@koine/browser 1.0.94 → 1.0.95

package/createStorage.d.ts

@@ -3,26 +3,27 @@ export declare type CreateStorageConfig = Record<string, any>;
  * Utility to create a storage instance to interact with `localStorage` using
  * encrypted (encoded) key/values.
  */
-export declare const createStorage: <T extends CreateStorageConfig>(config: Partial<T>) => {
+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.
-     * If the given `key` argument is not found `null` is returned.
+     * On ssr or if the given `key` argument is not found `defaultValue` is
+     * returned, otherwise `null`.
      */
-    get<TKey extends keyof T>(key: TKey): T[TKey] | null;
+    get<TKey extends keyof T>(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(): T;
+    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 keyof T>(key: TKey_1, value: T[TKey_1]): void;
+    set<TKey_1 extends Extract<keyof T, string>>(key: TKey_1, value: T[TKey_1]): void;
     /**
      * Set all given storage values (it uses `localStorage.set()`).
      *
@@ -33,11 +34,11 @@ export declare const createStorage: <T extends CreateStorageConfig>(config: Part
     /**
      * Check if a storage value is _truthy_ (it uses `localStorage.get()`).
      */
-    has<TKey_2 extends keyof T>(key: TKey_2): boolean;
+    has<TKey_2 extends Extract<keyof T, string>>(key: TKey_2): boolean;
     /**
      * Remove a storage value (it uses `localStorage.remove()`).
      */
-    remove<TKey_3 extends keyof T>(key: TKey_3): void;
+    remove<TKey_3 extends Extract<keyof T, string>>(key: TKey_3): void;
     /**
      * Clear all storage values (it uses `localStorage.remove()`).
      */

package/createStorage.js

@@ -1,24 +1,13 @@
 import { __assign } from "tslib";
-import { decode, encode, isBrowser, isNullOrUndefined, isString, } from "@koine/utils";
+import { decode, encode, isBrowser, isNullOrUndefined } from "@koine/utils";
 import { on } from "@koine/dom";
+import { storage } from "./storage";
 /**
  * Utility to create a storage instance to interact with `localStorage` using
  * encrypted (encoded) key/values.
  */
-export var createStorage = function (config) {
-    var methodsMap = { g: "getItem", s: "setItem", r: "removeItem" };
-    /**
-     * Super minifiable localStorage wrapper with SSR safety
-     */
-    var ls = function (method, key, value) {
-        return isBrowser
-            ? localStorage[methodsMap[method]](key, value)
-            : function () {
-                if (process.env["NODE_ENV"] !== "production") {
-                    console.warn("[@koine/utils] createStorage: localStorage does not exists in this environment.");
-                }
-            };
-    };
+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)));
@@ -28,33 +17,34 @@ export var createStorage = function (config) {
          * Get all storage value (it uses `localStorage.get()`).
          *
          * Unparseable values with `JSON.parse()` return their value as it is.
-         * If the given `key` argument is not found `null` is returned.
+         * On ssr or if the given `key` argument is not found `defaultValue` is
+         * returned, otherwise `null`.
          */
-        get: function (key) {
-            var stored = ls("g", keys[key]);
-            if (stored) {
-                stored = decode(stored);
-                try {
-                    return JSON.parse(stored);
-                }
-                catch (_e) {
-                    return stored;
-                }
-            }
-            return null;
+        get: function (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 () {
+        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 value = client.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;
         },
@@ -64,7 +54,7 @@ export var createStorage = function (config) {
          * Non-string values are stringified with `JSON.stringify()`
          */
         set: function (key, value) {
-            ls("s", keys[key], isString(value) ? encode(value) : encode(JSON.stringify(value)));
+            client.set(key, value, encode);
         },
         /**
          * Set all given storage values (it uses `localStorage.set()`).
@@ -73,13 +63,20 @@ export var createStorage = function (config) {
          * and `null` values are removed from the storage
          */
         setMany: function (newValues) {
-            for (var key in newValues) {
-                var value = newValues[key];
-                if (!isNullOrUndefined(value)) {
-                    this.set(key, value);
+            if (process.env["NODE_ENV"] !== "production") {
+                if (!isBrowser) {
+                    console.log("[@koine/utils:createStorage] attempt to use 'setMany' outside of browser.");
                 }
-                else {
-                    this.remove(key);
+            }
+            if (isBrowser) {
+                for (var key in newValues) {
+                    var value = newValues[key];
+                    if (!isNullOrUndefined(value)) {
+                        client.set(key, value);
+                    }
+                    else {
+                        client.remove(key);
+                    }
                 }
             }
         },
@@ -87,21 +84,27 @@ export var createStorage = function (config) {
          * Check if a storage value is _truthy_ (it uses `localStorage.get()`).
          */
         has: function (key) {
-            var stored = ls("g", keys[key]);
-            return !!stored;
+            return client.has(keys[key]);
         },
         /**
          * Remove a storage value (it uses `localStorage.remove()`).
          */
         remove: function (key) {
-            ls("r", keys[key]);
+            client.remove(keys[key]);
         },
         /**
          * Clear all storage values (it uses `localStorage.remove()`).
          */
         clear: function () {
-            for (var key in keys) {
-                ls("r", keys[key]);
+            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]);
+                }
             }
         },
         /**
@@ -111,6 +114,12 @@ export var createStorage = function (config) {
          * 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) {
+                if (process.env["NODE_ENV"] !== "production") {
+                    console.log("[@koine/utils:createStorage] attempt to use 'watch' outside of browser.");
+                }
+                return function () { return void 0; };
+            }
             var handler = function (event) {
                 var key = event.key, oldValue = event.oldValue, newValue = event.newValue;
                 if (key === keys[keyToWatch]) {
@@ -122,8 +131,6 @@ export var createStorage = function (config) {
                     }
                 }
             };
-            if (!isBrowser)
-                return function () { return void 0; };
             var listener = on(window, "storage", handler);
             return listener;
         },

package/index.d.ts

@@ -8,5 +8,6 @@ export * from "./navigateToHashParams";
 export * from "./navigateToMergedHashParams";
 export * from "./navigateToMergedParams";
 export * from "./navigateToParams";
+export * from "./navigateToUrl";
 export * from "./navigateWithoutUrlParam";
 export * from "./redirectTo";

package/index.js

@@ -8,5 +8,6 @@ export * from "./navigateToHashParams";
 export * from "./navigateToMergedHashParams";
 export * from "./navigateToMergedParams";
 export * from "./navigateToParams";
+export * from "./navigateToUrl";
 export * from "./navigateWithoutUrlParam";
 export * from "./redirectTo";

package/navigateToHash.js

@@ -1,3 +1,4 @@
+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"`
@@ -7,6 +8,6 @@
 export function navigateToHash(hash) {
     if (hash === void 0) { hash = ""; }
     var pathname = location.pathname, search = location.search;
-    history.replaceState(null, "", pathname + (search ? "?" + search : "") + "#" + hash);
+    navigateToUrl(pathname + (search ? "?" + search : "") + "#" + hash, true);
 }
 export default navigateToHash;

package/navigateToParams.js

@@ -1,4 +1,5 @@
 import { isBrowser, buildUrlQueryString, } from "@koine/utils";
+import navigateToUrl from "./navigateToUrl";
 /**
  * Change current URL query parameters, it uses `history`.
  *
@@ -10,7 +11,7 @@ export function navigateToParams(params, replace) {
     if (params === void 0) { params = {}; }
     var queryString = typeof params === "string" ? params : buildUrlQueryString(params);
     if (isBrowser) {
-        history[replace ? "replaceState" : "pushState"](null, "", location.pathname + queryString);
+        navigateToUrl(location.pathname + queryString, replace);
     }
     return queryString;
 }

package/navigateToUrl.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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,12 @@
+/**
+ * It updates the browser's location URL with global `history` object
+ *
+ * @category location
+ */
+export function navigateToUrl(url, replace) {
+    if (url === void 0) { url = ""; }
+    if (url) {
+        history[replace ? "replaceState" : "pushState"](null, "", url);
+    }
+}
+export default navigateToUrl;

package/node/createStorage.js

@@ -4,24 +4,13 @@ exports.createStorage = void 0;
 var tslib_1 = require("tslib");
 var utils_1 = require("@koine/utils");
 var dom_1 = require("@koine/dom");
+var storage_1 = require("./storage");
 /**
  * Utility to create a storage instance to interact with `localStorage` using
  * encrypted (encoded) key/values.
  */
-var createStorage = function (config) {
-    var methodsMap = { g: "getItem", s: "setItem", r: "removeItem" };
-    /**
-     * Super minifiable localStorage wrapper with SSR safety
-     */
-    var ls = function (method, key, value) {
-        return utils_1.isBrowser
-            ? localStorage[methodsMap[method]](key, value)
-            : function () {
-                if (process.env["NODE_ENV"] !== "production") {
-                    console.warn("[@koine/utils] createStorage: localStorage does not exists in this environment.");
-                }
-            };
-    };
+var createStorage = function (config, useSessionStorage) {
+    var client = useSessionStorage ? storage_1.storage.s : storage_1.storage.l;
     var keys = Object.keys(config).reduce(function (map, key) {
         var _a;
         return (tslib_1.__assign(tslib_1.__assign({}, map), (_a = {}, _a[key] = (0, utils_1.encode)(key), _a)));
@@ -31,33 +20,34 @@ var createStorage = function (config) {
          * Get all storage value (it uses `localStorage.get()`).
          *
          * Unparseable values with `JSON.parse()` return their value as it is.
-         * If the given `key` argument is not found `null` is returned.
+         * On ssr or if the given `key` argument is not found `defaultValue` is
+         * returned, otherwise `null`.
          */
-        get: function (key) {
-            var stored = ls("g", keys[key]);
-            if (stored) {
-                stored = (0, utils_1.decode)(stored);
-                try {
-                    return JSON.parse(stored);
-                }
-                catch (_e) {
-                    return stored;
-                }
-            }
-            return null;
+        get: function (key, defaultValue) {
+            return client.get(keys[key], utils_1.decode, defaultValue);
         },
         /**
          * Get all storage values (it uses `localStorage.get()`).
          *
          * `undefined` and `null` values are not returned.
          */
-        getAll: function () {
+        getAll: function (defaultValues) {
+            if (!utils_1.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 value = client.get(key);
+                var defaultValue = defaultValues === null || defaultValues === void 0 ? void 0 : defaultValues[key];
                 if (!(0, utils_1.isNullOrUndefined)(value)) {
                     all[key] = value;
                 }
+                else if (defaultValue) {
+                    all[key] = defaultValue;
+                }
             }
             return all;
         },
@@ -67,7 +57,7 @@ var createStorage = function (config) {
          * Non-string values are stringified with `JSON.stringify()`
          */
         set: function (key, value) {
-            ls("s", keys[key], (0, utils_1.isString)(value) ? (0, utils_1.encode)(value) : (0, utils_1.encode)(JSON.stringify(value)));
+            client.set(key, value, utils_1.encode);
         },
         /**
          * Set all given storage values (it uses `localStorage.set()`).
@@ -76,13 +66,20 @@ var createStorage = function (config) {
          * and `null` values are removed from the storage
          */
         setMany: function (newValues) {
-            for (var key in newValues) {
-                var value = newValues[key];
-                if (!(0, utils_1.isNullOrUndefined)(value)) {
-                    this.set(key, value);
+            if (process.env["NODE_ENV"] !== "production") {
+                if (!utils_1.isBrowser) {
+                    console.log("[@koine/utils:createStorage] attempt to use 'setMany' outside of browser.");
                 }
-                else {
-                    this.remove(key);
+            }
+            if (utils_1.isBrowser) {
+                for (var key in newValues) {
+                    var value = newValues[key];
+                    if (!(0, utils_1.isNullOrUndefined)(value)) {
+                        client.set(key, value);
+                    }
+                    else {
+                        client.remove(key);
+                    }
                 }
             }
         },
@@ -90,21 +87,27 @@ var createStorage = function (config) {
          * Check if a storage value is _truthy_ (it uses `localStorage.get()`).
          */
         has: function (key) {
-            var stored = ls("g", keys[key]);
-            return !!stored;
+            return client.has(keys[key]);
         },
         /**
          * Remove a storage value (it uses `localStorage.remove()`).
          */
         remove: function (key) {
-            ls("r", keys[key]);
+            client.remove(keys[key]);
         },
         /**
          * Clear all storage values (it uses `localStorage.remove()`).
          */
         clear: function () {
-            for (var key in keys) {
-                ls("r", keys[key]);
+            if (process.env["NODE_ENV"] !== "production") {
+                if (!utils_1.isBrowser) {
+                    console.log("[@koine/utils:createStorage] attempt to use 'clear' outside of browser.");
+                }
+            }
+            if (utils_1.isBrowser) {
+                for (var key in keys) {
+                    client.remove(keys[key]);
+                }
             }
         },
         /**
@@ -114,6 +117,12 @@ var createStorage = function (config) {
          * 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 (!utils_1.isBrowser) {
+                if (process.env["NODE_ENV"] !== "production") {
+                    console.log("[@koine/utils:createStorage] attempt to use 'watch' outside of browser.");
+                }
+                return function () { return void 0; };
+            }
             var handler = function (event) {
                 var key = event.key, oldValue = event.oldValue, newValue = event.newValue;
                 if (key === keys[keyToWatch]) {
@@ -125,8 +134,6 @@ var createStorage = function (config) {
                     }
                 }
             };
-            if (!utils_1.isBrowser)
-                return function () { return void 0; };
             var listener = (0, dom_1.on)(window, "storage", handler);
             return listener;
         },

package/node/index.js

@@ -11,5 +11,6 @@ tslib_1.__exportStar(require("./navigateToHashParams"), exports);
 tslib_1.__exportStar(require("./navigateToMergedHashParams"), exports);
 tslib_1.__exportStar(require("./navigateToMergedParams"), exports);
 tslib_1.__exportStar(require("./navigateToParams"), exports);
+tslib_1.__exportStar(require("./navigateToUrl"), exports);
 tslib_1.__exportStar(require("./navigateWithoutUrlParam"), exports);
 tslib_1.__exportStar(require("./redirectTo"), exports);

package/node/navigateToHash.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.navigateToHash = void 0;
+var tslib_1 = require("tslib");
+var navigateToUrl_1 = tslib_1.__importDefault(require("./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"`
@@ -10,7 +12,7 @@ exports.navigateToHash = void 0;
 function navigateToHash(hash) {
     if (hash === void 0) { hash = ""; }
     var pathname = location.pathname, search = location.search;
-    history.replaceState(null, "", pathname + (search ? "?" + search : "") + "#" + hash);
+    (0, navigateToUrl_1.default)(pathname + (search ? "?" + search : "") + "#" + hash, true);
 }
 exports.navigateToHash = navigateToHash;
 exports.default = navigateToHash;

package/node/navigateToParams.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.navigateToParams = void 0;
+var tslib_1 = require("tslib");
 var utils_1 = require("@koine/utils");
+var navigateToUrl_1 = tslib_1.__importDefault(require("./navigateToUrl"));
 /**
  * Change current URL query parameters, it uses `history`.
  *
@@ -13,7 +15,7 @@ function navigateToParams(params, replace) {
     if (params === void 0) { params = {}; }
     var queryString = typeof params === "string" ? params : (0, utils_1.buildUrlQueryString)(params);
     if (utils_1.isBrowser) {
-        history[replace ? "replaceState" : "pushState"](null, "", location.pathname + queryString);
+        (0, navigateToUrl_1.default)(location.pathname + queryString, replace);
     }
     return queryString;
 }

package/node/navigateToUrl.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.navigateToUrl = void 0;
+/**
+ * It updates the browser's location URL with global `history` object
+ *
+ * @category location
+ */
+function navigateToUrl(url, replace) {
+    if (url === void 0) { url = ""; }
+    if (url) {
+        history[replace ? "replaceState" : "pushState"](null, "", url);
+    }
+}
+exports.navigateToUrl = navigateToUrl;
+exports.default = navigateToUrl;

package/node/storage.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.storage = void 0;
+var storageClient_1 = require("./storageClient");
+/**
+ * Storage, for `localStorage` and `sessionStorage`
+ */
+exports.storage = {
+    l: (0, storageClient_1.storageClient)(),
+    s: (0, storageClient_1.storageClient)(true),
+};
+exports.default = exports.storage;

package/node/storageClient.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.storageClient = void 0;
+var utils_1 = require("@koine/utils");
+var methodsMap = { g: "getItem", s: "setItem", r: "removeItem" };
+/**
+ * Super minifiable `local/session Storage` client creator with SSR safety
+ */
+var storageClient = function (useSessionStorage) {
+    var nativeMethod = function (method, key, value) {
+        return utils_1.isBrowser
+            ? window[useSessionStorage ? "sessionStorage" : "localStorage"][methodsMap[method]](key, value)
+            : function () {
+                if (process.env["NODE_ENV"] !== "production") {
+                    console.warn("[@koine/utils:storage]:ls 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 (!utils_1.isBrowser) {
+                console.log("[@koine/utils:storage] called 'get' outside of browser with default value '".concat(JSON.stringify(defaultValue), "'."));
+            }
+        }
+        if (utils_1.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;
+                    if (process.env["NODE_ENV"] !== "production") {
+                        console.warn("[@koine/utils:storage]: 'get' failed to parse stored value as JSON. Plain '".concat(stored, "' value is returned."));
+                    }
+                }
+            }
+        }
+        return value;
+    };
+    var set = function (key, value, transform) {
+        if (transform === void 0) { transform = function (value) { return value; }; }
+        if (process.env["NODE_ENV"] !== "production") {
+            if (!utils_1.isBrowser) {
+                console.log("[@koine/utils:storage] called 'set' outside of browser does not work.");
+            }
+        }
+        if (utils_1.isBrowser) {
+            try {
+                var transformedValue = (0, utils_1.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 (!utils_1.isBrowser) {
+                console.log("[@koine/utils:storage] called 'remove' outside of browser does not work.");
+            }
+        }
+        if (utils_1.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 (!utils_1.isBrowser) {
+                console.log("[@koine/utils:storage] called 'has' outside of browser with default value '".concat(JSON.stringify(defaultValue), "'."));
+            }
+        }
+        if (utils_1.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,
+    };
+};
+exports.storageClient = storageClient;
+exports.default = exports.storageClient;

package/package.json

@@ -4,14 +4,14 @@
   "main": "./node/index.js",
   "typings": "./index.d.ts",
   "dependencies": {
-    "@koine/utils": "1.0.94",
+    "@koine/utils": "1.0.95",
     "ts-debounce": "^4.0.0",
-    "@koine/dom": "1.0.94",
+    "@koine/dom": "1.0.95",
     "date-fns-tz": "^1.3.7",
     "tslib": "^2.4.0"
   },
   "peerDependencies": {},
-  "version": "1.0.94",
+  "version": "1.0.95",
   "module": "./index.js",
   "types": "./index.d.ts"
 }

package/storage.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Storage, for `localStorage` and `sessionStorage`
+ */
+export declare const storage: {
+    l: {
+        get: <TValue>(key: string, transform?: ((value: string) => TValue) | undefined, defaultValue?: TValue | null | undefined) => NonNullable<TValue> | null;
+        set: <TValue_1>(key: string, value?: TValue_1 | undefined, transform?: (value: any) => string) => void;
+        remove: (key: string) => void;
+        has: (key: string, defaultValue?: boolean | undefined) => boolean;
+    };
+    s: {
+        get: <TValue>(key: string, transform?: ((value: string) => TValue) | undefined, defaultValue?: TValue | null | undefined) => NonNullable<TValue> | null;
+        set: <TValue_1>(key: string, value?: TValue_1 | undefined, transform?: (value: any) => string) => void;
+        remove: (key: string) => void;
+        has: (key: string, defaultValue?: boolean | undefined) => boolean;
+    };
+};
+export default storage;

package/storage.js

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

package/storageClient.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Super minifiable `local/session Storage` client creator with SSR safety
+ */
+export declare const storageClient: (useSessionStorage?: boolean) => {
+    get: <TValue>(key: string, transform?: ((value: string) => TValue) | undefined, defaultValue?: TValue | null | undefined) => NonNullable<TValue> | null;
+    set: <TValue_1>(key: string, value?: TValue_1 | undefined, transform?: (value: any) => string) => void;
+    remove: (key: string) => void;
+    has: (key: string, defaultValue?: boolean) => boolean;
+};
+export default storageClient;

package/storageClient.js

@@ -0,0 +1,100 @@
+import { isBrowser, isString } from "@koine/utils";
+var methodsMap = { g: "getItem", s: "setItem", r: "removeItem" };
+/**
+ * Super minifiable `local/session Storage` client creator with SSR safety
+ */
+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:storage]:ls 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;
+                    if (process.env["NODE_ENV"] !== "production") {
+                        console.warn("[@koine/utils:storage]: 'get' failed to parse stored value as JSON. Plain '".concat(stored, "' value is returned."));
+                    }
+                }
+            }
+        }
+        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;