@e-mc/file-manager 0.9.6 → 0.10.0

package/README.md

@@ -9,7 +9,7 @@
 
 ## Interface
 
-* [View Source](https://www.unpkg.com/@e-mc/types@0.9.6/lib/index.d.ts)
+* [View Source](https://www.unpkg.com/@e-mc/types@0.10.0/lib/index.d.ts)
 
 ```typescript
 import type { DataSource, IncrementalMatch, TaskAction } from "./squared";
@@ -31,13 +31,13 @@ interface IFileManager extends IHost, Set<string> {
     processTimeout: number;
     cacheToDisk: IHttpDiskCache<ExternalAsset>;
     cacheToMemory: IHttpMemoryCache<ExternalAsset>;
-    Request: IRequest<RequestModule>;
+    Request: IRequest;
     Document: InstallData<IDocument<IFileManager, ExternalAsset>, DocumentConstructor<IFileManager, ExternalAsset>>[];
     Task: InstallData<ITask, TaskConstructor>[];
     Image: Map<ImageMimeMap> | null;
     Cloud: ICloud | null;
     Watch: WatchInstance<ExternalAsset> | null;
-    Compress: ICompress<CompressModule> | null;
+    Compress: ICompress | null;
     readonly documentAssets: ExternalAsset[];
     readonly taskAssets: (ExternalAsset & Required<TaskAction>)[];
     readonly dataSourceItems: DataSource[];
@@ -62,7 +62,7 @@ interface IFileManager extends IHost, Set<string> {
     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: "compress", module?: CompressModule): ICompress | undefined;
     install(name: string, ...args: unknown[]): IModule | undefined;
     using(...items: ExternalAsset[] | [boolean, ...ExternalAsset[]]): this;
     contains(item: ExternalAsset, condition?: (target: ExternalAsset) => boolean): boolean;
@@ -79,6 +79,7 @@ interface IFileManager extends IHost, Set<string> {
     hasDocument(instance: IModule, document: string | string[] | undefined): boolean;
     getDocumentAssets(instance: IModule, condition?: (target: ExternalAsset) => boolean): ExternalAsset[];
     getDataSourceItems(instance: IModule, condition?: (target: DataSource) => boolean): DataSource[];
+    checkFilename(file: ExternalAsset, pathname?: string): string;
     setLocalUri(file: ExternalAsset, replace?: boolean): FileOutput;
     getLocalUri(data: FileData<ExternalAsset>): string;
     getMimeType(data: FileData<ExternalAsset>): string;
@@ -119,11 +120,12 @@ interface IFileManager extends IHost, Set<string> {
     deleteFile(src: string, options: DeleteFileOptions & DeleteFileAddendum, callback?: NoParamCallback): unknown;
     restart(recursive?: boolean | "abort", emptyDir?: boolean): void;
     restart(recursive?: boolean | "abort", exclusions?: string[], emptyDir?: boolean): void;
-    finalizeCompress(assets: ExternalAsset[]): Promise<unknown>;
-    finalizeDocument(): Promise<unknown>;
-    finalizeTask(assets: (ExternalAsset & Required<TaskAction>)[]): Promise<unknown>;
-    finalizeCloud(): Promise<unknown>;
-    finalizeCleanup(): Promise<unknown>;
+    finalizeCompress(assets: ExternalAsset[]): Promise<void>;
+    finalizeDocument(): Promise<void>;
+    finalizeTask(assets: (ExternalAsset & Required<TaskAction>)[]): Promise<void>;
+    finalizeCloud(): Promise<void>;
+    finalizeChecksum(): Promise<void>;
+    finalizeCleanup(): Promise<void>;
     finalize(): Promise<void>;
     close(): void;
     reset(): boolean;
@@ -199,6 +201,8 @@ interface FileManagerConstructor extends HostConstructor {
 ## Settings
 
 ```typescript
+import type { BackgroundColor, ForegroundColor, LoggerProgress } from "./logger";
+
 interface ProcessModule {
     thread?: {
         sub_limit?: number;
@@ -238,6 +242,7 @@ interface ErrorModule {
 }
 
 interface LoggerModule {
+    progress?: LoggerProgress;
     session_id?: boolean | number;
 }
 ```
@@ -273,12 +278,26 @@ FileManager.loadSettings({ // Global
     }
 });
 
-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 requestData = {
+  assets: [
+    { uri: "http://hostname/path/document1.png" }, // /path/workspace/document1.png
+    { pathname: "output", uri: "http://hostname/path/unknown", mimeType: "image/png" }, // /path/workspace/output/unknown.png
+    { pathname: "output", filename: "image2.png", uri: "http://hostname/path/document2.png" } // /path/workspace/output/image2.png
+  ],
+  incremental: "etag",
+  threads: 8,
+  log: {
+    showSize: true,
+    showProgress: true,
+    showDiff: [
+      "**/assets/*.js", // Local path
+      "javascript", // application/javascript | text/javascript
+      "text/css"
+    ]
+  }
+};
 
-const instance = new FileManager("/path/workspace", { assets, incremental: "etag" }, { disk_write: ["/path/workspace/output/**"] });
+const instance = new FileManager("/path/workspace", requestData, { disk_write: ["/path/workspace/output/**"] });
 await instance.start();
 ```
 
@@ -286,15 +305,15 @@ NOTE: **FileManager** is a sub-class of [Host](https://www.npmjs.com/package/@e-
 
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.9.6/lib/squared.d.ts
-- https://www.unpkg.com/@e-mc/types@0.9.6/lib/asset.d.ts
-- https://www.unpkg.com/@e-mc/types@0.9.6/lib/core.d.ts
-- https://www.unpkg.com/@e-mc/types@0.9.6/lib/filemanager.d.ts
-- https://www.unpkg.com/@e-mc/types@0.9.6/lib/logger.d.ts
-- https://www.unpkg.com/@e-mc/types@0.9.6/lib/module.d.ts
-- https://www.unpkg.com/@e-mc/types@0.9.6/lib/node.d.ts
-- https://www.unpkg.com/@e-mc/types@0.9.6/lib/request.d.ts
-- https://www.unpkg.com/@e-mc/types@0.9.6/lib/settings.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/squared.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/asset.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/filemanager.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/logger.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/module.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/node.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/request.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/settings.d.ts
 
 * https://www.npmjs.com/package/@types/node
 

package/index.d.ts

@@ -1,6 +1,6 @@
-import type { FileManagerConstructor } from '../types/lib';
-import type { ExternalAsset } from '../types/lib/asset';
-
-declare const FileManager: FileManagerConstructor<ExternalAsset>;
-
+import type { FileManagerConstructor } from '../types/lib';
+import type { ExternalAsset } from '../types/lib/asset';
+
+declare const FileManager: FileManagerConstructor<ExternalAsset>;
+
 export = FileManager;