@e-mc/types 0.8.7 → 0.9.0

package/lib/logger.d.ts

@@ -1,6 +1,6 @@
 import type { LogStatus } from './squared';
 
-import type { LOG_TYPE, STATUS_TYPE } from '../index.d';
+import type { LOG_STATE, LOG_TYPE, STATUS_TYPE } from '../index.d';
 
 import type { BackgroundColor as IBackgroundColor, ForegroundColor as IForegroundColor } from 'chalk';
 
@@ -31,17 +31,6 @@ export interface LoggerColor {
     messageBold?: boolean;
 }
 
-export interface LoggerFormat<T = NumString> {
-    width?: T;
-    color?: ForegroundColor;
-    bg_color?: BackgroundColor;
-    bg_alt_color?: BackgroundColor;
-    bold?: boolean;
-    justify?: TextAlign;
-    unit?: string;
-    as?: StringMap;
-}
-
 export interface LoggerStatus<T = boolean> {
     fatal?: T;
     error?: T;
@@ -105,9 +94,10 @@ export interface ExecCommand {
     warn?: string[];
 }
 
-export type { LOG_TYPE, STATUS_TYPE };
+export type { LOG_STATE, LOG_TYPE, STATUS_TYPE };
 export type LogType = LOG_TYPE[keyof LOG_TYPE];
 export type StatusType = STATUS_TYPE[keyof STATUS_TYPE];
+export type LogState = LOG_STATE[keyof LOG_STATE];
 export type StatusName = keyof typeof STATUS_TYPE;
 export type LogDate = Date | number;
 export type LogTime = LogDate | HighResolutionTime;
@@ -118,4 +108,4 @@ export type ForegroundColor = typeof IForegroundColor | HexColor;
 export type TextAlign = "left" | "center" | "right";
 export type ErrorOutMethod = (err: Error, data: LogTypeValue, require?: NodeRequire) => void;
 export type BroadcastOutMethod = (value: string, options: LogMessageOptions, require?: NodeRequire) => void;
-export type BroadcastValue = StringOfArray | { value: StringOfArray; stripAnsi?: boolean };
+export type BroadcastValue = ArrayOf<string> | { value: ArrayOf<string>; stripAnsi?: boolean };

package/lib/module.d.ts

@@ -12,7 +12,7 @@ declare enum NORMALIZE_FLAGS {
 }
 
 export interface RequireAction {
-    requireExt?: StringOfArray | boolean;
+    requireExt?: ArrayOf<string> | boolean;
 }
 
 export interface PermissionOptions {
@@ -125,7 +125,17 @@ export interface GetTempDirOptions {
     increment?: number;
 }
 
+export interface ExecAction {
+    uid?: NumString;
+    gid?: NumString;
+}
+
+export interface IncludeAction<T = string[]> {
+    include?: T;
+    exclude?: T;
+}
+
 export type NormalizeFlags = typeof NORMALIZE_FLAGS[keyof typeof NORMALIZE_FLAGS];
 export type ReadTextOptions = ReadBufferOptions;
-export type ReadFileCallback<T extends BufferContent = BufferContent> = (err: Null<NodeJS.ErrnoException>, data?: T) => void;
+export type ReadFileCallback<T extends Bufferable = Bufferable> = (err: Null<NodeJS.ErrnoException>, data?: T) => void;
 export type ProtocolType = "http" | "https" | "http/s" | "ftp" | "sftp" | "s/ftp" | "torrent" | "unc";

package/lib/node.d.ts

@@ -4,8 +4,6 @@ import type { ExternalAsset } from './asset';
 import type { HostInitConfig } from './core';
 import type { DownloadModule, ErrorModule, LoggerModule, MemoryModule, NodeModule, PermissionModule, ProcessModule, RequestModule, TempModule } from './settings';
 
-type BoolString = boolean | string;
-
 export interface RequestData<T extends ExternalAsset = ExternalAsset> extends Readonly<Omit<IRequestData, "log">>, Readonly<HostInitConfig> {
     readonly assets?: T[];
 }

package/lib/object.d.ts

@@ -1,3 +1,5 @@
+/* eslint @typescript-eslint/no-redeclare: "off" */
+
 interface Point {
     x: number;
     y: number;

package/lib/request.d.ts

@@ -1,8 +1,8 @@
 import type { BinaryAction } from './asset';
 import type { HttpProtocolVersion, InternetProtocolVersion } from './http';
 
-import type { Readable, Writable } from 'stream';
 import type { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
+import type { Readable, Writable } from 'stream';
 
 interface KeepAliveAction {
     keepAlive?: boolean;
@@ -57,7 +57,10 @@ export interface OpenOptions extends KeepAliveAction, SilentAction {
     socketPath?: string;
     httpVersion?: HttpProtocolVersion;
     method?: "GET" | "POST" | "HEAD";
+    search?: StringMap;
+    follow_redirect?: boolean;
     encoding?: BufferEncoding;
+    maxBufferSize?: NumString;
     format?: BufferFormat | { out?: BufferFormat; parser?: PlainObject };
     headers?: OutgoingHttpHeaders;
     timeout?: number;
@@ -65,6 +68,7 @@ export interface OpenOptions extends KeepAliveAction, SilentAction {
     postData?: unknown;
     connected?: (headers: IncomingHttpHeaders) => Void<boolean>;
     statusMessage?: string;
+    progressId?: NumString;
     outFormat?: { out: BufferFormat; parser?: PlainObject };
     outFilename?: Null<string>;
     outHeaders?: Null<IncomingHttpHeaders>;
@@ -104,8 +108,6 @@ export interface ProxySettings extends KeepAliveAction {
 
 export interface RequestInit extends ProtocolAction {
     headers?: unknown;
-    /* @deprecated - readTimeout */
-    requestTimeout?: number;
     readTimeout?: number;
 }
 
@@ -127,7 +129,7 @@ export interface ApplyOptions extends ProtocolAction, PlainObject {
 
 export type BufferFormat = "json" | "yaml" | "json5" | "xml" | "toml";
 export type ReadExpectType = "always" | "string" | "none";
-export type DataEncodedResult<T extends { encoding?: BufferEncoding }> = T extends { encoding: BufferEncoding } ? string : Null<BufferContent>;
+export type DataEncodedResult<T extends { encoding?: BufferEncoding }> = T extends { encoding: BufferEncoding } ? string : Null<Bufferable>;
 export type DataObjectResult<T extends { format?: unknown; encoding?: BufferEncoding }> = T extends { format: string | PlainObject } ? Null<object> : DataEncodedResult<T>;
 export type StatusOnCallback = (code: number, headers: IncomingHttpHeaders, url?: URL) => Void<boolean>;
 export type HeadersOnCallback = (headers: IncomingHttpHeaders, url?: URL) => Void<boolean>;

package/lib/settings.d.ts

@@ -1,24 +1,26 @@
 import type { WatchInterval } from './squared';
 
+import type { HashAlgorithm } from './asset';
+import type { CloudSource } from './cloud';
 import type { PermissionAction, PermissionReadWrite, PermittedDirectories } from './core';
-import type { DbSource, PoolConfig, TimeoutAction } from './db';
-import type { HttpOutgoingHeaders } from './http';
-import type { BroadcastOutMethod, ErrorOutMethod, LoggerColor, LoggerFormat, LoggerStatus } from './logger';
+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 { ExecAction, IncludeAction } from './module';
 
-import type { LookupAddress } from 'dns';
-import type { SecureVersion } from 'tls';
 import type { SpawnOptions } from 'child_process';
-import type { BrotliOptions, ZlibOptions } from 'zlib';
 import type { BinaryLike, CipherGCMTypes } from 'crypto';
+import type { LookupAddress } from 'dns';
+import type { BrotliOptions, ZlibOptions } from 'zlib';
 
 // @ts-ignore
-import type { Options as ZopfliOptions } from 'node-zopfli';
-// @ts-ignore
-import type { PicomatchOptions } from 'picomatch';
+import type { Unit } from 'bytes';
 // @ts-ignore
 import type { MinimatchOptions } from 'minimatch';
 // @ts-ignore
-import type { Unit } from 'bytes';
+import type { Options as ZopfliOptions } from 'node-zopfli';
+// @ts-ignore
+import type { PicomatchOptions } from 'picomatch';
 
 export interface HandlerModule<T = PlainObject> extends HandlerSettings<T> {
     handler?: string;
@@ -26,7 +28,7 @@ export interface HandlerModule<T = PlainObject> extends HandlerSettings<T> {
 }
 
 export interface HandlerSettings<T = PlainObject> {
-    settings?: T & { broadcast_id?: StringOfArray };
+    settings?: T & { broadcast_id?: ArrayOf<string> };
 }
 
 export interface ClientModule<T = ClientSettings> extends HandlerModule<T>, PermissionAction {}
@@ -43,7 +45,7 @@ export interface NodeModule<T = PlainObject> extends HandlerSettings<T> {
         inline?: boolean;
     };
     require?: {
-        ext?: StringOfArray | boolean;
+        ext?: ArrayOf<string> | boolean;
         npm?: boolean;
         inline?: boolean;
     };
@@ -56,13 +58,14 @@ export interface ProcessModule<T = PlainObject> extends HandlerSettings<T> {
             users?: string[];
             private?: boolean;
         };
-        limit?: NumString;
-        expires?: NumString;
         queue?: {
             limit?: NumString;
             expires?: NumString;
             priority: { bypass?: NumString } & MinMax<NumString>;
         };
+        limit?: NumString;
+        sub_limit?: NumString;
+        expires?: NumString;
     };
     cipher?: CipherConfig;
     password?: string;
@@ -121,7 +124,7 @@ export interface DocumentEval {
     absolute?: boolean;
 }
 
-export interface DocumentGroup<T = { imports?: StringMap } & AnyObject, U = T> {
+export interface DocumentGroup<T = { imports?: StringMap } & AnyObject, U = AnyObject> {
     transform?: T;
     view_engine?: U;
     pages?: ObjectMap<AnyObject>;
@@ -176,7 +179,9 @@ export interface MemoryCacheDiskSettings<T = NumString> extends IncludeAction<Nu
     expires?: T;
 }
 
-export interface DbModule<T = DbSettings> extends ClientModule<T>, DbSourceDataType<ObjectMap<StringMap>>, PlainObject {}
+export interface DbModule<T = DbSettings> extends ClientModule<T>, DbSourceDataType<ObjectMap<AnyObject>>, PlainObject {
+    apiVersion?: string;
+}
 
 export interface DbSettings<T = DbUserSettings> extends ClientDbSettings<T>, DbSourceDataType<DbSourceOptions> {}
 
@@ -214,6 +219,9 @@ export interface PurgeComponent extends PurgeBase {
 
 export type DbCacheValue = NumString | DbCacheSettings;
 export type DbCoerceValue = boolean | DbCoerceSettings;
+export type DbSourceDataType<T = unknown> = {
+    [K in DbSource]?: T;
+};
 
 export type ImageModule<T = ImageSettings> = ClientModule<T>;
 
@@ -247,18 +255,17 @@ export interface RequestModule<T = RequestSettings> extends HandlerSettings<T> {
         keep_alive?: boolean;
     };
     headers?: HttpOutgoingHeaders;
-    certs?: ObjectMap<SecureConfig<StringOfArray>>;
+    certs?: ObjectMap<SecureConfig<ArrayOf<string>>>;
     localhost?: string[];
     protocol?: {
-        "http/1.1": string[];
-        h2c: string[];
-        h2: string[];
+        "http/1.1"?: string[];
+        h2c?: string[];
+        h2?: string[];
     };
     post_limit?: NumString;
 }
 
 export interface RequestSettings extends PurgeAction, PlainObject {
-    cache?: boolean | string[];
     time_format?: "readable" | "relative" | "none";
 }
 
@@ -295,20 +302,18 @@ export interface CloudModule<T = CloudSettings> extends ClientModule<T>, CloudSe
 
 export interface CloudSettings extends ClientDbSettings, CloudServiceDataType<CloudServiceOptions> {}
 
-export interface CloudServiceDataType<T = unknown> {
-    atlas?: T;
-    aws?: T;
-    "aws-v3"?: T;
-    az?: T;
-    azure?: T;
-    gcp?: T;
-    gcloud?: T;
-    ibm?: T;
-    oci?: T;
-    minio?: T;
+export type CloudServiceDataType<T = unknown> = {
+    [K in CloudSource]?: T;
+};
+
+export interface CloudServiceOptions extends DbSourceOptions {
+    auth?: CloudAuthSettings;
 }
 
-export type CloudServiceOptions = Omit<DbSourceOptions, "pool">;
+export interface CloudAuthSettings {
+    storage?: boolean;
+    database?: boolean;
+}
 
 export interface ErrorModule extends HandlerModule {
     out?: string | ErrorOutMethod;
@@ -334,7 +339,7 @@ export interface LoggerModule<T = NumString, U = boolean | T, V = LoggerFormat<T
     unknown?: boolean | LoggerColor;
     system?: boolean | LoggerColor;
     node?: boolean | LoggerColor;
-    process?: boolean | LoggerColor & { cpu?: boolean; cpu_bar?: boolean | ArrayOf<number>; cpu_single_core?: boolean; mem?: boolean; mem_format?: "%" | Unit };
+    process?: boolean | LoggerProcessSettings;
     image?: boolean | LoggerColor;
     compress?: boolean | LoggerColor;
     watch?: boolean | LoggerColor;
@@ -363,11 +368,30 @@ export interface LoggerMeterSettings<T = NumString> {
     process?: T;
 }
 
+export interface LoggerProcessSettings extends LoggerColor {
+    cpu?: boolean;
+    cpu_bar?: boolean | ArrayOf<number>;
+    cpu_single_core?: boolean;
+    mem?: boolean;
+    mem_format?: "%" | Unit;
+}
+
+export interface LoggerFormat<T = NumString> {
+    width?: T;
+    color?: ForegroundColor;
+    bg_color?: BackgroundColor;
+    bg_alt_color?: BackgroundColor;
+    bold?: boolean;
+    justify?: TextAlign;
+    unit?: string;
+    as?: StringMap;
+}
+
 export interface HttpSettings {
     version?: NumString;
     timeout?: NumString;
     headers?: HttpOutgoingHeaders;
-    certs?: ObjectMap<SecureConfig<StringOfArray>>;
+    certs?: ObjectMap<SecureConfig<ArrayOf<string>>>;
 }
 
 export interface HttpDiskSettings extends IncludeAction {
@@ -405,46 +429,26 @@ export interface HashConfig extends IncludeAction<ObjectMap<string[] | "*">> {
     limit?: NumString;
 }
 
-export interface SecureConfig<T = string, U = T> {
-    ca?: T;
-    key?: U;
-    cert?: T;
-    passphrase?: U;
-    version?: SecureVersion;
-}
-
-export interface ServerPort<T = NumString> {
-    port?: T;
-}
-
-export interface ServerInfo<T = NumString> extends ServerPort<T> {
-    enabled?: boolean;
-    secure?: SecureConfig & ServerPort<T>;
-}
-
-export interface ServerSecure extends SecureConfig, ServerPort {}
-
 export interface BroadcastServer extends ServerInfo<ArrayOf<NumString>> {
     out?: string | BroadcastOutMethod;
 }
 
 export interface ExecOptions extends SpawnOptions {
     command?: string;
-    warn?: StringOfArray;
-}
-
-export interface ExecAction {
-    uid?: NumString;
-    gid?: NumString;
+    warn?: ArrayOf<string>;
 }
 
 export interface PurgeAction {
     purge?: PurgeComponent;
 }
 
-export interface IncludeAction<T = string[]> {
-    include?: T;
-    exclude?: T;
+export interface PoolConfig<T = number> extends MinMax {
+    idle?: T;
+    queue_max?: number;
+    queue_idle?: T;
+    purge?: T;
+    timeout?: number;
+    socket_timeout?: number;
 }
 
 export interface CipherConfig {
@@ -453,12 +457,12 @@ export interface CipherConfig {
     iv?: BinaryLike;
 }
 
-export type DbSourceDataType<T = unknown> = {
-    [K in DbSource]?: T;
-};
+export interface ServerInfo<T = NumString> extends ServerPort<T> {
+    enabled?: boolean;
+    secure?: SecureConfig & ServerPort<T>;
+}
 
 export type WatchUserSettings = ObjectMap<WatchInterval>;
 export type DocumentTransform = Null<boolean | "etag" | HashAlgorithm | HashConfig>;
-export type HashAlgorithm = "md5" | "sha1" | "sha256" | "sha224" | "sha384" | "sha512";
 
-export type { PermissionReadWrite };
+export type { ExecAction, PermissionReadWrite, SecureConfig };

package/lib/squared.d.ts

@@ -36,7 +36,7 @@ interface BoxRectDimension extends BoxRect, Dimension {
 }
 
 export interface FileAsset extends TextAsset, OutputAction, DocumentAction, MultipartAction, ResourceAction, IncrementalAction, ChecksumAction {
-    format?: StringOfArray;
+    format?: ArrayOf<string>;
     dataView?: NodeJS.ArrayBufferView;
     base64?: string;
     imported?: boolean | string[];
@@ -61,13 +61,13 @@ export interface DataSource<T = unknown> extends DocumentAction {
 export interface DbDataSource<T = unknown, U = unknown, V = unknown, W = unknown, X = unknown> extends DataSource<T> {
     name?: string;
     table?: string;
-    credential?: W;
+    credential?: string | W;
     options?: U;
     update?: V;
-    withCommand?: string | [string, string];
+    withCommand?: string | TupleOf<string>;
     parallel?: boolean;
     willAbort?: boolean;
-    streamRow?: Null<boolean | string | ((row: unknown) => Undef<Error | false>)>;
+    streamRow?: Null<boolean | string | ((row: unknown) => Void<Error | false>)>;
     usePool?: boolean | X;
 }
 
@@ -95,7 +95,7 @@ export interface BundleAction<T = unknown> {
     bundleIndex?: number;
     bundleReplace?: T;
     bundleQueue?: Promise<unknown>[];
-    trailingContent?: StringOfArray;
+    trailingContent?: ArrayOf<string>;
     exported?: boolean;
 }
 
@@ -105,7 +105,7 @@ export interface ChecksumAction {
 }
 
 export interface DocumentAction {
-    document?: StringOfArray;
+    document?: ArrayOf<string>;
     encoding?: BufferEncoding;
 }
 
@@ -242,7 +242,7 @@ export interface WatchReload extends WebSocketClient {
 
 export interface WebSocketResponse {
     event?: string;
-    socketId?: StringOfArray;
+    socketId?: ArrayOf<string>;
     type?: string;
     encoding?: BufferEncoding;
     value?: unknown;
@@ -274,10 +274,11 @@ export interface FileInfo {
 export interface RequestBase<T = PlainObject> {
     baseUrl?: string;
     priority?: number;
-    broadcastId?: StringOfArray;
-    log?: boolean | StringOfArray | T;
-    error?: { abort?: boolean | StringOfArray; fatal?: boolean };
-    ignoreExtensions?: boolean | StringOfArray;
+    threads?: number;
+    broadcastId?: ArrayOf<string>;
+    log?: boolean | ArrayOf<string> | T;
+    error?: { abort?: boolean | ArrayOf<string>; fatal?: boolean };
+    ignoreExtensions?: boolean | ArrayOf<string>;
 }
 
 export interface RequestData extends RequestBase, ImportAction<StringMap>, IncrementalAction {
@@ -356,8 +357,8 @@ export interface ChecksumBase<T = BinaryToTextEncoding> {
 
 export interface ChecksumOutput<T = BinaryToTextEncoding> extends ChecksumBase<T> {
     filename?: string;
-    include?: StringOfArray;
-    exclude?: StringOfArray;
+    include?: ArrayOf<string>;
+    exclude?: ArrayOf<string>;
     recursive?: boolean | 1;
 }
 

package/lib/type.d.ts

@@ -1,4 +1,4 @@
-/* eslint @typescript-eslint/no-explicit-any: "off" */
+/* eslint @typescript-eslint/no-explicit-any: "off", @typescript-eslint/no-redeclare: "off" */
 
 type Undef<T> = T | undefined;
 type Null<T> = T | null;
@@ -18,11 +18,10 @@ type NumString = number | string;
 type ArrayOf<T> = T | T[];
 type TupleOf<T> = [T, T];
 type FirstOf<T, U = boolean> = T[] | [U, ...T[]];
-type StringOfArray = ArrayOf<string>;
-type BufferContent = string | Buffer;
+type Bufferable = string | Buffer;
 
 type AnyObject = Record<string, unknown>;
-type PlainObject = Record<NumString | symbol, unknown>;
+type PlainObject = Record<string | number | symbol, unknown>;
 
 type StandardMap = Record<string, any>;
 type StringMap = Record<string, Undef<string>>;

package/lib/watch.d.ts

@@ -3,7 +3,7 @@ import type { DataSource, WatchResponse } from './squared';
 import type { ExternalAsset } from './asset';
 import type { IAbortComponent } from './core';
 import type { PostFinalizeCallback } from './filemanager';
-import type { SecureConfig } from './settings';
+import type { SecureConfig } from './http';
 
 import type { WatchEventValue } from '../index.d';
 
@@ -27,7 +27,7 @@ export interface IFileGroup<T extends ExternalAsset = ExternalAsset> extends IAb
     always: boolean;
     id?: string;
     url?: URL;
-    document?: StringOfArray;
+    document?: ArrayOf<string>;
     main?: T;
     bundleMain?: T;
     sourceFiles?: string[];
@@ -44,7 +44,7 @@ export interface IFileGroup<T extends ExternalAsset = ExternalAsset> extends IAb
     get server(): Null<ws.Server>;
     set related(value);
     get related(): T[];
-    get socketId(): StringOfArray;
+    get socketId(): ArrayOf<string>;
     set etag(value: unknown);
     get etag(): string;
     set lastModified(value: unknown);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/types",
-  "version": "0.8.7",
+  "version": "0.9.0",
   "description": "Type definitions for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -20,10 +20,9 @@
   "license": "BSD 3-Clause",
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
-    "bytes": "^3.1.2",
-    "uuid": "^9.0.1"
+    "bytes": "^3.1.2"
   },
   "devDependencies": {
-    "typescript": "5.3.3"
+    "typescript": "5.4.5"
   }
 }