refactor: rename custom hooks

lib/hooks/index.js

@@ -12,7 +12,6 @@ export * from './useDefaultReceivingSearchSettings';
 export * from './useEventEmitter';
 export * from './useExchangeRateValue';
 export * from './useFunds';
-export * from './useHoldingsAndLocations';
 export * from './useIdentifierTypes';
 export * from './useInstanceHoldings';
 export * from './useInstanceHoldingsQuery';
@@ -33,6 +32,7 @@ export * from './usePaneFocus';
 export * from './useReceivingTenantIdsAndLocations';
 export * from './useShowCallout';
 export * from './useTags';
+export * from './useTenantHoldingsAndLocations';
 export * from './useToggle';
 export * from './useTranslatedCategories';
 export * from './useUser';

lib/hooks/useReceivingTenantIdsAndLocations/useReceivingTenantIdsAndLocations.js

@@ -3,6 +3,10 @@ import { useMemo } from 'react';
 
 import { useCurrentUserTenants } from '../consortia';
 
+/*
+  The purpose of this hook is to generate the list of unique tenantIds and locationIds
+  for the receiving tenant and locations when we need to fetch locations from other tenants via `useTenantHoldingsAndLocations`
+*/
 export const useReceivingTenantIdsAndLocations = ({
   currentReceivingTenantId,
   currentLocationId: locationId,

lib/hooks/useTenantHoldingsAndLocations/index.js

@@ -0,0 +1 @@
+export { useTenantHoldingsAndLocations } from './useTenantHoldingsAndLocations';

lib/hooks/useHoldingsAndLocations/useHoldingsAndLocations.js → lib/hooks/useTenantHoldingsAndLocations/useTenantHoldingsAndLocations.js

@@ -7,13 +7,17 @@ import {
 
 import { LIMIT_MAX } from '../../constants';
 import {
-  getHoldingLocations,
-  getHoldingLocationsByTenants,
+  getHoldingsAndLocations,
+  getHoldingsAndLocationsByTenants,
 } from '../../utils';
 
 const DEFAULT_DATA = [];
 
-export const useHoldingsAndLocations = ({
+/*
+  The purpose of this hook is to fetch holdings and locations for a given instanceId
+  and tenants when we need to fetch locations from other tenants when Central ordering is enabled.
+*/
+export const useTenantHoldingsAndLocations = ({
   instanceId,
   options = {},
   tenantId,
@@ -63,8 +67,8 @@ export const useHoldingsAndLocations = ({
     queryKey,
     queryFn: ({ signal }) => {
       return receivingTenantIds.length
-        ? getHoldingLocationsByTenants({ ky, instanceId, receivingTenantIds, additionalTenantLocationIdsMap })
-        : getHoldingLocations({ ky, searchParams, signal, additionalLocationIds });
+        ? getHoldingsAndLocationsByTenants({ ky, instanceId, receivingTenantIds, additionalTenantLocationIdsMap })
+        : getHoldingsAndLocations({ ky, searchParams, signal, additionalLocationIds });
     },
     enabled: enabled && Boolean(instanceId),
     ...queryOptions,

lib/hooks/useHoldingsAndLocations/useHoldingsAndLocations.test.js → lib/hooks/useTenantHoldingsAndLocations/useTenantHoldingsAndLocations.test.js

@@ -10,7 +10,7 @@ import { useOkapiKy } from '@folio/stripes/core';
 
 import { HOLDINGS_API } from '../../constants';
 import { extendKyWithTenant } from '../../utils';
-import { useHoldingsAndLocations } from './useHoldingsAndLocations';
+import { useTenantHoldingsAndLocations } from './useTenantHoldingsAndLocations';
 
 jest.mock('../../utils', () => ({
   ...jest.requireActual('../../utils'),
@@ -49,7 +49,7 @@ const getMock = jest.fn()
   .mockReturnValueOnce({ json: () => Promise.resolve({ holdingsRecords }) })
   .mockReturnValue({ json: () => Promise.resolve({ locations }) });
 
-describe('useHoldingsAndLocations', () => {
+describe('useTenantHoldingsAndLocations', () => {
   beforeEach(() => {
     useOkapiKy
       .mockClear()
@@ -73,7 +73,7 @@ describe('useHoldingsAndLocations', () => {
   });
 
   it('should fetch holding locations', async () => {
-    const { result, waitFor } = renderHook(() => useHoldingsAndLocations({ instanceId: '1', tenantId: '2' }), { wrapper });
+    const { result, waitFor } = renderHook(() => useTenantHoldingsAndLocations({ instanceId: '1', tenantId: '2' }), { wrapper });
 
     await waitFor(() => expect(result.current.isLoading).toBeFalsy());
 
@@ -82,7 +82,7 @@ describe('useHoldingsAndLocations', () => {
 
   it('should fetch holding locations with different tenants', async () => {
     const receivingTenantIds = ['1', '2'];
-    const { result, waitFor } = renderHook(() => useHoldingsAndLocations({ instanceId: '1', receivingTenantIds, tenantId: '2' }), { wrapper });
+    const { result, waitFor } = renderHook(() => useTenantHoldingsAndLocations({ instanceId: '1', receivingTenantIds, tenantId: '2' }), { wrapper });
 
     await waitFor(() => expect(result.current.isLoading).toBeFalsy());
 

lib/utils/getHoldingLocations.js → lib/utils/getTenantHoldingsAndLocations.js

@@ -8,7 +8,7 @@ import { extendKyWithTenant } from './extendKyWithTenant';
 
 const DEFAULT_DATA = [];
 
-export const getHoldingLocations = async ({
+export const getHoldingsAndLocations = async ({
   ky,
   searchParams,
   signal,
@@ -48,7 +48,7 @@ export const getHoldingLocations = async ({
   };
 };
 
-export const getHoldingLocationsByTenants = async ({
+export const getHoldingsAndLocationsByTenants = async ({
   ky,
   instanceId,
   /*
@@ -77,7 +77,7 @@ export const getHoldingLocationsByTenants = async ({
   const locationsRequest = receivingTenantIds.map(async (tenantId) => {
     const tenantKy = extendKyWithTenant(ky, tenantId);
 
-    return getHoldingLocations({
+    return getHoldingsAndLocations({
       ky: tenantKy,
       searchParams,
       tenantId,

lib/utils/getHoldingLocations.test.js → lib/utils/getTenantHoldingsAndLocations.test.js

@@ -1,9 +1,9 @@
 import { HOLDINGS_API } from '../constants';
 import { extendKyWithTenant } from './extendKyWithTenant';
 import {
-  getHoldingLocations,
-  getHoldingLocationsByTenants,
-} from './getHoldingLocations';
+  getHoldingsAndLocations,
+  getHoldingsAndLocationsByTenants,
+} from './getTenantHoldingsAndLocations';
 
 jest.mock('./extendKyWithTenant', () => ({
   extendKyWithTenant: jest.fn(),
@@ -38,12 +38,12 @@ describe('utils', () => {
     };
   });
 
-  describe('getHoldingLocations', () => {
+  describe('getHoldingsAndLocations', () => {
     it('should return holdings, locations and locationIds', async () => {
       const searchParams = {};
       const signal = { signal: 'signal' };
 
-      const result = await getHoldingLocations({ ky, searchParams, signal });
+      const result = await getHoldingsAndLocations({ ky, searchParams, signal });
 
       expect(result).toEqual({
         holdings: holdingsRecords,
@@ -57,7 +57,7 @@ describe('utils', () => {
       const signal = { signal: 'signal' };
       const tenantId = 'tenant-id';
 
-      const result = await getHoldingLocations({ ky, searchParams, signal, tenantId });
+      const result = await getHoldingsAndLocations({ ky, searchParams, signal, tenantId });
 
       expect(result).toEqual({
         holdings: holdingsRecords.map(holding => ({ ...holding, tenantId })),
@@ -67,7 +67,7 @@ describe('utils', () => {
     });
   });
 
-  describe('getHoldingLocationsByTenants', () => {
+  describe('getHoldingsAndLocationsByTenants', () => {
     beforeEach(() => {
       extendKyWithTenant.mockImplementation((tenantKy, tenantId) => {
         return { ...tenantKy, tenantId };
@@ -78,7 +78,7 @@ describe('utils', () => {
       const instanceId = 'instance-id';
       const receivingTenantIds = ['tenant-id'];
 
-      const result = await getHoldingLocationsByTenants({ ky, instanceId, receivingTenantIds });
+      const result = await getHoldingsAndLocationsByTenants({ ky, instanceId, receivingTenantIds });
 
       expect(result).toEqual({
         holdings: holdingsRecords.map(holding => ({ ...holding, tenantId: receivingTenantIds[0] })),
@@ -90,7 +90,7 @@ describe('utils', () => {
     it('should return empty array of holdings, locations and locationIds when `receivingTenantIds` and not present or empty array', async () => {
       const instanceId = 'instance-id';
 
-      const result = await getHoldingLocationsByTenants({
+      const result = await getHoldingsAndLocationsByTenants({
         ky,
         instanceId,
       });

lib/utils/index.js

@@ -21,7 +21,7 @@ export * from './getConfigSetting';
 export * from './getControlledVocabTranslations';
 export * from './getErrorCodeFromResponse';
 export * from './getFundsForSelect';
-export * from './getHoldingLocations';
+export * from './getTenantHoldingsAndLocations';
 export * from './getLocationOptions';
 export * from './getMoneyMultiplier';
 export * from './getOrganizationsOptions';