@empathyco/x-components 8.8.1 → 8.10.0

package/report/x-components.api.json

@@ -37171,7 +37171,16 @@
             },
             {
               "kind": "Content",
-              "text": ", \"modelName\">[] | undefined;\n        UserViewedAVendorResult?: import(\"../../../vendor\")."
+              "text": ", \"modelName\">[] | undefined;\n        VendorResultMounted?: import(\"../../../vendor\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorResult",
+              "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        UserViewedAVendorResult?: import(\"../../../vendor\")."
             },
             {
               "kind": "Reference",
@@ -37216,7 +37225,16 @@
             },
             {
               "kind": "Content",
-              "text": ", \"modelName\">[] | undefined;\n        UserViewedAVendorBanner?: import(\"../../../vendor\")."
+              "text": ", \"modelName\">[] | undefined;\n        VendorBannerMounted?: import(\"../../../vendor\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorBanner",
+              "canonicalReference": "@empathyco/x-components!VendorBanner:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        UserViewedAVendorBanner?: import(\"../../../vendor\")."
             },
             {
               "kind": "Reference",
@@ -37234,7 +37252,7 @@
             },
             {
               "kind": "Content",
-              "text": " | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
+              "text": " | undefined;\n        VendorQueryChanged?: string | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -37504,7 +37522,7 @@
           "name": "HierarchicalFilter",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 316
+            "endIndex": 320
           }
         },
         {
@@ -76508,7 +76526,16 @@
             },
             {
               "kind": "Content",
-              "text": ", \"modelName\">[] | undefined;\n        UserViewedAVendorResult?: import(\"../../../vendor\")."
+              "text": ", \"modelName\">[] | undefined;\n        VendorResultMounted?: import(\"../../../vendor\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorResult",
+              "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        UserViewedAVendorResult?: import(\"../../../vendor\")."
             },
             {
               "kind": "Reference",
@@ -76553,7 +76580,16 @@
             },
             {
               "kind": "Content",
-              "text": ", \"modelName\">[] | undefined;\n        UserViewedAVendorBanner?: import(\"../../../vendor\")."
+              "text": ", \"modelName\">[] | undefined;\n        VendorBannerMounted?: import(\"../../../vendor\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorBanner",
+              "canonicalReference": "@empathyco/x-components!VendorBanner:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        UserViewedAVendorBanner?: import(\"../../../vendor\")."
             },
             {
               "kind": "Reference",
@@ -76571,7 +76607,7 @@
             },
             {
               "kind": "Content",
-              "text": " | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
+              "text": " | undefined;\n        VendorQueryChanged?: string | undefined;\n    }>;\n    innerCssClasses: import(\"vue\")."
             },
             {
               "kind": "Reference",
@@ -76742,7 +76778,7 @@
           "name": "SimpleFilter",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 284
+            "endIndex": 288
           }
         },
         {
@@ -79966,6 +80002,24 @@
               "text": "WireMetadata",
               "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
             },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        VendorResultMounted: (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        UserViewedAVendorResult: (payload: import(\"..\")."
@@ -80047,6 +80101,24 @@
               "text": "WireMetadata",
               "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
             },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        VendorBannerMounted: (payload: import(\"..\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "VendorBanner",
+              "canonicalReference": "@empathyco/x-components!VendorBanner:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
             {
               "kind": "Content",
               "text": ") => unknown;\n        UserViewedAVendorBanner: (payload: import(\"..\")."
@@ -80083,6 +80155,15 @@
               "text": "WireMetadata",
               "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
             },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        VendorQueryChanged: (payload: string, metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
             {
               "kind": "Content",
               "text": ") => unknown;\n    }>>;\n}, {}, {}, {}, import(\"vue\")."
@@ -80157,7 +80238,7 @@
           "name": "SnippetCallbacks",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 604
+            "endIndex": 614
           }
         },
         {
@@ -90274,7 +90355,44 @@
           "releaseTag": "Public",
           "name": "VendorActions",
           "preserveMemberOrder": false,
-          "members": [],
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorActions#setUrlParams:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setUrlParams: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(urlParams: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "UrlParams",
+                  "canonicalReference": "@empathyco/x-components!UrlParams:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ") => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "setUrlParams",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            }
+          ],
           "extendsTokenRanges": []
         },
         {
@@ -90639,6 +90757,33 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorBannerTagging#mountedUrl:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "mountedUrl: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "mountedUrl",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!VendorBannerTagging#viewUrl:member",
@@ -90683,7 +90828,35 @@
           "releaseTag": "Public",
           "name": "VendorGetters",
           "preserveMemberOrder": false,
-          "members": [],
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorGetters#query:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "query: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "query",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
           "extendsTokenRanges": []
         },
         {
@@ -90693,7 +90866,16 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface VendorMutations "
+              "text": "export interface VendorMutations extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryMutations",
+              "canonicalReference": "@empathyco/x-components!QueryMutations:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
             }
           ],
           "fileUrlPath": "src/x-modules/vendor/store/types.ts",
@@ -90701,6 +90883,33 @@
           "name": "VendorMutations",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorMutations#resetState:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "resetState: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "() => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "resetState",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!VendorMutations#setBanners:member",
@@ -90737,6 +90946,42 @@
                 "endIndex": 4
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorMutations#setRelatedTags:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setRelatedTags: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(relatedTags: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RelatedTag",
+                  "canonicalReference": "@empathyco/x-components!RelatedTag_2:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]) => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "setRelatedTags",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!VendorMutations#setResults:member",
@@ -90774,7 +91019,12 @@
               }
             }
           ],
-          "extendsTokenRanges": []
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
         },
         {
           "kind": "Interface",
@@ -91165,6 +91415,33 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorResultTagging#mountedUrl:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "mountedUrl: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "mountedUrl",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!VendorResultTagging#viewUrl:member",
@@ -91202,7 +91479,16 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface VendorState "
+              "text": "export interface VendorState extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryState",
+              "canonicalReference": "@empathyco/x-components!QueryState:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
             }
           ],
           "fileUrlPath": "src/x-modules/vendor/store/types.ts",
@@ -91242,6 +91528,38 @@
                 "endIndex": 3
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorState#relatedTags:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "relatedTags: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RelatedTag",
+                  "canonicalReference": "@empathyco/x-components!RelatedTag_2:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "relatedTags",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!VendorState#results:member",
@@ -91275,7 +91593,12 @@
               }
             }
           ],
-          "extendsTokenRanges": []
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            }
+          ]
         },
         {
           "kind": "Interface",
@@ -91432,6 +91755,34 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorXEvents#VendorBannerMounted:member",
+              "docComment": "/**\n * A vendor banner has been inserted in the DOM. Payload: The {@link VendorBanner | vendor banner} that was mounted.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "VendorBannerMounted: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "VendorBanner",
+                  "canonicalReference": "@empathyco/x-components!VendorBanner:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "VendorBannerMounted",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!VendorXEvents#VendorBannersChanged:member",
@@ -91473,6 +91824,61 @@
                 "endIndex": 5
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorXEvents#VendorQueryChanged:member",
+              "docComment": "/**\n * The vendor module query has changed. Payload: The new vendor query string.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "VendorQueryChanged: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "VendorQueryChanged",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!VendorXEvents#VendorResultMounted:member",
+              "docComment": "/**\n * A vendor result has been inserted in the DOM. Payload: The {@link VendorResult | vendor result} that was mounted.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "VendorResultMounted: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "VendorResult",
+                  "canonicalReference": "@empathyco/x-components!VendorResult:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "VendorResultMounted",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!VendorXEvents#VendorResultsChanged:member",