@aranova/tracking-react 1.3.0 → 1.4.0

package/README.md

@@ -342,6 +342,13 @@ await submit({
   your own), `pending` (same success; still being sent, the owner is alerted if it fails),
   `failed` (success copy plus `outcome.fallbackUrl`, the prefilled shop page), `invalid`
   (`outcome.message`, nothing sent), `stale` (the times changed; the config is refetched).
+- `outcome.mode` (and `booking.mode` before submitting): `live` for every real customer;
+  `test` (sent to the shop's test lead source) or `simulated` (never sent) on a test visit or a
+  non-production API. Show a small "test booking" note when it isn't `live`.
+- Development only: `useBookingSubmit(bookings, { simulate: "failed" })` forces a simulated
+  outcome (`created`, `rejected`, `unknown`, `failed`) to exercise each screen. The production
+  API ignores it. Test locally against the local API **and** the local CDN; the SDK warns in the
+  console when the endpoint is localhost but the config comes from production.
 - `useBookingSlots` / `bookableSlots(rules, { timeZone })` offer exactly the portal's start hours,
   judged by the shop's date. `useBookingSubmit` reuses one attempt key across a double-click or
   a retry, and sends the visit's `form_submit` once: don't send your own for this form.

package/dist/{bookings-VsQdopTt.d.mts → bookings-CqCuuyP6.d.mts}

@@ -70,6 +70,13 @@ interface BookingOptionConfig {
     key: string;
     label: string;
 }
+/** Where a booking went; decided by the API. A real customer always gets `live`. */
+declare const BOOKING_MODES: readonly ["live", "test", "simulated"];
+/**
+ * `live`: the shop's real queue. `test`: a real request on the shop's test lead source, never
+ * counted. `simulated`: never sent; nothing reached the shop or the customer.
+ */
+type BookingMode = (typeof BOOKING_MODES)[number];
 /** `integrations.autoleap.booking` — never carries a secret. */
 interface AutoLeapBookingConfig {
     /** False: show only `fallback_url`. The site never blocks the customer on it. */
@@ -83,6 +90,8 @@ interface AutoLeapBookingConfig {
     accepts_bookings: boolean;
     rules: BookingRulesConfig | null;
     options: BookingOptionConfig[];
+    /** Development objects only: `test` or `simulated`, so a dev page can say so up front. */
+    mode?: BookingMode;
 }
 interface ConversionIntegrations {
     autoleap?: {
@@ -254,8 +263,11 @@ declare function getTrackingConfigRuntime(ref: TrackingConfigReference, fetchImp
 /** A UUID v4 from Web Crypto, with a `getRandomValues` (then `Math.random`) fallback. */
 declare function uuidV4(): string;
 
+/** Developer-only outcomes for a simulated create; the production API ignores them. */
+declare const BOOKING_SIMULATIONS: readonly ["created", "rejected", "unknown", "failed"];
 declare const BOOKING_DROP_OFF_OPTIONS: readonly ["waitForIt", "dropOff"];
 type BookingDropOff = (typeof BOOKING_DROP_OFF_OPTIONS)[number];
+type BookingSimulation = (typeof BOOKING_SIMULATIONS)[number];
 /** What the booking form collected. Dates and hours are the shop's wall time. */
 interface BookingInput {
     /** `YYYY-MM-DD`, one of `bookableSlots(...)`'s dates. */
@@ -300,11 +312,13 @@ type BookingOutcome =
     status: "created";
     id: string;
     requestCode: string | null;
+    mode: BookingMode;
 }
 /** Received and still being sent; the shop confirms. Show the same success. */
  | {
     status: "pending";
     id: string;
+    mode: BookingMode;
 }
 /**
  * Not created. Still a success for the customer: show the prefilled shop booking link.
@@ -314,6 +328,7 @@ type BookingOutcome =
     status: "failed";
     id: string | null;
     fallbackUrl: string | null;
+    mode: BookingMode;
 }
 /** The booking breaks the shop's rules; `message` is customer-safe. Nothing was sent. */
  | {
@@ -326,20 +341,26 @@ type BookingOutcome =
     status: "stale";
     message: string;
 };
+interface BookingSubmitOptions {
+    attemptKey: string;
+    formSubmit?: BookingFormSubmit;
+    /**
+     * Development only: force a simulated create's outcome to exercise the success, pending and
+     * fallback screens. The production API ignores it, so it can never change a real booking.
+     */
+    simulate?: BookingSimulation;
+}
 interface SalesBookingsClient {
     /**
      * Send one booking. Never rejects for an API outcome: every answer is a {@link BookingOutcome}.
      * Pass the same `attemptKey` (a UUID, `newBookingAttemptKey()`) on a retry of the same submit,
      * so a double-click or a network retry can never book twice.
      */
-    submit(input: BookingInput, options: {
-        attemptKey: string;
-        formSubmit?: BookingFormSubmit;
-    }): Promise<BookingOutcome>;
+    submit(input: BookingInput, options: BookingSubmitOptions): Promise<BookingOutcome>;
     /** A booking's current status by the id `submit` returned. */
     status(id: string): Promise<BookingOutcome>;
 }
 /** 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 BookingDropOff as B, type ConversionConfig as C, type SalesBookingsClient as S, type TrackingConfigReference as T, type BookingFormSubmit as a, type BookingInput as b, type BookingOutcome as c, type ConversionConfigStore as d, resolveTrackingConfigUrl as e, type BookingDayWindows as f, getTrackingConfigRuntime as g, type ConversionIntegrations as h, TrackingConfigRuntime as i, newBookingAttemptKey as n, resolveConversionConfig as r };
+export { type BookingDropOff as B, type ConversionConfig as C, type SalesBookingsClient as S, type TrackingConfigReference as T, type BookingFormSubmit as a, type BookingInput as b, type BookingMode as c, type BookingOutcome as d, type BookingSimulation as e, type BookingSubmitOptions as f, type ConversionConfigStore as g, getTrackingConfigRuntime as h, resolveTrackingConfigUrl as i, type BookingDayWindows as j, type ConversionIntegrations as k, TrackingConfigRuntime as l, newBookingAttemptKey as n, resolveConversionConfig as r };

package/dist/{bookings-CqdjLMkv.d.ts → bookings-DIu1ho6v.d.ts}

@@ -70,6 +70,13 @@ interface BookingOptionConfig {
     key: string;
     label: string;
 }
+/** Where a booking went; decided by the API. A real customer always gets `live`. */
+declare const BOOKING_MODES: readonly ["live", "test", "simulated"];
+/**
+ * `live`: the shop's real queue. `test`: a real request on the shop's test lead source, never
+ * counted. `simulated`: never sent; nothing reached the shop or the customer.
+ */
+type BookingMode = (typeof BOOKING_MODES)[number];
 /** `integrations.autoleap.booking` — never carries a secret. */
 interface AutoLeapBookingConfig {
     /** False: show only `fallback_url`. The site never blocks the customer on it. */
@@ -83,6 +90,8 @@ interface AutoLeapBookingConfig {
     accepts_bookings: boolean;
     rules: BookingRulesConfig | null;
     options: BookingOptionConfig[];
+    /** Development objects only: `test` or `simulated`, so a dev page can say so up front. */
+    mode?: BookingMode;
 }
 interface ConversionIntegrations {
     autoleap?: {
@@ -254,8 +263,11 @@ declare function getTrackingConfigRuntime(ref: TrackingConfigReference, fetchImp
 /** A UUID v4 from Web Crypto, with a `getRandomValues` (then `Math.random`) fallback. */
 declare function uuidV4(): string;
 
+/** Developer-only outcomes for a simulated create; the production API ignores them. */
+declare const BOOKING_SIMULATIONS: readonly ["created", "rejected", "unknown", "failed"];
 declare const BOOKING_DROP_OFF_OPTIONS: readonly ["waitForIt", "dropOff"];
 type BookingDropOff = (typeof BOOKING_DROP_OFF_OPTIONS)[number];
+type BookingSimulation = (typeof BOOKING_SIMULATIONS)[number];
 /** What the booking form collected. Dates and hours are the shop's wall time. */
 interface BookingInput {
     /** `YYYY-MM-DD`, one of `bookableSlots(...)`'s dates. */
@@ -300,11 +312,13 @@ type BookingOutcome =
     status: "created";
     id: string;
     requestCode: string | null;
+    mode: BookingMode;
 }
 /** Received and still being sent; the shop confirms. Show the same success. */
  | {
     status: "pending";
     id: string;
+    mode: BookingMode;
 }
 /**
  * Not created. Still a success for the customer: show the prefilled shop booking link.
@@ -314,6 +328,7 @@ type BookingOutcome =
     status: "failed";
     id: string | null;
     fallbackUrl: string | null;
+    mode: BookingMode;
 }
 /** The booking breaks the shop's rules; `message` is customer-safe. Nothing was sent. */
  | {
@@ -326,20 +341,26 @@ type BookingOutcome =
     status: "stale";
     message: string;
 };
+interface BookingSubmitOptions {
+    attemptKey: string;
+    formSubmit?: BookingFormSubmit;
+    /**
+     * Development only: force a simulated create's outcome to exercise the success, pending and
+     * fallback screens. The production API ignores it, so it can never change a real booking.
+     */
+    simulate?: BookingSimulation;
+}
 interface SalesBookingsClient {
     /**
      * Send one booking. Never rejects for an API outcome: every answer is a {@link BookingOutcome}.
      * Pass the same `attemptKey` (a UUID, `newBookingAttemptKey()`) on a retry of the same submit,
      * so a double-click or a network retry can never book twice.
      */
-    submit(input: BookingInput, options: {
-        attemptKey: string;
-        formSubmit?: BookingFormSubmit;
-    }): Promise<BookingOutcome>;
+    submit(input: BookingInput, options: BookingSubmitOptions): Promise<BookingOutcome>;
     /** A booking's current status by the id `submit` returned. */
     status(id: string): Promise<BookingOutcome>;
 }
 /** 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 BookingDropOff as B, type ConversionConfig as C, type SalesBookingsClient as S, type TrackingConfigReference as T, type BookingFormSubmit as a, type BookingInput as b, type BookingOutcome as c, type ConversionConfigStore as d, resolveTrackingConfigUrl as e, type BookingDayWindows as f, getTrackingConfigRuntime as g, type ConversionIntegrations as h, TrackingConfigRuntime as i, newBookingAttemptKey as n, resolveConversionConfig as r };
+export { type BookingDropOff as B, type ConversionConfig as C, type SalesBookingsClient as S, type TrackingConfigReference as T, type BookingFormSubmit as a, type BookingInput as b, type BookingMode as c, type BookingOutcome as d, type BookingSimulation as e, type BookingSubmitOptions as f, type ConversionConfigStore as g, getTrackingConfigRuntime as h, resolveTrackingConfigUrl as i, type BookingDayWindows as j, type ConversionIntegrations as k, TrackingConfigRuntime as l, newBookingAttemptKey as n, resolveConversionConfig as r };

package/dist/client.d.mts

@@ -1,8 +1,8 @@
 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, j as PhoneConfig, P as ParsedPhone, k as PhoneDisplayFormat } from './phone-utils-CM8eUPz8.mjs';
-import { T as TrackingConfigReference, C as ConversionConfig, c as BookingOutcome, b as BookingInput, S as SalesBookingsClient, a as BookingFormSubmit } from './bookings-VsQdopTt.mjs';
-import { W as TriggerRegistryConfig, Y as TypedTrackingClient, a as BookingHandoffPrefill, b as BookingIntegration, B as BookableDay } from './ingest-typed-BCUv93ax.mjs';
+import { T as TrackingConfigReference, C as ConversionConfig, d as BookingOutcome, b as BookingInput, S as SalesBookingsClient, a as BookingFormSubmit, e as BookingSimulation } from './bookings-CqCuuyP6.mjs';
+import { W as TriggerRegistryConfig, Y as TypedTrackingClient, a as BookingHandoffPrefill, b as BookingIntegration, B as BookableDay } from './ingest-typed-D7UZr0EM.mjs';
 import { CountryCode } from 'libphonenumber-js';
 import './form-submit-BLb28aCk.mjs';
 import 'zod/mini';
@@ -418,6 +418,8 @@ interface BookingSubmitState {
  */
 declare function useBookingSubmit(bookings: SalesBookingsClient, options?: {
     formSubmit?: BookingFormSubmit;
+    /** Development only: a simulated create's outcome. The production API ignores it. */
+    simulate?: BookingSimulation;
 }): BookingSubmitState;
 
 export { AdPlatformTracking, type AdPlatformTrackingProps, BookingHandoffLink, type BookingHandoffLinkProps, type BookingHandoffOptions, type BookingSubmitState, type BookingSubmitStatus, ConsentBanner, type ConsentBannerProps, type CreateTrackingOptions, type CreateTrackingResult, GoogleAdsTracking, type GoogleAdsTrackingProps, PhoneField, type PhoneFieldApi, type PhoneFieldProps, type PhoneInputProps, type TrackingProviderProps, type UseConsentResult, type UseCookiePreferencesOptions, type UseCookiePreferencesResult, type UsePhoneFieldOptions, createTracking, useBookingHandoffUrl, useBookingIntegration, useBookingSlots, useBookingSubmit, useConsent, useConsentState, useCookiePreferences, useGclid, usePhoneConfig, usePhoneField, useTrackingParams };

package/dist/client.d.ts

@@ -1,8 +1,8 @@
 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, j as PhoneConfig, P as ParsedPhone, k as PhoneDisplayFormat } from './phone-utils-l8ey3Zdm.js';
-import { T as TrackingConfigReference, C as ConversionConfig, c as BookingOutcome, b as BookingInput, S as SalesBookingsClient, a as BookingFormSubmit } from './bookings-CqdjLMkv.js';
-import { W as TriggerRegistryConfig, Y as TypedTrackingClient, a as BookingHandoffPrefill, b as BookingIntegration, B as BookableDay } from './ingest-typed-DGqzbteM.js';
+import { T as TrackingConfigReference, C as ConversionConfig, d as BookingOutcome, b as BookingInput, S as SalesBookingsClient, a as BookingFormSubmit, e as BookingSimulation } from './bookings-DIu1ho6v.js';
+import { W as TriggerRegistryConfig, Y as TypedTrackingClient, a as BookingHandoffPrefill, b as BookingIntegration, B as BookableDay } from './ingest-typed-D2S3Kb8m.js';
 import { CountryCode } from 'libphonenumber-js';
 import './form-submit-BLb28aCk.js';
 import 'zod/mini';
@@ -418,6 +418,8 @@ interface BookingSubmitState {
  */
 declare function useBookingSubmit(bookings: SalesBookingsClient, options?: {
     formSubmit?: BookingFormSubmit;
+    /** Development only: a simulated create's outcome. The production API ignores it. */
+    simulate?: BookingSimulation;
 }): BookingSubmitState;
 
 export { AdPlatformTracking, type AdPlatformTrackingProps, BookingHandoffLink, type BookingHandoffLinkProps, type BookingHandoffOptions, type BookingSubmitState, type BookingSubmitStatus, ConsentBanner, type ConsentBannerProps, type CreateTrackingOptions, type CreateTrackingResult, GoogleAdsTracking, type GoogleAdsTrackingProps, PhoneField, type PhoneFieldApi, type PhoneFieldProps, type PhoneInputProps, type TrackingProviderProps, type UseConsentResult, type UseCookiePreferencesOptions, type UseCookiePreferencesResult, type UsePhoneFieldOptions, createTracking, useBookingHandoffUrl, useBookingIntegration, useBookingSlots, useBookingSubmit, useConsent, useConsentState, useCookiePreferences, useGclid, usePhoneConfig, usePhoneField, useTrackingParams };

package/dist/client.js

@@ -979,6 +979,10 @@ function fireConversionWithConsent(input, options) {
 }
 
 // ../tracking-core/src/resources/conversion-config.ts
+var BOOKING_MODES = ["live", "test", "simulated"];
+function isBookingMode(value) {
+  return BOOKING_MODES.includes(value);
+}
 function isStringMap(value) {
   return typeof value === "object" && value !== null && Object.values(value).every((v) => typeof v === "string");
 }
@@ -1050,7 +1054,8 @@ function parseIntegrations(value) {
         config_version: typeof b.config_version === "number" ? b.config_version : null,
         accepts_bookings: b.accepts_bookings === true,
         rules: parseBookingRules(b.rules),
-        options: Array.isArray(b.options) ? b.options.flatMap(parseBookingOption) : []
+        options: Array.isArray(b.options) ? b.options.flatMap(parseBookingOption) : [],
+        ...isBookingMode(b.mode) ? { mode: b.mode } : {}
       }
     }
   };
@@ -1734,7 +1739,8 @@ function getBookingIntegration(integrations) {
     timezone: booking.timezone,
     configVersion: booking.config_version,
     rules,
-    options: booking.options.map((option) => ({ key: option.key, label: option.label }))
+    options: booking.options.map((option) => ({ key: option.key, label: option.label })),
+    mode: booking.mode ?? "live"
   };
 }
 function camelRules(rules) {
@@ -3967,7 +3973,7 @@ function GoogleAdsTracking(props) {
 var import_react6 = require("react");
 
 // package.json
-var version = "1.3.0";
+var version = "1.4.0";
 
 // ../tracking-core/src/phone-react.tsx
 var import_react5 = require("react");
@@ -4284,13 +4290,13 @@ function useBookingSubmit(bookings, options = {}) {
   const [submitting, setSubmitting] = (0, import_react7.useState)(false);
   const attemptKey = (0, import_react7.useRef)(null);
   const inFlight = (0, import_react7.useRef)(null);
-  const { formSubmit } = options;
+  const { formSubmit, simulate } = options;
   const submit = (0, import_react7.useCallback)(
     (input) => {
       if (inFlight.current) return inFlight.current;
       attemptKey.current ?? (attemptKey.current = newBookingAttemptKey());
       setSubmitting(true);
-      const run = bookings.submit(input, { attemptKey: attemptKey.current, formSubmit }).then((result) => {
+      const run = bookings.submit(input, { attemptKey: attemptKey.current, formSubmit, simulate }).then((result) => {
         const unrecorded = result.status === "invalid" || result.status === "stale" || result.status === "failed" && result.id === null;
         if (!unrecorded) attemptKey.current = null;
         setOutcome(result);
@@ -4302,7 +4308,7 @@ function useBookingSubmit(bookings, options = {}) {
       inFlight.current = run;
       return run;
     },
-    [bookings, formSubmit]
+    [bookings, formSubmit, simulate]
   );
   const reset = (0, import_react7.useCallback)(() => {
     attemptKey.current = null;