@financial-times/content-curation-client 0.1.1 → 0.3.0

package/dist/_tsup-dts-rollup.d.ts

@@ -19,11 +19,17 @@ export { ApiClient as ApiClient_alias_1 }
 /**
  * Configuration options for the API client
  */
-declare interface ApiClientConfig {
+declare type ApiClientConfig = {
     baseUrl: string;
+    apiKey: string;
+    apiToken?: never;
+    fetch?: typeof fetch;
+} | {
+    baseUrl: string;
+    apiKey?: never;
     apiToken: string;
     fetch?: typeof fetch;
-}
+};
 export { ApiClientConfig }
 export { ApiClientConfig as ApiClientConfig_alias_1 }
 
@@ -1674,11 +1680,537 @@ declare type InteractiveSlice = FlourishGraphicSliceType | CustomIframeSliceType
 export { InteractiveSlice }
 export { InteractiveSlice as InteractiveSlice_alias_1 }
 
+declare type LegacyBlock = z.infer<typeof LegacyBlockSchema>;
+export { LegacyBlock }
+export { LegacyBlock as LegacyBlock_alias_1 }
+
+declare const LegacyBlockSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"topper-basic">;
+    children: z.ZodTuple<[], null>;
+    properties: z.ZodObject<{
+        title: z.ZodString;
+        sponsorText: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        sponsorText: string;
+    }, {
+        title: string;
+        sponsorText?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "topper-basic";
+    properties: {
+        title: string;
+        sponsorText: string;
+    };
+    children: [];
+}, {
+    type: "topper-basic";
+    properties: {
+        title: string;
+        sponsorText?: string | undefined;
+    };
+    children: [];
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"info-box">;
+    children: z.ZodTuple<[], null>;
+    properties: z.ZodObject<{
+        bodyHTML: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        bodyHTML: string;
+    }, {
+        bodyHTML: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "info-box";
+    properties: {
+        bodyHTML: string;
+    };
+    children: [];
+}, {
+    type: "info-box";
+    properties: {
+        bodyHTML: string;
+    };
+    children: [];
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"container">;
+    children: z.ZodArray<z.ZodDiscriminatedUnion<"source", [z.ZodObject<{
+        source: z.ZodLiteral<"flourish">;
+        properties: z.ZodObject<{
+            id: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+        }, {
+            id: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        properties: {
+            id: string;
+        };
+        source: "flourish";
+    }, {
+        properties: {
+            id: string;
+        };
+        source: "flourish";
+    }>, z.ZodObject<{
+        source: z.ZodLiteral<"list">;
+        properties: z.ZodObject<{
+            id: z.ZodString;
+            maxItems: z.ZodOptional<z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            maxItems?: number | undefined;
+        }, {
+            id: string;
+            maxItems?: number | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        properties: {
+            id: string;
+            maxItems?: number | undefined;
+        };
+        source: "list";
+    }, {
+        properties: {
+            id: string;
+            maxItems?: number | undefined;
+        };
+        source: "list";
+    }>]>, "many">;
+    properties: z.ZodObject<{
+        title: z.ZodOptional<z.ZodString>;
+        design: z.ZodDefault<z.ZodEnum<["chart", "four-story", "freeform", "hero-lead"]>>;
+        backgroundColor: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        design: "chart" | "four-story" | "freeform" | "hero-lead";
+        title?: string | undefined;
+        backgroundColor?: string | undefined;
+    }, {
+        title?: string | undefined;
+        design?: "chart" | "four-story" | "freeform" | "hero-lead" | undefined;
+        backgroundColor?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "container";
+    properties: {
+        design: "chart" | "four-story" | "freeform" | "hero-lead";
+        title?: string | undefined;
+        backgroundColor?: string | undefined;
+    };
+    children: ({
+        properties: {
+            id: string;
+        };
+        source: "flourish";
+    } | {
+        properties: {
+            id: string;
+            maxItems?: number | undefined;
+        };
+        source: "list";
+    })[];
+}, {
+    type: "container";
+    properties: {
+        title?: string | undefined;
+        design?: "chart" | "four-story" | "freeform" | "hero-lead" | undefined;
+        backgroundColor?: string | undefined;
+    };
+    children: ({
+        properties: {
+            id: string;
+        };
+        source: "flourish";
+    } | {
+        properties: {
+            id: string;
+            maxItems?: number | undefined;
+        };
+        source: "list";
+    })[];
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"experiment">;
+    children: z.ZodTuple<[], null>;
+    properties: z.ZodObject<{
+        experimentName: z.ZodString;
+        id: z.ZodString;
+        title: z.ZodOptional<z.ZodString>;
+        config: z.ZodOptional<z.ZodObject<{
+            value: z.ZodOptional<z.ZodOptional<z.ZodUnknown>>;
+            format: z.ZodOptional<z.ZodDefault<z.ZodEnum<["json"]>>>;
+        }, "strip", z.ZodTypeAny, {
+            format?: "json" | undefined;
+            value?: unknown;
+        }, {
+            format?: "json" | undefined;
+            value?: unknown;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        experimentName: string;
+        id: string;
+        config?: {
+            format?: "json" | undefined;
+            value?: unknown;
+        } | undefined;
+        title?: string | undefined;
+    }, {
+        experimentName: string;
+        id: string;
+        config?: {
+            format?: "json" | undefined;
+            value?: unknown;
+        } | undefined;
+        title?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    type: "experiment";
+    properties: {
+        experimentName: string;
+        id: string;
+        config?: {
+            format?: "json" | undefined;
+            value?: unknown;
+        } | undefined;
+        title?: string | undefined;
+    };
+    children: [];
+}, {
+    type: "experiment";
+    properties: {
+        experimentName: string;
+        id: string;
+        config?: {
+            format?: "json" | undefined;
+            value?: unknown;
+        } | undefined;
+        title?: string | undefined;
+    };
+    children: [];
+}>]>;
+
+declare type LegacyPageStructureOutput = z.infer<typeof LegacyPageStructureOutputSchema>;
+export { LegacyPageStructureOutput }
+export { LegacyPageStructureOutput as LegacyPageStructureOutput_alias_1 }
+
+declare const LegacyPageStructureOutputSchema: z.ZodObject<{
+    blocks: z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+        type: z.ZodLiteral<"topper-basic">;
+        children: z.ZodTuple<[], null>;
+        properties: z.ZodObject<{
+            title: z.ZodString;
+            sponsorText: z.ZodDefault<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            title: string;
+            sponsorText: string;
+        }, {
+            title: string;
+            sponsorText?: string | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        type: "topper-basic";
+        properties: {
+            title: string;
+            sponsorText: string;
+        };
+        children: [];
+    }, {
+        type: "topper-basic";
+        properties: {
+            title: string;
+            sponsorText?: string | undefined;
+        };
+        children: [];
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"info-box">;
+        children: z.ZodTuple<[], null>;
+        properties: z.ZodObject<{
+            bodyHTML: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            bodyHTML: string;
+        }, {
+            bodyHTML: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        type: "info-box";
+        properties: {
+            bodyHTML: string;
+        };
+        children: [];
+    }, {
+        type: "info-box";
+        properties: {
+            bodyHTML: string;
+        };
+        children: [];
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"container">;
+        children: z.ZodArray<z.ZodDiscriminatedUnion<"source", [z.ZodObject<{
+            source: z.ZodLiteral<"flourish">;
+            properties: z.ZodObject<{
+                id: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                id: string;
+            }, {
+                id: string;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            properties: {
+                id: string;
+            };
+            source: "flourish";
+        }, {
+            properties: {
+                id: string;
+            };
+            source: "flourish";
+        }>, z.ZodObject<{
+            source: z.ZodLiteral<"list">;
+            properties: z.ZodObject<{
+                id: z.ZodString;
+                maxItems: z.ZodOptional<z.ZodNumber>;
+            }, "strip", z.ZodTypeAny, {
+                id: string;
+                maxItems?: number | undefined;
+            }, {
+                id: string;
+                maxItems?: number | undefined;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            properties: {
+                id: string;
+                maxItems?: number | undefined;
+            };
+            source: "list";
+        }, {
+            properties: {
+                id: string;
+                maxItems?: number | undefined;
+            };
+            source: "list";
+        }>]>, "many">;
+        properties: z.ZodObject<{
+            title: z.ZodOptional<z.ZodString>;
+            design: z.ZodDefault<z.ZodEnum<["chart", "four-story", "freeform", "hero-lead"]>>;
+            backgroundColor: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            design: "chart" | "four-story" | "freeform" | "hero-lead";
+            title?: string | undefined;
+            backgroundColor?: string | undefined;
+        }, {
+            title?: string | undefined;
+            design?: "chart" | "four-story" | "freeform" | "hero-lead" | undefined;
+            backgroundColor?: string | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        type: "container";
+        properties: {
+            design: "chart" | "four-story" | "freeform" | "hero-lead";
+            title?: string | undefined;
+            backgroundColor?: string | undefined;
+        };
+        children: ({
+            properties: {
+                id: string;
+            };
+            source: "flourish";
+        } | {
+            properties: {
+                id: string;
+                maxItems?: number | undefined;
+            };
+            source: "list";
+        })[];
+    }, {
+        type: "container";
+        properties: {
+            title?: string | undefined;
+            design?: "chart" | "four-story" | "freeform" | "hero-lead" | undefined;
+            backgroundColor?: string | undefined;
+        };
+        children: ({
+            properties: {
+                id: string;
+            };
+            source: "flourish";
+        } | {
+            properties: {
+                id: string;
+                maxItems?: number | undefined;
+            };
+            source: "list";
+        })[];
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"experiment">;
+        children: z.ZodTuple<[], null>;
+        properties: z.ZodObject<{
+            experimentName: z.ZodString;
+            id: z.ZodString;
+            title: z.ZodOptional<z.ZodString>;
+            config: z.ZodOptional<z.ZodObject<{
+                value: z.ZodOptional<z.ZodOptional<z.ZodUnknown>>;
+                format: z.ZodOptional<z.ZodDefault<z.ZodEnum<["json"]>>>;
+            }, "strip", z.ZodTypeAny, {
+                format?: "json" | undefined;
+                value?: unknown;
+            }, {
+                format?: "json" | undefined;
+                value?: unknown;
+            }>>;
+        }, "strip", z.ZodTypeAny, {
+            experimentName: string;
+            id: string;
+            config?: {
+                format?: "json" | undefined;
+                value?: unknown;
+            } | undefined;
+            title?: string | undefined;
+        }, {
+            experimentName: string;
+            id: string;
+            config?: {
+                format?: "json" | undefined;
+                value?: unknown;
+            } | undefined;
+            title?: string | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        type: "experiment";
+        properties: {
+            experimentName: string;
+            id: string;
+            config?: {
+                format?: "json" | undefined;
+                value?: unknown;
+            } | undefined;
+            title?: string | undefined;
+        };
+        children: [];
+    }, {
+        type: "experiment";
+        properties: {
+            experimentName: string;
+            id: string;
+            config?: {
+                format?: "json" | undefined;
+                value?: unknown;
+            } | undefined;
+            title?: string | undefined;
+        };
+        children: [];
+    }>]>, "many">;
+    conceptId: z.ZodOptional<z.ZodString>;
+    themeName: z.ZodOptional<z.ZodString>;
+    uuid: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    blocks: ({
+        type: "topper-basic";
+        properties: {
+            title: string;
+            sponsorText: string;
+        };
+        children: [];
+    } | {
+        type: "info-box";
+        properties: {
+            bodyHTML: string;
+        };
+        children: [];
+    } | {
+        type: "container";
+        properties: {
+            design: "chart" | "four-story" | "freeform" | "hero-lead";
+            title?: string | undefined;
+            backgroundColor?: string | undefined;
+        };
+        children: ({
+            properties: {
+                id: string;
+            };
+            source: "flourish";
+        } | {
+            properties: {
+                id: string;
+                maxItems?: number | undefined;
+            };
+            source: "list";
+        })[];
+    } | {
+        type: "experiment";
+        properties: {
+            experimentName: string;
+            id: string;
+            config?: {
+                format?: "json" | undefined;
+                value?: unknown;
+            } | undefined;
+            title?: string | undefined;
+        };
+        children: [];
+    })[];
+    uuid: string;
+    conceptId?: string | undefined;
+    themeName?: string | undefined;
+}, {
+    blocks: ({
+        type: "topper-basic";
+        properties: {
+            title: string;
+            sponsorText?: string | undefined;
+        };
+        children: [];
+    } | {
+        type: "info-box";
+        properties: {
+            bodyHTML: string;
+        };
+        children: [];
+    } | {
+        type: "container";
+        properties: {
+            title?: string | undefined;
+            design?: "chart" | "four-story" | "freeform" | "hero-lead" | undefined;
+            backgroundColor?: string | undefined;
+        };
+        children: ({
+            properties: {
+                id: string;
+            };
+            source: "flourish";
+        } | {
+            properties: {
+                id: string;
+                maxItems?: number | undefined;
+            };
+            source: "list";
+        })[];
+    } | {
+        type: "experiment";
+        properties: {
+            experimentName: string;
+            id: string;
+            config?: {
+                format?: "json" | undefined;
+                value?: unknown;
+            } | undefined;
+            title?: string | undefined;
+        };
+        children: [];
+    })[];
+    uuid: string;
+    conceptId?: string | undefined;
+    themeName?: string | undefined;
+}>;
+export { LegacyPageStructureOutputSchema }
+export { LegacyPageStructureOutputSchema as LegacyPageStructureOutputSchema_alias_1 }
+
 /**
  * Client for Page structure endpoints
  */
 declare class PageClient extends BaseApiClient {
     getStructure(pageId: string): Promise<PageStructureOutput>;
+    getLegacyHubPageStructure(pageId: string): Promise<LegacyPageStructureOutput>;
     upsertStructure(pageId: string, data: Omit<PageStructureInput, "type">): Promise<PageStructureOutput>;
 }
 export { PageClient }
@@ -2579,7 +3111,7 @@ export { Slice as Slice_alias_1 }
  * All possible slice inputs for the Page API.
  * This discriminated union allows Zod to pick the correct schema based on the `type` field.
  */
-export declare const SliceApiInputSchema: z.ZodDiscriminatedUnion<"type", readonly [z.ZodObject<{
+declare const SliceApiInputSchema: z.ZodDiscriminatedUnion<"type", readonly [z.ZodObject<{
     type: z.ZodLiteral<"HomepageSlice">;
     hidden: z.ZodOptional<z.ZodBoolean>;
     properties: z.ZodOptional<z.ZodObject<{
@@ -2865,12 +3397,14 @@ export declare const SliceApiInputSchema: z.ZodDiscriminatedUnion<"type", readon
     hidden?: boolean | undefined;
     sliceId?: string | undefined;
 }>]>;
+export { SliceApiInputSchema }
+export { SliceApiInputSchema as SliceApiInputSchema_alias_1 }
 
 /**
  * All possible slice outputs for the Page API.
  * The same discriminated union but with each slice requiring `sliceId`.
  */
-export declare const SliceApiOutputSchema: z.ZodDiscriminatedUnion<"type", readonly [z.ZodObject<{
+declare const SliceApiOutputSchema: z.ZodDiscriminatedUnion<"type", readonly [z.ZodObject<{
     type: z.ZodLiteral<"HomepageSlice">;
     hidden: z.ZodOptional<z.ZodBoolean>;
     properties: z.ZodOptional<z.ZodObject<{
@@ -3156,6 +3690,8 @@ export declare const SliceApiOutputSchema: z.ZodDiscriminatedUnion<"type", reado
     sliceId: string;
     hidden?: boolean | undefined;
 }>]>;
+export { SliceApiOutputSchema }
+export { SliceApiOutputSchema as SliceApiOutputSchema_alias_1 }
 
 declare const SparkListSlice: {
     InputSchema: z.ZodObject<{

package/dist/index.cjs

@@ -74,7 +74,7 @@ var BaseApiClient = class {
       method,
       headers: {
         "Content-Type": "application/json",
-        Authorization: `Bearer ${this.config.apiToken}`
+        ...this.config.apiKey ? { "x-api-key": this.config.apiKey } : { Authorization: `Bearer ${this.config.apiToken}` }
       },
       body: bodyPayload ? JSON.stringify(bodyPayload) : void 0
     });
@@ -246,11 +246,86 @@ var HomepageClient = class extends BaseApiClient {
   }
 };
 
+// src/schemas/ftpink/legacyHubPage/index.ts
+
+var LegacyFlourishChildSchema = _zod.z.object({
+  source: _zod.z.literal("flourish"),
+  properties: _zod.z.object({
+    id: _zod.z.string().min(1)
+    // e.g. "visualisation/21901162"
+  })
+});
+var LegacyListChildSchema = _zod.z.object({
+  source: _zod.z.literal("list"),
+  properties: _zod.z.object({
+    id: _zod.z.string().uuid(),
+    maxItems: _zod.z.number().optional()
+  })
+});
+var LegacyContainerChildSchema = _zod.z.discriminatedUnion("source", [
+  LegacyFlourishChildSchema,
+  LegacyListChildSchema
+]);
+var LegacyTopperSchema = _zod.z.object({
+  type: _zod.z.literal("topper-basic"),
+  children: _zod.z.tuple([]),
+  properties: _zod.z.object({
+    title: _zod.z.string(),
+    sponsorText: _zod.z.string().default("")
+  })
+});
+var LegacyInfoBoxSchema = _zod.z.object({
+  type: _zod.z.literal("info-box"),
+  children: _zod.z.tuple([]),
+  properties: _zod.z.object({
+    bodyHTML: _zod.z.string()
+  })
+});
+var LegacyContainerSchema = _zod.z.object({
+  type: _zod.z.literal("container"),
+  children: _zod.z.array(LegacyContainerChildSchema).min(1),
+  properties: _zod.z.object({
+    title: _zod.z.string().optional(),
+    design: _zod.z.enum(["chart", "four-story", "freeform", "hero-lead"]).default("freeform"),
+    backgroundColor: _zod.z.string().optional()
+  })
+});
+var LegacyExperimentSchema = _zod.z.object({
+  type: _zod.z.literal("experiment"),
+  children: _zod.z.tuple([]),
+  properties: _zod.z.object({
+    experimentName: _zod.z.string(),
+    id: _zod.z.string(),
+    title: _zod.z.string().optional(),
+    config: _zod.z.object({
+      value: _zod.z.unknown().optional(),
+      // Hub pages support experiments with HTML and Text.
+      // For now we just support JSON. As we migrate pages, this may change.
+      format: _zod.z.enum(["json"]).default("json")
+    }).partial().optional()
+  })
+});
+var LegacyBlockSchema = _zod.z.discriminatedUnion("type", [
+  LegacyTopperSchema,
+  LegacyInfoBoxSchema,
+  LegacyContainerSchema,
+  LegacyExperimentSchema
+]);
+var LegacyPageStructureOutputSchema = _zod.z.object({
+  blocks: _zod.z.array(LegacyBlockSchema),
+  conceptId: _zod.z.string().uuid().optional(),
+  themeName: _zod.z.string().optional(),
+  uuid: _zod.z.string().uuid()
+});
+
 // src/page.ts
 var PageClient = class extends BaseApiClient {
   async getStructure(pageId) {
     return this.get(`/v1/page/${pageId}/structure`, PageStructureOutputSchema);
   }
+  async getLegacyHubPageStructure(pageId) {
+    return this.get(`/v1/page/${pageId}/legacyHubPageStructure`, LegacyPageStructureOutputSchema);
+  }
   async upsertStructure(pageId, data) {
     return this.put(
       `/v1/page/${pageId}/structure`,
@@ -288,5 +363,8 @@ var ApiClient = class extends BaseApiClient {
 
 
 
-exports.ApiClient = ApiClient; exports.ApiClientError = ApiClientError; exports.ApiErrorCode = ApiErrorCode; exports.ApiErrorPayloadSchema = ApiErrorPayloadSchema; exports.ApiErrorResponseSchema = ApiErrorResponseSchema; exports.ApiResponseSchema = ApiResponseSchema; exports.ApiSuccessResponseSchema = ApiSuccessResponseSchema; exports.HomepageClient = HomepageClient; exports.HomepageStructureInputSchema = HomepageStructureInputSchema; exports.HomepageStructureOutputSchema = HomepageStructureOutputSchema; exports.PageClient = PageClient; exports.PageStructureInputSchema = PageStructureInputSchema; exports.PageStructureOutputSchema = PageStructureOutputSchema;
+
+
+
+exports.ApiClient = ApiClient; exports.ApiClientError = ApiClientError; exports.ApiErrorCode = ApiErrorCode; exports.ApiErrorPayloadSchema = ApiErrorPayloadSchema; exports.ApiErrorResponseSchema = ApiErrorResponseSchema; exports.ApiResponseSchema = ApiResponseSchema; exports.ApiSuccessResponseSchema = ApiSuccessResponseSchema; exports.HomepageClient = HomepageClient; exports.HomepageStructureInputSchema = HomepageStructureInputSchema; exports.HomepageStructureOutputSchema = HomepageStructureOutputSchema; exports.LegacyPageStructureOutputSchema = LegacyPageStructureOutputSchema; exports.PageClient = PageClient; exports.PageStructureInputSchema = PageStructureInputSchema; exports.PageStructureOutputSchema = PageStructureOutputSchema; exports.SliceApiInputSchema = SliceApiInputSchema; exports.SliceApiOutputSchema = SliceApiOutputSchema;
 //# sourceMappingURL=index.cjs.map