@microsoft/teamsfx 2.2.1 → 2.2.2-alpha.735b0b61a.0

package/dist/index.esm2017.mjs

@@ -2396,6 +2396,13 @@ class CommandBot$1 {
 function cloneConversation(conversation) {
     return JSON.parse(JSON.stringify(conversation));
 }
+/**
+ * @internal
+ */
+function getKey(reference) {
+    var _a, _b;
+    return `_${(_a = reference.conversation) === null || _a === void 0 ? void 0 : _a.tenantId}_${(_b = reference.conversation) === null || _b === void 0 ? void 0 : _b.id}`;
+}
 /**
  * @internal
  */
@@ -2458,7 +2465,9 @@ class NotificationMiddleware {
             case ActivityType.CurrentBotInstalled:
             case ActivityType.TeamRestored: {
                 const reference = TurnContext.getConversationReference(context.activity);
-                await this.conversationReferenceStore.set(reference);
+                await this.conversationReferenceStore.add(getKey(reference), reference, {
+                    overwrite: true,
+                });
                 break;
             }
             case ActivityType.CurrentBotMessaged: {
@@ -2468,7 +2477,7 @@ class NotificationMiddleware {
             case ActivityType.CurrentBotUninstalled:
             case ActivityType.TeamDeleted: {
                 const reference = TurnContext.getConversationReference(context.activity);
-                await this.conversationReferenceStore.delete(reference);
+                await this.conversationReferenceStore.remove(getKey(reference), reference);
                 break;
             }
         }
@@ -2505,18 +2514,16 @@ class NotificationMiddleware {
         const reference = TurnContext.getConversationReference(context.activity);
         const conversationType = (_a = reference === null || reference === void 0 ? void 0 : reference.conversation) === null || _a === void 0 ? void 0 : _a.conversationType;
         if (conversationType === "personal" || conversationType === "groupChat") {
-            if (!(await this.conversationReferenceStore.check(reference))) {
-                await this.conversationReferenceStore.set(reference);
-            }
+            await this.conversationReferenceStore.add(getKey(reference), reference, { overwrite: false });
         }
         else if (conversationType === "channel") {
             const teamId = (_d = (_c = (_b = context.activity) === null || _b === void 0 ? void 0 : _b.channelData) === null || _c === void 0 ? void 0 : _c.team) === null || _d === void 0 ? void 0 : _d.id;
             if (teamId !== undefined) {
                 const teamReference = cloneConversation(reference);
                 teamReference.conversation.id = teamId;
-                if (!(await this.conversationReferenceStore.check(teamReference))) {
-                    await this.conversationReferenceStore.set(teamReference);
-                }
+                await this.conversationReferenceStore.add(getKey(teamReference), teamReference, {
+                    overwrite: false,
+                });
             }
         }
     }
@@ -2618,26 +2625,36 @@ class LocalFileStorage {
 /**
  * @internal
  */
-class ConversationReferenceStore {
+class DefaultConversationReferenceStore {
     constructor(storage) {
         this.storage = storage;
     }
-    async check(reference) {
-        const ref = await this.storage.read(this.getKey(reference));
-        return ref !== undefined;
-    }
-    getAll() {
-        return this.storage.list();
-    }
-    set(reference) {
-        return this.storage.write(this.getKey(reference), reference);
+    async add(key, reference, options) {
+        if (options.overwrite) {
+            await this.storage.write(key, reference);
+            return true;
+        }
+        const ref = await this.storage.read(key);
+        if (ref === undefined) {
+            await this.storage.write(key, reference);
+            return true;
+        }
+        return false;
     }
-    delete(reference) {
-        return this.storage.delete(this.getKey(reference));
+    async remove(key, reference) {
+        const ref = await this.storage.read(key);
+        if (ref === undefined) {
+            return false;
+        }
+        await this.storage.delete(key);
+        return true;
     }
-    getKey(reference) {
-        var _a, _b;
-        return `_${(_a = reference.conversation) === null || _a === void 0 ? void 0 : _a.tenantId}_${(_b = reference.conversation) === null || _b === void 0 ? void 0 : _b.id}`;
+    async list(pageSize, continuationToken) {
+        const data = await this.storage.list();
+        return {
+            data,
+            continuationToken: "",
+        };
     }
 }
 
@@ -3022,7 +3039,7 @@ class NotificationBot$1 {
     constructor(adapter, options) {
         var _a, _b;
         const storage = (_a = options === null || options === void 0 ? void 0 : options.storage) !== null && _a !== void 0 ? _a : new LocalFileStorage(path.resolve(process.env.RUNNING_ON_AZURE === "1" ? (_b = process.env.TEMP) !== null && _b !== void 0 ? _b : "./" : "./"));
-        this.conversationReferenceStore = new ConversationReferenceStore(storage);
+        this.conversationReferenceStore = new DefaultConversationReferenceStore(storage);
         this.adapter = adapter.use(new NotificationMiddleware({
             conversationReferenceStore: this.conversationReferenceStore,
         }));
@@ -3039,7 +3056,7 @@ class NotificationBot$1 {
         if (this.conversationReferenceStore === undefined || this.adapter === undefined) {
             throw new Error("NotificationBot has not been initialized.");
         }
-        const references = await this.conversationReferenceStore.getAll();
+        const { data: references } = await this.conversationReferenceStore.list();
         const targets = [];
         for (const reference of references) {
             // validate connection
@@ -3059,7 +3076,7 @@ class NotificationBot$1 {
                 targets.push(new TeamsBotInstallation$1(this.adapter, reference));
             }
             else {
-                await this.conversationReferenceStore.delete(reference);
+                await this.conversationReferenceStore.remove(getKey(reference), reference);
             }
         }
         return targets;
@@ -4442,23 +4459,42 @@ class TeamsBotInstallation {
         }
         return channels;
     }
+    /**
+     * 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.
+     */
+    async getPagedMembers(pageSize, continuationToken) {
+        let result = {
+            data: [],
+            continuationToken: "",
+        };
+        await this.adapter.continueConversationAsync(this.botAppId, this.conversationReference, async (context) => {
+            const pagedMembers = await TeamsInfo.getPagedMembers(context, pageSize, continuationToken);
+            result = {
+                data: pagedMembers.members.map((m) => new Member(this, m)),
+                continuationToken: pagedMembers.continuationToken,
+            };
+        });
+        return result;
+    }
     /**
      * Get members from this bot installation.
      *
      * @returns An array of members from where the bot is installed.
+     *
+     * @deprecated Use `getPagedMembers` instead.
      */
     async members() {
         const members = [];
-        await this.adapter.continueConversationAsync(this.botAppId, this.conversationReference, async (context) => {
-            let continuationToken;
-            do {
-                const pagedMembers = await TeamsInfo.getPagedMembers(context, undefined, continuationToken);
-                continuationToken = pagedMembers.continuationToken;
-                for (const member of pagedMembers.members) {
-                    members.push(new Member(this, member));
-                }
-            } while (continuationToken !== undefined);
-        });
+        let continuationToken;
+        do {
+            const pagedData = await this.getPagedMembers(undefined, continuationToken);
+            continuationToken = pagedData.continuationToken;
+            members.push(...pagedData.data);
+        } while (continuationToken);
         return members;
     }
     /**
@@ -4495,28 +4531,48 @@ class NotificationBot {
      */
     constructor(adapter, options) {
         var _a, _b, _c;
-        const storage = (_a = options === null || options === void 0 ? void 0 : options.storage) !== null && _a !== void 0 ? _a : new LocalFileStorage(path.resolve(process.env.RUNNING_ON_AZURE === "1" ? (_b = process.env.TEMP) !== null && _b !== void 0 ? _b : "./" : "./"));
-        this.conversationReferenceStore = new ConversationReferenceStore(storage);
+        if (options === null || options === void 0 ? void 0 : options.store) {
+            this.conversationReferenceStore = options.store;
+        }
+        else {
+            const storage = (_a = options === null || options === void 0 ? void 0 : options.storage) !== null && _a !== void 0 ? _a : new LocalFileStorage(path.resolve(process.env.RUNNING_ON_AZURE === "1" ? (_b = process.env.TEMP) !== null && _b !== void 0 ? _b : "./" : "./"));
+            this.conversationReferenceStore = new DefaultConversationReferenceStore(storage);
+        }
         this.adapter = adapter.use(new NotificationMiddleware({
             conversationReferenceStore: this.conversationReferenceStore,
         }));
         this.botAppId = ((_c = options === null || options === void 0 ? void 0 : options.botAppId) !== null && _c !== void 0 ? _c : process.env.BOT_ID);
     }
     /**
-     * Get all targets where the bot is installed.
+     * Create a {@link TeamsBotInstallation} instance with conversation reference.
+     *
+     * @param conversationReference - The bound `ConversationReference`.
+     * @returns - The {@link TeamsBotInstallation} instance or null.
+     */
+    buildTeamsBotInstallation(conversationReference) {
+        if (!conversationReference) {
+            throw new Error("conversationReference is required.");
+        }
+        return new TeamsBotInstallation(this.adapter, conversationReference, this.botAppId);
+    }
+    /**
+     * Gets a pagined list of targets where the bot is installed.
      *
      * @remarks
      * The result is retrieving from the persisted storage.
      *
-     * @returns An array of {@link TeamsBotInstallation}.
+     * @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.
      */
-    async installations() {
+    async getPagedInstallations(pageSize, continuationToken) {
         if (this.conversationReferenceStore === undefined || this.adapter === undefined) {
             throw new Error("NotificationBot has not been initialized.");
         }
-        const references = await this.conversationReferenceStore.getAll();
+        const references = await this.conversationReferenceStore.list(pageSize, continuationToken);
         const targets = [];
-        for (const reference of references) {
+        for (const reference of references.data) {
             // validate connection
             let valid = true;
             await this.adapter.continueConversationAsync(this.botAppId, reference, async (context) => {
@@ -4534,9 +4590,32 @@ class NotificationBot {
                 targets.push(new TeamsBotInstallation(this.adapter, reference, this.botAppId));
             }
             else {
-                await this.conversationReferenceStore.delete(reference);
+                await this.conversationReferenceStore.remove(getKey(reference), reference);
             }
         }
+        return {
+            data: targets,
+            continuationToken: references.continuationToken,
+        };
+    }
+    /**
+     * Get all targets where the bot is installed.
+     *
+     * @remarks
+     * The result is retrieving from the persisted storage.
+     *
+     * @returns An array of {@link TeamsBotInstallation}.
+     *
+     * @deprecated Use getPagedInstallations instead.
+     */
+    async installations() {
+        let continuationToken;
+        const targets = [];
+        do {
+            const result = await this.getPagedInstallations(undefined, continuationToken);
+            continuationToken = result.continuationToken;
+            targets.push(...result.data);
+        } while (continuationToken);
         return targets;
     }
     /**