UIOR-1177 Add settings components for custom fields #1536
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
NikitaSedyx
reviewed
Dec 21, 2023
| @@ -1,6 +1,6 @@ | |||
| { | |||
| "name": "@folio/orders", | |||
| "version": "5.1.0", | |||
| "version": "6.0.0", | |||
There was a problem hiding this comment.
why do you think it's a breaking change?
There was a problem hiding this comment.
We're discontinuing support for orders <12.1 and order-lines <3.3. Interface requirements are a part of the public API. This change is backward incompatible, as ui-orders will no longer function in an environment that provides orders <12.1 or order-lines <3.3.
There was a problem hiding this comment.
If you implement any backwards-incompatible change to any API, or drop any API at all, increment the module version to 3.0.0
|
NikitaSedyx
approved these changes
Jan 9, 2024
BogdanDenis
approved these changes
Jan 9, 2024
11 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
This PR is part of the integration of custom fields into the orders app. See UIOR-1177.
Approach
This PR introduces
<CustomFieldsSettings>within<OrderSettings>to manage custom fields for both purchase orders and purchase order lines. This addition includes permissions, translations, and relies on the components<ViewCustomFieldsSettings>and<EditCustomFieldsSettings>fromstripes-smart-components. These components communicate with themod-orders-storagemodule to manage the custom fields.Dependencies
<CustomFieldsSettings>requiresmod-orders-storageto provide thecustom-fields 3.0interface. Unfortunately, directly requiring the okapi interfacecustom-fields 3.0isn't feasible due to its"interfaceType": "multiple"nature. There's currently no way to ensure thatcustom-fields 3.0is specifically provided bymod-orders-storagerather than, for example,mod-users.The custom fields functionality was introduced in
mod-ordersandmod-orders-storageaccompanied by an upgrade to the provided interface versions toorders 12.1andorder-lines 3.3(see PR#806 and PR#374). Requiringorders 12.1andorder-lines 3.3guarantees that bothmod-ordersand consequentlymod-orders-storagesupport the custom fields functionality, securing the intended operation of<CustomFieldsSettings>.Breaking Changes
The requirement for
orders 12.1andorder-lines 3.3constitutes a breaking change. As per semantic versioning guidelines, a major version increment inui-ordersis recommended.Screenshots
screen-capture.webm
Pre-Merge Checklist
Before merging this PR, please go through the following list and take appropriate actions.
If there are breaking changes, please STOP and consider the following:
Ideally all of the PRs involved in breaking changes would be merged in the same day to avoid breaking the folio-testing environment. Communication is paramount if that is to be achieved, especially as the number of intermodule and inter-team dependencies increase.
While it's helpful for reviewers to help identify potential problems, ensuring that it's safe to merge is ultimately the responsibility of the PR assignee.