@reforgium/statum 3.0.0-rc.0 → 3.0.0-rc.1

package/README.md

@@ -235,7 +235,7 @@ Lightweight store for server-side pagination with filtering, dynamic query param
 | Method         | Description                                                               |
 |----------------|---------------------------------------------------------------------------|
 | fetch          | Clean first-page request: `fetch({ filters, query, routeParams })`       |
-| refresh        | Repeat request, optional merge overrides: `refresh({ filters, query })`  |
+| refetchWith        | Repeat request, optional merge overrides: `refetchWith({ filters, query })`  |
 | updatePage     | Change page: `updatePage(page, { ignoreCache })`                         |
 | updatePageSize | Change page size and reset cache: `updatePageSize(size)`                 |
 | updateByOffset | Table-event mapper: `updateByOffset({ page/first/rows }, { query })`    |
@@ -249,7 +249,7 @@ Lightweight store for server-side pagination with filtering, dynamic query param
 | Method         | Cache read | Cache reset | Notes |
 |----------------|------------|-------------|-------|
 | fetch          | no         | yes         | Always starts clean from page `0` |
-| refresh        | no         | no          | Uses active page/filters/query, merges overrides |
+| refetchWith        | no         | no          | Uses active page/filters/query, merges overrides |
 | updatePage     | yes        | no          | Can bypass with `ignoreCache: true` |
 | updatePageSize | no         | yes         | Prevents mixed caches for different page sizes |
 | updateByOffset | yes        | no          | Internally maps to `page + size` |
@@ -431,3 +431,4 @@ const body = serializer.serialize({ name: '  Vasya  ', active: null });
 MIT
 
 
+

package/fesm2022/reforgium-statum.mjs

@@ -1310,9 +1310,9 @@ class PagedQueryStore {
     /**
      * Force reload current data.
      * Optional args merge into active filters/query.
-     * Route params are intentionally not changed from `refresh`.
+     * Route params are intentionally not changed from `refetchWith`.
      */
-    refresh({ filters, query } = {}) {
+    refetchWith({ filters, query } = {}) {
         const nextFilters = filters == null ? this.filters : { ...this.filters, ...filters };
         const nextQuery = query == null ? this.query : { ...this.query, ...query };
         return this.#fetchItems({ filters: nextFilters, query: nextQuery });
@@ -1353,35 +1353,36 @@ class PagedQueryStore {
     };
     /**
      * Set route parameters (path variables) for the resource URL.
-     * Does not trigger loading automatically - call `refresh()` or `updatePage()` after.
+     * Does not trigger loading automatically - call `refetchWith()` or `updatePage()` after.
      *
      * @param params Dictionary of route parameters (e.g., `{ id: '123' }`)
+     * @param opts
      * @param opts.reset  If `true`, resets page to 0, clears cache, total elements count, and items
      * @param opts.abort  If `true`, aborts all active transport requests and sets loading to false
      *
      * @example
      * ```ts
      * store.setRouteParams({ userId: '42' });
-     * await store.refresh(); // fetch with new params
+     * await store.refetchWith(); // fetch with new params
      *
      * // Or with options:
      * store.setRouteParams({ userId: '42' }, { reset: false, abort: true });
      * ```
      */
-    setRouteParams = (params = {}, { reset = false, abort = false } = {}) => {
+    setRouteParams = (params = {}, opts = {}) => {
         const isChanged = !deepEqual(this.routeParams, params);
         if (!isChanged) {
             return;
         }
         this.routeParams = params;
-        if (reset) {
+        if (opts.reset) {
             this.page = 0;
             this.totalElements = 0;
             this.#cache.clear();
             this.cached.set([]);
             this.items.set([]);
         }
-        if (abort) {
+        if (opts.abort) {
             try {
                 this.#transport?.abortAll?.('Route params changed');
             }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.0.0-rc.0",
+  "version": "3.0.0-rc.1",
   "name": "@reforgium/statum",
   "description": "reforgium State modules",
   "author": "rtommievich",

package/types/reforgium-statum.d.ts

@@ -1,4 +1,4 @@
-import { AnyType, AnyDict, RestMethods, PageableRequest, PageableResponse } from '@reforgium/internal';
+import { AnyType, AnyDict, RestMethods, PageableRequest, PageableResponse, QueryParams } from '@reforgium/internal';
 import * as _angular_core from '@angular/core';
 import { Signal, WritableSignal, EnvironmentProviders, InjectionToken } from '@angular/core';
 import * as _reforgium_statum from '@reforgium/statum';
@@ -649,12 +649,16 @@ type OffsetPaginationType = {
     first?: number | null;
     rows?: number | null;
 };
+type FetchParams<FilterType> = QueryParams<FilterType> & {
+    query?: AnyDict;
+    routeParams?: AnyDict;
+};
 type FetchInput<FilterType> = {
     filters?: Partial<FilterType>;
     query?: AnyDict;
     routeParams?: AnyDict;
 };
-type RefreshInput<FilterType> = {
+type RefetchWithInput<FilterType> = {
     filters?: Partial<FilterType>;
     query?: AnyDict;
 };
@@ -668,6 +672,7 @@ type SetRouteParamsOptions = {
     reset?: boolean;
     abort?: boolean;
 };
+
 /**
  * Store for paginated data (tables/lists) with per-page cache and unified requests.
  *
@@ -719,9 +724,9 @@ declare class PagedQueryStore<ItemsType extends object, FilterType = unknown> {
     /**
      * Force reload current data.
      * Optional args merge into active filters/query.
-     * Route params are intentionally not changed from `refresh`.
+     * Route params are intentionally not changed from `refetchWith`.
      */
-    refresh({ filters, query }?: RefreshInput<FilterType>): Promise<ItemsType[] | undefined>;
+    refetchWith({ filters, query }?: RefetchWithInput<FilterType>): Promise<ItemsType[] | undefined>;
     /**
      * Switch page with a request.
      * If cache is enabled and the page is present in LRU — returns it from cache.
@@ -740,22 +745,23 @@ declare class PagedQueryStore<ItemsType extends object, FilterType = unknown> {
     updateByOffset: ({ page: pageNum, first, rows }?: OffsetPaginationType, { query }?: UpdateByOffsetOptions) => Promise<ItemsType[] | undefined>;
     /**
      * Set route parameters (path variables) for the resource URL.
-     * Does not trigger loading automatically - call `refresh()` or `updatePage()` after.
+     * Does not trigger loading automatically - call `refetchWith()` or `updatePage()` after.
      *
      * @param params Dictionary of route parameters (e.g., `{ id: '123' }`)
+     * @param opts
      * @param opts.reset  If `true`, resets page to 0, clears cache, total elements count, and items
      * @param opts.abort  If `true`, aborts all active transport requests and sets loading to false
      *
      * @example
      * ```ts
      * store.setRouteParams({ userId: '42' });
-     * await store.refresh(); // fetch with new params
+     * await store.refetchWith(); // fetch with new params
      *
      * // Or with options:
      * store.setRouteParams({ userId: '42' }, { reset: false, abort: true });
      * ```
      */
-    setRouteParams: (params?: AnyDict, { reset, abort }?: SetRouteParamsOptions) => void;
+    setRouteParams: (params?: AnyDict, opts?: SetRouteParamsOptions) => void;
     /**
      * Update store config on the fly (without re-creation).
      * Does not trigger loading automatically.
@@ -1093,5 +1099,5 @@ declare const STATUM_CONFIG: InjectionToken<StatumConfig>;
 declare const provideStatum: (config: StatumConfig) => EnvironmentProviders;
 
 export { AbortError, CacheMissError, DictLocalStore, DictStore, EntityStore, LruCache, PagedQueryStore, RESOURCE_PROFILES, ResourceStore, STATUM_CONFIG, Serializer, SerializerFieldError, createBodySerializer, createQuerySerializer, createResourceProfile, createStrictSerializer, isAbort, provideStatum, storageStrategy };
-export type { DataType, DictLocalConfig, DictStoreConfig, DictStoreProviderConfig, EntityId, EntityStoreConfig, FieldConfig, PagedQueryStoreConfig, PagedQueryStoreProviderConfig, ResourceProfileName, ResourceRoutesMap, ResourceStatus, ResourceStoreOptions, ResourceTraceEvent, RetryConfig, SerializedType, SerializerConfig, StatumConfig, StorageInterface, StorageStrategy, StorageStrategyOptions, Types };
+export type { DataType, DictLocalConfig, DictStoreConfig, DictStoreProviderConfig, EntityId, EntityStoreConfig, FetchInput, FetchParams, FieldConfig, OffsetPaginationType, PagedQueryStoreConfig, PagedQueryStoreProviderConfig, RefetchWithInput, ResourceProfileName, ResourceRoutesMap, ResourceStatus, ResourceStoreOptions, ResourceTraceEvent, RetryConfig, SerializedType, SerializerConfig, SetRouteParamsOptions, StatumConfig, StorageInterface, StorageStrategy, StorageStrategyOptions, Types, UpdateByOffsetOptions, UpdatePageOptions };
 //# sourceMappingURL=reforgium-statum.d.ts.map