@e-mc/types 0.11.16 → 0.11.17

package/README.md

@@ -9,7 +9,7 @@
 
 ## Interface
 
-* [View Source](https://www.unpkg.com/@e-mc/types@0.11.16/index.d.ts)
+* [View Source](https://www.unpkg.com/@e-mc/types@0.11.17/index.d.ts)
 
 ```typescript
 import type { LogArguments } from "./lib/logger";
@@ -198,10 +198,10 @@ const IMPORT_MAP: Record<string, string | undefined>;
 
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.11.16/index.d.ts
-- https://www.unpkg.com/@e-mc/types@0.11.16/lib/logger.d.ts
-- https://www.unpkg.com/@e-mc/types@0.11.16/lib/module.d.ts
-- https://www.unpkg.com/@e-mc/types@0.11.16/lib/node.d.ts
+- https://www.unpkg.com/@e-mc/types@0.11.17/index.d.ts
+- https://www.unpkg.com/@e-mc/types@0.11.17/lib/logger.d.ts
+- https://www.unpkg.com/@e-mc/types@0.11.17/lib/module.d.ts
+- https://www.unpkg.com/@e-mc/types@0.11.17/lib/node.d.ts
 
 * https://developer.mozilla.org/en-US/docs/Web/API/DOMException
 * https://www.npmjs.com/package/@types/bytes

package/constant.d.ts

@@ -1,5 +1,5 @@
 export const enum INTERNAL {
-    VERSION = '0.11.16',
+    VERSION = '0.11.17',
     TEMP_DIR = 'tmp',
     CJS = '__cjs__'
 }

package/index.d.ts

@@ -330,8 +330,10 @@ declare namespace types {
     function incrementUUID(restart?: boolean): string;
     function validateUUID(value: unknown): boolean;
     function randomString(format: string, dictionary?: string): string;
-    function errorValue(value: string, hint?: string): Error;
-    function errorMessage(title: number | string, value: string, hint?: string): Error;
+    function errorValue(value: string, cause: unknown): Error;
+    function errorValue(value: string, hint?: string, cause?: unknown): Error;
+    function errorMessage(title: number | string, value: string, cause: unknown): Error;
+    function errorMessage(title: number | string, value: string, hint?: string, cause?: unknown): Error;
     function supported(major: number, minor: number, lts: boolean): boolean;
     function supported(major: number, minor?: number, patch?: number, lts?: boolean): boolean;
     function importESM<T = unknown>(name: string, isDefault?: boolean, fromPath?: boolean): Promise<T>;

package/index.js

@@ -1040,11 +1040,19 @@ function randomString(format, dictionary) {
 function validateUUID(value) {
     return typeof value === 'string' && value.length === 36 && REGEXP_UUID.test(value);
 }
-function errorValue(value, hint) {
-    return new Error(value + (hint ? ` (${hint})` : ''));
+function errorValue(value, hint, cause) {
+    if (!cause && isObject(hint)) {
+        cause = hint;
+        hint = undefined;
+    }
+    return new Error(value + (hint ? ` (${hint})` : ''), cause ? { cause } : undefined);
 }
-function errorMessage(title, value, hint) {
-    return new Error((isString(title) || typeof title === 'number' ? title + ': ' : '') + value + (hint ? ` (${hint})` : ''));
+function errorMessage(title, value, hint, cause) {
+    if (!cause && isObject(hint)) {
+        cause = hint;
+        hint = undefined;
+    }
+    return new Error((isString(title) || typeof title === 'number' ? title + ': ' : '') + value + (hint ? ` (${hint})` : ''), cause ? { cause } : undefined);
 }
 function purgeMemory(percent) {
     CACHE_COERCED = new WeakSet();

package/lib/compat-v4.d.ts

@@ -0,0 +1,121 @@
+import type { CloudConstructor, FileManagerConstructor, ICloud, IFileManager, IHost, IModule, ModuleConstructor, WatchConstructor } from './index';
+
+import type { CloneObjectOptions } from '../index.d';
+import type { ExternalAsset } from './asset';
+import type { CacheOptions } from './core';
+import type { QueryResult } from './db';
+import type { ITransformSeries, OutV3, TransformSeriesConstructor } from './document';
+import type { IHttpMemoryCache } from './filemanager';
+import type { HttpAgentSettings, HttpProtocolVersion, HttpRequestClient, InternetProtocolVersion } from './http';
+import type { ParseFunctionOptions } from './module';
+import type { LogFailOptions, LogType, LogValue } from './logger';
+import type { HostConfig, OpenOptions, ProxySettings } from './request';
+import type { DbCoerceSettings, DnsLookupSettings, HttpMemorySettings, HttpSettings } from './settings';
+
+import type { OutgoingHttpHeaders } from 'http';
+import type { LookupFunction } from 'net';
+import type { Readable, Writable } from 'stream';
+
+type CpuUsage = NodeJS.CpuUsage;
+
+export interface GetFunctionsOptions extends ParseFunctionOptions {
+    outFailed?: string[];
+}
+
+export interface IModuleLibV4 {
+    isString(value: unknown): value is string;
+    isObject<T = object>(value: unknown): value is T;
+    isPlainObject<T = PlainObject>(value: unknown): value is T;
+    escapePattern(value: unknown, lookBehind?: boolean): string;
+    generateUUID(format?: string, dictionary?: string): string;
+    validateUUID(value: unknown): boolean;
+    cloneObject<T, U = unknown>(data: T, options?: boolean | WeakSet<object> | CloneObjectOptions<U>): T;
+    coerceObject<T = unknown>(data: T, parseString?: FunctionType<unknown, string> | boolean, cache?: boolean): T;
+    asFunction<T = unknown, U = FunctionType<Promise<T> | T>>(value: unknown, sync?: boolean): Null<U>;
+    isFileHTTP(value: string | URL): boolean;
+    isFileUNC(value: string | URL): boolean;
+    isPathUNC(value: string | URL): boolean;
+    toTimeMs(hrtime: HighResolutionTime, format?: boolean): number | string;
+    renameExt(value: string, ext: string, when?: string): string;
+    existsSafe(value: string, isFile?: boolean): boolean;
+    readFileSafe(value: string, encoding: BufferEncoding | "buffer", cache?: boolean): Null<Bufferable>;
+    getFunctions<T extends FunctionType>(values: unknown[], absolute?: boolean | GetFunctionsOptions, sync?: boolean, outFailed?: string[]): T[];
+    formatSize(value: number | string, options?: PlainObject): number | string;
+    hasSameStat(src: string, dest: string, keepEmpty?: boolean): boolean;
+    hasSize(value: string, keepEmpty?: boolean): boolean;
+    getSize(value: string, diskUsed?: boolean): number;
+    byteLength(value: Bufferable, encoding?: BufferEncoding): number;
+    cleanupStream(target: Readable | Writable, pathname?: string): void;
+    allSettled<U>(values: readonly (U | PromiseLike<U>)[], rejected?: LogValue, options?: LogFailOptions | LogType): Promise<PromiseSettledResult<U>[]>;
+}
+
+export interface IModuleCompatV4<T extends IHost = IHost> extends IModule<T> {
+    set startCPU(value);
+    get startCPU(): Null<CpuUsage>;
+}
+
+export interface ModuleCompatV4Constructor extends ModuleConstructor, IModuleLibV4 {
+    readonly prototype: IModuleCompatV4;
+    new(...args: unknown[]): IModuleCompatV4;
+}
+
+export interface IFileManagerCompatV4<T extends ExternalAsset = ExternalAsset> extends IFileManager<T> {
+    archiving: boolean;
+    cacheHttpRequest: boolean | FirstOf<string>;
+    cacheHttpRequestBuffer: IHttpMemoryCache<T>;
+    fetchTimeout: number;
+    httpProxy: Null<ProxySettings>;
+    acceptEncoding: boolean;
+    keepAliveTimeout: number;
+    addDns(hostname: string, address: string, family?: number | string): void;
+    lookupDns(hostname: string): LookupFunction;
+    getHttpProxy(uri: string, localhost?: boolean): Null<ProxySettings>;
+    getHttpHeaders(uri: string): Undef<OutgoingHttpHeaders>;
+    createHttpRequest(uri: string | URL, options?: OpenOptions): HostConfig;
+    getHttpClient(uri: string | URL, options: OpenOptions): HttpRequestClient;
+    set httpVersion(value);
+    get httpVersion(): Null<HttpProtocolVersion>;
+    set ipVersion(value);
+    get ipVersion(): InternetProtocolVersion;
+}
+
+export interface FileManagerCompatV4Constructor<T extends ExternalAsset = ExternalAsset> extends FileManagerConstructor<T> {
+    fromHttpStatusCode(value: number | string): string;
+    resetHttpHost(version?: HttpProtocolVersion): void;
+    defineHttpBuffer(options: HttpMemorySettings): void;
+    defineHttpSettings(options: HttpSettings): void;
+    defineHttpAgent(options: HttpAgentSettings): void;
+    defineDnsLookup(options: DnsLookupSettings, clear?: boolean): void;
+    clearDnsLookup(): void;
+    getAria2Path(): string;
+    clearHttpBuffer(percent?: number, limit?: number): void;
+    readonly prototype: IFileManagerCompatV4<T>;
+    new(...args: unknown[]): IFileManagerCompatV4<T>;
+}
+
+export interface ICloudCompatV4<T extends IHost = IHost> extends ICloud<T> {
+    getDatabaseResult(service: string, credential: unknown, queryString: string, options?: CacheOptions | boolean | string): Undef<QueryResult>;
+    setDatabaseResult(service: string, credential: unknown, queryString: string, result: unknown, options?: CacheOptions | string): QueryResult;
+    hasDatabaseCache(service: string, sessionKey?: string): boolean;
+    hasDatabaseCoerce(service: string, component: keyof DbCoerceSettings, credential?: unknown): boolean;
+}
+
+export interface CloudCompatV4Constructor extends CloudConstructor {
+    readonly prototype: ICloudCompatV4;
+    new(...args: unknown[]): ICloudCompatV4;
+}
+
+export interface WatchCompatV4Constructor<T extends IFileManager<U>, U extends ExternalAsset = ExternalAsset> extends WatchConstructor<T, U> {
+    readCACert(value: string, cache?: boolean): string;
+    readTLSKey(value: string, cache?: boolean): string;
+    readTLSCert(value: string, cache?: boolean): string;
+    isCert(value: string): boolean;
+    parseExpires(value: number | string, start?: number): number;
+}
+
+export interface ITransformSeriesCompatV4<T = AnyObject, U = T> extends ITransformSeries<T, U>, PropertyAction<OutV3, "out"> {}
+
+export interface TransformSeriesCompatV4Constructor extends TransformSeriesConstructor {
+    readonly prototype: ITransformSeriesCompatV4;
+    new(...args: unknown[]): ITransformSeriesCompatV4;
+}

package/lib/index.d.ts

@@ -5,7 +5,7 @@ import type { DataSource, DbDataSource, IncrementalMatch, LogStatus, TaskAction,
 import type { ExternalAsset, FileCommand, FileData, IFileThread, OutputFinalize } from './asset';
 import type { BucketWebsiteOptions, CloudDatabase, CloudFeatures, CloudFunctions, CloudService, CloudStorage, CloudStorageDownload, CloudStorageUpload, DeleteObjectsOptions, UploadAssetOptions } from './cloud';
 import type { BufferResult, CompressFormat, CompressLevel, ReadableOptions, TryFileCompressor } from './compress';
-import type { ClientDbConstructor, HostInitConfig, IAbortComponent, IClient, IClientDb, IPermission, JoinQueueOptions, PermissionReadWrite, ResumeThreadOptions, ThreadCountStat } from './core';
+import type { ClientConstructor, ClientDbConstructor, HostInitConfig, IAbortComponent, IClient, IClientDb, IPermission, JoinQueueOptions, PermissionReadWrite, ResumeThreadOptions, ThreadCountStat } from './core';
 import type { BatchQueryResult, DB_TYPE, ErrorQueryCallback, ExecuteBatchQueryOptions, ExecuteQueryOptions, HandleFailOptions, ProcessRowsOptions, QueryResult, SQL_COMMAND } from './db';
 import type { AsSourceFileOptions, ConfigOrTransformer, CustomizeOptions as CustomizeDocument, GenerateLintTableOptions, LintMessage, PluginConfig, SourceCode, SourceInput, SourceMap, SourceMapOptions, TransformAction, TransformCallback, TransformOutput, TransformResult, UpdateGradleOptions } from './document';
 import type { AssetContentOptions, ChecksumOptions, DeleteFileAddendum, FileOutput, FinalizeResult, FindAssetOptions, IHttpDiskCache, IHttpMemoryCache, ImageMimeMap, InstallData, PostFinalizeCallback, ReplaceOptions } from './filemanager';
@@ -106,7 +106,7 @@ declare namespace functions {
         get host(): T | null;
     }
 
-    interface ImageConstructor<T extends IHost = IHost, U extends ImageModule = ImageModule> extends ModuleConstructor {
+    interface ImageConstructor<T extends IHost = IHost, U extends ImageModule = ImageModule> extends ClientConstructor {
         /** @deprecated */
         readonly REGEXP_SIZERANGE: RegExp;
         transform<V extends TransformOptions>(file: string, command: string, options?: V): Promise<V extends { tempFile: true } ? string : Buffer | null>;
@@ -129,7 +129,7 @@ declare namespace functions {
         get host(): T | null;
     }
 
-    interface TaskConstructor<T extends IHost = IHost, U extends TaskModule = TaskModule> extends ModuleConstructor {
+    interface TaskConstructor<T extends IHost = IHost, U extends TaskModule = TaskModule> extends ClientConstructor {
         finalize<V extends ExternalAsset>(this: T, instance: ITask<T, U>, assets: V[]): Promise<unknown>;
         readonly prototype: ITask<T, U>;
         new(module?: U, ...args: unknown[]): ITask<T, U>;
@@ -265,7 +265,7 @@ declare namespace functions {
         get host(): T | null;
     }
 
-    interface DocumentConstructor<T extends IFileManager<U>, U extends ExternalAsset = ExternalAsset, V extends ClientModule = DocumentModule, W extends DocumentComponent = DocumentComponent, X extends DocumentComponentOption = DocumentComponentOption, Y extends ICloud = ICloud<T>> extends ModuleConstructor {
+    interface DocumentConstructor<T extends IFileManager<U>, U extends ExternalAsset = ExternalAsset, V extends ClientModule = DocumentModule, W extends DocumentComponent = DocumentComponent, X extends DocumentComponentOption = DocumentComponentOption, Y extends ICloud = ICloud<T>> extends ClientConstructor {
         finalize(this: T, instance: IDocument<T, U, V, W, X, Y>): Promise<unknown>;
         createSourceMap(code: string, remove: boolean): SourceMap;
         createSourceMap(code: string, uri?: string, remove?: boolean): SourceMap;
@@ -303,7 +303,7 @@ declare namespace functions {
         get host(): T | null;
     }
 
-    interface WatchConstructor<T extends IFileManager<U>, U extends ExternalAsset = ExternalAsset, V extends WatchModule = WatchModule, W extends FunctionType<unknown, any> = ModifiedPostFinalizeListener<U>> extends ModuleConstructor {
+    interface WatchConstructor<T extends IFileManager<U>, U extends ExternalAsset = ExternalAsset, V extends WatchModule = WatchModule, W extends FunctionType<unknown, any> = ModifiedPostFinalizeListener<U>> extends ClientConstructor {
         createServer(port: number, active: boolean): ws.Server | null;
         createServer(port: number, secure?: SecureOptions | null, active?: boolean): ws.Server | null;
         shutdown(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/types",
-  "version": "0.11.16",
+  "version": "0.11.17",
   "description": "Type definitions for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",

package/lib/dom.d.ts

@@ -1,9 +0,0 @@
-interface EventListenerOptions {
-    capture?: boolean;
-}
-
-export interface AddEventListenerOptions extends EventListenerOptions {
-    once?: boolean;
-    passive?: boolean;
-    signal?: AbortSignal;
-}