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

package/serializeCookie.mjs

@@ -1,22 +1,20 @@
 /**
- * @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)
- */
-import { isNumber } from "./isNumber";
+ */ import { isNumber } from "./isNumber";
 /**
  * RegExp to match field-content in RFC 7230 sec 3.2
  *
  * field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ]
  * field-vchar   = VCHAR / obs-text
  * obs-text      = %x80-FF
- */
-// eslint-disable-next-line no-control-regex
-var fieldContentRegExp = /^[\u0009\u0020-\u007e\u0080-\u00ff]+$/;
+ */ // eslint-disable-next-line no-control-regex
+const fieldContentRegExp = /^[\u0009\u0020-\u007e\u0080-\u00ff]+$/;
 /**
  * Serialize data into a cookie header.
  *
@@ -27,16 +25,10 @@ var fieldContentRegExp = /^[\u0009\u0020-\u007e\u0080-\u00ff]+$/;
  *   => "foo=bar; httpOnly"
  *
  * @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 function serializeCookie(name, val, attributes) {
-    if (attributes === void 0) { attributes = {}; }
-    var _a = attributes.encode, encode = _a === void 0 ? encodeURIComponent : _a, domain = attributes.domain, path = attributes.path, httpOnly = attributes.httpOnly, secure = attributes.secure, sameSite = attributes.sameSite;
-    var maxAge = attributes.maxAge, expires = attributes.expires;
-    var value = encode(val);
+ */ export function serializeCookie(name, val, attributes = {}) {
+    const { encode = encodeURIComponent, domain, path, httpOnly, secure, sameSite } = attributes;
+    let { maxAge, expires } = attributes;
+    const value = encode(val);
     if (process.env["NODE_ENV"] !== "production") {
         if (!fieldContentRegExp.test(name)) {
             throw new TypeError("argument name is invalid");
@@ -48,7 +40,7 @@ export function serializeCookie(name, val, attributes) {
             throw new TypeError("argument val is invalid");
         }
     }
-    var str = name + "=" + value;
+    let str = name + "=" + value;
     if (null != maxAge) {
         maxAge = maxAge - 0;
         if (isNaN(maxAge) || !isFinite(maxAge)) {
@@ -85,7 +77,7 @@ export function serializeCookie(name, val, attributes) {
         str += "; Secure";
     }
     if (sameSite) {
-        switch (sameSite.toLowerCase()) {
+        switch(sameSite.toLowerCase()){
             case "lax":
                 str += "; SameSite=Lax";
                 break;
@@ -95,8 +87,6 @@ export function serializeCookie(name, val, attributes) {
             case "none":
                 str += "; SameSite=None";
                 break;
-            //  default:
-            //    throw new TypeError('option sameSite is invalid');
         }
     }
     return str;

package/setCookie.d.ts

@@ -1,10 +1,6 @@
 import { type CookieAttributesClient } from "./cookie";
 /**
  * @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 declare function setCookie<T extends string = string>(name: string, value: string | T, attributes?: CookieAttributesClient): string | undefined;
 export default setCookie;

package/setCookie.mjs

@@ -1,4 +1,3 @@
-import { __assign, __rest } from "tslib";
 import { defaultAttributesClient } from "./cookie";
 import isNumber from "./isNumber";
 import isUndefined from "./isUndefined";
@@ -7,16 +6,14 @@ function converterWrite(value) {
 }
 /**
  * @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 function setCookie(name, value, attributes) {
-    if (attributes === void 0) { attributes = {}; }
+ */ export function setCookie(name, value, attributes = {}) {
     // eslint-disable-next-line prefer-const
-    var expires = attributes.expires, restAttrs = __rest(attributes, ["expires"]);
-    var cleanedAttrs = __assign(__assign({ expires: "" }, defaultAttributesClient), restAttrs);
+    let { expires, ...restAttrs } = attributes;
+    const cleanedAttrs = {
+        expires: "",
+        ...defaultAttributesClient,
+        ...restAttrs
+    };
     if (isUndefined(document)) {
         if (process.env["NODE_ENV"] !== "production") {
             console.warn("[@koine/utils:setCookie] document is undefined");
@@ -29,12 +26,10 @@ export function setCookie(name, value, attributes) {
     if (expires) {
         cleanedAttrs.expires = expires.toUTCString();
     }
-    name = encodeURIComponent(name)
-        .replace(/%(2[346B]|5E|60|7C)/g, decodeURIComponent)
-        .replace(/[()]/g, escape);
-    var stringifiedAttributes = "";
-    for (var name_1 in attributes) {
-        var attrName = name_1;
+    name = encodeURIComponent(name).replace(/%(2[346B]|5E|60|7C)/g, decodeURIComponent).replace(/[()]/g, escape);
+    let stringifiedAttributes = "";
+    for(const name in attributes){
+        const attrName = name;
         if (!attributes[attrName]) {
             continue;
         }
@@ -49,10 +44,8 @@ export function setCookie(name, value, attributes) {
         // Consume the characters of the unparsed-attributes up to,
         // not including, the first %x3B (";") character.
         // ...
-        stringifiedAttributes +=
-            "=" + String(attributes[attrName]).split(";")[0];
+        stringifiedAttributes += "=" + String(attributes[attrName]).split(";")[0];
     }
-    return (document.cookie =
-        name + "=" + converterWrite(value) + stringifiedAttributes);
+    return document.cookie = name + "=" + converterWrite(value) + stringifiedAttributes;
 }
 export default setCookie;

package/shuffle.d.ts

@@ -2,15 +2,16 @@
  * Creates an array of shuffled values, using a version of the
  * [Fisher-Yates shuffle](https://en.wikipedia.org/wiki/Fisher-Yates_shuffle).
  *
- * @see lodash.shuffle
- * @since 0.1.0
- * @category arrays
- * @param {Array} array The array to shuffle.
- * @returns {Array} Returns the new shuffled array.
+ * @category array
+ * @borrows [lodash.shuffle](https://github.com/lodash/lodash/blob/master/shuffle.js)
  * @example
- *
+ * ```ts
  * shuffle([1, 2, 3, 4])
  * // => [4, 1, 3, 2]
+ * ```
+ *
+ * @param array The array to shuffle.
+ * @returns The new shuffled array.
  */
 export declare function shuffle<T>(array: T[]): T[];
 export default shuffle;

package/shuffle.mjs

@@ -1,29 +1,30 @@
-import { __spreadArray } from "tslib";
 /**
  * Creates an array of shuffled values, using a version of the
  * [Fisher-Yates shuffle](https://en.wikipedia.org/wiki/Fisher-Yates_shuffle).
  *
- * @see lodash.shuffle
- * @since 0.1.0
- * @category arrays
- * @param {Array} array The array to shuffle.
- * @returns {Array} Returns the new shuffled array.
+ * @category array
+ * @borrows [lodash.shuffle](https://github.com/lodash/lodash/blob/master/shuffle.js)
  * @example
- *
+ * ```ts
  * shuffle([1, 2, 3, 4])
  * // => [4, 1, 3, 2]
- */
-export function shuffle(array) {
-    var length = array == null ? 0 : array.length;
+ * ```
+ *
+ * @param array The array to shuffle.
+ * @returns The new shuffled array.
+ */ export function shuffle(array) {
+    const length = array == null ? 0 : array.length;
     if (!length) {
         return [];
     }
-    var index = -1;
-    var lastIndex = length - 1;
-    var result = __spreadArray([], array, true);
-    while (++index < length) {
-        var rand = index + Math.floor(Math.random() * (lastIndex - index + 1));
-        var value = result[rand];
+    let index = -1;
+    const lastIndex = length - 1;
+    const result = [
+        ...array
+    ];
+    while(++index < length){
+        const rand = index + Math.floor(Math.random() * (lastIndex - index + 1));
+        const value = result[rand];
         result[rand] = result[index];
         result[index] = value;
     }

package/slugify.d.ts

@@ -5,7 +5,8 @@
  * - replaces the punctuation with dashes
  *
  * @category text
- * @see https://gist.github.com/mathewbyrne/1280286#gistcomment-3498021
+ *
+ * @borrows [mathewbyrne's gist](https://gist.github.com/mathewbyrne/1280286#gistcomment-3498021)
  */
 export declare function slugify(text: string, separator?: string): string;
 export default slugify;

package/slugify.mjs

@@ -7,17 +7,20 @@ import { removeAccents } from "./removeAccents";
  * - replaces the punctuation with dashes
  *
  * @category text
- * @see https://gist.github.com/mathewbyrne/1280286#gistcomment-3498021
- */
-export function slugify(text, separator) {
-    if (separator === void 0) { separator = "-"; }
-    return removeAccents(text.toString().toLowerCase().trim(), accentsSets.concat([["-", "[·/_,:;']"]]))
-        .replace(/\s+/g, "-") // replace spaces with -
-        .replace(/&/g, "-and-") // replace & with 'and'
-        .replace(/[^\w-]+/g, "") // remove all non-word chars
-        .replace(/--+/g, "-") // replace multiple - with single -
-        .replace(/^-+/, "") // trim - from start of text
-        .replace(/-+$/, "") // trim - from end of text
-        .replace(/-/g, separator);
+ *
+ * @borrows [mathewbyrne's gist](https://gist.github.com/mathewbyrne/1280286#gistcomment-3498021)
+ */ export function slugify(text, separator = "-") {
+    return removeAccents(text.toString().toLowerCase().trim(), accentsSets.concat([
+        [
+            "-",
+            "[·/_,:;']"
+        ]
+    ])).replace(/\s+/g, "-") // replace spaces with -
+    .replace(/&/g, "-and-") // replace & with 'and'
+    .replace(/[^\w-]+/g, "") // remove all non-word chars
+    .replace(/--+/g, "-") // replace multiple - with single -
+    .replace(/^-+/, "") // trim - from start of text
+    .replace(/-+$/, "") // trim - from end of text
+    .replace(/-/g, separator);
 }
 export default slugify;

package/split.d.ts

@@ -1,3 +1,7 @@
 export type Split<S extends string, D extends string> = string extends S ? string[] : S extends "" ? [] : S extends `${infer T}${D}${infer U}` ? [T, ...Split<U, D>] : [S];
+/**
+ * @category native
+ * @category text
+ */
 export declare function split<T extends string, D extends string>(str: T, delimiter: D): Split<T, D>;
 export default split;

package/split.mjs

@@ -1,4 +1,7 @@
-export function split(str, delimiter) {
+/**
+ * @category native
+ * @category text
+ */ export function split(str, delimiter) {
     return str.split(delimiter);
 }
 export default split;

package/swapMap.d.ts

@@ -1,7 +1,7 @@
 /**
  * Swap object map key/value
  *
- * @category objects
+ * @category object
  */
 export declare function swapMap<T extends Record<string, string | number | symbol> = Record<string, string | number | symbol>>(map?: T): Record<T[keyof T], keyof T>;
 export default swapMap;

package/swapMap.mjs

@@ -1,12 +1,10 @@
 /**
  * Swap object map key/value
  *
- * @category objects
- */
-export function swapMap(map) {
-    if (map === void 0) { map = {}; }
-    var output = {};
-    for (var key in map) {
+ * @category object
+ */ export function swapMap(map = {}) {
+    const output = {};
+    for(const key in map){
         output[map[key]] = key;
     }
     return output;

package/throttle.d.ts

@@ -1,8 +1,9 @@
+/// <reference types="node" />
 /**
  * Throttle function (e.g. for resize / scroll handlers)
  *
  * @category function
- * @see https://github.com/Mobius1/Rangeable/
+ * @borrows [Mobius1/Rangeable](https://github.com/Mobius1/Rangeable/)
  */
 export declare function throttle<TFn extends Function, TContext>(fn: TFn, limit: number, context?: TContext): (this: TContext, ...args: any[]) => NodeJS.Timeout | undefined;
 export default throttle;

package/throttle.mjs

@@ -1,22 +1,16 @@
-import { __spreadArray } from "tslib";
 /**
  * Throttle function (e.g. for resize / scroll handlers)
  *
  * @category function
- * @see https://github.com/Mobius1/Rangeable/
- */
-export function throttle(fn, limit, context) {
-    var wait;
-    return function () {
-        var args = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            args[_i] = arguments[_i];
-        }
+ * @borrows [Mobius1/Rangeable](https://github.com/Mobius1/Rangeable/)
+ */ export function throttle(fn, limit, context) {
+    let wait;
+    return function(...args) {
         context = context || this;
         if (!wait) {
-            fn.apply.apply(fn, __spreadArray([context], args, false));
+            fn.apply(context, ...args);
             wait = true;
-            return setTimeout(function () {
+            return setTimeout(function() {
                 wait = false;
             }, limit);
         }

package/titleCase.d.ts

@@ -1,7 +1,8 @@
 /**
- * @category typography
- * @see https://github.com/blakeembrey/change-case/blob/master/packages/title-case/src/index.ts
- * @author Blake Embrey (hello@blakeembrey.com)
+ * @category text
+ *
+ * @borrows [blakeembrey/change-case](https://github.com/blakeembrey/change-case/blob/master/packages/title-case/src/index.ts)
+ * @license Blake Embrey (hello@blakeembrey.com)
  */
 export declare const titleCase: (input?: null | string) => string;
 export default titleCase;

package/titleCase.mjs

@@ -1,11 +1,7 @@
 /**
- * @category typography
- * @see https://github.com/blakeembrey/change-case/blob/master/packages/title-case/src/index.ts
- * @author Blake Embrey (hello@blakeembrey.com)
- */
-export var titleCase = function (input) {
-    return input
-        ? input.replace(/\w\S*/g, function (txt) { return txt.charAt(0).toUpperCase() + txt.substring(1).toLowerCase(); })
-        : "";
-};
+ * @category text
+ *
+ * @borrows [blakeembrey/change-case](https://github.com/blakeembrey/change-case/blob/master/packages/title-case/src/index.ts)
+ * @license Blake Embrey (hello@blakeembrey.com)
+ */ export const titleCase = (input)=>input ? input.replace(/\w\S*/g, (txt)=>txt.charAt(0).toUpperCase() + txt.substring(1).toLowerCase()) : "";
 export default titleCase;

package/toNumber.mjs

@@ -1,8 +1,7 @@
 import { isNumber } from "./isNumber";
 /**
  * @category cast
- */
-export function toNumber(input, fallback) {
+ */ export function toNumber(input, fallback) {
     return isNumber(input) ? input : input ? parseFloat(input) : fallback || 0;
 }
 export default toNumber;

package/toRgba.mjs

@@ -4,12 +4,10 @@
 //   hexRgb(hexColor, { format: "css", alpha });
 /**
  * @category colors
- */
-export function toRgba(hex, alpha) {
-    if (alpha === void 0) { alpha = 1; }
-    var r = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex);
+ */ export function toRgba(hex, alpha = 1) {
+    const r = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex);
     if (r) {
-        return "rgba(".concat(parseInt(r[1], 16), ",").concat(parseInt(r[2], 16), ",").concat(parseInt(r[3], 16), ",").concat(alpha, ")");
+        return `rgba(${parseInt(r[1], 16)},${parseInt(r[2], 16)},${parseInt(r[3], 16)},${alpha})`;
     }
     return "";
 }

package/transformToUrlPathname.mjs

@@ -7,10 +7,7 @@ import isString from "./isString";
  * - replaces whitespaces with dashes
  *
  * @category location
- */
-export function transformToUrlPathname(toPathname) {
-    return isString(toPathname)
-        ? "/".concat(encodeURIComponent(toPathname.replace(/\s/g, "-").toLowerCase()))
-        : "";
+ */ export function transformToUrlPathname(toPathname) {
+    return isString(toPathname) ? `/${encodeURIComponent(toPathname.replace(/\s/g, "-").toLowerCase())}` : "";
 }
 export default transformToUrlPathname;

package/truncate.d.ts

@@ -1,7 +1,7 @@
 /**
  * Truncate string
  *
- * @category typography
+ * @category text
  */
 export declare const truncate: (input: undefined | null | string, length: number) => string;
 export default truncate;

package/truncate.mjs

@@ -1,13 +1,6 @@
 /**
  * Truncate string
  *
- * @category typography
- */
-export var truncate = function (input, length) {
-    return input
-        ? input.length > length
-            ? input.substring(0, length) + "..."
-            : input
-        : "";
-};
+ * @category text
+ */ export const truncate = (input, length)=>input ? input.length > length ? input.substring(0, length) + "..." : input : "";
 export default truncate;

package/tryUntil.d.ts

@@ -1,5 +1,8 @@
 /**
- * @borrows [https://levelup.gitconnected.com/javascript-wait-until-something-happens-or-timeout-82636839ea93]
+ * @category function
+ * @category async
+ *
+ * @borrows [Javascript: Wait Until Something Happens or Timeout](https://levelup.gitconnected.com/javascript-wait-until-something-happens-or-timeout-82636839ea93)
  *
  * @param timeout in `ms`
  * @param interval in `ms`

package/tryUntil.mjs

@@ -1,27 +1,27 @@
 /**
- * @borrows [https://levelup.gitconnected.com/javascript-wait-until-something-happens-or-timeout-82636839ea93]
+ * @category function
+ * @category async
+ *
+ * @borrows [Javascript: Wait Until Something Happens or Timeout](https://levelup.gitconnected.com/javascript-wait-until-something-happens-or-timeout-82636839ea93)
  *
  * @param timeout in `ms`
  * @param interval in `ms`
- */
-export var tryUntil = function (test, timeout, interval, resolve, reject) {
+ */ export const tryUntil = (test, timeout, interval, resolve, reject)=>{
     // return new Promise((resolve, reject) => {
-    var timeWas = new Date();
-    var wait = setInterval(function () {
+    const timeWas = new Date();
+    const wait = setInterval(function() {
         if (test()) {
             // console.log("resolved after", new Date() - timeWas, "ms");
             clearInterval(wait);
             resolve();
-            // @ts-expect-error ...
-        }
-        else if (new Date() - timeWas > timeout) {
+        // @ts-expect-error ...
+        } else if (new Date() - timeWas > timeout) {
             // Timeout
             // console.log("rejected after", new Date() - timeWas, "ms");
             clearInterval(wait);
-            if (reject)
-                reject();
+            if (reject) reject();
         }
     }, interval);
-    // });
+// });
 };
 export default tryUntil;

package/types.mjs

@@ -1 +1,2 @@
-export {};
+// import type { Replace } from "@koine/utils";
+export { };

package/typings.d.ts

@@ -1,9 +1,4 @@
 /**
  * List here the global variables used by third party scripts supported within
- * the `koine` ecosystem. For instance Google Analytics globally available
- * variables.
+ * the `koine` ecosystem.
  */
-
-// declare type NullableRecord<T> = {
-//   [K in keyof T]: T[K] | null;
-// };

package/uid.mjs

@@ -1,12 +1,10 @@
-var lastId = 0;
+let lastId = 0;
 /**
  * Super basic UID increment-based generator
  *
  * @category uid
- */
-export var uid = function (prefix) {
-    if (prefix === void 0) { prefix = "id"; }
+ */ export const uid = (prefix = "id")=>{
     lastId++;
-    return "".concat(prefix, "-").concat(lastId);
+    return `${prefix}-${lastId}`;
 };
 export default uid;

package/updateLinkParams.mjs

@@ -5,9 +5,8 @@ import updateUrlQueryParams from "./updateUrlQueryParams";
  *
  * @category location
  * @pure
- */
-export function updateLinkParams($anchor, newParams) {
-    var href = updateUrlQueryParams($anchor.href, newParams);
+ */ export function updateLinkParams($anchor, newParams) {
+    const href = updateUrlQueryParams($anchor.href, newParams);
     $anchor.href = href;
     return href;
 }

package/updateUrlQueryParams.d.ts

@@ -3,7 +3,6 @@ import { type AnyQueryParams } from "./location";
  * Update a URL string query parameters merging the given new query parameters
  *
  * @category location
- * @pure
  */
 export declare function updateUrlQueryParams(url: string, newParams?: NonNullable<AnyQueryParams>): string;
 export default updateUrlQueryParams;

package/updateUrlQueryParams.mjs

@@ -5,14 +5,9 @@ import mergeUrlQueryParams from "./mergeUrlQueryParams";
  * Update a URL string query parameters merging the given new query parameters
  *
  * @category location
- * @pure
- */
-export function updateUrlQueryParams(url, newParams) {
-    if (newParams === void 0) { newParams = {}; }
-    var parts = url.split("?");
-    var allParams = parts[1]
-        ? mergeUrlQueryParams(getUrlQueryParams(url), newParams)
-        : newParams;
+ */ export function updateUrlQueryParams(url, newParams = {}) {
+    const parts = url.split("?");
+    const allParams = parts[1] ? mergeUrlQueryParams(getUrlQueryParams(url), newParams) : newParams;
     return parts[0] + buildUrlQueryString(allParams);
 }
 export default updateUrlQueryParams;

package/uppercase.d.ts

@@ -2,6 +2,7 @@
  * Replacement for native `toUpperCase` tyescript ready (type narrowing ready)
  *
  * @category native
+ * @category text
  */
 export declare const uppercase: <T extends string>(str?: T | null | undefined) => Uppercase<T>;
 export default uppercase;

package/uppercase.mjs

@@ -2,8 +2,6 @@
  * Replacement for native `toUpperCase` tyescript ready (type narrowing ready)
  *
  * @category native
- */
-export var uppercase = function (str) {
-    return (str || "").toUpperCase();
-};
+ * @category text
+ */ export const uppercase = (str)=>(str || "").toUpperCase();
 export default uppercase;

package/uuid.mjs

@@ -3,11 +3,8 @@
  *
  * @category uid
  * @see https://stackoverflow.com/a/2117523/1938970
- */
-export var uuid = function () {
-    return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function (c) {
-        var r = (Math.random() * 16) | 0, v = c == "x" ? r : (r & 0x3) | 0x8;
+ */ export const uuid = ()=>"xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (c)=>{
+        const r = Math.random() * 16 | 0, v = c == "x" ? r : r & 0x3 | 0x8;
         return v.toString(16);
     });
-};
 export default uuid;

package/uuidNumeric.mjs

@@ -1,6 +1,5 @@
 /**
  * @category uid
  * @see https://stackoverflow.com/a/18048162/1938970
- */
-export var uuidNumeric = function () { return new Date().valueOf(); };
+ */ export const uuidNumeric = ()=>new Date().valueOf();
 export default uuidNumeric;

package/wait.mjs

@@ -2,8 +2,5 @@
  * A promisified `setTimeout`
  *
  * @category async
- */
-export var wait = function (milliseconds) {
-    return new Promise(function (resolve) { return setTimeout(resolve, milliseconds); });
-};
+ */ export const wait = (milliseconds)=>new Promise((resolve)=>setTimeout(resolve, milliseconds));
 export default wait;

package/without.mjs

@@ -1,6 +1,4 @@
-"use strict";
-/* eslint-disable @typescript-eslint/no-unused-vars */
-// TODO: finish this up, this is not exported yet
+/* eslint-disable @typescript-eslint/no-unused-vars */ // TODO: finish this up, this is not exported yet
 // ready to copy-paste to https://www.typescriptlang.org/play
 // type EmptyObject = Record<string, never>;
 // type EmptyArray = never[];