Skip to content

Add holdBestAvailable types and callbacks #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bverbeken merged 4 commits into from
Mar 25, 2026
Merged

Add holdBestAvailable types and callbacks #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
529b941
Add wheelchairSpaceType to AbstractSelectableObject
bverbeken Mar 25, 2026
6e1ba3d
Add holdBestAvailable types, callbacks, and chart method
bverbeken Mar 25, 2026
3f752e2
Merge branch 'main' into hold-best-available-types
bverbeken Mar 25, 2026
41e24d2
Make onBestAvailableHeld nextToEachOther optional, use Dict<number> f…
bverbeken Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,8 @@ const fullChartRendererConfig: Required<ChartRendererConfigOptions> = {
onObjectStatusChanged: _object => {},
onSelectedObjectUnavailable: _object => {},
onSessionInitialized: _holdToken => { },
onBestAvailableHeld: (_objects, _nextToEachOther) => {},
onBestAvailableHoldFailed: (_error) => {},
onHoldSucceeded: (_objects, _ticketTypes) => {},
onHoldFailed: (_objects, _ticketTypes) => {},
onHoldTokenExpired: () => {},
Expand Down
17 changes: 17 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -893,6 +893,8 @@ export type ChartRendererCallbacks = {
onFloorChanged?: (floor?: Floor) => void
onFullScreenClosed?: () => void
onFullScreenOpened?: () => void
onBestAvailableHeld?: (objects: string[], nextToEachOther?: boolean) => void
onBestAvailableHoldFailed?: (error: { message: string }) => void
onHoldFailed?: (objects: BookableObject[], ticketTypes: TicketTypeJson[]) => void
onHoldSucceeded?: (objects: BookableObject[], ticketTypes: TicketTypeJson[]) => void
onHoldTokenExpired?: () => void
Expand Down Expand Up @@ -1535,6 +1537,20 @@ export interface GeneralAdmissionArea extends AbstractBookableObject {
export type BookableObject = Seat | GeneralAdmissionArea | Booth | Table
export type SelectableObject = BookableObject | InteractiveSection

export interface BestAvailableForHoldingConfig {
number?: number
Comment thread
bverbeken marked this conversation as resolved.
categories?: CategoryKey[]
zone?: string
sections?: string[]
accessibleSeats?: number
ticketTypes?: Dict<number>
}

export interface BestAvailableHeldResult {
objects: string[]
nextToEachOther?: boolean
}

export type ReportGroupedBy = 'zone'

export interface SeatingChart {
Expand All @@ -1546,6 +1562,7 @@ export interface SeatingChart {
findObject: (label: string) => Promise<SelectableObject>
getReportBySelectability: () => Promise<Object>
getReportBySelectabilityGroupedBy: (groupBy: ReportGroupedBy) => Promise<Object>
holdBestAvailable: (config: BestAvailableForHoldingConfig) => Promise<BestAvailableHeldResult>
holdToken: string
Comment thread
bverbeken marked this conversation as resolved.
listCategories: () => Promise<Category[]>
listZones: () => Promise<Zone[]>
Expand Down
Loading