@contentful/optimization-api-schemas 0.1.0-alpha

package/dist/experience/profile/Profile.d.ts

@@ -0,0 +1,104 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing a full user profile as received from the Experience API.
+ *
+ * @remarks
+ * Represents the server-side view of a profile, including identifiers,
+ * traits, audiences, location, and session statistics.
+ */
+export declare const Profile: z.ZodMiniObject<{
+    /**
+     * Primary identifier of the profile.
+     */
+    id: z.ZodMiniString<string>;
+    /**
+     * Stable, long-lived identifier of the profile.
+     *
+     * @remarks
+     * Intended to remain constant across sessions and devices when possible.
+     * Usually equal to `id`.
+     */
+    stableId: z.ZodMiniString<string>;
+    /**
+     * Random value associated with the profile.
+     *
+     * @remarks
+     * Often used for deterministic bucketing (e.g., in experiments).
+     */
+    random: z.ZodMiniNumber<number>;
+    /**
+     * List of audience identifiers that this profile currently belongs to.
+     */
+    audiences: z.ZodMiniArray<z.ZodMiniString<string>>;
+    /**
+     * Traits describing the profile (user-level attributes).
+     *
+     * @see Traits
+     */
+    traits: z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniJSONSchema>;
+    /**
+     * Geo-location information associated with the profile.
+     *
+     * @see GeoLocation
+     */
+    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>;
+    /**
+     * Aggregated session statistics for the profile.
+     *
+     * @see SessionStatistics
+     */
+    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>;
+/**
+ * TypeScript type inferred from {@link Profile}.
+ */
+export type Profile = z.infer<typeof Profile>;
+/**
+ * Zod schema describing a partial profile payload used for sending events
+ * to the Experience & Insights APIs.
+ *
+ * @remarks
+ * This schema enforces the presence of an `id` field and allows additional
+ * JSON-serializable properties via `z.catchall`.
+ */
+export declare const PartialProfile: z.ZodMiniObject<{
+    /**
+     * Identifier of the profile.
+     *
+     * @remarks
+     * Used to associate events with an existing profile.
+     */
+    id: z.ZodMiniString<string>;
+}, z.core.$catchall<z.ZodMiniJSONSchema>>;
+/**
+ * TypeScript type inferred from {@link PartialProfile}.
+ */
+export type PartialProfile = z.infer<typeof PartialProfile>;
+//# sourceMappingURL=Profile.d.ts.map

package/dist/experience/profile/Profile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Profile.d.ts","sourceRoot":"","sources":["../../../src/experience/profile/Profile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAK7B;;;;;;GAMG;AACH,eAAO,MAAM,OAAO;IAClB;;OAEG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;;;;;;;;;;;;;;IAGH;;;;OAIG;;;;;;;;;;;;;;;;iBAEH,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAA;AAE7C;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc;IAEvB;;;;;OAKG;;yCAIN,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA"}

package/dist/experience/profile/Profile.js

@@ -0,0 +1,72 @@
+import * as z from 'zod/mini';
+import { GeoLocation } from '../event/properties';
+import { Traits } from '../event/properties/Traits';
+import { SessionStatistics } from './properties';
+/**
+ * Zod schema describing a full user profile as received from the Experience API.
+ *
+ * @remarks
+ * Represents the server-side view of a profile, including identifiers,
+ * traits, audiences, location, and session statistics.
+ */
+export const Profile = z.object({
+    /**
+     * Primary identifier of the profile.
+     */
+    id: z.string(),
+    /**
+     * Stable, long-lived identifier of the profile.
+     *
+     * @remarks
+     * Intended to remain constant across sessions and devices when possible.
+     * Usually equal to `id`.
+     */
+    stableId: z.string(),
+    /**
+     * Random value associated with the profile.
+     *
+     * @remarks
+     * Often used for deterministic bucketing (e.g., in experiments).
+     */
+    random: z.number(),
+    /**
+     * List of audience identifiers that this profile currently belongs to.
+     */
+    audiences: z.array(z.string()),
+    /**
+     * Traits describing the profile (user-level attributes).
+     *
+     * @see Traits
+     */
+    traits: Traits,
+    /**
+     * Geo-location information associated with the profile.
+     *
+     * @see GeoLocation
+     */
+    location: GeoLocation,
+    /**
+     * Aggregated session statistics for the profile.
+     *
+     * @see SessionStatistics
+     */
+    session: SessionStatistics,
+});
+/**
+ * Zod schema describing a partial profile payload used for sending events
+ * to the Experience & Insights APIs.
+ *
+ * @remarks
+ * This schema enforces the presence of an `id` field and allows additional
+ * JSON-serializable properties via `z.catchall`.
+ */
+export const PartialProfile = z.catchall(z.object({
+    /**
+     * Identifier of the profile.
+     *
+     * @remarks
+     * Used to associate events with an existing profile.
+     */
+    id: z.string(),
+}), z.json());
+//# sourceMappingURL=Profile.js.map

package/dist/experience/profile/Profile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Profile.js","sourceRoot":"","sources":["../../../src/experience/profile/Profile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B;;OAEG;IACH,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IAEd;;;;;;OAMG;IACH,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IAEpB;;;;;OAKG;IACH,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAElB;;OAEG;IACH,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAE9B;;;;OAIG;IACH,MAAM,EAAE,MAAM;IAEd;;;;OAIG;IACH,QAAQ,EAAE,WAAW;IAErB;;;;OAIG;IACH,OAAO,EAAE,iBAAiB;CAC3B,CAAC,CAAA;AAOF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,QAAQ,CACtC,CAAC,CAAC,MAAM,CAAC;IACP;;;;;OAKG;IACH,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;CACf,CAAC,EACF,CAAC,CAAC,IAAI,EAAE,CACT,CAAA"}

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

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

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

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

package/dist/experience/profile/index.js

@@ -0,0 +1,3 @@
+export * from './Profile';
+export * from './properties';
+//# sourceMappingURL=index.js.map

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

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

package/dist/experience/profile/properties/SessionStatistics.d.ts

@@ -0,0 +1,60 @@
+import * as z from 'zod/mini';
+/**
+ * Zod schema describing aggregated statistics for a user session.
+ *
+ * @remarks
+ * Captures both per-session metrics (such as `activeSessionLength`) and
+ * aggregate metrics (such as `averageSessionLength`) for a given profile.
+ */
+export declare const SessionStatistics: z.ZodMiniObject<{
+    /**
+     * Unique identifier for this session statistics record.
+     */
+    id: z.ZodMiniString<string>;
+    /**
+     * Indicates whether the visitor has been seen before.
+     *
+     * @remarks
+     * `true` typically means the visitor has at least one prior session.
+     */
+    isReturningVisitor: z.ZodMiniBoolean<boolean>;
+    /**
+     * Landing page for the session.
+     *
+     * @remarks
+     * Represents the first page the user visited in this session.
+     *
+     * @see Page
+     */
+    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>>;
+    /**
+     * Number of sessions associated with this profile or identifier.
+     *
+     * @remarks
+     * Often used in combination with {@link SessionStatistics.averageSessionLength}.
+     */
+    count: z.ZodMiniNumber<number>;
+    /**
+     * Duration of the active session.
+     */
+    activeSessionLength: z.ZodMiniNumber<number>;
+    /**
+     * Average session duration across all sessions represented by this record.
+     *
+     * @remarks
+     * The unit should match {@link SessionStatistics.activeSessionLength}.
+     */
+    averageSessionLength: z.ZodMiniNumber<number>;
+}, z.core.$strip>;
+/**
+ * TypeScript type inferred from {@link SessionStatistics}.
+ */
+export type SessionStatistics = z.infer<typeof SessionStatistics>;
+//# sourceMappingURL=SessionStatistics.d.ts.map

package/dist/experience/profile/properties/SessionStatistics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SessionStatistics.d.ts","sourceRoot":"","sources":["../../../../src/experience/profile/properties/SessionStatistics.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAG7B;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB;IAC5B;;OAEG;;IAGH;;;;;OAKG;;IAGH;;;;;;;OAOG;;;;;;;;;IAGH;;;;;OAKG;;IAGH;;OAEG;;IAGH;;;;;OAKG;;iBAEH,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA"}

package/dist/experience/profile/properties/SessionStatistics.js

@@ -0,0 +1,50 @@
+import * as z from 'zod/mini';
+import { Page } from '../../event/properties';
+/**
+ * Zod schema describing aggregated statistics for a user session.
+ *
+ * @remarks
+ * Captures both per-session metrics (such as `activeSessionLength`) and
+ * aggregate metrics (such as `averageSessionLength`) for a given profile.
+ */
+export const SessionStatistics = z.object({
+    /**
+     * Unique identifier for this session statistics record.
+     */
+    id: z.string(),
+    /**
+     * Indicates whether the visitor has been seen before.
+     *
+     * @remarks
+     * `true` typically means the visitor has at least one prior session.
+     */
+    isReturningVisitor: z.boolean(),
+    /**
+     * Landing page for the session.
+     *
+     * @remarks
+     * Represents the first page the user visited in this session.
+     *
+     * @see Page
+     */
+    landingPage: Page,
+    /**
+     * Number of sessions associated with this profile or identifier.
+     *
+     * @remarks
+     * Often used in combination with {@link SessionStatistics.averageSessionLength}.
+     */
+    count: z.number(),
+    /**
+     * Duration of the active session.
+     */
+    activeSessionLength: z.number(),
+    /**
+     * Average session duration across all sessions represented by this record.
+     *
+     * @remarks
+     * The unit should match {@link SessionStatistics.activeSessionLength}.
+     */
+    averageSessionLength: z.number(),
+});
+//# sourceMappingURL=SessionStatistics.js.map

package/dist/experience/profile/properties/SessionStatistics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SessionStatistics.js","sourceRoot":"","sources":["../../../../src/experience/profile/properties/SessionStatistics.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAA;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAA;AAE7C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC;;OAEG;IACH,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IAEd;;;;;OAKG;IACH,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE;IAE/B;;;;;;;OAOG;IACH,WAAW,EAAE,IAAI;IAEjB;;;;;OAKG;IACH,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IAEjB;;OAEG;IACH,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE;IAE/B;;;;;OAKG;IACH,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE;CACjC,CAAC,CAAA"}

package/dist/experience/profile/properties/index.d.ts

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

package/dist/experience/profile/properties/index.d.ts.map

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

package/dist/experience/profile/properties/index.js

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

package/dist/experience/profile/properties/index.js.map

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