@e-mc/file-manager 0.12.8 → 0.13.0

package/README.md

@@ -1,6 +1,6 @@
 # @e-mc/file-manager
 
-* NodeJS 18
+* NodeJS 18.20.5 LTS
 * ES2022
 
 ## General Usage
@@ -9,15 +9,15 @@
 
 ## 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 { DataSource, IncrementalMatch, TaskAction } from "./squared";
+import type { ChecksumValue, DataSource, IncrementalMatch, TaskAction } from "./squared";
 
 import type { DocumentConstructor, HostConstructor, ICloud, ICompress, IDocument, IHost, IImage, IModule, IRequest, ITask, IWatch, ImageConstructor, TaskConstructor, WatchConstructor } 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, ImageMimeMap, InstallData, PostFinalizeCallback, ReplaceOptions } from "./filemanager";
+import type { AssetContentOptions, CheckHashOptions, 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";
@@ -96,8 +96,12 @@ interface IFileManager extends IHost, Set<string> {
     addDownload(value: number | Buffer | string, encoding: BufferEncoding): number;
     addDownload(value: number | Buffer | string, type?: number | BufferEncoding, encoding?: BufferEncoding): number;
     getDownload(type?: number): [number, number];
+    checkHash(checksum: ChecksumValue, options: CheckHashOptions): boolean;
+    checkHash(checksum: ChecksumValue, data: Bufferable | null, uri: string | URL | undefined): boolean;
+    checkHash(checksum: ChecksumValue, data: Bufferable, options?: CheckHashOptions): boolean;
     transformAsset(data: IFileThread, parent?: ExternalAsset, override?: boolean): Promise<boolean>;
     addCopy(data: FileCommand<ExternalAsset>, saveAs?: string, replace?: boolean): string | undefined;
+    handleFilePermission(file: ExternalAsset): void;
     findMime(file: ExternalAsset, rename?: boolean): Promise<string>;
     getUTF8String(file: ExternalAsset, uri?: string): string;
     getBuffer(file: ExternalAsset, minStreamSize?: number): Promise<Buffer | null> | Buffer | null;
@@ -128,6 +132,7 @@ interface IFileManager extends IHost, Set<string> {
     finalizeChecksum(): Promise<void>;
     finalizeCleanup(): Promise<void>;
     finalize(): Promise<void>;
+    removeFiles(): void;
     close(): void;
     reset(): boolean;
     get baseDirectory(): string;
@@ -150,35 +155,11 @@ interface IFileManager extends IHost, Set<string> {
 
     /* EventEmitter */
     on(event: "end", listener: PostFinalizeCallback): this;
-    on(event: "exec", listener: (command: ExecCommand, options?: SpawnOptions) => void): this;
-    on(event: "error", listener: (err: Error) => void): this;
-    on(event: "file:read", listener: (src: string, data: Buffer | string, options?: ReadFileOptions) => void): this;
-    on(event: "file:write", listener: (src: string, options?: WriteFileOptions) => void): this;
-    on(event: "file:delete", listener: (src: string, options?: DeleteFileOptions) => void): this;
-    on(event: "file:copy", listener: (dest: string, options?: CopyFileOptions) => void): this;
-    on(event: "file:move", listener: (dest: string, options?: MoveFileOptions) => void): this;
-    on(event: "dir:create", listener: (src: string, options?: CreateDirOptions) => void): this;
-    on(event: "dir:remove", listener: (src: string, options?: RemoveDirOptions) => void): this;
+    on(event: "asset:permission", listener: (file: ExternalAsset) => void): this;
     once(event: "end", listener: PostFinalizeCallback): this;
-    once(event: "exec", listener: (command: ExecCommand, options?: SpawnOptions) => void): this;
-    once(event: "error", listener: (err: Error) => void): this;
-    once(event: "file:read", listener: (src: string, data: Buffer | string, options?: ReadFileOptions) => void): this;
-    once(event: "file:write", listener: (src: string, options?: WriteFileOptions) => void): this;
-    once(event: "file:delete", listener: (src: string, options?: DeleteFileOptions) => void): this;
-    once(event: "file:copy", listener: (dest: string, options?: CopyFileOptions) => void): this;
-    once(event: "file:move", listener: (dest: string, options?: MoveFileOptions) => void): this;
-    once(event: "dir:create", listener: (src: string, options?: CreateDirOptions) => void): this;
-    once(event: "dir:remove", listener: (src: string, options?: RemoveDirOptions) => void): this;
+    once(event: "asset:permission", listener: (file: ExternalAsset) => void): this;
     emit(event: "end", result: FinalizeResult): boolean;
-    emit(event: "exec", command: ExecCommand, options?: SpawnOptions): boolean;
-    emit(event: "error", err: Error): boolean;
-    emit(event: "file:read", src: string, data: Buffer | string, options?: ReadFileOptions): boolean;
-    emit(event: "file:write", src: string, options?: WriteFileOptions): boolean;
-    emit(event: "file:delete", src: string, options?: DeleteFileOptions): boolean;
-    emit(event: "file:copy", dest: string, options?: CopyFileOptions): boolean;
-    emit(event: "file:move", dest: string, options?: MoveFileOptions): boolean;
-    emit(event: "dir:create", src: string, options?: CreateDirOptions): boolean;
-    emit(event: "dir:remove", src: string, options?: RemoveDirOptions): boolean;
+    emit(event: "asset:permission", file: ExternalAsset): boolean;
 }
 
 interface FileManagerConstructor extends HostConstructor {
@@ -211,6 +192,14 @@ interface ProcessModule {
     };
 }
 
+interface MemoryModule {
+    settings?: {
+        stats?: {
+            file_count?: boolean;
+        };
+    };
+}
+
 interface RequestModule {
     timeout?: number | string;
     disk?: {
@@ -307,15 +296,15 @@ NOTE: **FileManager** is a sub-class of [Host](https://www.npmjs.com/package/@e-
 
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.12.7/lib/squared.d.ts
-- 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/core.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.7/lib/filemanager.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/module.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.7/lib/node.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.7/lib/request.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/squared.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/core.d.ts
+- https://www.unpkg.com/@e-mc/types@0.13.0/lib/filemanager.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/module.d.ts
+- https://www.unpkg.com/@e-mc/types@0.13.0/lib/node.d.ts
+- https://www.unpkg.com/@e-mc/types@0.13.0/lib/request.d.ts
+- https://www.unpkg.com/@e-mc/types@0.13.0/lib/settings.d.ts
 
 * https://www.npmjs.com/package/@types/node