idea-aws 3.16.7 → 4.0.0

package/README.md

@@ -1,6 +1,6 @@
 # IDEA AWS
 
-AWS wrappers to use in IDEA's back-ends
+AWS wrappers to use in IDEA's back-ends; note: internally we use AWS-SDK _v3_.
 
 ## Installation
 
@@ -18,4 +18,4 @@ Documentation generated with TypeDoc: [link](https://iter-idea.github.io/IDEA-AW
 
 ## Notes
 
-The AWS-SDK is already pre-installed in every Lambda Function; therefore, it's a devDependency.
+The AWS-SDK (v3) is already pre-installed in every Lambda Function; therefore, the clients are all in `devDependency`.

package/dist/src/attachments.d.ts

@@ -26,5 +26,5 @@ export declare class Attachments {
     /**
      * Get a signedURL to retrieve an attachment.
      */
-    get(attachmentId: string): SignedURL;
+    get(attachmentId: string): Promise<SignedURL>;
 }

package/dist/src/attachments.js

@@ -22,15 +22,15 @@ class Attachments {
     async put(project, teamId) {
         const attachmentIdPrefix = this.IUID_ATTACHMENTS_PREFIX.concat('_').concat(project).concat('_').concat(teamId);
         const attachmentId = await this.dynamo.IUNID(attachmentIdPrefix);
-        const signedURL = this.s3.signedURLPut(this.S3_ATTACHMENTS_BUCKET, attachmentId);
+        const signedURL = await this.s3.signedURLPut(this.S3_ATTACHMENTS_BUCKET, attachmentId);
         signedURL.id = attachmentId;
         return signedURL;
     }
     /**
      * Get a signedURL to retrieve an attachment.
      */
-    get(attachmentId) {
-        const signedURL = this.s3.signedURLGet(this.S3_ATTACHMENTS_BUCKET, attachmentId);
+    async get(attachmentId) {
+        const signedURL = await this.s3.signedURLGet(this.S3_ATTACHMENTS_BUCKET, attachmentId);
         signedURL.id = attachmentId;
         return signedURL;
     }

package/dist/src/cognito.d.ts

@@ -1,10 +1,10 @@
-import { CognitoIdentityServiceProvider as CognitoISP } from 'aws-sdk';
+import * as CognitoIP from '@aws-sdk/client-cognito-identity-provider';
 import { CognitoUser } from 'idea-toolbox';
 /**
  * A wrapper for AWS Cognito.
  */
 export declare class Cognito {
-    protected cognito: CognitoISP;
+    protected cognito: CognitoIP.CognitoIdentityProviderClient;
     constructor(params?: {
         region?: string;
     });
@@ -17,9 +17,9 @@ export declare class Cognito {
      * Get the attributes of the user, from the authorizer claims.
      * @param claims authorizer claims
      * @return user's data
-     * @deprecated use IdeaX.CognitoUser instead
+     * @deprecated use idea-toolbox's CognitoUser instead
      */
-    getUserByClaims(claims: any): CognitoUserGeneric;
+    getUserByClaims(claims: Record<string, any>): CognitoUserGeneric;
     /**
      * Map the complex structure returned by Cognito for a user's attributes in a simple key-value object.
      */
@@ -68,11 +68,11 @@ export declare class Cognito {
     /**
      * Sign in a user of a specific pool through username and password.
      */
-    signIn(email: string, password: string, cognitoUserPoolId: string, cognitoUserPoolClientId: string): Promise<CognitoISP.AuthenticationResultType>;
+    signIn(email: string, password: string, cognitoUserPoolId: string, cognitoUserPoolClientId: string): Promise<CognitoIP.AuthenticationResultType>;
     /**
      * Given a username and a refresh token (and pool data), refresh the session and return the new tokens.
      */
-    refreshSession(email: string, refreshToken: string, cognitoUserPoolId: string, cognitoUserPoolClientId: string): Promise<CognitoISP.AuthenticationResultType>;
+    refreshSession(email: string, refreshToken: string, cognitoUserPoolId: string, cognitoUserPoolClientId: string): Promise<CognitoIP.AuthenticationResultType>;
     /**
      * Change the email address (== username) associated to a user.
      */
@@ -84,7 +84,7 @@ export declare class Cognito {
     /**
      * Send to a user the instructions to change the password.
      */
-    forgotPassword(email: string, cognitoUserPoolClientId: string): Promise<CognitoISP.CodeDeliveryDetailsType>;
+    forgotPassword(email: string, cognitoUserPoolClientId: string): Promise<CognitoIP.CodeDeliveryDetailsType>;
     /**
      * Update a (Cognito)User's attributes, excluding the attributes that require specific methods.
      */

package/dist/src/cognito.js

@@ -1,14 +1,37 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Cognito = void 0;
-const aws_sdk_1 = require("aws-sdk");
+const CognitoIP = __importStar(require("@aws-sdk/client-cognito-identity-provider"));
 const idea_toolbox_1 = require("idea-toolbox");
 /**
  * A wrapper for AWS Cognito.
  */
 class Cognito {
     constructor(params = {}) {
-        this.cognito = new aws_sdk_1.CognitoIdentityServiceProvider({ apiVersion: '2016-04-18', region: params.region });
+        this.cognito = new CognitoIP.CognitoIdentityProviderClient({ region: params.region });
     }
     /**
      * Change the region in which to find the user pool.
@@ -16,13 +39,13 @@ class Cognito {
      */
     setRegion(region) {
         // there is no quick way to change the region without re-creating the object
-        this.cognito = new aws_sdk_1.CognitoIdentityServiceProvider({ apiVersion: this.cognito.config.apiVersion, region });
+        this.cognito = new CognitoIP.CognitoIdentityProviderClient({ region });
     }
     /**
      * Get the attributes of the user, from the authorizer claims.
      * @param claims authorizer claims
      * @return user's data
-     * @deprecated use IdeaX.CognitoUser instead
+     * @deprecated use idea-toolbox's CognitoUser instead
      */
     getUserByClaims(claims) {
         if (!claims)
@@ -51,19 +74,28 @@ class Cognito {
      * Identify a user by its email address, returning its attributes.
      */
     async getUserByEmail(email, cognitoUserPoolId) {
-        const user = await this.cognito.adminGetUser({ UserPoolId: cognitoUserPoolId, Username: email }).promise();
-        if (!user)
-            throw new Error('User not found');
-        return this.mapCognitoUserAttributesAsPlainObject(user);
+        const command = new CognitoIP.AdminGetUserCommand({ UserPoolId: cognitoUserPoolId, Username: email });
+        try {
+            const user = await this.cognito.send(command);
+            return this.mapCognitoUserAttributesAsPlainObject(user);
+        }
+        catch (error) {
+            if (error.name === 'UserNotFoundException')
+                throw new Error('User not found');
+            throw error;
+        }
     }
     /**
      * Identify a user by its userId (sub), returning its attributes.
      */
     async getUserBySub(sub, cognitoUserPoolId) {
         // as of today, there is no a direct way to find a user by its sub: we need to run a query against the users base
-        const usersList = await this.cognito
-            .listUsers({ UserPoolId: cognitoUserPoolId, Filter: `sub = "${sub}"`, Limit: 1 })
-            .promise();
+        const command = new CognitoIP.ListUsersCommand({
+            UserPoolId: cognitoUserPoolId,
+            Filter: `sub = "${sub}"`,
+            Limit: 1
+        });
+        const usersList = await this.cognito.send(command);
         const user = usersList?.Users[0];
         if (!user)
             throw new Error('User not found');
@@ -76,9 +108,8 @@ class Cognito {
         const params = { UserPoolId: cognitoUserPoolId };
         if (options.pagination)
             params.PaginationToken = options.pagination;
-        const res = await this.cognito.listUsers(params).promise();
-        const pagination = res.PaginationToken;
-        const users = options.users.concat(res.Users.map(u => new idea_toolbox_1.CognitoUser(this.mapCognitoUserAttributesAsPlainObject(u))));
+        const { Users, PaginationToken: pagination } = await this.cognito.send(new CognitoIP.ListUsersCommand(params));
+        const users = options.users.concat(Users.map(u => new idea_toolbox_1.CognitoUser(this.mapCognitoUserAttributesAsPlainObject(u))));
         if (pagination)
             return await this.listUsers(cognitoUserPoolId, { pagination, users });
         else
@@ -134,12 +165,11 @@ class Cognito {
             params.MessageAction = 'SUPPRESS';
         if (options.temporaryPassword)
             params.TemporaryPassword = options.temporaryPassword;
-        const result = await this.cognito.adminCreateUser(params).promise();
-        const userId = this.mapCognitoUserAttributesAsPlainObject(result.User).sub;
-        if (userId)
-            return userId;
-        else
+        const { User } = await this.cognito.send(new CognitoIP.AdminCreateUserCommand(params));
+        const userId = this.mapCognitoUserAttributesAsPlainObject(User).sub;
+        if (!userId)
             throw new Error('Creation failed');
+        return userId;
     }
     /**
      * Resend the password to a user who never logged in.
@@ -154,7 +184,7 @@ class Cognito {
         };
         if (options.temporaryPassword)
             params.TemporaryPassword = options.temporaryPassword;
-        await this.cognito.adminCreateUser(params).promise();
+        await this.cognito.send(new CognitoIP.AdminCreateUserCommand(params));
     }
     /**
      * Set a new password for a specific user identified by its email (admin-only).
@@ -174,7 +204,7 @@ class Cognito {
             Password: password,
             Permanent: options.permanent
         };
-        await this.cognito.adminSetUserPassword(params).promise();
+        await this.cognito.send(new CognitoIP.AdminSetUserPasswordCommand(params));
     }
     /**
      * Delete a user by its email (username), in the pool specified.
@@ -182,41 +212,38 @@ class Cognito {
     async deleteUser(email, cognitoUserPoolId) {
         if ((0, idea_toolbox_1.isEmpty)(email, 'email'))
             throw new Error('Invalid email');
-        await this.cognito.adminDeleteUser({ UserPoolId: cognitoUserPoolId, Username: email }).promise();
+        const command = new CognitoIP.AdminDeleteUserCommand({ UserPoolId: cognitoUserPoolId, Username: email });
+        await this.cognito.send(command);
     }
     /**
      * Sign in a user of a specific pool through username and password.
      */
     async signIn(email, password, cognitoUserPoolId, cognitoUserPoolClientId) {
-        const result = await this.cognito
-            .adminInitiateAuth({
+        const command = new CognitoIP.AdminInitiateAuthCommand({
             UserPoolId: cognitoUserPoolId,
             ClientId: cognitoUserPoolClientId,
             AuthFlow: 'ADMIN_NO_SRP_AUTH',
             AuthParameters: { USERNAME: email, PASSWORD: password }
-        })
-            .promise();
-        if (result?.AuthenticationResult)
-            return result.AuthenticationResult;
-        else
+        });
+        const { AuthenticationResult } = await this.cognito.send(command);
+        if (!AuthenticationResult)
             throw new Error('Sign-in failed');
+        return AuthenticationResult;
     }
     /**
      * Given a username and a refresh token (and pool data), refresh the session and return the new tokens.
      */
     async refreshSession(email, refreshToken, cognitoUserPoolId, cognitoUserPoolClientId) {
-        const result = await this.cognito
-            .adminInitiateAuth({
+        const command = new CognitoIP.AdminInitiateAuthCommand({
             UserPoolId: cognitoUserPoolId,
             ClientId: cognitoUserPoolClientId,
             AuthFlow: 'REFRESH_TOKEN_AUTH',
             AuthParameters: { USERNAME: email, REFRESH_TOKEN: refreshToken }
-        })
-            .promise();
-        if (result?.AuthenticationResult)
-            return result.AuthenticationResult;
-        else
+        });
+        const { AuthenticationResult } = await this.cognito.send(command);
+        if (!AuthenticationResult)
             throw new Error('Refresh failed');
+        return AuthenticationResult;
     }
     /**
      * Change the email address (== username) associated to a user.
@@ -224,16 +251,15 @@ class Cognito {
     async updateEmail(email, newEmail, cognitoUserPoolId) {
         if ((0, idea_toolbox_1.isEmpty)(newEmail, 'email'))
             throw new Error('Invalid new email');
-        await this.cognito
-            .adminUpdateUserAttributes({
+        const command = new CognitoIP.AdminUpdateUserAttributesCommand({
             UserPoolId: cognitoUserPoolId,
             Username: email,
             UserAttributes: [
                 { Name: 'email', Value: newEmail },
                 { Name: 'email_verified', Value: 'true' }
             ]
-        })
-            .promise();
+        });
+        await this.cognito.send(command);
         // sign out the user from all its devices and resolve
         await this.globalSignOut(newEmail, cognitoUserPoolId);
     }
@@ -244,21 +270,19 @@ class Cognito {
         if (newPassword.length < 8)
             throw new Error('Invalid new password');
         const tokensForPasswordChange = await this.signIn(email, oldPassword, cognitoUserPoolId, cognitoUserPoolClientId);
-        await this.cognito
-            .changePassword({
+        const command = new CognitoIP.ChangePasswordCommand({
             AccessToken: tokensForPasswordChange.AccessToken,
             PreviousPassword: oldPassword,
             ProposedPassword: newPassword
-        })
-            .promise();
+        });
+        await this.cognito.send(command);
     }
     /**
      * Send to a user the instructions to change the password.
      */
     async forgotPassword(email, cognitoUserPoolClientId) {
-        const { CodeDeliveryDetails } = await this.cognito
-            .forgotPassword({ Username: email, ClientId: cognitoUserPoolClientId })
-            .promise();
+        const command = new CognitoIP.ForgotPasswordCommand({ Username: email, ClientId: cognitoUserPoolClientId });
+        const { CodeDeliveryDetails } = await this.cognito.send(command);
         return CodeDeliveryDetails;
     }
     /**
@@ -273,15 +297,19 @@ class Cognito {
             Name: 'custom:'.concat(customAttribute),
             Value: String(user.attributes[customAttribute])
         }));
-        await this.cognito
-            .adminUpdateUserAttributes({ UserPoolId: cognitoUserPoolId, Username: user.email, UserAttributes })
-            .promise();
+        const command = new CognitoIP.AdminUpdateUserAttributesCommand({
+            UserPoolId: cognitoUserPoolId,
+            Username: user.email,
+            UserAttributes
+        });
+        await this.cognito.send(command);
     }
     /**
      * Sign out the user from all devices.
      */
     async globalSignOut(email, cognitoUserPoolId) {
-        await this.cognito.adminUserGlobalSignOut({ Username: email, UserPoolId: cognitoUserPoolId }).promise();
+        const command = new CognitoIP.AdminUserGlobalSignOutCommand({ Username: email, UserPoolId: cognitoUserPoolId });
+        await this.cognito.send(command);
     }
     /**
      * Confirm and conclude a registration, usign a confirmation code.
@@ -293,9 +321,12 @@ class Cognito {
             throw new Error('Invalid confirmation code');
         if (!cognitoUserPoolClientId)
             throw new Error('Invalid client ID');
-        await this.cognito
-            .confirmSignUp({ Username: email, ConfirmationCode: confirmationCode, ClientId: cognitoUserPoolClientId })
-            .promise();
+        const command = new CognitoIP.ConfirmSignUpCommand({
+            Username: email,
+            ConfirmationCode: confirmationCode,
+            ClientId: cognitoUserPoolClientId
+        });
+        await this.cognito.send(command);
     }
     /**
      * List the groups of the user pool.
@@ -304,7 +335,7 @@ class Cognito {
         const params = { UserPoolId: cognitoUserPoolId };
         if (options.pagination)
             params.NextToken = options.pagination;
-        const res = await this.cognito.listGroups(params).promise();
+        const res = await this.cognito.send(new CognitoIP.ListGroupsCommand(params));
         const pagination = res.NextToken;
         const groups = options.groups.concat(res.Groups.map(g => ({ name: g.GroupName, description: g.Description })));
         if (pagination)
@@ -316,13 +347,15 @@ class Cognito {
      * Create a new group in the user pool.
      */
     async createGroup(groupName, cognitoUserPoolId) {
-        await this.cognito.createGroup({ GroupName: groupName, UserPoolId: cognitoUserPoolId }).promise();
+        const command = new CognitoIP.CreateGroupCommand({ GroupName: groupName, UserPoolId: cognitoUserPoolId });
+        await this.cognito.send(command);
     }
     /**
      * Delete a group from the user pool.
      */
     async deleteGroup(groupName, cognitoUserPoolId) {
-        await this.cognito.deleteGroup({ GroupName: groupName, UserPoolId: cognitoUserPoolId }).promise();
+        const command = new CognitoIP.DeleteGroupCommand({ GroupName: groupName, UserPoolId: cognitoUserPoolId });
+        await this.cognito.send(command);
     }
     /**
      * List the users part of a group in the user pool.
@@ -334,7 +367,7 @@ class Cognito {
         };
         if (options.pagination)
             params.NextToken = options.pagination;
-        const res = await this.cognito.listUsersInGroup(params).promise();
+        const res = await this.cognito.send(new CognitoIP.ListUsersInGroupCommand(params));
         const pagination = res.NextToken;
         const users = options.users.concat(res.Users.map(u => new idea_toolbox_1.CognitoUser(this.mapCognitoUserAttributesAsPlainObject(u))));
         if (pagination)
@@ -347,18 +380,24 @@ class Cognito {
      */
     async addUserToGroup(email, group, cognitoUserPoolId) {
         const user = new idea_toolbox_1.CognitoUser(await this.getUserByEmail(email, cognitoUserPoolId));
-        await this.cognito
-            .adminAddUserToGroup({ UserPoolId: cognitoUserPoolId, GroupName: group, Username: user.userId })
-            .promise();
+        const command = new CognitoIP.AdminAddUserToGroupCommand({
+            UserPoolId: cognitoUserPoolId,
+            GroupName: group,
+            Username: user.userId
+        });
+        await this.cognito.send(command);
     }
     /**
      * Remove a user (by email) from a group in the user pool.
      */
     async removeUserFromGroup(email, group, cognitoUserPoolId) {
         const user = new idea_toolbox_1.CognitoUser(await this.getUserByEmail(email, cognitoUserPoolId));
-        await this.cognito
-            .adminRemoveUserFromGroup({ UserPoolId: cognitoUserPoolId, GroupName: group, Username: user.userId })
-            .promise();
+        const command = new CognitoIP.AdminRemoveUserFromGroupCommand({
+            UserPoolId: cognitoUserPoolId,
+            GroupName: group,
+            Username: user.userId
+        });
+        await this.cognito.send(command);
     }
 }
 exports.Cognito = Cognito;

package/dist/src/comprehend.d.ts

@@ -1,4 +1,4 @@
-import { Comprehend as AmazonComprehend } from 'aws-sdk';
+import * as AmazonComprehend from '@aws-sdk/client-comprehend';
 import { Sentiment } from 'idea-toolbox';
 /**
  * A wrapper for Amazon Comprehend.
@@ -7,7 +7,7 @@ export declare class Comprehend {
     /**
      * The instance of Comprehend.
      */
-    protected comprehend: AmazonComprehend;
+    protected comprehend: AmazonComprehend.ComprehendClient;
     constructor(params?: {
         region?: string;
     });

package/dist/src/comprehend.js

@@ -1,13 +1,36 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Comprehend = void 0;
-const aws_sdk_1 = require("aws-sdk");
+const AmazonComprehend = __importStar(require("@aws-sdk/client-comprehend"));
 /**
  * A wrapper for Amazon Comprehend.
  */
 class Comprehend {
     constructor(params = {}) {
-        this.comprehend = new aws_sdk_1.Comprehend({ apiVersion: '2017-11-27', region: params.region });
+        this.comprehend = new AmazonComprehend.ComprehendClient({ region: params.region });
     }
     /**
      * Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).
@@ -15,9 +38,8 @@ class Comprehend {
     async detectSentiment(params) {
         if (!params.language || !params.text)
             throw new Error('Missing some parameters');
-        const result = await this.comprehend
-            .detectSentiment({ LanguageCode: params.language, Text: params.text })
-            .promise();
+        const command = new AmazonComprehend.DetectSentimentCommand({ LanguageCode: params.language, Text: params.text });
+        const result = await this.comprehend.send(command);
         return result.Sentiment;
     }
     /**
@@ -26,7 +48,8 @@ class Comprehend {
     async detectDominantLanguage(params) {
         if (!params.text)
             throw new Error('Missing text');
-        const result = await this.comprehend.detectDominantLanguage({ Text: params.text }).promise();
+        const command = new AmazonComprehend.DetectDominantLanguageCommand({ Text: params.text });
+        const result = await this.comprehend.send(command);
         if (!result.Languages.length)
             throw new Error('Not found');
         return result.Languages[0].LanguageCode;