@forgebuild/sidon-booking-widget 4.0.4 → 4.1.1

package/dist/elements.d.ts

@@ -1,124 +1,127 @@
-// Hand-written typings for <sidon-booking-widget> and <sidon-berth-map>.
-// The entry modules only register the elements (side-effect imports), so
-// generated declarations come out as an empty `export {}`. The build copies
-// this file verbatim to dist/elements.d.ts and both entry .d.ts files
-// re-export it (scripts/write-element-types.mjs), which is why it imports
-// nothing: a relative import would dangle in dist/.
-//
-// Keep it in step with the `props` blocks in BookingWidget.svelte and
-// BerthMap.svelte and the events they emit. `npm run check` skips .d.ts
-// files (skipLibCheck), so check an edit with:
-//   npx tsc --ignoreConfig --noEmit --skipLibCheck false --lib es2023,dom src/elements.d.ts
-
-/** Peer-marina logo pin. Mirrors OtherMarina in lib/types.ts. */
-export interface OtherMarina {
-  name: string;
-  lat: number;
-  lng: number;
-  logoMark: string | null;
-  /** Always host-supplied: the package owns no site's routing. */
-  href: string | null;
-}
-
-/** OTA booking status. An expired booking reports `cancelled`. */
-export type SidonBookingStatus = 'hold' | 'pending' | 'confirmed' | 'declined' | 'cancelled';
-
-/** 1 Documents, 2 Details, 3 Payment, 4 Booking. */
-export interface SidonStepChangeDetail { step: 1 | 2 | 3 | 4 }
-/** The booking widget fires this from the wizard only, never in booking-page mode. */
-export interface SidonLoaChangeDetail { loa: number }
-/** `bookingId` is OTA's booking UUID, `marina` the marina slug. */
-export interface SidonBookedDetail { bookingId: string; marina: string }
-export interface SidonBookingStatusDetail { bookingId: string; status: SidonBookingStatus }
-/** A berth label, or null when deselected. */
-export interface SidonBerthSelectedDetail { berthId: string | null }
-/** Dates are `YYYY-MM-DD`; `berth` is a berth label. */
-export interface SidonQuickbookSubmitDetail { from: string | null; to: string | null; length: number; berth: string | null }
-
-// Element properties mirror the attributes, camelCased; optional like them.
-export interface SidonBookingWidgetElement extends HTMLElement {
-  /** OTA marina slug. */
-  marina?: string;
-  /** '' (default) = this page's origin, where the forwarder route lives. */
-  apiOrigin?: string;
-  from?: string;
-  to?: string;
-  length?: number;
-  berth?: string;
-  /** en/it/fr/es (first two letters). Unset: the wizard is English and the
-      booking page follows the booking's own locale. */
-  locale?: string;
-  currencySymbol?: string;
-  variant?: 'navy' | 'dark';
-  /** Present (even empty) = booking-page mode; a value overrides `?booking=`. */
-  bookingId?: string | null;
-  mapsApiKey?: string;
-  mapStyle?: 'chart' | 'coastal';
-  mapHeight?: string;
-  mapWidth?: string;
-  mapGap?: string;
-  width?: string;
-  layout?: 'stacked' | 'overlay';
-  logoMark?: string | null;
-  marinaName?: string;
-  otherMarinas?: OtherMarina[];
-  /** Sidon's origin for the Documents step's sign-in popup; defaults to https://sidonmarine.uk. */
-  sidonOrigin?: string;
-  /** Origin serving OTA's /api/sailor/documents; '' (default) = this page's origin. */
-  sailorApiOrigin?: string;
-}
-
-export interface SidonBerthMapElement extends HTMLElement {
-  /** OTA marina slug. */
-  marina?: string;
-  mapsApiKey?: string;
-  /** '' (default) = this page's origin, where the forwarder route lives. */
-  apiOrigin?: string;
-  mapStyle?: 'chart' | 'coastal';
-  locale?: string;
-  currencySymbol?: string;
-  from?: string;
-  to?: string;
-  length?: number;
-  berth?: string;
-  /** 'staff' (the OTA dashboard): every listed berth is clickable and fires
-      sidon-berth-selected, occupied berths are painted for [from, to), and
-      from/to follow their attributes. No card, availability or boat-length
-      checks. Default 'guest'. */
-  mode?: 'guest' | 'staff';
-  /** Re-reads the map payload. Undefined until the element has mounted
-      (a microtask after it is connected), so call `el.refresh?.()`. */
-  readonly refresh?: () => void;
-  bookPath?: string;
-  logoMark?: string | null;
-  marinaName?: string;
-  otherMarinas?: OtherMarina[];
-  mapHeight?: string;
-  showWeather?: boolean;
-  eyebrow?: string;
-  cardTitle?: string;
-  intro?: string;
-  rangeLabel?: string;
-  rangePlaceholder?: string;
-  lengthLabel?: string;
-  selectedLabel?: string;
-  selectedPlaceholder?: string;
-  ctaLabel?: string;
-}
-
-declare global {
-  interface HTMLElementTagNameMap {
-    'sidon-booking-widget': SidonBookingWidgetElement;
-    'sidon-berth-map': SidonBerthMapElement;
-  }
-  // Dispatched with bubbles + composed, so listeners on any ancestor
-  // element get the typed detail too.
-  interface HTMLElementEventMap {
-    'sidon-step-change': CustomEvent<SidonStepChangeDetail>;
-    'sidon-loa-change': CustomEvent<SidonLoaChangeDetail>;
-    'sidon-booked': CustomEvent<SidonBookedDetail>;
-    'sidon-booking-status': CustomEvent<SidonBookingStatusDetail>;
-    'sidon-berth-selected': CustomEvent<SidonBerthSelectedDetail>;
-    'sidon-quickbook-submit': CustomEvent<SidonQuickbookSubmitDetail>;
-  }
-}
+// Hand-written typings for <sidon-booking-widget> and <sidon-berth-map>.
+// The entry modules only register the elements (side-effect imports), so
+// generated declarations come out as an empty `export {}`. The build copies
+// this file verbatim to dist/elements.d.ts and both entry .d.ts files
+// re-export it (scripts/write-element-types.mjs), which is why it imports
+// nothing: a relative import would dangle in dist/.
+//
+// Keep it in step with the `props` blocks in BookingWidget.svelte and
+// BerthMap.svelte and the events they emit. `npm run check` skips .d.ts
+// files (skipLibCheck), so check an edit with:
+//   npx tsc --ignoreConfig --noEmit --skipLibCheck false --lib es2023,dom src/elements.d.ts
+
+/** Peer-marina logo pin. Mirrors OtherMarina in lib/types.ts. */
+export interface OtherMarina {
+  name: string;
+  lat: number;
+  lng: number;
+  logoMark: string | null;
+  /** Always host-supplied: the package owns no site's routing. */
+  href: string | null;
+}
+
+/** OTA booking status. An expired booking reports `cancelled`. */
+export type SidonBookingStatus = 'hold' | 'pending' | 'confirmed' | 'declined' | 'cancelled';
+
+/** 1 Documents, 2 Details, 3 Payment, 4 Booking. */
+export interface SidonStepChangeDetail { step: 1 | 2 | 3 | 4 }
+/** The booking widget fires this from the wizard only, never in booking-page mode. */
+export interface SidonLoaChangeDetail { loa: number }
+/** `bookingId` is OTA's booking UUID, `marina` the marina slug. */
+export interface SidonBookedDetail { bookingId: string; marina: string }
+export interface SidonBookingStatusDetail { bookingId: string; status: SidonBookingStatus }
+/** A berth label, or null when deselected. */
+export interface SidonBerthSelectedDetail { berthId: string | null }
+/** Dates are `YYYY-MM-DD`; `berth` is a berth label. */
+export interface SidonQuickbookSubmitDetail { from: string | null; to: string | null; length: number; berth: string | null }
+
+// Element properties mirror the attributes, camelCased; optional like them.
+export interface SidonBookingWidgetElement extends HTMLElement {
+  /** OTA marina slug. */
+  marina?: string;
+  /** '' (default) = this page's origin, where the forwarder route lives. */
+  apiOrigin?: string;
+  from?: string;
+  to?: string;
+  length?: number;
+  berth?: string;
+  /** en/it/fr/es (first two letters). Unset: the wizard is English and the
+      booking page follows the booking's own locale. */
+  locale?: string;
+  currencySymbol?: string;
+  variant?: 'navy' | 'dark';
+  /** Present (even empty) = booking-page mode; a value overrides `?booking=`. */
+  bookingId?: string | null;
+  mapsApiKey?: string;
+  mapStyle?: 'chart' | 'coastal';
+  mapHeight?: string;
+  mapWidth?: string;
+  mapGap?: string;
+  width?: string;
+  layout?: 'stacked' | 'overlay';
+  logoMark?: string | null;
+  marinaName?: string;
+  otherMarinas?: OtherMarina[];
+  /** Sidon's origin for the Documents step's sign-in popup; defaults to https://sidonmarine.uk. */
+  sidonOrigin?: string;
+  /** Size in px of Sidon's sign-in window; default 480 x 720. */
+  signInWidth?: number;
+  signInHeight?: number;
+  /** Origin serving OTA's /api/sailor/documents; '' (default) = this page's origin. */
+  sailorApiOrigin?: string;
+}
+
+export interface SidonBerthMapElement extends HTMLElement {
+  /** OTA marina slug. */
+  marina?: string;
+  mapsApiKey?: string;
+  /** '' (default) = this page's origin, where the forwarder route lives. */
+  apiOrigin?: string;
+  mapStyle?: 'chart' | 'coastal';
+  locale?: string;
+  currencySymbol?: string;
+  from?: string;
+  to?: string;
+  length?: number;
+  berth?: string;
+  /** 'staff' (the OTA dashboard): every listed berth is clickable and fires
+      sidon-berth-selected, occupied berths are painted for [from, to), and
+      from/to follow their attributes. No card, availability or boat-length
+      checks. Default 'guest'. */
+  mode?: 'guest' | 'staff';
+  /** Re-reads the map payload. Undefined until the element has mounted
+      (a microtask after it is connected), so call `el.refresh?.()`. */
+  readonly refresh?: () => void;
+  bookPath?: string;
+  logoMark?: string | null;
+  marinaName?: string;
+  otherMarinas?: OtherMarina[];
+  mapHeight?: string;
+  showWeather?: boolean;
+  eyebrow?: string;
+  cardTitle?: string;
+  intro?: string;
+  rangeLabel?: string;
+  rangePlaceholder?: string;
+  lengthLabel?: string;
+  selectedLabel?: string;
+  selectedPlaceholder?: string;
+  ctaLabel?: string;
+}
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'sidon-booking-widget': SidonBookingWidgetElement;
+    'sidon-berth-map': SidonBerthMapElement;
+  }
+  // Dispatched with bubbles + composed, so listeners on any ancestor
+  // element get the typed detail too.
+  interface HTMLElementEventMap {
+    'sidon-step-change': CustomEvent<SidonStepChangeDetail>;
+    'sidon-loa-change': CustomEvent<SidonLoaChangeDetail>;
+    'sidon-booked': CustomEvent<SidonBookedDetail>;
+    'sidon-booking-status': CustomEvent<SidonBookingStatusDetail>;
+    'sidon-berth-selected': CustomEvent<SidonBerthSelectedDetail>;
+    'sidon-quickbook-submit': CustomEvent<SidonQuickbookSubmitDetail>;
+  }
+}