@empathyco/x-components 3.0.0-alpha.146 → 3.0.0-alpha.149

package/report/x-components.api.json

@@ -13794,6 +13794,51 @@
           "releaseTag": "Public",
           "name": "FacetsMutations",
           "members": [
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@empathyco/x-components!FacetsMutations#mutateFilter:member(1)",
+              "docComment": "/**\n * Updates the state of a filter.\n *\n * @param payload - An object containing the filter to update, and the properties to modify.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "mutateFilter(payload: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "MutateFilterPayload",
+                  "canonicalReference": "@empathyco/x-components!MutateFilterPayload:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "payload",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                }
+              ],
+              "name": "mutateFilter"
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@empathyco/x-components!FacetsMutations#removeFacet:member(1)",
@@ -14023,51 +14068,6 @@
               ],
               "name": "setFacetGroup"
             },
-            {
-              "kind": "MethodSignature",
-              "canonicalReference": "@empathyco/x-components!FacetsMutations#setFilter:member(1)",
-              "docComment": "/**\n * Adds the filter to the {@link FacetsState.filters | filters} record.\n *\n * @param filter - The filter to add.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "setFilter(filter: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Filter",
-                  "canonicalReference": "@empathyco/x-components!Filter:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": false,
-              "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "filter",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  }
-                }
-              ],
-              "name": "setFilter"
-            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@empathyco/x-components!FacetsMutations#setFilters:member(1)",
@@ -17771,6 +17771,59 @@
           },
           "implementsTokenRanges": []
         },
+        {
+          "kind": "Function",
+          "canonicalReference": "@empathyco/x-components!flatHierarchicalFilters:function(1)",
+          "docComment": "/**\n * This function flattens the Hierarchical Filters, returning an array with all filters including the children.\n *\n * @param hierarchicalFilters - The list of Hierarchical Filters to flatten.\n *\n * @returns An array with all the Hierarchical filters.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export declare function flatHierarchicalFilters(hierarchicalFilters: "
+            },
+            {
+              "kind": "Reference",
+              "text": "HierarchicalFilter",
+              "canonicalReference": "@empathyco/x-components!HierarchicalFilter:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[]"
+            },
+            {
+              "kind": "Content",
+              "text": "): "
+            },
+            {
+              "kind": "Reference",
+              "text": "HierarchicalFilter",
+              "canonicalReference": "@empathyco/x-components!HierarchicalFilter:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "[]"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "returnTypeTokenRange": {
+            "startIndex": 4,
+            "endIndex": 6
+          },
+          "releaseTag": "Public",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "hierarchicalFilters",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            }
+          ],
+          "name": "flatHierarchicalFilters"
+        },
         {
           "kind": "Function",
           "canonicalReference": "@empathyco/x-components!getRootXComponent:function(1)",
@@ -24076,6 +24129,89 @@
           },
           "implementsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@empathyco/x-components!MutateFilterPayload:interface",
+          "docComment": "/**\n * Payload to use in the `mutateFilter` mutation.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface MutateFilterPayload "
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "MutateFilterPayload",
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!MutateFilterPayload#filter:member",
+              "docComment": "/**\n * The filter to modify. If it does not belong to the store it will be added.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "filter: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Filter",
+                  "canonicalReference": "@empathyco/x-components!Filter:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "filter",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!MutateFilterPayload#newFilterState:member",
+              "docComment": "/**\n * The new fields values to modify in the filter.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "newFilterState: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Partial",
+                  "canonicalReference": "!Partial:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Filter",
+                  "canonicalReference": "@empathyco/x-components!Filter:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "newFilterState",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@empathyco/x-components!MutationNamesFor:type",
@@ -26561,6 +26697,33 @@
               },
               "isStatic": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@empathyco/x-components!NextQueriesList#injectedQuery:member",
+              "docComment": "/**\n * Injected query, updated when the related request(s) have succeeded.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "injectedQuery: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "injectedQuery",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "@empathyco/x-components!NextQueriesList#maxGroups:member",
@@ -27638,6 +27801,161 @@
           },
           "implementsTokenRanges": []
         },
+        {
+          "kind": "Class",
+          "canonicalReference": "@empathyco/x-components!NextQueryPreview:class",
+          "docComment": "/**\n * Retrieves a preview of the results of a next query and exposes them in the default slot, along with the next query and the totalResults of the search request. By default, it renders the names of the results.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export default class NextQueryPreview extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "Vue",
+              "canonicalReference": "vue!Vue:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "NextQueryPreview",
+          "members": [
+            {
+              "kind": "Method",
+              "canonicalReference": "@empathyco/x-components!NextQueryPreview#mounted:member(1)",
+              "docComment": "/**\n * The component emits the NextQueryPreviewMounted event to retrieve the results preview of the next query.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "mounted(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [],
+              "name": "mounted"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@empathyco/x-components!NextQueryPreview#previewResults:member",
+              "docComment": "/**\n * The results preview of the next queries mounted. It is a dictionary, indexed by the next query query.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "previewResults: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Dictionary",
+                  "canonicalReference": "@empathyco/x-utils!Dictionary:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PreviewResults",
+                  "canonicalReference": "@empathyco/x-components!PreviewResults:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "previewResults",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              },
+              "isStatic": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@empathyco/x-components!NextQueryPreview#suggestion:member",
+              "docComment": "/**\n * The next query to retrieve the results preview.\n *\n * @public\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected suggestion: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "NextQuery",
+                  "canonicalReference": "@empathyco/x-components!NextQuery:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "suggestion",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@empathyco/x-components!NextQueryPreview#suggestionResults:member",
+              "docComment": "/**\n * Gets from the state the results preview of the next query.\n *\n * @returns The results preview of the actual next query.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get suggestionResults(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PreviewResults",
+                  "canonicalReference": "@empathyco/x-components!PreviewResults:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "suggestionResults",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          },
+          "implementsTokenRanges": []
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@empathyco/x-components!NiladicFunction:type",
@@ -35056,6 +35374,134 @@
                 "endIndex": 3
               },
               "isStatic": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@empathyco/x-components!ResultsList#providedQuery:member",
+              "docComment": "/**\n * It provides the search query. This query is updated only when the search request has succeeded.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "providedQuery: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "providedQuery",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@empathyco/x-components!ResultsList#searchQuery:member",
+              "docComment": "/**\n * The query of the search request, taken from the state.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "searchQuery: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "searchQuery",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@empathyco/x-components!ResultsList#searchStatus:member",
+              "docComment": "/**\n * The status of the search request, taken from the state.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "searchStatus: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RequestStatus",
+                  "canonicalReference": "@empathyco/x-components!RequestStatus:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "searchStatus",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@empathyco/x-components!ResultsList#updateQuery:member(1)",
+              "docComment": "/**\n * Updates the query to be provided to the child components when the search request has succeeded.\n *\n * @param status - The status of the search request.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "updateQuery(status: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RequestStatus",
+                  "canonicalReference": "@empathyco/x-components!RequestStatus:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "status",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  }
+                }
+              ],
+              "name": "updateQuery"
             }
           ],
           "extendsTokenRange": {