@e-mc/types 0.9.6 → 0.10.0

package/README.md

@@ -9,18 +9,16 @@
 
 ## Interface
 
-* [View Source](https://www.unpkg.com/@e-mc/types@0.9.6/index.d.ts)
+* [View Source](https://www.unpkg.com/@e-mc/types@0.10.0/index.d.ts)
 
 ```typescript
 import type { LogArguments } from "./lib/logger";
-import type { CloneObjectOptions } from "./lib/module";
 
 import type { BytesOptions } from "bytes";
-import type { BinaryLike, CipherGCMTypes, Encoding } from "crypto";
-import type { HighResolutionTime } from "perf_hooks";
+import type { BinaryLike, CipherGCMTypes, Encoding, RandomUUIDOptions } from "crypto";
 
 function createAbortError(reject: true): Promise<never>;
-function createAbortError(): Error;
+function createAbortError(): DOMException;
 function hasBit(value: unknown, flags: number): boolean;
 function ignoreFlag(value: unknown): boolean;
 function cloneFlag(value: unknown): boolean;
@@ -62,12 +60,16 @@ function coerceObject(data: unknown, parseString?: (...args: [string]) => unknow
 function getEncoding(value: unknown, fallback?: BufferEncoding): BufferEncoding;
 function encryptUTF8(algorithm: CipherGCMTypes, key: BinaryLike, iv: BinaryLike, data: string, encoding?: Encoding): string | undefined;
 function decryptUTF8(algorithm: CipherGCMTypes, key: BinaryLike, iv: BinaryLike, data: string, encoding?: Encoding): string | undefined;
-function generateUUID(): string;
+function hashKey(data: BinaryLike, algorithm?: string, encoding?: BinaryToTextEncoding): string;
+/** @deprecated - crypto.randomUUID */
+function generateUUID(options?: RandomUUIDOptions): 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;
 function errorMessage(title: number | string, value: string, hint?: string): Error;
+function supported(major: number, minor?: number, patch?: number, lts?: boolean): boolean;
+function importESM<T = unknown>(name: string, isDefault?: boolean, fromPath?: boolean): Promise<T>;
 function purgeMemory(percent?: number): number;
 
 interface LOG_TYPE {
@@ -194,10 +196,12 @@ const IMPORT_MAP: Record<string, string | undefined>;
 
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.9.6/lib/logger.d.ts
-- https://www.unpkg.com/@e-mc/types@0.9.6/lib/module.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/index.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/logger.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/module.d.ts
+- https://www.unpkg.com/@e-mc/types@0.10.0/lib/object.d.ts
 
-* https://nodejs.org/api/perf_hooks.html
+* https://developer.mozilla.org/en-US/docs/Web/API/DOMException
 * https://www.npmjs.com/package/@types/bytes
 
 ## LICENSE

package/constant.d.ts

@@ -1,5 +1,5 @@
 export const enum INTERNAL {
-    VERSION = '0.9.6',
+    VERSION = '0.10.0',
     TEMP_DIR = 'tmp',
     CJS = '__cjs__'
 }
@@ -8,6 +8,7 @@ export const enum VAL_MESSAGE {
     SUCCESS = 'Success',
     COMPLETED = 'Completed',
     CHECKSUM = 'Checksum matched',
+    MODIFIED_FILE = 'File modified',
     MODIFIED_DIRECTORY = 'Directory was modified',
     COMMIT_TRANSACTION = 'Transactions were committed'
 }
@@ -38,18 +39,22 @@ export const enum ERR_MESSAGE {
     FAIL = 'FAIL!',
     WARN = 'WARN!',
     ABORTED = 'Aborted',
+    EXPIRED = 'Expired',
     ABORTED_HOST = 'Aborted by host',
     ABORTED_CLIENT = 'Aborted by client',
     ABORTED_PROCESS = 'Aborted by process',
-    ABORTED_OPERATION = 'The operation was aborted',
+    ABORTED_OPERATION = 'This operation was aborted',
     FAILED = 'Failed',
     FAILED_CHECKSUM = 'Checksum did not match',
     PARAMETERS = 'Invalid parameters',
     FORMAT = 'Invalid format',
     CHECKSUM = 'Invalid checksum',
+    CONFIG = 'Invalid config',
     RESPONSE = 'Invalid response',
+    FUNCTION = 'Invalid function',
     SIZE = 'Size limit was exceeded',
     ERROR_CODE = 'Error code',
+    BUSY_RESOURCE = 'Resource already in use',
     PERMISSION = 'Operation not permitted',
     EXEC_PERMISSION = 'Exec command not permitted',
     NOT_CACHEABLE = 'Not able to cache',
@@ -64,6 +69,7 @@ export const enum ERR_MESSAGE {
     TIMEOUT = 'Timeout was exceeded',
     HANDLED_REJECTION = 'Handled rejection',
     UNSUPPORTED_ACCESS = 'Unsupported access',
+    UNSUPPORTED_PROTOCOL = 'Unsupported protocol',
     UNSUPPORTED_MIME = 'Unsupported MIME',
     UNSUPPORTED_READ = 'Not permitted to read file',
     UNSUPPORTED_WRITE = 'Not permitted to write file',
@@ -72,6 +78,7 @@ export const enum ERR_MESSAGE {
     NOTFOUND_BINARY = 'Binary not found',
     NOTFOUND_PACKAGE = 'Package not found',
     NOTFOUND_MIME = 'MIME not found',
+    NOTFOUND_TLS = 'TLS/SSL key and cert not found',
     INSTALL = 'Install required?',
     INLINE_METHOD = 'Unable to parse inline method',
     INLINE_OBJECT = 'Unable to parse inline object',
@@ -118,6 +125,7 @@ export const enum ERR_DB {
     TABLE = 'Missing database table',
     QUERY = 'Missing database query',
     CONNECTION = 'Missing connection string',
+    TLS = 'Missing TLS/SSL credentials',
     CLIENT = 'Unable to configure client',
     EXEC_QUERY = 'Unable to execute query',
     FILTER_QUERY = 'Unable to filter results',
@@ -159,6 +167,10 @@ export const enum ERR_CLOUD {
     METADATA_FAIL = 'Metadata failed'
 }
 
+export const enum ERR_COMPRESS {
+    API_KEY = 'Missing API key'
+}
+
 export const enum ERR_IMAGE {
     ROTATE = 'Unable to rotate image',
     FINALIZE = 'Unable to finalize image',
@@ -168,7 +180,16 @@ export const enum ERR_IMAGE {
 
 export const enum ERR_HTTP {
     HEADERS = 'Unable to process headers',
+    FORMAT = 'Unable to parse URI response',
+    SERVER_WEBSOCKET = 'Unable to create WebSocket server',
     ETAG = 'ETag not supported',
+    REQUEST = 'Invalid HTTP request',
+    TIMEOUT = 'HTTP request timeout',
+    TIMEOUT_CONNECTION = 'HTTP connection timeout',
+    DATA_RECEIVED = 'No data received',
+    REDIRECT_LIMIT = 'Exceeded redirect limit',
+    REDIRECT_FOLLOW = 'Follow redirect was disabled',
+    REDIRECT_MISSING = 'Missing redirect location',
     DOWNLOAD_SUCCESS = 'No files were successfully downloaded',
     MULTIPART_ATTACH = 'No files were attached'
 }
@@ -229,6 +250,14 @@ export const enum PACKAGE_NAME {
     WATCH_FILEGROUP = '@e-mc/watch/filegroup'
 }
 
+export const enum MIME_TYPE {
+    MULTIPART = 'multipart/form-data',
+    URLENCODED = 'application/x-www-form-urlencoded',
+    JSON = 'application/json',
+    TEXT = 'text/plain',
+    OCTET_STREAM = 'application/octet-stream'
+}
+
 export const enum ASSET_FLAG {
     NONE = 0,
     IGNORE = 1,
@@ -263,15 +292,15 @@ export const enum LOG_TYPE {
 }
 
 export const enum LOG_STATE {
-    STDIN = 0,
-    STDOUT = 1,
-    STDERR = 2
+    STDIN,
+    STDOUT,
+    STDERR
 }
 
 export const enum READDIR_SORT {
-    FILE = 0,
-    DIRECTORY = 1,
-    DESCENDING = 2
+    FILE,
+    DIRECTORY,
+    DESCENDING
 }
 
 export const enum SETTINGS_KEY_NAME {

package/index.d.ts

@@ -1,18 +1,14 @@
+/// <reference lib="dom" />
 /// <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';
+import type { BinaryLike, BinaryToTextEncoding, CipherGCMTypes, Encoding, RandomUUIDOptions } from 'crypto';
 
 // @ts-ignore
 import type { BytesOptions } from 'bytes';
 
-declare class AbortError extends Error {
-    code: string;
-}
-
 declare namespace types {
     interface LOG_TYPE {
         UNKNOWN: 0;
@@ -266,10 +262,24 @@ declare namespace types {
 
     const IMPORT_MAP: StringMap;
 
+    interface CloneObjectOptions<T = unknown> {
+        target?: T;
+        deep?: boolean;
+        deepIgnore?: WeakSet<object>;
+        mergeArray?: MergeArrayMethod;
+        mergeDepth?: number;
+        typedArray?: boolean;
+        symbol?: boolean;
+        inherited?: boolean;
+        nonenumerable?: boolean;
+        preserve?: boolean;
+    }
+
+    type MergeArrayMethod = "concat" | "concat-pre" | "includes" | "unshift" | "push" | "flat" | "join" | "slice" | "reverse" | ["flat", number] | ["join", string] | ["slice", number, number?];
     type WatchEventValue = WATCH_EVENT[keyof WATCH_EVENT];
 
     function createAbortError(reject: true): Promise<never>;
-    function createAbortError(): AbortError;
+    function createAbortError(): DOMException;
     function hasBit(value: unknown, flags: number): boolean;
     function ignoreFlag(value: unknown): boolean;
     function cloneFlag(value: unknown): boolean;
@@ -280,7 +290,7 @@ declare namespace types {
     function mainFlag(value: unknown): boolean;
     function existsFlag(value: unknown): boolean;
     function getLogCurrent(): Null<LogArguments>;
-    function setLogCurrent(value: LogArguments): void;
+    function setLogCurrent(value: Null<LogArguments>): void;
     function setTempDir(value: string): boolean;
     function getTempDir(): string;
     function isArray<T>(value: unknown): value is T[];
@@ -289,11 +299,11 @@ declare namespace types {
     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 parseTime(value: number | string, start?: number): number;
+    function parseExpires(value: number | string, 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: number | string): number;
     function convertTime(value: HighResolutionTime, format: true): string;
     function convertTime(value: HighResolutionTime, format?: boolean): number;
     function hasGlob(value: string): boolean;
@@ -311,13 +321,16 @@ declare namespace types {
     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>;
-    /** @deprecated crypto.randomUUID */
-    function generateUUID(): string;
+    function hashKey(data: BinaryLike, algorithm?: string, encoding?: BinaryToTextEncoding): string;
+    /** @deprecated - crypto.randomUUID */
+    function generateUUID(options?: RandomUUIDOptions): 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;
-    function errorMessage(title: NumString, value: string, hint?: string): Error;
+    function errorMessage(title: number | string, value: string, hint?: string): Error;
+    function supported(major: number, minor?: number, patch?: number, lts?: boolean): boolean;
+    function importESM<T = unknown>(name: string, isDefault?: boolean, fromPath?: boolean): Promise<T>;
     function purgeMemory(percent?: number): number;
 }