@qrvey/object-storage 0.0.7 → 0.0.9-beta

package/dist/esm/index.d.mts

@@ -1,4 +1,6 @@
 import stream, { Readable } from 'stream';
+import { ContainerGetPropertiesResponse } from '@azure/storage-blob';
+import { HeadBucketCommandOutput } from '@aws-sdk/client-s3';
 
 type UploadResponse = {
     key: string;
@@ -51,6 +53,8 @@ type CreateUploadWriteStreamResponse = {
     promise: Promise<unknown>;
 };
 
+type HeadBucketResponse = HeadBucketCommandOutput | ContainerGetPropertiesResponse;
+
 interface IObjectStorage {
     list(options: ListRequestOptions): Promise<ListResponse>;
     listAll(options: ListRequestOptions): Promise<ListResponse>;
@@ -63,6 +67,10 @@ interface IObjectStorage {
     }): Promise<UploadResponse>;
     createUploadWriteStream(key: string): CreateUploadWriteStreamResponse;
     delete(key: string): Promise<boolean>;
+    getHeadBucket(): Promise<HeadBucketResponse>;
+    uploadMultipart(key: string, file: FileContent, partNumber: number, uploadId?: string): Promise<string>;
+    completeMultipartUpload(key: string, uploadId: string): Promise<void>;
+    abortMultipartUpload(key: string, uploadId: string): Promise<void>;
 }
 
 declare class ObjectStorageService {
@@ -138,13 +146,53 @@ declare class ObjectStorageService {
      */
     static createUploadWriteStream(key: string, bucketName?: string): Promise<CreateUploadWriteStreamResponse>;
     /**
-     * Deletes an object from the object storage service.
+     * Deletes an object or multiple objects from the object storage service.
      *
-     * @param {string} key - The key of the object to delete.
-     * @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<boolean>} A promise that resolves to true if the object was successfully deleted, or false otherwise.
+     * @param {string | string[]} key - The key or array of keys of the objects to delete.
+     * @param {string} [bucketName] - The name of the bucket where the objects are stored. If not provided, the default bucket name will be used.
+     * @return {Promise<{ key: string; deleted: boolean; error?: string }[] | boolean>} A promise that resolves to an array of objects containing the key, deleted status, and an optional error message for each object deleted, or a boolean value indicating the success of the deletion.
+     */
+    static delete(key: string | string[], bucketName?: string): Promise<{
+        key: string;
+        deleted: boolean;
+        error?: string;
+    }[] | boolean>;
+    /**
+     * Retrieves the head bucket from the object storage service.
+     *
+     * @param {string} [bucketName] - The name of the bucket. If not provided, the default bucket name will be used.
+     * @return {Promise<HeadBucketResponse>} A promise that resolves to the head bucket response.
+     */
+    static getHeadBucket(bucketName?: string): Promise<HeadBucketResponse>;
+    /**
+     * Uploads a multipart file to the specified bucket in the object storage service.
+     *
+     * @param {string} key - The key of the object to upload the multipart file to.
+     * @param {FileContent} file - The content of the file to upload.
+     * @param {number} partNumber - The number of the part being uploaded.
+     * @param {string} [uploadId] - The ID of the multipart upload.
+     * @param {string} [bucketName] - The name of the bucket to upload the file to. If not provided, the default bucket name will be used.
+     * @return {Promise<string>} A Promise that resolves to the base64 encoded block ID of the uploaded part.
+     */
+    static uploadMultipart(key: string, file: FileContent, partNumber: number, uploadId?: string, bucketName?: string): Promise<string>;
+    /**
+     * Completes a multipart upload for the specified object in the object storage service.
+     *
+     * @param {string} key - The key of the object to complete the multipart upload for.
+     * @param {string} uploadId - The ID of the multipart upload to complete.
+     * @param {string} [bucketName] - The name of the bucket to complete the multipart upload in. If not provided, the default bucket name will be used.
+     * @return {Promise<void>} A Promise that resolves when the multipart upload is completed.
+     */
+    static completeMultipartUpload(key: string, uploadId: string, bucketName?: string): Promise<void>;
+    /**
+     * Aborts a multipart upload for the specified object in the object storage service.
+     *
+     * @param {string} key - The key of the object to abort the multipart upload for.
+     * @param {string} uploadId - The ID of the multipart upload to abort.
+     * @param {string} [bucketName] - The name of the bucket to abort the multipart upload in. If not provided, the default bucket name will be used.
+     * @return {Promise<void>} A Promise that resolves when the multipart upload is aborted.
      */
-    static delete(key: string, bucketName?: string): Promise<boolean>;
+    static abortMultipartUpload(key: string, uploadId: string, bucketName?: string): Promise<void>;
 }
 
 export { FileContent, GetObjectResponse, GetUploadUrlResponse, ListRequestOptions, ListResponse, ListResponseItem, ObjectStorageService, UploadResponse };

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
 import { BlobServiceClient, BlobSASPermissions } from '@azure/storage-blob';
-import { S3Client, ListObjectsV2Command, HeadObjectCommand, GetObjectCommand, PutObjectCommand, DeleteObjectCommand } from '@aws-sdk/client-s3';
+import { S3Client, S3, ListObjectsV2Command, HeadObjectCommand, GetObjectCommand, PutObjectCommand, DeleteObjectCommand, HeadBucketCommand } from '@aws-sdk/client-s3';
 import { getSignedUrl } from '@aws-sdk/s3-request-presigner';
 import stream from 'stream';
 import { Upload } from '@aws-sdk/lib-storage';
@@ -23,6 +23,18 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __objRest = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
 
 // src/shared/utils/errorHandler.ts
 var errorMessages = {
@@ -367,6 +379,92 @@ var BlobStorageService = class {
     });
     return Promise.all(deleteBlobPromises);
   }
+  async getHeadBucket() {
+    try {
+      const containerClient = this.blobServiceClient.getContainerClient(
+        this.containerName
+      );
+      const properties = await containerClient.getProperties();
+      return properties;
+    } catch (error) {
+      throw new Error(
+        "Error in Azure getHeadContainer. Container: " + this.containerName + " Error: " + error
+      );
+    }
+  }
+  /**
+   * The `uploadMultipart` function in TypeScript uploads a part of a file as a block to Azure Blob
+   * Storage and updates the metadata with the block ID.
+   * @param {string} blobName - The `blobName` parameter in the `uploadMultipart` function represents
+   * the name of the blob (file) that you want to upload in parts to Azure Blob Storage. It is a
+   * string value that identifies the specific blob within the container where it will be stored.
+   * @param {FileContent | any} file - The `file` parameter in the `uploadMultipart` function
+   * represents the content of the file that you want to upload as a part of a multipart upload. It
+   * can be either a `FileContent` object or any other type of data that represents the content of
+   * the file.
+   * @param {number} partNumber - The `partNumber` parameter in the `uploadMultipart` function
+   * represents the number or index of the part being uploaded. It is used to identify and order the
+   * different parts of a multipart upload. Each part uploaded to the blob storage service is
+   * associated with a unique part number to help in reconstructing
+   * @returns The function `uploadMultipart` returns a Promise that resolves to a string representing
+   * the base64 encoded block ID of the uploaded part.
+   */
+  async uploadMultipart(blobName, file, partNumber) {
+    var _a;
+    const containerClient = this.blobServiceClient.getContainerClient(
+      this.containerName
+    );
+    const blobClient = containerClient.getBlockBlobClient(blobName);
+    const partId = partNumber.toString().padStart(6, "0");
+    const partIdBase64 = Buffer.from(partId).toString("base64");
+    await blobClient.stageBlock(partIdBase64, file, file.length);
+    const properties = await blobClient.getProperties();
+    const existingBlockIds = ((_a = properties.metadata) == null ? void 0 : _a.blockids) ? JSON.parse(properties.metadata.blockids) : [];
+    existingBlockIds.push(partIdBase64);
+    await blobClient.setMetadata({
+      blockids: JSON.stringify(existingBlockIds)
+    });
+    return partIdBase64;
+  }
+  /**
+   * The `completeMultipartUpload` function in TypeScript completes a multipart upload by committing
+   * the blocks to create the blob.
+   * @param {string} blobName - The `blobName` parameter in the `completeMultipartUpload` function is
+   * a string that represents the name of the blob for which the multipart upload is being completed.
+   */
+  async completeMultipartUpload(blobName) {
+    var _a;
+    const containerClient = this.blobServiceClient.getContainerClient(
+      this.containerName
+    );
+    const blobClient = containerClient.getBlockBlobClient(blobName);
+    const properties = await blobClient.getProperties();
+    const blockIds = ((_a = properties.metadata) == null ? void 0 : _a.blockids) ? JSON.parse(properties.metadata.blockids) : [];
+    if (blockIds.length === 0) {
+      throw new Error("No block IDs found in metadata.");
+    }
+    await blobClient.commitBlockList(blockIds);
+  }
+  /**
+   * This TypeScript function aborts a multipart upload by deleting the specified blob and clearing
+   * its block IDs metadata.
+   * @param {string} blobName - The `blobName` parameter is a string that represents the name of the
+   * blob for which the multipart upload needs to be aborted.
+   */
+  async abortMultipartUpload(blobName) {
+    var _a;
+    const containerClient = this.blobServiceClient.getContainerClient(
+      this.containerName
+    );
+    const blobClient = containerClient.getBlockBlobClient(blobName);
+    const properties = await blobClient.getProperties();
+    const blockIds = ((_a = properties.metadata) == null ? void 0 : _a.blockids) ? JSON.parse(properties.metadata.blockids) : [];
+    if (blockIds.length === 0) {
+      throw new Error("No block IDs found in metadata.");
+    }
+    await blobClient.setMetadata({ blockids: "" });
+    await blobClient.delete();
+  }
 };
 
 // src/services/storage/s3/s3Helpers.ts
@@ -397,8 +495,9 @@ function s3ObjectToObjectResponse(s3Object) {
 var S3StorageService = class {
   constructor(bucketName) {
     this.s3Client = new S3Client({
-      region: process.env.AWS_REGION
+      region: process.env.AWS_DEFAULT_REGION
     });
+    this.s3 = new S3({ region: process.env.AWS_DEFAULT_REGION });
     this.bucketName = bucketName;
   }
   /**
@@ -599,6 +698,69 @@ var S3StorageService = class {
     await this.s3Client.send(command);
     return true;
   }
+  async getHeadBucket() {
+    try {
+      const command = new HeadBucketCommand({
+        Bucket: this.bucketName
+      });
+      return this.s3Client.send(command);
+    } catch (error) {
+      throw new Error(
+        "Error in S3 getHeadContainer. bucketName: " + this.bucketName + " Error: " + error
+      );
+    }
+  }
+  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 params = {
+      Bucket: this.bucketName,
+      Key: key,
+      Body: file,
+      PartNumber: partNumber,
+      UploadId: upId
+    };
+    await this.s3.uploadPart(params);
+    return upId;
+  }
+  async completeMultipartUpload(key, uploadId) {
+    const listPartsParams = {
+      Bucket: this.bucketName,
+      Key: key,
+      UploadId: uploadId
+    };
+    const partsResponse = await this.s3.listParts(listPartsParams);
+    const partsList = (partsResponse == null ? void 0 : partsResponse.Parts) && partsResponse.Parts.map(
+      // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
+      (_a) => {
+        var _b = _a, partList = __objRest(_b, ["Size", "LastModified"]);
+        return partList;
+      }
+    );
+    const completeMultipartParams = __spreadProps(__spreadValues({}, listPartsParams), {
+      MultipartUpload: {
+        Parts: partsList
+      }
+    });
+    await this.s3.completeMultipartUpload(completeMultipartParams);
+  }
+  async abortMultipartUpload(key, uploadId) {
+    const params = {
+      Bucket: this.bucketName,
+      Key: key,
+      UploadId: uploadId
+    };
+    await this.s3.abortMultipartUpload(params);
+  }
 };
 
 // src/services/objectStorageFactory.service.ts
@@ -723,16 +885,89 @@ var ObjectStorageService = class _ObjectStorageService {
     ).then((instance) => instance.createUploadWriteStream(key));
   }
   /**
-   * Deletes an object from the object storage service.
+   * Deletes an object or multiple objects from the object storage service.
    *
-   * @param {string} key - The key of the object to delete.
-   * @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<boolean>} A promise that resolves to true if the object was successfully deleted, or false otherwise.
+   * @param {string | string[]} key - The key or array of keys of the objects to delete.
+   * @param {string} [bucketName] - The name of the bucket where the objects are stored. If not provided, the default bucket name will be used.
+   * @return {Promise<{ key: string; deleted: boolean; error?: string }[] | boolean>} A promise that resolves to an array of objects containing the key, deleted status, and an optional error message for each object deleted, or a boolean value indicating the success of the deletion.
    */
   static async delete(key, bucketName) {
     return _ObjectStorageService.getObjectStorageServiceInstance(
       bucketName
-    ).then((instance) => instance.delete(key));
+    ).then(async (instance) => {
+      if (Array.isArray(key)) {
+        const deleteBlobPromises = key.map(async (blobName) => {
+          var _a;
+          try {
+            await instance.delete(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);
+      } else {
+        return instance.delete(key);
+      }
+    });
+  }
+  /**
+   * Retrieves the head bucket from the object storage service.
+   *
+   * @param {string} [bucketName] - The name of the bucket. If not provided, the default bucket name will be used.
+   * @return {Promise<HeadBucketResponse>} A promise that resolves to the head bucket response.
+   */
+  static async getHeadBucket(bucketName) {
+    return _ObjectStorageService.getObjectStorageServiceInstance(
+      bucketName
+    ).then((instance) => instance.getHeadBucket());
+  }
+  /**
+   * Uploads a multipart file to the specified bucket in the object storage service.
+   *
+   * @param {string} key - The key of the object to upload the multipart file to.
+   * @param {FileContent} file - The content of the file to upload.
+   * @param {number} partNumber - The number of the part being uploaded.
+   * @param {string} [uploadId] - The ID of the multipart upload.
+   * @param {string} [bucketName] - The name of the bucket to upload the file to. If not provided, the default bucket name will be used.
+   * @return {Promise<string>} A Promise that resolves to the base64 encoded block ID of the uploaded part.
+   */
+  static async uploadMultipart(key, file, partNumber, uploadId, bucketName) {
+    return _ObjectStorageService.getObjectStorageServiceInstance(
+      bucketName
+    ).then(
+      (instance) => instance.uploadMultipart(key, file, partNumber, uploadId)
+    );
+  }
+  /**
+   * Completes a multipart upload for the specified object in the object storage service.
+   *
+   * @param {string} key - The key of the object to complete the multipart upload for.
+   * @param {string} uploadId - The ID of the multipart upload to complete.
+   * @param {string} [bucketName] - The name of the bucket to complete the multipart upload in. If not provided, the default bucket name will be used.
+   * @return {Promise<void>} A Promise that resolves when the multipart upload is completed.
+   */
+  static async completeMultipartUpload(key, uploadId, bucketName) {
+    return _ObjectStorageService.getObjectStorageServiceInstance(
+      bucketName
+    ).then((instance) => instance.completeMultipartUpload(key, uploadId));
+  }
+  /**
+   * Aborts a multipart upload for the specified object in the object storage service.
+   *
+   * @param {string} key - The key of the object to abort the multipart upload for.
+   * @param {string} uploadId - The ID of the multipart upload to abort.
+   * @param {string} [bucketName] - The name of the bucket to abort the multipart upload in. If not provided, the default bucket name will be used.
+   * @return {Promise<void>} A Promise that resolves when the multipart upload is aborted.
+   */
+  static async abortMultipartUpload(key, uploadId, bucketName) {
+    return _ObjectStorageService.getObjectStorageServiceInstance(
+      bucketName
+    ).then((instance) => instance.abortMultipartUpload(key, uploadId));
   }
 };