@financial-times/cp-content-pipeline-schema 1.1.0 → 1.2.0

package/src/model/CapiResponse.ts

@@ -203,7 +203,11 @@ export class CapiResponse {
     return this.capiData.types
   }
   async url(vanity?: boolean | null) {
-    const url = this.capiData.webUrl
+    const url =
+      this.capiData.webUrl ??
+      this.capiData.canonicalWebUrl ??
+      `https://www.ft.com/content/${this.id()}`
+
     if (vanity) {
       try {
         const vanityUrl = await this.context.dataSources.vanityUrls.get(url)
@@ -231,7 +235,7 @@ export class CapiResponse {
     return null
   }
   accessLevel(): LiteralUnionScalarValues<typeof AccessLevel> {
-    return this.capiData.accessLevel
+    return this.capiData.accessLevel ?? 'subscribed'
   }
   canBeSyndicated(): LiteralUnionScalarValues<typeof CanBeSyndicated> {
     return this.capiData.canBeSyndicated
@@ -533,6 +537,23 @@ export class CapiResponse {
     return []
   }
 
+  async pinnedPost(): Promise<CapiResponse | null> {
+    if ('pinnedPosts' in this.capiData) {
+      const pinnedPosts = this.capiData.pinnedPosts || []
+      const liveBlogPosts = await this.liveBlogPosts()
+
+      const pinnedPostId = pinnedPosts[0]
+      const pinnedPostIndex = liveBlogPosts.findIndex(
+        (post) => post.id() === pinnedPostId
+      )
+
+      if (pinnedPostIndex !== -1) {
+        return liveBlogPosts.splice(pinnedPostIndex, 1)[0]
+      }
+    }
+    return null
+  }
+
   isContainedInPackage(): boolean {
     return 'containedIn' in this.capiData
       ? (this.capiData.containedIn?.length ?? 0) > 0
@@ -551,8 +572,9 @@ export class CapiResponse {
 
   commentsEnabled(): boolean {
     if ('comments' in this.capiData) {
-      return this.capiData.comments.enabled
+      return this.capiData.comments?.enabled ?? false
     }
+
     return false
   }
 

package/src/model/Picture.test.ts

@@ -2,6 +2,8 @@ import { QueryContext } from '..'
 import { ImageSet } from '../types/internal-content'
 import { Picture } from './Picture'
 
+const isLiveBlog = false
+
 describe('Picture model', () => {
   const mockImageSet = {
     apiUrl: 'https://api.ft.com/content/image-set',
@@ -35,7 +37,7 @@ describe('Picture model', () => {
 
   describe('finding the standard image', () => {
     it('uses the StandardInline image if it exists', () => {
-      const picture = new Picture(mockImageSet, mockContext)
+      const picture = new Picture(mockImageSet, isLiveBlog, mockContext)
       expect(picture.standard().url()).toEqual(
         'https://cloudfront.com/standard-inline.jpg'
       )
@@ -73,7 +75,11 @@ describe('Picture model', () => {
         type: 'http://www.ft.com/ontology/content/ImageSet',
       } as ImageSet
 
-      const picture = new Picture(mockWithoutStandardInline, mockContext)
+      const picture = new Picture(
+        mockWithoutStandardInline,
+        isLiveBlog,
+        mockContext
+      )
       expect(picture.standard().url()).toEqual(
         'https://cloudfront.com/desktop.jpg'
       )

package/src/model/Picture.ts

@@ -14,7 +14,11 @@ function assertDefined<T>(
 }
 
 export class Picture {
-  constructor(private imageSet: ImageSet, private context: QueryContext) {}
+  constructor(
+    private imageSet: ImageSet,
+    private isLiveBlog: boolean,
+    private context: QueryContext
+  ) {}
 
   images(): Image[] {
     return this.imageSet.members.map(
@@ -36,7 +40,10 @@ export class Picture {
 
   async layoutWidth(): Promise<LayoutWidth> {
     //TODO: actually work out the types
-    if (this.imageSet.members.length === 3) return 'full-grid'
+
+    if (!this.isLiveBlog && this.imageSet.members.length === 3) {
+      return 'full-grid'
+    }
 
     const dimensions = await this.standard().dimensions()
 

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

@@ -17,6 +17,7 @@ const articleMetadataSchema = baseMetadataSchema.pick({
   id: true,
   annotations: true,
   webUrl: true,
+  canonicalWebUrl: true,
   type: true,
   types: true,
   standout: true,

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

@@ -14,6 +14,7 @@ const audioMetadataSchema = baseMetadataSchema.pick({
   id: true,
   annotations: true,
   webUrl: true,
+  canonicalWebUrl: true,
   types: true,
   publishedDate: true,
   firstPublishedDate: true,

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

@@ -120,23 +120,28 @@ export const CapiPerson = z.object({
 export const baseMetadataSchema = z.object({
   id: z.string(),
   annotations: Annotation.array(),
-  webUrl: z.string(),
+  webUrl: z.string().optional(),
+  canonicalWebUrl: z.string().optional(),
   type: z.string(),
   types: z.string().array(),
-  standout: z.object({
-    editorsChoice: z.boolean(),
-    exclusive: z.boolean(),
-    scoop: z.boolean(),
-  }),
+  standout: z
+    .object({
+      editorsChoice: z.boolean(),
+      exclusive: z.boolean(),
+      scoop: z.boolean(),
+    })
+    .optional(),
   publishedDate: z.string(),
   firstPublishedDate: z.string(),
   realtime: z.boolean(),
-  accessLevel: z.union([
-    z.literal('premium'),
-    z.literal('subscribed'),
-    z.literal('registered'),
-    z.literal('free'),
-  ]),
+  accessLevel: z
+    .union([
+      z.literal('premium'),
+      z.literal('subscribed'),
+      z.literal('registered'),
+      z.literal('free'),
+    ])
+    .optional(),
   canBeSyndicated: z.union([
     z.literal('yes'),
     z.literal('no'),
@@ -145,9 +150,11 @@ export const baseMetadataSchema = z.object({
     z.literal('unknown'),
   ]),
   topper: Topper.optional(),
-  comments: z.object({
-    enabled: z.boolean(),
-  }),
+  comments: z
+    .object({
+      enabled: z.boolean(),
+    })
+    .optional(),
   containedIn: z
     .object({ apiUrl: z.string(), id: z.string() })
     .array()
@@ -175,6 +182,7 @@ export const baseContentSchema = z.object({
       promotionalStandfirst: z.string().optional(),
     })
     .optional(),
+  pinnedPosts: z.string().array(),
   contains: z
     .object({
       id: z.string(),

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

@@ -26,6 +26,7 @@ const contentPackageMetadataSchema = baseMetadataSchema.pick({
   id: true,
   annotations: true,
   webUrl: true,
+  canonicalWebUrl: true,
   type: true,
   types: true,
   standout: true,

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

@@ -10,6 +10,7 @@ const liveBlogPackageContentSchema = baseContentSchema.pick({
   summary: true,
   alternativeTitles: true,
   contains: true,
+  pinnedPosts: true,
   realtime: true,
 })
 
@@ -17,6 +18,7 @@ const liveBlogPackageMetadataSchema = baseMetadataSchema.pick({
   id: true,
   annotations: true,
   webUrl: true,
+  canonicalWebUrl: true,
   type: true,
   types: true,
   standout: true,

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

@@ -17,6 +17,7 @@ const placeholderMetadataSchema = baseMetadataSchema.pick({
   id: true,
   annotations: true,
   webUrl: true,
+  canonicalWebUrl: true,
   type: true,
   types: true,
   standout: true,

package/src/resolvers/content-tree/references/ImageSet.ts

@@ -5,6 +5,8 @@ import { ImageSetResolvers } from '../../../generated'
 
 export const ImageSet = {
   picture(parent, _args, context) {
+    const isLiveBlog = parent.contentApiData?.type() === 'LiveBlogPost'
+
     const imageSet = parent.contentApiData
       ?.embeds()
       ?.find(
@@ -12,6 +14,6 @@ export const ImageSet = {
           uuidFromUrl(embed.id) === uuidFromUrl(parent.reference.id)
       )
 
-    return imageSet ? new Picture(imageSet, context) : null
+    return imageSet ? new Picture(imageSet, isLiveBlog, context) : null
   },
 } satisfies ImageSetResolvers

package/src/resolvers/content-tree/references/LayoutImage.ts

@@ -3,6 +3,8 @@ import { LayoutImageResolvers } from '../../../generated'
 
 export const LayoutImage = {
   picture(parent, _args, context): Picture {
+    const isLiveBlog = parent.contentApiData?.type() === 'LiveBlogPost'
+
     return new Picture(
       {
         id: 'layout-imageset',
@@ -21,6 +23,7 @@ export const LayoutImage = {
           },
         ],
       },
+      isLiveBlog,
       context
     )
   },

package/src/resolvers/content-tree/references/ScrollyImage.ts

@@ -5,6 +5,8 @@ import { ScrollyImageResolvers } from '../../../generated'
 
 export const ScrollyImage = {
   picture(parent, _args, context) {
+    const isLiveBlog = parent.contentApiData?.type() === 'LiveBlogPost'
+
     const imageSet = parent.contentApiData
       ?.embeds()
       ?.find(
@@ -12,6 +14,6 @@ export const ScrollyImage = {
           uuidFromUrl(embed.id) === uuidFromUrl(parent.reference.id)
       )
 
-    return imageSet ? new Picture(imageSet, context) : null
+    return imageSet ? new Picture(imageSet, isLiveBlog, context) : null
   },
 } satisfies ScrollyImageResolvers

package/src/resolvers/content.ts

@@ -69,6 +69,7 @@ const resolvers = {
 
   LiveBlogPackage: {
     liveBlogPosts: (parent) => parent.liveBlogPosts(),
+    pinnedPost: (parent) => parent.pinnedPost(),
     realtime: (parent) => parent.realtime(),
   },