@empathyco/x-components 7.3.1 → 7.4.1

package/docs/API-reference/api/x-components.browsemutations.setstats.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; [setStats](./x-components.browsemutations.setstats.md)
+
+## BrowseMutations.setStats property
+
+Sets the stats of the module.
+
+**Signature:**
+
+```typescript
+setStats: (stats: Stats) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.settotalresults.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; [setTotalResults](./x-components.browsemutations.settotalresults.md)
+
+## BrowseMutations.setTotalResults property
+
+Sets the total results of the module.
+
+**Signature:**
+
+```typescript
+setTotalResults: (totalResults: number) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.updateresult.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; [updateResult](./x-components.browsemutations.updateresult.md)
+
+## BrowseMutations.updateResult property
+
+Updates a result with new fields.
+
+**Signature:**
+
+```typescript
+updateResult: (result: Partial<Result> & Pick<Result, 'id'>) => void;
+```

package/docs/API-reference/api/x-components.browsemutations.updateresultsfromenrichment.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; [updateResultsFromEnrichment](./x-components.browsemutations.updateresultsfromenrichment.md)
+
+## BrowseMutations.updateResultsFromEnrichment property
+
+Updates the results with the enrichment results.
+
+**Signature:**
+
+```typescript
+updateResultsFromEnrichment: (enrichmentResults: any[]) => void;
+```

package/docs/API-reference/api/x-components.browserequest.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; [browseRequest](./x-components.browserequest.md)
+
+## browseRequest variable
+
+Default implementation for the [BrowseGetters.request](./x-components.browsegetters.request.md) getter.
+
+**Signature:**
+
+```typescript
+request: BrowseXStoreModule['getters']['request']
+```

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

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseResultsList](./x-components.browseresultslist.md)
+
+## BrowseResultsList variable
+
+It renders a [ItemsList](./x-components.itemslist.md) list with the results from [SearchState.results](./x-components.searchstate.results.md) by default.
+
+The component provides a default slot which wraps the whole component with the `results` bound.
+
+It also provides the slot result to customize the item, which is within the default slot, with the result bound.
+
+**Signature:**
+
+```typescript
+_default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    animation: {
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
+        default: string;
+    };
+}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    animation: {
+        type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
+        default: string;
+    };
+}>> & Readonly<{}>, {
+    animation: string | Function | Record<string, any>;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>
+```

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

@@ -0,0 +1,45 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseSortPickerList](./x-components.browsesortpickerlist.md)
+
+## BrowseSortPickerList variable
+
+The `SortPickerList` component allows user to select the browse results order. This component also allows to change the selected sort programmatically.
+
+**Signature:**
+
+```typescript
+_default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    animation: {
+        type: null;
+        required: false;
+        default: string;
+    };
+    items: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    buttonClass: {
+        type: StringConstructor;
+        required: true;
+    };
+}>, (_ctx: any, _cache: any) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    animation: {
+        type: null;
+        required: false;
+        default: string;
+    };
+    items: {
+        type: ArrayConstructor;
+        required: true;
+    };
+    buttonClass: {
+        type: StringConstructor;
+        required: true;
+    };
+}>> & Readonly<{}>, {
+    animation: any;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>
+```

package/docs/API-reference/api/x-components.browsestate.banners.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; [BrowseState](./x-components.browsestate.md) &gt; [banners](./x-components.browsestate.banners.md)
+
+## BrowseState.banners property
+
+The list of the banners, related to the `browseCategory` property of the state.
+
+**Signature:**
+
+```typescript
+banners: Banner[];
+```

package/docs/API-reference/api/x-components.browsestate.browsetagging.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; [BrowseState](./x-components.browsestate.md) &gt; [browseTagging](./x-components.browsestate.browsetagging.md)
+
+## BrowseState.browseTagging property
+
+The browse tagging used to track the browse events.
+
+**Signature:**
+
+```typescript
+browseTagging: TaggingRequest;
+```

package/docs/API-reference/api/x-components.browsestate.config.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; [BrowseState](./x-components.browsestate.md) &gt; [config](./x-components.browsestate.config.md)
+
+## BrowseState.config property
+
+The configuration of the browse module.
+
+**Signature:**
+
+```typescript
+config: BrowseConfig;
+```

package/docs/API-reference/api/x-components.browsestate.displaybrowsetagging.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; [BrowseState](./x-components.browsestate.md) &gt; [displayBrowseTagging](./x-components.browsestate.displaybrowsetagging.md)
+
+## BrowseState.displayBrowseTagging property
+
+The display tagging used to track the browse events.
+
+**Signature:**
+
+```typescript
+displayBrowseTagging: TaggingRequest;
+```

package/docs/API-reference/api/x-components.browsestate.facets.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; [BrowseState](./x-components.browsestate.md) &gt; [facets](./x-components.browsestate.facets.md)
+
+## BrowseState.facets property
+
+The list of the facets, related to the `query` property of the state.
+
+**Signature:**
+
+```typescript
+facets: Facet[];
+```

package/docs/API-reference/api/x-components.browsestate.fromnoresultswithfilters.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; [BrowseState](./x-components.browsestate.md) &gt; [fromNoResultsWithFilters](./x-components.browsestate.fromnoresultswithfilters.md)
+
+## BrowseState.fromNoResultsWithFilters property
+
+Flag indicating if there is a no results situation with filters selected.
+
+**Signature:**
+
+```typescript
+fromNoResultsWithFilters: boolean;
+```

package/docs/API-reference/api/x-components.browsestate.isappendresults.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; [BrowseState](./x-components.browsestate.md) &gt; [isAppendResults](./x-components.browsestate.isappendresults.md)
+
+## BrowseState.isAppendResults property
+
+A flag to indicate if new results are append to the current instead of replacing them.
+
+**Signature:**
+
+```typescript
+isAppendResults: boolean;
+```

package/docs/API-reference/api/x-components.browsestate.isnoresults.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; [BrowseState](./x-components.browsestate.md) &gt; [isNoResults](./x-components.browsestate.isnoresults.md)
+
+## BrowseState.isNoResults property
+
+Flag indicating if there is a no results situation.
+
+**Signature:**
+
+```typescript
+isNoResults: boolean;
+```

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

@@ -0,0 +1,382 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BrowseState](./x-components.browsestate.md)
+
+## BrowseState interface
+
+Browse store state.
+
+**Signature:**
+
+```typescript
+export interface BrowseState extends StatusState 
+```
+**Extends:** [StatusState](./x-components.statusstate.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[banners](./x-components.browsestate.banners.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Banner\[\]
+
+
+</td><td>
+
+The list of the banners, related to the `browseCategory` property of the state.
+
+
+</td></tr>
+<tr><td>
+
+[browseTagging](./x-components.browsestate.browsetagging.md)
+
+
+</td><td>
+
+
+</td><td>
+
+TaggingRequest
+
+
+</td><td>
+
+The browse tagging used to track the browse events.
+
+
+</td></tr>
+<tr><td>
+
+[config](./x-components.browsestate.config.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[BrowseConfig](./x-components.browseconfig.md)
+
+
+</td><td>
+
+The configuration of the browse module.
+
+
+</td></tr>
+<tr><td>
+
+[displayBrowseTagging](./x-components.browsestate.displaybrowsetagging.md)
+
+
+</td><td>
+
+
+</td><td>
+
+TaggingRequest
+
+
+</td><td>
+
+The display tagging used to track the browse events.
+
+
+</td></tr>
+<tr><td>
+
+[facets](./x-components.browsestate.facets.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Facet\[\]
+
+
+</td><td>
+
+The list of the facets, related to the `query` property of the state.
+
+
+</td></tr>
+<tr><td>
+
+[fromNoResultsWithFilters](./x-components.browsestate.fromnoresultswithfilters.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Flag indicating if there is a no results situation with filters selected.
+
+
+</td></tr>
+<tr><td>
+
+[isAppendResults](./x-components.browsestate.isappendresults.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+A flag to indicate if new results are append to the current instead of replacing them.
+
+
+</td></tr>
+<tr><td>
+
+[isNoResults](./x-components.browsestate.isnoresults.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Flag indicating if there is a no results situation.
+
+
+</td></tr>
+<tr><td>
+
+[origin](./x-components.browsestate.origin.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[QueryOrigin](./x-components.queryorigin.md) \| null
+
+
+</td><td>
+
+The origin property of the request.
+
+
+</td></tr>
+<tr><td>
+
+[page](./x-components.browsestate.page.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The current page of the request.
+
+
+</td></tr>
+<tr><td>
+
+[params](./x-components.browsestate.params.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Dictionary&lt;unknown&gt;
+
+
+</td><td>
+
+The extra params property of the state.
+
+
+</td></tr>
+<tr><td>
+
+[promoteds](./x-components.browsestate.promoteds.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Promoted\[\]
+
+
+</td><td>
+
+The list of the promoted, related to the `query` property of the state.
+
+
+</td></tr>
+<tr><td>
+
+[results](./x-components.browsestate.results.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Result\[\]
+
+
+</td><td>
+
+The list of the results, related to the `query` property of the state.
+
+
+</td></tr>
+<tr><td>
+
+[selectedCategory](./x-components.browsestate.selectedcategory.md)
+
+
+</td><td>
+
+
+</td><td>
+
+BrowsableRequest
+
+
+</td><td>
+
+The current selected category of the request
+
+
+</td></tr>
+<tr><td>
+
+[selectedFilters](./x-components.browsestate.selectedfilters.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Dictionary&lt;Filter\[\]&gt;
+
+
+</td><td>
+
+The dictionary of selected filters, used to perform the browse request. The key is the facet id, and the value the list of filters for that facet.
+
+
+</td></tr>
+<tr><td>
+
+[sort](./x-components.browsestate.sort.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sort
+
+
+</td><td>
+
+The way of ordering the results.
+
+
+</td></tr>
+<tr><td>
+
+[stats](./x-components.browsestate.stats.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Stats
+
+
+</td><td>
+
+The stats of the results.
+
+
+</td></tr>
+<tr><td>
+
+[totalResults](./x-components.browsestate.totalresults.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The total number of results, related to the `query` property of the state.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/API-reference/api/x-components.browsestate.origin.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; [BrowseState](./x-components.browsestate.md) &gt; [origin](./x-components.browsestate.origin.md)
+
+## BrowseState.origin property
+
+The origin property of the request.
+
+**Signature:**
+
+```typescript
+origin: QueryOrigin | null;
+```

package/docs/API-reference/api/x-components.browsestate.page.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; [BrowseState](./x-components.browsestate.md) &gt; [page](./x-components.browsestate.page.md)
+
+## BrowseState.page property
+
+The current page of the request.
+
+**Signature:**
+
+```typescript
+page: number;
+```

package/docs/API-reference/api/x-components.browsestate.params.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; [BrowseState](./x-components.browsestate.md) &gt; [params](./x-components.browsestate.params.md)
+
+## BrowseState.params property
+
+The extra params property of the state.
+
+**Signature:**
+
+```typescript
+params: Dictionary<unknown>;
+```