@koine/utils 1.0.34 → 1.0.37

package/Emitter.d.ts

@@ -16,10 +16,10 @@ export declare function Emitter<EventMap extends {
     /**
      * Register an event handler for the given type.
      */
-    on<EventName extends keyof EventMap>(name: EventName, handler: (data?: EventMap[EventName] | undefined) => any): void;
+    on<EventName extends keyof EventMap>(name: EventName, handler: (data?: EventMap[EventName]) => any): void;
     /**
      * Invoke all handlers for the given type.
      */
-    emit<EventName_1 extends keyof EventMap>(name: EventName_1, data?: EventMap[EventName_1] | undefined): void;
+    emit<EventName_1 extends keyof EventMap>(name: EventName_1, data?: EventMap[EventName_1]): void;
 };
 export default Emitter;

package/createStorage.d.ts

@@ -0,0 +1,13 @@
+export declare type CreateStorageConfig = Record<string, any>;
+export declare const createStorage: <T extends CreateStorageConfig>(config: Partial<T>) => {
+    get<TKey extends keyof T>(key: TKey): T[TKey];
+    set<TKey_1 extends keyof T>(key: TKey_1, value: T[TKey_1]): void;
+    has<TKey_2 extends keyof T>(key: TKey_2): boolean;
+    remove<TKey_3 extends keyof T>(key: TKey_3): void;
+    clear(): void;
+    /**
+     * 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;
+};
+export default createStorage;

package/createStorage.js

@@ -0,0 +1,75 @@
+import { __assign } from "tslib";
+import { decode } from "./decode";
+import { encode } from "./encode";
+import isBrowser from "./isBrowser";
+import { isString } from "./isString";
+export var createStorage = function (config) {
+    var methodsMap = { g: "getItem", s: "setItem", r: "removeItem" };
+    /**
+     * Super minifiable localStorage wrapper with SSR safety
+     */
+    var ls = function (method, key, value) {
+        return isBrowser
+            ? localStorage[methodsMap[method]](key, value)
+            : function () {
+                if (process.env["NODE_ENV"] !== "production") {
+                    console.warn("[@koine/utils] createStorage: localStorage does not exists in this environment.");
+                }
+            };
+    };
+    var keys = Object.keys(config).reduce(function (map, key) {
+        var _a;
+        return (__assign(__assign({}, map), (_a = {}, _a[key] = encode(key), _a)));
+    }, {});
+    return {
+        get: function (key) {
+            var stored = ls("g", keys[key]);
+            if (stored) {
+                stored = decode(stored);
+                try {
+                    return JSON.parse(stored);
+                }
+                catch (_e) {
+                    return stored;
+                }
+            }
+            return null;
+        },
+        set: function (key, value) {
+            ls("s", keys[key], isString(value) ? encode(value) : JSON.stringify(value));
+        },
+        has: function (key) {
+            var stored = ls("g", keys[key]);
+            return !!stored;
+        },
+        remove: function (key) {
+            ls("r", keys[key]);
+        },
+        clear: function () {
+            for (var key in keys) {
+                ls("r", keys[key]);
+            }
+        },
+        /**
+         * Inspiration from [Multi Tab Logout in React — Redux](https://medium.com/front-end-weekly/multi-tab-logout-in-react-redux-4715f071c7fa)
+         */
+        watch: function (keyToWatch, onRemoved, onAdded) {
+            var handler = function (event) {
+                var key = event.key, oldValue = event.oldValue, newValue = event.newValue;
+                if (key === keys[keyToWatch]) {
+                    if (oldValue && !newValue) {
+                        onRemoved === null || onRemoved === void 0 ? void 0 : onRemoved();
+                    }
+                    else if (!oldValue && newValue) {
+                        onAdded === null || onAdded === void 0 ? void 0 : onAdded();
+                    }
+                }
+            };
+            window.addEventListener("storage", handler);
+            return function () {
+                window.removeEventListener("storage", handler);
+            };
+        },
+    };
+};
+export default createStorage;

package/getNonce.d.ts

@@ -2,5 +2,5 @@
  * @category security
  * @see https://github.com/styled-components/styled-components/blob/main/packages/styled-components/src/utils/nonce.ts
  */
-export declare function getNonce(): string | null;
+export declare function getNonce(): string;
 export default getNonce;

package/index.d.ts

@@ -1,8 +1,7 @@
 /**
  * @file
  *
- * TODO: libraries to encapsulate and re-export from here,
- * the selection is based on:
+ * Libraries to encapsulate and re-export from here, the selection is based on:
  *
  * [x] full typescript support
  * [x] treeshake-ability
@@ -24,6 +23,14 @@
  *
  * About utilities useful examples @see:
  * - https://github.com/chakra-ui/chakra-ui/blob/main/packages/utils/src
+ *
+ * TODO:
+ * We could also re-exports direct dependencies of packages that we often use
+ * anyway like [those of `yup`](https://github.com/jquense/yup/blob/master/package.json#L103):
+ *
+ * - [tiny-case](https://github.com/jquense/tiny-case)
+ * - [property-expr](https://github.com/jquense/expr/blob/master/index.js)
+ * - [toposort](https://github.com/marcelklehr/toposort)
  */
 export * from "./accentSets";
 export * from "./addOrReplaceAtIdx";
@@ -36,6 +43,7 @@ export * from "./clamp";
 export * from "./clsx";
 export * from "./convertRange";
 export * from "./cookie";
+export * from "./createStorage";
 export * from "./decode";
 export * from "./Defer";
 export * from "./Emitter";

package/index.js

@@ -1,8 +1,7 @@
 /**
  * @file
  *
- * TODO: libraries to encapsulate and re-export from here,
- * the selection is based on:
+ * Libraries to encapsulate and re-export from here, the selection is based on:
  *
  * [x] full typescript support
  * [x] treeshake-ability
@@ -24,6 +23,14 @@
  *
  * About utilities useful examples @see:
  * - https://github.com/chakra-ui/chakra-ui/blob/main/packages/utils/src
+ *
+ * TODO:
+ * We could also re-exports direct dependencies of packages that we often use
+ * anyway like [those of `yup`](https://github.com/jquense/yup/blob/master/package.json#L103):
+ *
+ * - [tiny-case](https://github.com/jquense/tiny-case)
+ * - [property-expr](https://github.com/jquense/expr/blob/master/index.js)
+ * - [toposort](https://github.com/marcelklehr/toposort)
  */
 export * from "./accentSets";
 export * from "./addOrReplaceAtIdx";
@@ -36,6 +43,7 @@ export * from "./clamp";
 export * from "./clsx";
 export * from "./convertRange";
 export * from "./cookie";
+export * from "./createStorage";
 export * from "./decode";
 export * from "./Defer";
 export * from "./Emitter";

package/isNullOrUndefined.d.ts

@@ -3,5 +3,5 @@
  *
  * @category is
  */
-export declare const isNullOrUndefined: import("./getType").TypeGuard<any, null | undefined>;
+export declare const isNullOrUndefined: import("./getType").TypeGuard<any, null>;
 export default isNullOrUndefined;

package/node/createStorage.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStorage = void 0;
+var tslib_1 = require("tslib");
+var decode_1 = require("./decode");
+var encode_1 = require("./encode");
+var isBrowser_1 = require("./isBrowser");
+var isString_1 = require("./isString");
+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_1.default
+            ? localStorage[methodsMap[method]](key, value)
+            : function () {
+                if (process.env["NODE_ENV"] !== "production") {
+                    console.warn("[@koine/utils] createStorage: localStorage does not exists in this environment.");
+                }
+            };
+    };
+    var keys = Object.keys(config).reduce(function (map, key) {
+        var _a;
+        return (tslib_1.__assign(tslib_1.__assign({}, map), (_a = {}, _a[key] = (0, encode_1.encode)(key), _a)));
+    }, {});
+    return {
+        get: function (key) {
+            var stored = ls("g", keys[key]);
+            if (stored) {
+                stored = (0, decode_1.decode)(stored);
+                try {
+                    return JSON.parse(stored);
+                }
+                catch (_e) {
+                    return stored;
+                }
+            }
+            return null;
+        },
+        set: function (key, value) {
+            ls("s", keys[key], (0, isString_1.isString)(value) ? (0, encode_1.encode)(value) : JSON.stringify(value));
+        },
+        has: function (key) {
+            var stored = ls("g", keys[key]);
+            return !!stored;
+        },
+        remove: function (key) {
+            ls("r", keys[key]);
+        },
+        clear: function () {
+            for (var key in keys) {
+                ls("r", keys[key]);
+            }
+        },
+        /**
+         * Inspiration from [Multi Tab Logout in React — Redux](https://medium.com/front-end-weekly/multi-tab-logout-in-react-redux-4715f071c7fa)
+         */
+        watch: function (keyToWatch, onRemoved, onAdded) {
+            var handler = function (event) {
+                var key = event.key, oldValue = event.oldValue, newValue = event.newValue;
+                if (key === keys[keyToWatch]) {
+                    if (oldValue && !newValue) {
+                        onRemoved === null || onRemoved === void 0 ? void 0 : onRemoved();
+                    }
+                    else if (!oldValue && newValue) {
+                        onAdded === null || onAdded === void 0 ? void 0 : onAdded();
+                    }
+                }
+            };
+            window.addEventListener("storage", handler);
+            return function () {
+                window.removeEventListener("storage", handler);
+            };
+        },
+    };
+};
+exports.createStorage = createStorage;
+exports.default = exports.createStorage;

package/node/index.js

@@ -2,8 +2,7 @@
 /**
  * @file
  *
- * TODO: libraries to encapsulate and re-export from here,
- * the selection is based on:
+ * Libraries to encapsulate and re-export from here, the selection is based on:
  *
  * [x] full typescript support
  * [x] treeshake-ability
@@ -25,6 +24,14 @@
  *
  * About utilities useful examples @see:
  * - https://github.com/chakra-ui/chakra-ui/blob/main/packages/utils/src
+ *
+ * TODO:
+ * We could also re-exports direct dependencies of packages that we often use
+ * anyway like [those of `yup`](https://github.com/jquense/yup/blob/master/package.json#L103):
+ *
+ * - [tiny-case](https://github.com/jquense/tiny-case)
+ * - [property-expr](https://github.com/jquense/expr/blob/master/index.js)
+ * - [toposort](https://github.com/marcelklehr/toposort)
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 var tslib_1 = require("tslib");
@@ -39,6 +46,7 @@ tslib_1.__exportStar(require("./clamp"), exports);
 tslib_1.__exportStar(require("./clsx"), exports);
 tslib_1.__exportStar(require("./convertRange"), exports);
 tslib_1.__exportStar(require("./cookie"), exports);
+tslib_1.__exportStar(require("./createStorage"), exports);
 tslib_1.__exportStar(require("./decode"), exports);
 tslib_1.__exportStar(require("./Defer"), exports);
 tslib_1.__exportStar(require("./Emitter"), exports);

package/node/readCookie.js

@@ -10,7 +10,7 @@ function converterRead(value) {
 function readCookie(name) {
     if (typeof document === "undefined") {
         if (process.env["NODE_ENV"] !== "production") {
-            console.warn("@koine/utils:cookie readCookie, document is undefined");
+            console.warn("[@koine/utils] readCookie: document is undefined");
         }
         return name ? "" : {};
     }
@@ -28,7 +28,7 @@ function readCookie(name) {
         }
         catch (e) {
             if (process.env["NODE_ENV"] !== "production") {
-                console.warn("@koine/utils:cookie readCookie, failed to decode", value);
+                console.warn("[@koine/utils] readCookie: failed to decode", value);
             }
         }
     }

package/node/setCookie.js

@@ -21,9 +21,9 @@ function setCookie(name, value, attributes) {
     var cleanedAttrs = tslib_1.__assign(tslib_1.__assign({ expires: "" }, cookie_1.defaultAttributesClient), restAttrs);
     if (typeof document === "undefined") {
         if (process.env["NODE_ENV"] !== "production") {
-            console.warn("@koine/utils:cookie setCookie, document is undefined");
+            console.warn("[@koine/utils] cookie setCookie: document is undefined");
         }
-        return;
+        return undefined;
     }
     if ((0, isNumber_1.default)(expires)) {
         expires = new Date(Date.now() + expires * 864e5);

package/package.json

@@ -7,7 +7,7 @@
   "peerDependencies": {
     "tslib": "^2.4.0"
   },
-  "version": "1.0.34",
+  "version": "1.0.37",
   "module": "./index.js",
   "types": "./index.d.ts"
 }

package/pageview.d.ts

@@ -6,4 +6,4 @@ export declare type GtmPageviewArgs = [
 /**
  * @category analytics-google
  */
-export declare const pageview: (page_path?: string | undefined, page_title?: string | undefined, page_location?: string | undefined) => void;
+export declare const pageview: (page_path?: string, page_title?: string, page_location?: string) => void;

package/parseURL.d.ts

@@ -13,5 +13,5 @@ export declare function parseURL(url: string): {
     pathname: string;
     search: string;
     hash: string;
-} | null;
+};
 export default parseURL;

package/readCookie.js

@@ -7,7 +7,7 @@ function converterRead(value) {
 export function readCookie(name) {
     if (typeof document === "undefined") {
         if (process.env["NODE_ENV"] !== "production") {
-            console.warn("@koine/utils:cookie readCookie, document is undefined");
+            console.warn("[@koine/utils] readCookie: document is undefined");
         }
         return name ? "" : {};
     }
@@ -25,7 +25,7 @@ export function readCookie(name) {
         }
         catch (e) {
             if (process.env["NODE_ENV"] !== "production") {
-                console.warn("@koine/utils:cookie readCookie, failed to decode", value);
+                console.warn("[@koine/utils] readCookie: failed to decode", value);
             }
         }
     }

package/setCookie.js

@@ -18,9 +18,9 @@ export function setCookie(name, value, attributes) {
     var cleanedAttrs = __assign(__assign({ expires: "" }, defaultAttributesClient), restAttrs);
     if (typeof document === "undefined") {
         if (process.env["NODE_ENV"] !== "production") {
-            console.warn("@koine/utils:cookie setCookie, document is undefined");
+            console.warn("[@koine/utils] cookie setCookie: document is undefined");
         }
-        return;
+        return undefined;
     }
     if (isNumber(expires)) {
         expires = new Date(Date.now() + expires * 864e5);