@pagamio/frontend-commons-lib 0.8.326 → 0.8.327

package/lib/shared/hooks/usePagamioTable.d.ts

@@ -1,5 +1,20 @@
-import type { ResponseMapping } from '../../api';
+import type { QueryParamConfig, ResponseMapping } from '../../api';
 import type { BaseEntity, UsePagamioTableConfig, UsePagamioTableReturn } from '../../pagamio-table/data-table/types';
 export declare const springBootMapping: ResponseMapping;
 export declare const arrayResponseMapping: ResponseMapping;
+/**
+ * Response mapping for Pagamio NestJS backends (commerce-os-core,
+ * nestjs-api-commons). Matches `PaginatedResponseDto<T>`:
+ *   { data: T[], meta: { page, limit, total, totalPages, hasNextPage, hasPreviousPage } }
+ *
+ * Pair with `pagamioQueryConfig` so request params line up too.
+ */
+export declare const pagamioMapping: ResponseMapping;
+/**
+ * Query-param config for Pagamio NestJS backends. Matches `PaginationDto`:
+ *   page (1-based), limit, search, sortBy, sortOrder ('asc'|'desc')
+ *
+ * The hook tracks `page` zero-indexed internally; we bump on the way out.
+ */
+export declare const pagamioQueryConfig: QueryParamConfig;
 export declare const usePagamioTable: <T extends BaseEntity>({ queryKey, queryFn, enabled: queryEnabled, staleTime, gcTime, data: clientData, columns, defaultFilters, responseMapping, queryParamConfig, pagination: paginationConfig, filtering: filteringConfig, sorting: sortingConfig, toolbar, searchPlaceholder, onRowClick, rowClassName, expandable, renderDetailPanel, }: UsePagamioTableConfig<T>) => UsePagamioTableReturn<T>;

package/lib/shared/hooks/usePagamioTable.js

@@ -30,6 +30,37 @@ export const arrayResponseMapping = {
     pageSize: '',
     defaultValues: { data: [], total: 0, page: 0, pageSize: 10 },
 };
+/**
+ * Response mapping for Pagamio NestJS backends (commerce-os-core,
+ * nestjs-api-commons). Matches `PaginatedResponseDto<T>`:
+ *   { data: T[], meta: { page, limit, total, totalPages, hasNextPage, hasPreviousPage } }
+ *
+ * Pair with `pagamioQueryConfig` so request params line up too.
+ */
+export const pagamioMapping = {
+    responseType: 'default',
+    data: 'data',
+    total: 'meta.total',
+    page: 'meta.page',
+    pageSize: 'meta.limit',
+    defaultValues: { data: [], total: 0, page: 1, pageSize: 10 },
+};
+/**
+ * Query-param config for Pagamio NestJS backends. Matches `PaginationDto`:
+ *   page (1-based), limit, search, sortBy, sortOrder ('asc'|'desc')
+ *
+ * The hook tracks `page` zero-indexed internally; we bump on the way out.
+ */
+export const pagamioQueryConfig = {
+    pagination: {
+        transform: (page, size) => ({
+            page: (page + 1).toString(),
+            limit: size.toString(),
+        }),
+    },
+    sorting: { sortByParam: 'sortBy', sortDirParam: 'sortOrder' },
+    filtering: { searchParam: 'search', filterFormat: 'flat' },
+};
 const defaultQueryConfig = {
     pagination: {
         transform: (page, size) => ({ page: page.toString(), size: size.toString() }),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pagamio/frontend-commons-lib",
   "description": "Pagamio library for Frontend reusable components like the form engine and table container",
-  "version": "0.8.326",
+  "version": "0.8.327",
   "publishConfig": {
     "access": "public",
     "provenance": false