@zeedhi/common 1.109.0 → 1.110.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeedhi/common",
-  "version": "1.109.0",
+  "version": "1.110.0",
   "description": "Zeedhi Common",
   "author": "Zeedhi <zeedhi@teknisa.com>",
   "license": "ISC",
@@ -43,5 +43,5 @@
     "lodash.times": "4.3.*",
     "mockdate": "3.0.*"
   },
-  "gitHead": "1f4ffbc7dac5b71cff4065c5956921405a362085"
+  "gitHead": "fc3c2ff25bee46c565577b6749a4d0539762407f"
 }

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

@@ -59,6 +59,7 @@ export declare class GridEditable extends Grid implements IGridEditable {
     protected addCancelColumn(): void;
     protected getCancelColumnProps(): IGridColumnEditable;
     protected instantiateCancelColumn(): GridColumnEditable;
+    protected registerDatasourceCallback(): void;
     protected createGridController(): void;
     /**
      * Changes column order
@@ -140,6 +141,7 @@ export declare class GridEditable extends Grid implements IGridEditable {
      * If the row[column.name] has a selected value, pushes it
      */
     private checkLookupData;
+    private pushLookupRow;
     private checkCompValidity;
     /**
      * change event of editable components
@@ -164,6 +166,8 @@ export declare class GridEditable extends Grid implements IGridEditable {
      */
     isValid(column: IGridColumnEditable, row: IDictionary, revalidate?: boolean): string | boolean;
     private newRowIdentifier;
+    private positionIdentifier;
+    private pageIdentifier;
     /**
      * Cancels all edited rows and enable grid components
      */
@@ -205,7 +209,17 @@ export declare class GridEditable extends Grid implements IGridEditable {
      * @param position whether the new Row will be inserted at the beginning or end of the data array
      */
     addNewRow(row: IDictionary, position?: 'end' | 'start'): Promise<void>;
+    /**
+     * Saves a row reference in editedRows and addedRows
+     * @param row Row to be saved
+     */
     protected saveRowReference(row: IDictionary<any>): void;
+    /**
+     * Inserts a row in datasource depending on the position
+     * @param row Row to be inserted
+     * @param position Position, 'end' or 'start'
+     * @returns the data containing the newly added row
+     */
     protected insertRowInDatasource(row: IDictionary<any>, position: 'end' | 'start'): IDictionary<any>[];
     /**
      * Gets the editable component name

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

@@ -89,4 +89,9 @@ export declare class Column extends Component implements IColumn {
      */
     applyActionCondition(row: IDictionary<any>): IDictionary<IDictionary<any>>;
     onBeforeDestroy(): void;
+    /**
+     * Retrieves a row from lookup using its key
+     * @returns the row object when found, null when it is not found or empty
+     */
+    getLookupRow(value: any): IDictionary | null;
 }

package/types/components/zd-select-multiple/select-multiple.d.ts

@@ -26,6 +26,7 @@ export declare class SelectMultiple extends Select implements ISelectMultiple {
     limit: number | null;
     showSelectAll: boolean;
     showCheckboxAll: boolean;
+    protected formatterFn: Function;
     /**
      * Create a new Select.
      * @param props Select properties
@@ -78,10 +79,6 @@ export declare class SelectMultiple extends Select implements ISelectMultiple {
      * Removes unselected inserts from datasource
      */
     private removeInserts;
-    /**
-     * Return formatted dataText and values
-     */
-    formatter(value: IDictionary<any>[]): any;
     /**
      * Returns the text shown when there's one or more selected items that doesn't fit in the input
      */

package/types/components/zd-select-tree/interfaces.d.ts

@@ -11,6 +11,7 @@ export interface ISelectTreeNode<T> {
     isDefaultExpanded?: boolean;
     children?: ISelectTreeNode<T>[] | null;
     row?: IDictionary<any>;
+    isMatched?: boolean;
 }
 export interface ISelectTree extends ITextInput, ISelectDataValueOut {
     nodes?: ISelectTreeNode<IDictionary>[];

package/types/components/zd-select-tree/select-tree.d.ts

@@ -116,11 +116,20 @@ export declare class SelectTree extends TextInput implements ISelectTree {
      * Defines the name of the form target to set using dataValueOut
      */
     dataValueOutFormName: string;
+    private discreteProps?;
+    protected formatterFn: Function;
     /**
      * Creates a new instance of SelectTree
      * @param props
      */
     constructor(props: ISelectTree);
+    /**
+     * Returns the currentRow in the dataText key
+     */
+    formatter(value?: string | IDictionary<any>, props?: {
+        dataText: string | any[];
+        dataTextSeparator: string;
+    }): any;
     focus(event: Event, element: any): Promise<void>;
     protected afterFocus(): Promise<void>;
     private createDataStructure;
@@ -128,7 +137,6 @@ export declare class SelectTree extends TextInput implements ISelectTree {
     createNodesFromDatasource(buildTree?: boolean): void;
     private createNodeFromRow;
     private createChildrenNodes;
-    private formatRow;
     /**
      * Triggered when the menu opens
      */
@@ -142,6 +150,7 @@ export declare class SelectTree extends TextInput implements ISelectTree {
      */
     select(node: ISelectTreeNode<IDictionary>, element?: any): void;
     private savedNodes?;
+    search: string;
     /**
      * Triggered after the search query changes
      */

package/types/components/zd-select-tree-multiple/select-tree-multiple.d.ts

@@ -1,6 +1,7 @@
 import { IDictionary } from '@zeedhi/core';
 import { SelectTree } from '../zd-select-tree/select-tree';
 import { ISelectTreeMultiple, ISelectTreeMultipleNode, ISelectTreeMultipleEvents } from './interfaces';
+import { ISelectTreeNode } from '../zd-select-tree/interfaces';
 /**
  * Base class for Select Tree Multiple component.
  */
@@ -46,11 +47,41 @@ export declare class SelectTreeMultiple extends SelectTree implements ISelectTre
     get value(): any;
     set value(value: any);
     setValue(value: any): void;
-    getAllNodes(nodes?: import("..").ISelectTreeNode<IDictionary<any>>[]): import("..").ISelectTreeNode<IDictionary<any>>[];
+    /**
+     * Retrieves all nodes in the tree as a flat array. Nodes that are not matched are excluded
+     * Nodes that are not matched but whose parent is matched are included
+     * @param nodes
+     * @param matched defines whether the parent of the current node branch is matched
+     * @returns all nodes in the tree as a flat array, filtering unmatched nodes
+     */
+    getAllNodes(nodes?: ISelectTreeNode<IDictionary<any>>[], matched?: boolean): ISelectTreeNode<IDictionary<any>>[];
     /**
      * Dispatches select/unselect event
      */
-    onSelectAll(isSelected: boolean, event: Event, element: any): void;
-    selectAllItems(): void;
-    unSelectAllItems(): void;
+    onSelectAll(isSelected: boolean, event: Event, element: any, nodes?: ISelectTreeNode<IDictionary<any>>[]): void;
+    /**
+     * Selects all items in the tree \
+     * If the component is fetchOnDemand, it will select all values from datasource.data \
+     * If not, it will select all nodes from the tree, unless the nodes to be selected are specified
+     * @param nodes nodes to be selected. These are the nodes that are currently visible in the tree
+     * (if the user is searching, selects only the searched nodes)
+     * @returns
+     */
+    selectAllItems(nodes?: ISelectTreeNode<IDictionary<any>>[]): void;
+    /**
+     * Unelects all items in the tree \
+     * If the component is fetchOnDemand, it will select all values from datasource.data \
+     * If not, it will select all nodes from the tree, unless the nodes to be selected are specified
+     * @param nodes nodes to be selected. These are the nodes that are currently visible in the tree
+     * (if the user is searching, selects only the searched nodes)
+     * @returns
+     */
+    unSelectAllItems(nodes?: ISelectTreeNode<IDictionary<any>>[]): void;
+    /**
+     * Takes two arrays and creates a map of the unique values
+     * @returns map of a merge between the two arrays, removing duplicates
+     */
+    private createMergeMap;
+    getValueIds(): any;
+    getValueAsObject(): any;
 }

package/types/formatters/column-zdselect.d.ts

@@ -0,0 +1 @@
+export {};

package/types/formatters/column-zdselectmultiple.d.ts

@@ -0,0 +1 @@
+export {};

package/types/formatters/index.d.ts

@@ -0,0 +1,2 @@
+import './column-zdselect';
+import './column-zdselectmultiple';

package/types/index.d.ts

@@ -2,4 +2,5 @@ declare const AutoNumeric: any;
 export * from './components';
 export * from './services';
 export * from './utils';
+export * from './formatters';
 export { AutoNumeric };

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

@@ -1,15 +1,15 @@
 import { IDictionary } from '@zeedhi/core';
 import { IColumn } from '../../../components';
-import { IReportType, MetadataColumn, MetadataFilter } from './interfaces';
+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 getColumnsWidth(columns: IColumn[]): {
-        widths: IDictionary<number>;
-        totalWidth: number;
-    };
-    protected buildColumns(columns: IColumn[]): MetadataColumn;
     protected buildFilter(filter: IDictionary, columns: IColumn[]): MetadataFilter;
     protected formatLangCode(lang?: string): string;
     protected expressionZeedhiToXls: any;

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

@@ -2,6 +2,7 @@ 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/interfaces.d.ts

@@ -45,3 +45,35 @@ export interface IMetadataObj {
     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,11 +1,13 @@
 import { IDictionary } from '@zeedhi/core';
 import { IColumn } from '../../../components';
 import { BaseReport } from './base-report';
-import { MetadataColumn } from './interfaces';
+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;
-    protected buildColumns(columns: IColumn[]): MetadataColumn;
     private getFormatOfColumn;
     private isNumberComponent;
     private checkAccessor;

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

@@ -0,0 +1,9 @@
+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

@@ -2,6 +2,7 @@ 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;

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

@@ -3,6 +3,7 @@ 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>;

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

@@ -3,6 +3,7 @@ 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>;

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

@@ -1,5 +1,6 @@
 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;
@@ -12,6 +13,6 @@ export declare class Report implements IReport {
     private isToggleableComponent;
     private getData;
     private getReportType;
-    getReport(type: string, portrait?: boolean, rowObj?: any, beforeReportEvent?: IBeforeReportEvent): Promise<string>;
+    getReport(type: string, portrait?: boolean, rowObj?: any, beforeReportEvent?: IBeforeReportEvent, labelFormatter?: LabelFormatter): Promise<string>;
     private filterColumns;
 }