@zeedhi/teknisa-components-common 1.95.0 → 1.96.1

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

@@ -1,10 +1,10 @@
 /* eslint-disable no-underscore-dangle */
 
 import {
-  Button, Date, Form, IButton, IForm, IModal, Modal, ModalService,
+  Button, Date, Form, IButton, IForm, IModal, ISelectMultiple, Modal, ModalService, SelectMultiple,
 } from '@zeedhi/common';
 import {
-  Http, Metadata, DateHelper,
+  Http, Metadata, DateHelper, Config,
 } from '@zeedhi/core';
 import {
   IFilterPropsComponent,
@@ -207,6 +207,133 @@ describe('TekGridFilterButton', () => {
       spy.mockReset();
     });
 
+    it('when creating a SelectMultiple filter, default should not add showCheckboxAll prop', () => {
+      const instance = new TekGrid({
+        name: 'grid_filterClick5',
+        component: 'TekGrid',
+        columns: [
+          {
+            name: 'id',
+            filterable: true,
+            filterProps: [{
+              name: 'id_edit', label: 'id', component: 'ZdSelectMultiple', showCheckboxAll: false,
+            }],
+          },
+          {
+            name: 'name',
+            filterable: true,
+            filterProps: [{ name: 'name_edit', label: 'name', component: 'ZdSelectMultiple' }],
+          },
+        ],
+      });
+
+      let formElements: any = [];
+      const spy = jest.spyOn(ModalService, 'create').mockImplementation((modal: IModal) => {
+        const form = getChild<IForm>(modal.children || [], `${instance.name}-filter-form`);
+        formElements = form.children;
+
+        return new Modal(modal);
+      });
+      instance.onCreated();
+      clickOnFilterButton(instance);
+
+      expect(formElements[0].showCheckboxAll).toBeFalsy();
+      expect(formElements[1].showCheckboxAll).toBeFalsy();
+
+      spy.mockReset();
+    });
+
+    it('when using the prop showCheckboxAllFilter, should add showCheckboxAll prop to SelectMultiple filters', () => {
+      const instance = new TekGrid({
+        name: 'grid_filterClick5',
+        component: 'TekGrid',
+        showCheckboxAllFilter: true,
+        columns: [
+          {
+            name: 'id',
+            filterable: true,
+            filterProps: [{
+              name: 'id_edit', label: 'id', component: 'ZdSelectMultiple', showCheckboxAll: false,
+            }],
+          },
+          {
+            name: 'name',
+            filterable: true,
+            filterProps: [{ name: 'name_edit', label: 'name', component: 'ZdSelectMultiple' }],
+          },
+        ],
+      });
+
+      let formElements: any = [];
+      const spy = jest.spyOn(ModalService, 'create').mockImplementation((modal: IModal) => {
+        const form = getChild<IForm>(modal.children || [], `${instance.name}-filter-form`);
+        formElements = form.children;
+
+        return new Modal(modal);
+      });
+      instance.onCreated();
+      clickOnFilterButton(instance);
+
+      expect(formElements[0].showCheckboxAll).toBeFalsy();
+      expect(formElements[1].showCheckboxAll).toBeTruthy();
+
+      spy.mockReset();
+    });
+
+    it('when creating a SelectMultiple filter, should change the filter value depending on checkboxAll', () => {
+      const instance = new TekGrid({
+        name: 'grid_filterClick5',
+        component: 'TekGrid',
+        columns: [
+          {
+            name: 'id',
+            filterable: true,
+            filterProps: [{
+              name: 'id_edit', label: 'id', component: 'ZdSelectMultiple', showCheckboxAll: false,
+            }],
+          },
+        ],
+      });
+
+      let form: IForm = { name: 'form', component: 'ZdForm' };
+      let select: ISelectMultiple = { name: 'select', component: 'ZdSelectMultiple' };
+      let applyButton: IButton = { name: 'apply', component: 'ZdButton' };
+      const spy = jest.spyOn(ModalService, 'create').mockImplementation((modal: IModal) => {
+        const modalFooter = getChild(modal.children || [], `${instance.name}-filter-footer`);
+        form = getChild(modal.children || [], `${instance.name}-filter-form`);
+        select = getChild(form.children || [], `${instance.name}-filter-AND-CONTAINS-id-0`);
+        applyButton = getChild(modalFooter.rightSlot, `${instance.name}-filter-okButton`);
+
+        return new Modal(modal);
+      });
+      instance.onCreated();
+      clickOnFilterButton(instance);
+      const applyButtonObject = new Button(applyButton);
+
+      const formObject = new Form(form);
+      const selectObject = new SelectMultiple(select);
+      jest.spyOn(Metadata, 'getInstance').mockReturnValue(formObject);
+      jest.spyOn(formObject, 'getChildInstance').mockReturnValue(selectObject);
+
+      formObject.value['grid_filterClick5-filter-AND-CONTAINS-id-0'] = ['example'];
+      setClick(applyButtonObject);
+
+      expect(instance.datasource.filter).toEqual({
+        id: ['example'],
+      });
+
+      selectObject.checkboxAll = true;
+      setClick(applyButtonObject);
+
+      expect(instance.datasource.filter).toEqual({});
+
+      (Config as any).set({ selectAllCompatibilityMode: true });
+      setClick(applyButtonObject);
+      expect(instance.datasource.filter).toEqual({ id: 'T' });
+
+      spy.mockReset();
+    });
+
     it('should create modal with filterable and ordered form elements', () => {
       const instance = new TekGrid({
         name: 'grid-filter-order',

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

@@ -706,13 +706,13 @@ describe('TekGrid', () => {
       (KeyMap as any).isElementActive = () => true;
       instance.onCreated();
       instance.onMounted(elem);
-      dispatchEvent('arrowdown', {}); // arrow down
+      instance.navigateDatasource(false);
       expect(instance.datasource.currentRow).toEqual(instance.datasource.data[0]);
 
-      dispatchEvent('arrowdown', {}); // arrow down
+      instance.navigateDatasource(false);
       expect(instance.datasource.currentRow).toEqual(instance.datasource.data[1]);
 
-      dispatchEvent('arrowup', {}); // arrow up
+      instance.navigateDatasource(true);
       expect(instance.datasource.currentRow).toEqual(instance.datasource.data[0]);
 
       dispatchEvent('arrowright', {}); // arrow right
@@ -2278,4 +2278,23 @@ describe('TekGrid', () => {
       spyModalService.mockReset();
     });
   });
+
+  describe('loadAfterTasks', () => {
+    it('should call request even if tasks fail', async () => {
+      const instance = new TekGrid({
+        name: 'grid',
+        component: 'TekGrid',
+      });
+      const spy = jest.spyOn(instance.datasource, 'get');
+
+      const errorFn = async () => {
+        throw new Error();
+      };
+      instance.registerTask(errorFn());
+
+      await instance.loadAfterTasks();
+
+      expect(spy).toHaveBeenCalledTimes(1);
+    });
+  });
 });

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

@@ -9,6 +9,7 @@ import { TekTreeGrid } from '../tek-tree-grid/tree-grid';
 export declare class TekGridFilterButton extends Button implements ITekGridFilterButton {
     gridName?: string;
     grid: TekGrid | TekTreeGrid;
+    showCheckboxAll: boolean;
     private filterModal?;
     protected filterFormInputs: IDictionary<string[]>;
     constructor(props: ITekGridFilterButton);
@@ -19,6 +20,7 @@ export declare class TekGridFilterButton extends Button implements ITekGridFilte
     destroyFilterModal(): void;
     private createFilterFromColumns;
     onBeforeDestroy(): void;
+    private formatFormValue;
     private applyFilter;
     private setFilter;
     private clearFilter;

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

@@ -1,5 +1,5 @@
 import { GridEditable, IComponentRender } from '@zeedhi/common';
-import { Datasource, IDictionary } from '@zeedhi/core';
+import { Datasource, IDictionary, IEventParam } from '@zeedhi/core';
 import { ITekGridAtoms } from '../../utils';
 import { TekGridColumn } from './grid-column';
 import { IModalFilterProps, ITekGrid, ITekGridColumn, ITekGridEvents, ITekGridExportConfig } from './interfaces';
@@ -72,6 +72,7 @@ export declare class TekGrid extends GridEditable implements ITekGrid {
     filterOperationsDatasource: Datasource;
     editNewRowsOnly: boolean;
     protected keyShortcutKeyMapping: any;
+    showCheckboxAllFilter: boolean;
     /**
      * TekGrid class constructor
      * @param props TekGrid properties
@@ -105,7 +106,7 @@ export declare class TekGrid extends GridEditable implements ITekGrid {
     /**
      * Loads grid data after resolving all tasks
      */
-    loadAfterTasks(): Promise<void>;
+    loadAfterTasks(): Promise<void | undefined>;
     private initGrouping;
     private buildGetFunction;
     updateGrouping: (lazyLoad?: boolean) => void;
@@ -135,8 +136,8 @@ export declare class TekGrid extends GridEditable implements ITekGrid {
     isGrouped(): number | false;
     navigateDown(params?: any): void;
     navigateUp(params?: any): void;
-    directionalLeft(): void;
-    directionalRight(): void;
+    directionalLeft(params: IEventParam<any>): void;
+    directionalRight(params: IEventParam<any>): void;
     /**
      * Dispatches row click event
      * @param row Grid row

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

@@ -59,6 +59,7 @@ export interface ITekGrid extends IGridEditable {
     showSummaryTotal?: boolean;
     layoutOptions?: TekGridLayoutOptions;
     mainGrid?: boolean;
+    showCheckboxAllFilter?: boolean;
 }
 export declare type MultiOptionParams = {
     iconName: string;
@@ -131,6 +132,7 @@ export interface ITekGridColumnsButton extends IIterableColumnsButton {
 export interface ITekGridFilterButton extends IButton {
     gridName?: string;
     grid?: TekGrid | TekTreeGrid;
+    showCheckboxAll?: boolean;
 }
 export interface ITekGridGroup {
     column: ITekGridColumn;
@@ -168,5 +170,6 @@ export interface ITekFilterHelperValue extends IDateHelperValue {
 export interface ITekFilterHelperValues extends IDateHelperValues {
 }
 export interface IModalFilterProps extends IModal {
-    height: string;
+    height?: string;
+    maxHeight?: string;
 }

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

@@ -21,4 +21,5 @@ export interface ITekTreeGrid extends ITreeGridEditable {
     exportConfig?: ITekGridExportConfig[];
     exportActions?: IComponentRender[];
     layoutOptions?: TekGridLayoutOptions;
+    showCheckboxAllFilter?: boolean;
 }

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

@@ -62,6 +62,7 @@ export declare class TekTreeGrid extends TreeGridEditable implements ITekTreeGri
     private gridBase;
     filterRelationsDatasource: Datasource;
     filterOperationsDatasource: Datasource;
+    showCheckboxAllFilter: boolean;
     /**
      * TekTreeGrid class constructor
      * @param props TekTreeGrid properties

package/types/utils/config/config.d.ts

@@ -2,4 +2,6 @@ import { IConfig } from '@zeedhi/core';
 export interface ITekConfig extends IConfig {
     saveGridLayoutsEndPoint?: string;
     loadGridLayoutsEndPoint?: string;
+    selectAllCompatibilityMode?: boolean;
+    gridShowCheckboxAllFilter?: boolean;
 }

package/types/utils/grid-base/grid-base.d.ts

@@ -227,6 +227,7 @@ export declare class GridBase {
             component: string;
             grid: TekGrid | TekTreeGrid;
             gridName: string;
+            showCheckboxAll: boolean;
             isVisible: string;
             events: {
                 onCreated: ({ component }: IEventParam<TekGridFilterButton>) => void;