seatsio 66.0.0 → 67.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "seatsio",
-  "version": "66.0.0",
+  "version": "67.0.0",
   "main": "index.js",
   "description": "Official JavaScript and Node.JS client library for the Seats.io REST API",
   "license": "MIT",

package/src/AsyncIterator.js

@@ -1,16 +1,16 @@
 const Page = require('./Page.js')
 const StatusChange = require('./Events/StatusChange.js')
 const Chart = require('./Charts/Chart.js')
-const Event = require('./Events/Event.js')
 const User = require('./Users/User.js')
 const Subaccount = require('./Subaccounts/Subaccount.js')
 const Workspace = require('./Workspaces/Workspace.js')
 const Season = require('./Seasons/Season')
+const EventDeserializer = require('./Events/EventDeserializer')
 
 class AsyncIterator {
     /**
      * @param {string} url
-     * @param {SeatsioClient} client
+     * @param {Axios} client
      * @param {string} objType
      * @param {object} params
      */
@@ -39,7 +39,7 @@ class AsyncIterator {
     events (data) {
         const events = []
         data.items.forEach(eventData => {
-            const event = new Event(eventData)
+            const event = new EventDeserializer().fromJson(eventData)
             this.items.push(event)
             events.push(event)
         })

package/src/Charts/Chart.js

@@ -1,6 +1,6 @@
-const Event = require('../Events/Event.js')
 const ChartValidation = require('./ChartValidation')
 const SocialDistancingRuleset = require('./SocialDistancingRuleset')
+const EventDeserializer = require('../Events/EventDeserializer')
 
 class Chart {
     /**
@@ -14,7 +14,7 @@ class Chart {
         this.tags = chart.tags
         this.publishedVersionThumbnailUrl = chart.publishedVersionThumbnailUrl
         this.draftVersionThumbnailUrl = chart.draftVersionThumbnailUrl || null
-        this.events = chart.events ? chart.events.map(event => new Event(event)) : []
+        this.events = chart.events ? chart.events.map(event => new EventDeserializer().fromJson(event)) : []
         this.archived = chart.archived
         if (chart.validation) this.validation = new ChartValidation(chart.validation)
         this.socialDistancingRulesets = Chart.socialDistancingRulesetsFromJson(chart.socialDistancingRulesets)

package/src/Charts/Charts.js

@@ -4,7 +4,7 @@ const Chart = require('./Chart.js')
 
 class Charts {
     /**
-     * @param {SeatsioClient} client
+     * @param {Axios} client
      */
     constructor (client) {
         this.client = client

package/src/Events/Event.js

@@ -17,6 +17,10 @@ class Event {
         this.channels = event.channels ? event.channels.map(c => new Channel(c)) : null
         this.socialDistancingRulesetKey = event.socialDistancingRulesetKey
     }
+
+    isSeason () {
+        return false
+    }
 }
 
 module.exports = Event

package/src/Events/EventDeserializer.js

@@ -0,0 +1,13 @@
+const Season = require('../Seasons/Season')
+const Event = require('./Event.js')
+
+class EventDeserializer {
+    fromJson (event) {
+        if (event.isSeason) {
+            return new Season(event)
+        }
+        return new Event(event)
+    }
+}
+
+module.exports = EventDeserializer

package/src/Events/Events.js

@@ -4,11 +4,11 @@ const EventObjectInfo = require('./EventObjectInfo.js')
 const StatusChange = require('./StatusChange.js')
 const BestAvailableObjects = require('./BestAvailableObjects.js')
 const ChangeObjectStatusResult = require('./ChangeObjectStatusResult.js')
-const Event = require('./Event.js')
+const EventDeserializer = require('./EventDeserializer')
 
 class Events {
     /**
-     * @param {SeatsioClient} client
+     * @param {Axios} client
      */
     constructor (client) {
         this.client = client
@@ -40,7 +40,7 @@ class Events {
         }
 
         return this.client.post('/events', requestParameters)
-            .then((res) => new Event(res.data))
+            .then((res) => new EventDeserializer().fromJson(res.data))
     }
 
     /**
@@ -49,7 +49,7 @@ class Events {
      */
     retrieve (eventKey) {
         return this.client.get(`/events/${encodeURIComponent(eventKey)}`)
-            .then((res) => new Event(res.data))
+            .then((res) => new EventDeserializer().fromJson(res.data))
     }
 
     updateChannels (eventKey, channels) {
@@ -137,7 +137,7 @@ class Events {
      */
     iterator () {
         return new Lister('/events', this.client, 'events', (data) => {
-            const events = data.items.map(eventData => new Event(eventData))
+            const events = data.items.map(eventData => new EventDeserializer().fromJson(eventData))
             return new Page(events, data.next_page_starts_after, data.previous_page_ends_before)
         })
     }

package/src/Invitations/Invitations.js

@@ -2,7 +2,7 @@ const Invitation = require('./Invitation.js')
 
 class Invitations {
     /**
-     * @param {SeatsioClient} client
+     * @param {Axios} client
      */
     constructor (client) {
         this.client = client

package/src/Seasons/Season.js

@@ -1,15 +1,17 @@
 const Event = require('../Events/Event.js')
 
-class Season {
+class Season extends Event {
     /**
      * @param {object} season
      */
     constructor (season) {
-        this.id = season.id
-        this.key = season.key
-        this.seasonEvent = new Event(season.seasonEvent)
+        super(season)
         this.partialSeasonKeys = season.partialSeasonKeys
-        this.events = season.events.map(e => new Event(e))
+        this.events = season.events ? season.events.map(e => new Event(e)) : undefined
+    }
+
+    isSeason () {
+        return true
     }
 }
 

package/src/Seasons/Seasons.js

@@ -1,13 +1,13 @@
-const Page = require('../Page.js')
-const Lister = require('../Lister.js')
 const Season = require('./Season')
 
 class Seasons {
     /**
-     * @param {SeatsioClient} client
+     * @param {Axios} client
+     * @param {SeatsioClient} seatsioClient
      */
-    constructor (client) {
+    constructor (client, seatsioClient) {
         this.client = client
+        this.seatsioClient = seatsioClient
     }
 
     /**
@@ -66,25 +66,6 @@ class Seasons {
             .then((res) => new Season(res.data))
     }
 
-    /**
-     * @param {string} key
-     * @returns {Promise<Season>}
-     */
-    retrieve (key) {
-        return this.client.get(`/seasons/${encodeURIComponent(key)}`)
-            .then((res) => new Season(res.data))
-    }
-
-    /**
-     * @param {string} topLevelSeasonKey
-     * @param {?string} partialSeasonKey
-     * @returns {Promise<Season>}
-     */
-    retrievePartialSeason (topLevelSeasonKey, partialSeasonKey) {
-        return this.client.get(`/seasons/${encodeURIComponent(topLevelSeasonKey)}/partial-seasons/${encodeURIComponent(partialSeasonKey)}`)
-            .then((res) => new Season(res.data))
-    }
-
     /**
      * @param {string} key
      * @param {?number} numberOfEvents
@@ -118,23 +99,6 @@ class Seasons {
             .then((res) => new Season(res.data))
     }
 
-    /**
-     * @param {string} key
-     * @returns {Promise}
-     */
-    delete (key) {
-        return this.client.delete(`/seasons/${encodeURIComponent(key)}`)
-    }
-
-    /**
-     * @param {string} topLevelSeasonKey
-     * @param {string} partialSeasonKey
-     * @returns {Promise<void>}
-     */
-    deletePartialSeason (topLevelSeasonKey, partialSeasonKey) {
-        return this.client.delete(`/seasons/${encodeURIComponent(topLevelSeasonKey)}/partial-seasons/${encodeURIComponent(partialSeasonKey)}`)
-    }
-
     /**
      * @param {string} topLevelSeasonKey
      * @param {string} partialSeasonKey
@@ -147,47 +111,11 @@ class Seasons {
     }
 
     /**
-     * @param {?object} requestParameters
-     * @returns {AsyncIterator<Season>}
-     */
-    listAll (requestParameters = {}) {
-        return this.iterator().all(requestParameters)
-    }
-
-    /**
-     * @param {?number} pageSize
-     * @returns {Page<Season>}
-     */
-    listFirstPage (pageSize = null) {
-        return this.iterator().firstPage(null, pageSize)
-    }
-
-    /**
-     * @param {?string} afterId
-     * @param {?number} pageSize
-     * @returns {Page<Season>}
-     */
-    listPageAfter (afterId, pageSize = null) {
-        return this.iterator().pageAfter(afterId, null, pageSize)
-    }
-
-    /**
-     * @param {?string} beforeId
-     * @param {?number} pageSize
-     * @returns {Page<Season>}
-     */
-    listPageBefore (beforeId, pageSize = null) {
-        return this.iterator().pageBefore(beforeId, null, pageSize)
-    }
-
-    /**
-     * @returns {Lister}
+     * @param {string} key
+     * @returns {Promise<Season>}
      */
-    iterator () {
-        return new Lister('/seasons', this.client, 'seasons', (data) => {
-            const seasons = data.items.map(seasonData => new Season(seasonData))
-            return new Page(seasons, data.next_page_starts_after, data.previous_page_ends_before)
-        })
+    retrieve (key) {
+        return this.seatsioClient.events.retrieve(key)
     }
 }
 

package/src/SeatsioClient.js

@@ -23,7 +23,7 @@ class SeatsioClient {
         this.errInterceptor = this.client.interceptors.response.use(response => response, errorResponseHandler)
 
         this.charts = new Charts(this.client)
-        this.events = new Events(this.client)
+        this.events = new Events(this.client, this)
         this.subaccounts = new Subaccounts(this.client)
         this.workspaces = new Workspaces(this.client)
         this.users = new Users(this.client)
@@ -33,7 +33,7 @@ class SeatsioClient {
         this.chartReports = new ChartReports(this.client)
         this.eventReports = new EventReports(this.client)
         this.usageReports = new UsageReports(this.client)
-        this.seasons = new Seasons(this.client)
+        this.seasons = new Seasons(this.client, this)
     }
 
     _axiosConfig (baseUrl, secretKey, workspaceKey, extraHeaders) {

package/src/Subaccounts/Subaccounts.js

@@ -5,7 +5,7 @@ const Chart = require('../Charts/Chart.js')
 
 class Subaccounts {
     /**
-     * @param {SeatsioClient} client
+     * @param {Axios} client
      */
     constructor (client) {
         this.client = client

package/src/Users/Users.js

@@ -4,7 +4,7 @@ const User = require('./User.js')
 
 class Users {
     /**
-     * @param {SeatsioClient} client
+     * @param {Axios} client
      */
     constructor (client) {
         this.client = client

package/src/Workspaces/Workspaces.js

@@ -4,7 +4,7 @@ const Workspace = require('./Workspace.js')
 
 class Workspaces {
     /**
-     * @param {SeatsioClient} client
+     * @param {Axios} client
      */
     constructor (client) {
         this.client = client

package/tests/events/listAllEvents.test.js

@@ -1,7 +1,7 @@
 const testUtils = require('../testUtils.js')
 
 test('listAll events when there are more than 10 events)', async () => {
-    const { client, user } = await testUtils.createTestUserAndClient()
+    const { client } = await testUtils.createTestUserAndClient()
     const chart = await client.charts.create()
 
     const events = await testUtils.createArray(15, () => client.events.create(chart.key))
@@ -13,3 +13,18 @@ test('listAll events when there are more than 10 events)', async () => {
 
     expect(retrievedEventKeys.sort()).toEqual(events.map(e => e.key).sort())
 })
+
+test('list seasons', async () => {
+    const { client } = await testUtils.createTestUserAndClient()
+    const chart = await client.charts.create()
+    await client.seasons.create(chart.key)
+    await client.seasons.create(chart.key)
+    await client.seasons.create(chart.key)
+
+    const areSeasons = []
+    for await (const season of client.events.listAll()) {
+        areSeasons.push(season.isSeason())
+    }
+
+    expect(areSeasons).toEqual([true, true, true])
+})

package/tests/events/retrieveEvent.test.js

@@ -1,5 +1,6 @@
 const testUtils = require('../testUtils.js')
 const TableBookingConfig = require('../../src/Events/TableBookingConfig')
+const SeasonParams = require("../../src/Seasons/SeasonParams");
 
 test('should retrieve event', async () => {
     const { client, user } = await testUtils.createTestUserAndClient()
@@ -20,3 +21,25 @@ test('should retrieve event', async () => {
     expect(retrievedEvent.forSaleConfig).toBeFalsy()
     expect(retrievedEvent.updatedOn).toBeNull()
 })
+
+test('retrieve season', async () => {
+    const { client, user } = await testUtils.createTestUserAndClient()
+    const chartKey = testUtils.getChartKey()
+    await testUtils.createTestChart(chartKey, user.secretKey)
+    const season = await client.seasons.create(chartKey, new SeasonParams().eventKeys(['event1', 'event2']))
+    const partialSeason1 = await client.seasons.createPartialSeason(season.key)
+    const partialSeason2 = await client.seasons.createPartialSeason(season.key)
+
+    const retrievedSeason = await client.events.retrieve(season.key)
+
+    expect(retrievedSeason.key).toBeTruthy()
+    expect(retrievedSeason.id).toBeTruthy()
+    expect(retrievedSeason.partialSeasonKeys).toEqual([partialSeason1.key, partialSeason2.key])
+    expect(retrievedSeason.events.map(e => e.key)).toEqual(['event1', 'event2'])
+    expect(retrievedSeason.chartKey).toBe(chartKey)
+    expect(retrievedSeason.tableBookingConfig).toEqual(TableBookingConfig.inherit())
+    expect(retrievedSeason.supportsBestAvailable).toBe(true)
+    expect(retrievedSeason.createdOn).toBeInstanceOf(Date)
+    expect(retrievedSeason.forSaleConfig).toBeFalsy()
+    expect(retrievedSeason.updatedOn).toBeFalsy()
+})

package/tests/seasons/createSeason.test.js

@@ -10,20 +10,16 @@ test('chart key is required', async () => {
 
     const season = await client.seasons.create(chartKey)
 
-    expect(season.key).toBeTruthy()
-    expect(season.id).toBeTruthy()
     expect(season.partialSeasonKeys.length).toBe(0)
     expect(season.events.length).toBe(0)
-
-    const seasonEvent = season.seasonEvent
-    expect(seasonEvent.id).toBeTruthy()
-    expect(seasonEvent.key).toBe(season.key)
-    expect(seasonEvent.chartKey).toBe(chartKey)
-    expect(seasonEvent.tableBookingConfig).toEqual(TableBookingConfig.inherit())
-    expect(seasonEvent.supportsBestAvailable).toBe(true)
-    expect(seasonEvent.createdOn).toBeInstanceOf(Date)
-    expect(seasonEvent.forSaleConfig).toBeFalsy()
-    expect(seasonEvent.updatedOn).toBeFalsy()
+    expect(season.id).toBeTruthy()
+    expect(season.key).toBe(season.key)
+    expect(season.chartKey).toBe(chartKey)
+    expect(season.tableBookingConfig).toEqual(TableBookingConfig.inherit())
+    expect(season.supportsBestAvailable).toBe(true)
+    expect(season.createdOn).toBeInstanceOf(Date)
+    expect(season.forSaleConfig).toBeFalsy()
+    expect(season.updatedOn).toBeFalsy()
 })
 
 test('key can be passed in', async () => {
@@ -61,7 +57,7 @@ test('table booking config can be passed in', async () => {
 
     const season = await client.seasons.create(chartKey, new SeasonParams().tableBookingConfig(tableBookingConfig))
 
-    expect(season.seasonEvent.tableBookingConfig).toEqual(tableBookingConfig)
+    expect(season.tableBookingConfig).toEqual(tableBookingConfig)
 })
 
 test('social distancing ruleset key can be passed in', async () => {
@@ -72,5 +68,5 @@ test('social distancing ruleset key can be passed in', async () => {
 
     const season = await client.seasons.create(chart.key, new SeasonParams().socialDistancingRulesetKey('ruleset1'))
 
-    expect(season.seasonEvent.socialDistancingRulesetKey).toBe('ruleset1')
+    expect(season.socialDistancingRulesetKey).toBe('ruleset1')
 })

package/tests/seasons/retrieveSeason.test.js

@@ -16,14 +16,10 @@ test('retrieve season', async () => {
     expect(retrievedSeason.id).toBeTruthy()
     expect(retrievedSeason.partialSeasonKeys).toEqual([partialSeason1.key, partialSeason2.key])
     expect(retrievedSeason.events.map(e => e.key)).toEqual(['event1', 'event2'])
-
-    const seasonEvent = retrievedSeason.seasonEvent
-    expect(seasonEvent.id).toBeTruthy()
-    expect(seasonEvent.key).toBe(retrievedSeason.key)
-    expect(seasonEvent.chartKey).toBe(chartKey)
-    expect(seasonEvent.tableBookingConfig).toEqual(TableBookingConfig.inherit())
-    expect(seasonEvent.supportsBestAvailable).toBe(true)
-    expect(seasonEvent.createdOn).toBeInstanceOf(Date)
-    expect(seasonEvent.forSaleConfig).toBeFalsy()
-    expect(seasonEvent.updatedOn).toBeFalsy()
+    expect(retrievedSeason.chartKey).toBe(chartKey)
+    expect(retrievedSeason.tableBookingConfig).toEqual(TableBookingConfig.inherit())
+    expect(retrievedSeason.supportsBestAvailable).toBe(true)
+    expect(retrievedSeason.createdOn).toBeInstanceOf(Date)
+    expect(retrievedSeason.forSaleConfig).toBeFalsy()
+    expect(retrievedSeason.updatedOn).toBeFalsy()
 })

package/tests/seasons/deletePartialSeason.test.js

@@ -1,18 +0,0 @@
-const testUtils = require('../testUtils.js')
-
-test('delete partial season', async () => {
-    const { client, user } = await testUtils.createTestUserAndClient()
-    const chartKey = testUtils.getChartKey()
-    await testUtils.createTestChart(chartKey, user.secretKey)
-    const season = await client.seasons.create(chartKey)
-    const partialSeason = await client.seasons.createPartialSeason(season.key)
-
-    await client.seasons.deletePartialSeason(season.key, partialSeason.key)
-
-    try {
-        await client.seasons.retrievePartialSeason(season.key, partialSeason.key)
-        throw new Error('Should have failed')
-    } catch (e) {
-        expect(e.errors[0].code).toBe('SEASON_NOT_FOUND')
-    }
-})

package/tests/seasons/deleteSeason.test.js

@@ -1,17 +0,0 @@
-const testUtils = require('../testUtils.js')
-
-test('delete season', async () => {
-    const { client, user } = await testUtils.createTestUserAndClient()
-    const chartKey = testUtils.getChartKey()
-    await testUtils.createTestChart(chartKey, user.secretKey)
-    const season = await client.seasons.create(chartKey)
-
-    await client.seasons.delete(season.key)
-
-    try {
-        await client.seasons.retrieve(season.key)
-        throw new Error('Should have failed')
-    } catch (e) {
-        expect(e.errors[0].code).toBe('SEASON_NOT_FOUND')
-    }
-})

package/tests/seasons/listAllSeasons.test.js

@@ -1,16 +0,0 @@
-const testUtils = require('../testUtils.js')
-
-test('list all seasons', async () => {
-    const { client } = await testUtils.createTestUserAndClient()
-    const chart = await client.charts.create()
-    const season1 = await client.seasons.create(chart.key)
-    const season2 = await client.seasons.create(chart.key)
-    const season3 = await client.seasons.create(chart.key)
-
-    const retrievedSeasonKeys = []
-    for await (const season of client.seasons.listAll()) {
-        retrievedSeasonKeys.push(season.key)
-    }
-
-    expect(retrievedSeasonKeys).toEqual([season3.key, season2.key, season1.key])
-})

package/tests/seasons/retrievePartialSeason.test.js

@@ -1,25 +0,0 @@
-const testUtils = require('../testUtils.js')
-const TableBookingConfig = require('../../src/Events/TableBookingConfig')
-
-test('retrieve partial season', async () => {
-    const { client, user } = await testUtils.createTestUserAndClient()
-    const chartKey = testUtils.getChartKey()
-    await testUtils.createTestChart(chartKey, user.secretKey)
-    const season = await client.seasons.create(chartKey)
-    const partialSeason = await client.seasons.createPartialSeason(season.key)
-
-    const retrievedPartialSeason = await client.seasons.retrievePartialSeason(season.key, partialSeason.key)
-
-    expect(retrievedPartialSeason.key).toBe(partialSeason.key)
-    expect(retrievedPartialSeason.id).toBeTruthy()
-
-    const seasonEvent = retrievedPartialSeason.seasonEvent
-    expect(seasonEvent.id).toBeTruthy()
-    expect(seasonEvent.key).toBe(retrievedPartialSeason.key)
-    expect(seasonEvent.chartKey).toBe(chartKey)
-    expect(seasonEvent.tableBookingConfig).toEqual(TableBookingConfig.inherit())
-    expect(seasonEvent.supportsBestAvailable).toBe(true)
-    expect(seasonEvent.createdOn).toBeInstanceOf(Date)
-    expect(seasonEvent.forSaleConfig).toBeFalsy()
-    expect(seasonEvent.updatedOn).toBeFalsy()
-})