@qrvey/object-storage 0.0.10-beta.2 → 0.0.10

package/README.md

@@ -1,7 +1,7 @@
 # @qrvey/object-storage
 
 ![install size](https://packagephobia.com/badge?p=%40qrvey%2Fobject-storage)
-![coverage](https://img.shields.io/badge/unit_test_coverage-9%25-brightgreen)
+![coverage](https://img.shields.io/badge/unit_test_coverage-8%25-brightgreen)
 
 The `@qrvey/object-storage` package provides a unified interface for ...
 

package/dist/cjs/index.js

@@ -16,6 +16,11 @@ var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
 var __getOwnPropSymbols = Object.getOwnPropertySymbols;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __knownSymbol = (name, symbol) => {
+  if (symbol = Symbol[name])
+    return symbol;
+  throw Error("Symbol." + name + " is not defined");
+};
 var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __spreadValues = (a, b) => {
   for (var prop in b || (b = {}))
@@ -41,6 +46,7 @@ var __objRest = (source, exclude) => {
     }
   return target;
 };
+var __forAwait = (obj, it, method) => (it = obj[__knownSymbol("asyncIterator")]) ? it.call(obj) : (obj = obj[__knownSymbol("iterator")](), it = {}, method = (key, fn) => (fn = obj[key]) && (it[key] = (arg) => new Promise((yes, no, done) => (arg = fn.call(obj, arg), done = arg.done, Promise.resolve(arg.value).then((value) => yes({ value, done }), no)))), method("next"), method("return"), it);
 
 // src/shared/utils/errorHandler.ts
 var errorMessages = {
@@ -182,16 +188,28 @@ var BlobStorageService = class {
    * Retrieves an object from the blob storage service.
    *
    * @param {string} blobName - The name of the blob to retrieve.
+   * @param {Object} [options] - The options that you can pass to the library.
    * @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.
    */
-  async getObject(blobName) {
+  async getObject(blobName, options) {
     var _a;
     try {
+      let downloadBlockBlobResponse;
       const containerClient = this.blobServiceClient.getContainerClient(
         this.containerName
       );
       const blockBlobClient = containerClient.getBlockBlobClient(blobName);
-      const downloadBlockBlobResponse = await blockBlobClient.download(0);
+      const expression = (options == null ? void 0 : options.range) || "";
+      const matches = expression.match(/\d+/g);
+      if (expression && (matches == null ? void 0 : matches.length)) {
+        const [start, end] = matches.map(Number);
+        downloadBlockBlobResponse = await blockBlobClient.download(
+          start,
+          end
+        );
+      } else {
+        downloadBlockBlobResponse = await blockBlobClient.download(0);
+      }
       return {
         body: downloadBlockBlobResponse.readableStreamBody,
         metadata: downloadBlockBlobResponse.metadata,
@@ -453,6 +471,71 @@ var BlobStorageService = class {
       );
     }
   }
+  async listMultipartUploadsForBucket() {
+    const containerClient = this.blobServiceClient.getContainerClient(
+      this.containerName
+    );
+    const blobList = containerClient.listBlobsFlat();
+    const uploads = [];
+    try {
+      for (var iter = __forAwait(blobList), more, temp, error; more = !(temp = await iter.next()).done; more = false) {
+        const blob = temp.value;
+        uploads.push({
+          uploadId: blob.name,
+          key: blob.name,
+          initiated: blob.properties.createdOn || /* @__PURE__ */ new Date()
+        });
+      }
+    } catch (temp) {
+      error = [temp];
+    } finally {
+      try {
+        more && (temp = iter.return) && await temp.call(iter);
+      } finally {
+        if (error)
+          throw error[0];
+      }
+    }
+    return {
+      bucketName: this.containerName,
+      uploads
+    };
+  }
+  /**
+   * Retrieves the list of parts for a multipart upload.
+   *
+   * @param {string} blobName - The name of the blob (file) in Azure Blob Storage.
+   * @return {Promise<ListPartsMultipartUploadResponse>} A promise that resolves to the list of parts for the multipart upload.
+   */
+  async listMultipartUploadsForKey(blobName) {
+    var _a;
+    const containerClient = this.blobServiceClient.getContainerClient(
+      this.containerName
+    );
+    const blobClient = containerClient.getBlockBlobClient(blobName);
+    const listResponse = await blobClient.getBlockList("all");
+    const parts = ((_a = listResponse == null ? void 0 : listResponse.uncommittedBlocks) == null ? void 0 : _a.map((block, index) => ({
+      PartNumber: index + 1,
+      LastModified: /* @__PURE__ */ new Date(),
+      // Azure Blob Storage doesn't provide the last modified date for individual parts
+      ETag: block.name,
+      Size: block.size
+    }))) || [];
+    return {
+      Parts: parts
+    };
+  }
+  /**
+   * Generates a unique upload ID for multipart uploads.
+   *
+   * @return {Promise<string>} A promise that resolves to a unique upload ID.
+   */
+  async generateUploadIdMultipart() {
+    const timestamp = Date.now();
+    const randomNum = Math.floor(Math.random() * 100);
+    const blockIdBase = (timestamp - randomNum).toString();
+    return blockIdBase;
+  }
   /**
    * Uploads a part of a file as a block to Azure Blob Storage and updates the metadata with the block ID.
    *
@@ -467,17 +550,10 @@ var BlobStorageService = class {
       this.containerName
     );
     const blobClient = containerClient.getBlockBlobClient(blobName);
-    let blockIdBase = uploadId;
-    if (!blockIdBase) {
-      const timestamp = Date.now();
-      const randomNum = Math.floor(Math.random() * 100);
-      blockIdBase = (timestamp - randomNum).toString();
-    }
+    const blockIdBase = uploadId || await this.generateUploadIdMultipart();
     const partId = partNumber.toString().padStart(6, "0");
     const partIdBase64 = Buffer.from(partId).toString("base64");
     await blobClient.stageBlock(partIdBase64, file, file.length);
-    const blockIdStorage = BlockIdStorage.getInstance();
-    blockIdStorage.addBlockId(blockIdBase, partIdBase64);
     return blockIdBase;
   }
   /**
@@ -489,17 +565,17 @@ var BlobStorageService = class {
    * @throws {Error} If no block IDs are found in the metadata.
    */
   async completeMultipartUpload(blobName, uploadId) {
+    var _a;
     const containerClient = this.blobServiceClient.getContainerClient(
       this.containerName
     );
     const blobClient = containerClient.getBlockBlobClient(blobName);
-    const blockIdStorage = BlockIdStorage.getInstance();
-    const blockIds = blockIdStorage.getBlockIds(uploadId);
+    const listMultipartUploads = await this.listMultipartUploadsForKey(blobName);
+    const blockIds = ((_a = listMultipartUploads == null ? void 0 : listMultipartUploads.Parts) == null ? void 0 : _a.map((part) => part.ETag)) || [];
     if (blockIds.length === 0) {
       throw new Error("No block IDs found in metadata.");
     }
     await blobClient.commitBlockList(blockIds);
-    blockIdStorage.clearBlockIds(uploadId);
   }
   /**
    * Aborts a multipart upload by deleting the specified blob and clearing its block IDs metadata.
@@ -517,6 +593,17 @@ var BlobStorageService = class {
     blockIdStorage.clearBlockIds(uploadId);
     await blobClient.delete();
   }
+  async getMultipartUploadPresignedUrl(blobName, uploadId, partNumber, expiresInMinutes = 2) {
+    const partId = partNumber.toString().padStart(6, "0");
+    const partIdBase64 = Buffer.from(partId).toString("base64");
+    const sasUrl = await this.getSignatureUrl(
+      blobName,
+      expiresInMinutes,
+      "w"
+    );
+    const url = `${sasUrl}&comp=block&blockid=${partIdBase64}`;
+    return url;
+  }
 };
 
 // src/services/storage/s3/s3Helpers.ts
@@ -773,18 +860,69 @@ var S3StorageService = class {
       );
     }
   }
+  /**
+   * Generates an upload ID for multipart upload in the S3 bucket.
+   *
+   * @param {string} key - The key of the object to upload.
+   * @return {Promise<string>} A promise that resolves to the generated upload ID.
+   * @throws {Error} If no upload ID was generated.
+   */
+  async generateUploadIdMultipart(key) {
+    const params = {
+      Bucket: this.bucketName,
+      Key: key
+    };
+    const response = await this.s3.createMultipartUpload(params);
+    if (!(response == null ? void 0 : response.UploadId))
+      throw new Error("No upload ID was generated");
+    return response.UploadId;
+  }
+  async listMultipartUploadsForBucket() {
+    const params = {
+      Bucket: this.bucketName
+    };
+    const response = await this.s3.listMultipartUploads(params);
+    return {
+      bucketName: this.bucketName,
+      uploads: response.Uploads ? response.Uploads.map((upload) => {
+        var _a, _b;
+        return {
+          uploadId: upload.UploadId || "",
+          key: upload.Key || "",
+          initiator: ((_a = upload == null ? void 0 : upload.Initiator) == null ? void 0 : _a.ID) || "",
+          owner: ((_b = upload == null ? void 0 : upload.Owner) == null ? void 0 : _b.ID) || "",
+          storageClass: upload.StorageClass || "",
+          initiated: upload.Initiated || ""
+        };
+      }) : []
+    };
+  }
+  /**
+   * Retrieves the list of parts for a multipart upload.
+   *
+   * @param {string} key - The key of the object being uploaded.
+   * @param {string} uploadId - The ID of the multipart upload.
+   * @return {Promise<ListPartsMultipartUploadResponse>} A promise that resolves to the list of parts for the multipart upload.
+   */
+  async listMultipartUploadsForKey(key, uploadId) {
+    const params = {
+      Bucket: this.bucketName,
+      Key: key,
+      UploadId: uploadId
+    };
+    const response = await this.s3.listParts(params);
+    const parts = response.Parts ? response.Parts.map((part) => ({
+      PartNumber: part.PartNumber,
+      LastModified: part.LastModified,
+      ETag: part.ETag,
+      Size: part.Size
+    })) : [];
+    return {
+      Parts: parts
+    };
+  }
   async uploadMultipart(key, file, partNumber, uploadId) {
-    let upId = uploadId;
-    if (!upId) {
-      const params2 = {
-        Bucket: this.bucketName,
-        Key: key
-      };
-      const response = await this.s3.createMultipartUpload(params2);
-      if (!(response == null ? void 0 : response.UploadId))
-        throw new Error("No upload ID was generated");
-      upId = response.UploadId;
-    }
+    const upId = uploadId || await this.generateUploadIdMultipart(key);
     const params = {
       Bucket: this.bucketName,
       Key: key,
@@ -796,12 +934,10 @@ var S3StorageService = class {
     return upId;
   }
   async completeMultipartUpload(key, uploadId) {
-    const listPartsParams = {
-      Bucket: this.bucketName,
-      Key: key,
-      UploadId: uploadId
-    };
-    const partsResponse = await this.s3.listParts(listPartsParams);
+    const partsResponse = await this.listMultipartUploadsForKey(
+      key,
+      uploadId
+    );
     const partsList = (partsResponse == null ? void 0 : partsResponse.Parts) && partsResponse.Parts.map(
       // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
       (_a) => {
@@ -809,11 +945,14 @@ var S3StorageService = class {
         return partList;
       }
     );
-    const completeMultipartParams = __spreadProps(__spreadValues({}, listPartsParams), {
+    const completeMultipartParams = {
+      Bucket: this.bucketName,
+      Key: key,
+      UploadId: uploadId,
       MultipartUpload: {
         Parts: partsList
       }
-    });
+    };
     await this.s3.completeMultipartUpload(completeMultipartParams);
   }
   async abortMultipartUpload(key, uploadId) {
@@ -824,6 +963,21 @@ var S3StorageService = class {
     };
     await this.s3.abortMultipartUpload(params);
   }
+  async getMultipartUploadPresignedUrl(key, uploadId, partNumber, expiresInMinutes = 60) {
+    const uploadPartParams = {
+      Bucket: this.bucketName,
+      Key: key,
+      UploadId: uploadId,
+      PartNumber: parseInt(partNumber, 10)
+    };
+    const expiresIn = expiresInMinutes * 60;
+    const presignedUrl = await s3RequestPresigner.getSignedUrl(
+      this.s3Client,
+      new clientS3.UploadPartCommand(uploadPartParams),
+      { expiresIn }
+    );
+    return presignedUrl;
+  }
 };
 
 // src/shared/utils/constants.ts
@@ -893,10 +1047,10 @@ var ObjectStorageService = class _ObjectStorageService {
    * @param {string} [bucketName] - The name of the bucket where the object is stored. If not provided, the default bucket name will be used.
    * @return {Promise<GetObjectResponse>} A promise that resolves to the retrieved object.
    */
-  static async getObject(key, bucketName) {
+  static async getObject(key, bucketName, options) {
     return _ObjectStorageService.getObjectStorageServiceInstance(
       bucketName
-    ).then((instance) => instance.getObject(key));
+    ).then((instance) => instance.getObject(key, options));
   }
   /**
    * Retrieves an object info (without file content) from the object storage service.
@@ -1002,6 +1156,44 @@ var ObjectStorageService = class _ObjectStorageService {
       bucketName
     ).then((instance) => instance.getHeadBucket());
   }
+  /**
+   * Generates a unique upload ID for a multipart upload.
+   *
+   * @param {string} key - The key of the object to upload.
+   * @param {string} [bucketName] - The name of the bucket. If not provided, the default bucket name will be used.
+   * @return {Promise<string>} A promise that resolves to the generated upload ID.
+   */
+  static async generateUploadIdMultipart(key, bucketName) {
+    return _ObjectStorageService.getObjectStorageServiceInstance(
+      bucketName
+    ).then((instance) => instance.generateUploadIdMultipart(key));
+  }
+  /**
+   * Retrieves a list of multipart uploads for a specified key in the object storage service.
+   *
+   * @param {string} key - The key of the object to retrieve uploads for.
+   * @param {string} [bucketName] - The name of the bucket. If not provided, the default bucket name will be used.
+   * @param {string} [uploadId] - The upload ID to filter the results by.
+   * @return {Promise<ListPartsMultipartUploadResponse>} A promise that resolves to the list of multipart uploads for the specified key.
+   */
+  static async listMultipartUploadsForKey(key, bucketName, uploadId) {
+    return _ObjectStorageService.getObjectStorageServiceInstance(
+      bucketName
+    ).then(
+      (instance) => instance.listMultipartUploadsForKey(key, uploadId)
+    );
+  }
+  /**
+   * Retrieves a list of all multipart uploads for a specified bucket in the object storage service.
+   *
+   * @param {string} [bucketName] - The name of the bucket. If not provided, the default bucket name will be used.
+   * @return {Promise<ListMultipartUploadsResponse>} A promise that resolves to the list of multipart uploads for the specified bucket.
+   */
+  static async listMultipartUploadsForBucket(bucketName) {
+    return _ObjectStorageService.getObjectStorageServiceInstance(
+      bucketName
+    ).then((instance) => instance.listMultipartUploadsForBucket());
+  }
   /**
    * Uploads a multipart file to the specified bucket in the object storage service.
    *
@@ -1045,6 +1237,25 @@ var ObjectStorageService = class _ObjectStorageService {
       bucketName
     ).then((instance) => instance.abortMultipartUpload(key, uploadId));
   }
+  /**
+   * Retrieves a presigned URL for a specific part of a multipart upload.
+   *
+   * @param {string} key - The key of the object for which to generate the presigned URL.
+   * @param {string} uploadId - The ID of the multipart upload.
+   * @param {string} partNumber - The number of the part for which to generate the presigned URL.
+   * @param {number} [expiresInMinutes] - The number of minutes until the presigned URL expires. Default is 60 minutes.
+   * @return {Promise<string>} A Promise that resolves to the presigned URL for the specified part of the multipart upload.
+   */
+  static async getMultipartUploadPresignedUrl(key, uploadId, partNumber, expiresInMinutes) {
+    return _ObjectStorageService.getObjectStorageServiceInstance().then(
+      (instance) => instance.getMultipartUploadPresignedUrl(
+        key,
+        uploadId,
+        partNumber,
+        expiresInMinutes
+      )
+    );
+  }
 };
 
 exports.ObjectStorageService = ObjectStorageService;