@seatsio/seatsio-types 2.8.0 → 3.0.0

package/dist/index.d.ts

@@ -113,7 +113,7 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
      * @param ticketType The ticket type for which the user clicked on the plus button. Optional.
      * {@link https://docs.seats.io/docs/renderer/config-cangaselectionbeincreased See documentation}
      */
-    canGASelectionBeIncreased?: (gaArea: GeneralAdmissionAreaProps, defaultValue: boolean, extraConfig: ExtraConfig, ticketType?: TicketTypeJson) => boolean;
+    canGASelectionBeIncreased?: (gaArea: GeneralAdmissionArea, defaultValue: boolean, extraConfig: ExtraConfig, ticketType?: TicketTypeJson) => boolean;
     /**
      * If your chart div is enclosed within a <form>element, you can use this configuration option to automatically add the selected seat IDs to the form data. This is one of the ways you can pass the selected seats to your server, so that you can book them later on through the Seats API.
      * {@link https://docs.seats.io/docs/renderer/config-selectedobjectsinputname See documentation}
@@ -132,7 +132,7 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
     /**
      * A function whose result will be displayed as extra information on the cursor tooltip. {@link https://docs.seats.io/docs/renderer/config-tooltipinfo See documentation}
      */
-    tooltipInfo?: <T extends SelectableObjectProps>(object: T) => string;
+    tooltipInfo?: (object: SelectableObject) => string;
     /**
      * On mobile, when displaying a chart with sections, a tooltip is shown at the bottom of the screen with the section name and pricing.
      * You can hide this tooltip on mobile by passing `showActiveSectionTooltipOnMobile: false`.
@@ -165,8 +165,8 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
      * Leaves the specified categories normally visible, while making all others dimmed out. The array can be a list of category IDs or labels.
      */
     filteredCategories?: CategoryKey[];
-    objectColor?: (object: SelectableObjectProps, defaultColor: string, extraConfig: ExtraConfig) => string;
-    objectLabel?: (object: SelectableObjectProps, defaultLabel: string, extraConfig: ExtraConfig) => string;
+    objectColor?: (object: SelectableObject, defaultColor: string, extraConfig: ExtraConfig) => string;
+    objectLabel?: (object: SelectableObject, defaultLabel: string, extraConfig: ExtraConfig) => string;
     /**
      * @param object
      * @param defaultIcon
@@ -174,8 +174,8 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
      * @returns A string with the name of a FontAwesome v4.7.0 icon. {@link https://fontawesome.com/v4.7.0/icons/ See the full list of available icons}.
      * For more details, {@link https://docs.seats.io/docs/renderer/config-objecticon see the documentation}.
      */
-    objectIcon?: (object: SelectableObjectProps, defaultIcon: string | null, extraConfig?: ExtraConfig) => string;
-    sectionColor?: (section: SectionProps, defaultColor: string, extraConfig: ExtraConfig) => string;
+    objectIcon?: (object: SelectableObject, defaultIcon: string | null, extraConfig?: ExtraConfig) => string;
+    sectionColor?: (section: Section, defaultColor: string, extraConfig: ExtraConfig) => string;
     /**
      * This setting allows you specify when section contents (rows of seats, tables, etc) should be shown. Only available on charts with sections. {@link https://docs.seats.io/docs/renderer/config-showsectioncontents See documentation}
      * @default 'always'
@@ -184,7 +184,7 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
     /**
      * A function that should return true if an object is visible, and false otherwise. When an object is invisible, it can't be selected or interacted with. {@link https://docs.seats.io/docs/renderer/config-isobjectvisible See documentation}
      */
-    isObjectVisible?: (object: SelectableObjectProps, extraConfig: ExtraConfig) => boolean;
+    isObjectVisible?: (object: SelectableObject, extraConfig: ExtraConfig) => boolean;
     /**
      * Set to true to show seat labels in your chart.
      * @deault false
@@ -359,15 +359,32 @@ export interface EventManagerSelectModeConfigOptions extends BaseEventManagerCon
     tooltipContents?: (object: object) => string;
     unavailableObjectsSelectable?: boolean;
     selectableObjects?: string[];
+    /**
+     * @param object
+     * @param defaultIcon
+     * @param extraConfig
+     * @returns A string with the name of a FontAwesome v4.7.0 icon. {@link https://fontawesome.com/v4.7.0/icons/ See the full list of available icons}.
+     * For more details, {@link https://docs.seats.io/docs/event-manager/modes/select#objecticon see the documentation}.
+     */
+    objectIcon?: (object: SelectableObject, defaultIcon: string | null, extraConfig?: ExtraConfig) => string;
+    objectTooltip?: {
+        showOrderId?: boolean;
+        showTechnicalLabel?: boolean;
+        showLabel?: boolean;
+        showCategory?: boolean;
+        showChannel?: boolean;
+        showActionHint?: boolean;
+    };
 }
 export interface EventManagerStaticModeConfigOptions extends BaseEventManagerConfigOptions, WithEvents {
     mode: 'static';
-    onObjectMouseOver?: (object: SelectableObjectProps) => void;
-    onObjectMouseOut?: (object: SelectableObjectProps) => void;
+    onObjectMouseOver?: (object: SelectableObject) => void;
+    onObjectMouseOut?: (object: SelectableObject) => void;
     tooltipContents?: (object: object) => string;
 }
 export type EventManagerConfigOptions = EventManagerManageObjectStatusesModeConfigOptions | EventManagerManageChannelsModeConfigOptions | EventManagerManageCategoriesModeConfigOptions | EventManagerSelectModeConfigOptions | EventManagerFilterSectionsModeConfigOptions | EventManagerStaticModeConfigOptions | (BaseEventManagerConfigOptions & WithEvent);
-export interface ChartDesignerConfigOptions {
+export type ChartDesignerConfigOptions = ChartDesignerNormalModeConfigOptions | ChartDesignerReadOnlyModeConfigOptions | ChartDesignerSafeModeConfigOptions;
+export interface BaseChartDesignerConfigOptions {
     canvasColorScheme?: 'auto' | 'light' | 'dark';
     chartKey?: string;
     container?: Element;
@@ -384,7 +401,6 @@ export interface ChartDesignerConfigOptions {
      * Documentation: {@link https://docs.seats.io/docs/embedded-designer/configuration-language}
      */
     language?: 'de' | 'en' | 'es' | 'fr' | 'pt';
-    mode?: 'normal' | 'safe' | 'readOnly';
     onChartCreated?: (chartKey: string) => void;
     onChartPublished?: (chartKey: string) => void;
     onChartUpdated?: (chartKey: string) => void;
@@ -395,6 +411,18 @@ export interface ChartDesignerConfigOptions {
     openLatestDrawing?: boolean;
     secretKey: string;
 }
+export interface ChartDesignerNormalModeConfigOptions extends BaseChartDesignerConfigOptions {
+    mode?: 'normal';
+}
+export interface ChartDesignerReadOnlyModeConfigOptions extends BaseChartDesignerConfigOptions {
+    mode: 'readOnly';
+}
+export interface ChartDesignerSafeModeConfigOptions extends BaseChartDesignerConfigOptions {
+    mode: 'safe';
+    safeModeOptions?: {
+        allowDeletingObjects?: boolean;
+    };
+}
 export interface ChartDesignerFeatures {
     'tables.bookAsAWhole'?: boolean;
     areas?: boolean;
@@ -444,18 +472,18 @@ export type ChartRendererCallbacks = {
     onFloorChanged?: (floor?: Floor) => void;
     onFullScreenClosed?: () => void;
     onFullScreenOpened?: () => void;
-    onHoldFailed?: (objects: BookableObjectProps[], ticketTypes: TicketTypeJson[]) => void;
-    onHoldSucceeded?: (objects: BookableObjectProps[], ticketTypes: TicketTypeJson[]) => void;
+    onHoldFailed?: (objects: BookableObject[], ticketTypes: TicketTypeJson[]) => void;
+    onHoldSucceeded?: (objects: BookableObject[], ticketTypes: TicketTypeJson[]) => void;
     onHoldTokenExpired?: () => void;
-    onObjectClicked?: (object: SelectableObjectProps) => void;
-    onObjectDeselected?: (object: BookableObjectProps, selectedTicketType: TicketTypeJson) => void;
-    onObjectMouseOut?: (object: SelectableObjectProps) => void;
-    onObjectMouseOver?: (object: SelectableObjectProps) => void;
-    onObjectSelected?: (object: SelectableObjectProps, selectedTicketType: TicketTypeJson) => void;
-    onObjectStatusChanged?: (object: BookableObjectProps) => void;
-    onReleaseHoldFailed?: (objects: BookableObjectProps[], ticketTypes: TicketTypeJson[]) => void;
-    onReleaseHoldSucceeded?: (objects: BookableObjectProps[], ticketTypes: TicketTypeJson[]) => void;
-    onSelectedObjectBooked?: (object: BookableObjectProps) => void;
+    onObjectClicked?: (object: SelectableObject) => void;
+    onObjectMouseOut?: (object: SelectableObject) => void;
+    onObjectMouseOver?: (object: SelectableObject) => void;
+    onObjectSelected?: (object: SelectableObject, selectedTicketType: TicketTypeJson) => void;
+    onObjectDeselected?: (object: SelectableObject, selectedTicketType: TicketTypeJson) => void;
+    onObjectStatusChanged?: (object: BookableObject) => void;
+    onReleaseHoldFailed?: (objects: BookableObject[], ticketTypes: TicketTypeJson[]) => void;
+    onReleaseHoldSucceeded?: (objects: BookableObject[], ticketTypes: TicketTypeJson[]) => void;
+    onSelectedObjectBooked?: (object: BookableObject) => void;
     onSelectionInvalid?: (violations: string[]) => void;
     onSelectionValid?: () => void;
     onSessionInitialized?: (holdToken: HoldToken) => void;
@@ -737,19 +765,19 @@ interface Labels {
     section?: string;
 }
 export type PriceType = number | string;
-export interface InteractiveObjectProps {
+export interface InteractiveObject {
     readonly label: string;
     readonly labels: Labels;
 }
-export interface NonBookableTableProps extends InteractiveObjectProps {
-    readonly seats: SeatProps[];
+export interface NonBookableTable extends InteractiveObject {
+    readonly seats: Seat[];
     readonly center: {
         x: number;
         y: number;
     };
     readonly category?: CategoryToJSON;
 }
-export interface NonBookableTableSeatProps extends InteractiveObjectProps {
+export interface NonBookableTableSeat extends InteractiveObject {
     readonly center: {
         x: number;
         y: number;
@@ -761,7 +789,7 @@ export interface NonBookableTableSeatProps extends InteractiveObjectProps {
         type: 'row' | 'table';
     };
 }
-export interface SelectableObjectProps extends InteractiveObjectProps {
+export interface AbstractSelectableObject extends InteractiveObject {
     readonly objectType: string;
     readonly selected: boolean;
     readonly selectedTicketType: string | undefined;
@@ -775,8 +803,8 @@ export interface SelectableObjectProps extends InteractiveObjectProps {
     select: (ticketType?: string) => Promise<void>;
     deselect: (ticketType?: string) => Promise<void>;
 }
-export interface SectionProps extends InteractiveObjectProps {
-    readonly objectType: string;
+export interface Section extends InteractiveObject {
+    readonly objectType: 'section';
     readonly numberOfSelectableObjects: number;
     readonly numberOfSelectedObjects: number;
     readonly selectableCategories: CategoryKey[];
@@ -784,10 +812,11 @@ export interface SectionProps extends InteractiveObjectProps {
     readonly isInteractive: boolean;
     readonly sectionCategory?: CategoryToJSON;
 }
-export interface InteractiveSectionProps extends SelectableObjectProps {
+export interface InteractiveSection extends AbstractSelectableObject {
+    readonly objectType: 'section';
     readonly ticketListing: ListingBySection;
 }
-export interface BookableObjectProps extends SelectableObjectProps {
+export interface AbstractBookableObject extends AbstractSelectableObject {
     /**
      * Set to one of the predefined values `free`, `reservedByToken`, `booked` or use a custom status.
      */
@@ -803,7 +832,8 @@ export interface BookableObjectProps extends SelectableObjectProps {
      */
     channel?: Channel;
 }
-export interface SeatProps extends BookableObjectProps {
+export interface Seat extends AbstractBookableObject {
+    readonly objectType: 'Seat';
     readonly center: {
         x: number;
         y: number;
@@ -816,17 +846,19 @@ export interface SeatProps extends BookableObjectProps {
     pulse: () => Promise<void>;
     unpulse: () => Promise<void>;
 }
-export interface BoothProps extends BookableObjectProps {
+export interface Booth extends AbstractBookableObject {
     readonly objectType: 'Booth';
 }
-export interface TableProps extends BookableObjectProps {
-    readonly seats: NonBookableTableSeatProps[];
+export interface Table extends AbstractBookableObject {
+    readonly objectType: 'Table';
+    readonly seats: NonBookableTableSeat[];
     readonly center: {
         x: number;
         y: number;
     };
 }
-export interface GeneralAdmissionAreaProps extends BookableObjectProps {
+export interface GeneralAdmissionArea extends AbstractBookableObject {
+    readonly objectType: 'GeneralAdmissionArea';
     readonly numBooked: number;
     readonly capacity: number;
     readonly numFree: number;
@@ -837,17 +869,19 @@ export interface GeneralAdmissionAreaProps extends BookableObjectProps {
     readonly entrance: string | null;
     readonly bookAsAWhole: boolean;
 }
+export type BookableObject = Seat | GeneralAdmissionArea | Booth | Table;
+export type SelectableObject = BookableObject | InteractiveSection;
 export interface SeatingChart {
     changeConfig: (config: ConfigChange) => Promise<void>;
     clearSelection: () => Promise<void>;
     deselectCategories: (categoryIds: string[]) => Promise<void>;
     deselectObjects: (objects: (string | Selection)[]) => Promise<void>;
     destroy: () => void;
-    findObject: <T extends SelectableObjectProps>(label: string) => Promise<T>;
+    findObject: (label: string) => Promise<SelectableObject>;
     getReportBySelectability: () => Promise<Object>;
     holdToken: string;
     listCategories: () => Promise<Category[]>;
-    listSelectedObjects: <T extends SelectableObjectProps>() => Promise<T[]>;
+    listSelectedObjects: () => Promise<SelectableObject[]>;
     render: () => SeatingChart;
     rerender: () => void;
     resetView: () => Promise<void>;
@@ -858,11 +892,11 @@ export interface SeatingChart {
     unpulse: (objects: string[]) => Promise<void>;
     startNewSession: () => Promise<void>;
     zoomToFilteredCategories: () => Promise<void>;
-    zoomToSection: (label: string) => SectionProps[];
+    zoomToSection: (label: string) => Section[];
     zoomToObjects: (labels: string[]) => Promise<void>;
     zoomToSelectedObjects: () => Promise<void>;
 }
-export interface EventManager extends Pick<SeatingChart, 'clearSelection' | 'deselectCategories' | 'deselectObjects' | 'destroy' | 'findObject' | 'listCategories' | 'listSelectedObjects' | 'render' | 'rerender' | 'resetView' | 'selectCategories' | 'selectObjects' | 'zoomToObjects' | 'zoomToSection' | 'zoomToSelectedObjects' | 'pulse' | 'unpulse'> {
+export interface EventManager extends Pick<SeatingChart, 'clearSelection' | 'deselectCategories' | 'deselectObjects' | 'destroy' | 'findObject' | 'listCategories' | 'listSelectedObjects' | 'selectedObjects' | 'render' | 'rerender' | 'resetView' | 'selectCategories' | 'selectObjects' | 'zoomToObjects' | 'zoomToSection' | 'zoomToSelectedObjects' | 'pulse' | 'unpulse'> {
     setHighlightedObjects(strings: string[]): void;
     clearHighlightedObjects(): void;
     setFilteredSection(label: string): void;

package/package.json

@@ -1,12 +1,16 @@
 {
     "name": "@seatsio/seatsio-types",
     "description": "Type definitions for Seats.io",
-    "version": "2.8.0",
+    "version": "3.0.0",
     "license": "MIT",
     "types": "dist/index.d.ts",
     "files": [
         "dist/index.d.ts"
     ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/seatsio/seatsio-types"
+    },
     "devDependencies": {
         "@actions/core": "1.10.1",
         "cli-select-2": "2.0.0",