@koine/utils 2.0.0-beta.1 → 2.0.0-beta.11

package/clsx.d.ts

@@ -1,9 +1,13 @@
-import type { ClassValue } from "clsx";
+type ClassValue = ClassArray | ClassDictionary | string | number | null | boolean | undefined;
+type ClassDictionary = Record<string, any>;
+type ClassArray = ClassValue[];
+export type ClsxClassValue = ClassValue;
 /**
  * Class names utility
  *
+ * @category impl
  * @borrows [lukeed/clsx](https://github.com/lukeed/clsx)
- * @license [MIT: Luke Edwards](https://github.com/lukeed/clsx/blob/master/license)
+ * @license MIT Luke Edwards https://github.com/lukeed/clsx/blob/master/license
  */
 export declare const clsx: (...args: ClassValue[]) => string;
 export default clsx;

package/clsx.mjs

@@ -1,23 +1,22 @@
+// import type { ClassValue } from "clsx";
 // import _clsx from "clsx";
 // export const clsx = _clsx;
 function toVal(mix) {
-    var k, y, str = "";
+    let k, y, str = "";
     if (typeof mix === "string" || typeof mix === "number") {
         str += mix;
-    }
-    else if (typeof mix === "object") {
+    } else if (typeof mix === "object") {
         if (Array.isArray(mix)) {
-            for (k = 0; k < mix.length; k++) {
+            for(k = 0; k < mix.length; k++){
                 if (mix[k]) {
-                    if ((y = toVal(mix[k]))) {
+                    if (y = toVal(mix[k])) {
                         str && (str += " ");
                         str += y;
                     }
                 }
             }
-        }
-        else {
-            for (k in mix) {
+        } else {
+            for(k in mix){
                 if (mix[k]) {
                     str && (str += " ");
                     str += k;
@@ -30,15 +29,15 @@ function toVal(mix) {
 /**
  * Class names utility
  *
+ * @category impl
  * @borrows [lukeed/clsx](https://github.com/lukeed/clsx)
- * @license [MIT: Luke Edwards](https://github.com/lukeed/clsx/blob/master/license)
- */
-export var clsx = function () {
-    var i = 0, tmp, x, str = "";
-    while (i < arguments.length) {
+ * @license MIT Luke Edwards https://github.com/lukeed/clsx/blob/master/license
+ */ export const clsx = function() {
+    let i = 0, tmp, x, str = "";
+    while(i < arguments.length){
         // eslint-disable-next-line prefer-rest-params
-        if ((tmp = arguments[i++])) {
-            if ((x = toVal(tmp))) {
+        if (tmp = arguments[i++]) {
+            if (x = toVal(tmp)) {
                 str && (str += " ");
                 str += x;
             }

package/convertRange.d.ts

@@ -3,7 +3,9 @@
  *
  * e.g. converting number 5 in a scale/range from 0 10 to a scale/range from 50
  * to 100 would return 75
- * ```
+ * @example
+ *
+ * ```ts
  * convertRange(5, [0, 10], [50, 100]);
  * ```
  *

package/convertRange.mjs

@@ -3,14 +3,15 @@
  *
  * e.g. converting number 5 in a scale/range from 0 10 to a scale/range from 50
  * to 100 would return 75
- * ```
+ * @example
+ *
+ * ```ts
  * convertRange(5, [0, 10], [50, 100]);
  * ```
  *
  * @category math
  * @see https://stackoverflow.com/a/14224813
- */
-export function convertRange(num, r1, r2) {
-    return ((num - r1[0]) * (r2[1] - r2[0])) / (r1[1] - r1[0]) + r2[0];
+ */ export function convertRange(num, r1, r2) {
+    return (num - r1[0]) * (r2[1] - r2[0]) / (r1[1] - r1[0]) + r2[0];
 }
 export default convertRange;

package/cookie.d.ts

@@ -1,5 +1,5 @@
 /**
- * @file
+ * @module
  *
  * @category cookie
  *
@@ -7,6 +7,9 @@
  * - [js-cookie](https://github.com/js-cookie/js-cookie)
  * - [cookie](https://github.com/jshttp/cookie)
  */
+/**
+ * @category cookie
+ */
 type CookieAttributes = {
     /**
      * Define when the cookie will be removed. Value can be a Number
@@ -41,13 +44,22 @@ type CookieAttributes = {
      */
     sameSite?: "strict" | "Strict" | "lax" | "Lax" | "none" | "None" | undefined;
 };
+/**
+ * @category cookie
+ */
 export type CookieAttributesServer = CookieAttributes & {
     maxAge?: number;
     httpOnly?: boolean;
     encode?: (input: string) => string;
     decode?: (input: string) => string;
 };
+/**
+ * @category cookie
+ */
 export type CookieAttributesClient = CookieAttributes;
+/**
+ * @category cookie
+ */
 export declare const defaultAttributesClient: {
     path: string;
 };

package/cookie.mjs

@@ -1,10 +1,15 @@
 /**
- * @file
+ * @module
  *
  * @category cookie
  *
  * All cookie related code is inspired and adapted from:
  * - [js-cookie](https://github.com/js-cookie/js-cookie)
  * - [cookie](https://github.com/jshttp/cookie)
- */
-export var defaultAttributesClient = { path: "/" };
+ */ /**
+ * @category cookie
+ */ /**
+ * @category cookie
+ */ export const defaultAttributesClient = {
+    path: "/"
+};

package/createPalette.d.ts

@@ -10,7 +10,9 @@ type PaletteMap<T extends PaletteShades> = {
  * Create palette, this is primarily thought to improve the reuse of a palette
  * definition between TailwindCSS and straight ES imports
  *
- * @category styling|tailwind|colours
+ * @category colors
+ * @category tailwind
+ * @category responsive
  *
  * @returns An array with: 1) A flat palette map 2) A TailwindCSS ready palette
  * object 3) A flat array of colors (no special sorting, same order as the `shades`

package/createPalette.mjs

@@ -2,21 +2,31 @@
  * Create palette, this is primarily thought to improve the reuse of a palette
  * definition between TailwindCSS and straight ES imports
  *
- * @category styling|tailwind|colours
+ * @category colors
+ * @category tailwind
+ * @category responsive
  *
  * @returns An array with: 1) A flat palette map 2) A TailwindCSS ready palette
  * object 3) A flat array of colors (no special sorting, same order as the `shades`
  * given as argument)
- */
-export var createPalette = function (name, shades) {
-    var map = shades.reduce(function (map, def) {
+ */ export const createPalette = (name, shades)=>{
+    const map = shades.reduce((map, def)=>{
         map[def[0]] = def[1];
         return map;
     }, {});
-    var tailwindPalette = shades.reduce(function (map, def) {
-        map["".concat(name, "-").concat(def[0])] = def[1];
+    // NOTE: the following breaks typedoc, with `any` it compiles
+    // const map = shades.reduce((map, def) => {
+    //   map[def[0]] = def[1] as TColor;
+    //   return map;
+    // }, {} as { [s: string]: TColor });
+    const tailwindPalette = shades.reduce((map, def)=>{
+        map[`${name}-${def[0]}`] = def[1];
         return map;
     }, {});
-    return [map, tailwindPalette, Object.values(map)];
+    return [
+        map,
+        tailwindPalette,
+        Object.values(map)
+    ];
 };
 export default createPalette;

package/debounce.mjs

@@ -3,27 +3,19 @@
  *
  * @category function
  * @borrows [davidwalsh/debounce](https://davidwalsh.name/javascript-debounce-function)
- */
-export function debounce(fn, wait, immediate) {
-    var timeout;
-    return function () {
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments[_i];
-        }
+ */ export function debounce(fn, wait, immediate) {
+    let timeout;
+    return function(...args) {
         // eslint-disable-next-line @typescript-eslint/no-this-alias
-        var context = this;
-        var later = function () {
+        const context = this;
+        const later = function() {
             timeout = null;
-            if (!immediate)
-                fn.apply(context, args);
+            if (!immediate) fn.apply(context, args);
         };
-        var callNow = immediate && !timeout;
-        if (timeout)
-            clearTimeout(timeout);
+        const callNow = immediate && !timeout;
+        if (timeout) clearTimeout(timeout);
         timeout = setTimeout(later, wait);
-        if (callNow)
-            fn.apply(context, args);
+        if (callNow) fn.apply(context, args);
     };
 }
 export default debounce;

package/debouncePromise.d.ts

@@ -1,11 +1,29 @@
-import { debounce as tsDebounce } from "ts-debounce";
-export { type Options as DebounceOptions } from "ts-debounce";
-export { type DebouncedFunction } from "ts-debounce";
+/**
+ * Copy pasted from [chodorowicz/ts-debounce](https://github.com/chodorowicz/ts-debounce/blob/master/src/index.ts)
+ *
+ * @module
+ */
+/**
+ * @categroy functionn
+ */
+export type DebounceOptions<Result> = {
+    isImmediate?: boolean;
+    maxWait?: number;
+    callback?: (data: Result) => void;
+};
+/**
+ * @categroy functionn
+ */
+export interface DebouncedFunction<Args extends any[], F extends (...args: Args) => any> {
+    (this: ThisParameterType<F>, ...args: Args & Parameters<F>): Promise<ReturnType<F>>;
+    cancel: (reason?: any) => void;
+}
 /**
  * Debounce function (with `Promise`)
  *
  * @category function
  * @borrows [chodorowicz/ts-debounce](https://github.com/chodorowicz/ts-debounce)
+ * @license MIT: Jakub Chodorowicz
  */
-export declare const debouncePromise: typeof tsDebounce;
+export declare function debouncePromise<Args extends any[], F extends (...args: Args) => any>(func: F, waitMilliseconds?: number, options?: DebounceOptions<ReturnType<F>>): DebouncedFunction<Args, F>;
 export default debouncePromise;

package/debouncePromise.mjs

@@ -1,9 +1,79 @@
-import { debounce as tsDebounce } from "ts-debounce";
+// import { debounce as tsDebounce } from "ts-debounce";
+// export { type Options as DebounceOptions } from "ts-debounce";
+// export { type DebouncedFunction } from "ts-debounce";
+// /**
+//  * Debounce function (with `Promise`)
+//  *
+//  * @category function
+//  * @borrows [chodorowicz/ts-debounce](https://github.com/chodorowicz/ts-debounce)
+//  */
+// export const debouncePromise = tsDebounce;
+// export default debouncePromise;
 /**
+ * Copy pasted from [chodorowicz/ts-debounce](https://github.com/chodorowicz/ts-debounce/blob/master/src/index.ts)
+ *
+ * @module
+ */ /**
+ * @categroy functionn
+ */ /**
  * Debounce function (with `Promise`)
  *
  * @category function
  * @borrows [chodorowicz/ts-debounce](https://github.com/chodorowicz/ts-debounce)
- */
-export var debouncePromise = tsDebounce;
+ * @license MIT: Jakub Chodorowicz
+ */ export function debouncePromise(func, waitMilliseconds = 50, options = {}) {
+    let timeoutId;
+    const isImmediate = options.isImmediate ?? false;
+    const callback = options.callback ?? false;
+    const maxWait = options.maxWait;
+    let lastInvokeTime = Date.now();
+    let promises = [];
+    function nextInvokeTimeout() {
+        if (maxWait !== undefined) {
+            const timeSinceLastInvocation = Date.now() - lastInvokeTime;
+            if (timeSinceLastInvocation + waitMilliseconds >= maxWait) {
+                return maxWait - timeSinceLastInvocation;
+            }
+        }
+        return waitMilliseconds;
+    }
+    const debouncedFunction = function(...args) {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const context = this;
+        return new Promise((resolve, reject)=>{
+            const invokeFunction = function() {
+                timeoutId = undefined;
+                lastInvokeTime = Date.now();
+                if (!isImmediate) {
+                    const result = func.apply(context, args);
+                    callback && callback(result);
+                    promises.forEach(({ resolve })=>resolve(result));
+                    promises = [];
+                }
+            };
+            const shouldCallNow = isImmediate && timeoutId === undefined;
+            if (timeoutId !== undefined) {
+                clearTimeout(timeoutId);
+            }
+            timeoutId = setTimeout(invokeFunction, nextInvokeTimeout());
+            if (shouldCallNow) {
+                const result = func.apply(context, args);
+                callback && callback(result);
+                return resolve(result);
+            }
+            promises.push({
+                resolve,
+                reject
+            });
+        });
+    };
+    debouncedFunction.cancel = function(reason) {
+        if (timeoutId !== undefined) {
+            clearTimeout(timeoutId);
+        }
+        promises.forEach(({ reject })=>reject(reason));
+        promises = [];
+    };
+    return debouncedFunction;
+}
 export default debouncePromise;

package/debounceRaf.d.ts

@@ -1,9 +1,9 @@
 /**
  * Debounce function (with `requestAnimationFrame`)
  *
- * (c) 2021 Chris Ferdinandi, MIT License, https://gomakethings.com
  * @category function
  * @borrows [vanillajstoolkit/debounce](https://vanillajstoolkit.com/helpers/debounce/)
+ * @license (c) 2021 Chris Ferdinandi, MIT License, https://gomakethings.com
  */
 export declare function debounceRaf<T extends (...args: any[]) => any>(this: unknown, fn: T): (this: unknown, ...args: Parameters<T>) => void;
 export default debounceRaf;

package/debounceRaf.mjs

@@ -1,25 +1,20 @@
 /**
  * Debounce function (with `requestAnimationFrame`)
  *
- * (c) 2021 Chris Ferdinandi, MIT License, https://gomakethings.com
  * @category function
  * @borrows [vanillajstoolkit/debounce](https://vanillajstoolkit.com/helpers/debounce/)
- */
-export function debounceRaf(fn) {
-    var timeout;
-    return function () {
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments[_i];
-        }
+ * @license (c) 2021 Chris Ferdinandi, MIT License, https://gomakethings.com
+ */ export function debounceRaf(fn) {
+    let timeout;
+    return function(...args) {
         // eslint-disable-next-line @typescript-eslint/no-this-alias
-        var context = this;
+        const context = this;
         // If there's a timer, cancel it
         if (timeout) {
             window.cancelAnimationFrame(timeout);
         }
         // Setup the new requestAnimationFrame()
-        timeout = window.requestAnimationFrame(function () {
+        timeout = window.requestAnimationFrame(function() {
             fn.apply(context, args);
         });
     };

package/decode.mjs

@@ -1,9 +1,8 @@
 /**
  * @category security
  * @see https://stackoverflow.com/a/22405578/9122820
- */
-export function decode(str) {
-    return str.replace(/.{3}/g, function (c) {
+ */ export function decode(str) {
+    return str.replace(/.{3}/g, function(c) {
         return String.fromCharCode(parseInt(c, 10));
     });
 }

package/encode.mjs

@@ -1,9 +1,8 @@
 /**
  * @category security
  * @see https://stackoverflow.com/a/22405578/9122820
- */
-export function encode(str) {
-    return str.replace(/./g, function (c) {
+ */ export function encode(str) {
+    return str.replace(/./g, function(c) {
         return ("00" + c.charCodeAt(0)).slice(-3);
     });
 }

package/ensureInt.mjs

@@ -2,8 +2,5 @@
  * Ensure input to be an integer
  *
  * @category cast
- */
-export var ensureInt = function (input) {
-    return typeof input === "string" ? parseInt(input, 10) : Math.round(input);
-};
+ */ export const ensureInt = (input)=>typeof input === "string" ? parseInt(input, 10) : Math.round(input);
 export default ensureInt;

package/env.mjs

@@ -1,3 +1,2 @@
-"use strict";
 // export const __DEV__ = process.env["NODE_ENV"] !== "production";
 // export const __TEST__ = process.env["NODE_ENV"] === "test";

package/errorToString.d.ts

@@ -1,7 +1,8 @@
 /**
  * Ensure to transform a JavaScript `Error` into a string (uses its `message`)
  *
- * @category Error
+ * @category error
+ * @category cast
  */
 export declare const errorToString: (e: unknown) => string;
 export default errorToString;

package/errorToString.mjs

@@ -2,9 +2,7 @@ import isString from "./isString";
 /**
  * Ensure to transform a JavaScript `Error` into a string (uses its `message`)
  *
- * @category Error
- */
-export var errorToString = function (e) {
-    return e instanceof Error ? e.message : isString(e) ? e : "";
-};
+ * @category error
+ * @category cast
+ */ export const errorToString = (e)=>e instanceof Error ? e.message : isString(e) ? e : "";
 export default errorToString;

package/findDuplicatedIndexes.mjs

@@ -1,10 +1,9 @@
 /**
  * @category array
- */
-export function findDuplicatedIndexes(arr) {
-    var indexes = {};
-    for (var i = 0; i < arr.length; i++) {
-        var idxInArray = arr.indexOf(arr[i]);
+ */ export function findDuplicatedIndexes(arr) {
+    const indexes = {};
+    for(let i = 0; i < arr.length; i++){
+        const idxInArray = arr.indexOf(arr[i]);
         if (idxInArray !== i && idxInArray !== -1) {
             indexes[i] = true;
         }

package/forin.d.ts

@@ -1,7 +1,8 @@
 /**
  * To easily get typed native `for in`
  *
- * @category objects
+ * @category native
+ * @category object
  */
 export declare function forin<T>(object: T, cb: <K extends keyof T>(key: K, value: T[K]) => void): void;
 export default forin;

package/forin.mjs

@@ -1,10 +1,10 @@
 /**
  * To easily get typed native `for in`
  *
- * @category objects
- */
-export function forin(object, cb) {
-    for (var key in object) {
+ * @category native
+ * @category object
+ */ export function forin(object, cb) {
+    for(const key in object){
         cb(key, object[key]);
     }
 }

package/gbToBytes.mjs

@@ -2,6 +2,5 @@
  * Gigabytes to bytes
  *
  * @category format
- */
-export var gbToBytes = function (bytes) { return bytes * 1000 * 1000 * 1000; };
+ */ export const gbToBytes = (bytes)=>bytes * 1000 * 1000 * 1000;
 export default gbToBytes;

package/getEmptyArray.d.ts

@@ -1,5 +1,4 @@
 /**
- *
  * Returns an array of undefined values of the desired length, useful to build
  * skeleton UIs.
  *

package/getEmptyArray.mjs

@@ -1,15 +1,15 @@
 import isNumber from "./isNumber";
 /**
- *
  * Returns an array of undefined values of the desired length, useful to build
  * skeleton UIs.
  *
  * @category array
- */
-export function getEmptyArray /* <T extends undefined | null = undefined> */(length) {
+ */ export function getEmptyArray(length) {
     if (!isNumber(length)) {
         length = parseInt(length, 10);
     }
-    return Array.from({ length: length });
+    return Array.from({
+        length
+    });
 }
 export default getEmptyArray;

package/getKeys.d.ts

@@ -2,7 +2,8 @@
  * Type safe replacement for `Object.keys(myObject)` to iterate over a record
  * without loosing the key's types in simple `string`s.
  *
- * @category objects
+ * @category native
+ * @category object
  * @see https://stackoverflow.com/a/59459000/1938970
  */
 export declare const getKeys: <T extends object>(obj: T) => (keyof T)[];

package/getKeys.mjs

@@ -2,8 +2,8 @@
  * Type safe replacement for `Object.keys(myObject)` to iterate over a record
  * without loosing the key's types in simple `string`s.
  *
- * @category objects
+ * @category native
+ * @category object
  * @see https://stackoverflow.com/a/59459000/1938970
- */
-export var getKeys = Object.keys;
+ */ export const getKeys = Object.keys;
 export default getKeys;

package/getMediaQueryWidthResolvers.d.ts

@@ -1,4 +1,10 @@
+/**
+ * @category responsive
+ */
 export type GetMediaQueryWidthResolversBreakpoints = Record<string, number>;
+/**
+ * @category responsive
+ */
 export declare function getMediaQueryWidthResolvers<TBreakpointsConfig extends GetMediaQueryWidthResolversBreakpoints>(customBreakpoints: TBreakpointsConfig): {
     max: (br: Extract<keyof TBreakpointsConfig, string>) => string;
     min: (br: Extract<keyof TBreakpointsConfig, string>) => string;