@financial-times/cp-content-pipeline-schema 3.12.2 → 3.13.0

package/src/model/Clip.test.ts

@@ -1,154 +1,173 @@
-import { Clip } from './Clip';
+import { QueryContext } from '..'
+import { Clip } from './Clip'
+const mockContext = {
+  systemCode: 'cp-content-pipeline',
+} as unknown as QueryContext
 
 describe('Clip', () => {
-    describe('poster', () => {
-        it('uses the Origami Image Service when a url is provided', () => {
-            const clip = new Clip({
+  describe('poster', () => {
+    it('uses the Origami Image Service when a url is provided', () => {
+      const clip = new Clip(
+        {
+          id: 'http://api.ft.com/things/1234',
+          type: 'http://www.ft.com/ontology/content/Clip',
+          dataSource: [{}],
+          poster: {
+            id: 'http://api.ft.com/things/1234',
+            type: 'http://www.ft.com/ontology/content/ImageSet',
+            members: [
+              {
                 id: 'http://api.ft.com/things/1234',
-                type: "http://www.ft.com/ontology/content/Clip",
-                dataSource: [
-                    {},
-                ],
-                poster: {
-                    id: 'http://api.ft.com/things/1234',
-                    type: 'http://www.ft.com/ontology/content/ImageSet',
-                    members: [
-                        {
-                            id: 'http://api.ft.com/things/1234',
-                            type: 'http://www.ft.com/ontology/content/Image',
-                            binaryUrl: 'http://video.ft.com/1234.jpg',
-                        },
-                    ],
-                },      
-            });
-            expect(clip.poster()).toContain('https://www.ft.com/__origami/service/image/v2/images/raw/');
-            expect(clip.poster()).toContain('source=cp-content-pipeline&fit=scale-down&quality=highest');
-        });
-        it('returns an empty string if an image url is not provided', () => {
-            const clip = new Clip({
+                type: 'http://www.ft.com/ontology/content/Image',
+                binaryUrl: 'http://video.ft.com/1234.jpg',
+              },
+            ],
+          },
+        },
+        mockContext
+      )
+      expect(clip.poster()).toContain('https://images.ft.com/v3/image/raw/')
+      expect(clip.poster()).toContain(
+        'source=cp-content-pipeline&fit=scale-down&quality=highest'
+      )
+    })
+    it('returns an empty string if an image url is not provided', () => {
+      const clip = new Clip(
+        {
+          id: 'http://api.ft.com/things/1234',
+          type: 'http://www.ft.com/ontology/content/Clip',
+          dataSource: [{}],
+          poster: {
+            id: 'http://api.ft.com/things/1234',
+            type: 'http://www.ft.com/ontology/content/ImageSet',
+            members: [
+              {
                 id: 'http://api.ft.com/things/1234',
-                type: "http://www.ft.com/ontology/content/Clip",
-                dataSource: [
-                    {},
-                ],
-                poster: {
-                    id: 'http://api.ft.com/things/1234',
-                    type: 'http://www.ft.com/ontology/content/ImageSet',
-                    members: [
-                        {
-                            id: 'http://api.ft.com/things/1234',
-                            type: 'http://www.ft.com/ontology/content/Image',
-                            binaryUrl: '',
-                        },
-                    ],
-                },      
-            });
-            expect(clip.poster()).toEqual('');
-        });
-        it('uses a default width if a layout is not provided', () => {
-            const clip = new Clip({
+                type: 'http://www.ft.com/ontology/content/Image',
+                binaryUrl: '',
+              },
+            ],
+          },
+        },
+        mockContext
+      )
+      expect(clip.poster()).toEqual('')
+    })
+    it('uses a default width if a layout is not provided', () => {
+      const clip = new Clip(
+        {
+          id: 'http://api.ft.com/things/1234',
+          type: 'http://www.ft.com/ontology/content/Clip',
+          dataSource: [{}],
+          poster: {
+            id: 'http://api.ft.com/things/1234',
+            type: 'http://www.ft.com/ontology/content/ImageSet',
+            members: [
+              {
                 id: 'http://api.ft.com/things/1234',
-                type: "http://www.ft.com/ontology/content/Clip",
-                dataSource: [
-                    {},
-                ],
-                poster: {
-                    id: 'http://api.ft.com/things/1234',
-                    type: 'http://www.ft.com/ontology/content/ImageSet',
-                    members: [
-                        {
-                            id: 'http://api.ft.com/things/1234',
-                            type: 'http://www.ft.com/ontology/content/Image',
-                            binaryUrl: 'http://video.ft.com/1234.jpg',
-                        },
-                    ],
-                },      
-            });
-            expect(clip.poster()).toContain('width=700');
-        });
-        it('uses a default width if a layout is not supported', () => {
-            const clip = new Clip({
+                type: 'http://www.ft.com/ontology/content/Image',
+                binaryUrl: 'http://video.ft.com/1234.jpg',
+              },
+            ],
+          },
+        },
+        mockContext
+      )
+      expect(clip.poster()).toContain('width=700')
+    })
+    it('uses a default width if a layout is not supported', () => {
+      const clip = new Clip(
+        {
+          id: 'http://api.ft.com/things/1234',
+          type: 'http://www.ft.com/ontology/content/Clip',
+          dataSource: [{}],
+          poster: {
+            id: 'http://api.ft.com/things/1234',
+            type: 'http://www.ft.com/ontology/content/ImageSet',
+            members: [
+              {
                 id: 'http://api.ft.com/things/1234',
-                type: "http://www.ft.com/ontology/content/Clip",
-                dataSource: [
-                    {},
-                ],
-                poster: {
-                    id: 'http://api.ft.com/things/1234',
-                    type: 'http://www.ft.com/ontology/content/ImageSet',
-                    members: [
-                        {
-                            id: 'http://api.ft.com/things/1234',
-                            type: 'http://www.ft.com/ontology/content/Image',
-                            binaryUrl: 'http://video.ft.com/1234.jpg',
-                        },
-                    ],
-                },      
-            }, 'I-dont-exist');
-            expect(clip.poster()).toEqual('https://www.ft.com/__origami/service/image/v2/images/raw/http%3A%2F%2Fvideo.ft.com%2F1234.jpg?source=cp-content-pipeline&fit=scale-down&quality=highest&width=700&dpr=1');
-        });
-        it('generates an image with the appropriate width for a `in-line` layout', () => {
-            const clip = new Clip({
+                type: 'http://www.ft.com/ontology/content/Image',
+                binaryUrl: 'http://video.ft.com/1234.jpg',
+              },
+            ],
+          },
+        },
+        mockContext,
+        'I-dont-exist'
+      )
+      expect(clip.poster()).toEqual(
+        'https://images.ft.com/v3/image/raw/http%3A%2F%2Fvideo.ft.com%2F1234.jpg?source=cp-content-pipeline&fit=scale-down&quality=highest&width=700&dpr=1'
+      )
+    })
+    it('generates an image with the appropriate width for a `in-line` layout', () => {
+      const clip = new Clip(
+        {
+          id: 'http://api.ft.com/things/1234',
+          type: 'http://www.ft.com/ontology/content/Clip',
+          dataSource: [{}],
+          poster: {
+            id: 'http://api.ft.com/things/1234',
+            type: 'http://www.ft.com/ontology/content/ImageSet',
+            members: [
+              {
                 id: 'http://api.ft.com/things/1234',
-                type: "http://www.ft.com/ontology/content/Clip",
-                dataSource: [
-                    {},
-                ],
-                poster: {
-                    id: 'http://api.ft.com/things/1234',
-                    type: 'http://www.ft.com/ontology/content/ImageSet',
-                    members: [
-                        {
-                            id: 'http://api.ft.com/things/1234',
-                            type: 'http://www.ft.com/ontology/content/Image',
-                            binaryUrl: 'http://video.ft.com/1234.jpg',
-                        },
-                    ],
-                },      
-            }, 'in-line');
-            expect(clip.poster()).toContain('width=700');
-        });
-        it('generates an image with the appropriate width for a `mid-grid` layout', () => {
-            const clip = new Clip({
+                type: 'http://www.ft.com/ontology/content/Image',
+                binaryUrl: 'http://video.ft.com/1234.jpg',
+              },
+            ],
+          },
+        },
+        mockContext,
+        'in-line'
+      )
+      expect(clip.poster()).toContain('width=700')
+    })
+    it('generates an image with the appropriate width for a `mid-grid` layout', () => {
+      const clip = new Clip(
+        {
+          id: 'http://api.ft.com/things/1234',
+          type: 'http://www.ft.com/ontology/content/Clip',
+          dataSource: [{}],
+          poster: {
+            id: 'http://api.ft.com/things/1234',
+            type: 'http://www.ft.com/ontology/content/ImageSet',
+            members: [
+              {
                 id: 'http://api.ft.com/things/1234',
-                type: "http://www.ft.com/ontology/content/Clip",
-                dataSource: [
-                    {},
-                ],
-                poster: {
-                    id: 'http://api.ft.com/things/1234',
-                    type: 'http://www.ft.com/ontology/content/ImageSet',
-                    members: [
-                        {
-                            id: 'http://api.ft.com/things/1234',
-                            type: 'http://www.ft.com/ontology/content/Image',
-                            binaryUrl: 'http://video.ft.com/1234.jpg',
-                        },
-                    ],
-                },      
-            }, 'mid-grid');
-            expect(clip.poster()).toContain('width=900');
-        });
-        it('generates an image with the appropriate width for a `full-grid` layout', () => {
-            const clip = new Clip({
+                type: 'http://www.ft.com/ontology/content/Image',
+                binaryUrl: 'http://video.ft.com/1234.jpg',
+              },
+            ],
+          },
+        },
+        mockContext,
+        'mid-grid'
+      )
+      expect(clip.poster()).toContain('width=900')
+    })
+    it('generates an image with the appropriate width for a `full-grid` layout', () => {
+      const clip = new Clip(
+        {
+          id: 'http://api.ft.com/things/1234',
+          type: 'http://www.ft.com/ontology/content/Clip',
+          dataSource: [{}],
+          poster: {
+            id: 'http://api.ft.com/things/1234',
+            type: 'http://www.ft.com/ontology/content/ImageSet',
+            members: [
+              {
                 id: 'http://api.ft.com/things/1234',
-                type: "http://www.ft.com/ontology/content/Clip",
-                dataSource: [
-                    {},
-                ],
-                poster: {
-                    id: 'http://api.ft.com/things/1234',
-                    type: 'http://www.ft.com/ontology/content/ImageSet',
-                    members: [
-                        {
-                            id: 'http://api.ft.com/things/1234',
-                            type: 'http://www.ft.com/ontology/content/Image',
-                            binaryUrl: 'http://video.ft.com/1234.jpg',
-                        },
-                    ],
-                },      
-            }, 'full-grid');
-            expect(clip.poster()).toContain('width=1200');
-        });
-    });
-}); 
+                type: 'http://www.ft.com/ontology/content/Image',
+                binaryUrl: 'http://video.ft.com/1234.jpg',
+              },
+            ],
+          },
+        },
+        mockContext,
+        'full-grid'
+      )
+      expect(clip.poster()).toContain('width=1200')
+    })
+  })
+})

package/src/model/Clip.ts

@@ -6,6 +6,7 @@ import {
 } from '../resolvers/literal-union'
 import { ClipFormat } from '../resolvers/scalars'
 import imageServiceUrl from '../helpers/imageService'
+import { QueryContext } from '..'
 
 type ClipSource = {
   binaryUrl: string
@@ -26,8 +27,11 @@ interface ClipVideo {
 }
 
 export class Clip implements ClipVideo {
-  constructor(private clip: ClipMetadata, private layout?: string) {}
-
+  constructor(
+    private clip: ClipMetadata,
+    private context: QueryContext,
+    private layout?: string
+  ) {}
   type() {
     return 'clip'
   }
@@ -83,7 +87,7 @@ export class Clip implements ClipVideo {
     return url
       ? imageServiceUrl({
           url,
-          systemCode: 'cp-content-pipeline',
+          systemCode: this.context.systemCode,
           width:
             this.layout && mapSizes[this.layout] ? mapSizes[this.layout] : 700,
         })

package/src/model/Concept.ts

@@ -53,7 +53,7 @@ export class Concept {
   #systemCode: string
 
   constructor(private capiConcept: Annotation, private context: QueryContext) {
-    this.#systemCode = context.systemCode ?? 'cp-content-pipeline'
+    this.#systemCode = context.systemCode
   }
 
   apiUrl() {

package/src/model/FlourishSource.ts

@@ -43,7 +43,7 @@ export class FlourishSource {
     private flourishData: FlourishData,
     private context: QueryContext
   ) {
-    this.#systemCode = context.systemCode ?? 'cp-content-pipeline'
+    this.#systemCode = context.systemCode
   }
 
   id() {
@@ -71,10 +71,7 @@ export class FlourishSource {
     }/thumbnail?cacheBuster=${cacheBusterTimestamp}`
   }
 
-  static async getImageMetadata(
-    data: FlourishData,
-    context: QueryContext
-  ) {
+  static async getImageMetadata(data: FlourishData, context: QueryContext) {
     const url = FlourishSource.fallbackUrl(data)
 
     try {
@@ -114,7 +111,7 @@ export class FlourishSource {
   url() {
     return imageServiceUrl({
       url: this.flourishUrl(),
-      systemCode: 'cp-content-pipeline',
+      systemCode: this.context.systemCode,
       width: this.width(),
     })
   }

package/src/model/Image.test.ts

@@ -50,9 +50,7 @@ describe('Image', () => {
       it('transforms the URL to use the Origami Image Service', () => {
         expect(
           sourceSet.every((source) =>
-            source.url.startsWith(
-              'https://www.ft.com/__origami/service/image/v2'
-            )
+            source.url.startsWith('https://images.ft.com/v3/image')
           )
         ).toBeTruthy()
       })
@@ -83,7 +81,7 @@ describe('Image', () => {
         expect(sourceSet.length).toEqual(1)
         expect(sourceSet[0]).toEqual({
           dpr: 1,
-          url: 'https://www.ft.com/__origami/service/image/v2/images/raw/ftcms%3A00000000-0000-0000-0000-000000000001?source=image-test&fit=scale-down&quality=highest&width=1000&dpr=1',
+          url: 'https://images.ft.com/v3/image/raw/ftcms%3A00000000-0000-0000-0000-000000000001?source=image-test&fit=scale-down&quality=highest&width=1000&dpr=1',
           width: 1000,
         })
       })
@@ -97,7 +95,7 @@ describe('Image', () => {
         expect(sourceSet.length).toEqual(1)
         expect(sourceSet[0]).toEqual({
           dpr: 1,
-          url: 'https://www.ft.com/__origami/service/image/v2/images/raw/ftcms%3A00000000-0000-0000-0000-000000000001?source=image-test&fit=scale-down&quality=highest&width=500&dpr=1',
+          url: 'https://images.ft.com/v3/image/raw/ftcms%3A00000000-0000-0000-0000-000000000001?source=image-test&fit=scale-down&quality=highest&width=500&dpr=1',
           width: 500,
         })
       })
@@ -153,12 +151,12 @@ describe('Image', () => {
           Array [
             Object {
               "dpr": 1,
-              "url": "https://www.ft.com/__origami/service/image/v2/images/raw/ftcms%3A00000000-0000-0000-0000-000000000001?source=image-test&fit=scale-down&quality=highest&width=3000&dpr=1",
+              "url": "https://images.ft.com/v3/image/raw/ftcms%3A00000000-0000-0000-0000-000000000001?source=image-test&fit=scale-down&quality=highest&width=3000&dpr=1",
               "width": 3000,
             },
             Object {
               "dpr": 2,
-              "url": "https://www.ft.com/__origami/service/image/v2/images/raw/ftcms%3A00000000-0000-0000-0000-000000000001?source=image-test&fit=scale-down&quality=highest&width=3000&dpr=2",
+              "url": "https://images.ft.com/v3/image/raw/ftcms%3A00000000-0000-0000-0000-000000000001?source=image-test&fit=scale-down&quality=highest&width=3000&dpr=2",
               "width": 3000,
             },
           ]

package/src/model/Image.ts

@@ -41,7 +41,7 @@ export class CAPIImage implements Image {
     private context: QueryContext,
     private leadImage?: LeadImage
   ) {
-    this.#systemCode = context.systemCode ?? 'cp-content-pipeline'
+    this.#systemCode = context.systemCode
     this.#dataSources = context.dataSources
   }
 

package/src/model/LeadFlourish.ts

@@ -5,7 +5,7 @@ import { FlourishSource } from './FlourishSource'
 export class LeadFlourish {
   #systemCode: string
   constructor(private capiResponse: Content, private context: QueryContext) {
-    this.#systemCode = context.systemCode ?? 'cp-content-pipeline'
+    this.#systemCode = context.systemCode
   }
 
   async fallbackImage() {

package/src/model/Person.test.ts

@@ -28,14 +28,14 @@ describe('Person model', () => {
     it('returns the headshot for an author', async () => {
       const model = new Person(capiPerson as CapiPerson, context)
       expect(await model.headshot({})).toEqual(
-        '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=image-test&fit=scale-down&quality=highest&width=150&dpr=1'
+        'https://images.ft.com/v3/image/raw/https%3A%2F%2Fd1e00ek4ebabms.cloudfront.net%2Fproduction%2Fuploaded-files%2Ffthead-v1_robert-shrimsley-cc467908-15d6-474d-94d8-171594ceabb9.png?source=image-test&fit=scale-down&quality=highest&width=150&dpr=1'
       )
     })
 
     it('can resize headshot and provide high resolution version', async () => {
       const model = new Person(capiPerson as CapiPerson, context)
       expect(await model.headshot({ width: 300, dpr: 2 })).toEqual(
-        '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=image-test&fit=scale-down&quality=highest&width=300&dpr=2'
+        'https://images.ft.com/v3/image/raw/https%3A%2F%2Fd1e00ek4ebabms.cloudfront.net%2Fproduction%2Fuploaded-files%2Ffthead-v1_robert-shrimsley-cc467908-15d6-474d-94d8-171594ceabb9.png?source=image-test&fit=scale-down&quality=highest&width=300&dpr=2'
       )
     })
 

package/src/model/Person.ts

@@ -59,7 +59,7 @@ export class Person {
   }
 
   constructor(private person: CapiPerson, private context: QueryContext) {
-    this.#systemCode = context.systemCode ?? 'cp-content-pipeline'
+    this.#systemCode = context.systemCode
   }
 
   prefLabel() {

package/src/model/Picture.test.ts

@@ -34,12 +34,13 @@ describe('Picture model', () => {
   } as ImageSet
 
   const mockContext = {} as QueryContext
+  mockContext.systemCode = 'cp-content-pipeline-api'
 
   describe('finding the standard image', () => {
     it('uses the StandardInline image if it exists', () => {
       const picture = new Picture(mockImageSet, isLiveBlog, mockContext)
       expect(picture.standard().url()).toEqual(
-        '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'
+        'https://images.ft.com/v3/image/raw/https%3A%2F%2Fcloudfront.com%2Fstandard-inline.jpg?source=cp-content-pipeline-api&fit=scale-down&quality=highest&width=700&dpr=1'
       )
     })
 
@@ -51,6 +52,7 @@ describe('Picture model', () => {
         apiUrl: 'https://api.ft.com/content/image-set',
         canBeSyndicated: 'verify',
         description: 'imageset description',
+        systemCode: 'cp-content-pipeline-api',
         id: 'https://api.ft.com/content/image-set',
         members: [
           {
@@ -81,7 +83,7 @@ describe('Picture model', () => {
         mockContext
       )
       expect(picture.standard().url()).toEqual(
-        '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'
+        'https://images.ft.com/v3/image/raw/https%3A%2F%2Fcloudfront.com%2Fdesktop.jpg?source=cp-content-pipeline-api&fit=scale-down&quality=highest&width=700&dpr=1'
       )
     })
   })

package/src/model/Topper.test.ts

@@ -15,6 +15,8 @@ import imageServiceUrl from '../helpers/imageService'
 import { capiPerson } from '../fixtures/capiPerson'
 
 const context = {} as unknown as QueryContext
+context.systemCode = 'cp-content-pipeline'
+
 describe('produces the correct types', () => {
   it('defaults when there is no topper, is normal headline, is paper background', () => {
     const clonedBase = cloneDeep(baseCapiObject)
@@ -375,7 +377,7 @@ describe('produces correct images', () => {
     const topper = new Topper(capiResponse, context)
     const fallback = topper.fallbackImage()
     expect(fallback?.url()).toEqual(
-      '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'
+      'https://images.ft.com/v3/image/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', () => {
@@ -505,7 +507,7 @@ describe('headshot method', () => {
       .mockResolvedValue(new Person(capiPerson, context))
 
     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'
+      'https://images.ft.com/v3/image/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

@@ -45,7 +45,7 @@ export class Topper {
   #systemCode: string
 
   constructor(private capiResponse: Content, private context: QueryContext) {
-    this.#systemCode = context.systemCode ?? 'cp-content-pipeline'
+    this.#systemCode = context.systemCode
   }
 
   intro() {

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

@@ -11,6 +11,7 @@ import {
   ClipSetResolvers,
 } from '../../../generated'
 import { ReferenceWithCAPIData } from '.'
+import type { QueryContext } from '../../..'
 
 function getClipSet(
   parent: ReferenceWithCAPIData<
@@ -72,12 +73,12 @@ export const ClipSet = {
   source: (parent) => getClipSet(parent)?.source || null,
   subtitle: (parent) => getClipSet(parent)?.subtitle || null,
   publishedDate: (parent) => getClipSet(parent)?.publishedDate || null,
-  async clips(parent) {
+  async clips(parent, _args: object, context: QueryContext) {
     const clipSet = getClipSet(parent)
 
     return clipSet && clipSet.members && clipSet.members.length > 0
       ? clipSet.members.map(
-          (clip) => new Clip(clip, parent.reference.dataLayout)
+          (clip) => new Clip(clip, context, parent.reference.dataLayout)
         )
       : null
   },

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

@@ -28,7 +28,7 @@ class RawImageModel implements Image {
   url() {
     return imageServiceUrl({
       url: this.rawImage.url,
-      systemCode: this.context.systemCode ?? 'cp-content-pipeline',
+      systemCode: this.context.systemCode,
       width: this.rawImage.width,
     })
   }