@empathyco/x-components 8.2.0 → 8.4.0

package/report/x-components.api.json

@@ -5030,7 +5030,52 @@
             },
             {
               "kind": "Content",
-              "text": ">;\n        required: true;\n    };\n}>, {\n    events: {};\n    metadata: "
+              "text": ">;\n        required: true;\n    };\n    clickEvent: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropType",
+              "canonicalReference": "@vue/runtime-core!PropType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "XEvent",
+              "canonicalReference": "@empathyco/x-components!XEvent:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">;\n        default: string;\n    };\n}>, {\n    events: import(\"vue\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ComputedRef",
+              "canonicalReference": "@vue/reactivity!ComputedRef:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "Partial",
+              "canonicalReference": "!Partial:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "XEventsTypes",
+              "canonicalReference": "@empathyco/x-components!XEventsTypes:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">>;\n    metadata: "
             },
             {
               "kind": "Reference",
@@ -5111,7 +5156,25 @@
             },
             {
               "kind": "Content",
-              "text": ">;\n        required: true;\n    };\n}>> & "
+              "text": ">;\n        required: true;\n    };\n    clickEvent: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropType",
+              "canonicalReference": "@vue/runtime-core!PropType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "XEvent",
+              "canonicalReference": "@empathyco/x-components!XEvent:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">;\n        default: string;\n    };\n}>> & "
             },
             {
               "kind": "Reference",
@@ -5120,7 +5183,16 @@
             },
             {
               "kind": "Content",
-              "text": "<{}>, {}, {}, {\n    BaseEventButton: import(\"vue\")."
+              "text": "<{}>, {\n    clickEvent: keyof "
+            },
+            {
+              "kind": "Reference",
+              "text": "XEventsTypes",
+              "canonicalReference": "@empathyco/x-components!XEventsTypes:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}, {}, {\n    BaseEventButton: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -5147,7 +5219,7 @@
           "name": "BaseAddToCart",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 34
+            "endIndex": 50
           }
         },
         {
@@ -10797,7 +10869,25 @@
             },
             {
               "kind": "Content",
-              "text": ">;\n        required: true;\n    };\n}>, {\n    el: import(\"vue\")."
+              "text": ">;\n        required: true;\n    };\n    clickEvent: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropType",
+              "canonicalReference": "@vue/runtime-core!PropType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "XEvent",
+              "canonicalReference": "@empathyco/x-components!XEvent:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">;\n        default: string;\n    };\n}>, {\n    el: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -10806,7 +10896,7 @@
             },
             {
               "kind": "Content",
-              "text": "<any, any>;\n    emitUserClickedAResult: () => void;\n}, {}, {}, {}, import(\"vue\")."
+              "text": "<any, any>;\n    onClick: () => void;\n}, {}, {}, {}, import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -10869,7 +10959,25 @@
             },
             {
               "kind": "Content",
-              "text": ">;\n        required: true;\n    };\n}>> & "
+              "text": ">;\n        required: true;\n    };\n    clickEvent: {\n        type: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PropType",
+              "canonicalReference": "@vue/runtime-core!PropType:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "XEvent",
+              "canonicalReference": "@empathyco/x-components!XEvent:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">;\n        default: string;\n    };\n}>> & "
             },
             {
               "kind": "Reference",
@@ -10878,7 +10986,16 @@
             },
             {
               "kind": "Content",
-              "text": "<{}>, {}, {}, {}, {}, string, import(\"vue\")."
+              "text": "<{}>, {\n    clickEvent: keyof "
+            },
+            {
+              "kind": "Reference",
+              "text": "XEventsTypes",
+              "canonicalReference": "@empathyco/x-components!XEventsTypes:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n}, {}, {}, {}, string, import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -10896,7 +11013,7 @@
           "name": "BaseResultLink",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 30
+            "endIndex": 40
           }
         },
         {
@@ -37000,7 +37117,34 @@
             },
             {
               "kind": "Content",
-              "text": ", \"modelName\">[] | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
+              "text": ", \"modelName\">[] | undefined;\n        UserViewedAVendorResult?: import(\"../../../vendor\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorResult",
+              "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        UserClickedAVendorResult?: import(\"../../../vendor\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorResult",
+              "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        UserClickedVendorResultAddToCart?: import(\"../../../vendor\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorResult",
+              "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -37270,7 +37414,7 @@
           "name": "HierarchicalFilter",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 300
+            "endIndex": 306
           }
         },
         {
@@ -63148,6 +63292,34 @@
             "endIndex": 3
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!resetUrlQuery:var",
+          "docComment": "/**\n * Sets to empathy string the query of the url module.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "resetUrlQuery: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"../..\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "AnyWire",
+              "canonicalReference": "@empathyco/x-components!AnyWire:type"
+            }
+          ],
+          "fileUrlPath": "src/x-modules/url/wiring.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "resetUrlQuery",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@empathyco/x-components!ResultFeature:type",
@@ -76172,7 +76344,34 @@
             },
             {
               "kind": "Content",
-              "text": ", \"modelName\">[] | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
+              "text": ", \"modelName\">[] | undefined;\n        UserViewedAVendorResult?: import(\"../../../vendor\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorResult",
+              "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        UserClickedAVendorResult?: import(\"../../../vendor\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorResult",
+              "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        UserClickedVendorResultAddToCart?: import(\"../../../vendor\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorResult",
+              "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -76343,7 +76542,7 @@
           "name": "SimpleFilter",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 268
+            "endIndex": 274
           }
         },
         {
@@ -79549,6 +79748,60 @@
               "text": "WireMetadata",
               "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
             },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        UserViewedAVendorResult: (payload: import(\"..\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorResult",
+              "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        UserClickedAVendorResult: (payload: import(\"..\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorResult",
+              "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        UserClickedVendorResultAddToCart: (payload: import(\"..\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorResult",
+              "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
             {
               "kind": "Content",
               "text": ") => unknown;\n    }>>;\n}, {}, {}, {}, import(\"vue\")."
@@ -79623,7 +79876,7 @@
           "name": "SnippetCallbacks",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 574
+            "endIndex": 586
           }
         },
         {
@@ -89697,7 +89950,7 @@
             },
             {
               "kind": "Content",
-              "text": ", 'modelName'>"
+              "text": ", 'modelName' | 'tagging'>"
             },
             {
               "kind": "Content",
@@ -89748,6 +90001,34 @@
                 "startIndex": 1,
                 "endIndex": 2
               }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorResult#tagging:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "tagging?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "VendorResultTagging",
+                  "canonicalReference": "@empathyco/x-components!VendorResultTagging:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "tagging",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
             }
           ],
           "extendsTokenRanges": [
@@ -89964,6 +90245,105 @@
             "endIndex": 42
           }
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@empathyco/x-components!VendorResultTagging:interface",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface VendorResultTagging "
+            }
+          ],
+          "fileUrlPath": "src/x-modules/vendor/types.ts",
+          "releaseTag": "Public",
+          "name": "VendorResultTagging",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorResultTagging#add2cartUrl:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "add2cartUrl: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "add2cartUrl",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorResultTagging#clickUrl:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "clickUrl: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "clickUrl",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorResultTagging#viewUrl:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "viewUrl: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "viewUrl",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@empathyco/x-components!VendorState:interface",
@@ -90029,6 +90409,90 @@
           "name": "VendorXEvents",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorXEvents#UserClickedAVendorResult:member",
+              "docComment": "/**\n * The user clicked on a vendor result. Payload: The {@link VendorResult | vendor result} that was clicked.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "UserClickedAVendorResult: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "VendorResult",
+                  "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "UserClickedAVendorResult",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorXEvents#UserClickedVendorResultAddToCart:member",
+              "docComment": "/**\n * The user clicked on the add to cart button of a vendor result. Payload: The {@link VendorResult | vendor result} that was clicked.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "UserClickedVendorResultAddToCart: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "VendorResult",
+                  "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "UserClickedVendorResultAddToCart",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorXEvents#UserViewedAVendorResult:member",
+              "docComment": "/**\n * The user viewed a vendor result. Payload: The {@link VendorResult | vendor result} that was viewed.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "UserViewedAVendorResult: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "VendorResult",
+                  "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "UserViewedAVendorResult",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!VendorXEvents#VendorResultsChanged:member",