@koine/utils 1.0.33 → 1.0.36

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] | null;
+    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/index.d.ts

@@ -36,6 +36,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";
@@ -104,6 +105,8 @@ export * from "./navigateToParams";
 export * from "./navigateWithoutUrlParam";
 export * from "./normaliseUrlPathname";
 export * from "./normaliseUrl";
+export * from "./objectPick";
+export * from "./objectOmit";
 export * from "./pageview";
 export * from "./parseCookie";
 export * from "./parseURL";
@@ -133,5 +136,4 @@ export * from "./updateLinkParams";
 export * from "./updateUrlQueryParams";
 export * from "./uuid";
 export * from "./wait";
-export * from "./whitelistObject";
 export type { Primitive, Class, Constructor, TypedArray, ObservableLike, Except, Mutable, Merge, MergeExclusive, RequireAtLeastOne, RequireExactlyOne, RequireAllOrNone, RemoveIndexSignature, PartialDeep, ReadonlyDeep, LiteralUnion, Opaque, InvariantOf, SetOptional, SetRequired, ValueOf, ConditionalKeys, ConditionalPick, ConditionalExcept, UnionToIntersection, LiteralToPrimitive, Stringified, IterableElement, Entry, Entries, SetReturnType, Simplify, Get, StringKeyOf, Schema, Jsonify, JsonPrimitive, JsonObject, JsonArray, JsonValue, Promisable, AsyncReturnType, Asyncify, Trim, Split, Includes, Join, LastArrayElement, FixedLengthArray, MultidimensionalArray, MultidimensionalReadonlyArray, PositiveInfinity, NegativeInfinity, Finite, Integer, Float, NegativeFloat, Negative, NonNegative, NegativeInteger, NonNegativeInteger, CamelCase, CamelCasedProperties, CamelCasedPropertiesDeep, KebabCase, KebabCasedProperties, KebabCasedPropertiesDeep, PascalCase, PascalCasedProperties, PascalCasedPropertiesDeep, SnakeCase, SnakeCasedProperties, SnakeCasedPropertiesDeep, ScreamingSnakeCase, DelimiterCase, DelimiterCasedProperties, DelimiterCasedPropertiesDeep, PackageJson, TsConfigJson, } from "type-fest";

package/index.js

@@ -36,6 +36,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";
@@ -105,6 +106,8 @@ export * from "./navigateToParams";
 export * from "./navigateWithoutUrlParam";
 export * from "./normaliseUrlPathname";
 export * from "./normaliseUrl";
+export * from "./objectPick";
+export * from "./objectOmit";
 export * from "./pageview";
 export * from "./parseCookie";
 export * from "./parseURL";
@@ -134,4 +137,3 @@ export * from "./updateLinkParams";
 export * from "./updateUrlQueryParams";
 export * from "./uuid";
 export * from "./wait";
-export * from "./whitelistObject";

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

@@ -39,6 +39,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);
@@ -108,6 +109,8 @@ tslib_1.__exportStar(require("./navigateToParams"), exports);
 tslib_1.__exportStar(require("./navigateWithoutUrlParam"), exports);
 tslib_1.__exportStar(require("./normaliseUrlPathname"), exports);
 tslib_1.__exportStar(require("./normaliseUrl"), exports);
+tslib_1.__exportStar(require("./objectPick"), exports);
+tslib_1.__exportStar(require("./objectOmit"), exports);
 tslib_1.__exportStar(require("./pageview"), exports);
 tslib_1.__exportStar(require("./parseCookie"), exports);
 tslib_1.__exportStar(require("./parseURL"), exports);
@@ -137,4 +140,3 @@ tslib_1.__exportStar(require("./updateLinkParams"), exports);
 tslib_1.__exportStar(require("./updateUrlQueryParams"), exports);
 tslib_1.__exportStar(require("./uuid"), exports);
 tslib_1.__exportStar(require("./wait"), exports);
-tslib_1.__exportStar(require("./whitelistObject"), exports);

package/node/objectOmit.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectOmit = void 0;
+/**
+ * Omit object properties by removing the given keys, it returns a
+ * new object.
+ *
+ * NOTE: most of the time using a normal [destructuring assignment](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment) is enough,
+ * use this utility only when it makes sense.
+ *
+ * @category objects
+ */
+function objectOmit(object, keys) {
+    return Object.keys(object).reduce(function (output, key) {
+        if (!keys.includes(key)) {
+            output[key] =
+                object[key];
+        }
+        return output;
+    }, {});
+}
+exports.objectOmit = objectOmit;
+exports.default = objectOmit;

package/node/{whitelistObject.js → objectPick.js}

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.whitelistObject = void 0;
+exports.objectPick = void 0;
 /**
- * Whitelist an object properties by selecting only the given keys, it returns a
+ * Pick object properties by selecting only the given keys, it returns a
  * new object.
  *
  * @category objects
  */
-function whitelistObject(object, keys) {
+function objectPick(object, keys) {
     var output = {};
     var len = keys.length;
     while (len--) {
@@ -15,5 +15,5 @@ function whitelistObject(object, keys) {
     }
     return output;
 }
-exports.whitelistObject = whitelistObject;
-exports.default = whitelistObject;
+exports.objectPick = objectPick;
+exports.default = objectPick;

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,7 +21,7 @@ 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;
     }

package/objectOmit.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Omit object properties by removing the given keys, it returns a
+ * new object.
+ *
+ * NOTE: most of the time using a normal [destructuring assignment](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment) is enough,
+ * use this utility only when it makes sense.
+ *
+ * @category objects
+ */
+export declare function objectOmit<T extends object, Keys extends (keyof T)[]>(object: T, keys: Keys): Omit<T, Keys[number]>;
+export default objectOmit;

package/objectOmit.js

@@ -0,0 +1,19 @@
+/**
+ * Omit object properties by removing the given keys, it returns a
+ * new object.
+ *
+ * NOTE: most of the time using a normal [destructuring assignment](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment) is enough,
+ * use this utility only when it makes sense.
+ *
+ * @category objects
+ */
+export function objectOmit(object, keys) {
+    return Object.keys(object).reduce(function (output, key) {
+        if (!keys.includes(key)) {
+            output[key] =
+                object[key];
+        }
+        return output;
+    }, {});
+}
+export default objectOmit;

package/objectPick.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Pick object properties by selecting only the given keys, it returns a
+ * new object.
+ *
+ * @category objects
+ */
+export declare function objectPick<T extends object, Keys extends (keyof T)[]>(object: T, keys: Keys): Pick<T, Keys[number]>;
+export default objectPick;

package/objectPick.js

@@ -0,0 +1,15 @@
+/**
+ * Pick object properties by selecting only the given keys, it returns a
+ * new object.
+ *
+ * @category objects
+ */
+export function objectPick(object, keys) {
+    var output = {};
+    var len = keys.length;
+    while (len--) {
+        output[keys[len]] = object[keys[len]];
+    }
+    return output;
+}
+export default objectPick;

package/package.json

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

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,7 +18,7 @@ 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;
     }