@microsoft/agents-copilotstudio-client 0.1.25-gcaee57b821

package/dist/src/powerPlatformEnvironment.js

@@ -0,0 +1,140 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCopilotStudioConnectionUrl = getCopilotStudioConnectionUrl;
+const botType_1 = require("./botType");
+const powerPlatformCloud_1 = require("./powerPlatformCloud");
+const ApiVersion = '2022-03-01-preview';
+/**
+ * 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.
+ */
+function getCopilotStudioConnectionUrl(settings, conversationId) {
+    let cloudValue = powerPlatformCloud_1.PowerPlatformCloud.Prod;
+    const isNotEmptyCloud = settings.cloud && settings.cloud.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;
+    if (cloudSetting === powerPlatformCloud_1.PowerPlatformCloud.Other && isNotEmptyCustomPowerPlatformCloud) {
+        throw new Error('customPowerPlatformCloud must be provided when PowerPlatformCloud is Other');
+    }
+    if (settings.environmentId.trim() === '') {
+        throw new Error('EnvironmentId must be provided');
+    }
+    if (settings.botIdentifier === undefined || settings.botIdentifier.trim() === '') {
+        throw new Error('BotIdentifier must be provided');
+    }
+    if (cloudSetting !== powerPlatformCloud_1.PowerPlatformCloud.Unknown) {
+        cloudValue = cloudSetting;
+    }
+    if (cloudSetting === powerPlatformCloud_1.PowerPlatformCloud.Other) {
+        if (isNotEmptyCustomPowerPlatformCloud && isValidUri(settings.customPowerPlatformCloud)) {
+            cloudValue = powerPlatformCloud_1.PowerPlatformCloud.Other;
+        }
+        else {
+            throw new Error('customPowerPlatformCloud must be provided when PowerPlatformCloud is Other');
+        }
+    }
+    let botType;
+    if (settings.copilotBotType && settings.copilotBotType.trim() !== '') {
+        if (!Object.values(botType_1.BotType).includes(settings.copilotBotType)) {
+            throw new Error('Invalid BotType enum key');
+        }
+        else {
+            botType = botType_1.BotType[settings.copilotBotType];
+        }
+    }
+    else {
+        botType = botType_1.BotType.Published;
+    }
+    settings.customPowerPlatformCloud = isNotEmptyCustomPowerPlatformCloud ? settings.customPowerPlatformCloud : 'api.unknown.powerplatform.com';
+    const host = getEnvironmentEndpoint(cloudValue, settings.environmentId, settings.customPowerPlatformCloud);
+    return createUri(settings.botIdentifier, host, botType, conversationId);
+}
+function isValidUri(uri) {
+    try {
+        const newUri = new URL(uri);
+        return !!newUri;
+    }
+    catch {
+        return false;
+    }
+}
+function createUri(botIdentifier, host, botType, conversationId) {
+    const botPathName = botType === botType_1.BotType.Published ? 'dataverse-backed' : 'prebuilt';
+    const url = new URL(`https://${host}`);
+    url.searchParams.set('api-version', ApiVersion);
+    if (!conversationId) {
+        url.pathname = `/copilotstudio/${botPathName}/authenticated/bots/${botIdentifier}/conversations`;
+    }
+    else {
+        url.pathname = `/copilotstudio/${botPathName}/authenticated/bots/${botIdentifier}/conversations/${conversationId}`;
+    }
+    return url.toString();
+}
+function getEnvironmentEndpoint(cloud, environmentId, cloudBaseAddress) {
+    if (cloud === powerPlatformCloud_1.PowerPlatformCloud.Other && (!cloudBaseAddress || !cloudBaseAddress.trim())) {
+        throw new Error('cloudBaseAddress must be provided when PowerPlatformCloud is Other');
+    }
+    cloudBaseAddress = cloudBaseAddress !== null && cloudBaseAddress !== void 0 ? cloudBaseAddress : 'api.unknown.powerplatform.com';
+    const normalizedResourceId = environmentId.toLowerCase().replaceAll('-', '');
+    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)}`;
+}
+function getEndpointSuffix(category, cloudBaseAddress) {
+    switch (category) {
+        case powerPlatformCloud_1.PowerPlatformCloud.Local:
+            return 'api.powerplatform.localhost';
+        case powerPlatformCloud_1.PowerPlatformCloud.Exp:
+            return 'api.exp.powerplatform.com';
+        case powerPlatformCloud_1.PowerPlatformCloud.Dev:
+            return 'api.dev.powerplatform.com';
+        case powerPlatformCloud_1.PowerPlatformCloud.Prv:
+            return 'api.prv.powerplatform.com';
+        case powerPlatformCloud_1.PowerPlatformCloud.Test:
+            return 'api.test.powerplatform.com';
+        case powerPlatformCloud_1.PowerPlatformCloud.Preprod:
+            return 'api.preprod.powerplatform.com';
+        case powerPlatformCloud_1.PowerPlatformCloud.FirstRelease:
+        case powerPlatformCloud_1.PowerPlatformCloud.Prod:
+            return 'api.powerplatform.com';
+        case powerPlatformCloud_1.PowerPlatformCloud.GovFR:
+            return 'api.gov.powerplatform.microsoft.us';
+        case powerPlatformCloud_1.PowerPlatformCloud.Gov:
+            return 'api.gov.powerplatform.microsoft.us';
+        case powerPlatformCloud_1.PowerPlatformCloud.High:
+            return 'api.high.powerplatform.microsoft.us';
+        case powerPlatformCloud_1.PowerPlatformCloud.DoD:
+            return 'api.appsplatform.us';
+        case powerPlatformCloud_1.PowerPlatformCloud.Mooncake:
+            return 'api.powerplatform.partner.microsoftonline.cn';
+        case powerPlatformCloud_1.PowerPlatformCloud.Ex:
+            return 'api.powerplatform.eaglex.ic.gov';
+        case powerPlatformCloud_1.PowerPlatformCloud.Rx:
+            return 'api.powerplatform.microsoft.scloud';
+        case powerPlatformCloud_1.PowerPlatformCloud.Other:
+            return cloudBaseAddress;
+        default:
+            throw new Error(`Invalid cluster category value: ${category}`);
+    }
+}
+function getIdSuffixLength(cloud) {
+    switch (cloud) {
+        case powerPlatformCloud_1.PowerPlatformCloud.FirstRelease:
+        case powerPlatformCloud_1.PowerPlatformCloud.Prod:
+            return 2;
+        default:
+            return 1;
+    }
+}
+//# sourceMappingURL=powerPlatformEnvironment.js.map

package/dist/src/powerPlatformEnvironment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"powerPlatformEnvironment.js","sourceRoot":"","sources":["../../src/powerPlatformEnvironment.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAeH,sEAyDC;AAtED,uCAAmC;AAEnC,6DAAyD;AAEzD,MAAM,UAAU,GAAW,oBAAoB,CAAA;AAE/C;;;;;;GAMG;AACH,SAAgB,6BAA6B,CAC3C,QAA4B,EAC5B,cAAuB;IAEvB,IAAI,UAAU,GAAuB,uCAAkB,CAAC,IAAI,CAAA;IAE5D,MAAM,eAAe,GAAG,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAA;IACtE,MAAM,kCAAkC,GAAG,QAAQ,CAAC,wBAAwB,KAAK,SAAS,IAAI,QAAQ,CAAC,wBAAwB,CAAC,IAAI,EAAE,KAAK,EAAE,CAAA;IAE7I,IAAI,eAAe,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,uCAAkB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACnF,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;IACxD,CAAC;IAED,MAAM,YAAY,GAAG,eAAe,CAAC,CAAC,CAAC,uCAAkB,CAAC,QAAQ,CAAC,KAAwC,CAAC,CAAC,CAAC,CAAC,uCAAkB,CAAC,OAAO,CAAA;IAEzI,IAAI,YAAY,KAAK,uCAAkB,CAAC,KAAK,IAAI,kCAAkC,EAAE,CAAC;QACpF,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAA;IAC/F,CAAC;IAED,IAAI,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACzC,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;IACnD,CAAC;IAED,IAAI,QAAQ,CAAC,aAAa,KAAK,SAAS,IAAI,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACjF,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;IACnD,CAAC;IAED,IAAI,YAAY,KAAK,uCAAkB,CAAC,OAAO,EAAE,CAAC;QAChD,UAAU,GAAG,YAAY,CAAA;IAC3B,CAAC;IAED,IAAI,YAAY,KAAK,uCAAkB,CAAC,KAAK,EAAE,CAAC;QAC9C,IAAI,kCAAkC,IAAI,UAAU,CAAC,QAAQ,CAAC,wBAAyB,CAAC,EAAE,CAAC;YACzF,UAAU,GAAG,uCAAkB,CAAC,KAAK,CAAA;QACvC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CACb,4EAA4E,CAC7E,CAAA;QACH,CAAC;IACH,CAAC;IAED,IAAI,OAAgB,CAAA;IAEpB,IAAI,QAAQ,CAAC,cAAc,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACrE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,iBAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAoC,CAAC,EAAE,CAAC;YACpF,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,iBAAO,CAAC,QAAQ,CAAC,cAAsC,CAAC,CAAA;QACpE,CAAC;IACH,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,iBAAO,CAAC,SAAS,CAAA;IAC7B,CAAC;IAED,QAAQ,CAAC,wBAAwB,GAAG,kCAAkC,CAAC,CAAC,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC,CAAC,+BAA+B,CAAA;IAE5I,MAAM,IAAI,GAAG,sBAAsB,CAAC,UAAU,EAAE,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,wBAAwB,CAAC,CAAA;IAC1G,OAAO,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;AACzE,CAAC;AAED,SAAS,UAAU,CAAE,GAAW;IAC9B,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAA;QAC3B,OAAO,CAAC,CAAC,MAAM,CAAA;IACjB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAChB,aAAqB,EACrB,IAAY,EACZ,OAAgB,EAChB,cAAuB;IAEvB,MAAM,WAAW,GAAG,OAAO,KAAK,iBAAO,CAAC,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,UAAU,CAAA;IAEnF,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC,CAAA;IACtC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,CAAA;IAE/C,IAAI,CAAC,cAAc,EAAE,CAAC;QACpB,GAAG,CAAC,QAAQ,GAAG,kBAAkB,WAAW,uBAAuB,aAAa,gBAAgB,CAAA;IAClG,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,QAAQ,GAAG,kBAAkB,WAAW,uBAAuB,aAAa,kBAAkB,cAAc,EAAE,CAAA;IACpH,CAAC;IAED,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAA;AACvB,CAAC;AAED,SAAS,sBAAsB,CAC7B,KAAyB,EACzB,aAAqB,EACrB,gBAAyB;IAEzB,IAAI,KAAK,KAAK,uCAAkB,CAAC,KAAK,IAAI,CAAC,CAAC,gBAAgB,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;QAC1F,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAA;IACvF,CAAC;IAED,gBAAgB,GAAG,gBAAgB,aAAhB,gBAAgB,cAAhB,gBAAgB,GAAI,+BAA+B,CAAA;IAEtE,MAAM,oBAAoB,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IAC5E,MAAM,cAAc,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAA;IAC/C,MAAM,SAAS,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC,EAAE,oBAAoB,CAAC,MAAM,GAAG,cAAc,CAAC,CAAA;IACjG,MAAM,SAAS,GAAG,oBAAoB,CAAC,SAAS,CAAC,oBAAoB,CAAC,MAAM,GAAG,cAAc,CAAC,CAAA;IAE9F,OAAO,GAAG,SAAS,IAAI,SAAS,gBAAgB,iBAAiB,CAAC,KAAK,EAAE,gBAAgB,CAAC,EAAE,CAAA;AAC9F,CAAC;AAED,SAAS,iBAAiB,CACxB,QAA4B,EAC5B,gBAAwB;IAExB,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,uCAAkB,CAAC,KAAK;YAC3B,OAAO,6BAA6B,CAAA;QACtC,KAAK,uCAAkB,CAAC,GAAG;YACzB,OAAO,2BAA2B,CAAA;QACpC,KAAK,uCAAkB,CAAC,GAAG;YACzB,OAAO,2BAA2B,CAAA;QACpC,KAAK,uCAAkB,CAAC,GAAG;YACzB,OAAO,2BAA2B,CAAA;QACpC,KAAK,uCAAkB,CAAC,IAAI;YAC1B,OAAO,4BAA4B,CAAA;QACrC,KAAK,uCAAkB,CAAC,OAAO;YAC7B,OAAO,+BAA+B,CAAA;QACxC,KAAK,uCAAkB,CAAC,YAAY,CAAC;QACrC,KAAK,uCAAkB,CAAC,IAAI;YAC1B,OAAO,uBAAuB,CAAA;QAChC,KAAK,uCAAkB,CAAC,KAAK;YAC3B,OAAO,oCAAoC,CAAA;QAC7C,KAAK,uCAAkB,CAAC,GAAG;YACzB,OAAO,oCAAoC,CAAA;QAC7C,KAAK,uCAAkB,CAAC,IAAI;YAC1B,OAAO,qCAAqC,CAAA;QAC9C,KAAK,uCAAkB,CAAC,GAAG;YACzB,OAAO,qBAAqB,CAAA;QAC9B,KAAK,uCAAkB,CAAC,QAAQ;YAC9B,OAAO,8CAA8C,CAAA;QACvD,KAAK,uCAAkB,CAAC,EAAE;YACxB,OAAO,iCAAiC,CAAA;QAC1C,KAAK,uCAAkB,CAAC,EAAE;YACxB,OAAO,oCAAoC,CAAA;QAC7C,KAAK,uCAAkB,CAAC,KAAK;YAC3B,OAAO,gBAAgB,CAAA;QACzB;YACE,MAAM,IAAI,KAAK,CAAC,mCAAmC,QAAQ,EAAE,CAAC,CAAA;IAClE,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CAAE,KAAyB;IACnD,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,uCAAkB,CAAC,YAAY,CAAC;QACrC,KAAK,uCAAkB,CAAC,IAAI;YAC1B,OAAO,CAAC,CAAA;QACV;YACE,OAAO,CAAC,CAAA;IACZ,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@microsoft/agents-copilotstudio-client",
+  "version": "0.1.25-gcaee57b821",
+  "homepage": "https://github.com/microsoft/Agents-for-js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/Agents-for-js"
+  },
+  "author": {
+    "name": "Microsoft",
+    "email": "agentssdk@microsoft.com",
+    "url": "https://aka.ms/Agents"
+  },
+  "description": "Microsoft Copilot Studio Client for JavaScript",
+  "keywords": [
+    "Agents",
+    "copilotstudio",
+    "powerplatform"
+  ],
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "dependencies": {
+    "@microsoft/agents-bot-activity": "0.1.25-gcaee57b821",
+    "axios": "^1.8.1",
+    "debug": "^4.3.7"
+  },
+  "license": "MIT",
+  "files": [
+    "README.md",
+    "dist/src",
+    "src"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/src/index.js",
+      "require": "./dist/src/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/src/botType.ts

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

package/src/connectionSettings.ts

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

package/src/copilotStudioClient.ts

@@ -0,0 +1,134 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ConnectionSettings } from './connectionSettings'
+import axios, { AxiosInstance, AxiosRequestConfig } from 'axios'
+import { getCopilotStudioConnectionUrl } from './powerPlatformEnvironment'
+import { Activity, ActivityTypes, ConversationAccount } from '@microsoft/agents-bot-activity'
+import { ExecuteTurnRequest } from './executeTurnRequest'
+import createDebug, { Debugger } from 'debug'
+
+interface streamRead {
+  done: boolean,
+  value: string
+}
+
+export class CopilotStudioClient {
+  /** The ID of the current conversation. */
+  private conversationId: string = ''
+  /** The connection settings for the client. */
+  private readonly settings: ConnectionSettings
+  /** The Axios instance used for HTTP requests. */
+  private readonly client: AxiosInstance
+  /** The logger for debugging. */
+  private readonly logger: Debugger
+
+  /**
+   * Creates an instance of CopilotStudioClient.
+   * @param settings The connection settings.
+   * @param token The authentication token.
+   */
+  constructor (settings: ConnectionSettings, token: string) {
+    this.settings = settings
+    this.client = axios.create()
+    this.client.defaults.headers.common.Authorization = `Bearer ${token}`
+    this.logger = createDebug('copilot-studio-client')
+  }
+
+  private async postRequestAsync (axiosConfig: AxiosRequestConfig): Promise<Activity[]> {
+    const activities: Activity[] = []
+    const response = await this.client(axiosConfig)
+    const stream = response.data
+    const reader = stream.pipeThrough(new TextDecoderStream()).getReader()
+    let result: string = ''
+    const results: string[] = []
+
+    const processEvents = async ({ done, value }: streamRead): Promise<string[]> => {
+      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: string[] = await reader.read().then(processEvents)
+
+    events.forEach(event => {
+      const values: string[] = event.toString().split('\n')
+      const validEvents = values.filter(e => e.substring(0, 4) === 'data' && e !== 'data: end\r')
+      validEvents.forEach(ve => {
+        try {
+          const act = Activity.fromJson(ve.substring(5, ve.length))
+          if (act.type === ActivityTypes.Message) {
+            activities.push(act)
+          } else {
+            this.logger('Activity type: ', act.type)
+          }
+        } catch (e) {
+          this.logger('Error: ', e)
+          throw e
+        }
+      })
+    })
+    return activities
+  }
+
+  public async startConversationAsync (emitStartConversationEvent: boolean = true): Promise<Activity> {
+    const uriStart: string = getCopilotStudioConnectionUrl(this.settings)
+    const body = { emitStartConversationEvent }
+
+    const config: AxiosRequestConfig = {
+      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 = act.conversation?.id!
+    return act
+  }
+
+  public async askQuestionAsync (question: string, conversationId: string = this.conversationId) {
+    const conversationAccount: ConversationAccount = {
+      id: conversationId
+    }
+    const activityObj = {
+      type: 'message',
+      text: question,
+      conversation: conversationAccount
+    }
+    const activity = Activity.fromObject(activityObj)
+
+    const localConversationId = activity.conversation?.id ?? conversationId
+    const uriExecute = getCopilotStudioConnectionUrl(this.settings, localConversationId)
+    const qbody: ExecuteTurnRequest = new ExecuteTurnRequest(activity)
+
+    const config: AxiosRequestConfig = {
+      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
+  }
+}

package/src/directToEngineConnectionSettings.ts

@@ -0,0 +1,23 @@
+/**
+ * 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/src/executeTurnRequest.ts

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

package/src/index.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/src/powerPlatformCloud.ts

@@ -0,0 +1,78 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Enum representing different Power Platform cloud environments.
+ */
+export 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
+}