seatsio 72.6.0 → 73.0.0

package/README.md

@@ -275,7 +275,7 @@ console.log(`Created a chart with key ${chart.key} and an event with key: ${even
 import { SeatsioClient, Region } from 'seatsio'
 
 let client = new SeatsioClient(Region.EU(), <COMPANY ADMIN KEY>, <WORKSPACE PUBLIC KEY>)
-let categories = await client.charts.listCategories("the chart key")
+let categoryList = await client.charts.listCategories("the chart key")
 for (const category of categoryList) {
     console.log(category.label)
 }

package/package.json

@@ -1,28 +1,41 @@
 {
   "name": "seatsio",
-  "version": "72.6.0",
-  "main": "index.js",
+  "version": "73.0.0",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "files": [
+    "/dist/src"
+  ],
   "description": "Official JavaScript and Node.JS client library for the Seats.io REST API",
   "license": "MIT",
   "scripts": {
-    "lint": "eslint ./src ./tests",
-    "test": "jest --maxWorkers=8 --verbose"
+    "lint": "eslint './src/**/*.ts' './tests/**/*.ts'",
+    "test": "jest --maxWorkers=8 --verbose",
+    "build": "tsc --outDir dist"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/seatsio/seatsio-js"
   },
   "dependencies": {
-    "axios": "1.3.4"
+    "axios": "1.4.0"
   },
   "devDependencies": {
-    "eslint": "8.35.0",
+    "@jest/globals": "29.5.0",
+    "@types/jest": "29.5.1",
+    "@types/node": "20.1.5",
+    "@types/uuid": "9.0.1",
+    "@typescript-eslint/eslint-plugin": "5.59.6",
+    "@typescript-eslint/parser": "5.59.6",
+    "eslint": "8.40.0",
     "eslint-config-standard": "17.0.0",
     "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-n": "15.6.1",
+    "eslint-plugin-n": "16.0.0",
     "eslint-plugin-promise": "6.1.1",
-    "jest": "29.4.3",
-    "jest-cli": "29.4.3",
+    "jest": "29.5.0",
+    "jest-cli": "29.5.0",
+    "ts-jest": "29.1.0",
+    "typescript": "5.0.4",
     "uuid": "9.0.0"
   }
 }

package/.eslintrc.json

@@ -1,15 +0,0 @@
-{
-    "extends": "standard",
-    "env": {
-      "jest": true,
-      "amd": true
-    },
-    "globals": {
-        "client": "readable",
-        "user": "readable"
-    },
-    "rules": {
-      "indent": [ "error", 4],
-      "multiline-comment-style": ["error", "starred-block"]
-    }
-}

package/.github/dependabot.yml

@@ -1,7 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: monthly
-  open-pull-requests-limit: 10

package/.github/workflows/build.yml

@@ -1,25 +0,0 @@
-name: 'Build'
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 18
-          registry-url: https://registry.npmjs.org/
-      - run: yarn install
-      - run: yarn lint
-      - uses: zcong1993/setup-timezone@master
-        with:
-          timezone: Europe/Brussels
-      - run: yarn test

package/.github/workflows/release.yml

@@ -1,42 +0,0 @@
-# Very important!
-# Make sure that the github token has read AND WRITE access on github.
-#   1. hit https://github.com/seatsio/[REPO]/settings/actions
-#   2. under "Workflow permissions", make sure "Read and write permissions" is checked instead of the (default?) read only.
-#
-
-name: Release
-run-name: Release ${{ github.repository }}
-on:
-  workflow_dispatch:
-    inputs:
-      versionToBump:
-        description: 'The version to bump. Major for incompatible API changes, minor for adding BC features'
-        required: true
-        type: choice
-        options:
-          - minor
-          - major
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: fregante/setup-git-user@v2
-      - id: install-zx
-        run: npm i -g zx
-      - id: install-semver-tool
-        run: |
-          wget -O /usr/local/bin/semver https://raw.githubusercontent.com/fsaintjacques/semver-tool/master/src/semver
-          chmod +x /usr/local/bin/semver
-      - run: zx ./release.mjs -v $VERSION_TO_BUMP
-        env:
-          VERSION_TO_BUMP: ${{ inputs.versionToBump }}
-          GH_TOKEN: ${{ github.token }}
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 18
-          registry-url: https://registry.npmjs.org/
-      - run: yarn install
-      - run: yarn publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/gulpfile.js

@@ -1,24 +0,0 @@
-var gulp = require('gulp')
-var jest = require('gulp-jest').default
-var browserify = require('browserify')
-var tap = require('gulp-tap')
-var buffer = require('gulp-buffer')
-var uglify = require('gulp-uglify-es').default
-
-gulp.task('jest', function () {
-    return gulp.src('tests')
-        .pipe(jest({
-            preprocessorIgnorePatterns: ['<rootDir>/dist/', '<rootDir>/node_modules'],
-            automock: false
-        }))
-})
-
-gulp.task('bundle', function () {
-    return gulp.src('src/SeatsioClient.js', { read: true })
-        .pipe(tap(function (file) {
-            file.contents = browserify(file.path, { debug: true, standalone: 'SeatsioClient' }).bundle().on('error', (err) => console.log(err))
-        }))
-        .pipe(buffer())
-        .pipe(uglify())
-        .pipe(gulp.dest('build'))
-})

package/index.js

@@ -1,9 +0,0 @@
-module.exports = {
-    SeatsioClient: require('./src/SeatsioClient.js'),
-    StatusChangesParams: require('./src/Events/StatusChangesParams.js'),
-    StatusChangeRequest: require('./src/Events/StatusChangeRequest.js'),
-    TableBookingconfig: require('./src/Events/TableBookingConfig.js'),
-    ChartListParams: require('./src/Charts/ChartListParams.js'),
-    SocialDistancingRuleset: require('./src/Charts/SocialDistancingRuleset.js'),
-    Region: require('./src/Region.js')
-}

package/jest.config.json

@@ -1,7 +0,0 @@
-{
-  "transform": {},
-  "testEnvironment": "node",
-  "setupFilesAfterEnv": [
-    "<rootDir>/tests/setupTests.js"
-  ]
-}

package/release.mjs

@@ -1,92 +0,0 @@
-#!/usr/bin/env zx
-
-/*
-* Script to release the seats.io java lib.
-*   - changes the version number in README.md
-*   - changes the version number in build.gradle
-*   - creates the release in Gihub (using gh cli)
-*
-*
-* Prerequisites:
-*   - zx installed (https://github.com/google/zx)
-*   - gh cli installed (https://cli.github.com/)
-*   - semver cli installed (https://github.com/fsaintjacques/semver-tool)
-*
-* Usage:
-*   zx ./release.mjs -v major/minor -n "release notes"
-* */
-
-// don't output the commands themselves
-$.verbose = false
-
-const versionToBump = getVersionToBump()
-const latestVersion = await fetchLatestReleasedVersionNumber()
-const nextVersion = await determineNextVersionNumber(latestVersion)
-
-await pullLastVersion()
-    .then(bumpVersionInFiles)
-    .then(commitAndPush)
-    .then(release)
-
-function getVersionToBump() {
-    if (!argv.v || !(argv.v === 'minor' || argv.v === 'major')) {
-        throw new Error ("Please specify -v major/minor")
-    }
-    return argv.v
-}
-
-function removeLeadingV(tagName) {
-    if (tagName.startsWith('v')) {
-        return tagName.substring(1)
-    }
-    return tagName
-}
-
-async function fetchLatestReleasedVersionNumber() {
-    let result = await $`gh release view --json tagName`
-    let tagName = JSON.parse(result).tagName
-    return removeLeadingV(tagName)
-}
-
-async function determineNextVersionNumber(previous) {
-    return (await $`semver bump ${versionToBump} ${previous}`).stdout.trim()
-}
-
-async function bumpVersionInFiles() {
-    await replaceInFile("package.json", `"version": "${latestVersion}",`, `"version": "${nextVersion}",`)
-}
-
-async function replaceInFile(filename, latestVersion, nextVersion) {
-    return await fs.readFile(filename, 'utf8')
-        .then(text => {
-            if (text.indexOf(latestVersion) < 0) {
-                throw new Error('Not the correct version. Could not find ' + latestVersion + ' in ' + filename)
-            }
-            return text
-        })
-        .then(text => text.replace(latestVersion, nextVersion))
-        .then(text => fs.writeFileSync(filename, text))
-        .then(() => gitAdd(filename))
-}
-
-async function pullLastVersion() {
-    await $`git checkout master`
-    await $`git pull origin master`
-}
-
-async function gitAdd(filename) {
-    return await $`git add ${filename}`
-}
-
-async function commitAndPush() {
-    await $`git commit -m "version bump"`
-    await $`git push origin master`
-}
-
-async function release() {
-    const newTag = 'v' + nextVersion
-    return await $`gh release create ${newTag} --generate-notes`.catch(error => {
-        console.error('something went wrong while creating the release. Please revert the version change!')
-        throw error
-    })
-}

package/src/Accounts/Account.js

@@ -1,18 +0,0 @@
-const AccountSettings = require('./AccountSettings.js')
-
-class Account {
-    /**
-     * @param {object} account
-     */
-    constructor (account) {
-        this.secretKey = account.secretKey
-        this.designerKey = account.designerKey
-        this.publicKey = account.publicKey
-        this.settings = new AccountSettings(account.settings)
-        this.company = account.company
-        this.email = account.email
-        this.role = account.role
-    }
-}
-
-module.exports = Account

package/src/Accounts/AccountSettings.js

@@ -1,17 +0,0 @@
-const ChartValidationSettings = require('./ChartValidationSettings.js')
-const DefaultRendererSettings = require('./DefaultRendererSettings.js')
-
-class AccountSettings {
-    /**
-     * @param {object} settings
-     */
-    constructor (settings) {
-        this.draftChartDrawingsEnabled = settings.draftChartDrawingsEnabled
-        this.holdOnSelectForGAs = settings.holdOnSelectForGAs
-        this.holdPeriodInMinutes = settings.holdPeriodInMinutes
-        this.chartValidation = new ChartValidationSettings(settings.chartValidation)
-        this.defaultRendererSettings = new DefaultRendererSettings(settings.defaultRendererSettings)
-    }
-}
-
-module.exports = AccountSettings

package/src/Accounts/Accounts.js

@@ -1,71 +0,0 @@
-const Account = require('./Account.js')
-
-const baseUrl = '/accounts/me'
-
-class Accounts {
-    constructor (client) {
-        this.client = client
-    }
-
-    /**
-     * @returns {Promise<Account>}
-     */
-    retrieveMyAccount () {
-        return this.client.get(baseUrl).then((res) => new Account(res.data))
-    }
-
-    /**
-     * @returns {Promise<string>}
-     */
-    regenerateSecretKey () {
-        return this.client.post(baseUrl + '/secret-key/actions/regenerate').then((res) => res.data.secretKey)
-    }
-
-    /**
-     * @returns {Promise<string>}
-     */
-    regenerateDesignerKey () {
-        return this.client.post(baseUrl + '/designer-key/actions/regenerate').then((res) => res.data.designerKey)
-    }
-
-    /**
-     * @returns {Promise}
-     */
-    enableDraftChartDrawings () {
-        return this.client.post(baseUrl + '/draft-chart-drawings/actions/enable')
-    }
-
-    /**
-     * @returns {Promise} Promise
-     */
-    disableDraftChartDrawings () {
-        return this.client.post(baseUrl + '/draft-chart-drawings/actions/disable')
-    }
-
-    /**
-     * @param {string} password
-     * @returns {Promise} Promise
-     */
-    changePassword (password) {
-        return this.client.post(baseUrl + '/actions/change-password', { password })
-    }
-
-    /**
-     * @param {number} holdPeriodInMinutes
-     * @returns {Promise} Promise
-     */
-    changeHoldPeriod (holdPeriodInMinutes) {
-        return this.client.post(baseUrl + '/actions/change-hold-period', { holdPeriodInMinutes })
-    }
-
-    /**
-     * @param {string} key
-     * @param {string} value
-     * @returns {Promise} Promise
-     */
-    updateSetting (key, value) {
-        return this.client.post(baseUrl + '/settings', { key, value })
-    }
-}
-
-module.exports = Accounts

package/src/Accounts/ChartValidationSettings.js

@@ -1,15 +0,0 @@
-class ChartValidationSettings {
-    /**
-     * @param {object} chartValidations
-     */
-    constructor (chartValidations) {
-        this.VALIDATE_DUPLICATE_LABELS = chartValidations.VALIDATE_DUPLICATE_LABELS
-        this.VALIDATE_OBJECTS_WITHOUT_CATEGORIES = chartValidations.VALIDATE_OBJECTS_WITHOUT_CATEGORIES
-        this.VALIDATE_UNLABELED_OBJECTS = chartValidations.VALIDATE_UNLABELED_OBJECTS
-        this.VALIDATE_FOCAL_POINT = chartValidations.VALIDATE_FOCAL_POINT
-        this.VALIDATE_OBJECT_TYPES_PER_CATEGORY = chartValidations.VALIDATE_OBJECT_TYPES_PER_CATEGORY
-        this.VALIDATE_EMPTY_FLOOR = chartValidations.VALIDATE_EMPTY_FLOOR
-    }
-}
-
-module.exports = ChartValidationSettings

package/src/Accounts/DefaultRendererSettings.js

@@ -1,11 +0,0 @@
-class DefaultRendererSettings {
-    /**
-     * @param {object} defaultRendererSettings
-     */
-    constructor (defaultRendererSettings) {
-        this.showFullScreenButton = defaultRendererSettings.showFullScreenButton
-        this.multiSelectEnabled = defaultRendererSettings.multiSelectEnabled
-    }
-}
-
-module.exports = DefaultRendererSettings

package/src/AsyncIterator.js

@@ -1,160 +0,0 @@
-const Page = require('./Page.js')
-const StatusChange = require('./Events/StatusChange.js')
-const Chart = require('./Charts/Chart.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 {Axios} client
-     * @param {string} objType
-     * @param {object} params
-     */
-    constructor (url, client, objType, params = {}) {
-        this.url = url
-        this.client = client
-        this.objType = objType
-        this.params = params
-        this.items = []
-        this.pages = []
-        this.index = 0
-        this.nextPageMustBeFetched = true
-    }
-
-    charts (data) {
-        const charts = []
-        data.items.forEach((chartData) => {
-            const chart = new Chart(chartData)
-            this.items.push(chart)
-            charts.push(chart)
-        })
-
-        this.pages.push(new Page(charts, data.next_page_starts_after, data.previous_page_ends_before))
-    }
-
-    events (data) {
-        const events = []
-        data.items.forEach(eventData => {
-            const event = new EventDeserializer().fromJson(eventData)
-            this.items.push(event)
-            events.push(event)
-        })
-        this.pages.push(new Page(events, data.next_page_starts_after, data.previous_page_ends_before))
-    }
-
-    seasons (data) {
-        const seasons = []
-        data.items.forEach(seasonData => {
-            const season = new Season(seasonData)
-            this.items.push(season)
-            seasons.push(season)
-        })
-        this.pages.push(new Page(seasons, data.next_page_starts_after, data.previous_page_ends_before))
-    }
-
-    statusChanges (data) {
-        const statusChanges = []
-        data.items.forEach((statusData) => {
-            const status = new StatusChange(statusData)
-            this.items.push(status)
-            statusChanges.push(status)
-        })
-        this.pages.push(new Page(statusChanges, data.next_page_starts_after, data.previous_page_ends_before))
-    }
-
-    subaccounts (data) {
-        const subaccounts = []
-        data.items.forEach((subaccountData) => {
-            const subaccount = new Subaccount(subaccountData)
-            this.items.push(subaccount)
-            subaccounts.push(subaccount)
-        })
-        this.pages.push(new Page(subaccounts, data.next_page_starts_after, data.previous_page_ends_before))
-    }
-
-    workspaces (data) {
-        const workspaces = []
-        data.items.forEach((json) => {
-            const workspace = new Workspace(json)
-            this.items.push(workspace)
-            workspaces.push(workspace)
-        })
-        this.pages.push(new Page(workspaces, data.next_page_starts_after, data.previous_page_ends_before))
-    }
-
-    users (data) {
-        const users = []
-        data.items.forEach((userData) => {
-            const user = new User(userData)
-            this.items.push(user)
-            users.push(user)
-        })
-        this.pages.push(new Page(users, data.next_page_starts_after, data.previous_page_ends_before))
-    }
-
-    fetch (fetchParams = {}) {
-        return this.client.get(this.url, { params: fetchParams })
-            .then((res) => {
-                if (res.data.next_page_starts_after) {
-                    this.nextPageStartsAfter = res.data.next_page_starts_after
-                    this.nextPageMustBeFetched = true
-                } else {
-                    this.nextPageMustBeFetched = false
-                }
-
-                switch (this.objType) {
-                case 'charts':
-                    this.charts(res.data)
-                    break
-                case 'events':
-                    this.events(res.data)
-                    break
-                case 'seasons':
-                    this.seasons(res.data)
-                    break
-                case 'statusChanges':
-                    this.statusChanges(res.data)
-                    break
-                case 'subaccounts':
-                    this.subaccounts(res.data)
-                    break
-                case 'users':
-                    this.users(res.data)
-                    break
-                case 'workspaces':
-                    this.workspaces(res.data)
-                    break
-                default:
-                    throw new Error(`Unknown object type '${this.objType}'`)
-                }
-            })
-    }
-
-    [Symbol.asyncIterator] () {
-        const _this = this
-
-        return {
-            async next () {
-                if (_this.nextPageMustBeFetched && _this.items.length === 0) {
-                    await _this.fetch(_this.params)
-                } else if (_this.nextPageMustBeFetched && !_this.items[_this.index]) {
-                    _this.params.start_after_id = _this.nextPageStartsAfter
-                    await _this.fetch(_this.params)
-                }
-                if (!_this.items[_this.index]) {
-                    return Promise.resolve({
-                        done: true
-                    })
-                } else {
-                    return Promise.resolve({ value: _this.items[_this.index++], done: false })
-                }
-            }
-        }
-    }
-}
-
-module.exports = AsyncIterator

package/src/Charts/Category.js

@@ -1,55 +0,0 @@
-class Category {
-    /**
-     * @param {string|number} key
-     * @param {string} label
-     * @param {string} color
-     */
-    constructor (key, label, color, accessible = false) {
-        this.key = key
-        this.label = label
-        this.color = color
-        this.accessible = accessible
-    }
-
-    /**
-     * @param {string|number} key
-     * @returns {Category}
-     */
-    setKey (key) {
-        this.key = key
-        return this
-    }
-
-    /**
-     * @param {string} label
-     * @returns {Category}
-     */
-    setLabel (label) {
-        this.label = label
-        return this
-    }
-
-    /**
-     * @param {string} color
-     * @returns {Category}
-     */
-    setColor (color) {
-        this.color = color
-        return this
-    }
-
-    /**
-     * @param {boolean} accessible
-     * @returns {Category}
-     */
-    setAccessible (accessible) {
-        this.accessible = accessible
-        return this
-    }
-
-    static fromJson (json) {
-        return new Category(json.key, json.label, json.color, json.accessible)
-    }
-}
-
-module.exports = Category

package/src/Charts/Chart.js

@@ -1,36 +0,0 @@
-const ChartValidation = require('./ChartValidation')
-const SocialDistancingRuleset = require('./SocialDistancingRuleset')
-const EventDeserializer = require('../Events/EventDeserializer')
-
-class Chart {
-    /**
-     * @param {object} chart
-     */
-    constructor (chart) {
-        this.name = chart.name
-        this.id = chart.id
-        this.key = chart.key
-        this.status = chart.status
-        this.tags = chart.tags
-        this.publishedVersionThumbnailUrl = chart.publishedVersionThumbnailUrl
-        this.draftVersionThumbnailUrl = chart.draftVersionThumbnailUrl || null
-        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)
-    }
-
-    static socialDistancingRulesetsFromJson (json) {
-        if (json === undefined) {
-            return undefined
-        }
-
-        const result = {}
-        for (const key in json) {
-            result[key] = SocialDistancingRuleset.fromJson(json[key])
-        }
-        return result
-    }
-}
-
-module.exports = Chart