@empathyco/x-components 3.0.0-alpha.65 → 3.0.0-alpha.68

package/report/x-components.api.json

@@ -19633,7 +19633,16 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface HistoryQueriesMutations "
+              "text": "export interface HistoryQueriesMutations extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryMutations",
+              "canonicalReference": "@empathyco/x-components!QueryMutations:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
             }
           ],
           "releaseTag": "Public",
@@ -19777,7 +19786,12 @@
               "name": "setSessionTimeStamp"
             }
           ],
-          "extendsTokenRanges": []
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 3
+            }
+          ]
         },
         {
           "kind": "Interface",
@@ -19786,7 +19800,16 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface HistoryQueriesState "
+              "text": "export interface HistoryQueriesState extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryState",
+              "canonicalReference": "@empathyco/x-components!QueryState:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
             }
           ],
           "releaseTag": "Public",
@@ -19903,7 +19926,12 @@
               }
             }
           ],
-          "extendsTokenRanges": []
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 3
+            }
+          ]
         },
         {
           "kind": "Interface",
@@ -21187,6 +21215,15 @@
               "text": "StatusMutations",
               "canonicalReference": "@empathyco/x-components!StatusMutations:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryMutations",
+              "canonicalReference": "@empathyco/x-components!QueryMutations:interface"
+            },
             {
               "kind": "Content",
               "text": " "
@@ -21390,7 +21427,11 @@
           "extendsTokenRanges": [
             {
               "startIndex": 1,
-              "endIndex": 3
+              "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 5
             }
           ]
         },
@@ -21434,6 +21475,15 @@
               "text": "StatusState",
               "canonicalReference": "@empathyco/x-components!StatusState:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryState",
+              "canonicalReference": "@empathyco/x-components!QueryState:interface"
+            },
             {
               "kind": "Content",
               "text": " "
@@ -21592,7 +21642,11 @@
           "extendsTokenRanges": [
             {
               "startIndex": 1,
-              "endIndex": 3
+              "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 5
             }
           ]
         },
@@ -26243,6 +26297,15 @@
               "text": "StatusMutations",
               "canonicalReference": "@empathyco/x-components!StatusMutations:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryMutations",
+              "canonicalReference": "@empathyco/x-components!QueryMutations:interface"
+            },
             {
               "kind": "Content",
               "text": " "
@@ -26446,7 +26509,11 @@
           "extendsTokenRanges": [
             {
               "startIndex": 1,
-              "endIndex": 3
+              "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 5
             }
           ]
         },
@@ -26490,6 +26557,15 @@
               "text": "StatusState",
               "canonicalReference": "@empathyco/x-components!StatusState:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryState",
+              "canonicalReference": "@empathyco/x-components!QueryState:interface"
+            },
             {
               "kind": "Content",
               "text": " "
@@ -26648,7 +26724,11 @@
           "extendsTokenRanges": [
             {
               "startIndex": 1,
-              "endIndex": 3
+              "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 5
             }
           ]
         },
@@ -30311,6 +30391,15 @@
               "text": "StatusMutations",
               "canonicalReference": "@empathyco/x-components!StatusMutations:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryMutations",
+              "canonicalReference": "@empathyco/x-components!QueryMutations:interface"
+            },
             {
               "kind": "Content",
               "text": " "
@@ -30465,7 +30554,11 @@
           "extendsTokenRanges": [
             {
               "startIndex": 1,
-              "endIndex": 3
+              "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 5
             }
           ]
         },
@@ -30509,6 +30602,15 @@
               "text": "StatusState",
               "canonicalReference": "@empathyco/x-components!StatusState:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryState",
+              "canonicalReference": "@empathyco/x-components!QueryState:interface"
+            },
             {
               "kind": "Content",
               "text": " "
@@ -30636,7 +30738,11 @@
           "extendsTokenRanges": [
             {
               "startIndex": 1,
-              "endIndex": 3
+              "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 5
             }
           ]
         },
@@ -32950,6 +33056,32 @@
           "releaseTag": "Public",
           "name": "RelatedTagsGetters",
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!RelatedTagsGetters#query:member",
+              "docComment": "/**\n * The combination of the query and the selected related tags.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "query: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "query",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!RelatedTagsGetters#relatedTags:member",
@@ -33029,6 +33161,15 @@
               "text": "StatusMutations",
               "canonicalReference": "@empathyco/x-components!StatusMutations:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryMutations",
+              "canonicalReference": "@empathyco/x-components!QueryMutations:interface"
+            },
             {
               "kind": "Content",
               "text": " "
@@ -33086,50 +33227,6 @@
               ],
               "name": "setParams"
             },
-            {
-              "kind": "MethodSignature",
-              "canonicalReference": "@empathyco/x-components!RelatedTagsMutations#setQuery:member(1)",
-              "docComment": "/**\n * Sets the query of the module, which is used to retrieve the related tags.\n *\n * @param newQuery - The new query to save to the state.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "setQuery(newQuery: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": "): "
-                },
-                {
-                  "kind": "Content",
-                  "text": "void"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": false,
-              "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 4
-              },
-              "releaseTag": "Public",
-              "overloadIndex": 1,
-              "parameters": [
-                {
-                  "parameterName": "newQuery",
-                  "parameterTypeTokenRange": {
-                    "startIndex": 1,
-                    "endIndex": 2
-                  }
-                }
-              ],
-              "name": "setQuery"
-            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@empathyco/x-components!RelatedTagsMutations#setRelatedTags:member(1)",
@@ -33232,14 +33329,44 @@
           "extendsTokenRanges": [
             {
               "startIndex": 1,
-              "endIndex": 3
+              "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 5
             }
           ]
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!relatedTagsQuery:var",
+          "docComment": "/**\n * Default implementation for the {@link RelatedTagsGetters.query} getter.\n *\n * @param state - Current {@link https://vuex.vuejs.org/guide/state.html | state} of the related tags' module.\n *\n * @returns The query with the selected related tags concatenated.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "query: "
+            },
+            {
+              "kind": "Reference",
+              "text": "RelatedTagsXStoreModule",
+              "canonicalReference": "@empathyco/x-components!RelatedTagsXStoreModule:type"
+            },
+            {
+              "kind": "Content",
+              "text": "['getters']['query']"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "relatedTagsQuery",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@empathyco/x-components!relatedTagsRequest:var",
-          "docComment": "/**\n * Default implementation for the {@link RelatedTagsGetters.request} getter.\n *\n * @param state - Current {@link https://vuex.vuejs.org/guide/state.html | state} of the related tags module.\n *\n * @returns The related tags request to fetch data from the API.\n *\n * @public\n */\n",
+          "docComment": "/**\n * Default implementation for the {@link RelatedTagsGetters.request} getter.\n *\n * @param state - Current {@link https://vuex.vuejs.org/guide/state.html | state} of the related tags module.\n *\n * @param getters - Current {@link https://vuex.vuejs.org/guide/getters.html | getters} of the related tags module.\n *\n * @returns The related tags request to fetch data from the API.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -33276,6 +33403,15 @@
               "text": "StatusState",
               "canonicalReference": "@empathyco/x-components!StatusState:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryState",
+              "canonicalReference": "@empathyco/x-components!QueryState:interface"
+            },
             {
               "kind": "Content",
               "text": " "
@@ -33342,32 +33478,6 @@
                 "endIndex": 3
               }
             },
-            {
-              "kind": "PropertySignature",
-              "canonicalReference": "@empathyco/x-components!RelatedTagsState#query:member",
-              "docComment": "/**\n * The internal query of the module. Used to request the related tags.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "query: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "string"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "query",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              }
-            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!RelatedTagsState#relatedTags:member",
@@ -33434,7 +33544,11 @@
           "extendsTokenRanges": [
             {
               "startIndex": 1,
-              "endIndex": 3
+              "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 5
             }
           ]
         },
@@ -36498,7 +36612,16 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface SearchBoxMutations "
+              "text": "export interface SearchBoxMutations extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryMutations",
+              "canonicalReference": "@empathyco/x-components!QueryMutations:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
             }
           ],
           "releaseTag": "Public",
@@ -36549,7 +36672,12 @@
               "name": "setQuery"
             }
           ],
-          "extendsTokenRanges": []
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 3
+            }
+          ]
         },
         {
           "kind": "Interface",
@@ -36558,7 +36686,16 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface SearchBoxState "
+              "text": "export interface SearchBoxState extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryState",
+              "canonicalReference": "@empathyco/x-components!QueryState:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
             }
           ],
           "releaseTag": "Public",
@@ -36591,7 +36728,12 @@
               }
             }
           ],
-          "extendsTokenRanges": []
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 3
+            }
+          ]
         },
         {
           "kind": "Interface",
@@ -37191,6 +37333,32 @@
           "releaseTag": "Public",
           "name": "SearchGetters",
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!SearchGetters#query:member",
+              "docComment": "/**\n * The combination of the query and the selected related tags.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "query: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "query",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "@empathyco/x-components!SearchGetters#request:member",
@@ -37598,6 +37766,15 @@
               "text": "StatusMutations",
               "canonicalReference": "@empathyco/x-components!StatusMutations:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryMutations",
+              "canonicalReference": "@empathyco/x-components!QueryMutations:interface"
+            },
             {
               "kind": "Content",
               "text": " "
@@ -38503,10 +38680,40 @@
           "extendsTokenRanges": [
             {
               "startIndex": 1,
-              "endIndex": 3
+              "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 5
             }
           ]
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@empathyco/x-components!searchQuery:var",
+          "docComment": "/**\n * Default implementation for the {@link SearchState.query} getter.\n *\n * @param state - Current {@link https://vuex.vuejs.org/guide/state.html | state} of the related tags' module.\n *\n * @returns The query with the selected related tags concatenated.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "query: "
+            },
+            {
+              "kind": "Reference",
+              "text": "SearchXStoreModule",
+              "canonicalReference": "@empathyco/x-components!SearchXStoreModule:type"
+            },
+            {
+              "kind": "Content",
+              "text": "['getters']['query']"
+            }
+          ],
+          "releaseTag": "Public",
+          "name": "searchQuery",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 3
+          }
+        },
         {
           "kind": "Variable",
           "canonicalReference": "@empathyco/x-components!searchRequest:var",
@@ -38547,6 +38754,15 @@
               "text": "StatusState",
               "canonicalReference": "@empathyco/x-components!StatusState:interface"
             },
+            {
+              "kind": "Content",
+              "text": ", "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryState",
+              "canonicalReference": "@empathyco/x-components!QueryState:interface"
+            },
             {
               "kind": "Content",
               "text": " "
@@ -39089,7 +39305,11 @@
           "extendsTokenRanges": [
             {
               "startIndex": 1,
-              "endIndex": 3
+              "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 5
             }
           ]
         },
@@ -45564,7 +45784,7 @@
             {
               "kind": "Reference",
               "text": "UrlState",
-              "canonicalReference": "@empathyco/x-components!UrlState:type"
+              "canonicalReference": "@empathyco/x-components!UrlState:interface"
             },
             {
               "kind": "Content",
@@ -45856,7 +46076,16 @@
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface UrlMutations "
+              "text": "export interface UrlMutations extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "QueryMutations",
+              "canonicalReference": "@empathyco/x-components!QueryMutations:interface"
+            },
+            {
+              "kind": "Content",
+              "text": " "
             }
           ],
           "releaseTag": "Public",
@@ -46244,7 +46473,12 @@
               "name": "setSort"
             }
           ],
-          "extendsTokenRanges": []
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 3
+            }
+          ]
         },
         {
           "kind": "TypeAlias",
@@ -46534,43 +46768,78 @@
           }
         },
         {
-          "kind": "TypeAlias",
-          "canonicalReference": "@empathyco/x-components!UrlState:type",
+          "kind": "Interface",
+          "canonicalReference": "@empathyco/x-components!UrlState:interface",
           "docComment": "/**\n * URL store state.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export declare type UrlState = "
+              "text": "export interface UrlState extends "
             },
             {
               "kind": "Reference",
-              "text": "UrlParams",
-              "canonicalReference": "@empathyco/x-components!UrlParams:interface"
+              "text": "QueryState",
+              "canonicalReference": "@empathyco/x-components!QueryState:interface"
             },
             {
               "kind": "Content",
-              "text": " & {\n    initialExtraParams: "
+              "text": ", "
             },
             {
               "kind": "Reference",
-              "text": "Dictionary",
-              "canonicalReference": "@empathyco/x-components!Dictionary:type"
-            },
-            {
-              "kind": "Content",
-              "text": "<unknown>;\n}"
+              "text": "UrlParams",
+              "canonicalReference": "@empathyco/x-components!UrlParams:interface"
             },
             {
               "kind": "Content",
-              "text": ";"
+              "text": " "
             }
           ],
           "releaseTag": "Public",
           "name": "UrlState",
-          "typeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 5
-          }
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@empathyco/x-components!UrlState#initialExtraParams:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "initialExtraParams: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Dictionary",
+                  "canonicalReference": "@empathyco/x-components!Dictionary:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<unknown>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "initialExtraParams",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            }
+          ],
+          "extendsTokenRanges": [
+            {
+              "startIndex": 1,
+              "endIndex": 2
+            },
+            {
+              "startIndex": 3,
+              "endIndex": 5
+            }
+          ]
         },
         {
           "kind": "Interface",
@@ -46782,7 +47051,7 @@
             {
               "kind": "Reference",
               "text": "UrlState",
-              "canonicalReference": "@empathyco/x-components!UrlState:type"
+              "canonicalReference": "@empathyco/x-components!UrlState:interface"
             },
             {
               "kind": "Content",