@aranova/tracking-react 1.2.2 → 1.2.3

package/dist/{ingest-typed-UA13xTfI.d.mts → ingest-typed-CCjpmxzo.d.mts}

@@ -77,7 +77,8 @@ type SdkHeartbeatConfig = z.infer<typeof sdkHeartbeatConfigSchema>;
 /**
  * Metadata for the automatic `form_start` event.
  *
- * The SDK emits this once per form when the visitor first focuses a field.
+ * The SDK emits this once per form when the visitor first focuses or taps
+ * anything inside it.
  */
 declare const formStartMetadataSchema: z.ZodMiniObject<{
     form: z.ZodMiniObject<{
@@ -100,6 +101,40 @@ declare const formStartConfigSchema: z.ZodMiniObject<{
 }, z.core.$strict>;
 type FormStartConfig = z.infer<typeof formStartConfigSchema>;
 
+/**
+ * Metadata for a manually fired `form_step` event.
+ *
+ * `form.id` must equal `form_start`/`form_submit`'s id. See
+ * docs/tracking-package/installing.md#multi-step-forms-form_step for the emit rule and an example.
+ */
+declare const formStepMetadataSchema: z.ZodMiniObject<{
+    form: z.ZodMiniObject<{
+        id: z.ZodMiniString<string>;
+        action: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    }, z.core.$strict>;
+    step: z.ZodMiniObject<{
+        id: z.ZodMiniString<string>;
+        index: z.ZodMiniInt;
+        total: z.ZodMiniNullable<z.ZodMiniInt>;
+    }, z.core.$strict>;
+    direction: z.ZodMiniEnum<{
+        forward: "forward";
+        back: "back";
+    }>;
+    page: z.ZodMiniObject<{
+        path: z.ZodMiniString<string>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+type FormStepMetadata = z.infer<typeof formStepMetadataSchema>;
+/**
+ * Registration config for `form_step`.
+ *
+ * Manual-only with no options; the empty object enables typed
+ * `trackEvent('form_step', ...)` calls.
+ */
+declare const formStepConfigSchema: z.ZodMiniObject<{}, z.core.$strict>;
+type FormStepConfig = z.infer<typeof formStepConfigSchema>;
+
 /**
  * Metadata for the automatic `multi_page_session` event.
  *
@@ -388,6 +423,12 @@ declare const EVENT_SEMANTICS: {
         readonly outcomeRole: "diagnostic";
         readonly clientVisibility: "detailed";
     };
+    readonly form_step: {
+        readonly label: "Form step";
+        readonly category: "engagement";
+        readonly outcomeRole: "engagement";
+        readonly clientVisibility: "detailed";
+    };
     readonly form_submit: {
         readonly label: "Form submitted";
         readonly category: "lead";
@@ -653,6 +694,34 @@ declare const EVENT_REGISTRY: {
         }, zod_v4_core.$strict>;
         readonly configSchema: z.ZodMiniObject<{}, zod_v4_core.$strict>;
     };
+    readonly form_step: {
+        readonly kind: "manual";
+        readonly semantics: {
+            readonly label: "Form step";
+            readonly category: "engagement";
+            readonly outcomeRole: "engagement";
+            readonly clientVisibility: "detailed";
+        };
+        readonly metadataSchema: z.ZodMiniObject<{
+            form: z.ZodMiniObject<{
+                id: z.ZodMiniString<string>;
+                action: z.ZodMiniNullable<z.ZodMiniString<string>>;
+            }, zod_v4_core.$strict>;
+            step: z.ZodMiniObject<{
+                id: z.ZodMiniString<string>;
+                index: z.ZodMiniInt;
+                total: z.ZodMiniNullable<z.ZodMiniInt>;
+            }, zod_v4_core.$strict>;
+            direction: z.ZodMiniEnum<{
+                forward: "forward";
+                back: "back";
+            }>;
+            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: {
@@ -725,6 +794,7 @@ type MetadataByName = {
     site_link_click: SiteLinkClickMetadata;
     site_link_arrival: SiteLinkArrivalMetadata;
     form_submit: FormSubmitMetadata;
+    form_step: FormStepMetadata;
     phone_click: PhoneClickMetadata;
     cta_click: CtaClickMetadata;
 };
@@ -740,6 +810,7 @@ type ConfigByName = {
     site_link_click: SiteLinkClickConfig;
     site_link_arrival: SiteLinkArrivalConfig;
     form_submit: FormSubmitConfig;
+    form_step: FormStepConfig;
     phone_click: PhoneClickConfig;
     cta_click: CtaClickConfig;
 };
@@ -805,6 +876,7 @@ type TriggerRegistryConfig = {
     }>;
     manual?: Partial<{
         form_submit: EventConfig<"form_submit">;
+        form_step: EventConfig<"form_step">;
         phone_click: EventConfig<"phone_click">;
         cta_click: EventConfig<"cta_click">;
     }>;
@@ -880,4 +952,4 @@ interface TypedTrackingClient<TRegistry extends TriggerRegistryConfig> {
     getVisitorId(): string;
 }
 
-export { formStartMetadataSchema as $, ALL_AUTOMATIC_EVENT_NAMES as A, type ScrollDepthMetadata as B, type CtaClickConfig as C, type SdkHeartbeatConfig as D, EVENT_REGISTRY as E, type FormStartConfig as F, type SdkHeartbeatMetadata as G, type SiteLinkArrivalConfig as H, type SiteLinkArrivalMetadata as I, type SiteLinkClickConfig as J, type SiteLinkClickMetadata as K, type SpecificPageName as L, type ManualEventName as M, type SpecificPageVisitConfig as N, type SpecificPageVisitMetadata as O, PAGE_IDENTITY_MAX_LENGTH as P, type TimeOnSiteMetadata as Q, type RegisteredAutomaticEvents as R, SPECIFIC_PAGE_NAMES as S, type TimeOnSiteConfig as T, type TrackableEvent as U, type TriggerRegistryConfig as V, type TypedTrackEventOptions as W, type TypedTrackingClient as X, ctaClickConfigSchema as Y, ctaClickMetadataSchema as Z, formStartConfigSchema as _, ALL_LEAD_EVENT_NAMES as a, getEventDefinition as a0, getEventSemantics as a1, multiPageSessionConfigSchema as a2, multiPageSessionMetadataSchema as a3, pageExitConfigSchema as a4, pageExitMetadataSchema as a5, pageIdentitySchema as a6, pageViewConfigSchema as a7, pageViewMetadataSchema as a8, phoneClickConfigSchema as a9, phoneClickMetadataSchema as aa, scrollDepthConfigSchema as ab, scrollDepthMetadataSchema as ac, sdkHeartbeatConfigSchema as ad, sdkHeartbeatMetadataSchema as ae, sdkHeartbeatTriggersSchema as af, siteLinkArrivalConfigSchema as ag, siteLinkArrivalMetadataSchema as ah, siteLinkClickConfigSchema as ai, siteLinkClickMetadataSchema as aj, specificPageNameSchema as ak, specificPageVisitConfigSchema as al, specificPageVisitMetadataSchema as am, timeOnSiteConfigSchema as an, timeOnSiteMetadataSchema as ao, ALL_MANUAL_EVENT_NAMES as b, type AutomaticEventName as c, type CtaClickMetadata as d, EVENT_SEMANTICS as e, type EventCategory as f, type EventClientVisibility as g, type EventConfig as h, type EventKind as i, type EventMetadata as j, type EventName as k, type EventOutcomeRole as l, type EventSemantics as m, type FormStartMetadata as n, type MultiPageSessionConfig as o, type MultiPageSessionMetadata as p, PAGE_IDENTITY_PATTERN as q, type PageExitConfig as r, type PageExitMetadata as s, type PageIdentity as t, type PageViewConfig as u, type PageViewMetadata as v, type PhoneClickConfig as w, type PhoneClickMetadata as x, type RegisteredManualEvents as y, type ScrollDepthConfig as z };
+export { ctaClickMetadataSchema as $, ALL_AUTOMATIC_EVENT_NAMES as A, type RegisteredManualEvents as B, type CtaClickConfig as C, type ScrollDepthConfig as D, EVENT_REGISTRY as E, type FormStartConfig as F, type ScrollDepthMetadata as G, type SdkHeartbeatConfig as H, type SdkHeartbeatMetadata as I, type SiteLinkArrivalConfig as J, type SiteLinkArrivalMetadata as K, type SiteLinkClickConfig as L, type ManualEventName as M, type SiteLinkClickMetadata as N, type SpecificPageName as O, PAGE_IDENTITY_MAX_LENGTH as P, type SpecificPageVisitConfig as Q, type RegisteredAutomaticEvents as R, SPECIFIC_PAGE_NAMES as S, type SpecificPageVisitMetadata as T, type TimeOnSiteConfig as U, type TimeOnSiteMetadata as V, type TrackableEvent as W, type TriggerRegistryConfig as X, type TypedTrackEventOptions as Y, type TypedTrackingClient as Z, ctaClickConfigSchema as _, ALL_LEAD_EVENT_NAMES as a, formStartConfigSchema as a0, formStartMetadataSchema as a1, formStepConfigSchema as a2, formStepMetadataSchema as a3, getEventDefinition as a4, getEventSemantics as a5, multiPageSessionConfigSchema as a6, multiPageSessionMetadataSchema as a7, pageExitConfigSchema as a8, pageExitMetadataSchema as a9, pageIdentitySchema as aa, pageViewConfigSchema as ab, pageViewMetadataSchema as ac, phoneClickConfigSchema as ad, phoneClickMetadataSchema as ae, scrollDepthConfigSchema as af, scrollDepthMetadataSchema as ag, sdkHeartbeatConfigSchema as ah, sdkHeartbeatMetadataSchema as ai, sdkHeartbeatTriggersSchema as aj, siteLinkArrivalConfigSchema as ak, siteLinkArrivalMetadataSchema as al, siteLinkClickConfigSchema as am, siteLinkClickMetadataSchema as an, specificPageNameSchema as ao, specificPageVisitConfigSchema as ap, specificPageVisitMetadataSchema as aq, timeOnSiteConfigSchema as ar, timeOnSiteMetadataSchema as as, ALL_MANUAL_EVENT_NAMES as b, type AutomaticEventName as c, type CtaClickMetadata as d, EVENT_SEMANTICS as e, type EventCategory as f, type EventClientVisibility as g, type EventConfig as h, type EventKind as i, type EventMetadata as j, type EventName as k, type EventOutcomeRole as l, type EventSemantics as m, type FormStartMetadata as n, type FormStepConfig as o, type FormStepMetadata as p, type MultiPageSessionConfig as q, type MultiPageSessionMetadata as r, PAGE_IDENTITY_PATTERN as s, type PageExitConfig as t, type PageExitMetadata as u, type PageIdentity as v, type PageViewConfig as w, type PageViewMetadata as x, type PhoneClickConfig as y, type PhoneClickMetadata as z };

package/dist/{ingest-typed-MBuMe9Pn.d.ts → ingest-typed-DRuUbg-r.d.ts}

@@ -77,7 +77,8 @@ type SdkHeartbeatConfig = z.infer<typeof sdkHeartbeatConfigSchema>;
 /**
  * Metadata for the automatic `form_start` event.
  *
- * The SDK emits this once per form when the visitor first focuses a field.
+ * The SDK emits this once per form when the visitor first focuses or taps
+ * anything inside it.
  */
 declare const formStartMetadataSchema: z.ZodMiniObject<{
     form: z.ZodMiniObject<{
@@ -100,6 +101,40 @@ declare const formStartConfigSchema: z.ZodMiniObject<{
 }, z.core.$strict>;
 type FormStartConfig = z.infer<typeof formStartConfigSchema>;
 
+/**
+ * Metadata for a manually fired `form_step` event.
+ *
+ * `form.id` must equal `form_start`/`form_submit`'s id. See
+ * docs/tracking-package/installing.md#multi-step-forms-form_step for the emit rule and an example.
+ */
+declare const formStepMetadataSchema: z.ZodMiniObject<{
+    form: z.ZodMiniObject<{
+        id: z.ZodMiniString<string>;
+        action: z.ZodMiniNullable<z.ZodMiniString<string>>;
+    }, z.core.$strict>;
+    step: z.ZodMiniObject<{
+        id: z.ZodMiniString<string>;
+        index: z.ZodMiniInt;
+        total: z.ZodMiniNullable<z.ZodMiniInt>;
+    }, z.core.$strict>;
+    direction: z.ZodMiniEnum<{
+        forward: "forward";
+        back: "back";
+    }>;
+    page: z.ZodMiniObject<{
+        path: z.ZodMiniString<string>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+type FormStepMetadata = z.infer<typeof formStepMetadataSchema>;
+/**
+ * Registration config for `form_step`.
+ *
+ * Manual-only with no options; the empty object enables typed
+ * `trackEvent('form_step', ...)` calls.
+ */
+declare const formStepConfigSchema: z.ZodMiniObject<{}, z.core.$strict>;
+type FormStepConfig = z.infer<typeof formStepConfigSchema>;
+
 /**
  * Metadata for the automatic `multi_page_session` event.
  *
@@ -388,6 +423,12 @@ declare const EVENT_SEMANTICS: {
         readonly outcomeRole: "diagnostic";
         readonly clientVisibility: "detailed";
     };
+    readonly form_step: {
+        readonly label: "Form step";
+        readonly category: "engagement";
+        readonly outcomeRole: "engagement";
+        readonly clientVisibility: "detailed";
+    };
     readonly form_submit: {
         readonly label: "Form submitted";
         readonly category: "lead";
@@ -653,6 +694,34 @@ declare const EVENT_REGISTRY: {
         }, zod_v4_core.$strict>;
         readonly configSchema: z.ZodMiniObject<{}, zod_v4_core.$strict>;
     };
+    readonly form_step: {
+        readonly kind: "manual";
+        readonly semantics: {
+            readonly label: "Form step";
+            readonly category: "engagement";
+            readonly outcomeRole: "engagement";
+            readonly clientVisibility: "detailed";
+        };
+        readonly metadataSchema: z.ZodMiniObject<{
+            form: z.ZodMiniObject<{
+                id: z.ZodMiniString<string>;
+                action: z.ZodMiniNullable<z.ZodMiniString<string>>;
+            }, zod_v4_core.$strict>;
+            step: z.ZodMiniObject<{
+                id: z.ZodMiniString<string>;
+                index: z.ZodMiniInt;
+                total: z.ZodMiniNullable<z.ZodMiniInt>;
+            }, zod_v4_core.$strict>;
+            direction: z.ZodMiniEnum<{
+                forward: "forward";
+                back: "back";
+            }>;
+            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: {
@@ -725,6 +794,7 @@ type MetadataByName = {
     site_link_click: SiteLinkClickMetadata;
     site_link_arrival: SiteLinkArrivalMetadata;
     form_submit: FormSubmitMetadata;
+    form_step: FormStepMetadata;
     phone_click: PhoneClickMetadata;
     cta_click: CtaClickMetadata;
 };
@@ -740,6 +810,7 @@ type ConfigByName = {
     site_link_click: SiteLinkClickConfig;
     site_link_arrival: SiteLinkArrivalConfig;
     form_submit: FormSubmitConfig;
+    form_step: FormStepConfig;
     phone_click: PhoneClickConfig;
     cta_click: CtaClickConfig;
 };
@@ -805,6 +876,7 @@ type TriggerRegistryConfig = {
     }>;
     manual?: Partial<{
         form_submit: EventConfig<"form_submit">;
+        form_step: EventConfig<"form_step">;
         phone_click: EventConfig<"phone_click">;
         cta_click: EventConfig<"cta_click">;
     }>;
@@ -880,4 +952,4 @@ interface TypedTrackingClient<TRegistry extends TriggerRegistryConfig> {
     getVisitorId(): string;
 }
 
-export { formStartMetadataSchema as $, ALL_AUTOMATIC_EVENT_NAMES as A, type ScrollDepthMetadata as B, type CtaClickConfig as C, type SdkHeartbeatConfig as D, EVENT_REGISTRY as E, type FormStartConfig as F, type SdkHeartbeatMetadata as G, type SiteLinkArrivalConfig as H, type SiteLinkArrivalMetadata as I, type SiteLinkClickConfig as J, type SiteLinkClickMetadata as K, type SpecificPageName as L, type ManualEventName as M, type SpecificPageVisitConfig as N, type SpecificPageVisitMetadata as O, PAGE_IDENTITY_MAX_LENGTH as P, type TimeOnSiteMetadata as Q, type RegisteredAutomaticEvents as R, SPECIFIC_PAGE_NAMES as S, type TimeOnSiteConfig as T, type TrackableEvent as U, type TriggerRegistryConfig as V, type TypedTrackEventOptions as W, type TypedTrackingClient as X, ctaClickConfigSchema as Y, ctaClickMetadataSchema as Z, formStartConfigSchema as _, ALL_LEAD_EVENT_NAMES as a, getEventDefinition as a0, getEventSemantics as a1, multiPageSessionConfigSchema as a2, multiPageSessionMetadataSchema as a3, pageExitConfigSchema as a4, pageExitMetadataSchema as a5, pageIdentitySchema as a6, pageViewConfigSchema as a7, pageViewMetadataSchema as a8, phoneClickConfigSchema as a9, phoneClickMetadataSchema as aa, scrollDepthConfigSchema as ab, scrollDepthMetadataSchema as ac, sdkHeartbeatConfigSchema as ad, sdkHeartbeatMetadataSchema as ae, sdkHeartbeatTriggersSchema as af, siteLinkArrivalConfigSchema as ag, siteLinkArrivalMetadataSchema as ah, siteLinkClickConfigSchema as ai, siteLinkClickMetadataSchema as aj, specificPageNameSchema as ak, specificPageVisitConfigSchema as al, specificPageVisitMetadataSchema as am, timeOnSiteConfigSchema as an, timeOnSiteMetadataSchema as ao, ALL_MANUAL_EVENT_NAMES as b, type AutomaticEventName as c, type CtaClickMetadata as d, EVENT_SEMANTICS as e, type EventCategory as f, type EventClientVisibility as g, type EventConfig as h, type EventKind as i, type EventMetadata as j, type EventName as k, type EventOutcomeRole as l, type EventSemantics as m, type FormStartMetadata as n, type MultiPageSessionConfig as o, type MultiPageSessionMetadata as p, PAGE_IDENTITY_PATTERN as q, type PageExitConfig as r, type PageExitMetadata as s, type PageIdentity as t, type PageViewConfig as u, type PageViewMetadata as v, type PhoneClickConfig as w, type PhoneClickMetadata as x, type RegisteredManualEvents as y, type ScrollDepthConfig as z };
+export { ctaClickMetadataSchema as $, ALL_AUTOMATIC_EVENT_NAMES as A, type RegisteredManualEvents as B, type CtaClickConfig as C, type ScrollDepthConfig as D, EVENT_REGISTRY as E, type FormStartConfig as F, type ScrollDepthMetadata as G, type SdkHeartbeatConfig as H, type SdkHeartbeatMetadata as I, type SiteLinkArrivalConfig as J, type SiteLinkArrivalMetadata as K, type SiteLinkClickConfig as L, type ManualEventName as M, type SiteLinkClickMetadata as N, type SpecificPageName as O, PAGE_IDENTITY_MAX_LENGTH as P, type SpecificPageVisitConfig as Q, type RegisteredAutomaticEvents as R, SPECIFIC_PAGE_NAMES as S, type SpecificPageVisitMetadata as T, type TimeOnSiteConfig as U, type TimeOnSiteMetadata as V, type TrackableEvent as W, type TriggerRegistryConfig as X, type TypedTrackEventOptions as Y, type TypedTrackingClient as Z, ctaClickConfigSchema as _, ALL_LEAD_EVENT_NAMES as a, formStartConfigSchema as a0, formStartMetadataSchema as a1, formStepConfigSchema as a2, formStepMetadataSchema as a3, getEventDefinition as a4, getEventSemantics as a5, multiPageSessionConfigSchema as a6, multiPageSessionMetadataSchema as a7, pageExitConfigSchema as a8, pageExitMetadataSchema as a9, pageIdentitySchema as aa, pageViewConfigSchema as ab, pageViewMetadataSchema as ac, phoneClickConfigSchema as ad, phoneClickMetadataSchema as ae, scrollDepthConfigSchema as af, scrollDepthMetadataSchema as ag, sdkHeartbeatConfigSchema as ah, sdkHeartbeatMetadataSchema as ai, sdkHeartbeatTriggersSchema as aj, siteLinkArrivalConfigSchema as ak, siteLinkArrivalMetadataSchema as al, siteLinkClickConfigSchema as am, siteLinkClickMetadataSchema as an, specificPageNameSchema as ao, specificPageVisitConfigSchema as ap, specificPageVisitMetadataSchema as aq, timeOnSiteConfigSchema as ar, timeOnSiteMetadataSchema as as, ALL_MANUAL_EVENT_NAMES as b, type AutomaticEventName as c, type CtaClickMetadata as d, EVENT_SEMANTICS as e, type EventCategory as f, type EventClientVisibility as g, type EventConfig as h, type EventKind as i, type EventMetadata as j, type EventName as k, type EventOutcomeRole as l, type EventSemantics as m, type FormStartMetadata as n, type FormStepConfig as o, type FormStepMetadata as p, type MultiPageSessionConfig as q, type MultiPageSessionMetadata as r, PAGE_IDENTITY_PATTERN as s, type PageExitConfig as t, type PageExitMetadata as u, type PageIdentity as v, type PageViewConfig as w, type PageViewMetadata as x, type PhoneClickConfig as y, type PhoneClickMetadata as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aranova/tracking-react",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "private": false,
   "type": "commonjs",
   "description": "React tracking and consent utilities for Aranova client sites",