defuss-runtime 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,238 @@
+declare const _BASE64_CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+declare let _base64LookupMap: Record<string, number> | null;
+declare function _getBase64LookupMap(): Record<string, number>;
+declare function binaryToBase64(buffer: ArrayBufferLike): string;
+declare function base64ToBinary(base64: string): ArrayBufferLike;
+
+declare const _HEX_PREFIX = "hex:";
+declare function binaryToHex(buffer: ArrayBufferLike): string;
+declare function hexToBinary(hexString: string): ArrayBufferLike;
+declare function textToBinary(text: string): ArrayBufferLike;
+declare function binaryToText(buffer: ArrayBufferLike): string;
+
+declare const getAllKeysFromPath: (path: string) => Array<string | number>;
+declare const ensureKey: (obj: Record<string, any>, key: string | number, nextKey?: string | number) => void;
+declare const getByPath: (obj: any, path: string) => any;
+declare const setByPath: (obj: any, path: string, value: any) => any;
+
+/**
+ * Return a new array with unique values from the input array.
+ * @param a - The array to dedupe
+ * @returns Array of unique values
+ */
+declare function unique<T>(a: readonly T[]): T[];
+
+/**
+ * Pick specific keys from an object.
+ * @param o - The source object
+ * @param keys - Array of keys to pick
+ * @returns New object with only the picked keys
+ */
+declare function pick<T extends object, K extends keyof T>(o: T, keys: readonly K[]): Pick<T, K>;
+
+/**
+ * Omit specific keys from an object.
+ * @param o - The source object
+ * @param keys - Array of keys to omit
+ * @returns New object without the omitted keys
+ */
+declare function omit<T extends object, K extends keyof T>(o: T, keys: readonly K[]): Omit<T, K>;
+
+/**
+ * Check deep equality of two values via JSON serialization.
+ * Non-serializable values (functions, undefined) are omitted.
+ * @param a - First value to compare
+ * @param b - Second value to compare
+ * @returns True if the serialized values are identical, false otherwise
+ */
+declare function equalsJSON<T>(a: T, b: T): boolean;
+
+/**
+ * Unique symbol to identify path accessor objects
+ */
+declare const PATH_ACCESSOR_SYMBOL: unique symbol;
+/**
+ * Type helper for access accessor that returns string paths
+ * This type allows chaining property access while maintaining type safety
+ * and ultimately returning a string representation of the access
+ */
+type PathAccessor<T> = T extends object ? {
+    [K in keyof T]: T[K] extends object ? PathAccessor<T[K]> & string : string;
+} & {
+    [K in number]: T extends readonly (infer U)[] ? PathAccessor<U> & string : T extends Record<number, infer U> ? PathAccessor<U> & string : PathAccessor<Dynamic> & string;
+} & string : string;
+/**
+ * Dynamic type for untyped object property access
+ * Use this with access<Dynamic>() to enable arbitrary property access
+ */
+type Dynamic = {
+    [key: string]: Dynamic;
+    [key: number]: Dynamic;
+};
+/**
+ * Creates a type-safe access accessor that returns string representations of property paths
+ *
+ * @example
+ * ```typescript
+ * interface User {
+ *   profile: {
+ *     preferences: {
+ *       theme: string;
+ *     };
+ *   };
+ * }
+ *
+ * const themePath = access<User>().profile.preferences.theme;
+ * console.log(String(themePath)); // "profile.preferences.theme"
+ *
+ * // For dynamic usage without types:
+ * const dynamicPath = access<Dynamic>().some.dynamic.path;
+ * console.log(String(dynamicPath)); // "some.dynamic.path"
+ * ```
+ */
+declare const access: <T = any>() => PathAccessor<T>;
+/**
+ * Checks if an object is a path accessor created by the access() function
+ *
+ * @param obj - The object to check
+ * @returns True if the object is a path accessor, false otherwise
+ *
+ * @example
+ * ```typescript
+ * const path = access<User>().profile.theme;
+ * const regularString = "profile.theme";
+ *
+ * console.log(isPathAccessor(path)); // true
+ * console.log(isPathAccessor(regularString)); // false
+ * ```
+ */
+declare const isPathAccessor: (obj: any) => obj is PathAccessor<any>;
+
+/**
+ * Debounce a function: delays invoking `fn` until after `wait` ms have elapsed
+ * since the last time the debounced function was called.
+ * @param fn - The function to debounce
+ * @param wait - Milliseconds to wait
+ * @returns Debounced function
+ */
+declare function debounce<F extends (...args: any[]) => any>(fn: F, wait: number): (...args: Parameters<F>) => void;
+
+/**
+ * Throttle a function: ensures that `fn` is called at most once every `wait` ms.
+ * @param fn - The function to throttle
+ * @param wait - Milliseconds to wait
+ * @returns Throttled function
+ */
+declare function throttle<F extends (...args: any[]) => any>(fn: F, wait: number): (...args: Parameters<F>) => void;
+
+/**
+ * Wait for a specified amount of time.
+ * @param ms - Milliseconds to wait
+ * @returns A promise that resolves after the specified time
+ */
+declare function wait(ms: number): Promise<void>;
+declare function createTimeoutPromise<T>(timeoutMs: number, operation: () => Promise<T> | T, timeoutCallback?: (ms: number) => void): Promise<T>;
+declare function waitForWithPolling<T>(check: () => T | null | undefined, timeout: number, interval?: number): Promise<T>;
+declare function waitForRef<T>(ref: {
+    current: T | null;
+}, timeout: number): Promise<T>;
+
+declare const asString: (value: any) => string;
+
+declare const asNumber: (value: any) => number;
+
+declare const asBoolean: (value: any) => boolean;
+
+declare const asArray: (value: any, transformerFn: (value: any) => any) => any[];
+
+declare const asDate: (value: any) => Date;
+
+declare const asInteger: (value: any) => number;
+
+declare const isAfter: (value: Date | undefined, minDate: Date, inclusive?: boolean) => value is Date;
+
+type ValidationMessage = string | number | boolean | null | undefined;
+type ValidationFnResult = true | ValidationMessage;
+type ValidatorPrimitiveFn<T = unknown> = (value: T) => boolean | Promise<boolean>;
+interface SingleValidationResult {
+    message?: ValidationMessage;
+    isValid: boolean;
+}
+type ValidatorFn<T extends unknown[] = unknown[]> = (...args: T) => boolean | string;
+type ValidationStep<T extends unknown[] = unknown[]> = {
+    fn: ValidatorFn<T>;
+    args: T;
+};
+
+declare const isArray: ValidatorPrimitiveFn;
+
+declare const isBefore: (value: Date | undefined, maxDate: Date, inclusive?: boolean) => value is Date;
+
+declare const isBoolean: ValidatorPrimitiveFn;
+
+declare const isDate: ValidatorPrimitiveFn;
+
+declare const isDefined: ValidatorPrimitiveFn;
+
+declare const isEmail: ValidatorPrimitiveFn;
+
+declare const isEmpty: ValidatorPrimitiveFn;
+
+declare const is: (value: any, valueB: any) => boolean;
+
+declare const isGreaterThan: (value: any, minValue: number, includeEqual?: boolean) => boolean;
+
+/**
+ * Checks if a value is a safe number (not NaN and finite).
+ * @param value - The value to check
+ * @returns True if the value is a safe number, false otherwise
+ */
+declare const isSafeNumber: ValidatorPrimitiveFn;
+
+/**
+ * Checks if a value (number or string) is a numeric and a safe number.
+ * @param value - The value to check
+ * @returns True if the value is numeric, false otherwise
+ */
+declare const isSafeNumeric: ValidatorPrimitiveFn;
+
+declare const isObject: ValidatorPrimitiveFn;
+
+declare const isOneOf: (value: any, options: Array<string | number>) => boolean;
+
+declare const isPhoneNumber: ValidatorPrimitiveFn;
+
+declare const isRequired: ValidatorPrimitiveFn;
+
+declare const isSlug: ValidatorPrimitiveFn;
+
+declare const isLessThan: (value: any, maxValue: number, includeEqual?: boolean) => boolean;
+
+declare const isString: ValidatorPrimitiveFn;
+
+declare const isUrl: ValidatorPrimitiveFn;
+
+declare const isUrlPath: ValidatorPrimitiveFn;
+
+interface DateValue {
+    month: number;
+    year: number;
+    date: number;
+    hour: number;
+    minute: number;
+    second: number;
+    millisecond: number;
+}
+declare const getDateValue: (date: Date) => DateValue;
+
+declare const isLongerThan: (value: any, minLength: number, includeEqual?: boolean) => boolean;
+
+declare const isShorterThan: (value: any, maxLength: number, includeEqual?: boolean) => boolean;
+
+declare const hasPattern: (value: any, pattern: RegExp) => boolean;
+
+declare const isInteger: ValidatorPrimitiveFn;
+
+declare const isEqual: (value: any, valueB: any) => boolean;
+
+export { type DateValue, type Dynamic, PATH_ACCESSOR_SYMBOL, type PathAccessor, type SingleValidationResult, type ValidationFnResult, type ValidationMessage, type ValidationStep, type ValidatorFn, type ValidatorPrimitiveFn, _BASE64_CHARS, _HEX_PREFIX, _base64LookupMap, _getBase64LookupMap, access, asArray, asBoolean, asDate, asInteger, asNumber, asString, base64ToBinary, binaryToBase64, binaryToHex, binaryToText, createTimeoutPromise, debounce, ensureKey, equalsJSON, getAllKeysFromPath, getByPath, getDateValue, hasPattern, hexToBinary, is, isAfter, isArray, isBefore, isBoolean, isDate, isDefined, isEmail, isEmpty, isEqual, isGreaterThan, isInteger, isLessThan, isLongerThan, isObject, isOneOf, isPathAccessor, isPhoneNumber, isRequired, isSafeNumber, isSafeNumeric, isShorterThan, isSlug, isString, isUrl, isUrlPath, omit, pick, setByPath, textToBinary, throttle, unique, wait, waitForRef, waitForWithPolling };

package/dist/index.d.mts

@@ -0,0 +1,238 @@
+declare const _BASE64_CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+declare let _base64LookupMap: Record<string, number> | null;
+declare function _getBase64LookupMap(): Record<string, number>;
+declare function binaryToBase64(buffer: ArrayBufferLike): string;
+declare function base64ToBinary(base64: string): ArrayBufferLike;
+
+declare const _HEX_PREFIX = "hex:";
+declare function binaryToHex(buffer: ArrayBufferLike): string;
+declare function hexToBinary(hexString: string): ArrayBufferLike;
+declare function textToBinary(text: string): ArrayBufferLike;
+declare function binaryToText(buffer: ArrayBufferLike): string;
+
+declare const getAllKeysFromPath: (path: string) => Array<string | number>;
+declare const ensureKey: (obj: Record<string, any>, key: string | number, nextKey?: string | number) => void;
+declare const getByPath: (obj: any, path: string) => any;
+declare const setByPath: (obj: any, path: string, value: any) => any;
+
+/**
+ * Return a new array with unique values from the input array.
+ * @param a - The array to dedupe
+ * @returns Array of unique values
+ */
+declare function unique<T>(a: readonly T[]): T[];
+
+/**
+ * Pick specific keys from an object.
+ * @param o - The source object
+ * @param keys - Array of keys to pick
+ * @returns New object with only the picked keys
+ */
+declare function pick<T extends object, K extends keyof T>(o: T, keys: readonly K[]): Pick<T, K>;
+
+/**
+ * Omit specific keys from an object.
+ * @param o - The source object
+ * @param keys - Array of keys to omit
+ * @returns New object without the omitted keys
+ */
+declare function omit<T extends object, K extends keyof T>(o: T, keys: readonly K[]): Omit<T, K>;
+
+/**
+ * Check deep equality of two values via JSON serialization.
+ * Non-serializable values (functions, undefined) are omitted.
+ * @param a - First value to compare
+ * @param b - Second value to compare
+ * @returns True if the serialized values are identical, false otherwise
+ */
+declare function equalsJSON<T>(a: T, b: T): boolean;
+
+/**
+ * Unique symbol to identify path accessor objects
+ */
+declare const PATH_ACCESSOR_SYMBOL: unique symbol;
+/**
+ * Type helper for access accessor that returns string paths
+ * This type allows chaining property access while maintaining type safety
+ * and ultimately returning a string representation of the access
+ */
+type PathAccessor<T> = T extends object ? {
+    [K in keyof T]: T[K] extends object ? PathAccessor<T[K]> & string : string;
+} & {
+    [K in number]: T extends readonly (infer U)[] ? PathAccessor<U> & string : T extends Record<number, infer U> ? PathAccessor<U> & string : PathAccessor<Dynamic> & string;
+} & string : string;
+/**
+ * Dynamic type for untyped object property access
+ * Use this with access<Dynamic>() to enable arbitrary property access
+ */
+type Dynamic = {
+    [key: string]: Dynamic;
+    [key: number]: Dynamic;
+};
+/**
+ * Creates a type-safe access accessor that returns string representations of property paths
+ *
+ * @example
+ * ```typescript
+ * interface User {
+ *   profile: {
+ *     preferences: {
+ *       theme: string;
+ *     };
+ *   };
+ * }
+ *
+ * const themePath = access<User>().profile.preferences.theme;
+ * console.log(String(themePath)); // "profile.preferences.theme"
+ *
+ * // For dynamic usage without types:
+ * const dynamicPath = access<Dynamic>().some.dynamic.path;
+ * console.log(String(dynamicPath)); // "some.dynamic.path"
+ * ```
+ */
+declare const access: <T = any>() => PathAccessor<T>;
+/**
+ * Checks if an object is a path accessor created by the access() function
+ *
+ * @param obj - The object to check
+ * @returns True if the object is a path accessor, false otherwise
+ *
+ * @example
+ * ```typescript
+ * const path = access<User>().profile.theme;
+ * const regularString = "profile.theme";
+ *
+ * console.log(isPathAccessor(path)); // true
+ * console.log(isPathAccessor(regularString)); // false
+ * ```
+ */
+declare const isPathAccessor: (obj: any) => obj is PathAccessor<any>;
+
+/**
+ * Debounce a function: delays invoking `fn` until after `wait` ms have elapsed
+ * since the last time the debounced function was called.
+ * @param fn - The function to debounce
+ * @param wait - Milliseconds to wait
+ * @returns Debounced function
+ */
+declare function debounce<F extends (...args: any[]) => any>(fn: F, wait: number): (...args: Parameters<F>) => void;
+
+/**
+ * Throttle a function: ensures that `fn` is called at most once every `wait` ms.
+ * @param fn - The function to throttle
+ * @param wait - Milliseconds to wait
+ * @returns Throttled function
+ */
+declare function throttle<F extends (...args: any[]) => any>(fn: F, wait: number): (...args: Parameters<F>) => void;
+
+/**
+ * Wait for a specified amount of time.
+ * @param ms - Milliseconds to wait
+ * @returns A promise that resolves after the specified time
+ */
+declare function wait(ms: number): Promise<void>;
+declare function createTimeoutPromise<T>(timeoutMs: number, operation: () => Promise<T> | T, timeoutCallback?: (ms: number) => void): Promise<T>;
+declare function waitForWithPolling<T>(check: () => T | null | undefined, timeout: number, interval?: number): Promise<T>;
+declare function waitForRef<T>(ref: {
+    current: T | null;
+}, timeout: number): Promise<T>;
+
+declare const asString: (value: any) => string;
+
+declare const asNumber: (value: any) => number;
+
+declare const asBoolean: (value: any) => boolean;
+
+declare const asArray: (value: any, transformerFn: (value: any) => any) => any[];
+
+declare const asDate: (value: any) => Date;
+
+declare const asInteger: (value: any) => number;
+
+declare const isAfter: (value: Date | undefined, minDate: Date, inclusive?: boolean) => value is Date;
+
+type ValidationMessage = string | number | boolean | null | undefined;
+type ValidationFnResult = true | ValidationMessage;
+type ValidatorPrimitiveFn<T = unknown> = (value: T) => boolean | Promise<boolean>;
+interface SingleValidationResult {
+    message?: ValidationMessage;
+    isValid: boolean;
+}
+type ValidatorFn<T extends unknown[] = unknown[]> = (...args: T) => boolean | string;
+type ValidationStep<T extends unknown[] = unknown[]> = {
+    fn: ValidatorFn<T>;
+    args: T;
+};
+
+declare const isArray: ValidatorPrimitiveFn;
+
+declare const isBefore: (value: Date | undefined, maxDate: Date, inclusive?: boolean) => value is Date;
+
+declare const isBoolean: ValidatorPrimitiveFn;
+
+declare const isDate: ValidatorPrimitiveFn;
+
+declare const isDefined: ValidatorPrimitiveFn;
+
+declare const isEmail: ValidatorPrimitiveFn;
+
+declare const isEmpty: ValidatorPrimitiveFn;
+
+declare const is: (value: any, valueB: any) => boolean;
+
+declare const isGreaterThan: (value: any, minValue: number, includeEqual?: boolean) => boolean;
+
+/**
+ * Checks if a value is a safe number (not NaN and finite).
+ * @param value - The value to check
+ * @returns True if the value is a safe number, false otherwise
+ */
+declare const isSafeNumber: ValidatorPrimitiveFn;
+
+/**
+ * Checks if a value (number or string) is a numeric and a safe number.
+ * @param value - The value to check
+ * @returns True if the value is numeric, false otherwise
+ */
+declare const isSafeNumeric: ValidatorPrimitiveFn;
+
+declare const isObject: ValidatorPrimitiveFn;
+
+declare const isOneOf: (value: any, options: Array<string | number>) => boolean;
+
+declare const isPhoneNumber: ValidatorPrimitiveFn;
+
+declare const isRequired: ValidatorPrimitiveFn;
+
+declare const isSlug: ValidatorPrimitiveFn;
+
+declare const isLessThan: (value: any, maxValue: number, includeEqual?: boolean) => boolean;
+
+declare const isString: ValidatorPrimitiveFn;
+
+declare const isUrl: ValidatorPrimitiveFn;
+
+declare const isUrlPath: ValidatorPrimitiveFn;
+
+interface DateValue {
+    month: number;
+    year: number;
+    date: number;
+    hour: number;
+    minute: number;
+    second: number;
+    millisecond: number;
+}
+declare const getDateValue: (date: Date) => DateValue;
+
+declare const isLongerThan: (value: any, minLength: number, includeEqual?: boolean) => boolean;
+
+declare const isShorterThan: (value: any, maxLength: number, includeEqual?: boolean) => boolean;
+
+declare const hasPattern: (value: any, pattern: RegExp) => boolean;
+
+declare const isInteger: ValidatorPrimitiveFn;
+
+declare const isEqual: (value: any, valueB: any) => boolean;
+
+export { type DateValue, type Dynamic, PATH_ACCESSOR_SYMBOL, type PathAccessor, type SingleValidationResult, type ValidationFnResult, type ValidationMessage, type ValidationStep, type ValidatorFn, type ValidatorPrimitiveFn, _BASE64_CHARS, _HEX_PREFIX, _base64LookupMap, _getBase64LookupMap, access, asArray, asBoolean, asDate, asInteger, asNumber, asString, base64ToBinary, binaryToBase64, binaryToHex, binaryToText, createTimeoutPromise, debounce, ensureKey, equalsJSON, getAllKeysFromPath, getByPath, getDateValue, hasPattern, hexToBinary, is, isAfter, isArray, isBefore, isBoolean, isDate, isDefined, isEmail, isEmpty, isEqual, isGreaterThan, isInteger, isLessThan, isLongerThan, isObject, isOneOf, isPathAccessor, isPhoneNumber, isRequired, isSafeNumber, isSafeNumeric, isShorterThan, isSlug, isString, isUrl, isUrlPath, omit, pick, setByPath, textToBinary, throttle, unique, wait, waitForRef, waitForWithPolling };