@lipemat/js-helpers 1.0.0

package/README.md

@@ -0,0 +1,61 @@
+# @lipemat/js-helpers
+
+Framework-agnostic TypeScript helper utilities used across [@lipemat](https://github.com/lipemat) projects.
+
+Each helper is small, dependency-light, and tree-shakeable. The package ships compiled ESM (`.js`) plus type declarations (`.d.ts`).
+
+## Installation
+
+```bash
+yarn add @lipemat/js-helpers
+# or
+npm install @lipemat/js-helpers
+```
+
+## Usage
+
+Every helper is importable from the package root:
+
+```ts
+import {debounce, hexToRGB, domReady} from '@lipemat/js-helpers';
+```
+
+## Helpers
+
+| Helper | Description | Docs |
+|--------|-------------|------|
+| `classNameAmend`, `sanitizeCssModuleClass` | Manipulate CSS class name strings. | [classes](./src/classes/Readme.md) |
+| `hexToRGB`, `RGBToHex`, `getLightness` | Convert between hex/RGB colors and measure lightness. | [colors](./src/colors/Readme.md) |
+| `csvExport` | Generate a CSV file and trigger a browser download. | [csvExport](./src/csvExport/Readme.md) |
+| `getFormattedDate` | Format a `Date` using `mm`/`dd`/`yyyy` tokens. | [date](./src/date/Readme.md) |
+| `debounce` | Lodash-free debounce with `immediate` and `cancel`. | [debounce](./src/debounce/Readme.md) |
+| `delay` | Resolve a promise after a set amount of time. | [delay](./src/delay/Readme.md) |
+| `isDesktop`, `isMobile`, `hasMobileUserAgent` | Detect desktop vs mobile clients. | [device](./src/device/Readme.md) |
+| `domReady` | Run a callback once the DOM is ready. | [dom-ready](./src/dom-ready/Readme.md) |
+| `ErrorWithFields` | `Error` subclass carrying per-field messages. | [error](./src/error/Readme.md) |
+| `decodeEntities` | Decode HTML entities in a string. | [escaping](./src/escaping/Readme.md) |
+| `injectScript` | Inject an external script into the DOM once. | [injectScript](./src/injectScript/Readme.md) |
+| `memoize` | Lodash-free memoization with an inspectable cache. | [memoize](./src/memoize/Readme.md) |
+| `noop` | A no-operation function. | [noop](./src/noop/Readme.md) |
+| `keysOf`, `entriesOf` | Type-safe `Object.keys`/`Object.entries`. | [objects](./src/objects/Readme.md) |
+| `once` | Run a function a single time and cache the result. | [once](./src/once/Readme.md) |
+| `generateRandomKey`, `add`/`removeLeading`/`TrailingSlash` | Random keys and slash management. | [string](./src/string/Readme.md) |
+| `throttle` | Lodash-free throttle with `immediate` and `cancel`. | [throttle](./src/throttle/Readme.md) |
+| `getUrlParam`, `addQueryArgs` | Read and append URL query arguments. | [url](./src/url/Readme.md) |
+
+## Development
+
+```bash
+yarn install      # install dependencies
+yarn build        # compile src -> dist via tsc
+yarn watch        # compile in watch mode
+yarn validate-ts  # type-check with no emit
+yarn lint         # ESLint (@lipemat/eslint-config)
+yarn test         # Jest (jsdom)
+```
+
+See [AGENTS.md](./AGENTS.md) for conventions on adding and documenting helpers.
+
+## License
+
+MIT © Mat Lipe

package/dist/classes/classes.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Utility functions for manipulating CSS class names.
+ *
+ * @version 1.4.0
+ */
+/**
+ * Add or remove a className from an existing string of classes.
+ *
+ * @param {string}  existing  - String of existing classes to work with.
+ * @param {string}  className - Classname to add or remove
+ * @param {boolean} add       - Either add or remove the class.
+ *
+ * @return {string} - The modified string of classes.
+ */
+export declare function classNameAmend(existing: string | undefined, className: string, add: boolean): string;
+/**
+ * Sanitize a CSS class name provided by PHP CSS module.
+ *
+ * - Removes any leading or trailing whitespace.
+ * - Replaces any spaces with a single dot.
+ * - Adds a leading dot if not present.
+ *
+ * @param {string} className - The class name to sanitize.
+ *
+ * @return {string} - The sanitized class name.
+ */
+export declare function sanitizeCssModuleClass(className: string | null): string;
+//# sourceMappingURL=classes.d.ts.map

package/dist/classes/classes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"classes.d.ts","sourceRoot":"","sources":["../../src/classes/classes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAE,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAI,MAAM,CAWtG;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,sBAAsB,CAAE,SAAS,EAAE,MAAM,GAAG,IAAI,GAAI,MAAM,CAUzE"}

package/dist/classes/classes.js

@@ -0,0 +1,50 @@
+/**
+ * Utility functions for manipulating CSS class names.
+ *
+ * @version 1.4.0
+ */
+/**
+ * Add or remove a className from an existing string of classes.
+ *
+ * @param {string}  existing  - String of existing classes to work with.
+ * @param {string}  className - Classname to add or remove
+ * @param {boolean} add       - Either add or remove the class.
+ *
+ * @return {string} - The modified string of classes.
+ */
+export function classNameAmend(existing, className, add) {
+    let classes = [];
+    if (undefined !== existing) {
+        classes = existing.split(' ');
+    }
+    if (add) {
+        classes.push(className);
+    }
+    else {
+        classes = classes.filter(_class => _class !== className);
+    }
+    return [...new Set(classes)].join(' ');
+}
+/**
+ * Sanitize a CSS class name provided by PHP CSS module.
+ *
+ * - Removes any leading or trailing whitespace.
+ * - Replaces any spaces with a single dot.
+ * - Adds a leading dot if not present.
+ *
+ * @param {string} className - The class name to sanitize.
+ *
+ * @return {string} - The sanitized class name.
+ */
+export function sanitizeCssModuleClass(className) {
+    if (null === className) {
+        return '';
+    }
+    className = className.trim();
+    className = className.replace(/\s+/g, '.');
+    if (className.charAt(0) !== '.') {
+        className = '.' + className;
+    }
+    return className;
+}
+//# sourceMappingURL=classes.js.map

package/dist/classes/classes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"classes.js","sourceRoot":"","sources":["../../src/classes/classes.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAAE,QAA4B,EAAE,SAAiB,EAAE,GAAY;IAC5F,IAAI,OAAO,GAAa,EAAE,CAAC;IAC3B,IAAK,SAAS,KAAK,QAAQ,EAAG,CAAC;QAC9B,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAE,GAAG,CAAE,CAAC;IACjC,CAAC;IACD,IAAK,GAAG,EAAG,CAAC;QACX,OAAO,CAAC,IAAI,CAAE,SAAS,CAAE,CAAC;IAC3B,CAAC;SAAM,CAAC;QACP,OAAO,GAAG,OAAO,CAAC,MAAM,CAAE,MAAM,CAAC,EAAE,CAAC,MAAM,KAAK,SAAS,CAAE,CAAC;IAC5D,CAAC;IACD,OAAO,CAAE,GAAG,IAAI,GAAG,CAAE,OAAO,CAAE,CAAE,CAAC,IAAI,CAAE,GAAG,CAAE,CAAC;AAC9C,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,sBAAsB,CAAE,SAAwB;IAC/D,IAAK,IAAI,KAAK,SAAS,EAAG,CAAC;QAC1B,OAAO,EAAE,CAAC;IACX,CAAC;IACD,SAAS,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;IAC7B,SAAS,GAAG,SAAS,CAAC,OAAO,CAAE,MAAM,EAAE,GAAG,CAAE,CAAC;IAC7C,IAAK,SAAS,CAAC,MAAM,CAAE,CAAC,CAAE,KAAK,GAAG,EAAG,CAAC;QACrC,SAAS,GAAG,GAAG,GAAG,SAAS,CAAC;IAC7B,CAAC;IACD,OAAO,SAAS,CAAC;AAClB,CAAC"}

package/dist/colors/colors.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Color Utilities
+ *
+ * @version 1.2.0
+ */
+export declare function hexToRGB(hex: string, alpha?: number): string;
+export declare function RGBToHex(rgb: string): string;
+/**
+ * Get the lightness of a color.
+ *
+ * > 0.5 is light, <= 0.5 is dark.
+ */
+export declare function getLightness(hexOrRGB: string): number;
+//# sourceMappingURL=colors.d.ts.map

package/dist/colors/colors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"colors.d.ts","sourceRoot":"","sources":["../../src/colors/colors.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,wBAAgB,QAAQ,CAAE,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAI,MAAM,CAU9D;AAGD,wBAAgB,QAAQ,CAAE,GAAG,EAAE,MAAM,GAAI,MAAM,CAa9C;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAE,QAAQ,EAAE,MAAM,GAAI,MAAM,CAGvD"}

package/dist/colors/colors.js

@@ -0,0 +1,63 @@
+/**
+ * Color Utilities
+ *
+ * @version 1.2.0
+ */
+export function hexToRGB(hex, alpha) {
+    if ('#' !== hex[0]) {
+        return hex;
+    }
+    const { r, g, b } = convertHexToRGB(hex);
+    if (typeof alpha !== 'undefined') {
+        return 'rgba(' + r + ', ' + g + ', ' + b + ', ' + alpha + ')';
+    }
+    return 'rgb(' + r + ', ' + g + ', ' + b + ')';
+}
+export function RGBToHex(rgb) {
+    if ('#' === rgb[0]) {
+        return rgb;
+    }
+    const colors = rgb.match(/^rgba?[\s+]?\([\s+]?(\d+)[\s+]?,[\s+]?(\d+)[\s+]?,[\s+]?(\d+)[\s+]?/i);
+    return (colors !== null) && 4 === colors.length
+        ? '#' +
+            ('0' + parseInt(colors[1], 10).toString(16)).slice(-2) +
+            ('0' + parseInt(colors[2], 10).toString(16)).slice(-2) +
+            ('0' + parseInt(colors[3], 10).toString(16)).slice(-2)
+        : '';
+}
+/**
+ * Get the lightness of a color.
+ *
+ * > 0.5 is light, <= 0.5 is dark.
+ */
+export function getLightness(hexOrRGB) {
+    const { r, g, b } = convertHexToRGB(hexOrRGB);
+    return Number((((0.2126 * r) + (0.7152 * g) + (0.0722 * b)) / 255).toFixed(2));
+}
+function convertHexToRGB(hex) {
+    // Already RGB, just convert to object.
+    if (hex.startsWith('rgb(')) {
+        const colors = hex.match(/^rgba?\(\s*(?<r>\d+)\s*,\s*(?<g>\d+)\s*,\s(?<b>\d+)(?:\s*,\s*[\d.]+)?\s*\)$/i);
+        const groups = colors?.groups;
+        return {
+            r: parseInt(groups?.r ?? '0', 10),
+            g: parseInt(groups?.g ?? '0', 10),
+            b: parseInt(groups?.b ?? '0', 10),
+        };
+    }
+    if (4 === hex.length) {
+        let colors = hex.substring(1).split('');
+        colors = [
+            colors[0],
+            colors[0],
+            colors[1],
+            colors[1],
+            colors[2],
+            colors[2],
+        ];
+        hex = colors.join('');
+    }
+    const r = parseInt(hex.slice(1, 3), 16), g = parseInt(hex.slice(3, 5), 16), b = parseInt(hex.slice(5, 7), 16);
+    return { r, g, b };
+}
+//# sourceMappingURL=colors.js.map

package/dist/colors/colors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"colors.js","sourceRoot":"","sources":["../../src/colors/colors.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,UAAU,QAAQ,CAAE,GAAW,EAAE,KAAc;IACpD,IAAK,GAAG,KAAK,GAAG,CAAE,CAAC,CAAE,EAAG,CAAC;QACxB,OAAO,GAAG,CAAC;IACZ,CAAC;IACD,MAAM,EAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAC,GAAG,eAAe,CAAE,GAAG,CAAE,CAAC;IAEzC,IAAK,OAAO,KAAK,KAAK,WAAW,EAAG,CAAC;QACpC,OAAO,OAAO,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,KAAK,GAAG,GAAG,CAAC;IAC/D,CAAC;IACD,OAAO,MAAM,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,GAAG,CAAC;AAC/C,CAAC;AAGD,MAAM,UAAU,QAAQ,CAAE,GAAW;IACpC,IAAK,GAAG,KAAK,GAAG,CAAE,CAAC,CAAE,EAAG,CAAC;QACxB,OAAO,GAAG,CAAC;IACZ,CAAC;IACD,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CACvB,sEAAsE,CACtE,CAAC;IACF,OAAO,CAAE,MAAM,KAAK,IAAI,CAAE,IAAI,CAAC,KAAK,MAAM,CAAC,MAAM;QAChD,CAAC,CAAC,GAAG;YACL,CAAE,GAAG,GAAG,QAAQ,CAAE,MAAM,CAAE,CAAC,CAAE,EAAE,EAAE,CAAE,CAAC,QAAQ,CAAE,EAAE,CAAE,CAAE,CAAC,KAAK,CAAE,CAAC,CAAC,CAAE;YAChE,CAAE,GAAG,GAAG,QAAQ,CAAE,MAAM,CAAE,CAAC,CAAE,EAAE,EAAE,CAAE,CAAC,QAAQ,CAAE,EAAE,CAAE,CAAE,CAAC,KAAK,CAAE,CAAC,CAAC,CAAE;YAChE,CAAE,GAAG,GAAG,QAAQ,CAAE,MAAM,CAAE,CAAC,CAAE,EAAE,EAAE,CAAE,CAAC,QAAQ,CAAE,EAAE,CAAE,CAAE,CAAC,KAAK,CAAE,CAAC,CAAC,CAAE;QAChE,CAAC,CAAC,EAAE,CAAC;AACP,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAE,QAAgB;IAC7C,MAAM,EAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAC,GAAG,eAAe,CAAE,QAAQ,CAAE,CAAC;IAC9C,OAAO,MAAM,CAAE,CAAE,CAAE,CAAE,MAAM,GAAG,CAAC,CAAE,GAAG,CAAE,MAAM,GAAG,CAAC,CAAE,GAAG,CAAE,MAAM,GAAG,CAAC,CAAE,CAAE,GAAG,GAAG,CAAE,CAAC,OAAO,CAAE,CAAC,CAAE,CAAE,CAAC;AAC9F,CAAC;AAGD,SAAS,eAAe,CAAE,GAAW;IACpC,uCAAuC;IACvC,IAAK,GAAG,CAAC,UAAU,CAAE,MAAM,CAAE,EAAG,CAAC;QAChC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CACvB,8EAA8E,CAC9E,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC;QAC9B,OAAO;YACN,CAAC,EAAE,QAAQ,CAAE,MAAM,EAAE,CAAC,IAAI,GAAG,EAAE,EAAE,CAAE;YACnC,CAAC,EAAE,QAAQ,CAAE,MAAM,EAAE,CAAC,IAAI,GAAG,EAAE,EAAE,CAAE;YACnC,CAAC,EAAE,QAAQ,CAAE,MAAM,EAAE,CAAC,IAAI,GAAG,EAAE,EAAE,CAAE;SACnC,CAAC;IACH,CAAC;IAGD,IAAK,CAAC,KAAK,GAAG,CAAC,MAAM,EAAG,CAAC;QACxB,IAAI,MAAM,GAAG,GAAG,CAAC,SAAS,CAAE,CAAC,CAAE,CAAC,KAAK,CAAE,EAAE,CAAE,CAAC;QAC5C,MAAM,GAAG;YACR,MAAM,CAAE,CAAC,CAAE;YACX,MAAM,CAAE,CAAC,CAAE;YACX,MAAM,CAAE,CAAC,CAAE;YACX,MAAM,CAAE,CAAC,CAAE;YACX,MAAM,CAAE,CAAC,CAAE;YACX,MAAM,CAAE,CAAC,CAAE;SACX,CAAC;QACF,GAAG,GAAG,MAAM,CAAC,IAAI,CAAE,EAAE,CAAE,CAAC;IACzB,CAAC;IAED,MAAM,CAAC,GAAG,QAAQ,CAAE,GAAG,CAAC,KAAK,CAAE,CAAC,EAAE,CAAC,CAAE,EAAE,EAAE,CAAE,EAC1C,CAAC,GAAG,QAAQ,CAAE,GAAG,CAAC,KAAK,CAAE,CAAC,EAAE,CAAC,CAAE,EAAE,EAAE,CAAE,EACrC,CAAC,GAAG,QAAQ,CAAE,GAAG,CAAC,KAAK,CAAE,CAAC,EAAE,CAAC,CAAE,EAAE,EAAE,CAAE,CAAC;IAGvC,OAAO,EAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAC,CAAC;AAClB,CAAC"}

package/dist/csvExport/csvExport.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @version 1.0.8
+ */
+export type CsvData = Array<{
+    [column: string]: number | string;
+} | Array<number | string>>;
+/**
+ * Generate a csv file and trigger a download of a said file.
+ *
+ * @author Mat Lipe
+ * @since September, 2019
+ *
+ * @param {Array<Object>} data
+ * @param {string}        fileName
+ *
+ * @return {void}
+ */
+export declare function csvExport(data: CsvData, fileName: string): void;
+//# sourceMappingURL=csvExport.d.ts.map

package/dist/csvExport/csvExport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"csvExport.d.ts","sourceRoot":"","sources":["../../src/csvExport/csvExport.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,MAAM,MAAM,OAAO,GAAG,KAAK,CAAC;IAAE,CAAE,MAAM,EAAE,MAAM,GAAI,MAAM,GAAG,MAAM,CAAA;CAAE,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAA;AAE7F;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAI,IAAI,CAiBjE"}

package/dist/csvExport/csvExport.js

@@ -0,0 +1,74 @@
+import DOMPurify from 'dompurify';
+const { sanitize } = DOMPurify;
+/**
+ * Generate a csv file and trigger a download of a said file.
+ *
+ * @author Mat Lipe
+ * @since September, 2019
+ *
+ * @param {Array<Object>} data
+ * @param {string}        fileName
+ *
+ * @return {void}
+ */
+export function csvExport(data, fileName) {
+    const csv = convertArrayOfObjectsToCSV(data);
+    if (null === csv) {
+        return;
+    }
+    const blob = new Blob([csv], { type: 'text/csv;charset=utf-8;' });
+    const link = document.createElement('a');
+    if (link.download !== undefined) {
+        link.setAttribute('href', sanitize(URL.createObjectURL(blob)));
+        link.setAttribute('download', sanitize(fileName));
+        link.style.visibility = 'hidden';
+        document.body.appendChild(link);
+        link.click();
+        document.body.removeChild(link);
+    }
+}
+/**
+ * Convert an array of objects|array to a string representation of a csv file.
+ *
+ * @param data
+ */
+function convertArrayOfObjectsToCSV(data) {
+    if (null === data || (0 === data.length)) {
+        return null;
+    }
+    const keys = Object.keys(data[0]);
+    let result = '';
+    if ('0' !== keys[0]) {
+        result += keys.join(',');
+        result += '\n';
+    }
+    data.forEach(item => {
+        keys.forEach((key, i) => {
+            if (i > 0) {
+                result += ',';
+            }
+            // @ts-expect-error
+            let innerValue = item[key]?.toString().replace(/"/g, '""') ?? '';
+            if (innerValue.search(/([",\n])/g) >= 0) {
+                innerValue = '"' + innerValue + '"';
+            }
+            result += decodeHtml(innerValue);
+        });
+        result += '\n';
+    });
+    return result;
+}
+/**
+ * Convert any HTML special characters to their string version,
+ * so they may be encoded via `encodeURI`.
+ *
+ * @param {string} html
+ *
+ * @return {string}
+ */
+function decodeHtml(html) {
+    const txt = document.createElement('textarea');
+    txt.innerHTML = sanitize(html);
+    return txt.value;
+}
+//# sourceMappingURL=csvExport.js.map

package/dist/csvExport/csvExport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"csvExport.js","sourceRoot":"","sources":["../../src/csvExport/csvExport.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,WAAW,CAAC;AAElC,MAAM,EAAC,QAAQ,EAAC,GAAG,SAAS,CAAC;AAQ7B;;;;;;;;;;GAUG;AACH,MAAM,UAAU,SAAS,CAAE,IAAa,EAAE,QAAgB;IACzD,MAAM,GAAG,GAAG,0BAA0B,CAAE,IAAI,CAAE,CAAC;IAC/C,IAAK,IAAI,KAAK,GAAG,EAAG,CAAC;QACpB,OAAO;IACR,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,IAAI,CAAE,CAAE,GAAG,CAAE,EAAE,EAAC,IAAI,EAAE,yBAAyB,EAAC,CAAE,CAAC;IACpE,MAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAE,GAAG,CAAE,CAAC;IAE3C,IAAK,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAG,CAAC;QACnC,IAAI,CAAC,YAAY,CAAE,MAAM,EAAE,QAAQ,CAAE,GAAG,CAAC,eAAe,CAAE,IAAI,CAAE,CAAE,CAAE,CAAC;QACrE,IAAI,CAAC,YAAY,CAAE,UAAU,EAAE,QAAQ,CAAE,QAAQ,CAAE,CAAE,CAAC;QACtD,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,QAAQ,CAAC;QACjC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAE,IAAI,CAAE,CAAC;QAClC,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAE,IAAI,CAAE,CAAC;IACnC,CAAC;AACF,CAAC;AAED;;;;GAIG;AACH,SAAS,0BAA0B,CAAE,IAAa;IACjD,IAAK,IAAI,KAAK,IAAI,IAAI,CAAE,CAAC,KAAK,IAAI,CAAC,MAAM,CAAE,EAAG,CAAC;QAC9C,OAAO,IAAI,CAAC;IACb,CAAC;IAED,MAAM,IAAI,GAAa,MAAM,CAAC,IAAI,CAAE,IAAI,CAAE,CAAC,CAAE,CAAE,CAAC;IAEhD,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAK,GAAG,KAAK,IAAI,CAAE,CAAC,CAAE,EAAG,CAAC;QACzB,MAAM,IAAI,IAAI,CAAC,IAAI,CAAE,GAAG,CAAE,CAAC;QAC3B,MAAM,IAAI,IAAI,CAAC;IAChB,CAAC;IAED,IAAI,CAAC,OAAO,CAAE,IAAI,CAAC,EAAE;QACpB,IAAI,CAAC,OAAO,CAAE,CAAE,GAAW,EAAE,CAAS,EAAG,EAAE;YAC1C,IAAK,CAAC,GAAG,CAAC,EAAG,CAAC;gBACb,MAAM,IAAI,GAAG,CAAC;YACf,CAAC;YACD,mBAAmB;YACnB,IAAI,UAAU,GAAG,IAAI,CAAE,GAAG,CAAE,EAAE,QAAQ,EAAE,CAAC,OAAO,CAAE,IAAI,EAAE,IAAI,CAAE,IAAI,EAAE,CAAC;YACrE,IAAK,UAAU,CAAC,MAAM,CAAE,WAAW,CAAE,IAAI,CAAC,EAAG,CAAC;gBAC7C,UAAU,GAAG,GAAG,GAAG,UAAU,GAAG,GAAG,CAAC;YACrC,CAAC;YACD,MAAM,IAAI,UAAU,CAAE,UAAU,CAAE,CAAC;QACpC,CAAC,CAAE,CAAC;QACJ,MAAM,IAAI,IAAI,CAAC;IAChB,CAAC,CAAE,CAAC;IAEJ,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,UAAU,CAAE,IAAY;IAChC,MAAM,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAE,UAAU,CAAE,CAAC;IACjD,GAAG,CAAC,SAAS,GAAG,QAAQ,CAAE,IAAI,CAAE,CAAC;IACjC,OAAO,GAAG,CAAC,KAAK,CAAC;AAClB,CAAC"}

package/dist/date/date.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @version 1.1.0
+ */
+/**
+ * Given a Date object, return the date in the provided format.
+ * Limited to `mm`, `dd`, and `yyyy` formats.
+ *
+ */
+export declare function getFormattedDate(date: Date, format?: string): string;
+//# sourceMappingURL=date.d.ts.map

package/dist/date/date.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../../src/date/date.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAE,IAAI,EAAE,IAAI,EAAE,MAAM,GAAE,MAAqB,GAAI,MAAM,CAapF"}

package/dist/date/date.js

@@ -0,0 +1,20 @@
+/**
+ * @version 1.1.0
+ */
+/**
+ * Given a Date object, return the date in the provided format.
+ * Limited to `mm`, `dd`, and `yyyy` formats.
+ *
+ */
+export function getFormattedDate(date, format = 'mm/dd/yyyy') {
+    const year = date.getFullYear();
+    let month = (1 + date.getMonth()).toString();
+    month = month.length > 1 ? month : '0' + month;
+    let day = date.getDate().toString();
+    day = day.length > 1 ? day : '0' + day;
+    return format
+        .replace('mm', month)
+        .replace('dd', day)
+        .replace('yyyy', year.toString());
+}
+//# sourceMappingURL=date.js.map

package/dist/date/date.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.js","sourceRoot":"","sources":["../../src/date/date.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAE,IAAU,EAAE,SAAiB,YAAY;IAC1E,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAEhC,IAAI,KAAK,GAAG,CAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAE,CAAC,QAAQ,EAAE,CAAC;IAC/C,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC;IAE/C,IAAI,GAAG,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;IACpC,GAAG,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC;IAEvC,OAAO,MAAM;SACX,OAAO,CAAE,IAAI,EAAE,KAAK,CAAE;SACtB,OAAO,CAAE,IAAI,EAAE,GAAG,CAAE;SACpB,OAAO,CAAE,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAE,CAAC;AACtC,CAAC"}

package/dist/debounce/debounce.d.ts

@@ -0,0 +1,17 @@
+import type { Callback } from '../once/once.js';
+type Result<T extends Callback> = {
+    (...args: Parameters<T>): Promise<ReturnType<T>>;
+    immediate: (...args: Parameters<T>) => ReturnType<T>;
+    cancel: () => void;
+};
+/**
+ * Alternative to lodash debounce.
+ *
+ * - Additional support for `immediate` execution to bypass the wait time.
+ * - Returns a promise to allow waiting for a completion of the debounced function.
+ *
+ * @version 1.4.1
+ */
+export declare function debounce<T extends Callback>(fn: T, wait?: number): Result<T>;
+export {};
+//# sourceMappingURL=debounce.d.ts.map

package/dist/debounce/debounce.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"debounce.d.ts","sourceRoot":"","sources":["../../src/debounce/debounce.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,QAAQ,EAAS,MAAM,iBAAiB,CAAC;AAEtD,KAAK,MAAM,CAAC,CAAC,SAAS,QAAQ,IAAI;IACjC,CAAE,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,GAAI,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IACnD,SAAS,EAAE,CAAE,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAM,UAAU,CAAC,CAAC,CAAC,CAAC;IACvD,MAAM,EAAE,MAAM,IAAI,CAAC;CACnB,CAAC;AAGF;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,QAAQ,EAAG,EAAE,EAAE,CAAC,EAAE,IAAI,SAAM,GAAI,MAAM,CAAC,CAAC,CAAC,CA6B3E"}

package/dist/debounce/debounce.js

@@ -0,0 +1,34 @@
+/**
+ * Alternative to lodash debounce.
+ *
+ * - Additional support for `immediate` execution to bypass the wait time.
+ * - Returns a promise to allow waiting for a completion of the debounced function.
+ *
+ * @version 1.4.1
+ */
+export function debounce(fn, wait = 300) {
+    let timer;
+    let promise = null;
+    let resolve;
+    const debounced = function (...args) {
+        clearTimeout(timer);
+        timer = setTimeout(() => {
+            resolve(fn(...args));
+        }, wait);
+        return promise ??= new Promise(res => {
+            resolve = res;
+        });
+    };
+    // Immediate execution method.
+    debounced.immediate = function (...args) {
+        clearTimeout(timer);
+        return fn(...args);
+    };
+    // Cancel method.
+    debounced.cancel = function () {
+        clearTimeout(timer);
+        promise = null;
+    };
+    return debounced;
+}
+//# sourceMappingURL=debounce.js.map

package/dist/debounce/debounce.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"debounce.js","sourceRoot":"","sources":["../../src/debounce/debounce.ts"],"names":[],"mappings":"AASA;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CAAsB,EAAK,EAAE,IAAI,GAAG,GAAG;IAC9D,IAAI,KAA8B,CAAC;IACnC,IAAI,OAAO,GAAkC,IAAI,CAAC;IAClD,IAAI,OAAyC,CAAC;IAE9C,MAAM,SAAS,GAAG,UAAU,GAAG,IAAmB;QACjD,YAAY,CAAE,KAAK,CAAE,CAAC;QACtB,KAAK,GAAG,UAAU,CAAE,GAAG,EAAE;YACxB,OAAO,CAAE,EAAE,CAAE,GAAG,IAAI,CAAE,CAAE,CAAC;QAC1B,CAAC,EAAE,IAAI,CAAE,CAAC;QAEV,OAAO,OAAO,KAAK,IAAI,OAAO,CAAiB,GAAG,CAAC,EAAE;YACpD,OAAO,GAAG,GAAG,CAAC;QACf,CAAC,CAAE,CAAC;IACL,CAAC,CAAC;IAEF,8BAA8B;IAC9B,SAAS,CAAC,SAAS,GAAG,UAAU,GAAG,IAAmB;QACrD,YAAY,CAAE,KAAK,CAAE,CAAC;QACtB,OAAO,EAAE,CAAE,GAAG,IAAI,CAAE,CAAC;IACtB,CAAC,CAAC;IAEF,iBAAiB;IACjB,SAAS,CAAC,MAAM,GAAG;QAClB,YAAY,CAAE,KAAK,CAAE,CAAC;QACtB,OAAO,GAAG,IAAI,CAAC;IAChB,CAAC,CAAC;IAEF,OAAO,SAAsB,CAAC;AAC/B,CAAC"}

package/dist/delay/delay.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Delay a promise by a given amount of time.
+ *
+ * Used to provide enough time to show transitions while
+ * other operations are happening.
+ *
+ * @example ```ts
+ *     const delayPromise = delay(200);
+ *     // Do another action while waiting for the delay.
+ *     await fetchPosts();
+ *     await delayPromise;
+ *
+ * @param  ms The amount of time to delay the promise by.
+ *
+ * @version 1.0.0
+ */
+export declare const delay: (ms: number) => Promise<void>;
+//# sourceMappingURL=delay.d.ts.map

package/dist/delay/delay.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"delay.d.ts","sourceRoot":"","sources":["../../src/delay/delay.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,KAAK,GAAK,IAAI,MAAM,KAAI,OAAO,CAAC,IAAI,CAEhD,CAAC"}

package/dist/delay/delay.js

@@ -0,0 +1,20 @@
+/**
+ * Delay a promise by a given amount of time.
+ *
+ * Used to provide enough time to show transitions while
+ * other operations are happening.
+ *
+ * @example ```ts
+ *     const delayPromise = delay(200);
+ *     // Do another action while waiting for the delay.
+ *     await fetchPosts();
+ *     await delayPromise;
+ *
+ * @param  ms The amount of time to delay the promise by.
+ *
+ * @version 1.0.0
+ */
+export const delay = (ms) => {
+    return new Promise(resolve => setTimeout(resolve, ms));
+};
+//# sourceMappingURL=delay.js.map

package/dist/delay/delay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delay.js","sourceRoot":"","sources":["../../src/delay/delay.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAE,EAAU,EAAkB,EAAE;IACpD,OAAO,IAAI,OAAO,CAAE,OAAO,CAAC,EAAE,CAAC,UAAU,CAAE,OAAO,EAAE,EAAE,CAAE,CAAE,CAAC;AAC5D,CAAC,CAAC"}

package/dist/device/device.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Detects if the user is on a desktop or mobile device.
+ * - Desktop: Width greater than 800 px and not a mobile user agent.
+ * - Mobile: Width less than 800 px or a mobile user agent.
+ *
+ * @see useMobile - For keeping track of mobile state in React components.
+ *
+ * @version 2.0.2
+ */
+export declare function isDesktop(): boolean;
+export declare function isMobile(): boolean;
+/**
+ * Checks if the user agent is a mobile device.
+ * - Checks if an HTTPS `userAgentData` API is available and if the `mobile` property is true.
+ * - If not available, checks the `navigator.userAgent` string for common mobile identifiers.
+ *
+ * Modeled after the `wp_is_mobile()` function in WordPress but runs on the client side
+ * to support:
+ *  1. Edge page caching.
+ *  2. Changes in emulation of the user agent during development.
+ *
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/Navigator/userAgentData
+ * @link https://developer.wordpress.org/reference/functions/wp_is_mobile/
+ */
+export declare function hasMobileUserAgent(): boolean;
+//# sourceMappingURL=device.d.ts.map

package/dist/device/device.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"device.d.ts","sourceRoot":"","sources":["../../src/device/device.ts"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AAGH,wBAAgB,SAAS,IAAI,OAAO,CAEnC;AAED,wBAAgB,QAAQ,IAAI,OAAO,CAElC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,IAAI,OAAO,CAU5C"}

package/dist/device/device.js

@@ -0,0 +1,42 @@
+const breakPoint = 800;
+/**
+ * Detects if the user is on a desktop or mobile device.
+ * - Desktop: Width greater than 800 px and not a mobile user agent.
+ * - Mobile: Width less than 800 px or a mobile user agent.
+ *
+ * @see useMobile - For keeping track of mobile state in React components.
+ *
+ * @version 2.0.2
+ */
+export function isDesktop() {
+    return window.innerWidth > breakPoint && !hasMobileUserAgent();
+}
+export function isMobile() {
+    return window.innerWidth < breakPoint || hasMobileUserAgent();
+}
+/**
+ * Checks if the user agent is a mobile device.
+ * - Checks if an HTTPS `userAgentData` API is available and if the `mobile` property is true.
+ * - If not available, checks the `navigator.userAgent` string for common mobile identifiers.
+ *
+ * Modeled after the `wp_is_mobile()` function in WordPress but runs on the client side
+ * to support:
+ *  1. Edge page caching.
+ *  2. Changes in emulation of the user agent during development.
+ *
+ * @link https://developer.mozilla.org/en-US/docs/Web/API/Navigator/userAgentData
+ * @link https://developer.wordpress.org/reference/functions/wp_is_mobile/
+ */
+export function hasMobileUserAgent() {
+    const ua = navigator.userAgent;
+    // @ts-expect-error TS2551 -- Not all browsers support userAgentData yet.
+    const uaData = navigator.userAgentData ?? undefined;
+    if ('undefined' !== typeof uaData && 'undefined' !== typeof uaData.mobile && Boolean(uaData.mobile)) {
+        return true;
+    }
+    else if ('undefined' === typeof ua || '' === ua) {
+        return false;
+    }
+    return ['Mobile', 'Android', 'Silk/', 'Kindle', 'BlackBerry', 'Opera Mini', 'Opera Mobi'].some(agent => ua.includes(agent));
+}
+//# sourceMappingURL=device.js.map

package/dist/device/device.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device.js","sourceRoot":"","sources":["../../src/device/device.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,GAAG,GAAG,CAAC;AAGvB;;;;;;;;GAQG;AAGH,MAAM,UAAU,SAAS;IACxB,OAAO,MAAM,CAAC,UAAU,GAAG,UAAU,IAAI,CAAE,kBAAkB,EAAE,CAAC;AACjE,CAAC;AAED,MAAM,UAAU,QAAQ;IACvB,OAAO,MAAM,CAAC,UAAU,GAAG,UAAU,IAAI,kBAAkB,EAAE,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,kBAAkB;IACjC,MAAM,EAAE,GAAG,SAAS,CAAC,SAAS,CAAC;IAC/B,yEAAyE;IACzE,MAAM,MAAM,GAAG,SAAS,CAAC,aAAa,IAAI,SAAS,CAAC;IACpD,IAAK,WAAW,KAAK,OAAO,MAAM,IAAI,WAAW,KAAK,OAAO,MAAM,CAAC,MAAM,IAAI,OAAO,CAAE,MAAM,CAAC,MAAM,CAAE,EAAG,CAAC;QACzG,OAAO,IAAI,CAAC;IACb,CAAC;SAAM,IAAK,WAAW,KAAK,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,EAAG,CAAC;QACrD,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,CAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,CAAE,CAAC,IAAI,CAAE,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAE,KAAK,CAAE,CAAE,CAAC;AACnI,CAAC"}

package/dist/dom-ready/dom-ready.d.ts

@@ -0,0 +1,12 @@
+export type EventCallback = (this: Document | void, ev?: Event) => void;
+/**
+ * Fire a callback after the DOMContentLoaded event.
+ * If called after the document is loaded, callback will be executed immediately.
+ * Logic borrowed from `@wordpress/dom-ready`.
+ *
+ * @param {Function} callback Callback to execute.
+ *
+ * @version 1.0.0
+ */
+export declare function domReady(callback: EventCallback): undefined;
+//# sourceMappingURL=dom-ready.d.ts.map

package/dist/dom-ready/dom-ready.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dom-ready.d.ts","sourceRoot":"","sources":["../../src/dom-ready/dom-ready.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG,CAAE,IAAI,EAAE,QAAQ,GAAG,IAAI,EAAE,EAAE,CAAC,EAAE,KAAK,KAAM,IAAI,CAAC;AAG1E;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,CAAE,QAAQ,EAAE,aAAa,aAShD"}

package/dist/dom-ready/dom-ready.js

@@ -0,0 +1,19 @@
+/**
+ * Fire a callback after the DOMContentLoaded event.
+ * If called after the document is loaded, callback will be executed immediately.
+ * Logic borrowed from `@wordpress/dom-ready`.
+ *
+ * @param {Function} callback Callback to execute.
+ *
+ * @version 1.0.0
+ */
+export function domReady(callback) {
+    if ('undefined' === typeof document) {
+        return;
+    }
+    if ('complete' === document.readyState || 'interactive' === document.readyState) {
+        return void callback();
+    }
+    document.addEventListener('DOMContentLoaded', () => callback());
+}
+//# sourceMappingURL=dom-ready.js.map

package/dist/dom-ready/dom-ready.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dom-ready.js","sourceRoot":"","sources":["../../src/dom-ready/dom-ready.ts"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,MAAM,UAAU,QAAQ,CAAE,QAAuB;IAChD,IAAK,WAAW,KAAK,OAAO,QAAQ,EAAG,CAAC;QACvC,OAAO;IACR,CAAC;IACD,IAAK,UAAU,KAAK,QAAQ,CAAC,UAAU,IAAI,aAAa,KAAK,QAAQ,CAAC,UAAU,EAAG,CAAC;QACnF,OAAO,KAAK,QAAQ,EAAE,CAAC;IACxB,CAAC;IAED,QAAQ,CAAC,gBAAgB,CAAE,kBAAkB,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAE,CAAC;AACnE,CAAC"}

package/dist/error/error.d.ts

@@ -0,0 +1,28 @@
+export interface ErrorField<T extends {
+    [field: string]: string;
+}> {
+    code: keyof T;
+    data?: object | string | boolean | number;
+    message: string;
+    additional_errors?: Array<ErrorField<T>>;
+}
+export type Fields<T> = {
+    [field in keyof T]?: string;
+};
+/**
+ * Use in place from the default Error handler to include
+ * information about form fields which caused the errors.
+ *
+ * Translates `WP_Error` responses from REST API into
+ * field name and their corresponding messages.
+ *
+ * @version 1.2.1
+ */
+export declare class ErrorWithFields<T extends {
+    [field: string]: string;
+}> extends Error {
+    fields: Fields<T>;
+    constructor(error: ErrorField<T>);
+    translate(error: ErrorField<T>): ErrorField<T>;
+}
+//# sourceMappingURL=error.d.ts.map

package/dist/error/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/error/error.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS;IAAE,CAAE,KAAK,EAAE,MAAM,GAAI,MAAM,CAAA;CAAE;IAClE,IAAI,EAAE,MAAM,CAAC,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAC1C,OAAO,EAAE,MAAM,CAAC;IAEhB,iBAAiB,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;CACzC;AAED,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI;KACtB,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM;CAC3B,CAAC;AAEF;;;;;;;;GAQG;AACH,qBAAa,eAAe,CAAC,CAAC,SAAS;IAAE,CAAE,KAAK,EAAE,MAAM,GAAI,MAAM,CAAA;CAAE,CAAE,SAAQ,KAAK;IAC3E,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;gBAEZ,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;IAejC,SAAS,CAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAI,UAAU,CAAC,CAAC,CAAC;CAShD"}