@seatsio/seatsio-types 4.0.0 → 4.1.1

package/dist/index.d.ts

@@ -171,15 +171,15 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
      */
     categoryFilter?: CategoryFilter;
     /**
-     * Makes the specified categories available from selection, while making all others unavailable from selection. The array can be a list of category IDs or labels.
+     * Makes the specified categories available from selection, while making all others unavailable from selection. The array can be a list of category keys or labels.
      */
     availableCategories?: CategoryKey[];
     /**
-     * Makes the specified categories unavailable from selection. The array can be a list of category IDs or labels.
+     * Makes the specified categories unavailable from selection. The array can be a list of category keys or labels.
      */
     unavailableCategories?: CategoryKey[];
     /**
-     * Leaves the specified categories normally visible, while making all others dimmed out. The array can be a list of category IDs or labels.
+     * Leaves the specified categories normally visible, while making all others dimmed out. The array can be a list of category keys or labels.
      */
     filteredCategories?: CategoryKey[];
     objectColor?: (object: SelectableObject, defaultColor: string, extraConfig: ExtraConfig) => string;
@@ -308,6 +308,10 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
      * Called when the chart needs to prompt how many places to select for each ticket type. {@link https://docs.seats.io/docs/renderer/prompts-api/onPlacesWithTicketTypesPrompt See documentation}
      */
     onPlacesWithTicketTypesPrompt?: (parameters: PlacesWithTicketTypesPromptParameters, confirmSelection: (placesPerTicketType: Dict<number> | string[]) => void) => void;
+    /**
+     * For charts with sections, enabling this setting will hide sections where all bookable objects are set as not for sale. By extension, this will also hide entire floors if every object on it is set as not for sale. {@link https://docs.seats.io/docs/renderer/config-hidesectionsnotforsale/ See documentation}
+     */
+    hideSectionsNotForSale?: boolean;
 }
 export type ExtractedEventManagerProps = Pick<ChartRendererConfigOptions, 'colors' | 'colorScheme' | 'extraConfig' | 'fitTo' | 'objectColor' | 'showFullScreenButton' | 'style' | 'stylePreset' | 'tooltipInfo' | 'themePreset' | 'themeColors'>;
 export interface BaseEventManagerConfigOptions extends CommonConfigOptions, ExtractedEventManagerProps, EventManagerCallbacks {
@@ -559,7 +563,7 @@ export type Floor = {
 export type Category = {
     accessible: boolean;
     color: string;
-    key: number;
+    key: CategoryKey;
     label: string;
     pricing: {
         price: number;
@@ -594,7 +598,7 @@ export type CategoryLimiter = {
     quantity: number;
 };
 export type CategoryAndTicketLimiter = {
-    category: string;
+    category: CategoryKey;
     ticketTypes: TicketTypeLimiter[];
 };
 export interface ChartRendererObjectTooltip {
@@ -724,8 +728,18 @@ export type SimplePricing = {
     price: number;
     channels?: ChannelPricing[];
 };
+export type SimplePricingForObjects = {
+    objects: string[];
+    originalPrice?: number;
+    price: number;
+    channels?: ChannelPricing[];
+};
 export type MultiLevelPricing = {
-    category: number | string;
+    category: CategoryKey;
+    ticketTypes: TicketType[];
+};
+export type MultiLevelPricingForObjects = {
+    objects: string[];
     ticketTypes: TicketType[];
 };
 export type ChannelPricing = (SimpleChannelPricing | MultiLevelChannelPricing);
@@ -745,7 +759,9 @@ export type TicketType = {
     label?: string;
     description?: string;
 };
-export type Pricing = (SimplePricing | MultiLevelPricing)[];
+export type PricingForCategory = (SimplePricing | MultiLevelPricing);
+export type PricingForObjects = (SimplePricingForObjects | MultiLevelPricingForObjects);
+export type Pricing = (PricingForCategory | PricingForObjects)[];
 export type SelectionValidator = SelectionValidatorNoOrphanSeats | SelectionValidatorConsecutiveSeats | SelectionValidatorMinimumSelectedPlaces;
 interface SelectionValidatorNoOrphanSeats {
     type: 'noOrphanSeats';
@@ -865,6 +881,7 @@ export interface AbstractBookableObject extends AbstractSelectableObject {
     readonly forSale: boolean;
     readonly dataPerEvent: Dict<object>;
     readonly seasonStatusOverriddenQuantity: number;
+    readonly entrance: string | null;
     inSelectableChannel?: boolean;
     hashedChannelKey?: string;
     isInChannel?: (channelKey: string) => boolean;
@@ -907,7 +924,6 @@ export interface GeneralAdmissionArea extends AbstractBookableObject {
     readonly selectionPerTicketType: Dict<number>;
     readonly holds: Dict<Dict<number>>;
     readonly dataPerEvent: Dict<object>;
-    readonly entrance: string | null;
     readonly bookAsAWhole: boolean;
 }
 export type BookableObject = Seat | GeneralAdmissionArea | Booth | Table;
@@ -915,7 +931,7 @@ export type SelectableObject = BookableObject | InteractiveSection;
 export interface SeatingChart {
     changeConfig: (config: ConfigChange) => Promise<void>;
     clearSelection: () => Promise<void>;
-    deselectCategories: (categoryIds: string[]) => Promise<void>;
+    deselectCategories: (categories: CategoryKey[]) => Promise<void>;
     deselectObjects: (objects: (string | SelectedAmount)[]) => Promise<void>;
     destroy: () => void;
     findObject: (label: string) => Promise<SelectableObject>;
@@ -926,7 +942,7 @@ export interface SeatingChart {
     render: () => SeatingChart;
     rerender: () => void;
     resetView: () => Promise<void>;
-    selectCategories: (categoryIds: string[]) => Promise<void>;
+    selectCategories: (categories: CategoryKey[]) => Promise<void>;
     selectedObjects: string[];
     selectObjects: (objects: (string | SelectedAmount)[]) => Promise<void>;
     pulse: (objects: string[]) => Promise<void>;

package/package.json

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