@e-mc/types 0.7.0 → 0.8.0

package/constant.d.ts

@@ -1,11 +1,12 @@
 export const enum INTERNAL {
-    VERSION = '0.7.0',
+    VERSION = '0.8.0',
     TEMP_DIR = 'tmp', // eslint-disable-line @typescript-eslint/no-shadow
     CJS = '__cjs__'
 }
 
 export const enum VAL_MESSAGE {
     SUCCESS = 'Success',
+    COMPLETED = 'Completed',
     MODIFIED_DIRECTORY = 'Directory was modified',
     COMMIT_TRANSACTION = 'Transactions were committed'
 }
@@ -35,6 +36,9 @@ export const enum ERR_MESSAGE {
     FAIL = 'FAIL!',
     WARN = 'WARN!',
     ABORTED = 'Aborted',
+    ABORTED_HOST = 'Aborted by host',
+    ABORTED_CLIENT = 'Aborted by client',
+    ABORTED_PROCESS = 'Aborted by process',
     ABORTED_OPERATION = 'The operation was aborted',
     FAILED = 'Failed',
     FAILED_CHECKSUM = 'Checksum did not match',

package/index.d.ts

@@ -281,11 +281,12 @@ declare namespace types {
     function cloneObject<T>(data: T, deepIgnore: WeakSet<object>): T;
     function cloneObject<T, U>(data: T, options?: CloneObjectOptions<U>): T;
     function coerceObject<T = unknown>(data: T, cache: boolean): T;
-    function coerceObject<T = unknown>(data: T, parseString?: FunctionArgs<[string], unknown>, cache?: boolean): T;
+    function coerceObject<T = unknown>(data: T, parseString?: FunctionArgs<[string]>, cache?: boolean): T;
     function getEncoding(value: unknown, fallback?: BufferEncoding): BufferEncoding;
     function encryptUTF8(algorithm: CipherGCMTypes, key: BinaryLike, iv: BinaryLike, data: string, encoding?: Encoding): Undef<string>;
     function decryptUTF8(algorithm: CipherGCMTypes, key: BinaryLike, iv: BinaryLike, data: string, encoding?: Encoding): Undef<string>;
     function generateUUID(): string;
+    function incrementUUID(restart?: boolean): string;
     function validateUUID(value: unknown): boolean;
     function randomString(format: string, dictionary?: string): string;
     function errorValue(value: string, hint?: string): Error;

package/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.errorValue = exports.validateUUID = exports.randomString = exports.decryptUTF8 = exports.encryptUTF8 = exports.getEncoding = exports.asFunction = exports.coerceObject = exports.cloneObject = exports.cascadeObject = exports.formatSize = exports.renameExt = exports.escapePattern = exports.hasGlob = exports.convertTime = exports.formatTime = exports.parseExpires = exports.parseTime = exports.isEmpty = exports.isString = exports.isObject = exports.isPlainObject = exports.isArray = exports.setTempDir = exports.getTempDir = exports.setLogCurrent = exports.getLogCurrent = exports.existsFlag = exports.mainFlag = exports.processFlag = exports.modifiedFlag = exports.watchFlag = exports.usingFlag = exports.cloneFlag = exports.ignoreFlag = exports.hasBit = exports.createAbortError = exports.IMPORT_MAP = exports.THRESHOLD = exports.READDIR_SORT = exports.WATCH_EVENT = exports.DB_TRANSACTION = exports.DB_TYPE = exports.FETCH_TYPE = exports.DOWNLOAD_TYPE = exports.ERR_CODE = exports.ASSET_FLAG = exports.FILE_TYPE = exports.STATUS_TYPE = exports.LOG_TYPE = void 0;
-exports.generateUUID = exports.purgeMemory = exports.errorMessage = void 0;
+exports.generateUUID = exports.incrementUUID = exports.purgeMemory = exports.errorMessage = void 0;
 const path = require("path");
 const fs = require("fs");
 const crypto = require("crypto");
@@ -20,6 +20,8 @@ const ASYNC_FUNCTION = Object.getPrototypeOf(async () => { }).constructor;
 let CACHE_COERCED = new WeakSet();
 let LOG_CURRENT = null;
 let TEMP_DIR = path.join(process.cwd(), "tmp" /* INTERNAL.TEMP_DIR */);
+let INCREMENT_COUNT = 65536;
+let INCREMENT_PREFIX = '';
 function fromObject(value, typedArray) {
     if (isObject(value)) {
         if (value instanceof Map) {
@@ -402,7 +404,7 @@ function isArray(value) {
 }
 exports.isArray = isArray;
 function isPlainObject(value) {
-    return value && typeof value === 'object' ? value.constructor === Object || Object.getPrototypeOf(value) === null : false;
+    return typeof value === 'object' && value !== null && (value.constructor === Object || Object.getPrototypeOf(value) === null);
 }
 exports.isPlainObject = isPlainObject;
 function isObject(value) {
@@ -549,10 +551,10 @@ function escapePattern(value, lookBehind) {
 }
 exports.escapePattern = escapePattern;
 function renameExt(value, ext, when) {
-    if (ext[0] !== '.') {
+    if (!ext.startsWith('.')) {
         ext = '.' + ext;
     }
-    if (when && when[0] !== '.') {
+    if (when && !when.startsWith('.')) {
         when = '.' + when;
     }
     const index = value.lastIndexOf('.');
@@ -574,7 +576,7 @@ function formatSize(value, options) {
 exports.formatSize = formatSize;
 function cascadeObject(data, query, fallback) {
     if (isObject(data) && isString(query)) {
-        const names = query.trim().split(/(?<!\\)\./).map(item => item.indexOf('.') !== -1 ? item.replace(/\\(?=\.)/g, '') : item);
+        const names = query.trim().split(/(?<!\\)\./).map(item => item.includes('.') ? item.replace(/\\(?=\.)/g, '') : item);
         for (let i = 0, length = names.length, match, current = data; i < length; ++i) {
             if (!(match = /^(.+?)(?:\[(.+)\])?$/.exec(names[i]))) {
                 break;
@@ -730,7 +732,7 @@ function coerceObject(data, parseString, cache) {
                                 default: {
                                     const text = match[2].trim();
                                     let values = []; // eslint-disable-line @typescript-eslint/no-explicit-any
-                                    if (text[0] === '[' && text[text.length - 1] === ']') {
+                                    if (text.startsWith('[') && text.endsWith(']')) {
                                         values = JSON.parse(text);
                                     }
                                     else if (text) {
@@ -855,7 +857,7 @@ function randomString(format, dictionary) {
                 dictionary || (dictionary = '0123456789abcdef');
                 const result = format.match(/(\d+|[^\d[]+|\[[^\]]+\]|\[)/g).reduce((a, b) => {
                     let length, available;
-                    if (b[0] === '[' && b[b.length - 1] === ']') {
+                    if (b.startsWith('[') && b.endsWith(']')) {
                         length = 1;
                         available = b.substring(1, b.length - 1);
                     }
@@ -907,4 +909,12 @@ function purgeMemory(percent) {
     CACHE_COERCED = new WeakSet();
 }
 exports.purgeMemory = purgeMemory;
+function incrementUUID(restart) {
+    if (restart || INCREMENT_COUNT === 65536) {
+        INCREMENT_COUNT = 0;
+        INCREMENT_PREFIX = (0, exports.generateUUID)().substring(0, 33);
+    }
+    return INCREMENT_PREFIX + (INCREMENT_COUNT++).toString(16).padStart(4, '0');
+}
+exports.incrementUUID = incrementUUID;
 exports.generateUUID = typeof crypto.randomUUID === 'function' ? crypto.randomUUID.bind(crypto) : uuid.v4;

package/lib/core.d.ts

@@ -6,7 +6,7 @@ import type { IExternalConfig, IExternalFunction, IHost, IModule, ModuleConstruc
 import type { QueryResult, TimeoutAction } from './db';
 import type { AddEventListenerOptions } from './dom';
 import type { Settings } from './node';
-import type { ClientDBSettings, ClientModule, DbCacheValue, DbCoerceSettings, DbCoerceValue, DbSourceOptions } from './settings';
+import type { ClientDbSettings, ClientModule, DbCacheValue, DbCoerceSettings, DbCoerceValue, DbSourceOptions } from './settings';
 
 export interface IdentifierAction {
     uuidKey?: string;
@@ -14,6 +14,7 @@ export interface IdentifierAction {
 
 export interface IClient<T extends IHost, U extends ClientModule, V extends FunctionType = FunctionType> extends IModule<T>, IExternalConfig<U, U extends ClientModule<infer W> ? W : unknown>, IExternalFunction<V> {
     init(...args: unknown[]): this;
+    getUserSettings<X>(): Null<X>;
     set cacheDir(value: string);
     get cacheDir(): string;
 }
@@ -23,7 +24,7 @@ export interface ClientConstructor<T extends IHost = IHost, U extends ClientModu
     new(module?: U): IClient<T, U>;
 }
 
-export interface IClientDb<T extends IHost, U extends ClientModule<ClientDBSettings>, V extends DataSource = DataSource, W extends DbSourceOptions = DbSourceOptions, X extends DbCoerceSettings = DbCoerceSettings> extends IClient<T, U> {
+export interface IClientDb<T extends IHost, U extends ClientModule<ClientDbSettings>, V extends DataSource = DataSource, W extends DbSourceOptions = DbSourceOptions, X extends DbCoerceSettings = DbCoerceSettings> extends IClient<T, U> {
     database: V[];
     cacheExpires: number;
     add(item: V, state?: number): void;
@@ -109,6 +110,7 @@ export interface PermissionConstructor {
     validate(settings: unknown): settings is PermittedDirectories;
     clone(permission: IPermission, freeze?: boolean): IPermission;
     match(pathname: string, pattern: StringOfArray): boolean;
+    toPosix(value: unknown): StringOfArray;
     readonly prototype: IPermission;
     new(freeze?: boolean): IPermission;
 }

package/lib/document.d.ts

@@ -148,6 +148,11 @@ export interface SourceMapConstructor {
     new(code: string, uri?: string, remove?: boolean): SourceMap;
 }
 
+export interface ImportMap {
+    imports?: StringMap;
+    scopes?: ObjectMap<StringMap>;
+}
+
 export interface UpdateGradleOptions {
     multiple?: boolean;
     addendum?: string;

package/lib/filemanager.d.ts

@@ -101,6 +101,7 @@ export interface FindAssetOptions<T extends ExternalAsset = ExternalAsset> {
 }
 
 export interface ChecksumOptions extends ReadHashOptions, Pick<ChecksumOutput, "include" | "exclude" | "recursive"> {
+    dot?: boolean;
     sortBy?: number;
     verbose?: boolean;
     ignore?: string[];

package/lib/index.d.ts

@@ -17,7 +17,7 @@ import type { CommandData, CropData, QualityData, ResizeData, RotateData, Transf
 import type { ExecCommand, LOG_TYPE, LogArguments, LogComponent, LogDate, LogFailOptions, LogMessageOptions, LogOptions, LogProcessOptions, LogTime, LogType, LogValue, STATUS_TYPE, StatusType } from './logger';
 import type { AsHashOptions, CheckSemVerOptions, CopyDirOptions, CopyDirResult, CopyFileOptions, CreateDirOptions, DeleteFileOptions, GetTempDirOptions, MoveFileOptions, NormalizeFlags, ParseFunctionOptions, PermissionOptions, ProtocolType, ReadFileCallback, ReadFileOptions, ReadHashOptions, RemoveDirOptions, WriteFileOptions } from './module';
 import type { RequestData, Settings } from './node';
-import type { ApplyOptions, Aria2Options, BufferFormat, DataEncodedResult, DataObjectResult, FormDataPart, HostConfig, OpenOptions, PostOptions, ProxySettings, ReadExpectType, RequestInit } from './request';
+import type { ApplyOptions, Aria2Options, BufferFormat, DataEncodedResult, DataObjectResult, FormDataPart, HeadersOnCallback, HostConfig, OpenOptions, PostOptions, ProxySettings, ReadExpectType, RequestInit } from './request';
 import type { ClientModule, CloudModule, CloudServiceOptions, CompressModule, CompressSettings, DbCoerceSettings, DbModule, DbSourceOptions, DnsLookupSettings, DocumentComponent, DocumentComponentOption, DocumentModule, HttpConnectSettings, HttpMemorySettings, ImageModule, RequestModule, RequestSettings, TaskModule, WatchModule } from './settings';
 import type { Command, SpawnResult } from './task';
 import type { IFileGroup, ModifiedPostFinalizeListener, SecureOptions, WatchInitResult } from './watch';
@@ -83,7 +83,7 @@ declare namespace functions {
         new(module?: U): ICompress<T, U>;
     }
 
-    interface IImage<T extends IHost = IHost, U extends ImageModule = ImageModule> extends IClient<T, U, FunctionType> {
+    interface IImage<T extends IHost = IHost, U extends ImageModule = ImageModule> extends IClient<T, U> {
         resizeData?: ResizeData;
         cropData?: CropData;
         rotateData?: RotateData;
@@ -135,6 +135,7 @@ declare namespace functions {
         setCredential(item: V): Promise<void>;
         getCredential<Y = PlainObject>(item: V): Undef<Y>;
         hasSource(source: string, ...type: number[]): boolean;
+        applyCommand(...items: V[]): void;
         executeQuery(item: V, sessionKey: string): Promise<QueryResult>;
         executeQuery(item: V, options?: ExecuteQueryOptions | string): Promise<QueryResult>;
         executeBatchQuery(batch: V[], sessionKey: string, outResult?: BatchQueryResult): Promise<BatchQueryResult>;
@@ -212,6 +213,7 @@ declare namespace functions {
         loadConfig(data: object, name: string): Optional<ConfigOrTransformer>;
         asSourceFile(value: string, options?: AsSourceFileOptions | boolean): unknown;
         findVersion(name: StringOfArray, fallback?: string): string;
+        findSourceScope(uri: string, imports: AnyObject): StringMap[];
         findSourceRoot(uri: string, imports?: StringMap): Undef<string>;
         resolveDir(name: string, ...paths: string[]): Undef<string>;
         locateSourceFiles(file: U, code?: string, bundleContent?: string[]): (imports?: StringMap) => Undef<SourceInput>;
@@ -222,7 +224,7 @@ declare namespace functions {
         settingsOf(name: keyof W, option: keyof X): unknown;
         parseTemplate(viewEngine: ViewEngine | string, template: string, data: unknown[]): Promise<Null<string>>;
         transform(type: string, code: string, format: StringOfArray, options?: TransformOutput & TransformAction): Promise<Void<TransformResult>>;
-        abort(name?: keyof W): void;
+        abort(name?: keyof W | Error, reason?: unknown): void;
         restart(): void;
         using?(data: IFileThread<U>): Promise<unknown>;
         setLocalUri?(file: U, replace?: boolean): void;
@@ -303,6 +305,8 @@ declare namespace functions {
         addDns(hostname: string, address: string, family?: NumString): void;
         lookupDns(hostname: string): LookupFunction;
         proxyOf(uri: string, localhost?: boolean): Undef<ProxySettings>;
+        headersOn(name: ArrayOf<string>, callback: HeadersOnCallback): void;
+        headersOn(name: ArrayOf<string>, patternUrl: string, callback: HeadersOnCallback): void;
         headersOf(uri: string): Undef<OutgoingHttpHeaders>;
         aria2c(uri: string | URL, pathname: string): Promise<string[]>;
         aria2c(uri: string | URL, options?: Aria2Options): Promise<string[]>;

package/lib/request.d.ts

@@ -127,4 +127,5 @@ 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 DataObjectResult<T extends { format?: unknown; encoding?: BufferEncoding }> = T extends { format: string | PlainObject } ? Null<object> : DataEncodedResult<T>;
+export type DataObjectResult<T extends { format?: unknown; encoding?: BufferEncoding }> = T extends { format: string | PlainObject } ? Null<object> : DataEncodedResult<T>;
+export type HeadersOnCallback = (value: IncomingHttpHeaders, url?: URL) => Void<boolean>;

package/lib/settings.d.ts

@@ -1,3 +1,5 @@
+import type { WatchInterval } from './squared';
+
 import type { PermissionAction, PermissionReadWrite, PermittedDirectories } from './core';
 import type { DbSource, PoolConfig, TimeoutAction } from './db';
 import type { HttpOutgoingHeaders } from './http';
@@ -29,7 +31,8 @@ export interface HandlerSettings<T = PlainObject> {
 
 export interface ClientModule<T = ClientSettings> extends HandlerModule<T>, PermissionAction {}
 
-export interface ClientSettings extends PlainObject {
+export interface ClientSettings<T = PlainObject> extends PlainObject {
+    users?: ObjectMap<T>;
     cache_dir?: string;
 }
 
@@ -105,12 +108,12 @@ export interface DownloadModule<T = PlainObject> extends HandlerSettings<T> {
     };
 }
 
-export interface DocumentModule<T = DbSettings> extends ClientModule<DocumentSettings> {
+export interface DocumentModule<T = DocumentSettings, U = DbSettings> extends ClientModule<T> {
     eval?: DocumentEval;
     imports?: StringMap;
     versions?: StringMap;
     format?: AnyObject;
-    db?: DbModule<T>;
+    db?: DbModule<U>;
 }
 
 export interface DocumentEval {
@@ -125,8 +128,9 @@ export interface DocumentGroup<T = { imports?: StringMap } & AnyObject, U = T> {
     imports?: StringMap;
 }
 
-export interface DocumentUsersGroup<T = AnyObject, U = T> extends DocumentGroup<T, U> {
+export interface DocumentUserSettings<T = AnyObject, U = T> extends DocumentGroup<T, U>, PlainObject {
     extensions?: Null<string[]>;
+    imports_strict?: boolean;
 }
 
 export interface DocumentComponent<T = boolean, U = T, V = U> extends Omit<DocumentGroup<T, U>, "pages"> {
@@ -140,8 +144,8 @@ export interface DocumentComponentOption<T = unknown> {
     local_file?: NumString;
 }
 
-export interface DocumentSettings extends DocumentGroup, PurgeAction, PlainObject {
-    users?: ObjectMap<DocumentUsersGroup>;
+export interface DocumentSettings extends DocumentGroup, PurgeAction, ClientSettings<DocumentUserSettings>, PlainObject {
+    imports_strict?: boolean;
     directory?: DocumentDirectory;
     options?: DocumentComponentOptions;
 }
@@ -152,7 +156,7 @@ export interface DocumentDirectory extends StringMap {
 
 export type DocumentComponentOptions = DocumentComponent<DocumentComponentOption<DocumentTransform>, DocumentComponentOption<boolean>>;
 
-export interface ClientDBSettings extends ClientSettings, PurgeAction {
+export interface ClientDbSettings<T = PlainObject> extends ClientSettings<T>, PurgeAction {
     session_expires?: number;
     user_key?: ObjectMap<DbSourceOptions>;
     imports?: StringMap;
@@ -166,7 +170,9 @@ export interface MemorySettings extends PlainObject {
 
 export interface DbModule<T = DbSettings> extends ClientModule<T>, DbSourceDataType<ObjectMap<StringMap>>, PlainObject {}
 
-export interface DbSettings extends ClientDBSettings, DbSourceDataType<DbSourceOptions> {}
+export interface DbSettings<T = DbUserSettings> extends ClientDbSettings<T>, DbSourceDataType<DbSourceOptions> {}
+
+export interface DbUserSettings extends DbSourceDataType<{ commands?: ObjectMap<ObjectMap<PlainObject>> }>, PlainObject {}
 
 export interface DbCacheSettings extends TimeoutAction {
     dir?: string;
@@ -254,9 +260,7 @@ export interface WatchModule<T = WatchSettings> extends HandlerModule<T>, Server
     interval?: NumString;
 }
 
-export interface WatchSettings<T = PlainObject> extends PlainObject {
-    users?: ObjectMap<ObjectMap<T>>;
-}
+export interface WatchSettings<T = WatchUserSettings> extends ClientSettings<ObjectMap<T>>, PlainObject {}
 
 export interface CompressModule<U = CompressSettings> extends HandlerSettings<U> {
     gzip?: ZlibOptions;
@@ -283,7 +287,7 @@ export interface CloudModule<T = CloudSettings> extends ClientModule<T>, CloudSe
     apiVersion?: string;
 }
 
-export interface CloudSettings extends ClientDBSettings, CloudServiceDataType<CloudServiceOptions> {}
+export interface CloudSettings extends ClientDbSettings, CloudServiceDataType<CloudServiceOptions> {}
 
 export interface CloudServiceDataType<T = unknown> {
     atlas?: T;
@@ -319,6 +323,7 @@ export interface LoggerModule<T = NumString, U = boolean | T, V = LoggerFormat<T
     session_id?: U;
     message?: boolean;
     stack_trace?: boolean | T;
+    abort?: boolean;
     stdout?: boolean;
     unknown?: boolean | LoggerColor;
     system?: boolean | LoggerColor;
@@ -445,6 +450,7 @@ export type DbSourceDataType<T = unknown> = {
     [K in DbSource]?: T;
 };
 
+export type WatchUserSettings = ObjectMap<WatchInterval>;
 export type DocumentTransform = Null<boolean | "etag" | HashAlgorithm | HashConfig>;
 export type HashAlgorithm = "md5" | "sha1" | "sha256" | "sha224" | "sha384" | "sha512";
 

package/lib/squared.d.ts

@@ -64,6 +64,7 @@ export interface DbDataSource<T = unknown, U = unknown, V = unknown, W = unknown
     credential?: W;
     options?: U;
     update?: V;
+    withCommand?: string | [string, string];
     parallel?: boolean;
     willAbort?: boolean;
     streamRow?: Null<boolean | string | ((row: unknown) => Undef<Error | false>)>;

package/package.json

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