bmlt-query-client 1.0.6 → 1.0.8

package/PROJECT_SUMMARY.md

@@ -87,7 +87,7 @@ import { BmltClient, Weekday, VenueType } from 'bmlt-query-client';
 
 // Initialize client with NYC demo server
 const client = new BmltClient({
-  rootServerURL: 'https://latest.aws.bmlt.app/main_server',
+  serverURL: 'https://latest.aws.bmlt.app/main_server',
 });
 
 // Search by address with automatic geocoding

package/README.md

@@ -38,7 +38,7 @@ The easiest way to use the BMLT Query Client in the browser is via ES modules:
 
   // Initialize the client
   const client = new BmltClient({
-    rootServerURL: 'https://latest.aws.bmlt.app/main_server', // NYC demo server
+    serverURL: 'https://latest.aws.bmlt.app/main_server', // NYC demo server
   });
 
   // Search for virtual meetings
@@ -72,7 +72,7 @@ npm install bmlt-query-client
 import { BmltClient, VenueType, MeetingQueryBuilder } from 'bmlt-query-client';
 
 const client = new BmltClient({
-  rootServerURL: 'https://your-bmlt-server.org/main_server',
+  serverURL: 'https://your-bmlt-server.org/main_server',
 });
 
 // Search for meetings
@@ -253,9 +253,9 @@ console.log(client.getUserAgent()); // 'my-updated-app/2.0.0'
 client.setTimeout(60000); // 60 seconds
 console.log(client.getTimeout()); // 60000
 
-// Update root server URL
-client.setRootServerURL('https://new-server.org/main_server');
-console.log(client.getRootServerURL());
+// Update server URL
+client.setServerURL('https://new-server.org/main_server');
+console.log(client.getServerURL());
 
 // Update default data format
 client.setDefaultFormat(BmltDataFormat.JSONP);
@@ -266,7 +266,7 @@ console.log(client.getDefaultFormat());
 
 ```javascript
 const client = new BmltClient({
-  rootServerURL: 'https://your-server.org/main_server', // Required
+  serverURL: 'https://your-server.org/main_server', // Required
   defaultFormat: BmltDataFormat.JSON, // Optional
   timeout: 30000, // 30 seconds
   userAgent: 'my-app/1.0.0', // Custom user agent
@@ -283,7 +283,7 @@ const client = new BmltClient({
 
 ```javascript
 const client = new BmltClient({
-  rootServerURL: 'https://your-server.org/main_server',
+  serverURL: 'https://your-server.org/main_server',
   geocodingOptions: {
     countryCode: 'us', // ISO country code bias
     viewbox: [-74.2, 40.4, -73.7, 40.9], // Geographic bounding box [w,s,e,n]

package/dist/app.d.ts

@@ -11,7 +11,7 @@ export declare class BmltClient {
     private timeout;
     private userAgent;
     private readonly geocodingService?;
-    private rootServerURL;
+    private serverURL;
     private defaultFormat;
     constructor(options: BmltClientOptions);
     /**
@@ -22,6 +22,16 @@ export declare class BmltClient {
      * Search for meetings
      */
     searchMeetings(params?: SearchResultsParams): Promise<Meeting[]>;
+    /**
+     * Search for meetings and return both meetings and the formats they reference in a
+     * single request. Uses get_used_formats=true so the server wraps the response as
+     * { meetings: Meeting[], formats: Format[] } instead of a bare Meeting[].
+     *
+     * This replaces the common pattern of Promise.all([getFormats(), searchMeetings()])
+     * with a single round-trip, which matters for large servers where getFormats() can
+     * return hundreds of unused format records.
+     */
+    searchMeetingsWithFormats(params?: Omit<SearchResultsParams, 'get_used_formats' | 'get_formats_only'>): Promise<MeetingsWithFormats>;
     /**
      * Search for meetings by geographic location using geocoding
      */
@@ -71,13 +81,13 @@ export declare class BmltClient {
      */
     reverseGeocode(coordinates: Coordinates, options?: Partial<GeocodeOptions>): Promise<GeocodeResult>;
     /**
-     * Get the root server URL
+     * Get the server URL
      */
-    getRootServerURL(): string;
+    getServerURL(): string;
     /**
-     * Update the root server URL
+     * Update the server URL
      */
-    setRootServerURL(url: string): void;
+    setServerURL(url: string): void;
     /**
      * Get the default data format
      */
@@ -116,8 +126,8 @@ export declare class BmltClient {
 }
 
 export declare interface BmltClientOptions {
-    /** Root server URL */
-    rootServerURL: string;
+    /** Server URL */
+    serverURL: string;
     /** Default data format */
     defaultFormat?: BmltDataFormat;
     /** HTTP request timeout in milliseconds */
@@ -703,9 +713,9 @@ export declare class MeetingQueryBuilder {
      */
     formatsOnly(): this;
     /**
-     * Filter by root server IDs (aggregator mode)
+     * Filter by server IDs (aggregator mode)
      */
-    rootServerIds(serverIds: number | number[], exclude?: boolean): this;
+    serverIds(serverIds: number | number[], exclude?: boolean): this;
     /**
      * Get the current query parameters
      */
@@ -722,12 +732,29 @@ export declare class MeetingQueryBuilder {
      * Execute the search and return results
      */
     execute(): Promise<Meeting[]>;
+    /**
+     * Execute the search and return both meetings and the formats they reference
+     * in a single request. Equivalent to execute() but avoids a separate getFormats() call.
+     */
+    executeWithFormats(): Promise<MeetingsWithFormats>;
     /**
      * Execute the search by geocoding an address first
      */
     executeNearAddress(address: string, radiusMiles?: number, radiusKm?: number, sortByDistance?: boolean): Promise<Meeting[]>;
 }
 
+/**
+ * Combined response when get_used_formats=true is passed to GetSearchResults.
+ * The BMLT API wraps the response in an object with separate meetings and formats arrays
+ * instead of returning a bare meetings array.
+ */
+export declare interface MeetingsWithFormats {
+    /** Meetings matching the search criteria */
+    meetings: Meeting[];
+    /** Only the formats actually referenced by the returned meetings */
+    formats: Format[];
+}
+
 /**
  * Convert miles to kilometers
  */
@@ -900,8 +927,8 @@ export declare interface SearchResultsParams extends BaseSearchParams {
     page_num?: number;
     /** Published status: undefined=published only, 0=all, -1=unpublished only */
     advanced_published?: 0 | -1;
-    /** Include specific root server IDs (for aggregator mode) */
-    root_server_ids?: number | number[];
+    /** Include specific server IDs (for aggregator mode) */
+    server_ids?: number | number[];
 }
 
 export declare interface ServerInfo {
@@ -962,7 +989,7 @@ export declare enum SortKey {
 }
 
 export declare interface URLBuilderOptions {
-    rootServerURL: string;
+    serverURL: string;
     format: BmltDataFormat;
     endpoint: BmltEndpoint;
     parameters?: Record<string, unknown>;
@@ -984,9 +1011,9 @@ export declare function validateEndpointFormat(endpoint: BmltEndpoint, format: B
 export declare function validateRadius(radius: number): void;
 
 /**
- * Clean and validate a root server URL
+ * Clean and validate a server URL
  */
-export declare function validateRootServerURL(url: string): string;
+export declare function validateServerURL(url: string): string;
 
 export declare enum VenueType {
     IN_PERSON = 1,