idea-aws 3.11.9 → 3.13.0

package/dist/src/cognito.d.ts

@@ -33,12 +33,17 @@ export declare class Cognito {
      */
     getUserBySub(sub: string, cognitoUserPoolId: string): Promise<CognitoUserGeneric>;
     /**
-     * Get all the users of the pool.
+     * List all the users of the pool.
      */
-    getAllUsers(cognitoUserPoolId: string, options?: {
+    listUsers(cognitoUserPoolId: string, options?: {
         pagination?: string;
         users: CognitoUser[];
     }): Promise<CognitoUser[]>;
+    /**
+     * List all the users of the pool, including the information about the groups they're in.
+     * Note: it's slower than the alternative `getAllUsers`: use it only when needed.
+     */
+    listUsersWithGroupsDetail(cognitoUserPoolId: string): Promise<CognitoUser[]>;
     /**
      * Create a new user (by its email) in the pool specified.
      * @return userId of the new user
@@ -83,7 +88,10 @@ export declare class Cognito {
     /**
      * List the groups of the user pool.
      */
-    listGroups(cognitoUserPoolId: string): Promise<CognitoGroup[]>;
+    listGroups(cognitoUserPoolId: string, options?: {
+        pagination?: string;
+        groups: CognitoGroup[];
+    }): Promise<CognitoGroup[]>;
     /**
      * Create a new group in the user pool.
      */
@@ -95,7 +103,10 @@ export declare class Cognito {
     /**
      * List the users part of a group in the user pool.
      */
-    listUsersInGroup(group: string, cognitoUserPoolId: string): Promise<CognitoUser[]>;
+    listUsersInGroup(group: string, cognitoUserPoolId: string, options?: {
+        pagination?: string;
+        users: CognitoUser[];
+    }): Promise<CognitoUser[]>;
     /**
      * Add a user (by email) to a group in the user pool.
      */

package/dist/src/cognito.js

@@ -70,9 +70,9 @@ class Cognito {
         return this.mapCognitoUserAttributesAsPlainObject(user);
     }
     /**
-     * Get all the users of the pool.
+     * List all the users of the pool.
      */
-    async getAllUsers(cognitoUserPoolId, options = { users: [] }) {
+    async listUsers(cognitoUserPoolId, options = { users: [] }) {
         const params = { UserPoolId: cognitoUserPoolId };
         if (options.pagination)
             params.PaginationToken = options.pagination;
@@ -80,10 +80,31 @@ class Cognito {
         const pagination = res.PaginationToken;
         const users = options.users.concat(res.Users.map(u => new idea_toolbox_1.CognitoUser(this.mapCognitoUserAttributesAsPlainObject(u))));
         if (pagination)
-            return await this.getAllUsers(cognitoUserPoolId, { pagination, users });
+            return await this.listUsers(cognitoUserPoolId, { pagination, users });
         else
             return users;
     }
+    /**
+     * List all the users of the pool, including the information about the groups they're in.
+     * Note: it's slower than the alternative `getAllUsers`: use it only when needed.
+     */
+    async listUsersWithGroupsDetail(cognitoUserPoolId) {
+        const groups = await this.listGroups(cognitoUserPoolId);
+        const users = [];
+        for (const group of groups) {
+            const usersOfGroup = await this.listUsersInGroup(group.name, cognitoUserPoolId);
+            usersOfGroup.forEach(userInGroup => {
+                const userAlreadyInOutputList = users.find(u => u.userId === userInGroup.userId);
+                if (userAlreadyInOutputList)
+                    userAlreadyInOutputList.groups.push(group.name);
+                else {
+                    userInGroup.groups.push(group.name);
+                    users.push(userInGroup);
+                }
+            });
+        }
+        return users;
+    }
     /**
      * Create a new user (by its email) in the pool specified.
      * @return userId of the new user
@@ -250,10 +271,17 @@ class Cognito {
     /**
      * List the groups of the user pool.
      */
-    async listGroups(cognitoUserPoolId) {
-        const groupsList = await this.cognito.listGroups({ UserPoolId: cognitoUserPoolId }).promise();
-        const groups = groupsList.Groups.map(g => ({ name: g.GroupName, description: g.Description }));
-        return groups;
+    async listGroups(cognitoUserPoolId, options = { groups: [] }) {
+        const params = { UserPoolId: cognitoUserPoolId };
+        if (options.pagination)
+            params.NextToken = options.pagination;
+        const res = await this.cognito.listGroups(params).promise();
+        const pagination = res.NextToken;
+        const groups = options.groups.concat(res.Groups.map(g => ({ name: g.GroupName, description: g.Description })));
+        if (pagination)
+            return await this.listGroups(cognitoUserPoolId, { pagination, groups });
+        else
+            return groups;
     }
     /**
      * Create a new group in the user pool.
@@ -270,12 +298,20 @@ class Cognito {
     /**
      * List the users part of a group in the user pool.
      */
-    async listUsersInGroup(group, cognitoUserPoolId) {
-        const usersInGroupList = await this.cognito
-            .listUsersInGroup({ UserPoolId: cognitoUserPoolId, GroupName: group })
-            .promise();
-        const users = usersInGroupList.Users.map(u => new idea_toolbox_1.CognitoUser(this.mapCognitoUserAttributesAsPlainObject(u)));
-        return users;
+    async listUsersInGroup(group, cognitoUserPoolId, options = { users: [] }) {
+        const params = {
+            UserPoolId: cognitoUserPoolId,
+            GroupName: group
+        };
+        if (options.pagination)
+            params.NextToken = options.pagination;
+        const res = await this.cognito.listUsersInGroup(params).promise();
+        const pagination = res.NextToken;
+        const users = options.users.concat(res.Users.map(u => new idea_toolbox_1.CognitoUser(this.mapCognitoUserAttributesAsPlainObject(u))));
+        if (pagination)
+            return await this.listUsersInGroup(group, cognitoUserPoolId, { pagination, users });
+        else
+            return users;
     }
     /**
      * Add a user (by email) to a group in the user pool.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "idea-aws",
-  "version": "3.11.9",
+  "version": "3.13.0",
   "description": "AWS wrappers to use in IDEA's back-ends",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -35,25 +35,25 @@
   },
   "homepage": "https://iter-idea.github.io/IDEA-AWS",
   "dependencies": {
-    "idea-toolbox": "^6.5.18",
-    "nanoid": "^4.0.0",
-    "nodemailer": "^6.7.5",
+    "idea-toolbox": "^6.5.19",
+    "nanoid": "^3.3.4",
+    "nodemailer": "^6.7.7",
     "shortid": "^2.2.16",
     "source-map-support": "^0.5.21",
     "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@tsconfig/node16": "^1.0.3",
-    "@types/aws-lambda": "^8.10.91",
-    "@types/node": "^14.14.26",
+    "@types/aws-lambda": "^8.10.101",
+    "@types/node": "^18.6.3",
     "@types/nodemailer": "^6.4.4",
     "@types/shortid": "^0.0.29",
     "@types/uuid": "^8.3.4",
-    "@typescript-eslint/eslint-plugin": "^4.31.1",
-    "@typescript-eslint/parser": "^4.31.1",
-    "aws-sdk": "^2.991.0",
-    "eslint": "^7.32.0",
-    "typedoc": "^0.23.2",
-    "typescript": "^4.4.3"
+    "@typescript-eslint/eslint-plugin": "^5.32.0",
+    "@typescript-eslint/parser": "^5.32.0",
+    "aws-sdk": "^2.1187.0",
+    "eslint": "^8.21.0",
+    "typedoc": "^0.23.10",
+    "typescript": "^4.7.4"
   }
 }