Merge branch 'main' into cg/cardGazer-4o

Author: corinagum

.github/workflows/coverage.yml

@@ -34,7 +34,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
       - name: Setup NodeJS ${{ env.node-version }}
-        uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+        uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
         with:
           node-version: ${{ env.node-version }}
       - name: Install Dependencies

.github/workflows/dotnet-codeql.yml

@@ -39,7 +39,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@8214744c546c1e5c8f03dde8fab3a7353211988d # v3.26.7
+        uses: github/codeql-action/init@294a9d92911152fe08befb9ec03e240add280cb3 # v3.26.8
         with:
           languages: csharp
       - name: Setup .NET
@@ -50,6 +50,6 @@ jobs:
         working-directory: dotnet/packages/Microsoft.TeamsAI/
         run: dotnet build Microsoft.Teams.AI.sln --configuration Release
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@8214744c546c1e5c8f03dde8fab3a7353211988d # v3.26.7
+        uses: github/codeql-action/analyze@294a9d92911152fe08befb9ec03e240add280cb3 # v3.26.8
         with:
           category: "/language:csharp"

.github/workflows/js-build-test-lint.yml

@@ -30,7 +30,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
       - name: Setup NodeJS ${{ matrix.node-version }}
-        uses: actions/setup-node@1e60f620b9541d16bece96c5465dc8ee9832be0b # v4.0.3
+        uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
         with:
           node-version: ${{ matrix.node-version }}
       - name: Install Dependencies

.github/workflows/js-codeql.yml

@@ -38,10 +38,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@8214744c546c1e5c8f03dde8fab3a7353211988d # v3.26.7
+        uses: github/codeql-action/init@294a9d92911152fe08befb9ec03e240add280cb3 # v3.26.8
         with:
           languages: javascript
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@8214744c546c1e5c8f03dde8fab3a7353211988d # v3.26.7
+        uses: github/codeql-action/analyze@294a9d92911152fe08befb9ec03e240add280cb3 # v3.26.8
         with:
           category: "/language:javascript"

.github/workflows/python-codeql.yml

@@ -38,10 +38,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@8214744c546c1e5c8f03dde8fab3a7353211988d # v3.26.7
+        uses: github/codeql-action/init@294a9d92911152fe08befb9ec03e240add280cb3 # v3.26.8
         with:
           languages: python
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@8214744c546c1e5c8f03dde8fab3a7353211988d # v3.26.7
+        uses: github/codeql-action/analyze@294a9d92911152fe08befb9ec03e240add280cb3 # v3.26.8
         with:
           category: "/language:python"

.github/workflows/scorecards.yml

@@ -66,6 +66,6 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@8214744c546c1e5c8f03dde8fab3a7353211988d # v3.26.7
+        uses: github/codeql-action/upload-sarif@294a9d92911152fe08befb9ec03e240add280cb3 # v3.26.8
         with:
           sarif_file: results.sarif

js/package.json

@@ -20,7 +20,7 @@
         "test:nyc:report": "npx rimraf coverage && yarn test:mocha && nyc report"
     },
     "dependencies": {
-        "botbuilder": "^4.23.0",
+        "botbuilder": "^4.23.1",
         "openai": "4.61.0"
     },
     "devDependencies": {
@@ -29,7 +29,7 @@
         "@microsoft/api-extractor": "^7.47.7",
         "@standardlabs/is-private": "^1.0.1",
         "@types/jsonwebtoken": "9.0.4",
-        "@types/lodash": "^4.17.7",
+        "@types/lodash": "^4.17.9",
         "@types/mocha": "^10.0.7",
         "@types/node": "^20.16.1",
         "@types/sinon": "^10.0.19",

js/packages/teams-ai/package.json

@@ -2,7 +2,7 @@
     "name": "@microsoft/teams-ai",
     "author": "Microsoft Corp.",
     "description": "SDK focused on building AI based applications for Microsoft Teams.",
-    "version": "1.4.1",
+    "version": "1.5.0",
     "license": "MIT",
     "keywords": [
         "botbuilder",
@@ -29,14 +29,14 @@
         "openai": "^4.61.0"
     },
     "dependencies": {
-        "@azure/openai-assistants": "1.0.0-beta.5",
-        "@azure/msal-node": "^2.13.1",
+        "@azure/openai-assistants": "1.0.0-beta.6",
+        "@azure/msal-node": "^2.14.0",
         "axios": "^1.7.5",
-        "botbuilder-dialogs": "^4.23.0",
+        "botbuilder-dialogs": "^4.23.1",
         "botframework-connector": "^4.23.0",
         "botframework-schema": "^4.23.0",
         "botframework-streaming": "^4.23.0",
-        "gpt-tokenizer": "^2.2.1",
+        "gpt-tokenizer": "^2.4.0",
         "json-colorizer": "^2.2.2",
         "jsonschema": "1.4.1",
         "uuid": "^9.0.1",

js/packages/teams-ai/src/StreamingResponse.spec.ts

@@ -1,5 +1,6 @@
 import assert from 'assert';
 import { TestAdapter } from 'botbuilder';
+import { CardFactory } from 'botbuilder-core';
 import { StreamingResponse } from './StreamingResponse';
 
 describe('StreamingResponse', function () {
@@ -157,5 +158,48 @@ describe('StreamingResponse', function () {
                 );
             });
         });
+
+        it('should send a final message with text and attachments', async () => {
+            const adapter = new TestAdapter();
+            const adaptiveCard = {
+                $schema: 'http://adaptivecards.io/schemas/adaptive-card.json',
+                version: '1.6',
+                type: 'AdaptiveCard',
+                body: [
+                    {
+                        text: 'This is an example of an attachment..',
+                        wrap: true,
+                        type: 'TextBlock'
+                    }
+                ]
+            };
+            await adapter.sendTextToBot('test', async (context) => {
+                const response = new StreamingResponse(context);
+                response.queueTextChunk('first');
+                response.queueTextChunk('second');
+                await response.waitForQueue();
+                await response.setAttachments([CardFactory.adaptiveCard(adaptiveCard)]);
+                await response.endStream();
+                assert(response.updatesSent == 2, 'updatesSent should be 2');
+
+                // Validate sent activities
+                const activities = adapter.activeQueue;
+                assert.equal(activities.length, 3, 'should have sent 3 activities');
+                assert.equal(activities[0].channelData.streamSequence, 1, 'first activity streamSequence should be 1');
+                assert.equal(activities[1].channelData.streamSequence, 2, 'second activity streamSequence should be 2');
+                assert.equal(activities[2].type, 'message', 'final activity type should be "message"');
+                assert.equal(activities[2].text, 'firstsecond', 'final activity text should be "firstsecond"');
+                assert.deepEqual(
+                    activities[2].channelData,
+                    { streamType: 'final', streamId: response.streamId },
+                    'final activity channelData should match'
+                );
+                assert.notEqual(activities[2].attachments, null);
+                if (activities[2].attachments) {
+                    assert.equal(activities[2].attachments.length, 1, 'should have 1 attachment');
+                    assert.deepEqual(activities[2].attachments[0].content, adaptiveCard, 'adaptive card should match');
+                }
+            });
+        });
     });
 });

js/packages/teams-ai/src/StreamingResponse.ts

@@ -6,7 +6,7 @@
  * Licensed under the MIT License.
  */
 
-import { Activity, TurnContext } from 'botbuilder-core';
+import { Activity, Attachment, TurnContext } from 'botbuilder-core';
 
 /**
  * A helper class for streaming responses to the client.
@@ -23,6 +23,7 @@ export class StreamingResponse {
     private _nextSequence: number = 1;
     private _streamId?: string;
     private _message: string = '';
+    private _attachments?: Attachment[];
     private _ended = false;
 
     // Queue for outgoing activities
@@ -113,6 +114,22 @@ export class StreamingResponse {
         return this._queueSync!;
     }
 
+    /**
+     * Sets the attachments to attach to the final chunk.
+     * @param attachments List of attachments.
+     */
+    public setAttachments(attachments: Attachment[]): void {
+        this._attachments = attachments;
+    }
+
+    /**
+     * Returns the most recently streamed message.
+     * @returns The streamed message.
+     */
+    public getMessage(): string {
+        return this._message;
+    }
+
     /**
      * Waits for the outgoing activity queue to be empty.
      * @returns {Promise<void>} - A promise representing the async operation.
@@ -140,6 +157,7 @@ export class StreamingResponse {
                 return {
                     type: 'message',
                     text: this._message,
+                    attachments: this._attachments,
                     channelData: {
                         streamType: 'final'
                     } as StreamingChannelData