@microsoft/teamsfx 0.6.2 → 0.6.3-alpha.27183ce36.0

package/types/teamsfx.d.ts

@@ -1,13 +1,88 @@
+/// <reference types="node" />
+
 import { AccessToken } from '@azure/identity';
+import { Activity } from 'botbuilder-core';
+import { Activity as Activity_2 } from 'botbuilder';
+import { Attachment } from 'botbuilder';
 import { AuthenticationProvider } from '@microsoft/microsoft-graph-client';
+import { AxiosInstance } from 'axios';
+import { AxiosRequestConfig } from 'axios';
+import { BotFrameworkAdapter } from 'botbuilder';
+import { CardAction } from 'botbuilder';
+import { CardImage } from 'botbuilder';
+import { ChannelInfo } from 'botbuilder';
 import { Client } from '@microsoft/microsoft-graph-client';
 import { ConnectionConfig } from 'tedious';
+import { ConversationReference } from 'botbuilder';
 import { Dialog } from 'botbuilder-dialogs';
 import { DialogContext } from 'botbuilder-dialogs';
 import { DialogTurnResult } from 'botbuilder-dialogs';
 import { GetTokenOptions } from '@azure/identity';
+import { HeroCard } from 'botbuilder';
+import { O365ConnectorCard } from 'botbuilder';
+import { ReceiptCard } from 'botbuilder';
+import { SecureContextOptions } from 'tls';
+import { TeamsChannelAccount } from 'botbuilder';
+import { ThumbnailCard } from 'botbuilder';
 import { TokenCredential } from '@azure/identity';
 import { TokenResponse } from 'botframework-schema';
+import { TurnContext } from 'botbuilder-core';
+import { TurnContext as TurnContext_2 } from 'botbuilder';
+import { WebRequest } from 'botbuilder';
+import { WebResponse } from 'botbuilder';
+
+/**
+ * Define available location for API Key location
+ *
+ * @beta
+ */
+export declare enum ApiKeyLocation {
+    /**
+     * The API Key is placed in request header
+     */
+    Header = 0,
+    /**
+     * The API Key is placed in query parameter
+     */
+    QueryParams = 1
+}
+
+/**
+ * Provider that handles API Key authentication
+ *
+ * @beta
+ */
+export declare class ApiKeyProvider implements AuthProvider {
+    private keyName;
+    private keyValue;
+    private keyLocation;
+    /**
+     *
+     * @param { string } keyName - The name of request header or query parameter that specifies API Key
+     * @param { string } keyValue - The value of API Key
+     * @param { ApiKeyLocation } keyLocation - The location of API Key: request header or query parameter.
+     *
+     * @throws {@link ErrorCode|InvalidParameter} - when key name or key value is empty.
+     * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
+     *
+     * @beta
+     */
+    constructor(keyName: string, keyValue: string, keyLocation: ApiKeyLocation);
+    /**
+     * Adds authentication info to http requests
+     *
+     * @param { AxiosRequestConfig } config - Contains all the request information and can be updated to include extra authentication info.
+     * Refer https://axios-http.com/docs/req_config for detailed document.
+     *
+     * @returns Updated axios request config.
+     *
+     * @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when API key already exists in request header or url query parameter.
+     * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
+     *
+     * @beta
+     */
+    AddAuthenticationInfo(config: AxiosRequestConfig): Promise<AxiosRequestConfig>;
+}
 
 /**
  * Represent Microsoft 365 tenant identity, and it is usually used when user is not involved like time-triggered automation job.
@@ -123,6 +198,430 @@ export declare interface AuthenticationConfiguration {
     readonly applicationIdUri?: string;
 }
 
+/**
+ * Defines method that injects authentication info to http requests
+ *
+ * @beta
+ */
+export declare interface AuthProvider {
+    /**
+     * Adds authentication info to http requests
+     *
+     * @param { AxiosRequestConfig } config - Contains all the request information and can be updated to include extra authentication info.
+     * Refer https://axios-http.com/docs/req_config for detailed document.
+     *
+     * @beta
+     */
+    AddAuthenticationInfo: (config: AxiosRequestConfig) => Promise<AxiosRequestConfig>;
+}
+
+export { AxiosInstance }
+
+/**
+ * Provider that handles Basic authentication
+ *
+ * @beta
+ */
+export declare class BasicAuthProvider implements AuthProvider {
+    private userName;
+    private password;
+    /**
+     *
+     * @param { string } userName - Username used in basic auth
+     * @param { string } password - Password used in basic auth
+     *
+     * @throws {@link ErrorCode|InvalidParameter} - when username or password is empty.
+     * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
+     *
+     * @beta
+     */
+    constructor(userName: string, password: string);
+    /**
+     * Adds authentication info to http requests
+     *
+     * @param { AxiosRequestConfig } config - Contains all the request information and can be updated to include extra authentication info.
+     * Refer https://axios-http.com/docs/req_config for detailed document.
+     *
+     * @returns Updated axios request config.
+     *
+     * @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when Authorization header or auth property already exists in request configuration.
+     * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
+     *
+     * @beta
+     */
+    AddAuthenticationInfo(config: AxiosRequestConfig): Promise<AxiosRequestConfig>;
+}
+
+/**
+ * Provider that handles Bearer Token authentication
+ *
+ * @beta
+ */
+export declare class BearerTokenAuthProvider implements AuthProvider {
+    private getToken;
+    /**
+     * @param { () => Promise<string> } getToken - Function that returns the content of bearer token used in http request
+     *
+     * @beta
+     */
+    constructor(getToken: () => Promise<string>);
+    /**
+     * Adds authentication info to http requests
+     *
+     * @param { AxiosRequestConfig } config - Contains all the request information and can be updated to include extra authentication info.
+     * Refer https://axios-http.com/docs/req_config for detailed document.
+     *
+     * @returns Updated axios request config.
+     *
+     * @throws {@link ErrorCode|AuthorizationInfoAlreadyExists} - when Authorization header already exists in request configuration.
+     *
+     * @beta
+     */
+    AddAuthenticationInfo(config: AxiosRequestConfig): Promise<AxiosRequestConfig>;
+}
+
+/**
+ * Provider that handles Certificate authentication
+ *
+ * @beta
+ */
+export declare class CertificateAuthProvider implements AuthProvider {
+    private certOption;
+    /**
+     *
+     * @param { SecureContextOptions } certOption - information about the cert used in http requests
+     *
+     * @throws {@link ErrorCode|InvalidParameter} - when cert option is empty.
+     *
+     * @beta
+     */
+    constructor(certOption: SecureContextOptions);
+    /**
+     * Adds authentication info to http requests.
+     *
+     * @param { AxiosRequestConfig } config - Contains all the request information and can be updated to include extra authentication info.
+     * Refer https://axios-http.com/docs/req_config for detailed document.
+     *
+     * @returns Updated axios request config.
+     *
+     * @throws {@link ErrorCode|InvalidParameter} - when custom httpsAgent in the request has duplicate properties with certOption provided in constructor.
+     *
+     * @beta
+     */
+    AddAuthenticationInfo(config: AxiosRequestConfig): Promise<AxiosRequestConfig>;
+}
+
+/**
+ * A {@link NotificationTarget} that represents a team channel.
+ *
+ * @remarks
+ * It's recommended to get channels from {@link TeamsBotInstallation.channels()}.
+ *
+ * @beta
+ */
+export declare class Channel implements NotificationTarget {
+    /**
+     * The parent {@link TeamsBotInstallation} where this channel is created from.
+     *
+     * @beta
+     */
+    readonly parent: TeamsBotInstallation;
+    /**
+     * Detailed channel information.
+     *
+     * @beta
+     */
+    readonly info: ChannelInfo;
+    /**
+     * Notification target type. For channel it's always "Channel".
+     *
+     * @beta
+     */
+    readonly type: NotificationTargetType;
+    /**
+     * Constuctor.
+     *
+     * @remarks
+     * It's recommended to get channels from {@link TeamsBotInstallation.channels()}, instead of using this constructor.
+     *
+     * @param parent - The parent {@link TeamsBotInstallation} where this channel is created from.
+     * @param info - Detailed channel information.
+     *
+     * @beta
+     */
+    constructor(parent: TeamsBotInstallation, info: ChannelInfo);
+    /**
+     * Send a plain text message.
+     *
+     * @param text - the plain text message.
+     * @returns A `Promise` representing the asynchronous operation.
+     *
+     * @beta
+     */
+    sendMessage(text: string): Promise<void>;
+    /**
+     * Send an adaptive card message.
+     *
+     * @param card - the adaptive card raw JSON.
+     * @returns A `Promise` representing the asynchronous operation.
+     *
+     * @beta
+     */
+    sendAdaptiveCard(card: unknown): Promise<void>;
+    /**
+     * @internal
+     */
+    private newConversation;
+}
+
+/**
+ * A command bot for receiving commands and sending responses in Teams.
+ *
+ * @remarks
+ * Ensure each command should ONLY be registered with the command once, otherwise it'll cause unexpected behavior if you register the same command more than once.
+ *
+ * @beta
+ */
+export declare class CommandBot {
+    private readonly adapter;
+    private readonly middleware;
+    /**
+     * Creates a new instance of the `CommandBot`.
+     *
+     * @param adapter The bound `BotFrameworkAdapter`.
+     * @param options - initialize options
+     *
+     * @beta
+     */
+    constructor(adapter: BotFrameworkAdapter, options?: CommandOptions);
+    /**
+     * Registers a command into the command bot.
+     *
+     * @param command The command to registered.
+     *
+     * @beta
+     */
+    registerCommand(command: TeamsFxBotCommandHandler): void;
+    /**
+     * Registers commands into the command bot.
+     *
+     * @param commands The command to registered.
+     *
+     * @beta
+     */
+    registerCommands(commands: TeamsFxBotCommandHandler[]): void;
+}
+
+/**
+ * Interface for a command messagge that can handled in a command handler.
+ */
+export declare interface CommandMessage {
+    /**
+     * Text of the message sent by the user.
+     */
+    text: string;
+    /**
+     * The capture groups that matched to the {@link TriggerPatterns} in a {@link TeamsFxBotCommandHandler} instance.
+     */
+    matches?: RegExpMatchArray;
+}
+
+/**
+ * Options to initialize {@link CommandBot}.
+ *
+ * @beta
+ */
+export declare interface CommandOptions {
+    /**
+     * The commands to registered with the command bot. Each command should implement the interface {@link TeamsFxBotCommandHandler} so that it can be correctly handled by this command bot.
+     *
+     * @beta
+     */
+    commands?: TeamsFxBotCommandHandler[];
+}
+
+/**
+ * Provide utilities for bot conversation, including:
+ *   - handle command and response.
+ *   - send notification to varies targets (e.g., member, group, channel).
+ *
+ * @example
+ * For command and response, you can register your commands through the constructor, or use the `registerCommand` and `registerCommands` API to add commands later.
+ *
+ * ```typescript
+ * // register through constructor
+ * const conversationBot = new ConversationBot({
+ *   command: {
+ *     enabled: true,
+ *     commands: [ new HelloWorldCommandHandler() ],
+ *   },
+ * });
+ *
+ * // register through `register*` API
+ * conversationBot.command.registerCommand(new HelpCommandHandler());
+ * ```
+ *
+ * For notification, you can enable notification at initialization, then send notifications at any time.
+ *
+ * ```typescript
+ * // enable through constructor
+ * const conversationBot = new ConversationBot({
+ *   notification: {
+ *     enabled: true,
+ *   },
+ * });
+ *
+ * // get all bot installations and send message
+ * for (const target of await conversationBot.notification.installations()) {
+ *   await target.sendMessage("Hello Notification");
+ * }
+ *
+ * // alternative - send message to all members
+ * for (const target of await conversationBot.notification.installations()) {
+ *   for (const member of await target.members()) {
+ *     await member.sendMessage("Hello Notification");
+ *   }
+ * }
+ * ```
+ *
+ * @remarks
+ * Set `adapter` in {@link ConversationOptions} to use your own bot adapter.
+ *
+ * For command and response, ensure each command should ONLY be registered with the command once, otherwise it'll cause unexpected behavior if you register the same command more than once.
+ *
+ * For notification, set `notification.storage` in {@link ConversationOptions} to use your own storage implementation.
+ *
+ * @beta
+ */
+export declare class ConversationBot {
+    /**
+     * The bot adapter.
+     *
+     * @beta
+     */
+    readonly adapter: BotFrameworkAdapter;
+    /**
+     * The entrypoint of command and response.
+     *
+     * @beta
+     */
+    readonly command?: CommandBot;
+    /**
+     * The entrypoint of notification.
+     *
+     * @beta
+     */
+    readonly notification?: NotificationBot;
+    /**
+     * Creates new instance of the `ConversationBot`.
+     *
+     * @remarks
+     * It's recommended to create your own adapter and storage for production environment instead of the default one.
+     *
+     * @param options - initialize options
+     *
+     * @beta
+     */
+    constructor(options: ConversationOptions);
+    private createDefaultAdapter;
+    /**
+     * The request handler to integrate with web request.
+     *
+     * @param req - an Express or Restify style request object.
+     * @param res - an Express or Restify style response object.
+     * @param logic - the additional function to handle bot context.
+     *
+     * @example
+     * For example, to use with Restify:
+     * ``` typescript
+     * // The default/empty behavior
+     * server.post("api/messages", conversationBot.requestHandler);
+     *
+     * // Or, add your own logic
+     * server.post("api/messages", async (req, res) => {
+     *   await conversationBot.requestHandler(req, res, async (context) => {
+     *     // your-own-context-logic
+     *   });
+     * });
+     * ```
+     *
+     * @beta
+     */
+    requestHandler(req: WebRequest, res: WebResponse, logic?: (context: TurnContext_2) => Promise<any>): Promise<void>;
+}
+
+/**
+ * Options to initialize {@link ConversationBot}
+ *
+ * @beta
+ */
+export declare interface ConversationOptions {
+    /**
+     * The bot adapter. If not provided, a default adapter will be created:
+     * - with `adapterConfig` as constructor parameter.
+     * - with a default error handler that logs error to console, sends trace activity, and sends error message to user.
+     *
+     * @remarks
+     * If neither `adapter` nor `adapterConfig` is provided, will use BOT_ID and BOT_PASSWORD from environment variables.
+     *
+     * @beta
+     */
+    adapter?: BotFrameworkAdapter;
+    /**
+     * If `adapter` is not provided, this `adapterConfig` will be passed to the new `BotFrameworkAdapter` when created internally.
+     *
+     * @remarks
+     * If neither `adapter` nor `adapterConfig` is provided, will use BOT_ID and BOT_PASSWORD from environment variables.
+     *
+     * @beta
+     */
+    adapterConfig?: {
+        [key: string]: unknown;
+    };
+    /**
+     * The command part.
+     *
+     * @beta
+     */
+    command?: CommandOptions & {
+        /**
+         * Whether to enable command or not.
+         *
+         * @beta
+         */
+        enabled?: boolean;
+    };
+    /**
+     * The notification part.
+     *
+     * @beta
+     */
+    notification?: NotificationOptions_2 & {
+        /**
+         * Whether to enable notification or not.
+         *
+         * @beta
+         */
+        enabled?: boolean;
+    };
+}
+
+/**
+ * Initializes new Axios instance with specific auth provider
+ *
+ * @param apiEndpoint - Base url of the API
+ * @param authProvider - Auth provider that injects authentication info to each request
+ * @returns axios instance configured with specfic auth provider
+ *
+ * @example
+ * ```typescript
+ * const client = createApiClient("https://my-api-endpoint-base-url", new BasicAuthProvider("xxx","xxx"));
+ * ```
+ *
+ * @beta
+ */
+export declare function createApiClient(apiEndpoint: string, authProvider: AuthProvider): AxiosInstance;
+
 /**
  * Get Microsoft graph client.
  *
@@ -176,6 +675,38 @@ export declare interface AuthenticationConfiguration {
  */
 export declare function createMicrosoftGraphClient(teamsfx: TeamsFxConfiguration, scopes?: string | string[]): Client;
 
+/**
+ * Helper to create SecureContextOptions from PEM format cert
+ *
+ * @param { string | Buffer } cert - The cert chain in PEM format
+ * @param { string | Buffer } key - The private key for the cert chain
+ * @param { {passphrase?: string; ca?: string | Buffer} } options - Optional settings when create the cert options.
+ *
+ * @returns Instance of SecureContextOptions
+ *
+ * @throws {@link ErrorCode|InvalidParameter} - when any parameter is empty
+ *
+ */
+export declare function createPemCertOption(cert: string | Buffer, key: string | Buffer, options?: {
+    passphrase?: string;
+    ca?: string | Buffer;
+}): SecureContextOptions;
+
+/**
+ * Helper to create SecureContextOptions from PFX format cert
+ *
+ * @param { string | Buffer } pfx - The content of .pfx file
+ * @param { {passphrase?: string} } options - Optional settings when create the cert options.
+ *
+ * @returns Instance of SecureContextOptions
+ *
+ * @throws {@link ErrorCode|InvalidParameter} - when any parameter is empty
+ *
+ */
+export declare function createPfxCertOption(pfx: string | Buffer, options?: {
+    passphrase?: string;
+}): SecureContextOptions;
+
 /**
  * Error code to trace the error types.
  * @beta
@@ -216,179 +747,522 @@ export declare enum ErrorCode {
     /**
      * Token is not within its valid time range error.
      */
-    TokenExpiredError = "TokenExpiredError",
+    TokenExpiredError = "TokenExpiredError",
+    /**
+     * Call service (AAD or simple authentication server) failed.
+     */
+    ServiceError = "ServiceError",
+    /**
+     * Operation failed.
+     */
+    FailedOperation = "FailedOperation",
+    /**
+     * Invalid response error.
+     */
+    InvalidResponse = "InvalidResponse",
+    /**
+     * Identity type error.
+     */
+    IdentityTypeNotSupported = "IdentityTypeNotSupported",
+    /**
+     * Authentication info already exists error.
+     */
+    AuthorizationInfoAlreadyExists = "AuthorizationInfoAlreadyExists"
+}
+
+/**
+ * Error class with code and message thrown by the SDK.
+ *
+ * @beta
+ */
+export declare class ErrorWithCode extends Error {
+    /**
+     * Error code
+     *
+     * @readonly
+     */
+    code: string | undefined;
+    /**
+     * Constructor of ErrorWithCode.
+     *
+     * @param {string} message - error message.
+     * @param {ErrorCode} code - error code.
+     *
+     * @beta
+     */
+    constructor(message?: string, code?: ErrorCode);
+}
+
+/**
+ * Get log level.
+ *
+ * @returns Log level
+ *
+ * @beta
+ */
+export declare function getLogLevel(): LogLevel | undefined;
+
+/**
+ * Generate connection configuration consumed by tedious.
+ *
+ * @param {TeamsFx} teamsfx - Used to provide configuration and auth
+ * @param { string? } databaseName - specify database name to override default one if there are multiple databases.
+ *
+ * @returns Connection configuration of tedious for the SQL.
+ *
+ * @throws {@link ErrorCode|InvalidConfiguration} when SQL config resource configuration is invalid.
+ * @throws {@link ErrorCode|InternalError} when get user MSI token failed or MSI token is invalid.
+ * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
+ *
+ * @beta
+ */
+export declare function getTediousConnectionConfig(teamsfx: TeamsFx, databaseName?: string): Promise<ConnectionConfig>;
+
+/**
+ * Identity type to use in authentication.
+ *
+ * @beta
+ */
+export declare enum IdentityType {
+    /**
+     * Represents the current user of Teams.
+     */
+    User = "User",
+    /**
+     * Represents the application itself.
+     */
+    App = "Application"
+}
+
+/**
+ * Log function for customized logging.
+ *
+ * @beta
+ */
+export declare type LogFunction = (level: LogLevel, message: string) => void;
+
+/**
+ * Interface for customized logger.
+ * @beta
+ */
+export declare interface Logger {
+    /**
+     * Writes to error level logging or lower.
+     */
+    error(message: string): void;
+    /**
+     * Writes to warning level logging or lower.
+     */
+    warn(message: string): void;
+    /**
+     * Writes to info level logging or lower.
+     */
+    info(message: string): void;
+    /**
+     * Writes to verbose level logging.
+     */
+    verbose(message: string): void;
+}
+
+/**
+ * Log level.
+ *
+ * @beta
+ */
+export declare enum LogLevel {
+    /**
+     * Show verbose, information, warning and error message.
+     */
+    Verbose = 0,
+    /**
+     * Show information, warning and error message.
+     */
+    Info = 1,
+    /**
+     * Show warning and error message.
+     */
+    Warn = 2,
+    /**
+     * Show error message.
+     */
+    Error = 3
+}
+
+/**
+ * A {@link NotificationTarget} that represents a team member.
+ *
+ * @remarks
+ * It's recommended to get members from {@link TeamsBotInstallation.members()}.
+ *
+ * @beta
+ */
+export declare class Member implements NotificationTarget {
+    /**
+     * The parent {@link TeamsBotInstallation} where this member is created from.
+     *
+     * @beta
+     */
+    readonly parent: TeamsBotInstallation;
+    /**
+     * Detailed member account information.
+     *
+     * @beta
+     */
+    readonly account: TeamsChannelAccount;
+    /**
+     * Notification target type. For member it's always "Person".
+     *
+     * @beta
+     */
+    readonly type: NotificationTargetType;
+    /**
+     * Constuctor.
+     *
+     * @remarks
+     * It's recommended to get members from {@link TeamsBotInstallation.members()}, instead of using this constructor.
+     *
+     * @param parent - The parent {@link TeamsBotInstallation} where this member is created from.
+     * @param account - Detailed member account information.
+     *
+     * @beta
+     */
+    constructor(parent: TeamsBotInstallation, account: TeamsChannelAccount);
+    /**
+     * Send a plain text message.
+     *
+     * @param text - the plain text message.
+     * @returns A `Promise` representing the asynchronous operation.
+     *
+     * @beta
+     */
+    sendMessage(text: string): Promise<void>;
+    /**
+     * Send an adaptive card message.
+     *
+     * @param card - the adaptive card raw JSON.
+     * @returns A `Promise` representing the asynchronous operation.
+     *
+     * @beta
+     */
+    sendAdaptiveCard(card: unknown): Promise<void>;
+    /**
+     * @internal
+     */
+    private newConversation;
+}
+
+/**
+ * Provides utility method to build bot message with cards that supported in Teams.
+ */
+export declare class MessageBuilder {
+    /**
+     * Build a bot message activity attached with adaptive card.
+     *
+     * @param cardTemplate The adaptive card template.
+     * @param data card data used to render the template.
+     * @returns A bot message activity attached with an adaptive card.
+     *
+     * @example
+     * ```javascript
+     * const cardTemplate = {
+     *   type: "AdaptiveCard",
+     *   body: [
+     *     {
+     *       "type": "TextBlock",
+     *       "text": "${title}",
+     *       "size": "Large"
+     *     },
+     *     {
+     *       "type": "TextBlock",
+     *       "text": "${description}"
+     *     }],
+     *     $schema: "http://adaptivecards.io/schemas/adaptive-card.json",
+     *     version: "1.4"
+     *  };
+     *
+     * type CardData = {
+     *   title: string,
+     *   description: string
+     * };
+     * const card = MessageBuilder.attachAdaptiveCard<CardData>(
+     *   cardTemplate, {
+     *   title: "sample card title",
+     *   description: "sample card description"
+     * });
+     * ```
+     *
+     * @beta
+     */
+    static attachAdaptiveCard<TData>(cardTemplate: any, data: TData): Partial<Activity_2>;
+    /**
+     * Build a bot message activity attached with an adaptive card.
+     *
+     * @param card The adaptive card content.
+     * @returns A bot message activity attached with an adaptive card.
+     *
+     * @beta
+     */
+    static attachAdaptiveCardWithoutData(card: any): Partial<Activity_2>;
+    /**
+     * Build a bot message activity attached with an hero card.
+     *
+     * @param title The card title.
+     * @param images Optional. The array of images to include on the card.
+     * @param buttons Optional. The array of buttons to include on the card. Each `string` in the array
+     *      is converted to an `imBack` button with a title and value set to the value of the string.
+     * @param other Optional. Any additional properties to include on the card.
+     *
+     * @returns A bot message activity attached with a hero card.
+     *
+     * @example
+     * ```javascript
+     * const message = MessageBuilder.attachHeroCard(
+     *      'sample title',
+     *      ['https://example.com/sample.jpg'],
+     *      ['action']
+     * );
+     * ```
+     *
+     * @beta
+     */
+    static attachHeroCard(title: string, images?: (CardImage | string)[], buttons?: (CardAction | string)[], other?: Partial<HeroCard>): Partial<Activity_2>;
+    /**
+     * Returns an attachment for a sign-in card.
+     *
+     * @param title The title for the card's sign-in button.
+     * @param url The URL of the sign-in page to use.
+     * @param text Optional. Additional text to include on the card.
+     *
+     * @returns A bot message activity attached with a sign-in card.
+     *
+     * @remarks
+     * For channels that don't natively support sign-in cards, an alternative message is rendered.
+     *
+     * @beta
+     */
+    static attachSigninCard(title: string, url: string, text?: string): Partial<Activity_2>;
     /**
-     * Call service (AAD or simple authentication server) failed.
+     * Build a bot message activity attached with an Office 365 connector card.
+     *
+     * @param card A description of the Office 365 connector card.
+     * @returns A bot message activity attached with an Office 365 connector card.
+     *
+     * @beta
      */
-    ServiceError = "ServiceError",
+    static attachO365ConnectorCard(card: O365ConnectorCard): Partial<Activity_2>;
     /**
-     * Operation failed.
+     * Build a message activity attached with a receipt card.
+     * @param card A description of the receipt card.
+     * @returns A message activity attached with a receipt card.
+     *
+     * @beta
      */
-    FailedOperation = "FailedOperation",
+    static AttachReceiptCard(card: ReceiptCard): Partial<Activity_2>;
     /**
-     * Invalid response error.
+     *
+     * @param title The card title.
+     * @param images Optional. The array of images to include on the card.
+     * @param buttons Optional. The array of buttons to include on the card. Each `string` in the array
+     *      is converted to an `imBack` button with a title and value set to the value of the string.
+     * @param other Optional. Any additional properties to include on the card.
+     * @returns A message activity attached with a thumbnail card
+     *
+     * @beta
      */
-    InvalidResponse = "InvalidResponse",
+    static attachThumbnailCard(title: string, images?: (CardImage | string)[], buttons?: (CardAction | string)[], other?: Partial<ThumbnailCard>): Partial<Activity_2>;
     /**
-     * Identity type error.
+     * Add an attachement to a bot activity.
+     * @param attachement The attachment object to attach.
+     * @returns A message activity with an attachment.
+     *
+     * @beta
      */
-    IdentityTypeNotSupported = "IdentityTypeNotSupported"
+    static attachContent(attachement: Attachment): Partial<Activity_2>;
 }
 
 /**
- * Error class with code and message thrown by the SDK.
+ * Microsoft Graph auth provider for Teams Framework
  *
  * @beta
  */
-export declare class ErrorWithCode extends Error {
+export declare class MsGraphAuthProvider implements AuthenticationProvider {
+    private teamsfx;
+    private scopes;
     /**
-     * Error code
+     * Constructor of MsGraphAuthProvider.
      *
-     * @readonly
+     * @param {TeamsFx} teamsfx - Used to provide configuration and auth.
+     * @param {string | string[]} scopes - The list of scopes for which the token will have access.
+     *
+     * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
+     *
+     * @returns An instance of MsGraphAuthProvider.
+     *
+     * @beta
      */
-    code: string | undefined;
+    constructor(teamsfx: TeamsFxConfiguration, scopes?: string | string[]);
     /**
-     * Constructor of ErrorWithCode.
+     * Get access token for Microsoft Graph API requests.
      *
-     * @param {string} message - error message.
-     * @param {ErrorCode} code - error code.
+     * @throws {@link ErrorCode|InternalError} when get access token failed due to empty token or unknown other problems.
+     * @throws {@link ErrorCode|TokenExpiredError} when SSO token has already expired.
+     * @throws {@link ErrorCode|UiRequiredError} when need user consent to get access token.
+     * @throws {@link ErrorCode|ServiceError} when failed to get access token from simple auth or AAD server.
+     * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
+     *
+     * @returns Access token from the credential.
      *
-     * @beta
      */
-    constructor(message?: string, code?: ErrorCode);
+    getAccessToken(): Promise<string>;
 }
 
 /**
- * Get log level.
- *
- * @returns Log level
- *
- * @beta
- */
-export declare function getLogLevel(): LogLevel | undefined;
-
-/**
- * Generate connection configuration consumed by tedious.
- *
- * @param {TeamsFx} teamsfx - Used to provide configuration and auth
- * @param { string? } databaseName - specify database name to override default one if there are multiple databases.
- *
- * @returns Connection configuration of tedious for the SQL.
- *
- * @throws {@link ErrorCode|InvalidConfiguration} when SQL config resource configuration is invalid.
- * @throws {@link ErrorCode|InternalError} when get user MSI token failed or MSI token is invalid.
- * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
- *
- * @beta
- */
-export declare function getTediousConnectionConfig(teamsfx: TeamsFx, databaseName?: string): Promise<ConnectionConfig>;
-
-/**
- * Identity type to use in authentication.
+ * Provide utilities to send notification to varies targets (e.g., member, group, channel).
  *
  * @beta
  */
-export declare enum IdentityType {
+export declare class NotificationBot {
+    private readonly conversationReferenceStore;
+    private readonly adapter;
     /**
-     * Represents the current user of Teams.
+     * constructor of the notification bot.
+     *
+     * @remarks
+     * To ensure accuracy, it's recommended to initialize before handling any message.
+     *
+     * @param adapter - the bound `BotFrameworkAdapter`
+     * @param options - initialize options
+     *
+     * @beta
      */
-    User = "User",
+    constructor(adapter: BotFrameworkAdapter, options?: NotificationOptions_2);
     /**
-     * Represents the application itself.
+     * Get all targets where the bot is installed.
+     *
+     * @remarks
+     * The result is retrieving from the persisted storage.
+     *
+     * @returns - an array of {@link TeamsBotInstallation}.
+     *
+     * @beta
      */
-    App = "Application"
+    installations(): Promise<TeamsBotInstallation[]>;
 }
 
 /**
- * Log function for customized logging.
+ * Options to initialize {@link NotificationBot}.
  *
  * @beta
  */
-export declare type LogFunction = (level: LogLevel, message: string) => void;
-
-/**
- * Interface for customized logger.
- * @beta
- */
-export declare interface Logger {
-    /**
-     * Writes to error level logging or lower.
-     */
-    error(message: string): void;
-    /**
-     * Writes to warning level logging or lower.
-     */
-    warn(message: string): void;
-    /**
-     * Writes to info level logging or lower.
-     */
-    info(message: string): void;
+declare interface NotificationOptions_2 {
     /**
-     * Writes to verbose level logging.
+     * An optional storage to persist bot notification connections.
+     *
+     * @remarks
+     * If `storage` is not provided, a default local file storage will be used,
+     * which stores notification connections into:
+     *   - ".notification.localstore.json" if running locally
+     *   - "${process.env.TEMP}/.notification.localstore.json" if `process.env.RUNNING_ON_AZURE` is set to "1"
+     *
+     * It's recommended to use your own shared storage for production environment.
+     *
+     * @beta
      */
-    verbose(message: string): void;
+    storage?: NotificationTargetStorage;
 }
+export { NotificationOptions_2 as NotificationOptions }
 
 /**
- * Log level.
+ * Represent a notification target.
  *
  * @beta
  */
-export declare enum LogLevel {
-    /**
-     * Show verbose, information, warning and error message.
-     */
-    Verbose = 0,
+export declare interface NotificationTarget {
     /**
-     * Show information, warning and error message.
+     * The type of target, could be "Channel" or "Group" or "Person".
+     *
+     * @beta
      */
-    Info = 1,
+    readonly type?: NotificationTargetType;
     /**
-     * Show warning and error message.
+     * Send a plain text message.
+     *
+     * @param text - the plain text message.
+     *
+     * @beta
      */
-    Warn = 2,
+    sendMessage(text: string): Promise<void>;
     /**
-     * Show error message.
+     * Send an adaptive card message.
+     *
+     * @param card - the adaptive card raw JSON.
+     *
+     * @beta
      */
-    Error = 3
+    sendAdaptiveCard(card: unknown): Promise<void>;
 }
 
 /**
- * Microsoft Graph auth provider for Teams Framework
+ * Interface for a storage provider that stores and retrieves notification target references.
  *
  * @beta
  */
-export declare class MsGraphAuthProvider implements AuthenticationProvider {
-    private teamsfx;
-    private scopes;
+export declare interface NotificationTargetStorage {
     /**
-     * Constructor of MsGraphAuthProvider.
+     * Read one notification target by its key.
      *
-     * @param {TeamsFx} teamsfx - Used to provide configuration and auth.
-     * @param {string | string[]} scopes - The list of scopes for which the token will have access.
+     * @param key - the key of a notification target.
      *
-     * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
+     * @returns - the notification target. Or undefined if not found.
      *
-     * @returns An instance of MsGraphAuthProvider.
+     * @beta
+     */
+    read(key: string): Promise<{
+        [key: string]: unknown;
+    } | undefined>;
+    /**
+     * List all stored notification targets.
+     *
+     * @returns - an array of notification target. Or an empty array if nothing is stored.
      *
      * @beta
      */
-    constructor(teamsfx: TeamsFxConfiguration, scopes?: string | string[]);
+    list(): Promise<{
+        [key: string]: unknown;
+    }[]>;
     /**
-     * Get access token for Microsoft Graph API requests.
+     * Write one notification target by its key.
      *
-     * @throws {@link ErrorCode|InternalError} when get access token failed due to empty token or unknown other problems.
-     * @throws {@link ErrorCode|TokenExpiredError} when SSO token has already expired.
-     * @throws {@link ErrorCode|UiRequiredError} when need user consent to get access token.
-     * @throws {@link ErrorCode|ServiceError} when failed to get access token from simple auth or AAD server.
-     * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
+     * @param key - the key of a notification target.
+     * @param object - the notification target.
      *
-     * @returns Access token from the credential.
+     * @beta
+     */
+    write(key: string, object: {
+        [key: string]: unknown;
+    }): Promise<void>;
+    /**
+     * Delete one notificaton target by its key.
+     *
+     * @param key - the key of a notification target.
      *
+     * @beta
      */
-    getAccessToken(): Promise<string>;
+    delete(key: string): Promise<void>;
 }
 
+/**
+ * The target type where the notification will be sent to.
+ *
+ * @remarks
+ * - "Channel" means to a team channel. (By default, notification to a team will be sent to its "General" channel.)
+ * - "Group" means to a group chat.
+ * - "Person" means to a personal chat.
+ *
+ * @beta
+ */
+export declare type NotificationTargetType = "Channel" | "Group" | "Person";
+
 /**
  * Represent on-behalf-of flow to get user identity, and it is designed to be used in server side.
  *
@@ -476,6 +1350,28 @@ export declare class OnBehalfOfUserCredential implements TokenCredential {
     private generateAuthServerError;
 }
 
+/**
+ * Send an adaptive card message to a notification target.
+ *
+ * @param target - the notification target.
+ * @param card - the adaptive card raw JSON.
+ * @returns A `Promise` representing the asynchronous operation.
+ *
+ * @beta
+ */
+export declare function sendAdaptiveCard(target: NotificationTarget, card: unknown): Promise<void>;
+
+/**
+ * Send a plain text message to a notification target.
+ *
+ * @param target - the notification target.
+ * @param text - the plain text message.
+ * @returns A `Promise` representing the asynchronous operation.
+ *
+ * @beta
+ */
+export declare function sendMessage(target: NotificationTarget, text: string): Promise<void>;
+
 /**
  * Set custom log function. Use the function if it's set. Priority is lower than setLogger.
  *
@@ -522,6 +1418,89 @@ export declare function setLogger(logger?: Logger): void;
  */
 export declare function setLogLevel(level: LogLevel): void;
 
+/**
+ * A {@link NotificationTarget} that represents a bot installation. Teams Bot could be installed into
+ * - Personal chat
+ * - Group chat
+ * - Team (by default the `General` channel)
+ *
+ * @remarks
+ * It's recommended to get bot installations from {@link ConversationBot.installations()}.
+ *
+ * @beta
+ */
+export declare class TeamsBotInstallation implements NotificationTarget {
+    /**
+     * The bound `BotFrameworkAdapter`.
+     *
+     * @beta
+     */
+    readonly adapter: BotFrameworkAdapter;
+    /**
+     * The bound `ConversationReference`.
+     *
+     * @beta
+     */
+    readonly conversationReference: Partial<ConversationReference>;
+    /**
+     * Notification target type.
+     *
+     * @remarks
+     * - "Channel" means bot is installed into a team and notification will be sent to its "General" channel.
+     * - "Group" means bot is installed into a group chat.
+     * - "Person" means bot is installed into a personal scope and notification will be sent to personal chat.
+     *
+     * @beta
+     */
+    readonly type?: NotificationTargetType;
+    /**
+     * Constructor
+     *
+     * @remarks
+     * It's recommended to get bot installations from {@link ConversationBot.installations()}, instead of using this constructor.
+     *
+     * @param adapter - the bound `BotFrameworkAdapter`.
+     * @param conversationReference - the bound `ConversationReference`.
+     *
+     * @beta
+     */
+    constructor(adapter: BotFrameworkAdapter, conversationReference: Partial<ConversationReference>);
+    /**
+     * Send a plain text message.
+     *
+     * @param text - the plain text message.
+     * @returns A `Promise` representing the asynchronous operation.
+     *
+     * @beta
+     */
+    sendMessage(text: string): Promise<void>;
+    /**
+     * Send an adaptive card message.
+     *
+     * @param card - the adaptive card raw JSON.
+     * @returns A `Promise` representing the asynchronous operation.
+     *
+     * @beta
+     */
+    sendAdaptiveCard(card: unknown): Promise<void>;
+    /**
+     * Get channels from this bot installation.
+     *
+     * @returns an array of channels if bot is installed into a team, otherwise returns an empty array.
+     *
+     * @beta
+     */
+    channels(): Promise<Channel[]>;
+    /**
+     * Get members from this bot installation.
+     *
+     * @returns an array of members from where the bot is installed.
+     *
+     * @beta
+     */
+    members(): Promise<Member[]>;
+}
+
 /**
  * Creates a new prompt that leverage Teams Single Sign On (SSO) support for bot to automatically sign in user and
  * help receive oauth token, asks the user to consent if needed.
@@ -809,6 +1788,26 @@ export declare class TeamsFx implements TeamsFxConfiguration {
     private loadFromEnv;
 }
 
+/**
+ * Interface for a command handler that can process command to a TeamsFx bot and return a response.
+ *
+ * @beta
+ */
+export declare interface TeamsFxBotCommandHandler {
+    /**
+     * The string or regular expression patterns that can trigger this handler.
+     */
+    triggerPatterns: TriggerPatterns;
+    /**
+     * Handles a bot command received activity.
+     *
+     * @param context The bot context.
+     * @param message The command message the user types from Teams.
+     * @returns A `Promise` representing an activity or text to send as the command response.
+     */
+    handleCommandReceived(context: TurnContext, message: CommandMessage): Promise<string | Partial<Activity>>;
+}
+
 /**
  * TeamsFx interface that provides credential and configuration.
  * @beta
@@ -929,6 +1928,11 @@ export declare class TeamsUserCredential implements TokenCredential {
     getUserInfo(): Promise<UserInfo>;
 }
 
+/**
+ * The trigger pattern used to trigger a {@link TeamsFxBotCommandHandler} instance.
+ */
+export declare type TriggerPatterns = string | RegExp | (string | RegExp)[];
+
 /**
  * UserInfo with user displayName, objectId and preferredUserName.
  *