@e-mc/cloud 0.10.5 → 0.11.0

package/LICENSE

@@ -8,4 +8,4 @@ Redistribution and use in source and binary forms, with or without modification,
 
 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,7 +1,7 @@
 # @e-mc/cloud
 
-* NodeJS 16
-* ES2020
+* NodeJS 16 LTS
+* ES2021
 
 ## General Usage
 
@@ -9,12 +9,12 @@
 
 ## Interface
 
-* [View Source](https://www.unpkg.com/@e-mc/types@0.10.5/lib/index.d.ts)
+* [View Source](https://www.unpkg.com/@e-mc/types@0.11.0/lib/index.d.ts)
 
 ```typescript
 import type { IHost, IScopeOrigin } from "./index";
 import type { ExternalAsset } from "./asset";
-import type { BucketWebsiteOptions, CloudDatabase, CloudFeatures, CloudFunctions, CloudService, CloudStorage, CloudStorageDownload, CloudStorageUpload, UploadAssetOptions } from "./cloud";
+import type { BucketWebsiteOptions, CloudDatabase, CloudFeatures, CloudFunctions, CloudService, CloudStorage, CloudStorageDownload, CloudStorageUpload, DeleteObjectsOptions, UploadAssetOptions } from "./cloud";
 import type { ClientDbConstructor, IClientDb } from "./core";
 import type { BatchQueryResult, QueryResult } from "./db";
 import type { LogMessageOptions } from "./logger";
@@ -29,7 +29,8 @@ interface ICloud extends IClientDb<IHost, CloudModule, CloudDatabase, CloudServi
     setBucketPolicy(service: string, credential: unknown, bucket: string, options: unknown): Promise<boolean>;
     setBucketTagging(service: string, credential: unknown, bucket: string, options: unknown): Promise<boolean>;
     setBucketWebsite(service: string, credential: unknown, bucket: string, options: BucketWebsiteOptions): Promise<boolean>;
-    deleteObjects(service: string, credential: unknown, bucket: string, recursive?: boolean): Promise<void>;
+    deleteObjects(service: string, credential: unknown, bucket: string, options: DeleteObjectsOptions): Promise<void>;
+    deleteObjects(service: string, credential: unknown, bucket: string, recursive?: boolean | DeleteObjectsOptions): Promise<void>;
     uploadObject(service: string, credential: unknown, bucket: string, upload: CloudStorageUpload, localUri: string, beforeResolve?: ((value: string) => Promise<void> | void)): Promise<string>;
     downloadObject(service: string, credential: unknown, bucket: string, download: CloudStorageDownload, beforeResolve?: ((value: Buffer | string | null) => Promise<string | undefined> | void)): Promise<Buffer | string>;
     getStorage(action: CloudFunctions, data: CloudStorage[] | undefined): CloudStorage | undefined;
@@ -76,13 +77,17 @@ interface ICloudServiceClient {
     validateDatabase?(credential: unknown, data?: CloudService): boolean;
     createStorageClient?(this: IModule, credential: unknown, service?: string): unknown;
     createDatabaseClient?(this: IModule, credential: unknown, data?: CloudService): unknown;
+    /** @deprecated */
     createBucket?(this: IModule, credential: unknown, bucket: string, publicRead?: boolean, service?: string, sdk?: string): Promise<boolean>;
     createBucketV2?(this: IModule, credential: unknown, bucket: string, acl?: unknown, options?: unknown, service?: string, sdk?: string): Promise<boolean>;
     setBucketPolicy?(this: IModule, credential: unknown, bucket: string, options: unknown, service?: string, sdk?: string): Promise<boolean>;
     setBucketTagging?(this: IModule, credential: unknown, bucket: string, options: unknown, service?: string, sdk?: string): Promise<boolean>;
     setBucketWebsite?(this: IModule, credential: unknown, bucket: string, options: BucketWebsiteOptions, service?: string, sdk?: string): Promise<boolean>;
+    /** @deprecated */
     deleteObjects?(this: IModule, credential: unknown, bucket: string, service?: string, sdk?: string, recursive?: boolean): Promise<void>;
+    /** @deprecated */
     deleteObjectsV2?(this: IModule, credential: unknown, bucket: string, recursive?: boolean, service?: string, sdk?: string): Promise<void>;
+    deleteObjectsV3?(this: IModule, credential: U, bucket: string, options?: DeleteObjectsOptions, service?: string, sdk?: string): Promise<void>;
     executeQuery?(this: ICloud, credential: unknown, data: CloudDatabase, sessionKey?: string): Promise<QueryResult>;
     executeBatchQuery?(this: ICloud, credential: unknown, batch: CloudDatabase[], sessionKey?: string): Promise<BatchQueryResult>;
 }
@@ -102,9 +107,7 @@ interface CloudModule {
     "aws-v3"?: CloudStoredCredentials;
     azure?: CloudStoredCredentials; // az
     gcp?: CloudStoredCredentials; // gcloud
-    ibm?: CloudStoredCredentials;
     oci?: CloudStoredCredentials;
-    minio?: CloudStoredCredentials;
     settings?: {
         broadcast_id?: string | string[];
         users?: Record<string, Record<string, unknown>>;
@@ -118,9 +121,7 @@ interface CloudModule {
         "aws-v3"?: CloudServiceOptions;
         azure?: CloudServiceOptions;
         gcp?: CloudServiceOptions;
-        ibm?: CloudServiceOptions;
         oci?: CloudServiceOptions;
-        minio?: CloudServiceOptions;
     };
     permission?: PermittedDirectories;
 }
@@ -174,13 +175,13 @@ const rows = await instance.getDatabaseRows({ service: "aws-v3", credential: "ma
 
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.10.5/lib/asset.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.5/lib/cloud.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.5/lib/core.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.5/lib/db.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.5/lib/logger.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.5/lib/settings.d.ts
+- https://www.unpkg.com/@e-mc/types@0.11.0/lib/asset.d.ts
+- https://www.unpkg.com/@e-mc/types@0.11.0/lib/cloud.d.ts
+- https://www.unpkg.com/@e-mc/types@0.11.0/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.11.0/lib/db.d.ts
+- https://www.unpkg.com/@e-mc/types@0.11.0/lib/logger.d.ts
+- https://www.unpkg.com/@e-mc/types@0.11.0/lib/settings.d.ts
 
 ## LICENSE
 
-BSD 3-Clause
+BSD 3-Clause

package/index.js

@@ -1,7 +1,7 @@
 "use strict";
-const path = require("path");
-const fs = require("fs");
-const crypto = require("crypto");
+const path = require("node:path");
+const fs = require("node:fs");
+const crypto = require("node:crypto");
 const types_1 = require("@e-mc/types");
 const core_1 = require("@e-mc/core");
 const SERVICE_CLIENT = new Map();
@@ -80,7 +80,7 @@ class Cloud extends core_1.ClientDb {
         const bucketPolicy = {};
         const bucketTagging = {};
         const rawFiles = [];
-        const startTime = process.hrtime();
+        const startTime = process.hrtime.bigint();
         let tasks = [], downloadMap;
         if (await instance.commit()) {
             instance.writeTimeElapsed(instance.moduleName, "Transactions were committed", startTime, { type: 64, ...Cloud.LOG_STYLE_SUCCESS });
@@ -90,7 +90,7 @@ class Cloud extends core_1.ClientDb {
         }
         for (const item of this.assets) {
             const cloudStorage = item.cloudStorage;
-            if ((0, types_1.isArray)(cloudStorage) && !(0, types_1.ignoreFlag)(item.flags)) {
+            if ((0, types_1.isArray)(cloudStorage) && !(0, types_1.ignoreFlag)(item)) {
                 if (item.invalid) {
                     cloudStorage.forEach(storage => {
                         instance.formatMessage(64, storage.service, ["Upload failed", storage.bucket], (0, types_1.errorValue)("File not found", item.uri || item.filename || "Unknown"), { ...Cloud.LOG_CLOUD_WARN });
@@ -120,10 +120,14 @@ class Cloud extends core_1.ClientDb {
                             const service = bucketDelete[name] ||= {};
                             const items = service[bucket];
                             if (!items) {
-                                service[bucket] = [{ ...credential }, admin.recursive];
+                                let options = (0, types_1.isObject)(admin.emptyBucket) ? admin.emptyBucket : undefined;
+                                if (typeof admin.recursive === 'boolean') {
+                                    (options ||= {}).recursive = admin.recursive;
+                                }
+                                service[bucket] = [{ ...credential }, options];
                             }
                             else if (admin.recursive === false) {
-                                items[1] = false;
+                                (items[1] ||= {}).recursive = false;
                             }
                         }
                         if (configBucket) {
@@ -151,8 +155,8 @@ class Cloud extends core_1.ClientDb {
         for (const service in bucketDelete) {
             const map = bucketDelete[service];
             for (const bucket in map) {
-                const [credential, recursive] = map[bucket];
-                tasks.push(instance.deleteObjects(service, credential, bucket, recursive).catch((err) => {
+                const [credential, options] = map[bucket];
+                tasks.push(instance.deleteObjects(service, credential, bucket, options).catch((err) => {
                     instance.writeFail(["Unable to empty bucket", service + ': ' + bucket], err, { type: 64, startTime });
                 }));
             }
@@ -223,7 +227,7 @@ class Cloud extends core_1.ClientDb {
         }
         for (const item of this.assets) {
             const cloudStorage = item.cloudStorage;
-            if ((0, types_1.isArray)(cloudStorage) && !(0, types_1.ignoreFlag)(item.flags)) {
+            if ((0, types_1.isArray)(cloudStorage) && !(0, types_1.ignoreFlag)(item)) {
                 for (const data of cloudStorage) {
                     if (!instance.hasStorage('download', data)) {
                         continue;
@@ -280,7 +284,7 @@ class Cloud extends core_1.ClientDb {
                         }
                         const items = Array.from(pending);
                         let result;
-                        for (let i = 0, length = items.length, size, copy; i < length; ++i) {
+                        for (let i = 0, length = items.length, size = 0, copy = false; i < length; ++i) {
                             const destUri = items[i];
                             try {
                                 if (typeof value === 'string') {
@@ -453,7 +457,7 @@ class Cloud extends core_1.ClientDb {
         const storage = [];
         for (const item of assets) {
             const cloudStorage = item.cloudStorage;
-            if ((0, types_1.isArray)(cloudStorage) && !(0, types_1.ignoreFlag)(item.flags)) {
+            if ((0, types_1.isArray)(cloudStorage) && !(0, types_1.ignoreFlag)(item)) {
                 for (const data of cloudStorage) {
                     const upload = data.upload;
                     if (upload) {
@@ -594,14 +598,21 @@ class Cloud extends core_1.ClientDb {
         }
         throw (0, types_1.errorMessage)(service, "Set bucket website not supported");
     }
-    async deleteObjects(service, credential, bucket, recursive = true) {
+    async deleteObjects(service, credential, bucket, options = true) {
         if (this.aborted) {
             return (0, types_1.createAbortError)(true);
         }
         const client = this.getClient(service);
+        const handlerV3 = client.deleteObjectsV3?.bind(this);
+        if (handlerV3) {
+            return handlerV3.call(this, credential, bucket, typeof options === 'boolean' ? { recursive: options } : options, service).catch((err) => {
+                errorResponse(this, service, bucket, err);
+            });
+        }
+        const recursive = (0, types_1.isObject)(options) ? options.recursive : options;
         const handlerV2 = client.deleteObjectsV2?.bind(this);
         if (handlerV2) {
-            return handlerV2.call(this, credential, bucket, recursive, service).catch((err) => {
+            return handlerV2.call(this, credential, bucket, recursive ?? true, service).catch((err) => {
                 errorResponse(this, service, bucket, err);
             });
         }
@@ -752,7 +763,7 @@ class Cloud extends core_1.ClientDb {
     }
     getCredential(item, unused) {
         const service = item.service;
-        let credential = item.credential, stored;
+        let credential = item.credential, stored = false;
         if (typeof credential === 'string') {
             const settings = this.getSettings(service);
             if ((0, types_1.isPlainObject)(settings)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/cloud",
-  "version": "0.10.5",
+  "version": "0.11.0",
   "description": "Cloud constructor for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -20,9 +20,9 @@
   "license": "BSD-3-Clause",
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
-    "@e-mc/core": "0.10.5",
-    "@e-mc/db": "0.10.5",
-    "@e-mc/types": "0.10.5",
+    "@e-mc/core": "0.11.0",
+    "@e-mc/db": "0.11.0",
+    "@e-mc/types": "0.11.0",
     "mime-types": "^2.1.35"
   }
 }

package/types/index.d.ts

@@ -1,5 +1,5 @@
 import type { ICloud, IFileManager, IModule, IScopeOrigin } from '@e-mc/types/lib';
-import type { BucketWebsiteOptions, CloudAsset, CloudDatabase, CloudService, CloudStorageUpload, DownloadData, UploadData } from '@e-mc/types/lib/cloud';
+import type { BucketWebsiteOptions, CloudAsset, CloudDatabase, CloudService, CloudStorageUpload, DeleteObjectsOptions, DownloadData, UploadData } from '@e-mc/types/lib/cloud';
 import type { BatchQueryResult, QueryResult } from '@e-mc/types/lib/db';
 
 export interface ICloudServiceClient<T extends CloudDatabase = CloudDatabase, U = unknown, V = unknown> {
@@ -20,7 +20,9 @@ export interface ICloudServiceClient<T extends CloudDatabase = CloudDatabase, U
     setBucketWebsite?(this: IModule, credential: U, bucket: string, options: BucketWebsiteOptions, service?: string, sdk?: string): Promise<boolean>;
     /** @deprecated */
     deleteObjects?(this: IModule, credential: U, bucket: string, service?: string, sdk?: string, recursive?: boolean): Promise<void>;
+    /** @deprecated */
     deleteObjectsV2?(this: IModule, credential: U, bucket: string, recursive?: boolean, service?: string, sdk?: string): Promise<void>;
+    deleteObjectsV3?(this: IModule, credential: U, bucket: string, options?: DeleteObjectsOptions, service?: string, sdk?: string): Promise<void>;
     executeQuery?(this: ICloud, credential: V, data: T, sessionKey?: string): Promise<QueryResult>;
     executeBatchQuery?(this: ICloud, credential: V, batch: T[], sessionKey?: string): Promise<BatchQueryResult>;
 }
@@ -32,6 +34,6 @@ export interface CloudScopeOrigin<T extends IFileManager<U>, U extends CloudAsse
 
 export type ServiceHost<T, U = unknown> = (this: IModule, credential: U, service?: string, sdk?: string) => T;
 export type UploadCallback = (data: UploadData, callback: (err: unknown, value?: string) => void) => void;
-export type DownloadCallback = (data: DownloadData, callback: (err: unknown, value?: Null<string | Buffer>) => void) => void;
+export type DownloadCallback = (data: DownloadData, callback: (err: unknown, value?: string | Buffer | null) => void) => void;
 export type UploadHost = ServiceHost<UploadCallback>;
 export type DownloadHost = ServiceHost<DownloadCallback>;

package/util.d.ts

@@ -1,7 +1,7 @@
 import type { UploadContent } from '@e-mc/types/lib/cloud';
 import type { AuthValue } from '@e-mc/types/lib/http';
 
-import type { Readable } from 'stream';
+import type { Readable } from 'node:stream';
 
 declare namespace util {
     /** @deprecated Types.IMPORT_MAP */

package/util.js

@@ -4,9 +4,9 @@ exports.readableAsBuffer = readableAsBuffer;
 exports.createKeyAndBody = createKeyAndBody;
 exports.generateFilename = generateFilename;
 exports.formatError = formatError;
-const path = require("path");
-const fs = require("fs");
-const stream = require("stream");
+const path = require("node:path");
+const fs = require("node:fs");
+const stream = require("node:stream");
 const mime = require("mime-types");
 const types_1 = require("@e-mc/types");
 Object.defineProperty(exports, "IMPORTS", { enumerable: true, get: function () { return types_1.IMPORT_MAP; } });
@@ -25,9 +25,7 @@ async function readableAsBuffer(from) {
             .on('end', () => {
             resolve(result);
         })
-            .on('error', err => {
-            reject(err);
-        })
+            .on('error', reject)
             .read();
     });
 }