@zeedhi/common 1.109.1 → 1.110.0

package/dist/zd-common.esm.js

@@ -1,4 +1,4 @@
-import { AccessorManager, Event, KeyMap, MethodNotAssignedError, Metadata, Accessor, I18n, FormatterParserProvider, Validation, Mask, DatasourceFactory, Loader, Config, dayjs, Utils, DateHelper, Router, Messages, InstanceNotFoundError, ViewService, MemoryDatasource, URL as URL$1, Http, Cookie, VersionService } from '@zeedhi/core';
+import { AccessorManager, Event, KeyMap, MethodNotAssignedError, Metadata, Accessor, I18n, FormatterParserProvider, Validation, Mask, DatasourceFactory, Loader, Config, dayjs, Utils, DateHelper, Router, Messages, InstanceNotFoundError, ViewService, URL as URL$1, Http, Cookie, VersionService } from '@zeedhi/core';
 import merge from 'lodash.merge';
 import cloneDeep from 'lodash.clonedeep';
 import debounce from 'lodash.debounce';
@@ -6821,6 +6821,8 @@ class GridEditable extends Grid {
         this.viewEnterEdit = null;
         this.showCancelColumn = false;
         this.newRowIdentifier = '__added_row';
+        this.positionIdentifier = '__position';
+        this.pageIdentifier = '__page';
         this.createGridController();
         this.doubleClickEdit = this.getInitValue('doubleClickEdit', props.doubleClickEdit, this.doubleClickEdit);
         this.canEditRow = this.getInitValue('canEditRow', props.canEditRow, this.canEditRow);
@@ -6829,6 +6831,7 @@ class GridEditable extends Grid {
         this.showCancelColumn = this.getInitValue('showCancelColumn', props.showCancelColumn, this.showCancelColumn);
         this.createAccessors();
         this.addCancelColumn();
+        this.registerDatasourceCallback();
     }
     setViewEnterEdit(viewEnterEdit) {
         this.viewEnterEdit = viewEnterEdit;
@@ -6884,6 +6887,35 @@ class GridEditable extends Grid {
     instantiateCancelColumn() {
         return new GridColumnEditable(this.getCancelColumnProps());
     }
+    registerDatasourceCallback() {
+        const callback = () => {
+            const addedRows = Object.keys(this.addedRows).map((key) => this.addedRows[key]);
+            if (addedRows.length === 0)
+                return;
+            let dataWithNewRow = null;
+            const { page } = this.datasource;
+            addedRows.forEach((row) => {
+                const { originalRow } = row;
+                const rowToInsert = originalRow || row;
+                const rowPage = rowToInsert[this.pageIdentifier];
+                const lastPage = this.datasource.getLastPage() || 1;
+                // if the row's page is greater than the last page, should insert the row in the last page
+                // if the row's page is not greater than the last page, should insert the row in the correct page
+                if (rowPage > lastPage) {
+                    if (page !== lastPage)
+                        return;
+                }
+                else if (rowPage !== page) {
+                    return;
+                }
+                dataWithNewRow = this.insertRowInDatasource(rowToInsert, rowToInsert[this.positionIdentifier]);
+            });
+            if (dataWithNewRow) {
+                this.datasource.updatePageData(dataWithNewRow);
+            }
+        };
+        this.datasource.registerGetCallback(callback);
+    }
     createGridController() {
         const controller = new GridEditableController(this);
         Loader.addController(`GridEditableController_${this.name}`, controller);
@@ -7196,6 +7228,7 @@ class GridEditable extends Grid {
         return __awaiter(this, void 0, void 0, function* () {
             const { page } = this.datasource;
             yield this.cancelAddedRows();
+            this.addedRows = {};
             yield this.datasource.setPage(page);
             this.editing = false;
             this.editedRows = {};
@@ -7213,14 +7246,10 @@ class GridEditable extends Grid {
             delete cloneAddedRows[key];
             this.editedRows = cloneEditedRows;
             this.addedRows = cloneAddedRows;
-            let { data } = this.datasource;
-            if (this.datasource instanceof MemoryDatasource) {
-                data = this.datasource.allData;
-            }
-            const { uniqueKey } = this.datasource;
+            const { data, uniqueKey } = this.datasource;
             const index = data.findIndex((row) => row[uniqueKey] === key);
             data.splice(index, 1);
-            return this.datasource.updateData(data);
+            return this.datasource.updatePageData(data);
         });
     }
     cancelAddedRows() {
@@ -7233,7 +7262,7 @@ class GridEditable extends Grid {
                     allData.splice(index, 1);
                 }
             }
-            yield this.datasource.updateData(allData);
+            yield this.datasource.updatePageData(allData);
         });
     }
     addDataRow(row) {
@@ -7272,6 +7301,8 @@ class GridEditable extends Grid {
             const row = Object.assign(Object.assign({}, this.editedRows[key].originalRow), this.editedRows[key]);
             delete row.originalRow;
             delete row[this.newRowIdentifier];
+            delete row[this.positionIdentifier];
+            delete row[this.pageIdentifier];
             Object.keys(row).forEach((attr) => {
                 if (Object.prototype.hasOwnProperty.call(row, `${attr}_original`)) {
                     delete row[`${attr}_original`];
@@ -7293,6 +7324,8 @@ class GridEditable extends Grid {
             const row = Object.assign(Object.assign({}, this.addedRows[key].originalRow), this.addedRows[key]);
             delete row.originalRow;
             delete row[this.newRowIdentifier];
+            delete row[this.positionIdentifier];
+            delete row[this.pageIdentifier];
             Object.keys(row).forEach((attr) => {
                 if (Object.prototype.hasOwnProperty.call(row, `${attr}_original`)) {
                     delete row[`${attr}_original`];
@@ -7363,10 +7396,14 @@ class GridEditable extends Grid {
         return __awaiter(this, void 0, void 0, function* () {
             const data = this.insertRowInDatasource(row, position);
             this.saveRowReference(row);
-            yield this.datasource.updateData(data);
+            yield this.datasource.updatePageData(data);
             this.editing = true;
         });
     }
+    /**
+     * Saves a row reference in editedRows and addedRows
+     * @param row Row to be saved
+     */
     saveRowReference(row) {
         const id = row[this.datasource.uniqueKey];
         if (id) {
@@ -7374,15 +7411,18 @@ class GridEditable extends Grid {
             this.addedRows = Object.assign(Object.assign({}, this.addedRows), { [id]: Object.assign({}, row) });
         }
     }
+    /**
+     * Inserts a row in datasource depending on the position
+     * @param row Row to be inserted
+     * @param position Position, 'end' or 'start'
+     * @returns the data containing the newly added row
+     */
     insertRowInDatasource(row, position) {
-        let data;
-        if (this.datasource instanceof MemoryDatasource) {
-            data = this.datasource.allData;
-        }
-        else {
-            data = this.datasource.data;
-        }
+        const { data } = this.datasource;
         row[this.newRowIdentifier] = true;
+        row[this.positionIdentifier] = position;
+        if (!row[this.pageIdentifier])
+            row[this.pageIdentifier] = this.datasource.page;
         if (position === 'start') {
             data.unshift(row);
         }
@@ -8393,16 +8433,11 @@ class WatchURL {
 WatchURL.watchers = {};
 WatchURL.originalEvents = new Map();
 
-class BaseReport {
-    constructor() {
-        this.expressionZeedhiToXls = {
-            AVG: 'AVERAGE',
-            COUNT: 'COUNTA',
-            MAX: 'MAX',
-            MIN: 'MIN',
-            SUM: 'SUM',
-        };
-        this.colunmXLS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+class ReportColumnTransformer {
+    constructor({ getFormatFn, labelFormatter, fileType }) {
+        this.getFormatFn = getFormatFn;
+        this.labelFormatter = labelFormatter;
+        this.fileType = fileType;
     }
     getColumnsWidth(columns) {
         const widths = {};
@@ -8420,7 +8455,7 @@ class BaseReport {
         }
         return { widths, totalWidth };
     }
-    buildColumns(columns) {
+    transform(columns) {
         const { widths, totalWidth } = this.getColumnsWidth(columns);
         return columns.reduce((result, col, index) => {
             let size;
@@ -8430,18 +8465,36 @@ class BaseReport {
             else {
                 size = Math.floor((widths[col.name] * 100) / totalWidth);
             }
+            const description = this.labelFormatter ? this.labelFormatter({ column: col, fileType: this.fileType }) : col.label;
+            const format = this.getFormatFn ? this.getFormatFn(col) : undefined;
             const row = {
+                format,
+                description,
                 align: col.align || 'left',
-                description: col.label,
                 sequence: index,
                 size: `${size}%`,
+                xlsType: col.xlsType,
             };
-            if (col.xlsType) {
-                row.xlsType = col.xlsType;
-            }
             return Object.assign(Object.assign({}, result), { [col.name]: row });
         }, {});
     }
+}
+
+class BaseReport {
+    constructor(labelFormatter) {
+        this.expressionZeedhiToXls = {
+            AVG: 'AVERAGE',
+            COUNT: 'COUNTA',
+            MAX: 'MAX',
+            MIN: 'MIN',
+            SUM: 'SUM',
+        };
+        this.colunmXLS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+        this.reportColumnTransformer = this.getReportColumnTransformer(labelFormatter);
+    }
+    getReportColumnTransformer(labelFormatter) {
+        return new ReportColumnTransformer({ labelFormatter, fileType: this.getFileType() });
+    }
     buildFilter(filter, columns) {
         return Object.keys(filter).map((key) => {
             var _a;
@@ -8464,6 +8517,9 @@ class CSVReport extends BaseReport {
         super(...arguments);
         this.route = '/generateCSV';
     }
+    getFileType() {
+        return 'csv';
+    }
     buildDataset(data, columns) {
         const columnNames = columns.map((col) => col.name);
         const result = data.reduce((reduced, row) => {
@@ -8473,7 +8529,7 @@ class CSVReport extends BaseReport {
         return JSON.stringify(result);
     }
     buildMetadata(name, title, columns, filter) {
-        const builtCols = this.buildColumns(columns);
+        const builtCols = this.reportColumnTransformer.transform(columns);
         const builtFilters = this.buildFilter(filter || {}, columns);
         const lang = this.formatLangCode(I18n.instance.language);
         const clientLogo = '';
@@ -8509,30 +8565,17 @@ class PDFReport extends BaseReport {
         super(...arguments);
         this.route = '/generateReport';
     }
+    getFileType() {
+        return 'pdf';
+    }
+    getReportColumnTransformer(labelFormatter) {
+        const getFormatFn = this.getFormatOfColumn.bind(this);
+        const fileType = this.getFileType();
+        return new ReportColumnTransformer({ getFormatFn, labelFormatter, fileType });
+    }
     buildDataset(data) {
         return JSON.stringify(data);
     }
-    buildColumns(columns) {
-        const { widths, totalWidth } = this.getColumnsWidth(columns);
-        return columns.reduce((result, col, index) => {
-            let size;
-            if (!totalWidth) {
-                size = Math.floor(100 / columns.length);
-            }
-            else {
-                size = Math.floor((widths[col.name] * 100) / totalWidth);
-            }
-            const row = {
-                align: col.align || 'left',
-                description: col.label,
-                sequence: index,
-                format: this.getFormatOfColumn(col),
-                size: `${size}%`,
-                xlsType: col.xlsType,
-            };
-            return Object.assign(Object.assign({}, result), { [col.name]: row });
-        }, {});
-    }
     getFormatOfColumn(column) {
         let format;
         let { mask } = column;
@@ -8580,7 +8623,7 @@ class PDFReport extends BaseReport {
     }
     buildMetadata(name, title, columns, filter, portrait = true) {
         return __awaiter(this, void 0, void 0, function* () {
-            const builtCols = this.buildColumns(columns);
+            const builtCols = this.reportColumnTransformer.transform(columns);
             const builtFilters = this.buildFilter(filter || {}, columns);
             const lang = this.formatLangCode(I18n.instance.language);
             let clientLogo = '';
@@ -8665,6 +8708,9 @@ class XLSReport extends BaseReport {
         super(...arguments);
         this.route = '/generateXLS';
     }
+    getFileType() {
+        return 'xls';
+    }
     buildDataset(data, columns) {
         const result = this.formatRawDataSet(data, columns);
         return JSON.stringify(result);
@@ -8679,7 +8725,7 @@ class XLSReport extends BaseReport {
         return result;
     }
     buildMetadata(name, title, columns, filter) {
-        const builtCols = this.buildColumns(columns);
+        const builtCols = this.reportColumnTransformer.transform(columns);
         const builtFilters = this.buildFilter(filter || {}, columns);
         const lang = this.formatLangCode(I18n.instance.language);
         const clientLogo = '';
@@ -8719,12 +8765,15 @@ class XLS2Report extends BaseReport {
         super(...arguments);
         this.route = '/generateXLS';
     }
+    getFileType() {
+        return 'xls';
+    }
     buildDataset(data, metadata) {
         const result = this.formatDataSet(metadata, data);
         return JSON.stringify(result);
     }
     buildMetadata(name, title, columns, filter) {
-        const builtCols = this.buildColumns(columns);
+        const builtCols = this.reportColumnTransformer.transform(columns);
         const builtFilters = this.buildFilter(filter || {}, columns);
         const lang = this.formatLangCode(I18n.instance.language);
         const clientLogo = '';
@@ -8916,12 +8965,15 @@ class XLS3Report extends BaseReport {
         super(...arguments);
         this.route = '/generateXLS';
     }
+    getFileType() {
+        return 'xls';
+    }
     buildDataset(data, metadata) {
         const result = this.formatDataSet(metadata, data);
         return JSON.stringify(result);
     }
     buildMetadata(name, title, columns, filter) {
-        const builtCols = this.buildColumns(columns);
+        const builtCols = this.reportColumnTransformer.transform(columns);
         const builtFilters = this.buildFilter(filter || {}, columns);
         const lang = this.formatLangCode(I18n.instance.language);
         const clientLogo = '';
@@ -9208,25 +9260,25 @@ class Report {
             return formattedData;
         });
     }
-    getReportType(type) {
+    getReportType(type, labelFormatter) {
         if (type === 'csv') {
-            return new CSVReport();
+            return new CSVReport(labelFormatter);
         }
         if (type === 'pdf') {
-            return new PDFReport();
+            return new PDFReport(labelFormatter);
         }
         if (type === 'xls') {
-            return new XLSReport();
+            return new XLSReport(labelFormatter);
         }
         if (type === 'xls2') {
-            return new XLS2Report();
+            return new XLS2Report(labelFormatter);
         }
         if (type === 'xls3') {
-            return new XLS3Report();
+            return new XLS3Report(labelFormatter);
         }
         throw new Error(`Invalid report type: ${type}`);
     }
-    getReport(type, portrait = true, rowObj, beforeReportEvent) {
+    getReport(type, portrait = true, rowObj, beforeReportEvent, labelFormatter) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const data = (_a = this.data) !== null && _a !== void 0 ? _a : yield this.getData();
@@ -9237,7 +9289,7 @@ class Report {
                 containerLabel: this.title,
                 widgetLabel: this.title,
             };
-            const reportType = this.getReportType(type);
+            const reportType = this.getReportType(type, labelFormatter);
             const { route } = reportType;
             const { name, columns, datasource } = this.iterable;
             const { groupedData } = Object.assign({}, this.iterable);

package/dist/zd-common.umd.js

@@ -6828,6 +6828,8 @@
           this.viewEnterEdit = null;
           this.showCancelColumn = false;
           this.newRowIdentifier = '__added_row';
+          this.positionIdentifier = '__position';
+          this.pageIdentifier = '__page';
           this.createGridController();
           this.doubleClickEdit = this.getInitValue('doubleClickEdit', props.doubleClickEdit, this.doubleClickEdit);
           this.canEditRow = this.getInitValue('canEditRow', props.canEditRow, this.canEditRow);
@@ -6836,6 +6838,7 @@
           this.showCancelColumn = this.getInitValue('showCancelColumn', props.showCancelColumn, this.showCancelColumn);
           this.createAccessors();
           this.addCancelColumn();
+          this.registerDatasourceCallback();
       }
       setViewEnterEdit(viewEnterEdit) {
           this.viewEnterEdit = viewEnterEdit;
@@ -6891,6 +6894,35 @@
       instantiateCancelColumn() {
           return new GridColumnEditable(this.getCancelColumnProps());
       }
+      registerDatasourceCallback() {
+          const callback = () => {
+              const addedRows = Object.keys(this.addedRows).map((key) => this.addedRows[key]);
+              if (addedRows.length === 0)
+                  return;
+              let dataWithNewRow = null;
+              const { page } = this.datasource;
+              addedRows.forEach((row) => {
+                  const { originalRow } = row;
+                  const rowToInsert = originalRow || row;
+                  const rowPage = rowToInsert[this.pageIdentifier];
+                  const lastPage = this.datasource.getLastPage() || 1;
+                  // if the row's page is greater than the last page, should insert the row in the last page
+                  // if the row's page is not greater than the last page, should insert the row in the correct page
+                  if (rowPage > lastPage) {
+                      if (page !== lastPage)
+                          return;
+                  }
+                  else if (rowPage !== page) {
+                      return;
+                  }
+                  dataWithNewRow = this.insertRowInDatasource(rowToInsert, rowToInsert[this.positionIdentifier]);
+              });
+              if (dataWithNewRow) {
+                  this.datasource.updatePageData(dataWithNewRow);
+              }
+          };
+          this.datasource.registerGetCallback(callback);
+      }
       createGridController() {
           const controller = new GridEditableController(this);
           core.Loader.addController(`GridEditableController_${this.name}`, controller);
@@ -7203,6 +7235,7 @@
           return __awaiter(this, void 0, void 0, function* () {
               const { page } = this.datasource;
               yield this.cancelAddedRows();
+              this.addedRows = {};
               yield this.datasource.setPage(page);
               this.editing = false;
               this.editedRows = {};
@@ -7220,14 +7253,10 @@
               delete cloneAddedRows[key];
               this.editedRows = cloneEditedRows;
               this.addedRows = cloneAddedRows;
-              let { data } = this.datasource;
-              if (this.datasource instanceof core.MemoryDatasource) {
-                  data = this.datasource.allData;
-              }
-              const { uniqueKey } = this.datasource;
+              const { data, uniqueKey } = this.datasource;
               const index = data.findIndex((row) => row[uniqueKey] === key);
               data.splice(index, 1);
-              return this.datasource.updateData(data);
+              return this.datasource.updatePageData(data);
           });
       }
       cancelAddedRows() {
@@ -7240,7 +7269,7 @@
                       allData.splice(index, 1);
                   }
               }
-              yield this.datasource.updateData(allData);
+              yield this.datasource.updatePageData(allData);
           });
       }
       addDataRow(row) {
@@ -7279,6 +7308,8 @@
               const row = Object.assign(Object.assign({}, this.editedRows[key].originalRow), this.editedRows[key]);
               delete row.originalRow;
               delete row[this.newRowIdentifier];
+              delete row[this.positionIdentifier];
+              delete row[this.pageIdentifier];
               Object.keys(row).forEach((attr) => {
                   if (Object.prototype.hasOwnProperty.call(row, `${attr}_original`)) {
                       delete row[`${attr}_original`];
@@ -7300,6 +7331,8 @@
               const row = Object.assign(Object.assign({}, this.addedRows[key].originalRow), this.addedRows[key]);
               delete row.originalRow;
               delete row[this.newRowIdentifier];
+              delete row[this.positionIdentifier];
+              delete row[this.pageIdentifier];
               Object.keys(row).forEach((attr) => {
                   if (Object.prototype.hasOwnProperty.call(row, `${attr}_original`)) {
                       delete row[`${attr}_original`];
@@ -7370,10 +7403,14 @@
           return __awaiter(this, void 0, void 0, function* () {
               const data = this.insertRowInDatasource(row, position);
               this.saveRowReference(row);
-              yield this.datasource.updateData(data);
+              yield this.datasource.updatePageData(data);
               this.editing = true;
           });
       }
+      /**
+       * Saves a row reference in editedRows and addedRows
+       * @param row Row to be saved
+       */
       saveRowReference(row) {
           const id = row[this.datasource.uniqueKey];
           if (id) {
@@ -7381,15 +7418,18 @@
               this.addedRows = Object.assign(Object.assign({}, this.addedRows), { [id]: Object.assign({}, row) });
           }
       }
+      /**
+       * Inserts a row in datasource depending on the position
+       * @param row Row to be inserted
+       * @param position Position, 'end' or 'start'
+       * @returns the data containing the newly added row
+       */
       insertRowInDatasource(row, position) {
-          let data;
-          if (this.datasource instanceof core.MemoryDatasource) {
-              data = this.datasource.allData;
-          }
-          else {
-              data = this.datasource.data;
-          }
+          const { data } = this.datasource;
           row[this.newRowIdentifier] = true;
+          row[this.positionIdentifier] = position;
+          if (!row[this.pageIdentifier])
+              row[this.pageIdentifier] = this.datasource.page;
           if (position === 'start') {
               data.unshift(row);
           }
@@ -8400,16 +8440,11 @@
   WatchURL.watchers = {};
   WatchURL.originalEvents = new Map();
 
-  class BaseReport {
-      constructor() {
-          this.expressionZeedhiToXls = {
-              AVG: 'AVERAGE',
-              COUNT: 'COUNTA',
-              MAX: 'MAX',
-              MIN: 'MIN',
-              SUM: 'SUM',
-          };
-          this.colunmXLS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+  class ReportColumnTransformer {
+      constructor({ getFormatFn, labelFormatter, fileType }) {
+          this.getFormatFn = getFormatFn;
+          this.labelFormatter = labelFormatter;
+          this.fileType = fileType;
       }
       getColumnsWidth(columns) {
           const widths = {};
@@ -8427,7 +8462,7 @@
           }
           return { widths, totalWidth };
       }
-      buildColumns(columns) {
+      transform(columns) {
           const { widths, totalWidth } = this.getColumnsWidth(columns);
           return columns.reduce((result, col, index) => {
               let size;
@@ -8437,18 +8472,36 @@
               else {
                   size = Math.floor((widths[col.name] * 100) / totalWidth);
               }
+              const description = this.labelFormatter ? this.labelFormatter({ column: col, fileType: this.fileType }) : col.label;
+              const format = this.getFormatFn ? this.getFormatFn(col) : undefined;
               const row = {
+                  format,
+                  description,
                   align: col.align || 'left',
-                  description: col.label,
                   sequence: index,
                   size: `${size}%`,
+                  xlsType: col.xlsType,
               };
-              if (col.xlsType) {
-                  row.xlsType = col.xlsType;
-              }
               return Object.assign(Object.assign({}, result), { [col.name]: row });
           }, {});
       }
+  }
+
+  class BaseReport {
+      constructor(labelFormatter) {
+          this.expressionZeedhiToXls = {
+              AVG: 'AVERAGE',
+              COUNT: 'COUNTA',
+              MAX: 'MAX',
+              MIN: 'MIN',
+              SUM: 'SUM',
+          };
+          this.colunmXLS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
+          this.reportColumnTransformer = this.getReportColumnTransformer(labelFormatter);
+      }
+      getReportColumnTransformer(labelFormatter) {
+          return new ReportColumnTransformer({ labelFormatter, fileType: this.getFileType() });
+      }
       buildFilter(filter, columns) {
           return Object.keys(filter).map((key) => {
               var _a;
@@ -8471,6 +8524,9 @@
           super(...arguments);
           this.route = '/generateCSV';
       }
+      getFileType() {
+          return 'csv';
+      }
       buildDataset(data, columns) {
           const columnNames = columns.map((col) => col.name);
           const result = data.reduce((reduced, row) => {
@@ -8480,7 +8536,7 @@
           return JSON.stringify(result);
       }
       buildMetadata(name, title, columns, filter) {
-          const builtCols = this.buildColumns(columns);
+          const builtCols = this.reportColumnTransformer.transform(columns);
           const builtFilters = this.buildFilter(filter || {}, columns);
           const lang = this.formatLangCode(core.I18n.instance.language);
           const clientLogo = '';
@@ -8516,30 +8572,17 @@
           super(...arguments);
           this.route = '/generateReport';
       }
+      getFileType() {
+          return 'pdf';
+      }
+      getReportColumnTransformer(labelFormatter) {
+          const getFormatFn = this.getFormatOfColumn.bind(this);
+          const fileType = this.getFileType();
+          return new ReportColumnTransformer({ getFormatFn, labelFormatter, fileType });
+      }
       buildDataset(data) {
           return JSON.stringify(data);
       }
-      buildColumns(columns) {
-          const { widths, totalWidth } = this.getColumnsWidth(columns);
-          return columns.reduce((result, col, index) => {
-              let size;
-              if (!totalWidth) {
-                  size = Math.floor(100 / columns.length);
-              }
-              else {
-                  size = Math.floor((widths[col.name] * 100) / totalWidth);
-              }
-              const row = {
-                  align: col.align || 'left',
-                  description: col.label,
-                  sequence: index,
-                  format: this.getFormatOfColumn(col),
-                  size: `${size}%`,
-                  xlsType: col.xlsType,
-              };
-              return Object.assign(Object.assign({}, result), { [col.name]: row });
-          }, {});
-      }
       getFormatOfColumn(column) {
           let format;
           let { mask } = column;
@@ -8587,7 +8630,7 @@
       }
       buildMetadata(name, title, columns, filter, portrait = true) {
           return __awaiter(this, void 0, void 0, function* () {
-              const builtCols = this.buildColumns(columns);
+              const builtCols = this.reportColumnTransformer.transform(columns);
               const builtFilters = this.buildFilter(filter || {}, columns);
               const lang = this.formatLangCode(core.I18n.instance.language);
               let clientLogo = '';
@@ -8672,6 +8715,9 @@
           super(...arguments);
           this.route = '/generateXLS';
       }
+      getFileType() {
+          return 'xls';
+      }
       buildDataset(data, columns) {
           const result = this.formatRawDataSet(data, columns);
           return JSON.stringify(result);
@@ -8686,7 +8732,7 @@
           return result;
       }
       buildMetadata(name, title, columns, filter) {
-          const builtCols = this.buildColumns(columns);
+          const builtCols = this.reportColumnTransformer.transform(columns);
           const builtFilters = this.buildFilter(filter || {}, columns);
           const lang = this.formatLangCode(core.I18n.instance.language);
           const clientLogo = '';
@@ -8726,12 +8772,15 @@
           super(...arguments);
           this.route = '/generateXLS';
       }
+      getFileType() {
+          return 'xls';
+      }
       buildDataset(data, metadata) {
           const result = this.formatDataSet(metadata, data);
           return JSON.stringify(result);
       }
       buildMetadata(name, title, columns, filter) {
-          const builtCols = this.buildColumns(columns);
+          const builtCols = this.reportColumnTransformer.transform(columns);
           const builtFilters = this.buildFilter(filter || {}, columns);
           const lang = this.formatLangCode(core.I18n.instance.language);
           const clientLogo = '';
@@ -8923,12 +8972,15 @@
           super(...arguments);
           this.route = '/generateXLS';
       }
+      getFileType() {
+          return 'xls';
+      }
       buildDataset(data, metadata) {
           const result = this.formatDataSet(metadata, data);
           return JSON.stringify(result);
       }
       buildMetadata(name, title, columns, filter) {
-          const builtCols = this.buildColumns(columns);
+          const builtCols = this.reportColumnTransformer.transform(columns);
           const builtFilters = this.buildFilter(filter || {}, columns);
           const lang = this.formatLangCode(core.I18n.instance.language);
           const clientLogo = '';
@@ -9215,25 +9267,25 @@
               return formattedData;
           });
       }
-      getReportType(type) {
+      getReportType(type, labelFormatter) {
           if (type === 'csv') {
-              return new CSVReport();
+              return new CSVReport(labelFormatter);
           }
           if (type === 'pdf') {
-              return new PDFReport();
+              return new PDFReport(labelFormatter);
           }
           if (type === 'xls') {
-              return new XLSReport();
+              return new XLSReport(labelFormatter);
           }
           if (type === 'xls2') {
-              return new XLS2Report();
+              return new XLS2Report(labelFormatter);
           }
           if (type === 'xls3') {
-              return new XLS3Report();
+              return new XLS3Report(labelFormatter);
           }
           throw new Error(`Invalid report type: ${type}`);
       }
-      getReport(type, portrait = true, rowObj, beforeReportEvent) {
+      getReport(type, portrait = true, rowObj, beforeReportEvent, labelFormatter) {
           var _a;
           return __awaiter(this, void 0, void 0, function* () {
               const data = (_a = this.data) !== null && _a !== void 0 ? _a : yield this.getData();
@@ -9244,7 +9296,7 @@
                   containerLabel: this.title,
                   widgetLabel: this.title,
               };
-              const reportType = this.getReportType(type);
+              const reportType = this.getReportType(type, labelFormatter);
               const { route } = reportType;
               const { name, columns, datasource } = this.iterable;
               const { groupedData } = Object.assign({}, this.iterable);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeedhi/common",
-  "version": "1.109.1",
+  "version": "1.110.0",
   "description": "Zeedhi Common",
   "author": "Zeedhi <zeedhi@teknisa.com>",
   "license": "ISC",
@@ -43,5 +43,5 @@
     "lodash.times": "4.3.*",
     "mockdate": "3.0.*"
   },
-  "gitHead": "7260f4ea8769c7f86c4f6c3e379e141f6ac401c0"
+  "gitHead": "fc3c2ff25bee46c565577b6749a4d0539762407f"
 }

package/types/components/zd-grid/grid-editable.d.ts

@@ -59,6 +59,7 @@ export declare class GridEditable extends Grid implements IGridEditable {
     protected addCancelColumn(): void;
     protected getCancelColumnProps(): IGridColumnEditable;
     protected instantiateCancelColumn(): GridColumnEditable;
+    protected registerDatasourceCallback(): void;
     protected createGridController(): void;
     /**
      * Changes column order
@@ -165,6 +166,8 @@ export declare class GridEditable extends Grid implements IGridEditable {
      */
     isValid(column: IGridColumnEditable, row: IDictionary, revalidate?: boolean): string | boolean;
     private newRowIdentifier;
+    private positionIdentifier;
+    private pageIdentifier;
     /**
      * Cancels all edited rows and enable grid components
      */
@@ -206,7 +209,17 @@ export declare class GridEditable extends Grid implements IGridEditable {
      * @param position whether the new Row will be inserted at the beginning or end of the data array
      */
     addNewRow(row: IDictionary, position?: 'end' | 'start'): Promise<void>;
+    /**
+     * Saves a row reference in editedRows and addedRows
+     * @param row Row to be saved
+     */
     protected saveRowReference(row: IDictionary<any>): void;
+    /**
+     * Inserts a row in datasource depending on the position
+     * @param row Row to be inserted
+     * @param position Position, 'end' or 'start'
+     * @returns the data containing the newly added row
+     */
     protected insertRowInDatasource(row: IDictionary<any>, position: 'end' | 'start'): IDictionary<any>[];
     /**
      * Gets the editable component name

package/types/utils/report/report-type/base-report.d.ts

@@ -1,15 +1,15 @@
 import { IDictionary } from '@zeedhi/core';
 import { IColumn } from '../../../components';
-import { IReportType, MetadataColumn, MetadataFilter } from './interfaces';
+import { IReportType, MetadataFilter, LabelFormatter } from './interfaces';
+import { ReportColumnTransformer } from './report-column-transformer';
 export declare abstract class BaseReport implements IReportType {
+    reportColumnTransformer: ReportColumnTransformer;
+    constructor(labelFormatter?: LabelFormatter);
+    protected getReportColumnTransformer(labelFormatter?: LabelFormatter): ReportColumnTransformer;
+    abstract getFileType(): string;
     abstract route: string;
     abstract buildDataset(data: IDictionary<any>[], metadata?: any): any;
     abstract buildMetadata(name: string, title: string, columns: IColumn[], filter?: IDictionary<any>, portrait?: boolean): Promise<any>;
-    protected getColumnsWidth(columns: IColumn[]): {
-        widths: IDictionary<number>;
-        totalWidth: number;
-    };
-    protected buildColumns(columns: IColumn[]): MetadataColumn;
     protected buildFilter(filter: IDictionary, columns: IColumn[]): MetadataFilter;
     protected formatLangCode(lang?: string): string;
     protected expressionZeedhiToXls: any;

package/types/utils/report/report-type/csv-report.d.ts

@@ -2,6 +2,7 @@ import { IDictionary } from '@zeedhi/core';
 import { IColumn } from '../../../components';
 import { BaseReport } from './base-report';
 export declare class CSVReport extends BaseReport {
+    getFileType(): string;
     readonly route: string;
     buildDataset(data: IDictionary<any>[], columns: IColumn[]): string;
     buildMetadata(name: string, title: string, columns: IColumn[], filter?: IDictionary<any>): Promise<string>;

package/types/utils/report/report-type/interfaces.d.ts

@@ -45,3 +45,35 @@ export interface IMetadataObj {
     xlsMergedCell?: any[];
     xlsDefaultType?: string;
 }
+export declare type ReportFixFormat = {
+    type: 'fix';
+    params: {
+        mask: string;
+    };
+};
+export declare type ReportCurrencyFormat = {
+    type: 'currency';
+    symbol: string;
+    decimal: string;
+    thousands: string;
+    precision: number;
+};
+export declare type ReportNumberFormat = {
+    params: {
+        decimal: string;
+        thousands: string;
+        precision: number;
+    };
+};
+export declare type ReportFormat = ReportFixFormat | ReportCurrencyFormat | ReportNumberFormat;
+export declare type GetFormatFn = (col: IColumn) => ReportFormat;
+export declare type LabelFormatterParams = {
+    column: IColumn;
+    fileType: string;
+};
+export declare type LabelFormatter = ({ column, fileType }: LabelFormatterParams) => string;
+export declare type ReportColumnTransformerParams = {
+    getFormatFn?: GetFormatFn;
+    labelFormatter?: LabelFormatter;
+    fileType: string;
+};

package/types/utils/report/report-type/pdf-report.d.ts

@@ -1,11 +1,13 @@
 import { IDictionary } from '@zeedhi/core';
 import { IColumn } from '../../../components';
 import { BaseReport } from './base-report';
-import { MetadataColumn } from './interfaces';
+import { LabelFormatter } from './interfaces';
+import { ReportColumnTransformer } from './report-column-transformer';
 export declare class PDFReport extends BaseReport {
+    getFileType(): string;
     readonly route: string;
+    protected getReportColumnTransformer(labelFormatter?: LabelFormatter): ReportColumnTransformer;
     buildDataset(data: IDictionary<any>[]): string;
-    protected buildColumns(columns: IColumn[]): MetadataColumn;
     private getFormatOfColumn;
     private isNumberComponent;
     private checkAccessor;

package/types/utils/report/report-type/report-column-transformer.d.ts

@@ -0,0 +1,9 @@
+import { MetadataColumn, ReportColumnTransformerParams } from './interfaces';
+export declare class ReportColumnTransformer {
+    private getFormatFn?;
+    private labelFormatter?;
+    private fileType;
+    constructor({ getFormatFn, labelFormatter, fileType }: ReportColumnTransformerParams);
+    private getColumnsWidth;
+    transform(columns: any[]): MetadataColumn;
+}

package/types/utils/report/report-type/xls-report.d.ts

@@ -2,6 +2,7 @@ import { IDictionary } from '@zeedhi/core';
 import { IColumn } from '../../../components';
 import { BaseReport } from './base-report';
 export declare class XLSReport extends BaseReport {
+    getFileType(): string;
     readonly route: string;
     buildDataset(data: IDictionary<any>[], columns: IColumn[]): string;
     private formatRawDataSet;

package/types/utils/report/report-type/xls2-report.d.ts

@@ -3,6 +3,7 @@ import { IColumn } from '../../../components';
 import { BaseReport } from './base-report';
 import { IMetadataObj } from './interfaces';
 export declare class XLS2Report extends BaseReport {
+    getFileType(): string;
     readonly route: string;
     buildDataset(data: IDictionary<any>[], metadata: IMetadataObj): string;
     buildMetadata(name: string, title: string, columns: IColumn[], filter?: IDictionary<any>): Promise<string>;

package/types/utils/report/report-type/xls3-report.d.ts

@@ -3,6 +3,7 @@ import { IColumn } from '../../../components';
 import { BaseReport } from './base-report';
 import { IMetadataObj } from './interfaces';
 export declare class XLS3Report extends BaseReport {
+    getFileType(): string;
     readonly route: string;
     buildDataset(data: IDictionary<any>[], metadata: IMetadataObj): string;
     buildMetadata(name: string, title: string, columns: IColumn[], filter?: IDictionary<any>): Promise<string>;

package/types/utils/report/report.d.ts

@@ -1,5 +1,6 @@
 import { IDictionary } from '@zeedhi/core';
 import { Iterable } from '../../components';
+import { LabelFormatter } from './report-type';
 import { IBeforeReportEvent, IReport } from './interfaces';
 export declare class Report implements IReport {
     iterable: Iterable;
@@ -12,6 +13,6 @@ export declare class Report implements IReport {
     private isToggleableComponent;
     private getData;
     private getReportType;
-    getReport(type: string, portrait?: boolean, rowObj?: any, beforeReportEvent?: IBeforeReportEvent): Promise<string>;
+    getReport(type: string, portrait?: boolean, rowObj?: any, beforeReportEvent?: IBeforeReportEvent, labelFormatter?: LabelFormatter): Promise<string>;
     private filterColumns;
 }