@empathyco/x-components 7.4.0 → 7.5.0

package/docs/API-reference/api/x-components.resetbrowseappending.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; [resetBrowseAppending](./x-components.resetbrowseappending.md)
+
+## resetBrowseAppending variable
+
+Resets the browse state `isAppendingResults`<!-- -->.
+
+**Signature:**
+
+```typescript
+resetBrowseAppending: import("../../wiring").AnyWire
+```

package/docs/API-reference/api/x-components.resetbrowserequestonrefinement.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; [resetBrowseRequestOnRefinement](./x-components.resetbrowserequestonrefinement.md)
+
+## resetBrowseRequestOnRefinement variable
+
+Default implementation for the [BrowseActions.resetRequestOnRefinement](./x-components.browseactions.resetrequestonrefinement.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+resetRequestOnRefinement: BrowseXStoreModule['actions']['resetRequestOnRefinement']
+```

package/docs/API-reference/api/x-components.resetbrowserequestonrefinementwire.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; [resetBrowseRequestOnRefinementWire](./x-components.resetbrowserequestonrefinementwire.md)
+
+## resetBrowseRequestOnRefinementWire variable
+
+Resets the [BrowseGetters.request](./x-components.browsegetters.request.md) parameters when refining request and before the actual request is launched.
+
+**Signature:**
+
+```typescript
+resetBrowseRequestOnRefinementWire: import("../../wiring").AnyWire
+```

package/docs/API-reference/api/x-components.resetbrowsestateforreloadwire.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; [resetBrowseStateForReloadWire](./x-components.resetbrowsestateforreloadwire.md)
+
+## resetBrowseStateForReloadWire variable
+
+Resets the browse state to reload the current browse.
+
+**Signature:**
+
+```typescript
+resetBrowseStateForReloadWire: import("../../wiring").AnyWire
+```

package/docs/API-reference/api/x-components.resetbrowsestateifnorequestwire.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; [resetBrowseStateIfNoRequestWire](./x-components.resetbrowsestateifnorequestwire.md)
+
+## resetBrowseStateIfNoRequestWire variable
+
+Resets the browse state when the request is changed to null. See the [BrowseXStoreModule](./x-components.browsexstoremodule.md) for details.
+
+**Signature:**
+
+```typescript
+resetBrowseStateIfNoRequestWire: import("../../wiring").Wire<InternalBrowseRequest | null>
+```

package/docs/API-reference/api/x-components.resetfromnobrowseresultswithfilters.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; [resetFromNoBrowseResultsWithFilters](./x-components.resetfromnobrowseresultswithfilters.md)
+
+## resetFromNoBrowseResultsWithFilters variable
+
+Resets the browse state `fromNoResultsWithFilters`<!-- -->.
+
+**Signature:**
+
+```typescript
+resetFromNoBrowseResultsWithFilters: import("../../wiring").AnyWire
+```

package/docs/API-reference/api/x-components.resetisnobrowseresults.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; [resetIsNoBrowseResults](./x-components.resetisnobrowseresults.md)
+
+## resetIsNoBrowseResults variable
+
+Resets the browse state `isNoResults`<!-- -->.
+
+**Signature:**
+
+```typescript
+resetIsNoBrowseResults: import("../../wiring").AnyWire
+```

package/docs/API-reference/api/x-components.savebrowseorigin.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; [saveBrowseOrigin](./x-components.savebrowseorigin.md)
+
+## saveBrowseOrigin variable
+
+Default implementation for the [BrowseActions.saveOrigin](./x-components.browseactions.saveorigin.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+saveOrigin: BrowseXStoreModule['actions']['saveOrigin']
+```

package/docs/API-reference/api/x-components.savebrowseoriginwire.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; [saveBrowseOriginWire](./x-components.savebrowseoriginwire.md)
+
+## saveBrowseOriginWire variable
+
+Sets the browse state `origin`<!-- -->.
+
+**Signature:**
+
+```typescript
+saveBrowseOriginWire: import("../../wiring").AnyWire
+```

package/docs/API-reference/api/x-components.savebrowseresponse.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; [saveBrowseResponse](./x-components.savebrowseresponse.md)
+
+## saveBrowseResponse variable
+
+Default implementation for the [BrowseActions.saveBrowseResponse](./x-components.browseactions.savebrowseresponse.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+saveBrowseResponse: BrowseXStoreModule['actions']['saveBrowseResponse']
+```

package/docs/API-reference/api/x-components.setbrowsecategory.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; [setBrowseCategory](./x-components.setbrowsecategory.md)
+
+## setBrowseCategory variable
+
+Sets the browse state `selectedCategory`<!-- -->.
+
+**Signature:**
+
+```typescript
+setBrowseCategory: import("../../wiring").Wire<import("@empathyco/x-types").BrowsableRequest>
+```

package/docs/API-reference/api/x-components.setbrowseextraparams.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; [setBrowseExtraParams](./x-components.setbrowseextraparams.md)
+
+## setBrowseExtraParams variable
+
+Sets the browse state `params`<!-- -->.
+
+**Signature:**
+
+```typescript
+setBrowseExtraParams: import("../../wiring").Wire<import("@empathyco/x-utils").Dictionary<unknown>>
+```

package/docs/API-reference/api/x-components.setbrowsepage.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; [setBrowsePage](./x-components.setbrowsepage.md)
+
+## setBrowsePage variable
+
+Sets the browse state `page`<!-- -->.
+
+**Signature:**
+
+```typescript
+setBrowsePage: import("../../wiring").Wire<number>
+```

package/docs/API-reference/api/x-components.setbrowseselectedfilters.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; [setBrowseSelectedFilters](./x-components.setbrowseselectedfilters.md)
+
+## setBrowseSelectedFilters variable
+
+Sets the browse state `selectedFilters`<!-- -->.
+
+**Signature:**
+
+```typescript
+setBrowseSelectedFilters: import("../../wiring").Wire<import("@empathyco/x-types").Filter[]>
+```

package/docs/API-reference/api/x-components.setbrowsesort.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; [setBrowseSort](./x-components.setbrowsesort.md)
+
+## setBrowseSort variable
+
+Sets the browse state `sort`<!-- -->.
+
+**Signature:**
+
+```typescript
+setBrowseSort: import("../../wiring").Wire<string>
+```

package/docs/API-reference/api/x-components.setbrowseurlparams.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; [setBrowseUrlParams](./x-components.setbrowseurlparams.md)
+
+## setBrowseUrlParams variable
+
+Default implementation for the [BrowseActions.setUrlParams](./x-components.browseactions.seturlparams.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+setUrlParams: BrowseXStoreModule['actions']['setUrlParams']
+```

package/docs/API-reference/api/x-components.setbrowseurlparamswire.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; [setBrowseUrlParamsWire](./x-components.setbrowseurlparamswire.md)
+
+## setBrowseUrlParamsWire variable
+
+Sets the browse state `query`<!-- -->.
+
+**Signature:**
+
+```typescript
+setBrowseUrlParamsWire: import("../../wiring").Wire<import("../..").UrlParams>
+```

package/docs/API-reference/api/x-components.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; [setResults](./x-components.setresults.md)
+
+## setResults variable
+
+Sets the vendor results of the [VendorXModule](./x-components.vendorxmodule.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+setResults: import("../../wiring").AnyWire
+```

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

@@ -206,6 +206,7 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
         UserClickedAnAiCarouselResult?: import("@empathyco/x-types").Result | undefined;
         UserClickedAnAiCarouselAdd2Cart?: import("@empathyco/x-types").Result | undefined;
         AiComponentMounted?: void | undefined;
+        VendorResultsChanged?: Omit<import("../../../vendor").VendorResult, "modelName">[] | undefined;
     }>;
     innerCssClasses: import("vue").ComputedRef<(string | Dictionary<boolean>)[]>;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{

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

@@ -156,9 +156,9 @@ _default: import("vue").DefineComponent<{}, {
         UserClickedABanner: (payload: import("@empathyco/x-types").Banner, metadata: WireMetadata) => unknown;
         UserClickedAbortARedirection: (payload: undefined, metadata: WireMetadata) => unknown;
         UserSelectedAPage: (payload: number, metadata: WireMetadata) => unknown;
-        BrowseRequestChanged: (payload: import("../x-modules/browse").InternalBrowseRequest | null, metadata: WireMetadata) => unknown;
-        BrowseRequestUpdated: (payload: import("../x-modules/browse").InternalBrowseRequest | null, metadata: WireMetadata) => unknown;
-        BrowseResponseChanged: (payload: import("../x-modules/browse").InternalBrowseResponse, metadata: WireMetadata) => unknown;
+        BrowseRequestChanged: (payload: import("..").InternalBrowseRequest | null, metadata: WireMetadata) => unknown;
+        BrowseRequestUpdated: (payload: import("..").InternalBrowseRequest | null, metadata: WireMetadata) => unknown;
+        BrowseResponseChanged: (payload: import("..").InternalBrowseResponse, metadata: WireMetadata) => unknown;
         BrowseTaggingChanged: (payload: import("@empathyco/x-types").TaggingRequest, metadata: WireMetadata) => unknown;
         UserClickedABrowseSort: (payload: string, metadata: WireMetadata) => unknown;
         SelectedBrowseSortProvided: (payload: string, metadata: WireMetadata) => unknown;
@@ -196,6 +196,7 @@ _default: import("vue").DefineComponent<{}, {
         UserClickedAnAiCarouselResult: (payload: import("@empathyco/x-types").Result, metadata: WireMetadata) => unknown;
         UserClickedAnAiCarouselAdd2Cart: (payload: import("@empathyco/x-types").Result, metadata: WireMetadata) => unknown;
         AiComponentMounted: (payload: undefined, metadata: WireMetadata) => unknown;
+        VendorResultsChanged: (payload: Omit<import("..").VendorResult, "modelName">[], metadata: WireMetadata) => unknown;
     }>>;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {
     GlobalXBus: import("vue").DefineComponent<{}, {}, any>;

package/docs/API-reference/api/x-components.usealiasapi.browsetotalresults.md

@@ -4,7 +4,7 @@
 
 ## UseAliasAPI.browseTotalResults property
 
-The  total results.
+The [BrowseXModule](./x-components.browsexmodule.md) total results.
 
 **Signature:**
 

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

@@ -52,7 +52,7 @@ number
 
 </td><td>
 
-The  total results.
+The [BrowseXModule](./x-components.browsexmodule.md) total results.
 
 
 </td></tr>

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [VendorActions](./x-components.vendoractions.md)
+
+## VendorActions interface
+
+**Signature:**
+
+```typescript
+export interface VendorActions 
+```

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

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [VendorGetters](./x-components.vendorgetters.md)
+
+## VendorGetters interface
+
+**Signature:**
+
+```typescript
+export interface VendorGetters 
+```

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

@@ -0,0 +1,54 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [VendorMutations](./x-components.vendormutations.md)
+
+## VendorMutations interface
+
+**Signature:**
+
+```typescript
+export interface VendorMutations 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[setResults](./x-components.vendormutations.setresults.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(results: [VendorResult](./x-components.vendorresult.md)<!-- -->\[\]) =&gt; void
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

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

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

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

@@ -0,0 +1,57 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [VendorResult](./x-components.vendorresult.md)
+
+## VendorResult interface
+
+The interface for a vendor result, extending the base Result interface.
+
+**Signature:**
+
+```typescript
+export interface VendorResult extends Omit<Result, 'modelName'>, NamedModel<'VendorResult'> 
+```
+**Extends:** Omit&lt;Result, 'modelName'&gt;, NamedModel&lt;'VendorResult'&gt;
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[position](./x-components.vendorresult.position.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/API-reference/api/x-components.vendorresult.position.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [VendorResult](./x-components.vendorresult.md) &gt; [position](./x-components.vendorresult.position.md)
+
+## VendorResult.position property
+
+**Signature:**
+
+```typescript
+position: number;
+```

package/docs/API-reference/api/x-components.vendorresultslist.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; [VendorResultsList](./x-components.vendorresultslist.md)
+
+## VendorResultsList variable
+
+It renders a [ItemsList](./x-components.itemslist.md) of vendor results from [VendorState.results](./x-components.vendorstate.results.md)<!-- -->.
+
+The component provides a default slot which wraps the whole component with the `vendorResults` plus the `injectedListItems` which also contains the injected list items from the ancestor.
+
+It also provides the parent slots to customize the items.
+
+**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.vendorstate.md

@@ -0,0 +1,54 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [VendorState](./x-components.vendorstate.md)
+
+## VendorState interface
+
+**Signature:**
+
+```typescript
+export interface VendorState 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[results](./x-components.vendorstate.results.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[VendorResult](./x-components.vendorresult.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/API-reference/api/x-components.vendorstate.results.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [VendorState](./x-components.vendorstate.md) &gt; [results](./x-components.vendorstate.results.md)
+
+## VendorState.results property
+
+**Signature:**
+
+```typescript
+results: VendorResult[];
+```

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

@@ -0,0 +1,58 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [VendorXEvents](./x-components.vendorxevents.md)
+
+## VendorXEvents interface
+
+Directory of events for the vendor module.
+
+**Signature:**
+
+```typescript
+export interface VendorXEvents 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[VendorResultsChanged](./x-components.vendorxevents.vendorresultschanged.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Omit&lt;[VendorResult](./x-components.vendorresult.md)<!-- -->, 'modelName'&gt;\[\]
+
+
+</td><td>
+
+The x consumer has provided vendor results to be inserted in the result grid. Payload: The array of vendor result inputs with their items and positions. modelName is excluded since it is an internal field, and we will assign it under the hood.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/API-reference/api/x-components.vendorxevents.vendorresultschanged.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; [VendorXEvents](./x-components.vendorxevents.md) &gt; [VendorResultsChanged](./x-components.vendorxevents.vendorresultschanged.md)
+
+## VendorXEvents.VendorResultsChanged property
+
+The x consumer has provided vendor results to be inserted in the result grid. Payload: The array of vendor result inputs with their items and positions. modelName is excluded since it is an internal field, and we will assign it under the hood.
+
+**Signature:**
+
+```typescript
+VendorResultsChanged: Omit<VendorResult, 'modelName'>[];
+```