@zeedhi/teknisa-components-common 1.130.0 → 1.132.0

package/tests/unit/utils/object-comparison.spec.ts

@@ -0,0 +1,89 @@
+import {
+  areObjectsEqual,
+  cloneComparableValue,
+  normalizeComparableValue,
+} from '../../../src/utils/object-comparison';
+
+describe('object-comparison', () => {
+  describe('areObjectsEqual()', () => {
+    it('should compare objects with different key order as equal', () => {
+      expect(areObjectsEqual({ a: 1, b: 2 }, { b: 2, a: 1 })).toBeTruthy();
+    });
+
+    it('should compare nested object values', () => {
+      expect(areObjectsEqual(
+        { filter: { id: [{ value: '10' }] } },
+        { filter: { id: [{ value: '20' }] } },
+      )).toBeFalsy();
+    });
+
+    it('should preserve array order when comparing values', () => {
+      expect(areObjectsEqual([1, 2, 3], [3, 2, 1])).toBeFalsy();
+      expect(areObjectsEqual([1, 2, 3], [1, 2, 3])).toBeTruthy();
+    });
+
+    it('should ignore undefined properties', () => {
+      expect(areObjectsEqual(
+        { value: '10', optional: undefined },
+        { value: '10' },
+      )).toBeTruthy();
+    });
+
+    it('should compare empty-like values as equal', () => {
+      expect(areObjectsEqual(null, undefined)).toBeTruthy();
+      expect(areObjectsEqual('', undefined)).toBeTruthy();
+      expect(areObjectsEqual({}, [])).toBeTruthy();
+      expect(areObjectsEqual({ filter: {} }, {})).toBeTruthy();
+      expect(areObjectsEqual(
+        { filter: null, dynamicFilter: undefined },
+        { filter: '', dynamicFilter: [] },
+      )).toBeTruthy();
+    });
+
+    it('should compare primitive values without coercion', () => {
+      expect(areObjectsEqual(1, '1')).toBeFalsy();
+      expect(areObjectsEqual(false, '')).toBeFalsy();
+      expect(areObjectsEqual(0, '')).toBeFalsy();
+    });
+  });
+
+  describe('cloneComparableValue()', () => {
+    it('should clone nested values', () => {
+      const value = {
+        filter: {
+          id: [{ value: '10' }],
+        },
+      };
+
+      const clonedValue = cloneComparableValue(value);
+      value.filter.id[0].value = '20';
+
+      expect(clonedValue).toEqual({
+        filter: {
+          id: [{ value: '10' }],
+        },
+      });
+    });
+  });
+
+  describe('normalizeComparableValue()', () => {
+    it('should sort object keys and remove empty-like values', () => {
+      expect(normalizeComparableValue({
+        b: 2,
+        a: undefined,
+        d: {},
+        c: 3,
+      })).toEqual({
+        b: 2,
+        c: 3,
+      });
+    });
+
+    it('should normalize empty-like values to null', () => {
+      expect(normalizeComparableValue(undefined)).toBeNull();
+      expect(normalizeComparableValue('')).toBeNull();
+      expect(normalizeComparableValue({})).toBeNull();
+      expect(normalizeComparableValue([])).toBeNull();
+    });
+  });
+});

package/types/components/index.d.ts

@@ -26,6 +26,7 @@ export * from './tek-grid/grid';
 export * from './tek-grid/grid-column';
 export * from './tek-grid/grid-columns-button';
 export * from './tek-grid/grid-columns-button-controller';
+export * from './tek-grid/grid-export-button';
 export * from './tek-grid/grid-filter-button';
 export * from './tek-grid/layout-options';
 export * from './tek-grid/filter-helper';

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

@@ -1,4 +1,5 @@
 import { IterableColumnsButton } from '@zeedhi/common';
+import { TekGridColumnsButtonController } from './grid-columns-button-controller';
 import { ITekGridColumnsButton } from './interfaces';
 /**
  * Base class for TekGrid Columns Button component
@@ -6,7 +7,7 @@ import { ITekGridColumnsButton } from './interfaces';
 export declare class TekGridColumnsButton extends IterableColumnsButton implements ITekGridColumnsButton {
     hideGroups: boolean;
     constructor(props: ITekGridColumnsButton);
-    onCreated(): void;
+    createController(): TekGridColumnsButtonController;
     private aggregationDataSet;
     getAggregationSelectData(): any[];
 }

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

@@ -0,0 +1,19 @@
+import { ComponentRender, IComponentRender } from '@zeedhi/common';
+import type { TekTreeGrid } from '../tek-tree-grid/tree-grid';
+import type { TekGrid } from './grid';
+import { ITekGridExportButton, ITekGridExportConfig } from './interfaces';
+/**
+ * Base class for TekGrid export button/dropdown component.
+ */
+export declare class TekGridExportButton extends ComponentRender implements ITekGridExportButton {
+    gridName?: string;
+    grid?: TekGrid | TekTreeGrid;
+    exportConfig?: ITekGridExportConfig[];
+    exportActions?: IComponentRender[];
+    constructor(props: ITekGridExportButton);
+    private getOption;
+    private getExportConfigButtons;
+    private loadChildren;
+    loadGrid(gridName?: string): void;
+    onCreated(): void;
+}

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

@@ -15,6 +15,7 @@ export declare class TekGridFilterButton extends Button implements ITekGridFilte
     constructor(props: ITekGridFilterButton);
     loadGrid(gridName?: string): void;
     click(event?: Event): void;
+    onCreated(): void;
     private loadFilterValues;
     hideFilterModal(): void;
     destroyFilterModal(): void;

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

@@ -3,6 +3,7 @@ import { Datasource, IDictionary, IEventParam } from '@zeedhi/core';
 import { ITekGridAtoms } from '../../utils';
 import { TekGridColumn } from './grid-column';
 import { IGroupedData, IModalFilterProps, ITekGrid, ITekGridColumn, ITekGridEvents, ITekGridExportConfig, ITekGridGroup, ITekGridGroupFooter } from './interfaces';
+import type { TekGridFilterButton } from './grid-filter-button';
 import { TekGridLayoutOptions } from './layout-options';
 export declare class TekGrid extends GridEditable implements ITekGrid {
     title: string;
@@ -178,6 +179,8 @@ export declare class TekGrid extends GridEditable implements ITekGrid {
     isGrouped(): number | false;
     navigateDown(params?: any): void;
     navigateUp(params?: any): void;
+    navigateDatasource(up: boolean): void;
+    private navigateGroupedDatasource;
     directionalLeft(params: IEventParam<any>): void;
     directionalRight(params: IEventParam<any>): void;
     /**
@@ -206,6 +209,7 @@ export declare class TekGrid extends GridEditable implements ITekGrid {
     selectGroupClick(row: IDictionary<any>, isSelected: boolean, event: Event, element: HTMLElement): void;
     getAtomInstance<T>(key: keyof ITekGridAtoms): T;
     getFilterInputs(columnName?: string): Input[];
+    registerFilterButton(filterButton: TekGridFilterButton): void;
     isColumnSearchable(column: TekGridColumn): boolean;
     getColumn(name: string): TekGridColumn;
     /**

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

@@ -117,6 +117,7 @@ export interface ITekGridLayoutColumn {
 }
 export interface ITekGridLayoutOptions extends IComponentRender {
     events?: ITekGridLayoutOptionsEvents;
+    gridName?: string;
 }
 export declare type IFilterRelation = 'AND' | 'OR';
 export declare type IFilterOperation = 'CONTAINS' | 'NOT_CONTAINS' | 'EQUALS' | 'NOT_EQUALS' | 'GREATER_THAN' | 'LESS_THAN' | 'GREATER_THAN_EQUALS' | 'LESS_THAN_EQUALS' | 'IN' | 'NOT_IN' | 'BETWEEN';
@@ -138,6 +139,7 @@ export interface ITekGridColumn extends IGridColumnEditable {
     storeData?: boolean;
 }
 export interface ITekGridColumnsButton extends IIterableColumnsButton {
+    gridName?: string;
     hideGroups?: boolean;
 }
 export interface ITekGridFilterButton extends IButton {
@@ -145,6 +147,12 @@ export interface ITekGridFilterButton extends IButton {
     grid?: TekGrid | TekTreeGrid;
     showCheckboxAll?: boolean;
 }
+export interface ITekGridExportButton extends IComponentRender {
+    gridName?: string;
+    grid?: TekGrid | TekTreeGrid;
+    exportConfig?: ITekGridExportConfig[];
+    exportActions?: IComponentRender[];
+}
 export interface ITekGridGroup {
     column: ITekGridColumn;
     name: string;

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

@@ -3,6 +3,7 @@ import { IDictionary } from '@zeedhi/core';
 import { IDynamicFilterItem, ITekGridLayoutColumn } from '..';
 import { ITekGridLayoutOptions, ITekGridLayout, ITekGridLayoutOptionsEvents } from './interfaces';
 export declare class TekGridLayoutOptions extends ComponentRender implements ITekGridLayoutOptions {
+    gridName?: string;
     currentLayoutName: string;
     layoutEdited: boolean;
     layouts: IDictionary<ITekGridLayout>;
@@ -15,11 +16,24 @@ export declare class TekGridLayoutOptions extends ComponentRender implements ITe
     originalDatasourceFilter: IDictionary<any>;
     events: ITekGridLayoutOptionsEvents;
     grid: Grid;
+    private changeLayoutEventGrid?;
+    private originalLayoutSnapshot?;
+    constructor(props: ITekGridLayoutOptions);
     private getParentGrid;
+    loadGrid(gridName?: string): Grid;
+    private onGridChangeLayout;
+    private registerChangeLayoutEvent;
     onMounted(element: HTMLElement): Promise<void>;
     private checkLayoutsData;
     protected loadLayoutsInfo(): Promise<any>;
     getHelperValue(column: any): string | (string | undefined)[] | undefined;
+    getLayoutColumnSnapshot(column: any, isVisible?: boolean): ITekGridLayoutColumn;
+    private getCurrentLayoutSnapshot;
+    private getBaselineLayoutSnapshot;
+    private getOriginalLayoutSnapshot;
+    hasLayoutChanges(): boolean;
+    getCurrentLayout(): ITekGridLayout;
+    getLayout(name?: string): ITekGridLayout | undefined;
     layoutHasFilter(layout: string | ITekGridLayout): number | false;
     private confirmFilterModal?;
     private newLayoutValue?;
@@ -31,6 +45,7 @@ export declare class TekGridLayoutOptions extends ComponentRender implements ITe
     private saveLayouts;
     deleteLayout(name: string): void;
     updateLayout(name: string, layout: ITekGridLayout): void;
+    updateLayout(name?: string): void;
     updateDefaultLayout(layout: ITekGridLayout): void;
     private fixColumns;
 }

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

@@ -3,6 +3,7 @@ import { Datasource, IDictionary } from '@zeedhi/core';
 import { ITekGridAtoms } from '../../utils';
 import { TekGridColumn } from '../tek-grid/grid-column';
 import { IModalFilterProps, ITekGridColumn, ITekGridEvents, ITekGridExportConfig } from '../tek-grid/interfaces';
+import type { TekGridFilterButton } from '../tek-grid/grid-filter-button';
 import { ITekTreeGrid } from './interfaces';
 import { TekGridLayoutOptions } from '..';
 export declare class TekTreeGrid extends TreeGridEditable implements ITekTreeGrid {
@@ -98,5 +99,6 @@ export declare class TekTreeGrid extends TreeGridEditable implements ITekTreeGri
     rowClick(row: IDictionary<any>, event: Event, element: HTMLElement): void;
     getAtomInstance<T>(key: keyof ITekGridAtoms): T;
     getFilterInputs(columnName?: string): import("@zeedhi/common").Input[];
+    registerFilterButton(filterButton: TekGridFilterButton): void;
     getColumn(name: string): TekGridColumn;
 }

package/types/utils/grid-base/export-options/button-option.d.ts

@@ -1,4 +1,6 @@
-import { ITekGridExportConfig, TekGrid, TekTreeGrid } from '../../../components';
+import type { TekTreeGrid } from '../../../components/tek-tree-grid/tree-grid';
+import type { ITekGridExportConfig } from '../../../components/tek-grid/interfaces';
+import type { TekGrid } from '../../../components/tek-grid/grid';
 import { IExportOption } from './interfaces';
 export declare class ButtonOption implements IExportOption {
     private config;

package/types/utils/grid-base/export-options/multi-option.d.ts

@@ -1,5 +1,7 @@
 import { IRow } from '@zeedhi/common';
-import { ITekGridExportConfig, TekGrid, TekTreeGrid } from '../../../components';
+import type { TekTreeGrid } from '../../../components/tek-tree-grid/tree-grid';
+import type { ITekGridExportConfig } from '../../../components/tek-grid/interfaces';
+import type { TekGrid } from '../../../components/tek-grid/grid';
 import { IExportOption } from './interfaces';
 export declare class MultiOption implements IExportOption {
     private config;

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

@@ -21,11 +21,8 @@ export interface ITekGridAtoms {
 }
 export declare class GridBase {
     private grid;
-    private exportConfigButtons;
     private defaultToolbar;
     constructor(grid: TekGrid | TekTreeGrid);
-    private getOption;
-    private getExportConfigButtons;
     private initializeDefaultToolbarItems;
     private processUserToolbarItems;
     /**
@@ -39,6 +36,7 @@ export declare class GridBase {
     createToolbarProps(): IComponentRender[];
     filterButton?: TekGridFilterButton;
     private loadFilterButton;
+    registerFilterButton(filterButton: TekGridFilterButton): void;
     private hideButtonClick;
     private addButtonClick;
     private deleteButtonClick;

package/types/utils/index.d.ts

@@ -4,3 +4,4 @@ export * from './grid-base/grid-controller';
 export * from './grid-base/export-options';
 export * from './config/config';
 export * from './extract-properties';
+export * from './object-comparison';

package/types/utils/object-comparison.d.ts

@@ -0,0 +1,3 @@
+export declare function cloneComparableValue<T>(value: T): T;
+export declare function normalizeComparableValue(value: any): any;
+export declare function areObjectsEqual(first: any, second: any): boolean;