@blaze-cms/react-page-builder 0.132.0 → 0.133.0-admin-updates.1

package/tests/unit/src/helpers/build-raw-query.test.js

@@ -32,6 +32,7 @@ const filterData = {
   relations: [],
   stringProps: []
 };
+const customProperty = 'lastname';
 
 describe('build raw query', () => {
   const {
@@ -43,17 +44,17 @@ describe('build raw query', () => {
     id,
     itemsToDisplay
   } = MOCKED_ARGS;
-  const rawQuery = buildRawQuery(
+  const rawQuery = buildRawQuery({
     docType,
     operator,
-    {
+    searchValues: {
       searchValuesText,
       searchValuesCheckboxSelectRange,
       searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
     },
     filterData,
     id
-  );
+  });
 
   it('should always return an object', () => {
     expect(typeof rawQuery).toBe('object');
@@ -64,65 +65,65 @@ describe('build raw query', () => {
   });
 
   it('should return an object with only checkbox & select search values', () => {
-    const rawQueryCheckboxSelect = buildRawQuery(
+    const rawQueryCheckboxSelect = buildRawQuery({
       docType,
       operator,
-      {
+      searchValues: {
         searchValuesText: SEARCH_VALUES_TEXT_EMPTY,
         searchValuesCheckboxSelectRange: SEARCH_VALUES_CHECKBOX_SELECT,
         searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
       },
       filterData,
       id
-    );
+    });
 
     expect(rawQueryCheckboxSelect).toEqual(RAW_QUERY_CHECKBOX_SELECT);
   });
 
   it('should return an object with only checkbox & select search values when checkbox has OR operator', () => {
-    const rawQueryCheckboxSelect = buildRawQuery(
+    const rawQueryCheckboxSelect = buildRawQuery({
       docType,
       operator,
-      {
+      searchValues: {
         searchValuesText: SEARCH_VALUES_TEXT_EMPTY,
         searchValuesCheckboxSelectRange: SEARCH_VALUES_CHECKBOX_SELECT,
         searchValuesCheckboxOr
       },
       filterData,
       id
-    );
+    });
 
     expect(rawQueryCheckboxSelect).toEqual(RAW_QUERY_CHECKBOX_SELECT_CHECKBOX_HAS_OR_OPERATOR);
   });
 
   it('should return an object with all search values (checkbox, select, text) - and same operator', () => {
-    const rawQueryCheckboxSelectTextSameOp = buildRawQuery(
+    const rawQueryCheckboxSelectTextSameOp = buildRawQuery({
       docType,
-      AND_OPERATOR,
-      {
+      operator: AND_OPERATOR,
+      searchValues: {
         searchValuesText: SEARCH_VALUES_TEXT,
         searchValuesCheckboxSelectRange: SEARCH_VALUES_CHECKBOX_SELECT,
         searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
       },
       filterData,
       id
-    );
+    });
 
     expect(rawQueryCheckboxSelectTextSameOp).toEqual(RAW_QUERY_ALL_SEARCH_VALUE_SAME_OPERATOR);
   });
 
   it('should return an object with all search values (checkbox, select, text) - and different operator', () => {
-    const rawQueryCheckboxSelectTextDifferentOp = buildRawQuery(
+    const rawQueryCheckboxSelectTextDifferentOp = buildRawQuery({
       docType,
       operator,
-      {
+      searchValues: {
         searchValuesText: SEARCH_VALUES_TEXT,
         searchValuesCheckboxSelectRange: SEARCH_VALUES_CHECKBOX_SELECT,
         searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
       },
       filterData,
       id
-    );
+    });
 
     expect(rawQueryCheckboxSelectTextDifferentOp).toEqual(
       RAW_QUERY_ALL_SEARCH_VALUE_DIFFERENT_OPERATOR
@@ -130,17 +131,17 @@ describe('build raw query', () => {
   });
 
   it('should return an object with all search values (checkbox, select, text) - same operator for text and checkbox with OR operator', () => {
-    const rawQueryCheckboxSelectTextSameOp = buildRawQuery(
+    const rawQueryCheckboxSelectTextSameOp = buildRawQuery({
       docType,
-      AND_OPERATOR,
-      {
+      operator: AND_OPERATOR,
+      searchValues: {
         searchValuesText: SEARCH_VALUES_TEXT,
         searchValuesCheckboxSelectRange: SEARCH_VALUES_CHECKBOX_SELECT,
         searchValuesCheckboxOr
       },
       filterData,
       id
-    );
+    });
 
     expect(rawQueryCheckboxSelectTextSameOp).toEqual(
       RAW_QUERY_ALL_SEARCH_VALUE_SAME_OPERATOR_TEXT_CHECKBOX_HAS_OR_OPERATOR
@@ -148,17 +149,17 @@ describe('build raw query', () => {
   });
 
   it('should return an object with all search values (checkbox, select, text) - and different operator for text and checkbox with OR operator', () => {
-    const rawQueryCheckboxSelectTextDifferentOp = buildRawQuery(
+    const rawQueryCheckboxSelectTextDifferentOp = buildRawQuery({
       docType,
       operator,
-      {
+      searchValues: {
         searchValuesText: SEARCH_VALUES_TEXT,
         searchValuesCheckboxSelectRange: SEARCH_VALUES_CHECKBOX_SELECT,
         searchValuesCheckboxOr
       },
       filterData,
       id
-    );
+    });
 
     expect(rawQueryCheckboxSelectTextDifferentOp).toEqual(
       RAW_QUERY_ALL_SEARCH_VALUE_DIFFERENT_OPERATOR_TEXT_CHECKBOX_HAS_OR_OPERATOR
@@ -166,15 +167,15 @@ describe('build raw query', () => {
   });
 
   it('should return an object with featured & sponsored filter set on list', () => {
-    const rawQueryMoreCheckboxFilters = buildRawQuery(
+    const rawQueryMoreCheckboxFilters = buildRawQuery({
       docType,
       operator,
-      {
+      searchValues: {
         searchValuesText,
         searchValuesCheckboxSelectRange,
         searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
       },
-      {
+      filterData: {
         filterValues: { checkboxFilters: ['featured', 'sponsored'], listFilterValues: {} },
         filterOperator: AND,
         relations: [],
@@ -182,42 +183,42 @@ describe('build raw query', () => {
         azFilter: 'x'
       },
       id
-    );
+    });
 
     expect(rawQueryMoreCheckboxFilters).toEqual(RAW_QUERY_CHECKBOX_FILTERS);
   });
 
   it('should return an object with just one checkbox filter set on list', () => {
-    const rawQueryOneCheckboxFilter = buildRawQuery(
+    const rawQueryOneCheckboxFilter = buildRawQuery({
       docType,
       operator,
-      {
+      searchValues: {
         searchValuesText,
         searchValuesCheckboxSelectRange,
         searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
       },
-      {
+      filterData: {
         filterValues: { checkboxFilters: ['sponsored'], listFilterValues: {} },
         filterOperator: AND,
         relations: [],
         stringProps: []
       },
       id
-    );
+    });
 
     expect(rawQueryOneCheckboxFilter).toEqual(RAW_QUERY_ONE_CHECKBOX_FILTERS);
   });
 
   it('should return an object with just one checkbox filter set on list & other filter values', () => {
-    const rawQueryOneCheckboxFilterMoreValues = buildRawQuery(
+    const rawQueryOneCheckboxFilterMoreValues = buildRawQuery({
       docType,
       operator,
-      {
+      searchValues: {
         searchValuesText,
         searchValuesCheckboxSelectRange,
         searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
       },
-      {
+      filterData: {
         filterValues: {
           checkboxFilters: ['sponsored'],
           listFilterValues: {
@@ -230,7 +231,7 @@ describe('build raw query', () => {
         stringProps: ['name', 'category.name']
       },
       id
-    );
+    });
 
     expect(rawQueryOneCheckboxFilterMoreValues).toEqual(
       RAW_QUERY_ONE_CHECKBOX_FILTERS_AND_OTHER_FILTERS
@@ -238,15 +239,15 @@ describe('build raw query', () => {
   });
 
   it('should return an object with just one checkbox filter set on list & other filter values plus itemsToDIsplayIds', () => {
-    const rawQueryOneCheckboxFilterMoreItemsToDisplayValues = buildRawQuery(
+    const rawQueryOneCheckboxFilterMoreItemsToDisplayValues = buildRawQuery({
       docType,
       operator,
-      {
+      searchValues: {
         searchValuesText,
         searchValuesCheckboxSelectRange,
         searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
       },
-      {
+      filterData: {
         filterValues: {
           checkboxFilters: ['sponsored'],
           listFilterValues: {
@@ -261,21 +262,21 @@ describe('build raw query', () => {
       },
       id,
       itemsToDisplay
-    );
+    });
 
     expect(rawQueryOneCheckboxFilterMoreItemsToDisplayValues).toEqual(RAW_QUERY_ITEMS_TO_DISPLAY);
   });
 
   it('should return an object with just one checkbox filter set on list & other filter values when the filter operator is OR', () => {
-    const rawQueryOneCheckboxFilterMoreValues = buildRawQuery(
+    const rawQueryOneCheckboxFilterMoreValues = buildRawQuery({
       docType,
       operator,
-      {
+      searchValues: {
         searchValuesText,
         searchValuesCheckboxSelectRange,
         searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
       },
-      {
+      filterData: {
         filterValues: {
           checkboxFilters: ['featured'],
           listFilterValues: { 'authors.firstname': ['John', 'Paul'], price: ['33'] }
@@ -285,7 +286,7 @@ describe('build raw query', () => {
         stringProps: ['author.firstname']
       },
       id
-    );
+    });
 
     expect(rawQueryOneCheckboxFilterMoreValues).toEqual(
       RAW_QUERY_ONE_CHECKBOX_FILTERS_AND_OTHER_FILTERS_OR_OPERATOR
@@ -293,15 +294,15 @@ describe('build raw query', () => {
   });
 
   it('should return an object with just one checkbox filter set on list & other filter values when the filter operator is OR plus itemsToDIsplayIds', () => {
-    const rawQueryOneCheckboxFilterMoreItemsToDisplayValues = buildRawQuery(
+    const rawQueryOneCheckboxFilterMoreItemsToDisplayValues = buildRawQuery({
       docType,
       operator,
-      {
+      searchValues: {
         searchValuesText,
         searchValuesCheckboxSelectRange,
         searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
       },
-      {
+      filterData: {
         filterValues: {
           checkboxFilters: ['sponsored'],
           listFilterValues: { metaTitle: ['meta', 'more-meta'], slug: ['slug-link'] }
@@ -312,7 +313,7 @@ describe('build raw query', () => {
       },
       id,
       itemsToDisplay
-    );
+    });
 
     expect(rawQueryOneCheckboxFilterMoreItemsToDisplayValues).toEqual(
       RAW_QUERY_OR_OPERATOR_ITEMS_TO_DISPLAY
@@ -320,15 +321,15 @@ describe('build raw query', () => {
   });
 
   it('should return corresponding query when there are items to display and should apply sort is passed as true', () => {
-    const rawQueryWithShouldApplySort = buildRawQuery(
+    const rawQueryWithShouldApplySort = buildRawQuery({
       docType,
       operator,
-      {
+      searchValues: {
         searchValuesText,
         searchValuesCheckboxSelectRange,
         searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
       },
-      {
+      filterData: {
         filterValues: {
           checkboxFilters: ['sponsored'],
           listFilterValues: { url: ['/url', '/alternative-url'], date: ['29-03-2020'] }
@@ -339,27 +340,119 @@ describe('build raw query', () => {
       },
       id,
       itemsToDisplay,
-      true
-    );
+      shouldApplySort: true
+    });
 
     expect(rawQueryWithShouldApplySort).toEqual(RAW_QUERY_WITH_SHOULD_APPLY_SORT);
   });
 
   it('should return query with aggs if requested', () => {
-    const queryWithAggs = buildRawQuery(
+    const queryWithAggs = buildRawQuery({
       docType,
       operator,
-      {
+      searchValues: {
         searchValuesText,
         searchValuesCheckboxSelectRange,
         searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
       },
       filterData,
       id,
-      [],
-      true,
-      { shouldReturnAggs: true, isAZ: true }
-    );
+      itemsToDisplay: [],
+      shouldApplySort: true,
+      azOptions: { shouldReturnAggs: true, isAZ: true }
+    });
+
+    expect(queryWithAggs).toEqual(RAW_QUERY_WITH_AGGS);
+  });
+
+  it('should return query with aggs if requested using custom az param', () => {
+    const queryWithAggs = buildRawQuery({
+      docType,
+      operator,
+      searchValues: {
+        searchValuesText,
+        searchValuesCheckboxSelectRange,
+        searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
+      },
+      filterData,
+      id,
+      itemsToDisplay: [],
+      shouldApplySort: true,
+      azOptions: {
+        shouldReturnAggs: true,
+        isAZ: true,
+        sortProperties: [{ propsToDisplay: [customProperty] }]
+      }
+    });
+
+    expect(JSON.stringify(queryWithAggs)).toContain(`${customProperty}.keyword`);
+  });
+
+  it('should handle filters with search where custom sort is also set', () => {
+    const queryWithAggs = buildRawQuery({
+      docType,
+      operator,
+      searchValues: {
+        searchValuesText,
+        searchValuesCheckboxSelectRange,
+        searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
+      },
+      filterData,
+      id,
+      itemsToDisplay: [],
+      shouldApplySort: true,
+      azOptions: {
+        shouldReturnAggs: false,
+        isAZ: false,
+        sortProperties: [{ isScore: true }]
+      }
+    });
+
+    expect(JSON.stringify(queryWithAggs)).not.toContain('sort');
+  });
+
+  it('should handle search filters with az listing using custom sort', () => {
+    const queryWithAggs = buildRawQuery({
+      docType,
+      operator,
+      searchValues: {
+        searchValuesText,
+        searchValuesCheckboxSelectRange,
+        searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
+      },
+      filterData,
+      id,
+      itemsToDisplay: [],
+      shouldApplySort: true,
+      azOptions: {
+        shouldReturnAggs: true,
+        isAZ: true,
+        sortProperties: [{ isScore: true }, { propsToDisplay: [customProperty] }]
+      }
+    });
+
+    expect(JSON.stringify(queryWithAggs)).toContain(`${customProperty}.keyword`);
+  });
+
+  it('should handle search filters with az listing using custom default', () => {
+    const queryWithAggs = buildRawQuery({
+      docType,
+      operator,
+      searchValues: {
+        searchValuesText,
+        searchValuesCheckboxSelectRange,
+        searchValuesCheckboxOr: searchValuesCheckboxOrEmpty
+      },
+      filterData,
+      id,
+      itemsToDisplay: [],
+      shouldApplySort: true,
+      azOptions: {
+        shouldReturnAggs: true,
+        isAZ: true,
+        sortProperties: [{ isScore: true }]
+      }
+    });
 
     expect(queryWithAggs).toEqual(RAW_QUERY_WITH_AGGS);
   });

package/tests/unit/src/helpers/build-sort-values.test.js

@@ -0,0 +1,34 @@
+import '@testing-library/jest-dom/extend-expect';
+import buildSortValues from '../../../../src/helpers/build-sort-values';
+
+describe('buildSortValues helper function', () => {
+  it('should return an object with empty sort array if no sortFilters are passed', () => {
+    const noSort = buildSortValues();
+    const emptySortFilters = buildSortValues([]);
+    expect(noSort).toEqual({ sort: [] });
+    expect(emptySortFilters).toEqual({ sort: [] });
+  });
+
+  it('should return null if no sortFilters are passed and useSortObject is true', () => {
+    const noSortUseSortObject = buildSortValues(null, [], [], true);
+    const emptySortFiltersUseSortObject = buildSortValues([], [], [], true);
+    expect(noSortUseSortObject).toEqual(null);
+    expect(emptySortFiltersUseSortObject).toEqual(null);
+  });
+
+  it('should return sort object if useSortObject is true and sortFilters match', () => {
+    const withUseSortObject = buildSortValues(
+      [
+        {
+          propsToDisplay: ['slug'],
+          sort: 'ASC',
+          label: ''
+        }
+      ],
+      [],
+      ['name', 'slug', 'metaTitle'],
+      true
+    );
+    expect(withUseSortObject).toEqual({ 'slug.keyword': 'asc' });
+  });
+});

package/tests/unit/src/helpers/get-extra-az-bits.test.js

@@ -1,21 +1,51 @@
+import { AZ_DEFAULT_PROP } from '../../../../src/constants';
 import getExtraAzBits from '../../../../src/helpers/get-extra-az-bits';
-import { AZ_AGGS, ALL_AZ_SORT } from '../../../../src/constants';
 
 describe('getExtraAzBits helper function', () => {
+  // shouldReturnAggs, isAZ, azSortProperty, azFilter
+  const customProperty = 'lastname';
+
   it('should return empty object if isAz is false', () => {
-    const noExtraBits = getExtraAzBits(false, false);
+    const noExtraBits = getExtraAzBits({ shouldReturnAggs: false, isAZ: false });
     const noExtraBits2 = getExtraAzBits(false, true, 'a');
     expect(noExtraBits).toEqual({});
     expect(noExtraBits2).toEqual({});
   });
 
   it('should return AZ_AGGS if shouldReturnAggs and isAz is true', () => {
-    const withAggs = getExtraAzBits(true, true);
-    expect(withAggs).toEqual(AZ_AGGS);
+    const withAggs = getExtraAzBits({ shouldReturnAggs: true, isAZ: true });
+    propertyCheck(withAggs);
+    expect(withAggs).toMatchSnapshot();
   });
 
   it('should return ALL_AZ_SORT if shouldReturnAggs is false and is Az and no Az filter is passed', () => {
-    const withAggs = getExtraAzBits(false, true, '');
-    expect(withAggs).toEqual(ALL_AZ_SORT);
+    const withAggs = getExtraAzBits({ shouldReturnAggs: false, isAZ: true, azFilter: '' });
+    propertyCheck(withAggs);
+    expect(withAggs).toMatchSnapshot();
+  });
+
+  it('should return AZ_AGGS if shouldReturnAggs and isAz is true with custom property', () => {
+    const withAggs = getExtraAzBits({
+      shouldReturnAggs: true,
+      isAZ: true,
+      azSortProperty: customProperty
+    });
+    propertyCheck(withAggs, customProperty);
+    expect(withAggs).toMatchSnapshot();
+  });
+
+  it('should return ALL_AZ_SORT if shouldReturnAggs is false and is Az and no Az filter is passed with custom property', () => {
+    const withAggs = getExtraAzBits({
+      shouldReturnAggs: false,
+      isAZ: true,
+      azFilter: '',
+      azSortProperty: customProperty
+    });
+    propertyCheck(withAggs, customProperty);
+    expect(withAggs).toMatchSnapshot();
   });
 });
+
+function propertyCheck(result, property = AZ_DEFAULT_PROP) {
+  expect(JSON.stringify(result)).toContain(`${property}.keyword`);
+}