uneeq-js 2.42.3 → 2.44.0

package/dist/src/service/resume-session-check.d.ts

@@ -0,0 +1,6 @@
+import { ResumeSessionCheckResponse } from '../types/ResumeSessionCheckResponse';
+import { UneeqOptions } from '../types/UneeqOptions';
+export declare class ResumeSessionCheck {
+    static validate(options: UneeqOptions): ResumeSessionCheckResponse;
+    static browserTabIsActive(): boolean;
+}

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

@@ -290,8 +290,9 @@ export declare class WarningMessage implements UneeqMessage {
  */
 export declare class SessionLiveMessage implements UneeqMessage {
     readonly showLogo: boolean;
+    readonly sessionResumed: boolean;
     uneeqMessageType: UneeqMessageType;
-    constructor(showLogo: boolean);
+    constructor(showLogo: boolean, sessionResumed: boolean);
 }
 /**
  * WebRTC data channel message

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

@@ -6,6 +6,7 @@ export interface NewSessionRequest {
     tokenId?: string;
     clientWidth?: number;
     clientHeight?: number;
+    resumeSessionId?: string;
 }
 interface NewSessionCustomData {
     additionalProp1: string;

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

@@ -1,3 +1,6 @@
 export interface PersonaStartRequest {
     enableTransparentBackground?: boolean;
+    resumeSession?: boolean;
+    backgroundImageUrl?: string;
+    nameTagImageUrl?: string;
 }

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

@@ -0,0 +1,4 @@
+export interface ResumeSessionCheckResponse {
+    resumeSession: boolean;
+    resumeSessionId?: string;
+}

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

@@ -53,4 +53,16 @@ export interface UneeqOptions {
      * This option specifies what the default voice input mode will be.
      */
     voiceInputMode: VoiceInputMode | string;
+    /**
+     * Resume user session if available.
+     */
+    resumeSession?: boolean;
+    /**
+     * This option specifies the URL of the background image to be used when the digital human is rendered.
+     */
+    backgroundImageUrl?: string;
+    /**
+     * This option specifies the URL of the name tag image to be used when the digital human is rendered.
+     */
+    nameTagImageUrl?: string;
 }

package/dist/src/uneeq.d.ts

@@ -26,6 +26,7 @@ export declare class Uneeq {
     private startSessionTime;
     private availableResponseTime;
     private streamManager;
+    private sessionWasResumed;
     constructor(options: UneeqOptions);
     setLoggerEnabled(enabled: boolean): void;
     /**

package/dist/umd/index.js

@@ -5761,13 +5761,14 @@ const messaging_1 = __webpack_require__(280);
 const metrics_service_1 = __webpack_require__(302);
 const online_status_service_1 = __webpack_require__(304);
 const prom_1 = __webpack_require__(269);
-const stream_manager_1 = __webpack_require__(305);
-const voice_input_manager_1 = __webpack_require__(306);
+const resume_session_check_1 = __webpack_require__(305);
+const stream_manager_1 = __webpack_require__(306);
+const voice_input_manager_1 = __webpack_require__(307);
 const MessageTypes_1 = __webpack_require__(267);
-const NewSessionRequest_1 = __webpack_require__(309);
+const NewSessionRequest_1 = __webpack_require__(310);
 const PublishSubscribeState_1 = __webpack_require__(231);
-const SourceApp_1 = __webpack_require__(310);
-const VoiceInputMode_1 = __webpack_require__(308);
+const SourceApp_1 = __webpack_require__(311);
+const VoiceInputMode_1 = __webpack_require__(309);
 class Uneeq {
     constructor(options) {
         this.ready = new rxjs_1.BehaviorSubject(false);
@@ -5777,6 +5778,7 @@ class Uneeq {
         this.sessionPaused = false;
         this.sessionStarted = false; /* Whether the user is live in a session with an avatar (different from sessionPaused) */
         this.unavailableAvatarMsgSent = false;
+        this.sessionWasResumed = false;
         logger_1.logger.enabled = options.logging || false;
         this.options = options;
         this.options.diagnostics = options.diagnostics || false;
@@ -5785,6 +5787,8 @@ class Uneeq {
         this.options.sendLocalAudio = options.sendLocalAudio === undefined ? true : options.sendLocalAudio;
         this.options.enableClientPerformanceMessage = options.enableClientPerformanceMessage || false;
         this.options.enableTransparentBackground = options.enableTransparentBackground || false;
+        this.options.backgroundImageUrl = options.backgroundImageUrl || '';
+        this.options.nameTagImageUrl = options.nameTagImageUrl || '';
         // 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);
@@ -5829,9 +5833,23 @@ class Uneeq {
         return __awaiter(this, void 0, void 0, function* () {
             this.startSessionTime = Date.now();
             try {
+                const resumeSessionCheck = resume_session_check_1.ResumeSessionCheck.validate(this.options);
+                if (resumeSessionCheck.resumeSession === true) {
+                    this.startSessionData.resumeSessionId = resumeSessionCheck.resumeSessionId;
+                }
                 this.startSessionData.tokenId = tokenId;
                 this.session = yield this.api.startSessionWithToken(this.startSessionData);
                 console.log('UneeQ Session ID: ' + this.session.id);
+                if (this.session.id === this.startSessionData.resumeSessionId) {
+                    logger_1.logger.log('UneeQ: Session was resumed.');
+                    this.sessionWasResumed = true;
+                }
+                else {
+                    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.session.sourceApp = SourceApp_1.SourceApp[this.session.sourceApp ? this.session.sourceApp : ''] ?
                     this.session.sourceApp : SourceApp_1.SourceApp.UNKNOWN;
                 this.initialize();
@@ -6077,7 +6095,7 @@ class Uneeq {
     sessionLiveHandler() {
         // Send the SessionLive message and play welcome (optional)
         if (!this.sessionStarted) {
-            this.messages.next(new MessageTypes_1.SessionLiveMessage(this.session.showUneeqLogo || false));
+            this.messages.next(new MessageTypes_1.SessionLiveMessage(this.session.showUneeqLogo || false, this.sessionWasResumed));
             if (this.options.playWelcome) {
                 this.api.avatarWelcome();
             }
@@ -6132,7 +6150,15 @@ class Uneeq {
                 };
                 this.internalMessages$.next({ faceMeMessageType: 'prom', promMsg: availabilityChkMetric });
                 this.messages.next(new MessageTypes_1.AvatarAvailableMessage());
-                this.api.avatarStart({ enableTransparentBackground: this.options.enableTransparentBackground });
+                this.api.avatarStart({
+                    enableTransparentBackground: this.options.enableTransparentBackground,
+                    resumeSession: this.sessionWasResumed,
+                    backgroundImageUrl: this.options.backgroundImageUrl,
+                    nameTagImageUrl: this.options.nameTagImageUrl
+                }).catch((err) => {
+                    console.error('UneeQ: Digital human could not be started. Clearing resumeSession token and ending process.', err);
+                    localStorage.removeItem('uneeqResumeSessionId');
+                });
             }
             else {
                 if (!this.unavailableAvatarMsgSent) {
@@ -18110,7 +18136,7 @@ function zipAll(project) {
 /* 224 */
 /***/ (function(module) {
 
-module.exports = JSON.parse("{\"name\":\"uneeq-js\",\"version\":\"2.42.3\",\"description\":\"\",\"main\":\"dist/index.js\",\"types\":\"dist/src/index.d.ts\",\"scripts\":{\"start\":\"npx webpack -w\",\"test-local\":\"./node_modules/karma/bin/karma start karma.conf.js -logLevel=DEBUG\",\"test\":\"./node_modules/karma/bin/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\":\"./node_modules/tslint/bin/tslint -p tsconfig.json --fix\",\"docs\":\"./node_modules/typedoc/bin/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.44.0\",\"description\":\"\",\"main\":\"dist/index.js\",\"types\":\"dist/src/index.d.ts\",\"scripts\":{\"start\":\"npx webpack -w\",\"test-local\":\"./node_modules/karma/bin/karma start karma.conf.js -logLevel=DEBUG\",\"test\":\"./node_modules/karma/bin/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\":\"./node_modules/tslint/bin/tslint -p tsconfig.json --fix\",\"docs\":\"./node_modules/typedoc/bin/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 */
@@ -32723,8 +32749,9 @@ exports.WarningMessage = WarningMessage;
  * Session is Live, avatar video is active
  */
 class SessionLiveMessage {
-    constructor(showLogo) {
+    constructor(showLogo, sessionResumed) {
         this.showLogo = showLogo;
+        this.sessionResumed = sessionResumed;
         this.uneeqMessageType = UneeqMessageType.SessionLive;
     }
 }
@@ -53303,6 +53330,51 @@ exports.OnlineStatusService = OnlineStatusService;
 
 "use strict";
 
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResumeSessionCheck = void 0;
+const logger_1 = __webpack_require__(233);
+class ResumeSessionCheck {
+    static validate(options) {
+        let resumeSession = options.resumeSession !== undefined ? options.resumeSession : false;
+        const resumeSessionPersonaId = localStorage.getItem('uneeqResumeSessionPersonaId');
+        const resumingSamePersona = resumeSessionPersonaId === options.conversationId;
+        if (!resumingSamePersona) {
+            logger_1.logger.log('UneeQ: Persona Id\'s do not match, unable to resume session.');
+            resumeSession = false;
+        }
+        const tabIsActive = ResumeSessionCheck.browserTabIsActive();
+        if (resumeSession && !tabIsActive) {
+            logger_1.logger.log('UneeQ: Browser tab is not active so unable to resume');
+            resumeSession = false;
+        }
+        if (resumeSession) {
+            const resumeSessionId = localStorage.getItem('uneeqResumeSessionId');
+            if (resumeSessionId !== null) {
+                return {
+                    resumeSession: true,
+                    resumeSessionId: resumeSessionId
+                };
+            }
+        }
+        return {
+            resumeSession: false
+        };
+    }
+    // Set this up as a method to make the class more testable.
+    // You cannot easily mock document.hidden as it is readonly.
+    static browserTabIsActive() {
+        return !document.hidden;
+    }
+}
+exports.ResumeSessionCheck = ResumeSessionCheck;
+
+
+/***/ }),
+/* 306 */
+/***/ (function(module, exports, __webpack_require__) {
+
+"use strict";
+
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.StreamManager = void 0;
 class StreamManager {
@@ -53417,7 +53489,7 @@ StreamManager.audioData = 'data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAAPAAADTG
 
 
 /***/ }),
-/* 306 */
+/* 307 */
 /***/ (function(module, exports, __webpack_require__) {
 
 "use strict";
@@ -53425,9 +53497,9 @@ StreamManager.audioData = 'data:audio/mpeg;base64,SUQzBAAAAAAAI1RTU0UAAAAPAAADTG
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VoiceInputManager = void 0;
 const operators_1 = __webpack_require__(126);
-const soundmeter_1 = __webpack_require__(307);
+const soundmeter_1 = __webpack_require__(308);
 const MessageTypes_1 = __webpack_require__(267);
-const VoiceInputMode_1 = __webpack_require__(308);
+const VoiceInputMode_1 = __webpack_require__(309);
 const logger_1 = __webpack_require__(233);
 class VoiceInputManager {
     constructor(options, api, messages, enableMicrophone) {
@@ -53600,7 +53672,7 @@ exports.VoiceInputManager = VoiceInputManager;
 
 
 /***/ }),
-/* 307 */
+/* 308 */
 /***/ (function(module, exports, __webpack_require__) {
 
 "use strict";
@@ -53679,7 +53751,7 @@ exports.SoundMeter = SoundMeter;
 
 
 /***/ }),
-/* 308 */
+/* 309 */
 /***/ (function(module, exports, __webpack_require__) {
 
 "use strict";
@@ -53694,7 +53766,7 @@ var VoiceInputMode;
 
 
 /***/ }),
-/* 309 */
+/* 310 */
 /***/ (function(module, exports, __webpack_require__) {
 
 "use strict";
@@ -53708,7 +53780,7 @@ var SessionType;
 
 
 /***/ }),
-/* 310 */
+/* 311 */
 /***/ (function(module, exports, __webpack_require__) {
 
 "use strict";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uneeq-js",
-  "version": "2.42.3",
+  "version": "2.44.0",
   "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.44.0
+* Added beta support for session resume.
+
+#### 2.43.0
+* Adding support for setting a background image and name tag image when starting a session using new fields in UneeqOptions. Url restrictions apply, please reach out to the Customer Service team.
+
 #### 2.42.3
 * Fixed issue that caused voiceActivity input not to work when using autoStart