@e-mc/file-manager 0.8.10 → 0.9.1

package/LICENSE

@@ -1,7 +1,11 @@
 Copyright 2024 An Pham
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+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.

package/README.md

@@ -1,7 +1,7 @@
 # @e-mc/file-manager
 
-* NodeJS 14
-* ES2019
+* NodeJS 16
+* ES2020
 
 ## General Usage
 
@@ -9,7 +9,7 @@
 
 ## Interface
 
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/index.d.ts
+* [View Source](https://www.unpkg.com/@e-mc/types@0.9.1/lib/index.d.ts)
 
 ```typescript
 import type { DataSource, IncrementalMatch, TaskAction } from "./squared";
@@ -17,7 +17,7 @@ import type { DataSource, IncrementalMatch, TaskAction } from "./squared";
 import type { DocumentConstructor, HostConstructor, ICloud, ICompress, IDocument, IHost, IImage, IModule, IRequest, ITask, ImageConstructor, TaskConstructor, WatchInstance } from "./index";
 import type { ExternalAsset, FileCommand, FileData, IFileThread, OutputFinalize } from "./asset";
 import type { IPermission, PermissionReadWrite } from "./core";
-import type { AssetContentOptions, ChecksumOptions, DeleteFileAddendum, FileOutput, FinalizeResult, FindAssetOptions, IHttpDiskCache, IHttpMemoryCache, InstallData, PostFinalizeCallback, ReplaceOptions } from "./filemanager";
+import type { AssetContentOptions, ChecksumOptions, DeleteFileAddendum, FileOutput, FinalizeResult, FindAssetOptions, IHttpDiskCache, IHttpMemoryCache, ImageMimeMap, InstallData, PostFinalizeCallback, ReplaceOptions } from "./filemanager";
 import type { ExecCommand } from "./logger";
 import type { CopyFileOptions, CreateDirOptions, DeleteFileOptions, MoveFileOptions, ReadFileOptions, RemoveDirOptions, WriteFileOptions } from "./module";
 import type { RequestData, Settings } from "./node";
@@ -28,14 +28,13 @@ import type { SpawnOptions } from "child_process";
 import type { NoParamCallback } from "fs";
 
 interface IFileManager extends IHost, Set<string> {
-    finalizeState: number;
     processTimeout: number;
     cacheToDisk: IHttpDiskCache<ExternalAsset>;
     cacheToMemory: IHttpMemoryCache<ExternalAsset>;
     Request: IRequest<RequestModule>;
     Document: InstallData<IDocument<IFileManager, ExternalAsset>, DocumentConstructor<IFileManager, ExternalAsset>>[];
     Task: InstallData<ITask, TaskConstructor>[];
-    Image: Map<string, InstallData<IImage, ImageConstructor>> | null;
+    Image: Map<ImageMimeMap> | null;
     Cloud: ICloud | null;
     Watch: WatchInstance<ExternalAsset> | null;
     Compress: ICompress<CompressModule> | null;
@@ -52,31 +51,34 @@ interface IFileManager extends IHost, Set<string> {
     readonly fetchedAssets: ExternalAsset[];
     readonly copiedAssets: ExternalAsset[];
     readonly emptyDir: Set<string>;
-    install(name: "document", target: DocumentConstructor<IFileManager, ExternalAsset>, module?: DocumentModule): IDocument<IFileManager, ExternalAsset> | undefined;
-    install(name: "task", target: TaskConstructor, module?: TaskModule): ITask | undefined;
-    install(name: "cloud", handler: string, module?: CloudModule): ICloud | undefined;
-    install(name: "cloud", module?: CloudModule): ICloud | undefined;
-    install(name: "db", module?: DbModule): IDb | undefined;
+    install(name: "document", handler: string, module?: DocumentModule, ...args: unknown[]): IDocument | undefined;
+    install(name: "document", target: DocumentConstructor, module?: DocumentModule, ...args: unknown[]): IDocument | undefined;
+    install(name: "task", handler: string, module?: TaskModule, ...args: unknown[]): ITask | undefined;
+    install(name: "task", target: TaskConstructor, module?: TaskModule, ...args: unknown[]): ITask | undefined;
+    install(name: "cloud", handler: string, module?: CloudModule, ...args: unknown[]): ICloud | undefined;
+    install(name: "cloud", module?: CloudModule, ...args: unknown[]): ICloud | undefined;
+    install(name: "image", handler: string, module?: ImageModule, ...args: unknown[]): IImage | undefined;
+    install(name: "image", target: ImageConstructor, module?: ImageModule, ...args: unknown[]): IImage | undefined;
     install(name: "image", targets: Map<string, ImageConstructor>, module?: ImageModule): void;
     install(name: "watch", module: WatchModule): WatchInstance<ExternalAsset> | undefined;
     install(name: "watch", interval?: number | string, port?: number | string, securePort?: number | string, extensions?: unknown[]): WatchInstance<ExternalAsset> | undefined;
     install(name: "compress", module?: CompressModule): ICompress<CompressModule> | undefined;
     install(name: string, ...args: unknown[]): IModule | undefined;
     using(...items: ExternalAsset[] | [boolean, ...ExternalAsset[]]): this;
-    contains(item: ExternalAsset, condition?: (...args: [ExternalAsset]) => boolean): boolean;
+    contains(item: ExternalAsset, condition?: (target: ExternalAsset) => boolean): boolean;
     removeCwd(value: unknown): string;
     findAsset(value: string | URL, instance?: IModule | FindAssetOptions<ExternalAsset>): ExternalAsset | undefined;
     removeAsset(file: ExternalAsset): boolean;
-    replace(file: ExternalAsset, replaceWith: string, options: ReplaceOptions): boolean;
-    replace(file: ExternalAsset, replaceWith: string, mimeType?: string | ReplaceOptions): boolean;
+    replace(file: ExternalAsset, replaceWith: string, mimeType: Undef<string>): boolean;
+    replace(file: ExternalAsset, replaceWith: string, options?: ReplaceOptions): boolean;
     rename(file: ExternalAsset, value: string): boolean;
     performAsyncTask(): void;
     removeAsyncTask(): void;
     completeAsyncTask(err?: unknown, uri?: string, parent?: ExternalAsset, type?: number): void;
     performFinalize(override?: boolean): void;
     hasDocument(instance: IModule, document: string | string[] | undefined): boolean;
-    getDocumentAssets(instance: IModule, condition?: (...args: [ExternalAsset]) => boolean): ExternalAsset[];
-    getDataSourceItems(instance: IModule, condition?: (...args: [DataSource]) => boolean): DataSource[];
+    getDocumentAssets(instance: IModule, condition?: (target: ExternalAsset) => boolean): ExternalAsset[];
+    getDataSourceItems(instance: IModule, condition?: (target: DataSource) => boolean): DataSource[];
     setLocalUri(file: ExternalAsset, replace?: boolean): FileOutput;
     getLocalUri(data: FileData<ExternalAsset>): string;
     getMimeType(data: FileData<ExternalAsset>): string;
@@ -86,14 +88,17 @@ interface IFileManager extends IHost, Set<string> {
     removeProcessTimeout(instance: IModule, file: ExternalAsset): void;
     getProcessTimeout(handler: InstallData): number;
     clearProcessTimeout(): void;
+    scheduleTask(url: string | URL, data: unknown, priority: number): Promise<unknown>;
+    scheduleTask(url: string | URL, data: unknown, thenCallback?: (...args: unknown[]) => unknown, catchCallback?: (...args: unknown[]) => unknown, priority?: number): Promise<unknown>;
+    setTaskLimit(value: number): void;
     addDownload(value: number | Buffer | string, encoding: BufferEncoding): number;
-    addDownload(value: number | Buffer | string, type?: number, encoding?: BufferEncoding): number;
+    addDownload(value: number | Buffer | string, type?: number | BufferEncoding, encoding?: BufferEncoding): number;
     getDownload(type?: number): [number, number];
-    transformAsset(data: IFileThread, parent?: ExternalAsset): Promise<void>;
+    transformAsset(data: IFileThread, parent?: ExternalAsset, override?: boolean): Promise<boolean>;
     addCopy(data: FileCommand<ExternalAsset>, saveAs?: string, replace?: boolean): string | undefined;
     findMime(file: ExternalAsset, rename?: boolean): Promise<string>;
     getUTF8String(file: ExternalAsset, uri?: string): string;
-    getBuffer(file: ExternalAsset, minStreamSize?: number): Promise<Buffer> | Buffer | null;
+    getBuffer(file: ExternalAsset, minStreamSize?: number): Promise<Buffer | null> | Buffer | null;
     getCacheDir(url: string | URL, createDir?: boolean): string;
     setAssetContent(file: ExternalAsset, content: string, options?: AssetContentOptions): string;
     getAssetContent(file: ExternalAsset, content?: string): string | undefined;
@@ -101,10 +106,11 @@ interface IFileManager extends IHost, Set<string> {
     writeImage(document: string | string[], output: OutputFinalize<ExternalAsset>): boolean;
     compressFile(file: ExternalAsset, overwrite?: boolean): Promise<unknown>;
     fetchObject(uri: string | URL, format: BufferFormat): Promise<object | null>;
-    fetchObject(uri: string | URL, options?: OpenOptions | BufferFormat): Promise<object | null>;
+    fetchObject(uri: string | URL, options?: OpenOptions): Promise<object | null>;
     fetchBuffer(uri: string | URL, options?: OpenOptions): Promise<Buffer | string | null>;
     fetchFiles(uri: string | URL, pathname: string): Promise<string[]>;
-    fetchFiles(uri: string | URL, options?: Aria2Options | string): Promise<string[]>;
+    fetchFiles(uri: string | URL, options?: Aria2Options): Promise<string[]>;
+    updateProgress(name: "request", id: number | string, receivedBytes: number, totalBytes: number, dataTime?: HighResolutionTime): void;
     start(emptyDir?: boolean): Promise<FinalizeResult>;
     processAssets(emptyDir?: boolean, using?: ExternalAsset[]): void;
     deleteFile(src: string, promises: boolean): Promise<void>;
@@ -130,6 +136,8 @@ interface IFileManager extends IHost, Set<string> {
     get delayed(): number;
     set cleared(value);
     get cleared(): boolean;
+    set finalizeState(value);
+    get finalizeState(): number;
 
     /* Set */
     add(value: string, parent?: ExternalAsset, type?: number): this;
@@ -170,37 +178,126 @@ interface IFileManager extends IHost, Set<string> {
 }
 
 interface FileManagerConstructor extends HostConstructor {
+    purgeMemory(percent?: number, limit?: number | boolean, parent?: number | boolean): Promise<number>;
     loadSettings(settings: Settings, password?: string): boolean;
     loadSettings(settings: Settings, permission?: PermissionReadWrite, password?: string): boolean;
     sanitizeAssets(assets: ExternalAsset[], exclusions?: string[]): ExternalAsset[];
-    writeChecksum(root: string, options?: ChecksumOptions): Promise<string[]>;
-    writeChecksum(root: string, to: string | undefined, options?: ChecksumOptions): Promise<string[] | null>;
-    writeChecksum(root: string, to?: string | ChecksumOptions, options?: ChecksumOptions): Promise<string[] | null>;
-    verifyChecksum(root: string, options?: ChecksumOptions): Promise<[string[], string[]] | null>;
-    verifyChecksum(root: string, from: string | undefined, options?: ChecksumOptions): Promise<[string[], string[]] | null>;
-    verifyChecksum(root: string, from?: string | ChecksumOptions, options?: ChecksumOptions): Promise<[string[], string[]] | null>;
+    writeChecksum(root: string, options: ChecksumOptions): Promise<string[]>;
+    writeChecksum(root: string, to?: string, options?: ChecksumOptions): Promise<string[] | null>;
+    verifyChecksum(root: string, options: ChecksumOptions): Promise<[string[], string[], number] | null>;
+    verifyChecksum(root: string, from?: string, options?: ChecksumOptions): Promise<[string[], string[], number] | null>;
     createFileThread(host: IFileManager, file: ExternalAsset): IFileThread;
     setTimeout(options: Record<string, number | string>): void;
     defineHttpCache(options: HttpMemorySettings, disk?: boolean): void;
     defineHttpConnect(options: HttpConnectSettings): void;
     readonly prototype: IFileManager;
     new(baseDirectory: string, config: RequestData, postFinalize?: PostFinalizeCallback): IFileManager;
-    new(baseDirectory: string, config: RequestData, permission?: IPermission, postFinalize?: PostFinalizeCallback): IFileManager;
+    new(baseDirectory: string, config: RequestData, permission?: IPermission | null, postFinalize?: PostFinalizeCallback): IFileManager;
 }
 ```
 
+## Settings
+
+```typescript
+interface ProcessModule {
+    thread?: {
+        sub_limit?: number;
+    };
+}
+
+interface RequestModule {
+    timeout?: number | string;
+    disk?: {
+        enabled?: boolean;
+        expires?: number | string;
+        limit?: number | string;
+        include?: string[];
+        exclude?: string[];
+    };
+    buffer?: {
+        enabled?: boolean;
+        expires?: number | string;
+        limit?: number | string;
+        include?: string[];
+        exclude?: string[];
+        limit_all?: number | string;
+        purge_amount?: number | string;
+        to_disk?: number | string | [number | string, (number | string)?];
+    };
+    connect?: {
+        timeout?: number | string;
+        retry_wait?: number | string;
+        retry_after?: number | string;
+        retry_limit?: number;
+        redirect_limit?: number;
+    };
+}
+
+interface ErrorModule {
+    recursion_limit?: number;
+}
+
+interface LoggerModule {
+    session_id?: boolean | number;
+}
+```
+
+### Example usage
+
+```javascript
+const FileManager = require("@e-mc/file-manager");
+
+FileManager.loadSettings({ // Global
+    process: {
+        thread: { sub_limit: 16 }
+    },
+    request: {
+        timeout: "15s",
+        disk: {
+            enabled: true,
+            limit: "1gb", // Content-Length
+            expires: "1d",
+            exclude: ["https://github.com", "zip"]
+        },
+        buffer: {
+            enabled: true,
+            limit: "64mb",
+            limit_all: "512mb",
+            expires: "1h",
+            purge_amount: 0.25 // When limit_all exceeded
+        }
+    },
+    permission: {
+        disk_read: ["**/*"],
+        disk_write: ["/tmp/**"]
+    }
+});
+
+const assets = [
+    { pathname: "output", filename: "image1.png", uri: "http://hostname/path/document1.png" },
+    { pathname: "output", filename: "image2.png", uri: "http://hostname/path/document2.png" }
+];
+
+const instance = new FileManager("/path/workspace", { assets, incremental: "etag" }, { disk_write: ["/path/workspace/output/**"] });
+await instance.start();
+```
+
+NOTE: **FileManager** is a sub-class of [Host](https://www.npmjs.com/package/@e-mc/core) and [Module](https://www.npmjs.com/package/@e-mc/module). Their ``loadSettings`` will be called as well which uses a combined [Settings](https://e-mc.readthedocs.io/en/latest/references.html#references-e-mc-types-lib-node) object.
+
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/squared.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/asset.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/core.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/filemanager.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/logger.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/module.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/node.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/request.d.ts
-- https://www.unpkg.com/@e-mc/types@0.8.10/lib/settings.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.1/lib/squared.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.1/lib/asset.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.1/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.1/lib/filemanager.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.1/lib/logger.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.1/lib/module.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.1/lib/node.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.1/lib/request.d.ts
+- https://www.unpkg.com/@e-mc/types@0.9.1/lib/settings.d.ts
+
+* https://www.npmjs.com/package/@types/node
 
 ## LICENSE
 
-MIT
+BSD 3-Clause