@webex/internal-plugin-ai-assistant 3.11.0 → 3.12.0

package/package.json

@@ -20,10 +20,10 @@
     ]
   },
   "dependencies": {
-    "@webex/common": "3.11.0",
-    "@webex/common-timers": "3.11.0",
-    "@webex/internal-plugin-mercury": "3.11.0",
-    "@webex/webex-core": "3.11.0",
+    "@webex/common": "3.12.0",
+    "@webex/common-timers": "3.12.0",
+    "@webex/internal-plugin-mercury": "3.12.0",
+    "@webex/webex-core": "3.12.0",
     "lodash": "^4.17.21",
     "uuid": "^3.3.2"
   },
@@ -33,9 +33,9 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.11.0",
-    "@webex/test-helper-mock-webex": "3.11.0",
-    "@webex/test-helper-test-users": "3.11.0",
+    "@webex/test-helper-chai": "3.12.0",
+    "@webex/test-helper-mock-webex": "3.12.0",
+    "@webex/test-helper-test-users": "3.12.0",
     "eslint": "^8.24.0",
     "prettier": "^2.7.1",
     "sinon": "^9.2.4"
@@ -49,5 +49,5 @@
     "test:style": "eslint ./src/**/*.*",
     "test:unit": "webex-legacy-tools test --unit --runner jest"
   },
-  "version": "3.11.0"
+  "version": "3.12.0"
 }

package/src/ai-assistant.ts

@@ -22,12 +22,15 @@ import {
   AI_ASSISTANT_UNREGISTERED,
   AI_ASSISTANT_SERVICE_NAME,
   ASSISTANT_API_RESPONSE_EVENT,
+  ASSISTANT_API_ACTIVITY,
   ACTION_TYPES,
   CONTENT_TYPES,
   CONTEXT_RESOURCE_TYPES,
   RESPONSE_NAMES,
+  AI_ASSISTANT_ACTIVITY_RECEIVED,
 } from './constants';
 import {
+  decryptAssistantActivity,
   decryptCitedAnswer,
   decryptMessage,
   decryptScheduleMeeting,
@@ -105,10 +108,10 @@ const AIAssistant = WebexPlugin.extend({
 
     this.stopListeningForEvents();
 
-    return this.webex.internal.mercury.disconnect().then(() => {
-      this.trigger(AI_ASSISTANT_UNREGISTERED);
-      this.registered = false;
-    });
+    this.trigger(AI_ASSISTANT_UNREGISTERED);
+    this.registered = false;
+
+    return Promise.resolve();
   },
 
   /**
@@ -120,6 +123,10 @@ const AIAssistant = WebexPlugin.extend({
     this.webex.internal.mercury.on(ASSISTANT_API_RESPONSE_EVENT, (envelope) => {
       this._handleEvent(envelope.data);
     });
+
+    this.webex.internal.mercury.on(ASSISTANT_API_ACTIVITY, (envelope) => {
+      this._handleAssistantActivity(envelope.data);
+    });
   },
 
   /**
@@ -129,6 +136,7 @@ const AIAssistant = WebexPlugin.extend({
    */
   stopListeningForEvents() {
     this.webex.internal.mercury.off(ASSISTANT_API_RESPONSE_EVENT);
+    this.webex.internal.mercury.off(ASSISTANT_API_ACTIVITY);
   },
 
   /**
@@ -160,6 +168,17 @@ const AIAssistant = WebexPlugin.extend({
     this.trigger(this._getResultEventName(data.clientRequestId), data);
   },
 
+  /**
+   * Handles an incoming activity event from the assistant API and triggers the correct event for consumers to listen to
+   * @param {Object} data the event data
+   * @returns {undefined}
+   */
+  async _handleAssistantActivity(data) {
+    await decryptAssistantActivity(data.activity, this.webex);
+
+    this.trigger(AI_ASSISTANT_ACTIVITY_RECEIVED, data);
+  },
+
   /**
    * Decrypts the response content in place
    * @param {any} responseContent the content object from the assistant-api response
@@ -206,7 +225,7 @@ const AIAssistant = WebexPlugin.extend({
    * @returns {Promise<Object>} Resolves with an object containing the requestId, sessionId and streamEventName
    */
   _request(options: RequestOptions): Promise<RequestResponse> {
-    const {resource, params} = options;
+    const {resource, params, headers} = options;
 
     const timeout = this.config.requestTimeout;
     const requestId = options.requestId || uuid.v4();
@@ -266,6 +285,7 @@ const AIAssistant = WebexPlugin.extend({
           method: 'POST',
           contentType: 'application/json',
           body: {clientRequestId: requestId, ...params},
+          headers,
         })
         .then(({body}) => {
           resolve({...body, requestId, streamEventName});
@@ -291,6 +311,7 @@ const AIAssistant = WebexPlugin.extend({
    * @param {Object} options.locale optional locale to use for the request, defaults to 'en_US'
    * @param {string} options.requestId optional request ID to use for this request, if not provided a new UUID will be generated
    * @param {string} options.entryPoint optional entryPoint to use for this request
+   * @param {string} options.renderProtocolVersion optional render protocol version to use for this request
    * @returns {Promise<Object>} Resolves with an object containing the requestId, sessionId and streamEventName
    * @public
    * @memberof AIAssistant
@@ -318,6 +339,12 @@ const AIAssistant = WebexPlugin.extend({
       content.parameters = options.parameters;
     }
 
+    const headers = {};
+
+    if (options.renderProtocolVersion) {
+      headers['AI-Assistant-Render-Protocol'] = options.renderProtocolVersion;
+    }
+
     return this._request({
       resource: options.sessionId ? `sessions/${options.sessionId}/messages` : 'sessions/messages',
       params: {
@@ -328,6 +355,7 @@ const AIAssistant = WebexPlugin.extend({
         ...(options.assistant ? {assistant: options.assistant} : {}),
       },
       ...(options.requestId ? {requestId: options.requestId} : {}),
+      headers,
     });
   },
 

package/src/constants.ts

@@ -1,8 +1,10 @@
 export const AI_ASSISTANT_REGISTERED = 'aiassistant:registered';
 export const AI_ASSISTANT_UNREGISTERED = 'aiassistant:unregistered';
 export const ASSISTANT_API_RESPONSE_EVENT = 'event:assistant-api.response';
+export const ASSISTANT_API_ACTIVITY = 'assistant-api.activity';
 export const AI_ASSISTANT_SERVICE_NAME = 'assistant-api';
 export const AI_ASSISTANT_RESULT = 'aiassistant:result';
+export const AI_ASSISTANT_ACTIVITY_RECEIVED = 'aiassistant:activityReceived';
 export const AI_ASSISTANT_STREAM = 'aiassistant:stream';
 
 export enum AI_ASSISTANT_ERRORS {

package/src/types.ts

@@ -23,6 +23,7 @@ export interface RequestOptions {
   notFoundPath?: string;
   params?: Record<string, unknown>;
   requestId?: string;
+  headers?: Record<string, string>;
 }
 
 export interface ContextResource {
@@ -52,4 +53,5 @@ export interface AiAssistantRequestOptions {
   locale?: string;
   requestId?: string;
   entryPoint?: string;
+  renderProtocolVersion?: string;
 }

package/src/utils.ts

@@ -29,6 +29,14 @@ export const decryptCitedAnswer = async (data, webex) => {
     );
   }
 
+  if (data.value.sources) {
+    await Promise.all(
+      data.value.sources.map((source, index) => {
+        return decryptInPlace(data, `value.sources.${index}.name`, 'encryptionKeyUrl', webex);
+      })
+    );
+  }
+
   await decryptInPlace(data, 'value.value', 'encryptionKeyUrl', webex);
 };
 export const decryptScheduleMeeting = async (data, webex) => {
@@ -68,3 +76,7 @@ export const decryptMessage = async (data, webex) => {
 export const decryptWorkspace = async (data, webex) => {
   await decryptInPlace(data, 'value.value', 'encryptionKeyUrl', webex);
 };
+
+export const decryptAssistantActivity = async (data, webex) => {
+  await decryptInPlace(data, 'content.value.message', 'encryptionKeyUrl', webex);
+};

package/test/unit/data/messages.ts

@@ -295,8 +295,7 @@ export const workspaceResponse = [
         type: 'json',
         encryptionKeyUrl: 'workspace_0_encryption_key_url',
         value: {
-          value:
-            'workspace_0_encrypted_value',
+          value: 'workspace_0_encrypted_value',
           type: 'markdown',
         },
       },
@@ -328,8 +327,7 @@ export const workspaceResponse = [
         type: 'json',
         encryptionKeyUrl: 'workspace_1_encryption_key_url',
         value: {
-          value:
-            'workspace_1_encrypted_value',
+          value: 'workspace_1_encrypted_value',
           type: 'markdown',
         },
       },
@@ -361,8 +359,7 @@ export const workspaceResponse = [
         type: 'json',
         encryptionKeyUrl: 'workspace_2_encryption_key_url',
         value: {
-          value:
-            'workspace_2_encrypted_value',
+          value: 'workspace_2_encrypted_value',
           type: 'markdown',
         },
       },
@@ -394,8 +391,7 @@ export const workspaceResponse = [
         type: 'json',
         encryptionKeyUrl: 'workspace_3_encryption_key_url',
         value: {
-          value:
-            'workspace_3_encrypted_value',
+          value: 'workspace_3_encrypted_value',
           type: 'markdown',
         },
       },
@@ -427,8 +423,7 @@ export const workspaceResponse = [
         type: 'json',
         encryptionKeyUrl: 'workspace_4_encryption_key_url',
         value: {
-          value:
-            'workspace_4_encrypted_value',
+          value: 'workspace_4_encrypted_value',
           type: 'markdown',
         },
       },
@@ -460,8 +455,7 @@ export const workspaceResponse = [
         type: 'json',
         encryptionKeyUrl: 'workspace_5_encryption_key_url',
         value: {
-          value:
-            'workspace_5_encrypted_value',
+          value: 'workspace_5_encrypted_value',
           type: 'markdown',
         },
       },
@@ -493,8 +487,7 @@ export const workspaceResponse = [
         type: 'json',
         encryptionKeyUrl: 'workspace_6_encryption_key_url',
         value: {
-          value:
-            'workspace_6_encrypted_value',
+          value: 'workspace_6_encrypted_value',
           type: 'markdown',
         },
       },
@@ -526,8 +519,7 @@ export const workspaceResponse = [
         type: 'json',
         encryptionKeyUrl: 'workspace_7_encryption_key_url',
         value: {
-          value:
-            'workspace_7_encrypted_value',
+          value: 'workspace_7_encrypted_value',
           type: 'markdown',
         },
       },
@@ -559,8 +551,7 @@ export const workspaceResponse = [
         type: 'json',
         encryptionKeyUrl: 'workspace_8_encryption_key_url',
         value: {
-          value:
-            'workspace_8_encrypted_value',
+          value: 'workspace_8_encrypted_value',
           type: 'markdown',
         },
       },
@@ -592,8 +583,7 @@ export const workspaceResponse = [
         type: 'json',
         encryptionKeyUrl: 'workspace_9_encryption_key_url',
         value: {
-          value:
-            'workspace_9_encrypted_value',
+          value: 'workspace_9_encrypted_value',
           type: 'markdown',
         },
       },
@@ -717,4 +707,115 @@ export const scheduleMeetingResponse = [
       creator: {role: 'assistant'},
     },
   },
-];
+];
+
+export const citedAnswerWithSourcesResponse = [
+  {
+    eventType: 'assistant-api.response',
+    sequence: 1,
+    finished: true,
+    clientRequestId: 'test-request-id',
+    responseId: '3c1a4b30-92fe-11f0-8e9f-1bafc66fbbc5',
+    responseType: 'response',
+    response: {
+      sessionId: '3c1939c0-92fe-11f0-8e9f-1bafc66fbbc5',
+      sessionUrl:
+        'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/3c1939c0-92fe-11f0-8e9f-1bafc66fbbc5',
+      messageId: '3c19fd10-92fe-11f0-8e9f-1bafc66fbbc5',
+      messageUrl:
+        'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/3c1939c0-92fe-11f0-8e9f-1bafc66fbbc5/messages/3c19fd10-92fe-11f0-8e9f-1bafc66fbbc5',
+      responseId: '3c1a4b30-92fe-11f0-8e9f-1bafc66fbbc5',
+      responseUrl:
+        'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/3c1939c0-92fe-11f0-8e9f-1bafc66fbbc5/messages/3c1a4b30-92fe-11f0-8e9f-1bafc66fbbc5',
+      content: {
+        name: 'cited_answer',
+        type: 'json',
+        encryptionKeyUrl: 'kms://kms-us.wbx2.com/keys/9565506d-78b1-4742-b0fd-63719748282e',
+        value: {
+          value: 'json_1_encrypted_value',
+          type: 'markdown',
+          citations: [
+            {
+              id: '6ccc8286e2084e05a6b9a29faae77095',
+              index: 1,
+              name: 'json_1_encrypted_citation_0',
+              url: 'https://co.webex.com/webappng/sites/co/recording/playback/6ccc8286e2084e05a6b9a29faae77095',
+              metadata: {
+                provider: 'webex',
+                type: 'meeting_recording',
+              },
+            },
+          ],
+          sources: [
+            {
+              id: '6ccc8286e2084e05a6b9a29faae77096',
+              index: 1,
+              type: 'post_meeting',
+              name: 'json_1_encrypted_source_0',
+              metadata: {
+                meetingContainerId: 'mccc8286e2084e05a6b9a29faae77096',
+              },
+            },
+            {
+              id: '6ccc8286e2084e05a6b9a29faae77096',
+              index: 2,
+              type: 'post_call',
+              name: 'json_1_encrypted_source_1',
+              metadata: {
+                callContainerId: 'mccc8286e2084e05a6b9a29faae77096',
+              },
+            },
+            {
+              id: '6ccc8286e2084e05a6b9a29faae77096',
+              index: 3,
+              type: 'message',
+              name: 'json_1_encrypted_source_2',
+              metadata: {
+                spaceId: 'mccc8286e2084e05a6b9a29faae77096',
+              },
+            },
+          ],
+        },
+      },
+      createdAt: '2025-09-16T13:08:30.594220705Z',
+      creator: {
+        role: 'assistant',
+      },
+    },
+  },
+];
+
+export const assistantActivity = [
+  {
+    eventType: 'assistant-api.activity',
+    sequence: 1,
+    finished: true,
+    clientRequestId: '',
+    responseId: '267533f0-566b-11f0-88f7-9bd287b85bcb',
+    responseType: 'activity',
+    activity: {
+      sessionId: '05779da0-566b-11f0-913c-035e874e536f',
+      sessionUrl:
+        'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/05779da0-566b-11f0-913c-035e874e536f',
+      messageId: '2674e5d0-566b-11f0-88f7-9bd287b85bcb',
+      messageUrl:
+        'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/05779da0-566b-11f0-913c-035e874e536f/messages/2674e5d0-566b-11f0-88f7-9bd287b85bcb',
+      responseId: '267533f0-566b-11f0-88f7-9bd287b85bcb',
+      responseUrl:
+        'https://assistant-api-a.wbx2.com:443/assistant-api/api/v1/sessions/05779da0-566b-11f0-913c-035e874e536f/messages/267533f0-566b-11f0-88f7-9bd287b85bcb',
+      content: {
+        type: 'json',
+        name: 'alert_create_poll',
+        value: {
+          pollType: 'poll',
+          message: 'message_encrypted_value_for_activity',
+        },
+      },
+      encryptionKeyUrl: 'kms://kms-cisco.wbx2.com/keys/9b838423-f31b-49d5-a7c7-182572340a37',
+      createdAt: '2025-07-01T11:04:27.082430261Z',
+      creator: {
+        role: 'assistant',
+      },
+    },
+  },
+];