@seatlayer/js 0.24.0 → 0.26.0

package/dist/index.d.cts

@@ -18,7 +18,7 @@ interface HoldConflict {
 interface HoldLineItem {
     label: string;
     objectId: string;
-    objectType: 'seat' | 'booth' | 'ga';
+    objectType: 'seat' | 'booth' | 'ga' | 'table';
     categoryKey: string;
     tierId: string | null;
     /** Price in major currency units (for example 45 means $45.00). */
@@ -151,6 +151,7 @@ declare class SeatingChart {
     private mount;
     private hostEl;
     private rendered;
+    private mode_;
     private tipEl;
     private tipPos;
     private onTipMove;
@@ -168,14 +169,47 @@ declare class SeatingChart {
     private buildBadge;
     private placeTooltip;
     private updateTooltip;
+    /**
+     * Whether the SERVED event is a live or a test event (`sk_test_` keys create
+     * test events, which never book real inventory). `null` before render()
+     * resolves — the mode comes from the server with the chart, not from options.
+     *
+     * The widget already surfaces this visually with the test-mode ribbon; this
+     * getter is for hosts that draw their own chrome — notably a native WebView
+     * wrapper, which must be able to tell an integrator that the build they are
+     * about to ship is pointed at a test event.
+     */
+    getMode(): 'live' | 'test' | null;
     /** Current selection with prices resolved from the chart categories. */
     getSelection(): SelectedSeat[];
     /** Hold the current selection. Resolves the hold, or null on a 409 conflict. */
     hold(options?: {
         ttlMs?: number;
     }): Promise<HoldResult | null>;
+    /**
+     * @internal Like {@link hold} but RE-THROWS the structured API error (409
+     * `reason`/`code` + `conflicts`) instead of swallowing it into `onError` +
+     * `null`. The native WebView host adapter needs the throw so it can answer the
+     * originating command with a correlated error carrying the SPECIFIC reason
+     * (`sold_out` vs `not_enough_together`); the public method above keeps the
+     * catch-and-onError contract that direct web consumers rely on. Not a stable
+     * part of the embed API.
+     */
+    holdOrThrow(options?: {
+        ttlMs?: number;
+    }): Promise<HoldResult | null>;
     /** Restore an active hold by its opaque id without extending its expiry. */
     resumeHold(holdId: string): Promise<HoldResult | null>;
+    /** @internal Throwing variant of {@link resumeHold} for the native host adapter. See {@link holdOrThrow}. */
+    resumeHoldOrThrow(holdId: string): Promise<HoldResult | null>;
+    /**
+     * Push the OPEN hold's expiry out ("need more time?"). Resolves the refreshed
+     * hold, or `null` when there is nothing held or the server refused (the hold
+     * is gone, already expired, or at its renewal cap) — refusal is a normal
+     * outcome, not an error, so the host decides the copy. The client-side expiry
+     * timer is re-armed to match, so `onHoldExpired` won't fire early.
+     */
+    extendHold(ttlMs?: number): Promise<HoldResult | null>;
     /** Current active hold known to this chart, if any. */
     getCurrentHold(): HoldResult | null;
     getGAAreas(): GAAreaAvailability[];
@@ -183,8 +217,15 @@ declare class SeatingChart {
         tierId?: string | null;
         ttlMs?: number;
     }): Promise<HoldResult | null>;
+    /** @internal Throwing variant of {@link holdGA} for the native host adapter. See {@link holdOrThrow}. */
+    holdGAOrThrow(areaId: string, qty: number, options?: {
+        tierId?: string | null;
+        ttlMs?: number;
+    }): Promise<HoldResult | null>;
     /** Ask the server for the `qty` best free seats and hold them atomically. */
     bestAvailable(qty: number, categoryKey?: string): Promise<BestAvailableResult | null>;
+    /** @internal Throwing variant of {@link bestAvailable} for the native host adapter. See {@link holdOrThrow}. */
+    bestAvailableOrThrow(qty: number, categoryKey?: string): Promise<BestAvailableResult | null>;
     /**
      * Choose a ticket tier for a selected seat (e.g. Adult → Child). The seat's
      * available `tiers` are on each `SelectedSeat` from `getSelection()` /
@@ -488,11 +529,11 @@ declare class EmbeddedDesigner {
  * per-line tier + price) and never changes shape across minor releases.
  */
 interface CheckoutLineItem {
-    /** Seat label (or GA synthetic-unit label). */
+    /** Seat, table-group, or GA synthetic-unit label. */
     label: string;
     /** Chart object id (row/booth/GA area) the unit belongs to. */
     objectId: string;
-    objectType: 'seat' | 'booth' | 'ga';
+    objectType: 'seat' | 'booth' | 'ga' | 'table';
     categoryKey: string;
     /** Chosen ticket tier id (Adult/Child/…), or null when the category has no tiers. */
     tierId: string | null;
@@ -684,6 +725,8 @@ declare class SeatPicker {
     private srEl;
     private baQty;
     private baCat;
+    /** "★ Best seats" premium quick-pick toggle — biases best-available to premium seats. */
+    private baPremium;
     private bestAvailableConfirm;
     private releasingHold;
     /** Event sales window is closed (read-only load state / live close). */
@@ -736,6 +779,20 @@ declare class SeatPicker {
      * sightline" line — the premium at-a-glance moment; click opens the 360.
      */
     private confirmThumbHtml;
+    /** Minimal HTML/attribute escaper for buyer-authored commercial text (notes). */
+    private escCx;
+    /** Localized "Restricted view" / "Obstructed view" label for a seat's flags,
+     *  or '' when neither is set. Restricted takes precedence when both are on. */
+    private limitedViewLabel;
+    /**
+     * Commercial flags block for the confirm/detail surface: a subtle ★ Premium
+     * tag plus an amber ◐ limited-view caution (with the organizer's note when
+     * present). '' when the seat carries no surfaced commercial flag.
+     */
+    private commercialConfirmHtml;
+    /** Small ◐ limited-view marker for a cart chip; title/aria uses the seat's
+     *  note when present, else the generic view label. '' for a clear-view seat. */
+    private commercialChipMarker;
     /** True when the picker is rendered inside an iframe (snippet embed at /e/:key). */
     private isFramed;
     /**
@@ -997,6 +1054,9 @@ declare class SeatPicker {
      * the prefix is exact (won't touch "1040-A" under section "104"); otherwise
      * the label is shown verbatim.
      */
+    /** Buyer-facing type word for the row/table key label — the designer's
+     *  per-object "Displayed type" override, or the default "Row". */
+    private rowTypeWord;
     private rowShort;
     private updateTooltip;
     getSelection(): PickerSeat[];
@@ -1006,7 +1066,9 @@ declare class SeatPicker {
     resumeHold(holdId: string): Promise<HoldResult | null>;
     /** Remove one server-held ticket while keeping the rest of the hold active. */
     removeHeldTicket(label: string): Promise<boolean>;
-    bestAvailable(qty: number, categoryKey?: string): Promise<HoldResult | null>;
+    bestAvailable(qty: number, categoryKey?: string, opts?: {
+        preferPremium?: boolean;
+    }): Promise<HoldResult | null>;
     release(): Promise<void>;
     destroy(): void;
 }

package/dist/index.d.ts

@@ -18,7 +18,7 @@ interface HoldConflict {
 interface HoldLineItem {
     label: string;
     objectId: string;
-    objectType: 'seat' | 'booth' | 'ga';
+    objectType: 'seat' | 'booth' | 'ga' | 'table';
     categoryKey: string;
     tierId: string | null;
     /** Price in major currency units (for example 45 means $45.00). */
@@ -151,6 +151,7 @@ declare class SeatingChart {
     private mount;
     private hostEl;
     private rendered;
+    private mode_;
     private tipEl;
     private tipPos;
     private onTipMove;
@@ -168,14 +169,47 @@ declare class SeatingChart {
     private buildBadge;
     private placeTooltip;
     private updateTooltip;
+    /**
+     * Whether the SERVED event is a live or a test event (`sk_test_` keys create
+     * test events, which never book real inventory). `null` before render()
+     * resolves — the mode comes from the server with the chart, not from options.
+     *
+     * The widget already surfaces this visually with the test-mode ribbon; this
+     * getter is for hosts that draw their own chrome — notably a native WebView
+     * wrapper, which must be able to tell an integrator that the build they are
+     * about to ship is pointed at a test event.
+     */
+    getMode(): 'live' | 'test' | null;
     /** Current selection with prices resolved from the chart categories. */
     getSelection(): SelectedSeat[];
     /** Hold the current selection. Resolves the hold, or null on a 409 conflict. */
     hold(options?: {
         ttlMs?: number;
     }): Promise<HoldResult | null>;
+    /**
+     * @internal Like {@link hold} but RE-THROWS the structured API error (409
+     * `reason`/`code` + `conflicts`) instead of swallowing it into `onError` +
+     * `null`. The native WebView host adapter needs the throw so it can answer the
+     * originating command with a correlated error carrying the SPECIFIC reason
+     * (`sold_out` vs `not_enough_together`); the public method above keeps the
+     * catch-and-onError contract that direct web consumers rely on. Not a stable
+     * part of the embed API.
+     */
+    holdOrThrow(options?: {
+        ttlMs?: number;
+    }): Promise<HoldResult | null>;
     /** Restore an active hold by its opaque id without extending its expiry. */
     resumeHold(holdId: string): Promise<HoldResult | null>;
+    /** @internal Throwing variant of {@link resumeHold} for the native host adapter. See {@link holdOrThrow}. */
+    resumeHoldOrThrow(holdId: string): Promise<HoldResult | null>;
+    /**
+     * Push the OPEN hold's expiry out ("need more time?"). Resolves the refreshed
+     * hold, or `null` when there is nothing held or the server refused (the hold
+     * is gone, already expired, or at its renewal cap) — refusal is a normal
+     * outcome, not an error, so the host decides the copy. The client-side expiry
+     * timer is re-armed to match, so `onHoldExpired` won't fire early.
+     */
+    extendHold(ttlMs?: number): Promise<HoldResult | null>;
     /** Current active hold known to this chart, if any. */
     getCurrentHold(): HoldResult | null;
     getGAAreas(): GAAreaAvailability[];
@@ -183,8 +217,15 @@ declare class SeatingChart {
         tierId?: string | null;
         ttlMs?: number;
     }): Promise<HoldResult | null>;
+    /** @internal Throwing variant of {@link holdGA} for the native host adapter. See {@link holdOrThrow}. */
+    holdGAOrThrow(areaId: string, qty: number, options?: {
+        tierId?: string | null;
+        ttlMs?: number;
+    }): Promise<HoldResult | null>;
     /** Ask the server for the `qty` best free seats and hold them atomically. */
     bestAvailable(qty: number, categoryKey?: string): Promise<BestAvailableResult | null>;
+    /** @internal Throwing variant of {@link bestAvailable} for the native host adapter. See {@link holdOrThrow}. */
+    bestAvailableOrThrow(qty: number, categoryKey?: string): Promise<BestAvailableResult | null>;
     /**
      * Choose a ticket tier for a selected seat (e.g. Adult → Child). The seat's
      * available `tiers` are on each `SelectedSeat` from `getSelection()` /
@@ -488,11 +529,11 @@ declare class EmbeddedDesigner {
  * per-line tier + price) and never changes shape across minor releases.
  */
 interface CheckoutLineItem {
-    /** Seat label (or GA synthetic-unit label). */
+    /** Seat, table-group, or GA synthetic-unit label. */
     label: string;
     /** Chart object id (row/booth/GA area) the unit belongs to. */
     objectId: string;
-    objectType: 'seat' | 'booth' | 'ga';
+    objectType: 'seat' | 'booth' | 'ga' | 'table';
     categoryKey: string;
     /** Chosen ticket tier id (Adult/Child/…), or null when the category has no tiers. */
     tierId: string | null;
@@ -684,6 +725,8 @@ declare class SeatPicker {
     private srEl;
     private baQty;
     private baCat;
+    /** "★ Best seats" premium quick-pick toggle — biases best-available to premium seats. */
+    private baPremium;
     private bestAvailableConfirm;
     private releasingHold;
     /** Event sales window is closed (read-only load state / live close). */
@@ -736,6 +779,20 @@ declare class SeatPicker {
      * sightline" line — the premium at-a-glance moment; click opens the 360.
      */
     private confirmThumbHtml;
+    /** Minimal HTML/attribute escaper for buyer-authored commercial text (notes). */
+    private escCx;
+    /** Localized "Restricted view" / "Obstructed view" label for a seat's flags,
+     *  or '' when neither is set. Restricted takes precedence when both are on. */
+    private limitedViewLabel;
+    /**
+     * Commercial flags block for the confirm/detail surface: a subtle ★ Premium
+     * tag plus an amber ◐ limited-view caution (with the organizer's note when
+     * present). '' when the seat carries no surfaced commercial flag.
+     */
+    private commercialConfirmHtml;
+    /** Small ◐ limited-view marker for a cart chip; title/aria uses the seat's
+     *  note when present, else the generic view label. '' for a clear-view seat. */
+    private commercialChipMarker;
     /** True when the picker is rendered inside an iframe (snippet embed at /e/:key). */
     private isFramed;
     /**
@@ -997,6 +1054,9 @@ declare class SeatPicker {
      * the prefix is exact (won't touch "1040-A" under section "104"); otherwise
      * the label is shown verbatim.
      */
+    /** Buyer-facing type word for the row/table key label — the designer's
+     *  per-object "Displayed type" override, or the default "Row". */
+    private rowTypeWord;
     private rowShort;
     private updateTooltip;
     getSelection(): PickerSeat[];
@@ -1006,7 +1066,9 @@ declare class SeatPicker {
     resumeHold(holdId: string): Promise<HoldResult | null>;
     /** Remove one server-held ticket while keeping the rest of the hold active. */
     removeHeldTicket(label: string): Promise<boolean>;
-    bestAvailable(qty: number, categoryKey?: string): Promise<HoldResult | null>;
+    bestAvailable(qty: number, categoryKey?: string, opts?: {
+        preferPremium?: boolean;
+    }): Promise<HoldResult | null>;
     release(): Promise<void>;
     destroy(): void;
 }