@superutils/rx 0.1.1 → 0.1.3

package/dist/index.cjs

@@ -278,8 +278,6 @@ var DataStorage = class {
    * ```
    */
   constructor(name, options) {
-    /** Debounce and throttle related options */
-    // readonly deferOptions
     this.initialized = false;
     this.subscriptions = {
       subject: void 0,
@@ -296,7 +294,10 @@ var DataStorage = class {
       this.setAll(data, true);
       return this;
     };
-    this.find = (predicateOrOptions) => (0, import_core6.find)(this.getAll(), predicateOrOptions);
+    this.find = (predicateOrOptions) => (0, import_core6.find)(
+      this.getAll(),
+      predicateOrOptions
+    );
     this.filter = (predicate, limit, asArray, result) => (0, import_core6.filter)(this.getAll(), predicate, limit, asArray, result);
     this.get = (key) => this.getAll().get(key);
     this.getAll = (forceRead = false) => {
@@ -337,9 +338,9 @@ var DataStorage = class {
         if (!(0, import_core6.isMap)(data)) return this.subject.next(/* @__PURE__ */ new Map());
         this.write(data);
         (0, import_core6.fallbackIfFails)(
-          async () => {
+          () => {
             var _a2;
-            return await ((_a2 = this.onChange) == null ? void 0 : _a2.call(this, data));
+            return (_a2 = this.onChange) == null ? void 0 : _a2.call(this, data);
           },
           [],
           this.triggerOnError("onChange")
@@ -382,10 +383,10 @@ var DataStorage = class {
       this.subject.next(new Map(data));
       return this;
     };
-    this.sort = ((nameOrComparator, options) => {
+    this.sort = ((byKeyOrNameOrComparator, options) => {
       const result = (0, import_core6.sort)(
         this.getAll(),
-        nameOrComparator,
+        byKeyOrNameOrComparator,
         options
       );
       (options == null ? void 0 : options.save) && this.setAll(result, true);
@@ -409,12 +410,17 @@ var DataStorage = class {
         this.triggerOnError("stringify-json")
       );
     };
+    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 && (0, import_core6.fallbackIfFails)(this.onError, [err, type], "");
     };
     this.unsubscribe = () => unsubscribeAll_default(this.subscriptions);
-    this.values = () => [...this.getAll().values()];
+    this.values = () => (0, import_core6.getValues)(this.getAll());
     this.write = (data) => {
       try {
         !this.initialized && this.init();

package/dist/index.d.cts

@@ -102,7 +102,7 @@ type ValueModifier<T = unknown, TCopy = T> = (newValue: T, previousValue: TCopy
  *   null,
  *   // copy and transform the value from number$
  *   newValue => newValue % 2 === 0,
- *   // debounce/throttle value changes to even$t
+ *   // debounce/throttle value changes to even$
  *   // {
  *   //   delay: 300 //
  *   //   throttle: false,
@@ -160,7 +160,7 @@ type StorageMap<K, V extends StorageValue> = <T>(callback: (value: V, key: K, da
 type StorageOnChangeFn<K, V extends StorageValue> = (data: Map<K, V>) => ValueOrPromise<void | Map<K, V>>;
 type StorageOnErrorFn = (err: unknown, type: OnErrorType) => ValueOrPromise<void>;
 /** Initial options provided through the constructor */
-type StorageOptions<Key, Value extends StorageValue, CacheDisabled extends boolean = false> = {
+type StorageOptions<Key extends StorageKey, Value extends StorageValue, CacheDisabled extends boolean = false> = {
     /** value to set, only if storage is empty. Default: `new Map()` */
     initialValue?: Map<Key, Value>;
 } & Pick<Partial<IDataStorage<Key, Value, CacheDisabled>>, 'cacheDisabled' | 'onChange' | 'onError' | 'parse' | 'spaces' | 'storage' | 'stringify'> & (CacheDisabled extends false ? Pick<Partial<IDataStorage<Key, Value, CacheDisabled>>, 'delay' | 'delayOptions'> : {
@@ -184,8 +184,9 @@ type StorageSortOptions = SortOptions & {
 };
 type StorageStringifyFn<K, V extends StorageValue> = (data: Map<K, V>) => string;
 type StorageToJSON<K, V> = (replacer?: null | ((key: K, value: V) => unknown), spacing?: string | number, data?: Map<K, V>) => string;
-type StorageValue = Record<PropertyKey, unknown>;
-interface IDataStorage<Key, Value extends StorageValue, CacheDisabled extends boolean = false> {
+type StorageKey = string;
+type StorageValue = object;
+interface IDataStorage<Key extends StorageKey, Value extends StorageValue, CacheDisabled extends boolean = false> {
     /** Disable in-memory cache and only directly read/write from storage (local storage or JSON fle) */
     readonly cacheDisabled: CacheDisabled;
     /**
@@ -227,6 +228,15 @@ interface IDataStorage<Key, Value extends StorageValue, CacheDisabled extends bo
      * - node: `undefined` (in-memory mode)
      */
     readonly storage?: StorageCompact | null;
+    /**
+     * The underlying RxJS Subject that serves as the primary reactive interface for observing data modifications.
+     *
+     * Its implementation type is determined by the caching strategy:
+     * - **BehaviorSubject**: Used when caching is enabled.
+     * It maintains the current state and emits it immediately to new subscribers.
+     * - **Subject**: Used when caching is disabled.
+     * It acts as a pure event pipe, emitting updates only at the moment they occur without retaining an in-memory copy.
+     */
     readonly subject: CacheDisabled extends true ? Subject<Map<Key, Value>> : BehaviorSubject<Map<Key, Value>>;
     /** Clear all items */
     readonly clear: () => IDataStorage<Key, Value, CacheDisabled>;
@@ -346,6 +356,8 @@ interface IDataStorage<Key, Value extends StorageValue, CacheDisabled extends bo
     readonly toArray: () => [Key, Value][];
     /** Convert list of items (Map) to JSON string of 2D Array */
     readonly toJSON: StorageToJSON<Key, Value>;
+    /** Convert list of items into an object */
+    readonly toObject: () => Record<Key, Value>;
     /** Convert list of items (Map) to JSON string of 2D Array */
     readonly toString: () => string;
     /**
@@ -357,7 +369,7 @@ interface IDataStorage<Key, Value extends StorageValue, CacheDisabled extends bo
      * - The instance stopping listening to force update cache triggers.
      */
     readonly unsubscribe: () => void;
-    /** Get all values */
+    /** Get all values as an array */
     readonly values: () => Value[];
     /**
      * Write data to the underlying storage (localStorage or file).
@@ -391,11 +403,11 @@ interface IDataStorage<Key, Value extends StorageValue, CacheDisabled extends bo
  * ```
  */
 declare const forceUpdateCache$: Subject<string | boolean | string[]>;
-declare class DataStorage<Key, Value extends StorageValue, CacheDisabled extends boolean = false> implements IDataStorage<Key, Value, CacheDisabled> {
+declare class DataStorage<Key extends StorageKey, Value extends StorageValue, CacheDisabled extends boolean = false> implements IDataStorage<Key, Value, CacheDisabled> {
     readonly cacheDisabled: CacheDisabled;
     readonly delay: number;
-    readonly delayOptions?: DelayOptions;
     /** Debounce and throttle related options */
+    readonly delayOptions?: DelayOptions;
     readonly initialized: boolean;
     readonly name: string;
     get size(): number;
@@ -533,6 +545,7 @@ declare class DataStorage<Key, Value extends StorageValue, CacheDisabled extends
     readonly stringify?: StorageStringifyFn<Key, Value>;
     readonly toArray: () => [Key, Value][];
     readonly toJSON: StorageToJSON<Key, Value>;
+    readonly toObject: () => Record<Key, Value>;
     readonly toString: (data?: Map<Key, Value>) => string;
     private triggerOnError;
     readonly unsubscribe: () => void;
@@ -727,4 +740,4 @@ declare const isSubscriptionLike: (value: unknown, strict?: boolean) => value is
  */
 declare const unsubscribeAll: (unsub?: UnsubscribeCandidates, onError?: (err: unknown) => void) => void;
 
-export { type CopyRxSubjectOptions, DataStorage, type DelayOptions, type IDataStorage, IGNORE_UPDATE_SYMBOL, IntervalRunner, IntervalSubject, type OnErrorType, type OnResultType, type StorageCompact, type StorageFilter, type StorageFind, type StorageMap, type StorageOnChangeFn, type StorageOnErrorFn, type StorageOptions, type StorageParseFn, type StorageSearch, type StorageSort, type StorageSortByComparator, type StorageSortByKey, type StorageSortByPropertyName, type StorageSortOptions, type StorageStringifyFn, type StorageToJSON, type StorageValue, type SubjectLike, type SubscriptionLike, type Unsubscribe, type UnsubscribeCandidates, type UnwrapSubjectValue, type ValueModifier, asPromise, copyRxSubject, forceUpdateCache$, isSubjectLike, isSubscriptionLike, type onBeforeExecType, unsubscribeAll };
+export { type CopyRxSubjectOptions, DataStorage, type DelayOptions, type IDataStorage, IGNORE_UPDATE_SYMBOL, IntervalRunner, IntervalSubject, type OnErrorType, type OnResultType, type StorageCompact, type StorageFilter, type StorageFind, type StorageKey, type StorageMap, type StorageOnChangeFn, type StorageOnErrorFn, type StorageOptions, type StorageParseFn, type StorageSearch, type StorageSort, type StorageSortByComparator, type StorageSortByKey, type StorageSortByPropertyName, type StorageSortOptions, type StorageStringifyFn, type StorageToJSON, type StorageValue, type SubjectLike, type SubscriptionLike, type Unsubscribe, type UnsubscribeCandidates, type UnwrapSubjectValue, type ValueModifier, asPromise, copyRxSubject, forceUpdateCache$, isSubjectLike, isSubscriptionLike, type onBeforeExecType, unsubscribeAll };

package/dist/index.d.ts

@@ -102,7 +102,7 @@ type ValueModifier<T = unknown, TCopy = T> = (newValue: T, previousValue: TCopy
  *   null,
  *   // copy and transform the value from number$
  *   newValue => newValue % 2 === 0,
- *   // debounce/throttle value changes to even$t
+ *   // debounce/throttle value changes to even$
  *   // {
  *   //   delay: 300 //
  *   //   throttle: false,
@@ -160,7 +160,7 @@ type StorageMap<K, V extends StorageValue> = <T>(callback: (value: V, key: K, da
 type StorageOnChangeFn<K, V extends StorageValue> = (data: Map<K, V>) => ValueOrPromise<void | Map<K, V>>;
 type StorageOnErrorFn = (err: unknown, type: OnErrorType) => ValueOrPromise<void>;
 /** Initial options provided through the constructor */
-type StorageOptions<Key, Value extends StorageValue, CacheDisabled extends boolean = false> = {
+type StorageOptions<Key extends StorageKey, Value extends StorageValue, CacheDisabled extends boolean = false> = {
     /** value to set, only if storage is empty. Default: `new Map()` */
     initialValue?: Map<Key, Value>;
 } & Pick<Partial<IDataStorage<Key, Value, CacheDisabled>>, 'cacheDisabled' | 'onChange' | 'onError' | 'parse' | 'spaces' | 'storage' | 'stringify'> & (CacheDisabled extends false ? Pick<Partial<IDataStorage<Key, Value, CacheDisabled>>, 'delay' | 'delayOptions'> : {
@@ -184,8 +184,9 @@ type StorageSortOptions = SortOptions & {
 };
 type StorageStringifyFn<K, V extends StorageValue> = (data: Map<K, V>) => string;
 type StorageToJSON<K, V> = (replacer?: null | ((key: K, value: V) => unknown), spacing?: string | number, data?: Map<K, V>) => string;
-type StorageValue = Record<PropertyKey, unknown>;
-interface IDataStorage<Key, Value extends StorageValue, CacheDisabled extends boolean = false> {
+type StorageKey = string;
+type StorageValue = object;
+interface IDataStorage<Key extends StorageKey, Value extends StorageValue, CacheDisabled extends boolean = false> {
     /** Disable in-memory cache and only directly read/write from storage (local storage or JSON fle) */
     readonly cacheDisabled: CacheDisabled;
     /**
@@ -227,6 +228,15 @@ interface IDataStorage<Key, Value extends StorageValue, CacheDisabled extends bo
      * - node: `undefined` (in-memory mode)
      */
     readonly storage?: StorageCompact | null;
+    /**
+     * The underlying RxJS Subject that serves as the primary reactive interface for observing data modifications.
+     *
+     * Its implementation type is determined by the caching strategy:
+     * - **BehaviorSubject**: Used when caching is enabled.
+     * It maintains the current state and emits it immediately to new subscribers.
+     * - **Subject**: Used when caching is disabled.
+     * It acts as a pure event pipe, emitting updates only at the moment they occur without retaining an in-memory copy.
+     */
     readonly subject: CacheDisabled extends true ? Subject<Map<Key, Value>> : BehaviorSubject<Map<Key, Value>>;
     /** Clear all items */
     readonly clear: () => IDataStorage<Key, Value, CacheDisabled>;
@@ -346,6 +356,8 @@ interface IDataStorage<Key, Value extends StorageValue, CacheDisabled extends bo
     readonly toArray: () => [Key, Value][];
     /** Convert list of items (Map) to JSON string of 2D Array */
     readonly toJSON: StorageToJSON<Key, Value>;
+    /** Convert list of items into an object */
+    readonly toObject: () => Record<Key, Value>;
     /** Convert list of items (Map) to JSON string of 2D Array */
     readonly toString: () => string;
     /**
@@ -357,7 +369,7 @@ interface IDataStorage<Key, Value extends StorageValue, CacheDisabled extends bo
      * - The instance stopping listening to force update cache triggers.
      */
     readonly unsubscribe: () => void;
-    /** Get all values */
+    /** Get all values as an array */
     readonly values: () => Value[];
     /**
      * Write data to the underlying storage (localStorage or file).
@@ -391,11 +403,11 @@ interface IDataStorage<Key, Value extends StorageValue, CacheDisabled extends bo
  * ```
  */
 declare const forceUpdateCache$: Subject<string | boolean | string[]>;
-declare class DataStorage<Key, Value extends StorageValue, CacheDisabled extends boolean = false> implements IDataStorage<Key, Value, CacheDisabled> {
+declare class DataStorage<Key extends StorageKey, Value extends StorageValue, CacheDisabled extends boolean = false> implements IDataStorage<Key, Value, CacheDisabled> {
     readonly cacheDisabled: CacheDisabled;
     readonly delay: number;
-    readonly delayOptions?: DelayOptions;
     /** Debounce and throttle related options */
+    readonly delayOptions?: DelayOptions;
     readonly initialized: boolean;
     readonly name: string;
     get size(): number;
@@ -533,6 +545,7 @@ declare class DataStorage<Key, Value extends StorageValue, CacheDisabled extends
     readonly stringify?: StorageStringifyFn<Key, Value>;
     readonly toArray: () => [Key, Value][];
     readonly toJSON: StorageToJSON<Key, Value>;
+    readonly toObject: () => Record<Key, Value>;
     readonly toString: (data?: Map<Key, Value>) => string;
     private triggerOnError;
     readonly unsubscribe: () => void;
@@ -727,4 +740,4 @@ declare const isSubscriptionLike: (value: unknown, strict?: boolean) => value is
  */
 declare const unsubscribeAll: (unsub?: UnsubscribeCandidates, onError?: (err: unknown) => void) => void;
 
-export { type CopyRxSubjectOptions, DataStorage, type DelayOptions, type IDataStorage, IGNORE_UPDATE_SYMBOL, IntervalRunner, IntervalSubject, type OnErrorType, type OnResultType, type StorageCompact, type StorageFilter, type StorageFind, type StorageMap, type StorageOnChangeFn, type StorageOnErrorFn, type StorageOptions, type StorageParseFn, type StorageSearch, type StorageSort, type StorageSortByComparator, type StorageSortByKey, type StorageSortByPropertyName, type StorageSortOptions, type StorageStringifyFn, type StorageToJSON, type StorageValue, type SubjectLike, type SubscriptionLike, type Unsubscribe, type UnsubscribeCandidates, type UnwrapSubjectValue, type ValueModifier, asPromise, copyRxSubject, forceUpdateCache$, isSubjectLike, isSubscriptionLike, type onBeforeExecType, unsubscribeAll };
+export { type CopyRxSubjectOptions, DataStorage, type DelayOptions, type IDataStorage, IGNORE_UPDATE_SYMBOL, IntervalRunner, IntervalSubject, type OnErrorType, type OnResultType, type StorageCompact, type StorageFilter, type StorageFind, type StorageKey, type StorageMap, type StorageOnChangeFn, type StorageOnErrorFn, type StorageOptions, type StorageParseFn, type StorageSearch, type StorageSort, type StorageSortByComparator, type StorageSortByKey, type StorageSortByPropertyName, type StorageSortOptions, type StorageStringifyFn, type StorageToJSON, type StorageValue, type SubjectLike, type SubscriptionLike, type Unsubscribe, type UnsubscribeCandidates, type UnwrapSubjectValue, type ValueModifier, asPromise, copyRxSubject, forceUpdateCache$, isSubjectLike, isSubscriptionLike, type onBeforeExecType, unsubscribeAll };

package/dist/index.js

@@ -164,6 +164,7 @@ import {
   find,
   getEntries,
   getKeys,
+  getValues,
   isArr as isArr2,
   isFn as isFn5,
   isMap,
@@ -264,8 +265,6 @@ var DataStorage = class {
    * ```
    */
   constructor(name, options) {
-    /** Debounce and throttle related options */
-    // readonly deferOptions
     this.initialized = false;
     this.subscriptions = {
       subject: void 0,
@@ -282,7 +281,10 @@ var DataStorage = class {
       this.setAll(data, true);
       return this;
     };
-    this.find = (predicateOrOptions) => find(this.getAll(), predicateOrOptions);
+    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) => {
@@ -323,9 +325,9 @@ var DataStorage = class {
         if (!isMap(data)) return this.subject.next(/* @__PURE__ */ new Map());
         this.write(data);
         fallbackIfFails3(
-          async () => {
+          () => {
             var _a2;
-            return await ((_a2 = this.onChange) == null ? void 0 : _a2.call(this, data));
+            return (_a2 = this.onChange) == null ? void 0 : _a2.call(this, data);
           },
           [],
           this.triggerOnError("onChange")
@@ -368,10 +370,10 @@ var DataStorage = class {
       this.subject.next(new Map(data));
       return this;
     };
-    this.sort = ((nameOrComparator, options) => {
+    this.sort = ((byKeyOrNameOrComparator, options) => {
       const result = sort(
         this.getAll(),
-        nameOrComparator,
+        byKeyOrNameOrComparator,
         options
       );
       (options == null ? void 0 : options.save) && this.setAll(result, true);
@@ -395,12 +397,17 @@ var DataStorage = class {
         this.triggerOnError("stringify-json")
       );
     };
+    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 = () => [...this.getAll().values()];
+    this.values = () => getValues(this.getAll());
     this.write = (data) => {
       try {
         !this.initialized && this.init();

package/package.json

@@ -2,8 +2,8 @@
 	"author": "Toufiqur Rahaman Chowdhury",
 	"description": "RxJS utilities and hooks for React applications.",
 	"dependencies": {
-		"@superutils/core": "^1.2.8",
-		"@superutils/promise": "^1.3.6",
+		"@superutils/core": "^1.2.9",
+		"@superutils/promise": "^1.3.7",
 		"@types/react": "^18.0.0",
 		"react": ">=16.8.0",
 		"rxjs": "^7.8.2"
@@ -49,5 +49,6 @@
 	"module": "./dist/index.js",
 	"type": "module",
 	"types": "./dist/index.d.ts",
-	"version": "0.1.1"
+	"version": "0.1.3",
+	"gitHead": "5065d39fb7486020cdc0aef690398dedb731b1e8"
 }