folio-org · NikitaSedyx · Jan 30, 2024 · Jan 30, 2024
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Change history for ui-receiving
 
-## 4.1.0 (IN PROGRESS)
+## 5.0.0 (IN PROGRESS)
 * Include Accession number field in receive all view. Refs UIREC-285.
 * Display and edit claiming active and interval fields in receiving title. Refs UIREC-288.
 * Optimize pieces query to improve performance. Refs UIREC-298.
@@ -13,6 +13,7 @@
 * Add the "Acquisition units" protected field to the receiving title form. Refs UIREC-295.
 * Delay claim action for piece record. Refs UIREC-303.
 * Send claim action for piece record. Refs UIREC-304.
+* *BREAKING* Bump minimum okapi interfaces for `pieces` (3.0) and `receiving` (2.0). Refs UIREC-316.
 
 ## [4.0.0](https://github.com/folio-org/ui-receiving/tree/v4.0.0) (2023-10-12)
 [Full Changelog](https://github.com/folio-org/ui-receiving/compare/v3.0.0...v4.0.0)

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@folio/receiving",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "description": "Description for receiving",
   "main": "index.js",
   "repository": "",
@@ -31,8 +31,8 @@
       "order-lines": "2.0 3.0",
       "orders": "11.0 12.0",
       "organizations.organizations": "1.0",
-      "pieces": "2.0",
-      "receiving": "1.0",
+      "pieces": "3.0",
+      "receiving": "2.0",
       "search": "0.5 0.6 1.0",
       "tags": "1.0",
       "titles": "1.2",

diff --git a/src/ReceivingList/ExportSettingsModal/constants.js b/src/ReceivingList/ExportSettingsModal/constants.js
@@ -14,7 +14,7 @@ export const EXPORT_TITLE_FIELDS = {
 };
 
 export const EXPORT_PIECE_FIELDS = {
-  caption: 'Caption',
+  displaySummary: 'Display summary',
   copyNumber: 'Copy number',
   enumeration: 'Enumeration',
   chronology: 'Chronology',

diff --git a/src/ReceivingList/ExportSettingsModal/utils/createExportReport.js b/src/ReceivingList/ExportSettingsModal/utils/createExportReport.js
@@ -76,7 +76,7 @@ export const createExportReport = (
     const item = itemsMap[pieceData.itemId];
 
     return {
-      caption: pieceData.caption,
+      displaySummary: pieceData.displaySummary,
       copyNumber: pieceData.copyNumber,
       enumeration: pieceData.enumeration,
       chronology: pieceData.chronology,

diff --git a/src/ReceivingList/ExportSettingsModal/utils/createExportReport.test.js b/src/ReceivingList/ExportSettingsModal/utils/createExportReport.test.js
@@ -77,7 +77,7 @@ const params = {
     {
       id: 'a3a7c49e-7e3c-43e2-a200-94048703539f',
       format: 'Other',
-      caption: 'Caption',
+      displaySummary: 'Display summary',
       chronology: '2022',
       enumeration: 'v1',
       comment: 'test export',
@@ -100,7 +100,7 @@ describe('createExportReport', () => {
     expect(createExportReport(params, { intl })).toEqual([expect.objectContaining({
       barcode: '9876543456',
       callNumber: 'TST',
-      caption: 'Caption',
+      displaySummary: 'Display summary',
       chronology: '2022',
       comment: 'test export',
       copyNumber: '3',

diff --git a/src/ReceivingList/ExportSettingsModal/utils/getExportFields.test.js b/src/ReceivingList/ExportSettingsModal/utils/getExportFields.test.js
@@ -22,7 +22,7 @@ describe('getExportFields', () => {
 
   it('should return for export an array with selected fields', () => {
     const titleFields = [{ value: 'title' }];
-    const pieceFields = [{ value: 'caption' }];
+    const pieceFields = [{ value: 'displaySummary' }];
 
     const exportSettings = {
       exportPieceFields: EXPORT_FIELDS_PARAMS.selected,
@@ -33,6 +33,6 @@ describe('getExportFields', () => {
 
     const fields = getExportFields(exportSettings);
 
-    expect(fields).toEqual(['title', 'caption']);
+    expect(fields).toEqual(['title', 'displaySummary']);
   });
 });
diff --git a/src/TitleDetails/AddPieceModal/AddPieceModal.js b/src/TitleDetails/AddPieceModal/AddPieceModal.js
@@ -294,9 +294,9 @@ const AddPieceModal = ({
                     <Field
                       component={TextField}
                       fullWidth
-                      id="caption"
-                      label={<FormattedMessage id="ui-receiving.piece.caption" />}
-                      name="caption"
+                      id="displaySummary"
+                      label={<FormattedMessage id="ui-receiving.piece.displaySummary" />}
+                      name="displaySummary"
                       type="text"
                     />
                   </Col>

diff --git a/src/TitleDetails/AddPieceModal/AddPieceModalContainer.test.js b/src/TitleDetails/AddPieceModal/AddPieceModalContainer.test.js
@@ -46,8 +46,8 @@ describe('AddPieceModalContainer', () => {
     const { getByLabelText, getByText } = renderAddPieceModalContainer();
 
     // header is rendered
-    expect(getByText('ui-receiving.piece.caption')).toBeDefined();
-    expect(getByLabelText('ui-receiving.piece.caption')).toBeDefined();
+    expect(getByText('ui-receiving.piece.displaySummary')).toBeDefined();
+    expect(getByLabelText('ui-receiving.piece.displaySummary')).toBeDefined();
     expect(getByText('ui-receiving.piece.copyNumber')).toBeDefined();
     expect(getByLabelText('ui-receiving.piece.copyNumber')).toBeDefined();
     expect(getByText('ui-receiving.piece.enumeration')).toBeDefined();
@@ -66,7 +66,7 @@ describe('AddPieceModalContainer', () => {
       },
     });
 
-    expect(getByLabelText('ui-receiving.piece.caption').disabled).toBeFalsy();
+    expect(getByLabelText('ui-receiving.piece.displaySummary').disabled).toBeFalsy();
     expect(getByLabelText('ui-receiving.piece.copyNumber').disabled).toBeFalsy();
     expect(getByLabelText('ui-receiving.piece.enumeration').disabled).toBeFalsy();
     expect(getByText('stripes-acq-components.piece.pieceFormat.physical')).toBeDefined();

diff --git a/src/TitleDetails/ExpectedPiecesList/ExpectedPiecesList.test.js b/src/TitleDetails/ExpectedPiecesList/ExpectedPiecesList.test.js
@@ -52,7 +52,7 @@ describe('Given Expected Pieces List', () => {
     // header is rendered
     expect(getByText('ui-receiving.piece.copyNumber')).toBeDefined();
     expect(getByText('ui-receiving.piece.chronology')).toBeDefined();
-    expect(getByText('ui-receiving.piece.caption')).toBeDefined();
+    expect(getByText('ui-receiving.piece.displaySummary')).toBeDefined();
     expect(getByText('ui-receiving.piece.enumeration')).toBeDefined();
     expect(getByText('ui-receiving.piece.format')).toBeDefined();
     expect(getByText('ui-receiving.piece.receiptDate')).toBeDefined();

diff --git a/src/TitleDetails/ReceivedPiecesList/ReceivedPiecesList.test.js b/src/TitleDetails/ReceivedPiecesList/ReceivedPiecesList.test.js
@@ -47,7 +47,7 @@ describe('Given Received Pieces List', () => {
 
     // header is rendered
     expect(getByText('ui-receiving.piece.copyNumber')).toBeDefined();
-    expect(getByText('ui-receiving.piece.caption')).toBeDefined();
+    expect(getByText('ui-receiving.piece.displaySummary')).toBeDefined();
     expect(getByText('ui-receiving.piece.barcode')).toBeDefined();
     expect(getByText('ui-receiving.piece.enumeration')).toBeDefined();
     expect(getByText('ui-receiving.piece.format')).toBeDefined();

diff --git a/src/TitleDetails/constants.js b/src/TitleDetails/constants.js
@@ -33,10 +33,10 @@ export const ORDER_FORMAT_TO_PIECE_FORMAT = {
 };
 
 export const PIECE_COLUMNS = {
-  caption: 'caption',
   callNumber: 'callNumber',
   chronology: 'chronology',
   copyNumber: 'copyNumber',
+  displaySummary: 'displaySummary',
   enumeration: 'enumeration',
   receiptDate: 'receiptDate',
   receivedDate: 'receivedDate',
@@ -49,7 +49,7 @@ export const PIECE_COLUMNS = {
 };
 
 const PIECE_VISIBLE_COLUMNS = [
-  PIECE_COLUMNS.caption,
+  PIECE_COLUMNS.displaySummary,
   PIECE_COLUMNS.copyNumber,
   PIECE_COLUMNS.enumeration,
   PIECE_COLUMNS.chronology,
@@ -60,7 +60,7 @@ const PIECE_VISIBLE_COLUMNS = [
 export const SORTABLE_COLUMNS = [PIECE_COLUMNS.enumeration, PIECE_COLUMNS.receiptDate, PIECE_COLUMNS.receivedDate];
 
 export const EXPECTED_PIECE_VISIBLE_COLUMNS = [
-  PIECE_COLUMNS.caption,
+  PIECE_COLUMNS.displaySummary,
   PIECE_COLUMNS.status,
   ...PIECE_VISIBLE_COLUMNS.slice(1),
   PIECE_COLUMNS.receiptDate,
@@ -79,7 +79,7 @@ export const UNRECEIVABLE_PIECE_VISIBLE_COLUMNS = [...RECEIVED_PIECE_VISIBLE_COL
 export const PIECE_COLUMN_MAPPING = {
   [PIECE_COLUMNS.copyNumber]: <FormattedMessage id="ui-receiving.piece.copyNumber" />,
   [PIECE_COLUMNS.chronology]: <FormattedMessage id="ui-receiving.piece.chronology" />,
-  [PIECE_COLUMNS.caption]: <FormattedMessage id="ui-receiving.piece.caption" />,
+  [PIECE_COLUMNS.displaySummary]: <FormattedMessage id="ui-receiving.piece.displaySummary" />,
   barcode: <FormattedMessage id="ui-receiving.piece.barcode" />,
   [PIECE_COLUMNS.enumeration]: <FormattedMessage id="ui-receiving.piece.enumeration" />,
   format: <FormattedMessage id="ui-receiving.piece.format" />,
@@ -96,7 +96,7 @@ export const PIECE_COLUMN_BASE_FORMATTER = {
   [PIECE_COLUMNS.request]: record => (record.request ? <FormattedMessage id="ui-receiving.piece.request.isOpened" /> : <NoValue />),
   [PIECE_COLUMNS.format]: ({ format }) => PIECE_FORMAT_LABELS[format],
   [PIECE_COLUMNS.callNumber]: record => record.callNumber || <NoValue />,
-  [PIECE_COLUMNS.caption]: record => record.caption || <NoValue />,
+  [PIECE_COLUMNS.displaySummary]: record => record.displaySummary || <NoValue />,
   [PIECE_COLUMNS.copyNumber]: record => record.copyNumber || <NoValue />,
   [PIECE_COLUMNS.barcode]: record => record.barcode || <NoValue />,
   [PIECE_COLUMNS.status]: record => record.receivingStatus || <NoValue />,

diff --git a/src/TitleExpect/TitleExpectList.test.js b/src/TitleExpect/TitleExpectList.test.js
@@ -16,7 +16,7 @@ const defaultProps = {
 
 const piece = {
   id: 'piece-id',
-  caption: 'Test piece',
+  displaySummary: 'Test piece',
 };
 
 const FormComponent = stripesFinalForm({})(({ children }) => <form>{children}</form>);

diff --git a/src/TitleExpect/constants.js b/src/TitleExpect/constants.js
@@ -3,7 +3,7 @@ import { PIECE_COLUMNS } from '../TitleDetails/constants';
 export const TITLE_EXPECT_PIECES_VISIBLE_COLUMNS = [
   'checked',
   PIECE_COLUMNS.barcode,
-  PIECE_COLUMNS.caption,
+  PIECE_COLUMNS.displaySummary,
   PIECE_COLUMNS.enumeration,
   PIECE_COLUMNS.format,
   PIECE_COLUMNS.request,

diff --git a/src/TitleReceive/TitleReceiveList.js b/src/TitleReceive/TitleReceiveList.js
@@ -27,7 +27,7 @@ import { useFieldArrowNavigation } from './useFieldArrowNavigation';
 
 const visibleColumns = [
   'checked',
-  'caption',
+  'displaySummary',
   'enumeration',
   'copyNumber',
   'accessionNumber',
@@ -58,13 +58,13 @@ export const TitleReceiveList = ({
   const cellFormatters = useMemo(
     () => {
       return {
-        caption: record => (
+        displaySummary: record => (
           <Field
-            name={`${field}[${record.rowIndex}].caption`}
+            name={`${field}[${record.rowIndex}].displaySummary`}
             component={TextField}
             marginBottom0
             fullWidth
-            aria-label={intl.formatMessage({ id: 'ui-receiving.piece.caption' })}
+            aria-label={intl.formatMessage({ id: 'ui-receiving.piece.displaySummary' })}
           />
         ),
         copyNumber: record => (
@@ -189,7 +189,7 @@ export const TitleReceiveList = ({
           aria-label={intl.formatMessage({ id: 'ui-receiving.piece.actions.selectAll' })}
         />
       ),
-      caption: <FormattedMessage id="ui-receiving.piece.caption" />,
+      displaySummary: <FormattedMessage id="ui-receiving.piece.displaySummary" />,
       copyNumber: <FormattedMessage id="ui-receiving.piece.copyNumber" />,
       enumeration: <FormattedMessage id="ui-receiving.piece.enumeration" />,
       accessionNumber: <FormattedMessage id="ui-receiving.piece.accessionNumber" />,

diff --git a/src/TitleReceive/useFieldArrowNavigation.test.js b/src/TitleReceive/useFieldArrowNavigation.test.js
@@ -3,7 +3,7 @@ import { renderHook } from '@folio/jest-config-stripes/testing-library/react';
 import { useFieldArrowNavigation } from './useFieldArrowNavigation';
 
 const fieldSetName = 'pieces';
-const getFieldName = idx => `${fieldSetName}[${idx}].caption`;
+const getFieldName = idx => `${fieldSetName}[${idx}].displaySummary`;
 const createEvent = options => ({
   preventDefault: jest.fn(),
   stopPropagation: jest.fn(),

diff --git a/src/TitleUnreceive/TitleUnreceiveList.js b/src/TitleUnreceive/TitleUnreceiveList.js
@@ -20,7 +20,7 @@ import {
 const visibleColumns = [
   'checked',
   'barcode',
-  'caption',
+  'displaySummary',
   'enumeration',
   'format',
   'hasRequest',
@@ -65,7 +65,7 @@ export const TitleUnreceiveList = ({ fields, props: { pieceLocationMap, pieceHol
         ),
         format: ({ format }) => PIECE_FORMAT_LABELS[format],
         callNumber: record => record.callNumber || <NoValue />,
-        caption: record => record.caption || <NoValue />,
+        displaySummary: record => record.displaySummary || <NoValue />,
         barcode: record => record.barcode || <NoValue />,
       };
     },
@@ -93,7 +93,7 @@ export const TitleUnreceiveList = ({ fields, props: { pieceLocationMap, pieceHol
         />
       ),
       barcode: <FormattedMessage id="ui-receiving.piece.barcode" />,
-      caption: <FormattedMessage id="ui-receiving.piece.caption" />,
+      displaySummary: <FormattedMessage id="ui-receiving.piece.displaySummary" />,
       enumeration: <FormattedMessage id="ui-receiving.piece.enumeration" />,
       format: <FormattedMessage id="ui-receiving.piece.format" />,
       hasRequest: <FormattedMessage id="ui-receiving.piece.request" />,

diff --git a/src/common/hooks/usePaginatedPieces/searchConfigs.js b/src/common/hooks/usePaginatedPieces/searchConfigs.js
@@ -3,7 +3,7 @@ import moment from 'moment';
 import { DATE_FORMAT } from '@folio/stripes-acq-components';
 
 const indexes = [
-  'caption',
+  'displaySummary',
   'chronology',
   'comment',
   'copyNumber',

diff --git a/src/common/hooks/usePaginatedPieces/searchConfigs.test.js b/src/common/hooks/usePaginatedPieces/searchConfigs.test.js
@@ -11,7 +11,7 @@ describe('makeKeywordQueryBuilder', () => {
       const dateFormat = 'MM/DD/YYYY';
 
       expect(makeKeywordQueryBuilder(dateFormat)(searchQuery)).toEqual(
-        `caption=="*${searchQuery}*" or chronology=="*${searchQuery}*" or comment=="*${searchQuery}*" or ` +
+        `displaySummary=="*${searchQuery}*" or chronology=="*${searchQuery}*" or comment=="*${searchQuery}*" or ` +
         `copyNumber=="*${searchQuery}*" or enumeration=="*${searchQuery}*" or ` +
         `receiptDate=="*${searchByDate(dateFormat, searchQuery)}*" or receivedDate=="*${searchByDate(dateFormat, searchQuery)}*"`,
       );

diff --git a/src/common/hooks/usePieceMutator.test.js b/src/common/hooks/usePieceMutator.test.js
@@ -39,7 +39,7 @@ describe('usePieceMutator', () => {
     await result.current.mutatePiece({
       piece: {
         holdingId: 'holdingId',
-        caption: 'v1',
+        displaySummary: 'v1',
       },
     });
 
@@ -58,7 +58,7 @@ describe('usePieceMutator', () => {
       piece: {
         id: 'pieceId',
         holdingId: 'holdingId',
-        caption: 'v1',
+        displaySummary: 'v1',
       },
     });
 
@@ -69,7 +69,7 @@ describe('usePieceMutator', () => {
     const pieceValues = {
       id: 'pieceId',
       holdingId: 'holdingId',
-      caption: 'v1',
+      displaySummary: 'v1',
       isCreateItem: true,
     };
 
@@ -93,7 +93,7 @@ describe('usePieceMutator', () => {
     const pieceValues = {
       id: 'pieceId',
       holdingId: 'holdingId',
-      caption: 'v1',
+      displaySummary: 'v1',
     };
 
     useOkapiKy.mockClear().mockReturnValue(kyMock);

diff --git a/src/common/hooks/useQuickReceive.test.js b/src/common/hooks/useQuickReceive.test.js
@@ -31,7 +31,7 @@ jest.mock('./useReceive', () => ({
 const pieceValues = {
   id: 'pieceId',
   holdingId: 'holdingId',
-  caption: 'v1',
+  displaySummary: 'v1',
 };
 
 describe('useQuickReceive', () => {

diff --git a/src/common/hooks/useReceive.js b/src/common/hooks/useReceive.js
@@ -19,7 +19,7 @@ export const useReceive = (options = {}) => {
           accessionNumber: piece.accessionNumber,
           callNumber: piece.callNumber,
           comment: piece.comment,
-          caption: piece.caption,
+          displaySummary: piece.displaySummary,
           chronology: piece.chronology,
           copyNumber: piece.copyNumber,
           displayOnHolding: piece.displayOnHolding,

diff --git a/src/common/hooks/useReceive.test.js b/src/common/hooks/useReceive.test.js
@@ -12,7 +12,7 @@ const queryClient = new QueryClient();
 const pieceValues = {
   id: 'pieceId',
   holdingId: 'holdingId',
-  caption: 'v1',
+  displaySummary: 'v1',
 };
 
 // eslint-disable-next-line react/prop-types

diff --git a/src/common/utils/receive.js b/src/common/utils/receive.js
@@ -8,7 +8,7 @@ export const unreceivePieces = (pieces, mutatorUnreceive) => {
   const selectedPieces = pieces
     .filter(({ checked }) => checked === true)
     .map(piece => ({
-      caption: piece.caption,
+      displaySummary: piece.displaySummary,
       chronology: piece.chronology,
       comment: piece.comment,
       copyNumber: piece.copyNumber,

diff --git a/translations/ui-receiving/en.json b/translations/ui-receiving/en.json
@@ -181,7 +181,7 @@
   "piece.action.button.delete": "Delete",
   "piece.action.button.expect": "Expect",
   "piece.callNumber": "Call number",
-  "piece.caption": "Caption",
+  "piece.displaySummary": "Display summary",
   "piece.copyNumber": "Copy number",
   "piece.comment": "Comment",
   "piece.enumeration": "Enumeration",