Merge pull request #37 from derekphilipau/dev

bug in schema keywords
derekphilipau · Dec 31, 2023 · 72c0516 · 72c0516
2 parents 55eef36 + 900ae9e
commit 72c0516
Show file tree

Hide file tree

Showing 2 changed files with 97 additions and 3 deletions.
diff --git a/__tests__/lib/schema.test.ts b/__tests__/lib/schema.test.ts
@@ -0,0 +1,87 @@
+import type { ArtworkDocument } from '@/types/document';
+import { getSchemaVisualArtwork } from '@/lib/schema';
+
+describe('getSchemaVisualArtwork', () => {
+  it('should return undefined for undefined input', () => {
+    const result = getSchemaVisualArtwork(undefined);
+    expect(result).toBeUndefined();
+  });
+
+  it('should correctly transform a minimal ArtworkDocument', () => {
+    const mockArtwork: ArtworkDocument = {
+      title: 'Test Artwork',
+      image: { thumbnailUrl: 'http://example.com/image.jpg' },
+      description: 'A description of the artwork',
+      primaryConstituent: { name: 'Artist Name', canonicalName: 'Artist Name' },
+      medium: ['Oil on canvas'],
+      classification: 'Painting',
+      dimensions: '94 1/2 × 44 × 33 in. (240 × 111.8 × 83.8 cm)',
+      copyright: 'Copyright info',
+      creditLine: 'Credit info',
+      formattedDate: '2023-01-01',
+      keywords: ['keyword1', 'keyword2'],
+    };
+
+    const expectedSchema = {
+      '@context': 'https://schema.org',
+      '@type': 'VisualArtwork',
+      name: 'Test Artwork',
+      image: 'http://example.com/image.jpg',
+      abstract: 'A description of the artwork',
+      creator: [{ '@type': 'Person', name: 'Artist Name' }],
+      artMedium: 'Oil on canvas',
+      artform: 'Painting',
+      height: [{ '@type': 'Distance', name: '240 cm' }],
+      width: [{ '@type': 'Distance', name: '111.8 cm' }],
+      depth: [{ '@type': 'Distance', name: '83.8 cm' }],
+      accessMode: 'visual',
+      copyrightNotice: 'Copyright info',
+      creditText: 'Credit info',
+      dateCreated: '2023-01-01',
+      inLanguage: 'English',
+      keywords: 'keyword1, keyword2',
+    };
+
+    const result = getSchemaVisualArtwork(mockArtwork);
+    expect(result).toEqual(expectedSchema);
+  });
+
+  it('should correctly transform a minimal ArtworkDocument with keywords as string', () => {
+    const mockArtwork: any = {
+      title: 'Test Artwork',
+      image: { thumbnailUrl: 'http://example.com/image.jpg' },
+      description: 'A description of the artwork',
+      primaryConstituent: { name: 'Artist Name', canonicalName: 'Artist Name' },
+      medium: ['Oil on canvas'],
+      classification: 'Painting',
+      dimensions: '94 1/2 × 44 × 33 in. (240 × 111.8 × 83.8 cm)',
+      copyright: 'Copyright info',
+      creditLine: 'Credit info',
+      formattedDate: '2023-01-01',
+      keywords: 'keyword1, keyword2',
+    };
+
+    const expectedSchema = {
+      '@context': 'https://schema.org',
+      '@type': 'VisualArtwork',
+      name: 'Test Artwork',
+      image: 'http://example.com/image.jpg',
+      abstract: 'A description of the artwork',
+      creator: [{ '@type': 'Person', name: 'Artist Name' }],
+      artMedium: 'Oil on canvas',
+      artform: 'Painting',
+      height: [{ '@type': 'Distance', name: '240 cm' }],
+      width: [{ '@type': 'Distance', name: '111.8 cm' }],
+      depth: [{ '@type': 'Distance', name: '83.8 cm' }],
+      accessMode: 'visual',
+      copyrightNotice: 'Copyright info',
+      creditText: 'Credit info',
+      dateCreated: '2023-01-01',
+      inLanguage: 'English',
+      keywords: 'keyword1, keyword2',
+    };
+
+    const result = getSchemaVisualArtwork(mockArtwork);
+    expect(result).toEqual(expectedSchema);
+  });
+});
diff --git a/lib/schema.ts b/lib/schema.ts
@@ -4,7 +4,6 @@
  * Functions to transform data into JSON-LD for Schema.org.
  * Currently only supports VisualArtwork.
  */
-import { vi } from 'date-fns/locale';
 import type { VisualArtwork, WithContext } from 'schema-dts';
 
 import type { ArtworkDocument } from '@/types/document';
@@ -59,7 +58,11 @@ export function getSchemaVisualArtwork(item: ArtworkDocument | undefined) {
       },
     ];
   }
-  if (item.medium) schema.artMedium = item.medium;
+  if (Array.isArray(item.medium) && item.medium.length > 0) {
+    schema.artMedium = item.medium.join(', ');
+  } else if (typeof item.medium === 'string' && item.medium) {
+    schema.artMedium = item.medium;
+  }
   if (item.classification) schema.artform = item.classification;
   const dimensions = getDimensionsCM(item.dimensions);
   if (dimensions?.height)
@@ -73,7 +76,11 @@ export function getSchemaVisualArtwork(item: ArtworkDocument | undefined) {
   if (item.creditLine) schema.creditText = item.creditLine;
   if (item.formattedDate) schema.dateCreated = item.formattedDate; // TODO
   schema.inLanguage = 'English'; // TODO
-  if (item.keywords?.length) schema.keywords = item.keywords.join(', ');
+  if (Array.isArray(item.keywords) && item.keywords.length > 0) {
+    schema.keywords = item.keywords.join(', ');
+  } else if (typeof item.keywords === 'string' && item.keywords) {
+    schema.keywords = item.keywords;
+  }
   return schema;
 }