@microsoft/agents-copilotstudio-client 0.1.25-gcaee57b821

package/README.md

@@ -0,0 +1,48 @@
+# @microsoft/agents-copilotstudio-client
+
+## Overview
+
+The `@microsoft/agents-copilotstudio-client` package allows you to interact with Copilot Studio Agents using the Direct Engine Protocol. This client library is designed to facilitate communication with agents, enabling seamless integration and interaction within your JavaScript or TypeScript applications.
+
+> Note: The Client needs to be initialized with a valid JWT Token.
+
+## Installation
+
+To install the package, use npm or yarn:
+
+```sh
+npm install @microsoft/agents-copilotstudio-client
+```
+
+## Pre-requisites
+
+Create and deploy an agent in Copilot Studio, see [this guide](https://learn.microsoft.com/en-us/microsoft-copilot-studio/fundamentals-get-started?tabs=web) for a quick start
+
+Obtain the Agent configuration values from `<YourAgent>/Settings/Advanced/Metadata`, you will need:
+
+- Environment ID
+- Tenant ID
+- Agent app ID
+- Schema name
+
+Create an Entra ID app registration with permissions in the PowerPlatform API: `CopilotStudio.Copilots.Invoke`
+
+> Note: If you do not see `Power Platform API` in the list of API's your organization uses, you need to add the Power Platform API to your tenant. To do that, goto [Power Platform API Authentication](https://learn.microsoft.com/power-platform/admin/programmability-authentication-v2#step-2-configure-api-permissions) and follow the instructions on Step 2 to add the Power Platform Admin API to your Tenant
+
+## Usage
+
+The client requires the `connectionSettings` and a the `jwt token` to authenticate in the service.
+
+```ts
+const createClient = async (): Promise<CopilotStudioClient> => {
+  const settings = loadCopilotStudioConnectionSettingsFromEnv()
+  const token = await acquireToken(settings)
+  const copilotClient = new CopilotStudioClient(settings, token)
+  return copilotClient
+}
+const copilotClient = await createClient()
+const replies = await copilotClient.startConversationAsync(true)
+replies.forEach(r => console.log(r.text))
+```
+
+

package/dist/src/botType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Enum representing the type of bot.
+ */
+export declare enum BotType {
+    /**
+     * Represents a published bot.
+     */
+    Published = 0,
+    /**
+     * Represents a prebuilt bot.
+     */
+    Prebuilt = 1
+}

package/dist/src/botType.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BotType = void 0;
+/**
+ * Enum representing the type of bot.
+ */
+var BotType;
+(function (BotType) {
+    /**
+     * Represents a published bot.
+     */
+    BotType[BotType["Published"] = 0] = "Published";
+    /**
+     * Represents a prebuilt bot.
+     */
+    BotType[BotType["Prebuilt"] = 1] = "Prebuilt";
+})(BotType || (exports.BotType = BotType = {}));
+//# sourceMappingURL=botType.js.map

package/dist/src/botType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"botType.js","sourceRoot":"","sources":["../../src/botType.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;GAEG;AACH,IAAY,OASX;AATD,WAAY,OAAO;IACjB;;OAEG;IACH,+CAAa,CAAA;IACb;;OAEG;IACH,6CAAY,CAAA;AACd,CAAC,EATW,OAAO,uBAAP,OAAO,QASlB"}

package/dist/src/connectionSettings.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Represents the settings required to establish a connection to Copilot Studio.
+ */
+export declare class ConnectionSettings {
+    /** The client ID of the application. */
+    appClientId: string;
+    /** The tenant ID of the application. */
+    tenantId: string;
+    /** The environment ID of the application. */
+    environmentId: string;
+    /** The cloud environment of the application. */
+    cloud: string;
+    /** The custom Power Platform cloud URL, if any. */
+    customPowerPlatformCloud?: string;
+    /** The identifier of the bot. */
+    botIdentifier?: string;
+    /** The type of the Copilot bot. */
+    copilotBotType?: string;
+}
+/**
+ * Loads the connection settings for Copilot Studio from environment variables.
+ * @returns The connection settings.
+ */
+export declare const loadCopilotStudioConnectionSettingsFromEnv: () => ConnectionSettings;

package/dist/src/connectionSettings.js

@@ -0,0 +1,41 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadCopilotStudioConnectionSettingsFromEnv = exports.ConnectionSettings = void 0;
+/**
+ * Represents the settings required to establish a connection to Copilot Studio.
+ */
+class ConnectionSettings {
+    constructor() {
+        /** The client ID of the application. */
+        this.appClientId = '';
+        /** The tenant ID of the application. */
+        this.tenantId = '';
+        /** The environment ID of the application. */
+        this.environmentId = '';
+        /** The cloud environment of the application. */
+        this.cloud = '';
+    }
+}
+exports.ConnectionSettings = ConnectionSettings;
+/**
+ * Loads the connection settings for Copilot Studio from environment variables.
+ * @returns The connection settings.
+ */
+const loadCopilotStudioConnectionSettingsFromEnv = () => {
+    var _a, _b, _c;
+    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,
+        customPowerPlatformCloud: process.env.customPowerPlatformCloud,
+        botIdentifier: process.env.botIdentifier,
+        copilotBotType: process.env.copilotBotType
+    };
+};
+exports.loadCopilotStudioConnectionSettingsFromEnv = loadCopilotStudioConnectionSettingsFromEnv;
+//# sourceMappingURL=connectionSettings.js.map

package/dist/src/connectionSettings.js.map

@@ -0,0 +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,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,aAAa;QACxC,cAAc,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc;KACrB,CAAA;AACzB,CAAC,CAAA;AAVY,QAAA,0CAA0C,8CAUtD"}

package/dist/src/copilotStudioClient.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ConnectionSettings } from './connectionSettings';
+import { Activity } from '@microsoft/agents-bot-activity';
+export declare class CopilotStudioClient {
+    /** The ID of the current conversation. */
+    private conversationId;
+    /** The connection settings for the client. */
+    private readonly settings;
+    /** The Axios instance used for HTTP requests. */
+    private readonly client;
+    /** The logger for debugging. */
+    private readonly logger;
+    /**
+     * Creates an instance of CopilotStudioClient.
+     * @param settings The connection settings.
+     * @param token The authentication token.
+     */
+    constructor(settings: ConnectionSettings, token: string);
+    private postRequestAsync;
+    startConversationAsync(emitStartConversationEvent?: boolean): Promise<Activity>;
+    askQuestionAsync(question: string, conversationId?: string): Promise<Activity[]>;
+}

package/dist/src/copilotStudioClient.js

@@ -0,0 +1,120 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CopilotStudioClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+const powerPlatformEnvironment_1 = require("./powerPlatformEnvironment");
+const agents_bot_activity_1 = require("@microsoft/agents-bot-activity");
+const executeTurnRequest_1 = require("./executeTurnRequest");
+const debug_1 = __importDefault(require("debug"));
+class CopilotStudioClient {
+    /**
+     * Creates an instance of CopilotStudioClient.
+     * @param settings The connection settings.
+     * @param token The authentication token.
+     */
+    constructor(settings, token) {
+        /** The ID of the current conversation. */
+        this.conversationId = '';
+        this.settings = settings;
+        this.client = axios_1.default.create();
+        this.client.defaults.headers.common.Authorization = `Bearer ${token}`;
+        this.logger = (0, debug_1.default)('copilot-studio-client');
+    }
+    async postRequestAsync(axiosConfig) {
+        const activities = [];
+        const response = await this.client(axiosConfig);
+        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');
+                result += value;
+                results.push(result);
+                return results;
+            }
+            this.logger('Bot is typing...');
+            result += value;
+            return await processEvents(await reader.read());
+        };
+        const events = await reader.read().then(processEvents);
+        events.forEach(event => {
+            const values = event.toString().split('\n');
+            const validEvents = values.filter(e => e.substring(0, 4) === 'data' && e !== 'data: end\r');
+            validEvents.forEach(ve => {
+                try {
+                    const act = agents_bot_activity_1.Activity.fromJson(ve.substring(5, ve.length));
+                    if (act.type === agents_bot_activity_1.ActivityTypes.Message) {
+                        activities.push(act);
+                    }
+                    else {
+                        this.logger('Activity type: ', act.type);
+                    }
+                }
+                catch (e) {
+                    this.logger('Error: ', e);
+                    throw e;
+                }
+            });
+        });
+        return activities;
+    }
+    async startConversationAsync(emitStartConversationEvent = true) {
+        var _a;
+        const uriStart = (0, powerPlatformEnvironment_1.getCopilotStudioConnectionUrl)(this.settings);
+        const body = { emitStartConversationEvent };
+        const config = {
+            method: 'post',
+            url: uriStart,
+            headers: {
+                Accept: 'text/event-stream',
+                'Content-Type': 'application/json'
+            },
+            data: body,
+            responseType: 'stream',
+            adapter: 'fetch'
+        };
+        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;
+    }
+    async askQuestionAsync(question, conversationId = this.conversationId) {
+        var _a, _b;
+        const conversationAccount = {
+            id: conversationId
+        };
+        const activityObj = {
+            type: 'message',
+            text: question,
+            conversation: conversationAccount
+        };
+        const activity = agents_bot_activity_1.Activity.fromObject(activityObj);
+        const localConversationId = (_b = (_a = activity.conversation) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : conversationId;
+        const uriExecute = (0, powerPlatformEnvironment_1.getCopilotStudioConnectionUrl)(this.settings, localConversationId);
+        const qbody = new executeTurnRequest_1.ExecuteTurnRequest(activity);
+        const config = {
+            method: 'post',
+            url: uriExecute,
+            headers: {
+                Accept: 'text/event-stream',
+                'Content-Type': 'application/json'
+            },
+            data: qbody,
+            responseType: 'stream',
+            adapter: 'fetch'
+        };
+        const values = await this.postRequestAsync(config);
+        return values;
+    }
+}
+exports.CopilotStudioClient = CopilotStudioClient;
+//# sourceMappingURL=copilotStudioClient.js.map

package/dist/src/copilotStudioClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copilotStudioClient.js","sourceRoot":"","sources":["../../src/copilotStudioClient.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAGH,kDAAgE;AAChE,yEAA0E;AAC1E,wEAA6F;AAC7F,6DAAyD;AACzD,kDAA6C;AAO7C,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,kBAAkB,CAAC,CAAA;YAC/B,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,8BAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAA;oBACzD,IAAI,GAAG,CAAC,IAAI,KAAK,mCAAa,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;IAEM,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,IAAI,CAAC,cAAc,GAAG,MAAA,GAAG,CAAC,YAAY,0CAAE,EAAG,CAAA;QAC3C,OAAO,GAAG,CAAA;IACZ,CAAC;IAEM,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,8BAAQ,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;AApHD,kDAoHC"}

package/dist/src/directToEngineConnectionSettings.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { BotType } from './botType';
+import { PowerPlatformCloud } from './powerPlatformCloud';
+/**
+ * Represents the settings required to establish a direct connection to the engine.
+ */
+export interface DirectToEngineConnectionSettings {
+    /** The identifier of the bot. */
+    botIdentifier: string;
+    /** The custom Power Platform cloud URL. */
+    customPowerPlatformCloud: string;
+    /** The environment ID of the application. */
+    environmentId: string;
+    /** The cloud environment of the application. */
+    cloud: PowerPlatformCloud;
+    /** The type of the Copilot bot. */
+    copilotBotType: BotType;
+}

package/dist/src/directToEngineConnectionSettings.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=directToEngineConnectionSettings.js.map

package/dist/src/directToEngineConnectionSettings.js.map

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

package/dist/src/executeTurnRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Activity } from '@microsoft/agents-bot-activity';
+export declare class ExecuteTurnRequest {
+    /** The activity to be executed. */
+    activity?: Activity;
+    /**
+     * Creates an instance of ExecuteTurnRequest.
+     * @param activity The activity to be executed.
+     */
+    constructor(activity?: Activity);
+}

package/dist/src/executeTurnRequest.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExecuteTurnRequest = void 0;
+class ExecuteTurnRequest {
+    /**
+     * Creates an instance of ExecuteTurnRequest.
+     * @param activity The activity to be executed.
+     */
+    constructor(activity) {
+        this.activity = activity;
+    }
+}
+exports.ExecuteTurnRequest = ExecuteTurnRequest;
+//# sourceMappingURL=executeTurnRequest.js.map

package/dist/src/executeTurnRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"executeTurnRequest.js","sourceRoot":"","sources":["../../src/executeTurnRequest.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,MAAa,kBAAkB;IAI7B;;;OAGG;IACH,YAAa,QAAmB;QAC9B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;CACF;AAXD,gDAWC"}

package/dist/src/index.d.ts

@@ -0,0 +1,7 @@
+export * from './botType';
+export * from './connectionSettings';
+export * from './copilotStudioClient';
+export * from './directToEngineConnectionSettings';
+export * from './executeTurnRequest';
+export * from './powerPlatformCloud';
+export * from './powerPlatformEnvironment';

package/dist/src/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./botType"), 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);
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,uDAAoC;AACpC,wDAAqC;AACrC,qEAAkD;AAClD,uDAAoC;AACpC,uDAAoC;AACpC,6DAA0C"}

package/dist/src/powerPlatformCloud.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Enum representing different Power Platform cloud environments.
+ */
+export declare enum PowerPlatformCloud {
+    /**
+     * Unknown cloud environment.
+     */
+    Unknown = -1,
+    /**
+     * Experimental cloud environment.
+     */
+    Exp = 0,
+    /**
+     * Development cloud environment.
+     */
+    Dev = 1,
+    /**
+     * Test cloud environment.
+     */
+    Test = 2,
+    /**
+     * Pre-production cloud environment.
+     */
+    Preprod = 3,
+    /**
+     * First release cloud environment.
+     */
+    FirstRelease = 4,
+    /**
+     * Production cloud environment.
+     */
+    Prod = 5,
+    /**
+     * Government cloud environment.
+     */
+    Gov = 6,
+    /**
+     * High security cloud environment.
+     */
+    High = 7,
+    /**
+     * Department of Defense cloud environment.
+     */
+    DoD = 8,
+    /**
+     * Mooncake cloud environment.
+     */
+    Mooncake = 9,
+    /**
+     * Ex cloud environment.
+     */
+    Ex = 10,
+    /**
+     * Rx cloud environment.
+     */
+    Rx = 11,
+    /**
+     * Private cloud environment.
+     */
+    Prv = 12,
+    /**
+     * Local cloud environment.
+     */
+    Local = 13,
+    /**
+     * French government cloud environment.
+     */
+    GovFR = 14,
+    /**
+     * Other cloud environment.
+     */
+    Other = 100
+}

package/dist/src/powerPlatformCloud.js

@@ -0,0 +1,82 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PowerPlatformCloud = void 0;
+/**
+ * Enum representing different Power Platform cloud environments.
+ */
+var PowerPlatformCloud;
+(function (PowerPlatformCloud) {
+    /**
+     * Unknown cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["Unknown"] = -1] = "Unknown";
+    /**
+     * Experimental cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["Exp"] = 0] = "Exp";
+    /**
+     * Development cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["Dev"] = 1] = "Dev";
+    /**
+     * Test cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["Test"] = 2] = "Test";
+    /**
+     * Pre-production cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["Preprod"] = 3] = "Preprod";
+    /**
+     * First release cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["FirstRelease"] = 4] = "FirstRelease";
+    /**
+     * Production cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["Prod"] = 5] = "Prod";
+    /**
+     * Government cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["Gov"] = 6] = "Gov";
+    /**
+     * High security cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["High"] = 7] = "High";
+    /**
+     * Department of Defense cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["DoD"] = 8] = "DoD";
+    /**
+     * Mooncake cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["Mooncake"] = 9] = "Mooncake";
+    /**
+     * Ex cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["Ex"] = 10] = "Ex";
+    /**
+     * Rx cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["Rx"] = 11] = "Rx";
+    /**
+     * Private cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["Prv"] = 12] = "Prv";
+    /**
+     * Local cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["Local"] = 13] = "Local";
+    /**
+     * French government cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["GovFR"] = 14] = "GovFR";
+    /**
+     * Other cloud environment.
+     */
+    PowerPlatformCloud[PowerPlatformCloud["Other"] = 100] = "Other";
+})(PowerPlatformCloud || (exports.PowerPlatformCloud = PowerPlatformCloud = {}));
+//# sourceMappingURL=powerPlatformCloud.js.map

package/dist/src/powerPlatformCloud.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"powerPlatformCloud.js","sourceRoot":"","sources":["../../src/powerPlatformCloud.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;GAEG;AACH,IAAY,kBAqEX;AArED,WAAY,kBAAkB;IAC5B;;OAEG;IACH,kEAAY,CAAA;IACZ;;OAEG;IACH,yDAAO,CAAA;IACP;;OAEG;IACH,yDAAO,CAAA;IACP;;OAEG;IACH,2DAAQ,CAAA;IACR;;OAEG;IACH,iEAAW,CAAA;IACX;;OAEG;IACH,2EAAgB,CAAA;IAChB;;OAEG;IACH,2DAAQ,CAAA;IACR;;OAEG;IACH,yDAAO,CAAA;IACP;;OAEG;IACH,2DAAQ,CAAA;IACR;;OAEG;IACH,yDAAO,CAAA;IACP;;OAEG;IACH,mEAAY,CAAA;IACZ;;OAEG;IACH,wDAAO,CAAA;IACP;;OAEG;IACH,wDAAO,CAAA;IACP;;OAEG;IACH,0DAAQ,CAAA;IACR;;OAEG;IACH,8DAAU,CAAA;IACV;;OAEG;IACH,8DAAU,CAAA;IACV;;OAEG;IACH,+DAAW,CAAA;AACb,CAAC,EArEW,kBAAkB,kCAAlB,kBAAkB,QAqE7B"}

package/dist/src/powerPlatformEnvironment.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ConnectionSettings } from './connectionSettings';
+/**
+ * Generates the connection URL for Copilot Studio.
+ * @param settings - The connection settings.
+ * @param conversationId - Optional conversation ID.
+ * @returns The connection URL.
+ * @throws Will throw an error if required settings are missing or invalid.
+ */
+export declare function getCopilotStudioConnectionUrl(settings: ConnectionSettings, conversationId?: string): string;