@financial-times/cp-content-pipeline-schema 1.1.1 → 1.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@financial-times/cp-content-pipeline-schema",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "description": "",
   "main": "lib/index.js",
   "scripts": {

package/src/generated/index.ts

@@ -529,6 +529,7 @@ export type LiveBlogPackage = Content & {
   readonly id: Scalars['String']['output'];
   readonly liveBlogPosts?: Maybe<ReadonlyArray<Maybe<Content>>>;
   readonly mainImage?: Maybe<Image>;
+  readonly pinnedPost?: Maybe<Content>;
   readonly publishedDate: Scalars['String']['output'];
   readonly realtime?: Maybe<Scalars['Boolean']['output']>;
   readonly standfirst?: Maybe<Scalars['String']['output']>;
@@ -1569,6 +1570,7 @@ export type LiveBlogPackageResolvers<ContextType = QueryContext, ParentType exte
   id?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   liveBlogPosts?: Resolver<Maybe<ReadonlyArray<Maybe<ResolversTypes['Content']>>>, ParentType, ContextType>;
   mainImage?: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
+  pinnedPost?: Resolver<Maybe<ResolversTypes['Content']>, ParentType, ContextType>;
   publishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   realtime?: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
   standfirst?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;

package/src/model/CapiResponse.ts

@@ -537,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

package/src/model/Image.ts

@@ -126,7 +126,7 @@ export class CAPIImage implements Image {
     return resolutions.map((dpr) => ({
       url: imageServiceUrl({
         id,
-        url: this.url(),
+        url: this.capiImage.binaryUrl,
         systemCode: this.#systemCode,
         width: maxAllowedWidth,
         dpr,
@@ -137,7 +137,10 @@ export class CAPIImage implements Image {
   }
 
   url() {
-    return this.capiImage.binaryUrl
+    return imageServiceUrl({
+      url: this.capiImage.binaryUrl,
+      systemCode: this.#systemCode,
+    })
   }
 
   async dimensions() {
@@ -149,7 +152,7 @@ export class CAPIImage implements Image {
     }
     try {
       const imageMetadata = await this.#dataSources.origami.getImageMetadata(
-        this.url()
+        this.capiImage.binaryUrl
       )
       return imageMetadata
     } catch (error) {

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,9 +37,9 @@ 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'
+        'https://www.ft.com/__origami/service/image/v2/images/raw/https%3A%2F%2Fcloudfront.com%2Fstandard-inline.jpg?source=cp-content-pipeline&fit=scale-down&quality=highest&width=700&dpr=1'
       )
     })
 
@@ -73,9 +75,13 @@ 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'
+        'https://www.ft.com/__origami/service/image/v2/images/raw/https%3A%2F%2Fcloudfront.com%2Fdesktop.jpg?source=cp-content-pipeline&fit=scale-down&quality=highest&width=700&dpr=1'
       )
     })
   })

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/Topper.test.ts

@@ -7,6 +7,7 @@ import conceptIds from '@financial-times/n-concept-ids'
 
 import type { QueryContext } from '..'
 import type { Image as CAPIImage } from '../types/internal-content'
+import imageServiceUrl from '../helpers/imageService'
 
 const context = {} as unknown as QueryContext
 describe('produces the correct types', () => {
@@ -325,7 +326,7 @@ describe('produces correct images', () => {
     const topper = new Topper(capiResponse, context)
     const fallback = topper.fallbackImage()
     expect(fallback?.url()).toEqual(
-      'https://cloudfront.com/topper-standard.png'
+      'https://www.ft.com/__origami/service/image/v2/images/raw/https%3A%2F%2Fcloudfront.com%2Ftopper-standard.png?source=cp-content-pipeline&fit=scale-down&quality=highest&width=700&dpr=1'
     )
   })
   it('uses the main image as fallback if no lead images', () => {
@@ -334,7 +335,10 @@ describe('produces correct images', () => {
     const topper = new Topper(capiResponse, context)
     const fallback = topper.fallbackImage()
     expect(fallback?.url()).toEqual(
-      (baseCapiObject.mainImage as CAPIImage).binaryUrl
+      imageServiceUrl({
+        url: (baseCapiObject.mainImage as CAPIImage).binaryUrl,
+        systemCode: 'cp-content-pipeline',
+      })
     )
   })
 })

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

@@ -182,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/live-blog-package.ts

@@ -10,6 +10,7 @@ const liveBlogPackageContentSchema = baseContentSchema.pick({
   summary: true,
   alternativeTitles: true,
   contains: true,
+  pinnedPosts: true,
   realtime: 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(),
   },