@zeedhi/common 1.123.0 → 1.124.0

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

@@ -1,119 +0,0 @@
-import { IDictionary, IEventParam } from '@zeedhi/core';
-import { IIterableProps } from '..';
-import { ITreeDataStructure } from '../../utils';
-import { IComponent, IComponentRender } from '../zd-component/interfaces';
-import { Direction, GridColumn, IGrid, IGridColumn, VerticalDirection } from '../zd-grid';
-import { Iterable } from '../zd-iterable/iterable';
-import { ITreeGrid, ITreeGridProps } from './interfaces';
-export declare class TreeGrid extends Iterable<GridColumn> implements ITreeGrid {
-    private tableActionBuilder;
-    private iterableTable;
-    private dataSelector;
-    private gridEvents;
-    private dataNavigator;
-    private viewNavigator;
-    private keyMapMerger;
-    private iterableTree;
-    treeDataStructure: ITreeDataStructure;
-    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;
-    parentField: string;
-    openLevelOnLoad: number | boolean;
-    fetchOnDemand: boolean;
-    fieldHasChild?: string;
-    flat: boolean;
-    detach: boolean;
-    lazyLoad: boolean;
-    constructor(props: ITreeGridProps);
-    protected initializeDatasource(props: IIterableProps): void;
-    onCreated(): void;
-    onMounted(element: HTMLElement): void;
-    onBeforeDestroy(): void;
-    /**
-     * toggleExpand
-     */
-    toggleExpand(row: IDictionary<any>, rowIndex?: number): Promise<IDictionary<any>[] | undefined>;
-    /**
-     * Toggle expand/collapse using navigation keys
-     * @param collapse Should collapse
-     */
-    navigateToggle(collapse: boolean): void;
-    getChildren(row: IDictionary): IDictionary[];
-    findDataIndex(data: IDictionary<any>[], value: any): number;
-    getParentRow(row: IDictionary): IDictionary;
-    buildTreeStructure(): void;
-    resetTree(): void;
-    filterRootData(): Promise<any>;
-    getConditionalProps({ row, column }: {
-        row: IDictionary;
-        column: GridColumn;
-    }): Partial<IComponentRender>;
-    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;
-    selectChildren(row: IDictionary<any>): void;
-    unselectChildren(row: IDictionary<any>): void;
-    buildTree(doGet?: boolean): void;
-    setViewUpdateScrollData(fn: () => void): void;
-    updateScrollData(): void;
-    updateData(data: IDictionary[]): Promise<any>;
-}

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

@@ -1,7 +0,0 @@
-import { ZeedhiCommonError } from './zeedhi-error';
-/**
- * Delete rows error
- */
-export declare class DeleteRowsError extends ZeedhiCommonError {
-    constructor();
-}

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

@@ -1,3 +0,0 @@
-export * from './zeedhi-error';
-export * from './delete-rows';
-export * from './non-initialized';

package/dist/types/error/non-initialized.d.ts

@@ -1,7 +0,0 @@
-import { ZeedhiCommonError } from './zeedhi-error';
-/**
- * NonInitialized error
- */
-export declare class NonInitializedError extends ZeedhiCommonError {
-    constructor(className: string);
-}

package/dist/types/error/zeedhi-error.d.ts

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

package/dist/types/index.d.ts

@@ -1,6 +0,0 @@
-import AutoNumeric from '@zeedhi/autonumeric';
-export * from './components';
-export * from './services';
-export * from './utils';
-export * from './error';
-export { AutoNumeric };

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

@@ -1,4 +0,0 @@
-export * from './zd-alert';
-export * from './zd-loading/loading-service';
-export * from './zd-dialog/dialog-service';
-export * from './zd-modal/modal-service';

package/dist/types/services/zd-alert/alert-queue.d.ts

@@ -1,13 +0,0 @@
-import { Alert, IAlert } from '../../components';
-import { IAlertsManager } from './interfaces';
-export declare class AlertQueue implements IAlertsManager {
-    protected queue: IAlert[];
-    visibleInstances: Alert[];
-    show(alert: IAlert): number;
-    /**
-     * Displays an alert
-     * @param alert Alert Structure
-     */
-    protected display(alert: IAlert): number;
-    remove(index: number): void;
-}

package/dist/types/services/zd-alert/alert-replace.d.ts

@@ -1,18 +0,0 @@
-import { Alert, IAlert } from '../../components';
-import { IAlertsManager } from './interfaces';
-/**
- * Displays alerts using replace.
- * Only one alert can be visible at a time, and when a new alert is shown,
- * the previous one is instantly removed
- */
-export declare class AlertReplace implements IAlertsManager {
-    protected queue: IAlert[];
-    visibleInstances: Alert[];
-    show(alert: IAlert): number;
-    /**
-     * Displays an alert
-     * @param alert Alert Structure
-     */
-    protected display(alert: IAlert): number;
-    remove(index: number): void;
-}

package/dist/types/services/zd-alert/alert-service.d.ts

@@ -1,45 +0,0 @@
-import { IAlert } from '../../components/zd-alert/interfaces';
-import { AlertQueue } from './alert-queue';
-import { AlertReplace } from './alert-replace';
-import { AlertStack } from './alert-stack';
-import { IAlertsManager } from './interfaces';
-export type Multiple = 'replace' | 'queue' | 'stack';
-/**
- * Alert Service Class
- */
-export declare class AlertService {
-    /**
-     * TODO: conferir se o alertsManager será necessário após a atualização 3.6.0 do vuetify,
-     * que vai implementar a funcionalidade internamente
-     * https://github.com/vuetifyjs/vuetify/milestone/72
-     * https://github.com/vuetifyjs/vuetify/issues/2384
-     */
-    static alertsManager: IAlertsManager;
-    static instantiateManager(multiple: Multiple): AlertQueue | AlertStack | AlertReplace;
-    static registerManager(instance: IAlertsManager): void;
-    /**
-     * Displays an alert.
-     * If has an opened alert it will be closed.
-     * @param alert Alert structure
-     * @returns Alert id
-     */
-    static show(alert: IAlert): number;
-    /**
-     * Hides alert by index. Default index is 0
-     */
-    static hide(index?: number): void;
-    /**
-     * Hides alert by alert id (returned by the `show` method)
-     * @param id
-     */
-    static hideById(id: number): void;
-    /**
-     * Hides all of the alerts
-     */
-    static hideAll(): void;
-    /**
-     * Removes an alert from the alert queue
-     * @param index index of the alert to be removed
-     */
-    static remove(index: number): void;
-}

package/dist/types/services/zd-alert/alert-stack.d.ts

@@ -1,9 +0,0 @@
-import { Alert, IAlert } from '../../components';
-import { IAlertsManager } from './interfaces';
-export declare class AlertStack implements IAlertsManager {
-    protected queue: IAlert[];
-    visibleInstances: Alert[];
-    show(alert: IAlert): number;
-    private display;
-    remove(index: number): void;
-}

package/dist/types/services/zd-alert/index.d.ts

@@ -1,5 +0,0 @@
-export * from './alert-queue';
-export * from './alert-stack';
-export * from './alert-replace';
-export * from './alert-service';
-export * from './interfaces';

package/dist/types/services/zd-alert/interfaces.d.ts

@@ -1,6 +0,0 @@
-import { Alert, IAlert } from '../../components';
-export interface IAlertsManager {
-    visibleInstances: Alert[];
-    show(alert: IAlert): number;
-    remove(index: number): void;
-}

package/dist/types/services/zd-dialog/dialog-service.d.ts

@@ -1,24 +0,0 @@
-import { Dialog } from '../../components/zd-dialog/dialog';
-import { IDialog } from '../../components/zd-dialog/interfaces';
-/**
- * Dialog Service Class
- */
-export declare class DialogService {
-    static instance: Dialog;
-    /**
-     * Displays a dialog.
-     * If has an opened dialog it will be closed.
-     * @param dialog dialog structure
-     */
-    static show(dialog: IDialog): void;
-    /**
-     * Hides current dialog
-     */
-    static hide(): void;
-    /**
-     * Displays a dialog
-     * @param dialog Dialog structure
-     * @private
-     */
-    private static display;
-}

package/dist/types/services/zd-loading/loading-service.d.ts

@@ -1,17 +0,0 @@
-import { ILoading } from '../..';
-/**
- * Loading Service Class
- */
-export declare class LoadingService {
-    static loading: ILoading;
-    /**
-     * Displays a Loading.
-     * If has an opened Loading it will be closed.
-     * @param Loading loading structure
-     */
-    static show(text?: string): void;
-    /**
-     * Hides current Loading
-     */
-    static hide(): void;
-}

package/dist/types/services/zd-modal/modal-service.d.ts

@@ -1,39 +0,0 @@
-import { IModal, Modal } from '../../components';
-/**
- * Modal service class
- */
-export declare class ModalService {
-    /**
-     * Modals collection
-     */
-    static modals: Modal[];
-    /**
-     * Creates a new modal instance
-     * @param modal modal structure
-     */
-    static create(modal: IModal): Modal;
-    /**
-     * Creates a new modal instance from JSON
-     * @param modal modal structure
-     */
-    static createFromJson(modalPath: string, local?: boolean, JSONCache?: boolean): Promise<Modal>;
-    /**
-     * Creates a new modal instance from JSON
-     * @param modal modal structure
-     */
-    static createFromJsonPost(modalPath: string, params?: object): Promise<Modal>;
-    /**
-     * Deletes modal
-     * @param modal modal instance
-     */
-    static delete(modal: Modal): void;
-    /**
-     * Closes modal by name
-     */
-    static closeByName(name: string): void;
-    /**
-     * Gets a modal by name
-     * @param name modal name
-     */
-    static getModal(name: string): Modal | undefined;
-}

package/dist/types/utils/data-value-out/data-value-out.d.ts

@@ -1,5 +0,0 @@
-import { ISelectDataValueOut } from './interfaces';
-export declare class DataValueOutHelper {
-    private static getFormParent;
-    static setDataValueOut(select: ISelectDataValueOut, value: any): void;
-}

package/dist/types/utils/data-value-out/index.d.ts

@@ -1,2 +0,0 @@
-export * from './interfaces';
-export * from './data-value-out';

package/dist/types/utils/data-value-out/interfaces.d.ts

@@ -1,8 +0,0 @@
-export interface ISelectDataValueOutItem {
-    column: string;
-    columnOnForm: string;
-}
-export interface ISelectDataValueOut {
-    dataValueOut?: ISelectDataValueOutItem[];
-    dataValueOutFormName?: string;
-}

package/dist/types/utils/datasource-searcher/datasource-searcher.d.ts

@@ -1,6 +0,0 @@
-import { Datasource, IDictionary } from '@zeedhi/core';
-import { IDatasourceSearcher, SearchParam } from './interfaces';
-export declare class DatasourceSearcher implements IDatasourceSearcher {
-    private dsSearch;
-    search(datasource: Datasource, searchValue: string | number | (string | number)[], searchIn: string, searchParam: SearchParam): Promise<IDictionary[]>;
-}

package/dist/types/utils/datasource-searcher/index.d.ts

@@ -1,2 +0,0 @@
-export * from './datasource-searcher';
-export * from './interfaces';

package/dist/types/utils/datasource-searcher/interfaces.d.ts

@@ -1,5 +0,0 @@
-import { Datasource, IDictionary } from '@zeedhi/core';
-export type SearchParam = 'SEARCH' | 'FILTER' | 'FIND' | 'DYNAMIC_FILTER';
-export interface IDatasourceSearcher {
-    search(datasource: Datasource, search: string | number | (string | number)[], searchIn: string, searchParam: SearchParam): Promise<IDictionary[]>;
-}

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

@@ -1,24 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-export declare class Icons {
-    private static mdiIcons;
-    private static faIcons;
-    private static icons;
-    /**
-     * Replace all the icons
-     * @param icons icons to be set
-     */
-    static setIcons(icons: IDictionary<string>): void;
-    /**
-     * Add icons, replacing default values
-     * @param icons icons to be added
-     */
-    static addIcons(icons: IDictionary<string>): void;
-    /**
-     * @param library defines the icon library that will be used
-     */
-    static changeIconLibrary(library?: string): void;
-    /**
-     * Get icons object
-     */
-    static getIcons(): IDictionary<string>;
-}

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

@@ -1,7 +0,0 @@
-export * from './theme/theme';
-export * from './icons/icons';
-export * from './data-value-out';
-export * from './unique-by/unique-by';
-export * from './datasource-searcher';
-export * from './omit/omit';
-export * from './tree-data-structure';

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

@@ -1,11 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-/**
- * Removes a property from an object, returning the resulting object without
- * the property
- * @param obj object
- * @param key property to be removed
- * @returns object without said property
- */
-export declare const omit: (obj: IDictionary, key: string) => {
-    [key: string]: any;
-};

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

@@ -1,34 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-interface ThemeBase {
-    defaultTheme: string;
-    variations: {
-        colors: string[];
-        lighten: number;
-        darken: number;
-    };
-    themes: IDictionary<{
-        dark?: boolean;
-        colors: IDictionary<string>;
-    }>;
-}
-/**
- * Interface for the default Zeedhi Theme definition
- */
-interface IDefaultTheme extends ThemeBase {
-    minifyTheme: (css: string) => string;
-    zeedhi: IDictionary<IDictionary<string>>;
-}
-/**
- * Interface for the Theme defined in the app
- */
-export interface ITheme extends Partial<IDefaultTheme> {
-    cspNonce?: string;
-}
-/**
- * Interface for the Theme to be returned by initTheme
- */
-interface IMaterialTheme extends ThemeBase {
-    cspNonce?: string;
-}
-declare const initTheme: (theme?: ITheme) => IMaterialTheme;
-export { initTheme };

package/dist/types/utils/tree-data-structure/index.d.ts

@@ -1,2 +0,0 @@
-export * from './tree-data-structure';
-export * from './interfaces';

package/dist/types/utils/tree-data-structure/interfaces.d.ts

@@ -1,30 +0,0 @@
-import { Datasource, IDictionary } from '@zeedhi/core';
-export interface ITreeComponent {
-    datasource: Datasource;
-    parentField: string;
-    openLevelOnLoad: number | boolean;
-    fetchOnDemand?: boolean;
-    detach?: boolean;
-    fieldHasChild?: string;
-}
-export interface ITreeDataStructure {
-    openLevelOnLoad: number | boolean;
-    fetchOnDemand: boolean;
-    detach?: boolean;
-    fieldHasChild?: string;
-    treeData: IDictionary<any>[];
-    searchHasNoData: boolean;
-    getChildren(row: IDictionary<any>): IDictionary<any>[];
-    buildTree(): void;
-    findDataIndex(data: IDictionary<any>[], value: any): number;
-    getParentRow(row: IDictionary): IDictionary;
-    resetTree(): void;
-    navigateToggle(collapse: boolean): void;
-    toggleExpand(row: IDictionary<any>, rowIndex?: number): Promise<IDictionary<any>[] | undefined>;
-    isOpened(row: IDictionary<any>): boolean;
-    clearRow(row: IDictionary): IDictionary;
-    hasChildOnDemand(row: IDictionary): boolean;
-    initialize(): void;
-    previousOpenedRow(rowIdx: number): number;
-    nextOpenedRow(rowIdx: number): number;
-}

package/dist/types/utils/tree-data-structure/tree-data-structure.d.ts

@@ -1,155 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { ITreeComponent, ITreeDataStructure } from './interfaces';
-export declare class TreeDataStructure implements ITreeDataStructure {
-    /**
-     * Original datasource
-     */
-    private originalDatasource;
-    /**
-     * Parent field Name
-     */
-    private parentField;
-    /**
-     * Defines if the tree will be opened or not (true/false) or if it should open only until a specific level
-     */
-    openLevelOnLoad: number | boolean;
-    /**
-     * Stores tree data
-     */
-    treeData: IDictionary<any>[];
-    /**
-     * Search returns no data
-     */
-    searchHasNoData: boolean;
-    /**
-     * Stores tree structure
-     */
-    private treeStructure;
-    fieldHasChild?: string;
-    /**
-     * Tree component
-     */
-    private tree;
-    constructor(tree: ITreeComponent);
-    detach?: boolean | undefined;
-    get fetchOnDemand(): boolean;
-    set fetchOnDemand(value: boolean);
-    /**
-     * Creates properties and methods
-     */
-    initialize(): void;
-    private searchValue;
-    /**
-     * Redefine get method
-     * @param originalGet originalDatasource get function
-     */
-    private treeGetData;
-    /**
-     * search data
-     */
-    buildTree(): void;
-    /**
-     * Build tree without fetchOnDemand
-     * @param data datasource data
-     */
-    private buildAllData;
-    /**
-     * Build tree data using a parent row
-     * @param parentRow Parent row (undefined = build entire tree)
-     */
-    private buildTreeData;
-    findDataIndex(data: IDictionary<any>[], value: any): number;
-    /**
-     * Build tree with fetchOnDemand
-     */
-    private buildOnDemand;
-    /**
-     * Sort data
-     */
-    private sortData;
-    /**
-     * Sort tree data rows
-     * @param dataToSort Data to sort
-     * @param columns Columns used to oreder the collection
-     * @param types Order orientation. All values must be asc or desc
-     * @param index Columns and types position
-     * @returns Sorted data
-     */
-    private sortTreeDataRows;
-    /**
-     * Custom sort for collections
-     * @param row Collection row
-     * @param nextRow Next row from collection
-     * @param columns Columns used to oreder the collection
-     * @param types Order orientation. All values must be asc or desc
-     * @param index Columns and types position
-     * @returns Row's position
-     */
-    private sort;
-    /**
-     * Return if tree element and its parents are opened
-     * @param row datasource row
-     * @returns Element and parents are opened
-     */
-    isOpened(row: IDictionary<any>): boolean;
-    /**
-     * Return previous opened row index
-     * @param rowIdx row index
-     * @returns previous row index
-     */
-    previousOpenedRow(rowIdx: number): number;
-    /**
-     * Return next opened row index
-     * @param rowIdx row index
-     * @returns next row index
-     */
-    nextOpenedRow(rowIdx: number): number;
-    /**
-     * Expands or collapses a row
-     * @param row Row object
-     * @param rowIndex Row index
-     */
-    toggleExpand(row: IDictionary<any>, rowIndex?: number): Promise<IDictionary<any>[] | undefined>;
-    /**
-     * Return row with tree data
-     * @param row datasource row
-     */
-    getRowData(row: IDictionary<any>): IDictionary<any>;
-    /**
-     * Toggle expand/collapse using navigation keys
-     * @param collapse Should collapse
-     */
-    navigateToggle(collapse: boolean): void;
-    /**
-     * Updates selected rows, fetches and retrieves data collection
-     * @returns Promise with data collection
-     */
-    private reloadAndUpdateSelectedRows;
-    /**
-     * Arrange treeData in a uniform structure
-     */
-    buildDetached(): void;
-    /**
-     * Search value against a memory datasource
-     */
-    private searchAllData;
-    /**
-     * Clear row removing 'tree__' props
-     */
-    clearRow(row: IDictionary<any>): {
-        [x: string]: any;
-    };
-    /**
-     * Get all children
-     * @param row datasource row
-     */
-    getChildren(row: IDictionary<any>): IDictionary<any>[];
-    /**
-     * Checks if a row has async children that are yet to be loaded
-     * @param row
-     * @returns `false` if the row has no children to be loaded, `true` if it does or if fieldHasChild is not defined
-     */
-    hasChildOnDemand(row: IDictionary<any>): boolean;
-    getParentRow(row: IDictionary): IDictionary;
-    resetTree(): void;
-}

package/dist/types/utils/unique-by/unique-by.d.ts

@@ -1,3 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-declare const uniqueBy: (a: IDictionary[], key: string) => IDictionary<any>[];
-export { uniqueBy };