Cherrypick backcompat for Copilot Studio Client into 1.1 release (#812)

* backwards compat for copilot studio client, plus lots of tests for both syntaxs

* rationalize some test cases

* correct method name

* correct method name

* correct method name

* merge

* remove console, fix Activity.fromObject in samples to include type

* merged

* Fix issue with conversationId in copilotstudio-console sample

---------

Co-authored-by: CeciliaAvila <cecilia.avila@southworks.com>

Author: benbrown

packages/agents-copilotstudio-client/src/copilotStudioClient.ts

@@ -160,7 +160,7 @@ export class CopilotStudioClient {
    * @param emitStartConversationEvent Whether to emit a start conversation event. Defaults to true.
    * @returns An async generator yielding the Agent's Activities.
    */
-  public async * startConversationAsync (emitStartConversationEvent: boolean = true): AsyncGenerator<Activity> {
+  public async * startConversationStreaming (emitStartConversationEvent: boolean = true): AsyncGenerator<Activity> {
     const uriStart: string = getCopilotStudioConnectionUrl(this.settings)
     const body = { emitStartConversationEvent }
 
@@ -169,15 +169,46 @@ export class CopilotStudioClient {
     yield * this.postRequestAsync(uriStart, body, 'POST')
   }
 
+  /**
+   * Sends an activity to the Copilot Studio service and retrieves the response activities.
+   * @param activity The activity to send.
+   * @param conversationId The ID of the conversation. Defaults to the current conversation ID.
+   * @returns An async generator yielding the Agent's Activities.
+   */
+  public async * sendActivityStreaming (activity: Activity, conversationId: string = this.conversationId) : AsyncGenerator<Activity> {
+    const localConversationId = activity.conversation?.id ?? conversationId
+    const uriExecute = getCopilotStudioConnectionUrl(this.settings, localConversationId)
+    const qbody: ExecuteTurnRequest = new ExecuteTurnRequest(activity)
+
+    logger.info('Sending activity...', activity)
+    yield * this.postRequestAsync(uriExecute, qbody, 'POST')
+  }
+
+  /**
+   * Starts a new conversation with the Copilot Studio service.
+   * @param emitStartConversationEvent Whether to emit a start conversation event. Defaults to true.
+   * @returns A promise yielding an array of activities.
+   * @deprecated Use startConversationStreaming instead.
+   */
+  public async startConversationAsync (emitStartConversationEvent: boolean = true): Promise<Activity[]> {
+    const result: Activity[] = []
+    for await (const value of this.startConversationStreaming(emitStartConversationEvent)) {
+      result.push(value)
+    }
+    return result
+  }
+
   /**
    * 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 An async generator yielding the Agent's Activities.
+   * @returns A promise yielding an array of activities.
+   * @deprecated Use sendActivityStreaming instead.
    */
-  public async * askQuestionAsync (question: string, conversationId: string = this.conversationId) : AsyncGenerator<Activity> {
+  public async askQuestionAsync (question: string, conversationId?: string) : Promise<Activity[]> {
+    const localConversationId = conversationId?.trim() ? conversationId : this.conversationId
     const conversationAccount: ConversationAccount = {
-      id: conversationId
+      id: localConversationId
     }
     const activityObj = {
       type: 'message',
@@ -186,21 +217,25 @@ export class CopilotStudioClient {
     }
     const activity = Activity.fromObject(activityObj)
 
-    yield * this.sendActivity(activity)
+    const result: Activity[] = []
+    for await (const value of this.sendActivityStreaming(activity, conversationId)) {
+      result.push(value)
+    }
+    return result
   }
 
   /**
    * Sends an activity to the Copilot Studio service and retrieves the response activities.
    * @param activity The activity to send.
    * @param conversationId The ID of the conversation. Defaults to the current conversation ID.
-   * @returns An async generator yielding the Agent's Activities.
+   * @returns A promise yielding an array of activities.
+   * @deprecated Use sendActivityStreaming instead.
    */
-  public async * sendActivity (activity: Activity, conversationId: string = this.conversationId) : AsyncGenerator<Activity> {
-    const localConversationId = activity.conversation?.id ?? conversationId
-    const uriExecute = getCopilotStudioConnectionUrl(this.settings, localConversationId)
-    const qbody: ExecuteTurnRequest = new ExecuteTurnRequest(activity)
-
-    logger.info('Sending activity...', activity)
-    yield * this.postRequestAsync(uriExecute, qbody, 'POST')
+  public async sendActivity (activity: Activity, conversationId: string = this.conversationId) : Promise<Activity[]> {
+    const result: Activity[] = []
+    for await (const value of this.sendActivityStreaming(activity, conversationId)) {
+      result.push(value)
+    }
+    return result
   }
 }

packages/agents-copilotstudio-client/src/copilotStudioWebChat.ts

@@ -219,7 +219,7 @@ export class CopilotStudioWebChat {
       logger.debug('--> Connection established.')
       notifyTyping()
 
-      for await (const activity of client.startConversationAsync()) {
+      for await (const activity of client.startConversationStreaming()) {
         delete activity.replyToId
         conversation = activity.conversation
         notifyActivity(activity)
@@ -281,7 +281,7 @@ export class CopilotStudioWebChat {
             subscriber.next(newActivity.id!)
 
             // Stream the agent's response, but don't block the UI
-            for await (const responseActivity of client.sendActivity(newActivity)) {
+            for await (const responseActivity of client.sendActivityStreaming(newActivity)) {
               notifyActivity(responseActivity)
               logger.info('<-- Activity received correctly from Copilot Studio.')
             }