@microsoft/teamsfx 1.2.1-rc.1 → 2.0.0-alpha.7f7c9560f.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/teamsfx",
-  "version": "1.2.1-rc.1",
+  "version": "2.0.0-alpha.7f7c9560f.0",
   "description": "Microsoft Teams Framework for Node.js and browser.",
   "main": "dist/index.node.cjs.js",
   "browser": "dist/index.esm2017.js",
@@ -49,7 +49,7 @@
     "@azure/identity": "^2.0.1",
     "@azure/msal-browser": "^2.21.0",
     "@azure/msal-node": "~1.1.0",
-    "@microsoft/adaptivecards-tools": "^1.1.0-rc.0",
+    "@microsoft/adaptivecards-tools": "1.1.1-alpha.7f7c9560f.0",
     "@microsoft/microsoft-graph-client": "^3.0.1",
     "axios": "^0.27.2",
     "botbuilder": ">=4.15.0 <5.0.0",
@@ -61,7 +61,7 @@
     "uuid": "^8.3.2"
   },
   "peerDependencies": {
-    "@microsoft/teams-js": "^1.9.0"
+    "@microsoft/teams-js": "^2.0.0"
   },
   "devDependencies": {
     "@azure/arm-sql": "^9.0.0",
@@ -70,7 +70,7 @@
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
     "@microsoft/api-documenter": "^7.14.1",
     "@microsoft/api-extractor": "^7.19.4",
-    "@microsoft/teams-js": "^1.9.0",
+    "@microsoft/teams-js": "^2.0.0",
     "@rollup/plugin-json": "^4.1.0",
     "@types/chai": "^4.2.22",
     "@types/chai-as-promised": "^7.1.4",
@@ -129,7 +129,7 @@
     "webpack": "^5.62.1",
     "yargs": "^17.2.1"
   },
-  "gitHead": "4a129d1ba158b94149387811fe2d58e6a2ef1801",
+  "gitHead": "4f3371e41a093a0187cdcebca076b4f491de004f",
   "publishConfig": {
     "access": "public"
   },

package/types/teamsfx.d.ts

@@ -127,6 +127,7 @@ export declare class AppCredential implements TokenCredential {
      * @throws {@link ErrorCode|InvalidConfiguration} when client id, client secret or tenant id is not found in config.
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is nodeJS.
      */
+    constructor(authConfig: AppCredentialAuthConfig);
     constructor(authConfig: AuthenticationConfiguration);
     /**
      * Get access token for credential.
@@ -163,6 +164,11 @@ export declare class AppCredential implements TokenCredential {
     private loadAndValidateConfig;
 }
 
+/**
+ * Authentication configuration for AppCredential used in node environment
+ */
+export declare type AppCredentialAuthConfig = OnBehalfOfCredentialAuthConfig;
+
 /**
  * Authentication related configuration.
  */
@@ -287,7 +293,9 @@ export declare interface BotSsoConfig {
          * The list of scopes for which the token will have access
          */
         scopes: string[];
-    } & AuthenticationConfiguration;
+    } & ((OnBehalfOfCredentialAuthConfig & {
+        initiateLoginEndpoint: string;
+    }) | AuthenticationConfiguration);
     dialog?: {
         /**
          * Custom sso execution activity handler class which should implement the interface {@link BotSsoExecutionActivityHandler}. If not provided, it will use {@link DefaultBotSsoExecutionActivityHandler} by default
@@ -397,6 +405,7 @@ export declare class BotSsoExecutionDialog extends ComponentDialog {
      * @param teamsfx {@link TeamsFx} instance for authentication
      */
     constructor(dedupStorage: Storage_2, ssoPromptSettings: TeamsBotSsoPromptSettings, teamsfx: TeamsFx, dialogName?: string);
+    constructor(dedupStorage: Storage_2, ssoPromptSettings: TeamsBotSsoPromptSettings, authConfig: OnBehalfOfCredentialAuthConfig, initiateLoginEndpoint: string, dialogName?: string);
     /**
      * Add TeamsFxBotSsoCommandHandler instance
      * @param handler {@link BotSsoExecutionDialogHandler} callback function
@@ -803,7 +812,6 @@ export declare function createApiClient(apiEndpoint: string, authProvider: AuthP
 
 /**
  * Get Microsoft graph client.
- *
  * @example
  * Get Microsoft graph client by TokenCredential
  * ```typescript
@@ -852,6 +860,59 @@ export declare function createApiClient(apiEndpoint: string, authProvider: AuthP
  */
 export declare function createMicrosoftGraphClient(teamsfx: TeamsFxConfiguration, scopes?: string | string[]): Client;
 
+/**
+ * Get Microsoft graph client.
+ * @example
+ * Get Microsoft graph client by TokenCredential
+ * ```typescript
+ * // In browser: TeamsUserCredential
+ * const authConfig: TeamsUserCredentialAuthConfig = {
+ *   clientId: "xxx",
+ initiateLoginEndpoint: "https://xxx/auth-start.html",
+ * };
+
+ * const credential = new TeamsUserCredential(authConfig);
+
+ * const scope = "User.Read";
+ * await credential.login(scope);
+
+ * const client = createMicrosoftGraphClientWithCredential(credential, scope);
+
+ * // In node: OnBehalfOfUserCredential
+ * const oboAuthConfig: OnBehalfOfCredentialAuthConfig = {
+ *   authorityHost: "xxx",
+ *   clientId: "xxx",
+ *   tenantId: "xxx",
+ *   clientSecret: "xxx",
+ * };
+
+ * const oboCredential = new OnBehalfOfUserCredential(ssoToken, oboAuthConfig);
+ * const scope = "User.Read";
+ * const client = createMicrosoftGraphClientWithCredential(oboCredential, scope);
+
+ * // In node: AppCredential
+ * const appAuthConfig: AppCredentialAuthConfig = {
+ *   authorityHost: "xxx",
+ *   clientId: "xxx",
+ *   tenantId: "xxx",
+ *   clientSecret: "xxx",
+ * };
+ * const appCredential = new AppCredential(appAuthConfig);
+ * const scope = "User.Read";
+ * const client = createMicrosoftGraphClientWithCredential(appCredential, scope);
+ *
+ * const profile = await client.api("/me").get();
+ * ```
+ *
+ * @param {TokenCredential} credential - Used to provide configuration and auth.
+ * @param scopes - The array of Microsoft Token scope of access. Default value is `[.default]`.
+ *
+ * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
+ *
+ * @returns Graph client with specified scopes.
+ */
+export declare function createMicrosoftGraphClientWithCredential(credential: TokenCredential, scopes?: string | string[]): Client;
+
 /**
  * Helper to create SecureContextOptions from PEM format cert
  *
@@ -1003,6 +1064,8 @@ export declare interface GetTeamsUserTokenOptions extends GetTokenOptions {
 /**
  * Generate connection configuration consumed by tedious.
  *
+ * @deprecated we recommend you compose your own Tedious configuration for better flexibility.
+ *
  * @param {TeamsFx} teamsfx - Used to provide configuration and auth
  * @param { string? } databaseName - specify database name to override default one if there are multiple databases.
  *
@@ -1018,6 +1081,27 @@ export declare function getTediousConnectionConfig(teamsfx: TeamsFx, databaseNam
  * Users execute query in message extension with SSO or access token.
  *
  * @param {TurnContext} context - The context object for the current turn.
+ * @param {OnBehalfOfCredentialAuthConfig} config - User custom the message extension authentication configuration.
+ * @param {initiateLoginEndpoint} initiateLoginEndpoint - Login page for Teams to redirect to.
+ * @param {string| string[]} scopes - The list of scopes for which the token will have access.
+ * @param {function} logic - Business logic when executing the query in message extension with SSO or access token.
+ *
+ * @throws {@link ErrorCode|InternalError} when User invoke not response to message extension query.
+ * @throws {@link ErrorCode|InternalError} when failed to get access token with unknown error.
+ * @throws {@link ErrorCode|TokenExpiredError} when SSO token has already expired.
+ * @throws {@link ErrorCode|ServiceError} when failed to get access token from simple auth server.
+ * @throws {@link ErrorCode|InvalidParameter} when scopes is not a valid string or string array.
+ * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is nodeJS.
+ *
+ * @returns A MessageExtension Response for the activity. If the logic not return any, return void instead.
+ */
+export declare function handleMessageExtensionQueryWithSSO(context: TurnContext, config: OnBehalfOfCredentialAuthConfig, initiateLoginEndpoint: string, scopes: string | string[], logic: (token: MessageExtensionTokenResponse) => Promise<any>): Promise<void | MessagingExtensionResponse>;
+
+/**
+ * Users execute query in message extension with SSO or access token.
+ *
+ *
+ * @param {TurnContext} context - The context object for the current turn.
  * @param {AuthenticationConfiguration} config - User custom the message extension authentication configuration.
  * @param {string| string[]} scopes - The list of scopes for which the token will have access.
  * @param {function} logic - Business logic when executing the query in message extension with SSO or access token.
@@ -1380,7 +1464,7 @@ declare interface MessageResponse {
  * Microsoft Graph auth provider for Teams Framework
  */
 export declare class MsGraphAuthProvider implements AuthenticationProvider {
-    private teamsfx;
+    private credentialOrTeamsFx;
     private scopes;
     /**
      * Constructor of MsGraphAuthProvider.
@@ -1393,6 +1477,7 @@ export declare class MsGraphAuthProvider implements AuthenticationProvider {
      * @returns An instance of MsGraphAuthProvider.
      */
     constructor(teamsfx: TeamsFxConfiguration, scopes?: string | string[]);
+    constructor(credential: TokenCredential, scopes?: string | string[]);
     /**
      * Get access token for Microsoft Graph API requests.
      *
@@ -1586,6 +1671,40 @@ export declare enum NotificationTargetType {
     Person = "Person"
 }
 
+/**
+ * Authentication configuration for OnBehalfOfCredential used in node environment
+ */
+export declare type OnBehalfOfCredentialAuthConfig = {
+    /**
+     * Hostname of AAD authority.
+     */
+    authorityHost: string;
+    /**
+     * The client (application) ID of an App Registration in the tenant
+     */
+    clientId: string;
+    /**
+     * AAD tenant id
+     *
+     * @readonly
+     */
+    tenantId: string;
+} & ({
+    /**
+     * Secret string that the application uses when requesting a token. Only used in confidential client applications. Can be created in the Azure app registration portal.
+     */
+    clientSecret: string;
+    certificateContent?: never;
+} | {
+    clientSecret?: never;
+    /**
+     * The content of a PEM-encoded public/private key certificate.
+     *
+     * @readonly
+     */
+    certificateContent: string;
+});
+
 /**
  * Represent on-behalf-of flow to get user identity, and it is designed to be used in server side.
  *
@@ -1613,6 +1732,7 @@ export declare class OnBehalfOfUserCredential implements TokenCredential {
      * @throws {@link ErrorCode|InternalError} when SSO token is not valid.
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
      */
+    constructor(ssoToken: string, config: OnBehalfOfCredentialAuthConfig);
     constructor(ssoToken: string, config: AuthenticationConfiguration);
     /**
      * Get access token from credential.
@@ -1875,7 +1995,8 @@ export declare class TeamsBotInstallation implements NotificationTarget {
  * ```
  */
 export declare class TeamsBotSsoPrompt extends Dialog {
-    private teamsfx;
+    private authConfig;
+    private initiateLoginEndpoint;
     private settings;
     /**
      * Constructor of TeamsBotSsoPrompt.
@@ -1888,6 +2009,7 @@ export declare class TeamsBotSsoPrompt extends Dialog {
      * @throws {@link ErrorCode|RuntimeNotSupported} when runtime is browser.
      */
     constructor(teamsfx: TeamsFx, dialogId: string, settings: TeamsBotSsoPromptSettings);
+    constructor(authConfig: OnBehalfOfCredentialAuthConfig, initiateLoginEndpoint: string, dialogId: string, settings: TeamsBotSsoPromptSettings);
     /**
      * Called when a prompt dialog is pushed onto the dialog stack and is being activated.
      * @remarks
@@ -2256,6 +2378,7 @@ export declare class TeamsUserCredential implements TokenCredential {
      * @remarks
      * Can only be used within Teams.
      */
+    constructor(authConfig: TeamsUserCredentialAuthConfig);
     constructor(authConfig: AuthenticationConfiguration);
     /**
      * Popup login page to get user's access token with specific scopes.
@@ -2283,6 +2406,20 @@ export declare class TeamsUserCredential implements TokenCredential {
     getUserInfo(resources?: string[]): Promise<UserInfo>;
 }
 
+/**
+ * Authentication configuration for TeamsUserCredential used in browser environment
+ */
+export declare type TeamsUserCredentialAuthConfig = {
+    /**
+     * Login page for Teams to redirect to.
+     */
+    initiateLoginEndpoint: string;
+    /**
+     * The client (application) ID of an App Registration in the tenant
+     */
+    clientId: string;
+};
+
 /**
  * The trigger pattern used to trigger a {@link TeamsFxBotCommandHandler} instance.
  */