@microsoft/teamsfx 2.2.1-rc.1 → 2.2.2-alpha.d8776a676.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/teamsfx",
-  "version": "2.2.1-rc.1",
+  "version": "2.2.2-alpha.d8776a676.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.14.6",
-    "@microsoft/adaptivecards-tools": "^1.3.1-rc.0",
+    "@microsoft/adaptivecards-tools": "1.3.2-alpha.d8776a676.0",
     "@microsoft/microsoft-graph-client": "^3.0.1",
     "axios": "^0.27.2",
     "botbuilder": ">=4.18.0 <5.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/eslint-plugin-teamsfx": "^0.0.2-rc.0",
+    "@microsoft/eslint-plugin-teamsfx": "0.0.3-alpha.d8776a676.0",
     "@microsoft/teams-js": "^2.7.1",
     "@rollup/plugin-json": "^4.1.0",
     "@types/chai": "^4.2.22",
@@ -130,7 +130,7 @@
     "webpack": "^5.62.1",
     "yargs": "^17.2.1"
   },
-  "gitHead": "2c9ab5d8d5d3489d268b42e1c9712b0f714cf5d5",
+  "gitHead": "3d0f8370706f4d607a3a0f7ab88da3181e13aa88",
   "publishConfig": {
     "access": "public"
   },

package/types/teamsfx.d.ts

@@ -1141,6 +1141,50 @@ export declare class BotSsoExecutionDialog extends ComponentDialog {
                       };
                   }
 
+                  /**
+                   * A store to persist notification target references.
+                   */
+                  export declare interface ConversationReferenceStore {
+                      /**
+                       * Add a conversation reference to the store. If overwrite, update existing one, otherwise add when not exist.
+                       *
+                       * @param key the key of the conversation reference.
+                       * @param reference the conversation reference to add.
+                       * @param options the options to add the conversation reference.
+                       *
+                       * @returns true if added or updated, false if not changed.
+                       */
+                      add(key: string, reference: Partial<ConversationReference>, options: ConversationReferenceStoreAddOptions): Promise<boolean>;
+                      /**
+                       * Remove a conversation reference from the store.
+                       *
+                       * @param key the key of the conversation reference.
+                       * @param reference the conversation reference to remove.
+                       *
+                       * @returns true if exist and removed, false if not changed.
+                       */
+                      remove(key: string, reference: Partial<ConversationReference>): Promise<boolean>;
+                      /**
+                       * List stored conversation reference by page.
+                       *
+                       * @param pageSize the page size.
+                       * @param continuationToken the continuation token to get next page.
+                       *
+                       * @returns a paged list of conversation references.
+                       */
+                      list(pageSize?: number, continuationToken?: string): Promise<PagedData<Partial<ConversationReference>>>;
+                  }
+
+                  /**
+                   * Options to add a conversation reference to the store.
+                   */
+                  export declare interface ConversationReferenceStoreAddOptions {
+                      /**
+                       * Whether to overwrite the existing conversation reference.
+                       */
+                      overwrite?: boolean;
+                  }
+
                   /**
                    * Initializes new Axios instance with specific auth provider
                    *
@@ -1989,6 +2033,25 @@ export declare class BotSsoExecutionDialog extends ComponentDialog {
                        * @param options - The initialize options
                        */
                       constructor(adapter: CloudAdapter, options?: NotificationOptions_3);
+                      /**
+                       * Create a {@link TeamsBotInstallation} instance with conversation reference.
+                       *
+                       * @param conversationReference - The bound `ConversationReference`.
+                       * @returns - The {@link TeamsBotInstallation} instance or null.
+                       */
+                      buildTeamsBotInstallation(conversationReference: Partial<ConversationReference>): TeamsBotInstallation_2 | null;
+                      /**
+                       * Gets a pagined list of targets where the bot is installed.
+                       *
+                       * @remarks
+                       * The result is retrieving from the persisted storage.
+                       *
+                       * @param pageSize - Suggested number of entries on a page.
+                       * @param continuationToken - A continuation token.
+                       *
+                       * @returns An array of {@link TeamsBotInstallation} with paged data and continuation token.
+                       */
+                      getPagedInstallations(pageSize?: number, continuationToken?: string): Promise<PagedData<TeamsBotInstallation_2>>;
                       /**
                        * Get all targets where the bot is installed.
                        *
@@ -1996,6 +2059,8 @@ export declare class BotSsoExecutionDialog extends ComponentDialog {
                        * The result is retrieving from the persisted storage.
                        *
                        * @returns An array of {@link TeamsBotInstallation}.
+                       *
+                       * @deprecated Use getPagedInstallations instead.
                        */
                       installations(): Promise<TeamsBotInstallation_2[]>;
                       /**
@@ -2075,15 +2140,29 @@ export declare class BotSsoExecutionDialog extends ComponentDialog {
                        */
                       botAppId?: string;
                       /**
-                       * An optional storage to persist bot notification connections.
+                       * An optional store to persist bot notification target references.
+                       *
+                       * @remarks
+                       * If `store` is not provided, a default conversation reference store will be used,
+                       * which stores notification target references 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 store for production environment.
+                       */
+                      store?: ConversationReferenceStore;
+                      /**
+                       * An optional storage to persist bot notification target references.
                        *
                        * @remarks
                        * If `storage` is not provided, a default local file storage will be used,
-                       * which stores notification connections into:
+                       * which stores notification target references 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.
+                       *
+                       * @deprecated Use `store` to customize the way to persist bot notification target references instead.
                        */
                       storage?: NotificationTargetStorage;
                   }
@@ -2120,6 +2199,9 @@ export declare class BotSsoExecutionDialog extends ComponentDialog {
 
                   /**
                    * Interface for a storage provider that stores and retrieves notification target references.
+                   *
+                   * @deprecated Use ConversationReferenceStore to customize the way
+                   * to persist bot notification connections instead.
                    */
                   export declare interface NotificationTargetStorage {
                       /**
@@ -2308,6 +2390,23 @@ export declare class BotSsoExecutionDialog extends ComponentDialog {
                       private generateAuthServerError;
                   }
 
+                  /**
+                   * Represents a page of data.
+                   */
+                  export declare interface PagedData<T> {
+                      /**
+                       * Page of data.
+                       */
+                      data: T[];
+                      /**
+                       * The Continuation Token to pass to get the next page of results.
+                       *
+                       * @remarks
+                       * Undefined or empty token means the page reaches the end.
+                       */
+                      continuationToken?: string;
+                  }
+
                   /**
                    * The search scope when calling {@link NotificationBot.findMember} and {@link NotificationBot.findAllMembers}.
                    * The search scope is a flagged enum and it can be combined with `|`.
@@ -2588,10 +2687,20 @@ export declare class BotSsoExecutionDialog extends ComponentDialog {
                        * @returns An array of channels if bot is installed into a team, otherwise returns an empty array.
                        */
                       channels(): Promise<Channel_2[]>;
+                      /**
+                       * Gets a pagined list of members from this bot installation.
+                       *
+                       * @param pageSize - Suggested number of entries on a page.
+                       * @param continuationToken - A continuation token.
+                       * @returns An array of members from where the bot is installed.
+                       */
+                      getPagedMembers(pageSize?: number, continuationToken?: string): Promise<PagedData<Member_2>>;
                       /**
                        * Get members from this bot installation.
                        *
                        * @returns An array of members from where the bot is installed.
+                       *
+                       * @deprecated Use `getPagedMembers` instead.
                        */
                       members(): Promise<Member_2[]>;
                       /**