@blaze-cms/react-page-builder 0.124.0-alpha.25 → 0.124.0-alpha.29

package/src/components/SearchFilter/SearchFilterContainer.js

@@ -1,4 +1,4 @@
-import React, { useState, useRef } from 'react';
+import React, { useState, useRef, useReducer } from 'react';
 import { useRouter } from 'next/router';
 import { useQuery } from '@apollo/client';
 import PropTypes from 'prop-types';
@@ -6,11 +6,31 @@ import { parseUrl, stringify } from 'query-string';
 import SearchFilter from './SearchFilter';
 import { withTitle } from '../../HOC';
 import { getSearchPublishedContent } from '../../application/query';
-import { buildNewQuery, buildRawQueryStringified, getInitialFilterValues } from './helpers';
+import {
+  buildNewQuery,
+  buildRawQueryStringified,
+  getInitialFilterValues,
+  buildFiltersQuery
+} from './helpers';
 import { getEntityData } from '../../helpers';
 import { RAW_RESULTS, RANGE, CHECKBOX_SELECT } from './constants';
 import { SCROLL_OFFSET } from '../../constants';
 
+const reducer = (state, action) => {
+  const { newValues, type, shouldSearch = true } = action;
+
+  switch (type) {
+    case 'update':
+      return { ...state, ...newValues, shouldSearch };
+    case 'resetSearch':
+      return { ...state, shouldSearch: false };
+    case 'reset':
+      return { ...newValues, shouldSearch };
+    default:
+      throw new Error();
+  }
+};
+
 const SearchFilterContainer = ({
   entity,
   url,
@@ -18,25 +38,27 @@ const SearchFilterContainer = ({
   name,
   isCollapsedOnResponsive,
   groupAfterMobile,
-  groupAfterDesktop
+  groupAfterDesktop,
+  filterBy,
+  filterByProperty,
+  shouldAddFilters
 }) => {
   const router = useRouter();
+  const { asPath } = router;
   const searchFilterRef = useRef(null);
   const [key, setKey] = useState(`filter-${name}`);
   const [displaySearchFilter, setDisplaySearchFilter] = useState(false);
+  const [filterValues, dispatch] = useReducer(reducer, null);
   const hasUrl = !!url;
   const {
     url: currentUrl,
     query: { sort, sortby },
     query
-  } = parseUrl(router.asPath);
+  } = parseUrl(asPath);
   const sortValues = sort && sortby ? stringify({ sort, sortby }) : '';
   const baseQuery = sortValues ? `${currentUrl}?${sortValues}` : currentUrl;
 
   const action = getSearchPublishedContent(RAW_RESULTS);
-
-  let rawQueryStringified = '';
-
   const checkboxSelectValues = [];
   const rangeValues = [];
 
@@ -50,21 +72,32 @@ const SearchFilterContainer = ({
 
   const { docType } = getEntityData(entity);
 
-  rawQueryStringified = buildRawQueryStringified(checkboxSelectValues, rangeValues, docType);
+  const filtersQuery = shouldAddFilters
+    ? buildFiltersQuery(filters || query, filterBy, filterByProperty)
+    : [];
+
+  const rawQueryStringified = buildRawQueryStringified(
+    checkboxSelectValues,
+    rangeValues,
+    docType,
+    filtersQuery
+  );
 
-  const { data, error, loading } = useQuery(action, {
+  const { data, error } = useQuery(action, {
     variables: { rawQueryStringified, limit: 0 }, // we only want aggs so limit=0 for no search results
     skip: !rawQueryStringified
   });
 
-  if (loading) return null;
   if (error) return error.message;
   if (!filters.length) return null;
 
-  const { searchPublishedContent: { rawResults: { aggregations: filterData = {} } = {} } = {} } =
+  const { searchPublishedContent: { rawResults: { aggregations: filterData } = {} } = {} } =
     data || {};
 
-  const initialFilterValues = getInitialFilterValues(filterData, filters, query);
+  if (!filterValues && filterData) {
+    const initialFilterValues = getInitialFilterValues(filterData, filters, query);
+    dispatch({ newValues: initialFilterValues, shouldSearch: false, type: 'update' });
+  }
 
   const handleSearch = newQuery => {
     setDisplaySearchFilter(false);
@@ -93,17 +126,19 @@ const SearchFilterContainer = ({
       window.scrollTo(0, 0);
     }
   };
+  if (!filterValues) return '';
 
   return (
     <SearchFilter
       key={key}
+      setAppliedFilters={dispatch}
       searchFilterRef={searchFilterRef}
       data={filterData}
       filters={filters}
       hasUrl={hasUrl}
       entity={entity}
       handleSearch={handleSearch}
-      initialFilterValues={initialFilterValues}
+      filterValues={filterValues}
       name={name}
       isCollapsedOnResponsive={isCollapsedOnResponsive}
       displaySearchFilter={displaySearchFilter}
@@ -121,7 +156,10 @@ SearchFilterContainer.propTypes = {
   name: PropTypes.string.isRequired,
   isCollapsedOnResponsive: PropTypes.bool,
   groupAfterMobile: PropTypes.number,
-  groupAfterDesktop: PropTypes.number
+  groupAfterDesktop: PropTypes.number,
+  filterBy: PropTypes.array,
+  filterByProperty: PropTypes.array,
+  shouldAddFilters: PropTypes.bool
 };
 
 SearchFilterContainer.defaultProps = {
@@ -130,7 +168,10 @@ SearchFilterContainer.defaultProps = {
   entity: '',
   isCollapsedOnResponsive: true,
   groupAfterMobile: 0,
-  groupAfterDesktop: 0
+  groupAfterDesktop: 0,
+  filterBy: [],
+  filterByProperty: [],
+  shouldAddFilters: false
 };
 
 export default withTitle(SearchFilterContainer);

package/src/components/SearchFilter/components/Checkbox.js

@@ -7,7 +7,15 @@ import { withTitle } from '../../../HOC';
 import { decodeValue } from '../helpers';
 import { LIMIT_MIN, LIMIT_MAX, MORE, LESS } from '../constants';
 
-const Checkbox = ({ data, prop, updateFilterValues, filterValues, label, shouldSearch }) => {
+const Checkbox = ({
+  data,
+  prop,
+  updateFilterValues,
+  filterValues,
+  label,
+  shouldSearch,
+  displayFilterCount
+}) => {
   const [checkboxLimit, setCheckboxLimit] = useState(null);
 
   const handleCheckboxOptions = () => {
@@ -35,7 +43,10 @@ const Checkbox = ({ data, prop, updateFilterValues, filterValues, label, shouldS
   const multiple = [];
 
   const sortedValues = data[prop].buckets
-    .map(({ key }) => key)
+    .map(({ key, doc_count: count }) => {
+      const optionLabel = displayFilterCount ? `${key} (${count})` : key;
+      return [key, optionLabel, !count];
+    })
     .filter(Boolean)
     .sort();
 
@@ -43,11 +54,12 @@ const Checkbox = ({ data, prop, updateFilterValues, filterValues, label, shouldS
     (value, i) =>
       i < checkboxLimit[prop] &&
       multiple.push({
-        label: upperFirst(value),
-        value,
+        label: upperFirst(value[1]),
+        value: value[0],
         name: prop,
-        checked: checkboxQueryParams.includes(value),
-        id: value
+        checked: checkboxQueryParams.includes(value[0]),
+        id: value[0],
+        disabled: value[2]
       })
   );
 
@@ -95,12 +107,14 @@ Checkbox.propTypes = {
   filterValues: PropTypes.object.isRequired,
   updateFilterValues: PropTypes.func.isRequired,
   shouldSearch: PropTypes.bool,
-  label: PropTypes.string
+  label: PropTypes.string,
+  displayFilterCount: PropTypes.bool
 };
 
 Checkbox.defaultProps = {
   shouldSearch: false,
-  label: ''
+  label: '',
+  displayFilterCount: false
 };
 
 export default withTitle(Checkbox);

package/src/components/SearchFilter/components/Select.js

@@ -11,17 +11,21 @@ const SelectFilter = ({
   updateFilterValues,
   filterValues,
   shouldSearch,
-  displayLabelAsPlaceholder
+  displayLabelAsPlaceholder,
+  displayFilterCount
 }) => {
   const filterValue = filterValues[prop] || '';
-
-  const options = data[prop].buckets
-    .map(bucket => bucket.key)
+  const disabledOptions = [];
+  const { buckets = [] } = data[prop] || {};
+  const options = buckets
+    .map(({ key, doc_count: count }) => {
+      if (!count) disabledOptions.push(key);
+      const optionLabel = displayFilterCount ? `${key} (${count})` : key;
+      return [key, optionLabel];
+    })
     .filter(Boolean)
     .sort();
 
-  const optionsJoined = options;
-
   const labelText = label || prop;
   let labelToUse = labelText;
   let defaultTextValue = DEFAULT_OPTION;
@@ -36,14 +40,14 @@ const SelectFilter = ({
       value={filterValue}
       id={prop}
       data-testid={`filter-${prop}`}
-      options={optionsJoined}
+      options={options}
       defaultTextValue={defaultTextValue}
       onChange={({ value }) => {
         let valueToUse = value;
         if (value === defaultTextValue) valueToUse = '';
-
         updateFilterValues({ [prop]: valueToUse }, shouldSearch);
       }}
+      disabled={disabledOptions}
     />
   );
 };
@@ -51,17 +55,20 @@ const SelectFilter = ({
 SelectFilter.propTypes = {
   data: PropTypes.object.isRequired,
   prop: PropTypes.string.isRequired,
-  filterValues: PropTypes.object.isRequired,
+  filterValues: PropTypes.object,
   updateFilterValues: PropTypes.func.isRequired,
   shouldSearch: PropTypes.bool,
   label: PropTypes.string,
-  displayLabelAsPlaceholder: PropTypes.bool
+  displayLabelAsPlaceholder: PropTypes.bool,
+  displayFilterCount: PropTypes.bool
 };
 
 SelectFilter.defaultProps = {
+  filterValues: {},
   shouldSearch: false,
   label: '',
-  displayLabelAsPlaceholder: false
+  displayLabelAsPlaceholder: false,
+  displayFilterCount: false
 };
 
 export default withTitle(SelectFilter);

package/src/components/SearchFilter/components/TextSearch.js

@@ -5,7 +5,7 @@ import { MdSearch } from 'react-icons/md';
 import { withTitle } from '../../../HOC';
 import { SEARCH_TERM } from '../constants';
 
-const TextSearch = ({ label, searchValue, updateFilterValues, handleSubmit, filterValues }) => (
+const TextSearch = ({ label, searchValue, updateFilterValues }) => (
   <div className="search">
     <div className="search__wrapper">
       <div className="form-field form-field--input form-field--search">
@@ -34,10 +34,8 @@ const TextSearch = ({ label, searchValue, updateFilterValues, handleSubmit, filt
 );
 
 TextSearch.propTypes = {
-  filterValues: PropTypes.object.isRequired,
   searchValue: PropTypes.string.isRequired,
   updateFilterValues: PropTypes.func.isRequired,
-  handleSubmit: PropTypes.func.isRequired,
   label: PropTypes.string
 };
 

package/src/components/SearchFilter/helpers/build-filters-query.js

@@ -0,0 +1,40 @@
+const builFilterObject = (key, value, filters) => {
+  const isArray = Array.isArray(value);
+  if (!isArray) {
+    const singleFilterObj = { match: { [key]: value } };
+    filters.push(singleFilterObj);
+    return;
+  }
+
+  value.forEach(filterValue => {
+    filters.push({ match: { [key]: filterValue } });
+  });
+};
+const buildFiltersQuery = (query, filterBy, filterByProperty) => {
+  const mustFilters = [];
+  Object.keys(query).forEach(queryKey => {
+    if (queryKey === 'search_term' || queryKey === 'shouldSearch') return;
+    if (!queryKey || !query[queryKey]) return;
+    const queryValue = query[queryKey];
+    const queryKeyword = `${queryKey}.keyword`;
+    builFilterObject(queryKeyword, queryValue, mustFilters);
+  });
+
+  if (filterByProperty && filterByProperty.length) {
+    filterByProperty &&
+      filterByProperty.forEach(filterByPropOption => {
+        const [filterByPropKey] = filterByPropOption.split('/');
+        filterBy.forEach(filterByOption => {
+          if (filterByOption.indexOf(filterByPropKey) === -1) return;
+          const [, filteryByValue] = filterByOption.split('/');
+          const filterByKeyword = `${filterByPropKey}.keyword`;
+          if (!filteryByValue) return;
+          mustFilters.push({ match: { [filterByKeyword]: filteryByValue } });
+        });
+      });
+  }
+
+  return mustFilters;
+};
+
+export default buildFiltersQuery;

package/src/components/SearchFilter/helpers/build-raw-query-stringified.js

@@ -1,6 +1,6 @@
 import { KEYWORD, SIZE } from '../constants';
 
-const buildRawQueryStringified = (checkboxSelectValues, rangeValues, entity) => {
+const buildRawQueryStringified = (checkboxSelectValues, rangeValues, entity, mustFilters) => {
   if (!checkboxSelectValues.length && !rangeValues.length) return '';
 
   const aggs = {};
@@ -36,6 +36,7 @@ const buildRawQueryStringified = (checkboxSelectValues, rangeValues, entity) =>
                 }
               }
             ],
+            must: mustFilters,
             minimum_should_match: 1
           }
         }

package/src/components/SearchFilter/helpers/get-initial-filter-values.js

@@ -3,6 +3,7 @@ import getFilterValueFromQuery from './get-filter-value-from-query';
 
 const getInitialFilterValues = (filterData, filters, query) => {
   const filterValues = {};
+
   Object.keys(filterData).forEach(key => {
     const filterProps =
       filters.find(({ propsToDisplay }) => propsToDisplay.find(prop => key === prop)) || {};

package/src/components/SearchFilter/helpers/index.js

@@ -13,6 +13,7 @@ import isDeviceDesktop from './is-device-desktop';
 import getInitialFilterValues from './get-initial-filter-values';
 import getFilterValueFromQuery from './get-filter-value-from-query';
 import buildQuery from './build-query';
+import buildFiltersQuery from './build-filters-query';
 
 export {
   buildQuery,
@@ -30,5 +31,6 @@ export {
   getSelectOptions,
   isDeviceDesktop,
   getInitialFilterValues,
-  getFilterValueFromQuery
+  getFilterValueFromQuery,
+  buildFiltersQuery
 };

package/tests/unit/src/components/Menu/__snapshots__/Menu.test.js.snap

@@ -3,20 +3,21 @@
 exports[`Menu component should render without throwing an error and match snapshot 1`] = `
 <DocumentFragment>
   <div
-    class="menu--desktop-wrapper"
+    class="menu--wrapper"
   >
-    <ul
-      class="menu-mod"
+    <div
+      class="menu--desktop-wrapper"
     >
-      <div
-        class="child_1"
+      <ul
+        class="menu-mod"
       >
-        only child
-      </div>
-      <li>
-        Search Component
-      </li>
-    </ul>
+        <div
+          class="child_1"
+        >
+          only child
+        </div>
+      </ul>
+    </div>
   </div>
 </DocumentFragment>
 `;

package/tests/unit/src/components/SearchFilter/SearchFilter/SearchFilter.test.js

@@ -11,7 +11,7 @@ const renderComponent = (Component, props) => {
 
 const mockedProps = {
   data: {},
-  initialFilterValues: {},
+  filterValues: {},
   filters: [],
   searchFilterRef: {},
   buttonRef: { current: null },
@@ -24,14 +24,11 @@ const mockedProps = {
   groupAfterMobile: 0,
   groupAfterDesktop: 0,
   isCollapsedOnResponsive: true,
-  displaySearchFilter: false
+  displaySearchFilter: false,
+  setAppliedFilters: jest.fn()
 };
 
 describe('SearchFilter component', () => {
-  it('should be defined', () => {
-    expect(SearchFilter).toBeDefined();
-  });
-
   describe('when isCollapsedOnResponsive = true, displaySearchFilter = false', () => {
     const specificMockedProps = {
       ...mockedProps,

package/tests/unit/src/components/SearchFilter/__snapshots__/SearchFilterContainer.test.js.snap

@@ -1,11 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`SearchFilter container should match snapshot 1`] = `
-<DocumentFragment>
-  <div>
-    Mocked component
-  </div>
-</DocumentFragment>
-`;
+exports[`SearchFilter container should match snapshot 1`] = `<DocumentFragment />`;
 
 exports[`SearchFilter container should return null if no filters are passed 1`] = `<DocumentFragment />`;

package/tests/unit/src/components/SearchFilter/components/__snapshots__/Checkbox.test.js.snap

@@ -10,6 +10,7 @@ exports[`Checkbox component should render without throwing an error match snapsh
       class="form-checkbox"
       data-cy="checkbox-cy-1"
       data-testid="checkbox-1"
+      disabled=""
       id="name1-checkbox"
       name="name"
       readonly=""
@@ -36,6 +37,7 @@ exports[`Checkbox component should render without throwing an error match snapsh
       class="form-checkbox"
       data-cy="checkbox-cy-2"
       data-testid="checkbox-2"
+      disabled=""
       id="name2-checkbox"
       name="name"
       readonly=""

package/tests/unit/src/components/SearchFilter/components/__snapshots__/Select.test.js.snap

@@ -13,11 +13,13 @@ exports[`Select component should display label as placeholder with no label tag
         Placeholder label
       </option>
       <option
+        disabled=""
         value="name1"
       >
         name1
       </option>
       <option
+        disabled=""
         value="name2"
       >
         name2
@@ -46,11 +48,13 @@ exports[`Select component should render witout throwing an error and match snaps
         Any
       </option>
       <option
+        disabled=""
         value="name1"
       >
         name1
       </option>
       <option
+        disabled=""
         value="name2"
       >
         name2