@seatsio/seatsio-types 6.26.0 → 6.28.0

package/dist/index.d.ts

@@ -100,6 +100,10 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
      * Defines the available listing types, each with an optional icon and label.
      */
     listingTypes?: ListingTypes;
+    /**
+     * Dims out the objects that don't pass every filter. Filtered-out objects stay selectable.
+     */
+    filters?: Filters;
     /**
      * Formats the price into a custom defined string when showing it to and en user. {@link https://docs.seats.io/docs/renderer/config-priceformatter See documentation}
      */
@@ -199,6 +203,7 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
     unavailableCategories?: CategoryKey[];
     /**
      * Leaves the specified categories normally visible, while making all others dimmed out. The array can be a list of category keys or labels.
+     * @deprecated Use `filters.categories` instead.
      */
     filteredCategories?: CategoryKey[];
     objectColor?: (object: SelectableObject, defaultColor: string, extraConfig: ExtraConfig) => string;
@@ -477,7 +482,11 @@ export interface BaseEventManagerOrderModeConfigOptions extends BaseEventManager
     categoryFilter?: CategoryFilter;
     availableCategories?: CategoryKey[];
     unavailableCategories?: CategoryKey[];
+    /**
+     * @deprecated Use `filters.categories` instead.
+     */
     filteredCategories?: CategoryKey[];
+    filters?: Pick<Filters, 'categories'>;
     session?: Session;
     holdToken?: string;
     showLegend?: boolean;
@@ -579,7 +588,7 @@ export interface ChartDesignerFeatures {
 }
 export interface ChartDesigner extends Pick<SeatingChart, 'render' | 'destroy'> {
 }
-export type ConfigChange = Pick<ChartRendererConfigOptions, 'availableCategories' | 'channels' | 'extraConfig' | 'filteredCategories' | 'maxSelectedObjects' | 'numberOfPlacesToSelect' | 'objectColor' | 'objectLabel' | 'pricing' | 'unavailableCategories'>;
+export type ConfigChange = Pick<ChartRendererConfigOptions, 'availableCategories' | 'channels' | 'extraConfig' | 'filteredCategories' | 'filters' | 'maxSelectedObjects' | 'numberOfPlacesToSelect' | 'objectColor' | 'objectLabel' | 'pricing' | 'unavailableCategories'>;
 type ChartRendererBuiltInStrings = {
     [key in ChartRendererStringKey]: string;
 };
@@ -1066,23 +1075,15 @@ export interface NonBookableTableSeat extends InteractiveObject {
     };
 }
 export type WheelchairSpaceType = 'WHEELCHAIR_ACCESSIBLE_SEAT' | 'WHEELCHAIR_SPACE';
-export interface AbstractSelectableObject extends InteractiveObject {
+export interface AbstractSelectableObject extends InteractiveObject, Readonly<Record<FilterableAccessibleType, boolean | undefined>> {
     readonly objectType: string;
     readonly selected: boolean;
     readonly selectedTicketType: string | undefined;
-    readonly accessible: boolean | undefined;
     readonly wheelchairSpaceType: WheelchairSpaceType | undefined;
-    readonly hearingImpaired: boolean | undefined;
-    readonly signLanguageInterpretation: boolean | undefined;
-    readonly cartServices: boolean | undefined;
-    readonly plusSize: boolean | undefined;
     readonly restrictedView: boolean | undefined;
     readonly vertigo: boolean | undefined;
     readonly limitedLegroom: boolean | undefined;
     readonly companionSeat: boolean | undefined;
-    readonly semiAmbulatorySeat: boolean | undefined;
-    readonly liftUpArmrests: boolean | undefined;
-    readonly aisleSeat: boolean | undefined;
     readonly displayObjectType: string | undefined;
     readonly category?: CategoryToJSON;
     readonly pricing: PricingJson;
@@ -1254,6 +1255,19 @@ export interface ListingType {
     iconColor?: string;
 }
 export type ListingTypes = Dict<ListingType>;
+export type FilterableAccessibleType = 'accessible' | 'semiAmbulatorySeat' | 'hearingImpaired' | 'signLanguageInterpretation' | 'cartServices' | 'plusSize' | 'liftUpArmrests' | 'aisleSeat';
+export type ListingTypeFilter = 'primary' | 'resale' | 'both';
+export interface Filters {
+    price?: {
+        min?: number;
+        max?: number;
+    };
+    categories?: CategoryKey[];
+    ticketTypes?: string[];
+    sections?: string[];
+    accessibilityTypes?: FilterableAccessibleType[];
+    listingType?: ListingTypeFilter;
+}
 export declare function isBooth(object: SelectableObject): object is Booth;
 export declare function isSeat(object: SelectableObject): object is Seat;
 export declare function isGeneralAdmission(object: SelectableObject): object is GeneralAdmissionArea;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@seatsio/seatsio-types",
     "description": "Type definitions for Seats.io",
-    "version": "6.26.0",
+    "version": "6.28.0",
     "license": "MIT",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",