@microsoft/agents-copilotstudio-client 0.6.1 → 0.6.16-gc874f0c9d8

package/dist/src/copilotStudioClient.d.ts

@@ -4,6 +4,10 @@
  */
 import { ConnectionSettings } from './connectionSettings';
 import { Activity } from '@microsoft/agents-activity';
+/**
+ * Client for interacting with Microsoft Copilot Studio services.
+ * Provides functionality to start conversations and send messages to Copilot Studio bots.
+ */
 export declare class CopilotStudioClient {
     /** Header key for conversation ID. */
     private static readonly conversationIdHeaderKey;
@@ -15,11 +19,11 @@ export declare class CopilotStudioClient {
     private readonly settings;
     /** The Axios instance used for HTTP requests. */
     private readonly client;
-    /** The logger for debugging. */
-    private readonly logger;
     /**
-     * Returns the Scope URL needed to connect to Copilot Studio from the Connection Settings.
-     * @param settings Copilot Studio Connection Settings.
+     * Returns the scope URL needed to connect to Copilot Studio from the connection settings.
+     * This is used for authentication token audience configuration.
+     * @param settings Copilot Studio connection settings.
+     * @returns The scope URL for token audience.
      */
     static scopeFromSettings: (settings: ConnectionSettings) => string;
     /**

package/dist/src/copilotStudioClient.js

@@ -12,9 +12,14 @@ const axios_1 = __importDefault(require("axios"));
 const powerPlatformEnvironment_1 = require("./powerPlatformEnvironment");
 const agents_activity_1 = require("@microsoft/agents-activity");
 const executeTurnRequest_1 = require("./executeTurnRequest");
-const debug_1 = __importDefault(require("debug"));
-const package_json_1 = __importDefault(require("@microsoft/agents-copilotstudio-client/package.json"));
+const logger_1 = require("@microsoft/agents-activity/logger");
+const package_json_1 = require("../package.json");
 const os_1 = __importDefault(require("os"));
+const logger = (0, logger_1.debug)('copilot-studio:client');
+/**
+ * Client for interacting with Microsoft Copilot Studio services.
+ * Provides functionality to start conversations and send messages to Copilot Studio bots.
+ */
 class CopilotStudioClient {
     /**
      * Creates an instance of CopilotStudioClient.
@@ -28,39 +33,39 @@ class CopilotStudioClient {
         this.client = axios_1.default.create();
         this.client.defaults.headers.common.Authorization = `Bearer ${token}`;
         this.client.defaults.headers.common['User-Agent'] = CopilotStudioClient.getProductInfo();
-        this.logger = (0, debug_1.default)('copilot-studio-client');
     }
     async postRequestAsync(axiosConfig) {
         var _a, _b, _c, _d;
         const activities = [];
-        this.logger(`>>> SEND TO ${axiosConfig.url}`);
+        logger.debug(`>>> SEND TO ${axiosConfig.url}`);
         const response = await this.client(axiosConfig);
         if (this.settings.useExperimentalEndpoint && !((_a = this.settings.directConnectUrl) === null || _a === void 0 ? void 0 : _a.trim())) {
             const islandExperimentalUrl = (_b = response.headers) === null || _b === void 0 ? void 0 : _b[CopilotStudioClient.islandExperimentalUrlHeaderKey];
             if (islandExperimentalUrl) {
                 this.settings.directConnectUrl = islandExperimentalUrl;
-                this.logger(`Island Experimental URL: ${islandExperimentalUrl}`);
+                logger.debug(`Island Experimental URL: ${islandExperimentalUrl}`);
             }
         }
         this.conversationId = (_d = (_c = response.headers) === null || _c === void 0 ? void 0 : _c[CopilotStudioClient.conversationIdHeaderKey]) !== null && _d !== void 0 ? _d : '';
         if (this.conversationId) {
-            this.logger(`Conversation ID: ${this.conversationId}`);
+            logger.debug(`Conversation ID: ${this.conversationId}`);
         }
-        this.logger('=====================================================');
-        this.logger(`Headers: ${JSON.stringify(response.headers, null, 2)}`);
-        this.logger('=====================================================');
+        const sanitizedHeaders = { ...response.headers };
+        delete sanitizedHeaders['Authorization'];
+        delete sanitizedHeaders[CopilotStudioClient.conversationIdHeaderKey];
+        logger.debug('Headers received:', sanitizedHeaders);
         const stream = response.data;
         const reader = stream.pipeThrough(new TextDecoderStream()).getReader();
         let result = '';
         const results = [];
         const processEvents = async ({ done, value }) => {
             if (done) {
-                this.logger('Stream complete');
+                logger.debug('Stream complete');
                 result += value;
                 results.push(result);
                 return results;
             }
-            this.logger('Agent is typing...');
+            logger.info('Agent is typing ...');
             result += value;
             return await processEvents(await reader.read());
         };
@@ -77,15 +82,15 @@ class CopilotStudioClient {
                         if (!this.conversationId.trim()) {
                             // Did not get it from the header.
                             this.conversationId = (_b = (_a = act.conversation) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : '';
-                            this.logger(`Conversation ID: ${this.conversationId}`);
+                            logger.debug(`Conversation ID: ${this.conversationId}`);
                         }
                     }
                     else {
-                        this.logger('Activity type: ', act.type);
+                        logger.debug(`Activity type: ${act.type}`);
                     }
                 }
                 catch (e) {
-                    this.logger('Error: ', e);
+                    logger.error('Error: ', e);
                     throw e;
                 }
             });
@@ -99,11 +104,16 @@ class CopilotStudioClient {
      * @returns A string containing the product information, including version and user agent.
      */
     static getProductInfo() {
-        const version = `CopilotStudioClient.agents-sdk-js/${package_json_1.default.version}`;
+        const versionString = `CopilotStudioClient.agents-sdk-js/${package_json_1.version}`;
+        let userAgent;
         if (typeof window !== 'undefined' && window.navigator) {
-            return `${version} ${navigator.userAgent}`;
+            userAgent = `${versionString} ${navigator.userAgent}`;
+        }
+        else {
+            userAgent = `${versionString} nodejs/${process.version} ${os_1.default.platform()}-${os_1.default.arch()}/${os_1.default.release()}`;
         }
-        return `${version} nodejs/${process.version} ${os_1.default.platform()}-${os_1.default.arch()}/${os_1.default.release()}`;
+        logger.debug(`User-Agent: ${userAgent}`);
+        return userAgent;
     }
     /**
      * Starts a new conversation with the Copilot Studio service.
@@ -111,6 +121,7 @@ class CopilotStudioClient {
      * @returns A promise that resolves to the initial activity of the conversation.
      */
     async startConversationAsync(emitStartConversationEvent = true) {
+        var _a;
         const uriStart = (0, powerPlatformEnvironment_1.getCopilotStudioConnectionUrl)(this.settings);
         const body = { emitStartConversationEvent };
         const config = {
@@ -124,8 +135,10 @@ class CopilotStudioClient {
             responseType: 'stream',
             adapter: 'fetch'
         };
+        logger.info('Starting conversation ...');
         const values = await this.postRequestAsync(config);
         const act = values[0];
+        logger.info(`Conversation '${(_a = act.conversation) === null || _a === void 0 ? void 0 : _a.id}' started. Received ${values.length} activities.`, values);
         return act;
     }
     /**
@@ -159,7 +172,9 @@ class CopilotStudioClient {
             responseType: 'stream',
             adapter: 'fetch'
         };
+        logger.info(`Asking question: ${question} ...`);
         const values = await this.postRequestAsync(config);
+        logger.info(`Received ${values.length} activities.`, values);
         return values;
     }
 }
@@ -169,8 +184,10 @@ CopilotStudioClient.conversationIdHeaderKey = 'x-ms-conversationid';
 /** Island Header key */
 CopilotStudioClient.islandExperimentalUrlHeaderKey = 'x-ms-d2e-experimental';
 /**
- * Returns the Scope URL needed to connect to Copilot Studio from the Connection Settings.
- * @param settings Copilot Studio Connection Settings.
+ * Returns the scope URL needed to connect to Copilot Studio from the connection settings.
+ * This is used for authentication token audience configuration.
+ * @param settings Copilot Studio connection settings.
+ * @returns The scope URL for token audience.
  */
 CopilotStudioClient.scopeFromSettings = powerPlatformEnvironment_1.getTokenAudience;
 //# sourceMappingURL=copilotStudioClient.js.map

package/dist/src/copilotStudioClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"copilotStudioClient.js","sourceRoot":"","sources":["../../src/copilotStudioClient.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAGH,kDAAgE;AAChE,yEAA4F;AAC5F,gEAAyF;AACzF,6DAAyD;AACzD,kDAA6C;AAC7C,uGAAuE;AACvE,4CAAmB;AAOnB,MAAa,mBAAmB;IAqB9B;;;;OAIG;IACH,YAAa,QAA4B,EAAE,KAAa;QApBxD,0CAA0C;QAClC,mBAAc,GAAW,EAAE,CAAA;QAoBjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,MAAM,EAAE,CAAA;QAC5B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAA;QACrE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,mBAAmB,CAAC,cAAc,EAAE,CAAA;QACxF,IAAI,CAAC,MAAM,GAAG,IAAA,eAAW,EAAC,uBAAuB,CAAC,CAAA;IACpD,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAE,WAA+B;;QAC7D,MAAM,UAAU,GAAe,EAAE,CAAA;QAEjC,IAAI,CAAC,MAAM,CAAC,eAAe,WAAW,CAAC,GAAG,EAAE,CAAC,CAAA;QAE7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;QAE/C,IAAI,IAAI,CAAC,QAAQ,CAAC,uBAAuB,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,QAAQ,CAAC,gBAAgB,0CAAE,IAAI,EAAE,CAAA,EAAE,CAAC;YACrF,MAAM,qBAAqB,GAAG,MAAA,QAAQ,CAAC,OAAO,0CAAG,mBAAmB,CAAC,8BAA8B,CAAC,CAAA;YACpG,IAAI,qBAAqB,EAAE,CAAC;gBAC1B,IAAI,CAAC,QAAQ,CAAC,gBAAgB,GAAG,qBAAqB,CAAA;gBACtD,IAAI,CAAC,MAAM,CAAC,4BAA4B,qBAAqB,EAAE,CAAC,CAAA;YAClE,CAAC;QACH,CAAC;QAED,IAAI,CAAC,cAAc,GAAG,MAAA,MAAA,QAAQ,CAAC,OAAO,0CAAG,mBAAmB,CAAC,uBAAuB,CAAC,mCAAI,EAAE,CAAA;QAC3F,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,oBAAoB,IAAI,CAAC,cAAc,EAAE,CAAC,CAAA;QACxD,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,uDAAuD,CAAC,CAAA;QACpE,IAAI,CAAC,MAAM,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;QACpE,IAAI,CAAC,MAAM,CAAC,uDAAuD,CAAC,CAAA;QAEpE,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAA;QAC5B,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,iBAAiB,EAAE,CAAC,CAAC,SAAS,EAAE,CAAA;QACtE,IAAI,MAAM,GAAW,EAAE,CAAA;QACvB,MAAM,OAAO,GAAa,EAAE,CAAA;QAE5B,MAAM,aAAa,GAAG,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAc,EAAqB,EAAE;YAC7E,IAAI,IAAI,EAAE,CAAC;gBACT,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAA;gBAC9B,MAAM,IAAI,KAAK,CAAA;gBACf,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBACpB,OAAO,OAAO,CAAA;YAChB,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAA;YACjC,MAAM,IAAI,KAAK,CAAA;YAEf,OAAO,MAAM,aAAa,CAAC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,CAAA;QACjD,CAAC,CAAA;QAED,MAAM,MAAM,GAAa,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QAEhE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACrB,MAAM,MAAM,GAAa,KAAK,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACrD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,IAAI,CAAC,KAAK,aAAa,CAAC,CAAA;YAC3F,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;;gBACvB,IAAI,CAAC;oBACH,MAAM,GAAG,GAAG,0BAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA;oBACzD,IAAI,GAAG,CAAC,IAAI,KAAK,+BAAa,CAAC,OAAO,EAAE,CAAC;wBACvC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;wBACpB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC;4BAChC,kCAAkC;4BAClC,IAAI,CAAC,cAAc,GAAG,MAAA,MAAA,GAAG,CAAC,YAAY,0CAAE,EAAE,mCAAI,EAAE,CAAA;4BAChD,IAAI,CAAC,MAAM,CAAC,oBAAoB,IAAI,CAAC,cAAc,EAAE,CAAC,CAAA;wBACxD,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,MAAM,CAAC,iBAAiB,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;oBAC1C,CAAC;gBACH,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAA;oBACzB,MAAM,CAAC,CAAA;gBACT,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QACF,OAAO,UAAU,CAAA;IACnB,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,cAAc;QAC3B,MAAM,OAAO,GAAG,qCAAqC,sBAAK,CAAC,OAAO,EAAE,CAAA;QAEpE,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACtD,OAAO,GAAG,OAAO,IAAI,SAAS,CAAC,SAAS,EAAE,CAAA;QAC5C,CAAC;QAED,OAAO,GAAG,OAAO,WAAW,OAAO,CAAC,OAAO,IAAI,YAAE,CAAC,QAAQ,EAAE,IAAI,YAAE,CAAC,IAAI,EAAE,IAAI,YAAE,CAAC,OAAO,EAAE,EAAE,CAAA;IAC7F,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,sBAAsB,CAAE,6BAAsC,IAAI;QAC7E,MAAM,QAAQ,GAAW,IAAA,wDAA6B,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACrE,MAAM,IAAI,GAAG,EAAE,0BAA0B,EAAE,CAAA;QAE3C,MAAM,MAAM,GAAuB;YACjC,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,QAAQ;YACb,OAAO,EAAE;gBACP,MAAM,EAAE,mBAAmB;gBAC3B,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI;YACV,YAAY,EAAE,QAAQ;YACtB,OAAO,EAAE,OAAO;SACjB,CAAA;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;QAClD,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;QACrB,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,gBAAgB,CAAE,QAAgB,EAAE,iBAAyB,IAAI,CAAC,cAAc;;QAC3F,MAAM,mBAAmB,GAAwB;YAC/C,EAAE,EAAE,cAAc;SACnB,CAAA;QACD,MAAM,WAAW,GAAG;YAClB,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,mBAAmB;SAClC,CAAA;QACD,MAAM,QAAQ,GAAG,0BAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;QAEjD,MAAM,mBAAmB,GAAG,MAAA,MAAA,QAAQ,CAAC,YAAY,0CAAE,EAAE,mCAAI,cAAc,CAAA;QACvE,MAAM,UAAU,GAAG,IAAA,wDAA6B,EAAC,IAAI,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAA;QACpF,MAAM,KAAK,GAAuB,IAAI,uCAAkB,CAAC,QAAQ,CAAC,CAAA;QAElE,MAAM,MAAM,GAAuB;YACjC,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,UAAU;YACf,OAAO,EAAE;gBACP,MAAM,EAAE,mBAAmB;gBAC3B,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,KAAK;YACX,YAAY,EAAE,QAAQ;YACtB,OAAO,EAAE,OAAO;SACjB,CAAA;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;QAClD,OAAO,MAAM,CAAA;IACf,CAAC;;AAnLH,kDAoLC;AAnLC,sCAAsC;AACd,2CAAuB,GAAW,qBAAqB,AAAhC,CAAgC;AAC/E,wBAAwB;AACA,kDAA8B,GAAW,uBAAuB,AAAlC,CAAkC;AAWxF;;;GAGG;AACI,qCAAiB,GAA6C,2CAAgB,AAA7D,CAA6D"}
+{"version":3,"file":"copilotStudioClient.js","sourceRoot":"","sources":["../../src/copilotStudioClient.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAGH,kDAAgE;AAChE,yEAA4F;AAC5F,gEAAyF;AACzF,6DAAyD;AACzD,8DAAyD;AACzD,kDAAyC;AACzC,4CAAmB;AAEnB,MAAM,MAAM,GAAG,IAAA,cAAK,EAAC,uBAAuB,CAAC,CAAA;AAO7C;;;GAGG;AACH,MAAa,mBAAmB;IAqB9B;;;;OAIG;IACH,YAAa,QAA4B,EAAE,KAAa;QApBxD,0CAA0C;QAClC,mBAAc,GAAW,EAAE,CAAA;QAoBjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,MAAM,GAAG,eAAK,CAAC,MAAM,EAAE,CAAA;QAC5B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,GAAG,UAAU,KAAK,EAAE,CAAA;QACrE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,mBAAmB,CAAC,cAAc,EAAE,CAAA;IAC1F,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAE,WAA+B;;QAC7D,MAAM,UAAU,GAAe,EAAE,CAAA;QAEjC,MAAM,CAAC,KAAK,CAAC,eAAe,WAAW,CAAC,GAAG,EAAE,CAAC,CAAA;QAE9C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;QAE/C,IAAI,IAAI,CAAC,QAAQ,CAAC,uBAAuB,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,QAAQ,CAAC,gBAAgB,0CAAE,IAAI,EAAE,CAAA,EAAE,CAAC;YACrF,MAAM,qBAAqB,GAAG,MAAA,QAAQ,CAAC,OAAO,0CAAG,mBAAmB,CAAC,8BAA8B,CAAC,CAAA;YACpG,IAAI,qBAAqB,EAAE,CAAC;gBAC1B,IAAI,CAAC,QAAQ,CAAC,gBAAgB,GAAG,qBAAqB,CAAA;gBACtD,MAAM,CAAC,KAAK,CAAC,4BAA4B,qBAAqB,EAAE,CAAC,CAAA;YACnE,CAAC;QACH,CAAC;QAED,IAAI,CAAC,cAAc,GAAG,MAAA,MAAA,QAAQ,CAAC,OAAO,0CAAG,mBAAmB,CAAC,uBAAuB,CAAC,mCAAI,EAAE,CAAA;QAC3F,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,CAAC,KAAK,CAAC,oBAAoB,IAAI,CAAC,cAAc,EAAE,CAAC,CAAA;QACzD,CAAC;QAED,MAAM,gBAAgB,GAAG,EAAE,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAA;QAChD,OAAO,gBAAgB,CAAC,eAAe,CAAC,CAAA;QACxC,OAAO,gBAAgB,CAAC,mBAAmB,CAAC,uBAAuB,CAAC,CAAA;QACpE,MAAM,CAAC,KAAK,CAAC,mBAAmB,EAAE,gBAAgB,CAAC,CAAA;QAEnD,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAA;QAC5B,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,iBAAiB,EAAE,CAAC,CAAC,SAAS,EAAE,CAAA;QACtE,IAAI,MAAM,GAAW,EAAE,CAAA;QACvB,MAAM,OAAO,GAAa,EAAE,CAAA;QAE5B,MAAM,aAAa,GAAG,KAAK,EAAE,EAAE,IAAI,EAAE,KAAK,EAAc,EAAqB,EAAE;YAC7E,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAA;gBAC/B,MAAM,IAAI,KAAK,CAAA;gBACf,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBACpB,OAAO,OAAO,CAAA;YAChB,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;YAClC,MAAM,IAAI,KAAK,CAAA;YAEf,OAAO,MAAM,aAAa,CAAC,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,CAAA;QACjD,CAAC,CAAA;QAED,MAAM,MAAM,GAAa,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;QAEhE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACrB,MAAM,MAAM,GAAa,KAAK,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YACrD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,IAAI,CAAC,KAAK,aAAa,CAAC,CAAA;YAC3F,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;;gBACvB,IAAI,CAAC;oBACH,MAAM,GAAG,GAAG,0BAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA;oBACzD,IAAI,GAAG,CAAC,IAAI,KAAK,+BAAa,CAAC,OAAO,EAAE,CAAC;wBACvC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;wBACpB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC;4BAChC,kCAAkC;4BAClC,IAAI,CAAC,cAAc,GAAG,MAAA,MAAA,GAAG,CAAC,YAAY,0CAAE,EAAE,mCAAI,EAAE,CAAA;4BAChD,MAAM,CAAC,KAAK,CAAC,oBAAoB,IAAI,CAAC,cAAc,EAAE,CAAC,CAAA;wBACzD,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,KAAK,CAAC,kBAAkB,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;oBAC5C,CAAC;gBACH,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAA;oBAC1B,MAAM,CAAC,CAAA;gBACT,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QACF,OAAO,UAAU,CAAA;IACnB,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,cAAc;QAC3B,MAAM,aAAa,GAAG,qCAAqC,sBAAO,EAAE,CAAA;QACpE,IAAI,SAAiB,CAAA;QAErB,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACtD,SAAS,GAAG,GAAG,aAAa,IAAI,SAAS,CAAC,SAAS,EAAE,CAAA;QACvD,CAAC;aAAM,CAAC;YACN,SAAS,GAAG,GAAG,aAAa,WAAW,OAAO,CAAC,OAAO,IAAI,YAAE,CAAC,QAAQ,EAAE,IAAI,YAAE,CAAC,IAAI,EAAE,IAAI,YAAE,CAAC,OAAO,EAAE,EAAE,CAAA;QACxG,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,eAAe,SAAS,EAAE,CAAC,CAAA;QACxC,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,sBAAsB,CAAE,6BAAsC,IAAI;;QAC7E,MAAM,QAAQ,GAAW,IAAA,wDAA6B,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACrE,MAAM,IAAI,GAAG,EAAE,0BAA0B,EAAE,CAAA;QAE3C,MAAM,MAAM,GAAuB;YACjC,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,QAAQ;YACb,OAAO,EAAE;gBACP,MAAM,EAAE,mBAAmB;gBAC3B,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,IAAI;YACV,YAAY,EAAE,QAAQ;YACtB,OAAO,EAAE,OAAO;SACjB,CAAA;QAED,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAA;QACxC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;QAClD,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;QACrB,MAAM,CAAC,IAAI,CAAC,iBAAiB,MAAA,GAAG,CAAC,YAAY,0CAAE,EAAE,uBAAuB,MAAM,CAAC,MAAM,cAAc,EAAE,MAAM,CAAC,CAAA;QAC5G,OAAO,GAAG,CAAA;IACZ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,gBAAgB,CAAE,QAAgB,EAAE,iBAAyB,IAAI,CAAC,cAAc;;QAC3F,MAAM,mBAAmB,GAAwB;YAC/C,EAAE,EAAE,cAAc;SACnB,CAAA;QACD,MAAM,WAAW,GAAG;YAClB,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,QAAQ;YACd,YAAY,EAAE,mBAAmB;SAClC,CAAA;QACD,MAAM,QAAQ,GAAG,0BAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;QAEjD,MAAM,mBAAmB,GAAG,MAAA,MAAA,QAAQ,CAAC,YAAY,0CAAE,EAAE,mCAAI,cAAc,CAAA;QACvE,MAAM,UAAU,GAAG,IAAA,wDAA6B,EAAC,IAAI,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAA;QACpF,MAAM,KAAK,GAAuB,IAAI,uCAAkB,CAAC,QAAQ,CAAC,CAAA;QAElE,MAAM,MAAM,GAAuB;YACjC,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,UAAU;YACf,OAAO,EAAE;gBACP,MAAM,EAAE,mBAAmB;gBAC3B,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,KAAK;YACX,YAAY,EAAE,QAAQ;YACtB,OAAO,EAAE,OAAO;SACjB,CAAA;QACD,MAAM,CAAC,IAAI,CAAC,oBAAoB,QAAQ,MAAM,CAAC,CAAA;QAC/C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;QAClD,MAAM,CAAC,IAAI,CAAC,YAAY,MAAM,CAAC,MAAM,cAAc,EAAE,MAAM,CAAC,CAAA;QAC5D,OAAO,MAAM,CAAA;IACf,CAAC;;AA3LH,kDA4LC;AA3LC,sCAAsC;AACd,2CAAuB,GAAW,qBAAqB,AAAhC,CAAgC;AAC/E,wBAAwB;AACA,kDAA8B,GAAW,uBAAuB,AAAlC,CAAkC;AASxF;;;;;GAKG;AACI,qCAAiB,GAA6C,2CAAgB,AAA7D,CAA6D"}

package/dist/src/copilotStudioWebChat.d.ts

@@ -5,61 +5,179 @@
 import { Activity } from '@microsoft/agents-activity';
 import { Observable, BehaviorSubject } from 'rxjs';
 import { CopilotStudioClient } from './copilotStudioClient';
+/**
+ * Configuration settings for the Copilot Studio WebChat connection.
+ * These settings control the behavior and appearance of the WebChat interface
+ * when connected to the Copilot Studio service.
+ */
 export interface CopilotStudioWebChatSettings {
     /**
-     * Whether to show typing indicators in the WebChat.
-     * Defaults to false.
+     * Whether to show typing indicators in the WebChat when the agent is processing a response.
+     * When enabled, users will see a typing indicator while waiting for the agent's reply,
+     * providing visual feedback that their message is being processed.
+     * @default false
      */
     showTyping?: boolean;
 }
+/**
+ * Represents a connection interface for integrating Copilot Studio with WebChat.
+ * This interface provides the necessary methods and observables to facilitate
+ * bidirectional communication between a WebChat client and the Copilot Studio service.
+ *
+ * The connection follows the DirectLine protocol pattern, making it compatible with
+ * Microsoft Bot Framework WebChat components.
+ */
 export interface CopilotStudioWebChatConnection {
     /**
-     * An observable that emits the connection status.
-     * 0 - Disconnected
-     * 1 - Connecting
-     * 2 - Connected
-    */
+     * An observable that emits the current connection status as numeric values.
+     * This allows WebChat clients to monitor and react to connection state changes.
+     *
+     * Connection status values:
+     * - 0: Disconnected - No active connection to the service
+     * - 1: Connecting - Attempting to establish connection
+     * - 2: Connected - Successfully connected and ready for communication
+     */
     connectionStatus$: BehaviorSubject<number>;
     /**
-     * An observable that emits incoming activities.
-     * The emitted activities will have a 'webchat:sequence-id' in their channelData.
+     * An observable stream that emits incoming activities from the Copilot Studio service.
+     * Each activity represents a message, card, or other interactive element sent by the agent.
+     *
+     * All emitted activities include:
+     * - A timestamp indicating when the activity was received
+     * - A 'webchat:sequence-id' in their channelData for proper message ordering
+     * - Standard Bot Framework Activity properties (type, text, attachments, etc.)
      */
     activity$: Observable<Partial<Activity>>;
     /**
-     * Posts an activity to the Copilot Studio service.
-     * The activity must have a non-empty text field.
-     * Returns an observable that emits the activity ID once the activity is posted.
+     * Posts a user activity to the Copilot Studio service and returns an observable
+     * that emits the activity ID once the message is successfully sent.
+     *
+     * The method validates that the activity contains meaningful content and handles
+     * the complete message flow including optional typing indicators.
      *
-     * @param activity - The activity to post.
-     * @returns An observable that emits the activity ID.
+     * @param activity - The user activity to send. Must contain a non-empty text field.
+     * @returns An observable that emits the unique activity ID upon successful posting.
+     * @throws Error if the activity text is empty or if the connection is not properly initialized.
      */
     postActivity(activity: Activity): Observable<string>;
     /**
-     * Ends the connection.
-     * This will complete the connectionStatus$ and activity$ observables.
+     * Gracefully terminates the connection to the Copilot Studio service.
+     * This method ensures proper cleanup by completing all active observables
+     * and releasing associated resources.
+     *
+     * After calling this method:
+     * - The connectionStatus$ observable will be completed
+     * - The activity$ observable will stop emitting new activities
+     * - No further activities can be posted through this connection
      */
     end(): void;
 }
 /**
- * This class is intended to be used in WebChat applications to connect to the Copilot Studio service.
+ * A utility class that provides WebChat integration capabilities for Copilot Studio services.
+ * This class acts as a bridge between Microsoft Bot Framework WebChat and Copilot Studio,
+ * enabling seamless communication through a DirectLine-compatible interface.
+ *
+ * ## Key Features:
+ * - DirectLine protocol compatibility for easy WebChat integration
+ * - Real-time bidirectional messaging with Copilot Studio agents
+ * - Automatic conversation management and message sequencing
+ * - Optional typing indicators for enhanced user experience
+ * - Observable-based architecture for reactive programming patterns
+ *
+ * ## Usage Scenarios:
+ * - Embedding Copilot Studio agents in web applications
+ * - Creating custom chat interfaces with WebChat components
+ * - Building conversational AI experiences with Microsoft's bot ecosystem
+ *
+ * @example Basic WebChat Integration
+ * ```typescript
+ * import { CopilotStudioClient } from '@microsoft/agents-copilotstudio-client';
+ * import { CopilotStudioWebChat } from '@microsoft/agents-copilotstudio-client';
+ *
+ * // Initialize the Copilot Studio client
+ * const client = new CopilotStudioClient({
+ *   botId: 'your-bot-id',
+ *   tenantId: 'your-tenant-id'
+ * });
  *
- * example usage:
- * ```javascript
- * const client = new CopilotStudioClient(...)
+ * // Create a WebChat-compatible connection
+ * const directLine = CopilotStudioWebChat.createConnection(client, {
+ *   showTyping: true
+ * });
+ *
+ * // Integrate with WebChat
  * window.WebChat.renderWebChat({
- *   directLine: CopilotStudioWebChat.createConnection(client)
- * })
+ *   directLine: directLine,
+ *   // ... other WebChat options
+ * }, document.getElementById('webchat'));
+ * ```
+ *
+ * @example Advanced Usage with Connection Monitoring
+ * ```typescript
+ * const connection = CopilotStudioWebChat.createConnection(client);
+ *
+ * // Monitor connection status
+ * connection.connectionStatus$.subscribe(status => {
+ *   switch (status) {
+ *     case 0: console.log('Disconnected'); break;
+ *     case 1: console.log('Connecting...'); break;
+ *     case 2: console.log('Connected and ready'); break;
+ *   }
+ * });
+ *
+ * // Listen for incoming activities
+ * connection.activity$.subscribe(activity => {
+ *   console.log('Received activity:', activity);
+ * });
  * ```
  */
 export declare class CopilotStudioWebChat {
     /**
-     * Creates a new DirectLine-Like connection to WebChat.
-     * When an activity is posted in WebChat, the connection will send it to the Copilot Studio service, awaiting response.
-     * After a response is received, it will emit the incoming activity back to WebChat.
+     * Creates a DirectLine-compatible connection for integrating Copilot Studio with WebChat.
+     *
+     * This method establishes a real-time communication channel between WebChat and the
+     * Copilot Studio service. The returned connection object implements the DirectLine
+     * protocol, making it fully compatible with Microsoft Bot Framework WebChat components.
+     *
+     * ## Connection Lifecycle:
+     * 1. **Initialization**: Creates observables for connection status and activity streaming
+     * 2. **Conversation Start**: Automatically initiates conversation when first activity is posted
+     * 3. **Message Flow**: Handles bidirectional message exchange with proper sequencing
+     * 4. **Cleanup**: Provides graceful connection termination
+     *
+     * ## Message Processing:
+     * - User messages are validated and sent to Copilot Studio
+     * - Agent responses are received and formatted for WebChat
+     * - All activities include timestamps and sequence IDs for proper ordering
+     * - Optional typing indicators provide visual feedback during processing
+     *
+     * @param client - A configured CopilotStudioClient instance that handles the underlying
+     *                 communication with the Copilot Studio service. This client should be
+     *                 properly authenticated and configured with the target bot details.
+     *
+     * @param settings - Optional configuration settings that control the behavior of the
+     *                   WebChat connection. These settings allow customization of features
+     *                   like typing indicators and other user experience enhancements.
+     *
+     * @returns A new CopilotStudioWebChatConnection instance that can be passed directly
+     *          to WebChat's renderWebChat function as the directLine parameter. The
+     *          connection is immediately ready for use and will automatically manage
+     *          the conversation lifecycle.
+     *
+     * @throws Error if the provided client is not properly configured or if there are
+     *         issues establishing the initial connection to the Copilot Studio service.
+     *
+     * @example
+     * ```typescript
+     * const connection = CopilotStudioWebChat.createConnection(client, {
+     *   showTyping: true
+     * });
      *
-     * @param client - The Copilot Studio client instance.
-     * @param settings - Optional settings for the WebChat connection.
-     * @returns A new instance of CopilotStudioWebChatConnection.
+     * // Use with WebChat
+     * window.WebChat.renderWebChat({
+     *   directLine: connection
+     * }, document.getElementById('webchat'));
+     * ```
      */
     static createConnection(client: CopilotStudioClient, settings?: CopilotStudioWebChatSettings): CopilotStudioWebChatConnection;
 }