@e-mc/types 0.10.1 → 0.10.3

package/lib/db.d.ts

@@ -1,110 +1,108 @@
-import type { DataSource, DbDataSource } from './squared';
-
-import type { CacheOptions, IdentifierAction } from './core';
-
-import type { DB_TYPE } from '../index.d';
-
-export interface ExecuteAction<T = unknown> {
-    params?: T;
-}
-
-export interface CascadeAction {
-    cascade?: string;
-    cacheObjectKey?: string;
-    fallback?: unknown;
-}
-
-export interface ExecuteQueryOptions {
-    checkObject?: CheckObjectCallback | string;
-    checkObjectKey?: string;
-    errorQuery?: ErrorQueryCallback;
-    sessionKey?: string;
-    outCacheMiss?: string[];
-}
-
-export interface ExecuteBatchQueryOptions extends ExecuteQueryOptions {
-    parallel?: boolean;
-    connectOnce?: boolean;
-}
-
-export interface ProcessRowsOptions {
-    disconnect?: () => void;
-    parallel?: boolean;
-}
-
-export interface DbConnection {
-    hostname: string;
-    password: string;
-    pathname: string;
-    port: string;
-    protocol: string;
-    search: string;
-    username: string;
-    database: string;
-}
-
-export interface HandleFailOptions {
-    commandType?: number;
-    errorQuery?: ErrorQueryCallback;
-}
-
-export interface ServerAuth<T = number> extends AuthValue, IdentifierAction {
-    protocol?: string;
-    server?: string;
-    hostname?: string;
-    port?: T;
-    database?: string;
-}
-
-export interface IDbPool<T extends DbDataSource = DbDataSource, U = unknown, V = unknown, W = unknown> {
-    client: U;
-    lastAccessed: number;
-    success: number;
-    failed: number;
-    poolKey: string;
-    uuidKey: Null<AuthValue>;
-    add(item: T, uuidKey?: string): this;
-    has(item: T): boolean;
-    getConnection(credential?: W): Promise<V>;
-    remove(): void;
-    detach(force?: boolean): Promise<void>;
-    close(): Promise<void>;
-    isIdle(timeout: number): boolean;
-    isEmpty(): boolean;
-    set connected(value: boolean);
-    get persist(): boolean;
-    get closed(): boolean;
-    get closeable(): boolean;
-    set parent(value: ObjectMap<IDbPool<T>>);
-}
-
-export interface DbPoolConstructor<T extends DbDataSource = DbDataSource, U = unknown, V = unknown, W = unknown> {
-    CACHE_UNUSED: readonly string[];
-    asString(credential: unknown): string;
-    sanitize(credential: unknown): unknown;
-    removeUUIDKey<X>(credential: X & IdentifierAction): X;
-    findKey<X extends IDbPool, Y extends DbDataSource>(pools: ObjectMap<X>, uuidKey: unknown, poolKey: Undef<string>, ...items: Y[]): Null<X>;
-    validateKey<X extends IDbPool>(pools: ObjectMap<X>, username: string, uuidKey: unknown): [string, Null<X>];
-    checkTimeout<X extends IDbPool>(pools: ObjectMap<X>, value: number, limit?: number): Promise<number>;
-    readonly prototype: IDbPool<T, U, V, W>;
-    new(pool: U, poolKey: string, uuidKey?: Null<AuthValue>): IDbPool<T, U, V, W>;
-}
-
-export interface TimeoutAction {
-    timeout?: number | string;
-}
-
-export type DbSource = "mariadb" | "mongodb" | "mssql" | "mysql" | "oracle" | "postgres" | "redis";
-export type QueryResult = unknown[];
-export type BatchQueryResult = Null<QueryResult>[];
-export type CheckObjectCallback = (item: DataSource, data: unknown) => Null<QueryResult>;
-export type ErrorQueryCallback = (err: unknown, item: DbDataSource, commandType?: number) => boolean;
-
-export interface SQL_COMMAND {
-    SELECT: 1;
-    INSERT: 2;
-    UPDATE: 3;
-    DELETE: 4;
-}
-
+import type { DataSource, DbDataSource } from './squared';
+
+import type { CacheOptions, IdentifierAction } from './core';
+
+import type { DB_TYPE } from '../index.d';
+
+export interface ExecuteAction<T = unknown> {
+    params?: T;
+}
+
+export interface CascadeAction {
+    cascade?: string;
+    cacheObjectKey?: string;
+    fallback?: unknown;
+}
+
+export interface ExecuteQueryOptions {
+    checkObject?: CheckObjectCallback | string;
+    checkObjectKey?: string;
+    errorQuery?: ErrorQueryCallback;
+    sessionKey?: string;
+    outCacheMiss?: string[];
+}
+
+export interface ExecuteBatchQueryOptions extends ExecuteQueryOptions {
+    parallel?: boolean;
+    connectOnce?: boolean;
+}
+
+export interface ProcessRowsOptions {
+    disconnect?: () => void;
+    parallel?: boolean;
+}
+
+export interface DbConnection extends Required<AuthValue> {
+    protocol: string;
+    hostname: string;
+    port: string;
+    pathname: string;
+    search: string;
+    database: string;
+}
+
+export interface HandleFailOptions {
+    commandType?: number;
+    errorQuery?: ErrorQueryCallback;
+}
+
+export interface ServerAuth<T = number> extends AuthValue, IdentifierAction {
+    protocol?: string;
+    server?: string;
+    hostname?: string;
+    port?: T;
+    database?: string;
+}
+
+export interface IDbPool<T extends DbDataSource = DbDataSource, U = unknown, V = unknown, W = unknown> {
+    client: U;
+    lastAccessed: number;
+    success: number;
+    failed: number;
+    poolKey: string;
+    uuidKey: Null<AuthValue>;
+    add(item: T, uuidKey?: string): this;
+    has(item: T): boolean;
+    getConnection(credential?: W): Promise<V>;
+    remove(): void;
+    detach(force?: boolean): Promise<void>;
+    close(): Promise<void>;
+    isIdle(timeout: number): boolean;
+    isEmpty(): boolean;
+    set connected(value: boolean);
+    get persist(): boolean;
+    get closed(): boolean;
+    get closeable(): boolean;
+    set parent(value: ObjectMap<IDbPool<T>>);
+}
+
+export interface DbPoolConstructor<T extends DbDataSource = DbDataSource, U = unknown, V = unknown, W = unknown> {
+    CACHE_UNUSED: readonly string[];
+    asString(credential: unknown): string;
+    sanitize(credential: unknown): unknown;
+    removeUUIDKey<X>(credential: X & IdentifierAction): X;
+    findKey<X extends IDbPool, Y extends DbDataSource>(pools: ObjectMap<X>, uuidKey: unknown, poolKey: Undef<string>, ...items: Y[]): Null<X>;
+    validateKey<X extends IDbPool>(pools: ObjectMap<X>, username: string, uuidKey: unknown): [string, Null<X>];
+    checkTimeout<X extends IDbPool>(pools: ObjectMap<X>, value: number, limit?: number): Promise<number>;
+    readonly prototype: IDbPool<T, U, V, W>;
+    new(pool: U, poolKey: string, uuidKey?: Null<AuthValue>): IDbPool<T, U, V, W>;
+}
+
+export interface TimeoutAction {
+    timeout?: number | string;
+}
+
+export type DbSource = "mariadb" | "mongodb" | "mssql" | "mysql" | "oracle" | "postgres" | "redis";
+export type QueryResult = unknown[];
+export type BatchQueryResult = Null<QueryResult>[];
+export type CheckObjectCallback = (item: DataSource, data: unknown) => Null<QueryResult>;
+export type ErrorQueryCallback = (err: unknown, item: DbDataSource, commandType?: number) => boolean;
+
+export interface SQL_COMMAND {
+    SELECT: 1;
+    INSERT: 2;
+    UPDATE: 3;
+    DELETE: 4;
+}
+
 export type { DB_TYPE, CacheOptions, IdentifierAction };

package/lib/document.d.ts

@@ -1,200 +1,200 @@
-import type { LocationUri, MimeTypeAction, StorageAction } from './squared';
-
-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 { DocumentTransform } from './settings';
-
-export interface DocumentAsset extends ExternalAsset, StorageAction<CloudStorage> {
-    inlineFilename?: string;
-    initialValue?: InitialValue & { inlineFilename?: string };
-}
-
-export interface StartOfSourceMap {
-    file?: string;
-    sourceRoot?: string;
-}
-
-export interface RawSourceMap<T = number | string> extends StartOfSourceMap {
-    version: T;
-    sources: string[];
-    names: string[];
-    sourcesContent?: string[];
-    mappings: string;
-}
-
-export interface SourceInput<T = [string, string?, string?][]> {
-    code?: string;
-    sourceFile?: T;
-    sourceName?: string;
-    sourcesRelativeTo?: string;
-}
-
-export interface SourceCode {
-    code: string;
-    map?: RawSourceMap;
-    sourceMappingURL?: string;
-}
-
-export interface ChunkFile {
-    code: string;
-    filename?: string;
-    entryPoint?: boolean;
-}
-
-export interface ChunkData extends ChunkFile {
-    sourceMap?: SourceMap;
-}
-
-export interface CacheData {
-    uri?: string;
-    etag?: string;
-    encoding?: BufferEncoding;
-    override?: boolean;
-}
-
-export interface TransformAction {
-    cacheData?: CacheData;
-}
-
-export interface TransformResult extends SourceCode {
-    type?: string;
-    chunks?: Null<(SourceCode & ChunkFile)[]>;
-    sourceFiles?: string[];
-}
-
-export interface TransformOutput extends Partial<LocationUri>, Omit<SourceInput<string>, "code">, MimeTypeAction {
-    imported?: boolean;
-    sourceMap?: SourceMap;
-    metadata?: unknown;
-    external?: PlainObject;
-    productionRelease?: boolean;
-    getMainFile?(code?: string, imports?: StringMap): Undef<SourceInput<string>>;
-    getSourceFiles?(imports?: StringMap): Undef<SourceInput>;
-}
-
-export interface TransformOptions<T = AnyObject, U = T> extends TransformOutput {
-    baseConfig: T;
-    outputConfig: U;
-    sourceMap: SourceMap;
-    supplementChunks: ChunkData[];
-}
-
-export interface ITransformSeries<T = AnyObject, U = T> extends IModule, TransformOptions<T, U> {
-    readonly type: string;
-    init(instance: IModule, dirname?: string): this;
-    close(instance: IModule): void;
-    createSourceMap(value: string): SourceMap;
-    getMainFile(code?: string, imports?: StringMap): Undef<SourceInput<string>>;
-    getSourceFiles(imports?: StringMap): Undef<SourceInput>;
-    toBaseConfig(all?: boolean): T;
-    upgrade<V = unknown>(context: V, dirname?: string, pkgname?: string): V;
-    upgradeESM<V = unknown>(context: V, dirname?: string, pkgname?: string): Promise<V>;
-    set code(value);
-    get code(): string;
-    get out(): IOut;
-    get metadata(): object;
-    get options(): TransformOutput;
-    get productionRelease(): boolean;
-    get imported(): boolean;
-    set version(value);
-    get version(): string;
-    set packageName(value);
-    get packageName(): string;
-    get packageVersion(): string;
-    get username(): string;
-}
-
-export interface TransformSeriesConstructor {
-    readonly prototype: ITransformSeries;
-    new(type: string, code: string, options: TransformOutput): ITransformSeries;
-}
-
-export interface IOut extends OutV3, OutV4 {}
-
-export interface OutV3 {
-    sourceFiles?: string[];
-    ignoreCache?: boolean;
-    logAppend?: LogComponent[];
-    messageAppend?: string;
-}
-
-export interface OutV4 {
-    logQueued?: LogComponent[];
-}
-
-export interface SourceMapOptions extends MimeTypeAction {
-    file?: string;
-    hash?: string;
-    sourceRoot?: string;
-    sourceMappingURL?: string;
-    inlineMap?: boolean;
-    emptySources?: boolean;
-}
-
-export interface SourceMap extends SourceCode {
-    output: Map<string, SourceCode>;
-    reset(): void;
-    nextMap(name: string, code: string, map: unknown, sourceMappingURL?: string, emptySources?: boolean): boolean;
-    set map(value);
-    get map(): Undef<RawSourceMap>;
-}
-
-export interface SourceMapConstructor {
-    findSourceMap(code?: string, uri?: string): Undef<RawSourceMap>;
-    removeSourceMappingURL(value: string): [string, string?, Null<RawSourceMap>?];
-    isRaw(map: unknown): map is RawSourceMap;
-    readonly prototype: SourceMap;
-    new(code: string, remove: boolean): SourceMap;
-    new(code: string, uri?: string, remove?: boolean): SourceMap;
-}
-
-export interface ImportMap {
-    imports?: StringMap;
-    scopes?: ObjectMap<StringMap>;
-}
-
-export interface UpdateGradleOptions {
-    multiple?: boolean;
-    addendum?: string;
-    upgrade?: boolean;
-    updateOnly?: boolean;
-}
-
-export interface LintMessage {
-    ruleId: string;
-    message: string;
-    line: number;
-    column: number;
-    endLine?: number;
-    endColumn?: number;
-    severity?: 0 | 1 | 2 | "" | "error" | "warning";
-    fatal?: boolean;
-}
-
-export interface GenerateLintTableOptions extends Partial<LocationUri> {
-    leadingText?: string;
-    trailingText?: string;
-    errorCount?: number | TupleOf<number>;
-    warningCount?: number | TupleOf<number>;
-    fatalErrorCount?: number;
-    timeStamp?: LogDate;
-    ruleWidth?: number;
-    messageWidth?: number;
-}
-
-export interface CustomizeOptions {
-    transform?: DocumentTransform;
-}
-
-export interface AsSourceFileOptions {
-    encoding?: BufferEncoding;
-    persist?: boolean;
-    cache?: boolean;
-}
-
-export type Transformer = FunctionType<Undef<Promise<string> | string>>;
-export type ConfigOrTransformer = AnyObject | Transformer;
-export type PluginConfig = [string, Undef<ConfigOrTransformer>, Undef<AnyObject>, boolean?] | [];
+import type { LocationUri, MimeTypeAction, StorageAction } from './squared';
+
+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 { DocumentTransform } from './settings';
+
+export interface DocumentAsset extends ExternalAsset, StorageAction<CloudStorage> {
+    inlineFilename?: string;
+    initialValue?: InitialValue & { inlineFilename?: string };
+}
+
+export interface StartOfSourceMap {
+    file?: string;
+    sourceRoot?: string;
+}
+
+export interface RawSourceMap<T = number | string> extends StartOfSourceMap {
+    version: T;
+    sources: string[];
+    names: string[];
+    sourcesContent?: string[];
+    mappings: string;
+}
+
+export interface SourceInput<T = [string, string?, string?][]> {
+    code?: string;
+    sourceFile?: T;
+    sourceName?: string;
+    sourcesRelativeTo?: string;
+}
+
+export interface SourceCode {
+    code: string;
+    map?: RawSourceMap;
+    sourceMappingURL?: string;
+}
+
+export interface ChunkFile {
+    code: string;
+    filename?: string;
+    entryPoint?: boolean;
+}
+
+export interface ChunkData extends ChunkFile {
+    sourceMap?: SourceMap;
+}
+
+export interface CacheData {
+    uri?: string;
+    etag?: string;
+    encoding?: BufferEncoding;
+    override?: boolean;
+}
+
+export interface TransformAction {
+    cacheData?: CacheData;
+}
+
+export interface TransformResult extends SourceCode {
+    type?: string;
+    chunks?: Null<(SourceCode & ChunkFile)[]>;
+    sourceFiles?: string[];
+}
+
+export interface TransformOutput extends Partial<LocationUri>, Omit<SourceInput<string>, "code">, MimeTypeAction {
+    imported?: boolean;
+    sourceMap?: SourceMap;
+    metadata?: unknown;
+    external?: PlainObject;
+    productionRelease?: boolean;
+    getMainFile?(code?: string, imports?: StringMap): Undef<SourceInput<string>>;
+    getSourceFiles?(imports?: StringMap): Undef<SourceInput>;
+}
+
+export interface TransformOptions<T = AnyObject, U = T> extends TransformOutput {
+    baseConfig: T;
+    outputConfig: U;
+    sourceMap: SourceMap;
+    supplementChunks: ChunkData[];
+}
+
+export interface ITransformSeries<T = AnyObject, U = T> extends IModule, TransformOptions<T, U> {
+    readonly type: string;
+    init(instance: IModule, dirname?: string): this;
+    close(instance: IModule): void;
+    createSourceMap(value: string): SourceMap;
+    getMainFile(code?: string, imports?: StringMap): Undef<SourceInput<string>>;
+    getSourceFiles(imports?: StringMap): Undef<SourceInput>;
+    toBaseConfig(all?: boolean): T;
+    upgrade<V = unknown>(context: V, dirname?: string, pkgname?: string): V;
+    upgradeESM<V = unknown>(context: V, dirname?: string, pkgname?: string): Promise<V>;
+    set code(value);
+    get code(): string;
+    get out(): IOut;
+    get metadata(): object;
+    get options(): TransformOutput;
+    get productionRelease(): boolean;
+    get imported(): boolean;
+    set version(value);
+    get version(): string;
+    set packageName(value);
+    get packageName(): string;
+    get packageVersion(): string;
+    get username(): string;
+}
+
+export interface TransformSeriesConstructor {
+    readonly prototype: ITransformSeries;
+    new(type: string, code: string, options: TransformOutput): ITransformSeries;
+}
+
+export interface IOut extends OutV3, OutV4 {}
+
+export interface OutV3 {
+    sourceFiles?: string[];
+    ignoreCache?: boolean;
+    logAppend?: LogComponent[];
+    messageAppend?: string;
+}
+
+export interface OutV4 {
+    logQueued?: LogComponent[];
+}
+
+export interface SourceMapOptions extends MimeTypeAction {
+    file?: string;
+    hash?: string;
+    sourceRoot?: string;
+    sourceMappingURL?: string;
+    inlineMap?: boolean;
+    emptySources?: boolean;
+}
+
+export interface SourceMap extends SourceCode {
+    output: Map<string, SourceCode>;
+    reset(): void;
+    nextMap(name: string, code: string, map: unknown, sourceMappingURL?: string, emptySources?: boolean): boolean;
+    set map(value);
+    get map(): Undef<RawSourceMap>;
+}
+
+export interface SourceMapConstructor {
+    findSourceMap(code?: string, uri?: string): Undef<RawSourceMap>;
+    removeSourceMappingURL(value: string): [string, string?, Null<RawSourceMap>?];
+    isRaw(map: unknown): map is RawSourceMap;
+    readonly prototype: SourceMap;
+    new(code: string, remove: boolean): SourceMap;
+    new(code: string, uri?: string, remove?: boolean): SourceMap;
+}
+
+export interface ImportMap {
+    imports?: StringMap;
+    scopes?: ObjectMap<StringMap>;
+}
+
+export interface UpdateGradleOptions {
+    multiple?: boolean;
+    addendum?: string;
+    upgrade?: boolean;
+    updateOnly?: boolean;
+}
+
+export interface LintMessage {
+    ruleId: string;
+    message: string;
+    line: number;
+    column: number;
+    endLine?: number;
+    endColumn?: number;
+    severity?: 0 | 1 | 2 | "" | "error" | "warning";
+    fatal?: boolean;
+}
+
+export interface GenerateLintTableOptions extends Partial<LocationUri> {
+    leadingText?: string;
+    trailingText?: string;
+    errorCount?: number | TupleOf<number>;
+    warningCount?: number | TupleOf<number>;
+    fatalErrorCount?: number;
+    timeStamp?: LogDate;
+    ruleWidth?: number;
+    messageWidth?: number;
+}
+
+export interface CustomizeOptions {
+    transform?: DocumentTransform;
+}
+
+export interface AsSourceFileOptions {
+    encoding?: BufferEncoding;
+    persist?: boolean;
+    cache?: boolean;
+}
+
+export type Transformer = FunctionType<Undef<Promise<string> | string>>;
+export type ConfigOrTransformer = AnyObject | Transformer;
+export type PluginConfig = [string, Undef<ConfigOrTransformer>, Undef<AnyObject>, boolean?] | [];
 export type TransformCallback<T extends IFileManager<U>, U extends ExternalAsset = ExternalAsset> = (this: T, instance: IDocument<T, U>, requireOrDocumentDir?: NodeJS.Require | string) => Void<Promise<void>>;