utilitify-core 1.0.0

package/dist/transform/index.d.cts

@@ -0,0 +1,271 @@
+/**
+ * Merge options
+ */
+interface MergeOptions {
+    /** How to merge arrays: 'concat', 'replace', or 'union' */
+    arrayMerge?: 'concat' | 'replace' | 'union';
+    /** Clone objects instead of mutating */
+    clone?: boolean;
+}
+/**
+ * Deep merge multiple objects
+ *
+ * @param objects - Objects to merge
+ * @returns Merged object
+ * @since 1.0.0
+ *
+ * @example
+ * ```typescript
+ * deepMerge({ a: 1, b: { c: 2 } }, { b: { d: 3 } });
+ * // { a: 1, b: { c: 2, d: 3 } }
+ * ```
+ */
+declare function deepMerge<T extends object>(...objects: Partial<T>[]): T;
+/**
+ * Deep merge with options
+ *
+ * @param options - Merge options
+ * @param objects - Objects to merge
+ * @returns Merged object
+ * @since 1.0.0
+ */
+declare function deepMergeWith<T extends object>(options: MergeOptions, ...objects: Partial<T>[]): T;
+/**
+ * Deep clone an object
+ *
+ * @param obj - Object to clone
+ * @returns Cloned object
+ * @since 1.0.0
+ */
+declare function cloneDeep<T>(obj: T): T;
+
+/**
+ * Flatten options
+ */
+interface FlattenOptions {
+    /** Delimiter for keys (default: '.') */
+    delimiter?: string;
+    /** Maximum depth to flatten */
+    maxDepth?: number;
+    /** Whether to flatten arrays */
+    flattenArrays?: boolean;
+}
+/**
+ * Flatten a nested object
+ *
+ * @param obj - Object to flatten
+ * @param options - Flatten options
+ * @returns Flattened object
+ *
+ * @example
+ * ```typescript
+ * flattenObject({ a: { b: { c: 1 } }, d: 2 });
+ * // { 'a.b.c': 1, 'd': 2 }
+ * ```
+ */
+declare function flattenObject<T extends object>(obj: T, options?: FlattenOptions): Record<string, unknown>;
+/**
+ * Unflatten a flattened object
+ *
+ * @param obj - Flattened object
+ * @param options - Options
+ * @returns Nested object
+ *
+ * @example
+ * ```typescript
+ * unflattenObject({ 'a.b.c': 1, 'd': 2 });
+ * // { a: { b: { c: 1 } }, d: 2 }
+ * ```
+ */
+declare function unflattenObject<T extends object>(obj: Record<string, unknown>, options?: FlattenOptions): T;
+/**
+ * Get value at path
+ *
+ * @param obj - Object
+ * @param path - Dot-notation path
+ * @param defaultValue - Default value if not found
+ * @returns Value at path
+ */
+declare function get<T = unknown>(obj: Record<string, unknown>, path: string | string[], defaultValue?: T): T | undefined;
+/**
+ * Set value at path
+ *
+ * @param obj - Object
+ * @param path - Dot-notation path
+ * @param value - Value to set
+ * @returns Modified object
+ */
+declare function set<T extends object>(obj: T, path: string | string[], value: unknown): T;
+
+/**
+ * Pick specified keys from object
+ *
+ * @param obj - Source object
+ * @param keys - Keys to pick
+ * @returns New object with only specified keys
+ *
+ * @example
+ * ```typescript
+ * pick({ a: 1, b: 2, c: 3 }, ['a', 'c']);
+ * // { a: 1, c: 3 }
+ * ```
+ */
+declare function pick<T extends object, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;
+/**
+ * Omit specified keys from object
+ *
+ * @param obj - Source object
+ * @param keys - Keys to omit
+ * @returns New object without specified keys
+ *
+ * @example
+ * ```typescript
+ * omit({ a: 1, b: 2, c: 3 }, ['b']);
+ * // { a: 1, c: 3 }
+ * ```
+ */
+declare function omit<T extends object, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
+/**
+ * Pick keys by predicate function
+ *
+ * @param obj - Source object
+ * @param predicate - Function to test each entry
+ * @returns New object with matching entries
+ *
+ * @example
+ * ```typescript
+ * pickBy({ a: 1, b: null, c: 3 }, value => value !== null);
+ * // { a: 1, c: 3 }
+ * ```
+ */
+declare function pickBy<T extends object>(obj: T, predicate: (value: unknown, key: string) => boolean): Partial<T>;
+/**
+ * Omit keys by predicate function
+ *
+ * @param obj - Source object
+ * @param predicate - Function to test each entry
+ * @returns New object without matching entries
+ */
+declare function omitBy<T extends object>(obj: T, predicate: (value: unknown, key: string) => boolean): Partial<T>;
+/**
+ * Remove null and undefined values
+ *
+ * @param obj - Source object
+ * @returns Object without null/undefined values
+ */
+declare function compact<T extends object>(obj: T): Partial<T>;
+/**
+ * Remove falsy values (null, undefined, '', 0, false)
+ *
+ * @param obj - Source object
+ * @returns Object without falsy values
+ */
+declare function compactDeep<T extends object>(obj: T): Partial<T>;
+/**
+ * Map object values
+ *
+ * @param obj - Source object
+ * @param fn - Mapping function
+ * @returns New object with mapped values
+ */
+declare function mapValues<T extends object, R>(obj: T, fn: (value: T[keyof T], key: keyof T) => R): Record<keyof T, R>;
+/**
+ * Map object keys
+ *
+ * @param obj - Source object
+ * @param fn - Mapping function
+ * @returns New object with mapped keys
+ */
+declare function mapKeys<T extends object>(obj: T, fn: (key: string, value: unknown) => string): Record<string, unknown>;
+/**
+ * Invert object (swap keys and values)
+ *
+ * @param obj - Source object
+ * @returns Inverted object
+ */
+declare function invert<T extends Record<string, string | number>>(obj: T): Record<string, string>;
+/**
+ * Get all keys including nested (as paths)
+ *
+ * @param obj - Source object
+ * @param prefix - Key prefix
+ * @returns Array of all paths
+ */
+declare function getAllKeys(obj: Record<string, unknown>, prefix?: string): string[];
+
+/**
+ * Sanitization options
+ */
+interface SanitizeOptions {
+    /** Strip HTML tags */
+    stripHtml?: boolean;
+    /** Escape HTML entities */
+    escapeHtml?: boolean;
+    /** Trim whitespace */
+    trim?: boolean;
+    /** Remove null bytes */
+    removeNullBytes?: boolean;
+    /** Maximum string length */
+    maxLength?: number;
+    /** Allowed HTML tags (if not stripping all) */
+    allowedTags?: string[];
+}
+/**
+ * Sanitize string input
+ *
+ * @param input - String to sanitize
+ * @param options - Sanitization options
+ * @returns Sanitized string
+ * @since 1.0.0
+ */
+declare function sanitizeString(input: string, options?: SanitizeOptions): string;
+/**
+ * Strip HTML tags from string
+ *
+ * @param html - HTML string
+ * @param allowedTags - Tags to keep
+ * @returns Cleaned string
+ * @since 1.0.0
+ */
+declare function stripHtml(html: string, allowedTags?: string[]): string;
+/**
+ * Escape HTML entities
+ *
+ * @param str - String to escape
+ * @returns Escaped string
+ * @since 1.0.0
+ */
+declare function escapeHtml(str: string): string;
+/**
+ * Unescape HTML entities
+ *
+ * @param str - String to unescape
+ * @returns Unescaped string
+ * @since 1.0.0
+ */
+declare function unescapeHtml(str: string): string;
+/**
+ * Sanitize object recursively
+ *
+ * @param obj - Object to sanitize
+ * @param options - Sanitization options
+ * @returns Sanitized object
+ * @since 1.0.0
+ */
+declare function sanitizeObject<T extends object>(obj: T, options?: SanitizeOptions): T;
+/**
+ * Sanitize for URL
+ *
+ * @param str - String to sanitize
+ * @returns URL-safe string
+ */
+declare function sanitizeUrl(str: string): string;
+/**
+ * Remove control characters
+ *
+ * @param str - String to clean
+ * @returns Cleaned string
+ */
+declare function removeControlChars(str: string): string;
+
+export { type FlattenOptions, type MergeOptions, type SanitizeOptions, cloneDeep, compact, compactDeep, deepMerge, deepMergeWith, escapeHtml, flattenObject, get, getAllKeys, invert, mapKeys, mapValues, omit, omitBy, pick, pickBy, removeControlChars, sanitizeObject, sanitizeString, sanitizeUrl, set, stripHtml, unescapeHtml, unflattenObject };

package/dist/transform/index.d.ts

@@ -0,0 +1,271 @@
+/**
+ * Merge options
+ */
+interface MergeOptions {
+    /** How to merge arrays: 'concat', 'replace', or 'union' */
+    arrayMerge?: 'concat' | 'replace' | 'union';
+    /** Clone objects instead of mutating */
+    clone?: boolean;
+}
+/**
+ * Deep merge multiple objects
+ *
+ * @param objects - Objects to merge
+ * @returns Merged object
+ * @since 1.0.0
+ *
+ * @example
+ * ```typescript
+ * deepMerge({ a: 1, b: { c: 2 } }, { b: { d: 3 } });
+ * // { a: 1, b: { c: 2, d: 3 } }
+ * ```
+ */
+declare function deepMerge<T extends object>(...objects: Partial<T>[]): T;
+/**
+ * Deep merge with options
+ *
+ * @param options - Merge options
+ * @param objects - Objects to merge
+ * @returns Merged object
+ * @since 1.0.0
+ */
+declare function deepMergeWith<T extends object>(options: MergeOptions, ...objects: Partial<T>[]): T;
+/**
+ * Deep clone an object
+ *
+ * @param obj - Object to clone
+ * @returns Cloned object
+ * @since 1.0.0
+ */
+declare function cloneDeep<T>(obj: T): T;
+
+/**
+ * Flatten options
+ */
+interface FlattenOptions {
+    /** Delimiter for keys (default: '.') */
+    delimiter?: string;
+    /** Maximum depth to flatten */
+    maxDepth?: number;
+    /** Whether to flatten arrays */
+    flattenArrays?: boolean;
+}
+/**
+ * Flatten a nested object
+ *
+ * @param obj - Object to flatten
+ * @param options - Flatten options
+ * @returns Flattened object
+ *
+ * @example
+ * ```typescript
+ * flattenObject({ a: { b: { c: 1 } }, d: 2 });
+ * // { 'a.b.c': 1, 'd': 2 }
+ * ```
+ */
+declare function flattenObject<T extends object>(obj: T, options?: FlattenOptions): Record<string, unknown>;
+/**
+ * Unflatten a flattened object
+ *
+ * @param obj - Flattened object
+ * @param options - Options
+ * @returns Nested object
+ *
+ * @example
+ * ```typescript
+ * unflattenObject({ 'a.b.c': 1, 'd': 2 });
+ * // { a: { b: { c: 1 } }, d: 2 }
+ * ```
+ */
+declare function unflattenObject<T extends object>(obj: Record<string, unknown>, options?: FlattenOptions): T;
+/**
+ * Get value at path
+ *
+ * @param obj - Object
+ * @param path - Dot-notation path
+ * @param defaultValue - Default value if not found
+ * @returns Value at path
+ */
+declare function get<T = unknown>(obj: Record<string, unknown>, path: string | string[], defaultValue?: T): T | undefined;
+/**
+ * Set value at path
+ *
+ * @param obj - Object
+ * @param path - Dot-notation path
+ * @param value - Value to set
+ * @returns Modified object
+ */
+declare function set<T extends object>(obj: T, path: string | string[], value: unknown): T;
+
+/**
+ * Pick specified keys from object
+ *
+ * @param obj - Source object
+ * @param keys - Keys to pick
+ * @returns New object with only specified keys
+ *
+ * @example
+ * ```typescript
+ * pick({ a: 1, b: 2, c: 3 }, ['a', 'c']);
+ * // { a: 1, c: 3 }
+ * ```
+ */
+declare function pick<T extends object, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;
+/**
+ * Omit specified keys from object
+ *
+ * @param obj - Source object
+ * @param keys - Keys to omit
+ * @returns New object without specified keys
+ *
+ * @example
+ * ```typescript
+ * omit({ a: 1, b: 2, c: 3 }, ['b']);
+ * // { a: 1, c: 3 }
+ * ```
+ */
+declare function omit<T extends object, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
+/**
+ * Pick keys by predicate function
+ *
+ * @param obj - Source object
+ * @param predicate - Function to test each entry
+ * @returns New object with matching entries
+ *
+ * @example
+ * ```typescript
+ * pickBy({ a: 1, b: null, c: 3 }, value => value !== null);
+ * // { a: 1, c: 3 }
+ * ```
+ */
+declare function pickBy<T extends object>(obj: T, predicate: (value: unknown, key: string) => boolean): Partial<T>;
+/**
+ * Omit keys by predicate function
+ *
+ * @param obj - Source object
+ * @param predicate - Function to test each entry
+ * @returns New object without matching entries
+ */
+declare function omitBy<T extends object>(obj: T, predicate: (value: unknown, key: string) => boolean): Partial<T>;
+/**
+ * Remove null and undefined values
+ *
+ * @param obj - Source object
+ * @returns Object without null/undefined values
+ */
+declare function compact<T extends object>(obj: T): Partial<T>;
+/**
+ * Remove falsy values (null, undefined, '', 0, false)
+ *
+ * @param obj - Source object
+ * @returns Object without falsy values
+ */
+declare function compactDeep<T extends object>(obj: T): Partial<T>;
+/**
+ * Map object values
+ *
+ * @param obj - Source object
+ * @param fn - Mapping function
+ * @returns New object with mapped values
+ */
+declare function mapValues<T extends object, R>(obj: T, fn: (value: T[keyof T], key: keyof T) => R): Record<keyof T, R>;
+/**
+ * Map object keys
+ *
+ * @param obj - Source object
+ * @param fn - Mapping function
+ * @returns New object with mapped keys
+ */
+declare function mapKeys<T extends object>(obj: T, fn: (key: string, value: unknown) => string): Record<string, unknown>;
+/**
+ * Invert object (swap keys and values)
+ *
+ * @param obj - Source object
+ * @returns Inverted object
+ */
+declare function invert<T extends Record<string, string | number>>(obj: T): Record<string, string>;
+/**
+ * Get all keys including nested (as paths)
+ *
+ * @param obj - Source object
+ * @param prefix - Key prefix
+ * @returns Array of all paths
+ */
+declare function getAllKeys(obj: Record<string, unknown>, prefix?: string): string[];
+
+/**
+ * Sanitization options
+ */
+interface SanitizeOptions {
+    /** Strip HTML tags */
+    stripHtml?: boolean;
+    /** Escape HTML entities */
+    escapeHtml?: boolean;
+    /** Trim whitespace */
+    trim?: boolean;
+    /** Remove null bytes */
+    removeNullBytes?: boolean;
+    /** Maximum string length */
+    maxLength?: number;
+    /** Allowed HTML tags (if not stripping all) */
+    allowedTags?: string[];
+}
+/**
+ * Sanitize string input
+ *
+ * @param input - String to sanitize
+ * @param options - Sanitization options
+ * @returns Sanitized string
+ * @since 1.0.0
+ */
+declare function sanitizeString(input: string, options?: SanitizeOptions): string;
+/**
+ * Strip HTML tags from string
+ *
+ * @param html - HTML string
+ * @param allowedTags - Tags to keep
+ * @returns Cleaned string
+ * @since 1.0.0
+ */
+declare function stripHtml(html: string, allowedTags?: string[]): string;
+/**
+ * Escape HTML entities
+ *
+ * @param str - String to escape
+ * @returns Escaped string
+ * @since 1.0.0
+ */
+declare function escapeHtml(str: string): string;
+/**
+ * Unescape HTML entities
+ *
+ * @param str - String to unescape
+ * @returns Unescaped string
+ * @since 1.0.0
+ */
+declare function unescapeHtml(str: string): string;
+/**
+ * Sanitize object recursively
+ *
+ * @param obj - Object to sanitize
+ * @param options - Sanitization options
+ * @returns Sanitized object
+ * @since 1.0.0
+ */
+declare function sanitizeObject<T extends object>(obj: T, options?: SanitizeOptions): T;
+/**
+ * Sanitize for URL
+ *
+ * @param str - String to sanitize
+ * @returns URL-safe string
+ */
+declare function sanitizeUrl(str: string): string;
+/**
+ * Remove control characters
+ *
+ * @param str - String to clean
+ * @returns Cleaned string
+ */
+declare function removeControlChars(str: string): string;
+
+export { type FlattenOptions, type MergeOptions, type SanitizeOptions, cloneDeep, compact, compactDeep, deepMerge, deepMergeWith, escapeHtml, flattenObject, get, getAllKeys, invert, mapKeys, mapValues, omit, omitBy, pick, pickBy, removeControlChars, sanitizeObject, sanitizeString, sanitizeUrl, set, stripHtml, unescapeHtml, unflattenObject };

package/dist/transform/index.js

@@ -0,0 +1,4 @@
+export { cloneDeep, compact, compactDeep, deepMerge, deepMergeWith, escapeHtml, flattenObject, get, getAllKeys, invert, mapKeys, mapValues, omit, omitBy, pick, pickBy, removeControlChars, sanitizeObject, sanitizeString, sanitizeUrl, set, stripHtml, unescapeHtml, unflattenObject } from '../chunk-R3IXCJR7.js';
+import '../chunk-4CV4JOE5.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/transform/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}