feat: enhance NewsArticleJsonLd and ArticleJsonLd author (#1105)

src/jsonld/newsarticle.tsx

@@ -3,6 +3,7 @@ import { setAuthor } from 'src/utils/schema/setAuthor';
 import { setPublisher } from 'src/utils/schema/setPublisher';
 
 import { JsonLd, JsonLdProps } from './jsonld';
+import { ArticleAuthor } from '../types';
 
 export interface NewsArticleJsonLdProps extends JsonLdProps {
   url: string;
@@ -13,7 +14,7 @@ export interface NewsArticleJsonLdProps extends JsonLdProps {
   dateCreated: string;
   datePublished: string;
   dateModified?: string;
-  authorName: string | string[];
+  authorName: string | string[] | ArticleAuthor | ArticleAuthor[];
   description: string;
   body: string;
   publisherName: string;
@@ -32,6 +33,7 @@ function NewsArticleJsonLd({
   datePublished,
   dateModified,
   authorName,
+  authorType,
   publisherName,
   publisherLogo,
   body,

src/types.ts

@@ -380,7 +380,8 @@ export type Author = {
 
 export type ArticleAuthor = {
   name: string;
-  url: string;
+  url?: string;
+  type?: 'Person' | 'Organization';
 };
 
 export type Publisher = {

src/utils/schema/__tests__/setAuthor.test.ts

@@ -0,0 +1,79 @@
+import { ArticleAuthor } from 'src/types';
+import { setAuthor } from '../setAuthor';
+
+describe('setAuthor', () => {
+  test('should return undefined if author is undefined', () => {
+    expect(setAuthor(undefined)).toBeUndefined();
+  });
+
+  test('works correctly when ArticleAuthor is passed', () => {
+    const author: ArticleAuthor = {
+      name: 'Acme',
+      type: 'Organization',
+      url: '/acme',
+    };
+
+    const data = setAuthor(author);
+
+    expect(data).toEqual({
+      '@type': 'Organization',
+      name: 'Acme',
+      url: '/acme',
+    });
+  });
+
+  test('works correctly when just ArticleAuthor name is passed', () => {
+    const data = setAuthor({ name: 'John Doe' });
+
+    expect(data).toEqual({
+      '@type': 'Person',
+      name: 'John Doe',
+    });
+  });
+
+  test('works correctly when an array of ArticleAuthor is passed', () => {
+    const author: ArticleAuthor[] = [
+      {
+        name: 'Acme',
+        type: 'Organization',
+        url: '/acme',
+      },
+      { name: 'John Doe' },
+    ];
+
+    const data = setAuthor(author);
+
+    expect(data).toEqual([
+      {
+        '@type': 'Organization',
+        name: 'Acme',
+        url: '/acme',
+      },
+      { '@type': 'Person', name: 'John Doe' },
+    ]);
+  });
+
+  test('works correctly when string is passed', () => {
+    const data = setAuthor('John Doe');
+
+    expect(data).toEqual({
+      '@type': 'Person',
+      name: 'John Doe',
+    });
+  });
+
+  test('works correctly when an array string is passed', () => {
+    const data = setAuthor(['John Doe', 'Foo Bar']);
+
+    expect(data).toEqual([
+      {
+        '@type': 'Person',
+        name: 'John Doe',
+      },
+      {
+        '@type': 'Person',
+        name: 'Foo Bar',
+      },
+    ]);
+  });
+});

src/utils/schema/setAuthor.ts

@@ -1,14 +1,5 @@
 import { ArticleAuthor } from '../../types';
 
-/**
- * Include name and url
- * @param author
- * @returns
- */
-function includeNameAndUrl(author: ArticleAuthor): boolean {
-  return typeof author === 'object' && !!(author.name && author.url);
-}
-
 /**
  * Generate author information
  * @param author
@@ -20,11 +11,11 @@ function generateAuthorInfo(author: string | ArticleAuthor) {
       '@type': 'Person',
       name: author,
     };
-  } else if (includeNameAndUrl(author)) {
+  } else if (!!author.name) {
     return {
-      '@type': 'Person',
+      '@type': author?.type ?? 'Person',
       name: author.name,
-      url: author.url,
+      url: author?.url,
     };
   }