uneeq-js 3.6.8 → 3.6.10

package/README.md

@@ -1,15 +1,69 @@
-# uneeq-js
+# DHOP Web SDK
+This project is a web npm package used to connect to Uneeq's Digital Human Orchestration Platform (DHOP)
 
-## Installation
+## Usage
+#### Install dependencies:
+`npm i`
+
+#### Start:
+`npm start`
+
+#### Run Tests:
+`npm test`
+
+#### Local testing
+
+See [./example/README.md](./example/README.md)
+
+#### Local Development with Angular Apps
+
+When developing uneeq-js alongside an Angular app (e.g., `hosted-experience`):
 
 ```bash
-npm install uneeq-js
+# From uneeq-js directory:
+npm link
+npm start                     # Runs in watch mode, auto-compiles changes
+
+# From the consuming app (e.g., apps/hosted-experience):
+npm link uneeq-js
+npm start
 ```
 
-## Documentation
+Changes to uneeq-js are automatically picked up without restarting.
+
+**Why this works:** Angular apps should configure `prebundle.exclude: ["uneeq-js"]` in `angular.json` to prevent caching during prebundling.
+
+**Reverting to npm version:**
+```bash
+npm unlink uneeq-js
+npm install
+```
+
+#### Lint
+
+Eslint is used in this project and can be run with `npm run lint`. You may find it easier to install VSCode plugin `eslint` to see lint errors in editor. Additionally adding the following option to the plugin settings will fix errors on save:
+
+`"editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true
+}`
+
+#### Logging
+A custom logger has been implemented using `pino` library. You can use it to log strings with values.
+`Logger.info('Logging just a string')`
+`Logger.info('Logging with value', { some: 'thing' })`
+`Logger.info('Logging with multiple values', { some: 'thing' }, { another: 'thing' })`
+
+There are multiple log levels which are defined in `src/types/LogLevels.ts`:
+`Logger.debug('a debug log')`
+`Logger.info('an info log')`
+`Logger.warn('a warning log')`
+`Logger.error('an error log')`
+
+Logs will only be displayed if they are at or above the log level specified when initializing the Uneeq class via UneeqConfig. The default log level is 'info'.
 
-For direct SDK integration (build your own), see: https://docs.uneeq.io/unlisted
+Log messages will be prefixed with the string 'UneeQ: ' so that uneeq-js logs can be differentiated from client logs easily.
 
-## Looking for Hosted Experience?
 
-If you're looking for UneeQ's Hosted Experience, visit: https://docs.uneeq.io/hosted-experience
+## Notes
+#### onnxruntime-web
+onnxruntime-web only works on version 1.15.1 at this time. Upgrading this package will likely break VAD funtionality.

package/README.npm.md

@@ -0,0 +1,15 @@
+# uneeq-js
+
+## Installation
+
+```bash
+npm install uneeq-js
+```
+
+## Documentation
+
+For direct SDK integration (build your own), see: https://docs.uneeq.io/unlisted
+
+## Looking for Hosted Experience?
+
+If you're looking for UneeQ's Hosted Experience, visit: https://docs.uneeq.io/hosted-experience

package/dist/deepgram-stt.d.ts

@@ -2,6 +2,7 @@ import { type Subject } from 'rxjs';
 import { type UneeqMessage } from './types/UneeqMessages';
 import { type DataChannelMessage } from './webrtc-data-channel/DataChannelMessage';
 import { type PromptMetadata } from './types/PromptMetadata';
+import { type SpeechRecognitionInterface } from './types/SpeechRecognitionInterface';
 export interface DeepgramSTTOptions {
     connectionUrl: string;
     jwtToken: string;
@@ -21,11 +22,12 @@ export interface DeepgramSTTOptions {
     echoCancellation?: boolean;
     noiseSuppression?: boolean;
     autoGainControl?: boolean;
+    microphoneDeviceId?: string;
     promptMetadata: PromptMetadata;
     messages: Subject<UneeqMessage>;
     sendMessage: (msg: DataChannelMessage) => void;
 }
-export declare class DeepgramSTT {
+export declare class DeepgramSTT implements SpeechRecognitionInterface {
     private readonly options;
     private connection;
     private isConnected;