docs(headless-react): more facet docs (#4952)

https://coveord.atlassian.net/browse/DOC-16501 We were missing documentation for location facets and for facet attributes coming from CoreCommerceFacets. E.g., ![Screenshot 2025-02-07 at 12 25 15 PM](https://github.com/user-attachments/assets/64a8f18c-ea85-4727-a5f1-7ef2d6be9b8a) vs ![Screenshot 2025-02-07 at 12 25 29 PM](https://github.com/user-attachments/assets/3b52d77e-432b-41f6-833e-f15570254b5b) and ![Screenshot 2025-02-07 at 12 26 08 PM](https://github.com/user-attachments/assets/45166bbb-b116-4dd3-a5f5-d0d5809e2e06)
coveo · Feb 10, 2025 · fa6a88d · fa6a88d
1 parent 08648b4
commit fa6a88d
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 0 deletions.
diff --git a/...s/src/controllers/commerce/core/facets/generator/headless-commerce-facet-generator.ssr.ts b/...s/src/controllers/commerce/core/facets/generator/headless-commerce-facet-generator.ssr.ts
@@ -45,6 +45,7 @@ import {
   CategoryFacetValue,
   FacetType,
   getCoreFacetState,
+  CoreCommerceFacet,
 } from '../headless-core-commerce-facet.js';
 import {
   getLocationFacetState,
@@ -73,6 +74,7 @@ export type {
   CategoryFacetState,
   CategoryFacetValue,
   CategoryFacetSearchResult,
+  CoreCommerceFacet,
   DateFacet,
   DateFacetValue,
   DateFacetState,

diff --git a/...eadless/src/controllers/commerce/core/facets/location/headless-commerce-location-facet.ts b/...eadless/src/controllers/commerce/core/facets/location/headless-commerce-location-facet.ts
@@ -10,11 +10,19 @@ import {
   buildCoreCommerceFacet,
 } from '../headless-core-commerce-facet.js';
 
+/**
+ * @group Sub-controllers
+ * @category LocationFacet
+ */
 export type LocationFacetOptions = Omit<
   CoreCommerceFacetOptions,
   'toggleSelectActionCreator' | 'toggleExcludeActionCreator'
 >;
 
+/**
+ * @group Sub-controllers
+ * @category LocationFacet
+ */
 export type LocationFacetState = Omit<
   CoreCommerceFacetState<LocationFacetValue>,
   'type'
@@ -25,6 +33,9 @@ export type LocationFacetState = Omit<
 /**
  * The `LocationFacet` sub-controller offers a high-level programming interface for implementing a location commerce
  * facet UI component.
+ *
+ * @group Sub-controllers
+ * @category LocationFacet
  */
 export type LocationFacet = Omit<
   CoreCommerceFacet<FacetValueRequest, LocationFacetValue>,

diff --git a/.../headless/src/controllers/commerce/core/facets/regular/headless-commerce-regular-facet.ts b/.../headless/src/controllers/commerce/core/facets/regular/headless-commerce-regular-facet.ts
@@ -21,12 +21,20 @@ import {
   buildRegularFacetSearch,
 } from './headless-commerce-regular-facet-search.js';
 
+/**
+ * @group Sub-controllers
+ * @category RegularFacet
+ */
 export type RegularFacetOptions = Omit<
   CoreCommerceFacetOptions,
   'toggleSelectActionCreator' | 'toggleExcludeActionCreator'
 > &
   SearchableFacetOptions;
 
+/**
+ * @group Sub-controllers
+ * @category RegularFacet
+ */
 export type RegularFacetState = Omit<
   CoreCommerceFacetState<RegularFacetValue>,
   'type'

diff --git a/packages/headless/src/ssr-commerce.index.ts b/packages/headless/src/ssr-commerce.index.ts
@@ -155,6 +155,7 @@ export type {
   CategoryFacetState,
   CategoryFacetValue,
   CategoryFacetSearchResult,
+  CoreCommerceFacet,
   DateFacet,
   DateFacetValue,
   DateFacetState,
@@ -169,6 +170,7 @@ export type {
   MappedGeneratedFacetController,
   MappedFacetStates,
   MappedFacetState,
+  LocationFacet,
   LocationFacetValue,
   LocationFacetState,
   FacetType,