chore: fix docs for build

empathyco · Oct 18, 2023 · 22e2257 · 22e2257
1 parent 0aebab8
commit 22e2257
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 11 deletions.
diff --git a/packages/x-components/src/x-modules/facets/store/types.ts b/packages/x-components/src/x-modules/facets/store/types.ts
@@ -1,6 +1,7 @@
 import { Facet, Filter, RawFilter } from '@empathyco/x-types';
 import { XActionContext, XStoreModule } from '../../../store';
 import { ConfigMutations } from '../../../store/utils/config-store.utils';
+import { QueryMutations } from '../../../store/utils/query.utils';
 
 /**
  * Facets store state.
@@ -53,7 +54,7 @@ export interface FacetsGetters {
  *
  * @public
  */
-export interface FacetsMutations extends ConfigMutations<FacetsState> {
+export interface FacetsMutations extends QueryMutations, ConfigMutations<FacetsState> {
   /**
    * Updates the state of a filter.
    *
@@ -92,12 +93,6 @@ export interface FacetsMutations extends ConfigMutations<FacetsState> {
    * @param filters - The filters to add.
    */
   setPreselectedFilters(filters: RawFilter[]): void;
-  /**
-   * Sets the {@link FacetsState.query} property.
-   *
-   * @param query - The new {@link FacetsState.query}.
-   */
-  setQuery(query: string): void;
   /**
    * Removes the facet from the {@link FacetsState.facets | facets} record.
    *

diff --git a/packages/x-components/src/x-modules/history-queries/store/types.ts b/packages/x-components/src/x-modules/history-queries/store/types.ts
@@ -40,7 +40,7 @@ export interface HistoryQueriesState extends QueryState {
 export interface HistoryQueriesGetters {
   /**
    * A sub-set of the {@link HistoryQueriesState.historyQueries}. If the
-   * {@link HistoryQueriesState.query} property is not empty, this list will only contain
+   * query property is not empty, this list will only contain
    * suggestions whose query matches with it.
    */
   historyQueries: HistoryQuery[];

diff --git a/packages/x-components/src/x-modules/identifier-results/wiring.ts b/packages/x-components/src/x-modules/identifier-results/wiring.ts
@@ -64,7 +64,7 @@ export const clearIdentifierResultsQuery = wireCommit('setQuery', '');
 const setUrlParams = wireDispatch('saveQuery', ({ eventPayload: { query } }) => query);
 
 /**
- * Requests and stores a new set of identifier results for the {@link IdentifierResultsState.query}.
+ * Requests and stores a new set of identifier results for the query.
  *
  * @public
  */

diff --git a/packages/x-components/src/x-modules/query-suggestions/wiring.ts b/packages/x-components/src/x-modules/query-suggestions/wiring.ts
@@ -84,7 +84,7 @@ export const clearQuerySuggestionsQuery = wireCommit('setQuery', '');
 const setUrlParams = wireDispatch('setUrlParams');
 
 /**
- * Requests and stores a new set of query suggestions for the {@link QuerySuggestionsState.query}.
+ * Requests and stores a new set of query suggestions for the query.
  *
  * @public
  */

diff --git a/packages/x-components/src/x-modules/search/store/getters/query.getter.ts b/packages/x-components/src/x-modules/search/store/getters/query.getter.ts
@@ -2,7 +2,7 @@ import { createRelatedTagsQueryGetter } from '../../../../store/utils/query.util
 import { SearchXStoreModule } from '../types';
 
 /**
- * Default implementation for the {@link SearchState.query} getter.
+ * Default implementation for the search query getter.
  *
  * @param state - Current {@link https://vuex.vuejs.org/guide/state.html | state} of the related
  * tags' module.