@qrvey/object-storage 0.0.3 → 0.0.5

package/dist/esm/index.d.mts

@@ -1,10 +1,10 @@
-import { Readable } from 'stream';
+import stream, { Readable } from 'stream';
 
 type UploadResponse = {
     key: string;
 };
 
-type FileContent = Readable | ReadableStream | Blob;
+type FileContent = Readable | ReadableStream | Blob | Buffer;
 
 type ListRequestOptions = {
     prefix?: string;
@@ -45,6 +45,12 @@ type GetUploadUrlResponse = {
     signedUrl: string;
 };
 
+type CreateUploadWriteStreamResponse = {
+    key: string;
+    stream: stream.PassThrough;
+    promise: Promise<unknown>;
+};
+
 interface IObjectStorage {
     list(options: ListRequestOptions): Promise<ListResponse>;
     listAll(options: ListRequestOptions): Promise<ListResponse>;
@@ -55,6 +61,7 @@ interface IObjectStorage {
     upload(key: string, body: FileContent, metadata?: {
         [key: string]: string;
     }): Promise<UploadResponse>;
+    createUploadWriteStream(key: string): CreateUploadWriteStreamResponse;
     delete(key: string): Promise<boolean>;
 }
 
@@ -116,6 +123,14 @@ declare class ObjectStorageService {
     static upload(key: string, body: FileContent, metadata?: {
         [key: string]: string;
     }, bucketName?: string): Promise<UploadResponse>;
+    /**
+     * Creates an upload write stream for the specified key in the object storage service.
+     *
+     * @param {string} key - The key of the object to create the upload write stream for.
+     * @param {string} [bucketName] - The name of the bucket where the object will be stored. If not provided, the default bucket name will be used.
+     * @return {Promise<CreateUploadWriteStreamResponse>} A promise that resolves to the response of the upload operation.
+     */
+    static createUploadWriteStream(key: string, bucketName?: string): Promise<CreateUploadWriteStreamResponse>;
     /**
      * Deletes an object from the object storage service.
      *

package/dist/esm/index.mjs

@@ -1,6 +1,8 @@
 import { BlobServiceClient, BlobSASPermissions } from '@azure/storage-blob';
 import { S3Client, ListObjectsV2Command, HeadObjectCommand, GetObjectCommand, PutObjectCommand, DeleteObjectCommand } from '@aws-sdk/client-s3';
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
+import stream from 'stream';
+import { Upload } from '@aws-sdk/lib-storage';
 
 var __defProp = Object.defineProperty;
 var __defProps = Object.defineProperties;
@@ -44,6 +46,7 @@ var errorMessages = {
   SignatureDoesNotMatch: "The request signature we calculated does not match the signature you provided",
   SlowDown: "Please reduce your request rate",
   TemporaryRedirect: "Temporary redirect",
+  ObjectNotFound: "ObjectNotFound - The specified key does not exist. (404)",
   DEFAULT: "An unknown error occurred"
 };
 var ErrorHandler = class {
@@ -91,7 +94,8 @@ var BlobStorageService = class {
       process.env.AZURE_STORAGE_CONNECTION_STRING
     );
   }
-  getUploadUrl(key, expiresInMinutes) {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars, no-unused-vars
+  createUploadWriteStream(key) {
     throw new Error("Method not implemented.");
   }
   /**
@@ -100,34 +104,17 @@ var BlobStorageService = class {
    * @param {string} blobName - The name of the blob.
    * @return {Promise<GetObjectResponse>} A promise that resolves to the blob properties.
    */
-  getHeadObject(blobName) {
-    return new Promise((resolve, reject) => {
-      try {
-        const containerClient = this.blobServiceClient.getContainerClient(
-          this.containerName
-        );
-        const blockBlobClient = containerClient.getBlockBlobClient(blobName);
-        blockBlobClient.getProperties().then((blobProperties) => {
-          return resolve(
-            BlobPropertiesResponseToObjectResponse(
-              blobProperties
-            )
-          );
-        }).catch(
-          (error) => reject(
-            ErrorHandler.handleError(
-              "DEFAULT",
-              "",
-              error
-            )
-          )
-        );
-      } catch (error) {
-        return reject(
-          ErrorHandler.handleError("DEFAULT", "", error)
-        );
-      }
-    });
+  async getHeadObject(blobName) {
+    try {
+      const containerClient = this.blobServiceClient.getContainerClient(
+        this.containerName
+      );
+      const blockBlobClient = containerClient.getBlockBlobClient(blobName);
+      const blobProperties = await blockBlobClient.getProperties();
+      return BlobPropertiesResponseToObjectResponse(blobProperties);
+    } catch (error) {
+      throw ErrorHandler.handleError("DEFAULT", "", error);
+    }
   }
   /**
    * Retrieves an object from the blob storage service.
@@ -135,35 +122,57 @@ var BlobStorageService = class {
    * @param {string} blobName - The name of the blob to retrieve.
    * @return {Promise<GetObjectResponse>} A promise that resolves to the object data, including the body, metadata, content type, and content length, or rejects with an error if there was an issue.
    */
-  getObject(blobName) {
-    return new Promise((resolve, reject) => {
-      try {
-        const containerClient = this.blobServiceClient.getContainerClient(
-          this.containerName
-        );
-        const blockBlobClient = containerClient.getBlockBlobClient(blobName);
-        blockBlobClient.download(0).then((downloadBlockBlobResponse) => {
-          return resolve({
-            body: downloadBlockBlobResponse.readableStreamBody,
-            metadata: {},
-            contentType: "",
-            contentLength: 0
-          });
-        }).catch(
-          (error) => reject(
-            ErrorHandler.handleError(
-              "DEFAULT",
-              "",
-              error
-            )
-          )
-        );
-      } catch (error) {
-        return reject(
-          ErrorHandler.handleError("DEFAULT", "", error)
-        );
+  async getObject(blobName) {
+    var _a;
+    try {
+      const containerClient = this.blobServiceClient.getContainerClient(
+        this.containerName
+      );
+      const blockBlobClient = containerClient.getBlockBlobClient(blobName);
+      const downloadBlockBlobResponse = await blockBlobClient.download(0);
+      return {
+        body: downloadBlockBlobResponse.readableStreamBody,
+        metadata: downloadBlockBlobResponse.metadata,
+        contentType: downloadBlockBlobResponse.contentType,
+        contentLength: downloadBlockBlobResponse.contentLength
+      };
+    } catch (error) {
+      let errorKey = "DEFAULT";
+      if (((_a = error == null ? void 0 : error.response) == null ? void 0 : _a.status) === 404) {
+        errorKey = "ObjectNotFound";
       }
-    });
+      throw ErrorHandler.handleError(errorKey, "", error);
+    }
+  }
+  async getSignatureUrl(blobName, expiresInMinutes, permissions) {
+    try {
+      const containerClient = this.blobServiceClient.getContainerClient(
+        this.containerName
+      );
+      const blockBlobClient = containerClient.getBlockBlobClient(blobName);
+      const startDate = /* @__PURE__ */ new Date();
+      const expiryDate = new Date(startDate);
+      expiryDate.setMinutes(startDate.getMinutes() + expiresInMinutes);
+      return blockBlobClient.generateSasUrl({
+        permissions: BlobSASPermissions.parse(permissions),
+        startsOn: startDate,
+        expiresOn: expiryDate
+      });
+    } catch (error) {
+      throw ErrorHandler.handleError("DEFAULT", "", error);
+    }
+  }
+  async getUploadUrl(blobName, expiresInMinutes) {
+    try {
+      const sasUrl = await this.getSignatureUrl(
+        blobName,
+        expiresInMinutes,
+        "w"
+      );
+      return { key: blobName, signedUrl: sasUrl };
+    } catch (error) {
+      throw ErrorHandler.handleError("DEFAULT", "", error);
+    }
   }
   /**
    * Retrieves a signed URL for the blob with the specified name that expires after a certain period.
@@ -172,37 +181,17 @@ var BlobStorageService = class {
    * @param {number} expiresInMinutes - The duration in minutes until the signed URL expires.
    * @return {Promise<string>} A Promise that resolves with the signed URL.
    */
-  getDownloadUrl(blobName, expiresInMinutes) {
-    return new Promise((resolve, reject) => {
-      try {
-        const containerClient = this.blobServiceClient.getContainerClient(
-          this.containerName
-        );
-        const blockBlobClient = containerClient.getBlockBlobClient(blobName);
-        const startDate = /* @__PURE__ */ new Date();
-        const expiryDate = new Date(startDate);
-        expiryDate.setMinutes(
-          startDate.getMinutes() + expiresInMinutes
-        );
-        blockBlobClient.generateSasUrl({
-          permissions: BlobSASPermissions.parse("r"),
-          startsOn: startDate,
-          expiresOn: expiryDate
-        }).then((sasUrl) => resolve(sasUrl)).catch(
-          (error) => reject(
-            ErrorHandler.handleError(
-              "DEFAULT",
-              "",
-              error
-            )
-          )
-        );
-      } catch (error) {
-        return reject(
-          ErrorHandler.handleError("DEFAULT", "", error)
-        );
-      }
-    });
+  async getDownloadUrl(blobName, expiresInMinutes) {
+    try {
+      const sasUrl = await this.getSignatureUrl(
+        blobName,
+        expiresInMinutes,
+        "r"
+      );
+      return sasUrl;
+    } catch (error) {
+      throw ErrorHandler.handleError("DEFAULT", "", error);
+    }
   }
   /**
    * Uploads a file to the blob storage service.
@@ -212,33 +201,22 @@ var BlobStorageService = class {
    * @param {{ [key: string]: string } | undefined} [metadata] - Optional metadata to associate with the blob.
    * @return {Promise<UploadResponse>} A promise that resolves to the response object containing the key of the uploaded blob, or rejects with an error if there was an issue.
    */
-  upload(blobName, body, metadata) {
-    return new Promise((resolve, reject) => {
-      try {
-        const containerClient = this.blobServiceClient.getContainerClient(
-          this.containerName
-        );
-        const blockBlobClient = containerClient.getBlockBlobClient(blobName);
-        blockBlobClient.uploadStream(
-          body,
-          void 0,
-          void 0,
-          metadata
-        ).then(() => resolve({ key: blobName })).catch(
-          (error) => reject(
-            ErrorHandler.handleError(
-              "DEFAULT",
-              "",
-              error
-            )
-          )
-        );
-      } catch (error) {
-        return reject(
-          ErrorHandler.handleError("DEFAULT", "", error)
-        );
-      }
-    });
+  async upload(blobName, body, metadata = {}) {
+    try {
+      const containerClient = this.blobServiceClient.getContainerClient(
+        this.containerName
+      );
+      const blockBlobClient = containerClient.getBlockBlobClient(blobName);
+      Buffer.isBuffer(body) ? await blockBlobClient.upload(body, body.length, { metadata }) : await blockBlobClient.uploadStream(
+        body,
+        void 0,
+        void 0,
+        { metadata }
+      );
+      return { key: blobName };
+    } catch (error) {
+      throw ErrorHandler.handleError("DEFAULT", "", error);
+    }
   }
   /**
    * Deletes a blob from the blob storage service.
@@ -246,28 +224,15 @@ var BlobStorageService = class {
    * @param {string} blobName - The name of the blob to be deleted.
    * @return {Promise<boolean>} A promise that resolves to true if the blob is successfully deleted, or rejects with an error if there was an issue.
    */
-  delete(blobName) {
-    return new Promise((resolve, reject) => {
-      try {
-        const containerClient = this.blobServiceClient.getContainerClient(
-          this.containerName
-        );
-        const blockBlobClient = containerClient.getBlockBlobClient(blobName);
-        blockBlobClient.delete().then(() => resolve(true)).catch(
-          (error) => reject(
-            ErrorHandler.handleError(
-              "DEFAULT",
-              "",
-              error
-            )
-          )
-        );
-      } catch (error) {
-        return reject(
-          ErrorHandler.handleError("DEFAULT", "", error)
-        );
-      }
-    });
+  async delete(data) {
+    try {
+      const containerClient = this.blobServiceClient.getContainerClient(
+        this.containerName
+      );
+      return this.deleteObject(containerClient, data);
+    } catch (error) {
+      throw ErrorHandler.handleError("DEFAULT", "", error);
+    }
   }
   /**
    * Lists a chunk of blobs from the specified container client based on the provided options and continuation token.
@@ -368,6 +333,40 @@ var BlobStorageService = class {
     } while (pagination);
     return { items: allItems, count: allItems.length };
   }
+  /**
+   * Deletes a blob from the blob storage service.
+   *
+   * @param {string} blobName - The name of the blob to be deleted.
+   * @return {Promise<boolean>} A promise that resolves to true if the blob is successfully deleted, or rejects with an error if there was an issue.
+   */
+  async deleteObject(containerClient, blobName) {
+    try {
+      const blockBlobClient = containerClient.getBlockBlobClient(blobName);
+      await blockBlobClient.delete();
+      return true;
+    } catch (error) {
+      throw ErrorHandler.handleError("DEFAULT", "", error);
+    }
+  }
+  async deleteObjects(blobNames) {
+    const containerClient = this.blobServiceClient.getContainerClient(
+      this.containerName
+    );
+    const deleteBlobPromises = blobNames.map(async (blobName) => {
+      var _a;
+      try {
+        await this.deleteObject(containerClient, blobName);
+        return { key: blobName, deleted: true };
+      } catch (error) {
+        return {
+          key: blobName,
+          deleted: false,
+          error: (_a = error == null ? void 0 : error.message) != null ? _a : ""
+        };
+      }
+    });
+    return Promise.all(deleteBlobPromises);
+  }
 };
 
 // src/services/storage/s3/s3Helpers.ts
@@ -395,8 +394,6 @@ function s3ObjectToObjectResponse(s3Object) {
     lastModified: s3Object.LastModified
   };
 }
-
-// src/services/storage/s3/s3Storage.service.ts
 var S3StorageService = class {
   constructor(bucketName) {
     this.s3Client = new S3Client({
@@ -566,6 +563,29 @@ var S3StorageService = class {
     await this.s3Client.send(command);
     return { key };
   }
+  /**
+   * Creates a writable stream for uploading a file to the S3 bucket.
+   *
+   * @param {string} key - The key of the object to upload.
+   * @return {CreateUploadWriteStreamResponse} An object containing the key of the uploaded object, the writable stream, and a promise that resolves when the upload is complete.
+   */
+  createUploadWriteStream(key) {
+    const streamPassThrough = new stream.PassThrough();
+    const params = {
+      Bucket: this.bucketName,
+      Key: key,
+      Body: streamPassThrough
+    };
+    const upload = new Upload({
+      client: this.s3Client,
+      params
+    });
+    return {
+      key,
+      stream: streamPassThrough,
+      promise: upload.done()
+    };
+  }
   /**
    * Deletes an object from the S3 bucket.
    * @param key - The key of the object to delete.
@@ -680,6 +700,18 @@ var ObjectStorageService = class _ObjectStorageService {
       bucketName
     ).then((instance) => instance.upload(key, body, metadata));
   }
+  /**
+   * Creates an upload write stream for the specified key in the object storage service.
+   *
+   * @param {string} key - The key of the object to create the upload write stream for.
+   * @param {string} [bucketName] - The name of the bucket where the object will be stored. If not provided, the default bucket name will be used.
+   * @return {Promise<CreateUploadWriteStreamResponse>} A promise that resolves to the response of the upload operation.
+   */
+  static async createUploadWriteStream(key, bucketName) {
+    return _ObjectStorageService.getObjectStorageServiceInstance(
+      bucketName
+    ).then((instance) => instance.createUploadWriteStream(key));
+  }
   /**
    * Deletes an object from the object storage service.
    *