@aranova/tracking-react 1.17.0 → 1.18.0

package/README.md

@@ -221,6 +221,22 @@ Development logs each contract violation, `debug` throws, production sends anywa
 (tagged `invalid_shape`) rather than dropped. Full guide:
 [docs/tracking-package/lead-forms.md](../../docs/tracking-package/lead-forms.md).
 
+Optional questions after the submit (patient type, timing, how they heard) attach to that same
+lead. Keep the handle `submit()` returns and pass it to `addDetails()` from the thank-you screen.
+That screen is a `<section>` with buttons, never a second `<form>`: a form logs its own
+`form_start` (a form never submitted, in the funnel) and submits on Enter.
+
+```tsx
+const { submission } = leadForms.submit({ formId: "booking-form", kind: "booking", fields });
+setSubmission(submission); // then render the post-submit <section>
+
+// "Add to my request" button's onClick: every role is optional here, nothing is owed.
+leadForms.addDetails(submission, {
+  fields: { patient_type: answers.patientType, note: answers.note, email: answers.email },
+  extra: [{ key: "heard_from", label: "How did you hear about us?", value: answers.heardFrom }],
+}); // { sent: false, reason: "no_fields" } when every answer is blank
+```
+
 ## Phone Fields
 
 Bundled `libphonenumber-js`: parse/format utils + a React input. Display is configurable; the

package/dist/{bookings-2ZKfenQ7.d.ts → bookings-CCGpXhYE.d.ts}

@@ -1,4 +1,4 @@
-import { p as LeadFormKind, r as LeadFormRole, o as LEAD_FORM_ROLE_SPECS, n as LEAD_FORM_ROLES, J as JsonValue, b as TrackingEnvironment, k as FormSubmitMetadata } from './phone-utils-CYr6AmEP.js';
+import { p as LeadFormKind, r as LeadFormRole, o as LEAD_FORM_ROLE_SPECS, n as LEAD_FORM_ROLES, J as JsonValue, b as TrackingEnvironment, k as FormSubmitMetadata } from './phone-utils-BlWj8oxq.js';
 
 interface ServiceFiring {
     send_to: string;
@@ -527,6 +527,18 @@ type LeadFormFields<C extends LeadFormContracts, K extends LeadFormKind> = {
 } & {
     [R in AddOnRole]?: boolean | Blank;
 } & AllGroups<KindOf<C, K>, KindOf<C, K>["requiresAny"]>;
+/** Who the lead is never changes after the submit; an email it lacked is the one exception. */
+type DetailsRole = Exclude<RegistryRole, Exclude<{
+    [R in RegistryRole]: Specs[R] extends {
+        contactIdentity: true;
+    } ? R : never;
+}[RegistryRole], "email">>;
+/** Every non-identity role of one kind, all optional: details add to a sent lead, so none is owed. */
+type LeadFormDetailsFields<C extends LeadFormContracts, K extends LeadFormKind> = {
+    [R in DetailsRole]?: LeadFormValue<KindOf<C, K>, R> | Blank;
+} & {
+    [R in AddOnRole]?: boolean | Blank;
+};
 interface LeadFormExtraField {
     key: string;
     label: string;
@@ -541,6 +553,23 @@ interface LeadFormSubmitInput<C extends LeadFormContracts, K extends LeadFormKin
     extra?: LeadFormExtraField[];
     action?: string | null;
 }
+/** Names the lead one `submit()` sent, so `addDetails()` can add to it. */
+interface LeadFormSubmission<K extends LeadFormKind = LeadFormKind> {
+    submissionId: string;
+    formId: string;
+    kind: K;
+}
+interface LeadFormDetailsInput<C extends LeadFormContracts, K extends LeadFormKind> {
+    fields: LeadFormDetailsFields<C, K>;
+    extra?: LeadFormExtraField[];
+}
+/** `no_fields`: every answer was blank, so nothing was sent. */
+type LeadFormDetailsResult = {
+    sent: true;
+} | {
+    sent: false;
+    reason: "no_fields";
+};
 /** Anything that can send a `form_submit`: `useTracking()` with `form_submit` registered. */
 interface LeadFormTracking {
     trackEvent(eventType: "form_submit", metadata: FormSubmitMetadata): void;
@@ -554,8 +583,12 @@ interface LeadFormSubmitOptions {
     trackingConfig?: TrackingConfigReference;
 }
 interface LeadFormSubmitter<C extends LeadFormContracts> {
-    /** Send one typed `form_submit`; returns the metadata sent, violations included. */
-    submit<K extends LeadFormKind>(input: LeadFormSubmitInput<C, K>): FormSubmitMetadata;
+    /** Send one typed `form_submit`; returns the metadata sent, violations included, and its handle. */
+    submit<K extends LeadFormKind>(input: LeadFormSubmitInput<C, K>): FormSubmitMetadata & {
+        submission: LeadFormSubmission<K>;
+    };
+    /** Add optional answers to a sent lead as one `form_details`; never a second lead. */
+    addDetails<K extends LeadFormKind>(submission: LeadFormSubmission<K>, input: LeadFormDetailsInput<C, K>): LeadFormDetailsResult;
 }
 /**
  * Bind a tracking client to the site's generated contracts (`ARANOVA_LEAD_FORMS`).
@@ -563,7 +596,8 @@ interface LeadFormSubmitter<C extends LeadFormContracts> {
  * @example
  * ```ts
  * const leadForms = createLeadFormSubmit(useTracking(), ARANOVA_LEAD_FORMS);
- * leadForms.submit({ formId: "booking-form", kind: "booking", fields: { given_name, phone } });
+ * const { submission } = leadForms.submit({ formId: "booking-form", kind: "booking", fields });
+ * leadForms.addDetails(submission, { fields: { note } });
  * ```
  */
 declare function createLeadFormSubmit<C extends LeadFormContracts>(tracking: LeadFormTracking, contracts: C, options?: LeadFormSubmitOptions): LeadFormSubmitter<C>;
@@ -761,4 +795,4 @@ interface SalesBookingsClient {
 /** A fresh per-submit key. Keep it for retries of the same submit; mint a new one after. */
 declare const newBookingAttemptKey: typeof uuidV4;
 
-export { type LeadFormKindDecl as A, type BookableDay as B, type ConversionConfig as C, type LeadFormRequirementDecl as D, type LeadFormSubmitInput as E, type FormSubmitField as F, type LeadFormSubmitOptions as G, type LeadFormSubmitter as H, type LeadFormTimeWindow as I, type LeadFormTracking as J, type LeadFormValue as K, type LeadFormAddress as L, bookableSlots as M, buildBookingHandoffUrl as N, getBookingIntegration as O, getTrackingConfigRuntime as P, groupBookingOptions as Q, newBookingAttemptKey as R, type SalesBookingsClient as S, type TrackingConfigReference as T, resolveConversionConfig as U, resolveTrackingConfigUrl as V, shopToday as W, slotFields as X, timeWindow as Y, createLeadFormSubmit as Z, TrackingConfigRuntime as _, type BookingDetailsFailure as a, type BookingDetailsInput as b, type BookingDetailsOptions as c, type BookingDetailsOutcome as d, type BookingDetailsStatus as e, type BookingDropOff as f, type BookingFormSubmit as g, type BookingHandoffPrefill as h, type BookingInput as i, type BookingInputFor as j, type BookingIntegration as k, type BookingMode as l, type BookingOption as m, type BookingOptionGroup as n, type BookingOptionKey as o, type BookingOutcome as p, type BookingProvider as q, type BookingRules as r, type BookingServiceKey as s, type BookingSimulation as t, type BookingSubmitOptions as u, type BookingVehicle as v, type ConversionConfigStore as w, type LeadFormContracts as x, type LeadFormExtraField as y, type LeadFormFields as z };
+export { slotFields as $, type LeadFormDetailsResult as A, type BookableDay as B, type ConversionConfig as C, type LeadFormExtraField as D, type LeadFormFields as E, type FormSubmitField as F, type LeadFormKindDecl as G, type LeadFormRequirementDecl as H, type LeadFormSubmission as I, type LeadFormSubmitInput as J, type LeadFormSubmitOptions as K, type LeadFormAddress as L, type LeadFormSubmitter as M, type LeadFormTimeWindow as N, type LeadFormTracking as O, type LeadFormValue as P, bookableSlots as Q, buildBookingHandoffUrl as R, type SalesBookingsClient as S, type TrackingConfigReference as T, getBookingIntegration as U, getTrackingConfigRuntime as V, groupBookingOptions as W, newBookingAttemptKey as X, resolveConversionConfig as Y, resolveTrackingConfigUrl as Z, shopToday as _, type BookingDetailsFailure as a, timeWindow as a0, createLeadFormSubmit as a1, TrackingConfigRuntime as a2, type BookingDetailsInput as b, type BookingDetailsOptions as c, type BookingDetailsOutcome as d, type BookingDetailsStatus as e, type BookingDropOff as f, type BookingFormSubmit as g, type BookingHandoffPrefill as h, type BookingInput as i, type BookingInputFor as j, type BookingIntegration as k, type BookingMode as l, type BookingOption as m, type BookingOptionGroup as n, type BookingOptionKey as o, type BookingOutcome as p, type BookingProvider as q, type BookingRules as r, type BookingServiceKey as s, type BookingSimulation as t, type BookingSubmitOptions as u, type BookingVehicle as v, type ConversionConfigStore as w, type LeadFormContracts as x, type LeadFormDetailsFields as y, type LeadFormDetailsInput as z };

package/dist/{bookings-DOh1WMhH.d.mts → bookings-CVvpj_8K.d.mts}

@@ -1,4 +1,4 @@
-import { p as LeadFormKind, r as LeadFormRole, o as LEAD_FORM_ROLE_SPECS, n as LEAD_FORM_ROLES, J as JsonValue, b as TrackingEnvironment, k as FormSubmitMetadata } from './phone-utils-CYr6AmEP.mjs';
+import { p as LeadFormKind, r as LeadFormRole, o as LEAD_FORM_ROLE_SPECS, n as LEAD_FORM_ROLES, J as JsonValue, b as TrackingEnvironment, k as FormSubmitMetadata } from './phone-utils-BlWj8oxq.mjs';
 
 interface ServiceFiring {
     send_to: string;
@@ -527,6 +527,18 @@ type LeadFormFields<C extends LeadFormContracts, K extends LeadFormKind> = {
 } & {
     [R in AddOnRole]?: boolean | Blank;
 } & AllGroups<KindOf<C, K>, KindOf<C, K>["requiresAny"]>;
+/** Who the lead is never changes after the submit; an email it lacked is the one exception. */
+type DetailsRole = Exclude<RegistryRole, Exclude<{
+    [R in RegistryRole]: Specs[R] extends {
+        contactIdentity: true;
+    } ? R : never;
+}[RegistryRole], "email">>;
+/** Every non-identity role of one kind, all optional: details add to a sent lead, so none is owed. */
+type LeadFormDetailsFields<C extends LeadFormContracts, K extends LeadFormKind> = {
+    [R in DetailsRole]?: LeadFormValue<KindOf<C, K>, R> | Blank;
+} & {
+    [R in AddOnRole]?: boolean | Blank;
+};
 interface LeadFormExtraField {
     key: string;
     label: string;
@@ -541,6 +553,23 @@ interface LeadFormSubmitInput<C extends LeadFormContracts, K extends LeadFormKin
     extra?: LeadFormExtraField[];
     action?: string | null;
 }
+/** Names the lead one `submit()` sent, so `addDetails()` can add to it. */
+interface LeadFormSubmission<K extends LeadFormKind = LeadFormKind> {
+    submissionId: string;
+    formId: string;
+    kind: K;
+}
+interface LeadFormDetailsInput<C extends LeadFormContracts, K extends LeadFormKind> {
+    fields: LeadFormDetailsFields<C, K>;
+    extra?: LeadFormExtraField[];
+}
+/** `no_fields`: every answer was blank, so nothing was sent. */
+type LeadFormDetailsResult = {
+    sent: true;
+} | {
+    sent: false;
+    reason: "no_fields";
+};
 /** Anything that can send a `form_submit`: `useTracking()` with `form_submit` registered. */
 interface LeadFormTracking {
     trackEvent(eventType: "form_submit", metadata: FormSubmitMetadata): void;
@@ -554,8 +583,12 @@ interface LeadFormSubmitOptions {
     trackingConfig?: TrackingConfigReference;
 }
 interface LeadFormSubmitter<C extends LeadFormContracts> {
-    /** Send one typed `form_submit`; returns the metadata sent, violations included. */
-    submit<K extends LeadFormKind>(input: LeadFormSubmitInput<C, K>): FormSubmitMetadata;
+    /** Send one typed `form_submit`; returns the metadata sent, violations included, and its handle. */
+    submit<K extends LeadFormKind>(input: LeadFormSubmitInput<C, K>): FormSubmitMetadata & {
+        submission: LeadFormSubmission<K>;
+    };
+    /** Add optional answers to a sent lead as one `form_details`; never a second lead. */
+    addDetails<K extends LeadFormKind>(submission: LeadFormSubmission<K>, input: LeadFormDetailsInput<C, K>): LeadFormDetailsResult;
 }
 /**
  * Bind a tracking client to the site's generated contracts (`ARANOVA_LEAD_FORMS`).
@@ -563,7 +596,8 @@ interface LeadFormSubmitter<C extends LeadFormContracts> {
  * @example
  * ```ts
  * const leadForms = createLeadFormSubmit(useTracking(), ARANOVA_LEAD_FORMS);
- * leadForms.submit({ formId: "booking-form", kind: "booking", fields: { given_name, phone } });
+ * const { submission } = leadForms.submit({ formId: "booking-form", kind: "booking", fields });
+ * leadForms.addDetails(submission, { fields: { note } });
  * ```
  */
 declare function createLeadFormSubmit<C extends LeadFormContracts>(tracking: LeadFormTracking, contracts: C, options?: LeadFormSubmitOptions): LeadFormSubmitter<C>;
@@ -761,4 +795,4 @@ interface SalesBookingsClient {
 /** A fresh per-submit key. Keep it for retries of the same submit; mint a new one after. */
 declare const newBookingAttemptKey: typeof uuidV4;
 
-export { type LeadFormKindDecl as A, type BookableDay as B, type ConversionConfig as C, type LeadFormRequirementDecl as D, type LeadFormSubmitInput as E, type FormSubmitField as F, type LeadFormSubmitOptions as G, type LeadFormSubmitter as H, type LeadFormTimeWindow as I, type LeadFormTracking as J, type LeadFormValue as K, type LeadFormAddress as L, bookableSlots as M, buildBookingHandoffUrl as N, getBookingIntegration as O, getTrackingConfigRuntime as P, groupBookingOptions as Q, newBookingAttemptKey as R, type SalesBookingsClient as S, type TrackingConfigReference as T, resolveConversionConfig as U, resolveTrackingConfigUrl as V, shopToday as W, slotFields as X, timeWindow as Y, createLeadFormSubmit as Z, TrackingConfigRuntime as _, type BookingDetailsFailure as a, type BookingDetailsInput as b, type BookingDetailsOptions as c, type BookingDetailsOutcome as d, type BookingDetailsStatus as e, type BookingDropOff as f, type BookingFormSubmit as g, type BookingHandoffPrefill as h, type BookingInput as i, type BookingInputFor as j, type BookingIntegration as k, type BookingMode as l, type BookingOption as m, type BookingOptionGroup as n, type BookingOptionKey as o, type BookingOutcome as p, type BookingProvider as q, type BookingRules as r, type BookingServiceKey as s, type BookingSimulation as t, type BookingSubmitOptions as u, type BookingVehicle as v, type ConversionConfigStore as w, type LeadFormContracts as x, type LeadFormExtraField as y, type LeadFormFields as z };
+export { slotFields as $, type LeadFormDetailsResult as A, type BookableDay as B, type ConversionConfig as C, type LeadFormExtraField as D, type LeadFormFields as E, type FormSubmitField as F, type LeadFormKindDecl as G, type LeadFormRequirementDecl as H, type LeadFormSubmission as I, type LeadFormSubmitInput as J, type LeadFormSubmitOptions as K, type LeadFormAddress as L, type LeadFormSubmitter as M, type LeadFormTimeWindow as N, type LeadFormTracking as O, type LeadFormValue as P, bookableSlots as Q, buildBookingHandoffUrl as R, type SalesBookingsClient as S, type TrackingConfigReference as T, getBookingIntegration as U, getTrackingConfigRuntime as V, groupBookingOptions as W, newBookingAttemptKey as X, resolveConversionConfig as Y, resolveTrackingConfigUrl as Z, shopToday as _, type BookingDetailsFailure as a, timeWindow as a0, createLeadFormSubmit as a1, TrackingConfigRuntime as a2, type BookingDetailsInput as b, type BookingDetailsOptions as c, type BookingDetailsOutcome as d, type BookingDetailsStatus as e, type BookingDropOff as f, type BookingFormSubmit as g, type BookingHandoffPrefill as h, type BookingInput as i, type BookingInputFor as j, type BookingIntegration as k, type BookingMode as l, type BookingOption as m, type BookingOptionGroup as n, type BookingOptionKey as o, type BookingOutcome as p, type BookingProvider as q, type BookingRules as r, type BookingServiceKey as s, type BookingSimulation as t, type BookingSubmitOptions as u, type BookingVehicle as v, type ConversionConfigStore as w, type LeadFormContracts as x, type LeadFormDetailsFields as y, type LeadFormDetailsInput as z };

package/dist/client.d.mts

@@ -1,9 +1,9 @@
 import * as react from 'react';
 import { ReactNode, CSSProperties, InputHTMLAttributes, ChangeEvent, FocusEvent, AnchorHTMLAttributes } from 'react';
-import { G as GtagEnvironmentMap, M as MetaPixelEnvironmentMap, h as ConsentState, f as ConsentChoiceState, g as ConsentSource, T as TrackingParams, b as TrackingEnvironment, u as PhoneConfig, P as ParsedPhone, v as PhoneDisplayFormat } from './phone-utils-CYr6AmEP.mjs';
-import { T as TrackingConfigReference, C as ConversionConfig, h as BookingHandoffPrefill, i as BookingInput, p as BookingOutcome, b as BookingDetailsInput, d as BookingDetailsOutcome, k as BookingIntegration, B as BookableDay, x as LeadFormContracts, S as SalesBookingsClient, g as BookingFormSubmit, t as BookingSimulation, j as BookingInputFor } from './bookings-DOh1WMhH.mjs';
-export { Z as createLeadFormSubmit } from './bookings-DOh1WMhH.mjs';
-import { L as TriggerRegistryConfig, O as TypedTrackingClient } from './ingest-typed-BO6Arbw-.mjs';
+import { G as GtagEnvironmentMap, M as MetaPixelEnvironmentMap, h as ConsentState, f as ConsentChoiceState, g as ConsentSource, T as TrackingParams, b as TrackingEnvironment, u as PhoneConfig, P as ParsedPhone, v as PhoneDisplayFormat } from './phone-utils-BlWj8oxq.mjs';
+import { T as TrackingConfigReference, C as ConversionConfig, h as BookingHandoffPrefill, i as BookingInput, p as BookingOutcome, b as BookingDetailsInput, d as BookingDetailsOutcome, k as BookingIntegration, B as BookableDay, x as LeadFormContracts, S as SalesBookingsClient, g as BookingFormSubmit, t as BookingSimulation, j as BookingInputFor } from './bookings-CVvpj_8K.mjs';
+export { a1 as createLeadFormSubmit } from './bookings-CVvpj_8K.mjs';
+import { O as TriggerRegistryConfig, U as TypedTrackingClient } from './ingest-typed-CoCjTqJs.mjs';
 import { CountryCode } from 'libphonenumber-js';
 import 'zod/mini';
 import 'zod/v4/core';

package/dist/client.d.ts

@@ -1,9 +1,9 @@
 import * as react from 'react';
 import { ReactNode, CSSProperties, InputHTMLAttributes, ChangeEvent, FocusEvent, AnchorHTMLAttributes } from 'react';
-import { G as GtagEnvironmentMap, M as MetaPixelEnvironmentMap, h as ConsentState, f as ConsentChoiceState, g as ConsentSource, T as TrackingParams, b as TrackingEnvironment, u as PhoneConfig, P as ParsedPhone, v as PhoneDisplayFormat } from './phone-utils-CYr6AmEP.js';
-import { T as TrackingConfigReference, C as ConversionConfig, h as BookingHandoffPrefill, i as BookingInput, p as BookingOutcome, b as BookingDetailsInput, d as BookingDetailsOutcome, k as BookingIntegration, B as BookableDay, x as LeadFormContracts, S as SalesBookingsClient, g as BookingFormSubmit, t as BookingSimulation, j as BookingInputFor } from './bookings-2ZKfenQ7.js';
-export { Z as createLeadFormSubmit } from './bookings-2ZKfenQ7.js';
-import { L as TriggerRegistryConfig, O as TypedTrackingClient } from './ingest-typed-D7I4aQ7p.js';
+import { G as GtagEnvironmentMap, M as MetaPixelEnvironmentMap, h as ConsentState, f as ConsentChoiceState, g as ConsentSource, T as TrackingParams, b as TrackingEnvironment, u as PhoneConfig, P as ParsedPhone, v as PhoneDisplayFormat } from './phone-utils-BlWj8oxq.js';
+import { T as TrackingConfigReference, C as ConversionConfig, h as BookingHandoffPrefill, i as BookingInput, p as BookingOutcome, b as BookingDetailsInput, d as BookingDetailsOutcome, k as BookingIntegration, B as BookableDay, x as LeadFormContracts, S as SalesBookingsClient, g as BookingFormSubmit, t as BookingSimulation, j as BookingInputFor } from './bookings-CCGpXhYE.js';
+export { a1 as createLeadFormSubmit } from './bookings-CCGpXhYE.js';
+import { O as TriggerRegistryConfig, U as TypedTrackingClient } from './ingest-typed-C3XAjHlH.js';
 import { CountryCode } from 'libphonenumber-js';
 import 'zod/mini';
 import 'zod/v4/core';