@e-mc/types 0.10.6 → 0.10.7

package/lib/settings.d.ts

@@ -5,7 +5,7 @@ import type { CloudSource } from './cloud';
 import type { PermissionAction, PermissionReadWrite, PermittedDirectories } from './core';
 import type { DbSource, TimeoutAction } from './db';
 import type { HttpOutgoingHeaders, SecureConfig, ServerPort } from './http';
-import type { BackgroundColor, BroadcastOutMethod, ErrorOutMethod, ForegroundColor, LoggerColor, LoggerStatus, TextAlign } from './logger';
+import type { BackgroundColor, BroadcastOutMethod, ErrorOutMethod, ForegroundColor, LoggerColor, LoggerStatus, TextAlign, TextWrapStyle } from './logger';
 import type { ExecAction, IncludeAction } from './module';
 
 import type { SpawnOptions } from 'child_process';
@@ -13,6 +13,7 @@ import type { BinaryLike, CipherGCMTypes } from 'crypto';
 import type { LookupAddress } from 'dns';
 import type { BrotliOptions, ZlibOptions } from 'zlib';
 
+import type { BackgroundColor as IBackgroundColor } from 'chalk';
 // @ts-ignore
 import type { Unit } from 'bytes';
 // @ts-ignore
@@ -59,13 +60,13 @@ export interface ProcessModule<T = PlainObject> extends HandlerSettings<T> {
             private?: boolean;
         };
         queue?: {
-            limit?: NumString;
-            expires?: NumString;
-            priority: { bypass?: NumString } & MinMax<NumString>;
+            limit?: number | string;
+            expires?: number | string;
+            priority: { bypass?: number | string } & MinMax<number | string>;
         };
-        limit?: NumString;
-        sub_limit?: NumString;
-        expires?: NumString;
+        limit?: number | string;
+        sub_limit?: number | string;
+        expires?: number | string;
     };
     cipher?: CipherConfig;
     password?: string;
@@ -77,6 +78,7 @@ export interface ProcessEnvConfig {
 
 export interface TempModule<T = PlainObject> extends HandlerSettings<T> {
     dir?: string;
+    env?: string;
     write?: boolean;
 }
 
@@ -92,19 +94,20 @@ export interface PermissionSettings extends PlainObject {
 }
 
 export interface DownloadModule<T = PlainObject> extends HandlerSettings<T> {
-    expires?: NumString;
+    expires?: number | string;
     aria2?: {
         bin?: string | false;
         exec?: ExecAction;
-        update_status?: NumString | { interval?: NumString; broadcast_only?: boolean };
-        max_concurrent_downloads?: NumString;
-        max_connection_per_server?: NumString;
-        bt_stop_timeout?: NumString;
-        bt_tracker_connect_timeout?: NumString;
-        bt_tracker_timeout?: NumString;
+        check_integrity?: boolean;
+        update_status?: number | string | { interval?: number | string; broadcast_only?: boolean };
+        max_concurrent_downloads?: number | string;
+        max_connection_per_server?: number | string;
+        bt_stop_timeout?: number | string;
+        bt_tracker_connect_timeout?: number | string;
+        bt_tracker_timeout?: number | string;
         min_split_size?: string;
-        disk_cache?: NumString;
-        lowest_speed_limit?: NumString;
+        disk_cache?: number | string;
+        lowest_speed_limit?: number | string;
         always_resume?: boolean;
         file_allocation?: "none" | "prealloc" | "trunc" | "falloc";
         conf_path?: string;
@@ -144,13 +147,13 @@ export interface DocumentComponentOption<T = unknown> {
     cache?: T;
     coerce?: boolean;
     abort?: boolean;
-    local_file?: NumString;
+    local_file?: number | string;
 }
 
-export interface DocumentSettings extends DocumentGroup, PurgeAction, ClientSettings<DocumentUserSettings>, PlainObject {
-    imports_strict?: boolean;
+export interface DocumentSettings<T extends DocumentUserSettings = DocumentUserSettings> extends DocumentGroup, PurgeAction, ClientSettings<T>, PlainObject {
     directory?: DocumentDirectory;
     options?: DocumentComponentOptions;
+    imports_strict?: boolean;
 }
 
 export interface DocumentDirectory extends StringMap {
@@ -172,7 +175,7 @@ export interface MemorySettings extends PlainObject {
     cache_disk?: MemoryCacheDiskSettings;
 }
 
-export interface MemoryCacheDiskSettings<T = NumString> extends IncludeAction<Null<string[]>> {
+export interface MemoryCacheDiskSettings<T = number | string> extends IncludeAction<Null<string[]>> {
     enabled?: boolean;
     min_size?: T;
     max_size?: T;
@@ -189,12 +192,12 @@ export interface DbUserSettings extends DbSourceDataType<{ commands?: ObjectMap<
 
 export interface DbCacheSettings extends TimeoutAction {
     dir?: string;
-    purge?: NumString;
+    purge?: number | string;
     when_empty?: boolean;
 }
 
 export interface DbSourceOptions {
-    pool?: PoolConfig<NumString>;
+    pool?: PoolConfig<number | string>;
     cache?: DbCacheValue;
     coerce?: DbCoerceValue;
 }
@@ -204,20 +207,20 @@ export interface DbCoerceSettings<T = boolean> {
     options?: T;
 }
 
-export interface PurgeBase<T = NumString> extends MinMax {
+export interface PurgeBase<T = number | string> extends MinMax {
     enabled?: boolean;
     percent?: T;
     limit?: number;
 }
 
 export interface PurgeComponent extends PurgeBase {
-    interval?: NumString;
+    interval?: number | string;
     all?: boolean | number;
     log?: boolean;
     prefix?: string;
 }
 
-export type DbCacheValue = NumString | DbCacheSettings;
+export type DbCacheValue = number | string | DbCacheSettings;
 export type DbCoerceValue = boolean | DbCoerceSettings;
 export type DbSourceDataType<T = unknown> = {
     [K in DbSource]?: T;
@@ -234,35 +237,42 @@ export interface ImageSettings extends PlainObject {
     };
 }
 
-export interface RequestModule<T = RequestSettings> extends HandlerSettings<T> {
-    timeout?: NumString;
-    read_timeout?: NumString;
+export interface RequestModule<T = RequestSettings> extends HandlerSettings<T>, HttpHostSettings {
+    timeout?: number | string;
+    read_timeout?: number | string;
     agent?: {
         keep_alive?: boolean;
-        timeout?: NumString;
+        timeout?: number | string;
     };
     disk?: HttpDiskSettings;
     buffer?: HttpMemorySettings;
     connect?: HttpConnectSettings;
     dns?: DnsLookupSettings;
     use?: {
-        http_version?: NumString;
+        http_version?: number | string;
         accept_encoding?: boolean;
     };
-    proxy?: AuthValue & IncludeAction & {
-        address?: string;
-        port?: NumString;
-        keep_alive?: boolean;
-    };
+    proxy?: HttpProxySettings;
     headers?: HttpOutgoingHeaders;
     certs?: ObjectMap<SecureConfig<ArrayOf<string>>>;
+    post_limit?: number | string;
+}
+
+export interface HttpProxySettings extends AuthValue, IncludeAction {
+    address?: string;
+    port?: number | string;
+    origin?: string;
+    keep_alive?: boolean;
+}
+
+export interface HttpHostSettings {
     localhost?: string[];
     protocol?: {
         "http/1.1"?: string[];
         h2c?: string[];
         h2?: string[];
     };
-    post_limit?: NumString;
+    write_stream?: ObjectMap<number | string>;
 }
 
 export interface RequestSettings extends PurgeAction, PlainObject {
@@ -270,7 +280,7 @@ export interface RequestSettings extends PurgeAction, PlainObject {
 }
 
 export interface WatchModule<T = WatchSettings> extends HandlerModule<T>, ServerInfo {
-    interval?: NumString;
+    interval?: number | string;
 }
 
 export interface WatchSettings<T = WatchUserSettings> extends ClientSettings<ObjectMap<T>>, PlainObject {}
@@ -279,19 +289,15 @@ export interface CompressModule<U = CompressSettings> extends HandlerSettings<U>
     gzip?: ZlibOptions;
     brotli?: BrotliOptions;
     zopfli?: ZopfliOptions;
-    tinify?: {
-        api_key?: string;
-        proxy?: string;
-    };
 }
 
 export interface CompressSettings extends PlainObject {
     cache?: boolean;
-    cache_expires?: NumString;
-    gzip_level?: NumString;
-    brotli_quality?: NumString;
-    zopfli_iterations?: NumString;
-    chunk_size?: NumString;
+    cache_expires?: number | string;
+    gzip_level?: number | string;
+    brotli_quality?: number | string;
+    zopfli_iterations?: number | string;
+    chunk_size?: number | string;
 }
 
 export interface TaskModule<T = PlainObject> extends ClientModule<T>, PlainObject {}
@@ -319,14 +325,24 @@ export interface ErrorModule extends HandlerModule {
     out?: string | ErrorOutMethod;
     abort?: string[];
     fatal?: boolean;
-    recursion_limit?: NumString;
+    recursion_limit?: number | string;
+}
+
+export interface LoggerProgress extends LoggerFormatColor {
+    scroll_buffer?: number | string;
+    max_width?: number | string;
+    use_color?: boolean;
+    text_wrap?: TextWrapStyle;
+    box_char?: string;
+    raw_mode?: boolean;
 }
 
-export interface LoggerModule<T = NumString, U = boolean | T, V = LoggerFormat<T>> {
+export interface LoggerModule<T = number | string, U = boolean | T, V = LoggerFormat<T>> {
     enabled?: boolean;
-    level?: NumString;
+    level?: number | string;
     production?: string[];
     format?: LoggerFormatSettings<V>;
+    progress?: LoggerProgress;
     meter?: LoggerMeterSettings<T>;
     broadcast?: BroadcastServer & { color?: boolean };
     status?: boolean | LoggerStatus;
@@ -359,9 +375,10 @@ export interface LoggerFormatSettings<T = PlainObject> {
     session_id?: T;
     message?: T;
     meter?: T;
+    error?: T;
 }
 
-export interface LoggerMeterSettings<T = NumString> {
+export interface LoggerMeterSettings<T = number | string> {
     http?: T;
     image?: T;
     compress?: T;
@@ -371,52 +388,58 @@ export interface LoggerMeterSettings<T = NumString> {
 export interface LoggerProcessSettings extends LoggerColor {
     cpu?: boolean;
     cpu_bar?: boolean | ArrayOf<number>;
+    cpu_bar_color?: [typeof IBackgroundColor, typeof IBackgroundColor, typeof IBackgroundColor];
     cpu_single_core?: boolean;
     mem?: boolean;
     mem_format?: "%" | Unit;
 }
 
-export interface LoggerFormat<T = NumString> {
-    width?: T;
+export interface LoggerFormatColor {
     color?: ForegroundColor;
     bg_color?: BackgroundColor;
+}
+
+export interface LoggerFormat<T = number | string> extends LoggerFormatColor {
+    width?: T;
+    alt_color?: ForegroundColor;
     bg_alt_color?: BackgroundColor;
     bold?: boolean;
     justify?: TextAlign;
     unit?: string;
     as?: StringMap;
+    braces?: string | TupleOf<string>;
 }
 
 export interface HttpSettings {
-    version?: NumString;
-    timeout?: NumString;
+    version?: number | string;
+    timeout?: number | string;
     headers?: HttpOutgoingHeaders;
     certs?: ObjectMap<SecureConfig<ArrayOf<string>>>;
 }
 
 export interface HttpDiskSettings extends IncludeAction {
     enabled?: boolean;
-    limit?: NumString;
-    expires?: NumString;
+    limit?: number | string;
+    expires?: number | string;
 }
 
 export interface HttpMemorySettings extends HttpDiskSettings {
-    limit_all?: NumString;
-    to_disk?: NumString | [NumString, NumString?];
-    purge_amount?: NumString;
+    limit_all?: number | string;
+    to_disk?: number | string | [number | string, (number | string)?];
+    purge_amount?: number | string;
 }
 
 export interface HttpConnectSettings {
-    timeout?: NumString;
-    retry_wait?: NumString;
-    retry_after?: NumString;
-    retry_limit?: NumString;
-    redirect_limit?: NumString;
+    timeout?: number | string;
+    retry_wait?: number | string;
+    retry_after?: number | string;
+    retry_limit?: number | string;
+    redirect_limit?: number | string;
 }
 
 export interface DnsLookupSettings {
-    family?: NumString;
-    expires?: NumString;
+    family?: number | string;
+    expires?: number | string;
     resolve?: ObjectMap<Partial<LookupAddress>>;
 }
 
@@ -424,12 +447,12 @@ export interface HashConfig extends IncludeAction<ObjectMap<string[] | "*">> {
     enabled?: boolean;
     algorithm?: HashAlgorithm;
     etag?: boolean;
-    expires?: NumString;
+    expires?: number | string;
     renew?: boolean;
-    limit?: NumString;
+    limit?: number | string;
 }
 
-export interface BroadcastServer extends ServerInfo<ArrayOf<NumString>> {
+export interface BroadcastServer extends ServerInfo<ArrayOf<number | string>> {
     out?: string | BroadcastOutMethod;
 }
 
@@ -457,7 +480,7 @@ export interface CipherConfig {
     iv?: BinaryLike;
 }
 
-export interface ServerInfo<T = NumString> extends ServerPort<T> {
+export interface ServerInfo<T = number | string> extends ServerPort<T> {
     enabled?: boolean;
     secure?: SecureConfig & ServerPort<T>;
 }

package/lib/squared.d.ts

@@ -23,18 +23,6 @@ interface BlobValue extends KeyValue<string, unknown> {
     filename?: string;
 }
 
-interface BoxRect<T = number> {
-    top: T;
-    right: T;
-    bottom: T;
-    left: T;
-}
-
-interface BoxRectDimension extends BoxRect, Dimension {
-    numberOfLines?: number;
-    overflow?: boolean;
-}
-
 export interface FileAsset extends TextAsset, OutputAction, DocumentAction, MultipartAction, ResourceAction, IncrementalAction, ChecksumAction {
     format?: ArrayOf<string>;
     dataView?: NodeJS.ArrayBufferView;
@@ -53,7 +41,7 @@ export interface DataSource<T = unknown> extends DocumentAction {
     preRender?: string | FunctionType;
     whenEmpty?: string | FunctionType;
     removeEmpty?: boolean;
-    ignoreCache?: boolean | 0 | 1 | [number, number?, number?];
+    ignoreCache?: IntBool | FirstOf<number, number>;
     transactionState?: number;
     transactionFail?: boolean;
 }
@@ -66,6 +54,7 @@ export interface DbDataSource<T = unknown, U = unknown, V = unknown, W = unknown
     update?: V;
     withCommand?: string | TupleOf<string>;
     parallel?: boolean;
+    flat?: number;
     willAbort?: boolean;
     streamRow?: Null<boolean | string | ((row: unknown) => Void<Error | false>)>;
     usePool?: boolean | X;
@@ -91,7 +80,7 @@ export interface WatchAction {
 }
 
 export interface BundleAction<T = unknown> {
-    bundleId?: NumString;
+    bundleId?: number | string;
     bundleIndex?: number;
     bundleReplace?: T;
     bundleQueue?: Promise<unknown>[];
@@ -225,7 +214,7 @@ export interface CompressFormat extends CompressLevel {
     condition?: string;
     plugin?: string;
     timeout?: number;
-    options?: PlainObject & { apiKey?: string };
+    options?: PlainObject;
 }
 
 export interface WatchInterval<T = FileAsset> extends TaskBase {
@@ -268,7 +257,7 @@ export interface BroadcastResponse extends WebSocketResponse {
 
 export interface FileInfo {
     name: string;
-    size: NumString;
+    size: number | string;
 }
 
 export interface RequestBase<T = PlainObject> {
@@ -322,32 +311,7 @@ export interface ResponseError {
 
 export interface RequestObserve extends WebSocketClient {
     action?: string;
-    expires?: NumString;
-}
-
-export interface FinalizedElement {
-    documentId: string;
-    bounds: BoxRectDimension;
-    css: PlainObject;
-    outerWrapperIds?: string[];
-}
-
-export interface ConditionProperty {
-    conditionText: string;
-}
-
-export interface CssConditionData extends ConditionProperty {
-    name?: string;
-    conditionText: string;
-}
-
-export interface ControllerSettingsDirectoryUI {
-    layout: string;
-    string: string;
-    font: string;
-    image: string;
-    video: string;
-    audio: string;
+    expires?: number | string;
 }
 
 export interface ChecksumBase<T = BinaryToTextEncoding> {
@@ -363,9 +327,9 @@ export interface ChecksumOutput<T = BinaryToTextEncoding> extends ChecksumBase<T
 }
 
 export interface TaskBase {
-    interval?: NumString;
-    start?: NumString;
-    expires?: NumString;
+    interval?: number | string;
+    start?: number | string;
+    expires?: number | string;
 }
 
 export type WebSocketEvent = "close" | "error";

package/lib/task.d.ts

@@ -1,10 +1,10 @@
-export interface Command<T = unknown> extends PlainObject {
-    task: string;
-    origDir: string;
-    data: T;
-}
-
-export interface SpawnResult {
-    added?: string[];
-    deleted?: string[];
+export interface Command<T = unknown> extends PlainObject {
+    task: string;
+    origDir: string;
+    data: T;
+}
+
+export interface SpawnResult {
+    added?: string[];
+    deleted?: string[];
 }

package/lib/type.d.ts

@@ -1,31 +1,34 @@
-/* eslint @typescript-eslint/no-explicit-any: "off", @typescript-eslint/no-redeclare: "off" */
-
 type Undef<T> = T | undefined;
 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; };
-type Writeable<T> = { -readonly [P in keyof T]: T[P] };
+type Writable<T> = { -readonly [P in keyof T]: T[P] };
 type KeyOfType<T, U = any, V = any> = { [K in keyof T]: K extends U ? T[K] extends V ? K : never : never }[keyof T];
 type MapOfType<T, U = any, V = any> = { [K in KeyOfType<T, U, V>]: K extends U ? T[K] extends V ? T[K] : never : never };
 
 type Constructor<out T> = new(...args: any[]) => T;
+type ConstructorDerived<T> = Pick<T, { [K in keyof T]: T[K] extends new() => any ? never : K }[keyof T]>;
 
 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[] | [U, ...T[]];
+type FirstOf<T, U = boolean> = T extends U ? [T, ...T[]] : T[] | [U, T, ...T[]];
 type Bufferable = string | Buffer;
 
 type AnyObject = Record<string, unknown>;
 type PlainObject = Record<string | number | symbol, unknown>;
 
 type StandardMap = Record<string, any>;
-type StringMap = Record<string, Undef<string>>;
-type ObjectMap<T> = Record<string, Undef<T>>;
+type StringMap = Record<string, string | undefined>;
+type ObjectMap<T> = Record<string, T | undefined>;
+type IterableMap<T> = Record<string, T>;
 
 type PropertyAction<T, U extends string, V extends boolean = false> = {
     [K in keyof T as `${U}${V extends true ? string & K : Capitalize<string & K>}`]: T[K];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/types",
-  "version": "0.10.6",
+  "version": "0.10.7",
   "description": "Type definitions for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -20,7 +20,8 @@
   "license": "BSD-3-Clause",
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
-    "bytes": "^3.1.2"
+    "bytes": "^3.1.2",
+    "chalk": "4.1.2"
   },
   "devDependencies": {
     "typescript": "5.5.4"