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

package/dist/index.node.cjs.js

@@ -2469,6 +2469,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
  */
@@ -2532,7 +2539,9 @@ class NotificationMiddleware {
                 case ActivityType.CurrentBotInstalled:
                 case ActivityType.TeamRestored: {
                     const reference = botbuilder.TurnContext.getConversationReference(context.activity);
-                    yield this.conversationReferenceStore.set(reference);
+                    yield this.conversationReferenceStore.add(getKey(reference), reference, {
+                        overwrite: true,
+                    });
                     break;
                 }
                 case ActivityType.CurrentBotMessaged: {
@@ -2542,7 +2551,7 @@ class NotificationMiddleware {
                 case ActivityType.CurrentBotUninstalled:
                 case ActivityType.TeamDeleted: {
                     const reference = botbuilder.TurnContext.getConversationReference(context.activity);
-                    yield this.conversationReferenceStore.delete(reference);
+                    yield this.conversationReferenceStore.remove(getKey(reference), reference);
                     break;
                 }
             }
@@ -2581,18 +2590,16 @@ class NotificationMiddleware {
             const reference = botbuilder.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 (!(yield this.conversationReferenceStore.check(reference))) {
-                    yield this.conversationReferenceStore.set(reference);
-                }
+                yield 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 (!(yield this.conversationReferenceStore.check(teamReference))) {
-                        yield this.conversationReferenceStore.set(teamReference);
-                    }
+                    yield this.conversationReferenceStore.add(getKey(teamReference), teamReference, {
+                        overwrite: false,
+                    });
                 }
             }
         });
@@ -2705,28 +2712,42 @@ class LocalFileStorage {
 /**
  * @internal
  */
-class ConversationReferenceStore {
+class DefaultConversationReferenceStore {
     constructor(storage) {
         this.storage = storage;
     }
-    check(reference) {
+    add(key, reference, options) {
         return tslib.__awaiter(this, void 0, void 0, function* () {
-            const ref = yield this.storage.read(this.getKey(reference));
-            return ref !== undefined;
+            if (options.overwrite) {
+                yield this.storage.write(key, reference);
+                return true;
+            }
+            const ref = yield this.storage.read(key);
+            if (ref === undefined) {
+                yield this.storage.write(key, reference);
+                return true;
+            }
+            return false;
         });
     }
-    getAll() {
-        return this.storage.list();
-    }
-    set(reference) {
-        return this.storage.write(this.getKey(reference), reference);
-    }
-    delete(reference) {
-        return this.storage.delete(this.getKey(reference));
+    remove(key, reference) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            const ref = yield this.storage.read(key);
+            if (ref === undefined) {
+                return false;
+            }
+            yield 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}`;
+    list(pageSize, continuationToken) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            const data = yield this.storage.list();
+            return {
+                data,
+                continuationToken: "",
+            };
+        });
     }
 }
 
@@ -3133,7 +3154,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__namespace.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,
         }));
@@ -3151,7 +3172,7 @@ class NotificationBot$1 {
             if (this.conversationReferenceStore === undefined || this.adapter === undefined) {
                 throw new Error("NotificationBot has not been initialized.");
             }
-            const references = yield this.conversationReferenceStore.getAll();
+            const { data: references } = yield this.conversationReferenceStore.list();
             const targets = [];
             for (const reference of references) {
                 // validate connection
@@ -3171,7 +3192,7 @@ class NotificationBot$1 {
                     targets.push(new TeamsBotInstallation$1(this.adapter, reference));
                 }
                 else {
-                    yield this.conversationReferenceStore.delete(reference);
+                    yield this.conversationReferenceStore.remove(getKey(reference), reference);
                 }
             }
             return targets;
@@ -4612,24 +4633,45 @@ 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.
+     */
+    getPagedMembers(pageSize, continuationToken) {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            let result = {
+                data: [],
+                continuationToken: "",
+            };
+            yield this.adapter.continueConversationAsync(this.botAppId, this.conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
+                const pagedMembers = yield botbuilder.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.
      */
     members() {
         return tslib.__awaiter(this, void 0, void 0, function* () {
             const members = [];
-            yield this.adapter.continueConversationAsync(this.botAppId, this.conversationReference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
-                let continuationToken;
-                do {
-                    const pagedMembers = yield botbuilder.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 = yield this.getPagedMembers(undefined, continuationToken);
+                continuationToken = pagedData.continuationToken;
+                members.push(...pagedData.data);
+            } while (continuationToken);
             return members;
         });
     }
@@ -4669,29 +4711,49 @@ 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__namespace.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__namespace.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.
      */
-    installations() {
+    getPagedInstallations(pageSize, continuationToken) {
         return tslib.__awaiter(this, void 0, void 0, function* () {
             if (this.conversationReferenceStore === undefined || this.adapter === undefined) {
                 throw new Error("NotificationBot has not been initialized.");
             }
-            const references = yield this.conversationReferenceStore.getAll();
+            const references = yield this.conversationReferenceStore.list(pageSize, continuationToken);
             const targets = [];
-            for (const reference of references) {
+            for (const reference of references.data) {
                 // validate connection
                 let valid = true;
                 yield this.adapter.continueConversationAsync(this.botAppId, reference, (context) => tslib.__awaiter(this, void 0, void 0, function* () {
@@ -4709,9 +4771,34 @@ class NotificationBot {
                     targets.push(new TeamsBotInstallation(this.adapter, reference, this.botAppId));
                 }
                 else {
-                    yield this.conversationReferenceStore.delete(reference);
+                    yield 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.
+     */
+    installations() {
+        return tslib.__awaiter(this, void 0, void 0, function* () {
+            let continuationToken;
+            const targets = [];
+            do {
+                const result = yield this.getPagedInstallations(undefined, continuationToken);
+                continuationToken = result.continuationToken;
+                targets.push(...result.data);
+            } while (continuationToken);
             return targets;
         });
     }