Compare commits

...

75 Commits

Author SHA1 Message Date
Elliot DeNolf
37fe2df2de chore(release): v1.15.6 2023-09-13 10:30:03 -04:00
Jarrod Flesch
8ca67d5aaa fix(#3289): removes HMR plugin from prod webpack configs (#3319) 2023-09-12 13:09:56 -04:00
Jarrod Flesch
096d33718d fix: fields with relationTo[] correctly load returned data from form submission (#3317) 2023-09-12 11:43:45 -04:00
Jessica Chowdhury
0bd335303d fix: greater than equal admin filter not working (#3306) 2023-09-11 13:08:06 -04:00
James
e8e1ba00fe chore(release): v1.15.5 2023-09-09 09:53:57 -04:00
Jarrod Flesch
a7d47c627d fix: corrects hasMany relationships within addFieldStatePromise (#3300) 2023-09-09 00:32:29 -04:00
Jarrod Flesch
5e1bed3177 chore: fixes console errors for checkboxes (#3291) 2023-09-07 09:11:35 -04:00
Elliot DeNolf
364014a1e9 chore(release): v1.15.4 2023-09-06 17:39:02 -04:00
Jarrod Flesch
9cd5e5aefa fix: appends versions key to incoming where query (#3287) 2023-09-06 15:07:46 -04:00
Bas Dalenoord
429a88a5a1 fix: change scoping of force parameter to prevent false negation; (#3278) 2023-09-06 12:54:39 -04:00
Jarrod Flesch
cf12b5fc70 fix(#3274): sets full user data from fetchFullUser instead of partial jwt data (#3279) 2023-09-06 12:52:48 -04:00
Jarrod Flesch
5096c37874 fix: aligns depth behaviour between local api and admin panel (#3276) 2023-09-06 12:51:59 -04:00
Jacob Fletcher
ac592b6d0d chore(templates/ecommerce): misc cleanup 2023-09-06 11:59:03 -04:00
Jacob Fletcher
007f7e7d18 chore(templates/ecommerce): fixes nextjs hmr 2023-09-06 11:49:59 -04:00
Jacob Fletcher
4ba072b0c6 chore(templates/ecommerce): related products 2023-09-06 11:39:18 -04:00
Jacob Fletcher
8a4db150f0 chore(templates/ecommerce): prevents server from restarting when app files change 2023-09-06 11:11:30 -04:00
Jacob Fletcher
b28b9020ea chore(templates/ecommerce): fixes product published dates 2023-09-06 11:07:59 -04:00
Jacob Fletcher
baa73fae62 chore(templates/ecommerce): wires in redirects 2023-09-06 11:03:30 -04:00
Jacob Fletcher
55c27b6d2f chore(templates/website): builds nextjs front-end (#3282) 2023-09-06 08:38:04 -04:00
James
6d148d7309 chore(release): v1.15.3 2023-09-05 16:53:47 -04:00
James Mikrut
8e10ecae4b Merge pull request #3256 from payloadcms/feat/versions-perf
Feat/versions perf
2023-09-05 16:47:48 -04:00
Jarrod Flesch
ef27b9f641 chore: revert changes related to the status displayed by the Status component 2023-09-05 16:33:01 -04:00
Jarrod Flesch
2dcce0339c chore: simplify logic for global status rendering 2023-09-05 16:04:56 -04:00
Jarrod Flesch
b649ad7bb5 chore: ensure not to update the version doc that was just created 2023-09-05 16:04:12 -04:00
Jarrod Flesch
3cee0be314 chore: remove script file example 2023-09-05 16:01:07 -04:00
Jacob Fletcher
8fc953605a chore(templates/ecommerce): properly formats csp and handles post requests in next app (#3260) 2023-09-01 10:52:05 -04:00
Jarrod Flesch
e28dfc0c93 chore: tweak script 2023-08-31 21:34:25 -04:00
Jarrod Flesch
33561a8ea2 chore: adds feature flag to config 2023-08-31 21:16:50 -04:00
Jarrod Flesch
e500b46576 chore: removes console log 2023-08-31 16:57:49 -04:00
Jarrod Flesch
e79a84d200 chore: migration script 2023-08-31 16:56:21 -04:00
Jarrod Flesch
16e94d401b feat: improves query speed for version enabled collections 2023-08-31 16:50:35 -04:00
Jarrod Flesch
9fbabc8fd6 fix: globals not saving updatedAt and createdAt and version dates correctly 2023-08-31 16:49:33 -04:00
Jarrod Flesch
9bc072ccaf fix: draft globals always displaying unpublish button 2023-08-31 16:48:25 -04:00
Jacob Fletcher
45905c312f chore(templates/ecommerce): bypasses next cache (#3254) 2023-08-31 09:34:10 -04:00
Jacob Fletcher
2c7a15ceca chore(templates/ecommerce): uses svg favicon 2023-08-28 16:11:11 -04:00
Jacob Fletcher
28e128241e chore(examples/custom-server): uses getPayloadClient in default server and removes admin redirect 2023-08-28 16:06:45 -04:00
Jacob Fletcher
21336cd61a chore(examples/custom-server): handles front-end post requests (#3221) 2023-08-28 15:58:56 -04:00
Jarrod Flesch
ff1c10c382 chore(examples): simplify getPayloadClient logic 2023-08-28 13:49:40 -04:00
Jarrod Flesch
6e8aa5e8af Merge branch 'master' of https://github.com/payloadcms/payload 2023-08-28 11:24:28 -04:00
Jarrod Flesch
32e7c56a0d chore(example): adjusts custom server example with pattern to utilize local api 2023-08-28 11:24:24 -04:00
Jacob Fletcher
e5c783df5d chore(templates/ecommerce): migrates to @payloadcms/plugin-stripe v0.0.14 (#3231) 2023-08-25 17:49:51 -04:00
Jacob Fletcher
63698e5e88 chore(templates): correctly sets next images domain (#3230) 2023-08-25 15:40:40 -04:00
Dan Ribbens
016ad3afc9 chore(release): v1.15.2 2023-08-25 11:40:42 -04:00
Dan Ribbens
33e1e15ca9 chore: pins swc v1.3.78 (#3228) 2023-08-25 11:00:43 -04:00
Jarrod Flesch
59918aac91 chore(docs): clarifies reason for returning doc in afterChange collection hook 2023-08-25 10:23:27 -04:00
Dan Ribbens
a0c3cbd68d chore(release): v1.15.1 2023-08-25 06:55:22 -04:00
Tylan Davis
3a15e077c6 fix: correct out of order dark-mode color variables (#3197) 2023-08-24 15:09:31 -04:00
Jessica Chowdhury
90a9e14e9d docs: adds custom select example and video (#3223) 2023-08-24 15:07:06 -04:00
Paul
6d3b8636f4 fix: mutation type with tabs missing previous tabs (#3196) 2023-08-24 14:29:25 -04:00
PatrikKozak
cb8e07f852 fix: arrays in richtext uploads (#3222)
Co-authored-by: Jarrod Flesch <jarrodmflesch@gmail.com>
2023-08-24 14:12:18 -04:00
Jessica Chowdhury
301be0a5d4 docs: adds minRow and maxRow to array and blocks pages (#3203) 2023-08-24 11:19:49 -04:00
Dan Ribbens
466589b483 chore(release): v1.15.0 2023-08-24 10:22:55 -04:00
Alessio Gravili
6754f55ce0 chore: improve filtering for hasMany number field (#3193)
* chore: improve fiiltering for hasMany number field

* chore: add translation for 'items' and replace rows with items

* chore: new exceededLimit key

* Revert "chore: add translation for 'items' and replace rows with items"

This reverts commit 3a91dabdfd.

* chore: undo adding items key in translation schema

* chore: new limitReached key

* chore: remove unnecessary exceededLimit key
2023-08-21 18:01:10 +02:00
Alessio Gravili
84d2bacb56 chore: improve checkboxes (#3191) 2023-08-21 10:39:40 -04:00
Alessio Gravili
739abdcd81 feat: query support for geo within and intersects + dynamic GraphQL operator types (#3183)
Co-authored-by: Lucas Blancas <lablancas@gmail.com>
2023-08-21 10:12:27 -04:00
Jacob Fletcher
c7cf2d3d2c chore(examples): updates draft-preview next-app example to use revalidateTag (#3199) 2023-08-21 08:45:44 -04:00
Jacob Fletcher
79561497f9 Merge pull request #3200 from payloadcms/chore/ecom-deploy
chore(templates): updates e-commerce template
2023-08-21 08:45:31 -04:00
Jacob Fletcher
600306274e chore(templates): renders static cart page fallback 2023-08-20 18:26:53 -04:00
Jacob Fletcher
398378a867 chore(templates): implements draft preview and on-demand revalidation 2023-08-20 13:20:06 -04:00
Jacob Fletcher
4e755dfde2 chore(templates): safely handles bad network requests 2023-08-20 02:09:51 -04:00
Elliot DeNolf
3634e2cc4d chore(templates): default port on website 2023-08-17 15:01:55 -04:00
Jarrod Flesch
294fb5e574 chore: improve ts typing in sanitization functions (#3194) 2023-08-17 10:47:54 -04:00
Dan Ribbens
f5f2332755 chore(release): v1.14.0 2023-08-16 13:58:20 -04:00
Jarrod Flesch
0acd7b8706 chore: file cleanup (#3190) 2023-08-16 13:03:43 -04:00
James Mikrut
d91b44cbb3 feat: improve field ops (#3172)
Co-authored-by: PatrikKozak <patrik@trbl.design>
2023-08-16 11:00:52 -04:00
Greg Willard
e03a8e6b03 feat: Improve admin dashboard accessibility (#3053)
Co-authored-by: Alessio Gravili <alessio@gravili.de>
2023-08-16 10:26:17 -04:00
Jacob Fletcher
846485388a docs: removes auto-formatting from rich-text.mdx (#3188) 2023-08-16 10:15:27 -04:00
Jacob Fletcher
8d83e05948 docs: fixes syntax error in rich-text.mdx that was breaking build 2023-08-16 03:28:19 -04:00
PatrikKozak
7963d04a27 fix: passes in height to resizeOptions upload option to allow height resize (#3171) 2023-08-15 14:58:16 -04:00
Jessica Chowdhury
20b6b29c79 chore(test): adds test to ensure relationship returns over 10 docs (#3181)
* chore(test): adds test to ensure relationship returns over 10 docs

* chore: remove unnecessary movieDocs variable
2023-08-15 19:48:33 +02:00
Alessio Gravili
fdfdfc83f3 fix: WhereBuilder component does not accept all valid Where queries (#3087)
* chore: add jsDocs for ListControls

* chore: add jsDocs for ListView

* chore: add jsDocs for WhereBuilder

* chore: add comment

* chore: remove unnecessary console log

* chore: improve operator type

* fix: transform where queries which aren't necessarily incorrect, and improve their validation

* chore: add type to import

* fix: do not merge existing old query params with new ones if the existing old ones got transformed and are not valid, as that would cause duplicates

* chore: sort imports and remove extra validation

* fix: transformWhereQuery logic

* chore: add back extra validation

* chore: add e2e tests
2023-08-15 19:22:57 +02:00
Jarrod Flesch
c154eb7e2b chore: remove swc version pin (#3179) 2023-08-15 09:19:18 -04:00
Stef Gootzen
33686c6db8 feat: add afterOperation hook (#2697)
* feat: add afterOperation hook for Find operation

* docs: change #afterOperation to #afteroperation

* chore: extract afterOperation in function

* chore: implement afterChange in operations

* docs: use proper CollectionAfterOperationHook

* chore: remove outdated info

* chore: types afterOperation hook

* chore: improves afterOperation tests

* docs: updates description of afterOperation hook

* chore: improve typings

* chore: improve types

* chore: rename index.tsx => index.ts

---------

Co-authored-by: Jacob Fletcher <jacobsfletch@gmail.com>
Co-authored-by: Alessio Gravili <alessio@gravili.de>
2023-08-15 14:37:01 +02:00
Alessio Gravili
6d6acbcfc1 Merge pull request #3176 from payloadcms/chore/docs-design-contributions
chore: add section for design contributions in contributing.md
2023-08-15 14:25:50 +02:00
Alessio Gravili
4e2f2561ff chore: add section for design contributions in contributing.md 2023-08-15 13:34:11 +02:00
524 changed files with 32306 additions and 4365 deletions

9
.vscode/launch.json vendored
View File

@@ -18,5 +18,12 @@
"type": "node-terminal",
"cwd": "${workspaceFolder}"
},
{
"command": "yarn run dev versions",
"name": "Debug Versions",
"request": "launch",
"type": "node-terminal",
"cwd": "${workspaceFolder}"
},
]
}
}

View File

@@ -1,5 +1,84 @@
## [1.15.6](https://github.com/payloadcms/payload/compare/v1.15.5...v1.15.6) (2023-09-13)
### Bug Fixes
* **#3289:** removes HMR plugin from prod webpack configs ([#3319](https://github.com/payloadcms/payload/issues/3319)) ([8ca67d5](https://github.com/payloadcms/payload/commit/8ca67d5aaa99f0f45eac56766fe42e07ab4a41f1)), closes [#3289](https://github.com/payloadcms/payload/issues/3289)
* fields with relationTo[] correctly load returned data from form submission ([#3317](https://github.com/payloadcms/payload/issues/3317)) ([096d337](https://github.com/payloadcms/payload/commit/096d33718d28cb5207027f6737982b29a0ced90d))
* greater than equal admin filter not working ([#3306](https://github.com/payloadcms/payload/issues/3306)) ([0bd3353](https://github.com/payloadcms/payload/commit/0bd335303dff71977b46b373fbee859d11c33337))
## [1.15.5](https://github.com/payloadcms/payload/compare/v1.15.4...v1.15.5) (2023-09-09)
### Bug Fixes
* corrects hasMany relationships within addFieldStatePromise ([#3300](https://github.com/payloadcms/payload/issues/3300)) ([a7d47c6](https://github.com/payloadcms/payload/commit/a7d47c627d064e92ca541f70caf0ff3d903b2d1d))
## [1.15.4](https://github.com/payloadcms/payload/compare/v1.15.3...v1.15.4) (2023-09-06)
### Bug Fixes
* **#3274:** sets full user data from fetchFullUser instead of partial jwt data ([#3279](https://github.com/payloadcms/payload/issues/3279)) ([cf12b5f](https://github.com/payloadcms/payload/commit/cf12b5fc703be6341b2b23efebd8aa85e8602567)), closes [#3274](https://github.com/payloadcms/payload/issues/3274)
* aligns depth behaviour between local api and admin panel ([#3276](https://github.com/payloadcms/payload/issues/3276)) ([5096c37](https://github.com/payloadcms/payload/commit/5096c378743f4c5eb5f4f2f7e67e5e206cc9da40))
* appends versions key to incoming where query ([#3287](https://github.com/payloadcms/payload/issues/3287)) ([9cd5e5a](https://github.com/payloadcms/payload/commit/9cd5e5aefaf0ee2af4f577da9578bb31bf4b0acb))
* change scoping of `force` parameter to prevent false negation; ([#3278](https://github.com/payloadcms/payload/issues/3278)) ([429a88a](https://github.com/payloadcms/payload/commit/429a88a5a18e8905c63dfe00b78b3e71d56758fd))
## [1.15.3](https://github.com/payloadcms/payload/compare/v1.15.2...v1.15.3) (2023-09-05)
### Bug Fixes
* draft globals always displaying unpublish button ([9bc072c](https://github.com/payloadcms/payload/commit/9bc072ccaf318c61b2c4e2a553604a24ff6a188e))
* globals not saving updatedAt and createdAt and version dates correctly ([9fbabc8](https://github.com/payloadcms/payload/commit/9fbabc8fd6a3bea5628bea8d0acc915ddb33bb5c))
### Features
* improves query speed for version enabled collections ([16e94d4](https://github.com/payloadcms/payload/commit/16e94d401bd7cb82de53142c5f9a325abd31a81a))
## [1.15.2](https://github.com/payloadcms/payload/compare/v1.15.1...v1.15.2) (2023-08-25)
## [1.15.1](https://github.com/payloadcms/payload/compare/v1.15.0...v1.15.1) (2023-08-25)
### Bug Fixes
* arrays in richtext uploads ([#3222](https://github.com/payloadcms/payload/issues/3222)) ([cb8e07f](https://github.com/payloadcms/payload/commit/cb8e07f85232a26c265872faf408644424312af6))
* correct out of order dark-mode color variables ([#3197](https://github.com/payloadcms/payload/issues/3197)) ([3a15e07](https://github.com/payloadcms/payload/commit/3a15e077c6914aba3ef26e453fee23c89f3db829))
* mutation type with tabs missing previous tabs ([#3196](https://github.com/payloadcms/payload/issues/3196)) ([6d3b863](https://github.com/payloadcms/payload/commit/6d3b8636f4e14a4e4155279353fa06e86fe2b25c))
# [1.15.0](https://github.com/payloadcms/payload/compare/v1.14.0...v1.15.0) (2023-08-24)
### Features
* query support for geo within and intersects + dynamic GraphQL operator types ([#3183](https://github.com/payloadcms/payload/issues/3183)) ([739abdc](https://github.com/payloadcms/payload/commit/739abdcd81176b3e812470eeea97b1be0d8c4a27))
# [1.14.0](https://github.com/payloadcms/payload/compare/v1.13.4...v1.14.0) (2023-08-16)
### Bug Fixes
* DatePicker showing only selected day by default ([#3169](https://github.com/payloadcms/payload/issues/3169)) ([edcb393](https://github.com/payloadcms/payload/commit/edcb3933cfb4532180c822135ea6a8be928e0fdc))
* only allow redirects to /admin sub-routes ([c0f05a1](https://github.com/payloadcms/payload/commit/c0f05a1c38fb9c958de920fabb698b5ecfb661f0))
* passes in height to resizeOptions upload option to allow height resize ([#3171](https://github.com/payloadcms/payload/issues/3171)) ([7963d04](https://github.com/payloadcms/payload/commit/7963d04a27888eb5a12d0ab37f2082cd33638abd))
* WhereBuilder component does not accept all valid Where queries ([#3087](https://github.com/payloadcms/payload/issues/3087)) ([fdfdfc8](https://github.com/payloadcms/payload/commit/fdfdfc83f36a958971f8e4e4f9f5e51560cb26e0))
### Features
* add afterOperation hook ([#2697](https://github.com/payloadcms/payload/issues/2697)) ([33686c6](https://github.com/payloadcms/payload/commit/33686c6db8373a16d7f6b0192e0701bf15881aa4))
* add support for hotkeys ([#1821](https://github.com/payloadcms/payload/issues/1821)) ([942cfec](https://github.com/payloadcms/payload/commit/942cfec286ff050e13417b037cca64b9d757d868))
* Added Azerbaijani language file ([#3164](https://github.com/payloadcms/payload/issues/3164)) ([63e3063](https://github.com/payloadcms/payload/commit/63e3063b9ecc1afd62d7a287a798d41215008f2a))
* allow async relationship filter options ([#2951](https://github.com/payloadcms/payload/issues/2951)) ([bad3638](https://github.com/payloadcms/payload/commit/bad363882c9d00d3c73547ca3329eba988e728ff))
* Improve admin dashboard accessibility ([#3053](https://github.com/payloadcms/payload/issues/3053)) ([e03a8e6](https://github.com/payloadcms/payload/commit/e03a8e6b030e82a17e1cdae5b4032433cf9c75a4))
* improve field ops ([#3172](https://github.com/payloadcms/payload/issues/3172)) ([d91b44c](https://github.com/payloadcms/payload/commit/d91b44cbb3fd526caca2a6f4bd30fd06ede3a5da))
* make PAYLOAD_CONFIG_PATH optional ([#2839](https://github.com/payloadcms/payload/issues/2839)) ([5744de7](https://github.com/payloadcms/payload/commit/5744de7ec63e3f17df7e02a7cc827818a79dbbb8))
* text alignment for richtext editor ([#2803](https://github.com/payloadcms/payload/issues/2803)) ([a0b13a5](https://github.com/payloadcms/payload/commit/a0b13a5b01fa0d7f4c4dffd1895bfe507e5c676d))
## [1.13.4](https://github.com/payloadcms/payload/compare/v1.13.3...v1.13.4) (2023-08-11)

View File

@@ -20,6 +20,12 @@ Payload documentation can be found directly within its codebase and you can feel
If you're an incredibly awesome person and want to help us make Payload even better through new features or additions, we would be thrilled to work with you.
## Design Contributions
When it comes to design-related changes or additions, it's crucial for us to ensure a cohesive user experience and alignment with our broader design vision. Before embarking on any implementation that would affect the design or UI/UX, we ask that you **first share your design proposal** with us for review and approval.
Our design review ensures that proposed changes fit seamlessly with other components, both existing and planned. This step is meant to prevent unintentional design inconsistencies and to save you from investing time in implementing features that might need significant design alterations later.
### Before Starting
To help us work on new features, you can create a new feature request post in [GitHub Discussion](https://github.com/payloadcms/payload/discussions) or discuss it in our [Discord](https://discord.com/invite/payload). New functionality often has large implications across the entire Payload repo, so it is best to discuss the architecture and approach before starting work on a pull request.

View File

@@ -31,8 +31,10 @@ keywords: array, fields, config, configuration, documentation, Content Managemen
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`name`** \* | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
| **`label`** | Text used as the heading in the Admin panel or an object with keys for each language. Auto-generated from name if not defined. |
| **`fields`** \* | Array of field types to correspond to each row of the Array. |
| **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |
| **`fields`** \* | Array of field types to correspond to each row of the Array. |
| **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)
| **`minRows`** | A number for the fewest allowed items during validation when a value is present. |
| **`maxRows`** | A number for the most allowed items during validation when a value is present. |
| **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. |
| **`hooks`** | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) |
| **`access`** | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) |

View File

@@ -33,7 +33,9 @@ keywords: blocks, fields, config, configuration, documentation, Content Manageme
| **`name`** * | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names) |
| **`label`** | Text used as the heading in the Admin panel or an object with keys for each language. Auto-generated from name if not defined. |
| **`blocks`** * | Array of [block configs](/docs/fields/blocks#block-configs) to be made available to this field. |
| **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |
| **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)
| **`minRows`** | A number for the fewest allowed items during validation when a value is present. |
| **`maxRows`** | A number for the most allowed items during validation when a value is present. |
| **`saveToJWT`** | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT. |
| **`hooks`** | Provide field-level hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks) |
| **`access`** | Provide field-level access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control) |

View File

@@ -7,9 +7,7 @@ keywords: rich text, fields, config, configuration, documentation, Content Manag
---
<Banner>
The Rich Text field is a powerful way to allow editors to write dynamic
content. The content is saved as JSON in the database and can be converted
into any format, including HTML, that you need.
The Rich Text field is a powerful way to allow editors to write dynamic content. The content is saved as JSON in the database and can be converted into any format, including HTML, that you need.
</Banner>
<LightDarkImage
@@ -22,14 +20,7 @@ keywords: rich text, fields, config, configuration, documentation, Content Manag
The Admin component is built on the powerful [`slatejs`](https://docs.slatejs.org/) editor and is meant to be as extensible and customizable as possible.
<Banner type="success">
<strong>
Consistent with Payload's goal of making you learn as little of Payload as
possible, customizing and using the Rich Text Editor does not involve
learning how to develop for a <em>Payload</em> rich text editor.
</strong>{" "}
Instead, you can invest your time and effort into learning Slate, an
open-source tool that will allow you to apply your learnings elsewhere as
well.
<strong>Consistent with Payload's goal of making you learn as little of Payload as possible, customizing and using the Rich Text Editor does not involve learning how to develop for a <em>Payload</em> rich text editor.</strong> Instead, you can invest your time and effort into learning Slate, an open-source tool that will allow you to apply your learnings elsewhere as well.
</Banner>
### Config
@@ -125,13 +116,7 @@ The built-in `relationship` element is a powerful way to reference other Documen
Similar to the `relationship` element, the `upload` element is a user-friendly way to reference [Upload-enabled collections](/docs/upload/overview) with a UI specifically designed for media / image-based uploads.
<Banner type="success">
<strong>Tip:</strong>
<br />
Collections are automatically allowed to be selected within the Rich Text
relationship and upload elements by default. If you want to disable a
collection from being able to be referenced in Rich Text fields, set the
collection admin options of <strong>enableRichTextLink</strong> and{" "}
<strong>enableRichTextRelationship</strong> to false.
<strong>Tip:</strong><br />Collections are automatically allowed to be selected within the Rich Text relationship and upload elements by default. If you want to disable a collection from being able to be referenced in Rich Text fields, set the collection admin options of <strong>enableRichTextLink</strong> and <strong>enableRichTextRelationship</strong> to false.
</Banner>
Relationship and Upload elements are populated dynamically into your Rich Text field' content. Within the REST and Local APIs, any present RichText `relationship` or `upload` elements will respect the `depth` option that you pass, and will be populated accordingly. In GraphQL, each `richText` field accepts an argument of `depth` for you to utilize.
@@ -307,10 +292,7 @@ const serialize = (children) =>
```
<Banner>
<strong>Note:</strong>
<br />
The above example is for how to render to JSX, although for plain HTML the
pattern is similar. Just remove the JSX and return HTML strings instead!
<strong>Note:</strong><br />The above example is for how to render to JSX, although for plain HTML the pattern is similar. Just remove the JSX and return HTML strings instead!
</Banner>
### Built-in SlateJS Plugins

View File

@@ -10,8 +10,7 @@ keywords: select, multi-select, fields, config, configuration, documentation, Co
The Select field provides a dropdown-style interface for choosing options from
a predefined list as an enumeration.
</Banner>
<LightDarkImage
<LightDarkImage
srcLight='https://payloadcms.com/images/docs/fields/select.png'
srcDark='https://payloadcms.com/images/docs/fields/select-dark.png'
alt='Shows a Select field in the Payload admin panel'
@@ -99,3 +98,85 @@ export const ExampleCollection: CollectionConfig = {
}
```
### Customization
The Select field UI component can be customized by providing a custom React component to the `components` object in the Base config.
```ts
export const CustomSelectField: Field = {
name: 'customSelectField',
type: 'select', // or 'text' if you have dynamic options
admin: {
components: {
Field: CustomSelectComponent({
options: [
{
label: 'Option 1',
value: '1',
},
{
label: 'Option 2',
value: '2',
},
],
}),
},
}
}
```
You can import the existing Select component directly from Payload, then extend and customize it as needed.
```ts
import * as React from 'react';
import { SelectInput, useField } from 'payload/components/forms';
import { useAuth } from 'payload/components/utilities';
type customSelectProps = {
path: string;
options: {
label: string;
value: string;
}[];
}
export const CustomSelectComponent: React.FC<CustomSelectProps> = ({ path, options }) => {
const { value, setValue } = useField<string>({ path });
const { user } = useAuth();
const adjustedOptions = options.filter((option) => {
/*
A common use case for a custom select
is to show different options based on
the current user's role.
*/
return option;
});
return (
<div>
<label className="field-label">
Custom Select
</label>
<SelectInput
path={path}
name={path}
options={adjustedOptions}
value={value}
onChange={() => setValue(e.value)}
/>
</div>
);
};
```
If you are looking to create a dynamic select field, the following tutorial will walk you through the process of creating a custom select field that fetches its options from an external API.
<VideoDrawer
id='Efn9OxSjA6Y'
label='How to Create a Custom Select Field'
drawerTitle='How to Create a Custom Select Field: A Step-by-Step Guide'
/>
If you want to learn more about custom components check out the [Admin > Custom Component](/docs/admin/components#field-component) docs.

View File

@@ -16,6 +16,7 @@ Collections feature the ability to define the following hooks:
- [afterRead](#afterread)
- [beforeDelete](#beforedelete)
- [afterDelete](#afterdelete)
- [afterOperation](#afteroperation)
Additionally, `auth`-enabled collections feature the following hooks:
@@ -31,6 +32,7 @@ Additionally, `auth`-enabled collections feature the following hooks:
All collection Hook properties accept arrays of synchronous or asynchronous functions. Each Hook type receives specific arguments and has the ability to modify specific outputs.
`collections/exampleHooks.js`
```ts
import { CollectionConfig } from 'payload/types';
@@ -48,6 +50,7 @@ export const ExampleHooks: CollectionConfig = {
afterChange: [(args) => {...}],
afterRead: [(args) => {...}],
afterDelete: [(args) => {...}],
afterOperation: [(args) => {...}],
// Auth-enabled hooks
beforeLogin: [(args) => {...}],
@@ -62,19 +65,19 @@ export const ExampleHooks: CollectionConfig = {
### beforeOperation
The `beforeOperation` Hook type can be used to modify the arguments that operations accept or execute side-effects that run before an operation begins.
The `beforeOperation` hook can be used to modify the arguments that operations accept or execute side-effects that run before an operation begins.
Available Collection operations include `create`, `read`, `update`, `delete`, `login`, `refresh` and `forgotPassword`.
Available Collection operations include `create`, `read`, `update`, `delete`, `login`, `refresh`, and `forgotPassword`.
```ts
import { CollectionBeforeOperationHook } from 'payload/types';
import { CollectionBeforeOperationHook } from "payload/types";
const beforeOperationHook: CollectionBeforeOperationHook = async ({
args, // Original arguments passed into the operation
args, // original arguments passed into the operation
operation, // name of the operation
}) => {
return args; // Return operation arguments as necessary
}
return args; // return modified operation arguments as necessary
};
```
### beforeValidate
@@ -88,7 +91,7 @@ Please do note that this does not run before the client-side validation. If you
3. `validate` runs on the server
```ts
import { CollectionBeforeOperationHook } from 'payload/types';
import { CollectionBeforeOperationHook } from "payload/types";
const beforeValidateHook: CollectionBeforeValidateHook = async ({
data, // incoming data to update or create with
@@ -97,7 +100,7 @@ const beforeValidateHook: CollectionBeforeValidateHook = async ({
originalDoc, // original document
}) => {
return data; // Return data to either create or update a document with
}
};
```
### beforeChange
@@ -105,7 +108,7 @@ const beforeValidateHook: CollectionBeforeValidateHook = async ({
Immediately following validation, `beforeChange` hooks will run within `create` and `update` operations. At this stage, you can be confident that the data that will be saved to the document is valid in accordance to your field validations. You can optionally modify the shape of data to be saved.
```ts
import { CollectionBeforeChangeHook } from 'payload/types';
import { CollectionBeforeChangeHook } from "payload/types";
const beforeChangeHook: CollectionBeforeChangeHook = async ({
data, // incoming data to update or create with
@@ -114,7 +117,7 @@ const beforeChangeHook: CollectionBeforeChangeHook = async ({
originalDoc, // original document
}) => {
return data; // Return data to either create or update a document with
}
};
```
### afterChange
@@ -122,7 +125,7 @@ const beforeChangeHook: CollectionBeforeChangeHook = async ({
After a document is created or updated, the `afterChange` hook runs. This hook is helpful to recalculate statistics such as total sales within a global, syncing user profile changes to a CRM, and more.
```ts
import { CollectionAfterChangeHook } from 'payload/types';
import { CollectionAfterChangeHook } from "payload/types";
const afterChangeHook: CollectionAfterChangeHook = async ({
doc, // full document data
@@ -130,8 +133,8 @@ const afterChangeHook: CollectionAfterChangeHook = async ({
previousDoc, // document data before updating the collection
operation, // name of the operation ie. 'create', 'update'
}) => {
return doc;
}
return doc; // value to be used in subsequent afterChange hooks
};
```
### beforeRead
@@ -139,7 +142,7 @@ const afterChangeHook: CollectionAfterChangeHook = async ({
Runs before `find` and `findByID` operations are transformed for output by `afterRead`. This hook fires before hidden fields are removed and before localized fields are flattened into the requested locale. Using this Hook will provide you with all locales and all hidden fields via the `doc` argument.
```ts
import { CollectionBeforeReadHook } from 'payload/types';
import { CollectionBeforeReadHook } from "payload/types";
const beforeReadHook: CollectionBeforeReadHook = async ({
doc, // full document data
@@ -147,7 +150,7 @@ const beforeReadHook: CollectionBeforeReadHook = async ({
query, // JSON formatted query
}) => {
return doc;
}
};
```
### afterRead
@@ -155,7 +158,7 @@ const beforeReadHook: CollectionBeforeReadHook = async ({
Runs as the last step before documents are returned. Flattens locales, hides protected fields, and removes fields that users do not have access to.
```ts
import { CollectionAfterReadHook } from 'payload/types';
import { CollectionAfterReadHook } from "payload/types";
const afterReadHook: CollectionAfterReadHook = async ({
doc, // full document data
@@ -164,7 +167,7 @@ const afterReadHook: CollectionAfterReadHook = async ({
findMany, // boolean to denote if this hook is running against finding one, or finding many
}) => {
return doc;
}
};
```
### beforeDelete
@@ -194,19 +197,37 @@ const afterDeleteHook: CollectionAfterDeleteHook = async ({
}) => {...}
```
### afterOperation
The `afterOperation` hook can be used to modify the result of operations or execute side-effects that run after an operation has completed.
Available Collection operations include `create`, `find`, `findByID`, `update`, `updateByID`, `delete`, `deleteByID`, `login`, `refresh`, and `forgotPassword`.
```ts
import { CollectionAfterOperationHook } from "payload/types";
const afterOperationHook: CollectionAfterOperationHook = async ({
args, // arguments passed into the operation
operation, // name of the operation
result, // the result of the operation, before modifications
}) => {
return result; // return modified result as necessary
};
```
### beforeLogin
For auth-enabled Collections, this hook runs during `login` operations where a user with the provided credentials exist, but before a token is generated and added to the response. You can optionally modify the user that is returned, or throw an error in order to deny the login operation.
```ts
import { CollectionBeforeLoginHook } from 'payload/types';
import { CollectionBeforeLoginHook } from "payload/types";
const beforeLoginHook: CollectionBeforeLoginHook = async ({
req, // full express request
user, // user being logged in
}) => {
return user;
}
};
```
### afterLogin
@@ -267,7 +288,7 @@ const afterMeHook: CollectionAfterMeHook = async ({
For auth-enabled Collections, this hook runs after successful `forgotPassword` operations. Returned values are discarded.
```ts
import { CollectionAfterForgotPasswordHook } from 'payload/types';
import { CollectionAfterForgotPasswordHook } from "payload/types";
const afterLoginHook: CollectionAfterForgotPasswordHook = async ({
req, // full express request
@@ -275,7 +296,7 @@ const afterLoginHook: CollectionAfterForgotPasswordHook = async ({
token, // user token
}) => {
return user;
}
};
```
## TypeScript
@@ -298,5 +319,5 @@ import type {
CollectionAfterRefreshHook,
CollectionAfterMeHook,
CollectionAfterForgotPasswordHook,
} from 'payload/types';
} from "payload/types";
```

View File

@@ -2,5 +2,5 @@ MONGODB_URI=mongodb://127.0.0.1/payload-example-custom-server
PAYLOAD_SECRET=PAYLOAD_CUSTOM_SERVER_EXAMPLE_SECRET_KEY
PAYLOAD_PUBLIC_SERVER_URL=http://localhost:3000
NEXT_PUBLIC_SERVER_URL=http://localhost:3000
PAYLOAD_SEED=true
PAYLOAD_PUBLIC_SEED=true
PAYLOAD_DROP_DATABASE=true

View File

@@ -94,7 +94,7 @@ To spin up this example locally, follow the [Quick Start](#quick-start).
### Seed
On boot, a seed script is included to scaffold a basic database for you to use as an example. This is done by setting the `PAYLOAD_DROP_DATABASE` and `PAYLOAD_SEED` environment variables which are included in the `.env.example` by default. You can remove these from your `.env` to prevent this behavior. You can also freshly seed your project at any time by running `yarn seed`. This seed creates an admin user with email `dev@payloadcms.com`, password `test`, and a `home` page.
On boot, a seed script is included to scaffold a basic database for you to use as an example. This is done by setting the `PAYLOAD_DROP_DATABASE` and `PAYLOAD_PUBLIC_SEED` environment variables which are included in the `.env.example` by default. You can remove these from your `.env` to prevent this behavior. You can also freshly seed your project at any time by running `yarn seed`. This seed creates an admin user with email `dev@payloadcms.com`, password `test`, and a `home` page.
> NOTICE: seeding the database is destructive because it drops your current database to populate a fresh one from the seed template. Only run this command if you are starting a new project or can afford to lose your current data.

View File

@@ -6,7 +6,7 @@
"license": "MIT",
"scripts": {
"dev": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts nodemon",
"seed": "rm -rf media && cross-env PAYLOAD_SEED=true PAYLOAD_DROP_DATABASE=true PAYLOAD_CONFIG_PATH=src/payload.config.ts ts-node src/server.ts",
"seed": "rm -rf media && cross-env PAYLOAD_PUBLIC_SEED=true PAYLOAD_DROP_DATABASE=true PAYLOAD_CONFIG_PATH=src/payload.config.ts ts-node src/server.ts",
"build:payload": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload build",
"build:server": "tsc --project tsconfig.server.json",
"build:next": "cross-env PAYLOAD_CONFIG_PATH=dist/payload.config.js NEXT_BUILD=true node dist/server.js",
@@ -52,4 +52,4 @@
"ts-node": "^10.9.1",
"typescript": "^4.8.4"
}
}
}

View File

@@ -0,0 +1,5 @@
import { NextResponse } from 'next/server'
export async function GET(): Promise<NextResponse> {
return NextResponse.json({ success: true })
}

View File

@@ -0,0 +1,5 @@
import { NextResponse } from 'next/server'
export async function POST(): Promise<NextResponse> {
return NextResponse.json({ success: true })
}

View File

@@ -1,6 +1,7 @@
import React, { Fragment } from 'react'
import { notFound } from 'next/navigation'
import { getPayloadClient } from '../getPayload'
import { Page } from './../payload-types'
import { Gutter } from './_components/Gutter'
import { RichText } from './_components/RichText'
@@ -8,11 +9,17 @@ import { RichText } from './_components/RichText'
import classes from './page.module.scss'
export default async function Home() {
const home: Page = await fetch(
`${process.env.NEXT_PUBLIC_SERVER_URL}/api/pages?where[slug][equals]=home`,
)
.then(res => res.json())
.then(res => res?.docs?.[0])
const payload = await getPayloadClient()
const { docs } = await payload.find({
collection: 'pages',
where: {
slug: {
equals: 'home',
},
},
})
const home = docs?.[0] as Page
if (!home) {
return notFound()

View File

@@ -0,0 +1,17 @@
import React from 'react'
const BeforeLogin: React.FC = () => {
if (process.env.PAYLOAD_PUBLIC_SEED === 'true') {
return (
<p>
{'Log in with the email '}
<strong>demo@payloadcms.com</strong>
{' and the password '}
<strong>demo</strong>.
</p>
)
}
return null
}
export default BeforeLogin

View File

@@ -0,0 +1,59 @@
import dotenv from 'dotenv'
import path from 'path'
import type { Payload } from 'payload'
import payload from 'payload'
import type { InitOptions } from 'payload/config'
import { seed as seedData } from './seed'
dotenv.config({
path: path.resolve(__dirname, '../.env'),
})
let cached = (global as any).payload
if (!cached) {
cached = (global as any).payload = { client: null, promise: null }
}
interface Args {
initOptions?: Partial<InitOptions>
seed?: boolean
}
export const getPayloadClient = async ({ initOptions, seed }: Args = {}): Promise<Payload> => {
if (!process.env.MONGODB_URI) {
throw new Error('MONGODB_URI environment variable is missing')
}
if (!process.env.PAYLOAD_SECRET) {
throw new Error('PAYLOAD_SECRET environment variable is missing')
}
if (cached.client) {
return cached.client
}
if (!cached.promise) {
cached.promise = payload.init({
mongoURL: process.env.MONGODB_URI,
secret: process.env.PAYLOAD_SECRET,
local: initOptions?.express ? false : true,
...(initOptions || {}),
})
}
try {
process.env.PAYLOAD_DROP_DATABASE = seed ? 'true' : 'false'
cached.client = await cached.promise
if (seed) {
await seedData(payload)
}
} catch (e: unknown) {
cached.promise = null
throw e
}
return cached.client
}

View File

@@ -8,10 +8,16 @@ dotenv.config({
import { buildConfig } from 'payload/config'
import { Pages } from './collections/Pages'
import BeforeLogin from './components/BeforeLogin'
export default buildConfig({
serverURL: process.env.PAYLOAD_PUBLIC_SERVER_URL || '',
collections: [Pages],
admin: {
components: {
beforeLogin: [BeforeLogin],
},
},
typescript: {
outputFile: path.resolve(__dirname, 'payload-types.ts'),
},

View File

@@ -5,8 +5,8 @@ export const seed = async (payload: Payload): Promise<void> => {
await payload.create({
collection: 'users',
data: {
email: 'dev@payloadcms.com',
password: 'test',
email: 'demo@payloadcms.com',
password: 'demo',
},
})

View File

@@ -10,33 +10,23 @@ dotenv.config({
})
import express from 'express'
import payload from 'payload'
import { seed } from './seed'
import { getPayloadClient } from './getPayload'
const app = express()
const PORT = process.env.PORT || 3000
// Redirect root to the admin panel
app.get('/', (_, res) => {
res.redirect('/admin')
})
const start = async (): Promise<void> => {
await payload.init({
secret: process.env.PAYLOAD_SECRET || '',
mongoURL: process.env.MONGODB_URI || '',
express: app,
onInit: () => {
payload.logger.info(`Payload Admin URL: ${payload.getAdminURL()}`)
const payload = await getPayloadClient({
initOptions: {
express: app,
onInit: async newPayload => {
newPayload.logger.info(`Payload Admin URL: ${newPayload.getAdminURL()}`)
},
},
seed: process.env.PAYLOAD_PUBLIC_SEED === 'true',
})
if (process.env.PAYLOAD_SEED === 'true') {
payload.logger.info('---- SEEDING DATABASE ----')
await seed(payload)
}
app.listen(PORT, async () => {
payload.logger.info(`App URL: ${process.env.PAYLOAD_PUBLIC_SERVER_URL}`)
})

View File

@@ -8,28 +8,23 @@ dotenv.config({
})
import express from 'express'
import payload from 'payload'
import { seed } from './seed'
import { getPayloadClient } from './getPayload'
const app = express()
const PORT = process.env.PORT || 3000
const start = async (): Promise<void> => {
await payload.init({
secret: process.env.PAYLOAD_SECRET || '',
mongoURL: process.env.MONGODB_URI || '',
express: app,
onInit: () => {
payload.logger.info(`Payload Admin URL: ${payload.getAdminURL()}`)
const payload = await getPayloadClient({
initOptions: {
express: app,
onInit: async newPayload => {
newPayload.logger.info(`Payload Admin URL: ${newPayload.getAdminURL()}`)
},
},
seed: process.env.PAYLOAD_PUBLIC_SEED === 'true',
})
if (process.env.PAYLOAD_SEED === 'true') {
payload.logger.info('---- SEEDING DATABASE ----')
await seed(payload)
}
if (process.env.NEXT_BUILD) {
app.listen(PORT, async () => {
payload.logger.info(`Next.js is now building...`)
@@ -47,7 +42,7 @@ const start = async (): Promise<void> => {
const nextHandler = nextApp.getRequestHandler()
app.get('*', (req, res) => nextHandler(req, res))
app.use((req, res) => nextHandler(req, res))
nextApp.prepare().then(() => {
payload.logger.info('Next.js started')

View File

@@ -1,6 +1,6 @@
# Payload Draft Preview Example Front-End
This is a [Next.js](https://nextjs.org) app using the [App Router](https://nextjs.org/docs/app). It was made explicitly for Payload's [Draft Preview Example](https://github.com/payloadcms/payload/tree/master/examples/draft-preview).
This is a [Next.js](https://nextjs.org) app using the [App Router](https://nextjs.org/docs/app). It was made explicitly for Payload's [Draft Preview Example](https://github.com/payloadcms/payload/tree/master/examples/draft-preview/payload).
> This example uses the App Router, the latest API of Next.js. If your app is using the legacy [Pages Router](https://nextjs.org/docs/pages), check out the official [Pages Router Example](https://github.com/payloadcms/payload/tree/master/examples/draft-preview/next-pages).

View File

@@ -20,6 +20,11 @@ export const fetchPage = async (
draft && payloadToken ? '&draft=true' : ''
}`,
{
method: 'GET',
// this is the key we'll use to on-demand revalidate pages that use this data
// we do this by calling `revalidateTag()` using the same key
// see `app/api/revalidate.ts` for more info
next: { tags: [`pages_${slug}`] },
...(draft && payloadToken
? {
headers: {

View File

@@ -1,23 +1,32 @@
import { revalidatePath } from 'next/cache'
import { revalidatePath, revalidateTag } from 'next/cache'
import type { NextRequest } from 'next/server'
import { NextResponse } from 'next/server'
// this endpoint will revalidate a page by tag or path
// this is to achieve on-demand revalidation of pages that use this data
// send either `collection` and `slug` or `revalidatePath` as query params
export async function GET(request: NextRequest): Promise<unknown> {
const path = request.nextUrl.searchParams.get('revalidatePath')
const collection = request.nextUrl.searchParams.get('collection')
const slug = request.nextUrl.searchParams.get('slug')
const path = request.nextUrl.searchParams.get('path')
const secret = request.nextUrl.searchParams.get('secret')
if (secret !== process.env.NEXT_PRIVATE_REVALIDATION_KEY) {
return NextResponse.json({ revalidated: false, now: Date.now() })
}
if (typeof collection === 'string' && typeof slug === 'string') {
revalidateTag(`${collection}_${slug}`)
return NextResponse.json({ revalidated: true, now: Date.now() })
}
// there is a known limitation with `revalidatePath` where it will not revalidate exact paths of dynamic routes
// instead, Next.js expects us to revalidate entire directories, i.e. `revalidatePath('/[slug]')` instead of `/example-page`
// for this reason, it is preferred to use `revalidateTag` instead of `revalidatePath`
// - https://github.com/vercel/next.js/issues/49387
// - https://github.com/vercel/next.js/issues/49778#issuecomment-1547028830
if (typeof path === 'string') {
// there is a known bug with `revalidatePath` where it will not revalidate exact paths of dynamic routes
// instead, Next.js expects us to revalidate entire directories, i.e. `/[slug]` instead of `/example-page`
// for now we'll make this change but with expectation that it will be fixed so we can use `revalidatePath('/example-page')`
// - https://github.com/vercel/next.js/issues/49387
// - https://github.com/vercel/next.js/issues/49778#issuecomment-1547028830
// revalidatePath(path)
revalidatePath('/[slug]')
revalidatePath(path)
return NextResponse.json({ revalidated: true, now: Date.now() })
}

View File

@@ -1,6 +1,6 @@
# Payload Draft Preview Example Front-End
This is a [Next.js](https://nextjs.org) app using the [Pages Router](https://nextjs.org/docs/pages). It was made explicitly for Payload's [Draft Preview Example](https://github.com/payloadcms/payload/tree/master/examples/draft-preview).
This is a [Next.js](https://nextjs.org) app using the [Pages Router](https://nextjs.org/docs/pages). It was made explicitly for Payload's [Draft Preview Example](https://github.com/payloadcms/payload/tree/master/examples/draft-preview/payload).
> This example uses the Pages Router, the legacy API of Next.js. If your app is using the latest [App Router](https://nextjs.org/docs/app), check out the official [App Router Example](https://github.com/payloadcms/payload/tree/master/examples/draft-preview/next-app).

View File

@@ -6,9 +6,9 @@ const revalidate = async (req: NextApiRequest, res: NextApiResponse): Promise<vo
return res.status(401).json({ message: 'Invalid token' })
}
if (typeof req.query.revalidatePath === 'string') {
if (typeof req.query.path === 'string') {
try {
await res.revalidate(req.query.revalidatePath)
await res.revalidate(req.query.path)
return res.json({ revalidated: true })
} catch (err: unknown) {
// If there was an error, Next.js will continue

View File

@@ -1,6 +1,6 @@
# Payload Draft Preview Example
The [Payload Draft Preview Example](https://github.com/payloadcms/payload/tree/master/examples/draft-preview) demonstrates how to implement draft preview in [Payload](https://github.com/payloadcms/payload) using [Versions](https://payloadcms.com/docs/versions/overview) and [Drafts](https://payloadcms.com/docs/versions/drafts). Draft preview allows you to see content on your front-end before it is published. There are various fully working front-ends made explicitly for this example, including:
The [Payload Draft Preview Example](https://github.com/payloadcms/payload/tree/master/examples/draft-preview/payload) demonstrates how to implement draft preview in [Payload](https://github.com/payloadcms/payload) using [Versions](https://payloadcms.com/docs/versions/overview) and [Drafts](https://payloadcms.com/docs/versions/drafts). Draft preview allows you to see content on your front-end before it is published. There are various fully working front-ends made explicitly for this example, including:
- [Next.js App Router](../next-app)
- [Next.js Pages Router](../next-pages)

View File

@@ -7,9 +7,11 @@ export const formatAppURL = ({ doc }): string => {
return pathname
}
// Revalidate the page in the background, so the user doesn't have to wait
// Notice that the hook itself is not async and we are not awaiting `revalidate`
// Only revalidate existing docs that are published
// revalidate the page in the background, so the user doesn't have to wait
// notice that the hook itself is not async and we are not awaiting `revalidate`
// only revalidate existing docs that are published (not drafts)
// send `revalidatePath`, `collection`, and `slug` to the frontend to use in its revalidate route
// frameworks may have different ways of doing this, but the idea is the same
export const revalidatePage: AfterChangeHook = ({ doc, req, operation }) => {
if (operation === 'update' && doc._status === 'published') {
const url = formatAppURL({ doc })
@@ -17,7 +19,7 @@ export const revalidatePage: AfterChangeHook = ({ doc, req, operation }) => {
const revalidate = async (): Promise<void> => {
try {
const res = await fetch(
`${process.env.PAYLOAD_PUBLIC_SITE_URL}/api/revalidate?secret=${process.env.REVALIDATION_KEY}&revalidatePath=${url}`,
`${process.env.PAYLOAD_PUBLIC_SITE_URL}/api/revalidate?secret=${process.env.REVALIDATION_KEY}&collection=pages&slug=${doc?.slug}&path=${url}`,
)
if (res.ok) {

View File

@@ -16,7 +16,7 @@ export const Pages: CollectionConfig = {
formatAppURL({
doc,
}),
)}&secret=${process.env.PAYLOAD_PUBLIC_DRAFT_SECRET}`
)}&collection=pages&slug=${doc.slug}&secret=${process.env.PAYLOAD_PUBLIC_DRAFT_SECRET}`
},
},
versions: {

View File

@@ -1,6 +1,7 @@
import type { Page } from '../payload-types'
export const examplePageDraft: Partial<Page> = {
title: 'Example Page (Draft)',
richText: [
{
children: [

View File

@@ -1,6 +1,6 @@
{
"name": "payload",
"version": "1.13.4",
"version": "1.15.6",
"description": "Node, React and MongoDB Headless CMS and Application Framework",
"license": "MIT",
"engines": {
@@ -46,6 +46,7 @@
"test:e2e:headed": "cross-env DISABLE_LOGGING=true playwright test --headed",
"test:e2e:debug": "cross-env PWDEBUG=1 DISABLE_LOGGING=true playwright test",
"test:components": "cross-env jest --config=jest.components.config.js",
"translateNewKeys": "ts-node -T ./scripts/translateNewKeys.ts",
"clean:cache": "rimraf node_modules/.cache",
"clean": "rimraf dist",
"release:patch": "release-it patch",
@@ -88,8 +89,8 @@
"@faceless-ui/scroll-info": "^1.3.0",
"@faceless-ui/window-info": "^2.1.1",
"@monaco-editor/react": "^4.5.1",
"@swc/core": "^1.3.76",
"@swc/register": "^0.1.10",
"@swc/core": "1.3.78",
"@swc/register": "0.1.10",
"@types/sharp": "^0.31.1",
"body-parser": "^1.20.1",
"bson-objectid": "^2.0.4",

128
scripts/translateNewKeys.ts Normal file
View File

@@ -0,0 +1,128 @@
/* eslint-disable no-await-in-loop */
/* eslint-disable no-continue */
/* eslint-disable no-restricted-syntax */
import * as fs from 'fs';
import * as path from 'path';
const TRANSLATIONS_DIR = './src/translations';
const SOURCE_LANG_FILE = 'en.json';
const OPENAI_ENDPOINT = 'https://api.openai.com/v1/chat/completions'; // Adjust if needed
const OPENAI_API_KEY = 'sk-YOURKEYHERE'; // Remember to replace with your actual key
async function main() {
const sourceLangContent = JSON.parse(fs.readFileSync(path.join(TRANSLATIONS_DIR, SOURCE_LANG_FILE), 'utf8'));
const files = fs.readdirSync(TRANSLATIONS_DIR);
for (const file of files) {
if (file === SOURCE_LANG_FILE) {
continue;
}
// check if file ends with .json
if (!file.endsWith('.json')) {
continue;
}
// skip the translation-schema.json file
if (file === 'translation-schema.json') {
continue;
}
console.log('Processing file:', file);
const targetLangContent = JSON.parse(fs.readFileSync(path.join(TRANSLATIONS_DIR, file), 'utf8'));
const missingKeys = findMissingKeys(sourceLangContent, targetLangContent);
let hasChanged = false;
for (const missingKey of missingKeys) {
const keys = missingKey.split('.');
const sourceText = keys.reduce((acc, key) => acc[key], sourceLangContent);
const targetLang = file.split('.')[0];
const translatedText = await translateText(sourceText, targetLang);
let targetObj = targetLangContent;
for (let i = 0; i < keys.length - 1; i += 1) {
if (!targetObj[keys[i]]) {
targetObj[keys[i]] = {};
}
targetObj = targetObj[keys[i]];
}
targetObj[keys[keys.length - 1]] = translatedText;
hasChanged = true;
}
if (hasChanged) {
const sortedContent = sortKeys(targetLangContent);
fs.writeFileSync(path.join(TRANSLATIONS_DIR, file), JSON.stringify(sortedContent, null, 2));
}
}
}
main().then(() => {
console.log('Translation update completed.');
}).catch((error) => {
console.error('Error occurred:', error);
});
async function translateText(text: string, targetLang: string): Promise<string> {
const response = await fetch(OPENAI_ENDPOINT, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${OPENAI_API_KEY}`,
},
body: JSON.stringify({
max_tokens: 150,
model: 'gpt-4',
messages: [
{
role: 'system',
content: `Only respond with the translation of the text you receive. The original language is English and the translation language is ${targetLang}. Only respond with the translation - do not say anything else. If you cannot translate the text, respond with "[SKIPPED]"`,
},
{
role: 'user',
content: text,
},
],
}),
});
const data = await response.json();
console.log(' Old text:', text, 'New text:', data.choices[0].message.content.trim());
return data.choices[0].message.content.trim();
}
function findMissingKeys(baseObj: any, targetObj: any, prefix = ''): string[] {
let missingKeys = [];
for (const key in baseObj) {
if (typeof baseObj[key] === 'object') {
missingKeys = missingKeys.concat(findMissingKeys(baseObj[key], targetObj[key] || {}, `${prefix}${key}.`));
} else if (!(key in targetObj)) {
missingKeys.push(`${prefix}${key}`);
}
}
return missingKeys;
}
function sortKeys(obj: any): any {
if (typeof obj !== 'object' || obj === null) return obj;
if (Array.isArray(obj)) {
return obj.map(sortKeys);
}
const sortedKeys = Object.keys(obj).sort();
const sortedObj: { [key: string]: any } = {};
for (const key of sortedKeys) {
sortedObj[key] = sortKeys(obj[key]);
}
return sortedObj;
}

View File

@@ -72,6 +72,7 @@ const Button = forwardRef<HTMLButtonElement | HTMLAnchorElement, Props>((props,
iconPosition = 'right',
newTab,
tooltip,
'aria-label': ariaLabel,
} = props;
const [showTooltip, setShowTooltip] = React.useState(false);
@@ -101,6 +102,8 @@ const Button = forwardRef<HTMLButtonElement | HTMLAnchorElement, Props>((props,
type,
className: classes,
disabled,
'aria-disabled': disabled,
'aria-label': ariaLabel,
onMouseEnter: tooltip ? () => setShowTooltip(true) : undefined,
onMouseLeave: tooltip ? () => setShowTooltip(false) : undefined,
onClick: !disabled ? handleClick : undefined,

View File

@@ -19,4 +19,5 @@ export type Props = {
iconPosition?: 'left' | 'right',
newTab?: boolean
tooltip?: string
'aria-label'?: string
}

View File

@@ -5,7 +5,8 @@
padding: base(1.25) $baseline;
position: relative;
h5 {
&__title {
@extend %h5;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;

View File

@@ -7,7 +7,7 @@ import './index.scss';
const baseClass = 'card';
const Card: React.FC<Props> = (props) => {
const { id, title, actions, onClick } = props;
const { id, title, titleAs, buttonAriaLabel, actions, onClick } = props;
const classes = [
baseClass,
@@ -15,14 +15,16 @@ const Card: React.FC<Props> = (props) => {
onClick && `${baseClass}--has-onclick`,
].filter(Boolean).join(' ');
const Tag = titleAs ?? 'div';
return (
<div
className={classes}
id={id}
>
<h5>
<Tag className={`${baseClass}__title`}>
{title}
</h5>
</Tag>
{actions && (
<div className={`${baseClass}__actions`}>
{actions}
@@ -30,6 +32,7 @@ const Card: React.FC<Props> = (props) => {
)}
{onClick && (
<Button
aria-label={buttonAriaLabel}
className={`${baseClass}__click`}
buttonStyle="none"
onClick={onClick}

View File

@@ -1,6 +1,10 @@
import { ElementType } from 'react';
export type Props = {
id?: string,
title: string,
titleAs?: ElementType,
buttonAriaLabel?: string,
actions?: React.ReactNode,
onClick?: () => void,
}

View File

@@ -2,9 +2,9 @@ import React from 'react';
import Editor from '@monaco-editor/react';
import type { Props } from './types';
import { useTheme } from '../../utilities/Theme';
import { ShimmerEffect } from '../ShimmerEffect';
import './index.scss';
import { ShimmerEffect } from '../ShimmerEffect';
const baseClass = 'code-editor';

View File

@@ -1,4 +1,4 @@
import React, { useId, useState } from 'react';
import React, { useId } from 'react';
import { useTranslation } from 'react-i18next';
import Pill from '../Pill';
import Plus from '../../icons/Plus';
@@ -61,6 +61,7 @@ const ColumnSelector: React.FC<Props> = (props) => {
alignIcon="left"
key={`${collection.slug}-${col.name || i}${editDepth ? `-${editDepth}-` : ''}${uuid}`}
icon={active ? <X /> : <Plus />}
aria-checked={active}
className={[
`${baseClass}__column`,
active && `${baseClass}__column--active`,

View File

@@ -90,7 +90,7 @@ const Content: React.FC<DocumentDrawerProps> = ({
const isEditing = Boolean(id);
const apiURL = id ? `${serverURL}${api}/${collectionSlug}/${id}?locale=${locale}` : null;
const action = `${serverURL}${api}/${collectionSlug}${id ? `/${id}` : ''}?locale=${locale}&depth=0&fallback-locale=null`;
const action = `${serverURL}${api}/${collectionSlug}${id ? `/${id}` : ''}?locale=${locale}&fallback-locale=null`;
const hasSavePermission = (isEditing && docPermissions?.update?.permission) || (!isEditing && (docPermissions as CollectionPermission)?.create?.permission);
const isLoading = !internalState || !docPermissions || isLoadingDocument;

View File

@@ -5,11 +5,11 @@ import { useTranslation } from 'react-i18next';
import { Props, TogglerProps } from './types';
import { EditDepthContext, useEditDepth } from '../../utilities/EditDepth';
import { Gutter } from '../Gutter';
import './index.scss';
import X from '../../icons/X';
const baseClass = 'drawer';
import './index.scss';
const baseClass = 'drawer';
const zBase = 100;
export const formatDrawerSlug = ({

View File

@@ -145,6 +145,7 @@ const EditMany: React.FC<Props> = (props) => {
<Form
className={`${baseClass}__form`}
onSuccess={onSuccess}
configFieldsSchema={selected}
>
<div className={`${baseClass}__main`}>
<div className={`${baseClass}__header`}>

View File

@@ -38,6 +38,11 @@ const getUseAsTitle = (collection: SanitizedCollectionConfig) => {
return topLevelFields.find((field) => fieldAffectsData(field) && field.name === useAsTitle);
};
/**
* The ListControls component is used to render the controls (search, filter, where)
* for a collection's list view. You can find those directly above the table which lists
* the collection's documents.
*/
const ListControls: React.FC<Props> = (props) => {
const {
collection,
@@ -105,6 +110,8 @@ const ListControls: React.FC<Props> = (props) => {
pillStyle="light"
className={`${baseClass}__toggle-columns ${visibleDrawer === 'columns' ? `${baseClass}__buttons-active` : ''}`}
onClick={() => setVisibleDrawer(visibleDrawer !== 'columns' ? 'columns' : undefined)}
aria-expanded={visibleDrawer === 'columns'}
aria-controls={`${baseClass}-columns`}
icon={<Chevron />}
>
{t('columns')}
@@ -114,6 +121,8 @@ const ListControls: React.FC<Props> = (props) => {
pillStyle="light"
className={`${baseClass}__toggle-where ${visibleDrawer === 'where' ? `${baseClass}__buttons-active` : ''}`}
onClick={() => setVisibleDrawer(visibleDrawer !== 'where' ? 'where' : undefined)}
aria-expanded={visibleDrawer === 'where'}
aria-controls={`${baseClass}-where`}
icon={<Chevron />}
>
{t('filters')}
@@ -123,6 +132,8 @@ const ListControls: React.FC<Props> = (props) => {
className={`${baseClass}__toggle-sort`}
buttonStyle={visibleDrawer === 'sort' ? undefined : 'secondary'}
onClick={() => setVisibleDrawer(visibleDrawer !== 'sort' ? 'sort' : undefined)}
aria-expanded={visibleDrawer === 'sort'}
aria-controls={`${baseClass}-sort`}
icon="chevron"
iconStyle="none"
>
@@ -136,6 +147,7 @@ const ListControls: React.FC<Props> = (props) => {
<AnimateHeight
className={`${baseClass}__columns`}
height={visibleDrawer === 'columns' ? 'auto' : 0}
id={`${baseClass}-columns`}
>
<ColumnSelector collection={collection} />
</AnimateHeight>
@@ -143,6 +155,7 @@ const ListControls: React.FC<Props> = (props) => {
<AnimateHeight
className={`${baseClass}__where`}
height={visibleDrawer === 'where' ? 'auto' : 0}
id={`${baseClass}-where`}
>
<WhereBuilder
collection={collection}
@@ -154,6 +167,7 @@ const ListControls: React.FC<Props> = (props) => {
<AnimateHeight
className={`${baseClass}__sort`}
height={visibleDrawer === 'sort' ? 'auto' : 0}
id={`${baseClass}-sort`}
>
<SortComplex
modifySearchQuery={modifySearchQuery}

View File

@@ -1,5 +1,6 @@
import React from 'react';
import { Link } from 'react-router-dom';
import { useTranslation } from 'react-i18next';
import { useConfig } from '../../utilities/Config';
import RenderCustomComponent from '../../utilities/RenderCustomComponent';
import LogOut from '../../icons/LogOut';
@@ -7,16 +8,21 @@ import LogOut from '../../icons/LogOut';
const baseClass = 'nav';
const DefaultLogout = () => {
const { t } = useTranslation('authentication');
const config = useConfig();
const {
routes: { admin },
admin: {
logoutRoute,
components: { logout }
}
components: { logout },
},
} = config;
return (
<Link to={`${admin}${logoutRoute}`} className={`${baseClass}__log-out`}>
<Link
to={`${admin}${logoutRoute}`}
className={`${baseClass}__log-out`}
aria-label={t('logOut')}
>
<LogOut />
</Link>
);

View File

@@ -24,7 +24,7 @@ const DefaultNav = () => {
const [menuActive, setMenuActive] = useState(false);
const [groups, setGroups] = useState<Group[]>([]);
const history = useHistory();
const { i18n } = useTranslation('general');
const { t, i18n } = useTranslation('general');
const {
collections,
globals,
@@ -81,6 +81,7 @@ const DefaultNav = () => {
<Link
to={admin}
className={`${baseClass}__brand`}
aria-label={t('dashboard')}
>
<Icon />
</Link>
@@ -141,6 +142,7 @@ const DefaultNav = () => {
<Link
to={`${admin}/account`}
className={`${baseClass}__account`}
aria-label={t('authentication:account')}
>
<Account />
</Link>

View File

@@ -45,6 +45,10 @@ const StaticPill: React.FC<Props> = (props) => {
children,
elementProps,
rounded,
'aria-label': ariaLabel,
'aria-expanded': ariaExpanded,
'aria-controls': ariaControls,
'aria-checked': ariaChecked,
} = props;
const classes = [
@@ -67,6 +71,10 @@ const StaticPill: React.FC<Props> = (props) => {
return (
<Element
{...elementProps}
aria-label={ariaLabel}
aria-expanded={ariaExpanded}
aria-controls={ariaControls}
aria-checked={ariaChecked}
className={classes}
type={Element === 'button' ? 'button' : undefined}
to={to || undefined}

View File

@@ -11,6 +11,10 @@ export type Props = {
draggable?: boolean,
rounded?: boolean
id?: string
'aria-label'?: string,
'aria-expanded'?: boolean,
'aria-controls'?: string,
'aria-checked'?: boolean,
elementProps?: HTMLAttributes<HTMLElement> & {
ref: React.RefCallback<HTMLElement>
}

View File

@@ -1,6 +1,7 @@
import React from 'react';
import { components as SelectComponents, MultiValueProps } from 'react-select';
import type { Option } from '../types';
import './index.scss';
const baseClass = 'multi-value-label';

View File

@@ -4,6 +4,7 @@ import { MultiValueRemoveProps } from 'react-select';
import X from '../../../icons/X';
import Tooltip from '../../Tooltip';
import { Option as OptionType } from '../types';
import './index.scss';
const baseClass = 'multi-value-remove';

View File

@@ -45,6 +45,7 @@ const SelectAdapter: React.FC<ReactSelectAdapterProps> = (props) => {
components,
isCreatable,
selectProps,
noOptionsMessage,
} = props;
const classes = [
@@ -72,6 +73,7 @@ const SelectAdapter: React.FC<ReactSelectAdapterProps> = (props) => {
filterOption={filterOption}
onMenuOpen={onMenuOpen}
menuPlacement="auto"
noOptionsMessage={noOptionsMessage}
components={{
ValueContainer,
SingleValue,
@@ -134,6 +136,7 @@ const SelectAdapter: React.FC<ReactSelectAdapterProps> = (props) => {
inputValue={inputValue}
onInputChange={(newValue) => setInputValue(newValue)}
onKeyDown={handleKeyDown}
noOptionsMessage={noOptionsMessage}
components={{
ValueContainer,
SingleValue,

View File

@@ -43,6 +43,7 @@ export type OptionGroup = {
}
export type Props = {
inputId?: string
className?: string
value?: Option | Option[],
onChange?: (value: any) => void, // eslint-disable-line @typescript-eslint/no-explicit-any
@@ -76,4 +77,5 @@ export type Props = {
*/
selectProps?: CustomSelectProps
backspaceRemovesValue?: boolean
noOptionsMessage?: (obj: { inputValue: string }) => string
}

View File

@@ -18,7 +18,7 @@ const SortColumn: React.FC<Props> = (props) => {
} = props;
const params = useSearchParams();
const history = useHistory();
const { i18n } = useTranslation();
const { t, i18n } = useTranslation('general');
const { sort } = params;
@@ -50,6 +50,7 @@ const SortColumn: React.FC<Props> = (props) => {
buttonStyle="none"
className={ascClasses.join(' ')}
onClick={() => setSort(asc)}
aria-label={t('sortByLabelDirection', { label: getTranslation(label, i18n), direction: t('ascending') })}
>
<Chevron />
</Button>
@@ -58,6 +59,7 @@ const SortColumn: React.FC<Props> = (props) => {
buttonStyle="none"
className={descClasses.join(' ')}
onClick={() => setSort(desc)}
aria-label={t('sortByLabelDirection', { label: getTranslation(label, i18n), direction: t('descending') })}
>
<Chevron />
</Button>

View File

@@ -66,11 +66,11 @@ const Status: React.FC = () => {
}
if (collection) {
url = `${serverURL}${api}/${collection.slug}/${id}?depth=0&locale=${locale}&fallback-locale=null`;
url = `${serverURL}${api}/${collection.slug}/${id}?locale=${locale}&fallback-locale=null`;
method = 'patch';
}
if (global) {
url = `${serverURL}${api}/globals/${global.slug}?depth=0&locale=${locale}&fallback-locale=null`;
url = `${serverURL}${api}/globals/${global.slug}?locale=${locale}&fallback-locale=null`;
method = 'post';
}

View File

@@ -2,6 +2,7 @@ import React from 'react';
import { useTranslation } from 'react-i18next';
import { Props, isComponent } from './types';
import { getTranslation } from '../../../../utilities/getTranslation';
import './index.scss';
const ViewDescription: React.FC<Props> = (props) => {

View File

@@ -41,7 +41,7 @@ const numeric = [
},
{
label: 'isGreaterThanOrEqualTo',
value: 'greater_than_equals',
value: 'greater_than_equal',
},
];
@@ -57,6 +57,16 @@ const geo = [
},
];
const within = {
label: 'within',
value: 'within',
};
const intersects = {
label: 'intersects',
value: 'intersects',
};
const like = {
label: 'isLike',
value: 'like',
@@ -86,7 +96,7 @@ const fieldTypeConditions = {
},
json: {
component: 'Text',
operators: [...base, like, contains],
operators: [...base, like, contains, within, intersects],
},
richText: {
component: 'Text',
@@ -102,7 +112,7 @@ const fieldTypeConditions = {
},
point: {
component: 'Point',
operators: [...geo],
operators: [...geo, within, intersects],
},
upload: {
component: 'Text',

View File

@@ -13,6 +13,7 @@ import { useSearchParams } from '../../utilities/SearchParams';
import validateWhereQuery from './validateWhereQuery';
import { Where } from '../../../../types';
import { getTranslation } from '../../../../utilities/getTranslation';
import { transformWhereQuery } from './transformWhereQuery';
import './index.scss';
@@ -43,6 +44,10 @@ const reduceFields = (fields, i18n) => flattenTopLevelFields(fields).reduce((red
return reduced;
}, []);
/**
* The WhereBuilder component is used to render the filter controls for a collection's list view.
* It is part of the {@link ListControls} component which is used to render the controls (search, filter, where).
*/
const WhereBuilder: React.FC<Props> = (props) => {
const {
collection,
@@ -59,16 +64,30 @@ const WhereBuilder: React.FC<Props> = (props) => {
const params = useSearchParams();
const { t, i18n } = useTranslation('general');
// This handles initializing the where conditions from the search query (URL). That way, if you pass in
// query params to the URL, the where conditions will be initialized from those and displayed in the UI.
// Example: /admin/collections/posts?where[or][0][and][0][text][equals]=example%20post
const [conditions, dispatchConditions] = useReducer(reducer, params.where, (whereFromSearch) => {
if (modifySearchQuery && validateWhereQuery(whereFromSearch)) {
return whereFromSearch.or;
}
if (modifySearchQuery && whereFromSearch) {
if (validateWhereQuery(whereFromSearch)) {
return whereFromSearch.or;
}
// Transform the where query to be in the right format. This will transform something simple like [text][equals]=example%20post to the right format
const transformedWhere = transformWhereQuery(whereFromSearch);
if (validateWhereQuery(transformedWhere)) {
return transformedWhere.or;
}
console.warn('Invalid where query in URL. Ignoring.');
}
return [];
});
const [reducedFields] = useState(() => reduceFields(collection.fields, i18n));
// This handles updating the search query (URL) when the where conditions change
useThrottledEffect(() => {
const currentParams = queryString.parse(history.location.search, { ignoreQueryPrefix: true, depth: 10 }) as { where: Where };
@@ -83,8 +102,11 @@ const WhereBuilder: React.FC<Props> = (props) => {
];
}, []) : [];
const hasNewWhereConditions = conditions.length > 0;
const newWhereQuery = {
...typeof currentParams?.where === 'object' ? currentParams.where : {},
...typeof currentParams?.where === 'object' && (validateWhereQuery(currentParams?.where) || !hasNewWhereConditions) ? currentParams.where : {},
or: [
...conditions,
...paramsToKeep,
@@ -94,7 +116,6 @@ const WhereBuilder: React.FC<Props> = (props) => {
if (handleChange) handleChange(newWhereQuery as Where);
const hasExistingConditions = typeof currentParams?.where === 'object' && 'or' in currentParams.where;
const hasNewWhereConditions = conditions.length > 0;
if (modifySearchQuery && ((hasExistingConditions && !hasNewWhereConditions) || hasNewWhereConditions)) {
history.replace({

View File

@@ -0,0 +1,51 @@
import type { Where } from '../../../../types';
/**
* Something like [or][0][and][0][text][equals]=example%20post will work and pass through the validateWhereQuery check.
* However, something like [text][equals]=example%20post will not work and will fail the validateWhereQuery check,
* even though it is a valid Where query. This needs to be transformed here.
*/
export const transformWhereQuery = (whereQuery): Where => {
if (!whereQuery) {
return {};
}
// Check if 'whereQuery' has 'or' field but no 'and'. This is the case for "correct" queries
if (whereQuery.or && !whereQuery.and) {
return {
or: whereQuery.or.map((query) => {
// ...but if the or query does not have an and, we need to add it
if(!query.and) {
return {
and: [query]
}
}
return query;
}),
};
}
// Check if 'whereQuery' has 'and' field but no 'or'.
if (whereQuery.and && !whereQuery.or) {
return {
or: [
{
and: whereQuery.and,
},
],
};
}
// Check if 'whereQuery' has neither 'or' nor 'and'.
if (!whereQuery.or && !whereQuery.and) {
return {
or: [
{
and: [whereQuery], // top-level siblings are considered 'and'
},
],
};
}
// If 'whereQuery' has 'or' and 'and', just return it as it is.
return whereQuery;
};

View File

@@ -1,8 +1,37 @@
import { Where } from '../../../../types';
import type { Operator, Where } from '../../../../types';
import { validOperators } from '../../../../types/constants';
const validateWhereQuery = (whereQuery): whereQuery is Where => {
if (whereQuery?.or?.length > 0 && whereQuery?.or?.[0]?.and && whereQuery?.or?.[0]?.and?.length > 0) {
return true;
// At this point we know that the whereQuery has 'or' and 'and' fields,
// now let's check the structure and content of these fields.
const isValid = whereQuery.or.every((orQuery) => {
if (orQuery.and && Array.isArray(orQuery.and)) {
return orQuery.and.every((andQuery) => {
if (typeof andQuery !== 'object') {
return false;
}
const andKeys = Object.keys(andQuery);
// If there are no keys, it's not a valid WhereField.
if (andKeys.length === 0) {
return false;
}
// eslint-disable-next-line no-restricted-syntax
for (const key of andKeys) {
const operator = Object.keys(andQuery[key])[0];
// Check if the key is a valid Operator.
if (!operator || !validOperators.includes(operator as Operator)) {
return false;
}
}
return true;
});
}
return false;
});
return isValid;
}
return false;

View File

@@ -111,7 +111,7 @@ export const addFieldStatePromise = async ({
acc.rowMetadata.push({
id: row.id,
collapsed: collapsedRowIDs === undefined ? field.admin.initCollapsed : collapsedRowIDs.includes(row.id),
collapsed: collapsedRowIDs === undefined ? Boolean(field?.admin?.initCollapsed) : collapsedRowIDs.includes(row.id),
childErrorPaths: new Set(),
});
@@ -191,7 +191,7 @@ export const addFieldStatePromise = async ({
acc.rowMetadata.push({
id: row.id,
collapsed: collapsedRowIDs === undefined ? field.admin.initCollapsed : collapsedRowIDs.includes(row.id),
collapsed: collapsedRowIDs === undefined ? Boolean(field?.admin?.initCollapsed) : collapsedRowIDs.includes(row.id),
blockType: row.blockType,
childErrorPaths: new Set(),
});
@@ -245,6 +245,54 @@ export const addFieldStatePromise = async ({
break;
}
case 'relationship': {
if (field.hasMany) {
const relationshipValue = Array.isArray(valueWithDefault) ? valueWithDefault.map((relationship) => {
if (Array.isArray(field.relationTo)) {
return {
relationTo: relationship.relationTo,
value: typeof relationship.value === 'string' ? relationship.value : relationship.value?.id,
};
}
if (typeof relationship === 'object' && relationship !== null) {
return relationship.id;
}
return relationship;
}) : undefined;
fieldState.value = relationshipValue;
fieldState.initialValue = relationshipValue;
} else if (Array.isArray(field.relationTo)) {
if (valueWithDefault && typeof valueWithDefault === 'object' && 'relationTo' in valueWithDefault && 'value' in valueWithDefault) {
const value = typeof valueWithDefault?.value === 'object' && 'id' in valueWithDefault.value ? valueWithDefault.value.id : valueWithDefault.value;
const relationshipValue = {
relationTo: valueWithDefault?.relationTo,
value,
};
fieldState.value = relationshipValue;
fieldState.initialValue = relationshipValue;
}
} else {
const relationshipValue = valueWithDefault && typeof valueWithDefault === 'object' && 'id' in valueWithDefault ? valueWithDefault.id : valueWithDefault;
fieldState.value = relationshipValue;
fieldState.initialValue = relationshipValue;
}
state[`${path}${field.name}`] = fieldState;
break;
}
case 'upload': {
const relationshipValue = valueWithDefault && typeof valueWithDefault === 'object' && 'id' in valueWithDefault ? valueWithDefault.id : valueWithDefault;
fieldState.value = relationshipValue;
fieldState.initialValue = relationshipValue;
state[`${path}${field.name}`] = fieldState;
break;
}
default: {
fieldState.value = valueWithDefault;
fieldState.initialValue = valueWithDefault;

View File

@@ -48,6 +48,7 @@ const Form: React.FC<Props> = (props) => {
initialState, // fully formed initial field state
initialData, // values only, paths are required as key - form should build initial state as convenience
waitForAutocomplete,
configFieldsSchema,
} = props;
const history = useHistory();
@@ -409,12 +410,14 @@ const Form: React.FC<Props> = (props) => {
path: string,
blockType?: string
}) => {
const rowConfig = traverseRowConfigs({ path, fieldConfig: collection?.fields || global?.fields });
if (!configFieldsSchema) return null;
const rowConfig = traverseRowConfigs({ path, fieldConfig: configFieldsSchema });
const rowFieldConfigs = buildFieldSchemaMap(rowConfig);
const pathSegments = splitPathByArrayFields(path);
const fieldKey = pathSegments.at(-1);
return rowFieldConfigs.get(blockType ? `${fieldKey}.${blockType}` : fieldKey);
}, [traverseRowConfigs, collection?.fields, global?.fields]);
}, [traverseRowConfigs, configFieldsSchema]);
// Array/Block row manipulation
const addFieldRow: Context['addFieldRow'] = useCallback(async ({ path, rowIndex, data }) => {

View File

@@ -49,6 +49,7 @@ export type Props = {
validationOperation?: 'create' | 'update'
children?: React.ReactNode
action?: string
configFieldsSchema?: FieldConfig[]
}
export type SubmitOptions = {

View File

@@ -1,62 +1,74 @@
import React from 'react';
import Check from '../../../icons/Check';
import Label from '../../Label';
import Line from '../../../icons/Line';
import './index.scss';
const baseClass = 'custom-checkbox';
type CheckboxInputProps = {
onToggle: React.MouseEventHandler<HTMLButtonElement>
onToggle: React.FormEventHandler<HTMLInputElement>
inputRef?: React.MutableRefObject<HTMLInputElement>
readOnly?: boolean
checked?: boolean
partialChecked?: boolean
name?: string
id?: string
label?: string
'aria-label'?: string
required?: boolean
}
export const CheckboxInput: React.FC<CheckboxInputProps> = (props) => {
const {
onToggle,
checked,
partialChecked,
inputRef,
name,
id,
label,
'aria-label': ariaLabel,
readOnly,
required,
} = props;
return (
<span
<div
className={[
baseClass,
checked && `${baseClass}--checked`,
(checked || partialChecked) && `${baseClass}--checked`,
readOnly && `${baseClass}--read-only`,
].filter(Boolean).join(' ')}
>
<input
ref={inputRef}
id={id}
type="checkbox"
name={name}
checked={checked}
readOnly
/>
<button
type="button"
onClick={onToggle}
>
<span className={`${baseClass}__input`}>
<Check />
<div className={`${baseClass}__input`}>
<input
ref={inputRef}
id={id}
type="checkbox"
name={name}
aria-label={ariaLabel}
defaultChecked={Boolean(checked)}
disabled={readOnly}
onInput={onToggle}
/>
<span className={`${baseClass}__icon ${!partialChecked ? 'check' : 'partial'}`}>
{!partialChecked && (
<Check />
)}
{partialChecked && (
<Line />
)}
</span>
</div>
{label && (
<Label
htmlFor={id}
label={label}
required={required}
/>
</button>
</span>
)}
</div>
);
};

View File

@@ -4,10 +4,6 @@
position: relative;
margin-bottom: $baseline;
input[type=checkbox] {
display: none;
}
.tooltip:not([aria-hidden="true"]) {
right: auto;
position: relative;
@@ -22,32 +18,84 @@
.custom-checkbox {
display: inline-flex;
label {
padding-bottom: 0;
}
input {
// hidden HTML checkbox
position: absolute;
top: 0;
left: 0;
opacity: 0;
padding-left: base(.5);
}
&__input {
// visible checkbox
@include formInput;
display: flex;
padding: 0;
line-height: 0;
position: relative;
width: $baseline;
height: $baseline;
margin-right: base(.5);
& input[type="checkbox"] {
position: absolute;
// Without the extra 4px, there is an uncheckable area due to the border of the parent element
width: calc(100% + 4px);
height: calc(100% + 4px);
padding: 0;
margin: 0;
margin-left: -2px;
margin-top: -2px;
opacity: 0;
border-radius: 0;
z-index: 1;
cursor: pointer;
}
}
&__icon {
position: absolute;
svg {
opacity: 0;
}
}
&:not(&--read-only) {
&:active,
&:focus-within,
&:focus {
.custom-checkbox__input, & input[type="checkbox"] {
@include inputShadowActive;
outline: 0;
box-shadow: 0 0 3px 3px var(--theme-success-400)!important;
border: 1px solid var(--theme-elevation-150);
}
}
&:hover {
.custom-checkbox__input, & input[type="checkbox"] {
border-color: var(--theme-elevation-250);
}
}
}
&:not(&--read-only):not(&--checked) {
&:hover {
cursor: pointer;
svg {
opacity: 0.2;
}
}
}
&--checked {
.custom-checkbox__icon {
svg {
opacity: 1;
}
}
}
&--read-only {
.custom-checkbox__input {
@@ -58,40 +106,6 @@
color: var(--theme-elevation-400);
}
}
button {
@extend %btn-reset;
display: flex;
align-items: center;
cursor: pointer;
&:focus,
&:active {
outline: none;
}
&:focus {
.custom-checkbox__input {
box-shadow: 0 0 3px 3px var(--theme-success-400);
}
}
&:hover {
svg {
opacity: .2;
}
}
}
&--checked {
button {
.custom-checkbox__input {
svg {
opacity: 1;
}
}
}
}
}
html[data-theme=light] {

View File

@@ -88,6 +88,7 @@ const Checkbox: React.FC<Props> = (props) => {
label={getTranslation(label || name, i18n)}
name={path}
checked={Boolean(value)}
readOnly={readOnly}
/>
<FieldDescription
value={value}

View File

@@ -10,9 +10,9 @@ import { Props } from './types';
import { getTranslation } from '../../../../../utilities/getTranslation';
import { Option } from '../../../elements/ReactSelect/types';
import ReactSelect from '../../../elements/ReactSelect';
import { isNumber } from '../../../../../utilities/isNumber';
import './index.scss';
import { isNumber } from '../../../../../utilities/isNumber';
const NumberField: React.FC<Props> = (props) => {
const {
@@ -143,9 +143,17 @@ const NumberField: React.FC<Props> = (props) => {
isMulti
isSortable
isClearable
noOptionsMessage={({ inputValue }) => {
const isOverHasMany = Array.isArray(value) && value.length >= maxRows;
if (isOverHasMany) {
return t('validation:limitReached', { value: value.length + 1, max: maxRows });
}
return t('general:noOptions');
}}
filterOption={(option, rawInput) => {
// eslint-disable-next-line no-restricted-globals
return isNumber(rawInput)
const isOverHasMany = Array.isArray(value) && value.length >= maxRows;
return isNumber(rawInput) && !isOverHasMany;
}}
numberOnly
/>

View File

@@ -6,6 +6,7 @@ import Tooltip from '../../../../../elements/Tooltip';
import Edit from '../../../../../icons/Edit';
import { useAuth } from '../../../../../utilities/Auth';
import { Option } from '../../types';
import './index.scss';
const baseClass = 'relationship--multi-value-label';

View File

@@ -6,11 +6,11 @@ import FormSubmit from '../../../../../Submit';
import { Props } from './types';
import fieldTypes from '../../../..';
import RenderFields from '../../../../../RenderFields';
import './index.scss';
import useHotkey from '../../../../../../../hooks/useHotkey';
import { useEditDepth } from '../../../../../../utilities/EditDepth';
import './index.scss';
const baseClass = 'rich-text-link-edit-modal';
export const LinkDrawer: React.FC<Props> = ({
@@ -30,6 +30,7 @@ export const LinkDrawer: React.FC<Props> = ({
<Form
onSubmit={handleModalSubmit}
initialState={initialState}
configFieldsSchema={fieldSchema}
>
<RenderFields
fieldTypes={fieldTypes}

View File

@@ -71,6 +71,7 @@ export const UploadDrawer: React.FC<ElementProps & {
<Form
onSubmit={handleUpdateEditData}
initialState={initialState}
configFieldsSchema={fieldSchema}
>
<RenderFields
readOnly={false}

View File

@@ -1,5 +1,4 @@
import React, { createContext, useCallback, useContext, useEffect, useState } from 'react';
import jwtDecode from 'jwt-decode';
import { useHistory, useLocation } from 'react-router-dom';
import { useModal } from '@faceless-ui/modal';
import { useTranslation } from 'react-i18next';
@@ -17,6 +16,7 @@ const maxTimeoutTime = 2147483647;
export const AuthProvider: React.FC<{ children: React.ReactNode }> = ({ children }) => {
const [user, setUser] = useState<User | null>();
const [tokenInMemory, setTokenInMemory] = useState<string>();
const [tokenExpiration, setTokenExpiration] = useState<number>();
const { pathname } = useLocation();
const { push } = useHistory();
@@ -35,7 +35,7 @@ export const AuthProvider: React.FC<{ children: React.ReactNode }> = ({ children
},
} = config;
const exp = user?.exp;
const exp = tokenExpiration;
const [permissions, setPermissions] = useState<Permissions>();
@@ -56,9 +56,24 @@ export const AuthProvider: React.FC<{ children: React.ReactNode }> = ({ children
closeAllModals();
}, [push, admin, logoutInactivityRoute, closeAllModals]);
const revokeTokenAndExpire = useCallback(() => {
setTokenInMemory(undefined);
setTokenExpiration(undefined);
}, []);
const setTokenAndExpiration = useCallback((json) => {
const token = json?.token || json?.refreshedToken;
if (token && json?.exp) {
setTokenInMemory(token);
setTokenExpiration(json.exp);
} else {
revokeTokenAndExpire();
}
}, [revokeTokenAndExpire]);
const refreshCookie = useCallback((forceRefresh?: boolean) => {
const now = Math.round((new Date()).getTime() / 1000);
const remainingTime = (exp as number || 0) - now;
const remainingTime = (typeof exp === 'number' ? exp : 0) - now;
if (forceRefresh || (exp && remainingTime < 120)) {
setTimeout(async () => {
@@ -72,6 +87,7 @@ export const AuthProvider: React.FC<{ children: React.ReactNode }> = ({ children
if (request.status === 200) {
const json = await request.json();
setUser(json.user);
setTokenAndExpiration(json);
} else {
setUser(null);
redirectToInactivityRoute();
@@ -81,7 +97,7 @@ export const AuthProvider: React.FC<{ children: React.ReactNode }> = ({ children
}
}, 1000);
}
}, [exp, serverURL, api, userSlug, i18n, redirectToInactivityRoute]);
}, [serverURL, api, userSlug, i18n, exp, redirectToInactivityRoute, setTokenAndExpiration]);
const refreshCookieAsync = useCallback(async (skipSetUser?: boolean): Promise<User> => {
try {
@@ -93,7 +109,10 @@ export const AuthProvider: React.FC<{ children: React.ReactNode }> = ({ children
if (request.status === 200) {
const json = await request.json();
if (!skipSetUser) setUser(json.user);
if (!skipSetUser) {
setUser(json.user);
setTokenAndExpiration(json);
}
return json.user;
}
@@ -104,19 +123,13 @@ export const AuthProvider: React.FC<{ children: React.ReactNode }> = ({ children
toast.error(`Refreshing token failed: ${e.message}`);
return null;
}
}, [serverURL, api, userSlug, i18n, redirectToInactivityRoute]);
const setToken = useCallback((token: string) => {
const decoded = jwtDecode<User>(token);
setUser(decoded);
setTokenInMemory(token);
}, []);
}, [serverURL, api, userSlug, i18n, redirectToInactivityRoute, setTokenAndExpiration]);
const logOut = useCallback(() => {
setUser(null);
setTokenInMemory(undefined);
revokeTokenAndExpire();
requests.post(`${serverURL}${api}/${userSlug}/logout`);
}, [serverURL, api, userSlug]);
}, [serverURL, api, userSlug, revokeTokenAndExpire]);
const refreshPermissions = useCallback(async () => {
try {
@@ -137,56 +150,59 @@ export const AuthProvider: React.FC<{ children: React.ReactNode }> = ({ children
}
}, [serverURL, api, i18n]);
// On mount, get user and set
useEffect(() => {
const fetchMe = async () => {
try {
const request = await requests.get(`${serverURL}${api}/${userSlug}/me`, {
headers: {
'Accept-Language': i18n.language,
},
});
const fetchFullUser = React.useCallback(async () => {
try {
const request = await requests.get(`${serverURL}${api}/${userSlug}/me`, {
headers: {
'Accept-Language': i18n.language,
},
});
if (request.status === 200) {
const json = await request.json();
if (request.status === 200) {
const json = await request.json();
if (json?.user) {
setUser(json.user);
} else if (json?.token) {
setToken(json.token);
} else if (autoLogin && autoLogin.prefillOnly !== true) {
// auto log-in with the provided autoLogin credentials. This is used in dev mode
// so you don't have to log in over and over again
const autoLoginResult = await requests.post(`${serverURL}${api}/${userSlug}/login`, {
body: JSON.stringify({
email: autoLogin.email,
password: autoLogin.password,
}),
headers: {
'Accept-Language': i18n.language,
'Content-Type': 'application/json',
},
});
if (autoLoginResult.status === 200) {
const autoLoginJson = await autoLoginResult.json();
setUser(autoLoginJson.user);
if (autoLoginJson?.token) {
setToken(autoLoginJson.token);
}
} else {
setUser(null);
if (json?.user) {
setUser(json.user);
if (json?.token) {
setTokenAndExpiration(json);
}
} else if (autoLogin && autoLogin.prefillOnly !== true) {
// auto log-in with the provided autoLogin credentials. This is used in dev mode
// so you don't have to log in over and over again
const autoLoginResult = await requests.post(`${serverURL}${api}/${userSlug}/login`, {
body: JSON.stringify({
email: autoLogin.email,
password: autoLogin.password,
}),
headers: {
'Accept-Language': i18n.language,
'Content-Type': 'application/json',
},
});
if (autoLoginResult.status === 200) {
const autoLoginJson = await autoLoginResult.json();
setUser(autoLoginJson.user);
if (autoLoginJson?.token) {
setTokenAndExpiration(autoLoginJson);
}
} else {
setUser(null);
revokeTokenAndExpire();
}
} else {
setUser(null);
revokeTokenAndExpire();
}
} catch (e) {
toast.error(`Fetching user failed: ${e.message}`);
}
};
} catch (e) {
toast.error(`Fetching user failed: ${e.message}`);
}
}, [serverURL, api, userSlug, i18n, autoLogin, setTokenAndExpiration, revokeTokenAndExpire]);
fetchMe();
}, [i18n, setToken, api, serverURL, userSlug, autoLogin]);
// On mount, get user and set
useEffect(() => {
fetchFullUser();
}, [fetchFullUser]);
// When location changes, refresh cookie
useEffect(() => {
@@ -209,12 +225,12 @@ export const AuthProvider: React.FC<{ children: React.ReactNode }> = ({ children
useEffect(() => {
let reminder: ReturnType<typeof setTimeout>;
const now = Math.round((new Date()).getTime() / 1000);
const remainingTime = exp as number - now;
const remainingTime = typeof exp === 'number' ? exp - now : 0;
if (remainingTime > 0) {
reminder = setTimeout(() => {
openModal('stay-logged-in');
}, (Math.min((remainingTime - 60) * 1000), maxTimeoutTime));
}, Math.max(Math.min((remainingTime - 60) * 1000, maxTimeoutTime)));
}
return () => {
@@ -225,19 +241,20 @@ export const AuthProvider: React.FC<{ children: React.ReactNode }> = ({ children
useEffect(() => {
let forceLogOut: ReturnType<typeof setTimeout>;
const now = Math.round((new Date()).getTime() / 1000);
const remainingTime = exp as number - now;
const remainingTime = typeof exp === 'number' ? exp - now : 0;
if (remainingTime > 0) {
forceLogOut = setTimeout(() => {
setUser(null);
revokeTokenAndExpire();
redirectToInactivityRoute();
}, Math.min(remainingTime * 1000, maxTimeoutTime));
}, Math.max(Math.min(remainingTime * 1000, maxTimeoutTime), 0));
}
return () => {
if (forceLogOut) clearTimeout(forceLogOut);
};
}, [exp, closeAllModals, i18n, redirectToInactivityRoute]);
}, [exp, closeAllModals, i18n, redirectToInactivityRoute, revokeTokenAndExpire]);
return (
<Context.Provider value={{
@@ -248,8 +265,8 @@ export const AuthProvider: React.FC<{ children: React.ReactNode }> = ({ children
refreshCookieAsync,
refreshPermissions,
permissions,
setToken,
token: tokenInMemory,
fetchFullUser,
}}
>
{children}

View File

@@ -6,8 +6,8 @@ export type AuthContext<T = User> = {
logOut: () => void
refreshCookie: (forceRefresh?: boolean) => void
refreshCookieAsync: () => Promise<User>
setToken: (token: string) => void
token?: string
refreshPermissions: () => Promise<void>
permissions?: Permissions
fetchFullUser: () => Promise<void>
}

View File

@@ -88,6 +88,7 @@ const DefaultAccount: React.FC<Props> = (props) => {
onSuccess={onSave}
initialState={initialState}
disabled={!hasSavePermission}
configFieldsSchema={fields}
>
<div className={`${baseClass}__main`}>
<Meta
@@ -130,9 +131,11 @@ const DefaultAccount: React.FC<Props> = (props) => {
<h3>{t('general:payloadSettings')}</h3>
<div className={`${baseClass}__language`}>
<Label
htmlFor="language-select"
label={t('general:language')}
/>
<ReactSelect
inputId="language-select"
value={languageOptions.find((language) => (language.value === i18n.language))}
options={languageOptions}
onChange={({ value }) => (i18n.changeLanguage(value))}

View File

@@ -59,7 +59,7 @@ const AccountView: React.FC = () => {
const dataToRender = locationState?.data || data;
const apiURL = `${serverURL}${api}/${slug}/${data?.id}?locale=${locale}`;
const action = `${serverURL}${api}/${slug}/${data?.id}?locale=${locale}&depth=0`;
const action = `${serverURL}${api}/${slug}/${data?.id}?locale=${locale}`;
const onSave = React.useCallback(async (json: any) => {
getDocPermissions();

View File

@@ -17,7 +17,7 @@ const baseClass = 'create-first-user';
const CreateFirstUser: React.FC<Props> = (props) => {
const { setInitialized } = props;
const { setToken } = useAuth();
const { fetchFullUser } = useAuth();
const {
admin: { user: userSlug }, collections, serverURL, routes: { admin, api },
} = useConfig();
@@ -25,9 +25,9 @@ const CreateFirstUser: React.FC<Props> = (props) => {
const userConfig = collections.find((collection) => collection.slug === userSlug);
const onSuccess = (json) => {
const onSuccess = async (json) => {
if (json?.user?.token) {
setToken(json.user.token);
await fetchFullUser();
}
setInitialized(true);
@@ -52,6 +52,11 @@ const CreateFirstUser: React.FC<Props> = (props) => {
},
] as Field[];
const fieldSchema = [
...fields,
...userConfig.fields,
];
return (
<MinimalTemplate className={baseClass}>
<h1>{t('general:welcome')}</h1>
@@ -67,12 +72,10 @@ const CreateFirstUser: React.FC<Props> = (props) => {
redirect={admin}
action={`${serverURL}${api}/${userSlug}/first-register`}
validationOperation="create"
configFieldsSchema={fieldSchema}
>
<RenderFields
fieldSchema={[
...fields,
...userConfig.fields,
]}
fieldSchema={fieldSchema}
fieldTypes={fieldTypes}
/>
<FormSubmit>{t('general:create')}</FormSubmit>

View File

@@ -24,7 +24,7 @@ const Dashboard: React.FC<Props> = (props) => {
} = props;
const { push } = useHistory();
const { i18n } = useTranslation('general');
const { t, i18n } = useTranslation('general');
const {
routes: {
@@ -77,12 +77,14 @@ const Dashboard: React.FC<Props> = (props) => {
<ul className={`${baseClass}__card-list`}>
{entities.map(({ entity, type }, entityIndex) => {
let title: string;
let buttonAriaLabel: string;
let createHREF: string;
let onClick: () => void;
let hasCreatePermission: boolean;
if (type === EntityType.collection) {
title = getTranslation(entity.labels.plural, i18n);
buttonAriaLabel = t('showAllLabel', { label: title });
onClick = () => push({ pathname: `${admin}/collections/${entity.slug}` });
createHREF = `${admin}/collections/${entity.slug}/create`;
hasCreatePermission = permissions?.collections?.[entity.slug]?.create?.permission;
@@ -90,6 +92,7 @@ const Dashboard: React.FC<Props> = (props) => {
if (type === EntityType.global) {
title = getTranslation(entity.label, i18n);
buttonAriaLabel = t('editLabel', { label: getTranslation(entity.label, i18n) });
onClick = () => push({ pathname: `${admin}/globals/${entity.slug}` });
}
@@ -97,8 +100,10 @@ const Dashboard: React.FC<Props> = (props) => {
<li key={entityIndex}>
<Card
title={title}
titleAs="h3"
id={`card-${entity.slug}`}
onClick={onClick}
buttonAriaLabel={buttonAriaLabel}
actions={(hasCreatePermission && type === EntityType.collection) ? (
<Button
el="link"
@@ -107,6 +112,7 @@ const Dashboard: React.FC<Props> = (props) => {
round
buttonStyle="icon-label"
iconStyle="with-border"
aria-label={t('createNewLabel', { label: getTranslation(entity.labels.singular, i18n) })}
/>
) : undefined}
/>

View File

@@ -11,7 +11,6 @@ import FormSubmit from '../../forms/Submit';
import Button from '../../elements/Button';
import Meta from '../../utilities/Meta';
import './index.scss';
const baseClass = 'forgot-password';

View File

@@ -60,6 +60,7 @@ const DefaultGlobalView: React.FC<Props> = (props) => {
onSuccess={onSave}
disabled={!hasSavePermission}
initialState={initialState}
configFieldsSchema={fields}
>
<FormLoadingOverlayToggle
action="update"

View File

@@ -96,7 +96,7 @@ const GlobalView: React.FC<IndexProps> = (props) => {
global,
onSave,
apiURL: `${serverURL}${api}/globals/${slug}?locale=${locale}${global.versions?.drafts ? '&draft=true' : ''}`,
action: `${serverURL}${api}/globals/${slug}?locale=${locale}&depth=0&fallback-locale=null`,
action: `${serverURL}${api}/globals/${slug}?locale=${locale}&fallback-locale=null`,
updatedAt: updatedAt || dataToRender?.updatedAt,
}}
/>

View File

@@ -20,7 +20,7 @@ const baseClass = 'login';
const Login: React.FC = () => {
const history = useHistory();
const { t } = useTranslation('authentication');
const { user, setToken } = useAuth();
const { user, fetchFullUser } = useAuth();
const config = useConfig();
const {
admin: {
@@ -47,9 +47,9 @@ const Login: React.FC = () => {
const redirect = query.get('redirect');
const onSuccess = (data) => {
const onSuccess = async (data) => {
if (data.token) {
setToken(data.token);
await fetchFullUser();
// Ensure the redirect always starts with the admin route, and concatenate the redirect path
history.push(admin + (redirect || ''));

View File

@@ -13,7 +13,6 @@ import Button from '../../elements/Button';
import Meta from '../../utilities/Meta';
import HiddenInput from '../../forms/field-types/HiddenInput';
import './index.scss';
const baseClass = 'reset-password';
@@ -23,12 +22,12 @@ const ResetPassword: React.FC = () => {
const { admin: { user: userSlug, logoutRoute }, serverURL, routes: { admin, api } } = config;
const { token } = useParams<{ token?: string }>();
const history = useHistory();
const { user, setToken } = useAuth();
const { user, fetchFullUser } = useAuth();
const { t } = useTranslation('authentication');
const onSuccess = (data) => {
const onSuccess = async (data) => {
if (data.token) {
setToken(data.token);
await fetchFullUser();
history.push(`${admin}`);
} else {
history.push(`${admin}/login`);

View File

@@ -106,6 +106,7 @@ const DefaultEditView: React.FC<Props> = (props) => {
onSuccess={onSave}
disabled={!hasSavePermission}
initialState={internalState}
configFieldsSchema={fields}
>
<FormLoadingOverlayToggle
formIsLoading={isLoading}

View File

@@ -110,7 +110,7 @@ const EditView: React.FC<IndexProps> = (props) => {
}
const apiURL = `${serverURL}${api}/${slug}/${id}?locale=${locale}${collection.versions.drafts ? '&draft=true' : ''}`;
const action = `${serverURL}${api}/${slug}${isEditing ? `/${id}` : ''}?locale=${locale}&depth=0&fallback-locale=null`;
const action = `${serverURL}${api}/${slug}${isEditing ? `/${id}` : ''}?locale=${locale}&fallback-locale=null`;
const hasSavePermission = (isEditing && docPermissions?.update?.permission) || (!isEditing && (docPermissions as CollectionPermission)?.create?.permission);
const isLoading = !internalState || !docPermissions || isLoadingData;

View File

@@ -100,7 +100,10 @@ const DefaultList: React.FC<Props> = (props) => {
{getTranslation(pluralLabel, i18n)}
</h1>
{hasCreatePermission && (
<Pill to={newDocumentURL}>
<Pill
to={newDocumentURL}
aria-label={t('createNewLabel', { label: getTranslation(singularLabel, i18n) })}
>
{t('createNew')}
</Pill>
)}

View File

@@ -1,34 +0,0 @@
@import '../../../../../scss/styles.scss';
.select-all {
button {
@extend %btn-reset;
display: flex;
align-items: center;
cursor: pointer;
&:focus:not(:focus-visible),
&:active {
outline: none;
}
&:hover {
svg {
opacity: .2;
}
}
&:focus-visible {
outline-offset: var(--accessibility-outline-offset);
}
}
&__input {
@include formInput;
padding: 0;
line-height: 0;
position: relative;
width: $baseline;
height: $baseline;
}
}

View File

@@ -1,31 +1,22 @@
import React from 'react';
import { useTranslation } from 'react-i18next';
import { SelectAllStatus, useSelection } from '../SelectionProvider';
import Check from '../../../../icons/Check';
import Line from '../../../../icons/Line';
import './index.scss';
const baseClass = 'select-all';
import { CheckboxInput } from '../../../../forms/field-types/Checkbox/Input';
const SelectAll: React.FC = () => {
const { t } = useTranslation('general');
const { selectAll, toggleAll } = useSelection();
return (
<div className={baseClass}>
<button
type="button"
onClick={() => toggleAll()}
>
<span className={`${baseClass}__input`}>
{ (selectAll === SelectAllStatus.AllInPage || selectAll === SelectAllStatus.AllAvailable) && (
<Check />
)}
{ selectAll === SelectAllStatus.Some && (
<Line />
)}
</span>
</button>
</div>
<CheckboxInput
id="select-all"
aria-label={selectAll === SelectAllStatus.None ? t('selectAllRows') : t('deselectAllRows')}
checked={selectAll === SelectAllStatus.AllInPage || selectAll === SelectAllStatus.AllAvailable}
partialChecked={selectAll === SelectAllStatus.Some}
onToggle={() => toggleAll()}
/>
);
};

View File

@@ -1,31 +1,17 @@
import React from 'react';
import { useSelection } from '../SelectionProvider';
import Check from '../../../../icons/Check';
import { CheckboxInput } from '../../../../forms/field-types/Checkbox/Input';
import './index.scss';
const baseClass = 'select-row';
const SelectRow: React.FC<{ id: string | number }> = ({ id }) => {
const { selected, setSelection } = useSelection();
return (
<div
className={[
baseClass,
(selected[id]) && `${baseClass}--checked`,
].filter(Boolean).join(' ')}
key={id}
>
<button
type="button"
onClick={() => setSelection(id)}
>
<span className={`${baseClass}__input`}>
<Check />
</span>
</button>
</div>
<CheckboxInput
checked={selected[id]}
onToggle={() => setSelection(id)}
/>
);
};

View File

@@ -16,6 +16,12 @@ import { useSearchParams } from '../../../utilities/SearchParams';
import { TableColumnsProvider } from '../../../elements/TableColumns';
import type { Field } from '../../../../../fields/config/types';
/**
* The ListView component is table which lists the collection's documents.
* The default list view can be found at the {@link DefaultList} component.
* Users can also create pass their own custom list view component instead
* of using the default one.
*/
const ListView: React.FC<ListIndexProps> = (props) => {
const {
collection,

View File

@@ -177,8 +177,9 @@ html[data-theme=dark] {
--theme-elevation-250: var(--color-base-650);
--theme-elevation-300: var(--color-base-600);
--theme-elevation-350: var(--color-base-550);
--theme-elevation-400: var(--color-base-450);
--theme-elevation-450: var(--color-base-400);
--theme-elevation-400: var(--color-base-500);
--theme-elevation-450: var(--color-base-450);
--theme-elevation-500: var(--color-base-400);
--theme-elevation-550: var(--color-base-350);
--theme-elevation-600: var(--color-base-300);
--theme-elevation-650: var(--color-base-250);

View File

@@ -3,6 +3,7 @@ import { Document } from 'mongoose';
import { APIError } from '../../errors';
import { PayloadRequest } from '../../express/types';
import { Collection } from '../../collections/config/types';
import { buildAfterOperation } from '../../collections/operations/utils';
export type Arguments = {
collection: Collection
@@ -128,6 +129,16 @@ async function forgotPassword(incomingArgs: Arguments): Promise<string | null> {
await hook({ args, context: req.context });
}, Promise.resolve());
// /////////////////////////////////////
// afterOperation - Collection
// /////////////////////////////////////
token = await buildAfterOperation({
operation: 'forgotPassword',
args,
result: token,
});
return token;
}

View File

@@ -10,6 +10,7 @@ import { User } from '../types';
import { Collection } from '../../collections/config/types';
import { afterRead } from '../../fields/hooks/afterRead';
import unlock from './unlock';
import { buildAfterOperation } from '../../collections/operations/utils';
import { incrementLoginAttempts } from '../strategies/local/incrementLoginAttempts';
import { authenticateLocalStrategy } from '../strategies/local/authenticate';
import { getFieldsToSign } from './getFieldsToSign';
@@ -206,15 +207,28 @@ async function login<TSlug extends keyof GeneratedTypes['collections']>(
}) || user;
}, Promise.resolve());
// /////////////////////////////////////
// Return results
// /////////////////////////////////////
return {
let result: Result & { user: GeneratedTypes['collections'][TSlug] } = {
token,
user,
exp: (jwt.decode(token) as jwt.JwtPayload).exp,
};
// /////////////////////////////////////
// afterOperation - Collection
// /////////////////////////////////////
result = await buildAfterOperation<GeneratedTypes['collections'][TSlug]>({
operation: 'login',
args,
result,
});
// /////////////////////////////////////
// Return results
// /////////////////////////////////////
return result;
}
export default login;

View File

@@ -1,11 +1,12 @@
import url from 'url';
import jwt from 'jsonwebtoken';
import { Response } from 'express';
import url from 'url';
import { Collection, BeforeOperationHook } from '../../collections/config/types';
import { Forbidden } from '../../errors';
import getCookieExpiration from '../../utilities/getCookieExpiration';
import { Document } from '../../types';
import { PayloadRequest } from '../../express/types';
import { buildAfterOperation } from '../../collections/operations/utils';
import { getFieldsToSign } from './getFieldsToSign';
export type Result = {
@@ -97,7 +98,7 @@ async function refresh(incomingArgs: Arguments): Promise<Result> {
args.res.cookie(`${config.cookiePrefix}-token`, refreshedToken, cookieOptions);
}
let response: Result = {
let result: Result = {
user,
refreshedToken,
exp,
@@ -110,20 +111,31 @@ async function refresh(incomingArgs: Arguments): Promise<Result> {
await collectionConfig.hooks.afterRefresh.reduce(async (priorHook, hook) => {
await priorHook;
response = (await hook({
result = (await hook({
req: args.req,
res: args.res,
exp,
token: refreshedToken,
context: args.req.context,
})) || response;
})) || result;
}, Promise.resolve());
// /////////////////////////////////////
// afterOperation - Collection
// /////////////////////////////////////
result = await buildAfterOperation({
operation: 'refresh',
args,
result,
});
// /////////////////////////////////////
// Return results
// /////////////////////////////////////
return response;
return result;
}
export default refresh;

View File

@@ -16,7 +16,7 @@ const swcOptions = {
tsx: true,
},
paths: undefined,
baseUrl: __dirname,
baseUrl: path.resolve(),
},
module: {
type: 'commonjs',

View File

@@ -88,6 +88,5 @@ export const getBaseConfig = (payloadConfig: SanitizedConfig): Configuration =>
template: payloadConfig.admin.indexHTML,
filename: path.normalize('./index.html'),
}),
new webpack.HotModuleReplacementPlugin(),
],
});

View File

@@ -29,6 +29,7 @@ export const defaults = {
afterRead: [],
beforeDelete: [],
afterDelete: [],
afterOperation: [],
beforeLogin: [],
afterLogin: [],
afterLogout: [],

View File

@@ -98,6 +98,7 @@ const collectionSchema = joi.object().keys({
afterRead: joi.array().items(joi.func()),
beforeDelete: joi.array().items(joi.func()),
afterDelete: joi.array().items(joi.func()),
afterOperation: joi.array().items(joi.func()),
beforeLogin: joi.array().items(joi.func()),
afterLogin: joi.array().items(joi.func()),
afterLogout: joi.array().items(joi.func()),

View File

@@ -12,6 +12,7 @@ import { IncomingUploadType, Upload } from '../../uploads/types';
import { IncomingCollectionVersions, SanitizedCollectionVersions } from '../../versions/types';
import { BuildQueryArgs } from '../../mongoose/buildQuery';
import { CustomPreviewButtonProps, CustomPublishButtonProps, CustomSaveButtonProps, CustomSaveDraftButtonProps } from '../../admin/components/elements/types';
import { AfterOperationArg, AfterOperationMap } from '../operations/utils';
import type { Props as ListProps } from '../../admin/components/views/collections/List/types';
import type { Props as EditProps } from '../../admin/components/views/collections/Edit/types';
@@ -123,6 +124,13 @@ export type AfterDeleteHook<T extends TypeWithID = any> = (args: {
context: RequestContext;
}) => any;
export type AfterOperationHook<
T extends TypeWithID = any,
> = (
arg: AfterOperationArg<T>,
) => Promise<ReturnType<AfterOperationMap<T>[keyof AfterOperationMap<T>]>>;
export type AfterErrorHook = (err: Error, res: unknown, context: RequestContext) => { response: any, status: number } | void;
export type BeforeLoginHook<T extends TypeWithID = any> = (args: {
@@ -314,6 +322,7 @@ export type CollectionConfig = {
afterMe?: AfterMeHook[];
afterRefresh?: AfterRefreshHook[];
afterForgotPassword?: AfterForgotPasswordHook[];
afterOperation?: AfterOperationHook[];
};
/**
* Custom rest api endpoints

View File

@@ -22,11 +22,14 @@ import { afterRead } from '../../fields/hooks/afterRead';
import { generateFileData } from '../../uploads/generateFileData';
import { saveVersion } from '../../versions/saveVersion';
import { mapAsync } from '../../utilities/mapAsync';
import { buildAfterOperation } from './utils';
import { registerLocalStrategy } from '../../auth/strategies/local/register';
const unlinkFile = promisify(fs.unlink);
export type Arguments<T extends { [field: string | number | symbol]: unknown }> = {
export type CreateUpdateType = { [field: string | number | symbol]: unknown }
export type Arguments<T extends CreateUpdateType> = {
collection: Collection
req: PayloadRequest
depth?: number
@@ -318,6 +321,16 @@ async function create<TSlug extends keyof GeneratedTypes['collections']>(
}) || result;
}, Promise.resolve());
// /////////////////////////////////////
// afterOperation - Collection
// /////////////////////////////////////
result = await buildAfterOperation<GeneratedTypes['collections'][TSlug]>({
operation: 'create',
args,
result,
});
// Remove temp files if enabled, as express-fileupload does not do this automatically
if (config.upload?.useTempFiles && collectionConfig.upload) {
const { files } = req;

View File

@@ -10,6 +10,7 @@ import { Where } from '../../types';
import { afterRead } from '../../fields/hooks/afterRead';
import { deleteCollectionVersions } from '../../versions/deleteCollectionVersions';
import { deleteAssociatedFiles } from '../../uploads/deleteAssociatedFiles';
import { buildAfterOperation } from './utils';
export type Arguments = {
depth?: number
@@ -212,10 +213,22 @@ async function deleteOperation<TSlug extends keyof GeneratedTypes['collections']
}
preferences.Model.deleteMany({ key: { in: docs.map(({ id }) => `collection-${collectionConfig.slug}-${id}`) } });
return {
let result = {
docs: awaitedDocs.filter(Boolean),
errors,
};
// /////////////////////////////////////
// afterOperation - Collection
// /////////////////////////////////////
result = await buildAfterOperation<GeneratedTypes['collections'][TSlug]>({
operation: 'delete',
args,
result,
});
return result;
}
export default deleteOperation;

View File

@@ -4,11 +4,12 @@ import sanitizeInternalFields from '../../utilities/sanitizeInternalFields';
import { NotFound, Forbidden } from '../../errors';
import executeAccess from '../../auth/executeAccess';
import { BeforeOperationHook, Collection } from '../config/types';
import { Document, Where } from '../../types';
import { Document } from '../../types';
import { hasWhereAccessResult } from '../../auth/types';
import { afterRead } from '../../fields/hooks/afterRead';
import { deleteCollectionVersions } from '../../versions/deleteCollectionVersions';
import { deleteAssociatedFiles } from '../../uploads/deleteAssociatedFiles';
import { buildAfterOperation } from './utils';
export type Arguments = {
depth?: number
@@ -174,6 +175,16 @@ async function deleteByID<TSlug extends keyof GeneratedTypes['collections']>(inc
result = await hook({ req, id, doc: result, context: req.context }) || result;
}, Promise.resolve());
// /////////////////////////////////////
// afterOperation - Collection
// /////////////////////////////////////
result = await buildAfterOperation<GeneratedTypes['collections'][TSlug]>({
operation: 'deleteByID',
args,
result,
});
// /////////////////////////////////////
// 8. Return results
// /////////////////////////////////////

View File

@@ -9,6 +9,7 @@ import { buildSortParam } from '../../mongoose/buildSortParam';
import { AccessResult } from '../../config/types';
import { afterRead } from '../../fields/hooks/afterRead';
import { queryDrafts } from '../../versions/drafts/queryDrafts';
import { buildAfterOperation } from './utils';
export type Arguments = {
collection: Collection
@@ -226,6 +227,16 @@ async function find<T extends TypeWithID & Record<string, unknown>>(
})),
};
// /////////////////////////////////////
// afterOperation - Collection
// /////////////////////////////////////
result = await buildAfterOperation<T>({
operation: 'find',
args,
result,
});
// /////////////////////////////////////
// Return results
// /////////////////////////////////////

View File

@@ -7,6 +7,7 @@ import { NotFound } from '../../errors';
import executeAccess from '../../auth/executeAccess';
import replaceWithDraftIfAvailable from '../../versions/drafts/replaceWithDraftIfAvailable';
import { afterRead } from '../../fields/hooks/afterRead';
import { buildAfterOperation } from './utils';
export type Arguments = {
collection: Collection
@@ -173,6 +174,16 @@ async function findByID<T extends TypeWithID>(
}) || result;
}, Promise.resolve());
// /////////////////////////////////////
// afterOperation - Collection
// /////////////////////////////////////
result = await buildAfterOperation<T>({
operation: 'findByID',
args,
result,
});
// /////////////////////////////////////
// Return results
// /////////////////////////////////////

View File

@@ -124,12 +124,28 @@ async function restoreVersion<T extends TypeWithID = any>(args: Arguments): Prom
delete prevVersion.id;
await VersionModel.updateMany({
$and: [
{
parent: {
$eq: parentDocID,
},
},
{
latest: {
$eq: true,
},
},
],
}, { $unset: { latest: 1 } });
await VersionModel.create({
parent: parentDocID,
version: rawVersion.version,
autosave: false,
createdAt: prevVersion.createdAt,
updatedAt: new Date().toISOString(),
latest: payload.config.database.queryDrafts_2_0 ? true : undefined,
});
// /////////////////////////////////////

Some files were not shown because too many files have changed in this diff Show More