@horribleprogram/sdk 0.1.4 → 0.1.6

package/README.md

@@ -3,14 +3,18 @@
 [![npm version](https://img.shields.io/npm/v/@horribleprogram/sdk.svg)](https://www.npmjs.com/package/@horribleprogram/sdk)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Official JavaScript/TypeScript SDK for the **Botcierge Intent Classification API**.
+Official JavaScript/TypeScript SDK for **Botcierge Intent Classification**. 
+
+Starting with `v0.1.5`, the SDK runs **completely locally** on your machine. It loads the `sentence-transformers/all-MiniLM-L12-v2` model using ONNX runtime and performs classification via cosine similarity against a built-in static intents taxonomy.
+
+No API keys, configuration, or active internet connection (after first run) are required.
 
 ## Features
 
-- **TypeScript Native**: Full type definitions for all API responses.
-- **Lightweight**: Zero dependencies (uses native `fetch`).
-- **Flexible**: Easy to use for both simple scripts and complex applications.
-- **Cross-platform**: Works in Node.js, Browsers, and Edge environments.
+- **Purely Local**: High-speed offline intent classification with zero external API calls or latency.
+- **ONNX-Powered**: Powered by `@xenova/transformers` for running `all-MiniLM-L12-v2` locally.
+- **TypeScript Native**: Full type safety for class instances, options, and classification outputs.
+- **Automatic Caching**: Model weights (approx. 120MB) are downloaded automatically on the first run and cached locally.
 
 ## Installation
 
@@ -23,6 +27,7 @@ npm install @horribleprogram/sdk
 ```typescript
 import { query_intent } from '@horribleprogram/sdk';
 
+// On the first run, the local model will download and cache.
 const result = await query_intent("I'd like to share some food");
 
 console.log(result.domain);     // FOODLINK
@@ -30,46 +35,43 @@ console.log(result.intent);     // share_food
 console.log(result.confidence); // high
 ```
 
-No configuration needed — the SDK points to the hosted API at `https://horribleprogram-intentapi.hf.space` by default.
+## Usage
 
-## Try it in Node
+### Simple Usage
+The simplest way to use the SDK is through the default helper function:
 
-Create a file `demo.mjs` and run it with `node demo.mjs`:
+```javascript
+import { query_intent } from '@horribleprogram/sdk';
 
-```js
-import { Botcierge, query_intent } from '@horribleprogram/sdk'
+const result = await query_intent("I'm hungry");
+console.log(result);
+// { domain: 'FOODLINK', intent: 'request_food', confidence: 'high', scores: { request_food: 0.975 } }
+```
 
-// Zero-config — hits the hosted API by default
-console.log(await query_intent("I'm hungry"))
-console.log(await query_intent("I need help with a bill"))
+### Dedicated Instance
+For class-based architectures, instantiate the `Botcierge` class:
 
-// Or with an explicit client
-const client = new Botcierge()
-console.log(await client.query_intent("I want to add milk to my list"))
-```
+```javascript
+import { Botcierge } from '@horribleprogram/sdk';
 
-Example output:
-```json
-{ "domain": "FOODLINK",   "intent": "request_food",      "confidence": "high" }
-{ "domain": "BILLBRIDGE", "intent": "request_bill_help",  "confidence": "high" }
-{ "domain": "SHOP_SAVVY", "intent": "add_item",           "confidence": "high" }
+const client = new Botcierge();
+const result = await client.query_intent("I want to add milk to my list");
+console.log(result);
+// { domain: 'SHOP_SAVVY', intent: 'add_item', confidence: 'high', scores: { add_item: 0.884 } }
 ```
 
 ## API Reference
 
 ### `query_intent(utterance: string): Promise<IntentResult>`
-
-Classifies a string using the default client (hosted API).
+Classifies a string using the default local instance.
 
 ### `class Botcierge`
-
 #### `constructor(config?: BotciergeConfig)`
-
-- `config.baseUrl`: Override the API base URL (default: `https://horribleprogram-intentapi.hf.space`).
+Creates a new intent classification instance.
+- `config`: Currently empty (reserved for future options).
 
 #### `query_intent(utterance: string): Promise<IntentResult>`
-
-Classifies a string into a specific domain and intent.
+Classifies a string locally into a specific domain and intent.
 
 ### Types
 
@@ -83,27 +85,23 @@ interface IntentResult {
 }
 ```
 
-## Error Handling
-
-```typescript
-import { Botcierge } from '@horribleprogram/sdk';
-
-const client = new Botcierge({ baseUrl: 'https://my-own-instance.com' });
-
-try {
-  await client.query_intent("hello");
-} catch (e) {
-  console.log(e.message); // "Botcierge API error: ..."
-}
-```
-
 ## Development
 
+To build and test the SDK locally:
+
 ```bash
+# Clone the repository and install dependencies
+cd sdk-js
+npm install
+
+# Run unit tests
 npm test
+
+# Build files (CJS + ESM + DTS)
 npm run build
 ```
 
 ## License
 
 MIT © [horribleprogram](https://npmjs.com/~horribleprogram)
+

package/dist/{chunk-4DZAWXQM.js → chunk-45PYBUYK.js}

@@ -199,74 +199,44 @@ function cosineSimilarity(v1, v2) {
   return dotProduct / (Math.sqrt(norm1) * Math.sqrt(norm2));
 }
 var Botcierge = class {
-  baseUrl;
-  apiKey;
   constructor(config = {}) {
-    this.baseUrl = config.baseUrl || "https://horribleprogram-intentapi.hf.space";
-    this.apiKey = config.apiKey;
-  }
-  getApiKey() {
-    if (this.apiKey) return this.apiKey;
-    if (typeof process !== "undefined" && process.env) {
-      return process.env.BOTCIERGE_API_KEY || process.env.OPENAI_API_KEY;
-    }
-    return void 0;
   }
   async query_intent(utterance) {
-    const apiKey = this.getApiKey();
-    if (apiKey) {
-      const headers = {
-        "Content-Type": "application/json",
-        "Authorization": `Bearer ${apiKey}`,
-        "X-API-Key": apiKey
-      };
-      const response = await fetch(`${this.baseUrl}/classify`, {
-        method: "POST",
-        headers,
-        body: JSON.stringify({ utterance })
-      });
-      if (!response.ok) {
-        const error = await response.json().catch(() => ({ detail: "Unknown error" }));
-        throw new Error(`Botcierge API error: ${error.detail || response.statusText}`);
-      }
-      return await response.json();
-    } else {
-      const extractor = await getExtractor();
-      const output = await extractor(utterance, { pooling: "mean", normalize: true });
-      const queryVector = Array.from(output.data);
-      const taxEmbeddings = await getTaxonomyEmbeddings();
-      let bestSim = -1;
-      let bestItem = null;
-      for (const item of taxEmbeddings) {
-        const sim = cosineSimilarity(queryVector, item.vector);
-        if (sim > bestSim) {
-          bestSim = sim;
-          bestItem = item;
-        }
-      }
-      if (!bestItem || bestSim < 0.35) {
-        return {
-          domain: "unknown",
-          intent: "unknown",
-          confidence: "low",
-          scores: {}
-        };
-      }
-      let confidence = "low";
-      if (bestSim >= 0.7) {
-        confidence = "high";
-      } else if (bestSim >= 0.5) {
-        confidence = "medium";
+    const extractor = await getExtractor();
+    const output = await extractor(utterance, { pooling: "mean", normalize: true });
+    const queryVector = Array.from(output.data);
+    const taxEmbeddings = await getTaxonomyEmbeddings();
+    let bestSim = -1;
+    let bestItem = null;
+    for (const item of taxEmbeddings) {
+      const sim = cosineSimilarity(queryVector, item.vector);
+      if (sim > bestSim) {
+        bestSim = sim;
+        bestItem = item;
       }
+    }
+    if (!bestItem || bestSim < 0.35) {
       return {
-        domain: bestItem.domain,
-        intent: bestItem.intent,
-        confidence,
-        scores: {
-          [bestItem.intent]: bestSim
-        }
+        domain: "unknown",
+        intent: "unknown",
+        confidence: "low",
+        scores: {}
       };
     }
+    let confidence = "low";
+    if (bestSim >= 0.7) {
+      confidence = "high";
+    } else if (bestSim >= 0.5) {
+      confidence = "medium";
+    }
+    return {
+      domain: bestItem.domain,
+      intent: bestItem.intent,
+      confidence,
+      scores: {
+        [bestItem.intent]: bestSim
+      }
+    };
   }
 };
 var defaultClient = new Botcierge();

package/dist/index.cjs

@@ -224,74 +224,44 @@ function cosineSimilarity(v1, v2) {
   return dotProduct / (Math.sqrt(norm1) * Math.sqrt(norm2));
 }
 var Botcierge = class {
-  baseUrl;
-  apiKey;
   constructor(config = {}) {
-    this.baseUrl = config.baseUrl || "https://horribleprogram-intentapi.hf.space";
-    this.apiKey = config.apiKey;
-  }
-  getApiKey() {
-    if (this.apiKey) return this.apiKey;
-    if (typeof process !== "undefined" && process.env) {
-      return process.env.BOTCIERGE_API_KEY || process.env.OPENAI_API_KEY;
-    }
-    return void 0;
   }
   async query_intent(utterance) {
-    const apiKey = this.getApiKey();
-    if (apiKey) {
-      const headers = {
-        "Content-Type": "application/json",
-        "Authorization": `Bearer ${apiKey}`,
-        "X-API-Key": apiKey
-      };
-      const response = await fetch(`${this.baseUrl}/classify`, {
-        method: "POST",
-        headers,
-        body: JSON.stringify({ utterance })
-      });
-      if (!response.ok) {
-        const error = await response.json().catch(() => ({ detail: "Unknown error" }));
-        throw new Error(`Botcierge API error: ${error.detail || response.statusText}`);
-      }
-      return await response.json();
-    } else {
-      const extractor = await getExtractor();
-      const output = await extractor(utterance, { pooling: "mean", normalize: true });
-      const queryVector = Array.from(output.data);
-      const taxEmbeddings = await getTaxonomyEmbeddings();
-      let bestSim = -1;
-      let bestItem = null;
-      for (const item of taxEmbeddings) {
-        const sim = cosineSimilarity(queryVector, item.vector);
-        if (sim > bestSim) {
-          bestSim = sim;
-          bestItem = item;
-        }
-      }
-      if (!bestItem || bestSim < 0.35) {
-        return {
-          domain: "unknown",
-          intent: "unknown",
-          confidence: "low",
-          scores: {}
-        };
-      }
-      let confidence = "low";
-      if (bestSim >= 0.7) {
-        confidence = "high";
-      } else if (bestSim >= 0.5) {
-        confidence = "medium";
+    const extractor = await getExtractor();
+    const output = await extractor(utterance, { pooling: "mean", normalize: true });
+    const queryVector = Array.from(output.data);
+    const taxEmbeddings = await getTaxonomyEmbeddings();
+    let bestSim = -1;
+    let bestItem = null;
+    for (const item of taxEmbeddings) {
+      const sim = cosineSimilarity(queryVector, item.vector);
+      if (sim > bestSim) {
+        bestSim = sim;
+        bestItem = item;
       }
+    }
+    if (!bestItem || bestSim < 0.35) {
       return {
-        domain: bestItem.domain,
-        intent: bestItem.intent,
-        confidence,
-        scores: {
-          [bestItem.intent]: bestSim
-        }
+        domain: "unknown",
+        intent: "unknown",
+        confidence: "low",
+        scores: {}
       };
     }
+    let confidence = "low";
+    if (bestSim >= 0.7) {
+      confidence = "high";
+    } else if (bestSim >= 0.5) {
+      confidence = "medium";
+    }
+    return {
+      domain: bestItem.domain,
+      intent: bestItem.intent,
+      confidence,
+      scores: {
+        [bestItem.intent]: bestSim
+      }
+    };
   }
 };
 var defaultClient = new Botcierge();

package/dist/index.d.cts

@@ -5,14 +5,9 @@ interface IntentResult {
     scores?: Record<string, number>;
 }
 interface BotciergeConfig {
-    baseUrl?: string;
-    apiKey?: string;
 }
 declare class Botcierge {
-    private baseUrl;
-    private apiKey?;
     constructor(config?: BotciergeConfig);
-    private getApiKey;
     query_intent(utterance: string): Promise<IntentResult>;
 }
 /**

package/dist/index.d.ts

@@ -5,14 +5,9 @@ interface IntentResult {
     scores?: Record<string, number>;
 }
 interface BotciergeConfig {
-    baseUrl?: string;
-    apiKey?: string;
 }
 declare class Botcierge {
-    private baseUrl;
-    private apiKey?;
     constructor(config?: BotciergeConfig);
-    private getApiKey;
     query_intent(utterance: string): Promise<IntentResult>;
 }
 /**

package/dist/index.js

@@ -1,7 +1,7 @@
 import {
   Botcierge,
   query_intent
-} from "./chunk-4DZAWXQM.js";
+} from "./chunk-45PYBUYK.js";
 export {
   Botcierge,
   query_intent

package/dist/main.cjs

@@ -226,74 +226,44 @@ function cosineSimilarity(v1, v2) {
   return dotProduct / (Math.sqrt(norm1) * Math.sqrt(norm2));
 }
 var Botcierge = class {
-  baseUrl;
-  apiKey;
   constructor(config = {}) {
-    this.baseUrl = config.baseUrl || "https://horribleprogram-intentapi.hf.space";
-    this.apiKey = config.apiKey;
-  }
-  getApiKey() {
-    if (this.apiKey) return this.apiKey;
-    if (typeof process !== "undefined" && process.env) {
-      return process.env.BOTCIERGE_API_KEY || process.env.OPENAI_API_KEY;
-    }
-    return void 0;
   }
   async query_intent(utterance) {
-    const apiKey = this.getApiKey();
-    if (apiKey) {
-      const headers = {
-        "Content-Type": "application/json",
-        "Authorization": `Bearer ${apiKey}`,
-        "X-API-Key": apiKey
-      };
-      const response = await fetch(`${this.baseUrl}/classify`, {
-        method: "POST",
-        headers,
-        body: JSON.stringify({ utterance })
-      });
-      if (!response.ok) {
-        const error = await response.json().catch(() => ({ detail: "Unknown error" }));
-        throw new Error(`Botcierge API error: ${error.detail || response.statusText}`);
-      }
-      return await response.json();
-    } else {
-      const extractor = await getExtractor();
-      const output = await extractor(utterance, { pooling: "mean", normalize: true });
-      const queryVector = Array.from(output.data);
-      const taxEmbeddings = await getTaxonomyEmbeddings();
-      let bestSim = -1;
-      let bestItem = null;
-      for (const item of taxEmbeddings) {
-        const sim = cosineSimilarity(queryVector, item.vector);
-        if (sim > bestSim) {
-          bestSim = sim;
-          bestItem = item;
-        }
-      }
-      if (!bestItem || bestSim < 0.35) {
-        return {
-          domain: "unknown",
-          intent: "unknown",
-          confidence: "low",
-          scores: {}
-        };
-      }
-      let confidence = "low";
-      if (bestSim >= 0.7) {
-        confidence = "high";
-      } else if (bestSim >= 0.5) {
-        confidence = "medium";
+    const extractor = await getExtractor();
+    const output = await extractor(utterance, { pooling: "mean", normalize: true });
+    const queryVector = Array.from(output.data);
+    const taxEmbeddings = await getTaxonomyEmbeddings();
+    let bestSim = -1;
+    let bestItem = null;
+    for (const item of taxEmbeddings) {
+      const sim = cosineSimilarity(queryVector, item.vector);
+      if (sim > bestSim) {
+        bestSim = sim;
+        bestItem = item;
       }
+    }
+    if (!bestItem || bestSim < 0.35) {
       return {
-        domain: bestItem.domain,
-        intent: bestItem.intent,
-        confidence,
-        scores: {
-          [bestItem.intent]: bestSim
-        }
+        domain: "unknown",
+        intent: "unknown",
+        confidence: "low",
+        scores: {}
       };
     }
+    let confidence = "low";
+    if (bestSim >= 0.7) {
+      confidence = "high";
+    } else if (bestSim >= 0.5) {
+      confidence = "medium";
+    }
+    return {
+      domain: bestItem.domain,
+      intent: bestItem.intent,
+      confidence,
+      scores: {
+        [bestItem.intent]: bestSim
+      }
+    };
   }
 };
 var defaultClient = new Botcierge();

package/dist/main.js

@@ -1,6 +1,6 @@
 import {
   query_intent
-} from "./chunk-4DZAWXQM.js";
+} from "./chunk-45PYBUYK.js";
 
 // src/main.ts
 import * as readline from "readline";

package/package.json

@@ -1,11 +1,22 @@
 {
   "name": "@horribleprogram/sdk",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "SDK for Botcierge Intent Classification",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./dist": {
+      "import": "./dist/index.js"
+    },
+    "./dist/*": "./dist/*"
+  },
   "files": [
     "dist"
   ],