@contentful/optimization-api-schemas 0.1.0-alpha

package/dist/contentful/PersonalizationEntry.d.ts

@@ -0,0 +1,541 @@
+import type { Entry } from 'contentful';
+import * as z from 'zod/mini';
+import { CtflEntry, Link } from './CtflEntry';
+/**
+ * Union of supported personalization types.
+ *
+ * @remarks
+ * `nt_experiment` represents experiments (A/B tests), and `nt_personalization`
+ * represents always-on personalized experiences.
+ */
+export declare const PersonalizationType: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"nt_experiment">, z.ZodMiniLiteral<"nt_personalization">]>;
+/**
+ * TypeScript type inferred from {@link PersonalizationType}.
+ */
+export type PersonalizationType = z.infer<typeof PersonalizationType>;
+/**
+ * Zod schema describing the fields of a Personalization entry.
+ *
+ * @remarks
+ * Extends the generic {@link EntryFields} with personalization-specific
+ * properties such as name, description, type, config, audience, and variants.
+ */
+export declare const PersonalizationFields: z.ZodMiniObject<{
+    nt_name: z.ZodMiniString<string>;
+    nt_description: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+    nt_type: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"nt_experiment">, z.ZodMiniLiteral<"nt_personalization">]>;
+    nt_config: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniNullable<z.ZodMiniObject<{
+        distribution: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniArray<z.ZodMiniNumber<number>>>>;
+        traffic: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniNumber<number>>>;
+        components: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+            type: z.ZodMiniOptional<z.ZodMiniLiteral<"EntryReplacement">>;
+            baseline: z.ZodMiniObject<{
+                id: z.ZodMiniString<string>;
+                hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+            }, z.core.$strip>;
+            variants: z.ZodMiniArray<z.ZodMiniObject<{
+                id: z.ZodMiniString<string>;
+                hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>, z.ZodMiniObject<{
+            type: z.ZodMiniLiteral<"InlineVariable">;
+            key: z.ZodMiniString<string>;
+            valueType: z.ZodMiniEnum<{
+                Boolean: "Boolean";
+                Number: "Number";
+                Object: "Object";
+                String: "String";
+            }>;
+            baseline: z.ZodMiniObject<{
+                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>;
+            variants: z.ZodMiniArray<z.ZodMiniObject<{
+                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">>>>;
+        sticky: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>>;
+    }, z.core.$strip>>>>, z.ZodMiniTransform<{
+        distribution?: number[] | undefined;
+        traffic?: number | undefined;
+        components?: ({
+            baseline: {
+                id: string;
+                hidden: boolean;
+            };
+            variants: {
+                id: string;
+                hidden: boolean;
+            }[];
+            type?: "EntryReplacement" | undefined;
+        } | {
+            type: "InlineVariable";
+            key: string;
+            valueType: "Boolean" | "Number" | "Object" | "String";
+            baseline: {
+                value: string | number | boolean | Record<string, z.core.util.JSONType> | null;
+            };
+            variants: {
+                value: string | number | boolean | Record<string, z.core.util.JSONType> | null;
+            }[];
+        })[] | undefined;
+        sticky?: boolean | undefined;
+    } | null, {
+        distribution?: number[] | undefined;
+        traffic?: number | undefined;
+        components?: ({
+            baseline: {
+                id: string;
+                hidden: boolean;
+            };
+            variants: {
+                id: string;
+                hidden: boolean;
+            }[];
+            type?: "EntryReplacement" | undefined;
+        } | {
+            type: "InlineVariable";
+            key: string;
+            valueType: "Boolean" | "Number" | "Object" | "String";
+            baseline: {
+                value: string | number | boolean | Record<string, z.core.util.JSONType> | null;
+            };
+            variants: {
+                value: string | number | boolean | Record<string, z.core.util.JSONType> | null;
+            }[];
+        })[] | undefined;
+        sticky?: boolean | undefined;
+    } | null>>;
+    nt_audience: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniObject<{
+        metadata: z.ZodMiniObject<{
+            tags: z.ZodMiniArray<z.ZodMiniObject<{
+                sys: z.ZodMiniObject<{
+                    type: z.ZodMiniLiteral<"Link">;
+                    linkType: z.ZodMiniLiteral<"Tag">;
+                    id: z.ZodMiniString<string>;
+                }, z.core.$strip>;
+            }, z.core.$strip>>;
+        }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+        sys: z.ZodMiniObject<{
+            type: z.ZodMiniLiteral<"Entry">;
+            contentType: z.ZodMiniObject<{
+                sys: z.ZodMiniObject<{
+                    type: z.ZodMiniLiteral<"Link">;
+                    linkType: z.ZodMiniLiteral<"ContentType">;
+                    id: z.ZodMiniString<string>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+            publishedVersion: z.ZodMiniNumber<number>;
+            id: z.ZodMiniString<string>;
+            createdAt: z.ZodMiniAny;
+            updatedAt: z.ZodMiniAny;
+            locale: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            revision: z.ZodMiniNumber<number>;
+            space: z.ZodMiniObject<{
+                sys: z.ZodMiniObject<{
+                    type: z.ZodMiniLiteral<"Link">;
+                    linkType: z.ZodMiniLiteral<"Space">;
+                    id: z.ZodMiniString<string>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+            environment: z.ZodMiniObject<{
+                sys: z.ZodMiniObject<{
+                    type: z.ZodMiniLiteral<"Link">;
+                    linkType: z.ZodMiniLiteral<"Environment">;
+                    id: z.ZodMiniString<string>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        fields: z.ZodMiniObject<{
+            nt_audience_id: z.ZodMiniString<string>;
+            nt_name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            nt_description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+    }, z.core.$strip>>>;
+    nt_variants: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniArray<z.ZodMiniCustom<Entry, Entry>>>>;
+    nt_experience_id: z.ZodMiniString<string>;
+}, z.core.$catchall<z.ZodMiniJSONSchema>>;
+/**
+ * TypeScript type inferred from {@link PersonalizationFields}.
+ */
+export type PersonalizationFields = z.infer<typeof PersonalizationFields>;
+/**
+ * Zod schema describing a Personalization entry, which is associated with a {@link PersonalizedEntry } via its `fields.nt_experiences`.
+ */
+export declare const PersonalizationEntry: z.ZodMiniObject<{
+    metadata: z.ZodMiniObject<{
+        tags: z.ZodMiniArray<z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Tag">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+    }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+    sys: z.ZodMiniObject<{
+        type: z.ZodMiniLiteral<"Entry">;
+        contentType: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"ContentType">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        publishedVersion: z.ZodMiniNumber<number>;
+        id: z.ZodMiniString<string>;
+        createdAt: z.ZodMiniAny;
+        updatedAt: z.ZodMiniAny;
+        locale: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        revision: z.ZodMiniNumber<number>;
+        space: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Space">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        environment: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Environment">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    fields: z.ZodMiniObject<{
+        nt_name: z.ZodMiniString<string>;
+        nt_description: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+        nt_type: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"nt_experiment">, z.ZodMiniLiteral<"nt_personalization">]>;
+        nt_config: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniNullable<z.ZodMiniObject<{
+            distribution: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniArray<z.ZodMiniNumber<number>>>>;
+            traffic: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniNumber<number>>>;
+            components: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+                type: z.ZodMiniOptional<z.ZodMiniLiteral<"EntryReplacement">>;
+                baseline: z.ZodMiniObject<{
+                    id: z.ZodMiniString<string>;
+                    hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+                }, z.core.$strip>;
+                variants: z.ZodMiniArray<z.ZodMiniObject<{
+                    id: z.ZodMiniString<string>;
+                    hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>, z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"InlineVariable">;
+                key: z.ZodMiniString<string>;
+                valueType: z.ZodMiniEnum<{
+                    Boolean: "Boolean";
+                    Number: "Number";
+                    Object: "Object";
+                    String: "String";
+                }>;
+                baseline: z.ZodMiniObject<{
+                    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>;
+                variants: z.ZodMiniArray<z.ZodMiniObject<{
+                    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">>>>;
+            sticky: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>>;
+        }, z.core.$strip>>>>, z.ZodMiniTransform<{
+            distribution?: number[] | undefined;
+            traffic?: number | undefined;
+            components?: ({
+                baseline: {
+                    id: string;
+                    hidden: boolean;
+                };
+                variants: {
+                    id: string;
+                    hidden: boolean;
+                }[];
+                type?: "EntryReplacement" | undefined;
+            } | {
+                type: "InlineVariable";
+                key: string;
+                valueType: "Boolean" | "Number" | "Object" | "String";
+                baseline: {
+                    value: string | number | boolean | Record<string, z.core.util.JSONType> | null;
+                };
+                variants: {
+                    value: string | number | boolean | Record<string, z.core.util.JSONType> | null;
+                }[];
+            })[] | undefined;
+            sticky?: boolean | undefined;
+        } | null, {
+            distribution?: number[] | undefined;
+            traffic?: number | undefined;
+            components?: ({
+                baseline: {
+                    id: string;
+                    hidden: boolean;
+                };
+                variants: {
+                    id: string;
+                    hidden: boolean;
+                }[];
+                type?: "EntryReplacement" | undefined;
+            } | {
+                type: "InlineVariable";
+                key: string;
+                valueType: "Boolean" | "Number" | "Object" | "String";
+                baseline: {
+                    value: string | number | boolean | Record<string, z.core.util.JSONType> | null;
+                };
+                variants: {
+                    value: string | number | boolean | Record<string, z.core.util.JSONType> | null;
+                }[];
+            })[] | undefined;
+            sticky?: boolean | undefined;
+        } | null>>;
+        nt_audience: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniObject<{
+            metadata: z.ZodMiniObject<{
+                tags: z.ZodMiniArray<z.ZodMiniObject<{
+                    sys: z.ZodMiniObject<{
+                        type: z.ZodMiniLiteral<"Link">;
+                        linkType: z.ZodMiniLiteral<"Tag">;
+                        id: z.ZodMiniString<string>;
+                    }, z.core.$strip>;
+                }, z.core.$strip>>;
+            }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Entry">;
+                contentType: z.ZodMiniObject<{
+                    sys: z.ZodMiniObject<{
+                        type: z.ZodMiniLiteral<"Link">;
+                        linkType: z.ZodMiniLiteral<"ContentType">;
+                        id: z.ZodMiniString<string>;
+                    }, z.core.$strip>;
+                }, z.core.$strip>;
+                publishedVersion: z.ZodMiniNumber<number>;
+                id: z.ZodMiniString<string>;
+                createdAt: z.ZodMiniAny;
+                updatedAt: z.ZodMiniAny;
+                locale: z.ZodMiniOptional<z.ZodMiniString<string>>;
+                revision: z.ZodMiniNumber<number>;
+                space: z.ZodMiniObject<{
+                    sys: z.ZodMiniObject<{
+                        type: z.ZodMiniLiteral<"Link">;
+                        linkType: z.ZodMiniLiteral<"Space">;
+                        id: z.ZodMiniString<string>;
+                    }, z.core.$strip>;
+                }, z.core.$strip>;
+                environment: z.ZodMiniObject<{
+                    sys: z.ZodMiniObject<{
+                        type: z.ZodMiniLiteral<"Link">;
+                        linkType: z.ZodMiniLiteral<"Environment">;
+                        id: z.ZodMiniString<string>;
+                    }, z.core.$strip>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+            fields: z.ZodMiniObject<{
+                nt_audience_id: z.ZodMiniString<string>;
+                nt_name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+                nt_description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+        }, z.core.$strip>>>;
+        nt_variants: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniArray<z.ZodMiniCustom<Entry, Entry>>>>;
+        nt_experience_id: z.ZodMiniString<string>;
+    }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link PersonalizationEntry}.
+ */
+export type PersonalizationEntry = z.infer<typeof PersonalizationEntry>;
+/**
+ * Type guard for {@link PersonalizationEntry}.
+ *
+ * @param entry - Contentful entry or link to test.
+ * @returns `true` if the value conforms to {@link PersonalizationEntry}, otherwise `false`.
+ */
+export declare function isPersonalizationEntry(entry: CtflEntry | Link): entry is PersonalizationEntry;
+/**
+ * Zod schema describing an array of personalization entries or links.
+ *
+ * @remarks
+ * Each element may be a {@link Link} or a fully resolved {@link PersonalizationEntry}.
+ */
+export declare const PersonalizationEntryArray: z.ZodMiniArray<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+    sys: z.ZodMiniObject<{
+        type: z.ZodMiniLiteral<"Link">;
+        linkType: z.ZodMiniString<string>;
+        id: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodMiniObject<{
+    metadata: z.ZodMiniObject<{
+        tags: z.ZodMiniArray<z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Tag">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+    }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+    sys: z.ZodMiniObject<{
+        type: z.ZodMiniLiteral<"Entry">;
+        contentType: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"ContentType">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        publishedVersion: z.ZodMiniNumber<number>;
+        id: z.ZodMiniString<string>;
+        createdAt: z.ZodMiniAny;
+        updatedAt: z.ZodMiniAny;
+        locale: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        revision: z.ZodMiniNumber<number>;
+        space: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Space">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        environment: z.ZodMiniObject<{
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Link">;
+                linkType: z.ZodMiniLiteral<"Environment">;
+                id: z.ZodMiniString<string>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    fields: z.ZodMiniObject<{
+        nt_name: z.ZodMiniString<string>;
+        nt_description: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+        nt_type: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"nt_experiment">, z.ZodMiniLiteral<"nt_personalization">]>;
+        nt_config: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniNullable<z.ZodMiniObject<{
+            distribution: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniArray<z.ZodMiniNumber<number>>>>;
+            traffic: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniNumber<number>>>;
+            components: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+                type: z.ZodMiniOptional<z.ZodMiniLiteral<"EntryReplacement">>;
+                baseline: z.ZodMiniObject<{
+                    id: z.ZodMiniString<string>;
+                    hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+                }, z.core.$strip>;
+                variants: z.ZodMiniArray<z.ZodMiniObject<{
+                    id: z.ZodMiniString<string>;
+                    hidden: z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>, z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"InlineVariable">;
+                key: z.ZodMiniString<string>;
+                valueType: z.ZodMiniEnum<{
+                    Boolean: "Boolean";
+                    Number: "Number";
+                    Object: "Object";
+                    String: "String";
+                }>;
+                baseline: z.ZodMiniObject<{
+                    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>;
+                variants: z.ZodMiniArray<z.ZodMiniObject<{
+                    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">>>>;
+            sticky: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>>;
+        }, z.core.$strip>>>>, z.ZodMiniTransform<{
+            distribution?: number[] | undefined;
+            traffic?: number | undefined;
+            components?: ({
+                baseline: {
+                    id: string;
+                    hidden: boolean;
+                };
+                variants: {
+                    id: string;
+                    hidden: boolean;
+                }[];
+                type?: "EntryReplacement" | undefined;
+            } | {
+                type: "InlineVariable";
+                key: string;
+                valueType: "Boolean" | "Number" | "Object" | "String";
+                baseline: {
+                    value: string | number | boolean | Record<string, z.core.util.JSONType> | null;
+                };
+                variants: {
+                    value: string | number | boolean | Record<string, z.core.util.JSONType> | null;
+                }[];
+            })[] | undefined;
+            sticky?: boolean | undefined;
+        } | null, {
+            distribution?: number[] | undefined;
+            traffic?: number | undefined;
+            components?: ({
+                baseline: {
+                    id: string;
+                    hidden: boolean;
+                };
+                variants: {
+                    id: string;
+                    hidden: boolean;
+                }[];
+                type?: "EntryReplacement" | undefined;
+            } | {
+                type: "InlineVariable";
+                key: string;
+                valueType: "Boolean" | "Number" | "Object" | "String";
+                baseline: {
+                    value: string | number | boolean | Record<string, z.core.util.JSONType> | null;
+                };
+                variants: {
+                    value: string | number | boolean | Record<string, z.core.util.JSONType> | null;
+                }[];
+            })[] | undefined;
+            sticky?: boolean | undefined;
+        } | null>>;
+        nt_audience: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniObject<{
+            metadata: z.ZodMiniObject<{
+                tags: z.ZodMiniArray<z.ZodMiniObject<{
+                    sys: z.ZodMiniObject<{
+                        type: z.ZodMiniLiteral<"Link">;
+                        linkType: z.ZodMiniLiteral<"Tag">;
+                        id: z.ZodMiniString<string>;
+                    }, z.core.$strip>;
+                }, z.core.$strip>>;
+            }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+            sys: z.ZodMiniObject<{
+                type: z.ZodMiniLiteral<"Entry">;
+                contentType: z.ZodMiniObject<{
+                    sys: z.ZodMiniObject<{
+                        type: z.ZodMiniLiteral<"Link">;
+                        linkType: z.ZodMiniLiteral<"ContentType">;
+                        id: z.ZodMiniString<string>;
+                    }, z.core.$strip>;
+                }, z.core.$strip>;
+                publishedVersion: z.ZodMiniNumber<number>;
+                id: z.ZodMiniString<string>;
+                createdAt: z.ZodMiniAny;
+                updatedAt: z.ZodMiniAny;
+                locale: z.ZodMiniOptional<z.ZodMiniString<string>>;
+                revision: z.ZodMiniNumber<number>;
+                space: z.ZodMiniObject<{
+                    sys: z.ZodMiniObject<{
+                        type: z.ZodMiniLiteral<"Link">;
+                        linkType: z.ZodMiniLiteral<"Space">;
+                        id: z.ZodMiniString<string>;
+                    }, z.core.$strip>;
+                }, z.core.$strip>;
+                environment: z.ZodMiniObject<{
+                    sys: z.ZodMiniObject<{
+                        type: z.ZodMiniLiteral<"Link">;
+                        linkType: z.ZodMiniLiteral<"Environment">;
+                        id: z.ZodMiniString<string>;
+                    }, z.core.$strip>;
+                }, z.core.$strip>;
+            }, z.core.$strip>;
+            fields: z.ZodMiniObject<{
+                nt_audience_id: z.ZodMiniString<string>;
+                nt_name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+                nt_description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+        }, z.core.$strip>>>;
+        nt_variants: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniArray<z.ZodMiniCustom<Entry, Entry>>>>;
+        nt_experience_id: z.ZodMiniString<string>;
+    }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+}, z.core.$strip>]>>;
+/**
+ * TypeScript type inferred from {@link PersonalizationEntryArray}.
+ */
+export type PersonalizationEntryArray = z.infer<typeof PersonalizationEntryArray>;
+//# sourceMappingURL=PersonalizationEntry.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PersonalizationEntry.d.ts","sourceRoot":"","sources":["../../src/contentful/PersonalizationEntry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B,OAAO,EAAE,SAAS,EAAe,IAAI,EAAE,MAAM,aAAa,CAAA;AAG1D;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,sGAG9B,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAErE;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yCA6DhC,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAE/B,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,GAAG,KAAK,IAAI,oBAAoB,CAE7F;AAED;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAAiD,CAAA;AAEvF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA"}

package/dist/contentful/PersonalizationEntry.js

@@ -0,0 +1,95 @@
+import * as z from 'zod/mini';
+import { AudienceEntry } from './AudienceEntry';
+import { CtflEntry, EntryFields, Link } from './CtflEntry';
+import { PersonalizationConfig } from './PersonalizationConfig';
+/**
+ * Union of supported personalization types.
+ *
+ * @remarks
+ * `nt_experiment` represents experiments (A/B tests), and `nt_personalization`
+ * represents always-on personalized experiences.
+ */
+export const PersonalizationType = z.union([
+    z.literal('nt_experiment'),
+    z.literal('nt_personalization'),
+]);
+/**
+ * Zod schema describing the fields of a Personalization entry.
+ *
+ * @remarks
+ * Extends the generic {@link EntryFields} with personalization-specific
+ * properties such as name, description, type, config, audience, and variants.
+ */
+export const PersonalizationFields = z.extend(EntryFields, {
+    /**
+     * The name of the personalization (Short Text).
+     */
+    nt_name: z.string(),
+    /**
+     * The description of the personalization (Short Text).
+     *
+     * @remarks
+     * Optional, may be `null` if no description is provided.
+     */
+    nt_description: z.optional(z.nullable(z.string())),
+    /**
+     * The type of the personalization (`nt_experiment` | `nt_personalization`).
+     */
+    nt_type: PersonalizationType,
+    /**
+     * The configuration of a {@link PersonalizationEntry } (JSON).
+     *
+     * @remarks
+     * Accepts `null` or an explicit {@link PersonalizationConfig} and converts
+     * falsy/undefined values into a default configuration.
+     */
+    nt_config: z.pipe(z.optional(z.prefault(z.nullable(PersonalizationConfig), null)), z.transform((v) => v ?? {
+        traffic: 0,
+        distribution: [0.5, 0.5],
+        components: [],
+        sticky: false,
+    })),
+    /**
+     * The audience of the personalization (Audience).
+     *
+     * @remarks
+     * Optional and nullable; when omitted or `null`, the personalization may apply
+     * to all users.
+     */
+    nt_audience: z.optional(z.nullable(AudienceEntry)),
+    /**
+     * All used variants of the personalization (Contentful references to other Content Types).
+     *
+     * @remarks
+     * Modeled as an array of untyped Contentful entries and defaults to an empty
+     * array when omitted.
+     */
+    nt_variants: z.optional(z.prefault(z.array(z.custom()), [])),
+    /**
+     * The personalization/experience ID related to this personalization entry.
+     */
+    nt_experience_id: z.string(),
+});
+/**
+ * Zod schema describing a Personalization entry, which is associated with a {@link PersonalizedEntry } via its `fields.nt_experiences`.
+ */
+export const PersonalizationEntry = z.extend(CtflEntry, {
+    fields: PersonalizationFields,
+});
+/**
+ * Type guard for {@link PersonalizationEntry}.
+ *
+ * @param entry - Contentful entry or link to test.
+ * @returns `true` if the value conforms to {@link PersonalizationEntry}, otherwise `false`.
+ */
+export function isPersonalizationEntry(entry) {
+    return PersonalizationEntry.safeParse(entry).success;
+}
+/**
+ * Zod schema describing an array of personalization entries or links.
+ *
+ * @remarks
+ * Each element may be a {@link Link} or a fully resolved {@link PersonalizationEntry}.
+ */
+export const PersonalizationEntryArray = z.array(z.union([Link, PersonalizationEntry]));
+//# sourceMappingURL=PersonalizationEntry.js.map

package/dist/contentful/PersonalizationEntry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PersonalizationEntry.js","sourceRoot":"","sources":["../../src/contentful/PersonalizationEntry.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AAC1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC;IACzC,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;IAC1B,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;CAChC,CAAC,CAAA;AAOF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE;IACzD;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IAEnB;;;;;OAKG;IACH,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IAElD;;OAEG;IACH,OAAO,EAAE,mBAAmB;IAE5B;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,CAAC,IAAI,CACf,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,IAAI,CAAC,CAAC,EAC/D,CAAC,CAAC,SAAS,CACT,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,IAAI;QACH,OAAO,EAAE,CAAC;QACV,YAAY,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;QACxB,UAAU,EAAE,EAAE;QACd,MAAM,EAAE,KAAK;KACd,CACJ,CACF;IAED;;;;;;OAMG;IACH,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAElD;;;;;;OAMG;IACH,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAS,CAAC,EAAE,EAAE,CAAC,CAAC;IAEnE;;OAEG;IACH,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;CAC7B,CAAC,CAAA;AAOF;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE;IACtD,MAAM,EAAE,qBAAqB;CAC9B,CAAC,CAAA;AAOF;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAuB;IAC5D,OAAO,oBAAoB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAA;AACtD,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAA"}