@seatmap.pro/renderer 1.72.3 → 1.73.1

package/lib/index.d.ts

@@ -4079,6 +4079,123 @@ declare class SeatmapBookingRenderer extends Renderer {
  */
 declare const VERSION: string;
 
+/**
+ * State machine of a booking session. Only `ACTIVE` and `PENDING_PAYMENT` hold inventory.
+ */
+type BookingSessionState = 'ACTIVE' | 'PENDING_PAYMENT' | 'CONFIRMED' | 'CANCELLED' | 'EXPIRED';
+/**
+ * One seat held by a session, with the price captured when it was locked.
+ */
+interface ISessionCartSeat {
+    id: number;
+    priceId?: number;
+    priceName?: string;
+}
+/**
+ * General-admission capacity held by a session in one area.
+ */
+interface ISessionCartGa {
+    id: number;
+    capacity: number;
+    priceId?: number;
+    priceName?: string;
+}
+/**
+ * Everything a session currently holds.
+ */
+interface ISessionCart {
+    seats: ISessionCartSeat[];
+    groupOfSeats: ISessionCartGa[];
+}
+/**
+ * Seats and general-admission capacities a lock, unlock or checkout call applies to.
+ * `capacity` is the desired total for that area in this session, not a delta.
+ */
+interface ISessionSelection {
+    seats?: number[];
+    groupOfSeats?: {
+        id: number;
+        capacity: number;
+    }[];
+}
+/**
+ * A booking session as the public API reports it.
+ */
+interface IBookingSession {
+    sessionId: string;
+    eventId: string;
+    state: BookingSessionState;
+    cart: ISessionCart;
+    total: number;
+    expiresAt: string;
+    expiresInSeconds: number;
+    serverTime: string;
+}
+/**
+ * The response to opening a session, carrying the limits the client must respect.
+ */
+interface ICreatedBookingSession {
+    sessionId: string;
+    expiresAt: string;
+    serverTime: string;
+    maxSeats: number;
+    ttlSeconds: number;
+}
+/**
+ * The lines that could not be acquired when a lock or checkout call was refused.
+ */
+interface ISessionConflicts {
+    seats: number[];
+    groupOfSeats: number[];
+}
+
+/**
+ * Error thrown when the session API refuses a call. `code` carries the backend error
+ * code (`SEAT_CONFLICT`, `SESSION_DEAD`, `SESSION_FROZEN`, `CAP_SEATS`, `NOT_ENABLED`,
+ * `START_OVER_REQUIRED`) and `conflicts` the lines that could not be acquired.
+ */
+declare class BookingSessionError extends Error {
+    readonly status: number;
+    readonly code: string | undefined;
+    readonly conflicts: ISessionConflicts | undefined;
+    constructor(status: number, message: string, code?: string, conflicts?: ISessionConflicts);
+}
+/**
+ * Settings for {@link BookingSessionClient}. `baseUrl` and `publicKey` are the same
+ * values the renderer is constructed with.
+ */
+interface IBookingSessionClientSettings {
+    baseUrl: string;
+    publicKey: string;
+}
+/**
+ * Client for the public booking session API. The session id returned by
+ * {@link BookingSessionClient.create} is the credential for every later call, so the
+ * caller is responsible for storing it across page loads.
+ */
+declare class BookingSessionClient {
+    private readonly settings;
+    constructor(settings: IBookingSessionClientSettings);
+    create(eventId: string, idempotencyKey?: string): Promise<ICreatedBookingSession>;
+    get(sessionId: string): Promise<IBookingSession>;
+    lock(sessionId: string, selection: ISessionSelection): Promise<IBookingSession>;
+    unlock(sessionId: string, selection: ISessionSelection): Promise<IBookingSession>;
+    checkout(sessionId: string, selection?: ISessionSelection): Promise<IBookingSession>;
+    cancel(sessionId: string, startOver?: boolean): Promise<IBookingSession>;
+    private send;
+}
+
+/**
+ * Converts a renderer cart into the selection shape the session API expects. Seats and
+ * general-admission areas the renderer could not identify are dropped.
+ */
+declare const selectionFromCart: (cart: ICart) => ISessionSelection;
+/**
+ * Builds the selection that releases everything a session currently holds, for passing to
+ * {@link BookingSessionClient.unlock}. General-admission areas release by dropping to zero.
+ */
+declare const selectionFromSession: (session: IBookingSession | null) => ISessionSelection;
+
 type AdminHotkeyAction = 'pan' | 'clearSelection' | 'selectAll' | 'zoomIn' | 'zoomOut' | 'zoomToFit' | 'flatSection';
 
 declare const defaultZoomSettings: IZoomSettings;
@@ -4122,4 +4239,4 @@ declare class RotationAnimation {
     getAnimation(): IRotationAnimation | null;
 }
 
-export { type AdminHotkeyAction, ApiError, BookingApiClient, type BrandingLevel, type BuiltinSeatStateKey, type ById, type ColorById, type ColorSequenceSettings, DataManager, type DataManagerEvent, type DataManagerEventCallback, type DeepPartial, type DestEvent, DestEventType, type HotkeysSetting, type IAdminRenderer, type IAdminRendererSettings, type IAssignmentListDTO, type IAvailabilityDTO, type IBackgroundImageLoadedEvent, type IBaseSeat, type IBaseSector, type IBasicSeatStyle, type IBeforeSeatDrawEvent, type IBookingRendererSettings, type ICart, type ICartChangeResult, type ICartGa, type ICartSeat, type IClickSrcEvent, type IColoredPrice, type IConfigurationDTO, type ICustomSeatStyle, type IDeselectDestEvent, type IDragEndSrcEvent, type IDragMoveSrcEvent, type IDragStartSrcEvent, type IEntityStates, type IErrorMessage, type IExtendedSeat, type ILabelStyle, type ILoadProgressEvent, type ILoaderSettings, type ILoaderTheme, type IMarker, type IMarkerSettings, type IMinimapSettings, type IMouseMoveSrcEvent, type IOrphanGroupStyle, type IOrphanSeatsBlockedEvent, type IPanDestEvent, type IPanZoomDestEvent, type IPlainSeatsDTO, type IPngBackgroundDTO, type IPoint, type IPrice, type IPriceDTO, type IPriceId, type IPriceListDTO, type IRectSelectDestEvent, type IRemovedCartGa, type IRenderer, type IRendererAnimation, type IRendererMachineContext, type IRendererSettings, type IRendererSvgSectionStylesSetting, type IRendererTheme, type IResolvedMarker, type IRowDTO, type ISVGBackgroundDTO, type ISchemaDTO, type ISeat, type ISeatCartSwitchDestEvent, type ISeatDTO, type ISeatMetadata, type ISeatMouseEnterDestEvent, type ISeatMouseLeaveDestEvent, type ISeatPriceScheme, type ISeatSelectDestEvent, type ISeatStateRenderArgs, type ISeatStyle, type ISection, type ISectionClickDestEvent, type ISectionGridDTO, type ISectionMetadata, type ISectionMouseEnterDestEvent, type ISectionMouseLeaveDestEvent, type ISectionPhoto, type ISectionRect, type ISectionWithCoords, type ISector, type ISectorDTO, type IShapeMetadata, type ISpecialPrice, type ISpecialState, type ISvgSectionStateStyles, type ISvgSectionStyle, type ITileGrid, type IVenueDTO, type IVisibilitySettings, type IWatermarkSettings, type IZoomSettings, type InteractionZoomStrategy, type InteractionZoomStrategyType, type LoaderStyle, type LoadingPhase, type MarkerAppearance, type MarkerTarget, type MinimapPosition, type Nullable, Renderer, type RendererMachine, type RendererMachineReducer, type RendererMachineService, RendererSelectMode, RendererTargetType, type RequestMetrics, RotationAnimation, type SeatFilter, type SeatInteractionState, type SeatStylesMap, SeatmapAdminRenderer, SeatmapBookingRenderer, type SrcEvent, SrcEventType, StateManager, type StateManagerEvent, type StateManagerEventCallback, type TransformArray, VERSION, convertPricesToColored, convertPricesToColoredById, defaultZoomSettings, emptyPriceList, mergeSettings, preconnectToApi, sortPrices };
+export { type AdminHotkeyAction, ApiError, BookingApiClient, BookingSessionClient, BookingSessionError, type BookingSessionState, type BrandingLevel, type BuiltinSeatStateKey, type ById, type ColorById, type ColorSequenceSettings, DataManager, type DataManagerEvent, type DataManagerEventCallback, type DeepPartial, type DestEvent, DestEventType, type HotkeysSetting, type IAdminRenderer, type IAdminRendererSettings, type IAssignmentListDTO, type IAvailabilityDTO, type IBackgroundImageLoadedEvent, type IBaseSeat, type IBaseSector, type IBasicSeatStyle, type IBeforeSeatDrawEvent, type IBookingRendererSettings, type IBookingSession, type IBookingSessionClientSettings, type ICart, type ICartChangeResult, type ICartGa, type ICartSeat, type IClickSrcEvent, type IColoredPrice, type IConfigurationDTO, type ICreatedBookingSession, type ICustomSeatStyle, type IDeselectDestEvent, type IDragEndSrcEvent, type IDragMoveSrcEvent, type IDragStartSrcEvent, type IEntityStates, type IErrorMessage, type IExtendedSeat, type ILabelStyle, type ILoadProgressEvent, type ILoaderSettings, type ILoaderTheme, type IMarker, type IMarkerSettings, type IMinimapSettings, type IMouseMoveSrcEvent, type IOrphanGroupStyle, type IOrphanSeatsBlockedEvent, type IPanDestEvent, type IPanZoomDestEvent, type IPlainSeatsDTO, type IPngBackgroundDTO, type IPoint, type IPrice, type IPriceDTO, type IPriceId, type IPriceListDTO, type IRectSelectDestEvent, type IRemovedCartGa, type IRenderer, type IRendererAnimation, type IRendererMachineContext, type IRendererSettings, type IRendererSvgSectionStylesSetting, type IRendererTheme, type IResolvedMarker, type IRowDTO, type ISVGBackgroundDTO, type ISchemaDTO, type ISeat, type ISeatCartSwitchDestEvent, type ISeatDTO, type ISeatMetadata, type ISeatMouseEnterDestEvent, type ISeatMouseLeaveDestEvent, type ISeatPriceScheme, type ISeatSelectDestEvent, type ISeatStateRenderArgs, type ISeatStyle, type ISection, type ISectionClickDestEvent, type ISectionGridDTO, type ISectionMetadata, type ISectionMouseEnterDestEvent, type ISectionMouseLeaveDestEvent, type ISectionPhoto, type ISectionRect, type ISectionWithCoords, type ISector, type ISectorDTO, type ISessionCart, type ISessionCartGa, type ISessionCartSeat, type ISessionConflicts, type ISessionSelection, type IShapeMetadata, type ISpecialPrice, type ISpecialState, type ISvgSectionStateStyles, type ISvgSectionStyle, type ITileGrid, type IVenueDTO, type IVisibilitySettings, type IWatermarkSettings, type IZoomSettings, type InteractionZoomStrategy, type InteractionZoomStrategyType, type LoaderStyle, type LoadingPhase, type MarkerAppearance, type MarkerTarget, type MinimapPosition, type Nullable, Renderer, type RendererMachine, type RendererMachineReducer, type RendererMachineService, RendererSelectMode, RendererTargetType, type RequestMetrics, RotationAnimation, type SeatFilter, type SeatInteractionState, type SeatStylesMap, SeatmapAdminRenderer, SeatmapBookingRenderer, type SrcEvent, SrcEventType, StateManager, type StateManagerEvent, type StateManagerEventCallback, type TransformArray, VERSION, convertPricesToColored, convertPricesToColoredById, defaultZoomSettings, emptyPriceList, mergeSettings, preconnectToApi, selectionFromCart, selectionFromSession, sortPrices };