@e-mc/types 0.8.3 → 0.8.5

package/LICENSE

@@ -1,11 +1,7 @@
-Copyright 2023 An Pham
+Copyright 2024 Mile Square Park
 
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,7 +1,7 @@
-### @e-mc/types
+# @e-mc/types
 
-https://e-mc.readthedocs.io
+PEP 402
 
-### LICENSE
+## LICENSE
 
-BSD 3-Clause
+MIT

package/constant.d.ts

@@ -1,5 +1,5 @@
 export const enum INTERNAL {
-    VERSION = '0.8.3',
+    VERSION = '0.8.5',
     TEMP_DIR = 'tmp', // eslint-disable-line @typescript-eslint/no-shadow
     CJS = '__cjs__'
 }
@@ -187,11 +187,13 @@ export const enum TIME {
 
 export const enum PACKAGE_NAME {
     CLOUD = '@e-mc/cloud',
+    CLOUD_UTIL = '@e-mc/cloud/util',
     COMPAT_V4 = '@e-mc/compat-v4',
     COMPRESS = '@e-mc/compress',
     CORE = '@e-mc/core',
     DB = '@e-mc/db',
     DB_POOL = '@e-mc/db/pool',
+    DB_UTIL = '@e-mc/db/util',
     DOCUMENT = '@e-mc/document',
     DOCUMENT_ANDROID = '@pi-r/android',
     DOCUMENT_CHROME = '@pi-r/chrome',
@@ -204,6 +206,7 @@ export const enum PACKAGE_NAME {
     MODULE_LIB_V4 = '@e-mc/module/lib-v4',
     REQUEST = '@e-mc/request',
     REQUEST_HTTP_HOST = '@e-mc/request/http/host',
+    REQUEST_UTIL = '@e-mc/request/util',
     TASK = '@e-mc/task',
     TASK_GULP = '@pi-r/gulp',
     TYPES = '@e-mc/types',

package/index.d.ts

@@ -276,6 +276,7 @@ declare namespace types {
     function renameExt(value: string, ext: string, when?: string): string;
     function formatSize(value: string): number;
     function formatSize(value: number, options?: BytesOptions): string;
+    function alignSize(value: unknown, kb?: number, factor?: number): number;
     function cascadeObject<T = unknown>(data: object, query: string, fallback?: unknown): T;
     function cloneObject<T>(data: T, deep: boolean): T;
     function cloneObject<T>(data: T, deepIgnore: WeakSet<object>): T;

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.incrementUUID = exports.purgeMemory = exports.errorMessage = void 0;
+exports.validateUUID = exports.randomString = exports.decryptUTF8 = exports.encryptUTF8 = exports.getEncoding = exports.asFunction = exports.coerceObject = exports.cloneObject = exports.cascadeObject = exports.alignSize = 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.incrementUUID = exports.purgeMemory = exports.errorMessage = exports.errorValue = void 0;
 const path = require("path");
 const fs = require("fs");
 const crypto = require("crypto");
@@ -571,9 +571,40 @@ function renameExt(value, ext, when) {
 }
 exports.renameExt = renameExt;
 function formatSize(value, options) {
-    return (typeof value === 'number' ? bytes(value, options) : bytes(value));
+    if (typeof value === 'number') {
+        return (bytes(value, options) || ('0' + (options?.unitSeparator || '') + 'B'));
+    }
+    return (bytes(value) || 0);
 }
 exports.formatSize = formatSize;
+function alignSize(value, kb = 0, factor = 0) {
+    if (value === undefined) {
+        return NaN;
+    }
+    let result = 0;
+    switch (typeof value) {
+        case 'number':
+            if (value < 0) {
+                return NaN;
+            }
+            result = Math.ceil(factor > 0 ? value * Math.pow(1024, factor) : value);
+            break;
+        case 'string':
+            result = formatSize(value);
+            if (result < 0) {
+                return NaN;
+            }
+            break;
+        default:
+            return NaN;
+    }
+    if (kb > 0) {
+        kb = Math.ceil(kb) * 1024;
+        return Math.ceil(result / kb) * kb;
+    }
+    return result;
+}
+exports.alignSize = alignSize;
 function cascadeObject(data, query, fallback) {
     if (isObject(data) && isString(query)) {
         const names = query.trim().split(/(?<!\\)\./).map(item => item.includes('.') ? item.replace(/\\(?=\.)/g, '') : item);

package/lib/index.d.ts

@@ -35,7 +35,6 @@ import type * as EventEmitter from 'events';
 
 // @ts-ignore
 import type * as ws from 'ws';
-// @ts-ignore
 import type { FileTypeResult } from 'file-type';
 
 type BufferView = BufferContent | NodeJS.ArrayBufferView;
@@ -66,7 +65,7 @@ declare namespace functions {
         chunkSize?: number;
         register(format: string, callback: TryFileCompressor): void;
         getLevel(value: string, fallback?: number): Undef<number>;
-        getReadable(file: string | Buffer): Readable;
+        getReadable(file: string | URL | Buffer): Readable;
         createGzip(file: string | Buffer, options?: CompressLevel): Gzip;
         createBrotliCompress(file: string | Buffer, options?: CompressLevel): BrotliCompress;
         createWriteStreamAsGzip(file: string | Buffer, output: string, options?: CompressLevel): WriteStream;
@@ -109,7 +108,7 @@ declare namespace functions {
         clamp(value: unknown, min?: number, max?: number): number;
         isBinary(mime: unknown): mime is string;
         toABGR(buffer: Uint8Array | Buffer): Buffer;
-        /* @deprecated IImage.using (v0.9) */
+        /* @deprecated - IImage.using */
         using?<V extends ExternalAsset>(this: T, instance: IImage<T, U>, data: IFileThread<V>, command: string): Promise<unknown>;
         readonly prototype: IImage<T, U>;
         new(module?: U): IImage<T, U>;
@@ -127,7 +126,7 @@ declare namespace functions {
 
     interface TaskConstructor<T extends IHost = IHost, U extends TaskModule = TaskModule> extends ModuleConstructor {
         finalize<V extends ExternalAsset>(this: T, instance: ITask<T, U>, assets: V[]): Promise<unknown>;
-        /* @deprecated ITask.using (v0.9) */
+        /* @deprecated - ITask.using */
         using?<V extends ExternalAsset>(this: T, instance: ITask<T, U>, assets: V[], preceding?: boolean): Promise<unknown>;
         readonly prototype: ITask<T, U>;
         new(module?: U, ...args: unknown[]): ITask<T, U>;
@@ -147,9 +146,9 @@ declare namespace functions {
         handleFail(err: unknown, item: V, options?: HandleFailOptions): boolean;
         readTLSCert(value: unknown, cache?: boolean): string;
         readTLSConfig(options: SecureContextOptions, cache?: boolean): void;
-        settingsOf(source: string, name: "pool" | "cache"): unknown;
+        settingsOf(source: string, name: keyof Omit<W, "coerce">): unknown;
         settingsOf(source: string, name: "coerce", component: keyof X): unknown;
-        settingsKey(source: string, name: "pool" | "cache"): unknown;
+        settingsKey(source: string, name: keyof Omit<W, "coerce">): unknown;
         settingsKey(source: string, name: "coerce", component: keyof X): unknown;
         getPoolConfig(source: string, uuidKey?: string): Undef<Required<PoolConfig>>;
         get sourceType(): DB_TYPE;
@@ -256,7 +255,7 @@ declare namespace functions {
         writeSourceMap(uri: string, data: SourceCode, options?: SourceMapOptions): Undef<string>;
         updateGradle(source: string, namespaces: string[], value: string, options?: UpdateGradleOptions | boolean): string;
         generateLintTable(messages: LintMessage[], options: GenerateLintTableOptions): LogComponent[];
-        /* @deprecated IDocument.using (v0.9) */
+        /* @deprecated - IDocument.using */
         using?(this: T, instance: IDocument<T, U, V, W, X, Y>, file: U): Promise<unknown>;
         cleanup?(this: T, instance: IDocument<T, U, V, W, X, Y>): Promise<unknown>;
         sanitizeAssets?(assets: U[], exclusions?: U[]): U[];
@@ -266,7 +265,7 @@ declare namespace functions {
 
     interface IWatch<T extends IFileManager<U>, U extends ExternalAsset = ExternalAsset, V extends WatchModule = WatchModule, W extends FunctionType<unknown, any> = ModifiedPostFinalizeListener<U>> extends IClient<T, V, W> {
         connectTimeout: number;
-        start(assets: U[], permission?: IPermission): void;
+        start(assets: U[], permission?: Null<IPermission>): void;
         modified(watch: IFileGroup<U>): Promise<Void<FinalizeResult>>;
         configureServer(options: SecureOptions): boolean;
         setCA(value: string): boolean;
@@ -293,6 +292,7 @@ declare namespace functions {
         checkTimeout(client: ws): boolean;
         readonly prototype: IWatch<T, U, V, W>;
         new(module?: V): IWatch<T, U, V, W>;
+        /* @deprecated */
         new(interval?: number, port?: number, securePort?: number, extensions?: unknown[]): IWatch<T, U, V, W>;
     }
 
@@ -310,9 +310,9 @@ declare namespace functions {
         lookupDns(hostname: string): LookupFunction;
         proxyOf(uri: string, localhost?: boolean): Undef<ProxySettings>;
         statusOn(name: ArrayOf<number>, callback: StatusOnCallback): void;
-        statusOn(name: ArrayOf<number>, patternUrl: string, callback: StatusOnCallback): void;
-        headersOn(name: ArrayOf<string>, callback: HeadersOnCallback): void;
-        headersOn(name: ArrayOf<string>, patternUrl: string, callback: HeadersOnCallback): void;
+        statusOn(name: ArrayOf<number>, globUrl: string, callback: StatusOnCallback): void;
+        headersOn(name: StringOfArray, callback: HeadersOnCallback): void;
+        headersOn(name: StringOfArray, globUrl: 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[]>;
@@ -425,8 +425,10 @@ declare namespace functions {
         writeBuffer(file: T, options?: WriteFileOptions): Null<Buffer>;
         writeImage(document: StringOfArray, output: OutputFinalize<T>): boolean;
         compressFile(file: T, overwrite?: boolean): Promise<unknown>;
+        fetchObject(uri: string | URL, format: BufferFormat): Promise<Null<object>>;
         fetchObject(uri: string | URL, options?: OpenOptions | BufferFormat): Promise<Null<object>>;
         fetchBuffer<U extends OpenOptions>(uri: string | URL, options?: U): Promise<DataEncodedResult<U>>;
+        fetchFiles(uri: string | URL, pathname: string): Promise<string[]>;
         fetchFiles(uri: string | URL, options?: Aria2Options | string): Promise<string[]>;
         start(emptyDir?: boolean): Promise<FinalizeResult>;
         processAssets(emptyDir?: boolean, using?: T[]): void;
@@ -723,8 +725,8 @@ declare namespace functions {
         copyDir(src: string | URL, dest: string | URL, move?: boolean, recursive?: boolean): Promise<CopyDirResult>;
         renameFile(src: string | URL, dest: string | URL, throws?: boolean): boolean;
         streamFile<U extends BufferContent>(src: string, cache: boolean): Promise<U>;
-        streamFile<U extends BufferContent>(src: string, options: U): Promise<U extends { encoding: string } ? string : Buffer>;
-        streamFile<U extends BufferContent>(src: string, cache?: boolean | U, options?: U): Promise<U extends { encoding: string } ? string : Buffer>;
+        streamFile<U extends ReadBufferOptions>(src: string, options: U): Promise<U extends { encoding: string } ? string : Buffer>;
+        streamFile<U extends ReadBufferOptions>(src: string, cache?: boolean | U, options?: U): Promise<U extends { encoding: string } ? string : Buffer>;
         readText(value: string | URL, cache: boolean): string;
         readText<U extends ReadTextOptions>(value: string | URL, options: U): U extends { minStreamSize: NumString } ? Promise<string> : string;
         readText(value: string | URL, encoding?: BufferEncoding | boolean | ReadTextOptions, cache?: boolean): string;

package/lib/logger.d.ts

@@ -2,7 +2,6 @@ import type { LogStatus } from './squared';
 
 import type { LOG_TYPE, STATUS_TYPE } from '../index.d';
 
-// @ts-ignore
 import type { BackgroundColor as IBackgroundColor, ForegroundColor as IForegroundColor } from 'chalk';
 
 type HexColor = `#${string}`;

package/lib/request.d.ts

@@ -65,7 +65,6 @@ export interface OpenOptions extends KeepAliveAction, SilentAction {
     postData?: unknown;
     connected?: (headers: IncomingHttpHeaders) => Void<boolean>;
     statusMessage?: string;
-    silent?: boolean;
     outFormat?: { out: BufferFormat; parser?: PlainObject };
     outFilename?: Null<string>;
     outHeaders?: Null<IncomingHttpHeaders>;
@@ -105,7 +104,9 @@ export interface ProxySettings extends KeepAliveAction {
 
 export interface RequestInit extends ProtocolAction {
     headers?: unknown;
+    /* @deprecated - readTimeout */
     requestTimeout?: number;
+    readTimeout?: number;
 }
 
 export interface ClientConfig {

package/lib/settings.d.ts

@@ -84,8 +84,8 @@ export interface PermissionModule<T = PermissionSettings> extends PermittedDirec
 }
 
 export interface PermissionSettings extends PlainObject {
-    picomatch?: PicomatchOptions;
-    minimatch?: MinimatchOptions;
+    picomatch?: Null<PicomatchOptions>;
+    minimatch?: Null<MinimatchOptions>;
 }
 
 export interface DownloadModule<T = PlainObject> extends HandlerSettings<T> {

package/lib/type.d.ts

@@ -3,7 +3,7 @@
 type Undef<T> = T | undefined;
 type Null<T> = T | null;
 type Void<T> = T | void;
-type Optional<T> = Undef<T> | Null<T>;
+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 KeyOfType<T, U = any, V = any> = { [K in keyof T]: K extends U ? T[K] extends V ? K : never : never }[keyof T];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/types",
-  "version": "0.8.3",
+  "version": "0.8.5",
   "description": "Type definitions for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -17,7 +17,7 @@
     "squared-functions"
   ],
   "author": "An Pham <anpham6@gmail.com>",
-  "license": "BSD 3-Clause",
+  "license": "MIT",
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
     "bytes": "^3.1.2",