@e-mc/cloud 0.12.8 → 0.13.0

package/README.md

@@ -1,6 +1,6 @@
 # @e-mc/cloud
 
-* NodeJS 18
+* NodeJS 18.20.5 LTS
 * ES2022
 
 ## General Usage
@@ -9,7 +9,7 @@
 
 ## Interface
 
-* [View Source](https://www.unpkg.com/@e-mc/types@0.12.7/lib/index.d.ts)
+* [View Source](https://www.unpkg.com/@e-mc/types@0.13.0/lib/index.d.ts)
 
 ```typescript
 import type { IHost, IScopeOrigin } from "./index";
@@ -31,6 +31,7 @@ interface ICloud extends IClientDb<IHost, CloudModule, CloudDatabase, CloudServi
     setBucketWebsite(service: string, credential: unknown, bucket: string, options: BucketWebsiteOptions): Promise<boolean>;
     deleteObjects(service: string, credential: unknown, bucket: string, options: DeleteObjectsOptions): Promise<void>;
     deleteObjects(service: string, credential: unknown, bucket: string, recursive?: boolean | DeleteObjectsOptions): Promise<void>;
+    copyObject(service: string, credential: unknown, bucketSource: string, keySource: string, bucket: string, key: string, options?: CopyObjectOptions): 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;
@@ -51,6 +52,7 @@ interface ICloud extends IClientDb<IHost, CloudModule, CloudDatabase, CloudServi
 }
 
 interface CloudConstructor extends ClientDbConstructor<IHost> {
+    LOG_CLOUD_SUCCESS: LogMessageOptions;
     LOG_CLOUD_FAIL: LogMessageOptions;
     LOG_CLOUD_COMMAND: LogMessageOptions;
     LOG_CLOUD_WARN: LogMessageOptions;
@@ -62,7 +64,9 @@ interface CloudConstructor extends ClientDbConstructor<IHost> {
     uploadAsset(state: IScopeOrigin<IFileManager, ICloud>, file: ExternalAsset, options: UploadAssetOptions): Promise<void>[];
     uploadAsset(state: IScopeOrigin<IFileManager, ICloud>, file: ExternalAsset, ignoreProcess: boolean): Promise<void>[];
     uploadAsset(state: IScopeOrigin<IFileManager, ICloud>, file: ExternalAsset, contentType?: string, ignoreProcess?: boolean): Promise<void>[];
+    uploadAssetSuccess(state: IScopeOrigin<IFileManager, ICloud>, file: ExternalAsset, active?: boolean): (value: string) => Promise<void> | void;
     sanitizeAssets(assets: ExternalAsset[]): ExternalAsset[];
+    optionsLogMessage(type: "SUCCESS" | "FAIL" | "COMMAND" | "WARN" | "UPLOAD" | "DOWNLOAD" | "DELETE" | "DELAYED", options?: LogMessageOptions & LogFailOptions): LogMessageOptions & LogFailOptions;
     readonly prototype: ICloud;
     new(module?: CloudModule, database?: CloudDatabase[], ...args: unknown[]): ICloud;
 }
@@ -88,6 +92,7 @@ interface ICloudServiceClient {
     /** @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>;
+    copyObject?(this: IModule, credential: U, bucketSource: string, keySource: string, bucket: string, key: string, options?: unknown, 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>;
 }
@@ -175,12 +180,12 @@ const rows = await instance.getDatabaseRows({ service: "aws-v3", credential: "ma
 
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.12.7/lib/asset.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.7/lib/cloud.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.7/lib/core.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.7/lib/db.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.7/lib/logger.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.7/lib/settings.d.ts
+- https://www.unpkg.com/@e-mc/types@0.13.0/lib/asset.d.ts
+- https://www.unpkg.com/@e-mc/types@0.13.0/lib/cloud.d.ts
+- https://www.unpkg.com/@e-mc/types@0.13.0/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.13.0/lib/db.d.ts
+- https://www.unpkg.com/@e-mc/types@0.13.0/lib/logger.d.ts
+- https://www.unpkg.com/@e-mc/types@0.13.0/lib/settings.d.ts
 
 ## LICENSE
 

package/index.js

@@ -6,8 +6,8 @@ const types_1 = require("@e-mc/types");
 const core_1 = require("@e-mc/core");
 const kCloud = Symbol.for('cloud:constructor');
 const SERVICE_CLIENT = new Map();
-const SERVICE_UPLOAD = {};
-const SERVICE_DOWNLOAD = {};
+const SERVICE_UPLOAD = Object.create(null);
+const SERVICE_DOWNLOAD = Object.create(null);
 function setUploadFilename(upload, filename) {
     filename = Cloud.toPosix(filename.replace(/^\.*[\\/]+/, ''));
     const index = filename.lastIndexOf('/');
@@ -39,17 +39,6 @@ function getFiles(file, data) {
     }
     return [grouped];
 }
-function createUploadCallback(state, file, active) {
-    return async (value) => {
-        if ((0, types_1.isString)(value)) {
-            for (const { instance: document } of state.host.Document) {
-                if (document.cloudUpload && await document.cloudUpload(state, file, value, active)) {
-                    return;
-                }
-            }
-        }
-    };
-}
 function renameTrailing(map, item, folder, value) {
     const location = folder + value;
     map[location] ||= 1;
@@ -57,7 +46,7 @@ function renameTrailing(map, item, folder, value) {
     item.filename = (index !== -1 ? value.substring(0, index) : value) + '_' + map[location]++ + (index !== -1 ? value.substring(index) : '');
 }
 function errorResponse(instance, service, bucket, err) {
-    instance.formatMessage(64, service, ["Unable to empty bucket", bucket], err, { ...Cloud.LOG_CLOUD_WARN });
+    instance.formatMessage(64, service, ["Unable to empty bucket", bucket], err, Cloud.optionsLogMessage('WARN'));
 }
 const errorObject = (err, service, value) => err instanceof Error ? err : typeof err === 'string' ? new Error(err) : (0, types_1.errorMessage)(service, value);
 const assignFilename = (value) => crypto.randomUUID() + (path.extname(value) || '');
@@ -65,6 +54,7 @@ class Cloud extends core_1.ClientDb {
     static [kCloud] = true;
     static STORE_RESULT_PARTITION_SIZE = 16;
     static STORE_RESULT_PARTITION_MULT = 2;
+    static LOG_CLOUD_SUCCESS = core_1.ClientDb.LOG_STYLE_SUCCESS;
     static LOG_CLOUD_FAIL = core_1.ClientDb.LOG_STYLE_FAIL;
     static LOG_CLOUD_COMMAND = Object.freeze({ titleColor: 'blue' });
     static LOG_CLOUD_WARN = Object.freeze({ titleColor: 'yellow' });
@@ -72,6 +62,29 @@ class Cloud extends core_1.ClientDb {
     static LOG_CLOUD_DOWNLOAD = Object.freeze({ titleColor: 'cyan' });
     static LOG_CLOUD_DELETE = Object.freeze({ titleColor: 'grey' });
     static LOG_CLOUD_DELAYED = Object.freeze({ titleColor: 'grey' });
+    static toPosix(value, filename, normalize) {
+        if (typeof filename === 'boolean') {
+            normalize = filename;
+            filename = undefined;
+        }
+        if (typeof value === 'string') {
+            let pathname = value;
+            if (normalize) {
+                pathname = path.posix.normalize(pathname);
+            }
+            if (pathname) {
+                pathname = pathname.replace(/(?<!^)\/+$/, '');
+                if (!filename) {
+                    return pathname;
+                }
+                if (pathname !== '/') {
+                    pathname += '/';
+                }
+                return pathname + filename;
+            }
+        }
+        return filename || '';
+    }
     static async finalize(instance) {
         if (instance.aborted) {
             return (0, types_1.createAbortError)(true);
@@ -87,7 +100,7 @@ class Cloud extends core_1.ClientDb {
         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 });
+            instance.writeTimeElapsed(instance.moduleName, "Transactions were committed", startTime, Cloud.optionsLogMessage('SUCCESS'));
         }
         for (const { instance: document } of this.Document) {
             document.cloudInit?.(state);
@@ -97,7 +110,7 @@ class Cloud extends core_1.ClientDb {
             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 });
+                        instance.formatMessage(64, storage.service, ["Upload failed", storage.bucket], (0, types_1.errorValue)("File not found", item.uri || item.filename || "Unknown"), Cloud.optionsLogMessage('WARN'));
                     });
                     continue;
                 }
@@ -305,11 +318,11 @@ class Cloud extends core_1.ClientDb {
                                     this.addDownload(size = value.length);
                                 }
                                 this.add(destUri);
-                                this.formatMessage(64, service, ["Download success", (0, types_1.formatSize)(size)], destUri, { ...Cloud.LOG_CLOUD_DOWNLOAD });
+                                this.formatMessage(64, service, ["Download success", (0, types_1.formatSize)(size)], destUri, Cloud.optionsLogMessage('DOWNLOAD'));
                                 result ||= destUri;
                             }
                             catch (err) {
-                                if (!copy && core_1.ClientDb.isErrorCode(err, 'EXDEV')) {
+                                if (!copy && (0, types_1.isErrorCode)(err, 'EXDEV')) {
                                     copy = true;
                                     --i;
                                 }
@@ -441,7 +454,7 @@ class Cloud extends core_1.ClientDb {
                         if (index > 0 || !options.contentType) {
                             options.contentType = index === 0 && contentType || this.lookupMime(path.basename(localUri)) || "application/octet-stream";
                         }
-                        uploading.push(instance.uploadObject(service, { ...credential }, bucket, options, localUri, !ignoreProcess ? createUploadCallback(state, file, active) : undefined)
+                        uploading.push(instance.uploadObject(service, { ...credential }, bucket, options, localUri, !ignoreProcess ? this.uploadAssetSuccess(state, file, active) : undefined)
                             .catch((err) => {
                             instance.writeFail(["Upload failed", path.basename(localUri)], err, { type: 64, fatal: i === 0 && index === 0 });
                         }));
@@ -457,6 +470,15 @@ class Cloud extends core_1.ClientDb {
         }
         return tasks;
     }
+    static uploadAssetSuccess(state, file, active = false) {
+        return async (value) => {
+            for (const { instance: document } of state.host.Document) {
+                if (document.cloudUpload && await document.cloudUpload(state, file, value, active)) {
+                    return;
+                }
+            }
+        };
+    }
     static sanitizeAssets(assets) {
         const storage = [];
         for (const item of assets) {
@@ -520,6 +542,9 @@ class Cloud extends core_1.ClientDb {
         }
         return assets;
     }
+    static optionsLogMessage(type, options) {
+        return { type: 64, ...this[`LOG_CLOUD_${type}`], ...options };
+    }
     _moduleName = 'cloud';
     _threadable = true;
     uploaded = [];
@@ -533,27 +558,27 @@ class Cloud extends core_1.ClientDb {
         }
         return super.setQueryResult(service, credential, queryString, result, sessionKey);
     }
-    async createBucket(service, credential, bucket, publicRead, options) {
+    async createBucket(service, credential, bucket, acl, options) {
         if (this.aborted) {
             return (0, types_1.createAbortError)(true);
         }
         const client = this.getClient(service);
         try {
-            if (publicRead === undefined || typeof publicRead === 'boolean') {
+            if (acl === undefined || typeof acl === 'boolean') {
                 const handler = client.createBucket?.bind(this);
                 if (handler) {
-                    return handler.call(this, credential, bucket, publicRead);
+                    return handler.call(this, credential, bucket, acl);
                 }
             }
             else {
                 const handler = client.createBucketV2?.bind(this);
                 if (handler) {
-                    return handler.call(this, credential, bucket, publicRead, options);
+                    return handler.call(this, credential, bucket, acl, options);
                 }
             }
         }
         catch (err) {
-            this.formatMessage(64, service, ["Unable to create bucket", bucket], err, { ...Cloud.LOG_CLOUD_WARN });
+            this.formatMessage(64, service, ["Unable to create bucket", bucket], err, Cloud.optionsLogMessage('WARN'));
             throw err;
         }
         throw (0, types_1.errorMessage)(service, "Create bucket not supported");
@@ -568,7 +593,7 @@ class Cloud extends core_1.ClientDb {
                 return handler.call(this, credential, bucket, options);
             }
             catch (err) {
-                this.formatMessage(64, service, ["Unable to update bucket policy", bucket], err, { ...Cloud.LOG_CLOUD_WARN });
+                this.formatMessage(64, service, ["Unable to update bucket policy", bucket], err, Cloud.optionsLogMessage('WARN'));
                 throw err;
             }
         }
@@ -584,7 +609,7 @@ class Cloud extends core_1.ClientDb {
                 return handler.call(this, credential, bucket, options);
             }
             catch (err) {
-                this.formatMessage(64, service, ["Unable to update bucket tagging", bucket], err, { ...Cloud.LOG_CLOUD_WARN });
+                this.formatMessage(64, service, ["Unable to update bucket tagging", bucket], err, Cloud.optionsLogMessage('WARN'));
                 throw err;
             }
         }
@@ -600,7 +625,7 @@ class Cloud extends core_1.ClientDb {
                 return handler.call(this, credential, bucket, options);
             }
             catch (err) {
-                this.formatMessage(64, service, ["Unable to configure bucket", bucket], err, { ...Cloud.LOG_CLOUD_WARN });
+                this.formatMessage(64, service, ["Unable to configure bucket", bucket], err, Cloud.optionsLogMessage('WARN'));
                 throw err;
             }
         }
@@ -632,6 +657,18 @@ class Cloud extends core_1.ClientDb {
         }
         throw (0, types_1.errorMessage)(service, "Delete objects not supported");
     }
+    async copyObject(service, credential, bucketSource, keySource, bucket, key, options) {
+        if (this.aborted) {
+            return (0, types_1.createAbortError)(true);
+        }
+        const handler = this.getClient(service).copyObject?.bind(this);
+        if (handler) {
+            return handler.call(this, credential, bucketSource, keySource, bucket, key, options, service).catch((err) => {
+                errorResponse(this, service, bucket, err);
+            });
+        }
+        throw (0, types_1.errorMessage)(service, "Copy object not supported");
+    }
     async uploadObject(service, credential, bucket, upload, localUri, beforeResolve) {
         if (this.aborted) {
             return (0, types_1.createAbortError)(true);
@@ -641,7 +678,7 @@ class Cloud extends core_1.ClientDb {
             handler = this.getUploadHandler(service, credential).bind(this);
         }
         catch (err) {
-            this.formatMessage(64, service, ["Upload function not supported", bucket], localUri, { ...Cloud.LOG_CLOUD_WARN });
+            this.formatMessage(64, service, ["Upload function not supported", bucket], localUri, Cloud.optionsLogMessage('WARN'));
             throw err;
         }
         return new Promise((resolve, reject) => {
@@ -650,7 +687,7 @@ class Cloud extends core_1.ClientDb {
                 if (err) {
                     reject(errorObject(err, service, "Upload failed"));
                 }
-                else if (value) {
+                else if ((0, types_1.isString)(value)) {
                     if (beforeResolve) {
                         await beforeResolve(value);
                     }
@@ -676,7 +713,7 @@ class Cloud extends core_1.ClientDb {
             handler = this.getDownloadHandler(service, credential).bind(this);
         }
         catch (err) {
-            this.formatMessage(64, service, ["Download function not supported", bucket], Cloud.joinPath(download.pathname, download.filename), { ...Cloud.LOG_CLOUD_WARN });
+            this.formatMessage(64, service, ["Download function not supported", bucket], Cloud.joinPath(download.pathname, download.filename), Cloud.optionsLogMessage('WARN'));
             throw err;
         }
         return new Promise((resolve, reject) => {
@@ -726,7 +763,7 @@ class Cloud extends core_1.ClientDb {
                     return await client.executeQuery.call(this, credential, item, sessionKey);
                 }
                 catch (err) {
-                    this.formatFail(64, service, "Unable to execute query", err, { ...Cloud.LOG_CLOUD_FAIL });
+                    this.formatFail(64, service, "Unable to execute query", err, Cloud.optionsLogMessage('FAIL'));
                     throw err;
                 }
             }
@@ -762,7 +799,7 @@ class Cloud extends core_1.ClientDb {
                     return await client.executeBatchQuery.call(this, credential, batch, sessionKey);
                 }
                 catch (err) {
-                    this.formatFail(64, service, "Unable to execute query", err, { ...Cloud.LOG_CLOUD_FAIL });
+                    this.formatFail(64, service, "Unable to execute query", err, Cloud.optionsLogMessage('FAIL'));
                     throw err;
                 }
             }
@@ -828,7 +865,7 @@ class Cloud extends core_1.ClientDb {
             }
         }
         catch (err) {
-            this.formatFail(64, data.service, "Cloud provider not found", err, { ...Cloud.LOG_CLOUD_FAIL });
+            this.formatFail(64, data.service, "Cloud provider not found", err, Cloud.optionsLogMessage('FAIL'));
         }
         return false;
     }

package/package.json

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

package/types/index.d.ts

@@ -23,6 +23,7 @@ export interface ICloudServiceClient<T extends CloudDatabase = CloudDatabase, U
     /** @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>;
+    copyObject?(this: IModule, credential: U, bucketSource: string, keySource: string, bucket: string, key: string, options?: unknown, 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>;
 }

package/util.d.ts

@@ -1,3 +1,4 @@
+import type { IModule } from '@e-mc/types/lib';
 import type { UploadContent } from '@e-mc/types/lib/cloud';
 import type { AuthValue } from '@e-mc/types/lib/http';
 
@@ -6,10 +7,12 @@ import type { Readable } from 'node:stream';
 declare namespace util {
     function readableAsBuffer(from: Readable): Promise<Buffer | null>;
     function createKeyAndBody<T = Buffer>(filename: string, items: UploadContent[], chunkSize?: number | string | FunctionType<void>, errorCallback?: FunctionType<void> | number, flags?: number): [string[], T[], string[]];
+    function createErrorHandler(instance: IModule, service: string, bucket: string): (err: unknown) => void;
     function generateFilename(filename: string): (i: number) => [string, boolean];
     function getBasicAuth(auth: AuthValue): string;
     function getBasicAuth(username: unknown, password?: unknown): string;
     function hasBasicAuth(value: string): boolean;
+    function intoArray<T>(value: T | undefined | null): (T extends Array<infer U> ? U[] : T[]) | null;
     function formatError(title: string | { service: string }, message: string, hint?: string): Error;
 }
 

package/util.js

@@ -2,6 +2,8 @@
 exports.hasBasicAuth = exports.getBasicAuth = void 0;
 exports.readableAsBuffer = readableAsBuffer;
 exports.createKeyAndBody = createKeyAndBody;
+exports.createErrorHandler = createErrorHandler;
+exports.intoArray = intoArray;
 exports.generateFilename = generateFilename;
 exports.formatError = formatError;
 const path = require("node:path");
@@ -114,6 +116,17 @@ function createKeyAndBody(filename, items, chunkSize = 0, errorCallback, flags =
     }
     return [key, body, type];
 }
+function createErrorHandler(instance, service, bucket) {
+    return (err) => {
+        instance.addLog(3, err, service, bucket);
+    };
+}
+function intoArray(value) {
+    if (value != null) {
+        return Array.isArray(value) ? value : [value];
+    }
+    return null;
+}
 function generateFilename(filename) {
     let basename, suffix;
     return (i) => {