@forgebuild/sidon-booking-widget 2.0.0 → 3.0.0

package/README.md

@@ -215,12 +215,14 @@ an HTML tag. Without a bundler, load `dist/sidon-booking-widget.js` with `<scrip
 The wizard has four steps:
 
 1. **Documents**: the sailor's documents, held once for all marinas. The guest signs in with Sidon
-   (Clerk), and the step shows which of the marina's requirements are met and lets them upload
+   (a popup on Sidon's site), and the step shows which of the marina's requirements are met and lets them upload
    what's missing. Uploads go straight to OTA, not through your forwarder. *Next* unlocks once
    OTA says the requirements pass for the stay's dates.
    - It applies only where OTA has switched on the marina's `sailor_documents`. Other marinas keep
-     the per-booking upload on [the booking page](#the-booking-page).
-   - It needs `clerk-publishable-key`; see [Documents setup](#documents-setup).
+     the per-booking upload on [the booking page](#the-booking-page), and the wizard skips this
+     step: it opens on Details and the stepper shows 1 Details, 2 Payment, 3 Booking. Events
+     still carry the step numbers below (Details is `2`).
+   - It needs `sailor-api-origin`; see [Documents setup](#documents-setup).
 2. **Details**: dates, boat length and berth (with an optional map), then the guest's contact and
    boat details. *Next* puts a 30-minute hold on the berth.
 3. **Payment**: Stripe's Payment Element. The card is authorised at this step and captured when the
@@ -247,7 +249,7 @@ shows the booking view again, with a *Start a new booking* action.
 | `currency-symbol` | `''` | When empty, amounts are formatted in the marina's currency with `Intl.NumberFormat`. Set it, to `$` for example, to show that fixed symbol before amounts instead. |
 | `variant` | `navy` | `navy` or `dark`; see [Theming](#theming). |
 | `booking-id` | absent | When present, the element is in [booking-page mode](#the-booking-page). A value overrides the booking id in the URL. |
-| `clerk-publishable-key` | `''` | The site's own Clerk publishable key (`pk_…`), for the Documents step's sign-in. Each site has its own Clerk application; see [Documents setup](#documents-setup). Clerk loads from that application's Frontend API. |
+| `sidon-origin` | `https://marina.sidonmarine.uk` | Where the Documents step's *Sign in with Sidon* popup opens; see [Documents setup](#documents-setup). Override only to test against another Sidon. |
 | `sailor-api-origin` | `''` | OTA's origin, where the Documents step uploads to (`/api/sailor/documents`). Uploads don't go through the forwarder. |
 | `maps-api-key` | | Google Maps JS API key. The map renders only when this is set. It never renders on step 4 or in booking-page mode. |
 | `map-style` | `chart` | `chart` (buoy circles) or `coastal` (SVG pontoon overlays). |
@@ -275,18 +277,21 @@ root and can be caught anywhere on the page:
 
 ### Documents setup
 
+Sign-in is Sidon's, not the site's: *Sign in with Sidon* opens a popup on Sidon's `/connect` page,
+and the sailor signs in (or signs up) with their Sidon account there. The popup hands the widget a
+sailor token, which it keeps for the browser tab. The site has no auth setup of its own.
+
 Per site:
 
-1. Create a Clerk application for the site and add the site's domain to it.
-2. Add that application's secret key to OTA's `SAILOR_CLERK_SECRET_KEYS` (a comma-separated list).
-3. Upgrade the widget and the forwarder, then set `clerk-publishable-key` and `sailor-api-origin`
-   on the element. `sailor-api-origin` is required whenever the key is set. Sign-in now works as
-   an optional step.
-4. On OTA, switch on the marina's `sailor_documents`, last, and only once every site booking that
-   marina runs the new widget. Switching it on earlier shows guests "Sign-in is unavailable" and
-   gives 1.x sites a raw "Sign in required".
+1. Ask Sidon to add the site's origin (e.g. `https://www.example.com`) to `CONNECT_ORIGINS`. The
+   popup refuses any other origin.
+2. Upgrade the widget and the forwarder, then set `sailor-api-origin` on the element.
+3. On OTA, switch on the marina's `sailor_documents`, last, and only once every site booking that
+   marina runs the new widget. 1.x sites get a raw "Sign in required" once it's on.
 
-The site's Clerk application must require an email address.
+`sidon-origin` points the popup at another Sidon (a local or staging one); leave it unset in
+production. Sidon's Clerk instance needs the `ota` JWT template (claims `email` and `name`), and
+OTA's `SAILOR_CLERK_SECRET_KEYS` must hold that instance's secret key.
 
 The forwarder forwards the `X-Sailor-Token` header, so update `@forgebuild/sidon-booking-widget`
 in the forwarder's project too.
@@ -526,7 +531,7 @@ between two styles:
 The wizard gained a first step, so the step numbers moved: 1 Documents, 2 Details, 3 Payment,
 4 Booking. **This breaks hosts listening to `sidon-step-change`** (and anything keyed on step 3
 being the booking), so it ships as a major version. Update those listeners, and set
-`clerk-publishable-key` and `sailor-api-origin` ([Documents setup](#documents-setup)). On
+`sailor-api-origin` ([Documents setup](#documents-setup)). On
 [the booking page](#the-booking-page), marinas on sailor documents no longer show the per-booking
 upload.
 

package/dist/elements.d.ts

@@ -62,8 +62,8 @@ export interface SidonBookingWidgetElement extends HTMLElement {
   logoMark?: string | null;
   marinaName?: string;
   otherMarinas?: OtherMarina[];
-  /** The site's own Clerk publishable key (Sidon sign-in on the Documents step). */
-  clerkPublishableKey?: string;
+  /** Sidon's origin for the Documents step's sign-in popup; defaults to https://marina.sidonmarine.uk. */
+  sidonOrigin?: string;
   /** Origin serving OTA's /api/sailor/documents; '' (default) = this page's origin. */
   sailorApiOrigin?: string;
 }