[CI-5649] Add pre filter expression per section (#447)

* add pre filter expression per section

* remove only

* Update and add test

---------

Co-authored-by: Enes Kutay SEZEN <eneskutaysezen@gmail.com>

Author: stanlp1

spec/src/modules/autocomplete.js

@@ -428,6 +428,77 @@ describe(`ConstructorIO - Autocomplete${bundledDescriptionSuffix}`, () => {
       });
     });
 
+    it('Should return a response with a valid query and preFilterExpressionPerSection', (done) => {
+      const preFilterExpressionPerSection = {
+        Products: {
+          or: [
+            {
+              and: [
+                { name: 'group_id', value: 'BrandXY' },
+                { name: 'Color', value: 'red' },
+              ],
+            },
+            {
+              and: [
+                { name: 'Color', value: 'blue' },
+                { name: 'Brand', value: 'XYZ' },
+              ],
+            },
+          ],
+        },
+      };
+      const { autocomplete } = new ConstructorIO({
+        apiKey: testApiKey,
+        fetch: fetchSpy,
+      });
+
+      autocomplete.getAutocompleteResults(query, { preFilterExpressionPerSection }).then((res) => {
+        const requestedUrlParams = helpers.extractUrlParamsFromFetch(fetchSpy);
+
+        expect(res).to.have.property('request').to.be.an('object');
+        expect(res).to.have.property('result_id').to.be.an('string');
+        expect(requestedUrlParams.pre_filter_expression).to.have.property('Products');
+        // Parse before comparing so an accidental double-serialization would fail this assertion
+        const products = JSON.parse(requestedUrlParams.pre_filter_expression.Products);
+        expect(products).to.eql(preFilterExpressionPerSection.Products);
+        done();
+      });
+    });
+
+    it('Should return a response with a valid query, and multiple preFilterExpressionPerSection', (done) => {
+      const preFilterExpressionPerSection = {
+        Products: {
+          and: [
+            { name: 'group_id', value: 'BrandXY' },
+            { name: 'Color', value: 'red' },
+          ],
+        },
+        'Search Suggestions': {
+          and: [
+            { name: 'Brand', value: 'XYZ' },
+          ],
+        },
+      };
+      const { autocomplete } = new ConstructorIO({
+        apiKey: testApiKey,
+        fetch: fetchSpy,
+      });
+
+      autocomplete.getAutocompleteResults(query, { preFilterExpressionPerSection }).then((res) => {
+        const requestedUrlParams = helpers.extractUrlParamsFromFetch(fetchSpy);
+
+        expect(res).to.have.property('request').to.be.an('object');
+        expect(res).to.have.property('result_id').to.be.an('string');
+        expect(requestedUrlParams.pre_filter_expression).to.have.property('Products');
+        expect(requestedUrlParams.pre_filter_expression).to.have.property('Search Suggestions');
+        const products = JSON.parse(requestedUrlParams.pre_filter_expression.Products);
+        const searchSuggestions = JSON.parse(requestedUrlParams.pre_filter_expression['Search Suggestions']);
+        expect(products).to.eql(preFilterExpressionPerSection.Products);
+        expect(searchSuggestions).to.eql(preFilterExpressionPerSection['Search Suggestions']);
+        done();
+      });
+    });
+
     it('Should return a response with a valid query, section and fmtOptions', (done) => {
       const hiddenFields = ['testField', 'hiddenField2'];
       const fmtOptions = { hidden_fields: hiddenFields };

src/modules/autocomplete.js

@@ -51,6 +51,7 @@ function createAutocompleteUrl(query, parameters, options) {
       hiddenFields,
       variationsMap,
       preFilterExpression,
+      preFilterExpressionPerSection,
       qsParam,
       fmtOptions,
     } = parameters;
@@ -84,6 +85,13 @@ function createAutocompleteUrl(query, parameters, options) {
       queryParams.pre_filter_expression = JSON.stringify(preFilterExpression);
     }
 
+    // Pull filter expression per section from parameters
+    if (preFilterExpressionPerSection) {
+      Object.keys(preFilterExpressionPerSection).forEach((section) => {
+        queryParams[`pre_filter_expression[${section}]`] = JSON.stringify(preFilterExpressionPerSection[section]);
+      });
+    }
+
     // Pull format options from parameters
     if (fmtOptions) {
       queryParams.fmt_options = fmtOptions;
@@ -144,6 +152,7 @@ class Autocomplete {
    * @param {object} [parameters.resultsPerSection] - Number of results to return (value) per section (key)
    * @param {object} [parameters.fmtOptions] - An object containing options to format different aspects of the response. Please refer to https://docs.constructor.com/reference/v1-autocomplete-get-autocomplete-results for details
    * @param {object} [parameters.preFilterExpression] - Faceting expression to scope autocomplete results. Please refer to https://docs.constructor.com/reference/configuration-collections for details
+   * @param {object} [parameters.preFilterExpressionPerSection] - Faceting expression to scope autocomplete results per section (key). Please refer to https://docs.constructor.com/reference/configuration-collections for details
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
    * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details
    * @param {object} [parameters.qsParam] - object of additional query parameters to be appended to requests for results

src/types/autocomplete.d.ts

@@ -20,6 +20,7 @@ export interface IAutocompleteParameters {
   hiddenFields?: string[];
   variationsMap?: VariationsMap;
   preFilterExpression?: FilterExpression;
+  preFilterExpressionPerSection?: Record<string, FilterExpression>;
   qsParam?: Record<string, any>;
   fmtOptions?: FmtOptions;
 }