@koine/utils 1.0.26 → 1.0.29

package/location.d.ts

@@ -1,147 +1,4 @@
-export declare type AnyQueryParams = undefined | null | Record<string | number, unknown>;
-/**
- * Solution without DOM or specific env native methods
- *
- * @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;
-/**
- * Strips out the trailing slash
- */
-export declare function removeTralingSlash(urlLike?: string): string;
-/**
- * Normalise URL (absolute URL)
- *
- * - replaces too many consecutive slashes (except `http{s}://`)
- * - removes the trailing slash
- */
-export declare function normaliseUrl(absoluteUrl?: string): string;
-/**
- * Normalise URL pathname (relative URL)
- *
- * - replaces too many consecutive slashes
- * - removes the trailing slash
- */
-export declare function normaliseUrlPathname(pathname?: string): string;
-/**
- * Transform string in a URL pathname (relative URL)
- *
- * - adds an initial slash
- * - encode the string
- * - replaces whitespaces with dashes
- */
-export declare function transformToUrlPathname(toPathname?: string): string;
-/**
- * Get parsed query parameters as object dictionary (from URL or given query string)
- *
- * @param url A URL which contains a  `?`, e.g. `?myparam=x` or `https://a.com?myparams=x`.
- *                    If not provided it defaults reading the current URL query string with
- *                    `location.search`. Through this argument you can use this
- *                    same function to parse, for instance, the query params of
- *                    the `href` of a `<a href="...">` HTML tag.
- *
- */
-export declare function getUrlQueryParams<T extends NonNullable<AnyQueryParams>>(url?: string): T;
-/**
- * Get pathname parts
- *
- * First clean the pathname from the first slash if any then split the pathname
- * in parts,
- * Given a pathname like: `"/en/{prefix}/{collection}/{slug}"` we obtain
- * `[locale, prefix, collection, slug]`
- */
-export declare function getUrlPathnameParts(pathname?: string): string[];
-/**
- * Get clean query string for URL
- *
- * It returns the query string **with** the initial `?`
- *
- * TODO: at some point replace with `URLSearchParams`, @see [caniuse](https://caniuse.com/?search=URLSearchParams)
- */
-export declare function buildUrlQueryString(params?: AnyQueryParams): string;
-/**
- * Change URL path, ensures initial and ending slashes and normalise eventual
- * consecutive slashes, it uses `history`.
- *
- * @param replace Replace URL instead of pushing it in the history stack. By default it pushes it.
- * @returns {string} The new cleaned pathname
- */
-export declare function changeUrlPath(pathname: string, state?: object, replace?: boolean): string;
-/**
- * Change current URL query parameters, it uses `history`.
- *
- * @param replace Replace URL instead of pushing it in the history stack. By default it pushes it.
- * @returns The query string with initial `?`
- */
-export declare function navigateToParams(params?: string | AnyQueryParams, replace?: boolean): string;
 /**
- * Merge current URL query parameters with the given ones, it uses `history`.
- *
- * @param replace Replace URL instead of pushing it in the history stack. By default it pushes it.
+ * @category location
  */
-export declare function navigateToMergedParams(params?: NonNullable<AnyQueryParams>, replace?: boolean): string;
-/**
- * Remove URL query parameter, it uses `history`
- *
- * @param replace Replace URL instead of pushing it in the history stack. By default it pushes it.
- */
-export declare function navigateWithoutUrlParam(paramName?: string, replace?: boolean): string;
-/**
- * Merge query parameters objects, it *mutates* the first given object argument
- *
- * @pure
- */
-export declare function mergeUrlQueryParams<T extends AnyQueryParams>(oldParams?: NonNullable<AnyQueryParams>, newParams?: NonNullable<AnyQueryParams>): T;
-/**
- * Update a URL string query parameters merging the given new query parameters
- *
- * @pure
- */
-export declare function updateUrlQueryParams(url: string, newParams?: NonNullable<AnyQueryParams>): string;
-/**
- * Update link `<a href="">` merging the given new query parameters.
- * it returns the newly created `href` URL value
- *
- * @pure
- */
-export declare function updateLinkParams($anchor: HTMLAnchorElement, newParams: NonNullable<AnyQueryParams>): string;
-/**
- * Redirect to url with params {optionally}, removes eventual trailing question
- * marks from the given URL, it uses `location`
- */
-export declare function redirectTo(url: string, params?: AnyQueryParams): void;
-/**
- * Is external url compared to the given current URL (if not provided it falls
- * back to `location.href`)
- *
- */
-export declare function isExternalUrl(url: string, currentUrl?: string): boolean;
-/**
- * It updates the `location.hash` with the given query params, it uses `location.hash`
- * if a second argument `hash` is not provded
- */
-export declare function navigateToHashParams(params?: string | AnyQueryParams, hash?: string): string;
-/**
- * It updates the "query params" within the `location.hash`, it uses `location`
- */
-export declare function navigateToMergedHashParams(params?: NonNullable<AnyQueryParams>, hash?: string): string;
-/**
- * It returns the "query params" as an object extracting it from the given `hash`
- *string or, if not provided, failling back reading the `location.hash`
- */
-export declare function getUrlHashParams<T extends NonNullable<AnyQueryParams>>(hash?: string): T;
-/**
- * It returns the "pathname" cleaned up from the `#` and the initial slashes
- *  extracting it from the given `hash` string or, if not provided, failling
- * back reading the `location.hash`
- */
-export declare function getUrlHashPathname(hash?: string): string;
+export declare type AnyQueryParams = undefined | null | Record<string | number, unknown>;

package/location.js

@@ -1,299 +1 @@
-import { isBrowser } from "./ssr";
-import { isString, isNull, isUndefined } from "./is";
-/**
- * Solution without DOM or specific env native methods
- *
- * @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],
-    });
-}
-/**
- * Strips out the trailing slash
- */
-export function removeTralingSlash(urlLike) {
-    if (urlLike === void 0) { urlLike = ""; }
-    return urlLike.replace(/\/*$/, "");
-}
-/**
- * Normalise URL (absolute URL)
- *
- * - replaces too many consecutive slashes (except `http{s}://`)
- * - removes the trailing slash
- */
-export function normaliseUrl(absoluteUrl) {
-    if (absoluteUrl === void 0) { absoluteUrl = ""; }
-    return removeTralingSlash(absoluteUrl.replace(/([^:]\/)\/+/g, "$1"));
-}
-/**
- * Normalise URL pathname (relative URL)
- *
- * - replaces too many consecutive slashes
- * - removes the trailing slash
- */
-export function normaliseUrlPathname(pathname) {
-    if (pathname === void 0) { pathname = ""; }
-    return removeTralingSlash(pathname.replace(/\/+/g, "/"));
-}
-/**
- * Transform string in a URL pathname (relative URL)
- *
- * - adds an initial slash
- * - encode the string
- * - replaces whitespaces with dashes
- */
-export function transformToUrlPathname(toPathname) {
-    return isString(toPathname)
-        ? "/".concat(encodeURIComponent(toPathname.replace(/\s/g, "-").toLowerCase()))
-        : "";
-}
-/**
- * Get parsed query parameters as object dictionary (from URL or given query string)
- *
- * @param url A URL which contains a  `?`, e.g. `?myparam=x` or `https://a.com?myparams=x`.
- *                    If not provided it defaults reading the current URL query string with
- *                    `location.search`. Through this argument you can use this
- *                    same function to parse, for instance, the query params of
- *                    the `href` of a `<a href="...">` HTML tag.
- *
- */
-export function getUrlQueryParams(url) {
-    var _a;
-    var params = {};
-    var search = url
-        ? (_a = url.split("?")) === null || _a === void 0 ? void 0 : _a[1]
-        : isBrowser
-            ? location.search.substring(1)
-            : "";
-    if (!search) {
-        return {};
-    }
-    try {
-        // @see https://stackoverflow.com/a/8649003/1938970
-        var paramsAsObj = "{\"".concat(search
-            .replace(/&/g, '","')
-            .replace(/=/g, '":"'), "\"}");
-        params = JSON.parse(paramsAsObj, function (key, value) {
-            return key === "" ? value : decodeURIComponent(value);
-        });
-    }
-    catch (e) {
-        // do nothing or warn on process.env["NODE_ENV"] !== "production"
-    }
-    return params;
-}
-/**
- * Get pathname parts
- *
- * First clean the pathname from the first slash if any then split the pathname
- * in parts,
- * Given a pathname like: `"/en/{prefix}/{collection}/{slug}"` we obtain
- * `[locale, prefix, collection, slug]`
- */
-export function getUrlPathnameParts(pathname) {
-    if (pathname === void 0) { pathname = ""; }
-    pathname = pathname || isBrowser ? location.pathname : "";
-    return pathname
-        .replace(/^\//, "")
-        .split("/")
-        .filter(function (part) { return part; });
-}
-/**
- * Get clean query string for URL
- *
- * It returns the query string **with** the initial `?`
- *
- * TODO: at some point replace with `URLSearchParams`, @see [caniuse](https://caniuse.com/?search=URLSearchParams)
- */
-export function buildUrlQueryString(params) {
-    if (params === void 0) { params = {}; }
-    var output = "";
-    for (var key in params) {
-        var value = params[key];
-        if (!isNull(value) && !isUndefined(value)) {
-            output += "".concat(key, "=").concat(encodeURIComponent(value + ""), "&");
-        }
-    }
-    // removes the last &
-    return output ? "?".concat(output.replace(/&+$/, "")) : "";
-}
-/**
- * Change URL path, ensures initial and ending slashes and normalise eventual
- * consecutive slashes, it uses `history`.
- *
- * @param replace Replace URL instead of pushing it in the history stack. By default it pushes it.
- * @returns {string} The new cleaned pathname
- */
-export function changeUrlPath(pathname, state, replace) {
-    var path = normaliseUrlPathname("/".concat(pathname, "/"));
-    if (isBrowser) {
-        history[replace ? "replaceState" : "pushState"](state, "", path);
-    }
-    return path;
-}
-/**
- * Change current URL query parameters, it uses `history`.
- *
- * @param replace Replace URL instead of pushing it in the history stack. By default it pushes it.
- * @returns The query string with initial `?`
- */
-export function navigateToParams(params, replace) {
-    if (params === void 0) { params = {}; }
-    var queryString = typeof params === "string" ? params : buildUrlQueryString(params);
-    if (isBrowser) {
-        history[replace ? "replaceState" : "pushState"](null, "", location.pathname + queryString);
-    }
-    return queryString;
-}
-/**
- * Merge current URL query parameters with the given ones, it uses `history`.
- *
- * @param replace Replace URL instead of pushing it in the history stack. By default it pushes it.
- */
-export function navigateToMergedParams(params, replace) {
-    if (params === void 0) { params = {}; }
-    return navigateToParams(mergeUrlQueryParams(getUrlQueryParams(), params), replace);
-}
-/**
- * Remove URL query parameter, it uses `history`
- *
- * @param replace Replace URL instead of pushing it in the history stack. By default it pushes it.
- */
-export function navigateWithoutUrlParam(paramName, replace) {
-    var params = {};
-    var currentParams = getUrlQueryParams();
-    for (var key in currentParams) {
-        if (key !== paramName) {
-            params[key] = currentParams[key];
-        }
-    }
-    return navigateToParams(params, replace);
-}
-/**
- * Merge query parameters objects, it *mutates* the first given object argument
- *
- * @pure
- */
-export function mergeUrlQueryParams(oldParams, newParams) {
-    if (oldParams === void 0) { oldParams = {}; }
-    if (newParams === void 0) { newParams = {}; }
-    for (var key in newParams) {
-        var value = newParams[key];
-        if (oldParams[key] && isNull(value)) {
-            delete oldParams[key];
-        }
-        else {
-            oldParams[key] = value;
-        }
-    }
-    return oldParams;
-}
-/**
- * Update a URL string query parameters merging the given new query parameters
- *
- * @pure
- */
-export function updateUrlQueryParams(url, newParams) {
-    if (newParams === void 0) { newParams = {}; }
-    var parts = url.split("?");
-    var allParams = parts[1]
-        ? mergeUrlQueryParams(getUrlQueryParams(url), newParams)
-        : newParams;
-    return parts[0] + buildUrlQueryString(allParams);
-}
-/**
- * Update link `<a href="">` merging the given new query parameters.
- * it returns the newly created `href` URL value
- *
- * @pure
- */
-export function updateLinkParams($anchor, newParams) {
-    var href = updateUrlQueryParams($anchor.href, newParams);
-    $anchor.href = href;
-    return href;
-}
-/**
- * Redirect to url with params {optionally}, removes eventual trailing question
- * marks from the given URL, it uses `location`
- */
-export function redirectTo(url, params) {
-    if (isBrowser) {
-        var queryString = buildUrlQueryString(params);
-        location.href = url.replace(/\?+$/g, "") + queryString;
-    }
-}
-/**
- * Is external url compared to the given current URL (if not provided it falls
- * back to `location.href`)
- *
- */
-export function isExternalUrl(url, currentUrl) {
-    var _a;
-    var reg = /https?:\/\/((?:[\w\d-]+\.)+[\w\d]{2,})/i;
-    var urlMatches = reg.exec(url);
-    // if no matches are found it means we either have an invalid URL, a relative
-    // URL or a hash link, and those are not considered externals
-    if (!urlMatches) {
-        return false;
-    }
-    currentUrl = currentUrl || isBrowser ? location.href : "";
-    return currentUrl ? ((_a = reg.exec(currentUrl)) === null || _a === void 0 ? void 0 : _a[1]) !== urlMatches[1] : true;
-}
-/**
- * It updates the `location.hash` with the given query params, it uses `location.hash`
- * if a second argument `hash` is not provded
- */
-export function navigateToHashParams(params, hash) {
-    if (params === void 0) { params = {}; }
-    if (hash === void 0) { hash = ""; }
-    var useLocation = !hash;
-    hash = hash || location.hash;
-    var hashQueryLess = getUrlHashPathname(hash);
-    var queryString = typeof params === "string" ? params : buildUrlQueryString(params);
-    var newHash = "#/" + hashQueryLess + queryString;
-    if (useLocation) {
-        location.hash = newHash;
-    }
-    return newHash;
-}
-/**
- * It updates the "query params" within the `location.hash`, it uses `location`
- */
-export function navigateToMergedHashParams(params, hash) {
-    if (params === void 0) { params = {}; }
-    if (hash === void 0) { hash = ""; }
-    return navigateToHashParams(mergeUrlQueryParams(getUrlHashParams(hash), params), hash);
-}
-/**
- * It returns the "query params" as an object extracting it from the given `hash`
- *string or, if not provided, failling back reading the `location.hash`
- */
-export function getUrlHashParams(hash) {
-    if (hash === void 0) { hash = ""; }
-    hash = hash || location.hash;
-    var hashParts = hash.split("?");
-    if (hashParts.length >= 1) {
-        return Object.fromEntries(new URLSearchParams(hashParts[1]));
-    }
-    return {};
-}
-/**
- * It returns the "pathname" cleaned up from the `#` and the initial slashes
- *  extracting it from the given `hash` string or, if not provided, failling
- * back reading the `location.hash`
- */
-export function getUrlHashPathname(hash) {
-    if (hash === void 0) { hash = ""; }
-    hash = hash || location.hash;
-    return hash.split("?")[0].replace(/^#\//, "");
-}
+export {};

package/mapListBy.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Maps an array of objects into a map keyed with the given key
+ *
+ * @category array
+ */
+export declare function mapListBy<T extends Record<string | number | symbol, any>>(array?: T[], key?: keyof T): Record<T[keyof T], T>;
+export default mapListBy;

package/mapListBy.js

@@ -0,0 +1,14 @@
+/**
+ * Maps an array of objects into a map keyed with the given key
+ *
+ * @category array
+ */
+export function mapListBy(array, key) {
+    if (array === void 0) { array = []; }
+    if (key === void 0) { key = ""; }
+    return array.reduce(function (obj, item) {
+        obj[item[key]] = item;
+        return obj;
+    }, {});
+}
+export default mapListBy;

package/{match-sorter.d.ts → matchSorter.d.ts}

@@ -58,3 +58,4 @@ declare const defaultBaseSortFn: BaseSorter<unknown>;
 declare function matchSorter<ItemType = string>(items: ReadonlyArray<ItemType>, value: string, options?: MatchSorterOptions<ItemType>): Array<ItemType>;
 export { matchSorter, defaultBaseSortFn };
 export type { MatchSorterOptions, KeyAttributesOptions, KeyOption, KeyAttributes, RankingInfo, ValueGetterKey, };
+export default matchSorter;

package/{match-sorter.js → matchSorter.js}

@@ -15,7 +15,7 @@ import { __assign } from "tslib";
  * @copyright (c) 2020 Kent C. Dodds
  * @author Kent C. Dodds <me@kentcdodds.com> (https://kentcdodds.com)
  */
-import { removeAccents } from "./text";
+import removeAccents from "./removeAccents";
 var RANKING_CASE_SENSITIVE_EQUAL = 7;
 var RANKING_EQUAL = 6;
 var RANKING_STARTS_WITH = 5;
@@ -367,3 +367,4 @@ function getKeyAttributes(key) {
     return __assign(__assign({}, defaultKeyAttributes), key);
 }
 export { matchSorter, defaultBaseSortFn };
+export default matchSorter;

package/mergeObjects.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Merge two or more objects together. It mutates the target object.
+ *
+ * @category objects
+ * @see https://stackoverflow.com/a/46973278/1938970
+ */
+export declare const mergeObjects: <T extends object = object>(target: T, ...sources: T[]) => T;

package/{objects.js → mergeObjects.js}

@@ -1,15 +1,9 @@
 import { __spreadArray } from "tslib";
-import { isObject } from "./is";
-/**
- * Type safe replacement for `Object.keys(myObject)` to iterate over a record
- * without loosing the key's types in simple `string`s.
- *
- * @see https://stackoverflow.com/a/59459000/1938970
- */
-export var getKeys = Object.keys;
+import { isObject } from "./isObject";
 /**
  * Merge two or more objects together. It mutates the target object.
  *
+ * @category objects
  * @see https://stackoverflow.com/a/46973278/1938970
  */
 export var mergeObjects = function (target) {
@@ -41,26 +35,3 @@ export var mergeObjects = function (target) {
     }
     return mergeObjects.apply(void 0, __spreadArray([target], sources, false));
 };
-/**
- * Swap object map key/value
- */
-export function swapMap(map) {
-    if (map === void 0) { map = {}; }
-    var output = {};
-    for (var key in map) {
-        output[map[key]] = key;
-    }
-    return output;
-}
-/**
- * Whitelist an object properties by selecting only the given keys, it returns a
- * new object.
- */
-export function whitelistObject(object, keys) {
-    var output = {};
-    var len = keys.length;
-    while (len--) {
-        output[keys[len]] = object[keys[len]];
-    }
-    return output;
-}

package/mergeUrlQueryParams.d.ts

@@ -0,0 +1,9 @@
+import { type AnyQueryParams } from "./location";
+/**
+ * Merge query parameters objects, it *mutates* the first given object argument
+ *
+ * @category location
+ * @pure
+ */
+export declare function mergeUrlQueryParams<T extends AnyQueryParams>(oldParams?: NonNullable<AnyQueryParams>, newParams?: NonNullable<AnyQueryParams>): T;
+export default mergeUrlQueryParams;

package/mergeUrlQueryParams.js

@@ -0,0 +1,22 @@
+import isNull from "./isNull";
+/**
+ * Merge query parameters objects, it *mutates* the first given object argument
+ *
+ * @category location
+ * @pure
+ */
+export function mergeUrlQueryParams(oldParams, newParams) {
+    if (oldParams === void 0) { oldParams = {}; }
+    if (newParams === void 0) { newParams = {}; }
+    for (var key in newParams) {
+        var value = newParams[key];
+        if (oldParams[key] && isNull(value)) {
+            delete oldParams[key];
+        }
+        else {
+            oldParams[key] = value;
+        }
+    }
+    return oldParams;
+}
+export default mergeUrlQueryParams;

package/navigateToHashParams.d.ts

@@ -0,0 +1,9 @@
+import { type AnyQueryParams } from "./location";
+/**
+ * It updates the `location.hash` with the given query params, it uses `location.hash`
+ * if a second argument `hash` is not provded
+ *
+ * @category location
+ */
+export declare function navigateToHashParams(params?: string | AnyQueryParams, hash?: string): string;
+export default navigateToHashParams;

package/navigateToHashParams.js

@@ -0,0 +1,22 @@
+import buildUrlQueryString from "./buildUrlQueryString";
+import getUrlHashPathname from "./getUrlHashPathname";
+/**
+ * It updates the `location.hash` with the given query params, it uses `location.hash`
+ * if a second argument `hash` is not provded
+ *
+ * @category location
+ */
+export function navigateToHashParams(params, hash) {
+    if (params === void 0) { params = {}; }
+    if (hash === void 0) { hash = ""; }
+    var useLocation = !hash;
+    hash = hash || location.hash;
+    var hashQueryLess = getUrlHashPathname(hash);
+    var queryString = typeof params === "string" ? params : buildUrlQueryString(params);
+    var newHash = "#/" + hashQueryLess + queryString;
+    if (useLocation) {
+        location.hash = newHash;
+    }
+    return newHash;
+}
+export default navigateToHashParams;

package/navigateToMergedHashParams.d.ts

@@ -0,0 +1,8 @@
+import { type AnyQueryParams } from "./location";
+/**
+ * It updates the "query params" within the `location.hash`, it uses `location`
+ *
+ * @category location
+ */
+export declare function navigateToMergedHashParams(params?: NonNullable<AnyQueryParams>, hash?: string): string;
+export default navigateToMergedHashParams;

package/navigateToMergedHashParams.js

@@ -0,0 +1,14 @@
+import getUrlHashParams from "./getUrlHashParams";
+import mergeUrlQueryParams from "./mergeUrlQueryParams";
+import navigateToHashParams from "./navigateToHashParams";
+/**
+ * It updates the "query params" within the `location.hash`, it uses `location`
+ *
+ * @category location
+ */
+export function navigateToMergedHashParams(params, hash) {
+    if (params === void 0) { params = {}; }
+    if (hash === void 0) { hash = ""; }
+    return navigateToHashParams(mergeUrlQueryParams(getUrlHashParams(hash), params), hash);
+}
+export default navigateToMergedHashParams;

package/navigateToMergedParams.d.ts

@@ -0,0 +1,9 @@
+import { type AnyQueryParams } from "./location";
+/**
+ * Merge current URL query parameters with the given ones, it uses `history`.
+ *
+ * @category location
+ * @param replace Replace URL instead of pushing it in the history stack. By default it pushes it.
+ */
+export declare function navigateToMergedParams(params?: NonNullable<AnyQueryParams>, replace?: boolean): string;
+export default navigateToMergedParams;

package/navigateToMergedParams.js

@@ -0,0 +1,14 @@
+import getUrlQueryParams from "./getUrlQueryParams";
+import mergeUrlQueryParams from "./mergeUrlQueryParams";
+import navigateToParams from "./navigateToParams";
+/**
+ * Merge current URL query parameters with the given ones, it uses `history`.
+ *
+ * @category location
+ * @param replace Replace URL instead of pushing it in the history stack. By default it pushes it.
+ */
+export function navigateToMergedParams(params, replace) {
+    if (params === void 0) { params = {}; }
+    return navigateToParams(mergeUrlQueryParams(getUrlQueryParams(), params), replace);
+}
+export default navigateToMergedParams;

package/navigateToParams.d.ts

@@ -0,0 +1,10 @@
+import { type AnyQueryParams } from "./location";
+/**
+ * Change current URL query parameters, it uses `history`.
+ *
+ * @category location
+ * @param replace Replace URL instead of pushing it in the history stack. By default it pushes it.
+ * @returns The query string with initial `?`
+ */
+export declare function navigateToParams(params?: string | AnyQueryParams, replace?: boolean): string;
+export default navigateToParams;