adding custom task ringtones, disable task ringtone, and removing loc…

…al storage check for login popups (#860) * adding custom task ringtones, disable task ringtone, and removing local storage check for login popups --------- Co-authored-by: Brett McStotts <[email protected]>
amazon-connect · Mar 29, 2024 · ae2a7c0 · ae2a7c0
1 parent f769093
commit ae2a7c0
Show file tree

Hide file tree

Showing 12 changed files with 149 additions and 90 deletions.
diff --git a/Documentation.md b/Documentation.md
@@ -16,6 +16,14 @@ In version 1.x, we also support `make` for legacy builds. This option was remove
 
 # Important Announcements
 
+1. March 2024 - In response to a Google Chrome feature launched on 7/13/2023 called [Storage Partitioning](https://developers.google.com/privacy-sandbox/3pcd/storage-partitioning), we made a short term fix on 2/10/2024 to adjust our mute functionality and synchronize the mute state across all CCPs. However, due to current limitations, this change required us to disable muting while being on hold. As a workaround, agents should mute themselves on the call before going on hold. We are planning to address this issue by August 2024 and revert back to original mute behavior.
+    * At the moment, the following APIs will fail when the contact is on hold:
+      * `voiceConnection.muteParticipant()`
+      * `voiceConnection.unmuteParticipant()`
+      * `agent.mute()`
+      * `agent.unmute()`
+    * As a workaround, you can mute the call prior to placing the call on hold.
+
 1. December 2022 - In addition to the CCP, customers can now embed an application that provides guided experiences to your agents using the connect.agentApp. See the [updated documentation](https://github.com/amazon-connect/amazon-connect-streams/blob/master/Documentation.md#initialization-for-ccp-customer-profiles-amazon-q-connect-and-customviews) for details on usage.
    - ### Guided experiences for agents
      - With Amazon Connect you can now create guided step-by-step experiences that walk agents through tailored views that focus on what must be seen or done by the agent at a given moment during an interaction. You can design workflows for various types of customer interactions and present agents with different step-by-step guides based on context, such as call queue, customer information, and interactive voice response (IVR). This feature is available in the Connect agent workspace as well as an embeddable application that can be embedded into another website via the Streams API. For more information, visit the AWS website: https://aws.amazon.com/connect/agent-workspace/

diff --git a/README.md b/README.md
@@ -18,6 +18,13 @@ Run `npm run release` to generate new release files. Full instructions for build
 In version 1.x, we also support `make` for legacy builds. This option was removed in version 2.x. 
 
 # Important Announcements
+1. March 2024 - In response to a Google Chrome feature launched on 7/13/2023 called [Storage Partitioning](https://developers.google.com/privacy-sandbox/3pcd/storage-partitioning), we made a short term fix on 2/10/2024 to adjust our mute functionality and synchronize the mute state across all CCPs. However, due to current limitations, this change required us to disable muting while being on hold. As a workaround, agents should mute themselves on the call before going on hold. We are planning to address this issue by August 2024 and revert back to original mute behavior.
+    * At the moment, the following APIs will fail when the contact is on hold:
+      * `voiceConnection.muteParticipant()`
+      * `voiceConnection.unmuteParticipant()`
+      * `agent.mute()`
+      * `agent.unmute()`
+    * As a workaround, you can mute the call prior to placing the call on hold.
 1. December 2022 - In addition to the CCP, customers can now embed an application that provides guided experiences to your agents using the connect.agentApp. See the [updated documentation](https://github.com/amazon-connect/amazon-connect-streams/blob/master/Documentation.md#initialization-for-ccp-customer-profiles-amazon-q-connect-and-customviews) for details on usage. 
     * ### Guided experiences for agents
       + With Amazon Connect you can now create guided step-by-step experiences that walk agents through tailored views that focus on what must be seen or done by the agent at a given moment during an interaction. You can design workflows for various types of customer interactions and present agents with different step-by-step guides based on context, such as call queue, customer information, and interactive voice response (IVR). This feature is available in the Connect agent workspace as well as an embeddable application that can be embedded into another website via the Streams API. For more information, visit the AWS website: https://aws.amazon.com/connect/agent-workspace/
@@ -199,6 +206,10 @@ everything setup correctly and that you will be able to listen for events.
             allowFramedVideoCall: true,    // optional, default to false
             allowEarlyGum: true    //optional, default to true
           },
+          task: {
+            disableRingtone: false, // optional, defaults to false
+            ringtoneUrl: "[your-ringtone-filepath].mp3", // optional, defaults to CCP's default ringtone if a falsy value is set
+          },
           pageOptions: { //optional
             enableAudioDeviceSettings: false, //optional, defaults to 'false'
             enableVideoDeviceSettings: false, //optional, defaults to 'false'

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "amazon-connect-streams",
-  "version": "2.14.0",
+  "version": "2.14.1",
   "description": "Amazon Connect Streams Library",
   "engines": {
     "node": ">=12.0.0"

diff --git a/release/connect-streams-dr-min.js b/release/connect-streams-dr-min.js
diff --git a/release/connect-streams-dr.js b/release/connect-streams-dr.js
diff --git a/release/connect-streams-min.js b/release/connect-streams-min.js
diff --git a/release/connect-streams.js b/release/connect-streams.js
@@ -26891,7 +26891,7 @@ AWS.apiLoader.services['connect']['2017-02-15'] = require('../apis/connect-2017-
 
   connect.core = {};
   connect.core.initialized = false;
-  connect.version = "2.14.0";
+  connect.version = "2.14.1";
   connect.outerContextStreamsVersion = null;
   connect.DEFAULT_BATCH_SIZE = 500;
 
@@ -27454,19 +27454,31 @@ AWS.apiLoader.services['connect']['2017-02-15'] = require('../apis/connect-2017-
           params.ringtone.chat.ringtoneUrl = otherParams.chat.ringtoneUrl;
         }
       }
-
+
+      if (otherParams.task) {
+        if (otherParams.task.disableRingtone) {
+          params.ringtone.task.disabled = true;
+        }
+
+        if (otherParams.task.ringtoneUrl) {
+          params.ringtone.task.ringtoneUrl = otherParams.task.ringtoneUrl;
+        }
+      }
+
       // Merge in ringtone settings from downstream.
       if (otherParams.ringtone) {
         params.ringtone.voice = connect.merge(params.ringtone.voice,
           otherParams.ringtone.voice || {});
         params.ringtone.queue_callback = connect.merge(params.ringtone.queue_callback,
           otherParams.ringtone.voice || {});
         params.ringtone.chat = connect.merge(params.ringtone.chat,
-          otherParams.ringtone.chat || {});
+            otherParams.ringtone.chat || {});
+        params.ringtone.task = connect.merge(params.ringtone.task,
+            otherParams.ringtone.task || {});
       }
     };
- 
-    // Merge params from params.softphone and params.chat into params.ringtone
+
+    // Merge params from params.softphone and params.chat and params.task into params.ringtone
     // for embedded and non-embedded use cases so that defaults are picked up.
     mergeParams(params, params);
 
@@ -28229,12 +28241,13 @@ AWS.apiLoader.services['connect']['2017-02-15'] = require('../apis/connect-2017-
         connect.core.masterClient = new connect.UpstreamConduitMasterClient(conduit);
         connect.core.portStreamId = data.id;
 
-        if (params.softphone || params.chat || params.pageOptions || params.shouldAddNamespaceToLogs || params.disasterRecoveryOn) {
+        if (params.softphone || params.chat || params.task || params.pageOptions || params.shouldAddNamespaceToLogs || params.disasterRecoveryOn) {
           // Send configuration up to the CCP.
           //set it to false if secondary
           conduit.sendUpstream(connect.EventType.CONFIGURE, {
             softphone: params.softphone,
             chat: params.chat,
+            task: params.task,
             pageOptions: params.pageOptions,
             shouldAddNamespaceToLogs: params.shouldAddNamespaceToLogs,
             disasterRecoveryOn: params.disasterRecoveryOn,
@@ -28316,10 +28329,6 @@ AWS.apiLoader.services['connect']['2017-02-15'] = require('../apis/connect-2017-
           try {
             var loginUrl = getLoginUrl(params);
             connect.getLog().warn("ACK_TIMEOUT occurred, attempting to pop the login page if not already open.").sendInternalLogToServer();
-            // clear out last opened timestamp for SAML authentication when there is ACK_TIMEOUT
-            if (params.loginUrl) {
-              connect.core.getPopupManager().clear(connect.MasterTopics.LOGIN_POPUP);
-            }
             connect.core.loginWindow = connect.core.getPopupManager().open(loginUrl, connect.MasterTopics.LOGIN_POPUP, params.loginOptions);
           } catch (e) {
             connect.getLog().error("ACK_TIMEOUT occurred but we are unable to open the login popup.").withException(e).sendInternalLogToServer();
@@ -28332,7 +28341,6 @@ AWS.apiLoader.services['connect']['2017-02-15'] = require('../apis/connect-2017-
               this.unsubscribe();
               global.clearTimeout(connect.core.iframeRefreshTimeout);
               connect.core.iframeRefreshTimeout = null;
-              connect.core.getPopupManager().clear(connect.MasterTopics.LOGIN_POPUP);
               if ((params.loginPopupAutoClose || (params.loginOptions && params.loginOptions.autoClose)) && connect.core.loginWindow) {
                 connect.core.loginWindow.close();
                 connect.core.loginWindow = null;
@@ -33986,28 +33994,23 @@ AWS.apiLoader.services['connect']['2017-02-15'] = require('../apis/connect-2017-
   connect.PopupManager = function () { };
 
   connect.PopupManager.prototype.open = function (url, name, options) {
-    var then = this._getLastOpenedTimestamp(name);
-    var now = new Date().getTime();
     var win = null;
-    if (now - then > ONE_DAY_MILLIS) {
-      if (options) {
-        // default values are chosen to provide a minimum height without scrolling
-        // and a uniform margin based on the css of the ccp login page
-        var height = options.height || DEFAULT_POPUP_HEIGHT;
-        var width = options.width || DEFAULT_POPUP_WIDTH;
-        var top = options.top || 0;
-        var left = options.left || 0;
-        win = window.open('', name, "width="+width+", height="+height+", top="+top+", left="+left);
-        if (win.location !== url) {
-          win = window.open(url, name, "width="+width+", height="+height+", top="+top+", left="+left);
-        }
-      } else {
-        win = window.open('', name);
-        if (win.location !== url) {
-          win = window.open(url, name);
-        }
+    if (options) {
+      // default values are chosen to provide a minimum height without scrolling
+      // and a uniform margin based on the css of the ccp login page
+      var height = options.height || DEFAULT_POPUP_HEIGHT;
+      var width = options.width || DEFAULT_POPUP_WIDTH;
+      var top = options.top || 0;
+      var left = options.left || 0;
+      win = window.open('', name, "width="+width+", height="+height+", top="+top+", left="+left);
+      if (win.location !== url) {
+        win = window.open(url, name, "width="+width+", height="+height+", top="+top+", left="+left);
+      }
+    } else {
+      win = window.open('', name);
+      if (win.location !== url) {
+        win = window.open(url, name);
       }
-      this._setLastOpenedTimestamp(name, now);
     }
     return win;
   };

diff --git a/src/core.js b/src/core.js
@@ -574,19 +574,31 @@
           params.ringtone.chat.ringtoneUrl = otherParams.chat.ringtoneUrl;
         }
       }
-
+
+      if (otherParams.task) {
+        if (otherParams.task.disableRingtone) {
+          params.ringtone.task.disabled = true;
+        }
+
+        if (otherParams.task.ringtoneUrl) {
+          params.ringtone.task.ringtoneUrl = otherParams.task.ringtoneUrl;
+        }
+      }
+
       // Merge in ringtone settings from downstream.
       if (otherParams.ringtone) {
         params.ringtone.voice = connect.merge(params.ringtone.voice,
           otherParams.ringtone.voice || {});
         params.ringtone.queue_callback = connect.merge(params.ringtone.queue_callback,
           otherParams.ringtone.voice || {});
         params.ringtone.chat = connect.merge(params.ringtone.chat,
-          otherParams.ringtone.chat || {});
+            otherParams.ringtone.chat || {});
+        params.ringtone.task = connect.merge(params.ringtone.task,
+            otherParams.ringtone.task || {});
       }
     };
- 
-    // Merge params from params.softphone and params.chat into params.ringtone
+
+    // Merge params from params.softphone and params.chat and params.task into params.ringtone
     // for embedded and non-embedded use cases so that defaults are picked up.
     mergeParams(params, params);
 
@@ -1349,12 +1361,13 @@
         connect.core.masterClient = new connect.UpstreamConduitMasterClient(conduit);
         connect.core.portStreamId = data.id;
 
-        if (params.softphone || params.chat || params.pageOptions || params.shouldAddNamespaceToLogs || params.disasterRecoveryOn) {
+        if (params.softphone || params.chat || params.task || params.pageOptions || params.shouldAddNamespaceToLogs || params.disasterRecoveryOn) {
           // Send configuration up to the CCP.
           //set it to false if secondary
           conduit.sendUpstream(connect.EventType.CONFIGURE, {
             softphone: params.softphone,
             chat: params.chat,
+            task: params.task,
             pageOptions: params.pageOptions,
             shouldAddNamespaceToLogs: params.shouldAddNamespaceToLogs,
             disasterRecoveryOn: params.disasterRecoveryOn,
@@ -1436,10 +1449,6 @@
           try {
             var loginUrl = getLoginUrl(params);
             connect.getLog().warn("ACK_TIMEOUT occurred, attempting to pop the login page if not already open.").sendInternalLogToServer();
-            // clear out last opened timestamp for SAML authentication when there is ACK_TIMEOUT
-            if (params.loginUrl) {
-              connect.core.getPopupManager().clear(connect.MasterTopics.LOGIN_POPUP);
-            }
             connect.core.loginWindow = connect.core.getPopupManager().open(loginUrl, connect.MasterTopics.LOGIN_POPUP, params.loginOptions);
           } catch (e) {
             connect.getLog().error("ACK_TIMEOUT occurred but we are unable to open the login popup.").withException(e).sendInternalLogToServer();
@@ -1452,7 +1461,6 @@
               this.unsubscribe();
               global.clearTimeout(connect.core.iframeRefreshTimeout);
               connect.core.iframeRefreshTimeout = null;
-              connect.core.getPopupManager().clear(connect.MasterTopics.LOGIN_POPUP);
               if ((params.loginPopupAutoClose || (params.loginOptions && params.loginOptions.autoClose)) && connect.core.loginWindow) {
                 connect.core.loginWindow.close();
                 connect.core.loginWindow = null;

diff --git a/src/index.d.ts b/src/index.d.ts
@@ -441,6 +441,14 @@ declare namespace connect {
     readonly ringtoneUrl?: string;
   }
 
+  interface TaskOptions {
+    /** This option allows you to completely disable the built-in ringtone audio that is played when a task is incoming. */
+    readonly disableRingtone?: boolean;
+
+    /** If the ringtone is not disabled, this allows for overriding the ringtone with any browser-supported audio file accessible by the user. */
+    readonly ringtoneUrl?: string;
+  }
+
   interface LoginOptions {
     /*
     * Whether to auto close the login prompt.
@@ -526,6 +534,9 @@ declare namespace connect {
     /** Allows you to specify ringtone settings for Chat. */
     readonly chat?: ChatOptions;
 
+    /** Allows you to specify ringtone settings for Task. */
+    readonly task?: TaskOptions;
+
     /**
      * Allows you to customize the title attribute of the CCP iframe.
      * @example "Contact Control Panel"

diff --git a/src/util.js b/src/util.js
@@ -560,28 +560,23 @@
   connect.PopupManager = function () { };
 
   connect.PopupManager.prototype.open = function (url, name, options) {
-    var then = this._getLastOpenedTimestamp(name);
-    var now = new Date().getTime();
     var win = null;
-    if (now - then > ONE_DAY_MILLIS) {
-      if (options) {
-        // default values are chosen to provide a minimum height without scrolling
-        // and a uniform margin based on the css of the ccp login page
-        var height = options.height || DEFAULT_POPUP_HEIGHT;
-        var width = options.width || DEFAULT_POPUP_WIDTH;
-        var top = options.top || 0;
-        var left = options.left || 0;
-        win = window.open('', name, "width="+width+", height="+height+", top="+top+", left="+left);
-        if (win.location !== url) {
-          win = window.open(url, name, "width="+width+", height="+height+", top="+top+", left="+left);
-        }
-      } else {
-        win = window.open('', name);
-        if (win.location !== url) {
-          win = window.open(url, name);
-        }
+    if (options) {
+      // default values are chosen to provide a minimum height without scrolling
+      // and a uniform margin based on the css of the ccp login page
+      var height = options.height || DEFAULT_POPUP_HEIGHT;
+      var width = options.width || DEFAULT_POPUP_WIDTH;
+      var top = options.top || 0;
+      var left = options.left || 0;
+      win = window.open('', name, "width="+width+", height="+height+", top="+top+", left="+left);
+      if (win.location !== url) {
+        win = window.open(url, name, "width="+width+", height="+height+", top="+top+", left="+left);
+      }
+    } else {
+      win = window.open('', name);
+      if (win.location !== url) {
+        win = window.open(url, name);
       }
-      this._setLastOpenedTimestamp(name, now);
     }
     return win;
   };