@picked/analytics 0.0.117-next.2 → 0.0.117

package/dist/cjs/types.d.ts

@@ -0,0 +1,327 @@
+/** @file Analytics event types and interfaces for Snowplow tracking. */
+import type { ActivityCallbackData, AnonymousTrackingOptions, CommonEventProperties, SelfDescribingEvent } from '@snowplow/browser-tracker';
+import type { ExperienceStep, Field, FieldValue, Picked, ValidationError as FieldValidationError } from '@picked/client';
+import type { AppSchema, AppUrl, CvlyFunnelSchema, CvlyFunnelUrl, CvlyXSchema, CvlyXUrl, DeploymentSchema, DeploymentUrl, ElementSchema, ElementUrl, EventSchema, EventUrl, ExceptionSchema, ExceptionUrl, ExperienceSchema, ExperienceUrl, FeatureListSchema, FeatureListUrl, FieldListSchema, FieldListUrl, FormSchema, FormUrl, ModalSchema, ModalUrl, OrderSchema, OrderUrl, PickedSchema, PickedUrl, ProductListSchema, ProductListUrl, ResponseListSchema, ResponseListUrl, SessionSchema, SessionUrl, StepSchema, StepUrl, WorkspaceSchema, WorkspaceUrl } from './schemas/index.js';
+export type SnowplowSelfDescribingEvent = SelfDescribingEvent & CommonEventProperties;
+export type SchemaUrl<Schema extends string, Version extends string> = `iglu:dev.pckd/${Schema}/jsonschema/${Version}`;
+export interface Context<Url extends string, Schema extends Record<string, unknown>> {
+    schema: Url;
+    data: Schema;
+}
+type EventContext<T extends EventSchema> = Context<EventUrl, T>;
+type TopLevelEvent<Type extends string> = EventContext<{
+    type: Type;
+    meta: EventSchema['meta'];
+}>;
+export type ContextItem = Context<string, Record<string, unknown>>;
+export type ContextArray = ContextItem[];
+/**
+ * Type representing an event with its required and conditional context.
+ *
+ * @template EventType - The event type.
+ * @template RequiredContext - The required context for the event.
+ * @template ConditionalContext - The conditional context for the event which should be supplied when available.
+ */
+export interface SnowplowEventWithContext<EventType extends string, RequiredContext extends ContextArray, ConditionalContext extends ContextArray = []> {
+    event: TopLevelEvent<EventType>;
+    context: ConditionalContext extends ContextArray ? [...RequiredContext, ...Partial<ConditionalContext>[number][]] : RequiredContext;
+}
+export type AppContext = Context<AppUrl, AppSchema>;
+export type CvlyFunnelContext = Context<CvlyFunnelUrl, CvlyFunnelSchema>;
+export type CvlyXContext = Context<CvlyXUrl, CvlyXSchema>;
+export type ElementContext = Context<ElementUrl, ElementSchema>;
+export type ExceptionContext = Context<ExceptionUrl, ExceptionSchema>;
+export type ExperienceContext = Context<ExperienceUrl, ExperienceSchema>;
+export type FeatureListContext = Context<FeatureListUrl, FeatureListSchema>;
+export type FieldListContext = Context<FieldListUrl, FieldListSchema>;
+export type FormContext = Context<FormUrl, FormSchema>;
+export type ModalContext = Context<ModalUrl, ModalSchema>;
+export type OrderContext = Context<OrderUrl, OrderSchema>;
+export type PickedContext = Context<PickedUrl, PickedSchema>;
+export type ProductListContext = Context<ProductListUrl, ProductListSchema>;
+export type ResponseListContext = Context<ResponseListUrl, ResponseListSchema>;
+export type SessionContext = Context<SessionUrl, SessionSchema>;
+export type StepContext = Context<StepUrl, StepSchema>;
+export type WorkspaceContext = Context<WorkspaceUrl, WorkspaceSchema>;
+export type DeploymentContext = Context<DeploymentUrl, DeploymentSchema>;
+/** Flat key-value meta a tracker stamps into every Picked event it sends. */
+export type EventMeta = Readonly<Record<string, string | number | boolean>>;
+/**
+ * A tracker's event meta: fixed keys, or a function returning the keys, which the tracker
+ * calls when each event is sent.
+ */
+export type EventMetaSource = EventMeta | (() => EventMeta);
+export interface CreateTrackerOptions {
+    /**
+     * @deprecated The organization ID is no longer used by the analytics tracker. The
+     * field is accepted for backwards compatibility but the value is ignored.
+     */
+    organizationId?: string;
+    /**
+     * The project ID.
+     */
+    projectId?: string;
+    /**
+     * The application ID. Defaults to `'picked-analytics'`.
+     *
+     * @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracker-setup/initialization-options/
+     */
+    appId?: string;
+    /**
+     * The collector host. Defaults to `'evnts.pckd.dev'`, Picked's production
+     * collector. The host is resolved by the caller — `createTracker` reads no
+     * environment variables — so an embedder that must not reach production passes
+     * its own value.
+     *
+     * @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracker-setup/initialization-options/
+     */
+    collectorUrl?: string;
+    /**
+     * Path on `collectorUrl` that receives events, in place of Snowplow's
+     * `/com.snowplowanalytics.snowplow/tp2`. Set it when `collectorUrl` is the site's own
+     * origin fronting the collector through a reverse proxy, which re-attaches the canonical
+     * path upstream. Supplying a path also pins the transport to POST, since a GET would
+     * address the collector's `/i` endpoint, which the proxy does not carry.
+     *
+     * @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracker-setup/initialization-options/
+     */
+    collectorPath?: string;
+    /**
+     * Enable activity tracking page pings.
+     *
+     * @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/previous-versions/javascript-tracker-v3/tracking-events/#activity-tracking-page-pings
+     */
+    trackActivity?: boolean;
+    /**
+     * Callback for activity tracking.
+     *
+     * @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/previous-versions/javascript-tracker-v3/tracking-events/#enableactivitytrackingcallback
+     */
+    trackActivityCallback?: (data: ActivityCallbackData) => void;
+    /**
+     * Attach the page view ID to all events.
+     *
+     * @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracking-events/page-views/#webpage-page-view-id-context-entity
+     */
+    trackWebPage?: boolean;
+    /**
+     * Attach the session to all events.
+     *
+     * @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracking-events/session/
+     */
+    trackSessions?: boolean;
+    /**
+     * Attach the browser context to all events.
+     *
+     * @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/browsers/
+     */
+    trackBrowser?: boolean;
+    /**
+     * Enable the error tracking plugin.
+     *
+     * @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracking-events/errors/
+     */
+    trackErrors?: boolean;
+    /**
+     * Enable the core web vitals tracking plugin.
+     *
+     * @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracking-events/web-vitals/
+     */
+    trackVitals?: boolean;
+    /**
+     * Enable the navigation performance tracking plugin.
+     *
+     * @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracking-events/timings/
+     */
+    trackPerformance?: boolean;
+    /**
+     * Class-name allowlist for button click tracking. Setting it enables button click tracking.
+     *
+     * @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracking-events/button-click/#filter-function
+     */
+    trackButtonClickAllowList?: string[];
+    /**
+     * Filter function for button click tracking. Setting it enables button click tracking; the
+     * filter applies when `trackButtonClickAllowList` is absent.
+     *
+     * @see https://docs.snowplow.io/docs/collecting-data/collecting-from-own-applications/javascript-trackers/web-tracker/tracking-events/button-click/#filter-function
+     */
+    trackButtonClickFilter?: (element: HTMLElement) => boolean;
+    /**
+     * Keys stamped into the `meta` of every Picked event this tracker sends, and set as the
+     * `meta` of its global `app` context so native Snowplow events carry them too. A key here
+     * wins over a per-event key of the same name. Other trackers on the page are unaffected.
+     *
+     * A function is called when each event is sent, for the event's `meta` and again for its
+     * `app` context, so a key such as `signed_in` follows state that changes without a page load.
+     *
+     * @example { surface: 'marketing', env: 'production', signed_in: false }
+     * @example () => ({ surface: 'dashboard', env: 'production', signed_in: isSignedIn() })
+     */
+    eventMeta?: EventMetaSource;
+    /**
+     * Snowplow's `anonymousTracking` tracker option, passed through unchanged. Absent,
+     * Snowplow's default (identified tracking) applies.
+     */
+    anonymousTracking?: AnonymousTrackingOptions;
+    /**
+     * Parameters related to the CVLY-X environment.
+     *
+     * @deprecated
+     */
+    cvlyX?: {
+        /**
+         * The Git commit SHA of the current deployment (GIT_COMMIT_SHA).
+         */
+        gitCommitSha?: string;
+        /**
+         * The Vercel deployment ID (VERCEL_DEPLOYMENT_ID).
+         */
+        vercelDeploymentId: string;
+        /**
+         * The Vercel environment in which the application is running (e.g., production, preview, development) (VERCEL_ENV).
+         */
+        vercelEnv: string;
+        /**
+         * The Vercel URL of the current deployment (VERCEL_URL).
+         */
+        vercelUrl: string;
+    };
+    /**
+     * Parameters related to the application deployment environment.
+     */
+    deployment: {
+        /**
+         * The deployment environment.
+         */
+        env: string;
+        /**
+         * The Git commit SHA of the current deployment.
+         */
+        sha?: string;
+        /**
+         * The deployment ID.
+         */
+        id?: string;
+        /**
+         * The host address for the deployment.
+         */
+        host?: string;
+    };
+}
+export interface AnalyticsExperience {
+    id: string;
+    title: string;
+    /** The stable experience key. */
+    key?: string;
+}
+export interface AnalyticsStep {
+    id: string;
+    title: string;
+}
+interface AnalyticsForm {
+    id: string;
+    title: string;
+}
+export interface AnalyticsQuestionOption {
+    id: string;
+    title: string;
+    value: string | number | Record<string, unknown> | boolean;
+}
+interface AnalyticsModal {
+    id: string;
+    title: string;
+}
+export interface AnalyticsQuestion {
+    id: string;
+    type: 'input' | 'multiple-choice' | 'text';
+    title: string;
+    options?: AnalyticsQuestionOption[];
+}
+export type AnalyticsField = Field;
+export interface AnalyticsResponse {
+    fieldKey: string;
+    value: FieldValue | undefined;
+}
+export interface AnalyticsFeature {
+    feature: string;
+    name: string;
+    key: string;
+    bucket: boolean | string;
+}
+export type AnalyticsException = FieldValidationError | string;
+export interface AnalyticsOrder {
+    id: string;
+    checkoutToken?: string;
+    customerId?: string;
+    cartToken?: string;
+}
+export interface AnalyticsProduct {
+    itemId?: string;
+    itemName?: string;
+    affiliation?: string;
+    coupon?: string;
+    currency?: string;
+    creativeName?: string;
+    creativeSlot?: string;
+    discount?: number | string;
+    index?: number | string;
+    itemBrand?: string;
+    itemCategory?: string;
+    itemCategory2?: string;
+    itemCategory3?: string;
+    itemCategory4?: string;
+    itemCategory5?: string;
+    itemListId?: string;
+    itemListName?: string;
+    itemVariant?: string;
+    locationId?: string;
+    price?: number | string;
+    promotionId?: string;
+    promotionName?: string;
+    quantity?: number | string;
+    inStock?: boolean;
+}
+export type AnalyticsProductList = AnalyticsProduct[] | {
+    title?: string;
+    items: AnalyticsProduct[];
+};
+export interface AnalyticsShopifySession {
+    clientId?: string;
+    customerId?: string;
+    checkoutToken?: string;
+}
+/** The workspace that served the project config. */
+export interface AnalyticsWorkspace {
+    id?: string;
+    /** The published workspace version id; `null` when the workspace has no published version. */
+    versionId?: string | null;
+    status?: string;
+}
+export interface AnalyticsContext {
+    /** The Picked ID: the SDK's per-browser id of the visitor. */
+    pickedId?: string;
+    /** @deprecated Use `pickedId`. */
+    sessionId?: string;
+    isUser?: boolean;
+    projectId: string;
+    workspace?: AnalyticsWorkspace;
+    features?: AnalyticsFeature[];
+    experience?: AnalyticsExperience;
+    step?: ExperienceStep;
+    form?: AnalyticsForm;
+    fields?: AnalyticsField[];
+    responses?: AnalyticsResponse[];
+    modal?: AnalyticsModal;
+    productList?: AnalyticsProductList;
+    exception?: AnalyticsException;
+    shopifySession?: AnalyticsShopifySession;
+    order?: AnalyticsOrder;
+    identifiers?: Record<string, string>;
+}
+/** A capability `analyticsPlugin` sets up with the client and a reader of its analytics context. */
+export interface AnalyticsPluginCapability {
+    setup: (client: Picked, readContext: () => AnalyticsContext) => void;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/cjs/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,wEAAwE;AACxE,OAAO,KAAK,EACV,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EACV,cAAc,EACd,KAAK,EACL,UAAU,EACV,MAAM,EACN,eAAe,IAAI,oBAAoB,EACxC,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EACV,SAAS,EACT,MAAM,EACN,gBAAgB,EAChB,aAAa,EACb,WAAW,EACX,QAAQ,EACR,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,UAAU,EACV,WAAW,EACX,QAAQ,EACR,eAAe,EACf,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,YAAY,EACZ,UAAU,EACV,OAAO,EACP,WAAW,EACX,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,SAAS,EACT,iBAAiB,EACjB,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,UAAU,EACV,UAAU,EACV,OAAO,EACP,eAAe,EACf,YAAY,EACb,MAAM,WAAW,CAAA;AAElB,MAAM,MAAM,2BAA2B,GAAG,mBAAmB,GAAG,qBAAqB,CAAA;AAErF,MAAM,MAAM,SAAS,CACnB,MAAM,SAAS,MAAM,EACrB,OAAO,SAAS,MAAM,IACpB,iBAAiB,MAAM,eAAe,OAAO,EAAE,CAAA;AAEnD,MAAM,WAAW,OAAO,CAAC,GAAG,SAAS,MAAM,EAAE,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACjF,MAAM,EAAE,GAAG,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;CACb;AAED,KAAK,YAAY,CAAC,CAAC,SAAS,WAAW,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;AAE/D,KAAK,aAAa,CAAC,IAAI,SAAS,MAAM,IAAI,YAAY,CAAC;IACrD,IAAI,EAAE,IAAI,CAAA;IACV,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CAC1B,CAAC,CAAA;AAEF,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;AAClE,MAAM,MAAM,YAAY,GAAG,WAAW,EAAE,CAAA;AAExC;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB,CACvC,SAAS,SAAS,MAAM,EACxB,eAAe,SAAS,YAAY,EACpC,kBAAkB,SAAS,YAAY,GAAG,EAAE;IAE5C,KAAK,EAAE,aAAa,CAAC,SAAS,CAAC,CAAA;IAC/B,OAAO,EAAE,kBAAkB,SAAS,YAAY,GAC5C,CAAC,GAAG,eAAe,EAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,GAC9D,eAAe,CAAA;CACpB;AAGD,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AACnD,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAA;AACxE,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;AACzD,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,UAAU,EAAE,aAAa,CAAC,CAAA;AAC/D,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,YAAY,EAAE,eAAe,CAAC,CAAA;AACrE,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAA;AACxE,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAA;AAC3E,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,YAAY,EAAE,eAAe,CAAC,CAAA;AACrE,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;AACtD,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;AACzD,MAAM,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;AACzD,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,EAAE,YAAY,CAAC,CAAA;AAC5D,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,cAAc,EAAE,iBAAiB,CAAC,CAAA;AAG3E,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAA;AAC9E,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,UAAU,EAAE,aAAa,CAAC,CAAA;AAC/D,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;AACtD,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,YAAY,EAAE,eAAe,CAAC,CAAA;AACrE,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAA;AAExE,6EAA6E;AAC7E,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC,CAAA;AAE3E;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,CAAC,MAAM,SAAS,CAAC,CAAA;AAE3D,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAE5D;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAA;IAEpC;;;;;OAKG;IACH,sBAAsB,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,OAAO,CAAA;IAE1D;;;;;;;;;;OAUG;IACH,SAAS,CAAC,EAAE,eAAe,CAAA;IAE3B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,wBAAwB,CAAA;IAE5C;;;;OAIG;IACH,KAAK,CAAC,EAAE;QACN;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QAErB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAA;QAE1B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAA;QAEjB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;IAED;;OAEG;IACH,UAAU,EAAE;QACV;;WAEG;QACH,GAAG,EAAE,MAAM,CAAA;QAEX;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAA;QAEZ;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAA;QAEX;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,iCAAiC;IACjC,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd;AAED,UAAU,aAAa;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAA;CAC3D;AAED,UAAU,cAAc;IACtB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,OAAO,GAAG,iBAAiB,GAAG,MAAM,CAAA;IAC1C,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,uBAAuB,EAAE,CAAA;CACpC;AAED,MAAM,MAAM,cAAc,GAAG,KAAK,CAAA;AAElC,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,UAAU,GAAG,SAAS,CAAA;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,OAAO,GAAG,MAAM,CAAA;CACzB;AAED,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG,MAAM,CAAA;AAE9D,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC1B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC1B,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,MAAM,oBAAoB,GAC5B,gBAAgB,EAAE,GAClB;IACE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,gBAAgB,EAAE,CAAA;CAC1B,CAAA;AAEL,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,oDAAoD;AACpD,MAAM,WAAW,kBAAkB;IACjC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,8FAA8F;IAC9F,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,kCAAkC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,kBAAkB,CAAA;IAC9B,QAAQ,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC7B,UAAU,CAAC,EAAE,mBAAmB,CAAA;IAChC,IAAI,CAAC,EAAE,cAAc,CAAA;IACrB,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,MAAM,CAAC,EAAE,cAAc,EAAE,CAAA;IACzB,SAAS,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC/B,KAAK,CAAC,EAAE,cAAc,CAAA;IACtB,WAAW,CAAC,EAAE,oBAAoB,CAAA;IAClC,SAAS,CAAC,EAAE,kBAAkB,CAAA;IAC9B,cAAc,CAAC,EAAE,uBAAuB,CAAA;IACxC,KAAK,CAAC,EAAE,cAAc,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACrC;AAED,oGAAoG;AACpG,MAAM,WAAW,yBAAyB;IACxC,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,gBAAgB,KAAK,IAAI,CAAA;CACrE"}

package/dist/cjs/user-interaction.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @file Wires Picked experience targets to opt-in DOM interaction listeners and
+ * window/document level listeners.
+ */
+import { type InteractionEventName } from './interaction-events.js';
+import type { AnalyticsContext } from './types.js';
+/**
+ * Bind the listed DOM interaction listeners to the given target. Listeners not
+ * named in `enabledEvents` are not bound; the empty list is a no-op.
+ *
+ * @param {() => AnalyticsContext} createAnalyticsContext - Factory the bound
+ *   listeners call to read the current analytics context at the moment an
+ *   event fires.
+ * @param {EventTarget | null} target - Event target the listeners attach to
+ *   (typically an experience shadow root). When `null`, no listeners are bound.
+ * @param {readonly InteractionEventName[]} enabledEvents - Names of interaction
+ *   events to enable. Defaults to every known event for backwards compatibility
+ *   with direct callers that pre-date the opt-in plugin option.
+ * @example
+ * bindUserInteractionListeners(createCtx, shadowRoot, ['click', 'scroll'])
+ */
+export declare function bindUserInteractionListeners(createAnalyticsContext: () => AnalyticsContext, target: EventTarget | null, enabledEvents?: readonly InteractionEventName[]): void;
+/**
+ * Bind window/document-level listeners (page visibility, online/offline, resize,
+ * unload, etc.). Caller decides when to invoke this; it is gated by the plugin's
+ * `enableDocumentListeners` option.
+ *
+ * @param {() => AnalyticsContext} createAnalyticsContext - Factory the
+ *   listeners call to read the current analytics context at the moment an
+ *   event fires.
+ * @example
+ * bindGlobalEventListeners(createCtx)
+ */
+export declare function bindGlobalEventListeners(createAnalyticsContext: () => AnalyticsContext): void;
+//# sourceMappingURL=user-interaction.d.ts.map

package/dist/cjs/user-interaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-interaction.d.ts","sourceRoot":"","sources":["../../src/user-interaction.ts"],"names":[],"mappings":"AAAA;;;GAGG;AASH,OAAO,EAGL,KAAK,oBAAoB,EAC1B,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE/C;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,4BAA4B,CAC1C,sBAAsB,EAAE,MAAM,gBAAgB,EAC9C,MAAM,EAAE,WAAW,GAAG,IAAI,EAC1B,aAAa,GAAE,SAAS,oBAAoB,EAA4B,QAMzE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CAAC,sBAAsB,EAAE,MAAM,gBAAgB,QAQtF"}

package/dist/cjs/utils.d.ts

@@ -0,0 +1,268 @@
+import type { ExperienceInstance } from '@picked/client';
+import type { AnalyticsContext, AnalyticsExperience, AppContext, Context, ContextArray, ExceptionContext, ExperienceContext, FeatureListContext, FieldListContext, FormContext, ModalContext, OrderContext, ProductListContext, ResponseListContext, SchemaUrl, SessionContext, SnowplowEventWithContext, SnowplowSelfDescribingEvent, StepContext, WorkspaceContext } from './types.js';
+import type { EventSchema } from './schemas/index.js';
+/**
+ * Builds the Iglu URI that identifies a Snowplow schema and version.
+ *
+ * @param {string} schema - Schema name, such as `event` or `response_list`.
+ * @param {string} version - Schema version in Iglu's dash form, such as `1-0-0`.
+ * @returns {SchemaUrl} The fully qualified Iglu schema URI.
+ * @example schemaUrl('event', '1-0-0') // 'iglu:dev.pckd/event/jsonschema/1-0-0'
+ */
+export declare function schemaUrl<T extends string, U extends string>(schema: T, version: U): SchemaUrl<T, U>;
+/**
+ * Records a debug message. The body is a stub until debug mode is wired up.
+ *
+ * @param {string} _message - The message to record.
+ * @param {...unknown} _data - Values to record alongside the message.
+ * @example log('tracked', event)
+ */
+export declare function log(_message: string, ..._data: unknown[]): void;
+/**
+ * Records a warning. The body is a stub until debug mode is wired up.
+ *
+ * @param {string} _message - The message to record.
+ * @param {...unknown} _data - Values to record alongside the message.
+ * @example warn('"form" is required for this event', event)
+ */
+export declare function warn(_message: string, ..._data: unknown[]): void;
+/**
+ * Records an error. The body is a stub until debug mode is wired up.
+ *
+ * @param {string} _message - The message to record.
+ * @param {...unknown} _data - Values to record alongside the message.
+ * @example error('tracker failed', reason)
+ */
+export declare function error(_message: string, ..._data: unknown[]): void;
+/**
+ * Assembles a self-describing Snowplow event from a type, its contexts and its meta.
+ * Contexts that resolved to `undefined` are dropped, so a caller can pass an optional
+ * context inline.
+ *
+ * @param {string} type - The event type carried in the event's `data`.
+ * @param {ContextArray} context - The contexts to attach, `undefined` entries included.
+ * @param {EventSchema['meta']} [meta] - Event meta; defaults to an empty object.
+ * @returns {SnowplowSelfDescribingEvent} The event ready to hand to the tracker.
+ * @example createEvent('step_submit', [createContext('step', '1-0-1', step)])
+ */
+export declare function createEvent<E extends SnowplowEventWithContext<string, ContextArray, ContextArray>>(type: E['event']['data']['type'], context: E['context'], meta?: E['event']['data']['meta']): SnowplowSelfDescribingEvent;
+/**
+ * Wraps context data in its Iglu schema envelope.
+ *
+ * @param {string} schema - Schema name for the context.
+ * @param {string} version - Schema version in Iglu's dash form.
+ * @param {Record<string, unknown>} data - The context payload.
+ * @returns {Context} The context with its `schema` and `data` members.
+ * @example createContext('app', '1-0-0', { project_id: 'proj1' })
+ */
+export declare function createContext<S extends string, V extends string, D extends Record<string, unknown>>(schema: S, version: V, data: D): Context<SchemaUrl<S, V>, D>;
+/**
+ * Builds a tracking function for one event type. The returned function formats its
+ * payload through `formatter` and hands the result to the Snowplow tracker.
+ *
+ * @param {string} eventName - The event type the returned function tracks.
+ * @param {(payload: never, meta?: EventSchema['meta']) => SnowplowSelfDescribingEvent} formatter - Formats a payload into a self-describing event.
+ * @returns {(payload: never, meta?: EventSchema['meta']) => void} A function that formats and tracks one event.
+ * @example const trackStepSubmit = createTrackEvent('step_submit', formatEvent)
+ */
+export declare function createTrackEvent(eventName: string, formatter: (_: null, eventMeta?: EventSchema['meta']) => SnowplowSelfDescribingEvent): (eventMeta?: EventSchema['meta']) => void;
+export declare function createTrackEvent<P>(eventName: string, formatter: (eventPayload: P, eventMeta?: EventSchema['meta']) => SnowplowSelfDescribingEvent): (eventPayload: P, eventMeta?: EventSchema['meta']) => void;
+/**
+ * Builds a binder for one DOM event type. The returned function attaches the handler to
+ * a target at most once per type, and reads a fresh analytics context on every
+ * interaction.
+ *
+ * @param {string} type - The DOM event type to listen for.
+ * @param {(interaction: { analyticsContext: AnalyticsContext; event: Event }) => void} handler - Receives the event and the analytics context read at interaction time.
+ * @param {AddEventListenerOptions | boolean} [options] - Listener options; defaults to `{ passive: true }`.
+ * @returns {(target: EventTarget, createAnalyticsContext: () => AnalyticsContext) => void} A binder taking the target and a context factory.
+ * @example const bindClick = createBindListener('click', onClick)
+ */
+export declare function createBindListener<T extends Event = Event>(type: string, handler: (interaction: {
+    analyticsContext: AnalyticsContext;
+    event: T;
+}) => void, options?: AddEventListenerOptions | boolean): (target: EventTarget, createAnalyticsContext: () => AnalyticsContext) => void;
+/**
+ * Builds a binder that attaches the handler to `document` at most once per event type.
+ * The binder is inert where there is no document.
+ *
+ * @param {string} type - The DOM event type to listen for.
+ * @param {(interaction: { analyticsContext: AnalyticsContext; event: Event }) => void} handler - Receives the event and the analytics context read at interaction time.
+ * @returns {(createAnalyticsContext: () => AnalyticsContext) => void} A binder taking a context factory.
+ * @example const bindVisibility = createDocumentBindListener('visibilitychange', onHide)
+ */
+export declare function createDocumentBindListener<T extends Event = Event>(type: string, handler: (interaction: {
+    analyticsContext: AnalyticsContext;
+    event: T;
+}) => void): (createAnalyticsContext: () => AnalyticsContext) => void;
+/**
+ * Builds a binder that attaches the handler to `window` at most once per event type.
+ * The binder is inert where there is no window.
+ *
+ * @param {string} type - The DOM event type to listen for.
+ * @param {(interaction: { analyticsContext: AnalyticsContext; event: Event }) => void} handler - Receives the event and the analytics context read at interaction time.
+ * @returns {(createAnalyticsContext: () => AnalyticsContext) => void} A binder taking a context factory.
+ * @example const bindUnload = createWindowBindListener('beforeunload', onLeave)
+ */
+export declare function createWindowBindListener<T extends Event = Event>(type: string, handler: (interaction: {
+    analyticsContext: AnalyticsContext;
+    event: T;
+}) => void): (createAnalyticsContext: () => AnalyticsContext) => void;
+/**
+ * Builds the Snowplow `feature_list` context from the features the session resolved.
+ * A context with no features carries an empty list.
+ *
+ * @param {AnalyticsContext} event - Analytics context carrying the resolved features.
+ * @returns {FeatureListContext['data']} The feature list context data.
+ * @example formatFeatureListContextData({ projectId: 'p', features: [] }) // { items: [] }
+ */
+export declare function formatFeatureListContextData(event: AnalyticsContext): FeatureListContext['data'];
+/**
+ * Builds the Snowplow `app` context. A missing project id is reported and replaced with
+ * an `unknown` placeholder, so the event still reaches the collector.
+ *
+ * @param {AnalyticsContext} event - Analytics context carrying the project id.
+ * @returns {AppContext['data']} The app context data.
+ * @example formatAppContextData({ projectId: 'proj1' }) // { project_id: 'proj1' }
+ */
+export declare function formatAppContextData(event: AnalyticsContext): AppContext['data'];
+/**
+ * Builds the Snowplow `workspace` context from the workspace that served the project config.
+ *
+ * @param {AnalyticsContext} event - Analytics context carrying the workspace.
+ * @returns {WorkspaceContext['data'] | undefined} The workspace context data, or `undefined` when the context carries no workspace.
+ * @example formatWorkspaceContextData({ projectId: 'p', workspace: { id: 'wsp_1', versionId: 'wspv_1', status: 'live' } }) // { id: 'wsp_1', version_id: 'wspv_1', status: 'live' }
+ */
+export declare function formatWorkspaceContextData(event: AnalyticsContext): WorkspaceContext['data'] | undefined;
+/**
+ * Builds the Snowplow `session` context, folding in the session identifiers, the Google
+ * Analytics client id read from the `_ga` cookie, and any Shopify session tokens.
+ *
+ * @param {AnalyticsContext} event - Analytics context carrying the session.
+ * @returns {SessionContext['data']} The session context data.
+ * @example formatSessionContextData({ projectId: 'p', pickedId: 'v1' }) // { id: 'v1' }
+ */
+export declare function formatSessionContextData(event: AnalyticsContext): SessionContext['data'];
+/**
+ * Builds the Snowplow `field_list` context from the fields on the current step. The
+ * context describes the fields themselves — their type, label and options — and carries
+ * no captured value.
+ *
+ * @param {AnalyticsContext} event - Analytics context carrying the fields.
+ * @returns {FieldListContext['data'] | undefined} The field list context data, or `undefined` when no fields are present.
+ * @example formatFieldListContextData({ projectId: 'p', fields }) // { items: [...] }
+ */
+export declare function formatFieldListContextData(event: AnalyticsContext): FieldListContext['data'] | undefined;
+/**
+ * Builds the Snowplow `response_list` context from the responses whose fields carry
+ * `policies.trackValue`. Every event that carries this context passes through here, so
+ * this is the single point at which a field's tracking policy is enforced. The context
+ * is omitted when no response survives the filter.
+ *
+ * @param {AnalyticsContext} event - Analytics context carrying the responses and the fields they belong to.
+ * @returns {ResponseListContext['data'] | undefined} The response list context data, or `undefined` when nothing is trackable.
+ * @example
+ * const fields = [{ key: 'colour', policies: { trackValue: true }, ... }]
+ * formatResponseListContextData({ projectId: 'p', fields, responses: [{ fieldKey: 'colour', value: 'blue' }] })
+ * // { items: [{ field_id: 'colour', values: [{ value: 'blue' }] }] }
+ */
+export declare function formatResponseListContextData(event: AnalyticsContext): ResponseListContext['data'] | undefined;
+/**
+ * Builds the Snowplow `step` context, emitting the stable `key` alongside the
+ * workspace-specific `id` so steps stay correlatable across workspaces.
+ *
+ * @param {AnalyticsContext} event - Analytics context carrying the current step.
+ * @param {boolean} [required] - When `true`, returns `unknown` placeholders instead of `undefined` if no step is present.
+ * @returns {StepContext['data'] | undefined} The step context data, or `undefined` when no step is present and not required.
+ * @example
+ * const step = { id: 'uuid', key: 'welcome', name: 'Welcome', fieldKeys: [] }
+ * formatStepContextData({ projectId: 'p', step }, true) // { id: 'uuid', title: 'Welcome', key: 'welcome' }
+ */
+export declare function formatStepContextData(event: AnalyticsContext, required: true): StepContext['data'];
+export declare function formatStepContextData(event: AnalyticsContext, required?: false): StepContext['data'] | undefined;
+/**
+ * Builds the Snowplow `product_list` context, accepting either a bare item array or an
+ * object carrying a title alongside its items. When the list is absent and `required` is
+ * set, the absence is reported and an `unknown` placeholder is returned.
+ *
+ * @param {AnalyticsContext} event - Analytics context carrying the product list.
+ * @param {boolean} [required] - When `true`, returns a placeholder instead of `undefined`.
+ * @returns {ProductListContext['data'] | undefined} The product list context data, or `undefined` when absent and not required.
+ * @example formatProductListContextData({ projectId: 'p', productList: [] }, true)
+ */
+export declare function formatProductListContextData(event: AnalyticsContext, required: true): ProductListContext['data'];
+export declare function formatProductListContextData(event: AnalyticsContext, required?: false): ProductListContext['data'] | undefined;
+/**
+ * Builds the Snowplow `order` context. When the order is absent and `required` is set,
+ * the absence is reported and an `unknown` placeholder is returned.
+ *
+ * @param {AnalyticsContext} event - Analytics context carrying the order.
+ * @param {boolean} [required] - When `true`, returns a placeholder instead of `undefined`.
+ * @returns {OrderContext['data'] | undefined} The order context data, or `undefined` when absent and not required.
+ * @example formatOrderContextData({ projectId: 'p', order: { id: 'o1' } })
+ */
+export declare function formatOrderContextData(event: AnalyticsContext, required: true): OrderContext['data'];
+export declare function formatOrderContextData(event: AnalyticsContext, required?: false): OrderContext['data'] | undefined;
+/**
+ * Builds the Snowplow `experience` context, emitting the stable `key` alongside the id
+ * and title. When the experience is absent and
+ * `required` is set, the absence is reported and an `unknown` placeholder is returned.
+ *
+ * @param {AnalyticsContext} event - Analytics context carrying the experience.
+ * @param {boolean} [required] - When `true`, returns a placeholder instead of `undefined`.
+ * @returns {ExperienceContext['data'] | undefined} The experience context data, or `undefined` when absent and not required.
+ * @example formatExperienceContextData({ projectId: 'p', experience })
+ */
+export declare function formatExperienceContextData(event: AnalyticsContext, required: true): ExperienceContext['data'];
+export declare function formatExperienceContextData(event: AnalyticsContext, required?: false): ExperienceContext['data'] | undefined;
+/**
+ * Reads the analytics view of an experience instance: its id, title and key.
+ *
+ * @param {Pick<ExperienceInstance, 'experienceId' | 'experienceName' | 'experienceKey'>} instance - The experience instance.
+ * @returns {AnalyticsExperience} The experience as the analytics context carries it.
+ * @example toAnalyticsExperience(instance) // { id: 'exp-1', title: 'Exp 1', key: 'exp-key' }
+ */
+export declare const toAnalyticsExperience: (instance: Pick<ExperienceInstance, 'experienceId' | 'experienceName' | 'experienceKey'>) => AnalyticsExperience;
+/**
+ * Builds the Snowplow `exception` context from either a bare reason string or a field
+ * validation error. When the exception is absent and `required` is set, the absence is
+ * reported and an `unknown` placeholder is returned.
+ *
+ * @param {AnalyticsContext} event - Analytics context carrying the exception.
+ * @param {boolean} [required] - When `true`, returns a placeholder instead of `undefined`.
+ * @returns {ExceptionContext['data'] | undefined} The exception context data, or `undefined` when absent and not required.
+ * @example formatExceptionContextData({ projectId: 'p', exception: 'timeout' })
+ */
+export declare function formatExceptionContextData(event: AnalyticsContext, required: true): ExceptionContext['data'];
+export declare function formatExceptionContextData(event: AnalyticsContext, required?: false): ExceptionContext['data'] | undefined;
+/**
+ * Builds the Snowplow `form` context. A missing form is reported and replaced with an
+ * `unknown` placeholder, because every event carrying this context requires one.
+ *
+ * @param {AnalyticsContext} event - Analytics context carrying the form.
+ * @returns {FormContext['data']} The form context data.
+ * @example formatFormContextData({ projectId: 'p', form: { id: 'f1', title: 'Quote' } })
+ */
+export declare function formatFormContextData(event: AnalyticsContext): FormContext['data'];
+/**
+ * Builds the Snowplow `modal` context. A missing modal is reported and replaced with an
+ * `unknown` placeholder, because every event carrying this context requires one.
+ *
+ * @param {AnalyticsContext} event - Analytics context carrying the modal.
+ * @returns {ModalContext['data']} The modal context data.
+ * @example formatModalContextData({ projectId: 'p', modal: { id: 'm1', title: 'Offer' } })
+ */
+export declare function formatModalContextData(event: AnalyticsContext): ModalContext['data'];
+/**
+ * Creates a debounced version of the supplied function that will only invoke
+ * the original after `ms` milliseconds have elapsed since the last call.
+ *
+ * @template Fn
+ * @param {Fn} fn - The function to debounce.
+ * @param {number} ms - The debounce window in milliseconds.
+ * @returns {(...args: Parameters<Fn>) => void} A debounced wrapper around `fn`.
+ * @example
+ * const log = debounce((value: string) => console.log(value), 200)
+ */
+export declare function debounce<Fn extends (...args: never[]) => unknown>(fn: Fn, ms?: number): (...args: Parameters<Fn>) => void;
+//# sourceMappingURL=utils.d.ts.map