@empathyco/x-components 7.3.1 → 7.4.1

package/docs/API-reference/api/x-components.browsemutations.md

@@ -0,0 +1,458 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md)
+
+## BrowseMutations interface
+
+Browse store mutations.
+
+**Signature:**
+
+```typescript
+export interface BrowseMutations extends StatusMutations, ConfigMutations<BrowseState> 
+```
+**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- -->&lt;[BrowseState](./x-components.browsestate.md)<!-- -->&gt;
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[appendResults](./x-components.browsemutations.appendresults.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(results: Result\[\]) =&gt; void
+
+
+</td><td>
+
+Append the results to the results state.
+
+
+</td></tr>
+<tr><td>
+
+[resetState](./x-components.browsemutations.resetstate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; void
+
+
+</td><td>
+
+Resets the "resettable" part of the Browse state to the initial state. See the [BrowseXStoreModule](./x-components.browsexstoremodule.md) for details.
+
+
+</td></tr>
+<tr><td>
+
+[resetStateForReload](./x-components.browsemutations.resetstateforreload.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; void
+
+
+</td><td>
+
+Resets the "resettable" part of the Browse state like [BrowseMutations.resetState](./x-components.browsemutations.resetstate.md) but maintains the values required to perform the browse request again.
+
+
+</td></tr>
+<tr><td>
+
+[setBanners](./x-components.browsemutations.setbanners.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(banners: Banner\[\]) =&gt; void
+
+
+</td><td>
+
+Sets the banners of the module.
+
+
+</td></tr>
+<tr><td>
+
+[setBrowseTagging](./x-components.browsemutations.setbrowsetagging.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(browseTagging: TaggingRequest) =&gt; void
+
+
+</td><td>
+
+Sets the browse tagging of the module, which is used to track the query.
+
+
+</td></tr>
+<tr><td>
+
+[setDisplayBrowseTagging](./x-components.browsemutations.setdisplaybrowsetagging.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(displayBrowseTagging: TaggingRequest) =&gt; void
+
+
+</td><td>
+
+Sets the display tagging of the module.
+
+
+</td></tr>
+<tr><td>
+
+[setFacets](./x-components.browsemutations.setfacets.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(facets: Facet\[\]) =&gt; void
+
+
+</td><td>
+
+Sets the facets of the module.
+
+
+</td></tr>
+<tr><td>
+
+[setFromNoResultsWithFilters](./x-components.browsemutations.setfromnoresultswithfilters.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(fromNoResultsWithFilters: boolean) =&gt; void
+
+
+</td><td>
+
+Sets the `fromNoResultsWithFilters` flag value.
+
+
+</td></tr>
+<tr><td>
+
+[setIsAppendResults](./x-components.browsemutations.setisappendresults.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(isAppendResults: boolean) =&gt; void
+
+
+</td><td>
+
+Set the `isAppendResuls` flag value.
+
+
+</td></tr>
+<tr><td>
+
+[setIsNoResults](./x-components.browsemutations.setisnoresults.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(isNoResults: boolean) =&gt; void
+
+
+</td><td>
+
+Sets the `isNoResults` flag value.
+
+
+</td></tr>
+<tr><td>
+
+[setOrigin](./x-components.browsemutations.setorigin.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(origin: [QueryOrigin](./x-components.queryorigin.md) \| undefined \| null) =&gt; void
+
+
+</td><td>
+
+Sets the origin of the module.
+
+
+</td></tr>
+<tr><td>
+
+[setPage](./x-components.browsemutations.setpage.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(page: number) =&gt; void
+
+
+</td><td>
+
+Sets the page of the module.
+
+
+</td></tr>
+<tr><td>
+
+[setParams](./x-components.browsemutations.setparams.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(params: Dictionary&lt;unknown&gt;) =&gt; void
+
+
+</td><td>
+
+Sets the extra params of the module.
+
+
+</td></tr>
+<tr><td>
+
+[setPromoteds](./x-components.browsemutations.setpromoteds.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(promoteds: Promoted\[\]) =&gt; void
+
+
+</td><td>
+
+Sets the promoteds of the module.
+
+
+</td></tr>
+<tr><td>
+
+[setResults](./x-components.browsemutations.setresults.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(results: Result\[\]) =&gt; void
+
+
+</td><td>
+
+Sets the results of the module.
+
+
+</td></tr>
+<tr><td>
+
+[setSelectedCategory](./x-components.browsemutations.setselectedcategory.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(selectedCategory: BrowsableRequest) =&gt; void
+
+
+</td><td>
+
+Sets the selected category of the module.
+
+
+</td></tr>
+<tr><td>
+
+[setSelectedFilters](./x-components.browsemutations.setselectedfilters.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(selectedFilters: Filter\[\]) =&gt; void
+
+
+</td><td>
+
+Sets the selected filters of the module.
+
+
+</td></tr>
+<tr><td>
+
+[setSort](./x-components.browsemutations.setsort.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(sort: Sort) =&gt; void
+
+
+</td><td>
+
+Sets the selected sort option of the module.
+
+
+</td></tr>
+<tr><td>
+
+[setStats](./x-components.browsemutations.setstats.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(stats: Stats) =&gt; void
+
+
+</td><td>
+
+Sets the stats of the module.
+
+
+</td></tr>
+<tr><td>
+
+[setTotalResults](./x-components.browsemutations.settotalresults.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(totalResults: number) =&gt; void
+
+
+</td><td>
+
+Sets the total results of the module.
+
+
+</td></tr>
+<tr><td>
+
+[updateResult](./x-components.browsemutations.updateresult.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(result: Partial&lt;Result&gt; &amp; Pick&lt;Result, 'id'&gt;) =&gt; void
+
+
+</td><td>
+
+Updates a result with new fields.
+
+
+</td></tr>
+<tr><td>
+
+[updateResultsFromEnrichment](./x-components.browsemutations.updateresultsfromenrichment.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(enrichmentResults: any\[\]) =&gt; void
+
+
+</td><td>
+
+Updates the results with the enrichment results.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/API-reference/api/x-components.browsemutations.resetstate.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [resetState](./x-components.browsemutations.resetstate.md)
+
+## BrowseMutations.resetState property
+
+Resets the "resettable" part of the Browse state to the initial state. See the [BrowseXStoreModule](./x-components.browsexstoremodule.md) for details.
+
+**Signature:**
+
+```typescript
+resetState: () => void;
+```

package/docs/API-reference/api/x-components.browsemutations.resetstateforreload.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [resetStateForReload](./x-components.browsemutations.resetstateforreload.md)
+
+## BrowseMutations.resetStateForReload property
+
+Resets the "resettable" part of the Browse state like [BrowseMutations.resetState](./x-components.browsemutations.resetstate.md) but maintains the values required to perform the browse request again.
+
+**Signature:**
+
+```typescript
+resetStateForReload: () => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setbanners.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setBanners](./x-components.browsemutations.setbanners.md)
+
+## BrowseMutations.setBanners property
+
+Sets the banners of the module.
+
+**Signature:**
+
+```typescript
+setBanners: (banners: Banner[]) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setbrowsetagging.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setBrowseTagging](./x-components.browsemutations.setbrowsetagging.md)
+
+## BrowseMutations.setBrowseTagging property
+
+Sets the browse tagging of the module, which is used to track the query.
+
+**Signature:**
+
+```typescript
+setBrowseTagging: (browseTagging: TaggingRequest) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setdisplaybrowsetagging.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setDisplayBrowseTagging](./x-components.browsemutations.setdisplaybrowsetagging.md)
+
+## BrowseMutations.setDisplayBrowseTagging property
+
+Sets the display tagging of the module.
+
+**Signature:**
+
+```typescript
+setDisplayBrowseTagging: (displayBrowseTagging: TaggingRequest) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setfacets.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setFacets](./x-components.browsemutations.setfacets.md)
+
+## BrowseMutations.setFacets property
+
+Sets the facets of the module.
+
+**Signature:**
+
+```typescript
+setFacets: (facets: Facet[]) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setfromnoresultswithfilters.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setFromNoResultsWithFilters](./x-components.browsemutations.setfromnoresultswithfilters.md)
+
+## BrowseMutations.setFromNoResultsWithFilters property
+
+Sets the `fromNoResultsWithFilters` flag value.
+
+**Signature:**
+
+```typescript
+setFromNoResultsWithFilters: (fromNoResultsWithFilters: boolean) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setisappendresults.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setIsAppendResults](./x-components.browsemutations.setisappendresults.md)
+
+## BrowseMutations.setIsAppendResults property
+
+Set the `isAppendResuls` flag value.
+
+**Signature:**
+
+```typescript
+setIsAppendResults: (isAppendResults: boolean) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setisnoresults.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setIsNoResults](./x-components.browsemutations.setisnoresults.md)
+
+## BrowseMutations.setIsNoResults property
+
+Sets the `isNoResults` flag value.
+
+**Signature:**
+
+```typescript
+setIsNoResults: (isNoResults: boolean) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setorigin.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setOrigin](./x-components.browsemutations.setorigin.md)
+
+## BrowseMutations.setOrigin property
+
+Sets the origin of the module.
+
+**Signature:**
+
+```typescript
+setOrigin: (origin: QueryOrigin | undefined | null) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setpage.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setPage](./x-components.browsemutations.setpage.md)
+
+## BrowseMutations.setPage property
+
+Sets the page of the module.
+
+**Signature:**
+
+```typescript
+setPage: (page: number) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setparams.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setParams](./x-components.browsemutations.setparams.md)
+
+## BrowseMutations.setParams property
+
+Sets the extra params of the module.
+
+**Signature:**
+
+```typescript
+setParams: (params: Dictionary<unknown>) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setpromoteds.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setPromoteds](./x-components.browsemutations.setpromoteds.md)
+
+## BrowseMutations.setPromoteds property
+
+Sets the promoteds of the module.
+
+**Signature:**
+
+```typescript
+setPromoteds: (promoteds: Promoted[]) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setresults.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setResults](./x-components.browsemutations.setresults.md)
+
+## BrowseMutations.setResults property
+
+Sets the results of the module.
+
+**Signature:**
+
+```typescript
+setResults: (results: Result[]) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setselectedcategory.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setSelectedCategory](./x-components.browsemutations.setselectedcategory.md)
+
+## BrowseMutations.setSelectedCategory property
+
+Sets the selected category of the module.
+
+**Signature:**
+
+```typescript
+setSelectedCategory: (selectedCategory: BrowsableRequest) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setselectedfilters.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setSelectedFilters](./x-components.browsemutations.setselectedfilters.md)
+
+## BrowseMutations.setSelectedFilters property
+
+Sets the selected filters of the module.
+
+**Signature:**
+
+```typescript
+setSelectedFilters: (selectedFilters: Filter[]) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.setsort.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseMutations](./x-components.browsemutations.md) &gt; [setSort](./x-components.browsemutations.setsort.md)
+
+## BrowseMutations.setSort property
+
+Sets the selected sort option of the module.
+
+**Signature:**
+
+```typescript
+setSort: (sort: Sort) => void;
+```