@superutils/rx 0.1.13 → 0.1.14

package/dist/index.js

@@ -4,44 +4,31 @@ import {
   isError,
   isFn,
   isObj,
-  isPositiveNumber,
-  isSubjectLike
+  isPositiveNumber
 } from "@superutils/core";
-import PromisE, {
+import {
+  timeout,
   TIMEOUT_MAX
 } from "@superutils/promise";
-
-// src/rxjs.ts
-import {
-  BehaviorSubject,
-  isObservable,
-  skip,
-  Subject,
-  Subscription
-} from "rxjs";
-
-// src/asPromise.ts
-var asPromise = (subject, expectedValue, timeoutOrOptions) => {
-  if (!isSubjectLike(subject) && !isObservable(subject))
-    return PromisE.reject(
-      new Error("subject must be an instance of BehaviorSubject")
-    );
+import { isObservable, skip } from "rxjs";
+var asPromise = (input$, expectedValue, timeoutOrOptions) => {
   let subscription;
   const options = isObj(timeoutOrOptions) ? timeoutOrOptions : { timeout: timeoutOrOptions };
   options.timeout = isPositiveNumber(options.timeout) ? options.timeout : TIMEOUT_MAX;
-  const promise = PromisE.timeout(
+  const promise = timeout(
     {
       ...options,
       onTimeout: async () => {
-        const { onTimeout, timeoutMsg } = options;
-        const msg = await fallbackIfFails(onTimeout, [], void 0);
-        return msg != null ? msg : isError(timeoutMsg) ? timeoutMsg : new Error(
-          timeoutMsg != null ? timeoutMsg : "request timed out before an expected value is received"
-        );
+        var _a, _b;
+        const msg = (_a = options.timeoutMsg) != null ? _a : asPromise.defaults.timeoutMsg;
+        return (_b = await fallbackIfFails(options.onTimeout, [], void 0)) != null ? _b : isError(msg) ? msg : new Error(msg);
       }
     },
-    new PromisE((resolve) => {
-      subscription = subject.subscribe((value) => {
+    new Promise((resolve, reject) => {
+      var _a;
+      if (!isObservable(input$))
+        return reject(new Error(asPromise.defaults.invalidInputMsg));
+      subscription = input$.pipe(skip((_a = options.skip) != null ? _a : 0)).subscribe((value) => {
         const shouldResolve = value === expectedValue || expectedValue === void 0 || isFn(expectedValue) && fallbackIfFails(expectedValue, [value], false);
         shouldResolve && resolve(value);
       });
@@ -53,26 +40,34 @@ var asPromise = (subject, expectedValue, timeoutOrOptions) => {
   });
   return promise;
 };
+asPromise.defaults = {
+  invalidInputMsg: "Input must be an observable or subject instance",
+  timeoutMsg: "Request timed out before an expected value is received"
+};
 
-// src/copyRxSubject.ts
+// src/copyRx.ts
 import {
   deferred,
   fallbackIfFails as fallbackIfFails2,
   isArr,
   isFn as isFn4,
-  isPositiveNumber as isPositiveNumber2
+  isPositiveNumber as isPositiveNumber2,
+  isPromise,
+  isSubjectLike
 } from "@superutils/core";
-
-// src/isSubjectLike.ts
-import { isSubjectLike as _isSubjectLike } from "@superutils/core";
-var isSubjectLike2 = (x, withValue = false) => _isSubjectLike(x, withValue);
-var isSubjectLike_default = isSubjectLike2;
+import PromisE from "@superutils/promise";
+import {
+  BehaviorSubject,
+  isObservable as isObservable2,
+  skip as skip2
+} from "rxjs";
 
 // src/unsubscribeAll.ts
 import { isFn as isFn3 } from "@superutils/core";
 
 // src/isSubscriptionLike.ts
 import { isBool, isFn as isFn2 } from "@superutils/core";
+import { Subscription } from "rxjs";
 var isSubscriptionLike = (value, strict = false) => {
   if (value instanceof Subscription) return true;
   const sub = value;
@@ -81,399 +76,99 @@ var isSubscriptionLike = (value, strict = false) => {
 var isSubscriptionLike_default = isSubscriptionLike;
 
 // src/unsubscribeAll.ts
-var unsubscribeAll = (unsub = {}, onError) => {
-  if (!unsub) return;
+var unsubscribeAll = (candidate = {}, onError) => {
+  if (!candidate) return;
   try {
-    if (isFn3(unsub)) return unsub();
-    if (isSubscriptionLike_default(unsub)) return unsub.unsubscribe();
-    Object.values(unsub).forEach(
+    if (isFn3(candidate)) {
+      candidate();
+      return;
+    }
+    if (isSubscriptionLike_default(candidate)) {
+      candidate.unsubscribe();
+      return;
+    }
+    Object.values(candidate).forEach(
       (value) => unsubscribeAll(value, onError)
     );
   } catch (err) {
     onError == null ? void 0 : onError(err);
   }
 };
-var unsubscribeAll_default = unsubscribeAll;
 
-// src/copyRxSubject.ts
-var IGNORE_UPDATE_SYMBOL = /* @__PURE__ */ Symbol("ignore-rx-update");
-function copyRxSubject(source$, copy$, valueModifier, options) {
-  var _a;
-  copy$ = isSubjectLike_default(copy$) ? copy$ : new BehaviorSubject(void 0);
-  options = {
-    ...copyRxSubject.defaults,
-    ...options != null ? options : {}
-  };
-  const sourceArr = isSubjectLike_default(source$) ? [source$] : isArr(source$) ? source$ : [source$];
+// src/copyRx.ts
+var IGNORE_UPDATE_SYMBOL = /* @__PURE__ */ Symbol("ignore-update");
+function copyRx(source$, transform, options) {
+  var _a, _b, _c, _d;
+  const sourceArr = isObservable2(source$) ? [source$] : isArr(source$) ? source$ : [source$];
   const cache = new Map(
-    sourceArr.map((subject, i) => [
+    sourceArr.map((x, i) => [
       i,
-      isSubjectLike_default(subject) ? subject.value : subject
+      isObservable2(x) ? x.value : x
       // fixed value provided
     ])
   );
-  const triggerChange = () => {
+  const _options = {
+    ...copyRx.defaults,
+    ...options != null ? options : {}
+  };
+  if (!isArr(_options.skipEmits)) _options.skipEmits = [_options.skipEmits];
+  if (_options.thisArg !== void 0) {
+    _options.onError = (_b = (_a = _options.onError) == null ? void 0 : _a.bind) == null ? void 0 : _b.call(_a, _options.thisArg);
+    transform = (_c = transform == null ? void 0 : transform.bind) == null ? void 0 : _c.call(transform, _options.thisArg);
+  }
+  if (isFn4(transform) && _options.transformSequentially)
+    transform = PromisE.deferredCallback(transform, {
+      delay: 0,
+      // enables sequential execution
+      onError: _options.onError,
+      thisArg: _options.thisArg
+    });
+  const copy$ = isSubjectLike(_options.output) ? _options.output : new BehaviorSubject(_options.initialValue);
+  const updateOutput = (value) => value !== copyRx.IGNORE && copy$.next(value);
+  let handleChange = () => {
     const currentValue = isArr(source$) ? [...cache.values()] : cache.get(0);
-    if (!isFn4(valueModifier)) return copy$.next(currentValue);
-    const modifiedValue = fallbackIfFails2(
-      valueModifier,
-      [currentValue, void 0, copy$],
+    if (!isFn4(transform)) return copy$.next(currentValue);
+    const result = fallbackIfFails2(
+      transform,
+      [currentValue, copy$],
       (err) => {
-        var _a2;
-        fallbackIfFails2(
-          (_a2 = options.onError) == null ? void 0 : _a2.bind(options.thisArg),
-          [err],
-          void 0
-        );
-        return IGNORE_UPDATE_SYMBOL;
+        fallbackIfFails2(_options.onError, [err], void 0);
+        return copyRx.IGNORE;
       }
     );
-    modifiedValue !== IGNORE_UPDATE_SYMBOL && copy$.next(modifiedValue);
+    !isPromise(result) ? updateOutput(result) : result.then(updateOutput);
   };
-  const triggerChangeDeferred = isPositiveNumber2(options.delay) ? deferred(triggerChange, options.delay, options) : triggerChange;
-  const subscriptions = sourceArr.map((subject, i) => {
-    if (!isSubjectLike_default(subject) || subject.closed) return;
-    return (subject instanceof BehaviorSubject ? subject.pipe(
-      skip(1)
-      // skip initial value
-    ) : subject).subscribe((newValue) => {
-      cache.set(i, newValue);
-      triggerChangeDeferred();
+  handleChange = isPositiveNumber2(_options.delay) ? deferred(handleChange, _options.delay, _options) : handleChange;
+  const subscriptions = sourceArr.map((x, i) => {
+    var _a2;
+    if (!isObservable2(x) || x.closed) return;
+    const skipEmit = (_a2 = _options.skipEmits[i]) != null ? _a2 : x instanceof BehaviorSubject ? 1 : 0;
+    if (skipEmit > 0) x = x.pipe(skip2(skipEmit));
+    return x.subscribe({
+      next: (newValue) => {
+        cache.set(i, newValue);
+        handleChange();
+      }
     });
-  }).filter(Boolean);
-  const unsubscribeOrg = (_a = copy$ == null ? void 0 : copy$.unsubscribe) == null ? void 0 : _a.bind(copy$);
+  });
+  const unsubscribeOrg = (_d = copy$.unsubscribe) == null ? void 0 : _d.bind(copy$);
   copy$.unsubscribe = (...args) => {
     unsubscribeOrg == null ? void 0 : unsubscribeOrg(...args);
     unsubscribeAll(subscriptions);
     cache.clear();
   };
-  triggerChange();
+  handleChange();
   return copy$;
 }
-copyRxSubject.defaults = {
+copyRx.defaults = {
   delay: 0,
   throttle: false
 };
-copyRxSubject.IGNORE_UPDATE_SYMBOL = IGNORE_UPDATE_SYMBOL;
-
-// src/data-storage/DataStorage.ts
-import {
-  deferred as deferred2,
-  fallbackIfFails as fallbackIfFails3,
-  filter,
-  find,
-  getEntries,
-  getKeys,
-  getValues,
-  isArr as isArr2,
-  isDefined,
-  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 _DataStorage {
-  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;
-      const newData = this.read();
-      this.subject.next(newData);
-    };
-    this.handleSubjectChange = (data) => {
-      var _a;
-      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 */)
-      );
-    };
-    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(
-        (_a = this.onError) == null ? void 0 : _a.bind(this),
-        [err, type],
-        ""
-      );
-      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,
-      delayOptions,
-      initialValue,
-      onError,
-      onChange,
-      parse,
-      spaces,
-      storage,
-      stringify
-    } = options != null ? options : {};
-    this.delay = delay === 0 || isPositiveNumber3(delay) ? delay : 300;
-    this.name = `${name != null ? name : ""}`.trim();
-    this.onError = onError;
-    this.onChange = onChange;
-    this.parse = parse;
-    this.storage = storage === null ? null : storage != null ? storage : fallbackIfFails3(
-      () => globalThis.localStorage,
-      [],
-      void 0
-    );
-    if (this.name && !this.storage)
-      throw new Error(
-        "options.storage: LocalStorage instance or equivalent required"
-      );
-    this.cacheDisabled = !!this.storage && cacheDisabled;
-    this.stringify = stringify;
-    this.spaces = spaces;
-    this.subject = this.cacheDisabled ? new Subject() : new BehaviorSubject(void 0);
-    this.delayOptions = delayOptions;
-    isMap(initialValue) && initialValue.size && this.init(initialValue);
-  }
-  get size() {
-    return this.getAll().size;
-  }
-};
-/**
- * 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.
- *
- * This default behavior can be overridden by providing custom `parse` and `stringify` implementations in `options`.
- *
- * @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 != 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 cache-enabled storage instances to be updated.
- * - name (`string` | `string[]`): update all instances with a specific name(s)
- * - global (`true`): update all instances globally
- *
- * 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";
+copyRx.IGNORE = IGNORE_UPDATE_SYMBOL;
 
 // src/IntervalSubject.ts
-var IntervalSubject = class extends BehaviorSubject {
+import { BehaviorSubject as BehaviorSubject2 } from "rxjs";
+var IntervalSubject = class extends BehaviorSubject2 {
   constructor(autoStart, _delay = 1e3, initialValue = 0, incrementBy = 1) {
     super(initialValue);
     this.autoStart = autoStart;
@@ -516,7 +211,8 @@ var IntervalSubject = class extends BehaviorSubject {
 };
 
 // src/IntervalRunner.ts
-import { fallbackIfFails as fallbackIfFails4, noop } from "@superutils/core";
+import { fallbackIfFails as fallbackIfFails3, noop } from "@superutils/core";
+import { BehaviorSubject as BehaviorSubject3 } from "rxjs";
 var IntervalRunner = class {
   constructor(taskFn, taskArgs, intervalMs, sequential = true, preExecute = true) {
     this.taskFn = taskFn;
@@ -543,7 +239,7 @@ var IntervalRunner = class {
       } catch (_err) {
         err = _err;
       }
-      fallbackIfFails4(
+      fallbackIfFails3(
         this.onResult,
         [err != null ? err : null, result, this.runCount, once],
         void 0
@@ -613,25 +309,15 @@ var IntervalRunner = class {
       this.clearInterval();
       return this;
     };
-    this.intervalMs$ = intervalMs instanceof BehaviorSubject ? intervalMs : new BehaviorSubject(intervalMs);
+    this.intervalMs$ = intervalMs instanceof BehaviorSubject3 ? intervalMs : new BehaviorSubject3(intervalMs);
   }
 };
 export {
-  BehaviorSubject,
-  DataStorage,
   IGNORE_UPDATE_SYMBOL,
   IntervalRunner,
   IntervalSubject,
-  OnErrorType,
-  Subject,
-  Subscription,
   asPromise,
-  copyRxSubject,
-  forceUpdateCache$,
-  isObservable,
-  isSubjectLike2 as isSubjectLike,
+  copyRx,
   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.17",
-		"@superutils/promise": "^1.3.16",
+		"@superutils/core": "^1.2.18",
+		"@superutils/promise": "^1.3.17",
 		"@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.13",
-	"gitHead": "63216686cba0a287fc167e02d9137b9e7e6942c1"
+	"version": "0.1.14",
+	"gitHead": "9e526ce83ac97f6ba66a06a6d2e95798a4660823"
 }