@turndown/library 0.1.24 → 0.1.29

package/dist/helpers/object/index.d.ts

@@ -1,298 +0,0 @@
-import type { IFilterCondition, ISortCondition } from "../../types/base/paging.types";
-type TRecord = Record<string, unknown>;
-type TSortableValue = string | number | bigint | boolean | Date | null | undefined;
-type TReplaceNulls<TValue> = TValue extends null ? "" : TValue extends (infer TItem)[] ? TReplaceNulls<TItem>[] : TValue extends Date ? TValue : TValue extends object ? {
-    [TKey in keyof TValue]: TReplaceNulls<TValue[TKey]>;
-} : TValue;
-/**
- * Safely parse a JSON string into a typed value.
- *
- * When a fallback value is provided, the function always returns that generic
- * type. Without a fallback value, parse failures return an empty object.
- *
- * @typeParam TParsed - Expected parsed value type.
- * @param {string | null | undefined} jsonString - JSON string to parse.
- * @param {TParsed} [fallbackValue] - Value returned when parsing fails.
- * @returns {TParsed | Record<string, unknown>} Parsed value or fallback.
- * @example
- * parseJSON<{ a: number }>('{"a":1}', { a: 0 }) // => { a: 1 }
- * parseJSON('not json') // => {}
- */
-export declare function parseJSON<TParsed>(jsonString: string | null | undefined, fallbackValue: TParsed): TParsed;
-export declare function parseJSON(jsonString: string | null | undefined): Record<string, unknown>;
-/**
- * Stringify a value to JSON while skipping circular references.
- *
- * Uses an internal cache to omit repeated object references that would
- * normally cause `JSON.stringify` to throw.
- *
- * @param {unknown} value - Value to stringify.
- * @returns {string | undefined} JSON string with circulars omitted.
- * @example
- * const value: Record<string, unknown> = {}; value.self = value;
- * JSONStringify(value) // => "{}"
- */
-export declare const JSONStringify: (value: unknown) => string | undefined;
-/**
- * Deep-remove `undefined` properties while preserving Dates and arrays.
- *
- * Object properties with `undefined` values are removed. Array items are
- * preserved so array indexes do not shift.
- *
- * @typeParam TValue - Input value type.
- * @param {TValue} value - Input value.
- * @returns {TValue} Cleaned clone with `undefined` object properties removed.
- */
-export declare const removeUndefined: <TValue>(value: TValue) => TValue;
-/**
- * Test whether a location object's `pathname` equals a key.
- *
- * @param {{ pathname?: string } | null | undefined} location - Object expected
- * to have a `pathname`.
- * @param {string} key - Path to compare.
- * @returns {boolean}
- * @example
- * validPath({ pathname: "/home" }, "/home") // true
- */
-export declare const validPath: (location: {
-    pathname?: string;
-} | null | undefined, key: string) => boolean;
-/**
- * Return the first element if the input is an array; otherwise return the value itself.
- *
- * @typeParam T - Element type.
- * @param {T | T[]} input - A single value or an array.
- * @returns {T} First element or the input value.
- * @example
- * returnObject([1,2,3]) // 1
- * returnObject(5) // 5
- */
-export declare const returnObject: <T>(input: T | T[]) => T;
-/**
- * Filter out items from `array1` whose `id` appears in `array2`.
- *
- * @typeParam T - Object type with an `id` field.
- * @param {T[]} [array1] - Source array.
- * @param {T[]} [array2] - Items whose `id`s should be excluded.
- * @returns {T[]} Filtered array (or `[]` on invalid input).
- */
-export declare const filterArrayById: <T extends {
-    id: number | string;
-}>(array1?: T[], array2?: T[]) => T[];
-/**
- * Sort an array of objects by a given property (ascending).
- *
- * Mutates the original array (uses `Array.prototype.sort`).
- *
- * @typeParam T - Object type.
- * @typeParam TKey - Sortable property key.
- * @param {T[]} array - Array to sort.
- * @param {TKey} property - Property name to sort by.
- * @returns {T[]} The same array instance, sorted (or empty array if input invalid).
- */
-export declare const sortArrayByProperty: <TKey extends PropertyKey, T extends Record<TKey, TSortableValue>>(array: T[], property: TKey) => T[];
-/**
- * Recursively replace `null` values with empty strings.
- *
- * Works on primitives, arrays, Dates, and plain objects.
- *
- * @typeParam TValue - Input value type.
- * @param {TValue} value - Input value.
- * @returns {TReplaceNulls<TValue>} Value with all `null` replaced by `""`.
- */
-export declare const replaceNulls: <TValue>(value: TValue) => TReplaceNulls<TValue>;
-/**
- * Recursively remove object keys that contain a dot (`.`).
- *
- * @typeParam TValue - Input value type.
- * @param {TValue} value - Input object or array.
- * @returns {TValue} New value with dotted keys removed at all levels.
- */
-export declare const removeFormProperties: <TValue>(value: TValue) => TValue;
-/**
- * Recursively convert string booleans `"true"`/`"false"` to actual booleans.
- *
- * Leaves all other values unchanged.
- *
- * @typeParam TValue - Input value type.
- * @param {TValue} value - Input object or array.
- * @returns {TValue} New value with boolean-like strings converted.
- */
-export declare const convertStringBooleans: <TValue>(value: TValue) => TValue;
-/**
- * Convenience helper to clean form-like data:
- * - Removes `undefined` properties
- * - Converts string booleans to booleans
- * - Removes keys containing a dot (`.`)
- *
- * @typeParam TObject - Form data object type.
- * @param {TObject} objectToClean - Input data.
- * @returns {Partial<TObject>} Cleaned clone.
- */
-export declare const cleanFormData: <TObject extends TRecord>(objectToClean: TObject) => Partial<TObject>;
-/**
- * Return a default pagination object, allowing optional sort and filters.
- *
- * @param {ISortCondition[]} [sort] - Optional sort conditions.
- * @param {IFilterCondition[]} [filters] - Optional filter conditions.
- * @returns {{ page: number; size: number; sort: ISortCondition[]; filters: IFilterCondition[] }}
- * @example
- * resetPagination() // => { page:1, size:25, sort:[], filters:[] }
- */
-export declare const resetPagination: (sort?: ISortCondition[], filters?: IFilterCondition[]) => {
-    page: number;
-    size: number;
-    sort: ISortCondition[];
-    filters: IFilterCondition[];
-};
-/**
- * Format a string of digits into a U.S. phone number.
- *
- * Strips non-numeric characters and formats 10 digits as `(XXX) XXX-XXXX`.
- * Strips a leading US country code when 11 digits are provided.
- * If a value cannot be formatted, returns the original value as a string.
- *
- * @param {string | number} value - Phone number digits (string or number).
- * @returns {string} Formatted phone number, or original input if invalid length.
- * @example
- * formatPhoneNumber("1234567890") // "(123) 456-7890"
- * formatPhoneNumber(9876543210)   // "(987) 654-3210"
- * formatPhoneNumber("555")        // "555"
- */
-export declare const formatPhoneNumber: (value: string | number) => string;
-/**
- * Format a number with thousands separators (commas).
- *
- * @param {number} value - Number to format.
- * @returns {string} String with commas.
- * @example
- * formatNumber(1234567) // "1,234,567"
- */
-export declare const formatNumber: (value: number) => string;
-/**
- * Remove comma separators from a number-like value.
- *
- * @param {number | string} value - Number-like value.
- * @returns {string} Value without comma separators.
- */
-export declare const parseNumber: (value: number | string) => string;
-/**
- * Delete a property from an object if it exists (no-op if it doesn't).
- *
- * @typeParam TObject - Object type.
- * @param {TObject} objectToUpdate - Target object (mutated).
- * @param {keyof TObject | string} propertyName - Property to delete.
- * @returns {void}
- */
-export declare const deletePropertyIfExists: <TObject extends TRecord>(objectToUpdate: TObject, propertyName: keyof TObject | string) => void;
-/**
- * Split an array into chunks of a given size.
- *
- * @typeParam T - Element type.
- * @param {T[]} array - Source array.
- * @param {number} chunkSize - Size of each chunk.
- * @returns {T[][]} Array of chunks (last one may be smaller).
- * @example
- * chunkArray([1,2,3,4,5], 2) // [[1,2],[3,4],[5]]
- */
-export declare const chunkArray: <T>(array: T[], chunkSize: number) => T[][];
-/**
- * Return a shallow clone of `objectToOmitFrom` without the listed properties.
- *
- * @typeParam TObject - Source object type.
- * @typeParam TKey - Keys to omit.
- * @param {TObject} objectToOmitFrom - Source object.
- * @param {readonly TKey[]} propsToOmit - Property names to omit.
- * @returns {Omit<TObject, TKey>} New object without omitted props.
- * @example
- * omitProperties({a:1,b:2}, ["b"]) // { a:1 }
- */
-export declare const omitProperties: <TObject extends TRecord, TKey extends keyof TObject>(objectToOmitFrom: TObject, propsToOmit: readonly TKey[]) => Omit<TObject, TKey>;
-/**
- * Safe `hasOwnProperty` check.
- *
- * @param {unknown} value - Value to test.
- * @param {PropertyKey} key - Property name.
- * @returns {boolean}
- */
-export declare const hasProperty: <TKey extends PropertyKey>(value: unknown, key: TKey) => value is Record<TKey, unknown>;
-/**
- * Safe `hasOwnProperty` alias from the reference utilities.
- *
- * @param {unknown} value - Value to test.
- * @param {PropertyKey} key - Property name.
- * @returns {boolean}
- */
-export declare const hasOwnProp: <TKey extends PropertyKey>(value: unknown, key: TKey) => value is Record<TKey, unknown>;
-/**
- * Determine if an object has at least one own enumerable property.
- *
- * @param {unknown} value - Object to test.
- * @returns {boolean} `true` if there is at least one key.
- */
-export declare const hasProperties: (value: unknown) => boolean;
-/**
- * Get the first own enumerable property value from an object.
- *
- * @typeParam TObject - Source object type.
- * @param {TObject | null | undefined} value - Source object.
- * @returns {TObject[keyof TObject] | null} First value, or null for empty/non-object input.
- */
-export declare const getFirstPropertyValue: <TObject extends TRecord>(value: TObject | null | undefined) => TObject[keyof TObject] | null;
-/**
- * Get a nested value from an object using dot notation.
- *
- * @param {unknown} value - Source object.
- * @param {string} path - Dot-delimited path.
- * @returns {unknown} Nested value, or undefined when the path cannot be resolved.
- * @example
- * getNestedValue({ user: { name: "John" } }, "user.name") // "John"
- */
-export declare const getNestedValue: (value: unknown, path: string) => unknown;
-/**
- * Set a nested value on an object using dot notation.
- *
- * Mutates and returns the provided object. Unsafe path segments are ignored to
- * prevent prototype pollution.
- *
- * @typeParam TObject - Target object type.
- * @param {TObject} objectToUpdate - Target object.
- * @param {string} path - Dot-delimited path.
- * @param {unknown} value - Value to set.
- * @returns {TObject} The mutated target object.
- * @example
- * setNestedValue({}, "user.name", "John") // { user: { name: "John" } }
- */
-export declare const setNestedValue: <TObject extends TRecord>(objectToUpdate: TObject, path: string, value: unknown) => TObject;
-/**
- * Deep clone a value while preserving Dates and circular references.
- *
- * @typeParam TValue - Input value type.
- * @param {TValue} value - Value to clone.
- * @returns {TValue} Deep clone of the input.
- */
-export declare const deepClone: <TValue>(value: TValue) => TValue;
-/**
- * Flatten a nested object into dot notation.
- *
- * Arrays and Dates are treated as leaf values.
- *
- * @param {TRecord} value - Source object.
- * @param {string} [prefix] - Internal prefix for recursion.
- * @returns {TRecord} Flattened object.
- * @example
- * flatten({ user: { name: "John" } }) // { "user.name": "John" }
- */
-export declare const flatten: (value: TRecord, prefix?: string) => TRecord;
-/**
- * Convert a dot-notation object into a nested object.
- *
- * Unsafe path segments are ignored to prevent prototype pollution.
- *
- * @param {TRecord} value - Dot-notation source object.
- * @returns {TRecord} Nested object.
- * @example
- * unflatten({ "user.name": "John" }) // { user: { name: "John" } }
- */
-export declare const unflatten: (value: TRecord) => TRecord;
-export {};