This commit is contained in:
2025-08-25 20:24:23 +08:00
parent 30106e0129
commit 0ae8d7a709
1044 changed files with 321581 additions and 0 deletions

View File

@@ -0,0 +1,376 @@
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
## [3.5.2](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.5.1...decap-cms-widget-relation@3.5.2) (2025-07-22)
**Note:** Version bump only for package decap-cms-widget-relation
## [3.5.1](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.5.0...decap-cms-widget-relation@3.5.1) (2025-07-22)
**Note:** Version bump only for package decap-cms-widget-relation
# [3.5.0](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.3.2...decap-cms-widget-relation@3.5.0) (2025-07-15)
**Note:** Version bump only for package decap-cms-widget-relation
# [3.4.0](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.3.2...decap-cms-widget-relation@3.4.0) (2025-06-26)
**Note:** Version bump only for package decap-cms-widget-relation
## [3.3.2](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.3.1...decap-cms-widget-relation@3.3.2) (2024-08-13)
### Reverts
- Revert "Update dependencies (#7264)" ([22d483a](https://github.com/decaporg/decap-cms/commit/22d483a5b0c654071ae05735ac4f49abdc13d38c)), closes [#7264](https://github.com/decaporg/decap-cms/issues/7264)
## [3.3.1](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.3.0...decap-cms-widget-relation@3.3.1) (2024-08-13)
**Note:** Version bump only for package decap-cms-widget-relation
# [3.3.0](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.2.1...decap-cms-widget-relation@3.3.0) (2024-04-16)
### Features
- nested fields and integer values for filter relation widget ([#7177](https://github.com/decaporg/decap-cms/issues/7177)) ([0e6f93b](https://github.com/decaporg/decap-cms/commit/0e6f93b1527931ddd7167bfd0ee3c3a7654e98b3))
## [3.2.1](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.2.0...decap-cms-widget-relation@3.2.1) (2024-04-02)
### Bug Fixes
- handle single values in multiselect relation widget ([#7164](https://github.com/decaporg/decap-cms/issues/7164)) ([248f36f](https://github.com/decaporg/decap-cms/commit/248f36fdc8326803b8b6d7174ac21650a5c05b7c))
# [3.2.0](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.1.1...decap-cms-widget-relation@3.2.0) (2024-03-28)
### Features
- filtering for relation widget ([#2405](https://github.com/decaporg/decap-cms/issues/2405)) ([#7161](https://github.com/decaporg/decap-cms/issues/7161)) ([85c92f0](https://github.com/decaporg/decap-cms/commit/85c92f0b1a40a7d0e34efb5e9bc4955e53725aeb))
## [3.1.1](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.1.0-beta.1...decap-cms-widget-relation@3.1.1) (2024-03-21)
**Note:** Version bump only for package decap-cms-widget-relation
# [3.1.0](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.1.0-beta.1...decap-cms-widget-relation@3.1.0) (2024-02-01)
**Note:** Version bump only for package decap-cms-widget-relation
# [3.1.0-beta.1](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.1.0-beta.0...decap-cms-widget-relation@3.1.0-beta.1) (2024-01-31)
**Note:** Version bump only for package decap-cms-widget-relation
# [3.1.0-beta.0](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.1.0...decap-cms-widget-relation@3.1.0-beta.0) (2023-10-20)
### Reverts
- Revert "chore(release): publish" ([b89fc89](https://github.com/decaporg/decap-cms/commit/b89fc894dfbb5f4136b2e5427fd25a29378a58c6))
## [3.0.3](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.0.2...decap-cms-widget-relation@3.0.3) (2023-10-13)
**Note:** Version bump only for package decap-cms-widget-relation
## [3.0.2](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.0.1...decap-cms-widget-relation@3.0.2) (2023-09-06)
**Note:** Version bump only for package decap-cms-widget-relation
## [3.0.1](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@3.0.0...decap-cms-widget-relation@3.0.1) (2023-08-25)
### Bug Fixes
- update peer dependencies ([#6886](https://github.com/decaporg/decap-cms/issues/6886)) ([e580ce5](https://github.com/decaporg/decap-cms/commit/e580ce52ce5f80fa040e8fbcab7fed0744f4f695))
# [3.0.0](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@2.12.0...decap-cms-widget-relation@3.0.0) (2023-08-18)
**Note:** Version bump only for package decap-cms-widget-relation
# [2.12.0](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@2.12.0-beta.0...decap-cms-widget-relation@2.12.0) (2023-08-18)
**Note:** Version bump only for package decap-cms-widget-relation
# 2.12.0-beta.0 (2023-08-18)
### Features
- rename packages ([#6863](https://github.com/decaporg/decap-cms/issues/6863)) ([d515e7b](https://github.com/decaporg/decap-cms/commit/d515e7bd33216a775d96887b08c4f7b1962941bb))
## [2.11.2-beta.0](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@2.11.1...decap-cms-widget-relation@2.11.2-beta.0) (2023-07-27)
**Note:** Version bump only for package decap-cms-widget-relation
## [2.11.1](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@2.11.0...decap-cms-widget-relation@2.11.1) (2022-04-13)
### Bug Fixes
- **relation-widget:** i18n options ([#6299](https://github.com/decaporg/decap-cms/issues/6299)) ([4bf6464](https://github.com/decaporg/decap-cms/commit/4bf64642e4c0be4adce81af1d407bdbd5770a727))
# [2.11.0](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@2.10.4...decap-cms-widget-relation@2.11.0) (2021-10-21)
### Features
- **relation-widget:** enable reordering for relation controls ([#5873](https://github.com/decaporg/decap-cms/issues/5873)) ([a77a355](https://github.com/decaporg/decap-cms/commit/a77a355bac376758a6c9f9948e258bd32ccd4302))
## [2.10.4](https://github.com/decaporg/decap-cms/compare/decap-cms-widget-relation@2.10.3...decap-cms-widget-relation@2.10.4) (2021-09-13)
### Bug Fixes
- **widget-relation:** don't invoke onChange if component is not mounted ([#5804](https://github.com/decaporg/decap-cms/issues/5804)) ([bd35474](https://github.com/decaporg/decap-cms/commit/bd35474b928642af3fa3be434928709fd6e9e844))
## [2.10.3](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.10.2...decap-cms-widget-relation@2.10.3) (2021-05-23)
### Bug Fixes
- **deps:** update dependency react-select to v4 ([#5417](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/5417)) ([03362ef](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/03362ef5ab87c6fe5c964da5c5a18099b73a3fc6))
## [2.10.2](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.10.1...decap-cms-widget-relation@2.10.2) (2021-05-19)
**Note:** Version bump only for package decap-cms-widget-relation
## [2.10.1](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.10.0...decap-cms-widget-relation@2.10.1) (2021-05-19)
### Bug Fixes
- **deps:** update react-select to v3 ([#5394](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/5394)) ([03be13c](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/03be13c1e87b318fd10ae6f6ab54cd2634fb9662))
# [2.10.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.9.0...decap-cms-widget-relation@2.10.0) (2021-05-04)
### Features
- added react 17 as peer dependency in packages ([#5316](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/5316)) ([9e42380](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/9e423805707321396eec137f5b732a5b07a0dd3f))
# [2.9.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.8.10...decap-cms-widget-relation@2.9.0) (2021-04-13)
### Features
- add min and max fields to relation widget (resolves [#5026](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/5026)) ([#5238](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/5238)) ([fe117e4](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/fe117e472e18079e4f65ca2dfa5c258040cf93f9))
## [2.8.10](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.8.9...decap-cms-widget-relation@2.8.10) (2021-04-07)
**Note:** Version bump only for package decap-cms-widget-relation
## [2.8.9](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.8.8...decap-cms-widget-relation@2.8.9) (2021-02-23)
**Note:** Version bump only for package decap-cms-widget-relation
## [2.8.8](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.8.7...decap-cms-widget-relation@2.8.8) (2021-02-10)
**Note:** Version bump only for package decap-cms-widget-relation
## [2.8.7](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.8.6...decap-cms-widget-relation@2.8.7) (2020-09-20)
### Bug Fixes
- **widget-relation:** set initial metadata value ([#4326](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/4326)) ([5a4b365](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/5a4b36527e21e87f401b15501418fd739c672d85))
## [2.8.6](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.8.5...decap-cms-widget-relation@2.8.6) (2020-09-15)
**Note:** Version bump only for package decap-cms-widget-relation
## 2.8.5 (2020-09-08)
### Reverts
- Revert "chore(release): publish" ([828bb16](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/828bb16415b8c22a34caa19c50c38b24ffe9ceae))
## 2.8.4 (2020-08-20)
### Reverts
- Revert "chore(release): publish" ([8262487](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/82624879ccbcb16610090041db28f00714d924c8))
## 2.8.3 (2020-07-27)
### Reverts
- Revert "chore(release): publish" ([118d50a](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/118d50a7a70295f25073e564b5161aa2b9883056))
## [2.8.2](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.8.1...decap-cms-widget-relation@2.8.2) (2020-07-16)
### Bug Fixes
- **widget-relation:** append initial value search to options ([#4026](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/4026)) ([12c388e](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/12c388eff3795bf1f4475b1d7c3b61f8569c3b31))
## [2.8.1](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.8.0...decap-cms-widget-relation@2.8.1) (2020-07-14)
### Bug Fixes
- relation widget performance ([#3975](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/3975)) ([c7e0fe8](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/c7e0fe8492d09a3d151c608f50da844f421362ed))
# [2.8.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.7.0...decap-cms-widget-relation@2.8.0) (2020-06-18)
### Bug Fixes
- **widget-relation:** keep referenced field type when not using template ([#3850](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/3850)) ([1419ba1](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/1419ba1d09ba1671f964f797479e1da5073a608d))
### Features
- add widgets schema validation ([#3841](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/3841)) ([2b46608](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/2b46608f86d22c8ad34f75e396be7c34462d9e99))
# [2.7.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.6.0...decap-cms-widget-relation@2.7.0) (2020-05-19)
### Bug Fixes
- **widget-relation:** fix displayFields default ([#3783](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/3783)) ([24d96a7](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/24d96a760a26f043468cd3e7af28ad3adc6c283a))
### Features
- **widget-relation:** target file collections ([#3754](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/3754)) ([2f435f8](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/2f435f875bc139af345080eb8cca6146d27c10f6))
# [2.6.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.5.2...decap-cms-widget-relation@2.6.0) (2020-05-04)
### Features
- **widget-relation:** string templates support ([#3659](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/3659)) ([213ae86](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/213ae86b54d02f5fc79fe11113507587ed062ff2))
## [2.5.2](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.5.1...decap-cms-widget-relation@2.5.2) (2020-02-14)
### Bug Fixes
- dispatch QUERY_FAILURE on query failure ([#3243](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/3243)) ([2447f9c](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/2447f9c311db3c5db35ce6501c0380d304709d50))
## [2.5.1](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.5.0...decap-cms-widget-relation@2.5.1) (2020-02-13)
### Bug Fixes
- change getAsset to not return a promise ([#3232](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/3232)) ([ab685e8](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/ab685e85943d1ac48142f157683bc2126fd6af16))
# [2.5.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.4.2...decap-cms-widget-relation@2.5.0) (2019-11-18)
### Bug Fixes
- **bundle-size:** don't import react-select twice ([#2875](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/2875)) ([665afed](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/665afed3c20f1d74ba4b2ef65d0eb5130e558433))
### Features
- commit media with post ([#2851](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/2851)) ([6515dee](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/6515dee8715d8571ea19484a7dfab7cfd0cc40be))
## [2.4.2](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.4.1...decap-cms-widget-relation@2.4.2) (2019-09-26)
**Note:** Version bump only for package decap-cms-widget-relation
## [2.4.1](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.4.0...decap-cms-widget-relation@2.4.1) (2019-07-24)
**Note:** Version bump only for package decap-cms-widget-relation
# [2.4.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.3.3...decap-cms-widget-relation@2.4.0) (2019-06-26)
### Features
- **widget-relation:** support nested field references in relation widget ([#2391](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/2391)) ([d6964b5](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/d6964b5))
## [2.3.3](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.3.3-beta.0...decap-cms-widget-relation@2.3.3) (2019-06-14)
**Note:** Version bump only for package decap-cms-widget-relation
## [2.3.3-beta.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.3.2...decap-cms-widget-relation@2.3.3-beta.0) (2019-05-15)
### Bug Fixes
- **widget-relation:** clear button ([#2285](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/2285)) ([9318aa0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/9318aa0))
## [2.3.2](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.3.2-beta.0...decap-cms-widget-relation@2.3.2) (2019-04-10)
**Note:** Version bump only for package decap-cms-widget-relation
## [2.3.2-beta.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.3.1...decap-cms-widget-relation@2.3.2-beta.0) (2019-04-05)
**Note:** Version bump only for package decap-cms-widget-relation
## [2.3.1](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.3.1-beta.2...decap-cms-widget-relation@2.3.1) (2019-03-29)
**Note:** Version bump only for package decap-cms-widget-relation
## [2.3.1-beta.2](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.3.1-beta.1...decap-cms-widget-relation@2.3.1-beta.2) (2019-03-28)
**Note:** Version bump only for package decap-cms-widget-relation
## [2.3.1-beta.1](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.3.1-beta.0...decap-cms-widget-relation@2.3.1-beta.1) (2019-03-26)
### Bug Fixes
- export on decap-cms and maps on esm ([#2244](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/2244)) ([6ffd13b](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/6ffd13b))
## [2.3.1-beta.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.3.0...decap-cms-widget-relation@2.3.1-beta.0) (2019-03-25)
### Bug Fixes
- update peer dep versions ([#2234](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/2234)) ([7987091](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/7987091))
# [2.3.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.2.0...decap-cms-widget-relation@2.3.0) (2019-03-22)
### Features
- add ES module builds ([#2215](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/2215)) ([d142b32](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/d142b32))
# [2.2.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.2.0-beta.0...decap-cms-widget-relation@2.2.0) (2019-03-22)
**Note:** Version bump only for package decap-cms-widget-relation
# [2.2.0-beta.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.1.3-beta.0...decap-cms-widget-relation@2.2.0-beta.0) (2019-03-21)
### Features
- provide usable UMD builds for all packages ([#2141](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/2141)) ([82cc794](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/82cc794))
## [2.1.3-beta.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.1.2...decap-cms-widget-relation@2.1.3-beta.0) (2019-03-15)
### Features
- upgrade to Emotion 10 ([#2166](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/2166)) ([ccef446](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/ccef446))
## [2.1.2](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.1.1...decap-cms-widget-relation@2.1.2) (2019-03-11)
### Bug Fixes
- **relation-widget:** accept string in searchFields config ([#2137](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/2137)) ([9fed79b](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/9fed79b))
## [2.1.1](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.1.0...decap-cms-widget-relation@2.1.1) (2019-03-08)
**Note:** Version bump only for package decap-cms-widget-relation
# [2.1.0](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.0.6...decap-cms-widget-relation@2.1.0) (2019-02-26)
### Features
- **decap-cms-widget-relation:** use react-select and add support for multiple entries ([#1936](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/1936)) ([518f6fb](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/518f6fb))
## [2.0.6](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.0.5...decap-cms-widget-relation@2.0.6) (2019-02-08)
### Bug Fixes
- **decap-cms-core:** fix fields metadata for objects and lists ([#2011](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/2011)) ([2d1d1c1](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/2d1d1c1))
<a name="2.0.5"></a>
## [2.0.5](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.0.4...decap-cms-widget-relation@2.0.5) (2018-08-24)
**Note:** Version bump only for package decap-cms-widget-relation
<a name="2.0.4"></a>
## [2.0.4](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.0.3...decap-cms-widget-relation@2.0.4) (2018-08-07)
### Bug Fixes
- **relation:** fix relation widget selection bug ([#1572](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/issues/1572)) ([77fbc04](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/commit/77fbc04))
<a name="2.0.3"></a>
## [2.0.3](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.0.2...decap-cms-widget-relation@2.0.3) (2018-08-01)
**Note:** Version bump only for package decap-cms-widget-relation
<a name="2.0.2"></a>
## [2.0.2](https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation/compare/decap-cms-widget-relation@2.0.1...decap-cms-widget-relation@2.0.2) (2018-07-28)
**Note:** Version bump only for package decap-cms-widget-relation
<a name="2.0.1"></a>
## 2.0.1 (2018-07-26)
<a name="2.0.0"></a>
# 2.0.0 (2018-07-26)
**Note:** Version bump only for package decap-cms-widget-relation

View File

@@ -0,0 +1,9 @@
# Docs coming soon!
Decap CMS was converted from a single npm package to a "monorepo" of over 20 packages.
We haven't created a README for this package yet, but you can:
1. Check out the [main readme](https://github.com/decaporg/decap-cms/#readme) or the [documentation
site](https://www.decapcms.org) for more info.
2. Reach out to the [community chat](https://decapcms.org/chat/) if you need help.
3. Help out and [write the readme yourself](https://github.com/decaporg/decap-cms/edit/main/packages/decap-cms-widget-relation/README.md)!

View File

@@ -0,0 +1,41 @@
{
"name": "decap-cms-widget-relation",
"description": "Widget for linking related entries in Decap CMS.",
"version": "3.5.2",
"homepage": "https://www.decapcms.org/docs/widgets/#relation",
"repository": "https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-widget-relation",
"bugs": "https://github.com/decaporg/decap-cms/issues",
"module": "dist/esm/index.js",
"main": "dist/decap-cms-widget-relation.js",
"license": "MIT",
"keywords": [
"decap-cms",
"widget",
"relation",
"link"
],
"sideEffects": false,
"scripts": {
"develop": "npm run build:esm -- --watch",
"build": "cross-env NODE_ENV=production webpack",
"build:esm": "cross-env NODE_ENV=esm babel src --out-dir dist/esm --ignore \"**/__tests__\" --root-mode upward"
},
"dependencies": {
"@dnd-kit/core": "^6.0.8",
"@dnd-kit/modifiers": "^6.0.1",
"@dnd-kit/sortable": "^7.0.2",
"react-select": "^5.10.0",
"react-window": "^1.8.5"
},
"peerDependencies": {
"@emotion/react": "^11.11.1",
"@emotion/styled": "^11.11.0",
"decap-cms-lib-widgets": "^3.0.0",
"decap-cms-ui-default": "^3.0.0",
"immutable": "^3.7.6",
"lodash": "^4.17.11",
"prop-types": "^15.7.2",
"react": "^19.1.0",
"uuid": "^8.3.2"
}
}

View File

@@ -0,0 +1,55 @@
class RelationCache {
constructor() {
this.cache = new Map();
this.pendingRequests = new Map();
}
async getOptions(collection, searchFields, term, file, queryFn) {
const cacheKey = `${collection}-${searchFields.join(',')}-${term || ''}-${file || ''}`;
if (this.cache.has(cacheKey)) {
return this.cache.get(cacheKey);
}
if (this.pendingRequests.has(cacheKey)) {
return this.pendingRequests.get(cacheKey);
}
const request = queryFn();
this.pendingRequests.set(cacheKey, request);
try {
const result = await request;
this.cache.set(cacheKey, result);
this.ensureCacheSize();
return result;
} finally {
this.pendingRequests.delete(cacheKey);
}
}
invalidateCollection(collection) {
for (const [key] of this.cache.entries()) {
if (key.startsWith(`${collection}-`)) {
this.cache.delete(key);
}
}
}
ensureCacheSize() {
const maxSize = 100;
if (this.cache.size > maxSize) {
const firstKey = this.cache.keys().next().value;
this.cache.delete(firstKey);
}
}
clear() {
this.cache.clear();
this.pendingRequests.clear();
}
}
const relationCache = new RelationCache();
export default relationCache;

View File

@@ -0,0 +1,505 @@
import React from 'react';
import PropTypes from 'prop-types';
import ImmutablePropTypes from 'react-immutable-proptypes';
import { components } from 'react-select';
import AsyncSelect from 'react-select/async';
import debounce from 'lodash/debounce';
import find from 'lodash/find';
import get from 'lodash/get';
import isEmpty from 'lodash/isEmpty';
import last from 'lodash/last';
import uniqBy from 'lodash/uniqBy';
import { fromJS, List, Map } from 'immutable';
import { reactSelectStyles } from 'decap-cms-ui-default';
import { stringTemplate, validations } from 'decap-cms-lib-widgets';
import { FixedSizeList } from 'react-window';
import {
DndContext,
MouseSensor,
TouchSensor,
closestCenter,
useSensor,
useSensors,
} from '@dnd-kit/core';
import { SortableContext, horizontalListSortingStrategy, useSortable } from '@dnd-kit/sortable';
import { restrictToParentElement } from '@dnd-kit/modifiers';
import { CSS } from '@dnd-kit/utilities';
import { v4 as uuid } from 'uuid';
import relationCache from './RelationCache';
function arrayMove(array, from, to) {
const slicedArray = array.slice();
slicedArray.splice(to < 0 ? array.length + to : to, 0, slicedArray.splice(from, 1)[0]);
return slicedArray;
}
function MultiValue(props) {
const { setNodeRef, transform, transition } = useSortable({
id: props.data.data.id,
});
function onMouseDown(e) {
e.preventDefault();
e.stopPropagation();
}
const style = {
transform: CSS.Transform.toString(transform),
transition,
};
const innerProps = { ...props.innerProps, onMouseDown };
return (
<div ref={setNodeRef} style={style}>
<components.MultiValue {...props} innerProps={innerProps} />
</div>
);
}
function MultiValueLabel(props) {
const { attributes, listeners } = useSortable({
id: props.data.data.id,
});
return (
<div {...attributes} {...listeners}>
<components.MultiValueLabel {...props} />
</div>
);
}
function SortableSelect(props) {
const { distance, value, onSortEnd, isMulti } = props;
if (!isMulti) {
return <AsyncSelect {...props} />;
}
const keys = Array.isArray(value) ? value.map(({ data }) => data.id) : [];
const activationConstraint = { distance };
const sensors = useSensors(
useSensor(MouseSensor, { activationConstraint }),
useSensor(TouchSensor, { activationConstraint }),
);
function handleSortEnd({ active, over }) {
onSortEnd({
oldIndex: keys.indexOf(active.id),
newIndex: keys.indexOf(over.id),
});
}
return (
<DndContext
modifiers={[restrictToParentElement]}
collisionDetection={closestCenter}
sensors={sensors}
onDragEnd={handleSortEnd}
>
<SortableContext items={keys} strategy={horizontalListSortingStrategy}>
<AsyncSelect {...props} />
</SortableContext>
</DndContext>
);
}
function Option({ index, style, data }) {
return <div style={style}>{data.options[index]}</div>;
}
function MenuList(props) {
if (props.isLoading || props.options.length <= 0 || !Array.isArray(props.children)) {
return props.children;
}
const rows = props.children;
const itemSize = 30;
return (
<FixedSizeList
style={{ width: '100%' }}
width={300}
height={Math.min(300, rows.length * itemSize + itemSize / 3)}
itemCount={rows.length}
itemSize={itemSize}
itemData={{ options: rows }}
>
{Option}
</FixedSizeList>
);
}
function optionToString(option) {
return option && option.value ? option.value : '';
}
function convertToOption(raw) {
if (typeof raw === 'string') {
return { label: raw, value: raw };
}
return Map.isMap(raw) ? raw.toJS() : raw;
}
function getSelectedOptions(value) {
const selectedOptions = List.isList(value) ? value.toJS() : value;
if (!selectedOptions || !Array.isArray(selectedOptions)) {
return null;
}
return selectedOptions;
}
function uniqOptions(initial, current) {
return uniqBy(initial.concat(current), o => o.value);
}
function getFieldArray(field) {
if (!field) {
return [];
}
return List.isList(field) ? field.toJS() : [field];
}
function getSelectedValue({ value, options, isMultiple }) {
if (isMultiple) {
const selectedOptions = getSelectedOptions(value);
if (selectedOptions === null) {
return null;
}
const selected = selectedOptions
.map(i => options.find(o => o.value === (i.value || i)))
.filter(Boolean)
.map(convertToSortableOption);
return selected;
} else {
return find(options, ['value', value]) || null;
}
}
function convertToSortableOption(raw) {
const option = convertToOption(raw);
return {
...option,
data: {
...option.data,
id: uuid(),
},
};
}
export default class RelationControl extends React.Component {
mounted = false;
state = {
initialOptions: [],
};
static propTypes = {
onChange: PropTypes.func.isRequired,
forID: PropTypes.string.isRequired,
value: PropTypes.node,
field: ImmutablePropTypes.map,
query: PropTypes.func.isRequired,
queryHits: PropTypes.array,
classNameWrapper: PropTypes.string.isRequired,
setActiveStyle: PropTypes.func.isRequired,
setInactiveStyle: PropTypes.func.isRequired,
locale: PropTypes.string,
};
isValid = () => {
const { field, value, t } = this.props;
const min = field.get('min');
const max = field.get('max');
if (!this.isMultiple()) {
return { error: false };
}
const error = validations.validateMinMax(
t,
field.get('label', field.get('name')),
value,
min,
max,
);
return error ? { error } : { error: false };
};
shouldComponentUpdate(nextProps) {
return (
this.props.value !== nextProps.value ||
this.props.hasActiveStyle !== nextProps.hasActiveStyle ||
this.props.queryHits !== nextProps.queryHits
);
}
async componentDidMount() {
// Manually validate PropTypes - React 19 breaking change
PropTypes.checkPropTypes(RelationControl.propTypes, this.props, 'prop', 'RelationControl');
this.mounted = true;
const { value } = this.props;
if (value && this.hasInitialValues(value)) {
await this.loadInitialOptions();
}
}
hasInitialValues(value) {
if (this.isMultiple()) {
const selectedOptions = getSelectedOptions(value);
return selectedOptions && selectedOptions.length > 0;
}
return value && value !== '';
}
async loadInitialOptions() {
const { field, query, forID, value } = this.props;
const collection = field.get('collection');
const searchFieldsArray = getFieldArray(field.get('search_fields'));
const file = field.get('file');
try {
const result = await relationCache.getOptions(
collection,
searchFieldsArray,
'', // empty term for initial load
file,
() => query(forID, collection, searchFieldsArray, '', file),
);
const hits = result.payload.hits || [];
const options = this.parseHitOptions(hits);
if (this.mounted) {
this.setState({ initialOptions: options });
// Call onChange with metadata for initial values
if (value && this.hasInitialValues(value)) {
this.triggerInitialOnChange(value, options);
}
}
} catch (error) {
console.error('Failed to load initial options:', error);
}
}
triggerInitialOnChange(value, options) {
const { onChange, field } = this.props;
if (this.isMultiple()) {
const selectedOptions = getSelectedOptions(value);
if (selectedOptions && selectedOptions.length > 0) {
const matchedOptions = selectedOptions
.map(val => options.find(opt => opt.value === (val.value || val)))
.filter(Boolean);
if (matchedOptions.length > 0) {
const metadata = {
[field.get('name')]: {
[field.get('collection')]: matchedOptions.reduce(
(acc, option) => ({
...acc,
[option.value]: option.data,
}),
{},
),
},
};
onChange(value, metadata);
}
}
} else {
const matchedOption = options.find(opt => opt.value === value);
if (matchedOption) {
const metadata = {
[field.get('name')]: {
[field.get('collection')]: {
[matchedOption.value]: matchedOption.data,
},
},
};
onChange(value, metadata);
}
}
}
componentWillUnmount() {
this.mounted = false;
}
onSortEnd =
options =>
({ oldIndex, newIndex }) => {
const { onChange, field } = this.props;
const value = options.map(optionToString);
const newValue = arrayMove(value, oldIndex, newIndex);
const metadata =
(!isEmpty(options) && {
[field.get('name')]: {
[field.get('collection')]: {
[last(newValue)]: last(options).data,
},
},
}) ||
{};
onChange(fromJS(newValue), metadata);
};
handleChange = selectedOption => {
const { onChange, field } = this.props;
if (this.isMultiple()) {
const options = selectedOption;
this.setState({ initialOptions: options.filter(Boolean) });
const value = options.map(optionToString);
const metadata =
(!isEmpty(options) && {
[field.get('name')]: {
[field.get('collection')]: {
[last(value)]: last(options).data,
},
},
}) ||
{};
onChange(fromJS(value), metadata);
} else {
this.setState({ initialOptions: [selectedOption].filter(Boolean) });
const value = optionToString(selectedOption);
const metadata = selectedOption && {
[field.get('name')]: {
[field.get('collection')]: { [value]: selectedOption.data },
},
};
onChange(value, metadata);
}
};
parseNestedFields = (hit, field) => {
const { locale } = this.props;
const hitData =
locale != null && hit.i18n != null && hit.i18n[locale] != null
? hit.i18n[locale].data
: hit.data;
const templateVars = stringTemplate.extractTemplateVars(field);
// return non template fields as is
if (templateVars.length <= 0) {
return get(hitData, field);
}
const data = stringTemplate.addFileTemplateFields(hit.path, fromJS(hitData));
const value = stringTemplate.compileStringTemplate(field, null, hit.slug, data);
return value;
};
isMultiple() {
return this.props.field.get('multiple', false);
}
parseHitOptions = hits => {
const { field } = this.props;
const valueField = field.get('value_field');
const displayField = field.get('display_fields') || List([field.get('value_field')]);
const filters = getFieldArray(field.get('filters'));
const options = hits.reduce((acc, hit) => {
if (
filters.every(filter => {
// check if the value for the (nested) filter field is in the filter values
const fieldKeys = filter.field.split('.');
let value = hit.data;
for (let i = 0; i < fieldKeys.length; i++) {
if (Object.prototype.hasOwnProperty.call(value, fieldKeys[i])) {
value = value[fieldKeys[i]];
} else {
return false;
}
}
return filter.values.includes(value);
})
) {
const valuesPaths = stringTemplate.expandPath({ data: hit.data, path: valueField });
for (let i = 0; i < valuesPaths.length; i++) {
const label = displayField
.toJS()
.map(key => {
const displayPaths = stringTemplate.expandPath({ data: hit.data, path: key });
return this.parseNestedFields(hit, displayPaths[i] || displayPaths[0]);
})
.join(' ');
const value = this.parseNestedFields(hit, valuesPaths[i]);
acc.push({ data: hit.data, value, label });
}
}
return acc;
}, []);
return options;
};
loadOptions = debounce((term, callback) => {
const { field, query, forID } = this.props;
const collection = field.get('collection');
const searchFieldsArray = getFieldArray(field.get('search_fields'));
const file = field.get('file');
relationCache
.getOptions(collection, searchFieldsArray, term, file, () =>
query(forID, collection, searchFieldsArray, term, file),
)
.then(result => {
const hits = result.payload.hits || [];
const options = this.parseHitOptions(hits);
const optionsLength = field.get('options_length') || 20;
const uniq = uniqOptions(this.state.initialOptions, options).slice(0, optionsLength);
callback(uniq);
})
.catch(error => {
console.error('Failed to load options:', error);
callback([]);
});
}, 500);
render() {
const { value, field, forID, classNameWrapper, setActiveStyle, setInactiveStyle, queryHits } =
this.props;
const isMultiple = this.isMultiple();
const isClearable = !field.get('required', true) || isMultiple;
const queryOptions = this.parseHitOptions(queryHits);
const options = uniqOptions(this.state.initialOptions, queryOptions);
const selectedValue = getSelectedValue({
options,
value,
isMultiple,
});
return (
<SortableSelect
useDragHandle
onSortEnd={this.onSortEnd(selectedValue)}
distance={4}
// react-select props:
components={{ MenuList, MultiValue, MultiValueLabel }}
value={selectedValue}
inputId={forID}
cacheOptions
defaultOptions
loadOptions={this.loadOptions}
onChange={this.handleChange}
className={classNameWrapper}
onFocus={setActiveStyle}
onBlur={setInactiveStyle}
styles={reactSelectStyles}
isMulti={isMultiple}
isClearable={isClearable}
placeholder=""
/>
);
}
}

View File

@@ -0,0 +1,13 @@
import React from 'react';
import PropTypes from 'prop-types';
import { WidgetPreviewContainer } from 'decap-cms-ui-default';
function RelationPreview({ value }) {
return <WidgetPreviewContainer>{value}</WidgetPreviewContainer>;
}
RelationPreview.propTypes = {
value: PropTypes.node,
};
export default RelationPreview;

View File

@@ -0,0 +1,739 @@
import React from 'react';
import { fromJS } from 'immutable';
import { render, fireEvent, waitFor, act } from '@testing-library/react';
import { DecapCmsWidgetRelation } from '../';
jest.mock('react-window', () => {
function FixedSizeList(props) {
return props.itemData.options;
}
return {
FixedSizeList,
};
});
jest.mock('../RelationCache', () => {
return {
__esModule: true,
default: {
getOptions: jest.fn((collection, searchFields, term, file, queryFn) => {
return queryFn();
}),
clear: jest.fn(),
invalidateCollection: jest.fn(),
},
};
});
beforeEach(() => {
jest.clearAllMocks();
});
const RelationControl = DecapCmsWidgetRelation.controlComponent;
const fieldConfig = {
name: 'post',
collection: 'posts',
display_fields: ['title', 'slug'],
search_fields: ['title', 'body'],
value_field: 'title',
};
const customizedOptionsLengthConfig = {
name: 'post',
collection: 'posts',
display_fields: ['title', 'slug'],
search_fields: ['title', 'body'],
value_field: 'title',
options_length: 10,
};
const deeplyNestedFieldConfig = {
name: 'post',
collection: 'posts',
display_fields: ['title', 'slug', 'deeply.nested.post.field'],
search_fields: ['deeply.nested.post.field'],
value_field: 'title',
};
const nestedFieldConfig = {
name: 'post',
collection: 'posts',
display_fields: ['title', 'slug', 'nested.field_1'],
search_fields: ['nested.field_1', 'nested.field_2'],
value_field: 'title',
};
const filterBooleanFieldConfig = {
name: 'post',
collection: 'posts',
display_fields: ['title', 'slug'],
search_fields: ['title', 'body'],
value_field: 'title',
filters: [
{
field: 'draft',
values: [false],
},
],
};
const filterStringFieldConfig = {
name: 'post',
collection: 'posts',
display_fields: ['title', 'slug'],
search_fields: ['title', 'body'],
value_field: 'title',
filters: [
{
field: 'title',
values: ['Post # 1', 'Post # 2', 'Post # 7', 'Post # 9', 'Post # 15'],
},
],
};
const filterIntegerFieldConfig = {
name: 'post',
collection: 'posts',
display_fields: ['title', 'slug'],
search_fields: ['title', 'body'],
value_field: 'title',
filters: [
{
field: 'num',
values: [1, 5, 9],
},
],
};
const multipleFiltersFieldConfig = {
name: 'post',
collection: 'posts',
display_fields: ['title', 'slug'],
search_fields: ['title', 'body'],
value_field: 'title',
filters: [
{
field: 'title',
values: ['Post # 1', 'Post # 2', 'Post # 7', 'Post # 9', 'Post # 15'],
},
{
field: 'draft',
values: [true],
},
],
};
const emptyFilterFieldConfig = {
name: 'post',
collection: 'posts',
display_fields: ['title', 'slug'],
search_fields: ['title', 'body'],
value_field: 'title',
filters: [
{
field: 'draft',
values: [],
},
],
};
const nestedFilterFieldConfig = {
name: 'post',
collection: 'posts',
display_fields: ['title', 'slug'],
search_fields: ['title', 'body'],
value_field: 'title',
filters: [
{
field: 'deeply.nested.post.field',
values: ['Deeply nested field'],
},
],
};
function generateHits(length) {
const hits = Array.from({ length }, (val, idx) => {
const title = `Post # ${idx + 1}`;
const slug = `post-number-${idx + 1}`;
const draft = idx % 2 === 0;
const num = idx + 1;
const path = `posts/${slug}.md`;
return { collection: 'posts', data: { title, slug, draft, num }, slug, path };
});
return [
...hits,
{
collection: 'posts',
data: {
title: 'Deeply nested post',
slug: 'post-deeply-nested',
deeply: {
nested: {
post: {
field: 'Deeply nested field',
},
},
},
},
},
{
collection: 'posts',
data: {
title: 'Nested post',
slug: 'post-nested',
nested: {
field_1: 'Nested field 1',
field_2: 'Nested field 2',
},
},
},
{
collection: 'posts',
data: { title: 'YAML post', slug: 'post-yaml', body: 'Body yaml' },
},
{
collection: 'posts',
data: { title: 'JSON post', slug: 'post-json', body: 'Body json' },
},
];
}
const simpleFileCollectionHits = [{ data: { categories: ['category 1', 'category 2'] } }];
const nestedFileCollectionHits = [
{
data: {
nested: {
categories: [
{
name: 'category 1',
id: 'cat1',
},
{
name: 'category 2',
id: 'cat2',
},
],
},
},
},
];
const numberFieldsHits = [
{
collection: 'posts',
data: {
title: 'post # 1',
slug: 'post-1',
index: 1,
},
},
{
collection: 'posts',
data: {
title: 'post # 2',
slug: 'post-2',
index: 2,
},
},
];
class RelationController extends React.Component {
state = {
value: this.props.value,
queryHits: [],
};
mounted = false;
componentDidMount() {
this.mounted = true;
}
componentWillUnmount() {
this.mounted = false;
}
handleOnChange = jest.fn(value => {
act(() => {
this.setState({ ...this.state, value });
});
});
setQueryHits = jest.fn(queryHits => {
if (this.mounted) {
act(() => {
this.setState({ ...this.state, queryHits });
});
}
});
query = jest.fn((...args) => {
const queryHits = generateHits(25);
const [, collection, , term, file, optionsLength] = args;
let hits = queryHits;
if (collection === 'numbers_collection') {
hits = numberFieldsHits;
} else if (file === 'nested_file') {
hits = nestedFileCollectionHits;
} else if (file === 'simple_file') {
hits = simpleFileCollectionHits;
} else if (term === 'JSON post') {
hits = [queryHits[queryHits.length - 1]];
} else if (term === 'YAML' || term === 'YAML post') {
hits = [queryHits[queryHits.length - 2]];
} else if (term === 'Nested') {
hits = [queryHits[queryHits.length - 3]];
} else if (term === 'Deeply nested') {
hits = [queryHits[queryHits.length - 4]];
}
hits = hits.slice(0, optionsLength);
this.setQueryHits(hits);
return Promise.resolve({ payload: { hits } });
});
render() {
return this.props.children({
value: this.state.value,
handleOnChange: this.handleOnChange,
query: this.query,
queryHits: this.state.queryHits,
setQueryHits: this.setQueryHits,
});
}
}
function setup({ field, value }) {
let renderArgs;
const setActiveSpy = jest.fn();
const setInactiveSpy = jest.fn();
const helpers = render(
<RelationController value={value}>
{({ handleOnChange, value, query, queryHits, setQueryHits }) => {
renderArgs = { value, onChangeSpy: handleOnChange, setQueryHitsSpy: setQueryHits };
return (
<RelationControl
field={field}
value={value}
query={query}
queryHits={queryHits}
onChange={handleOnChange}
forID="relation-field"
classNameWrapper=""
setActiveStyle={setActiveSpy}
setInactiveStyle={setInactiveSpy}
/>
);
}}
</RelationController>,
);
const input = helpers.container.querySelector('input');
return {
...helpers,
...renderArgs,
setActiveSpy,
setInactiveSpy,
input,
};
}
describe('Relation widget', () => {
it('should list the first 20 option hits on initial load', async () => {
const field = fromJS(fieldConfig);
const { getAllByText, input } = setup({ field });
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
expect(getAllByText(/^Post # (\d{1,2}) post-number-\1$/)).toHaveLength(20);
});
});
it('should list the first 10 option hits on initial load', async () => {
const field = fromJS(customizedOptionsLengthConfig);
const { getAllByText, input } = setup({ field });
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
expect(getAllByText(/^Post # (\d{1,2}) post-number-\1$/)).toHaveLength(10);
});
});
it('should update option list based on search term', async () => {
const field = fromJS(fieldConfig);
const { getAllByText, input } = setup({ field });
fireEvent.change(input, { target: { value: 'YAML' } });
await waitFor(() => {
expect(getAllByText('YAML post post-yaml')).toHaveLength(1);
});
});
it('should call onChange with correct selectedItem value and metadata', async () => {
const field = fromJS(fieldConfig);
const { getByText, input, onChangeSpy } = setup({ field });
const value = 'Post # 1';
const label = 'Post # 1 post-number-1';
const metadata = {
post: {
posts: { 'Post # 1': { title: 'Post # 1', draft: true, num: 1, slug: 'post-number-1' } },
},
};
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
fireEvent.click(getByText(label));
expect(onChangeSpy).toHaveBeenCalledTimes(1);
expect(onChangeSpy).toHaveBeenCalledWith(value, metadata);
});
});
it('should update metadata for initial preview 1', async () => {
const field = fromJS(fieldConfig);
const value = 'Post # 1';
const { getByText, onChangeSpy } = setup({ field, value });
const label = 'Post # 1 post-number-1';
const metadata = {
post: {
posts: { 'Post # 1': { title: 'Post # 1', draft: true, num: 1, slug: 'post-number-1' } },
},
};
// The component will automatically trigger a query for initial load
// Wait for it to process and call onChange
await waitFor(
() => {
expect(getByText(label)).toBeInTheDocument();
},
{ timeout: 3000 },
);
await waitFor(
() => {
expect(onChangeSpy).toHaveBeenCalledTimes(1);
expect(onChangeSpy).toHaveBeenCalledWith(value, metadata);
},
{ timeout: 3000 },
);
});
it('should update option list based on nested search term', async () => {
const field = fromJS(nestedFieldConfig);
const { getAllByText, input } = setup({ field });
fireEvent.change(input, { target: { value: 'Nested' } });
await waitFor(() => {
expect(getAllByText('Nested post post-nested Nested field 1')).toHaveLength(1);
});
});
it('should update option list based on deeply nested search term', async () => {
const field = fromJS(deeplyNestedFieldConfig);
const { getAllByText, input } = setup({ field });
fireEvent.change(input, { target: { value: 'Deeply nested' } });
await waitFor(() => {
expect(
getAllByText('Deeply nested post post-deeply-nested Deeply nested field'),
).toHaveLength(1);
});
});
it('should handle string templates', async () => {
const stringTemplateConfig = {
name: 'post',
collection: 'posts',
display_fields: ['{{slug}}', '{{filename}}', '{{extension}}'],
search_fields: ['slug'],
value_field: '{{slug}}',
};
const field = fromJS(stringTemplateConfig);
const { getByText, input, onChangeSpy } = setup({ field });
const value = 'post-number-1';
const label = 'post-number-1 post-number-1 md';
const metadata = {
post: {
posts: {
'post-number-1': { title: 'Post # 1', draft: true, num: 1, slug: 'post-number-1' },
},
},
};
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
fireEvent.click(getByText(label));
expect(onChangeSpy).toHaveBeenCalledTimes(1);
expect(onChangeSpy).toHaveBeenCalledWith(value, metadata);
});
});
it('should default display_fields to value_field', async () => {
const field = fromJS(fieldConfig).delete('display_fields');
const { getAllByText, input } = setup({ field });
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
expect(getAllByText(/^Post # (\d{1,2})$/)).toHaveLength(20);
});
});
it('should keep number type of referenced field', async () => {
const fieldConfig = {
name: 'numbers',
collection: 'numbers_collection',
value_field: 'index',
search_fields: ['index'],
display_fields: ['title'],
};
const field = fromJS(fieldConfig);
const { getByText, getAllByText, input, onChangeSpy } = setup({ field });
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
expect(getAllByText(/^post # \d$/)).toHaveLength(2);
});
fireEvent.keyDown(input, { key: 'ArrowDown' });
fireEvent.click(getByText('post # 1'));
fireEvent.keyDown(input, { key: 'ArrowDown' });
fireEvent.click(getByText('post # 2'));
expect(onChangeSpy).toHaveBeenCalledTimes(2);
expect(onChangeSpy).toHaveBeenCalledWith(1, {
numbers: { numbers_collection: { 1: { index: 1, slug: 'post-1', title: 'post # 1' } } },
});
expect(onChangeSpy).toHaveBeenCalledWith(2, {
numbers: { numbers_collection: { 2: { index: 2, slug: 'post-2', title: 'post # 2' } } },
});
});
describe('with multiple', () => {
it('should call onChange with correct selectedItem value and metadata', async () => {
const field = fromJS({ ...fieldConfig, multiple: true });
const { getByText, input, onChangeSpy } = setup({ field });
const metadata1 = {
post: {
posts: { 'Post # 1': { title: 'Post # 1', draft: true, num: 1, slug: 'post-number-1' } },
},
};
const metadata2 = {
post: {
posts: { 'Post # 2': { title: 'Post # 2', draft: false, num: 2, slug: 'post-number-2' } },
},
};
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
fireEvent.click(getByText('Post # 1 post-number-1'));
});
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
fireEvent.click(getByText('Post # 2 post-number-2'));
});
expect(onChangeSpy).toHaveBeenCalledTimes(2);
expect(onChangeSpy).toHaveBeenCalledWith(fromJS(['Post # 1']), metadata1);
expect(onChangeSpy).toHaveBeenCalledWith(fromJS(['Post # 1', 'Post # 2']), metadata2);
});
it('should update metadata for initial preview 2', async () => {
const field = fromJS({ ...fieldConfig, multiple: true });
const value = fromJS(['YAML post', 'JSON post']);
const { getByText, onChangeSpy } = setup({ field, value });
const metadata = {
post: {
posts: {
'YAML post': { title: 'YAML post', slug: 'post-yaml', body: 'Body yaml' },
'JSON post': { title: 'JSON post', slug: 'post-json', body: 'Body json' },
},
},
};
// Wait for both labels to appear
await waitFor(
() => {
expect(getByText('YAML post post-yaml')).toBeInTheDocument();
expect(getByText('JSON post post-json')).toBeInTheDocument();
},
{ timeout: 3000 },
);
// Wait for onChange to be called
await waitFor(
() => {
expect(onChangeSpy).toHaveBeenCalledTimes(1);
expect(onChangeSpy).toHaveBeenCalledWith(value, metadata);
},
{ timeout: 3000 },
);
});
});
describe('with file collection', () => {
const fileFieldConfig = {
name: 'categories',
collection: 'file',
file: 'simple_file',
value_field: 'categories.*',
display_fields: ['categories.*'],
};
it('should handle simple list', async () => {
const field = fromJS(fileFieldConfig);
const { getAllByText, input, getByText } = setup({ field });
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
expect(getAllByText(/category/)).toHaveLength(2);
expect(getByText('category 1')).toBeInTheDocument();
expect(getByText('category 2')).toBeInTheDocument();
});
});
it('should handle nested list', async () => {
const field = fromJS({
...fileFieldConfig,
file: 'nested_file',
value_field: 'nested.categories.*.id',
display_fields: ['nested.categories.*.name'],
});
const { getAllByText, input, getByText } = setup({ field });
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
expect(getAllByText(/category/)).toHaveLength(2);
expect(getByText('category 1')).toBeInTheDocument();
expect(getByText('category 2')).toBeInTheDocument();
});
});
});
describe('with filter', () => {
it('should list the 10 option hits on initial load using a filter on boolean value', async () => {
const field = fromJS(filterBooleanFieldConfig);
const { getAllByText, input } = setup({ field });
const expectedOptions = [];
for (let i = 2; i <= 25; i += 2) {
expectedOptions.push(`Post # ${i} post-number-${i}`);
}
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
const displayedOptions = getAllByText(/^Post # (\d{1,2}) post-number-\1$/);
expect(displayedOptions).toHaveLength(expectedOptions.length);
for (let i = 0; i < expectedOptions.length; i++) {
const expectedOption = expectedOptions[i];
const optionFound = displayedOptions.some(
option => option.textContent === expectedOption,
);
expect(optionFound).toBe(true);
}
});
});
it('should list the 5 option hits on initial load using a filter on string value', async () => {
const field = fromJS(filterStringFieldConfig);
const { getAllByText, input } = setup({ field });
const expectedOptions = [
'Post # 1 post-number-1',
'Post # 2 post-number-2',
'Post # 7 post-number-7',
'Post # 9 post-number-9',
'Post # 15 post-number-15',
];
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
const displayedOptions = getAllByText(/^Post # (\d{1,2}) post-number-\1$/);
expect(displayedOptions).toHaveLength(expectedOptions.length);
for (let i = 0; i < expectedOptions.length; i++) {
const expectedOption = expectedOptions[i];
const optionFound = displayedOptions.some(
option => option.textContent === expectedOption,
);
expect(optionFound).toBe(true);
}
});
});
it('should list 3 option hits on initial load using a filter on integer value', async () => {
const field = fromJS(filterIntegerFieldConfig);
const { getAllByText, input } = setup({ field });
const expectedOptions = [
'Post # 1 post-number-1',
'Post # 5 post-number-5',
'Post # 9 post-number-9',
];
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
const displayedOptions = getAllByText(/^Post # (\d{1,2}) post-number-\1$/);
expect(displayedOptions).toHaveLength(expectedOptions.length);
for (let i = 0; i < expectedOptions.length; i++) {
const expectedOption = expectedOptions[i];
const optionFound = displayedOptions.some(
option => option.textContent === expectedOption,
);
expect(optionFound).toBe(true);
}
});
});
it('should list 4 option hits on initial load using multiple filters', async () => {
const field = fromJS(multipleFiltersFieldConfig);
const { getAllByText, input } = setup({ field });
const expectedOptions = [
'Post # 1 post-number-1',
'Post # 7 post-number-7',
'Post # 9 post-number-9',
'Post # 15 post-number-15',
];
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
const displayedOptions = getAllByText(/^Post # (\d{1,2}) post-number-\1$/);
expect(displayedOptions).toHaveLength(expectedOptions.length);
for (let i = 0; i < expectedOptions.length; i++) {
const expectedOption = expectedOptions[i];
const optionFound = displayedOptions.some(
option => option.textContent === expectedOption,
);
expect(optionFound).toBe(true);
}
});
});
it('should list 0 option hits on initial load on empty filter values array', async () => {
const field = fromJS(emptyFilterFieldConfig);
const { getAllByText, input } = setup({ field });
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
expect(() => getAllByText(/^Post # (\d{1,2}) post-number-\1$/)).toThrow(Error);
});
});
it('should list 1 option hit on initial load on nested filter field', async () => {
const field = fromJS(nestedFilterFieldConfig);
const { getAllByText, input } = setup({ field });
fireEvent.keyDown(input, { key: 'ArrowDown' });
await waitFor(() => {
expect(() => getAllByText(/^Post # (\d{1,2}) post-number-\1$/)).toThrow(Error);
expect(getAllByText('Deeply nested post post-deeply-nested')).toHaveLength(1);
});
});
});
});

View File

@@ -0,0 +1,16 @@
import controlComponent from './RelationControl';
import previewComponent from './RelationPreview';
import schema from './schema';
function Widget(opts = {}) {
return {
name: 'relation',
controlComponent,
previewComponent,
schema,
...opts,
};
}
export const DecapCmsWidgetRelation = { Widget, controlComponent, previewComponent };
export default DecapCmsWidgetRelation;

View File

@@ -0,0 +1,32 @@
export default {
properties: {
collection: { type: 'string' },
value_field: { type: 'string' },
search_fields: { type: 'array', minItems: 1, items: { type: 'string' } },
file: { type: 'string' },
multiple: { type: 'boolean' },
min: { type: 'integer' },
max: { type: 'integer' },
display_fields: { type: 'array', minItems: 1, items: { type: 'string' } },
options_length: { type: 'integer' },
filters: {
type: 'array',
items: {
type: 'object',
properties: {
field: { type: 'string' },
values: { type: 'array', minItems: 1, items: { type: ['string', 'boolean', 'integer'] } },
},
required: ['field', 'values'],
},
},
},
oneOf: [
{
required: ['collection', 'value_field', 'search_fields'],
},
{
required: ['collection', 'valueField', 'searchFields'],
},
],
};

View File

@@ -0,0 +1,3 @@
const { getConfig } = require('../../scripts/webpack.js');
module.exports = getConfig();