@blaze-cms/plugin-search-ui 0.131.0 → 0.132.0-admin-updates.1

package/src/components/SearchAdmin/SearchAdmin.js

@@ -1,21 +1,28 @@
 import React, { useState, useRef, useEffect } from 'react';
 import classnames from 'classnames';
+import { useDebounce } from '@blaze-react/utils/lib/customHooks';
 import useLocalStorage from '../useLocalStorage';
 import SearchBar from './SearchBar';
 import RecentSearches from './RecentSearches';
 import SearchResults from './SearchResults';
 import TriggerModal from './TriggerModal';
+import SearchAdminSideBar from './SearchAdminSideBar';
 import useSearchResults from '../useSearchResults';
 import { SEARCH_ADMIN } from '../../constants';
 
 const SearchAdmin = () => {
   const [searchTerm, setSearchTerm] = useState('');
+  const [openSearchSideBar, setOpenSearchSideBar] = useState(true);
+  const [entityValues, setEntityValues] = useState([]);
   const [recentSearches, setRecentSearches] = useLocalStorage('recentSearches', []);
   const [displaySearchModalFrame, setDisplaySearchModalFrame] = useState(false);
   const [enableResults, setEnableResults] = useState(true);
   const searchInputRef = useRef(null);
-  const [{ loading, results, total }, setQueryParams] = useSearchResults({
-    queryKey: SEARCH_ADMIN
+  const debouncedEntityValues = useDebounce(entityValues, 500);
+  const entities = debouncedEntityValues.map(e => e.id);
+  const [{ loading, newResults: results = [], total }, setQueryParams] = useSearchResults({
+    queryKey: SEARCH_ADMIN,
+    entities
   });
 
   useEffect(
@@ -30,11 +37,13 @@ const SearchAdmin = () => {
   const handleSearchTerm = ({ target: { value } }) => {
     setSearchTerm(value);
   };
+
   const toggleSearchModal = () => {
     setSearchTerm(null);
     setEnableResults(false);
     setDisplaySearchModalFrame(!displaySearchModalFrame);
   };
+
   const search = ({ value }) => {
     if (!value) return;
     !enableResults && setEnableResults(true);
@@ -68,58 +77,71 @@ const SearchAdmin = () => {
     'modal--show': displaySearchModalFrame
   });
 
+  const searchModalSideBarClassName = classnames('modal__search__sidebar', {
+    'modal__search__sidebar--close': !openSearchSideBar
+  });
+
   const isEmptySearchTermAndData = !searchTerm && !results.length;
   const isEmptySearchTermnAndDisabledResults = !searchTerm && !enableResults;
   const shouldDisplayRecentSearches =
     isEmptySearchTermAndData || isEmptySearchTermnAndDisabledResults;
 
-  const showResults = enableResults && results.length;
+  const handleSetEntityValues = newEntity => {
+    const entityExists = entityValues.some(entity => entity.id === newEntity.id);
+    if (entityExists) {
+      setQueryParams({ value: searchTerm, offset: 0 });
+      setEntityValues(entityValues.filter(entity => entity.id !== newEntity.id));
+    } else {
+      setQueryParams({ value: searchTerm, offset: 0 });
+      setEntityValues([...entityValues, newEntity]);
+    }
+  };
 
   return (
     <div className="search search--header">
       <TriggerModal toggleSearchModal={toggleSearchModal} />
       <div className={searchModalResultsClassName}>
         {displaySearchModalFrame && (
-          <>
-            <div className="modal__header modal__header--search">
-              <SearchBar
-                toggleSearchModal={toggleSearchModal}
-                handleKeyDown={handleKeyDown}
-                searchInputRef={searchInputRef}
-                handleSearchTerm={handleSearchTerm}
-                searchTerm={searchTerm}
-                search={() => search({ value: searchTerm })}
-              />
+          <div className="modal__search">
+            <SearchAdminSideBar
+              searchModalSideBarClassName={searchModalSideBarClassName}
+              openSearchSideBar={openSearchSideBar}
+              setOpenSearchSideBar={setOpenSearchSideBar}
+              handleSetEntityValues={handleSetEntityValues}
+              entityValues={entityValues}
+              setEntityValues={setEntityValues}
+            />
+            <div className="modal__search__content">
+              <div className="modal__header modal__header--search">
+                <SearchBar
+                  toggleSearchModal={toggleSearchModal}
+                  handleKeyDown={handleKeyDown}
+                  searchInputRef={searchInputRef}
+                  handleSearchTerm={handleSearchTerm}
+                  searchTerm={searchTerm}
+                  search={() => search({ value: searchTerm })}
+                />
+              </div>
+              {shouldDisplayRecentSearches && (
+                <RecentSearches
+                  recentSearches={recentSearches}
+                  handleSearchTerm={handleSearchTerm}
+                  search={search}
+                />
+              )}
+              {enableResults && (
+                <SearchResults
+                  currentValue={searchTerm}
+                  entities={entities}
+                  loading={loading}
+                  results={results}
+                  total={total}
+                  setQueryParams={setQueryParams}
+                  closeModal={toggleSearchModal}
+                />
+              )}
             </div>
-            {shouldDisplayRecentSearches ? (
-              <RecentSearches
-                recentSearches={recentSearches}
-                handleSearchTerm={handleSearchTerm}
-                search={search}
-              />
-            ) : (
-              <>
-                {!showResults && (
-                  <div className="list list--search">
-                    <div className="header header--list">
-                      <h2>No Results</h2>
-                    </div>
-                  </div>
-                )}
-              </>
-            )}
-            {showResults && (
-              <SearchResults
-                currentValue={searchTerm}
-                searchTerm={searchTerm}
-                loading={loading}
-                results={results}
-                total={total}
-                setQueryParams={setQueryParams}
-                closeModal={toggleSearchModal}
-              />
-            )}
-          </>
+          </div>
         )}
       </div>
     </div>

package/src/components/SearchAdmin/SearchAdminSideBar/SearchAdminSideBar.js

@@ -0,0 +1,88 @@
+import React, { useState } from 'react';
+import { useQuery } from '@apollo/client';
+import { getQuery } from '@blaze-cms/admin-ui-utils';
+import { Checkbox } from '@blaze-react/checkboxes';
+
+const MENU_PERMISSIONS = ['update:any', 'update:own', 'create:any', 'create:own'];
+
+const SearchAdminSideBar = ({
+  searchModalSideBarClassName,
+  openSearchSideBar,
+  setOpenSearchSideBar,
+  handleSetEntityValues,
+  entityValues,
+  setEntityValues
+}) => {
+  const [loadMore, setLoadMore] = useState(false);
+  const { data: { getEntitySchemas = [] } = {}, loading } = useQuery(
+    getQuery('GET_USER_EDITABLE_ENTITIES'),
+    {
+      variables: {
+        canDoActions: MENU_PERMISSIONS
+      }
+    }
+  );
+
+  if (loading) return null;
+
+  const filteredEntitiesSchemas = getEntitySchemas.filter(entity => {
+    if (Object.keys(entity.extras).length) {
+      return entity.extras.searchIndexes.includes('admin');
+    }
+    return false;
+  });
+
+  const entitiesToShow = filteredEntitiesSchemas.slice(
+    0,
+    loadMore ? filteredEntitiesSchemas.length : 5
+  );
+
+  return (
+    <div className={searchModalSideBarClassName}>
+      <div
+        className="modal__search__sidebar__button"
+        role="button"
+        onClick={() => setOpenSearchSideBar(!openSearchSideBar)}>
+        <i className="material-icons">
+          {openSearchSideBar ? 'keyboard_arrow_left' : 'keyboard_arrow_right'}
+        </i>
+      </div>
+      <div className="modal__search__sidebar__container">
+        <div className="modal__search__sidebar__wrapper">
+          <div className="modal__search__sidebar__filters">
+            <i className="material-icons modal__search__sidebar__icon">tune</i>
+            <span>Filters</span>
+          </div>
+          <div
+            className="modal__search__sidebar__clear"
+            role="button"
+            onClick={() => setEntityValues([])}>
+            <span>Clear all</span>
+            <i className="material-icons modal__search__sidebar__icon--clear">replay</i>
+          </div>
+        </div>
+        <div className="modal__search__sidebar__entity-list">
+          <h1>Entity list</h1>
+          {entitiesToShow.map(entity => (
+            <Checkbox
+              checked={entityValues.some(_entity => _entity.id === entity.id)}
+              label={entity.displayName}
+              id={entity.id}
+              name={entity.id}
+              onChange={({ value: { checked } }) => handleSetEntityValues(entity)}
+            />
+          ))}
+          <div
+            className="modal__search__sidebar__more"
+            role="button"
+            onClick={() => setLoadMore(!loadMore)}>
+            <i className="material-icons">{!loadMore ? 'navigate_next' : 'expand_less'}</i>
+            <span>{loadMore ? 'Less' : 'More'}</span>
+          </div>
+        </div>
+      </div>
+    </div>
+  );
+};
+
+export default SearchAdminSideBar;

package/src/components/SearchAdmin/SearchAdminSideBar/index.js

@@ -0,0 +1,3 @@
+import SearchAdminSideBar from './SearchAdminSideBar';
+
+export default SearchAdminSideBar;

package/src/components/SearchAdmin/SearchResults/SearchResults.js

@@ -1,6 +1,6 @@
 /* eslint-disable jsx-a11y/anchor-is-valid */
 /* eslint-disable jsx-a11y/no-static-element-interactions */
-import React, { useState } from 'react';
+import React, { useState, useEffect } from 'react';
 import PropTypes from 'prop-types';
 import VirtualList from 'react-tiny-virtual-list';
 import { withRouter } from 'react-router-dom';
@@ -13,6 +13,7 @@ import {
 
 const SearchResults = ({
   currentValue,
+  entities,
   loading,
   results,
   total,
@@ -22,12 +23,45 @@ const SearchResults = ({
 }) => {
   const [verifiedRanges, setVerifiedRanges] = useState([]);
   const [currentIndex, setCurrentIndex] = useState(0);
+  const [currentResults, setCurrentResults] = useState('');
+  const [allResults, setAllResults] = useState([]);
+  const [currentParams, setCurrentParams] = useState('');
+
+  useEffect(
+    () => {
+      if (!loading) {
+        const newResults = results.map(({ id }) => id).join(',');
+        if (currentResults !== newResults) {
+          const newParams = `${currentValue},${entities.join(',')}`;
+          if (newParams !== currentParams) {
+            setAllResults(results);
+            setCurrentParams(newParams);
+            if (verifiedRanges.length) setVerifiedRanges([]);
+          } else {
+            setAllResults(allResults.concat(results));
+          }
+          setCurrentResults(newResults);
+        }
+      }
+    },
+    [
+      allResults,
+      currentParams,
+      currentResults,
+      currentValue,
+      entities,
+      loading,
+      results,
+      total,
+      verifiedRanges.length
+    ]
+  );
 
   const handleRenderedItems = async ({ startIndex }) => {
-    const rowsLength = results.length;
+    const rowsLength = allResults.length;
     const loadIndex = Math.floor(rowsLength / 2) - SEARCH_RESULTS_OVER_SCAN_BUFFER;
     if (loadIndex > 0 && loadIndex < startIndex && !verifiedRanges.includes(loadIndex)) {
-      setQueryParams({ value: currentValue, offset: results.length });
+      setQueryParams({ value: currentValue, offset: allResults.length });
       setVerifiedRanges([...verifiedRanges, loadIndex]);
       setCurrentIndex(startIndex + SEARCH_RESULTS_OVER_SCAN_BUFFER);
     }
@@ -49,53 +83,96 @@ const SearchResults = ({
     return `${day}.${month}.${year}`;
   };
 
-  return (
-    <>
-      {loading && <span>Loading...</span>}
-      <div className="modal__content modal__content--search">
+  if (!allResults.length)
+    return (
+      <div className="list list--search">
         <div className="header header--list">
-          <h2>{total} results</h2>
+          <h2>No Results</h2>
         </div>
-        <VirtualList
-          width="100%"
-          height={window.innerHeight - SEARCH_RESULTS_ELEMETS_HEIGHT_ABOVE_LIST}
-          itemCount={results.length}
-          itemSize={SEARCH_RESULTS_ITEM_SIZE}
-          overscanCount={SEARCH_RESULTS_OVER_SCAN_BUFFER}
-          scrollToIndex={currentIndex}
-          onItemsRendered={handleRenderedItems}
-          renderItem={({ index, style }) => {
-            const { id, docType, updated, name } = results[index];
-            const updatedDate = updated ? getDateFormat(updated) : null;
-            return (
-              <div key={index} style={style} className="list__item--resultWrapper">
-                <div className="list__item list__item--result">
-                  <div className="list__item-row list__item-row--result">
-                    <span className="badge badge--primary">
-                      {docType} {updatedDate}
-                    </span>
-                    <a
-                      href={getNavigationRoute({
+      </div>
+    );
+
+  return (
+    <div className="modal__content modal__content--search">
+      <div className="header header--list">
+        <h2 className="header--list--results">
+          About <b>{total}</b> search keywords results
+        </h2>
+      </div>
+      <VirtualList
+        width="100%"
+        height={window.innerHeight - SEARCH_RESULTS_ELEMETS_HEIGHT_ABOVE_LIST}
+        itemCount={allResults.length}
+        itemSize={SEARCH_RESULTS_ITEM_SIZE}
+        overscanCount={SEARCH_RESULTS_OVER_SCAN_BUFFER}
+        scrollToIndex={currentIndex}
+        onItemsRendered={handleRenderedItems}
+        renderItem={({ index, style }) => {
+          const {
+            id,
+            docType,
+            updated,
+            name,
+            entityIdentifier,
+            published,
+            created,
+            status
+          } = allResults[index];
+          const updatedDate = updated ? getDateFormat(updated) : null;
+          const createdDate = created ? getDateFormat(created) : null;
+          const publishedDate = published ? getDateFormat(published) : null;
+          return (
+            <div key={index} style={style} className="list__item--resultWrapper">
+              <div className="list__item list__item--result">
+                <div className="list__item-row list__item-row--result">
+                  <span className="list__item-identifier">{entityIdentifier}</span>
+                  <a
+                    href={getNavigationRoute({
+                      id,
+                      docType
+                    })}
+                    onClick={() =>
+                      navigate({
                         id,
                         docType
-                      })}
-                      onClick={() =>
-                        navigate({
-                          id,
-                          docType
-                        })
-                      }
-                      className="list__item-text list__item-text--result">
-                      {name}
-                    </a>
+                      })
+                    }
+                    className="list__item-link">
+                    {name}
+                  </a>
+
+                  <div className="list__item-dates">
+                    {publishedDate && (
+                      <span>
+                        <b>Published: </b>
+                        {publishedDate}
+                      </span>
+                    )}
+                    <span>
+                      <b>Created: </b>
+                      {createdDate}
+                    </span>
+                    <span>
+                      <b>Updated: </b>
+                      {updatedDate}
+                    </span>
+                  </div>
+                  <div className="list__item-status">
+                    {status && (
+                      <span>
+                        <b>Status: </b>
+                        {status}
+                      </span>
+                    )}
                   </div>
                 </div>
               </div>
-            );
-          }}
-        />
-      </div>
-    </>
+            </div>
+          );
+        }}
+      />
+      {loading && <span>Loading...</span>}
+    </div>
   );
 };
 
@@ -106,7 +183,8 @@ SearchResults.propTypes = {
   setQueryParams: PropTypes.func.isRequired,
   closeModal: PropTypes.func.isRequired,
   history: PropTypes.object.isRequired,
-  currentValue: PropTypes.string.isRequired
+  currentValue: PropTypes.string.isRequired,
+  entities: PropTypes.array.isRequired
 };
 
 export default withRouter(SearchResults);

package/src/components/useSearch/useSearch.js

@@ -2,20 +2,28 @@ import { useState, useEffect } from 'react';
 import { useLazyQuery } from '@apollo/client';
 import searchQueries from '../../application/query';
 
-function useSearch({ queryKey, resultKeys, entities = [], fields }) {
+function useSearch({ queryKey, resultKeys, entities = [], fields, extraFilters }) {
   const [queryParams, setParams] = useState({ limit: 20, offset: 0, value: '' });
   const [searchedValue, setSearchedValue] = useState(null);
+  const [previousEntities, setPreviousEntities] = useState([]);
   const [previousOffset, setPreviousOffset] = useState(null);
   const buildSearchQuery = searchQueries[queryKey];
-  const [
-    getSearchResults,
-    {
-      loading,
-      data: { search: { results, jsonResults, total } } = {
-        search: { results: [], total: 0 }
-      }
-    }
-  ] = useLazyQuery(buildSearchQuery({ resultKeys }), { ssr: false });
+
+  const [getSearchResults, { loading, data = {} } = {}] = useLazyQuery(
+    buildSearchQuery({ resultKeys }),
+    { ssr: false }
+  );
+
+  const { search } = data;
+
+  const defaultSearch = {
+    results: [],
+    jsonResults: null,
+    total: 0
+  };
+
+  const { results, jsonResults, total } = search ?? defaultSearch;
+
   // todo: remove ssr: false once this bug is resolved https://github.com/apollographql/apollo-client/issues/9108
   // without ssr: false clients can hang in ssr.
 
@@ -28,13 +36,14 @@ function useSearch({ queryKey, resultKeys, entities = [], fields }) {
       const { limit, offset, value } = queryParams;
       const isNewValueSet = value && value !== searchedValue;
       const isNewOffsetSet = previousOffset !== null && offset !== previousOffset;
+      const notSameLength = previousEntities.length !== entities.length;
       const parsedEntities = entities.length
         ? entities.map(entity => ({
             match: { docType: entity }
           }))
         : [];
 
-      if (isNewValueSet || isNewOffsetSet) {
+      if (isNewValueSet || isNewOffsetSet || notSameLength) {
         getSearchResults({
           variables: {
             limit,
@@ -48,7 +57,8 @@ function useSearch({ queryKey, resultKeys, entities = [], fields }) {
                         query: value,
                         fields,
                         type: 'most_fields',
-                        default_operator: 'AND'
+                        default_operator: 'AND',
+                        extraFilters
                       }
                     },
                     {
@@ -64,6 +74,7 @@ function useSearch({ queryKey, resultKeys, entities = [], fields }) {
         });
         setSearchedValue(value);
         setPreviousOffset(offset);
+        setPreviousEntities(entities);
       }
     },
     [
@@ -75,7 +86,10 @@ function useSearch({ queryKey, resultKeys, entities = [], fields }) {
       previousOffset,
       getSearchResults,
       entities,
-      fields
+      fields,
+      entities.length,
+      previousEntities.length,
+      extraFilters
     ]
   );
 

package/src/components/useSearchResults/useSearchResults.js

@@ -2,6 +2,8 @@ import { useState, useEffect } from 'react';
 import useSearch from '../useSearch';
 
 function useSearchResults({ queryKey, resultKeys, entities, fields }) {
+  const [currentResults, setCurrentResults] = useState([]);
+  const [allResults, setAllResults] = useState([]);
   const [
     {
       searchedValue,
@@ -10,8 +12,6 @@ function useSearchResults({ queryKey, resultKeys, entities, fields }) {
     },
     setParams
   ] = useSearch({ queryKey, resultKeys, entities, fields });
-  const [currentResults, setCurrentResults] = useState([]);
-  const [allResults, setAllResults] = useState([]);
 
   useEffect(
     () => {
@@ -20,7 +20,7 @@ function useSearchResults({ queryKey, resultKeys, entities, fields }) {
         setCurrentResults(results);
       }
     },
-    [allResults, currentResults, currentResults.length, results]
+    [allResults, currentResults, results]
   );
 
   const clearList = params => {
@@ -32,7 +32,16 @@ function useSearchResults({ queryKey, resultKeys, entities, fields }) {
     params.value !== searchedValue ? clearList(params) : setParams(params);
   };
 
-  return [{ loading, results: allResults, total }, setQueryParams];
+  return [
+    {
+      loading,
+      results: allResults,
+      currentResults,
+      newResults: results,
+      total
+    },
+    setQueryParams
+  ];
 }
 
 export default useSearchResults;