@vettvangur/vanilla 0.0.2 → 0.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vettvangur/vanilla",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Vettvangur | Vanilla JS Utility Library",
   "access": "private",
   "type": "module",
@@ -32,6 +32,6 @@
   "scripts": {
     "bundle": "pnpm types & rollup -c",
     "dist": "pnpm publish",
-    "types": "tsc -p tsconfig.json & shx mv dist/types/index.d.mts dist/types/index.d.ts"
+    "types": "tsc -p tsconfig.json && shx mv dist/types/index.d.mts dist/types/index.d.ts"
   }
 }

package/dist/types/index.d.mts

@@ -1,249 +0,0 @@
-/**
- * Capitalizes the first letter of a given string.
- *
- * @function capitalize
- * @param {string|null|undefined} value - The string to capitalize. If null or undefined, returns an empty string.
- * @param {boolean} [lowerRest=false] - If true, converts the rest of the string to lowercase.
- * @returns {string} The capitalized string, or an empty string if the input is falsy.
- *
- * @example capitalize(string)
- */
-export function capitalize(value: string | null | undefined, lowerRest?: boolean): string;
-/**
- * Retrieves a translated string from a dictionary based on a given key and culture.
- *
- * @function dictionary
- * @param {string} key - The key for the translation.
- * @param {Array} data - The array of translation objects.
- * @param {string} [culture='is-IS'] - The language code to search for (default: 'is-IS').
- * @returns {string} The translated string if found, otherwise '[Translation not found]'.
- *
- * @example
- * dictionary(key)
- */
-export function dictionary(key: string, data: any[], culture?: string): string;
-/**
- * Fetches data from a given URL with customizable options and error handling.
- *
- * @async
- * @function fetcher
- * @param {Object} params - The parameters for the fetcher function.
- * @param {string} params.url - The URL to fetch data from.
- * @param {RequestInit|null} [params.options={}] - Fetch API options (headers, method, body, etc.).
- * @param {boolean} [params.throwOnError=false] - Whether to throw an error on non-OK HTTP responses.
- * @returns {Promise<Object|null>} The parsed JSON response or null if an error occurs.
- * @throws Will throw an error if `throwOnError` is true and the fetch fails or returns a non-OK status.
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
- *
- * @example
- * const getData = await fetcher({
- *  url,
- *  {
- *    method: 'POST',
- *    headers: {
- *      'Content-Type': 'application/json'
- *    }
- *  }
- * })
- */
-export function fetcher({ url, options, throwOnError }: {
-    url: string;
-    options?: RequestInit | null;
-    throwOnError?: boolean;
-}): Promise<any | null>;
-/**
- * Loads environment variables from `.env` and `.env.[NODE_ENV]` files.
- *
- * This function first loads the base `.env` file, then loads an environment-specific file
- * based on `NODE_ENV` (e.g., `.env.production`, `.env.development`). If `NODE_ENV` is not set,
- * it defaults to `'development'`.
- *
- * @async
- * @function loadEnvFiles
- * @param {boolean} [showMessage=true] - Whether to log a message indicating which env file was loaded.
- * @throws {Error} Throws an error if loading the environment-specific file fails.
- * @returns {Promise<void>} Resolves when environment files are loaded.
- */
-export function loadEnvFiles(showMessage?: boolean): Promise<void>;
-/**
- * Retrieves a template based on an alias, capitalizing the alias before lookup.
- *
- * @param {string} alias - The alias to search for in the templates object.
- * @param {Object} templates - An object containing templates indexed by alias.
- * @returns {*} - The matching template, or the 'Subpage' template if not found.
- *
- * @example
- * const template = getTemplate('name', templates);
- *
- */
-export function getTemplate(alias: string, templates: any): any;
-/**
- * Checks if a given value is empty (i.e., '', undefined, or null).
- *
- * @param {*} value - The value to check.
- * @returns {boolean} - Returns `true` if the value is empty, otherwise `false`.
- *
- * @example
- * console.log(isEmpty('')); // true
- * console.log(isEmpty(null)); // true
- * console.log(isEmpty('hello')); // false
- */
-export function isEmpty(value: any): boolean;
-/**
- * Compiles a module map, converting a selector-importer pair into a `Map` for efficient lookups.
- *
- * @function createModuleMap
- * @param {Object} moduleMap - The module map where selectors are keys and dynamic imports are values.
- * @returns {Map} A Map where selectors are keys and dynamic import functions are values.
- *
- * @example
- * const moduleMap = {
- *   '.selector': () => import('components/component'),
- *   '.selector-1, .selector-2, .selector-3': () => import('components/component')
- * };
- * const compiledMap = createModuleMap(moduleMap);
- */
-export function createModuleMap(moduleMap: any): Map<any, any>;
-/**
- * Adds a preload class to the body element after a short delay.
- * Also hides the preload animation after another delay.
- *
- * @function preloadTimeout
- *
- * @example
- * preloadTimeout(); // Adds 'loaded' class after a short delay, hides preload animation after another delay.
- */
-export function preloadTimeout(): void;
-/**
- * Lazy loads modules based on a selector in the provided module map using the IntersectionObserver API.
- *
- * @function lazyModules
- * @param {Map} moduleMap - A map of selectors to dynamic import functions.
- * @param {Element} [root=document] - The root element to query for selectors (defaults to `document`).
- *
- * @example
- * const moduleMap = new Map([
- *   ['.selector', () => import('components/component')],
- *   ['.selector-1, .selector-2, .selector-3', () => import('components/compomnent')],
- * ]);
- * lazyModules(moduleMap); // Lazy load the components when their selectors are in view.
- */
-export function lazyModules(moduleMap: Map<any, any>, root?: Element): void;
-/**
- * Initializes core scripts with an optional callback function.
- *
- * @function initCoreScripts
- * @param {Function} callback - The callback function to initialize core scripts.
- *
- * @example
- * initCoreScripts(() => { console.log('Core scripts initialized'); });
- */
-export function initCoreScripts(callback?: Function): void;
-/**
- * Handles the `DOMContentLoaded` event to initialize core scripts and lazy load modules.
- *
- * @function onDomReady
- * @param {Map} moduleMap - The compiled module map for lazy loading.
- * @param {Function} initCoreScriptsCallback - The callback function to initialize core scripts.
- * @param {Function} [callback] - An optional callback to execute during `DOMContentLoaded` event handling.
- *
- * @example
- * onDomReady(moduleMap, () => { console.log('Core scripts initialized'); }, () => { console.log('DOM content loaded'); });
- */
-export function onDomReady(moduleMap: Map<any, any>, initCoreScriptsCallback: Function, callback?: Function): void;
-/**
- * Handles the `popstate` event to initialize core scripts and lazy load modules.
- *
- * @function onPopstate
- * @param {Map} moduleMap - The compiled module map for lazy loading.
- * @param {Function} initCoreScriptsCallback - The callback function to initialize core scripts.
- * @param {Function} [callback] - An optional callback to execute during `popstate` event handling.
- *
- * @example
- * onPopstate(moduleMap, () => { console.log('Core scripts initialized'); }, () => { console.log('Popstate event triggered'); });
- */
-export function onPopstate(moduleMap: Map<any, any>, initCoreScriptsCallback: Function, callback?: Function): void;
-/**
- * Handles the `htmx:beforeSwap` event to perform actions before HTMX swaps.
- *
- * @function onHtmxBeforeSwap
- * @param {Function} callback - The callback function to execute during `htmx:beforeSwap` event handling.
- *
- * @example
- * onHtmxBeforeSwap((e) => { console.log('HTMX before swap:', e); });
- */
-export function onHtmxBeforeSwap(callback?: Function): void;
-/**
- * Handles the `htmx:afterSwap` event to initialize core scripts and lazy load modules.
- *
- * @function onHtmxAfterSwap
- * @param {Map} moduleMap - The compiled module map for lazy loading.
- * @param {Function} [callback] - An optional callback to execute during `htmx:afterSwap` event handling.
- *
- * @example
- * onHtmxAfterSwap(moduleMap, () => { console.log('HTMX after swap completed'); });
- */
-export function onHtmxAfterSwap(moduleMap: Map<any, any>, callback?: Function): void;
-/**
- * Handles the `htmx:afterSettle` event to initialize core scripts and lazy load modules.
- *
- * @function onHtmxAfterSettle
- * @param {Map} moduleMap - The compiled module map for lazy loading.
- * @param {Function} initCoreScriptsCallback - The callback function to initialize core scripts.
- * @param {Function} [callback] - An optional callback to execute during `htmx:afterSettle` event handling.
- *
- * @example
- * onHtmxAfterSettle(moduleMap, () => { console.log('Core scripts initialized'); }, () => { console.log('HTMX settle completed'); });
- */
-export function onHtmxAfterSettle(moduleMap: Map<any, any>, initCoreScriptsCallback: Function, callback?: Function): void;
-/**
- * Handles click outside and ESC key events to trigger a callback and close open elements with the `open` class.
- *
- * @function clickOutside
- * @param {Function} callback - The callback function to be executed when a click outside or ESC key event occurs.
- * @description
- * This function listens for `click` events and `keyup` events:
- * - When a click outside of `.co-trigger` is detected, the provided callback is executed.
- * - When the `ESC` key is pressed, the provided callback is executed, and any open elements (with the `open` class) are closed.
- *
- * @example
- * ClickOutside(() => {
- *   console.log('Click outside or ESC pressed!');
- * });
- */
-export function clickOutside(callback: Function): void;
-export namespace regexr {
-    /**
-     * Tests whether a given value matches a regex pattern.
-     *
-     * @param {Object} params - Parameters for testing regex.
-     * @param {string} params.value - The string to test against the regex.
-     * @param {string} params.pattern - The regex pattern to match.
-     * @param {string} [params.flags='g'] - Regex flags (default: 'g').
-     * @returns {boolean} Returns `true` if the value matches the pattern, otherwise `false`.
-     *
-     * @example
-     * const isMatch = regexr.match(pattern)
-     * console.log(isMatch) // return true or false
-     */
-    function test({ value, pattern, flags }: {
-        value: string;
-        pattern: string;
-        flags?: string;
-    }): boolean;
-    /**
-     * Matches a given value against a regex pattern and returns the matches.
-     *
-     * @param {Object} params - Parameters for matching regex.
-     * @param {string} params.value - The string to match against the regex.
-     * @param {string} params.pattern - The regex pattern to match.
-     * @param {string} [params.flags='g'] - Regex flags (default: 'g').
-     * @returns {Array<string>|null} Returns an array of matches, or `null` if no match is found.
-     */
-    function match({ value, pattern, flags }: {
-        value: string;
-        pattern: string;
-        flags?: string;
-    }): Array<string> | null;
-}
-export function flatten(obj: any, prefix?: string): any;