@jphil/bookwhen-client 0.5.1 → 0.6.0

package/README.md

@@ -109,7 +109,7 @@ Project docs are intentionally lightweight and living:
 
 ## Roadmap
 
-- Expand coverage to remaining Bookwhen v2 content models.
+- Improve and consolidate shared JSON:API typing across model services.
 - Continue improving test depth across browser and Node environments.
 - Iterate toward a stable 1.0 release with community feedback.
 

package/dist/index.d.ts

@@ -229,12 +229,24 @@ declare class EventService implements IEventService {
      */
     getById(params: z.infer<typeof GetEventByIdParamsSchema>): Promise<EventResponse>;
     /**
-     * Retrieves multiple events based on filtering and pagination parameters.
+     * Retrieves a single page of events based on filtering and pagination parameters.
+     * The Bookwhen API returns up to 20 events per page by default.
      *
      * @param {GetMultipleEventsParams} params - Optional parameters for filtering and pagination.
      * @return {Promise<EventsResponse>} A Promise that resolves to the full JSON:API response object.
      */
     getMultiple(params?: GetMultipleEventsParams): Promise<EventsResponse>;
+    /**
+     * Retrieves all events matching the given filters, automatically following
+     * pagination links to fetch every page of results.
+     *
+     * The returned response contains the combined `data` and deduplicated
+     * `included` arrays from all pages.
+     *
+     * @param {GetMultipleEventsParams} params - Optional parameters for filtering.
+     * @return {Promise<EventsResponse>} A Promise that resolves to the combined JSON:API response.
+     */
+    getAll(params?: GetMultipleEventsParams): Promise<EventsResponse>;
 }
 
 declare interface EventsResponse extends JsonApiResponse<BookwhenEvent[]> {
@@ -371,11 +383,18 @@ export declare interface IEventService {
      */
     getById(params: GetEventByIdParams): Promise<EventResponse>;
     /**
-     * Retrieves multiple events based on specified parameters.
+     * Retrieves a single page of events based on specified parameters.
      * @param params Optional parameters to filter and control the list of returned events, according to what the Bookwhen API supports.
      * @returns A Promise that resolves to the full JSON:API response object.
      */
     getMultiple?(params?: GetMultipleEventsParams): Promise<EventsResponse>;
+    /**
+     * Retrieves all events matching the given filters, automatically following
+     * pagination links to fetch every page of results.
+     * @param params Optional parameters to filter the returned events.
+     * @returns A Promise that resolves to the combined JSON:API response with all pages merged.
+     */
+    getAll?(params?: GetMultipleEventsParams): Promise<EventsResponse>;
 }
 
 export declare interface ILocationService {

package/dist/index.js

@@ -6481,7 +6481,8 @@ class EventService {
     }
   }
   /**
-   * Retrieves multiple events based on filtering and pagination parameters.
+   * Retrieves a single page of events based on filtering and pagination parameters.
+   * The Bookwhen API returns up to 20 events per page by default.
    *
    * @param {GetMultipleEventsParams} params - Optional parameters for filtering and pagination.
    * @return {Promise<EventsResponse>} A Promise that resolves to the full JSON:API response object.
@@ -6497,6 +6498,50 @@ class EventService {
       handleServiceHTTPErrors(error, SERVICE_HTTP_STATUS_CODES);
     }
   }
+  /**
+   * Retrieves all events matching the given filters, automatically following
+   * pagination links to fetch every page of results.
+   *
+   * The returned response contains the combined `data` and deduplicated
+   * `included` arrays from all pages.
+   *
+   * @param {GetMultipleEventsParams} params - Optional parameters for filtering.
+   * @return {Promise<EventsResponse>} A Promise that resolves to the combined JSON:API response.
+   */
+  async getAll(params = {}) {
+    const firstPage = await this.getMultiple(params);
+    if (!firstPage?.data || !firstPage.links?.next) {
+      return firstPage;
+    }
+    const allData = [...firstPage.data];
+    const includedById = /* @__PURE__ */ new Map();
+    if (firstPage.included) {
+      for (const item of firstPage.included) {
+        includedById.set(`${item.type}:${item.id}`, item);
+      }
+    }
+    let nextUrl = firstPage.links.next;
+    while (nextUrl) {
+      try {
+        const page = (await this.axiosInstance.get(nextUrl)).data;
+        if (page.data) {
+          allData.push(...page.data);
+        }
+        if (page.included) {
+          for (const item of page.included) {
+            includedById.set(`${item.type}:${item.id}`, item);
+          }
+        }
+        nextUrl = page.links?.next;
+      } catch (error) {
+        handleServiceHTTPErrors(error, SERVICE_HTTP_STATUS_CODES);
+      }
+    }
+    return {
+      data: allData,
+      included: includedById.size > 0 ? Array.from(includedById.values()) : void 0
+    };
+  }
 }
 const TicketResourceSchema = z.enum([
   "class_passes",