@aranova/tracking-react 1.17.0 → 1.19.0

package/dist/{ingest-typed-D7I4aQ7p.d.ts → ingest-typed-BEFQd3WM.d.mts}

@@ -1,6 +1,6 @@
+import { J as JsonValue, j as FormSubmitConfig, k as FormSubmitMetadata } from './phone-utils-BlWj8oxq.mjs';
 import * as zod_v4_core from 'zod/v4/core';
 import * as z from 'zod/mini';
-import { J as JsonValue, j as FormSubmitConfig, k as FormSubmitMetadata } from './phone-utils-CYr6AmEP.js';
 
 /**
  * Metadata for a manually fired `cta_click` event.
@@ -92,6 +92,48 @@ declare const formStartConfigSchema: z.ZodMiniObject<{
 }, z.core.$strict>;
 type FormStartConfig = z.infer<typeof formStartConfigSchema>;
 
+/**
+ * A manual `form_details`: optional answers the API folds into the `form_submit` whose
+ * `submission_id` it names (add-only, never a lead). Built by `leadForms.addDetails()`.
+ */
+declare const formDetailsMetadataSchema: z.ZodMiniObject<{
+    form: z.ZodMiniObject<{
+        id: z.ZodMiniString<string>;
+        submission_id: z.ZodMiniUUID;
+        kind: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+        fields: z.ZodMiniArray<z.ZodMiniObject<{
+            name: z.ZodMiniString<string>;
+            type: z.ZodMiniString<string>;
+            label: z.ZodMiniNullable<z.ZodMiniString<string>>;
+            value: z.ZodMiniType<JsonValue, unknown, z.core.$ZodTypeInternals<JsonValue, unknown>>;
+            role: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+        }, z.core.$strict>>;
+        contract_version: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniInt>>;
+        contract_hash: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+        extra: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniObject<{
+            key: z.ZodMiniString<string>;
+            label: z.ZodMiniString<string>;
+            value: z.ZodMiniType<JsonValue, unknown, z.core.$ZodTypeInternals<JsonValue, unknown>>;
+        }, z.core.$strict>>>>;
+        contract_violations: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniObject<{
+            role: z.ZodMiniNullable<z.ZodMiniString<string>>;
+            rule: z.ZodMiniString<string>;
+        }, z.core.$strict>>>>;
+    }, z.core.$strict>;
+    page: z.ZodMiniObject<{
+        path: z.ZodMiniString<string>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+type FormDetailsMetadata = z.infer<typeof formDetailsMetadataSchema>;
+/**
+ * Registration config for `form_details`.
+ *
+ * Manual-only with no options; the empty object enables typed
+ * `trackEvent('form_details', ...)` calls.
+ */
+declare const formDetailsConfigSchema: z.ZodMiniObject<{}, z.core.$strict>;
+type FormDetailsConfig = z.infer<typeof formDetailsConfigSchema>;
+
 /**
  * Metadata for a manually fired `form_step` event.
  *
@@ -345,6 +387,80 @@ declare const timeOnSiteConfigSchema: z.ZodMiniObject<{
 }, z.core.$strict>;
 type TimeOnSiteConfig = z.infer<typeof timeOnSiteConfigSchema>;
 
+declare const videoVariantSchema: z.ZodMiniEnum<{
+    "16x9": "16x9";
+    "9x16": "9x16";
+}>;
+type VideoVariant = z.infer<typeof videoVariantSchema>;
+declare const videoProgressTriggerReasonSchema: z.ZodMiniEnum<{
+    goal: "goal";
+    ended: "ended";
+    pause: "pause";
+    page_exit: "page_exit";
+    checkpoint: "checkpoint";
+    seek: "seek";
+}>;
+type VideoProgressTriggerReason = z.infer<typeof videoProgressTriggerReasonSchema>;
+declare const videoRangeSchema: z.ZodMiniObject<{
+    start_s: z.ZodMiniNumber<number>;
+    end_s: z.ZodMiniNumber<number>;
+}, z.core.$strict>;
+type VideoWatchRange = z.infer<typeof videoRangeSchema>;
+/** Metadata for `video_play` emitted when playback starts or resumes on `<TrackedVideo>`. */
+declare const videoPlayMetadataSchema: z.ZodMiniObject<{
+    video_id: z.ZodMiniString<string>;
+    variant: z.ZodMiniEnum<{
+        "16x9": "16x9";
+        "9x16": "9x16";
+    }>;
+    current_s: z.ZodMiniNumber<number>;
+    duration_s: z.ZodMiniNumber<number>;
+    play_sequence: z.ZodMiniInt;
+    page: z.ZodMiniObject<{
+        path: z.ZodMiniString<string>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+type VideoPlayMetadata = z.infer<typeof videoPlayMetadataSchema>;
+declare const videoPlayConfigSchema: z.ZodMiniObject<{}, z.core.$strict>;
+type VideoPlayConfig = z.infer<typeof videoPlayConfigSchema>;
+/**
+ * Metadata for `video_progress` emitted at checkpoints, goal thresholds, pause, seek, ended, and page_exit.
+ * `ranges` carries cumulative merged `[start_s, end_s]` intervals watched in the session so far.
+ */
+declare const videoProgressMetadataSchema: z.ZodMiniObject<{
+    video_id: z.ZodMiniString<string>;
+    variant: z.ZodMiniEnum<{
+        "16x9": "16x9";
+        "9x16": "9x16";
+    }>;
+    trigger: z.ZodMiniEnum<{
+        goal: "goal";
+        ended: "ended";
+        pause: "pause";
+        page_exit: "page_exit";
+        checkpoint: "checkpoint";
+        seek: "seek";
+    }>;
+    current_s: z.ZodMiniNumber<number>;
+    furthest_s: z.ZodMiniNumber<number>;
+    watched_s: z.ZodMiniNumber<number>;
+    duration_s: z.ZodMiniNumber<number>;
+    max_percent: z.ZodMiniInt;
+    watched_percent: z.ZodMiniInt;
+    play_count: z.ZodMiniInt;
+    seek_count: z.ZodMiniInt;
+    ranges: z.ZodMiniArray<z.ZodMiniObject<{
+        start_s: z.ZodMiniNumber<number>;
+        end_s: z.ZodMiniNumber<number>;
+    }, z.core.$strict>>;
+    page: z.ZodMiniObject<{
+        path: z.ZodMiniString<string>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+type VideoProgressMetadata = z.infer<typeof videoProgressMetadataSchema>;
+declare const videoProgressConfigSchema: z.ZodMiniObject<{}, z.core.$strict>;
+type VideoProgressConfig = z.infer<typeof videoProgressConfigSchema>;
+
 type EventOutcomeRole = "lead" | "engagement" | "navigation" | "diagnostic";
 type EventCategory = "page" | "engagement" | "lead" | "commerce" | "system";
 type EventClientVisibility = "simple" | "detailed" | "hidden";
@@ -414,6 +530,12 @@ declare const EVENT_SEMANTICS: {
         readonly outcomeRole: "engagement";
         readonly clientVisibility: "detailed";
     };
+    readonly form_details: {
+        readonly label: "Form details added";
+        readonly category: "lead";
+        readonly outcomeRole: "engagement";
+        readonly clientVisibility: "detailed";
+    };
     readonly form_submit: {
         readonly label: "Form submitted";
         readonly category: "lead";
@@ -444,6 +566,18 @@ declare const EVENT_SEMANTICS: {
         readonly outcomeRole: "navigation";
         readonly clientVisibility: "simple";
     };
+    readonly video_play: {
+        readonly label: "Video played";
+        readonly category: "engagement";
+        readonly outcomeRole: "engagement";
+        readonly clientVisibility: "simple";
+    };
+    readonly video_progress: {
+        readonly label: "Video watched";
+        readonly category: "engagement";
+        readonly outcomeRole: "engagement";
+        readonly clientVisibility: "detailed";
+    };
 };
 type EventName = keyof typeof EVENT_SEMANTICS;
 declare function getEventSemantics(eventName: string): EventSemantics | null;
@@ -655,6 +789,69 @@ declare const EVENT_REGISTRY: {
         }, zod_v4_core.$strict>;
         readonly configSchema: z.ZodMiniObject<{}, zod_v4_core.$strict>;
     };
+    readonly video_play: {
+        readonly kind: "automatic";
+        readonly semantics: {
+            readonly label: "Video played";
+            readonly category: "engagement";
+            readonly outcomeRole: "engagement";
+            readonly clientVisibility: "simple";
+        };
+        readonly metadataSchema: z.ZodMiniObject<{
+            video_id: z.ZodMiniString<string>;
+            variant: z.ZodMiniEnum<{
+                "16x9": "16x9";
+                "9x16": "9x16";
+            }>;
+            current_s: z.ZodMiniNumber<number>;
+            duration_s: z.ZodMiniNumber<number>;
+            play_sequence: z.ZodMiniInt;
+            page: z.ZodMiniObject<{
+                path: z.ZodMiniString<string>;
+            }, zod_v4_core.$strict>;
+        }, zod_v4_core.$strict>;
+        readonly configSchema: z.ZodMiniObject<{}, zod_v4_core.$strict>;
+    };
+    readonly video_progress: {
+        readonly kind: "automatic";
+        readonly semantics: {
+            readonly label: "Video watched";
+            readonly category: "engagement";
+            readonly outcomeRole: "engagement";
+            readonly clientVisibility: "detailed";
+        };
+        readonly metadataSchema: z.ZodMiniObject<{
+            video_id: z.ZodMiniString<string>;
+            variant: z.ZodMiniEnum<{
+                "16x9": "16x9";
+                "9x16": "9x16";
+            }>;
+            trigger: z.ZodMiniEnum<{
+                goal: "goal";
+                ended: "ended";
+                pause: "pause";
+                page_exit: "page_exit";
+                checkpoint: "checkpoint";
+                seek: "seek";
+            }>;
+            current_s: z.ZodMiniNumber<number>;
+            furthest_s: z.ZodMiniNumber<number>;
+            watched_s: z.ZodMiniNumber<number>;
+            duration_s: z.ZodMiniNumber<number>;
+            max_percent: z.ZodMiniInt;
+            watched_percent: z.ZodMiniInt;
+            play_count: z.ZodMiniInt;
+            seek_count: z.ZodMiniInt;
+            ranges: z.ZodMiniArray<z.ZodMiniObject<{
+                start_s: z.ZodMiniNumber<number>;
+                end_s: z.ZodMiniNumber<number>;
+            }, zod_v4_core.$strict>>;
+            page: z.ZodMiniObject<{
+                path: z.ZodMiniString<string>;
+            }, zod_v4_core.$strict>;
+        }, zod_v4_core.$strict>;
+        readonly configSchema: z.ZodMiniObject<{}, zod_v4_core.$strict>;
+    };
     readonly form_submit: {
         readonly kind: "manual";
         readonly semantics: {
@@ -686,6 +883,7 @@ declare const EVENT_REGISTRY: {
                     role: z.ZodMiniNullable<z.ZodMiniString<string>>;
                     rule: z.ZodMiniString<string>;
                 }, zod_v4_core.$strict>>>>;
+                submission_id: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniUUID>>;
             }, zod_v4_core.$strict>;
             page: z.ZodMiniObject<{
                 path: z.ZodMiniString<string>;
@@ -721,6 +919,44 @@ declare const EVENT_REGISTRY: {
         }, zod_v4_core.$strict>;
         readonly configSchema: z.ZodMiniObject<{}, zod_v4_core.$strict>;
     };
+    readonly form_details: {
+        readonly kind: "manual";
+        readonly semantics: {
+            readonly label: "Form details added";
+            readonly category: "lead";
+            readonly outcomeRole: "engagement";
+            readonly clientVisibility: "detailed";
+        };
+        readonly metadataSchema: z.ZodMiniObject<{
+            form: z.ZodMiniObject<{
+                id: z.ZodMiniString<string>;
+                submission_id: z.ZodMiniUUID;
+                kind: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+                fields: z.ZodMiniArray<z.ZodMiniObject<{
+                    name: z.ZodMiniString<string>;
+                    type: z.ZodMiniString<string>;
+                    label: z.ZodMiniNullable<z.ZodMiniString<string>>;
+                    value: z.ZodMiniType<JsonValue, unknown, zod_v4_core.$ZodTypeInternals<JsonValue, unknown>>;
+                    role: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+                }, zod_v4_core.$strict>>;
+                contract_version: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniInt>>;
+                contract_hash: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+                extra: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniObject<{
+                    key: z.ZodMiniString<string>;
+                    label: z.ZodMiniString<string>;
+                    value: z.ZodMiniType<JsonValue, unknown, zod_v4_core.$ZodTypeInternals<JsonValue, unknown>>;
+                }, zod_v4_core.$strict>>>>;
+                contract_violations: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniObject<{
+                    role: z.ZodMiniNullable<z.ZodMiniString<string>>;
+                    rule: z.ZodMiniString<string>;
+                }, zod_v4_core.$strict>>>>;
+            }, zod_v4_core.$strict>;
+            page: z.ZodMiniObject<{
+                path: z.ZodMiniString<string>;
+            }, zod_v4_core.$strict>;
+        }, zod_v4_core.$strict>;
+        readonly configSchema: z.ZodMiniObject<{}, zod_v4_core.$strict>;
+    };
     readonly phone_click: {
         readonly kind: "manual";
         readonly semantics: {
@@ -792,8 +1028,11 @@ type MetadataByName = {
     page_exit: PageExitMetadata;
     site_link_click: SiteLinkClickMetadata;
     site_link_arrival: SiteLinkArrivalMetadata;
+    video_play: VideoPlayMetadata;
+    video_progress: VideoProgressMetadata;
     form_submit: FormSubmitMetadata;
     form_step: FormStepMetadata;
+    form_details: FormDetailsMetadata;
     phone_click: PhoneClickMetadata;
     cta_click: CtaClickMetadata;
 };
@@ -808,8 +1047,11 @@ type ConfigByName = {
     page_exit: PageExitConfig;
     site_link_click: SiteLinkClickConfig;
     site_link_arrival: SiteLinkArrivalConfig;
+    video_play: VideoPlayConfig;
+    video_progress: VideoProgressConfig;
     form_submit: FormSubmitConfig;
     form_step: FormStepConfig;
+    form_details: FormDetailsConfig;
     phone_click: PhoneClickConfig;
     cta_click: CtaClickConfig;
 };
@@ -864,6 +1106,7 @@ type TriggerRegistryConfig = {
     manual?: Partial<{
         form_submit: EventConfig<"form_submit">;
         form_step: EventConfig<"form_step">;
+        form_details: EventConfig<"form_details">;
         phone_click: EventConfig<"phone_click">;
         cta_click: EventConfig<"cta_click">;
     }>;
@@ -889,6 +1132,51 @@ type TrackableEvent<TRegistry extends TriggerRegistryConfig> = {
     };
 }[RegisteredManualEvents<TRegistry>];
 
+/**
+ * Input accepted by the low-level stringly-typed client.
+ *
+ * Prefer the typed `trackEvent(eventName, metadata)` facade exposed by
+ * `useTracking()` in React/Next integrations.
+ */
+interface TrackEventInput {
+    /** Event name to enqueue. */
+    eventType: string;
+    /** URL associated with the event. Defaults to the current page URL. */
+    pageUrl?: string | null;
+    /** Event-specific metadata. */
+    metadata?: Record<string, unknown> | null;
+    /** Timestamp override. Defaults to queue time. */
+    occurredAt?: Date | string | null;
+}
+/**
+ * Low-level tracking client responsible for queueing and flushing events.
+ */
+interface TrackingClient {
+    /** Enqueue an event for batched delivery. */
+    trackEvent: (input: TrackEventInput) => void;
+    /** Flush queued events immediately (fetch, non-keepalive). */
+    flush: () => Promise<void>;
+    /**
+     * Flush queued events through the keepalive transport so the request
+     * survives document unload. Use from `pagehide`/`visibilitychange:hidden`
+     * handlers — a plain `flush()` there is aborted by the browser on unload.
+     */
+    flushBeacon: () => void;
+    /**
+     * Register a synchronous pre-unload hook invoked right before `flushBeacon`
+     * snapshots the queue into a keepalive batch. Used by `page_exit` and
+     * `<TrackedVideo>` so their final segment/progress events ride in the same
+     * keepalive request as any queued events.
+     */
+    onBeforeUnload?: (listener: () => void) => () => void;
+    /** Return the current rolling session id. */
+    getSessionId: () => string;
+    /** Return the persistent visitor id. */
+    getVisitorId: () => string;
+    /** Remove timers/listeners and prevent future flushes. */
+    destroy: () => void;
+}
+
 interface TypedTrackEventOptions {
     /**
      * Override the page URL associated with this event.
@@ -933,4 +1221,4 @@ interface TypedTrackingClient<TRegistry extends TriggerRegistryConfig> {
     getVisitorId(): string;
 }
 
-export { type AutomaticEventName as A, type SiteLinkClickConfig as B, type CtaClickConfig as C, type SiteLinkClickMetadata as D, EVENT_SEMANTICS as E, type FormStartConfig as F, type SpecificPageName as G, type SpecificPageVisitConfig as H, type SpecificPageVisitMetadata as I, type TimeOnSiteMetadata as J, type TrackableEvent as K, type TriggerRegistryConfig as L, type ManualEventName as M, type TypedTrackEventOptions as N, type TypedTrackingClient as O, type PageExitConfig as P, getEventSemantics as Q, type RegisteredAutomaticEvents as R, type ScrollDepthConfig as S, type TimeOnSiteConfig as T, type CtaClickMetadata as a, type EventCategory as b, type EventClientVisibility as c, type EventConfig as d, type EventKind as e, type EventMetadata as f, type EventName as g, type EventOutcomeRole as h, type EventSemantics as i, type FormStartMetadata as j, type FormStepConfig as k, type FormStepMetadata as l, type MultiPageSessionConfig as m, type MultiPageSessionMetadata as n, type PageExitMetadata as o, type PageIdentity as p, type PageViewConfig as q, type PageViewMetadata as r, type PhoneClickConfig as s, type PhoneClickMetadata as t, type RegisteredManualEvents as u, type ScrollDepthMetadata as v, type SdkHeartbeatConfig as w, type SdkHeartbeatMetadata as x, type SiteLinkArrivalConfig as y, type SiteLinkArrivalMetadata as z };
+export { type VideoVariant as $, type AutomaticEventName as A, type SiteLinkArrivalConfig as B, type CtaClickConfig as C, type SiteLinkArrivalMetadata as D, EVENT_SEMANTICS as E, type FormDetailsConfig as F, type SiteLinkClickConfig as G, type SiteLinkClickMetadata as H, type SpecificPageName as I, type SpecificPageVisitConfig as J, type SpecificPageVisitMetadata as K, type TimeOnSiteMetadata as L, type ManualEventName as M, type TrackableEvent as N, type TrackingClient as O, type PageExitConfig as P, type TriggerRegistryConfig as Q, type RegisteredAutomaticEvents as R, type ScrollDepthConfig as S, type TimeOnSiteConfig as T, type TypedTrackEventOptions as U, type TypedTrackingClient as V, type VideoPlayConfig as W, type VideoPlayMetadata as X, type VideoProgressConfig as Y, type VideoProgressMetadata as Z, type VideoProgressTriggerReason as _, type CtaClickMetadata as a, type VideoWatchRange as a0, getEventSemantics as a1, type EventCategory as b, type EventClientVisibility as c, type EventConfig as d, type EventKind as e, type EventMetadata as f, type EventName as g, type EventOutcomeRole as h, type EventSemantics as i, type FormDetailsMetadata as j, type FormStartConfig as k, type FormStartMetadata as l, type FormStepConfig as m, type FormStepMetadata as n, type MultiPageSessionConfig as o, type MultiPageSessionMetadata as p, type PageExitMetadata as q, type PageIdentity as r, type PageViewConfig as s, type PageViewMetadata as t, type PhoneClickConfig as u, type PhoneClickMetadata as v, type RegisteredManualEvents as w, type ScrollDepthMetadata as x, type SdkHeartbeatConfig as y, type SdkHeartbeatMetadata as z };