idea-aws 3.11.7 → 3.12.0

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

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/dist/src/resourceController.d.ts

@@ -125,12 +125,12 @@ export declare abstract class ResourceController extends GenericController {
     t(key: string, interpolateParams?: any): string;
     /**
      * Interpolates a string to replace parameters.
-     * "This is a {{ key }}" ==> "This is a value", with params = { key: "value" }
+     * `"This is a {{ key }}"` ==> `"This is a value", with params = { key: "value" }`.
      */
     private interpolate;
     /**
      * Gets a value from an object by composed key.
-     * getValue({ key1: { keyA: 'valueI' }}, 'key1.keyA') ==> 'valueI'
+     * `getValue({ key1: { keyA: 'valueI' }}, 'key1.keyA')` ==> `'valueI'`.
      */
     private getValue;
     /**

package/dist/src/resourceController.js

@@ -379,7 +379,7 @@ class ResourceController extends genericController_1.GenericController {
     }
     /**
      * Interpolates a string to replace parameters.
-     * "This is a {{ key }}" ==> "This is a value", with params = { key: "value" }
+     * `"This is a {{ key }}"` ==> `"This is a value", with params = { key: "value" }`.
      */
     interpolate(expr, params) {
         if (!params || !expr)
@@ -391,7 +391,7 @@ class ResourceController extends genericController_1.GenericController {
     }
     /**
      * Gets a value from an object by composed key.
-     * getValue({ key1: { keyA: 'valueI' }}, 'key1.keyA') ==> 'valueI'
+     * `getValue({ key1: { keyA: 'valueI' }}, 'key1.keyA')` ==> `'valueI'`.
      */
     getValue(target, key) {
         const keys = typeof key === 'string' ? key.split('.') : [key];

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "idea-aws",
-  "version": "3.11.7",
+  "version": "3.12.0",
   "description": "AWS wrappers to use in IDEA's back-ends",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "lint": "eslint --ext .ts",
     "compile": "tsc --build",
-    "docs": "typedoc",
+    "docs": "typedoc index.ts",
     "build": "./build.sh",
     "publishPackage": "./build.sh && npm publish"
   },
@@ -35,7 +35,7 @@
   },
   "homepage": "https://iter-idea.github.io/IDEA-AWS",
   "dependencies": {
-    "idea-toolbox": "^6.5.16",
+    "idea-toolbox": "^6.5.18",
     "nanoid": "^4.0.0",
     "nodemailer": "^6.7.5",
     "shortid": "^2.2.16",
@@ -43,7 +43,7 @@
     "uuid": "^8.3.2"
   },
   "devDependencies": {
-    "@tsconfig/node14": "^1.0.0",
+    "@tsconfig/node16": "^1.0.3",
     "@types/aws-lambda": "^8.10.91",
     "@types/node": "^14.14.26",
     "@types/nodemailer": "^6.4.4",