@koine/browser 1.0.88

package/README.md

@@ -0,0 +1 @@
+# @koine/browser

package/createStorage.d.ts

@@ -0,0 +1,53 @@
+export declare type CreateStorageConfig = Record<string, any>;
+/**
+ * Utility to create a storage instance to interact with `localStorage` using
+ * encrypted (encoded) key/values.
+ */
+export declare const createStorage: <T extends CreateStorageConfig>(config: Partial<T>) => {
+    /**
+     * Get all storage value (it uses `localStorage.get()`).
+     *
+     * Unparseable values with `JSON.parse()` return their value as it is.
+     * If the given `key` argument is not found `null` is returned.
+     */
+    get<TKey extends keyof T>(key: TKey): T[TKey] | null;
+    /**
+     * Get all storage values (it uses `localStorage.get()`).
+     *
+     * `undefined` and `null` values are not returned.
+     */
+    getAll(): T;
+    /**
+     * Set a storage value (it uses `localStorage.set()`).
+     *
+     * Non-string values are stringified with `JSON.stringify()`
+     */
+    set<TKey_1 extends keyof T>(key: TKey_1, value: T[TKey_1]): void;
+    /**
+     * Set all given storage values (it uses `localStorage.set()`).
+     *
+     * Non-string values are stringified with `JSON.stringify()`, `undefined`
+     * and `null` values are removed from the storage
+     */
+    setMany(newValues: Partial<T>): void;
+    /**
+     * Check if a storage value is _truthy_ (it uses `localStorage.get()`).
+     */
+    has<TKey_2 extends keyof T>(key: TKey_2): boolean;
+    /**
+     * Remove a storage value (it uses `localStorage.remove()`).
+     */
+    remove<TKey_3 extends keyof T>(key: TKey_3): void;
+    /**
+     * Clear all storage values (it uses `localStorage.remove()`).
+     */
+    clear(): void;
+    /**
+     * Watch a storage value changes, this needs to be executed only in browser
+     * context (it uses `window.addEventListener("storage")`).
+     *
+     * Inspiration from [Multi Tab Logout in React — Redux](https://medium.com/front-end-weekly/multi-tab-logout-in-react-redux-4715f071c7fa)
+     */
+    watch: <TKey_4 extends keyof T>(keyToWatch: TKey_4, onRemoved?: () => void, onAdded?: () => void) => (() => void) | undefined;
+};
+export default createStorage;

package/createStorage.js

@@ -0,0 +1,132 @@
+import { __assign } from "tslib";
+import { decode, encode, isBrowser, isNullOrUndefined, isString, } from "@koine/utils";
+import { on } from "@koine/dom";
+/**
+ * Utility to create a storage instance to interact with `localStorage` using
+ * encrypted (encoded) key/values.
+ */
+export var createStorage = function (config) {
+    var methodsMap = { g: "getItem", s: "setItem", r: "removeItem" };
+    /**
+     * Super minifiable localStorage wrapper with SSR safety
+     */
+    var ls = function (method, key, value) {
+        return isBrowser
+            ? localStorage[methodsMap[method]](key, value)
+            : function () {
+                if (process.env["NODE_ENV"] !== "production") {
+                    console.warn("[@koine/utils] createStorage: localStorage does not exists in this environment.");
+                }
+            };
+    };
+    var keys = Object.keys(config).reduce(function (map, key) {
+        var _a;
+        return (__assign(__assign({}, map), (_a = {}, _a[key] = encode(key), _a)));
+    }, {});
+    return {
+        /**
+         * Get all storage value (it uses `localStorage.get()`).
+         *
+         * Unparseable values with `JSON.parse()` return their value as it is.
+         * If the given `key` argument is not found `null` is returned.
+         */
+        get: function (key) {
+            var stored = ls("g", keys[key]);
+            if (stored) {
+                stored = decode(stored);
+                try {
+                    return JSON.parse(stored);
+                }
+                catch (_e) {
+                    return stored;
+                }
+            }
+            return null;
+        },
+        /**
+         * Get all storage values (it uses `localStorage.get()`).
+         *
+         * `undefined` and `null` values are not returned.
+         */
+        getAll: function () {
+            var all = {};
+            for (var key in keys) {
+                var value = this.get(key);
+                if (!isNullOrUndefined(value)) {
+                    all[key] = value;
+                }
+            }
+            return all;
+        },
+        /**
+         * Set a storage value (it uses `localStorage.set()`).
+         *
+         * Non-string values are stringified with `JSON.stringify()`
+         */
+        set: function (key, value) {
+            ls("s", keys[key], isString(value) ? encode(value) : encode(JSON.stringify(value)));
+        },
+        /**
+         * Set all given storage values (it uses `localStorage.set()`).
+         *
+         * Non-string values are stringified with `JSON.stringify()`, `undefined`
+         * and `null` values are removed from the storage
+         */
+        setMany: function (newValues) {
+            for (var key in newValues) {
+                var value = newValues[key];
+                if (!isNullOrUndefined(value)) {
+                    this.set(key, value);
+                }
+                else {
+                    this.remove(key);
+                }
+            }
+        },
+        /**
+         * Check if a storage value is _truthy_ (it uses `localStorage.get()`).
+         */
+        has: function (key) {
+            var stored = ls("g", keys[key]);
+            return !!stored;
+        },
+        /**
+         * Remove a storage value (it uses `localStorage.remove()`).
+         */
+        remove: function (key) {
+            ls("r", keys[key]);
+        },
+        /**
+         * Clear all storage values (it uses `localStorage.remove()`).
+         */
+        clear: function () {
+            for (var key in keys) {
+                ls("r", keys[key]);
+            }
+        },
+        /**
+         * Watch a storage value changes, this needs to be executed only in browser
+         * context (it uses `window.addEventListener("storage")`).
+         *
+         * Inspiration from [Multi Tab Logout in React — Redux](https://medium.com/front-end-weekly/multi-tab-logout-in-react-redux-4715f071c7fa)
+         */
+        watch: function (keyToWatch, onRemoved, onAdded) {
+            var handler = function (event) {
+                var key = event.key, oldValue = event.oldValue, newValue = event.newValue;
+                if (key === keys[keyToWatch]) {
+                    if (oldValue && !newValue) {
+                        onRemoved === null || onRemoved === void 0 ? void 0 : onRemoved();
+                    }
+                    else if (!oldValue && newValue) {
+                        onAdded === null || onAdded === void 0 ? void 0 : onAdded();
+                    }
+                }
+            };
+            if (!isBrowser)
+                return function () { return void 0; };
+            var listener = on(window, "storage", handler);
+            return listener;
+        },
+    };
+};
+export default createStorage;

package/getZonedDate.d.ts

@@ -0,0 +1,16 @@
+/**
+ * It returns a `Date` object from a date `string` adjusted on the user timeZone,
+ * if a timeZone is not provided we try getting it from the `Intl` browwser native
+ * API. It gracefully falls back returning a _non-timezone-based_ `Date`.
+ *
+ * @category date
+ *
+ * @resources
+ * - to get the timeZone client side see [this article](https://attacomsian.com/blog/javascript-current-timezone)
+ * - for converting the date based on the time zone [date-fns docs](https://date-fns.org/v2.27.0/docs/Time-Zones) and [date-fns-tz docs](https://github.com/marnusw/date-fns-tz)
+ *
+ * @param dateString A parseable date as string, `Z` is automatically suffixed if not present to correctly get time zone based time from a UTC date.
+ * @param timeZone Optionally pass a timeZone (e.g. from user preference or from the server), it falls back trying to read it from the `Intl` browwser native API.
+ */
+export declare function getZonedDate(dateString?: string, timeZone?: string): Date;
+export default getZonedDate;

package/getZonedDate.js

@@ -0,0 +1,37 @@
+import utcToZonedTime from "date-fns-tz/utcToZonedTime";
+import { isBrowser } from "@koine/utils";
+/**
+ * It returns a `Date` object from a date `string` adjusted on the user timeZone,
+ * if a timeZone is not provided we try getting it from the `Intl` browwser native
+ * API. It gracefully falls back returning a _non-timezone-based_ `Date`.
+ *
+ * @category date
+ *
+ * @resources
+ * - to get the timeZone client side see [this article](https://attacomsian.com/blog/javascript-current-timezone)
+ * - for converting the date based on the time zone [date-fns docs](https://date-fns.org/v2.27.0/docs/Time-Zones) and [date-fns-tz docs](https://github.com/marnusw/date-fns-tz)
+ *
+ * @param dateString A parseable date as string, `Z` is automatically suffixed if not present to correctly get time zone based time from a UTC date.
+ * @param timeZone Optionally pass a timeZone (e.g. from user preference or from the server), it falls back trying to read it from the `Intl` browwser native API.
+ */
+export function getZonedDate(dateString, timeZone) {
+    if (dateString === void 0) { dateString = ""; }
+    if (!dateString.endsWith("Z"))
+        dateString += "Z";
+    if (!timeZone && isBrowser) {
+        try {
+            timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+        }
+        catch (e) {
+            if (process.env["NODE_ENV"] !== "production") {
+                console.warn("[@koine/utils:getZonedDate] failed reading timeZone, error", e);
+            }
+            // no need to do anything here, it just means `Intl` failed, probably
+            // because the browser does not support it
+        }
+    }
+    return timeZone
+        ? utcToZonedTime(new Date(dateString), timeZone)
+        : new Date(dateString);
+}
+export default getZonedDate;

package/gtagPageview.d.ts

@@ -0,0 +1,10 @@
+export declare type GtmPageviewArgs = [
+    page_path?: string,
+    page_title?: string,
+    page_location?: string
+];
+/**
+ * @category analytics-google
+ */
+export declare const gtagPageview: (page_path?: string | undefined, page_title?: string | undefined, page_location?: string | undefined) => void;
+export default gtagPageview;

package/gtagPageview.js

@@ -0,0 +1,30 @@
+import { isUndefined } from "@koine/utils";
+/**
+ * @category analytics-google
+ */
+export var gtagPageview = function () {
+    var args = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        args[_i] = arguments[_i];
+    }
+    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 default gtagPageview;
+// export type GtmEventArgs = [
+//   eventCategory?: string,
+//   eventAction?: string,
+//   eventLabel?: string,
+//   eventValue?: string
+// ];
+// export const event = (...args: GtmEventArgs) => {
+//   if (!isUndefined(window) && !isUndefined(window.gtag)) {
+//     window.gtag("send", "event", ...args);
+//   }
+// };

package/index.d.ts

@@ -0,0 +1,12 @@
+export * from "./createStorage";
+export * from "./getZonedDate";
+export * from "./gtagPageview";
+export * from "./isIE";
+export * from "./isMobile";
+export * from "./navigateToHash";
+export * from "./navigateToHashParams";
+export * from "./navigateToMergedHashParams";
+export * from "./navigateToMergedParams";
+export * from "./navigateToParams";
+export * from "./navigateWithoutUrlParam";
+export * from "./redirectTo";

package/index.js

@@ -0,0 +1,12 @@
+export * from "./createStorage";
+export * from "./getZonedDate";
+export * from "./gtagPageview";
+export * from "./isIE";
+export * from "./isMobile";
+export * from "./navigateToHash";
+export * from "./navigateToHashParams";
+export * from "./navigateToMergedHashParams";
+export * from "./navigateToMergedParams";
+export * from "./navigateToParams";
+export * from "./navigateWithoutUrlParam";
+export * from "./redirectTo";

package/isIE.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @category detect
+ * @category is
+ * @see https://stackoverflow.com/a/21712356/12285349
+ */
+export declare function isIE(ssrValue?: boolean): boolean;
+export default isIE;

package/isIE.js

@@ -0,0 +1,18 @@
+import { isServer } from "@koine/utils";
+/**
+ * @category detect
+ * @category is
+ * @see https://stackoverflow.com/a/21712356/12285349
+ */
+export function isIE(ssrValue) {
+    if (ssrValue === void 0) { ssrValue = true; }
+    if (isServer) {
+        return ssrValue;
+    }
+    var ua = window.navigator.userAgent;
+    if (ua.indexOf("MSIE ") > 0 || ua.indexOf("Trident/") > 0) {
+        return true;
+    }
+    return false;
+}
+export default isIE;

package/isMobile.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @category detect
+ * @category is
+ * @see https://stackoverflow.com/a/3540295
+ */
+export declare function isMobile(ssrValue?: boolean): boolean;
+export default isMobile;

package/isMobile.js

@@ -0,0 +1,16 @@
+import { isServer } from "@koine/utils";
+/**
+ * @category detect
+ * @category is
+ * @see https://stackoverflow.com/a/3540295
+ */
+export function isMobile(ssrValue) {
+    if (ssrValue === void 0) { ssrValue = true; }
+    if (isServer) {
+        return ssrValue;
+    }
+    return /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(window.navigator.userAgent);
+    // return /(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|ipad|iris|kindle|Android|Silk|lge |maemo|midp|mmp|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows (ce|phone)|xda|xiino/i.test(navigator.userAgent)
+    //   || /1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i.test(navigator.userAgent.substr(0,4)
+}
+export default isMobile;

package/navigateToHash.d.ts

@@ -0,0 +1,8 @@
+/**
+ * It updates the browser's location hash by replacing the history state.
+ * The non-silent standard way would simply be `location.hash = "#new-hash"`
+ *
+ * @category location
+ */
+export declare function navigateToHash(hash?: string): void;
+export default navigateToHash;

package/navigateToHash.js

@@ -0,0 +1,12 @@
+/**
+ * It updates the browser's location hash by replacing the history state.
+ * The non-silent standard way would simply be `location.hash = "#new-hash"`
+ *
+ * @category location
+ */
+export function navigateToHash(hash) {
+    if (hash === void 0) { hash = ""; }
+    var pathname = location.pathname, search = location.search;
+    history.replaceState(null, "", pathname + (search ? "?" + search : "") + "#" + hash);
+}
+export default navigateToHash;

package/navigateToHashParams.d.ts

@@ -0,0 +1,9 @@
+import { type AnyQueryParams } from "@koine/utils";
+/**
+ * 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,21 @@
+import { buildUrlQueryString, getUrlHashPathname, } from "@koine/utils";
+/**
+ * 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 "@koine/utils";
+/**
+ * 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,13 @@
+import { mergeUrlQueryParams, getUrlHashParams, } from "@koine/utils";
+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 "@koine/utils";
+/**
+ * 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,13 @@
+import { mergeUrlQueryParams, getUrlQueryParams, } from "@koine/utils";
+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 "@koine/utils";
+/**
+ * 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;

package/navigateToParams.js

@@ -0,0 +1,17 @@
+import { isBrowser, buildUrlQueryString, } from "@koine/utils";
+/**
+ * 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 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;
+}
+export default navigateToParams;

package/navigateWithoutUrlParam.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Remove URL query parameter, 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 navigateWithoutUrlParam(paramName?: string, replace?: boolean): string;
+export default navigateWithoutUrlParam;

package/navigateWithoutUrlParam.js

@@ -0,0 +1,19 @@
+import { getUrlQueryParams } from "@koine/utils";
+import { navigateToParams } from "./navigateToParams";
+/**
+ * Remove URL query parameter, it uses `history`
+ *
+ * @category location
+ * @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);
+}
+export default navigateWithoutUrlParam;

package/node/createStorage.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStorage = void 0;
+var tslib_1 = require("tslib");
+var utils_1 = require("@koine/utils");
+var dom_1 = require("@koine/dom");
+/**
+ * Utility to create a storage instance to interact with `localStorage` using
+ * encrypted (encoded) key/values.
+ */
+var createStorage = function (config) {
+    var methodsMap = { g: "getItem", s: "setItem", r: "removeItem" };
+    /**
+     * Super minifiable localStorage wrapper with SSR safety
+     */
+    var ls = function (method, key, value) {
+        return utils_1.isBrowser
+            ? localStorage[methodsMap[method]](key, value)
+            : function () {
+                if (process.env["NODE_ENV"] !== "production") {
+                    console.warn("[@koine/utils] createStorage: localStorage does not exists in this environment.");
+                }
+            };
+    };
+    var keys = Object.keys(config).reduce(function (map, key) {
+        var _a;
+        return (tslib_1.__assign(tslib_1.__assign({}, map), (_a = {}, _a[key] = (0, utils_1.encode)(key), _a)));
+    }, {});
+    return {
+        /**
+         * Get all storage value (it uses `localStorage.get()`).
+         *
+         * Unparseable values with `JSON.parse()` return their value as it is.
+         * If the given `key` argument is not found `null` is returned.
+         */
+        get: function (key) {
+            var stored = ls("g", keys[key]);
+            if (stored) {
+                stored = (0, utils_1.decode)(stored);
+                try {
+                    return JSON.parse(stored);
+                }
+                catch (_e) {
+                    return stored;
+                }
+            }
+            return null;
+        },
+        /**
+         * Get all storage values (it uses `localStorage.get()`).
+         *
+         * `undefined` and `null` values are not returned.
+         */
+        getAll: function () {
+            var all = {};
+            for (var key in keys) {
+                var value = this.get(key);
+                if (!(0, utils_1.isNullOrUndefined)(value)) {
+                    all[key] = value;
+                }
+            }
+            return all;
+        },
+        /**
+         * Set a storage value (it uses `localStorage.set()`).
+         *
+         * Non-string values are stringified with `JSON.stringify()`
+         */
+        set: function (key, value) {
+            ls("s", keys[key], (0, utils_1.isString)(value) ? (0, utils_1.encode)(value) : (0, utils_1.encode)(JSON.stringify(value)));
+        },
+        /**
+         * Set all given storage values (it uses `localStorage.set()`).
+         *
+         * Non-string values are stringified with `JSON.stringify()`, `undefined`
+         * and `null` values are removed from the storage
+         */
+        setMany: function (newValues) {
+            for (var key in newValues) {
+                var value = newValues[key];
+                if (!(0, utils_1.isNullOrUndefined)(value)) {
+                    this.set(key, value);
+                }
+                else {
+                    this.remove(key);
+                }
+            }
+        },
+        /**
+         * Check if a storage value is _truthy_ (it uses `localStorage.get()`).
+         */
+        has: function (key) {
+            var stored = ls("g", keys[key]);
+            return !!stored;
+        },
+        /**
+         * Remove a storage value (it uses `localStorage.remove()`).
+         */
+        remove: function (key) {
+            ls("r", keys[key]);
+        },
+        /**
+         * Clear all storage values (it uses `localStorage.remove()`).
+         */
+        clear: function () {
+            for (var key in keys) {
+                ls("r", keys[key]);
+            }
+        },
+        /**
+         * Watch a storage value changes, this needs to be executed only in browser
+         * context (it uses `window.addEventListener("storage")`).
+         *
+         * Inspiration from [Multi Tab Logout in React — Redux](https://medium.com/front-end-weekly/multi-tab-logout-in-react-redux-4715f071c7fa)
+         */
+        watch: function (keyToWatch, onRemoved, onAdded) {
+            var handler = function (event) {
+                var key = event.key, oldValue = event.oldValue, newValue = event.newValue;
+                if (key === keys[keyToWatch]) {
+                    if (oldValue && !newValue) {
+                        onRemoved === null || onRemoved === void 0 ? void 0 : onRemoved();
+                    }
+                    else if (!oldValue && newValue) {
+                        onAdded === null || onAdded === void 0 ? void 0 : onAdded();
+                    }
+                }
+            };
+            if (!utils_1.isBrowser)
+                return function () { return void 0; };
+            var listener = (0, dom_1.on)(window, "storage", handler);
+            return listener;
+        },
+    };
+};
+exports.createStorage = createStorage;
+exports.default = exports.createStorage;

package/node/getZonedDate.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getZonedDate = void 0;
+var tslib_1 = require("tslib");
+var utcToZonedTime_1 = tslib_1.__importDefault(require("date-fns-tz/utcToZonedTime"));
+var utils_1 = require("@koine/utils");
+/**
+ * It returns a `Date` object from a date `string` adjusted on the user timeZone,
+ * if a timeZone is not provided we try getting it from the `Intl` browwser native
+ * API. It gracefully falls back returning a _non-timezone-based_ `Date`.
+ *
+ * @category date
+ *
+ * @resources
+ * - to get the timeZone client side see [this article](https://attacomsian.com/blog/javascript-current-timezone)
+ * - for converting the date based on the time zone [date-fns docs](https://date-fns.org/v2.27.0/docs/Time-Zones) and [date-fns-tz docs](https://github.com/marnusw/date-fns-tz)
+ *
+ * @param dateString A parseable date as string, `Z` is automatically suffixed if not present to correctly get time zone based time from a UTC date.
+ * @param timeZone Optionally pass a timeZone (e.g. from user preference or from the server), it falls back trying to read it from the `Intl` browwser native API.
+ */
+function getZonedDate(dateString, timeZone) {
+    if (dateString === void 0) { dateString = ""; }
+    if (!dateString.endsWith("Z"))
+        dateString += "Z";
+    if (!timeZone && utils_1.isBrowser) {
+        try {
+            timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+        }
+        catch (e) {
+            if (process.env["NODE_ENV"] !== "production") {
+                console.warn("[@koine/utils:getZonedDate] failed reading timeZone, error", e);
+            }
+            // no need to do anything here, it just means `Intl` failed, probably
+            // because the browser does not support it
+        }
+    }
+    return timeZone
+        ? (0, utcToZonedTime_1.default)(new Date(dateString), timeZone)
+        : new Date(dateString);
+}
+exports.getZonedDate = getZonedDate;
+exports.default = getZonedDate;

package/node/gtagPageview.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.gtagPageview = void 0;
+var utils_1 = require("@koine/utils");
+/**
+ * @category analytics-google
+ */
+var gtagPageview = function () {
+    var args = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        args[_i] = arguments[_i];
+    }
+    if (!(0, utils_1.isUndefined)(window) && !(0, utils_1.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>'
+        });
+    }
+};
+exports.gtagPageview = gtagPageview;
+exports.default = exports.gtagPageview;
+// export type GtmEventArgs = [
+//   eventCategory?: string,
+//   eventAction?: string,
+//   eventLabel?: string,
+//   eventValue?: string
+// ];
+// export const event = (...args: GtmEventArgs) => {
+//   if (!isUndefined(window) && !isUndefined(window.gtag)) {
+//     window.gtag("send", "event", ...args);
+//   }
+// };

package/node/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./createStorage"), exports);
+tslib_1.__exportStar(require("./getZonedDate"), exports);
+tslib_1.__exportStar(require("./gtagPageview"), exports);
+tslib_1.__exportStar(require("./isIE"), exports);
+tslib_1.__exportStar(require("./isMobile"), exports);
+tslib_1.__exportStar(require("./navigateToHash"), exports);
+tslib_1.__exportStar(require("./navigateToHashParams"), exports);
+tslib_1.__exportStar(require("./navigateToMergedHashParams"), exports);
+tslib_1.__exportStar(require("./navigateToMergedParams"), exports);
+tslib_1.__exportStar(require("./navigateToParams"), exports);
+tslib_1.__exportStar(require("./navigateWithoutUrlParam"), exports);
+tslib_1.__exportStar(require("./redirectTo"), exports);

package/node/isIE.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isIE = void 0;
+var utils_1 = require("@koine/utils");
+/**
+ * @category detect
+ * @category is
+ * @see https://stackoverflow.com/a/21712356/12285349
+ */
+function isIE(ssrValue) {
+    if (ssrValue === void 0) { ssrValue = true; }
+    if (utils_1.isServer) {
+        return ssrValue;
+    }
+    var ua = window.navigator.userAgent;
+    if (ua.indexOf("MSIE ") > 0 || ua.indexOf("Trident/") > 0) {
+        return true;
+    }
+    return false;
+}
+exports.isIE = isIE;
+exports.default = isIE;

package/node/isMobile.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isMobile = void 0;
+var utils_1 = require("@koine/utils");
+/**
+ * @category detect
+ * @category is
+ * @see https://stackoverflow.com/a/3540295
+ */
+function isMobile(ssrValue) {
+    if (ssrValue === void 0) { ssrValue = true; }
+    if (utils_1.isServer) {
+        return ssrValue;
+    }
+    return /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(window.navigator.userAgent);
+    // return /(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|ipad|iris|kindle|Android|Silk|lge |maemo|midp|mmp|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows (ce|phone)|xda|xiino/i.test(navigator.userAgent)
+    //   || /1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i.test(navigator.userAgent.substr(0,4)
+}
+exports.isMobile = isMobile;
+exports.default = isMobile;

package/node/navigateToHash.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.navigateToHash = void 0;
+/**
+ * It updates the browser's location hash by replacing the history state.
+ * The non-silent standard way would simply be `location.hash = "#new-hash"`
+ *
+ * @category location
+ */
+function navigateToHash(hash) {
+    if (hash === void 0) { hash = ""; }
+    var pathname = location.pathname, search = location.search;
+    history.replaceState(null, "", pathname + (search ? "?" + search : "") + "#" + hash);
+}
+exports.navigateToHash = navigateToHash;
+exports.default = navigateToHash;

package/node/navigateToHashParams.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.navigateToHashParams = void 0;
+var utils_1 = require("@koine/utils");
+/**
+ * It updates the `location.hash` with the given query params, it uses `location.hash`
+ * if a second argument `hash` is not provded
+ *
+ * @category location
+ */
+function navigateToHashParams(params, hash) {
+    if (params === void 0) { params = {}; }
+    if (hash === void 0) { hash = ""; }
+    var useLocation = !hash;
+    hash = hash || location.hash;
+    var hashQueryLess = (0, utils_1.getUrlHashPathname)(hash);
+    var queryString = typeof params === "string" ? params : (0, utils_1.buildUrlQueryString)(params);
+    var newHash = "#/" + hashQueryLess + queryString;
+    if (useLocation) {
+        location.hash = newHash;
+    }
+    return newHash;
+}
+exports.navigateToHashParams = navigateToHashParams;
+exports.default = navigateToHashParams;

package/node/navigateToMergedHashParams.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.navigateToMergedHashParams = void 0;
+var utils_1 = require("@koine/utils");
+var navigateToHashParams_1 = require("./navigateToHashParams");
+/**
+ * It updates the "query params" within the `location.hash`, it uses `location`
+ *
+ * @category location
+ */
+function navigateToMergedHashParams(params, hash) {
+    if (params === void 0) { params = {}; }
+    if (hash === void 0) { hash = ""; }
+    return (0, navigateToHashParams_1.navigateToHashParams)((0, utils_1.mergeUrlQueryParams)((0, utils_1.getUrlHashParams)(hash), params), hash);
+}
+exports.navigateToMergedHashParams = navigateToMergedHashParams;
+exports.default = navigateToMergedHashParams;

package/node/navigateToMergedParams.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.navigateToMergedParams = void 0;
+var utils_1 = require("@koine/utils");
+var navigateToParams_1 = require("./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.
+ */
+function navigateToMergedParams(params, replace) {
+    if (params === void 0) { params = {}; }
+    return (0, navigateToParams_1.navigateToParams)((0, utils_1.mergeUrlQueryParams)((0, utils_1.getUrlQueryParams)(), params), replace);
+}
+exports.navigateToMergedParams = navigateToMergedParams;
+exports.default = navigateToMergedParams;

package/node/navigateToParams.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.navigateToParams = void 0;
+var utils_1 = require("@koine/utils");
+/**
+ * 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 `?`
+ */
+function navigateToParams(params, replace) {
+    if (params === void 0) { params = {}; }
+    var queryString = typeof params === "string" ? params : (0, utils_1.buildUrlQueryString)(params);
+    if (utils_1.isBrowser) {
+        history[replace ? "replaceState" : "pushState"](null, "", location.pathname + queryString);
+    }
+    return queryString;
+}
+exports.navigateToParams = navigateToParams;
+exports.default = navigateToParams;

package/node/navigateWithoutUrlParam.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.navigateWithoutUrlParam = void 0;
+var utils_1 = require("@koine/utils");
+var navigateToParams_1 = require("./navigateToParams");
+/**
+ * Remove URL query parameter, it uses `history`
+ *
+ * @category location
+ * @param replace Replace URL instead of pushing it in the history stack. By default it pushes it.
+ */
+function navigateWithoutUrlParam(paramName, replace) {
+    var params = {};
+    var currentParams = (0, utils_1.getUrlQueryParams)();
+    for (var key in currentParams) {
+        if (key !== paramName) {
+            params[key] = currentParams[key];
+        }
+    }
+    return (0, navigateToParams_1.navigateToParams)(params, replace);
+}
+exports.navigateWithoutUrlParam = navigateWithoutUrlParam;
+exports.default = navigateWithoutUrlParam;

package/node/redirectTo.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.redirectTo = void 0;
+var utils_1 = require("@koine/utils");
+/**
+ * Redirect to url with params {optionally}, removes eventual trailing question
+ * marks from the given URL, it uses `location`
+ *
+ * @category location
+ */
+function redirectTo(url, params) {
+    if (utils_1.isBrowser) {
+        var queryString = (0, utils_1.buildUrlQueryString)(params);
+        location.href = url.replace(/\?+$/g, "") + queryString;
+    }
+}
+exports.redirectTo = redirectTo;
+exports.default = redirectTo;

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@koine/browser",
+  "sideEffects": false,
+  "main": "./node/index.js",
+  "typings": "./index.d.ts",
+  "dependencies": {
+    "@koine/utils": "1.0.88",
+    "ts-debounce": "^4.0.0",
+    "@koine/dom": "1.0.88",
+    "date-fns-tz": "^1.3.7",
+    "tslib": "^2.4.0"
+  },
+  "peerDependencies": {},
+  "version": "1.0.88",
+  "module": "./index.js",
+  "types": "./index.d.ts"
+}

package/redirectTo.d.ts

@@ -0,0 +1,9 @@
+import { type AnyQueryParams } from "@koine/utils";
+/**
+ * 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,14 @@
+import { isBrowser, buildUrlQueryString, } from "@koine/utils";
+/**
+ * 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/typings.d.ts

@@ -0,0 +1,12 @@
+/**
+ * List here the global variables used by third party scripts supported within
+ * the `koine` ecosystem. For instance Google Analytics globally available
+ * variables.
+ */
+
+// eslint-disable-next-line no-var,@typescript-eslint/no-explicit-any
+declare var gtag: (...args: any[]) => any;
+
+// declare type NullableRecord<T> = {
+//   [K in keyof T]: T[K] | null;
+// };