@contentful/optimization-api-schemas 0.1.0-alpha

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

@@ -0,0 +1 @@
+{"version":3,"file":"BatchExperienceEvent.d.ts","sourceRoot":"","sources":["../../../src/experience/event/BatchExperienceEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAkB7B;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAQ/B,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEvE;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAAgC,CAAA;AAEtE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA"}

package/dist/experience/event/BatchExperienceEvent.js

@@ -0,0 +1,37 @@
+import * as z from 'zod/mini';
+import { AliasEvent } from './AliasEvent';
+import { ComponentViewEvent } from './ComponentViewEvent';
+import { GroupEvent } from './GroupEvent';
+import { IdentifyEvent } from './IdentifyEvent';
+import { PageViewEvent } from './PageViewEvent';
+import { ScreenViewEvent } from './ScreenViewEvent';
+import { TrackEvent } from './TrackEvent';
+/**
+ * Partial schema capturing an anonymous identifier.
+ *
+ * @remarks
+ * This object is merged into each event type in a batch to associate the
+ * event with an `anonymousId`.
+ */
+const Anon = { anonymousId: z.string() };
+/**
+ * Zod schema describing each valid experience/personalization event within a batch.
+ *
+ * @remarks
+ * This is a discriminated union on the `type` field that supports all event
+ * types used in batch ingestion, each extended with an `anonymousId`.
+ */
+export const BatchExperienceEvent = z.discriminatedUnion('type', [
+    z.extend(AliasEvent, Anon),
+    z.extend(ComponentViewEvent, Anon),
+    z.extend(GroupEvent, Anon),
+    z.extend(IdentifyEvent, Anon),
+    z.extend(PageViewEvent, Anon),
+    z.extend(ScreenViewEvent, Anon),
+    z.extend(TrackEvent, Anon),
+]);
+/**
+ * Zod schema describing an array of {@link BatchExperienceEvent} items.
+ */
+export const BatchExperienceEventArray = z.array(BatchExperienceEvent);
+//# sourceMappingURL=BatchExperienceEvent.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BatchExperienceEvent.js","sourceRoot":"","sources":["../../../src/experience/event/BatchExperienceEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC;;;;;;GAMG;AACH,MAAM,IAAI,GAAG,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAA;AAExC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAC/D,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC;IAC1B,CAAC,CAAC,MAAM,CAAC,kBAAkB,EAAE,IAAI,CAAC;IAClC,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC;IAC1B,CAAC,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC;IAC7B,CAAC,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC;IAC7B,CAAC,CAAC,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC;IAC/B,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC;CAC3B,CAAC,CAAA;AAOF;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAA"}

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

@@ -0,0 +1,75 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing a `component` view event.
+ *
+ * @remarks
+ * Component view events track exposure of individual components such as
+ * entries or variables within a personalized experience.
+ *
+ * Extends {@link UniversalEventProperties}.
+ */
+export declare const ComponentViewEvent: 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>;
+/**
+ * TypeScript type inferred from {@link ComponentViewEvent}.
+ */
+export type ComponentViewEvent = z.infer<typeof ComponentViewEvent>;
+//# sourceMappingURL=ComponentViewEvent.d.ts.map

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

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

package/dist/experience/event/ComponentViewEvent.js

@@ -0,0 +1,43 @@
+import * as z from 'zod/mini';
+import { UniversalEventProperties } from './UniversalEventProperties';
+/**
+ * Zod schema describing a `component` view event.
+ *
+ * @remarks
+ * Component view events track exposure of individual components such as
+ * entries or variables within a personalized experience.
+ *
+ * Extends {@link UniversalEventProperties}.
+ */
+export const ComponentViewEvent = z.extend(UniversalEventProperties, {
+    /**
+     * Discriminator indicating that this event is a component view.
+     */
+    type: z.literal('component'),
+    /**
+     * Type of component that was viewed.
+     *
+     * - `'Entry'` — A content entry component.
+     * - `'Variable'` — A variable or inline value component.
+     */
+    componentType: z.union([z.literal('Entry'), z.literal('Variable')]),
+    /**
+     * Contentful entry ID corresponding to the component that was viewed.
+     */
+    componentId: z.string(),
+    /**
+     * Identifier of the experience that rendered this component.
+     *
+     * @remarks
+     * Optional; component views may occur outside of a specific experience/personalization.
+     */
+    experienceId: z.optional(z.string()),
+    /**
+     * Index of the variant associated with this component view.
+     *
+     * @remarks
+     * Typically corresponds to the index of the selected personalization entry.
+     */
+    variantIndex: z.number(),
+});
+//# sourceMappingURL=ComponentViewEvent.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ComponentViewEvent.js","sourceRoot":"","sources":["../../../src/experience/event/ComponentViewEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAC7B,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAErE;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,wBAAwB,EAAE;IACnE;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IAE5B;;;;;OAKG;IACH,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;IAEnE;;OAEG;IACH,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IAEvB;;;;;OAKG;IACH,YAAY,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAEpC;;;;;OAKG;IACH,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;CACzB,CAAC,CAAA"}