toolbox-x 1.0.0

package/dist/guards.d.mts

@@ -0,0 +1,399 @@
+/**
+ * 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 { $ as Maybe, Ct as TimeZoneIdNative, J as FalsyPrimitive, Tt as UTCOffset, X as GenericFn, dt as $TimeZoneIdentifier, ft as ClockTime, it as Numeric, lt as ValidArray, st as Primitive, tt as NormalPrimitive, xt as TimeWithUnit, y as GenericObject, z as AsyncFunction } from "./object-B0TV3eHx.mjs";
+import { b as RGB, g as HSLA, h as HSL, s as CSSColor, v as Hex6, x as RGBA, y as Hex8 } from "./Color-D38Xrw65.mjs";
+import { a as isEmail, c as isHexString, d as isNumericString, f as isPhoneNumber, i as isDateString, l as isIPAddress, m as isUUID, n as isBinaryString, o as isEmailArray, p as isURL, r as isBrowser, s as isEnvironment, t as isBase64, u as isNode } from "./specials-D48_IZbd.mjs";
+
+//#region src/colors/guards.d.ts
+/**
+ * Checks if a color is in `Hex` format.
+ *
+ * @param color Color to check.
+ * @returns Boolean: `true` if it's a `Hex` color, `false` if not.
+ */
+declare function isHex6(color: string): color is Hex6;
+/**
+ * Checks if a color is in `Hex8` format.
+ *
+ * @param color Color to check.
+ * @returns Boolean: `true` if it's a `Hex8` color, `false` if not.
+ */
+declare function isHex8(color: string): color is Hex8;
+/**
+ * Checks if a color is in `RGB` format and within valid ranges.
+ *
+ * @param color Color to check.
+ * @returns `true` if it's a `RGB` color, `false` if not.
+ */
+declare function isRGB(color: string): color is RGB;
+/**
+ * Checks if a color is in `RGBA` format and within valid ranges.
+ *
+ * @param color Color to check.
+ * @returns `true` if it's a `RGBA` color, `false` if not.
+ */
+declare function isRGBA(color: string): color is RGBA;
+/**
+ * Checks if a color is in `HSL` format and within valid ranges.
+ *
+ * @param color Color to check.
+ * @returns `true` if it's a `HSL` color, `false` if not.
+ */
+declare function isHSL(color: string): color is HSL;
+/**
+ * Checks if a color is in `HSLA` format and within valid ranges.
+ *
+ * @param color Color to check.
+ * @returns `true` if it's a `HSLA` color, `false` if not.
+ */
+declare function isHSLA(color: string): color is HSLA;
+/** * Check if a string represents a valid `CSSColor`. */
+declare function isCSSColor(value: string): value is CSSColor;
+//#endregion
+//#region src/date/guards.d.ts
+/**
+ * * Checks if the provided value is a valid time string in "HH:MM" format.
+ *
+ * @param value - The value to check.
+ * @returns `true` if the value is a valid time string, `false` otherwise.
+ */
+declare function isValidTime(value: unknown): value is ClockTime;
+/**
+ * * Checks if the provided value is a valid `UTCOffset` (e.g. `UTC-01:30`).
+ *
+ * @param value - The value to check.
+ * @returns `true` if the value is a valid utc offset, `false` otherwise.
+ */
+declare function isValidUTCOffset(value: unknown): value is UTCOffset;
+/**
+ * * Validates whether the provided value is a recognized IANA time zone identifier (excluding `"Factory"`), based on the {@link https://en.wikipedia.org/wiki/List_of_tz_database_time_zones IANA TZ Database}.
+ *
+ * @remarks
+ * - Relies on a large constant map of time zone identifiers, which can increase bundle size in browser environments. Matches against `597` identifiers.
+ * - Prefer {@link isNativeTimeZoneId} when you want a lightweight, native-only validation approach. Matches against `418` identifiers.
+ *
+ * @param value Time zone identifier to validate.
+ * @returns `true` if the value is a valid IANA time zone identifier, otherwise `false`.
+ */
+declare function isValidTimeZoneId(value: unknown): value is $TimeZoneIdentifier;
+/**
+ * * Validates whether the provided value is a supported time zone identifier using the native JavaScript API (`Intl.supportedValuesOf('timeZone')`).
+ *
+ * @remarks
+ * - Uses only native {@link Intl} capabilities—minimal code footprint, highly performant. Matches against `418` identifiers.
+ * - Prefer {@link isValidTimeZoneId} when validation must align strictly with the full
+ *   {@link https://en.wikipedia.org/wiki/List_of_tz_database_time_zones IANA TZ Database}. Matches against `597` identifiers.
+ *
+ * @param value Time zone identifier to validate.
+ * @returns `true` if the value is a valid native JS-supported time zone identifier, otherwise `false`.
+ */
+declare function isNativeTimeZoneId(value: unknown): value is TimeZoneIdNative;
+/**
+ * * Checks if the year is a leap year.
+ *
+ * - A year is a leap year if it is divisible by 4, but not divisible by 100, unless it is also divisible by 400.
+ * - For example, 2000 and 2400 are leap years, but 1900 and 2100 are not.
+ * @param year The year to check.
+ * @returns `true` if the year is a leap year, `false` otherwise.
+ */
+declare function isLeapYear(year: Numeric): boolean;
+/**
+ * * Checks if a value is a date-like object from `Date`, `Chronos`, `Moment.js`, `Day.js`, `Luxon`, `JS-Joda`, or `Temporal`
+ * @param value Value to check if it is date-like object.
+ * @returns `true` if the value is date-like object, otherwise `false`.
+ */
+declare function isDateLike(value: unknown): boolean;
+/** Checks if a value represents time value (number) with different forms of {@link TimeWithUnit units} */
+declare function isTimeWithUnit(value: unknown): value is TimeWithUnit;
+//#endregion
+//#region src/guards/non-primitives.d.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`.
+ */
+declare function isArray<T>(value: unknown): value is Array<T>;
+/**
+ * * 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`.
+ */
+declare function isValidArray<T>(value: unknown): value is Array<T>;
+/**
+ * * 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`.
+ */
+declare function isObject(value: unknown): value is GenericObject;
+/**
+ * * 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`.
+ */
+declare function isNotEmptyObject(value: unknown): value is GenericObject;
+/**
+ * * 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`.
+ */
+declare function isObjectWithKeys<Key extends string>(value: unknown, keys: ValidArray<Key>): value is { [K in Key]: unknown };
+/**
+ * * 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`.
+ */
+declare function isEmptyObject<T extends GenericObject>(value: T): boolean;
+/**
+ * * 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`.
+ */
+declare function isFunction(value: unknown): value is GenericFn;
+/**
+ * * 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`.
+ */
+declare const isMethodDescriptor: (descriptor: Maybe<PropertyDescriptor>) => boolean;
+/**
+ * * 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`.
+ */
+declare function isDate(value: unknown): value is 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`.
+ */
+declare function isArrayOfType<T>(value: unknown, typeCheck: (item: unknown) => item is T): value is T[];
+/**
+ * * 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`.
+ */
+declare function isPromise<T>(value: unknown): value is Promise<T>;
+/**
+ * * 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`.
+ */
+declare function isSet<T>(value: unknown): value is Set<T>;
+/**
+ * * 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`.
+ */
+declare function isMap<K, V>(value: unknown): value is Map<K, V>;
+/**
+ * * 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`.
+ */
+declare function isRegExp(value: unknown): value is 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`.
+ */
+declare function isError(value: unknown): value is 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`.
+ */
+declare function isJSON(value: unknown): value is string;
+/**
+ * * 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`.
+ */
+declare function isReturningPromise<T>(fn: unknown): fn is AsyncFunction<T>;
+//#endregion
+//#region src/guards/primitives.d.ts
+/**
+ * * Type guard to check whether a value is a finite number (excluding `NaN` and `Infinity`).
+ * @param value - The value to test.
+ * @returns `true` if the value is a finite number; otherwise `false`.
+ */
+declare function isNumber(value: unknown): value is number;
+/**
+ * * Type guard to check if a value is a string.
+ * @param value - The value to check.
+ * @returns `true` if the value is a string, otherwise `false`.
+ */
+declare function isString(value: unknown): value is string;
+/**
+ * * Type guard to check if a value is an integer.
+ * @param value - The value to check.
+ * @returns `true` if the value is an integer, otherwise `false`.
+ */
+declare function isInteger(value: unknown): value is number;
+/**
+ * * Type guard to check if a value is a positive integer.
+ * @param value - The value to check.
+ * @returns `true` if the value is a positive integer, otherwise `false`.
+ */
+declare function isPositiveInteger(value: unknown): value is number;
+/**
+ * * Type guard to check if a value is a boolean.
+ * @param value - The value to check.
+ * @returns `true` if the value is a boolean, otherwise `false`.
+ */
+declare function isBoolean(value: unknown): value is boolean;
+/**
+ * * Type guard to check if a value is null.
+ * @param value - The value to check.
+ * @returns `true` if the value is null, otherwise `false`.
+ */
+declare function isNull(value: unknown): value is null;
+/**
+ * * Type guard to check if a value is undefined.
+ * @param value - The value to check.
+ * @returns `true` if the value is undefined, otherwise `false`.
+ */
+declare function isUndefined(value: unknown): value is undefined;
+/**
+ * * Type guard to check if a value is a symbol.
+ * @param value - The value to check.
+ * @returns `true` if the value is a symbol, otherwise `false`.
+ */
+declare function isSymbol(value: unknown): value is symbol;
+/**
+ * * Type guard to check if a value is a BigInt.
+ * @param value - The value to check.
+ * @returns `true` if the value is a BigInt, otherwise `false`.
+ */
+declare function isBigInt(value: unknown): value is bigint;
+/**
+ * * Type guard to check if a value is a primitive (i.e. `string | number | boolean | symbol | bigint | null | undefined`).
+ * @param value - The value to check.
+ * @returns `true` if the value is a primitive, otherwise `false`.
+ */
+declare function isPrimitive(value: unknown): value is Primitive;
+/**
+ * * Type guard to check if a value is a normal primitive (i.e. `string | number | boolean | null | undefined`).
+ * @param value - The value to check.
+ * @returns `true` if the value is a primitive, otherwise `false`.
+ */
+declare function isNormalPrimitive(value: unknown): value is NormalPrimitive;
+/**
+ * * Type guard to check if a value is a non-empty string.
+ * @param value - The value to check.
+ * @returns `true` if the value is a non-empty string, otherwise `false`.
+ */
+declare function isNonEmptyString(value: unknown): value is string;
+/**
+ * * Type guard to check if a value is falsy.
+ * @param value - The value to check.
+ * @returns `true` if the value is falsy, otherwise `false`.
+ */
+declare function isFalsy(value: unknown): value is FalsyPrimitive;
+/**
+ * * Type guard to check if a value is truthy.
+ * @param value - The value to check.
+ * @returns `true` if the value is truthy (not null or undefined), otherwise `false`.
+ */
+declare function isTruthy<T>(value: T): value is Exclude<T, FalsyPrimitive>;
+//#endregion
+//#region src/number/guards.d.ts
+/**
+ * * Check if a number is even or not.
+ *
+ * @param input The number or numeric string to check.
+ * @returns Boolean: `true` if even and `false` if not even.
+ */
+declare const isEven: (input: Numeric) => boolean;
+/**
+ * * Checks if a number is odd or not.
+ *
+ * @param input The number or numeric string to check.
+ * @returns Boolean: `true` if odd and `false` if not odd.
+ */
+declare const isOdd: (input: Numeric) => boolean;
+/**
+ * * Checks if a number is a multiple of another number.
+ *
+ * @param input - The number to check.
+ * @param multipleOf - The number to check against.
+ * @returns `true` if `input` is a multiple of `multipleOf`, otherwise `false`.
+ */
+declare const isMultiple: (input: number, multipleOf: number) => boolean;
+/**
+ * * Checks if a number is a perfect square.
+ *
+ * @param num The number to check.
+ * @returns `true` if the number is a perfect square, otherwise `false`.
+ */
+declare function isPerfectSquare(num: number): boolean;
+/**
+ * * Checks if a number is part of the Fibonacci sequence.
+ *
+ * @param num The number to check.
+ * @returns `true` if the number is a Fibonacci number, otherwise `false`.
+ */
+declare function isFibonacci(num: number): boolean;
+/**
+ * * Checks whether any input is not a finite number.
+ *
+ * @param numbers - The list of numbers to validate.
+ * @returns `true` if any input is not finite.
+ */
+declare function areInvalidNumbers(...numbers: number[]): boolean;
+//#endregion
+//#region src/string/guards.d.ts
+/**
+ * * Checks if a string is a palindrome.
+ * @param input - The string to check.
+ * @returns True if the string is a palindrome, otherwise false.
+ */
+declare const isPalindrome: (input: string) => boolean;
+/**
+ * * Checks if a string is in camelCase format.
+ * @param str The string to check.
+ * @returns `true` if the string is in camelCase, otherwise `false`.
+ */
+declare function isCamelCase(str: string): boolean;
+/**
+ * * Checks if a string is in PascalCase format.
+ * @param str The string to check.
+ * @returns `true` if the string is in PascalCase, otherwise `false`.
+ */
+declare function isPascalCase(str: string): boolean;
+/**
+ * * Checks if a string is in snake_case format.
+ * @param str The string to check.
+ * @returns `true` if the string is in snake_case, otherwise `false`.
+ */
+declare function isSnakeCase(str: string): boolean;
+/**
+ * * Checks if a string is in kebab-case format.
+ * @param str The string to check.
+ * @returns `true` if the string is in kebab-case, otherwise `false`.
+ */
+declare function isKebabCase(str: string): boolean;
+/**
+ * * Checks if a string contains only emojis.
+ * @param str The string to check.
+ * @returns `true` if the string contains only emojis, otherwise `false`.
+ */
+declare function isEmojiOnly(str: string): boolean;
+//#endregion
+export { areInvalidNumbers, areInvalidNumbers as areNumbersInvalid, areInvalidNumbers as isInvalidNumber, areInvalidNumbers as isNumberInvalid, isReturningPromise as doesReturnPromise, isReturningPromise, isArray, isArrayOfType, isValidArray as isArrayWithLength, isValidArray, isBase64, isBigInt, isBinaryString, isBoolean, isBrowser, isCSSColor, isCamelCase, isDate, isDateLike, isDateString, isEmail, isEmail as isValidEmail, isEmailArray, isEmojiOnly, isEmptyObject, isEmptyObject as isEmptyObjectGuard, isEmptyObject as isObjectEmpty, isEnvironment, isEnvironment as isExpectedNodeENV, isEnvironment as isNodeENV, isEnvironment as isNodeEnvironment, isError, isEven, isEven as isEvenNumber, isFalsy, isFibonacci, isFibonacci as isPartOfFibonacci, isFibonacci as isPartOfFibonacciSeries, isFunction, isHSL, isHSLA, isHex6, isHex8, isHexString, isIPAddress, isInteger, isJSON, isJSON as isJSONObject, isJSON as isValidJSON, isKebabCase, isLeapYear, isMap, isMap as isValidMap, isMethodDescriptor as isMethod, isMethodDescriptor, isMultiple, isNativeTimeZoneId, isNode, isNonEmptyString, isNormalPrimitive, isNotEmptyObject, isNotEmptyObject as isValidObject, isNull, isNumber, isNumericString, isObject, isObjectWithKeys, isOdd, isOdd as isOddNumber, isPalindrome, isPascalCase, isPerfectSquare, isPhoneNumber, isPositiveInteger, isPrimitive, isPromise, isRGB, isRGBA, isRegExp, isRegExp as isRegularExpression, isSet, isSet as isValidSet, isSnakeCase, isString, isSymbol, isTimeWithUnit, isTruthy, isURL, isURL as isValidURL, isUUID, isUndefined, isValidTime, isValidTime as isValidTimeString, isValidTimeZoneId, isValidUTCOffset as isValidUTC, isValidUTCOffset as isValidUTCOffSet, isValidUTCOffset };

package/dist/guards.mjs

@@ -0,0 +1,75 @@
+/**
+ * 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 { a as isNonEmptyString, c as isNumber, d as isString, f as isSymbol, i as isInteger, l as isPositiveInteger, m as isUndefined, n as isBoolean, o as isNormalPrimitive, p as isTruthy, r as isFalsy, s as isNull, t as isBigInt, u as isPrimitive } from "./primitives-KsFUp3kQ.mjs";
+import { a as isHex8, i as isHex6, n as isHSL, o as isRGB, r as isHSLA, s as isRGBA, t as isCSSColor } from "./guards-3kaUX66g.mjs";
+import { A as isSet, C as isMethodDescriptor, D as isPromise, E as isObjectWithKeys, O as isRegExp, S as isMap, T as isObject, _ as isDate, a as isEmail, b as isFunction, c as isHexString, d as isNumericString, f as isPhoneNumber, g as isArrayOfType, h as isArray, i as isDateString, j as isValidArray, k as isReturningPromise, l as isIPAddress, m as isUUID, n as isBinaryString, o as isEmailArray, p as isURL, r as isBrowser, s as isEnvironment, t as isBase64, u as isNode, v as isEmptyObject, w as isNotEmptyObject, x as isJSON, y as isError } from "./specials-uhDuRg8H.mjs";
+import { a as isValidTime, i as isTimeWithUnit, n as isLeapYear, o as isValidTimeZoneId, r as isNativeTimeZoneId, s as isValidUTCOffset, t as isDateLike } from "./guards-DdyU4h4o.mjs";
+import { d as isFibonacci, f as isMultiple, l as areInvalidNumbers, m as isPerfectSquare, p as isOdd, s as reverseString, u as isEven } from "./convert-Bn4jFomQ.mjs";
+
+//#region src/string/guards.ts
+/**
+* * Checks if a string is a palindrome.
+* @param input - The string to check.
+* @returns True if the string is a palindrome, otherwise false.
+*/
+const isPalindrome = (input) => {
+	const normalized = input.toLowerCase().replace(/[^a-z0-9]/g, "");
+	return normalized === reverseString(normalized);
+};
+/**
+* * Checks if a string is in camelCase format.
+* @param str The string to check.
+* @returns `true` if the string is in camelCase, otherwise `false`.
+*/
+function isCamelCase(str) {
+	return /^[a-z]+([A-Z][a-z]*)*$/.test(str);
+}
+/**
+* * Checks if a string is in PascalCase format.
+* @param str The string to check.
+* @returns `true` if the string is in PascalCase, otherwise `false`.
+*/
+function isPascalCase(str) {
+	return /^[A-Z][a-zA-Z]*$/.test(str);
+}
+/**
+* * Checks if a string is in snake_case format.
+* @param str The string to check.
+* @returns `true` if the string is in snake_case, otherwise `false`.
+*/
+function isSnakeCase(str) {
+	return /^[a-z]+(_[a-z]+)*$/.test(str);
+}
+/**
+* * Checks if a string is in kebab-case format.
+* @param str The string to check.
+* @returns `true` if the string is in kebab-case, otherwise `false`.
+*/
+function isKebabCase(str) {
+	return /^[a-z]+(-[a-z]+)*$/.test(str);
+}
+/**
+* * Checks if a string contains only emojis.
+* @param str The string to check.
+* @returns `true` if the string contains only emojis, otherwise `false`.
+*/
+function isEmojiOnly(str) {
+	return /^[\p{Emoji}]+$/u.test(str);
+}
+
+//#endregion
+export { areInvalidNumbers, areInvalidNumbers as areNumbersInvalid, areInvalidNumbers as isInvalidNumber, areInvalidNumbers as isNumberInvalid, isReturningPromise as doesReturnPromise, isReturningPromise, isArray, isArrayOfType, isValidArray as isArrayWithLength, isValidArray, isBase64, isBigInt, isBinaryString, isBoolean, isBrowser, isCSSColor, isCamelCase, isDate, isDateLike, isDateString, isEmail, isEmail as isValidEmail, isEmailArray, isEmojiOnly, isEmptyObject, isEmptyObject as isEmptyObjectGuard, isEmptyObject as isObjectEmpty, isEnvironment, isEnvironment as isExpectedNodeENV, isEnvironment as isNodeENV, isEnvironment as isNodeEnvironment, isError, isEven, isEven as isEvenNumber, isFalsy, isFibonacci, isFibonacci as isPartOfFibonacci, isFibonacci as isPartOfFibonacciSeries, isFunction, isHSL, isHSLA, isHex6, isHex8, isHexString, isIPAddress, isInteger, isJSON, isJSON as isJSONObject, isJSON as isValidJSON, isKebabCase, isLeapYear, isMap, isMap as isValidMap, isMethodDescriptor as isMethod, isMethodDescriptor, isMultiple, isNativeTimeZoneId, isNode, isNonEmptyString, isNormalPrimitive, isNotEmptyObject, isNotEmptyObject as isValidObject, isNull, isNumber, isNumericString, isObject, isObjectWithKeys, isOdd, isOdd as isOddNumber, isPalindrome, isPascalCase, isPerfectSquare, isPhoneNumber, isPositiveInteger, isPrimitive, isPromise, isRGB, isRGBA, isRegExp, isRegExp as isRegularExpression, isSet, isSet as isValidSet, isSnakeCase, isString, isSymbol, isTimeWithUnit, isTruthy, isURL, isURL as isValidURL, isUUID, isUndefined, isValidTime, isValidTime as isValidTimeString, isValidTimeZoneId, isValidUTCOffset as isValidUTC, isValidUTCOffset as isValidUTCOffSet, isValidUTCOffset };

package/dist/hash-B6JPEyAz.d.mts

@@ -0,0 +1,131 @@
+/**
+ * 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 { V as Branded, it as Numeric, xt as TimeWithUnit, y as GenericObject } from "./object-B0TV3eHx.mjs";
+
+//#region src/types/hash.d.ts
+/** UUID versions as number from `1-8` */
+type $UUIDVersion = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8;
+/** UUID versions as string from `v1-v8` */
+type UUIDVersion = `v${$UUIDVersion}`;
+/** Supported UUID versions (without `v2`) as string */
+type SupportedVersion = `v${Exclude<$UUIDVersion, 2>}`;
+/** General 5 parts UUID string type */
+type $UUID = `${string}-${string}-${string}-${string}-${string}`;
+/** General 5 parts UUID string as {@link Branded} type */
+type UUID<V extends UUIDVersion> = Branded<$UUID, V>;
+/** * Options for generating UUID for `v3` and `v5` */
+interface $UUIDOptionsV3V5<V extends 'v3' | 'v5'> extends $UUIDOptions<V> {
+  /** Namespace for `v3` and `v5` UUID (must be another valid UUID) */
+  namespace: $UUID;
+  /** Name for `v3` and `v5` UUID (must be a non-empty string) */
+  name: string;
+}
+/** * General Options for generating UUID */
+interface $UUIDOptions<V extends SupportedVersion = 'v4'> {
+  /** UUID version, default `'v4'` */
+  version?: V | SupportedVersion;
+  /** Whether to use uppercase characters (default `false`) */
+  uppercase?: boolean;
+}
+/** * Options for generating UUID */
+type UUIDOptions<V extends SupportedVersion = 'v4'> = V extends 'v3' | 'v5' ? $UUIDOptionsV3V5<V> : $UUIDOptions<V>;
+/** Type representing decoded UUID info */
+interface DecodedUUID {
+  /** Original UUID */
+  raw: UUID<UUIDVersion>;
+  /** Plain version of the UUID without hyphens (`-`) */
+  plain: string;
+  /** Version of the UUID as number */
+  version: $UUIDVersion;
+  /** Variant of the UUID */
+  variant: 'NCS' | 'RFC4122' | 'Microsoft' | 'Future';
+  /** Single integer value of the UUID in bigint */
+  singleInt: bigint;
+  /** Timestamp for `v1`, `v6`, `v7` and `v8` (in ms since epoch) */
+  timestamp?: number;
+  /** v1 node (MAC) */
+  node?: string;
+}
+/** Header for `Signet` */
+type SignetHeader = {
+  /** Algorithm used. Currently supports `'HS256'` only */alg: 'HS256'; /** Type of token. Fixed `'SIGNET+JWT'` */
+  typ: 'SIGNET+JWT';
+};
+/** Options for token verification */
+type VerifyOptions = {
+  /** Where the token is allowed to be used */audience?: string | string[]; /** Who the token is about */
+  subject?: string; /** From where/who the token is issued */
+  issuer?: string;
+};
+/** Token signing options */
+interface SignOptions extends VerifyOptions {
+  /**
+   * * Specifies when the token expires after issuing it.
+   *
+   * @remarks
+   * - A numeric value (number or numeric string ({@link Numeric})) is interpreted as seconds count, e.g., `120` or `'120'` will be treated as `'120 seconds'`.
+   * - If you use time value with unit ({@link TimeWithUnit}) be sure you provide the time units (days, hours, etc.), otherwise it will return `NaN`, e.g., `'120 unknown'` will return `NaN`.
+   */
+  expiresIn?: TimeWithUnit | Numeric;
+  /**
+   * * Specifies when the token becomes active/valid in the future.
+   *
+   * @remarks
+   * - A numeric value (number or numeric string ({@link Numeric})) is interpreted as seconds count, e.g., `120` or `'120'` will be treated as `'120 seconds'`.
+   * - If you use time value with unit ({@link TimeWithUnit}) be sure you provide the time units (days, hours, etc.), otherwise it will return `NaN`, e.g., `'120 unknown'` will return `NaN`.
+   */
+  notBefore?: TimeWithUnit | Numeric;
+}
+/** 3-parts dot separated token string */
+type TokenString = `${string}.${string}.${string}`;
+/** Interface of token verification result if token is valid */
+type $ValidToken<T extends GenericObject = GenericObject> = {
+  /** Whether the token is valid */isValid: true; /** Decoded payload after successful verification with common {@link SignetPayload} properties */
+  payload: SignetPayload<T>;
+};
+/** Interface of token verification result if token is invalid */
+type $InvalidToken = {
+  /** Whether the token is valid */isValid: false; /** Error message if the token is invalid */
+  error: string;
+};
+/** Result of token verification */
+type VerifiedToken<T extends GenericObject = GenericObject> = $ValidToken<T> | $InvalidToken;
+/** Decoded `Signet` payload with `iat` and optional claims */
+type SignetPayload<T extends GenericObject = GenericObject> = {
+  /** When the token was created (unix timestamp in seconds) */iat: number; /** When the token was created (as JavaScript {@link Date}) */
+  iatDate: Date; /** When the token expires (unix timestamp in seconds) */
+  exp?: number; /** When the token expires (as JavaScript {@link Date}) */
+  expDate?: Date; /** When the token becomes valid (unix timestamp in seconds) */
+  nbf?: number; /** When the token becomes valid (as JavaScript {@link Date}) */
+  nbfDate?: Date; /** Where the token is allowed to be used */
+  aud?: string | string[]; /** Who the token is about */
+  sub?: string; /** From where/who the token is issued */
+  iss?: string;
+} & T;
+/** Interface of a decoded token */
+type DecodedToken<T extends GenericObject = GenericObject> = {
+  /** Token header info, algorithm, type etc. */header: SignetHeader; /** Decoded payload after with common {@link SignetPayload} properties */
+  payload: SignetPayload<T>;
+  /**
+   * The `Base64`-encoded signature from the token.
+   * This is the third part of the token string.
+   */
+  signature: string; /** The header and payload in encrypted `Base64` format.*/
+  signingInput: `${string}.${string}`;
+};
+//#endregion
+export { VerifiedToken as _, $UUIDVersion as a, DecodedUUID as c, SignetPayload as d, SupportedVersion as f, UUIDVersion as g, UUIDOptions as h, $UUIDOptionsV3V5 as i, SignOptions as l, UUID as m, $UUID as n, $ValidToken as o, TokenString as p, $UUIDOptions as r, DecodedToken as s, $InvalidToken as t, SignetHeader as u, VerifyOptions as v };