@e-mc/types 0.12.14 → 0.12.16

package/README.md

@@ -9,7 +9,7 @@
 
 ## Interface
 
-* [View Source](https://www.unpkg.com/@e-mc/types@0.12.14/index.d.ts)
+* [View Source](https://www.unpkg.com/@e-mc/types@0.12.16/index.d.ts)
 
 ```typescript
 import type { LogArguments } from "./lib/logger";
@@ -77,6 +77,7 @@ function supported(major: number, minor: number, lts: boolean): boolean;
 function supported(major: number, minor?: number, patch?: number, lts?: boolean): boolean;
 function importESM(name: string | URL, isDefault: boolean, fromPath?: boolean): Promise<unknown>;
 function importESM(name: string | URL, options?: ImportAttributes, fromPath?: boolean): Promise<unknown>;
+function requireESM(name: string, url?: string | URL, expect?: string): unknown;
 function purgeMemory(percent?: number): number;
 
 interface LOG_TYPE {
@@ -204,10 +205,10 @@ const IMPORT_MAP: Record<string, string | undefined>;
 
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.12.14/index.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.14/lib/logger.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.14/lib/module.d.ts
-- https://www.unpkg.com/@e-mc/types@0.12.14/lib/node.d.ts
+- https://www.unpkg.com/@e-mc/types@0.12.16/index.d.ts
+- https://www.unpkg.com/@e-mc/types@0.12.16/lib/logger.d.ts
+- https://www.unpkg.com/@e-mc/types@0.12.16/lib/module.d.ts
+- https://www.unpkg.com/@e-mc/types@0.12.16/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.12.14',
+    VERSION = '0.12.16',
     TEMP_DIR = 'tmp',
     CJS = '__cjs__'
 }

package/index.d.ts

@@ -340,12 +340,15 @@ declare namespace types {
     function sanitizeCmd(value: string, ...args: unknown[]): string;
     function sanitizeArgs(value: string, doubleQuote?: boolean): string;
     function sanitizeArgs(values: string[], doubleQuote?: boolean): 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 | URL, isDefault: boolean, fromPath?: boolean): Promise<T>;
     function importESM<T = unknown>(name: string | URL, options?: ImportAttributes, fromPath?: boolean): Promise<T>;
+    function requireESM<T = unknown>(name: string, url?: string | URL, expect?: string): T;
     function purgeMemory(percent?: number): number;
 }
 

package/index.js

@@ -47,15 +47,18 @@ exports.incrementUUID = incrementUUID;
 exports.hashKey = hashKey;
 exports.supported = supported;
 exports.importESM = importESM;
+exports.requireESM = requireESM;
 const path = require("node:path");
 const fs = require("node:fs");
 const crypto = require("node:crypto");
 const bytes = require("bytes");
+const node_module_1 = require("node:module");
 const node_os_1 = require("node:os");
 const node_url_1 = require("node:url");
 const PATTERN_CHARS = {
     '&': '\\x26',
     '!': '\\x21',
+    '"': '\\x22',
     '#': '\\x23',
     '%': '\\x25',
     ',': '\\x2c',
@@ -101,6 +104,7 @@ let CACHE_COERCED = new WeakSet();
 let LOG_CURRENT = null;
 let SUPPORTED_HASHSINGLE = false;
 let SUPPORTED_IMPORTATTRIBUTES = false;
+let SUPPORTED_REGEXPESCAPE = false;
 let TEMP_DIR = path.join(process.cwd(), "tmp");
 let INCREMENT_COUNT = 65536;
 let INCREMENT_PREFIX = '';
@@ -739,6 +743,9 @@ function hasGlob(value) {
 function escapePattern(value, symbols) {
     switch (typeof value) {
         case 'string': {
+            if (symbols && SUPPORTED_REGEXPESCAPE) {
+                return RegExp.escape(value);
+            }
             let result = '', j = 0;
             for (let i = 0, length = value.length, ch; i < length; ++i) {
                 switch (ch = value[i]) {
@@ -1029,18 +1036,18 @@ function asFunction(value, sync = true) {
 }
 function getEncoding(value, fallback) {
     if (typeof value === 'string') {
-        switch (value = value.trim().toLowerCase()) {
-            case 'utf8':
-            case 'utf-8':
-                return 'utf8';
-            case 'utf16le':
-            case 'utf-16le':
-            case 'utf16':
-            case 'utf-16':
-                return 'utf16le';
+        const result = value.trim().toLowerCase();
+        if (result.slice(0, 3) === 'utf') {
+            switch (result.slice(result[3] === '-' ? 4 : 3)) {
+                case '8':
+                    return 'utf8';
+                case '16le':
+                case '16':
+                    return 'utf16le';
+            }
         }
-        if (Buffer.isEncoding(value)) {
-            return value;
+        else if (Buffer.isEncoding(result)) {
+            return result;
         }
     }
     return fallback || 'utf8';
@@ -1169,11 +1176,19 @@ function sanitizeArgs(values, doubleQuote) {
     }
     return (typeof values === 'string' ? result[0] : result);
 }
-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();
@@ -1238,5 +1253,10 @@ async function importESM(name, isDefault, fromPath) {
     }
     return result;
 }
+function requireESM(name, url, expect) {
+    const result = url ? (0, node_module_1.createRequire)(url)(name) : require(name);
+    return process.features.require_module && isObject(result) && result.__esModule && 'default' in result && (!expect || typeof result.default === expect) ? result.default : result;
+}
 SUPPORTED_HASHSINGLE = supported(20, 12, true) || supported(21, 7);
-SUPPORTED_IMPORTATTRIBUTES = supported(18, 20, 5, true) || supported(20, 18, 3, true) || supported(22, 12, true) || supported(23, 1);
+SUPPORTED_IMPORTATTRIBUTES = supported(18, 20, true) || supported(20, 10);
+SUPPORTED_REGEXPESCAPE = supported(24);

package/lib/asset.d.ts

@@ -36,6 +36,7 @@ export interface IFileThread<T extends ExternalAsset = ExternalAsset> extends IA
     getObject<U extends FileCommand<T>>(data?: PlainObject): U;
     get host(): IFileManager<T>;
     get queuedTasks(): FunctionType<void>[];
+    get localUri(): string | undefined;
 }
 
 export interface FileThreadConstructor<T extends ExternalAsset = ExternalAsset> {

package/lib/cloud.d.ts

@@ -61,6 +61,7 @@ export interface CloudStorageUpload<T = unknown, U = string, V = unknown, W = st
     tags?: Record<string, string> | false;
     options?: T;
     fileGroup?: UploadContent[];
+    descendantsGroup?: string[];
     localStorage?: boolean;
     endpoint?: string;
     all?: boolean;

package/lib/core.d.ts

@@ -70,9 +70,10 @@ export interface ClientDbConstructor<T extends IHost = IHost, U extends ClientMo
     convertTime(value: number | string): number;
     findResult(source: string, credential: unknown, queryString: string, timeout: number, sessionKey?: string | boolean, renewCache?: boolean): QueryResult | undefined;
     storeResult(source: string, credential: unknown, queryString: string, result: QueryResult, options: StoreResultOptions): QueryResult;
+    /** @deprecated */
     storeResult(source: string, credential: unknown, queryString: string, result: QueryResult, sessionKey: string, sessionExpires: number): QueryResult;
     storeResult(source: string, credential: unknown, queryString: string, result: QueryResult, cache: DbCacheValue): QueryResult;
-    storeResult(source: string, credential: unknown, queryString: string, result: QueryResult, cache: DbCacheValue | undefined, options: StoreResultOptions): QueryResult;
+    storeResult(source: string, credential: unknown, queryString: string, result: QueryResult, cache: DbCacheValue | undefined, options: Omit<StoreResultOptions, "cache">): QueryResult;
     purgeResult(prefix?: string): Promise<number>;
     extractUUID(credential: unknown): string;
     setPoolConfig(value: unknown): void;
@@ -83,7 +84,7 @@ export interface ClientDbConstructor<T extends IHost = IHost, U extends ClientMo
 }
 
 export interface IWorkerGroup extends WorkerBase {
-    [Symbol.iterator](): IteratorObject<IWorkerChannel, BuiltinIteratorReturn>;
+    [Symbol.iterator](): IterableIterator<IWorkerChannel>;
     add(name: string, item: IWorkerChannel, priority?: number): this;
     get(name: string, force?: boolean | number): IWorkerChannel | undefined;
     delete(name: string | IWorkerChannel): boolean;
@@ -107,7 +108,7 @@ export interface WorkerGroupConstructor {
 }
 
 export interface IWorkerChannel<T = unknown> extends EventEmitter, Iterable<Worker>, WorkerInfo {
-    [Symbol.iterator](): IteratorObject<Worker, BuiltinIteratorReturn>;
+    [Symbol.iterator](): IterableIterator<Worker>;
     sendObject(data: unknown, transferList?: Transferable[], callback?: WorkerChannelResponse<T>, ...returnArgs: unknown[]): Worker;
     sendBuffer(data: Buffer | SharedArrayBuffer, callback: WorkerChannelResponse<T>, ...returnArgs: unknown[]): Worker | null;
     sendBuffer(data: Buffer | SharedArrayBuffer, shared?: boolean, callback?: WorkerChannelResponse<T>, ...returnArgs: unknown[]): Worker | null;

package/lib/document.d.ts

@@ -4,6 +4,7 @@ import type { IDocument, IFileManager, IModule } from './index';
 import type { ExternalAsset, InitialValue } from './asset';
 import type { CloudStorage } from './cloud';
 import type { LogComponent, LogDate } from './logger';
+import type { DefaultAction } from './module';
 import type { DocumentTransform } from './settings';
 
 export interface DocumentAsset extends ExternalAsset, StorageAction<CloudStorage> {
@@ -189,7 +190,7 @@ export interface CustomizeOptions {
     transform?: DocumentTransform;
 }
 
-export interface AsSourceFileOptions extends EncodingAction {
+export interface AsSourceFileOptions extends EncodingAction, DefaultAction {
     cache?: boolean;
 }
 

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 { BrotliCompressLevel, 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';
@@ -92,7 +92,7 @@ declare namespace functions {
         new(module?: U): ICompress<T, U>;
     }
 
-    interface IImage<T extends IHost = IHost, U extends ImageModule = ImageModule> extends IClient<T, U> {
+    interface IImage<T extends IHost = IHost, U extends ImageModule = ImageModule, V extends ExternalAsset = ExternalAsset> extends IClient<T, U> {
         resizeData?: ResizeData | null;
         cropData?: CropData | null;
         rotateData?: RotateData | null;
@@ -110,13 +110,13 @@ declare namespace functions {
         parseQuality(value: string): QualityData | null;
         parseOpacity(value: string): number;
         parseWorker(command: string | CommandData, outputType?: string): CommandData | null;
-        using?<V extends ExternalAsset>(data: IFileThread<V>, command: string): Promise<unknown>;
+        using?(data: IFileThread<V>, command: string): Promise<unknown>;
         get outputAs(): string;
         set host(value);
         get host(): T | null;
     }
 
-    interface ImageConstructor<T extends IHost = IHost, U extends ImageModule = ImageModule> extends ModuleConstructor, IWorkerConstructor {
+    interface ImageConstructor<T extends IHost = IHost, U extends ImageModule = ImageModule> extends ClientConstructor, IWorkerConstructor {
         readonly MIME_JPEG: string;
         readonly MIME_PNG: string;
         readonly MIME_WEBP: string;
@@ -132,19 +132,19 @@ declare namespace functions {
         new(module?: U, ...args: unknown[]): IImage<T, U>;
     }
 
-    interface ITask<T extends IHost = IHost, U extends TaskModule = TaskModule> extends IClient<T, U> {
-        using?<V extends ExternalAsset>(data: IFileThread<V>): Promise<unknown>;
+    interface ITask<T extends IHost = IHost, U extends TaskModule = TaskModule, V extends ExternalAsset = ExternalAsset> extends IClient<T, U> {
+        using?(data: IFileThread<V>): Promise<unknown>;
         collect?(items: unknown[], preceding?: boolean): Promise<SpawnResult>[];
         map?(tasks: Command[]): Promise<SpawnResult | void>[];
         series?(tasks: Command[]): Promise<unknown>;
         parallel?(tasks: Command[]): Promise<unknown>;
         spawn?(task: PlainObject, callback: (result?: SpawnResult) => void): void;
-        execute?<V extends IFileManager<W>, W extends ExternalAsset>(manager: V, task: PlainObject, callback: (value?: unknown) => void): void;
+        execute?<W extends IFileManager<X>, X extends ExternalAsset>(manager: W, task: PlainObject, callback: (value?: unknown) => void): void;
         set host(value);
         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>;
@@ -280,12 +280,14 @@ 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;
         writeSourceMap(uri: string, data: SourceCode, options?: SourceMapOptions): string | undefined;
+        /** @deprecated */
         updateGradle(source: string, namespaces: string[], value: string, upgrade: boolean): string;
+        /** @deprecated */
         updateGradle(source: string, namespaces: string[], value: string, options?: UpdateGradleOptions): string;
         generateLintTable(messages: LintMessage[], options: GenerateLintTableOptions): LogComponent[];
         cleanup?(this: T, instance: IDocument<T, U, V, W, X, Y>): Promise<unknown>;
@@ -319,7 +321,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;
@@ -354,6 +356,7 @@ declare namespace functions {
         rclone(uri: string | URL, pathname: string | URL): Promise<string[]>;
         rclone(uri: string | URL, options?: RcloneOptions): Promise<string[]>;
         json(uri: string | URL, options?: OpenOptions): Promise<object | null>;
+        blob(uri: string | URL, options?: OpenOptions): Promise<Blob | null>;
         pipe(uri: string | URL, to: Writable, options?: OpenOptions): Promise<null>;
         opts<V extends OpenOptions>(url: string | URL, options?: V): HostConfig & V;
         open(uri: string | URL, options: OpenOptions): HttpRequestClient;
@@ -619,6 +622,7 @@ declare namespace functions {
         getThreadCount(full: true): ThreadCountStat;
         getThreadCount(username: string, iv?: BinaryLike): ThreadCountStat;
         getThreadCount(username?: string | boolean, iv?: BinaryLike): number;
+        parseIp(value: unknown, kind?: "ipv4" | "ipv6"): string;
         getLogDelayed(): FormatMessageArgs[];
         getPermissionFromSettings(freeze?: boolean): IPermission;
         readonly prototype: IHost;
@@ -817,11 +821,17 @@ declare namespace functions {
         readBuffer(value: string | URL, cache?: boolean | ReadBufferOptions): Buffer | null;
         resolveMime(data: FileTypeFormat): Promise<FileTypeResult | undefined>;
         lookupMime(value: string, extension?: boolean): string;
-        initCpuUsage(instance?: IModule): CpuUsage;
-        getCpuUsage(start: CpuUsage, format: true): string;
-        getCpuUsage(start: CpuUsage, format?: boolean): number;
+        /** @deprecated class */
+        initCpuUsage(instance?: IModule, thread?: boolean): CpuUsage;
+        /** @deprecated private */
+        getCpuUsage(start: CpuUsage, format: true, thread?: boolean): string;
+        /** @deprecated private */
+        getCpuUsage(start: CpuUsage, format?: boolean, thread?: boolean): number;
+        /** @deprecated private */
         getMemUsage(format: true | "%" | Unit, free?: boolean): string;
+        /** @deprecated private */
         getMemUsage(format?: boolean, free?: boolean): number;
+        /** @deprecated private */
         formatCpuMem(start: CpuUsage, all?: boolean): string;
         getPackageVersion(name: string | [string, string], options?: PackageVersionOptions): string;
         checkSemVer(name: string | [string, string], options: CheckSemVerOptions): boolean;
@@ -842,4 +852,4 @@ declare namespace functions {
     }
 }
 
-export = functions;
+export = functions;

package/lib/module.d.ts

@@ -16,6 +16,11 @@ export interface RequireAction {
     requireExt?: string | string[] | boolean;
 }
 
+export interface DefaultAction {
+    default?: boolean;
+    url?: string | URL;
+}
+
 export interface ThrowsAction {
     throwsPermission?: boolean;
     throwsDoesNotExist?: boolean;
@@ -41,7 +46,7 @@ export interface FileSystemOptions extends PermissionOptions, ThrowsAction {
     ignorePermission?: boolean;
 }
 
-export interface ReadFileOptions extends FileSystemOptions, StreamBase, RequireAction, EncodingAction {
+export interface ReadFileOptions extends FileSystemOptions, StreamBase, RequireAction, EncodingAction, DefaultAction {
     cache?: boolean;
 }
 
@@ -57,6 +62,7 @@ export interface CopyFileOptions extends FileSystemOptions {
     overwrite?: boolean;
     createDir?: boolean;
     outSrc?: string;
+    mode?: number;
 }
 
 export interface RemoveDirOptions extends FileSystemOptions {
@@ -67,7 +73,7 @@ export interface RemoveDirOptions extends FileSystemOptions {
 export type MoveFileOptions = CopyFileOptions;
 export type CreateDirOptions = FileSystemOptions;
 
-export interface ParseFunctionOptions extends RequireAction {
+export interface ParseFunctionOptions extends RequireAction, DefaultAction {
     absolute?: boolean;
     sync?: boolean;
     external?: boolean;

package/lib/object.d.ts

@@ -34,4 +34,8 @@ interface MinMax<T = number> {
 }
 
 /** @deprecated lib/node **/
-type HighResolutionTime = bigint | [number, number];
+type HighResolutionTime = bigint | [number, number];
+
+interface RegExpConstructor {
+    escape(value: string): string;
+}

package/lib/request.d.ts

@@ -148,6 +148,7 @@ export interface OpenOptions extends KeepAliveAction, SilentAction, EncodingActi
     progressId?: number | string;
     outFormat?: { out: BufferFormat; parser?: PlainObject };
     outFilename?: string | null;
+    outContentType?: string;
     outHeaders?: IncomingHttpHeaders | null;
     outStream?: Writable | null;
     outAbort?: AbortController | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/types",
-  "version": "0.12.14",
+  "version": "0.12.16",
   "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;
-}