feat(atomic): add identifier on atomic commerce generated facets (#4112)

https://coveord.atlassian.net/browse/KIT-3336 --------- Co-authored-by: GitHub Actions Bot <>
coveo · Jun 21, 2024 · b2a4406 · b2a4406
1 parent 9ab7ba5
commit b2a4406
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 0 deletions.
diff --git a/packages/atomic/src/components.d.ts b/packages/atomic/src/components.d.ts
@@ -274,6 +274,10 @@ export namespace Components {
           * The category facet controller instance.
          */
         "facet": CategoryFacet;
+        /**
+          * The field identifier for this facet.
+         */
+        "field"?: string;
         /**
           * Specifies whether the facet is collapsed.
          */
@@ -293,6 +297,10 @@ export namespace Components {
           * The facet controller instance.
          */
         "facet": RegularFacet;
+        /**
+          * The field identifier for this facet.
+         */
+        "field"?: string;
         /**
           * Specifies whether the facet is collapsed.
          */
@@ -404,6 +412,10 @@ export namespace Components {
           * The numeric facet controller instance.
          */
         "facet": NumericFacet;
+        /**
+          * The field identifier for this facet.
+         */
+        "field"?: string;
         /**
           * Specifies whether the facet is collapsed.
          */
@@ -676,6 +688,10 @@ export namespace Components {
           * The date facet controller instance.
          */
         "facet": DateFacet;
+        /**
+          * The field identifier for this facet.
+         */
+        "field"?: string;
         /**
           * Specifies whether the facet is collapsed.
          */
@@ -5687,6 +5703,10 @@ declare namespace LocalJSX {
           * The category facet controller instance.
          */
         "facet": CategoryFacet;
+        /**
+          * The field identifier for this facet.
+         */
+        "field"?: string;
         /**
           * Specifies whether the facet is collapsed.
          */
@@ -5706,6 +5726,10 @@ declare namespace LocalJSX {
           * The facet controller instance.
          */
         "facet": RegularFacet;
+        /**
+          * The field identifier for this facet.
+         */
+        "field"?: string;
         /**
           * Specifies whether the facet is collapsed.
          */
@@ -5806,6 +5830,10 @@ declare namespace LocalJSX {
           * The numeric facet controller instance.
          */
         "facet": NumericFacet;
+        /**
+          * The field identifier for this facet.
+         */
+        "field"?: string;
         /**
           * Specifies whether the facet is collapsed.
          */
@@ -6050,6 +6078,10 @@ declare namespace LocalJSX {
           * The date facet controller instance.
          */
         "facet": DateFacet;
+        /**
+          * The field identifier for this facet.
+         */
+        "field"?: string;
         /**
           * Specifies whether the facet is collapsed.
          */

diff --git a/...ponents/commerce/facets/atomic-commerce-category-facet/atomic-commerce-category-facet.tsx b/...ponents/commerce/facets/atomic-commerce-category-facet/atomic-commerce-category-facet.tsx
@@ -69,6 +69,10 @@ export class AtomicCategoryFacet implements InitializableComponent<Bindings> {
    * Specifies whether the facet is collapsed.
    */
   @Prop({reflect: true, mutable: true}) public isCollapsed = false;
+  /**
+   * The field identifier for this facet.
+   */
+  @Prop({reflect: true}) field?: string;
 
   @BindStateToController('facet')
   @State()

diff --git a/...ges/atomic/src/components/commerce/facets/atomic-commerce-facet/atomic-commerce-facet.tsx b/...ges/atomic/src/components/commerce/facets/atomic-commerce-facet/atomic-commerce-facet.tsx
@@ -71,6 +71,10 @@ export class AtomicCommerceFacet implements InitializableComponent<Bindings> {
    * Specifies whether the facet is collapsed.
    */
   @Prop({reflect: true, mutable: true}) public isCollapsed = false;
+  /**
+   * The field identifier for this facet.
+   */
+  @Prop({reflect: true}) field?: string;
 
   @BindStateToController('facet')
   @State()

diff --git a/...s/atomic/src/components/commerce/facets/atomic-commerce-facets/atomic-commerce-facets.tsx b/...s/atomic/src/components/commerce/facets/atomic-commerce-facets/atomic-commerce-facets.tsx
@@ -103,6 +103,7 @@ export class AtomicCommerceFacets implements InitializableComponent<Bindings> {
             isCollapsed: this.shouldCollapseFacet(index),
             summary: this.summary,
             facet: facet as T,
+            field: facet.state.field,
           });
 
           switch (facet.state.type) {

diff --git a/...omponents/commerce/facets/atomic-commerce-numeric-facet/atomic-commerce-numeric-facet.tsx b/...omponents/commerce/facets/atomic-commerce-numeric-facet/atomic-commerce-numeric-facet.tsx
@@ -68,6 +68,10 @@ export class AtomicCommerceNumericFacet
    * Specifies whether the facet is collapsed.
    */
   @Prop({reflect: true, mutable: true}) public isCollapsed = false;
+  /**
+   * The field identifier for this facet.
+   */
+  @Prop({reflect: true}) field?: string;
 
   private headerFocus?: FocusTargetController;
 

diff --git a/...nents/commerce/facets/atomic-commerce-timeframe-facet/atomic-commerce-timeframe-facet.tsx b/...nents/commerce/facets/atomic-commerce-timeframe-facet/atomic-commerce-timeframe-facet.tsx
@@ -57,6 +57,10 @@ export class AtomicCommerceTimeframeFacet
    * Specifies whether the facet is collapsed.
    */
   @Prop({reflect: true, mutable: true}) public isCollapsed = false;
+  /**
+   * The field identifier for this facet.
+   */
+  @Prop({reflect: true}) field?: string;
 
   @BindStateToController('facet')
   @State()