@empathyco/x-components 6.3.2 → 7.0.0

package/report/x-components.api.json

@@ -5587,7 +5587,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@empathyco/x-components!BaseCurrency:var",
-          "docComment": "/**\n * Renders the value received as a property which always must be a JavaScript number, with the proper format provided as a string property or by injection. The rendered tag is a span in order to render a default inline HTML element.\n *\n * Regarding the format or mask to be defined as string: - Use 'i' to define integer numbers. - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the format doesn't include decimals, it is filled with zeros until reach the length defined with 'd's. - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group. - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more than one character. - If you want to hide the decimal part if it's zero, you can add the `?` symbol after the decimal characters (e.g. 'i.iii,dd?', for `1234` you would get `1.234` instead of `1.234,00`). - Set whatever you need around the integers and decimals marks. - Default mask: 'i.iii,dd' which returns '1.345,67'.\n *\n * @remarks\n *\n * The number of 'd', which is the maximum decimal length, MUST matches with the length of decimals provided from the adapter. Otherwise, when the component truncate the decimal part, it deletes significant digits.\n *\n * Basic example:\n * ```vue\n * <BaseCurrency\n *   :value=\"123456.789\"\n *   format=\"i.iiii,dddd €\"\n * />\n * ```\n *\n * It will render: `123.456,7890 €`.\n *\n * See docs below for more examples.\n *\n * @public\n */\n",
+          "docComment": "",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -5622,7 +5622,7 @@
             },
             {
               "kind": "Content",
-              "text": ";\n        required: true;\n    };\n    format: {\n        type: "
+              "text": ";\n        required: true;\n    };\n    currency: "
             },
             {
               "kind": "Reference",
@@ -5631,7 +5631,34 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    };\n}>, {\n    currency: import(\"vue\")."
+              "text": ";\n    format: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropType",
+              "canonicalReference": "@vue/runtime-core!PropType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Intl.NumberFormatOptions",
+              "canonicalReference": "!Intl.NumberFormatOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"currency\" | \"style\">>;\n        default: () => {};\n    };\n}>, {\n    currencyText: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -5694,7 +5721,7 @@
             },
             {
               "kind": "Content",
-              "text": ";\n        required: true;\n    };\n    format: {\n        type: "
+              "text": ";\n        required: true;\n    };\n    currency: "
             },
             {
               "kind": "Reference",
@@ -5703,7 +5730,34 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    };\n}>> & "
+              "text": ";\n    format: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropType",
+              "canonicalReference": "@vue/runtime-core!PropType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Intl.NumberFormatOptions",
+              "canonicalReference": "!Intl.NumberFormatOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"currency\" | \"style\">>;\n        default: () => {};\n    };\n}>> & "
             },
             {
               "kind": "Reference",
@@ -5712,7 +5766,25 @@
             },
             {
               "kind": "Content",
-              "text": "<{}>, {}, {}, {}, {}, string, import(\"vue\")."
+              "text": "<{}>, {\n    format: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Intl.NumberFormatOptions",
+              "canonicalReference": "!Intl.NumberFormatOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"currency\" | \"style\">;\n}, {}, {}, {}, string, import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -5730,7 +5802,7 @@
           "name": "BaseCurrency",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 30
+            "endIndex": 46
           }
         },
         {
@@ -9486,7 +9558,7 @@
             },
             {
               "kind": "Content",
-              "text": ";\n        }>;\n        required: true;\n    };\n    format: {\n        type: "
+              "text": ";\n        }>;\n        required: true;\n    };\n    currency: "
             },
             {
               "kind": "Reference",
@@ -9495,7 +9567,34 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    };\n    lessThan: {\n        type: "
+              "text": ";\n    format: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropType",
+              "canonicalReference": "@vue/runtime-core!PropType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Intl.NumberFormatOptions",
+              "canonicalReference": "!Intl.NumberFormatOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"currency\" | \"style\">>;\n    lessThan: {\n        type: "
             },
             {
               "kind": "Reference",
@@ -9612,7 +9711,7 @@
             },
             {
               "kind": "Content",
-              "text": ";\n        }>;\n        required: true;\n    };\n    format: {\n        type: "
+              "text": ";\n        }>;\n        required: true;\n    };\n    currency: "
             },
             {
               "kind": "Reference",
@@ -9621,7 +9720,34 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    };\n    lessThan: {\n        type: "
+              "text": ";\n    format: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropType",
+              "canonicalReference": "@vue/runtime-core!PropType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Intl.NumberFormatOptions",
+              "canonicalReference": "!Intl.NumberFormatOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"currency\" | \"style\">>;\n    lessThan: {\n        type: "
             },
             {
               "kind": "Reference",
@@ -9684,7 +9810,7 @@
           "name": "BasePriceFilterLabel",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 52
+            "endIndex": 64
           }
         },
         {
@@ -10077,7 +10203,7 @@
             },
             {
               "kind": "Content",
-              "text": ">;\n        required: true;\n    };\n    format: {\n        type: "
+              "text": ">;\n        required: true;\n    };\n    currency: "
             },
             {
               "kind": "Reference",
@@ -10086,7 +10212,34 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    };\n}>, {\n    dynamicClasses: import(\"vue\")."
+              "text": ";\n    format: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropType",
+              "canonicalReference": "@vue/runtime-core!PropType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Intl.NumberFormatOptions",
+              "canonicalReference": "!Intl.NumberFormatOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"currency\" | \"style\">>;\n        default: () => {};\n    };\n}>, {\n    dynamicClasses: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -10167,7 +10320,7 @@
             },
             {
               "kind": "Content",
-              "text": ">;\n        required: true;\n    };\n    format: {\n        type: "
+              "text": ">;\n        required: true;\n    };\n    currency: "
             },
             {
               "kind": "Reference",
@@ -10176,7 +10329,34 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    };\n}>> & "
+              "text": ";\n    format: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropType",
+              "canonicalReference": "@vue/runtime-core!PropType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Intl.NumberFormatOptions",
+              "canonicalReference": "!Intl.NumberFormatOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"currency\" | \"style\">>;\n        default: () => {};\n    };\n}>> & "
             },
             {
               "kind": "Reference",
@@ -10185,7 +10365,25 @@
             },
             {
               "kind": "Content",
-              "text": "<{}>, {}, {}, {\n    BaseCurrency: import(\"vue\")."
+              "text": "<{}>, {\n    format: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Intl.NumberFormatOptions",
+              "canonicalReference": "!Intl.NumberFormatOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"currency\" | \"style\">;\n}, {}, {\n    BaseCurrency: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -10212,7 +10410,7 @@
           "name": "BaseResultCurrentPrice",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 38
+            "endIndex": 54
           }
         },
         {
@@ -10803,7 +11001,7 @@
             },
             {
               "kind": "Content",
-              "text": ">;\n        required: true;\n    };\n    format: {\n        type: "
+              "text": ">;\n        required: true;\n    };\n    currency: "
             },
             {
               "kind": "Reference",
@@ -10812,7 +11010,34 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    };\n}>, {}, {}, {}, {}, import(\"vue\")."
+              "text": ";\n    format: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropType",
+              "canonicalReference": "@vue/runtime-core!PropType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Intl.NumberFormatOptions",
+              "canonicalReference": "!Intl.NumberFormatOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"currency\" | \"style\">>;\n        default: () => {};\n    };\n}>, {}, {}, {}, {}, import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -10875,7 +11100,7 @@
             },
             {
               "kind": "Content",
-              "text": ">;\n        required: true;\n    };\n    format: {\n        type: "
+              "text": ">;\n        required: true;\n    };\n    currency: "
             },
             {
               "kind": "Reference",
@@ -10884,7 +11109,34 @@
             },
             {
               "kind": "Content",
-              "text": ";\n    };\n}>> & "
+              "text": ";\n    format: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropType",
+              "canonicalReference": "@vue/runtime-core!PropType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Intl.NumberFormatOptions",
+              "canonicalReference": "!Intl.NumberFormatOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"currency\" | \"style\">>;\n        default: () => {};\n    };\n}>> & "
             },
             {
               "kind": "Reference",
@@ -10893,7 +11145,25 @@
             },
             {
               "kind": "Content",
-              "text": "<{}>, {}, {}, {\n    BaseCurrency: import(\"vue\")."
+              "text": "<{}>, {\n    format: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Omit",
+              "canonicalReference": "!Omit:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Intl.NumberFormatOptions",
+              "canonicalReference": "!Intl.NumberFormatOptions:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", \"currency\" | \"style\">;\n}, {}, {\n    BaseCurrency: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -10920,7 +11190,7 @@
           "name": "BaseResultPreviousPrice",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 34
+            "endIndex": 50
           }
         },
         {
@@ -17750,67 +18020,6 @@
             "endIndex": 24
           }
         },
-        {
-          "kind": "Function",
-          "canonicalReference": "@empathyco/x-components!currencyFormatter:function(1)",
-          "docComment": "/**\n * Format a value with a given format.\n *\n * @remarks\n *\n * Format: - Use 'i' to define integer numbers. - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the doesn't include decimals, it is filled with zeros until reach the length defined with 'd's. - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group. - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more than one character. - Set whatever you need around the integers and decimals marks. - Default mask: 'i.iii,dd' which returns '1.345,67'. - If you want to hide the decimal part if it's zero (non significant), you can add the `?` symbol after the decimal characters (e.g. 'i.iii,dd?', for `1234` you would get `1.234` instead of `1.234,00`). It defines the value of `hideIntegerDecimals`: - If true (exists) and the value is an integer without decimals, the decimal non significant zeroes are hidden. - If false, the default behaviour will fill with zeros the remaining length until getting the one defined with the 'd's.\n *\n * @param value - Numeric value to be formatted.\n *\n * @param format - Format or mask to be defined as string.\n *\n * @returns Formatted number.\n *\n * @public\n */\n",
-          "excerptTokens": [
-            {
-              "kind": "Content",
-              "text": "export declare function currencyFormatter(value: "
-            },
-            {
-              "kind": "Content",
-              "text": "number"
-            },
-            {
-              "kind": "Content",
-              "text": ", format?: "
-            },
-            {
-              "kind": "Content",
-              "text": "string"
-            },
-            {
-              "kind": "Content",
-              "text": "): "
-            },
-            {
-              "kind": "Content",
-              "text": "string"
-            },
-            {
-              "kind": "Content",
-              "text": ";"
-            }
-          ],
-          "fileUrlPath": "src/utils/currency-formatter.ts",
-          "returnTypeTokenRange": {
-            "startIndex": 5,
-            "endIndex": 6
-          },
-          "releaseTag": "Public",
-          "overloadIndex": 1,
-          "parameters": [
-            {
-              "parameterName": "value",
-              "parameterTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isOptional": false
-            },
-            {
-              "parameterName": "format",
-              "parameterTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
-              "isOptional": true
-            }
-          ],
-          "name": "currencyFormatter"
-        },
         {
           "kind": "Function",
           "canonicalReference": "@empathyco/x-components!debounce:function(1)",

package/report/x-components.api.md

@@ -634,26 +634,32 @@ buttonClass: StringConstructor;
 BaseEventButton: DefineComponent<    {}, {}, any>;
 }, {}, string, ComponentProvideOptions, true, {}, any>;
 
-// @public
+// @public (undocumented)
 export const BaseCurrency: DefineComponent<ExtractPropTypes<    {
 value: {
 type: NumberConstructor;
 required: true;
 };
+currency: StringConstructor;
 format: {
-type: StringConstructor;
+type: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
+default: () => {};
 };
 }>, {
-currency: ComputedRef<string>;
+currencyText: ComputedRef<string>;
 }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
 value: {
 type: NumberConstructor;
 required: true;
 };
+currency: StringConstructor;
 format: {
-type: StringConstructor;
+type: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
+default: () => {};
 };
-}>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+}>> & Readonly<{}>, {
+format: Omit<Intl.NumberFormatOptions, "currency" | "style">;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 
 // @public
 export const BaseDropdown: DefineComponent<ExtractPropTypes<    {
@@ -1120,9 +1126,8 @@ range: RangeValue;
 }>;
 required: true;
 };
-format: {
-type: StringConstructor;
-};
+currency: StringConstructor;
+format: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
 lessThan: {
 type: StringConstructor;
 required: true;
@@ -1144,9 +1149,8 @@ range: RangeValue;
 }>;
 required: true;
 };
-format: {
-type: StringConstructor;
-};
+currency: StringConstructor;
+format: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
 lessThan: {
 type: StringConstructor;
 required: true;
@@ -1224,8 +1228,10 @@ result: {
 type: PropType<Result>;
 required: true;
 };
+currency: StringConstructor;
 format: {
-type: StringConstructor;
+type: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
+default: () => {};
 };
 }>, {
 dynamicClasses: ComputedRef<VueCSSClasses>;
@@ -1234,10 +1240,14 @@ result: {
 type: PropType<Result>;
 required: true;
 };
+currency: StringConstructor;
 format: {
-type: StringConstructor;
+type: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
+default: () => {};
 };
-}>> & Readonly<{}>, {}, {}, {
+}>> & Readonly<{}>, {
+format: Omit<Intl.NumberFormatOptions, "currency" | "style">;
+}, {}, {
 BaseCurrency: DefineComponent<    {}, {}, any>;
 }, {}, string, ComponentProvideOptions, true, {}, any>;
 
@@ -1312,18 +1322,24 @@ result: {
 type: PropType<Result>;
 required: true;
 };
+currency: StringConstructor;
 format: {
-type: StringConstructor;
+type: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
+default: () => {};
 };
 }>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
 result: {
 type: PropType<Result>;
 required: true;
 };
+currency: StringConstructor;
 format: {
-type: StringConstructor;
+type: PropType<Omit<Intl.NumberFormatOptions, "currency" | "style">>;
+default: () => {};
 };
-}>> & Readonly<{}>, {}, {}, {
+}>> & Readonly<{}>, {
+format: Omit<Intl.NumberFormatOptions, "currency" | "style">;
+}, {}, {
 BaseCurrency: DefineComponent<    {}, {}, any>;
 }, {}, string, ComponentProvideOptions, true, {}, any>;
 
@@ -2115,9 +2131,6 @@ export { CuratedCheckTinyFilledIcon }
 
 export { CuratedCheckTinyIcon }
 
-// @public
-export function currencyFormatter(value: number, format?: string): string;
-
 // @public
 export function debounce<Payload>(wire: Wire<Payload>, timeInMs: TimeSelector | number, options?: TimedWireOperatorOptions): Wire<Payload>;