@seatsio/seatsio-types 2.3.0 → 2.4.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 seats.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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?: string) => boolean;
+    canGASelectionBeIncreased?: (gaArea: GeneralAdmissionAreaProps, 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}
@@ -441,17 +441,17 @@ export type ChartRendererCallbacks = {
     onFloorChanged?: (floor?: Floor) => void;
     onFullScreenClosed?: () => void;
     onFullScreenOpened?: () => void;
-    onHoldFailed?: (objects: BookableObjectProps[], ticketTypes: string[]) => void;
-    onHoldSucceeded?: (objects: BookableObjectProps[], ticketTypes: string[]) => void;
+    onHoldFailed?: (objects: BookableObjectProps[], ticketTypes: TicketTypeJson[]) => void;
+    onHoldSucceeded?: (objects: BookableObjectProps[], ticketTypes: TicketTypeJson[]) => void;
     onHoldTokenExpired?: () => void;
     onObjectClicked?: (object: SelectableObjectProps) => void;
-    onObjectDeselected?: (object: BookableObjectProps, selectedTicketType: string) => void;
+    onObjectDeselected?: (object: BookableObjectProps, selectedTicketType: TicketTypeJson) => void;
     onObjectMouseOut?: (object: SelectableObjectProps) => void;
     onObjectMouseOver?: (object: SelectableObjectProps) => void;
-    onObjectSelected?: (object: SelectableObjectProps, selectedTicketType: string) => void;
+    onObjectSelected?: (object: SelectableObjectProps, selectedTicketType: TicketTypeJson) => void;
     onObjectStatusChanged?: (object: BookableObjectProps) => void;
-    onReleaseHoldFailed?: (objects: BookableObjectProps[], ticketTypes: string[]) => void;
-    onReleaseHoldSucceeded?: (objects: BookableObjectProps[], ticketTypes: string[]) => void;
+    onReleaseHoldFailed?: (objects: BookableObjectProps[], ticketTypes: TicketTypeJson[]) => void;
+    onReleaseHoldSucceeded?: (objects: BookableObjectProps[], ticketTypes: TicketTypeJson[]) => void;
     onSelectedObjectBooked?: (object: BookableObjectProps) => void;
     onSelectionInvalid?: (violations: string[]) => void;
     onSelectionValid?: () => void;
@@ -699,9 +699,9 @@ export interface CategoryToJSON {
 export interface PricingJson {
     price?: PriceType;
     formattedPrice?: PriceType;
-    ticketTypes?: TicketTypeJson[];
+    ticketTypes?: TicketTypeJsonForPricing[];
 }
-interface TicketTypeJson {
+interface TicketTypeJsonForPricing {
     ticketType?: string;
     price?: PriceType;
     label?: string;
@@ -712,6 +712,15 @@ interface TicketTypeJsonWithoutPrice {
     label?: string;
     description?: string;
 }
+export interface TicketTypeJson {
+    ticketType: string;
+    price: number;
+    originalPrice?: number;
+    label?: string;
+    description?: string;
+    formattedPrice: string;
+    formattedOriginalPrice?: string;
+}
 interface Labels {
     own: string;
     displayedLabel: string;
@@ -823,19 +832,19 @@ export interface SeatingChart {
     changeConfig: (config: ConfigChange) => Promise<void>;
     clearSelection: () => Promise<void>;
     deselectCategories: (categoryIds: string[]) => Promise<void>;
-    deselectObjects: (objects: string[] | Selection[]) => Promise<void>;
+    deselectObjects: (objects: (string | Selection)[]) => Promise<void>;
     destroy: () => void;
-    findObject: (label: string) => Promise<SelectableObjectProps>;
+    findObject: <T extends SelectableObjectProps>(label: string) => Promise<T>;
     getReportBySelectability: () => Promise<Object>;
     holdToken: string;
     listCategories: () => Promise<Category[]>;
-    listSelectedObjects: () => Promise<(any)[]>;
+    listSelectedObjects: <T extends SelectableObjectProps>() => Promise<T[]>;
     render: () => SeatingChart;
     rerender: () => void;
     resetView: () => Promise<void>;
     selectCategories: (categoryIds: string[]) => Promise<void>;
     selectedObjects: string[];
-    selectObjects: (objects: string[] | Selection[]) => Promise<void>;
+    selectObjects: (objects: (string | Selection)[]) => Promise<void>;
     pulse: (objects: string[]) => Promise<void>;
     unpulse: (objects: string[]) => Promise<void>;
     startNewSession: () => Promise<void>;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@seatsio/seatsio-types",
     "description": "Type definitions for Seats.io",
-    "version": "2.3.0",
+    "version": "2.4.2",
     "license": "MIT",
     "types": "dist/index.d.ts",
     "files": [
@@ -15,8 +15,8 @@
     },
     "scripts": {
         "build": "tsc",
-        "test": "yarn tsc src/index.test.ts",
-        "watch": "tsc --watch",
+        "test": "yarn tsc --noEmit src/index.test.ts",
+        "test:watch": "tsc --watch src/index.test.ts",
         "bump-version": "node scripts/bumpVersion.mjs"
     }
 }