@zeedhi/common 1.112.0 → 3.0.0

package/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/types/utils/data-value-out/index.d.ts

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

package/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/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/types/utils/index.d.ts

@@ -1,6 +0,0 @@
-export * from './icons/icons';
-export * from './themes/themes';
-export * from './watch-url/watch-url';
-export * from './report';
-export * from './tree-data-structure';
-export * from './data-value-out';

package/types/utils/report/dataset-formatters/grouped-pdf-formatter.d.ts

@@ -1,47 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-declare type GroupHeader = {
-    group: boolean;
-    groupRow: IDictionary;
-    groupColumnName: string;
-    groupHeader: boolean;
-    groupIndex: number;
-    groupLabel: string;
-    groupValue: number | string;
-    groupOpened: boolean;
-    groupHeaders: GroupHeader[];
-    children: IDictionary[];
-};
-declare type GroupFooter = {
-    groupFooter: boolean;
-    groupIndex: number;
-    groupHeaders: GroupHeader[];
-    groupLabel: string;
-    groupValue: number | string;
-    groupSummary?: boolean;
-    [key: string]: any;
-};
-declare type DataItem = IDictionary & {
-    groupHeaders?: GroupHeader[];
-};
-export declare type InputDataEntry = GroupHeader | DataItem | GroupFooter;
-declare type OutputGroupData = {
-    __group: boolean;
-    __groupHeader?: boolean;
-    __groupFooter?: boolean;
-    __groupIndex: number;
-    __groupLabel: string;
-    __groupValue: string;
-    __groupOpened?: boolean;
-    __groupSummary?: boolean;
-    [key: string]: any;
-};
-export declare type OutputDataEntry = OutputGroupData | IDictionary;
-/**
- * Class used to format grouped data into the ZhReports format
- */
-export declare class GroupedPDFFormatter {
-    format(data: InputDataEntry[]): OutputDataEntry[];
-    isGroupHeader(entry: InputDataEntry): entry is GroupHeader;
-    isGroupFooter(entry: InputDataEntry): entry is GroupFooter;
-}
-export {};

package/types/utils/report/dataset-formatters/index.d.ts

@@ -1 +0,0 @@
-export * from './grouped-pdf-formatter';

package/types/utils/report/errors/empty-data-error.d.ts

@@ -1,6 +0,0 @@
-/**
- * Empty data error
- */
-export declare class EmptyDataError extends Error {
-    constructor();
-}

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

@@ -1,10 +0,0 @@
-export * from './report';
-export * from './interfaces';
-export * from './report-type/csv-report';
-export * from './report-type/pdf-report';
-export * from './report-type/xls-report';
-export * from './report-type/xls2-report';
-export * from './report-type/xls3-report';
-export * from './report-type/interfaces';
-export * from './dataset-formatters';
-export * from './errors/empty-data-error';

package/types/utils/report/interfaces.d.ts

@@ -1,15 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-export interface IReport {
-    title: string;
-    data?: IDictionary[];
-    endPoint: string;
-    fileEndPoint: string;
-    getReport(type: string, portrait: boolean): Promise<string>;
-}
-export interface IBeforeReportParam {
-    dataSet: any;
-    filter: any;
-    metaData: any;
-    [key: string]: any;
-}
-export declare type IBeforeReportEvent = (param: IBeforeReportParam) => Promise<IBeforeReportParam>;

package/types/utils/report/report-type/base-report.d.ts

@@ -1,17 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { IColumn } from '../../../components';
-import { IReportType, MetadataFilter, LabelFormatter } from './interfaces';
-import { ReportColumnTransformer } from './report-column-transformer';
-export declare abstract class BaseReport implements IReportType {
-    reportColumnTransformer: ReportColumnTransformer;
-    constructor(labelFormatter?: LabelFormatter);
-    protected getReportColumnTransformer(labelFormatter?: LabelFormatter): ReportColumnTransformer;
-    abstract getFileType(): string;
-    abstract route: string;
-    abstract buildDataset(data: IDictionary<any>[], metadata?: any): any;
-    abstract buildMetadata(name: string, title: string, columns: IColumn[], filter?: IDictionary<any>, portrait?: boolean): Promise<any>;
-    protected buildFilter(filter: IDictionary, columns: IColumn[]): MetadataFilter;
-    protected formatLangCode(lang?: string): string;
-    protected expressionZeedhiToXls: any;
-    protected colunmXLS: string;
-}

package/types/utils/report/report-type/csv-report.d.ts

@@ -1,9 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { IColumn } from '../../../components';
-import { BaseReport } from './base-report';
-export declare class CSVReport extends BaseReport {
-    getFileType(): string;
-    readonly route: string;
-    buildDataset(data: IDictionary<any>[], columns: IColumn[]): string;
-    buildMetadata(name: string, title: string, columns: IColumn[], filter?: IDictionary<any>): Promise<string>;
-}

package/types/utils/report/report-type/index.d.ts

@@ -1,5 +0,0 @@
-export * from './csv-report';
-export * from './pdf-report';
-export * from './xls-report';
-export * from './base-report';
-export * from './interfaces';

package/types/utils/report/report-type/interfaces.d.ts

@@ -1,79 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { IColumn } from '../../../components';
-export interface IReportType {
-    readonly route: string;
-    type?: string;
-    buildDataset(data: IDictionary[], metadata: any): any;
-    buildDataset(data: IDictionary[], metadata?: any, columns?: IColumn[]): any;
-    buildMetadata(name: string, title: string, columns: IColumn[], filter?: IDictionary, portrait?: boolean): Promise<any>;
-}
-export declare type MetadataColumn = IDictionary<{
-    align: string;
-    description: string;
-    sequence: number;
-    size: string;
-    expression?: string;
-    xlsType?: string;
-}>;
-export declare type MetadataFilter = {
-    label: string;
-    value: string;
-}[];
-export interface IMetadataObj {
-    clientLogo: string;
-    enterpriseLogo: string;
-    productLogo: string;
-    columns: MetadataColumn;
-    filter: MetadataFilter;
-    lang: string;
-    name: string;
-    reportName: string;
-    title: string;
-    widgetLabel: string;
-    orientation: 'PORTRAIT' | 'LANDSCAPE';
-    version: '1.0';
-    words: {
-        Page: string;
-        Report: string;
-        Version: string;
-    };
-    staticData: {};
-    groups: Array<any>;
-    reportXLS?: boolean;
-    formatXLS?: 'F1' | 'F2' | 'F3';
-    type?: string;
-    xlsMergedCell?: any[];
-    xlsDefaultType?: string;
-}
-export declare type ReportFixFormat = {
-    type: 'fix';
-    params: {
-        mask: string;
-    };
-};
-export declare type ReportCurrencyFormat = {
-    type: 'currency';
-    symbol: string;
-    decimal: string;
-    thousands: string;
-    precision: number;
-};
-export declare type ReportNumberFormat = {
-    params: {
-        decimal: string;
-        thousands: string;
-        precision: number;
-    };
-};
-export declare type ReportFormat = ReportFixFormat | ReportCurrencyFormat | ReportNumberFormat;
-export declare type GetFormatFn = (col: IColumn) => ReportFormat;
-export declare type LabelFormatterParams = {
-    column: IColumn;
-    fileType: string;
-};
-export declare type LabelFormatter = ({ column, fileType }: LabelFormatterParams) => string;
-export declare type ReportColumnTransformerParams = {
-    getFormatFn?: GetFormatFn;
-    labelFormatter?: LabelFormatter;
-    fileType: string;
-};

package/types/utils/report/report-type/pdf-report.d.ts

@@ -1,16 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { IColumn } from '../../../components';
-import { BaseReport } from './base-report';
-import { LabelFormatter } from './interfaces';
-import { ReportColumnTransformer } from './report-column-transformer';
-export declare class PDFReport extends BaseReport {
-    getFileType(): string;
-    readonly route: string;
-    protected getReportColumnTransformer(labelFormatter?: LabelFormatter): ReportColumnTransformer;
-    buildDataset(data: IDictionary<any>[]): string;
-    private getFormatOfColumn;
-    private isNumberComponent;
-    private checkAccessor;
-    buildMetadata(name: string, title: string, columns: IColumn[], filter?: IDictionary<any>, portrait?: boolean): Promise<string>;
-    private toDataURL;
-}

package/types/utils/report/report-type/report-column-transformer.d.ts

@@ -1,9 +0,0 @@
-import { MetadataColumn, ReportColumnTransformerParams } from './interfaces';
-export declare class ReportColumnTransformer {
-    private getFormatFn?;
-    private labelFormatter?;
-    private fileType;
-    constructor({ getFormatFn, labelFormatter, fileType }: ReportColumnTransformerParams);
-    private getColumnsWidth;
-    transform(columns: any[]): MetadataColumn;
-}

package/types/utils/report/report-type/xls-report.d.ts

@@ -1,10 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { IColumn } from '../../../components';
-import { BaseReport } from './base-report';
-export declare class XLSReport extends BaseReport {
-    getFileType(): string;
-    readonly route: string;
-    buildDataset(data: IDictionary<any>[], columns: IColumn[]): string;
-    private formatRawDataSet;
-    buildMetadata(name: string, title: string, columns: IColumn[], filter?: IDictionary<any>): Promise<string>;
-}

package/types/utils/report/report-type/xls2-report.d.ts

@@ -1,17 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { IColumn } from '../../../components';
-import { BaseReport } from './base-report';
-import { IMetadataObj } from './interfaces';
-export declare class XLS2Report extends BaseReport {
-    getFileType(): string;
-    readonly route: string;
-    buildDataset(data: IDictionary<any>[], metadata: IMetadataObj): string;
-    buildMetadata(name: string, title: string, columns: IColumn[], filter?: IDictionary<any>): Promise<string>;
-    private getColumnsName;
-    private initVars;
-    private formatRowFunc;
-    private setRowGroup;
-    private setIndexGroups;
-    private setRowNormal;
-    formatDataSet(metaData: IMetadataObj, dataSet: IDictionary[]): any[][];
-}

package/types/utils/report/report-type/xls3-report.d.ts

@@ -1,17 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { IColumn } from '../../../components';
-import { BaseReport } from './base-report';
-import { IMetadataObj } from './interfaces';
-export declare class XLS3Report extends BaseReport {
-    getFileType(): string;
-    readonly route: string;
-    buildDataset(data: IDictionary<any>[], metadata: IMetadataObj): string;
-    buildMetadata(name: string, title: string, columns: IColumn[], filter?: IDictionary<any>): Promise<string>;
-    private getColumnsNameFormat3;
-    private initVars;
-    private setRowGroupFormat;
-    private formatRowFunc;
-    private setIndexGroups;
-    private setRowNormal;
-    formatDataSet(metaData: IMetadataObj, dataSet: IDictionary[]): string[][];
-}

package/types/utils/report/report.d.ts

@@ -1,18 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { Iterable } from '../../components';
-import { LabelFormatter } from './report-type';
-import { IBeforeReportEvent, IReport } from './interfaces';
-export declare class Report implements IReport {
-    iterable: Iterable;
-    title: string;
-    data?: IDictionary[];
-    endPoint: string;
-    fileEndPoint: string;
-    constructor(iterable: Iterable, title: string);
-    private formatToggleable;
-    private isToggleableComponent;
-    private getData;
-    private getReportType;
-    getReport(type: string, portrait?: boolean, rowObj?: any, beforeReportEvent?: IBeforeReportEvent, labelFormatter?: LabelFormatter): Promise<string>;
-    private filterColumns;
-}

package/types/utils/themes/themes.d.ts

@@ -1,71 +0,0 @@
-declare const initTheme: (theme?: any) => {
-    dark: boolean;
-    options: {
-        customProperties: boolean;
-        minifyTheme: (css: string) => string;
-    };
-    themes: {
-        light: {
-            primary: string;
-            secondary: string;
-            accent: string;
-            error: string;
-            info: string;
-            success: string;
-            warning: string;
-            anchor: string;
-            grey: string;
-        };
-        dark: {
-            primary: string;
-            secondary: string;
-            accent: string;
-            error: string;
-            info: string;
-            success: string;
-            warning: string;
-            anchor: string;
-            grey: string;
-        };
-    };
-    zeedhi: {
-        light: {
-            'font-color': string;
-            'background-base': string;
-            'background-base-2': string;
-            'background-base-3': string;
-            'scrollbar-track': string;
-            'scrollbar-thumb': string;
-            'badge-background-color': string;
-            'badge-text-color': string;
-        };
-        dark: {
-            'font-color': string;
-            'background-base': string;
-            'background-base-2': string;
-            'background-base-3': string;
-            'scrollbar-track': string;
-            'scrollbar-thumb': string;
-            'badge-background-color': string;
-            'badge-text-color': string;
-        };
-        variables: {
-            'default-padding': string;
-            'font-headline-size': string;
-            'font-headline-weight': string;
-            'font-title-size': string;
-            'font-title-weight': string;
-            'font-body1-size': string;
-            'font-body1-weight': string;
-            'font-body2-size': string;
-            'font-body2-weight': string;
-            'font-body3-size': string;
-            'font-body3-weight': string;
-            'font-body4-size': string;
-            'font-body4-weight': string;
-            'font-caption-size': string;
-            'font-caption-weight': string;
-        };
-    };
-};
-export { initTheme };

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

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

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

@@ -1,9 +0,0 @@
-import { Datasource } from '@zeedhi/core';
-export interface ITreeDataStructure {
-    datasource: Datasource;
-    parentField: string;
-    openLevelOnLoad: number | boolean;
-    fetchOnDemand: boolean;
-    detach?: boolean;
-    fieldHasChild?: string;
-}

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

@@ -1,152 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { ITreeDataStructure } from './interfaces';
-export declare class TreeDataStructure {
-    /**
-     * 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: ITreeDataStructure);
-    get fetchOnDemand(): boolean;
-    set fetchOnDemand(value: boolean);
-    /**
-     * Creates properties and methods
-     */
-    private init;
-    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;
-}

package/types/utils/watch-url/watch-url.d.ts

@@ -1,59 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-declare type UpdateFunction = (queryValue: string | (string | null)[], component: any) => any;
-declare type Watchers = IDictionary<{
-    name: string;
-    prop: string;
-    updateFn?: UpdateFunction;
-}[]>;
-/**
- * WatchURL util
- */
-export declare class WatchURL {
-    static watchers: Watchers;
-    static unregisterAfterEach: Function;
-    private static originalEvents;
-    /**
-     * Update components based on query parameter values
-     */
-    static updateWatchers(): void;
-    /**
-     * Register a new watcher
-     * @param name component name
-     * @param param query parameter name
-     * @param updateFn false function to be called when query parameter changes
-     * @param replace call router replace when component value changes
-     * @param prop component property to be updated
-     */
-    static registerWatcher(name: string, param: string, updateFn?: UpdateFunction, replace?: boolean, prop?: string): void;
-    /**
-     * Gets the change event to replace component's event
-     */
-    private static getWatcherEvent;
-    /**
-     * Updates query parameters
-     */
-    private static updateQuery;
-    /**
-     * Updates component property
-     */
-    private static updateComponent;
-    /**
-     * Destroys a watcher
-     * @param name component name
-     */
-    static destroyWatcher(name: string): void;
-    /**
-     * Destroy all watchers
-     */
-    static destroyWatchers(): void;
-    /**
-     * Resets component change event to it's original value
-     */
-    private static resetEvent;
-    /**
-     * Returns a watcher by component name
-     * @param name component name
-     */
-    static getWatcher(name: string): Watchers | null;
-}
-export {};