@zeedhi/teknisa-components-common 1.117.1 → 3.0.1

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

@@ -1,203 +0,0 @@
-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> {
-    layouts: ITekGridLayoutInfo;
-}
-export interface ITekGridCalcSummaryEventParams extends IEventParam<ITekGrid> {
-    summary: ITekGridSummary;
-    columnName: string;
-    rowValue: IDictionary<any>;
-}
-export declare type ITekGridEvent<T> = (event: T) => Promise<any>;
-export interface ITekGridEvents<T = IEventParam<any> | ITekGridLayoutEventParams | ITekGridCalcSummaryEventParams> extends IComponentEvents<T> {
-    addClick?: EventDef<T>;
-    afterCancel?: EventDef<T>;
-    afterDelete?: EventDef<T>;
-    afterSave?: EventDef<T>;
-    beforeApplyFilter?: EventDef<T>;
-    beforeCancel?: EventDef<T>;
-    beforeDelete?: EventDef<T>;
-    beforeSave?: EventDef<T>;
-    calcSummary?: EventDef<T>;
-    filterClick?: EventDef<T>;
-    loadLayouts?: EventDef<T, ITekGridEvent<T>>;
-    saveLayouts?: EventDef<T>;
-    groupRowClick?: EventDef<T>;
-    groupSelect?: EventDef<T>;
-    groupUnselect?: EventDef<T>;
-    beforeOpenReport?: EventDef<T, IBeforeReportEvent>;
-    beforeReload?: EventDef<T>;
-    [key: string]: any;
-}
-export declare type ITekGridLayoutOptionsEvent<T> = (event: T) => Promise<any>;
-export interface ITekGridLayoutOptionsEvents<T = IEventParam<any> | ITekGridLayoutEventParams> extends IComponentEvents<T> {
-    loadLayouts?: ITekGridEvent<T>;
-    saveLayouts?: IEvent<T>;
-    [key: string]: any;
-}
-export interface ITekGrid extends IGridEditable {
-    actions?: IComponentRender[];
-    addButton?: boolean;
-    columnFilterButton?: boolean;
-    columns?: ITekGridColumn[];
-    columnsButton?: boolean;
-    columnsButtonIgnore?: string[];
-    deleteButton?: 'none' | 'currentRow' | 'selection';
-    events?: ITekGridEvents;
-    showEditButtons?: boolean;
-    filterButton?: boolean;
-    modalFilterProps?: IModalFilterProps;
-    showSearch?: boolean;
-    showHideButton?: boolean;
-    showLayoutOptions?: boolean;
-    title?: string;
-    showExport?: boolean;
-    showReload?: boolean;
-    exportConfig?: ITekGridExportConfig[];
-    exportActions?: IComponentRender[];
-    groupsOpened?: boolean;
-    showSummaryTotal?: boolean;
-    layoutOptions?: TekGridLayoutOptions;
-    mainGrid?: boolean;
-    showCheckboxAllFilter?: boolean;
-    defaultFilter?: IDictionary;
-    xlsDefaultType?: string;
-    toolbarOpened?: boolean;
-    reportTitle?: string;
-    reportLabelFormatter?: LabelFormatter;
-}
-export declare type MultiOptionParams = {
-    iconName: string;
-    label: string;
-    cssClass?: string;
-    reportParams?: {
-        portrait?: boolean;
-        rowObj?: any;
-    };
-};
-export interface ITekGridExportConfig {
-    type: string;
-    portrait?: boolean;
-    label?: string;
-    iconName?: string;
-    multiOption?: MultiOptionParams[];
-}
-export interface ITekGridLayoutInfo {
-    currentLayoutName?: string;
-    layouts?: IDictionary<ITekGridLayout>;
-}
-export interface ITekGridLayout {
-    name: string;
-    gridWidth?: string;
-    columns?: ITekGridLayoutColumn[];
-    order?: string[];
-    dynamicFilter?: IDictionary<IDynamicFilterItem[]>;
-    filter?: IDictionary<any>;
-}
-export declare const columnAggregationValues: ["SUM", "MIN", "MAX", "AVG", "COUNT", undefined];
-export declare type ITekGridColumnAggregation = (typeof columnAggregationValues)[number];
-export interface ITekGridLayoutColumn {
-    name: string;
-    width?: string;
-    minWidth?: string;
-    maxWidth?: string;
-    isVisible?: boolean;
-    fixed?: boolean;
-    grouped?: boolean;
-    aggregation?: ITekGridColumnAggregation;
-    label?: string;
-    align?: 'left' | 'right' | 'center';
-    groupOpened?: boolean;
-    filterHelperValue?: string | IDictionary<any>;
-}
-export interface ITekGridLayoutOptions extends IComponentRender {
-    events?: ITekGridLayoutOptionsEvents;
-}
-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';
-export interface IFilterPropsComponent extends IComponent {
-    relation?: IFilterRelation;
-    operation?: IFilterOperation;
-    helperOptions?: string[];
-    helperValue?: string;
-}
-export interface ITekGridColumn extends IGridColumnEditable {
-    filterProps?: IFilterPropsComponent | IFilterPropsComponent[];
-    filterable?: boolean;
-    filterIndex?: number;
-    skipLookupSearch?: boolean;
-    grouped?: boolean;
-    aggregation?: ITekGridColumnAggregation;
-    groupOpened?: boolean;
-    groupLabelForEmptyValue?: string;
-    storeData?: boolean;
-}
-export interface ITekGridColumnsButton extends IIterableColumnsButton {
-    hideGroups?: boolean;
-}
-export interface ITekGridFilterButton extends IButton {
-    gridName?: string;
-    grid?: TekGrid | TekTreeGrid;
-    showCheckboxAll?: boolean;
-}
-export interface ITekGridGroup {
-    column: ITekGridColumn;
-    name: string;
-    label: string;
-    lastValue: any;
-    footer: ITekGridFooter;
-    initialized: boolean;
-    lastGroupHeaderRow?: ITekGridGroupHeader;
-}
-export interface ITekGridGroupHeader {
-    group: boolean;
-    groupRow: IDictionary;
-    groupColumnName: string;
-    groupHeader: boolean;
-    groupIndex: number;
-    groupLabel: string;
-    groupValue: any;
-    groupOpened: boolean;
-    groupHeaders: ITekGridGroupHeader[];
-    children: IDictionary<any>[];
-}
-export interface ITekGridFooter {
-    [key: string]: ITekGridSummary;
-}
-export interface ITekGridSummary {
-    sum: any;
-    avg: any;
-    count: number;
-    min: any;
-    max: any;
-}
-export interface ITekFilterHelperValue extends IDateHelperValue {
-}
-export interface ITekFilterHelperValues extends IDateHelperValues {
-}
-export interface IModalFilterProps extends IModal {
-    height?: string;
-    maxHeight?: string;
-}
-export interface ITekGridGroupFooter {
-    groupFooter: boolean;
-    groupIndex: number;
-    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;
-} | ITekGridSummaryTotal | {
-    [key: string]: any;
-    groupHeaders: ITekGridGroupHeader[];
-};

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

@@ -1,55 +0,0 @@
-import { ComponentRender } from '@zeedhi/common';
-import { IImage } from './interfaces';
-/**
- * Teknisa component
- */
-export declare class Image extends ComponentRender implements IImage {
-    /**
-     * Route path
-     */
-    to: string;
-    /**
-     * Image source.
-     */
-    src: string;
-    /**
-     * Defines the component height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    height: string | number;
-    /**
-     * Defines the component min height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    minHeight: string | number;
-    /**
-     * Defines the component max height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    maxHeight: string | number;
-    /**
-     * Set component height to fill all space available
-     */
-    fillHeight: boolean;
-    /**
-     * Defines the component width. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    width: string | number;
-    /**
-     * Defines the component min width. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    minWidth: string | number;
-    /**
-     * Defines the component max height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    maxWidth: string | number;
-    /**
-     * Creates a new instance of ImgLink
-     * @param props Image Link props
-     */
-    constructor(props: IImage);
-    load(event?: Event, element?: HTMLElement): void;
-}

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

@@ -1,12 +0,0 @@
-import { IComponentRender } from '@zeedhi/common';
-export interface IImage extends IComponentRender {
-    to?: string;
-    src?: string;
-    height?: number | string;
-    maxHeight?: number | string;
-    minHeight?: number | string;
-    fillHeight?: boolean;
-    width?: number | string;
-    maxWidth?: number | string;
-    minWidth?: number | string;
-}

package/types/components/tek-iterable-carousel/interfaces.d.ts

@@ -1,5 +0,0 @@
-import { ICarousel, IIterableComponentRender } from '@zeedhi/common';
-export declare type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
-export interface IIterableCarousel extends ICarousel {
-    iterable?: Omit<IIterableComponentRender, 'name' | 'component'>;
-}

package/types/components/tek-iterable-carousel/iterable-carousel.d.ts

@@ -1,13 +0,0 @@
-import { Carousel, IComponentRender, IterableComponentRender } from '@zeedhi/common';
-import { IIterableCarousel } from './interfaces';
-/**
- * Base class for IterableCarousel component.
- * This component uses every row returned by IterableComponentRender.datasource to render
- * slides defined by componentMetadata property, inside a carousel component.
- */
-export declare class IterableCarousel extends Carousel implements IIterableCarousel {
-    iterable: IterableComponentRender;
-    constructor(props: IIterableCarousel);
-    get children(): IComponentRender[];
-    set children(value: IComponentRender[]);
-}

package/types/components/tek-iterable-component-render/interfaces.d.ts

@@ -1,3 +0,0 @@
-import { IIterableComponentRender as ZdIIterableComponentRender } from '@zeedhi/common';
-export interface IIterableComponentRender extends ZdIIterableComponentRender {
-}

package/types/components/tek-iterable-component-render/iterable-component-render.d.ts

@@ -1,10 +0,0 @@
-import { Iterable, IIterableComponentRender } from '@zeedhi/common';
-/**
- * Base class for IterableComponentRender component.
- * This component uses every row returned by Iterable.datasource to render
- * components defined by componentMetadata property.
- * If the data inside the datasource is changed you should perform
- * a datasource.get() to force updating the rendered components.
- */
-export declare class IterableComponentRender extends Iterable implements IIterableComponentRender {
-}

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

@@ -1,6 +0,0 @@
-import { ILoading as IZdLoading } from '@zeedhi/common';
-export interface ILoading extends IZdLoading {
-    text?: string;
-    zIndex?: number | string;
-    image?: string;
-}

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

@@ -1,24 +0,0 @@
-import { Loading as ZdLoading } from '@zeedhi/common';
-import { ILoading } from './interfaces';
-/**
- * Teknisa component
- */
-export declare class Loading extends ZdLoading implements ILoading {
-    /**
-    * text to show in Loader Overlay
-    */
-    text: string;
-    /**
-    * zIndex value.
-    */
-    zIndex: number | string;
-    /**
-    * loading path.
-    */
-    image: string;
-    /**
-    * Creates a new instance of TekLoading
-    * @param props Image Link props
-    */
-    constructor(props: ILoading);
-}

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

@@ -1,22 +0,0 @@
-import { IIterable, IComponentEvents, EventDef } from '@zeedhi/common';
-import { IEventParam } from '@zeedhi/core';
-import { Notifications } from './notifications';
-export interface INotification {
-    id: string;
-    date: string;
-    subject: string;
-    body: string;
-    read: boolean;
-}
-export interface INotificationsEvent extends IEventParam<Notifications> {
-    notification: INotification;
-}
-export interface INotificationsEvents<T = INotificationsEvent | IEventParam<any>> extends IComponentEvents<T> {
-    showAllClick?: EventDef<T>;
-    notificationClick?: EventDef<T>;
-    markAllAsReadClick?: EventDef<T>;
-}
-export interface INotifications extends IIterable {
-    allNotificationsPath?: string;
-    events?: INotificationsEvents;
-}

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

@@ -1,35 +0,0 @@
-import { Iterable } from '@zeedhi/common';
-import { INotifications, INotificationsEvents } from './interfaces';
-/**
- * Notifications component is used to show notifications
- */
-export declare class Notifications extends Iterable implements INotifications {
-    allNotificationsPath: string;
-    /**
-     * Defines grid events.
-     */
-    events: INotificationsEvents;
-    cardTitle: {
-        name: string;
-        component: string;
-        title: string;
-        rightSlot: {
-            name: string;
-            component: string;
-            tag: string;
-            events: {
-                click: ({ event, element }: any) => void;
-            };
-            children: {
-                name: string;
-                cssClass: string;
-                component: string;
-                text: string;
-            }[];
-        }[];
-    };
-    constructor(props: INotifications);
-    markAsRead({ event, element }: any): void;
-    showAll(event: Event, element: HTMLElement): void;
-    notificationClick(event: Event, notification: any, element: HTMLElement): void;
-}

package/types/components/tek-product-card/interfaces.d.ts

@@ -1,19 +0,0 @@
-import { IComponentRender } from '@zeedhi/common';
-import { IEventParam } from '@zeedhi/core';
-import { ProductCard } from './product-card';
-export declare type IProductCardEvent = IEventParam<ProductCard>;
-export interface IProductCard extends IComponentRender {
-    id?: string;
-    to?: string;
-    src?: string;
-    errorImagePath?: string;
-    errorImageText?: string;
-    productPrice?: number | string;
-    productName?: string;
-    productSupplier?: string;
-    productBrand?: string;
-    width?: string;
-    height?: number | string;
-    maxHeight?: number | string;
-    minHeight?: number | string;
-}

package/types/components/tek-product-card/product-card.d.ts

@@ -1,66 +0,0 @@
-import { ComponentRender } from '@zeedhi/common';
-import { IProductCard } from './interfaces';
-/**
- * Teknisa product card component
- */
-export declare class ProductCard extends ComponentRender implements IProductCard {
-    /**
-     * Route path.
-     */
-    to: string;
-    /**
-     * Product Id.
-     */
-    id: string;
-    /**
-     * Image source Product.
-     */
-    src: string;
-    /**
-     * Product name.
-     */
-    productName: string;
-    /**
-     * Product supplier
-     */
-    productSupplier?: string;
-    /**
-     * Product brand
-     */
-    productBrand?: string;
-    /**
-     * Product price
-     */
-    productPrice?: number | string;
-    /**
-     * Path to image to be shown when error
-     */
-    errorImagePath: string;
-    /**
-     * Text to be shown when error
-     */
-    errorImageText: string;
-    /**
-     * Card width
-     */
-    width: string;
-    /**
-     * Sets the height for the component.
-     */
-    height: number | string;
-    /**
-     * Sets the maximum height for the component.
-     */
-    maxHeight: number | string;
-    /**
-     * Sets the minimum height for the component.
-     */
-    minHeight: number | string;
-    protected currencyFormatterFn: Function;
-    /**
-     * Creates a new instance of ProductCard
-     * @param props Product Card props
-     */
-    constructor(props: IProductCard);
-    get productPriceFormat(): any;
-}

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

@@ -1,30 +0,0 @@
-import { IComponentRender, ITreeGridEditable } from '@zeedhi/common';
-import { IDictionary } from '@zeedhi/core';
-import { ITekGridColumn, ITekGridEvents, ITekGridExportConfig, TekGridLayoutOptions, IModalFilterProps } from '..';
-export interface ITekTreeGrid extends ITreeGridEditable {
-    actions?: IComponentRender[];
-    addButton?: boolean;
-    columnFilterButton?: boolean;
-    columns?: ITekGridColumn[];
-    columnsButton?: boolean;
-    columnsButtonIgnore?: string[];
-    deleteButton?: 'none' | 'currentRow' | 'selection';
-    events?: ITekGridEvents;
-    filterButton?: boolean;
-    mainGrid?: boolean;
-    modalFilterProps?: IModalFilterProps;
-    showSearch?: boolean;
-    showHideButton?: boolean;
-    showLayoutOptions?: boolean;
-    title?: string;
-    showExport?: boolean;
-    showEditButtons?: boolean;
-    showReload?: boolean;
-    exportConfig?: ITekGridExportConfig[];
-    exportActions?: IComponentRender[];
-    layoutOptions?: TekGridLayoutOptions;
-    showCheckboxAllFilter?: boolean;
-    defaultFilter?: IDictionary;
-    toolbarOpened?: boolean;
-    reportTitle?: string;
-}

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

@@ -1,102 +0,0 @@
-import { IComponentRender, TreeGridEditable } from '@zeedhi/common';
-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 { ITekTreeGrid } from './interfaces';
-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[];
-    filterButton: boolean;
-    modalFilterProps: IModalFilterProps;
-    showSearch?: boolean;
-    showHideButton: boolean;
-    columnFilterButton: boolean;
-    columnsButton: boolean;
-    columnsButtonIgnore: string[];
-    events: ITekGridEvents;
-    /**
-     * Enables column dragging
-     * @public
-     */
-    dragColumns: boolean;
-    /**
-     * Defines if the grid is the unique grid on screen
-     */
-    mainGrid: boolean;
-    /**
-     * Enables column resizing
-     * @public
-     */
-    resizeColumns: boolean;
-    /**
-     * Enables layout saving
-     * @public
-     */
-    showLayoutOptions: boolean;
-    /**
-     * Editable columns
-     */
-    columns: TekGridColumn[];
-    /**
-     * Show export button
-     */
-    showExport: boolean;
-    /**
-     * Show refresh button
-     */
-    showReload: boolean;
-    toolbarOpened: boolean;
-    protected keyShortcutKeyMapping: any;
-    /**
-     * Export config
-     */
-    exportConfig: ITekGridExportConfig[];
-    private toolbarSlotProps;
-    /**
-     * Actions to overwrite the default export config
-     */
-    exportActions?: IComponentRender[];
-    private gridBase;
-    filterRelationsDatasource: Datasource;
-    filterOperationsDatasource: Datasource;
-    showCheckboxAllFilter: boolean;
-    defaultFilter: IDictionary;
-    reportTitle: string;
-    /**
-     * TekTreeGrid class constructor
-     * @param props TekTreeGrid properties
-     */
-    constructor(props: ITekTreeGrid);
-    onMounted(element: HTMLElement): void;
-    onBeforeDestroy(): void;
-    onCreated(): void;
-    protected focusSearchInput(): void;
-    get layoutOptions(): TekGridLayoutOptions | undefined;
-    /**
-     * Get Grid columns objects
-     * @param columns Grid columns parameter
-     */
-    protected getColumns(columns: ITekGridColumn[]): TekGridColumn[];
-    columnHasFilterData(column: TekGridColumn): any;
-    getReport(type: string, portrait?: boolean, rowObj?: any): Promise<Window | null>;
-    setSearch(search: string): Promise<any>;
-    /**
-     * Dispatches row click event
-     * @param row Grid row
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    rowClick(row: IDictionary<any>, event: Event, element: HTMLElement): void;
-    getAtomInstance<T>(key: keyof ITekGridAtoms): T;
-    getFilterInputs(columnName?: string): import("@zeedhi/common").Input[];
-    getColumn(name: string): TekGridColumn;
-}

package/types/error/incomplete-groups-error.d.ts

@@ -1,8 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-/**
- * Thrown when a row has incomplete group information.
- * Provides details about the missing groups and the problematic row.
- */
-export declare class IncompleteGroupsError extends Error {
-    constructor(row: IDictionary, missingGroups: string[]);
-}

package/types/index.d.ts

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

package/types/utils/extract-properties.d.ts

@@ -1,7 +0,0 @@
-/**
- * Extracts properties from an object based on a list of properties
- * @param obj object whose properties will be extracted
- * @param props array of strings with the properties to be extracted
- * @returns object containing the extracted properties
- */
-export declare const extractProperties: (obj: any, props: string[]) => any;

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

@@ -1,5 +0,0 @@
-import { IComponentRender } from '@zeedhi/common';
-import { TekGrid, TekTreeGrid } from '../../../components';
-export interface IExportOption {
-    buildComponent: (grid: TekGrid | TekTreeGrid) => IComponentRender;
-}