@horribleprogram/sdk 0.1.1 → 0.1.3

package/README.md

@@ -1,97 +1,109 @@
-# @botcierge/sdk
-
-[![npm version](https://img.shields.io/npm/v/@botcierge/sdk.svg)](https://www.npmjs.com/package/@botcierge/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**.
-
-## 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.
-
-## Installation
-
-```bash
-npm install @botcierge/sdk
-```
-
-## Quick Start
-
-```typescript
-import { query_intent } from '@botcierge/sdk';
-
-try {
-  const result = await query_intent("I'd like to share some food");
-  
-  console.log(`Domain: ${result.domain}`);         // foodshare
-  console.log(`Intent: ${result.intent}`);         // share_food
-  console.log(`Confidence: ${result.confidence}`); // high
-} catch (error) {
-  console.error("Classification failed:", error.message);
-}
-```
-
-## API Reference
-
-### `query_intent(utterance: string): Promise<IntentResult>`
-
-A helper function for quick classification using the default configuration (connecting to `http://localhost:8000`).
-
-### `class Botcierge`
-
-The main class for interacting with the Botcierge API.
-
-#### `constructor(config?: BotciergeConfig)`
-
-- `config.baseUrl`: The base URL of your Botcierge API (default: `http://localhost:8000`).
-
-#### `query_intent(utterance: string): Promise<IntentResult>`
-
-Classifies a string into a specific domain and intent.
-
-### Types
-
-#### `IntentResult`
-```typescript
-interface IntentResult {
-  domain: string;                   // The high-level category (e.g., 'moneyshare')
-  intent: string;                   // The specific action (e.g., 'request_loan')
-  confidence: "high" | "medium" | "low";
-  scores: Record<string, number>;   // Raw similarity scores for all intents
-}
-```
-
-## Error Handling
-
-The SDK throws standard `Error` objects if the network request fails or if the API returns a non-2xx status code.
-
-```typescript
-import { Botcierge } from '@botcierge/sdk';
-
-const client = new Botcierge({ baseUrl: 'https://invalid-api.com' });
-
-try {
-  await client.query_intent("hello");
-} catch (e) {
-  console.log(e.message); // "Botcierge API error: ..."
-}
-```
-
-## Development
-
-### Running Tests
-```bash
-npm test
-```
-
-### Building
-```bash
-npm run build
-```
-
-## License
-
-MIT © [horribleprogram](https://npmjs.com/~horribleprogram)
+# @horribleprogram/sdk
+
+[![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**.
+
+## 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.
+
+## Installation
+
+```bash
+npm install @horribleprogram/sdk
+```
+
+## Quick Start
+
+```typescript
+import { query_intent } from '@horribleprogram/sdk';
+
+const result = await query_intent("I'd like to share some food");
+
+console.log(result.domain);     // FOODLINK
+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.
+
+## Try it in Node
+
+Create a file `demo.mjs` and run it with `node demo.mjs`:
+
+```js
+import { Botcierge, query_intent } from '@horribleprogram/sdk'
+
+// 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"))
+
+// Or with an explicit client
+const client = new Botcierge()
+console.log(await client.query_intent("I want to add milk to my list"))
+```
+
+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" }
+```
+
+## API Reference
+
+### `query_intent(utterance: string): Promise<IntentResult>`
+
+Classifies a string using the default client (hosted API).
+
+### `class Botcierge`
+
+#### `constructor(config?: BotciergeConfig)`
+
+- `config.baseUrl`: Override the API base URL (default: `https://horribleprogram-intentapi.hf.space`).
+
+#### `query_intent(utterance: string): Promise<IntentResult>`
+
+Classifies a string into a specific domain and intent.
+
+### Types
+
+#### `IntentResult`
+```typescript
+interface IntentResult {
+  domain: string;
+  intent: string;
+  confidence: "high" | "medium" | "low";
+  scores?: Record<string, number>;
+}
+```
+
+## 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
+
+```bash
+npm test
+npm run build
+```
+
+## License
+
+MIT © [horribleprogram](https://npmjs.com/~horribleprogram)

package/dist/{chunk-AOE6JLKC.js → chunk-EWLGKE65.js}

@@ -2,7 +2,7 @@
 var Botcierge = class {
   baseUrl;
   constructor(config = {}) {
-    this.baseUrl = config.baseUrl || "http://localhost:8000";
+    this.baseUrl = config.baseUrl || "https://horribleprogram-intentapi.hf.space";
   }
   async query_intent(utterance) {
     const response = await fetch(`${this.baseUrl}/classify`, {

package/dist/index.cjs

@@ -27,7 +27,7 @@ module.exports = __toCommonJS(index_exports);
 var Botcierge = class {
   baseUrl;
   constructor(config = {}) {
-    this.baseUrl = config.baseUrl || "http://localhost:8000";
+    this.baseUrl = config.baseUrl || "https://horribleprogram-intentapi.hf.space";
   }
   async query_intent(utterance) {
     const response = await fetch(`${this.baseUrl}/classify`, {

package/dist/index.js

@@ -1,7 +1,7 @@
 import {
   Botcierge,
   query_intent
-} from "./chunk-AOE6JLKC.js";
+} from "./chunk-EWLGKE65.js";
 export {
   Botcierge,
   query_intent

package/dist/main.cjs

@@ -29,7 +29,7 @@ var readline = __toESM(require("readline"), 1);
 var Botcierge = class {
   baseUrl;
   constructor(config = {}) {
-    this.baseUrl = config.baseUrl || "http://localhost:8000";
+    this.baseUrl = config.baseUrl || "https://horribleprogram-intentapi.hf.space";
   }
   async query_intent(utterance) {
     const response = await fetch(`${this.baseUrl}/classify`, {

package/dist/main.js

@@ -1,6 +1,6 @@
 import {
   query_intent
-} from "./chunk-AOE6JLKC.js";
+} from "./chunk-EWLGKE65.js";
 
 // src/main.ts
 import * as readline from "readline";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@horribleprogram/sdk",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "SDK for Botcierge Intent Classification",
   "type": "module",
   "main": "./dist/index.js",