@blaze-cms/react-page-builder 0.132.0 → 0.133.0-alpha.0

package/src/components/List/helpers/get-list-query.js

@@ -1,9 +1,11 @@
+import { AZ_QUERY_CONST, PB_QUERY_CONST } from '../../../constants';
 import stripQueryKey from './strip-query-key';
 
 const getListQuery = (query, hasListSpecificFilters, name) => {
   const updatedQuery = {};
-  const listKey = `pb[${name}]`;
+  const listKey = `${PB_QUERY_CONST}[${name}]`;
   const paginationKey = `${listKey}[page]`;
+  const azFilterKey = `${listKey}${AZ_QUERY_CONST}`;
   const sortKey = `${listKey}[sort]`;
   const sortByKey = `${listKey}[sortby]`;
 
@@ -16,8 +18,9 @@ const getListQuery = (query, hasListSpecificFilters, name) => {
       const strippedKey = stripQueryKey(queryKey, listKey, paginationKey);
       if (isListKey) updatedQuery[strippedKey] = decodedQueryValue;
     } else {
-      if (queryKey.indexOf('pb[') === -1) updatedQuery[queryKey] = decodedQueryValue;
+      if (queryKey.indexOf(`${PB_QUERY_CONST}[`) === -1) updatedQuery[queryKey] = decodedQueryValue;
       if (queryKey.indexOf(paginationKey) !== -1) updatedQuery[queryKey] = decodedQueryValue;
+      if (queryKey.indexOf(azFilterKey) !== -1) updatedQuery[queryKey] = decodedQueryValue;
     }
   });
   updatedQuery.sort = query[sortKey] || query.sort;

package/src/components/List/helpers/get-sort-props.js

@@ -1,10 +1,18 @@
-const getSortProps = ({ querySort, sortProperties, defaultSort, querySortBy, defaultSortBy }) => {
+const getSortProps = ({
+  querySort,
+  sortProperties,
+  defaultSort,
+  querySortBy,
+  defaultSortBy,
+  isTextSearchFilterApplied
+}) => {
   const sort = querySort || (sortProperties.length ? null : defaultSort);
   let sortby = null;
   if (querySortBy) sortby = [querySortBy];
   else if (!sortProperties.length) sortby = defaultSortBy;
 
   const updatedSortProperties = [...sortProperties];
+  if (isTextSearchFilterApplied) updatedSortProperties.unshift({ isScore: true });
   if (sort) updatedSortProperties.unshift({ sort, propsToDisplay: sortby });
 
   const sortbyFilters = updatedSortProperties

package/src/constants/index.js

@@ -161,36 +161,7 @@ const AZ = [
   'Z'
 ];
 
-const AZ_AGGS = {
-  aggs: {
-    azCount: {
-      terms: {
-        script: "doc['name.keyword'].getValue().substring(0,1).toUpperCase()",
-        size: 500
-      }
-    }
-  },
-  sort: [{ 'name.keyword': 'asc' }]
-};
-const ALL_AZ_SORT = {
-  sort: [
-    {
-      _script: {
-        type: 'number',
-        script: {
-          lang: 'painless',
-          source:
-            "int charPos = params.letters.indexOf(doc['name.keyword'].value.substring(0,1).toUpperCase()); charPos > -1 ? charPos : 100",
-          params: {
-            letters: AZ
-          }
-        },
-        order: 'asc'
-      }
-    },
-    { 'name.keyword': 'asc' }
-  ]
-};
+const AZ_DEFAULT_PROP = 'name';
 
 const SCROLL_OFFSET = process.env.BLAZE_SCROLL_OFFSET || 50;
 
@@ -302,8 +273,7 @@ export {
   PREHEADER_PROP,
   HEADLINE_PROP,
   AZ_QUERY_CONST,
-  AZ_AGGS,
-  ALL_AZ_SORT,
+  AZ_DEFAULT_PROP,
   AZ,
   SCROLL_OFFSET,
   ANCHOR_TAG,

package/src/helpers/build-az-filter.js

@@ -1,9 +1,10 @@
-const buildAzFilter = (azFilter, mustFilters) => {
+const buildAzFilter = (azFilter, mustFilters, azSortProperty) => {
   if (!azFilter) return;
   const filterValue = azFilter === '0' ? '[^a-zA-Z]' : azFilter;
+  const azSortProp = `${azSortProperty}.keyword`;
   const azQuery = {
     regexp: {
-      'name.keyword': {
+      [azSortProp]: {
         value: `${filterValue}.*`,
         case_insensitive: true
       }

package/src/helpers/build-raw-query.js

@@ -2,9 +2,9 @@ import buildRawQueryBase from './build-raw-query-base';
 import getItemsToDisplayIds from './get-items-to-display-ids';
 import getExtraAzBits from './get-extra-az-bits';
 import buildAzFilter from './build-az-filter';
-import { AND_OPERATOR } from '../constants';
+import { AND_OPERATOR, AZ_DEFAULT_PROP } from '../constants';
 
-const buildRawQuery = (
+const buildRawQuery = ({
   docType,
   operator,
   searchValues,
@@ -13,15 +13,17 @@ const buildRawQuery = (
   itemsToDisplay,
   shouldApplySort,
   azOptions
-) => {
+}) => {
   const {
     searchValuesText,
     searchValuesCheckboxSelectRange,
     searchValuesCheckboxOr
   } = searchValues;
-
   const { filterValues, filterOperator, relations, stringProps, azFilter } = filterData;
-  const { shouldReturnAggs, isAZ } = azOptions || {};
+  const { isAZ, sortProperties = [] } = azOptions || {};
+  const [{ propsToDisplay: [azSortProp] } = { propsToDisplay: [] }] = sortProperties;
+  const azSortProperty = azSortProp || AZ_DEFAULT_PROP;
+
   const searchValuesTextCheckboxSelectJoined =
     operator === AND_OPERATOR ? [...searchValuesText, ...searchValuesCheckboxSelectRange] : [];
   let searchValuesTextCheckboxOr = searchValuesText;
@@ -50,7 +52,7 @@ const buildRawQuery = (
     }
   ];
 
-  buildAzFilter(azFilter, mustValues);
+  buildAzFilter(azFilter, mustValues, azSortProperty);
 
   const query = {
     bool: {
@@ -58,7 +60,7 @@ const buildRawQuery = (
       ...buildRawQueryBase({ docType, id, filterValues, filterOperator, relations, stringProps })
     }
   };
-  const azQueryBits = getExtraAzBits(shouldReturnAggs, isAZ, azFilter);
+  const azQueryBits = getExtraAzBits({ ...azOptions, azSortProperty, azFilter });
 
   if (itemsToDisplay && itemsToDisplay.length) {
     const itemsToDisplayIds = getItemsToDisplayIds(itemsToDisplay);

package/src/helpers/build-sort-values.js

@@ -0,0 +1,32 @@
+import getSortbyFieldName from './get-sort-by-field-name';
+
+const buildAzSort = (sortFilters, relations, stringProps) => {
+  const sortValues = {};
+  sortFilters.forEach(({ sort, propsToDisplay }) => {
+    if (!sort) return;
+    const sortFieldName = getSortbyFieldName(relations, propsToDisplay, stringProps);
+    if (sortFieldName) sortValues[sortFieldName] = sort.toLowerCase();
+  });
+
+  return sortValues;
+};
+
+const buildSortValues = (sortFilters, relations, stringProps, useSortObject) => {
+  if (!sortFilters || !sortFilters.length) return useSortObject ? null : { sort: [] };
+  if (useSortObject) return buildAzSort(sortFilters, relations, stringProps);
+
+  const sortValues = sortFilters
+    .map(({ sort, propsToDisplay, isScore }) => {
+      if (isScore) return '_score';
+      if (!sort) return null;
+
+      const sortFieldName = getSortbyFieldName(relations, propsToDisplay, stringProps);
+      return sortFieldName ? `${sortFieldName}:${sort.toLowerCase()}` : null;
+    })
+    .filter(Boolean)
+    .join(',');
+
+  return { sort: sortValues };
+};
+
+export default buildSortValues;

package/src/helpers/get-extra-az-bits.js

@@ -1,7 +1,45 @@
-import { AZ_AGGS, ALL_AZ_SORT } from '../constants';
+import { AZ, AZ_DEFAULT_PROP } from '../constants';
 
-const getExtraAzBits = (shouldReturnAggs, isAZ, azFilter) => {
+function getAzArgs(azSortProperty) {
+  const azProp = `${azSortProperty}.keyword`;
+
+  const AZ_AGGS = {
+    aggs: {
+      azCount: {
+        terms: {
+          script: `doc['${azProp}'].getValue().substring(0,1).toUpperCase()`,
+          size: 500
+        }
+      }
+    },
+    sort: [{ [azProp]: 'asc' }]
+  };
+  const ALL_AZ_SORT = {
+    sort: [
+      {
+        _script: {
+          type: 'number',
+          script: {
+            lang: 'painless',
+            source: `int charPos = params.letters.indexOf(doc['${azProp}'].value.substring(0,1).toUpperCase()); charPos > -1 ? charPos : 100`,
+            params: {
+              letters: AZ
+            }
+          },
+          order: 'asc'
+        }
+      },
+      { [azProp]: 'asc' }
+    ]
+  };
+
+  return { ALL_AZ_SORT, AZ_AGGS };
+}
+
+const getExtraAzBits = ({ shouldReturnAggs, isAZ, azSortProperty = AZ_DEFAULT_PROP, azFilter }) => {
   if (!isAZ || (isAZ && azFilter)) return {};
+
+  const { AZ_AGGS, ALL_AZ_SORT } = getAzArgs(azSortProperty);
   if (shouldReturnAggs) return AZ_AGGS;
 
   return ALL_AZ_SORT;

package/src/helpers/get-generic-render-variables.js

@@ -1,42 +1,25 @@
-import getSortbyFieldName from './get-sort-by-field-name';
 import { DEFAULT_LIMIT, DEFAULT_OFFSET } from '../constants';
+import buildSortValues from './build-sort-values';
 
-const buildSortValues = (sortFilters, relations, stringProps) => {
-  if (!sortFilters || !sortFilters.length) return { sort: [] };
-
-  const sortValues = sortFilters
-    .map(({ sort, propsToDisplay }) => {
-      if (!sort) return null;
-
-      const sortFieldName = getSortbyFieldName(relations, propsToDisplay, stringProps);
-      return sortFieldName ? `${sortFieldName}:${sort.toLowerCase()}` : null;
-    })
-    .filter(Boolean)
-    .join(',');
-
-  return { sort: sortValues };
-};
-const getCorrectSort = (relations, filterProps, stringProps, isTextSearchApplied) => {
-  if (isTextSearchApplied) {
-    return {};
-  }
+const getCorrectSort = (relations, filterProps, stringProps, useSortObject) => {
   const { sort, sortby, sortProperties = [] } = filterProps;
 
   return buildSortValues(
     [{ sort, propsToDisplay: sortby }, ...sortProperties],
     relations,
-    stringProps
+    stringProps,
+    useSortObject
   );
 };
 
-const getGenericRenderVariables = (
+const getGenericRenderVariables = ({
   relations,
   filterProps = {},
   stringProps = [],
   rawQuery = {},
-  isTextSearchFilterApplied = false,
   useRandomSort = false
-) => {
+}) => {
+  const rawQueryCopy = { ...rawQuery };
   const { limit = DEFAULT_LIMIT, offset } = filterProps;
   const limitToUse = Number(limit || DEFAULT_LIMIT);
   const offsetToUse = Number(offset || DEFAULT_OFFSET);
@@ -45,7 +28,7 @@ const getGenericRenderVariables = (
     const rawQueryStringified = JSON.stringify({
       query: {
         function_score: {
-          query: rawQuery && rawQuery.query ? rawQuery.query : rawQuery,
+          query: rawQueryCopy && rawQueryCopy.query ? rawQueryCopy.query : rawQueryCopy,
           random_score: {},
           boost_mode: 'replace'
         }
@@ -59,13 +42,23 @@ const getGenericRenderVariables = (
     };
   }
 
-  const sort = getCorrectSort(relations, filterProps, stringProps, isTextSearchFilterApplied);
+  const sort = getCorrectSort(relations, filterProps, stringProps, !!rawQueryCopy.sort);
+
+  if (rawQueryCopy.sort && sort) {
+    rawQueryCopy.sort = [...rawQueryCopy.sort, sort];
+
+    return {
+      limit: limitToUse,
+      offset: offsetToUse,
+      rawQueryStringified: JSON.stringify(rawQueryCopy)
+    };
+  }
 
   return {
     limit: limitToUse,
     offset: offsetToUse,
     ...sort,
-    rawQueryStringified: JSON.stringify(rawQuery)
+    rawQueryStringified: JSON.stringify(rawQueryCopy)
   };
 };
 

package/tests/unit/src/components/List/helpers/get-list-query.test.js

@@ -0,0 +1,55 @@
+import getListQuery from '../../../../../../src/components/List/helpers/get-list-query';
+
+describe('getListQuery', () => {
+  it('should handle empty query', () => {
+    const query = {};
+    const hasListSpecificFilters = false;
+    const name = 'testList';
+
+    const result = getListQuery(query, hasListSpecificFilters, name);
+
+    expect(result).toEqual({});
+  });
+
+  it('should handle query without list-specific filters', () => {
+    const query = {
+      param1: 'value1',
+      param2: 'value2',
+      otherParam: 'otherValue',
+      'pb[testList][page]': '2',
+      'pb[testList][sort]': 'date',
+      'pb[testList][sortby]': 'asc'
+    };
+    const hasListSpecificFilters = false;
+    const name = 'testList';
+
+    const result = getListQuery(query, hasListSpecificFilters, name);
+
+    expect(result).toEqual({
+      param1: 'value1',
+      param2: 'value2',
+      otherParam: 'otherValue',
+      sort: 'date',
+      sortby: 'asc',
+      'pb[testList][page]': '2'
+    });
+  });
+
+  it('should handle query with list-specific filters', () => {
+    const query = {
+      'pb[testList][filter1]': 'filterValue1',
+      'pb[testList][page]': '3',
+      'pb[testList][sort]': 'name'
+    };
+    const hasListSpecificFilters = true;
+    const name = 'testList';
+
+    const result = getListQuery(query, hasListSpecificFilters, name);
+
+    expect(result).toEqual({
+      filter1: 'filterValue1',
+      sort: 'name',
+      'pb[testList][page]': '3'
+    });
+  });
+});

package/tests/unit/src/components/List/helpers/get-sort-props.test.js

@@ -42,6 +42,24 @@ describe('getSortProps helper function', () => {
     ]);
   });
 
+  it('should add score sort as second value if has textSearch', () => {
+    const { sortbyFilters, updatedSortProperties } = getSortProps({
+      ...props,
+      querySortBy,
+      querySort: desc,
+      isTextSearchFilterApplied: true
+    });
+    expect(sortbyFilters).toEqual([querySortBy, property]);
+    expect(updatedSortProperties).toEqual([
+      {
+        propsToDisplay: [querySortBy],
+        sort: desc
+      },
+      { isScore: true },
+      ...sortProperties
+    ]);
+  });
+
   it('should use old style sort', () => {
     const { sortbyFilters, updatedSortProperties } = getSortProps({
       ...props,

package/tests/unit/src/constants/__snapshots__/index.test.js.snap

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`constants should match snapshot 1`] = `undefined`;

package/tests/unit/src/constants/index.test.js

@@ -0,0 +1,7 @@
+import constants from '../../../../src/constants';
+
+describe('constants', () => {
+  it('should match snapshot', () => {
+    expect(constants).toMatchSnapshot();
+  });
+});

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

@@ -0,0 +1,137 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`getExtraAzBits helper function should return ALL_AZ_SORT if shouldReturnAggs is false and is Az and no Az filter is passed 1`] = `
+Object {
+  "sort": Array [
+    Object {
+      "_script": Object {
+        "order": "asc",
+        "script": Object {
+          "lang": "painless",
+          "params": Object {
+            "letters": Array [
+              "A",
+              "B",
+              "C",
+              "D",
+              "E",
+              "F",
+              "G",
+              "H",
+              "I",
+              "J",
+              "K",
+              "L",
+              "M",
+              "N",
+              "O",
+              "P",
+              "Q",
+              "R",
+              "S",
+              "T",
+              "U",
+              "V",
+              "W",
+              "X",
+              "Y",
+              "Z",
+            ],
+          },
+          "source": "int charPos = params.letters.indexOf(doc['name.keyword'].value.substring(0,1).toUpperCase()); charPos > -1 ? charPos : 100",
+        },
+        "type": "number",
+      },
+    },
+    Object {
+      "name.keyword": "asc",
+    },
+  ],
+}
+`;
+
+exports[`getExtraAzBits helper function should return ALL_AZ_SORT if shouldReturnAggs is false and is Az and no Az filter is passed with custom property 1`] = `
+Object {
+  "sort": Array [
+    Object {
+      "_script": Object {
+        "order": "asc",
+        "script": Object {
+          "lang": "painless",
+          "params": Object {
+            "letters": Array [
+              "A",
+              "B",
+              "C",
+              "D",
+              "E",
+              "F",
+              "G",
+              "H",
+              "I",
+              "J",
+              "K",
+              "L",
+              "M",
+              "N",
+              "O",
+              "P",
+              "Q",
+              "R",
+              "S",
+              "T",
+              "U",
+              "V",
+              "W",
+              "X",
+              "Y",
+              "Z",
+            ],
+          },
+          "source": "int charPos = params.letters.indexOf(doc['lastname.keyword'].value.substring(0,1).toUpperCase()); charPos > -1 ? charPos : 100",
+        },
+        "type": "number",
+      },
+    },
+    Object {
+      "lastname.keyword": "asc",
+    },
+  ],
+}
+`;
+
+exports[`getExtraAzBits helper function should return AZ_AGGS if shouldReturnAggs and isAz is true 1`] = `
+Object {
+  "aggs": Object {
+    "azCount": Object {
+      "terms": Object {
+        "script": "doc['name.keyword'].getValue().substring(0,1).toUpperCase()",
+        "size": 500,
+      },
+    },
+  },
+  "sort": Array [
+    Object {
+      "name.keyword": "asc",
+    },
+  ],
+}
+`;
+
+exports[`getExtraAzBits helper function should return AZ_AGGS if shouldReturnAggs and isAz is true with custom property 1`] = `
+Object {
+  "aggs": Object {
+    "azCount": Object {
+      "terms": Object {
+        "script": "doc['lastname.keyword'].getValue().substring(0,1).toUpperCase()",
+        "size": 500,
+      },
+    },
+  },
+  "sort": Array [
+    Object {
+      "lastname.keyword": "asc",
+    },
+  ],
+}
+`;

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

@@ -1,11 +1,12 @@
 import buildAzFilter from '../../../../src/helpers/build-az-filter';
+import { AZ_DEFAULT_PROP } from '../../../../src/constants';
 
 const mockFilters = [{ must: ['this'] }];
 const mockedResult = [
   { must: ['this'] },
   {
     regexp: {
-      'name.keyword': {
+      [`${AZ_DEFAULT_PROP}.keyword`]: {
         value: `b.*`,
         case_insensitive: true
       }
@@ -14,12 +15,12 @@ const mockedResult = [
 ];
 describe('buildAzFilter helper function', () => {
   it('should leave unchanged filters if no az is passed', () => {
-    buildAzFilter('', mockFilters);
+    buildAzFilter('', mockFilters, AZ_DEFAULT_PROP);
     expect(mockFilters).toEqual(mockFilters);
   });
 
   it('should update filters if az is passed', () => {
-    buildAzFilter('b', mockFilters);
+    buildAzFilter('b', mockFilters, AZ_DEFAULT_PROP);
     expect(mockFilters).toEqual(mockedResult);
   });
 });