@financial-times/cp-content-pipeline-schema 2.10.0 → 2.10.2

package/lib/model/schemas/capi/placeholder.d.ts

@@ -1,11 +1,50 @@
-export declare const placeholderSchema: import("zod").ZodObject<{
-    id: import("zod").ZodString;
-    type: import("zod").ZodOptional<import("zod").ZodString>;
-    types: import("zod").ZodArray<import("zod").ZodString, "many">;
-    standfirst: import("zod").ZodOptional<import("zod").ZodString>;
+export declare const placeholderSchema: import("zod").ZodObject<import("zod").objectUtil.extendShape<import("zod").objectUtil.extendShape<Pick<{
     title: import("zod").ZodString;
-    publishedDate: import("zod").ZodString;
-    annotations: import("zod").ZodArray<import("zod").ZodObject<{
+    standfirst: import("zod").ZodOptional<import("zod").ZodString>;
+    byline: import("zod").ZodOptional<import("zod").ZodString>;
+    bodyXML: import("zod").ZodString;
+    summary: import("zod").ZodObject<{
+        bodyXML: import("zod").ZodString;
+    }, "strip", import("zod").ZodTypeAny, {
+        bodyXML: string;
+    }, {
+        bodyXML: string;
+    }>;
+    alternativeTitles: import("zod").ZodOptional<import("zod").ZodObject<{
+        promotionalTitle: import("zod").ZodString;
+    }, "strip", import("zod").ZodTypeAny, {
+        promotionalTitle: string;
+    }, {
+        promotionalTitle: string;
+    }>>;
+    alternativeStandfirsts: import("zod").ZodOptional<import("zod").ZodObject<{
+        promotionalStandfirst: import("zod").ZodOptional<import("zod").ZodString>;
+    }, "strip", import("zod").ZodTypeAny, {
+        promotionalStandfirst?: string | undefined;
+    }, {
+        promotionalStandfirst?: string | undefined;
+    }>>;
+    pinnedPosts: import("zod").ZodArray<import("zod").ZodString, "many">;
+    contains: import("zod").ZodArray<import("zod").ZodObject<{
+        id: import("zod").ZodString;
+        apiUrl: import("zod").ZodString;
+    }, "strip", import("zod").ZodTypeAny, {
+        id: string;
+        apiUrl: string;
+    }, {
+        id: string;
+        apiUrl: string;
+    }>, "many">;
+    design: import("zod").ZodObject<{
+        theme: import("zod").ZodUnion<[import("zod").ZodLiteral<"special-report">, import("zod").ZodLiteral<"extra">, import("zod").ZodLiteral<"basic">, import("zod").ZodLiteral<"extra-wide">]>;
+    }, "strip", import("zod").ZodTypeAny, {
+        theme: "special-report" | "extra" | "basic" | "extra-wide";
+    }, {
+        theme: "special-report" | "extra" | "basic" | "extra-wide";
+    }>;
+}, "standfirst" | "title" | "byline" | "bodyXML" | "alternativeTitles" | "alternativeStandfirsts">, Pick<{
+    id: import("zod").ZodString;
+    annotations: import("zod").ZodArray<import("zod").ZodObject<import("zod").objectUtil.extendShape<{
         id: import("zod").ZodString;
         apiUrl: import("zod").ZodString;
         directType: import("zod").ZodString;
@@ -13,8 +52,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
         type: import("zod").ZodOptional<import("zod").ZodString>;
         types: import("zod").ZodArray<import("zod").ZodString, "many">;
         headshot: import("zod").ZodOptional<import("zod").ZodString>;
+    }, {
         predicate: import("zod").ZodString;
-    }, "strip", import("zod").ZodTypeAny, {
+    }>, "strip", import("zod").ZodTypeAny, {
         id: string;
         apiUrl: string;
         directType: string;
@@ -35,6 +75,8 @@ export declare const placeholderSchema: import("zod").ZodObject<{
     }>, "many">;
     webUrl: import("zod").ZodOptional<import("zod").ZodString>;
     canonicalWebUrl: import("zod").ZodOptional<import("zod").ZodString>;
+    type: import("zod").ZodOptional<import("zod").ZodString>;
+    types: import("zod").ZodArray<import("zod").ZodString, "many">;
     standout: import("zod").ZodOptional<import("zod").ZodObject<{
         editorsChoice: import("zod").ZodBoolean;
         exclusive: import("zod").ZodBoolean;
@@ -48,7 +90,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
         exclusive: boolean;
         scoop: boolean;
     }>>;
+    publishedDate: import("zod").ZodString;
     firstPublishedDate: import("zod").ZodString;
+    realtime: import("zod").ZodBoolean;
     editorialDesk: import("zod").ZodOptional<import("zod").ZodString>;
     accessLevel: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"premium">, import("zod").ZodLiteral<"subscribed">, import("zod").ZodLiteral<"registered">, import("zod").ZodLiteral<"free">]>>;
     canBeSyndicated: import("zod").ZodUnion<[import("zod").ZodLiteral<"yes">, import("zod").ZodLiteral<"no">, import("zod").ZodLiteral<"verify">, import("zod").ZodLiteral<"withContributorPayment">, import("zod").ZodLiteral<"unknown">]>;
@@ -95,22 +139,17 @@ export declare const placeholderSchema: import("zod").ZodObject<{
         id: string;
         apiUrl: string;
     }>, "many">>;
-    byline: import("zod").ZodOptional<import("zod").ZodString>;
-    bodyXML: import("zod").ZodString;
-    alternativeTitles: import("zod").ZodOptional<import("zod").ZodObject<{
-        promotionalTitle: import("zod").ZodString;
-    }, "strip", import("zod").ZodTypeAny, {
-        promotionalTitle: string;
-    }, {
-        promotionalTitle: string;
-    }>>;
-    alternativeStandfirsts: import("zod").ZodOptional<import("zod").ZodObject<{
-        promotionalStandfirst: import("zod").ZodOptional<import("zod").ZodString>;
+    tableOfContents: import("zod").ZodOptional<import("zod").ZodObject<{
+        labelType: import("zod").ZodString;
+        sequence: import("zod").ZodString;
     }, "strip", import("zod").ZodTypeAny, {
-        promotionalStandfirst?: string | undefined;
+        labelType: string;
+        sequence: string;
     }, {
-        promotionalStandfirst?: string | undefined;
+        labelType: string;
+        sequence: string;
     }>>;
+}, "id" | "type" | "types" | "publishedDate" | "annotations" | "webUrl" | "canonicalWebUrl" | "standout" | "firstPublishedDate" | "editorialDesk" | "accessLevel" | "canBeSyndicated" | "canBeDistributed" | "topper" | "comments" | "containedIn">>, Pick<{
     mainImage: import("zod").ZodOptional<import("zod").ZodDiscriminatedUnion<"type", [import("zod").ZodObject<{
         id: import("zod").ZodString;
         type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/ImageSet">;
@@ -161,8 +200,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
             maxDisplayWidth?: string | undefined;
             pixelWidth?: number | undefined;
             pixelHeight?: number | undefined;
-        }>, import("zod").ZodObject<{
+        }>, import("zod").ZodObject<import("zod").objectUtil.extendShape<{
             id: import("zod").ZodString;
+            type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Image">;
             format: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"standardInline">, import("zod").ZodLiteral<"mobile">, import("zod").ZodLiteral<"desktop">, import("zod").ZodLiteral<"standard">, import("zod").ZodLiteral<"square">, import("zod").ZodLiteral<"ftEditSquare">, import("zod").ZodLiteral<"wide">, import("zod").ZodLiteral<"portrait">, import("zod").ZodLiteral<"landscape">]>>;
             title: import("zod").ZodOptional<import("zod").ZodString>;
             description: import("zod").ZodOptional<import("zod").ZodString>;
@@ -178,8 +218,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
             maxDisplayWidth: import("zod").ZodOptional<import("zod").ZodString>;
             pixelWidth: import("zod").ZodOptional<import("zod").ZodNumber>;
             pixelHeight: import("zod").ZodOptional<import("zod").ZodNumber>;
+        }, {
             type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Graphic">;
-        }, "strip", import("zod").ZodTypeAny, {
+        }>, "strip", import("zod").ZodTypeAny, {
             id: string;
             type: "http://www.ft.com/ontology/content/Graphic";
             binaryUrl: string;
@@ -320,8 +361,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
         maxDisplayWidth?: string | undefined;
         pixelWidth?: number | undefined;
         pixelHeight?: number | undefined;
-    }>, import("zod").ZodObject<{
+    }>, import("zod").ZodObject<import("zod").objectUtil.extendShape<{
         id: import("zod").ZodString;
+        type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Image">;
         format: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"standardInline">, import("zod").ZodLiteral<"mobile">, import("zod").ZodLiteral<"desktop">, import("zod").ZodLiteral<"standard">, import("zod").ZodLiteral<"square">, import("zod").ZodLiteral<"ftEditSquare">, import("zod").ZodLiteral<"wide">, import("zod").ZodLiteral<"portrait">, import("zod").ZodLiteral<"landscape">]>>;
         title: import("zod").ZodOptional<import("zod").ZodString>;
         description: import("zod").ZodOptional<import("zod").ZodString>;
@@ -337,8 +379,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
         maxDisplayWidth: import("zod").ZodOptional<import("zod").ZodString>;
         pixelWidth: import("zod").ZodOptional<import("zod").ZodNumber>;
         pixelHeight: import("zod").ZodOptional<import("zod").ZodNumber>;
+    }, {
         type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Graphic">;
-    }, "strip", import("zod").ZodTypeAny, {
+    }>, "strip", import("zod").ZodTypeAny, {
         id: string;
         type: "http://www.ft.com/ontology/content/Graphic";
         binaryUrl: string;
@@ -416,8 +459,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
             maxDisplayWidth?: string | undefined;
             pixelWidth?: number | undefined;
             pixelHeight?: number | undefined;
-        }>, import("zod").ZodObject<{
+        }>, import("zod").ZodObject<import("zod").objectUtil.extendShape<{
             id: import("zod").ZodString;
+            type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Image">;
             format: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"standardInline">, import("zod").ZodLiteral<"mobile">, import("zod").ZodLiteral<"desktop">, import("zod").ZodLiteral<"standard">, import("zod").ZodLiteral<"square">, import("zod").ZodLiteral<"ftEditSquare">, import("zod").ZodLiteral<"wide">, import("zod").ZodLiteral<"portrait">, import("zod").ZodLiteral<"landscape">]>>;
             title: import("zod").ZodOptional<import("zod").ZodString>;
             description: import("zod").ZodOptional<import("zod").ZodString>;
@@ -433,8 +477,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
             maxDisplayWidth: import("zod").ZodOptional<import("zod").ZodString>;
             pixelWidth: import("zod").ZodOptional<import("zod").ZodNumber>;
             pixelHeight: import("zod").ZodOptional<import("zod").ZodNumber>;
+        }, {
             type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Graphic">;
-        }, "strip", import("zod").ZodTypeAny, {
+        }>, "strip", import("zod").ZodTypeAny, {
             id: string;
             type: "http://www.ft.com/ontology/content/Graphic";
             binaryUrl: string;
@@ -609,6 +654,19 @@ export declare const placeholderSchema: import("zod").ZodObject<{
             pixelHeight?: number | undefined;
         };
     }>>;
+    leadFlourish: import("zod").ZodOptional<import("zod").ZodObject<{
+        id: import("zod").ZodString;
+        type: import("zod").ZodString;
+        description: import("zod").ZodString;
+    }, "strip", import("zod").ZodTypeAny, {
+        id: string;
+        type: string;
+        description: string;
+    }, {
+        id: string;
+        type: string;
+        description: string;
+    }>>;
     embeds: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodObject<{
         id: import("zod").ZodString;
         type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/ImageSet">;
@@ -659,8 +717,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
             maxDisplayWidth?: string | undefined;
             pixelWidth?: number | undefined;
             pixelHeight?: number | undefined;
-        }>, import("zod").ZodObject<{
+        }>, import("zod").ZodObject<import("zod").objectUtil.extendShape<{
             id: import("zod").ZodString;
+            type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Image">;
             format: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"standardInline">, import("zod").ZodLiteral<"mobile">, import("zod").ZodLiteral<"desktop">, import("zod").ZodLiteral<"standard">, import("zod").ZodLiteral<"square">, import("zod").ZodLiteral<"ftEditSquare">, import("zod").ZodLiteral<"wide">, import("zod").ZodLiteral<"portrait">, import("zod").ZodLiteral<"landscape">]>>;
             title: import("zod").ZodOptional<import("zod").ZodString>;
             description: import("zod").ZodOptional<import("zod").ZodString>;
@@ -676,8 +735,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
             maxDisplayWidth: import("zod").ZodOptional<import("zod").ZodString>;
             pixelWidth: import("zod").ZodOptional<import("zod").ZodNumber>;
             pixelHeight: import("zod").ZodOptional<import("zod").ZodNumber>;
+        }, {
             type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Graphic">;
-        }, "strip", import("zod").ZodTypeAny, {
+        }>, "strip", import("zod").ZodTypeAny, {
             id: string;
             type: "http://www.ft.com/ontology/content/Graphic";
             binaryUrl: string;
@@ -788,20 +848,20 @@ export declare const placeholderSchema: import("zod").ZodObject<{
                 pixelWidth: import("zod").ZodOptional<import("zod").ZodNumber>;
                 videoCodec: import("zod").ZodOptional<import("zod").ZodString>;
             }, "strip", import("zod").ZodTypeAny, {
-                audioCodec?: string | undefined;
                 binaryUrl?: string | undefined;
+                pixelWidth?: number | undefined;
+                pixelHeight?: number | undefined;
+                audioCodec?: string | undefined;
                 duration?: number | undefined;
                 mediaType?: string | undefined;
-                pixelHeight?: number | undefined;
-                pixelWidth?: number | undefined;
                 videoCodec?: string | undefined;
             }, {
-                audioCodec?: string | undefined;
                 binaryUrl?: string | undefined;
+                pixelWidth?: number | undefined;
+                pixelHeight?: number | undefined;
+                audioCodec?: string | undefined;
                 duration?: number | undefined;
                 mediaType?: string | undefined;
-                pixelHeight?: number | undefined;
-                pixelWidth?: number | undefined;
                 videoCodec?: string | undefined;
             }>, "many">;
             poster: import("zod").ZodOptional<import("zod").ZodObject<{
@@ -854,8 +914,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
                     maxDisplayWidth?: string | undefined;
                     pixelWidth?: number | undefined;
                     pixelHeight?: number | undefined;
-                }>, import("zod").ZodObject<{
+                }>, import("zod").ZodObject<import("zod").objectUtil.extendShape<{
                     id: import("zod").ZodString;
+                    type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Image">;
                     format: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"standardInline">, import("zod").ZodLiteral<"mobile">, import("zod").ZodLiteral<"desktop">, import("zod").ZodLiteral<"standard">, import("zod").ZodLiteral<"square">, import("zod").ZodLiteral<"ftEditSquare">, import("zod").ZodLiteral<"wide">, import("zod").ZodLiteral<"portrait">, import("zod").ZodLiteral<"landscape">]>>;
                     title: import("zod").ZodOptional<import("zod").ZodString>;
                     description: import("zod").ZodOptional<import("zod").ZodString>;
@@ -871,8 +932,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
                     maxDisplayWidth: import("zod").ZodOptional<import("zod").ZodString>;
                     pixelWidth: import("zod").ZodOptional<import("zod").ZodNumber>;
                     pixelHeight: import("zod").ZodOptional<import("zod").ZodNumber>;
+                }, {
                     type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Graphic">;
-                }, "strip", import("zod").ZodTypeAny, {
+                }>, "strip", import("zod").ZodTypeAny, {
                     id: string;
                     type: "http://www.ft.com/ontology/content/Graphic";
                     binaryUrl: string;
@@ -972,12 +1034,12 @@ export declare const placeholderSchema: import("zod").ZodObject<{
             id: string;
             type: "http://www.ft.com/ontology/content/Clip";
             dataSource: {
-                audioCodec?: string | undefined;
                 binaryUrl?: string | undefined;
+                pixelWidth?: number | undefined;
+                pixelHeight?: number | undefined;
+                audioCodec?: string | undefined;
                 duration?: number | undefined;
                 mediaType?: string | undefined;
-                pixelHeight?: number | undefined;
-                pixelWidth?: number | undefined;
                 videoCodec?: string | undefined;
             }[];
             format?: "standardInline" | "mobile" | undefined;
@@ -1019,12 +1081,12 @@ export declare const placeholderSchema: import("zod").ZodObject<{
             id: string;
             type: "http://www.ft.com/ontology/content/Clip";
             dataSource: {
-                audioCodec?: string | undefined;
                 binaryUrl?: string | undefined;
+                pixelWidth?: number | undefined;
+                pixelHeight?: number | undefined;
+                audioCodec?: string | undefined;
                 duration?: number | undefined;
                 mediaType?: string | undefined;
-                pixelHeight?: number | undefined;
-                pixelWidth?: number | undefined;
                 videoCodec?: string | undefined;
             }[];
             format?: "standardInline" | "mobile" | undefined;
@@ -1104,12 +1166,12 @@ export declare const placeholderSchema: import("zod").ZodObject<{
             id: string;
             type: "http://www.ft.com/ontology/content/Clip";
             dataSource: {
-                audioCodec?: string | undefined;
                 binaryUrl?: string | undefined;
+                pixelWidth?: number | undefined;
+                pixelHeight?: number | undefined;
+                audioCodec?: string | undefined;
                 duration?: number | undefined;
                 mediaType?: string | undefined;
-                pixelHeight?: number | undefined;
-                pixelWidth?: number | undefined;
                 videoCodec?: string | undefined;
             }[];
             format?: "standardInline" | "mobile" | undefined;
@@ -1148,9 +1210,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
                 description?: string | undefined;
             } | undefined;
         }[];
+        description?: string | undefined;
         caption?: string | undefined;
         dataCopyright?: string | undefined;
-        description?: string | undefined;
         displayTitle?: string | undefined;
         contentWarning?: string[] | undefined;
         noAudio?: boolean | undefined;
@@ -1171,12 +1233,12 @@ export declare const placeholderSchema: import("zod").ZodObject<{
             id: string;
             type: "http://www.ft.com/ontology/content/Clip";
             dataSource: {
-                audioCodec?: string | undefined;
                 binaryUrl?: string | undefined;
+                pixelWidth?: number | undefined;
+                pixelHeight?: number | undefined;
+                audioCodec?: string | undefined;
                 duration?: number | undefined;
                 mediaType?: string | undefined;
-                pixelHeight?: number | undefined;
-                pixelWidth?: number | undefined;
                 videoCodec?: string | undefined;
             }[];
             format?: "standardInline" | "mobile" | undefined;
@@ -1215,9 +1277,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
                 description?: string | undefined;
             } | undefined;
         }[];
+        description?: string | undefined;
         caption?: string | undefined;
         dataCopyright?: string | undefined;
-        description?: string | undefined;
         displayTitle?: string | undefined;
         contentWarning?: string[] | undefined;
         noAudio?: boolean | undefined;
@@ -1232,7 +1294,23 @@ export declare const placeholderSchema: import("zod").ZodObject<{
             transcript?: string | undefined;
         } | undefined;
     }>]>, "many">>;
-}, "strip", import("zod").ZodTypeAny, {
+    dataSource: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
+        binaryUrl: import("zod").ZodString;
+        duration: import("zod").ZodNumber;
+        filesize: import("zod").ZodNumber;
+        mediaType: import("zod").ZodString;
+    }, "strip", import("zod").ZodTypeAny, {
+        binaryUrl: string;
+        duration: number;
+        mediaType: string;
+        filesize: number;
+    }, {
+        binaryUrl: string;
+        duration: number;
+        mediaType: string;
+        filesize: number;
+    }>, "many">>;
+}, "mainImage" | "leadImages" | "alternativeImages" | "embeds">>, "strip", import("zod").ZodTypeAny, {
     id: string;
     types: string[];
     title: string;
@@ -1437,12 +1515,12 @@ export declare const placeholderSchema: import("zod").ZodObject<{
             id: string;
             type: "http://www.ft.com/ontology/content/Clip";
             dataSource: {
-                audioCodec?: string | undefined;
                 binaryUrl?: string | undefined;
+                pixelWidth?: number | undefined;
+                pixelHeight?: number | undefined;
+                audioCodec?: string | undefined;
                 duration?: number | undefined;
                 mediaType?: string | undefined;
-                pixelHeight?: number | undefined;
-                pixelWidth?: number | undefined;
                 videoCodec?: string | undefined;
             }[];
             format?: "standardInline" | "mobile" | undefined;
@@ -1481,9 +1559,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
                 description?: string | undefined;
             } | undefined;
         }[];
+        description?: string | undefined;
         caption?: string | undefined;
         dataCopyright?: string | undefined;
-        description?: string | undefined;
         displayTitle?: string | undefined;
         contentWarning?: string[] | undefined;
         noAudio?: boolean | undefined;
@@ -1703,12 +1781,12 @@ export declare const placeholderSchema: import("zod").ZodObject<{
             id: string;
             type: "http://www.ft.com/ontology/content/Clip";
             dataSource: {
-                audioCodec?: string | undefined;
                 binaryUrl?: string | undefined;
+                pixelWidth?: number | undefined;
+                pixelHeight?: number | undefined;
+                audioCodec?: string | undefined;
                 duration?: number | undefined;
                 mediaType?: string | undefined;
-                pixelHeight?: number | undefined;
-                pixelWidth?: number | undefined;
                 videoCodec?: string | undefined;
             }[];
             format?: "standardInline" | "mobile" | undefined;
@@ -1747,9 +1825,9 @@ export declare const placeholderSchema: import("zod").ZodObject<{
                 description?: string | undefined;
             } | undefined;
         }[];
+        description?: string | undefined;
         caption?: string | undefined;
         dataCopyright?: string | undefined;
-        description?: string | undefined;
         displayTitle?: string | undefined;
         contentWarning?: string[] | undefined;
         noAudio?: boolean | undefined;

package/package.json

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

package/src/datasources/capi.test.ts

@@ -0,0 +1,54 @@
+import { Logger } from '@dotcom-reliability-kit/logger'
+import { CapiDataSource } from './capi'
+import { QueryContext } from '..'
+import { KeyValueCache } from '@apollo/utils.keyvaluecache'
+import { CapiResponse } from '../model/CapiResponse'
+import { ContentTypeSchemas } from '../types/internal-content'
+
+const logger = new Logger()
+const metrics = { count: jest.fn() }
+
+describe('CapiDataSource', () => {
+  describe('cache keys', () => {
+    it('should return the same cache key that it actually stored in the cache', async () => {
+      const id = '00000000-0000-0000-0000-000000000000'
+      const cache = {
+        get: jest.fn(),
+        set: jest.fn(),
+        delete: jest.fn(),
+      } satisfies KeyValueCache
+      const capi = new CapiDataSource({
+        cache,
+        context: {
+          versions: { api: '1.0.0', schema: '1.0.0' },
+          logger,
+          metrics,
+        } as unknown as QueryContext,
+      })
+
+      jest.spyOn(global, 'fetch').mockResolvedValue(
+        new Response(JSON.stringify({ id }), {
+          headers: new Headers([['content-type', 'application/json']]),
+        })
+      )
+
+      jest
+        .spyOn(CapiResponse, 'fromJSON')
+        .mockImplementation(
+          (content, context) =>
+            new CapiResponse(content as ContentTypeSchemas, context)
+        )
+
+      await capi.getContent(id)
+
+      expect(cache.set).toBeCalled()
+      await expect(capi.getHTTPCacheKeyForContent(id)).resolves.toBe(
+        cache.set.mock.lastCall?.[0]
+      )
+    })
+  })
+
+  afterAll(() => {
+    jest.resetAllMocks()
+  })
+})

package/src/datasources/capi.ts

@@ -2,9 +2,24 @@ import { CapiResponse } from '../model/CapiResponse'
 import { InstrumentedRESTDataSource } from './instrumented'
 import { CapiPerson } from '../types/internal-content'
 import { AugmentedRequest } from '@apollo/datasource-rest'
+import {
+  KeyValueCache,
+  PrefixingKeyValueCache,
+} from '@apollo/utils.keyvaluecache'
 
 const REQUEST_TIMEOUT = 5000 // 5 seconds
 
+const isPrefixing = (cache: KeyValueCache): cache is PrefixingKeyValueCache =>
+  'prefix' in cache
+
+function getWrappedCacheKey(cache: KeyValueCache): string {
+  if (isPrefixing(cache)) {
+    return getWrappedCacheKey(cache['wrapped']) + cache['prefix']
+  }
+
+  return ''
+}
+
 export class CapiDataSource extends InstrumentedRESTDataSource {
   baseURL = process.env.CAPI_URL || 'https://api-t.ft.com/'
   capiKey = process.env.CAPI_API_KEY || ''
@@ -56,4 +71,18 @@ export class CapiDataSource extends InstrumentedRESTDataSource {
       cacheOptions: { ttl: this.peopleCacheTTL },
     })
   }
+
+  // replicates the logic implicit in PrefixingKeyValueCache to
+  // construct a cache key for an article used to purge Redis
+  async getHTTPCacheKeyForContent(uuid: string) {
+    const dummyRequest: AugmentedRequest = {
+      params: new URLSearchParams(),
+      headers: {},
+    }
+    const cacheKey = this.cacheKeyFor(
+      await this.resolveURL(`internalcontent/${uuid}`, dummyRequest)
+    )
+
+    return `${getWrappedCacheKey(this.httpCache['keyValueCache'])}${cacheKey}`
+  }
 }

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

@@ -10,7 +10,6 @@ const contentPackageContentSchema = baseContentSchema
     summary: true,
     alternativeTitles: true,
     contains: true,
-    tableOfContents: true,
     design: true,
     bodyXML: true,
   })

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

@@ -11,7 +11,6 @@ const liveBlogPackageContentSchema = baseContentSchema.pick({
   alternativeTitles: true,
   contains: true,
   pinnedPosts: true,
-  realtime: true,
 })
 
 const liveBlogPackageMetadataSchema = baseMetadataSchema.pick({