@contentful/optimization-api-schemas 0.1.0-alpha

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

@@ -0,0 +1,73 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing a custom `track` event.
+ *
+ * @remarks
+ * Track events capture arbitrary user actions that do not fit into
+ * the more specific event types (page, screen, identify, etc.).
+ *
+ * Extends {@link UniversalEventProperties}.
+ */
+export declare const TrackEvent: 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>;
+/**
+ * TypeScript type inferred from {@link TrackEvent}.
+ */
+export type TrackEvent = z.infer<typeof TrackEvent>;
+//# sourceMappingURL=TrackEvent.d.ts.map

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

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

package/dist/experience/event/TrackEvent.js

@@ -0,0 +1,27 @@
+import * as z from 'zod/mini';
+import { UniversalEventProperties } from './UniversalEventProperties';
+import { Properties } from './properties';
+/**
+ * Zod schema describing a custom `track` event.
+ *
+ * @remarks
+ * Track events capture arbitrary user actions that do not fit into
+ * the more specific event types (page, screen, identify, etc.).
+ *
+ * Extends {@link UniversalEventProperties}.
+ */
+export const TrackEvent = z.extend(UniversalEventProperties, {
+    /**
+     * Discriminator indicating that this event is a track event.
+     */
+    type: z.literal('track'),
+    /**
+     * Name of the event being tracked.
+     */
+    event: z.string(),
+    /**
+     * Additional properties describing the event.
+     */
+    properties: Properties,
+});
+//# sourceMappingURL=TrackEvent.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TrackEvent.js","sourceRoot":"","sources":["../../../src/experience/event/TrackEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAC7B,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,wBAAwB,EAAE;IAC3D;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IAExB;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IAEjB;;OAEG;IACH,UAAU,EAAE,UAAU;CACvB,CAAC,CAAA"}

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

@@ -0,0 +1,175 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing universal event context properties shared by all
+ * analytics events.
+ *
+ * @remarks
+ * The `page` and screen` properties are optional, but should usually be
+ * omitted for event types that are not `page` or `screen`
+ */
+export declare const UniversalEventContext: z.ZodMiniObject<{
+    /**
+     * Application-level metadata.
+     */
+    app: z.ZodMiniOptional<z.ZodMiniObject<{
+        name: z.ZodMiniString<string>;
+        version: z.ZodMiniString<string>;
+    }, z.core.$strip>>;
+    /**
+     * Campaign attribution metadata.
+     */
+    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-related consent information.
+     */
+    gdpr: z.ZodMiniObject<{
+        /**
+         * Indicates whether the user has given consent.
+         */
+        isConsentGiven: z.ZodMiniBoolean<boolean>;
+    }, z.core.$strip>;
+    /**
+     * Analytics library metadata.
+     */
+    library: z.ZodMiniObject<{
+        name: z.ZodMiniString<string>;
+        version: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    /**
+     * Locale identifier of the event (e.g., `"en-US"`).
+     */
+    locale: z.ZodMiniString<string>;
+    /**
+     * Optional geo-location information associated with the event.
+     */
+    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>>;
+    /**
+     * User agent string of the client, if available.
+     */
+    userAgent: z.ZodMiniOptional<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+export type UniversalEventContext = z.infer<typeof UniversalEventContext>;
+/**
+ * Zod schema describing universal properties shared by all analytics events.
+ *
+ * @remarks
+ * These properties capture common metadata such as channel, context,
+ * timestamps, and user identifiers.
+ */
+export declare const UniversalEventProperties: z.ZodMiniObject<{
+    /**
+     * Channel from which the event originated.
+     *
+     * @see Channel
+     */
+    channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
+    /**
+     * Context object carrying environment and client metadata.
+     */
+    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<{
+            /**
+             * Indicates whether the user has given consent.
+             */
+            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>;
+    /**
+     * Unique identifier for this message.
+     *
+     * @remarks
+     * Used to deduplicate events across retries and transports.
+     */
+    messageId: z.ZodMiniString<string>;
+    /**
+     * Timestamp when the event originally occurred.
+     *
+     * @remarks
+     * ISO 8601 datetime string.
+     */
+    originalTimestamp: z.iso.ZodMiniISODateTime;
+    /**
+     * Timestamp when the event payload was sent.
+     *
+     * @remarks
+     * ISO 8601 datetime string.
+     */
+    sentAt: z.iso.ZodMiniISODateTime;
+    /**
+     * Timestamp when the event was recorded or processed.
+     *
+     * @remarks
+     * ISO 8601 datetime string.
+     */
+    timestamp: z.iso.ZodMiniISODateTime;
+    /**
+     * Identifier of the authenticated user, if known.
+     */
+    userId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link UniversalEventProperties}.
+ */
+export type UniversalEventProperties = z.infer<typeof UniversalEventProperties>;
+//# sourceMappingURL=UniversalEventProperties.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"UniversalEventProperties.d.ts","sourceRoot":"","sources":["../../../src/experience/event/UniversalEventProperties.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAG7B;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB;IAChC;;OAEG;;;;;IAGH;;OAEG;;;;;;;;IAGH;;OAEG;;QAED;;WAEG;;;IAIL;;OAEG;;;;;IAGH;;OAEG;;IAGH;;OAEG;;;;;;;;;;;;;;;IAGH;;OAEG;;iBAEH,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB;IACnC;;;;OAIG;;IAGH;;OAEG;;;;;;;;;;;;;;YA7CD;;eAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAiDL;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;iBAEH,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA"}

package/dist/experience/event/UniversalEventProperties.js

@@ -0,0 +1,100 @@
+import * as z from 'zod/mini';
+import { App, Campaign, Channel, GeoLocation, Library, Page, Screen } from './properties';
+/**
+ * Zod schema describing universal event context properties shared by all
+ * analytics events.
+ *
+ * @remarks
+ * The `page` and screen` properties are optional, but should usually be
+ * omitted for event types that are not `page` or `screen`
+ */
+export const UniversalEventContext = z.object({
+    /**
+     * Application-level metadata.
+     */
+    app: App,
+    /**
+     * Campaign attribution metadata.
+     */
+    campaign: Campaign,
+    /**
+     * GDPR-related consent information.
+     */
+    gdpr: z.object({
+        /**
+         * Indicates whether the user has given consent.
+         */
+        isConsentGiven: z.boolean(),
+    }),
+    /**
+     * Analytics library metadata.
+     */
+    library: Library,
+    /**
+     * Locale identifier of the event (e.g., `"en-US"`).
+     */
+    locale: z.string(),
+    /**
+     * Optional geo-location information associated with the event.
+     */
+    location: z.optional(GeoLocation),
+    /**
+     * User agent string of the client, if available.
+     */
+    userAgent: z.optional(z.string()),
+});
+/**
+ * Zod schema describing universal properties shared by all analytics events.
+ *
+ * @remarks
+ * These properties capture common metadata such as channel, context,
+ * timestamps, and user identifiers.
+ */
+export const UniversalEventProperties = z.object({
+    /**
+     * Channel from which the event originated.
+     *
+     * @see Channel
+     */
+    channel: Channel,
+    /**
+     * Context object carrying environment and client metadata.
+     */
+    context: z.extend(UniversalEventContext, {
+        page: z.optional(Page),
+        screen: z.optional(Screen),
+    }),
+    /**
+     * Unique identifier for this message.
+     *
+     * @remarks
+     * Used to deduplicate events across retries and transports.
+     */
+    messageId: z.string(),
+    /**
+     * Timestamp when the event originally occurred.
+     *
+     * @remarks
+     * ISO 8601 datetime string.
+     */
+    originalTimestamp: z.iso.datetime(),
+    /**
+     * Timestamp when the event payload was sent.
+     *
+     * @remarks
+     * ISO 8601 datetime string.
+     */
+    sentAt: z.iso.datetime(),
+    /**
+     * Timestamp when the event was recorded or processed.
+     *
+     * @remarks
+     * ISO 8601 datetime string.
+     */
+    timestamp: z.iso.datetime(),
+    /**
+     * Identifier of the authenticated user, if known.
+     */
+    userId: z.optional(z.string()),
+});
+//# sourceMappingURL=UniversalEventProperties.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"UniversalEventProperties.js","sourceRoot":"","sources":["../../../src/experience/event/UniversalEventProperties.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAC7B,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAEzF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C;;OAEG;IACH,GAAG,EAAE,GAAG;IAER;;OAEG;IACH,QAAQ,EAAE,QAAQ;IAElB;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb;;WAEG;QACH,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE;KAC5B,CAAC;IAEF;;OAEG;IACH,OAAO,EAAE,OAAO;IAEhB;;OAEG;IACH,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAElB;;OAEG;IACH,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;IAEjC;;OAEG;IACH,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAClC,CAAC,CAAA;AAGF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C;;;;OAIG;IACH,OAAO,EAAE,OAAO;IAEhB;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,qBAAqB,EAAE;QACvC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;QACtB,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;KAC3B,CAAC;IAEF;;;;;OAKG;IACH,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IAErB;;;;;OAKG;IACH,iBAAiB,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;IAEnC;;;;;OAKG;IACH,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;IAExB;;;;;OAKG;IACH,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE;IAE3B;;OAEG;IACH,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAC/B,CAAC,CAAA"}

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

@@ -0,0 +1,12 @@
+export * from './AliasEvent';
+export * from './BatchExperienceEvent';
+export * from './ComponentViewEvent';
+export * from './ExperienceEvent';
+export * from './GroupEvent';
+export * from './IdentifyEvent';
+export * from './PageViewEvent';
+export * from './properties';
+export * from './ScreenViewEvent';
+export * from './TrackEvent';
+export * from './UniversalEventProperties';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/experience/event/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA;AACjC,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,cAAc,CAAA;AAC5B,cAAc,mBAAmB,CAAA;AACjC,cAAc,cAAc,CAAA;AAC5B,cAAc,4BAA4B,CAAA"}

package/dist/experience/event/index.js

@@ -0,0 +1,12 @@
+export * from './AliasEvent';
+export * from './BatchExperienceEvent';
+export * from './ComponentViewEvent';
+export * from './ExperienceEvent';
+export * from './GroupEvent';
+export * from './IdentifyEvent';
+export * from './PageViewEvent';
+export * from './properties';
+export * from './ScreenViewEvent';
+export * from './TrackEvent';
+export * from './UniversalEventProperties';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/experience/event/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,wBAAwB,CAAA;AACtC,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA;AACjC,cAAc,cAAc,CAAA;AAC5B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,cAAc,CAAA;AAC5B,cAAc,mBAAmB,CAAA;AACjC,cAAc,cAAc,CAAA;AAC5B,cAAc,4BAA4B,CAAA"}

package/dist/experience/event/properties/App.d.ts

@@ -0,0 +1,25 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing app-level properties.
+ *
+ * @remarks
+ * These properties typically describe the application that is emitting
+ * analytics events, such as its name and version.
+ *
+ * The entire object is optional; when omitted, no app context is attached.
+ */
+export declare const App: z.ZodMiniOptional<z.ZodMiniObject<{
+    /**
+     * Name of the application.
+     */
+    name: z.ZodMiniString<string>;
+    /**
+     * Version of the application.
+     */
+    version: z.ZodMiniString<string>;
+}, z.core.$strip>>;
+/**
+ * TypeScript type inferred from {@link App}.
+ */
+export type App = z.infer<typeof App>;
+//# sourceMappingURL=App.d.ts.map

package/dist/experience/event/properties/App.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../../../../src/experience/event/properties/App.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;;;;GAQG;AACH,eAAO,MAAM,GAAG;IAEZ;;OAEG;;IAGH;;OAEG;;kBAGN,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,GAAG,CAAC,CAAA"}

package/dist/experience/event/properties/App.js

@@ -0,0 +1,21 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing app-level properties.
+ *
+ * @remarks
+ * These properties typically describe the application that is emitting
+ * analytics events, such as its name and version.
+ *
+ * The entire object is optional; when omitted, no app context is attached.
+ */
+export const App = z.optional(z.object({
+    /**
+     * Name of the application.
+     */
+    name: z.string(),
+    /**
+     * Version of the application.
+     */
+    version: z.string(),
+}));
+//# sourceMappingURL=App.js.map

package/dist/experience/event/properties/App.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"App.js","sourceRoot":"","sources":["../../../../src/experience/event/properties/App.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,QAAQ,CAC3B,CAAC,CAAC,MAAM,CAAC;IACP;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAEhB;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CACH,CAAA"}

package/dist/experience/event/properties/Campaign.d.ts

@@ -0,0 +1,34 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing campaign attribution properties.
+ *
+ * @remarks
+ * These fields typically mirror UTM parameters used for marketing campaigns.
+ */
+export declare const Campaign: z.ZodMiniObject<{
+    /**
+     * Name of the campaign (e.g., `utm_campaign`).
+     */
+    name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Campaign source (e.g., `utm_source`).
+     */
+    source: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Campaign medium (e.g., `utm_medium`).
+     */
+    medium: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Campaign term (e.g., `utm_term`).
+     */
+    term: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    /**
+     * Campaign content (e.g., `utm_content`).
+     */
+    content: z.ZodMiniOptional<z.ZodMiniString<string>>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link Campaign}.
+ */
+export type Campaign = z.infer<typeof Campaign>;
+//# sourceMappingURL=Campaign.d.ts.map

package/dist/experience/event/properties/Campaign.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Campaign.d.ts","sourceRoot":"","sources":["../../../../src/experience/event/properties/Campaign.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;GAKG;AACH,eAAO,MAAM,QAAQ;IACnB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;iBAEH,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAA"}

package/dist/experience/event/properties/Campaign.js

@@ -0,0 +1,30 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing campaign attribution properties.
+ *
+ * @remarks
+ * These fields typically mirror UTM parameters used for marketing campaigns.
+ */
+export const Campaign = z.object({
+    /**
+     * Name of the campaign (e.g., `utm_campaign`).
+     */
+    name: z.optional(z.string()),
+    /**
+     * Campaign source (e.g., `utm_source`).
+     */
+    source: z.optional(z.string()),
+    /**
+     * Campaign medium (e.g., `utm_medium`).
+     */
+    medium: z.optional(z.string()),
+    /**
+     * Campaign term (e.g., `utm_term`).
+     */
+    term: z.optional(z.string()),
+    /**
+     * Campaign content (e.g., `utm_content`).
+     */
+    content: z.optional(z.string()),
+});
+//# sourceMappingURL=Campaign.js.map

package/dist/experience/event/properties/Campaign.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Campaign.js","sourceRoot":"","sources":["../../../../src/experience/event/properties/Campaign.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/B;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAE9B;;OAEG;IACH,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAE9B;;OAEG;IACH,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CAChC,CAAC,CAAA"}

package/dist/experience/event/properties/Channel.d.ts

@@ -0,0 +1,17 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing the analytics channel.
+ *
+ * @remarks
+ * Indicates the execution environment where the event originated.
+ *
+ * - `'mobile'` — Events from native or hybrid mobile apps.
+ * - `'server'` — Events emitted from backend/server-side code.
+ * - `'web'` — Events from web browsers or web-based clients.
+ */
+export declare const Channel: z.ZodMiniUnion<readonly [z.ZodMiniLiteral<"mobile">, z.ZodMiniLiteral<"server">, z.ZodMiniLiteral<"web">]>;
+/**
+ * TypeScript type inferred from {@link Channel}.
+ */
+export type Channel = z.infer<typeof Channel>;
+//# sourceMappingURL=Channel.d.ts.map

package/dist/experience/event/properties/Channel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Channel.d.ts","sourceRoot":"","sources":["../../../../src/experience/event/properties/Channel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;;;;;GASG;AACH,eAAO,MAAM,OAAO,4GAAwE,CAAA;AAE5F;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAA"}

package/dist/experience/event/properties/Channel.js

@@ -0,0 +1,13 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing the analytics channel.
+ *
+ * @remarks
+ * Indicates the execution environment where the event originated.
+ *
+ * - `'mobile'` — Events from native or hybrid mobile apps.
+ * - `'server'` — Events emitted from backend/server-side code.
+ * - `'web'` — Events from web browsers or web-based clients.
+ */
+export const Channel = z.union([z.literal('mobile'), z.literal('server'), z.literal('web')]);
+//# sourceMappingURL=Channel.js.map

package/dist/experience/event/properties/Channel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Channel.js","sourceRoot":"","sources":["../../../../src/experience/event/properties/Channel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA"}

package/dist/experience/event/properties/Dictionary.d.ts

@@ -0,0 +1,13 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing a simple string-to-string dictionary.
+ *
+ * @remarks
+ * Commonly used for query parameters or other small key–value maps.
+ */
+export declare const Dictionary: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniString<string>>;
+/**
+ * TypeScript type inferred from {@link Dictionary}.
+ */
+export type Dictionary = z.infer<typeof Dictionary>;
+//# sourceMappingURL=Dictionary.d.ts.map

package/dist/experience/event/properties/Dictionary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Dictionary.d.ts","sourceRoot":"","sources":["../../../../src/experience/event/properties/Dictionary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;GAKG;AACH,eAAO,MAAM,UAAU,mEAAmC,CAAA;AAE1D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAA"}

package/dist/experience/event/properties/Dictionary.js

@@ -0,0 +1,9 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing a simple string-to-string dictionary.
+ *
+ * @remarks
+ * Commonly used for query parameters or other small key–value maps.
+ */
+export const Dictionary = z.record(z.string(), z.string());
+//# sourceMappingURL=Dictionary.js.map

package/dist/experience/event/properties/Dictionary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Dictionary.js","sourceRoot":"","sources":["../../../../src/experience/event/properties/Dictionary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAE7B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAA"}