@empathyco/x-components 6.0.0-alpha.180 → 6.0.0-alpha.181

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 6.0.0-alpha.181 (2025-11-20)
+
+* feat: add standalone facets endpoint and module foundation (#1928) ([b3109e5](https://github.com/empathyco/x/commit/b3109e5)), closes [#1928](https://github.com/empathyco/x/issues/1928)
+
+
+
+
+
 ## 6.0.0-alpha.180 (2025-11-19)
 
 * chore(deps): update dependency @types/node to v24 (#1927) ([4b58181](https://github.com/empathyco/x/commit/4b58181)), closes [#1927](https://github.com/empathyco/x/issues/1927)

package/docs/API-reference/api/x-adapter-platform.facetsendpointadapter.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [facetsEndpointAdapter](./x-adapter-platform.facetsendpointadapter.md)
+
+## facetsEndpointAdapter variable
+
+Default adapter for the search endpoint.
+
+**Signature:**
+
+```typescript
+facetsEndpointAdapter: import("@empathyco/x-adapter").ExtendableEndpointAdapter<FacetsRequest, FacetsResponse>
+```

package/docs/API-reference/api/x-adapter-platform.facetsrequestschema.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [facetsRequestSchema](./x-adapter-platform.facetsrequestschema.md)
+
+## facetsRequestSchema variable
+
+Default implementation for the FacetsRequestSchema.
+
+**Signature:**
+
+```typescript
+facetsRequestSchema: import("@empathyco/x-adapter").MutableSchema<FacetsRequest, PlatformFacetsRequest>
+```

package/docs/API-reference/api/x-adapter-platform.facetsresponsemapper.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [facetsResponseMapper](./x-adapter-platform.facetsresponsemapper.md)
+
+## facetsResponseMapper variable
+
+Default implementation for the FacetsResponseMapper.
+
+**Signature:**
+
+```typescript
+facetsResponseMapper: import("@empathyco/x-adapter").Mapper<PlatformFacetsResponse, FacetsResponse>
+```

package/docs/API-reference/api/x-adapter-platform.md

@@ -32,6 +32,8 @@
 |  [PlatformExperienceControlsRequest](./x-adapter-platform.platformexperiencecontrolsrequest.md) | Request for the <code>experience controls</code> endpoint. |
 |  [PlatformExperienceControlsResponse](./x-adapter-platform.platformexperiencecontrolsresponse.md) | Response for the <code>experience controls</code> endpoint. |
 |  [PlatformFacet](./x-adapter-platform.platformfacet.md) | Facet model for the <code>platform</code> API. |
+|  [PlatformFacetsRequest](./x-adapter-platform.platformfacetsrequest.md) | Request for the <code>facets</code> endpoint. |
+|  [PlatformFacetsResponse](./x-adapter-platform.platformfacetsresponse.md) | Response for the <code>facets</code> endpoint. |
 |  [PlatformFilter](./x-adapter-platform.platformfilter.md) | Filter model for the <code>platform</code> API. |
 |  [PlatformHierarchicalFilter](./x-adapter-platform.platformhierarchicalfilter.md) | HierarchicalFilter model for the <code>platform</code> API. |
 |  [PlatformIdentifierResultsRequest](./x-adapter-platform.platformidentifierresultsrequest.md) | Request for the <code>identifier results</code> endpoint. |
@@ -98,6 +100,9 @@
 |  [experienceControlsResponseMapper](./x-adapter-platform.experiencecontrolsresponsemapper.md) | Default implementation for the ExperienceControlsResponseMapper. |
 |  [experienceControlsResponseSchema](./x-adapter-platform.experiencecontrolsresponseschema.md) | Default implementation for the ExperienceControlsResponseSchema. |
 |  [facetSchema](./x-adapter-platform.facetschema.md) | Default implementation for the FacetSchema. |
+|  [facetsEndpointAdapter](./x-adapter-platform.facetsendpointadapter.md) | Default adapter for the search endpoint. |
+|  [facetsRequestSchema](./x-adapter-platform.facetsrequestschema.md) | Default implementation for the FacetsRequestSchema. |
+|  [facetsResponseMapper](./x-adapter-platform.facetsresponsemapper.md) | Default implementation for the FacetsResponseMapper. |
 |  [hierarchicalFilterSchema](./x-adapter-platform.hierarchicalfilterschema.md) | Default implementation for the HierarchicalFilterSchema. |
 |  [identifierResultsEndpointAdapter](./x-adapter-platform.identifierresultsendpointadapter.md) | Default adapter for the identifier results endpoint. |
 |  [identifierResultsRequestMapper](./x-adapter-platform.identifierresultsrequestmapper.md) | Default mapper for IdentifierResultsRequest. |

package/docs/API-reference/api/x-adapter-platform.platformfacetsrequest.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFacetsRequest](./x-adapter-platform.platformfacetsrequest.md)
+
+## PlatformFacetsRequest interface
+
+Request for the `facets` endpoint.
+
+**Signature:**
+
+```typescript
+export interface PlatformFacetsRequest extends PlatformQueryableRequest, PlatformFilterableRequest, PlatformTrackableRequest, PlatformExtraParamsRequest 
+```
+**Extends:** PlatformQueryableRequest, PlatformFilterableRequest, PlatformTrackableRequest, PlatformExtraParamsRequest
+

package/docs/API-reference/api/x-adapter-platform.platformfacetsresponse.catalog.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFacetsResponse](./x-adapter-platform.platformfacetsresponse.md) &gt; [catalog](./x-adapter-platform.platformfacetsresponse.catalog.md)
+
+## PlatformFacetsResponse.catalog property
+
+**Signature:**
+
+```typescript
+catalog: {
+        facets: PlatformFacet[];
+    };
+```

package/docs/API-reference/api/x-adapter-platform.platformfacetsresponse.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFacetsResponse](./x-adapter-platform.platformfacetsresponse.md)
+
+## PlatformFacetsResponse interface
+
+Response for the `facets` endpoint.
+
+**Signature:**
+
+```typescript
+export interface PlatformFacetsResponse 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [catalog](./x-adapter-platform.platformfacetsresponse.catalog.md) |  | { facets: [PlatformFacet](./x-adapter-platform.platformfacet.md)<!-- -->\[\]; } |  |
+

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

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [applyHierarchicalSelection](./x-components.applyhierarchicalselection.md)
+
+## applyHierarchicalSelection() function
+
+Recursively applies the selected state to hierarchical filters and their children.
+
+**Signature:**
+
+```typescript
+export declare function applyHierarchicalSelection(filters: HierarchicalFilter[], selectedIds: Set<string | number>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  filters | HierarchicalFilter\[\] | The hierarchical filters to update. |
+|  selectedIds | Set&lt;string \| number&gt; | The set of selected filter ids. |
+
+**Returns:**
+
+void
+

package/docs/API-reference/api/x-components.facetsactions.cancelfetchandsavefacetsresponse.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; [FacetsActions](./x-components.facetsactions.md) &gt; [cancelFetchAndSaveFacetsResponse](./x-components.facetsactions.cancelfetchandsavefacetsresponse.md)
+
+## FacetsActions.cancelFetchAndSaveFacetsResponse property
+
+Cancels / interrupt [FacetsActions.cancelFetchAndSaveFacetsResponse](./x-components.facetsactions.cancelfetchandsavefacetsresponse.md) synchronous promise.
+
+**Signature:**
+
+```typescript
+cancelFetchAndSaveFacetsResponse: () => void;
+```

package/docs/API-reference/api/x-components.facetsactions.fetchandsavefacetsresponse.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; [FacetsActions](./x-components.facetsactions.md) &gt; [fetchAndSaveFacetsResponse](./x-components.facetsactions.fetchandsavefacetsresponse.md)
+
+## FacetsActions.fetchAndSaveFacetsResponse property
+
+Fetches a new facets response and stores them in the module state.
+
+**Signature:**
+
+```typescript
+fetchAndSaveFacetsResponse: (request: FacetsRequest | null) => void;
+```

package/docs/API-reference/api/x-components.facetsactions.fetchfacetsresponse.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; [FacetsActions](./x-components.facetsactions.md) &gt; [fetchFacetsResponse](./x-components.facetsactions.fetchfacetsresponse.md)
+
+## FacetsActions.fetchFacetsResponse property
+
+Fetches the facets response and returns them.
+
+**Signature:**
+
+```typescript
+fetchFacetsResponse: (request: FacetsRequest) => FacetsResponse;
+```

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

@@ -11,3 +11,13 @@ Facets store actions.
 ```typescript
 export interface FacetsActions 
 ```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [cancelFetchAndSaveFacetsResponse](./x-components.facetsactions.cancelfetchandsavefacetsresponse.md) |  | () => void | Cancels / interrupt [FacetsActions.cancelFetchAndSaveFacetsResponse](./x-components.facetsactions.cancelfetchandsavefacetsresponse.md) synchronous promise. |
+|  [fetchAndSaveFacetsResponse](./x-components.facetsactions.fetchandsavefacetsresponse.md) |  | (request: FacetsRequest \| null) => void | Fetches a new facets response and stores them in the module state. |
+|  [fetchFacetsResponse](./x-components.facetsactions.fetchfacetsresponse.md) |  | (request: FacetsRequest) => FacetsResponse | Fetches the facets response and returns them. |
+|  [saveOrigin](./x-components.facetsactions.saveorigin.md) |  | (originInit: [QueryOriginInit](./x-components.queryorigininit.md)<!-- -->) =&gt; void | Creates a [QueryOrigin](./x-components.queryorigin.md) and saves it. |
+

package/docs/API-reference/api/x-components.facetsactions.saveorigin.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; [FacetsActions](./x-components.facetsactions.md) &gt; [saveOrigin](./x-components.facetsactions.saveorigin.md)
+
+## FacetsActions.saveOrigin property
+
+Creates a [QueryOrigin](./x-components.queryorigin.md) and saves it.
+
+**Signature:**
+
+```typescript
+saveOrigin: (originInit: QueryOriginInit) => void;
+```

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

@@ -17,6 +17,7 @@ export interface FacetsGetters
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [facets](./x-components.facetsgetters.facets.md) |  | Record<Facet\['id'\], Facet> | List of all facets with their filters. |
+|  [request](./x-components.facetsgetters.request.md) |  | FacetsRequest \| null | The adapter request object for retrieving the facets, or null if there is no valid data to create a request. |
 |  [selectedFilters](./x-components.facetsgetters.selectedfilters.md) |  | Filter\[\] | List of all selected filters. |
 |  [selectedFiltersByFacet](./x-components.facetsgetters.selectedfiltersbyfacet.md) |  | [FiltersByFacet](./x-components.filtersbyfacet.md) | List of all selected filters grouped by their facet. |
 |  [selectedFiltersForRequest](./x-components.facetsgetters.selectedfiltersforrequest.md) |  | Filter\[\] | List of all selected filters that conform to the filters for request strategy. |

package/docs/API-reference/api/x-components.facetsgetters.request.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; [FacetsGetters](./x-components.facetsgetters.md) &gt; [request](./x-components.facetsgetters.request.md)
+
+## FacetsGetters.request property
+
+The adapter request object for retrieving the facets, or null if there is no valid data to create a request.
+
+**Signature:**
+
+```typescript
+request: FacetsRequest | null;
+```

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

@@ -9,9 +9,9 @@ Facets store mutations.
 **Signature:**
 
 ```typescript
-export interface FacetsMutations extends QueryMutations, ConfigMutations<FacetsState> 
+export interface FacetsMutations extends StatusMutations, QueryMutations, ConfigMutations<FacetsState> 
 ```
-**Extends:** [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- -->&lt;[FacetsState](./x-components.facetsstate.md)<!-- -->&gt;
+**Extends:** [StatusMutations](./x-components.statusmutations.md)<!-- -->, [QueryMutations](./x-components.querymutations.md)<!-- -->, [ConfigMutations](./x-components.configmutations.md)<!-- -->&lt;[FacetsState](./x-components.facetsstate.md)<!-- -->&gt;
 
 ## Properties
 
@@ -26,6 +26,8 @@ export interface FacetsMutations extends QueryMutations, ConfigMutations<FacetsS
 |  [setFacet](./x-components.facetsmutations.setfacet.md) |  | (facet: Facet) =&gt; void | Adds the facet to the [facets](./x-components.facetsstate.facets.md) record. |
 |  [setFacetGroup](./x-components.facetsmutations.setfacetgroup.md) |  | (facetGroupEntry: [FacetGroupEntry](./x-components.facetgroupentry.md)<!-- -->) =&gt; void | Sets the group id of the facet. |
 |  [setFilters](./x-components.facetsmutations.setfilters.md) |  | (filters: Filter\[\]) =&gt; void | Adds a list of filters to the [filters](./x-components.facetsstate.filters.md) record. |
+|  [setOrigin](./x-components.facetsmutations.setorigin.md) |  | (origin: [QueryOrigin](./x-components.queryorigin.md) \| undefined \| null) =&gt; void | Sets the origin of the module. |
+|  [setParams](./x-components.facetsmutations.setparams.md) |  | (params: Dictionary&lt;unknown&gt;) =&gt; void | Sets the extra params of the module. |
 |  [setPreselectedFilters](./x-components.facetsmutations.setpreselectedfilters.md) |  | (filters: RawFilter\[\]) =&gt; void | Adds a list of filters to the [preselectedFilters](./x-components.facetsstate.preselectedfilters.md) record. |
 |  [setStickyFilter](./x-components.facetsmutations.setstickyfilter.md) |  | (filter: RawFilter) =&gt; void | Adds the filter to the [sticky filters](./x-components.facetsstate.stickyfilters.md) record. |
 

package/docs/API-reference/api/x-components.facetsmutations.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; [FacetsMutations](./x-components.facetsmutations.md) &gt; [setOrigin](./x-components.facetsmutations.setorigin.md)
+
+## FacetsMutations.setOrigin property
+
+Sets the origin of the module.
+
+**Signature:**
+
+```typescript
+setOrigin: (origin: QueryOrigin | undefined | null) => void;
+```

package/docs/API-reference/api/x-components.facetsmutations.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; [FacetsMutations](./x-components.facetsmutations.md) &gt; [setParams](./x-components.facetsmutations.setparams.md)
+
+## FacetsMutations.setParams property
+
+Sets the extra params of the module.
+
+**Signature:**
+
+```typescript
+setParams: (params: Dictionary<unknown>) => void;
+```

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

@@ -9,8 +9,9 @@ Facets store state.
 **Signature:**
 
 ```typescript
-export interface FacetsState 
+export interface FacetsState extends StatusState, QueryState 
 ```
+**Extends:** [StatusState](./x-components.statusstate.md)<!-- -->, [QueryState](./x-components.querystate.md)
 
 ## Properties
 
@@ -20,7 +21,8 @@ export interface FacetsState
 |  [facets](./x-components.facetsstate.facets.md) |  | Record&lt;Facet\['id'\], Omit&lt;Facet, 'filters'&gt;&gt; | The facets without their filters. |
 |  [filters](./x-components.facetsstate.filters.md) |  | Record&lt;Filter\['id'\], Filter&gt; | Record of all available filters indexed by its id. |
 |  [groups](./x-components.facetsstate.groups.md) |  | Record&lt;Facet\['id'\], [GroupId](./x-components.groupid.md)<!-- -->&gt; | Record specifying the group each facet belongs to. |
+|  [origin](./x-components.facetsstate.origin.md) |  | [QueryOrigin](./x-components.queryorigin.md) \| null | The origin property of the request. |
+|  [params](./x-components.facetsstate.params.md) |  | Dictionary&lt;unknown&gt; | The extra params property of the state. |
 |  [preselectedFilters](./x-components.facetsstate.preselectedfilters.md) |  | RawFilter\[\] | Record of preselected filters indexed by its id. |
-|  [query](./x-components.facetsstate.query.md) |  | string | The current query [FacetsState.query](./x-components.facetsstate.query.md)<!-- -->. |
 |  [stickyFilters](./x-components.facetsstate.stickyfilters.md) |  | Record&lt;Filter\['id'\], Filter&gt; | Record of sticky filters indexed by its id. |
 

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

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

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

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [flattenAllFilters](./x-components.flattenallfilters.md)
+
+## flattenAllFilters() function
+
+Flattens all filters from an array of facets, including hierarchical filters.
+
+**Signature:**
+
+```typescript
+export declare function flattenAllFilters(facets: Facet[]): Filter[];
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  facets | Facet\[\] | The list of facets to extract filters from. |
+
+**Returns:**
+
+Filter\[\]
+
+A flat array of all filters from all facets.
+

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

@@ -31,6 +31,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [animateClipPath(animationOrigin)](./x-components.animateclippath.md) | Returns a transition component to wrap an element passed in the default slot and animating its clip-path using inset and with the origin passed as parameter. |
 |  [animateScale(animationOrigin)](./x-components.animatescale.md) | Returns a transition component to wrap an element passed in the default slot and animating its scale using transform and with the transform origin passed as parameter. |
 |  [animateTranslate(animationOrigin)](./x-components.animatetranslate.md) | Returns a transition component to wrap an element passed in the default slot and animating its translate using transform and with the transform origin passed as parameter. |
+|  [applyHierarchicalSelection(filters, selectedIds)](./x-components.applyhierarchicalselection.md) | Recursively applies the selected state to hierarchical filters and their children. |
 |  [areFiltersDifferent(someFilters, anotherFilters)](./x-components.arefiltersdifferent.md) | Compares if two lists contains the same filters. |
 |  [arrayToObject(array)](./x-components.arraytoobject.md) | Reduce an array of strings to an object which properties names are the value of each string, and the value under that property are also the string. |
 |  [arrayToObject(array, key)](./x-components.arraytoobject_1.md) | Reduce an array of objects to an object which properties names are the value of each object\[key\], and the value under that property are each object. 'key' is the the parameter passed to this function. |
@@ -79,6 +80,7 @@ X-Components is a library usable everywhere not only for search experiences.
 |  [filterTruthyPayload(wire)](./x-components.filtertruthypayload.md) | Creates a [Wire](./x-components.wire.md) that is only executed when the payload is a [falsy value](https://developer.mozilla.org/en-US/docs/Glossary/Falsy)<!-- -->. |
 |  [filterWhitelistedModules(wire, whitelist)](./x-components.filterwhitelistedmodules.md) | Creates a [Wire](./x-components.wire.md) that is only executed if the event is emitted from a [XModule](./x-components.xmodule.md) that is included in the <code>whitelist</code> array passed as parameter. |
 |  [flatHierarchicalFilters(hierarchicalFilters)](./x-components.flathierarchicalfilters.md) | This function flattens the Hierarchical Filters, returning an array with all filters including the children. |
+|  [flattenAllFilters(facets)](./x-components.flattenallfilters.md) | Flattens all filters from an array of facets, including hierarchical filters. |
 |  [getActiveElement(root)](./x-components.getactiveelement.md) | Retrieves the currently active element from the specified document or shadow root. This function is recursive to handle nested shadow DOMs, ensuring the actual active element is returned even if it resides deep within multiple shadow DOM layers. |
 |  [getGetterPath(moduleName, getterName)](./x-components.getgetterpath.md) | Generates a getter path string with the module and getter name. |
 |  [getRootXComponent(component)](./x-components.getrootxcomponent.md) | Given a component, finds the root XComponent in the ancestors hierarchy. |

package/docs/API-reference/api/x-types.facetsrequest.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [FacetsRequest](./x-types.facetsrequest.md)
+
+## FacetsRequest interface
+
+The Request for the Facets endpoint.
+
+**Signature:**
+
+```typescript
+export interface FacetsRequest extends QueryableRequest, FilterableRequest, TrackableRequest, ExtraParamsRequest 
+```
+**Extends:** [QueryableRequest](./x-types.queryablerequest.md)<!-- -->, [FilterableRequest](./x-types.filterablerequest.md)<!-- -->, [TrackableRequest](./x-types.trackablerequest.md)<!-- -->, [ExtraParamsRequest](./x-types.extraparamsrequest.md)
+

package/docs/API-reference/api/x-types.facetsresponse.facets.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [FacetsResponse](./x-types.facetsresponse.md) &gt; [facets](./x-types.facetsresponse.facets.md)
+
+## FacetsResponse.facets property
+
+**Signature:**
+
+```typescript
+facets?: Facet[];
+```

package/docs/API-reference/api/x-types.facetsresponse.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [FacetsResponse](./x-types.facetsresponse.md)
+
+## FacetsResponse interface
+
+Response for the facet endpoint.
+
+**Signature:**
+
+```typescript
+export interface FacetsResponse 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [facets?](./x-types.facetsresponse.facets.md) |  | [Facet](./x-types.facet.md)<!-- -->\[\] | _(Optional)_ |
+

package/docs/API-reference/api/x-types.md

@@ -48,6 +48,8 @@ Entry point to export search-type models and testing schemas in a unified api-ex
 |  [ExtraParamsRequest](./x-types.extraparamsrequest.md) | Interface to support extra params in any request. |
 |  [Facet](./x-types.facet.md) | Facet is a trait for filtering results. It uses [Filter](./x-types.filter.md) as filters. |
 |  [FacetFilter](./x-types.facetfilter.md) | A filter which is associated with a [Facet](./x-types.facet.md)<!-- -->. |
+|  [FacetsRequest](./x-types.facetsrequest.md) | The Request for the Facets endpoint. |
+|  [FacetsResponse](./x-types.facetsresponse.md) | Response for the facet endpoint. |
 |  [Filter](./x-types.filter.md) | A basic filter. |
 |  [FilterableRequest](./x-types.filterablerequest.md) | Interface for any Request with a <code>filters</code> parameter. |
 |  [HierarchicalFacet](./x-types.hierarchicalfacet.md) | Hierarchical facet is a trait for filtering results. It extends from [Facet](./x-types.facet.md) changes the modelName and uses [HierarchicalFilter](./x-types.hierarchicalfilter.md) as filters. |

package/docs/API-reference/api/x-types.xcomponentsadapter.facets.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-types](./x-types.md) &gt; [XComponentsAdapter](./x-types.xcomponentsadapter.md) &gt; [facets](./x-types.xcomponentsadapter.facets.md)
+
+## XComponentsAdapter.facets property
+
+**Signature:**
+
+```typescript
+facets: EndpointAdapter<FacetsRequest, FacetsResponse>;
+```

package/docs/API-reference/api/x-types.xcomponentsadapter.md

@@ -22,6 +22,7 @@ export interface XComponentsAdapter
 |  [aiSummarize](./x-types.xcomponentsadapter.aisummarize.md) |  | EndpointAdapter&lt;[AiSuggestionsRequest](./x-types.aisuggestionsrequest.md)<!-- -->, Response&gt; |  |
 |  [aiTasks](./x-types.xcomponentsadapter.aitasks.md) |  | EndpointAdapter&lt;[AiTasksRequest](./x-types.aitasksrequest.md)<!-- -->, [AiTasksResponse](./x-types.aitasksresponse.md)<!-- -->&gt; |  |
 |  [experienceControls](./x-types.xcomponentsadapter.experiencecontrols.md) |  | EndpointAdapter&lt;[ExperienceControlsRequest](./x-types.experiencecontrolsrequest.md)<!-- -->, [ExperienceControlsResponse](./x-types.experiencecontrolsresponse.md)<!-- -->&gt; |  |
+|  [facets](./x-types.xcomponentsadapter.facets.md) |  | EndpointAdapter&lt;[FacetsRequest](./x-types.facetsrequest.md)<!-- -->, [FacetsResponse](./x-types.facetsresponse.md)<!-- -->&gt; |  |
 |  [identifierResults](./x-types.xcomponentsadapter.identifierresults.md) |  | EndpointAdapter&lt;[IdentifierResultsRequest](./x-types.identifierresultsrequest.md)<!-- -->, [IdentifierResultsResponse](./x-types.identifierresultsresponse.md)<!-- -->&gt; |  |
 |  [nextQueries](./x-types.xcomponentsadapter.nextqueries.md) |  | EndpointAdapter&lt;[NextQueriesRequest](./x-types.nextqueriesrequest.md)<!-- -->, [NextQueriesResponse](./x-types.nextqueriesresponse.md)<!-- -->&gt; |  |
 |  [popularSearches](./x-types.xcomponentsadapter.popularsearches.md) |  | EndpointAdapter&lt;[PopularSearchesRequest](./x-types.popularsearchesrequest.md)<!-- -->, [PopularSearchesResponse](./x-types.popularsearchesresponse.md)<!-- -->&gt; |  |

package/facets/index.js

@@ -32,6 +32,6 @@ export { facets } from '../js/x-modules/facets/store/getters/facets.getter.js';
 export { selectedFiltersByFacet } from '../js/x-modules/facets/store/getters/selected-filters-by-facet.getter.js';
 export { selectedFilters } from '../js/x-modules/facets/store/getters/selected-filters.getter.js';
 export { facetsXStoreModule } from '../js/x-modules/facets/store/module.js';
-export { flatHierarchicalFilters } from '../js/x-modules/facets/utils.js';
+export { applyHierarchicalSelection, flatHierarchicalFilters, flattenAllFilters } from '../js/x-modules/facets/utils.js';
 export { facetsWiring, setFiltersFromHistoryQueries, setQueryFromPreview, setSelectedFiltersFromPreview } from '../js/x-modules/facets/wiring.js';
 export { facetsXModule } from '../js/x-modules/facets/x-module.js';

package/js/index.js

@@ -270,7 +270,7 @@ export { facets } from './x-modules/facets/store/getters/facets.getter.js';
 export { selectedFiltersByFacet } from './x-modules/facets/store/getters/selected-filters-by-facet.getter.js';
 export { selectedFilters } from './x-modules/facets/store/getters/selected-filters.getter.js';
 export { facetsXStoreModule } from './x-modules/facets/store/module.js';
-export { flatHierarchicalFilters } from './x-modules/facets/utils.js';
+export { applyHierarchicalSelection, flatHierarchicalFilters, flattenAllFilters } from './x-modules/facets/utils.js';
 export { facetsWiring, setFiltersFromHistoryQueries, setQueryFromPreview, setSelectedFiltersFromPreview } from './x-modules/facets/wiring.js';
 export { facetsXModule } from './x-modules/facets/x-module.js';
 export { default as ClearHistoryQueries } from './x-modules/history-queries/components/clear-history-queries.vue.js';

package/js/x-modules/facets/store/actions/fetch-and-save-facets-response.action.js

@@ -0,0 +1,38 @@
+import { isHierarchicalFacet } from '@empathyco/x-types';
+import { createFetchAndSaveActions } from '../../../../store/utils/fetch-and-save-action.utils.js';
+import { applyHierarchicalSelection, flattenAllFilters } from '../../utils.js';
+
+const { fetchAndSave, cancelPrevious } = createFetchAndSaveActions({
+    async fetch({ dispatch, getters }) {
+        return getters.request
+            ? dispatch('fetchFacetsResponse', getters.request)
+            : Promise.resolve(null);
+    },
+    onSuccess({ commit, getters }, response) {
+        if (response !== null) {
+            const selectedFilters = getters.selectedFilters;
+            const selectedIds = new Set(Object.values(selectedFilters ?? {})
+                .filter((f) => f.selected)
+                .map((f) => f.id));
+            const facetsWithSelectedFilters = [];
+            response.facets?.forEach((facet) => {
+                if (isHierarchicalFacet(facet)) {
+                    applyHierarchicalSelection(facet.filters, selectedIds);
+                }
+                else {
+                    facet.filters.forEach((filter) => {
+                        filter.selected = selectedIds.has(filter.id);
+                    });
+                }
+                facetsWithSelectedFilters.push(facet);
+                commit('setFacet', facet);
+            });
+            commit('setFilters', flattenAllFilters(facetsWithSelectedFilters));
+        }
+    },
+});
+const fetchAndSaveFacetsResponse = fetchAndSave;
+const cancelFetchAndSaveFacetsResponse = cancelPrevious;
+
+export { cancelFetchAndSaveFacetsResponse, fetchAndSaveFacetsResponse };
+//# sourceMappingURL=fetch-and-save-facets-response.action.js.map

package/js/x-modules/facets/store/actions/fetch-and-save-facets-response.action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-and-save-facets-response.action.js","sources":["../../../../../../src/x-modules/facets/store/actions/fetch-and-save-facets-response.action.ts"],"sourcesContent":["import type { Facet, FacetsRequest, FacetsResponse, Filter } from '@empathyco/x-types'\nimport type { FacetsActionsContext } from '../types'\nimport { isHierarchicalFacet } from '@empathyco/x-types'\nimport { createFetchAndSaveActions } from '../../../../store/utils/fetch-and-save-action.utils'\nimport { applyHierarchicalSelection, flattenAllFilters } from '../../utils'\n\nconst { fetchAndSave, cancelPrevious } = createFetchAndSaveActions<\n  FacetsActionsContext,\n  FacetsRequest | null,\n  FacetsResponse | null\n>({\n  async fetch({ dispatch, getters }) {\n    return getters.request\n      ? dispatch('fetchFacetsResponse', getters.request)\n      : Promise.resolve(null)\n  },\n  onSuccess({ commit, getters }, response) {\n    if (response !== null) {\n      const selectedFilters = getters.selectedFilters\n      const selectedIds = new Set(\n        Object.values(selectedFilters ?? {})\n          .filter((f: Filter) => f.selected)\n          .map((f: Filter) => f.id),\n      )\n      const facetsWithSelectedFilters: Facet[] = []\n\n      response.facets?.forEach((facet: Facet) => {\n        if (isHierarchicalFacet(facet)) {\n          applyHierarchicalSelection(facet.filters, selectedIds)\n        } else {\n          facet.filters.forEach((filter: Filter) => {\n            filter.selected = selectedIds.has(filter.id)\n          })\n        }\n\n        facetsWithSelectedFilters.push(facet)\n        commit('setFacet', facet)\n      })\n\n      commit('setFilters', flattenAllFilters(facetsWithSelectedFilters))\n    }\n  },\n})\n\nexport const fetchAndSaveFacetsResponse = fetchAndSave\nexport const cancelFetchAndSaveFacetsResponse = cancelPrevious\n"],"names":[],"mappings":";;;;AAMA,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,yBAAyB,CAIhE;AACA,IAAA,MAAM,KAAK,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAA;QAC/B,OAAO,OAAO,CAAC,OAAO;cAClB,QAAQ,CAAC,qBAAqB,EAAE,OAAO,CAAC,OAAO,CAAC;AAClD,cAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;KAC1B;AACD,IAAA,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAA;AACrC,QAAA,IAAI,QAAQ,KAAK,IAAI,EAAE;AACrB,YAAA,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,CAAA;AAC/C,YAAA,MAAM,WAAW,GAAG,IAAI,GAAG,CACzB,MAAM,CAAC,MAAM,CAAC,eAAe,IAAI,EAAE,CAAC;iBACjC,MAAM,CAAC,CAAC,CAAS,KAAK,CAAC,CAAC,QAAQ,CAAC;iBACjC,GAAG,CAAC,CAAC,CAAS,KAAK,CAAC,CAAC,EAAE,CAAC,CAC5B,CAAA;YACD,MAAM,yBAAyB,GAAY,EAAE,CAAA;YAE7C,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,KAAY,KAAI;AACxC,gBAAA,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE;AAC9B,oBAAA,0BAA0B,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,CAAA;iBACvD;qBAAM;oBACL,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAc,KAAI;wBACvC,MAAM,CAAC,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;AAC9C,qBAAC,CAAC,CAAA;iBACH;AAED,gBAAA,yBAAyB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACrC,gBAAA,MAAM,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;AAC3B,aAAC,CAAC,CAAA;YAEF,MAAM,CAAC,YAAY,EAAE,iBAAiB,CAAC,yBAAyB,CAAC,CAAC,CAAA;SACnE;KACF;AACF,CAAA,CAAC,CAAA;AAEK,MAAM,0BAA0B,GAAG,aAAY;AAC/C,MAAM,gCAAgC,GAAG;;;;"}

package/js/x-modules/facets/store/actions/fetch-facets-response.action.js

@@ -0,0 +1,16 @@
+import { XPlugin } from '../../../../plugins/x-plugin.js';
+
+/**
+ * Default implementation for the {@link FacetsActions.fetchFacetsResponse}.
+ *
+ * @param _context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,
+ * provided by Vuex.
+ * @param request - The facets request to make.
+ * @returns A Promise of facets response that resolves when it fetches facets response.
+ *
+ * @public
+ */
+const fetchFacetsResponse = async (_context, request) => XPlugin.adapter.facets(request);
+
+export { fetchFacetsResponse };
+//# sourceMappingURL=fetch-facets-response.action.js.map

package/js/x-modules/facets/store/actions/fetch-facets-response.action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-facets-response.action.js","sources":["../../../../../../src/x-modules/facets/store/actions/fetch-facets-response.action.ts"],"sourcesContent":["import type { FacetsXStoreModule } from '../types'\nimport { XPlugin } from '../../../../plugins/x-plugin'\n\n/**\n * Default implementation for the {@link FacetsActions.fetchFacetsResponse}.\n *\n * @param _context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,\n * provided by Vuex.\n * @param request - The facets request to make.\n * @returns A Promise of facets response that resolves when it fetches facets response.\n *\n * @public\n */\nexport const fetchFacetsResponse: FacetsXStoreModule['actions']['fetchFacetsResponse'] = async (\n  _context,\n  request,\n) => XPlugin.adapter.facets(request)\n"],"names":[],"mappings":";;AAGA;;;;;;;;;AASG;MACU,mBAAmB,GAAyD,OACvF,QAAQ,EACR,OAAO,KACJ,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO;;;;"}

package/js/x-modules/facets/store/actions/save-origin.action.js

@@ -0,0 +1,16 @@
+import { createOrigin } from '../../../../utils/origin.js';
+
+/**
+ * Default implementation for the {@link FacetsActions.saveOrigin}.
+ *
+ * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,
+ * provided by Vuex.
+ * @param queryOriginInit - The object to create the {@link QueryOrigin} with.
+ * @public
+ */
+const saveOrigin = ({ commit }, queryOriginInit) => {
+    commit('setOrigin', createOrigin(queryOriginInit));
+};
+
+export { saveOrigin };
+//# sourceMappingURL=save-origin.action.js.map

package/js/x-modules/facets/store/actions/save-origin.action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"save-origin.action.js","sources":["../../../../../../src/x-modules/facets/store/actions/save-origin.action.ts"],"sourcesContent":["import type { QueryOrigin } from '../../../../types/origin'\nimport type { FacetsXStoreModule } from '../types'\nimport { createOrigin } from '../../../../utils/origin'\n\n/**\n * Default implementation for the {@link FacetsActions.saveOrigin}.\n *\n * @param context - The {@link https://vuex.vuejs.org/guide/actions.html | context} of the actions,\n * provided by Vuex.\n * @param queryOriginInit - The object to create the {@link QueryOrigin} with.\n * @public\n */\nexport const saveOrigin: FacetsXStoreModule['actions']['saveOrigin'] = (\n  { commit },\n  queryOriginInit,\n) => {\n  commit('setOrigin', createOrigin(queryOriginInit) as QueryOrigin | null)\n}\n"],"names":[],"mappings":";;AAIA;;;;;;;AAOG;AACU,MAAA,UAAU,GAAgD,CACrE,EAAE,MAAM,EAAE,EACV,eAAe,KACb;IACF,MAAM,CAAC,WAAW,EAAE,YAAY,CAAC,eAAe,CAAuB,CAAC,CAAA;AAC1E;;;;"}