@e-mc/types 0.10.6 → 0.11.1

package/LICENSE

@@ -8,4 +8,4 @@ Redistribution and use in source and binary forms, with or without modification,
 
 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.
+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

@@ -1,7 +1,7 @@
 # @e-mc/types
 
-* NodeJS 16
-* ES2020
+* NodeJS 16 LTS
+* ES2021
 
 ## General Usage
 
@@ -9,13 +9,14 @@
 
 ## Interface
 
-* [View Source](https://www.unpkg.com/@e-mc/types@0.10.6/index.d.ts)
+* [View Source](https://www.unpkg.com/@e-mc/types@0.11.1/index.d.ts)
 
 ```typescript
 import type { LogArguments } from "./lib/logger";
+import type { HighResolutionTime } from "./lib/node";
 
+import type { BinaryLike, CipherGCMTypes, Encoding, RandomUUIDOptions } from "node:crypto";
 import type { BytesOptions } from "bytes";
-import type { BinaryLike, CipherGCMTypes, Encoding, RandomUUIDOptions } from "crypto";
 
 function createAbortError(reject: true): Promise<never>;
 function createAbortError(): DOMException;
@@ -46,7 +47,7 @@ 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;
-function escapePattern(value: unknown, lookBehind?: boolean): string;
+function escapePattern(value: unknown, lookBehind?: boolean, reserved?: boolean): string;
 function renameExt(value: string, ext: string, when?: string): string;
 function formatSize(value: string): number;
 function formatSize(value: number, options?: BytesOptions): string;
@@ -68,6 +69,7 @@ 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, lts: boolean): boolean;
 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;
@@ -196,14 +198,14 @@ const IMPORT_MAP: Record<string, string | undefined>;
 
 ## References
 
-- https://www.unpkg.com/@e-mc/types@0.10.6/index.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.6/lib/logger.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.6/lib/module.d.ts
-- https://www.unpkg.com/@e-mc/types@0.10.6/lib/object.d.ts
+- https://www.unpkg.com/@e-mc/types@0.11.1/index.d.ts
+- https://www.unpkg.com/@e-mc/types@0.11.1/lib/logger.d.ts
+- https://www.unpkg.com/@e-mc/types@0.11.1/lib/module.d.ts
+- https://www.unpkg.com/@e-mc/types@0.11.1/lib/node.d.ts
 
 * https://developer.mozilla.org/en-US/docs/Web/API/DOMException
 * https://www.npmjs.com/package/@types/bytes
 
 ## LICENSE
 
-BSD 3-Clause
+BSD 3-Clause

package/constant.d.ts

@@ -1,5 +1,5 @@
 export const enum INTERNAL {
-    VERSION = '0.9.15',
+    VERSION = '0.11.1',
     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,17 @@ 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',
+    EXPECT_CONTINUE = 'Did not receive continue acknowledgment',
     DOWNLOAD_SUCCESS = 'No files were successfully downloaded',
     MULTIPART_ATTACH = 'No files were attached'
 }
@@ -203,7 +225,6 @@ 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',
@@ -218,7 +239,6 @@ export const enum PACKAGE_NAME {
     IMAGE = '@e-mc/image',
     IMAGE_JIMP = '@pi-r/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',
     REQUEST_UTIL = '@e-mc/request/util',
@@ -229,6 +249,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 +291,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 {
@@ -281,6 +309,7 @@ export const enum SETTINGS_KEY_NAME {
     NODE_REQUIRE_EXT = "node.require.ext",
     NODE_REQUIRE_NPM = "node.require.npm",
     NODE_REQUIRE_INLINE = "node.require.inline",
+    NODE_PACKAGE_MANAGER = "node.settings.package_manager",
     TEMP_DIR = "temp.dir",
     TEMP_WRITE = "temp.write",
     PROCESS_PASSWORD = "process.password",

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 { HighResolutionTime } from './lib/node';
 
-import type { BinaryLike, CipherGCMTypes, Encoding } from 'crypto';
+import type { BinaryLike, BinaryToTextEncoding, CipherGCMTypes, Encoding, RandomUUIDOptions } from 'node: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,25 @@ declare namespace types {
 
     const IMPORT_MAP: StringMap;
 
+    interface CloneObjectOptions<T = unknown> {
+        target?: T;
+        deep?: boolean;
+        deepIgnore?: WeakSet<object>;
+        freezeDepth?: number | boolean;
+        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;
@@ -279,8 +290,8 @@ declare namespace types {
     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 getLogCurrent(): LogArguments | null;
+    function setLogCurrent(value: LogArguments | null): void;
     function setTempDir(value: string): boolean;
     function getTempDir(): string;
     function isArray<T>(value: unknown): value is T[];
@@ -288,16 +299,16 @@ declare namespace types {
     function isPlainObject<T = PlainObject>(value: unknown): value is T;
     function isString(value: unknown): value is string;
     function isEmpty(value: unknown): boolean;
-    function asFunction<U = unknown, V = unknown>(value: unknown, sync?: boolean): Null<FunctionType<U, V>>;
-    function parseTime(value: NumString, start?: number): number;
-    function parseExpires(value: NumString, start?: number): number;
+    function asFunction<U = unknown, V = unknown>(value: unknown, sync?: boolean): FunctionType<U, V> | null;
+    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;
-    function escapePattern(value: unknown, lookBehind?: boolean): string;
+    function escapePattern(value: unknown, symbols?: boolean): string;
     function renameExt(value: string, ext: string, when?: string): string;
     function formatSize(value: string): number;
     function formatSize(value: number, options?: BytesOptions): string;
@@ -309,15 +320,19 @@ declare namespace types {
     function coerceObject<T = unknown>(data: T, 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>;
-    /** @deprecated crypto.randomUUID */
-    function generateUUID(): string;
+    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 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, lts: boolean): boolean;
+    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;
 }