@koine/browser 2.0.0-beta.8 → 2.0.0-beta.80

package/README.md

@@ -1 +1 @@
-# @koine/browser
+# @koine/i18n

package/createStorage.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./createStorage";
+export { default } from "./createStorage";

package/createStorage.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./createStorage.cjs.js').default;

package/createStorage.cjs.js

@@ -0,0 +1,101 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils = require('@koine/utils');
+var dom = require('@koine/dom');
+var storage = require('./storage.cjs.js');
+require('./storageClient.cjs.js');
+
+let createStorage = (config, useSessionStorage) => {
+    const client = useSessionStorage ? storage.storage.s : storage.storage.l;
+    const keys = Object.keys(config).reduce((map, key) => ({ ...map, [key]: utils.encode(key) }), {});
+    return {
+        get(key, defaultValue) {
+            return client.get(keys[key], utils.decode, defaultValue);
+        },
+        getAll(defaultValues) {
+            if (!utils.isBrowser) {
+                if (process.env["NODE_ENV"] === "development") {
+                    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 (!utils.isNullOrUndefined(value)) {
+                    all[key] = value;
+                }
+                else if (defaultValue) {
+                    all[key] = defaultValue;
+                }
+            }
+            return all;
+        },
+        set(key, value) {
+            client.set(keys[key], value, utils.encode);
+        },
+        setMany(newValues) {
+            if (process.env["NODE_ENV"] === "development") {
+                if (!utils.isBrowser) {
+                    console.log(`[@koine/utils:createStorage] attempt to use 'setMany' outside of browser.`);
+                }
+            }
+            if (utils.isBrowser) {
+                for (const key in newValues) {
+                    const value = newValues[key];
+                    if (!utils.isNullOrUndefined(value)) {
+                        this.set(key, value);
+                    }
+                    else {
+                        this.remove(key);
+                    }
+                }
+            }
+        },
+        has(key) {
+            return client.has(keys[key]);
+        },
+        remove(key) {
+            client.remove(keys[key]);
+        },
+        clear() {
+            if (process.env["NODE_ENV"] === "development") {
+                if (!utils.isBrowser) {
+                    console.log(`[@koine/utils:createStorage] attempt to use 'clear' outside of browser.`);
+                }
+            }
+            if (utils.isBrowser) {
+                for (const key in keys) {
+                    client.remove(keys[key]);
+                }
+            }
+        },
+        watch: (keyToWatch, onRemoved, onAdded) => {
+            if (!utils.isBrowser) {
+                if (process.env["NODE_ENV"] === "development") {
+                    console.log(`[@koine/utils:createStorage] attempt to use 'watch' outside of browser.`);
+                }
+                return utils.noop;
+            }
+            const handler = (event) => {
+                const { key, oldValue, newValue } = event;
+                if (key === keys[keyToWatch]) {
+                    if (oldValue && !newValue) {
+                        onRemoved?.();
+                    }
+                    else if (!oldValue && newValue) {
+                        onAdded?.();
+                    }
+                }
+            };
+            const listener = dom.on(window, "storage", handler);
+            return listener;
+        },
+    };
+};
+
+exports.createStorage = createStorage;
+exports["default"] = createStorage;

package/createStorage.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './createStorage.cjs.js';
+export { _default as default } from './createStorage.cjs.default.js';

package/createStorage.d.ts

@@ -1,54 +1,12 @@
 export 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>, 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`.
-     */
+export declare let createStorage: <T extends CreateStorageConfig>(config: Partial<T>, useSessionStorage?: boolean) => {
     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.esm.js

@@ -0,0 +1,96 @@
+import { encode, decode, isBrowser, isNullOrUndefined, noop } from '@koine/utils';
+import { on } from '@koine/dom';
+import { storage } from './storage.esm.js';
+import './storageClient.esm.js';
+
+let createStorage = (config, useSessionStorage) => {
+    const client = useSessionStorage ? storage.s : storage.l;
+    const keys = Object.keys(config).reduce((map, key) => ({ ...map, [key]: encode(key) }), {});
+    return {
+        get(key, defaultValue) {
+            return client.get(keys[key], decode, defaultValue);
+        },
+        getAll(defaultValues) {
+            if (!isBrowser) {
+                if (process.env["NODE_ENV"] === "development") {
+                    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) {
+                    all[key] = defaultValue;
+                }
+            }
+            return all;
+        },
+        set(key, value) {
+            client.set(keys[key], value, encode);
+        },
+        setMany(newValues) {
+            if (process.env["NODE_ENV"] === "development") {
+                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);
+                    }
+                }
+            }
+        },
+        has(key) {
+            return client.has(keys[key]);
+        },
+        remove(key) {
+            client.remove(keys[key]);
+        },
+        clear() {
+            if (process.env["NODE_ENV"] === "development") {
+                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: (keyToWatch, onRemoved, onAdded) => {
+            if (!isBrowser) {
+                if (process.env["NODE_ENV"] === "development") {
+                    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 { createStorage, createStorage as default };

package/getZonedDate.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./getZonedDate";
+export { default } from "./getZonedDate";

package/getZonedDate.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./getZonedDate.cjs.js').default;

package/getZonedDate.cjs.js

@@ -0,0 +1,29 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils = require('@koine/utils');
+
+const utcToZonedTime = (date, _tz) => {
+    return date;
+};
+let getZonedDate = (dateString = "", timeZone) => {
+    if (!dateString.endsWith("Z"))
+        dateString += "Z";
+    if (!timeZone && utils.isBrowser) {
+        try {
+            timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+        }
+        catch (e) {
+            if (process.env["NODE_ENV"] === "development") {
+                console.warn("[@koine/browser:getZonedDate] failed reading timeZone, error", e);
+            }
+        }
+    }
+    return timeZone
+        ? utcToZonedTime(new Date(dateString))
+        : new Date(dateString);
+};
+
+exports["default"] = getZonedDate;
+exports.getZonedDate = getZonedDate;

package/getZonedDate.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './getZonedDate.cjs.js';
+export { _default as default } from './getZonedDate.cjs.default.js';

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 declare let getZonedDate: (dateString?: string, timeZone?: string) => Date;
 export default getZonedDate;

package/getZonedDate.esm.js

@@ -0,0 +1,24 @@
+import { isBrowser } from '@koine/utils';
+
+const utcToZonedTime = (date, _tz) => {
+    return date;
+};
+let 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"] === "development") {
+                console.warn("[@koine/browser:getZonedDate] failed reading timeZone, error", e);
+            }
+        }
+    }
+    return timeZone
+        ? utcToZonedTime(new Date(dateString))
+        : new Date(dateString);
+};
+
+export { getZonedDate as default, getZonedDate };

package/gtag.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./gtag";
+export { default } from "./gtag";

package/gtag.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./gtag.cjs.js').default;

package/gtag.cjs.js

@@ -0,0 +1,15 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils = require('@koine/utils');
+
+let gtag = (...args) => {
+    !utils.isUndefined(window) && !utils.isUndefined(window.gtag)
+        ?
+            window.gtag(...args)
+        : utils.noop();
+};
+
+exports["default"] = gtag;
+exports.gtag = gtag;

package/gtag.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './gtag.cjs.js';
+export { _default as default } from './gtag.cjs.default.js';

package/gtag.d.ts

@@ -0,0 +1,2 @@
+export declare let gtag: <T extends unknown[]>(...args: T) => void;
+export default gtag;

package/gtag.esm.js

@@ -0,0 +1,10 @@
+import { isUndefined, noop } from '@koine/utils';
+
+let gtag = (...args) => {
+    !isUndefined(window) && !isUndefined(window.gtag)
+        ?
+            window.gtag(...args)
+        : noop();
+};
+
+export { gtag as default, gtag };

package/gtagPageview.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./gtagPageview";
+export { default } from "./gtagPageview";

package/gtagPageview.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./gtagPageview.cjs.js').default;

package/gtagPageview.cjs.js

@@ -0,0 +1,15 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var gtag = require('./gtag.cjs.js');
+require('@koine/utils');
+
+let gtagPageview = (...args) => gtag.gtag("event", "page_view", {
+    page_path: args[0] || location.pathname,
+    page_title: args[1] || document.title,
+    page_location: args[2] || location.href,
+});
+
+exports["default"] = gtagPageview;
+exports.gtagPageview = gtagPageview;

package/gtagPageview.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './gtagPageview.cjs.js';
+export { _default as default } from './gtagPageview.cjs.default.js';

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 declare let gtagPageview: (page_path?: string | undefined, page_title?: string | undefined, page_location?: string | undefined) => void;
 export default gtagPageview;

package/gtagPageview.esm.js

@@ -0,0 +1,10 @@
+import { gtag } from './gtag.esm.js';
+import '@koine/utils';
+
+let gtagPageview = (...args) => gtag("event", "page_view", {
+    page_path: args[0] || location.pathname,
+    page_title: args[1] || document.title,
+    page_location: args[2] || location.href,
+});
+
+export { gtagPageview as default, gtagPageview };

package/index.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./index";

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;

package/index.cjs.js

@@ -0,0 +1,45 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var createStorage = require('./createStorage.cjs.js');
+var getZonedDate = require('./getZonedDate.cjs.js');
+var gtag = require('./gtag.cjs.js');
+var gtagPageview = require('./gtagPageview.cjs.js');
+var isIE = require('./isIE.cjs.js');
+var isMobile = require('./isMobile.cjs.js');
+var listenUrlSearch = require('./listenUrlSearch.cjs.js');
+var listenUrlSearchParams = require('./listenUrlSearchParams.cjs.js');
+var navigateToHash = require('./navigateToHash.cjs.js');
+var navigateToHashParams = require('./navigateToHashParams.cjs.js');
+var navigateToMergedHashParams = require('./navigateToMergedHashParams.cjs.js');
+var navigateToMergedParams = require('./navigateToMergedParams.cjs.js');
+var navigateToParams = require('./navigateToParams.cjs.js');
+var navigateToUrl = require('./navigateToUrl.cjs.js');
+var navigateWithoutUrlParam = require('./navigateWithoutUrlParam.cjs.js');
+var storage = require('./storage.cjs.js');
+var redirectTo = require('./redirectTo.cjs.js');
+var storageClient = require('./storageClient.cjs.js');
+require('@koine/utils');
+require('@koine/dom');
+
+
+
+exports.createStorage = createStorage.createStorage;
+exports.getZonedDate = getZonedDate.getZonedDate;
+exports.gtag = gtag.gtag;
+exports.gtagPageview = gtagPageview.gtagPageview;
+exports.isIE = isIE.isIE;
+exports.isMobile = isMobile.isMobile;
+exports.listenUrlSearch = listenUrlSearch.listenUrlSearch;
+exports.listenUrlSearchParams = listenUrlSearchParams.listenUrlSearchParams;
+exports.navigateToHash = navigateToHash.navigateToHash;
+exports.navigateToHashParams = navigateToHashParams.navigateToHashParams;
+exports.navigateToMergedHashParams = navigateToMergedHashParams.navigateToMergedHashParams;
+exports.navigateToMergedParams = navigateToMergedParams.navigateToMergedParams;
+exports.navigateToParams = navigateToParams.navigateToParams;
+exports.navigateToUrl = navigateToUrl.navigateToUrl;
+exports.navigateWithoutUrlParam = navigateWithoutUrlParam.navigateWithoutUrlParam;
+exports.storage = storage.storage;
+exports.redirectTo = redirectTo.redirectTo;
+exports.storageClient = storageClient.storageClient;

package/index.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './index.cjs.js';
+export { _default as default } from './index.cjs.default.js';

package/index.d.ts

@@ -1,8 +1,11 @@
 export { createStorage, type CreateStorageConfig } from "./createStorage";
 export { getZonedDate } from "./getZonedDate";
+export { gtag } from "./gtag";
 export { gtagPageview, type GtmPageviewArgs } from "./gtagPageview";
 export { isIE } from "./isIE";
 export { isMobile } from "./isMobile";
+export { listenUrlSearch } from "./listenUrlSearch";
+export { listenUrlSearchParams } from "./listenUrlSearchParams";
 export { navigateToHash } from "./navigateToHash";
 export { navigateToHashParams } from "./navigateToHashParams";
 export { navigateToMergedHashParams } from "./navigateToMergedHashParams";
@@ -10,6 +13,6 @@ 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 { redirectTo } from "./redirectTo";
 export { storageClient, type StorageClientConfig } from "./storageClient";

package/index.esm.js

@@ -0,0 +1,20 @@
+export { createStorage } from './createStorage.esm.js';
+export { getZonedDate } from './getZonedDate.esm.js';
+export { gtag } from './gtag.esm.js';
+export { gtagPageview } from './gtagPageview.esm.js';
+export { isIE } from './isIE.esm.js';
+export { isMobile } from './isMobile.esm.js';
+export { listenUrlSearch } from './listenUrlSearch.esm.js';
+export { listenUrlSearchParams } from './listenUrlSearchParams.esm.js';
+export { navigateToHash } from './navigateToHash.esm.js';
+export { navigateToHashParams } from './navigateToHashParams.esm.js';
+export { navigateToMergedHashParams } from './navigateToMergedHashParams.esm.js';
+export { navigateToMergedParams } from './navigateToMergedParams.esm.js';
+export { navigateToParams } from './navigateToParams.esm.js';
+export { navigateToUrl } from './navigateToUrl.esm.js';
+export { navigateWithoutUrlParam } from './navigateWithoutUrlParam.esm.js';
+export { storage } from './storage.esm.js';
+export { redirectTo } from './redirectTo.esm.js';
+export { storageClient } from './storageClient.esm.js';
+import '@koine/utils';
+import '@koine/dom';

package/isIE.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./isIE";
+export { default } from "./isIE";

package/isIE.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./isIE.cjs.js').default;

package/isIE.cjs.js

@@ -0,0 +1,19 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils = require('@koine/utils');
+
+let isIE = (ssrValue = true) => {
+    if (utils.isServer) {
+        return ssrValue;
+    }
+    const ua = window.navigator.userAgent;
+    if (ua.indexOf("MSIE ") > 0 || ua.indexOf("Trident/") > 0) {
+        return true;
+    }
+    return false;
+};
+
+exports["default"] = isIE;
+exports.isIE = isIE;

package/isIE.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './isIE.cjs.js';
+export { _default as default } from './isIE.cjs.default.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 declare let isIE: (ssrValue?: boolean) => boolean;
 export default isIE;

package/isIE.esm.js

@@ -0,0 +1,14 @@
+import { isServer } from '@koine/utils';
+
+let isIE = (ssrValue = true) => {
+    if (isServer) {
+        return ssrValue;
+    }
+    const ua = window.navigator.userAgent;
+    if (ua.indexOf("MSIE ") > 0 || ua.indexOf("Trident/") > 0) {
+        return true;
+    }
+    return false;
+};
+
+export { isIE as default, isIE };

package/isMobile.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./isMobile";
+export { default } from "./isMobile";

package/isMobile.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./isMobile.cjs.js').default;

package/isMobile.cjs.js

@@ -0,0 +1,13 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var utils = require('@koine/utils');
+
+let isMobile = (ssrValue = true) => utils.isServer
+    ? ssrValue
+    :
+        /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(window.navigator.userAgent);
+
+exports["default"] = isMobile;
+exports.isMobile = isMobile;

package/isMobile.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './isMobile.cjs.js';
+export { _default as default } from './isMobile.cjs.default.js';

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 declare let isMobile: (ssrValue?: boolean) => boolean;
 export default isMobile;

package/isMobile.esm.js

@@ -0,0 +1,8 @@
+import { isServer } from '@koine/utils';
+
+let isMobile = (ssrValue = true) => isServer
+    ? ssrValue
+    :
+        /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(window.navigator.userAgent);
+
+export { isMobile as default, isMobile };