@superutils/rx 0.1.4 → 0.1.5

package/dist/index.js

@@ -166,16 +166,30 @@ import {
   getKeys,
   getValues,
   isArr as isArr2,
-  isFn as isFn5,
   isMap,
+  isObj as isObj2,
   isPositiveNumber as isPositiveNumber3,
   isStr,
   mapJoin,
+  objToMap,
   search,
   sort
 } from "@superutils/core";
+
+// src/data-storage/types.ts
+var OnErrorType = /* @__PURE__ */ ((OnErrorType2) => {
+  OnErrorType2["onChange"] = "onChange";
+  OnErrorType2["parse"] = "parse";
+  OnErrorType2["parse_json"] = "parse-json";
+  OnErrorType2["stringify"] = "stringify";
+  OnErrorType2["stringify_json"] = "stringify-json";
+  OnErrorType2["write"] = "write";
+  return OnErrorType2;
+})(OnErrorType || {});
+
+// src/data-storage/DataStorage.ts
 var forceUpdateCache$ = new Subject();
-var DataStorage = class {
+var _DataStorage = class _DataStorage {
   /**
    * A wrapper for reading and writing to LocalStorage (browser) or JSON files (NodeJS),
    * providing a Map-like interface with advanced features like search, filtering, and sorting.
@@ -270,155 +284,30 @@ var DataStorage = class {
       subject: void 0,
       forceUpdateCache: void 0
     };
-    this.clear = () => {
-      this.setAll(/* @__PURE__ */ new Map(), true);
-      return this;
-    };
-    this.delete = (keys) => {
-      if (!isArr2(keys)) keys = [keys];
-      const data = this.getAll();
-      for (const k of keys) data.delete(k);
-      this.setAll(data, true);
-      return this;
+    this.handleForceUpdateCacheChange = (name) => {
+      const isTarget = !this.name ? false : isArr2(name) ? name.includes(this.name) : isStr(name) ? name === this.name : name === true;
+      if (!isTarget) return;
+      const newData = this.read();
+      this.subject.next(newData);
     };
-    this.find = (predicateOrOptions) => find(
-      this.getAll(),
-      predicateOrOptions
-    );
-    this.filter = (predicate, limit, asArray, result) => filter(this.getAll(), predicate, limit, asArray, result);
-    this.get = (key) => this.getAll().get(key);
-    this.getAll = (forceRead = false) => {
+    this.handleSubjectChange = (data) => {
       var _a;
-      const wasInitialized = this.initialized;
-      if (!wasInitialized) this.init();
-      const readFromStorage = this.cacheDisabled || this.name && forceRead;
-      if (readFromStorage) {
-        const data = this.read();
-        const shouldTrigger = forceRead || !wasInitialized && !!data.size;
-        shouldTrigger && this.subject.next(data);
-        return data;
-      }
-      return (_a = this.subject) == null ? void 0 : _a.value;
-    };
-    this.has = (key) => this.getAll().has(key);
-    this.init = (initialValue) => {
-      var _a, _b;
-      if (this.initialized) return false;
-      this.initialized = true;
-      this.subject instanceof BehaviorSubject && this.subject.next(this.read());
-      unsubscribeAll_default(this.subscriptions);
-      if (!this.cacheDisabled) {
-        this.subscriptions.forceUpdateCache = forceUpdateCache$.subscribe(
-          (refresh) => {
-            const doRefresh = !this.name ? false : isArr2(refresh) ? refresh.includes(this.name) : isStr(refresh) ? refresh === this.name : refresh === true;
-            if (!doRefresh) return;
-            const newData = this.read();
-            this.subject.next(newData);
-          }
-        );
-      }
-      !((_b = (_a = this.subject) == null ? void 0 : _a.value) == null ? void 0 : _b.size) && isMap(initialValue) && !!(initialValue == null ? void 0 : initialValue.size) && this.setAll(initialValue);
-      const piped = this.subject.pipe(
-        skip(this.cacheDisabled || !!(initialValue == null ? void 0 : initialValue.size) ? 0 : 1)
-      );
-      let handleChange = (data) => {
-        if (!isMap(data)) return this.subject.next(/* @__PURE__ */ new Map());
-        this.write(data);
-        fallbackIfFails3(
-          () => {
-            var _a2;
-            return (_a2 = this.onChange) == null ? void 0 : _a2.call(this, data);
-          },
-          [],
-          this.triggerOnError("onChange")
-        );
-      };
-      if (this.delay > 0)
-        handleChange = deferred2(handleChange, this.delay, this.delayOptions);
-      this.subscriptions.subject = piped.subscribe(handleChange);
-      return true;
-    };
-    this.keys = () => getKeys(this.getAll());
-    this.map = (callback) => this.toArray().map(
-      ([key, value], index, data) => callback(value, key, data, index)
-    );
-    this.read = () => {
-      var _a, _b;
-      const dataStr = (_b = (_a = this.storage) == null ? void 0 : _a.getItem(this.name)) != null ? _b : "[]";
-      const data = isFn5(this.parse) && fallbackIfFails3(
-        this.parse,
-        [dataStr],
-        this.triggerOnError("parse")
+      if (!isMap(data)) return this.subject.next(/* @__PURE__ */ new Map());
+      this.write(data);
+      fallbackIfFails3(
+        (_a = this.onChange) == null ? void 0 : _a.bind(this),
+        [data],
+        this.triggerOnError("onChange" /* onChange */)
       );
-      if (isMap(data)) return data;
-      return new Map(
-        fallbackIfFails3(
-          () => JSON.parse(dataStr),
-          [],
-          this.triggerOnError("parse-json")
-        )
-      );
-    };
-    this.search = (options) => search(this.getAll(), options);
-    this.set = (key, value) => {
-      this.setAll(/* @__PURE__ */ new Map([[key, value]]), false);
-      return this;
     };
-    this.setAll = (data = /* @__PURE__ */ new Map(), replace = false) => {
-      if (!isMap(data)) return this;
-      data = replace ? data : mapJoin(this.getAll(), data);
-      this.subject.next(new Map(data));
-      return this;
-    };
-    this.sort = ((byKeyOrNameOrComparator, options) => {
-      const result = sort(
-        this.getAll(),
-        byKeyOrNameOrComparator,
-        options
-      );
-      (options == null ? void 0 : options.save) && this.setAll(result, true);
-      return result;
-    });
-    this.toArray = () => getEntries(this.getAll());
-    this.toJSON = (replacer, spacing = this.spaces, data = this.getAll()) => {
-      const arr = Array.from(data);
-      const str = fallbackIfFails3(
-        () => {
-          var _a;
-          return (_a = this.stringify) == null ? void 0 : _a.call(this, data);
-        },
-        [],
-        this.triggerOnError("stringify")
-      );
-      if (isStr(str)) return str;
-      return fallbackIfFails3(
-        () => JSON.stringify(arr, replacer, spacing),
-        [],
-        this.triggerOnError("stringify-json")
+    this.triggerOnError = (type, returnValue = void 0) => (err) => {
+      var _a;
+      fallbackIfFails3(
+        (_a = this.onError) == null ? void 0 : _a.bind(this),
+        [err, type],
+        ""
       );
-    };
-    this.toObject = () => {
-      const obj = {};
-      for (const [key, value] of this.getAll()) obj[key] = value;
-      return obj;
-    };
-    this.toString = (data) => this.toJSON(void 0, void 0, data);
-    this.triggerOnError = (type) => (err) => {
-      this.onError && fallbackIfFails3(this.onError, [err, type], "");
-    };
-    this.unsubscribe = () => unsubscribeAll_default(this.subscriptions);
-    this.values = () => getValues(this.getAll());
-    this.write = (data) => {
-      try {
-        !this.initialized && this.init();
-        data != null ? data : data = this.subject.value;
-        if (!this.name || !this.storage || !isMap(data)) return false;
-        this.storage.setItem(this.name, this.toString(data));
-        return true;
-      } catch (err) {
-        this.triggerOnError("write")(err);
-        return false;
-      }
+      return returnValue;
     };
     const {
       cacheDisabled = false,
@@ -432,7 +321,7 @@ var DataStorage = class {
       storage,
       stringify
     } = options != null ? options : {};
-    this.delay = cacheDisabled ? 0 : delay === 0 || isPositiveNumber3(delay) ? delay : 300;
+    this.delay = delay === 0 || isPositiveNumber3(delay) ? delay : 300;
     this.name = `${name != null ? name : ""}`.trim();
     this.onError = onError;
     this.onChange = onChange;
@@ -456,7 +345,221 @@ var DataStorage = class {
   get size() {
     return this.getAll().size;
   }
+  clear() {
+    this.setAll(/* @__PURE__ */ new Map(), true);
+    return this;
+  }
+  delete(keys) {
+    if (!isArr2(keys)) keys = [keys];
+    const data = this.getAll();
+    for (const k of keys) data.delete(k);
+    this.setAll(data, true);
+    return this;
+  }
+  find(predicateOrOptions) {
+    return find(
+      this.getAll(),
+      predicateOrOptions
+    );
+  }
+  filter(...args) {
+    return filter(this.getAll(), ...args);
+  }
+  get(key) {
+    return this.getAll().get(key);
+  }
+  getAll(forceRead = false) {
+    var _a, _b;
+    const wasInitialized = this.initialized;
+    if (!wasInitialized) this.init();
+    const readFromStorage = this.cacheDisabled || this.name && forceRead;
+    if (readFromStorage) {
+      const data = this.read();
+      const shouldTrigger = forceRead || !wasInitialized && !!data.size;
+      shouldTrigger && this.subject.next(data);
+      return data;
+    }
+    return (_b = (_a = this.subject) == null ? void 0 : _a.value) != null ? _b : /* @__PURE__ */ new Map();
+  }
+  has(key) {
+    return this.getAll().has(key);
+  }
+  init(initialValue) {
+    if (this.initialized) return false;
+    this.initialized = true;
+    let isEmpty = true;
+    if (!!(initialValue == null ? void 0 : initialValue.size) || !this.cacheDisabled) {
+      const existingValue = this.read();
+      if (existingValue.size) initialValue = existingValue;
+      isEmpty = this.cacheDisabled || existingValue.size === 0;
+    }
+    (initialValue == null ? void 0 : initialValue.size) && this.subject.next(initialValue);
+    unsubscribeAll_default(this.subscriptions);
+    if (!this.cacheDisabled) {
+      this.subscriptions.forceUpdateCache = forceUpdateCache$.subscribe(
+        this.handleForceUpdateCacheChange
+      );
+    }
+    this.subscriptions.subject = this.subject.pipe(skip(this.cacheDisabled || isEmpty ? 0 : 1)).subscribe(
+      !this.cacheDisabled && this.delay > 0 ? deferred2(this.handleSubjectChange, this.delay, {
+        thisArg: this,
+        ...this.delayOptions
+      }) : this.handleSubjectChange
+    );
+    return true;
+  }
+  keys() {
+    return getKeys(this.getAll());
+  }
+  map(callback) {
+    return this.toArray().map(
+      ([key, value], index, data) => callback(value, key, data, index)
+    );
+  }
+  read() {
+    var _a, _b, _c;
+    const dataStr = (_b = (_a = this.storage) == null ? void 0 : _a.getItem(this.name)) != null ? _b : "";
+    const parse = (_c = this.parse) == null ? void 0 : _c.bind(this);
+    const data = fallbackIfFails3(
+      parse,
+      [dataStr],
+      this.triggerOnError("parse" /* parse */)
+    );
+    if (isMap(data)) return data;
+    return new Map(
+      fallbackIfFails3(
+        () => JSON.parse(dataStr),
+        [],
+        this.triggerOnError("parse-json" /* parse_json */)
+      )
+    );
+  }
+  search(options) {
+    return search(this.getAll(), options);
+  }
+  set(key, value) {
+    this.setAll(/* @__PURE__ */ new Map([[key, value]]), false);
+    return this;
+  }
+  setAll(data = /* @__PURE__ */ new Map(), replace = false) {
+    if (!isMap(data)) return this;
+    data = replace ? data : mapJoin(this.getAll(), data);
+    this.subject.next(new Map(data));
+    return this;
+  }
+  sort(...args) {
+    var _a;
+    const result = sort(
+      this.getAll(),
+      args[0],
+      args[1]
+    );
+    ((_a = args[1]) == null ? void 0 : _a.save) && this.setAll(result, true);
+    return result;
+  }
+  toArray() {
+    return getEntries(this.getAll());
+  }
+  toJSON(...[replacer, spacing = this.spaces, data = this.getAll()]) {
+    var _a;
+    const stringify = (_a = this.stringify) == null ? void 0 : _a.bind(this);
+    const str = fallbackIfFails3(
+      stringify,
+      [data],
+      this.triggerOnError("stringify" /* stringify */)
+    );
+    if (isStr(str)) return str;
+    return fallbackIfFails3(
+      () => JSON.stringify(
+        Array.from(data),
+        replacer,
+        spacing
+      ),
+      [],
+      this.triggerOnError("stringify-json" /* stringify_json */, "")
+    );
+  }
+  toObject(data = ((_a) => (_a = this == null ? void 0 : this.getAll) == null ? void 0 : _a.call(this))()) {
+    const obj = {};
+    data = !isMap(data) ? /* @__PURE__ */ new Map() : data;
+    for (const [key, value] of data)
+      obj[key] = value;
+    return obj;
+  }
+  toString(data) {
+    return this.toJSON(void 0, void 0, data);
+  }
+  unsubscribe() {
+    return unsubscribeAll_default(this.subscriptions);
+  }
+  values() {
+    return getValues(this.getAll());
+  }
+  write(data) {
+    try {
+      !this.initialized && this.init();
+      data != null ? data : data = this.subject.value;
+      if (!this.name || !this.storage || !isMap(data)) return false;
+      this.storage.setItem(this.name, this.toString(data));
+      return true;
+    } catch (err) {
+      this.triggerOnError("write" /* write */)(err);
+      return false;
+    }
+  }
 };
+/**
+ * Creates a {@link DataStorage} instance initialized from a plain object.
+ *
+ * This factory method automatically configures `parse` and `stringify` logic to
+ * treat the underlying storage as a serialized object, while providing a
+ * type-safe Map-like interface for individual properties.
+ *
+ * @param name (optional) The name for the storage (e.g., localStorage key or filename).
+ * @param options (optional) Configuration options for the storage instance.
+ * @param options.initialValue (optional) An optional object to populate the storage if it's currently empty.
+ *
+ * @template T (optional) The structure of the object being stored. Can auto-infer from `options.initialValue`.
+ * @template CacheDisabled (optional) Literal type determining whether to disable in-memory caching.
+ *
+ * @returns A new DataStorage instance mapped to the object's keys and values.
+ *
+ * @example
+ * #### Store and access a User object
+ * ```typescript
+ * import { DataStorage } from '@superutils/rx'
+ *
+ * interface User {
+ *   age: number;
+ *   name: string;
+ * }
+ *
+ * const initialValue: User = {
+ *   age: 99,
+ *   name: 'Ninety Nine'
+ * }
+ *
+ * // Initialize storage from the object
+ * const storage = DataStorage.fromObject<User>('user-profile', { initialValue })
+ *
+ * // Keys are inferred from the User interface
+ * const name = storage.get('name') // Inferred as: string | undefined
+ * console.log(name) // Prints: 'Ninety Nine'
+ *
+ * // Update properties safely
+ * storage.set('age', 100)
+ *
+ * // Reconstruct the updated object
+ * const userObj = storage.toObject<User>()
+ * console.log(userObj) // { age: 100, name: 'Ninety Nine' }
+ * ```
+ */
+_DataStorage.fromObject = (name, options) => new _DataStorage(name, {
+  parse: (str) => objToMap(JSON.parse(str || "{}")),
+  stringify: (data) => JSON.stringify(_DataStorage.prototype.toObject(data)),
+  ...options,
+  initialValue: !isObj2(options == null ? void 0 : options.initialValue, true) ? options == null ? void 0 : options.initialValue : objToMap(options.initialValue)
+});
 /**
  * Trigger forced update of cached data from storage.
  *
@@ -476,9 +579,10 @@ var DataStorage = class {
  * DataStorage.forceUpdateCache(true)
  * ```
  */
-DataStorage.forceUpdateCache = (name) => {
+_DataStorage.forceUpdateCache = (name) => {
   forceUpdateCache$.next(name);
 };
+var DataStorage = _DataStorage;
 
 // src/IntervalSubject.ts
 var IntervalSubject = class extends BehaviorSubject {
@@ -630,6 +734,7 @@ export {
   IGNORE_UPDATE_SYMBOL,
   IntervalRunner,
   IntervalSubject,
+  OnErrorType,
   Subject,
   Subscription,
   asPromise,

package/package.json

@@ -1,9 +1,9 @@
 {
 	"author": "Toufiqur Rahaman Chowdhury",
-	"description": "RxJS utilities and hooks for React applications.",
+	"description": "A set of small, focused utilities for working with RxJS observables and subjects.",
 	"dependencies": {
-		"@superutils/core": "^1.2.9",
-		"@superutils/promise": "^1.3.8",
+		"@superutils/core": "^1.2.10",
+		"@superutils/promise": "^1.3.9",
 		"@types/react": "^18.0.0",
 		"react": ">=16.8.0",
 		"rxjs": "^7.8.2"
@@ -49,6 +49,6 @@
 	"module": "./dist/index.js",
 	"type": "module",
 	"types": "./dist/index.d.ts",
-	"version": "0.1.4",
-	"gitHead": "1faa1c8734f9892abb9e07616b62abeeff1321b5"
+	"version": "0.1.5",
+	"gitHead": "9b77219f98125fd231d24c6e44299de7b99b679e"
 }