Compare commits

..

30 Commits

Author SHA1 Message Date
Elliot DeNolf
e8c6c9338d chore(release): db-postgres/0.5.1 [skip ci] 2024-02-06 15:41:35 -05:00
Elliot DeNolf
558534aff8 chore(release): richtext-lexical/0.6.0 [skip ci] 2024-02-06 15:41:04 -05:00
Elliot DeNolf
29c901ba9b chore(release): payload/2.10.0 [skip ci] 2024-02-06 15:38:33 -05:00
Elliot DeNolf
f3876c2a39 fix(db-postgres): localized field sort count (#4997)
* fix(db-postgres): localized field sort count

* test: localized sort doc count
2024-02-06 11:44:54 -05:00
Elliot DeNolf
c3a3942969 fix(db-postgres): filtering relationships with drafts enabled (#4998)
* fix(db-postgres): filtering relationships with drafts enabled

* test: draft relationship filtering
2024-02-06 11:16:27 -05:00
Paul
23b135b963 fix(templates): fix conflicting routes with Nextjs (#4725)
* Updated templates and readme to note conflicting routes

* Move information in readmes to blockquotes and move next-api to just next

* Remove unnecessary notes
2024-02-06 10:56:20 -05:00
Daniel Kirchhof
e3c8105cc2 feat: use deletion success message from server if provided (#4966) 2024-02-06 10:17:53 -05:00
Jarrod Flesch
2c71aaef75 chore: standardize req passed through the local API (#4994) 2024-02-05 15:43:59 -05:00
brachypelma
922fb9b7fa docs: added link to JSON field type (#4989) 2024-02-05 13:13:28 -05:00
Elliot DeNolf
0740d5095e fix(migrations): safely create migration file when no name passed (#4995) 2024-02-05 10:43:19 -05:00
Jacob Fletcher
b392d656fe chore(examples/multi-tentant): resets lastLoggedInTenant when none found (#4984) 2024-02-02 15:50:12 -05:00
Elliot DeNolf
c0eef90cdc ci: supabase (#4983)
* ci: supabase

* test: add supabase to adapter record

* test: adjust index tests conditional
2024-02-02 15:26:18 -05:00
Dan Ribbens
db22cbdf21 fix(plugin-seo): tabbedUI with email field causes duplicate field (#4944)
* fix(plugin-seo): tabbedUI with email field causes duplicate field

* chore(plugin-seo): code comment
2024-02-02 14:53:51 -05:00
Dan Ribbens
1e8a6b7899 feat: extend transactions to cover after and beforeOperation hooks (#4960)
* feat: extend transactions to cover after and beforeOperation hooks

* feat: use transactions in refresh operation

* docs: add req to beforeOperation and afterOperation args
2024-02-02 14:53:14 -05:00
Dan Ribbens
5d934ba02d feat: previousValue and previousSiblingDoc args added to beforeChange field hooks (#4958)
* feat: previousValue and previousSiblingDoc args added to beforeChange field hooks

* chore: fieldHook type docs
2024-02-02 13:59:11 -05:00
Elliot DeNolf
f651665f2f chore(deps): add pnpm overrides for common packages (#4980)
* chore(deps): add pnpm overrides for common packages

* chore(deps): bump @swc/core for compat w/ latest typescript
2024-02-02 13:21:57 -05:00
Elliot DeNolf
5d3659d48a fix(db-postgres): handle schema changes with supabase (#4968)
* fix(db-postgres): handle schema changes with supabase

* chore(deps): bump drizzle-orm for test suite
2024-02-02 11:29:32 -05:00
Dan Ribbens
47106d5a1a fix(db-postgres): indexes not creating for relationships, arrays, hasmany and blocks (#4976) 2024-02-02 11:16:21 -05:00
Jarrod Flesch
afa2b942e0 fix: ensures docPermissions fallback to collection permissions on create (#4969) 2024-02-01 16:54:52 -05:00
Dan Ribbens
20ddd0de5b chore: add indexes to preferences for performance (#4965) 2024-02-01 15:31:31 -05:00
Dan Ribbens
64f705c3c9 fix(db-postgres): indexes not created for non unique field names (#4967) 2024-02-01 15:21:15 -05:00
Daniel Shamburger
b30ea8aa6b docs: typo (#4948) 2024-01-31 15:40:55 -05:00
Mark Paolo Libunao
471d2113a7 feat: re-use existing logger instance passed to payload.init (#3124) 2024-01-31 15:40:14 -05:00
Alessio Gravili
8725d41164 feat: add more options to addFieldStatePromise so that it can be used for field flattening (#4799) 2024-01-30 23:02:58 +01:00
Dan Ribbens
0bd81aa25a fix(templates-ecommerce): hook errors for non-string ids (#4946) 2024-01-30 13:28:14 -05:00
Dan Ribbens
8c09ca9be5 examples: fix multi-tenant hooks to use transactions (#4955) 2024-01-30 13:26:13 -05:00
Alessio Gravili
90d7ee3e65 feat(richtext-lexical): Blocks: generate type definitions for blocks fields (#4529) 2024-01-30 16:51:18 +01:00
Kendell Joseph
58bbd8c00f chore(examples/hierarchy): adds hierarchy example (#4923) 2024-01-26 16:17:11 -05:00
Elliot DeNolf
003ad065c3 chore(release): plugin-cloud-storage/1.1.2 [skip ci] 2024-01-26 13:58:13 -05:00
Elliot DeNolf
70715926a8 chore(release): richtext-slate/1.4.0 [skip ci] 2024-01-26 13:57:45 -05:00
126 changed files with 11824 additions and 3311 deletions

View File

@@ -85,7 +85,7 @@ jobs:
strategy:
fail-fast: false
matrix:
database: [mongoose, postgres]
database: [mongoose, postgres, supabase]
env:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
@@ -118,7 +118,22 @@ jobs:
postgresql password: ${{ env.POSTGRES_PASSWORD }}
if: matrix.database == 'postgres'
- run: sleep 30
- name: Install Supabase CLI
uses: supabase/setup-cli@v1
with:
version: latest
if: matrix.database == 'supabase'
- name: Initialize Supabase
run: |
supabase init
supabase start
if: matrix.database == 'supabase'
- name: Wait for PostgreSQL
run: sleep 30
if: matrix.database == 'postgres'
- name: Configure PostgreSQL
run: |
psql "postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB" -c "CREATE ROLE runner SUPERUSER LOGIN;"
@@ -126,6 +141,11 @@ jobs:
echo "POSTGRES_URL=postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB" >> $GITHUB_ENV
if: matrix.database == 'postgres'
- name: Configure Supabase
run: |
echo "POSTGRES_URL=postgresql://postgres:postgres@127.0.0.1:54322/postgres" >> $GITHUB_ENV
if: matrix.database == 'supabase'
- name: Component Tests
run: pnpm test:components

View File

@@ -1,3 +1,27 @@
## [2.10.0](https://github.com/payloadcms/payload/compare/v2.9.0...v2.10.0) (2024-02-06)
### Features
* add more options to addFieldStatePromise so that it can be used for field flattening ([#4799](https://github.com/payloadcms/payload/issues/4799)) ([8725d41](https://github.com/payloadcms/payload/commit/8725d411645bb0270376e235669f46be2227ecc0))
* extend transactions to cover after and beforeOperation hooks ([#4960](https://github.com/payloadcms/payload/issues/4960)) ([1e8a6b7](https://github.com/payloadcms/payload/commit/1e8a6b7899f7b1e6451cc4d777602208478b483c))
* previousValue and previousSiblingDoc args added to beforeChange field hooks ([#4958](https://github.com/payloadcms/payload/issues/4958)) ([5d934ba](https://github.com/payloadcms/payload/commit/5d934ba02d07d98f781ce983228858ee5ce5c226))
* re-use existing logger instance passed to payload.init ([#3124](https://github.com/payloadcms/payload/issues/3124)) ([471d211](https://github.com/payloadcms/payload/commit/471d2113a790dc0d54b2f8ed84e6899310efd600))
* **richtext-lexical:** Blocks: generate type definitions for blocks fields ([#4529](https://github.com/payloadcms/payload/issues/4529)) ([90d7ee3](https://github.com/payloadcms/payload/commit/90d7ee3e6535d51290fc734b284ff3811dbda1f8))
* use deletion success message from server if provided ([#4966](https://github.com/payloadcms/payload/issues/4966)) ([e3c8105](https://github.com/payloadcms/payload/commit/e3c8105cc2ed6fdf8007d97cd7b5556fc71ed724))
### Bug Fixes
* **db-postgres:** filtering relationships with drafts enabled ([#4998](https://github.com/payloadcms/payload/issues/4998)) ([c3a3942](https://github.com/payloadcms/payload/commit/c3a39429697e9d335e9be199e7caafb82eb26219))
* **db-postgres:** handle schema changes with supabase ([#4968](https://github.com/payloadcms/payload/issues/4968)) ([5d3659d](https://github.com/payloadcms/payload/commit/5d3659d48ad8bbf5d96fbcd80434d2287cab97e0))
* **db-postgres:** indexes not created for non unique field names ([#4967](https://github.com/payloadcms/payload/issues/4967)) ([64f705c](https://github.com/payloadcms/payload/commit/64f705c3c94148972f67e8175e718015760d6430))
* **db-postgres:** indexes not creating for relationships, arrays, hasmany and blocks ([#4976](https://github.com/payloadcms/payload/issues/4976)) ([47106d5](https://github.com/payloadcms/payload/commit/47106d5a1af2ebd073fbbc6e474174c3d3835e5c))
* **db-postgres:** localized field sort count ([#4997](https://github.com/payloadcms/payload/issues/4997)) ([f3876c2](https://github.com/payloadcms/payload/commit/f3876c2a39efe19a1864213306725aadcc14f130))
* ensures docPermissions fallback to collection permissions on create ([#4969](https://github.com/payloadcms/payload/issues/4969)) ([afa2b94](https://github.com/payloadcms/payload/commit/afa2b942e0aad90c55744ae13e0ffe1cefa4585d))
* **migrations:** safely create migration file when no name passed ([#4995](https://github.com/payloadcms/payload/issues/4995)) ([0740d50](https://github.com/payloadcms/payload/commit/0740d5095ee1aef13e4e37f6b174d529f0f2d993))
* **plugin-seo:** tabbedUI with email field causes duplicate field ([#4944](https://github.com/payloadcms/payload/issues/4944)) ([db22cbd](https://github.com/payloadcms/payload/commit/db22cbdf21a39ed0604ab96c57ca4242eac82ce7))
## [2.9.0](https://github.com/payloadcms/payload/compare/v2.8.2...v2.9.0) (2024-01-26)

View File

@@ -28,7 +28,7 @@ This field uses the `monaco-react` editor syntax highlighting.
| **`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 a field label in the Admin panel or an object with keys for each language. |
| **`unique`** | Enforce that each entry in the Collection has a unique value for this field. |
| **`index`** | Build a an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
| **`index`** | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
| **`validate`** | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation) |
| **`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) |

View File

@@ -46,6 +46,7 @@ export const Page: CollectionConfig = {
- [Date](/docs/fields/date) - date / time field that saves a timestamp
- [Email](/docs/fields/email) - validates the entry is a properly formatted email
- [Group](/docs/fields/group) - nest fields within an object
- [JSON](/docs/fields/json) - saves actual JSON in the database
- [Number](/docs/fields/number) - field that enforces that its value be a number
- [Point](/docs/fields/point) - geometric coordinates for location data
- [Radio](/docs/fields/radio) - radio button group, allowing only one value to be selected

View File

@@ -38,7 +38,7 @@ caption="Admin panel screenshot of a Relationship field"
| **`label`** | Text used as a field label in the Admin panel or an object with keys for each language. |
| **`unique`** | Enforce that each entry in the Collection has a unique value for 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) |
| **`index`** | Build a an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
| **`index`** | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
| **`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

@@ -75,6 +75,7 @@ import { CollectionBeforeOperationHook } from 'payload/types'
const beforeOperationHook: CollectionBeforeOperationHook = async ({
args, // original arguments passed into the operation
operation, // name of the operation
req, // full express request
}) => {
return args // return modified operation arguments as necessary
}
@@ -209,6 +210,7 @@ import { CollectionAfterOperationHook } from 'payload/types'
const afterOperationHook: CollectionAfterOperationHook = async ({
args, // arguments passed into the operation
operation, // name of the operation
req, // full express request
result, // the result of the operation, before modifications
}) => {
return result // return modified result as necessary

View File

@@ -6,7 +6,8 @@ desc: Hooks can be added to any fields, and optionally modify the return value o
keywords: hooks, fields, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
---
Field-level hooks offer incredible potential for encapsulating your logic. They help to isolate concerns and package up functionalities to be easily reusable across your projects.
Field-level hooks offer incredible potential for encapsulating your logic. They help to isolate concerns and package up
functionalities to be easily reusable across your projects.
**Example use cases include:**
@@ -46,7 +47,8 @@ const ExampleField: Field = {
## Arguments and return values
All field-level hooks are formatted to accept the same arguments, although some arguments may be `undefined` based on which field hook you are utilizing.
All field-level hooks are formatted to accept the same arguments, although some arguments may be `undefined` based on
which field hook you are utilizing.
<Banner type="success">
<strong>Tip:</strong>
@@ -69,10 +71,10 @@ Field Hooks receive one `args` argument that contains the following properties:
| **`operation`** | A string relating to which operation the field type is currently executing within. Useful within `beforeValidate`, `beforeChange`, and `afterChange` hooks to differentiate between `create` and `update` operations. |
| **`originalDoc`** | The full original document in `update` operations. In the `afterChange` hook, this is the resulting document of the operation. |
| **`previousDoc`** | The document before changes were applied, only in `afterChange` hooks. |
| **`previousSiblingDoc`** | The sibling data from the previous document in `afterChange` hook. |
| **`previousSiblingDoc`** | The sibling data of the document before changes being applied, only in `beforeChange` and `afterChange` hook. |
| **`req`** | The Express `request` object. It is mocked for Local API operations. |
| **`value`** | The value of the field. |
| **`previousValue`** | The previous value of the field, before changes were applied, only in `afterChange` hooks. |
| **`previousValue`** | The previous value of the field, before changes, only in `beforeChange` and `afterChange` hooks. |
| **`context`** | Context passed to this hook. More info can be found under [Context](/docs/hooks/context) |
| **`field`** | The field which the hook is running against. |
| **`collection`** | The collection which the field belongs to. If the field belongs to a global, this will be null. |
@@ -80,7 +82,8 @@ Field Hooks receive one `args` argument that contains the following properties:
#### Return value
All field hooks can optionally modify the return value of the field before the operation continues. Field Hooks may optionally return the value that should be used within the field.
All field hooks can optionally modify the return value of the field before the operation continues. Field Hooks may
optionally return the value that should be used within the field.
<Banner type="warning">
<strong>Important</strong>
@@ -92,11 +95,14 @@ All field hooks can optionally modify the return value of the field before the o
## Examples of Field Hooks
To better illustrate how field-level hooks can be applied, here are some specific examples. These demonstrate the flexibility and potential of field hooks in different contexts. Remember, these examples are just a starting point - the true potential of field-level hooks lies in their adaptability to a wide array of use cases.
To better illustrate how field-level hooks can be applied, here are some specific examples. These demonstrate the
flexibility and potential of field hooks in different contexts. Remember, these examples are just a starting point - the
true potential of field-level hooks lies in their adaptability to a wide array of use cases.
### beforeValidate
Runs before the `update` operation. This hook allows you to pre-process or format field data before it undergoes validation.
Runs before the `update` operation. This hook allows you to pre-process or format field data before it undergoes
validation.
```ts
import { Field } from 'payload/types'
@@ -113,11 +119,15 @@ const usernameField: Field = {
}
```
In this example, the `beforeValidate` hook is used to process the `username` field. The hook takes the incoming value of the field and transforms it by trimming whitespace and converting it to lowercase. This ensures that the username is stored in a consistent format in the database.
In this example, the `beforeValidate` hook is used to process the `username` field. The hook takes the incoming value of
the field and transforms it by trimming whitespace and converting it to lowercase. This ensures that the username is
stored in a consistent format in the database.
### beforeChange
Immediately following validation, `beforeChange` hooks will run within `create` and `update` operations. At this stage, you can be confident that the field data that will be saved to the document is valid in accordance to your field validations.
Immediately following validation, `beforeChange` hooks will run within `create` and `update` operations. At this stage,
you can be confident that the field data that will be saved to the document is valid in accordance to your field
validations.
```ts
import { Field } from 'payload/types'
@@ -136,11 +146,14 @@ const emailField: Field = {
}
```
In the `emailField`, the `beforeChange` hook checks the `operation` type. If the operation is `create`, it performs additional validation or transformation on the email field value. This allows for operation-specific logic to be applied to the field.
In the `emailField`, the `beforeChange` hook checks the `operation` type. If the operation is `create`, it performs
additional validation or transformation on the email field value. This allows for operation-specific logic to be applied
to the field.
### afterChange
The `afterChange` hook is executed after a field's value has been changed and saved in the database. This hook is useful for post-processing or triggering side effects based on the new value of the field.
The `afterChange` hook is executed after a field's value has been changed and saved in the database. This hook is useful
for post-processing or triggering side effects based on the new value of the field.
```ts
import { Field } from 'payload/types'
@@ -165,11 +178,15 @@ const membershipStatusField: Field = {
}
```
In this example, the `afterChange` hook is used with a `membershipStatusField`, which allows users to select their membership level (Standard, Premium, VIP). The hook monitors changes in the membership status. When a change occurs, it logs the update and can be used to trigger further actions, such as tracking conversion from one tier to another or notifying them about changes in their membership benefits.
In this example, the `afterChange` hook is used with a `membershipStatusField`, which allows users to select their
membership level (Standard, Premium, VIP). The hook monitors changes in the membership status. When a change occurs, it
logs the update and can be used to trigger further actions, such as tracking conversion from one tier to another or
notifying them about changes in their membership benefits.
### afterRead
The `afterRead` hook is invoked after a field value is read from the database. This is ideal for formatting or transforming the field data for output.
The `afterRead` hook is invoked after a field value is read from the database. This is ideal for formatting or
transforming the field data for output.
```ts
import { Field } from 'payload/types'
@@ -186,8 +203,9 @@ const dateField: Field = {
}
```
Here, the `afterRead` hook for the `dateField` is used to format the date into a more readable format using `toLocaleDateString()`. This hook modifies the way the date is presented to the user, making it more user-friendly.
Here, the `afterRead` hook for the `dateField` is used to format the date into a more readable format
using `toLocaleDateString()`. This hook modifies the way the date is presented to the user, making it more
user-friendly.
## TypeScript

View File

@@ -98,6 +98,13 @@ On boot, a seed script is included to scaffold a basic database for you to use a
> 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.
### Conflicting routes
>In a monorepo when routes are bootstrapped to the same host, they can conflict with Payload's own routes if they have the same name. In our template we've named the Nextjs API routes to `next` to avoid this conflict.
>
>This can happen with any other routes conflicting with Payload such as `admin` and we recommend using different names for custom routes.
>Alternatively you can also rename Payload's own routes via the [configuration](https://payloadcms.com/docs/configuration/overview).
## Production
To run Payload in production, you need to build and serve the Admin panel. To do so, follow these steps:

View File

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

View File

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

View File

@@ -0,0 +1,10 @@
import { NextResponse } from 'next/server'
/**
* The Next.js API routes can conflict with Payload's own routes if they share the same path
* To avoid this you can customise the path of Payload or the API route of Nextjs as we've done here
* See readme: https://github.com/payloadcms/payload/tree/main/examples/custom-server#conflicting-routes
* */
export async function GET(): Promise<NextResponse> {
return NextResponse.json({ success: true })
}

View File

@@ -0,0 +1,10 @@
import { NextResponse } from 'next/server'
/**
* The Next.js API routes can conflict with Payload's own routes if they share the same path
* To avoid this you can customise the path of Payload or the API route of Nextjs as we've done here
* See readme: https://github.com/payloadcms/payload/tree/main/examples/custom-server#conflicting-routes
* */
export async function POST(): Promise<NextResponse> {
return NextResponse.json({ success: true })
}

View File

@@ -0,0 +1,2 @@
DATABASE_URI=mongodb://127.0.0.1/payload-template-blank
PAYLOAD_SECRET=YOUR_SECRET_HERE

6
examples/hierarchy/.gitignore vendored Normal file
View File

@@ -0,0 +1,6 @@
build
dist
/media
node_modules
.DS_Store
.env

View File

@@ -0,0 +1,8 @@
module.exports = {
printWidth: 100,
parser: 'typescript',
semi: false,
singleQuote: true,
trailingComma: 'all',
arrowParens: 'avoid',
}

View File

@@ -0,0 +1,58 @@
# Payload Hierarchy Example
This example demonstrates how to achieve a virtual hierarchy between documents in your [Payload](https://github.com/payloadcms/payload) application.
## Quick Start
To spin up the project locally, follow these steps:
1. First clone the repo
1. Then `cd YOUR_PROJECT_REPO && cp .env.example .env`
1. Next `yarn && yarn dev` (or `docker-compose up`, see [Docker](#docker))
1. Now `open http://localhost:3000/admin` to access the admin panel
1. Create your first admin user using the form on the page
That's it! Changes made in `./src` will be reflected in your app.
## How it works
This example achieves parent/child relationships between your documents through the use of virtual fields. When you query a document with the `?children=true` query param, an afterRead hook is used to populate the documents within its own tree.
For more information on how virtual fields, see the [Official Virtual Fields Example](https://github.com/payloadcms/payload/tree/main/examples/virtual-fields).
### Collections
See the [Collections](https://payloadcms.com/docs/configuration/collections) docs for details on how to extend any of this functionality.
- #### Users
The `users` collection is a default payload users collection.
- #### Entities
The `entities` collection can define a parent as any other entity. It has a virtual field that will also populate children when it is called via the API using a query `children=true`. See [Virtual Fields](https://github.com/payloadcms/payload/tree/main/examples/virtual-fields) for more details on how virtual fields work.
The virtual field retrieves __all__ children which includes other entities and people.
- #### People
The `people` collection is a collection that can define an array of parent entities. It also has an allocation field. This is for demonstrating attaching data to a parent-child relationship.
## Development
To spin up this example locally, follow the [Quick Start](#quick-start).
## Production
To run Payload in production, you need to build and serve the Admin panel. To do so, follow these steps:
1. First invoke the `payload build` script by running `yarn build` or `npm run build` in your project root. This creates a `./build` directory with a production-ready admin bundle.
1. Then run `yarn serve` or `npm run serve` to run Node in production and serve Payload from the `./build` directory.
### Deployment
The easiest way to deploy your project is to use [Payload Cloud](https://payloadcms.com/new/import), a one-click hosting solution to deploy production-ready instances of your Payload apps directly from your GitHub repo. You can also deploy your app manually, check out the [deployment documentation](https://payloadcms.com/docs/production/deployment) for full details.
## Questions
If you have any issues or questions, reach out to us on [Discord](https://discord.com/invite/payload) or start a [GitHub discussion](https://github.com/payloadcms/payload/discussions).

View File

@@ -0,0 +1,6 @@
{
"$schema": "https://json.schemastore.org/nodemon.json",
"ext": "ts",
"exec": "ts-node src/server.ts -- -I",
"stdin": false
}

View File

@@ -0,0 +1,35 @@
{
"name": "hierarchy",
"description": "A hierarchy example with Payload",
"version": "1.0.0",
"main": "dist/server.js",
"license": "MIT",
"scripts": {
"dev": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts nodemon",
"build:payload": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload build",
"build:server": "tsc",
"build": "yarn copyfiles && yarn build:payload && yarn build:server",
"serve": "cross-env PAYLOAD_CONFIG_PATH=dist/payload.config.js NODE_ENV=production node dist/server.js",
"copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png}\" dist/",
"generate:types": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:types",
"generate:graphQLSchema": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload generate:graphQLSchema",
"payload": "cross-env PAYLOAD_CONFIG_PATH=src/payload.config.ts payload"
},
"dependencies": {
"@payloadcms/bundler-webpack": "^1.0.0",
"@payloadcms/db-mongodb": "^1.0.0",
"@payloadcms/plugin-cloud": "^3.0.0",
"@payloadcms/richtext-slate": "^1.0.0",
"cross-env": "^7.0.3",
"dotenv": "^8.2.0",
"express": "^4.17.1",
"payload": "^2.0.0"
},
"devDependencies": {
"@types/express": "^4.17.9",
"copyfiles": "^2.4.1",
"nodemon": "^2.0.6",
"ts-node": "^9.1.1",
"typescript": "^4.8.4"
}
}

View File

@@ -0,0 +1,79 @@
import { CollectionConfig } from 'payload/types'
export const Entities: CollectionConfig = {
slug: 'entities',
admin: {
useAsTitle: 'name',
},
fields: [
{
name: 'name',
type: 'text',
required: true,
},
// - This field is populated by setting the query parameter 'children=true'
// - This is a virtual field used to track a child relationship
// - Only relationship information is returned by this field
// - Data beyond relationships is not stored in this field
{
name: 'children',
type: 'relationship',
relationTo: ['entities', 'people'],
access: {
create: () => false,
update: () => false,
},
hooks: {
afterRead: [
async ({ data, req }) => {
const { id } = data
if (!req.query.children) return
const people = await req.payload.find({
req,
collection: 'people',
where: {
'parents.parent': { equals: id },
},
limit: 0,
depth: 0,
pagination: false,
})
const entities = await req.payload.find({
req,
collection: 'entities',
where: {
parent: { equals: id },
},
limit: 0,
depth: 0,
pagination: false,
})
return [
...entities.docs.map(entity => {
return {
relationTo: 'entity',
value: entity,
}
}),
...people.docs.map(person => {
return {
relationTo: 'people',
value: person,
}
}),
]
},
],
},
},
{
name: 'parent',
type: 'relationship',
relationTo: 'entities',
},
],
}

View File

@@ -0,0 +1,32 @@
import { CollectionConfig } from 'payload/types'
export const People: CollectionConfig = {
slug: 'people',
admin: {
useAsTitle: 'name',
},
fields: [
{
name: 'name',
type: 'text',
required: true,
},
{
name: 'parents',
type: 'array',
fields: [
{
name: 'parent',
type: 'relationship',
relationTo: 'entities',
},
{
name: 'allocation',
type: 'number',
min: 0,
max: 100,
},
],
},
],
}

View File

@@ -0,0 +1,15 @@
import { CollectionConfig } from 'payload/types'
const Users: CollectionConfig = {
slug: 'users',
auth: true,
admin: {
useAsTitle: 'email',
},
fields: [
// Email added by default
// Add more fields as needed
],
}
export default Users

View File

@@ -0,0 +1,30 @@
import path from 'path'
import { payloadCloud } from '@payloadcms/plugin-cloud'
import { mongooseAdapter } from '@payloadcms/db-mongodb'
import { webpackBundler } from '@payloadcms/bundler-webpack'
import { slateEditor } from '@payloadcms/richtext-slate'
import { buildConfig } from 'payload/config'
import Users from './collections/Users'
import { Entities } from './collections/Entities'
import { People } from './collections/People'
export default buildConfig({
admin: {
user: Users.slug,
bundler: webpackBundler(),
},
editor: slateEditor({}),
collections: [Users, Entities, People],
typescript: {
outputFile: path.resolve(__dirname, 'payload-types.ts'),
},
graphQL: {
schemaOutputFile: path.resolve(__dirname, 'generated-schema.graphql'),
},
plugins: [payloadCloud()],
db: mongooseAdapter({
url: process.env.DATABASE_URI,
}),
})

View File

@@ -0,0 +1,27 @@
import express from 'express'
import payload from 'payload'
require('dotenv').config()
const app = express()
// Redirect root to Admin panel
app.get('/', (_, res) => {
res.redirect('/admin')
})
const start = async () => {
// Initialize Payload
await payload.init({
secret: process.env.PAYLOAD_SECRET,
express: app,
onInit: async () => {
payload.logger.info(`Payload Admin URL: ${payload.getAdminURL()}`)
},
})
// Add your own express routes here
app.listen(3000)
}
start()

View File

@@ -0,0 +1,22 @@
{
"compilerOptions": {
"target": "es5",
"lib": ["dom", "dom.iterable", "esnext"],
"allowJs": true,
"strict": false,
"esModuleInterop": true,
"skipLibCheck": true,
"outDir": "./dist",
"rootDir": "./src",
"jsx": "react",
"paths": {
"payload/generated-types": ["./src/payload-types.ts"]
}
},
"include": ["src"],
"exclude": ["node_modules", "dist", "build"],
"ts-node": {
"transpileOnly": true,
"swc": true
}
}

7896
examples/hierarchy/yarn.lock Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -2,26 +2,27 @@ import type { AfterLoginHook } from 'payload/dist/collections/config/types'
export const recordLastLoggedInTenant: AfterLoginHook = async ({ req, user }) => {
try {
const relatedOrg = await req.payload.find({
collection: 'tenants',
where: {
'domains.domain': {
in: [req.headers.host],
},
},
depth: 0,
limit: 1,
})
if (relatedOrg.docs.length > 0) {
await req.payload.update({
id: user.id,
collection: 'users',
data: {
lastLoggedInTenant: relatedOrg.docs[0].id,
const relatedOrg = await req.payload
.find({
collection: 'tenants',
where: {
'domains.domain': {
in: [req.headers.host],
},
},
depth: 0,
limit: 1,
})
}
?.then(res => res.docs?.[0])
await req.payload.update({
id: user.id,
collection: 'users',
data: {
lastLoggedInTenant: relatedOrg?.id || null,
},
req,
})
} catch (err: unknown) {
req.payload.logger.error(`Error recording last logged in tenant for user ${user.id}: ${err}`)
}

View File

@@ -30,6 +30,7 @@ export const isSuperOrTenantAdmin = async (args: { req: PayloadRequest }): Promi
},
depth: 0,
limit: 1,
req,
})
// if this tenant does not exist, deny access

File diff suppressed because it is too large Load Diff

View File

@@ -64,7 +64,7 @@
"copyfiles": "2.4.1",
"cross-env": "7.0.3",
"dotenv": "8.6.0",
"drizzle-orm": "0.28.5",
"drizzle-orm": "0.29.3",
"express": "4.18.2",
"form-data": "3.0.1",
"fs-extra": "10.1.0",
@@ -94,7 +94,7 @@
"slash": "3.0.0",
"slate": "0.91.4",
"tempfile": "^3.0.0",
"ts-node": "10.9.1",
"ts-node": "10.9.2",
"turbo": "^1.11.1",
"typescript": "5.2.2",
"uuid": "^9.0.1"
@@ -104,6 +104,16 @@
"react-i18next": "11.18.6",
"react-router-dom": "5.3.4"
},
"pnpm": {
"overrides": {
"copyfiles": "2.4.1",
"cross-env": "7.0.3",
"dotenv": "8.6.0",
"drizzle-orm": "0.29.3",
"ts-node": "10.9.2",
"typescript": "5.2.2"
}
},
"engines": {
"node": ">=14",
"pnpm": ">=8"

View File

@@ -32,7 +32,7 @@ export const createMigration: CreateMigration = async function createMigration({
// Check for predefined migration.
// Either passed in via --file or prefixed with @payloadcms/db-mongodb/
if (file || migrationName.startsWith('@payloadcms/db-mongodb/')) {
if (file || migrationName?.startsWith('@payloadcms/db-mongodb/')) {
if (!file) file = migrationName
const predefinedMigrationName = file.replace('@payloadcms/db-mongodb/', '')
@@ -59,8 +59,8 @@ export const createMigration: CreateMigration = async function createMigration({
const timestamp = `${formattedDate}_${formattedTime}`
const formattedName = migrationName.replace(/\W/g, '_')
const fileName = `${timestamp}_${formattedName}.ts`
const formattedName = migrationName?.replace(/\W/g, '_')
const fileName = migrationName ? `${timestamp}_${formattedName}.ts` : `${timestamp}_migration.ts`
const filePath = `${dir}/${fileName}`
fs.writeFileSync(filePath, migrationFileContent)
payload.logger.info({ msg: `Migration created at ${filePath}` })

View File

@@ -1,6 +1,6 @@
{
"name": "@payloadcms/db-postgres",
"version": "0.5.0",
"version": "0.5.1",
"description": "The officially supported Postgres database adapter for Payload",
"repository": "https://github.com/payloadcms/payload",
"license": "MIT",
@@ -22,7 +22,7 @@
"dependencies": {
"@libsql/client": "^0.3.1",
"console-table-printer": "2.11.2",
"drizzle-kit": "0.20.5-608ae62",
"drizzle-kit": "0.20.14-1f2c838",
"drizzle-orm": "0.29.3",
"pg": "8.11.3",
"prompts": "2.4.2",

View File

@@ -158,7 +158,7 @@ export const findMany = async function find({
query: db
.select({
count: sql<number>`count
(*)`,
(DISTINCT ${adapter.tables[tableName].id})`,
})
.from(table)
.where(where),

View File

@@ -134,7 +134,7 @@ export const getTableColumnFromPath = ({
aliasTable,
collectionPath,
columnPrefix: `${columnPrefix}${field.name}_`,
constraintPath,
constraintPath: `${constraintPath}${field.name}.`,
constraints,
fields: field.fields,
joinAliases,
@@ -185,7 +185,7 @@ export const getTableColumnFromPath = ({
aliasTable,
collectionPath,
columnPrefix: `${columnPrefix}${field.name}_`,
constraintPath,
constraintPath: `${constraintPath}${field.name}.`,
constraints,
fields: field.fields,
joinAliases,

View File

@@ -27,9 +27,9 @@ type Args = {
adapter: PostgresAdapter
baseColumns?: Record<string, PgColumnBuilder>
baseExtraConfig?: Record<string, (cols: GenericColumns) => IndexBuilder | UniqueConstraintBuilder>
buildTexts?: boolean
buildNumbers?: boolean
buildRelationships?: boolean
buildTexts?: boolean
disableNotNull: boolean
disableUnique: boolean
fields: Field[]
@@ -42,8 +42,8 @@ type Args = {
}
type Result = {
hasManyTextField: 'index' | boolean
hasManyNumberField: 'index' | boolean
hasManyTextField: 'index' | boolean
relationsToBuild: Map<string, string>
}
@@ -51,9 +51,9 @@ export const buildTable = ({
adapter,
baseColumns = {},
baseExtraConfig = {},
buildTexts,
buildNumbers,
buildRelationships,
buildTexts,
disableNotNull,
disableUnique = false,
fields,
@@ -100,16 +100,16 @@ export const buildTable = ({
columns.id = idColTypeMap[idColType]('id').primaryKey()
;({
hasLocalizedField,
hasLocalizedManyTextField,
hasLocalizedManyNumberField,
hasLocalizedManyTextField,
hasLocalizedRelationshipField,
hasManyTextField,
hasManyNumberField,
hasManyTextField,
} = traverseFields({
adapter,
buildTexts,
buildNumbers,
buildRelationships,
buildTexts,
columns,
disableNotNull,
disableUnique,
@@ -196,12 +196,12 @@ export const buildTable = ({
const textsTableName = `${rootTableName}_texts`
const columns: Record<string, PgColumnBuilder> = {
id: serial('id').primaryKey(),
text: varchar('text'),
order: integer('order').notNull(),
parent: parentIDColumnMap[idColType]('parent_id')
.references(() => table.id, { onDelete: 'cascade' })
.notNull(),
path: varchar('path').notNull(),
text: varchar('text'),
}
if (hasLocalizedManyTextField) {
@@ -210,15 +210,15 @@ export const buildTable = ({
textsTable = pgTable(textsTableName, columns, (cols) => {
const indexes: Record<string, IndexBuilder> = {
orderParentIdx: index('order_parent_idx').on(cols.order, cols.parent),
orderParentIdx: index(`${textsTableName}_order_parent_idx`).on(cols.order, cols.parent),
}
if (hasManyTextField === 'index') {
indexes.text_idx = index('text_idx').on(cols.text)
indexes.text_idx = index(`${textsTableName}_text_idx`).on(cols.text)
}
if (hasLocalizedManyTextField) {
indexes.localeParent = index('locale_parent').on(cols.locale, cols.parent)
indexes.localeParent = index(`${textsTableName}_locale_parent`).on(cols.locale, cols.parent)
}
return indexes
@@ -254,15 +254,18 @@ export const buildTable = ({
numbersTable = pgTable(numbersTableName, columns, (cols) => {
const indexes: Record<string, IndexBuilder> = {
orderParentIdx: index('order_parent_idx').on(cols.order, cols.parent),
orderParentIdx: index(`${numbersTableName}_order_parent_idx`).on(cols.order, cols.parent),
}
if (hasManyNumberField === 'index') {
indexes.numberIdx = index('number_idx').on(cols.number)
indexes.numberIdx = index(`${numbersTableName}_number_idx`).on(cols.number)
}
if (hasLocalizedManyNumberField) {
indexes.localeParent = index('locale_parent').on(cols.locale, cols.parent)
indexes.localeParent = index(`${numbersTableName}_locale_parent`).on(
cols.locale,
cols.parent,
)
}
return indexes
@@ -313,13 +316,13 @@ export const buildTable = ({
relationshipsTable = pgTable(relationshipsTableName, relationshipColumns, (cols) => {
const result: Record<string, unknown> = {
order: index('order_idx').on(cols.order),
parentIdx: index('parent_idx').on(cols.parent),
pathIdx: index('path_idx').on(cols.path),
order: index(`${relationshipsTableName}_order_idx`).on(cols.order),
parentIdx: index(`${relationshipsTableName}_parent_idx`).on(cols.parent),
pathIdx: index(`${relationshipsTableName}_path_idx`).on(cols.path),
}
if (hasLocalizedRelationshipField) {
result.localeIdx = index('locale_idx').on(cols.locale)
result.localeIdx = index(`${relationshipsTableName}_locale_idx`).on(cols.locale)
}
return result
@@ -381,5 +384,5 @@ export const buildTable = ({
adapter.relations[`relations_${tableName}`] = tableRelations
return { hasManyTextField, hasManyNumberField, relationsToBuild }
return { hasManyNumberField, hasManyTextField, relationsToBuild }
}

View File

@@ -6,10 +6,11 @@ import type { GenericColumn } from '../types'
type CreateIndexArgs = {
columnName: string
name: string | string[]
tableName: string
unique?: boolean
}
export const createIndex = ({ name, columnName, unique }: CreateIndexArgs) => {
export const createIndex = ({ name, columnName, tableName, unique }: CreateIndexArgs) => {
return (table: { [x: string]: GenericColumn }) => {
let columns
if (Array.isArray(name)) {
@@ -20,7 +21,8 @@ export const createIndex = ({ name, columnName, unique }: CreateIndexArgs) => {
} else {
columns = [table[name]]
}
if (unique) return uniqueIndex(`${columnName}_idx`).on(columns[0], ...columns.slice(1))
return index(`${columnName}_idx`).on(columns[0], ...columns.slice(1))
if (unique)
return uniqueIndex(`${tableName}_${columnName}_idx`).on(columns[0], ...columns.slice(1))
return index(`${tableName}_${columnName}_idx`).on(columns[0], ...columns.slice(1))
}
}

View File

@@ -32,9 +32,9 @@ import { validateExistingBlockIsIdentical } from './validateExistingBlockIsIdent
type Args = {
adapter: PostgresAdapter
buildTexts: boolean
buildNumbers: boolean
buildRelationships: boolean
buildTexts: boolean
columnPrefix?: string
columns: Record<string, PgColumnBuilder>
disableNotNull: boolean
@@ -56,18 +56,18 @@ type Args = {
type Result = {
hasLocalizedField: boolean
hasLocalizedManyTextField: boolean
hasLocalizedManyNumberField: boolean
hasLocalizedManyTextField: boolean
hasLocalizedRelationshipField: boolean
hasManyTextField: 'index' | boolean
hasManyNumberField: 'index' | boolean
hasManyTextField: 'index' | boolean
}
export const traverseFields = ({
adapter,
buildTexts,
buildNumbers,
buildRelationships,
buildTexts,
columnPrefix,
columns,
disableNotNull,
@@ -122,7 +122,7 @@ export const traverseFields = ({
if (
(field.unique || field.index) &&
!['array', 'blocks', 'group', 'point', 'relationship', 'upload'].includes(field.type) &&
!(field.type === 'number' && field.hasMany === true)
!('hasMany' in field && field.hasMany === true)
) {
const unique = disableUnique !== true && field.unique
if (unique) {
@@ -132,9 +132,10 @@ export const traverseFields = ({
}
adapter.fieldConstraints[rootTableName][`${columnName}_idx`] = constraintValue
}
targetIndexes[`${field.name}Idx`] = createIndex({
targetIndexes[`${newTableName}_${field.name}Idx`] = createIndex({
name: fieldName,
columnName,
tableName: newTableName,
unique,
})
}
@@ -241,17 +242,18 @@ export const traverseFields = ({
string,
(cols: GenericColumns) => IndexBuilder | UniqueConstraintBuilder
> = {
orderIdx: (cols) => index('order_idx').on(cols.order),
parentIdx: (cols) => index('parent_idx').on(cols.parent),
orderIdx: (cols) => index(`${selectTableName}_order_idx`).on(cols.order),
parentIdx: (cols) => index(`${selectTableName}_parent_idx`).on(cols.parent),
}
if (field.localized) {
baseColumns.locale = adapter.enums.enum__locales('locale').notNull()
baseExtraConfig.localeIdx = (cols) => index('locale_idx').on(cols.locale)
baseExtraConfig.localeIdx = (cols) =>
index(`${selectTableName}_locale_idx`).on(cols.locale)
}
if (field.index) {
baseExtraConfig.value = (cols) => index('value_idx').on(cols.value)
baseExtraConfig.value = (cols) => index(`${selectTableName}_value_idx`).on(cols.value)
}
buildTable({
@@ -304,18 +306,19 @@ export const traverseFields = ({
string,
(cols: GenericColumns) => IndexBuilder | UniqueConstraintBuilder
> = {
_orderIdx: (cols) => index('_order_idx').on(cols._order),
_parentIDIdx: (cols) => index('_parent_id_idx').on(cols._parentID),
_orderIdx: (cols) => index(`${arrayTableName}_order_idx`).on(cols._order),
_parentIDIdx: (cols) => index(`${arrayTableName}_parent_id_idx`).on(cols._parentID),
}
if (field.localized && adapter.payload.config.localization) {
baseColumns._locale = adapter.enums.enum__locales('_locale').notNull()
baseExtraConfig._localeIdx = (cols) => index('_locale_idx').on(cols._locale)
baseExtraConfig._localeIdx = (cols) =>
index(`${arrayTableName}_locale_idx`).on(cols._locale)
}
const {
hasManyTextField: subHasManyTextField,
hasManyNumberField: subHasManyNumberField,
hasManyTextField: subHasManyTextField,
relationsToBuild: subRelationsToBuild,
} = buildTable({
adapter,
@@ -384,19 +387,20 @@ export const traverseFields = ({
string,
(cols: GenericColumns) => IndexBuilder | UniqueConstraintBuilder
> = {
_orderIdx: (cols) => index('order_idx').on(cols._order),
_parentIDIdx: (cols) => index('parent_id_idx').on(cols._parentID),
_pathIdx: (cols) => index('path_idx').on(cols._path),
_orderIdx: (cols) => index(`${blockTableName}_order_idx`).on(cols._order),
_parentIDIdx: (cols) => index(`${blockTableName}_parent_id_idx`).on(cols._parentID),
_pathIdx: (cols) => index(`${blockTableName}_path_idx`).on(cols._path),
}
if (field.localized && adapter.payload.config.localization) {
baseColumns._locale = adapter.enums.enum__locales('_locale').notNull()
baseExtraConfig._localeIdx = (cols) => index('locale_idx').on(cols._locale)
baseExtraConfig._localeIdx = (cols) =>
index(`${blockTableName}_locale_idx`).on(cols._locale)
}
const {
hasManyTextField: subHasManyTextField,
hasManyNumberField: subHasManyNumberField,
hasManyTextField: subHasManyTextField,
relationsToBuild: subRelationsToBuild,
} = buildTable({
adapter,
@@ -465,16 +469,16 @@ export const traverseFields = ({
if (!('name' in field)) {
const {
hasLocalizedField: groupHasLocalizedField,
hasLocalizedManyTextField: groupHasLocalizedManyTextField,
hasLocalizedManyNumberField: groupHasLocalizedManyNumberField,
hasLocalizedManyTextField: groupHasLocalizedManyTextField,
hasLocalizedRelationshipField: groupHasLocalizedRelationshipField,
hasManyTextField: groupHasManyTextField,
hasManyNumberField: groupHasManyNumberField,
hasManyTextField: groupHasManyTextField,
} = traverseFields({
adapter,
buildTexts,
buildNumbers,
buildRelationships,
buildTexts,
columnPrefix,
columns,
disableNotNull,
@@ -507,16 +511,16 @@ export const traverseFields = ({
const {
hasLocalizedField: groupHasLocalizedField,
hasLocalizedManyTextField: groupHasLocalizedManyTextField,
hasLocalizedManyNumberField: groupHasLocalizedManyNumberField,
hasLocalizedManyTextField: groupHasLocalizedManyTextField,
hasLocalizedRelationshipField: groupHasLocalizedRelationshipField,
hasManyTextField: groupHasManyTextField,
hasManyNumberField: groupHasManyNumberField,
hasManyTextField: groupHasManyTextField,
} = traverseFields({
adapter,
buildTexts,
buildNumbers,
buildRelationships,
buildTexts,
columnPrefix: `${columnName}_`,
columns,
disableNotNull: disableNotNullFromHere,
@@ -550,16 +554,16 @@ export const traverseFields = ({
const {
hasLocalizedField: tabHasLocalizedField,
hasLocalizedManyTextField: tabHasLocalizedManyTextField,
hasLocalizedManyNumberField: tabHasLocalizedManyNumberField,
hasLocalizedManyTextField: tabHasLocalizedManyTextField,
hasLocalizedRelationshipField: tabHasLocalizedRelationshipField,
hasManyTextField: tabHasManyTextField,
hasManyNumberField: tabHasManyNumberField,
hasManyTextField: tabHasManyTextField,
} = traverseFields({
adapter,
buildTexts,
buildNumbers,
buildRelationships,
buildTexts,
columnPrefix,
columns,
disableNotNull: disableNotNullFromHere,
@@ -593,16 +597,16 @@ export const traverseFields = ({
const disableNotNullFromHere = Boolean(field.admin?.condition) || disableNotNull
const {
hasLocalizedField: rowHasLocalizedField,
hasLocalizedManyTextField: rowHasLocalizedManyTextField,
hasLocalizedManyNumberField: rowHasLocalizedManyNumberField,
hasLocalizedManyTextField: rowHasLocalizedManyTextField,
hasLocalizedRelationshipField: rowHasLocalizedRelationshipField,
hasManyTextField: rowHasManyTextField,
hasManyNumberField: rowHasManyNumberField,
hasManyTextField: rowHasManyTextField,
} = traverseFields({
adapter,
buildTexts,
buildNumbers,
buildRelationships,
buildTexts,
columnPrefix,
columns,
disableNotNull: disableNotNullFromHere,
@@ -663,10 +667,10 @@ export const traverseFields = ({
return {
hasLocalizedField,
hasLocalizedManyTextField,
hasLocalizedManyNumberField,
hasLocalizedManyTextField,
hasLocalizedRelationshipField,
hasManyTextField,
hasManyNumberField,
hasManyTextField,
}
}

View File

@@ -1,6 +1,6 @@
{
"name": "payload",
"version": "2.9.0",
"version": "2.10.0",
"description": "Node, React and MongoDB Headless CMS and Application Framework",
"license": "MIT",
"main": "./dist/index.js",
@@ -59,7 +59,7 @@
"@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/core": "1.3.107",
"@swc/register": "0.1.10",
"body-parser": "1.20.2",
"body-scroll-lock": "4.0.0-beta.0",

View File

@@ -64,7 +64,7 @@ const DeleteDocument: React.FC<Props> = (props) => {
if (res.status < 400) {
setDeleting(false)
toggleModal(modalSlug)
toast.success(t('titleDeleted', { label: getTranslation(singular, i18n), title }))
toast.success(json.message || t('titleDeleted', { label: getTranslation(singular, i18n), title }))
return history.push(`${admin}/collections/${slug}`)
}

View File

@@ -33,7 +33,7 @@ export const DocumentControls: React.FC<{
id?: string
isAccountView?: boolean
isEditing?: boolean
permissions?: CollectionPermission | GlobalPermission | null
permissions?: CollectionPermission | GlobalPermission
}> = (props) => {
const {
id,

View File

@@ -12,42 +12,83 @@ import { fieldAffectsData, fieldHasSubFields, tabHasName } from '../../../../../
import getValueWithDefault from '../../../../../fields/getDefaultValue'
import { iterateFields } from './iterateFields'
type Args = {
export type AddFieldStatePromiseArgs = {
/**
* if all parents are localized, then the field is localized
*/
anyParentLocalized?: boolean
config: SanitizedConfig
data: Data
field: NonPresentationalField
/**
* You can use this to filter down to only `localized` fields that require transalation (type: text, textarea, etc.). Another plugin might want to look for only `point` type fields to do some GIS function. With the filter function you can go in like a surgeon.
*/
filter?: (args: AddFieldStatePromiseArgs) => boolean
/**
* Force the value of fields like arrays or blocks to be the full value instead of the length @default false
*/
forceFullValue?: boolean
fullData: Data
id: number | string
/**
* Whether the field schema should be included in the state
*/
includeSchema?: boolean
locale: string
/**
* Whether to omit parent fields in the state. @default false
*/
omitParents?: boolean
operation: 'create' | 'update'
passesCondition: boolean
path: string
preferences: {
[key: string]: unknown
}
/**
* Whether to skip checking the field's condition. @default false
*/
skipConditionChecks?: boolean
/**
* Whether to skip validating the field. @default false
*/
skipValidation?: boolean
state: Fields
t: TFunction
user: User
}
export const addFieldStatePromise = async ({
id,
config,
data,
field,
fullData,
locale,
operation,
passesCondition,
path,
preferences,
state,
t,
user,
}: Args): Promise<void> => {
/**
* Flattens the fields schema and fields data.
* The output is the field path (e.g. array.0.name) mapped to a FormField object.
*/
export const addFieldStatePromise = async (args: AddFieldStatePromiseArgs): Promise<void> => {
const {
id,
anyParentLocalized = false,
config,
data,
field,
filter,
forceFullValue = false,
fullData,
includeSchema = false,
locale,
omitParents = false,
operation,
passesCondition,
path,
preferences,
skipConditionChecks = false,
skipValidation = false,
state,
t,
user,
} = args
if (fieldAffectsData(field)) {
const fieldState: FormField = {
condition: field.admin?.condition,
fieldSchema: includeSchema ? field : undefined,
initialValue: undefined,
passesCondition,
valid: true,
@@ -66,9 +107,9 @@ export const addFieldStatePromise = async ({
data[field.name] = valueWithDefault
}
let validationResult: boolean | string = true
let validationResult: string | true = true
if (typeof fieldState.validate === 'function') {
if (typeof fieldState.validate === 'function' && !skipValidation) {
validationResult = await fieldState.validate(data?.[field.name], {
...field,
id,
@@ -96,24 +137,36 @@ export const addFieldStatePromise = async ({
const rowPath = `${path}${field.name}.${i}.`
row.id = row?.id || new ObjectID().toHexString()
state[`${rowPath}id`] = {
initialValue: row.id,
valid: true,
value: row.id,
if (!omitParents && (!filter || filter(args))) {
state[`${rowPath}id`] = {
fieldSchema: includeSchema
? field.fields.find((field) => 'name' in field && field.name === 'id')
: undefined,
initialValue: row.id,
valid: true,
value: row.id,
}
}
acc.promises.push(
iterateFields({
id,
anyParentLocalized: field.localized || anyParentLocalized,
config,
data: row,
fields: field.fields,
filter,
forceFullValue,
fullData,
includeSchema,
locale,
omitParents,
operation,
parentPassesCondition: passesCondition,
path: rowPath,
preferences,
skipConditionChecks,
skipValidation,
state,
t,
user,
@@ -146,8 +199,8 @@ export const addFieldStatePromise = async ({
fieldState.value = null
fieldState.initialValue = null
} else {
fieldState.value = arrayValue.length
fieldState.initialValue = arrayValue.length
fieldState.value = forceFullValue ? arrayValue : arrayValue.length
fieldState.initialValue = forceFullValue ? arrayValue : arrayValue.length
if (arrayValue.length > 0) {
fieldState.disableFormData = true
@@ -157,7 +210,9 @@ export const addFieldStatePromise = async ({
fieldState.rows = rowMetadata
// Add field to state
state[`${path}${field.name}`] = fieldState
if (!omitParents && (!filter || filter(args))) {
state[`${path}${field.name}`] = fieldState
}
break
}
@@ -173,36 +228,60 @@ export const addFieldStatePromise = async ({
if (block) {
row.id = row?.id || new ObjectID().toHexString()
state[`${rowPath}id`] = {
initialValue: row.id,
valid: true,
value: row.id,
}
if (!omitParents && (!filter || filter(args))) {
state[`${rowPath}id`] = {
fieldSchema: includeSchema
? block.fields.find(
(blockField) => 'name' in blockField && blockField.name === 'id',
)
: undefined,
initialValue: row.id,
valid: true,
value: row.id,
}
state[`${rowPath}blockType`] = {
initialValue: row.blockType,
valid: true,
value: row.blockType,
}
state[`${rowPath}blockType`] = {
fieldSchema: includeSchema
? block.fields.find(
(blockField) => 'name' in blockField && blockField.name === 'blockType',
)
: undefined,
initialValue: row.blockType,
valid: true,
value: row.blockType,
}
state[`${rowPath}blockName`] = {
initialValue: row.blockName,
valid: true,
value: row.blockName,
state[`${rowPath}blockName`] = {
fieldSchema: includeSchema
? block.fields.find(
(blockField) => 'name' in blockField && blockField.name === 'blockName',
)
: undefined,
initialValue: row.blockName,
valid: true,
value: row.blockName,
}
}
acc.promises.push(
iterateFields({
id,
anyParentLocalized: field.localized || anyParentLocalized,
config,
data: row,
fields: block.fields,
filter,
forceFullValue,
fullData,
includeSchema,
locale,
omitParents,
operation,
parentPassesCondition: passesCondition,
path: rowPath,
preferences,
skipConditionChecks,
skipValidation,
state,
t,
user,
@@ -237,8 +316,8 @@ export const addFieldStatePromise = async ({
fieldState.value = null
fieldState.initialValue = null
} else {
fieldState.value = blocksValue.length
fieldState.initialValue = blocksValue.length
fieldState.value = forceFullValue ? blocksValue : blocksValue.length
fieldState.initialValue = forceFullValue ? blocksValue : blocksValue.length
if (blocksValue.length > 0) {
fieldState.disableFormData = true
@@ -248,7 +327,9 @@ export const addFieldStatePromise = async ({
fieldState.rows = rowMetadata
// Add field to state
state[`${path}${field.name}`] = fieldState
if (!omitParents && (!filter || filter(args))) {
state[`${path}${field.name}`] = fieldState
}
break
}
@@ -256,15 +337,22 @@ export const addFieldStatePromise = async ({
case 'group': {
await iterateFields({
id,
anyParentLocalized: field.localized || anyParentLocalized,
config,
data: data?.[field.name] || {},
fields: field.fields,
filter,
forceFullValue,
fullData,
includeSchema,
locale,
omitParents,
operation,
parentPassesCondition: passesCondition,
path: `${path}${field.name}.`,
preferences,
skipConditionChecks,
skipValidation,
state,
t,
user,
@@ -324,7 +412,9 @@ export const addFieldStatePromise = async ({
fieldState.initialValue = relationshipValue
}
state[`${path}${field.name}`] = fieldState
if (!filter || filter(args)) {
state[`${path}${field.name}`] = fieldState
}
break
}
@@ -337,7 +427,9 @@ export const addFieldStatePromise = async ({
fieldState.value = relationshipValue
fieldState.initialValue = relationshipValue
state[`${path}${field.name}`] = fieldState
if (!filter || filter(args)) {
state[`${path}${field.name}`] = fieldState
}
break
}
@@ -347,7 +439,9 @@ export const addFieldStatePromise = async ({
fieldState.initialValue = valueWithDefault
// Add field to state
state[`${path}${field.name}`] = fieldState
if (!filter || filter(args)) {
state[`${path}${field.name}`] = fieldState
}
break
}
@@ -356,15 +450,22 @@ export const addFieldStatePromise = async ({
// Handle field types that do not use names (row, etc)
await iterateFields({
id,
anyParentLocalized: field.localized || anyParentLocalized,
config,
data,
fields: field.fields,
filter,
forceFullValue,
fullData,
includeSchema,
locale,
omitParents,
operation,
parentPassesCondition: passesCondition,
path,
preferences,
skipConditionChecks,
skipValidation,
state,
t,
user,
@@ -373,15 +474,22 @@ export const addFieldStatePromise = async ({
const promises = field.tabs.map((tab) =>
iterateFields({
id,
anyParentLocalized: tab.localized || anyParentLocalized,
config,
data: tabHasName(tab) ? data?.[tab.name] : data,
fields: tab.fields,
filter,
forceFullValue,
fullData,
includeSchema,
locale,
omitParents,
operation,
parentPassesCondition: passesCondition,
path: tabHasName(tab) ? `${path}${tab.name}.` : path,
preferences,
skipConditionChecks,
skipValidation,
state,
t,
user,

View File

@@ -4,65 +4,123 @@ import type { User } from '../../../../../auth'
import type { SanitizedConfig } from '../../../../../config/types'
import type { Field as FieldSchema } from '../../../../../fields/config/types'
import type { Data, Fields } from '../types'
import type { AddFieldStatePromiseArgs } from './addFieldStatePromise'
import { fieldIsPresentationalOnly } from '../../../../../fields/config/types'
import { addFieldStatePromise } from './addFieldStatePromise'
type Args = {
config: SanitizedConfig
/**
* if any parents is localized, then the field is localized. @default false
*/
anyParentLocalized?: boolean
/**
* config is only needed for validation
*/
config?: SanitizedConfig
data: Data
fields: FieldSchema[]
filter?: (args: AddFieldStatePromiseArgs) => boolean
/**
* Force the value of fields like arrays or blocks to be the full value instead of the length @default false
*/
forceFullValue?: boolean
fullData: Data
id: number | string
id?: number | string
/**
* Whether the field schema should be included in the state. @default false
*/
includeSchema?: boolean
/**
* operation is only needed for checking field conditions
*/
locale: string
/**
* Whether to omit parent fields in the state. @default false
*/
omitParents?: boolean
/**
* operation is only needed for validation
*/
operation: 'create' | 'update'
parentPassesCondition: boolean
path: string
preferences: {
parentPassesCondition?: boolean
/**
* The initial path of the field. @default ''
*/
path?: string
preferences?: {
[key: string]: unknown
}
state: Fields
/**
* Whether to skip checking the field's condition. @default false
*/
skipConditionChecks?: boolean
/**
* Whether to skip validating the field. @default false
*/
skipValidation?: boolean
state?: Fields
t: TFunction
user: User
}
/**
* Flattens the fields schema and fields data
*/
export const iterateFields = async ({
id,
anyParentLocalized = false,
config,
data,
fields,
filter,
forceFullValue = false,
fullData,
includeSchema = false,
locale,
omitParents = false,
operation,
parentPassesCondition,
parentPassesCondition = true,
path = '',
preferences,
state,
skipConditionChecks = false,
skipValidation = false,
state = {},
t,
user,
}: Args): Promise<void> => {
const promises = []
fields.forEach((field) => {
const initialData = data
if (!fieldIsPresentationalOnly(field) && !field?.admin?.disabled) {
const passesCondition = Boolean(
(field?.admin?.condition
? Boolean(field.admin.condition(fullData || {}, initialData || {}, { user }))
: true) && parentPassesCondition,
)
let passesCondition = true
if (!skipConditionChecks) {
passesCondition = Boolean(
(field?.admin?.condition
? Boolean(field.admin.condition(fullData || {}, data || {}, { user }))
: true) && parentPassesCondition,
)
}
promises.push(
addFieldStatePromise({
id,
anyParentLocalized,
config,
data,
field,
filter,
forceFullValue,
fullData,
includeSchema,
locale,
omitParents,
operation,
passesCondition,
path,
preferences,
skipConditionChecks,
skipValidation,
state,
t,
user,

View File

@@ -2,11 +2,22 @@ import { unflatten as flatleyUnflatten } from 'flatley'
import type { Data, Fields } from './types'
const reduceFieldsToValues = (fields: Fields, unflatten?: boolean): Data => {
/**
* Reduce flattened form fields (Fields) to just map to the respective values instead of the full FormField object
*
* @param unflatten This also unflattens the data if `unflatten` is true. The unflattened data should match the original data structure
* @param ignoreDisableFormData - if true, will include fields that have `disableFormData` set to true, for example, blocks or arrays fields.
*
*/
const reduceFieldsToValues = (
fields: Fields,
unflatten?: boolean,
ignoreDisableFormData?: boolean,
): Data => {
const data = {}
Object.keys(fields).forEach((key) => {
if (!fields[key].disableFormData) {
if (ignoreDisableFormData === true || !fields[key].disableFormData) {
data[key] = fields[key].value
}
})

View File

@@ -20,6 +20,7 @@ export type FormField = {
condition?: Condition
disableFormData?: boolean
errorMessage?: string
fieldSchema?: FieldConfig
initialValue: unknown
passesCondition?: boolean
rows?: Row[]

View File

@@ -29,9 +29,14 @@ type RichTextAdapterBase<
}) => Promise<void> | null
outputSchema?: ({
field,
interfaceNameDefinitions,
isRequired,
}: {
field: RichTextField<Value, AdapterProps, ExtraFieldProperties>
/**
* Allows you to define new top-level interfaces that can be re-used in the output schema.
*/
interfaceNameDefinitions: Map<string, JSONSchema4>
isRequired: boolean
}) => JSONSchema4
populationPromise?: (data: {

View File

@@ -40,7 +40,6 @@ export const DocumentInfoProvider: React.FC<Props> = ({
const [publishedDoc, setPublishedDoc] = useState<TypeWithID & TypeWithTimestamps>(null)
const [versions, setVersions] = useState<PaginatedDocs<Version>>(null)
const [unpublishedVersions, setUnpublishedVersions] = useState<PaginatedDocs<Version>>(null)
const [docPermissions, setDocPermissions] = useState<DocumentPermissions>(null)
const baseURL = `${serverURL}${api}`
let slug: string
@@ -62,6 +61,10 @@ export const DocumentInfoProvider: React.FC<Props> = ({
}
}
const [docPermissions, setDocPermissions] = useState<DocumentPermissions>(
permissions[pluralType][slug],
)
const getVersions = useCallback(async () => {
let versionFetchURL
let publishedFetchURL
@@ -215,14 +218,14 @@ export const DocumentInfoProvider: React.FC<Props> = ({
'Accept-Language': i18n.language,
},
})
const json = await res.json()
setDocPermissions(json)
} else {
// fallback to permissions from the entity type
// (i.e. create has no id)
setDocPermissions(permissions[pluralType][slug])
try {
const json = await res.json()
setDocPermissions(json)
} catch (e) {
console.error('Unable to fetch document permissions', e)
}
}
}, [serverURL, api, pluralType, slug, id, permissions, i18n.language, code])
}, [serverURL, api, pluralType, slug, id, i18n.language, code])
const getDocPreferences = useCallback(async () => {
return getPreference<DocumentPreferences>(preferencesKey)
@@ -262,6 +265,7 @@ export const DocumentInfoProvider: React.FC<Props> = ({
const value: ContextType = {
id,
slug,
collection,
docPermissions,
getDocPermissions,
@@ -271,7 +275,6 @@ export const DocumentInfoProvider: React.FC<Props> = ({
preferencesKey,
publishedDoc,
setDocFieldPreferences,
slug,
unpublishedVersions,
versions,
}

View File

@@ -12,7 +12,7 @@ import type { TypeWithVersion } from '../../../../versions/types'
export type Version = TypeWithVersion<any>
export type DocumentPermissions = CollectionPermission | GlobalPermission | null
export type DocumentPermissions = CollectionPermission | GlobalPermission
export type ContextType = {
collection?: SanitizedCollectionConfig

View File

@@ -29,37 +29,38 @@ async function forgotPassword(incomingArgs: Arguments): Promise<null | string> {
let args = incomingArgs
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection?.config,
context: args.req.context,
operation: 'forgotPassword',
})) || args
}, Promise.resolve())
const {
collection: { config: collectionConfig },
data,
disableEmail,
expiration,
req: {
payload: { config, emailOptions, sendEmail: email },
payload,
t,
},
req,
} = args
try {
const shouldCommit = await initTransaction(req)
const shouldCommit = await initTransaction(args.req)
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection?.config,
context: args.req.context,
operation: 'forgotPassword',
req: args.req,
})) || args
}, Promise.resolve())
const {
collection: { config: collectionConfig },
data,
disableEmail,
expiration,
req: {
payload: { config, emailOptions, sendEmail: email },
payload,
t,
},
req,
} = args
// /////////////////////////////////////
// Forget password
@@ -159,7 +160,7 @@ async function forgotPassword(incomingArgs: Arguments): Promise<null | string> {
return token
} catch (error: unknown) {
await killTransaction(req)
await killTransaction(args.req)
throw error
}
}

View File

@@ -3,10 +3,8 @@ import type { PayloadRequest } from '../../../express/types'
import type { Payload } from '../../../payload'
import type { Result } from '../forgotPassword'
import { getDataLoader } from '../../../collections/dataloader'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { createLocalReq } from '../../../utilities/createLocalReq'
import forgotPassword from '../forgotPassword'
export type Options<T extends keyof GeneratedTypes['collections']> = {
@@ -24,15 +22,7 @@ async function localForgotPassword<T extends keyof GeneratedTypes['collections']
payload: Payload,
options: Options<T>,
): Promise<Result> {
const {
collection: collectionSlug,
context,
data,
disableEmail,
expiration,
req = {} as PayloadRequest,
} = options
setRequestContext(req, context)
const { collection: collectionSlug, data, disableEmail, expiration } = options
const collection = payload.collections[collectionSlug]
@@ -44,12 +34,7 @@ async function localForgotPassword<T extends keyof GeneratedTypes['collections']
)
}
req.payloadAPI = req.payloadAPI || 'local'
req.payload = payload
req.i18n = i18nInit(payload.config.i18n)
if (!req.t) req.t = req.i18n.t
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
return forgotPassword({
collection,

View File

@@ -5,10 +5,8 @@ import type { GeneratedTypes } from '../../../index'
import type { Payload } from '../../../payload'
import type { Result } from '../login'
import { getDataLoader } from '../../../collections/dataloader'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { createLocalReq } from '../../../utilities/createLocalReq'
import login from '../login'
export type Options<TSlug extends keyof GeneratedTypes['collections']> = {
@@ -33,25 +31,14 @@ async function localLogin<TSlug extends keyof GeneratedTypes['collections']>(
): Promise<Result & { user: GeneratedTypes['collections'][TSlug] }> {
const {
collection: collectionSlug,
context,
data,
depth,
fallbackLocale: fallbackLocaleArg = options?.req?.fallbackLocale,
locale: localeArg = null,
overrideAccess = true,
req = {} as PayloadRequest,
res,
showHiddenFields,
} = options
setRequestContext(req, context)
const collection = payload.collections[collectionSlug]
const localizationConfig = payload?.config?.localization
const defaultLocale = localizationConfig ? localizationConfig.defaultLocale : null
const locale = localeArg || req?.locale || defaultLocale
const fallbackLocale = localizationConfig
? localizationConfig.locales.find(({ code }) => locale === code)?.fallbackLocale
: null
if (!collection) {
throw new APIError(
@@ -59,12 +46,7 @@ async function localLogin<TSlug extends keyof GeneratedTypes['collections']>(
)
}
req.payloadAPI = req.payloadAPI || 'local'
req.payload = payload
req.i18n = i18nInit(payload.config.i18n)
if (!req.t) req.t = req.i18n.t
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
const args = {
collection,
@@ -76,12 +58,6 @@ async function localLogin<TSlug extends keyof GeneratedTypes['collections']>(
showHiddenFields,
}
if (locale) args.req.locale = locale
if (fallbackLocale) {
args.req.fallbackLocale =
typeof fallbackLocaleArg !== 'undefined' ? fallbackLocaleArg : fallbackLocale || defaultLocale
}
return login<TSlug>(args)
}

View File

@@ -3,10 +3,8 @@ import type { PayloadRequest } from '../../../express/types'
import type { Payload } from '../../../payload'
import type { Result } from '../resetPassword'
import { getDataLoader } from '../../../collections/dataloader'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { createLocalReq } from '../../../utilities/createLocalReq'
import resetPassword from '../resetPassword'
export type Options<T extends keyof GeneratedTypes['collections']> = {
@@ -24,15 +22,7 @@ async function localResetPassword<T extends keyof GeneratedTypes['collections']>
payload: Payload,
options: Options<T>,
): Promise<Result> {
const {
collection: collectionSlug,
context,
data,
overrideAccess,
req = {} as PayloadRequest,
} = options
setRequestContext(req, context)
const { collection: collectionSlug, data, overrideAccess } = options
const collection = payload.collections[collectionSlug]
@@ -44,12 +34,7 @@ async function localResetPassword<T extends keyof GeneratedTypes['collections']>
)
}
req.payload = payload
req.payloadAPI = req.payloadAPI || 'local'
req.i18n = i18nInit(payload.config.i18n)
if (!req.t) req.t = req.i18n.t
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
return resetPassword({
collection,

View File

@@ -2,10 +2,8 @@ import type { GeneratedTypes, RequestContext } from '../../../'
import type { PayloadRequest } from '../../../express/types'
import type { Payload } from '../../../payload'
import { getDataLoader } from '../../../collections/dataloader'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { createLocalReq } from '../../../utilities/createLocalReq'
import unlock from '../unlock'
export type Options<T extends keyof GeneratedTypes['collections']> = {
@@ -22,14 +20,7 @@ async function localUnlock<T extends keyof GeneratedTypes['collections']>(
payload: Payload,
options: Options<T>,
): Promise<boolean> {
const {
collection: collectionSlug,
context,
data,
overrideAccess = true,
req = {} as PayloadRequest,
} = options
setRequestContext(req, context)
const { collection: collectionSlug, data, overrideAccess = true } = options
const collection = payload.collections[collectionSlug]
@@ -39,12 +30,7 @@ async function localUnlock<T extends keyof GeneratedTypes['collections']>(
)
}
req.payload = payload
req.payloadAPI = req.payloadAPI || 'local'
req.i18n = i18nInit(payload.config.i18n)
if (!req.t) req.t = req.i18n.t
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
return unlock({
collection,

View File

@@ -3,8 +3,7 @@ import type { PayloadRequest } from '../../../express/types'
import type { Payload } from '../../../payload'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { createLocalReq } from '../../../utilities/createLocalReq'
import verifyEmail from '../verifyEmail'
export type Options<T extends keyof GeneratedTypes['collections']> = {
@@ -18,8 +17,7 @@ async function localVerifyEmail<T extends keyof GeneratedTypes['collections']>(
payload: Payload,
options: Options<T>,
): Promise<boolean> {
const { collection: collectionSlug, context, req = {} as PayloadRequest, token } = options
setRequestContext(req, context)
const { collection: collectionSlug, token } = options
const collection = payload.collections[collectionSlug]
@@ -29,9 +27,7 @@ async function localVerifyEmail<T extends keyof GeneratedTypes['collections']>(
)
}
req.payload = payload
req.payloadAPI = req.payloadAPI || 'local'
req.i18n = i18nInit(payload.config.i18n)
const req = createLocalReq(options, payload)
return verifyEmail({
collection,

View File

@@ -45,37 +45,38 @@ async function login<TSlug extends keyof GeneratedTypes['collections']>(
): Promise<Result & { user: GeneratedTypes['collections'][TSlug] }> {
let args = incomingArgs
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection?.config,
context: args.req.context,
operation: 'login',
})) || args
}, Promise.resolve())
const {
collection: { config: collectionConfig },
data,
depth,
overrideAccess,
req,
req: {
payload,
payload: { config, secret },
},
showHiddenFields,
} = args
try {
const shouldCommit = await initTransaction(req)
const shouldCommit = await initTransaction(args.req)
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection?.config,
context: args.req.context,
operation: 'login',
req: args.req,
})) || args
}, Promise.resolve())
const {
collection: { config: collectionConfig },
data,
depth,
overrideAccess,
req,
req: {
payload,
payload: { config, secret },
},
showHiddenFields,
} = args
// /////////////////////////////////////
// Login
@@ -262,7 +263,7 @@ async function login<TSlug extends keyof GeneratedTypes['collections']>(
return result
} catch (error: unknown) {
await killTransaction(req)
await killTransaction(args.req)
throw error
}
}

View File

@@ -9,7 +9,10 @@ import type { Document } from '../../types'
import { buildAfterOperation } from '../../collections/operations/utils'
import { Forbidden } from '../../errors'
import { commitTransaction } from '../../utilities/commitTransaction'
import getCookieExpiration from '../../utilities/getCookieExpiration'
import { initTransaction } from '../../utilities/initTransaction'
import { killTransaction } from '../../utilities/killTransaction'
import { getFieldsToSign } from './getFieldsToSign'
export type Result = {
@@ -28,120 +31,130 @@ export type Arguments = {
async function refresh(incomingArgs: Arguments): Promise<Result> {
let args = incomingArgs
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
try {
const shouldCommit = await initTransaction(args.req)
await args.collection.config.hooks.beforeOperation.reduce(
async (priorHook: BeforeOperationHook | Promise<void>, hook: BeforeOperationHook) => {
await priorHook
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
args =
(await hook({
args,
collection: args.collection?.config,
context: args.req.context,
operation: 'refresh',
})) || args
},
Promise.resolve(),
)
await args.collection.config.hooks.beforeOperation.reduce(
async (priorHook: BeforeOperationHook | Promise<void>, hook: BeforeOperationHook) => {
await priorHook
// /////////////////////////////////////
// Refresh
// /////////////////////////////////////
args =
(await hook({
args,
collection: args.collection?.config,
context: args.req.context,
operation: 'refresh',
req: args.req,
})) || args
},
Promise.resolve(),
)
const {
collection: { config: collectionConfig },
req: {
payload: { config, secret },
},
} = args
// /////////////////////////////////////
// Refresh
// /////////////////////////////////////
if (typeof args.token !== 'string' || !args.req.user) throw new Forbidden(args.req.t)
const {
collection: { config: collectionConfig },
req: {
payload: { config, secret },
},
} = args
const parsedURL = url.parse(args.req.url)
const isGraphQL = parsedURL.pathname === config.routes.graphQL
if (typeof args.token !== 'string' || !args.req.user) throw new Forbidden(args.req.t)
const user = await args.req.payload.findByID({
id: args.req.user.id,
collection: args.req.user.collection,
depth: isGraphQL ? 0 : args.collection.config.auth.depth,
req: args.req,
})
const parsedURL = url.parse(args.req.url)
const isGraphQL = parsedURL.pathname === config.routes.graphQL
const fieldsToSign = getFieldsToSign({
collectionConfig,
email: user?.email as string,
user: args?.req?.user,
})
const user = await args.req.payload.findByID({
id: args.req.user.id,
collection: args.req.user.collection,
depth: isGraphQL ? 0 : args.collection.config.auth.depth,
req: args.req,
})
const refreshedToken = jwt.sign(fieldsToSign, secret, {
expiresIn: collectionConfig.auth.tokenExpiration,
})
const fieldsToSign = getFieldsToSign({
collectionConfig,
email: user?.email as string,
user: args?.req?.user,
})
const exp = (jwt.decode(refreshedToken) as Record<string, unknown>).exp as number
const refreshedToken = jwt.sign(fieldsToSign, secret, {
expiresIn: collectionConfig.auth.tokenExpiration,
})
if (args.res) {
const cookieOptions = {
domain: undefined,
expires: getCookieExpiration(collectionConfig.auth.tokenExpiration),
httpOnly: true,
path: '/',
sameSite: collectionConfig.auth.cookies.sameSite,
secure: collectionConfig.auth.cookies.secure,
const exp = (jwt.decode(refreshedToken) as Record<string, unknown>).exp as number
if (args.res) {
const cookieOptions = {
domain: undefined,
expires: getCookieExpiration(collectionConfig.auth.tokenExpiration),
httpOnly: true,
path: '/',
sameSite: collectionConfig.auth.cookies.sameSite,
secure: collectionConfig.auth.cookies.secure,
}
if (collectionConfig.auth.cookies.domain)
cookieOptions.domain = collectionConfig.auth.cookies.domain
args.res.cookie(`${config.cookiePrefix}-token`, refreshedToken, cookieOptions)
}
if (collectionConfig.auth.cookies.domain)
cookieOptions.domain = collectionConfig.auth.cookies.domain
let result: Result = {
exp,
refreshedToken,
user,
}
args.res.cookie(`${config.cookiePrefix}-token`, refreshedToken, cookieOptions)
// /////////////////////////////////////
// After Refresh - Collection
// /////////////////////////////////////
await collectionConfig.hooks.afterRefresh.reduce(async (priorHook, hook) => {
await priorHook
result =
(await hook({
collection: args.collection?.config,
context: args.req.context,
exp,
req: args.req,
res: args.res,
token: refreshedToken,
})) || result
}, Promise.resolve())
// /////////////////////////////////////
// afterOperation - Collection
// /////////////////////////////////////
result = await buildAfterOperation({
args,
collection: args.collection?.config,
operation: 'refresh',
result,
})
// /////////////////////////////////////
// Return results
// /////////////////////////////////////
if (collectionConfig.auth.removeTokenFromResponses) {
delete result.refreshedToken
}
if (shouldCommit) await commitTransaction(args.req)
return result
} catch (error: unknown) {
await killTransaction(args.req)
throw error
}
let result: Result = {
exp,
refreshedToken,
user,
}
// /////////////////////////////////////
// After Refresh - Collection
// /////////////////////////////////////
await collectionConfig.hooks.afterRefresh.reduce(async (priorHook, hook) => {
await priorHook
result =
(await hook({
collection: args.collection?.config,
context: args.req.context,
exp,
req: args.req,
res: args.res,
token: refreshedToken,
})) || result
}, Promise.resolve())
// /////////////////////////////////////
// afterOperation - Collection
// /////////////////////////////////////
result = await buildAfterOperation({
args,
collection: args.collection?.config,
operation: 'refresh',
result,
})
// /////////////////////////////////////
// Return results
// /////////////////////////////////////
if (collectionConfig.auth.removeTokenFromResponses) {
delete result.refreshedToken
}
return result
}
export default refresh

View File

@@ -31,6 +31,10 @@ export async function generateTypes(): Promise<void> {
style: {
singleQuote: true,
},
// Generates code for $defs that aren't referenced by the schema. Reason:
// If a field defines an interfaceName, it should be included in the generated types
// even if it's not used by another type. Reason: the user might want to use it in their own code.
unreachableDefinitions: true,
}).then((compiled) => {
if (config.typescript.declare !== false) {
compiled += `\n\n${declare}`

View File

@@ -45,7 +45,7 @@ if (tsConfig?.config?.compilerOptions?.paths) {
// Allow disabling SWC for debugging
if (process.env.DISABLE_SWC !== 'true') {
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore - bad @swc/register types
// @ts-expect-error - bad @swc/register types
swcRegister(swcOptions)
}

View File

@@ -48,6 +48,7 @@ export type BeforeOperationHook = (args: {
* Hook operation being performed
*/
operation: HookOperationType
req: PayloadRequest
}) => any
export type BeforeValidateHook<T extends TypeWithID = any> = (args: {

View File

@@ -55,44 +55,45 @@ async function create<TSlug extends keyof GeneratedTypes['collections']>(
): Promise<GeneratedTypes['collections'][TSlug]> {
let args = incomingArgs
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(
async (priorHook: BeforeOperationHook | Promise<void>, hook: BeforeOperationHook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'create',
})) || args
},
Promise.resolve(),
)
const {
autosave = false,
collection: { config: collectionConfig },
collection,
depth,
disableVerificationEmail,
draft = false,
overrideAccess,
overwriteExistingFiles = false,
req: {
payload,
payload: { config, emailOptions },
},
req,
showHiddenFields,
} = args
try {
const shouldCommit = await initTransaction(req)
const shouldCommit = await initTransaction(args.req)
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(
async (priorHook: BeforeOperationHook | Promise<void>, hook: BeforeOperationHook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'create',
req: args.req,
})) || args
},
Promise.resolve(),
)
const {
autosave = false,
collection: { config: collectionConfig },
collection,
depth,
disableVerificationEmail,
draft = false,
overrideAccess,
overwriteExistingFiles = false,
req: {
payload,
payload: { config, emailOptions },
},
req,
showHiddenFields,
} = args
let { data } = args
@@ -367,7 +368,7 @@ async function create<TSlug extends keyof GeneratedTypes['collections']>(
return result
} catch (error: unknown) {
await killTransaction(req)
await killTransaction(args.req)
throw error
}
}

View File

@@ -39,42 +39,42 @@ async function deleteOperation<TSlug extends keyof GeneratedTypes['collections']
}> {
let args = incomingArgs
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(
async (priorHook: BeforeOperationHook | Promise<void>, hook: BeforeOperationHook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'delete',
})) || args
},
Promise.resolve(),
)
const {
collection: { config: collectionConfig },
depth,
overrideAccess,
req: {
locale,
payload: { config },
payload,
t,
},
req,
showHiddenFields,
where,
} = args
try {
const shouldCommit = await initTransaction(req)
const shouldCommit = await initTransaction(args.req)
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(
async (priorHook: BeforeOperationHook | Promise<void>, hook: BeforeOperationHook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'delete',
req: args.req,
})) || args
},
Promise.resolve(),
)
const {
collection: { config: collectionConfig },
depth,
overrideAccess,
req: {
locale,
payload: { config },
payload,
t,
},
req,
showHiddenFields,
where,
} = args
if (!where) {
throw new APIError("Missing 'where' query of documents to delete.", httpStatus.BAD_REQUEST)
@@ -264,7 +264,7 @@ async function deleteOperation<TSlug extends keyof GeneratedTypes['collections']
return result
} catch (error: unknown) {
await killTransaction(req)
await killTransaction(args.req)
throw error
}
}

View File

@@ -30,41 +30,42 @@ async function deleteByID<TSlug extends keyof GeneratedTypes['collections']>(
): Promise<Document> {
let args = incomingArgs
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(
async (priorHook: BeforeOperationHook | Promise<void>, hook: BeforeOperationHook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'delete',
})) || args
},
Promise.resolve(),
)
const {
id,
collection: { config: collectionConfig },
depth,
overrideAccess,
req: {
payload: { config },
payload,
t,
},
req,
showHiddenFields,
} = args
try {
const shouldCommit = await initTransaction(req)
const shouldCommit = await initTransaction(args.req)
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(
async (priorHook: BeforeOperationHook | Promise<void>, hook: BeforeOperationHook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'delete',
req: args.req,
})) || args
},
Promise.resolve(),
)
const {
id,
collection: { config: collectionConfig },
depth,
overrideAccess,
req: {
payload: { config },
payload,
t,
},
req,
showHiddenFields,
} = args
// /////////////////////////////////////
// Access
@@ -213,7 +214,7 @@ async function deleteByID<TSlug extends keyof GeneratedTypes['collections']>(
return result
} catch (error: unknown) {
await killTransaction(req)
await killTransaction(args.req)
throw error
}
}

View File

@@ -37,42 +37,43 @@ async function find<T extends TypeWithID & Record<string, unknown>>(
): Promise<PaginatedDocs<T>> {
let args = incomingArgs
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'read',
})) || args
}, Promise.resolve())
const {
collection: { config: collectionConfig },
collection,
currentDepth,
depth,
disableErrors,
draft: draftsEnabled,
limit,
overrideAccess,
page,
pagination = true,
req: { locale, payload },
req,
showHiddenFields,
sort,
where,
} = args
try {
const shouldCommit = await initTransaction(req)
const shouldCommit = await initTransaction(args.req)
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'read',
req: args.req,
})) || args
}, Promise.resolve())
const {
collection: { config: collectionConfig },
collection,
currentDepth,
depth,
disableErrors,
draft: draftsEnabled,
limit,
overrideAccess,
page,
pagination = true,
req: { locale, payload },
req,
showHiddenFields,
sort,
where,
} = args
// /////////////////////////////////////
// Access
@@ -253,7 +254,7 @@ async function find<T extends TypeWithID & Record<string, unknown>>(
return result
} catch (error: unknown) {
await killTransaction(req)
await killTransaction(args.req)
throw error
}
}

View File

@@ -30,38 +30,39 @@ export type Arguments = {
async function findByID<T extends TypeWithID>(incomingArgs: Arguments): Promise<T> {
let args = incomingArgs
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'read',
})) || args
}, Promise.resolve())
const {
id,
collection: { config: collectionConfig },
currentDepth,
depth,
disableErrors,
draft: draftEnabled = false,
overrideAccess = false,
req: { locale, t },
req,
showHiddenFields,
} = args
try {
const shouldCommit = await initTransaction(req)
const { transactionID } = req
const shouldCommit = await initTransaction(args.req)
const { transactionID } = args.req
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'read',
req: args.req,
})) || args
}, Promise.resolve())
const {
id,
collection: { config: collectionConfig },
currentDepth,
depth,
disableErrors,
draft: draftEnabled = false,
overrideAccess = false,
req: { locale, t },
req,
showHiddenFields,
} = args
// /////////////////////////////////////
// Access
@@ -204,7 +205,7 @@ async function findByID<T extends TypeWithID>(incomingArgs: Arguments): Promise<
return result
} catch (error: unknown) {
await killTransaction(req)
await killTransaction(args.req)
throw error
}
}

View File

@@ -8,10 +8,8 @@ import type { Document } from '../../../types'
import type { File } from '../../../uploads/types'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import getFileByPath from '../../../uploads/getFileByPath'
import { getDataLoader } from '../../dataloader'
import { createLocalReq } from '../../../utilities/createLocalReq'
import create from '../create'
export type Options<TSlug extends keyof GeneratedTypes['collections']> = {
@@ -44,30 +42,17 @@ export default async function createLocal<TSlug extends keyof GeneratedTypes['co
): Promise<GeneratedTypes['collections'][TSlug]> {
const {
collection: collectionSlug,
context,
data,
depth,
disableVerificationEmail,
draft,
fallbackLocale: fallbackLocaleArg = options?.req?.fallbackLocale,
file,
filePath,
locale: localeArg = null,
overrideAccess = true,
overwriteExistingFiles = false,
req = {} as PayloadRequest,
showHiddenFields,
user,
} = options
setRequestContext(req, context)
const collection = payload.collections[collectionSlug]
const localizationConfig = payload?.config?.localization
const defaultLocale = localizationConfig ? localizationConfig.defaultLocale : null
const locale = localeArg || req.locale || defaultLocale
const fallbackLocale = localizationConfig
? localizationConfig.locales.find(({ code }) => locale === code)?.fallbackLocale
: null
if (!collection) {
throw new APIError(
@@ -75,21 +60,18 @@ export default async function createLocal<TSlug extends keyof GeneratedTypes['co
)
}
req.payloadAPI = req.payloadAPI || 'local'
req.locale = locale
req.fallbackLocale =
typeof fallbackLocaleArg !== 'undefined' ? fallbackLocaleArg : fallbackLocale || defaultLocale
req.payload = payload
req.i18n = i18nInit(payload.config.i18n)
req.files = {
file: (file ?? (await getFileByPath(filePath))) as UploadedFile,
const req = createLocalReq(options, payload)
const fileToSet = (file ?? (await getFileByPath(filePath))) as UploadedFile
if (fileToSet) {
if (req?.files) {
req.files.file = fileToSet
} else {
req.files = {
file: fileToSet,
}
}
}
if (typeof user !== 'undefined') req.user = user
if (!req.t) req.t = req.i18n.t
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
return create<TSlug>({
collection,
data,

View File

@@ -5,9 +5,7 @@ import type { Document, Where } from '../../../types'
import type { BulkOperationResult } from '../../config/types'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { getDataLoader } from '../../dataloader'
import { createLocalReq } from '../../../utilities/createLocalReq'
import deleteOperation from '../delete'
import deleteByID from '../deleteByID'
@@ -59,24 +57,13 @@ async function deleteLocal<TSlug extends keyof GeneratedTypes['collections']>(
const {
id,
collection: collectionSlug,
context,
depth,
fallbackLocale: fallbackLocaleArg = options?.req?.fallbackLocale,
locale: localeArg = null,
overrideAccess = true,
req: incomingReq = {} as PayloadRequest,
showHiddenFields,
user,
where,
} = options
const collection = payload.collections[collectionSlug]
const localizationConfig = payload?.config?.localization
const defaultLocale = localizationConfig ? localizationConfig.defaultLocale : null
const locale = localeArg || incomingReq?.locale || defaultLocale
const fallbackLocale = localizationConfig
? localizationConfig.locales.find(({ code }) => locale === code)?.fallbackLocale
: null
if (!collection) {
throw new APIError(
@@ -84,22 +71,7 @@ async function deleteLocal<TSlug extends keyof GeneratedTypes['collections']>(
)
}
const req = {
fallbackLocale:
typeof fallbackLocaleArg !== 'undefined'
? fallbackLocaleArg
: fallbackLocale || defaultLocale,
i18n: i18nInit(payload.config.i18n),
locale: locale,
payload,
payloadAPI: 'local',
transactionID: incomingReq?.transactionID,
user,
} as PayloadRequest
setRequestContext(req, context)
if (!req.t) req.t = req.i18n.t
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
const args = {
id,

View File

@@ -5,9 +5,7 @@ import type { Payload } from '../../../payload'
import type { Document, Where } from '../../../types'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { getDataLoader } from '../../dataloader'
import { createLocalReq } from '../../../utilities/createLocalReq'
import find from '../find'
export type Options<T extends keyof GeneratedTypes['collections']> = {
@@ -39,32 +37,20 @@ export default async function findLocal<T extends keyof GeneratedTypes['collecti
): Promise<PaginatedDocs<GeneratedTypes['collections'][T]>> {
const {
collection: collectionSlug,
context,
currentDepth,
depth,
disableErrors,
draft = false,
fallbackLocale: fallbackLocaleArg = options?.req?.fallbackLocale,
limit,
locale: localeArg = null,
overrideAccess = true,
page,
pagination = true,
req = {} as PayloadRequest,
showHiddenFields,
sort,
user,
where,
} = options
setRequestContext(req, context)
const collection = payload.collections[collectionSlug]
const localizationConfig = payload?.config?.localization
const defaultLocale = localizationConfig ? localizationConfig.defaultLocale : null
const locale = localeArg || req.locale || defaultLocale
const fallbackLocale = localizationConfig
? localizationConfig.locales.find(({ code }) => locale === code)?.fallbackLocale
: null
if (!collection) {
throw new APIError(
@@ -72,17 +58,7 @@ export default async function findLocal<T extends keyof GeneratedTypes['collecti
)
}
req.payloadAPI = req.payloadAPI || 'local'
req.locale = locale
req.fallbackLocale =
typeof fallbackLocaleArg !== 'undefined' ? fallbackLocaleArg : fallbackLocale || defaultLocale
req.i18n = i18nInit(payload.config.i18n)
req.payload = payload
if (!req.t) req.t = req.i18n.t
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
if (typeof user !== 'undefined') req.user = user
const req = createLocalReq(options, payload)
return find<GeneratedTypes['collections'][T]>({
collection,

View File

@@ -4,9 +4,7 @@ import type { Payload } from '../../../payload'
import type { Document } from '../../../types'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { getDataLoader } from '../../dataloader'
import { createLocalReq } from '../../../utilities/createLocalReq'
import findByID from '../findByID'
export type Options<T extends keyof GeneratedTypes['collections']> = {
@@ -35,27 +33,15 @@ export default async function findByIDLocal<T extends keyof GeneratedTypes['coll
const {
id,
collection: collectionSlug,
context,
currentDepth,
depth,
disableErrors = false,
draft = false,
fallbackLocale: fallbackLocaleArg = options?.req?.fallbackLocale,
locale: localeArg = null,
overrideAccess = true,
req = {} as PayloadRequest,
showHiddenFields,
user,
} = options
setRequestContext(req, context)
const collection = payload.collections[collectionSlug]
const localizationConfig = payload?.config?.localization
const defaultLocale = localizationConfig ? localizationConfig.defaultLocale : null
const locale = localeArg || req.locale || defaultLocale
const fallbackLocale = localizationConfig
? localizationConfig.locales.find(({ code }) => locale === code)?.fallbackLocale
: null
if (!collection) {
throw new APIError(
@@ -63,17 +49,7 @@ export default async function findByIDLocal<T extends keyof GeneratedTypes['coll
)
}
req.payloadAPI = req.payloadAPI || 'local'
req.locale = locale
req.fallbackLocale =
typeof fallbackLocaleArg !== 'undefined' ? fallbackLocaleArg : fallbackLocale || defaultLocale
req.i18n = i18nInit(payload.config.i18n)
req.payload = payload
if (typeof user !== 'undefined') req.user = user
if (!req.t) req.t = req.i18n.t
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
return findByID<GeneratedTypes['collections'][T]>({
id,

View File

@@ -5,9 +5,7 @@ import type { Document } from '../../../types'
import type { TypeWithVersion } from '../../../versions/types'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { getDataLoader } from '../../dataloader'
import { createLocalReq } from '../../../utilities/createLocalReq'
import findVersionByID from '../findVersionByID'
export type Options<T extends keyof GeneratedTypes['collections']> = {
@@ -35,24 +33,13 @@ export default async function findVersionByIDLocal<T extends keyof GeneratedType
const {
id,
collection: collectionSlug,
context,
depth,
disableErrors = false,
fallbackLocale: fallbackLocaleArg = options?.req?.fallbackLocale,
locale: localeArg = null,
overrideAccess = true,
req = {} as PayloadRequest,
showHiddenFields,
} = options
setRequestContext(req, context)
const collection = payload.collections[collectionSlug]
const localizationConfig = payload?.config?.localization
const defaultLocale = localizationConfig ? localizationConfig.defaultLocale : null
const locale = localeArg || req.locale || defaultLocale
const fallbackLocale = localizationConfig
? localizationConfig.locales.find(({ code }) => locale === code)?.fallbackLocale
: null
if (!collection) {
throw new APIError(
@@ -62,15 +49,7 @@ export default async function findVersionByIDLocal<T extends keyof GeneratedType
)
}
req.payloadAPI = req.payloadAPI || 'local'
req.locale = locale
req.fallbackLocale =
typeof fallbackLocaleArg !== 'undefined' ? fallbackLocaleArg : fallbackLocale || defaultLocale
req.i18n = i18nInit(payload.config.i18n)
req.payload = payload
if (!req.t) req.t = req.i18n.t
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
return findVersionByID({
id,

View File

@@ -6,9 +6,7 @@ import type { Document, Where } from '../../../types'
import type { TypeWithVersion } from '../../../versions/types'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { getDataLoader } from '../../dataloader'
import { createLocalReq } from '../../../utilities/createLocalReq'
import findVersions from '../findVersions'
export type Options<T extends keyof GeneratedTypes['collections']> = {
@@ -37,27 +35,16 @@ export default async function findVersionsLocal<T extends keyof GeneratedTypes['
): Promise<PaginatedDocs<TypeWithVersion<GeneratedTypes['collections'][T]>>> {
const {
collection: collectionSlug,
context,
depth,
fallbackLocale: fallbackLocaleArg = options?.req?.fallbackLocale,
limit,
locale: localeArg = null,
overrideAccess = true,
page,
req: incomingReq,
showHiddenFields,
sort,
user,
where,
} = options
const collection = payload.collections[collectionSlug]
const localizationConfig = payload?.config?.localization
const defaultLocale = localizationConfig ? localizationConfig.defaultLocale : null
const locale = localeArg || incomingReq?.locale || defaultLocale
const fallbackLocale = localizationConfig
? localizationConfig.locales.find(({ code }) => locale === code)?.fallbackLocale
: null
if (!collection) {
throw new APIError(
@@ -65,23 +52,7 @@ export default async function findVersionsLocal<T extends keyof GeneratedTypes['
)
}
const i18n = i18nInit(payload.config.i18n)
const req = {
fallbackLocale:
typeof fallbackLocaleArg !== 'undefined'
? fallbackLocaleArg
: fallbackLocale || defaultLocale,
i18n,
locale,
payload,
payloadAPI: 'local',
transactionID: incomingReq?.transactionID,
user,
} as PayloadRequest
setRequestContext(req, context)
if (!req.t) req.t = req.i18n.t
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
return findVersions({
collection,

View File

@@ -4,9 +4,7 @@ import type { Payload } from '../../../payload'
import type { Document } from '../../../types'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { getDataLoader } from '../../dataloader'
import { createLocalReq } from '../../../utilities/createLocalReq'
import restoreVersion from '../restoreVersion'
export type Options<T extends keyof GeneratedTypes['collections']> = {
@@ -30,26 +28,9 @@ export default async function restoreVersionLocal<T extends keyof GeneratedTypes
payload: Payload,
options: Options<T>,
): Promise<GeneratedTypes['collections'][T]> {
const {
id,
collection: collectionSlug,
context,
depth,
fallbackLocale: fallbackLocaleArg = options?.req?.fallbackLocale,
locale: localeArg = null,
overrideAccess = true,
req: incomingReq,
showHiddenFields,
user,
} = options
const { id, collection: collectionSlug, depth, overrideAccess = true, showHiddenFields } = options
const collection = payload.collections[collectionSlug]
const localizationConfig = payload?.config?.localization
const defaultLocale = localizationConfig ? localizationConfig.defaultLocale : null
const locale = localeArg || incomingReq?.locale || defaultLocale
const fallbackLocale = localizationConfig
? localizationConfig.locales.find(({ code }) => locale === code)?.fallbackLocale
: null
if (!collection) {
throw new APIError(
@@ -59,23 +40,7 @@ export default async function restoreVersionLocal<T extends keyof GeneratedTypes
)
}
const i18n = i18nInit(payload.config.i18n)
const req = {
fallbackLocale:
typeof fallbackLocaleArg !== 'undefined'
? fallbackLocaleArg
: fallbackLocale || defaultLocale,
i18n,
locale,
payload,
payloadAPI: 'local',
t: i18n.t,
transactionID: incomingReq?.transactionID,
user,
} as PayloadRequest
setRequestContext(req, context)
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
const args = {
id,

View File

@@ -1,3 +1,4 @@
import type { UploadedFile } from 'express-fileupload'
import type { DeepPartial } from 'ts-essentials'
import type { GeneratedTypes } from '../../../'
@@ -8,10 +9,8 @@ import type { File } from '../../../uploads/types'
import type { BulkOperationResult } from '../../config/types'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import getFileByPath from '../../../uploads/getFileByPath'
import { getDataLoader } from '../../dataloader'
import { createLocalReq } from '../../../utilities/createLocalReq'
import update from '../update'
import updateByID from '../updateByID'
@@ -70,30 +69,18 @@ async function updateLocal<TSlug extends keyof GeneratedTypes['collections']>(
id,
autosave,
collection: collectionSlug,
context,
data,
depth,
draft,
fallbackLocale: fallbackLocaleArg = options?.req?.fallbackLocale,
file,
filePath,
locale: localeArg = null,
overrideAccess = true,
overwriteExistingFiles = false,
req: incomingReq,
showHiddenFields,
user,
where,
} = options
const collection = payload.collections[collectionSlug]
const i18n = i18nInit(payload.config.i18n)
const localizationConfig = payload?.config?.localization
const defaultLocale = localizationConfig ? localizationConfig.defaultLocale : null
const locale = localeArg || incomingReq?.locale || defaultLocale
const fallbackLocale = localizationConfig
? localizationConfig.locales.find(({ code }) => locale === code)?.fallbackLocale
: null
if (!collection) {
throw new APIError(
@@ -101,25 +88,17 @@ async function updateLocal<TSlug extends keyof GeneratedTypes['collections']>(
)
}
const req = {
fallbackLocale:
typeof fallbackLocaleArg !== 'undefined'
? fallbackLocaleArg
: fallbackLocale || defaultLocale,
files: {
file: file ?? (await getFileByPath(filePath)),
},
i18n,
locale: locale ?? defaultLocale,
payload,
payloadAPI: 'local',
transactionID: incomingReq?.transactionID,
user,
} as PayloadRequest
setRequestContext(req, context)
if (!req.t) req.t = req.i18n.t
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
const fileToSet = (file ?? (await getFileByPath(filePath))) as UploadedFile
if (fileToSet) {
if (req?.files) {
req.files.file = fileToSet
} else {
req.files = {
file: fileToSet,
}
}
}
const args = {
id,

View File

@@ -47,42 +47,43 @@ async function update<TSlug extends keyof GeneratedTypes['collections']>(
): Promise<BulkOperationResult<TSlug>> {
let args = incomingArgs
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'update',
})) || args
}, Promise.resolve())
const {
collection: { config: collectionConfig },
collection,
depth,
draft: draftArg = false,
overrideAccess,
overwriteExistingFiles = false,
req: {
locale,
payload: { config },
payload,
t,
},
req,
showHiddenFields,
where,
} = args
try {
const shouldCommit = await initTransaction(req)
const shouldCommit = await initTransaction(args.req)
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'update',
req: args.req,
})) || args
}, Promise.resolve())
const {
collection: { config: collectionConfig },
collection,
depth,
draft: draftArg = false,
overrideAccess,
overwriteExistingFiles = false,
req: {
locale,
payload: { config },
payload,
t,
},
req,
showHiddenFields,
where,
} = args
if (!where) {
throw new APIError("Missing 'where' query of documents to update.", httpStatus.BAD_REQUEST)
@@ -405,7 +406,7 @@ async function update<TSlug extends keyof GeneratedTypes['collections']>(
return result
} catch (error: unknown) {
await killTransaction(req)
await killTransaction(args.req)
throw error
}
}

View File

@@ -46,43 +46,44 @@ async function updateByID<TSlug extends keyof GeneratedTypes['collections']>(
): Promise<GeneratedTypes['collections'][TSlug]> {
let args = incomingArgs
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'update',
})) || args
}, Promise.resolve())
const {
id,
autosave = false,
collection: { config: collectionConfig },
collection,
depth,
draft: draftArg = false,
overrideAccess,
overwriteExistingFiles = false,
req: {
locale,
payload: { config },
payload,
t,
},
req,
showHiddenFields,
} = args
try {
const shouldCommit = await initTransaction(req)
const shouldCommit = await initTransaction(args.req)
// /////////////////////////////////////
// beforeOperation - Collection
// /////////////////////////////////////
await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
await priorHook
args =
(await hook({
args,
collection: args.collection.config,
context: args.req.context,
operation: 'update',
req: args.req,
})) || args
}, Promise.resolve())
const {
id,
autosave = false,
collection: { config: collectionConfig },
collection,
depth,
draft: draftArg = false,
overrideAccess,
overwriteExistingFiles = false,
req: {
locale,
payload: { config },
payload,
t,
},
req,
showHiddenFields,
} = args
if (!id) {
throw new APIError('Missing ID of document to update.', httpStatus.BAD_REQUEST)
@@ -376,7 +377,7 @@ async function updateByID<TSlug extends keyof GeneratedTypes['collections']>(
return result
} catch (error: unknown) {
await killTransaction(req)
await killTransaction(args.req)
throw error
}
}

View File

@@ -1,6 +1,7 @@
import type forgotPassword from '../../auth/operations/forgotPassword'
import type login from '../../auth/operations/login'
import type refresh from '../../auth/operations/refresh'
import type { PayloadRequest } from '../../express/types'
import type { AfterOperationHook, SanitizedCollectionConfig, TypeWithID } from '../config/types'
import type create from './create'
import type deleteOperation from './delete'
@@ -22,77 +23,62 @@ export type AfterOperationMap<T extends TypeWithID> = {
update: typeof update // todo: pass correct generic
updateByID: typeof updateByID // todo: pass correct generic
}
export type AfterOperationArg<T extends TypeWithID> =
export type AfterOperationArg<T extends TypeWithID> = {
/** The collection which this hook is being run on */
collection: SanitizedCollectionConfig
req: PayloadRequest
} & (
| {
args: Parameters<AfterOperationMap<T>['create']>[0]
/** The collection which this hook is being run on */
collection: SanitizedCollectionConfig
operation: 'create'
result: Awaited<ReturnType<AfterOperationMap<T>['create']>>
}
| {
args: Parameters<AfterOperationMap<T>['delete']>[0]
/** The collection which this hook is being run on */
collection: SanitizedCollectionConfig
operation: 'delete'
result: Awaited<ReturnType<AfterOperationMap<T>['delete']>>
}
| {
args: Parameters<AfterOperationMap<T>['deleteByID']>[0]
/** The collection which this hook is being run on */
collection: SanitizedCollectionConfig
operation: 'deleteByID'
result: Awaited<ReturnType<AfterOperationMap<T>['deleteByID']>>
}
| {
args: Parameters<AfterOperationMap<T>['find']>[0]
/** The collection which this hook is being run on */
collection: SanitizedCollectionConfig
operation: 'find'
result: Awaited<ReturnType<AfterOperationMap<T>['find']>>
}
| {
args: Parameters<AfterOperationMap<T>['findByID']>[0]
/** The collection which this hook is being run on */
collection: SanitizedCollectionConfig
operation: 'findByID'
result: Awaited<ReturnType<AfterOperationMap<T>['findByID']>>
}
| {
args: Parameters<AfterOperationMap<T>['forgotPassword']>[0]
/** The collection which this hook is being run on */
collection: SanitizedCollectionConfig
operation: 'forgotPassword'
result: Awaited<ReturnType<AfterOperationMap<T>['forgotPassword']>>
}
| {
args: Parameters<AfterOperationMap<T>['login']>[0]
/** The collection which this hook is being run on */
collection: SanitizedCollectionConfig
operation: 'login'
result: Awaited<ReturnType<AfterOperationMap<T>['login']>>
}
| {
args: Parameters<AfterOperationMap<T>['refresh']>[0]
/** The collection which this hook is being run on */
collection: SanitizedCollectionConfig
operation: 'refresh'
result: Awaited<ReturnType<AfterOperationMap<T>['refresh']>>
}
| {
args: Parameters<AfterOperationMap<T>['update']>[0]
/** The collection which this hook is being run on */
collection: SanitizedCollectionConfig
operation: 'update'
result: Awaited<ReturnType<AfterOperationMap<T>['update']>>
}
| {
args: Parameters<AfterOperationMap<T>['updateByID']>[0]
/** The collection which this hook is being run on */
collection: SanitizedCollectionConfig
operation: 'updateByID'
result: Awaited<ReturnType<AfterOperationMap<T>['updateByID']>>
}
)
// export type AfterOperationHook = typeof buildAfterOperation;
@@ -100,7 +86,7 @@ export const buildAfterOperation = async <
T extends TypeWithID = any,
O extends keyof AfterOperationMap<T> = keyof AfterOperationMap<T>,
>(
operationArgs: AfterOperationArg<T> & { operation: O },
operationArgs: Omit<AfterOperationArg<T>, 'req'> & { operation: O },
): Promise<Awaited<ReturnType<AfterOperationMap<T>[O]>>> => {
const { args, collection, operation, result } = operationArgs
@@ -114,6 +100,7 @@ export const buildAfterOperation = async <
args,
collection,
operation,
req: args.req,
result: newResult,
} as AfterOperationArg<T>)

View File

@@ -26,6 +26,7 @@ import type { PayloadRequest } from '../express/types'
import type { GlobalConfig, SanitizedGlobalConfig } from '../globals/config/types'
import type { Payload } from '../payload'
import type { Where } from '../types'
import type { PayloadLogger } from '../utilities/logger'
type Prettify<T> = {
[K in keyof T]: T[K]
@@ -155,6 +156,11 @@ export type InitOptions = {
* See Pino Docs for options: https://getpino.io/#/docs/api?id=options
*/
loggerOptions?: LoggerOptions
/**
* A previously instantiated logger instance. Must conform to the PayloadLogger interface which uses Pino
* This allows you to bring your own logger instance and let payload use it
*/
logger?: PayloadLogger
/**
* A function that is called immediately following startup that receives the Payload instance as it's only argument.

View File

@@ -9,6 +9,7 @@ export { combineMerge } from '../utilities/combineMerge'
export {
configToJSONSchema,
entityToJSONSchema,
fieldsToJSONSchema,
withNullableJSONSchemaType,
} from '../utilities/configToJSONSchema'
export { createArrayFromCommaDelineated } from '../utilities/createArrayFromCommaDelineated'

View File

@@ -38,8 +38,9 @@ export type FieldHookArgs<T extends TypeWithID = any, P = any, S = any> = {
originalDoc?: T
/** The document before changes were applied, only in `afterChange` hooks. */
previousDoc?: T
/** The sibling data from the previous document in `afterChange` hook. */
/** The sibling data of the document before changes being applied, only in `beforeChange` and `afterChange` hook. */
previousSiblingDoc?: T
/** The previous value of the field, before changes, only in `beforeChange` and `afterChange` hooks. */
previousValue?: P
/** The Express request object. It is mocked for Local API operations. */
req: PayloadRequest

View File

@@ -88,6 +88,8 @@ export const promise = async ({
global,
operation,
originalDoc: doc,
previousSiblingDoc: siblingDoc,
previousValue: siblingDoc[field.name],
req,
siblingData,
value: siblingData[field.name],

View File

@@ -3,10 +3,8 @@ import type { PayloadRequest } from '../../../express/types'
import type { Payload } from '../../../payload'
import type { Document } from '../../../types'
import { getDataLoader } from '../../../collections/dataloader'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { createLocalReq } from '../../../utilities/createLocalReq'
import findOne from '../findOne'
export type Options<T extends keyof GeneratedTypes['globals']> = {
@@ -27,55 +25,28 @@ export default async function findOneLocal<T extends keyof GeneratedTypes['globa
options: Options<T>,
): Promise<GeneratedTypes['globals'][T]> {
const {
context,
slug: globalSlug,
depth,
draft = false,
fallbackLocale: fallbackLocaleArg = options?.req?.fallbackLocale,
locale = payload.config.localization ? payload.config.localization?.defaultLocale : null,
overrideAccess = true,
showHiddenFields,
slug: globalSlug,
user,
} = options
const globalConfig = payload.globals.config.find((config) => config.slug === globalSlug)
const localizationConfig = payload?.config?.localization
const defaultLocale = payload?.config?.localization
? payload?.config?.localization?.defaultLocale
: null
const fallbackLocale = localizationConfig
? localizationConfig.locales.find(({ code }) => locale === code)?.fallbackLocale
: null
if (!globalConfig) {
throw new APIError(`The global with slug ${String(globalSlug)} can't be found.`)
}
const i18n = i18nInit(payload.config.i18n)
const req = {
fallbackLocale:
typeof fallbackLocaleArg !== 'undefined'
? fallbackLocaleArg
: fallbackLocale || defaultLocale,
i18n,
locale: locale ?? options.req?.locale ?? defaultLocale,
payload,
payloadAPI: 'local',
t: i18n.t,
user,
} as PayloadRequest
setRequestContext(req, context)
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
return findOne({
slug: globalSlug as string,
depth,
draft,
globalConfig,
overrideAccess,
req,
showHiddenFields,
slug: globalSlug as string,
})
}

View File

@@ -4,10 +4,8 @@ import type { Payload } from '../../../payload'
import type { Document } from '../../../types'
import type { TypeWithVersion } from '../../../versions/types'
import { getDataLoader } from '../../../collections/dataloader'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { createLocalReq } from '../../../utilities/createLocalReq'
import findVersionByID from '../findVersionByID'
export type Options<T extends keyof GeneratedTypes['globals']> = {
@@ -30,48 +28,20 @@ export default async function findVersionByIDLocal<T extends keyof GeneratedType
): Promise<TypeWithVersion<GeneratedTypes['globals'][T]>> {
const {
id,
context,
slug: globalSlug,
depth,
disableErrors = false,
fallbackLocale: fallbackLocaleArg = options?.req?.fallbackLocale,
locale = payload.config.localization ? payload.config.localization?.defaultLocale : null,
overrideAccess = true,
req: incomingReq,
showHiddenFields,
slug: globalSlug,
user,
} = options
const globalConfig = payload.globals.config.find((config) => config.slug === globalSlug)
const localizationConfig = payload?.config?.localization
const defaultLocale = payload?.config?.localization
? payload?.config?.localization?.defaultLocale
: null
const fallbackLocale = localizationConfig
? localizationConfig.locales.find(({ code }) => locale === code)?.fallbackLocale
: null
const i18n = i18nInit(payload.config.i18n)
if (!globalConfig) {
throw new APIError(`The global with slug ${String(globalSlug)} can't be found.`)
}
const req = {
fallbackLocale:
typeof fallbackLocaleArg !== 'undefined'
? fallbackLocaleArg
: fallbackLocale || defaultLocale,
i18n,
locale,
payload,
payloadAPI: 'local',
t: i18n.t,
transactionID: incomingReq?.transactionID,
user,
} as PayloadRequest
setRequestContext(req, context)
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
return findVersionByID({
id,

View File

@@ -5,10 +5,8 @@ import type { Payload } from '../../../payload'
import type { Document, Where } from '../../../types'
import type { TypeWithVersion } from '../../../versions/types'
import { getDataLoader } from '../../../collections/dataloader'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { createLocalReq } from '../../../utilities/createLocalReq'
import findVersions from '../findVersions'
export type Options<T extends keyof GeneratedTypes['globals']> = {
@@ -32,51 +30,23 @@ export default async function findVersionsLocal<T extends keyof GeneratedTypes['
options: Options<T>,
): Promise<PaginatedDocs<TypeWithVersion<GeneratedTypes['globals'][T]>>> {
const {
context,
slug: globalSlug,
depth,
fallbackLocale: fallbackLocaleArg = options?.req?.fallbackLocale,
limit,
locale = payload.config.localization ? payload.config.localization?.defaultLocale : null,
overrideAccess = true,
page,
req: incomingReq,
showHiddenFields,
slug: globalSlug,
sort,
user,
where,
} = options
const globalConfig = payload.globals.config.find((config) => config.slug === globalSlug)
const localizationConfig = payload?.config?.localization
const defaultLocale = payload?.config?.localization
? payload?.config?.localization?.defaultLocale
: null
const fallbackLocale = localizationConfig
? localizationConfig.locales.find(({ code }) => locale === code)?.fallbackLocale
: null
const i18n = i18nInit(payload.config.i18n)
if (!globalConfig) {
throw new APIError(`The global with slug ${String(globalSlug)} can't be found.`)
}
const req = {
fallbackLocale:
typeof fallbackLocaleArg !== 'undefined'
? fallbackLocaleArg
: fallbackLocale || defaultLocale,
i18n,
locale,
payload,
payloadAPI: 'local',
t: i18n.t,
transactionID: incomingReq?.transactionID,
user,
} as PayloadRequest
setRequestContext(req, context)
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
return findVersions({
depth,

View File

@@ -3,10 +3,8 @@ import type { PayloadRequest } from '../../../express/types'
import type { Payload } from '../../../payload'
import type { Document } from '../../../types'
import { getDataLoader } from '../../../collections/dataloader'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { createLocalReq } from '../../../utilities/createLocalReq'
import restoreVersion from '../restoreVersion'
export type Options<T extends keyof GeneratedTypes['globals']> = {
@@ -26,49 +24,15 @@ export default async function restoreVersionLocal<T extends keyof GeneratedTypes
payload: Payload,
options: Options<T>,
): Promise<GeneratedTypes['globals'][T]> {
const {
id,
context,
depth,
fallbackLocale: fallbackLocaleArg = options?.req?.fallbackLocale,
locale = payload.config.localization ? payload.config.localization?.defaultLocale : null,
overrideAccess = true,
req: incomingReq,
showHiddenFields,
slug: globalSlug,
user,
} = options
const { id, slug: globalSlug, depth, overrideAccess = true, showHiddenFields } = options
const globalConfig = payload.globals.config.find((config) => config.slug === globalSlug)
const localizationConfig = payload?.config?.localization
const defaultLocale = payload?.config?.localization
? payload?.config?.localization?.defaultLocale
: null
const fallbackLocale = localizationConfig
? localizationConfig.locales.find(({ code }) => locale === code)?.fallbackLocale
: null
const i18n = i18nInit(payload.config.i18n)
if (!globalConfig) {
throw new APIError(`The global with slug ${String(globalSlug)} can't be found.`)
}
const req = {
fallbackLocale:
typeof fallbackLocaleArg !== 'undefined'
? fallbackLocaleArg
: fallbackLocale || defaultLocale,
i18n,
locale,
payload,
payloadAPI: 'local',
t: i18n.t,
transactionID: incomingReq?.transactionID,
user,
} as PayloadRequest
setRequestContext(req, context)
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
return restoreVersion({
id,

View File

@@ -5,10 +5,8 @@ import type { PayloadRequest } from '../../../express/types'
import type { Payload } from '../../../payload'
import type { Document } from '../../../types'
import { getDataLoader } from '../../../collections/dataloader'
import { APIError } from '../../../errors'
import { setRequestContext } from '../../../express/setRequestContext'
import { i18nInit } from '../../../translations/init'
import { createLocalReq } from '../../../utilities/createLocalReq'
import update from '../update'
export type Options<TSlug extends keyof GeneratedTypes['globals']> = {
@@ -29,52 +27,18 @@ export default async function updateLocal<TSlug extends keyof GeneratedTypes['gl
payload: Payload,
options: Options<TSlug>,
): Promise<GeneratedTypes['globals'][TSlug]> {
const {
context,
data,
depth,
draft,
fallbackLocale: fallbackLocaleArg = options?.req?.fallbackLocale,
locale = payload.config.localization ? payload.config.localization?.defaultLocale : null,
overrideAccess = true,
req: incomingReq,
showHiddenFields,
slug: globalSlug,
user,
} = options
const { slug: globalSlug, data, depth, draft, overrideAccess = true, showHiddenFields } = options
const globalConfig = payload.globals.config.find((config) => config.slug === globalSlug)
const localizationConfig = payload?.config?.localization
const defaultLocale = payload?.config?.localization
? payload?.config?.localization?.defaultLocale
: null
const fallbackLocale = localizationConfig
? localizationConfig.locales.find(({ code }) => locale === code)?.fallbackLocale
: null
const i18n = i18nInit(payload.config.i18n)
if (!globalConfig) {
throw new APIError(`The global with slug ${String(globalSlug)} can't be found.`)
}
const req = {
fallbackLocale:
typeof fallbackLocaleArg !== 'undefined'
? fallbackLocaleArg
: fallbackLocale || defaultLocale,
i18n,
locale,
payload,
payloadAPI: 'local',
t: i18n.t,
transactionID: incomingReq?.transactionID,
user,
} as PayloadRequest
setRequestContext(req, context)
if (!req.payloadDataLoader) req.payloadDataLoader = getDataLoader(req)
const req = createLocalReq(options, payload)
return update<TSlug>({
slug: globalSlug as string,
data,
depth,
draft,
@@ -82,6 +46,5 @@ export default async function updateLocal<TSlug extends keyof GeneratedTypes['gl
overrideAccess,
req,
showHiddenFields,
slug: globalSlug as string,
})
}

View File

@@ -311,7 +311,8 @@ export class BasePayload<TGeneratedTypes extends GeneratedTypes> {
*/
// @ts-expect-error // TODO: TypeScript hallucinating again. fix later
async init(options: InitOptions): Promise<Payload> {
this.logger = Logger('payload', options.loggerOptions, options.loggerDestination)
this.logger =
options.logger ?? Logger('payload', options.loggerOptions, options.loggerDestination)
if (!options.secret) {
throw new Error('Error: missing secret key. A secret key is needed to secure Payload.')

View File

@@ -12,6 +12,7 @@ const preferenceAccess: Access = ({ req }) => ({
})
const getPreferencesCollection = (config: Config): CollectionConfig => ({
slug: 'payload-preferences',
access: {
delete: preferenceAccess,
read: preferenceAccess,
@@ -39,6 +40,7 @@ const getPreferencesCollection = (config: Config): CollectionConfig => ({
fields: [
{
name: 'user',
type: 'relationship',
hooks: {
beforeValidate: [
({ req }) => {
@@ -52,22 +54,22 @@ const getPreferencesCollection = (config: Config): CollectionConfig => ({
},
],
},
index: true,
relationTo: config.collections
.filter((collectionConfig) => collectionConfig.auth)
.map((collectionConfig) => collectionConfig.slug),
required: true,
type: 'relationship',
},
{
name: 'key',
type: 'text',
index: true,
},
{
name: 'value',
type: 'json',
},
],
slug: 'payload-preferences',
})
export default getPreferencesCollection

View File

@@ -78,9 +78,12 @@ export function withNullableJSONSchemaType(
return fieldTypes
}
function fieldsToJSONSchema(
export function fieldsToJSONSchema(
collectionIDFieldTypes: { [key: string]: 'number' | 'string' },
fields: Field[],
/**
* Allows you to define new top-level interfaces that can be re-used in the output schema.
*/
interfaceNameDefinitions: Map<string, JSONSchema4>,
): {
properties: {
@@ -144,6 +147,7 @@ function fieldsToJSONSchema(
if (field.editor.outputSchema) {
fieldSchema = field.editor.outputSchema({
field,
interfaceNameDefinitions,
isRequired,
})
} else {
@@ -524,8 +528,11 @@ export function configToJSONSchema(
config: SanitizedConfig,
defaultIDType?: 'number' | 'text',
): JSONSchema4 {
// a mutable Map to store custom top-level `interfaceName` types
// a mutable Map to store custom top-level `interfaceName` types. Fields with an `interfaceName` property will be moved to the top-level definitions here
const interfaceNameDefinitions: Map<string, JSONSchema4> = new Map()
// Collections and Globals have to be moved to the top-level definitions as well. Reason: The top-level type will be the `Config` type - we don't want all collection and global
// types to be inlined inside the `Config` type
const entityDefinitions: { [k: string]: JSONSchema4 } = [
...config.globals,
...config.collections,
@@ -537,6 +544,7 @@ export function configToJSONSchema(
return {
additionalProperties: false,
definitions: { ...entityDefinitions, ...Object.fromEntries(interfaceNameDefinitions) },
// These properties here will be very simple, as all the complexity is in the definitions. These are just the properties for the top-level `Config` type
properties: {
collections: generateEntitySchemas(config.collections || []),
globals: generateEntitySchemas(config.globals || []),

View File

@@ -0,0 +1,63 @@
import type { Payload, RequestContext } from '..'
import type { PayloadRequest } from '../exports/types'
import { getDataLoader } from '../collections/dataloader'
import { i18nInit } from '../translations/init'
function getRequestContext(
req: PayloadRequest = { context: null } as PayloadRequest,
context: RequestContext = {},
): RequestContext {
if (req.context) {
if (Object.keys(req.context).length === 0 && req.context.constructor === Object) {
// if req.context is `{}` avoid unnecessary spread
return context
} else {
return { ...req.context, ...context }
}
} else {
return context
}
}
type CreateLocalReq = (
options: {
collection?: number | string | symbol
context?: RequestContext
fallbackLocale?: string
locale?: string
req?: PayloadRequest
user?: Document
},
payload: Payload,
) => PayloadRequest
export const createLocalReq: CreateLocalReq = (
{ collection, context, fallbackLocale, locale, req = {} as PayloadRequest, user },
payload,
) => {
const i18n = req?.i18n || i18nInit(payload.config?.i18n)
if (payload.config?.localization) {
const defaultLocale = payload.config.localization.defaultLocale
req.locale = locale || req?.locale || defaultLocale
const fallbackLocaleFromConfig = payload.config.localization.locales.find(
({ code }) => req.locale === code,
)?.fallbackLocale
if (typeof fallbackLocale !== 'undefined') {
req.fallbackLocale = fallbackLocale
} else if (typeof req?.fallbackLocale === 'undefined') {
req.fallbackLocale = fallbackLocaleFromConfig || defaultLocale
}
}
req.context = getRequestContext(req, context)
req.payloadAPI = req?.payloadAPI || 'local'
req.payload = payload
req.i18n = i18n
req.t = i18n.t
req.user = user || req?.user || null
req.collection = collection ? payload.collections?.[collection] : null
req.payloadDataLoader = req?.payloadDataLoader || getDataLoader(req)
return req
}

View File

@@ -1,7 +1,7 @@
{
"name": "@payloadcms/plugin-cloud-storage",
"description": "The official cloud storage plugin for Payload CMS",
"version": "1.1.1",
"version": "1.1.2",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"license": "MIT",

View File

@@ -99,17 +99,29 @@ const seo =
if (isEnabled) {
if (pluginConfig?.tabbedUI) {
// prevent issues with auth enabled collections having an email field that shouldn't be moved to the SEO tab
const emailField =
(collection.auth ||
!(typeof collection.auth === 'object' && collection.auth.disableLocalStrategy)) &&
collection.fields?.find((field) => 'name' in field && field.name === 'email')
const seoTabs: TabsField[] = [
{
type: 'tabs',
tabs: [
// append a new tab onto the end of the tabs array, if there is one at the first index
// if needed, create a new `Content` tab in the first index for this collection's base fields
...(collection?.fields?.[0].type === 'tabs'
...(collection?.fields?.[0]?.type === 'tabs'
? collection.fields[0]?.tabs
: [
{
fields: [...(collection?.fields || [])],
fields: [
...((emailField
? collection.fields.filter(
(field) => 'name' in field && field.name !== 'email',
)
: collection.fields) || []),
],
label: collection?.labels?.singular || 'Content',
},
]),
@@ -124,8 +136,9 @@ const seo =
return {
...collection,
fields: [
...(emailField ? [emailField] : []),
...seoTabs,
...(collection?.fields?.[0].type === 'tabs' ? collection?.fields?.slice(1) : []),
...(collection?.fields?.[0]?.type === 'tabs' ? collection.fields.slice(1) : []),
],
}
}

View File

@@ -1,6 +1,6 @@
{
"name": "@payloadcms/richtext-lexical",
"version": "0.5.2",
"version": "0.6.0",
"description": "The officially supported Lexical richtext adapter for Payload",
"repository": "https://github.com/payloadcms/payload",
"license": "MIT",
@@ -32,6 +32,7 @@
"classnames": "^2.3.2",
"deep-equal": "2.2.3",
"i18next": "22.5.1",
"json-schema": "^0.4.0",
"lexical": "0.12.6",
"lodash": "4.17.21",
"react": "18.2.0",
@@ -42,6 +43,7 @@
},
"devDependencies": {
"@payloadcms/eslint-config": "workspace:*",
"@types/json-schema": "7.0.12",
"@types/node": "20.6.2",
"@types/react": "18.2.15",
"payload": "workspace:*"

View File

@@ -1,7 +1,7 @@
import type { Block } from 'payload/types'
import type { Block, BlockField } from 'payload/types'
import { baseBlockFields } from 'payload/config'
import { formatLabels, getTranslation } from 'payload/utilities'
import { fieldsToJSONSchema, formatLabels, getTranslation } from 'payload/utilities'
import type { FeatureProvider } from '../types'
@@ -31,6 +31,20 @@ export const BlocksFeature = (props?: BlocksFeatureProps): FeatureProvider => {
return {
feature: () => {
return {
generatedTypes: {
modifyOutputSchema: ({ currentSchema, field, interfaceNameDefinitions }) => {
const blocksField: BlockField = {
name: field?.name + '_lexical_blocks',
blocks: props.blocks,
type: 'blocks',
}
// This is only done so that interfaceNameDefinitions sets those block's interfaceNames.
// we don't actually use the JSON Schema itself in the generated types yet.
fieldsToJSONSchema({}, [blocksField], interfaceNameDefinitions)
return currentSchema
},
},
nodes: [
{
node: BlockNode,

View File

@@ -1,4 +1,5 @@
import type { Transformer } from '@lexical/markdown'
import type { JSONSchema4 } from 'json-schema'
import type { Klass, LexicalEditor, LexicalNode, SerializedEditorState } from 'lexical'
import type { SerializedLexicalNode } from 'lexical'
import type { LexicalNodeReplacement } from 'lexical'
@@ -65,6 +66,25 @@ export type Feature = {
floatingSelectToolbar?: {
sections: FloatingToolbarSection[]
}
generatedTypes?: {
modifyOutputSchema: ({
currentSchema,
field,
interfaceNameDefinitions,
isRequired,
}: {
/**
* Current schema which will be modified by this function.
*/
currentSchema: JSONSchema4
field: RichTextField<SerializedEditorState, AdapterProps>
/**
* Allows you to define new top-level interfaces that can be re-used in the output schema.
*/
interfaceNameDefinitions: Map<string, JSONSchema4>
isRequired: boolean
}) => JSONSchema4
}
hooks?: {
afterReadPromise?: ({
field,
@@ -200,6 +220,27 @@ export type SanitizedFeatures = Required<
floatingSelectToolbar: {
sections: FloatingToolbarSection[]
}
generatedTypes: {
modifyOutputSchemas: Array<
({
currentSchema,
field,
interfaceNameDefinitions,
isRequired,
}: {
/**
* Current schema which will be modified by this function.
*/
currentSchema: JSONSchema4
field: RichTextField<SerializedEditorState, AdapterProps>
/**
* Allows you to define new top-level interfaces that can be re-used in the output schema.
*/
interfaceNameDefinitions: Map<string, JSONSchema4>
isRequired: boolean
}) => JSONSchema4
>
}
hooks: {
afterReadPromises: Array<
({

View File

@@ -12,6 +12,9 @@ export const sanitizeFeatures = (features: ResolvedFeatureMap): SanitizedFeature
floatingSelectToolbar: {
sections: [],
},
generatedTypes: {
modifyOutputSchemas: [],
},
hooks: {
afterReadPromises: [],
load: [],
@@ -29,6 +32,9 @@ export const sanitizeFeatures = (features: ResolvedFeatureMap): SanitizedFeature
}
features.forEach((feature) => {
if (feature?.generatedTypes?.modifyOutputSchema) {
sanitized.generatedTypes.modifyOutputSchemas.push(feature.generatedTypes.modifyOutputSchema)
}
if (feature.hooks) {
if (feature.hooks.afterReadPromise) {
sanitized.hooks.afterReadPromises = sanitized.hooks.afterReadPromises.concat(

View File

@@ -1,3 +1,4 @@
import type { JSONSchema4 } from 'json-schema'
import type { SerializedEditorState } from 'lexical'
import type { EditorConfig as LexicalEditorConfig } from 'lexical/LexicalEditor'
import type { RichTextAdapter } from 'payload/types'
@@ -98,8 +99,8 @@ export function lexicalEditor(props?: LexicalEditorProps): LexicalRichTextAdapte
})
},
editorConfig: finalSanitizedEditorConfig,
outputSchema: ({ isRequired }) => {
return {
outputSchema: ({ field, interfaceNameDefinitions, isRequired }) => {
let outputSchema: JSONSchema4 = {
// This schema matches the SerializedEditorState type so far, that it's possible to cast SerializedEditorState to this schema without any errors.
// In the future, we should
// 1) allow recursive children
@@ -155,6 +156,17 @@ export function lexicalEditor(props?: LexicalEditorProps): LexicalRichTextAdapte
required: ['root'],
type: withNullableJSONSchemaType('object', isRequired),
}
for (const modifyOutputSchema of finalSanitizedEditorConfig.features.generatedTypes
.modifyOutputSchemas) {
outputSchema = modifyOutputSchema({
currentSchema: outputSchema,
field,
interfaceNameDefinitions,
isRequired,
})
}
return outputSchema
},
populationPromise({
context,

View File

@@ -1,6 +1,6 @@
{
"name": "@payloadcms/richtext-slate",
"version": "1.3.1",
"version": "1.4.0",
"description": "The officially supported Slate richtext adapter for Payload",
"repository": "https://github.com/payloadcms/payload",
"license": "MIT",

1219
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@@ -299,6 +299,14 @@ To seed the database with a few products and pages you can run `yarn seed`. This
> 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.
### Conflicting routes
>In a monorepo when routes are bootstrapped to the same host, they can conflict with Payload's own routes if they have the same name. In our template we've named the Nextjs API routes to `next` to avoid this conflict.
>
>This can happen with any other routes conflicting with Payload such as `admin` and we recommend using different names for custom routes.
>Alternatively you can also rename Payload's own routes via the [configuration](https://payloadcms.com/docs/configuration/overview).
## Production
To run Payload in production, you need to build and serve the Admin panel. To do so, follow these steps:

View File

@@ -6,7 +6,7 @@ export const clearUserCart: AfterChangeHook<Order> = async ({ doc, req, operatio
const { payload } = req
if (operation === 'create' && doc.orderedBy) {
const orderedBy = typeof doc.orderedBy === 'string' ? doc.orderedBy : doc.orderedBy.id
const orderedBy = typeof doc.orderedBy === 'object' ? doc.orderedBy.id : doc.orderedBy
const user = await payload.findByID({
collection: 'users',

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