@zeedhi/teknisa-components-common 1.107.1 → 1.108.0

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

@@ -1,8 +1,8 @@
-import { GridEditable, IComponentRender } from '@zeedhi/common';
+import { GridEditable, IComponentRender, IGridColumnEditable, Input } from '@zeedhi/common';
 import { Datasource, IDictionary, IEventParam } from '@zeedhi/core';
 import { ITekGridAtoms } from '../../utils';
 import { TekGridColumn } from './grid-column';
-import { IGroupedData, IModalFilterProps, ITekGrid, ITekGridColumn, ITekGridEvents, ITekGridExportConfig } from './interfaces';
+import { IGroupedData, IModalFilterProps, ITekGrid, ITekGridColumn, ITekGridEvents, ITekGridExportConfig, ITekGridGroup, ITekGridGroupFooter } from './interfaces';
 import { TekGridLayoutOptions } from './layout-options';
 export declare class TekGrid extends GridEditable implements ITekGrid {
     title: string;
@@ -22,6 +22,10 @@ export declare class TekGrid extends GridEditable implements ITekGrid {
      * @public
      */
     dragColumns: boolean;
+    /**
+     * Components that will be rendered on toolbar slot
+     */
+    toolbarConfig: (IComponentRender | string)[];
     /**
      * Enables column resizing
      * @public
@@ -65,8 +69,8 @@ export declare class TekGrid extends GridEditable implements ITekGrid {
     groupColumnNames: string[];
     summaryColumns: TekGridColumn[];
     groupColumns: TekGridColumn[];
-    groupedData: IGroupedData[];
     private toolbarSlotProps;
+    groupedData: IGroupedData[];
     viewUpdateScrollData?: () => void;
     private gridBase;
     filterRelationsDatasource: Datasource;
@@ -129,12 +133,39 @@ export declare class TekGrid extends GridEditable implements ITekGrid {
     private initSummaryColumns;
     private addGroupHeader;
     private addGroupFooters;
+    /**
+     * Creates a group footer, calculating its summary data
+     * @param group Group to which this footer is related
+     * @param groupIndex Index of the group
+     * @returns new group footer
+     */
+    getGroupFooter(group: ITekGridGroup, groupIndex: number): ITekGridGroupFooter;
+    /**
+     * Gets all of the group headers that belong to the group at the specified index
+     * This method should be called only during the groups creation process because it depends on the
+     * group creation order (because it accesses lastGroupHeaderRow that changes during the creation process)
+     * @param groupIndex
+     * @returns
+     */
+    private getGroupHeaders;
+    /**
+     * Updates all footers summary data and the summary total
+     */
+    updateSummary(): void;
+    /**
+     * Takes a group footer and updates its summary data
+     */
+    private updateGroupFooterSummary;
+    /**
+     * Updates the total summary data
+     */
+    private updateSummaryTotal;
     private resetFooterVariables;
     private isUndefined;
     private calcSummaryValues;
     private calcSummary;
-    private addSummary;
-    private summaryData;
+    private getSummary;
+    private getSummaryData;
     openGroup(group: IDictionary<any>): void;
     isItemVisible(row: IDictionary<any>): any;
     private getGroupValue;
@@ -172,7 +203,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): import("@zeedhi/common").Input[];
+    getFilterInputs(columnName?: string): Input[];
     isColumnSearchable(column: TekGridColumn): boolean;
     getColumn(name: string): TekGridColumn;
     /**
@@ -214,8 +245,21 @@ export declare class TekGrid extends GridEditable implements ITekGrid {
      * Checks if a row is a group header, adding typescript type-checking
      */
     private isGroupHeader;
+    /**
+     * Checks if a row is a group footer, adding typescript type-checking
+     */
+    private isGroupFooter;
+    /**
+     * Checks if a row is a summary, adding typescript type-checking
+     */
+    private isGroupSummary;
     /**
      * Checks if a row is the last grouping of the grid (the most internal grouping)
      */
     private isLastGrouping;
+    /**
+     * change event of editable components
+     * - override to call updateSummary on change
+     */
+    protected changeEditableComponent(column: IGridColumnEditable, row: IDictionary<any>, value: any, component?: Input): void;
 }

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

@@ -184,16 +184,18 @@ export interface ITekGridGroupFooter {
     groupHeaders: ITekGridGroupHeader[];
     groupLabel: string;
     groupValue: any;
+    [key: string]: any;
 }
+export declare type ITekGridSummaryTotal = ITekGridGroupFooter & {
+    [key: string]: any;
+};
 export declare type IGroupedData = (ITekGridGroupHeader & {
     [key: string]: any;
 }) | {
     [key: string]: any;
     groupFooter: boolean;
     groupSummary: boolean;
-} | (ITekGridGroupFooter & {
-    [key: string]: any;
-}) | {
+} | ITekGridSummaryTotal | {
     [key: string]: any;
     groupHeaders: ITekGridGroupHeader[];
 };

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

@@ -8,6 +8,10 @@ import { TekGridLayoutOptions } from '..';
 export declare class TekTreeGrid extends TreeGridEditable implements ITekTreeGrid {
     title: string;
     addButton: boolean;
+    /**
+     * Components that will be rendered on toolbar slot
+     */
+    toolbarConfig: (IComponentRender | string)[];
     showEditButtons: boolean;
     deleteButton: 'none' | 'currentRow' | 'selection';
     actions: IComponentRender[];
@@ -55,11 +59,11 @@ export declare class TekTreeGrid extends TreeGridEditable implements ITekTreeGri
      * Export config
      */
     exportConfig: ITekGridExportConfig[];
+    private toolbarSlotProps;
     /**
      * Actions to overwrite the default export config
      */
     exportActions?: IComponentRender[];
-    private toolbarSlotProps;
     private gridBase;
     filterRelationsDatasource: Datasource;
     filterOperationsDatasource: Datasource;

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

@@ -1,5 +1,4 @@
 import { IComponentRender } from '@zeedhi/common';
-import { IEventParam } from '@zeedhi/core';
 import { TekGrid, TekGridFilterButton, TekTreeGrid } from '../../components';
 export interface ITekGridAtoms {
     TITLE: string;
@@ -23,237 +22,21 @@ export interface ITekGridAtoms {
 export declare class GridBase {
     private grid;
     private exportConfigButtons;
+    private defaultToolbar;
     constructor(grid: TekGrid | TekTreeGrid);
     private getOption;
     private getExportConfigButtons;
-    createToolbarProps(): ({
-        name: string;
-        component: string;
-        cssClass: string;
-        tag: string;
-        text: string;
-        title: string;
-        label?: undefined;
-        bottom?: undefined;
-        children?: undefined;
-        cssStyle?: undefined;
-        isVisible?: undefined;
-    } | {
-        name: string;
-        component: string;
-        label: string;
-        bottom: boolean;
-        children: {
-            name: string;
-            component: string;
-            iconName: string;
-            isVisible: string;
-            cssClass: string;
-            events: {
-                click: ({ event }: IEventParam<any>) => void;
-            };
-        }[];
-        cssClass?: undefined;
-        tag?: undefined;
-        text?: undefined;
-        title?: undefined;
-        cssStyle?: undefined;
-        isVisible?: undefined;
-    } | {
-        name: string;
-        component: string;
-        tag: string;
-        cssStyle: string;
-        isVisible: string;
-        children: ({
-            name: string;
-            component: string;
-            tag: string;
-            cssStyle: string;
-            isVisible: string;
-            children: ({
-                name: string;
-                component: string;
-                label: string;
-                bottom: boolean;
-                children: {
-                    name: string;
-                    component: string;
-                    icon: boolean;
-                    iconName: string;
-                    isVisible: string;
-                    events: {
-                        click: ({ event }: IEventParam<any>) => void;
-                    };
-                }[];
-                cssClass?: undefined;
-                vertical?: undefined;
-                isVisible?: undefined;
-                offsetY?: undefined;
-                activator?: undefined;
-            } | {
-                name: string;
-                component: string;
-                label: string;
-                bottom: boolean;
-                children: {
-                    name: string;
-                    component: string;
-                    icon: boolean;
-                    iconName: string;
-                    isVisible: string;
-                    disabled: string;
-                    events: {
-                        click: ({ event }: IEventParam<any>) => void;
-                    };
-                }[];
-                cssClass?: undefined;
-                vertical?: undefined;
-                isVisible?: undefined;
-                offsetY?: undefined;
-                activator?: undefined;
-            } | {
-                name: string;
-                component: string;
-                cssClass: string;
-                vertical: boolean;
-                isVisible: string;
-                label?: undefined;
-                bottom?: undefined;
-                children?: undefined;
-                offsetY?: undefined;
-                activator?: undefined;
-            } | {
-                name: string;
-                component: string;
-                label: string;
-                bottom: boolean;
-                children: {
-                    name: string;
-                    component: string;
-                    isVisible: string;
-                    iterableComponentName: string;
-                    hideGroups: boolean;
-                    ignoreColumns: string;
-                }[];
-                cssClass?: undefined;
-                vertical?: undefined;
-                isVisible?: undefined;
-                offsetY?: undefined;
-                activator?: undefined;
-            } | {
-                name: string;
-                component: string;
-                isVisible: string;
-                label?: undefined;
-                bottom?: undefined;
-                children?: undefined;
-                cssClass?: undefined;
-                vertical?: undefined;
-                offsetY?: undefined;
-                activator?: undefined;
-            } | {
-                name: string;
-                component: string;
-                cssClass: string;
-                offsetY: boolean;
-                activator: {
-                    name: string;
-                    component: string;
-                    icon: boolean;
-                    iconName: string;
-                    isVisible: string;
-                };
-                children: IComponentRender[];
-                label?: undefined;
-                bottom?: undefined;
-                vertical?: undefined;
-                isVisible?: undefined;
-            })[];
-            label?: undefined;
-            small?: undefined;
-            events?: undefined;
-            outline?: undefined;
-            cssClass?: undefined;
-            iterableComponentName?: undefined;
-            bottom?: undefined;
-        } | {
-            name: string;
-            component: string;
-            label: string;
-            isVisible: string;
-            small: boolean;
-            events: {
-                click: ({ event }: IEventParam<any>) => void;
-            };
-            tag?: undefined;
-            cssStyle?: undefined;
-            children?: undefined;
-            outline?: undefined;
-            cssClass?: undefined;
-            iterableComponentName?: undefined;
-            bottom?: undefined;
-        } | {
-            name: string;
-            component: string;
-            label: string;
-            outline: boolean;
-            cssClass: string;
-            isVisible: string;
-            small: boolean;
-            events: {
-                click: ({ event }: IEventParam<any>) => void;
-            };
-            tag?: undefined;
-            cssStyle?: undefined;
-            children?: undefined;
-            iterableComponentName?: undefined;
-            bottom?: undefined;
-        } | {
-            name: string;
-            component: string;
-            cssClass: string;
-            iterableComponentName: string;
-            isVisible: string;
-            tag?: undefined;
-            cssStyle?: undefined;
-            children?: undefined;
-            label?: undefined;
-            small?: undefined;
-            events?: undefined;
-            outline?: undefined;
-            bottom?: undefined;
-        } | {
-            name: string;
-            component: string;
-            label: string;
-            bottom: boolean;
-            children: {
-                name: string;
-                component: string;
-                grid: TekGrid | TekTreeGrid;
-                gridName: string;
-                showCheckboxAll: boolean;
-                isVisible: string;
-                events: {
-                    onCreated: ({ component }: IEventParam<TekGridFilterButton>) => void;
-                };
-            }[];
-            tag?: undefined;
-            cssStyle?: undefined;
-            isVisible?: undefined;
-            small?: undefined;
-            events?: undefined;
-            outline?: undefined;
-            cssClass?: undefined;
-            iterableComponentName?: undefined;
-        })[];
-        cssClass?: undefined;
-        text?: undefined;
-        title?: undefined;
-        label?: undefined;
-        bottom?: undefined;
-    })[];
+    private initializeDefaultToolbarItems;
+    private processUserToolbarItems;
+    /**
+     * Adiciona os itens padrão da toolbar quando nenhuma configuração é fornecida.
+     * @param toolbarDivChildren Array para adicionar os componentes da toolbar.
+     */
+    private addDefaultToolbarItems;
+    /**
+     * Cria os componentes que serão renderizados na toolbar do grid.
+     */
+    createToolbarProps(): IComponentRender[];
     filterButton?: TekGridFilterButton;
     private loadFilterButton;
     private hideButtonClick;

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

@@ -15,15 +15,13 @@ export declare class GridController {
     get toolbarStyle(): string;
     get tooltipName(): "TEKGRID_SHOW" | "TEKGRID_HIDE";
     get showReloadButton(): boolean;
-    get showDivider2(): boolean | undefined;
     get showColumnsButton(): boolean;
     get columnsButtonIgnore(): string[];
     get showLayoutOptionsButton(): boolean;
-    get showDivider1(): boolean | undefined;
+    get showDivider(): boolean;
     get showActionsButton(): boolean;
     get showExportButton(): boolean;
     get showActionAndExportButton(): boolean | undefined;
-    get showDivider3(): boolean | undefined;
     get isEditing(): boolean;
     get showEditButtons(): boolean;
     get isNotEditing(): boolean;

package/types/components/tek-ag-grid/default-icons.d.ts

@@ -1,53 +0,0 @@
-declare const defaultIcons: {
-    columnGroupOpened: string;
-    columnGroupClosed: string;
-    columnSelectClosed: string;
-    columnSelectOpen: string;
-    columnSelectIndeterminate: string;
-    columnMovePin: string;
-    columnMoveHide: string;
-    columnMoveMove: string;
-    columnMoveLeft: string;
-    columnMoveRight: string;
-    columnMoveGroup: string;
-    columnMoveValue: string;
-    dropNotAllowed: string;
-    groupContracted: string;
-    groupExpanded: string;
-    chart: string;
-    close: string;
-    cancel: string;
-    check: string;
-    first: string;
-    previous: string;
-    next: string;
-    last: string;
-    linked: string;
-    unlinked: string;
-    colorPicker: string;
-    groupLoading: string;
-    menu: string;
-    filter: string;
-    columns: string;
-    maximize: string;
-    minimize: string;
-    menuPin: string;
-    menuValue: string;
-    menuAddRowGroup: string;
-    menuRemoveRowGroup: string;
-    clipboardCopy: string;
-    clipboardPaste: string;
-    rowGroupPanel: string;
-    valuePanel: string;
-    columnDrag: string;
-    rowDrag: string;
-    save: string;
-    smallDown: string;
-    smallLeft: string;
-    smallRight: string;
-    smallUp: string;
-    sortAscending: string;
-    sortDescending: string;
-    sortUnSort: string;
-};
-export default defaultIcons;

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

@@ -1,9 +0,0 @@
-import { IIterable } from '@zeedhi/common';
-import { IDictionary } from '@zeedhi/core';
-export interface ITekAgGrid extends IIterable {
-    dense?: boolean;
-    frameworkComponents?: IDictionary;
-    gridOptions?: IDictionary;
-    height?: string | number;
-    icons?: IDictionary<string>;
-}

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

@@ -1,35 +0,0 @@
-import { Iterable } from '@zeedhi/common';
-import { IDictionary } from '@zeedhi/core';
-import { ITekAgGrid } from './interfaces';
-/** Grid Component */
-export declare class TekAgGrid extends Iterable implements ITekAgGrid {
-    cssClass: string;
-    dense: boolean;
-    frameworkComponents: IDictionary;
-    gridOptions: IDictionary;
-    height: string | number;
-    icons: IDictionary<string>;
-    gridComponent: any;
-    /**
-     * Creates a new AgGrid.
-     * @param props AgGrid properties
-     */
-    constructor(props: ITekAgGrid);
-    private createOptionsAccessors;
-    private setAccessor;
-    /**
-     * Reload dataset
-     */
-    reload(): Promise<any>;
-    /**
-     * Compares two dates
-     * @param date1
-     * @param date2
-     * @param format
-     * @returns -1 if date1 after date2
-     * @returns 0 if date1 equal date2
-     * @returns 1 if date1 before date2
-     */
-    dateComparator(date1: string | Date, date2: string | Date, format?: string): 1 | -1 | 0;
-    private getDateAsString;
-}

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

@@ -1,94 +0,0 @@
-import { IDatasource, IDictionary, RestDatasource } from '@zeedhi/core';
-import { IDynamicFilterItem, ITekRestDatasource } from './interfaces';
-export declare class TekRestDatasource extends RestDatasource implements ITekRestDatasource {
-    /** Dynamic filter data */
-    dynamicFilter: IDictionary<IDynamicFilterItem[]>;
-    /** Search Join data */
-    searchJoin: IDictionary<Array<string | number>>;
-    /**
-     * URL reserved keys
-     */
-    protected reservedKeys: IDictionary<boolean>;
-    /**
-     * Dynamic Filter Operations
-     */
-    dynamicFilterOperations: IDictionary<boolean>;
-    /**
-     * Dynamic Filter Relations
-     */
-    dynamicFilterRelations: IDictionary<boolean>;
-    /**
-     * Dynamic Filter applied flag
-     */
-    protected dynamicFilterApplied: string;
-    /**
-     * Create new datasource
-     * @param props Datasource properties
-     */
-    constructor(props: ITekRestDatasource);
-    protected updateInternalProperties(datasource?: IDatasource): void;
-    protected getEncodedParam(urlParam: string, datasourceParam?: IDictionary<any>): IDictionary<any>;
-    protected getQueryStringValues(): IDictionary<any>;
-    protected getUrlQueryString(): string;
-    /**
-     * 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>;
-    /**
-     * Removes a dynamic filter position
-     * @param column Dynamic Filter column name
-     * @returns Promise with data collection
-     */
-    removeDynamicFilter(column: string): Promise<any>;
-    /**
-     * Sets new dynamic filter value
-     * @param filter Dynamic Filter value
-     * @returns Promise with data collection
-     */
-    setDynamicFilter(filter: IDictionary<any>): Promise<any>;
-    /**
-     * Clears Dynamic filter value
-     * @returns Promise with data collection
-     */
-    clearDynamicFilter(): Promise<any>;
-    /**
-     * Resets page and selected rows and tries to update the url
-     * @returns Promise with data collection
-     */
-    protected updateDynamicFilter(): Promise<any>;
-    /**
-     * Checks if a filter value is valid
-     * @param value Filter value
-     * @returns Is valid filter value
-     */
-    protected isValidDynamicFilterValue(column: string, value?: IDictionary<any>[]): boolean | undefined;
-    /**
-     * Retrieves request params
-     */
-    protected getRequestParams(): any;
-    clone(): {
-        dynamicFilter: IDictionary<IDynamicFilterItem[]>;
-        searchJoin: IDictionary<(string | number)[]>;
-        type: string;
-        route?: string | undefined;
-        lazyLoad?: boolean | undefined;
-        arrayFormat?: "indices" | "brackets" | "repeat" | "comma" | undefined;
-        find?: IDictionary<any> | undefined;
-        currentRow?: IDictionary<any> | undefined;
-        data?: IDictionary<any>[] | undefined;
-        filter?: IDictionary<any> | undefined;
-        limit?: string | number | undefined;
-        loadAll?: boolean | undefined;
-        loading?: boolean | undefined;
-        order?: string[] | undefined;
-        page?: string | number | undefined;
-        search?: string | undefined;
-        searchIn?: string[] | undefined;
-        uniqueKey?: string | undefined;
-        watchUrl?: boolean | undefined;
-        events?: import("@zeedhi/core").IDatasourceEvents<import("@zeedhi/core").IEventParam<any>> | undefined;
-    };
-}

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

@@ -1,53 +0,0 @@
-declare const defaultIcons: {
-    columnGroupOpened: string;
-    columnGroupClosed: string;
-    columnSelectClosed: string;
-    columnSelectOpen: string;
-    columnSelectIndeterminate: string;
-    columnMovePin: string;
-    columnMoveHide: string;
-    columnMoveMove: string;
-    columnMoveLeft: string;
-    columnMoveRight: string;
-    columnMoveGroup: string;
-    columnMoveValue: string;
-    dropNotAllowed: string;
-    groupContracted: string;
-    groupExpanded: string;
-    chart: string;
-    close: string;
-    cancel: string;
-    check: string;
-    first: string;
-    previous: string;
-    next: string;
-    last: string;
-    linked: string;
-    unlinked: string;
-    colorPicker: string;
-    groupLoading: string;
-    menu: string;
-    filter: string;
-    columns: string;
-    maximize: string;
-    minimize: string;
-    menuPin: string;
-    menuValue: string;
-    menuAddRowGroup: string;
-    menuRemoveRowGroup: string;
-    clipboardCopy: string;
-    clipboardPaste: string;
-    rowGroupPanel: string;
-    valuePanel: string;
-    columnDrag: string;
-    rowDrag: string;
-    save: string;
-    smallDown: string;
-    smallLeft: string;
-    smallRight: string;
-    smallUp: string;
-    sortAscending: string;
-    sortDescending: string;
-    sortUnSort: string;
-};
-export default defaultIcons;

package/types/components/tek-grid/filter-dynamic-values.d.ts

@@ -1,9 +0,0 @@
-import { TekGridColumn } from '..';
-export declare class TekFilterDynamicValues {
-    private static values;
-    private static formatDate;
-    static getLabel(name: string): string;
-    static getValue(name: string, column: TekGridColumn): string | string[];
-    static register(name: string, label: string, fn: () => Date | [Date, Date]): void;
-    static unregister(name: string): void;
-}