@splendidlabz/utils 1.11.1 → 1.11.3

package/dist/types/lib/objects/index.d.cts

@@ -1,13 +0,0 @@
-export { camelCaseKeys } from './camelcase-keys.cjs';
-export { isEmpty, notEmpty } from './empty.cjs';
-export { isEqual, notEqual } from './equal.cjs';
-export { extendObject } from './extend.cjs';
-export { flattenObject } from './flatten.cjs';
-export { parseJSON } from './json.cjs';
-export { objectForEach, objectMap } from './loop.cjs';
-export { concatMix, createMix, mix } from './mix/mix.cjs';
-export { getNestedProperty, getNestedProperty2, getNestedValue } from './nested-property.cjs';
-export { normalizeObject } from './normalize-object.cjs';
-export { omitEmpty } from './omit-empty.cjs';
-export { sizeOf } from './size.cjs';
-export { splitObject } from './split.cjs';

package/dist/types/lib/objects/json.d.cts

@@ -1,3 +0,0 @@
-declare function parseJSON(value: any, defaultValue?: {}): any;
-
-export { parseJSON };

package/dist/types/lib/objects/loop.d.cts

@@ -1,4 +0,0 @@
-declare function objectForEach(object: any, callback: any): void;
-declare function objectMap(object: any, callback: any): any[];
-
-export { objectForEach, objectMap };

package/dist/types/lib/objects/mix/mix.d.cts

@@ -1,44 +0,0 @@
-/**
- * Creates a customized mix function with specific options for array handling.
- *
- * @param {Object} [userOptions={}] - Configuration options for the mix function.
- * @param {('replace'|'concat')} [userOptions.array='replace'] - How to handle array merging:
- *   - 'replace': Arrays from later sources completely replace arrays from earlier sources
- *   - 'concat': Arrays are concatenated together
- * @return {Function} A mix function configured with the provided options.
- *
- * @example
- * // Create mix function that concatenates arrays
- * const concatMix = createMix({ array: 'concat' })
- * const obj1 = { items: [1, 2] }
- * const obj2 = { items: [3, 4] }
- * const result = concatMix(obj1, obj2)
- * // Returns: { items: [1, 2, 3, 4] }
- *
- * @example
- * // Create mix function that replaces arrays (default behavior)
- * const replaceMix = createMix({ array: 'replace' })
- * const obj1 = { items: [1, 2] }
- * const obj2 = { items: [3, 4] }
- * const result = replaceMix(obj1, obj2)
- * // Returns: { items: [3, 4] }
- */
-declare function createMix(userOptions?: {
-    array?: ("replace" | "concat");
-}): Function;
-/**
- * Deep merges multiple objects into a new object with intelligent handling of arrays and nested objects.
- *
- * @param {...Object} sources - Objects to merge. Null and undefined values are skipped.
- * @return {Object} A new object containing the merged properties from all sources.
- *
- * @example
- * const obj1 = { a: 1, b: { x: 10 } }
- * const obj2 = { b: { y: 20 }, c: 3 }
- * const result = mix(obj1, obj2)
- * // Returns: { a: 1, b: { x: 10, y: 20 }, c: 3 }
- */
-declare const mix: Function;
-declare const concatMix: Function;
-
-export { concatMix, createMix, mix };

package/dist/types/lib/objects/nested-property.d.cts

@@ -1,24 +0,0 @@
-/**
- * Returns the value at the given path in the object.
- * If the path does not exist, it returns undefined.
- *
- * @param {Object} object - The object to get the nested property from.
- * @param {Array} pathArr - The array representing the path to the property.
- * @return {*} The value at the given path in the object or undefined if the path does not exist.
- *
- * @example
- * let object = {
- *   one: {
- *     two: {
- *       three: "value"
- *     }
- *   }
- * };
- * let path = ['one', 'two', 'three'];
- * console.log(getNestedProperty(object, path)); // Outputs: "value"
- */
-declare function getNestedProperty(object: any, pathArr: any[]): any;
-declare function getNestedProperty2(object: any, path: any): any;
-declare function getNestedValue(object: any, path: any): any;
-
-export { getNestedProperty, getNestedProperty2, getNestedValue };

package/dist/types/lib/objects/normalize-object.d.cts

@@ -1,3 +0,0 @@
-declare function normalizeObject(object: any): any;
-
-export { normalizeObject };

package/dist/types/lib/objects/omit-empty.d.cts

@@ -1,3 +0,0 @@
-declare function omitEmpty(obj: any, shallow?: boolean): any;
-
-export { omitEmpty };

package/dist/types/lib/objects/size.d.cts

@@ -1,3 +0,0 @@
-declare function sizeOf(obj: any): string;
-
-export { sizeOf };

package/dist/types/lib/objects/split.d.cts

@@ -1,14 +0,0 @@
-/**
- * Split on object up based on the keys provided.
- * @param {Object} obj
- * @param {Array} keys
- * @returns
- */
-declare function splitObject(obj: any, keys: any[]): {
-    picked: {};
-    omitted: any;
-    p: {};
-    o: any;
-};
-
-export { splitObject };

package/dist/types/lib/promises/index.d.cts

@@ -1 +0,0 @@
-export { reject } from './reject.cjs';

package/dist/types/lib/promises/reject.d.cts

@@ -1,5 +0,0 @@
-declare function reject(props: any, { includeStack }?: {
-    includeStack?: boolean;
-}): Promise<never>;
-
-export { reject };

package/dist/types/lib/sse.d.cts

@@ -1,18 +0,0 @@
-declare function createSSE({ event, data, id, retry }: {
-    event: any;
-    data: any;
-    id: any;
-    retry: any;
-}): string;
-/**
- * Parses a single SSE message into a structured object
- * @param {string} message - The raw SSE message
- * @returns {Object|null} The parsed message or null if invalid
- * @property {string} [event] - The event type if specified
- * @property {string|Object} data - The message data (parsed as JSON if possible)
- * @property {string} [id] - The message ID if specified
- * @property {number} [retry] - The retry interval if specified
- */
-declare function parseSSE(message: string): any | null;
-
-export { createSSE, parseSSE };

package/dist/types/lib/strings/convert-case/convert-case.d.cts

@@ -1,10 +0,0 @@
-declare function toKebab(string: any): any;
-declare function toCamel(string: any): any;
-declare function toPascal(string: any): any;
-declare function toTitle(string: any): any;
-declare function toSlug(string: any): any;
-declare function toSentence(string: any): any;
-declare function toUpper(string: any): any;
-declare function toLower(string: any): any;
-
-export { toCamel, toKebab, toLower, toPascal, toSentence, toSlug, toTitle, toUpper };

package/dist/types/lib/strings/index.d.cts

@@ -1,5 +0,0 @@
-export { toCamel, toKebab, toLower, toPascal, toSentence, toSlug, toTitle, toUpper } from './convert-case/convert-case.cjs';
-export { markdown, treatMarkdownWhitespace } from './markdown.cjs';
-export { parseFullName } from './name.cjs';
-export { pluralize } from './pluralize.cjs';
-export { plural, stripNumbers, toQueryString } from './query-string.cjs';

package/dist/types/lib/strings/markdown.d.cts

@@ -1,25 +0,0 @@
-/**
- * Converts markdown content to HTML with whitespace handling
- * @param {string} content - Markdown content to convert
- * @param {Object} [options={}] - Conversion options
- * @param {boolean} [options.inline=false] - Whether content should be treated as inline markdown
- * @returns {string} Converted HTML string
- */
-declare function markdown(content: string, options?: {
-    inline?: boolean;
-}): string;
-/**
- * Handles whitespace in markdown content to ensure proper rendering
- * @param {string} content - Markdown content to process
- * @param {Object} [options={}] - Processing options
- * @param {boolean} [options.inline=false] - Whether content is inline markdown
- * @returns {{ content: string, inline: boolean }} Processed content and inline status
- */
-declare function treatMarkdownWhitespace(content: string, { inline }?: {
-    inline?: boolean;
-}): {
-    content: string;
-    inline: boolean;
-};
-
-export { markdown, treatMarkdownWhitespace };

package/dist/types/lib/strings/name.d.cts

@@ -1,7 +0,0 @@
-declare function parseFullName(name: any): {
-    firstName: any;
-    middleName: any;
-    lastName: any;
-};
-
-export { parseFullName };

package/dist/types/lib/strings/pluralize.d.cts

@@ -1,3 +0,0 @@
-declare const pluralize: any;
-
-export { pluralize };

package/dist/types/lib/strings/query-string.d.cts

@@ -1,10 +0,0 @@
-/**
- * Converts object into a query string
- * @param {Object} object
- * @returns
- */
-declare function toQueryString(object: any): string;
-declare function plural(count: any, noun: any, suffix?: string): string;
-declare function stripNumbers(string: any): any;
-
-export { plural, stripNumbers, toQueryString };

package/dist/types/lib/style/index.d.cts

@@ -1,3 +0,0 @@
-declare function toStyleString(style: any): string;
-
-export { toStyleString };

package/dist/types/lib/symbols/index.d.cts

@@ -1 +0,0 @@
-export { getSymbol, getSymbolValue } from './symbols.cjs';

package/dist/types/lib/symbols/symbols.d.cts

@@ -1,4 +0,0 @@
-declare function getSymbol(object: any, description: any): symbol;
-declare function getSymbolValue(object: any, description: any): any;
-
-export { getSymbol, getSymbolValue };

package/dist/types/node/dirname.d.cts

@@ -1,9 +0,0 @@
-/**
- * Returns __dirname
- * @param url — import.meta.url
- * @returns
- */
-declare function __dirname$1(url: any): string;
-declare function dirname(url: any): string;
-
-export { __dirname$1 as __dirname, dirname };

package/dist/types/node/file-cache.d.cts

@@ -1,56 +0,0 @@
-/**
- * Creates a file cache instance for managing cached files in a directory
- * @param {string} dir - Absolute or relative path to cache directory
- * @returns {Promise<object>} Cache instance
- * @property {function(string): Promise<number>} cacheAt - Returns the cached file's modified timestamp, or directory's last modified time if no file specified
- * @property {function(string): string} getAbsPath - Returns absolute path for a file in cache
- * @property {function(string): Promise<boolean>} hasFile - Checks if a file exists in cache
- * @property {function(string): Promise<Buffer|undefined>} loadFile - Loads file contents from cache
- * @property {function(string, string|Buffer): Promise<void>} saveFile - Saves data to cache file
- * @property {function(string): Promise<object>} loadJSON - Loads and parses JSON from cache file
- * @property {function(string, object): Promise<void>} saveJSON - Saves object as JSON to cache file
- */
-declare function createCache(dir: string): Promise<object>;
-/**
- * Legacy file cache API for managing a single cached file
- * @param {Object} options
- * @param {string} options.dir - Absolute or relative path to cache directory
- * @param {string} options.file - Filename to cache
- * @returns {Promise<{
- *   modifiedAt: number,
- *   load: () => Promise<Buffer>,
- *   save: (data: string|Buffer) => Promise<void>,
- *   loadJSON: () => Promise<object>,
- *   saveJSON: (data: object) => Promise<void>
- * }>}
- */
-declare function fileCache({ dir, file }: {
-    dir: string;
-    file: string;
-}): Promise<{
-    modifiedAt: number;
-    load: () => Promise<Buffer>;
-    save: (data: string | Buffer) => Promise<void>;
-    loadJSON: () => Promise<object>;
-    saveJSON: (data: object) => Promise<void>;
-}>;
-/**
- * Gets the most recent modification time of files matching the glob pattern
- * @param {string|string[]} globPath - Glob pattern(s) to match files
- * @returns {Promise<number>} Timestamp of most recently modified file, or 0 if no files found
- */
-declare function getLastModifiedTime(globPath: string | string[]): Promise<number>;
-/**
- * @deprecated Use getLastModifiedTime instead
- * @param {string|string[]} globPath - Glob pattern(s) to match files
- * @returns {Promise<number>} Timestamp of most recently modified file, or 0 if no files found
- */
-declare function getLatestModifiedTime(globPath: string | string[]): Promise<number>;
-/**
- * Removes leading slash from a path string
- * @param {string} x - Path string to process
- * @returns {string} Path without leading slash
- */
-declare function removeFirstSlash(x: string): string;
-
-export { createCache, fileCache, getLastModifiedTime, getLatestModifiedTime, removeFirstSlash };

package/dist/types/node/file.d.cts

@@ -1,4 +0,0 @@
-declare function mkdir(path: any): Promise<string>;
-declare function copyFile(from: any, to: any): Promise<void>;
-
-export { copyFile, mkdir };

package/dist/types/node/hash.d.cts

@@ -1,3 +0,0 @@
-declare function sha256Hash(string: any): string;
-
-export { sha256Hash };

package/dist/types/node/index.d.cts

@@ -1,7 +0,0 @@
-export { __dirname, dirname } from './dirname.cjs';
-export { createCache, fileCache, getLastModifiedTime, getLatestModifiedTime, removeFirstSlash } from './file-cache.cjs';
-export { sha256Hash } from './hash.cjs';
-export { PKCE } from './pkce.cjs';
-export { randomString } from './random-string.cjs';
-export { sanitize } from './sanitize.cjs';
-export { uuid } from './uuid.cjs';

package/dist/types/node/pkce.d.cts

@@ -1,8 +0,0 @@
-declare function PKCE(): Promise<{
-    state: string;
-    code_verifier: string;
-    code_challenge: string;
-    code_challenge_method: string;
-}>;
-
-export { PKCE };

package/dist/types/node/random-string.d.cts

@@ -1,3 +0,0 @@
-declare function randomString(length?: number): string;
-
-export { randomString };

package/dist/types/node/sanitize.d.cts

@@ -1,10 +0,0 @@
-/**
- * Sanitizes values using sanitize-html
- * @param {*} value - Value to sanitize (string, array, or object)
- * @param {Object} [options={}] - sanitize-html options
- * @returns {*} Sanitized value
- * @throws {Error} If input is a string but sanitize-html fails
- */
-declare function sanitize(value: any, options?: any): any;
-
-export { sanitize };

package/dist/types/node/uuid.d.cts

@@ -1,3 +0,0 @@
-declare function uuid(): `${string}-${string}-${string}-${string}-${string}`;
-
-export { uuid };