@zeedhi/teknisa-components-common 1.117.1 → 3.0.1

package/{types/utils/grid-base → dist/types/components/tek-grid/tek-grid-toolbar-provider}/export-options/button-option.d.ts

@@ -1,16 +1,17 @@
-import { ITekGridExportConfig, TekGrid, TekTreeGrid } from '../../../components';
-import { IExportOption } from './interfaces';
-export declare class ButtonOption implements IExportOption {
-    private config;
-    constructor(config: ITekGridExportConfig);
-    buildComponent(grid: TekGrid | TekTreeGrid): {
-        label: string | undefined;
-        iconName: string | undefined;
-        name: string;
-        component: string;
-        flat: boolean;
-        events: {
-            click: () => any;
-        };
-    };
-}
+import { IComponent } from '@zeedhi/common';
+import { IExportable, ITekGridExportConfig } from '../../interfaces';
+import { IExportOption } from './interfaces';
+export declare class ButtonOption implements IExportOption {
+    private config;
+    constructor(config: ITekGridExportConfig);
+    buildComponent(grid: IComponent & IExportable): {
+        label: string | undefined;
+        iconName: string | undefined;
+        name: string;
+        component: string;
+        flat: boolean;
+        events: {
+            click: () => any;
+        };
+    };
+}

package/{types/utils/grid-base → dist/types/components/tek-grid/tek-grid-toolbar-provider}/export-options/index.d.ts

@@ -1,3 +1,3 @@
-export * from './button-option';
-export * from './multi-option';
-export * from './interfaces';
+export * from './button-option';
+export * from './multi-option';
+export * from './interfaces';

package/dist/types/components/tek-grid/tek-grid-toolbar-provider/export-options/interfaces.d.ts

@@ -0,0 +1,5 @@
+import { IComponent, IComponentRender } from '@zeedhi/common';
+import { IExportable } from '../../interfaces';
+export interface IExportOption {
+    buildComponent: (grid: IComponent & IExportable) => IComponentRender;
+}

package/{types/utils/grid-base → dist/types/components/tek-grid/tek-grid-toolbar-provider}/export-options/multi-option.d.ts

@@ -1,12 +1,12 @@
-import { IRow } from '@zeedhi/common';
-import { ITekGridExportConfig, TekGrid, TekTreeGrid } from '../../../components';
-import { IExportOption } from './interfaces';
-export declare class MultiOption implements IExportOption {
-    private config;
-    constructor(config: ITekGridExportConfig);
-    private formatName;
-    private buildTooltip;
-    private buildButton;
-    private buildDivider;
-    buildComponent(grid: TekGrid | TekTreeGrid): IRow;
-}
+import { IComponent, IRow } from '@zeedhi/common';
+import { IExportable, ITekGridExportConfig } from '../../interfaces';
+import { IExportOption } from './interfaces';
+export declare class MultiOption implements IExportOption {
+    private config;
+    constructor(config: ITekGridExportConfig);
+    private formatName;
+    private buildTooltip;
+    private buildButton;
+    private buildDivider;
+    buildComponent(grid: IComponent & IExportable): IRow;
+}

package/dist/types/components/tek-grid/tek-grid-toolbar-provider/index.d.ts

@@ -0,0 +1,2 @@
+export * from './export-options';
+export * from './tek-grid-toolbar-provider';

package/dist/types/components/tek-grid/tek-grid-toolbar-provider/tek-grid-toolbar-provider.d.ts

@@ -0,0 +1,22 @@
+import { IEventParam } from '@zeedhi/core';
+import { IComponentRender, IGridEditable } from '@zeedhi/common';
+import { IExportable, ISupportsToolbar, ITekGridAtoms, ITekGridToolbarProvider } from '../interfaces';
+type GridEditableWithToolbar = IGridEditable & ISupportsToolbar & IExportable;
+export declare class TekGridToolbarProvider implements ITekGridToolbarProvider {
+    private grid;
+    private groupsVisibility;
+    constructor(grid: GridEditableWithToolbar, groupsVisibility: 'hide' | 'show');
+    protected atoms: ITekGridAtoms;
+    getAtomName(key: keyof ITekGridAtoms): string;
+    getAtomInstance<T>(key: keyof ITekGridAtoms): T;
+    private getOption;
+    private getExportConfigButtons;
+    private hideButtonClick;
+    private cancelChanges;
+    private saveChanges;
+    private addButtonClick;
+    private deleteButtonClick;
+    reloadGrid({ event }: IEventParam<any>): void;
+    getProperties(): IComponentRender[];
+}
+export {};

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

@@ -0,0 +1,216 @@
+import { Datasource, IDictionary, IEventParam } from '@zeedhi/core';
+import { Direction, IGrid, VerticalDirection, IComponent, IComponentRender, IGridColumnEditable, IGridEditable, Iterable, IIterableProps } from '@zeedhi/common';
+import { IModalFilterProps, ITekGrid, ITekGridAtoms, ITekGridColumn, ITekGridExportConfig, ITekGridProps, ITekGridSummary } from './interfaces';
+import { TekGridColumn } from './tek-grid-column';
+export declare class TekGrid extends Iterable<TekGridColumn> implements ITekGrid {
+    private tableActionBuilder;
+    private iterableTable;
+    private dataSelector;
+    private tekGridEvents;
+    private dataNavigator;
+    private groupedViewNavigator;
+    private keyMapMerger;
+    private dataEditor;
+    private columnsSearcher;
+    private groupedDataManager;
+    private tekGridToolbarProvider;
+    title: string;
+    addButton: boolean;
+    deleteButton: 'none' | 'currentRow' | 'selection';
+    actions: IComponentRender[];
+    showEditButtons: boolean;
+    filterButton: boolean;
+    showSearch: boolean;
+    columnFilterButton: boolean;
+    columnsButton: boolean;
+    mainGrid: boolean;
+    columnsButtonIgnore: string[];
+    /**
+     * Enables column dragging
+     * @public
+     */
+    dragColumns: boolean;
+    /**
+     * Enables column resizing
+     * @public
+     */
+    resizeColumns: boolean;
+    /**
+     * Enables layout saving
+     * @public
+     */
+    showLayoutOptions: boolean;
+    xlsDefaultType?: string;
+    modalFilterProps: IModalFilterProps;
+    /**
+     * Show export button
+     */
+    showExport: boolean;
+    /**
+     * Show refresh button
+     */
+    showReload: boolean;
+    /**
+     * Export config
+     */
+    exportConfig: ITekGridExportConfig[];
+    /**
+     * Actions to overwrite the default export config
+     */
+    exportActions?: IComponentRender[];
+    /**
+     * Groups should be opened by default after building
+     */
+    groupsOpened: boolean;
+    /**
+     * Show Total summary
+     */
+    showSummaryTotal: boolean;
+    editNewRowsOnly: boolean;
+    protected keyShortcutKeyMapping: any;
+    showCheckboxAllFilter: boolean;
+    defaultFilter: IDictionary;
+    toolbarOpened: boolean;
+    reportTitle: string;
+    editing: boolean;
+    currentColumn: TekGridColumn | null;
+    selectedRows: IDictionary<any>[];
+    selectionState: {
+        allSelected: boolean;
+        except: IDictionary<any>[];
+    };
+    rowStyleConditions?: (row: IDictionary) => IDictionary;
+    selectAllPages: boolean;
+    selectable: boolean;
+    disableSelection?: (args: {
+        row: IDictionary<any>;
+        component: IGrid;
+    }) => boolean;
+    cellSelection: boolean;
+    toolbarSlot: IComponentRender[];
+    footerSlot: IComponentRender[];
+    noResultsText: string;
+    noResultSlot: IComponentRender[];
+    errorSlot: IComponentRender[];
+    dense: boolean;
+    headerBackground: string;
+    headerCellTextColor: string;
+    height: string | number;
+    loadingText: string;
+    maxHeight: string | number;
+    maxWidth: string | number;
+    minHeight: string | number;
+    minWidth: string | number;
+    noDataText: string;
+    noDataSlot: IComponentRender[];
+    showFooter: boolean;
+    showHeader: boolean;
+    showSelectAll: boolean;
+    width: string | number;
+    backgroundColor: string;
+    canEditRow?: ((args: {
+        row: IDictionary<any>;
+        component: IGridEditable;
+    }) => boolean) | undefined;
+    showCancelColumn: boolean;
+    doubleClickEdit: boolean;
+    singleEdit: boolean;
+    editingNewRows: boolean;
+    private defaultLazy;
+    private toolbarSlotProps;
+    filterRelationsDatasource?: Datasource;
+    filterOperationsDatasource?: Datasource;
+    /**
+     * TekGrid class constructor
+     * @param props TekGrid properties
+     */
+    constructor(props: ITekGridProps);
+    protected initializeDatasource(props: IIterableProps): void;
+    columnHasFilter(columnName: string): boolean;
+    registerTask(task: Promise<any>): void;
+    loadAfterTasks(): Promise<void>;
+    calcSummary(column: TekGridColumn, columnNamesummary: ITekGridSummary, row: IDictionary): void;
+    private getDefaultLazy;
+    initializeGrouping(lazyLoad: boolean): void;
+    updateGrouping(): void;
+    updateGroupedData(lazyLoad: boolean): Promise<void>;
+    buildGroupedData(): void;
+    openGroup(group: IDictionary<any>): void;
+    isItemVisible(row: IDictionary<any>): any;
+    isGrouped(): boolean;
+    isColumnSearchable(column: TekGridColumn): boolean;
+    getGroupedData(): IDictionary<any>[];
+    directionalLeft(param: IEventParam<any>): void;
+    directionalRight(param: IEventParam<any>): void;
+    getReport(): Promise<Window | null>;
+    setViewUpdateFixedColumns(fn: () => void): void;
+    setViewUpdateScrollData(fn: () => void): void;
+    onCreated(): void;
+    private createDynamicFilterDatasources;
+    onMounted(element: HTMLElement): void;
+    onBeforeDestroy(): void;
+    createColumn(column: ITekGridColumn): TekGridColumn;
+    getConditionalProps({ row, column }: {
+        row: IDictionary;
+        column: TekGridColumn;
+    }): Partial<IComponentRender>;
+    changeOrder(sortBy: {
+        key: string;
+        order: 'asc' | 'desc';
+    }[]): Promise<void>;
+    selectCell(row: IDictionary, column: TekGridColumn): void;
+    reapplyRowStyleConditions(row: IDictionary): IDictionary;
+    getRowStyleConditions(row: IDictionary): IDictionary;
+    deleteRows(): Promise<any[]>;
+    selectAll(isSelected: boolean): void;
+    toggleRow(row: IDictionary): void;
+    selectRow(row: IDictionary, select: boolean): void;
+    callDisableSelection(row: IDictionary): boolean;
+    selectClick(row: IDictionary<any>, isSelected: boolean, event: Event, element?: HTMLElement): void;
+    selectAllClick(isSelected: boolean, event: Event, element?: HTMLElement): void;
+    navigatePageUp(): void;
+    navigatePageDown(): void;
+    setViewNavigate(viewNavigate: (direction: Direction, event?: Event) => void): void;
+    navigateLeft(params: IEventParam<any>): void;
+    navigateRight(params: IEventParam<any>): void;
+    navigateUp(): void;
+    navigateDown(): void;
+    navigateDatasource(direction: VerticalDirection): void;
+    getActionComponent(actionComponent: IComponent, column: TekGridColumn, row: IDictionary, parentPath?: string): IComponent;
+    addCancelColumn(): void;
+    getCancelColumnProps(): IGridColumnEditable;
+    isAdded(row: IDictionary): boolean;
+    cancelAddedRow(key: string | number): Promise<any>;
+    cancelAddedRows(): Promise<void>;
+    getAddedRows(): IDictionary<any>[];
+    addNewRow(row: IDictionary, position?: 'end' | 'start'): Promise<void>;
+    getVisibleValue(row: IDictionary, column: ITekGridColumn): any;
+    getEditableComponent(column: ITekGridColumn, row: IDictionary<any>): IComponentRender;
+    isEdited(column: ITekGridColumn, row: IDictionary): boolean;
+    isValid(column: ITekGridColumn, row: IDictionary, revalidate?: boolean): Promise<boolean>;
+    checkValid(column: ITekGridColumn, row: IDictionary): boolean;
+    isGridValid(revalidate?: boolean): boolean;
+    getComponent<T>(key: string, columnName: string): T;
+    updateRow(newRow: IDictionary): void;
+    updateCell(rowKey: string, columnName: string, value: any): void;
+    setViewEnterEdit(fn: ((rowKey: string, columnName: string) => void) | null): void;
+    enterEdit(rowKey: string, columnName: string): void;
+    cancelEditedRows(): Promise<void>;
+    saveEditedRows(revalidate?: boolean): Promise<void[]>;
+    reapplyCanEditRow(row: IDictionary<any>): void;
+    getCanEditRow(row: IDictionary<any>): boolean | undefined;
+    getEditedRows(revalidate?: boolean, silent?: boolean): IDictionary<any>[];
+    getEditedRow(row: IDictionary): IDictionary | undefined;
+    rowClick(row: IDictionary<any>, event: Event, element?: HTMLElement): void;
+    rowDoubleClick(row: IDictionary<any>, event: Event, element?: HTMLElement): void;
+    cellDoubleClick(row: IDictionary<any>, column: TekGridColumn, event: Event, element?: HTMLElement): void;
+    inlineEdit(row: IDictionary, column: TekGridColumn, event?: Event, element?: HTMLElement): void;
+    cellClick(row: IDictionary<any>, column: TekGridColumn, event: Event, element?: HTMLElement): void;
+    cellClickEvent(row: IDictionary<any>, column: TekGridColumn, event: Event, element?: HTMLElement): void;
+    groupRowClick(row: IDictionary<any>, event: Event, element?: HTMLElement): void;
+    groupRowDoubleClick(row: IDictionary<any>, event: Event, element?: HTMLElement): void;
+    selectGroupClick(row: IDictionary<any>, isSelected: boolean, event: Event, element?: HTMLElement): void;
+    setSearch(search: string): Promise<any>;
+    getAtomInstance<T>(key: keyof ITekGridAtoms): T;
+    getAtomName(key: keyof ITekGridAtoms): string;
+}

package/{types → dist/types}/components/tek-user-info/TekUserInfoController.d.ts

@@ -1,21 +1,22 @@
-import { TekUserInfo } from './tek-user-info';
-export declare class TekUserInfoController {
-    component: TekUserInfo;
-    get versionInfo(): import("./interfaces").IVersionInfo | null;
-    constructor(component: TekUserInfo);
-    get name(): string;
-    set name(value: string);
-    get version(): string;
-    set version(value: string);
-    get hasDefaultEmail(): boolean;
-    get hasAboutImage(): boolean;
-    mergeText(name: string, version: string): string;
-    get mainVersion(): string;
-    protected getItems(tab: 'frontend' | 'backend' | 'modules'): string | never[];
-    get frontendItems(): string | never[];
-    get backendItems(): string | never[];
-    get modulesItems(): string | never[];
-    get showReportError(): boolean;
-    get showVersionInfo(): boolean;
-    get showAbout(): boolean;
-}
+import { TekUserInfo } from './tek-user-info';
+declare class TekUserInfoController {
+    component: TekUserInfo;
+    get versionInfo(): import("./interfaces").IVersionInfo | null;
+    constructor(component: TekUserInfo);
+    get name(): string;
+    set name(value: string);
+    get version(): string;
+    set version(value: string);
+    get hasDefaultEmail(): boolean;
+    get hasAboutImage(): boolean;
+    mergeText(name: string, version: string): string;
+    get mainVersion(): string;
+    protected getItems(tab: 'frontend' | 'backend' | 'modules'): string | never[];
+    get frontendItems(): string | never[];
+    get backendItems(): string | never[];
+    get modulesItems(): string | never[];
+    get showReportError(): boolean;
+    get showVersionInfo(): boolean;
+    get showAbout(): boolean;
+}
+export { TekUserInfoController };

package/{types → dist/types}/components/tek-user-info/interfaces.d.ts

@@ -1,28 +1,27 @@
-import { IList } from '@zeedhi/common';
-import { IUserInfo } from '@zeedhi/zd-user-info-common';
-export interface IVersionInfo {
-    name: string;
-    version: string;
-    frontend: {
-        name: string;
-        version: string;
-    }[];
-    backend: {
-        name: string;
-        version: string;
-    }[];
-    modules: {
-        name: string;
-        version: string;
-    }[];
-}
-export interface ITekUserInfo extends IUserInfo {
-    aboutImage?: string;
-    defaultEmail?: string;
-    versionInfo?: IVersionInfo | null;
-    versionUrl?: string;
-    aboutModalHeaderHeight?: number | string;
-}
-export interface ITekUserInfoList extends IList {
-    parentName?: string;
-}
+import { IList } from '@zeedhi/common';
+import { IUserInfo } from '@zeedhi/zd-user-info-common';
+export interface IVersionInfo {
+    name: string;
+    version: string;
+    frontend: {
+        name: string;
+        version: string;
+    }[];
+    backend: {
+        name: string;
+        version: string;
+    }[];
+    modules: {
+        name: string;
+        version: string;
+    }[];
+}
+export interface ITekUserInfo extends IUserInfo {
+    aboutImage?: string;
+    defaultEmail?: string;
+    versionInfo?: IVersionInfo | null;
+    versionUrl?: string;
+}
+export interface ITekUserInfoList extends IList {
+    parentName?: string;
+}

package/{types → dist/types}/components/tek-user-info/tek-user-info-list.d.ts

@@ -1,31 +1,32 @@
-import { List } from '@zeedhi/common';
-import { ITekUserInfo, ITekUserInfoList } from './interfaces';
-export declare class TekUserInfoList extends List implements ITekUserInfoList {
-    /**
-     * Name of the user info component
-     */
-    parentName: string;
-    dense: boolean;
-    constructor(props: ITekUserInfo);
-    protected getItems(): ({
-        name: string;
-        component: string;
-        title: string;
-        subtitle: string;
-        isVisible: string;
-        cssClass: string;
-        prependIcon?: undefined;
-        events?: undefined;
-    } | {
-        name: string;
-        component: string;
-        title: string;
-        prependIcon: string;
-        cssClass: string;
-        isVisible: string;
-        events: {
-            click: () => void;
-        };
-        subtitle?: undefined;
-    })[];
-}
+import { List } from '@zeedhi/common';
+import { ITekUserInfoList } from './interfaces';
+export declare class TekUserInfoList extends List implements ITekUserInfoList {
+    /**
+     * Name of the user info component
+     */
+    parentName: string;
+    dense: boolean;
+    constructor(props: ITekUserInfoList);
+    onCreated(): void;
+    protected getItems(): ({
+        name: string;
+        component: string;
+        title: string;
+        subtitle: string;
+        isVisible: string;
+        cssClass: string;
+        prependIcon?: undefined;
+        events?: undefined;
+    } | {
+        name: string;
+        component: string;
+        title: string;
+        prependIcon: string;
+        cssClass: string;
+        isVisible: string;
+        events: {
+            click: () => void;
+        };
+        subtitle?: undefined;
+    })[];
+}

package/{types → dist/types}/components/tek-user-info/tek-user-info.d.ts

@@ -1,38 +1,37 @@
-import { Button, IComponentRender, Modal } from '@zeedhi/common';
-import { IEventParam } from '@zeedhi/core';
-import { UserInfo } from '@zeedhi/zd-user-info-common';
-import { ITekUserInfo, IVersionInfo } from './interfaces';
-export declare class TekUserInfo extends UserInfo implements ITekUserInfo {
-    aboutModal?: Modal;
-    reportModal?: Modal;
-    /**
-    * Data about the application version
-    */
-    versionInfo: IVersionInfo | null;
-    /**
-    * Default email address to be defined in the Report Bug form
-    */
-    defaultEmail: string;
-    /**
-    * Url from which the version info will be retrieved
-    */
-    versionUrl: string;
-    /**
-    * Path to the image to be shown on about modal
-    */
-    aboutImage: string;
-    aboutModalHeaderHeight: number | string;
-    protected propBottomSlot?: IComponentRender[];
-    constructor(props: ITekUserInfo);
-    protected getBottomSlot(): IComponentRender[];
-    onAboutClick(): void;
-    protected getVersionTree(tab: 'frontend' | 'backend' | 'modules'): {
-        name: string;
-        component: string;
-        text: string;
-    }[];
-    onReportClick(): void;
-    onSendReport({ event, element }: IEventParam<Button>): void;
-    onCreated(): void;
-    onMounted(element: any): Promise<void>;
-}
+import { Button, IComponentRender, Modal } from '@zeedhi/common';
+import { IEventParam } from '@zeedhi/core';
+import { ITekUserInfo, IVersionInfo } from './interfaces';
+import { UserInfo } from '@zeedhi/zd-user-info-common';
+export declare class TekUserInfo extends UserInfo implements ITekUserInfo {
+    aboutModal?: Modal;
+    reportModal?: Modal;
+    /**
+    * Data about the application version
+    */
+    versionInfo: IVersionInfo | null;
+    /**
+    * Default email address to be defined in the Report Bug form
+    */
+    defaultEmail: string;
+    /**
+    * Url from which the version info will be retrieved
+    */
+    versionUrl: string;
+    /**
+    * Path to the image to be shown on about modal
+    */
+    aboutImage: string;
+    protected propBottomSlot?: IComponentRender[];
+    constructor(props: ITekUserInfo);
+    protected getBottomSlot(): IComponentRender[];
+    onAboutClick(): void;
+    protected getVersionTree(tab: 'frontend' | 'backend' | 'modules'): {
+        name: string;
+        component: string;
+        text: string;
+    }[];
+    onReportClick(): void;
+    onSendReport({ event, element }: IEventParam<Button>): Promise<void>;
+    onCreated(): void;
+    onMounted(element: any): Promise<void>;
+}

package/{types → dist/types}/error/delete-rows-error.d.ts

@@ -1,6 +1,6 @@
-/**
- * Delete rows error
- */
-export declare class TekGridDeleteRowsError extends Error {
-    constructor();
-}
+/**
+ * Delete rows error
+ */
+export declare class TekGridDeleteRowsError extends Error {
+    constructor();
+}

package/dist/types/error/tek-grid-delete-rows-error.d.ts

@@ -0,0 +1,7 @@
+import { TeknisaCommonError } from './teknisa-common-error';
+/**
+ * TekGridDelete rows error
+ */
+export declare class TekGridDeleteRowsError extends TeknisaCommonError {
+    constructor();
+}

package/dist/types/error/teknisa-common-error.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Base Teknisa error
+ */
+export declare class TeknisaCommonError extends Error {
+    constructor(message: string);
+}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './components';
+export * from './utils';

package/{types → dist/types}/utils/config/config.d.ts

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

package/dist/types/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './config/config';
+export * from './is-filled-object/is-filled-object';
+export * from './is-nil';

package/dist/types/utils/is-filled-object/is-filled-object.d.ts

@@ -0,0 +1,2 @@
+declare const isFilledObject: (obj: unknown) => obj is object;
+export { isFilledObject };

package/dist/types/utils/is-nil.d.ts

@@ -0,0 +1 @@
+export declare function isNil(value: unknown): value is null | undefined;

package/environments.json

@@ -0,0 +1,14 @@
+{
+  "development": {
+    "devDependencies": {
+      "@zeedhi/common": "file:../../../zeedhi-client-core/packages/common",
+      "@zeedhi/core": "file:../../../zeedhi-client-core/packages/core"
+    }
+  },
+  "production": {
+    "devDependencies": {
+      "@zeedhi/common": "^3.0.0",
+      "@zeedhi/core": "^3.0.0"
+    }
+  }
+}