@horribleprogram/sdk 0.1.1

package/README.md

@@ -0,0 +1,97 @@
+# @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)

package/dist/chunk-AOE6JLKC.js

@@ -0,0 +1,30 @@
+// src/index.ts
+var Botcierge = class {
+  baseUrl;
+  constructor(config = {}) {
+    this.baseUrl = config.baseUrl || "http://localhost:8000";
+  }
+  async query_intent(utterance) {
+    const response = await fetch(`${this.baseUrl}/classify`, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json"
+      },
+      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();
+  }
+};
+var defaultClient = new Botcierge();
+async function query_intent(utterance) {
+  return defaultClient.query_intent(utterance);
+}
+
+export {
+  Botcierge,
+  query_intent
+};

package/dist/index.cjs

@@ -0,0 +1,55 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  Botcierge: () => Botcierge,
+  query_intent: () => query_intent
+});
+module.exports = __toCommonJS(index_exports);
+var Botcierge = class {
+  baseUrl;
+  constructor(config = {}) {
+    this.baseUrl = config.baseUrl || "http://localhost:8000";
+  }
+  async query_intent(utterance) {
+    const response = await fetch(`${this.baseUrl}/classify`, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json"
+      },
+      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();
+  }
+};
+var defaultClient = new Botcierge();
+async function query_intent(utterance) {
+  return defaultClient.query_intent(utterance);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Botcierge,
+  query_intent
+});

package/dist/index.d.cts

@@ -0,0 +1,21 @@
+interface IntentResult {
+    domain: string;
+    intent: string;
+    confidence: "high" | "medium" | "low";
+    scores?: Record<string, number>;
+}
+interface BotciergeConfig {
+    baseUrl?: string;
+}
+declare class Botcierge {
+    private baseUrl;
+    constructor(config?: BotciergeConfig);
+    query_intent(utterance: string): Promise<IntentResult>;
+}
+/**
+ * Classifies an utterance into an intent.
+ * By default, connects to http://localhost:8000
+ */
+declare function query_intent(utterance: string): Promise<IntentResult>;
+
+export { Botcierge, type BotciergeConfig, type IntentResult, query_intent };

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+interface IntentResult {
+    domain: string;
+    intent: string;
+    confidence: "high" | "medium" | "low";
+    scores?: Record<string, number>;
+}
+interface BotciergeConfig {
+    baseUrl?: string;
+}
+declare class Botcierge {
+    private baseUrl;
+    constructor(config?: BotciergeConfig);
+    query_intent(utterance: string): Promise<IntentResult>;
+}
+/**
+ * Classifies an utterance into an intent.
+ * By default, connects to http://localhost:8000
+ */
+declare function query_intent(utterance: string): Promise<IntentResult>;
+
+export { Botcierge, type BotciergeConfig, type IntentResult, query_intent };

package/dist/index.js

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

package/dist/main.cjs

@@ -0,0 +1,84 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+
+// src/main.ts
+var readline = __toESM(require("readline"), 1);
+
+// src/index.ts
+var Botcierge = class {
+  baseUrl;
+  constructor(config = {}) {
+    this.baseUrl = config.baseUrl || "http://localhost:8000";
+  }
+  async query_intent(utterance) {
+    const response = await fetch(`${this.baseUrl}/classify`, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json"
+      },
+      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();
+  }
+};
+var defaultClient = new Botcierge();
+async function query_intent(utterance) {
+  return defaultClient.query_intent(utterance);
+}
+
+// src/main.ts
+var queries = [
+  "I'm hungry",
+  "I need some blood",
+  "I want to add milk to my shopping list"
+];
+async function runBatch() {
+  for (const query of queries) {
+    const result = await query_intent(query);
+    console.log(result.intent);
+  }
+}
+async function runInteractive() {
+  const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+  const prompt = () => rl.question("> ", async (user_query) => {
+    if (!user_query) {
+      rl.close();
+      return;
+    }
+    const result = await query_intent(user_query);
+    console.log(result.intent);
+    prompt();
+  });
+  prompt();
+}
+var mode = process.argv[2];
+if (mode === "interactive") {
+  runInteractive();
+} else {
+  runBatch();
+}

package/dist/main.d.cts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/main.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/main.js

@@ -0,0 +1,36 @@
+import {
+  query_intent
+} from "./chunk-AOE6JLKC.js";
+
+// src/main.ts
+import * as readline from "readline";
+var queries = [
+  "I'm hungry",
+  "I need some blood",
+  "I want to add milk to my shopping list"
+];
+async function runBatch() {
+  for (const query of queries) {
+    const result = await query_intent(query);
+    console.log(result.intent);
+  }
+}
+async function runInteractive() {
+  const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+  const prompt = () => rl.question("> ", async (user_query) => {
+    if (!user_query) {
+      rl.close();
+      return;
+    }
+    const result = await query_intent(user_query);
+    console.log(result.intent);
+    prompt();
+  });
+  prompt();
+}
+var mode = process.argv[2];
+if (mode === "interactive") {
+  runInteractive();
+} else {
+  runBatch();
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@horribleprogram/sdk",
+  "version": "0.1.1",
+  "description": "SDK for Botcierge Intent Classification",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts src/main.ts --format cjs,esm --dts --clean",
+    "dev": "tsup src/index.ts --format cjs,esm --watch --dts",
+    "test": "vitest run",
+    "lint": "tsc"
+  },
+  "keywords": [
+    "botcierge",
+    "intent",
+    "classifier",
+    "sdk"
+  ],
+  "author": "horribleprogram",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^25.8.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^4.1.6"
+  },
+  "dependencies": {}
+}