Compare commits

..

9 Commits

Author SHA1 Message Date
Sasha
cbee9c4c4a forgot upsertRow/insertArrays 2025-06-03 01:21:13 +03:00
Sasha
ba011b8933 even more (upsertRow/*) 2025-06-03 01:19:33 +03:00
Sasha
193c051c67 Merge branch 'main' of github.com:payloadcms/payload into chore/strict-drizzle 2025-06-03 01:11:44 +03:00
Sasha
e7749468c2 even even more 2025-06-03 01:09:59 +03:00
Sasha
115af04406 even more 2025-06-03 00:59:53 +03:00
Sasha
ec115c6eca more 2025-06-03 00:23:38 +03:00
Sasha
4b3f1b9c92 Merge branch 'main' of github.com:payloadcms/payload into chore/strict-drizzle 2025-06-02 17:40:24 +03:00
Sasha
180ef3a49d more 2025-03-11 19:08:24 +02:00
Sasha
1066b434c3 chore(drizzle): enable strict true 2025-03-11 18:12:47 +02:00
922 changed files with 12043 additions and 18902 deletions

View File

@@ -10,7 +10,7 @@ inputs:
pnpm-version:
description: Pnpm version
required: true
default: 10.12.1
default: 9.7.1
pnpm-run-install:
description: Whether to run pnpm install
required: false

View File

@@ -6,7 +6,6 @@ on:
- opened
- reopened
- synchronize
- labeled
push:
branches:
- main
@@ -18,7 +17,7 @@ concurrency:
env:
NODE_VERSION: 23.11.0
PNPM_VERSION: 10.12.1
PNPM_VERSION: 9.7.1
DO_NOT_TRACK: 1 # Disable Turbopack telemetry
NEXT_TELEMETRY_DISABLED: 1 # Disable Next telemetry
@@ -322,142 +321,6 @@ jobs:
steps:
- uses: actions/checkout@v4
- name: Node setup
uses: ./.github/actions/setup
with:
node-version: ${{ env.NODE_VERSION }}
pnpm-version: ${{ env.PNPM_VERSION }}
pnpm-run-install: false
pnpm-restore-cache: false # Full build is restored below
pnpm-install-cache-key: pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
- name: Restore build
uses: actions/cache@v4
with:
path: ./*
key: ${{ github.sha }}-${{ github.run_number }}
- name: Start LocalStack
run: pnpm docker:start
if: ${{ matrix.suite == 'plugin-cloud-storage' }}
- name: Store Playwright's Version
run: |
# Extract the version number using a more targeted regex pattern with awk
PLAYWRIGHT_VERSION=$(pnpm ls @playwright/test --depth=0 | awk '/@playwright\/test/ {print $2}')
echo "Playwright's Version: $PLAYWRIGHT_VERSION"
echo "PLAYWRIGHT_VERSION=$PLAYWRIGHT_VERSION" >> $GITHUB_ENV
- name: Cache Playwright Browsers for Playwright's Version
id: cache-playwright-browsers
uses: actions/cache@v4
with:
path: ~/.cache/ms-playwright
key: playwright-browsers-${{ env.PLAYWRIGHT_VERSION }}
- name: Setup Playwright - Browsers and Dependencies
if: steps.cache-playwright-browsers.outputs.cache-hit != 'true'
run: pnpm exec playwright install --with-deps chromium
- name: Setup Playwright - Dependencies-only
if: steps.cache-playwright-browsers.outputs.cache-hit == 'true'
run: pnpm exec playwright install-deps chromium
- name: E2E Tests
run: PLAYWRIGHT_JSON_OUTPUT_NAME=results_${{ matrix.suite }}.json pnpm test:e2e:prod:ci:noturbo ${{ matrix.suite }}
env:
PLAYWRIGHT_JSON_OUTPUT_NAME: results_${{ matrix.suite }}.json
NEXT_TELEMETRY_DISABLED: 1
- uses: actions/upload-artifact@v4
if: always()
with:
name: test-results-${{ matrix.suite }}
path: test/test-results/
if-no-files-found: ignore
retention-days: 1
# Disabled until this is fixed: https://github.com/daun/playwright-report-summary/issues/156
# - uses: daun/playwright-report-summary@v3
# with:
# report-file: results_${{ matrix.suite }}.json
# report-tag: ${{ matrix.suite }}
# job-summary: true
tests-e2e-turbo:
runs-on: ubuntu-24.04
needs: [changes, build]
if: >-
needs.changes.outputs.needs_tests == 'true' &&
(
contains(github.event.pull_request.labels.*.name, 'run-e2e-turbo') ||
github.event.label.name == 'run-e2e-turbo'
)
name: e2e-turbo-${{ matrix.suite }}
strategy:
fail-fast: false
matrix:
# find test -type f -name 'e2e.spec.ts' | sort | xargs dirname | xargs -I {} basename {}
suite:
- _community
- access-control
- admin__e2e__general
- admin__e2e__list-view
- admin__e2e__document-view
- admin-bar
- admin-root
- auth
- auth-basic
- bulk-edit
- joins
- field-error-states
- fields-relationship
- fields__collections__Array
- fields__collections__Blocks
- fields__collections__Blocks#config.blockreferences.ts
- fields__collections__Checkbox
- fields__collections__Collapsible
- fields__collections__ConditionalLogic
- fields__collections__CustomID
- fields__collections__Date
- fields__collections__Email
- fields__collections__Indexed
- fields__collections__JSON
- fields__collections__Number
- fields__collections__Point
- fields__collections__Radio
- fields__collections__Relationship
- fields__collections__Row
- fields__collections__Select
- fields__collections__Tabs
- fields__collections__Tabs2
- fields__collections__Text
- fields__collections__UI
- fields__collections__Upload
- hooks
- lexical__collections__Lexical__e2e__main
- lexical__collections__Lexical__e2e__blocks
- lexical__collections__Lexical__e2e__blocks#config.blockreferences.ts
- lexical__collections__RichText
- query-presets
- form-state
- live-preview
- localization
- locked-documents
- i18n
- plugin-cloud-storage
- plugin-form-builder
- plugin-import-export
- plugin-nested-docs
- plugin-seo
- sort
- versions
- uploads
env:
SUITE_NAME: ${{ matrix.suite }}
steps:
- uses: actions/checkout@v4
- name: Node setup
uses: ./.github/actions/setup
with:
@@ -508,7 +371,7 @@ jobs:
- uses: actions/upload-artifact@v4
if: always()
with:
name: test-results-turbo${{ matrix.suite }}
name: test-results-${{ matrix.suite }}
path: test/test-results/
if-no-files-found: ignore
retention-days: 1

View File

@@ -8,7 +8,7 @@ on:
env:
NODE_VERSION: 23.11.0
PNPM_VERSION: 10.12.1
PNPM_VERSION: 9.7.1
DO_NOT_TRACK: 1 # Disable Turbopack telemetry
NEXT_TELEMETRY_DISABLED: 1 # Disable Next telemetry

View File

@@ -13,7 +13,7 @@ on:
env:
NODE_VERSION: 23.11.0
PNPM_VERSION: 10.12.1
PNPM_VERSION: 9.7.1
DO_NOT_TRACK: 1 # Disable Turbopack telemetry
NEXT_TELEMETRY_DISABLED: 1 # Disable Next telemetry

View File

@@ -8,7 +8,7 @@ on:
env:
NODE_VERSION: 23.11.0
PNPM_VERSION: 10.12.1
PNPM_VERSION: 9.7.1
DO_NOT_TRACK: 1 # Disable Turbopack telemetry
NEXT_TELEMETRY_DISABLED: 1 # Disable Next telemetry

View File

@@ -1,2 +1,2 @@
pnpm 10.12.1
pnpm 9.7.1
nodejs 23.11.0

View File

@@ -97,6 +97,7 @@ The following options are available:
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| **`avatar`** | Set account profile picture. Options: `gravatar`, `default` or a custom React component. |
| **`autoLogin`** | Used to automate log-in for dev and demonstration convenience. [More details](../authentication/overview). |
| **`buildPath`** | Specify an absolute path for where to store the built Admin bundle used in production. Defaults to `path.resolve(process.cwd(), 'build')`. |
| **`components`** | Component overrides that affect the entirety of the Admin Panel. [More details](../custom-components/overview). |
| **`custom`** | Any custom properties you wish to pass to the Admin Panel. |
| **`dateFormat`** | The date format that will be used for all dates within the Admin Panel. Any valid [date-fns](https://date-fns.org/) format pattern can be used. |

View File

@@ -23,9 +23,6 @@ Example:
```ts
const user = await fetch('http://localhost:3000/api/users/login', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
email: 'dev@payloadcms.com',
password: 'password',

View File

@@ -178,7 +178,7 @@ All auth-related operations are available via Payload's REST, Local, and GraphQL
## Strategies
Out of the box Payload ships with three powerful Authentication strategies:
Out of the box Payload ships with a three powerful Authentication strategies:
- [HTTP-Only Cookies](./cookies)
- [JSON Web Tokens (JWT)](./jwt)

View File

@@ -85,7 +85,6 @@ The following options are available:
| `defaultPopulate` | Specify which fields to select when this Collection is populated from another document. [More Details](../queries/select#defaultpopulate-collection-config-property). |
| `indexes` | Define compound indexes for this collection. This can be used to either speed up querying/sorting by 2 or more fields at the same time or to ensure uniqueness between several fields. |
| `forceSelect` | Specify which fields should be selected always, regardless of the `select` query which can be useful that the field exists for access control / hooks |
| `disableBulkEdit` | Disable the bulk edit operation for the collection in the admin panel and the REST API |
_\* An asterisk denotes that a property is required._
@@ -195,15 +194,13 @@ export const MyCollection: CollectionConfig = {
The following options are available:
| Option | Description |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `beforeDocumentControls` | Inject custom components before the Save / Publish buttons. [More details](../custom-components/edit-view#beforedocumentcontrols). |
| `editMenuItems` | Inject custom components within the 3-dot menu dropdown located in the document controls bar. [More details](../custom-components/edit-view#editmenuitems). |
| `SaveButton` | Replace the default Save Button within the Edit View. [Drafts](../versions/drafts) must be disabled. [More details](../custom-components/edit-view#savebutton). |
| `SaveDraftButton` | Replace the default Save Draft Button within the Edit View. [Drafts](../versions/drafts) must be enabled and autosave must be disabled. [More details](../custom-components/edit-view#savedraftbutton). |
| `PublishButton` | Replace the default Publish Button within the Edit View. [Drafts](../versions/drafts) must be enabled. [More details](../custom-components/edit-view#publishbutton). |
| `PreviewButton` | Replace the default Preview Button within the Edit View. [Preview](../admin/preview) must be enabled. [More details](../custom-components/edit-view#previewbutton). |
| `Upload` | Replace the default Upload component within the Edit View. [Upload](../upload/overview) must be enabled. [More details](../custom-components/edit-view#upload). |
| Option | Description |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SaveButton` | Replace the default Save Button within the Edit View. [Drafts](../versions/drafts) must be disabled. [More details](../custom-components/edit-view#savebutton). |
| `SaveDraftButton` | Replace the default Save Draft Button within the Edit View. [Drafts](../versions/drafts) must be enabled and autosave must be disabled. [More details](../custom-components/edit-view#savedraftbutton). |
| `PublishButton` | Replace the default Publish Button within the Edit View. [Drafts](../versions/drafts) must be enabled. [More details](../custom-components/edit-view#publishbutton). |
| `PreviewButton` | Replace the default Preview Button within the Edit View. [Preview](../admin/preview) must be enabled. [More details](../custom-components/edit-view#previewbutton). |
| `Upload` | Replace the default Upload component within the Edit View. [Upload](../upload/overview) must be enabled. [More details](../custom-components/edit-view#upload). |
<Banner type="success">
**Note:** For details on how to build Custom Components, see [Building Custom

View File

@@ -88,7 +88,7 @@ export const MyCollection: CollectionConfig = {
### Edit View
The Edit View is where users interact with individual Collection and Global Documents. This is where they can view, edit, and save their content. The Edit View is keyed under the `default` property in the `views.edit` object.
The Edit View is where users interact with individual Collection and Global Documents. This is where they can view, edit, and save their content. the Edit View is keyed under the `default` property in the `views.edit` object.
For more information on customizing the Edit View, see the [Edit View](./edit-view) documentation.
@@ -107,8 +107,8 @@ export const MyCollection: CollectionConfig = {
components: {
views: {
edit: {
myCustomView: {
Component: '/path/to/MyCustomView',
myCustomTab: {
Component: '/path/to/MyCustomTab',
path: '/my-custom-tab',
// highlight-start
tab: {
@@ -116,14 +116,13 @@ export const MyCollection: CollectionConfig = {
},
// highlight-end
},
anotherCustomView: {
anotherCustomTab: {
Component: '/path/to/AnotherCustomView',
path: '/another-custom-view',
// highlight-start
tab: {
label: 'Another Custom View',
href: '/another-custom-view',
order: '100',
},
// highlight-end
},
@@ -144,7 +143,6 @@ The following options are available for tabs:
| ----------- | ------------------------------------------------------------------------------------------------------------- |
| `label` | The label to display in the tab. |
| `href` | The URL to navigate to when the tab is clicked. This is optional and defaults to the tab's `path`. |
| `order` | The order in which the tab appears in the navigation. Can be set on default and custom tabs. |
| `Component` | The component to render in the tab. This can be a Server or Client component. [More details](#tab-components) |
### Tab Components

View File

@@ -101,16 +101,15 @@ export const MyCollection: CollectionConfig = {
The following options are available:
| Path | Description |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
| `beforeDocumentControls` | Inject custom components before the Save / Publish buttons. [More details](#beforedocumentcontrols). |
| `editMenuItems` | Inject custom components within the 3-dot menu dropdown located in the document control bar. [More details](#editmenuitems). |
| `SaveButton` | A button that saves the current document. [More details](#savebutton). |
| `SaveDraftButton` | A button that saves the current document as a draft. [More details](#savedraftbutton). |
| `PublishButton` | A button that publishes the current document. [More details](#publishbutton). |
| `PreviewButton` | A button that previews the current document. [More details](#previewbutton). |
| `Description` | A description of the Collection. [More details](#description). |
| `Upload` | A file upload component. [More details](#upload). |
| Path | Description |
| ------------------------ | ---------------------------------------------------------------------------------------------------- |
| `beforeDocumentControls` | Inject custom components before the Save / Publish buttons. [More details](#beforedocumentcontrols). |
| `SaveButton` | A button that saves the current document. [More details](#savebutton). |
| `SaveDraftButton` | A button that saves the current document as a draft. [More details](#savedraftbutton). |
| `PublishButton` | A button that publishes the current document. [More details](#publishbutton). |
| `PreviewButton` | A button that previews the current document. [More details](#previewbutton). |
| `Description` | A description of the Collection. [More details](#description). |
| `Upload` | A file upload component. [More details](#upload). |
#### Globals
@@ -135,15 +134,14 @@ export const MyGlobal: GlobalConfig = {
The following options are available:
| Path | Description |
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
| `beforeDocumentControls` | Inject custom components before the Save / Publish buttons. [More details](#beforedocumentcontrols). |
| `editMenuItems` | Inject custom components within the 3-dot menu dropdown located in the document control bar. [More details](#editmenuitems). |
| `SaveButton` | A button that saves the current document. [More details](#savebutton). |
| `SaveDraftButton` | A button that saves the current document as a draft. [More details](#savedraftbutton). |
| `PublishButton` | A button that publishes the current document. [More details](#publishbutton). |
| `PreviewButton` | A button that previews the current document. [More details](#previewbutton). |
| `Description` | A description of the Global. [More details](#description). |
| Path | Description |
| ------------------------ | ---------------------------------------------------------------------------------------------------- |
| `beforeDocumentControls` | Inject custom components before the Save / Publish buttons. [More details](#beforedocumentcontrols). |
| `SaveButton` | A button that saves the current document. [More details](#savebutton). |
| `SaveDraftButton` | A button that saves the current document as a draft. [More details](#savedraftbutton). |
| `PublishButton` | A button that publishes the current document. [More details](#publishbutton). |
| `PreviewButton` | A button that previews the current document. [More details](#previewbutton). |
| `Description` | A description of the Global. [More details](#description). |
### SaveButton
@@ -262,92 +260,6 @@ export function MyCustomDocumentControlButton(
}
```
### editMenuItems
The `editMenuItems` property allows you to inject custom components into the 3-dot menu dropdown located in the document controls bar. This dropdown contains default options including `Create New`, `Duplicate`, `Delete`, and other options when additional features are enabled. Any custom components you add will appear below these default items.
To add `editMenuItems`, use the `components.edit.editMenuItems` property in your [Collection Config](../configuration/collections):
#### Config Example
```ts
import type { CollectionConfig } from 'payload'
export const Pages: CollectionConfig = {
slug: 'pages',
admin: {
components: {
edit: {
// highlight-start
editMenuItems: ['/path/to/CustomEditMenuItem'],
// highlight-end
},
},
},
}
```
Here's an example of a custom `editMenuItems` component:
#### Server Component
```tsx
import React from 'react'
import { PopupList } from '@payloadcms/ui'
import type { EditMenuItemsServerProps } from 'payload'
export const EditMenuItems = async (props: EditMenuItemsServerProps) => {
const href = `/custom-action?id=${props.id}`
return (
<PopupList.ButtonGroup>
<PopupList.Button href={href}>Custom Edit Menu Item</PopupList.Button>
<PopupList.Button href={href}>
Another Custom Edit Menu Item - add as many as you need!
</PopupList.Button>
</PopupList.ButtonGroup>
)
}
```
#### Client Component
```tsx
'use client'
import React from 'react'
import { PopupList } from '@payloadcms/ui'
import type { EditViewMenuItemClientProps } from 'payload'
export const EditMenuItems = (props: EditViewMenuItemClientProps) => {
const handleClick = () => {
console.log('Custom button clicked!')
}
return (
<PopupList.ButtonGroup>
<PopupList.Button onClick={handleClick}>
Custom Edit Menu Item
</PopupList.Button>
<PopupList.Button onClick={handleClick}>
Another Custom Edit Menu Item - add as many as you need!
</PopupList.Button>
</PopupList.ButtonGroup>
)
}
```
<Banner type="info">
**Styling:** Use Payload's built-in `PopupList.Button` to ensure your menu
items automatically match the default dropdown styles. If you want a different
look, you can customize the appearance by passing your own `className` to
`PopupList.Button`, or use a completely custom button built with a standard
HTML `button` element or any other component that fits your design
preferences.
</Banner>
### SaveDraftButton
The `SaveDraftButton` property allows you to render a custom Save Draft Button in the Edit View.

View File

@@ -94,7 +94,6 @@ The following options are available:
| `beforeListTable` | An array of custom components to inject before the table of documents in the List View. [More details](#beforelisttable). |
| `afterList` | An array of custom components to inject after the list of documents in the List View. [More details](#afterlist). |
| `afterListTable` | An array of custom components to inject after the table of documents in the List View. [More details](#afterlisttable). |
| `listMenuItems` | An array of components to render within a menu next to the List Controls (after the Columns and Filters options) |
| `Description` | A component to render a description of the Collection. [More details](#description). |
### beforeList

View File

@@ -372,13 +372,13 @@ export default function MyCustomLogo() {
}
```
### header
### Header
The `header` property allows you to inject Custom Components above the Payload header.
The `Header` property allows you to inject Custom Components above the Payload header.
Examples of a custom header components might include an announcements banner, a notifications bar, or anything else you'd like to display at the top of the Admin Panel in a prominent location.
To add `header` components, use the `admin.components.header` property in your Payload Config:
To add `Header` components, use the `admin.components.header` property in your Payload Config:
```ts
import { buildConfig } from 'payload'
@@ -388,14 +388,14 @@ export default buildConfig({
admin: {
// highlight-start
components: {
header: ['/path/to/your/component'],
Header: ['/path/to/your/component'],
},
// highlight-end
},
})
```
Here is an example of a simple `header` component:
Here is an example of a simple `Header` component:
```tsx
export default function MyCustomHeader() {

View File

@@ -80,8 +80,6 @@ export default buildConfig({
| `afterSchemaInit` | Drizzle schema hook. Runs after the schema is built. [More Details](#afterschemainit) |
| `generateSchemaOutputFile` | Override generated schema from `payload generate:db-schema` file path. Defaults to `{CWD}/src/payload-generated.schema.ts` |
| `allowIDOnCreate` | Set to `true` to use the `id` passed in data on the create API operations without using a custom ID field. |
| `readReplicas` | An array of DB read replicas connection strings, can be used to offload read-heavy traffic. |
| `blocksAsJSON` | Store blocks as a JSON column instead of using the relational structure which can improve performance with a large amount of blocks |
## Access to Drizzle

View File

@@ -50,7 +50,6 @@ export default buildConfig({
| `generateSchemaOutputFile` | Override generated schema from `payload generate:db-schema` file path. Defaults to `{CWD}/src/payload-generated.schema.ts` |
| `autoIncrement` | Pass `true` to enable SQLite [AUTOINCREMENT](https://www.sqlite.org/autoinc.html) for primary keys to ensure the same ID cannot be reused from deleted rows |
| `allowIDOnCreate` | Set to `true` to use the `id` passed in data on the create API operations without using a custom ID field. |
| `blocksAsJSON` | Store blocks as a JSON column instead of using the relational structure which can improve performance with a large amount of blocks |
## Access to Drizzle

View File

@@ -305,22 +305,6 @@ The following additional properties are provided in the `ctx` object:
| `req` | The current HTTP request object. Contains `payload`, `user`, etc. |
| `event` | Either `onChange` or `submit` depending on the current action. Used as a performance opt-in. [More details](#async-field-validations). |
#### Localized and Built-in Error Messages
You can return localized error messages by utilizing the translation function provided in the `req` object:
```ts
import type { Field } from 'payload'
export const MyField: Field = {
type: 'text',
name: 'myField',
validate: (value, {req: { t }}) => Boolean(value) || t('validation:required'), // highlight-line
}
```
This way you can use [Custom Translations](https://payloadcms.com/docs/configuration/i18n#custom-translations) as well as Payload's built in error messages (like `validation:required` used in the example above). For a full list of available translation strings, see the [english translation file](https://github.com/payloadcms/payload/blob/main/packages/translations/src/languages/en.ts) of Payload.
#### Reusing Default Field Validations
When using custom validation functions, Payload will use yours in place of the default. However, you might want to simply augment the default validation with your own custom logic.

View File

@@ -54,7 +54,7 @@ export const MySelectField: Field = {
| **`enumName`** | Custom enum name for this field when using SQL Database Adapter ([Postgres](/docs/database/postgres)). Auto-generated from name if not defined. |
| **`dbName`** | Custom table name (if `hasMany` set to `true`) for this field when using SQL Database Adapter ([Postgres](/docs/database/postgres)). Auto-generated from name if not defined. |
| **`interfaceName`** | Create a top level, reusable [Typescript interface](/docs/typescript/generating-types#custom-field-interfaces) & [GraphQL type](/docs/graphql/graphql-schema#custom-field-schemas). |
| **`filterOptions`** | Dynamically filter which options are available based on the user, data, etc. [More details](#filteroptions) |
| **`filterOptions`** | Dynamically filter which options are available based on the user, data, etc. [More details](#filterOptions) |
| **`typescriptSchema`** | Override field type generation with providing a JSON schema |
| **`virtual`** | Provide `true` to disable field in the database, or provide a string path to [link the field with a relationship](/docs/fields/relationship#linking-virtual-fields-with-relationships). See [Virtual Fields](https://payloadcms.com/blog/learn-how-virtual-fields-can-help-solve-common-cms-challenges) |

View File

@@ -23,12 +23,6 @@ On the payload config, you can configure the following settings under the `folde
// Type definition
type RootFoldersConfiguration = {
/**
* If true, the browse by folder view will be enabled
*
* @default true
*/
browseByFolder?: boolean
/**
* An array of functions to be ran when the folder collection is initialized
* This allows plugins to modify the collection configuration
@@ -88,16 +82,7 @@ To enable folders on a collection, you need to set the `admin.folders` property
```ts
// Type definition
type CollectionFoldersConfiguration =
| boolean
| {
/**
* If true, the collection will be included in the browse by folder view
*
* @default true
*/
browseByFolder?: boolean
}
type CollectionFoldersConfiguration = boolean
```
```ts

View File

@@ -121,7 +121,7 @@ The following arguments are provided to the `beforeValidate` hook:
### beforeChange
Immediately before validation, beforeChange hooks will run during create and update operations. At this stage, the data should be treated as unvalidated user input. There is no guarantee that required fields exist or that fields are in the correct format. As such, using this data for side effects requires manual validation. You can optionally modify the shape of the data to be saved.
Immediately following validation, `beforeChange` hooks will run within `create` and `update` operations. At this stage, you can be confident that the data that will be saved to the document is valid in accordance to your field validations. You can optionally modify the shape of data to be saved.
```ts
import type { CollectionBeforeChangeHook } from 'payload'
@@ -160,7 +160,6 @@ The following arguments are provided to the `afterChange` hook:
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`collection`** | The [Collection](../configuration/collections) in which this Hook is running against. |
| **`context`** | Custom context passed between hooks. [More details](./context). |
| **`data`** | The incoming data passed through the operation. |
| **`doc`** | The resulting Document after changes are applied. |
| **`operation`** | The name of the operation that this hook is running within. |
| **`previousDoc`** | The Document before changes were applied. |

View File

@@ -128,18 +128,20 @@ const MyCollection: CollectionConfig = {
## TypeScript
The default TypeScript interface for `context` is `{ [key: string]: unknown }`. If you prefer a more strict typing in your project or when authoring plugins for others, you can override this using the `declare module` syntax.
The default TypeScript interface for `context` is `{ [key: string]: unknown }`. If you prefer a more strict typing in your project or when authoring plugins for others, you can override this using the `declare` syntax.
This is known as [module augmentation / declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation), a TypeScript feature which allows us to add properties to existing types. Simply put this in any `.ts` or `.d.ts` file:
This is known as "type augmentation", a TypeScript feature which allows us to add types to existing types. Simply put this in any `.ts` or `.d.ts` file:
```ts
import { RequestContext as OriginalRequestContext } from 'payload'
declare module 'payload' {
// Augment the RequestContext interface to include your custom properties
export interface RequestContext {
// Create a new interface that merges your additional fields with the original one
export interface RequestContext extends OriginalRequestContext {
myObject?: string
// ...
}
}
```
This will add the property `myObject` with a type of string to every context object. Make sure to follow this example correctly, as module augmentation can mess up your types if you do it wrong.
This will add the property `myObject` with a type of string to every context object. Make sure to follow this example correctly, as type augmentation can mess up your types if you do it wrong.

View File

@@ -128,7 +128,6 @@ The following arguments are provided to the `afterChange` hook:
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`global`** | The [Global](../configuration/globals) in which this Hook is running against. |
| **`context`** | Custom context passed between hooks. [More details](./context). |
| **`data`** | The incoming data passed through the operation. |
| **`doc`** | The resulting Document after changes are applied. |
| **`previousDoc`** | The Document before changes were applied. |
| **`req`** | The [Web Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object. This is mocked for [Local API](../local-api/overview) operations. |

View File

@@ -68,26 +68,3 @@ Here's a quick overview:
- Workflows are groupings of specific tasks which should be run in-order, and can be retried from a specific point of failure
- A Job is an instance of a single task or workflow which will be executed
- A Queue is a way to segment your jobs into different "groups" - for example, some to run nightly, and others to run every 10 minutes
### Visualizing Jobs in the Admin UI
By default, the internal `payload-jobs` collection is hidden from the Payload Admin Panel. To make this collection visible for debugging or inspection purposes, you can override its configuration using `jobsCollectionOverrides`.
```ts
import { buildConfig } from 'payload'
export default buildConfig({
// ... other config
jobs: {
// ... other job settings
jobsCollectionOverrides: ({ defaultJobsCollection }) => {
if (!defaultJobsCollection.admin) {
defaultJobsCollection.admin = {}
}
defaultJobsCollection.admin.hidden = false
return defaultJobsCollection
},
},
})
```

View File

@@ -30,9 +30,7 @@ As mentioned above, you can queue jobs, but the jobs won't run unless a worker p
### Cron jobs
The `jobs.autoRun` property allows you to configure cron jobs that automatically run queued jobs at specified intervals. Note that this does not _queue_ new jobs - only _runs_ jobs that are already in the specified queue.
**Example**:
You can use the `jobs.autoRun` property to configure cron jobs:
```ts
export default buildConfig({
@@ -82,12 +80,6 @@ await fetch('/api/payload-jobs/run?limit=100&queue=nightly', {
This endpoint is automatically mounted for you and is helpful in conjunction with serverless platforms like Vercel, where you might want to use Vercel Cron to invoke a serverless function that executes your jobs.
**Query Parameters:**
- `limit`: The maximum number of jobs to run in this invocation (default: 10).
- `queue`: The name of the queue to run jobs from. If not specified, jobs will be run from the `default` queue.
- `allQueues`: If set to `true`, all jobs from all queues will be run. This will ignore the `queue` parameter.
**Vercel Cron Example**
If you're deploying on Vercel, you can add a `vercel.json` file in the root of your project that configures Vercel Cron to invoke the `run` endpoint on a cron schedule.
@@ -145,15 +137,11 @@ If you want to process jobs programmatically from your server-side code, you can
**Run all jobs:**
```ts
// Run all jobs from the `default` queue - default limit is 10
const results = await payload.jobs.run()
// You can customize the queue name and limit by passing them as arguments:
await payload.jobs.run({ queue: 'nightly', limit: 100 })
// Run all jobs from all queues:
await payload.jobs.run({ allQueues: true })
// You can provide a where clause to filter the jobs that should be run:
await payload.jobs.run({
where: { 'input.message': { equals: 'secret' } },
@@ -170,22 +158,10 @@ const results = await payload.jobs.runByID({
### Bin script
Finally, you can process jobs via the bin script that comes with Payload out of the box. By default, this script will run jobs from the `default` queue, with a limit of 10 jobs per invocation:
Finally, you can process jobs via the bin script that comes with Payload out of the box.
```sh
npx payload jobs:run
```
You can override the default queue and limit by passing the `--queue` and `--limit` flags:
```sh
npx payload jobs:run --queue myQueue --limit 15
```
If you want to run all jobs from all queues, you can pass the `--all-queues` flag:
```sh
npx payload jobs:run --all-queues
npx payload jobs:run --queue default --limit 10
```
In addition, the bin script allows you to pass a `--cron` flag to the `jobs:run` command to run the jobs on a scheduled, cron basis:

View File

@@ -470,31 +470,6 @@ formBuilderPlugin({
})
```
### Preventing generated schema naming conflicts
Plugin fields can cause GraphQL type name collisions with your own blocks or collections. This results in errors like:
```plaintext
Error: Schema must contain uniquely named types but contains multiple types named "Country"
```
You can resolve this by overriding:
- `graphQL.singularName` in your collection config (for GraphQL schema conflicts)
- `interfaceName` in your block config
- `interfaceName` in the plugin field config
```ts
// payload.config.ts
formBuilderPlugin({
fields: {
country: {
interfaceName: 'CountryFormBlock', // overrides the generated type name to avoid a conflict
},
},
})
```
## Email
This plugin relies on the [email configuration](../email/overview) defined in your Payload configuration. It will read from your config and attempt to send your emails using the credentials provided.

View File

@@ -180,8 +180,8 @@ and `createBreadcrumbField` methods. They will merge your customizations overtop
```ts
import type { CollectionConfig } from 'payload'
import { createParentField } from '@payloadcms/plugin-nested-docs'
import { createBreadcrumbsField } from '@payloadcms/plugin-nested-docs'
import { createParentField } from '@payloadcms/plugin-nested-docs/fields'
import { createBreadcrumbsField } from '@payloadcms/plugin-nested-docs/fields'
const examplePageConfig: CollectionConfig = {
slug: 'pages',

View File

@@ -84,28 +84,6 @@ const config = buildConfig({
export default config
```
## Instrumenting Database Queries
If you want Sentry to capture Postgres query performance traces, you need to inject the Sentry-patched `pg` driver into the Postgres adapter. This ensures Sentrys instrumentation hooks into your database calls.
```ts
import * as Sentry from '@sentry/nextjs'
import { buildConfig } from 'payload'
import { sentryPlugin } from '@payloadcms/plugin-sentry'
import { postgresAdapter } from '@payloadcms/db-postgres'
import pg from 'pg'
export default buildConfig({
db: postgresAdapter({
pool: { connectionString: process.env.DATABASE_URL },
pg, // Inject the patched pg driver for Sentry instrumentation
}),
plugins: [
sentryPlugin({ Sentry }),
],
})
```
## Options
- `Sentry` : Sentry | **required**

View File

@@ -115,7 +115,6 @@ Set the `uploadsCollection` to your application's upload-enabled collection slug
##### `tabbedUI`
When the `tabbedUI` property is `true`, it appends an `SEO` tab onto your config using Payload's [Tabs Field](../fields/tabs). If your collection is not already tab-enabled, meaning the first field in your config is not of type `tabs`, then one will be created for you called `Content`. Defaults to `false`.
Note that the order of plugins or fields in your config may affect whether or not the plugin can smartly merge tabs with your existing fields. If you have a complex structure we recommend you [make use of the fields directly](#direct-use-of-fields) instead of relying on this config option.
<Banner type="info">
If you wish to continue to use top-level or sidebar fields with `tabbedUI`,

View File

@@ -6,6 +6,8 @@ desc: You don't want to have a DB connection while building your Docker containe
keywords: deployment, production, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
---
# Building without a DB connection
One of the most common problems when building a site for production, especially with Docker - is the DB connection requirement.
The important note is that Payload by itself does not have this requirement, But [Next.js' SSG ](https://nextjs.org/docs/pages/building-your-application/rendering/static-site-generation) does if any of your route segments have SSG enabled (which is default, unless you opted out or used a [Dynamic API](https://nextjs.org/docs/app/deep-dive/caching#dynamic-apis)) and use the Payload Local API.

View File

@@ -207,4 +207,4 @@ const config = buildConfig({
})
```
The `filterConstraints` function receives the same arguments as [`filterOptions`](../fields/select#filteroptions) in the [Select field](../fields/select).
The `filterConstraints` function receives the same arguments as [`filterOptions`](../fields/select#filterOptions) in the [Select field](../fields/select).

View File

@@ -336,17 +336,3 @@ You can customize the placeholder (the text that appears in the editor when it's
}),
}
```
## Detecting empty editor state
When you first type into a rich text field and subsequently delete everything through the admin panel, its value changes from `null` to a JSON object containing an empty paragraph.
If needed, you can reset the field value to `null` programmatically - for example, by using a custom hook to detect when the editor is empty.
This also applies to fields like `text` and `textArea`, which could be stored as either `null` or an empty value in the database. Since the empty value for richText is a JSON object, checking for emptiness is a bit more involved - so Payload provides a utility for it:
```ts
import { hasText } from '@payloadcms/richtext-lexical/shared'
hasText(richtextData)
```

View File

@@ -81,7 +81,6 @@ The default `elements` available in Payload are:
- `link`
- `ol`
- `ul`
- `li`
- `textAlign`
- `indent`
- [`relationship`](#relationship-element)

View File

@@ -95,7 +95,6 @@ _An asterisk denotes that an option is required._
| **`adminThumbnail`** | Set the way that the [Admin Panel](../admin/overview) will display thumbnails for this Collection. [More](#admin-thumbnails) |
| **`bulkUpload`** | Allow users to upload in bulk from the list view, default is true |
| **`cacheTags`** | Set to `false` to disable the cache tag set in the UI for the admin thumbnail component. Useful for when CDNs don't allow certain cache queries. |
| **`constructorOptions`** | An object passed to the the Sharp image library that accepts any Constructor options and applies them to the upload file. [More](https://sharp.pixelplumbing.com/api-constructor/) |
| **`crop`** | Set to `false` to disable the cropping tool in the [Admin Panel](../admin/overview). Crop is enabled by default. [More](#crop-and-focal-point-selector) |
| **`disableLocalStorage`** | Completely disable uploading files to disk locally. [More](#disabling-local-upload-storage) |
| **`displayPreview`** | Enable displaying preview of the uploaded file in Upload fields related to this Collection. Can be locally overridden by `displayPreview` option in Upload field. [More](/docs/fields/upload#config-options). |

View File

@@ -84,7 +84,7 @@ pnpm add @payloadcms/storage-s3
- The `config` object can be any [`S3ClientConfig`](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3) object (from [`@aws-sdk/client-s3`](https://github.com/aws/aws-sdk-js-v3)). _This is highly dependent on your AWS setup_. Check the AWS documentation for more information.
- When enabled, this package will automatically set `disableLocalStorage` to `true` for each collection.
- When deploying to Vercel, server uploads are limited with 4.5MB. Set `clientUploads` to `true` to do uploads directly on the client. You must allow CORS PUT method for the bucket to your website.
- Configure `signedDownloads` (either globally of per-collection in `collections`) to use [presigned URLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-presigned-url.html) for files downloading. This can improve performance for large files (like videos) while still respecting your access control. Additionally, with `signedDownloads.shouldUseSignedURL` you can specify a condition whether Payload should use a presigned URL, if you want to use this feature only for specific files.
- Configure `signedDownloads` (either globally of per-collection in `collections`) to use [presigned URLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-presigned-url.html) for files downloading. This can improve performance for large files (like videos) while still respecting your access control.
```ts
import { s3Storage } from '@payloadcms/storage-s3'
@@ -100,14 +100,6 @@ export default buildConfig({
'media-with-prefix': {
prefix,
},
'media-with-presigned-downloads': {
// Filter only mp4 files
signedDownloads: {
shouldUseSignedURL: ({ collection, filename, req }) => {
return filename.endsWith('.mp4')
},
},
},
},
bucket: process.env.S3_BUCKET,
config: {

View File

@@ -51,37 +51,12 @@ Within the Admin UI, if drafts are enabled, a document can be shown with one of
#### Updating or creating drafts
If you enable drafts on a collection or global, the `create` and `update` operations for REST, GraphQL, and Local APIs expose a new option called `draft` which allows you to specify if you are creating or updating a **draft**, or if you're just sending your changes straight to the published document.
For example:
```ts
// REST API
POST /api/your-collection?draft=true
// Local API
await payload.create({
collection: 'your-collection',
data: {
// your data here
},
draft: true, // This is required to create a draft
})
// GraphQL
mutation {
createYourCollection(data: { ... }, draft: true) {
// ...
}
}
```
If you enable drafts on a collection or global, the `create` and `update` operations for REST, GraphQL, and Local APIs expose a new option called `draft` which allows you to specify if you are creating or updating a **draft**, or if you're just sending your changes straight to the published document. For example, if you pass the query parameter `?draft=true` to a REST `create` or `update` operation, your action will be treated as if you are creating a `draft` and not a published document. By default, the `draft` argument is set to `false`.
**Required fields**
If `draft` is enabled while creating or updating a document, all fields are considered as not required, so that you can save drafts that are incomplete.
Setting `_status: "draft"` will not bypass the required fields. You need to set `draft: true` as shown in the previous examples.
#### Reading drafts vs. published documents
In addition to the `draft` argument within `create` and `update` operations, a `draft` argument is also exposed for `find` and `findByID` operations.

View File

@@ -1,12 +1,14 @@
import configPromise from '@payload-config'
import { getPayload } from 'payload'
export const GET = async (request: Request) => {
export const GET = async () => {
const payload = await getPayload({
config: configPromise,
})
return Response.json({
message: 'This is an example of a custom route.',
const data = await payload.find({
collection: 'users',
})
return Response.json(data)
}

View File

@@ -1,12 +1,14 @@
import configPromise from '@payload-config'
import { getPayload } from 'payload'
export const GET = async (request: Request) => {
export const GET = async () => {
const payload = await getPayload({
config: configPromise,
})
return Response.json({
message: 'This is an example of a custom route.',
const data = await payload.find({
collection: 'users',
})
return Response.json(data)
}

View File

@@ -1,12 +1,8 @@
{
"name": "payload-monorepo",
"version": "3.43.0",
"version": "3.40.0",
"private": true,
"type": "module",
"workspaces": [
"packages/*",
"test/*"
],
"scripts": {
"bf": "pnpm run build:force",
"build": "pnpm run build:core",
@@ -64,12 +60,11 @@
"clean:build": "node ./scripts/delete-recursively.js 'media/' '**/dist/' '**/.cache/' '**/.next/' '**/.turbo/' '**/tsconfig.tsbuildinfo' '**/payload*.tgz' '**/meta_*.json'",
"clean:build:allowtgz": "node ./scripts/delete-recursively.js 'media/' '**/dist/' '**/.cache/' '**/.next/' '**/.turbo/' '**/tsconfig.tsbuildinfo' '**/meta_*.json'",
"clean:cache": "node ./scripts/delete-recursively.js node_modules/.cache! packages/payload/node_modules/.cache! .next/*",
"dev": "cross-env NODE_OPTIONS=\"--no-deprecation --max-old-space-size=16384\" tsx ./test/dev.ts",
"dev": "cross-env NODE_OPTIONS=--no-deprecation tsx ./test/dev.ts",
"dev:generate-db-schema": "pnpm runts ./test/generateDatabaseSchema.ts",
"dev:generate-graphql-schema": "pnpm runts ./test/generateGraphQLSchema.ts",
"dev:generate-importmap": "pnpm runts ./test/generateImportMap.ts",
"dev:generate-types": "pnpm runts ./test/generateTypes.ts",
"dev:memorydb": "cross-env NODE_OPTIONS=--no-deprecation tsx ./test/dev.ts --start-memory-db",
"dev:postgres": "cross-env PAYLOAD_DATABASE=postgres pnpm runts ./test/dev.ts",
"dev:prod": "cross-env NODE_OPTIONS=--no-deprecation tsx ./test/dev.ts --prod",
"dev:prod:memorydb": "cross-env NODE_OPTIONS=--no-deprecation tsx ./test/dev.ts --prod --start-memory-db",
@@ -102,16 +97,16 @@
"test:e2e": "pnpm runts ./test/runE2E.ts",
"test:e2e:debug": "cross-env NODE_OPTIONS=\"--no-deprecation --no-experimental-strip-types\" NODE_NO_WARNINGS=1 PWDEBUG=1 DISABLE_LOGGING=true playwright test",
"test:e2e:headed": "cross-env NODE_OPTIONS=\"--no-deprecation --no-experimental-strip-types\" NODE_NO_WARNINGS=1 DISABLE_LOGGING=true playwright test --headed",
"test:e2e:noturbo": "pnpm runts ./test/runE2E.ts --no-turbo",
"test:e2e:prod": "pnpm prepare-run-test-against-prod && pnpm runts ./test/runE2E.ts --prod",
"test:e2e:prod:ci": "pnpm prepare-run-test-against-prod:ci && pnpm runts ./test/runE2E.ts --prod",
"test:e2e:prod:ci:noturbo": "pnpm prepare-run-test-against-prod:ci && pnpm runts ./test/runE2E.ts --prod --no-turbo",
"test:e2e:prod:ci:turbo": "pnpm prepare-run-test-against-prod:ci && pnpm runts ./test/runE2E.ts --prod --turbo",
"test:e2e:turbo": "pnpm runts ./test/runE2E.ts --turbo",
"test:int": "cross-env NODE_OPTIONS=\"--no-deprecation --no-experimental-strip-types\" NODE_NO_WARNINGS=1 DISABLE_LOGGING=true jest --forceExit --detectOpenHandles --config=test/jest.config.js --runInBand",
"test:int:postgres": "cross-env NODE_OPTIONS=\"--no-deprecation --no-experimental-strip-types\" NODE_NO_WARNINGS=1 PAYLOAD_DATABASE=postgres DISABLE_LOGGING=true jest --forceExit --detectOpenHandles --config=test/jest.config.js --runInBand",
"test:int:sqlite": "cross-env NODE_OPTIONS=\"--no-deprecation --no-experimental-strip-types\" NODE_NO_WARNINGS=1 PAYLOAD_DATABASE=sqlite DISABLE_LOGGING=true jest --forceExit --detectOpenHandles --config=test/jest.config.js --runInBand",
"test:types": "tstyche",
"test:unit": "cross-env NODE_OPTIONS=\"--no-deprecation --no-experimental-strip-types\" NODE_NO_WARNINGS=1 DISABLE_LOGGING=true jest --forceExit --detectOpenHandles --config=jest.config.js --runInBand",
"translateNewKeys": "pnpm --filter @tools/scripts run generateTranslations:core"
"translateNewKeys": "pnpm --filter translations run translateNewKeys"
},
"lint-staged": {
"**/package.json": "sort-package-json",
@@ -122,7 +117,7 @@
],
"templates/website/**/*": "sh -c \"cd templates/website; pnpm install --no-frozen-lockfile --ignore-workspace; pnpm run lint --fix\"",
"templates/**/pnpm-lock.yaml": "pnpm runts scripts/remove-template-lock-files.ts",
"tsconfig.base.json": "node scripts/reset-tsconfig.js"
"tsconfig.json": "node scripts/reset-tsconfig.js"
},
"devDependencies": {
"@jest/globals": "29.7.0",
@@ -141,7 +136,7 @@
"@types/fs-extra": "^11.0.2",
"@types/jest": "29.5.12",
"@types/minimist": "1.2.5",
"@types/node": "22.15.30",
"@types/node": "22.5.4",
"@types/react": "19.1.0",
"@types/react-dom": "19.1.2",
"@types/shelljs": "0.8.15",
@@ -151,10 +146,7 @@
"create-payload-app": "workspace:*",
"cross-env": "7.0.3",
"dotenv": "16.4.7",
"drizzle-kit": "0.31.0",
"drizzle-orm": "0.43.1",
"escape-html": "^1.0.3",
"eslint": "9.22.0",
"drizzle-kit": "0.28.0",
"execa": "5.1.1",
"form-data": "3.0.1",
"fs-extra": "10.1.0",
@@ -163,11 +155,10 @@
"jest": "29.7.0",
"lint-staged": "15.2.7",
"minimist": "1.2.8",
"mongodb-memory-server": "10.1.4",
"mongodb-memory-server": "^10",
"next": "15.3.2",
"open": "^10.1.0",
"p-limit": "^5.0.0",
"pg": "8.11.3",
"playwright": "1.50.0",
"playwright-core": "1.50.0",
"prettier": "3.5.3",
@@ -185,10 +176,10 @@
"turbo": "^2.3.3",
"typescript": "5.7.3"
},
"packageManager": "pnpm@10.12.1",
"packageManager": "pnpm@9.7.1",
"engines": {
"node": "^18.20.2 || >=20.9.0",
"pnpm": "^10.12.1"
"pnpm": "^9.7.0"
},
"pnpm": {
"overrides": {
@@ -201,5 +192,9 @@
"react-dom": "$react-dom",
"typescript": "$typescript"
}
}
},
"workspaces:": [
"packages/*",
"test/*"
]
}

View File

@@ -1,6 +1,6 @@
{
"name": "@payloadcms/admin-bar",
"version": "3.43.0",
"version": "3.40.0",
"description": "An admin bar for React apps using Payload",
"homepage": "https://payloadcms.com",
"repository": {

View File

@@ -1,6 +1,6 @@
{
"name": "create-payload-app",
"version": "3.43.0",
"version": "3.40.0",
"homepage": "https://payloadcms.com",
"repository": {
"type": "git",
@@ -77,7 +77,7 @@
"@types/esprima": "^4.0.6",
"@types/fs-extra": "^9.0.12",
"@types/jest": "29.5.12",
"@types/node": "22.15.30"
"@types/node": "22.5.4"
},
"engines": {
"node": "^18.20.2 || >=20.9.0"

View File

@@ -7,7 +7,7 @@ export async function getExamples({ branch }: { branch: string }): Promise<Proje
const response = await fetch(url)
const examplesResponseList = (await response.json()) as { name: string; path: string }[]
const examplesResponseList: { name: string; path: string }[] = await response.json()
const examples: ProjectExample[] = examplesResponseList.map((example) => ({
name: example.name,

View File

@@ -19,7 +19,7 @@ export async function getLatestPackageVersion({
}) {
try {
const response = await fetch(`https://registry.npmjs.org/${packageName}`)
const data = (await response.json()) as { 'dist-tags': { latest: string } }
const data = await response.json()
const latestVersion = data['dist-tags'].latest
if (debug) {

View File

@@ -1,7 +1,3 @@
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
// Do not include DOM and DOM.Iterable as this is a server-only package.
"lib": ["ES2022"],
}
}

View File

@@ -1,6 +1,6 @@
{
"name": "@payloadcms/db-mongodb",
"version": "3.43.0",
"version": "3.40.0",
"description": "The officially supported MongoDB database adapter for Payload",
"homepage": "https://payloadcms.com",
"repository": {
@@ -47,7 +47,7 @@
"prepublishOnly": "pnpm clean && pnpm turbo build"
},
"dependencies": {
"mongoose": "8.15.1",
"mongoose": "8.9.5",
"mongoose-paginate-v2": "1.8.5",
"prompts": "2.4.2",
"uuid": "10.0.0"
@@ -57,8 +57,8 @@
"@types/mongoose-aggregate-paginate-v2": "1.0.12",
"@types/prompts": "^2.4.5",
"@types/uuid": "10.0.0",
"mongodb": "6.16.0",
"mongodb-memory-server": "10.1.4",
"mongodb": "6.12.0",
"mongodb-memory-server": "^10",
"payload": "workspace:*"
},
"peerDependencies": {

View File

@@ -40,9 +40,6 @@ export const connect: Connect = async function connect(
// If we are running a replica set with MongoDB Memory Server,
// wait until the replica set elects a primary before proceeding
if (this.mongoMemoryServer) {
this.payload.logger.info(
'Waiting for MongoDB Memory Server replica set to elect a primary...',
)
await new Promise((resolve) => setTimeout(resolve, 2000))
}
@@ -53,7 +50,7 @@ export const connect: Connect = async function connect(
this.beginTransaction = defaultBeginTransaction()
}
if (!hotReload) {
if (!this.mongoMemoryServer && !hotReload) {
if (process.env.PAYLOAD_DROP_DATABASE === 'true') {
this.payload.logger.info('---- DROPPING DATABASE ----')
await mongoose.connection.dropDatabase()

View File

@@ -1,49 +1,29 @@
import type { DeleteVersions, FlattenedField } from 'payload'
import { APIError, buildVersionCollectionFields, buildVersionGlobalFields } from 'payload'
import { buildVersionCollectionFields, type DeleteVersions } from 'payload'
import type { MongooseAdapter } from './index.js'
import type { CollectionModel } from './types.js'
import { buildQuery } from './queries/buildQuery.js'
import { getCollection, getGlobal } from './utilities/getEntity.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
export const deleteVersions: DeleteVersions = async function deleteVersions(
this: MongooseAdapter,
{ collection: collectionSlug, globalSlug, locale, req, where },
{ collection: collectionSlug, locale, req, where },
) {
let fields: FlattenedField[]
let VersionsModel: CollectionModel
if (globalSlug) {
const { globalConfig, Model } = getGlobal({
adapter: this,
globalSlug,
versions: true,
})
fields = buildVersionGlobalFields(this.payload.config, globalConfig, true)
VersionsModel = Model
} else if (collectionSlug) {
const { collectionConfig, Model } = getCollection({
adapter: this,
collectionSlug,
versions: true,
})
fields = buildVersionCollectionFields(this.payload.config, collectionConfig, true)
VersionsModel = Model
} else {
throw new APIError('Either collection or globalSlug must be passed.')
}
const { collectionConfig, Model } = getCollection({
adapter: this,
collectionSlug,
versions: true,
})
const session = await getSession(this, req)
const query = await buildQuery({
adapter: this,
fields,
fields: buildVersionCollectionFields(this.payload.config, collectionConfig, true),
locale,
where,
})
await VersionsModel.deleteMany(query, { session })
await Model.deleteMany(query, { session })
}

View File

@@ -5,7 +5,11 @@ import mongoose from 'mongoose'
import type { MongooseAdapter } from './index.js'
export const destroy: Destroy = async function destroy(this: MongooseAdapter) {
await mongoose.disconnect()
if (this.mongoMemoryServer) {
await this.mongoMemoryServer.stop()
} else {
await mongoose.disconnect()
}
Object.keys(mongoose.models).map((model) => mongoose.deleteModel(model))
}

View File

@@ -245,13 +245,10 @@ export async function buildSearchParam({
value: { $in },
}
} else {
const nextSubPath = pathsToQuery[i + 1]?.path
if (nextSubPath) {
relationshipQuery = {
value: {
[nextSubPath]: { $in },
},
}
relationshipQuery = {
value: {
_id: { $in },
},
}
}
}

View File

@@ -1,5 +1,5 @@
import type { MongooseUpdateQueryOptions } from 'mongoose'
import type { Job, UpdateJobs, Where } from 'payload'
import type { BaseJob, UpdateJobs, Where } from 'payload'
import type { MongooseAdapter } from './index.js'
@@ -47,7 +47,7 @@ export const updateJobs: UpdateJobs = async function updateMany(
transform({ adapter: this, data, fields: collectionConfig.fields, operation: 'write' })
let result: Job[] = []
let result: BaseJob[] = []
try {
if (id) {

View File

@@ -1,8 +1,4 @@
{
"extends": "../../tsconfig.base.json",
"references": [{ "path": "../payload" }, { "path": "../translations" }],
"compilerOptions": {
// Do not include DOM and DOM.Iterable as this is a server-only package.
"lib": ["ES2022"],
}
"references": [{ "path": "../payload" }, { "path": "../translations" }]
}

View File

@@ -1,6 +1,6 @@
{
"name": "@payloadcms/db-postgres",
"version": "3.43.0",
"version": "3.40.0",
"description": "The officially supported Postgres database adapter for Payload",
"homepage": "https://payloadcms.com",
"repository": {
@@ -78,8 +78,8 @@
"@payloadcms/drizzle": "workspace:*",
"@types/pg": "8.10.2",
"console-table-printer": "2.12.1",
"drizzle-kit": "0.31.1",
"drizzle-orm": "0.44.2",
"drizzle-kit": "0.28.0",
"drizzle-orm": "0.36.1",
"pg": "8.11.3",
"prompts": "2.4.2",
"to-snake-case": "1.0.0",

View File

@@ -1,32 +1,31 @@
import type { DrizzleAdapter } from '@payloadcms/drizzle/types'
import type { Connect, Migration } from 'payload'
import type { Connect, Migration, Payload } from 'payload'
import { pushDevSchema } from '@payloadcms/drizzle'
import { drizzle } from 'drizzle-orm/node-postgres'
import { withReplicas } from 'drizzle-orm/pg-core'
import type { PostgresAdapter } from './types.js'
const connectWithReconnect = async function ({
adapter,
pool,
payload,
reconnect = false,
}: {
adapter: PostgresAdapter
pool: PostgresAdapter['pool']
payload: Payload
reconnect?: boolean
}) {
let result
if (!reconnect) {
result = await pool.connect()
result = await adapter.pool.connect()
} else {
try {
result = await pool.connect()
result = await adapter.pool.connect()
} catch (ignore) {
setTimeout(() => {
adapter.payload.logger.info('Reconnecting to postgres')
void connectWithReconnect({ adapter, pool, reconnect: true })
payload.logger.info('Reconnecting to postgres')
void connectWithReconnect({ adapter, payload, reconnect: true })
}, 1000)
}
}
@@ -36,7 +35,7 @@ const connectWithReconnect = async function ({
result.prependListener('error', (err) => {
try {
if (err.code === 'ECONNRESET') {
void connectWithReconnect({ adapter, pool, reconnect: true })
void connectWithReconnect({ adapter, payload, reconnect: true })
}
} catch (ignore) {
// swallow error
@@ -55,29 +54,12 @@ export const connect: Connect = async function connect(
try {
if (!this.pool) {
this.pool = new this.pg.Pool(this.poolOptions)
await connectWithReconnect({ adapter: this, pool: this.pool })
await connectWithReconnect({ adapter: this, payload: this.payload })
}
const logger = this.logger || false
this.drizzle = drizzle({ client: this.pool, logger, schema: this.schema })
if (this.readReplicaOptions) {
const readReplicas = this.readReplicaOptions.map((connectionString) => {
const options = {
...this.poolOptions,
connectionString,
}
const pool = new this.pg.Pool(options)
void connectWithReconnect({
adapter: this,
pool,
})
return drizzle({ client: pool, logger, schema: this.schema })
})
const myReplicas = withReplicas(this.drizzle, readReplicas as any)
this.drizzle = myReplicas
}
if (!hotReload) {
if (process.env.PAYLOAD_DROP_DATABASE === 'true') {
this.payload.logger.info(`---- DROPPING TABLES SCHEMA(${this.schemaName || 'public'}) ----`)

View File

@@ -99,7 +99,6 @@ export function postgresAdapter(args: Args): DatabaseAdapterObj<PostgresAdapter>
afterSchemaInit: args.afterSchemaInit ?? [],
allowIDOnCreate,
beforeSchemaInit: args.beforeSchemaInit ?? [],
blocksAsJSON: args.blocksAsJSON ?? false,
createDatabase,
createExtensions,
createMigration: buildCreateMigration({
@@ -140,7 +139,6 @@ export function postgresAdapter(args: Args): DatabaseAdapterObj<PostgresAdapter>
prodMigrations: args.prodMigrations,
// @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve
push: args.push,
readReplicaOptions: args.readReplicas,
relations: {},
relationshipsSuffix: args.relationshipsSuffix || '_rels',
schema: {},

View File

@@ -3,19 +3,13 @@ import type {
GenericEnum,
MigrateDownArgs,
MigrateUpArgs,
PostgresDB,
PostgresSchemaHook,
} from '@payloadcms/drizzle/postgres'
import type { DrizzleAdapter } from '@payloadcms/drizzle/types'
import type { DrizzleConfig, ExtractTablesWithRelations } from 'drizzle-orm'
import type { DrizzleConfig } from 'drizzle-orm'
import type { NodePgDatabase } from 'drizzle-orm/node-postgres'
import type {
PgDatabase,
PgQueryResultHKT,
PgSchema,
PgTableFn,
PgTransactionConfig,
PgWithReplicas,
} from 'drizzle-orm/pg-core'
import type { PgSchema, PgTableFn, PgTransactionConfig } from 'drizzle-orm/pg-core'
import type { Pool, PoolConfig } from 'pg'
type PgDependency = typeof import('pg')
@@ -41,10 +35,6 @@ export type Args = {
* To generate Drizzle schema from the database, see [Drizzle Kit introspection](https://orm.drizzle.team/kit-docs/commands#introspect--pull)
*/
beforeSchemaInit?: PostgresSchemaHook[]
/**
* Store blocks as JSON column instead of storing them in relational structure.
*/
blocksAsJSON?: boolean
/**
* Pass `true` to disale auto database creation if it doesn't exist.
* @default false
@@ -65,7 +55,6 @@ export type Args = {
up: (args: MigrateUpArgs) => Promise<void>
}[]
push?: boolean
readReplicas?: string[]
relationshipsSuffix?: string
/**
* The schema name to use for the database
@@ -85,16 +74,7 @@ type ResolveSchemaType<T> = 'schema' extends keyof T
? T['schema']
: GeneratedDatabaseSchema['schemaUntyped']
type Drizzle =
| NodePgDatabase<ResolveSchemaType<GeneratedDatabaseSchema>>
| PgWithReplicas<
PgDatabase<
PgQueryResultHKT,
Record<string, unknown>,
ExtractTablesWithRelations<Record<string, unknown>>
>
>
type Drizzle = NodePgDatabase<ResolveSchemaType<GeneratedDatabaseSchema>>
export type PostgresAdapter = {
drizzle: Drizzle
pg: PgDependency

View File

@@ -10,9 +10,5 @@
{
"path": "../drizzle"
}
],
"compilerOptions": {
// Do not include DOM and DOM.Iterable as this is a server-only package.
"lib": ["ES2022"],
}
]
}

View File

@@ -1,6 +1,6 @@
{
"name": "@payloadcms/db-sqlite",
"version": "3.43.0",
"version": "3.40.0",
"description": "The officially supported SQLite database adapter for Payload",
"homepage": "https://payloadcms.com",
"repository": {
@@ -76,8 +76,8 @@
"@libsql/client": "0.14.0",
"@payloadcms/drizzle": "workspace:*",
"console-table-printer": "2.12.1",
"drizzle-kit": "0.31.1",
"drizzle-orm": "0.44.2",
"drizzle-kit": "0.28.0",
"drizzle-orm": "0.36.1",
"prompts": "2.4.2",
"to-snake-case": "1.0.0",
"uuid": "9.0.0"

View File

@@ -89,7 +89,6 @@ export function sqliteAdapter(args: Args): DatabaseAdapterObj<SQLiteAdapter> {
allowIDOnCreate,
autoIncrement: args.autoIncrement ?? false,
beforeSchemaInit: args.beforeSchemaInit ?? [],
blocksAsJSON: args.blocksAsJSON ?? false,
// @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve
client: undefined,
clientConfig: args.client,

View File

@@ -50,10 +50,6 @@ export type Args = {
* To generate Drizzle schema from the database, see [Drizzle Kit introspection](https://orm.drizzle.team/kit-docs/commands#introspect--pull)
*/
beforeSchemaInit?: SQLiteSchemaHook[]
/**
* Store blocks as JSON column instead of storing them in relational structure.
*/
blocksAsJSON?: boolean
client: Config
/** Generated schema from payload generate:db-schema file path */
generateSchemaOutputFile?: string

View File

@@ -10,9 +10,5 @@
{
"path": "../drizzle"
}
],
"compilerOptions": {
// Do not include DOM and DOM.Iterable as this is a server-only package.
"lib": ["ES2022"],
}
]
}

View File

@@ -1,6 +1,6 @@
{
"name": "@payloadcms/db-vercel-postgres",
"version": "3.43.0",
"version": "3.40.0",
"description": "Vercel Postgres adapter for Payload",
"homepage": "https://payloadcms.com",
"repository": {
@@ -78,8 +78,8 @@
"@payloadcms/drizzle": "workspace:*",
"@vercel/postgres": "^0.9.0",
"console-table-printer": "2.12.1",
"drizzle-kit": "0.31.1",
"drizzle-orm": "0.44.2",
"drizzle-kit": "0.28.0",
"drizzle-orm": "0.36.1",
"pg": "8.11.3",
"prompts": "2.4.2",
"to-snake-case": "1.0.0",

View File

@@ -4,7 +4,6 @@ import type { Connect, Migration } from 'payload'
import { pushDevSchema } from '@payloadcms/drizzle'
import { sql, VercelPool } from '@vercel/postgres'
import { drizzle } from 'drizzle-orm/node-postgres'
import { withReplicas } from 'drizzle-orm/pg-core'
import pg from 'pg'
import type { VercelPostgresAdapter } from './types.js'
@@ -47,19 +46,6 @@ export const connect: Connect = async function connect(
schema: this.schema,
})
if (this.readReplicaOptions) {
const readReplicas = this.readReplicaOptions.map((connectionString) => {
const options = {
...this.poolOptions,
connectionString,
}
const pool = new VercelPool(options)
return drizzle({ client: pool, logger, schema: this.schema })
})
const myReplicas = withReplicas(this.drizzle, readReplicas as any)
this.drizzle = myReplicas
}
if (!hotReload) {
if (process.env.PAYLOAD_DROP_DATABASE === 'true') {
this.payload.logger.info(`---- DROPPING TABLES SCHEMA(${this.schemaName || 'public'}) ----`)

View File

@@ -95,7 +95,6 @@ export function vercelPostgresAdapter(args: Args = {}): DatabaseAdapterObj<Verce
afterSchemaInit: args.afterSchemaInit ?? [],
allowIDOnCreate,
beforeSchemaInit: args.beforeSchemaInit ?? [],
blocksAsJSON: args.blocksAsJSON ?? false,
createDatabase,
createExtensions,
defaultDrizzleSnapshot,
@@ -175,7 +174,6 @@ export function vercelPostgresAdapter(args: Args = {}): DatabaseAdapterObj<Verce
find,
findGlobal,
findGlobalVersions,
readReplicaOptions: args.readReplicas,
// @ts-expect-error - vestiges of when tsconfig was not strict. Feel free to improve
findOne,
findVersions,

View File

@@ -33,10 +33,6 @@ export type Args = {
* To generate Drizzle schema from the database, see [Drizzle Kit introspection](https://orm.drizzle.team/kit-docs/commands#introspect--pull)
*/
beforeSchemaInit?: PostgresSchemaHook[]
/**
* Store blocks as JSON column instead of storing them in relational structure.
*/
blocksAsJSON?: boolean
connectionString?: string
/**
* Pass `true` to disale auto database creation if it doesn't exist.
@@ -68,7 +64,6 @@ export type Args = {
up: (args: MigrateUpArgs) => Promise<void>
}[]
push?: boolean
readReplicas?: string[]
relationshipsSuffix?: string
/**
* The schema name to use for the database

View File

@@ -10,9 +10,5 @@
{
"path": "../drizzle"
}
],
"compilerOptions": {
// Do not include DOM and DOM.Iterable as this is a server-only package.
"lib": ["ES2022"],
}
]
}

View File

@@ -1,6 +1,6 @@
{
"name": "@payloadcms/drizzle",
"version": "3.43.0",
"version": "3.40.0",
"description": "A library of shared functions used by different payload database adapters",
"homepage": "https://payloadcms.com",
"repository": {
@@ -55,7 +55,7 @@
"dependencies": {
"console-table-printer": "2.12.1",
"dequal": "2.0.3",
"drizzle-orm": "0.44.2",
"drizzle-orm": "0.36.1",
"prompts": "2.4.2",
"to-snake-case": "1.0.0",
"uuid": "9.0.0"
@@ -64,6 +64,7 @@
"@libsql/client": "0.14.0",
"@payloadcms/eslint-config": "workspace:*",
"@types/pg": "8.10.2",
"@types/prompts": "^2.4.5",
"@types/to-snake-case": "1.0.0",
"payload": "workspace:*"
},

View File

@@ -1,19 +1,16 @@
import type { Count, SanitizedCollectionConfig } from 'payload'
import toSnakeCase from 'to-snake-case'
import type { Count } from 'payload'
import type { DrizzleAdapter } from './types.js'
import { buildQuery } from './queries/buildQuery.js'
import { getCollection } from './utilities/getEntity.js'
import { getTransaction } from './utilities/getTransaction.js'
export const count: Count = async function count(
this: DrizzleAdapter,
{ collection, locale, req, where: whereArg },
{ collection: collectionSlug, locale, req, where: whereArg = {} },
) {
const collectionConfig: SanitizedCollectionConfig = this.payload.collections[collection].config
const tableName = this.tableNameMap.get(toSnakeCase(collectionConfig.slug))
const { collectionConfig, tableName } = getCollection({ adapter: this, collectionSlug })
const db = await getTransaction(this, req)

View File

@@ -1,24 +1,18 @@
import type { CountGlobalVersions, SanitizedGlobalConfig } from 'payload'
import type { CountGlobalVersions } from 'payload'
import { buildVersionGlobalFields } from 'payload'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from './types.js'
import { buildQuery } from './queries/buildQuery.js'
import { getGlobal } from './utilities/getEntity.js'
import { getTransaction } from './utilities/getTransaction.js'
export const countGlobalVersions: CountGlobalVersions = async function countGlobalVersions(
this: DrizzleAdapter,
{ global, locale, req, where: whereArg },
{ global: globalSlug, locale, req, where: whereArg = {} },
) {
const globalConfig: SanitizedGlobalConfig = this.payload.globals.config.find(
({ slug }) => slug === global,
)
const tableName = this.tableNameMap.get(
`_${toSnakeCase(globalConfig.slug)}${this.versionsSuffix}`,
)
const { globalConfig, tableName } = getGlobal({ adapter: this, globalSlug, versions: true })
const db = await getTransaction(this, req)

View File

@@ -1,22 +1,22 @@
import type { CountVersions, SanitizedCollectionConfig } from 'payload'
import type { CountVersions } from 'payload'
import { buildVersionCollectionFields } from 'payload'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from './types.js'
import { buildQuery } from './queries/buildQuery.js'
import { getCollection } from './utilities/getEntity.js'
import { getTransaction } from './utilities/getTransaction.js'
export const countVersions: CountVersions = async function countVersions(
this: DrizzleAdapter,
{ collection, locale, req, where: whereArg },
{ collection: collectionSlug, locale, req, where: whereArg = {} },
) {
const collectionConfig: SanitizedCollectionConfig = this.payload.collections[collection].config
const tableName = this.tableNameMap.get(
`_${toSnakeCase(collectionConfig.slug)}${this.versionsSuffix}`,
)
const { collectionConfig, tableName } = getCollection({
adapter: this,
collectionSlug,
versions: true,
})
const db = await getTransaction(this, req)

View File

@@ -1,10 +1,9 @@
import type { Create } from 'payload'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from './types.js'
import { upsertRow } from './upsertRow/index.js'
import { getCollection } from './utilities/getEntity.js'
import { getTransaction } from './utilities/getTransaction.js'
export const create: Create = async function create(
@@ -12,15 +11,13 @@ export const create: Create = async function create(
{ collection: collectionSlug, data, req, returning, select },
) {
const db = await getTransaction(this, req)
const collection = this.payload.collections[collectionSlug].config
const tableName = this.tableNameMap.get(toSnakeCase(collection.slug))
const { collectionConfig, tableName } = getCollection({ adapter: this, collectionSlug })
const result = await upsertRow({
adapter: this,
data,
db,
fields: collection.flattenedFields,
fields: collectionConfig.flattenedFields,
ignoreResult: returning === false,
operation: 'create',
req,

View File

@@ -1,20 +1,17 @@
import type { CreateGlobalArgs } from 'payload'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from './types.js'
import { upsertRow } from './upsertRow/index.js'
import { getGlobal } from './utilities/getEntity.js'
import { getTransaction } from './utilities/getTransaction.js'
export async function createGlobal<T extends Record<string, unknown>>(
this: DrizzleAdapter,
{ slug, data, req, returning }: CreateGlobalArgs,
{ slug: globalSlug, data, req, returning }: CreateGlobalArgs,
): Promise<T> {
const db = await getTransaction(this, req)
const globalConfig = this.payload.globals.config.find((config) => config.slug === slug)
const tableName = this.tableNameMap.get(toSnakeCase(globalConfig.slug))
const { globalConfig, tableName } = getGlobal({ adapter: this, globalSlug })
data.createdAt = new Date().toISOString()
@@ -30,10 +27,10 @@ export async function createGlobal<T extends Record<string, unknown>>(
})
if (returning === false) {
return null
return null as unknown as T
}
result.globalType = slug
result.globalType = globalSlug
return result
}

View File

@@ -2,11 +2,11 @@ import type { CreateGlobalVersionArgs, TypeWithID, TypeWithVersion } from 'paylo
import { sql } from 'drizzle-orm'
import { buildVersionGlobalFields } from 'payload'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from './types.js'
import { upsertRow } from './upsertRow/index.js'
import { getGlobal } from './utilities/getEntity.js'
import { getTransaction } from './utilities/getTransaction.js'
export async function createGlobalVersion<T extends TypeWithID>(
@@ -25,9 +25,7 @@ export async function createGlobalVersion<T extends TypeWithID>(
}: CreateGlobalVersionArgs,
) {
const db = await getTransaction(this, req)
const global = this.payload.globals.config.find(({ slug }) => slug === globalSlug)
const tableName = this.tableNameMap.get(`_${toSnakeCase(global.slug)}${this.versionsSuffix}`)
const { globalConfig, tableName } = getGlobal({ adapter: this, globalSlug, versions: true })
const result = await upsertRow<TypeWithVersion<T>>({
adapter: this,
@@ -41,7 +39,7 @@ export async function createGlobalVersion<T extends TypeWithID>(
version: versionData,
},
db,
fields: buildVersionGlobalFields(this.payload.config, global, true),
fields: buildVersionGlobalFields(this.payload.config, globalConfig, true),
ignoreResult: returning === false ? 'idOnly' : false,
operation: 'create',
req,
@@ -50,7 +48,7 @@ export async function createGlobalVersion<T extends TypeWithID>(
})
const table = this.tables[tableName]
if (global.versions.drafts) {
if (globalConfig.versions.drafts) {
await this.execute({
db,
sql: sql`

View File

@@ -2,11 +2,11 @@ import type { CreateVersionArgs, TypeWithID, TypeWithVersion } from 'payload'
import { sql } from 'drizzle-orm'
import { buildVersionCollectionFields } from 'payload'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from './types.js'
import { upsertRow } from './upsertRow/index.js'
import { getCollection } from './utilities/getEntity.js'
import { getTransaction } from './utilities/getTransaction.js'
export async function createVersion<T extends TypeWithID>(
@@ -26,12 +26,13 @@ export async function createVersion<T extends TypeWithID>(
}: CreateVersionArgs<T>,
) {
const db = await getTransaction(this, req)
const collection = this.payload.collections[collectionSlug].config
const defaultTableName = toSnakeCase(collection.slug)
const { collectionConfig, tableName } = getCollection({
adapter: this,
collectionSlug,
versions: true,
})
const tableName = this.tableNameMap.get(`_${defaultTableName}${this.versionsSuffix}`)
const version = { ...versionData }
const version: Partial<TypeWithID> = { ...versionData }
if (version.id) {
delete version.id
}
@@ -51,7 +52,7 @@ export async function createVersion<T extends TypeWithID>(
adapter: this,
data,
db,
fields: buildVersionCollectionFields(this.payload.config, collection, true),
fields: buildVersionCollectionFields(this.payload.config, collectionConfig, true),
operation: 'create',
req,
select,
@@ -60,7 +61,7 @@ export async function createVersion<T extends TypeWithID>(
const table = this.tables[tableName]
if (collection.versions.drafts) {
if (collectionConfig.versions.drafts) {
await this.execute({
db,
sql: sql`

View File

@@ -1,28 +1,26 @@
import type { DeleteMany } from 'payload'
import { inArray } from 'drizzle-orm'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from './types.js'
import { findMany } from './find/findMany.js'
import { getCollection } from './utilities/getEntity.js'
import { getTransaction } from './utilities/getTransaction.js'
export const deleteMany: DeleteMany = async function deleteMany(
this: DrizzleAdapter,
{ collection, req, where },
{ collection: collectionSlug, req, where },
) {
const db = await getTransaction(this, req)
const collectionConfig = this.payload.collections[collection].config
const tableName = this.tableNameMap.get(toSnakeCase(collectionConfig.slug))
const { collectionConfig, tableName } = getCollection({ adapter: this, collectionSlug })
const result = await findMany({
adapter: this,
fields: collectionConfig.flattenedFields,
joins: false,
limit: 0,
locale: req?.locale,
locale: req?.locale ?? undefined,
page: 1,
pagination: false,
req,
@@ -30,9 +28,9 @@ export const deleteMany: DeleteMany = async function deleteMany(
where,
})
const ids = []
const ids: (number | string)[] = []
result.docs.forEach((data) => {
result.docs.forEach((data: any) => {
ids.push(data.id)
})

View File

@@ -1,7 +1,6 @@
import type { DeleteOne } from 'payload'
import { eq } from 'drizzle-orm'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from './types.js'
@@ -9,6 +8,7 @@ import { buildFindManyArgs } from './find/buildFindManyArgs.js'
import { buildQuery } from './queries/buildQuery.js'
import { selectDistinct } from './queries/selectDistinct.js'
import { transform } from './transform/read/index.js'
import { getCollection, getTableQuery } from './utilities/getEntity.js'
import { getTransaction } from './utilities/getTransaction.js'
export const deleteOne: DeleteOne = async function deleteOne(
@@ -16,16 +16,14 @@ export const deleteOne: DeleteOne = async function deleteOne(
{ collection: collectionSlug, req, returning, select, where: whereArg },
) {
const db = await getTransaction(this, req)
const collection = this.payload.collections[collectionSlug].config
const { collectionConfig, tableName } = getCollection({ adapter: this, collectionSlug })
const tableName = this.tableNameMap.get(toSnakeCase(collection.slug))
let docToDelete: Record<string, unknown>
let docToDelete: Record<string, unknown> | undefined = undefined
const { joins, selectFields, where } = buildQuery({
adapter: this,
fields: collection.flattenedFields,
locale: req?.locale,
fields: collectionConfig.flattenedFields,
locale: req?.locale ?? undefined,
tableName,
where: whereArg,
})
@@ -40,15 +38,17 @@ export const deleteOne: DeleteOne = async function deleteOne(
where,
})
const queryTable = getTableQuery({ adapter: this, tableName })
if (selectDistinctResult?.[0]?.id) {
docToDelete = await db.query[tableName].findFirst({
docToDelete = await queryTable.findFirst({
where: eq(this.tables[tableName].id, selectDistinctResult[0].id),
})
} else {
const findManyArgs = buildFindManyArgs({
adapter: this,
depth: 0,
fields: collection.flattenedFields,
fields: collectionConfig.flattenedFields,
joinQuery: false,
select,
tableName,
@@ -56,7 +56,7 @@ export const deleteOne: DeleteOne = async function deleteOne(
findManyArgs.where = where
docToDelete = await db.query[tableName].findFirst(findManyArgs)
docToDelete = await queryTable.findFirst(findManyArgs)
}
if (!docToDelete) {
@@ -70,7 +70,7 @@ export const deleteOne: DeleteOne = async function deleteOne(
adapter: this,
config: this.payload.config,
data: docToDelete,
fields: collection.flattenedFields,
fields: collectionConfig.flattenedFields,
joinQuery: false,
tableName,
})

View File

@@ -1,37 +1,26 @@
import type { DeleteVersions, FlattenedField, SanitizedCollectionConfig } from 'payload'
import type { DeleteVersions } from 'payload'
import { inArray } from 'drizzle-orm'
import { APIError, buildVersionCollectionFields, buildVersionGlobalFields } from 'payload'
import toSnakeCase from 'to-snake-case'
import { buildVersionCollectionFields } from 'payload'
import type { DrizzleAdapter } from './types.js'
import { findMany } from './find/findMany.js'
import { getCollection } from './utilities/getEntity.js'
import { getTransaction } from './utilities/getTransaction.js'
export const deleteVersions: DeleteVersions = async function deleteVersion(
this: DrizzleAdapter,
{ collection: collectionSlug, globalSlug, locale, req, where: where },
{ collection: collectionSlug, locale, req, where: where },
) {
const db = await getTransaction(this, req)
const { collectionConfig, tableName } = getCollection({
adapter: this,
collectionSlug,
versions: true,
})
let tableName: string
let fields: FlattenedField[]
if (globalSlug) {
const globalConfig = this.payload.globals.config.find(({ slug }) => slug === globalSlug)
tableName = this.tableNameMap.get(`_${toSnakeCase(globalSlug)}${this.versionsSuffix}`)
fields = buildVersionGlobalFields(this.payload.config, globalConfig, true)
} else if (collectionSlug) {
const collectionConfig: SanitizedCollectionConfig =
this.payload.collections[collectionSlug].config
tableName = this.tableNameMap.get(
`_${toSnakeCase(collectionConfig.slug)}${this.versionsSuffix}`,
)
fields = buildVersionCollectionFields(this.payload.config, collectionConfig, true)
} else {
throw new APIError('Either collection or globalSlug must be passed.')
}
const fields = buildVersionCollectionFields(this.payload.config, collectionConfig, true)
const { docs } = await findMany({
adapter: this,
@@ -46,9 +35,9 @@ export const deleteVersions: DeleteVersions = async function deleteVersion(
where,
})
const ids = []
const ids: (number | string)[] = []
docs.forEach((doc) => {
docs.forEach((doc: any) => {
ids.push(doc.id)
})

View File

@@ -1,15 +1,14 @@
import type { Find, SanitizedCollectionConfig } from 'payload'
import toSnakeCase from 'to-snake-case'
import type { Find } from 'payload'
import type { DrizzleAdapter } from './types.js'
import { findMany } from './find/findMany.js'
import { getCollection } from './utilities/getEntity.js'
export const find: Find = async function find(
this: DrizzleAdapter,
{
collection,
collection: collectionSlug,
draftsEnabled,
joins,
limit,
@@ -22,11 +21,9 @@ export const find: Find = async function find(
where,
},
) {
const collectionConfig: SanitizedCollectionConfig = this.payload.collections[collection].config
const { collectionConfig, tableName } = getCollection({ adapter: this, collectionSlug })
const sort = sortArg !== undefined && sortArg !== null ? sortArg : collectionConfig.defaultSort
const tableName = this.tableNameMap.get(toSnakeCase(collectionConfig.slug))
return findMany({
adapter: this,
collectionSlug: collectionConfig.slug,

View File

@@ -44,7 +44,7 @@ export const buildFindManyArgs = ({
select,
tableName,
versions,
}: BuildFindQueryArgs): Record<string, unknown> => {
}: BuildFindQueryArgs): any => {
const result: Result = {
extras: {},
with: {},

View File

@@ -252,20 +252,6 @@ export const traverseFields = ({
}
}
if (adapter.blocksAsJSON) {
if (select || selectAllOnCurrentLevel) {
const fieldPath = `${path}${field.name}`
if ((isFieldLocalized || parentIsLocalized) && _locales) {
_locales.columns[fieldPath] = true
} else if (adapter.tables[currentTableName]?.[fieldPath]) {
currentArgs.columns[fieldPath] = true
}
}
break
}
;(field.blockReferences ?? field.blocks).forEach((_block) => {
const block = typeof _block === 'string' ? adapter.payload.blocks[_block] : _block
const blockKey = `_blocks_${block.slug}${!block[InternalBlockTableNameIndex] ? '' : `_${block[InternalBlockTableNameIndex]}`}`

View File

@@ -1,18 +1,15 @@
import type { FindGlobal } from 'payload'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from './types.js'
import { findMany } from './find/findMany.js'
import { getGlobal } from './utilities/getEntity.js'
export const findGlobal: FindGlobal = async function findGlobal(
this: DrizzleAdapter,
{ slug, locale, req, select, where },
{ slug: globalSlug, locale, req, select, where },
) {
const globalConfig = this.payload.globals.config.find((config) => config.slug === slug)
const tableName = this.tableNameMap.get(toSnakeCase(globalConfig.slug))
const { globalConfig, tableName } = getGlobal({ adapter: this, globalSlug })
const {
docs: [doc],
@@ -29,7 +26,7 @@ export const findGlobal: FindGlobal = async function findGlobal(
})
if (doc) {
doc.globalType = slug
doc.globalType = globalSlug
return doc
}

View File

@@ -1,25 +1,19 @@
import type { FindGlobalVersions, SanitizedGlobalConfig } from 'payload'
import type { FindGlobalVersions } from 'payload'
import { buildVersionGlobalFields } from 'payload'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from './types.js'
import { findMany } from './find/findMany.js'
import { getGlobal } from './utilities/getEntity.js'
export const findGlobalVersions: FindGlobalVersions = async function findGlobalVersions(
this: DrizzleAdapter,
{ global, limit, locale, page, pagination, req, select, skip, sort: sortArg, where },
{ global: globalSlug, limit, locale, page, pagination, req, select, skip, sort: sortArg, where },
) {
const globalConfig: SanitizedGlobalConfig = this.payload.globals.config.find(
({ slug }) => slug === global,
)
const { globalConfig, tableName } = getGlobal({ adapter: this, globalSlug, versions: true })
const sort = sortArg !== undefined && sortArg !== null ? sortArg : '-createdAt'
const tableName = this.tableNameMap.get(
`_${toSnakeCase(globalConfig.slug)}${this.versionsSuffix}`,
)
const fields = buildVersionGlobalFields(this.payload.config, globalConfig, true)
return findMany({

View File

@@ -1,22 +1,19 @@
import type { FindOneArgs, SanitizedCollectionConfig, TypeWithID } from 'payload'
import toSnakeCase from 'to-snake-case'
import type { FindOneArgs, TypeWithID } from 'payload'
import type { DrizzleAdapter } from './types.js'
import { findMany } from './find/findMany.js'
import { getCollection } from './utilities/getEntity.js'
export async function findOne<T extends TypeWithID>(
this: DrizzleAdapter,
{ collection, draftsEnabled, joins, locale, req, select, where }: FindOneArgs,
{ collection: collectionSlug, draftsEnabled, joins, locale, req, select, where }: FindOneArgs,
): Promise<T> {
const collectionConfig: SanitizedCollectionConfig = this.payload.collections[collection].config
const tableName = this.tableNameMap.get(toSnakeCase(collectionConfig.slug))
const { collectionConfig, tableName } = getCollection({ adapter: this, collectionSlug })
const { docs } = await findMany({
adapter: this,
collectionSlug: collection,
collectionSlug,
draftsEnabled,
fields: collectionConfig.flattenedFields,
joins,

View File

@@ -1,23 +1,34 @@
import type { FindVersions, SanitizedCollectionConfig } from 'payload'
import type { FindVersions } from 'payload'
import { buildVersionCollectionFields } from 'payload'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from './types.js'
import { findMany } from './find/findMany.js'
import { getCollection } from './utilities/getEntity.js'
export const findVersions: FindVersions = async function findVersions(
this: DrizzleAdapter,
{ collection, limit, locale, page, pagination, req, select, skip, sort: sortArg, where },
{
collection: collectionSlug,
limit,
locale,
page,
pagination,
req,
select,
skip,
sort: sortArg,
where,
},
) {
const collectionConfig: SanitizedCollectionConfig = this.payload.collections[collection].config
const { collectionConfig, tableName } = getCollection({
adapter: this,
collectionSlug,
versions: true,
})
const sort = sortArg !== undefined && sortArg !== null ? sortArg : collectionConfig.defaultSort
const tableName = this.tableNameMap.get(
`_${toSnakeCase(collectionConfig.slug)}${this.versionsSuffix}`,
)
const fields = buildVersionCollectionFields(this.payload.config, collectionConfig, true)
return findMany({

View File

@@ -1,4 +1,4 @@
import type { Payload } from 'payload'
import type { JsonObject, Payload, TypeWithID } from 'payload'
import {
commitTransaction,
@@ -32,7 +32,7 @@ export const migrate: DrizzleAdapter['migrate'] = async function migrate(
}
let latestBatch = 0
let migrationsInDB = []
let migrationsInDB: (JsonObject & TypeWithID)[] = []
const hasMigrationTable = await migrationTableExists(this)

View File

@@ -52,7 +52,7 @@ export async function migrateDown(this: DrizzleAdapter): Promise<void> {
const tableExists = await migrationTableExists(this, db)
if (tableExists) {
if (tableExists && migration.id) {
await payload.delete({
id: migration.id,
collection: 'payload-migrations',

View File

@@ -48,7 +48,7 @@ export async function migrateReset(this: DrizzleAdapter): Promise<void> {
})
const tableExists = await migrationTableExists(this, db)
if (tableExists) {
if (tableExists && migration.id) {
await payload.delete({
id: migration.id,
collection: 'payload-migrations',
@@ -58,7 +58,10 @@ export async function migrateReset(this: DrizzleAdapter): Promise<void> {
await commitTransaction(req)
} catch (err: unknown) {
let msg = `Error running migration ${migrationFile.name}.`
let msg = `Error running migration`
if (migrationFile) {
msg += ` ${migrationFile.name}.`
}
if (err instanceof Error) {
msg += ` ${err.message}`

View File

@@ -1,3 +1,5 @@
import type { MigrationData } from 'payload'
import { Table } from 'console-table-printer'
import { getMigrations, readMigrationFiles } from 'payload'
@@ -13,7 +15,7 @@ export async function migrateStatus(this: DrizzleAdapter): Promise<void> {
msg: `Found ${migrationFiles.length} migration files.`,
})
let existingMigrations = []
let existingMigrations: MigrationData[] = []
const hasMigrationTable = await migrationTableExists(this)
if (hasMigrationTable) {

View File

@@ -159,7 +159,6 @@ export type BasePostgresAdapter = {
up: (args: MigrateUpArgs) => Promise<void>
}[]
push: boolean
readReplicaOptions?: string[]
rejectInitializing: () => void
relations: Record<string, GenericRelation>
relationshipsSuffix?: string

View File

@@ -180,9 +180,6 @@ export const getTableColumnFromPath = ({
})
}
case 'blocks': {
if (adapter.blocksAsJSON) {
break
}
let blockTableColumn: TableColumn
let newTableName: string
@@ -390,18 +387,6 @@ export const getTableColumnFromPath = ({
table: aliasRelationshipTable,
})
if (newCollectionPath === 'id') {
return {
columnName: 'parent',
constraints,
field: {
name: 'id',
type: adapter.idType === 'uuid' ? 'text' : 'number',
} as NumberField | TextField,
table: aliasRelationshipTable,
}
}
const relationshipConfig = adapter.payload.collections[field.collection].config
const relationshipTableName = adapter.tableNameMap.get(
toSnakeCase(relationshipConfig.slug),
@@ -452,18 +437,6 @@ export const getTableColumnFromPath = ({
table: newAliasTable,
})
if (newCollectionPath === 'id') {
return {
columnName: 'id',
constraints,
field: {
name: 'id',
type: adapter.idType === 'uuid' ? 'text' : 'number',
} as NumberField | TextField,
table: newAliasTable,
}
}
return getTableColumnFromPath({
adapter,
aliasTable: newAliasTable,

View File

@@ -117,8 +117,7 @@ export function parseParams({
})
if (
(['json', 'richText'].includes(field.type) ||
(field.type === 'blocks' && adapter.blocksAsJSON)) &&
['json', 'richText'].includes(field.type) &&
Array.isArray(pathSegments) &&
pathSegments.length > 1
) {
@@ -368,25 +367,7 @@ export function parseParams({
break
}
const orConditions: SQL<unknown>[] = []
let resolvedQueryValue = queryValue
if (
operator === 'in' &&
Array.isArray(queryValue) &&
queryValue.some((v) => v === null)
) {
orConditions.push(isNull(resolvedColumn))
resolvedQueryValue = queryValue.filter((v) => v !== null)
}
let constraint = adapter.operators[queryOperator](
resolvedColumn,
resolvedQueryValue,
)
if (orConditions.length) {
orConditions.push(constraint)
constraint = or(...orConditions)
}
constraints.push(constraint)
constraints.push(adapter.operators[queryOperator](resolvedColumn, queryValue))
}
}
}

View File

@@ -1,27 +1,39 @@
import type { QueryDrafts, SanitizedCollectionConfig } from 'payload'
import type { QueryDrafts } from 'payload'
import { buildVersionCollectionFields, combineQueries } from 'payload'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from './types.js'
import { findMany } from './find/findMany.js'
import { getCollection } from './utilities/getEntity.js'
export const queryDrafts: QueryDrafts = async function queryDrafts(
this: DrizzleAdapter,
{ collection, joins, limit, locale, page = 1, pagination, req, select, sort, where },
{
collection: collectionSlug,
joins,
limit,
locale,
page = 1,
pagination,
req,
select,
sort,
where,
},
) {
const collectionConfig: SanitizedCollectionConfig = this.payload.collections[collection].config
const tableName = this.tableNameMap.get(
`_${toSnakeCase(collectionConfig.slug)}${this.versionsSuffix}`,
)
const { collectionConfig, tableName } = getCollection({
adapter: this,
collectionSlug,
versions: true,
})
const fields = buildVersionCollectionFields(this.payload.config, collectionConfig, true)
const combinedWhere = combineQueries({ latest: { equals: true } }, where)
const combinedWhere = combineQueries({ latest: { equals: true } }, where ?? {})
const result = await findMany({
adapter: this,
collectionSlug: collection,
collectionSlug,
fields,
joins,
limit,
@@ -38,7 +50,7 @@ export const queryDrafts: QueryDrafts = async function queryDrafts(
return {
...result,
docs: result.docs.map((doc) => {
docs: result.docs.map((doc: any) => {
doc = {
id: doc.parent,
...doc.version,

View File

@@ -141,7 +141,7 @@ export const traverseFields = ({
adapter.payload.config.localization &&
(isFieldLocalized || forceLocalized) &&
field.type !== 'array' &&
(field.type !== 'blocks' || adapter.blocksAsJSON) &&
field.type !== 'blocks' &&
(('hasMany' in field && field.hasMany !== true) || !('hasMany' in field))
) {
hasLocalizedField = true
@@ -370,17 +370,6 @@ export const traverseFields = ({
break
}
case 'blocks': {
if (adapter.blocksAsJSON) {
targetTable[fieldName] = withDefault(
{
name: columnName,
type: 'jsonb',
},
field,
)
break
}
const disableNotNullFromHere = Boolean(field.admin?.condition) || disableNotNull
;(field.blockReferences ?? field.blocks).forEach((_block) => {
@@ -398,7 +387,6 @@ export const traverseFields = ({
if (typeof blocksTableNameMap[blockTableName] === 'undefined') {
blocksTableNameMap[blockTableName] = 1
} else if (
!adapter.rawTables[blockTableName] ||
!validateExistingBlockIsIdentical({
block,
localized: field.localized,

View File

@@ -20,21 +20,13 @@ export const transformHasManyNumber = ({
if (withinArrayOrBlockLocale) {
result = numberRows.reduce((acc, { locale, number }) => {
if (locale === withinArrayOrBlockLocale) {
if (typeof number === 'string') {
number = Number(number)
}
acc.push(number)
}
return acc
}, [])
} else {
result = numberRows.map(({ number }) => {
if (typeof number === 'string') {
number = Number(number)
}
return number
})
result = numberRows.map(({ number }) => number)
}
if (locale) {

View File

@@ -98,8 +98,6 @@ export const traverseFields = <T extends Record<string, unknown>>({
withinArrayOrBlockLocale,
}: TraverseFieldsArgs): T => {
const sanitizedPath = path ? `${path}.` : path
const localeCodes =
adapter.payload.config.localization && adapter.payload.config.localization.localeCodes
const formatted = fields.reduce((result, field) => {
if (fieldIsVirtual(field)) {
@@ -221,7 +219,7 @@ export const traverseFields = <T extends Record<string, unknown>>({
return result
}
if (field.type === 'blocks' && !adapter.blocksAsJSON) {
if (field.type === 'blocks') {
const blockFieldPath = `${sanitizedPath}${field.name}`
const blocksByPath = blocks[blockFieldPath]
@@ -508,10 +506,6 @@ export const traverseFields = <T extends Record<string, unknown>>({
if (field.type === 'text' && field?.hasMany) {
const textPathMatch = texts[`${sanitizedPath}${field.name}`]
if (!textPathMatch) {
result[field.name] =
isLocalized && localeCodes
? Object.fromEntries(localeCodes.map((locale) => [locale, []]))
: []
return result
}
@@ -551,10 +545,6 @@ export const traverseFields = <T extends Record<string, unknown>>({
if (field.type === 'number' && field.hasMany) {
const numberPathMatch = numbers[`${sanitizedPath}${field.name}`]
if (!numberPathMatch) {
result[field.name] =
isLocalized && localeCodes
? Object.fromEntries(localeCodes.map((locale) => [locale, []]))
: []
return result
}
@@ -616,8 +606,10 @@ export const traverseFields = <T extends Record<string, unknown>>({
}
if (isLocalized && Array.isArray(table._locales)) {
if (!table._locales.length && localeCodes) {
localeCodes.forEach((_locale) => (table._locales as unknown[]).push({ _locale }))
if (!table._locales.length && adapter.payload.config.localization) {
adapter.payload.config.localization.localeCodes.forEach((_locale) =>
(table._locales as unknown[]).push({ _locale }),
)
}
table._locales.forEach((localeRow) => {
@@ -733,6 +725,8 @@ export const traverseFields = <T extends Record<string, unknown>>({
}
return result
return result
}, dataRef)
if (Array.isArray(table._locales)) {

View File

@@ -3,13 +3,7 @@ import type { FlattenedArrayField } from 'payload'
import { fieldShouldBeLocalized } from 'payload/shared'
import type { DrizzleAdapter } from '../../types.js'
import type {
ArrayRowToInsert,
BlockRowToInsert,
NumberToDelete,
RelationshipToDelete,
TextToDelete,
} from './types.js'
import type { ArrayRowToInsert, BlockRowToInsert, RelationshipToDelete } from './types.js'
import { isArrayOfRows } from '../../utilities/isArrayOfRows.js'
import { traverseFields } from './traverseFields.js'
@@ -26,7 +20,6 @@ type Args = {
field: FlattenedArrayField
locale?: string
numbers: Record<string, unknown>[]
numbersToDelete: NumberToDelete[]
parentIsLocalized: boolean
path: string
relationships: Record<string, unknown>[]
@@ -35,7 +28,6 @@ type Args = {
[tableName: string]: Record<string, unknown>[]
}
texts: Record<string, unknown>[]
textsToDelete: TextToDelete[]
/**
* Set to a locale code if this set of fields is traversed within a
* localized array or block field
@@ -53,14 +45,12 @@ export const transformArray = ({
field,
locale,
numbers,
numbersToDelete,
parentIsLocalized,
path,
relationships,
relationshipsToDelete,
selects,
texts,
textsToDelete,
withinArrayOrBlockLocale,
}: Args) => {
const newRows: ArrayRowToInsert[] = []
@@ -114,7 +104,6 @@ export const transformArray = ({
insideArrayOrBlock: true,
locales: newRow.locales,
numbers,
numbersToDelete,
parentIsLocalized: parentIsLocalized || field.localized,
parentTableName: arrayTableName,
path: `${path || ''}${field.name}.${i}.`,
@@ -123,7 +112,6 @@ export const transformArray = ({
row: newRow.row,
selects,
texts,
textsToDelete,
withinArrayOrBlockLocale,
})

View File

@@ -4,12 +4,7 @@ import { fieldShouldBeLocalized } from 'payload/shared'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from '../../types.js'
import type {
BlockRowToInsert,
NumberToDelete,
RelationshipToDelete,
TextToDelete,
} from './types.js'
import type { BlockRowToInsert, RelationshipToDelete } from './types.js'
import { resolveBlockTableName } from '../../utilities/validateExistingBlockIsIdentical.js'
import { traverseFields } from './traverseFields.js'
@@ -25,7 +20,6 @@ type Args = {
field: FlattenedBlocksField
locale?: string
numbers: Record<string, unknown>[]
numbersToDelete: NumberToDelete[]
parentIsLocalized: boolean
path: string
relationships: Record<string, unknown>[]
@@ -34,7 +28,6 @@ type Args = {
[tableName: string]: Record<string, unknown>[]
}
texts: Record<string, unknown>[]
textsToDelete: TextToDelete[]
/**
* Set to a locale code if this set of fields is traversed within a
* localized array or block field
@@ -50,14 +43,12 @@ export const transformBlocks = ({
field,
locale,
numbers,
numbersToDelete,
parentIsLocalized,
path,
relationships,
relationshipsToDelete,
selects,
texts,
textsToDelete,
withinArrayOrBlockLocale,
}: Args) => {
data.forEach((blockRow, i) => {
@@ -126,7 +117,6 @@ export const transformBlocks = ({
insideArrayOrBlock: true,
locales: newRow.locales,
numbers,
numbersToDelete,
parentIsLocalized: parentIsLocalized || field.localized,
parentTableName: blockTableName,
path: `${path || ''}${field.name}.${i}.`,
@@ -135,7 +125,6 @@ export const transformBlocks = ({
row: newRow.row,
selects,
texts,
textsToDelete,
withinArrayOrBlockLocale,
})

View File

@@ -29,13 +29,11 @@ export const transformForWrite = ({
blocksToDelete: new Set(),
locales: {},
numbers: [],
numbersToDelete: [],
relationships: [],
relationshipsToDelete: [],
row: {},
selects: {},
texts: [],
textsToDelete: [],
}
// This function is responsible for building up the
@@ -52,7 +50,6 @@ export const transformForWrite = ({
fields,
locales: rowToInsert.locales,
numbers: rowToInsert.numbers,
numbersToDelete: rowToInsert.numbersToDelete,
parentIsLocalized,
parentTableName: tableName,
path,
@@ -61,7 +58,6 @@ export const transformForWrite = ({
row: rowToInsert.row,
selects: rowToInsert.selects,
texts: rowToInsert.texts,
textsToDelete: rowToInsert.textsToDelete,
})
return rowToInsert

View File

@@ -5,13 +5,7 @@ import { fieldIsVirtual, fieldShouldBeLocalized } from 'payload/shared'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from '../../types.js'
import type {
ArrayRowToInsert,
BlockRowToInsert,
NumberToDelete,
RelationshipToDelete,
TextToDelete,
} from './types.js'
import type { ArrayRowToInsert, BlockRowToInsert, RelationshipToDelete } from './types.js'
import { isArrayOfRows } from '../../utilities/isArrayOfRows.js'
import { resolveBlockTableName } from '../../utilities/validateExistingBlockIsIdentical.js'
@@ -57,7 +51,6 @@ type Args = {
[locale: string]: Record<string, unknown>
}
numbers: Record<string, unknown>[]
numbersToDelete: NumberToDelete[]
parentIsLocalized: boolean
/**
* This is the name of the parent table
@@ -71,7 +64,6 @@ type Args = {
[tableName: string]: Record<string, unknown>[]
}
texts: Record<string, unknown>[]
textsToDelete: TextToDelete[]
/**
* Set to a locale code if this set of fields is traversed within a
* localized array or block field
@@ -94,7 +86,6 @@ export const traverseFields = ({
insideArrayOrBlock = false,
locales,
numbers,
numbersToDelete,
parentIsLocalized,
parentTableName,
path,
@@ -103,7 +94,6 @@ export const traverseFields = ({
row,
selects,
texts,
textsToDelete,
withinArrayOrBlockLocale,
}: Args) => {
if (row._uuid) {
@@ -146,14 +136,12 @@ export const traverseFields = ({
field,
locale: localeKey,
numbers,
numbersToDelete,
parentIsLocalized: parentIsLocalized || field.localized,
path,
relationships,
relationshipsToDelete,
selects,
texts,
textsToDelete,
withinArrayOrBlockLocale: localeKey,
})
@@ -171,14 +159,12 @@ export const traverseFields = ({
data: data[field.name],
field,
numbers,
numbersToDelete,
parentIsLocalized: parentIsLocalized || field.localized,
path,
relationships,
relationshipsToDelete,
selects,
texts,
textsToDelete,
withinArrayOrBlockLocale,
})
@@ -188,7 +174,7 @@ export const traverseFields = ({
return
}
if (field.type === 'blocks' && !adapter.blocksAsJSON) {
if (field.type === 'blocks') {
;(field.blockReferences ?? field.blocks).forEach((block) => {
const matchedBlock =
typeof block === 'string'
@@ -216,14 +202,12 @@ export const traverseFields = ({
field,
locale: localeKey,
numbers,
numbersToDelete,
parentIsLocalized: parentIsLocalized || field.localized,
path,
relationships,
relationshipsToDelete,
selects,
texts,
textsToDelete,
withinArrayOrBlockLocale: localeKey,
})
}
@@ -238,14 +222,12 @@ export const traverseFields = ({
data: fieldData,
field,
numbers,
numbersToDelete,
parentIsLocalized: parentIsLocalized || field.localized,
path,
relationships,
relationshipsToDelete,
selects,
texts,
textsToDelete,
withinArrayOrBlockLocale,
})
}
@@ -275,7 +257,6 @@ export const traverseFields = ({
insideArrayOrBlock,
locales,
numbers,
numbersToDelete,
parentIsLocalized: parentIsLocalized || field.localized,
parentTableName,
path: `${path || ''}${field.name}.`,
@@ -284,7 +265,6 @@ export const traverseFields = ({
row,
selects,
texts,
textsToDelete,
withinArrayOrBlockLocale: localeKey,
})
})
@@ -307,7 +287,6 @@ export const traverseFields = ({
insideArrayOrBlock,
locales,
numbers,
numbersToDelete,
parentIsLocalized: parentIsLocalized || field.localized,
parentTableName,
path: `${path || ''}${field.name}.`,
@@ -316,7 +295,6 @@ export const traverseFields = ({
row,
selects,
texts,
textsToDelete,
withinArrayOrBlockLocale,
})
}
@@ -402,11 +380,6 @@ export const traverseFields = ({
if (typeof fieldData === 'object') {
Object.entries(fieldData).forEach(([localeKey, localeData]) => {
if (Array.isArray(localeData)) {
if (!localeData.length) {
textsToDelete.push({ locale: localeKey, path: textPath })
return
}
transformTexts({
baseRow: {
locale: localeKey,
@@ -419,11 +392,6 @@ export const traverseFields = ({
})
}
} else if (Array.isArray(fieldData)) {
if (!fieldData.length) {
textsToDelete.push({ locale: withinArrayOrBlockLocale, path: textPath })
return
}
transformTexts({
baseRow: {
locale: withinArrayOrBlockLocale,
@@ -444,11 +412,6 @@ export const traverseFields = ({
if (typeof fieldData === 'object') {
Object.entries(fieldData).forEach(([localeKey, localeData]) => {
if (Array.isArray(localeData)) {
if (!localeData.length) {
numbersToDelete.push({ locale: localeKey, path: numberPath })
return
}
transformNumbers({
baseRow: {
locale: localeKey,
@@ -461,11 +424,6 @@ export const traverseFields = ({
})
}
} else if (Array.isArray(fieldData)) {
if (!fieldData.length) {
numbersToDelete.push({ locale: withinArrayOrBlockLocale, path: numberPath })
return
}
transformNumbers({
baseRow: {
locale: withinArrayOrBlockLocale,

View File

@@ -23,16 +23,6 @@ export type RelationshipToDelete = {
path: string
}
export type TextToDelete = {
locale?: string
path: string
}
export type NumberToDelete = {
locale?: string
path: string
}
export type RowToInsert = {
arrays: {
[tableName: string]: ArrayRowToInsert[]
@@ -45,7 +35,6 @@ export type RowToInsert = {
[locale: string]: Record<string, unknown>
}
numbers: Record<string, unknown>[]
numbersToDelete: NumberToDelete[]
relationships: Record<string, unknown>[]
relationshipsToDelete: RelationshipToDelete[]
row: Record<string, unknown>
@@ -53,5 +42,4 @@ export type RowToInsert = {
[tableName: string]: Record<string, unknown>[]
}
texts: Record<string, unknown>[]
textsToDelete: TextToDelete[]
}

View File

@@ -315,7 +315,6 @@ export type BuildDrizzleTable<T extends DrizzleAdapter = DrizzleAdapter> = (args
}) => void
export interface DrizzleAdapter extends BaseDatabaseAdapter {
blocksAsJSON?: boolean
convertPathToJSONTraversal?: (incomingSegments: string[]) => string
countDistinct: CountDistinct
createJSONQuery: (args: CreateJSONQueryArgs) => string
@@ -324,8 +323,8 @@ export interface DrizzleAdapter extends BaseDatabaseAdapter {
drizzle: LibSQLDatabase | PostgresDB
dropDatabase: DropDatabase
enums?: never | Record<string, unknown>
execute: Execute<unknown>
features: {
json?: boolean
}

View File

@@ -1,21 +1,19 @@
import type { UpdateGlobalArgs } from 'payload'
import toSnakeCase from 'to-snake-case'
import type { DrizzleAdapter } from './types.js'
import { upsertRow } from './upsertRow/index.js'
import { getGlobal, getTableQuery } from './utilities/getEntity.js'
import { getTransaction } from './utilities/getTransaction.js'
export async function updateGlobal<T extends Record<string, unknown>>(
this: DrizzleAdapter,
{ slug, data, req, returning, select }: UpdateGlobalArgs,
{ slug: globalSlug, data, req, returning, select }: UpdateGlobalArgs,
): Promise<T> {
const db = await getTransaction(this, req)
const globalConfig = this.payload.globals.config.find((config) => config.slug === slug)
const tableName = this.tableNameMap.get(toSnakeCase(globalConfig.slug))
const existingGlobal = await db.query[tableName].findFirst({})
const { globalConfig, tableName } = getGlobal({ adapter: this, globalSlug })
const queryTable = getTableQuery({ adapter: this, tableName })
const existingGlobal = await queryTable.findFirst({})
const result = await upsertRow<{ globalType: string } & T>({
...(existingGlobal ? { id: existingGlobal.id, operation: 'update' } : { operation: 'create' }),
@@ -30,10 +28,11 @@ export async function updateGlobal<T extends Record<string, unknown>>(
})
if (returning === false) {
// @ts-expect-error dont want to change public api response type
return null
}
result.globalType = slug
result.globalType = globalSlug
return result
}

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