[feature] Private mode

.gitignore

@@ -4,3 +4,4 @@ node_modules
 dist
 types
 .rpt2_cache
+.DS_Store

README.md

@@ -135,6 +135,21 @@ interface ICustomerDetailsSectionButtonClick {
 
 The `buttonId` property reflects the `id` specified for the button in the section definition.
 
+#### `private_mode`
+
+Emitted when agent toggles private mode in Chats section. The handler gets the following payload:
+
+```ts
+interface IPrivateMode {
+  threads: {
+    [key: string]: boolean;
+  };
+  source: 'chats';
+}
+```
+
+_String_ key is thread ID and boolean represents state of private mode. True means enabled private mode, false means disabled private mode.
+
 ### Methods
 
 #### `getCustomerProfile(): ICustomerProfile | null`
@@ -170,6 +185,17 @@ widget.modifySection(section);
 
 The `title` of a given section has to match the one specified in the initial state. Otherwise, the section won't change. Also, the Agent App ignores the commands without valid section definitions. Make sure that the definition you're sending is correct.
 
+#### `getPrivateModeState(): IPrivateMode | null`
+
+Gets threads with private mode recorded most recently. Returns the `IPrivateMode` object, which is identical to the one emitted by the `private_mode` event or `null` (if no profile was registered). It may contain information about multiple threads, for example, when widget was initialized after agent has toggled private mode for some threads.
+
+```ts
+{
+  source: 'chats',
+  threads: { R80Q1FDEGX: true, R80Q1HDKP4: true }
+}
+```
+
 ## MessageBox widget (`IMessageBoxWidget`)
 
 ### Events
@@ -182,6 +208,21 @@ Emitted after the widget is opened in the MessageBox. The handler will get a `IC
 
 Emitted after the message is sent by the agent. Keep in mind that the message has to be set with [`putMessage`] method in order to be sent.
 
+#### `private_mode`
+
+Emitted when agent toggles private mode in Chats section. The handler gets the following payload:
+
+```ts
+interface IPrivateMode {
+  threads: {
+    [key: string]: boolean;
+  };
+  source: 'chats';
+}
+```
+
+_String_ key is thread ID and boolean represents state of private mode. True means enabled private mode, false means disabled private mode.
+
 ### Methods
 
 #### `putMessage(msg: IRichMessage | string): Promise<void>`
@@ -206,6 +247,17 @@ widget.putMessage(richMessage);
 
 Gets the customer profile recorded most recently. Returns the `ICustomerProfile` object, which is identical to the one emitted by the `customer_profile` event or `null` (if no profile was registered).
 
+#### `getPrivateModeState(): IPrivateMode | null`
+
+Gets threads with private mode recorded most recently. Returns the `IPrivateMode` object, which is identical to the one emitted by the `private_mode` event or `null` (if no profile was registered). It may contain information about multiple threads, for example, when widget was initialized after agent has toggled private mode for some threads.
+
+```ts
+{
+  source: 'chats',
+  threads: { R80Q1FDEGX: true, R80Q1HDKP4: true }
+}
+```
+
 ### Rich Message object format
 
 - `custom_id`, `properties` and `elements` are optional

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livechat/agent-app-sdk",
-  "version": "1.5.2",
+  "version": "1.6.0",
   "description": "SDK for extending LiveChat's Agent App",
   "license": "MIT",
   "repository": {

src/index.ts

@@ -2,3 +2,4 @@ export * from './widgets/details';
 export * from './widgets/messagebox';
 export * from './widgets/fullscreen';
 export * from './widgets/shared/customer-profile';
+export * from './widgets/shared/private-mode';

src/utils/types.ts

@@ -1 +1,5 @@
 export type Omit<T, K> = Pick<T, Exclude<keyof T, K>>;
+
+export interface KeyMap<T = any> {
+  [key: string]: T;
+}

src/widgets/connection/constants.ts

@@ -0,0 +1,10 @@
+export enum PluginType {
+  MessageBox = 'messagebox',
+  Details = 'details',
+  Fullscreen = 'fullscreen'
+}
+
+export enum PluginMessage {
+  Inited = 'plugin_inited',
+  Loaded = 'plugin_loaded'
+}

src/widgets/details/details-widget.ts

@@ -1,6 +1,7 @@
 import { withAmplitude } from '../shared/amplitude';
 import { withCustomerProfile } from '../shared/customer-profile';
 import { withRichMessages } from '../shared/rich-messages';
+import { withPrivateMode } from '../shared/private-mode';
 import { createWidget } from '../shared/widget';
 import { IConnection, createConnection } from '../connection';
 import assertSection from './custom-sections';
@@ -9,6 +10,7 @@ import {
   IDetailsWidgetApi,
   ISection
 } from './interfaces';
+import { PluginMessage, PluginType } from '../connection/constants';
 
 function DetailsWidget(connection: IConnection<IDetailsWidgetEvents>) {
   const base = createWidget<IDetailsWidgetApi, IDetailsWidgetEvents>(
@@ -21,7 +23,7 @@ function DetailsWidget(connection: IConnection<IDetailsWidgetEvents>) {
         return connection.sendMessage('watch_messages');
       },
       refreshSession(): Promise<void> {
-        return connection.sendMessage('plugin_loaded');
+        return connection.sendMessage(PluginMessage.Loaded);
       },
       modifySection(section: ISection): Promise<void> {
         assertSection(section);
@@ -30,7 +32,9 @@ function DetailsWidget(connection: IConnection<IDetailsWidgetEvents>) {
     }
   );
 
-  const widget = withAmplitude(withRichMessages(withCustomerProfile(base)));
+  const widget = withAmplitude(
+    withRichMessages(withCustomerProfile(withPrivateMode(base)))
+  );
 
   return widget;
 }
@@ -42,7 +46,9 @@ export default function createDetailsWidget(): Promise<IDetailsWidget> {
   return createConnection()
     .then(connection => {
       widget = DetailsWidget(connection);
-      return connection.sendMessage('plugin_inited');
+      return connection.sendMessage(PluginMessage.Inited, {
+        plugin_type: PluginType.Details
+      });
     })
     .then(() => widget);
 }

src/widgets/fullscreen/fullscreen-widget.ts

@@ -2,6 +2,7 @@ import { createWidget } from '../shared/widget';
 import { withAmplitude } from '../shared/amplitude';
 import { IConnection, createConnection } from '../connection';
 import { IFullscreenWidgetApi, IFullscreenWidgetEvents } from './interfaces';
+import { PluginMessage, PluginType } from '../connection/constants';
 
 function FullscreenWidget(connection: IConnection<IFullscreenWidgetEvents>) {
   const base = createWidget<IFullscreenWidgetApi, IFullscreenWidgetEvents>(
@@ -22,7 +23,13 @@ export interface IFullscreenWidget
   extends ReturnType<typeof FullscreenWidget> {}
 
 export default function createFullscreenWidget(): Promise<IFullscreenWidget> {
-  return createConnection<IFullscreenWidgetEvents>().then(connection =>
-    FullscreenWidget(connection)
-  );
+  let widget: IFullscreenWidget;
+  return createConnection<IFullscreenWidgetEvents>()
+    .then(connection => {
+      widget = FullscreenWidget(connection);
+      connection.sendMessage(PluginMessage.Inited, {
+        plugin_type: PluginType.Fullscreen
+      });
+    })
+    .then(() => widget);
 }

src/widgets/messagebox/messagebox-widget.ts

@@ -1,13 +1,15 @@
 import { createWidget } from '../shared/widget';
 import { withAmplitude } from '../shared/amplitude';
 import { withCustomerProfile } from '../shared/customer-profile';
+import { withPrivateMode } from '../shared/private-mode';
 import { withRichMessages } from '../shared/rich-messages';
 import { IConnection, createConnection } from '../connection';
 import {
   IMessageBoxWidgetApi,
   IMessageBoxWidgetEvents,
   IRichMessage
 } from './interfaces';
+import { PluginType, PluginMessage } from '../connection/constants';
 
 function MessageBoxWidget(connection: IConnection<IMessageBoxWidgetEvents>) {
   const base = createWidget<IMessageBoxWidgetApi, IMessageBoxWidgetEvents>(
@@ -25,7 +27,9 @@ function MessageBoxWidget(connection: IConnection<IMessageBoxWidgetEvents>) {
     }
   );
 
-  const widget = withAmplitude(withRichMessages(withCustomerProfile(base)));
+  const widget = withAmplitude(
+    withRichMessages(withCustomerProfile(withPrivateMode(base)))
+  );
 
   return widget;
 }
@@ -34,7 +38,13 @@ export interface IMessageBoxWidget
   extends ReturnType<typeof MessageBoxWidget> {}
 
 export default function createMessageBoxWidget(): Promise<IMessageBoxWidget> {
-  return createConnection<IMessageBoxWidgetEvents>().then(connection =>
-    MessageBoxWidget(connection)
-  );
+  let widget: IMessageBoxWidget;
+  return createConnection<IMessageBoxWidgetEvents>().then(connection => {
+    widget = MessageBoxWidget(connection);
+    return connection
+      .sendMessage(PluginMessage.Inited, {
+        plugin_type: PluginType.MessageBox
+      })
+      .then(() => widget);
+  });
 }

src/widgets/shared/private-mode.ts

@@ -0,0 +1,35 @@
+import { KeyMap } from '../../utils/types';
+import { WidgetMixin, Widget, AnyWidgetApi } from './widget';
+
+export interface IPrivateMode {
+  threads: KeyMap<boolean>;
+  source: 'chats';
+}
+
+export interface IPrivateModeApi {
+  getPrivateModeState(): IPrivateMode | null;
+}
+
+export interface IPrivateModeEvents {
+  private_mode: IPrivateMode;
+}
+
+export const withPrivateMode: WidgetMixin<
+  IPrivateModeApi,
+  IPrivateModeEvents
+> = widget => {
+  let threads = null;
+
+  function onPrivateMode(privateMode: IPrivateMode) {
+    threads = { ...threads, ...privateMode.threads };
+  }
+
+  widget.on('private_mode', onPrivateMode);
+
+  return {
+    ...widget,
+    getPrivateModeState(): IPrivateMode | null {
+      return { source: 'chats', threads };
+    }
+  };
+};