idea-aws 4.4.14 → 4.4.16

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('-attachment') : 'attachment';
+        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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "idea-aws",
-  "version": "4.4.14",
+  "version": "4.4.16",
   "description": "AWS wrappers to use in IDEA's back-ends",
   "license": "MPL-2.0",
   "main": "dist/index.js",