@ts-utilities/core 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,1288 @@
+//#region src/functions/deepmerge.d.ts
+type TAllKeys<T> = T extends any ? keyof T : never;
+type TIndexValue<T, K$1 extends PropertyKey, D = never> = T extends any ? K$1 extends keyof T ? T[K$1] : D : never;
+type TPartialKeys<T, K$1 extends keyof T> = Omit<T, K$1> & Partial<Pick<T, K$1>> extends infer O ? { [P in keyof O]: O[P] } : never;
+type TFunction = (...a: any[]) => any;
+type TPrimitives = string | number | boolean | bigint | symbol | Date | TFunction;
+type DeepMergeOptions = {
+  arrayMerge?: 'replace' | 'concat' | 'merge' | ((target: any[], source: any[]) => any[]);
+  clone?: boolean;
+  customMerge?: (key: string | symbol, targetValue: any, sourceValue: any) => any;
+  functionMerge?: 'replace' | 'compose';
+  maxDepth?: number;
+};
+type TMerged<T> = [T] extends [Array<any>] ? { [K in keyof T]: TMerged<T[K]> } : [T] extends [TPrimitives] ? T : [T] extends [object] ? TPartialKeys<{ [K in TAllKeys<T>]: TMerged<TIndexValue<T, K>> }, never> : T;
+/**
+ * Deeply merges multiple objects, with later sources taking precedence.
+ * Handles nested objects, arrays, and special object types with circular reference detection.
+ *
+ * Features:
+ * - Deep merging of nested objects
+ * - Configurable array merging strategies
+ * - Circular reference detection and handling
+ * - Support for symbols and special objects (Date, RegExp, etc.)
+ * - Type-safe with improved generics
+ * - Optional cloning to avoid mutation
+ * - Custom merge functions for specific keys
+ *
+ * @template T - The target object type
+ * @param target - The target object to merge into
+ * @param sources - Source objects to merge from (can have additional properties)
+ * @param options - Configuration options
+ * @param options.clone - Whether to clone the target (default: true)
+ * @param options.customMerge - Custom merge function for specific keys
+ * @param options.arrayMerge - How to merge arrays: 'replace' (default), 'concat', or 'merge'
+ * @param options.functionMerge - How to merge functions: 'replace' (default) or 'compose'
+ * @param options.maxDepth - Maximum recursion depth (default: 100)
+ * @returns The merged object with proper typing
+ *
+ * @example
+ * // Basic shallow merge
+ * deepmerge({ a: 1 }, { b: 2 }) // { a: 1, b: 2 }
+ *
+ * @example
+ * // Deep merge of nested objects
+ * deepmerge({ user: { name: 'John' } }, { user: { age: 30 } })
+ * // { user: { name: 'John', age: 30 } }
+ *
+ * @example
+ * // Array concatenation
+ * deepmerge({ tags: ['react'] }, { tags: ['typescript'] }, { arrayMerge: 'concat' })
+ * // { tags: ['react', 'typescript'] }
+ *
+ * @example
+ * // Array replacement (default)
+ * deepmerge({ items: [1, 2] }, { items: [3, 4] })
+ * // { items: [3, 4] }
+ *
+ * @example
+ * // Custom array merging
+ * deepmerge(
+ *   { scores: [85, 90] },
+ *   { scores: [95] },
+ *   { arrayMerge: (target, source) => [...target, ...source] }
+ * )
+ * // { scores: [85, 90, 95] }
+ *
+ * @example
+ * // Configuration merging
+ * const defaultConfig = { theme: 'light', features: { darkMode: false } };
+ * const userConfig = { theme: 'dark', features: { darkMode: true, animations: true } };
+ * deepmerge(defaultConfig, userConfig);
+ * // { theme: 'dark', features: { darkMode: true, animations: true } }
+ *
+ * @example
+ * // State updates in reducers
+ * const initialState = { user: { profile: { name: '' } }, settings: {} };
+ * const action = { user: { profile: { name: 'Alice' } }, settings: { theme: 'dark' } };
+ * const newState = deepmerge(initialState, action);
+ *
+ * @example
+ * // Merging API responses
+ * const cachedData = { posts: [{ id: 1, title: 'Old' }] };
+ * const freshData = { posts: [{ id: 1, title: 'Updated', author: 'Bob' }] };
+ * deepmerge(cachedData, freshData);
+ * // { posts: [{ id: 1, title: 'Updated', author: 'Bob' }] }
+ *
+ * @example
+ * // Function composition
+ * const log1 = () => console.log('first');
+ * const log2 = () => console.log('second');
+ * const composed = deepmerge(log1, log2, { functionMerge: 'compose' });
+ * composed(); // logs 'first' then 'second'
+ */
+declare function deepmerge<T extends Record<string, any>, S$1 extends Record<string, any>[]>(target: T, ...sources: S$1): TMerged<T | S$1[number]>;
+declare function deepmerge<T extends Record<string, any>, S$1 extends Record<string, any>[]>(target: T, sources: S$1, options?: DeepMergeOptions): TMerged<T | S$1[number]>;
+//#endregion
+//#region src/functions/hydrate.d.ts
+type Hydrate<T> = T extends null ? undefined : T extends (infer U)[] ? Hydrate<U>[] : T extends object ? { [K in keyof T]: Hydrate<T[K]> } : T;
+/**
+ * Converts all `null` values to `undefined` in the data structure recursively.
+ *
+ * @param data - Any input data (object, array, primitive)
+ * @returns Same type as input, but with all nulls replaced by undefined
+ *
+ * @example
+ * ```ts
+ * // Basic object hydration
+ * hydrate({ name: null, age: 25 }) // { name: undefined, age: 25 }
+ *
+ * // Nested object hydration
+ * hydrate({
+ *   user: { email: null, profile: { avatar: null } },
+ *   settings: { theme: 'dark' }
+ * })
+ * // { user: { email: undefined, profile: { avatar: undefined } }, settings: { theme: 'dark' } }
+ *
+ * // Array hydration
+ * hydrate([null, 'hello', null, 42]) // [undefined, 'hello', undefined, 42]
+ *
+ * // Mixed data structures
+ * hydrate({
+ *   posts: [null, { title: 'Hello', content: null }],
+ *   metadata: { published: null, tags: ['react', null] }
+ * })
+ * ```
+ *
+ * @example
+ * ```ts
+ * // API response normalization
+ * const apiResponse = await fetch('/api/user');
+ * const rawData = await apiResponse.json(); // May contain null values
+ * const normalizedData = hydrate(rawData); // Convert nulls to undefined
+ *
+ * // Database result processing
+ * const dbResult = query('SELECT * FROM users'); // Some fields may be NULL
+ * const cleanData = hydrate(dbResult); // Normalize for consistent handling
+ *
+ * // Form data sanitization
+ * const formData = getFormValues(); // May have null values from empty fields
+ * const sanitizedData = hydrate(formData); // Prepare for validation/state
+ * ```
+ */
+declare function hydrate<T>(data: T): Hydrate<T>;
+//#endregion
+//#region src/functions/object.d.ts
+/**
+ * Type representing a path split into segments
+ * @template S - The original path string type
+ */
+type SplitPath<S$1 extends string> = S$1 extends `${infer First}.${infer Rest}` ? [First, ...SplitPath<Rest>] : [S$1];
+/**
+ * Recursive type to resolve nested object types based on path
+ * @template T - Current object type
+ * @template K - Array of path segments
+ */
+type GetValue<T, K$1 extends Array<string | number>> = K$1 extends [infer First, ...infer Rest] ? First extends keyof T ? GetValue<T[First], Rest extends Array<string | number> ? Rest : []> : First extends `${number}` ? T extends any[] ? GetValue<T[number], Rest extends Array<string | number> ? Rest : []> : undefined : undefined : T;
+/**
+ * Get a nested value from an object using array path segments
+ * @template T - Object type
+ * @template K - Path segments array type
+ * @template D - Default value type
+ * @param obj - Source object
+ * @param path - Array of path segments
+ * @param defaultValue - Fallback value if path not found
+ * @returns Value at path or default value
+ *
+ * @example
+ * getObjectValue({a: [{b: 1}]}, ['a', 0, 'b']) // 1
+ */
+declare function getObjectValue<T, K$1 extends Array<string | number>, D>(obj: T, path: K$1, defaultValue: D): Exclude<GetValue<T, K$1>, undefined> | D;
+/**
+ * Get a nested value from an object using array path segments
+ * @template T - Object type
+ * @template K - Path segments array type
+ * @param obj - Source object
+ * @param path - Array of path segments
+ * @returns Value at path or undefined
+ *
+ * @example
+ * getObjectValue({a: [{b: 1}]}, ['a', 0, 'b']) // 1
+ */
+declare function getObjectValue<T, K$1 extends Array<string | number>>(obj: T, path: K$1): GetValue<T, K$1> | undefined;
+/**
+ * Get a nested value from an object using dot notation path
+ * @template T - Object type
+ * @template S - Path string literal type
+ * @template D - Default value type
+ * @param obj - Source object
+ * @param path - Dot-separated path string
+ * @param defaultValue - Fallback value if path not found
+ * @returns Value at path or default value
+ *
+ * @example
+ * getObjectValue({a: [{b: 1}]}, 'a.0.b', 2) // 1
+ */
+declare function getObjectValue<T, S$1 extends string, D>(obj: T, path: S$1, defaultValue: D): Exclude<GetValue<T, SplitPath<S$1>>, undefined> | D;
+/**
+ * Get a nested value from an object using dot notation path
+ * @template T - Object type
+ * @template S - Path string literal type
+ * @param obj - Source object
+ * @param path - Dot-separated path string
+ * @returns Value at path or undefined
+ *
+ * @example
+ * getObjectValue({a: [{b: 1}]}, 'a.0.b') // 1
+ */
+declare function getObjectValue<T, S$1 extends string>(obj: T, path: S$1): GetValue<T, SplitPath<S$1>> | undefined;
+/**
+ * Extend an object or function with additional properties while
+ * preserving the original type information.
+ *
+ * Works with both plain objects and callable functions since
+ * functions in JavaScript are objects too. Also handles nullable types.
+ *
+ * @template T The base object or function type (can be null/undefined)
+ * @template P The additional properties type
+ *
+ * @param base - The object or function to extend (can be null/undefined)
+ * @param props - An object containing properties to attach
+ *
+ * @returns The same object/function, augmented with the given properties, or the original value if null/undefined
+ *
+ * @example
+ * ```ts
+ * // Extend a plain object
+ * const config = extendProps({ apiUrl: '/api' }, { timeout: 5000 });
+ * // config has both apiUrl and timeout properties
+ *
+ * // Extend a function with metadata
+ * const fetchData = (url: string) => fetch(url).then(r => r.json());
+ * const enhancedFetch = extendProps(fetchData, {
+ *   description: 'Data fetching utility',
+ *   version: '1.0'
+ * });
+ * // enhancedFetch is callable and has description/version properties
+ *
+ * // Create plugin system
+ * const basePlugin = { name: 'base', enabled: true };
+ * const authPlugin = extendProps(basePlugin, {
+ *   authenticate: (token: string) => validateToken(token)
+ * });
+ *
+ * // Build configuration objects
+ * const defaultSettings = { theme: 'light', lang: 'en' };
+ * const userSettings = extendProps(defaultSettings, {
+ *   theme: 'dark',
+ *   notifications: true
+ * });
+ *
+ * // Handle nullable types (e.g., Supabase Session | null)
+ * const session: Session | null = getSession();
+ * const extendedSession = extendProps(session, { customProp: 'value' });
+ * // extendedSession is (Session & { customProp: string }) | null
+ * ```
+ */
+declare function extendProps<T, P$1 extends object>(base: T, props: P$1): T extends null | undefined ? T : T & P$1;
+//#endregion
+//#region src/functions/poll.d.ts
+/**
+ * Repeatedly polls an async `cond` function UNTIL it returns a TRUTHY value,
+ * or until the operation times out or is aborted.
+ *
+ * Designed for waiting on async jobs, external state, or delayed availability.
+ *
+ * @template T The type of the successful result.
+ *
+ * @param cond
+ * A function returning a Promise that resolves to:
+ *   - a truthy value `T` → stop polling and return it
+ *   - falsy/null/undefined → continue polling
+ *
+ * @param options
+ * Configuration options:
+ * - `interval` (number) — Time between polls in ms (default: 5000 ms)
+ * - `timeout` (number) — Max total duration before failing (default: 5 min)
+ * - `jitter` (boolean) — Add small random offset (±10%) to intervals to avoid sync bursts (default: true)
+ * - `signal` (AbortSignal) — Optional abort signal to cancel polling
+ *
+ * @returns
+ * Resolves with the truthy value `T` when successful.
+ * Throws `AbortError` if aborted
+ *
+ * @example
+ * ```ts
+ * // Poll for job completion
+ * const job = await poll(async () => {
+ *   const status = await getJobStatus();
+ *   return status === 'done' ? status : null;
+ * }, { interval: 3000, timeout: 60000 });
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Wait for API endpoint to be ready
+ * const apiReady = await poll(async () => {
+ *   try {
+ *     await fetch('/api/health');
+ *     return true;
+ *   } catch {
+ *     return null;
+ *   }
+ * }, { interval: 1000, timeout: 30000 });
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Poll with abort signal for cancellation
+ * const controller = new AbortController();
+ * setTimeout(() => controller.abort(), 10000); // Cancel after 10s
+ *
+ * try {
+ *   const result = await poll(
+ *     () => checkExternalService(),
+ *     { interval: 2000, signal: controller.signal }
+ *   );
+ * } catch (err) {
+ *   if (err.name === 'AbortError') {
+ *     console.log('Polling was cancelled');
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Poll for user action completion
+ * const userConfirmed = await poll(async () => {
+ *   const confirmations = await getPendingConfirmations();
+ *   return confirmations.length > 0 ? confirmations[0] : null;
+ * }, { interval: 5000, timeout: 300000 }); // 5 min timeout
+ * ```
+ */
+declare function poll<T>(cond: () => Promise<T | null | false | undefined>, {
+  interval,
+  timeout,
+  jitter,
+  signal
+}?: Partial<{
+  interval: number;
+  timeout: number;
+  signal: AbortSignal;
+  jitter: boolean;
+}>): Promise<T>;
+//#endregion
+//#region src/functions/schedule.d.ts
+/**
+ * A task function that can be synchronous or asynchronous.
+ */
+type Task = () => Promise<void> | void;
+/**
+ * Options for configuring the schedule function.
+ */
+interface ScheduleOpts {
+  /** Number of retry attempts on failure. Defaults to 0. */
+  retry?: number;
+  /** Delay in milliseconds between retries. Defaults to 0. */
+  delay?: number;
+  /** Maximum time in milliseconds to wait for the task to complete. */
+  timeout?: number;
+}
+/**
+ * Runs a function asynchronously in the background without blocking the main thread.
+ *
+ * Executes the task immediately using setTimeout, with optional retry logic on failure.
+ * Useful for non-critical operations like analytics, logging, or background processing.
+ * Logs execution time and retry attempts to the console.
+ *
+ * @param task - The function to execute asynchronously
+ * @param options - Configuration options for retries and timing
+ *
+ * @example
+ * ```ts
+ * // Simple background task
+ * schedule(() => {
+ *   console.log('Background work done');
+ * });
+ *
+ * // Task with retry on failure
+ * schedule(
+ *   () => sendAnalytics(),
+ *   { retry: 3, delay: 1000 }
+ * );
+ * ```
+ */
+declare function schedule(task: Task, options?: ScheduleOpts): void;
+//#endregion
+//#region src/functions/shield.d.ts
+/**
+ * A helper to run sync or async operations safely without try/catch.
+ *
+ * Returns a tuple `[error, data]`:
+ * - `error`: the thrown error (if any), otherwise `null`
+ * - `data`: the resolved value (if successful), otherwise `null`
+ *
+ * @example
+ * ```ts
+ * // Synchronous error handling
+ * const [err, value] = shield(() => {
+ *   if (Math.random() > 0.5) throw new Error('Random failure');
+ *   return 'success';
+ * });
+ * if (err) {
+ *   console.error('Operation failed:', err);
+ * } else {
+ *   console.log('Result:', value);
+ * }
+ *
+ * // Asynchronous error handling
+ * const [asyncErr, result] = await shield(async () => {
+ *   const response = await fetch('/api/data');
+ *   if (!response.ok) throw new Error('API error');
+ *   return response.json();
+ * });
+ * if (asyncErr) {
+ *   console.error('API call failed:', asyncErr);
+ * } else {
+ *   processData(result);
+ * }
+ *
+ * // API calls with fallbacks
+ * const [fetchErr, data] = await shield(fetchUserData(userId));
+ * const userData = fetchErr ? getCachedUserData(userId) : data;
+ *
+ * // File operations
+ * const [fileErr, content] = shield(() => readFileSync('config.json'));
+ * if (fileErr) {
+ *   console.warn('Could not read config, using defaults');
+ *   return defaultConfig;
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // In async functions
+ * async function safeApiCall() {
+ *   const [err, result] = await shield(callExternalAPI());
+ *   if (err) {
+ *     await logError(err);
+ *     return null;
+ *   }
+ *   return result;
+ * }
+ *
+ * // In event handlers
+ * function handleSubmit(formData) {
+ *   const [validationErr, validatedData] = shield(() => validateForm(formData));
+ *   if (validationErr) {
+ *     showValidationError(validationErr);
+ *     return;
+ *   }
+ *   submitData(validatedData);
+ * }
+ * ```
+ */
+declare function shield<T, E = Error>(operation: Promise<T>): Promise<[E | null, T | null]>;
+declare function shield<T, E = Error>(operation: () => T): [E | null, T | null];
+//#endregion
+//#region src/functions/utils-core.d.ts
+/**
+ * Converts various case styles (camelCase, PascalCase, kebab-case, snake_case) into readable normal case.
+ *
+ * Transforms technical naming conventions into human-readable titles by:
+ * - Adding spaces between words
+ * - Capitalizing the first letter of each word
+ * - Handling common separators (-, _, camelCase boundaries)
+ *
+ * @param inputString - The string to convert (supports camelCase, PascalCase, kebab-case, snake_case).
+ * @returns The converted string in normal case (title case).
+ *
+ * @example
+ * ```ts
+ * convertToNormalCase('camelCase') // 'Camel Case'
+ * convertToNormalCase('kebab-case') // 'Kebab Case'
+ * convertToNormalCase('snake_case') // 'Snake Case'
+ * convertToNormalCase('PascalCase') // 'Pascal Case'
+ * ```
+ */
+declare function convertToNormalCase(inputString: string): string;
+/**
+ * Converts a string to a URL-friendly slug by trimming, converting to lowercase,
+ * replacing diacritics, removing invalid characters, and replacing spaces with hyphens.
+ * @param {string} [str] - The input string to convert.
+ * @returns {string} The generated slug.
+ * @example
+ * convertToSlug("Hello World!"); // "hello-world"
+ * convertToSlug("Déjà Vu"); // "deja-vu"
+ */
+declare const convertToSlug: (str: string) => string;
+/**
+ * Pauses execution for the specified time.
+ *
+ * `signal` allows cancelling the sleep via AbortSignal.
+ *
+ * @param time - Time in milliseconds to sleep (default is 1000ms)
+ * @param signal - Optional AbortSignal to cancel the sleep early
+ * @returns - A Promise that resolves after the specified time or when aborted
+ */
+declare const sleep: (time?: number, signal?: AbortSignal) => Promise<void>;
+type DebouncedFunction<F$1 extends (...args: any[]) => any> = {
+  (...args: Parameters<F$1>): ReturnType<F$1> | undefined;
+  readonly isPending: boolean;
+};
+/**
+ * Creates a debounced function that delays invoking the provided function until
+ * after the specified `wait` time has elapsed since the last invocation.
+ *
+ * If the `immediate` option is set to `true`, the function will be invoked immediately
+ * on the leading edge of the wait interval. Subsequent calls during the wait interval
+ * will reset the timer but not invoke the function until the interval elapses again.
+ *
+ * The returned function includes the `isPending` property to check if the debounce
+ * timer is currently active.
+ *
+ * @typeParam F - The type of the function to debounce.
+ *
+ * @param function_ - The function to debounce.
+ * @param wait - The number of milliseconds to delay (default is 100ms).
+ * @param options - An optional object with the following properties:
+ *   - `immediate` (boolean): If `true`, invokes the function on the leading edge
+ *     of the wait interval instead of the trailing edge.
+ *
+ * @returns A debounced version of the provided function, enhanced with the `isPending` property.
+ *
+ * @throws {TypeError} If the first parameter is not a function.
+ * @throws {RangeError} If the `wait` parameter is negative.
+ *
+ * @example
+ * ```ts
+ * // Basic debouncing
+ * const log = debounce((message: string) => console.log(message), 200);
+ * log('Hello'); // Logs "Hello" after 200ms if no other call is made.
+ * console.log(log.isPending); // true if the timer is active.
+ *
+ * // Immediate execution
+ * const save = debounce(() => saveToServer(), 500, { immediate: true });
+ * save(); // Executes immediately, then waits 500ms for subsequent calls
+ *
+ * // Check pending state
+ * const debouncedSearch = debounce(searchAPI, 300);
+ * debouncedSearch('query');
+ * if (debouncedSearch.isPending) {
+ *   showLoadingIndicator();
+ * }
+ * ```
+ */
+declare function debounce<F$1 extends (...args: any[]) => any>(function_: F$1, wait?: number, options?: {
+  immediate: boolean;
+}): DebouncedFunction<F$1>;
+type ThrottledFunction<F$1 extends (...args: any[]) => any> = {
+  (...args: Parameters<F$1>): ReturnType<F$1> | undefined;
+  readonly isPending: boolean;
+};
+/**
+ * Creates a throttled function that invokes the provided function at most once
+ * every `wait` milliseconds.
+ *
+ * If the `leading` option is set to `true`, the function will be invoked immediately
+ * on the leading edge of the throttle interval. If the `trailing` option is set to `true`,
+ * the function will also be invoked at the end of the throttle interval if additional
+ * calls were made during the interval.
+ *
+ * The returned function includes the `isPending` property to check if the throttle
+ * timer is currently active.
+ *
+ * @typeParam F - The type of the function to throttle.
+ *
+ * @param function_ - The function to throttle.
+ * @param wait - The number of milliseconds to wait between invocations (default is 100ms).
+ * @param options - An optional object with the following properties:
+ *   - `leading` (boolean): If `true`, invokes the function on the leading edge of the interval.
+ *   - `trailing` (boolean): If `true`, invokes the function on the trailing edge of the interval.
+ *
+ * @returns A throttled version of the provided function, enhanced with the `isPending` property.
+ *
+ * @throws {TypeError} If the first parameter is not a function.
+ * @throws {RangeError} If the `wait` parameter is negative.
+ *
+ * @example
+ * ```ts
+ * // Basic throttling (leading edge by default)
+ * const log = throttle((message: string) => console.log(message), 200);
+ * log('Hello'); // Logs "Hello" immediately
+ * log('World'); // Ignored for 200ms
+ * console.log(log.isPending); // true if within throttle window
+ *
+ * // Trailing edge only
+ * const trailingLog = throttle(() => console.log('trailing'), 200, {
+ *   leading: false,
+ *   trailing: true
+ * });
+ * trailingLog(); // No immediate execution
+ * // After 200ms: logs "trailing"
+ *
+ * // Both edges
+ * const bothLog = throttle(() => console.log('both'), 200, {
+ *   leading: true,
+ *   trailing: true
+ * });
+ * bothLog(); // Immediate execution
+ * // After 200ms: executes again if called during window
+ * ```
+ */
+declare function throttle<F$1 extends (...args: any[]) => any>(function_: F$1, wait?: number, options?: {
+  leading?: boolean;
+  trailing?: boolean;
+}): ThrottledFunction<F$1>;
+/**
+ * Formats a string by replacing each '%s' placeholder with the corresponding argument.
+ *
+ * Mimics the basic behavior of C's printf for %s substitution. Supports both
+ * variadic arguments and array-based argument passing. Extra placeholders
+ * are left as-is, missing arguments result in empty strings.
+ *
+ * @param format - The format string containing '%s' placeholders.
+ * @param args - The values to substitute, either as separate arguments or a single array.
+ * @returns The formatted string with placeholders replaced by arguments.
+ *
+ * @example
+ * ```ts
+ * // Basic usage with separate arguments
+ * printf("%s love %s", "I", "Bangladesh") // "I love Bangladesh"
+ *
+ * // Using array of arguments
+ * printf("%s love %s", ["I", "Bangladesh"]) // "I love Bangladesh"
+ *
+ * // Extra placeholders remain unchanged
+ * printf("%s %s %s", "Hello", "World") // "Hello World %s"
+ *
+ * // Missing arguments become empty strings
+ * printf("%s and %s", "this") // "this and "
+ *
+ * // Multiple occurrences
+ * printf("%s %s %s", "repeat", "repeat", "repeat") // "repeat repeat repeat"
+ * ```
+ */
+declare function printf(format: string, ...args: unknown[]): string;
+/**
+ * Escapes a string for use in a regular expression.
+ *
+ * @param str - The string to escape
+ * @returns - The escaped string safe for use in RegExp constructor
+ *
+ * @example
+ * ```ts
+ * const escapedString = escapeRegExp('Hello, world!');
+ * // escapedString === 'Hello\\, world!'
+ *
+ * const regex = new RegExp(escapeRegExp(userInput));
+ * ```
+ */
+declare function escapeRegExp(str: string): string;
+/**
+ * Normalizes a string by:
+ * - Applying Unicode normalization (NFC)
+ * - Optionally removing diacritic marks (accents)
+ * - Optionally trimming leading/trailing non-alphanumeric characters
+ * - Optionally converting to lowercase
+ *
+ * @param str - The string to normalize
+ * @param options - Normalization options
+ * @param options.lowercase - Whether to convert the result to lowercase (default: true)
+ * @param options.removeAccents - Whether to remove diacritic marks like accents (default: true)
+ * @param options.removeNonAlphanumeric - Whether to trim non-alphanumeric characters from the edges (default: true)
+ * @returns The normalized string
+ *
+ * @example
+ * ```ts
+ * normalizeText('Café') // 'cafe'
+ * normalizeText('  Hello!  ') // 'hello'
+ * normalizeText('José', { removeAccents: false }) // 'josé'
+ * ```
+ */
+declare function normalizeText(str?: string | null, options?: {
+  lowercase?: boolean;
+  removeAccents?: boolean;
+  removeNonAlphanumeric?: boolean;
+}): string;
+//#endregion
+//#region src/types/utilities.d.ts
+/**
+ * Extracts the keys of an object type as a union type.
+ *
+ * @template T - The object type to extract keys from
+ * @returns A union of all keys in the object type
+ *
+ * @example
+ * ```ts
+ * type User = { name: string; age: number };
+ * type UserKeys = Keys<User>; // 'name' | 'age'
+ * ```
+ */
+type Keys<T extends object> = keyof T;
+/**
+ * Extracts the values of an object type as a union type.
+ *
+ * @template T - The object type to extract values from
+ * @returns A union of all values in the object type
+ *
+ * @example
+ * ```ts
+ * type User = { name: string; age: number };
+ * type UserValues = Values<User>; // string | number
+ * ```
+ */
+type Values<T extends object> = T[keyof T];
+/**
+ * Makes all properties of an object type optional recursively.
+ *
+ * This type traverses through nested objects and arrays, making all properties optional.
+ * Functions and primitives are left unchanged.
+ *
+ * @template T - The type to make deeply partial
+ * @returns A type with all properties optional recursively
+ *
+ * @example
+ * ```ts
+ * type Config = {
+ *   server: { host: string; port: number };
+ *   features: string[];
+ * };
+ *
+ * type PartialConfig = DeepPartial<Config>;
+ * // {
+ * //   server?: { host?: string; port?: number };
+ * //   features?: string[];
+ * // }
+ * ```
+ */
+type DeepPartial<T> = T extends Function ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends object ? { [K in keyof T]?: DeepPartial<T[K]> } : T;
+/**
+ * Makes only specified properties of an object type optional.
+ *
+ * @template T - The base object type
+ * @template K - The keys to make optional
+ * @returns An object type with specified properties optional
+ *
+ * @example
+ * ```ts
+ * type User = { name: string; age: number; email: string };
+ * type PartialUser = SelectivePartial<User, 'age' | 'email'>;
+ * // { name: string; age?: number; email?: string }
+ * ```
+ */
+type SelectivePartial<T, K$1 extends keyof T> = Omit<T, K$1> & Partial<Pick<T, K$1>>;
+/**
+ * Makes all properties of an object type required recursively.
+ *
+ * This type traverses through nested objects and arrays, making all properties required.
+ * Functions and primitives are left unchanged.
+ *
+ * @template T - The type to make deeply required
+ * @returns A type with all properties required recursively
+ *
+ * @example
+ * ```ts
+ * type PartialConfig = {
+ *   server?: { host?: string; port?: number };
+ * };
+ *
+ * type RequiredConfig = DeepRequired<PartialConfig>;
+ * // {
+ * //   server: { host: string; port: number };
+ * // }
+ * ```
+ */
+type DeepRequired<T> = T extends Function ? T : T extends Array<infer U> ? Array<DeepRequired<U>> : T extends object ? { [K in keyof T]-?: DeepRequired<T[K]> } : T;
+/**
+ * Makes only specified properties of an object type required.
+ *
+ * @template T - The base object type
+ * @template K - The keys to make required
+ * @returns An object type with specified properties required
+ *
+ * @example
+ * ```ts
+ * type PartialUser = { name?: string; age?: number; email?: string };
+ * type RequiredUser = SelectiveRequired<PartialUser, 'name'>;
+ * // { name: string; age?: number; email?: string }
+ * ```
+ */
+type SelectiveRequired<T, K$1 extends keyof T> = Omit<T, K$1> & Required<Pick<T, K$1>>;
+/**
+ * Creates a type where all properties are never (useful for excluding types).
+ *
+ * This can be used to create mutually exclusive types or to exclude certain properties.
+ *
+ * @template T - The object type to transform
+ * @returns An object type with all properties set to never
+ *
+ * @example
+ * ```ts
+ * type User = { name: string; age: number };
+ * type ExcludedUser = Never<User>; // { name: never; age: never }
+ * ```
+ */
+type Never<T> = { [K in keyof T]: never };
+/**
+ * Makes all properties of an object type nullable recursively.
+ *
+ * @template T - The type to make nullable
+ * @returns A type where all properties can be null
+ *
+ * @example
+ * ```ts
+ * type User = { name: string; profile: { age: number } };
+ * type NullableUser = Nullable<User>;
+ * // { name: string | null; profile: { age: number | null } | null }
+ * ```
+ */
+type Nullable<T> = T extends object ? { [P in keyof T]: Nullable<T[P]> } : T | null;
+/**
+ * Makes all properties of an object type optional (undefined) recursively.
+ *
+ * @template T - The type to make optional
+ * @returns A type where all properties can be undefined
+ *
+ * @example
+ * ```ts
+ * type User = { name: string; profile: { age: number } };
+ * type OptionalUser = Optional<User>;
+ * // { name: string | undefined; profile: { age: number | undefined } | undefined }
+ * ```
+ */
+type Optional<T> = T extends object ? { [P in keyof T]: Optional<T[P]> } : T | undefined;
+/**
+ * Makes all properties of an object type nullish (null or undefined) recursively.
+ *
+ * @template T - The type to make nullish
+ * @returns A type where all properties can be null or undefined
+ *
+ * @example
+ * ```ts
+ * type User = { name: string; profile: { age: number } };
+ * type NullishUser = Nullish<User>;
+ * // { name: string | null | undefined; profile: { age: number | null | undefined } | null | undefined }
+ * ```
+ */
+type Nullish<T> = T extends object ? { [P in keyof T]: Nullish<T[P]> } : T | null | undefined;
+/**
+ * Makes all properties of an object type optional and nullish recursively.
+ *
+ * This combines optional properties with nullish values.
+ *
+ * @template T - The type to make maybe
+ * @returns A type where all properties are optional and can be null or undefined
+ *
+ * @example
+ * ```ts
+ * type User = { name: string; profile: { age: number } };
+ * type MaybeUser = Maybe<User>;
+ * // { name?: string | null | undefined; profile?: { age?: number | null | undefined } | null | undefined }
+ * ```
+ */
+type Maybe<T> = T extends object ? { [P in keyof T]?: Nullish<T[P]> } : T | null | undefined;
+/**
+ * Makes all properties of an object type readonly recursively.
+ *
+ * This type traverses through nested objects and arrays, making all properties readonly.
+ * Functions and primitives are left unchanged.
+ *
+ * @template T - The type to make deeply readonly
+ * @returns A type with all properties readonly recursively
+ *
+ * @example
+ * ```ts
+ * type Config = {
+ *   server: { host: string; port: number };
+ *   features: string[];
+ * };
+ *
+ * type ReadonlyConfig = DeepReadonly<Config>;
+ * // {
+ * //   readonly server: { readonly host: string; readonly port: number };
+ * //   readonly features: readonly string[];
+ * // }
+ * ```
+ */
+type DeepReadonly<T> = T extends Function ? T : T extends Array<infer U> ? ReadonlyArray<DeepReadonly<U>> : T extends object ? { readonly [K in keyof T]: DeepReadonly<T[K]> } : T;
+/**
+ * Removes readonly modifier from all properties of an object type recursively.
+ *
+ * @template T - The readonly type to make mutable
+ * @returns A type with all readonly modifiers removed
+ *
+ * @example
+ * ```ts
+ * type ReadonlyUser = { readonly name: string; readonly profile: { readonly age: number } };
+ * type MutableUser = Mutable<ReadonlyUser>;
+ * // { name: string; profile: { age: number } }
+ * ```
+ */
+type Mutable<T> = { -readonly [P in keyof T]: T[P] };
+/**
+ * Extracts keys of an object type that have values of a specific type.
+ *
+ * @template T - The object type to search
+ * @template U - The value type to match
+ * @returns A union of keys whose values match the specified type
+ *
+ * @example
+ * ```ts
+ * type User = { name: string; age: number; active: boolean };
+ * type StringKeys = KeysOfType<User, string>; // 'name'
+ * type NumberKeys = KeysOfType<User, number>; // 'age'
+ * ```
+ */
+type KeysOfType<T, U$1> = { [K in keyof T]: T[K] extends U$1 ? K : never }[keyof T];
+/**
+ * Omits properties from an object type that have values of a specific type.
+ *
+ * @template T - The object type to filter
+ * @template U - The value type to exclude
+ * @returns An object type without properties of the specified value type
+ *
+ * @example
+ * ```ts
+ * type Mixed = { name: string; age: number; active: boolean };
+ * type WithoutStrings = OmitByType<Mixed, string>; // { age: number; active: boolean }
+ * ```
+ */
+type OmitByType<T, U$1> = { [K in keyof T as T[K] extends U$1 ? never : K]: T[K] };
+/**
+ * Makes specified properties required while keeping others as-is.
+ *
+ * @template T - The base object type
+ * @template K - The keys to make required
+ * @returns An object type with specified properties required
+ *
+ * @example
+ * ```ts
+ * type PartialUser = { name?: string; age?: number; email?: string };
+ * type RequiredNameUser = RequiredKeys<PartialUser, 'name'>;
+ * // { name: string; age?: number; email?: string }
+ * ```
+ */
+type RequiredKeys<T, K$1 extends keyof T> = Omit<T, K$1> & Required<Pick<T, K$1>>;
+/**
+ * Computes the symmetric difference between two object types.
+ *
+ * Properties that exist in either T or U but not in both.
+ *
+ * @template T - First object type
+ * @template U - Second object type
+ * @returns Properties unique to T or U
+ *
+ * @example
+ * ```ts
+ * type A = { x: number; y: string };
+ * type B = { y: string; z: boolean };
+ * type DiffAB = Diff<A, B>; // { x: number; z: boolean }
+ * ```
+ */
+type Diff<T, U$1> = Omit<T, keyof U$1> & Omit<U$1, keyof T>;
+/**
+ * Computes the intersection of two object types (properties present in both).
+ *
+ * @template T - First object type
+ * @template U - Second object type
+ * @returns Properties that exist in both T and U
+ *
+ * @example
+ * ```ts
+ * type A = { x: number; y: string };
+ * type B = { y: string; z: boolean };
+ * type IntersectionAB = Intersection<A, B>; // { y: string }
+ * ```
+ */
+type Intersection<T extends object, U$1 extends object> = Pick<T, Extract<keyof T, keyof U$1> & Extract<keyof U$1, keyof T>>;
+/**
+ * Merges two object types, combining their properties.
+ *
+ * @template T - First object type
+ * @template U - Second object type
+ * @returns A merged object type with properties from both
+ *
+ * @example
+ * ```ts
+ * type A = { x: number; y: string };
+ * type B = { y: boolean; z: string };
+ * type Merged = Merge<A, B>; // { x: number; y: boolean; z: string }
+ * ```
+ */
+type Merge<T extends object, U$1 extends object, I = Diff<T, U$1> & Intersection<U$1, T> & Diff<U$1, T>> = Pick<I, keyof I>;
+/**
+ * Subtracts properties of one object type from another.
+ *
+ * @template T - The object type to subtract from
+ * @template U - The object type whose properties to subtract
+ * @returns T without properties that exist in U
+ *
+ * @example
+ * ```ts
+ * type A = { x: number; y: string; z: boolean };
+ * type B = { y: string };
+ * type Subtracted = Substract<A, B>; // { x: number; z: boolean }
+ * ```
+ */
+type Substract<T extends object, U$1 extends object> = Omit<T, keyof U$1>;
+/**
+ * Represents either all properties present or none of them.
+ *
+ * Useful for creating mutually exclusive configurations.
+ *
+ * @template T - The object type
+ * @returns Either the full object or an empty object with optional properties
+ *
+ * @example
+ * ```ts
+ * type Config = { host: string; port: number };
+ * type AllOrNoneConfig = AllOrNone<Config>;
+ * // { host: string; port: number } | {}
+ * ```
+ */
+type AllOrNone<T> = T | { [P in keyof T]?: never };
+/**
+ * Represents exactly one property from an object type being present.
+ *
+ * Useful for creating discriminated unions or mutually exclusive options.
+ *
+ * @template T - The object type
+ * @returns A union where only one property is present at a time
+ *
+ * @example
+ * ```ts
+ * type Action = { type: 'create'; payload: string } | { type: 'update'; id: number };
+ * type OneAction = OneOf<Action>;
+ * // { type: 'create'; payload: string } | { type: 'update'; id: number }
+ * ```
+ */
+type OneOf<T> = { [K in keyof T]: Pick<T, K> }[keyof T];
+/**
+ * Represents exactly two properties from an object type being present.
+ *
+ * @template T - The object type
+ * @returns A union where exactly two properties are present at a time
+ *
+ * @example
+ * ```ts
+ * type Config = { a: number; b: string; c: boolean };
+ * type TwoConfig = TwoOf<Config>;
+ * // { a: number; b: string } | { a: number; c: boolean } | { b: string; c: boolean }
+ * ```
+ */
+type TwoOf<T> = { [K in keyof T]: { [L in Exclude<keyof T, K>]: Pick<T, K | L> }[Exclude<keyof T, K>] }[keyof T];
+/**
+ * Prettifies a complex type by expanding it for better readability in tooltips.
+ *
+ * This type doesn't change the runtime type but helps with IntelliSense display.
+ *
+ * @template T - The type to prettify
+ * @returns The same type but expanded for better readability
+ *
+ * @example
+ * ```ts
+ * type Complex = { a: string } & { b: number };
+ * type PrettyComplex = Prettify<Complex>; // Shows as { a: string; b: number }
+ * ```
+ */
+type Prettify<T> = T extends infer U ? U extends object ? { [K in keyof U]: U[K] } & {} : U : never;
+/**
+ * Extracts all nested keys of an object type as dot-separated strings.
+ *
+ * @template ObjectType - The object type to extract nested keys from
+ * @template IgnoreKeys - Keys to ignore during extraction
+ * @returns A union of dot-separated string paths
+ *
+ * @example
+ * ```ts
+ * type User = {
+ *   name: string;
+ *   profile: { age: number; address: { city: string } };
+ *   tags: string[];
+ * };
+ *
+ * type UserPaths = NestedKeyOf<User>;
+ * // 'name' | 'profile' | 'profile.age' | 'profile.address' | 'profile.address.city' | 'tags'
+ * ```
+ */
+type NestedKeyOf<ObjectType extends object, IgnoreKeys extends string = never> = { [Key in keyof ObjectType & string]: Key extends IgnoreKeys ? never : ObjectType[Key] extends object ? ObjectType[Key] extends Array<any> ? Key : `${Key}` | `${Key}.${NestedKeyOf<ObjectType[Key], IgnoreKeys>}` : `${Key}` }[keyof ObjectType & string];
+/**
+ * Creates a type that excludes properties present in another type.
+ *
+ * This is useful for creating mutually exclusive types.
+ *
+ * @template T - The base type
+ * @template U - The type whose properties to exclude
+ * @returns A type with properties from T that are not in U
+ *
+ * @example
+ * ```ts
+ * type A = { x: number; y: string };
+ * type B = { y: string };
+ * type WithoutB = Without<A, B>; // { x?: never }
+ * ```
+ */
+type Without<T, U$1> = { [P in Exclude<keyof T, keyof U$1>]?: never };
+//#endregion
+//#region src/types/gates.d.ts
+type BUFFER<T> = T;
+type IMPLIES<T, U$1> = T extends U$1 ? true : false;
+type XOR_Binary<T, U$1> = T | U$1 extends object ? (Without<T, U$1> & U$1) | (Without<U$1, T> & T) : T | U$1;
+type XNOR_Binary<T, U$1> = (T & U$1) | (Without<T, U$1> & Without<U$1, T>);
+/**
+ * Computes a type-level AND (all must true) for a tuple of types.
+ *
+ * Truth table for 3 arguments:
+ *
+ * A  B  C  = AND
+ * 1  1  1  = 1
+ * 1  1  0  = 0
+ * 1  0  1  = 0
+ * 1  0  0  = 0
+ * 0  1  1  = 0
+ * 0  1  0  = 0
+ * 0  0  1  = 0
+ * 0  0  0  = 0
+ *
+ * @template T - Tuple of boolean-like types (1/0)
+ */
+type AND<T extends any[]> = T extends [infer F, ...infer R] ? R extends any[] ? F & AND<R> : F : unknown;
+/**
+ * Computes a type-level OR (At least one) for a tuple of types.
+ *
+ * Truth table for 3 arguments:
+ *
+ * A  B  C  = OR
+ * 1  1  1  = 1
+ * 1  1  0  = 1
+ * 1  0  1  = 1
+ * 1  0  0  = 1
+ * 0  1  1  = 1
+ * 0  1  0  = 1
+ * 0  0  1  = 1
+ * 0  0  0  = 0
+ *
+ * @template T - Tuple of boolean-like types (1/0)
+ */
+type OR<T extends any[]> = T extends [infer F, ...infer R] ? R extends any[] ? F | OR<R> : F : never;
+/**
+ * Computes a type-level XOR (only one/odd) for a tuple of types.
+ *
+ * Truth table for 3 arguments:
+ *
+ * A  B  C  = XOR
+ * 1  1  1  = 1
+ * 1  1  0  = 0
+ * 1  0  1  = 0
+ * 1  0  0  = 1
+ * 0  1  1  = 0
+ * 0  1  0  = 1
+ * 0  0  1  = 1
+ * 0  0  0  = 0
+ *
+ * @template T - Tuple of boolean-like types (1/0)
+ */
+type XOR<T extends any[]> = T extends [infer F, ...infer R] ? R extends [infer S, ...infer Rest] ? XOR<[XOR_Binary<F, S>, ...Rest]> : F : never;
+/**
+ * Computes a type-level XNOR (All or None true) for a tuple of types.
+ *
+ * Truth table for 3 arguments:
+ *
+ * A  B  C  = XNOR
+ * 1  1  1  = 0
+ * 1  1  0  = 1
+ * 1  0  1  = 1
+ * 1  0  0  = 0
+ * 0  1  1  = 1
+ * 0  1  0  = 0
+ * 0  0  1  = 0
+ * 0  0  0  = 1
+ *
+ * @template T - Tuple of boolean-like types (1/0)
+ */
+type XNOR<T extends any[]> = T extends [infer F, ...infer R] ? R extends [infer S, ...infer Rest] ? XNOR<[XNOR_Binary<F, S>, ...Rest]> : F : never;
+/**
+ * Computes a type-level NOT for a tuple of types.
+ *
+ * Truth table for 3 arguments:
+ *
+ * A  B  C  = NOT
+ * 1  1  1  = 0
+ * 1  1  0  = 0
+ * 1  0  1  = 0
+ * 1  0  0  = 0
+ * 0  1  1  = 0
+ * 0  1  0  = 0
+ * 0  0  1  = 0
+ * 0  0  0  = 1
+ *
+ * @template T - Tuple of boolean-like types (1/0)
+ */
+type NOT<T> = { [P in keyof T]?: never };
+/**
+ * Computes a type-level NAND for a tuple of types.
+ *
+ * Truth table for 3 arguments:
+ *
+ * A  B  C  = NAND
+ * 1  1  1  = 0
+ * 1  1  0  = 1
+ * 1  0  1  = 1
+ * 1  0  0  = 1
+ * 0  1  1  = 1
+ * 0  1  0  = 1
+ * 0  0  1  = 1
+ * 0  0  0  = 1
+ *
+ * @template T - Tuple of boolean-like types (1/0)
+ */
+type NAND<T extends any[]> = NOT<AND<T>>;
+/**
+ * Computes a type-level NOR for a tuple of types.
+ *
+ * Truth table for 3 arguments:
+ *
+ * A  B  C  = NOR
+ * 1  1  1  = 0
+ * 1  1  0  = 0
+ * 1  0  1  = 0
+ * 1  0  0  = 0
+ * 0  1  1  = 0
+ * 0  1  0  = 0
+ * 0  0  1  = 0
+ * 0  0  0  = 1
+ *
+ * @template T - Tuple of boolean-like types (1/0)
+ */
+type NOR<T extends any[]> = NOT<OR<T>>;
+//#endregion
+//#region src/types/guards.d.ts
+/**
+ * Represents primitive JavaScript types including null and undefined.
+ */
+type Primitive = string | number | bigint | boolean | symbol | null | undefined;
+/**
+ * Represents all falsy values in JavaScript.
+ */
+type Falsy = false | '' | 0 | null | undefined;
+/**
+ * Type guard that checks if a value is falsy.
+ *
+ * @param val - The value to check
+ * @returns True if the value is falsy, false otherwise
+ *
+ * @example
+ * if (isFalsy(value)) {
+ *   console.log('Value is falsy');
+ * }
+ */
+declare const isFalsy: (val: unknown) => val is Falsy;
+/**
+ * Type guard that checks if a value is null or undefined.
+ *
+ * @param val - The value to check
+ * @returns True if the value is null or undefined, false otherwise
+ *
+ * @example
+ * if (isNullish(value)) {
+ *   console.log('Value is null or undefined');
+ * }
+ */
+declare const isNullish: (val: unknown) => val is null | undefined;
+/**
+ * Type guard that checks if a value is a primitive type.
+ *
+ * @param val - The value to check
+ * @returns True if the value is a primitive, false otherwise
+ *
+ * @example
+ * if (isPrimitive(value)) {
+ *   console.log('Value is a primitive type');
+ * }
+ */
+declare const isPrimitive: (val: unknown) => val is Primitive;
+/**
+ * Type guard that checks if a value is a plain object (not an array, function, etc.).
+ *
+ * @param value - The value to check
+ * @returns True if the value is a plain object, false otherwise
+ *
+ * @example
+ * if (isPlainObject(value)) {
+ *   console.log('Value is a plain object');
+ * }
+ */
+declare function isPlainObject(value: unknown): value is Record<string, any>;
+//#endregion
+export { AND, AllOrNone, BUFFER, DeepMergeOptions, DeepPartial, DeepReadonly, DeepRequired, Diff, Falsy, IMPLIES, Intersection, Keys, KeysOfType, Maybe, Merge, Mutable, NAND, NOR, NOT, NestedKeyOf, Never, Nullable, Nullish, OR, OmitByType, OneOf, Optional, Prettify, Primitive, RequiredKeys, ScheduleOpts, SelectivePartial, SelectiveRequired, Substract, Task, TwoOf, Values, Without, XNOR, XNOR_Binary, XOR, XOR_Binary, convertToNormalCase, convertToSlug, debounce, deepmerge, escapeRegExp, extendProps, getObjectValue, hydrate, isFalsy, isNullish, isPlainObject, isPrimitive, normalizeText, poll, printf, schedule, shield, sleep, throttle };