@sme.up/ketchup 8.0.1 → 8.1.0

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

@@ -1,33 +1,33 @@
-/**
- * Interface related to the formulas factory function.
- */
-export interface KupMathFormulas {
-  custom: (formula: string, row: {
-    [index: string]: number;
-  }) => number;
-  normalDistribution: (average: number, variance: number, x: number) => number;
-}
-/**
- * Locales available for KupMath.
- */
-export declare enum KupMathLocales {
-  cn = "chs",
-  en = "en",
-  es = "es",
-  it = "it",
-  fr = "fr",
-  pl = "pl",
-  ru = "ru"
-}
-/**
- * Interface related to the numbers factory function.
- */
-export interface KupMathNumbers {
-  toLocaleString: (value: string) => string;
-}
-export interface NumericFieldFormatOptions {
-  integer: number;
-  decimal: number;
-  allowNegative: boolean;
-  group: boolean;
-}
+/**
+ * Interface related to the formulas factory function.
+ */
+export interface KupMathFormulas {
+  custom: (formula: string, row: {
+    [index: string]: number;
+  }) => number;
+  normalDistribution: (average: number, variance: number, x: number) => number;
+}
+/**
+ * Locales available for KupMath.
+ */
+export declare enum KupMathLocales {
+  cn = "chs",
+  en = "en",
+  es = "es",
+  it = "it",
+  fr = "fr",
+  pl = "pl",
+  ru = "ru"
+}
+/**
+ * Interface related to the numbers factory function.
+ */
+export interface KupMathNumbers {
+  toLocaleString: (value: string) => string;
+}
+export interface NumericFieldFormatOptions {
+  integer: number;
+  decimal: number;
+  allowNegative: boolean;
+  group: boolean;
+}

package/dist/types/managers/kup-math/kup-math-helper.d.ts

@@ -1,17 +1,17 @@
-/**
- * Takes a mathematical formula as string in input, with column names between brackets, and returns the result as a number.
- * @param {string} formula - Mathematical operation (i.e.: ([COL1] - [COL2]) * 100 / [COL3]).
- * @param {{ [index: string]: number }} row - Object containing column names as indexes and the related values as keys.
- * @returns {number} Result of the formula.
- */
-export declare function customFormula(formula: string, row: {
-  [index: string]: number;
-}): number;
-/**
- * Calculates a single Y point of a normal distribution.
- * @param {number} average - Average.
- * @param {number} variance - Variance.
- * @param {number} x - X coordinate.
- * @returns {number} Result.
- */
-export declare function normalDistributionFormula(average: number, variance: number, x: number): number;
+/**
+ * Takes a mathematical formula as string in input, with column names between brackets, and returns the result as a number.
+ * @param {string} formula - Mathematical operation (i.e.: ([COL1] - [COL2]) * 100 / [COL3]).
+ * @param {{ [index: string]: number }} row - Object containing column names as indexes and the related values as keys.
+ * @returns {number} Result of the formula.
+ */
+export declare function customFormula(formula: string, row: {
+  [index: string]: number;
+}): number;
+/**
+ * Calculates a single Y point of a normal distribution.
+ * @param {number} average - Average.
+ * @param {number} variance - Variance.
+ * @param {number} x - X coordinate.
+ * @returns {number} Result.
+ */
+export declare function normalDistributionFormula(average: number, variance: number, x: number): number;

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

@@ -1,85 +1,147 @@
-import numeral from 'numeral';
-import 'numeral/locales/chs';
-import 'numeral/locales/es';
-import 'numeral/locales/fr';
-import 'numeral/locales/it';
-import 'numeral/locales/pl';
-import 'numeral/locales/ru';
-import { KupComponent } from '../../types/GenericTypes';
-import { KupMathFormulas, KupMathLocales, KupMathNumbers, NumericFieldFormatOptions } from './kup-math-declarations';
-/**
- * Handles mathematical operations and number formatting/conversion.
- * @module KupMath
- */
-export declare class KupMath {
-  formulas: KupMathFormulas;
-  locale: KupMathLocales;
-  managedComponents: Set<KupComponent>;
-  numbers: KupMathNumbers;
-  numeral: typeof numeral;
-  /**
-   * Initializes KupMath.
-   */
-  constructor(locale?: KupMathLocales);
-  /**
-   * Sets the locale of the numeral instance. The locales available must be tied to the KupDates locales.
-   * @param {KupMathLocales} locale - Numeraljs locale string.
-   */
-  setLocale(locale: KupMathLocales): void;
-  /**
-   * Calculates the normal distribution on a set of values.
-   * @param {string[] | number[] | String[]} values - Array of values.
-   * @param {number} precision - Number of iterations to run (points). When not specified, defaults to 201.
-   * @returns {number[][]} Returns an array of arrays containing numbers, which are the representation of the calculated normal distribution.
-   */
-  normalDistribution(values: string[] | number[] | String[], precision?: number): number[][];
-  /**
-   * Formats the input number with the specified format of the currently set locale.
-   * @param {string | String | number} input - Input number which will be automatically "numberified".
-   * @param {string} format - Desired format. Defaults to '0,0.00' (i.e.: 2,000,000.51).
-   * @param {boolean} inputIsLocalized Numberifies assuming the input string is in the current KupMath locale's format.
-   * @returns {string} Formatted number.
-   */
-  format(input: string | String | number, format?: string, inputIsLocalized?: boolean): string;
-  /**
-   * Created the string for format a number
-   * @param {boolean} thousandPoint - show thousandPoint
-   * @param {number} decimals - number of decimals
-   */
-  createFormatPattern(thousandPoint?: boolean, decimals?: number): string;
-  /**
-   * Returns the decimal separator of current browser
-   * @returns current decimal separator, by locale
-   */
-  decimalSeparator(): string;
-  /**
-   * Returns the group separator of current browser
-   * @returns current group separator, by locale
-   */
-  groupSeparator(): string;
-  /**
-   * Checks if an input string matches options, for desired formatted decimal number (integer digits, decimal digits)
-   * @param value the input value to check
-   * @param options options for customize the check
-   * @returns an object from applying the regular expression for check
-   */
-  matchNumericValueWithOptions(value: string, options: NumericFieldFormatOptions): RegExpMatchArray;
-  /**
-   * Returns a number from a non-specified input type between string, number, or String.
-   * @param {string | String | number} input - Input value to numberify.
-   * @param {boolean} inputIsLocalized - Numberifies assuming the input string is in the current KupMath locale's format.
-   * @returns {number} Resulting number or NaN (when not a number).
-   */
-  numberify(input: string | String | number, inputIsLocalized?: boolean): number;
-  /**
-   * Registers a KupComponent in KupMath, in order to be properly handled whenever the locale changes.
-   * @param {any} component - The Ketchup component to be registered.
-   */
-  register(component: any): void;
-  /**
-   * Unregisters a KupComponent, so it won't be refreshed when the locale changes.
-   *
-   * @param {any} component - The component calling this function.
-   */
-  unregister(component: any): void;
-}
+import numeral from 'numeral';
+import 'numeral/locales/chs';
+import 'numeral/locales/es';
+import 'numeral/locales/fr';
+import 'numeral/locales/it';
+import 'numeral/locales/pl';
+import 'numeral/locales/ru';
+import { KupComponent } from '../../types/GenericTypes';
+import { KupMathFormulas, KupMathLocales, KupMathNumbers, NumericFieldFormatOptions } from './kup-math-declarations';
+/**
+ * Handles mathematical operations and number formatting/conversion.
+ * @module KupMath
+ */
+export declare class KupMath {
+  formulas: KupMathFormulas;
+  locale: KupMathLocales;
+  managedComponents: Set<KupComponent>;
+  numbers: KupMathNumbers;
+  numeral: typeof numeral;
+  /**
+   * Initializes KupMath.
+   */
+  constructor(locale?: KupMathLocales);
+  /**
+   * Sets the locale of the numeral instance. The locales available must be tied to the KupDates locales.
+   * @param {KupMathLocales} locale - Numeraljs locale string.
+   */
+  setLocale(locale: KupMathLocales): void;
+  /**
+   * Calculates the normal distribution on a set of values.
+   * @param {string[] | number[] | String[]} values - Array of values.
+   * @param {number} precision - Number of iterations to run (points). When not specified, defaults to 201.
+   * @returns {number[][]} Returns an array of arrays containing numbers, which are the representation of the calculated normal distribution.
+   */
+  normalDistribution(values: string[] | number[] | String[], precision?: number): number[][];
+  /**
+   * Formats the input number with the specified format of the currently set locale.
+   * @param {string | String | number} input - Input number which will be automatically "numberified".
+   * @param {string} format - Desired format. Defaults to '0,0.00' (i.e.: 2,000,000.51).
+   * @param {boolean} inputIsLocalized Numberifies assuming the input string is in the current KupMath locale's format.
+   * @returns {string} Formatted number.
+   */
+  format(input: string | String | number, format?: string, inputIsLocalized?: boolean): string;
+  /**
+   * Create the pattern string for format a number
+   * @param {boolean} thousandPoint - show thousandPoint
+   * @param {number} decimals - number of decimals
+   * @returns {string} - formatter pattern
+   */
+  createFormatPattern(thousandPoint?: boolean, decimals?: number): string;
+  /**
+   * Returns the decimal separator of current browser
+   * @returns {string} current decimal separator, by locale
+   */
+  decimalSeparator(): string;
+  /**
+   * Returns the group separator of current browser
+   * @returns {string} current group separator, by locale
+   */
+  groupSeparator(): string;
+  /**
+   * Checks if an input string matches options, for desired formatted decimal number (integer digits, decimal digits)
+   * @param {string} value the input value to check
+   * @param {NumericFieldFormatOptions} options options for customize the check
+   * @returns {RegExpMatchArray} an object from applying the regular expression for check
+   */
+  matchNumericValueWithOptions(value: string, options: NumericFieldFormatOptions): RegExpMatchArray;
+  /**
+   * Returns a number from a non-specified input type between string, number, or String.
+   * @param {string | String | number} input - Input value to numberify.
+   * @param {boolean} inputIsLocalized - Numberifies assuming the input string is in the current KupMath locale's format.
+   * @param {string} type - type of number for calculate suffix
+   * @param {string} decFmt - decimal format for the input value.
+   * @returns {number} Resulting number or NaN (when not a number).
+   */
+  numberify(input: string | String | number, inputIsLocalized?: boolean, type?: string, decFmt?: string): number;
+  /**
+   * Returns a number from a non-specified input type between string, number, or String.
+   * If value in is null, undefined or blank, returns 0
+   * @param {string} input number as string, formatted by locale US, decimal separator . (like java decimal numbers)
+   * @param {boolean} inputIsLocalized - Numberifies assuming the input string is in the current KupMath locale's format.
+   * @param {string} type - type of number for calculate suffix
+   * @returns {number} Resulting number
+   **/
+  numberifySafe(input: string, inputIsLocalized?: boolean, type?: string, decFmt?: string): number;
+  /**
+   * Checks if input is a valid number
+   * @param {any} value input value to check
+   * @returns {boolean} if input value is valid number
+   */
+  isNumber(value: any): boolean;
+  /**
+   * Checks if string in input is a valid formatted number
+   * @param {string} value number as string, formatted by actual browser locale
+   * @param {string} type - type of number for calculate suffix
+   * @returns {boolean} true if number string in input is a valid number
+   */
+  isStringNumber(value: string, type: string): boolean;
+  /**
+   * Gets number as string, formatted by locale US, decimal separator . (like java decimal numbers)
+   * @param {string} input number as string, formatted by actual browser locale (maybe)
+   * @param {string} type - type of number for calculate suffix
+   * @param {string} decSeparator - decimal serparator of input string
+   * @returns {string} number as string, formatted by locale US, decimal separator . (like java decimal numbers), without group separator
+   **/
+  formattedStringToNumberString(input: string, type: string, decSeparator?: string): string;
+  /**
+   * Gets the number of decimals for current number
+   * @param {number} value numer input
+   * @returns {number} the number of decimals
+   */
+  countDecimals(value: number): number;
+  /**
+   * Gets the suffix for number, by type
+   * @param {string} type - type of number for calculate suffix
+   * @returns {string} suffix for number, by type
+   **/
+  getNumericValueSuffix(type: string): string;
+  /**
+   * Gets the number as string, formatted by actual browser locale, with suffix by type
+   * @param {number} input number
+   * @param {number} decimals number of significant decimal digits for output
+   * @param {string} type - type of number for calculate suffix
+   * @returns {string} number as string, formatted by actual browser locale, with suffix by type
+   **/
+  numberToFormattedString(input: number, decimals: number, type: string): string;
+  /**
+   * Gets the number as string, formatted by actual browser locale, with suffix by type
+   * @param {string} input number as string, formatted by locale US, decimal separator . (like java decimal numbers)
+   * @param {number} decimals number of significant decimal digits for output
+   * @param {string} type - type of number for calculate suffix
+   * @param {string} decSeparator decimal separator for outpu string
+   * @returns {string} number as string, formatted by actual browser locale (or using decimal separator param), with suffix by type
+   **/
+  numberStringToFormattedString(input: string, decimals: number, type: string, decSeparator?: string): string;
+  /**
+   * Registers a KupComponent in KupMath, in order to be properly handled whenever the locale changes.
+   * @param {any} component - The Ketchup component to be registered.
+   */
+  register(component: any): void;
+  /**
+   * Unregisters a KupComponent, so it won't be refreshed when the locale changes.
+   *
+   * @param {any} component - The component calling this function.
+   */
+  unregister(component: any): void;
+}

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

@@ -1,15 +1,15 @@
-/**
- * Interface of the objects JSON.
- * << To be implemented, still a draft. >>
- */
-export interface KupObjectsJSON {
-  [index: string]: any;
-}
-/**
- * The composition of an object consists of: type, parameter, key.
- */
-export interface KupObj {
-  t: string;
-  p: string;
-  k: string;
-}
+/**
+ * Interface of the objects JSON.
+ * << To be implemented, still a draft. >>
+ */
+export interface KupObjectsJSON {
+  [index: string]: any;
+}
+/**
+ * The composition of an object consists of: type, parameter, key.
+ */
+export interface KupObj {
+  t: string;
+  p: string;
+  k: string;
+}