@neuralbase/client 1.0.0

package/README.md

@@ -0,0 +1,63 @@
+# @neuralbase/client
+
+Official client SDK for NeuralBase AI services.
+
+## Installation
+
+```bash
+npm install @neuralbase/client
+```
+
+## Quick Start
+
+```typescript
+import { NeuralBase } from '@neuralbase/client';
+
+const client = new NeuralBase({
+  baseURL: 'https://api.your-domain.com'
+});
+
+// Chat
+const response = await client.chat.neural.ask({ question: 'Hello!' });
+console.log(response.answer); // "Hello there!"
+```
+
+## API Reference
+
+### `new NeuralBase(config)`
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `baseURL` | `string` | _Required_ | API endpoint |
+| `timeout` | `number` | `30000` | Request timeout (ms) |
+| `contextId` | `string` | `undefined` | Default RAG context ID |
+
+### Methods
+
+#### `client.chat.neural.ask(request)`
+
+```typescript
+interface ChatRequest {
+  question: string;
+  contextId?: string;
+}
+
+interface ChatResponse {
+  answer: string;      // HTML formatted
+  answerClean: string; // Plain text
+  sources: Source[];   // RAG citations
+}
+```
+
+#### Voice
+
+- `client.voice.stt.transcribe(audio: Blob | Buffer)`: Returns `{ text: string }`
+- `client.voice.tts.generate(text: string, options: TTSOptions)`: Returns `ArrayBuffer` (WAV)
+
+## Examples
+
+See [examples/nextjs-sdk-test](../examples/nextjs-sdk-test) for a complete Next.js implementation including voice features.
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,105 @@
+interface NeuralBaseConfig {
+    baseURL?: string;
+    contextId?: string;
+    timeout?: number;
+}
+interface NeuralChatOptions {
+    question: string;
+    contextId?: string;
+}
+interface ChatResponse {
+    success?: boolean;
+    answer?: string;
+    answerClean?: string;
+    sources?: {
+        filename: string;
+        score: number;
+    }[];
+}
+interface TTSOptions {
+    voice?: string;
+    language?: string;
+}
+
+declare class ChatModule {
+    private client;
+    constructor(client: NeuralBase);
+    /**
+     * Neural Chat (RAG)
+     * Answers questions based on a specific knowledge context.
+     */
+    get neural(): {
+        ask: (options: NeuralChatOptions | string, contextIdOverride?: string) => Promise<ChatResponse>;
+    };
+}
+
+declare class VoiceModule {
+    private client;
+    constructor(client: NeuralBase);
+    /**
+     * Speech-to-Text
+     */
+    get stt(): {
+        /**
+         * Transcribe raw PCM audio data/Blob
+         */
+        transcribe: (audioData: Buffer | Blob | ArrayBuffer) => Promise<{
+            text: string;
+        }>;
+    };
+    /**
+     * Text-to-Speech
+     */
+    get tts(): {
+        /**
+         * Generate speech audio from text
+         * Returns an ArrayBuffer of the WAV file
+         */
+        generate: (text: string, options?: TTSOptions) => Promise<ArrayBuffer>;
+    };
+}
+
+declare class NeuralBase {
+    readonly baseURL: string;
+    readonly timeout: number;
+    readonly contextId?: string;
+    readonly chat: ChatModule;
+    readonly voice: VoiceModule;
+    constructor(config?: NeuralBaseConfig);
+    /**
+     * Helper for GET requests
+     */
+    get<T>(path: string, options?: any): Promise<T>;
+    /**
+     * Helper for POST requests
+     */
+    post<T>(path: string, body: any, options?: any): Promise<T>;
+    private getHeaders;
+}
+
+declare class VoiceRecorder {
+    private mediaRecorder;
+    private audioChunks;
+    private stream;
+    constructor();
+    start(): Promise<void>;
+    stop(): Promise<Blob>;
+    cleanup(): void;
+    isRecording(): boolean;
+}
+
+declare class NeuralBaseError extends Error {
+    status?: number | undefined;
+    data?: any | undefined;
+    constructor(message: string, status?: number | undefined, data?: any | undefined);
+}
+interface RequestOptions {
+    method?: string;
+    headers?: Record<string, string>;
+    body?: any;
+    timeout?: number;
+    signal?: AbortSignal;
+}
+declare function request<T>(url: string, options?: RequestOptions): Promise<T>;
+
+export { ChatModule, type ChatResponse, NeuralBase, type NeuralBaseConfig, NeuralBaseError, type NeuralChatOptions, type RequestOptions, type TTSOptions, VoiceModule, VoiceRecorder, request };

package/dist/index.d.ts

@@ -0,0 +1,105 @@
+interface NeuralBaseConfig {
+    baseURL?: string;
+    contextId?: string;
+    timeout?: number;
+}
+interface NeuralChatOptions {
+    question: string;
+    contextId?: string;
+}
+interface ChatResponse {
+    success?: boolean;
+    answer?: string;
+    answerClean?: string;
+    sources?: {
+        filename: string;
+        score: number;
+    }[];
+}
+interface TTSOptions {
+    voice?: string;
+    language?: string;
+}
+
+declare class ChatModule {
+    private client;
+    constructor(client: NeuralBase);
+    /**
+     * Neural Chat (RAG)
+     * Answers questions based on a specific knowledge context.
+     */
+    get neural(): {
+        ask: (options: NeuralChatOptions | string, contextIdOverride?: string) => Promise<ChatResponse>;
+    };
+}
+
+declare class VoiceModule {
+    private client;
+    constructor(client: NeuralBase);
+    /**
+     * Speech-to-Text
+     */
+    get stt(): {
+        /**
+         * Transcribe raw PCM audio data/Blob
+         */
+        transcribe: (audioData: Buffer | Blob | ArrayBuffer) => Promise<{
+            text: string;
+        }>;
+    };
+    /**
+     * Text-to-Speech
+     */
+    get tts(): {
+        /**
+         * Generate speech audio from text
+         * Returns an ArrayBuffer of the WAV file
+         */
+        generate: (text: string, options?: TTSOptions) => Promise<ArrayBuffer>;
+    };
+}
+
+declare class NeuralBase {
+    readonly baseURL: string;
+    readonly timeout: number;
+    readonly contextId?: string;
+    readonly chat: ChatModule;
+    readonly voice: VoiceModule;
+    constructor(config?: NeuralBaseConfig);
+    /**
+     * Helper for GET requests
+     */
+    get<T>(path: string, options?: any): Promise<T>;
+    /**
+     * Helper for POST requests
+     */
+    post<T>(path: string, body: any, options?: any): Promise<T>;
+    private getHeaders;
+}
+
+declare class VoiceRecorder {
+    private mediaRecorder;
+    private audioChunks;
+    private stream;
+    constructor();
+    start(): Promise<void>;
+    stop(): Promise<Blob>;
+    cleanup(): void;
+    isRecording(): boolean;
+}
+
+declare class NeuralBaseError extends Error {
+    status?: number | undefined;
+    data?: any | undefined;
+    constructor(message: string, status?: number | undefined, data?: any | undefined);
+}
+interface RequestOptions {
+    method?: string;
+    headers?: Record<string, string>;
+    body?: any;
+    timeout?: number;
+    signal?: AbortSignal;
+}
+declare function request<T>(url: string, options?: RequestOptions): Promise<T>;
+
+export { ChatModule, type ChatResponse, NeuralBase, type NeuralBaseConfig, NeuralBaseError, type NeuralChatOptions, type RequestOptions, type TTSOptions, VoiceModule, VoiceRecorder, request };

package/dist/index.js

@@ -0,0 +1,233 @@
+"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, {
+  ChatModule: () => ChatModule,
+  NeuralBase: () => NeuralBase,
+  NeuralBaseError: () => NeuralBaseError,
+  VoiceModule: () => VoiceModule,
+  VoiceRecorder: () => VoiceRecorder,
+  request: () => request
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/core/request.ts
+var NeuralBaseError = class extends Error {
+  constructor(message, status, data) {
+    super(message);
+    this.status = status;
+    this.data = data;
+    this.name = "NeuralBaseError";
+  }
+};
+async function request(url, options = {}) {
+  const { method = "GET", headers = {}, body, timeout = 3e4 } = options;
+  const controller = new AbortController();
+  const id = setTimeout(() => controller.abort(), timeout);
+  let requestBody = body;
+  if (body && typeof body === "object" && !(body instanceof FormData) && !(body instanceof Blob) && !(body instanceof ArrayBuffer) && !ArrayBuffer.isView(body)) {
+    requestBody = JSON.stringify(body);
+  }
+  try {
+    const response = await fetch(url, {
+      method,
+      headers,
+      body: requestBody,
+      signal: options.signal || controller.signal
+    });
+    clearTimeout(id);
+    if (!response.ok) {
+      let errorData;
+      try {
+        errorData = await response.json();
+      } catch {
+        errorData = { error: response.statusText };
+      }
+      const message = errorData.error || errorData.message || "Request failed";
+      throw new NeuralBaseError(message, response.status, errorData);
+    }
+    const contentType = response.headers.get("Content-Type") || "";
+    if (contentType.includes("audio/") || contentType.includes("application/octet-stream")) {
+      return await response.arrayBuffer();
+    }
+    return await response.json();
+  } catch (error) {
+    clearTimeout(id);
+    if (error instanceof NeuralBaseError) throw error;
+    if (error instanceof Error && error.name === "AbortError") {
+      throw new NeuralBaseError("Request timeout after " + timeout + "ms", 408);
+    }
+    throw new NeuralBaseError(error instanceof Error ? error.message : "Unknown error", 500);
+  }
+}
+
+// src/modules/chat.ts
+var ChatModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Neural Chat (RAG)
+   * Answers questions based on a specific knowledge context.
+   */
+  get neural() {
+    return {
+      ask: (options, contextIdOverride) => {
+        const question = typeof options === "string" ? options : options.question;
+        const contextId = (typeof options === "object" ? options.contextId : contextIdOverride) || this.client.contextId;
+        return this.client.post("/chat/context", { question, contextId });
+      }
+    };
+  }
+};
+
+// src/modules/voice.ts
+var VoiceModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Speech-to-Text
+   */
+  get stt() {
+    return {
+      /**
+       * Transcribe raw PCM audio data/Blob
+       */
+      transcribe: (audioData) => {
+        return this.client.post("/stt", audioData, {
+          "Content-Type": "application/octet-stream"
+        });
+      }
+    };
+  }
+  /**
+   * Text-to-Speech
+   */
+  get tts() {
+    return {
+      /**
+       * Generate speech audio from text
+       * Returns an ArrayBuffer of the WAV file
+       */
+      generate: (text, options = {}) => {
+        return this.client.post("/tts", { text, ...options });
+      }
+    };
+  }
+};
+
+// src/client.ts
+var NeuralBase = class {
+  constructor(config = {}) {
+    this.baseURL = (config.baseURL || "/api").replace(/\/$/, "");
+    this.timeout = config.timeout || 3e4;
+    this.contextId = config.contextId;
+    this.chat = new ChatModule(this);
+    this.voice = new VoiceModule(this);
+  }
+  /**
+   * Helper for GET requests
+   */
+  async get(path, options = {}) {
+    return request(`${this.baseURL}${path}`, {
+      method: "GET",
+      headers: this.getHeaders(),
+      timeout: this.timeout,
+      ...options
+    });
+  }
+  /**
+   * Helper for POST requests
+   */
+  async post(path, body, options = {}) {
+    return request(`${this.baseURL}${path}`, {
+      method: "POST",
+      headers: { ...this.getHeaders(), ...options },
+      // Merge headers and options
+      body,
+      timeout: this.timeout
+    });
+  }
+  getHeaders() {
+    return {};
+  }
+};
+
+// src/modules/recorder.ts
+var VoiceRecorder = class {
+  constructor() {
+    this.mediaRecorder = null;
+    this.audioChunks = [];
+    this.stream = null;
+  }
+  async start() {
+    try {
+      this.stream = await navigator.mediaDevices.getUserMedia({ audio: true });
+      this.mediaRecorder = new MediaRecorder(this.stream, {
+        mimeType: "audio/webm;codecs=opus"
+      });
+      this.audioChunks = [];
+      this.mediaRecorder.ondataavailable = (event) => {
+        if (event.data.size > 0) {
+          this.audioChunks.push(event.data);
+        }
+      };
+      this.mediaRecorder.start();
+    } catch (error) {
+      console.error("Error accessing microphone:", error);
+      throw new Error("Could not access microphone. Please check permissions.");
+    }
+  }
+  stop() {
+    return new Promise((resolve, reject) => {
+      if (!this.mediaRecorder || this.mediaRecorder.state === "inactive") {
+        return reject(new Error("Recorder is not active"));
+      }
+      this.mediaRecorder.onstop = () => {
+        const audioBlob = new Blob(this.audioChunks, { type: "audio/webm" });
+        this.cleanup();
+        resolve(audioBlob);
+      };
+      this.mediaRecorder.stop();
+    });
+  }
+  cleanup() {
+    if (this.stream) {
+      this.stream.getTracks().forEach((track) => track.stop());
+      this.stream = null;
+    }
+    this.mediaRecorder = null;
+    this.audioChunks = [];
+  }
+  isRecording() {
+    return !!this.mediaRecorder && this.mediaRecorder.state === "recording";
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ChatModule,
+  NeuralBase,
+  NeuralBaseError,
+  VoiceModule,
+  VoiceRecorder,
+  request
+});

package/dist/index.mjs

@@ -0,0 +1,201 @@
+// src/core/request.ts
+var NeuralBaseError = class extends Error {
+  constructor(message, status, data) {
+    super(message);
+    this.status = status;
+    this.data = data;
+    this.name = "NeuralBaseError";
+  }
+};
+async function request(url, options = {}) {
+  const { method = "GET", headers = {}, body, timeout = 3e4 } = options;
+  const controller = new AbortController();
+  const id = setTimeout(() => controller.abort(), timeout);
+  let requestBody = body;
+  if (body && typeof body === "object" && !(body instanceof FormData) && !(body instanceof Blob) && !(body instanceof ArrayBuffer) && !ArrayBuffer.isView(body)) {
+    requestBody = JSON.stringify(body);
+  }
+  try {
+    const response = await fetch(url, {
+      method,
+      headers,
+      body: requestBody,
+      signal: options.signal || controller.signal
+    });
+    clearTimeout(id);
+    if (!response.ok) {
+      let errorData;
+      try {
+        errorData = await response.json();
+      } catch {
+        errorData = { error: response.statusText };
+      }
+      const message = errorData.error || errorData.message || "Request failed";
+      throw new NeuralBaseError(message, response.status, errorData);
+    }
+    const contentType = response.headers.get("Content-Type") || "";
+    if (contentType.includes("audio/") || contentType.includes("application/octet-stream")) {
+      return await response.arrayBuffer();
+    }
+    return await response.json();
+  } catch (error) {
+    clearTimeout(id);
+    if (error instanceof NeuralBaseError) throw error;
+    if (error instanceof Error && error.name === "AbortError") {
+      throw new NeuralBaseError("Request timeout after " + timeout + "ms", 408);
+    }
+    throw new NeuralBaseError(error instanceof Error ? error.message : "Unknown error", 500);
+  }
+}
+
+// src/modules/chat.ts
+var ChatModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Neural Chat (RAG)
+   * Answers questions based on a specific knowledge context.
+   */
+  get neural() {
+    return {
+      ask: (options, contextIdOverride) => {
+        const question = typeof options === "string" ? options : options.question;
+        const contextId = (typeof options === "object" ? options.contextId : contextIdOverride) || this.client.contextId;
+        return this.client.post("/chat/context", { question, contextId });
+      }
+    };
+  }
+};
+
+// src/modules/voice.ts
+var VoiceModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Speech-to-Text
+   */
+  get stt() {
+    return {
+      /**
+       * Transcribe raw PCM audio data/Blob
+       */
+      transcribe: (audioData) => {
+        return this.client.post("/stt", audioData, {
+          "Content-Type": "application/octet-stream"
+        });
+      }
+    };
+  }
+  /**
+   * Text-to-Speech
+   */
+  get tts() {
+    return {
+      /**
+       * Generate speech audio from text
+       * Returns an ArrayBuffer of the WAV file
+       */
+      generate: (text, options = {}) => {
+        return this.client.post("/tts", { text, ...options });
+      }
+    };
+  }
+};
+
+// src/client.ts
+var NeuralBase = class {
+  constructor(config = {}) {
+    this.baseURL = (config.baseURL || "/api").replace(/\/$/, "");
+    this.timeout = config.timeout || 3e4;
+    this.contextId = config.contextId;
+    this.chat = new ChatModule(this);
+    this.voice = new VoiceModule(this);
+  }
+  /**
+   * Helper for GET requests
+   */
+  async get(path, options = {}) {
+    return request(`${this.baseURL}${path}`, {
+      method: "GET",
+      headers: this.getHeaders(),
+      timeout: this.timeout,
+      ...options
+    });
+  }
+  /**
+   * Helper for POST requests
+   */
+  async post(path, body, options = {}) {
+    return request(`${this.baseURL}${path}`, {
+      method: "POST",
+      headers: { ...this.getHeaders(), ...options },
+      // Merge headers and options
+      body,
+      timeout: this.timeout
+    });
+  }
+  getHeaders() {
+    return {};
+  }
+};
+
+// src/modules/recorder.ts
+var VoiceRecorder = class {
+  constructor() {
+    this.mediaRecorder = null;
+    this.audioChunks = [];
+    this.stream = null;
+  }
+  async start() {
+    try {
+      this.stream = await navigator.mediaDevices.getUserMedia({ audio: true });
+      this.mediaRecorder = new MediaRecorder(this.stream, {
+        mimeType: "audio/webm;codecs=opus"
+      });
+      this.audioChunks = [];
+      this.mediaRecorder.ondataavailable = (event) => {
+        if (event.data.size > 0) {
+          this.audioChunks.push(event.data);
+        }
+      };
+      this.mediaRecorder.start();
+    } catch (error) {
+      console.error("Error accessing microphone:", error);
+      throw new Error("Could not access microphone. Please check permissions.");
+    }
+  }
+  stop() {
+    return new Promise((resolve, reject) => {
+      if (!this.mediaRecorder || this.mediaRecorder.state === "inactive") {
+        return reject(new Error("Recorder is not active"));
+      }
+      this.mediaRecorder.onstop = () => {
+        const audioBlob = new Blob(this.audioChunks, { type: "audio/webm" });
+        this.cleanup();
+        resolve(audioBlob);
+      };
+      this.mediaRecorder.stop();
+    });
+  }
+  cleanup() {
+    if (this.stream) {
+      this.stream.getTracks().forEach((track) => track.stop());
+      this.stream = null;
+    }
+    this.mediaRecorder = null;
+    this.audioChunks = [];
+  }
+  isRecording() {
+    return !!this.mediaRecorder && this.mediaRecorder.state === "recording";
+  }
+};
+export {
+  ChatModule,
+  NeuralBase,
+  NeuralBaseError,
+  VoiceModule,
+  VoiceRecorder,
+  request
+};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@neuralbase/client",
+  "version": "1.0.0",
+  "description": "Simple, secure frontend chat SDK for NeuralBase - just send questions, get answers (no API keys required)",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch"
+  },
+  "keywords": [
+    "neuralbase",
+    "chatbot",
+    "frontend",
+    "client",
+    "browser",
+    "react",
+    "vue",
+    "typescript"
+  ],
+  "author": "NeuralBase",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3"
+  }
+}