@zeedhi/teknisa-components-common 1.109.1 → 1.110.0

package/dist/tek-components-common.esm.js

@@ -966,6 +966,13 @@ class GridBase {
                 },
                 children: this.grid.exportActions || this.exportConfigButtons,
             }),
+            actionsDivider: (index) => ({
+                name: `${this.grid.name}_divider${index}`,
+                component: 'ZdDivider',
+                cssClass: 'toolbar-divider',
+                vertical: true,
+                isVisible: `{{GridController_${this.grid.componentId}.showActionsButton}}`,
+            }),
             actionsDropdown: () => ({
                 name: `${this.grid.name}_actions_dropdown`,
                 component: 'ZdDropdown',
@@ -1074,7 +1081,7 @@ class GridBase {
     addDefaultToolbarItems(toolbarDivChildren) {
         const defaultItems = [
             'addButton', 'deleteButton', 'divider', 'refreshButton', 'divider',
-            'columnsButton', 'layoutOptions', 'exportDropdown', 'divider', 'actionsDropdown',
+            'columnsButton', 'layoutOptions', 'exportDropdown', 'actionsDivider', 'actionsDropdown',
             'saveButton', 'cancelButton', 'divider', 'gridSearch', 'filterButton',
         ];
         defaultItems.forEach((itemName, index) => {
@@ -2402,6 +2409,7 @@ class TekGrid extends GridEditable {
         this.editNewRowsOnly = this.getInitValue('editNewRowsOnly', props.editNewRowsOnly, this.editNewRowsOnly);
         this.mainGrid = this.getInitValue('mainGrid', props.mainGrid, this.mainGrid);
         this.reportTitle = this.getInitValue('reportTitle', props.reportTitle, this.reportTitle);
+        this.reportLabelFormatter = this.getInitValue('reportLabelFormatter', props.reportLabelFormatter, this.reportLabelFormatter);
         this.actions = props.actions || this.actions;
         this.toolbarSlotProps = props.toolbarSlot !== undefined;
         if (this.deleteButton === 'selection') {
@@ -2587,7 +2595,7 @@ class TekGrid extends GridEditable {
                         columns: reportAggregations,
                         xlsDefaultType: this.xlsDefaultType,
                     }),
-                }, beforeOpen);
+                }, beforeOpen, this.reportLabelFormatter);
                 window.open(reportUrl);
             }
             catch (e) {

package/dist/tek-components-common.umd.js

@@ -970,6 +970,13 @@
                   },
                   children: this.grid.exportActions || this.exportConfigButtons,
               }),
+              actionsDivider: (index) => ({
+                  name: `${this.grid.name}_divider${index}`,
+                  component: 'ZdDivider',
+                  cssClass: 'toolbar-divider',
+                  vertical: true,
+                  isVisible: `{{GridController_${this.grid.componentId}.showActionsButton}}`,
+              }),
               actionsDropdown: () => ({
                   name: `${this.grid.name}_actions_dropdown`,
                   component: 'ZdDropdown',
@@ -1078,7 +1085,7 @@
       addDefaultToolbarItems(toolbarDivChildren) {
           const defaultItems = [
               'addButton', 'deleteButton', 'divider', 'refreshButton', 'divider',
-              'columnsButton', 'layoutOptions', 'exportDropdown', 'divider', 'actionsDropdown',
+              'columnsButton', 'layoutOptions', 'exportDropdown', 'actionsDivider', 'actionsDropdown',
               'saveButton', 'cancelButton', 'divider', 'gridSearch', 'filterButton',
           ];
           defaultItems.forEach((itemName, index) => {
@@ -2406,6 +2413,7 @@
           this.editNewRowsOnly = this.getInitValue('editNewRowsOnly', props.editNewRowsOnly, this.editNewRowsOnly);
           this.mainGrid = this.getInitValue('mainGrid', props.mainGrid, this.mainGrid);
           this.reportTitle = this.getInitValue('reportTitle', props.reportTitle, this.reportTitle);
+          this.reportLabelFormatter = this.getInitValue('reportLabelFormatter', props.reportLabelFormatter, this.reportLabelFormatter);
           this.actions = props.actions || this.actions;
           this.toolbarSlotProps = props.toolbarSlot !== undefined;
           if (this.deleteButton === 'selection') {
@@ -2591,7 +2599,7 @@
                           columns: reportAggregations,
                           xlsDefaultType: this.xlsDefaultType,
                       }),
-                  }, beforeOpen);
+                  }, beforeOpen, this.reportLabelFormatter);
                   window.open(reportUrl);
               }
               catch (e) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeedhi/teknisa-components-common",
-  "version": "1.109.1",
+  "version": "1.110.0",
   "description": "Teknisa Components Common",
   "author": "Zeedhi <zeedhi@teknisa.com>",
   "license": "ISC",
@@ -32,5 +32,5 @@
   "peerDependencies": {
     "@zeedhi/core": "^1.97.0"
   },
-  "gitHead": "d40cf324961b699346b610c975eaedc46f1a154a"
+  "gitHead": "5dc8ed0a31eac861718475f4fd2e65ab0da772cc"
 }

package/tests/unit/components/tek-grid/grid.spec.ts

@@ -311,6 +311,34 @@ describe('TekGrid', () => {
       spy.mockReset();
     });
 
+    it('when reportLabelFormatter is defined, it should be passed to getReport', async () => {
+      (window as any).open = jest.fn();
+      const reportLabelFormatter = jest.fn();
+      const spy = jest.spyOn(Report.prototype, 'getReport').mockImplementationOnce(async () => '');
+
+      const instance = new TekGrid({
+        reportLabelFormatter,
+        name: 'grid',
+        component: 'TekGrid',
+        columns: [
+          {
+            name: 'id',
+            label: 'ID',
+            aggregation: 'COUNT',
+          },
+          {
+            name: 'department_id',
+            label: 'Department ID',
+            grouped: true,
+          },
+        ],
+      });
+
+      await instance.getReport('pdf');
+
+      expect(spy).toHaveBeenLastCalledWith('pdf', undefined, expect.any(Object), undefined, reportLabelFormatter);
+    });
+
     it('when called with a dynamicFilter, should format the filter values', async () => {
       (window as any).open = jest.fn();
       const spy = jest.spyOn(Report.prototype, 'getReport').mockImplementationOnce(async () => '');
@@ -399,7 +427,7 @@ describe('TekGrid', () => {
         metaData: expect.objectContaining({
           filter,
         }),
-      }), undefined);
+      }), undefined, undefined);
       (window as any).open.mockClear();
       spy.mockReset();
     });
@@ -465,7 +493,7 @@ describe('TekGrid', () => {
         metaData: {
           columns: {}, filter: undefined, groups: [], xlsDefaultType: undefined,
         },
-      }, undefined);
+      }, undefined, undefined);
     });
 
     it('when data is empty, should show alert', async () => {
@@ -2846,10 +2874,11 @@ describe('TekGrid', () => {
           ],
         },
       });
+      await instance.datasource.get();
       const newRow1 = { id: 2 };
       await instance.addNewRow(newRow1, 'start');
-      expect(instance.datasource.data[0]).toEqual({ id: 2, __added_row: true });
-      expect(instance.datasource.data[1]).toEqual({ id: 1 });
+      expect(instance.datasource.data[0]).toMatchObject({ id: 2, __added_row: true });
+      expect(instance.datasource.data[1]).toMatchObject({ id: 1 });
     });
 
     it('should add a new row to the groupedData array', async () => {

package/types/components/tek-datasource/rest-datasource.d.ts

@@ -32,36 +32,36 @@ export declare class TekRestDatasource extends RestDatasource implements ITekRes
      * @param filtroDinamico
      * @returns
      */
-    setBaseFilter(filtroDinamico: any): Promise<any>;
+    setBaseFilter(filtroDinamico: any): Promise<IDictionary<any> | IDictionary<any>[]>;
     /**
      * Adds a new dynamic filter position or replace if exists
      * @param column Dynamic Filter column name
      * @param value Dynamic Filter value
      * @returns Promise with data collection
      */
-    addDynamicFilter(column: string, value: any): Promise<any>;
+    addDynamicFilter(column: string, value: any): Promise<IDictionary<any> | IDictionary<any>[]>;
     /**
      * Removes a dynamic filter position
      * @param column Dynamic Filter column name
      * @returns Promise with data collection
      */
-    removeDynamicFilter(column: string): Promise<any>;
+    removeDynamicFilter(column: string): Promise<IDictionary<any> | IDictionary<any>[]>;
     /**
      * Sets new dynamic filter value
      * @param filter Dynamic Filter value
      * @returns Promise with data collection
      */
-    setDynamicFilter(filter: IDictionary<any>): Promise<any>;
+    setDynamicFilter(filter: IDictionary<any>): Promise<IDictionary<any> | IDictionary<any>[]>;
     /**
      * Clears Dynamic filter value
      * @returns Promise with data collection
      */
-    clearDynamicFilter(): Promise<any>;
+    clearDynamicFilter(): Promise<IDictionary<any> | IDictionary<any>[]>;
     /**
      * Resets page and selected rows and tries to update the url
      * @returns Promise with data collection
      */
-    updateDynamicFilter(): Promise<any>;
+    updateDynamicFilter(): Promise<IDictionary<any> | IDictionary<any>[]>;
     /**
      * Checks if a filter value is valid
      * @param value Filter value

package/types/components/tek-grid/grid.d.ts

@@ -1,4 +1,4 @@
-import { GridEditable, IComponentRender, IGridColumnEditable, Input } from '@zeedhi/common';
+import { GridEditable, IComponentRender, IGridColumnEditable, Input, LabelFormatter } from '@zeedhi/common';
 import { Datasource, IDictionary, IEventParam } from '@zeedhi/core';
 import { ITekGridAtoms } from '../../utils';
 import { TekGridColumn } from './grid-column';
@@ -81,6 +81,7 @@ export declare class TekGrid extends GridEditable implements ITekGrid {
     defaultFilter: IDictionary;
     toolbarOpened: boolean;
     reportTitle: string;
+    reportLabelFormatter?: LabelFormatter;
     /**
      * TekGrid class constructor
      * @param props TekGrid properties

package/types/components/tek-grid/interfaces.d.ts

@@ -1,4 +1,4 @@
-import { IBeforeReportEvent, IComponent, IComponentEvents, IComponentRender, IGridColumnEditable, IGridEditable, IIterableColumnsButton, EventDef, IModal, IButton } from '@zeedhi/common';
+import { IBeforeReportEvent, IComponent, IComponentEvents, IComponentRender, IGridColumnEditable, IGridEditable, IIterableColumnsButton, EventDef, IModal, IButton, LabelFormatter } from '@zeedhi/common';
 import { IDictionary, IEvent, IEventParam, IDateHelperValue, IDateHelperValues } from '@zeedhi/core';
 import { IDynamicFilterItem, TekGrid, TekGridLayoutOptions, TekTreeGrid } from '..';
 export interface ITekGridLayoutEventParams extends IEventParam<ITekGrid> {
@@ -64,6 +64,7 @@ export interface ITekGrid extends IGridEditable {
     xlsDefaultType?: string;
     toolbarOpened?: boolean;
     reportTitle?: string;
+    reportLabelFormatter?: LabelFormatter;
 }
 export declare type MultiOptionParams = {
     iconName: string;