@koine/browser 2.0.0-alpha.4 → 2.0.0-beta.10

package/createStorage.d.ts

@@ -1,7 +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) => {
     /**

package/createStorage.js

@@ -1,147 +1,147 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createStorage = void 0;
-var tslib_1 = require("tslib");
-var decode_1 = tslib_1.__importDefault(require("@koine/utils/decode"));
-var encode_1 = tslib_1.__importDefault(require("@koine/utils/encode"));
-var isBrowser_1 = tslib_1.__importDefault(require("@koine/utils/isBrowser"));
-var isNullOrUndefined_1 = tslib_1.__importDefault(require("@koine/utils/isNullOrUndefined"));
-var noop_1 = tslib_1.__importDefault(require("@koine/utils/noop"));
-var on_1 = tslib_1.__importDefault(require("@koine/dom/on"));
-var storage_1 = tslib_1.__importDefault(require("./storage"));
-/**
- * Utility to create a storage instance to interact with `localStorage` using
- * encrypted (encoded) key/values.
- */
-var createStorage = function (config, useSessionStorage) {
-    var client = useSessionStorage ? storage_1.default.s : storage_1.default.l;
-    var keys = Object.keys(config).reduce(function (map, key) {
-        var _a;
-        return (tslib_1.__assign(tslib_1.__assign({}, map), (_a = {}, _a[key] = (0, encode_1.default)(key), _a)));
-    }, {});
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    createStorage: function() {
+        return createStorage;
+    },
+    default: function() {
+        return _default;
+    }
+});
+const _interop_require_default = require("@swc/helpers/_/_interop_require_default");
+const _decode = /*#__PURE__*/ _interop_require_default._(require("@koine/utils/decode"));
+const _encode = /*#__PURE__*/ _interop_require_default._(require("@koine/utils/encode"));
+const _isBrowser = /*#__PURE__*/ _interop_require_default._(require("@koine/utils/isBrowser"));
+const _isNullOrUndefined = /*#__PURE__*/ _interop_require_default._(require("@koine/utils/isNullOrUndefined"));
+const _noop = /*#__PURE__*/ _interop_require_default._(require("@koine/utils/noop"));
+const _on = /*#__PURE__*/ _interop_require_default._(require("@koine/dom/on"));
+const _storage = /*#__PURE__*/ _interop_require_default._(require("./storage"));
+const createStorage = (config, useSessionStorage)=>{
+    const client = useSessionStorage ? _storage.default.s : _storage.default.l;
+    const keys = Object.keys(config).reduce((map, key)=>({
+            ...map,
+            [key]: (0, _encode.default)(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: function (key, defaultValue) {
-            return client.get(keys[key], decode_1.default, defaultValue);
+     * 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.default, defaultValue);
         },
         /**
-         * Get all storage values (it uses `localStorage.get()`).
-         *
-         * `undefined` and `null` values are not returned.
-         */
-        getAll: function (defaultValues) {
-            if (!isBrowser_1.default) {
+     * Get all storage values (it uses `localStorage.get()`).
+     *
+     * `undefined` and `null` values are not returned.
+     */ getAll (defaultValues) {
+            if (!_isBrowser.default) {
                 if (process.env["NODE_ENV"] !== "production") {
-                    console.log("[@koine/utils:createStorage] attempt to use 'getAll' outside of browser.");
+                    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 (!(0, isNullOrUndefined_1.default)(value)) {
+            const all = {};
+            for(const key in keys){
+                const value = this.get(key);
+                const defaultValue = defaultValues?.[key];
+                if (!(0, _isNullOrUndefined.default)(value)) {
                     all[key] = value;
-                }
-                else if (defaultValue) {
+                } 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: function (key, value) {
-            client.set(keys[key], value, encode_1.default);
+     * 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.default);
         },
         /**
-         * 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) {
+     * 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_1.default) {
-                    console.log("[@koine/utils:createStorage] attempt to use 'setMany' outside of browser.");
+                if (!_isBrowser.default) {
+                    console.log(`[@koine/utils:createStorage] attempt to use 'setMany' outside of browser.`);
                 }
             }
-            if (isBrowser_1.default) {
-                for (var key in newValues) {
-                    var value = newValues[key];
-                    if (!(0, isNullOrUndefined_1.default)(value)) {
+            if (_isBrowser.default) {
+                for(const key in newValues){
+                    const value = newValues[key];
+                    if (!(0, _isNullOrUndefined.default)(value)) {
                         this.set(key, value);
-                    }
-                    else {
+                    } else {
                         this.remove(key);
                     }
                 }
             }
         },
         /**
-         * Check if a storage value is _truthy_ (it uses `localStorage.get()`).
-         */
-        has: function (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: function (key) {
+     * Remove a storage value (it uses `localStorage.remove()`).
+     */ remove (key) {
             client.remove(keys[key]);
         },
         /**
-         * Clear all storage values (it uses `localStorage.remove()`).
-         */
-        clear: function () {
+     * Clear all storage values (it uses `localStorage.remove()`).
+     */ clear () {
             if (process.env["NODE_ENV"] !== "production") {
-                if (!isBrowser_1.default) {
-                    console.log("[@koine/utils:createStorage] attempt to use 'clear' outside of browser.");
+                if (!_isBrowser.default) {
+                    console.log(`[@koine/utils:createStorage] attempt to use 'clear' outside of browser.`);
                 }
             }
-            if (isBrowser_1.default) {
-                for (var key in keys) {
+            if (_isBrowser.default) {
+                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: function (keyToWatch, onRemoved, onAdded) {
-            if (!isBrowser_1.default) {
+     * 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.default) {
                 if (process.env["NODE_ENV"] !== "production") {
-                    console.log("[@koine/utils:createStorage] attempt to use 'watch' outside of browser.");
+                    console.log(`[@koine/utils:createStorage] attempt to use 'watch' outside of browser.`);
                 }
-                return noop_1.default;
+                return _noop.default;
             }
-            var handler = function (event) {
-                var key = event.key, oldValue = event.oldValue, newValue = event.newValue;
+            const handler = (event)=>{
+                const { key, oldValue, newValue } = event;
                 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();
+                        onRemoved?.();
+                    } else if (!oldValue && newValue) {
+                        onAdded?.();
                     }
                 }
             };
-            var listener = (0, on_1.default)(window, "storage", handler);
+            const listener = (0, _on.default)(window, "storage", handler);
             return listener;
-        },
+        }
     };
 };
-exports.createStorage = createStorage;
-exports.default = exports.createStorage;
+const _default = createStorage;

package/createStorage.mjs

@@ -1,4 +1,3 @@
-import { __assign } from "tslib";
 import decode from "@koine/utils/decode";
 import encode from "@koine/utils/encode";
 import isBrowser from "@koine/utils/isBrowser";
@@ -9,135 +8,126 @@ import storage from "./storage";
 /**
  * Utility to create a storage instance to interact with `localStorage` using
  * encrypted (encoded) key/values.
- */
-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)));
-    }, {});
+ *
+ * @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: function (key, defaultValue) {
+     * 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: function (defaultValues) {
+     * 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.");
+                    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];
+            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) {
+                } 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: function (key, value) {
+     * 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: function (newValues) {
+     * 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.");
+                    console.log(`[@koine/utils:createStorage] attempt to use 'setMany' outside of browser.`);
                 }
             }
             if (isBrowser) {
-                for (var key in newValues) {
-                    var value = newValues[key];
+                for(const key in newValues){
+                    const value = newValues[key];
                     if (!isNullOrUndefined(value)) {
                         this.set(key, value);
-                    }
-                    else {
+                    } else {
                         this.remove(key);
                     }
                 }
             }
         },
         /**
-         * Check if a storage value is _truthy_ (it uses `localStorage.get()`).
-         */
-        has: function (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: function (key) {
+     * Remove a storage value (it uses `localStorage.remove()`).
+     */ remove (key) {
             client.remove(keys[key]);
         },
         /**
-         * Clear all storage values (it uses `localStorage.remove()`).
-         */
-        clear: function () {
+     * 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.");
+                    console.log(`[@koine/utils:createStorage] attempt to use 'clear' outside of browser.`);
                 }
             }
             if (isBrowser) {
-                for (var key in keys) {
+                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: function (keyToWatch, onRemoved, onAdded) {
+     * 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.");
+                    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;
+            const handler = (event)=>{
+                const { key, oldValue, newValue } = event;
                 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();
+                        onRemoved?.();
+                    } else if (!oldValue && newValue) {
+                        onAdded?.();
                     }
                 }
             };
-            var listener = on(window, "storage", handler);
+            const listener = on(window, "storage", handler);
             return listener;
-        },
+        }
     };
 };
 export default createStorage;

package/getZonedDate.js

@@ -1,42 +1,37 @@
 "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 isBrowser_1 = tslib_1.__importDefault(require("@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.
- */
-function getZonedDate(dateString, timeZone) {
-    if (dateString === void 0) { dateString = ""; }
-    if (!dateString.endsWith("Z"))
-        dateString += "Z";
-    if (!timeZone && isBrowser_1.default) {
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    getZonedDate: function() {
+        return getZonedDate;
+    },
+    default: function() {
+        return _default;
+    }
+});
+const _interop_require_default = require("@swc/helpers/_/_interop_require_default");
+const _utcToZonedTime = /*#__PURE__*/ _interop_require_default._(require("date-fns-tz/utcToZonedTime"));
+const _isBrowser = /*#__PURE__*/ _interop_require_default._(require("@koine/utils/isBrowser"));
+function getZonedDate(dateString = "", timeZone) {
+    if (!dateString.endsWith("Z")) dateString += "Z";
+    if (!timeZone && _isBrowser.default) {
         try {
             timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;
-        }
-        catch (e) {
+        } 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
+        // 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);
+    return timeZone ? (0, _utcToZonedTime.default)(new Date(dateString), timeZone) : new Date(dateString);
 }
-exports.getZonedDate = getZonedDate;
-exports.default = getZonedDate;
+const _default = getZonedDate;

package/getZonedDate.mjs

@@ -13,25 +13,19 @@ import isBrowser from "@koine/utils/isBrowser";
  *
  * @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";
+ */ export function getZonedDate(dateString = "", timeZone) {
+    if (!dateString.endsWith("Z")) dateString += "Z";
     if (!timeZone && isBrowser) {
         try {
             timeZone = Intl.DateTimeFormat().resolvedOptions().timeZone;
-        }
-        catch (e) {
+        } 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
+        // 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);
+    return timeZone ? utcToZonedTime(new Date(dateString), timeZone) : new Date(dateString);
 }
 export default getZonedDate;

package/gtagPageview.js

@@ -1,35 +1,41 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.gtagPageview = void 0;
-var tslib_1 = require("tslib");
-var isUndefined_1 = tslib_1.__importDefault(require("@koine/utils/isUndefined"));
-/**
- * @category analytics-google
- */
-var gtagPageview = function () {
-    var args = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        args[_i] = arguments[_i];
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    gtagPageview: function() {
+        return gtagPageview;
+    },
+    default: function() {
+        return _default // 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);
+         //   }
+         // };
+        ;
     }
-    if (!(0, isUndefined_1.default)(window) && !(0, isUndefined_1.default)(window.gtag)) {
+});
+const _interop_require_default = require("@swc/helpers/_/_interop_require_default");
+const _isUndefined = /*#__PURE__*/ _interop_require_default._(require("@koine/utils/isUndefined"));
+const gtagPageview = (...args)=>{
+    if (!(0, _isUndefined.default)(window) && !(0, _isUndefined.default)(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>'
+            page_location: args[2] || location.href
         });
     }
 };
-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);
-//   }
-// };
+const _default = gtagPageview;