[JS] feat: add user agent override and internalize BotAdapter

js/packages/teams-ai/package.json

@@ -65,7 +65,6 @@
     },
     "files": [
         "_ts3.4",
-        "lib",
-        "src"
+        "lib"
     ]
 }

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

@@ -1,5 +1,5 @@
 import { strict as assert } from 'assert';
-import { Activity, ActivityTypes, Channels, MemoryStorage, MessageReactionTypes, TestAdapter } from 'botbuilder';
+import { Activity, ActivityTypes, Channels, CloudAdapter, MemoryStorage, MessageReactionTypes, TestAdapter } from 'botbuilder';
 import {
     Application,
     ApplicationBuilder,
@@ -123,6 +123,17 @@ describe('Application', () => {
         });
     });
 
+    describe('botAuthentication', () => {
+        const app = new Application({
+            botAuthentication: { }
+        });
+
+        it('should initialize `CloudAdapter`', () => {
+            assert.doesNotThrow(() => app.adapter);
+            assert.equal(app.adapter instanceof CloudAdapter, true);
+        });
+    });
+
     describe('adaptiveCards', () => {
         it('should return the adaptiveCards property', () => {
             const app = new Application();

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

@@ -11,15 +11,25 @@ import {
     Activity,
     ActivityTypes,
     BotAdapter,
+    CloudAdapter,
+    ConfigurationBotFrameworkAuthentication,
+    ConfigurationBotFrameworkAuthenticationOptions,
     ConversationReference,
     FileConsentCardResponse,
     O365ConnectorCardActionQuery,
     ResourceResponse,
     Storage,
     TurnContext
 } from 'botbuilder';
-import { ReadReceiptInfo } from 'botframework-connector';
 
+import {
+    AuthenticationConfiguration,
+    ConnectorClientOptions,
+    ReadReceiptInfo,
+    ServiceClientCredentialsFactory
+} from 'botframework-connector';
+
+import packageInfo from '../package.json';
 import { AdaptiveCards, AdaptiveCardsOptions } from './AdaptiveCards';
 import { AI, AIOptions } from './AI';
 import { Meetings } from './Meetings';
@@ -40,6 +50,11 @@ import {
  */
 const TYPING_TIMER_DELAY = 1000;
 
+/**
+ * @private
+ */
+const USER_AGENT = `${packageInfo.name}/${packageInfo.version}`;
+
 /**
  * Query arguments for a search-based message extension.
  * @template TParams Type of the query parameters.
@@ -68,6 +83,8 @@ export interface Query<TParams extends Record<string, any>> {
 export interface ApplicationOptions<TState extends TurnState> {
     /**
      * Optional. Bot adapter being used.
+     * @deprecated
+     * since version 1.0.2, use `botAuthentication` instead
      * @remarks
      * If using the `longRunningMessages` option or calling the continueConversationAsync() method,
      * this property is required.
@@ -87,6 +104,17 @@ export interface ApplicationOptions<TState extends TurnState> {
      */
     botAppId?: string;
 
+    /**
+     * Optional. Bot authentication configuration
+     */
+    botAuthentication?: {
+        botFrameworkAuthConfig?: ConfigurationBotFrameworkAuthenticationOptions;
+        credentialsFactory?: ServiceClientCredentialsFactory;
+        authConfiguration?: AuthenticationConfiguration;
+        botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+        connectorClientOptions?: ConnectorClientOptions;
+    };
+
     /**
      * Optional. Storage provider to use for the application.
      */
@@ -236,22 +264,31 @@ export class Application<TState extends TurnState = TurnState> {
      * @param {ApplicationOptions<TState>} options Optional. Options used to configure the application.
      */
     public constructor(options?: Partial<ApplicationOptions<TState>>) {
-        this._options = Object.assign(
-            {
-                removeRecipientMention: true,
-                startTypingTimer: true,
-                longRunningMessages: false
-            } as ApplicationOptions<TState>,
-            options
-        ) as ApplicationOptions<TState>;
-
-        this._adapter = this._options.adapter;
+        this._options = {
+            ...options,
+            turnStateFactory: options?.turnStateFactory || (() => new TurnState() as TState),
+            removeRecipientMention:
+                options?.removeRecipientMention !== undefined ? options.removeRecipientMention : true,
+            startTypingTimer: options?.startTypingTimer !== undefined ? options.startTypingTimer : true,
+            longRunningMessages: options?.longRunningMessages !== undefined ? options.longRunningMessages : false
+        };
 
         this._adapter = this._options.adapter;
 
-        // Create turn state factory
-        if (!this._options.turnStateFactory) {
-            this._options.turnStateFactory = () => new TurnState() as TState;
+        if (!this._adapter && this._options.botAuthentication) {
+            this._adapter = new CloudAdapter(
+                new ConfigurationBotFrameworkAuthentication(
+                    this._options.botAuthentication.botFrameworkAuthConfig || {},
+                    this._options.botAuthentication.credentialsFactory,
+                    this._options.botAuthentication.authConfiguration,
+                    this._options.botAuthentication.botFrameworkClientFetch,
+                    {
+                        ...(this._options.botAuthentication.connectorClientOptions || {}),
+                        userAgent: USER_AGENT,
+                        userAgentHeaderName: undefined
+                    }
+                )
+            );
         }
 
         // Create AI component if configured with a planner
@@ -366,6 +403,19 @@ export class Application<TState extends TurnState = TurnState> {
         return this._taskModules;
     }
 
+    /**
+     * Sets the bots error handler
+     * @param handler Function to call when an error is encountered.
+     * @returns {this} The application instance for chaining purposes.
+     */
+    public error(handler: (context: TurnContext, error: Error) => Promise<void>): this {
+        if (this._adapter) {
+            this._adapter.onTurnError = handler;
+        }
+
+        return this;
+    }
+
     /**
      * Adds a new route to the application.
      * @remarks