Add config listings, listing types, and listing pricing types (#66)

Author: bverbeken

src/index.test.ts

@@ -52,6 +52,14 @@ const fullChartRendererConfig: Required<ChartRendererConfigOptions> = {
     ],
     priceFormatter: price => '$' + price,
     showSectionPricingOverlay: true,
+    listings: [
+        { id: 'vip', objects: ['A-1', 'A-2'], selectAsGroup: true, listingType: 'premium' },
+        { id: 'hot', objects: ['B-1'] }
+    ],
+    listingTypes: {
+        premium: { label: 'Premium', icon: 'star' },
+        hot: { label: 'Hot', icon: 'fire' }
+    },
     selectedObjects: [
         'A-1',
         {
@@ -612,6 +620,10 @@ const objectPricing: Required<Pricing> = {
         { objects: ['A-1', 'A-2'], price: 10, fee: 1 },
         { objects: ['A-1', 'A-2'], ticketTypes: [
             { ticketType: 'Adult', price: 10, fee: 1 }
+        ]},
+        { listing: 'vip', price: 100, originalPrice: 120, fee: 2 },
+        { listing: 'hot', ticketTypes: [
+            { ticketType: 'adult', price: 30, fee: 1 }
         ]
     }],
     showSectionPricingOverlay: true

src/index.ts

@@ -96,6 +96,14 @@ export interface ChartRendererConfigOptions extends DeprecatedConfigProperties,
      * Seats supports two types of pricing: simple pricing and multi-level pricing. {@link https://docs.seats.io/docs/renderer/config-pricing See documentation}
      */
     pricing?: Pricing
+    /**
+     * Groups objects into listings that can be configured with a type and selected together.
+     */
+    listings?: ConfigListing[]
+    /**
+     * Defines the available listing types, each with an optional icon and label.
+     */
+    listingTypes?: ListingTypes
     /**
      * 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}
      */
@@ -1277,6 +1285,18 @@ export type MultiLevelPricingForObjects = {
     ticketTypes: TicketType[]
 }
 
+export type SimplePricingForListing = {
+    listing: string
+    originalPrice?: number
+    price: number
+    fee?: number
+}
+
+export type MultiLevelPricingForListing = {
+    listing: string
+    ticketTypes: TicketType[]
+}
+
 export type ChannelPricing = (SimpleChannelPricing | MultiLevelChannelPricing)
 
 export type SimpleChannelPricing = {
@@ -1306,6 +1326,7 @@ export type TicketType = {
 
 export type PricingForCategory = (SimplePricing | MultiLevelPricing)
 export type PricingForObjects = (SimplePricingForObjects | MultiLevelPricingForObjects)
+export type PricingForListing = (SimplePricingForListing | MultiLevelPricingForListing)
 
 // Legacy types for backwards compatibility
 type LegacySimplePricing = Omit<SimplePricing, 'fee'>
@@ -1319,7 +1340,7 @@ export type LegacyPricing = (LegacyPricingForCategory | LegacyPricingForObjects)
 export type Pricing = {
     allFeesIncluded?: boolean
     priceFormatter?: (price: number) => string
-    prices: (PricingForCategory | PricingForObjects)[],
+    prices: (PricingForCategory | PricingForObjects | PricingForListing)[],
     showSectionPricingOverlay?: boolean
 } | LegacyPricing
 
@@ -1639,6 +1660,20 @@ export type ListingBySection = {
     quantity: number
 }
 
+export interface ConfigListing {
+    id: string
+    objects?: string[]
+    listingType?: string
+    selectAsGroup?: boolean
+}
+
+export interface ListingType {
+    icon?: string
+    label?: string
+}
+
+export type ListingTypes = Dict<ListingType>
+
 // Runtime type helper functions
 export function isBooth(object: SelectableObject): object is Booth {
     return object.objectType === 'Booth'