From fa6a88d90b7d22575b0b71a6395c3589bbebf9d1 Mon Sep 17 00:00:00 2001
From: jpmarceau <39384459+jpmarceau@users.noreply.github.com>
Date: Mon, 10 Feb 2025 11:03:06 -0500
Subject: [PATCH] docs(headless-react): more facet docs (#4952)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

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)
---
 .../headless-commerce-facet-generator.ssr.ts          |  2 ++
 .../location/headless-commerce-location-facet.ts      | 11 +++++++++++
 .../facets/regular/headless-commerce-regular-facet.ts |  8 ++++++++
 packages/headless/src/ssr-commerce.index.ts           |  2 ++
 4 files changed, 23 insertions(+)

diff --git a/packages/headless/src/controllers/commerce/core/facets/generator/headless-commerce-facet-generator.ssr.ts b/packages/headless/src/controllers/commerce/core/facets/generator/headless-commerce-facet-generator.ssr.ts
index 020cf191627..2305c73ec9c 100644
--- a/packages/headless/src/controllers/commerce/core/facets/generator/headless-commerce-facet-generator.ssr.ts
+++ b/packages/headless/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/packages/headless/src/controllers/commerce/core/facets/location/headless-commerce-location-facet.ts b/packages/headless/src/controllers/commerce/core/facets/location/headless-commerce-location-facet.ts
index 06011ad9d36..234e93deb61 100644
--- a/packages/headless/src/controllers/commerce/core/facets/location/headless-commerce-location-facet.ts
+++ b/packages/headless/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/packages/headless/src/controllers/commerce/core/facets/regular/headless-commerce-regular-facet.ts b/packages/headless/src/controllers/commerce/core/facets/regular/headless-commerce-regular-facet.ts
index cb2ded25ac1..c0404406151 100644
--- a/packages/headless/src/controllers/commerce/core/facets/regular/headless-commerce-regular-facet.ts
+++ b/packages/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
index bce6f3836f8..fda647ca7fe 100644
--- 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,