@e-mc/types 0.11.8 → 0.12.0

package/lib/request.d.ts

@@ -1,6 +1,8 @@
+import type { EncodingAction } from './squared';
+
 import type { IRequest } from './index';
 import type { BinaryAction } from './asset';
-import type { HttpProtocolVersion, HttpRequestClient, InternetProtocolVersion } from './http';
+import type { HeadersAction, HttpProtocolVersion, HttpRequestClient, InternetProtocolVersion } from './http';
 import type { IncludeAction } from './module';
 import type { HttpHostSettings, RequestModule } from './settings';
 
@@ -16,6 +18,11 @@ interface SilentAction {
     silent?: boolean;
 }
 
+interface CopyAction extends HeadersAction {
+    pathname?: string;
+    signal?: AbortSignal;
+}
+
 interface ProtocolAction {
     httpVersion?: HttpProtocolVersion;
     ipVersion?: InternetProtocolVersion;
@@ -117,7 +124,7 @@ export interface HttpAdapterConstructor<T extends OpenOptions = OpenOptions> {
     new(instance: IRequest, state: ControllerState, uri: string | URL, options: T): IHttpAdapter<T>;
 }
 
-export interface OpenOptions extends KeepAliveAction, SilentAction {
+export interface OpenOptions extends KeepAliveAction, SilentAction, EncodingAction {
     host?: IHttpHost;
     url?: URL;
     base?: boolean;
@@ -128,7 +135,6 @@ export interface OpenOptions extends KeepAliveAction, SilentAction {
     followRedirect?: boolean;
     expectContinue?: boolean;
     expectTimeout?: number;
-    encoding?: BufferEncoding;
     maxBufferSize?: number | string;
     format?: BufferFormat | { out?: BufferFormat; parser?: PlainObject };
     headers?: OutgoingHttpHeaders | Headers;
@@ -163,10 +169,11 @@ export interface FormDataPart {
     filename?: string;
 }
 
-export interface Aria2Options extends BinaryAction, SilentAction {
-    pathname?: string;
-    headers?: OutgoingHttpHeaders | Headers;
-    signal?: AbortSignal;
+export interface Aria2Options extends BinaryAction, SilentAction, CopyAction {}
+
+export interface RcloneOptions extends Aria2Options {
+    command?: "copy" | "copyto" | "copyurl";
+    update?: boolean;
 }
 
 export interface HostConfig extends OpenOptions {

package/lib/settings.d.ts

@@ -12,6 +12,7 @@ import type { SpawnOptions } from 'node:child_process';
 import type { BinaryLike, CipherGCMTypes } from 'node:crypto';
 import type { LookupAddress } from 'node:dns';
 import type { BrotliOptions, ZlibOptions } from 'node:zlib';
+// @ts-ignore
 import type { BackgroundColor as IBackgroundColor } from 'chalk';
 // @ts-ignore
 import type { Unit } from 'bytes';
@@ -22,13 +23,13 @@ import type { Options as ZopfliOptions } from 'node-zopfli';
 // @ts-ignore
 import type { PicomatchOptions } from 'picomatch';
 
-interface MinMax<T = number> {
-    min?: T;
-    max?: T;
+export interface DownloadAction {
+    bin?: string | false;
+    exec?: ExecAction;
 }
 
-export interface HandlerModule<T = PlainObject> extends HandlerSettings<T> {
-    handler?: string;
+export interface HandlerModule<T = PlainObject, U = string> extends HandlerSettings<T> {
+    handler?: U;
     extensions?: string[];
 }
 
@@ -75,6 +76,13 @@ export interface ProcessModule<T = PlainObject> extends HandlerSettings<T> {
             expires?: number | string;
             priority: { bypass?: number | string } & MinMax<number | string>;
         };
+        worker?: {
+            users?: boolean | string[];
+            max?: number | string;
+            max_expires?: number | string;
+            locked?: boolean;
+            channel?: MinMax<number | string> & { expires?: number | string; verbose?: boolean };
+        };
         limit?: number | string;
         sub_limit?: number | string;
         expires?: number | string;
@@ -107,9 +115,7 @@ export interface PermissionSettings extends PlainObject {
 
 export interface DownloadModule<T = PlainObject> extends HandlerSettings<T> {
     expires?: number | string;
-    aria2?: {
-        bin?: string | false;
-        exec?: ExecAction;
+    aria2?: DownloadAction & {
         check_integrity?: boolean;
         update_status?: number | string | { interval?: number | string; broadcast_only?: boolean };
         max_concurrent_downloads?: number | string;
@@ -122,8 +128,52 @@ export interface DownloadModule<T = PlainObject> extends HandlerSettings<T> {
         lowest_speed_limit?: number | string;
         always_resume?: boolean;
         file_allocation?: "none" | "prealloc" | "trunc" | "falloc";
+        proxy?: {
+            http: string;
+            https: string;
+            ftp: string;
+            all: string;
+        } | false;
+        no_proxy?: string;
         conf_path?: string;
     };
+    rclone?: DownloadAction & {
+        /* Copy */
+        check_first?: boolean;
+        checksum?: boolean;
+        cutoff_mode?: "HARD" | "SOFT" | "CAUTIOUS";
+        ignore_case_sync?: boolean;
+        ignore_checksum?: boolean;
+        ignore_existing?: boolean;
+        ignore_size?: boolean;
+        ignore_times?: boolean;
+        immutable?: boolean;
+        inplace?: boolean;
+        max_backlog?: number;
+        max_duration?: string;
+        max_transfer?: string;
+        metadata?: boolean;
+        modify_window?: string;
+        multi_thread_chunk_size?: string;
+        multi_thread_cutoff?: string;
+        multi_thread_streams?: number;
+        multi_thread_write_buffer_size?: string;
+        no_check_dest?: boolean;
+        no_traverse?: boolean;
+        no_update_dir_modtime?: boolean;
+        refresh_times?: boolean;
+        size_only?: boolean;
+        update?: boolean;
+        /* Listing */
+        fast_list?: boolean;
+        /* Networking */
+        bind?: string;
+        contimeout?: string;
+        disable_http2?: boolean;
+        timeout?: string;
+        /* Config */
+        config?: string;
+    };
 }
 
 export interface DocumentModule<T = DocumentSettings, U = DbSettings> extends ClientModule<T> {
@@ -333,11 +383,13 @@ export interface CloudAuthSettings {
     database?: boolean;
 }
 
-export interface ErrorModule<T = ErrorSettings> extends HandlerModule<T> {
+export interface ErrorModule<T = ErrorSettings> extends HandlerModule<T, ErrorOutMethod> {
     out?: string | ErrorOutMethod;
     abort?: string[];
     fatal?: boolean;
+    /** @deprecated retry_limit */
     recursion_limit?: number | string;
+    retry_limit?: number | string;
 }
 
 export interface ErrorSettings extends PlainObject {
@@ -353,7 +405,7 @@ export interface LoggerProgress extends LoggerFormatColor {
     raw_mode?: boolean;
 }
 
-export interface LoggerModule<T = number | string, U = boolean | T, V = LoggerFormat<T>> {
+export interface LoggerModule<T = number | string, U = boolean | T, V = LoggerFormat<T>, W = boolean | LoggerProcessSettings> {
     enabled?: boolean;
     level?: number | string;
     production?: string[];
@@ -371,7 +423,7 @@ export interface LoggerModule<T = number | string, U = boolean | T, V = LoggerFo
     unknown?: boolean | LoggerColor;
     system?: boolean | LoggerColor;
     node?: boolean | LoggerColor;
-    process?: boolean | LoggerProcessSettings;
+    process?: W;
     image?: boolean | LoggerColor;
     compress?: boolean | LoggerColor;
     watch?: boolean | LoggerColor;
@@ -402,6 +454,7 @@ export interface LoggerMeterSettings<T = number | string> {
 }
 
 export interface LoggerProcessSettings extends LoggerColor {
+    enabled?: boolean;
     cpu?: boolean;
     cpu_bar?: boolean | number | number[];
     cpu_bar_color?: [typeof IBackgroundColor, typeof IBackgroundColor, typeof IBackgroundColor];
@@ -487,6 +540,7 @@ export interface PoolConfig<T = number> extends MinMax {
     queue_idle?: T;
     purge?: T;
     timeout?: number;
+    server_timeout?: number;
     socket_timeout?: number;
 }
 
@@ -501,6 +555,11 @@ export interface ServerInfo<T = number | string> extends ServerPort<T> {
     secure?: SecureConfig & ServerPort<T>;
 }
 
+export interface MinMax<T = number> {
+    min?: T;
+    max?: T;
+}
+
 export type WatchUserSettings = ObjectMap<WatchInterval>;
 export type DocumentTransform = boolean | "etag" | HashAlgorithm | HashConfig | null;
 

package/lib/squared.d.ts

@@ -83,6 +83,10 @@ export interface WatchAction {
     watch?: WatchValue;
 }
 
+export interface WorkerAction {
+    worker?: boolean | number;
+}
+
 export interface BundleAction<T = unknown> {
     bundleId?: number | string;
     bundleIndex?: number;
@@ -97,9 +101,12 @@ export interface ChecksumAction {
     checksumOutput?: ChecksumValue;
 }
 
-export interface DocumentAction {
+export interface EncodingAction<T = BufferEncoding> {
+    encoding?: T;
+}
+
+export interface DocumentAction<T = BufferEncoding> extends EncodingAction<T> {
     document?: string | string[];
-    encoding?: BufferEncoding;
 }
 
 export interface AttributeAction<T = AttributeMap> {
@@ -197,29 +204,30 @@ export interface LocationUri {
     filename: string;
 }
 
-export interface ViewEngine {
+export interface ViewEngine<T = unknown, U = PlainObject> {
     name?: string;
     singleRow?: boolean;
     outputEmpty?: boolean;
     expires?: number | string;
     options?: {
-        compile?: PlainObject;
-        output?: PlainObject;
+        compile?: T;
+        output?: U;
     };
 }
 
-export interface CompressLevel extends MimeTypeAction {
+export interface CompressLevel {
     algorithm?: string;
     level?: number;
     chunkSize?: number;
 }
 
-export interface CompressFormat extends CompressLevel {
+export interface CompressFormat extends CompressLevel, MimeTypeAction, WorkerAction {
     format?: string;
     condition?: string;
     plugin?: string;
     timeout?: number;
     options?: PlainObject;
+    metadata?: PlainObject & MimeTypeAction;
 }
 
 export interface WatchInterval<T = FileAsset> extends TaskBase {
@@ -227,6 +235,7 @@ export interface WatchInterval<T = FileAsset> extends TaskBase {
     main?: boolean;
     reload?: WatchReload;
     assets?: T[];
+    recursive?: boolean | string | string[];
 }
 
 export interface WatchReload extends WebSocketClient {
@@ -321,7 +330,9 @@ export interface RequestObserve extends WebSocketClient {
 
 export interface ChecksumBase<T = BinaryToTextEncoding> {
     algorithm?: string;
+    /** @deprecated digestEncoding */
     digest?: T;
+    digestEncoding?: T;
 }
 
 export interface ChecksumOutput<T = BinaryToTextEncoding> extends ChecksumBase<T> {

package/lib/type.d.ts

@@ -1,7 +1,3 @@
-/** @deprecated */
-type Undef<T> = T | undefined;
-/** @deprecated */
-type Null<T> = T | null;
 type Void<T> = T | void;
 type Optional<T> = T | null | undefined;
 type Nullable<T> = { [P in keyof T]: T[P] | null; };
@@ -15,12 +11,8 @@ type ConstructorDerived<T> = Pick<T, { [K in keyof T]: T[K] extends new() => any
 type FunctionType<T = unknown, U = unknown> = (...args: U[]) => T;
 type FunctionArgs<T extends unknown[], U = unknown> = (...args: T) => U;
 
-/** @deprecated */
-type NumString = number | string;
 type IntBool = boolean | 0 | 1;
 type ArrayOf<T> = T | T[];
-/** @deprecated */
-type TupleOf<T> = [T, T];
 type FirstOf<T, U = boolean> = T extends U ? [T, ...T[]] : T[] | [U, T, ...T[]];
 type Bufferable = string | Buffer;
 

package/lib/watch.d.ts

@@ -41,6 +41,7 @@ export interface IFileGroup<T extends ExternalAsset = ExternalAsset> extends IAb
     find(socketId: string): ISocketRequest | undefined;
     pause(): void;
     resume(): void;
+    matchRecursive(value: string): boolean;
     get server(): ws.Server | null;
     set related(value);
     get related(): T[];
@@ -54,6 +55,7 @@ export interface IFileGroup<T extends ExternalAsset = ExternalAsset> extends IAb
     get expired(): boolean;
     get paused(): boolean;
     get abortable(): boolean;
+    get recursive(): boolean | undefined;
 }
 
 export interface FileGroupConstructor<T extends ExternalAsset = ExternalAsset> {
@@ -62,8 +64,8 @@ export interface FileGroupConstructor<T extends ExternalAsset = ExternalAsset> {
     checkTimeout(client: ws.WebSocket): boolean;
     cloneAsset(asset: T): T;
     readonly prototype: IFileGroup<T>;
-    new(uri: string, assets: T[], abortable: boolean): IFileGroup<T>;
-    new(uri: string, assets: T[], startTime?: number, abortable?: boolean): IFileGroup<T>;
+    new(uri: string, assets: T[], abortable: boolean, recursive?: boolean | string | string[]): IFileGroup<T>;
+    new(uri: string, assets: T[], startTime?: number, abortable?: boolean, recursive?: boolean | string | string[]): IFileGroup<T>;
 }
 
 export interface WatchInitResult<T = ExternalAsset> {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/types",
-  "version": "0.11.8",
+  "version": "0.12.0",
   "description": "Type definitions for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -24,6 +24,6 @@
     "chalk": "4.1.2"
   },
   "devDependencies": {
-    "typescript": "5.7.3"
+    "typescript": "5.8.3"
   }
 }