@contentful/optimization-api-schemas 0.1.0-alpha

package/dist/contentful/MergeTagEntry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MergeTagEntry.d.ts","sourceRoot":"","sources":["../../src/contentful/MergeTagEntry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAG7B;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;QAEtB;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgBL,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA"}

package/dist/contentful/MergeTagEntry.js

@@ -0,0 +1,38 @@
+import * as z from 'zod/mini';
+import { CtflEntry, EntrySys } from './CtflEntry';
+/**
+ * Zod schema for a Merge Tag Contentful entry.
+ *
+ * @remarks
+ * Extends {@link CtflEntry} with merge-tag-specific fields and constrains the
+ * `contentType` to the `nt_mergetag` content type.
+ */
+export const MergeTagEntry = z.extend(CtflEntry, {
+    fields: z.object({
+        /**
+         * Human-readable name of the merge tag.
+         */
+        nt_name: z.string(),
+        /**
+         * Fallback value to use when the merge tag cannot be resolved.
+         */
+        nt_fallback: z.optional(z.string()),
+        /**
+         * Internal identifier of the merge tag.
+         */
+        nt_mergetag_id: z.string(),
+    }),
+    /**
+     * System fields extended to constrain the content type to `nt_mergetag`.
+     */
+    sys: z.extend(EntrySys, {
+        contentType: z.object({
+            sys: z.object({
+                type: z.literal('Link'),
+                linkType: z.literal('ContentType'),
+                id: z.literal('nt_mergetag'),
+            }),
+        }),
+    }),
+});
+//# sourceMappingURL=MergeTagEntry.js.map

package/dist/contentful/MergeTagEntry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MergeTagEntry.js","sourceRoot":"","sources":["../../src/contentful/MergeTagEntry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAC7B,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAEjD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE;IAC/C,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf;;WAEG;QACH,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QAEnB;;WAEG;QACH,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;QAEnC;;WAEG;QACH,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;KAC3B,CAAC;IAEF;;OAEG;IACH,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;QACtB,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACpB,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC;gBACZ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;gBACvB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;gBAClC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;aAC7B,CAAC;SACH,CAAC;KACH,CAAC;CACH,CAAC,CAAA"}

package/dist/contentful/PersonalizationConfig.d.ts

@@ -0,0 +1,437 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing a single entry replacement variant.
+ *
+ * @remarks
+ * Each variant is identified by an `id` and may be marked as `hidden`.
+ */
+export declare const EntryReplacementVariant: z.ZodMiniObject<{
+    /**
+     * Unique identifier for the variant.
+     */
+    id: z.ZodMiniString<string>;
+    /**
+     * Indicates whether this variant is hidden from allocation/traffic.
+     *
+     * @defaultValue false
+     */
+    hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link EntryReplacementVariant}.
+ */
+export type EntryReplacementVariant = z.infer<typeof EntryReplacementVariant>;
+/**
+ * Type guard for {@link EntryReplacementVariant}.
+ *
+ * @param variant - Value to test.
+ * @returns `true` if `variant` conforms to {@link EntryReplacementVariant}, otherwise `false`.
+ */
+export declare function isEntryReplacementVariant(variant: unknown): variant is EntryReplacementVariant;
+/**
+ * Zod schema describing an entry replacement personalization component.
+ *
+ * @remarks
+ * This component replaces a baseline entry with one of several variants.
+ */
+export declare const EntryReplacementComponent: z.ZodMiniObject<{
+    /**
+     * Discriminator for the component type.
+     *
+     * @remarks
+     * May be omitted, in which case the component is treated as an EntryReplacement.
+     */
+    type: z.ZodMiniOptional<z.ZodMiniLiteral<"EntryReplacement">>;
+    /**
+     * Baseline variant used when no targeting or allocation selects another variant.
+     */
+    baseline: z.ZodMiniObject<{
+        /**
+         * Unique identifier for the variant.
+         */
+        id: z.ZodMiniString<string>;
+        /**
+         * Indicates whether this variant is hidden from allocation/traffic.
+         *
+         * @defaultValue false
+         */
+        hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+    }, z.core.$strip>;
+    /**
+     * Additional variants that may be served.
+     */
+    variants: z.ZodMiniArray<z.ZodMiniObject<{
+        /**
+         * Unique identifier for the variant.
+         */
+        id: z.ZodMiniString<string>;
+        /**
+         * Indicates whether this variant is hidden from allocation/traffic.
+         *
+         * @defaultValue false
+         */
+        hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link EntryReplacementComponent}.
+ */
+export type EntryReplacementComponent = z.infer<typeof EntryReplacementComponent>;
+/**
+ * Type guard for {@link EntryReplacementComponent}.
+ *
+ * @param component - Personalization component to test.
+ * @returns `true` if the component is an EntryReplacement component, otherwise `false`.
+ */
+export declare function isEntryReplacementComponent(component: PersonalizationComponent): component is EntryReplacementComponent;
+/**
+ * Zod schema describing a variant for inline variables.
+ *
+ * @remarks
+ * The value may be a primitive or a JSON object.
+ */
+export declare const InlineVariableVariant: z.ZodMiniObject<{
+    /**
+     * Variant value for the inline variable.
+     */
+    value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniBoolean<boolean>, z.ZodMiniNull, z.ZodMiniNumber<number>, z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>]>;
+}, z.core.$strip>;
+/**
+ * Enumeration of supported inline variable value types.
+ */
+export declare const InlineVariableComponentValueType: z.ZodMiniEnum<{
+    Boolean: "Boolean";
+    Number: "Number";
+    Object: "Object";
+    String: "String";
+}>;
+/**
+ * Zod schema describing an inline variable personalization component.
+ *
+ * @remarks
+ * Used to vary scalar or object values in templates.
+ */
+export declare const InlineVariableComponent: z.ZodMiniObject<{
+    /**
+     * Discriminator for the inline variable component.
+     */
+    type: z.ZodMiniLiteral<"InlineVariable">;
+    /**
+     * Key under which this variable is exposed to the template.
+     */
+    key: z.ZodMiniString<string>;
+    /**
+     * Describes the runtime type of the values for this variable.
+     */
+    valueType: z.ZodMiniEnum<{
+        Boolean: "Boolean";
+        Number: "Number";
+        Object: "Object";
+        String: "String";
+    }>;
+    /**
+     * Baseline value used when no targeting or allocation selects another variant.
+     */
+    baseline: z.ZodMiniObject<{
+        /**
+         * Variant value for the inline variable.
+         */
+        value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniBoolean<boolean>, z.ZodMiniNull, z.ZodMiniNumber<number>, z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>]>;
+    }, z.core.$strip>;
+    /**
+     * Additional variable variants for experimentation or personalization.
+     */
+    variants: z.ZodMiniArray<z.ZodMiniObject<{
+        /**
+         * Variant value for the inline variable.
+         */
+        value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniBoolean<boolean>, z.ZodMiniNull, z.ZodMiniNumber<number>, z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>]>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link InlineVariableComponent}.
+ */
+export type InlineVariableComponent = z.infer<typeof InlineVariableComponent>;
+/**
+ * Type guard for {@link InlineVariableComponent}.
+ *
+ * @param component - Personalization component to test.
+ * @returns `true` if the component is an InlineVariable component, otherwise `false`.
+ */
+export declare function isInlineVariableComponent(component: PersonalizationComponent): component is InlineVariableComponent;
+/**
+ * Discriminated union of all supported personalization components.
+ */
+export declare const PersonalizationComponent: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+    /**
+     * Discriminator for the component type.
+     *
+     * @remarks
+     * May be omitted, in which case the component is treated as an EntryReplacement.
+     */
+    type: z.ZodMiniOptional<z.ZodMiniLiteral<"EntryReplacement">>;
+    /**
+     * Baseline variant used when no targeting or allocation selects another variant.
+     */
+    baseline: z.ZodMiniObject<{
+        /**
+         * Unique identifier for the variant.
+         */
+        id: z.ZodMiniString<string>;
+        /**
+         * Indicates whether this variant is hidden from allocation/traffic.
+         *
+         * @defaultValue false
+         */
+        hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+    }, z.core.$strip>;
+    /**
+     * Additional variants that may be served.
+     */
+    variants: z.ZodMiniArray<z.ZodMiniObject<{
+        /**
+         * Unique identifier for the variant.
+         */
+        id: z.ZodMiniString<string>;
+        /**
+         * Indicates whether this variant is hidden from allocation/traffic.
+         *
+         * @defaultValue false
+         */
+        hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodMiniObject<{
+    /**
+     * Discriminator for the inline variable component.
+     */
+    type: z.ZodMiniLiteral<"InlineVariable">;
+    /**
+     * Key under which this variable is exposed to the template.
+     */
+    key: z.ZodMiniString<string>;
+    /**
+     * Describes the runtime type of the values for this variable.
+     */
+    valueType: z.ZodMiniEnum<{
+        Boolean: "Boolean";
+        Number: "Number";
+        Object: "Object";
+        String: "String";
+    }>;
+    /**
+     * Baseline value used when no targeting or allocation selects another variant.
+     */
+    baseline: z.ZodMiniObject<{
+        /**
+         * Variant value for the inline variable.
+         */
+        value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniBoolean<boolean>, z.ZodMiniNull, z.ZodMiniNumber<number>, z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>]>;
+    }, z.core.$strip>;
+    /**
+     * Additional variable variants for experimentation or personalization.
+     */
+    variants: z.ZodMiniArray<z.ZodMiniObject<{
+        /**
+         * Variant value for the inline variable.
+         */
+        value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniBoolean<boolean>, z.ZodMiniNull, z.ZodMiniNumber<number>, z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>]>;
+    }, z.core.$strip>>;
+}, z.core.$strip>], "type">;
+/**
+ * TypeScript type inferred from {@link PersonalizationComponent}.
+ */
+export type PersonalizationComponent = z.infer<typeof PersonalizationComponent>;
+/**
+ * Zod schema representing an array of {@link PersonalizationComponent} items.
+ */
+export declare const PersonalizationComponentArray: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+    /**
+     * Discriminator for the component type.
+     *
+     * @remarks
+     * May be omitted, in which case the component is treated as an EntryReplacement.
+     */
+    type: z.ZodMiniOptional<z.ZodMiniLiteral<"EntryReplacement">>;
+    /**
+     * Baseline variant used when no targeting or allocation selects another variant.
+     */
+    baseline: z.ZodMiniObject<{
+        /**
+         * Unique identifier for the variant.
+         */
+        id: z.ZodMiniString<string>;
+        /**
+         * Indicates whether this variant is hidden from allocation/traffic.
+         *
+         * @defaultValue false
+         */
+        hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+    }, z.core.$strip>;
+    /**
+     * Additional variants that may be served.
+     */
+    variants: z.ZodMiniArray<z.ZodMiniObject<{
+        /**
+         * Unique identifier for the variant.
+         */
+        id: z.ZodMiniString<string>;
+        /**
+         * Indicates whether this variant is hidden from allocation/traffic.
+         *
+         * @defaultValue false
+         */
+        hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodMiniObject<{
+    /**
+     * Discriminator for the inline variable component.
+     */
+    type: z.ZodMiniLiteral<"InlineVariable">;
+    /**
+     * Key under which this variable is exposed to the template.
+     */
+    key: z.ZodMiniString<string>;
+    /**
+     * Describes the runtime type of the values for this variable.
+     */
+    valueType: z.ZodMiniEnum<{
+        Boolean: "Boolean";
+        Number: "Number";
+        Object: "Object";
+        String: "String";
+    }>;
+    /**
+     * Baseline value used when no targeting or allocation selects another variant.
+     */
+    baseline: z.ZodMiniObject<{
+        /**
+         * Variant value for the inline variable.
+         */
+        value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniBoolean<boolean>, z.ZodMiniNull, z.ZodMiniNumber<number>, z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>]>;
+    }, z.core.$strip>;
+    /**
+     * Additional variable variants for experimentation or personalization.
+     */
+    variants: z.ZodMiniArray<z.ZodMiniObject<{
+        /**
+         * Variant value for the inline variable.
+         */
+        value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniBoolean<boolean>, z.ZodMiniNull, z.ZodMiniNumber<number>, z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>]>;
+    }, z.core.$strip>>;
+}, z.core.$strip>], "type">>;
+/**
+ * TypeScript type inferred from {@link PersonalizationComponentArray}.
+ */
+export type PersonalizationComponentArray = z.infer<typeof PersonalizationComponentArray>;
+/**
+ * Zod schema describing the full configuration for a personalization.
+ *
+ * @remarks
+ * Provides distribution, traffic allocation, component definitions, and sticky behavior.
+ */
+export declare const PersonalizationConfig: z.ZodMiniObject<{
+    /**
+     * Variant distribution used for traffic allocation.
+     *
+     * @defaultValue [0.5, 0.5]
+     */
+    distribution: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniArray<z.ZodMiniNumber<number>>>>;
+    /**
+     * Percentage of total traffic that should enter the personalization.
+     *
+     * @defaultValue 0
+     */
+    traffic: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniNumber<number>>>;
+    /**
+     * Personalization components that define how content is varied.
+     *
+     * @defaultValue
+     * A single {@link EntryReplacementComponent} with an empty `baseline` and `variants` ID.
+     */
+    components: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+        /**
+         * Discriminator for the component type.
+         *
+         * @remarks
+         * May be omitted, in which case the component is treated as an EntryReplacement.
+         */
+        type: z.ZodMiniOptional<z.ZodMiniLiteral<"EntryReplacement">>;
+        /**
+         * Baseline variant used when no targeting or allocation selects another variant.
+         */
+        baseline: z.ZodMiniObject<{
+            /**
+             * Unique identifier for the variant.
+             */
+            id: z.ZodMiniString<string>;
+            /**
+             * Indicates whether this variant is hidden from allocation/traffic.
+             *
+             * @defaultValue false
+             */
+            hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+        }, z.core.$strip>;
+        /**
+         * Additional variants that may be served.
+         */
+        variants: z.ZodMiniArray<z.ZodMiniObject<{
+            /**
+             * Unique identifier for the variant.
+             */
+            id: z.ZodMiniString<string>;
+            /**
+             * Indicates whether this variant is hidden from allocation/traffic.
+             *
+             * @defaultValue false
+             */
+            hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>, z.ZodMiniObject<{
+        /**
+         * Discriminator for the inline variable component.
+         */
+        type: z.ZodMiniLiteral<"InlineVariable">;
+        /**
+         * Key under which this variable is exposed to the template.
+         */
+        key: z.ZodMiniString<string>;
+        /**
+         * Describes the runtime type of the values for this variable.
+         */
+        valueType: z.ZodMiniEnum<{
+            Boolean: "Boolean";
+            Number: "Number";
+            Object: "Object";
+            String: "String";
+        }>;
+        /**
+         * Baseline value used when no targeting or allocation selects another variant.
+         */
+        baseline: z.ZodMiniObject<{
+            /**
+             * Variant value for the inline variable.
+             */
+            value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniBoolean<boolean>, z.ZodMiniNull, z.ZodMiniNumber<number>, z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>]>;
+        }, z.core.$strip>;
+        /**
+         * Additional variable variants for experimentation or personalization.
+         */
+        variants: z.ZodMiniArray<z.ZodMiniObject<{
+            /**
+             * Variant value for the inline variable.
+             */
+            value: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniBoolean<boolean>, z.ZodMiniNull, z.ZodMiniNumber<number>, z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>]>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>], "type">>>>;
+    /**
+     * Controls whether the assignment should be sticky for a given user.
+     *
+     * @defaultValue false
+     */
+    sticky: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link PersonalizationConfig}.
+ */
+export type PersonalizationConfig = z.infer<typeof PersonalizationConfig>;
+//# sourceMappingURL=PersonalizationConfig.d.ts.map

package/dist/contentful/PersonalizationConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PersonalizationConfig.d.ts","sourceRoot":"","sources":["../../src/contentful/PersonalizationConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB;IAClC;;OAEG;;IAGH;;;;OAIG;;iBAEH,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,uBAAuB,CAE9F;AAED;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB;IACpC;;;;;OAKG;;IAGH;;OAEG;;QA7CH;;WAEG;;QAGH;;;;WAIG;;;IAuCH;;OAEG;;QAlDH;;WAEG;;QAGH;;;;WAIG;;;iBA2CH,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAEjF;;;;;GAKG;AACH,wBAAgB,2BAA2B,CACzC,SAAS,EAAE,wBAAwB,GAClC,SAAS,IAAI,yBAAyB,CAExC;AAED;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB;IAChC;;OAEG;;iBAEH,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,gCAAgC;;;;;EAAoD,CAAA;AAEjG;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB;IAClC;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;IAGH;;OAEG;;QAnCH;;WAEG;;;IAoCH;;OAEG;;QAxCH;;WAEG;;;iBAwCH,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAE7E;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,wBAAwB,GAClC,SAAS,IAAI,uBAAuB,CAEtC;AAED;;GAEG;AACH,eAAO,MAAM,wBAAwB;IA3GnC;;;;;OAKG;;IAGH;;OAEG;;QA7CH;;WAEG;;QAGH;;;;WAIG;;;IAuCH;;OAEG;;QAlDH;;WAEG;;QAGH;;;;WAIG;;;;IAuFH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;IAGH;;OAEG;;QAnCH;;WAEG;;;IAoCH;;OAEG;;QAxCH;;WAEG;;;2BAiEH,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;GAEG;AACH,eAAO,MAAM,6BAA6B;IAxHxC;;;;;OAKG;;IAGH;;OAEG;;QA7CH;;WAEG;;QAGH;;;;WAIG;;;IAuCH;;OAEG;;QAlDH;;WAEG;;QAGH;;;;WAIG;;;;IAuFH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;IAGH;;OAEG;;QAnCH;;WAEG;;;IAoCH;;OAEG;;QAxCH;;WAEG;;;4BA2EyE,CAAA;AAE9E;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AAEzF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB;IAChC;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;OAKG;;QAzJH;;;;;WAKG;;QAGH;;WAEG;;YA7CH;;eAEG;;YAGH;;;;eAIG;;;QAuCH;;WAEG;;YAlDH;;eAEG;;YAGH;;;;eAIG;;;;QAuFH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;;;;;;QAGH;;WAEG;;YAnCH;;eAEG;;;QAoCH;;WAEG;;YAxCH;;eAEG;;;;IAuHH;;;;OAIG;;iBAEH,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA"}

package/dist/contentful/PersonalizationConfig.js

@@ -0,0 +1,164 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing a single entry replacement variant.
+ *
+ * @remarks
+ * Each variant is identified by an `id` and may be marked as `hidden`.
+ */
+export const EntryReplacementVariant = z.object({
+    /**
+     * Unique identifier for the variant.
+     */
+    id: z.string(),
+    /**
+     * Indicates whether this variant is hidden from allocation/traffic.
+     *
+     * @defaultValue false
+     */
+    hidden: z.prefault(z.boolean(), false),
+});
+/**
+ * Type guard for {@link EntryReplacementVariant}.
+ *
+ * @param variant - Value to test.
+ * @returns `true` if `variant` conforms to {@link EntryReplacementVariant}, otherwise `false`.
+ */
+export function isEntryReplacementVariant(variant) {
+    return EntryReplacementVariant.safeParse(variant).success;
+}
+/**
+ * Zod schema describing an entry replacement personalization component.
+ *
+ * @remarks
+ * This component replaces a baseline entry with one of several variants.
+ */
+export const EntryReplacementComponent = z.object({
+    /**
+     * Discriminator for the component type.
+     *
+     * @remarks
+     * May be omitted, in which case the component is treated as an EntryReplacement.
+     */
+    type: z.optional(z.literal('EntryReplacement')),
+    /**
+     * Baseline variant used when no targeting or allocation selects another variant.
+     */
+    baseline: EntryReplacementVariant,
+    /**
+     * Additional variants that may be served.
+     */
+    variants: z.array(EntryReplacementVariant),
+});
+/**
+ * Type guard for {@link EntryReplacementComponent}.
+ *
+ * @param component - Personalization component to test.
+ * @returns `true` if the component is an EntryReplacement component, otherwise `false`.
+ */
+export function isEntryReplacementComponent(component) {
+    return component.type === 'EntryReplacement' || component.type === undefined;
+}
+/**
+ * Zod schema describing a variant for inline variables.
+ *
+ * @remarks
+ * The value may be a primitive or a JSON object.
+ */
+export const InlineVariableVariant = z.object({
+    /**
+     * Variant value for the inline variable.
+     */
+    value: z.union([z.string(), z.boolean(), z.null(), z.number(), z.record(z.string(), z.json())]),
+});
+/**
+ * Enumeration of supported inline variable value types.
+ */
+export const InlineVariableComponentValueType = z.enum(['Boolean', 'Number', 'Object', 'String']);
+/**
+ * Zod schema describing an inline variable personalization component.
+ *
+ * @remarks
+ * Used to vary scalar or object values in templates.
+ */
+export const InlineVariableComponent = z.object({
+    /**
+     * Discriminator for the inline variable component.
+     */
+    type: z.literal('InlineVariable'),
+    /**
+     * Key under which this variable is exposed to the template.
+     */
+    key: z.string(),
+    /**
+     * Describes the runtime type of the values for this variable.
+     */
+    valueType: InlineVariableComponentValueType,
+    /**
+     * Baseline value used when no targeting or allocation selects another variant.
+     */
+    baseline: InlineVariableVariant,
+    /**
+     * Additional variable variants for experimentation or personalization.
+     */
+    variants: z.array(InlineVariableVariant),
+});
+/**
+ * Type guard for {@link InlineVariableComponent}.
+ *
+ * @param component - Personalization component to test.
+ * @returns `true` if the component is an InlineVariable component, otherwise `false`.
+ */
+export function isInlineVariableComponent(component) {
+    return component.type === 'InlineVariable';
+}
+/**
+ * Discriminated union of all supported personalization components.
+ */
+export const PersonalizationComponent = z.discriminatedUnion('type', [
+    EntryReplacementComponent,
+    InlineVariableComponent,
+]);
+/**
+ * Zod schema representing an array of {@link PersonalizationComponent} items.
+ */
+export const PersonalizationComponentArray = z.array(PersonalizationComponent);
+/**
+ * Zod schema describing the full configuration for a personalization.
+ *
+ * @remarks
+ * Provides distribution, traffic allocation, component definitions, and sticky behavior.
+ */
+export const PersonalizationConfig = z.object({
+    /**
+     * Variant distribution used for traffic allocation.
+     *
+     * @defaultValue [0.5, 0.5]
+     */
+    distribution: z.optional(z.prefault(z.array(z.number()), [0.5, 0.5])),
+    /**
+     * Percentage of total traffic that should enter the personalization.
+     *
+     * @defaultValue 0
+     */
+    traffic: z.optional(z.prefault(z.number(), 0)),
+    /**
+     * Personalization components that define how content is varied.
+     *
+     * @defaultValue
+     * A single {@link EntryReplacementComponent} with an empty `baseline` and `variants` ID.
+     */
+    components: z.optional(z.prefault(PersonalizationComponentArray, [
+        {
+            type: 'EntryReplacement',
+            baseline: { id: '' },
+            variants: [{ id: '' }],
+        },
+    ])),
+    /**
+     * Controls whether the assignment should be sticky for a given user.
+     *
+     * @defaultValue false
+     */
+    sticky: z.optional(z.prefault(z.boolean(), false)),
+});
+//# sourceMappingURL=PersonalizationConfig.js.map

package/dist/contentful/PersonalizationConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PersonalizationConfig.js","sourceRoot":"","sources":["../../src/contentful/PersonalizationConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C;;OAEG;IACH,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IAEd;;;;OAIG;IACH,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC;CACvC,CAAC,CAAA;AAOF;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,OAAgB;IACxD,OAAO,uBAAuB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,OAAO,CAAA;AAC3D,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD;;;;;OAKG;IACH,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAE/C;;OAEG;IACH,QAAQ,EAAE,uBAAuB;IAEjC;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC;CAC3C,CAAC,CAAA;AAOF;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,SAAmC;IAEnC,OAAO,SAAS,CAAC,IAAI,KAAK,kBAAkB,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,CAAA;AAC9E,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;CAChG,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAA;AAEjG;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC;IAEjC;;OAEG;IACH,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IAEf;;OAEG;IACH,SAAS,EAAE,gCAAgC;IAE3C;;OAEG;IACH,QAAQ,EAAE,qBAAqB;IAE/B;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC;CACzC,CAAC,CAAA;AAOF;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CACvC,SAAmC;IAEnC,OAAO,SAAS,CAAC,IAAI,KAAK,gBAAgB,CAAA;AAC5C,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IACnE,yBAAyB;IACzB,uBAAuB;CACxB,CAAC,CAAA;AAOF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAA;AAO9E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C;;;;OAIG;IACH,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IAErE;;;;OAIG;IACH,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;IAE9C;;;;;OAKG;IACH,UAAU,EAAE,CAAC,CAAC,QAAQ,CACpB,CAAC,CAAC,QAAQ,CAAC,6BAA6B,EAAE;QACxC;YACE,IAAI,EAAE,kBAAkB;YACxB,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE;YACpB,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;SACvB;KACF,CAAC,CACH;IAED;;;;OAIG;IACH,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC;CACnD,CAAC,CAAA"}