@e-mc/file-manager
v0.10.3
Published
FileManager constructor for E-mc.
Downloads
1,104
Readme
@e-mc/file-manager
- NodeJS 16
- ES2020
General Usage
Interface
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, 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";
import type { Aria2Options, BufferFormat, OpenOptions } from "./request";
import type { CloudModule, CompressModule, DbModule, DocumentModule, HttpConnectSettings, HttpMemorySettings, ImageModule, RequestModule, TaskModule, WatchModule } from "./settings";
import type { SpawnOptions } from "child_process";
import type { NoParamCallback } from "fs";
interface IFileManager extends IHost, Set<string> {
processTimeout: number;
cacheToDisk: IHttpDiskCache<ExternalAsset>;
cacheToMemory: IHttpMemoryCache<ExternalAsset>;
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 | null;
readonly documentAssets: ExternalAsset[];
readonly taskAssets: (ExternalAsset & Required<TaskAction>)[];
readonly dataSourceItems: DataSource[];
readonly files: Set<string>;
readonly filesQueued: Set<string>;
readonly filesToRemove: Set<string>;
readonly filesToCompare: Map<ExternalAsset, string[]>;
readonly contentToAppend: Map<string, string[]>;
readonly contentToReplace: Map<string, string[]>;
readonly processing: IFileThread[];
readonly fetchedAssets: ExternalAsset[];
readonly copiedAssets: ExternalAsset[];
readonly emptyDir: Set<string>;
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 | undefined;
install(name: string, ...args: unknown[]): IModule | undefined;
using(...items: ExternalAsset[] | [boolean, ...ExternalAsset[]]): this;
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, 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?: (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;
openThread(instance: IModule, data: IFileThread, timeout?: number): boolean;
closeThread(instance: IModule | null, data: IFileThread, callback?: (...args: unknown[]) => void): boolean;
addProcessTimeout(instance: IModule, file: ExternalAsset, timeout: number): void;
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 | BufferEncoding, encoding?: BufferEncoding): number;
getDownload(type?: number): [number, number];
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 | 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;
writeBuffer(file: ExternalAsset, options?: WriteFileOptions): Buffer | null;
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): 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): 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>;
deleteFile(src: string, options: DeleteFileOptions & DeleteFileAddendum, promises: boolean): Promise<void>;
deleteFile(src: string, callback?: NoParamCallback): unknown;
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<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;
get baseDirectory(): string;
get config(): RequestData;
get assets(): ExternalAsset[];
get incremental(): IncrementalMatch;
set restarting(value);
get restarting(): boolean;
get delayed(): number;
set cleared(value);
get cleared(): boolean;
set finalizeState(value);
get finalizeState(): number;
/* Set */
add(value: string, parent?: ExternalAsset, type?: number): this;
delete(value: string, emptyDir?: boolean): boolean;
has(value: unknown): value is 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;
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;
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;
}
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, 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 | null, postFinalize?: PostFinalizeCallback): IFileManager;
}
Settings
import type { BackgroundColor, ForegroundColor, LoggerProgress } from "./logger";
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 {
progress?: LoggerProgress;
session_id?: boolean | number;
}
Example usage
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 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", requestData, { disk_write: ["/path/workspace/output/**"] });
await instance.start();
NOTE: FileManager is a sub-class of Host and Module. Their loadSettings
will be called as well which uses a combined Settings object.
References
- https://www.unpkg.com/@e-mc/[email protected]/lib/squared.d.ts
- https://www.unpkg.com/@e-mc/[email protected]/lib/asset.d.ts
- https://www.unpkg.com/@e-mc/[email protected]/lib/core.d.ts
- https://www.unpkg.com/@e-mc/[email protected]/lib/filemanager.d.ts
- https://www.unpkg.com/@e-mc/[email protected]/lib/logger.d.ts
- https://www.unpkg.com/@e-mc/[email protected]/lib/module.d.ts
- https://www.unpkg.com/@e-mc/[email protected]/lib/node.d.ts
- https://www.unpkg.com/@e-mc/[email protected]/lib/request.d.ts
- https://www.unpkg.com/@e-mc/[email protected]/lib/settings.d.ts
- https://www.npmjs.com/package/@types/node
LICENSE
BSD 3-Clause