@parag.more.withsurface.com/forms-sdk 0.1.4 → 0.1.6

package/dist/types/core/engine/urlData.d.ts

@@ -1,18 +1,4 @@
-/**
- * Attribution capture (forms-sdk-plan.md row 56): the `URL_DATA`
- * external-state entry that rides every response write and feeds UTM/source
- * attribution. Mirrors the URL-config branch of form-render's
- * `buildExternalStateStore` — same shape (`fullUrl`/`params`/`referrer`/
- * `cookies`, wire-validated against `ZURLData` in the contract test), same
- * `defaultUrl` precedence, same swallow-on-malformed behavior.
- *
- * One structural simplification the self-hosted model earns (plan §4.1): the
- * SDK runs in the page it measures, so `fullUrl`/`referrer`/`cookies` are
- * read directly from `location`/`document` — native needs them relayed
- * through `?url=`/`?referrer=`/`?cookies=` query params by the tag, including
- * cookies as a JSON blob. Cookie capture stays gated by the same
- * `trackCookies` setting.
- */
+
 export type UrlData = {
     type: "URL_DATA";
     fullUrl?: string;
@@ -23,8 +9,7 @@ export type UrlData = {
 export declare const constructUrlParamsObject: (url: string) => Record<string, string>;
 export declare const parseCookiesObject: (cookieString: string) => Record<string, string>;
 export declare const buildUrlData: ({ defaultUrl, trackCookies, }?: {
-    /** Config-pinned URL that wins over the live page URL, like native. */
+    
     defaultUrl?: string;
     trackCookies?: boolean;
 }) => UrlData;
-//# sourceMappingURL=urlData.d.ts.map

package/dist/types/core/engine/urlPrefill.d.ts

@@ -1,11 +1,4 @@
-/**
- * URL prefill parsing (forms-sdk-plan.md row 19), same syntax as the native
- * runtime's `useFormUrlParameters`/`parseQuestionId`: any
- * `?<questionId>_<fieldName>=value` query param prefills a field. The param
- * name splits on the FIRST underscore (field names may contain more), both
- * sides are trimmed, `url`/`referrer`/`cookies` are reserved for attribution,
- * and params without an underscore are ignored (no field to target).
- */
+
 export type ParsedUrlQuestionId = {
     originalId: string;
     questionId: string;
@@ -18,4 +11,3 @@ export declare const parseQuestionId: (input: string) => {
     fieldName: string | null;
 };
 export declare const parsePrefillParams: (search: string | URLSearchParams) => Record<string, ParsedUrlQuestionId[]> | null;
-//# sourceMappingURL=urlPrefill.d.ts.map

package/dist/types/core/events/dropoffDetection.d.ts

@@ -1,21 +1,8 @@
 import type { PushEventClient } from "./pushEvents";
-/**
- * `form_step_dropoff` beacon (forms-sdk-plan.md row 32), form-render's
- * `useBeforeUnload` semantics without React: on `pagehide` — the only
- * teardown event that still delivers beacons reliably — emit the drop-off
- * event for the step the visitor abandoned, but only after the form was
- * started and never for bfcache suspensions (`event.persisted`), which are
- * not abandonment.
- *
- * State is read through a getter at fire time because the current step and
- * session change after the listener attaches (native reads refs for the same
- * reason). Delivery rides the pushEvent client, whose transport is
- * sendBeacon-first — the property that makes a pagehide send survivable.
- */
+
 export declare const observeDropoff: (pushEventClient: PushEventClient, getState: () => {
     started: boolean;
     formId: string;
     stepId: string;
     sessionId?: string;
 }) => (() => void);
-//# sourceMappingURL=dropoffDetection.d.ts.map

package/dist/types/core/events/emitter.d.ts

@@ -1,23 +1,7 @@
-/**
- * Instance-scoped typed event emitter — the primitive behind the SDK's
- * public `form.on(...)` lifecycle surface (forms-sdk-plan.md §2.2) and the
- * store-subscription contract adapters build on (§2.9).
- *
- * Exists because the SDK cannot use Node's EventEmitter (zero runtime deps,
- * browser bundle) and must not reproduce form-render's module-level
- * singleton listeners, which break multi-form pages (§2.7). Handler
- * exceptions are isolated per handler: a throwing host callback never breaks
- * the engine or sibling handlers — the never-break-the-host-page guarantee
- * applied to the callback boundary.
- *
- * The concrete SDK event map (viewed/started/stepChanged/…) is owned by the
- * step engine, which defines the payload shapes it emits; this module is
- * deliberately payload-agnostic.
- */
+
 export type Unsubscribe = () => void;
 export type Emitter<TEventMap extends Record<string, unknown>> = {
     on: <K extends keyof TEventMap>(event: K, handler: (payload: TEventMap[K]) => void) => Unsubscribe;
     emit: <K extends keyof TEventMap>(event: K, payload: TEventMap[K]) => void;
 };
 export declare const createEmitter: <TEventMap extends Record<string, unknown>>() => Emitter<TEventMap>;
-//# sourceMappingURL=emitter.d.ts.map

package/dist/types/core/events/formJourneyTracker.d.ts

@@ -1,22 +1,5 @@
 import type { Transport } from "../client/transport";
-/**
- * Form-journey step telemetry (forms-sdk-plan.md row 30): visits, transitions,
- * and outcomes beaconed to `POST /api/v1/form-journey/track`. A direct port of
- * form-render's `createFormJourneyTracker` — same ordinal bookkeeping, same
- * close-previous-visit timing, same 50-visit cap with `truncated`, same
- * freeze-on-terminal-outcome, same microtask coalescing (a transition
- * immediately followed by a terminal sends one beacon, so an in-progress
- * write can't race the disqualified one), and the same synchronous flush for
- * the `in_progress` terminal, which only fires from pagehide and cannot
- * depend on a microtask racing page teardown.
- *
- * Wire types are local structural mirrors of the Zod schemas in
- * `@surface/types/v1/formJourney` (zero-runtime-deps); the contract test
- * validates them against the real `ZFormJourneyTrackPayload`. The
- * `transitionMeta`/`matched` payloads are typed opaque here — they are
- * constructed by routing evaluation, which lands with the routing extraction,
- * and the tracker only passes them through.
- */
+
 export type FormJourneyOutcome = "in_progress" | "completed" | "partial" | "disqualified" | "dropped_off";
 export type FormJourneyTransitionReason = "initial" | "linear" | "conditional_match" | "default_fallback" | "prefill_jump" | "back_nav" | "auto_skip";
 export type FormJourneyVisit = {
@@ -66,4 +49,3 @@ export declare const createFormJourneyTracker: ({ transport, preview, }: {
     transport: Transport;
     preview?: boolean;
 }) => FormJourneyTracker;
-//# sourceMappingURL=formJourneyTracker.d.ts.map

package/dist/types/core/events/pushEvents.d.ts

@@ -1,18 +1,5 @@
 import type { Transport } from "../client/transport";
-/**
- * Client for the internal event pipeline `POST /api/v1/pushEvent`
- * (forms-sdk-plan.md row 33), mirroring form-render's `callPushEventApi`:
- * same wire shapes, same client-side bot filter, same required-field guard
- * (any invalid event drops the whole request), same beacon-first delivery.
- * Two deliberate departures, both decided in the plan: no PostHog mirror
- * (Surface-internal telemetry — §1D row 33) and a `preview` flag that blocks
- * every send so agent preview loops never pollute data (§2.2).
- *
- * The wire types below are structural mirrors of the Zod schemas in
- * `@surface/types/v1/surfaceEvent/model/types.ts` — local because the SDK
- * ships with zero runtime dependencies; the contract test in this directory
- * validates them against the real schemas.
- */
+
 export type SurfaceEventType = "form_viewed" | "form_started" | "form_completed" | "form_step_viewed" | "form_step_submitted" | "form_step_dropoff" | "form_question_submitted" | "response_submission_created" | "response_submission_error" | "script_initiated";
 export type SurfaceEventEntityType = "form" | "form_step" | "response";
 export type PushEventProperty = {
@@ -29,7 +16,7 @@ export type PushEventPayload = {
     leadId?: string;
     environmentId?: string;
 };
-/** The server accepts exactly one batch shape: a step transition pair. */
+
 export type PushEventBatch = {
     events: [
         PushEventPayload & {
@@ -59,4 +46,3 @@ export declare const createPushEventClient: ({ transport, preview, }: {
     transport: Transport;
     preview?: boolean;
 }) => PushEventClient;
-//# sourceMappingURL=pushEvents.d.ts.map

package/dist/types/core/events/startedDetection.d.ts

@@ -1,11 +1,2 @@
-/**
- * `form_started` detection (forms-sdk-plan.md row 22): native fires it on the
- * first deep-inequality between the current answer state and the snapshot
- * taken at mount, once per form instance (`DualPaneAdjustableForm`'s
- * `startedForm` ref + lodash `isEqual`). The detector captures the snapshot at
- * creation; `check(current)` returns true exactly once, on the first
- * divergence. The local deep-equal covers the answer-state shape (plain
- * objects, arrays, primitives) — key order insensitive, like lodash.
- */
+
 export declare const createStartedDetector: <T>(initial: T) => ((current: T) => boolean);
-//# sourceMappingURL=startedDetection.d.ts.map

package/dist/types/core/events/viewDetection.d.ts

@@ -1,15 +1,2 @@
-/**
- * `form_viewed` detection (forms-sdk-plan.md row 21): an IntersectionObserver
- * on the bound form root, firing the callback exactly once per observer —
- * form-render's `useDetectFormView` semantics with its React scaffolding
- * removed. The once-guard replaces native's belt-and-braces 1 s throttle:
- * with a single fire per instance there is nothing left to throttle. The
- * caller (bind layer / engine) emits `form_viewed` + first-step
- * `form_step_viewed`, exactly what native's throttled callback did.
- *
- * If `IntersectionObserver` is unavailable the callback fires immediately —
- * losing view analytics entirely is worse than counting a below-fold mount,
- * and native never handled this case (it would throw).
- */
+
 export declare const observeFormView: (element: Element, onViewed: () => void) => (() => void);
-//# sourceMappingURL=viewDetection.d.ts.map

package/dist/types/core/identity/browserFingerprint.d.ts

@@ -1,19 +1,4 @@
-/**
- * Canonical browser-fingerprint implementation for Surface lead identity.
- *
- * The lead-identity pipeline keys on the SHA-256 of `JSON.stringify` over the
- * collected fields, so the object's insertion order, value shapes, and falsy
- * fallbacks (`||`, not `??`) ARE the wire contract: any deviation produces a
- * different hash and splits one visitor into two leads. Do not reorder fields,
- * rename keys, or change fallback behavior here without a coordinated
- * migration.
- *
- * This module supersedes the two byte-identical copies it was lifted from —
- * `packages/form-render/src/lib/client/leads/browserFingerprint.ts` and the
- * public tag's `src/lead/fingerprint.ts` (trysurface/scripts) — which consume
- * it over time (forms-sdk-plan.md, parity row 9). The identity test in this
- * directory pins hash equality against the form-render copy.
- */
+
 export type Fingerprint = {
     deviceType: "Mobile" | "Desktop";
     screen: {
@@ -28,13 +13,12 @@ export type Fingerprint = {
     }>;
     os: string;
     language: string;
-    /** Absent (never null/empty) when `navigator.plugins` is null. */
+    
     plugins?: string[];
     timezone: string;
     environmentId: string;
-    /** SHA-256 hex of the serialized fields above. */
+    
     id: string;
 };
 export declare function getHash(input: string): Promise<string>;
 export declare const getBrowserFingerprint: (environmentId: string) => Promise<Fingerprint>;
-//# sourceMappingURL=browserFingerprint.d.ts.map

package/dist/types/core/identity/ensureIdentified.d.ts

@@ -1,21 +1,7 @@
 import type { Transport } from "../client/transport";
 import { type LeadSource } from "./identify";
 import { type CachedLeadData } from "./leadDataCache";
-/**
- * The boot-sequence identity step (forms-sdk-plan.md §2.2): resolve the
- * visitor before any response write, since attribute sync silently no-ops for
- * responses whose lead was never identified (row 60). Mirrors the tag's
- * `identifyLead` flow: a fresh cache entry with a session and fingerprint
- * skips the network entirely; otherwise compute the fingerprint, carry any
- * cached leadId/session forward so the server can preserve identity, and
- * cache the result under the shared tag key.
- *
- * `preview: true` blocks the identify call outright — the preview contract
- * (§2.2) is that drafts never create leads. Concurrent calls (multi-form
- * pages) may race one identify each; that is safe — the server find-or-creates
- * by fingerprint, so both resolve to the same lead — and avoids the tag's
- * module-level in-flight flag, which the SDK's instance-scoped rule forbids.
- */
+
 export declare const ensureIdentified: ({ transport, environmentId, formId, pageUrl, source, preview, }: {
     transport: Transport;
     environmentId: string;
@@ -24,4 +10,3 @@ export declare const ensureIdentified: ({ transport, environmentId, formId, page
     source?: LeadSource;
     preview?: boolean;
 }) => Promise<CachedLeadData | null>;
-//# sourceMappingURL=ensureIdentified.d.ts.map

package/dist/types/core/identity/identify.d.ts

@@ -1,18 +1,5 @@
 import type { Transport } from "../client/transport";
-/**
- * Wrapper for `POST /api/v1/lead/identify` (forms-sdk-plan.md row 10),
- * mirroring form-render's `identifyLeadForFormRequest`: same payload fields,
- * same URL normalization (trailing slashes stripped from href and pathname),
- * same keepalive delivery, same `data.data` response unwrap, null on any
- * failure. The wire types are structural mirrors of `ZLeadIdentifyPayload`
- * (`@surface/types/v1/lead/app/types.ts`) — local because the SDK ships with
- * zero runtime dependencies; the contract test validates them against the
- * real schema.
- *
- * `source` defaults to `"sdkForm"` — the dedicated SDK value (Decisions #8),
- * so SDK-originated leads stay distinguishable from the native runtime's
- * `"surfaceForm"` in the leads hub and analytics.
- */
+
 export type LeadSource = "surfaceForm" | "htmlForm" | "websiteDeAnon" | "webhook" | "website" | "imported" | "scheduler" | "linkedin" | "sdkForm";
 export type IdentifyPayload = {
     environmentId: string;
@@ -45,4 +32,3 @@ export declare const buildIdentifyPayload: ({ environmentId, fingerprintId, page
     referrer?: string | null;
 }) => IdentifyPayload;
 export declare const identifyLead: (transport: Transport, payload: IdentifyPayload) => Promise<IdentifyResult | null>;
-//# sourceMappingURL=identify.d.ts.map

package/dist/types/core/identity/journey.d.ts

@@ -1,28 +1,15 @@
 import type { Transport } from "../client/transport";
-/**
- * Opt-in user-journey page-view tracking (forms-sdk-plan.md row 16), the
- * SDK's `journey: true` module. Mirrors the public tag's implementation
- * (trysurface/scripts `src/store/{user-journey,journey-cookies}.ts`, verified
- * at HEAD): same cookies (`surface_journey_id`, 60 d, eTLD+1 domain;
- * `surface_recent_visit`, 1 d), same duplicate-URL skip, same delivery split —
- * beacon when the journey id is already known (nothing to read back), fetch
- * when it isn't so the server-issued id can be captured — and the same
- * history-patching SPA route detection.
- *
- * Journey→response stitching stays server-side (UTM backfill on response
- * create); the client's only job is delivering page views under a stable id.
- */
+
 export declare const JOURNEY_COOKIE_NAME = "surface_journey_id";
 export declare const RECENT_VISIT_COOKIE_NAME = "surface_recent_visit";
 export type JourneyTracker = {
     trackPageView: (url?: string) => Promise<void>;
-    /** Patches history + popstate; returns a teardown restoring the originals. */
+    
     observeRouteChanges: () => () => void;
-    /** Deletes both journey cookies — the native clear-on-first-step-completion hook. */
+    
     clear: () => void;
 };
 export declare const createJourneyTracker: ({ transport, environmentId, }: {
     transport: Transport;
     environmentId: string;
 }) => JourneyTracker;
-//# sourceMappingURL=journey.d.ts.map

package/dist/types/core/identity/journey.testStubs.d.ts

@@ -1,5 +1,4 @@
-/** Minimal DOM stub for journey tests: cookie jar honoring max-age deletion, location, referrer. */
+
 export declare const stubJourneyDom: ({ href }?: {
     href?: string;
 }) => Map<string, string>;
-//# sourceMappingURL=journey.testStubs.d.ts.map

package/dist/types/core/identity/leadDataCache.d.ts

@@ -1,18 +1,4 @@
-/**
- * TTL-stamped lead-identity cache (forms-sdk-plan.md row 11), byte-compatible
- * with the public tag's `surfaceLeadData` localStorage entry — same key, same
- * shape, same 10-minute TTL, same remove-on-expiry read semantics
- * (trysurface/scripts `src/lead/identify.ts`).
- *
- * Sharing the tag's key IS the interop rule (plan §4.1): on a page where the
- * tag is also installed, the SDK reads the identity the tag already resolved
- * and skips its own identify — and vice versa — so both agree on the visitor
- * without any cross-component protocol.
- *
- * Every access is guarded: no localStorage (SSR) reads as a cache miss, and
- * storage exceptions (Safari private mode, quota) are swallowed — cache loss
- * only costs an extra identify round-trip.
- */
+
 export declare const LEAD_DATA_STORAGE_KEY = "surfaceLeadData";
 export declare const LEAD_DATA_TTL_MS: number;
 export type CachedLeadData = {
@@ -24,4 +10,3 @@ export type CachedLeadData = {
 };
 export declare const readLeadData: () => CachedLeadData | null;
 export declare const writeLeadData: (data: Omit<CachedLeadData, "expiry">) => void;
-//# sourceMappingURL=leadDataCache.d.ts.map

package/dist/types/enrichment/attachEnrichment.d.ts

@@ -1,25 +1,6 @@
 import type { Transport } from "../core/client/transport";
 import type { FormEngine } from "../core/engine/formEngine";
-/**
- * Real-time identity enrichment for SDK forms (field-run finding 4.10): the
- * native renderer fires `/api/v1/services/enrichment/realtime` on blur of the
- * IdentityInfo `enrichmentSourceField` (or `websiteUrl`, or EmailForm's email)
- * and stores the result as the `selfServeEnrichment` APOLLO_EMAIL_ENRICHMENT
- * external state — which the response payload forwards as `enrichedFields`
- * and which drives field autofill. The SDK has no blur moment (headless
- * callers have no DOM at all), so the trigger is a debounced answer-watch: a
- * candidate value that is a valid email/domain and has been stable for
- * `DEBOUNCE_MS` fires once (deduped per value, native semantics); completing
- * a step flushes the pending debounce so a type-then-advance never loses the
- * window. The request is never awaited — submission must not block on the
- * vendor API — so a result can resolve after the finishing write; the engine
- * persists it anyway by amending the stored response on setExternalState.
- * Results merge existing-keys-win, exactly like native's G2 rule — a later
- * trigger only fills gaps.
- *
- * The provider key never reaches the page: the endpoint resolves it
- * server-side and is rate-limited per-IP and per-form.
- */
+
 export type EnrichmentSource = {
     questionId: string;
     fieldNames: string[];
@@ -32,4 +13,3 @@ export type AttachEnrichmentOptions = {
     sources: EnrichmentSource[];
 };
 export declare const attachEnrichment: ({ engine, transport, formId, sources, }: AttachEnrichmentOptions) => (() => void);
-//# sourceMappingURL=attachEnrichment.d.ts.map

package/dist/types/index.d.ts

@@ -1,14 +1,17 @@
 export { bindForm, type BindFormOptions } from "./bind/bindForm";
-export { mountBookingWidget, type BookingWidgetOptions } from "./bind/bookingWidget";
+export { mountBookingWidget, type BookingIdentity, type BookingWidgetEvent, type BookingWidgetOptions, } from "./bind/bookingWidget";
+export { mountScheduler } from "./bind/scheduler/mountScheduler";
+export { type MountSchedulerOptions } from "./bind/scheduler/types";
 export { createEmailValidator, type CreateEmailValidatorOptions, type EmailValidationResult, type EmailValidator, } from "./core/client/emailValidation";
 export { submitResponse, updateResponse, type CreateResponseResult } from "./core/client/responses";
-export { enrichmentSourcesOf, fetchRuntimeConfig, hasEnabledEnrichmentProvider, statefulQuestionIdsOf, statefulQuestionsOf, stepsOf, type RuntimeConfig, } from "./core/client/runtimeConfig";
+export { enrichmentSourcesOf, fetchRuntimeConfig, hasEnabledEnrichmentProvider, schedulerQuestionsOf, statefulQuestionIdsOf, statefulQuestionsOf, stepsOf, type RuntimeConfig, type SchedulerParamRef, type SchedulerQuestion, type SchedulerStateRef, } from "./core/client/runtimeConfig";
 export { createSchedulerClient, toSchedulerAnswerState, type AvailabilitySummary, type Booking, type BookingAttendee, type SchedulerClient, type TimeSlot, } from "./core/client/scheduler";
 export { DEFAULT_API_BASE_URL, createTransport, type Transport, type TransportError, type TransportResult, } from "./core/client/transport";
 export { IDENTITY_INFO_ANSWER_KEYS, type DisclaimerAnswer, type DropdownAnswer, type EmailFormAnswer, type FileUploaderAnswer, type GraphicOptionsAnswer, type IdentityInfoAnswer, type IdentityInfoAnswerKey, type KnownAnswerState, type LongInputAnswer, type MMChoiceAnswer, type MultipleChoiceAnswer, type MultipleChoiceSingleAnswerAnswer, type MultipleOptionsAnswer, type SchedulerAnswer, type ShortInputAnswer, } from "./core/engine/answerStates";
 export { createFormEngine, type FormEngine, type FormEngineEvents, type FormEngineState, type ResolveNextStep, type ResolvedNextStep, } from "./core/engine/formEngine";
 export { DEFAULT_REDIRECT_TIMEOUT_MS, buildRedirectUrl, performRedirect, type RedirectType, } from "./core/engine/redirect";
 export { buildResponsesArray, createSubmitResponsePayload, createUpdateResponsePayload, type AnswerStates, type ExternalStates, type FormResponsePayload, type FormUpdateResponsePayload, type SingleFormResponse, } from "./core/engine/responsePayload";
+export { type SchedulerBookingSummary, type SchedulerLifecycleEvent, type SchedulerProvider, } from "./core/engine/schedulerEvents";
 export { buildUrlData, constructUrlParamsObject, parseCookiesObject, type UrlData, } from "./core/engine/urlData";
 export { parsePrefillParams, parseQuestionId, type ParsedUrlQuestionId } from "./core/engine/urlPrefill";
 export { observeDropoff } from "./core/events/dropoffDetection";
@@ -25,4 +28,3 @@ export { LEAD_DATA_STORAGE_KEY, LEAD_DATA_TTL_MS, readLeadData, writeLeadData, t
 export { ENRICHMENT_STATE_ID, attachEnrichment, type AttachEnrichmentOptions, type EnrichmentSource, } from "./enrichment/attachEnrichment";
 export { SurfaceForms, type SurfaceForm, type SurfaceFormsInitOptions } from "./surfaceForms";
 export { attachEmailValidation, type AttachEmailValidationOptions } from "./validation/attachEmailValidation";
-//# sourceMappingURL=index.d.ts.map

package/dist/types/react/index.d.ts

@@ -1,2 +1 @@
 export { useSurfaceForm, type UseSurfaceFormResult } from "./useSurfaceForm";
-//# sourceMappingURL=index.d.ts.map

package/dist/types/react/useSurfaceForm.d.ts

@@ -1,14 +1,5 @@
 import type { FormEngine, FormEngineState } from "../core/engine/formEngine";
-/**
- * React adapter (forms-sdk-plan.md §2.9): a thin `useSyncExternalStore`
- * subscription over the headless engine's store contract. The host renders
- * the current step from `state` with controlled inputs; every action is the
- * engine's own method, so engine semantics are identical to the `bind/` mode
- * by construction — only who applies visibility differs.
- *
- * Server snapshots reuse `engine.state()`: the engine is SSR-safe to create
- * (no DOM access until interaction), so hydration sees the initial step.
- */
+
 export type UseSurfaceFormResult = {
     state: FormEngineState;
     setAnswer: FormEngine["setAnswer"];
@@ -22,4 +13,3 @@ export type UseSurfaceFormResult = {
     on: FormEngine["on"];
 };
 export declare const useSurfaceForm: (engine: FormEngine) => UseSurfaceFormResult;
-//# sourceMappingURL=useSurfaceForm.d.ts.map

package/dist/types/surfaceForms.d.ts

@@ -1,120 +1,75 @@
 import { type EmailValidationResult } from "./core/client/emailValidation";
 import { type RuntimeConfig } from "./core/client/runtimeConfig";
+import { type Transport } from "./core/client/transport";
 import { type FormEngine, type ResolveNextStep } from "./core/engine/formEngine";
 import type { LeadSource } from "./core/identity/identify";
 import { type TrackingSettings } from "./tracking/attachTracking";
-/**
- * The public entry point (forms-sdk-plan.md §2.2): composes the boot sequence
- * in the native, load-bearing order — identify before the first write (row
- * 60: attribute sync silently no-ops otherwise) — then wires events, journey,
- * drop-off, and the optional DOM binding around one engine instance.
- *
- * **The form definition boots from the runtime-config endpoint** (§2.3,
- * Decisions #7): when `steps` is omitted, init fetches the published record
- * and derives the step order, the behavioral settings gates, and the expected
- * questionIds for the §4.3 drift warning. Caller-provided `steps`/`settings`/
- * `expectedQuestionIds` still win — offline tests and agents that already
- * hold the record skip the fetch entirely.
- *
- * `preview: true` replicates the native guarantee that previews never pollute
- * data (§2.2): identify, response writes, pushEvents, form-journey, and the
- * journey module are all blocked client-side.
- */
+
 export type SurfaceFormsInitOptions = {
     environmentId: string;
     formId: string;
-    /** Ordered logical steps of the form record; omitted = fetched from runtime-config. */
+    
     steps?: Array<{
         id: string;
         endStepKind?: "thank_you" | "disqualified";
     }>;
-    /**
-     * Behavioral gates + customer-tag config (rows 51–55). Omitted values fill
-     * from runtime-config ONLY when `steps` is also omitted (the record fetch) —
-     * caller-provided `steps` skip the fetch entirely, so pass tracking settings
-     * explicitly in that offline mode.
-     */
+    
     settings?: {
         trackPartialResponses?: boolean;
         trackCookies?: boolean;
     } & TrackingSettings;
     apiBaseUrl?: string;
-    /** Enables the bind/ layer + view detection on this root. */
+    
     container?: Element;
-    /** Stateful questionIds from the record; unbound ones get the §4.3 runtime warning. */
+    
     expectedQuestionIds?: string[];
-    /** Routing evaluation; defaults to linear order until the extracted routing module lands. */
+    
     resolveNextStep?: ResolveNextStep;
-    /** Seeds a URL_DATA external-state entry under this id (attribution, row 56). */
+    
     urlDataStateId?: string;
     source?: LeadSource;
-    /** Page-view tracking module (tag parity), default off. */
+    
     journey?: boolean;
-    /**
-     * Automatic waterfall email validation (row 37), default off: watches
-     * email answers (debounced, per-address verdicts, fail-open) and annotates
-     * the response `meta` with native's `isEmailValid`/`emailValidation`/
-     * `emailValidationFailed` keys. Opt-in because verdicts spend the form
-     * owner's validator quota. The on-demand `validateEmail` on the handle is
-     * always available and shares the same per-address cache.
-     */
+    
     emailValidation?: boolean;
     preview?: boolean;
-    /**
-     * Signed token from the create_form / get_sdk_binding_map replies; with
-     * `preview: true` it unlocks the DRAFT config of a never-published form.
-     * Without it, preview serves the published config.
-     */
+    
     previewToken?: string;
-    /**
-     * Resume a stored response: pass the `responseId` + `resumeToken` pair a
-     * previous session's create returned (`state().resumeToken`, or the `saved`
-     * event). Boot fetches the stored answers through the token-gated read-back
-     * and seeds the engine — writes become updates and earlier answers are
-     * preserved; a failed fetch warns and starts fresh. Ignored in preview.
-     */
+    
     resume?: {
         responseId: string;
         resumeToken: string;
     };
-    /** Logs every captured answer and warns on states the server would reject (unknown questionId, wrong/missing type, malformed choices). Development aid; never enable in production. */
+    
     debug?: boolean;
     meta?: Record<string, unknown>;
 };
-export type SurfaceForm = Pick<FormEngine, "setAnswer" | "setExternalState" | "next" | "back" | "goToStep" | "submit" | "disqualify" | "savePartial" | "flush" | "markViewed" | "on" | "state" | "subscribe"> & {
-    /** Re-runs identify (e.g. after an SPA route change); cache makes it cheap. */
+export type SurfaceForm = Pick<FormEngine, "setAnswer" | "setExternalState" | "next" | "back" | "goToStep" | "submit" | "disqualify" | "savePartial" | "notifyScheduler" | "flush" | "markViewed" | "on" | "state" | "subscribe"> & {
+    
     identify: () => Promise<unknown>;
-    /**
-     * On-demand waterfall email validation (row 37): resolves a per-address
-     * deliverability verdict, cached for the form's lifetime and fail-open on
-     * validator outage. Use it to gate your own navigation:
-     * `if ((await form.validateEmail(value)).isValid) form.next()`.
-     * In preview it resolves a synthetic valid verdict without network.
-     */
+    
     validateEmail: (email: string) => Promise<EmailValidationResult>;
-    /**
-     * Records caller-computed values (a qualification score, an A/B bucket, …)
-     * onto the response `meta` — they ride the next save, or amend the stored
-     * response when the form already finished. SDK-owned keys
-     * (`surfaceTagStatus` and the email-validation verdicts) are dropped with a
-     * console warning: dashboards trust those.
-     */
+    
     mergeMeta: (partial: Record<string, unknown>) => void;
-    /**
-     * What actually runs in THIS environment — the record can declare features
-     * (an enrichment source field) that the environment does not back with a
-     * provider, and nothing else surfaces that.
-     */
+    
     capabilities: {
         enrichment: boolean;
         emailValidation: boolean;
         tracking: boolean;
     };
-    /** The fetched published record (labels, component types); undefined when `steps` was caller-provided. */
+    
     runtimeConfig?: RuntimeConfig;
+    
+    transport: Transport;
+    
+    identity: () => {
+        fingerprint?: string;
+        leadSessionId?: string;
+        leadId?: string;
+    };
+    preview: boolean;
     destroy: () => void;
 };
 export declare const SurfaceForms: {
     init: ({ environmentId, formId, steps, settings, apiBaseUrl, container, expectedQuestionIds, resolveNextStep, urlDataStateId, source, journey, emailValidation, preview, previewToken, debug, resume, meta, }: SurfaceFormsInitOptions) => Promise<SurfaceForm>;
 };
-//# sourceMappingURL=surfaceForms.d.ts.map

package/dist/types/tracking/attachTracking.d.ts

@@ -1,27 +1,7 @@
 import type { FormEngine } from "../core/engine/formEngine";
 import { type AdConversionRule } from "./conversionRules";
 import { type VendorSettings } from "./vendors";
-/**
- * Phase-2 tracking runtime (forms-sdk-plan.md rows 51–55): binds one engine
- * instance to the customer-tag lifecycle events and the ad-conversion rule
- * engine. Trigger moments mirror `useConversionRules`' semantics translated
- * from React effects to engine events:
- *
- * - `form_started`: the response row landing (first `saved`) in a session that
- *   began without a responseId — a resume never refires.
- * - `step_submitted`: the first `stepCompleted` of the session.
- * - `reached_step`: every step that becomes current (including the initial
- *   one), once per step — back-nav never refires.
- * - terminal (`reached_qualified` + `form_submitted` union, deduped by rule):
- *   the `completed` event; a disqualified finish never fires.
- * - `email_provided` / `meeting_booked`: first non-empty email answer / first
- *   scheduler state with `eventScheduled` — detected via `subscribe`.
- *
- * Every rule fires once per instance; `responseId` stays the platform-side
- * dedupe key, so moments reached before the first write queue and flush when
- * `saved` delivers the id (native's pending-refs, minus the React plumbing).
- * All state is instance-scoped (§2.7) — two forms on one page track separately.
- */
+
 export type TrackingSettings = VendorSettings & {
     adsConversions?: AdConversionRule[];
 };
@@ -32,4 +12,3 @@ export type AttachTrackingOptions = {
     win?: Window;
 };
 export declare const attachTracking: ({ engine, formId, settings, win }: AttachTrackingOptions) => (() => void);
-//# sourceMappingURL=attachTracking.d.ts.map