@financial-times/cp-content-pipeline-schema 2.15.1 → 3.0.0

package/src/model/Topper.test.ts

@@ -2,13 +2,17 @@ import { Topper } from './Topper'
 import { Person } from './Person'
 import { baseCapiObject } from '../fixtures/capiObject'
 import { CapiResponse } from './CapiResponse'
-import { Concept, predicates } from './Concept'
+import { predicates } from './Concept'
 import cloneDeep from 'clone-deep'
 import conceptIds from '@financial-times/n-concept-ids'
 
 import type { QueryContext } from '..'
-import type { Image as CAPIImage } from '../types/internal-content'
+import type {
+  Article,
+  Image as CAPIImage,
+} from './schemas/capi/internal-content'
 import imageServiceUrl from '../helpers/imageService'
+import { capiPerson } from '../fixtures/capiPerson'
 
 const context = {} as unknown as QueryContext
 describe('produces the correct types', () => {
@@ -154,13 +158,14 @@ describe('produces the correct types', () => {
   it('flourish topper', () => {
     const clonedBase = cloneDeep(baseCapiObject)
     clonedBase.leadFlourish = {
-        id: 'test-id',
-        description: 'test-description',
-        type: 'test-type'
-      }
+      id: 'test-id',
+      description: 'test-description',
+      type: 'test-type',
+    }
     clonedBase.topper = {
-        layout: 'flourish',
-        layoutWidth: 'full-width'
+      layout: 'flourish',
+      layoutWidth: 'full-width',
+      backgroundColour: 'paper',
     }
     const capiResponse = new CapiResponse(clonedBase, context)
     const topper = new Topper(capiResponse, context)
@@ -235,7 +240,8 @@ describe('it retrieves the correct headline', () => {
 
 describe('produces the correct intro', () => {
   it('uses summary if it exists', () => {
-    const clonedBase = cloneDeep(baseCapiObject)
+    const clonedBase: Article & { summary?: typeof summary } =
+      cloneDeep(baseCapiObject)
     const summary = {
       bodyXML: 'some form of xml for the document summary',
     }
@@ -468,24 +474,22 @@ describe('headshot method', () => {
     jest.clearAllMocks()
   })
 
-  it('returns null if the content is not opinion genre', () => {
+  it('returns null if the content is not opinion genre', async () => {
     jest.spyOn(capiResponse, 'isPodcast').mockReturnValue(false)
     jest.spyOn(capiResponse, 'isOpinion').mockReturnValue(false)
 
-    const result = topper.headshot({})
-
-    expect(result).toBeNull()
+    await expect(topper.headshot({})).resolves.toBeNull()
   })
 
   it('attempts to return the author headshot if the content is opinion genre', async () => {
     jest.spyOn(capiResponse, 'isPodcast').mockReturnValue(false)
     jest.spyOn(capiResponse, 'isOpinion').mockReturnValue(true)
-    jest.spyOn(capiResponse, 'getAuthors').mockReturnValue([{} as Concept])
     jest
-      .spyOn(Person.prototype, 'headshot')
-      .mockReturnValue(Promise.resolve(null))
+      .spyOn(capiResponse, 'primaryAuthor')
+      .mockResolvedValue(new Person(capiPerson, context))
 
-    await topper.headshot({})
-    expect(Person.prototype.headshot).toHaveBeenCalledTimes(1)
+    expect(await topper.headshot({})).toBe(
+      'https://www.ft.com/__origami/service/image/v2/images/raw/https%3A%2F%2Fd1e00ek4ebabms.cloudfront.net%2Fproduction%2Fuploaded-files%2Ffthead-v1_robert-shrimsley-cc467908-15d6-474d-94d8-171594ceabb9.png?source=cp-content-pipeline&fit=scale-down&quality=highest&width=150&dpr=1'
+    )
   })
 })

package/src/model/Topper.ts

@@ -10,6 +10,7 @@ import { RichText } from './RichText'
 import imageServiceUrl from '../helpers/imageService'
 import { LeadFlourish } from './LeadFlourish'
 import type { TopperWithHeadshotHeadshotArgs } from '../generated'
+import { predicates } from './Concept'
 
 type TopperType =
   | 'DeepPortraitTopper'
@@ -295,7 +296,9 @@ export class Topper {
   }
 
   columnist() {
-    const authors = this.capiResponse.getAuthors()
+    const authors = this.capiResponse.annotations({
+      byPredicate: predicates.hasAuthor,
+    })
     const isOpinionOrColumn =
       this.type() === 'OpinionTopper' || this.capiResponse.isColumn()
 
@@ -334,18 +337,16 @@ export class Topper {
     return null
   }
 
-  headshot(args: TopperWithHeadshotHeadshotArgs) {
+  async headshot(args: TopperWithHeadshotHeadshotArgs) {
     if (this.capiResponse.isPodcast()) {
-      args.url = this.capiResponse.mainImage()?.url()
-      return this.imageService(args)
+      return this.imageService({
+        ...args,
+        url: this.capiResponse.mainImage()?.url(),
+      })
     }
 
     if (this.capiResponse.isOpinion()) {
-      const authors = this.capiResponse.authors()
-
-      if (authors && authors[0]) {
-        return authors[0].headshot(args)
-      }
+      return (await this.capiResponse.primaryAuthor())?.headshot(args) ?? null
     }
 
     return null

package/src/model/__snapshots__/Byline.test.ts.snap

@@ -2,7 +2,24 @@
 
 exports[`byline transformation adds a link around a single known author 1`] = `
 Object {
-  "references": Array [],
+  "references": Array [
+    Object {
+      "contentApiData": undefined,
+      "reference": Object {
+        "children": Array [
+          Object {
+            "type": "text",
+            "value": "Chris Giles",
+          },
+        ],
+        "data": Object {
+          "referenceIndex": 0,
+        },
+        "id": "1d556016-ad16-4fe7-8724-42b3fb15ad28",
+        "type": "author",
+      },
+    },
+  ],
   "tree": Object {
     "children": Array [
       Object {
@@ -12,22 +29,58 @@ Object {
             "value": "Chris Giles",
           },
         ],
-        "href": "https://www.ft.com/stream/uuid/1d556016-ad16-4fe7-8724-42b3fb15ad28",
-        "type": "author-link",
+        "data": Object {
+          "referenceIndex": 0,
+        },
+        "id": "1d556016-ad16-4fe7-8724-42b3fb15ad28",
+        "type": "author",
       },
       Object {
         "type": "text",
         "value": " in London",
       },
     ],
-    "type": "root",
+    "type": "byline",
   },
 }
 `;
 
 exports[`byline transformation adds links around multiple known authors 1`] = `
 Object {
-  "references": Array [],
+  "references": Array [
+    Object {
+      "contentApiData": undefined,
+      "reference": Object {
+        "children": Array [
+          Object {
+            "type": "text",
+            "value": "Chris Giles",
+          },
+        ],
+        "data": Object {
+          "referenceIndex": 0,
+        },
+        "id": "1d556016-ad16-4fe7-8724-42b3fb15ad28",
+        "type": "author",
+      },
+    },
+    Object {
+      "contentApiData": undefined,
+      "reference": Object {
+        "children": Array [
+          Object {
+            "type": "text",
+            "value": "Martin Wolf",
+          },
+        ],
+        "data": Object {
+          "referenceIndex": 1,
+        },
+        "id": "7c1e1e72-57ae-4461-862a-f8d24dd42e22",
+        "type": "author",
+      },
+    },
+  ],
   "tree": Object {
     "children": Array [
       Object {
@@ -37,8 +90,11 @@ Object {
             "value": "Chris Giles",
           },
         ],
-        "href": "https://www.ft.com/stream/uuid/1d556016-ad16-4fe7-8724-42b3fb15ad28",
-        "type": "author-link",
+        "data": Object {
+          "referenceIndex": 0,
+        },
+        "id": "1d556016-ad16-4fe7-8724-42b3fb15ad28",
+        "type": "author",
       },
       Object {
         "type": "text",
@@ -51,22 +107,42 @@ Object {
             "value": "Martin Wolf",
           },
         ],
-        "href": "https://www.ft.com/stream/uuid/7c1e1e72-57ae-4461-862a-f8d24dd42e22",
-        "type": "author-link",
+        "data": Object {
+          "referenceIndex": 1,
+        },
+        "id": "7c1e1e72-57ae-4461-862a-f8d24dd42e22",
+        "type": "author",
       },
       Object {
         "type": "text",
         "value": " in London",
       },
     ],
-    "type": "root",
+    "type": "byline",
   },
 }
 `;
 
 exports[`byline transformation converts straight apostrophes in byline 1`] = `
 Object {
-  "references": Array [],
+  "references": Array [
+    Object {
+      "contentApiData": undefined,
+      "reference": Object {
+        "children": Array [
+          Object {
+            "type": "text",
+            "value": "Sarah O’Connor",
+          },
+        ],
+        "data": Object {
+          "referenceIndex": 0,
+        },
+        "id": "1d556016-ad16-4fe7-8724-eeeeeeeeeeee",
+        "type": "author",
+      },
+    },
+  ],
   "tree": Object {
     "children": Array [
       Object {
@@ -76,15 +152,18 @@ Object {
             "value": "Sarah O’Connor",
           },
         ],
-        "href": "https://www.ft.com/stream/uuid/1d556016-ad16-4fe7-8724-eeeeeeeeeeee",
-        "type": "author-link",
+        "data": Object {
+          "referenceIndex": 0,
+        },
+        "id": "1d556016-ad16-4fe7-8724-eeeeeeeeeeee",
+        "type": "author",
       },
       Object {
         "type": "text",
         "value": " in Bali",
       },
     ],
-    "type": "root",
+    "type": "byline",
   },
 }
 `;
@@ -99,14 +178,31 @@ Object {
         "value": "Chris Giles and Nick Ramsbottom in London",
       },
     ],
-    "type": "root",
+    "type": "byline",
   },
 }
 `;
 
 exports[`byline transformation ignores extra authors in annotations array 1`] = `
 Object {
-  "references": Array [],
+  "references": Array [
+    Object {
+      "contentApiData": undefined,
+      "reference": Object {
+        "children": Array [
+          Object {
+            "type": "text",
+            "value": "Martin Wolf",
+          },
+        ],
+        "data": Object {
+          "referenceIndex": 0,
+        },
+        "id": "7c1e1e72-57ae-4461-862a-f8d24dd42e22",
+        "type": "author",
+      },
+    },
+  ],
   "tree": Object {
     "children": Array [
       Object {
@@ -116,22 +212,42 @@ Object {
             "value": "Martin Wolf",
           },
         ],
-        "href": "https://www.ft.com/stream/uuid/7c1e1e72-57ae-4461-862a-f8d24dd42e22",
-        "type": "author-link",
+        "data": Object {
+          "referenceIndex": 0,
+        },
+        "id": "7c1e1e72-57ae-4461-862a-f8d24dd42e22",
+        "type": "author",
       },
       Object {
         "type": "text",
         "value": " in London",
       },
     ],
-    "type": "root",
+    "type": "byline",
   },
 }
 `;
 
 exports[`byline transformation ignores unknown authors in byline text 1`] = `
 Object {
-  "references": Array [],
+  "references": Array [
+    Object {
+      "contentApiData": undefined,
+      "reference": Object {
+        "children": Array [
+          Object {
+            "type": "text",
+            "value": "Chris Giles",
+          },
+        ],
+        "data": Object {
+          "referenceIndex": 0,
+        },
+        "id": "1d556016-ad16-4fe7-8724-42b3fb15ad28",
+        "type": "author",
+      },
+    },
+  ],
   "tree": Object {
     "children": Array [
       Object {
@@ -141,22 +257,42 @@ Object {
             "value": "Chris Giles",
           },
         ],
-        "href": "https://www.ft.com/stream/uuid/1d556016-ad16-4fe7-8724-42b3fb15ad28",
-        "type": "author-link",
+        "data": Object {
+          "referenceIndex": 0,
+        },
+        "id": "1d556016-ad16-4fe7-8724-42b3fb15ad28",
+        "type": "author",
       },
       Object {
         "type": "text",
         "value": " and Nick Ramsbottom in London",
       },
     ],
-    "type": "root",
+    "type": "byline",
   },
 }
 `;
 
 exports[`byline transformation leaves curly apostrophes in byline 1`] = `
 Object {
-  "references": Array [],
+  "references": Array [
+    Object {
+      "contentApiData": undefined,
+      "reference": Object {
+        "children": Array [
+          Object {
+            "type": "text",
+            "value": "Sarah O’Connor",
+          },
+        ],
+        "data": Object {
+          "referenceIndex": 0,
+        },
+        "id": "1d556016-ad16-4fe7-8724-eeeeeeeeeeee",
+        "type": "author",
+      },
+    },
+  ],
   "tree": Object {
     "children": Array [
       Object {
@@ -166,15 +302,18 @@ Object {
             "value": "Sarah O’Connor",
           },
         ],
-        "href": "https://www.ft.com/stream/uuid/1d556016-ad16-4fe7-8724-eeeeeeeeeeee",
-        "type": "author-link",
+        "data": Object {
+          "referenceIndex": 0,
+        },
+        "id": "1d556016-ad16-4fe7-8724-eeeeeeeeeeee",
+        "type": "author",
       },
       Object {
         "type": "text",
         "value": " in Bali",
       },
     ],
-    "type": "root",
+    "type": "byline",
   },
 }
 `;

package/src/model/schemas/capi/article.ts

@@ -24,6 +24,7 @@ const articleMetadataSchema = baseMetadataSchema.pick({
   publishedDate: true,
   firstPublishedDate: true,
   publishReference: true,
+  lastModified: true,
   accessLevel: true,
   editorialDesk: true,
   canBeSyndicated: true,

package/src/model/schemas/capi/audio.ts

@@ -19,6 +19,7 @@ const audioMetadataSchema = baseMetadataSchema.pick({
   publishedDate: true,
   firstPublishedDate: true,
   publishReference: true,
+  lastModified: true,
   accessLevel: true,
   editorialDesk: true,
   canBeSyndicated: true,

package/src/model/schemas/capi/base-schema.ts

@@ -89,7 +89,7 @@ const AlternativeImage = z.object({
   promotionalImage: BaseImage,
 })
 
-export const LeadFlourish = z.object({
+const LeadFlourish = z.object({
   id: z.string(),
   type: z.string(),
   description: z.string(),
@@ -150,7 +150,7 @@ const DataSource = z.object({
   mediaType: z.string(),
 })
 
-export const CapiPersonMembership = z.object({
+const CapiPersonMembership = z.object({
   title: z.string(),
   types: z.string().array(),
   directType: z.string(),
@@ -165,7 +165,7 @@ export const CapiPerson = z.object({
   types: z.string().array(),
   directType: z.string(),
   labels: z.string().array(),
-  memberships: CapiPersonMembership.array(),
+  memberships: CapiPersonMembership.array().optional(),
   emailAddress: z.string().optional(),
   twitterHandle: z.string().optional(),
   descriptionXML: z.string().optional(),
@@ -195,6 +195,7 @@ export const baseMetadataSchema = z.object({
   publishedDate: z.string(),
   firstPublishedDate: z.string(),
   publishReference: z.string().optional(),
+  lastModified: z.string(),
   realtime: z.boolean(),
   editorialDesk: z.string().optional(),
   accessLevel: z

package/src/model/schemas/capi/content-package.ts

@@ -12,6 +12,7 @@ const contentPackageContentSchema = baseContentSchema
     contains: true,
     design: true,
     bodyXML: true,
+    byline: true,
   })
   .merge(
     baseContentSchema
@@ -31,6 +32,7 @@ const contentPackageMetadataSchema = baseMetadataSchema.pick({
   standout: true,
   publishedDate: true,
   firstPublishedDate: true,
+  lastModified: true,
   publishReference: true,
   accessLevel: true,
   editorialDesk: true,

package/src/model/schemas/capi/internal-content.ts

@@ -0,0 +1,45 @@
+import { z } from 'zod'
+import type {
+  CapiPerson,
+  Annotation,
+  Image,
+  ImageSet,
+  Clip,
+  ClipSet,
+  MainImage,
+  LeadImage,
+} from './base-schema'
+
+import { articleSchema } from './article'
+import { placeholderSchema } from './placeholder'
+
+import { liveBlogPackageSchema } from './live-blog-package'
+import { audioSchema } from './audio'
+import { videoSchema } from './video'
+
+import { contentPackageSchema } from './content-package'
+
+export type Article = z.infer<typeof articleSchema>
+type Placeholder = z.infer<typeof placeholderSchema>
+type LiveBlogPackage = z.infer<typeof liveBlogPackageSchema>
+type ContentPackage = z.infer<typeof contentPackageSchema>
+type Audio = z.infer<typeof audioSchema>
+type Video = z.infer<typeof videoSchema>
+
+export type CapiPerson = z.infer<typeof CapiPerson>
+
+export type Annotation = z.infer<typeof Annotation>
+export type Image = z.infer<typeof Image>
+export type LeadImage = z.infer<typeof LeadImage>
+export type ImageSet = z.infer<typeof ImageSet>
+export type MainImage = z.infer<typeof MainImage>
+export type Clip = z.infer<typeof Clip>
+export type ClipSet = z.infer<typeof ClipSet>
+
+export type ContentTypeSchemas =
+  | Article
+  | Placeholder
+  | LiveBlogPackage
+  | ContentPackage
+  | Audio
+  | Video

package/src/model/schemas/capi/live-blog-package.ts

@@ -23,6 +23,7 @@ const liveBlogPackageMetadataSchema = baseMetadataSchema.pick({
   standout: true,
   publishedDate: true,
   firstPublishedDate: true,
+  lastModified: true,
   publishReference: true,
   accessLevel: true,
   editorialDesk: true,

package/src/model/schemas/capi/placeholder.ts

@@ -23,6 +23,7 @@ const placeholderMetadataSchema = baseMetadataSchema.pick({
   standout: true,
   publishedDate: true,
   firstPublishedDate: true,
+  lastModified: true,
   publishReference: true,
   accessLevel: true,
   editorialDesk: true,

package/src/model/schemas/capi/video.ts

@@ -8,6 +8,7 @@ const videoContentSchema = baseContentSchema.pick({
   title: true,
   transcript: true,
   alternativeTitles: true,
+  byline: true,
 })
 
 const videoMetadataSchema = baseMetadataSchema.pick({
@@ -18,6 +19,7 @@ const videoMetadataSchema = baseMetadataSchema.pick({
   types: true,
   publishedDate: true,
   firstPublishedDate: true,
+  lastModified: true,
   publishReference: true,
   accessLevel: true,
   editorialDesk: true,

package/src/resolvers/concept.ts

@@ -1,17 +1,34 @@
-import { ConceptResolvers } from '../generated'
+import {
+  ConceptInterfaceResolvers,
+  ConceptResolvers,
+  AuthorResolvers,
+} from '../generated'
 
-const resolvers: { Concept: ConceptResolvers } = {
-  Concept: {
-    apiUrl: (parent) => parent.apiUrl(),
-    directType: (parent) => parent.directType(),
-    isPackageBrand: (parent) => parent.isPackageBrand(),
-    id: (parent) => parent.uuid(),
-    predicate: (parent) => parent.predicate(),
-    prefLabel: (parent) => parent.prefLabel(),
-    type: (parent) => parent.type(),
-    types: (parent) => parent.types(),
-    url: async (parent, args) => parent.url(args),
+const conceptResolvers = {
+  __resolveType: (parent) => (parent.isAuthor() ? 'Author' : 'Concept'),
+  apiUrl: (parent) => parent.apiUrl(),
+  directType: (parent) => parent.directType(),
+  isPackageBrand: (parent) => parent.isPackageBrand(),
+  id: (parent) => parent.uuid(),
+  predicate: (parent) => parent.predicate(),
+  prefLabel: (parent) => parent.prefLabel(),
+  type: (parent) => parent.type(),
+  types: (parent) => parent.types(),
+  url: async (parent, args) => parent.url(args),
+} satisfies ConceptInterfaceResolvers
+
+const resolvers = {
+  ConceptInterface: conceptResolvers,
+  Concept: conceptResolvers,
+  Author: {
+    ...conceptResolvers,
+    person: (parent, _, context) =>
+      context.dataSources.capi.getPerson(parent.uuid()),
   },
+} satisfies {
+  ConceptInterface: ConceptInterfaceResolvers
+  Concept: ConceptResolvers
+  Author: AuthorResolvers
 }
 
 export default resolvers