@react-hive/honey-utils 4.1.0 → 4.3.0

package/dist/index.dev.cjs

@@ -1758,7 +1758,9 @@ __webpack_require__.r(__webpack_exports__);
 __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
 /* harmony export */   getLocalStorageCapabilities: () => (/* reexport safe */ _storage__WEBPACK_IMPORTED_MODULE_0__.getLocalStorageCapabilities),
-/* harmony export */   isLocalStorageReadable: () => (/* reexport safe */ _storage__WEBPACK_IMPORTED_MODULE_0__.isLocalStorageReadable)
+/* harmony export */   isLocalStorageReadable: () => (/* reexport safe */ _storage__WEBPACK_IMPORTED_MODULE_0__.isLocalStorageReadable),
+/* harmony export */   readLocalStorageJson: () => (/* reexport safe */ _storage__WEBPACK_IMPORTED_MODULE_0__.readLocalStorageJson),
+/* harmony export */   writeLocalStorageJson: () => (/* reexport safe */ _storage__WEBPACK_IMPORTED_MODULE_0__.writeLocalStorageJson)
 /* harmony export */ });
 /* harmony import */ var _storage__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./storage */ "./src/env/storage/index.ts");
 
@@ -1775,12 +1777,77 @@ __webpack_require__.r(__webpack_exports__);
 __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
 /* harmony export */   getLocalStorageCapabilities: () => (/* reexport safe */ _local_storage__WEBPACK_IMPORTED_MODULE_0__.getLocalStorageCapabilities),
-/* harmony export */   isLocalStorageReadable: () => (/* reexport safe */ _local_storage__WEBPACK_IMPORTED_MODULE_0__.isLocalStorageReadable)
+/* harmony export */   isLocalStorageReadable: () => (/* reexport safe */ _local_storage__WEBPACK_IMPORTED_MODULE_0__.isLocalStorageReadable),
+/* harmony export */   readLocalStorageJson: () => (/* reexport safe */ _local_storage_json__WEBPACK_IMPORTED_MODULE_1__.readLocalStorageJson),
+/* harmony export */   writeLocalStorageJson: () => (/* reexport safe */ _local_storage_json__WEBPACK_IMPORTED_MODULE_1__.writeLocalStorageJson)
 /* harmony export */ });
 /* harmony import */ var _local_storage__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./local-storage */ "./src/env/storage/local-storage.ts");
+/* harmony import */ var _local_storage_json__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./local-storage-json */ "./src/env/storage/local-storage-json.ts");
 
 
 
+
+/***/ },
+
+/***/ "./src/env/storage/local-storage-json.ts"
+/*!***********************************************!*\
+  !*** ./src/env/storage/local-storage-json.ts ***!
+  \***********************************************/
+(__unused_webpack_module, __webpack_exports__, __webpack_require__) {
+
+__webpack_require__.r(__webpack_exports__);
+/* harmony export */ __webpack_require__.d(__webpack_exports__, {
+/* harmony export */   readLocalStorageJson: () => (/* binding */ readLocalStorageJson),
+/* harmony export */   writeLocalStorageJson: () => (/* binding */ writeLocalStorageJson)
+/* harmony export */ });
+/* harmony import */ var _json__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ~/json */ "./src/json/index.ts");
+
+/**
+ * Reads the value stored as JSON under a key in `localStorage`.
+ *
+ * Never throws: storage that cannot be read at all (SSR, disabled storage, sandboxed iframes, strict
+ * privacy modes) reads as nothing stored, as does a value that is not JSON.
+ *
+ * The value is only cast to `Value`, not checked against it - something stored by an older version
+ * of the app, or by hand, can be of any shape, so check it before relying on it.
+ *
+ * @param key - The `localStorage` key to read.
+ *
+ * @returns The parsed value, or `null` when nothing is stored under the key, what is stored is not
+ *          valid JSON, or storage cannot be read.
+ */
+const readLocalStorageJson = (key) => {
+    try {
+        const value = window.localStorage.getItem(key);
+        return value === null ? null : (0,_json__WEBPACK_IMPORTED_MODULE_0__.parseJson)(value);
+    }
+    catch {
+        return null;
+    }
+};
+/**
+ * Stores a value under a key in `localStorage`, as JSON.
+ *
+ * Never throws: a write that fails - storage full (`QuotaExceededError`), Safari Private Mode,
+ * security-restricted contexts, SSR, or a value `JSON.stringify()` cannot serialise (a circular
+ * reference, a `BigInt`) - reports `false` instead.
+ *
+ * @param key - The `localStorage` key to write.
+ * @param value - Any JSON-serialisable value.
+ *
+ * @returns `true` once the value is stored, `false` when it could not be.
+ */
+const writeLocalStorageJson = (key, value) => {
+    try {
+        window.localStorage.setItem(key, JSON.stringify(value));
+        return true;
+    }
+    catch {
+        return false;
+    }
+};
+
+
 /***/ },
 
 /***/ "./src/env/storage/local-storage.ts"
@@ -2440,6 +2507,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */   isDecimal: () => (/* binding */ isDecimal),
 /* harmony export */   isDefined: () => (/* binding */ isDefined),
 /* harmony export */   isEmptyObject: () => (/* binding */ isEmptyObject),
+/* harmony export */   isEnumValue: () => (/* binding */ isEnumValue),
 /* harmony export */   isError: () => (/* binding */ isError),
 /* harmony export */   isFiniteNumber: () => (/* binding */ isFiniteNumber),
 /* harmony export */   isInteger: () => (/* binding */ isInteger),
@@ -2663,6 +2731,29 @@ const isInteger = (value) => isNumber(value) && Number.isInteger(value);
  * ```
  */
 const isDecimal = (value) => isFiniteNumber(value) && !Number.isInteger(value);
+/**
+ * Checks if a value is one of a string enum's values.
+ *
+ * @template Value - The type of the enum's values.
+ *
+ * @param enumObject - The enum, or any object whose values are the allowed strings.
+ * @param value - The value to check.
+ *
+ * @returns `true` if the value is one of the enum's values; otherwise, `false`.
+ *
+ * @example
+ * ```ts
+ * enum Fruit {
+ *   APPLE = 'apple',
+ *   PEAR = 'pear',
+ * }
+ *
+ * isEnumValue(Fruit, 'apple'); // true
+ * isEnumValue(Fruit, 'APPLE'); // false
+ * isEnumValue(Fruit, null); // false
+ * ```
+ */
+const isEnumValue = (enumObject, value) => Object.values(enumObject).includes(value);
 
 
 /***/ },
@@ -3928,6 +4019,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */   isDefined: () => (/* reexport safe */ _guards__WEBPACK_IMPORTED_MODULE_8__.isDefined),
 /* harmony export */   isEmptyArray: () => (/* reexport safe */ _array__WEBPACK_IMPORTED_MODULE_1__.isEmptyArray),
 /* harmony export */   isEmptyObject: () => (/* reexport safe */ _guards__WEBPACK_IMPORTED_MODULE_8__.isEmptyObject),
+/* harmony export */   isEnumValue: () => (/* reexport safe */ _guards__WEBPACK_IMPORTED_MODULE_8__.isEnumValue),
 /* harmony export */   isError: () => (/* reexport safe */ _guards__WEBPACK_IMPORTED_MODULE_8__.isError),
 /* harmony export */   isFile: () => (/* reexport safe */ _file__WEBPACK_IMPORTED_MODULE_5__.isFile),
 /* harmony export */   isFiniteNumber: () => (/* reexport safe */ _guards__WEBPACK_IMPORTED_MODULE_8__.isFiniteNumber),
@@ -3957,6 +4049,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */   parseJson: () => (/* reexport safe */ _json__WEBPACK_IMPORTED_MODULE_17__.parseJson),
 /* harmony export */   pipe: () => (/* reexport safe */ _array__WEBPACK_IMPORTED_MODULE_1__.pipe),
 /* harmony export */   readFilesFromDataTransfer: () => (/* reexport safe */ _file__WEBPACK_IMPORTED_MODULE_5__.readFilesFromDataTransfer),
+/* harmony export */   readLocalStorageJson: () => (/* reexport safe */ _env__WEBPACK_IMPORTED_MODULE_4__.readLocalStorageJson),
 /* harmony export */   reduceAsync: () => (/* reexport safe */ _async__WEBPACK_IMPORTED_MODULE_2__.reduceAsync),
 /* harmony export */   replaceHistorySearchParams: () => (/* reexport safe */ _dom__WEBPACK_IMPORTED_MODULE_3__.replaceHistorySearchParams),
 /* harmony export */   resolveAxisDelta: () => (/* reexport safe */ _intersection__WEBPACK_IMPORTED_MODULE_10__.resolveAxisDelta),
@@ -3973,7 +4066,8 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export */   toKebabCase: () => (/* reexport safe */ _string__WEBPACK_IMPORTED_MODULE_13__.toKebabCase),
 /* harmony export */   toggleArrayItem: () => (/* reexport safe */ _array__WEBPACK_IMPORTED_MODULE_1__.toggleArrayItem),
 /* harmony export */   traverseFileSystemDirectory: () => (/* reexport safe */ _file__WEBPACK_IMPORTED_MODULE_5__.traverseFileSystemDirectory),
-/* harmony export */   unique: () => (/* reexport safe */ _array__WEBPACK_IMPORTED_MODULE_1__.unique)
+/* harmony export */   unique: () => (/* reexport safe */ _array__WEBPACK_IMPORTED_MODULE_1__.unique),
+/* harmony export */   writeLocalStorageJson: () => (/* reexport safe */ _env__WEBPACK_IMPORTED_MODULE_4__.writeLocalStorageJson)
 /* harmony export */ });
 /* harmony import */ var _a11y__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ./a11y */ "./src/a11y/index.ts");
 /* harmony import */ var _array__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ./array */ "./src/array/index.ts");