@qrvey/object-storage 1.0.2-beta → 1.0.3-535

package/dist/types/index.d.ts

@@ -41,6 +41,7 @@ type GetObjectResponse = {
     contentDisposition?: string;
     contentLanguage?: string;
     body?: Readable;
+    content?: Readable;
 };
 
 type GetUploadUrlResponse = {
@@ -57,9 +58,16 @@ type CreateUploadWriteStreamResponse = {
 type HeadBucketResponse = HeadBucketCommandOutput | ContainerGetPropertiesResponse;
 
 type ObjectStorageOptions = {
-    region: string;
-    credentials: AwsCredentialIdentity;
-    provider: string;
+    region?: string;
+    credentials?: AwsCredentialIdentity;
+    provider?: string;
+    connectionString?: string;
+    host?: string;
+    port?: string | number;
+    user?: string;
+    password?: string;
+    privateKey?: string | Buffer;
+    secure?: boolean;
 };
 
 type ListPartsMultipartUploadResponse = {
@@ -133,49 +141,57 @@ declare class ObjectStorageService {
      *
      * @param {ListRequestOptions} options - The options to apply to the list operation.
      * @param {string} [bucketName] - The name of the bucket to list objects from. If not provided, the default bucket name will be used.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @return {Promise<ListResponse>} A promise that resolves to the list of objects.
      */
-    static list(options: ListRequestOptions, bucketName?: string): Promise<ListResponse>;
+    static list(options: ListRequestOptions, bucketName?: string, objectStorageOptions?: ObjectStorageOptions): Promise<ListResponse>;
     /**
      * Retrieves a list of all objects from the object storage service.
      *
      * @param {ListRequestOptions} options - The options to apply to the list operation.
      * @param {string} [bucketName] - The name of the bucket to list objects from. If not provided, the default bucket name will be used.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @return {Promise<ListResponse>} A promise that resolves to the list of all objects.
      */
-    static listAll(options: ListRequestOptions, bucketName?: string): Promise<ListResponse>;
+    static listAll(options: ListRequestOptions, bucketName?: string, objectStorageOptions?: ObjectStorageOptions): Promise<ListResponse>;
     /**
      * Retrieves an object from the object storage service.
      *
      * @param {string} key - The key of the object to retrieve.
      * @param {string} [bucketName] - The name of the bucket where the object is stored. If not provided, the default bucket name will be used.
+     * @param {IGetObjectOptions} [options] - The options to apply to the get operation.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @return {Promise<GetObjectResponse>} A promise that resolves to the retrieved object.
      */
-    static getObject(key: string, bucketName?: string, options?: IGetObjectOptions): Promise<GetObjectResponse>;
+    static getObject(key: string, bucketName?: string, options?: IGetObjectOptions, objectStorageOptions?: ObjectStorageOptions): Promise<GetObjectResponse>;
     /**
      * Retrieves an object info (without file content) from the object storage service.
      * @param key - The key of the object to retrieve.
+     * @param bucketName - The name of the bucket where the object is stored. If not provided, the default bucket name will be used.
+     * @param objectStorageOptions - The options for the object storage service.
      * @returns A promise that resolves to the info of the file.
      */
-    static getHeadObject(key: string, bucketName?: string): Promise<GetObjectResponse>;
+    static getHeadObject(key: string, bucketName?: string, objectStorageOptions?: ObjectStorageOptions): Promise<GetObjectResponse>;
     /**
      * Retrieves a signed URL for the specified object in the object storage service.
      *
      * @param {string} key - The key of the object for which to generate the signed URL.
      * @param {number} expiresInMinutes - The number of minutes until the signed URL expires.
      * @param {string} [bucketName] - The name of the bucket where the object is stored. If not provided, the default bucket name will be used.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @return {Promise<string>} A promise that resolves to the generated signed URL.
      */
-    static getDownloadUrl(key: string, expiresInMinutes: number, bucketName?: string): Promise<string>;
+    static getDownloadUrl(key: string, expiresInMinutes: number, bucketName?: string, objectStorageOptions?: ObjectStorageOptions): Promise<string>;
     /**
      * Retrieves an upload URL for the specified object in the object storage service.
      *
      * @param {string} key - The key of the object for which to generate the upload URL.
      * @param {number} expiresInMinutes - The number of minutes until the upload URL expires.
      * @param {string} [bucketName] - The name of the bucket where the object will be stored. If not provided, the default bucket name will be used.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @return {Promise<string>} A promise that resolves to the generated upload URL.
      */
-    static getUploadUrl(key: string, expiresInMinutes: number, bucketName?: string): Promise<GetUploadUrlResponse>;
+    static getUploadUrl(key: string, expiresInMinutes: number, bucketName?: string, objectStorageOptions?: ObjectStorageOptions): Promise<GetUploadUrlResponse>;
     /**
      * Uploads a file to the object storage service.
      *
@@ -183,27 +199,30 @@ declare class ObjectStorageService {
      * @param {FileContent} body - The content of the file to upload.
      * @param {Object} [metadata] - Optional metadata to associate with the object.
      * @param {string} [bucketName] - The name of the bucket where the object will be stored. If not provided, the default bucket name will be used.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @return {Promise<UploadResponse>} A promise that resolves to the response of the upload operation.
      */
     static upload(key: string, body: FileContent, metadata?: {
         [key: string]: string;
-    }, bucketName?: string): Promise<UploadResponse>;
+    }, bucketName?: string, objectStorageOptions?: ObjectStorageOptions): 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.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @return {Promise<CreateUploadWriteStreamResponse>} A promise that resolves to the response of the upload operation.
      */
-    static createUploadWriteStream(key: string, bucketName?: string): Promise<CreateUploadWriteStreamResponse>;
+    static createUploadWriteStream(key: string, bucketName?: string, objectStorageOptions?: ObjectStorageOptions): Promise<CreateUploadWriteStreamResponse>;
     /**
      * Deletes an object or multiple objects from the object storage service.
      *
      * @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.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @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<{
+    static delete(key: string | string[], bucketName?: string, objectStorageOptions?: ObjectStorageOptions): Promise<{
         key: string;
         deleted: boolean;
         error?: string;
@@ -212,33 +231,37 @@ declare class ObjectStorageService {
      * 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.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @return {Promise<HeadBucketResponse>} A promise that resolves to the head bucket response.
      */
-    static getHeadBucket(bucketName?: string): Promise<HeadBucketResponse>;
+    static getHeadBucket(bucketName?: string, objectStorageOptions?: ObjectStorageOptions): Promise<HeadBucketResponse>;
     /**
      * 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.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @return {Promise<string>} A promise that resolves to the generated upload ID.
      */
-    static generateUploadIdMultipart(key: string, bucketName?: string): Promise<string>;
+    static generateUploadIdMultipart(key: string, bucketName?: string, objectStorageOptions?: ObjectStorageOptions): Promise<string>;
     /**
      * 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.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @return {Promise<ListPartsMultipartUploadResponse>} A promise that resolves to the list of multipart uploads for the specified key.
      */
-    static listMultipartUploadsForKey(key: string, bucketName?: string, uploadId?: string): Promise<ListPartsMultipartUploadResponse>;
+    static listMultipartUploadsForKey(key: string, bucketName?: string, uploadId?: string, objectStorageOptions?: ObjectStorageOptions): Promise<ListPartsMultipartUploadResponse>;
     /**
      * 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.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @return {Promise<ListMultipartUploadsResponse>} A promise that resolves to the list of multipart uploads for the specified bucket.
      */
-    static listMultipartUploadsForBucket(bucketName?: string): Promise<ListMultipartUploadsResponse>;
+    static listMultipartUploadsForBucket(bucketName?: string, objectStorageOptions?: ObjectStorageOptions): Promise<ListMultipartUploadsResponse>;
     /**
      * Uploads a multipart file to the specified bucket in the object storage service.
      *
@@ -247,27 +270,30 @@ declare class ObjectStorageService {
      * @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.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @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>;
+    static uploadMultipart(key: string, file: FileContent, partNumber: number, uploadId?: string, bucketName?: string, objectStorageOptions?: ObjectStorageOptions): 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.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @return {Promise<void>} A Promise that resolves when the multipart upload is completed.
      */
-    static completeMultipartUpload(key: string, uploadId: string, bucketName?: string): Promise<void>;
+    static completeMultipartUpload(key: string, uploadId: string, bucketName?: string, objectStorageOptions?: ObjectStorageOptions): 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.
+     * @param {ObjectStorageOptions} [objectStorageOptions] - The options for the object storage service.
      * @return {Promise<void>} A Promise that resolves when the multipart upload is aborted.
      */
-    static abortMultipartUpload(key: string, uploadId: string, bucketName?: string): Promise<void>;
+    static abortMultipartUpload(key: string, uploadId: string, bucketName?: string, objectStorageOptions?: ObjectStorageOptions): Promise<void>;
     /**
      * Retrieves a presigned URL for a specific part of a multipart upload.
      *

package/package.json

@@ -4,11 +4,15 @@
         "@aws-sdk/credential-provider-node": "3.774.0",
         "@aws-sdk/lib-storage": "3.x",
         "@aws-sdk/s3-request-presigner": "3.x",
-        "@azure/storage-blob": "12.23.0"
+        "@azure/storage-blob": "12.23.0",
+        "basic-ftp": "5.0.3",
+        "ssh2-sftp-client": "9.1.0"
     },
     "devDependencies": {
         "@types/jest": "29.5.5",
+        "@types/ssh2-sftp-client": "9.0.5",
         "auto-version-js": "0.3.10",
+        "dotenv": "17.2.0",
         "eslint-config-custom": "*",
         "jest": "29.7.0",
         "ts-jest": "29.1.1",
@@ -46,11 +50,11 @@
         "build:compile:esm": "tsup --config ./tsup.config.esm.ts",
         "build:compile:types": "tsup --config ./tsup.config.types.ts",
         "prepare-publish": "yarn install && yarn test:cov && yarn build",
-        "publish-package": "yarn prepare-publish && npm publish --tag=beta",
+        "publish-package": "yarn prepare-publish && npm publish",
         "test": "jest",
         "test:cov": "jest --coverage && chmod +x ./coverageReader.sh && sh ./coverageReader.sh",
         "type-check": "tsc"
     },
     "types": "dist/types/index.d.ts",
-    "version": "1.0.2-beta"
+    "version": "1.0.3-535"
 }