feat(quantic): addition of the ability to generate automatic ranges in timeframe facets

.changeset/quantic-timeframe-facet-automatic-ranges.md

@@ -0,0 +1,5 @@
+---
+'@coveo/quantic': minor
+---
+
+Added the `generateAutomaticRanges` public property to `QuanticTimeframeFacet`, allowing the component to display automatically generated date ranges returned by the API in addition to manually defined `c-quantic-timeframe` ranges.

packages/quantic/force-app/examples/main/lwc/exampleQuanticTimeframeFacet/exampleQuanticTimeframeFacet.html

@@ -14,7 +14,8 @@
         field={config.field}
         label={config.label}
         with-date-picker={config.withDatePicker}
-        is-collapsed={config.isCollapsed}>
+        is-collapsed={config.isCollapsed}
+        generate-automatic-ranges={config.generateAutomaticRanges}>
         <c-quantic-timeframe period="next" unit="year"></c-quantic-timeframe>
         <c-quantic-timeframe amount="2" unit="week"></c-quantic-timeframe>
         <c-quantic-timeframe unit="month"></c-quantic-timeframe>

packages/quantic/force-app/examples/main/lwc/exampleQuanticTimeframeFacet/exampleQuanticTimeframeFacet.js

@@ -33,6 +33,13 @@ export default class ExampleQuanticTimeframeFacet extends LightningElement {
       description: 'Whether the facet is initially collapsed.',
       defaultValue: false,
     },
+    {
+      attribute: 'generateAutomaticRanges',
+      label: 'Generate automatic ranges',
+      description:
+        'Whether to generate automatic ranges for the facet in addition to the manually defined ranges.',
+      defaultValue: false,
+    },
     {
       attribute: 'useCase',
       label: 'Use Case',

packages/quantic/force-app/main/default/lwc/quanticTimeframeFacet/__tests__/quanticTimeframeFacet.test.js

@@ -252,6 +252,28 @@ describe('c-quantic-timeframe-facet', () => {
       );
     });
 
+    it('should build the facet controller with generateAutomaticRanges set to true when the generateAutomaticRanges property is set to true', async () => {
+      createTestComponent({
+        ...defaultOptions,
+        generateAutomaticRanges: true,
+      });
+      await flushPromises();
+
+      expect(functionsMocks.buildDateFacet).toHaveBeenCalledTimes(1);
+      expect(functionsMocks.buildDateFacet).toHaveBeenCalledWith(
+        exampleEngine,
+        expect.objectContaining({
+          options: expect.objectContaining({
+            field: defaultOptions.field,
+            facetId: defaultOptions.facetId,
+            generateAutomaticRanges: true,
+            sortCriteria: 'descending',
+            injectionDepth: defaultOptions.injectionDepth,
+          }),
+        })
+      );
+    });
+
     it('should register the facet to the quantic store', async () => {
       const expectedFacetType = 'dateFacets';
       const element = createTestComponent();

packages/quantic/force-app/main/default/lwc/quanticTimeframeFacet/quanticTimeframeFacet.js

@@ -72,7 +72,7 @@ import {api, LightningElement, track} from 'lwc';
  * @category Search
  * @category Insight Panel
  * @example
- * <c-quantic-timeframe-facet engine-id={engineId} field="Date" label="Indexed Date" is-collapsed with-date-picker>
+ * <c-quantic-timeframe-facet engine-id={engineId} field="Date" label="Indexed Date" is-collapsed with-date-picker generate-automatic-ranges>
  *   <c-quantic-timeframe period="past" unit="year" amount="10" label="Past decade"></c-quantic-timeframe>
  * </c-quantic-timeframe-facet>
  */
@@ -156,6 +156,13 @@ export default class QuanticTimeframeFacet extends LightningElement {
    * @type {DependsOn}
    */
   @api dependsOn;
+  /**
+   * Whether to generate automatic ranges for the facet in addition to the manually defined `c-quantic-timeframe` ranges.
+   * @api
+   * @type {boolean}
+   * @defaultValue `false`
+   */
+  @api generateAutomaticRanges = false;
 
   static attributes = [
     'facetId',
@@ -165,6 +172,7 @@ export default class QuanticTimeframeFacet extends LightningElement {
     'noFilterFacetCount',
     'injectionDepth',
     'dependsOn',
+    'generateAutomaticRanges',
   ];
 
   /** @type {DateFacetState} */
@@ -476,7 +484,7 @@ export default class QuanticTimeframeFacet extends LightningElement {
       options: {
         field: this.field,
         currentValues: this.currentValues,
-        generateAutomaticRanges: false,
+        generateAutomaticRanges: this.generateAutomaticRanges,
         sortCriteria: 'descending',
         filterFacetCount: !this.noFilterFacetCount,
         injectionDepth: Number(this.injectionDepth),