@sme.up/ketchup 8.0.2 → 8.1.0

package/dist/types/utils/filters/filters-declarations.d.ts

@@ -1,39 +1,39 @@
-import { KupListNode } from '../../components/kup-list/kup-list-declarations';
-/**
- * Interface for ranged filters.
- */
-export declare enum FilterInterval {
-  FROM = 0,
-  TO = 1
-}
-export interface GenericFilter {
-  [index: string]: Filter;
-}
-export interface ValueDisplayedValue {
-  value: string;
-  displayedValue?: string;
-  node?: KupListNode;
-}
-export interface Filter {
-  textField: string;
-  textFieldTmp?: string;
-  checkBoxes: ValueDisplayedValue[];
-  interval: string[];
-  intervalTmp?: string[];
-}
-/**
- * This regular expressions returns a match like this one:
- * if the string does not match is null, otherwise the indexes are equal to the object below:
- *
- * @property {string} 0 - The entire match of the regexp; is equal to the cellValue.
- * @property {string} 1 - Either !' or ' it's the start of the regexp.
- * @property {string} 2 - Either % or null: means the string must start with the given string.
- * @property {string} 3 - Either "" or a string with a length.
- * @property {string} 4 - Either % or null: means the string must finish with the given string.
- * @property {string} 5 - Always equal to ': it's the end of the filter.
- */
-export declare const FILTER_ANALIZER: RegExp;
-export declare enum KupGlobalFilterMode {
-  SIMPLE = "simple",
-  HIGHLIGHT = "highlight"
-}
+import { KupListNode } from '../../components/kup-list/kup-list-declarations';
+/**
+ * Interface for ranged filters.
+ */
+export declare enum FilterInterval {
+  FROM = 0,
+  TO = 1
+}
+export interface GenericFilter {
+  [index: string]: Filter;
+}
+export interface ValueDisplayedValue {
+  value: string;
+  displayedValue?: string;
+  node?: KupListNode;
+}
+export interface Filter {
+  textField: string;
+  textFieldTmp?: string;
+  checkBoxes: ValueDisplayedValue[];
+  interval: string[];
+  intervalTmp?: string[];
+}
+/**
+ * This regular expressions returns a match like this one:
+ * if the string does not match is null, otherwise the indexes are equal to the object below:
+ *
+ * @property {string} 0 - The entire match of the regexp; is equal to the cellValue.
+ * @property {string} 1 - Either !' or ' it's the start of the regexp.
+ * @property {string} 2 - Either % or null: means the string must start with the given string.
+ * @property {string} 3 - Either "" or a string with a length.
+ * @property {string} 4 - Either % or null: means the string must finish with the given string.
+ * @property {string} 5 - Always equal to ': it's the end of the filter.
+ */
+export declare const FILTER_ANALIZER: RegExp;
+export declare enum KupGlobalFilterMode {
+  SIMPLE = "simple",
+  HIGHLIGHT = "highlight"
+}

package/dist/types/utils/filters/filters-rows.d.ts

@@ -1,30 +1,30 @@
-import type { GenericFilter, ValueDisplayedValue } from './filters-declarations';
-import type { KupDataTable } from '../../components/kup-data-table/kup-data-table';
-import type { KupTree } from '../../components/kup-tree/kup-tree';
-import { Filters } from './filters';
-import { FiltersColumnMenu } from './filters-column-menu';
-import { KupDataCell, KupDataColumn, KupDataRow, KupDataRowCells } from '../../managers/kup-data/kup-data-declarations';
-/**
- * Filtering algorithms related to data-table rows.
- * @module FiltersRows
- * @todo Should contain EVERY row-specific filtering method.
- */
-export declare class FiltersRows extends Filters {
-  isFilterCompliantForCell(cellValue: KupDataCell, filterValue: string, interval: string[]): boolean;
-  isFilterCompliantForCellObj(cellValue: KupDataCell, filterValue: string, interval: string[]): boolean;
-  isRowCompliant(r: KupDataRow, filters?: GenericFilter, globalFilter?: string, isUsingGlobalFilter?: boolean, columns?: KupDataColumn[], columnFilters?: FiltersColumnMenu): boolean;
-  areCellsCompliant(cells: KupDataRowCells, filters?: GenericFilter, globalFilter?: string, isUsingGlobalFilter?: boolean, columns?: KupDataColumn[], columnFilters?: FiltersColumnMenu): boolean;
-  hasFilters(filters: GenericFilter, columns: KupDataColumn[], columnFilters?: FiltersColumnMenu): boolean;
-  /**
-   * Filters the rows data of a data-table component according to the parameters
-   *
-   * @param rows - The data of the rows to filter.
-   * @param filters - The the filters for each column.
-   * @param globalFilter - A global filter applied to all columns.
-   * @param columns - The colmns on which the filter will take effect.
-   * @todo This function can be improved in its speed by a refactor in which from two different cycles of execution for
-   *    single filters and global filter, all controls on a single column are done in a single cycle.
-   */
-  filterRows(rows?: Array<KupDataRow>, filters?: GenericFilter, globalFilter?: string, columns?: KupDataColumn[], columnFilters?: FiltersColumnMenu): Array<KupDataRow>;
-  getColumnValues(comp: KupDataTable | KupTree, column: KupDataColumn, globalFilterValue: string, columnFilters?: FiltersColumnMenu): ValueDisplayedValue[];
-}
+import type { GenericFilter, ValueDisplayedValue } from './filters-declarations';
+import type { KupDataTable } from '../../components/kup-data-table/kup-data-table';
+import type { KupTree } from '../../components/kup-tree/kup-tree';
+import { Filters } from './filters';
+import { FiltersColumnMenu } from './filters-column-menu';
+import { KupDataCell, KupDataColumn, KupDataRow, KupDataRowCells } from '../../managers/kup-data/kup-data-declarations';
+/**
+ * Filtering algorithms related to data-table rows.
+ * @module FiltersRows
+ * @todo Should contain EVERY row-specific filtering method.
+ */
+export declare class FiltersRows extends Filters {
+  isFilterCompliantForCell(cellValue: KupDataCell, filterValue: string, interval: string[]): boolean;
+  isFilterCompliantForCellObj(cellValue: KupDataCell, filterValue: string, interval: string[]): boolean;
+  isRowCompliant(r: KupDataRow, filters?: GenericFilter, globalFilter?: string, isUsingGlobalFilter?: boolean, columns?: KupDataColumn[], columnFilters?: FiltersColumnMenu): boolean;
+  areCellsCompliant(cells: KupDataRowCells, filters?: GenericFilter, globalFilter?: string, isUsingGlobalFilter?: boolean, columns?: KupDataColumn[], columnFilters?: FiltersColumnMenu): boolean;
+  hasFilters(filters: GenericFilter, columns: KupDataColumn[], columnFilters?: FiltersColumnMenu): boolean;
+  /**
+   * Filters the rows data of a data-table component according to the parameters
+   *
+   * @param rows - The data of the rows to filter.
+   * @param filters - The the filters for each column.
+   * @param globalFilter - A global filter applied to all columns.
+   * @param columns - The colmns on which the filter will take effect.
+   * @todo This function can be improved in its speed by a refactor in which from two different cycles of execution for
+   *    single filters and global filter, all controls on a single column are done in a single cycle.
+   */
+  filterRows(rows?: Array<KupDataRow>, filters?: GenericFilter, globalFilter?: string, columns?: KupDataColumn[], columnFilters?: FiltersColumnMenu): Array<KupDataRow>;
+  getColumnValues(comp: KupDataTable | KupTree, column: KupDataColumn, globalFilterValue: string, columnFilters?: FiltersColumnMenu): ValueDisplayedValue[];
+}

package/dist/types/utils/filters/filters-tree-items.d.ts

@@ -1,19 +1,19 @@
-import type { GenericFilter, ValueDisplayedValue } from './filters-declarations';
-import { KupTreeNode } from '../../components/kup-tree/kup-tree-declarations';
-import { FiltersColumnMenu } from './filters-column-menu';
-import { FiltersRows } from './filters-rows';
-import { KupDataColumn } from '../../managers/kup-data/kup-data-declarations';
-/**
- * Filtering algorithms related to tree items rows.
- * @module FiltersTreeItems
- * @todo Should contain EVERY tree-item-specific filtering method.
- */
-export declare class FiltersTreeItems extends FiltersRows {
-  filterRows(items?: KupTreeNode[], filters?: GenericFilter, globalFilter?: string, columns?: KupDataColumn[], columnFilters?: FiltersColumnMenu): Array<KupTreeNode>;
-  isNodeCompliant(node: KupTreeNode, filters?: GenericFilter, globalFilter?: string, isUsingGlobalFilter?: boolean, columns?: KupDataColumn[], columnFilters?: FiltersColumnMenu): boolean;
-  private setNodeVisibility;
-  private setAllVisible;
-  extractColumnValues(rows: Array<KupTreeNode>, column: KupDataColumn, values: ValueDisplayedValue[], univocal?: boolean): ValueDisplayedValue[];
-  expandCollapseNode(treeNode: KupTreeNode, expandNode?: boolean): void;
-  expandCollapseAllNodes(treeNode: KupTreeNode, expandNode?: boolean): void;
-}
+import type { GenericFilter, ValueDisplayedValue } from './filters-declarations';
+import { KupTreeNode } from '../../components/kup-tree/kup-tree-declarations';
+import { FiltersColumnMenu } from './filters-column-menu';
+import { FiltersRows } from './filters-rows';
+import { KupDataColumn } from '../../managers/kup-data/kup-data-declarations';
+/**
+ * Filtering algorithms related to tree items rows.
+ * @module FiltersTreeItems
+ * @todo Should contain EVERY tree-item-specific filtering method.
+ */
+export declare class FiltersTreeItems extends FiltersRows {
+  filterRows(items?: KupTreeNode[], filters?: GenericFilter, globalFilter?: string, columns?: KupDataColumn[], columnFilters?: FiltersColumnMenu): Array<KupTreeNode>;
+  isNodeCompliant(node: KupTreeNode, filters?: GenericFilter, globalFilter?: string, isUsingGlobalFilter?: boolean, columns?: KupDataColumn[], columnFilters?: FiltersColumnMenu): boolean;
+  private setNodeVisibility;
+  private setAllVisible;
+  extractColumnValues(rows: Array<KupTreeNode>, column: KupDataColumn, values: ValueDisplayedValue[], univocal?: boolean): ValueDisplayedValue[];
+  expandCollapseNode(treeNode: KupTreeNode, expandNode?: boolean): void;
+  expandCollapseAllNodes(treeNode: KupTreeNode, expandNode?: boolean): void;
+}

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

@@ -1,72 +1,72 @@
-import { KupDataTable } from '../../components/kup-data-table/kup-data-table';
-import { KupTree } from '../../components/kup-tree/kup-tree';
-import { ValueDisplayedValue } from './filters-declarations';
-/**
- * Filtering algorithms.
- * @module Filters
- * @todo Should contain EVERY filtering method in common between filtering types (i.e.: global filters and column menu filters).
- */
-export declare class Filters {
-  /**
-   * Function used to check whether the component is a KupTree or KupDataTable.
-   * @param {KupDataTable | KupTree} comp - Component using the column menu.
-   * @returns {comp is KupTree} Returns true when the component is KupTree.
-   */
-  static isTree(comp: KupDataTable | KupTree): comp is KupTree;
-  isObjFiltrableByInterval(obj: any): boolean;
-  normalizeValue(value: string, smeupObj: any): string;
-  /**
-   * Given a filter value, check if is a negative filter
-   * @param filterValue the filter value to use for check
-   */
-  filterIsNegative(filterValue: string): boolean;
-  /**
-   * Given a value and a filter value, returns if that value matches the filter.
-   *
-   * Web filters can also be expressions: by putting strings between single quotes (') it's possible to activate filter expressions.
-   * Valid syntax:
-   * 'filter' = search for exact phrase;
-   * '' = match when value is empty;
-   * 'filter%' = match when a string starts with "filter";
-   * '%filter' = match when a string ends with "filter";
-   * '%filter%' = match when a string contains "filter".
-   *
-   * It is also possible to negate the expression by prepending "!" in front of the expression.
-   * For example: !'' = value in the cell must not be empty.
-   *
-   * With no expression set, the filter is by default set to '%filter%'.
-   *
-   * @param value - The current value to check.
-   * @param filterValue - The value of the current filter.
-   * @returns false if value or filterValue are empty;
-              true if value contains filterValue;
-              true if value matches special filter created on filterValue;
-              false otherwise.
-   */
-  isFilterCompliantForValue(value: string, filterValue: string): boolean;
-  /**
-   * Given a value and a filter value, returns if that value matches the filter.
-   *
-   * Web filters can also be expressions: by putting strings between single quotes (') it's possible to activate filter expressions.
-   * Valid syntax:
-   * 'filter' = search for exact phrase;
-   * '' = match when value is empty;
-   * 'filter%' = match when a string starts with "filter";
-   * '%filter' = match when a string ends with "filter";
-   * '%filter%' = match when a string contains "filter".
-   *
-   * It is also possible to negate the expression by prepending "!" in front of the expression.
-   * For example: !'' = value in the cell must not be empty.
-   *
-   * With no expression set, the filter is by default set to '%filter%'.
-   *
-   * @param value - The current value to check.
-   * @param parsedFilter - The value of the current filter.
-   * @param ignoreNegativeFlag = false - When set to true, the matcher will ignore the (!) operator; useful for global filter.
-   * @returns True if the filter is empty and the value of the cell is empty, false otherwise.
-   */
-  matchSpecialFilter(value: string, parsedFilter: RegExpMatchArray | null, ignoreNegativeFlag?: boolean): boolean;
-  isFilterCompliantForSimpleValue(valueToCheck: string, obj: any, filterValue: string, interval: string[]): boolean;
-  static valuesArrayContainsValue(values: ValueDisplayedValue[], value: string): boolean;
-  static indexOfValueInValuesArray(values: ValueDisplayedValue[], value: string): number;
-}
+import { KupDataTable } from '../../components/kup-data-table/kup-data-table';
+import { KupTree } from '../../components/kup-tree/kup-tree';
+import { ValueDisplayedValue } from './filters-declarations';
+/**
+ * Filtering algorithms.
+ * @module Filters
+ * @todo Should contain EVERY filtering method in common between filtering types (i.e.: global filters and column menu filters).
+ */
+export declare class Filters {
+  /**
+   * Function used to check whether the component is a KupTree or KupDataTable.
+   * @param {KupDataTable | KupTree} comp - Component using the column menu.
+   * @returns {comp is KupTree} Returns true when the component is KupTree.
+   */
+  static isTree(comp: KupDataTable | KupTree): comp is KupTree;
+  isObjFiltrableByInterval(obj: any): boolean;
+  normalizeValue(value: string, smeupObj: any): string;
+  /**
+   * Given a filter value, check if is a negative filter
+   * @param filterValue the filter value to use for check
+   */
+  filterIsNegative(filterValue: string): boolean;
+  /**
+   * Given a value and a filter value, returns if that value matches the filter.
+   *
+   * Web filters can also be expressions: by putting strings between single quotes (') it's possible to activate filter expressions.
+   * Valid syntax:
+   * 'filter' = search for exact phrase;
+   * '' = match when value is empty;
+   * 'filter%' = match when a string starts with "filter";
+   * '%filter' = match when a string ends with "filter";
+   * '%filter%' = match when a string contains "filter".
+   *
+   * It is also possible to negate the expression by prepending "!" in front of the expression.
+   * For example: !'' = value in the cell must not be empty.
+   *
+   * With no expression set, the filter is by default set to '%filter%'.
+   *
+   * @param value - The current value to check.
+   * @param filterValue - The value of the current filter.
+   * @returns false if value or filterValue are empty;
+              true if value contains filterValue;
+              true if value matches special filter created on filterValue;
+              false otherwise.
+   */
+  isFilterCompliantForValue(value: string, filterValue: string): boolean;
+  /**
+   * Given a value and a filter value, returns if that value matches the filter.
+   *
+   * Web filters can also be expressions: by putting strings between single quotes (') it's possible to activate filter expressions.
+   * Valid syntax:
+   * 'filter' = search for exact phrase;
+   * '' = match when value is empty;
+   * 'filter%' = match when a string starts with "filter";
+   * '%filter' = match when a string ends with "filter";
+   * '%filter%' = match when a string contains "filter".
+   *
+   * It is also possible to negate the expression by prepending "!" in front of the expression.
+   * For example: !'' = value in the cell must not be empty.
+   *
+   * With no expression set, the filter is by default set to '%filter%'.
+   *
+   * @param value - The current value to check.
+   * @param parsedFilter - The value of the current filter.
+   * @param ignoreNegativeFlag = false - When set to true, the matcher will ignore the (!) operator; useful for global filter.
+   * @returns True if the filter is empty and the value of the cell is empty, false otherwise.
+   */
+  matchSpecialFilter(value: string, parsedFilter: RegExpMatchArray | null, ignoreNegativeFlag?: boolean): boolean;
+  isFilterCompliantForSimpleValue(valueToCheck: string, obj: any, filterValue: string, interval: string[]): boolean;
+  static valuesArrayContainsValue(values: ValueDisplayedValue[], value: string): boolean;
+  static indexOfValueInValuesArray(values: ValueDisplayedValue[], value: string): number;
+}

package/dist/types/utils/kup-column-menu/kup-column-menu-declarations.d.ts

@@ -1,19 +1,19 @@
-/**
- * Component IDs.
- */
-export declare enum KupColumnMenuIds {
-  BUTTON_APPLY = "apply",
-  BUTTON_ADD_COLUMNS = "add",
-  BUTTON_GROUP = "group",
-  BUTTON_NEW = "new",
-  BUTTON_OPEN_IN_NEW = "open-in-new",
-  BUTTON_REMOVE = "remove",
-  BUTTON_SEARCH = "search",
-  CHECKBOX_GLOBAL = "global-checkbox",
-  SWITCH_GROUP = "group",
-  SWITCH_KEY = "key",
-  TEXTFIELD_FILTER = "filter",
-  TEXTFIELD_FORMULA = "formula",
-  TEXTFIELD_FROM = "filter-from",
-  TEXTFIELD_TO = "filter-to"
-}
+/**
+ * Component IDs.
+ */
+export declare enum KupColumnMenuIds {
+  BUTTON_APPLY = "apply",
+  BUTTON_ADD_COLUMNS = "add",
+  BUTTON_GROUP = "group",
+  BUTTON_NEW = "new",
+  BUTTON_OPEN_IN_NEW = "open-in-new",
+  BUTTON_REMOVE = "remove",
+  BUTTON_SEARCH = "search",
+  CHECKBOX_GLOBAL = "global-checkbox",
+  SWITCH_GROUP = "group",
+  SWITCH_KEY = "key",
+  TEXTFIELD_FILTER = "filter",
+  TEXTFIELD_FORMULA = "formula",
+  TEXTFIELD_FROM = "filter-from",
+  TEXTFIELD_TO = "filter-to"
+}