@splendidlabz/utils 1.5.0 → 1.5.1

package/dist/dom/ui/traverse-and-scramble.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Traverses a DOM node and scrambles its text content, excluding specified elements.
+ * Useful for creating placeholder/loading states or privacy features.
+ *
+ * @param {Element|ChildNode} node - The root element or node to start traversal from
+ * @param {Object} [options] - Options for traversal
+ * @param {string[]} [options.excludes=[]] - Array of CSS selectors to exclude from scrambling
+ * @example
+ * // Scramble all text in a container
+ * traverseAndScramble(document.querySelector('.container'))
+ *
+ * // Scramble text but exclude certain elements
+ * traverseAndScramble(document.body, {
+ *   excludes: ['.no-scramble', '[data-no-scramble]']
+ * })
+ */
+export function traverseAndScramble(node: Element | ChildNode, { excludes }?: {
+    excludes?: string[];
+}): void;

package/dist/lib/arrays/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./item-position.js";
+export * from "./join.js";
+export * from "./shuffle.js";
+export * from "./sort.js";
+export * from "./unique.js";

package/dist/lib/arrays/item-position.d.ts

@@ -0,0 +1,14 @@
+export function last(array: any, index: any): boolean;
+/**
+ * Checks if the given index is the last item in the array
+ * @param {Array} array - The array to check
+ * @param {number} index - The index to check
+ * @returns {boolean} True if the index is the last item, false otherwise
+ */
+export function isLastItem(array: any[], index: number): boolean;
+/**
+ * Returns the last item in the array
+ * @param {Array} array - The array to get the last item from
+ * @returns {*} The last item in the array
+ */
+export function lastArrayItem(array: any[]): any;

package/dist/lib/arrays/join.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Joins an array with a conjunction (and/or)
+ * @param {Array<string>} array - Array of strings to join
+ * @param {Object} [options] - Options for joining
+ * @param {string} [options.conjunction='and'] - Conjunction to use ('and' or 'or')
+ * @returns {string} Joined string
+ * @example
+ * joinWithConjunction(['a', 'b', 'c']) // 'a, b, and c'
+ * joinWithConjunction(['a', 'b'], { conjunction: 'or' }) // 'a or b'
+ */
+export function joinWithConjunction(array: Array<string>, { conjunction }?: {
+    conjunction?: string;
+}): string;

package/dist/lib/arrays/shuffle.d.ts

@@ -0,0 +1 @@
+export function shuffle(array: any): any;

package/dist/lib/arrays/sort.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Sorts an array of objects, numbers, or strings without mutating the original array.
+ * Supports nested properties, multiple sort keys, and various data types.
+ *
+ * @template T
+ * @param {T[]} array - Array to sort
+ * @param {Object} [options] - Sort options
+ * @param {string|string[]|null} [options.props=null] - Property or array of properties to sort by. If null, sorts simple arrays
+ * @param {boolean} [options.reverse=false] - Whether to sort in reverse order
+ * @returns {T[]} New sorted array
+ * @example
+ * // Sort simple array
+ * sort([3, 1, 2]) // [1, 2, 3]
+ *
+ * // Sort objects by single property
+ * sort(users, { props: 'name' })
+ *
+ * // Sort objects by multiple properties
+ * sort(users, { props: ['age', 'name'] })
+ *
+ * // Sort in reverse order
+ * sort(users, { props: 'age', reverse: true })
+ *
+ * // Sort by nested property
+ * sort(users, { props: 'address.city' })
+ */
+export function sort<T>(array: T[], { props, reverse }?: {
+    props?: string | string[] | null;
+    reverse?: boolean;
+}): T[];

package/dist/lib/arrays/unique.d.ts

@@ -0,0 +1 @@
+export function uniqueArray(array: any): any[];

package/dist/lib/auth/index.d.ts

@@ -0,0 +1 @@
+export * from "./route-manager.js";

package/dist/lib/auth/route-manager.d.ts

@@ -0,0 +1,25 @@
+/**
+  // Usage ... Probably should use either protected or bypass, not both.
+  @example
+  const config = {
+    routeConfig: {
+      startsWith: ['/dashboard']
+    }
+    bypassRoutes: {
+      is: ['/'],
+      startsWith: ['/fonts', '/auth', '/favicon', '/images'],
+      includes: ['/meh'],
+    }
+  }
+  const {isProtectedRoute, isBypassRoute} = AuthManager(config)
+  if (!isProtectedRoute(context.url.pathname)) return next() // Handle only protected routes
+  if (isBypassRoute(context.url.pathname)) return next() // Bypass all non protected routes
+ */
+export function RouteManager(config: any): {
+    isProtectedRoute(pathname: any): any;
+    isBypassRoute(pathname: any): any;
+};
+export function AuthManager(config: any): {
+    isProtectedRoute(pathname: any): any;
+    isBypassRoute(pathname: any): any;
+};

package/dist/lib/checks.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Checks if a value is a plain object (not an array or null)
+ * @param {unknown} x - The value to check
+ * @returns {boolean} True if the value is a plain object
+ * @example
+ * isObject({}) // true
+ * isObject([]) // false
+ * isObject(null) // false
+ */
+export function isObject(x: unknown): boolean;
+/**
+ * Checks if a value is an array
+ * @param {unknown} x - The value to check
+ * @returns {boolean} True if the value is an array
+ * @example
+ * isArray([]) // true
+ * isArray({}) // false
+ */
+export function isArray(x: unknown): boolean;
+/**
+ * Checks if a value is not a plain object
+ * @param {unknown} x - The value to check
+ * @returns {boolean} True if the value is not a plain object
+ * @example
+ * notObject([]) // true
+ * notObject(null) // true
+ * notObject({}) // false
+ */
+export function notObject(x: unknown): boolean;

package/dist/lib/date/days.d.ts

@@ -0,0 +1,5 @@
+export const DAYS: {
+    short: string;
+    long: string;
+    numeric: number;
+}[];

package/dist/lib/date/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./days.js";
+export * from "./months.js";
+export * from "./time.js";

package/dist/lib/date/months.d.ts

@@ -0,0 +1,9 @@
+export const MONTHS: {
+    long: string;
+    short: string;
+    numeric: number;
+    lastDay: {
+        default: number;
+        leapYear: number;
+    };
+}[];

package/dist/lib/date/time.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Convert a time string to milliseconds
+ * @param {string} arg - The time string to convert
+ * @returns {number}
+ */
+export function ms(arg: string): number;
+export function seconds(arg: any): number;
+export function getTimeInMs(value: any, unit?: string): any;

package/dist/lib/form/form-data.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Converts Form Data into an object
+ * @param {FormData} formData
+ * @returns Object
+ */
+export function formDataToObject(formData: FormData): {};
+export function flattenArrayFields(inputObject: any): {};

package/dist/lib/form/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./form-data.js";
+export * from "./sanitize.js";

package/dist/lib/form/sanitize.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @typedef {Object} SanitizeOptions
+ * @property {Function} [sanitizer] - Function to sanitize strings
+ * @property {*} [additional] - Any additional properties are passed through to the sanitizer function
+ */
+/**
+ * Core sanitization function that handles different value types.
+ * Throws if no sanitizer function is provided.
+ * Any additional properties in options are passed through to the sanitizer function.
+ *
+ * @param {*} value - The value to sanitize
+ * @param {SanitizeOptions} [options={}] - Sanitization options
+ * @throws {Error} If sanitizer function is not provided
+ * @returns {*} Sanitized value
+ * @example
+ * // Basic sanitization
+ * sanitize('hello', { sanitizer: str => str.trim() })
+ *
+ * // With additional options passed to sanitizer
+ * sanitize('hello', {
+ *   sanitizer: (str, length, char) => str.padEnd(length, char),
+ *   length: 10,
+ *   char: '-'
+ * })
+ */
+export function sanitize(value: any, options?: SanitizeOptions): any;
+export type SanitizeOptions = {
+    /**
+     * - Function to sanitize strings
+     */
+    sanitizer?: Function;
+    /**
+     * - Any additional properties are passed through to the sanitizer function
+     */
+    additional?: any;
+};
+/**
+ * Sanitizes an array by recursively sanitizing each element.
+ * Throws if no sanitizer function is provided.
+ * Any additional properties in options are passed through to the sanitizer function.
+ *
+ * @param {Array} arr - Array to sanitize
+ * @param {SanitizeOptions} options - Sanitization options
+ * @throws {Error} If sanitizer function is not provided
+ * @returns {Array} New array with sanitized values
+ */
+export function sanitizeArray(arr: any[], { sanitizer, ...rest }: SanitizeOptions): any[];
+/**
+ * Sanitizes all string values in an object recursively.
+ * Throws if no sanitizer function is not provided.
+ * Any additional properties in options are passed through to the sanitizer function.
+ *
+ * @param {Object} obj - Object to sanitize
+ * @param {SanitizeOptions} [options={}] - Sanitization options
+ * @throws {Error} If sanitizer function is not provided
+ * @returns {Object} New object with sanitized values
+ */
+export function sanitizeObject(obj: any, { sanitizer, ...options }?: SanitizeOptions): any;

package/dist/lib/functions/debounce.d.ts

@@ -0,0 +1 @@
+export function debounce(callback: any, wait: any, immediate?: boolean): () => void;

package/dist/lib/functions/env.d.ts

@@ -0,0 +1 @@
+export function getEnv(): "browser" | "node";

package/dist/lib/functions/functional.d.ts

@@ -0,0 +1,4 @@
+export function curry(fn: any): (...args: any[]) => any;
+export function compose(...fns: any[]): (value: any) => any;
+export function pipe(...fns: any[]): (value: any) => any;
+export function times(fn: any, n: any): any[];

package/dist/lib/functions/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./debounce.js";
+export * from "./env.js";
+export * from "./functional.js";
+export * from "./throttle.js";
+export * from "./timeout.js";

package/dist/lib/functions/throttle.d.ts

@@ -0,0 +1 @@
+export function throttle(callback: any, wait: any): (...args: any[]) => void;

package/dist/lib/functions/timeout.d.ts

@@ -0,0 +1,3 @@
+export function timeout(wait: any, callback: any): void;
+export function delay(ms: any): Promise<any>;
+export function wait(ms: any): Promise<any>;

package/dist/lib/index.d.ts

@@ -0,0 +1,13 @@
+export * from "./arrays/index.js";
+export * from "./auth/index.js";
+export * from "./checks.js";
+export * from "./date/index.js";
+export * from "./form/index.js";
+export * from "./functions/index.js";
+export * from "./numbers/index.js";
+export * from "./objects/index.js";
+export * from "./promises/index.js";
+export * from "./sse.js";
+export * from "./strings/index.js";
+export * from "./style/index.js";
+export * from "./symbols/index.js";

package/dist/lib/numbers/index.d.ts

@@ -0,0 +1,2 @@
+export function splitUnit(string: any): any[];
+export * from "./math.js";

package/dist/lib/numbers/math.d.ts

@@ -0,0 +1,2 @@
+export function toDegrees(angle: any): number;
+export function toRadians(angle: any): number;

package/dist/lib/objects/camelcase-keys.d.ts

@@ -0,0 +1 @@
+export function camelCaseKeys(obj: any): any;

package/dist/lib/objects/empty.d.ts

@@ -0,0 +1,2 @@
+export function isEmpty(obj: any): boolean;
+export function notEmpty(obj: any): boolean;

package/dist/lib/objects/equal.d.ts

@@ -0,0 +1,2 @@
+export function isEqual(a: any, b: any): any;
+export function notEqual(a: any, b: any): boolean;

package/dist/lib/objects/extend.d.ts

@@ -0,0 +1,4 @@
+export function extendObject(object: any): {
+    orig: any;
+    extended: {};
+};

package/dist/lib/objects/flatten.d.ts

@@ -0,0 +1,4 @@
+export function flattenObject(obj: any, { separator, prefix }: {
+    separator: any;
+    prefix?: string;
+}): {};

package/dist/lib/objects/index.d.ts

@@ -0,0 +1,13 @@
+export * from "./camelcase-keys.js";
+export * from "./empty.js";
+export * from "./equal.js";
+export * from "./extend.js";
+export * from "./flatten.js";
+export * from "./json.js";
+export * from "./loop.js";
+export * from "./mix/mix.js";
+export * from "./nested-property.js";
+export * from "./normalize-object.js";
+export * from "./omit-empty.js";
+export * from "./size.js";
+export * from "./split.js";

package/dist/lib/objects/json.d.ts

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

package/dist/lib/objects/loop.d.ts

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

package/dist/lib/objects/mix/mix.d.ts

@@ -0,0 +1 @@
+export function mix(...sources: any[]): {};

package/dist/lib/objects/nested-property.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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"
+ */
+export function getNestedProperty(object: any, pathArr: any[]): any;
+export function getNestedProperty2(object: any, path: any): any;
+export function getNestedValue(object: any, path: any): any;

package/dist/lib/objects/normalize-object.d.ts

@@ -0,0 +1 @@
+export function normalizeObject(object: any): any;

package/dist/lib/objects/omit-empty.d.ts

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

package/dist/lib/objects/size.d.ts

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

package/dist/lib/objects/split.d.ts

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

package/dist/lib/promises/index.d.ts

@@ -0,0 +1 @@
+export * from "./reject.js";

package/dist/lib/promises/reject.d.ts

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

package/dist/lib/sse.d.ts

@@ -0,0 +1,16 @@
+export 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
+ */
+export function parseSSE(message: string): any | null;

package/dist/lib/strings/convert-case/convert-case.d.ts

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

package/dist/lib/strings/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./convert-case/convert-case.js";
+export * from "./markdown.js";
+export * from "./pluralize.js";
+export * from "./query-string.js";

package/dist/lib/strings/markdown.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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|Promise<string>} HTML string or Promise that resolves to HTML string
+ */
+export function markdown(content: string, options?: {
+    inline?: boolean;
+}): string | Promise<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
+ */
+export function treatMarkdownWhitespace(content: string, { inline }?: {
+    inline?: boolean;
+}): {
+    content: string;
+    inline: boolean;
+};

package/dist/lib/strings/pluralize.d.ts

@@ -0,0 +1 @@
+export { pluralize };

package/dist/lib/strings/query-string.d.ts

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

package/dist/lib/style/index.d.ts

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

package/dist/lib/symbols/index.d.ts

@@ -0,0 +1 @@
+export * from "./symbols.js";

package/dist/lib/symbols/symbols.d.ts

@@ -0,0 +1,2 @@
+export function getSymbol(object: any, description: any): symbol;
+export function getSymbolValue(object: any, description: any): any;

package/dist/node/common.d.ts

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

package/dist/node/dirname.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns __dirname
+ * @param url — import.meta.url
+ * @returns
+ */
+export function __dirname(url: any): string;
+export function dirname(url: any): string;

package/dist/node/file-cache.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Creates a file cache instance for managing cached files in a directory
+ * @param {string} dir - 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
+ */
+export function createCache(dir: string): Promise<object>;
+/**
+ * Legacy file cache API for managing a single cached file
+ * @param {Object} options
+ * @param {string} options.dir - 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>
+ * }>}
+ */
+export 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
+ */
+export 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
+ */
+export 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
+ */
+export function removeFirstSlash(x: string): string;

package/dist/node/file.d.ts

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

package/dist/node/hash.d.ts

@@ -0,0 +1 @@
+export function sha256Hash(string: any): string;

package/dist/node/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./common.js";
+export * from "./dirname.js";
+export * from "./file-cache.js";
+export * from "./hash.js";
+export * from "./pkce.js";
+export * from "./random-string.js";
+export * from "./sanitize.js";

package/dist/node/pkce.d.ts

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

package/dist/node/random-string.d.ts

@@ -0,0 +1,2 @@
+export function randomString(length?: number): Promise<string>;
+export function randomStringSync(length?: number): string;

package/dist/node/sanitize.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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
+ */
+export function sanitize(value: any, options?: any): any;