@koine/utils 1.0.26 → 1.0.29

package/node/uid.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.uuid = exports.uid = void 0;
+exports.uid = void 0;
 var lastId = 0;
 /**
  * Super basic UID increment-based generator
+ *
+ * @category uid
  */
 var uid = function (prefix) {
     if (prefix === void 0) { prefix = "id"; }
@@ -11,15 +13,4 @@ var uid = function (prefix) {
     return "".concat(prefix, "-").concat(lastId);
 };
 exports.uid = uid;
-/**
- * Uuid, tiny custom helper instead of node's uuid/v4
- *
- * @see https://stackoverflow.com/a/2117523/1938970
- */
-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;
-        return v.toString(16);
-    });
-};
-exports.uuid = uuid;
+exports.default = exports.uid;

package/node/updateLinkParams.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateLinkParams = void 0;
+var updateUrlQueryParams_1 = require("./updateUrlQueryParams");
+/**
+ * Update link `<a href="">` merging the given new query parameters.
+ * it returns the newly created `href` URL value
+ *
+ * @category location
+ * @pure
+ */
+function updateLinkParams($anchor, newParams) {
+    var href = (0, updateUrlQueryParams_1.default)($anchor.href, newParams);
+    $anchor.href = href;
+    return href;
+}
+exports.updateLinkParams = updateLinkParams;
+exports.default = updateLinkParams;

package/node/updateUrlQueryParams.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateUrlQueryParams = void 0;
+var buildUrlQueryString_1 = require("./buildUrlQueryString");
+var getUrlQueryParams_1 = require("./getUrlQueryParams");
+var mergeUrlQueryParams_1 = require("./mergeUrlQueryParams");
+/**
+ * Update a URL string query parameters merging the given new query parameters
+ *
+ * @category location
+ * @pure
+ */
+function updateUrlQueryParams(url, newParams) {
+    if (newParams === void 0) { newParams = {}; }
+    var parts = url.split("?");
+    var allParams = parts[1]
+        ? (0, mergeUrlQueryParams_1.default)((0, getUrlQueryParams_1.default)(url), newParams)
+        : newParams;
+    return parts[0] + (0, buildUrlQueryString_1.default)(allParams);
+}
+exports.updateUrlQueryParams = updateUrlQueryParams;
+exports.default = updateUrlQueryParams;

package/node/uuid.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uuid = void 0;
+/**
+ * Uuid, tiny custom helper instead of node's uuid/v4
+ *
+ * @category uid
+ * @see https://stackoverflow.com/a/2117523/1938970
+ */
+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;
+        return v.toString(16);
+    });
+};
+exports.uuid = uuid;
+exports.default = exports.uuid;

package/node/wait.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wait = void 0;
+/**
+ * A promisified `setTimeout`
+ *
+ * @category async
+ */
+var wait = function (milliseconds) {
+    return new Promise(function (resolve) { return setTimeout(resolve, milliseconds); });
+};
+exports.wait = wait;
+exports.default = exports.wait;

package/node/whitelistObject.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.whitelistObject = void 0;
+/**
+ * Whitelist an object properties by selecting only the given keys, it returns a
+ * new object.
+ *
+ * @category objects
+ */
+function whitelistObject(object, keys) {
+    var output = {};
+    var len = keys.length;
+    while (len--) {
+        output[keys[len]] = object[keys[len]];
+    }
+    return output;
+}
+exports.whitelistObject = whitelistObject;
+exports.default = whitelistObject;

package/normaliseUrl.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Normalise URL (absolute URL)
+ *
+ * - replaces too many consecutive slashes (except `http{s}://`)
+ * - removes the trailing slash
+ *
+ * @category location
+ */
+export declare function normaliseUrl(absoluteUrl?: string): string;
+export default normaliseUrl;

package/normaliseUrl.js

@@ -0,0 +1,14 @@
+import removeTralingSlash from "./removeTrailingSlash";
+/**
+ * Normalise URL (absolute URL)
+ *
+ * - replaces too many consecutive slashes (except `http{s}://`)
+ * - removes the trailing slash
+ *
+ * @category location
+ */
+export function normaliseUrl(absoluteUrl) {
+    if (absoluteUrl === void 0) { absoluteUrl = ""; }
+    return removeTralingSlash(absoluteUrl.replace(/([^:]\/)\/+/g, "$1"));
+}
+export default normaliseUrl;

package/normaliseUrlPathname.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Normalise URL pathname (relative URL)
+ *
+ * - replaces too many consecutive slashes
+ * - removes the trailing slash
+ *
+ * @category location
+ */
+export declare function normaliseUrlPathname(pathname?: string): string;
+export default normaliseUrlPathname;

package/normaliseUrlPathname.js

@@ -0,0 +1,14 @@
+import removeTralingSlash from "./removeTrailingSlash";
+/**
+ * Normalise URL pathname (relative URL)
+ *
+ * - replaces too many consecutive slashes
+ * - removes the trailing slash
+ *
+ * @category location
+ */
+export function normaliseUrlPathname(pathname) {
+    if (pathname === void 0) { pathname = ""; }
+    return removeTralingSlash(pathname.replace(/\/+/g, "/"));
+}
+export default normaliseUrlPathname;

package/package.json

@@ -7,7 +7,7 @@
   "peerDependencies": {
     "tslib": "^2.4.0"
   },
-  "version": "1.0.26",
+  "version": "1.0.29",
   "module": "./index.js",
   "types": "./index.d.ts"
 }

package/{analytics-google.d.ts → pageview.d.ts}

@@ -3,4 +3,7 @@ export declare type GtmPageviewArgs = [
     page_title?: string,
     page_location?: string
 ];
+/**
+ * @category analytics-google
+ */
 export declare const pageview: (page_path?: string | undefined, page_title?: string | undefined, page_location?: string | undefined) => void;

package/{analytics-google.js → pageview.js}

@@ -1,18 +1,20 @@
-// import { isUndefined } from "./is";
+import isUndefined from "./isUndefined";
+/**
+ * @category analytics-google
+ */
 export var pageview = function () {
     var args = [];
     for (var _i = 0; _i < arguments.length; _i++) {
         args[_i] = arguments[_i];
     }
-    // FIXME: ambient types
-    // if (!isUndefined(window) && !isUndefined(window.gtag)) {
-    //   window.gtag("event", "page_view", {
-    //     page_path: args[0] || location.pathname,
-    //     page_title: args[1] || document.title,
-    //     page_location: args[2] || location.href,
-    //     // send_to: '<GA_MEASUREMENT_ID>'
-    //   });
-    // }
+    if (!isUndefined(window) && !isUndefined(window.gtag)) {
+        window.gtag("event", "page_view", {
+            page_path: args[0] || location.pathname,
+            page_title: args[1] || document.title,
+            page_location: args[2] || location.href,
+            // send_to: '<GA_MEASUREMENT_ID>'
+        });
+    }
 };
 // export type GtmEventArgs = [
 //   eventCategory?: string,

package/parseCookie.d.ts

@@ -0,0 +1,11 @@
+import { type CookieAttributesServer } from "./cookie";
+/**
+ * Parse a cookie header.
+ *
+ * Parse the given cookie header string into an object
+ * The object has the various cookies as keys(names) => values
+ *
+ * @category cookie
+ */
+export declare function parseCookie<T extends Record<string, unknown> = Record<string, string>>(str: string, attributes?: CookieAttributesServer): T;
+export default parseCookie;

package/parseCookie.js

@@ -0,0 +1,48 @@
+/**
+ * Try decoding a string using a decoding function.
+ */
+function tryDecode(str, decode) {
+    try {
+        return decode(str);
+    }
+    catch (e) {
+        return str;
+    }
+}
+/**
+ * Parse a cookie header.
+ *
+ * Parse the given cookie header string into an object
+ * The object has the various cookies as keys(names) => values
+ *
+ * @category cookie
+ */
+export function parseCookie(str, attributes) {
+    if (attributes === void 0) { attributes = {}; }
+    if (typeof str !== "string") {
+        throw new TypeError("argument str must be a string");
+    }
+    var obj = {};
+    var pairs = str.split(";");
+    var _a = attributes.decode, decode = _a === void 0 ? decodeURIComponent : _a;
+    for (var i = 0; i < pairs.length; i++) {
+        var pair = pairs[i];
+        var index = pair.indexOf("=");
+        // skip things that don't look like key=value
+        if (index < 0) {
+            continue;
+        }
+        var key = pair.substring(0, index).trim();
+        // only assign once
+        if (undefined == obj[key]) {
+            var val = pair.substring(index + 1, pair.length).trim();
+            // quoted values
+            if (val[0] === '"') {
+                val = val.slice(1, -1);
+            }
+            obj[key] = tryDecode(val, decode);
+        }
+    }
+    return obj;
+}
+export default parseCookie;

package/parseURL.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Solution without DOM or specific env native methods
+ *
+ * @category location
+ * @see https://stackoverflow.com/a/21553982/1938970
+ */
+export declare function parseURL(url: string): {
+    href: string;
+    protocol: string;
+    host: string;
+    hostname: string;
+    port: string;
+    pathname: string;
+    search: string;
+    hash: string;
+} | null;
+export default parseURL;

package/parseURL.js

@@ -0,0 +1,20 @@
+/**
+ * Solution without DOM or specific env native methods
+ *
+ * @category location
+ * @see https://stackoverflow.com/a/21553982/1938970
+ */
+export function parseURL(url) {
+    var match = url.match(/^(https?:)\/\/(([^:/?#]*)(?::([0-9]+))?)([/]{0,1}[^?#]*)(\?[^#]*|)(#.*|)$/);
+    return (match && {
+        href: url,
+        protocol: match[1],
+        host: match[2],
+        hostname: match[3],
+        port: match[4],
+        pathname: match[5],
+        search: match[6],
+        hash: match[7],
+    });
+}
+export default parseURL;

package/randomInt.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get random int (min and max included)
+ *
+ * @category math
+ */
+export declare function randomInt(min: number, max: number): number;
+export default randomInt;

package/randomInt.js

@@ -0,0 +1,9 @@
+/**
+ * Get random int (min and max included)
+ *
+ * @category math
+ */
+export function randomInt(min, max) {
+    return Math.floor(Math.random() * (max - min + 1) + min);
+}
+export default randomInt;

package/{misc.d.ts → randomKey.d.ts}

@@ -1,6 +1,8 @@
 /**
  * Get random key from given object
  *
+ * @category misc
  * @see https://stackoverflow.com/a/15106541/1938970
  */
 export declare function randomKey<T extends Record<string | number, unknown>>(obj: T): keyof T;
+export default randomKey;

package/{misc.js → randomKey.js}

@@ -1,9 +1,11 @@
 /**
  * Get random key from given object
  *
+ * @category misc
  * @see https://stackoverflow.com/a/15106541/1938970
  */
 export function randomKey(obj) {
     var keys = Object.keys(obj);
     return keys[(keys.length * Math.random()) << 0];
 }
+export default randomKey;

package/readCookie.d.ts

@@ -0,0 +1,3 @@
+export declare function readCookie<T extends Record<string, unknown> = Record<string, string>>(name?: null): T;
+export declare function readCookie<T extends Record<string, unknown> = Record<string, string>, N extends keyof T = keyof T>(name: N): T[N];
+export default readCookie;

package/readCookie.js

@@ -0,0 +1,34 @@
+function converterRead(value) {
+    if (value[0] === '"') {
+        value = value.slice(1, -1);
+    }
+    return value.replace(/(%[\dA-F]{2})+/gi, decodeURIComponent);
+}
+export function readCookie(name) {
+    if (typeof document === "undefined") {
+        if (process.env["NODE_ENV"] !== "production") {
+            console.warn("@koine/utils:cookie readCookie, document is undefined");
+        }
+        return name ? "" : {};
+    }
+    var cookies = document.cookie ? document.cookie.split("; ") : [];
+    var all = {};
+    for (var i = 0; i < cookies.length; i++) {
+        var parts = cookies[i].split("=");
+        var value = parts.slice(1).join("=");
+        try {
+            var found = decodeURIComponent(parts[0]);
+            all[found] = converterRead(value);
+            if (name === found) {
+                break;
+            }
+        }
+        catch (e) {
+            if (process.env["NODE_ENV"] !== "production") {
+                console.warn("@koine/utils:cookie readCookie, failed to decode", value);
+            }
+        }
+    }
+    return name ? all[name] : all;
+}
+export default readCookie;

package/redirectTo.d.ts

@@ -0,0 +1,9 @@
+import { type AnyQueryParams } from "./location";
+/**
+ * Redirect to url with params {optionally}, removes eventual trailing question
+ * marks from the given URL, it uses `location`
+ *
+ * @category location
+ */
+export declare function redirectTo(url: string, params?: AnyQueryParams): void;
+export default redirectTo;

package/redirectTo.js

@@ -0,0 +1,15 @@
+import buildUrlQueryString from "./buildUrlQueryString";
+import isBrowser from "./isBrowser";
+/**
+ * Redirect to url with params {optionally}, removes eventual trailing question
+ * marks from the given URL, it uses `location`
+ *
+ * @category location
+ */
+export function redirectTo(url, params) {
+    if (isBrowser) {
+        var queryString = buildUrlQueryString(params);
+        location.href = url.replace(/\?+$/g, "") + queryString;
+    }
+}
+export default redirectTo;

package/removeAccents.d.ts

@@ -0,0 +1,6 @@
+import { type AccentsSet } from "./accentSets";
+/**
+ * @category text
+ */
+export declare function removeAccents(text?: string, sets?: AccentsSet[]): string;
+export default removeAccents;

package/removeAccents.js

@@ -0,0 +1,15 @@
+import { accentsSets } from "./accentSets";
+/**
+ * @category text
+ */
+export function removeAccents(text, sets) {
+    if (text === void 0) { text = ""; }
+    if (sets === void 0) { sets = accentsSets; }
+    var len = sets.length;
+    while (len--) {
+        var _a = sets[len], to = _a[0], from = _a[1];
+        text = text.replace(new RegExp("[".concat(from, "]"), "gi"), to);
+    }
+    return text;
+}
+export default removeAccents;

package/removeCookie.d.ts

@@ -0,0 +1,10 @@
+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 removeCookie(name: string, attributes?: CookieAttributesClient): void;
+export default removeCookie;

package/removeCookie.js

@@ -0,0 +1,15 @@
+import { __assign } from "tslib";
+import { defaultAttributesClient } from "./cookie";
+import { setCookie } from "./setCookie";
+/**
+ * @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 removeCookie(name, attributes) {
+    if (attributes === void 0) { attributes = {}; }
+    setCookie(name, "", __assign(__assign(__assign({}, defaultAttributesClient), attributes), { expires: -1 }));
+}
+export default removeCookie;

package/removeDuplicatesByKey.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Remove duplicated array objects, equality is determined by a strict (`===`)
+ * comparison of each object's given key
+ *
+ * @category array
+ */
+export declare function removeDuplicatesByKey<T extends Record<string | number | symbol, any>>(array?: T[], key?: keyof T): T[];
+export default removeDuplicatesByKey;

package/removeDuplicatesByKey.js

@@ -0,0 +1,21 @@
+/**
+ * Remove duplicated array objects, equality is determined by a strict (`===`)
+ * comparison of each object's given key
+ *
+ * @category array
+ */
+export function removeDuplicatesByKey(array, key) {
+    if (array === void 0) { array = []; }
+    if (key === void 0) { key = ""; }
+    var keysMap = {};
+    var output = [];
+    for (var i = 0; i < array.length; i++) {
+        var item = array[i];
+        if (!keysMap[item[key]]) {
+            output.push(item);
+            keysMap[item[key]] = true;
+        }
+    }
+    return output;
+}
+export default removeDuplicatesByKey;

package/removeDuplicatesComparing.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @category array
+ */
+export declare function removeDuplicatesComparing<T>(from: any[], to: T[]): T[];
+export default removeDuplicatesComparing;

package/removeDuplicatesComparing.js

@@ -0,0 +1,10 @@
+import { removeIndexesFromArray } from "./removeIndexesFromArray";
+import { findDuplicatedIndexes } from "./findDuplicatedIndexes";
+/**
+ * @category array
+ */
+export function removeDuplicatesComparing(from, to) {
+    var indexes = findDuplicatedIndexes(from);
+    return removeIndexesFromArray(to, indexes);
+}
+export default removeDuplicatesComparing;

package/removeIndexesFromArray.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @category array
+ */
+export declare function removeIndexesFromArray<T>(arr: T[], indexes: Record<number, true>): T[];
+export default removeIndexesFromArray;

package/removeIndexesFromArray.js

@@ -0,0 +1,14 @@
+/**
+ * @category array
+ */
+export function removeIndexesFromArray(arr, indexes) {
+    var output = [];
+    for (var i = 0; i < arr.length; i++) {
+        // eslint-disable-next-line no-prototype-builtins
+        if (!indexes.hasOwnProperty(i)) {
+            output.push(arr[i]);
+        }
+    }
+    return output;
+}
+export default removeIndexesFromArray;

package/removeTrailingSlash.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Strips out the trailing slash
+ *
+ * @category location
+ */
+export declare function removeTralingSlash(urlLike?: string): string;
+export default removeTralingSlash;

package/removeTrailingSlash.js

@@ -0,0 +1,10 @@
+/**
+ * Strips out the trailing slash
+ *
+ * @category location
+ */
+export function removeTralingSlash(urlLike) {
+    if (urlLike === void 0) { urlLike = ""; }
+    return urlLike.replace(/\/*$/, "");
+}
+export default removeTralingSlash;

package/roundTo.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Round to given number of the given number of decimals
+ *
+ * @category math
+ * @see https://stackoverflow.com/a/15762794/1938970
+ */
+export declare function roundTo(num: number, decimals?: number): string;
+export default roundTo;

package/{math.js → roundTo.js}

@@ -1,20 +1,7 @@
-/**
- * Get random int (min and max included)
- */
-export function randomInt(min, max) {
-    return Math.floor(Math.random() * (max - min + 1) + min);
-}
-/**
- * Returns a number whose value is limited to the given range.
- *
- * @see https://stackoverflow.com/a/11409944/1938970
- */
-export function clamp(num, min, max) {
-    return Math.min(Math.max(num, min), max);
-}
 /**
  * Round to given number of the given number of decimals
  *
+ * @category math
  * @see https://stackoverflow.com/a/15762794/1938970
  */
 export function roundTo(num, decimals) {
@@ -44,17 +31,4 @@ export function roundTo(num, decimals) {
     }
     return "";
 }
-/**
- * Convert range of a number
- *
- * e.g. converting number 5 in a scale/range from 0 10 to a scale/range from 50
- * to 100 would return 75
- * ```
- * convertRange(5, [0, 10], [50, 100]);
- * ```
- *
- * @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 default roundTo;