drf-react-by-schema 0.6.2 → 0.6.3

package/dist/api.d.ts

@@ -1,6 +1,6 @@
 import { serverEndPointType } from './context/DRFReactBySchemaContext';
 import { Item, SchemaType, modelOptionsType, DataSchemaColumnsType, ItemSchemaColumnsType, PaginatedResult } from './utils';
-import { GridFilterModel } from '@mui/x-data-grid';
+import { GridFilterModel, GridSortModel } from '@mui/x-data-grid';
 import { AlertColor } from '@mui/material/Alert';
 type Id = string | number | null;
 interface TargetApiParams {
@@ -71,6 +71,7 @@ export interface getGenericModelListProps {
     loadedModelOptions?: modelOptionsType | boolean;
     page?: number;
     filter?: GridFilterModel;
+    sort?: GridSortModel;
     sumRows?: SumRowsType;
 }
 export interface SumRowsType {
@@ -83,7 +84,7 @@ interface SumRowsItem {
     suffix?: string;
     isCount?: boolean;
 }
-export declare const getGenericModelList: ({ model, serverEndPoint, id, relatedModel, relatedModelId, columnFields, hiddenFields, creatableFields, isInBatches, loadedSchema, loadedModelOptions, page, filter, sumRows, }: getGenericModelListProps) => Promise<false | DataSchemaColumnsType>;
+export declare const getGenericModelList: ({ model, serverEndPoint, id, relatedModel, relatedModelId, columnFields, hiddenFields, creatableFields, isInBatches, loadedSchema, loadedModelOptions, page, filter, sort, sumRows, }: getGenericModelListProps) => Promise<false | DataSchemaColumnsType>;
 export declare const getGenericModel: ({ model, serverEndPoint, id, relatedModel, relatedModelId, }: {
     model: string;
     serverEndPoint: serverEndPointType | null;

package/dist/api.js

@@ -540,7 +540,7 @@ const isLoggedIn = (serverEndPoint) => __awaiter(void 0, void 0, void 0, functio
     return usuaria;
 });
 exports.isLoggedIn = isLoggedIn;
-const getGenericModelList = ({ model, serverEndPoint, id = '', relatedModel = '', relatedModelId = '', columnFields, hiddenFields = ['id'], creatableFields = [], isInBatches = false, loadedSchema, loadedModelOptions, page, filter, sumRows, }) => __awaiter(void 0, void 0, void 0, function* () {
+const getGenericModelList = ({ model, serverEndPoint, id = '', relatedModel = '', relatedModelId = '', columnFields, hiddenFields = ['id'], creatableFields = [], isInBatches = false, loadedSchema, loadedModelOptions, page, filter, sort, sumRows, }) => __awaiter(void 0, void 0, void 0, function* () {
     let path = `${model}/${id}`;
     let schemaPath = model;
     let schema = loadedSchema;
@@ -550,17 +550,16 @@ const getGenericModelList = ({ model, serverEndPoint, id = '', relatedModel = ''
         path += `/${relatedModel}/${relatedModelId}`;
         schemaPath += `/${id}/${relatedModel}`;
     }
-    if (page || filter || sumRows) {
-        path += '?';
-    }
+    const queryParams = [];
+    // SERVER-SIDE TOTALS (sumRows):
     if (sumRows) {
         const sumRowsParams = sumRows.rows.map(row => row.field).join(',');
-        path += `sum_rows=${sumRowsParams}`;
+        queryParams.push(`sum_rows=${sumRowsParams}`);
     }
+    // SERVER-SIDE FILTERING:
     if (filter) {
-        const filtersArr = [];
         if (filter.quickFilterValues && filter.quickFilterValues.length > 0 && filter.quickFilterValues[0]) {
-            filtersArr.push(`search=${filter.quickFilterValues[0]}`);
+            queryParams.push(`search=${filter.quickFilterValues[0]}`);
         }
         for (const item of filter.items) {
             if (!item.operatorValue) {
@@ -569,18 +568,23 @@ const getGenericModelList = ({ model, serverEndPoint, id = '', relatedModel = ''
             const queryParam = item.value
                 ? `columnField=${item.columnField}&operatorValue=${item.operatorValue}&value=${item.value}`
                 : `columnField=${item.columnField}&operatorValue=${item.operatorValue}`;
-            filtersArr.push(queryParam);
+            queryParams.push(queryParam);
         }
-        if (sumRows) {
-            path += '&';
+    }
+    // SERVER-SIDE SORTING:
+    if (sort) {
+        const sortParams = [];
+        for (const item of sort) {
+            sortParams.push(item.sort === 'desc' ? `-${item.field}` : item.field);
         }
-        path += filtersArr.join('&');
+        queryParams.push(`ordering=${sortParams.join(',')}`);
     }
+    // SERVER-SIDE PAGINATION:
     if (page) {
-        if (sumRows || filter) {
-            path += '&';
-        }
-        path += `page=${page + 1}`;
+        queryParams.push(`page=${page + 1}`);
+    }
+    if (queryParams.length > 0) {
+        path += `?${queryParams.join('&')}`;
     }
     // Only get schema and columns if not in batches or in first batch:
     if (!schema) {

package/dist/components/DataGridBySchemaEditable.js

@@ -615,6 +615,12 @@ const DataGridBySchemaEditable = (0, react_1.forwardRef)((_a, ref) => {
                         setPaginationModel(Object.assign(Object.assign({}, paginationModel), { filter: newFilter }));
                     }
                 }
+                : undefined, sortingMode: paginationModel ? 'server' : 'client', onSortModelChange: paginationModel
+                ? (newSorting) => {
+                    if (setPaginationModel && paginationModel) {
+                        setPaginationModel(Object.assign(Object.assign({}, paginationModel), { sort: newSorting }));
+                    }
+                }
                 : undefined })),
         react_1.default.createElement(ConfirmDialog_1.ConfirmDialog, { open: dialogOpen, onClose: handleDialogClose, onConfirm: handleDeleteSave }),
         react_1.default.createElement(Snackbar_1.default, { open: snackBar.open, autoHideDuration: 5000, onClose: () => {

package/dist/components/GenericModelList.js

@@ -103,6 +103,7 @@ const GenericModelList = ({ columnFields, hiddenFields = [], minWidthFields, ind
                     hiddenFields,
                     page: paginationModel ? paginationModel.page : 0,
                     filter: paginationModel ? paginationModel.filter : undefined,
+                    sort: paginationModel ? paginationModel.sort : undefined,
                     sumRows,
                 };
                 const paginatedData = yield (0, api_1.getGenericModelList)(loadPaginatedParams);

package/dist/utils.d.ts

@@ -1,4 +1,4 @@
-import { GridActionsColDef, GridColDef, GridFilterModel } from '@mui/x-data-grid';
+import { GridActionsColDef, GridColDef, GridFilterModel, GridSortModel } from '@mui/x-data-grid';
 export type Id = string | number;
 export type Item = Record<string, any>;
 export type PaginatedResult = {
@@ -12,6 +12,7 @@ export interface PaginationModel {
     page: number;
     pageSize: number;
     filter?: GridFilterModel;
+    sort?: GridSortModel;
 }
 export type SchemaType = Record<string, Field>;
 export type modelOptionsType = Record<string, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "drf-react-by-schema",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "description": "Components and Tools for building a React App having Django Rest Framework (DRF) as server",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",