@microsoft/agents-copilotstudio-client 0.5.4-ga4d0401645 → 0.5.12-g2d752e9b13

package/dist/src/connectionSettings.d.ts

@@ -2,10 +2,13 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License.
  */
+import { AgentType } from './agentType';
+import { CopilotStudioConnectionSettings } from './copilotStudioConnectionSettings';
+import { PowerPlatformCloud } from './powerPlatformCloud';
 /**
  * Represents the settings required to establish a connection to Copilot Studio.
  */
-export declare class ConnectionSettings {
+export declare class ConnectionSettings implements CopilotStudioConnectionSettings {
     /** The client ID of the application. */
     appClientId: string;
     /** The tenant ID of the application. */
@@ -13,13 +16,17 @@ export declare class ConnectionSettings {
     /** The environment ID of the application. */
     environmentId: string;
     /** The cloud environment of the application. */
-    cloud: string;
+    cloud?: PowerPlatformCloud;
     /** The custom Power Platform cloud URL, if any. */
     customPowerPlatformCloud?: string;
     /** The identifier of the agent. */
     agentIdentifier?: string;
     /** The type of the Copilot agent. */
-    copilotAgentType?: string;
+    copilotAgentType?: AgentType;
+    /** The URL to connect directly to Copilot Studio endpoint */
+    directConnectUrl?: string;
+    /** Flag to use the experimental endpoint if available */
+    useExperimentalEndpoint?: boolean;
 }
 /**
  * Loads the connection settings for Copilot Studio from environment variables.

package/dist/src/connectionSettings.js

@@ -5,6 +5,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadCopilotStudioConnectionSettingsFromEnv = exports.ConnectionSettings = void 0;
+const agentType_1 = require("./agentType");
+const powerPlatformCloud_1 = require("./powerPlatformCloud");
 /**
  * Represents the settings required to establish a connection to Copilot Studio.
  */
@@ -16,8 +18,8 @@ class ConnectionSettings {
         this.tenantId = '';
         /** The environment ID of the application. */
         this.environmentId = '';
-        /** The cloud environment of the application. */
-        this.cloud = '';
+        /** Flag to use the experimental endpoint if available */
+        this.useExperimentalEndpoint = false;
     }
 }
 exports.ConnectionSettings = ConnectionSettings;
@@ -26,15 +28,19 @@ exports.ConnectionSettings = ConnectionSettings;
  * @returns The connection settings.
  */
 const loadCopilotStudioConnectionSettingsFromEnv = () => {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
+    const cloudStr = process.env.cloud;
+    const agentStr = process.env.copilotAgentType;
     return {
         appClientId: (_a = process.env.appClientId) !== null && _a !== void 0 ? _a : '',
         tenantId: (_b = process.env.tenantId) !== null && _b !== void 0 ? _b : '',
         environmentId: (_c = process.env.environmentId) !== null && _c !== void 0 ? _c : '',
-        cloud: process.env.cloud,
+        cloud: cloudStr ? powerPlatformCloud_1.PowerPlatformCloud[cloudStr] : undefined,
         customPowerPlatformCloud: process.env.customPowerPlatformCloud,
         agentIdentifier: process.env.agentIdentifier,
-        copilotAgentType: process.env.copilotAgentType
+        copilotAgentType: agentStr ? agentType_1.AgentType[agentStr] : undefined,
+        directConnectUrl: process.env.directConnectUrl,
+        useExperimentalEndpoint: ((_d = process.env.useExperimentalEndpoint) === null || _d === void 0 ? void 0 : _d.toLocaleLowerCase()) === 'true'
     };
 };
 exports.loadCopilotStudioConnectionSettingsFromEnv = loadCopilotStudioConnectionSettingsFromEnv;

package/dist/src/connectionSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"connectionSettings.js","sourceRoot":"","sources":["../../src/connectionSettings.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;GAEG;AACH,MAAa,kBAAkB;IAA/B;QACE,wCAAwC;QACjC,gBAAW,GAAW,EAAE,CAAA;QAC/B,wCAAwC;QACjC,aAAQ,GAAW,EAAE,CAAA;QAC5B,6CAA6C;QACtC,kBAAa,GAAW,EAAE,CAAA;QACjC,gDAAgD;QACzC,UAAK,GAAW,EAAE,CAAA;IAO3B,CAAC;CAAA;AAfD,gDAeC;AAED;;;GAGG;AACI,MAAM,0CAA0C,GAA6B,GAAG,EAAE;;IACvF,OAAO;QACL,WAAW,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,WAAW,mCAAI,EAAE;QAC1C,QAAQ,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,QAAQ,mCAAI,EAAE;QACpC,aAAa,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,aAAa,mCAAI,EAAE;QAC9C,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK;QACxB,wBAAwB,EAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB;QAC9D,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe;QAC5C,gBAAgB,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB;KACzB,CAAA;AACzB,CAAC,CAAA;AAVY,QAAA,0CAA0C,8CAUtD"}
+{"version":3,"file":"connectionSettings.js","sourceRoot":"","sources":["../../src/connectionSettings.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2CAAuC;AAEvC,6DAAyD;AAEzD;;GAEG;AACH,MAAa,kBAAkB;IAA/B;QACE,wCAAwC;QACjC,gBAAW,GAAW,EAAE,CAAA;QAC/B,wCAAwC;QACjC,aAAQ,GAAW,EAAE,CAAA;QAC5B,6CAA6C;QACtC,kBAAa,GAAW,EAAE,CAAA;QAWjC,yDAAyD;QAClD,4BAAuB,GAAa,KAAK,CAAA;IAClD,CAAC;CAAA;AAnBD,gDAmBC;AAED;;;GAGG;AACI,MAAM,0CAA0C,GAA6B,GAAG,EAAE;;IACvF,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,KAAoD,CAAA;IACjF,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAsD,CAAA;IAEnF,OAAO;QACL,WAAW,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,WAAW,mCAAI,EAAE;QAC1C,QAAQ,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,QAAQ,mCAAI,EAAE;QACpC,aAAa,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,aAAa,mCAAI,EAAE;QAC9C,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,uCAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS;QAC1D,wBAAwB,EAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB;QAC9D,eAAe,EAAE,OAAO,CAAC,GAAG,CAAC,eAAe;QAC5C,gBAAgB,EAAE,QAAQ,CAAC,CAAC,CAAC,qBAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS;QAC5D,gBAAgB,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB;QAC9C,uBAAuB,EAAE,CAAA,MAAA,OAAO,CAAC,GAAG,CAAC,uBAAuB,0CAAE,iBAAiB,EAAE,MAAK,MAAM;KAChE,CAAA;AAChC,CAAC,CAAA;AAfY,QAAA,0CAA0C,8CAetD"}

package/dist/src/copilotStudioClient.d.ts

@@ -5,6 +5,10 @@
 import { ConnectionSettings } from './connectionSettings';
 import { Activity } from '@microsoft/agents-activity';
 export declare class CopilotStudioClient {
+    /** Header key for conversation ID. */
+    private static readonly conversationIdHeaderKey;
+    /** Island Header key */
+    private static readonly islandExperimentalUrlHeaderKey;
     /** The ID of the current conversation. */
     private conversationId;
     /** The connection settings for the client. */
@@ -20,6 +24,12 @@ export declare class CopilotStudioClient {
      */
     constructor(settings: ConnectionSettings, token: string);
     private postRequestAsync;
+    /**
+     * Appends this package.json version to the User-Agent header.
+     * - For browser environments, it includes the user agent of the browser.
+     * - For Node.js environments, it includes the Node.js version, platform, architecture, and release.
+     * @returns A string containing the product information, including version and user agent.
+     */
     private static getProductInfo;
     /**
      * Starts a new conversation with the Copilot Studio service.

package/dist/src/copilotStudioClient.js

@@ -27,11 +27,28 @@ class CopilotStudioClient {
         this.settings = settings;
         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}`);
         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}`);
+            }
+        }
+        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}`);
+        }
+        this.logger('=====================================================');
+        this.logger(`Headers: ${JSON.stringify(response.headers, null, 2)}`);
+        this.logger('=====================================================');
         const stream = response.data;
         const reader = stream.pipeThrough(new TextDecoderStream()).getReader();
         let result = '';
@@ -52,10 +69,16 @@ class CopilotStudioClient {
             const values = event.toString().split('\n');
             const validEvents = values.filter(e => e.substring(0, 4) === 'data' && e !== 'data: end\r');
             validEvents.forEach(ve => {
+                var _a, _b;
                 try {
                     const act = agents_activity_1.Activity.fromJson(ve.substring(5, ve.length));
                     if (act.type === agents_activity_1.ActivityTypes.Message) {
                         activities.push(act);
+                        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}`);
+                        }
                     }
                     else {
                         this.logger('Activity type: ', act.type);
@@ -69,8 +92,18 @@ class CopilotStudioClient {
         });
         return activities;
     }
+    /**
+     * Appends this package.json version to the User-Agent header.
+     * - For browser environments, it includes the user agent of the browser.
+     * - For Node.js environments, it includes the Node.js version, platform, architecture, and release.
+     * @returns A string containing the product information, including version and user agent.
+     */
     static getProductInfo() {
-        return `CopilotStudioClient.agents-sdk-js/${package_json_1.default.version} nodejs/${process.version}  ${os_1.default.platform()}-${os_1.default.arch()}/${os_1.default.release()}`;
+        const version = `CopilotStudioClient.agents-sdk-js/${package_json_1.default.version}`;
+        if (typeof window !== 'undefined' && window.navigator) {
+            return `${version} ${navigator.userAgent}`;
+        }
+        return `${version} nodejs/${process.version} ${os_1.default.platform()}-${os_1.default.arch()}/${os_1.default.release()}`;
     }
     /**
      * Starts a new conversation with the Copilot Studio service.
@@ -78,7 +111,6 @@ 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 = {
@@ -87,7 +119,6 @@ class CopilotStudioClient {
             headers: {
                 Accept: 'text/event-stream',
                 'Content-Type': 'application/json',
-                'User-Agent': CopilotStudioClient.getProductInfo(),
             },
             data: body,
             responseType: 'stream',
@@ -95,7 +126,6 @@ class CopilotStudioClient {
         };
         const values = await this.postRequestAsync(config);
         const act = values[0];
-        this.conversationId = (_a = act.conversation) === null || _a === void 0 ? void 0 : _a.id;
         return act;
     }
     /**
@@ -123,7 +153,7 @@ class CopilotStudioClient {
             url: uriExecute,
             headers: {
                 Accept: 'text/event-stream',
-                'Content-Type': 'application/json'
+                'Content-Type': 'application/json',
             },
             data: qbody,
             responseType: 'stream',
@@ -134,4 +164,8 @@ class CopilotStudioClient {
     }
 }
 exports.CopilotStudioClient = CopilotStudioClient;
+/** Header key for conversation ID. */
+CopilotStudioClient.conversationIdHeaderKey = 'x-ms-conversationid';
+/** Island Header key */
+CopilotStudioClient.islandExperimentalUrlHeaderKey = 'x-ms-d2e-experimental';
 //# 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,yEAA0E;AAC1E,gEAAyF;AACzF,6DAAyD;AACzD,kDAA6C;AAC7C,uGAAuE;AACvE,4CAAmB;AAOnB,MAAa,mBAAmB;IAU9B;;;;OAIG;IACH,YAAa,QAA4B,EAAE,KAAa;QAdxD,0CAA0C;QAClC,mBAAc,GAAW,EAAE,CAAA;QAcjC,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,GAAG,IAAA,eAAW,EAAC,uBAAuB,CAAC,CAAA;IACpD,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAE,WAA+B;QAC7D,MAAM,UAAU,GAAe,EAAE,CAAA;QACjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;QAC/C,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;oBACtB,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;IAEO,MAAM,CAAC,cAAc;QAC3B,OAAO,qCAAqC,sBAAK,CAAC,OAAO,WAAW,OAAO,CAAC,OAAO,KAAK,YAAE,CAAC,QAAQ,EAAE,IAAI,YAAE,CAAC,IAAI,EAAE,IAAI,YAAE,CAAC,OAAO,EAAE,EAAE,CAAA;IACtI,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;gBAClC,YAAY,EAAE,mBAAmB,CAAC,cAAc,EAAE;aACnD;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,IAAI,CAAC,cAAc,GAAG,MAAA,GAAG,CAAC,YAAY,0CAAE,EAAG,CAAA;QAC3C,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;CACF;AApID,kDAoIC"}
+{"version":3,"file":"copilotStudioClient.js","sourceRoot":"","sources":["../../src/copilotStudioClient.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAGH,kDAAgE;AAChE,yEAA0E;AAC1E,gEAAyF;AACzF,6DAAyD;AACzD,kDAA6C;AAC7C,uGAAuE;AACvE,4CAAmB;AAOnB,MAAa,mBAAmB;IAe9B;;;;OAIG;IACH,YAAa,QAA4B,EAAE,KAAa;QAdxD,0CAA0C;QAClC,mBAAc,GAAW,EAAE,CAAA;QAcjC,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;;AA7KH,kDA8KC;AA7KC,sCAAsC;AACd,2CAAuB,GAAW,qBAAqB,AAAhC,CAAgC;AAC/E,wBAAwB;AACA,kDAA8B,GAAW,uBAAuB,AAAlC,CAAkC"}

package/dist/src/{directToEngineConnectionSettings.d.ts → copilotStudioConnectionSettings.d.ts}

@@ -7,15 +7,19 @@ import { PowerPlatformCloud } from './powerPlatformCloud';
 /**
  * Represents the settings required to establish a direct connection to the engine.
  */
-export interface DirectToEngineConnectionSettings {
+export interface CopilotStudioConnectionSettings {
     /** The identifier of the agent. */
-    agentIdentifier: string;
+    agentIdentifier?: string;
     /** The custom Power Platform cloud URL. */
-    customPowerPlatformCloud: string;
+    customPowerPlatformCloud?: string;
     /** The environment ID of the application. */
-    environmentId: string;
+    environmentId?: string;
     /** The cloud environment of the application. */
-    cloud: PowerPlatformCloud;
+    cloud?: PowerPlatformCloud;
     /** The type of the Copilot agent. */
-    copilotAgentType: AgentType;
+    copilotAgentType?: AgentType;
+    /** URL provided to connect directly to Copilot Studio endpoint. When provided all other settings are ignored. */
+    directConnectUrl?: string;
+    /** Directs Copilot Studio Client to use the experimental endpoint if available. */
+    useExperimentalEndpoint?: boolean;
 }

package/dist/src/copilotStudioConnectionSettings.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=copilotStudioConnectionSettings.js.map

package/dist/src/copilotStudioConnectionSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copilotStudioConnectionSettings.js","sourceRoot":"","sources":["../../src/copilotStudioConnectionSettings.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/dist/src/copilotStudioWebChat.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Activity } from '@microsoft/agents-activity';
+import { Observable, BehaviorSubject } from 'rxjs';
+import { CopilotStudioClient } from './copilotStudioClient';
+export interface CopilotStudioWebChatSettings {
+    /**
+     * Whether to show typing indicators in the WebChat.
+     * Defaults to false.
+     */
+    showTyping?: boolean;
+}
+export interface CopilotStudioWebChatConnection {
+    /**
+     * An observable that emits the connection status.
+     * 0 - Disconnected
+     * 1 - Connecting
+     * 2 - Connected
+    */
+    connectionStatus$: BehaviorSubject<number>;
+    /**
+     * An observable that emits incoming activities.
+     * The emitted activities will have a 'webchat:sequence-id' in their channelData.
+     */
+    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.
+     *
+     * @param activity - The activity to post.
+     * @returns An observable that emits the activity ID.
+     */
+    postActivity(activity: Activity): Observable<string>;
+    /**
+     * Ends the connection.
+     * This will complete the connectionStatus$ and activity$ observables.
+     */
+    end(): void;
+}
+/**
+ * This class is intended to be used in WebChat applications to connect to the Copilot Studio service.
+ *
+ * example usage:
+ * ```javascript
+ * const client = new CopilotStudioClient(...)
+ * window.WebChat.renderWebChat({
+ *   directLine: CopilotStudioWebChat.createConnection(client)
+ * })
+ * ```
+ */
+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.
+     *
+     * @param client - The Copilot Studio client instance.
+     * @param settings - Optional settings for the WebChat connection.
+     * @returns A new instance of CopilotStudioWebChatConnection.
+     */
+    static createConnection(client: CopilotStudioClient, settings?: CopilotStudioWebChatSettings): CopilotStudioWebChatConnection;
+}

package/dist/src/copilotStudioWebChat.js

@@ -0,0 +1,107 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CopilotStudioWebChat = void 0;
+const uuid_1 = require("uuid");
+const rxjs_1 = require("rxjs");
+/**
+ * This class is intended to be used in WebChat applications to connect to the Copilot Studio service.
+ *
+ * example usage:
+ * ```javascript
+ * const client = new CopilotStudioClient(...)
+ * window.WebChat.renderWebChat({
+ *   directLine: CopilotStudioWebChat.createConnection(client)
+ * })
+ * ```
+ */
+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.
+     *
+     * @param client - The Copilot Studio client instance.
+     * @param settings - Optional settings for the WebChat connection.
+     * @returns A new instance of CopilotStudioWebChatConnection.
+     */
+    static createConnection(client, settings) {
+        let sequence = 0;
+        let activityObserver;
+        let conversation;
+        const connectionStatus$ = new rxjs_1.BehaviorSubject(0);
+        const activity$ = rxjs_1.Observable.create(async (observer) => {
+            activityObserver = observer;
+            if (connectionStatus$.value < 2) {
+                connectionStatus$.next(2);
+                return;
+            }
+            notifyTyping();
+            const activity = await client.startConversationAsync();
+            conversation = activity.conversation;
+            sequence = 0;
+            notifyActivity(activity);
+        });
+        const notifyActivity = (activity) => {
+            activityObserver === null || activityObserver === void 0 ? void 0 : activityObserver.next({
+                ...activity,
+                timestamp: new Date().toISOString(),
+                channelData: {
+                    ...activity.channelData,
+                    'webchat:sequence-id': sequence++,
+                },
+            });
+        };
+        const notifyTyping = () => {
+            if (!(settings === null || settings === void 0 ? void 0 : settings.showTyping)) {
+                return;
+            }
+            const from = conversation
+                ? { id: conversation.id, name: conversation.name }
+                : { id: 'agent', name: 'Agent' };
+            notifyActivity({ type: 'typing', from });
+        };
+        return {
+            connectionStatus$,
+            activity$,
+            postActivity(activity) {
+                var _a;
+                if (!((_a = activity.text) === null || _a === void 0 ? void 0 : _a.trim())) {
+                    throw new Error('Activity text cannot be empty.');
+                }
+                if (!activityObserver) {
+                    throw new Error('Activity observer is not initialized.');
+                }
+                return rxjs_1.Observable.create(async (observer) => {
+                    try {
+                        const id = (0, uuid_1.v4)();
+                        notifyActivity({ ...activity, id });
+                        notifyTyping();
+                        const activities = await client.askQuestionAsync(activity.text);
+                        for (const responseActivity of activities) {
+                            notifyActivity(responseActivity);
+                        }
+                        observer.next(id);
+                        observer.complete();
+                    }
+                    catch (error) {
+                        observer.error(error);
+                    }
+                });
+            },
+            end() {
+                connectionStatus$.complete();
+                activity$.complete();
+                if (activityObserver) {
+                    activityObserver.complete();
+                    activityObserver = undefined;
+                }
+            },
+        };
+    }
+}
+exports.CopilotStudioWebChat = CopilotStudioWebChat;
+//# sourceMappingURL=copilotStudioWebChat.js.map

package/dist/src/copilotStudioWebChat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copilotStudioWebChat.js","sourceRoot":"","sources":["../../src/copilotStudioWebChat.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+BAAiC;AAGjC,+BAAiE;AA4CjE;;;;;;;;;;GAUG;AACH,MAAa,oBAAoB;IAC/B;;;;;;;;OAQG;IACH,MAAM,CAAC,gBAAgB,CACrB,MAA2B,EAC3B,QAAuC;QAEvC,IAAI,QAAQ,GAAG,CAAC,CAAA;QAChB,IAAI,gBAAyD,CAAA;QAC7D,IAAI,YAA6C,CAAA;QAEjD,MAAM,iBAAiB,GAAG,IAAI,sBAAe,CAAC,CAAC,CAAC,CAAA;QAChD,MAAM,SAAS,GAAG,iBAAU,CAAC,MAAM,CACjC,KAAK,EAAE,QAAqC,EAAE,EAAE;YAC9C,gBAAgB,GAAG,QAAQ,CAAA;YAE3B,IAAI,iBAAiB,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;gBAChC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBACzB,OAAM;YACR,CAAC;YAED,YAAY,EAAE,CAAA;YACd,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,sBAAsB,EAAE,CAAA;YACtD,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAA;YACpC,QAAQ,GAAG,CAAC,CAAA;YACZ,cAAc,CAAC,QAAQ,CAAC,CAAA;QAC1B,CAAC,CACF,CAAA;QAED,MAAM,cAAc,GAAG,CAAC,QAA2B,EAAE,EAAE;YACrD,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,IAAI,CAAC;gBACrB,GAAG,QAAQ;gBACX,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;gBACnC,WAAW,EAAE;oBACX,GAAG,QAAQ,CAAC,WAAW;oBACvB,qBAAqB,EAAE,QAAQ,EAAE;iBAClC;aACF,CAAC,CAAA;QACJ,CAAC,CAAA;QAED,MAAM,YAAY,GAAG,GAAG,EAAE;YACxB,IAAI,CAAC,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,UAAU,CAAA,EAAE,CAAC;gBAC1B,OAAM;YACR,CAAC;YAED,MAAM,IAAI,GAAG,YAAY;gBACvB,CAAC,CAAC,EAAE,EAAE,EAAE,YAAY,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE;gBAClD,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;YAClC,cAAc,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAA;QAC1C,CAAC,CAAA;QAED,OAAO;YACL,iBAAiB;YACjB,SAAS;YACT,YAAY,CAAE,QAAkB;;gBAC9B,IAAI,CAAC,CAAA,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,EAAE,CAAA,EAAE,CAAC;oBAC3B,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;gBACnD,CAAC;gBAED,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBACtB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;gBAC1D,CAAC;gBAED,OAAO,iBAAU,CAAC,MAAM,CAAC,KAAK,EAAE,QAA0B,EAAE,EAAE;oBAC5D,IAAI,CAAC;wBACH,MAAM,EAAE,GAAG,IAAA,SAAI,GAAE,CAAA;wBAEjB,cAAc,CAAC,EAAE,GAAG,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAA;wBACnC,YAAY,EAAE,CAAA;wBAEd,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAK,CAAC,CAAA;wBAChE,KAAK,MAAM,gBAAgB,IAAI,UAAU,EAAE,CAAC;4BAC1C,cAAc,CAAC,gBAAgB,CAAC,CAAA;wBAClC,CAAC;wBAED,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;wBACjB,QAAQ,CAAC,QAAQ,EAAE,CAAA;oBACrB,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;oBACvB,CAAC;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC;YAED,GAAG;gBACD,iBAAiB,CAAC,QAAQ,EAAE,CAAA;gBAC5B,SAAS,CAAC,QAAQ,EAAE,CAAA;gBACpB,IAAI,gBAAgB,EAAE,CAAC;oBACrB,gBAAgB,CAAC,QAAQ,EAAE,CAAA;oBAC3B,gBAAgB,GAAG,SAAS,CAAA;gBAC9B,CAAC;YACH,CAAC;SACF,CAAA;IACH,CAAC;CACF;AApGD,oDAoGC"}

package/dist/src/index.d.ts

@@ -1,7 +1,8 @@
-export * from './agentType';
-export * from './connectionSettings';
-export * from './copilotStudioClient';
-export * from './directToEngineConnectionSettings';
-export * from './executeTurnRequest';
-export * from './powerPlatformCloud';
-export * from './powerPlatformEnvironment';
+export * from './agentType.js';
+export * from './connectionSettings.js';
+export * from './copilotStudioClient.js';
+export * from './copilotStudioConnectionSettings.js';
+export * from './copilotStudioWebChat.js';
+export * from './executeTurnRequest.js';
+export * from './powerPlatformCloud.js';
+export * from './powerPlatformEnvironment.js';

package/dist/src/index.js

@@ -14,11 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./agentType"), exports);
-__exportStar(require("./connectionSettings"), exports);
-__exportStar(require("./copilotStudioClient"), exports);
-__exportStar(require("./directToEngineConnectionSettings"), exports);
-__exportStar(require("./executeTurnRequest"), exports);
-__exportStar(require("./powerPlatformCloud"), exports);
-__exportStar(require("./powerPlatformEnvironment"), exports);
+__exportStar(require("./agentType.js"), exports);
+__exportStar(require("./connectionSettings.js"), exports);
+__exportStar(require("./copilotStudioClient.js"), exports);
+__exportStar(require("./copilotStudioConnectionSettings.js"), exports);
+__exportStar(require("./copilotStudioWebChat.js"), exports);
+__exportStar(require("./executeTurnRequest.js"), exports);
+__exportStar(require("./powerPlatformCloud.js"), exports);
+__exportStar(require("./powerPlatformEnvironment.js"), exports);
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,uDAAoC;AACpC,wDAAqC;AACrC,qEAAkD;AAClD,uDAAoC;AACpC,uDAAoC;AACpC,6DAA0C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA8B;AAC9B,0DAAuC;AACvC,2DAAwC;AACxC,uEAAoD;AACpD,4DAAyC;AACzC,0DAAuC;AACvC,0DAAuC;AACvC,gEAA6C"}

package/dist/src/powerPlatformEnvironment.js

@@ -7,7 +7,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCopilotStudioConnectionUrl = getCopilotStudioConnectionUrl;
 const agentType_1 = require("./agentType");
 const powerPlatformCloud_1 = require("./powerPlatformCloud");
-const ApiVersion = '2022-03-01-preview';
+const prebuiltBotStrategy_1 = require("./strategies/prebuiltBotStrategy");
+const publishedBotStrategy_1 = require("./strategies/publishedBotStrategy");
 /**
  * Generates the connection URL for Copilot Studio.
  * @param settings - The connection settings.
@@ -16,17 +17,29 @@ const ApiVersion = '2022-03-01-preview';
  * @throws Will throw an error if required settings are missing or invalid.
  */
 function getCopilotStudioConnectionUrl(settings, conversationId) {
+    var _a, _b;
     let cloudValue = powerPlatformCloud_1.PowerPlatformCloud.Prod;
-    const isNotEmptyCloud = settings.cloud && settings.cloud.trim() !== '';
+    if ((_a = settings.directConnectUrl) === null || _a === void 0 ? void 0 : _a.trim()) {
+        if (!isValidUri(settings.directConnectUrl)) {
+            throw new Error('directConnectUrl must be a valid URL');
+        }
+        // FIX for Missing Tenant ID
+        if (settings.directConnectUrl.toLocaleLowerCase().includes('tenants/00000000-0000-0000-0000-000000000000')) {
+            // Direct connection cannot be used, ejecting and forcing the normal settings flow:
+            return getCopilotStudioConnectionUrl({ ...settings, directConnectUrl: '' }, conversationId);
+        }
+        return createURL(settings.directConnectUrl, conversationId).href;
+    }
+    const isNotEmptyCloud = settings.cloud && settings.cloud.toString().trim() !== '';
     const isNotEmptyCustomPowerPlatformCloud = settings.customPowerPlatformCloud !== undefined && settings.customPowerPlatformCloud.trim() !== '';
     if (isNotEmptyCloud && !Object.values(powerPlatformCloud_1.PowerPlatformCloud).includes(settings.cloud)) {
         throw new Error('Invalid PowerPlatformCloud enum key');
     }
-    const cloudSetting = isNotEmptyCloud ? powerPlatformCloud_1.PowerPlatformCloud[settings.cloud] : powerPlatformCloud_1.PowerPlatformCloud.Unknown;
+    const cloudSetting = isNotEmptyCloud ? settings.cloud : powerPlatformCloud_1.PowerPlatformCloud.Unknown;
     if (cloudSetting === powerPlatformCloud_1.PowerPlatformCloud.Other && isNotEmptyCustomPowerPlatformCloud) {
         throw new Error('customPowerPlatformCloud must be provided when PowerPlatformCloud is Other');
     }
-    if (settings.environmentId.trim() === '') {
+    if (!((_b = settings.environmentId) === null || _b === void 0 ? void 0 : _b.trim())) {
         throw new Error('EnvironmentId must be provided');
     }
     if (settings.agentIdentifier === undefined || settings.agentIdentifier.trim() === '') {
@@ -44,12 +57,12 @@ function getCopilotStudioConnectionUrl(settings, conversationId) {
         }
     }
     let agentType;
-    if (settings.copilotAgentType && settings.copilotAgentType.trim() !== '') {
+    if (settings.copilotAgentType && settings.copilotAgentType.toString().trim() !== '') {
         if (!Object.values(agentType_1.AgentType).includes(settings.copilotAgentType)) {
             throw new Error('Invalid AgentType enum key');
         }
         else {
-            agentType = agentType_1.AgentType[settings.copilotAgentType];
+            agentType = settings.copilotAgentType;
         }
     }
     else {
@@ -57,7 +70,17 @@ function getCopilotStudioConnectionUrl(settings, conversationId) {
     }
     settings.customPowerPlatformCloud = isNotEmptyCustomPowerPlatformCloud ? settings.customPowerPlatformCloud : 'api.unknown.powerplatform.com';
     const host = getEnvironmentEndpoint(cloudValue, settings.environmentId, settings.customPowerPlatformCloud);
-    return createUri(settings.agentIdentifier, host, agentType, conversationId);
+    const strategy = {
+        [agentType_1.AgentType.Published]: () => new publishedBotStrategy_1.PublishedBotStrategy({
+            host,
+            schema: settings.agentIdentifier,
+        }),
+        [agentType_1.AgentType.Prebuilt]: () => new prebuiltBotStrategy_1.PrebuiltBotStrategy({
+            host,
+            identifier: settings.agentIdentifier,
+        }),
+    }[agentType]();
+    return strategy.getConversationUrl(conversationId);
 }
 function isValidUri(uri) {
     try {
@@ -68,17 +91,22 @@ function isValidUri(uri) {
         return false;
     }
 }
-function createUri(agentIdentifier, host, agentType, conversationId) {
-    const agentPathName = agentType === agentType_1.AgentType.Published ? 'dataverse-backed' : 'prebuilt';
-    const url = new URL(`https://${host}`);
-    url.searchParams.set('api-version', ApiVersion);
-    if (!conversationId) {
-        url.pathname = `/copilotstudio/${agentPathName}/authenticated/bots/${agentIdentifier}/conversations`;
+function createURL(base, conversationId) {
+    const url = new URL(base);
+    if (!url.searchParams.has('api-version')) {
+        url.searchParams.append('api-version', '2022-03-01-preview');
     }
-    else {
-        url.pathname = `/copilotstudio/${agentPathName}/authenticated/bots/${agentIdentifier}/conversations/${conversationId}`;
+    if (url.pathname.endsWith('/')) {
+        url.pathname = url.pathname.slice(0, -1);
+    }
+    if (url.pathname.includes('/conversations')) {
+        url.pathname = url.pathname.substring(0, url.pathname.indexOf('/conversations'));
+    }
+    url.pathname = `${url.pathname}/conversations`;
+    if (conversationId) {
+        url.pathname = `${url.pathname}/${conversationId}`;
     }
-    return url.toString();
+    return url;
 }
 function getEnvironmentEndpoint(cloud, environmentId, cloudBaseAddress) {
     if (cloud === powerPlatformCloud_1.PowerPlatformCloud.Other && (!cloudBaseAddress || !cloudBaseAddress.trim())) {
@@ -89,7 +117,7 @@ function getEnvironmentEndpoint(cloud, environmentId, cloudBaseAddress) {
     const idSuffixLength = getIdSuffixLength(cloud);
     const hexPrefix = normalizedResourceId.substring(0, normalizedResourceId.length - idSuffixLength);
     const hexSuffix = normalizedResourceId.substring(normalizedResourceId.length - idSuffixLength);
-    return `${hexPrefix}.${hexSuffix}.environment.${getEndpointSuffix(cloud, cloudBaseAddress)}`;
+    return new URL(`https://${hexPrefix}.${hexSuffix}.environment.${getEndpointSuffix(cloud, cloudBaseAddress)}`);
 }
 function getEndpointSuffix(category, cloudBaseAddress) {
     switch (category) {