@zeedhi/common 3.0.6 → 3.1.0

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

@@ -1,86 +0,0 @@
-import { Datasource, IDictionary } from '@zeedhi/core';
-import { ComponentRender } from '../zd-component/component-render';
-import { IComponentRender } from '../zd-component/interfaces';
-import { Column } from './column';
-import { IColumn, IIterable, IIterableEvents, IIterableProps } from './interfaces';
-/**
- * Base class for Iterable components.
- */
-export declare abstract class Iterable<T extends Column = Column> extends ComponentRender<IIterableProps> implements IIterable<T> {
-    /**
-     * Iterable datasource
-     */
-    datasource: Datasource;
-    columns: T[];
-    pageSizes: string[];
-    events: IIterableEvents;
-    virtualScroll: boolean;
-    virtualScrollCache: number;
-    searchVisibleOnly: boolean;
-    defaultSearchVisibleOnly: boolean;
-    private conditionsManager;
-    /**
-     * Creates a new Iterable.
-     * @param props Iterable properties
-     */
-    constructor(props: IIterableProps);
-    protected initializeDatasource(props: IIterableProps): void;
-    updateData(data: IDictionary[]): Promise<any>;
-    getAppliedConditions(args: {
-        row: IDictionary;
-        column: Column;
-        path?: string;
-    }): Partial<IComponentRender>;
-    getCurrentRowIndex(): number;
-    getPage(): number;
-    setPage(page: number): Promise<any>;
-    getLastPage(): number;
-    protected createController(): void;
-    onCreated(): void;
-    /**
-     * Retrieves columns instances
-     * @param columns Columns property
-     */
-    protected createColumns(props: IIterableProps): T[];
-    abstract createColumn(columnProps: IColumn): T;
-    /**
-     * Retrieves a columns by name
-     * @param name Column name
-     */
-    getColumn(name: string): T;
-    get pageText(): string;
-    get paginationLength(): number;
-    /**
-     * Return cells with conditions applied for each row
-     * @param columns Iterable columns
-     * @param row Datasource row
-     */
-    getCellWithAppliedConditions(columns: Column[], row: IDictionary<any>): IDictionary<IDictionary<any>>;
-    reapplyConditions(row: IDictionary<any>, columns?: Column[]): IDictionary<IDictionary<any>>;
-    reload(): Promise<any>;
-    changeData(data: IDictionary[]): void;
-    onBeforeDestroy(): void;
-    /**
-     * Dispatches change layout Event
-     * @param event DOM event
-     * @param element DOM Element
-     */
-    changeLayout(event?: Event, element?: any): void;
-    setSearch(search: string): Promise<any>;
-    setCurrentRow(row: IDictionary): void;
-    setOrder(order: string[]): Promise<any>;
-    getRowKey(row: IDictionary): any;
-    delete(row: IDictionary): Promise<any>;
-    getData(): IDictionary[];
-    protected changeDefaultSlotNames(slot: IComponentRender[]): any;
-    /**
-     * Recursively replaces a pattern in all string values within an object/array tree
-     * @param obj The object or array to process
-     * @param pattern The regex pattern to search for
-     * @param replacement The replacement string
-     * @returns A new object/array with replaced values
-     */
-    private recursiveReplace;
-    private isObject;
-    findRow(key: string | number): IDictionary<any> | undefined;
-}

package/dist/types/components/zd-iterable/search.d.ts

@@ -1,31 +0,0 @@
-import { TextInput } from '../zd-text-input/text-input';
-import { ISearch } from './interfaces';
-import { Iterable } from './iterable';
-/**
- * Base class for Search component
- */
-export declare class Search extends TextInput implements ISearch {
-    /**
-     * Iterable component name
-     */
-    iterableComponentName: string;
-    /**
-     * Iterable component name
-     */
-    iterableComponent: Iterable;
-    showLabel: boolean;
-    showHelper: boolean;
-    appendIcon: string;
-    placeholder: string;
-    lazyAttach: boolean;
-    /**
-     * Creates a new Iterable Page component.
-     * @param props Iterable page component properties
-     */
-    constructor(props: ISearch);
-    setIterableComponent(name?: string): void;
-    protected setSearch(search: string): Promise<void>;
-    debounceSetSearch: (search: string) => void;
-    get value(): string;
-    set value(value: string);
-}

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

@@ -1,34 +0,0 @@
-import { IComponentRender } from '../zd-component/interfaces';
-import { IIterableProps } from '../zd-iterable/interfaces';
-export interface IIterableComponentRenderProps extends IIterableProps {
-    rowPropName?: string;
-    componentMetadata?: IComponentRender;
-    footerSlot?: IComponentRender[];
-    toolbarSlot?: IComponentRender[];
-    errorSlot?: IComponentRender[];
-    noDataSlot?: IComponentRender[];
-    noResultSlot?: IComponentRender[];
-    height?: number | string;
-    maxHeight?: number | string;
-    minHeight?: number | string;
-    fillHeight?: boolean;
-    width?: number | string;
-    maxWidth?: number | string;
-    minWidth?: number | string;
-}
-export interface IIterableComponentRender extends IIterableProps {
-    rowPropName: string;
-    componentMetadata?: IComponentRender;
-    footerSlot: IComponentRender[];
-    toolbarSlot: IComponentRender[];
-    errorSlot: IComponentRender[];
-    noDataSlot: IComponentRender[];
-    noResultSlot: IComponentRender[];
-    height: number | string;
-    maxHeight: number | string;
-    minHeight: number | string;
-    fillHeight: boolean;
-    width: number | string;
-    maxWidth: number | string;
-    minWidth: number | string;
-}

package/dist/types/components/zd-iterable-component-render/iterable-component-render.d.ts

@@ -1,84 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { IComponentRender } from '../zd-component/interfaces';
-import { Column } from '../zd-iterable/column';
-import { IColumn } from '../zd-iterable/interfaces';
-import { Iterable } from '../zd-iterable/iterable';
-import { IIterableComponentRender, IIterableComponentRenderProps } from './interfaces';
-/**
- * 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 {
-    /**
-     * Components that will be rendered on toolbar slot
-     */
-    toolbarSlot: IComponentRender[];
-    /**
-     * Components that will be rendered on footer slot
-     */
-    footerSlot: IComponentRender[];
-    /**
-     * Component item definition
-     */
-    componentMetadata: IComponentRender;
-    /**
-     * Row property name
-     */
-    rowPropName: string;
-    /**
-     * Components that will be rendered in no-data case
-     */
-    noDataSlot: IComponentRender[];
-    /**
-     * Components that will be rendered in no-result case
-     */
-    noResultSlot: IComponentRender[];
-    /**
-     * 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;
-    /**
-     * Components that will be rendered in error case
-     */
-    errorSlot: IComponentRender[];
-    constructor(props: IIterableComponentRenderProps);
-    private addSlashes;
-    /**
-     * Returns the iterable component metadata based on row data
-     */
-    getComponentMetadata(row: IDictionary<any>): any;
-    createColumn(column: IColumn): Column;
-}

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

@@ -1,7 +0,0 @@
-import { IComponentRender } from '../zd-component/interfaces';
-export interface ILayout extends IComponentRender {
-    fullHeight?: boolean;
-    scrollable?: boolean;
-    tag?: string;
-    height: string | number;
-}

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

@@ -1,9 +0,0 @@
-import { ComponentRender } from '../zd-component/component-render';
-import { ILayout } from './interfaces';
-export declare class Layout extends ComponentRender implements ILayout {
-    fullHeight?: boolean | undefined;
-    scrollable?: boolean | undefined;
-    tag?: string;
-    height: string | number;
-    constructor(props: ILayout);
-}

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

@@ -1,44 +0,0 @@
-import { IComponent, IComponentRender } from '../zd-component/interfaces';
-/**
- * Interface for list component
- */
-export interface IList extends IComponentRender {
-    dense?: boolean;
-    disabled?: boolean;
-    divided?: boolean;
-    items?: IListItem[];
-    lines?: false | 'one' | 'two' | 'three';
-    color?: string;
-    elevation?: number | string;
-    openStrategy?: 'single' | 'multiple' | 'list';
-    height?: number | string;
-    maxHeight?: number | string;
-    minHeight?: number | string;
-    fillHeight?: boolean;
-    width?: number | string;
-    maxWidth?: number | string;
-    minWidth?: number | string;
-}
-/**
- * Interface for list itens
- */
-export interface IListItem extends IComponentRender {
-    appendIcon?: string;
-    disabled?: boolean;
-    leftField?: IComponent;
-    prependIcon?: string;
-    rightField?: IComponent;
-    ripple?: boolean;
-    subtitle?: string;
-    title?: string;
-    lines?: false | 'one' | 'two' | 'three';
-    dense?: boolean;
-}
-/**
- * Interface for list group
- */
-export interface IListGroup extends IListItem {
-    items?: IListItem[];
-    lazyLoad?: boolean;
-    opened?: boolean;
-}

package/dist/types/components/zd-list/item-not-found.d.ts

@@ -1,6 +0,0 @@
-/**
- * Item not found error
- */
-export declare class ItemNotFoundError extends Error {
-    constructor(name: string, parentName: string);
-}

package/dist/types/components/zd-list/list-group.d.ts

@@ -1,30 +0,0 @@
-import { IListGroup, IListItem } from './interfaces';
-import { ListItem } from './list-item';
-/**
- * Base class for ListGroup component.
- */
-export declare class ListGroup extends ListItem implements IListGroup {
-    /**
-     * List items structure.
-     */
-    items: IListItem[];
-    /**
-     * Content will be loaded only when the group opens.
-     */
-    lazyLoad: boolean;
-    /**
-     * Group state.
-     */
-    opened: boolean;
-    constructor(props: IListGroup);
-    /**
-     * Toggle group state.
-     */
-    toggle(): void;
-    /**
-     * Get item by name
-     * @param name name property of the item
-     * @throws ItemNotFoundError
-     */
-    getItem(name: string): IListItem;
-}

package/dist/types/components/zd-list/list-item.d.ts

@@ -1,46 +0,0 @@
-import { ComponentRender } from '../zd-component/component-render';
-import { IComponent } from '../zd-component/interfaces';
-import { IListItem } from './interfaces';
-/**
- * Base class for ListItem component.
- */
-export declare class ListItem extends ComponentRender implements IListItem {
-    /**
-     * Append an icon inside the item.
-     */
-    appendIcon?: string;
-    /**
-     * Removes the ability to click or target the item.
-     */
-    disabled: boolean;
-    /**
-     * Prepend a component inside the item.
-     */
-    leftField?: IComponent;
-    /**
-     * Prepend an icon inside the item.
-     */
-    prependIcon?: string;
-    /**
-     * Append a component inside the item.
-     */
-    rightField?: IComponent;
-    /**
-     * Apply the ripple effect to show action from a user.
-     */
-    ripple: boolean;
-    /**
-     * Defines the item subtitle.
-     */
-    subtitle?: string;
-    /**
-     * Increases the item height to better support more lines of text.
-     */
-    lines?: false | 'one' | 'two' | 'three';
-    /**
-     * Defines the item title.
-     */
-    title?: string;
-    dense: boolean;
-    constructor(props: IListItem);
-}

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

@@ -1,81 +0,0 @@
-import { ComponentRender } from '../zd-component/component-render';
-import { IList, IListItem } from './interfaces';
-/**
- * Base class for List component.
- */
-export declare class List extends ComponentRender implements IList {
-    /**
-     * Applies specified color to the entire list.
-     * It can be the name of material or css color in hexa or rgba.
-     */
-    color?: string;
-    /**
-     * Create the list with smaller items.
-     */
-    dense: boolean;
-    /**
-     * Removes the ability to click or target the list.
-     */
-    disabled: boolean;
-    /**
-     * Render list with dividers between the items.
-     */
-    divided: boolean;
-    /**
-     * List items structure.
-     */
-    items: IListItem[];
-    /**
-     * Increases the height of all the list items to better support more lines of text.
-     */
-    lines: false | 'one' | 'two' | 'three';
-    /**
-     * Designates an elevation applied to the list between 0 and 24.
-     */
-    elevation: number | string;
-    /**
-     * Will only collapse when explicitly closed.
-     */
-    openStrategy: 'single' | 'multiple' | 'list';
-    /**
-     * 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;
-    constructor(props: IList);
-    /**
-     * Get item by name
-     * @param name name property of the item
-     * @throws ItemNotFoundError
-     */
-    getItem(name: string): IListItem;
-}

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

@@ -1,7 +0,0 @@
-import { IComponent } from '../zd-component/interfaces';
-export interface ILoading extends IComponent {
-    text?: string;
-    defaultText?: string;
-    zIndex?: number | string;
-    opacity?: number | string;
-}

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

@@ -1,21 +0,0 @@
-import { Component } from '../zd-component/component';
-import { ILoading } from './interfaces';
-export declare class Loading extends Component implements ILoading {
-    /**
-     * text to show in Loader Overlay
-     */
-    text?: string;
-    defaultText?: string;
-    opacity?: number | string;
-    isVisible: boolean;
-    zIndex: number | string;
-    constructor(props: ILoading);
-    /**
-     * Displays overlay
-     */
-    show(text?: string): void;
-    /**
-     * Close overlay
-     */
-    hide(): void;
-}

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

@@ -1,25 +0,0 @@
-import { IDictionary, IEventParam } from '@zeedhi/core';
-import { IButton } from '../zd-button/interfaces';
-import { IComponentRender } from '../zd-component/interfaces';
-import { Login } from './login';
-import { LoginButton } from './login-button';
-export type ILoginEvent = IEventParam<Login>;
-export type ILoginButtonEvent = IEventParam<LoginButton>;
-export interface ILogin extends IComponentRender {
-    backgroundStyle?: string;
-    bottomLink?: IComponentRender[];
-    color?: string;
-    cardWidth?: string | number;
-    layout?: string;
-    logo?: string;
-    logoMessage?: string;
-    poweredByImage?: string;
-    poweredByImageCard?: string;
-    socialLogin?: IComponentRender[];
-    flatForm?: boolean;
-}
-export interface ILoginButton extends IButton {
-    authUrl?: string;
-    redirectUrl?: string;
-    requestParams?: IDictionary<any>;
-}

package/dist/types/components/zd-login/login-button.d.ts

@@ -1,50 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { Button } from '../zd-button/button';
-import { Form } from '../zd-form/form';
-import { ILoginButton } from './interfaces';
-/**
- * The Login button component <code>zd-login-button</code> is used to handle login.
- */
-export declare class LoginButton extends Button implements ILoginButton {
-    parent?: Form;
-    /**
-     * Endpoint used to authentication
-     */
-    authUrl: string;
-    /**
-     * Url to redirect
-     */
-    redirectUrl: string;
-    /**
-     * Extra params to be added on login request
-     */
-    requestParams: IDictionary<any>;
-    /**
-     * Create a new LoginButton
-     * @param props LoginButton definition
-     */
-    constructor(props: ILoginButton);
-    /**
-     * Click event
-     */
-    click(event: Event, element: any): Promise<void>;
-    /**
-     * Send request to the configured endpoint
-     */
-    private sendRequest;
-    /**
-     * Returns a parsed query string
-     * @param args Params to the query string
-     */
-    private getQueryString;
-    /**
-     * Redirect the app to the configured url
-     * @param args Response
-     */
-    private handleLoginSuccess;
-    /**
-     * Emit the LoginFail event
-     * @param args Response
-     */
-    private handleLoginFail;
-}

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

@@ -1,54 +0,0 @@
-import { ComponentRender } from '../zd-component/component-render';
-import { IComponentRender } from '../zd-component/interfaces';
-import { ILogin } from './interfaces';
-/**
- * Base class for Login component.
- */
-export declare class Login extends ComponentRender implements ILogin {
-    /**
-     * Value set int the css property background.
-     */
-    backgroundStyle: string;
-    /**
-     * An area in the bottom of the card to display a link.
-     */
-    bottomLink: IComponentRender[];
-    /**
-     * Set card width.
-     */
-    cardWidth: string | number;
-    /**
-     * Applies specified color to the control.
-     * It can be the name of material or css color in hexa.
-     */
-    color: string;
-    /**
-     * Card position orientation.
-     */
-    layout: string;
-    /**
-     * Logo displayed in the top of the card.
-     */
-    logo: string;
-    /**
-     * Text displayed under the logo.
-     */
-    logoMessage: string;
-    /**
-     * Image displayed out of the card.
-     */
-    poweredByImage: string;
-    /**
-     * Image displayed in the card.
-     */
-    poweredByImageCard: string;
-    /**
-     * If form is flat
-     */
-    flatForm: boolean;
-    /**
-     * Buttons displayed in the bottom of the card.
-     */
-    socialLogin: IComponentRender[];
-    constructor(props: ILogin);
-}

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

@@ -1,5 +0,0 @@
-import { IComponentRender } from '../zd-component/interfaces';
-export interface IMain extends IComponentRender {
-    scrollable?: boolean;
-    tag?: string;
-}

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

@@ -1,7 +0,0 @@
-import { ComponentRender } from '../zd-component/component-render';
-import { IMain } from './interfaces';
-export declare class Main extends ComponentRender implements IMain {
-    scrollable: boolean;
-    tag?: string;
-    constructor(props: IMain);
-}

package/dist/types/components/zd-master-detail/detail-not-found.d.ts

@@ -1,7 +0,0 @@
-import { ZeedhiCommonError } from '../../error/zeedhi-error';
-/**
- * Detail not found error
- */
-export declare class DetailNotFoundError extends ZeedhiCommonError {
-    constructor(name: string);
-}

package/dist/types/components/zd-master-detail/interfaces.d.ts

@@ -1,10 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { IComponentRender } from '../zd-component/interfaces';
-export interface IMasterDetail extends IComponentRender {
-    config?: IDictionary<any>;
-    lazyRelate?: boolean;
-    height?: number | string;
-    maxHeight?: number | string;
-    minHeight?: number | string;
-    fillHeight?: boolean;
-}