@koine/browser 2.0.0-beta.13 → 2.0.0-beta.15

package/createStorage.d.ts

@@ -1,59 +1,12 @@
-/**
- * @category storage
- */
 export type CreateStorageConfig = Record<string, any>;
-/**
- * Utility to create a storage instance to interact with `localStorage` using
- * encrypted (encoded) key/values.
- *
- * @category storage
- */
 export declare const createStorage: <T extends CreateStorageConfig>(config: Partial<T>, useSessionStorage?: boolean) => {
-    /**
-     * Get all storage value (it uses `localStorage.get()`).
-     *
-     * Unparseable values with `JSON.parse()` return their value as it is.
-     * On ssr or if the given `key` argument is not found `defaultValue` is
-     * returned, otherwise `null`.
-     */
     get<TKey extends Extract<keyof T, string>>(key: TKey, defaultValue?: T[TKey] | null | undefined): T[TKey] | null;
-    /**
-     * Get all storage values (it uses `localStorage.get()`).
-     *
-     * `undefined` and `null` values are not returned.
-     */
     getAll(defaultValues?: Partial<T> | undefined): T;
-    /**
-     * Set a storage value (it uses `localStorage.set()`).
-     *
-     * Non-string values are stringified with `JSON.stringify()`
-     */
     set<TKey_1 extends Extract<keyof T, string>>(key: TKey_1, value?: T[TKey_1] | undefined): 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 Extract<keyof T, string>>(key: TKey_2): any;
-    /**
-     * Remove a storage value (it uses `localStorage.remove()`).
-     */
     remove<TKey_3 extends Extract<keyof T, string>>(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,101 @@
+import { __assign } from "tslib";
+import decode from "@koine/utils/decode";
+import encode from "@koine/utils/encode";
+import isBrowser from "@koine/utils/isBrowser";
+import isNullOrUndefined from "@koine/utils/isNullOrUndefined";
+import noop from "@koine/utils/noop";
+import on from "@koine/dom/on";
+import storage from "./storage.js";
+export var createStorage = function (config, useSessionStorage) {
+    var client = useSessionStorage ? storage.s : storage.l;
+    var keys = Object.keys(config).reduce(function (map, key) {
+        var _a;
+        return (__assign(__assign({}, map), (_a = {}, _a[key] = encode(key), _a)));
+    }, {});
+    return {
+        get: function (key, defaultValue) {
+            return client.get(keys[key], decode, defaultValue);
+        },
+        getAll: function (defaultValues) {
+            if (!isBrowser) {
+                if (process.env["NODE_ENV"] !== "production") {
+                    console.log("[@koine/utils:createStorage] attempt to use 'getAll' outside of browser.");
+                }
+                return {};
+            }
+            var all = {};
+            for (var key in keys) {
+                var value = this.get(key);
+                var defaultValue = defaultValues === null || defaultValues === void 0 ? void 0 : defaultValues[key];
+                if (!isNullOrUndefined(value)) {
+                    all[key] = value;
+                }
+                else if (defaultValue) {
+                    all[key] = defaultValue;
+                }
+            }
+            return all;
+        },
+        set: function (key, value) {
+            client.set(keys[key], value, encode);
+        },
+        setMany: function (newValues) {
+            if (process.env["NODE_ENV"] !== "production") {
+                if (!isBrowser) {
+                    console.log("[@koine/utils:createStorage] attempt to use 'setMany' outside of browser.");
+                }
+            }
+            if (isBrowser) {
+                for (var key in newValues) {
+                    var value = newValues[key];
+                    if (!isNullOrUndefined(value)) {
+                        this.set(key, value);
+                    }
+                    else {
+                        this.remove(key);
+                    }
+                }
+            }
+        },
+        has: function (key) {
+            return client.has(keys[key]);
+        },
+        remove: function (key) {
+            client.remove(keys[key]);
+        },
+        clear: function () {
+            if (process.env["NODE_ENV"] !== "production") {
+                if (!isBrowser) {
+                    console.log("[@koine/utils:createStorage] attempt to use 'clear' outside of browser.");
+                }
+            }
+            if (isBrowser) {
+                for (var key in keys) {
+                    client.remove(keys[key]);
+                }
+            }
+        },
+        watch: function (keyToWatch, onRemoved, onAdded) {
+            if (!isBrowser) {
+                if (process.env["NODE_ENV"] !== "production") {
+                    console.log("[@koine/utils:createStorage] attempt to use 'watch' outside of browser.");
+                }
+                return noop;
+            }
+            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();
+                    }
+                }
+            };
+            var listener = on(window, "storage", handler);
+            return listener;
+        },
+    };
+};
+export default createStorage;

package/getZonedDate.d.ts

@@ -1,16 +1,2 @@
-/**
- * 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,21 @@
+import utcToZonedTime from "date-fns-tz/utcToZonedTime";
+import isBrowser from "@koine/utils/isBrowser";
+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);
+            }
+        }
+    }
+    return timeZone
+        ? utcToZonedTime(new Date(dateString), timeZone)
+        : new Date(dateString);
+}
+export default getZonedDate;

package/gtagPageview.d.ts

@@ -3,8 +3,5 @@ export type GtmPageviewArgs = [
     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,15 @@
+import isUndefined from "@koine/utils/isUndefined";
+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,
+        });
+    }
+};
+export default gtagPageview;

package/index.d.ts

@@ -1,15 +1,15 @@
-export { createStorage, type CreateStorageConfig } from "./createStorage";
-export { getZonedDate } from "./getZonedDate";
-export { gtagPageview, type GtmPageviewArgs } from "./gtagPageview";
-export { isIE } from "./isIE";
-export { isMobile } from "./isMobile";
-export { navigateToHash } from "./navigateToHash";
-export { navigateToHashParams } from "./navigateToHashParams";
-export { navigateToMergedHashParams } from "./navigateToMergedHashParams";
-export { navigateToMergedParams } from "./navigateToMergedParams";
-export { navigateToParams } from "./navigateToParams";
-export { navigateToUrl } from "./navigateToUrl";
-export { navigateWithoutUrlParam } from "./navigateWithoutUrlParam";
-export { redirectTo } from "./redirectTo";
-export { storage } from "./storage";
-export { storageClient, type StorageClientConfig } from "./storageClient";
+export { createStorage, type CreateStorageConfig } from "./createStorage.js";
+export { getZonedDate } from "./getZonedDate.js";
+export { gtagPageview, type GtmPageviewArgs } from "./gtagPageview.js";
+export { isIE } from "./isIE.js";
+export { isMobile } from "./isMobile.js";
+export { navigateToHash } from "./navigateToHash.js";
+export { navigateToHashParams } from "./navigateToHashParams.js";
+export { navigateToMergedHashParams } from "./navigateToMergedHashParams.js";
+export { navigateToMergedParams } from "./navigateToMergedParams.js";
+export { navigateToParams } from "./navigateToParams.js";
+export { navigateToUrl } from "./navigateToUrl.js";
+export { navigateWithoutUrlParam } from "./navigateWithoutUrlParam.js";
+export { redirectTo } from "./redirectTo.js";
+export { storage } from "./storage.js";
+export { storageClient, type StorageClientConfig } from "./storageClient.js";

package/index.js

@@ -0,0 +1,15 @@
+export { createStorage } from "./createStorage.js";
+export { getZonedDate } from "./getZonedDate.js";
+export { gtagPageview } from "./gtagPageview.js";
+export { isIE } from "./isIE.js";
+export { isMobile } from "./isMobile.js";
+export { navigateToHash } from "./navigateToHash.js";
+export { navigateToHashParams } from "./navigateToHashParams.js";
+export { navigateToMergedHashParams } from "./navigateToMergedHashParams.js";
+export { navigateToMergedParams } from "./navigateToMergedParams.js";
+export { navigateToParams } from "./navigateToParams.js";
+export { navigateToUrl } from "./navigateToUrl.js";
+export { navigateWithoutUrlParam } from "./navigateWithoutUrlParam.js";
+export { redirectTo } from "./redirectTo.js";
+export { storage } from "./storage.js";
+export { storageClient } from "./storageClient.js";

package/isIE.d.ts

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

package/{isIE.mjs → isIE.js}

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

package/isMobile.d.ts

@@ -1,7 +1,2 @@
-/**
- * @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,9 @@
+import isServer from "@koine/utils/isServer";
+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);
+}
+export default isMobile;

package/navigateToHash.d.ts

@@ -1,8 +1,2 @@
-/**
- * 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,7 @@
+import navigateToUrl from "./navigateToUrl.js";
+export function navigateToHash(hash) {
+    if (hash === void 0) { hash = ""; }
+    var pathname = location.pathname, search = location.search;
+    navigateToUrl(pathname + (search ? "?" + search : "") + (hash ? "#" + hash : ""), true);
+}
+export default navigateToHash;

package/navigateToHashParams.d.ts

@@ -1,9 +1,3 @@
 import type { AnyQueryParams } from "@koine/utils/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,16 @@
+import buildUrlQueryString from "@koine/utils/buildUrlQueryString";
+import getUrlHashPathname from "@koine/utils/getUrlHashPathname";
+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

@@ -1,8 +1,3 @@
 import type { AnyQueryParams } from "@koine/utils/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.mjs → navigateToMergedHashParams.js}

@@ -1,11 +1,9 @@
 import getUrlHashParams from "@koine/utils/getUrlHashParams";
 import mergeUrlQueryParams from "@koine/utils/mergeUrlQueryParams";
-import { navigateToHashParams } from "./navigateToHashParams";
-/**
- * It updates the "query params" within the `location.hash`, it uses `location`
- *
- * @category location
- */ export function navigateToMergedHashParams(params = {}, hash = "") {
+import { navigateToHashParams } from "./navigateToHashParams.js";
+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

@@ -1,9 +1,3 @@
 import type { AnyQueryParams } from "@koine/utils/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,8 @@
+import getUrlQueryParams from "@koine/utils/getUrlQueryParams";
+import mergeUrlQueryParams from "@koine/utils/mergeUrlQueryParams";
+import { navigateToParams } from "./navigateToParams.js";
+export function navigateToMergedParams(params, replace) {
+    if (params === void 0) { params = {}; }
+    return navigateToParams(mergeUrlQueryParams(getUrlQueryParams(), params), replace);
+}
+export default navigateToMergedParams;

package/navigateToParams.d.ts

@@ -1,10 +1,3 @@
 import type { AnyQueryParams } from "@koine/utils/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;

package/navigateToParams.js

@@ -0,0 +1,12 @@
+import buildUrlQueryString from "@koine/utils/buildUrlQueryString";
+import isBrowser from "@koine/utils/isBrowser";
+import navigateToUrl from "./navigateToUrl.js";
+export function navigateToParams(params, replace) {
+    if (params === void 0) { params = {}; }
+    var queryString = typeof params === "string" ? params : buildUrlQueryString(params);
+    if (isBrowser) {
+        navigateToUrl(location.pathname + queryString, replace);
+    }
+    return queryString;
+}
+export default navigateToParams;

package/navigateToUrl.d.ts

@@ -1,7 +1,2 @@
-/**
- * It updates the browser's location URL with global `history` object
- *
- * @category location
- */
 export declare function navigateToUrl(url?: string, replace?: boolean): void;
 export default navigateToUrl;

package/navigateToUrl.js

@@ -0,0 +1,7 @@
+export function navigateToUrl(url, replace) {
+    if (url === void 0) { url = ""; }
+    if (url) {
+        history[replace ? "replaceState" : "pushState"](history.state, "", url);
+    }
+}
+export default navigateToUrl;

package/navigateWithoutUrlParam.d.ts

@@ -1,8 +1,2 @@
-/**
- * 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,13 @@
+import getUrlQueryParams from "@koine/utils/getUrlQueryParams";
+import navigateToParams from "./navigateToParams.js";
+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/package.json

@@ -2,12 +2,62 @@
   "name": "@koine/browser",
   "sideEffects": false,
   "dependencies": {
-    "@koine/dom": "2.0.0-beta.13",
-    "@koine/utils": "2.0.0-beta.13"
+    "@koine/dom": "2.0.0-beta.15",
+    "@koine/utils": "2.0.0-beta.15"
   },
-  "module": "./index.mjs",
-  "main": "./index.js",
   "types": "./index.d.ts",
+  "type": "module",
+  "module": "./index.js",
+  "exports": {
+    ".": {
+      "import": "./index.js"
+    },
+    "./createStorage": {
+      "import": "./createStorage.js"
+    },
+    "./getZonedDate": {
+      "import": "./getZonedDate.js"
+    },
+    "./gtagPageview": {
+      "import": "./gtagPageview.js"
+    },
+    "./isIE": {
+      "import": "./isIE.js"
+    },
+    "./isMobile": {
+      "import": "./isMobile.js"
+    },
+    "./navigateToHash": {
+      "import": "./navigateToHash.js"
+    },
+    "./navigateToHashParams": {
+      "import": "./navigateToHashParams.js"
+    },
+    "./navigateToMergedHashParams": {
+      "import": "./navigateToMergedHashParams.js"
+    },
+    "./navigateToMergedParams": {
+      "import": "./navigateToMergedParams.js"
+    },
+    "./navigateToParams": {
+      "import": "./navigateToParams.js"
+    },
+    "./navigateToUrl": {
+      "import": "./navigateToUrl.js"
+    },
+    "./navigateWithoutUrlParam": {
+      "import": "./navigateWithoutUrlParam.js"
+    },
+    "./redirectTo": {
+      "import": "./redirectTo.js"
+    },
+    "./storage": {
+      "import": "./storage.js"
+    },
+    "./storageClient": {
+      "import": "./storageClient.js"
+    }
+  },
   "peerDependencies": {},
-  "version": "2.0.0-beta.13"
-}
+  "version": "2.0.0-beta.15"
+}

package/redirectTo.d.ts

@@ -1,9 +1,3 @@
 import type { AnyQueryParams } from "@koine/utils/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,9 @@
+import buildUrlQueryString from "@koine/utils/buildUrlQueryString";
+import isBrowser from "@koine/utils/isBrowser";
+export function redirectTo(url, params) {
+    if (isBrowser) {
+        var queryString = buildUrlQueryString(params);
+        location.href = url.replace(/\?+$/g, "") + queryString;
+    }
+}
+export default redirectTo;

package/storage.d.ts

@@ -1,8 +1,3 @@
-/**
- * Storage, for `localStorage` and `sessionStorage`
- *
- * @category storage
- */
 export declare const storage: {
     l: {
         get: <TKey extends string, TValue = any>(key: TKey, transform?: ((value: string) => TValue) | undefined, defaultValue?: TValue | null | undefined) => NonNullable<TValue> | null;

package/storage.js

@@ -0,0 +1,6 @@
+import storageClient from "./storageClient.js";
+export var storage = {
+    l: storageClient(),
+    s: storageClient(true),
+};
+export default storage;

package/storageClient.d.ts

@@ -1,12 +1,4 @@
-/**
- * @category storage
- */
 export type StorageClientConfig = Record<string, any>;
-/**
- * Super minifiable `local/session Storage` client creator with SSR safety
- *
- * @category storage
- */
 export declare const storageClient: <TConfig extends StorageClientConfig = StorageClientConfig>(useSessionStorage?: boolean) => {
     get: <TKey extends Extract<keyof TConfig, string>, TValue = TConfig[TKey]>(key: TKey, transform?: ((value: string) => TValue) | undefined, defaultValue?: TValue | null | undefined) => NonNullable<TValue> | null;
     set: <TKey_1 extends Extract<keyof TConfig, string>, TValue_1 = TConfig[TKey_1]>(key: TKey_1, value?: TValue_1 | undefined, transform?: (value: any) => string) => void;

package/storageClient.js

@@ -0,0 +1,95 @@
+import isBrowser from "@koine/utils/isBrowser";
+import isString from "@koine/utils/isString";
+var methodsMap = { g: "getItem", s: "setItem", r: "removeItem" };
+export var storageClient = function (useSessionStorage) {
+    var nativeMethod = function (method, key, value) {
+        return isBrowser
+            ? window[useSessionStorage ? "sessionStorage" : "localStorage"][methodsMap[method]](key, value)
+            : function () {
+                if (process.env["NODE_ENV"] !== "production") {
+                    console.warn("[@koine/utils:storageClient]: ".concat(useSessionStorage ? "sessionStorage" : "localStorage", " does not exists outside of browser."));
+                }
+            };
+    };
+    var get = function (key, transform, defaultValue) {
+        var value = defaultValue !== null && defaultValue !== void 0 ? defaultValue : null;
+        if (process.env["NODE_ENV"] !== "production") {
+            if (!isBrowser) {
+                console.log("[@koine/utils:storage] called 'get' outside of browser with default value '".concat(JSON.stringify(defaultValue), "'."));
+            }
+        }
+        if (isBrowser) {
+            var stored = nativeMethod("g", key);
+            if (stored) {
+                stored = transform ? transform(stored) : stored;
+                try {
+                    var parsed = JSON.parse(stored);
+                    if (parsed)
+                        value = parsed;
+                }
+                catch (_e) {
+                    value = stored;
+                }
+            }
+        }
+        return value;
+    };
+    var set = function (key, value, transform) {
+        if (transform === void 0) { transform = function (value) { return value; }; }
+        if (process.env["NODE_ENV"] !== "production") {
+            if (!isBrowser) {
+                console.log("[@koine/utils:storage] called 'set' outside of browser does not work.");
+            }
+        }
+        if (isBrowser) {
+            try {
+                var transformedValue = isString(value)
+                    ? transform(value)
+                    : transform(JSON.stringify(value));
+                nativeMethod("s", key, transformedValue);
+            }
+            catch (_e) {
+                if (process.env["NODE_ENV"] !== "production") {
+                    console.warn("[@koine/utils:createStorage]: 'set' error.", _e);
+                }
+            }
+        }
+    };
+    var remove = function (key) {
+        if (process.env["NODE_ENV"] !== "production") {
+            if (!isBrowser) {
+                console.log("[@koine/utils:storage] called 'remove' outside of browser does not work.");
+            }
+        }
+        if (isBrowser) {
+            try {
+                nativeMethod("r", key);
+            }
+            catch (_e) {
+                if (process.env["NODE_ENV"] !== "production") {
+                    console.warn("[@koine/utils:createStorage]: 'remove' error.", _e);
+                }
+            }
+        }
+    };
+    var has = function (key, defaultValue) {
+        var value = defaultValue !== null && defaultValue !== void 0 ? defaultValue : false;
+        if (process.env["NODE_ENV"] !== "production") {
+            if (!isBrowser) {
+                console.log("[@koine/utils:storage] called 'has' outside of browser with default value '".concat(JSON.stringify(defaultValue), "'."));
+            }
+        }
+        if (isBrowser) {
+            var stored = nativeMethod("g", key);
+            value = stored !== null && stored !== void 0 ? stored : false;
+        }
+        return value;
+    };
+    return {
+        get: get,
+        set: set,
+        remove: remove,
+        has: has,
+    };
+};
+export default storageClient;

package/README.md

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

package/createStorage.mjs

@@ -1,133 +0,0 @@
-import decode from "@koine/utils/decode";
-import encode from "@koine/utils/encode";
-import isBrowser from "@koine/utils/isBrowser";
-import isNullOrUndefined from "@koine/utils/isNullOrUndefined";
-import noop from "@koine/utils/noop";
-import on from "@koine/dom/on";
-import storage from "./storage";
-/**
- * Utility to create a storage instance to interact with `localStorage` using
- * encrypted (encoded) key/values.
- *
- * @category storage
- */ export const createStorage = (config, useSessionStorage)=>{
-    const client = useSessionStorage ? storage.s : storage.l;
-    const keys = Object.keys(config).reduce((map, key)=>({
-            ...map,
-            [key]: encode(key)
-        }), {});
-    return {
-        /**
-     * Get all storage value (it uses `localStorage.get()`).
-     *
-     * Unparseable values with `JSON.parse()` return their value as it is.
-     * On ssr or if the given `key` argument is not found `defaultValue` is
-     * returned, otherwise `null`.
-     */ get (key, defaultValue) {
-            return client.get(keys[key], decode, defaultValue);
-        },
-        /**
-     * Get all storage values (it uses `localStorage.get()`).
-     *
-     * `undefined` and `null` values are not returned.
-     */ getAll (defaultValues) {
-            if (!isBrowser) {
-                if (process.env["NODE_ENV"] !== "production") {
-                    console.log(`[@koine/utils:createStorage] attempt to use 'getAll' outside of browser.`);
-                }
-                return {};
-            }
-            const all = {};
-            for(const key in keys){
-                const value = this.get(key);
-                const defaultValue = defaultValues?.[key];
-                if (!isNullOrUndefined(value)) {
-                    all[key] = value;
-                } else if (defaultValue) {
-                    // NOTE: without the assertion typedoc does not compile
-                    all[key] = defaultValue;
-                }
-            }
-            return all;
-        },
-        /**
-     * Set a storage value (it uses `localStorage.set()`).
-     *
-     * Non-string values are stringified with `JSON.stringify()`
-     */ set (key, value) {
-            client.set(keys[key], value, encode);
-        },
-        /**
-     * 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) {
-            if (process.env["NODE_ENV"] !== "production") {
-                if (!isBrowser) {
-                    console.log(`[@koine/utils:createStorage] attempt to use 'setMany' outside of browser.`);
-                }
-            }
-            if (isBrowser) {
-                for(const key in newValues){
-                    const 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 (key) {
-            return client.has(keys[key]);
-        },
-        /**
-     * Remove a storage value (it uses `localStorage.remove()`).
-     */ remove (key) {
-            client.remove(keys[key]);
-        },
-        /**
-     * Clear all storage values (it uses `localStorage.remove()`).
-     */ clear () {
-            if (process.env["NODE_ENV"] !== "production") {
-                if (!isBrowser) {
-                    console.log(`[@koine/utils:createStorage] attempt to use 'clear' outside of browser.`);
-                }
-            }
-            if (isBrowser) {
-                for(const key in keys){
-                    client.remove(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: (keyToWatch, onRemoved, onAdded)=>{
-            if (!isBrowser) {
-                if (process.env["NODE_ENV"] !== "production") {
-                    console.log(`[@koine/utils:createStorage] attempt to use 'watch' outside of browser.`);
-                }
-                return noop;
-            }
-            const handler = (event)=>{
-                const { key, oldValue, newValue } = event;
-                if (key === keys[keyToWatch]) {
-                    if (oldValue && !newValue) {
-                        onRemoved?.();
-                    } else if (!oldValue && newValue) {
-                        onAdded?.();
-                    }
-                }
-            };
-            const listener = on(window, "storage", handler);
-            return listener;
-        }
-    };
-};
-export default createStorage;

package/getZonedDate.mjs

@@ -1,31 +0,0 @@
-import utcToZonedTime from "date-fns-tz/utcToZonedTime";
-import isBrowser from "@koine/utils/isBrowser";
-/**
- * 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.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.mjs

@@ -1,23 +0,0 @@
-import isUndefined from "@koine/utils/isUndefined";
-/**
- * @category analytics-google
- */ export const gtagPageview = (...args)=>{
-    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
-        });
-    }
-};
-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.mjs

@@ -1,15 +0,0 @@
-export { createStorage } from "./createStorage";
-export { getZonedDate } from "./getZonedDate";
-export { gtagPageview } from "./gtagPageview";
-export { isIE } from "./isIE";
-export { isMobile } from "./isMobile";
-export { navigateToHash } from "./navigateToHash";
-export { navigateToHashParams } from "./navigateToHashParams";
-export { navigateToMergedHashParams } from "./navigateToMergedHashParams";
-export { navigateToMergedParams } from "./navigateToMergedParams";
-export { navigateToParams } from "./navigateToParams";
-export { navigateToUrl } from "./navigateToUrl";
-export { navigateWithoutUrlParam } from "./navigateWithoutUrlParam";
-export { redirectTo } from "./redirectTo";
-export { storage } from "./storage";
-export { storageClient } from "./storageClient";

package/isMobile.mjs

@@ -1,14 +0,0 @@
-import isServer from "@koine/utils/isServer";
-/**
- * @category detect
- * @category is
- * @see https://stackoverflow.com/a/3540295
- */ export function isMobile(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.mjs

@@ -1,11 +0,0 @@
-import navigateToUrl from "./navigateToUrl";
-/**
- * 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 = "") {
-    const { pathname, search } = location;
-    navigateToUrl(pathname + (search ? "?" + search : "") + (hash ? "#" + hash : ""), true);
-}
-export default navigateToHash;

package/navigateToHashParams.mjs

@@ -1,19 +0,0 @@
-import buildUrlQueryString from "@koine/utils/buildUrlQueryString";
-import getUrlHashPathname from "@koine/utils/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 = "") {
-    const useLocation = !hash;
-    hash = hash || location.hash;
-    const hashQueryLess = getUrlHashPathname(hash);
-    const queryString = typeof params === "string" ? params : buildUrlQueryString(params);
-    const newHash = "#/" + hashQueryLess + queryString;
-    if (useLocation) {
-        location.hash = newHash;
-    }
-    return newHash;
-}
-export default navigateToHashParams;

package/navigateToMergedParams.mjs

@@ -1,12 +0,0 @@
-import getUrlQueryParams from "@koine/utils/getUrlQueryParams";
-import mergeUrlQueryParams from "@koine/utils/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) {
-    return navigateToParams(mergeUrlQueryParams(getUrlQueryParams(), params), replace);
-}
-export default navigateToMergedParams;

package/navigateToParams.mjs

@@ -1,17 +0,0 @@
-import buildUrlQueryString from "@koine/utils/buildUrlQueryString";
-import isBrowser from "@koine/utils/isBrowser";
-import navigateToUrl from "./navigateToUrl";
-/**
- * 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) {
-    const queryString = typeof params === "string" ? params : buildUrlQueryString(params);
-    if (isBrowser) {
-        navigateToUrl(location.pathname + queryString, replace);
-    }
-    return queryString;
-}
-export default navigateToParams;

package/navigateToUrl.mjs

@@ -1,10 +0,0 @@
-/**
- * It updates the browser's location URL with global `history` object
- *
- * @category location
- */ export function navigateToUrl(url = "", replace) {
-    if (url) {
-        history[replace ? "replaceState" : "pushState"](history.state, "", url);
-    }
-}
-export default navigateToUrl;

package/navigateWithoutUrlParam.mjs

@@ -1,18 +0,0 @@
-import getUrlQueryParams from "@koine/utils/getUrlQueryParams";
-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) {
-    const params = {};
-    const currentParams = getUrlQueryParams();
-    for(const key in currentParams){
-        if (key !== paramName) {
-            params[key] = currentParams[key];
-        }
-    }
-    return navigateToParams(params, replace);
-}
-export default navigateWithoutUrlParam;

package/redirectTo.mjs

@@ -1,14 +0,0 @@
-import buildUrlQueryString from "@koine/utils/buildUrlQueryString";
-import isBrowser from "@koine/utils/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) {
-        const queryString = buildUrlQueryString(params);
-        location.href = url.replace(/\?+$/g, "") + queryString;
-    }
-}
-export default redirectTo;

package/storage.mjs

@@ -1,10 +0,0 @@
-import storageClient from "./storageClient";
-/**
- * Storage, for `localStorage` and `sessionStorage`
- *
- * @category storage
- */ export const storage = {
-    l: storageClient(),
-    s: storageClient(true)
-};
-export default storage;

package/storageClient.mjs

@@ -1,97 +0,0 @@
-import isBrowser from "@koine/utils/isBrowser";
-import isString from "@koine/utils/isString";
-const methodsMap = {
-    g: "getItem",
-    s: "setItem",
-    r: "removeItem"
-};
-/**
- * Super minifiable `local/session Storage` client creator with SSR safety
- *
- * @category storage
- */ export const storageClient = (useSessionStorage)=>{
-    const nativeMethod = (method, key, value)=>isBrowser ? window[useSessionStorage ? "sessionStorage" : "localStorage"][methodsMap[method]](key, value) : ()=>{
-            if (process.env["NODE_ENV"] !== "production") {
-                console.warn(`[@koine/utils:storageClient]: ${useSessionStorage ? "sessionStorage" : "localStorage"} does not exists outside of browser.`);
-            }
-        };
-    const get = (key, transform, defaultValue)=>{
-        let value = defaultValue ?? null;
-        if (process.env["NODE_ENV"] !== "production") {
-            if (!isBrowser) {
-                console.log(`[@koine/utils:storage] called 'get' outside of browser with default value '${JSON.stringify(defaultValue)}'.`);
-            }
-        }
-        if (isBrowser) {
-            let stored = nativeMethod("g", key);
-            if (stored) {
-                stored = transform ? transform(stored) : stored;
-                try {
-                    const parsed = JSON.parse(stored);
-                    if (parsed) value = parsed;
-                } catch (_e) {
-                    value = stored;
-                // if (process.env["NODE_ENV"] !== "production") {
-                //   console.warn(
-                //     `[@koine/utils:storage]: 'get' failed to parse stored value as JSON. Plain '${stored}' value is returned.`
-                //   );
-                // }
-                }
-            }
-        }
-        return value;
-    };
-    const set = (key, value, transform = (value)=>value)=>{
-        if (process.env["NODE_ENV"] !== "production") {
-            if (!isBrowser) {
-                console.log(`[@koine/utils:storage] called 'set' outside of browser does not work.`);
-            }
-        }
-        if (isBrowser) {
-            try {
-                const transformedValue = isString(value) ? transform(value) : transform(JSON.stringify(value));
-                nativeMethod("s", key, transformedValue);
-            } catch (_e) {
-                if (process.env["NODE_ENV"] !== "production") {
-                    console.warn(`[@koine/utils:createStorage]: 'set' error.`, _e);
-                }
-            }
-        }
-    };
-    const remove = (key)=>{
-        if (process.env["NODE_ENV"] !== "production") {
-            if (!isBrowser) {
-                console.log(`[@koine/utils:storage] called 'remove' outside of browser does not work.`);
-            }
-        }
-        if (isBrowser) {
-            try {
-                nativeMethod("r", key);
-            } catch (_e) {
-                if (process.env["NODE_ENV"] !== "production") {
-                    console.warn(`[@koine/utils:createStorage]: 'remove' error.`, _e);
-                }
-            }
-        }
-    };
-    const has = (key, defaultValue)=>{
-        let value = defaultValue ?? false;
-        if (process.env["NODE_ENV"] !== "production") {
-            if (!isBrowser) {
-                console.log(`[@koine/utils:storage] called 'has' outside of browser with default value '${JSON.stringify(defaultValue)}'.`);
-            }
-        }
-        if (isBrowser) {
-            const stored = nativeMethod("g", key);
-            value = stored ?? false;
-        }
-        return value;
-    };
-    return {
-        get,
-        set,
-        remove,
-        has
-    };
-};
-export default storageClient;