@parag.more.withsurface.com/forms-sdk 0.1.4 → 0.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -4
- package/dist/index.cjs +1 -2737
- package/dist/index.mjs +1 -2714
- package/dist/react/index.cjs +1 -44
- package/dist/react/index.mjs +1 -21
- package/dist/surface-forms-sdk.min.js +21 -2
- package/dist/types/bind/bindForm.d.ts +2 -36
- package/dist/types/bind/bookingWidget.d.ts +29 -17
- package/dist/types/bind/scheduler/embedUtils.d.ts +50 -0
- package/dist/types/bind/scheduler/mountScheduler.d.ts +2 -0
- package/dist/types/bind/scheduler/providers/cal.d.ts +3 -0
- package/dist/types/bind/scheduler/providers/calendly.d.ts +3 -0
- package/dist/types/bind/scheduler/providers/chilical.d.ts +3 -0
- package/dist/types/bind/scheduler/providers/clari.d.ts +3 -0
- package/dist/types/bind/scheduler/providers/hubspot.d.ts +3 -0
- package/dist/types/bind/scheduler/providers/index.d.ts +4 -0
- package/dist/types/bind/scheduler/providers/reclaimai.d.ts +3 -0
- package/dist/types/bind/scheduler/providers/revenuehero.d.ts +3 -0
- package/dist/types/bind/scheduler/providers/savvycal.d.ts +3 -0
- package/dist/types/bind/scheduler/providers/surface.d.ts +3 -0
- package/dist/types/bind/scheduler/providers/zoom.d.ts +3 -0
- package/dist/types/bind/scheduler/styles.d.ts +3 -0
- package/dist/types/bind/scheduler/types.d.ts +65 -0
- package/dist/types/core/client/emailValidation.d.ts +3 -4
- package/dist/types/core/client/responses.d.ts +3 -15
- package/dist/types/core/client/runtimeConfig.d.ts +40 -32
- package/dist/types/core/client/scheduler.d.ts +4 -27
- package/dist/types/core/client/transport.d.ts +4 -28
- package/dist/types/core/engine/answerAudit.d.ts +3 -12
- package/dist/types/core/engine/answerStates.d.ts +4 -17
- package/dist/types/core/engine/formEngine.d.ts +16 -53
- package/dist/types/core/engine/redirect.d.ts +1 -23
- package/dist/types/core/engine/responsePayload.d.ts +4 -28
- package/dist/types/core/engine/schedulerEvents.d.ts +40 -0
- package/dist/types/core/engine/urlData.d.ts +2 -17
- package/dist/types/core/engine/urlPrefill.d.ts +1 -9
- package/dist/types/core/events/dropoffDetection.d.ts +1 -14
- package/dist/types/core/events/emitter.d.ts +1 -17
- package/dist/types/core/events/formJourneyTracker.d.ts +1 -19
- package/dist/types/core/events/pushEvents.d.ts +2 -16
- package/dist/types/core/events/startedDetection.d.ts +1 -10
- package/dist/types/core/events/viewDetection.d.ts +1 -14
- package/dist/types/core/identity/browserFingerprint.d.ts +3 -19
- package/dist/types/core/identity/ensureIdentified.d.ts +1 -16
- package/dist/types/core/identity/identify.d.ts +1 -15
- package/dist/types/core/identity/journey.d.ts +3 -16
- package/dist/types/core/identity/journey.testStubs.d.ts +1 -2
- package/dist/types/core/identity/leadDataCache.d.ts +1 -16
- package/dist/types/enrichment/attachEnrichment.d.ts +1 -21
- package/dist/types/index.d.ts +5 -3
- package/dist/types/react/index.d.ts +0 -1
- package/dist/types/react/useSurfaceForm.d.ts +1 -11
- package/dist/types/surfaceForms.d.ts +28 -73
- package/dist/types/tracking/attachTracking.d.ts +1 -22
- package/dist/types/tracking/conversionRules.d.ts +3 -12
- package/dist/types/tracking/vendors.d.ts +3 -22
- package/dist/types/validation/attachEmailValidation.d.ts +0 -1
- package/docs/api.md +51 -39
- package/docs/reference/binding.md +86 -13
- package/docs/reference/clients.md +21 -1
- package/docs/reference/engine.md +5 -1
- package/docs/reference/events.md +4 -1
- package/docs/reference/identity.md +2 -3
- package/llms.txt +58 -10
- package/package.json +1 -1
- package/skills/surface-forms-sdk/SKILL.md +19 -6
- package/skills/surface-forms-sdk/patterns.md +30 -5
- package/dist/index.cjs.map +0 -7
- package/dist/index.mjs.map +0 -7
- package/dist/react/index.cjs.map +0 -7
- package/dist/react/index.mjs.map +0 -7
- package/dist/surface-forms-sdk.min.js.map +0 -7
- package/dist/types/bind/bindForm.d.ts.map +0 -1
- package/dist/types/bind/bindForm.test.d.ts +0 -2
- package/dist/types/bind/bindForm.test.d.ts.map +0 -1
- package/dist/types/bind/bookingWidget.d.ts.map +0 -1
- package/dist/types/bind/bookingWidget.test.d.ts +0 -2
- package/dist/types/bind/bookingWidget.test.d.ts.map +0 -1
- package/dist/types/core/client/emailValidation.d.ts.map +0 -1
- package/dist/types/core/client/emailValidation.test.d.ts +0 -2
- package/dist/types/core/client/emailValidation.test.d.ts.map +0 -1
- package/dist/types/core/client/responses.d.ts.map +0 -1
- package/dist/types/core/client/responses.test.d.ts +0 -2
- package/dist/types/core/client/responses.test.d.ts.map +0 -1
- package/dist/types/core/client/runtimeConfig.contract.test.d.ts +0 -2
- package/dist/types/core/client/runtimeConfig.contract.test.d.ts.map +0 -1
- package/dist/types/core/client/runtimeConfig.d.ts.map +0 -1
- package/dist/types/core/client/runtimeConfig.test.d.ts +0 -2
- package/dist/types/core/client/runtimeConfig.test.d.ts.map +0 -1
- package/dist/types/core/client/scheduler.contract.test.d.ts +0 -2
- package/dist/types/core/client/scheduler.contract.test.d.ts.map +0 -1
- package/dist/types/core/client/scheduler.d.ts.map +0 -1
- package/dist/types/core/client/scheduler.test.d.ts +0 -2
- package/dist/types/core/client/scheduler.test.d.ts.map +0 -1
- package/dist/types/core/client/transport.d.ts.map +0 -1
- package/dist/types/core/client/transport.test.d.ts +0 -2
- package/dist/types/core/client/transport.test.d.ts.map +0 -1
- package/dist/types/core/engine/answerAudit.d.ts.map +0 -1
- package/dist/types/core/engine/answerAudit.test.d.ts +0 -2
- package/dist/types/core/engine/answerAudit.test.d.ts.map +0 -1
- package/dist/types/core/engine/answerStates.contract.test.d.ts +0 -2
- package/dist/types/core/engine/answerStates.contract.test.d.ts.map +0 -1
- package/dist/types/core/engine/answerStates.d.ts.map +0 -1
- package/dist/types/core/engine/formEngine.d.ts.map +0 -1
- package/dist/types/core/engine/formEngine.test.d.ts +0 -2
- package/dist/types/core/engine/formEngine.test.d.ts.map +0 -1
- package/dist/types/core/engine/redirect.d.ts.map +0 -1
- package/dist/types/core/engine/redirect.test.d.ts +0 -2
- package/dist/types/core/engine/redirect.test.d.ts.map +0 -1
- package/dist/types/core/engine/responsePayload.contract.test.d.ts +0 -2
- package/dist/types/core/engine/responsePayload.contract.test.d.ts.map +0 -1
- package/dist/types/core/engine/responsePayload.d.ts.map +0 -1
- package/dist/types/core/engine/responsePayload.test.d.ts +0 -2
- package/dist/types/core/engine/responsePayload.test.d.ts.map +0 -1
- package/dist/types/core/engine/urlData.contract.test.d.ts +0 -2
- package/dist/types/core/engine/urlData.contract.test.d.ts.map +0 -1
- package/dist/types/core/engine/urlData.d.ts.map +0 -1
- package/dist/types/core/engine/urlData.test.d.ts +0 -2
- package/dist/types/core/engine/urlData.test.d.ts.map +0 -1
- package/dist/types/core/engine/urlPrefill.d.ts.map +0 -1
- package/dist/types/core/engine/urlPrefill.test.d.ts +0 -2
- package/dist/types/core/engine/urlPrefill.test.d.ts.map +0 -1
- package/dist/types/core/events/dropoffDetection.d.ts.map +0 -1
- package/dist/types/core/events/dropoffDetection.test.d.ts +0 -2
- package/dist/types/core/events/dropoffDetection.test.d.ts.map +0 -1
- package/dist/types/core/events/emitter.d.ts.map +0 -1
- package/dist/types/core/events/emitter.test.d.ts +0 -2
- package/dist/types/core/events/emitter.test.d.ts.map +0 -1
- package/dist/types/core/events/formJourneyTracker.contract.test.d.ts +0 -2
- package/dist/types/core/events/formJourneyTracker.contract.test.d.ts.map +0 -1
- package/dist/types/core/events/formJourneyTracker.d.ts.map +0 -1
- package/dist/types/core/events/formJourneyTracker.test.d.ts +0 -2
- package/dist/types/core/events/formJourneyTracker.test.d.ts.map +0 -1
- package/dist/types/core/events/pushEvents.contract.test.d.ts +0 -2
- package/dist/types/core/events/pushEvents.contract.test.d.ts.map +0 -1
- package/dist/types/core/events/pushEvents.d.ts.map +0 -1
- package/dist/types/core/events/pushEvents.test.d.ts +0 -2
- package/dist/types/core/events/pushEvents.test.d.ts.map +0 -1
- package/dist/types/core/events/startedDetection.d.ts.map +0 -1
- package/dist/types/core/events/startedDetection.test.d.ts +0 -2
- package/dist/types/core/events/startedDetection.test.d.ts.map +0 -1
- package/dist/types/core/events/viewDetection.d.ts.map +0 -1
- package/dist/types/core/events/viewDetection.test.d.ts +0 -2
- package/dist/types/core/events/viewDetection.test.d.ts.map +0 -1
- package/dist/types/core/identity/browserFingerprint.d.ts.map +0 -1
- package/dist/types/core/identity/browserFingerprint.test.d.ts +0 -2
- package/dist/types/core/identity/browserFingerprint.test.d.ts.map +0 -1
- package/dist/types/core/identity/ensureIdentified.d.ts.map +0 -1
- package/dist/types/core/identity/ensureIdentified.test.d.ts +0 -2
- package/dist/types/core/identity/ensureIdentified.test.d.ts.map +0 -1
- package/dist/types/core/identity/identify.contract.test.d.ts +0 -2
- package/dist/types/core/identity/identify.contract.test.d.ts.map +0 -1
- package/dist/types/core/identity/identify.d.ts.map +0 -1
- package/dist/types/core/identity/identify.test.d.ts +0 -2
- package/dist/types/core/identity/identify.test.d.ts.map +0 -1
- package/dist/types/core/identity/journey.contract.test.d.ts +0 -2
- package/dist/types/core/identity/journey.contract.test.d.ts.map +0 -1
- package/dist/types/core/identity/journey.d.ts.map +0 -1
- package/dist/types/core/identity/journey.test.d.ts +0 -2
- package/dist/types/core/identity/journey.test.d.ts.map +0 -1
- package/dist/types/core/identity/journey.testStubs.d.ts.map +0 -1
- package/dist/types/core/identity/leadDataCache.d.ts.map +0 -1
- package/dist/types/core/identity/leadDataCache.test.d.ts +0 -2
- package/dist/types/core/identity/leadDataCache.test.d.ts.map +0 -1
- package/dist/types/enrichment/attachEnrichment.d.ts.map +0 -1
- package/dist/types/enrichment/attachEnrichment.test.d.ts +0 -2
- package/dist/types/enrichment/attachEnrichment.test.d.ts.map +0 -1
- package/dist/types/index.d.ts.map +0 -1
- package/dist/types/react/index.d.ts.map +0 -1
- package/dist/types/react/ssr.test.d.ts +0 -2
- package/dist/types/react/ssr.test.d.ts.map +0 -1
- package/dist/types/react/useSurfaceForm.d.ts.map +0 -1
- package/dist/types/react/useSurfaceForm.test.d.ts +0 -2
- package/dist/types/react/useSurfaceForm.test.d.ts.map +0 -1
- package/dist/types/surfaceForms.d.ts.map +0 -1
- package/dist/types/surfaceForms.test.d.ts +0 -2
- package/dist/types/surfaceForms.test.d.ts.map +0 -1
- package/dist/types/tracking/attachTracking.d.ts.map +0 -1
- package/dist/types/tracking/attachTracking.test.d.ts +0 -2
- package/dist/types/tracking/attachTracking.test.d.ts.map +0 -1
- package/dist/types/tracking/conversionRules.contract.test.d.ts +0 -2
- package/dist/types/tracking/conversionRules.contract.test.d.ts.map +0 -1
- package/dist/types/tracking/conversionRules.d.ts.map +0 -1
- package/dist/types/tracking/conversionRules.test.d.ts +0 -2
- package/dist/types/tracking/conversionRules.test.d.ts.map +0 -1
- package/dist/types/tracking/vendors.d.ts.map +0 -1
- package/dist/types/tracking/vendors.test.d.ts +0 -2
- package/dist/types/tracking/vendors.test.d.ts.map +0 -1
- package/dist/types/validation/attachEmailValidation.d.ts.map +0 -1
- package/dist/types/validation/attachEmailValidation.test.d.ts +0 -2
- package/dist/types/validation/attachEmailValidation.test.d.ts.map +0 -1
package/README.md
CHANGED
|
@@ -4,10 +4,10 @@ Build Surface forms as **your own pages**. The form record on Surface stays the
|
|
|
4
4
|
data model — steps, questions, validation, enrichment, tracking settings — while
|
|
5
5
|
your HTML/CSS/JS owns every pixel and every navigation decision. The SDK binds
|
|
6
6
|
the two: a headless, dependency-free engine over Surface's public runtime
|
|
7
|
-
endpoints, a `data-*` DOM binding layer, a React adapter,
|
|
8
|
-
|
|
9
|
-
(GTM/GA4/Meta/HubSpot +
|
|
10
|
-
dependencies.
|
|
7
|
+
endpoints, a `data-*` DOM binding layer, a React adapter, embedded schedulers
|
|
8
|
+
(Surface's own + every provider native forms support) with automatic booking
|
|
9
|
+
tracking, and settings-driven tag/conversion tracking (GTM/GA4/Meta/HubSpot +
|
|
10
|
+
ad conversions). ~22 kB gzipped, zero runtime dependencies.
|
|
11
11
|
|
|
12
12
|
> **Working with an AI agent?** This package ships agent-ready docs:
|
|
13
13
|
> [`llms.txt`](llms.txt) is the binding contract and boot guide,
|
|
@@ -44,6 +44,11 @@ Highlights beyond binding:
|
|
|
44
44
|
|
|
45
45
|
- **Headless + React** — drive everything with `setAnswer`/`submit`/`state`,
|
|
46
46
|
or `useSurfaceForm` from `<package>/react`.
|
|
47
|
+
- **Embedded schedulers** — `mountScheduler({ form, container })` renders the
|
|
48
|
+
record's scheduler (Surface, Calendly, Cal.com, SavvyCal, Chili Piper,
|
|
49
|
+
HubSpot, RevenueHero, Zoom, Reclaim.ai, Clari), tracks the booking lifecycle
|
|
50
|
+
on `form.on("scheduler")`, and persists the booking automatically; an
|
|
51
|
+
unstyled widget remains for fully custom booking UIs.
|
|
47
52
|
- **Resume** — persist the `saved` event's `{ responseId, resumeToken }` and
|
|
48
53
|
pass `resume:` to continue a response later.
|
|
49
54
|
- **Email validation** — `form.validateEmail()` on demand, or
|