@microsoft/agents-hosting 0.1.49

package/dist/src/auth/msalTokenProvider.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { AuthConfiguration } from './authConfiguration';
+import { AuthProvider } from './authProvider';
+/**
+ * Provides tokens using MSAL.
+ */
+export declare class MsalTokenProvider implements AuthProvider {
+    /**
+     * Gets an access token.
+     * @param authConfig The authentication configuration.
+     * @param scope The scope for the token.
+     * @returns A promise that resolves to the access token.
+     */
+    getAccessToken(authConfig: AuthConfiguration, scope: string): Promise<string>;
+    private readonly sysOptions;
+    /**
+     * Acquires a token using a user-assigned identity.
+     * @param authConfig The authentication configuration.
+     * @param scope The scope for the token.
+     * @returns A promise that resolves to the access token.
+     */
+    private acquireTokenWithUserAssignedIdentity;
+    /**
+     * Acquires a token using a certificate.
+     * @param authConfig The authentication configuration.
+     * @param scope The scope for the token.
+     * @returns A promise that resolves to the access token.
+     */
+    private acquireTokenWithCertificate;
+    /**
+     * Acquires a token using a client secret.
+     * @param authConfig The authentication configuration.
+     * @param scope The scope for the token.
+     * @returns A promise that resolves to the access token.
+     */
+    private acquireAccessTokenViaSecret;
+    /**
+     * Acquires a token using a FIC client assertion.
+     * @param authConfig The authentication configuration.
+     * @param scope The scope for the token.
+     * @returns A promise that resolves to the access token.
+     */
+    private acquireAccessTokenViaFIC;
+    /**
+     * Fetches an external token.
+     * @param FICClientId The FIC client ID.
+     * @returns A promise that resolves to the external token.
+     */
+    private fetchExternalToken;
+}

package/dist/src/auth/msalTokenProvider.js

@@ -0,0 +1,198 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MsalTokenProvider = void 0;
+const msal_node_1 = require("@azure/msal-node");
+const logger_1 = require("../logger");
+const uuid_1 = require("uuid");
+const fs_1 = __importDefault(require("fs"));
+const crypto_1 = __importDefault(require("crypto"));
+const audience = 'api://AzureADTokenExchange';
+const logger = (0, logger_1.debug)('agents:msal-token-provider');
+/**
+ * Provides tokens using MSAL.
+ */
+class MsalTokenProvider {
+    constructor() {
+        this.sysOptions = {
+            loggerOptions: {
+                logLevel: msal_node_1.LogLevel.Trace,
+                loggerCallback: (level, message, containsPii) => {
+                    if (containsPii) {
+                        return;
+                    }
+                    switch (level) {
+                        case msal_node_1.LogLevel.Error:
+                            logger.error(message);
+                            return;
+                        case msal_node_1.LogLevel.Info:
+                            logger.info(message);
+                            return;
+                        case msal_node_1.LogLevel.Warning:
+                            logger.warn(message);
+                            return;
+                        case msal_node_1.LogLevel.Verbose:
+                            logger.debug(message);
+                    }
+                },
+                piiLoggingEnabled: false
+            }
+        };
+    }
+    /**
+     * Gets an access token.
+     * @param authConfig The authentication configuration.
+     * @param scope The scope for the token.
+     * @returns A promise that resolves to the access token.
+     */
+    async getAccessToken(authConfig, scope) {
+        if (!authConfig.clientId && process.env.NODE_ENV !== 'production') {
+            return '';
+        }
+        let token;
+        if (authConfig.FICClientId !== undefined) {
+            token = await this.acquireAccessTokenViaFIC(authConfig, scope);
+        }
+        else if (authConfig.clientSecret !== undefined) {
+            token = await this.acquireAccessTokenViaSecret(authConfig, scope);
+        }
+        else if (authConfig.certPemFile !== undefined &&
+            authConfig.certKeyFile !== undefined) {
+            token = await this.acquireTokenWithCertificate(authConfig, scope);
+        }
+        else if (authConfig.clientSecret === undefined &&
+            authConfig.certPemFile === undefined &&
+            authConfig.certKeyFile === undefined) {
+            token = await this.acquireTokenWithUserAssignedIdentity(authConfig, scope);
+        }
+        else {
+            throw new Error('Invalid authConfig. ');
+        }
+        if (token === undefined) {
+            throw new Error('Failed to acquire token');
+        }
+        return token;
+    }
+    /**
+     * Acquires a token using a user-assigned identity.
+     * @param authConfig The authentication configuration.
+     * @param scope The scope for the token.
+     * @returns A promise that resolves to the access token.
+     */
+    async acquireTokenWithUserAssignedIdentity(authConfig, scope) {
+        const mia = new msal_node_1.ManagedIdentityApplication({
+            managedIdentityIdParams: {
+                userAssignedClientId: authConfig.clientId || ''
+            },
+            system: this.sysOptions
+        });
+        const token = await mia.acquireToken({
+            resource: scope
+        });
+        return token === null || token === void 0 ? void 0 : token.accessToken;
+    }
+    /**
+     * Acquires a token using a certificate.
+     * @param authConfig The authentication configuration.
+     * @param scope The scope for the token.
+     * @returns A promise that resolves to the access token.
+     */
+    async acquireTokenWithCertificate(authConfig, scope) {
+        const privateKeySource = fs_1.default.readFileSync(authConfig.certKeyFile);
+        const privateKeyObject = crypto_1.default.createPrivateKey({
+            key: privateKeySource,
+            format: 'pem'
+        });
+        const privateKey = privateKeyObject.export({
+            format: 'pem',
+            type: 'pkcs8'
+        });
+        const pubKeyObject = new crypto_1.default.X509Certificate(fs_1.default.readFileSync(authConfig.certPemFile));
+        const cca = new msal_node_1.ConfidentialClientApplication({
+            auth: {
+                clientId: authConfig.clientId || '',
+                authority: `https://login.microsoftonline.com/${authConfig.tenantId || 'botframework.com'}`,
+                clientCertificate: {
+                    privateKey: privateKey,
+                    thumbprint: pubKeyObject.fingerprint.replaceAll(':', ''),
+                    x5c: Buffer.from(authConfig.certPemFile, 'base64').toString()
+                }
+            },
+            system: this.sysOptions
+        });
+        const token = await cca.acquireTokenByClientCredential({
+            scopes: [`${scope}/.default`],
+            correlationId: (0, uuid_1.v4)()
+        });
+        return token === null || token === void 0 ? void 0 : token.accessToken;
+    }
+    /**
+     * Acquires a token using a client secret.
+     * @param authConfig The authentication configuration.
+     * @param scope The scope for the token.
+     * @returns A promise that resolves to the access token.
+     */
+    async acquireAccessTokenViaSecret(authConfig, scope) {
+        const cca = new msal_node_1.ConfidentialClientApplication({
+            auth: {
+                clientId: authConfig.clientId,
+                authority: `https://login.microsoftonline.com/${authConfig.tenantId || 'botframework.com'}`,
+                clientSecret: authConfig.clientSecret
+            },
+            system: this.sysOptions
+        });
+        const token = await cca.acquireTokenByClientCredential({
+            scopes: [`${scope}/.default`],
+            correlationId: (0, uuid_1.v4)()
+        });
+        return token === null || token === void 0 ? void 0 : token.accessToken;
+    }
+    /**
+     * Acquires a token using a FIC client assertion.
+     * @param authConfig The authentication configuration.
+     * @param scope The scope for the token.
+     * @returns A promise that resolves to the access token.
+     */
+    async acquireAccessTokenViaFIC(authConfig, scope) {
+        const scopes = [`${scope}/.default`];
+        const clientAssertion = await this.fetchExternalToken(authConfig.FICClientId);
+        const cca = new msal_node_1.ConfidentialClientApplication({
+            auth: {
+                clientId: authConfig.clientId,
+                authority: `https://login.microsoftonline.com/${authConfig.tenantId}`,
+                clientAssertion
+            },
+            system: this.sysOptions
+        });
+        const token = await cca.acquireTokenByClientCredential({ scopes });
+        logger.info('got token using FIC client assertion');
+        return token === null || token === void 0 ? void 0 : token.accessToken;
+    }
+    /**
+     * Fetches an external token.
+     * @param FICClientId The FIC client ID.
+     * @returns A promise that resolves to the external token.
+     */
+    async fetchExternalToken(FICClientId) {
+        const managedIdentityClientAssertion = new msal_node_1.ManagedIdentityApplication({
+            managedIdentityIdParams: {
+                userAssignedClientId: FICClientId
+            },
+            system: this.sysOptions
+        });
+        const response = await managedIdentityClientAssertion.acquireToken({
+            resource: audience,
+            forceRefresh: true
+        });
+        logger.info('got token for FIC');
+        return response.accessToken;
+    }
+}
+exports.MsalTokenProvider = MsalTokenProvider;
+//# sourceMappingURL=msalTokenProvider.js.map

package/dist/src/auth/msalTokenProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"msalTokenProvider.js","sourceRoot":"","sources":["../../../src/auth/msalTokenProvider.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;AAEH,gDAAyH;AAGzH,sCAAiC;AACjC,+BAAyB;AAEzB,4CAAmB;AACnB,oDAA2B;AAE3B,MAAM,QAAQ,GAAG,4BAA4B,CAAA;AAC7C,MAAM,MAAM,GAAG,IAAA,cAAK,EAAC,4BAA4B,CAAC,CAAA;AAElD;;GAEG;AACH,MAAa,iBAAiB;IAA9B;QAiCmB,eAAU,GAAsB;YAC/C,aAAa,EAAE;gBACb,QAAQ,EAAE,oBAAQ,CAAC,KAAK;gBACxB,cAAc,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE;oBAC9C,IAAI,WAAW,EAAE,CAAC;wBAChB,OAAM;oBACR,CAAC;oBACD,QAAQ,KAAK,EAAE,CAAC;wBACd,KAAK,oBAAQ,CAAC,KAAK;4BACjB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;4BACrB,OAAM;wBACR,KAAK,oBAAQ,CAAC,IAAI;4BAChB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;4BACpB,OAAM;wBACR,KAAK,oBAAQ,CAAC,OAAO;4BACnB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;4BACpB,OAAM;wBACR,KAAK,oBAAQ,CAAC,OAAO;4BACnB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;oBACzB,CAAC;gBACH,CAAC;gBACD,iBAAiB,EAAE,KAAK;aACzB;SACF,CAAA;IA6HH,CAAC;IApLC;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAE,UAA6B,EAAE,KAAa;QAChE,IAAI,CAAC,UAAU,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE,CAAC;YAClE,OAAO,EAAE,CAAA;QACX,CAAC;QACD,IAAI,KAAK,CAAA;QACT,IAAI,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACzC,KAAK,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QAChE,CAAC;aAAM,IAAI,UAAU,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YACjD,KAAK,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QACnE,CAAC;aAAM,IAAI,UAAU,CAAC,WAAW,KAAK,SAAS;YAC7C,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACvC,KAAK,GAAG,MAAM,IAAI,CAAC,2BAA2B,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QACnE,CAAC;aAAM,IAAI,UAAU,CAAC,YAAY,KAAK,SAAS;YAC9C,UAAU,CAAC,WAAW,KAAK,SAAS;YACpC,UAAU,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACvC,KAAK,GAAG,MAAM,IAAI,CAAC,oCAAoC,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QAC5E,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;QACzC,CAAC;QACD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;QAC5C,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IA2BD;;;;;OAKG;IACK,KAAK,CAAC,oCAAoC,CAAE,UAA6B,EAAE,KAAa;QAC9F,MAAM,GAAG,GAAG,IAAI,sCAA0B,CAAC;YACzC,uBAAuB,EAAE;gBACvB,oBAAoB,EAAE,UAAU,CAAC,QAAQ,IAAI,EAAE;aAChD;YACD,MAAM,EAAE,IAAI,CAAC,UAAU;SACxB,CAAC,CAAA;QACF,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,YAAY,CAAC;YACnC,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAA;QACF,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,WAAW,CAAA;IAC3B,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,2BAA2B,CAAE,UAA6B,EAAE,KAAa;QACrF,MAAM,gBAAgB,GAAG,YAAE,CAAC,YAAY,CAAC,UAAU,CAAC,WAAqB,CAAC,CAAA;QAE1E,MAAM,gBAAgB,GAAG,gBAAM,CAAC,gBAAgB,CAAC;YAC/C,GAAG,EAAE,gBAAgB;YACrB,MAAM,EAAE,KAAK;SACd,CAAC,CAAA;QAEF,MAAM,UAAU,GAAG,gBAAgB,CAAC,MAAM,CAAC;YACzC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,OAAO;SACd,CAAC,CAAA;QAEF,MAAM,YAAY,GAAG,IAAI,gBAAM,CAAC,eAAe,CAAC,YAAE,CAAC,YAAY,CAAC,UAAU,CAAC,WAAqB,CAAC,CAAC,CAAA;QAElG,MAAM,GAAG,GAAG,IAAI,yCAA6B,CAAC;YAC5C,IAAI,EAAE;gBACJ,QAAQ,EAAE,UAAU,CAAC,QAAQ,IAAI,EAAE;gBACnC,SAAS,EAAE,qCAAqC,UAAU,CAAC,QAAQ,IAAI,kBAAkB,EAAE;gBAC3F,iBAAiB,EAAE;oBACjB,UAAU,EAAE,UAAoB;oBAChC,UAAU,EAAE,YAAY,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;oBACxD,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,WAAqB,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE;iBACxE;aACF;YACD,MAAM,EAAE,IAAI,CAAC,UAAU;SACxB,CAAC,CAAA;QACF,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,8BAA8B,CAAC;YACrD,MAAM,EAAE,CAAC,GAAG,KAAK,WAAW,CAAC;YAC7B,aAAa,EAAE,IAAA,SAAE,GAAE;SACpB,CAAC,CAAA;QACF,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,WAAqB,CAAA;IACrC,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,2BAA2B,CAAE,UAA6B,EAAE,KAAa;QACrF,MAAM,GAAG,GAAG,IAAI,yCAA6B,CAAC;YAC5C,IAAI,EAAE;gBACJ,QAAQ,EAAE,UAAU,CAAC,QAAkB;gBACvC,SAAS,EAAE,qCAAqC,UAAU,CAAC,QAAQ,IAAI,kBAAkB,EAAE;gBAC3F,YAAY,EAAE,UAAU,CAAC,YAAY;aACtC;YACD,MAAM,EAAE,IAAI,CAAC,UAAU;SACxB,CAAC,CAAA;QACF,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,8BAA8B,CAAC;YACrD,MAAM,EAAE,CAAC,GAAG,KAAK,WAAW,CAAC;YAC7B,aAAa,EAAE,IAAA,SAAE,GAAE;SACpB,CAAC,CAAA;QACF,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,WAAqB,CAAA;IACrC,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,wBAAwB,CAAE,UAA6B,EAAE,KAAa;QAClF,MAAM,MAAM,GAAG,CAAC,GAAG,KAAK,WAAW,CAAC,CAAA;QACpC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,WAAqB,CAAC,CAAA;QACvF,MAAM,GAAG,GAAG,IAAI,yCAA6B,CAAC;YAC5C,IAAI,EAAE;gBACJ,QAAQ,EAAE,UAAU,CAAC,QAAkB;gBACvC,SAAS,EAAE,qCAAqC,UAAU,CAAC,QAAQ,EAAE;gBACrE,eAAe;aAChB;YACD,MAAM,EAAE,IAAI,CAAC,UAAU;SACxB,CAAC,CAAA;QACF,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,8BAA8B,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QAClE,MAAM,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAA;QACnD,OAAO,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,WAAqB,CAAA;IACrC,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,kBAAkB,CAAE,WAAmB;QACnD,MAAM,8BAA8B,GAAG,IAAI,sCAA0B,CAAC;YACpE,uBAAuB,EAAE;gBACvB,oBAAoB,EAAE,WAAW;aAClC;YACD,MAAM,EAAE,IAAI,CAAC,UAAU;SACxB,CACA,CAAA;QACD,MAAM,QAAQ,GAAG,MAAM,8BAA8B,CAAC,YAAY,CAAC;YACjE,QAAQ,EAAE,QAAQ;YAClB,YAAY,EAAE,IAAI;SACnB,CAAC,CAAA;QACF,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;QAChC,OAAO,QAAQ,CAAC,WAAW,CAAA;IAC7B,CAAC;CACF;AArLD,8CAqLC"}

package/dist/src/auth/request.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { JwtPayload } from 'jsonwebtoken';
+/**
+ * Represents a Node.js HTTP Request, including the minimal set of use properties.
+ * Compatible with Restify, Express, and Node.js core http.
+ */
+export interface Request<Body extends Record<string, unknown> = Record<string, unknown>, Headers extends Record<string, string[] | string | undefined> = Record<string, string[] | string | undefined>> {
+    body?: Body;
+    headers: Headers;
+    method?: string;
+    user?: JwtPayload;
+}

package/dist/src/auth/request.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=request.js.map

package/dist/src/auth/request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/auth/request.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/dist/src/baseAdapter.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { AuthConfiguration } from './auth/authConfiguration';
+import { AuthProvider } from './auth/authProvider';
+import { Middleware, MiddlewareHandler, MiddlewareSet } from './middlewareSet';
+import { TurnContext } from './turnContext';
+import { Activity, ConversationReference } from '@microsoft/agents-activity';
+import { ResourceResponse } from './connector-client/resourceResponse';
+import { AttachmentData } from './connector-client/attachmentData';
+import { AttachmentInfo } from './connector-client/attachmentInfo';
+/**
+ * Base class for all adapters, providing middleware and error handling capabilities.
+ */
+export declare abstract class BaseAdapter {
+    protected middleware: MiddlewareSet;
+    private turnError;
+    readonly AgentIdentityKey: symbol;
+    readonly ConnectorClientKey: symbol;
+    readonly OAuthScopeKey: symbol;
+    authProvider: AuthProvider;
+    authConfig: AuthConfiguration;
+    /**
+     * Sends a set of activities to the conversation.
+     * @param context - The TurnContext for the current turn.
+     * @param activities - The activities to send.
+     * @returns A promise representing the array of ResourceResponses for the sent activities.
+     */
+    abstract sendActivities(context: TurnContext, activities: Activity[]): Promise<ResourceResponse[]>;
+    /**
+     * Updates an existing activity.
+     * @param context - The TurnContext for the current turn.
+     * @param activity - The activity to update.
+     * @returns A promise representing the ResourceResponse for the updated activity.
+     */
+    abstract updateActivity(context: TurnContext, activity: Activity): Promise<ResourceResponse | void>;
+    /**
+     * Deletes an existing activity.
+     * @param context - The TurnContext for the current turn.
+     * @param reference - The conversation reference of the activity to delete.
+     * @returns A promise representing the completion of the delete operation.
+     */
+    abstract deleteActivity(context: TurnContext, reference: Partial<ConversationReference>): Promise<void>;
+    /**
+     * Continues a conversation.
+     * @param reference - The conversation reference to continue.
+     * @param logic - The logic to execute.
+     * @returns A promise representing the completion of the continue operation.
+     */
+    abstract continueConversation(reference: Partial<ConversationReference>, logic: (revocableContext: TurnContext) => Promise<void>): Promise<void>;
+    /**
+     * Uploads an attachment.
+     * @param conversationId - The conversation ID.
+     * @param attachmentData - The attachment data.
+     * @returns A promise representing the ResourceResponse for the uploaded attachment.
+     */
+    abstract uploadAttachment(conversationId: string, attachmentData: AttachmentData): Promise<ResourceResponse>;
+    /**
+     * Gets attachment information.
+     * @param attachmentId - The attachment ID.
+     * @returns A promise representing the AttachmentInfo for the requested attachment.
+     */
+    abstract getAttachmentInfo(attachmentId: string): Promise<AttachmentInfo>;
+    /**
+     * Gets an attachment.
+     * @param attachmentId - The attachment ID.
+     * @param viewId - The view ID.
+     * @returns A promise representing the NodeJS.ReadableStream for the requested attachment.
+     */
+    abstract getAttachment(attachmentId: string, viewId: string): Promise<NodeJS.ReadableStream>;
+    get onTurnError(): (context: TurnContext, error: Error) => Promise<void>;
+    set onTurnError(value: (context: TurnContext, error: Error) => Promise<void>);
+    /**
+     * Adds middleware to the adapter's middleware pipeline.
+     * @param middlewares - The middleware to add.
+     * @returns The adapter instance.
+     */
+    use(...middlewares: Array<MiddlewareHandler | Middleware>): this;
+    private makeRevocable;
+    /**
+     * Runs the middleware pipeline in sequence.
+     * @param context - The TurnContext for the current turn.
+     * @param next - The next function to call in the pipeline.
+     * @returns A promise representing the completion of the middleware pipeline.
+     */
+    protected runMiddleware(context: TurnContext, next: (revocableContext: TurnContext) => Promise<void>): Promise<void>;
+}

package/dist/src/baseAdapter.js

@@ -0,0 +1,94 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseAdapter = void 0;
+const msalTokenProvider_1 = require("./auth/msalTokenProvider");
+const middlewareSet_1 = require("./middlewareSet");
+const logger_1 = require("./logger");
+const logger = (0, logger_1.debug)('agents:base-adapter');
+/**
+ * Base class for all adapters, providing middleware and error handling capabilities.
+ */
+class BaseAdapter {
+    constructor() {
+        this.middleware = new middlewareSet_1.MiddlewareSet();
+        this.turnError = async (context, error) => {
+            logger.error(`\n [onTurnError] unhandled error: ${error}`);
+            // Send a trace activity, which will be displayed in Bot Framework Emulator
+            await context.sendTraceActivity('OnTurnError Trace', `${error}`, 'https://www.botframework.com/schemas/error', 'TurnError');
+            // Send a message to the user
+            await context.sendActivity('The agent encountered an error or bug.');
+            await context.sendActivity('To continue to run this agent, please fix the source code.');
+        };
+        this.AgentIdentityKey = Symbol('AgentIdentity');
+        this.ConnectorClientKey = Symbol('ConnectorClient');
+        this.OAuthScopeKey = Symbol('OAuthScope');
+        this.authProvider = new msalTokenProvider_1.MsalTokenProvider();
+        this.authConfig = { issuers: [] };
+    }
+    get onTurnError() {
+        return this.turnError;
+    }
+    set onTurnError(value) {
+        this.turnError = value;
+    }
+    /**
+     * Adds middleware to the adapter's middleware pipeline.
+     * @param middlewares - The middleware to add.
+     * @returns The adapter instance.
+     */
+    use(...middlewares) {
+        this.middleware.use(...middlewares);
+        return this;
+    }
+    makeRevocable(target, handler) {
+        // Ensure proxy supported (some browsers don't)
+        if (typeof Proxy !== 'undefined' && Proxy.revocable) {
+            return Proxy.revocable(target, (handler != null) ? handler : {});
+        }
+        else {
+            return {
+                proxy: target,
+                revoke: () => {
+                    // noop
+                }
+            };
+        }
+    }
+    /**
+     * Runs the middleware pipeline in sequence.
+     * @param context - The TurnContext for the current turn.
+     * @param next - The next function to call in the pipeline.
+     * @returns A promise representing the completion of the middleware pipeline.
+     */
+    async runMiddleware(context, next) {
+        if (context && context.activity && context.activity.locale) {
+            context.locale = context.activity.locale;
+        }
+        const pContext = this.makeRevocable(context);
+        try {
+            await this.middleware.run(pContext.proxy, async () => await next(pContext.proxy));
+        }
+        catch (err) {
+            if (this.onTurnError) {
+                if (err instanceof Error) {
+                    await this.onTurnError(pContext.proxy, err);
+                }
+                else {
+                    throw new Error('Unknown error type');
+                }
+            }
+            else {
+                throw err;
+            }
+        }
+        finally {
+            pContext.revoke();
+        }
+    }
+}
+exports.BaseAdapter = BaseAdapter;
+//# sourceMappingURL=baseAdapter.js.map

package/dist/src/baseAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseAdapter.js","sourceRoot":"","sources":["../../src/baseAdapter.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,gEAA4D;AAC5D,mDAA8E;AAE9E,qCAAgC;AAMhC,MAAM,MAAM,GAAG,IAAA,cAAK,EAAC,qBAAqB,CAAC,CAAA;AAE3C;;GAEG;AACH,MAAsB,WAAW;IAAjC;QACY,eAAU,GAAkB,IAAI,6BAAa,EAAE,CAAA;QAEjD,cAAS,GAA0D,KAAK,EAAE,OAAoB,EAAE,KAAY,EAAE,EAAE;YACtH,MAAM,CAAC,KAAK,CAAC,qCAAqC,KAAK,EAAE,CAAC,CAAA;YAE1D,2EAA2E;YAC3E,MAAM,OAAO,CAAC,iBAAiB,CAC7B,mBAAmB,EACnB,GAAG,KAAK,EAAE,EACV,4CAA4C,EAC5C,WAAW,CACZ,CAAA;YAED,6BAA6B;YAC7B,MAAM,OAAO,CAAC,YAAY,CAAC,wCAAwC,CAAC,CAAA;YACpE,MAAM,OAAO,CAAC,YAAY,CAAC,4DAA4D,CAAC,CAAA;QAC1F,CAAC,CAAA;QAEQ,qBAAgB,GAAG,MAAM,CAAC,eAAe,CAAC,CAAA;QAC1C,uBAAkB,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAA;QAC9C,kBAAa,GAAG,MAAM,CAAC,YAAY,CAAC,CAAA;QAE7C,iBAAY,GAAiB,IAAI,qCAAiB,EAAE,CAAA;QACpD,eAAU,GAAsB,EAAE,OAAO,EAAE,EAAE,EAAE,CAAA;IAgIjD,CAAC;IApEC,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAED,IAAI,WAAW,CAAE,KAA4D;QAC3E,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;IACxB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAE,GAAG,WAAkD;QACxD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,CAAA;QAEnC,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,aAAa,CACnB,MAAS,EACT,OAAyB;QAEzB,+CAA+C;QAC/C,IAAI,OAAO,KAAK,KAAK,WAAW,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YACpD,OAAO,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;QAClE,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,GAAS,EAAE;oBACjB,OAAO;gBACT,CAAC;aACF,CAAA;QACH,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,aAAa,CAC3B,OAAoB,EACpB,IAAsD;QAEtD,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC3D,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAA;QAC1C,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;QAE5C,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;QACnF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACrB,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;oBACzB,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;gBAC7C,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAA;gBACvC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,CAAA;YACX,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,QAAQ,CAAC,MAAM,EAAE,CAAA;QACnB,CAAC;IACH,CAAC;CACF;AAxJD,kCAwJC"}

package/dist/src/cards/animationCard.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { CardAction } from '@microsoft/agents-activity';
+import { MediaUrl } from './mediaUrl';
+import { ThumbnailUrl } from './thumbnailUrl';
+/**
+ * Interface representing an Animation Card.
+ */
+export interface AnimationCard {
+    /** The title of the card. */
+    title: string;
+    /** The subtitle of the card. */
+    subtitle: string;
+    /** The text content of the card. */
+    text: string;
+    /** The image to be displayed on the card. */
+    image: ThumbnailUrl;
+    /** The media URLs or objects. */
+    media: MediaUrl[];
+    /** The buttons to be displayed on the card. */
+    buttons: CardAction[];
+    /** Indicates whether the card is shareable. */
+    shareable: boolean;
+    /** Indicates whether the card should auto-loop. */
+    autoloop: boolean;
+    /** Indicates whether the card should auto-start. */
+    autostart: boolean;
+    /** The aspect ratio of the card. */
+    aspect: string;
+    /** The duration of the animation. */
+    duration: string;
+    /** Additional value for the card. */
+    value: any;
+}

package/dist/src/cards/animationCard.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=animationCard.js.map

package/dist/src/cards/animationCard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"animationCard.js","sourceRoot":"","sources":["../../../src/cards/animationCard.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/dist/src/cards/audioCard.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { CardAction } from '@microsoft/agents-activity';
+import { MediaUrl } from './mediaUrl';
+import { ThumbnailUrl } from './thumbnailUrl';
+/**
+ * Interface representing an Audio Card.
+ */
+export interface AudioCard {
+    /** The title of the card. */
+    title: string;
+    /** The subtitle of the card. */
+    subtitle: string;
+    /** The text content of the card. */
+    text: string;
+    /** The image to be displayed on the card. */
+    image: ThumbnailUrl;
+    /** The media URLs or objects. */
+    media: MediaUrl[];
+    /** The buttons to be displayed on the card. */
+    buttons: CardAction[];
+    /** Indicates whether the card is shareable. */
+    shareable: boolean;
+    /** Indicates whether the card should auto-loop. */
+    autoloop: boolean;
+    /** Indicates whether the card should auto-start. */
+    autostart: boolean;
+    /** The aspect ratio of the card. */
+    aspect: string;
+    /** The duration of the audio. */
+    duration: string;
+    /** Additional value for the card. */
+    value: any;
+}

package/dist/src/cards/audioCard.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Copyright(c) Microsoft Corporation.All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=audioCard.js.map

package/dist/src/cards/audioCard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audioCard.js","sourceRoot":"","sources":["../../../src/cards/audioCard.ts"],"names":[],"mappings":";AAAA;;;GAGG"}