@zeedhi/common 1.123.0 → 1.125.0

package/dist/types/components/zd-form/form.d.ts

@@ -1,174 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { ComponentRender } from '../zd-component/component-render';
-import { Input } from '../zd-input/input';
-import { IForm, IFormComponent, IFormEvents, IFormGrid } from './interfaces';
-/**
- * Base class for Form component.
- */
-export declare class Form extends ComponentRender implements IForm {
-    /**
-     * Children component structure if the component has children.
-     */
-    children: IFormComponent[];
-    /**
-     * Applies the align-items css property.
-     * Available options are start, center, end, space-between, space-around and stretch.
-     */
-    align?: string;
-    /**
-     * Applies the justify-content css property.
-     * Available options are start, center, end, space-between and space-around.
-     */
-    justify?: 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;
-    /**
-     * 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;
-    /**
-     * Defines form events.
-     */
-    events: IFormEvents;
-    /**
-     * Optional validation method assigned by view layer.
-     */
-    private viewValidate?;
-    /**
-     * Optional submit method.
-     */
-    submitFunction?: () => void;
-    /**
-     * Reset validation method assigned by view layer.
-     */
-    private viewResetValidation?;
-    /**
-     * Children components that are Inputs.
-     */
-    private inputs;
-    private internalValue;
-    /**
-     * Creates a new Form.
-     * @param props Form properties
-     */
-    constructor(props: IForm);
-    /**
-     * Form value.
-     */
-    get value(): IDictionary;
-    set value(value: IDictionary);
-    /**
-     * Clear all form inputs
-     */
-    clearForm(): void;
-    /**
-     * Saves input instance and defines property on form value.
-     * @param component Children component
-     */
-    registerInput(component: Input): void;
-    /**
-     * Children props without grid system.
-     */
-    get childrenProps(): {
-        [key: string]: any;
-        children?: import("..").IComponentRender[] | undefined;
-        component: string;
-        allowDuplicate?: boolean | undefined;
-        autofocus?: boolean | undefined;
-        componentId?: number | undefined;
-        cssClass?: string | undefined;
-        cssStyle?: string | IDictionary<any> | undefined;
-        events?: import("..").IComponentEvents<import("@zeedhi/core").IEventParam<any>> | undefined;
-        directives?: import("..").IComponentDirectives | undefined;
-        isVisible?: string | boolean | undefined;
-        dark?: boolean | undefined;
-        light?: boolean | undefined;
-        theme?: string | undefined;
-        keyMap?: import("@zeedhi/core").IKeyMap<import("@zeedhi/core").IEventParam<any>> | undefined;
-        name: string;
-        parent?: import("..").IComponentInstance | undefined;
-        tabStop?: boolean | undefined;
-        userProperties?: IDictionary<any> | undefined;
-        fillHeight?: boolean | undefined;
-    }[];
-    /**
-     * Checks if the value matches a col value (1, 2, ... 12) or auto
-     */
-    private matchColumn;
-    private breakpoints;
-    private matchBreakpoint;
-    private handleColClass;
-    private handleOffsetClass;
-    /**
-     * This method searches in a css class string to find classes related to grid cols \
-     * Parses all of the grid cols classes found to form grid object entries, for example
-     * the following class: 'zd-col-sm-12 zd-col-md-6' will become { sm: '12', md: '6' }
-     */
-    private parseGridClasses;
-    private getChildGrid;
-    /**
-     * Grid system for each child.
-     */
-    get childrenGrid(): IDictionary<IFormGrid>;
-    /**
-     * Validates form.
-     */
-    validate(): Promise<{
-        valid: boolean;
-    }>;
-    /**
-     * Sets view validation method.
-     */
-    setViewValidate(viewValidate: () => Promise<{
-        valid: boolean;
-        errors: {
-            id: string | number;
-            errorMessages: string[];
-        }[];
-    }>): void;
-    /**
-     * Sets view reset validation method.
-     */
-    setViewResetValidation(viewResetValidation: () => void): void;
-    /**
-     * Triggered when form is submitted and it's valid.
-     * @param event DOM Event
-     * @param element Form component
-     */
-    callSubmitEvent(event: Event, element: any): void;
-    /**
-     * Triggered when the component is mounted.
-     * @param element Element mounted reference
-     */
-    onMounted(element: any): void;
-    submit(): void;
-    /**
-     * Reset all form validation errors.
-     * @throws Will throw if viewResetValidation is undefined
-     */
-    resetValidation(): void;
-}

package/dist/types/components/zd-form/interfaces.d.ts

@@ -1,36 +0,0 @@
-import { IEventParam } from '@zeedhi/core';
-import { EventDef, IComponentEvents, IComponentRender } from '../zd-component/interfaces';
-import { Form } from './form';
-export type IFormEvent = IEventParam<Form>;
-export interface IFormEvents extends IComponentEvents<IFormEvent> {
-    submit?: EventDef<IFormEvent>;
-}
-export interface IFormGrid {
-    cols?: string;
-    lg?: string;
-    md?: string;
-    sm?: string;
-    xl?: string;
-    xxl?: string;
-    offset?: string;
-    'offset-lg'?: string;
-    'offset-md'?: string;
-    'offset-sm'?: string;
-    'offset-xl'?: string;
-    'offset-xxl'?: string;
-}
-export interface IFormComponent extends IComponentRender {
-    grid?: IFormGrid;
-}
-export interface IForm extends IComponentRender {
-    align?: string;
-    justify?: string;
-    height?: number | string;
-    maxHeight?: number | string;
-    minHeight?: number | string;
-    width?: number | string;
-    maxWidth?: number | string;
-    minWidth?: number | string;
-    children?: IFormComponent[];
-    events?: IFormEvents;
-}

package/dist/types/components/zd-frame/frame.d.ts

@@ -1,81 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { ComponentRender } from '../zd-component/component-render';
-import { IFrame, IFrameEvents } from './interfaces';
-export declare class Frame extends ComponentRender implements IFrame {
-    loading: boolean;
-    local: boolean;
-    metadata: object;
-    override: object;
-    params: object;
-    overrideNamedProps: IDictionary;
-    path: string;
-    cache: boolean;
-    JSONCache: boolean | string;
-    events: IFrameEvents;
-    cacheDuration: number;
-    /**
-     * 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;
-    /**
-     * 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;
-    type: string;
-    private readonly headerName;
-    private static readonly cacheName;
-    protected resolveLoad?: (value: object) => void;
-    protected rejectLoad?: (reason?: any) => void;
-    constructor(props: IFrame);
-    onCreated(): void;
-    overrideNamedPropsFunc(metadata: object): any;
-    reload(): Promise<void>;
-    /**
-     * Triggered when frame is load.
-     * @param event
-     * @param element
-     */
-    afterLoad(event?: Event, element?: HTMLElement): void;
-    /**
-     * Deletes all frame cached requests
-     */
-    static deleteCache(): Promise<boolean>;
-    waitLoading(): Promise<object>;
-    protected notFoundError(e: unknown): void;
-    private getMetadata;
-    private requestPage;
-    /**
-     * Checks if cache response is valid (not expired yet)
-     * @param response
-     */
-    private isValid;
-    /**
-     * Puts the metadata in defined cache with defined url
-     * @param cache Cache object in which data will be stored
-     * @param url Metadata url
-     * @param metadata Metadata to be stored
-     */
-    private putCache;
-}

package/dist/types/components/zd-frame/interfaces.d.ts

@@ -1,23 +0,0 @@
-import { IDictionary, IEventParam } from '@zeedhi/core';
-import { EventDef, IComponentEvents, IComponentRender } from '../zd-component/interfaces';
-import { Frame } from './frame';
-export type IFrameEvent = IEventParam<Frame>;
-export interface IFrameEvents<T = IFrameEvent> extends IComponentEvents<T> {
-    onAfterLoad?: EventDef<T>;
-}
-export interface IFrame extends IComponentRender {
-    path: string;
-    local?: boolean;
-    override?: object;
-    overrideNamedProps?: IDictionary;
-    cache?: boolean;
-    JSONCache?: boolean | string;
-    cacheDuration?: number;
-    height?: number | string;
-    maxHeight?: number | string;
-    minHeight?: number | string;
-    width?: number | string;
-    maxWidth?: number | string;
-    minWidth?: number | string;
-    type?: string;
-}

package/dist/types/components/zd-frame-page/frame-page.d.ts

@@ -1,14 +0,0 @@
-import { Frame } from '../zd-frame/frame';
-import { IFramePage } from './interfaces';
-export declare class FramePage extends Frame implements IFramePage {
-    /**
-     * Set "NotFound" to the frame
-     */
-    notFoundRoute: string;
-    constructor(props: IFramePage);
-    /**
-     * Triggered before the component is destroyed.
-     */
-    onBeforeDestroy(): void;
-    protected notFoundError(e: unknown): void;
-}

package/dist/types/components/zd-frame-page/interfaces.d.ts

@@ -1,4 +0,0 @@
-import { IFrame } from '../zd-frame/interfaces';
-export interface IFramePage extends IFrame {
-    notFoundRoute?: string;
-}

package/dist/types/components/zd-grid/data-navigator.d.ts

@@ -1,12 +0,0 @@
-import { Direction, IDataNavigator, IGrid, IIterableTable } from './interfaces';
-export declare class DataNavigator implements IDataNavigator {
-    protected iterable: IGrid & IIterableTable;
-    constructor(iterable: IGrid & IIterableTable);
-    navigateDatasource(direction: Direction): void;
-    private navigateFirst;
-    private navigateLast;
-    private navigateInitial;
-    navigatePageDown(): void;
-    navigatePageUp(): void;
-    private navigateCurrentRow;
-}

package/dist/types/components/zd-grid/data-selector.d.ts

@@ -1,25 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { IDataSelector, IGrid } from './interfaces';
-export declare class DataSelector implements IDataSelector {
-    protected iterable: IGrid;
-    constructor(iterable: IGrid);
-    selectAll(isSelected: boolean): void;
-    toggleRow(row: IDictionary): void;
-    selectRow(row: IDictionary, select: boolean): void;
-    callDisableSelection(row: IDictionary<any>): boolean;
-    /**
-     * Dispatches select/unselect event
-     * @param row Grid row
-     * @param isSelected Row is selected
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    selectClick(row: IDictionary<any>, isSelected: boolean, event: Event, element: any): void;
-    /**
-     * Dispatches select/unselect all rows event
-     * @param isSelected Row is selected
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    selectAllClick(isSelected: boolean, event: Event, element: any): void;
-}

package/dist/types/components/zd-grid/grid-column.d.ts

@@ -1,47 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { Column } from '../zd-iterable/column';
-import { IChildrenActionColumn, IGridColumn } from './interfaces';
-/**
- * Base class for Grid column
- */
-export declare class GridColumn extends Column implements IGridColumn {
-    children: IChildrenActionColumn[];
-    /**
-     * Creates a new Grid Column.
-     * @param props Grid column properties
-     */
-    constructor(props: IGridColumn);
-    /**
-     * Children props without grid system.
-     */
-    get childrenProps(): {
-        [key: string]: any;
-        allowDuplicate?: boolean | undefined;
-        autofocus?: boolean | undefined;
-        children?: import("..").IComponent[] | undefined;
-        componentId?: number | undefined;
-        cssClass?: string | undefined;
-        cssStyle?: string | IDictionary<any> | undefined;
-        events?: import("..").IComponentEvents<import("@zeedhi/core").IEventParam<any>> | undefined;
-        directives?: import("..").IComponentDirectives | undefined;
-        isVisible?: string | boolean | undefined;
-        dark?: boolean | undefined;
-        light?: boolean | undefined;
-        theme?: string | undefined;
-        keyMap?: import("@zeedhi/core").IKeyMap<import("@zeedhi/core").IEventParam<any>> | undefined;
-        name: string;
-        parent?: import("..").IComponentInstance | undefined;
-        tabStop?: boolean | undefined;
-        userProperties?: IDictionary<any> | undefined;
-        fillHeight?: boolean | undefined;
-    }[];
-    /**
-     * Get the Column without the conditions object
-     * @param component Column component
-     */
-    getColumnWithoutConditions(component: any): any;
-    /**
-     * checkOutValues
-     */
-    checkOutValues(component: any, row: IDictionary<any>, newRow: IDictionary<any>): void;
-}

package/dist/types/components/zd-grid/grid-events.d.ts

@@ -1,26 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { GridColumn } from './grid-column';
-import { IGrid, IGridEvents } from './interfaces';
-export declare class GridEvents implements IGridEvents {
-    protected iterable: IGrid;
-    /**
-     * Flag to prevent row click
-     */
-    protected preventRowClick: boolean;
-    constructor(iterable: IGrid);
-    /**
-     * Dispatches row click event
-     * @param row Grid row
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    rowClick(row: IDictionary<any>, event: Event, element: any): void;
-    /**
-     * Dispatches cell click Event
-     * @param row Grid row
-     * @param column Grid column
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    cellClick(row: IDictionary<any>, column: GridColumn, event: Event, element: any): void;
-}

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

@@ -1,85 +0,0 @@
-import { IDictionary, IEventParam } from '@zeedhi/core';
-import { IComponent, IComponentRender } from '../zd-component/interfaces';
-import { Iterable } from '../zd-iterable/iterable';
-import { GridColumn } from './grid-column';
-import { Direction, IGrid, IGridColumn, IGridEvents, IGridProps, VerticalDirection } from './interfaces';
-export declare class Grid extends Iterable<GridColumn> implements IGrid, IGridEvents {
-    private tableActionBuilder;
-    private iterableTable;
-    private dataSelector;
-    private gridEvents;
-    private dataNavigator;
-    private viewNavigator;
-    private keyMapMerger;
-    currentColumn: GridColumn | 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;
-    dragColumns: 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[];
-    resizeColumns: boolean;
-    showFooter: boolean;
-    showHeader: boolean;
-    showSelectAll: boolean;
-    width: string | number;
-    backgroundColor: string;
-    constructor(props: IGridProps);
-    getConditionalProps({ row, column }: {
-        row: IDictionary;
-        column: GridColumn;
-    }): Partial<IComponentRender>;
-    onMounted(element: HTMLElement): void;
-    onBeforeDestroy(): 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;
-    createColumn(column: IGridColumn): GridColumn;
-    rowClick(row: IDictionary<any>, event: Event, element?: HTMLElement): void;
-    cellClick(row: IDictionary<any>, column: GridColumn, event: Event, element?: HTMLElement): void;
-    selectClick(row: IDictionary<any>, isSelected: boolean, event: Event, element?: HTMLElement): void;
-    selectAllClick(isSelected: boolean, event: Event, element?: HTMLElement): void;
-    selectAll(isSelected: boolean): void;
-    toggleRow(row: IDictionary): void;
-    selectRow(row: IDictionary, select: boolean): void;
-    callDisableSelection(row: IDictionary): boolean;
-    changeOrder(sortBy: {
-        key: string;
-        order: 'asc' | 'desc';
-    }[]): Promise<void>;
-    selectCell(row: IDictionary, column: GridColumn): void;
-    reapplyRowStyleConditions(row: IDictionary): IDictionary;
-    getRowStyleConditions(row: IDictionary): IDictionary;
-    deleteRows(): Promise<any[]>;
-    getActionComponent(actionComponent: IComponent, column: GridColumn, row: IDictionary, parentPath?: string): IComponent;
-    changeData(data?: IDictionary<any>[]): void;
-}

package/dist/types/components/zd-grid/index.d.ts

@@ -1,11 +0,0 @@
-export * from './data-selector';
-export * from './grid-column';
-export * from './grid-events';
-export * from './grid';
-export * from './interfaces';
-export * from './iterable-table';
-export * from './table-action-builder';
-export * from './keymap-navigation';
-export * from './keymap-merger';
-export * from './data-navigator';
-export * from './view-navigator';