@coveo/quantic 3.43.5 → 3.44.0

package/docs/out/quantic-docs.json

@@ -2666,7 +2666,7 @@
                 ],
                 "fires": "",
                 "examples": [
-                    "<c-quantic-timeframe-facet engine-id={engineId} field=\"Date\" label=\"Indexed Date\" is-collapsed with-date-picker>\n  <c-quantic-timeframe period=\"past\" unit=\"year\" amount=\"10\" label=\"Past decade\"></c-quantic-timeframe>\n</c-quantic-timeframe-facet>"
+                    "<c-quantic-timeframe-facet engine-id={engineId} field=\"Date\" label=\"Indexed Date\" is-collapsed with-date-picker generate-automatic-ranges>\n  <c-quantic-timeframe period=\"past\" unit=\"year\" amount=\"10\" label=\"Past decade\"></c-quantic-timeframe>\n</c-quantic-timeframe-facet>"
                 ],
                 "xmlMeta": {
                     "apiVersion": "53.0",
@@ -2754,6 +2754,15 @@
                         "required": true,
                         "defaultValue": "",
                         "type": "DependsOn"
+                    },
+                    {
+                        "name": "generateAutomaticRanges",
+                        "attribute": "generate-automatic-ranges",
+                        "access": "@api",
+                        "description": "<p>Whether to generate automatic ranges for the facet in addition to the manually defined <code>c-quantic-timeframe</code> ranges.</p>",
+                        "required": false,
+                        "defaultValue": "`false`",
+                        "type": "boolean"
                     }
                 ]
             }
@@ -6156,7 +6165,7 @@
                 ],
                 "fires": "",
                 "examples": [
-                    "<c-quantic-timeframe-facet engine-id={engineId} field=\"Date\" label=\"Indexed Date\" is-collapsed with-date-picker>\n  <c-quantic-timeframe period=\"past\" unit=\"year\" amount=\"10\" label=\"Past decade\"></c-quantic-timeframe>\n</c-quantic-timeframe-facet>"
+                    "<c-quantic-timeframe-facet engine-id={engineId} field=\"Date\" label=\"Indexed Date\" is-collapsed with-date-picker generate-automatic-ranges>\n  <c-quantic-timeframe period=\"past\" unit=\"year\" amount=\"10\" label=\"Past decade\"></c-quantic-timeframe>\n</c-quantic-timeframe-facet>"
                 ],
                 "xmlMeta": {
                     "apiVersion": "53.0",
@@ -6244,6 +6253,15 @@
                         "required": true,
                         "defaultValue": "",
                         "type": "DependsOn"
+                    },
+                    {
+                        "name": "generateAutomaticRanges",
+                        "attribute": "generate-automatic-ranges",
+                        "access": "@api",
+                        "description": "<p>Whether to generate automatic ranges for the facet in addition to the manually defined <code>c-quantic-timeframe</code> ranges.</p>",
+                        "required": false,
+                        "defaultValue": "`false`",
+                        "type": "boolean"
                     }
                 ]
             },

package/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();

package/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),