@contentful/optimization-api-schemas 0.1.0-alpha

package/dist/experience/ExperienceRequest.d.ts

@@ -0,0 +1,440 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing optional configuration for an experience request.
+ *
+ * @remarks
+ * These options can be used to enable or filter specific features when
+ * evaluating experiences.
+ */
+export declare const ExperienceRequestOptions: z.ZodMiniObject<{
+    /**
+     * Features or capabilities to enable for this request.
+     */
+    features: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link ExperienceRequestOptions}.
+ */
+export type ExperienceRequestOptions = z.infer<typeof ExperienceRequestOptions>;
+/**
+ * Zod schema describing the data payload for an experience request.
+ *
+ * @remarks
+ * Contains the list of events to be evaluated plus optional request
+ * configuration.
+ */
+export declare const ExperienceRequestData: z.ZodMiniObject<{
+    /**
+     * Experience events that should be evaluated by the Experience API.
+     *
+     * @remarks
+     * Must contain at least one event.
+     */
+    events: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[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>, 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<"component">;
+        componentType: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"Entry">, z.ZodMiniLiteral<"Variable">]>;
+        componentId: z.ZodMiniString<string>;
+        experienceId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        variantIndex: z.ZodMiniNumber<number>;
+    }, z.core.$strip>, 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<"group">;
+    }, z.core.$strip>, 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<"identify">;
+        traits: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>;
+    }, z.core.$strip>, z.ZodMiniObject<{
+        channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
+        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<"page">;
+        name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        properties: 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>>;
+        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.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>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, z.ZodMiniObject<{
+        channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
+        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<"screen">;
+        name: z.ZodMiniString<string>;
+        properties: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>>;
+        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>>;
+            screen: z.ZodMiniObject<{
+                name: z.ZodMiniString<string>;
+            }, z.core.$catchall<z.ZodMiniJSONSchema>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, 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<"track">;
+        event: z.ZodMiniString<string>;
+        properties: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>;
+    }, z.core.$strip>], "type">>;
+    /**
+     * Optional configuration for this experience request.
+     */
+    options: z.ZodMiniOptional<z.ZodMiniObject<{
+        /**
+         * Features or capabilities to enable for this request.
+         */
+        features: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link ExperienceRequestData}.
+ */
+export type ExperienceRequestData = z.infer<typeof ExperienceRequestData>;
+//# sourceMappingURL=ExperienceRequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ExperienceRequest.d.ts","sourceRoot":"","sources":["../../src/experience/ExperienceRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAG7B;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;IACnC;;OAEG;;iBAEH,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB;IAChC;;;;;OAKG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAGH;;OAEG;;QA7BH;;WAEG;;;iBA6BH,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA"}

package/dist/experience/ExperienceRequest.js

@@ -0,0 +1,36 @@
+import * as z from 'zod/mini';
+import { ExperienceEventArray } from './event';
+/**
+ * Zod schema describing optional configuration for an experience request.
+ *
+ * @remarks
+ * These options can be used to enable or filter specific features when
+ * evaluating experiences.
+ */
+export const ExperienceRequestOptions = z.object({
+    /**
+     * Features or capabilities to enable for this request.
+     */
+    features: z.optional(z.array(z.string())),
+});
+/**
+ * Zod schema describing the data payload for an experience request.
+ *
+ * @remarks
+ * Contains the list of events to be evaluated plus optional request
+ * configuration.
+ */
+export const ExperienceRequestData = z.object({
+    /**
+     * Experience events that should be evaluated by the Experience API.
+     *
+     * @remarks
+     * Must contain at least one event.
+     */
+    events: ExperienceEventArray.check(z.minLength(1)),
+    /**
+     * Optional configuration for this experience request.
+     */
+    options: z.optional(ExperienceRequestOptions),
+});
+//# sourceMappingURL=ExperienceRequest.js.map

package/dist/experience/ExperienceRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExperienceRequest.js","sourceRoot":"","sources":["../../src/experience/ExperienceRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAC7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAE9C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;CAC1C,CAAC,CAAA;AAOF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C;;;;;OAKG;IACH,MAAM,EAAE,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAElD;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,wBAAwB,CAAC;CAC9C,CAAC,CAAA"}

package/dist/experience/ExperienceResponse.d.ts

@@ -0,0 +1,173 @@
+import * as z from 'zod/mini';
+import { SelectedPersonalizationArray } from './personalization';
+/**
+ * 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 declare const ExperienceData: z.ZodMiniObject<{
+    /**
+     * Profile associated with the evaluated events.
+     */
+    profile: z.ZodMiniObject<{
+        id: z.ZodMiniString<string>;
+        stableId: z.ZodMiniString<string>;
+        random: z.ZodMiniNumber<number>;
+        audiences: z.ZodMiniArray<z.ZodMiniString<string>>;
+        traits: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>;
+        location: 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>;
+        session: z.ZodMiniObject<{
+            id: z.ZodMiniString<string>;
+            isReturningVisitor: z.ZodMiniBoolean<boolean>;
+            landingPage: 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>>;
+            count: z.ZodMiniNumber<number>;
+            activeSessionLength: z.ZodMiniNumber<number>;
+            averageSessionLength: z.ZodMiniNumber<number>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    /**
+     * Selected experiences and variants for the profile.
+     *
+     * @see {@link SelectedPersonalizationArray}
+     */
+    experiences: z.ZodMiniArray<z.ZodMiniObject<{
+        experienceId: z.ZodMiniString<string>;
+        variantIndex: z.ZodMiniNumber<number>;
+        variants: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+        sticky: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>>;
+    }, z.core.$strip>>;
+    /**
+     * Currently used for Custom Flags.
+     *
+     * @see {@link ChangeArray}
+     */
+    changes: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+        key: z.ZodMiniString<string>;
+        meta: z.ZodMiniObject<{
+            experienceId: z.ZodMiniString<string>;
+            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">>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link ExperienceData}.
+ */
+export type ExperienceData = z.infer<typeof ExperienceData>;
+/**
+ * Zod schema describing a full Experience API response.
+ *
+ * @remarks
+ * Extends {@link ResponseEnvelope} with {@link ExperienceData} as the `data` payload.
+ */
+export declare const ExperienceResponse: z.ZodMiniObject<{
+    message: z.ZodMiniString<string>;
+    error: z.ZodMiniNullable<z.ZodMiniBoolean<boolean>>;
+    data: z.ZodMiniObject<{
+        /**
+         * Profile associated with the evaluated events.
+         */
+        profile: z.ZodMiniObject<{
+            id: z.ZodMiniString<string>;
+            stableId: z.ZodMiniString<string>;
+            random: z.ZodMiniNumber<number>;
+            audiences: z.ZodMiniArray<z.ZodMiniString<string>>;
+            traits: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>;
+            location: 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>;
+            session: z.ZodMiniObject<{
+                id: z.ZodMiniString<string>;
+                isReturningVisitor: z.ZodMiniBoolean<boolean>;
+                landingPage: 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>>;
+                count: z.ZodMiniNumber<number>;
+                activeSessionLength: z.ZodMiniNumber<number>;
+                averageSessionLength: z.ZodMiniNumber<number>;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        /**
+         * Selected experiences and variants for the profile.
+         *
+         * @see {@link SelectedPersonalizationArray}
+         */
+        experiences: z.ZodMiniArray<z.ZodMiniObject<{
+            experienceId: z.ZodMiniString<string>;
+            variantIndex: z.ZodMiniNumber<number>;
+            variants: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+            sticky: z.ZodMiniOptional<z.ZodMiniPrefault<z.ZodMiniBoolean<boolean>>>;
+        }, z.core.$strip>>;
+        /**
+         * Currently used for Custom Flags.
+         *
+         * @see {@link ChangeArray}
+         */
+        changes: z.ZodMiniArray<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+            key: z.ZodMiniString<string>;
+            meta: z.ZodMiniObject<{
+                experienceId: z.ZodMiniString<string>;
+                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">>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link ExperienceResponse}.
+ */
+export type ExperienceResponse = z.infer<typeof ExperienceResponse>;
+/**
+ * Optimization data shape used for compatibility outside the API adapter.
+ *
+ * @remarks
+ * This type mirrors {@link ExperienceData} but replaces the `experiences`
+ * field with `personalizations` while preserving the rest of the structure.
+ */
+export type OptimizationData = Omit<ExperienceData, 'experiences'> & {
+    /**
+     * Selected personalizations for the profile.
+     */
+    personalizations: SelectedPersonalizationArray;
+};
+//# sourceMappingURL=ExperienceResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ExperienceResponse.d.ts","sourceRoot":"","sources":["../../src/experience/ExperienceResponse.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B,OAAO,EAAE,4BAA4B,EAAE,MAAM,mBAAmB,CAAA;AAIhE;;;;;;GAMG;AACH,eAAO,MAAM,cAAc;IACzB;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAGH;;;;OAIG;;;;;;;IAGH;;;;OAIG;;;;;;;;;;iBAEH,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB;;;;QA/B7B;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAGH;;;;WAIG;;;;;;;QAGH;;;;WAIG;;;;;;;;;;;iBAeiF,CAAA;AAEtF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEnE;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,cAAc,EAAE,aAAa,CAAC,GAAG;IACnE;;OAEG;IACH,gBAAgB,EAAE,4BAA4B,CAAA;CAC/C,CAAA"}