@microsoft/agents-copilotstudio-client 0.2.14 → 0.3.5

package/dist/src/copilotStudioClient.d.ts

@@ -21,6 +21,17 @@ export declare class CopilotStudioClient {
     constructor(settings: ConnectionSettings, token: string);
     private postRequestAsync;
     private static getProductInfo;
+    /**
+     * Starts a new conversation with the Copilot Studio service.
+     * @param emitStartConversationEvent Whether to emit a start conversation event. Defaults to true.
+     * @returns A promise that resolves to the initial activity of the conversation.
+     */
     startConversationAsync(emitStartConversationEvent?: boolean): Promise<Activity>;
+    /**
+     * Sends a question to the Copilot Studio service and retrieves the response activities.
+     * @param question The question to ask.
+     * @param conversationId The ID of the conversation. Defaults to the current conversation ID.
+     * @returns A promise that resolves to an array of activities containing the responses.
+     */
     askQuestionAsync(question: string, conversationId?: string): Promise<Activity[]>;
 }

package/dist/src/copilotStudioClient.js

@@ -72,6 +72,11 @@ class CopilotStudioClient {
     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()}`;
     }
+    /**
+     * Starts a new conversation with the Copilot Studio service.
+     * @param emitStartConversationEvent Whether to emit a start conversation event. Defaults to true.
+     * @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);
@@ -93,6 +98,12 @@ class CopilotStudioClient {
         this.conversationId = (_a = act.conversation) === null || _a === void 0 ? void 0 : _a.id;
         return act;
     }
+    /**
+     * Sends a question to the Copilot Studio service and retrieves the response activities.
+     * @param question The question to ask.
+     * @param conversationId The ID of the conversation. Defaults to the current conversation ID.
+     * @returns A promise that resolves to an array of activities containing the responses.
+     */
     async askQuestionAsync(question, conversationId = this.conversationId) {
         var _a, _b;
         const conversationAccount = {

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;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;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;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,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;AAzHD,kDAyHC"}
+{"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"}

package/dist/src/executeTurnRequest.d.ts

@@ -3,6 +3,10 @@
  * Licensed under the MIT License.
  */
 import { Activity } from '@microsoft/agents-activity';
+/**
+ * Represents a request to execute a turn in a conversation.
+ * This class encapsulates the activity to be executed during the turn.
+ */
 export declare class ExecuteTurnRequest {
     /** The activity to be executed. */
     activity?: Activity;

package/dist/src/executeTurnRequest.js

@@ -5,6 +5,10 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExecuteTurnRequest = void 0;
+/**
+ * Represents a request to execute a turn in a conversation.
+ * This class encapsulates the activity to be executed during the turn.
+ */
 class ExecuteTurnRequest {
     /**
      * Creates an instance of ExecuteTurnRequest.

package/dist/src/executeTurnRequest.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/agents-copilotstudio-client",
-  "version": "0.2.14",
+  "version": "0.3.5",
   "homepage": "https://github.com/microsoft/Agents-for-js",
   "repository": {
     "type": "git",
@@ -20,8 +20,8 @@
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
   "dependencies": {
-    "@microsoft/agents-activity": "0.2.14",
-    "axios": "^1.8.2",
+    "@microsoft/agents-activity": "0.3.5",
+    "axios": "^1.9.0",
     "debug": "^4.3.7"
   },
   "license": "MIT",

package/src/copilotStudioClient.ts

@@ -86,6 +86,11 @@ export class CopilotStudioClient {
     return `CopilotStudioClient.agents-sdk-js/${pjson.version} nodejs/${process.version}  ${os.platform()}-${os.arch()}/${os.release()}`
   }
 
+  /**
+   * Starts a new conversation with the Copilot Studio service.
+   * @param emitStartConversationEvent Whether to emit a start conversation event. Defaults to true.
+   * @returns A promise that resolves to the initial activity of the conversation.
+   */
   public async startConversationAsync (emitStartConversationEvent: boolean = true): Promise<Activity> {
     const uriStart: string = getCopilotStudioConnectionUrl(this.settings)
     const body = { emitStartConversationEvent }
@@ -109,6 +114,12 @@ export class CopilotStudioClient {
     return act
   }
 
+  /**
+   * Sends a question to the Copilot Studio service and retrieves the response activities.
+   * @param question The question to ask.
+   * @param conversationId The ID of the conversation. Defaults to the current conversation ID.
+   * @returns A promise that resolves to an array of activities containing the responses.
+   */
   public async askQuestionAsync (question: string, conversationId: string = this.conversationId) {
     const conversationAccount: ConversationAccount = {
       id: conversationId

package/src/executeTurnRequest.ts

@@ -5,6 +5,10 @@
 
 import { Activity } from '@microsoft/agents-activity'
 
+/**
+ * Represents a request to execute a turn in a conversation.
+ * This class encapsulates the activity to be executed during the turn.
+ */
 export class ExecuteTurnRequest {
   /** The activity to be executed. */
   activity?: Activity