@superutils/rx 0.1.6 → 0.1.7

package/dist/index.js

@@ -166,6 +166,7 @@ import {
   getKeys,
   getValues,
   isArr as isArr2,
+  isDefined,
   isMap,
   isObj as isObj2,
   isPositiveNumber as isPositiveNumber3,
@@ -190,100 +191,36 @@ var OnErrorType = /* @__PURE__ */ ((OnErrorType2) => {
 // src/data-storage/DataStorage.ts
 var forceUpdateCache$ = new Subject();
 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.
-   *
-   * #### Notes:
-   * - **Performance**: `DataStorage` is optimized for small to medium datasets.
-   *   - For datasets > 1MB, consider increasing the `delay` option to reduce write frequency.
-   *   - It is **NOT** recommended for datasets larger than 3MB due to synchronous serialization costs.
-   * - **RxJS Integration**: Built on RxJS for reactive data handling, though no prior RxJS knowledge is required.
-   * - **Storage Behavior**:
-   *   - If `name` is omitted, the instance operates in-memory only and data is not persisted to storage.
-   *   - If `cacheDisabled` is `true`, data is not kept in memory; every read/write operation accesses the underlying
-   * storage directly.
-   *
-   * @example
-   * #### Browser Usage
-   * ```javascript
-   * import { DataStorage } from '@superutils/rx'
-   * import fetch from '@superutils/fetch'
-   *
-   * const storage = new DataStorage('products')
-   * const { products } = await fetch('[DUMMYJSON-DOT-COM]/products')
-   * // save all items to storage
-   * storage.setAll(
-   *   new Map(products.map(p => [p.id, p])), // convert to Map
-   * )
-   *
-   * // print product with id `1`
-   * console.log(storage.get(1))
-   *
-   * // search for items
-   * const searchResult = storage.search({
-   *   query: { availabilityStatus: 'low' }
-   * })
-   * console.log(searchResult)
-   * ```
-   * @example
-   * #### NodeJS Usage
-   * ```javascript
-   * import { DataStorage } from '@superutils/rx'
-   * import fetch from '@superutils/fetch'
-   * import { LocalStorage } from 'node-localstorage'
-   *
-   * // Add localStorage alternative for NodeJS that reads and writes to JSON files.
-   * // This is not necessary for browsers.
-   * globalThis.localStorage = new LocalStorage('./data', 1e7)
-   *
-   * const storage = new DataStorage('products')
-   * const { products } = await fetch('[DUMMYJSON-DOT-COM]/products')
-   * // save all items to storage
-   * storage.setAll(
-   *   new Map(products.map(p => [p.id, p])), // convert to Map
-   * )
-   *
-   * // print product with id `1`
-   * console.log(storage.get(1))
-   *
-   * // search for items
-   * const searchResult = storage.search({
-   *   query: { availabilityStatus: 'low' }
-   * })
-   * console.log(searchResult)
-   * ```
-   *
-   * @example
-   * #### Advanced: `onChange` and RxJS subject
-   *
-   * Internally, `DataStorage` uses RxJS subject which is exposed as `subject` property.
-   * You can use this to subscribe to changes and do additional operations such as logging or sanitization etc.
-   *
-   * Alternatively, you can also set the `onChange` callback which is triggered whenever the subject changes and
-   * does not require maintaining a subscription or knowledge of RxJS subject.
-   *
-   * ```javascript
-   * import { DataStorage } from '@superutils/rx'
-   *
-   * const storage = new DataStorage('my-data')
-   * const sub = storage.subject.subscribe(data => {
-   *   // Write to the database whenever data changes
-   *   console.log('Saving to database...', data)
-   * })
-   * // unsubscribe from subject
-   * setTimeout(()=> sub.unsbuscribe(), 1000)
-   *
-   * // add an entry to storage
-   * storage.set('bob', { age: 99, id: 'bob', name: 'Bob' })
-   * ```
-   */
   constructor(name, options) {
     this.initialized = false;
     this.subscriptions = {
       subject: void 0,
       forceUpdateCache: void 0
     };
+    this.clear = () => this.setAll(/* @__PURE__ */ new Map(), true);
+    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.filter = (...args) => filter(this.getAll(), ...args);
+    this.find = (predicateOrOptions) => find(this.getAll(), predicateOrOptions);
+    this.get = (key) => this.getAll().get(key);
+    this.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();
+    };
     this.handleForceUpdateCacheChange = (name) => {
       const isTarget = !this.name ? false : isArr2(name) ? name.includes(this.name) : isStr(name) ? name === this.name : name === true;
       if (!isTarget) return;
@@ -300,6 +237,107 @@ var _DataStorage = class _DataStorage {
         this.triggerOnError("onChange" /* onChange */)
       );
     };
+    this.has = (key) => this.getAll().has(key);
+    this.init = (initialValue) => {
+      var _a;
+      if (this.initialized) return false;
+      this.initialized = true;
+      let isEmpty = true;
+      if (!!(initialValue == null ? void 0 : initialValue.size) || !this.cacheDisabled) {
+        const dataStr = this.name ? (_a = this.storage) == null ? void 0 : _a.getItem(this.name) : null;
+        const existingValue = this.read(dataStr);
+        if (isDefined(dataStr)) 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;
+    };
+    this.keys = () => getKeys(this.getAll());
+    this.map = (callback) => this.toArray().map(
+      ([key, value], index, entries) => callback(value, key, entries, index)
+    );
+    this.read = (dataStr = this.name ? ((_a) => (_a = this.storage) == null ? void 0 : _a.getItem(this.name))() : null) => {
+      var _a2;
+      if (!this.name) {
+        return (_a2 = this.subject.value) != null ? _a2 : /* @__PURE__ */ new Map();
+      }
+      const data = fallbackIfFails3(
+        (() => {
+          var _a3;
+          return (_a3 = this.parse) == null ? void 0 : _a3.call(this, dataStr);
+        }),
+        [],
+        this.triggerOnError("parse" /* parse */)
+      );
+      if (isMap(data)) return data;
+      if (!isStr(dataStr)) return /* @__PURE__ */ new Map();
+      return new Map(
+        fallbackIfFails3(
+          () => JSON.parse(dataStr),
+          [],
+          this.triggerOnError("parse-json" /* parse_json */)
+        )
+      );
+    };
+    this.search = (...args) => search(this.getAll(), ...args);
+    this.set = (key, value) => this.setAll(/* @__PURE__ */ new Map([[key, value]]), false);
+    this.setAll = (data, replace = false) => {
+      if (!isMap(data)) return this;
+      data = replace ? data : mapJoin(this.getAll(), data);
+      this.subject.next(new Map(data));
+      return this;
+    };
+    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;
+    };
+    this.toArray = () => getEntries(this.getAll());
+    this.toJSON = (replacer, spacing = this.spaces, data = this.getAll()) => {
+      const str = fallbackIfFails3(
+        (() => {
+          var _a;
+          return (_a = this.stringify) == null ? void 0 : _a.call(this, 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 */, "")
+      );
+    };
+    this.toObject = (data = this.getAll()) => {
+      const obj = {};
+      if (!isMap(data)) return obj;
+      for (const [key, value] of data)
+        obj[key] = value;
+      return obj;
+    };
+    this.toString = (data = this.getAll()) => this.toJSON(void 0, void 0, data);
     this.triggerOnError = (type, returnValue = void 0) => (err) => {
       var _a;
       fallbackIfFails3(
@@ -309,6 +347,21 @@ var _DataStorage = class _DataStorage {
       );
       return returnValue;
     };
+    this.unsubscribe = () => unsubscribeAll_default(this.subscriptions);
+    this.values = () => getValues(this.getAll());
+    this.write = (data) => {
+      var _a;
+      try {
+        !this.initialized && this.init();
+        const finalData = data != null ? data : (_a = this.subject) == null ? void 0 : _a.value;
+        if (!this.name || !this.storage || !isMap(finalData)) return false;
+        this.storage.setItem(this.name, this.toString(finalData));
+        return true;
+      } catch (err) {
+        this.triggerOnError("write" /* write */)(err);
+        return false;
+      }
+    };
     const {
       cacheDisabled = false,
       delay,
@@ -345,168 +398,6 @@ var _DataStorage = class _DataStorage {
   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.
@@ -555,35 +446,30 @@ var _DataStorage = class _DataStorage {
  * ```
  */
 _DataStorage.fromObject = (name, options) => new _DataStorage(name, {
-  parse: (str) => objToMap(JSON.parse(str || "{}")),
-  stringify: (data) => JSON.stringify(_DataStorage.prototype.toObject(data)),
+  parse: (str) => objToMap(JSON.parse(str != null ? str : "{}")),
+  stringify: function(data) {
+    return JSON.stringify(this.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.
  *
- * @param name determines which storage instances to be updated.
+ * @param name determines which cache-enabled storage instances to be updated.
  * - name (`string` | `string[]`): update all instances with a specific name(s)
  * - global (`true`): update all instances globally
  *
- * @example
- * ```javascript
- * import { DataStorage } from '@superutils/rx'
- *
- * // Update all DataStorage instances with specific name(s)
- * const name = 'products'
- * DataStorage.forceUpdateCache([name])
- *
- * // Update every single instance of DataStorage that uses storage (has a "name")
- * DataStorage.forceUpdateCache(true)
- * ```
+ * See {@link forceUpdateCache$} for more details.
  */
 _DataStorage.forceUpdateCache = (name) => {
   forceUpdateCache$.next(name);
 };
 var DataStorage = _DataStorage;
 
+// src/data-storage/index.ts
+import { objToMap as objToMap2 } from "@superutils/core";
+
 // src/IntervalSubject.ts
 var IntervalSubject = class extends BehaviorSubject {
   constructor(autoStart, _delay = 1e3, initialValue = 0, incrementBy = 1) {
@@ -743,6 +629,7 @@ export {
   isObservable,
   isSubjectLike2 as isSubjectLike,
   isSubscriptionLike,
+  objToMap2 as objToMap,
   skip,
   unsubscribeAll
 };

package/package.json

@@ -2,8 +2,8 @@
 	"author": "Toufiqur Rahaman Chowdhury",
 	"description": "A set of small, focused utilities for working with RxJS observables and subjects.",
 	"dependencies": {
-		"@superutils/core": "^1.2.11",
-		"@superutils/promise": "^1.3.10",
+		"@superutils/core": "^1.2.12",
+		"@superutils/promise": "^1.3.11",
 		"@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.6",
-	"gitHead": "c97c6ce7baebd9de3a314616594e69b435d7b719"
+	"version": "0.1.7",
+	"gitHead": "22050737e69a5e7a6fea402c2e5540f3d0c2375c"
 }