@financial-times/cp-content-pipeline-schema 3.0.4 → 3.1.1

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

@@ -76,6 +76,9 @@ export declare const articleSchema: import("zod").ZodObject<import("zod").object
     }>, "many">;
     webUrl: import("zod").ZodOptional<import("zod").ZodString>;
     canonicalWebUrl: import("zod").ZodOptional<import("zod").ZodString>;
+    apiUrl: import("zod").ZodOptional<import("zod").ZodString>;
+    path: import("zod").ZodString;
+    versionRange: 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<{
@@ -1296,6 +1299,197 @@ export declare const articleSchema: import("zod").ZodObject<import("zod").object
             }[] | undefined;
             transcript?: string | undefined;
         } | undefined;
+    }>, import("zod").ZodObject<import("zod").objectUtil.extendShape<import("zod").objectUtil.extendShape<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;
+            prefLabel: import("zod").ZodString;
+            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, {
+            id: string;
+            apiUrl: string;
+            directType: string;
+            prefLabel: string;
+            types: string[];
+            predicate: string;
+            type?: string | undefined;
+            headshot?: string | undefined;
+        }, {
+            id: string;
+            apiUrl: string;
+            directType: string;
+            prefLabel: string;
+            types: string[];
+            predicate: string;
+            type?: string | undefined;
+            headshot?: string | undefined;
+        }>, "many">;
+        webUrl: import("zod").ZodOptional<import("zod").ZodString>;
+        canonicalWebUrl: import("zod").ZodOptional<import("zod").ZodString>;
+        apiUrl: import("zod").ZodOptional<import("zod").ZodString>;
+        path: import("zod").ZodString;
+        versionRange: 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;
+            scoop: import("zod").ZodBoolean;
+        }, "strip", import("zod").ZodTypeAny, {
+            editorsChoice: boolean;
+            exclusive: boolean;
+            scoop: boolean;
+        }, {
+            editorsChoice: boolean;
+            exclusive: boolean;
+            scoop: boolean;
+        }>>;
+        publishedDate: import("zod").ZodString;
+        firstPublishedDate: import("zod").ZodString;
+        publishReference: import("zod").ZodOptional<import("zod").ZodString>;
+        lastModified: import("zod").ZodOptional<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">]>;
+        canBeDistributed: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"yes">, import("zod").ZodLiteral<"no">, import("zod").ZodLiteral<"verify">]>>;
+        topper: import("zod").ZodOptional<import("zod").ZodObject<{
+            headline: import("zod").ZodOptional<import("zod").ZodString>;
+            standfirst: import("zod").ZodOptional<import("zod").ZodString>;
+            backgroundColour: import("zod").ZodString;
+            backgroundBox: import("zod").ZodOptional<import("zod").ZodBoolean>;
+            textShadow: import("zod").ZodOptional<import("zod").ZodBoolean>;
+            layout: import("zod").ZodString;
+            layoutWidth: import("zod").ZodOptional<import("zod").ZodString>;
+        }, "strip", import("zod").ZodTypeAny, {
+            backgroundColour: string;
+            layout: string;
+            headline?: string | undefined;
+            standfirst?: string | undefined;
+            backgroundBox?: boolean | undefined;
+            textShadow?: boolean | undefined;
+            layoutWidth?: string | undefined;
+        }, {
+            backgroundColour: string;
+            layout: string;
+            headline?: string | undefined;
+            standfirst?: string | undefined;
+            backgroundBox?: boolean | undefined;
+            textShadow?: boolean | undefined;
+            layoutWidth?: string | undefined;
+        }>>;
+        comments: import("zod").ZodOptional<import("zod").ZodObject<{
+            enabled: import("zod").ZodBoolean;
+        }, "strip", import("zod").ZodTypeAny, {
+            enabled: boolean;
+        }, {
+            enabled: boolean;
+        }>>;
+        containedIn: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
+            apiUrl: import("zod").ZodString;
+            id: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            id: string;
+            apiUrl: string;
+        }, {
+            id: string;
+            apiUrl: string;
+        }>, "many">>;
+        tableOfContents: import("zod").ZodOptional<import("zod").ZodObject<{
+            labelType: import("zod").ZodString;
+            sequence: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            labelType: string;
+            sequence: string;
+        }, {
+            labelType: string;
+            sequence: string;
+        }>>;
+    }, "id" | "publishedDate" | "canonicalWebUrl" | "firstPublishedDate" | "publishReference" | "canBeSyndicated" | "canBeDistributed">, Pick<{
+        title: import("zod").ZodString;
+        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";
+        }>;
+        transcript: import("zod").ZodOptional<import("zod").ZodString>;
+    }, "bodyXML">>, {
+        apiUrl: import("zod").ZodString;
+        type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/CustomCodeComponent">;
+        path: import("zod").ZodString;
+        versionRange: import("zod").ZodString;
+        attributes: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodBoolean, import("zod").ZodUndefined]>>;
+    }>, "strip", import("zod").ZodTypeAny, {
+        id: string;
+        apiUrl: string;
+        type: "http://www.ft.com/ontology/content/CustomCodeComponent";
+        path: string;
+        publishedDate: string;
+        versionRange: string;
+        firstPublishedDate: string;
+        canBeSyndicated: "unknown" | "yes" | "no" | "verify" | "withContributorPayment";
+        bodyXML: string;
+        attributes: Record<string, string | boolean | undefined>;
+        canonicalWebUrl?: string | undefined;
+        publishReference?: string | undefined;
+        canBeDistributed?: "yes" | "no" | "verify" | undefined;
+    }, {
+        id: string;
+        apiUrl: string;
+        type: "http://www.ft.com/ontology/content/CustomCodeComponent";
+        path: string;
+        publishedDate: string;
+        versionRange: string;
+        firstPublishedDate: string;
+        canBeSyndicated: "unknown" | "yes" | "no" | "verify" | "withContributorPayment";
+        bodyXML: string;
+        attributes: Record<string, string | boolean | undefined>;
+        canonicalWebUrl?: string | undefined;
+        publishReference?: string | undefined;
+        canBeDistributed?: "yes" | "no" | "verify" | undefined;
     }>]>, "many">>;
     dataSource: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
         binaryUrl: import("zod").ZodString;
@@ -1585,6 +1779,20 @@ export declare const articleSchema: import("zod").ZodObject<import("zod").object
             }[] | undefined;
             transcript?: string | undefined;
         } | undefined;
+    } | {
+        id: string;
+        apiUrl: string;
+        type: "http://www.ft.com/ontology/content/CustomCodeComponent";
+        path: string;
+        publishedDate: string;
+        versionRange: string;
+        firstPublishedDate: string;
+        canBeSyndicated: "unknown" | "yes" | "no" | "verify" | "withContributorPayment";
+        bodyXML: string;
+        attributes: Record<string, string | boolean | undefined>;
+        canonicalWebUrl?: string | undefined;
+        publishReference?: string | undefined;
+        canBeDistributed?: "yes" | "no" | "verify" | undefined;
     })[] | undefined;
 }, {
     id: string;
@@ -1858,5 +2066,19 @@ export declare const articleSchema: import("zod").ZodObject<import("zod").object
             }[] | undefined;
             transcript?: string | undefined;
         } | undefined;
+    } | {
+        id: string;
+        apiUrl: string;
+        type: "http://www.ft.com/ontology/content/CustomCodeComponent";
+        path: string;
+        publishedDate: string;
+        versionRange: string;
+        firstPublishedDate: string;
+        canBeSyndicated: "unknown" | "yes" | "no" | "verify" | "withContributorPayment";
+        bodyXML: string;
+        attributes: Record<string, string | boolean | undefined>;
+        canonicalWebUrl?: string | undefined;
+        publishReference?: string | undefined;
+        canBeDistributed?: "yes" | "no" | "verify" | undefined;
     })[] | undefined;
 }>;

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

@@ -76,6 +76,9 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
     }>, "many">;
     webUrl: import("zod").ZodOptional<import("zod").ZodString>;
     canonicalWebUrl: import("zod").ZodOptional<import("zod").ZodString>;
+    apiUrl: import("zod").ZodOptional<import("zod").ZodString>;
+    path: import("zod").ZodString;
+    versionRange: 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<{
@@ -1296,6 +1299,197 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
             }[] | undefined;
             transcript?: string | undefined;
         } | undefined;
+    }>, import("zod").ZodObject<import("zod").objectUtil.extendShape<import("zod").objectUtil.extendShape<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;
+            prefLabel: import("zod").ZodString;
+            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, {
+            id: string;
+            apiUrl: string;
+            directType: string;
+            prefLabel: string;
+            types: string[];
+            predicate: string;
+            type?: string | undefined;
+            headshot?: string | undefined;
+        }, {
+            id: string;
+            apiUrl: string;
+            directType: string;
+            prefLabel: string;
+            types: string[];
+            predicate: string;
+            type?: string | undefined;
+            headshot?: string | undefined;
+        }>, "many">;
+        webUrl: import("zod").ZodOptional<import("zod").ZodString>;
+        canonicalWebUrl: import("zod").ZodOptional<import("zod").ZodString>;
+        apiUrl: import("zod").ZodOptional<import("zod").ZodString>;
+        path: import("zod").ZodString;
+        versionRange: 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;
+            scoop: import("zod").ZodBoolean;
+        }, "strip", import("zod").ZodTypeAny, {
+            editorsChoice: boolean;
+            exclusive: boolean;
+            scoop: boolean;
+        }, {
+            editorsChoice: boolean;
+            exclusive: boolean;
+            scoop: boolean;
+        }>>;
+        publishedDate: import("zod").ZodString;
+        firstPublishedDate: import("zod").ZodString;
+        publishReference: import("zod").ZodOptional<import("zod").ZodString>;
+        lastModified: import("zod").ZodOptional<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">]>;
+        canBeDistributed: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"yes">, import("zod").ZodLiteral<"no">, import("zod").ZodLiteral<"verify">]>>;
+        topper: import("zod").ZodOptional<import("zod").ZodObject<{
+            headline: import("zod").ZodOptional<import("zod").ZodString>;
+            standfirst: import("zod").ZodOptional<import("zod").ZodString>;
+            backgroundColour: import("zod").ZodString;
+            backgroundBox: import("zod").ZodOptional<import("zod").ZodBoolean>;
+            textShadow: import("zod").ZodOptional<import("zod").ZodBoolean>;
+            layout: import("zod").ZodString;
+            layoutWidth: import("zod").ZodOptional<import("zod").ZodString>;
+        }, "strip", import("zod").ZodTypeAny, {
+            backgroundColour: string;
+            layout: string;
+            headline?: string | undefined;
+            standfirst?: string | undefined;
+            backgroundBox?: boolean | undefined;
+            textShadow?: boolean | undefined;
+            layoutWidth?: string | undefined;
+        }, {
+            backgroundColour: string;
+            layout: string;
+            headline?: string | undefined;
+            standfirst?: string | undefined;
+            backgroundBox?: boolean | undefined;
+            textShadow?: boolean | undefined;
+            layoutWidth?: string | undefined;
+        }>>;
+        comments: import("zod").ZodOptional<import("zod").ZodObject<{
+            enabled: import("zod").ZodBoolean;
+        }, "strip", import("zod").ZodTypeAny, {
+            enabled: boolean;
+        }, {
+            enabled: boolean;
+        }>>;
+        containedIn: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
+            apiUrl: import("zod").ZodString;
+            id: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            id: string;
+            apiUrl: string;
+        }, {
+            id: string;
+            apiUrl: string;
+        }>, "many">>;
+        tableOfContents: import("zod").ZodOptional<import("zod").ZodObject<{
+            labelType: import("zod").ZodString;
+            sequence: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
+            labelType: string;
+            sequence: string;
+        }, {
+            labelType: string;
+            sequence: string;
+        }>>;
+    }, "id" | "publishedDate" | "canonicalWebUrl" | "firstPublishedDate" | "publishReference" | "canBeSyndicated" | "canBeDistributed">, Pick<{
+        title: import("zod").ZodString;
+        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";
+        }>;
+        transcript: import("zod").ZodOptional<import("zod").ZodString>;
+    }, "bodyXML">>, {
+        apiUrl: import("zod").ZodString;
+        type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/CustomCodeComponent">;
+        path: import("zod").ZodString;
+        versionRange: import("zod").ZodString;
+        attributes: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodBoolean, import("zod").ZodUndefined]>>;
+    }>, "strip", import("zod").ZodTypeAny, {
+        id: string;
+        apiUrl: string;
+        type: "http://www.ft.com/ontology/content/CustomCodeComponent";
+        path: string;
+        publishedDate: string;
+        versionRange: string;
+        firstPublishedDate: string;
+        canBeSyndicated: "unknown" | "yes" | "no" | "verify" | "withContributorPayment";
+        bodyXML: string;
+        attributes: Record<string, string | boolean | undefined>;
+        canonicalWebUrl?: string | undefined;
+        publishReference?: string | undefined;
+        canBeDistributed?: "yes" | "no" | "verify" | undefined;
+    }, {
+        id: string;
+        apiUrl: string;
+        type: "http://www.ft.com/ontology/content/CustomCodeComponent";
+        path: string;
+        publishedDate: string;
+        versionRange: string;
+        firstPublishedDate: string;
+        canBeSyndicated: "unknown" | "yes" | "no" | "verify" | "withContributorPayment";
+        bodyXML: string;
+        attributes: Record<string, string | boolean | undefined>;
+        canonicalWebUrl?: string | undefined;
+        publishReference?: string | undefined;
+        canBeDistributed?: "yes" | "no" | "verify" | undefined;
     }>]>, "many">>;
     dataSource: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
         binaryUrl: import("zod").ZodString;