uneeq-js 2.46.0 → 2.46.3

package/dist/src/service/uneeq-local-storage.d.ts

@@ -0,0 +1,9 @@
+export declare class UneeqLocalStorage {
+    private localStorageAvailable?;
+    constructor();
+    get available(): boolean;
+    setItemSafely(key: string, value: string): void;
+    getItemSafely(key: string): any;
+    removeItemSafely(key: string): void;
+    private checkIfLocalStorageAvailable;
+}

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

@@ -16,6 +16,7 @@ export declare enum UneeqMessageType {
     AvatarAvailable = "AvatarAvailable",
     AvatarUnavailable = "AvatarUnavailable",
     ConnectionLost = "ConnectionLost",
+    ResumeSessionUnavailable = "ResumeSessionUnavailable",
     ServiceUnavailable = "ServiceUnavailable",
     OnlineStatusUpdate = "OnlineStatusUpdate",
     MicActivityNotSupported = "MicActivityNotSupported",
@@ -190,6 +191,13 @@ export declare class ConnectionLostMessage implements UneeqMessage {
     uneeqMessageType: UneeqMessageType;
     constructor(connectionState: PublishSubscribeState);
 }
+/**
+ * Resume Session Unavailable
+ */
+export declare class ResumeSessionUnavailable implements UneeqMessage {
+    uneeqMessageType: UneeqMessageType;
+    constructor();
+}
 /**
  * The avatar's answer to a question
  */

package/dist/src/uneeq.d.ts

@@ -32,6 +32,7 @@ export declare class Uneeq {
     private streamManager;
     private digitalHumanVideoElement;
     private sessionWasResumed;
+    private uneeqLocalStorage;
     constructor(options: UneeqOptions);
     setLoggerEnabled(enabled: boolean): void;
     /**
@@ -151,4 +152,9 @@ export declare class Uneeq {
      */
     private initOnlineStatusUpdateMessages;
     private initPromMetricsListener;
+    /**
+     * Check if resume session functionality is available (localStorage is available)
+     * Warn implementer if unavailable
+     */
+    private checkIfResumeSessionIsAvailable;
 }

package/dist/umd/index.js

@@ -5763,13 +5763,14 @@ 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 voice_input_manager_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__(311);
+const NewSessionRequest_1 = __webpack_require__(312);
 const PublishSubscribeState_1 = __webpack_require__(231);
-const SourceApp_1 = __webpack_require__(312);
-const VoiceInputMode_1 = __webpack_require__(310);
+const SourceApp_1 = __webpack_require__(313);
+const VoiceInputMode_1 = __webpack_require__(311);
 class Uneeq {
     constructor(options) {
         this.ready = new rxjs_1.BehaviorSubject(false);
@@ -5780,6 +5781,7 @@ class Uneeq {
         this.sessionStarted = false; /* Whether the user is live in a session with an avatar (different from sessionPaused) */
         this.unavailableAvatarMsgSent = false;
         this.sessionWasResumed = false;
+        this.uneeqLocalStorage = new uneeq_local_storage_1.UneeqLocalStorage();
         logger_1.logger.enabled = options.logging || false;
         this.options = options;
         this.options.diagnostics = options.diagnostics || false;
@@ -5791,6 +5793,7 @@ class Uneeq {
         this.options.backgroundImageUrl = options.backgroundImageUrl || '';
         this.options.nameTagImageUrl = options.nameTagImageUrl || '';
         this.options.speechToTextLocales = locale_detector_1.LocaleDetector.validateOrDetectSpeechLocales(options);
+        this.checkIfResumeSessionIsAvailable();
         // 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);
@@ -5860,8 +5863,8 @@ class Uneeq {
                     logger_1.logger.log('UneeQ: Session was not resumed.');
                 }
                 // put the session id and persona id into local storage so it can be resumed
-                localStorage.setItem('uneeqResumeSessionId', this.session.id);
-                localStorage.setItem('uneeqResumeSessionPersonaId', this.options.conversationId);
+                this.uneeqLocalStorage.setItemSafely('uneeqResumeSessionId', this.session.id);
+                this.uneeqLocalStorage.setItemSafely('uneeqResumeSessionPersonaId', this.options.conversationId);
                 this.session.sourceApp = SourceApp_1.SourceApp[this.session.sourceApp ? this.session.sourceApp : ''] ?
                     this.session.sourceApp : SourceApp_1.SourceApp.UNKNOWN;
                 this.initialize();
@@ -6180,7 +6183,7 @@ class Uneeq {
                     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');
+                    this.uneeqLocalStorage.removeItemSafely('uneeqResumeSessionId');
                 });
             }
             else {
@@ -6255,6 +6258,17 @@ class Uneeq {
             prom.handleMessage(message.promMsg);
         });
     }
+    /**
+     * Check if resume session functionality is available (localStorage is available)
+     * Warn implementer if unavailable
+     */
+    checkIfResumeSessionIsAvailable() {
+        if (this.options.resumeSession === true && !this.uneeqLocalStorage.available) {
+            console.warn('UneeQ: Resuming session is unavailable in this browser because localStorage is not allowed.');
+            this.messages.next(new MessageTypes_1.ResumeSessionUnavailable());
+            this.options.resumeSession = false;
+        }
+    }
 }
 exports.Uneeq = Uneeq;
 
@@ -18159,7 +18173,7 @@ function zipAll(project) {
 /* 224 */
 /***/ (function(module) {
 
-module.exports = JSON.parse("{\"name\":\"uneeq-js\",\"version\":\"2.46.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\"}}");
+module.exports = JSON.parse("{\"name\":\"uneeq-js\",\"version\":\"2.46.3\",\"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 */
@@ -32428,7 +32442,7 @@ exports.DigitalHumanVideoPlayManager = DigitalHumanVideoPlayManager;
 "use strict";
 
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DigitalHumanUnmuted = exports.DigitalHumanPlayedInMutedModeSuccess = exports.DigitalHumanFailedToPlay = exports.DigitalHumanVideoError = exports.ClientPerformanceMessage = exports.ClientMediaStreamUpdateMessage = exports.OnlineStatusUpdateMessage = exports.SessionInfoMessage = exports.AvatarRequestIgnored = exports.AvatarRequestCompleted = exports.SessionErrorMessage = exports.WebRtcStatsMessage = exports.WebRtcDataMessage = exports.SessionLiveMessage = exports.WarningMessage = exports.RecordingStoppedMessage = exports.RecordingStartedMessage = exports.DevicePermissionAllowedMessage = exports.AvatarTextInputFinishedMessage = exports.FinishedSpeakingMessage = exports.StartedSpeakingMessage = exports.AvatarQuestionMessage = exports.InstructionsMessage = exports.AvatarAnswerContentMessage = exports.AvatarAnswerMessage = exports.ConnectionLostMessage = exports.VoiceActivityInputModeNotSupportedMessage = exports.MicActivityNotSupportedMessage = exports.MicActivityMessage = exports.MicActivityErrorMessage = exports.ServiceUnavailableMessage = exports.AvatarUnavailableMessage = exports.AvatarAvailableMessage = exports.SessionEndedMessage = exports.SessionResumedMessage = exports.SessionPausedMessage = exports.DeviceListUpdatedMessage = exports.DeviceErrorMessage = exports.SetSpeakerSuccessMessage = exports.SetMicSuccessMessage = exports.SetCameraSuccessMessage = exports.DeviceNotFoundErrorMessage = exports.ReadyMessage = exports.UneeqMessageType = void 0;
+exports.DigitalHumanUnmuted = exports.DigitalHumanPlayedInMutedModeSuccess = exports.DigitalHumanFailedToPlay = exports.DigitalHumanVideoError = exports.ClientPerformanceMessage = exports.ClientMediaStreamUpdateMessage = exports.OnlineStatusUpdateMessage = exports.SessionInfoMessage = exports.AvatarRequestIgnored = exports.AvatarRequestCompleted = exports.SessionErrorMessage = exports.WebRtcStatsMessage = exports.WebRtcDataMessage = exports.SessionLiveMessage = exports.WarningMessage = exports.RecordingStoppedMessage = exports.RecordingStartedMessage = exports.DevicePermissionAllowedMessage = exports.AvatarTextInputFinishedMessage = exports.FinishedSpeakingMessage = exports.StartedSpeakingMessage = exports.AvatarQuestionMessage = exports.InstructionsMessage = exports.AvatarAnswerContentMessage = exports.AvatarAnswerMessage = exports.ResumeSessionUnavailable = exports.ConnectionLostMessage = exports.VoiceActivityInputModeNotSupportedMessage = exports.MicActivityNotSupportedMessage = exports.MicActivityMessage = exports.MicActivityErrorMessage = exports.ServiceUnavailableMessage = exports.AvatarUnavailableMessage = exports.AvatarAvailableMessage = exports.SessionEndedMessage = exports.SessionResumedMessage = exports.SessionPausedMessage = exports.DeviceListUpdatedMessage = exports.DeviceErrorMessage = exports.SetSpeakerSuccessMessage = exports.SetMicSuccessMessage = exports.SetCameraSuccessMessage = exports.DeviceNotFoundErrorMessage = exports.ReadyMessage = exports.UneeqMessageType = void 0;
 var UneeqMessageType;
 (function (UneeqMessageType) {
     UneeqMessageType["Ready"] = "Ready";
@@ -32442,6 +32456,7 @@ var UneeqMessageType;
     UneeqMessageType["AvatarAvailable"] = "AvatarAvailable";
     UneeqMessageType["AvatarUnavailable"] = "AvatarUnavailable";
     UneeqMessageType["ConnectionLost"] = "ConnectionLost";
+    UneeqMessageType["ResumeSessionUnavailable"] = "ResumeSessionUnavailable";
     UneeqMessageType["ServiceUnavailable"] = "ServiceUnavailable";
     UneeqMessageType["OnlineStatusUpdate"] = "OnlineStatusUpdate";
     UneeqMessageType["MicActivityNotSupported"] = "MicActivityNotSupported";
@@ -32652,6 +32667,15 @@ class ConnectionLostMessage {
     }
 }
 exports.ConnectionLostMessage = ConnectionLostMessage;
+/**
+ * Resume Session Unavailable
+ */
+class ResumeSessionUnavailable {
+    constructor() {
+        this.uneeqMessageType = UneeqMessageType.ResumeSessionUnavailable;
+    }
+}
+exports.ResumeSessionUnavailable = ResumeSessionUnavailable;
 /**
  * The avatar's answer to a question
  */
@@ -32932,12 +32956,15 @@ class LocaleDetector {
      * @returns a colon separated string of locales (language tags)
      */
     static validateOrDetectSpeechLocales(options) {
-        const localeOptions = options.speechToTextLocales;
-        if (localeOptions && localeOptions.length > 0) {
-            if (!localeOptions.match(this.localesRegEx)) {
-                console.warn(`UneeQ: Potentially invalid value for speechToTextLocales: ${localeOptions}. Please use a BCP-47 language tag with multiple locales separated by colon .e.g 'en-US:ja-JP`);
+        let speechToTextLocales = options.speechToTextLocales;
+        // validate config language locales match regex 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`);
+            }
+            if (speechToTextLocales === 'undefined' || speechToTextLocales === 'null') {
+                speechToTextLocales = this.defaultLocale;
             }
-            return localeOptions;
         }
         // Get the user's language preferences from the browser
         const userLanguages = window.navigator.languages || [window.navigator.language];
@@ -32956,8 +32983,8 @@ class LocaleDetector {
             // If the user's language preferences are empty, default to en-US
             userLanguageLocales = this.defaultLocale;
         }
-        // Return the concatenated language locales string
-        return userLanguageLocales;
+        // Return the concatenated language locales string if config has not supplied any
+        return speechToTextLocales || userLanguageLocales;
     }
 }
 exports.LocaleDetector = LocaleDetector;
@@ -53438,10 +53465,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.');
@@ -53453,7 +53482,7 @@ class ResumeSessionCheck {
             resumeSession = false;
         }
         if (resumeSession) {
-            const resumeSessionId = localStorage.getItem('uneeqResumeSessionId');
+            const resumeSessionId = uneeqLocalStorage.getItemSafely('uneeqResumeSessionId');
             if (resumeSessionId !== null) {
                 return {
                     resumeSession: true,
@@ -53480,6 +53509,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 {
@@ -53540,7 +53626,7 @@ exports.StreamManager = StreamManager;
 
 
 /***/ }),
-/* 308 */
+/* 309 */
 /***/ (function(module, exports, __webpack_require__) {
 
 "use strict";
@@ -53548,9 +53634,9 @@ exports.StreamManager = StreamManager;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VoiceInputManager = void 0;
 const operators_1 = __webpack_require__(126);
-const soundmeter_1 = __webpack_require__(309);
+const soundmeter_1 = __webpack_require__(310);
 const MessageTypes_1 = __webpack_require__(267);
-const VoiceInputMode_1 = __webpack_require__(310);
+const VoiceInputMode_1 = __webpack_require__(311);
 const logger_1 = __webpack_require__(233);
 class VoiceInputManager {
     constructor(options, api, messages, enableMicrophone) {
@@ -53717,7 +53803,7 @@ exports.VoiceInputManager = VoiceInputManager;
 
 
 /***/ }),
-/* 309 */
+/* 310 */
 /***/ (function(module, exports, __webpack_require__) {
 
 "use strict";
@@ -53796,7 +53882,7 @@ exports.SoundMeter = SoundMeter;
 
 
 /***/ }),
-/* 310 */
+/* 311 */
 /***/ (function(module, exports, __webpack_require__) {
 
 "use strict";
@@ -53811,7 +53897,7 @@ var VoiceInputMode;
 
 
 /***/ }),
-/* 311 */
+/* 312 */
 /***/ (function(module, exports, __webpack_require__) {
 
 "use strict";
@@ -53825,7 +53911,7 @@ var SessionType;
 
 
 /***/ }),
-/* 312 */
+/* 313 */
 /***/ (function(module, exports, __webpack_require__) {
 
 "use strict";

package/package.json

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

package/readme.md

@@ -8,6 +8,15 @@ 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.3
+* Fix for sessions to start without localStorage availability.
+
+#### 2.46.2
+* Fix for session starting in incognito browser windows.
+
+#### 2.46.1
+* Tweaking locale detection to better handle null or undefined input
+
 #### 2.46.0
 * Adding automatic detection of speech to text language - If no speechToTextLocales set, we will try to automatically detect a users browser language. If we cannot do that, we will fall back to en-US as the default speech to text language.