@quatrain/storage-s3 1.2.1 → 1.2.3

package/dist/S3StorageAdapter.d.ts

@@ -1,13 +1,48 @@
 import { AbstractStorageAdapter, FileType, FileResponseLinkType, StorageParameters, DownloadFileMetaType } from '@quatrain/storage';
-import { Readable, Stream } from 'stream';
+import { Readable, Stream } from 'node:stream';
 import { S3Client } from '@aws-sdk/client-s3';
+/**
+ * Storage adapter implementation for AWS S3 compatible services.
+ * Implements direct stream uploads, presigned URLs, and multipart handling.
+ */
 export declare class S3StorageAdapter extends AbstractStorageAdapter {
     protected _client: S3Client;
     constructor(params: StorageParameters);
+    /**
+     * Validates the connection to the configured S3 endpoint by attempting to list buckets.
+     *
+     * @returns True if the connection succeeds and buckets are accessible.
+     */
     test(): Promise<boolean>;
+    /**
+     * Exposes the underlying AWS S3 Client instance.
+     *
+     * @returns The `S3Client` instance.
+     */
     getDriver(): S3Client;
+    /**
+     * Helper utility converting a Node.js Stream into a raw Buffer.
+     * Required for S3 payloads when streaming sizes are indeterminate.
+     *
+     * @param stream - The input stream.
+     * @returns A promise resolving to the concatenated Buffer.
+     */
     streamToBuffer(stream: Stream): Promise<Buffer>;
+    /**
+     * Uploads a file stream directly into an S3 Bucket.
+     *
+     * @param file - Target file metadata.
+     * @param stream - The content readable stream.
+     * @returns A promise resolving to the uploaded FileType metadata.
+     * @throws {Error} If the upload fails.
+     */
     create(file: FileType, stream: Readable): Promise<FileType>;
+    /**
+     * Copies an existing object within S3 to a new destination key or bucket.
+     *
+     * @param file - Source file.
+     * @param destFile - Destination file.
+     */
     copy(file: FileType, destFile: FileType): Promise<void>;
     /**
      * Move file to given destination
@@ -17,14 +52,63 @@ export declare class S3StorageAdapter extends AbstractStorageAdapter {
      * @returns
      */
     move(file: FileType, destFile: FileType): Promise<FileType>;
-    getUrl(file: FileType, expiresIn?: number, action?: any, extra?: any): Promise<{
+    /**
+     * Generates a temporary, presigned GET URL for public or secure access.
+     *
+     * @param file - Target file.
+     * @param expiresIn - URL expiration time in seconds.
+     * @param action - The requested action ('read', etc.).
+     * @param extra - Extra parameters such as 'cacheControl'.
+     * @returns A promise resolving to the generated URL and expiration payload.
+     */
+    _getUrl(file: FileType, expiresIn?: number, action?: any, extra?: any): Promise<{
         url: string;
         expiresIn: number;
     }>;
+    /**
+     * Deletes an object from the S3 Bucket.
+     *
+     * @param file - The file to remove.
+     * @returns A promise resolving to true on success.
+     */
     delete(file: FileType): Promise<boolean>;
+    /**
+     * Downloads an S3 object and returns it as a Node.js Readable stream.
+     *
+     * @param file - The target file.
+     * @returns A promise resolving to the ReadStream.
+     */
     getReadable(file: FileType): Promise<Readable>;
+    /**
+     * Issues a HEAD request to fetch S3 object metadata like size and content-type
+     * without downloading the actual payload.
+     *
+     * @param file - The file footprint.
+     * @returns A promise resolving to the augmented metadata.
+     */
     getMetaData(file: FileType): Promise<FileType>;
+    /**
+     * Directly pipes an S3 object to an external HTTP response or stream.
+     *
+     * @param file - Target file.
+     * @param res - The response or writable stream.
+     * @returns The piped stream instance.
+     */
     stream(file: FileType, res: any): Promise<any>;
+    /**
+     * Downloads an S3 object and writes it directly to the local filesystem.
+     *
+     * @param file - The remote file.
+     * @param meta - Local download path instructions.
+     * @returns A promise resolving to the local file path.
+     */
     download(file: FileType, meta: DownloadFileMetaType): Promise<string>;
+    /**
+     * Generates a presigned PUT URL allowing clients to upload directly to S3, bypassing the backend.
+     *
+     * @param file - The requested upload file destination.
+     * @param expiresIn - Token expiration in seconds.
+     * @returns A promise resolving to the upload URL instructions.
+     */
     getUploadUrl(file: FileType, expiresIn?: number): Promise<FileResponseLinkType>;
 }

package/dist/S3StorageAdapter.js

@@ -11,10 +11,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.S3StorageAdapter = void 0;
 const storage_1 = require("@quatrain/storage");
-const stream_1 = require("stream");
+const node_stream_1 = require("node:stream");
 const s3_request_presigner_1 = require("@aws-sdk/s3-request-presigner");
-const fs_1 = require("fs");
+const node_fs_1 = require("node:fs");
 const client_s3_1 = require("@aws-sdk/client-s3");
+/**
+ * Storage adapter implementation for AWS S3 compatible services.
+ * Implements direct stream uploads, presigned URLs, and multipart handling.
+ */
 class S3StorageAdapter extends storage_1.AbstractStorageAdapter {
     constructor(params) {
         super(params);
@@ -30,6 +34,11 @@ class S3StorageAdapter extends storage_1.AbstractStorageAdapter {
         this._client = new client_s3_1.S3Client(config);
         storage_1.Storage.info(`AWS Storage Adapter initialized in ${this._params.config.endpoint || this._params.config.region}`);
     }
+    /**
+     * Validates the connection to the configured S3 endpoint by attempting to list buckets.
+     *
+     * @returns True if the connection succeeds and buckets are accessible.
+     */
     test() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
@@ -44,9 +53,21 @@ class S3StorageAdapter extends storage_1.AbstractStorageAdapter {
             }
         });
     }
+    /**
+     * Exposes the underlying AWS S3 Client instance.
+     *
+     * @returns The `S3Client` instance.
+     */
     getDriver() {
         return this._client;
     }
+    /**
+     * Helper utility converting a Node.js Stream into a raw Buffer.
+     * Required for S3 payloads when streaming sizes are indeterminate.
+     *
+     * @param stream - The input stream.
+     * @returns A promise resolving to the concatenated Buffer.
+     */
     streamToBuffer(stream) {
         return __awaiter(this, void 0, void 0, function* () {
             return new Promise((resolve, reject) => {
@@ -57,6 +78,14 @@ class S3StorageAdapter extends storage_1.AbstractStorageAdapter {
             });
         });
     }
+    /**
+     * Uploads a file stream directly into an S3 Bucket.
+     *
+     * @param file - Target file metadata.
+     * @param stream - The content readable stream.
+     * @returns A promise resolving to the uploaded FileType metadata.
+     * @throws {Error} If the upload fails.
+     */
     create(file, stream) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
@@ -77,6 +106,12 @@ class S3StorageAdapter extends storage_1.AbstractStorageAdapter {
             }
         });
     }
+    /**
+     * Copies an existing object within S3 to a new destination key or bucket.
+     *
+     * @param file - Source file.
+     * @param destFile - Destination file.
+     */
     copy(file, destFile) {
         return __awaiter(this, void 0, void 0, function* () {
             storage_1.Storage.debug(`Copying file ${file.bucket}/${file.ref} to ${file.bucket}/${destFile.ref}`);
@@ -114,7 +149,16 @@ class S3StorageAdapter extends storage_1.AbstractStorageAdapter {
             return destFile;
         });
     }
-    getUrl(file_1) {
+    /**
+     * Generates a temporary, presigned GET URL for public or secure access.
+     *
+     * @param file - Target file.
+     * @param expiresIn - URL expiration time in seconds.
+     * @param action - The requested action ('read', etc.).
+     * @param extra - Extra parameters such as 'cacheControl'.
+     * @returns A promise resolving to the generated URL and expiration payload.
+     */
+    _getUrl(file_1) {
         return __awaiter(this, arguments, void 0, function* (file, expiresIn = 3600, action = 'read', extra = {}) {
             const commandArgs = {
                 Bucket: file.bucket,
@@ -130,6 +174,12 @@ class S3StorageAdapter extends storage_1.AbstractStorageAdapter {
             return { url, expiresIn };
         });
     }
+    /**
+     * Deletes an object from the S3 Bucket.
+     *
+     * @param file - The file to remove.
+     * @returns A promise resolving to true on success.
+     */
     delete(file) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
@@ -143,6 +193,12 @@ class S3StorageAdapter extends storage_1.AbstractStorageAdapter {
             return true;
         });
     }
+    /**
+     * Downloads an S3 object and returns it as a Node.js Readable stream.
+     *
+     * @param file - The target file.
+     * @returns A promise resolving to the ReadStream.
+     */
     getReadable(file) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
@@ -154,12 +210,19 @@ class S3StorageAdapter extends storage_1.AbstractStorageAdapter {
             const item = yield ((_a = this._client) === null || _a === void 0 ? void 0 : _a.send(command));
             const ByteArray = yield ((_b = item === null || item === void 0 ? void 0 : item.Body) === null || _b === void 0 ? void 0 : _b.transformToByteArray());
             const buffer = Buffer.from(ByteArray, 'base64');
-            const readable = new stream_1.Readable();
+            const readable = new node_stream_1.Readable();
             readable.push(buffer);
             readable.push(null);
             return readable;
         });
     }
+    /**
+     * Issues a HEAD request to fetch S3 object metadata like size and content-type
+     * without downloading the actual payload.
+     *
+     * @param file - The file footprint.
+     * @returns A promise resolving to the augmented metadata.
+     */
     getMetaData(file) {
         return __awaiter(this, void 0, void 0, function* () {
             const command = new client_s3_1.HeadObjectCommand({
@@ -171,6 +234,13 @@ class S3StorageAdapter extends storage_1.AbstractStorageAdapter {
             return meta;
         });
     }
+    /**
+     * Directly pipes an S3 object to an external HTTP response or stream.
+     *
+     * @param file - Target file.
+     * @param res - The response or writable stream.
+     * @returns The piped stream instance.
+     */
     stream(file, res) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;
@@ -181,19 +251,33 @@ class S3StorageAdapter extends storage_1.AbstractStorageAdapter {
             const item = yield this._client.send(command);
             const ByteArray = yield ((_a = item.Body) === null || _a === void 0 ? void 0 : _a.transformToByteArray());
             const buffer = Buffer.from(ByteArray, 'base64');
-            const readable = new stream_1.Readable();
+            const readable = new node_stream_1.Readable();
             readable.push(buffer);
             readable.push(null);
             return readable.pipe(res);
         });
     }
+    /**
+     * Downloads an S3 object and writes it directly to the local filesystem.
+     *
+     * @param file - The remote file.
+     * @param meta - Local download path instructions.
+     * @returns A promise resolving to the local file path.
+     */
     download(file, meta) {
         return __awaiter(this, void 0, void 0, function* () {
             const stream = yield this.getReadable(file);
-            yield new Promise((res) => stream.pipe((0, fs_1.createWriteStream)(meta.path)).on('close', () => res(true)));
+            yield new Promise((res) => stream.pipe((0, node_fs_1.createWriteStream)(meta.path)).on('close', () => res(true)));
             return meta.path;
         });
     }
+    /**
+     * Generates a presigned PUT URL allowing clients to upload directly to S3, bypassing the backend.
+     *
+     * @param file - The requested upload file destination.
+     * @param expiresIn - Token expiration in seconds.
+     * @returns A promise resolving to the upload URL instructions.
+     */
     getUploadUrl(file_1) {
         return __awaiter(this, arguments, void 0, function* (file, expiresIn = 3600) {
             const command = new client_s3_1.PutObjectCommand({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quatrain/storage-s3",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "Storage adapter for S3 compatible services",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -33,7 +33,7 @@
   "dependencies": {
     "@aws-sdk/client-s3": "^3.337.0",
     "@aws-sdk/s3-request-presigner": "^3.342.0",
-    "@quatrain/storage": "^1.2.1",
+    "@quatrain/storage": "^1.2.4",
     "fs-extra": "^11.2.0"
   },
   "scripts": {

package/src/S3StorageAdapter.ts

@@ -6,9 +6,9 @@ import {
    StorageParameters,
    DownloadFileMetaType,
 } from '@quatrain/storage'
-import { Readable, Stream } from 'stream'
+import { Readable, Stream } from 'node:stream'
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner'
-import { createWriteStream } from 'fs'
+import { createWriteStream } from 'node:fs'
 import {
    S3Client,
    PutObjectCommand,
@@ -19,6 +19,10 @@ import {
    ListBucketsCommand,
 } from '@aws-sdk/client-s3'
 
+/**
+ * Storage adapter implementation for AWS S3 compatible services.
+ * Implements direct stream uploads, presigned URLs, and multipart handling.
+ */
 export class S3StorageAdapter extends AbstractStorageAdapter {
    protected _client: S3Client
 
@@ -44,6 +48,11 @@ export class S3StorageAdapter extends AbstractStorageAdapter {
       )
    }
 
+   /**
+    * Validates the connection to the configured S3 endpoint by attempting to list buckets.
+    * 
+    * @returns True if the connection succeeds and buckets are accessible.
+    */
    async test(): Promise<boolean> {
       try {
          const command = new ListBucketsCommand()
@@ -56,10 +65,22 @@ export class S3StorageAdapter extends AbstractStorageAdapter {
       }
    }
 
+   /**
+    * Exposes the underlying AWS S3 Client instance.
+    * 
+    * @returns The `S3Client` instance.
+    */
    getDriver() {
       return this._client
    }
 
+   /**
+    * Helper utility converting a Node.js Stream into a raw Buffer.
+    * Required for S3 payloads when streaming sizes are indeterminate.
+    * 
+    * @param stream - The input stream.
+    * @returns A promise resolving to the concatenated Buffer.
+    */
    async streamToBuffer(stream: Stream): Promise<Buffer> {
       return new Promise<Buffer>((resolve, reject) => {
          const _buf: any[] = []
@@ -70,6 +91,14 @@ export class S3StorageAdapter extends AbstractStorageAdapter {
       })
    }
 
+   /**
+    * Uploads a file stream directly into an S3 Bucket.
+    * 
+    * @param file - Target file metadata.
+    * @param stream - The content readable stream.
+    * @returns A promise resolving to the uploaded FileType metadata.
+    * @throws {Error} If the upload fails.
+    */
    async create(file: FileType, stream: Readable): Promise<FileType> {
       try {
          const input = {
@@ -98,6 +127,12 @@ export class S3StorageAdapter extends AbstractStorageAdapter {
       }
    }
 
+   /**
+    * Copies an existing object within S3 to a new destination key or bucket.
+    * 
+    * @param file - Source file.
+    * @param destFile - Destination file.
+    */
    async copy(file: FileType, destFile: FileType) {
       Storage.debug(
          `Copying file ${file.bucket}/${file.ref} to ${file.bucket}/${destFile.ref}`
@@ -141,7 +176,16 @@ export class S3StorageAdapter extends AbstractStorageAdapter {
       return destFile
    }
 
-   async getUrl(file: FileType, expiresIn = 3600, action: any = 'read', extra: any = {}) {
+   /**
+    * Generates a temporary, presigned GET URL for public or secure access.
+    * 
+    * @param file - Target file.
+    * @param expiresIn - URL expiration time in seconds.
+    * @param action - The requested action ('read', etc.).
+    * @param extra - Extra parameters such as 'cacheControl'.
+    * @returns A promise resolving to the generated URL and expiration payload.
+    */
+   async _getUrl(file: FileType, expiresIn = 3600, action: any = 'read', extra: any = {}) {
       const commandArgs: any = {
          Bucket: file.bucket,
          Key: encodeURI(file.ref),
@@ -159,6 +203,12 @@ export class S3StorageAdapter extends AbstractStorageAdapter {
       return { url, expiresIn }
    }
 
+   /**
+    * Deletes an object from the S3 Bucket.
+    * 
+    * @param file - The file to remove.
+    * @returns A promise resolving to true on success.
+    */
    async delete(file: FileType) {
       Storage.debug(`Deleting file ${file.bucket}/${file.ref}`)
       const command = new DeleteObjectCommand({
@@ -172,6 +222,12 @@ export class S3StorageAdapter extends AbstractStorageAdapter {
       return true
    }
 
+   /**
+    * Downloads an S3 object and returns it as a Node.js Readable stream.
+    * 
+    * @param file - The target file.
+    * @returns A promise resolving to the ReadStream.
+    */
    async getReadable(file: FileType): Promise<Readable> {
       Storage.debug(`GET Readable for ${file.ref}`)
       const command = new GetObjectCommand({
@@ -188,6 +244,13 @@ export class S3StorageAdapter extends AbstractStorageAdapter {
       return readable
    }
 
+   /**
+    * Issues a HEAD request to fetch S3 object metadata like size and content-type
+    * without downloading the actual payload.
+    * 
+    * @param file - The file footprint.
+    * @returns A promise resolving to the augmented metadata.
+    */
    async getMetaData(file: FileType): Promise<FileType> {
       const command = new HeadObjectCommand({
          Bucket: file.bucket,
@@ -204,6 +267,13 @@ export class S3StorageAdapter extends AbstractStorageAdapter {
       return meta
    }
 
+   /**
+    * Directly pipes an S3 object to an external HTTP response or stream.
+    * 
+    * @param file - Target file.
+    * @param res - The response or writable stream.
+    * @returns The piped stream instance.
+    */
    async stream(file: FileType, res: any) {
       const command = new GetObjectCommand({
          Bucket: file.bucket,
@@ -219,6 +289,13 @@ export class S3StorageAdapter extends AbstractStorageAdapter {
       return readable.pipe(res)
    }
 
+   /**
+    * Downloads an S3 object and writes it directly to the local filesystem.
+    * 
+    * @param file - The remote file.
+    * @param meta - Local download path instructions.
+    * @returns A promise resolving to the local file path.
+    */
    async download(file: FileType, meta: DownloadFileMetaType) {
       const stream: Readable = await this.getReadable(file)
       await new Promise((res) =>
@@ -228,6 +305,13 @@ export class S3StorageAdapter extends AbstractStorageAdapter {
       return meta.path
    }
 
+   /**
+    * Generates a presigned PUT URL allowing clients to upload directly to S3, bypassing the backend.
+    * 
+    * @param file - The requested upload file destination.
+    * @param expiresIn - Token expiration in seconds.
+    * @returns A promise resolving to the upload URL instructions.
+    */
    async getUploadUrl(
       file: FileType,
       expiresIn = 3600