@sme.up/ketchup 4.3.0-SNAPSHOT → 5.1.0-SNAPSHOT

package/dist/types/components/kup-tree/kup-tree-declarations.d.ts

@@ -1,6 +1,6 @@
-import { GenericObject, KupEventPayload } from '../../types/GenericTypes';
+import { KupDataCell, KupDataColumn, KupDataNode, KupDataRow } from '../../managers/kup-data/kup-data-declarations';
+import { GenericMap, KupEventPayload } from '../../types/GenericTypes';
 import { KupCardEventPayload } from '../kup-card/kup-card-declarations';
-import { Cell, CellsHolder, Column, Row, RowAction } from './../kup-data-table/kup-data-table-declarations';
 /**
  * Props of the kup-tree component.
  * Used to export every prop in an object.
@@ -39,35 +39,11 @@ export declare enum KupTreeProps {
   totals = "Defines the current totals options.",
   useDynamicExpansion = "When the component must use the dynamic expansion feature to open its nodes, it means that not all the nodes of the tree have been passed inside the data property. Therefore, when expanding a node, the tree must emit an event (or run a given callback) and wait for the child nodes to be downloaded from the server."
 }
-/**
- * The name of the property used by the tree component to store whether a TreeNode is open or closed
- * @constant
- */
-export declare const treeExpandedPropName = "isExpanded";
-export interface TreeNode {
-  data?: GenericObject;
-  actions?: Array<RowAction>;
-  cells: CellsHolder;
-  children: Array<TreeNode>;
-  disabled: boolean;
-  expandable: boolean;
-  icon?: string;
+export interface KupTreeNode extends KupDataNode {
+  expandable?: boolean;
   iconColor?: string;
-  id?: string;
-  obj: {
-    t: string;
-    p: string;
-    k: string;
-  };
-  options?: boolean;
-  readOnly?: boolean;
-  style?: {
-    [index: string]: string;
-  };
-  value: string;
-  /** used for render or not render node (and children) while filtering */
+  style?: GenericMap;
   visible?: boolean;
-  [treeExpandedPropName]?: boolean;
 }
 export declare type TreeNodePath = number[];
 /**
@@ -80,10 +56,10 @@ export declare const treeMainColumnName = "TREE_COLUMN";
  */
 export interface KupTreeEventHandlerDetails {
   area: string;
-  cell: Cell;
-  column: Column;
+  cell: KupDataCell;
+  column: KupDataColumn;
   filterRemove: HTMLSpanElement;
-  row: Row;
+  row: KupDataRow;
   td: HTMLElement;
   th: HTMLElement;
   tr: HTMLTableRowElement;
@@ -94,7 +70,7 @@ export declare enum KupTreeExpansionMode {
 }
 export interface KupTreeNodeCollapseEventPayload extends KupEventPayload {
   treeNodePath: TreeNodePath;
-  treeNode: TreeNode;
+  treeNode: KupDataNode;
 }
 export interface KupTreeNodeExpandEventPayload extends KupTreeNodeCollapseEventPayload {
   usesDynamicExpansion?: boolean;
@@ -105,7 +81,7 @@ export interface KupTreeNodeSelectedEventPayload extends KupTreeNodeCollapseEven
   auto: boolean;
 }
 export interface KupTreeNodeButtonClickEventPayload extends KupTreeNodeCollapseEventPayload {
-  column: Column;
+  column: KupDataColumn;
   columnName: string;
   auto: boolean;
 }
@@ -119,6 +95,9 @@ export interface KupTreeColumnMenuEventPayload extends KupEventPayload {
 }
 export interface KupTreeDynamicMassExpansionEventPayload extends KupEventPayload {
   treeNodePath?: TreeNodePath;
-  treeNode?: TreeNode;
+  treeNode?: KupDataNode;
   expandAll?: boolean;
 }
+export interface KupTreeColumnRemoveEventPayload extends KupEventPayload {
+  column: KupDataColumn;
+}

package/dist/types/components/kup-tree/kup-tree-faker.d.ts

@@ -1,7 +1,7 @@
-import { Column } from './../kup-data-table/kup-data-table-declarations';
-import { TreeNode, TreeNodePath } from './kup-tree-declarations';
+import { KupDataColumn } from '../../managers/kup-data/kup-data-declarations';
+import { KupTreeNode, TreeNodePath } from './kup-tree-declarations';
 interface TreeRndNodeGetter {
-  selectedTreeNode: TreeNode | null;
+  selectedTreeNode: KupTreeNode | null;
   treeNodePath: TreeNodePath | null;
 }
 export interface FactoryTreeNodeOptions {
@@ -15,13 +15,13 @@ export interface DynamicExpansionFakerOptions {
   useDelay?: number;
 }
 export interface TreeConfigData {
-  columns: Column[];
-  data: TreeNode[];
+  columns: KupDataColumn[];
+  data: KupTreeNode[];
 }
 export declare function getRandomInteger(maximum?: number): number;
-export declare function getTreeNodeFromPath(treeNodes: TreeNode[], path: TreeNodePath): TreeNode | null;
-export declare function flattenTree(nodesToFlatten: TreeNode[], useIsExpandedFlag?: boolean): TreeNode[];
-export declare function getRndTreeNode(currentDepthTreeElements: TreeNode[], treeDepth: number): TreeRndNodeGetter;
+export declare function getTreeNodeFromPath(treeNodes: KupTreeNode[], path: TreeNodePath): KupTreeNode | null;
+export declare function flattenTree(nodesToFlatten: KupTreeNode[], useIsExpandedFlag?: boolean): KupTreeNode[];
+export declare function getRndTreeNode(currentDepthTreeElements: KupTreeNode[], treeDepth: number): TreeRndNodeGetter;
 /**
  * Function returning the columns and the data to create and initialize a kup-tree component.
  * @param treeDepth - How many subtree a tree can have.
@@ -46,8 +46,8 @@ export declare function DynamicExpansionFaker(treeDepth?: number, columnCount?:
   treeNode: FactoryTreeNodeOptions;
   dynamicExpansion?: DynamicExpansionFakerOptions;
 }): {
-  data: TreeNode[];
-  columns: Column[];
+  data: KupTreeNode[];
+  columns: KupDataColumn[];
   getTreeNodeChildren(nodePath?: TreeNodePath): Promise<unknown>;
   treeDataSource: TreeConfigData;
 };

package/dist/types/components/kup-tree/kup-tree.d.ts

@@ -1,11 +1,12 @@
 import { EventEmitter, JSX } from '../../stencil-public-runtime';
-import { Column, Row, TotalsMap } from './../kup-data-table/kup-data-table-declarations';
-import { TreeNode, TreeNodePath, KupTreeNodeCollapseEventPayload, KupTreeNodeExpandEventPayload, KupTreeNodeSelectedEventPayload, KupTreeNodeButtonClickEventPayload, KupTreeContextMenuEventPayload, KupTreeColumnMenuEventPayload, KupTreeDynamicMassExpansionEventPayload, KupTreeExpansionMode } from './kup-tree-declarations';
+import { TotalsMap } from './../kup-data-table/kup-data-table-declarations';
+import { TreeNodePath, KupTreeNodeCollapseEventPayload, KupTreeNodeExpandEventPayload, KupTreeNodeSelectedEventPayload, KupTreeNodeButtonClickEventPayload, KupTreeContextMenuEventPayload, KupTreeColumnMenuEventPayload, KupTreeDynamicMassExpansionEventPayload, KupTreeExpansionMode, KupTreeColumnRemoveEventPayload, KupTreeNode } from './kup-tree-declarations';
 import { KupTreeState } from './kup-tree-state';
 import { KupStore } from '../kup-state/kup-store';
 import { GenericFilter, KupGlobalFilterMode, ValueDisplayedValue } from '../../utils/filters/filters-declarations';
 import { GenericObject, KupEventPayload } from '../../types/GenericTypes';
 import { FCellPadding } from '../../f-components/f-cell/f-cell-declarations';
+import { KupDataColumn, KupDataDataset, KupDataRow } from '../../managers/kup-data/kup-data-declarations';
 export declare class KupTree {
   /**
    * References the root HTML element of the component (<kup-tree>).
@@ -34,7 +35,7 @@ export declare class KupTree {
   /**
    * The columns of the tree when tree visualization is active.
    */
-  columns?: Column[];
+  columns?: KupDataColumn[];
   /**
    * Custom style of the component.
    * @default ""
@@ -44,7 +45,7 @@ export declare class KupTree {
   /**
    * The json data used to populate the tree view: the basic, always visible tree nodes.
    */
-  data: TreeNode[];
+  data: KupTreeNode[];
   /**
    * The density of the rows, defaults at 'medium' and can also be set to 'dense' or 'wide'.
    */
@@ -60,7 +61,7 @@ export declare class KupTree {
    *
    * @see useDynamicExpansion
    */
-  dynamicExpansionCallback: (treeNodeToExpand: TreeNode, treeNodePath: TreeNodePath) => Promise<TreeNode[]> | undefined;
+  dynamicExpansionCallback: (treeNodeToExpand: KupTreeNode, treeNodePath: TreeNodePath) => Promise<KupTreeNode[]> | undefined;
   /**
    * When set to true, editable cells will be rendered using input components.
    * @default false
@@ -204,7 +205,7 @@ export declare class KupTree {
    */
   private resizeTimeout;
   /**
-   * Fired when a TreeNode gets collapsed (closed).
+   * Fired when a KupTreeNode gets collapsed (closed).
    */
   kupTreeNodeCollapse: EventEmitter<KupTreeNodeCollapseEventPayload>;
   /**
@@ -213,10 +214,10 @@ export declare class KupTree {
    * @event kup-tree-nodeexpand
    * @type {object}
    * @property {TreeNodePath} treeNodePath - The array of indexes to retrieve the current treeNode inside the data prop.
-   * @property {TreeNode} treeNode - Reference to the TreeNode data object which is being expanded (passed through the data prop).
+   * @property {KupTreeNode} treeNode - Reference to the KupTreeNode data object which is being expanded (passed through the data prop).
    * @property {boolean} usesDynamicExpansion - Flag to notify that the component is running in dynamicExpansion mode.
    * @property {boolean} dynamicExpansionRequireChildren - Flag to notify that the current dynamicExpansion event
-   *  requires the parent component to add TreeNode children to the given TreeNode.
+   *  requires the parent component to add KupTreeNode children to the given KupTreeNode.
    * @see useDynamicExpansion
    * @see dynamicExpansionCallback
    * @since 1.0.0
@@ -242,7 +243,11 @@ export declare class KupTree {
   kupDidUnload: EventEmitter<KupEventPayload>;
   kupTreeNodeDblClick: EventEmitter<KupTreeNodeCollapseEventPayload>;
   kupTreeDynamicMassExpansion: EventEmitter<KupTreeDynamicMassExpansionEventPayload>;
-  enrichDataWhenChanged(newData: any, oldData: any): void;
+  /**
+   * Event fired when columns are removed (set to hidden).
+   */
+  kupColumnRemove: EventEmitter<KupTreeColumnRemoveEventPayload>;
+  enrichDataWhenChanged(newData: KupTreeNode[] | KupDataDataset, oldData: KupTreeNode[]): void;
   enrichStructureStateWhenChanged(newValue: any, oldValue: any): void;
   selectedNodeToStr(newData: any): void;
   /**
@@ -267,6 +272,11 @@ export declare class KupTree {
    * @returns {Promise<GenericObject>} List of props as object, each key will be a prop.
    */
   getProps(descriptions?: boolean): Promise<GenericObject>;
+  /**
+   * Hides the given column.
+   * @param {KupDataColumn} column - Column to hide.
+   */
+  hideColumn(column: KupDataColumn): Promise<void>;
   /**
    * Opens the column menu of the given column.
    * @param {string} column - Name of the column.
@@ -288,23 +298,23 @@ export declare class KupTree {
   setTreeColumnVisibility(value: boolean): void;
   isTreeColumnVisible(): boolean;
   private checkScrollOnHover;
-  onKupTreeNodeDblClick(treeNodeData: TreeNode, treeNodePath: string): void;
-  nodesToRows(): Row[];
+  onKupTreeNodeDblClick(treeNodeData: KupTreeNode, treeNodePath: string): void;
+  nodesToRows(): KupDataRow[];
   private setDynPosElements;
-  expandCollapseNode(treeNode: TreeNode, expandNode?: boolean): void;
-  expandCollapseAllNodes(treeNode: TreeNode, expandNode?: boolean): void;
-  getColumns(): Array<Column>;
+  expandCollapseNode(treeNode: KupTreeNode, expandNode?: boolean): void;
+  expandCollapseAllNodes(treeNode: KupTreeNode, expandNode?: boolean): void;
+  getColumns(): Array<KupDataColumn>;
   private getSizedColumns;
-  getVisibleColumns(): Array<Column>;
-  getHeadingColumns(): Array<Column>;
-  launchNodeEvent(treeNodePath: TreeNodePath, treeNode: TreeNode): void;
+  getVisibleColumns(): Array<KupDataColumn>;
+  getHeadingColumns(): Array<KupDataColumn>;
+  launchNodeEvent(treeNodePath: TreeNodePath, treeNode: KupTreeNode): void;
   private openTotalMenu;
   private closeMenuAndTooltip;
   private onTotalMenuOpen;
   private getEventDetails;
   private contextMenuHandler;
-  hdlTreeNodeClick(e: MouseEvent, treeNodeData: TreeNode, treeNodePath: string, auto: boolean): void;
-  hdlTreeNodeExpanderClick(treeNodeData: TreeNode, treeNodePath: string, ctrlKey: boolean): void;
+  hdlTreeNodeClick(e: MouseEvent, treeNodeData: KupTreeNode, treeNodePath: string, auto: boolean): void;
+  hdlTreeNodeExpanderClick(treeNodeData: KupTreeNode, treeNodePath: string, ctrlKey: boolean): void;
   private hasTotals;
   private handleChildren;
   /**
@@ -317,8 +327,8 @@ export declare class KupTree {
   onGlobalFilterChange({ detail }: {
     detail: any;
   }): void;
-  getColumnValues(column: Column): ValueDisplayedValue[];
-  getRows(): Array<TreeNode>;
+  getColumnValues(column: KupDataColumn): ValueDisplayedValue[];
+  getRows(): Array<KupTreeNode>;
   private filterNodes;
   private calculateVisibleNodes;
   private refreshStructureState;
@@ -341,14 +351,14 @@ export declare class KupTree {
    */
   private renderHighlightedContent;
   /**
-   * Given a TreeNode, reads through its data then composes and returns its JSX object.
-   * @param treeNodeData - The TreeNode object to parse.
-   * @param treeNodePath - A string containing the comma(,) separated indexes of the TreeNodes to use,
-   *    sorted from left to right, to access the current TreeNode starting from the data prop children object.
-   * @param treeNodeDepth - An integer to keep track of the depth level of the current TreeNode. Used for indentation.
+   * Given a KupTreeNode, reads through its data then composes and returns its JSX object.
+   * @param treeNodeData - The KupTreeNode object to parse.
+   * @param treeNodePath - A string containing the comma(,) separated indexes of the KupTreeNodes to use,
+   *    sorted from left to right, to access the current KupTreeNode starting from the data prop children object.
+   * @param treeNodeDepth - An integer to keep track of the depth level of the current KupTreeNode. Used for indentation.
    * @returns The the JSX created from the current tree node.
    */
-  renderTreeNode(treeNodeData: TreeNode, treeNodePath: string, treeNodeDepth?: number): JSX.Element;
+  renderTreeNode(treeNodeData: KupTreeNode, treeNodePath: string, treeNodeDepth?: number): JSX.Element;
   private closeTotalMenu;
   private isOpenedTotalMenuForColumn;
   onTotalsChange(event: any, column: any): void;
@@ -356,15 +366,15 @@ export declare class KupTree {
   didLoadInteractables(): void;
   private totalMenuPosition;
   /**
-   * Given a TreeNode, reads through its data to compose and return the TreeNodes of the root of this TreeNode
-   * and its children nodes, composing an array of JSX TreeNodes.
-   * @param treeNodeData - The TreeNode object to parse.
-   * @param treeNodePath - A string containing the comma(,) separated indexes of the TreeNodes to use,
-   *    sorted from left to right, to access the current TreeNode starting from the data prop children object.
-   * @param treeNodeDepth - An integer to keep track of the depth level of the current TreeNode. Used for indentation.
-   * @returns An array of JSX TreeNodes created from the given treeNodeData.
+   * Given a KupTreeNode, reads through its data to compose and return the KupTreeNodes of the root of this KupTreeNode
+   * and its children nodes, composing an array of JSX KupTreeNodes.
+   * @param treeNodeData - The KupTreeNode object to parse.
+   * @param treeNodePath - A string containing the comma(,) separated indexes of the KupTreeNodes to use,
+   *    sorted from left to right, to access the current KupTreeNode starting from the data prop children object.
+   * @param treeNodeDepth - An integer to keep track of the depth level of the current KupTreeNode. Used for indentation.
+   * @returns An array of JSX KupTreeNodes created from the given treeNodeData.
    */
-  renderTree(treeNodeData: TreeNode, treeNodePath: string, treeNodeDepth?: number): JSX.Element[];
+  renderTree(treeNodeData: KupTreeNode, treeNodePath: string, treeNodeDepth?: number): JSX.Element[];
   private setEllipsis;
   componentWillLoad(): void;
   componentDidLoad(): void;