@sme.up/ketchup 8.0.2 → 8.2.0

package/dist/types/managers/kup-data/kup-data-node-helper.d.ts

@@ -1,44 +1,44 @@
-import { TreeNodePath } from '../../components/kup-tree/kup-tree-declarations';
-import { KupDataNode, KupDataNodeDrilldownInfo } from './kup-data-declarations';
-/**
- * Removes the given node from the input array, by searching even children.
- * @param {KupDataNode[]} nodes - Input array of nodes.
- * @param {KupDataNode} node2remove - Node to remove.
- * @returns {KupDataNode} Copy of the removed node.
- */
-export declare function removeNode(nodes: KupDataNode[], node2remove: KupDataNode): KupDataNode;
-/**
- * Sets the values specified in the properties to every node of the input array.
- * @param {KupDataNode[]} nodes - Input array of nodes.
- * @param {Partial<KupDataNode>} properties - New properties values to set.
- * @param {boolean} recursively - Sets values to every child node.
- * @param {KupDataNode[]} exclude - Nodes to exclude (they won't be updated).
- * @returns {KupDataNode[]} Array of the updated nodes.
- */
-export declare function setPropertiesNode(nodes: KupDataNode[], properties: Partial<KupDataNode>, recursively?: boolean, exclude?: KupDataNode[]): KupDataNode[];
-/**
- * Streamlines an array of nodes by recursively fetching every child node.
- * @param {KupDataNode[]} nodes - Input array of nodes.
- * @returns {KupDataNode[]} Streamlined array of every node and their children.
- */
-export declare function toStreamNode(nodes: KupDataNode[]): KupDataNode[];
-/**
- * Gets information about the tree depth, such as max number of children and max depth.
- * @param {KupDataNode[]} nodes - Input array of nodes.
- * @returns {KupDataNodeDrilldownInfo} Information about the tree depth.
- */
-export declare function getDrilldownInfoNode(nodes: KupDataNode[]): KupDataNodeDrilldownInfo;
-/**
- * Returns the parent of the given node.
- * @param {KupDataNode[]} nodes - Input array of nodes.
- * @param {KupDataNode} child - Child node.
- * @returns {KupDataNode} Parent node.
- */
-export declare function getParentNode(nodes: KupDataNode[], child: KupDataNode): KupDataNode;
-/**
- * Returns the node with id equal to the given value.
- * @param {KupDataNode[]} nodes - Input array of nodes.
- * @param {string} treeNodePath - Tree node path.
- * @returns {KupDataNode} Node.
- */
-export declare function getNodeByPath(nodes: KupDataNode[], treeNodePath: TreeNodePath): KupDataNode;
+import { TreeNodePath } from '../../components/kup-tree/kup-tree-declarations';
+import { KupDataNode, KupDataNodeDrilldownInfo } from './kup-data-declarations';
+/**
+ * Removes the given node from the input array, by searching even children.
+ * @param {KupDataNode[]} nodes - Input array of nodes.
+ * @param {KupDataNode} node2remove - Node to remove.
+ * @returns {KupDataNode} Copy of the removed node.
+ */
+export declare function removeNode(nodes: KupDataNode[], node2remove: KupDataNode): KupDataNode;
+/**
+ * Sets the values specified in the properties to every node of the input array.
+ * @param {KupDataNode[]} nodes - Input array of nodes.
+ * @param {Partial<KupDataNode>} properties - New properties values to set.
+ * @param {boolean} recursively - Sets values to every child node.
+ * @param {KupDataNode[]} exclude - Nodes to exclude (they won't be updated).
+ * @returns {KupDataNode[]} Array of the updated nodes.
+ */
+export declare function setPropertiesNode(nodes: KupDataNode[], properties: Partial<KupDataNode>, recursively?: boolean, exclude?: KupDataNode[]): KupDataNode[];
+/**
+ * Streamlines an array of nodes by recursively fetching every child node.
+ * @param {KupDataNode[]} nodes - Input array of nodes.
+ * @returns {KupDataNode[]} Streamlined array of every node and their children.
+ */
+export declare function toStreamNode(nodes: KupDataNode[]): KupDataNode[];
+/**
+ * Gets information about the tree depth, such as max number of children and max depth.
+ * @param {KupDataNode[]} nodes - Input array of nodes.
+ * @returns {KupDataNodeDrilldownInfo} Information about the tree depth.
+ */
+export declare function getDrilldownInfoNode(nodes: KupDataNode[]): KupDataNodeDrilldownInfo;
+/**
+ * Returns the parent of the given node.
+ * @param {KupDataNode[]} nodes - Input array of nodes.
+ * @param {KupDataNode} child - Child node.
+ * @returns {KupDataNode} Parent node.
+ */
+export declare function getParentNode(nodes: KupDataNode[], child: KupDataNode): KupDataNode;
+/**
+ * Returns the node with id equal to the given value.
+ * @param {KupDataNode[]} nodes - Input array of nodes.
+ * @param {string} treeNodePath - Tree node path.
+ * @returns {KupDataNode} Node.
+ */
+export declare function getNodeByPath(nodes: KupDataNode[], treeNodePath: TreeNodePath): KupDataNode;

package/dist/types/managers/kup-data/kup-data-row-helper.d.ts

@@ -1,14 +1,14 @@
-import { KupDataDataset, KupDataFindCellFilters, KupDataNode, KupDataRow } from './kup-data-declarations';
-/**
- * Finds all the rows containing cells matching the filters criteria in the input dataset.
- * @param {KupDataDataset} dataset - Input dataset.
- * @param {KupDataFindCellFilters} filters - Filters of the research.
- * @returns {KupDataRow[]} Array of rows fetched after applying the filters.
- */
-export declare function findRow(dataset: KupDataDataset, filters: KupDataFindCellFilters): KupDataRow[];
-/**
- * Converts the rows of the input dataset to tree nodes.
- * @param {KupDataDataset} dataset - Input dataset.
- * @returns {KupDataNode[]} Array of tree nodes.
- */
-export declare function toNode(dataset: KupDataDataset): KupDataNode[];
+import { KupDataDataset, KupDataFindCellFilters, KupDataNode, KupDataRow } from './kup-data-declarations';
+/**
+ * Finds all the rows containing cells matching the filters criteria in the input dataset.
+ * @param {KupDataDataset} dataset - Input dataset.
+ * @param {KupDataFindCellFilters} filters - Filters of the research.
+ * @returns {KupDataRow[]} Array of rows fetched after applying the filters.
+ */
+export declare function findRow(dataset: KupDataDataset, filters: KupDataFindCellFilters): KupDataRow[];
+/**
+ * Converts the rows of the input dataset to tree nodes.
+ * @param {KupDataDataset} dataset - Input dataset.
+ * @returns {KupDataNode[]} Array of tree nodes.
+ */
+export declare function toNode(dataset: KupDataDataset): KupDataNode[];

package/dist/types/managers/kup-data/kup-data.d.ts

@@ -1,86 +1,86 @@
-import { KupDataCell, KupDataColumn, KupDataDataset, KupDataDatasetSort, KupDataFindCellFilters, KupDataNewColumn, KupDataNewColumnOptions, KupDataNewColumnTypes, KupDataNode, KupDataNodeDrilldownInfo, KupDataRow } from './kup-data-declarations';
-import { FCellShapes, FCellTypes } from '../../f-components/f-cell/f-cell-declarations';
-import { TreeNodePath } from '../../components/kup-tree/kup-tree-declarations';
-import { ValueDisplayedValue } from '../../utils/filters/filters-declarations';
-/**
- * Handles data operations.
- * @module KupData
- */
-export declare class KupData {
-  cell: {
-    find(dataset: KupDataDataset, filters: KupDataFindCellFilters): KupDataCell[];
-    getValue(dataset: KupDataDataset, column: KupDataColumn, sorted?: boolean): ValueDisplayedValue[];
-    getUnivocalValue(dataset: KupDataDataset, column: KupDataColumn, sorted?: boolean): ValueDisplayedValue[];
-    replace(dataset: KupDataDataset, cell: KupDataCell, columns?: string[]): KupDataCell[];
-    getType(cell: KupDataCell, shape?: FCellShapes): FCellTypes;
-  };
-  column: {
-    find(dataset: KupDataDataset | KupDataColumn[], filters: Partial<KupDataColumn>): KupDataColumn[];
-    hide(dataset: KupDataDataset | KupDataColumn[], columns2hide: string[]): KupDataColumn[];
-    new(dataset: KupDataDataset, type: KupDataNewColumnTypes, options: KupDataNewColumnOptions): string | KupDataColumn;
-  };
-  node: {
-    getDrilldownInfo(nodes: KupDataNode[]): KupDataNodeDrilldownInfo;
-    getParent(nodes: KupDataNode[], child: KupDataNode): KupDataNode;
-    find(nodes: KupDataNode[], treeNodePath: TreeNodePath): KupDataNode;
-    findByStrTreeNodePath(nodes: KupDataNode[], treeNodePath: string): KupDataNode;
-    remove(nodes: KupDataNode[], node2remove: KupDataNode): KupDataNode;
-    setProperties(nodes: KupDataNode[], properties: Partial<KupDataNode>, recursively?: boolean, exclude?: KupDataNode[]): KupDataNode[];
-    toStream(nodes: KupDataNode[]): KupDataNode[];
-  };
-  row: {
-    find(dataset: KupDataDataset, filters: KupDataFindCellFilters): KupDataRow[];
-    toNode(dataset: KupDataDataset): KupDataNode[];
-  };
-  /**
-   * Utility used by findRow and findCell.
-   * @param {KupDataDataset} dataset - Input dataset.
-   * @param {KupDataFindCellFilters} filters - Filters of the research.
-   * @returns {{cells: KupDataCell[], rows: KupDataRow[]}}  Object containing rows and cells.
-   */
-  finder(dataset: KupDataDataset, filters: KupDataFindCellFilters): {
-    cells: KupDataCell[];
-    rows: KupDataRow[];
-  };
-  /**
-   * Creates a new dataset with an amount of cells equal to a distinct calculation applied to the given columns.
-   * The original value of cells will be stored in the title property of the new cells.
-   * @param {KupDataDataset} dataset - Input dataset.
-   * @param {string[]} columns - Column names to manage. When missing, defaults to all columns.
-   * @param {KupDataColumn} valuesColumn - When present, this column will be included in the final dataset containing the original values of the cells.
-   * @returns {KupDataDataset} New dataset with processed data.
-   */
-  distinct(dataset: KupDataDataset, columns?: string[], valuesColumn?: KupDataColumn): KupDataDataset;
-  /**
-   * Creates a new dataset from the input one.
-   * The new columns are to be specified in the columns argument along with their creation criteria.
-   * @param {KupDataDataset} dataset - Input dataset.
-   * @param {KupDataNewColumn[]} newColumns - Array containing the specifics of the new columns to be created.
-   * @returns {KupDataDataset} Resulting dataset.
-   */
-  new(dataset: KupDataDataset, newColumns: KupDataNewColumn[]): KupDataDataset;
-  /**
-   * Performs a distinct/count after previously grouping columns by ranges.
-   * @param {KupDataDataset} dataset - Input dataset.
-   * @param {KupDataNewColumn[]} rangeColumns - A list of columns coupled with their criteria for creation. These are used to define ranges.
-   * @param {KupDataColumn} resultingColumn - The resulting column.
-   * @param {KupDataColumn} valuesColumn - When present, this column will be included in the final dataset containing the original values of the cells.
-   * @returns {KupDataDataset} New dataset with processed data.
-   */
-  rangedDistinct(dataset: KupDataDataset, rangeColumns: KupDataNewColumn[], resultingColumn: KupDataColumn, valuesColumn?: KupDataColumn): KupDataDataset;
-  /**
-   * Creates a new dataset with sorted elements.
-   * @param {KupDataDataset} dataset Input dataset.
-   * @param {KupDataDatasetSort} sortType Type of sort to apply.
-   * @param {string} headerColumn The column used for sorting.
-   * @returns {KupDataDataset} Sorted dataset.
-   */
-  sort(dataset: KupDataDataset, sortType: KupDataDatasetSort, headerColumn: string): KupDataDataset;
-  /**
-   * Creates a new dataset with transposed columns and rows.
-   * @param {KupDataDataset} dataset - Input dataset.
-   * @param {string} headerColumn - When specified, it will be the column used as header. When missing, the header will be a series of progressive numbers.
-   * @returns {KupDataDataset} Transposed dataset.
-   */
-  transpose(dataset: KupDataDataset, headerColumn?: string): KupDataDataset;
-}
+import { KupDataCell, KupDataColumn, KupDataDataset, KupDataDatasetSort, KupDataFindCellFilters, KupDataNewColumn, KupDataNewColumnOptions, KupDataNewColumnTypes, KupDataNode, KupDataNodeDrilldownInfo, KupDataRow } from './kup-data-declarations';
+import { FCellShapes, FCellTypes } from '../../f-components/f-cell/f-cell-declarations';
+import { TreeNodePath } from '../../components/kup-tree/kup-tree-declarations';
+import { ValueDisplayedValue } from '../../utils/filters/filters-declarations';
+/**
+ * Handles data operations.
+ * @module KupData
+ */
+export declare class KupData {
+  cell: {
+    find(dataset: KupDataDataset, filters: KupDataFindCellFilters): KupDataCell[];
+    getValue(dataset: KupDataDataset, column: KupDataColumn, sorted?: boolean): ValueDisplayedValue[];
+    getUnivocalValue(dataset: KupDataDataset, column: KupDataColumn, sorted?: boolean): ValueDisplayedValue[];
+    replace(dataset: KupDataDataset, cell: KupDataCell, columns?: string[]): KupDataCell[];
+    getType(cell: KupDataCell, shape?: FCellShapes): FCellTypes;
+  };
+  column: {
+    find(dataset: KupDataDataset | KupDataColumn[], filters: Partial<KupDataColumn>): KupDataColumn[];
+    hide(dataset: KupDataDataset | KupDataColumn[], columns2hide: string[]): KupDataColumn[];
+    new(dataset: KupDataDataset, type: KupDataNewColumnTypes, options: KupDataNewColumnOptions): string | KupDataColumn;
+  };
+  node: {
+    getDrilldownInfo(nodes: KupDataNode[]): KupDataNodeDrilldownInfo;
+    getParent(nodes: KupDataNode[], child: KupDataNode): KupDataNode;
+    find(nodes: KupDataNode[], treeNodePath: TreeNodePath): KupDataNode;
+    findByStrTreeNodePath(nodes: KupDataNode[], treeNodePath: string): KupDataNode;
+    remove(nodes: KupDataNode[], node2remove: KupDataNode): KupDataNode;
+    setProperties(nodes: KupDataNode[], properties: Partial<KupDataNode>, recursively?: boolean, exclude?: KupDataNode[]): KupDataNode[];
+    toStream(nodes: KupDataNode[]): KupDataNode[];
+  };
+  row: {
+    find(dataset: KupDataDataset, filters: KupDataFindCellFilters): KupDataRow[];
+    toNode(dataset: KupDataDataset): KupDataNode[];
+  };
+  /**
+   * Utility used by findRow and findCell.
+   * @param {KupDataDataset} dataset - Input dataset.
+   * @param {KupDataFindCellFilters} filters - Filters of the research.
+   * @returns {{cells: KupDataCell[], rows: KupDataRow[]}}  Object containing rows and cells.
+   */
+  finder(dataset: KupDataDataset, filters: KupDataFindCellFilters): {
+    cells: KupDataCell[];
+    rows: KupDataRow[];
+  };
+  /**
+   * Creates a new dataset with an amount of cells equal to a distinct calculation applied to the given columns.
+   * The original value of cells will be stored in the title property of the new cells.
+   * @param {KupDataDataset} dataset - Input dataset.
+   * @param {string[]} columns - Column names to manage. When missing, defaults to all columns.
+   * @param {KupDataColumn} valuesColumn - When present, this column will be included in the final dataset containing the original values of the cells.
+   * @returns {KupDataDataset} New dataset with processed data.
+   */
+  distinct(dataset: KupDataDataset, columns?: string[], valuesColumn?: KupDataColumn): KupDataDataset;
+  /**
+   * Creates a new dataset from the input one.
+   * The new columns are to be specified in the columns argument along with their creation criteria.
+   * @param {KupDataDataset} dataset - Input dataset.
+   * @param {KupDataNewColumn[]} newColumns - Array containing the specifics of the new columns to be created.
+   * @returns {KupDataDataset} Resulting dataset.
+   */
+  new(dataset: KupDataDataset, newColumns: KupDataNewColumn[]): KupDataDataset;
+  /**
+   * Performs a distinct/count after previously grouping columns by ranges.
+   * @param {KupDataDataset} dataset - Input dataset.
+   * @param {KupDataNewColumn[]} rangeColumns - A list of columns coupled with their criteria for creation. These are used to define ranges.
+   * @param {KupDataColumn} resultingColumn - The resulting column.
+   * @param {KupDataColumn} valuesColumn - When present, this column will be included in the final dataset containing the original values of the cells.
+   * @returns {KupDataDataset} New dataset with processed data.
+   */
+  rangedDistinct(dataset: KupDataDataset, rangeColumns: KupDataNewColumn[], resultingColumn: KupDataColumn, valuesColumn?: KupDataColumn): KupDataDataset;
+  /**
+   * Creates a new dataset with sorted elements.
+   * @param {KupDataDataset} dataset Input dataset.
+   * @param {KupDataDatasetSort} sortType Type of sort to apply.
+   * @param {string} headerColumn The column used for sorting.
+   * @returns {KupDataDataset} Sorted dataset.
+   */
+  sort(dataset: KupDataDataset, sortType: KupDataDatasetSort, headerColumn: string): KupDataDataset;
+  /**
+   * Creates a new dataset with transposed columns and rows.
+   * @param {KupDataDataset} dataset - Input dataset.
+   * @param {string} headerColumn - When specified, it will be the column used as header. When missing, the header will be a series of progressive numbers.
+   * @returns {KupDataDataset} Transposed dataset.
+   */
+  transpose(dataset: KupDataDataset, headerColumn?: string): KupDataDataset;
+}

package/dist/types/managers/kup-dates/kup-dates-declarations.d.ts

@@ -1,39 +1,39 @@
-/**
- * Normalization types.
- */
-export declare enum KupDatesNormalize {
-  DATE = "date",
-  TIME = "time",
-  TIMESTAMP = "timestamp"
-}
-/**
- * Supported locales.
- */
-export declare enum KupDatesLocales {
-  CHINESE = "cn",
-  ENGLISH = "en",
-  FRENCH = "fr",
-  ITALIAN = "it",
-  POLISH = "pl",
-  RUSSIAN = "ru",
-  SPANISH = "es"
-}
-/**
- * Format Months
- */
-export declare enum KupDateTimeFormatOptionsMonth {
-  NUMERIC = "numeric",
-  DIGIT2 = "2-digit",
-  LONG = "long",
-  SHORT = "short",
-  NARROW = "narrow"
-}
-/**
- * Common use formats
- */
-export declare enum KupDatesFormats {
-  ISO_DATE = "YYYY-MM-DD",
-  ISO_DATE_TIME = "YYYY-MM-DD HH:mm:ss",
-  ISO_TIME = "HH:mm:ss",
-  ISO_TIME_WITHOUT_SECONDS = "HH:mm"
-}
+/**
+ * Normalization types.
+ */
+export declare enum KupDatesNormalize {
+  DATE = "date",
+  TIME = "time",
+  TIMESTAMP = "timestamp"
+}
+/**
+ * Supported locales.
+ */
+export declare enum KupDatesLocales {
+  CHINESE = "cn",
+  ENGLISH = "en",
+  FRENCH = "fr",
+  ITALIAN = "it",
+  POLISH = "pl",
+  RUSSIAN = "ru",
+  SPANISH = "es"
+}
+/**
+ * Format Months
+ */
+export declare enum KupDateTimeFormatOptionsMonth {
+  NUMERIC = "numeric",
+  DIGIT2 = "2-digit",
+  LONG = "long",
+  SHORT = "short",
+  NARROW = "narrow"
+}
+/**
+ * Common use formats
+ */
+export declare enum KupDatesFormats {
+  ISO_DATE = "YYYY-MM-DD",
+  ISO_DATE_TIME = "YYYY-MM-DD HH:mm:ss",
+  ISO_TIME = "HH:mm:ss",
+  ISO_TIME_WITHOUT_SECONDS = "HH:mm"
+}