uneeq-js 2.44.6 → 2.45.0

package/dist/src/types/PersonaStartRequest.d.ts

@@ -3,4 +3,5 @@ export interface PersonaStartRequest {
     resumeSession?: boolean;
     backgroundImageUrl?: string;
     nameTagImageUrl?: string;
+    speechToTextLocales?: string;
 }

package/dist/src/types/UneeqOptions.d.ts

@@ -65,4 +65,13 @@ export interface UneeqOptions {
      * This option specifies the URL of the name tag image to be used when the digital human is rendered.
      */
     nameTagImageUrl?: string;
+    /**
+     * This option specifies up to four locales that the Digital Human should understand a person speaking (speech recognition)
+     * The locales are specified in the BCP-47 format e.g "en-US".
+     * The first locale is considered the primary locale.
+     * Locales should be separated with a colon e.g "en-US:en-GB:en-AU".
+     *
+     * Note: this is ignored if using the VOICE_ACTIVITY voiceInputMode mode.
+     */
+    speechToTextLocales?: string;
 }

package/dist/src/uneeq.d.ts

@@ -3,8 +3,13 @@ import 'rxjs/add/operator/filter';
 import { UneeqOptions } from './types/types';
 import { VoiceInputMode } from './types/VoiceInputMode';
 export declare class Uneeq {
+    /**
+     * The active session id as a string. If the session has not started yet value will be null
+     */
+    get sessionId(): string | null;
     static onDataMessage: (msg: any) => void;
     static onStatMessage: (stats: any) => void;
+    private static localesRegEx;
     ready: BehaviorSubject<boolean>;
     version: string;
     private messages;
@@ -39,10 +44,6 @@ export declare class Uneeq {
      * should be used instead of init() when a third party conversation service is used.
      */
     initWithToken(tokenId: string): Promise<void>;
-    /**
-     * The active session id as a string. If the session has not started yet value will be null
-     */
-    get sessionId(): string | null;
     /**
      * Set a preferred camera to use in a live session. On success, SetCameraSuccessMessage
      * will be sent. DeviceNotFoundErrorMessage will be sent when the requested device is not found.
@@ -151,4 +152,10 @@ export declare class Uneeq {
      */
     private initOnlineStatusUpdateMessages;
     private initPromMetricsListener;
+    /**
+     * Validates one or more colon-separated locales
+     * @param locales
+     * @returns locales if valid, empty string otherwise
+     */
+    private validateLocales;
 }

package/dist/umd/index.js

@@ -5789,6 +5789,7 @@ class Uneeq {
         this.options.enableTransparentBackground = options.enableTransparentBackground || false;
         this.options.backgroundImageUrl = options.backgroundImageUrl || '';
         this.options.nameTagImageUrl = options.nameTagImageUrl || '';
+        this.options.speechToTextLocales = this.validateLocales(options.speechToTextLocales);
         // TODO update default mode to VOICE_ACTIVITY once we are confident in the solution.
         this.options.voiceInputMode = options.voiceInputMode || VoiceInputMode_1.VoiceInputMode.PUSH_TO_TALK;
         this.api = new api_1.API(this.options.url, this.options.apiKey);
@@ -5810,6 +5811,15 @@ class Uneeq {
         this.metricsService = new metrics_service_1.MetricsService(this.options, this.internalMessages$, this.messages);
         this.dhVideoPlayManager = new digital_human_video_play_manager_1.DigitalHumanVideoPlayManager(this.messages, () => { this.unmuteDigitalHuman(); });
     }
+    /**
+     * The active session id as a string. If the session has not started yet value will be null
+     */
+    get sessionId() {
+        if (this.session) {
+            return this.session.id;
+        }
+        return null;
+    }
     /* Enable or disable logging */
     setLoggerEnabled(enabled) {
         logger_1.logger.enabled = enabled;
@@ -5860,15 +5870,6 @@ class Uneeq {
             }
         });
     }
-    /**
-     * The active session id as a string. If the session has not started yet value will be null
-     */
-    get sessionId() {
-        if (this.session) {
-            return this.session.id;
-        }
-        return null;
-    }
     /**
      * Set a preferred camera to use in a live session. On success, SetCameraSuccessMessage
      * will be sent. DeviceNotFoundErrorMessage will be sent when the requested device is not found.
@@ -6174,7 +6175,8 @@ class Uneeq {
                     enableTransparentBackground: this.options.enableTransparentBackground,
                     resumeSession: this.sessionWasResumed,
                     backgroundImageUrl: this.options.backgroundImageUrl,
-                    nameTagImageUrl: this.options.nameTagImageUrl
+                    nameTagImageUrl: this.options.nameTagImageUrl,
+                    speechToTextLocales: this.options.speechToTextLocales
                 }).catch((err) => {
                     console.error('UneeQ: Digital human could not be started. Clearing resumeSession token and ending process.', err);
                     localStorage.removeItem('uneeqResumeSessionId');
@@ -6252,8 +6254,25 @@ class Uneeq {
             prom.handleMessage(message.promMsg);
         });
     }
+    /**
+     * Validates one or more colon-separated locales
+     * @param locales
+     * @returns locales if valid, empty string otherwise
+     */
+    validateLocales(locales = '') {
+        if (locales.length > 0) {
+            if (locales.match(Uneeq.localesRegEx)) {
+                return locales;
+            }
+            else {
+                console.error(`UneeQ: Invalid value for speechToTextLocales: ${locales}. Please use a valid BCP 47 language tag with multiple locales separated by colon .e.g 'en-US:ja-JP`);
+            }
+        }
+        return '';
+    }
 }
 exports.Uneeq = Uneeq;
+Uneeq.localesRegEx = /^([a-z]{2}(-[A-Z]{2})?)(:[a-z]{2}(-[A-Z]{2})?)*$/;
 
 
 /***/ }),
@@ -18156,7 +18175,7 @@ function zipAll(project) {
 /* 224 */
 /***/ (function(module) {
 
-module.exports = JSON.parse("{\"name\":\"uneeq-js\",\"version\":\"2.44.6\",\"description\":\"\",\"main\":\"dist/index.js\",\"types\":\"dist/src/index.d.ts\",\"scripts\":{\"start\":\"npx webpack -w\",\"test-local\":\"npx karma start karma.conf.js -logLevel=DEBUG\",\"test\":\"npx karma start --browsers ChromeHeadless --single-run\",\"test:windows\":\"karma start karma.conf.js\",\"build\":\"webpack --config webpack.config.prod.js && webpack --config webpack.config.umd.js\",\"lint\":\"npx tslint -p tsconfig.json --fix\",\"docs\":\"npx typedoc --options\"},\"files\":[\"dist\",\"!dist/test\"],\"author\":\"\",\"license\":\"ISC\",\"dependencies\":{\"@stomp/stompjs\":\"^6.0.0\",\"@uehreka/seriously\":\"^1.0.1\",\"fast-text-encoding\":\"^1.0.0\",\"intrinsic-scale\":\"^3.0.4\",\"promjs\":\"^0.4.1\",\"rxjs\":\"^6.2.2\",\"rxjs-compat\":\"^6.3.2\",\"simple-peer\":\"9.11.0\",\"webrtc-adapter\":\"8.1.0\"},\"devDependencies\":{\"@types/jasmine\":\"^2.8.8\",\"@types/node\":\"^10.9.4\",\"fetch-mock\":\"7.7.3\",\"ignore-styles\":\"^5.0.1\",\"jasmine\":\"^3.2.0\",\"jasmine-class-mock\":\"^1.0.1\",\"jasmine-core\":\"^3.3.0\",\"karma\":\"^5.0.0\",\"karma-chrome-launcher\":\"^2.2.0\",\"karma-firefox-launcher\":\"^1.1.0\",\"karma-jasmine\":\"^2.0.1\",\"karma-jasmine-html-reporter\":\"^1.4.0\",\"karma-requirejs\":\"^1.1.0\",\"karma-safari-launcher\":\"^1.0.0\",\"karma-typescript\":\"^5.0.0\",\"karma-typescript-es6-transform\":\"^5.0.0\",\"nock\":\"^9.6.1\",\"requirejs\":\"^2.3.6\",\"ts-loader\":\"^5.0.0\",\"ts-node\":\"^7.0.1\",\"tslint\":\"^5.11.0\",\"tslint-no-focused-test\":\"^0.5.0\",\"typedoc\":\"^0.18.0\",\"typescript\":\"^3.9.7\",\"webpack\":\"^4.17.1\",\"webpack-cli\":\"^3.1.0\"}}");
+module.exports = JSON.parse("{\"name\":\"uneeq-js\",\"version\":\"2.45.0\",\"description\":\"\",\"main\":\"dist/index.js\",\"types\":\"dist/src/index.d.ts\",\"scripts\":{\"start\":\"npx webpack -w\",\"test-local\":\"npx karma start karma.conf.js -logLevel=DEBUG\",\"test\":\"npx karma start --browsers ChromeHeadless --single-run\",\"test:windows\":\"karma start karma.conf.js\",\"build\":\"webpack --config webpack.config.prod.js && webpack --config webpack.config.umd.js\",\"lint\":\"npx tslint -p tsconfig.json --fix\",\"docs\":\"npx typedoc --options\"},\"files\":[\"dist\",\"!dist/test\"],\"author\":\"\",\"license\":\"ISC\",\"dependencies\":{\"@stomp/stompjs\":\"^6.0.0\",\"@uehreka/seriously\":\"^1.0.1\",\"fast-text-encoding\":\"^1.0.0\",\"intrinsic-scale\":\"^3.0.4\",\"promjs\":\"^0.4.1\",\"rxjs\":\"^6.2.2\",\"rxjs-compat\":\"^6.3.2\",\"simple-peer\":\"9.11.0\",\"webrtc-adapter\":\"8.1.0\"},\"devDependencies\":{\"@types/jasmine\":\"^2.8.8\",\"@types/node\":\"^10.9.4\",\"fetch-mock\":\"7.7.3\",\"ignore-styles\":\"^5.0.1\",\"jasmine\":\"^3.2.0\",\"jasmine-class-mock\":\"^1.0.1\",\"jasmine-core\":\"^3.3.0\",\"karma\":\"^5.0.0\",\"karma-chrome-launcher\":\"^2.2.0\",\"karma-firefox-launcher\":\"^1.1.0\",\"karma-jasmine\":\"^2.0.1\",\"karma-jasmine-html-reporter\":\"^1.4.0\",\"karma-requirejs\":\"^1.1.0\",\"karma-safari-launcher\":\"^1.0.0\",\"karma-typescript\":\"^5.0.0\",\"karma-typescript-es6-transform\":\"^5.0.0\",\"nock\":\"^9.6.1\",\"requirejs\":\"^2.3.6\",\"ts-loader\":\"^5.0.0\",\"ts-node\":\"^7.0.1\",\"tslint\":\"^5.11.0\",\"tslint-no-focused-test\":\"^0.5.0\",\"typedoc\":\"^0.18.0\",\"typescript\":\"^3.9.7\",\"webpack\":\"^4.17.1\",\"webpack-cli\":\"^3.1.0\"}}");
 
 /***/ }),
 /* 225 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uneeq-js",
-  "version": "2.44.6",
+  "version": "2.45.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",

package/readme.md

@@ -8,6 +8,9 @@ https://docs.uneeq.io/build-your-own-experience
 To use uneeq-js with a typescript version < 3.8, 'skipLibCheck' must be set to true.
 
 ## Release Notes
+#### 2.45.0
+* Added ability to, when starting a session, specify up to four languages (using locale codes) that a Digital Human should understand
+
 #### 2.44.6
 * Fixed an issue when ending a session that would cause newly created sessions to be ended shortly after.