UISAUTCOMP-95 Use first page Browse query for facet requests. (#130)

* UISAUTCOMP-95 Use first page Browse query for facet requests.

* UISAUTCOMP-95 Use existing query prop in AuthoritiesSearchPane

* UISAUTCOMP-95 Include current facets in firstPageQuery

* UISAUTCOMP-95 Added readme for useAuthoritiesBrowse hook

Author: BogdanDenis

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change history for stripes-authoriy-components
 
+## [3.0.2] IN PROGRESS
+
+- [UISAUTCOMP-95](https://issues.folio.org/browse/UISAUTCOMP-95) Use first page Browse query for facet requests.
+
 ## [3.0.1] (https://github.com/folio-org/stripes-authority-components/tree/v3.0.1) (2023-10-27)
 
 - [UISAUTCOMP-87](https://issues.folio.org/browse/UISAUTCOMP-87) Highlight the Browse search list row after editing the 1xx field.

lib/queries/useAuthoritiesBrowse/readme.md

@@ -0,0 +1,34 @@
+# useAuthoritiesBrowse
+This hook contains logic of Authority browsing functionality.
+
+### Usage
+
+`useAuthoritiesBrowse` returns an object with following properties:
+
+Name | type | description
+--- | --- | --- |
+`authorities` | array | Array of found Authority records
+`isLoading` | bool | Is a request pending
+`isLoaded` | bool | Has a request finished
+`hasNextPage` | bool | Can browse a next page
+`hasPrevPage` | bool | Can browse a previous page
+`handleLoadMore` | function | Function to fetch more data. Same API as `MCL`'s `onNeedMoreData`
+`query` | string | Formatted query string that is used for fetching results for currently browsed page
+`firstPageQuery` | string | Formatted query string that was used for fetching results for first browsed page (page with anchor)
+`totalRecords` | number | Number of total records found
+
+
+### Props
+Name | type | description | default | required
+--- | --- | --- | --- | ---
+`searchQuery` | string | Seqrch query provided by user | `` | true
+`searchIndex` | string | Search index provided by user | `` | true
+`filters` | object | Selected search filters. Structure: `{ filterName: ['filterValue1', 'filterValue2'] }`| undefined | true
+`pageSize` | number | Number of results per page | undefined | true
+`precedingRecordsCount` | number | Number of records before anchor item in results list | undefined | true
+`browsePageQuery` | string | Query that will be searched when viewing Next or Previous page | undefined | false
+`setBrowsePageQuery` | function | Setter function for `browsePageQuery` | undefined | true
+`browsePage` | number | Numerical order of the current viewed Browse page | undefined | false
+`setBrowsePage` | function | Setter function for `browsePage` | undefined | true
+`navigationSegmentValue` | string | Current segment of MARC authority search and browse view | undefined | false.
+`tenantId` | string | Tenant id in a multi-tenant environment | undefined | false

lib/queries/useAuthoritiesBrowse/useAuthoritiesBrowse.js

@@ -21,19 +21,8 @@ import { useTenantKy } from '../../temp/hooks/useTenantKy';
 
 const AUTHORITIES_BROWSE_API = 'browse/authorities';
 
-const useBrowseRequest = ({
-  filters,
-  searchQuery,
-  searchIndex,
-  startingSearch,
-  pageSize,
-  precedingRecordsCount,
-  tenantId,
-}) => {
-  const ky = useTenantKy({ tenantId });
-  const [namespace] = useNamespace({ key: QUERY_KEY_AUTHORITIES });
-
-  const cqlSearch = startingSearch ? [startingSearch] : [];
+const buildQuery = (searchString, searchIndex, filters) => {
+  const cqlSearch = searchString ? [searchString] : [];
 
   cqlSearch.push(`isTitleHeadingRef==${searchIndex === searchableIndexesValues.NAME_TITLE}`);
 
@@ -49,6 +38,23 @@ const useBrowseRequest = ({
 
   const query = [...cqlSearch, ...cqlFilters, headingTypeQuery].filter(Boolean).join(' and ');
 
+  return query;
+};
+
+const useBrowseRequest = ({
+  filters,
+  searchQuery,
+  searchIndex,
+  startingSearch,
+  pageSize,
+  precedingRecordsCount,
+  tenantId,
+}) => {
+  const ky = useTenantKy({ tenantId });
+  const [namespace] = useNamespace({ key: QUERY_KEY_AUTHORITIES });
+
+  const query = buildQuery(startingSearch, searchIndex, filters);
+
   const searchParams = {
     query,
     limit: pageSize,
@@ -227,6 +233,7 @@ const useAuthoritiesBrowse = ({
     isLoaded: isFetched,
     handleLoadMore,
     query,
+    firstPageQuery: buildQuery(buildPageQuery(searchQuery, 0), searchIndex, filters),
   });
 };