irdata_js 0.2.0 → 0.3.0

package/README.md

@@ -8,6 +8,19 @@ JavaScript library to interact with the iRacing /data API.
 npm install irdata_js
 ```
 
+## CDN Usage
+
+For direct usage in the browser without a build step, you can load the library via a CDN. The library is exposed as the global `irdata` variable.
+
+```html
+<script src="https://unpkg.com/irdata_js/dist/index.global.js"></script>
+<script>
+  const client = new irdata.IRacingClient({
+    // ...
+  });
+</script>
+```
+
 ## Quick Start
 
 The library supports OAuth 2.0 authentication.
@@ -62,8 +75,11 @@ try {
   const { data, metadata } = await client.getData('/member/info');
   
   console.log(data); // The actual API response
+  console.log(metadata.contentType); // Response content type (e.g. 'application/json')
   console.log(metadata.sizeBytes); // Response size in bytes
-  console.log(metadata.chunksDetected); // Boolean indicating if data is chunked
+  console.log(metadata.fetchTimeMs); // Fetch duration in milliseconds
+  console.log(metadata.chunkCount); // Number of chunks (0 if not chunked)
+  console.log(metadata.chunkRows); // Total rows across all chunks (valid if chunkCount > 0)
 } catch (error) {
   console.error('Failed to fetch member info:', error);
 }
@@ -71,14 +87,14 @@ try {
 
 ### 4. Handling Large Datasets (Chunks)
 
-Some iRacing endpoints (like large result sets) return data in multiple "chunks" hosted on S3. When `metadata.chunksDetected` is true, you can use the library to fetch the rest of the data.
+Some iRacing endpoints (like large result sets) return data in multiple "chunks" hosted on S3. When `metadata.chunkCount` is greater than 0, you can use the library to fetch the rest of the data.
 
 #### Fetch all chunks at once
 
 ```javascript
 const result = await client.getData('/results/get');
 
-if (result.metadata.chunksDetected) {
+if (result.metadata.chunkCount > 0) {
   // Fetch and merge all chunks into a single array
   const { data: allResults } = await client.getChunks(result.data);
   console.log('Total results:', allResults.length);
@@ -90,8 +106,8 @@ if (result.metadata.chunksDetected) {
 For extremely large datasets, you might want to fetch chunks one by one:
 
 ```javascript
-if (result.metadata.chunksDetected) {
-  const totalChunks = result.data.chunk_info.chunk_file_names.length;
+if (result.metadata.chunkCount > 0) {
+  const totalChunks = result.metadata.chunkCount;
   
   for (let i = 0; i < totalChunks; i++) {
     const { data: chunk } = await client.getChunk(result.data, i);
@@ -100,6 +116,8 @@ if (result.metadata.chunksDetected) {
 }
 ```
 
+> **Note:** iRacing's API incorrectly returns `application/octet-stream` as the `Content-Type` for JSON chunks. This library automatically detects and parses these as JSON.
+
 ## Development
 
 ### Build
@@ -110,19 +128,27 @@ npm run build
 
 ### Manual Verification (OAuth Flow)
 
-This repository includes a local development proxy server to test the OAuth flow and API interaction, avoiding CORS issues during development.
+This repository includes a local development proxy server and a demo application to test the OAuth flow and API interaction, avoiding CORS issues during development.
 
-1.  Create a file named `auth_config.json` in the `examples/` directory (ignored by git) with your credentials:
+1.  Create a file named `config.json` in the `demo/` directory (ignored by git) with your configuration:
 
     ```json
     {
-      "clientId": "YOUR_CLIENT_ID",
-      "redirectUri": "http://127.0.0.1/irdata_js/callback",
-      "tokenEndpoint": "http://127.0.0.1/token"
+      "port": 80,
+      "basePath": "/irdata_js",
+      "redirectPath": "/irdata_js/callback",
+      "auth": {
+        "clientId": "YOUR_CLIENT_ID",
+        "redirectUri": "http://127.0.0.1/irdata_js/callback",
+        "tokenEndpoint": "http://127.0.0.1/irdata_js/token"
+      }
     }
     ```
 
-    _Note: The `redirectUri` should match what you registered with iRacing. The proxy server is configured to intercept the path specified in `redirectUri` (e.g. `/irdata_js/callback`) and redirect it to the example app while preserving the auth code._
+    *   `port`: The port the proxy server will listen on.
+    *   `basePath`: The path prefix where the static files and proxy endpoints are served from.
+    *   `redirectPath`: The path the proxy server intercepts for OAuth callbacks.
+    *   `auth`: Your iRacing API credentials. Note that `tokenEndpoint` should include the `basePath`.
 
 2.  Start the proxy server:
 
@@ -130,10 +156,12 @@ This repository includes a local development proxy server to test the OAuth flow
     npm run dev
     ```
 
-    _This starts the proxy server on port 80. Depending on your system configuration, you might need elevated privileges (e.g., `sudo`) to listen on port 80._
+    *This command automatically generates the `demo/index.html` from the template using your configuration and starts the proxy server.*
+    *Depending on your system configuration, you might need elevated privileges (e.g., `sudo`) to listen on port 80.*
+
+3.  Open `http://127.0.0.1/irdata_js/` (or your configured `basePath`) in your browser.
+    *   The demo app is configured to use the local proxy endpoints (e.g., `/irdata_js/token`, `/irdata_js/data`, `/irdata_js/passthrough`) to bypass CORS restrictions.
 
-3.  Open `http://127.0.0.1/examples/index.html` in your browser.
-    - The `index.html` is configured to use the local proxy endpoints (`/token`, `/data`, `/passthrough`) to bypass CORS restrictions enforced by the browser.
 
 ## License