uneeq-js 2.46.2 → 2.46.4

package/dist/src/service/locale-detector.d.ts

@@ -9,6 +9,6 @@ export declare class LocaleDetector {
      */
     static validateOrDetectSpeechLocales(options: UneeqOptions): string;
     private static defaultLocale;
-    private static localesRegEx;
     private static localeMappings;
+    private static sttSupportedLocales;
 }

package/dist/umd/index.js

@@ -5763,8 +5763,8 @@ const metrics_service_1 = __webpack_require__(303);
 const online_status_service_1 = __webpack_require__(305);
 const prom_1 = __webpack_require__(270);
 const resume_session_check_1 = __webpack_require__(306);
-const stream_manager_1 = __webpack_require__(307);
-const uneeq_local_storage_1 = __webpack_require__(308);
+const stream_manager_1 = __webpack_require__(308);
+const uneeq_local_storage_1 = __webpack_require__(307);
 const voice_input_manager_1 = __webpack_require__(309);
 const MessageTypes_1 = __webpack_require__(267);
 const NewSessionRequest_1 = __webpack_require__(312);
@@ -18173,7 +18173,7 @@ function zipAll(project) {
 /* 224 */
 /***/ (function(module) {
 
-module.exports = JSON.parse("{\"name\":\"uneeq-js\",\"version\":\"2.46.2\",\"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.46.4\",\"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 */
@@ -32957,11 +32957,15 @@ class LocaleDetector {
      */
     static validateOrDetectSpeechLocales(options) {
         let speechToTextLocales = options.speechToTextLocales;
-        // validate config language locales match regex and are not null or undefined
+        // validate config language locales match supported list and are not null or undefined
         if (speechToTextLocales && speechToTextLocales.length > 0) {
-            if (!speechToTextLocales.match(this.localesRegEx)) {
-                console.error(`UneeQ: Likely invalid value for speechToTextLocales: ${speechToTextLocales}. Please use a BCP-47 language tag with multiple locales separated by colon .e.g 'en-US:ja-JP`);
-            }
+            let arrayOfLocales = speechToTextLocales.split(':');
+            arrayOfLocales.forEach((locale) => {
+                if (!this.sttSupportedLocales[locale]) {
+                    console.error(`UneeQ: Speech to text not supported for: ${locale}. Defaulting to en-US`);
+                    speechToTextLocales = this.defaultLocale;
+                }
+            });
             if (speechToTextLocales === 'undefined' || speechToTextLocales === 'null') {
                 speechToTextLocales = this.defaultLocale;
             }
@@ -32969,27 +32973,37 @@ class LocaleDetector {
         // Get the user's language preferences from the browser
         const userLanguages = window.navigator.languages || [window.navigator.language];
         // Map two-letter language locales to four-letter language locales
+        // Chinese is unusual for our STT so requires special manipulation
         const filteredUserLanguages = userLanguages.map((lang) => {
-            if (lang.length < 5) {
-                return this.localeMappings[lang] || null;
+            if (lang.length < 5 || lang === 'zh-CN') {
+                lang = this.localeMappings[lang] || null;
+            }
+            if (lang && !this.sttSupportedLocales[lang]) {
+                console.warn(`UneeQ: Speech to text not supported for one of the detected languages: ${lang}. Replacing with en-US.`);
+                lang = this.defaultLocale;
             }
             return lang;
         });
         // Truncate the array to a maximum of 4 elements
-        const truncatedUserLanguages = filteredUserLanguages.slice(0, 4);
+        const truncatedUserLanguages = filteredUserLanguages.slice(0, 4).filter(notEmpty).filter((v, i, a) => a.indexOf(v) === i);
         // Join the filtered and truncated user's language preferences into a string separated by colons
-        let userLanguageLocales = truncatedUserLanguages.join(':');
+        let userLanguageLocales = truncatedUserLanguages.join(':').replace(/:\s*$/, "");
         if (!userLanguageLocales || userLanguageLocales.length === 0) {
             // If the user's language preferences are empty, default to en-US
             userLanguageLocales = this.defaultLocale;
         }
+        if (speechToTextLocales && speechToTextLocales.length > 0) {
+            console.debug(`UneeQ: Configured speech to text languages: ${speechToTextLocales}`);
+        }
+        else {
+            console.warn(`UneeQ: Detected speechToText languages from browser: ${userLanguageLocales}`);
+        }
         // Return the concatenated language locales string if config has not supplied any
         return speechToTextLocales || userLanguageLocales;
     }
 }
 exports.LocaleDetector = LocaleDetector;
 LocaleDetector.defaultLocale = 'en-US';
-LocaleDetector.localesRegEx = /^([a-z]{2}(-[A-Z]{2}))(:[a-z]{2}(-[A-Z]{2})?)*$/;
 // Map two-letter language locales to four-letter language locales
 LocaleDetector.localeMappings = {
     en: 'en-US',
@@ -32998,7 +33012,7 @@ LocaleDetector.localeMappings = {
     ja: 'ja-JP',
     de: 'de-DE',
     ko: 'ko-KR',
-    zh: 'zh-CN',
+    zh: 'cmn-Hans-CN',
     it: 'it-IT',
     pt: 'pt-PT',
     nl: 'nl-NL',
@@ -33019,7 +33033,158 @@ LocaleDetector.localeMappings = {
     vi: 'vi-VN',
     uk: 'uk-UA',
     hi: 'hi-IN',
+    'zh-CN': 'cmn-Hans-CN',
 };
+LocaleDetector.sttSupportedLocales = {
+    "af-ZA": true,
+    "sq-AL": true,
+    "am-ET": true,
+    "ar-DZ": true,
+    "ar-BH": true,
+    "ar-EG": true,
+    "ar-IQ": true,
+    "ar-IL": true,
+    "ar-JO": true,
+    "ar-KW": true,
+    "ar-LB": true,
+    "ar-MR": true,
+    "ar-MA": true,
+    "ar-OM": true,
+    "ar-QA": true,
+    "ar-SA": true,
+    "ar-PS": true,
+    "ar-TN": true,
+    "ar-AE": true,
+    "ar-YE": true,
+    "hy-AM": true,
+    "az-AZ": true,
+    "eu-ES": true,
+    "bn-BD": true,
+    "bn-IN": true,
+    "bs-BA": true,
+    "bg-BG": true,
+    "my-MM": true,
+    "ca-ES": true,
+    "yue-Hant-HK": true,
+    "cmn-Hans-CN": true,
+    "cmn-Hant-TW": true,
+    "hr-HR": true,
+    "cs-CZ": true,
+    "da-DK": true,
+    "nl-BE": true,
+    "nl-NL": true,
+    "en-AU": true,
+    "en-CA": true,
+    "en-GH": true,
+    "en-HK": true,
+    "en-IN": true,
+    "en-IE": true,
+    "en-KE": true,
+    "en-NZ": true,
+    "en-NG": true,
+    "en-PK": true,
+    "en-PH": true,
+    "en-SG": true,
+    "en-ZA": true,
+    "en-TZ": true,
+    "en-GB": true,
+    "en-US": true,
+    "et-EE": true,
+    "fil-PH": true,
+    "fi-FI": true,
+    "fr-BE": true,
+    "fr-CA": true,
+    "fr-FR": true,
+    "fr-CH": true,
+    "gl-ES": true,
+    "ka-GE": true,
+    "de-AT": true,
+    "de-DE": true,
+    "de-CH": true,
+    "el-GR": true,
+    "gu-IN": true,
+    "iw-IL": true,
+    "hi-IN": true,
+    "hu-HU": true,
+    "is-IS": true,
+    "id-ID": true,
+    "it-IT": true,
+    "it-CH": true,
+    "ja-JP": true,
+    "jv-ID": true,
+    "kn-IN": true,
+    "kk-KZ": true,
+    "km-KH": true,
+    "ko-KR": true,
+    "lo-LA": true,
+    "lv-LV": true,
+    "lt-LT": true,
+    "mk-MK": true,
+    "ms-MY": true,
+    "ml-IN": true,
+    "mr-IN": true,
+    "mn-MN": true,
+    "ne-NP": true,
+    "no-NO": true,
+    "fa-IR": true,
+    "pl-PL": true,
+    "pt-BR": true,
+    "pt-PT": true,
+    "pa-Guru-IN": true,
+    "ro-RO": true,
+    "ru-RU": true,
+    "rw-RW": true,
+    "sr-RS": true,
+    "si-LK": true,
+    "sk-SK": true,
+    "sl-SI": true,
+    "ss-latn-za": true,
+    "st-ZA": true,
+    "es-AR": true,
+    "es-BO": true,
+    "es-CL": true,
+    "es-CO": true,
+    "es-CR": true,
+    "es-DO": true,
+    "es-EC": true,
+    "es-SV": true,
+    "es-GT": true,
+    "es-HN": true,
+    "es-MX": true,
+    "es-NI": true,
+    "es-PA": true,
+    "es-PY": true,
+    "es-PE": true,
+    "es-PR": true,
+    "es-ES": true,
+    "es-US": true,
+    "es-UY": true,
+    "es-VE": true,
+    "su-ID": true,
+    "sw-KE": true,
+    "sw-TZ": true,
+    "sv-SE": true,
+    "ta-IN": true,
+    "ta-MY": true,
+    "ta-SG": true,
+    "ta-LK": true,
+    "te-IN": true,
+    "th-TH": true,
+    "tn-latn-za": true,
+    "tr-TR": true,
+    "ts-ZA": true,
+    "uk-UA": true,
+    "ur-IN": true,
+    "ur-PK": true,
+    "uz-UZ": true,
+    "ve-ZA": true,
+    "vi-VN": true,
+    "xh-ZA": true,
+    "zu-ZA": true,
+};
+function notEmpty(value) {
+    return value !== null && value !== undefined;
+}
 
 
 /***/ }),
@@ -53465,10 +53630,12 @@ exports.OnlineStatusService = OnlineStatusService;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ResumeSessionCheck = void 0;
 const logger_1 = __webpack_require__(233);
+const uneeq_local_storage_1 = __webpack_require__(307);
 class ResumeSessionCheck {
     static validate(options) {
+        const uneeqLocalStorage = new uneeq_local_storage_1.UneeqLocalStorage();
         let resumeSession = options.resumeSession !== undefined ? options.resumeSession : false;
-        const resumeSessionPersonaId = localStorage.getItem('uneeqResumeSessionPersonaId');
+        const resumeSessionPersonaId = uneeqLocalStorage.getItemSafely('uneeqResumeSessionPersonaId');
         const resumingSamePersona = resumeSessionPersonaId === options.conversationId;
         if (!resumingSamePersona) {
             logger_1.logger.log('UneeQ: Persona Id\'s do not match, unable to resume session.');
@@ -53480,7 +53647,7 @@ class ResumeSessionCheck {
             resumeSession = false;
         }
         if (resumeSession) {
-            const resumeSessionId = localStorage.getItem('uneeqResumeSessionId');
+            const resumeSessionId = uneeqLocalStorage.getItemSafely('uneeqResumeSessionId');
             if (resumeSessionId !== null) {
                 return {
                     resumeSession: true,
@@ -53507,6 +53674,63 @@ exports.ResumeSessionCheck = ResumeSessionCheck;
 
 "use strict";
 
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UneeqLocalStorage = void 0;
+const logger_1 = __webpack_require__(233);
+class UneeqLocalStorage {
+    constructor() { }
+    get available() {
+        if (this.localStorageAvailable === undefined) {
+            this.localStorageAvailable = this.checkIfLocalStorageAvailable();
+        }
+        return this.localStorageAvailable;
+    }
+    setItemSafely(key, value) {
+        if (this.available) {
+            localStorage.setItem(key, value);
+        }
+        else {
+            logger_1.logger.log('UneeQ: unable to access localStorage because it is not available.');
+        }
+    }
+    getItemSafely(key) {
+        if (this.available) {
+            return localStorage.getItem(key);
+        }
+        else {
+            logger_1.logger.log('UneeQ: unable to access localStorage because it is not available.');
+            return undefined;
+        }
+    }
+    removeItemSafely(key) {
+        if (this.available) {
+            localStorage.removeItem(key);
+        }
+        else {
+            logger_1.logger.log('UneeQ: unable to access localStorage because it is not available.');
+        }
+    }
+    checkIfLocalStorageAvailable() {
+        const uneeqLocalStoreCheck = 'UneeqLocalStoreCheck';
+        try {
+            localStorage.setItem(uneeqLocalStoreCheck, uneeqLocalStoreCheck);
+            localStorage.removeItem(uneeqLocalStoreCheck);
+            return true;
+        }
+        catch (e) {
+            return false;
+        }
+    }
+}
+exports.UneeqLocalStorage = UneeqLocalStorage;
+
+
+/***/ }),
+/* 308 */
+/***/ (function(module, exports, __webpack_require__) {
+
+"use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StreamManager = void 0;
 class StreamManager {
@@ -53566,64 +53790,6 @@ class StreamManager {
 exports.StreamManager = StreamManager;
 
 
-/***/ }),
-/* 308 */
-/***/ (function(module, exports, __webpack_require__) {
-
-"use strict";
-
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UneeqLocalStorage = void 0;
-const logger_1 = __webpack_require__(233);
-class UneeqLocalStorage {
-    constructor() { }
-    get available() {
-        if (this.localStorageAvailable === undefined) {
-            this.localStorageAvailable = this.checkIfLocalStorageAvailable();
-        }
-        return this.localStorageAvailable;
-    }
-    setItemSafely(key, value) {
-        if (this.available) {
-            localStorage.setItem(key, value);
-        }
-        else {
-            logger_1.logger.log('UneeQ: unable to access localStorage because it is not available.');
-        }
-    }
-    getItemSafely(key) {
-        if (this.available) {
-            return localStorage.getItem(key);
-        }
-        else {
-            logger_1.logger.log('UneeQ: unable to access localStorage because it is not available.');
-            return undefined;
-        }
-    }
-    removeItemSafely(key) {
-        if (this.available) {
-            localStorage.removeItem(key);
-        }
-        else {
-            logger_1.logger.log('UneeQ: unable to access localStorage because it is not available.');
-        }
-    }
-    checkIfLocalStorageAvailable() {
-        const uneeqLocalStoreCheck = 'UneeqLocalStoreCheck';
-        try {
-            localStorage.setItem(uneeqLocalStoreCheck, uneeqLocalStoreCheck);
-            localStorage.removeItem(uneeqLocalStoreCheck);
-            return true;
-        }
-        catch (e) {
-            console.warn('UneeQ: Local storage is not available. Reason: ', e);
-            return false;
-        }
-    }
-}
-exports.UneeqLocalStorage = UneeqLocalStorage;
-
-
 /***/ }),
 /* 309 */
 /***/ (function(module, exports, __webpack_require__) {

package/package.json

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

package/readme.md

@@ -8,6 +8,12 @@ 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.46.4
+* Improve locale detection to ensure we fall back to supported speech to text languages
+
+#### 2.46.3
+* Fix for sessions to start without localStorage availability.
+
 #### 2.46.2
 * Fix for session starting in incognito browser windows.