@seatsio/seatsio-types 2.0.1 → 2.1.0

package/dist/index.d.ts

@@ -27,15 +27,23 @@ export interface CommonConfigOptions {
      */
     divId?: string;
 }
+interface WithEvents {
+    event?: string;
+    events?: string[];
+}
+interface WithEvent {
+    event: string;
+}
+type Session = 'continue' | 'manual' | 'none' | 'start';
 export interface ChartRendererConfigOptions extends DeprecatedConfigProperties, CommonConfigOptions, ChartRendererCallbacks {
     /**
      * Allows to render a multi-floor seating chart with specific floor selected, instead of the default all-floors view.
      */
     activeFloor?: string;
     /**
-    * The key of the events for which you want to render the seating chart.
-    * Note: Channels functionality is not supported when using an event group with multiple events. Use {@link https://docs.seats.io/docs/api/seasons seasons} for that.
-    */
+     * The key of the events for which you want to render the seating chart.
+     * Note: Channels functionality is not supported when using an event group with multiple events. Use {@link https://docs.seats.io/docs/api/seasons seasons} for that.
+     */
     events?: string[];
     /**
      * This parameter supports the following values:
@@ -47,8 +55,8 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
      */
     mode?: ChartRendererMode;
     /**
-    * Allows to toggle on or off some features of the cursor tooltip, displayed when hovering objects when using pointing devices like a mouse, or when tapping on an object on touch devices.
-    */
+     * Allows to toggle on or off some features of the cursor tooltip, displayed when hovering objects when using pointing devices like a mouse, or when tapping on an object on touch devices.
+     */
     objectTooltip?: ChartRendererObjectTooltip;
     /**
      * Seats supports two types of pricing: simple pricing and multi-level pricing. {@link https://docs.seats.io/docs/renderer/config-pricing See documentation}
@@ -67,8 +75,8 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
      * */
     workspaceKey: string;
     /**
-    * The key of the event (or the season) for which you want to render the seating chart.
-    */
+     * The key of the event (or the season) for which you want to render the seating chart.
+     */
     event?: string;
     /** Custom data to be passed to certain callbacks. {@link https://docs.seats.io/docs/renderer/config-extraconfig/ See documentation} for information. */
     extraConfig?: ExtraConfig;
@@ -186,7 +194,7 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
      * Start a session to temporarily hold objects upon selection. {@link https://docs.seats.io/docs/renderer/config-session See documentation} for more details.
      * @default 'none'
      */
-    session?: 'continue' | 'manual' | 'none' | 'start';
+    session?: Session;
     /**
      * Hold tokens allows the chart renderer to re-select already selected seats after a page refresh. {@link https://docs.seats.io/docs/renderer/config-holdtoken See documentation} for more details.
      */
@@ -223,27 +231,27 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
     inputDevice?: 'cursor' | 'touch' | 'auto';
     /**
      * This parameter allows you to override the default seats.io spinner that is shown while the floor plan is being loaded. The value can contain (valid) html.
- */
+     */
     loading?: string;
     /**
      * Sets the color scheme for the user interface. The colors of certain floor plan elements, such as zoomed-in sections, will also be adjusted accordingly.
      */
     colorScheme?: 'light' | 'dark';
     /**
-    * Replaces certain colors of the current color scheme. {@link https://docs.seats.io/docs/renderer/colors See documentation}
-    */
+     * Replaces certain colors of the current color scheme. {@link https://docs.seats.io/docs/renderer/colors See documentation}
+     */
     colors?: {
         colorSelected?: string;
         cursorTooltipBackgroundColor?: string;
         colorTitle?: string;
     };
     /**
- * Sets the preset of styles to use for the seating chart user interface. {@link https://docs.seats.io/docs/renderer/stylepreset See documentation}
- */
+     * Sets the preset of styles to use for the seating chart user interface. {@link https://docs.seats.io/docs/renderer/stylepreset See documentation}
+     */
     stylePreset?: 'balance' | 'bubblegum' | 'flathead' | 'bezels' | 'leaf';
     /**
- * Sets the intention for certain style properties, allowing to override the current style preset. {@link https://docs.seats.io/docs/renderer/style See documentation}
- */
+     * Sets the intention for certain style properties, allowing to override the current style preset. {@link https://docs.seats.io/docs/renderer/style See documentation}
+     */
     style?: StyleOverride;
     /**
      * Determines how the chart will fit within its parent container. See the {@link https://docs.seats.io/docs/renderer/config-fitto documentation} for more information on this setting.
@@ -270,8 +278,7 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
     channels?: string[];
 }
 export type ExtractedEventManagerProps = Pick<ChartRendererConfigOptions, 'colors' | 'colorScheme' | 'extraConfig' | 'fitTo' | 'objectColor' | 'showFullScreenButton' | 'style' | 'stylePreset' | 'tooltipInfo' | 'themePreset' | 'themeColors'>;
-export interface EventManagerConfigOptions extends CommonConfigOptions, ExtractedEventManagerProps, EventManagerCallbacks {
-    event: string;
+interface BaseEventManagerConfigOptions extends CommonConfigOptions, ExtractedEventManagerProps, EventManagerCallbacks {
     mode: EventManagerMode;
     /**
      * The secret key of a workspace.
@@ -322,6 +329,41 @@ export interface EventManagerConfigOptions extends CommonConfigOptions, Extracte
         useChannelColors?: boolean;
     };
 }
+interface EventManagerManageObjectStatusesModeConfigOptions extends BaseEventManagerConfigOptions, WithEvents {
+    mode: 'manageObjectStatuses';
+    session?: Session;
+}
+interface EventManagerManageChannelsModeConfigOptions extends BaseEventManagerConfigOptions, WithEvent {
+    mode: 'manageChannels';
+    manageChannelsList?: boolean;
+    unavailableObjectsSelectable?: boolean;
+}
+interface EventManagerManageCategoriesModeConfigOptions extends BaseEventManagerConfigOptions, WithEvent {
+    mode: 'manageCategories';
+    unavailableObjectsSelectable?: boolean;
+}
+interface EventManagerFilterSectionsModeConfigOptions extends BaseEventManagerConfigOptions, WithEvent {
+    mode: 'filterSections';
+    onFilteredSectionChange: (sectionLabels: string[]) => {};
+}
+interface EventManagerSelectModeConfigOptions extends BaseEventManagerConfigOptions, WithEvents {
+    mode: 'select';
+    maxSelectedObjects?: SelectionLimiter;
+    numberOfPlacesToSelect?: number;
+    selectedObjects?: (string | SelectedObject | SelectedGA)[];
+    selectionBy?: 'places' | 'objects';
+    ticketTypes?: TicketTypeJsonWithoutPrice[];
+    tooltipContents?: (object: object) => string;
+    unavailableObjectsSelectable?: boolean;
+    selectableObjects?: string[];
+}
+interface EventManagerStaticModeConfigOptions extends BaseEventManagerConfigOptions, WithEvents {
+    mode: 'static';
+    onObjectMouseOver?: (object: SelectableObjectProps) => void;
+    onObjectMouseOut?: (object: SelectableObjectProps) => void;
+    tooltipContents?: (object: object) => string;
+}
+export type EventManagerConfigOptions = EventManagerManageObjectStatusesModeConfigOptions | EventManagerManageChannelsModeConfigOptions | EventManagerManageCategoriesModeConfigOptions | EventManagerSelectModeConfigOptions | EventManagerFilterSectionsModeConfigOptions | EventManagerStaticModeConfigOptions | (BaseEventManagerConfigOptions & WithEvent);
 export interface ChartDesignerConfigOptions {
     canvasColorScheme?: 'auto' | 'light' | 'dark';
     chartKey?: string;
@@ -415,7 +457,10 @@ export type ChartRendererCallbacks = {
     onSelectionValid?: () => void;
     onSessionInitialized?: (holdToken: HoldToken) => void;
 };
-export type EventManagerCallbacks = Pick<ChartRendererCallbacks, 'onChartRendered' | 'onChartRenderingFailed' | 'onChartRerenderingStarted' | 'onObjectSelected' | 'onObjectDeselected' | 'onObjectClicked' | 'onFullScreenOpened' | 'onFullScreenClosed'> & {
+export type EventManagerCallbacks = Pick<ChartRendererCallbacks, 'onObjectSelected' | 'onObjectDeselected' | 'onObjectClicked' | 'onFullScreenOpened' | 'onFullScreenClosed'> & {
+    onChartRendered?: (chart: EventManager) => void;
+    onChartRenderingFailed?: (chart: EventManager) => void;
+    onChartRerenderingStarted?: (chart: EventManager) => void;
     onSubmitFailed?: () => void;
     onSubmitSucceeded?: () => void;
 };
@@ -525,9 +570,9 @@ export interface ChartRendererObjectTooltip {
      */
     stylizedLabel?: boolean;
     /**
-    * If true, a popup will show up when selecting an object on mobile containing the same information as the desktop tooltip, seen on hover. A button must be pressed to confirm the selection. If false, selection is done instantly but no information regarding the object is shown to the user. If unset, it will automatically attempt to show it unless an onObjectClicked parameter is passed in.
-    * @default auto
-    */
+     * If true, a popup will show up when selecting an object on mobile containing the same information as the desktop tooltip, seen on hover. A button must be pressed to confirm the selection. If false, selection is done instantly but no information regarding the object is shown to the user. If unset, it will automatically attempt to show it unless an onObjectClicked parameter is passed in.
+     * @default auto
+     */
     confirmSelectionOnMobile?: boolean | 'auto';
 }
 export type Language = 'ar' | 'be' | 'bg' | 'ca' | 'cs' | 'cy' | 'da' | 'de' | 'el' | 'en' | 'es' | 'et' | 'fa' | 'fi' | 'fr' | 'hr' | 'he' | 'hu' | 'it' | 'ja' | 'ku' | 'li' | 'lv' | 'no' | 'nl' | 'pl' | 'pt' | 'ro' | 'ru' | 'sk' | 'sl' | 'sr' | 'sv' | 'tr' | 'uk' | 'zh-Hans' | 'zh-Hant';
@@ -594,12 +639,12 @@ export type DeprecatedConfigProperties = {
      */
     holdOnSelect?: boolean;
     /**
-    * @deprecated Use `showSectionContents: "always"` instead.
-    */
+     * @deprecated Use `showSectionContents: "always"` instead.
+     */
     alwaysShowSectionContents?: boolean;
     /**
-    * @deprecated
-    */
+     * @deprecated
+     */
     showRowLines?: boolean;
 };
 export type ChartRendererMode = 'normal' | 'print' | 'spotlight' | 'static';
@@ -662,6 +707,11 @@ interface TicketTypeJson {
     label?: string;
     formattedPrice?: PriceType;
 }
+interface TicketTypeJsonWithoutPrice {
+    ticketType?: string;
+    label?: string;
+    description?: string;
+}
 interface Labels {
     own: string;
     displayedLabel: string;
@@ -788,6 +838,10 @@ export interface SeatingChart {
     zoomToSelectedObjects: () => Promise<void>;
 }
 export interface EventManager extends Pick<SeatingChart, 'clearSelection' | 'deselectCategories' | 'deselectObjects' | 'destroy' | 'findObject' | 'listCategories' | 'listSelectedObjects' | 'render' | 'rerender' | 'resetView' | 'selectCategories' | 'selectObjects' | 'zoomToSection' | 'zoomToSelectedObjects'> {
+    setHighlightedObjects(strings: string[]): void;
+    clearHighlightedObjects(): void;
+    setFilteredSection(label: string): void;
+    clearFilteredSection(): void;
 }
 export interface Channel {
     name: string;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@seatsio/seatsio-types",
     "description": "Type definitions for Seats.io",
-    "version": "2.0.1",
+    "version": "2.1.0",
     "license": "MIT",
     "types": "dist/index.d.ts",
     "files": [