bmlt-query-client 1.0.2 → 1.0.3

package/.eslintrc.json

@@ -1,9 +1,7 @@
 {
   "parser": "@typescript-eslint/parser",
   "plugins": ["@typescript-eslint"],
-  "extends": [
-    "eslint:recommended"
-  ],
+  "extends": ["eslint:recommended"],
   "env": {
     "browser": true,
     "node": true,

package/.prettierignore

@@ -0,0 +1,32 @@
+# Dependencies
+node_modules/
+
+# Build outputs
+dist/
+build/
+*.d.ts
+
+# Logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Coverage
+coverage/
+
+# Cache
+.cache/
+.parcel-cache/
+
+# Misc
+.DS_Store
+.env*
+.vscode/
+.idea/
+*.tsbuildinfo
+
+# Package files
+package-lock.json
+yarn.lock
+pnpm-lock.yaml

package/.prettierrc

@@ -0,0 +1,14 @@
+{
+  "semi": true,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "bracketSpacing": true,
+  "arrowParens": "avoid",
+  "endOfLine": "lf",
+  "quoteProps": "as-needed",
+  "bracketSameLine": false,
+  "embeddedLanguageFormatting": "auto"
+}

package/PROJECT_SUMMARY.md

@@ -1,17 +1,20 @@
 # BMLT Query Client - Project Complete! 🎉
 
 ## Overview
+
 A comprehensive TypeScript client for querying BMLT (Basic Meeting List Tool) servers with built-in geocoding support using Nominatim. Successfully replaces the broken `StringSearchIsAnAddress` functionality with reliable, rate-limited geocoding.
 
 ## ✅ Completed Features
 
 ### 🚀 Core Functionality
+
 - **Full TypeScript Support** - Complete type definitions for all BMLT API endpoints
 - **All BMLT Endpoints** - Complete coverage of the BMLT Semantic API
 - **Fluent Query Builder** - Chainable methods for complex searches
 - **Geographic Search** - Address-to-coordinate conversion with radius search
 
 ### 🌍 Geocoding Service
+
 - **Nominatim Integration** - OpenStreetMap-based geocoding
 - **US Region Bias** - Defaults to US (`countryCode: 'us'`)
 - **Custom Region Support** - Country codes and viewbox restrictions
@@ -20,13 +23,16 @@ A comprehensive TypeScript client for querying BMLT (Basic Meeting List Tool) se
 - **Retry Logic** - Exponential backoff with configurable retry counts
 
 ### 🛡️ Error Handling
+
 - **Comprehensive Error Types** - Specific error classes for different failures
 - **User-Friendly Messages** - Clean error messages for end users
 - **Retry Detection** - Automatic identification of retryable vs non-retryable errors
 - **Network Resilience** - Handles timeouts, network failures, and rate limits
 
 ### 📡 API Coverage
+
 All BMLT Semantic API endpoints:
+
 - `GetSearchResults` - Meeting searches with extensive filtering
 - `GetFormats` - Available meeting formats
 - `GetServiceBodies` - Service body hierarchy
@@ -38,6 +44,7 @@ All BMLT Semantic API endpoints:
 - `GetCoverageArea` - Geographic coverage
 
 ### 🧪 Testing & Examples
+
 - **Real NYC Demo Server** - All examples use `https://latest.aws.bmlt.app/main_server`
 - **Integration Tests** - Comprehensive test suite with real API calls
 - **Working Examples** - Complete usage examples with actual NYC data
@@ -80,14 +87,14 @@ 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'
+  rootServerURL: 'https://latest.aws.bmlt.app/main_server',
 });
 
 // Search by address with automatic geocoding
 const meetings = await client.searchMeetingsByAddress({
   address: 'Times Square, New York, NY',
   radiusMiles: 2,
-  sortByDistance: true
+  sortByDistance: true,
 });
 
 // Use fluent query builder
@@ -119,11 +126,13 @@ const virtualMeetings = await new MeetingQueryBuilder(client)
 ## 📋 Next Steps
 
 ### Publishing to NPM
+
 1. Update author information in `package.json`
 2. Set up GitHub repository
 3. Run `npm publish` to release to NPM registry
 
 ### Optional Enhancements
+
 - Add caching layer for geocoding results
 - Support for additional geocoding providers
 - WebSocket support for real-time updates
@@ -152,6 +161,7 @@ npm run clean
 ## 📖 Documentation
 
 Complete documentation is available in `README.md` including:
+
 - Installation and setup instructions
 - Complete API reference
 - Working examples with NYC demo server

package/README.md

@@ -1,48 +1,57 @@
 # BMLT Query Client
 
+[![npm version](https://badge.fury.io/js/bmlt-query-client.svg)](https://badge.fury.io/js/bmlt-query-client)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Node.js](https://img.shields.io/badge/Node.js-18.0%2B-green.svg)](https://nodejs.org/)
+[![npm](https://img.shields.io/npm/v/bmlt-query-client.svg)](https://www.npmjs.com/package/bmlt-query-client)
+
 A modern TypeScript/JavaScript client for querying BMLT (Basic Meeting List Tool) servers with built-in geocoding support using the native fetch API.
 
+## Demo
+
+[https://bmlt-enabled.github.io/bmlt-query-client/](https://bmlt-enabled.github.io/bmlt-query-client/)
+
 ## Features
 
-- 🚀 **Zero dependencies** - Uses native fetch API instead of axios
+- 🚀 **Zero dependencies** - Uses native fetch API
 - 🏛️ **Complete BMLT API coverage** - All semantic endpoints supported
 - 🌍 **Built-in geocoding** - Uses Nominatim for address-to-coordinates conversion
 - 🔍 **Fluent query builder** - Chainable API for complex meeting searches
 - ⚡ **Rate limiting & retry logic** - Stable operation with automatic retries
 - 📱 **Browser ready** - Works in all modern browsers via ES modules
 - 🎯 **TypeScript support** - Full type definitions included
-- 📦 **Multiple formats** - ES modules, CommonJS, and browser bundles
+- 📦 **ES Module format** - Single optimized browser-compatible build
 
 ## Quick Start
 
-### For Browser (ES Modules - Recommended)
+### For Browser (ES Modules)
 
 The easiest way to use the BMLT Query Client in the browser is via ES modules:
 
 ```html
 <script type="module">
   // Import directly from a CDN (when published)
-  import { BmltClient, VenueType, QuickSearch } from 'https://unpkg.com/bmlt-query-client/dist/index.esm.js';
-  
+  import { BmltClient, VenueType, QuickSearch } from 'https://cdn.aws.bmlt.app/app.js';
+
   // Or import from your local build
-  // import { BmltClient, VenueType, QuickSearch } from './dist/index.esm.js';
+  // import { BmltClient, VenueType, QuickSearch } from './dist/app.js';
 
   // Initialize the client
   const client = new BmltClient({
-    rootServerURL: 'https://latest.aws.bmlt.app/main_server'  // NYC demo server
+    rootServerURL: 'https://latest.aws.bmlt.app/main_server', // NYC demo server
   });
 
   // Search for virtual meetings
   const virtualMeetings = await client.searchMeetings({
     venue_types: VenueType.VIRTUAL,
-    page_size: 10
+    page_size: 10,
   });
 
   // Search meetings by address
   const nearbyMeetings = await client.searchMeetingsByAddress({
     address: 'Times Square, New York, NY',
     radiusMiles: 5,
-    searchParams: { page_size: 10 }
+    searchParams: { page_size: 10 },
   });
 
   // Use the fluent query builder
@@ -63,32 +72,30 @@ 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'
+  rootServerURL: 'https://your-bmlt-server.org/main_server',
 });
 
 // Search for meetings
 const meetings = await client.searchMeetings({
   weekdays: [1, 2, 3], // Sunday, Monday, Tuesday
-  venue_types: VenueType.IN_PERSON
+  venue_types: VenueType.IN_PERSON,
 });
 
 // Use the query builder for complex searches
 const builder = new MeetingQueryBuilder(client);
 const eveningMeetings = await builder
-  .onWeekdays(1, 2, 3, 4, 5)  // Weekdays
-  .startingAfter(17, 0)       // After 5 PM
+  .onWeekdays(1, 2, 3, 4, 5) // Weekdays
+  .startingAfter(17, 0) // After 5 PM
   .inPersonOnly()
   .nearCoordinates({ latitude: 40.7589, longitude: -73.9851 }, 2) // 2 mile radius
   .execute();
 ```
 
-## Bundle Sizes
+## Bundle Size
 
 The client has been optimized for minimal bundle size:
 
-- **ES Module**: ~55KB (15KB gzipped) - All dependencies included
-- **IIFE Bundle**: ~35KB (11KB gzipped) - For legacy browser support
-- **CommonJS/ESM (Node)**: ~31KB (8KB gzipped) - External dependencies
+- **ES Module**: ~55KB (15KB gzipped) - Zero external dependencies, fully self-contained
 
 ## Browser Support
 
@@ -114,14 +121,14 @@ const formats = await client.getFormats();
 const serviceBodies = await client.getServiceBodies();
 
 // Field values
-const fieldValues = await client.getFieldValues({ 
-  meeting_key: 'location_municipality' 
+const fieldValues = await client.getFieldValues({
+  meeting_key: 'location_municipality',
 });
 
 // Changes within date range
 const changes = await client.getChanges({
   start_date: '2023-01-01',
-  end_date: '2023-01-31'
+  end_date: '2023-01-31',
 });
 ```
 
@@ -136,7 +143,7 @@ console.log(result.coordinates); // { latitude: 40.758, longitude: -73.985 }
 const meetings = await client.searchMeetingsByAddress({
   address: 'Central Park, New York',
   radiusMiles: 2,
-  sortByDistance: true
+  sortByDistance: true,
 });
 ```
 
@@ -149,11 +156,11 @@ const builder = new MeetingQueryBuilder(client);
 const meetings = await builder
   .onWeekdays(Weekday.SATURDAY, Weekday.SUNDAY)
   .virtualOnly()
-  .startingAfter(10, 0)  // After 10 AM
-  .endingBefore(20, 0)   // Before 8 PM
+  .startingAfter(10, 0) // After 10 AM
+  .endingBefore(20, 0) // Before 8 PM
   .searchText('meditation')
   .sortByDistance()
-  .paginate(20, 1)       // 20 results, page 1
+  .paginate(20, 1) // 20 results, page 1
   .execute();
 ```
 
@@ -172,7 +179,7 @@ const weekendMeetings = await quickSearch.weekend().execute();
 const todaysVirtualMeetings = await quickSearch
   .today()
   .virtualOnly()
-  .startingAfter(18, 0)  // After 6 PM
+  .startingAfter(18, 0) // After 6 PM
   .execute();
 ```
 
@@ -189,12 +196,12 @@ try {
   if (error instanceof BmltQueryError) {
     console.log('Error type:', error.type);
     console.log('User message:', error.getUserMessage());
-    
+
     if (error.isRetryable()) {
       // Handle retryable errors (network, timeout, rate limit)
       console.log('This error can be retried');
     }
-    
+
     if (error.isType(BmltErrorType.GEOCODING_ERROR)) {
       // Handle geocoding-specific errors
       console.log('Geocoding failed');
@@ -205,8 +212,7 @@ try {
 
 ## Examples
 
-- **[ES Module Demo](./example-esm.html)** - Complete browser example using ES modules
-- **[Legacy Demo](./example.html)** - Browser example using IIFE bundle
+- **[Browser Demo](./docs/index.html)** - Complete browser example using ES modules
 
 ## Development
 
@@ -217,31 +223,59 @@ npm install
 # Run tests
 npm test
 
-# Build all formats
-npm run build:all
+# Build the ES module bundle
+npm run build
+
+# Clean build directory
+npm run clean
 
-# Build individual formats
-npm run build        # Node.js (ESM/CJS)
-npm run build:esm    # Browser ES module
-npm run build:browser # Browser IIFE bundle
+# Code formatting
+npm run format        # Format all files
+npm run format:check  # Check formatting
+
+# Code quality
+npm run lint          # Lint code
+npm run type-check    # TypeScript checking
 ```
 
 ## Configuration
 
+### Runtime Configuration
+
+You can update client settings after initialization:
+
+```javascript
+// Update user agent for all requests
+client.setUserAgent('my-updated-app/2.0.0');
+console.log(client.getUserAgent()); // 'my-updated-app/2.0.0'
+
+// Update request timeout
+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 default data format
+client.setDefaultFormat(BmltDataFormat.JSONP);
+console.log(client.getDefaultFormat());
+```
+
 ### Client Options
 
 ```javascript
 const client = new BmltClient({
   rootServerURL: 'https://your-server.org/main_server', // Required
-  defaultFormat: BmltDataFormat.JSON,                   // Optional
-  timeout: 30000,                                       // 30 seconds
-  userAgent: 'my-app/1.0.0',                           // Custom user agent
-  enableGeocoding: true,                                // Enable address search
+  defaultFormat: BmltDataFormat.JSON, // Optional
+  timeout: 30000, // 30 seconds
+  userAgent: 'my-app/1.0.0', // Custom user agent
+  enableGeocoding: true, // Enable address search
   geocodingOptions: {
-    countryCode: 'us',    // Bias results to US
-    retryCount: 3,        // Retry failed requests
-    timeout: 10000        // Geocoding timeout
-  }
+    countryCode: 'us', // Bias results to US
+    retryCount: 3, // Retry failed requests
+    timeout: 10000, // Geocoding timeout
+  },
 });
 ```
 
@@ -251,15 +285,15 @@ const client = new BmltClient({
 const client = new BmltClient({
   rootServerURL: 'https://your-server.org/main_server',
   geocodingOptions: {
-    countryCode: 'us',                    // ISO country code bias
+    countryCode: 'us', // ISO country code bias
     viewbox: [-74.2, 40.4, -73.7, 40.9], // Geographic bounding box [w,s,e,n]
-    bounded: true,                        // Restrict to viewbox
-    retryCount: 3,                        // Request retry attempts
-    timeout: 10000,                       // Request timeout (ms)
-    intervalCap: 1,                       // Rate limit: requests per interval
-    interval: 1000,                       // Rate limit interval (ms)
-    concurrency: 1                        // Max concurrent requests
-  }
+    bounded: true, // Restrict to viewbox
+    retryCount: 3, // Request retry attempts
+    timeout: 10000, // Request timeout (ms)
+    intervalCap: 1, // Rate limit: requests per interval
+    interval: 1000, // Rate limit interval (ms)
+    concurrency: 1, // Max concurrent requests
+  },
 });
 ```
 

package/dist/app.d.ts

@@ -97,6 +97,22 @@ export declare class BmltClient {
      * Clear the geocoding queue
      */
     clearGeocodingQueue(): void;
+    /**
+     * Get the current user agent string
+     */
+    getUserAgent(): string;
+    /**
+     * Set the user agent string for HTTP requests
+     */
+    setUserAgent(userAgent: string): void;
+    /**
+     * Get the current timeout setting
+     */
+    getTimeout(): number;
+    /**
+     * Set the timeout for HTTP requests
+     */
+    setTimeout(timeout: number): void;
 }
 
 export declare interface BmltClientOptions {
@@ -448,6 +464,14 @@ export declare class GeocodingService {
      * Set concurrency limit
      */
     setConcurrency(concurrency: number): void;
+    /**
+     * Get the current user agent string
+     */
+    getUserAgent(): string;
+    /**
+     * Set the user agent string for geocoding requests
+     */
+    setUserAgent(userAgent: string): void;
 }
 
 export declare interface GeographicSearchParams {