@hubui/client 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 HubUI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,247 @@
+# @hubui/client
+
+Official JavaScript/TypeScript SDK for [HubUI](https://hubui.ai) — Connect your applications to AI voice and text agents.
+
+**SDK Version: 0.1.0**
+
+[Get Started Free](https://app.hubui.ai) · [Documentation](https://app.hubui.ai/documentation) · [Discord](https://discord.gg/9HZBN6ZeU6)
+
+---
+
+## Why HubUI Client?
+
+If you already have a web app — React, Next.js, Vue, plain HTML — HubUI Client lets you **drop in a real-time voice or text AI agent with a few lines of code**. No WebRTC plumbing. No socket management. No audio handling.
+
+Your users get a real-time conversation with an AI agent — voice with sub-500ms latency, or streaming text chat — and you get a clean event-driven API. Connect, listen for events, done.
+
+The Client SDK handles the browser side. HubUI handles everything else — speech-to-text, LLM inference, text-to-speech, and phone numbers.
+
+> **Building a custom reasoning backend?** Use the [HubUI Brain SDK](https://github.com/HubUI-AI/hubui-brain) (Python) to plug in your own LLM, LangChain, or LangGraph pipeline.
+
+---
+
+## Installation
+
+### From npm (recommended)
+
+```bash
+npm install @hubui/client
+```
+
+### From GitHub repository
+
+```bash
+npm install github:HubUI-AI/hubui-client
+```
+
+If your environment requires explicit Git URLs:
+
+```bash
+npm install git+https://github.com/HubUI-AI/hubui-client.git
+```
+
+## Before You Start
+
+- [Free HubUI account](https://app.hubui.ai) (sign up in seconds)
+- Agent created in the [HubUI Dashboard](https://app.hubui.ai)
+- API key (`pk_live_...`) from Dashboard > Settings > API Keys
+- `agentId` from the Agents page
+
+## Quick Start
+
+### Voice Mode
+
+```typescript
+import { HubUI } from '@hubui/client';
+
+// Connect to your agent in voice mode
+const session = await HubUI.connect({
+  agentId: 'your-agent-id',      // From HubUI Dashboard
+  apiKey: 'pk_live_xxxxx',        // From HubUI Dashboard > Settings > API Keys
+  mode: 'voice',
+  userName: 'John Doe',           // Optional: End user's name
+});
+
+// Listen for transcripts
+session.on('transcript', (text, speaker, isFinal) => {
+  console.log(`${speaker}: ${text}`);
+});
+
+// Handle connection state
+session.on('connectionStateChanged', (state) => {
+  console.log('Connection:', state);
+});
+
+// Mute/unmute controls
+session.mute();
+session.unmute();
+
+// Disconnect when done
+await session.disconnect();
+```
+
+### Text Mode
+
+```typescript
+import { HubUI } from '@hubui/client';
+
+// Connect to your agent in text mode
+const session = await HubUI.connect({
+  agentId: 'your-agent-id',
+  apiKey: 'pk_live_xxxxx',
+  mode: 'text',
+  userName: 'John Doe',
+});
+
+// Listen for agent responses
+session.on('message', (text) => {
+  console.log('Agent:', text);
+});
+
+// Send messages
+await session.send('Hello! How can you help me?');
+
+// Disconnect when done
+await session.disconnect();
+```
+
+## API Reference
+
+### `HubUI.connect(config)`
+
+Connects to a HubUI agent and returns a session.
+
+**Parameters:**
+
+| Property | Type | Required | Description |
+|----------|------|----------|-------------|
+| `agentId` | `string` | Yes | Your agent ID from the dashboard |
+| `apiKey` | `string` | Yes* | Your API key (`pk_live_...`) |
+| `token` | `string` | No | Pre-fetched realtime token (advanced usage) |
+| `serverUrl` | `string` | No | Realtime server URL (required when `token` is provided) |
+| `mode` | `'voice' \| 'text'` | Yes | Connection mode |
+| `userName` | `string` | No | End user's display name |
+| `userEmail` | `string` | No | End user's email |
+| `audioInput` | `string` | No | Audio input device ID |
+| `audioOutput` | `string` | No | Audio output device ID |
+| `apiBaseUrl` | `string` | No | Custom HubUI API base URL |
+| `debug` | `boolean` | No | Enable SDK debug logging (default: `false`) |
+
+**Returns:** `Promise<HubUISession>`
+
+\* `apiKey` is required unless you provide `token` + `serverUrl`.
+
+### `HubUI.getAudioDevices()`
+
+Lists available audio input and output devices.
+
+```typescript
+const { inputs, outputs } = await HubUI.getAudioDevices();
+
+console.log('Microphones:', inputs);
+console.log('Speakers:', outputs);
+```
+
+### `HubUISession`
+
+#### Properties
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `state` | `HubUIConnectionState` | Current connection state |
+| `mode` | `'voice' \| 'text'` | Current mode |
+| `transcript` | `HubUITranscriptEntry[]` | Full conversation transcript |
+
+#### Methods
+
+| Method | Description |
+|--------|-------------|
+| `on(event, callback)` | Subscribe to events |
+| `off(event, callback)` | Unsubscribe from events |
+| `mute()` | Mute microphone (voice mode) |
+| `unmute()` | Unmute microphone (voice mode) |
+| `isMuted()` | Check if muted |
+| `enableAudio()` | Enable audio (required on mobile) |
+| `send(message)` | Send text message |
+| `setAudioInput(deviceId)` | Change microphone |
+| `setAudioOutput(deviceId)` | Change speaker |
+| `disconnect()` | End the session |
+
+#### Events
+
+| Event | Callback | Description |
+|-------|----------|-------------|
+| `connected` | `() => void` | Connected to agent |
+| `disconnected` | `() => void` | Disconnected from agent |
+| `error` | `(error: HubUIError) => void` | Error occurred |
+| `transcript` | `(text, speaker, isFinal) => void` | Voice transcript received |
+| `message` | `(text) => void` | Text message received |
+| `connectionStateChanged` | `(state) => void` | State changed |
+| `audioPlaybackBlocked` | `() => void` | Audio blocked (call `enableAudio()`) |
+
+## Mobile Browser Support
+
+Mobile browsers require a user gesture to play audio. Handle this with:
+
+```typescript
+session.on('audioPlaybackBlocked', () => {
+  // Show UI prompting user to tap
+  showButton('Tap to enable audio', async () => {
+    await session.enableAudio();
+  });
+});
+```
+
+## Error Handling
+
+```typescript
+import { HubUI, HubUIError, ErrorCodes } from '@hubui/client';
+
+try {
+  const session = await HubUI.connect(config);
+} catch (error) {
+  if (error instanceof HubUIError) {
+    switch (error.code) {
+      case ErrorCodes.INVALID_API_KEY:
+        console.error('Invalid API key');
+        break;
+      case ErrorCodes.INVALID_AGENT_ID:
+        console.error('Agent not found');
+        break;
+      default:
+        console.error('Error:', error.message);
+    }
+  }
+}
+```
+
+## TypeScript Support
+
+Full TypeScript support with exported types:
+
+```typescript
+import type {
+  HubUIConfig,
+  HubUIConnectionState,
+  HubUITranscriptEntry,
+  AudioDevice,
+} from '@hubui/client';
+```
+
+## Browser Support
+
+- Chrome 70+
+- Firefox 65+
+- Safari 14+
+- Edge 79+
+
+## Support
+
+- **[Read the docs](https://app.hubui.ai/documentation)** — full platform documentation
+- **[Join the Discord](https://discord.gg/9HZBN6ZeU6)** — get help, share what you're building
+- Email: info@hubui.ai
+- Dashboard: https://app.hubui.ai
+
+## License
+
+This software is licensed under the [Apache License 2.0](LICENSE).

package/dist/HubUI.d.ts

@@ -0,0 +1,54 @@
+/**
+ * HubUI Client SDK - Main Entry Point
+ * @hubui/client
+ *
+ * Static class providing SDK entry points.
+ */
+import { HubUISession } from './HubUISession';
+import { HubUIConfig, AudioDevice } from './types';
+/**
+ * Main entry point for the HubUI SDK.
+ *
+ * @example
+ * ```typescript
+ * import { HubUI } from '@hubui/client';
+ *
+ * // Connect to an agent
+ * const session = await HubUI.connect({
+ *   agentId: 'your-agent-id',
+ *   apiKey: 'pk_live_xxxxx',
+ *   mode: 'voice',  // or 'text'
+ *   userName: 'John Doe',
+ * });
+ *
+ * // Listen for events
+ * session.on('transcript', (text, speaker) => {
+ *   console.log(`${speaker}: ${text}`);
+ * });
+ *
+ * // Disconnect when done
+ * await session.disconnect();
+ * ```
+ */
+export declare class HubUI {
+    /**
+     * Connect to a HubUI agent.
+     *
+     * @param config - Configuration for the connection
+     * @returns A promise that resolves to an active HubUISession
+     * @throws HubUIError if connection fails
+     */
+    static connect(config: HubUIConfig): Promise<HubUISession>;
+    /**
+     * Get available audio input and output devices.
+     *
+     * @returns Lists of available audio devices
+     * @throws HubUIError if device enumeration fails
+     */
+    static getAudioDevices(): Promise<{
+        inputs: AudioDevice[];
+        outputs: AudioDevice[];
+    }>;
+    private static validateConfig;
+    private static fetchToken;
+}

package/dist/HubUISession.d.ts

@@ -0,0 +1,120 @@
+/**
+ * HubUI Client SDK - Session Class
+ * @hubui/client
+ *
+ * Manages an active connection to a HubUI agent.
+ */
+import { HubUIConnectionState, HubUITranscriptEntry, HubUIEvents, HubUIConfig, TokenResponse } from './types';
+/**
+ * Represents an active session with a HubUI agent.
+ *
+ * @example
+ * ```typescript
+ * const session = await HubUI.connect({ agentId, apiKey, mode: 'voice' });
+ *
+ * session.on('transcript', (text, speaker, isFinal) => {
+ *   console.log(`${speaker}: ${text}`);
+ * });
+ *
+ * session.on('message', (text) => {
+ *   console.log('Agent:', text);
+ * });
+ *
+ * // For text mode:
+ * await session.send('Hello!');
+ *
+ * // Cleanup
+ * await session.disconnect();
+ * ```
+ */
+export declare class HubUISession {
+    private room;
+    private config;
+    private eventListeners;
+    private _state;
+    private _transcript;
+    private _isMuted;
+    private transcriptIdCounter;
+    private audioContext;
+    private audioUnlocked;
+    private debug;
+    /**
+     * @internal
+     * Use HubUI.connect() instead of constructing directly.
+     */
+    constructor(config: HubUIConfig);
+    /**
+     * Current connection state
+     */
+    get state(): HubUIConnectionState;
+    /**
+     * Current mode (voice or text)
+     */
+    get mode(): 'voice' | 'text';
+    /**
+     * Full transcript history
+     */
+    get transcript(): HubUITranscriptEntry[];
+    /**
+     * @internal
+     * Connect to the room - called by HubUI.connect()
+     */
+    connect(tokenResponse: TokenResponse): Promise<void>;
+    /**
+     * Register an event listener
+     */
+    on<E extends keyof HubUIEvents>(event: E, callback: HubUIEvents[E]): void;
+    /**
+     * Remove an event listener
+     */
+    off<E extends keyof HubUIEvents>(event: E, callback: HubUIEvents[E]): void;
+    /**
+     * Mute the microphone (voice mode only)
+     */
+    mute(): void;
+    /**
+     * Unmute the microphone (voice mode only)
+     */
+    unmute(): void;
+    /**
+     * Check if microphone is muted
+     */
+    isMuted(): boolean;
+    /**
+     * Enable audio playback (required on mobile browsers)
+     */
+    enableAudio(): Promise<void>;
+    /**
+     * Send a text message to the agent
+     */
+    send(message: string): Promise<void>;
+    /**
+     * Set audio input device
+     */
+    setAudioInput(deviceId: string): Promise<void>;
+    /**
+     * Set audio output device
+     */
+    setAudioOutput(deviceId: string): Promise<void>;
+    /**
+     * Disconnect from the agent
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Unlock audio for mobile browsers - must be called before connect
+     */
+    private unlockAudio;
+    /**
+     * Register text stream handlers for receiving agent responses
+     */
+    private registerTextStreamHandlers;
+    private setupRoomListeners;
+    private mapConnectionState;
+    private updateState;
+    private addTranscriptEntry;
+    private updateTranscriptEntry;
+    private log;
+    private logWarn;
+    private logError;
+    private emit;
+}

package/dist/constants.d.ts

@@ -0,0 +1,37 @@
+/**
+ * HubUI Client SDK - Constants
+ * @hubui/client
+ */
+/**
+ * Default API base URL for HubUI backend
+ */
+export declare const DEFAULT_API_BASE_URL = "https://api.hubui.ai";
+/**
+ * API endpoints
+ */
+export declare const API_ENDPOINTS: {
+    /** Public token endpoint for SDK authentication */
+    readonly PUBLIC_TOKEN: "/api/v1/tokens/public";
+};
+/**
+ * Realtime data channel topics
+ */
+export declare const DATA_TOPICS: {
+    /** Topic for text chat messages */
+    readonly CHAT: "lk-chat-topic";
+};
+/**
+ * Default configuration values
+ */
+export declare const DEFAULTS: {
+    /** Default connection timeout in milliseconds */
+    readonly CONNECTION_TIMEOUT: 30000;
+    /** Default reconnection attempts */
+    readonly MAX_RECONNECT_ATTEMPTS: 3;
+    /** Default user name if not provided */
+    readonly USER_NAME: "User";
+};
+/**
+ * SDK version
+ */
+export declare const SDK_VERSION = "0.1.0";