@empathyco/x-components 7.3.0 → 7.4.0

package/report/x-components.api.json

@@ -13854,6 +13854,55 @@
               "isAbstract": false,
               "name": "addProductToCart"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@empathyco/x-components!BaseXAPI#browse:member(1)",
+              "docComment": "/**\n * Browses the browseField and browseValue parameters as a selected category.\n *\n * @param browseCategory - browseField and browseValue to be browsed.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "browse(browseCategory?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BrowsableRequest",
+                  "canonicalReference": "@empathyco/x-components!BrowsableRequest:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "browseCategory",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "browse"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@empathyco/x-components!BaseXAPI#close:member(1)",
@@ -33926,7 +33975,52 @@
             },
             {
               "kind": "Content",
-              "text": " | undefined;\n        UserClickedAbortARedirection?: void | undefined;\n        UserSelectedAPage?: number | undefined;\n        SemanticQueryRequestUpdated?: import(\"@empathyco/x-types\")."
+              "text": " | undefined;\n        UserClickedAbortARedirection?: void | undefined;\n        UserSelectedAPage?: number | undefined;\n        BrowseRequestChanged?: import(\"../../../browse\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "InternalBrowseRequest",
+              "canonicalReference": "@empathyco/x-components!~InternalBrowseRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | null | undefined;\n        BrowseRequestUpdated?: import(\"../../../browse\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "InternalBrowseRequest",
+              "canonicalReference": "@empathyco/x-components!~InternalBrowseRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | null | undefined;\n        BrowseResponseChanged?: import(\"../../../browse\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "InternalBrowseResponse",
+              "canonicalReference": "@empathyco/x-components!~InternalBrowseResponse:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        BrowseTaggingChanged?: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "TaggingRequest",
+              "canonicalReference": "@empathyco/x-components!TaggingRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        UserClickedABrowseSort?: string | undefined;\n        SelectedBrowseSortProvided?: string | undefined;\n        UserBrowsedToCategory?: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "BrowsableRequest",
+              "canonicalReference": "@empathyco/x-components!BrowsableRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        SemanticQueryRequestUpdated?: import(\"@empathyco/x-types\")."
             },
             {
               "kind": "Reference",
@@ -34403,7 +34497,7 @@
           "name": "HierarchicalFilter",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 286
+            "endIndex": 296
           }
         },
         {
@@ -59604,6 +59698,34 @@
             "endIndex": 3
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!resetNextQueriesQuery:var",
+          "docComment": "/**\n * Reset the next queries state `query`.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "resetNextQueriesQuery: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"../..\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "AnyWire",
+              "canonicalReference": "@empathyco/x-components!AnyWire:type"
+            }
+          ],
+          "fileUrlPath": "src/x-modules/next-queries/wiring.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "resetNextQueriesQuery",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@empathyco/x-components!resetNextQueriesWire:var",
@@ -59813,6 +59935,34 @@
             "endIndex": 6
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!resetUrlBrowseCategory:var",
+          "docComment": "/**\n * Sets the browseCategory of the url module.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "resetUrlBrowseCategory: "
+            },
+            {
+              "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": "resetUrlBrowseCategory",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@empathyco/x-components!ResultFeature:type",
@@ -70974,6 +71124,47 @@
             "endIndex": 4
           }
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!setUrlBrowseCategory:var",
+          "docComment": "/**\n * Sets the browseCategory of the url module.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "setUrlBrowseCategory: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"../..\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "Wire",
+              "canonicalReference": "@empathyco/x-components!Wire:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "BrowsableRequest",
+              "canonicalReference": "@empathyco/x-components!BrowsableRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            }
+          ],
+          "fileUrlPath": "src/x-modules/url/wiring.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "setUrlBrowseCategory",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 6
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@empathyco/x-components!setUrlFilters:var",
@@ -72158,7 +72349,52 @@
             },
             {
               "kind": "Content",
-              "text": " | undefined;\n        UserClickedAbortARedirection?: void | undefined;\n        UserSelectedAPage?: number | undefined;\n        SemanticQueryRequestUpdated?: import(\"@empathyco/x-types\")."
+              "text": " | undefined;\n        UserClickedAbortARedirection?: void | undefined;\n        UserSelectedAPage?: number | undefined;\n        BrowseRequestChanged?: import(\"../../../browse\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "InternalBrowseRequest",
+              "canonicalReference": "@empathyco/x-components!~InternalBrowseRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | null | undefined;\n        BrowseRequestUpdated?: import(\"../../../browse\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "InternalBrowseRequest",
+              "canonicalReference": "@empathyco/x-components!~InternalBrowseRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | null | undefined;\n        BrowseResponseChanged?: import(\"../../../browse\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "InternalBrowseResponse",
+              "canonicalReference": "@empathyco/x-components!~InternalBrowseResponse:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        BrowseTaggingChanged?: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "TaggingRequest",
+              "canonicalReference": "@empathyco/x-components!TaggingRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        UserClickedABrowseSort?: string | undefined;\n        SelectedBrowseSortProvided?: string | undefined;\n        UserBrowsedToCategory?: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "BrowsableRequest",
+              "canonicalReference": "@empathyco/x-components!BrowsableRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | undefined;\n        SemanticQueryRequestUpdated?: import(\"@empathyco/x-types\")."
             },
             {
               "kind": "Reference",
@@ -72536,7 +72772,7 @@
           "name": "SimpleFilter",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 254
+            "endIndex": 264
           }
         },
         {
@@ -75103,6 +75339,114 @@
               "text": "WireMetadata",
               "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
             },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        BrowseRequestChanged: (payload: import(\"../x-modules/browse\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "InternalBrowseRequest",
+              "canonicalReference": "@empathyco/x-components!~InternalBrowseRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | null, metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        BrowseRequestUpdated: (payload: import(\"../x-modules/browse\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "InternalBrowseRequest",
+              "canonicalReference": "@empathyco/x-components!~InternalBrowseRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " | null, metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        BrowseResponseChanged: (payload: import(\"../x-modules/browse\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "InternalBrowseResponse",
+              "canonicalReference": "@empathyco/x-components!~InternalBrowseResponse:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        BrowseTaggingChanged: (payload: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "TaggingRequest",
+              "canonicalReference": "@empathyco/x-components!TaggingRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        UserClickedABrowseSort: (payload: string, metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        SelectedBrowseSortProvided: (payload: string, metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ") => unknown;\n        UserBrowsedToCategory: (payload: import(\"@empathyco/x-types\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "BrowsableRequest",
+              "canonicalReference": "@empathyco/x-components!BrowsableRequest:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", metadata: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WireMetadata",
+              "canonicalReference": "@empathyco/x-components!WireMetadata:interface"
+            },
             {
               "kind": "Content",
               "text": ") => unknown;\n        SemanticQueryRequestUpdated: (payload: import(\"@empathyco/x-types\")."
@@ -75681,7 +76025,7 @@
           "name": "SnippetCallbacks",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 544
+            "endIndex": 568
           }
         },
         {
@@ -81214,6 +81558,42 @@
           "name": "UrlMutations",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!UrlMutations#setBrowseCategory:member",
+              "docComment": "/**\n * Sets the new browseCategory.\n *\n * @param sort - The new browseCategory of the url.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setBrowseCategory: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(browseCategory: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BrowsableRequest",
+                  "canonicalReference": "@empathyco/x-components!BrowsableRequest:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ") => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "setBrowseCategory",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!UrlMutations#setFilters:member",
@@ -81582,6 +81962,60 @@
                 }
               ]
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!UrlParams#browseField:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "browseField: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "browseField",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!UrlParams#browseValue:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "browseValue: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "browseValue",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!UrlParams#filter:member",
@@ -82338,6 +82772,33 @@
           "name": "UseAliasAPI",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!UseAliasAPI#browseTotalResults:member",
+              "docComment": "/**\n * The {@link BrowseXModule} total results.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly browseTotalResults: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "browseTotalResults",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!UseAliasAPI#device:member",
@@ -87345,6 +87806,42 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!XAPI#browse:member",
+              "docComment": "/**\n * Dispatch a browse with the browseCategory parameter.\n *\n * @param browseCategory - browseField and browseValue to be searched.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "browse: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(browseCategory?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BrowsableRequest",
+                  "canonicalReference": "@empathyco/x-components!BrowsableRequest:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ") => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "browse",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!XAPI#getSnippetConfig:member",
@@ -89743,6 +90240,15 @@
               "kind": "Content",
               "text": ", "
             },
+            {
+              "kind": "Reference",
+              "text": "BrowseXEvents",
+              "canonicalReference": "@empathyco/x-components!~BrowseXEvents:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
             {
               "kind": "Reference",
               "text": "SemanticQueriesXEvents",
@@ -90746,6 +91252,10 @@
             {
               "startIndex": 41,
               "endIndex": 42
+            },
+            {
+              "startIndex": 43,
+              "endIndex": 44
             }
           ]
         },
@@ -91550,6 +92060,34 @@
                 "endIndex": 2
               }
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!XModulesTree#browse:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "browse: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BrowseXModule",
+                  "canonicalReference": "@empathyco/x-components!~BrowseXModule:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "browse",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!XModulesTree#device:member",