@contentful/optimization-api-schemas 0.1.0-alpha

package/dist/experience/ExperienceResponse.js

@@ -0,0 +1,38 @@
+import * as z from 'zod/mini';
+import { ChangeArray } from './change';
+import { SelectedPersonalizationArray } from './personalization';
+import { Profile } from './profile';
+import { ResponseEnvelope } from './ResponseEnvelope';
+/**
+ * Zod schema describing the `data` payload of a standard Experience API response.
+ *
+ * @remarks
+ * Contains the evaluated profile, selected personalizations, and computed
+ * changes that should be applied on the client.
+ */
+export const ExperienceData = z.object({
+    /**
+     * Profile associated with the evaluated events.
+     */
+    profile: Profile,
+    /**
+     * Selected experiences and variants for the profile.
+     *
+     * @see {@link SelectedPersonalizationArray}
+     */
+    experiences: SelectedPersonalizationArray,
+    /**
+     * Currently used for Custom Flags.
+     *
+     * @see {@link ChangeArray}
+     */
+    changes: ChangeArray,
+});
+/**
+ * Zod schema describing a full Experience API response.
+ *
+ * @remarks
+ * Extends {@link ResponseEnvelope} with {@link ExperienceData} as the `data` payload.
+ */
+export const ExperienceResponse = z.extend(ResponseEnvelope, { data: ExperienceData });
+//# sourceMappingURL=ExperienceResponse.js.map

package/dist/experience/ExperienceResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExperienceResponse.js","sourceRoot":"","sources":["../../src/experience/ExperienceResponse.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAErD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO;IAEhB;;;;OAIG;IACH,WAAW,EAAE,4BAA4B;IAEzC;;;;OAIG;IACH,OAAO,EAAE,WAAW;CACrB,CAAC,CAAA;AAOF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAA"}

package/dist/experience/ResponseEnvelope.d.ts

@@ -0,0 +1,35 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing the common envelope structure of responses
+ * from the Experience API.
+ *
+ * @remarks
+ * Concrete responses extend this schema and refine the `data` property
+ * to a more specific shape.
+ */
+export declare const ResponseEnvelope: z.ZodMiniObject<{
+    /**
+     * Response payload.
+     *
+     * @remarks
+     * The base schema uses an empty object; specific responses extend this
+     * with more detailed structures.
+     */
+    data: z.ZodMiniObject<Record<never, z.core.SomeType>, z.core.$strip>;
+    /**
+     * Human-readable message accompanying the response.
+     */
+    message: z.ZodMiniString<string>;
+    /**
+     * Indicates whether an error occurred.
+     *
+     * @remarks
+     * May be `null` when the error state is unknown or not applicable.
+     */
+    error: z.ZodMiniNullable<z.ZodMiniBoolean<boolean>>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link ResponseEnvelope}.
+ */
+export type ResponseEnvelope = z.infer<typeof ResponseEnvelope>;
+//# sourceMappingURL=ResponseEnvelope.d.ts.map

package/dist/experience/ResponseEnvelope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResponseEnvelope.d.ts","sourceRoot":"","sources":["../../src/experience/ResponseEnvelope.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;;;;;OAMG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;iBAEH,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}

package/dist/experience/ResponseEnvelope.js

@@ -0,0 +1,31 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing the common envelope structure of responses
+ * from the Experience API.
+ *
+ * @remarks
+ * Concrete responses extend this schema and refine the `data` property
+ * to a more specific shape.
+ */
+export const ResponseEnvelope = z.object({
+    /**
+     * Response payload.
+     *
+     * @remarks
+     * The base schema uses an empty object; specific responses extend this
+     * with more detailed structures.
+     */
+    data: z.object(),
+    /**
+     * Human-readable message accompanying the response.
+     */
+    message: z.string(),
+    /**
+     * Indicates whether an error occurred.
+     *
+     * @remarks
+     * May be `null` when the error state is unknown or not applicable.
+     */
+    error: z.nullable(z.boolean()),
+});
+//# sourceMappingURL=ResponseEnvelope.js.map

package/dist/experience/ResponseEnvelope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ResponseEnvelope.js","sourceRoot":"","sources":["../../src/experience/ResponseEnvelope.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC;;;;;;OAMG;IACH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAEhB;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IAEnB;;;;;OAKG;IACH,KAAK,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;CAC/B,CAAC,CAAA"}

package/dist/experience/change/Change.d.ts

@@ -0,0 +1,138 @@
+import * as z from 'zod/mini';
+/**
+ * Enumeration of supported change types.
+ *
+ * @remarks
+ * Currently only the `'Variable'` change type is supported, but the union
+ * in {@link ChangeBase} allows for additional types to be introduced.
+ */
+export declare const ChangeType: readonly ["Variable"];
+/**
+ * Zod schema for the allowed value types of a variable change.
+ *
+ * @remarks
+ * Supports primitives and JSON objects keyed by strings.
+ */
+export declare const VariableChangeValue: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniBoolean<boolean>, z.ZodMiniNull, z.ZodMiniNumber<number>, z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>]>;
+/**
+ * Zod schema representing an unknown change type.
+ *
+ * @remarks
+ * This can be used to handle forward-compatible change payloads where
+ * the `type` is not recognized.
+ */
+export declare const UnknownChange: z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    meta: z.ZodMiniObject<{
+        /**
+         * Identifier of the personalization or experiment experience.
+         */
+        experienceId: z.ZodMiniString<string>;
+        /**
+         * Index of the variant within the experience configuration.
+         *
+         * @remarks
+         * Typically corresponds to the array index in the experience's distribution.
+         */
+        variantIndex: z.ZodMiniNumber<number>;
+    }, z.core.$strip>;
+    type: z.ZodMiniString<string>;
+    value: z.ZodMiniUnknown;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link UnknownChange}.
+ */
+export type UnknownChange = z.infer<typeof UnknownChange>;
+/**
+ * Zod schema representing a change whose type is `'Variable'`.
+ *
+ * @remarks
+ * The `value` must conform to {@link VariableChangeValue}.
+ */
+export declare const VariableChange: z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    meta: z.ZodMiniObject<{
+        /**
+         * Identifier of the personalization or experiment experience.
+         */
+        experienceId: z.ZodMiniString<string>;
+        /**
+         * Index of the variant within the experience configuration.
+         *
+         * @remarks
+         * Typically corresponds to the array index in the experience's distribution.
+         */
+        variantIndex: z.ZodMiniNumber<number>;
+    }, z.core.$strip>;
+    type: z.ZodMiniLiteral<"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>;
+/**
+ * TypeScript type inferred from {@link VariableChange}.
+ */
+export type VariableChange = z.infer<typeof VariableChange>;
+/**
+ * JSON value type inferred from {@link z.json}.
+ *
+ * @remarks
+ * Represents any JSON-serializable value.
+ */
+export type Json = z.infer<typeof z.json>;
+/**
+ * Map of Custom Flag keys to JSON values.
+ */
+export type Flags = Record<string, Json>;
+/**
+ * Union of supported change types.
+ *
+ * @remarks
+ * Currently only {@link VariableChange} is included.
+ */
+export declare const Change: z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    meta: z.ZodMiniObject<{
+        /**
+         * Identifier of the personalization or experiment experience.
+         */
+        experienceId: z.ZodMiniString<string>;
+        /**
+         * Index of the variant within the experience configuration.
+         *
+         * @remarks
+         * Typically corresponds to the array index in the experience's distribution.
+         */
+        variantIndex: z.ZodMiniNumber<number>;
+    }, z.core.$strip>;
+    type: z.ZodMiniLiteral<"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>], "type">;
+/**
+ * TypeScript type inferred from {@link Change}.
+ */
+export type Change = z.infer<typeof Change>;
+/**
+ * Zod schema representing an array of {@link Change} items.
+ */
+export declare const ChangeArray: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    meta: z.ZodMiniObject<{
+        /**
+         * Identifier of the personalization or experiment experience.
+         */
+        experienceId: z.ZodMiniString<string>;
+        /**
+         * Index of the variant within the experience configuration.
+         *
+         * @remarks
+         * Typically corresponds to the array index in the experience's distribution.
+         */
+        variantIndex: z.ZodMiniNumber<number>;
+    }, z.core.$strip>;
+    type: z.ZodMiniLiteral<"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>], "type">>;
+/**
+ * TypeScript type inferred from {@link ChangeArray}.
+ */
+export type ChangeArray = z.infer<typeof ChangeArray>;
+//# sourceMappingURL=Change.d.ts.map

package/dist/experience/change/Change.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Change.d.ts","sourceRoot":"","sources":["../../../src/experience/change/Change.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,uBAAwB,CAAA;AAyC/C;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,sLAM9B,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;;;QApCtB;;WAEG;;QAGH;;;;;WAKG;;;;;iBAoCL,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,cAAc;;;QA3DvB;;WAEG;;QAGH;;;;;WAKG;;;;;iBA2DL,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D;;;;;GAKG;AACH,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAA;AAEzC;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;AAExC;;;;;GAKG;AACH,eAAO,MAAM,MAAM;;;QA/Ff;;WAEG;;QAGH;;;;;WAKG;;;;;2BAqF6D,CAAA;AAEpE;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,CAAA;AAE3C;;GAEG;AACH,eAAO,MAAM,WAAW;;;QAzGpB;;WAEG;;QAGH;;;;;WAKG;;;;;4BA+FmC,CAAA;AAE1C;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAA"}

package/dist/experience/change/Change.js

@@ -0,0 +1,102 @@
+import * as z from 'zod/mini';
+/**
+ * Enumeration of supported change types.
+ *
+ * @remarks
+ * Currently only the `'Variable'` change type is supported, but the union
+ * in {@link ChangeBase} allows for additional types to be introduced.
+ */
+export const ChangeType = ['Variable'];
+/**
+ * Zod schema describing the base shape for a change.
+ *
+ * @remarks
+ * This base is extended by specific change types such as {@link VariableChange}.
+ */
+const ChangeBase = z.object({
+    /**
+     * Key identifying the subject of the change.
+     */
+    key: z.string(),
+    /**
+     * Discriminator for the change type.
+     *
+     * @remarks
+     * May be one of {@link ChangeType} or an arbitrary string for unknown types.
+     */
+    type: z.union([z.enum(ChangeType), z.string()]),
+    /**
+     * Metadata describing the originating experience and variant index.
+     */
+    meta: z.object({
+        /**
+         * Identifier of the personalization or experiment experience.
+         */
+        experienceId: z.string(),
+        /**
+         * Index of the variant within the experience configuration.
+         *
+         * @remarks
+         * Typically corresponds to the array index in the experience's distribution.
+         */
+        variantIndex: z.number(),
+    }),
+});
+/**
+ * Zod schema for the allowed value types of a variable change.
+ *
+ * @remarks
+ * Supports primitives and JSON objects keyed by strings.
+ */
+export const VariableChangeValue = z.union([
+    z.string(),
+    z.boolean(),
+    z.null(),
+    z.number(),
+    z.record(z.string(), z.json()),
+]);
+/**
+ * Zod schema representing an unknown change type.
+ *
+ * @remarks
+ * This can be used to handle forward-compatible change payloads where
+ * the `type` is not recognized.
+ */
+export const UnknownChange = z.extend(ChangeBase, {
+    /**
+     * Unconstrained change type string.
+     */
+    type: z.string(),
+    /**
+     * Payload for the change value, with unknown structure.
+     */
+    value: z.unknown(),
+});
+/**
+ * Zod schema representing a change whose type is `'Variable'`.
+ *
+ * @remarks
+ * The `value` must conform to {@link VariableChangeValue}.
+ */
+export const VariableChange = z.extend(ChangeBase, {
+    /**
+     * Discriminator for a variable change.
+     */
+    type: z.literal('Variable'),
+    /**
+     * New value for the variable identified by {@link ChangeBase.key}.
+     */
+    value: VariableChangeValue,
+});
+/**
+ * Union of supported change types.
+ *
+ * @remarks
+ * Currently only {@link VariableChange} is included.
+ */
+export const Change = z.discriminatedUnion('type', [VariableChange]);
+/**
+ * Zod schema representing an array of {@link Change} items.
+ */
+export const ChangeArray = z.array(Change);
+//# sourceMappingURL=Change.js.map

package/dist/experience/change/Change.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Change.js","sourceRoot":"","sources":["../../../src/experience/change/Change.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,UAAU,CAAU,CAAA;AAE/C;;;;;GAKG;AACH,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1B;;OAEG;IACH,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IAEf;;;;;OAKG;IACH,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IAE/C;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb;;WAEG;QACH,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;QAExB;;;;;WAKG;QACH,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;KACzB,CAAC;CACH,CAAC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC;IACzC,CAAC,CAAC,MAAM,EAAE;IACV,CAAC,CAAC,OAAO,EAAE;IACX,CAAC,CAAC,IAAI,EAAE;IACR,CAAC,CAAC,MAAM,EAAE;IACV,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;CAC/B,CAAC,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE;IAChD;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAEhB;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE;CACnB,CAAC,CAAA;AAOF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE;IACjD;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,mBAAmB;CAC3B,CAAC,CAAA;AAoBF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,cAAc,CAAC,CAAC,CAAA;AAOpE;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA"}

package/dist/experience/change/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Change';
+//# sourceMappingURL=index.d.ts.map

package/dist/experience/change/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/experience/change/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA"}

package/dist/experience/change/index.js

@@ -0,0 +1,2 @@
+export * from './Change';
+//# sourceMappingURL=index.js.map

package/dist/experience/change/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/experience/change/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA"}

package/dist/experience/event/AliasEvent.d.ts

@@ -0,0 +1,73 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing an `alias` event.
+ *
+ * @remarks
+ * Currently unused.
+ *
+ * Alias events are typically used to associate multiple identifiers
+ * (for example, anonymous and authenticated IDs) with the same user.
+ *
+ * Extends {@link UniversalEventProperties} with a fixed `type` field.
+ */
+export declare const AliasEvent: z.ZodMiniObject<{
+    channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
+    context: z.ZodMiniObject<{
+        app: z.ZodMiniOptional<z.ZodMiniObject<{
+            name: z.ZodMiniString<string>;
+            version: z.ZodMiniString<string>;
+        }, z.core.$strip>>;
+        campaign: z.ZodMiniObject<{
+            name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            source: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            medium: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            term: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            content: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        }, z.core.$strip>;
+        gdpr: z.ZodMiniObject<{
+            isConsentGiven: z.ZodMiniBoolean<boolean>;
+        }, z.core.$strip>;
+        library: z.ZodMiniObject<{
+            name: z.ZodMiniString<string>;
+            version: z.ZodMiniString<string>;
+        }, z.core.$strip>;
+        locale: z.ZodMiniString<string>;
+        location: z.ZodMiniOptional<z.ZodMiniObject<{
+            coordinates: z.ZodMiniOptional<z.ZodMiniObject<{
+                latitude: z.ZodMiniNumber<number>;
+                longitude: z.ZodMiniNumber<number>;
+            }, z.core.$strip>>;
+            city: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            postalCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            region: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            regionCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            country: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            countryCode: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            continent: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            timezone: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        }, z.core.$strip>>;
+        userAgent: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        page: z.ZodMiniOptional<z.ZodMiniObject<{
+            path: z.ZodMiniString<string>;
+            query: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+            referrer: z.ZodMiniString<string>;
+            search: z.ZodMiniString<string>;
+            title: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            url: z.ZodMiniString<string>;
+        }, z.core.$catchall<z.ZodMiniJSONSchema>>>;
+        screen: z.ZodMiniOptional<z.ZodMiniObject<{
+            name: z.ZodMiniString<string>;
+        }, z.core.$catchall<z.ZodMiniJSONSchema>>>;
+    }, z.core.$strip>;
+    messageId: z.ZodMiniString<string>;
+    originalTimestamp: z.iso.ZodMiniISODateTime;
+    sentAt: z.iso.ZodMiniISODateTime;
+    timestamp: z.iso.ZodMiniISODateTime;
+    userId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    type: z.ZodMiniLiteral<"alias">;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link AliasEvent}.
+ */
+export type AliasEvent = z.infer<typeof AliasEvent>;
+//# sourceMappingURL=AliasEvent.d.ts.map

package/dist/experience/event/AliasEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AliasEvent.d.ts","sourceRoot":"","sources":["../../../src/experience/event/AliasEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAG7B;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAKrB,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAA"}

package/dist/experience/event/AliasEvent.js

@@ -0,0 +1,20 @@
+import * as z from 'zod/mini';
+import { UniversalEventProperties } from './UniversalEventProperties';
+/**
+ * Zod schema describing an `alias` event.
+ *
+ * @remarks
+ * Currently unused.
+ *
+ * Alias events are typically used to associate multiple identifiers
+ * (for example, anonymous and authenticated IDs) with the same user.
+ *
+ * Extends {@link UniversalEventProperties} with a fixed `type` field.
+ */
+export const AliasEvent = z.extend(UniversalEventProperties, {
+    /**
+     * Discriminator indicating that this event is an alias event.
+     */
+    type: z.literal('alias'),
+});
+//# sourceMappingURL=AliasEvent.js.map

package/dist/experience/event/AliasEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AliasEvent.js","sourceRoot":"","sources":["../../../src/experience/event/AliasEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAC7B,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAErE;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,wBAAwB,EAAE;IAC3D;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;CACzB,CAAC,CAAA"}