@reforgium/statum 2.1.2 → 2.2.0

package/README.md

@@ -1,4 +1,4 @@
-# @reforgium/statum
+# @reforgium/statum
 
 [![npm version](https://badge.fury.io/js/%40reforgium%2Fstatum.svg)](https://www.npmjs.com/package/@reforgium/statum)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -181,7 +181,7 @@ entities.removeOne(1);
 
 ## PaginatedDataStore
 
-Lightweight store for server-side pagination with sorting, filtering, and page cache.
+Lightweight store for server-side pagination, filtering, and page cache.
 
 ### When to use
 
@@ -201,23 +201,22 @@ Lightweight store for server-side pagination with sorting, filtering, and page c
 | pageSize       | `number`                  | Page size                              |
 | totalElements  | `number`                  | Total items on server                  |
 | filters        | `Partial<F>`              | Active filters                         |
-| sort           | `string \| undefined`     | Sort as `"field,asc"` / `"field,desc"` |
 
 ### Methods
 
-| Method         | Description                                       |
-|----------------|---------------------------------------------------|
-| refresh        | Repeat request with current params                |
-| updatePage     | Change page (can use cache)                       |
-| updatePageSize | Change page size (can use cache)                  |
-| updateFilters  | Merge filters, reset cache, go to page 0          |
-| setFilters     | Replace filters, reset cache + sort, go to page 0 |
-| updateQuery    | Map table events to `page`/`sort`                 |
-| updateRoute    | Change endpoint, reset meta/cache                 |
-| setRouteParams | Fill route url with params                        |
-| updateConfig   | Patch config and apply presets                    |
-| copy           | Copy config/meta from another store               |
-| destroy        | Manual destroying of caches and abort requests    |
+| Method         | Description                                    |
+|----------------|------------------------------------------------|
+| refresh        | Repeat request with current params             |
+| updatePage     | Change page (can use cache)                    |
+| updatePageSize | Change page size (can use cache)               |
+| updateFilters  | Merge filters, reset cache, go to page 0       |
+| setFilters     | Replace filters, reset cache, go to page 0     |
+| updateQuery    | Map table events to `page`                     |
+| updateRoute    | Change endpoint, reset meta/cache              |
+| setRouteParams | Fill route url with params                     |
+| updateConfig   | Patch config and apply presets                 |
+| copy           | Copy config/meta from another store            |
+| destroy        | Manual destroying of caches and abort requests |
 
 Example:
 

package/fesm2022/reforgium-statum.mjs

@@ -1225,7 +1225,7 @@ class ResourceStore {
  *
  * Provides:
  * - reactive signals: `items`, `loading`, `cached`;
- * - methods to control page/size/filters/sorting;
+ * - methods to control page/size/filters;
  * - optional LRU cache by pages;
  * - configurable transport (GET/POST/PATCH/…).
  *
@@ -1250,8 +1250,6 @@ class PaginatedDataStore {
     loading = signal(false, ...(ngDevMode ? [{ debugName: "loading" }] : []));
     /** Current filters (applied to requests). */
     filters = {};
-    /** Current sorting (`field,asc|desc`). */
-    sort;
     /** Current page index (0-based). */
     page = 0;
     /** Default page size. */
@@ -1272,7 +1270,7 @@ class PaginatedDataStore {
         this.initTransport();
         inject(DestroyRef).onDestroy(() => this.destroy());
     }
-    /** Force reload current data (with the same page/filters/sort). */
+    /** Force reload current data (with the same page/filters). */
     refresh() {
         return this.#fetchItems({});
     }
@@ -1311,21 +1309,20 @@ class PaginatedDataStore {
     };
     /**
      * Update the state from table events (PrimeNG, etc.) and fetch.
-     * Supports `page/first/rows/sortField/sortOrder`.
+     * Supports `page/first/rows`.
      */
-    updateQuery = ({ page: pageNum, first = 0, rows = 0, sortOrder, sortField }) => {
+    updateQuery = ({ page: pageNum, first = 0, rows = 0 }) => {
         const page = (pageNum ?? (first && rows && Math.floor(first / rows))) || 0;
-        const sort = sortField ? `${sortField},${sortOrder === 1 ? 'asc' : 'desc'}` : '';
-        return this.#fetchItems({ page, sort });
+        return this.#fetchItems({ page });
     };
     /**
-     * Set filters from scratch (goes to the first page and resets sorting) and fetch.
+     * Set filters from scratch (goes to the first page) and fetch.
      * Useful for quick presets.
      */
     setFilters = (filters = {}) => {
         this.#cache.clear();
         this.cached.set([]);
-        return this.#fetchItems({ page: 0, filters, sort: undefined });
+        return this.#fetchItems({ page: 0, filters });
     };
     /**
      * Change the resource route (resets page, cache, and presets) without fetching.
@@ -1407,14 +1404,13 @@ class PaginatedDataStore {
             }
         }
     }
-    #fetchItems = async ({ page = this.page, size = this.pageSize, sort = this.sort, filters = this.filters, }) => {
-        const query = this.parseQuery({ page, size, sort, filters });
+    #fetchItems = async ({ page = this.page, size = this.pageSize, filters = this.filters }) => {
+        const query = this.parseQuery({ page, size, filters });
         this.loading.set(true);
         this.#transport.abortAll();
         try {
             const response = await this.runTransport(filters, query);
             this.page = page;
-            this.sort = sort;
             this.filters = filters;
             const parsed = await this.parseResponseData(response);
             this.pageSize = parsed.pageable?.pageSize || size;
@@ -1437,7 +1433,7 @@ class PaginatedDataStore {
         this.#transport = new ResourceStore({ [this.config.method || 'GET']: this.route }, {
             delay: this.config.debounceTime,
             delayMode: 'debounce',
-            presetQueries: { page: this.page, size: this.pageSize, sort: this.sort },
+            presetQueries: { page: this.page, size: this.pageSize },
             presetPayload: this.filters,
         });
     }
@@ -1450,10 +1446,10 @@ class PaginatedDataStore {
         // @ts-ignore
         return this.#transport[method]({ query, payload, params }, { promote: false, dedupe: true });
     }
-    parseQuery({ page = 0, size, sort, filters }) {
+    parseQuery({ page = 0, size, filters }) {
         const method = this.config.method || 'GET';
         const requestPayload = { page, size, ...(method === 'GET' ? filters : {}) };
-        const rawQueries = this.config.parseRequest?.({ ...requestPayload, sort }) || requestPayload;
+        const rawQueries = this.config.parseRequest?.({ ...requestPayload }) || requestPayload;
         const queries = {};
         Object.entries(rawQueries).forEach(([key, value]) => {
             if (Array.isArray(value)) {
@@ -1463,7 +1459,6 @@ class PaginatedDataStore {
                 queries[key] = value;
             }
         });
-        sort && (queries['sort'] = sort);
         return queries;
     }
     parseResponseData = async (data) => {
@@ -1509,7 +1504,6 @@ class PaginatedDataStore {
         this.filters = this.config.presetFilters || {};
         this.pageSize = this.config.presetQuery?.pageSize || 20;
         this.page = this.config.presetQuery?.page || 0;
-        this.sort = this.config.presetQuery?.sort;
     }
 }
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.1.2",
+  "version": "2.2.0",
   "name": "@reforgium/statum",
   "description": "reforgium State modules",
   "author": "rtommievich",

package/types/reforgium-statum.d.ts

@@ -585,17 +585,16 @@ type PaginatedDataStoreConfig<ItemsType extends object, FilterType = unknown> =
     cacheSize?: number;
     /** Debounce delay before request (ms). Useful for frequent filter changes. */
     debounceTime?: number;
-    /** Initial pagination/sort params. `page` is required. */
+    /** Initial pagination params. `page` is required. */
     presetQuery?: {
         page: number;
         pageSize?: number;
-        sort?: string;
     };
     /** Initial filters. Will be sent with the first request. */
     presetFilters?: Partial<FilterType>;
     /**
      * Custom transformation of request data into a query object.
-     * Useful for mapping `page/pageSize/sort` → API-specific keys.
+     * Useful for mapping `page/pageSize` → API-specific keys.
      */
     parseRequest?: (data: PageableRequest) => Query;
     /**
@@ -611,9 +610,9 @@ type PaginatedDataStoreConfig<ItemsType extends object, FilterType = unknown> =
 type PaginatedDataStoreProviderConfig = {
     /** Default method for all stores (if not overridden locally). */
     defaultMethod?: RestMethods;
-    /** Default base `page/pageSize/sort`. */
+    /** Default base `page/pageSize`. */
     defaultQuery?: PaginatedDataStoreConfig<object>['presetQuery'];
-    /** Global `parseRequest` — maps pagination/sort into a query object. */
+    /** Global `parseRequest` — maps pagination into a query object. */
     defaultParseRequest?: PaginatedDataStoreConfig<object>['parseRequest'];
     /** Whether to enable page cache by default. */
     defaultHasCache?: boolean;
@@ -625,15 +624,13 @@ type PaginationType = {
     page?: number;
     first?: number | null;
     rows?: number | null;
-    sortField?: string | string[] | null;
-    sortOrder?: number | null;
 };
 /**
  * Store for paginated data (tables/lists) with per-page cache and unified requests.
  *
  * Provides:
  * - reactive signals: `items`, `loading`, `cached`;
- * - methods to control page/size/filters/sorting;
+ * - methods to control page/size/filters;
  * - optional LRU cache by pages;
  * - configurable transport (GET/POST/PATCH/…).
  *
@@ -657,8 +654,6 @@ declare class PaginatedDataStore<ItemsType extends object, FilterType = unknown>
     loading: WritableSignal<boolean>;
     /** Current filters (applied to requests). */
     filters: Partial<FilterType>;
-    /** Current sorting (`field,asc|desc`). */
-    sort?: string | ReadonlyArray<string>;
     /** Current page index (0-based). */
     page: number;
     /** Default page size. */
@@ -671,7 +666,7 @@ declare class PaginatedDataStore<ItemsType extends object, FilterType = unknown>
      * @param config Store behavior: method, cache, request/response parsers, debounce, presets, etc.
      */
     constructor(route: string, config?: PaginatedDataStoreConfig<ItemsType, FilterType>);
-    /** Force reload current data (with the same page/filters/sort). */
+    /** Force reload current data (with the same page/filters). */
     refresh(): Promise<ItemsType[] | undefined>;
     /**
      * Switch page with a request.
@@ -692,11 +687,11 @@ declare class PaginatedDataStore<ItemsType extends object, FilterType = unknown>
     updateFilters: (filters: Partial<FilterType>) => Promise<ItemsType[] | undefined>;
     /**
      * Update the state from table events (PrimeNG, etc.) and fetch.
-     * Supports `page/first/rows/sortField/sortOrder`.
+     * Supports `page/first/rows`.
      */
-    updateQuery: ({ page: pageNum, first, rows, sortOrder, sortField }: PaginationType) => Promise<ItemsType[] | undefined>;
+    updateQuery: ({ page: pageNum, first, rows }: PaginationType) => Promise<ItemsType[] | undefined>;
     /**
-     * Set filters from scratch (goes to the first page and resets sorting) and fetch.
+     * Set filters from scratch (goes to the first page) and fetch.
      * Useful for quick presets.
      */
     setFilters: (filters?: Partial<FilterType>) => Promise<ItemsType[] | undefined>;
@@ -779,7 +774,7 @@ type DictStoreConfig<ItemsType extends object> = {
     /** Autoload data on initialization (`true` by default). */
     autoLoad?: boolean | 'whenEmpty';
     /**
-     * Custom mapper of pagination/sort request into query params.
+     * Custom mapper of pagination request into query params.
      * Useful if the API expects non-standard field names.
      */
     parseRequest?: (data: PageableRequest) => AnyDict;