idea-aws 4.4.13 → 4.4.15

package/dist/src/attachments.d.ts

@@ -1,6 +1,6 @@
 import { SignedURL } from 'idea-toolbox';
 import { DynamoDB } from './dynamoDB';
-import { S3 } from './s3';
+import { S3, SignedURLOptions } from './s3';
 /**
  * A custom class that takes advantage of DynamoDB and S3 to easily manage attachments.
  */
@@ -8,20 +8,42 @@ export declare class Attachments {
     protected ddb: DynamoDB;
     protected s3: S3;
     /**
-     * The bucket where from to retrieve the attachments. Fallback to IDEA's default one.
+     * The bucket where from to retrieve the attachments. Fallback to IDEA's default one (CDK).
      */
-    protected S3_ATTACHMENTS_BUCKET: string;
+    bucket: string;
     /**
-     * The prefix for attachment IDs. Fallback to IDEA's default one.
+     * The folder where from to retrieve the attachments. Fallback to IDEA's default one (CDK).
      */
-    protected IUID_ATTACHMENTS_PREFIX: string;
-    constructor(ddb: DynamoDB, s3: S3);
+    folder: string;
     /**
-     * Get a signedURL to put an attachment.
+     * The default prefix for attachment IDs.
      */
-    put(project: string, teamId: string): Promise<SignedURL>;
+    prefix: string;
+    constructor(ddb: DynamoDB, s3: S3, options?: AttachmentsInitOptions);
     /**
-     * Get a signedURL to retrieve an attachment.
+     * Get a `SignedURL` to upload an attachment.
      */
-    get(attachmentId: string): Promise<SignedURL>;
+    put(options?: AttachmentsOptions): Promise<SignedURL>;
+    /**
+     * Get a `SignedURL` to download an attachment.
+     */
+    get(attachmentId: string, options?: AttachmentsOptions): Promise<SignedURL>;
+}
+/**
+ * Options when creating a new instance of Attachments.
+ */
+export interface AttachmentsInitOptions {
+    /**
+     * Whether to enable the compatibility mode to older versions (temporary, it will be removed).
+     */
+    compatibility?: 'v1';
+}
+/**
+ * Options when preparing for the upload/download of an attachment.
+ */
+export interface AttachmentsOptions extends SignedURLOptions {
+    /**
+     * The attachment ID prefix, if different from the internal attribute `prefix`.
+     */
+    prefix?: string;
 }

package/dist/src/attachments.js

@@ -1,37 +1,52 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Attachments = void 0;
+const genericController_1 = require("./genericController");
 /**
  * A custom class that takes advantage of DynamoDB and S3 to easily manage attachments.
  */
 class Attachments {
-    constructor(ddb, s3) {
+    constructor(ddb, s3, options = {}) {
         this.ddb = ddb;
         this.s3 = s3;
         /**
-         * The bucket where from to retrieve the attachments. Fallback to IDEA's default one.
+         * The bucket where from to retrieve the attachments. Fallback to IDEA's default one (CDK).
          */
-        this.S3_ATTACHMENTS_BUCKET = process.env.S3_ATTACHMENTS_BUCKET ?? 'idea-attachments';
+        this.bucket = process.env.S3_BUCKET_MEDIA;
         /**
-         * The prefix for attachment IDs. Fallback to IDEA's default one.
+         * The folder where from to retrieve the attachments. Fallback to IDEA's default one (CDK).
          */
-        this.IUID_ATTACHMENTS_PREFIX = process.env.IUID_ATTACHMENTS_PREFIX ?? 'ATT';
+        this.folder = process.env.S3_ATTACHMENTS_FOLDER;
+        /**
+         * The default prefix for attachment IDs.
+         */
+        this.prefix = process.env.PROJECT ? process.env.PROJECT.concat('_ATT') : 'ATT';
+        if (options.compatibility === 'v1') {
+            this.bucket = process.env.S3_ATTACHMENTS_BUCKET || 'idea-attachments';
+            this.folder = null;
+            this.prefix = 'ATT';
+        }
     }
     /**
-     * Get a signedURL to put an attachment.
+     * Get a `SignedURL` to upload an attachment.
      */
-    async put(project, teamId) {
-        const attachmentIdPrefix = this.IUID_ATTACHMENTS_PREFIX.concat('_', project, '_', teamId);
-        const attachmentId = await this.ddb.IUNID(attachmentIdPrefix);
-        const signedURL = await this.s3.signedURLPut(this.S3_ATTACHMENTS_BUCKET, attachmentId);
+    async put(options = {}) {
+        const attachmentId = await this.ddb.IUNID(options.prefix || this.prefix);
+        const key = this.folder ? `${this.folder}/${attachmentId}` : attachmentId;
+        const signedURL = await this.s3.signedURLPut(this.bucket, key);
         signedURL.id = attachmentId;
         return signedURL;
     }
     /**
-     * Get a signedURL to retrieve an attachment.
+     * Get a `SignedURL` to download an attachment.
      */
-    async get(attachmentId) {
-        const signedURL = await this.s3.signedURLGet(this.S3_ATTACHMENTS_BUCKET, attachmentId);
+    async get(attachmentId, options = {}) {
+        if (!attachmentId)
+            throw new genericController_1.HandledError('Missing attachment ID');
+        if (!attachmentId.startsWith(options.prefix || this.prefix))
+            throw new genericController_1.HandledError('Not found');
+        const key = this.folder ? `${this.folder}/${attachmentId}` : attachmentId;
+        const signedURL = await this.s3.signedURLGet(this.bucket, key);
         signedURL.id = attachmentId;
         return signedURL;
     }

package/dist/src/cognito.d.ts

@@ -97,6 +97,14 @@ export declare class Cognito {
      * Update a (Cognito)User's attributes, excluding the attributes that require specific methods.
      */
     updateUser(user: CognitoUser, userPoolId: string): Promise<void>;
+    /**
+     * Disable a cognito user.
+     */
+    disableUser(email: string, userPoolId: string): Promise<void>;
+    /**
+     * Enable a cognito user.
+     */
+    enableUser(email: string, userPoolId: string): Promise<void>;
     /**
      * Sign out the user from all devices.
      */
@@ -148,10 +156,14 @@ export interface CognitoUserGeneric {
      * The email (=== username).
      */
     email: string;
+    /**
+     * Whether the user has been disabled.
+     */
+    disabled: boolean;
     /**
      * Cognito can have custom attributes.
      */
-    [attribute: string]: string;
+    [attribute: string]: string | number | boolean;
 }
 /**
  * Options when creating a new user.

package/dist/src/cognito.js

@@ -68,6 +68,7 @@ class Cognito {
         (user.Attributes ?? user.UserAttributes ?? []).forEach((a) => (userAttributes[a.Name] = a.Value));
         if (!userAttributes.userId)
             userAttributes.userId = userAttributes.sub;
+        userAttributes.disabled = !user.Enabled;
         return userAttributes;
     }
     //
@@ -316,6 +317,20 @@ class Cognito {
         });
         await this.client.send(command);
     }
+    /**
+     * Disable a cognito user.
+     */
+    async disableUser(email, userPoolId) {
+        const command = new CognitoIP.AdminDisableUserCommand({ UserPoolId: userPoolId, Username: email });
+        await this.client.send(command);
+    }
+    /**
+     * Enable a cognito user.
+     */
+    async enableUser(email, userPoolId) {
+        const command = new CognitoIP.AdminEnableUserCommand({ UserPoolId: userPoolId, Username: email });
+        await this.client.send(command);
+    }
     /**
      * Sign out the user from all devices.
      */

package/dist/src/dynamoDB.d.ts

@@ -15,7 +15,7 @@ export declare class DynamoDB {
      */
     unmarshall(data: Record<string, any>, options?: DDBUtils.unmarshallOptions): Record<string, any>;
     /**
-     * Returns an IUNID: IDEA's Unique Nano IDentifier, which is an id unique through an IDEA's AWS account and region.
+     * Returns an IUNID: IDEA's Unique Nano IDentifier, which is an id unique through an AWS region inside an account.
      * Note: no need of an auth check for external uses: the permissions depend from the context in which it's executed.
      * @param project project code
      * @return the IUNID

package/dist/src/dynamoDB.js

@@ -49,7 +49,7 @@ class DynamoDB {
         return DDBUtils.unmarshall(data, options);
     }
     /**
-     * Returns an IUNID: IDEA's Unique Nano IDentifier, which is an id unique through an IDEA's AWS account and region.
+     * Returns an IUNID: IDEA's Unique Nano IDentifier, which is an id unique through an AWS region inside an account.
      * Note: no need of an auth check for external uses: the permissions depend from the context in which it's executed.
      * @param project project code
      * @return the IUNID

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "idea-aws",
-  "version": "4.4.13",
+  "version": "4.4.15",
   "description": "AWS wrappers to use in IDEA's back-ends",
   "license": "MPL-2.0",
   "main": "dist/index.js",
@@ -39,7 +39,7 @@
   "dependencies": {
     "@aws-lambda-powertools/metrics": "^1.18.1",
     "@aws-lambda-powertools/tracer": "^1.18.1",
-    "idea-toolbox": "^7.0.8",
+    "idea-toolbox": "^7.0.11",
     "nanoid": "^3.3.7",
     "nodemailer": "^6.9.14",
     "source-map-support": "^0.5.21"