ug-js-sdk 3.0.46

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 UG labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,106 @@
+# UG JS SDK
+
+![npm version](https://img.shields.io/npm/v/ug-js-sdk)
+![license](https://img.shields.io/npm/l/ug-js-sdk)
+![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue)
+
+JavaScript SDK for building conversational AI experiences with voice, text, avatars, and real-time interactions.
+
+## Installation
+
+```bash
+npm install ug-js-sdk
+```
+
+## Quick Start
+
+```typescript
+import { ConversationManager } from 'ug-js-sdk'
+
+const conversation = new ConversationManager({
+  apiUrl: 'wss://pug.uglabs.app',
+  apiKey: 'your-api-key',
+  federatedId: 'user-123',
+  prompt: 'You are a friendly assistant.',
+  hooks: {
+    onStateChange: (state) => console.log('State:', state),
+    onTextMessage: (event) => console.log('Assistant:', event.text),
+    onError: (error) => console.error('Error:', error.message),
+  },
+})
+
+// Start the conversation
+await conversation.start()
+
+// Send text input
+await conversation.sendText('Hello!')
+
+// Or enable voice input
+await conversation.startListening()
+```
+
+## Features
+
+- **Voice Input/Output** - Real-time speech-to-text and text-to-speech
+- **Text Chat** - Send and receive text messages
+- **Avatar Support** - Lip-sync animations with viseme data
+- **Subtitles** - Real-time captions with word highlighting
+- **Utilities** - Built-in classifiers and extractors for AI operations
+- **Safety Policies** - Content filtering and moderation
+- **Image Generation** - Generate images via Bria or Replicate
+
+## Configuration
+
+```typescript
+const config: ConversationConfig = {
+  apiUrl: 'wss://pug.uglabs.app',
+  apiKey: 'your-api-key',
+  federatedId: 'user-id',
+  prompt: 'Your system prompt here',
+
+  // Optional: Configure capabilities
+  capabilities: {
+    audio: true,
+    subtitles: true,
+    viseme: false,
+    avatar: false,
+  },
+
+  // Optional: Voice settings
+  voiceProfile: {
+    voice_id: 'voice-id',
+    speed: 1.0,
+  },
+
+  hooks: {
+    onStateChange: (state) => { /* handle state */ },
+    onTextMessage: (event) => { /* handle text */ },
+    onSubtitleChange: (subtitle) => { /* handle subtitles */ },
+    onError: (error) => { /* handle errors */ },
+  },
+}
+```
+
+## Conversation States
+
+The SDK manages the following states:
+
+| State | Description |
+|-------|-------------|
+| `uninitialized` | Before connection |
+| `initializing` | Connecting to server |
+| `idle` | Ready for interaction |
+| `listening` | Listening for voice input |
+| `userSpeaking` | User is speaking |
+| `waiting` | Processing input |
+| `playing` | Playing audio response |
+
+## Documentation
+
+For full documentation, API reference, and examples visit:
+
+**[docs.uglabs.io/sdk/js](https://docs.uglabs.io/sdk/js)**
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './ug-core';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './ug-core';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}

package/dist/ug-core/conversation-manager/ConversationCommands.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Contains conversation command strings that can be customized externally.
+ * These commands are sent to the conversation system to control conversation flow.
+ */
+export declare class ConversationCommands {
+    static readonly DEFAULT_START_COMMAND = "[start conversation]";
+    static readonly DEFAULT_PAUSE_RESUME_COMMAND = "[resume after short pause]";
+    static readonly DEFAULT_LONG_PAUSE_RESUME_COMMAND = "[resume after long break]";
+    static readonly DEFAULT_ERROR_RESUME_COMMAND = "[resume after error]";
+    startCommand: string;
+    pauseResumeCommand: string;
+    longPauseResumeCommand: string;
+    errorResumeCommand: string;
+    /**
+     * Sets all command values at once
+     * @param startCommand Command to start conversation
+     * @param pauseResumeCommand Command to resume conversation after a short pause
+     * @param longPauseResumeCommand Command to resume after a long break
+     * @param errorResumeCommand Command to resume after error
+     */
+    set(startCommand?: string, pauseResumeCommand?: string, longPauseResumeCommand?: string, errorResumeCommand?: string): void;
+    /**
+     * Resets all command values to their defaults
+     */
+    setDefault(): void;
+}

package/dist/ug-core/conversation-manager/ConversationCommands.js

@@ -0,0 +1,39 @@
+/**
+ * Contains conversation command strings that can be customized externally.
+ * These commands are sent to the conversation system to control conversation flow.
+ */
+export class ConversationCommands {
+    // Default command constants
+    static DEFAULT_START_COMMAND = '[start conversation]';
+    static DEFAULT_PAUSE_RESUME_COMMAND = '[resume after short pause]';
+    static DEFAULT_LONG_PAUSE_RESUME_COMMAND = '[resume after long break]';
+    static DEFAULT_ERROR_RESUME_COMMAND = '[resume after error]';
+    startCommand = ConversationCommands.DEFAULT_START_COMMAND;
+    pauseResumeCommand = ConversationCommands.DEFAULT_PAUSE_RESUME_COMMAND;
+    longPauseResumeCommand = ConversationCommands.DEFAULT_LONG_PAUSE_RESUME_COMMAND;
+    errorResumeCommand = ConversationCommands.DEFAULT_ERROR_RESUME_COMMAND;
+    /**
+     * Sets all command values at once
+     * @param startCommand Command to start conversation
+     * @param pauseResumeCommand Command to resume conversation after a short pause
+     * @param longPauseResumeCommand Command to resume after a long break
+     * @param errorResumeCommand Command to resume after error
+     */
+    set(startCommand, pauseResumeCommand, longPauseResumeCommand, errorResumeCommand) {
+        this.startCommand = startCommand ?? ConversationCommands.DEFAULT_START_COMMAND;
+        this.pauseResumeCommand = pauseResumeCommand ?? ConversationCommands.DEFAULT_PAUSE_RESUME_COMMAND;
+        this.longPauseResumeCommand =
+            longPauseResumeCommand ?? ConversationCommands.DEFAULT_LONG_PAUSE_RESUME_COMMAND;
+        this.errorResumeCommand = errorResumeCommand ?? ConversationCommands.DEFAULT_ERROR_RESUME_COMMAND;
+    }
+    /**
+     * Resets all command values to their defaults
+     */
+    setDefault() {
+        this.startCommand = ConversationCommands.DEFAULT_START_COMMAND;
+        this.pauseResumeCommand = ConversationCommands.DEFAULT_PAUSE_RESUME_COMMAND;
+        this.longPauseResumeCommand = ConversationCommands.DEFAULT_LONG_PAUSE_RESUME_COMMAND;
+        this.errorResumeCommand = ConversationCommands.DEFAULT_ERROR_RESUME_COMMAND;
+    }
+}
+//# sourceMappingURL=ConversationCommands.js.map

package/dist/ug-core/conversation-manager/ConversationCommands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConversationCommands.js","sourceRoot":"","sources":["../../../src/ug-core/conversation-manager/ConversationCommands.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,OAAO,oBAAoB;IAC/B,4BAA4B;IACrB,MAAM,CAAU,qBAAqB,GAAG,sBAAsB,CAAA;IAC9D,MAAM,CAAU,4BAA4B,GAAG,4BAA4B,CAAA;IAC3E,MAAM,CAAU,iCAAiC,GAAG,2BAA2B,CAAA;IAC/E,MAAM,CAAU,4BAA4B,GAAG,sBAAsB,CAAA;IAErE,YAAY,GAAW,oBAAoB,CAAC,qBAAqB,CAAA;IACjE,kBAAkB,GAAW,oBAAoB,CAAC,4BAA4B,CAAA;IAC9E,sBAAsB,GAAW,oBAAoB,CAAC,iCAAiC,CAAA;IACvF,kBAAkB,GAAW,oBAAoB,CAAC,4BAA4B,CAAA;IAErF;;;;;;OAMG;IACI,GAAG,CACR,YAAqB,EACrB,kBAA2B,EAC3B,sBAA+B,EAC/B,kBAA2B;QAE3B,IAAI,CAAC,YAAY,GAAG,YAAY,IAAI,oBAAoB,CAAC,qBAAqB,CAAA;QAC9E,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,IAAI,oBAAoB,CAAC,4BAA4B,CAAA;QACjG,IAAI,CAAC,sBAAsB;YACzB,sBAAsB,IAAI,oBAAoB,CAAC,iCAAiC,CAAA;QAClF,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,IAAI,oBAAoB,CAAC,4BAA4B,CAAA;IACnG,CAAC;IAED;;OAEG;IACI,UAAU;QACf,IAAI,CAAC,YAAY,GAAG,oBAAoB,CAAC,qBAAqB,CAAA;QAC9D,IAAI,CAAC,kBAAkB,GAAG,oBAAoB,CAAC,4BAA4B,CAAA;QAC3E,IAAI,CAAC,sBAAsB,GAAG,oBAAoB,CAAC,iCAAiC,CAAA;QACpF,IAAI,CAAC,kBAAkB,GAAG,oBAAoB,CAAC,4BAA4B,CAAA;IAC7E,CAAC"}