toolbox-x 1.0.0

package/dist/specials-DzLr1ZgU.cjs

@@ -0,0 +1,477 @@
+/**
+ * Copyright 2026 - present Nazmul Hassan
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+const require_primitives = require('./primitives-B26uZolQ.cjs');
+
+//#region src/guards/non-primitives.ts
+/**
+* * Type guard to check if a value is an array.
+* @param value - The value to check.
+* @returns `true` if the value is an array, otherwise `false`.
+*/
+function isArray(value) {
+	return Array.isArray(value);
+}
+/**
+* * Type guard to check if a value is an array with length.
+* @param value - The value to check.
+* @returns `true` if the value is an array with length, otherwise `false`.
+*/
+function isValidArray(value) {
+	return Array.isArray(value) && value?.length > 0;
+}
+/**
+* * Type guard to check if a value is an object (excluding null).
+* @param value - The value to check.
+* @returns `true` if the value is an object, otherwise `false`.
+*/
+function isObject(value) {
+	return value !== null && typeof value === "object" && !isArray(value);
+}
+/**
+* * Type guard to check if a value is an object (excluding null) and has keys in it.
+* @param value - The value to check.
+* @returns `true` if the value is an object with valid keys, otherwise `false`.
+*/
+function isNotEmptyObject(value) {
+	return isObject(value) && Object.keys(value)?.length > 0;
+}
+/**
+* * Type guard to check if a value is an object with specific keys.
+* @param value - The value to check.
+* @param keys - The list of keys the object should contain.
+* @returns `true` if the value is an object with the specified keys, otherwise `false`.
+*/
+function isObjectWithKeys(value, keys) {
+	return isObject(value) && keys?.every((key) => key in value);
+}
+/**
+* * Type guard to check if a value is an empty object.
+* @param value - The value to check.
+* @returns `true` if the value is an empty object, otherwise `false`.
+*/
+function isEmptyObject(value) {
+	return isObject(value) && Object.keys(value)?.length === 0;
+}
+/**
+* * Type guard to check if a value is a function.
+* @param value - The value to check.
+* @returns `true` if the value is a function, otherwise `false`.
+*/
+function isFunction(value) {
+	return typeof value === "function";
+}
+/**
+* * Determines whether the provided property descriptor represents a method.
+*
+* @param descriptor - The property descriptor to check.
+* @returns `true` if the descriptor is defined and its value is a function; otherwise, `false`.
+*/
+const isMethodDescriptor = (descriptor) => {
+	return !!descriptor && typeof descriptor?.value === "function";
+};
+/**
+* * Type guard to check if a value is a Date object.
+* @param value - The value to check.
+* @returns `true` if the value is a Date object, otherwise `false`.
+*/
+function isDate(value) {
+	return value instanceof Date;
+}
+/**
+* * Type guard to check if a value is an array of a specific type.
+* @param value - The value to check.
+* @param typeCheck - The type guard function to check each item of the array.
+* @returns `true` if the value is an array of the specified type, otherwise `false`.
+*/
+function isArrayOfType(value, typeCheck) {
+	return isArray(value) && value?.every(typeCheck);
+}
+/**
+* * Type guard to check if a value is a Promise.
+* @param value - The value to check.
+* @returns `true` if the value is a Promise, otherwise `false`.
+*/
+function isPromise(value) {
+	return isObject(value) && isFunction(value.then);
+}
+/**
+* * Type guard to check if a value is a Set.
+* @param value - The value to check.
+* @returns `true` if the value is a Set, otherwise `false`.
+*/
+function isSet(value) {
+	return value instanceof Set;
+}
+/**
+* * Type guard to check if a value is a Map.
+* @param value - The value to check.
+* @returns `true` if the value is a Map, otherwise `false`.
+*/
+function isMap(value) {
+	return value instanceof Map;
+}
+/**
+* * Type guard to check if a value is a RegExp.
+* @param value - The value to check.
+* @returns `true` if the value is a RegExp, otherwise `false`.
+*/
+function isRegExp(value) {
+	return value instanceof RegExp;
+}
+/**
+* * Type guard to check if a value is an Error object.
+* @param value - The value to check.
+* @returns `true` if the value is an Error object, otherwise `false`.
+*/
+function isError(value) {
+	return value instanceof Error;
+}
+/**
+* * Type guard to check if a string is valid JSON.
+* @param value - The value to check.
+* @returns `true` if the value is valid JSON, otherwise `false`.
+*/
+function isJSON(value) {
+	if (!require_primitives.isString(value)) return false;
+	try {
+		JSON.parse(value);
+		return true;
+	} catch {
+		return false;
+	}
+}
+/**
+* * Type guard to check if a function returns a Promise.
+* @param fn - The function to check.
+* @returns `true` if the function returns a Promise, otherwise `false`.
+*/
+function isReturningPromise(fn) {
+	return isFunction(fn) && fn.constructor?.name === "AsyncFunction";
+}
+
+//#endregion
+//#region src/guards/specials.ts
+/**
+* * Type guard to check if a value is a valid email string.
+* @param value - The value to check.
+* @returns `true` if the value is a valid email, otherwise `false`.
+*/
+function isEmail(value) {
+	return require_primitives.isString(value) && /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/.test(value);
+}
+/**
+* * Type guard to check if a value is an array of valid email strings.
+* @param value - The value to check.
+* @returns `true` if the value is an array of valid email strings, otherwise `false`.
+*/
+function isEmailArray(value) {
+	return isArray(value) && value?.every(isEmail);
+}
+/**
+* * Type guard to check if a value is a valid date string.
+* @param value - The value to check.
+* @returns `true` if the value is a valid date string, otherwise `false`.
+*/
+function isDateString(value) {
+	return require_primitives.isString(value) && !isNaN(Date.parse(value));
+}
+/**
+* * Type guard to check if a value is a valid UUID (`RFC4122` `v1`-`v8`).
+* @param value - The value to check.
+* @returns `true` if the value matches standard UUID pattern, otherwise `false`.
+*/
+function isUUID(value) {
+	const h = "[0-9a-f]";
+	const expr = new RegExp(`^${h}{8}-${h}{4}-[1-8]${h}{3}-[89ab]${h}{3}-${h}{12}$`, "i");
+	return require_primitives.isString(value) && expr.test(value);
+}
+/**
+* * Type guard to check if the code is running in a browser environment.
+* @returns `true` if the code is running in a browser, otherwise `false`.
+*/
+function isBrowser() {
+	return typeof window !== "undefined" && typeof document !== "undefined";
+}
+/**
+* * Type guard to check if the code is running in a Node.js environment.
+* @returns `true` if the code is running in Node.js, otherwise `false`.
+*/
+function isNode() {
+	return typeof process !== "undefined" && process.versions != null && process.versions.node != null;
+}
+/**
+* * Type guard to check if a value is a valid URL.
+* @param value - The value to check.
+* @returns `true` if the value is a valid URL, otherwise `false`.
+*/
+function isURL(value) {
+	try {
+		new URL(require_primitives.isString(value) ? value : "");
+		return true;
+	} catch {
+		return false;
+	}
+}
+/**
+* * Type guard to check if a value is a valid Base64 encoded string.
+* @param value - The value to check.
+* @returns `true` if the value is a valid Base64 string, otherwise `false`.
+*/
+function isBase64(value) {
+	return require_primitives.isString(value) && /^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/.test(value);
+}
+/**
+* * Type guard to check if a value is a valid hexadecimal byte sequence.
+* @param value - The value to check, spaced between bytes or un-spaced.
+* @returns `true` if the value is a valid hexadecimal byte sequence, otherwise `false`.
+*/
+function isHexString(value) {
+	return require_primitives.isString(value) && /^[\da-fA-F\s]+$/.test(value) && value.replace(/\s+/g, "").length % 2 === 0;
+}
+/**
+* * Type guard to check if a value is a valid binary byte sequence.
+* @param value - The value to check, spaced between bytes or un-spaced.
+* @returns `true` if the value is a valid binary byte sequence, otherwise `false`.
+*/
+function isBinaryString(value) {
+	return require_primitives.isString(value) && /^[01\s]+$/.test(value) && value.replace(/\s+/g, "").length % 8 === 0;
+}
+/**
+* * Type guard to check if a value is a valid phone number.
+* @param value - The value to check.
+* @returns `true` if the value is a valid phone number, otherwise `false`.
+*/
+function isPhoneNumber(value) {
+	return require_primitives.isString(value) && /^\+?[1-9]\d{1,14}$/.test(value);
+}
+/**
+* * Type guard to check if a value is a valid IP address (IPv4 or IPv6).
+* @param value - The value to check.
+* @returns `true` if the value is a valid IP address, otherwise `false`.
+*/
+function isIPAddress(value) {
+	return require_primitives.isString(value) && /^(?:\d{1,3}\.){3}\d{1,3}$|^([a-f0-9:]+:+)+[a-f0-9]+$/i.test(value);
+}
+/**
+* * Type guard to check if the current environment matches a given string.
+* @param env - The expected environment (e.g., "production", "development").
+* @returns `true` if the value is a numeric string parsable by `Number()`, otherwise `false`.
+*/
+function isEnvironment(env) {
+	return process.env.NODE_ENV === env;
+}
+/**
+* * Type guard to check if a value is a string representing a finite number.
+*
+* @remarks
+* - Accepts strings like: `"42"`, `"  -5.5 "`, `"0.123"`, `"-0"`, `"1e5"`.
+* - Rejects strings like: `"NaN"`, `"Infinity"`, `"-Infinity"`, `"abc"`, `""`, `"42abc"`.
+*
+* @param value - The value to test.
+* @returns `true` if the value is a string that fully represents a finite number.
+*/
+function isNumericString(value) {
+	return require_primitives.isString(value) && value?.trim() !== "" && Number.isFinite(Number(value));
+}
+
+//#endregion
+Object.defineProperty(exports, 'isArray', {
+  enumerable: true,
+  get: function () {
+    return isArray;
+  }
+});
+Object.defineProperty(exports, 'isArrayOfType', {
+  enumerable: true,
+  get: function () {
+    return isArrayOfType;
+  }
+});
+Object.defineProperty(exports, 'isBase64', {
+  enumerable: true,
+  get: function () {
+    return isBase64;
+  }
+});
+Object.defineProperty(exports, 'isBinaryString', {
+  enumerable: true,
+  get: function () {
+    return isBinaryString;
+  }
+});
+Object.defineProperty(exports, 'isBrowser', {
+  enumerable: true,
+  get: function () {
+    return isBrowser;
+  }
+});
+Object.defineProperty(exports, 'isDate', {
+  enumerable: true,
+  get: function () {
+    return isDate;
+  }
+});
+Object.defineProperty(exports, 'isDateString', {
+  enumerable: true,
+  get: function () {
+    return isDateString;
+  }
+});
+Object.defineProperty(exports, 'isEmail', {
+  enumerable: true,
+  get: function () {
+    return isEmail;
+  }
+});
+Object.defineProperty(exports, 'isEmailArray', {
+  enumerable: true,
+  get: function () {
+    return isEmailArray;
+  }
+});
+Object.defineProperty(exports, 'isEmptyObject', {
+  enumerable: true,
+  get: function () {
+    return isEmptyObject;
+  }
+});
+Object.defineProperty(exports, 'isEnvironment', {
+  enumerable: true,
+  get: function () {
+    return isEnvironment;
+  }
+});
+Object.defineProperty(exports, 'isError', {
+  enumerable: true,
+  get: function () {
+    return isError;
+  }
+});
+Object.defineProperty(exports, 'isFunction', {
+  enumerable: true,
+  get: function () {
+    return isFunction;
+  }
+});
+Object.defineProperty(exports, 'isHexString', {
+  enumerable: true,
+  get: function () {
+    return isHexString;
+  }
+});
+Object.defineProperty(exports, 'isIPAddress', {
+  enumerable: true,
+  get: function () {
+    return isIPAddress;
+  }
+});
+Object.defineProperty(exports, 'isJSON', {
+  enumerable: true,
+  get: function () {
+    return isJSON;
+  }
+});
+Object.defineProperty(exports, 'isMap', {
+  enumerable: true,
+  get: function () {
+    return isMap;
+  }
+});
+Object.defineProperty(exports, 'isMethodDescriptor', {
+  enumerable: true,
+  get: function () {
+    return isMethodDescriptor;
+  }
+});
+Object.defineProperty(exports, 'isNode', {
+  enumerable: true,
+  get: function () {
+    return isNode;
+  }
+});
+Object.defineProperty(exports, 'isNotEmptyObject', {
+  enumerable: true,
+  get: function () {
+    return isNotEmptyObject;
+  }
+});
+Object.defineProperty(exports, 'isNumericString', {
+  enumerable: true,
+  get: function () {
+    return isNumericString;
+  }
+});
+Object.defineProperty(exports, 'isObject', {
+  enumerable: true,
+  get: function () {
+    return isObject;
+  }
+});
+Object.defineProperty(exports, 'isObjectWithKeys', {
+  enumerable: true,
+  get: function () {
+    return isObjectWithKeys;
+  }
+});
+Object.defineProperty(exports, 'isPhoneNumber', {
+  enumerable: true,
+  get: function () {
+    return isPhoneNumber;
+  }
+});
+Object.defineProperty(exports, 'isPromise', {
+  enumerable: true,
+  get: function () {
+    return isPromise;
+  }
+});
+Object.defineProperty(exports, 'isRegExp', {
+  enumerable: true,
+  get: function () {
+    return isRegExp;
+  }
+});
+Object.defineProperty(exports, 'isReturningPromise', {
+  enumerable: true,
+  get: function () {
+    return isReturningPromise;
+  }
+});
+Object.defineProperty(exports, 'isSet', {
+  enumerable: true,
+  get: function () {
+    return isSet;
+  }
+});
+Object.defineProperty(exports, 'isURL', {
+  enumerable: true,
+  get: function () {
+    return isURL;
+  }
+});
+Object.defineProperty(exports, 'isUUID', {
+  enumerable: true,
+  get: function () {
+    return isUUID;
+  }
+});
+Object.defineProperty(exports, 'isValidArray', {
+  enumerable: true,
+  get: function () {
+    return isValidArray;
+  }
+});

package/dist/specials-LVONlKbQ.d.cts

@@ -0,0 +1,108 @@
+/**
+ * Copyright 2026 - present Nazmul Hassan
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { g as UUIDVersion, m as UUID } from "./hash-NTpeKYB_.cjs";
+
+//#region src/guards/specials.d.ts
+/**
+ * * Type guard to check if a value is a valid email string.
+ * @param value - The value to check.
+ * @returns `true` if the value is a valid email, otherwise `false`.
+ */
+declare function isEmail(value: unknown): value is string;
+/**
+ * * Type guard to check if a value is an array of valid email strings.
+ * @param value - The value to check.
+ * @returns `true` if the value is an array of valid email strings, otherwise `false`.
+ */
+declare function isEmailArray(value: unknown): value is string[];
+/**
+ * * Type guard to check if a value is a valid date string.
+ * @param value - The value to check.
+ * @returns `true` if the value is a valid date string, otherwise `false`.
+ */
+declare function isDateString(value: unknown): value is string;
+/**
+ * * Type guard to check if a value is a valid UUID (`RFC4122` `v1`-`v8`).
+ * @param value - The value to check.
+ * @returns `true` if the value matches standard UUID pattern, otherwise `false`.
+ */
+declare function isUUID(value: unknown): value is UUID<UUIDVersion>;
+/**
+ * * Type guard to check if the code is running in a browser environment.
+ * @returns `true` if the code is running in a browser, otherwise `false`.
+ */
+declare function isBrowser(): boolean;
+/**
+ * * Type guard to check if the code is running in a Node.js environment.
+ * @returns `true` if the code is running in Node.js, otherwise `false`.
+ */
+declare function isNode(): boolean;
+/**
+ * * Type guard to check if a value is a valid URL.
+ * @param value - The value to check.
+ * @returns `true` if the value is a valid URL, otherwise `false`.
+ */
+declare function isURL(value: unknown): value is string;
+/**
+ * * Type guard to check if a value is a valid Base64 encoded string.
+ * @param value - The value to check.
+ * @returns `true` if the value is a valid Base64 string, otherwise `false`.
+ */
+declare function isBase64(value: unknown): value is string;
+/**
+ * * Type guard to check if a value is a valid hexadecimal byte sequence.
+ * @param value - The value to check, spaced between bytes or un-spaced.
+ * @returns `true` if the value is a valid hexadecimal byte sequence, otherwise `false`.
+ */
+declare function isHexString(value: unknown): value is string;
+/**
+ * * Type guard to check if a value is a valid binary byte sequence.
+ * @param value - The value to check, spaced between bytes or un-spaced.
+ * @returns `true` if the value is a valid binary byte sequence, otherwise `false`.
+ */
+declare function isBinaryString(value: unknown): value is string;
+/**
+ * * Type guard to check if a value is a valid phone number.
+ * @param value - The value to check.
+ * @returns `true` if the value is a valid phone number, otherwise `false`.
+ */
+declare function isPhoneNumber(value: unknown): value is string;
+/**
+ * * Type guard to check if a value is a valid IP address (IPv4 or IPv6).
+ * @param value - The value to check.
+ * @returns `true` if the value is a valid IP address, otherwise `false`.
+ */
+declare function isIPAddress(value: unknown): value is string;
+/**
+ * * Type guard to check if the current environment matches a given string.
+ * @param env - The expected environment (e.g., "production", "development").
+ * @returns `true` if the value is a numeric string parsable by `Number()`, otherwise `false`.
+ */
+declare function isEnvironment(env: string): boolean;
+/**
+ * * Type guard to check if a value is a string representing a finite number.
+ *
+ * @remarks
+ * - Accepts strings like: `"42"`, `"  -5.5 "`, `"0.123"`, `"-0"`, `"1e5"`.
+ * - Rejects strings like: `"NaN"`, `"Infinity"`, `"-Infinity"`, `"abc"`, `""`, `"42abc"`.
+ *
+ * @param value - The value to test.
+ * @returns `true` if the value is a string that fully represents a finite number.
+ */
+declare function isNumericString(value: unknown): value is `${number}`;
+//#endregion
+export { isEmail as a, isHexString as c, isNumericString as d, isPhoneNumber as f, isDateString as i, isIPAddress as l, isUUID as m, isBinaryString as n, isEmailArray as o, isURL as p, isBrowser as r, isEnvironment as s, isBase64 as t, isNode as u };