@empathyco/x-components 6.0.0-alpha.60 → 6.0.0-alpha.62

package/js/utils/currency-formatter.js.map

@@ -1 +1 @@
-{"version":3,"file":"currency-formatter.js","sources":["../../../src/utils/currency-formatter.ts"],"sourcesContent":["/**\n * Regex to detect the format.\n */\nconst FORMAT_REGEX = /(i([^id]+))?i+(([^id?]+)(d+)(\\?)?)?/;\n\n/**\n * Configuration for format currency.\n */\ninterface CurrencyConfig {\n  /** The character between a group of three integer 'i's and the following one. */\n  integerSeparator: string;\n  /**\n   * The character between a group of three integer 'i's and the following one. It also\n   * supports more than one single character.\n   */\n  decimalSeparator: string;\n  /** Length of decimals numbers. It counts the number of 'd's after the integer part. */\n  decimalsNumber: number;\n  /** Boolean value to hide or show the decimal part when it has 0. */\n  hideIntegerDecimals: boolean;\n}\n\n/**\n * Parts of number: integer and decimal.\n */\ninterface NumberParts {\n  /** Integer part of the number as string. */\n  integer: string;\n  /** Decimal part of the number as string. */\n  decimal: string;\n}\n\n/**\n * Format a value with a given format.\n *\n * @param value - Numeric value to be formatted.\n * @param format - Format or mask to be defined as string.\n *\n * @remarks\n * Format:\n * - Use 'i' to define integer numbers.\n * - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the\n * doesn't include decimals, it is filled with zeros until reach the length defined with 'd's.\n * - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group.\n * - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more\n * than one character.\n * - Set whatever you need around the integers and decimals marks.\n * - Default mask: 'i.iii,dd' which returns '1.345,67'.\n * - If you want to hide the decimal part if it's zero (non significant), you can add the `?` symbol\n * after the decimal characters (e.g. 'i.iii,dd?', for `1234` you would get `1.234` instead of\n * `1.234,00`). It defines the value of `hideIntegerDecimals`:\n * - If true (exists) and the value is an integer without decimals, the decimal non significant\n * zeroes are hidden.\n * - If false, the default behaviour will fill with zeros the remaining length until getting\n * the one defined with the 'd's.\n *\n * @returns Formatted number.\n *\n * @public\n */\nexport function currencyFormatter(value: number, format = 'i.iii,dd'): string {\n  const { integer, decimal } = numberParts(value);\n  const { decimalSeparator, decimalsNumber, integerSeparator, hideIntegerDecimals } =\n    currencyConfig(format);\n\n  const formattedInteger = formatInteger(integer, integerSeparator);\n  const formattedDecimal = formatDecimal(decimal, {\n    decimalsNumber,\n    hideIntegerDecimals,\n    decimalSeparator\n  });\n  return format.replace(FORMAT_REGEX, `${formattedInteger}${formattedDecimal}`);\n}\n\n/**\n * Returns the formatted integer part. This computed returns:\n * - integer part with the integer separator added.\n *\n * @param integer - Integer value as a string.\n * @param integerSeparator - Separator to apply in the integer side.\n *\n * The regexp adds the integer separator for each thousand group (each 3 numbers).\n *\n * @returns Formatted integer.\n *\n * @internal\n */\nfunction formatInteger(integer: string, integerSeparator: string): string {\n  return integer.replace(/\\B(?=(\\d{3})+(?!\\d))/g, integerSeparator);\n}\n\n/**\n * Returns the formatted decimal. This computed returns:\n * - decimal part filled with zeros until complete remaining slots defined with the decimal\n * length in the format.\n * - decimal part truncated. The decimal numbers length, defined with the number of 'd's in the\n * format prop. This must MATCH with the number of decimals provided from the adapter.\n *\n * @param decimal - Decimal part as a string.\n * @param CurrencyConfig - From which the `decimalsNumber`, `decimalsSeparator` and\n * `hideIntegerDecimals` are obtained.\n *\n * @returns Formatted integer.\n *\n * @internal\n */\nfunction formatDecimal(\n  decimal: string,\n  {\n    decimalsNumber,\n    decimalSeparator,\n    hideIntegerDecimals\n  }: Omit<CurrencyConfig, 'integerSeparator'>\n): string {\n  return hideIntegerDecimals && !+decimal\n    ? ''\n    : `${decimalSeparator}${decimal.padEnd(decimalsNumber, '0').substring(0, decimalsNumber)}`;\n}\n\n/**\n * Function that divide fhe format passed as value for get integerSeparator, decimalSeparator\n * and decimalsNumber.\n *\n * @param format - Format or mask to apply to the value.\n *\n * @returns Object with properties of the currency config.\n *\n * @internal\n */\nfunction currencyConfig(format: string): CurrencyConfig {\n  const [\n    ,\n    ,\n    integerSeparator = '',\n    ,\n    decimalSeparator = '',\n    decimals = '',\n    hideIntegerDecimals = ''\n  ] = FORMAT_REGEX.exec(format) ?? [];\n  return {\n    integerSeparator,\n    decimalSeparator,\n    decimalsNumber: decimals.length,\n    hideIntegerDecimals: !!hideIntegerDecimals\n  };\n}\n\n/**\n * Divide the number in two parts by separator '.', one of them is the integer number and other\n * the decimals numbers.\n *\n * @param value - Numeric value to be formatted.\n *\n * @returns Parts of number.\n *\n * @internal\n */\nfunction numberParts(value: number): NumberParts {\n  const [integer, decimal = ''] = `${value}`.split('.');\n  return {\n    integer,\n    decimal\n  };\n}\n"],"names":[],"mappings":"AAAA;;AAEG;AACH,MAAM,YAAY,GAAG,qCAAqC,CAAC;AA6B3D;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BG;SACa,iBAAiB,CAAC,KAAa,EAAE,MAAM,GAAG,UAAU,EAAA;IAClE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;AAChD,IAAA,MAAM,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,GAC/E,cAAc,CAAC,MAAM,CAAC,CAAC;IAEzB,MAAM,gBAAgB,GAAG,aAAa,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;AAClE,IAAA,MAAM,gBAAgB,GAAG,aAAa,CAAC,OAAO,EAAE;QAC9C,cAAc;QACd,mBAAmB;QACnB,gBAAgB;AACjB,KAAA,CAAC,CAAC;AACH,IAAA,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,CAAG,EAAA,gBAAgB,CAAG,EAAA,gBAAgB,CAAE,CAAA,CAAC,CAAC;AAChF,CAAC;AAED;;;;;;;;;;;;AAYG;AACH,SAAS,aAAa,CAAC,OAAe,EAAE,gBAAwB,EAAA;IAC9D,OAAO,OAAO,CAAC,OAAO,CAAC,uBAAuB,EAAE,gBAAgB,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;;;;;;;;;AAcG;AACH,SAAS,aAAa,CACpB,OAAe,EACf,EACE,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACsB,EAAA;AAE3C,IAAA,OAAO,mBAAmB,IAAI,CAAC,CAAC,OAAO;AACrC,UAAE,EAAE;UACF,GAAG,gBAAgB,CAAA,EAAG,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,cAAc,CAAC,EAAE,CAAC;AAC/F,CAAC;AAED;;;;;;;;;AASG;AACH,SAAS,cAAc,CAAC,MAAc,EAAA;AACpC,IAAA,MAAM,KAGJ,gBAAgB,GAAG,EAAE,IAErB,gBAAgB,GAAG,EAAE,EACrB,QAAQ,GAAG,EAAE,EACb,mBAAmB,GAAG,EAAE,CACzB,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IACpC,OAAO;QACL,gBAAgB;QAChB,gBAAgB;QAChB,cAAc,EAAE,QAAQ,CAAC,MAAM;QAC/B,mBAAmB,EAAE,CAAC,CAAC,mBAAmB;KAC3C,CAAC;AACJ,CAAC;AAED;;;;;;;;;AASG;AACH,SAAS,WAAW,CAAC,KAAa,EAAA;AAChC,IAAA,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,EAAE,CAAC,GAAG,CAAG,EAAA,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtD,OAAO;QACL,OAAO;QACP,OAAO;KACR,CAAC;AACJ;;;;"}
+{"version":3,"file":"currency-formatter.js","sources":["../../../src/utils/currency-formatter.ts"],"sourcesContent":["/**\n * Regex to detect the format.\n */\nconst FORMAT_REGEX = /(i([^id]+))?i+(([^id?]+)(d+)(\\?)?)?/\n\n/**\n * Configuration for format currency.\n */\ninterface CurrencyConfig {\n  /** The character between a group of three integer 'i's and the following one. */\n  integerSeparator: string\n  /**\n   * The character between a group of three integer 'i's and the following one. It also\n   * supports more than one single character.\n   */\n  decimalSeparator: string\n  /** Length of decimals numbers. It counts the number of 'd's after the integer part. */\n  decimalsNumber: number\n  /** Boolean value to hide or show the decimal part when it has 0. */\n  hideIntegerDecimals: boolean\n}\n\n/**\n * Parts of number: integer and decimal.\n */\ninterface NumberParts {\n  /** Integer part of the number as string. */\n  integer: string\n  /** Decimal part of the number as string. */\n  decimal: string\n}\n\n/**\n * Format a value with a given format.\n *\n * @param value - Numeric value to be formatted.\n * @param format - Format or mask to be defined as string.\n *\n * @remarks\n * Format:\n * - Use 'i' to define integer numbers.\n * - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the\n * doesn't include decimals, it is filled with zeros until reach the length defined with 'd's.\n * - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group.\n * - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more\n * than one character.\n * - Set whatever you need around the integers and decimals marks.\n * - Default mask: 'i.iii,dd' which returns '1.345,67'.\n * - If you want to hide the decimal part if it's zero (non significant), you can add the `?` symbol\n * after the decimal characters (e.g. 'i.iii,dd?', for `1234` you would get `1.234` instead of\n * `1.234,00`). It defines the value of `hideIntegerDecimals`:\n * - If true (exists) and the value is an integer without decimals, the decimal non significant\n * zeroes are hidden.\n * - If false, the default behaviour will fill with zeros the remaining length until getting\n * the one defined with the 'd's.\n *\n * @returns Formatted number.\n *\n * @public\n */\nexport function currencyFormatter(value: number, format = 'i.iii,dd'): string {\n  const { integer, decimal } = numberParts(value)\n  const { decimalSeparator, decimalsNumber, integerSeparator, hideIntegerDecimals } =\n    currencyConfig(format)\n\n  const formattedInteger = formatInteger(integer, integerSeparator)\n  const formattedDecimal = formatDecimal(decimal, {\n    decimalsNumber,\n    hideIntegerDecimals,\n    decimalSeparator,\n  })\n  return format.replace(FORMAT_REGEX, `${formattedInteger}${formattedDecimal}`)\n}\n\n/**\n * Returns the formatted integer part. This computed returns:\n * - integer part with the integer separator added.\n *\n * @param integer - Integer value as a string.\n * @param integerSeparator - Separator to apply in the integer side.\n *\n * The regexp adds the integer separator for each thousand group (each 3 numbers).\n *\n * @returns Formatted integer.\n *\n * @internal\n */\nfunction formatInteger(integer: string, integerSeparator: string): string {\n  return integer.replace(/\\B(?=(\\d{3})+(?!\\d))/g, integerSeparator)\n}\n\n/**\n * Returns the formatted decimal. This computed returns:\n * - decimal part filled with zeros until complete remaining slots defined with the decimal\n * length in the format.\n * - decimal part truncated. The decimal numbers length, defined with the number of 'd's in the\n * format prop. This must MATCH with the number of decimals provided from the adapter.\n *\n * @param decimal - Decimal part as a string.\n * @param CurrencyConfig - From which the `decimalsNumber`, `decimalsSeparator` and\n * `hideIntegerDecimals` are obtained.\n * @param CurrencyConfig.decimalsNumber - decimalsNumber currency config.\n * @param CurrencyConfig.decimalSeparator - decimalSeparator currency config.\n * @param CurrencyConfig.hideIntegerDecimals - hideIntegerDecimals currency config.\n *\n * @returns Formatted integer.\n *\n * @internal\n */\nfunction formatDecimal(\n  decimal: string,\n  {\n    decimalsNumber,\n    decimalSeparator,\n    hideIntegerDecimals,\n  }: Omit<CurrencyConfig, 'integerSeparator'>,\n): string {\n  return hideIntegerDecimals && !+decimal\n    ? ''\n    : `${decimalSeparator}${decimal.padEnd(decimalsNumber, '0').substring(0, decimalsNumber)}`\n}\n\n/**\n * Function that divide fhe format passed as value for get integerSeparator, decimalSeparator\n * and decimalsNumber.\n *\n * @param format - Format or mask to apply to the value.\n *\n * @returns Object with properties of the currency config.\n *\n * @internal\n */\nfunction currencyConfig(format: string): CurrencyConfig {\n  const [\n    ,\n    ,\n    integerSeparator = '',\n    ,\n    decimalSeparator = '',\n    decimals = '',\n    hideIntegerDecimals = '',\n  ] = FORMAT_REGEX.exec(format) ?? []\n  return {\n    integerSeparator,\n    decimalSeparator,\n    decimalsNumber: decimals.length,\n    hideIntegerDecimals: !!hideIntegerDecimals,\n  }\n}\n\n/**\n * Divide the number in two parts by separator '.', one of them is the integer number and other\n * the decimals numbers.\n *\n * @param value - Numeric value to be formatted.\n *\n * @returns Parts of number.\n *\n * @internal\n */\nfunction numberParts(value: number): NumberParts {\n  const [integer, decimal = ''] = `${value}`.split('.')\n  return {\n    integer,\n    decimal,\n  }\n}\n"],"names":[],"mappings":"AAAA;;AAEG;AACH,MAAM,YAAY,GAAG,qCAAqC,CAAA;AA6B1D;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BG;SACa,iBAAiB,CAAC,KAAa,EAAE,MAAM,GAAG,UAAU,EAAA;IAClE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC,KAAK,CAAC,CAAA;AAC/C,IAAA,MAAM,EAAE,gBAAgB,EAAE,cAAc,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,GAC/E,cAAc,CAAC,MAAM,CAAC,CAAA;IAExB,MAAM,gBAAgB,GAAG,aAAa,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAA;AACjE,IAAA,MAAM,gBAAgB,GAAG,aAAa,CAAC,OAAO,EAAE;QAC9C,cAAc;QACd,mBAAmB;QACnB,gBAAgB;AACjB,KAAA,CAAC,CAAA;AACF,IAAA,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,CAAG,EAAA,gBAAgB,CAAG,EAAA,gBAAgB,CAAE,CAAA,CAAC,CAAA;AAC/E,CAAC;AAED;;;;;;;;;;;;AAYG;AACH,SAAS,aAAa,CAAC,OAAe,EAAE,gBAAwB,EAAA;IAC9D,OAAO,OAAO,CAAC,OAAO,CAAC,uBAAuB,EAAE,gBAAgB,CAAC,CAAA;AACnE,CAAC;AAED;;;;;;;;;;;;;;;;;AAiBG;AACH,SAAS,aAAa,CACpB,OAAe,EACf,EACE,cAAc,EACd,gBAAgB,EAChB,mBAAmB,GACsB,EAAA;AAE3C,IAAA,OAAO,mBAAmB,IAAI,CAAC,CAAC,OAAO;AACrC,UAAE,EAAE;UACF,GAAG,gBAAgB,CAAA,EAAG,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,cAAc,CAAC,EAAE,CAAA;AAC9F,CAAC;AAED;;;;;;;;;AASG;AACH,SAAS,cAAc,CAAC,MAAc,EAAA;AACpC,IAAA,MAAM,KAGJ,gBAAgB,GAAG,EAAE,IAErB,gBAAgB,GAAG,EAAE,EACrB,QAAQ,GAAG,EAAE,EACb,mBAAmB,GAAG,EAAE,EACzB,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;IACnC,OAAO;QACL,gBAAgB;QAChB,gBAAgB;QAChB,cAAc,EAAE,QAAQ,CAAC,MAAM;QAC/B,mBAAmB,EAAE,CAAC,CAAC,mBAAmB;KAC3C,CAAA;AACH,CAAC;AAED;;;;;;;;;AASG;AACH,SAAS,WAAW,CAAC,KAAa,EAAA;AAChC,IAAA,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,EAAE,CAAC,GAAG,CAAG,EAAA,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACrD,OAAO;QACL,OAAO;QACP,OAAO;KACR,CAAA;AACH;;;;"}

package/js/utils/debounce.js

@@ -5,8 +5,6 @@
  * of the debounce time.
  *
  * @param fn - Function to be debounced.
- * @param debounceTimeInMs - The time of debounce in ms.
- * @param debounceOptions - The options for the debounce strategy.
  * @returns A new function with the debounce.
  *
  * @example Debounce options:

package/js/utils/debounce.js.map

@@ -1 +1 @@
-{"version":3,"file":"debounce.js","sources":["../../../src/utils/debounce.ts"],"sourcesContent":["/* eslint-disable max-len */\nimport { DebouncedFunction, DebounceOptions } from './types';\n\n/**\n * Util function that returns a debounced version of the function passed as parameter. It can use\n * the leading strategy, trailing strategy or both. Using both would result in one leading\n * execution guaranteed and trailing executions only if there are further calls during the length\n * of the debounce time.\n *\n * @param fn - Function to be debounced.\n * @param debounceTimeInMs - The time of debounce in ms.\n * @param debounceOptions - The options for the debounce strategy.\n * @returns A new function with the debounce.\n *\n * @example Debounce options:\n *\n * Given this code, where you configure the `trailing` and `leading` options:\n *\n * ```js\n * const log = debounce(name => console.log(name), 1000, {\n *   leading\n *   trailing\n * });\n *\n *  log('a'); // +0ms\n *  log('b'); // +0ms\n *  log('c'); // +0ms\n *  setTimeout(() => log('d'), 1000); // +1000ms\n *  setTimeout(() => log('e'), 1500); // +500ms\n *  setTimeout(() => log('f'), 2600); // +1100ms\n * ```\n *\n * | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\\ trailing<br/> leading \\\\ | **`false`** | **`true`**    |\n * |:----------------------------------------------------------------------------------------------------------|-------------|---------------|\n * | **`false`**                                                                                               |             | c, e, f       |\n * | **`true`**                                                                                                | a, d, f     | a, c, d, e, f |\n *\n * @public\n */\nexport const debounce = <Params extends any[]>(\n  fn: (...args: Params) => void,\n  debounceTimeInMs: number,\n  { leading = false, trailing = true }: DebounceOptions = {}\n): DebouncedFunction<Params> => {\n  let timer: ReturnType<typeof setTimeout> | undefined;\n  const debouncedFn: DebouncedFunction<Params> = (...args) => {\n    const isFirstLeadingCall = leading && !timer;\n    if (isFirstLeadingCall) {\n      fn(...args);\n    }\n    const trailingFn = (): void => {\n      timer = undefined;\n      if (!isFirstLeadingCall && trailing) {\n        fn(...args);\n      }\n    };\n    if (timer) {\n      clearTimeout(timer);\n    }\n    timer = setTimeout(() => trailingFn(), debounceTimeInMs);\n  };\n\n  debouncedFn.cancel = () => {\n    if (timer) {\n      clearTimeout(timer);\n    }\n  };\n  return debouncedFn;\n};\n"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmCG;MACU,QAAQ,GAAG,CACtB,EAA6B,EAC7B,gBAAwB,EACxB,EAAE,OAAO,GAAG,KAAK,EAAE,QAAQ,GAAG,IAAI,EAAsB,GAAA,EAAE,KAC7B;AAC7B,IAAA,IAAI,KAAgD,CAAC;AACrD,IAAA,MAAM,WAAW,GAA8B,CAAC,GAAG,IAAI,KAAI;AACzD,QAAA,MAAM,kBAAkB,GAAG,OAAO,IAAI,CAAC,KAAK,CAAC;AAC7C,QAAA,IAAI,kBAAkB,EAAE;AACtB,YAAA,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;AACb,SAAA;QACD,MAAM,UAAU,GAAG,MAAW;YAC5B,KAAK,GAAG,SAAS,CAAC;AAClB,YAAA,IAAI,CAAC,kBAAkB,IAAI,QAAQ,EAAE;AACnC,gBAAA,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;AACb,aAAA;AACH,SAAC,CAAC;AACF,QAAA,IAAI,KAAK,EAAE;YACT,YAAY,CAAC,KAAK,CAAC,CAAC;AACrB,SAAA;QACD,KAAK,GAAG,UAAU,CAAC,MAAM,UAAU,EAAE,EAAE,gBAAgB,CAAC,CAAC;AAC3D,KAAC,CAAC;AAEF,IAAA,WAAW,CAAC,MAAM,GAAG,MAAK;AACxB,QAAA,IAAI,KAAK,EAAE;YACT,YAAY,CAAC,KAAK,CAAC,CAAC;AACrB,SAAA;AACH,KAAC,CAAC;AACF,IAAA,OAAO,WAAW,CAAC;AACrB;;;;"}
+{"version":3,"file":"debounce.js","sources":["../../../src/utils/debounce.ts"],"sourcesContent":["import type { DebouncedFunction, DebounceOptions } from './types'\n\n/**\n * Util function that returns a debounced version of the function passed as parameter. It can use\n * the leading strategy, trailing strategy or both. Using both would result in one leading\n * execution guaranteed and trailing executions only if there are further calls during the length\n * of the debounce time.\n *\n * @param fn - Function to be debounced.\n * @returns A new function with the debounce.\n *\n * @example Debounce options:\n *\n * Given this code, where you configure the `trailing` and `leading` options:\n *\n * ```js\n * const log = debounce(name => console.log(name), 1000, {\n *   leading\n *   trailing\n * });\n *\n *  log('a'); // +0ms\n *  log('b'); // +0ms\n *  log('c'); // +0ms\n *  setTimeout(() => log('d'), 1000); // +1000ms\n *  setTimeout(() => log('e'), 1500); // +500ms\n *  setTimeout(() => log('f'), 2600); // +1100ms\n * ```\n *\n * | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\\\\ trailing<br/> leading \\\\ | **`false`** | **`true`**    |\n * |:----------------------------------------------------------------------------------------------------------|-------------|---------------|\n * | **`false`**                                                                                               |             | c, e, f       |\n * | **`true`**                                                                                                | a, d, f     | a, c, d, e, f |\n *\n * @public\n */\nexport const debounce = <Params extends any[]>(\n  fn: (...args: Params) => void,\n  debounceTimeInMs: number,\n  { leading = false, trailing = true }: DebounceOptions = {},\n): DebouncedFunction<Params> => {\n  let timer: ReturnType<typeof setTimeout> | undefined\n  const debouncedFn: DebouncedFunction<Params> = (...args) => {\n    const isFirstLeadingCall = leading && !timer\n    if (isFirstLeadingCall) {\n      fn(...args)\n    }\n    const trailingFn = (): void => {\n      timer = undefined\n      if (!isFirstLeadingCall && trailing) {\n        fn(...args)\n      }\n    }\n    if (timer) {\n      clearTimeout(timer)\n    }\n    timer = setTimeout(() => trailingFn(), debounceTimeInMs)\n  }\n\n  debouncedFn.cancel = () => {\n    if (timer) {\n      clearTimeout(timer)\n    }\n  }\n  return debouncedFn\n}\n"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCG;MACU,QAAQ,GAAG,CACtB,EAA6B,EAC7B,gBAAwB,EACxB,EAAE,OAAO,GAAG,KAAK,EAAE,QAAQ,GAAG,IAAI,EAAsB,GAAA,EAAE,KAC7B;AAC7B,IAAA,IAAI,KAAgD,CAAA;AACpD,IAAA,MAAM,WAAW,GAA8B,CAAC,GAAG,IAAI,KAAI;AACzD,QAAA,MAAM,kBAAkB,GAAG,OAAO,IAAI,CAAC,KAAK,CAAA;AAC5C,QAAA,IAAI,kBAAkB,EAAE;AACtB,YAAA,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;AACZ,SAAA;QACD,MAAM,UAAU,GAAG,MAAW;YAC5B,KAAK,GAAG,SAAS,CAAA;AACjB,YAAA,IAAI,CAAC,kBAAkB,IAAI,QAAQ,EAAE;AACnC,gBAAA,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;AACZ,aAAA;AACH,SAAC,CAAA;AACD,QAAA,IAAI,KAAK,EAAE;YACT,YAAY,CAAC,KAAK,CAAC,CAAA;AACpB,SAAA;QACD,KAAK,GAAG,UAAU,CAAC,MAAM,UAAU,EAAE,EAAE,gBAAgB,CAAC,CAAA;AAC1D,KAAC,CAAA;AAED,IAAA,WAAW,CAAC,MAAM,GAAG,MAAK;AACxB,QAAA,IAAI,KAAK,EAAE;YACT,YAAY,CAAC,KAAK,CAAC,CAAA;AACpB,SAAA;AACH,KAAC,CAAA;AACD,IAAA,OAAO,WAAW,CAAA;AACpB;;;;"}

package/js/utils/filters.js

@@ -27,7 +27,7 @@ function createRawFilters(filterIds) {
         return {
             id: filterId,
             modelName: 'RawFilter',
-            selected: true
+            selected: true,
         };
     });
 }

package/js/utils/filters.js.map

@@ -1 +1 @@
-{"version":3,"file":"filters.js","sources":["../../../src/utils/filters.ts"],"sourcesContent":["import { Filter, RawFilter } from '@empathyco/x-types';\n\n/**\n * Compares if two lists contains the same filters.\n *\n * @param someFilters - A list of filters to compare.\n * @param anotherFilters - Another list of filters to compare.\n *\n * @returns True if the two lists of filters are equal, which means that they have the same\n * filters. The position of the filter does not matter for this check.\n *\n * @public\n */\nexport function areFiltersDifferent(someFilters: Filter[], anotherFilters: Filter[]): boolean {\n  return (\n    someFilters.length !== anotherFilters.length ||\n    someFilters.some(filter => !anotherFilters.find(otherFilter => otherFilter.id === filter.id))\n  );\n}\n\n/**\n * Helper method which creates the filter entity from the filter ir of the url.\n *\n * @param filterIds - List of filter ids from the url.\n *\n * @returns A list of  filters.\n *\n * @public\n */\nexport function createRawFilters(filterIds: Array<Filter['id']>): RawFilter[] {\n  return filterIds.map(filterId => {\n    return {\n      id: filterId as string,\n      modelName: 'RawFilter',\n      selected: true\n    };\n  });\n}\n"],"names":[],"mappings":"AAEA;;;;;;;;;;AAUG;AACa,SAAA,mBAAmB,CAAC,WAAqB,EAAE,cAAwB,EAAA;AACjF,IAAA,QACE,WAAW,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM;QAC5C,WAAW,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,IAAI,WAAW,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,CAAC,EAC7F;AACJ,CAAC;AAED;;;;;;;;AAQG;AACG,SAAU,gBAAgB,CAAC,SAA8B,EAAA;AAC7D,IAAA,OAAO,SAAS,CAAC,GAAG,CAAC,QAAQ,IAAG;QAC9B,OAAO;AACL,YAAA,EAAE,EAAE,QAAkB;AACtB,YAAA,SAAS,EAAE,WAAW;AACtB,YAAA,QAAQ,EAAE,IAAI;SACf,CAAC;AACJ,KAAC,CAAC,CAAC;AACL;;;;"}
+{"version":3,"file":"filters.js","sources":["../../../src/utils/filters.ts"],"sourcesContent":["import type { Filter, RawFilter } from '@empathyco/x-types'\n\n/**\n * Compares if two lists contains the same filters.\n *\n * @param someFilters - A list of filters to compare.\n * @param anotherFilters - Another list of filters to compare.\n *\n * @returns True if the two lists of filters are equal, which means that they have the same\n * filters. The position of the filter does not matter for this check.\n *\n * @public\n */\nexport function areFiltersDifferent(someFilters: Filter[], anotherFilters: Filter[]): boolean {\n  return (\n    someFilters.length !== anotherFilters.length ||\n    someFilters.some(filter => !anotherFilters.find(otherFilter => otherFilter.id === filter.id))\n  )\n}\n\n/**\n * Helper method which creates the filter entity from the filter ir of the url.\n *\n * @param filterIds - List of filter ids from the url.\n *\n * @returns A list of  filters.\n *\n * @public\n */\nexport function createRawFilters(filterIds: Array<Filter['id']>): RawFilter[] {\n  return filterIds.map(filterId => {\n    return {\n      id: filterId as string,\n      modelName: 'RawFilter',\n      selected: true,\n    }\n  })\n}\n"],"names":[],"mappings":"AAEA;;;;;;;;;;AAUG;AACa,SAAA,mBAAmB,CAAC,WAAqB,EAAE,cAAwB,EAAA;AACjF,IAAA,QACE,WAAW,CAAC,MAAM,KAAK,cAAc,CAAC,MAAM;QAC5C,WAAW,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,IAAI,WAAW,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,CAAC,EAC9F;AACH,CAAC;AAED;;;;;;;;AAQG;AACG,SAAU,gBAAgB,CAAC,SAA8B,EAAA;AAC7D,IAAA,OAAO,SAAS,CAAC,GAAG,CAAC,QAAQ,IAAG;QAC9B,OAAO;AACL,YAAA,EAAE,EAAE,QAAkB;AACtB,YAAA,SAAS,EAAE,WAAW;AACtB,YAAA,QAAQ,EAAE,IAAI;SACf,CAAA;AACH,KAAC,CAAC,CAAA;AACJ;;;;"}

package/js/utils/focus.js

@@ -3,9 +3,7 @@
  *
  * @public
  */
-/* eslint-disable max-len */
-const FOCUSABLE_SELECTORS = 'a[href], button:not([disabled]), details, input:not([disabled]), select:not([disabled]), textarea:not([disabled]), [tabindex]:not([tabindex="-1"])';
-/* eslint-enable max-len */
+const FOCUSABLE_SELECTORS = 'a[href], button:not([disabled]), details, input:not([disabled]), select:not([disabled]), textarea:not([disabled]), [tabindex]:not([tabindex="-1"])';
 
 export { FOCUSABLE_SELECTORS };
 //# sourceMappingURL=focus.js.map

package/js/utils/focus.js.map

@@ -1 +1 @@
-{"version":3,"file":"focus.js","sources":["../../../src/utils/focus.ts"],"sourcesContent":["/**\n * Comma separated list of common focusable selectors.\n *\n * @public\n */\n/* eslint-disable max-len */\nexport const FOCUSABLE_SELECTORS =\n  'a[href], button:not([disabled]), details, input:not([disabled]), select:not([disabled]), textarea:not([disabled]), [tabindex]:not([tabindex=\"-1\"])';\n/* eslint-enable max-len */\n"],"names":[],"mappings":"AAAA;;;;AAIG;AACH;AACO,MAAM,mBAAmB,GAC9B,qJAAqJ;AACvJ;;;;"}
+{"version":3,"file":"focus.js","sources":["../../../src/utils/focus.ts"],"sourcesContent":["/**\n * Comma separated list of common focusable selectors.\n *\n * @public\n */\n\nexport const FOCUSABLE_SELECTORS =\n  'a[href], button:not([disabled]), details, input:not([disabled]), select:not([disabled]), textarea:not([disabled]), [tabindex]:not([tabindex=\"-1\"])'\n"],"names":[],"mappings":"AAAA;;;;AAIG;AAEI,MAAM,mBAAmB,GAC9B;;;;"}

package/js/utils/function.js

@@ -4,7 +4,6 @@
  *
  * @internal
  */
-// eslint-disable-next-line @typescript-eslint/no-empty-function
 function noOp() { }
 
 export { noOp };

package/js/utils/function.js.map

@@ -1 +1 @@
-{"version":3,"file":"function.js","sources":["../../../src/utils/function.ts"],"sourcesContent":["/**\n * Util function to be used as default parameter for callbacks, or optional functions\n * implementations.\n *\n * @internal\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nexport function noOp(): any {}\n"],"names":[],"mappings":"AAAA;;;;;AAKG;AACH;AACM,SAAU,IAAI,GAAA;;;;"}
+{"version":3,"file":"function.js","sources":["../../../src/utils/function.ts"],"sourcesContent":["/**\n * Util function to be used as default parameter for callbacks, or optional functions\n * implementations.\n *\n * @internal\n */\nexport function noOp(): any {}\n"],"names":[],"mappings":"AAAA;;;;;AAKG;AACG,SAAU,IAAI,GAAA;;;;"}

package/js/utils/get-url-parameters.js.map

@@ -1 +1 @@
-{"version":3,"file":"get-url-parameters.js","sources":["../../../src/utils/get-url-parameters.ts"],"sourcesContent":["/**\n * Get one parameter value from the url.\n *\n * @param param - The parameter to get from the url.\n * @returns The parameter value from the url.\n * @public\n */\nexport const getURLParameter = (param: string): string | null => {\n  const regex = new RegExp(`[?|&]${param}=([^&;]+?)(&|#|;|$)`);\n  const paramValue = regex.exec(window.location.href);\n  return paramValue ? decodeURIComponent(paramValue[1].replace(/\\+/g, '%20')) : null;\n};\n"],"names":[],"mappings":"AAAA;;;;;;AAMG;AACU,MAAA,eAAe,GAAG,CAAC,KAAa,KAAmB;IAC9D,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,CAAQ,KAAA,EAAA,KAAK,CAAqB,mBAAA,CAAA,CAAC,CAAC;AAC7D,IAAA,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACpD,OAAO,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;AACrF;;;;"}
+{"version":3,"file":"get-url-parameters.js","sources":["../../../src/utils/get-url-parameters.ts"],"sourcesContent":["/**\n * Get one parameter value from the url.\n *\n * @param param - The parameter to get from the url.\n * @returns The parameter value from the url.\n * @public\n */\nexport const getURLParameter = (param: string): string | null => {\n  const regex = new RegExp(`[?|&]${param}=([^&;]+?)(&|#|;|$)`)\n  const paramValue = regex.exec(window.location.href)\n  return paramValue ? decodeURIComponent(paramValue[1].replace(/\\+/g, '%20')) : null\n}\n"],"names":[],"mappings":"AAAA;;;;;;AAMG;AACU,MAAA,eAAe,GAAG,CAAC,KAAa,KAAmB;IAC9D,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,CAAQ,KAAA,EAAA,KAAK,CAAqB,mBAAA,CAAA,CAAC,CAAA;AAC5D,IAAA,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IACnD,OAAO,UAAU,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,GAAG,IAAI,CAAA;AACpF;;;;"}

package/js/utils/html.js.map

@@ -1 +1 @@
-{"version":3,"file":"html.js","sources":["../../../src/utils/html.ts"],"sourcesContent":["/**\n * Returns true if the two elements are the same, or if `b` is a child of `a`.\n *\n * @param a - The element to check if it is equal to `b` or if it contains `b`.\n * @param b - The element to check if it is equal to `a` or contained inside it.\n * @returns True if `a` is equal to `b` or if it contains `b`.\n *\n * @public\n */\nexport function isElementEqualOrContained(a: Element, b: Element): boolean {\n  return a === b || a.contains(b);\n}\n\n/**\n * Returns the target element for a given event. The target element is obtained from `composedPath`\n * Event method because if the event is triggered inside a Shadow DOM context, `event.target` points\n * to Shadow DOM element, not the element that triggered the event. `composedPath` method also is\n * available in a non-shadow DOM context.\n *\n * @remarks In a shadow DOM context, this function only works if the Shadow DOM uses `open`\n * encapsulation mode.\n *\n * @param event - Event which takes place in the DOM.\n * @returns Target Element of the event.\n *\n * @public\n */\nexport function getTargetElement(event: Event): Element {\n  return event.composedPath()[0] as Element;\n}\n\n/**\n * Retrieves the currently active element from the specified document or shadow root.\n * This function is recursive to handle nested shadow DOMs, ensuring the actual active\n * element is returned even if it resides deep within multiple shadow DOM layers.\n *\n * @param root - The root document or shadow root from which to retrieve the active element.\n * Defaults to the global document if not specified.\n * @returns The active element if one exists, or null if no active element can be found.\n * In the context of shadow DOM, this will return the deepest active element\n * within nested shadow roots.\n *\n * @public\n */\nexport function getActiveElement(root: Document | ShadowRoot = document): Element | null {\n  let current = root.activeElement;\n  while (current?.shadowRoot) {\n    current = current.shadowRoot.activeElement;\n  }\n  return current;\n}\n"],"names":[],"mappings":"AAAA;;;;;;;;AAQG;AACa,SAAA,yBAAyB,CAAC,CAAU,EAAE,CAAU,EAAA;IAC9D,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;;AAaG;AACG,SAAU,gBAAgB,CAAC,KAAY,EAAA;AAC3C,IAAA,OAAO,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAY,CAAC;AAC5C,CAAC;AAED;;;;;;;;;;;;AAYG;AACa,SAAA,gBAAgB,CAAC,IAAA,GAA8B,QAAQ,EAAA;AACrE,IAAA,IAAI,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC;IACjC,OAAO,OAAO,EAAE,UAAU,EAAE;AAC1B,QAAA,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC;AAC5C,KAAA;AACD,IAAA,OAAO,OAAO,CAAC;AACjB;;;;"}
+{"version":3,"file":"html.js","sources":["../../../src/utils/html.ts"],"sourcesContent":["/**\n * Returns true if the two elements are the same, or if `b` is a child of `a`.\n *\n * @param a - The element to check if it is equal to `b` or if it contains `b`.\n * @param b - The element to check if it is equal to `a` or contained inside it.\n * @returns True if `a` is equal to `b` or if it contains `b`.\n *\n * @public\n */\nexport function isElementEqualOrContained(a: Element, b: Element): boolean {\n  return a === b || a.contains(b)\n}\n\n/**\n * Returns the target element for a given event. The target element is obtained from `composedPath`\n * Event method because if the event is triggered inside a Shadow DOM context, `event.target` points\n * to Shadow DOM element, not the element that triggered the event. `composedPath` method also is\n * available in a non-shadow DOM context.\n *\n * @remarks In a shadow DOM context, this function only works if the Shadow DOM uses `open`\n * encapsulation mode.\n *\n * @param event - Event which takes place in the DOM.\n * @returns Target Element of the event.\n *\n * @public\n */\nexport function getTargetElement(event: Event): Element {\n  return event.composedPath()[0] as Element\n}\n\n/**\n * Retrieves the currently active element from the specified document or shadow root.\n * This function is recursive to handle nested shadow DOMs, ensuring the actual active\n * element is returned even if it resides deep within multiple shadow DOM layers.\n *\n * @param root - The root document or shadow root from which to retrieve the active element.\n * Defaults to the global document if not specified.\n * @returns The active element if one exists, or null if no active element can be found.\n * In the context of shadow DOM, this will return the deepest active element\n * within nested shadow roots.\n *\n * @public\n */\nexport function getActiveElement(root: Document | ShadowRoot = document): Element | null {\n  let current = root.activeElement\n  while (current?.shadowRoot) {\n    current = current.shadowRoot.activeElement\n  }\n  return current\n}\n"],"names":[],"mappings":"AAAA;;;;;;;;AAQG;AACa,SAAA,yBAAyB,CAAC,CAAU,EAAE,CAAU,EAAA;IAC9D,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;AACjC,CAAC;AAED;;;;;;;;;;;;;AAaG;AACG,SAAU,gBAAgB,CAAC,KAAY,EAAA;AAC3C,IAAA,OAAO,KAAK,CAAC,YAAY,EAAE,CAAC,CAAC,CAAY,CAAA;AAC3C,CAAC;AAED;;;;;;;;;;;;AAYG;AACa,SAAA,gBAAgB,CAAC,IAAA,GAA8B,QAAQ,EAAA;AACrE,IAAA,IAAI,OAAO,GAAG,IAAI,CAAC,aAAa,CAAA;IAChC,OAAO,OAAO,EAAE,UAAU,EAAE;AAC1B,QAAA,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,aAAa,CAAA;AAC3C,KAAA;AACD,IAAA,OAAO,OAAO,CAAA;AAChB;;;;"}

package/js/utils/is-new-query.js.map

@@ -1 +1 @@
-{"version":3,"file":"is-new-query.js","sources":["../../../src/utils/is-new-query.ts"],"sourcesContent":["import { isStringEmpty } from './string';\n\n/**\n * Regex for splitting a query into its words.\n *\n * @public\n */\nexport const SPLIT_WORDS_REGEX = /[\\s-]/;\n\n/**\n * Compares two queries to know if the new one is a refined query from the previous one or a new\n * one.\n *\n * A refined query is a query which has the previous query or part of it.\n * Example:\n * - previousQuery = 'lego star'.\n * - newQuery = 'lego star wars'.\n *\n * Example:\n * - previousQuery = 'lego star wars'.\n * - newQuery = 'lego star'.\n *\n * A new query is a query which has not the previous query.\n * Example:\n * - previousQuery = 'lego star'.\n * - newQuery = 'lego wars'.\n *\n * In this case, it is changing the word set, because a word is changed by another one, so\n * this is changing the search intention.\n *\n * @param newQuery - The new query.\n * @param previousQuery - The previous query.\n *\n * @returns A boolean which flags if the query is refined or not.\n *\n * @public\n */\nexport function isNewQuery(newQuery: string, previousQuery: string): boolean {\n  const isNewQueryEmpty = isStringEmpty(newQuery);\n  const isPreviousQueryEmpty = isStringEmpty(previousQuery);\n  const previousQueryWords = previousQuery.split(SPLIT_WORDS_REGEX);\n  const newQueryWords = newQuery.split(SPLIT_WORDS_REGEX);\n  return (\n    !previousQueryWords.every(previousQueryWord =>\n      newQueryWords.some(\n        newQueryWord =>\n          newQueryWord.includes(previousQueryWord) || previousQueryWord.includes(newQueryWord)\n      )\n    ) ||\n    (isNewQueryEmpty && !isPreviousQueryEmpty) ||\n    (!isNewQueryEmpty && isPreviousQueryEmpty)\n  );\n}\n"],"names":[],"mappings":";;AAEA;;;;AAIG;AACI,MAAM,iBAAiB,GAAG,QAAQ;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BG;AACa,SAAA,UAAU,CAAC,QAAgB,EAAE,aAAqB,EAAA;AAChE,IAAA,MAAM,eAAe,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;AAChD,IAAA,MAAM,oBAAoB,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;IAC1D,MAAM,kBAAkB,GAAG,aAAa,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAClE,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;AACxD,IAAA,QACE,CAAC,kBAAkB,CAAC,KAAK,CAAC,iBAAiB,IACzC,aAAa,CAAC,IAAI,CAChB,YAAY,IACV,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,iBAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,CACvF,CACF;AACD,SAAC,eAAe,IAAI,CAAC,oBAAoB,CAAC;AAC1C,SAAC,CAAC,eAAe,IAAI,oBAAoB,CAAC,EAC1C;AACJ;;;;"}
+{"version":3,"file":"is-new-query.js","sources":["../../../src/utils/is-new-query.ts"],"sourcesContent":["import { isStringEmpty } from './string'\n\n/**\n * Regex for splitting a query into its words.\n *\n * @public\n */\nexport const SPLIT_WORDS_REGEX = /[\\s-]/\n\n/**\n * Compares two queries to know if the new one is a refined query from the previous one or a new\n * one.\n *\n * A refined query is a query which has the previous query or part of it.\n * Example:\n * - previousQuery = 'lego star'.\n * - newQuery = 'lego star wars'.\n *\n * Example:\n * - previousQuery = 'lego star wars'.\n * - newQuery = 'lego star'.\n *\n * A new query is a query which has not the previous query.\n * Example:\n * - previousQuery = 'lego star'.\n * - newQuery = 'lego wars'.\n *\n * In this case, it is changing the word set, because a word is changed by another one, so\n * this is changing the search intention.\n *\n * @param newQuery - The new query.\n * @param previousQuery - The previous query.\n *\n * @returns A boolean which flags if the query is refined or not.\n *\n * @public\n */\nexport function isNewQuery(newQuery: string, previousQuery: string): boolean {\n  const isNewQueryEmpty = isStringEmpty(newQuery)\n  const isPreviousQueryEmpty = isStringEmpty(previousQuery)\n  const previousQueryWords = previousQuery.split(SPLIT_WORDS_REGEX)\n  const newQueryWords = newQuery.split(SPLIT_WORDS_REGEX)\n  return (\n    !previousQueryWords.every(previousQueryWord =>\n      newQueryWords.some(\n        newQueryWord =>\n          newQueryWord.includes(previousQueryWord) || previousQueryWord.includes(newQueryWord),\n      ),\n    ) ||\n    (isNewQueryEmpty && !isPreviousQueryEmpty) ||\n    (!isNewQueryEmpty && isPreviousQueryEmpty)\n  )\n}\n"],"names":[],"mappings":";;AAEA;;;;AAIG;AACI,MAAM,iBAAiB,GAAG,QAAO;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BG;AACa,SAAA,UAAU,CAAC,QAAgB,EAAE,aAAqB,EAAA;AAChE,IAAA,MAAM,eAAe,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAA;AAC/C,IAAA,MAAM,oBAAoB,GAAG,aAAa,CAAC,aAAa,CAAC,CAAA;IACzD,MAAM,kBAAkB,GAAG,aAAa,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAA;IACjE,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAA;AACvD,IAAA,QACE,CAAC,kBAAkB,CAAC,KAAK,CAAC,iBAAiB,IACzC,aAAa,CAAC,IAAI,CAChB,YAAY,IACV,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,iBAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,CACvF,CACF;AACD,SAAC,eAAe,IAAI,CAAC,oBAAoB,CAAC;AAC1C,SAAC,CAAC,eAAe,IAAI,oBAAoB,CAAC,EAC3C;AACH;;;;"}

package/js/utils/normalize.js

@@ -9,7 +9,7 @@
  * diacritical marks. Else the same string.
  */
 const removeCombiningDiacriticalMarks = typeof String.prototype.normalize === 'function'
-    ? (string) => string.normalize('NFD').replace(/[\u0300-\u036f]/g, '')
+    ? (string) => string.normalize('NFD').replace(/[\u0300-\u036F]/g, '')
     : (string) => string;
 /**
  * Trims the string, transforms it to lower case, and removes

package/js/utils/normalize.js.map

@@ -1 +1 @@
-{"version":3,"file":"normalize.js","sources":["../../../src/utils/normalize.ts"],"sourcesContent":["/**\n * If the `String.normalize` function is available in the environment, it removes the\n * {@link https://en.wikipedia.org/wiki/Combining_Diacritical_Marks | combining diacritical marks}\n * characters from it.\n * Otherwise, it just returns the same string.\n *\n * @param string - The string to remove its combining diacritical mark characters.\n * @returns If the environment supports string normalization, the string without the combining\n * diacritical marks. Else the same string.\n */\nconst removeCombiningDiacriticalMarks =\n  typeof String.prototype.normalize === 'function'\n    ? (string: string) => string.normalize('NFD').replace(/[\\u0300-\\u036f]/g, '')\n    : (string: string) => string;\n\n/**\n * Trims the string, transforms it to lower case, and removes\n * {@link https://en.wikipedia.org/wiki/Combining_Diacritical_Marks | combining diacritical marks}\n * from it.\n *\n * @param string - The string to normalize.\n * @returns The normalized version of the string.\n * @public\n */\nexport function normalizeString(string: string | undefined): string {\n  string = string?.trim().toLowerCase() ?? '';\n  return removeCombiningDiacriticalMarks(string);\n}\n"],"names":[],"mappings":"AAAA;;;;;;;;;AASG;AACH,MAAM,+BAA+B,GACnC,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,KAAK,UAAU;AAC9C,MAAE,CAAC,MAAc,KAAK,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;AAC7E,MAAE,CAAC,MAAc,KAAK,MAAM,CAAC;AAEjC;;;;;;;;AAQG;AACG,SAAU,eAAe,CAAC,MAA0B,EAAA;IACxD,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC;AAC5C,IAAA,OAAO,+BAA+B,CAAC,MAAM,CAAC,CAAC;AACjD;;;;"}
+{"version":3,"file":"normalize.js","sources":["../../../src/utils/normalize.ts"],"sourcesContent":["/**\n * If the `String.normalize` function is available in the environment, it removes the\n * {@link https://en.wikipedia.org/wiki/Combining_Diacritical_Marks | combining diacritical marks}\n * characters from it.\n * Otherwise, it just returns the same string.\n *\n * @param string - The string to remove its combining diacritical mark characters.\n * @returns If the environment supports string normalization, the string without the combining\n * diacritical marks. Else the same string.\n */\nconst removeCombiningDiacriticalMarks =\n  typeof String.prototype.normalize === 'function'\n    ? (string: string) => string.normalize('NFD').replace(/[\\u0300-\\u036F]/g, '')\n    : (string: string) => string\n\n/**\n * Trims the string, transforms it to lower case, and removes\n * {@link https://en.wikipedia.org/wiki/Combining_Diacritical_Marks | combining diacritical marks}\n * from it.\n *\n * @param string - The string to normalize.\n * @returns The normalized version of the string.\n * @public\n */\nexport function normalizeString(string: string | undefined): string {\n  string = string?.trim().toLowerCase() ?? ''\n  return removeCombiningDiacriticalMarks(string)\n}\n"],"names":[],"mappings":"AAAA;;;;;;;;;AASG;AACH,MAAM,+BAA+B,GACnC,OAAO,MAAM,CAAC,SAAS,CAAC,SAAS,KAAK,UAAU;AAC9C,MAAE,CAAC,MAAc,KAAK,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC;AAC7E,MAAE,CAAC,MAAc,KAAK,MAAM,CAAA;AAEhC;;;;;;;;AAQG;AACG,SAAU,eAAe,CAAC,MAA0B,EAAA;IACxD,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE,IAAI,EAAE,CAAA;AAC3C,IAAA,OAAO,+BAA+B,CAAC,MAAM,CAAC,CAAA;AAChD;;;;"}

package/js/utils/number.js

@@ -5,7 +5,6 @@
  * @param number - The number to check if it belongs to the range.
  * @param range - The range that the number should be in.
  * @returns True when the number is in the range. False otherwise.
- *
  * @public
  */
 function isInRange(number, [min, max]) {

package/js/utils/number.js.map

@@ -1 +1 @@
-{"version":3,"file":"number.js","sources":["../../../src/utils/number.ts"],"sourcesContent":["/**\n * Returns true if the number is greater than or equal than the min, and less than or equal than\n * the max.\n *\n * @param number - The number to check if it belongs to the range.\n * @param range - The range that the number should be in.\n * @returns True when the number is in the range. False otherwise.\n *\n * @public\n */\nexport function isInRange(number: number, [min, max]: [number, number]): boolean {\n  return number >= min && number <= max;\n}\n"],"names":[],"mappings":"AAAA;;;;;;;;;AASG;AACG,SAAU,SAAS,CAAC,MAAc,EAAE,CAAC,GAAG,EAAE,GAAG,CAAmB,EAAA;AACpE,IAAA,OAAO,MAAM,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,CAAC;AACxC;;;;"}
+{"version":3,"file":"number.js","sources":["../../../src/utils/number.ts"],"sourcesContent":["/**\n * Returns true if the number is greater than or equal than the min, and less than or equal than\n * the max.\n *\n * @param number - The number to check if it belongs to the range.\n * @param range - The range that the number should be in.\n * @returns True when the number is in the range. False otherwise.\n * @public\n */\nexport function isInRange(number: number, [min, max]: [number, number]): boolean {\n  return number >= min && number <= max\n}\n"],"names":[],"mappings":"AAAA;;;;;;;;AAQG;AACG,SAAU,SAAS,CAAC,MAAc,EAAE,CAAC,GAAG,EAAE,GAAG,CAAmB,EAAA;AACpE,IAAA,OAAO,MAAM,IAAI,GAAG,IAAI,MAAM,IAAI,GAAG,CAAA;AACvC;;;;"}

package/js/utils/origin.js

@@ -5,12 +5,10 @@
  *
  * @param originInit - An object containing the needed properties to create a {@link QueryOrigin} or
  * a {@link ResultOrigin}.
- *
  * @returns The composed origin, or `null` if it is not able to create the origin.
- *
  * @internal
  */
-function createOrigin({ feature, location }) {
+function createOrigin({ feature, location, }) {
     if (feature) {
         return `${feature}:${location ?? 'none'}`;
     }

package/js/utils/origin.js.map

@@ -1 +1 @@
-{"version":3,"file":"origin.js","sources":["../../../src/utils/origin.ts"],"sourcesContent":["import { QueryOrigin, QueryOriginInit, ResultOrigin } from '../types/origin';\n\n/**\n * Creates a {@link QueryOrigin} or a {@link ResultOrigin} string given a {@link QueryFeature} and\n * a {@link FeatureLocation}.\n * If it can't be created, it returns `null`.\n *\n * @param originInit - An object containing the needed properties to create a {@link QueryOrigin} or\n * a {@link ResultOrigin}.\n *\n * @returns The composed origin, or `null` if it is not able to create the origin.\n *\n * @internal\n */\nexport function createOrigin({\n  feature,\n  location\n}: QueryOriginInit): QueryOrigin | ResultOrigin | null {\n  if (feature) {\n    return `${feature}:${location ?? 'none'}`;\n  }\n  return null;\n}\n"],"names":[],"mappings":"AAEA;;;;;;;;;;;AAWG;SACa,YAAY,CAAC,EAC3B,OAAO,EACP,QAAQ,EACQ,EAAA;AAChB,IAAA,IAAI,OAAO,EAAE;AACX,QAAA,OAAO,GAAG,OAAO,CAAA,CAAA,EAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;AAC3C,KAAA;AACD,IAAA,OAAO,IAAI,CAAC;AACd;;;;"}
+{"version":3,"file":"origin.js","sources":["../../../src/utils/origin.ts"],"sourcesContent":["import type { QueryOrigin, QueryOriginInit, ResultOrigin } from '../types/origin'\n\n/**\n * Creates a {@link QueryOrigin} or a {@link ResultOrigin} string given a {@link QueryFeature} and\n * a {@link FeatureLocation}.\n * If it can't be created, it returns `null`.\n *\n * @param originInit - An object containing the needed properties to create a {@link QueryOrigin} or\n * a {@link ResultOrigin}.\n * @returns The composed origin, or `null` if it is not able to create the origin.\n * @internal\n */\nexport function createOrigin({\n  feature,\n  location,\n}: QueryOriginInit): QueryOrigin | ResultOrigin | null {\n  if (feature) {\n    return `${feature}:${location ?? 'none'}`\n  }\n  return null\n}\n"],"names":[],"mappings":"AAEA;;;;;;;;;AASG;SACa,YAAY,CAAC,EAC3B,OAAO,EACP,QAAQ,GACQ,EAAA;AAChB,IAAA,IAAI,OAAO,EAAE;AACX,QAAA,OAAO,GAAG,OAAO,CAAA,CAAA,EAAI,QAAQ,IAAI,MAAM,EAAE,CAAA;AAC1C,KAAA;AACD,IAAA,OAAO,IAAI,CAAA;AACb;;;;"}

package/js/utils/sanitize.js.map

@@ -1 +1 @@
-{"version":3,"file":"sanitize.js","sources":["../../../src/utils/sanitize.ts"],"sourcesContent":["const REPLACE_REGEX = /[<>&]/g;\n/**\n * Sanitize characters from a given string.\n *\n * @param str - The string to remove unwanted characters.\n * @returns The string without the unwanted characters.\n * @public\n */\nexport const sanitize = (str: string): string => {\n  return str.replace(REPLACE_REGEX, key => `&#${key.charCodeAt(0)};`);\n};\n"],"names":[],"mappings":"AAAA,MAAM,aAAa,GAAG,QAAQ,CAAC;AAC/B;;;;;;AAMG;AACU,MAAA,QAAQ,GAAG,CAAC,GAAW,KAAY;AAC9C,IAAA,OAAO,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,IAAI,CAAK,EAAA,EAAA,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA,CAAA,CAAG,CAAC,CAAC;AACtE;;;;"}
+{"version":3,"file":"sanitize.js","sources":["../../../src/utils/sanitize.ts"],"sourcesContent":["const REPLACE_REGEX = /[<>&]/g\n/**\n * Sanitize characters from a given string.\n *\n * @param str - The string to remove unwanted characters.\n * @returns The string without the unwanted characters.\n * @public\n */\nexport const sanitize = (str: string): string => {\n  return str.replace(REPLACE_REGEX, key => `&#${key.charCodeAt(0)};`)\n}\n"],"names":[],"mappings":"AAAA,MAAM,aAAa,GAAG,QAAQ,CAAA;AAC9B;;;;;;AAMG;AACU,MAAA,QAAQ,GAAG,CAAC,GAAW,KAAY;AAC9C,IAAA,OAAO,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,GAAG,IAAI,CAAK,EAAA,EAAA,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA,CAAA,CAAG,CAAC,CAAA;AACrE;;;;"}

package/js/utils/storage.js

@@ -15,7 +15,7 @@ const localStorageService = typeof localStorage !== 'undefined'
         clear: noOp,
         getItem: noOp,
         setItem: noOp,
-        removeItem: noOp
+        removeItem: noOp,
     };
 
 export { localStorageService };

package/js/utils/storage.js.map

@@ -1 +1 @@
-{"version":3,"file":"storage.js","sources":["../../../src/utils/storage.ts"],"sourcesContent":["import { BrowserStorageService, StorageService } from '@empathyco/x-storage-service';\nimport { noOp } from './function';\n\n/**\n * Service instance of {@link @empathyco/x-storage-service#StorageService | storage service} if\n * localStorage is available.\n * If not, required {@link @empathyco/x-storage-service#StorageService | storage service} functions\n * are initialized with empty implementations.\n *\n * @internal\n */\nexport const localStorageService: StorageService =\n  typeof localStorage !== 'undefined'\n    ? new BrowserStorageService(localStorage, 'x')\n    : {\n        clear: noOp,\n        getItem: noOp,\n        setItem: noOp,\n        removeItem: noOp\n      };\n"],"names":[],"mappings":";;;AAGA;;;;;;;AAOG;AACU,MAAA,mBAAmB,GAC9B,OAAO,YAAY,KAAK,WAAW;AACjC,MAAE,IAAI,qBAAqB,CAAC,YAAY,EAAE,GAAG,CAAC;AAC9C,MAAE;AACE,QAAA,KAAK,EAAE,IAAI;AACX,QAAA,OAAO,EAAE,IAAI;AACb,QAAA,OAAO,EAAE,IAAI;AACb,QAAA,UAAU,EAAE,IAAI;;;;;"}
+{"version":3,"file":"storage.js","sources":["../../../src/utils/storage.ts"],"sourcesContent":["import type { StorageService } from '@empathyco/x-storage-service'\nimport { BrowserStorageService } from '@empathyco/x-storage-service'\nimport { noOp } from './function'\n\n/**\n * Service instance of {@link @empathyco/x-storage-service#StorageService | storage service} if\n * localStorage is available.\n * If not, required {@link @empathyco/x-storage-service#StorageService | storage service} functions\n * are initialized with empty implementations.\n *\n * @internal\n */\nexport const localStorageService: StorageService =\n  typeof localStorage !== 'undefined'\n    ? new BrowserStorageService(localStorage, 'x')\n    : {\n        clear: noOp,\n        getItem: noOp,\n        setItem: noOp,\n        removeItem: noOp,\n      }\n"],"names":[],"mappings":";;;AAIA;;;;;;;AAOG;AACU,MAAA,mBAAmB,GAC9B,OAAO,YAAY,KAAK,WAAW;AACjC,MAAE,IAAI,qBAAqB,CAAC,YAAY,EAAE,GAAG,CAAC;AAC9C,MAAE;AACE,QAAA,KAAK,EAAE,IAAI;AACX,QAAA,OAAO,EAAE,IAAI;AACb,QAAA,OAAO,EAAE,IAAI;AACb,QAAA,UAAU,EAAE,IAAI;;;;;"}

package/js/utils/string.js.map

@@ -1 +1 @@
-{"version":3,"file":"string.js","sources":["../../../src/utils/string.ts"],"sourcesContent":["/**\n * Util used to return true if the string is empty, undefined or null.\n *\n * @param str - String value.\n * @returns Returns true if str is an empty string, undefined or null.\n * @public\n */\nexport function isStringEmpty(str?: string | null): boolean {\n  return !str || str.length === 0;\n}\n\n/**\n * Util to transform string a into kebab case.\n *\n * @example\n * Transforms `camelCase` into `camel-case`\n * Transforms `PascalCase` into `pascal-case`\n * Transforms `snake_case` into `snake-case`\n * Transforms `space space  multispaces` into `space-space-multiplespaces`\n * Transforms `kebab-case` into `kebab-case`\n *\n * @param str - String value.\n * @returns Returns the string in kebab case.\n * @public\n */\nexport function toKebabCase(str: string): string {\n  return str\n    .replace(/([a-z])([A-Z])/g, '$1-$2')\n    .replace(/\\s+|_/g, '-')\n    .toLowerCase();\n}\n\n/**\n * Util to capitalize a string .\n *\n * @example\n * Transforms `query` into `Query`\n *\n * @param str - String value.\n *\n * @returns Returns the string capitalized.\n *\n * @public\n */\nexport function capitalize<StrType extends string>(str: StrType): Capitalize<StrType> {\n  return (str.charAt(0).toUpperCase() + str.slice(1)) as Capitalize<StrType>;\n}\n"],"names":[],"mappings":"AAAA;;;;;;AAMG;AACG,SAAU,aAAa,CAAC,GAAmB,EAAA;IAC/C,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;;;;;;;AAaG;AACG,SAAU,WAAW,CAAC,GAAW,EAAA;AACrC,IAAA,OAAO,GAAG;AACP,SAAA,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;AACnC,SAAA,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;AACtB,SAAA,WAAW,EAAE,CAAC;AACnB,CAAC;AAED;;;;;;;;;;;AAWG;AACG,SAAU,UAAU,CAAyB,GAAY,EAAA;AAC7D,IAAA,QAAQ,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAyB;AAC7E;;;;"}
+{"version":3,"file":"string.js","sources":["../../../src/utils/string.ts"],"sourcesContent":["/**\n * Util used to return true if the string is empty, undefined or null.\n *\n * @param str - String value.\n * @returns Returns true if str is an empty string, undefined or null.\n * @public\n */\nexport function isStringEmpty(str?: string | null): boolean {\n  return !str || str.length === 0\n}\n\n/**\n * Util to transform string a into kebab case.\n *\n * @example\n * Transforms `camelCase` into `camel-case`\n * Transforms `PascalCase` into `pascal-case`\n * Transforms `snake_case` into `snake-case`\n * Transforms `space space  multispaces` into `space-space-multiplespaces`\n * Transforms `kebab-case` into `kebab-case`\n *\n * @param str - String value.\n * @returns Returns the string in kebab case.\n * @public\n */\nexport function toKebabCase(str: string): string {\n  return str\n    .replace(/([a-z])([A-Z])/g, '$1-$2')\n    .replace(/\\s+|_/g, '-')\n    .toLowerCase()\n}\n\n/**\n * Util to capitalize a string .\n *\n * @example\n * Transforms `query` into `Query`\n *\n * @param str - String value.\n *\n * @returns Returns the string capitalized.\n *\n * @public\n */\nexport function capitalize<StrType extends string>(str: StrType): Capitalize<StrType> {\n  return (str.charAt(0).toUpperCase() + str.slice(1)) as Capitalize<StrType>\n}\n"],"names":[],"mappings":"AAAA;;;;;;AAMG;AACG,SAAU,aAAa,CAAC,GAAmB,EAAA;IAC/C,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,CAAA;AACjC,CAAC;AAED;;;;;;;;;;;;;AAaG;AACG,SAAU,WAAW,CAAC,GAAW,EAAA;AACrC,IAAA,OAAO,GAAG;AACP,SAAA,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC;AACnC,SAAA,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC;AACtB,SAAA,WAAW,EAAE,CAAA;AAClB,CAAC;AAED;;;;;;;;;;;AAWG;AACG,SAAU,UAAU,CAAyB,GAAY,EAAA;AAC7D,IAAA,QAAQ,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAwB;AAC5E;;;;"}

package/js/utils/throttle.js.map

@@ -1 +1 @@
-{"version":3,"file":"throttle.js","sources":["../../../src/utils/throttle.ts"],"sourcesContent":["import { ThrottleFunction } from './types';\n\n/**\n * Util function that returns a throttled version of the function passed as parameter.\n *\n * @param fn - Function to be debounced.\n * @param throttleTimeMs - The time of throttle in ms.\n * @returns A new function with the throttle.\n *\n * @public\n */\n\nexport const throttle = <Params extends any[]>(\n  fn: (...args: Params) => void,\n  throttleTimeMs: number\n): ThrottleFunction<Params> => {\n  let timeout: ReturnType<typeof setTimeout> | undefined;\n  let params: Params;\n\n  const throttleFn: ThrottleFunction<Params> = (...args) => {\n    params = args;\n    if (!timeout) {\n      timeout = setTimeout(() => {\n        fn(...params);\n        timeout = undefined;\n      }, throttleTimeMs);\n    }\n  };\n\n  return throttleFn;\n};\n"],"names":[],"mappings":"AAEA;;;;;;;;AAQG;MAEU,QAAQ,GAAG,CACtB,EAA6B,EAC7B,cAAsB,KACM;AAC5B,IAAA,IAAI,OAAkD,CAAC;AACvD,IAAA,IAAI,MAAc,CAAC;AAEnB,IAAA,MAAM,UAAU,GAA6B,CAAC,GAAG,IAAI,KAAI;QACvD,MAAM,GAAG,IAAI,CAAC;QACd,IAAI,CAAC,OAAO,EAAE;AACZ,YAAA,OAAO,GAAG,UAAU,CAAC,MAAK;AACxB,gBAAA,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC;gBACd,OAAO,GAAG,SAAS,CAAC;aACrB,EAAE,cAAc,CAAC,CAAC;AACpB,SAAA;AACH,KAAC,CAAC;AAEF,IAAA,OAAO,UAAU,CAAC;AACpB;;;;"}
+{"version":3,"file":"throttle.js","sources":["../../../src/utils/throttle.ts"],"sourcesContent":["import type { ThrottleFunction } from './types'\n\n/**\n * Util function that returns a throttled version of the function passed as parameter.\n *\n * @param fn - Function to be debounced.\n * @param throttleTimeMs - The time of throttle in ms.\n * @returns A new function with the throttle.\n *\n * @public\n */\n\nexport const throttle = <Params extends any[]>(\n  fn: (...args: Params) => void,\n  throttleTimeMs: number,\n): ThrottleFunction<Params> => {\n  let timeout: ReturnType<typeof setTimeout> | undefined\n  let params: Params\n\n  const throttleFn: ThrottleFunction<Params> = (...args) => {\n    params = args\n    if (!timeout) {\n      timeout = setTimeout(() => {\n        fn(...params)\n        timeout = undefined\n      }, throttleTimeMs)\n    }\n  }\n\n  return throttleFn\n}\n"],"names":[],"mappings":"AAEA;;;;;;;;AAQG;MAEU,QAAQ,GAAG,CACtB,EAA6B,EAC7B,cAAsB,KACM;AAC5B,IAAA,IAAI,OAAkD,CAAA;AACtD,IAAA,IAAI,MAAc,CAAA;AAElB,IAAA,MAAM,UAAU,GAA6B,CAAC,GAAG,IAAI,KAAI;QACvD,MAAM,GAAG,IAAI,CAAA;QACb,IAAI,CAAC,OAAO,EAAE;AACZ,YAAA,OAAO,GAAG,UAAU,CAAC,MAAK;AACxB,gBAAA,EAAE,CAAC,GAAG,MAAM,CAAC,CAAA;gBACb,OAAO,GAAG,SAAS,CAAA;aACpB,EAAE,cAAc,CAAC,CAAA;AACnB,SAAA;AACH,KAAC,CAAA;AAED,IAAA,OAAO,UAAU,CAAA;AACnB;;;;"}

package/js/wiring/namespaced-wires.factory.js

@@ -58,10 +58,12 @@ function namespacedWireDispatchWithoutPayload(moduleName) {
  */
 function getPayload(moduleName, payload) {
     return typeof payload === 'function'
-        ? ({ state, getters, eventPayload, metadata }) => payload({
+        ? ({ state, getters, eventPayload, metadata }) => 
+        // eslint-disable-next-line ts/no-unsafe-call,ts/no-unsafe-return
+        payload({
             ...getStateAndGettersFromModule(state, getters, moduleName),
             eventPayload,
-            metadata
+            metadata,
         })
         : payload;
 }

package/js/wiring/namespaced-wires.factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"namespaced-wires.factory.js","sources":["../../../src/wiring/namespaced-wires.factory.ts"],"sourcesContent":["import { XModuleName } from '../x-modules/x-modules.types';\nimport {\n  NamespacedWireCommit,\n  NamespacedWireCommitWithoutPayload,\n  NamespacedWireDispatch,\n  NamespacedWireDispatchWithoutPayload\n} from './namespaced-wiring.types';\nimport {\n  wireCommit,\n  wireCommitWithoutPayload,\n  wireDispatch,\n  wireDispatchWithoutPayload\n} from './wires.factory';\nimport { PayloadFactoryData } from './wiring.types';\nimport { getStateAndGettersFromModule } from './wiring.utils';\n\n/**\n * Creates a namespaced {@link (wireCommit:1)} for the module name passed.\n *\n * @param moduleName - The module name for scoping the {@link (wireCommit:1)}.\n * @returns A function which creates a namespaced wire for the {@link (wireCommit:1)}.\n *\n * @public\n */\nexport function namespacedWireCommit<ModuleName extends XModuleName>(\n  moduleName: ModuleName\n): NamespacedWireCommit<ModuleName> {\n  return (mutation: string, payload?: unknown) =>\n    wireCommit(`x/${moduleName}/${mutation}`, getPayload(moduleName, payload));\n}\n\n/**\n * Creates a namespaced {@link wireCommitWithoutPayload} for the module name passed.\n *\n * @param moduleName - The module name for scoping the {@link wireCommitWithoutPayload}.\n * @returns A function which creates a namespaced wire for the {@link wireCommitWithoutPayload}.\n *\n * @public\n */\nexport function namespacedWireCommitWithoutPayload<ModuleName extends XModuleName>(\n  moduleName: ModuleName\n): NamespacedWireCommitWithoutPayload<ModuleName> {\n  return mutation => wireCommitWithoutPayload(`x/${moduleName}/${mutation as string}`);\n}\n\n/**\n * Creates a namespaced {@link (wireDispatch:1)} for the module name passed.\n *\n * @param moduleName - The module name for scoping the {@link (wireDispatch:1)}.\n * @returns A function which creates a namespaced wire for the {@link (wireDispatch:1)}.\n *\n * @public\n */\nexport function namespacedWireDispatch<ModuleName extends XModuleName>(\n  moduleName: ModuleName\n): NamespacedWireDispatch<ModuleName> {\n  return (action: string, payload?: unknown) =>\n    wireDispatch(`x/${moduleName}/${action}`, getPayload(moduleName, payload));\n}\n\n/**\n * Creates a namespaced {@link wireDispatchWithoutPayload} for the module name passed.\n *\n * @param moduleName - The module name for scoping the {@link wireDispatchWithoutPayload}.\n * @returns A function which creates a namespaced wire for the {@link wireDispatchWithoutPayload}.\n *\n * @public\n */\nexport function namespacedWireDispatchWithoutPayload<ModuleName extends XModuleName>(\n  moduleName: ModuleName\n): NamespacedWireDispatchWithoutPayload<ModuleName> {\n  return action => wireDispatchWithoutPayload(`x/${moduleName}/${action as string}`);\n}\n\n/**\n * Decision maker of if the payload is a function which receives the\n * {@link StoreModuleStateAndGetters | module state and getters}, the payload and the metadata,\n * returns the payload for or a static value.\n *\n * @param moduleName - The {@link XModuleName | module name} for scoping the state and getters.\n * @param payload - The payload for the wire which can be a retrieving function or a static value.\n * @returns The function which will retrieve data from the store or the static value.\n *\n * @internal\n */\nfunction getPayload(moduleName: XModuleName, payload: unknown): unknown {\n  return typeof payload === 'function'\n    ? ({ state, getters, eventPayload, metadata }: PayloadFactoryData<XModuleName>) =>\n        payload({\n          ...getStateAndGettersFromModule(state, getters, moduleName),\n          eventPayload,\n          metadata\n        })\n    : payload;\n}\n"],"names":[],"mappings":";;;AAgBA;;;;;;;AAOG;AACG,SAAU,oBAAoB,CAClC,UAAsB,EAAA;IAEtB,OAAO,CAAC,QAAgB,EAAE,OAAiB,KACzC,UAAU,CAAC,CAAK,EAAA,EAAA,UAAU,IAAI,QAAQ,CAAA,CAAE,EAAE,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/E,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,kCAAkC,CAChD,UAAsB,EAAA;AAEtB,IAAA,OAAO,QAAQ,IAAI,wBAAwB,CAAC,CAAK,EAAA,EAAA,UAAU,CAAI,CAAA,EAAA,QAAkB,CAAE,CAAA,CAAC,CAAC;AACvF,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,sBAAsB,CACpC,UAAsB,EAAA;IAEtB,OAAO,CAAC,MAAc,EAAE,OAAiB,KACvC,YAAY,CAAC,CAAK,EAAA,EAAA,UAAU,IAAI,MAAM,CAAA,CAAE,EAAE,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;AAC/E,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,oCAAoC,CAClD,UAAsB,EAAA;AAEtB,IAAA,OAAO,MAAM,IAAI,0BAA0B,CAAC,CAAK,EAAA,EAAA,UAAU,CAAI,CAAA,EAAA,MAAgB,CAAE,CAAA,CAAC,CAAC;AACrF,CAAC;AAED;;;;;;;;;;AAUG;AACH,SAAS,UAAU,CAAC,UAAuB,EAAE,OAAgB,EAAA;IAC3D,OAAO,OAAO,OAAO,KAAK,UAAU;AAClC,UAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAmC,KAC1E,OAAO,CAAC;AACN,YAAA,GAAG,4BAA4B,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC;YAC3D,YAAY;YACZ,QAAQ;SACT,CAAC;UACJ,OAAO,CAAC;AACd;;;;"}
+{"version":3,"file":"namespaced-wires.factory.js","sources":["../../../src/wiring/namespaced-wires.factory.ts"],"sourcesContent":["import type { XModuleName } from '../x-modules/x-modules.types'\nimport type {\n  NamespacedWireCommit,\n  NamespacedWireCommitWithoutPayload,\n  NamespacedWireDispatch,\n  NamespacedWireDispatchWithoutPayload,\n} from './namespaced-wiring.types'\nimport type { PayloadFactoryData } from './wiring.types'\nimport {\n  wireCommit,\n  wireCommitWithoutPayload,\n  wireDispatch,\n  wireDispatchWithoutPayload,\n} from './wires.factory'\nimport { getStateAndGettersFromModule } from './wiring.utils'\n\n/**\n * Creates a namespaced {@link (wireCommit:1)} for the module name passed.\n *\n * @param moduleName - The module name for scoping the {@link (wireCommit:1)}.\n * @returns A function which creates a namespaced wire for the {@link (wireCommit:1)}.\n *\n * @public\n */\nexport function namespacedWireCommit<ModuleName extends XModuleName>(\n  moduleName: ModuleName,\n): NamespacedWireCommit<ModuleName> {\n  return (mutation: string, payload?: unknown) =>\n    wireCommit(`x/${moduleName}/${mutation}`, getPayload(moduleName, payload))\n}\n\n/**\n * Creates a namespaced {@link wireCommitWithoutPayload} for the module name passed.\n *\n * @param moduleName - The module name for scoping the {@link wireCommitWithoutPayload}.\n * @returns A function which creates a namespaced wire for the {@link wireCommitWithoutPayload}.\n *\n * @public\n */\nexport function namespacedWireCommitWithoutPayload<ModuleName extends XModuleName>(\n  moduleName: ModuleName,\n): NamespacedWireCommitWithoutPayload<ModuleName> {\n  return mutation => wireCommitWithoutPayload(`x/${moduleName}/${mutation as string}`)\n}\n\n/**\n * Creates a namespaced {@link (wireDispatch:1)} for the module name passed.\n *\n * @param moduleName - The module name for scoping the {@link (wireDispatch:1)}.\n * @returns A function which creates a namespaced wire for the {@link (wireDispatch:1)}.\n *\n * @public\n */\nexport function namespacedWireDispatch<ModuleName extends XModuleName>(\n  moduleName: ModuleName,\n): NamespacedWireDispatch<ModuleName> {\n  return (action: string, payload?: unknown) =>\n    wireDispatch(`x/${moduleName}/${action}`, getPayload(moduleName, payload))\n}\n\n/**\n * Creates a namespaced {@link wireDispatchWithoutPayload} for the module name passed.\n *\n * @param moduleName - The module name for scoping the {@link wireDispatchWithoutPayload}.\n * @returns A function which creates a namespaced wire for the {@link wireDispatchWithoutPayload}.\n *\n * @public\n */\nexport function namespacedWireDispatchWithoutPayload<ModuleName extends XModuleName>(\n  moduleName: ModuleName,\n): NamespacedWireDispatchWithoutPayload<ModuleName> {\n  return action => wireDispatchWithoutPayload(`x/${moduleName}/${action as string}`)\n}\n\n/**\n * Decision maker of if the payload is a function which receives the\n * {@link StoreModuleStateAndGetters | module state and getters}, the payload and the metadata,\n * returns the payload for or a static value.\n *\n * @param moduleName - The {@link XModuleName | module name} for scoping the state and getters.\n * @param payload - The payload for the wire which can be a retrieving function or a static value.\n * @returns The function which will retrieve data from the store or the static value.\n *\n * @internal\n */\nfunction getPayload(moduleName: XModuleName, payload: unknown): unknown {\n  return typeof payload === 'function'\n    ? ({ state, getters, eventPayload, metadata }: PayloadFactoryData<XModuleName>) =>\n        // eslint-disable-next-line ts/no-unsafe-call,ts/no-unsafe-return\n        payload({\n          ...getStateAndGettersFromModule(state, getters, moduleName),\n          eventPayload,\n          metadata,\n        })\n    : payload\n}\n"],"names":[],"mappings":";;;AAgBA;;;;;;;AAOG;AACG,SAAU,oBAAoB,CAClC,UAAsB,EAAA;IAEtB,OAAO,CAAC,QAAgB,EAAE,OAAiB,KACzC,UAAU,CAAC,CAAK,EAAA,EAAA,UAAU,IAAI,QAAQ,CAAA,CAAE,EAAE,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAA;AAC9E,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,kCAAkC,CAChD,UAAsB,EAAA;AAEtB,IAAA,OAAO,QAAQ,IAAI,wBAAwB,CAAC,CAAK,EAAA,EAAA,UAAU,CAAI,CAAA,EAAA,QAAkB,CAAE,CAAA,CAAC,CAAA;AACtF,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,sBAAsB,CACpC,UAAsB,EAAA;IAEtB,OAAO,CAAC,MAAc,EAAE,OAAiB,KACvC,YAAY,CAAC,CAAK,EAAA,EAAA,UAAU,IAAI,MAAM,CAAA,CAAE,EAAE,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAA;AAC9E,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,oCAAoC,CAClD,UAAsB,EAAA;AAEtB,IAAA,OAAO,MAAM,IAAI,0BAA0B,CAAC,CAAK,EAAA,EAAA,UAAU,CAAI,CAAA,EAAA,MAAgB,CAAE,CAAA,CAAC,CAAA;AACpF,CAAC;AAED;;;;;;;;;;AAUG;AACH,SAAS,UAAU,CAAC,UAAuB,EAAE,OAAgB,EAAA;IAC3D,OAAO,OAAO,OAAO,KAAK,UAAU;AAClC,UAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAmC;;AAE1E,QAAA,OAAO,CAAC;AACN,YAAA,GAAG,4BAA4B,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC;YAC3D,YAAY;YACZ,QAAQ;SACT,CAAC;UACJ,OAAO,CAAA;AACb;;;;"}

package/js/wiring/namespaced-wires.operators.js.map

@@ -1 +1 @@
-{"version":3,"file":"namespaced-wires.operators.js","sources":["../../../src/wiring/namespaced-wires.operators.ts"],"sourcesContent":["import { Dictionary } from '@empathyco/x-utils';\nimport { XModuleName } from '../x-modules/x-modules.types';\nimport { NamespacedTimeWireOperator } from './namespaced-wiring.types';\nimport { debounce, throttle } from './wires.operators';\nimport { getStateAndGettersFromModule } from './wiring.utils';\n\n/**\n * Type safe debounce operator which creates a function which can only access the Module of\n * the {@link https://vuex.vuejs.org/ | Vuex} Store passed as parameter.\n *\n * @param moduleName - The {@link XModuleName} to create the operator wire.\n * @returns A function which creates a wire that uses the {@link debounce} wire operator to\n * execute the `wire` after the time has passed without invoking it. This debounce time\n * is given by the execution of the `timeRetrieving` function.\n *\n * @public\n */\nexport function namespacedDebounce<ModuleName extends XModuleName>(\n  moduleName: ModuleName\n): NamespacedTimeWireOperator<ModuleName> {\n  return createNamespacedTimeWireOperator(moduleName, debounce);\n}\n\n/**\n * Type safe throttle operator which creates a function which can only access the Module of\n * the {@link https://vuex.vuejs.org/ | Vuex} Store passed as parameter.\n *\n * @param moduleName - The {@link XModuleName} to create the operator wire.\n * @returns A function which creates a wire that uses the {@link throttle} wire operator to\n * execute the `wire` once every couple of milliseconds. This throttle time is given by\n * the execution of the `timeRetrieving` function.\n *\n * @public\n */\nexport function namespacedThrottle<ModuleName extends XModuleName>(\n  moduleName: ModuleName\n): NamespacedTimeWireOperator<ModuleName> {\n  return createNamespacedTimeWireOperator(moduleName, throttle);\n}\n\n/**\n * Creates a function which creates a namespaced wire that uses the {@link debounce} or\n * {@link throttle} time wire operator.\n *\n * @param moduleName - The {@link XModuleName} to create the operator wire.\n * @param timingOperator - The time wire operator {@link debounce} or {@link throttle}.\n * @returns A function which creates a namespaced time wire operator.\n *\n * @internal\n */\nfunction createNamespacedTimeWireOperator<ModuleName extends XModuleName>(\n  moduleName: ModuleName,\n  timingOperator: typeof throttle | typeof debounce\n): NamespacedTimeWireOperator<ModuleName> {\n  return (wire, timeSelector, options) =>\n    timingOperator(\n      wire,\n      ({ state, getters }) =>\n        timeSelector(getStateAndGettersFromModule(state, getters as Dictionary, moduleName)),\n      options\n    );\n}\n"],"names":[],"mappings":";;;AAMA;;;;;;;;;;AAUG;AACG,SAAU,kBAAkB,CAChC,UAAsB,EAAA;AAEtB,IAAA,OAAO,gCAAgC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAChE,CAAC;AAED;;;;;;;;;;AAUG;AACG,SAAU,kBAAkB,CAChC,UAAsB,EAAA;AAEtB,IAAA,OAAO,gCAAgC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;AAChE,CAAC;AAED;;;;;;;;;AASG;AACH,SAAS,gCAAgC,CACvC,UAAsB,EACtB,cAAiD,EAAA;AAEjD,IAAA,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,KACjC,cAAc,CACZ,IAAI,EACJ,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,KACjB,YAAY,CAAC,4BAA4B,CAAC,KAAK,EAAE,OAAqB,EAAE,UAAU,CAAC,CAAC,EACtF,OAAO,CACR,CAAC;AACN;;;;"}
+{"version":3,"file":"namespaced-wires.operators.js","sources":["../../../src/wiring/namespaced-wires.operators.ts"],"sourcesContent":["import type { Dictionary } from '@empathyco/x-utils'\nimport type { XModuleName } from '../x-modules/x-modules.types'\nimport type { NamespacedTimeWireOperator } from './namespaced-wiring.types'\nimport { debounce, throttle } from './wires.operators'\nimport { getStateAndGettersFromModule } from './wiring.utils'\n\n/**\n * Type safe debounce operator which creates a function which can only access the Module of\n * the {@link https://vuex.vuejs.org/ | Vuex} Store passed as parameter.\n *\n * @param moduleName - The {@link XModuleName} to create the operator wire.\n * @returns A function which creates a wire that uses the {@link debounce} wire operator to\n * execute the `wire` after the time has passed without invoking it. This debounce time\n * is given by the execution of the `timeRetrieving` function.\n *\n * @public\n */\nexport function namespacedDebounce<ModuleName extends XModuleName>(\n  moduleName: ModuleName,\n): NamespacedTimeWireOperator<ModuleName> {\n  return createNamespacedTimeWireOperator(moduleName, debounce)\n}\n\n/**\n * Type safe throttle operator which creates a function which can only access the Module of\n * the {@link https://vuex.vuejs.org/ | Vuex} Store passed as parameter.\n *\n * @param moduleName - The {@link XModuleName} to create the operator wire.\n * @returns A function which creates a wire that uses the {@link throttle} wire operator to\n * execute the `wire` once every couple of milliseconds. This throttle time is given by\n * the execution of the `timeRetrieving` function.\n *\n * @public\n */\nexport function namespacedThrottle<ModuleName extends XModuleName>(\n  moduleName: ModuleName,\n): NamespacedTimeWireOperator<ModuleName> {\n  return createNamespacedTimeWireOperator(moduleName, throttle)\n}\n\n/**\n * Creates a function which creates a namespaced wire that uses the {@link debounce} or\n * {@link throttle} time wire operator.\n *\n * @param moduleName - The {@link XModuleName} to create the operator wire.\n * @param timingOperator - The time wire operator {@link debounce} or {@link throttle}.\n * @returns A function which creates a namespaced time wire operator.\n *\n * @internal\n */\nfunction createNamespacedTimeWireOperator<ModuleName extends XModuleName>(\n  moduleName: ModuleName,\n  timingOperator: typeof throttle | typeof debounce,\n): NamespacedTimeWireOperator<ModuleName> {\n  return (wire, timeSelector, options) =>\n    timingOperator(\n      wire,\n      ({ state, getters }) =>\n        timeSelector(getStateAndGettersFromModule(state, getters as Dictionary, moduleName)),\n      options,\n    )\n}\n"],"names":[],"mappings":";;;AAMA;;;;;;;;;;AAUG;AACG,SAAU,kBAAkB,CAChC,UAAsB,EAAA;AAEtB,IAAA,OAAO,gCAAgC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;AAC/D,CAAC;AAED;;;;;;;;;;AAUG;AACG,SAAU,kBAAkB,CAChC,UAAsB,EAAA;AAEtB,IAAA,OAAO,gCAAgC,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;AAC/D,CAAC;AAED;;;;;;;;;AASG;AACH,SAAS,gCAAgC,CACvC,UAAsB,EACtB,cAAiD,EAAA;AAEjD,IAAA,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,KACjC,cAAc,CACZ,IAAI,EACJ,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,KACjB,YAAY,CAAC,4BAA4B,CAAC,KAAK,EAAE,OAAqB,EAAE,UAAU,CAAC,CAAC,EACtF,OAAO,CACR,CAAA;AACL;;;;"}

package/js/wiring/wires-operators.utils.js

@@ -5,7 +5,7 @@ import { takeUntil } from 'rxjs/operators';
  * Creates the observable for the events that will be racing the wire's execution.
  *
  * @param events - The events to merge its observables.
- * @param on - The on function of the {@link @empathyco/x-bus#XBus} where the events will run.
+ * @param on - The on function of the XBus where the events will run.
  * @returns The observable for the racing events.
  * @internal
  */
@@ -35,6 +35,8 @@ function normalizeTime(timeInMs, store) {
  *
  * @param durationInMs - The duration in ms for the timer.
  * @param options - Options to configure the timer, like an events to force it or cancel it.
+ * @param options.cancelOn - cancelOn option.
+ * @param options.forceOn - forceOn option.
  * @param on - The {@link XBus.on} method.
  * @returns A timer observable that can be aborted or forced depending on the provided options.
  * @internal

package/js/wiring/wires-operators.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"wires-operators.utils.js","sources":["../../../src/wiring/wires-operators.utils.ts"],"sourcesContent":["import { Subject, Observable, timer, race } from 'rxjs';\nimport { takeUntil } from 'rxjs/operators';\nimport { Store } from 'vuex';\nimport { XBus } from '@empathyco/x-bus';\nimport { RootXStoreState } from '../store/store.types';\nimport { MaybeArray } from '../utils/types';\nimport { XEvent, XEventsTypes } from './events.types';\nimport { TimedWireOperatorOptions, TimeSelector, WireMetadata } from './wiring.types';\n\n/**\n * Creates the observable for the events that will be racing the wire's execution.\n *\n * @param events - The events to merge its observables.\n * @param on - The on function of the {@link @empathyco/x-bus#XBus} where the events will run.\n * @returns The observable for the racing events.\n * @internal\n */\nexport function mergeEvents(\n  events: MaybeArray<XEvent>,\n  on: XBus<XEventsTypes, WireMetadata>['on']\n): Observable<void> {\n  const subject = new Subject<void>();\n  const eventsList = Array.isArray(events) ? events : [events];\n\n  /* Can't use RxJS `merge` function, as it immediately emits previously emitted values to new\n   subscriptions due to the `ReplaySubject` of the bus. With this Subject we are still receiving\n   those values immediately on subscription, but as there are no subscribers before the `return`\n   happens we are fine. */\n  eventsList.forEach(raceEvent => on(raceEvent).subscribe(() => subject.next()));\n  return subject;\n}\n\n/**\n * Checks how to retrieve the timeout time, retrieves it and returns it in ms.\n *\n * @param timeInMs - Time for the timeout in ms.\n * @param store - The store of the wire that will be timed out.\n * @returns The time in ms for the timeout.\n * @internal\n */\nexport function normalizeTime(\n  timeInMs: TimeSelector | number,\n  store: Store<RootXStoreState>\n): number {\n  return typeof timeInMs === 'function' ? timeInMs(store) : timeInMs;\n}\n\n/**\n * Creates a timer observable that depending on the provided options might be aborted or forced.\n *\n * @param durationInMs - The duration in ms for the timer.\n * @param options - Options to configure the timer, like an events to force it or cancel it.\n * @param on - The {@link XBus.on} method.\n * @returns A timer observable that can be aborted or forced depending on the provided options.\n * @internal\n */\nexport function createTimer(\n  durationInMs: number,\n  { cancelOn, forceOn }: TimedWireOperatorOptions,\n  on: XBus<XEventsTypes, WireMetadata>['on']\n): Observable<unknown> {\n  let timerObservable: Observable<unknown> = timer(durationInMs);\n  if (forceOn) {\n    timerObservable = race(timerObservable, mergeEvents(forceOn, on));\n  }\n\n  if (cancelOn) {\n    timerObservable = timerObservable.pipe(takeUntil(mergeEvents(cancelOn, on)));\n  }\n\n  return timerObservable;\n}\n"],"names":[],"mappings":";;;AASA;;;;;;;AAOG;AACa,SAAA,WAAW,CACzB,MAA0B,EAC1B,EAA0C,EAAA;AAE1C,IAAA,MAAM,OAAO,GAAG,IAAI,OAAO,EAAQ,CAAC;AACpC,IAAA,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,CAAC;AAE7D;;;AAGwB;IACxB,UAAU,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AAC/E,IAAA,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;AAOG;AACa,SAAA,aAAa,CAC3B,QAA+B,EAC/B,KAA6B,EAAA;AAE7B,IAAA,OAAO,OAAO,QAAQ,KAAK,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC;AACrE,CAAC;AAED;;;;;;;;AAQG;AACG,SAAU,WAAW,CACzB,YAAoB,EACpB,EAAE,QAAQ,EAAE,OAAO,EAA4B,EAC/C,EAA0C,EAAA;AAE1C,IAAA,IAAI,eAAe,GAAwB,KAAK,CAAC,YAAY,CAAC,CAAC;AAC/D,IAAA,IAAI,OAAO,EAAE;AACX,QAAA,eAAe,GAAG,IAAI,CAAC,eAAe,EAAE,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AACnE,KAAA;AAED,IAAA,IAAI,QAAQ,EAAE;AACZ,QAAA,eAAe,GAAG,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;AAC9E,KAAA;AAED,IAAA,OAAO,eAAe,CAAC;AACzB;;;;"}
+{"version":3,"file":"wires-operators.utils.js","sources":["../../../src/wiring/wires-operators.utils.ts"],"sourcesContent":["import type { XBus } from '@empathyco/x-bus'\nimport type { Observable } from 'rxjs'\nimport type { Store } from 'vuex'\nimport type { RootXStoreState } from '../store/store.types'\nimport type { MaybeArray } from '../utils/types'\nimport type { XEvent, XEventsTypes } from './events.types'\nimport type { TimedWireOperatorOptions, TimeSelector, WireMetadata } from './wiring.types'\nimport { race, Subject, timer } from 'rxjs'\nimport { takeUntil } from 'rxjs/operators'\n\n/**\n * Creates the observable for the events that will be racing the wire's execution.\n *\n * @param events - The events to merge its observables.\n * @param on - The on function of the XBus where the events will run.\n * @returns The observable for the racing events.\n * @internal\n */\nexport function mergeEvents(\n  events: MaybeArray<XEvent>,\n  on: XBus<XEventsTypes, WireMetadata>['on'],\n): Observable<void> {\n  const subject = new Subject<void>()\n  const eventsList = Array.isArray(events) ? events : [events]\n\n  /* Can't use RxJS `merge` function, as it immediately emits previously emitted values to new\n   subscriptions due to the `ReplaySubject` of the bus. With this Subject we are still receiving\n   those values immediately on subscription, but as there are no subscribers before the `return`\n   happens we are fine. */\n  eventsList.forEach(raceEvent => on(raceEvent).subscribe(() => subject.next()))\n  return subject\n}\n\n/**\n * Checks how to retrieve the timeout time, retrieves it and returns it in ms.\n *\n * @param timeInMs - Time for the timeout in ms.\n * @param store - The store of the wire that will be timed out.\n * @returns The time in ms for the timeout.\n * @internal\n */\nexport function normalizeTime(\n  timeInMs: TimeSelector | number,\n  store: Store<RootXStoreState>,\n): number {\n  return typeof timeInMs === 'function' ? timeInMs(store) : timeInMs\n}\n\n/**\n * Creates a timer observable that depending on the provided options might be aborted or forced.\n *\n * @param durationInMs - The duration in ms for the timer.\n * @param options - Options to configure the timer, like an events to force it or cancel it.\n * @param options.cancelOn - cancelOn option.\n * @param options.forceOn - forceOn option.\n * @param on - The {@link XBus.on} method.\n * @returns A timer observable that can be aborted or forced depending on the provided options.\n * @internal\n */\nexport function createTimer(\n  durationInMs: number,\n  { cancelOn, forceOn }: TimedWireOperatorOptions,\n  on: XBus<XEventsTypes, WireMetadata>['on'],\n): Observable<unknown> {\n  let timerObservable: Observable<unknown> = timer(durationInMs)\n  if (forceOn) {\n    timerObservable = race(timerObservable, mergeEvents(forceOn, on))\n  }\n\n  if (cancelOn) {\n    timerObservable = timerObservable.pipe(takeUntil(mergeEvents(cancelOn, on)))\n  }\n\n  return timerObservable\n}\n"],"names":[],"mappings":";;;AAUA;;;;;;;AAOG;AACa,SAAA,WAAW,CACzB,MAA0B,EAC1B,EAA0C,EAAA;AAE1C,IAAA,MAAM,OAAO,GAAG,IAAI,OAAO,EAAQ,CAAA;AACnC,IAAA,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,CAAC,MAAM,CAAC,CAAA;AAE5D;;;AAGwB;IACxB,UAAU,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;AAC9E,IAAA,OAAO,OAAO,CAAA;AAChB,CAAC;AAED;;;;;;;AAOG;AACa,SAAA,aAAa,CAC3B,QAA+B,EAC/B,KAA6B,EAAA;AAE7B,IAAA,OAAO,OAAO,QAAQ,KAAK,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAA;AACpE,CAAC;AAED;;;;;;;;;;AAUG;AACG,SAAU,WAAW,CACzB,YAAoB,EACpB,EAAE,QAAQ,EAAE,OAAO,EAA4B,EAC/C,EAA0C,EAAA;AAE1C,IAAA,IAAI,eAAe,GAAwB,KAAK,CAAC,YAAY,CAAC,CAAA;AAC9D,IAAA,IAAI,OAAO,EAAE;AACX,QAAA,eAAe,GAAG,IAAI,CAAC,eAAe,EAAE,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAA;AAClE,KAAA;AAED,IAAA,IAAI,QAAQ,EAAE;AACZ,QAAA,eAAe,GAAG,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;AAC7E,KAAA;AAED,IAAA,OAAO,eAAe,CAAA;AACxB;;;;"}

package/js/wiring/wires.factory.js

@@ -11,7 +11,6 @@ function createWireFromFunction(fn) {
         fn({ eventPayload, store, metadata });
     });
 }
-// eslint-disable-next-line jsdoc/require-jsdoc
 function wireCommit(mutation, payload) {
     return (observable, store) => observable.subscribe(createSubscriptionCallback(store, 'commit', mutation, payload));
 }
@@ -26,7 +25,6 @@ function wireCommit(mutation, payload) {
 function wireCommitWithoutPayload(mutation) {
     return (observable, store) => observable.subscribe(() => store.commit(mutation));
 }
-// eslint-disable-next-line jsdoc/require-jsdoc
 function wireDispatch(action, payload) {
     return (observable, store) => observable.subscribe(createSubscriptionCallback(store, 'dispatch', action, payload));
 }
@@ -39,7 +37,8 @@ function wireDispatch(action, payload) {
  * @public
  */
 function wireDispatchWithoutPayload(action) {
-    return (observable, store) => observable.subscribe(() => store.dispatch(action));
+    // eslint-disable-next-line ts/no-unsafe-return,ts/no-misused-promises
+    return (observable, store) => observable.subscribe(async () => store.dispatch(action));
 }
 /**
  * Creates a wires factory that can create wires that will invoke the service methods.
@@ -51,8 +50,11 @@ function wireDispatchWithoutPayload(action) {
 function wireService(service) {
     return (method, payload) => {
         return observable => observable.subscribe(payload !== undefined
-            ? () => service[method](payload)
-            : observablePayload => service[method](observablePayload.eventPayload));
+            ? // eslint-disable-next-line ts/no-unsafe-return
+                () => service[method](payload)
+            : // eslint-disable-next-line ts/no-unsafe-return
+                // eslint-disable-next-line ts/no-unsafe-return
+                observablePayload => service[method](observablePayload.eventPayload));
     };
 }
 /**
@@ -65,6 +67,7 @@ function wireService(service) {
  */
 function wireServiceWithoutPayload(service) {
     return method => {
+        // eslint-disable-next-line ts/no-unsafe-return
         return observable => observable.subscribe(() => service[method]());
     };
 }
@@ -85,19 +88,23 @@ function wireServiceWithoutPayload(service) {
 function createSubscriptionCallback(store, commitOrDispatch, mutationOrAction, payload) {
     const storeExecutor = store[commitOrDispatch];
     return typeof payload === 'function'
-        ? wirePayload => {
-            return storeExecutor(mutationOrAction, payload({
+        ? async (wirePayload) => {
+            // eslint-disable-next-line ts/no-unsafe-return
+            return storeExecutor(mutationOrAction, 
+            // eslint-disable-next-line ts/no-unsafe-call
+            payload({
                 state: store.state,
+                // eslint-disable-next-line ts/no-unsafe-assignment
                 getters: store.getters,
-                ...wirePayload
+                ...wirePayload,
             }));
         }
         : payload !== undefined
             ? () => {
-                storeExecutor(mutationOrAction, payload);
+                void storeExecutor(mutationOrAction, payload);
             }
             : observableValue => {
-                storeExecutor(mutationOrAction, observableValue.eventPayload);
+                void storeExecutor(mutationOrAction, observableValue.eventPayload);
             };
 }
 

package/js/wiring/wires.factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"wires.factory.js","sources":["../../../src/wiring/wires.factory.ts"],"sourcesContent":["import { Store } from 'vuex';\nimport { RootXStoreState } from '../store/store.types';\nimport { MonadicFunction, NiladicFunction, SubObject } from '../utils/index';\nimport {\n  AnyWire,\n  PayloadFactoryData,\n  Wire,\n  WireParams,\n  WirePayload,\n  WireService,\n  WireServiceWithoutPayload\n} from './wiring.types';\n\n/**\n * Creates a wire that executes the function passed. This function will receive a\n * {@link WireParams} object.\n *\n * @param fn - The function to execute whenever a new value is emitted to the observable.\n * @returns The Wire function.\n * @public\n */\nexport function createWireFromFunction<Payload>(\n  fn: (parameters: WireParams<Payload>) => void\n): Wire<Payload> {\n  return (observable, store) =>\n    observable.subscribe(({ metadata, eventPayload }) => {\n      fn({ eventPayload, store, metadata });\n    });\n}\n\n/**\n * Creates a wire that commits a mutation to the store. This wire receives a function. This function\n * is used to get the actual payload value passed to mutation.\n * This wire can be used in every event, as it does not have a payload type associated.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @param payloadFactory - A function that receives a {@link PayloadFactoryData | object}\n * with the Store state, getters, payload and metadata as parameter.\n * @returns A {@link AnyWire} wire that commits the mutation with the payload returned by the\n * payloadFactory.\n * @public\n */\nexport function wireCommit<Payload>(\n  mutation: string,\n  payloadFactory: (params: PayloadFactoryData<Payload>) => any\n): AnyWire;\n/**\n * Creates a wire that commits a mutation to the store. This wire can receive any value as payload.\n * This wire can be used in every event, as it does not have a payload type associated.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @param staticPayload - A static payload to pass to the mutation.\n * @returns {@link AnyWire} A wire that commits the mutation with the staticPayload payload.\n * @public\n */\nexport function wireCommit(mutation: string, staticPayload: any): AnyWire;\n/**\n * Creates a wire that commits a mutation to the store. This wire will commit to the store the\n * payload that it receives in the observable.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @typeParam Payload - The type of the payload that this wire will receive\n * @returns {@link Wire} A wire that commits the mutation with the payload that it receives\n * in the observable.\n * @public\n */\nexport function wireCommit<Payload>(mutation: string): Wire<Payload>;\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport function wireCommit<Payload>(mutation: string, payload?: Payload): Wire<Payload> {\n  return (observable, store) =>\n    observable.subscribe(createSubscriptionCallback(store, 'commit', mutation, payload));\n}\n\n/**\n * Creates a wire that commits a mutation to the store, but without any payload. This wire can\n * be used in every event, as it does not have a payload type associated.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @returns {@link AnyWire} A wire that commits the mutation without any payload.\n * @public\n */\nexport function wireCommitWithoutPayload(mutation: string): AnyWire {\n  return (observable, store) => observable.subscribe(() => store.commit(mutation));\n}\n\n/**\n * Creates a wire that dispatch an action to the store. This wire receives a function. This function\n * is used to get the actual payload value passed to action.\n * This wire can be used in every event, as it does not have a payload type associated.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @param payloadFactory - A function that receives a {@link PayloadFactoryData | object}\n * with the Store state, getters, payload and metadata as parameter.\n * @returns A {@link AnyWire} wire that dispatches the action with the payload returned by the\n * payloadFactory.\n * @public\n */\nexport function wireDispatch<Payload>(\n  action: string,\n  payloadFactory: (params: PayloadFactoryData<Payload>) => any\n): AnyWire;\n/**\n * Creates a wire that dispatches an action to the store. This wire can be used in every event,\n * as it does not have a payload type associated.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @param staticPayload - A static payload to pass to the action which will be dispatched.\n * @returns {@link AnyWire} A wire that dispatches the action with the staticPayload payload.\n * @public\n */\nexport function wireDispatch(action: string, staticPayload: any): AnyWire;\n/**\n * Creates a wire that dispatches an action to the store. This wire will pass the payload\n * received in the observable to the action.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @typeParam Payload - The type of the payload that this wire will receive\n * @returns {@link Wire} A wire that dispatches the action with the payload that it receives\n * in the observable.\n * @public\n */\nexport function wireDispatch<Payload>(action: string): Wire<Payload>;\n// eslint-disable-next-line jsdoc/require-jsdoc\nexport function wireDispatch<Payload>(action: string, payload?: Payload): Wire<Payload> {\n  return (observable, store) =>\n    observable.subscribe(createSubscriptionCallback(store, 'dispatch', action, payload));\n}\n\n/**\n * Creates a wire that dispatches an action to the store, but without any payload. This wire can\n * be used in every event, as it does not have a payload type associated.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @returns {@link AnyWire} A wire that dispatches the action without any payload.\n * @public\n */\nexport function wireDispatchWithoutPayload(action: string): AnyWire {\n  return (observable, store) => observable.subscribe(() => store.dispatch(action));\n}\n\n/**\n * Creates a wires factory that can create wires that will invoke the service methods.\n *\n * @param service - The service to invoke its methods.\n * @returns A factory to create wires that invoke the service methods.\n * @public\n */\nexport function wireService<SomeService>(\n  service: SomeService & SubObject<SomeService, MonadicFunction>\n): WireService<SubObject<SomeService, MonadicFunction>> {\n  return (method, payload?) => {\n    return observable =>\n      observable.subscribe(\n        payload !== undefined\n          ? () => service[method](payload)\n          : observablePayload => service[method](observablePayload.eventPayload)\n      );\n  };\n}\n\n/**\n * Creates a wires factory that can create wires that will invoke the service methods but\n * without payload.\n *\n * @param service - The service to invoke its methods.\n * @returns A factory to create wires that invoke the service methods without payload.\n * @public\n */\nexport function wireServiceWithoutPayload<SomeService>(\n  service: SomeService & SubObject<SomeService, NiladicFunction>\n): WireServiceWithoutPayload<SubObject<SomeService, NiladicFunction>> {\n  return method => {\n    return observable => observable.subscribe(() => service[method]());\n  };\n}\n\n/**\n * Creates the callback function for the {@link wireCommit} and {@link wireDispatch}\n * subscriptions. It can be based on the payload as function which retrieves the observable\n * payload from the store, a static payload or the event value from the observable.\n *\n * @param store - The {@link RootXStoreState} store.\n * @param commitOrDispatch - The executor over store. It can be `commit` or `dispatch`.\n * @param mutationOrAction - The mutation or action to commit or dispatch respectively.\n * @param payload - The payload for the store executor. It can be a function which retrieves the\n * payload from the store, a static payload or the event value from the observable.\n * @typeParam Payload - The type of the payload to get the observable event value type.\n * @returns A function to commit or dispatch a payload value over store.\n * @internal\n */\nfunction createSubscriptionCallback<Payload>(\n  store: Store<RootXStoreState>,\n  commitOrDispatch: 'commit' | 'dispatch',\n  mutationOrAction: string,\n  payload?: Payload\n): (observableValue: WirePayload<Payload>) => void {\n  const storeExecutor = store[commitOrDispatch];\n  return typeof payload === 'function'\n    ? wirePayload => {\n        return storeExecutor(\n          mutationOrAction,\n          payload({\n            state: store.state,\n            getters: store.getters,\n            ...wirePayload\n          })\n        );\n      }\n    : payload !== undefined\n    ? () => {\n        storeExecutor(mutationOrAction, payload);\n      }\n    : observableValue => {\n        storeExecutor(mutationOrAction, observableValue.eventPayload);\n      };\n}\n"],"names":[],"mappings":"AAaA;;;;;;;AAOG;AACG,SAAU,sBAAsB,CACpC,EAA6C,EAAA;AAE7C,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,KACvB,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAI;QAClD,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AACxC,KAAC,CAAC,CAAC;AACP,CAAC;AAuCD;AACgB,SAAA,UAAU,CAAU,QAAgB,EAAE,OAAiB,EAAA;IACrE,OAAO,CAAC,UAAU,EAAE,KAAK,KACvB,UAAU,CAAC,SAAS,CAAC,0BAA0B,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;AACzF,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,wBAAwB,CAAC,QAAgB,EAAA;IACvD,OAAO,CAAC,UAAU,EAAE,KAAK,KAAK,UAAU,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;AACnF,CAAC;AAuCD;AACgB,SAAA,YAAY,CAAU,MAAc,EAAE,OAAiB,EAAA;IACrE,OAAO,CAAC,UAAU,EAAE,KAAK,KACvB,UAAU,CAAC,SAAS,CAAC,0BAA0B,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AACzF,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,0BAA0B,CAAC,MAAc,EAAA;IACvD,OAAO,CAAC,UAAU,EAAE,KAAK,KAAK,UAAU,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;AACnF,CAAC;AAED;;;;;;AAMG;AACG,SAAU,WAAW,CACzB,OAA8D,EAAA;AAE9D,IAAA,OAAO,CAAC,MAAM,EAAE,OAAQ,KAAI;QAC1B,OAAO,UAAU,IACf,UAAU,CAAC,SAAS,CAClB,OAAO,KAAK,SAAS;cACjB,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;AAChC,cAAE,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,iBAAiB,CAAC,YAAY,CAAC,CACzE,CAAC;AACN,KAAC,CAAC;AACJ,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,yBAAyB,CACvC,OAA8D,EAAA;IAE9D,OAAO,MAAM,IAAG;AACd,QAAA,OAAO,UAAU,IAAI,UAAU,CAAC,SAAS,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AACrE,KAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;AAaG;AACH,SAAS,0BAA0B,CACjC,KAA6B,EAC7B,gBAAuC,EACvC,gBAAwB,EACxB,OAAiB,EAAA;AAEjB,IAAA,MAAM,aAAa,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC9C,OAAO,OAAO,OAAO,KAAK,UAAU;UAChC,WAAW,IAAG;AACZ,YAAA,OAAO,aAAa,CAClB,gBAAgB,EAChB,OAAO,CAAC;gBACN,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,OAAO,EAAE,KAAK,CAAC,OAAO;AACtB,gBAAA,GAAG,WAAW;AACf,aAAA,CAAC,CACH,CAAC;SACH;UACD,OAAO,KAAK,SAAS;cACrB,MAAK;AACH,gBAAA,aAAa,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;aAC1C;cACD,eAAe,IAAG;AAChB,gBAAA,aAAa,CAAC,gBAAgB,EAAE,eAAe,CAAC,YAAY,CAAC,CAAC;AAChE,aAAC,CAAC;AACR;;;;"}
+{"version":3,"file":"wires.factory.js","sources":["../../../src/wiring/wires.factory.ts"],"sourcesContent":["import type { Store } from 'vuex'\nimport type { RootXStoreState } from '../store/store.types'\nimport type { MonadicFunction, NiladicFunction, SubObject } from '../utils/index'\nimport type {\n  AnyWire,\n  PayloadFactoryData,\n  Wire,\n  WireParams,\n  WirePayload,\n  WireService,\n  WireServiceWithoutPayload,\n} from './wiring.types'\n\n/**\n * Creates a wire that executes the function passed. This function will receive a\n * {@link WireParams} object.\n *\n * @param fn - The function to execute whenever a new value is emitted to the observable.\n * @returns The Wire function.\n * @public\n */\nexport function createWireFromFunction<Payload>(\n  fn: (parameters: WireParams<Payload>) => void,\n): Wire<Payload> {\n  return (observable, store) =>\n    observable.subscribe(({ metadata, eventPayload }) => {\n      fn({ eventPayload, store, metadata })\n    })\n}\n\n/**\n * Creates a wire that commits a mutation to the store. This wire receives a function. This function\n * is used to get the actual payload value passed to mutation.\n * This wire can be used in every event, as it does not have a payload type associated.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @param payloadFactory - A function that receives a {@link PayloadFactoryData | object}\n * with the Store state, getters, payload and metadata as parameter.\n * @returns A {@link AnyWire} wire that commits the mutation with the payload returned by the\n * payloadFactory.\n * @public\n */\nexport function wireCommit<Payload>(\n  mutation: string,\n  payloadFactory: (params: PayloadFactoryData<Payload>) => any,\n): AnyWire\n/**\n * Creates a wire that commits a mutation to the store. This wire can receive any value as payload.\n * This wire can be used in every event, as it does not have a payload type associated.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @param staticPayload - A static payload to pass to the mutation.\n * @returns {@link AnyWire} A wire that commits the mutation with the staticPayload payload.\n * @public\n */\nexport function wireCommit(mutation: string, staticPayload: any): AnyWire\n/**\n * Creates a wire that commits a mutation to the store. This wire will commit to the store the\n * payload that it receives in the observable.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @typeParam Payload - The type of the payload that this wire will receive\n * @returns {@link Wire} A wire that commits the mutation with the payload that it receives\n * in the observable.\n * @public\n */\nexport function wireCommit<Payload>(mutation: string): Wire<Payload>\n\nexport function wireCommit<Payload>(mutation: string, payload?: Payload): Wire<Payload> {\n  return (observable, store) =>\n    observable.subscribe(createSubscriptionCallback(store, 'commit', mutation, payload))\n}\n\n/**\n * Creates a wire that commits a mutation to the store, but without any payload. This wire can\n * be used in every event, as it does not have a payload type associated.\n *\n * @param mutation - The full mutation path to commit. I.e. `x/searchBox/setQuery`.\n * @returns {@link AnyWire} A wire that commits the mutation without any payload.\n * @public\n */\nexport function wireCommitWithoutPayload(mutation: string): AnyWire {\n  return (observable, store) => observable.subscribe(() => store.commit(mutation))\n}\n\n/**\n * Creates a wire that dispatch an action to the store. This wire receives a function. This function\n * is used to get the actual payload value passed to action.\n * This wire can be used in every event, as it does not have a payload type associated.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @param payloadFactory - A function that receives a {@link PayloadFactoryData | object}\n * with the Store state, getters, payload and metadata as parameter.\n * @returns A {@link AnyWire} wire that dispatches the action with the payload returned by the\n * payloadFactory.\n * @public\n */\nexport function wireDispatch<Payload>(\n  action: string,\n  payloadFactory: (params: PayloadFactoryData<Payload>) => any,\n): AnyWire\n/**\n * Creates a wire that dispatches an action to the store. This wire can be used in every event,\n * as it does not have a payload type associated.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @param staticPayload - A static payload to pass to the action which will be dispatched.\n * @returns {@link AnyWire} A wire that dispatches the action with the staticPayload payload.\n * @public\n */\nexport function wireDispatch(action: string, staticPayload: any): AnyWire\n/**\n * Creates a wire that dispatches an action to the store. This wire will pass the payload\n * received in the observable to the action.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @typeParam Payload - The type of the payload that this wire will receive\n * @returns {@link Wire} A wire that dispatches the action with the payload that it receives\n * in the observable.\n * @public\n */\nexport function wireDispatch<Payload>(action: string): Wire<Payload>\n\nexport function wireDispatch<Payload>(action: string, payload?: Payload): Wire<Payload> {\n  return (observable, store) =>\n    observable.subscribe(createSubscriptionCallback(store, 'dispatch', action, payload))\n}\n\n/**\n * Creates a wire that dispatches an action to the store, but without any payload. This wire can\n * be used in every event, as it does not have a payload type associated.\n *\n * @param action - The full action path to dispatch. I.e. `x/querySuggestions/fetchSuggestions`.\n * @returns {@link AnyWire} A wire that dispatches the action without any payload.\n * @public\n */\nexport function wireDispatchWithoutPayload(action: string): AnyWire {\n  // eslint-disable-next-line ts/no-unsafe-return,ts/no-misused-promises\n  return (observable, store) => observable.subscribe(async () => store.dispatch(action))\n}\n\n/**\n * Creates a wires factory that can create wires that will invoke the service methods.\n *\n * @param service - The service to invoke its methods.\n * @returns A factory to create wires that invoke the service methods.\n * @public\n */\nexport function wireService<SomeService>(\n  service: SomeService & SubObject<SomeService, MonadicFunction>,\n): WireService<SubObject<SomeService, MonadicFunction>> {\n  return (method, payload?) => {\n    return observable =>\n      observable.subscribe(\n        payload !== undefined\n          ? // eslint-disable-next-line ts/no-unsafe-return\n            () => service[method](payload)\n          : // eslint-disable-next-line ts/no-unsafe-return\n            observablePayload => service[method](observablePayload.eventPayload),\n      )\n  }\n}\n\n/**\n * Creates a wires factory that can create wires that will invoke the service methods but\n * without payload.\n *\n * @param service - The service to invoke its methods.\n * @returns A factory to create wires that invoke the service methods without payload.\n * @public\n */\nexport function wireServiceWithoutPayload<SomeService>(\n  service: SomeService & SubObject<SomeService, NiladicFunction>,\n): WireServiceWithoutPayload<SubObject<SomeService, NiladicFunction>> {\n  return method => {\n    // eslint-disable-next-line ts/no-unsafe-return\n    return observable => observable.subscribe(() => service[method]())\n  }\n}\n\n/**\n * Creates the callback function for the {@link wireCommit} and {@link wireDispatch}\n * subscriptions. It can be based on the payload as function which retrieves the observable\n * payload from the store, a static payload or the event value from the observable.\n *\n * @param store - The {@link RootXStoreState} store.\n * @param commitOrDispatch - The executor over store. It can be `commit` or `dispatch`.\n * @param mutationOrAction - The mutation or action to commit or dispatch respectively.\n * @param payload - The payload for the store executor. It can be a function which retrieves the\n * payload from the store, a static payload or the event value from the observable.\n * @typeParam Payload - The type of the payload to get the observable event value type.\n * @returns A function to commit or dispatch a payload value over store.\n * @internal\n */\nfunction createSubscriptionCallback<Payload>(\n  store: Store<RootXStoreState>,\n  commitOrDispatch: 'commit' | 'dispatch',\n  mutationOrAction: string,\n  payload?: Payload,\n): (observableValue: WirePayload<Payload>) => void {\n  const storeExecutor = store[commitOrDispatch]\n  return typeof payload === 'function'\n    ? async wirePayload => {\n        // eslint-disable-next-line ts/no-unsafe-return\n        return storeExecutor(\n          mutationOrAction,\n          // eslint-disable-next-line ts/no-unsafe-call\n          payload({\n            state: store.state,\n            // eslint-disable-next-line ts/no-unsafe-assignment\n            getters: store.getters,\n            ...wirePayload,\n          }),\n        )\n      }\n    : payload !== undefined\n      ? () => {\n          void storeExecutor(mutationOrAction, payload)\n        }\n      : observableValue => {\n          void storeExecutor(mutationOrAction, observableValue.eventPayload)\n        }\n}\n"],"names":[],"mappings":"AAaA;;;;;;;AAOG;AACG,SAAU,sBAAsB,CACpC,EAA6C,EAAA;AAE7C,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,KACvB,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAI;QAClD,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAA;AACvC,KAAC,CAAC,CAAA;AACN,CAAC;AAwCe,SAAA,UAAU,CAAU,QAAgB,EAAE,OAAiB,EAAA;IACrE,OAAO,CAAC,UAAU,EAAE,KAAK,KACvB,UAAU,CAAC,SAAS,CAAC,0BAA0B,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAA;AACxF,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,wBAAwB,CAAC,QAAgB,EAAA;IACvD,OAAO,CAAC,UAAU,EAAE,KAAK,KAAK,UAAU,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;AAClF,CAAC;AAwCe,SAAA,YAAY,CAAU,MAAc,EAAE,OAAiB,EAAA;IACrE,OAAO,CAAC,UAAU,EAAE,KAAK,KACvB,UAAU,CAAC,SAAS,CAAC,0BAA0B,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;AACxF,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,0BAA0B,CAAC,MAAc,EAAA;;IAEvD,OAAO,CAAC,UAAU,EAAE,KAAK,KAAK,UAAU,CAAC,SAAS,CAAC,YAAY,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;AACxF,CAAC;AAED;;;;;;AAMG;AACG,SAAU,WAAW,CACzB,OAA8D,EAAA;AAE9D,IAAA,OAAO,CAAC,MAAM,EAAE,OAAQ,KAAI;QAC1B,OAAO,UAAU,IACf,UAAU,CAAC,SAAS,CAClB,OAAO,KAAK,SAAS;AACnB;gBACE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;AAChC;AACE;AAAA,gBAAA,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,iBAAiB,CAAC,YAAY,CAAC,CACzE,CAAA;AACL,KAAC,CAAA;AACH,CAAC;AAED;;;;;;;AAOG;AACG,SAAU,yBAAyB,CACvC,OAA8D,EAAA;IAE9D,OAAO,MAAM,IAAG;;AAEd,QAAA,OAAO,UAAU,IAAI,UAAU,CAAC,SAAS,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;AACpE,KAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;AAaG;AACH,SAAS,0BAA0B,CACjC,KAA6B,EAC7B,gBAAuC,EACvC,gBAAwB,EACxB,OAAiB,EAAA;AAEjB,IAAA,MAAM,aAAa,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAA;IAC7C,OAAO,OAAO,OAAO,KAAK,UAAU;AAClC,UAAE,OAAM,WAAW,KAAG;;YAElB,OAAO,aAAa,CAClB,gBAAgB;;AAEhB,YAAA,OAAO,CAAC;gBACN,KAAK,EAAE,KAAK,CAAC,KAAK;;gBAElB,OAAO,EAAE,KAAK,CAAC,OAAO;AACtB,gBAAA,GAAG,WAAW;AACf,aAAA,CAAC,CACH,CAAA;SACF;UACD,OAAO,KAAK,SAAS;cACnB,MAAK;AACH,gBAAA,KAAK,aAAa,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAA;aAC9C;cACD,eAAe,IAAG;gBAChB,KAAK,aAAa,CAAC,gBAAgB,EAAE,eAAe,CAAC,YAAY,CAAC,CAAA;AACpE,aAAC,CAAA;AACT;;;;"}

package/js/wiring/wires.operators.js

@@ -101,7 +101,7 @@ function throttle(wire, timeInMs, options = {}) {
     return (observable, store, on) => {
         return wire(observable.pipe(throttle$1(() => createTimer(normalizeTime(timeInMs, store), options, on), {
             leading: true,
-            trailing: true
+            trailing: true,
         })), store, on);
     };
 }
@@ -119,7 +119,7 @@ function throttle(wire, timeInMs, options = {}) {
 function mapWire(toWire, mapFn) {
     return (observable, ...restWireParams) => toWire(observable.pipe(map(({ eventPayload, ...restWirePayload }) => ({
         eventPayload: mapFn(eventPayload),
-        ...restWirePayload
+        ...restWirePayload,
     }))), ...restWireParams);
 }
 

package/js/wiring/wires.operators.js.map

@@ -1 +1 @@
-{"version":3,"file":"wires.operators.js","sources":["../../../src/wiring/wires.operators.ts"],"sourcesContent":["import {\n  debounce as debounceRx,\n  filter as filterRx,\n  map,\n  throttle as throttleRx\n} from 'rxjs/operators';\nimport { XModuleName } from '../x-modules/x-modules.types';\nimport { createTimer, normalizeTime } from './wires-operators.utils';\nimport { TimedWireOperatorOptions, TimeSelector, Wire, WireParams } from './wiring.types';\n\n/**\n * Creates a {@link Wire} that is only executed whenever the condition in the filterFn is true.\n *\n * @param wire - The wire to filter.\n * @param filterFn - A function which must return a boolean and that will be executed every time\n * the wire is called.\n * @returns The Wire function filter.\n *\n * @public\n */\nexport function filter<Payload>(\n  wire: Wire<Payload>,\n  filterFn: (parameters: WireParams<Payload>) => boolean\n): Wire<Payload> {\n  return (observable, store, on) =>\n    wire(observable.pipe(filterRx(wirePayload => filterFn({ ...wirePayload, store }))), store, on);\n}\n\n/**\n * Creates a {@link Wire} that is only executed when the payload is truthy. A truthy value is\n * whatever is not a {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy | falsy value}.\n *\n * @param wire - The wire to avoid executing when the payload is falsy.\n * @returns The Wire function falsy filter.\n *\n * @public\n */\nexport function filterFalsyPayload<Payload>(\n  wire: Wire<Exclude<Payload, null | undefined | false | 0 | ''>>\n): Wire<Payload> {\n  return filter(wire, ({ eventPayload }) => !!eventPayload) as Wire<Payload>;\n}\n\n/**\n * Creates a {@link Wire} that is only executed when the payload is a\n * {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy | falsy value}.\n *\n * @param wire - The wire to avoid executing when the payload is truthy.\n * @returns The Wire function truthy filter.\n *\n * @public\n */\nexport function filterTruthyPayload<Payload>(wire: Wire<Payload>): Wire<Payload> {\n  return filter(wire, ({ eventPayload }) => !eventPayload);\n}\n\n/**\n * Creates a {@link Wire} that is only executed if the event is emitted from a {@link XModule}\n * that is included\n * in the `whitelist` array passed as parameter.\n *\n * @param wire - The wire to filter using the whitelist.\n * @param whitelist - An array of {@link XModuleName} or null.\n * @returns The Wire function with whitelisted modules filter.\n *\n * @public\n */\nexport function filterWhitelistedModules<Payload>(\n  wire: Wire<Payload>,\n  whitelist: Array<XModuleName | null>\n): Wire<Payload> {\n  const whitelistSet = new Set(whitelist);\n  return filter(wire, ({ metadata }) => whitelistSet.has(metadata.moduleName));\n}\n\n/**\n * Creates a {@link Wire} that is only executed if the event is emitted from a {@link XModule}\n * that is NOT included\n * in the `blacklist` array passed as parameter.\n *\n * @param wire - The wire to filter using the whitelist.\n * @param blacklist - An array of {@link XModuleName} or null.\n * @returns The Wire function with blacklisted modules filter.\n *\n * @public\n */\nexport function filterBlacklistedModules<Payload>(\n  wire: Wire<Payload>,\n  blacklist: Array<XModuleName | null>\n): Wire<Payload> {\n  const blacklistSet = new Set(blacklist);\n  return filter(wire, ({ metadata }) => !blacklistSet.has(metadata.moduleName));\n}\n\n/**\n * Creates a debounced {@link Wire}. Being debounced means that it will only be executed after\n * the time given by `timeInMs` has passed without invoking it.\n *\n * @param wire - The wire to debounce.\n * @param timeInMs - The time in milliseconds to debounce the wire execution or a function to\n * retrieve it from the store.\n * @param options - Options to configure this wire with, like an event to force it or cancel it.\n * @returns The Wire function with a debounced timing.\n *\n * @public\n */\nexport function debounce<Payload>(\n  wire: Wire<Payload>,\n  timeInMs: TimeSelector | number,\n  options: TimedWireOperatorOptions = {}\n): Wire<Payload> {\n  return (observable, store, on) => {\n    return wire(\n      observable.pipe(debounceRx(() => createTimer(normalizeTime(timeInMs, store), options, on))),\n      store,\n      on\n    );\n  };\n}\n\n/**\n * Creates a throttled {@link Wire}. Being throttled means that it will only be executed once\n * every couple of milliseconds given by the `timeInMs` parameter.\n *\n * @param wire - The wire to throttle.\n * @param timeInMs - The time in milliseconds to throttle the wire execution or a function to\n * retrieve it from the store.\n * @param options - Options to configure this wire with, like an event to force it or cancel it.\n * @returns The Wire function with a throttle timing.\n *\n * @public\n */\nexport function throttle<Payload>(\n  wire: Wire<Payload>,\n  timeInMs: TimeSelector | number,\n  options: TimedWireOperatorOptions = {}\n): Wire<Payload> {\n  return (observable, store, on) => {\n    return wire(\n      observable.pipe(\n        throttleRx(() => createTimer(normalizeTime(timeInMs, store), options, on), {\n          leading: true,\n          trailing: true\n        })\n      ),\n      store,\n      on\n    );\n  };\n}\n\n/**\n * Creates a {@link Wire} from other `toWire` wire. It uses `mapFn` to transform the\n * `FromPayload` received to `ToPayload` which `toWire` requires. This is\n * useful to reuse wires in different Events where the payload doesn't fit exactly.\n *\n * @param toWire - The wire which the new Wire is created from.\n * @param mapFn - Function to map the payload from `FromPayload` to `ToPayload`.\n * @returns A new {@link Wire}.\n *\n * @public\n */\nexport function mapWire<FromPayload, ToPayload>(\n  toWire: Wire<ToPayload>,\n  mapFn: (payload: FromPayload) => ToPayload\n): Wire<FromPayload> {\n  return (observable, ...restWireParams) =>\n    toWire(\n      observable.pipe(\n        map(({ eventPayload, ...restWirePayload }) => ({\n          eventPayload: mapFn(eventPayload),\n          ...restWirePayload\n        }))\n      ),\n      ...restWireParams\n    );\n}\n"],"names":["filterRx","debounceRx","throttleRx"],"mappings":";;;AAUA;;;;;;;;;AASG;AACa,SAAA,MAAM,CACpB,IAAmB,EACnB,QAAsD,EAAA;AAEtD,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,KAC3B,IAAI,CAAC,UAAU,CAAC,IAAI,CAACA,QAAQ,CAAC,WAAW,IAAI,QAAQ,CAAC,EAAE,GAAG,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;AACnG,CAAC;AAED;;;;;;;;AAQG;AACG,SAAU,kBAAkB,CAChC,IAA+D,EAAA;AAE/D,IAAA,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,YAAY,CAAkB,CAAC;AAC7E,CAAC;AAED;;;;;;;;AAQG;AACG,SAAU,mBAAmB,CAAU,IAAmB,EAAA;AAC9D,IAAA,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;AAC3D,CAAC;AAED;;;;;;;;;;AAUG;AACa,SAAA,wBAAwB,CACtC,IAAmB,EACnB,SAAoC,EAAA;AAEpC,IAAA,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;IACxC,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;AAC/E,CAAC;AAED;;;;;;;;;;AAUG;AACa,SAAA,wBAAwB,CACtC,IAAmB,EACnB,SAAoC,EAAA;AAEpC,IAAA,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;IACxC,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;AAChF,CAAC;AAED;;;;;;;;;;;AAWG;AACG,SAAU,QAAQ,CACtB,IAAmB,EACnB,QAA+B,EAC/B,UAAoC,EAAE,EAAA;AAEtC,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,KAAI;AAC/B,QAAA,OAAO,IAAI,CACT,UAAU,CAAC,IAAI,CAACC,UAAU,CAAC,MAAM,WAAW,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,EAC3F,KAAK,EACL,EAAE,CACH,CAAC;AACJ,KAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;AAWG;AACG,SAAU,QAAQ,CACtB,IAAmB,EACnB,QAA+B,EAC/B,UAAoC,EAAE,EAAA;AAEtC,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,KAAI;QAC/B,OAAO,IAAI,CACT,UAAU,CAAC,IAAI,CACbC,UAAU,CAAC,MAAM,WAAW,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE;AACzE,YAAA,OAAO,EAAE,IAAI;AACb,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA,CAAC,CACH,EACD,KAAK,EACL,EAAE,CACH,CAAC;AACJ,KAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;AAUG;AACa,SAAA,OAAO,CACrB,MAAuB,EACvB,KAA0C,EAAA;IAE1C,OAAO,CAAC,UAAU,EAAE,GAAG,cAAc,KACnC,MAAM,CACJ,UAAU,CAAC,IAAI,CACb,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,GAAG,eAAe,EAAE,MAAM;AAC7C,QAAA,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;AACjC,QAAA,GAAG,eAAe;AACnB,KAAA,CAAC,CAAC,CACJ,EACD,GAAG,cAAc,CAClB,CAAC;AACN;;;;"}
+{"version":3,"file":"wires.operators.js","sources":["../../../src/wiring/wires.operators.ts"],"sourcesContent":["import type { XModuleName } from '../x-modules/x-modules.types'\nimport type { TimedWireOperatorOptions, TimeSelector, Wire, WireParams } from './wiring.types'\nimport {\n  debounce as debounceRx,\n  filter as filterRx,\n  map,\n  throttle as throttleRx,\n} from 'rxjs/operators'\nimport { createTimer, normalizeTime } from './wires-operators.utils'\n\n/**\n * Creates a {@link Wire} that is only executed whenever the condition in the filterFn is true.\n *\n * @param wire - The wire to filter.\n * @param filterFn - A function which must return a boolean and that will be executed every time\n * the wire is called.\n * @returns The Wire function filter.\n *\n * @public\n */\nexport function filter<Payload>(\n  wire: Wire<Payload>,\n  filterFn: (parameters: WireParams<Payload>) => boolean,\n): Wire<Payload> {\n  return (observable, store, on) =>\n    wire(observable.pipe(filterRx(wirePayload => filterFn({ ...wirePayload, store }))), store, on)\n}\n\n/**\n * Creates a {@link Wire} that is only executed when the payload is truthy. A truthy value is\n * whatever is not a {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy | falsy value}.\n *\n * @param wire - The wire to avoid executing when the payload is falsy.\n * @returns The Wire function falsy filter.\n *\n * @public\n */\nexport function filterFalsyPayload<Payload>(\n  wire: Wire<Exclude<Payload, null | undefined | false | 0 | ''>>,\n): Wire<Payload> {\n  return filter(wire, ({ eventPayload }) => !!eventPayload) as Wire<Payload>\n}\n\n/**\n * Creates a {@link Wire} that is only executed when the payload is a\n * {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy | falsy value}.\n *\n * @param wire - The wire to avoid executing when the payload is truthy.\n * @returns The Wire function truthy filter.\n *\n * @public\n */\nexport function filterTruthyPayload<Payload>(wire: Wire<Payload>): Wire<Payload> {\n  return filter(wire, ({ eventPayload }) => !eventPayload)\n}\n\n/**\n * Creates a {@link Wire} that is only executed if the event is emitted from a {@link XModule}\n * that is included\n * in the `whitelist` array passed as parameter.\n *\n * @param wire - The wire to filter using the whitelist.\n * @param whitelist - An array of {@link XModuleName} or null.\n * @returns The Wire function with whitelisted modules filter.\n *\n * @public\n */\nexport function filterWhitelistedModules<Payload>(\n  wire: Wire<Payload>,\n  whitelist: Array<XModuleName | null>,\n): Wire<Payload> {\n  const whitelistSet = new Set(whitelist)\n  return filter(wire, ({ metadata }) => whitelistSet.has(metadata.moduleName))\n}\n\n/**\n * Creates a {@link Wire} that is only executed if the event is emitted from a {@link XModule}\n * that is NOT included\n * in the `blacklist` array passed as parameter.\n *\n * @param wire - The wire to filter using the whitelist.\n * @param blacklist - An array of {@link XModuleName} or null.\n * @returns The Wire function with blacklisted modules filter.\n *\n * @public\n */\nexport function filterBlacklistedModules<Payload>(\n  wire: Wire<Payload>,\n  blacklist: Array<XModuleName | null>,\n): Wire<Payload> {\n  const blacklistSet = new Set(blacklist)\n  return filter(wire, ({ metadata }) => !blacklistSet.has(metadata.moduleName))\n}\n\n/**\n * Creates a debounced {@link Wire}. Being debounced means that it will only be executed after\n * the time given by `timeInMs` has passed without invoking it.\n *\n * @param wire - The wire to debounce.\n * @param timeInMs - The time in milliseconds to debounce the wire execution or a function to\n * retrieve it from the store.\n * @param options - Options to configure this wire with, like an event to force it or cancel it.\n * @returns The Wire function with a debounced timing.\n *\n * @public\n */\nexport function debounce<Payload>(\n  wire: Wire<Payload>,\n  timeInMs: TimeSelector | number,\n  options: TimedWireOperatorOptions = {},\n): Wire<Payload> {\n  return (observable, store, on) => {\n    return wire(\n      observable.pipe(debounceRx(() => createTimer(normalizeTime(timeInMs, store), options, on))),\n      store,\n      on,\n    )\n  }\n}\n\n/**\n * Creates a throttled {@link Wire}. Being throttled means that it will only be executed once\n * every couple of milliseconds given by the `timeInMs` parameter.\n *\n * @param wire - The wire to throttle.\n * @param timeInMs - The time in milliseconds to throttle the wire execution or a function to\n * retrieve it from the store.\n * @param options - Options to configure this wire with, like an event to force it or cancel it.\n * @returns The Wire function with a throttle timing.\n *\n * @public\n */\nexport function throttle<Payload>(\n  wire: Wire<Payload>,\n  timeInMs: TimeSelector | number,\n  options: TimedWireOperatorOptions = {},\n): Wire<Payload> {\n  return (observable, store, on) => {\n    return wire(\n      observable.pipe(\n        throttleRx(() => createTimer(normalizeTime(timeInMs, store), options, on), {\n          leading: true,\n          trailing: true,\n        }),\n      ),\n      store,\n      on,\n    )\n  }\n}\n\n/**\n * Creates a {@link Wire} from other `toWire` wire. It uses `mapFn` to transform the\n * `FromPayload` received to `ToPayload` which `toWire` requires. This is\n * useful to reuse wires in different Events where the payload doesn't fit exactly.\n *\n * @param toWire - The wire which the new Wire is created from.\n * @param mapFn - Function to map the payload from `FromPayload` to `ToPayload`.\n * @returns A new {@link Wire}.\n *\n * @public\n */\nexport function mapWire<FromPayload, ToPayload>(\n  toWire: Wire<ToPayload>,\n  mapFn: (payload: FromPayload) => ToPayload,\n): Wire<FromPayload> {\n  return (observable, ...restWireParams) =>\n    toWire(\n      observable.pipe(\n        map(({ eventPayload, ...restWirePayload }) => ({\n          eventPayload: mapFn(eventPayload),\n          ...restWirePayload,\n        })),\n      ),\n      ...restWireParams,\n    )\n}\n"],"names":["filterRx","debounceRx","throttleRx"],"mappings":";;;AAUA;;;;;;;;;AASG;AACa,SAAA,MAAM,CACpB,IAAmB,EACnB,QAAsD,EAAA;AAEtD,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,KAC3B,IAAI,CAAC,UAAU,CAAC,IAAI,CAACA,QAAQ,CAAC,WAAW,IAAI,QAAQ,CAAC,EAAE,GAAG,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAA;AAClG,CAAC;AAED;;;;;;;;AAQG;AACG,SAAU,kBAAkB,CAChC,IAA+D,EAAA;AAE/D,IAAA,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,YAAY,CAAkB,CAAA;AAC5E,CAAC;AAED;;;;;;;;AAQG;AACG,SAAU,mBAAmB,CAAU,IAAmB,EAAA;AAC9D,IAAA,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC,CAAA;AAC1D,CAAC;AAED;;;;;;;;;;AAUG;AACa,SAAA,wBAAwB,CACtC,IAAmB,EACnB,SAAoC,EAAA;AAEpC,IAAA,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAA;IACvC,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAA;AAC9E,CAAC;AAED;;;;;;;;;;AAUG;AACa,SAAA,wBAAwB,CACtC,IAAmB,EACnB,SAAoC,EAAA;AAEpC,IAAA,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAA;IACvC,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAA;AAC/E,CAAC;AAED;;;;;;;;;;;AAWG;AACG,SAAU,QAAQ,CACtB,IAAmB,EACnB,QAA+B,EAC/B,UAAoC,EAAE,EAAA;AAEtC,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,KAAI;AAC/B,QAAA,OAAO,IAAI,CACT,UAAU,CAAC,IAAI,CAACC,UAAU,CAAC,MAAM,WAAW,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,EAC3F,KAAK,EACL,EAAE,CACH,CAAA;AACH,KAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;AAWG;AACG,SAAU,QAAQ,CACtB,IAAmB,EACnB,QAA+B,EAC/B,UAAoC,EAAE,EAAA;AAEtC,IAAA,OAAO,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,KAAI;QAC/B,OAAO,IAAI,CACT,UAAU,CAAC,IAAI,CACbC,UAAU,CAAC,MAAM,WAAW,CAAC,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE;AACzE,YAAA,OAAO,EAAE,IAAI;AACb,YAAA,QAAQ,EAAE,IAAI;AACf,SAAA,CAAC,CACH,EACD,KAAK,EACL,EAAE,CACH,CAAA;AACH,KAAC,CAAA;AACH,CAAC;AAED;;;;;;;;;;AAUG;AACa,SAAA,OAAO,CACrB,MAAuB,EACvB,KAA0C,EAAA;IAE1C,OAAO,CAAC,UAAU,EAAE,GAAG,cAAc,KACnC,MAAM,CACJ,UAAU,CAAC,IAAI,CACb,GAAG,CAAC,CAAC,EAAE,YAAY,EAAE,GAAG,eAAe,EAAE,MAAM;AAC7C,QAAA,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;AACjC,QAAA,GAAG,eAAe;AACnB,KAAA,CAAC,CAAC,CACJ,EACD,GAAG,cAAc,CAClB,CAAA;AACL;;;;"}