@e-mc/types 0.13.5 → 0.13.7

package/README.md

@@ -9,7 +9,7 @@
 
 ## Interface
 
-* [View Source](https://www.unpkg.com/@e-mc/types@0.13.5/index.d.ts)
+* [View Source](https://www.unpkg.com/@e-mc/types@0.13.7/index.d.ts)
 
 ```typescript
 import type { LogArguments } from "./lib/logger";
@@ -208,10 +208,10 @@ const IMPORT_MAP: Record<string, string | undefined>;
 
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.13.5/index.d.ts
-- https://www.unpkg.com/@e-mc/types@0.13.5/lib/logger.d.ts
-- https://www.unpkg.com/@e-mc/types@0.13.5/lib/module.d.ts
-- https://www.unpkg.com/@e-mc/types@0.13.5/lib/node.d.ts
+- https://www.unpkg.com/@e-mc/types@0.13.7/index.d.ts
+- https://www.unpkg.com/@e-mc/types@0.13.7/lib/logger.d.ts
+- https://www.unpkg.com/@e-mc/types@0.13.7/lib/module.d.ts
+- https://www.unpkg.com/@e-mc/types@0.13.7/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.13.5',
+    VERSION = '0.13.7',
     TEMP_DIR = 'tmp',
     CJS = '__cjs__'
 }

package/index.js

@@ -176,8 +176,7 @@ function fromObject(value, typedArray, structured, shared) {
 function trimQuote(value) {
     value = value.trim();
     const first = value[0];
-    const last = value[value.length - 1];
-    return first === last && (first === '"' || first === "'" || first === "`") ? value.substring(1, value.length - 1) : value;
+    return first === value.at(-1) && (first === '"' || first === "'" || first === "`") ? value.substring(1, value.length - 1) : value;
 }
 function checkCipherType(value) {
     switch (value) {
@@ -1052,18 +1051,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';

package/lib/core.d.ts

@@ -40,11 +40,11 @@ export interface IClientDb<T extends IHost, U extends ClientModule<ClientDbSetti
     hasCache(source: string, sessionKey?: string): boolean;
     hasCoerce(source: string, component: keyof DbCoerceSettings, uuidKey: string | undefined): boolean;
     hasCoerce(source: string, component: keyof DbCoerceSettings, credential?: unknown): boolean;
+    getQueryResult(source: string, credential: unknown, queryString: string, options: CacheOptions): QueryResult | undefined;
     getQueryResult(source: string, credential: unknown, queryString: string, renewCache: boolean): QueryResult | undefined;
-    getQueryResult(source: string, credential: unknown, queryString: string, sessionKey?: string, renewCache?: boolean): QueryResult | undefined;
-    getQueryResult(source: string, credential: unknown, queryString: string, options?: CacheOptions | string, renewCache?: boolean): QueryResult | undefined;
-    setQueryResult(source: string, credential: unknown, queryString: string, result: unknown, sessionKey?: string): QueryResult;
-    setQueryResult(source: string, credential: unknown, queryString: string, result: unknown, options?: CacheOptions | string): QueryResult;
+    getQueryResult(source: string, credential: unknown, queryString: string, sessionKey?: string | CacheOptions, renewCache?: boolean): QueryResult | undefined;
+    setQueryResult(source: string, credential: unknown, queryString: string, result: unknown, options: CacheOptions): QueryResult;
+    setQueryResult(source: string, credential: unknown, queryString: string, result: unknown, sessionKey?: string | CacheOptions): QueryResult;
     getCacheResult(source: string, credential: unknown, queryString: string, cacheValue: CacheOptions, ignoreCache?: IntBool | FirstOf<number, number>): QueryResult | undefined;
     applyState(items: V | V[], value: number, as?: boolean): void;
     commit(items?: V[]): Promise<boolean>;
@@ -68,12 +68,16 @@ export interface ClientDbConstructor<T extends IHost = IHost, U extends ClientMo
     loadSettings(settings: Pick<Settings, "process" | "memory">, password?: string): boolean;
     getTimeout(value: number | string | TimeoutAction | undefined): number;
     convertTime(value: number | string): number;
+    findResult(source: string, credential: unknown, queryString: string, timeout: number, renewCache: boolean): QueryResult | undefined;
     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;
-    purgeResult(prefix?: string): Promise<number>;
+    storeResult(source: string, credential: unknown, queryString: string, result: QueryResult, cache: DbCacheValue | undefined, options: Omit<StoreResultOptions, "cache">): QueryResult;
+    findSession<W = unknown>(source: string, user: string, key: string): W | undefined;
+    storeSession(source: string, user: string, key: string, result: unknown, expires?: number): void;
+    purgeResult(prefix?: string, lru?: boolean | number): Promise<number>;
     extractUUID(credential: unknown): string;
     setPoolConfig(value: unknown): void;
     getPoolConfig(source: string): unknown;

package/lib/http.d.ts

@@ -112,7 +112,8 @@ export interface AuthValue {
 }
 
 export type HttpRequestClient = ClientRequest | ClientHttp2Stream;
-export type HttpOutgoingHeaders = ObjectMap<OutgoingHttpHeaders>;
+export type HttpHeaders = OutgoingHttpHeaders | Headers;
+export type HttpOutgoingHeaders = ObjectMap<HttpHeaders>;
 export type HttpAgentOptions = Pick<AgentOptions, "timeout" | "maxSockets" | "maxTotalSockets" | "keepAliveMsecs" | "maxFreeSockets" | "proxyEnv">;
 export type HttpProtocolVersion = 1 | 2 | 3;
 export type InternetProtocolVersion = 0 | 4 | 6;

package/lib/index.d.ts

@@ -625,6 +625,7 @@ declare namespace functions {
         defineHttpCache(options: HttpMemorySettings, disk?: boolean): void;
         defineHttpConnect(options: HttpConnectSettings): void;
         defineHttpAdapter(module: unknown): void;
+        generateSessionId(): string;
         readonly prototype: IFileManager<T>;
         new(baseDirectory: string, config: RequestData<T>, postFinalize?: PostFinalizeCallback): IFileManager<T>;
         new(baseDirectory: string, config: RequestData<T>, permission?: IPermission | null, postFinalize?: PostFinalizeCallback): IFileManager<T>;
@@ -679,6 +680,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;
@@ -689,7 +691,7 @@ declare namespace functions {
         readonly status: LogStatus<StatusType>[];
         readonly errors: unknown[];
         supported(major: number, minor?: number, patch?: number, lts?: boolean): boolean;
-        supports(name: string, value?: boolean): boolean;
+        supports(name: string, value?: boolean, locked?: boolean): boolean;
         getTempDir(options: TempDirOptions): string;
         getTempDir(uuidDir: boolean, createDir: boolean): string;
         getTempDir(pathname: string, createDir: boolean): string;
@@ -900,6 +902,7 @@ declare namespace functions {
         sanitizeArgs(values: string[], doubleQuote?: boolean): string[];
         purgeMemory(percent: number, limit: number, parent?: boolean): Promise<number>;
         purgeMemory(percent?: number, limit?: number | boolean, parent?: unknown): Promise<number>;
+        availableParallelism(factor?: number): number;
         canWrite(name: "temp" | "home"): boolean;
         loadSettings(settings: Settings, password?: string): boolean;
         readonly prototype: IModule<T>;

package/lib/request.d.ts

@@ -38,13 +38,20 @@ export interface IHttpHost {
     success(version: HttpProtocolVersion, status?: boolean): number;
     failed(version: HttpProtocolVersion, status?: boolean): number;
     error(version: HttpProtocolVersion, status?: boolean): number;
+    /** @deprecated altSvc.did */
     didAltSvc(version: HttpProtocolVersion): boolean;
+    /** @deprecated altSvc.next */
     nextAltSvc(): boolean;
+    /** @deprecated altSvc.close */
     closeAltSvc(error?: boolean): boolean;
+    /** @deprecated altSvc.clear */
     clearAltSvc(version?: HttpProtocolVersion): void;
+    /** @deprecated altSvc.flag */
     flagAltSvc(version: HttpProtocolVersion, value: number): void;
     reset(): void;
+    v1(): boolean;
     v2(): boolean;
+    get altSvc(): IHttpHostAltSvc;
     set version(value);
     get version(): HttpProtocolVersion;
     get protocol(): string;
@@ -66,6 +73,25 @@ export interface HttpHostConstructor {
     new(url: URL, httpVersion?: HttpProtocolVersion): IHttpHost;
 }
 
+export interface IHttpHostAltSvc {
+    did(version: HttpProtocolVersion): boolean;
+    next(): boolean;
+    close(error?: boolean): boolean;
+    clear(version?: HttpProtocolVersion): void;
+    flag(version: HttpProtocolVersion, value: number): void;
+    valid(hostname: string, port: string, version: number): boolean;
+    set available(value: unknown[]);
+    get errors(): AltSvcInfo[];
+    get hostname(): string | undefined;
+    get port(): string | undefined;
+    get origin(): string | undefined;
+}
+
+export interface HttpHostAltSvcConstructor {
+    readonly prototype: IHttpHostAltSvc;
+    new(host: IHttpHost, versionData: AltSvcData): IHttpHostAltSvc;
+}
+
 export interface IHttpAdapter<T extends OpenOptions = OpenOptions> {
     instance: IRequest;
     state: ControllerState;
@@ -218,6 +244,30 @@ export interface ControllerState {
     readonly config: Required<ClientConfig>;
 }
 
+export interface AltSvcInfo {
+    hostname: string;
+    port: string;
+    version: number;
+}
+
+export interface AltSvcLocation extends Partial<AltSvcInfo> {
+    origin?: string;
+    timeout?: NodeJS.Timeout | null;
+}
+
+export interface AltSvcAvailability extends AltSvcInfo {
+    expires: number;
+    persist: boolean;
+}
+
+export interface AltSvcData {
+    success: number;
+    failed: number;
+    errors: number;
+    alpn: number;
+    status: number;
+}
+
 export type HttpMethod = "GET" | "POST" | "PUT" | "HEAD" | "DELETE";
 export type BufferFormat = "json" | "yaml" | "json5" | "xml" | "toml";
 export type ReadExpectType = "always" | "string" | "none";

package/lib/settings.d.ts

@@ -1,4 +1,4 @@
-import type { WatchInterval } from './squared';
+import type { ExpiresAction, WatchInterval } from './squared';
 
 import type { HashAlgorithm } from './asset';
 import type { CloudSource } from './cloud';
@@ -74,20 +74,18 @@ export interface ProcessModule<T = PlainObject> extends HandlerSettings<T> {
         };
         queue?: {
             limit?: number | string;
-            expires?: number | string;
             priority: { bypass?: number | string } & MinMax<number | string>;
-        };
+        } & ExpiresAction;
         worker?: {
             users?: boolean | string[];
             max?: number | string;
             max_expires?: number | string;
             locked?: boolean;
-            channel?: MinMax<number | string> & { expires?: number | string; verbose?: boolean };
+            channel?: MinMax<number | string> & ExpiresAction & { verbose?: boolean };
         };
         limit?: number | string;
         sub_limit?: number | string;
-        expires?: number | string;
-    };
+    } & ExpiresAction;
     cipher?: CipherConfig;
     password?: string;
 }
@@ -114,8 +112,7 @@ export interface PermissionSettings extends PlainObject {
     minimatch?: MinimatchOptions | null;
 }
 
-export interface DownloadModule<T = PlainObject> extends HandlerSettings<T> {
-    expires?: number | string;
+export interface DownloadModule<T = PlainObject> extends HandlerSettings<T>, ExpiresAction {
     aria2?: DownloadAction & {
         check_integrity?: boolean;
         update_status?: number | string | { interval?: number | string; broadcast_only?: boolean };
@@ -233,7 +230,7 @@ export interface DocumentDirectory extends StringMap {
 export type DocumentComponentOptions = DocumentComponent<DocumentComponentOption<DocumentTransform>, DocumentComponentOption<boolean>>;
 
 export interface ClientDbSettings<T = PlainObject> extends ClientSettings<T>, PurgeAction {
-    session_expires?: number;
+    session_expires?: number | string;
     user_key?: ObjectMap<DbSourceOptions>;
     imports?: StringMap;
 }
@@ -246,13 +243,13 @@ export interface MemorySettings extends PlainObject {
         file_count?: boolean;
     };
     cache_disk?: MemoryCacheDiskSettings;
+    gc?: { interval?: number | string; expires_limit?: number | string } & ExpiresAction;
 }
 
-export interface MemoryCacheDiskSettings<T = number | string, U = string[] | null> extends IncludeAction<U> {
+export interface MemoryCacheDiskSettings<T = number | string, U = string[] | null> extends IncludeAction<U>, ExpiresAction<T> {
     enabled?: boolean;
     min_size?: T;
     max_size?: T;
-    expires?: T;
 }
 
 export interface DbModule<T = DbSettings> extends ClientModule<T>, DbSourceDataType<ObjectMap<AnyObject>>, PlainObject {
@@ -282,6 +279,7 @@ export interface DbCoerceSettings<T = boolean> {
 
 export interface PurgeBase<T = number | string> extends MinMax {
     enabled?: boolean;
+    type?: "lru" | "lfu";
     percent?: T;
     limit?: T;
 }
@@ -504,10 +502,9 @@ export interface HttpSettings {
     certs?: ObjectMap<SecureConfig<string | string[]>>;
 }
 
-export interface HttpDiskSettings extends IncludeAction {
+export interface HttpDiskSettings extends IncludeAction, ExpiresAction {
     enabled?: boolean;
     limit?: number | string;
-    expires?: number | string;
 }
 
 export interface HttpMemorySettings extends HttpDiskSettings {
@@ -524,17 +521,15 @@ export interface HttpConnectSettings {
     redirect_limit?: number | string;
 }
 
-export interface DnsLookupSettings {
+export interface DnsLookupSettings extends ExpiresAction {
     family?: number | string;
-    expires?: number | string;
     resolve?: ObjectMap<Partial<LookupAddress>>;
 }
 
-export interface HashConfig extends IncludeAction<ObjectMap<string[] | "*">> {
+export interface HashConfig extends IncludeAction<ObjectMap<string[] | "*">>, ExpiresAction {
     enabled?: boolean;
     algorithm?: HashAlgorithm;
     etag?: boolean;
-    expires?: number | string;
     renew?: boolean;
     limit?: number | string;
 }
@@ -552,10 +547,9 @@ export interface PurgeAction {
     purge?: PurgeComponent;
 }
 
-export interface CacheDirAction {
+export interface CacheDirAction extends ExpiresAction {
     enabled?: boolean;
     dir?: string;
-    expires?: number | string;
 }
 
 export interface PoolConfig<T = number> extends MinMax {

package/lib/squared.d.ts

@@ -149,6 +149,10 @@ export interface FromAction {
     from?: string[];
 }
 
+export interface ExpiresAction<T = number | string> {
+    expires?: T;
+}
+
 export interface TaskCommand<T = PlainObject> {
     handler?: string;
     task?: string | T;
@@ -204,11 +208,10 @@ export interface LocationUri {
     filename: string;
 }
 
-export interface ViewEngine<T = unknown, U = PlainObject> {
+export interface ViewEngine<T = unknown, U = PlainObject> extends ExpiresAction {
     name?: string;
     singleRow?: boolean;
     outputEmpty?: boolean;
-    expires?: number | string;
     options?: {
         compile?: T;
         output?: U;
@@ -323,9 +326,8 @@ export interface ResponseError {
     hint?: string;
 }
 
-export interface RequestObserve extends WebSocketClient {
+export interface RequestObserve extends WebSocketClient, ExpiresAction {
     action?: string;
-    expires?: number | string;
 }
 
 export interface ChecksumBase<T = BinaryToTextEncoding> {
@@ -342,10 +344,9 @@ export interface ChecksumOutput<T = BinaryToTextEncoding> extends ChecksumBase<T
     recursive?: boolean | 1;
 }
 
-export interface TaskBase {
+export interface TaskBase extends ExpiresAction {
     interval?: number | string;
     start?: number | string;
-    expires?: number | string;
 }
 
 export type WebSocketEvent = "close" | "error";

package/package.json

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