refactor: Utilities

Small refactor to move all utilities into a dedicated utilities directory, and ensure that anything exported from that dir is exported from the library itself as well

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 9.1.0 In progress
 * usePrevNextPagination null safety (yarn test warnings)
+* Refactor to move utilities tp dedicated directory
 
 ## 9.0.0 2023-10-12
 * Added useParallelBatchFetch hook

index.js

@@ -1,6 +1,8 @@
 // Components
 export { default as ActionMenu } from './lib/ActionMenu';
 export { default as AlternativeNamesFieldArray } from './lib/AlternativeNamesFieldArray';
+export { default as CustomMetaSection } from './lib/CustomMetaSection';
+export { default as DateFilter } from './lib/DateFilter';
 export { default as DocumentCard } from './lib/DocumentCard';
 export { default as DocumentFilter } from './lib/DocumentFilter';
 export { default as DocumentsFieldArray } from './lib/DocumentsFieldArray';
@@ -11,65 +13,32 @@ export { default as EResourceType } from './lib/EResourceType';
 export { default as FileUploader } from './lib/FileUploader';
 export { default as FileUploaderField } from './lib/FileUploaderField';
 export { default as FormattedDateTime } from './lib/FormattedDateTime';
+export { default as InfoBox } from './lib/InfoBox';
 export { default as InternalContactCard } from './lib/InternalContactCard';
 export { default as InternalContactSelection } from './lib/InternalContactSelection';
 export { default as InternalContactsFieldArray } from './lib/InternalContactsFieldArray';
 export { default as OrganizationsFieldArray } from './lib/OrganizationsFieldArray';
-export { default as DateFilter } from './lib/DateFilter';
-export { default as ViewOrganizationCard } from './lib/ViewOrganizationCard';
 export { default as LicenseCard } from './lib/LicenseCard';
 export { default as LicenseEndDate } from './lib/LicenseEndDate';
 export { default as LogsList } from './lib/LogsList';
 export { default as Logs } from './lib/Logs';
+export { default as NewBox } from './lib/NewBox';
 export { default as OrganizationSelection } from './lib/OrganizationSelection';
+export { default as SearchKeyControl } from './lib/SearchKeyControl';
 export { default as SerialCoverage } from './lib/SerialCoverage';
 export { default as Tags } from './lib/Tags';
 export { default as TitleOnPlatformLink } from './lib/TitleOnPlatformLink';
-export { default as CustomMetaSection } from './lib/CustomMetaSection';
-export { default as SearchKeyControl } from './lib/SearchKeyControl';
-
-// Functions, utilities, and misc.
-export { default as generateQueryParams } from './lib/generateQueryParams';
-export { default as getSASParams } from './lib/getSASParams';
-export { default as getSiblingIdentifier } from './lib/getSiblingIdentifier';
-export { default as getResourceIdentifier } from './lib/getResourceIdentifier';
-export { default as isPackage } from './lib/isPackage';
-export { default as renderUserName } from './lib/renderUserName';
-export { default as getRefdataValuesByDesc } from './lib/getRefdataValuesByDesc';
-export { default as renderDynamicRows } from './lib/renderDynamicRows';
-export { default as downloadBlob } from './lib/downloadBlob';
-export { default as recursiveUrlDecoding } from './lib/recursiveUrlDecoding';
-export { default as selectifyRefdata } from './lib/selectifyRefdata';
-
-export {
-  tagsPath,
-  defaultTagsParams,
-  defaultTagQuery,
-  tagNamespaceArray
-} from './lib/tagsConfig'; // Tag configuration for consistency across ERM apps
-
-export { default as preventResourceRefresh } from './lib/preventResourceRefresh';
-export {
-  composeValidators,
-  composeValidatorsWithArgs,
-  invalidNumber as invalidNumberValidator,
-  rangeOverflow,
-  rangeUnderflow,
-  required as requiredValidator,
-  requiredObject as requiredObjectValidator,
-} from './lib/validators';
-
-export { default as handleSaveKeyCommand } from './lib/keyboardShortcutHandlers';
+export { default as ViewOrganizationCard } from './lib/ViewOrganizationCard';
 
 // Shared registry components/functions
 export { default as InternalContactsArrayDisplay } from './lib/InternalContactsArrayDisplay';
 export { default as OrganizationsArrayDisplay } from './lib/OrganizationsArrayDisplay';
 
-export { default as InfoBox } from './lib/InfoBox';
-export { default as NewBox } from './lib/NewBox';
-
 // customHooks
 export * from './lib/hooks';
 
 // constants
 export * from './lib/constants';
+
+// utility functions
+export * from './lib/utils';

lib/AlternativeNamesFieldArray/AlternativeNamesField.js

@@ -3,7 +3,7 @@ import PropTypes from 'prop-types';
 import { Field } from 'react-final-form';
 
 import { TextField } from '@folio/stripes/components';
-import { required } from '../validators';
+import { requiredValidator as required } from '../utils';
 
 export default class AlternativeNamesField extends React.Component {
   static propTypes = {

lib/DocumentFilter/DocumentFilterRule.js

@@ -12,7 +12,7 @@ import {
 } from '@folio/stripes/components';
 import { FormattedMessage, useIntl } from 'react-intl';
 import { Field } from 'react-final-form';
-import { required as requiredValidator } from '../validators';
+import { requiredValidator } from '../utils';
 import DocumentFilterRuleConstants from './DocumentFilterRuleConstants';
 
 const DocumentFilterRule = ({

lib/DocumentsFieldArray/DocumentField.js

@@ -13,7 +13,7 @@ import {
 } from '@folio/stripes/components';
 
 import FileUploaderField from '../FileUploaderField';
-import { composeValidators } from '../validators';
+import { composeValidators } from '../utils';
 
 const MAX_URL_SIZE = 2048;
 export default class DocumentField extends React.Component {

lib/EResourceType/EResourceType.js

@@ -1,7 +1,7 @@
 import React from 'react';
 import PropTypes from 'prop-types';
 import { FormattedMessage } from 'react-intl';
-import isPackage from '../isPackage';
+import { isPackage } from '../utils';
 
 export default class EResourceType extends React.Component {
   static propTypes = {

lib/InternalContactCard/InternalContactCard.js

@@ -1,11 +1,12 @@
 import React from 'react';
 import PropTypes from 'prop-types';
+import { FormattedMessage } from 'react-intl';
+
 import { Link } from 'react-router-dom';
 import { AppIcon } from '@folio/stripes/core';
-import { FormattedMessage } from 'react-intl';
 import { Card, Col, KeyValue, NoValue, Row } from '@folio/stripes/components';
 
-import renderUserName from '../renderUserName';
+import { renderUserName } from '../utils';
 
 export default class ContactCard extends React.Component {
   static propTypes = {

lib/InternalContactSelection/InternalContactSelection.js

@@ -1,9 +1,10 @@
-import React, { useEffect, useMemo, useState } from 'react';
+import { useEffect, useMemo, useState } from 'react';
 import PropTypes from 'prop-types';
 import uniqBy from 'lodash/uniqBy';
 
 import { useChunkedUsers, useParallelBatchFetch } from '../hooks';
-import renderUserName from '../renderUserName';
+import { renderUserName } from '../utils';
+
 import InternalContactSelectionDisplay from './InternalContactSelectionDisplay';
 
 const InternalContactSelection = ({

lib/InternalContactsArrayDisplay/InternalContactsArrayDisplay.js

@@ -4,7 +4,7 @@ import { useQuery } from 'react-query';
 import { useOkapiKy } from '@folio/stripes/core';
 import { Row } from '@folio/stripes/components';
 
-import renderUserName from '../renderUserName';
+import { renderUserName } from '../utils';
 
 const InternalContactsArrayDisplay = ({ contacts }) => {
   /* eslint-disable no-param-reassign */

lib/InternalContactsFieldArray/InternalContactsFieldArray.js

@@ -12,7 +12,7 @@ import {
 
 import { useKiwtFieldArray } from '@k-int/stripes-kint-components';
 import EditCard from '../EditCard';
-import { composeValidators, required } from '../validators';
+import { composeValidators, requiredValidator as required } from '../utils';
 
 import UserField from './UserField';
 

lib/InternalContactsFieldArray/UserField.js

@@ -1,6 +1,8 @@
 import React from 'react';
 import PropTypes from 'prop-types';
 import { FormattedMessage } from 'react-intl';
+import { Link } from 'react-router-dom';
+
 import {
   Button,
   Card,
@@ -13,9 +15,9 @@ import {
 } from '@folio/stripes/components';
 import { AppIcon, Pluggable } from '@folio/stripes/core';
 
-import { Link } from 'react-router-dom';
+import { renderUserName } from '../utils';
+
 import css from '../styles.css';
-import renderUserName from '../renderUserName';
 
 export default class UserField extends React.Component {
   static propTypes = {

lib/OrganizationsFieldArray/EditOrganizationCard.js

@@ -12,7 +12,7 @@ import {
 } from '@folio/stripes/components';
 
 import EditCard from '../EditCard';
-import { required } from '../validators';
+import { requiredValidator as required } from '../utils';
 import ViewOrganizationCard from '../ViewOrganizationCard';
 import RolesFieldArray from './RolesFieldArray';
 import FieldPrimaryOrg from './FieldPrimaryOrg';

lib/OrganizationsFieldArray/RolesFieldArray.js

@@ -14,7 +14,7 @@ import {
 } from '@folio/stripes/components';
 import { useKiwtFieldArray } from '@k-int/stripes-kint-components';
 
-import { required } from '../validators';
+import { requiredValidator as required } from '../utils';
 import { usePrevious } from '../hooks';
 
 // Utility function to check if two arrays of scalars contain the same items (Order does not count)

lib/Tags/Tags.js

@@ -1,4 +1,4 @@
-import React, { useContext } from 'react';
+import { useContext } from 'react';
 import PropTypes from 'prop-types';
 
 import { FormattedMessage } from 'react-intl';
@@ -12,7 +12,7 @@ import { Pane } from '@folio/stripes/components';
 import { TagsForm } from '@folio/stripes/smart-components';
 
 import { useTags } from '../hooks';
-import { tagNamespaceArray } from '../tagsConfig';
+import { tagNamespaceArray } from '../utils';
 
 const Tags = ({
   invalidateLinks = [], // If there are other queries that need invalidating, pass those here

lib/hooks/useExportLogStream/useExportLogStream.js

@@ -4,7 +4,7 @@ import { useQuery } from 'react-query';
 
 import { CalloutContext, useOkapiKy } from '@folio/stripes/core';
 
-import downloadBlob from '../../downloadBlob';
+import { downloadBlob } from '../../utils';
 
 const useExportLogStream = (job, type) => {
   const callout = useContext(CalloutContext);

lib/hooks/useFileHandlers.js

@@ -1,7 +1,7 @@
 import { useMutation } from 'react-query';
 
 import { useOkapiKy } from '@folio/stripes/core';
-import downloadBlob from '../downloadBlob';
+import { downloadBlob } from '../utils';
 
 const useFileHandlers = (fileEndpoint) => {
   const ky = useOkapiKy();

lib/hooks/useTags.js

@@ -1,6 +1,6 @@
 import { useQuery } from 'react-query';
 import { useOkapiKy } from '@folio/stripes/core';
-import { defaultTagQuery, tagNamespaceArray } from '../tagsConfig';
+import { defaultTagQuery, tagNamespaceArray } from '../utils';
 
 const useTags = (namespaceArray, options) => {
   const ky = useOkapiKy();

lib/utils/index.js

@@ -0,0 +1,35 @@
+// Stripes connect utils (Maybe redundant)
+export { default as generateQueryParams } from './generateQueryParams';
+export { default as getSASParams } from './getSASParams';
+export { default as preventResourceRefresh } from './preventResourceRefresh';
+
+// Validators
+export {
+  composeValidators,
+  composeValidatorsWithArgs,
+  invalidNumber as invalidNumberValidator,
+  rangeOverflow,
+  rangeUnderflow,
+  required as requiredValidator,
+  requiredObject as requiredObjectValidator,
+} from './validators';
+
+// Tag configuration for consistency across ERM apps
+export {
+  tagsPath,
+  defaultTagsParams,
+  defaultTagQuery,
+  tagNamespaceArray
+} from './tagsConfig'; 
+
+// Rest of utils
+export { default as downloadBlob } from './downloadBlob';
+export { default as getRefdataValuesByDesc } from './getRefdataValuesByDesc';
+export { default as isPackage } from './isPackage';
+export { default as handleSaveKeyCommand } from './keyboardShortcutHandlers';
+export { default as recursiveUrlDecoding } from './recursiveUrlDecoding';
+export { default as renderDynamicRows } from './renderDynamicRows';
+export { default as renderUserName } from './renderUserName';
+export { default as selectifyRefdata } from './selectifyRefdata';
+export { default as getSiblingIdentifier } from './getSiblingIdentifier';
+export { default as getResourceIdentifier } from './getResourceIdentifier';

lib/utils/renderDynamicRows/index.js

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