@jphil/bookwhen-client 0.0.10 → 0.1.1

package/README.md

@@ -2,7 +2,7 @@
 
 \[wip\]!
 
-An API client library for the [Bookwhen](www.bookwhen.com) booking platform [API (v2)](https://api.bookwhen.com/v2), written in Typescript for NodeJS. Intended for server-side environments.
+An API client library for the [Bookwhen](https://www.bookwhen.com) booking platform [API (v2)](https://api.bookwhen.com/v2), written in Typescript for NodeJS. Intended for server-side environments.
 
 ## Table of Contents
 
@@ -17,12 +17,12 @@ An API client library for the [Bookwhen](www.bookwhen.com) booking platform [API
 
 ## Overview
 
-You'll likely be at least somewhat familiar with the [Bookwhen](www.bookwhen.com) booking platform if you've landed here. But if not, you'll want to have a look at their [API (v2) documentation](https://api.bookwhen.com/v2). There's also a nice [Swagger style layout of the Bookwhen API v2 docs](https://petstore.swagger.io/?url=https://api.bookwhen.com/v2/openapi.yaml)
+You'll likely be at least somewhat familiar with the [Bookwhen](https://www.bookwhen.com) booking platform if you've landed here. But if not, you'll want to have a look at their [API (v2) documentation](https://api.bookwhen.com/v2). There's also a nice [Swagger style layout of the Bookwhen API v2 docs](https://petstore.swagger.io/?url=https://api.bookwhen.com/v2/openapi.yaml)
 
 ## Features
 
-- Lightweight and easy to integrate
-- Fully typed for TypeScript support
+- Provides an easy way to pull your data from Bookwhen for NodeJS environments
+- Provides fully typed methods for each model (so far just the events model) in the Bookwhen API v2
 
 ## Installation
 
@@ -34,10 +34,18 @@ pnpm add @jphil/bookwhen-client
 
 ## Usage
 
-\[wip\]!
+!N.B. this usage structure may change as I progress towards a 1.0.0
 
 ```typescript
-// ... todo
+import { createBookwhenClient } from 'bookwhen-client';
+
+const client = createBookwhenClient(YOUR_API_KEY)
+const event = client.event.getByID({myEventId});
+const events = client.event.getMultiple({
+  filters: ["filter1", "filter2"]
+  includes: ["inc1", "inc2"]
+});
+
 ```
 
 ## Configuration
@@ -56,9 +64,15 @@ Please see the docs in the CONTRIBUTIONS.md file, thanks!
 
 ## Roadmap
 
-- Keep up with any future changes or additions to the [Bookwhen API](https://api.bookwhen.com/v2).
+- Keep up with any future changes or additions to the [Bookwhen API](https://api.bookwhen.com/v2), additions will be driven mainly by this.
+- Possibly add a "fields" param to service methods to allow response filtering
+
+### Todos
+- [] put Zod in place in more areas to strengthen runtime type guards
+- [] refine error handling
+- [] write more integration tests
+- [] write services for the other integrations
 
 ## License
 
 ISC License. See [LICENSE](LICENSE) for more information.
-

package/dist/client/BookwhenClient.d.ts

@@ -0,0 +1,38 @@
+import type { AxiosInstance } from 'axios';
+import { EventService } from '../services/event/Event.js';
+/**
+ * Client for the Bookwhen API.
+ *
+ * @see https://petstore.swagger.io/?url=https://api.bookwhen.com/v2/openapi.yaml#/ClassPass/get_class_passes__class_pass_id_
+ */
+export declare class BookwhenClient {
+    private axiosInstance;
+    private eventService?;
+    /**
+     * Creates a new instance of the BookwhenClient class.
+     * @param axiosInstance - Configured Axios instance for making HTTP requests.
+     * @throws Error if axiosInstance is not provided.
+     */
+    constructor(axiosInstance: AxiosInstance);
+    /**
+     * Gets the EventService instance.
+     *
+     * Available methods:
+     * - getById(params: GetEventByIdParams): Promise<BookwhenEvent>
+     * - getMultiple(params: GetMultipleEventsParams): Promise<BookwhenEvent[]>
+     *
+     * @returns The EventService instance.
+     */
+    get events(): EventService;
+}
+interface BookwhenClientOptions {
+    apiKey: string;
+    baseURL?: string;
+}
+/**
+ * Creates an instance of Axios with the provided API key.
+ * @param apiKey - The API key used for authentication.
+ * @returns The Axios instance.
+ */
+export declare function createBookwhenClient(options: BookwhenClientOptions): BookwhenClient;
+export {};

package/dist/client/BookwhenClient.integration.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/client/BookwhenClient.integration.test.js

@@ -0,0 +1,78 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { BookwhenClient } from './BookwhenClient.js';
+import { EventService } from '../services/event/Event.js';
+vi.mock('axios');
+vi.mock('../src/services/event/Event');
+describe('BookwhenClient Integration', () => {
+    describe('BookwhenClient - Events Service', () => {
+        it('should call the correct endpoint when getById is called', async () => {
+            const mockAxiosInstance = {
+                get: vi.fn().mockResolvedValue({
+                    data: {
+                        data: { id: 'event123' }
+                    }
+                }),
+            };
+            const client = new BookwhenClient(mockAxiosInstance);
+            const eventId = 'event123';
+            const event = await client.events.getById({ eventId });
+            expect(mockAxiosInstance.get).toHaveBeenCalledWith('/events/event123');
+            expect(event).toEqual({ id: 'event123' });
+        });
+        it('should call the correct endpoint with correct parameters when events.getMultiple is called', async () => {
+            const mockAxiosInstance = {
+                get: vi.fn().mockResolvedValue({
+                    data: {
+                        data: [{ id: 'event1' }, { id: 'event2' }],
+                    },
+                }),
+            };
+            const client = new BookwhenClient(mockAxiosInstance);
+            const includes = ['location', 'tickets'];
+            const filters = {
+                title: ['Workshop'],
+                start_at: ['2023-01-01']
+            };
+            const eventsData = [
+                { id: '1', type: 'event' },
+                { id: '2', type: 'event' },
+            ];
+            const events = await client.events.getMultiple({ includes, filters });
+            expect(mockAxiosInstance.get).toHaveBeenCalledWith('/events?filter[title]=Workshop&filter[start_at]=2023-01-01&include=location,tickets');
+            expect(events).toEqual([{ id: 'event1' }, { id: 'event2' }]);
+        });
+        it('should correctly initialize and expose the events service via the client', () => {
+            const mockAxiosInstance = {};
+            const client = new BookwhenClient(mockAxiosInstance);
+            const eventsService = client.events;
+            expect(eventsService).toBeInstanceOf(EventService);
+        });
+        it('should use the same axios instance in events service as in the BookwhenClient', () => {
+            const mockAxiosInstance = {};
+            const client = new BookwhenClient(mockAxiosInstance);
+            const eventsService = client.events;
+            expect(eventsService['axiosInstance']).toBe(client['axiosInstance']);
+        });
+        it('should handle errors thrown by the events service methods', async () => {
+            const mockAxiosInstance = {
+                get: vi.fn().mockRejectedValue(new Error('Network Error')),
+            };
+            const client = new BookwhenClient(mockAxiosInstance);
+            // @ts-ignore - Testing invalid parameter type
+            await expect(client.events.getById(453453)).rejects.toThrow('events.getById: Schema Validation failed: Expected object, received number');
+            // @ts-ignore - Testing invalid parameter type
+            await expect(client.events.getById('invalidId')).rejects.toThrow('events.getById: Schema Validation failed: Expected object, received string');
+        });
+        it('should correctly pass filters and includes to events.getMultiple method', async () => {
+            const mockAxiosInstance = {
+                get: vi.fn().mockResolvedValue({ data: { data: [] } }),
+            };
+            const client = new BookwhenClient(mockAxiosInstance);
+            const filters = { tag: ['workshop', 'seminar'], from: '20220101' };
+            const includes = ['location', 'tickets.events'];
+            await client.events.getMultiple({ filters, includes });
+            expect(mockAxiosInstance.get).toHaveBeenCalledWith('/events?filter[tag]=workshop,seminar&filter[from]=20220101&include=location,tickets.events');
+        });
+    });
+});
+//# sourceMappingURL=BookwhenClient.integration.test.js.map

package/dist/client/BookwhenClient.integration.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BookwhenClient.integration.test.js","sourceRoot":"","sources":["../../src/client/BookwhenClient.integration.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAE9D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACjB,EAAE,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;AAEvC,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;QAC/C,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;YACvE,MAAM,iBAAiB,GAAG;gBACxB,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC;oBAC7B,IAAI,EAAE;wBACJ,IAAI,EAAE,EAAE,EAAE,EAAE,UAAU,EAAE;qBACzB;iBACF,CAAC;aACyB,CAAC;YAC9B,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,iBAAiB,CAAC,CAAC;YACrD,MAAM,OAAO,GAAG,UAAU,CAAC;YAC3B,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;YAEvD,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;YACvE,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4FAA4F,EAAE,KAAK,IAAI,EAAE;YAC1G,MAAM,iBAAiB,GAAG;gBACxB,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC;oBAC7B,IAAI,EAAE;wBACJ,IAAI,EAAE,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC;qBAC3C;iBACF,CAAC;aACyB,CAAC;YAC9B,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,iBAAiB,CAAC,CAAC;YACrD,MAAM,QAAQ,GAAoB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YAC1D,MAAM,OAAO,GAAG;gBACd,KAAK,EAAE,CAAC,UAAU,CAAC;gBACnB,QAAQ,EAAE,CAAC,YAAY,CAAC;aACzB,CAAC;YACF,MAAM,UAAU,GAAG;gBACjB,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE;gBAC1B,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE;aAC3B,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAC,QAAQ,EAAE,OAAO,EAAC,CAAC,CAAC;YAEpE,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,qFAAqF,CAAC,CAAC;YAC1I,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0EAA0E,EAAE,GAAG,EAAE;YAClF,MAAM,iBAAiB,GAAG,EAAmB,CAAC;YAC9C,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,iBAAiB,CAAC,CAAC;YACrD,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;YAEpC,MAAM,CAAC,aAAa,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+EAA+E,EAAE,GAAG,EAAE;YACvF,MAAM,iBAAiB,GAAG,EAAmB,CAAC;YAC9C,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,iBAAiB,CAAC,CAAC;YACrD,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;YAEpC,MAAM,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;YACzE,MAAM,iBAAiB,GAAG;gBACxB,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;aAC/B,CAAC;YAE9B,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,iBAAiB,CAAC,CAAC;YAErD,8CAA8C;YAC9C,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,4EAA4E,CAAC,CAAC;YAE1I,8CAA8C;YAC9C,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,4EAA4E,CAAC,CAAC;QACjJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yEAAyE,EAAE,KAAK,IAAI,EAAE;YACvF,MAAM,iBAAiB,GAAG;gBACxB,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,CAAC;aAC3B,CAAC;YAE9B,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,iBAAiB,CAAC,CAAC;YAErD,MAAM,OAAO,GAAG,EAAE,GAAG,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;YACnE,MAAM,QAAQ,GAAoB,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;YAEjE,MAAM,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;YAEvD,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,4FAA4F,CAAC,CAAC;QACnJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/client/BookwhenClient.js

@@ -0,0 +1,69 @@
+// src/clients/BookwhenClient.ts
+import axios from 'axios';
+import { EventService } from '../services/event/Event.js'; // Ensure this file and class are setup accordingly
+import { CLIENT_HTTP_STATUS_CODES } from '../request/httpStatusCodes.js';
+/**
+ * Client for the Bookwhen API.
+ *
+ * @see https://petstore.swagger.io/?url=https://api.bookwhen.com/v2/openapi.yaml#/ClassPass/get_class_passes__class_pass_id_
+ */
+export class BookwhenClient {
+    axiosInstance;
+    eventService;
+    /**
+     * Creates a new instance of the BookwhenClient class.
+     * @param axiosInstance - Configured Axios instance for making HTTP requests.
+     * @throws Error if axiosInstance is not provided.
+     */
+    constructor(axiosInstance) {
+        this.axiosInstance = axiosInstance;
+        if (!axiosInstance) {
+            throw new Error('BookwhenClient - you must provide an axios instance');
+        }
+    }
+    /**
+     * Gets the EventService instance.
+     *
+     * Available methods:
+     * - getById(params: GetEventByIdParams): Promise<BookwhenEvent>
+     * - getMultiple(params: GetMultipleEventsParams): Promise<BookwhenEvent[]>
+     *
+     * @returns The EventService instance.
+     */
+    get events() {
+        if (!this.eventService) {
+            this.eventService = new EventService(this.axiosInstance);
+        }
+        return this.eventService;
+    }
+}
+/**
+ * Creates an instance of Axios with the provided API key.
+ * @param apiKey - The API key used for authentication.
+ * @returns The Axios instance.
+ */
+export function createBookwhenClient(options) {
+    const { apiKey, baseURL = 'https://api.bookwhen.com/v2' } = options;
+    const axiosInstance = axios.create({
+        baseURL: baseURL,
+        auth: { username: apiKey, password: '' },
+    });
+    axiosInstance.interceptors.response.use((response) => response.data ?? response, (error) => {
+        if (error.response) {
+            const status = error.response.status;
+            const clientError = CLIENT_HTTP_STATUS_CODES[status];
+            if (clientError) {
+                return Promise.reject(new Error(clientError.message));
+            }
+        }
+        else if (error.request) {
+            throw new Error('No response received from the server');
+        }
+        else {
+            throw new Error('An error occurred setting up the request');
+        }
+        return Promise.reject(error);
+    });
+    return new BookwhenClient(axiosInstance);
+}
+//# sourceMappingURL=BookwhenClient.js.map

package/dist/client/BookwhenClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BookwhenClient.js","sourceRoot":"","sources":["../../src/client/BookwhenClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC,CAAE,mDAAmD;AAC/G,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE;;;;GAIG;AACH,MAAM,OAAO,cAAc;IAQL;IAPZ,YAAY,CAAgB;IAEpC;;;;OAIG;IACH,YAAoB,aAA4B;QAA5B,kBAAa,GAAb,aAAa,CAAe;QAC9C,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,MAAM;QACR,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACvB,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;CACF;AAOD;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAA8B;IACjE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,6BAA6B,EAAE,GAAG,OAAO,CAAC;IAEpE,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC;QACjC,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE;KACzC,CAAC,CAAC;IAEH,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CACrC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,IAAI,QAAQ,EACvC,CAAC,KAAK,EAAE,EAAE;QACR,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnB,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;YACrC,MAAM,WAAW,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC;YACrD,IAAI,WAAW,EAAE,CAAC;gBAChB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC,CACF,CAAC;IAEF,OAAO,IAAI,cAAc,CAAC,aAAa,CAAC,CAAC;AAC3C,CAAC"}

package/dist/client/BookwhenClient.unit.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/client/BookwhenClient.unit.test.js

@@ -0,0 +1,70 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import axios from 'axios';
+import { createBookwhenClient } from './BookwhenClient.js';
+import { BookwhenClient } from './BookwhenClient.js';
+import { EventService } from '../services/event/Event.js';
+vi.mock('axios');
+vi.mock('../src/services/event/Event');
+describe('BookwhenClient', () => {
+    it('should throw an error if axiosInstance is not provided', () => {
+        expect(() => new BookwhenClient(undefined)).toThrowError('BookwhenClient - you must provide an axios instance');
+    });
+    it('should assign axiosInstance correctly', () => {
+        const mockAxiosInstance = {};
+        const client = new BookwhenClient(mockAxiosInstance);
+        expect(client['axiosInstance']).toBe(mockAxiosInstance);
+    });
+    it('should expose EventService via getter', () => {
+        const mockAxiosInstance = {};
+        const client = new BookwhenClient(mockAxiosInstance);
+        const eventService = client.events;
+        expect(eventService['axiosInstance']).toBe(mockAxiosInstance);
+        expect(eventService).toBeInstanceOf(EventService);
+    });
+    it('should share axiosInstance with EventService', () => {
+        const mockAxiosInstance = {};
+        const client = new BookwhenClient(mockAxiosInstance);
+        const eventService = client.events;
+        expect(eventService['axiosInstance']).toBe(mockAxiosInstance);
+    });
+});
+describe('createBookwhenClient', () => {
+    let mockAxiosInstance;
+    beforeEach(() => {
+        // Create mock axios instance with interceptors
+        mockAxiosInstance = {
+            interceptors: {
+                response: {
+                    use: vi.fn()
+                },
+                request: {
+                    use: vi.fn()
+                }
+            }
+        };
+        // Mock axios.create to return our mock instance
+        vi.spyOn(axios, 'create').mockReturnValue(mockAxiosInstance);
+    });
+    it('should create an axiosInstance with correct config and return a BookwhenClient', () => {
+        const apiKey = 'test-api-key';
+        const client = createBookwhenClient({ apiKey });
+        expect(axios.create).toHaveBeenCalledWith({
+            baseURL: 'https://api.bookwhen.com/v2',
+            auth: { username: apiKey, password: '' },
+        });
+        expect(mockAxiosInstance.interceptors.response.use).toHaveBeenCalled();
+        expect(client).toBeInstanceOf(BookwhenClient);
+    });
+    it('should handle errors using the interceptor', async () => {
+        const axiosInstance = axios.create();
+        const errorResponse = { response: { status: 400 } };
+        vi.spyOn(axios, 'create').mockReturnValue(axiosInstance);
+        // Mock the interceptor
+        const interceptor = vi.fn();
+        axiosInstance.interceptors.response.use = interceptor;
+        createBookwhenClient({ apiKey: 'test-api-key' });
+        const [, errorHandler] = interceptor.mock.calls[0];
+        await expect(errorHandler(errorResponse)).rejects.toThrowError('BookwhenClient: Bad request');
+    });
+});
+//# sourceMappingURL=BookwhenClient.unit.test.js.map

package/dist/client/BookwhenClient.unit.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BookwhenClient.unit.test.js","sourceRoot":"","sources":["../../src/client/BookwhenClient.unit.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAC9D,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACjB,EAAE,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;AAEvC,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,cAAc,CAAC,SAAgB,CAAC,CAAC,CAAC,YAAY,CAC7D,qDAAqD,CACtD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,iBAAiB,GAAG,EAAmB,CAAC;QAC9C,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,iBAAiB,CAAC,CAAC;QAErD,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,iBAAiB,GAAG,EAAmB,CAAC;QAC9C,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,iBAAiB,CAAC,CAAC;QAErD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;QAEnC,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC9D,MAAM,CAAC,YAAY,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,iBAAiB,GAAG,EAAmB,CAAC;QAC9C,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,iBAAiB,CAAC,CAAC;QAErD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;QAEnC,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACpC,IAAI,iBAAgC,CAAC;IAErC,UAAU,CAAC,GAAG,EAAE;QACd,+CAA+C;QAC/C,iBAAiB,GAAG;YAClB,YAAY,EAAE;gBACZ,QAAQ,EAAE;oBACR,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;iBACb;gBACD,OAAO,EAAE;oBACP,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;iBACb;aACF;SAC0B,CAAC;QAE9B,gDAAgD;QAChD,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gFAAgF,EAAE,GAAG,EAAE;QACxF,MAAM,MAAM,GAAG,cAAc,CAAC;QAE9B,MAAM,MAAM,GAAG,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,oBAAoB,CAAC;YACxC,OAAO,EAAE,6BAA6B;YACtC,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE;SACzC,CAAC,CAAC;QACH,MAAM,CAAC,iBAAiB,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,gBAAgB,EAAE,CAAC;QACvE,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QAC1D,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QACrC,MAAM,aAAa,GAAG,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;QAEpD,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QAEzD,uBAAuB;QACvB,MAAM,WAAW,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;QAC5B,aAAa,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,GAAG,WAAW,CAAC;QAEtD,oBAAoB,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC,CAAC;QAEjD,MAAM,CAAC,EAAE,YAAY,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAA8C,CAAC;QAEhG,MAAM,MAAM,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,6BAA6B,CAAC,CAAC;IAChG,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -1 +1,3 @@
-export declare const test: () => void;
+export * from './types/GlobalTypes.js';
+export * from './services/event/EventInterfaces.js';
+export { createBookwhenClient } from './client/BookwhenClient.js';

package/dist/index.js

@@ -1,4 +1,4 @@
-export const test = () => {
-    console.log('hello test');
-};
+export * from './types/GlobalTypes.js';
+export * from './services/event/EventInterfaces.js';
+export { createBookwhenClient } from './client/BookwhenClient.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG,GAAG,EAAE;IACvB,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AAC5B,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,qCAAqC,CAAC;AAEpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/index.test.js

@@ -1,7 +1,8 @@
 import { describe, it, expect } from 'vitest';
-describe('something', () => {
-    it('should pass CI', () => {
-        expect(1).toBe(1);
+import { createBookwhenClient } from './index.js';
+describe('index.ts', () => {
+    it('should export BookwhenClient', () => {
+        expect(createBookwhenClient).toBeDefined();
     });
 });
 //# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE9C,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE;QACxB,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAElD,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACtB,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACpC,MAAM,CAAC,oBAAoB,CAAC,CAAC,WAAW,EAAE,CAAC;IAC/C,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/request/BookwhenRequest.d.ts

@@ -0,0 +1,46 @@
+import type { Resources, Filters } from "../types/GlobalTypes.js";
+/**
+ * QueryBuilder class to help build query strings for Bookwhen API requests.
+ */
+export declare class BookwhenRequest {
+    private path;
+    private filters;
+    private includes;
+    constructor(path: string);
+    /**
+     * Adds filters to the BookwhenQuery object.
+     * @param filters - An array of key-value pairs representing the filters to be added.
+     *
+     * Example resultant query strings:
+     * /v2/events?filter[from]=20200401&filter[to]=20200404
+     * /v2/events?filter[tag]=tag%20one,tag%20two
+     * /v2/events?filter[title]=advanced,pro&filter[detail]=masterclass
+     *
+     * @see https://petstore.swagger.io/?url=https://api.bookwhen.com/v2/openapi.yaml
+     *
+     * @returns The updated BookwhenQuery object.
+     */
+    addFilters(filters: Filters): BookwhenRequest;
+    /**
+     * Adds an include query parameter to the BookwhenRequest object.
+     * @param includes - An array of strings representing the resources to include.
+     *
+     * @returns The updated BookwhenRequest object.
+     *
+     * @throws Error if any include is not a valid string.
+     */
+    addIncludes(includes: Resources): BookwhenRequest;
+    /**
+     * Does the actual work of putting together a valid query string given:
+     * - filters
+     * - includes
+     * - segments
+     *
+     * @returns
+     */
+    build(): string;
+    /**
+     * @returns the constructed query string
+     */
+    toString(): string;
+}

package/dist/request/BookwhenRequest.js

@@ -0,0 +1,126 @@
+import z from 'zod';
+/**
+ * QueryBuilder class to help build query strings for Bookwhen API requests.
+ */
+export class BookwhenRequest {
+    path = '';
+    filters = [];
+    includes = [];
+    constructor(path) {
+        try {
+            if (!path) {
+                throw new Error('Path is required');
+            }
+            this.path = path;
+        }
+        catch (error) {
+            throw new Error("BookwhenQuery error: " + error.message);
+        }
+    }
+    /**
+     * Adds filters to the BookwhenQuery object.
+     * @param filters - An array of key-value pairs representing the filters to be added.
+     *
+     * Example resultant query strings:
+     * /v2/events?filter[from]=20200401&filter[to]=20200404
+     * /v2/events?filter[tag]=tag%20one,tag%20two
+     * /v2/events?filter[title]=advanced,pro&filter[detail]=masterclass
+     *
+     * @see https://petstore.swagger.io/?url=https://api.bookwhen.com/v2/openapi.yaml
+     *
+     * @returns The updated BookwhenQuery object.
+     */
+    addFilters(filters) {
+        // @todo add zod validation for filters?
+        try {
+            for (let key in filters) {
+                let value = filters[key];
+                if (Array.isArray(value) && value && value.length > 0) {
+                    // const encodedValues = value.map((v: string) => {
+                    //   console.log('typeof v', typeof v);
+                    //   if (typeof v === 'undefined') {
+                    //     return '';
+                    //   }
+                    //   if (v.length === 0) {
+                    //     return '';
+                    //   }
+                    //   return encodeURIComponent(v);
+                    // }).join(',');
+                    const encodedValues = value
+                        .filter((v) => typeof v === 'string' && v.length > 0)
+                        .map((v) => encodeURIComponent(v))
+                        .join(',');
+                    this.filters.push(`filter[${encodeURIComponent(key)}]=${encodedValues}`);
+                }
+                else if (typeof value === 'string' && value !== '') {
+                    if (key.length === 0) {
+                        throw new Error('Invalid filter key' + key);
+                    }
+                    this.filters.push(`filter[${encodeURIComponent(key)}]=${encodeURIComponent(value)}`);
+                }
+                else if (typeof value === 'undefined' && value !== '') {
+                    // ignore undefined values
+                }
+            }
+        }
+        catch (error) {
+            throw new Error("BookwhenQuery error: " + error.message);
+        }
+        return this;
+    }
+    /**
+     * Adds an include query parameter to the BookwhenRequest object.
+     * @param includes - An array of strings representing the resources to include.
+     *
+     * @returns The updated BookwhenRequest object.
+     *
+     * @throws Error if any include is not a valid string.
+     */
+    addIncludes(includes) {
+        try {
+            const validIncludes = includes.filter((include) => include.length > 0);
+            if (validIncludes.length !== includes.length) {
+                throw new Error('Invalid includes');
+            }
+            if (validIncludes.length > 0) {
+                const includeQuery = validIncludes.join(',');
+                this.includes.push(`include=${includeQuery}`);
+            }
+        }
+        catch (error) {
+            throw new Error("BookwhenQuery error: " + error.message);
+        }
+        return this;
+    }
+    /**
+     * Does the actual work of putting together a valid query string given:
+     * - filters
+     * - includes
+     * - segments
+     *
+     * @returns
+     */
+    build() {
+        let queryString = '';
+        // Concatenate filters and includes, if any
+        if (this.filters.length > 0) {
+            queryString += this.filters.join('&');
+        }
+        if (this.includes.length > 0) {
+            // Add '&' if filters already added to queryString
+            queryString += queryString ? '&' : '';
+            queryString += this.includes.join('&');
+        }
+        // Strip any leading slashes from this.path
+        const cleanedPath = this.path.replace(/^\/+/, '');
+        // Return the full URI, including query string only if it's non-empty
+        return `/${cleanedPath}${queryString ? '?' + queryString : ''}`;
+    }
+    /**
+     * @returns the constructed query string
+     */
+    toString() {
+        return this.build();
+    }
+}
+//# sourceMappingURL=BookwhenRequest.js.map

package/dist/request/BookwhenRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BookwhenRequest.js","sourceRoot":"","sources":["../../src/request/BookwhenRequest.ts"],"names":[],"mappings":"AACA,OAAO,CAAC,MAAM,KAAK,CAAC;AAEpB;;GAEG;AACH,MAAM,OAAO,eAAe;IAElB,IAAI,GAAW,EAAE,CAAC;IAClB,OAAO,GAAa,EAAE,CAAC;IACvB,QAAQ,GAAa,EAAE,CAAC;IAEhC,YAAY,IAAY;QACtB,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACtC,CAAC;YACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACnB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAI,KAAe,CAAC,OAAO,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,UAAU,CAAC,OAAgB;QAChC,wCAAwC;QACxC,IAAI,CAAC;YACH,KAAK,IAAI,GAAG,IAAI,OAAO,EAAE,CAAC;gBACxB,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;gBACzB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACtD,mDAAmD;oBACnD,uCAAuC;oBACvC,oCAAoC;oBACpC,iBAAiB;oBACjB,MAAM;oBACN,0BAA0B;oBAC1B,iBAAiB;oBACjB,MAAM;oBACN,kCAAkC;oBAClC,gBAAgB;oBAEhB,MAAM,aAAa,GAAG,KAAK;yBAC1B,MAAM,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;yBAC5D,GAAG,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;yBACzC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAEX,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,kBAAkB,CAAC,GAAG,CAAC,KAAK,aAAa,EAAE,CAAC,CAAC;gBAC3E,CAAC;qBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;oBACrD,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBACrB,MAAM,IAAI,KAAK,CAAC,oBAAoB,GAAG,GAAG,CAAC,CAAC;oBAC9C,CAAC;oBACD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,kBAAkB,CAAC,GAAG,CAAC,KAAK,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;gBACtF,CAAC;qBAAM,IAAI,OAAO,KAAK,KAAK,WAAW,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;oBACxD,0BAA0B;gBAC5B,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAI,KAAe,CAAC,OAAO,CAAC,CAAC;QACtE,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,WAAW,CAAC,QAAmB;QACpC,IAAI,CAAC;YACH,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACvE,IAAI,aAAa,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAC7C,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACtC,CAAC;YACD,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7B,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC7C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,YAAY,EAAE,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,uBAAuB,GAAI,KAAe,CAAC,OAAO,CAAC,CAAC;QACtE,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,KAAK;QACH,IAAI,WAAW,GAAG,EAAE,CAAC;QAErB,2CAA2C;QAC3C,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5B,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,kDAAkD;YAClD,WAAW,IAAI,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACtC,WAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,CAAC;QAED,2CAA2C;QAC3C,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAElD,qEAAqE;QACrE,OAAO,IAAI,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;CACF"}

package/dist/request/BookwhenRequest.unit.test.d.ts

@@ -0,0 +1 @@
+export {};