@e-mc/types 0.0.1

package/LICENSE

@@ -0,0 +1,11 @@
+Copyright 2023 An Pham
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+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.

package/README.md

@@ -0,0 +1,5 @@
+### @e-mc/types
+
+### LICENSE
+
+BSD 3-Clause

package/constant.d.ts

@@ -0,0 +1,158 @@
+export const enum VAL_MESSAGE {
+    SUCCESS = 'Success',
+    MODIFIED_DIRECTORY = 'Directory was modified',
+    COMMIT_TRANSACTION = 'Transactions were committed'
+}
+
+export const enum ERR_MESSAGE {
+    UNKNOWN = 'Unknown',
+    FAIL = 'FAIL!',
+    WARN = 'WARN!',
+    ABORTED = 'Aborted',
+    ABORTED_OPERATION = 'The operation was aborted',
+    FAILED = 'Failed',
+    PARAMETERS = 'Invalid parameters',
+    FORMAT = 'Invalid format',
+    ERROR_CODE = 'Error code',
+    EXEC_PERMISSION = 'Exec command not permitted',
+    NOT_CACHEABLE = 'Not able to cache',
+    NOT_COPYABLE = 'Not able to copy file',
+    NOT_DIRECTORY = 'Path is not a directory',
+    CANCELLED = 'Transaction was cancelled',
+    INCOMPLETE = 'Transaction was not completed',
+    THREAD = 'Thread limit exceeded',
+    THREAD_KILLED = 'Thread was killed',
+    TIMEOUT = 'Timeout was exceeded',
+    HANDLED_REJECTION = 'Handled rejection',
+    UNSUPPORTED_ACCESS = 'Unsupported access',
+    UNSUPPORTED_READ = 'Not permitted to read file',
+    UNSUPPORTED_WRITE = 'Not permitted to write file',
+    NOTFOUND_FILE = 'File not found',
+    NOTFOUND_BINARY = 'Binary not found',
+    NOTFOUND_PACKAGE = 'Package not found',
+    NOTFOUND_MIME = 'MIME not found',
+    INSTALL = 'Install required?',
+    INLINE_METHOD = 'Unable to parse inline method',
+    INLINE_OBJECT = 'Unable to parse inline object',
+    PROCESS_FILE = 'Unable to process file',
+    READ_FILE = 'Unable to read file',
+    WRITE_FILE = 'Unable to write file',
+    COPY_FILE = 'Unable to copy file',
+    DELETE_FILE = 'Unable to delete file',
+    RENAME_FILE = 'Unable to rename file',
+    MOVE_FILE = 'Unable to move file',
+    CONVERT_FILE = 'Unable to convert file',
+    DOWNLOAD_FILE = 'Unable to download file',
+    RESOLVE_FILE = 'Unable to resolve file',
+    RESOLVE_HOSTNAME = 'Unable to resolve hostname',
+    REPLACE_FILE = 'Unable to replace file',
+    COMPRESS_FILE = 'Unable to compress file',
+    COMPRESS_BUFFER = 'Unable to compress buffer',
+    DECOMPRESS_FILE = 'Unable to decompress file',
+    WATCH_FILE = 'Unable to watch file',
+    EXECUTE_FILE = 'Unable to execute file',
+    OVERWRITE_FILE = 'Unable to overwrite file',
+    CREATE_DIRECTORY = 'Unable to create directory',
+    TEMP_DIRECTORY = 'Unable to create temp directory',
+    READ_DIRECTORY = 'Unable to read directory',
+    WRITE_DIRECTORY = 'Unable to write directory',
+    MOVE_DIRECTORY = 'Unable to move directory',
+    REMOVE_DIRECTORY = 'Unable to remove directory',
+    LOAD_CONFIG = 'Unable to load configuration',
+    LOAD_HANDLER = 'Unable to load handler',
+    READ_BUFFER = 'Unable to read buffer',
+    WRITE_BUFFER = 'Unable to write buffer',
+    TRANSFORM_DOCUMENT = 'Unable to transform document',
+    PERFORM_TASK = 'Unable to perform task'
+}
+
+export const enum TIME {
+    Y = 1000 * 60 * 60 * 24 * 7 * 52,
+    M = 1000 * 60 * 60 * 24 * 30,
+    W = 1000 * 60 * 60 * 24 * 7,
+    D = 1000 * 60 * 60 * 24,
+    H = 1000 * 60 * 60,
+    m = 1000 * 60,
+    S = 1000
+}
+
+export const enum PACKAGE_NAME {
+    CLOUD = '@e-mc/cloud',
+    COMPAT_V4 = '@e-mc/compat-v4',
+    COMPRESS = '@e-mc/compress',
+    CORE = '@e-mc/core',
+    DB = '@e-mc/db',
+    DB_POOL = '@e-mc/db/pool',
+    DOCUMENT = '@e-mc/document',
+    DOCUMENT_ANDROID = '@e-mc/document/android',
+    DOCUMENT_CHROME = '@e-mc/document/chrome',
+    DOCUMENT_TRANSFORM = '@e-mc/document/transform',
+    DOCUMENT_UTIL = '@e-mc/document/util',
+    FILE_MANAGER = '@e-mc/file-manager',
+    IMAGE = '@e-mc/image',
+    IMAGE_JIMP = '@e-mc/image/jimp',
+    MODULE = '@e-mc/module',
+    MODULE_LIB_V4 = '@e-mc/module/lib-v4',
+    REQUEST = '@e-mc/request',
+    REQUEST_HTTP_HOST = '@e-mc/request/http/host',
+    TASK = '@e-mc/task',
+    TASK_GULP = '@e-mc/task/gulp',
+    TYPES = '@e-mc/types',
+    WATCH = '@e-mc/watch',
+    WATCH_FILEGROUP = '@e-mc/watch/filegroup'
+}
+
+export const enum ASSET_FLAG {
+    NONE = 0,
+    IGNORE = 1,
+    CLONE = 2,
+    USING = 4,
+    WATCH = 8,
+    MODIFIED = 16,
+    PROCESS = 32,
+    MAIN = 64,
+    EXISTS = 128
+}
+
+export const enum LOG_TYPE {
+    UNKNOWN = 0,
+    SYSTEM = 1,
+    NODE = 2,
+    PROCESS = 4,
+    COMPRESS = 8,
+    WATCH = 16,
+    FILE = 32,
+    CLOUD = 64,
+    TIME_ELAPSED = 128,
+    TIME_PROCESS = 256,
+    FAIL = 512,
+    HTTP = 1024,
+    IMAGE = 2048,
+    EXEC = 4096,
+    PERMISSION = 8192,
+    TIMEOUT = 16384,
+    STDOUT = 32768,
+    DB = 65536
+}
+
+export const enum SETTINGS_KEY_NAME {
+    NODE_PROCESS_CPUUSAGE = "node.process.cpu_usage",
+    NODE_PROCESS_MEMORYUSAGE = "node.process.memory_usage",
+    NODE_PROCESS_INLINE = "node.process.inline",
+    NODE_REQUIRE_EXT = "node.require.ext",
+    NODE_REQUIRE_NPM = "node.require.npm",
+    NODE_REQUIRE_INLINE = "node.require.inline",
+    TEMP_DIR = "temp.dir",
+    TEMP_WRITE = "temp.write",
+    PROCESS_PASSWORD = "process.password",
+    PROCESS_ENV_APPLY = "process.env.apply",
+    PROCESS_CIPHER_ALGORITHM = "process.cipher.algorithm",
+    PERMISSION_PROCESS_EXEC = "permission.process_exec",
+    PERMISSION_HOMEREAD = "permission.home_read",
+    PERMISSION_HOMEWRITE = "permission.home_write",
+    MEMORY_SETTINGS_USERS = "memory.settings.users",
+    ERROR_OUT = "error.out",
+    ERROR_FATAL = "error.fatal",
+    BROADCAST_OUT = "broadcast.out",
+    LOGGER_LEVEL = "logger.level"
+}

package/index.d.ts

@@ -0,0 +1,250 @@
+/// <reference path="./lib/type.d.ts" />
+/// <reference path="./lib/object.d.ts" />
+
+import type { LogArguments } from './lib/logger';
+import type { CloneObjectOptions } from './lib/module';
+
+import type { BinaryLike, CipherGCMTypes, Encoding } from 'crypto';
+
+// @ts-ignore
+import type { BytesOptions } from 'bytes';
+
+declare class AbortError extends Error {
+    code: string;
+}
+
+declare namespace types {
+    interface LOG_TYPE {
+        UNKNOWN: 0;
+        SYSTEM: 1;
+        NODE: 2;
+        PROCESS: 4;
+        COMPRESS: 8;
+        WATCH: 16;
+        FILE: 32;
+        CLOUD: 64;
+        TIME_ELAPSED: 128;
+        TIME_PROCESS: 256;
+        FAIL: 512;
+        HTTP: 1024;
+        IMAGE: 2048;
+        EXEC: 4096;
+        PERMISSION: 8192;
+        TIMEOUT: 16384;
+        STDOUT: 32768;
+        DB: 65536;
+    }
+
+    const LOG_TYPE: {
+        UNKNOWN: 0;
+        SYSTEM: 1;
+        NODE: 2;
+        PROCESS: 4;
+        COMPRESS: 8;
+        WATCH: 16;
+        FILE: 32;
+        CLOUD: 64;
+        TIME_ELAPSED: 128;
+        TIME_PROCESS: 256;
+        FAIL: 512;
+        HTTP: 1024;
+        IMAGE: 2048;
+        EXEC: 4096;
+        PERMISSION: 8192;
+        TIMEOUT: 16384;
+        STDOUT: 32768;
+        DB: 65536;
+    };
+
+    interface STATUS_TYPE {
+        UNKNOWN: 0;
+        FATAL: 1;
+        ERROR: 2;
+        WARN: 3;
+        INFO: 4;
+        DEBUG: 5;
+        ASSERT: 6;
+        TRACE: 7;
+    }
+
+    const STATUS_TYPE: {
+        UNKNOWN: 0;
+        FATAL: 1;
+        ERROR: 2;
+        WARN: 3;
+        INFO: 4;
+        DEBUG: 5;
+        ASSERT: 6;
+        TRACE: 7;
+    };
+
+    interface ASSET_FLAG {
+        NONE: 0;
+        IGNORE: 1;
+        CLONE: 2;
+        USING: 4;
+        WATCH: 8;
+        MODIFIED: 16;
+        PROCESS: 32;
+        MAIN: 64;
+        EXISTS: 128;
+    }
+
+    const ASSET_FLAG: {
+        NONE: 0;
+        IGNORE: 1;
+        CLONE: 2;
+        USING: 4;
+        WATCH: 8;
+        MODIFIED: 16;
+        PROCESS: 32;
+        MAIN: 64;
+        EXISTS: 128;
+    };
+
+    interface FILE_TYPE {
+        UNKNOWN: 0;
+        ASSET: 1;
+        TRANSFORM: 2;
+        COMPRESSED: 4;
+        SOURCEMAP: 8;
+        TORRENT: 16;
+    }
+
+    const FILE_TYPE: {
+        UNKNOWN: 0;
+        ASSET: 1;
+        TRANSFORM: 2;
+        COMPRESSED: 4;
+        SOURCEMAP: 8;
+        TORRENT: 16;
+    };
+
+    interface ACTION_FLAG {
+        NONE: 0;
+        IGNORE: 1;
+    }
+
+    const ACTION_FLAG: {
+        NONE: 0;
+        IGNORE: 1;
+    };
+
+    interface ERR_CODE {
+        MODULE_NOT_FOUND: "MODULE_NOT_FOUND";
+    }
+
+    const ERR_CODE: {
+        MODULE_NOT_FOUND: string;
+    };
+
+    interface DOWNLOAD_TYPE {
+        HTTP: 0;
+        DISK: 1;
+        CACHE: 2;
+    }
+
+    const DOWNLOAD_TYPE: {
+        HTTP: 0;
+        DISK: 1;
+        CACHE: 2;
+    };
+
+    interface FETCH_TYPE {
+        UNKNOWN: 0;
+        HTTP: 1;
+        TORRENT: 2;
+        FTP: 3;
+        UNIX_SOCKET: 4;
+    }
+
+    const FETCH_TYPE: {
+        UNKNOWN: 0;
+        HTTP: 1;
+        TORRENT: 2;
+        FTP: 3;
+        UNIX_SOCKET: 4;
+    };
+
+    interface DB_TYPE {
+        SQL: 1;
+        NOSQL: 2;
+        DOCUMENT: 4;
+        KEYVALUE: 8;
+    }
+
+    const DB_TYPE: {
+        SQL: 1;
+        NOSQL: 2;
+        DOCUMENT: 4;
+        KEYVALUE: 8;
+    };
+
+    interface WATCH_EVENT {
+        MODIFIED: "modified";
+        BROADCAST: "broadcast";
+        CLOSE: "close";
+        ERROR: "error";
+    }
+
+    const WATCH_EVENT: {
+        MODIFIED: string;
+        BROADCAST: string;
+        CLOSE: string;
+        ERROR: string;
+    };
+
+    const IMPORT_MAP: StringMap;
+
+    type WatchEventValue = WATCH_EVENT[keyof WATCH_EVENT];
+
+    function createAbortError(): AbortError;
+    function hasBit(value: unknown, flags: number): boolean;
+    function ignoreFlag(value: unknown): boolean;
+    function cloneFlag(value: unknown): boolean;
+    function usingFlag(value: unknown): boolean;
+    function watchFlag(value: unknown): boolean;
+    function modifiedFlag(value: unknown): boolean;
+    function processFlag(value: unknown): boolean;
+    function mainFlag(value: unknown): boolean;
+    function existsFlag(value: unknown): boolean;
+    function getLogCurrent(): Null<LogArguments>;
+    function setLogCurrent(value: LogArguments): void;
+    function setTempDir(value: string): boolean;
+    function getTempDir(): string;
+    function isArray<T>(value: unknown): value is T[];
+    function isObject<T = object>(value: unknown): value is T;
+    function isPlainObject<T = PlainObject>(value: unknown): value is T;
+    function isString(value: unknown): value is string;
+    function isEmpty(value: unknown): boolean;
+    function asFunction<T = unknown, U = FunctionType<Promise<T> | T>>(value: unknown, sync?: boolean): Null<U>;
+    function parseTime(value: NumString, start?: number): number;
+    function parseExpires(value: NumString, start?: number): number;
+    function formatTime(value: number, char: string): string;
+    function formatTime(value: number, elapsed?: boolean, char?: string): string;
+    function convertTime(value: NumString): number;
+    function convertTime(value: HighResolutionTime, format: true): string;
+    function convertTime(value: HighResolutionTime, format?: boolean): number;
+    function hasGlob(value: string): boolean;
+    function escapePattern(value: unknown, lookBehind?: boolean): string;
+    function renameExt(value: string, ext: string, when?: string): string;
+    function formatSize(value: string): number;
+    function formatSize(value: number, options?: BytesOptions): string;
+    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;
+    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 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 validateUUID(value: unknown): value is string;
+    function randomString(format: string, dictionary?: string): string;
+    function errorValue(value: string, hint?: string): Error;
+    function errorMessage(title: NumString, value: string, hint?: string): Error;
+    function purgeMemory(percent?: number): number;
+}
+
+export = types;