@seatsio/seatsio-types 3.6.0 → 4.1.0

package/dist/index.d.ts

@@ -100,11 +100,11 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
     /**
      * Render the chart with the specified objects selected (if they are still free). {@link https://docs.seats.io/docs/renderer/config-selectedobjects See documentation}
      */
-    selectedObjects?: (string | SelectedObject | SelectedGA)[];
+    selectedObjects?: (string | SelectedAmount)[];
     /**
      * Render the chart with the specified objects selectable. {@link https://docs.seats.io/docs/renderer/selectableobjects See documentation}
      */
-    selectableObjects?: string[];
+    selectableObjects?: (string | SelectableAmount)[];
     /**
      * Selection validators run every time a seat is selected or deselected. They check whether there are no orphan seats, and/or whether all selected seats are consecutive (meaning: next to each other and in the same category). {@link https://docs.seats.io/docs/renderer/config-selectionvalidators See documentation}
      */
@@ -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;
@@ -383,7 +383,7 @@ export interface EventManagerSelectModeConfigOptions extends BaseEventManagerCon
     maxSelectedObjects?: SelectionLimiter;
     numberOfPlacesToSelect?: number;
     isObjectSelectable?: (object: SelectableObject) => boolean;
-    selectedObjects?: (string | SelectedObject | SelectedGA)[];
+    selectedObjects?: (string | SelectedAmount)[];
     selectionBy?: 'places' | 'objects';
     ticketTypes?: TicketTypeJsonWithoutPrice[];
     tooltipContents?: (object: object) => string;
@@ -559,7 +559,7 @@ export type Floor = {
 export type Category = {
     accessible: boolean;
     color: string;
-    key: number;
+    key: CategoryKey;
     label: string;
     pricing: {
         price: number;
@@ -594,7 +594,7 @@ export type CategoryLimiter = {
     quantity: number;
 };
 export type CategoryAndTicketLimiter = {
-    category: string;
+    category: CategoryKey;
     ticketTypes: TicketTypeLimiter[];
 };
 export interface ChartRendererObjectTooltip {
@@ -724,8 +724,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 +755,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';
@@ -760,11 +772,7 @@ interface SelectionValidatorMinimumSelectedPlaces {
     type: 'minimumSelectedPlaces';
     minimum: number;
 }
-export interface SelectedObject {
-    label: string;
-    ticketType: string;
-}
-export interface SelectedGA {
+export interface SelectableAmount {
     label: string;
     amount: number;
 }
@@ -869,6 +877,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;
@@ -911,7 +920,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;
@@ -919,8 +927,8 @@ 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>;
+    deselectCategories: (categories: CategoryKey[]) => Promise<void>;
+    deselectObjects: (objects: (string | SelectedAmount)[]) => Promise<void>;
     destroy: () => void;
     findObject: (label: string) => Promise<SelectableObject>;
     getReportBySelectability: () => Promise<Object>;
@@ -930,9 +938,9 @@ 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 | Selection)[]) => Promise<void>;
+    selectObjects: (objects: (string | SelectedAmount)[]) => Promise<void>;
     pulse: (objects: string[]) => Promise<void>;
     unpulse: (objects: string[]) => Promise<void>;
     startNewSession: () => Promise<void>;
@@ -953,8 +961,8 @@ export interface Channel {
     color: string;
     index: number;
 }
-export type Selection = {
-    id: string;
+export type SelectedAmount = {
+    label: string;
     ticketType?: string;
     amount?: number;
 };

package/package.json

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