Compare commits

..

4 Commits

Author SHA1 Message Date
Germán Jabloñski
ac46c289a1 revert incorrect eslint autfixes 2025-02-28 15:30:46 -03:00
Germán Jabloñski
4c54ccc25a Merge remote-tracking branch 'origin/main' into revert-11133-typescript-strict-plugin 2025-02-28 15:23:39 -03:00
Germán Jabloñski
be52a2a223 Merge remote-tracking branch 'origin/main' into revert-11133-typescript-strict-plugin 2025-02-17 09:12:40 -03:00
Germán Jabloñski
0824b4f34c Revert "chore: add typescript-strict-plugin to the payload package for increm…"
This reverts commit 6eee787493.
2025-02-13 09:48:29 -03:00
707 changed files with 21853 additions and 21162 deletions

View File

@@ -57,7 +57,7 @@ body:
- type: textarea
attributes:
label: Environment Info
description: Paste output from `pnpm payload info` _or_ Payload, Node.js, and Next.js versions. Please avoid using "latest"—specific version numbers help us accurately diagnose and resolve issues.
description: Paste output from `pnpm payload info` _or_ Payload, Node.js, and Next.js versions.
render: text
placeholder: |
Payload:

View File

@@ -20,7 +20,7 @@ body:
- type: textarea
attributes:
label: Environment Info
description: Paste output from `pnpm payload info` _or_ Payload, Node.js, and Next.js versions. Please avoid using "latest"—specific version numbers help us accurately diagnose and resolve issues.
description: Paste output from `pnpm payload info` _or_ Payload, Node.js, and Next.js versions.
render: text
placeholder: |
Payload:

View File

@@ -1,6 +1,6 @@
{
"compilerOptions": {
"target": "es5",
"target": "ES2022",
"lib": ["es2020.string"],
"noEmit": true,
"strict": true,

View File

@@ -1,6 +1,6 @@
{
"compilerOptions": {
"target": "es5",
"target": "ES2022",
"lib": ["es2020.string"],
"noEmit": true,
"strict": true,

View File

@@ -2,8 +2,8 @@ name: lock-issues
on:
schedule:
# Run nightly at 12am EST, staggered with stale workflow
- cron: '0 5 * * *'
# Run nightly at 12am EST
- cron: '0 4 * * *'
workflow_dispatch:
permissions:

View File

@@ -275,7 +275,6 @@ jobs:
- admin__e2e__general
- admin__e2e__list-view
- admin__e2e__document-view
- admin-bar
- admin-root
- auth
- auth-basic
@@ -314,7 +313,6 @@ jobs:
- i18n
- plugin-cloud-storage
- plugin-form-builder
- plugin-import-export
- plugin-nested-docs
- plugin-seo
- versions
@@ -419,7 +417,6 @@ jobs:
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
POSTGRES_DB: payloadtests
MONGODB_VERSION: 6.0
steps:
- uses: actions/checkout@v4
@@ -459,14 +456,8 @@ jobs:
echo "POSTGRES_URL=postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@localhost:5432/$POSTGRES_DB" >> $GITHUB_ENV
if: matrix.database == 'postgres'
# Avoid dockerhub rate-limiting
- name: Cache Docker images
uses: ScribeMD/docker-cache@0.5.0
with:
key: docker-${{ runner.os }}-mongo-${{ env.MONGODB_VERSION }}
- name: Start MongoDB
uses: supercharge/mongodb-github-action@1.12.0
uses: supercharge/mongodb-github-action@1.11.0
with:
mongodb-version: 6.0
if: matrix.database == 'mongodb'

View File

@@ -1,9 +1,6 @@
name: publish-prerelease
name: release-canary
on:
schedule:
# Run nightly at 10pm EST
- cron: '0 3 * * *'
workflow_dispatch:
env:
@@ -14,7 +11,7 @@ env:
jobs:
release:
name: publish-prerelease-${{ github.ref_name }}-${{ github.sha }}
name: release-canary-${{ github.ref_name }}-${{ github.sha }}
permissions:
id-token: write
runs-on: ubuntu-24.04
@@ -30,19 +27,8 @@ jobs:
run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
- name: Determine release type
id: determine_release_type
# Use 'canary' for main branch, 'internal' for others
run: |
if [[ ${{ github.ref_name }} == "main" ]]; then
echo "release_type=canary" >> $GITHUB_OUTPUT
else
echo "release_type=internal" >> $GITHUB_OUTPUT
fi
- name: Release
run: pnpm publish-prerelease --tag ${{ steps.determine_release_type.outputs.release_type }}
- name: Canary release script
run: pnpm release:canary
env:
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
NPM_CONFIG_PROVENANCE: true

View File

@@ -2,8 +2,8 @@ name: stale
on:
schedule:
# Run nightly at 1am EST, staggered with lock-issues workflow
- cron: '0 6 * * *'
# Run nightly at 1am EST
- cron: '0 5 * * *'
workflow_dispatch:
inputs:

5
.gitignore vendored
View File

@@ -306,8 +306,6 @@ $RECYCLE.BIN/
/build
.swc
app/(payload)/admin/importMap.js
test/admin-bar/app/(payload)/admin/importMap.js
/test/admin-bar/app/(payload)/admin/importMap.js
test/live-preview/app/(payload)/admin/importMap.js
/test/live-preview/app/(payload)/admin/importMap.js
test/admin-root/app/(payload)/admin/importMap.js
@@ -320,6 +318,3 @@ test/databaseAdapter.js
/media-with-relation-preview
/media-without-relation-preview
/media-without-cache-tags
test/.localstack
test/google-cloud-storage
test/azurestoragedata/

3
.idea/payload.iml generated
View File

@@ -80,9 +80,8 @@
<excludeFolder url="file://$MODULE_DIR$/packages/drizzle/dist" />
<excludeFolder url="file://$MODULE_DIR$/packages/db-sqlite/.turbo" />
<excludeFolder url="file://$MODULE_DIR$/packages/db-sqlite/dist" />
<excludeFolder url="file://$MODULE_DIR$/packages/plugin-import-export/dist" />
</content>
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
</module>
</module>

View File

@@ -135,7 +135,7 @@ const ExampleComponent: React.FC = () => {
#### Updating other fields' values
If you are building a Custom Component, then you should use `setValue` which is returned from the `useField` hook to programmatically set your field's value. But if you're looking to update _another_ field's value, you can use `dispatchFields` returned from `useAllFormFields`.
If you are building a Custom Component, then you should use `setValue` which is returned from the `useField` hook to programmatically set your field's value. But if you're looking to update _another_ field's value, you can use `dispatchFields` returned from `useFormFields`.
You can send the following actions to the `dispatchFields` function.

View File

@@ -62,12 +62,9 @@ export const Users: CollectionConfig = {
})
return {
// Send the user with the collection slug back to authenticate,
// Send the user back to authenticate,
// or send null if no user should be authenticated
user: usersQuery.docs[0] ? {
collection: 'users'
...usersQuery.docs[0],
} : null,
user: usersQuery.docs[0] || null,
// Optionally, you can return headers
// that you'd like Payload to set here when

View File

@@ -57,9 +57,9 @@ export const Posts: CollectionConfig = {
The following options are available:
| Option | Description |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `admin` | The configuration options for the Admin Panel. [More details](#admin-options). |
| Option | Description |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `admin` | The configuration options for the Admin Panel. [More details](#admin-options). |
| `access` | Provide Access Control functions to define exactly who should be able to do what with Documents in this Collection. [More details](../access-control/collections). |
| `auth` | Specify options if you would like this Collection to feature authentication. [More details](../authentication/overview). |
| `custom` | Extension point for adding custom data (e.g. for plugins) |
@@ -67,18 +67,17 @@ The following options are available:
| `defaultSort` | Pass a top-level field to sort by default in the Collection List View. Prefix the name of the field with a minus symbol ("-") to sort in descending order. Multiple fields can be specified by using a string array. |
| `dbName` | Custom table or Collection name depending on the Database Adapter. Auto-generated from slug if not defined. |
| `endpoints` | Add custom routes to the REST API. Set to `false` to disable routes. [More details](../rest-api/overview#custom-endpoints). |
| `fields` * | Array of field types that will determine the structure and functionality of the data stored within this Collection. [More details](../fields/overview). |
| `fields` * | Array of field types that will determine the structure and functionality of the data stored within this Collection. [More details](../fields/overview). |
| `graphQL` | Manage GraphQL-related properties for this collection. [More](#graphql) |
| `hooks` | Entry point for Hooks. [More details](../hooks/overview#collection-hooks). |
| `labels` | Singular and plural labels for use in identifying this Collection throughout Payload. Auto-generated from slug if not defined. |
| `lockDocuments` | Enables or disables document locking. By default, document locking is enabled. Set to an object to configure, or set to `false` to disable locking. [More details](../admin/locked-documents). |
| `slug` * | Unique, URL-friendly string that will act as an identifier for this Collection. |
| `slug` * | Unique, URL-friendly string that will act as an identifier for this Collection. |
| `timestamps` | Set to false to disable documents' automatically generated `createdAt` and `updatedAt` timestamps. |
| `typescript` | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined. |
| `upload` | Specify options if you would like this Collection to support file uploads. For more, consult the [Uploads](../upload/overview) documentation. |
| `versions` | Set to true to enable default options, or configure with object properties. [More details](../versions/overview#collection-config). |
| `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. |
_* An asterisk denotes that a property is required._

View File

@@ -119,32 +119,10 @@ For details on how to build Custom Components, see [Building Custom Components](
### Import Map
In order for Payload to make use of [Component Paths](#component-paths), an "Import Map" is automatically generated at either `src/app/(payload)/admin/importMap.js` or `app/(payload)/admin/importMap.js`. This file contains every Custom Component in your config, keyed to their respective paths. When Payload needs to lookup a component, it uses this file to find the correct import.
In order for Payload to make use of [Component Paths](#component-paths), an "Import Map" is automatically generated at `app/(payload)/admin/importMap.js`. This file contains every Custom Component in your config, keyed to their respective paths. When Payload needs to lookup a component, it uses this file to find the correct import.
The Import Map is automatically regenerated at startup and whenever Hot Module Replacement (HMR) runs, or you can run `payload generate:importmap` to manually regenerate it.
#### Overriding Import Map Location
Using the `config.admin.importMap.importMapFile` property, you can override the location of the import map. This is useful if you want to place the import map in a different location, or if you want to use a custom file name.
```ts
import { buildConfig } from 'payload'
import { fileURLToPath } from 'node:url'
import path from 'path'
const filename = fileURLToPath(import.meta.url)
const dirname = path.dirname(filename)
const config = buildConfig({
// ...
admin: {
importMap: {
baseDir: path.resolve(dirname, 'src'),
importMapFile: path.resolve(dirname, 'app', '(payload)', 'custom-import-map.js'), // highlight-line
},
},
})
```
#### Custom Imports
If needed, custom items can be appended onto the Import Map. This is mostly only relevant for plugin authors who need to add a custom import that is not referenced in a known location.
@@ -168,7 +146,7 @@ export default buildConfig({
},
},
}
})
}
```
## Building Custom Components

View File

@@ -34,12 +34,11 @@ export default buildConfig({
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `autoPluralization` | Tell Mongoose to auto-pluralize any collection names if it encounters any singular words used as collection `slug`s. |
| `connectOptions` | Customize MongoDB connection options. Payload will connect to your MongoDB database using default options which you can override and extend to include all the [options](https://mongoosejs.com/docs/connections.html#options) available to mongoose. |
| `collectionsSchemaOptions` | Customize Mongoose schema options for collections. |
| `collectionsSchemaOptions` | Customize Mongoose schema options for collections. |
| `disableIndexHints` | Set to true to disable hinting to MongoDB to use 'id' as index. This is currently done when counting documents for pagination, as it increases the speed of the count function used in that query. Disabling this optimization might fix some problems with AWS DocumentDB. Defaults to false |
| `migrationDir` | Customize the directory that migrations are stored. |
| `transactionOptions` | An object with configuration properties used in [transactions](https://www.mongodb.com/docs/manual/core/transactions/) or `false` which will disable the use of transactions. |
| `collation` | Enable language-specific string comparison with customizable options. Available on MongoDB 3.4+. Defaults locale to "en". Example: `{ strength: 3 }`. For a full list of collation options and their definitions, see the [MongoDB documentation](https://www.mongodb.com/docs/manual/reference/collation/). |
| `allowAdditionalKeys` | By default, Payload strips all additional keys from MongoDB data that don't exist in the Payload schema. If you have some data that you want to include to the result but it doesn't exist in Payload, you can set this to `true`. Be careful as Payload access control _won't_ work for this data. |
## Access to Mongoose models
@@ -51,11 +50,3 @@ You can access Mongoose models as follows:
- Collection models - `payload.db.collections[myCollectionSlug]`
- Globals model - `payload.db.globals`
- Versions model (both collections and globals) - `payload.db.versions[myEntitySlug]`
## Using other MongoDB implementations
Limitations with [DocumentDB](https://aws.amazon.com/documentdb/) and [Azure Cosmos DB](https://azure.microsoft.com/en-us/products/cosmos-db):
* For Azure Cosmos DB you must pass `transactionOptions: false` to the adapter options. Azure Cosmos DB does not support transactions that update two and more documents in different collections, which is a common case when using Payload (via hooks).
* For Azure Cosmos DB the root config property `indexSortableFields` must be set to `true`.
* The [Join Field](../fields/join) is not supported in DocumentDB and Azure Cosmos DB, as we internally use MongoDB aggregations to query data for that field, which are limited there. This can be changed in the future.
* For DocumentDB pass `disableIndexHints: true` to disable hinting to the DB to use `id` as index which can cause problems with DocumentDB.

View File

@@ -84,7 +84,6 @@ The Blocks Field inherits all of the default options from the base [Field Admin
| **`group`** | Text or localization object used to group this Block in the Blocks Drawer. |
| **`initCollapsed`** | Set the initial collapsed state |
| **`isSortable`** | Disable order sorting by setting this value to `false` |
| **`disableBlockName`** | Hide the blockName field by setting this value to `true` |
#### Customizing the way your block is rendered in Lexical
@@ -166,7 +165,7 @@ The `blockType` is saved as the slug of the block that has been selected.
**`blockName`**
The Admin Panel provides each block with a `blockName` field which optionally allows editors to label their blocks for better editability and readability. This can be visually hidden via `admin.disableBlockName`.
The Admin Panel provides each block with a `blockName` field which optionally allows editors to label their blocks for better editability and readability.
## Example

View File

@@ -62,10 +62,6 @@ of relationship types in an easy manner.
The Join field is extremely performant and does not add additional query overhead to your API responses until you add depth of 1 or above. It works in all database adapters. In MongoDB, we use **aggregations** to automatically join in related documents, and in relational databases, we use joins.
</Banner>
<Banner type="warning">
The Join Field is not supported in [DocumentDB](https://aws.amazon.com/documentdb/) and [Azure Cosmos DB](https://azure.microsoft.com/en-us/products/cosmos-db), as we internally use MongoDB aggregations to query data for that field, which are limited there. This can be changed in the future.
</Banner>
### Schema advice
When modeling your database, you might come across many places where you'd like to feature bi-directional relationships.

View File

@@ -502,7 +502,7 @@ export const MyCollectionConfig: CollectionConfig = {
All Description Functions receive the following arguments:
| Argument | Description |
| Argument | Description |
| --- | --- |
| **`t`** | The `t` function used to internationalize the Admin Panel. [More details](../configuration/i18n) |
@@ -512,21 +512,11 @@ All Description Functions receive the following arguments:
### Conditional Logic
You can show and hide fields based on what other fields are doing by utilizing conditional logic on a field by field basis. The `condition` property on a field's admin config accepts a function which takes the following arguments:
You can show and hide fields based on what other fields are doing by utilizing conditional logic on a field by field basis. The `condition` property on a field's admin config accepts a function which takes three arguments:
| Argument | Description |
| --- | --- |
| **`data`** | The entire document's data that is currently being edited. |
| **`siblingData`** | Only the fields that are direct siblings to the field with the condition. |
| **`ctx`** | An object containing additional information about the fields location and user. |
The `ctx` object:
| Property | Description |
| --- | --- |
| **`blockData`** | The nearest parent block's data. If the field is not inside a block, this will be `undefined`. |
| **`path`** | The full path to the field in the schema, including array indexes. Useful for dynamic lookups. |
| **`user`** | The currently authenticated user object. |
- `data` - the entire document's data that is currently being edited
- `siblingData` - only the fields that are direct siblings to the field with the condition
- `{ user }` - the final argument is an object containing the currently authenticated user
The `condition` function should return a boolean that will control if the field should be displayed or not.
@@ -545,7 +535,7 @@ The `condition` function should return a boolean that will control if the field
type: 'text',
admin: {
// highlight-start
condition: (data, siblingData, { blockData, path, user }) => {
condition: (data, siblingData, { user }) => {
if (data.enableGreeting) {
return true
} else {

View File

@@ -239,13 +239,16 @@ export const useLivePreview = <T extends any>(props: {
## Example
For a working demonstration of this, check out the official [Live Preview Example](https://github.com/payloadcms/payload/tree/main/examples/live-preview). There you will find an example of a fully integrated Next.js App Router front-end that runs on the same server as Payload.
For a working demonstration of this, check out the official [Live Preview Example](https://github.com/payloadcms/payload/tree/main/examples/live-preview). There you will find examples of various front-end frameworks and how to integrate each one of them, including:
- [Next.js App Router](https://github.com/payloadcms/payload/tree/main/examples/live-preview/next-app)
- [Next.js Pages Router](https://github.com/payloadcms/payload/tree/main/examples/live-preview/next-pages)
## Troubleshooting
#### Relationships and/or uploads are not populating
If you are using relationships or uploads in your front-end application, and your front-end application runs on a different domain than your Payload server, you may need to configure [CORS](../configuration/overview#cors) to allow requests to be made between the two domains. This includes sites that are running on a different port or subdomain. Similarly, if you are protecting resources behind user authentication, you may also need to configure [CSRF](../authentication/cookies#csrf-prevention) to allow cookies to be sent between the two domains. For example:
If you are using relationships or uploads in your front-end application, and your front-end application runs on a different domain than your Payload server, you may need to configure [CORS](../configuration/overview) to allow requests to be made between the two domains. This includes sites that are running on a different port or subdomain. Similarly, if you are protecting resources behind user authentication, you may also need to configure [CSRF](../authentication/overview#csrf-protection) to allow cookies to be sent between the two domains. For example:
```ts
// payload.config.ts

View File

@@ -703,31 +703,6 @@ import { addLocalesToRequestFromData } from 'payload'
}
```
`headersWithCors`
By default, custom endpoints don't handle CORS headers in responses. The `headersWithCors` function checks the Payload config and sets the appropriate CORS headers in the response accordingly.
```ts
import { headersWithCors } from 'payload'
// custom endpoint example
{
path: '/:id/tracking',
method: 'post',
handler: async (req) => {
return Response.json(
{ message: 'success' },
{
headers: headersWithCors({
headers: new Headers(),
req,
})
},
)
}
}
```
## Method Override for GET Requests
Payload supports a method override feature that allows you to send GET requests using the HTTP POST method. This can be particularly useful in scenarios when the query string in a regular GET request is too long.

View File

@@ -2,8 +2,8 @@
title: Lexical Converters
label: Converters
order: 20
desc: Conversion between lexical, markdown, jsx and html
keywords: lexical, rich text, editor, headless cms, convert, html, mdx, markdown, md, conversion, export, jsx
desc: Conversion between lexical, markdown and html
keywords: lexical, rich text, editor, headless cms, convert, html, mdx, markdown, md, conversion, export
---
Lexical saves data in JSON - this is great for storage and flexibility and allows you to easily to convert it to other formats like JSX, HTML or Markdown.
@@ -74,28 +74,20 @@ To convert Lexical Blocks or Inline Blocks to JSX, pass the converter for your b
```tsx
'use client'
import type { MyInlineBlock, MyNumberBlock, MyTextBlock } from '@/payload-types'
import type {
DefaultNodeTypes,
SerializedBlockNode,
SerializedInlineBlockNode,
} from '@payloadcms/richtext-lexical'
import type { MyInlineBlock, MyTextBlock } from '@/payload-types'
import type { DefaultNodeTypes, SerializedBlockNode } from '@payloadcms/richtext-lexical'
import type { SerializedEditorState } from '@payloadcms/richtext-lexical/lexical'
import { type JSXConvertersFunction, RichText } from '@payloadcms/richtext-lexical/react'
import React from 'react'
// Extend the default node types with your custom blocks for full type safety
type NodeTypes =
| DefaultNodeTypes
| SerializedBlockNode<MyNumberBlock | MyTextBlock>
| SerializedInlineBlockNode<MyInlineBlock>
type NodeTypes = DefaultNodeTypes | SerializedBlockNode<MyInlineBlock | MyTextBlock>
const jsxConverters: JSXConvertersFunction<NodeTypes> = ({ defaultConverters }) => ({
...defaultConverters,
blocks: {
// Each key should match your block's slug
myNumberBlock: ({ node }) => <div>{node.fields.number}</div>,
myTextBlock: ({ node }) => <div style={{ backgroundColor: 'red' }}>{node.fields.text}</div>,
},
inlineBlocks: {
@@ -163,156 +155,19 @@ export const MyComponent: React.FC<{
If you don't have a React-based frontend, or if you need to send the content to a third-party service, you can convert lexical to HTML. There are two ways to do this:
1. **Outputting HTML from the Collection:** Create a new field in your collection to convert saved JSON content to HTML. Payload generates and outputs the HTML for use in your frontend.
2. **Generating HTML on any server** Convert JSON to HTML on-demand on the server.
1. **Generating HTML in your frontend** Convert JSON to HTML on-demand wherever you need it (Recommended).
2. **Outputting HTML from the Collection:** Create a new field in your collection to convert saved JSON content to HTML. Payload generates and outputs the HTML for use in your frontend. This is not recommended, as this approach adds additional overhead to the Payload API and may not work with live preview.
### Generating HTML in your frontend
If you wish to convert JSON to HTML ad-hoc, use the `convertLexicalToHTML` function exported from `@payloadcms/richtext-lexical/html`:
```tsx
'use client'
import type { SerializedEditorState } from '@payloadcms/richtext-lexical/lexical'
import { convertLexicalToHTML } from '@payloadcms/richtext-lexical/html'
import React from 'react'
export const MyComponent = ({ data }: { data: SerializedEditorState }) => {
const html = convertLexicalToHTML({ data })
return <div dangerouslySetInnerHTML={{ __html: html }} />
}
```
### Generating HTML in your frontend with dynamic population
The default `convertLexicalToHTML` function does not populate data for nodes like uploads or links - it expects you to pass in the fully populated data. If you want the converter to dynamically populate those nodes as they are encountered, you have to use the async version of the converter, imported from `@payloadcms/richtext-lexical/html-async`, and pass in the `populate` function:
```tsx
'use client'
import type { SerializedEditorState } from '@payloadcms/richtext-lexical/lexical'
import { getRestPopulateFn } from '@payloadcms/richtext-lexical/client'
import { convertLexicalToHTMLAsync } from '@payloadcms/richtext-lexical/html-async'
import React, { useEffect, useState } from 'react'
export const MyComponent = ({ data }: { data: SerializedEditorState }) => {
const [html, setHTML] = useState<null | string>(null)
useEffect(() => {
async function convert() {
const html = await convertLexicalToHTMLAsync({
data,
populate: getRestPopulateFn({
apiURL: `http://localhost:3000/api`,
}),
})
setHTML(html)
}
void convert()
}, [data])
return html && <div dangerouslySetInnerHTML={{ __html: html }} />
}
```
Do note that using the REST populate function will result in each node sending a separate request to the REST API, which may be slow for a large amount of nodes. On the server, you can use the payload populate function, which will be more efficient:
```tsx
import type { SerializedEditorState } from '@payloadcms/richtext-lexical/lexical'
import { getPayloadPopulateFn } from '@payloadcms/richtext-lexical'
import { convertLexicalToHTMLAsync } from '@payloadcms/richtext-lexical/html-async'
import { getPayload } from 'payload'
import React from 'react'
import config from '../../config.js'
export const MyRSCComponent = async ({ data }: { data: SerializedEditorState }) => {
const payload = await getPayload({
config,
})
const html = await convertLexicalToHTMLAsync({
data,
populate: await getPayloadPopulateFn({
currentDepth: 0,
depth: 1,
payload,
}),
})
return html && <div dangerouslySetInnerHTML={{ __html: html }} />
}
```
### Converting Lexical Blocks
```tsx
'use client'
import type { MyInlineBlock, MyTextBlock } from '@/payload-types'
import type {
DefaultNodeTypes,
SerializedBlockNode,
SerializedInlineBlockNode,
} from '@payloadcms/richtext-lexical'
import type { SerializedEditorState } from '@payloadcms/richtext-lexical/lexical'
import {
convertLexicalToHTML,
type HTMLConvertersFunction,
} from '@payloadcms/richtext-lexical/html'
import React from 'react'
type NodeTypes =
| DefaultNodeTypes
| SerializedBlockNode<MyTextBlock>
| SerializedInlineBlockNode<MyInlineBlock>
const htmlConverters: HTMLConvertersFunction<NodeTypes> = ({ defaultConverters }) => ({
...defaultConverters,
blocks: {
// Each key should match your block's slug
myTextBlock: ({ node, providedCSSString }) =>
`<div style="background-color: red;${providedCSSString}">${node.fields.text}</div>`,
},
inlineBlocks: {
// Each key should match your inline block's slug
myInlineBlock: ({ node, providedStyleTag }) =>
`<span${providedStyleTag}>${node.fields.text}</span$>`,
},
})
export const MyComponent = ({ data }: { data: SerializedEditorState }) => {
const html = convertLexicalToHTML({
converters: htmlConverters,
data,
})
return <div dangerouslySetInnerHTML={{ __html: html }} />
}
```
In both cases, the conversion needs to happen on a server, as the HTML converter will automatically fetch data for nodes that require it (e.g. uploads and internal links). The editor comes with built-in HTML serializers, simplifying the process of converting JSON to HTML.
### Outputting HTML from the Collection
To add HTML generation directly within the collection, follow the example below:
```ts
import type { HTMLConvertersFunction } from '@payloadcms/richtext-lexical/html'
import type { MyTextBlock } from '@/payload-types.js'
import type { CollectionConfig } from 'payload'
import {
BlocksFeature,
type DefaultNodeTypes,
lexicalEditor,
lexicalHTMLField,
type SerializedBlockNode,
} from '@payloadcms/richtext-lexical'
import { HTMLConverterFeature, lexicalEditor, lexicalHTML } from '@payloadcms/richtext-lexical'
const Pages: CollectionConfig = {
slug: 'pages',
@@ -320,53 +175,71 @@ const Pages: CollectionConfig = {
{
name: 'nameOfYourRichTextField',
type: 'richText',
editor: lexicalEditor(),
},
lexicalHTMLField({
htmlFieldName: 'nameOfYourRichTextField_html',
lexicalFieldName: 'nameOfYourRichTextField',
}),
{
name: 'customRichText',
type: 'richText',
editor: lexicalEditor({
features: ({ defaultFeatures }) => [
...defaultFeatures,
BlocksFeature({
blocks: [
{
interfaceName: 'MyTextBlock',
slug: 'myTextBlock',
fields: [
{
name: 'text',
type: 'text',
},
],
},
],
}),
// The HTMLConverter Feature is the feature which manages the HTML serializers.
// If you do not pass any arguments to it, it will use the default serializers.
HTMLConverterFeature({}),
],
}),
},
lexicalHTMLField({
htmlFieldName: 'customRichText_html',
lexicalFieldName: 'customRichText',
// can pass in additional converters or override default ones
converters: (({ defaultConverters }) => ({
...defaultConverters,
blocks: {
myTextBlock: ({ node, providedCSSString }) =>
`<div style="background-color: red;${providedCSSString}">${node.fields.text}</div>`,
},
})) as HTMLConvertersFunction<DefaultNodeTypes | SerializedBlockNode<MyTextBlock>>,
}),
lexicalHTML('nameOfYourRichTextField', { name: 'nameOfYourRichTextField_html' }),
],
}
```
The `lexicalHTML()` function creates a new field that automatically converts the referenced lexical richText field into HTML through an afterRead hook.
### Generating HTML anywhere on the server
If you wish to convert JSON to HTML ad-hoc, use the `convertLexicalToHTML` function:
```ts
import { consolidateHTMLConverters, convertLexicalToHTML } from '@payloadcms/richtext-lexical'
await convertLexicalToHTML({
converters: consolidateHTMLConverters({ editorConfig }),
data: editorData,
payload, // if you have Payload but no req available, pass it in here to enable server-only functionality (e.g. proper conversion of upload nodes)
req, // if you have req available, pass it in here to enable server-only functionality (e.g. proper conversion of upload nodes). No need to pass in Payload if req is passed in.
})
```
This method employs `convertLexicalToHTML` from `@payloadcms/richtext-lexical`, which converts the serialized editor state into HTML.
Because every `Feature` is able to provide html converters, and because the `htmlFeature` can modify those or provide their own, we need to consolidate them with the default html Converters using the `consolidateHTMLConverters` function.
#### Example: Generating HTML within an afterRead hook
```ts
import type { FieldHook } from 'payload'
import {
HTMLConverterFeature,
consolidateHTMLConverters,
convertLexicalToHTML,
defaultEditorConfig,
defaultEditorFeatures,
sanitizeServerEditorConfig,
} from '@payloadcms/richtext-lexical'
const hook: FieldHook = async ({ req, siblingData }) => {
const editorConfig = defaultEditorConfig
editorConfig.features = [...defaultEditorFeatures, HTMLConverterFeature({})]
const sanitizedEditorConfig = await sanitizeServerEditorConfig(editorConfig, req.payload.config)
const html = await convertLexicalToHTML({
converters: consolidateHTMLConverters({ editorConfig: sanitizedEditorConfig }),
data: siblingData.lexicalSimple,
req,
})
return html
}
```
### CSS
Payload's lexical HTML converter does not generate CSS for you, but it does add classes to the generated HTML. You can use these classes to style the HTML in your frontend.
@@ -380,85 +253,141 @@ Here is some "base" CSS you can use to ensure that nested lists render correctly
}
```
### Creating your own HTML Converter
HTML Converters are typed as `HTMLConverter`, which contains the node type it should handle, and a function that accepts the serialized node from the lexical editor, and outputs the HTML string. Here's the HTML Converter of the Upload node as an example:
```ts
import type { HTMLConverter } from '@payloadcms/richtext-lexical'
const UploadHTMLConverter: HTMLConverter<SerializedUploadNode> = {
converter: async ({ node, req }) => {
const uploadDocument: {
value?: any
} = {}
if(req) {
await populate({
id,
collectionSlug: node.relationTo,
currentDepth: 0,
data: uploadDocument,
depth: 1,
draft: false,
key: 'value',
overrideAccess: false,
req,
showHiddenFields: false,
})
}
const url = (req?.payload?.config?.serverURL || '') + uploadDocument?.value?.url
if (!(uploadDocument?.value?.mimeType as string)?.startsWith('image')) {
// Only images can be serialized as HTML
return ``
}
return `<img src="${url}" alt="${uploadDocument?.value?.filename}" width="${uploadDocument?.value?.width}" height="${uploadDocument?.value?.height}"/>`
},
nodeTypes: [UploadNode.getType()], // This is the type of the lexical node that this converter can handle. Instead of hardcoding 'upload' we can get the node type directly from the UploadNode, since it's static.
}
```
As you can see, we have access to all the information saved in the node (for the Upload node, this is `value`and `relationTo`) and we can use that to generate the HTML.
The `convertLexicalToHTML` is part of `@payloadcms/richtext-lexical` automatically handles traversing the editor state and calling the correct converter for each node.
### Embedding the HTML Converter in your Feature
You can embed your HTML Converter directly within your custom `ServerFeature`, allowing it to be handled automatically by the `consolidateHTMLConverters` function. Here is an example:
```ts
import { createNode } from '@payloadcms/richtext-lexical'
import type { FeatureProviderProviderServer } from '@payloadcms/richtext-lexical'
export const UploadFeature: FeatureProviderProviderServer<
UploadFeatureProps,
UploadFeaturePropsClient
> = (props) => {
/*...*/
return {
feature: () => {
return {
nodes: [
createNode({
converters: {
html: yourHTMLConverter, // <= This is where you define your HTML Converter
},
node: UploadNode,
//...
}),
],
ClientComponent: UploadFeatureClientComponent,
clientFeatureProps: clientProps,
serverFeatureProps: props,
/*...*/
}
},
key: 'upload',
serverFeatureProps: props,
}
}
```
## Headless Editor
Lexical provides a seamless way to perform conversions between various other formats:
- HTML to Lexical
- Markdown to Lexical
- HTML to Lexical (or, importing HTML into the lexical editor)
- Markdown to Lexical (or, importing Markdown into the lexical editor)
- Lexical to Markdown
A headless editor can perform such conversions outside of the main editor instance. Follow this method to initiate a headless editor:
```ts
import { createHeadlessEditor } from '@payloadcms/richtext-lexical/lexical/headless'
import { getEnabledNodes, editorConfigFactory } from '@payloadcms/richtext-lexical'
import { getEnabledNodes, sanitizeServerEditorConfig } from '@payloadcms/richtext-lexical'
const yourEditorConfig // <= your editor config here
const payloadConfig // <= your Payload Config here
const headlessEditor = createHeadlessEditor({
nodes: getEnabledNodes({
editorConfig: await editorConfigFactory.default({config: payloadConfig})
editorConfig: sanitizeServerEditorConfig(yourEditorConfig, payloadConfig),
}),
})
```
### Getting the editor config
You need to provide an editor config in order to create a headless editor. This is because the editor config is used to determine which nodes & features are enabled, and which converters are used.
As you can see, you need to provide an editor config in order to create a headless editor. This is because the editor config is used to determine which nodes & features are enabled, and which converters are used.
To get the editor config, import the `editorConfigFactory` factory - this factory provides a variety of ways to get the editor config, depending on your use case.
To get the editor config, simply import the default editor config and adjust it - just like you did inside of the `editor: lexicalEditor({})` property:
```ts
import type { SanitizedConfig } from 'payload'
import { defaultEditorConfig, defaultEditorFeatures } from '@payloadcms/richtext-lexical' // <= make sure this package is installed
import {
editorConfigFactory,
FixedToolbarFeature,
lexicalEditor,
} from '@payloadcms/richtext-lexical'
const yourEditorConfig = defaultEditorConfig
// Your config needs to be available in order to retrieve the default editor config
const config: SanitizedConfig = {} as SanitizedConfig
// Version 1 - use the default editor config
const yourEditorConfig = await editorConfigFactory.default({ config })
// Version 2 - if you have access to a lexical fields, you can extract the editor config from it
const yourEditorConfig2 = editorConfigFactory.fromField({
field: collectionConfig.fields[1],
})
// Version 3 - create a new editor config - behaves just like instantiating a new `lexicalEditor`
const yourEditorConfig3 = await editorConfigFactory.fromFeatures({
config,
features: ({ defaultFeatures }) => [...defaultFeatures, FixedToolbarFeature()],
})
// Version 4 - if you have instantiated a lexical editor and are accessing it outside a field (=> this is the unsanitized editor),
// you can extract the editor config from it.
// This is common if you define the editor in a re-usable module scope variable and pass it to the richText field.
// This is the least efficient way to get the editor config, and not recommended. It is recommended to extract the `features` arg
// into a separate variable and use `fromFeatures` instead.
const editor = lexicalEditor({
features: ({ defaultFeatures }) => [...defaultFeatures, FixedToolbarFeature()],
})
const yourEditorConfig4 = await editorConfigFactory.fromEditor({
config,
editor,
})
// If you made changes to the features of the field's editor config, you should also make those changes here:
yourEditorConfig.features = [
...defaultEditorFeatures,
// Add your custom features here
]
```
### Example - Getting the editor config from an existing field
### Getting the editor config from an existing field
If you have access to the sanitized collection config, you can get access to the lexical sanitized editor config & features, as every lexical richText field returns it. Here is an example how you can get it from another field's afterRead hook:
```ts
import type { CollectionConfig, RichTextField } from 'payload'
import { editorConfigFactory, getEnabledNodes, lexicalEditor } from '@payloadcms/richtext-lexical'
import { createHeadlessEditor } from '@payloadcms/richtext-lexical/lexical/headless'
import type { LexicalRichTextAdapter, SanitizedServerEditorConfig } from '@payloadcms/richtext-lexical'
import {
getEnabledNodes,
lexicalEditor
} from '@payloadcms/richtext-lexical'
export const MyCollection: CollectionConfig = {
slug: 'slug',
@@ -468,18 +397,20 @@ export const MyCollection: CollectionConfig = {
type: 'text',
hooks: {
afterRead: [
({ siblingFields, value }) => {
const field: RichTextField = siblingFields.find(
({ value, collection }) => {
const otherRichTextField: RichTextField = collection.fields.find(
(field) => 'name' in field && field.name === 'richText',
) as RichTextField
const editorConfig = editorConfigFactory.fromField({
field,
})
const lexicalAdapter: LexicalRichTextAdapter =
otherRichTextField.editor as LexicalRichTextAdapter
const sanitizedServerEditorConfig: SanitizedServerEditorConfig =
lexicalAdapter.editorConfig
const headlessEditor = createHeadlessEditor({
nodes: getEnabledNodes({
editorConfig,
editorConfig: sanitizedServerEditorConfig,
}),
})
@@ -493,43 +424,37 @@ export const MyCollection: CollectionConfig = {
{
name: 'richText',
type: 'richText',
editor: lexicalEditor(),
},
],
editor: lexicalEditor({
features,
}),
}
]
}
```
## HTML => Lexical
If you have access to the Payload Config and the lexical editor config, you can convert HTML to the lexical editor state with the following:
Once you have your headless editor instance, you can use it to convert HTML to Lexical:
```ts
import { convertHTMLToLexical, editorConfigFactory } from '@payloadcms/richtext-lexical'
// Make sure you have jsdom and @types/jsdom installed
import { $generateNodesFromDOM } from '@payloadcms/richtext-lexical/lexical/html'
import { $getRoot, $getSelection } from '@payloadcms/richtext-lexical/lexical'
import { JSDOM } from 'jsdom'
const html = convertHTMLToLexical({
editorConfig: await editorConfigFactory.default({
config, // <= make sure you have access to your Payload Config
}),
html: '<p>text</p>',
JSDOM, // pass the JSDOM import. As it's a relatively large package, richtext-lexical does not include it by default.
})
```
## Markdown => Lexical
Convert markdown content to the Lexical editor format with the following:
```ts
import { $convertFromMarkdownString, editorConfigFactory } from '@payloadcms/richtext-lexical'
const yourEditorConfig = await editorConfigFactory.default({ config })
const markdown = `# Hello World`
headlessEditor.update(
() => {
$convertFromMarkdownString(markdown, yourEditorConfig.features.markdownTransformers)
// In a headless environment you can use a package such as JSDom to parse the HTML string.
const dom = new JSDOM(htmlString)
// Once you have the DOM instance it's easy to generate LexicalNodes.
const nodes = $generateNodesFromDOM(headlessEditor, dom.window.document)
// Select the root
$getRoot().select()
// Insert them at a selection.
const selection = $getSelection()
selection.insertNodes(nodes)
},
{ discrete: true },
)
@@ -549,6 +474,27 @@ This has been taken from the [lexical serialization & deserialization docs](http
immediate reading of the updated state isn't necessary, you can omit the flag.
</Banner>
## Markdown => Lexical
Convert markdown content to the Lexical editor format with the following:
```ts
import { sanitizeServerEditorConfig, $convertFromMarkdownString } from '@payloadcms/richtext-lexical'
const yourSanitizedEditorConfig = sanitizeServerEditorConfig(yourEditorConfig, payloadConfig) // <= your editor config & Payload Config here
const markdown = `# Hello World`
headlessEditor.update(
() => {
$convertFromMarkdownString(markdown, yourSanitizedEditorConfig.features.markdownTransformers)
},
{ discrete: true },
)
// Do this if you then want to get the editor JSON
const editorJSON = headlessEditor.getEditorState().toJSON()
```
## Lexical => Markdown
Export content from the Lexical editor into Markdown format using these steps:
@@ -559,12 +505,11 @@ Export content from the Lexical editor into Markdown format using these steps:
Here's the code for it:
```ts
import { $convertToMarkdownString } from '@payloadcms/richtext-lexical/lexical/markdown'
import { sanitizeServerEditorConfig } from '@payloadcms/richtext-lexical'
import type { SerializedEditorState } from '@payloadcms/richtext-lexical/lexical'
import { editorConfigFactory } from '@payloadcms/richtext-lexical'
import { $convertToMarkdownString } from '@payloadcms/richtext-lexical/lexical/markdown'
const yourEditorConfig = await editorConfigFactory.default({ config })
const yourSanitizedEditorConfig = sanitizeServerEditorConfig(yourEditorConfig, payloadConfig) // <= your editor config & Payload Config here
const yourEditorState: SerializedEditorState // <= your current editor state here
// Import editor state into your headless editor
@@ -573,7 +518,7 @@ try {
() => {
headlessEditor.setEditorState(headlessEditor.parseEditorState(yourEditorState))
},
{ discrete: true }, // This should commit the editor state immediately
{ discrete: true }, // This should commit the editor state immediately
)
} catch (e) {
logger.error({ err: e }, 'ERROR parsing editor state')
@@ -582,7 +527,7 @@ try {
// Export to markdown
let markdown: string
headlessEditor.getEditorState().read(() => {
markdown = $convertToMarkdownString(yourEditorConfig?.features?.markdownTransformers)
markdown = $convertToMarkdownString(yourSanitizedEditorConfig?.features?.markdownTransformers)
})
```
@@ -603,13 +548,13 @@ const yourEditorState: SerializedEditorState // <= your current editor state her
// Import editor state into your headless editor
try {
headlessEditor.update(
headlessEditor.update(
() => {
headlessEditor.setEditorState(headlessEditor.parseEditorState(yourEditorState))
},
{ discrete: true }, // This should commit the editor state immediately
{ discrete: true }, // This should commit the editor state immediately
)
} catch (e) {
} catch (e) {
logger.error({ err: e }, 'ERROR parsing editor state')
}

View File

@@ -158,7 +158,7 @@ Here's an overview of all the included features:
| **`IndentFeature`** | Yes | Allows you to indent text with the tab key |
| **`UnorderedListFeature`** | Yes | Adds unordered lists (ul) |
| **`OrderedListFeature`** | Yes | Adds ordered lists (ol) |
| **`ChecklistFeature`** | Yes | Adds checklists |
| **`CheckListFeature`** | Yes | Adds checklists |
| **`LinkFeature`** | Yes | Allows you to create internal and external links |
| **`RelationshipFeature`** | Yes | Allows you to create block-level (not inline) relationships to other documents |
| **`BlockquoteFeature`** | Yes | Allows you to create block-level quotes |

View File

@@ -185,8 +185,6 @@ The [Admin Panel](../admin/overview) will also automatically display all availab
Behind the scenes, Payload relies on [`sharp`](https://sharp.pixelplumbing.com/api-resize#resize) to perform its image resizing. You can specify additional options for `sharp` to use while resizing your images.
Note that for image resizing to work, `sharp` must be specified in your [Payload Config](../configuration/overview). This is configured by default if you created your Payload project with `create-payload-app`. See `sharp` in [Config Options](../configuration/overview#config-options).
#### Accessing the resized images in hooks
All auto-resized images are exposed to be re-used in hooks and similar via an object that is bound to `req.payloadUploadSizes`.
@@ -349,32 +347,6 @@ fetch('api/:upload-slug', {
})
```
## Uploading Files stored locally
If you want to upload a file stored on your machine directly using the `payload.create` method, for example, during a seed script,
you can use the `filePath` property to specify the local path of the file.
```ts
const localFilePath = path.resolve(__dirname, filename)
await payload.create({
collection: 'media',
data: {
alt,
},
filePath: localFilePath,
})
```
The `data` property should still include all the required fields of your `media` collection.
<Banner type="warning">
**Important:**
Remember that all custom hooks attached to the `media` collection will still trigger.
Ensure that files match the specified mimeTypes or sizes defined in the collection's `formatOptions` or custom `hooks`.
</Banner>
## Uploading Files from Remote URLs
The `pasteURL` option allows users to fetch files from remote URLs by pasting them into an Upload field. This option is **enabled by default** and can be configured to either **allow unrestricted client-side fetching** or **restrict server-side fetching** to specific trusted domains.

View File

@@ -25,7 +25,7 @@
"graphql": "^16.9.0",
"next": "^15.0.0",
"payload": "latest",
"payload-admin-bar": "^1.0.7",
"payload-admin-bar": "^1.0.6",
"react": "19.0.0",
"react-dom": "19.0.0"
},

5404
examples/draft-preview/pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -42,7 +42,7 @@
"next": "^15.1.0",
"next-intl": "^3.23.2",
"payload": "latest",
"payload-admin-bar": "^1.0.7",
"payload-admin-bar": "^1.0.6",
"prism-react-renderer": "^2.3.1",
"react": "^19.0.0",
"react-dom": "^19.0.0",

File diff suppressed because it is too large Load Diff

View File

@@ -1,5 +1,3 @@
DATABASE_URI=mongodb://127.0.0.1/payload-example-multi-tenant
POSTGRES_URL=postgres://127.0.0.1:5432/payload-example-multi-tenant
PAYLOAD_SECRET=PAYLOAD_MULTI_TENANT_EXAMPLE_SECRET_KEY
PAYLOAD_PUBLIC_SERVER_URL=http://localhost:3000
SEED_DB=true

View File

@@ -46,12 +46,12 @@ See the [Collections](https://payloadcms.com/docs/configuration/collections) doc
**Domain-based Tenant Setting**:
This example also supports domain-based tenant selection, where tenants can be associated with a specific domain. If a tenant is associated with a domain (e.g., `gold.localhost:3000`), when a user logs in from that domain, they will be automatically scoped to the matching tenant. This is accomplished through an optional `afterLogin` hook that sets a `payload-tenant` cookie based on the domain.
This example also supports domain-based tenant selection, where tenants can be associated with a specific domain. If a tenant is associated with a domain (e.g., `gold.test:3000`), when a user logs in from that domain, they will be automatically scoped to the matching tenant. This is accomplished through an optional `afterLogin` hook that sets a `payload-tenant` cookie based on the domain.
For the domain portion of the example to function properly, you will need to add the following entries to your system's `/etc/hosts` file:
```
127.0.0.1 gold.localhost silver.localhost bronze.localhost
127.0.0.1 gold.test silver.test bronze.test
```
- #### Pages

View File

@@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />
// NOTE: This file should not be edited
// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.
// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.

View File

@@ -17,7 +17,6 @@
},
"dependencies": {
"@payloadcms/db-mongodb": "latest",
"@payloadcms/db-postgres": "^3.25.0",
"@payloadcms/next": "latest",
"@payloadcms/plugin-multi-tenant": "latest",
"@payloadcms/richtext-lexical": "latest",

File diff suppressed because it is too large Load Diff

View File

@@ -10,10 +10,10 @@ export default async ({ params: paramsPromise }: { params: Promise<{ slug: strin
<p>When you visit a tenant by domain, the domain is used to determine the tenant.</p>
<p>
For example, visiting{' '}
<a href="http://gold.localhost:3000/tenant-domains/login">
http://gold.localhost:3000/tenant-domains/login
<a href="http://gold.test:3000/tenant-domains/login">
http://gold.test:3000/tenant-domains/login
</a>{' '}
will show the tenant with the domain "gold.localhost".
will show the tenant with the domain "gold.test".
</p>
<h2>Slugs</h2>

View File

@@ -1,9 +1,12 @@
import { TenantField as TenantField_1d0591e3cf4f332c83a86da13a0de59a } from '@payloadcms/plugin-multi-tenant/client'
import { TenantSelector as TenantSelector_1d0591e3cf4f332c83a86da13a0de59a } from '@payloadcms/plugin-multi-tenant/client'
import { TenantSelectionProvider as TenantSelectionProvider_d6d5f193a167989e2ee7d14202901e62 } from '@payloadcms/plugin-multi-tenant/rsc'
import { TenantSelector as TenantSelector_d6d5f193a167989e2ee7d14202901e62 } from '@payloadcms/plugin-multi-tenant/rsc'
import { TenantSelectionProvider as TenantSelectionProvider_1d0591e3cf4f332c83a86da13a0de59a } from '@payloadcms/plugin-multi-tenant/client'
export const importMap = {
"@payloadcms/plugin-multi-tenant/client#TenantField": TenantField_1d0591e3cf4f332c83a86da13a0de59a,
"@payloadcms/plugin-multi-tenant/client#TenantSelector": TenantSelector_1d0591e3cf4f332c83a86da13a0de59a,
"@payloadcms/plugin-multi-tenant/rsc#TenantSelectionProvider": TenantSelectionProvider_d6d5f193a167989e2ee7d14202901e62
'@payloadcms/plugin-multi-tenant/client#TenantField':
TenantField_1d0591e3cf4f332c83a86da13a0de59a,
'@payloadcms/plugin-multi-tenant/rsc#TenantSelector':
TenantSelector_d6d5f193a167989e2ee7d14202901e62,
'@payloadcms/plugin-multi-tenant/client#TenantSelectionProvider':
TenantSelectionProvider_1d0591e3cf4f332c83a86da13a0de59a,
}

View File

@@ -1,9 +1,8 @@
import type { FieldHook, Where } from 'payload'
import type { FieldHook } from 'payload'
import { ValidationError } from 'payload'
import { getUserTenantIDs } from '../../../utilities/getUserTenantIDs'
import { extractID } from '@/utilities/extractID'
export const ensureUniqueSlug: FieldHook = async ({ data, originalDoc, req, value }) => {
// if value is unchanged, skip validation
@@ -11,30 +10,26 @@ export const ensureUniqueSlug: FieldHook = async ({ data, originalDoc, req, valu
return value
}
const constraints: Where[] = [
{
slug: {
equals: value,
},
},
]
const incomingTenantID = extractID(data?.tenant)
const currentTenantID = extractID(originalDoc?.tenant)
const incomingTenantID = typeof data?.tenant === 'object' ? data.tenant.id : data?.tenant
const currentTenantID =
typeof originalDoc?.tenant === 'object' ? originalDoc.tenant.id : originalDoc?.tenant
const tenantIDToMatch = incomingTenantID || currentTenantID
if (tenantIDToMatch) {
constraints.push({
tenant: {
equals: tenantIDToMatch,
},
})
}
const findDuplicatePages = await req.payload.find({
collection: 'pages',
where: {
and: constraints,
and: [
{
tenant: {
equals: tenantIDToMatch,
},
},
{
slug: {
equals: value,
},
},
],
},
})

View File

@@ -1,11 +1,11 @@
import type { User } from '@/payload-types'
import type { Access, Where } from 'payload'
import { getTenantFromCookie } from '@payloadcms/plugin-multi-tenant/utilities'
import { parseCookies } from 'payload'
import { isSuperAdmin } from '../../../access/isSuperAdmin'
import { getUserTenantIDs } from '../../../utilities/getUserTenantIDs'
import { isAccessingSelf } from './isAccessingSelf'
import { getCollectionIDType } from '@/utilities/getCollectionIDType'
export const readAccess: Access<User> = ({ req, id }) => {
if (!req?.user) {
@@ -16,11 +16,9 @@ export const readAccess: Access<User> = ({ req, id }) => {
return true
}
const cookies = parseCookies(req.headers)
const superAdmin = isSuperAdmin(req.user)
const selectedTenant = getTenantFromCookie(
req.headers,
getCollectionIDType({ payload: req.payload, collectionSlug: 'tenants' }),
)
const selectedTenant = cookies.get('payload-tenant')
const adminTenantAccessIDs = getUserTenantIDs(req.user, 'tenant-admin')
if (selectedTenant) {

View File

@@ -1,11 +1,8 @@
import type { FieldHook, Where } from 'payload'
import type { FieldHook } from 'payload'
import { ValidationError } from 'payload'
import { getUserTenantIDs } from '../../../utilities/getUserTenantIDs'
import { extractID } from '@/utilities/extractID'
import { getTenantFromCookie } from '@payloadcms/plugin-multi-tenant/utilities'
import { getCollectionIDType } from '@/utilities/getCollectionIDType'
export const ensureUniqueUsername: FieldHook = async ({ data, originalDoc, req, value }) => {
// if value is unchanged, skip validation
@@ -13,31 +10,26 @@ export const ensureUniqueUsername: FieldHook = async ({ data, originalDoc, req,
return value
}
const constraints: Where[] = [
{
username: {
equals: value,
},
},
]
const selectedTenant = getTenantFromCookie(
req.headers,
getCollectionIDType({ payload: req.payload, collectionSlug: 'tenants' }),
)
if (selectedTenant) {
constraints.push({
'tenants.tenant': {
equals: selectedTenant,
},
})
}
const incomingTenantID = typeof data?.tenant === 'object' ? data.tenant.id : data?.tenant
const currentTenantID =
typeof originalDoc?.tenant === 'object' ? originalDoc.tenant.id : originalDoc?.tenant
const tenantIDToMatch = incomingTenantID || currentTenantID
const findDuplicateUsers = await req.payload.find({
collection: 'users',
where: {
and: constraints,
and: [
{
'tenants.tenant': {
equals: tenantIDToMatch,
},
},
{
username: {
equals: value,
},
},
],
},
})
@@ -47,8 +39,7 @@ export const ensureUniqueUsername: FieldHook = async ({ data, originalDoc, req,
// provide a more specific error message
if (req.user.roles?.includes('super-admin') || tenantIDs.length > 1) {
const attemptedTenantChange = await req.payload.findByID({
// @ts-ignore - selectedTenant will match DB ID type
id: selectedTenant,
id: tenantIDToMatch,
collection: 'tenants',
})

View File

@@ -21,7 +21,7 @@ export const setCookieBasedOnDomain: CollectionAfterLoginHook = async ({ req, us
expires: getCookieExpiration({ seconds: 7200 }),
path: '/',
returnCookieAsObject: false,
value: String(relatedOrg.docs[0].id),
value: relatedOrg.docs[0].id,
})
// Merge existing responseHeaders with the new Set-Cookie header

View File

@@ -1,12 +1,12 @@
import { Config } from 'payload'
import type { MigrateUpArgs } from '@payloadcms/db-mongodb'
export const seed: NonNullable<Config['onInit']> = async (payload): Promise<void> => {
export async function up({ payload }: MigrateUpArgs): Promise<void> {
const tenant1 = await payload.create({
collection: 'tenants',
data: {
name: 'Tenant 1',
slug: 'gold',
domain: 'gold.localhost',
domain: 'gold.test',
},
})
@@ -15,7 +15,7 @@ export const seed: NonNullable<Config['onInit']> = async (payload): Promise<void
data: {
name: 'Tenant 2',
slug: 'silver',
domain: 'silver.localhost',
domain: 'silver.test',
},
})
@@ -24,7 +24,7 @@ export const seed: NonNullable<Config['onInit']> = async (payload): Promise<void
data: {
name: 'Tenant 3',
slug: 'bronze',
domain: 'bronze.localhost',
domain: 'bronze.test',
},
})

View File

@@ -6,65 +6,10 @@
* and re-run `payload generate:types` to regenerate this file.
*/
/**
* Supported timezones in IANA format.
*
* This interface was referenced by `Config`'s JSON-Schema
* via the `definition` "supportedTimezones".
*/
export type SupportedTimezones =
| 'Pacific/Midway'
| 'Pacific/Niue'
| 'Pacific/Honolulu'
| 'Pacific/Rarotonga'
| 'America/Anchorage'
| 'Pacific/Gambier'
| 'America/Los_Angeles'
| 'America/Tijuana'
| 'America/Denver'
| 'America/Phoenix'
| 'America/Chicago'
| 'America/Guatemala'
| 'America/New_York'
| 'America/Bogota'
| 'America/Caracas'
| 'America/Santiago'
| 'America/Buenos_Aires'
| 'America/Sao_Paulo'
| 'Atlantic/South_Georgia'
| 'Atlantic/Azores'
| 'Atlantic/Cape_Verde'
| 'Europe/London'
| 'Europe/Berlin'
| 'Africa/Lagos'
| 'Europe/Athens'
| 'Africa/Cairo'
| 'Europe/Moscow'
| 'Asia/Riyadh'
| 'Asia/Dubai'
| 'Asia/Baku'
| 'Asia/Karachi'
| 'Asia/Tashkent'
| 'Asia/Calcutta'
| 'Asia/Dhaka'
| 'Asia/Almaty'
| 'Asia/Jakarta'
| 'Asia/Bangkok'
| 'Asia/Shanghai'
| 'Asia/Singapore'
| 'Asia/Tokyo'
| 'Asia/Seoul'
| 'Australia/Sydney'
| 'Pacific/Guam'
| 'Pacific/Noumea'
| 'Pacific/Auckland'
| 'Pacific/Fiji';
export interface Config {
auth: {
users: UserAuthOperations;
};
blocks: {};
collections: {
pages: Page;
users: User;
@@ -83,7 +28,7 @@ export interface Config {
'payload-migrations': PayloadMigrationsSelect<false> | PayloadMigrationsSelect<true>;
};
db: {
defaultIDType: number;
defaultIDType: string;
};
globals: {};
globalsSelect: {};
@@ -119,8 +64,8 @@ export interface UserAuthOperations {
* via the `definition` "pages".
*/
export interface Page {
id: number;
tenant?: (number | null) | Tenant;
id: string;
tenant?: (string | null) | Tenant;
title?: string | null;
slug?: string | null;
updatedAt: string;
@@ -131,7 +76,7 @@ export interface Page {
* via the `definition` "tenants".
*/
export interface Tenant {
id: number;
id: string;
name: string;
/**
* Used for domain-based tenant handling
@@ -153,12 +98,12 @@ export interface Tenant {
* via the `definition` "users".
*/
export interface User {
id: number;
id: string;
roles?: ('super-admin' | 'user')[] | null;
username?: string | null;
tenants?:
| {
tenant: number | Tenant;
tenant: string | Tenant;
roles: ('tenant-admin' | 'tenant-viewer')[];
id?: string | null;
}[]
@@ -179,24 +124,24 @@ export interface User {
* via the `definition` "payload-locked-documents".
*/
export interface PayloadLockedDocument {
id: number;
id: string;
document?:
| ({
relationTo: 'pages';
value: number | Page;
value: string | Page;
} | null)
| ({
relationTo: 'users';
value: number | User;
value: string | User;
} | null)
| ({
relationTo: 'tenants';
value: number | Tenant;
value: string | Tenant;
} | null);
globalSlug?: string | null;
user: {
relationTo: 'users';
value: number | User;
value: string | User;
};
updatedAt: string;
createdAt: string;
@@ -206,10 +151,10 @@ export interface PayloadLockedDocument {
* via the `definition` "payload-preferences".
*/
export interface PayloadPreference {
id: number;
id: string;
user: {
relationTo: 'users';
value: number | User;
value: string | User;
};
key?: string | null;
value?:
@@ -229,7 +174,7 @@ export interface PayloadPreference {
* via the `definition` "payload-migrations".
*/
export interface PayloadMigration {
id: number;
id: string;
name?: string | null;
batch?: number | null;
updatedAt: string;

View File

@@ -1,5 +1,4 @@
import { mongooseAdapter } from '@payloadcms/db-mongodb'
import { postgresAdapter } from '@payloadcms/db-postgres'
import { lexicalEditor } from '@payloadcms/richtext-lexical'
import path from 'path'
import { buildConfig } from 'payload'
@@ -12,7 +11,6 @@ import { multiTenantPlugin } from '@payloadcms/plugin-multi-tenant'
import { isSuperAdmin } from './access/isSuperAdmin'
import type { Config } from './payload-types'
import { getUserTenantIDs } from './utilities/getUserTenantIDs'
import { seed } from './seed'
const filename = fileURLToPath(import.meta.url)
const dirname = path.dirname(filename)
@@ -23,19 +21,9 @@ export default buildConfig({
user: 'users',
},
collections: [Pages, Users, Tenants],
// db: mongooseAdapter({
// url: process.env.DATABASE_URI as string,
// }),
db: postgresAdapter({
pool: {
connectionString: process.env.POSTGRES_URL,
},
db: mongooseAdapter({
url: process.env.DATABASE_URI as string,
}),
onInit: async (args) => {
if (process.env.SEED_DB) {
await seed(args)
}
},
editor: lexicalEditor({}),
graphQL: {
schemaOutputFile: path.resolve(dirname, 'generated-schema.graphql'),

View File

@@ -1,9 +0,0 @@
import type { CollectionSlug, Payload } from 'payload'
type Args = {
collectionSlug: CollectionSlug
payload: Payload
}
export const getCollectionIDType = ({ collectionSlug, payload }: Args): 'number' | 'text' => {
return payload.collections[collectionSlug]?.customIDType ?? payload.db.defaultIDType
}

View File

@@ -20,7 +20,6 @@ const config = withBundleAnalyzer(
ignoreBuildErrors: true,
},
experimental: {
fullySpecified: true,
serverActions: {
bodySizeLimit: '5mb',
},

View File

@@ -1,12 +1,11 @@
{
"name": "payload-monorepo",
"version": "3.27.0",
"version": "3.25.0",
"private": true,
"type": "module",
"scripts": {
"bf": "pnpm run build:force",
"build": "pnpm run build:core",
"build:admin-bar": "turbo build --filter \"@payloadcms/admin-bar\"",
"build:all": "turbo build",
"build:app": "next build",
"build:app:analyze": "cross-env ANALYZE=true next build",
@@ -34,7 +33,6 @@
"build:payload-cloud": "turbo build --filter \"@payloadcms/payload-cloud\"",
"build:plugin-cloud-storage": "turbo build --filter \"@payloadcms/plugin-cloud-storage\"",
"build:plugin-form-builder": "turbo build --filter \"@payloadcms/plugin-form-builder\"",
"build:plugin-import-export": "turbo build --filter \"@payloadcms/plugin-import-export\"",
"build:plugin-multi-tenant": "turbo build --filter \"@payloadcms/plugin-multi-tenant\"",
"build:plugin-nested-docs": "turbo build --filter \"@payloadcms/plugin-nested-docs\"",
"build:plugin-redirects": "turbo build --filter \"@payloadcms/plugin-redirects\"",
@@ -81,9 +79,10 @@
"prepare": "husky",
"prepare-run-test-against-prod": "pnpm bf && rm -rf test/packed && rm -rf test/node_modules && rm -rf app && rm -f test/pnpm-lock.yaml && pnpm run script:pack --all --no-build --dest test/packed && pnpm runts test/setupProd.ts && cd test && pnpm i --ignore-workspace && cd ..",
"prepare-run-test-against-prod:ci": "rm -rf test/node_modules && rm -rf app && rm -f test/pnpm-lock.yaml && pnpm run script:pack --all --no-build --dest test/packed && pnpm runts test/setupProd.ts && cd test && pnpm i --ignore-workspace && cd ..",
"publish-prerelease": "pnpm --filter releaser publish-prerelease",
"reinstall": "pnpm clean:all && pnpm install",
"release": "pnpm --filter releaser release --tag latest",
"release:beta": "pnpm runts ./scripts/release.ts --bump prerelease --tag beta",
"release:canary": "pnpm --filter releaser release:canary",
"runts": "cross-env NODE_OPTIONS=--no-deprecation node --no-deprecation --import @swc-node/register/esm-register",
"script:build-template-with-local-pkgs": "pnpm --filter scripts build-template-with-local-pkgs",
"script:gen-templates": "pnpm --filter scripts gen-templates",

View File

@@ -1,10 +0,0 @@
.tmp
**/.git
**/.hg
**/.pnp.*
**/.svn
**/.yarn/**
**/build
**/dist/**
**/node_modules
**/temp

View File

@@ -1,24 +0,0 @@
{
"$schema": "https://json.schemastore.org/swcrc",
"sourceMaps": true,
"jsc": {
"target": "esnext",
"parser": {
"syntax": "typescript",
"tsx": true,
"dts": true
},
"transform": {
"react": {
"runtime": "automatic",
"pragmaFrag": "React.Fragment",
"throwIfNamespace": true,
"development": false,
"useBuiltins": true
}
}
},
"module": {
"type": "es6"
}
}

View File

@@ -1,22 +0,0 @@
MIT License
Copyright (c) 2018-2025 Payload CMS, Inc. <info@payloadcms.com>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@@ -1,119 +0,0 @@
# Payload Admin Bar
An admin bar for React apps using [Payload](https://github.com/payloadcms/payload).
### Installation
```bash
pnpm i @payloadcms/admin-bar
```
### Basic Usage
```jsx
import { PayloadAdminBar } from '@payloadcms/admin-bar'
export const App = () => {
return <PayloadAdminBar cmsURL="https://cms.website.com" collection="pages" id="12345" />
}
```
Checks for authentication with Payload CMS by hitting the [`/me`](https://payloadcms.com/docs/authentication/operations#me) route. If authenticated, renders an admin bar with simple controls to do the following:
- Navigate to the admin dashboard
- Navigate to the currently logged-in user's account
- Edit the current collection
- Create a new collection of the same type
- Logout
- Indicate and exit preview mode
The admin bar ships with very little style and is fully customizable.
### Dynamic props
With client-side routing, we need to update the admin bar with a new collection type and document id on each route change. This will depend on your app's specific setup, but here are a some common examples:
#### NextJS
For NextJS apps using dynamic-routes, use `getStaticProps`:
```ts
export const getStaticProps = async ({ params: { slug } }) => {
const props = {}
const pageReq = await fetch(
`https://cms.website.com/api/pages?where[slug][equals]=${slug}&depth=1`,
)
const pageData = await pageReq.json()
if (pageReq.ok) {
const { docs } = pageData
const [doc] = docs
props = {
...doc,
collection: 'pages',
collectionLabels: {
singular: 'page',
plural: 'pages',
},
}
}
return props
}
```
Now your app can forward these props onto the admin bar. Something like this:
```ts
import { PayloadAdminBar } from '@payloadcms/admin-bar';
export const App = (appProps) => {
const {
pageProps: {
collection,
collectionLabels,
id
}
} = appProps;
return (
<PayloadAdminBar
{...{
cmsURL: 'https://cms.website.com',
collection,
collectionLabels,
id
}}
/>
)
}
```
### Props
| Property | Type | Required | Default | Description |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------ | -------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| cmsURL | `string` | true | `http://localhost:8000` | `serverURL` as defined in your [Payload config](https://payloadcms.com/docs/configuration/overview#options) |
| adminPath | `string` | false | /admin | `routes` as defined in your [Payload config](https://payloadcms.com/docs/configuration/overview#options) |
| apiPath | `string` | false | /api | `routes` as defined in your [Payload config](https://payloadcms.com/docs/configuration/overview#options) |
| authCollectionSlug | `string` | false | 'users' | Slug of your [auth collection](https://payloadcms.com/docs/configuration/collections) |
| collectionSlug | `string` | true | undefined | Slug of your [collection](https://payloadcms.com/docs/configuration/collections) |
| collectionLabels | `{ singular?: string, plural?: string }` | false | undefined | Labels of your [collection](https://payloadcms.com/docs/configuration/collections) |
| id | `string` | true | undefined | id of the document |
| logo | `ReactElement` | false | undefined | Custom logo |
| classNames | `{ logo?: string, user?: string, controls?: string, create?: string, logout?: string, edit?: string, preview?: string }` | false | undefined | Custom class names, one for each rendered element |
| logoProps | `{[key: string]?: unknown}` | false | undefined | Custom props |
| userProps | `{[key: string]?: unknown}` | false | undefined | Custom props |
| divProps | `{[key: string]?: unknown}` | false | undefined | Custom props |
| createProps | `{[key: string]?: unknown}` | false | undefined | Custom props |
| logoutProps | `{[key: string]?: unknown}` | false | undefined | Custom props |
| editProps | `{[key: string]?: unknown}` | false | undefined | Custom props |
| previewProps | `{[key: string]?: unknown}` | false | undefined | Custom props |
| style | `CSSProperties` | false | undefined | Custom inline style |
| unstyled | `boolean` | false | undefined | If true, renders no inline style |
| onAuthChange | `(user: PayloadMeUser) => void` | false | undefined | Fired on each auth change |
| devMode | `boolean` | false | undefined | If true, fakes authentication (useful when dealing with [SameSite cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite)) |
| preview | `boolean` | false | undefined | If true, renders an exit button with your `onPreviewExit` handler) |
| onPreviewExit | `function` | false | undefined | Callback for the preview button `onClick` event) |

View File

@@ -1,18 +0,0 @@
import { rootEslintConfig, rootParserOptions } from '../../eslint.config.js'
/** @typedef {import('eslint').Linter.Config} Config */
/** @type {Config[]} */
export const index = [
...rootEslintConfig,
{
languageOptions: {
parserOptions: {
...rootParserOptions,
tsconfigRootDir: import.meta.dirname,
},
},
},
]
export default index

View File

@@ -1,65 +0,0 @@
{
"name": "@payloadcms/admin-bar",
"version": "3.27.0",
"description": "An admin bar for React apps using Payload",
"homepage": "https://payloadcms.com",
"repository": {
"type": "git",
"url": "https://github.com/payloadcms/payload.git",
"directory": "packages/admin-bar"
},
"license": "MIT",
"author": "Payload <dev@payloadcms.com> (https://payloadcms.com)",
"maintainers": [
{
"name": "Payload",
"email": "info@payloadcms.com",
"url": "https://payloadcms.com"
}
],
"type": "module",
"exports": {
".": {
"import": "./src/index.ts",
"types": "./src/index.ts",
"default": "./src/index.ts"
}
},
"main": "./src/index.ts",
"types": "./src/index.ts",
"files": [
"dist"
],
"scripts": {
"build": "pnpm copyfiles && pnpm build:types && pnpm build:swc",
"build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
"build:types": "tsc --emitDeclarationOnly --outDir dist",
"clean": "rimraf -g {dist,*.tsbuildinfo}",
"copyfiles": "copyfiles -u 1 \"src/**/*.{html,css,scss,ttf,woff,woff2,eot,svg,jpg,png,json}\" dist/",
"lint": "eslint .",
"lint:fix": "eslint . --fix",
"prepublishOnly": "pnpm clean && pnpm turbo build"
},
"devDependencies": {
"@payloadcms/eslint-config": "workspace:*",
"@types/react": "19.0.10",
"@types/react-dom": "19.0.4",
"payload": "workspace:*"
},
"peerDependencies": {
"react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0",
"react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"
},
"publishConfig": {
"exports": {
".": {
"import": "./dist/index.js",
"types": "./dist/index.d.ts",
"default": "./dist/index.js"
}
},
"main": "./dist/index.js",
"registry": "https://registry.npmjs.org/",
"types": "./dist/index.d.ts"
}
}

View File

@@ -1,349 +0,0 @@
'use client'
import React, { useEffect, useState } from 'react'
const dummyUser = {
id: '12345',
email: 'dev@email.com',
}
import type { PayloadAdminBarProps, PayloadMeUser } from './types.js'
export const PayloadAdminBar: React.FC<PayloadAdminBarProps> = (props) => {
const {
id: docID,
adminPath = '/admin',
apiPath = '/api',
authCollectionSlug = 'users',
className,
classNames,
cmsURL = 'http://localhost:8000',
collectionLabels,
collectionSlug,
createProps,
devMode,
divProps,
editProps,
logo,
logoProps,
logoutProps,
onAuthChange,
onPreviewExit,
preview,
previewProps,
style,
unstyled,
userProps,
} = props
const [user, setUser] = useState<PayloadMeUser>()
useEffect(() => {
const fetchMe = async () => {
try {
const meRequest = await fetch(`${cmsURL}${apiPath}/${authCollectionSlug}/me`, {
credentials: 'include',
method: 'get',
})
const meResponse = await meRequest.json()
const { user } = meResponse
if (user) {
setUser(user)
} else {
if (devMode !== true) {
setUser(null)
} else {
setUser(dummyUser)
}
}
} catch (err) {
console.warn(err)
if (devMode === true) {
setUser(dummyUser)
}
}
}
void fetchMe()
}, [cmsURL, adminPath, apiPath, devMode])
useEffect(() => {
if (typeof onAuthChange === 'function') {
onAuthChange(user)
}
}, [user, onAuthChange])
if (user) {
const { id: userID, email } = user
return (
<div
className={className}
id="payload-admin-bar"
style={{
...(unstyled !== true
? {
alignItems: 'center',
backgroundColor: '#222',
boxSizing: 'border-box',
color: '#fff',
display: 'flex',
fontFamily:
'-apple-system, BlinkMacSystemFont, Segoe UI, Roboto, Helvetica Neue, Arial, sans-serif',
fontSize: 'small',
left: 0,
minWidth: '0',
padding: '0.5rem',
position: 'fixed',
top: 0,
width: '100%',
zIndex: 99999,
}
: {}),
...style,
}}
>
<a
className={classNames?.logo}
href={`${cmsURL}${adminPath}`}
{...logoProps}
style={{
...(unstyled !== true
? {
alignItems: 'center',
color: 'inherit',
display: 'flex',
flexShrink: 0,
height: '20px',
marginRight: '10px',
textDecoration: 'none',
...(logoProps?.style
? {
...logoProps.style,
}
: {}),
}
: {}),
}}
>
{logo || 'Payload CMS'}
</a>
<a
className={classNames?.user}
href={`${cmsURL}${adminPath}/collections/${authCollectionSlug}/${userID}`}
rel="noopener noreferrer"
target="_blank"
{...userProps}
style={{
...(unstyled !== true
? {
color: 'inherit',
display: 'block',
marginRight: '10px',
minWidth: '50px',
overflow: 'hidden',
textDecoration: 'none',
textOverflow: 'ellipsis',
whiteSpace: 'nowrap',
...(userProps?.style
? {
...userProps.style,
}
: {}),
}
: {}),
}}
>
<span
style={{
...(unstyled !== true
? {
overflow: 'hidden',
textOverflow: 'ellipsis',
whiteSpace: 'nowrap',
}
: {}),
}}
>
{email || 'Profile'}
</span>
</a>
<div
className={classNames?.controls}
{...divProps}
style={{
...(unstyled !== true
? {
alignItems: 'center',
display: 'flex',
flexGrow: 1,
flexShrink: 1,
justifyContent: 'flex-end',
marginRight: '10px',
...(divProps?.style
? {
...divProps.style,
}
: {}),
}
: {}),
}}
>
{collectionSlug && docID && (
<a
className={classNames?.edit}
href={`${cmsURL}${adminPath}/collections/${collectionSlug}/${docID}`}
rel="noopener noreferrer"
target="_blank"
{...editProps}
style={{
display: 'block',
...(unstyled !== true
? {
color: 'inherit',
flexShrink: 1,
marginRight: '10px',
overflow: 'hidden',
textDecoration: 'none',
textOverflow: 'ellipsis',
whiteSpace: 'nowrap',
...(editProps?.style
? {
...editProps.style,
}
: {}),
}
: {}),
}}
>
<span
style={{
...(unstyled !== true
? {
overflow: 'hidden',
textOverflow: 'ellipsis',
whiteSpace: 'nowrap',
}
: {}),
}}
>
{`Edit ${collectionLabels?.singular || 'page'}`}
</span>
</a>
)}
{collectionSlug && (
<a
className={classNames?.create}
href={`${cmsURL}${adminPath}/collections/${collectionSlug}/create`}
rel="noopener noreferrer"
target="_blank"
{...createProps}
style={{
...(unstyled !== true
? {
color: 'inherit',
display: 'block',
flexShrink: 1,
overflow: 'hidden',
textDecoration: 'none',
textOverflow: 'ellipsis',
whiteSpace: 'nowrap',
...(createProps?.style
? {
...createProps.style,
}
: {}),
}
: {}),
}}
>
<span
style={{
...(unstyled !== true
? {
overflow: 'hidden',
textOverflow: 'ellipsis',
whiteSpace: 'nowrap',
}
: {}),
}}
>
{`New ${collectionLabels?.singular || 'page'}`}
</span>
</a>
)}
{preview && (
<button
className={classNames?.preview}
onClick={onPreviewExit}
{...previewProps}
style={{
...(unstyled !== true
? {
background: 'none',
border: 'none',
color: 'inherit',
cursor: 'pointer',
fontFamily: 'inherit',
fontSize: 'inherit',
marginLeft: '10px',
padding: 0,
...(previewProps?.style
? {
...previewProps.style,
}
: {}),
}
: {}),
}}
type="button"
>
Exit preview mode
</button>
)}
</div>
<a
className={classNames?.logout}
href={`${cmsURL}${adminPath}/logout`}
rel="noopener noreferrer"
target="_blank"
{...logoutProps}
style={{
...(unstyled !== true
? {
color: 'inherit',
display: 'block',
flexShrink: 1,
overflow: 'hidden',
textDecoration: 'none',
textOverflow: 'ellipsis',
whiteSpace: 'nowrap',
...(logoutProps?.style
? {
...logoutProps.style,
}
: {}),
}
: {}),
}}
>
<span
style={{
...(unstyled !== true
? {
overflow: 'hidden',
textOverflow: 'ellipsis',
whiteSpace: 'nowrap',
}
: {}),
}}
>
Logout
</span>
</a>
</div>
)
}
return null
}

View File

@@ -1,2 +0,0 @@
export { PayloadAdminBar } from './AdminBar.js'
export type { PayloadAdminBarProps, PayloadMeUser } from './types.js'

View File

@@ -1,67 +0,0 @@
import type { CSSProperties, ReactElement } from 'react'
export type PayloadMeUser =
| {
email: string
id: string
}
| null
| undefined
export type PayloadAdminBarProps = {
adminPath?: string
apiPath?: string
authCollectionSlug?: string
className?: string
classNames?: {
controls?: string
create?: string
edit?: string
logo?: string
logout?: string
preview?: string
user?: string
}
cmsURL?: string
collectionLabels?: {
plural?: string
singular?: string
}
collectionSlug?: string
createProps?: {
[key: string]: unknown
style?: CSSProperties
}
devMode?: boolean
divProps?: {
[key: string]: unknown
style?: CSSProperties
}
editProps?: {
[key: string]: unknown
style?: CSSProperties
}
id?: string
logo?: ReactElement
logoProps?: {
[key: string]: unknown
style?: CSSProperties
}
logoutProps?: {
[key: string]: unknown
style?: CSSProperties
}
onAuthChange?: (user: PayloadMeUser) => void
onPreviewExit?: () => void
preview?: boolean
previewProps?: {
[key: string]: unknown
style?: CSSProperties
}
style?: CSSProperties
unstyled?: boolean
userProps?: {
[key: string]: unknown
style?: CSSProperties
}
}

View File

@@ -1,9 +0,0 @@
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
/* TODO: remove the following lines */
"strict": false,
"noUncheckedIndexedAccess": false,
},
"references": [{ "path": "../payload" }]
}

View File

@@ -1,6 +1,6 @@
{
"name": "create-payload-app",
"version": "3.27.0",
"version": "3.25.0",
"homepage": "https://payloadcms.com",
"repository": {
"type": "git",

View File

@@ -1,6 +1,6 @@
{
"name": "@payloadcms/db-mongodb",
"version": "3.27.0",
"version": "3.25.0",
"description": "The officially supported MongoDB database adapter for Payload",
"homepage": "https://payloadcms.com",
"repository": {
@@ -47,6 +47,7 @@
},
"dependencies": {
"mongoose": "8.9.5",
"mongoose-aggregate-paginate-v2": "1.1.2",
"mongoose-paginate-v2": "1.8.5",
"prompts": "2.4.2",
"uuid": "10.0.0"
@@ -54,8 +55,6 @@
"devDependencies": {
"@payloadcms/eslint-config": "workspace:*",
"@types/mongoose-aggregate-paginate-v2": "1.0.12",
"@types/prompts": "^2.4.5",
"@types/uuid": "10.0.0",
"mongodb": "6.12.0",
"mongodb-memory-server": "^10",
"payload": "workspace:*"

View File

@@ -70,15 +70,9 @@ export const connect: Connect = async function connect(
await this.migrate({ migrations: this.prodMigrations })
}
} catch (err) {
let msg = `Error: cannot connect to MongoDB.`
if (typeof err === 'object' && err && 'message' in err && typeof err.message === 'string') {
msg = `${msg} Details: ${err.message}`
}
this.payload.logger.error({
err,
msg,
msg: `Error: cannot connect to MongoDB. Details: ${err.message}`,
})
process.exit(1)
}

View File

@@ -6,15 +6,13 @@ import { flattenWhereToOperators } from 'payload'
import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
export const count: Count = async function count(
this: MongooseAdapter,
{ collection: collectionSlug, locale, req, where = {} },
{ collection, locale, req, where },
) {
const { collectionConfig, Model } = getCollection({ adapter: this, collectionSlug })
const Model = this.collections[collection]
const options: CountOptions = {
session: await getSession(this, req),
}
@@ -28,8 +26,8 @@ export const count: Count = async function count(
const query = await buildQuery({
adapter: this,
collectionSlug,
fields: collectionConfig.flattenedFields,
collectionSlug: collection,
fields: this.payload.collections[collection].config.flattenedFields,
locale,
where,
})

View File

@@ -6,15 +6,13 @@ import { buildVersionGlobalFields, flattenWhereToOperators } from 'payload'
import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { getGlobal } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
export const countGlobalVersions: CountGlobalVersions = async function countGlobalVersions(
this: MongooseAdapter,
{ global: globalSlug, locale, req, where = {} },
{ global, locale, req, where },
) {
const { globalConfig, Model } = getGlobal({ adapter: this, globalSlug, versions: true })
const Model = this.versions[global]
const options: CountOptions = {
session: await getSession(this, req),
}
@@ -28,7 +26,11 @@ export const countGlobalVersions: CountGlobalVersions = async function countGlob
const query = await buildQuery({
adapter: this,
fields: buildVersionGlobalFields(this.payload.config, globalConfig, true),
fields: buildVersionGlobalFields(
this.payload.config,
this.payload.globals.config.find((each) => each.slug === global),
true,
),
locale,
where,
})

View File

@@ -6,19 +6,13 @@ import { buildVersionCollectionFields, flattenWhereToOperators } from 'payload'
import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
export const countVersions: CountVersions = async function countVersions(
this: MongooseAdapter,
{ collection: collectionSlug, locale, req, where = {} },
{ collection, locale, req, where },
) {
const { collectionConfig, Model } = getCollection({
adapter: this,
collectionSlug,
versions: true,
})
const Model = this.versions[collection]
const options: CountOptions = {
session: await getSession(this, req),
}
@@ -32,7 +26,11 @@ export const countVersions: CountVersions = async function countVersions(
const query = await buildQuery({
adapter: this,
fields: buildVersionCollectionFields(this.payload.config, collectionConfig, true),
fields: buildVersionCollectionFields(
this.payload.config,
this.payload.collections[collection].config,
true,
),
locale,
where,
})

View File

@@ -3,17 +3,15 @@ import type { Create } from 'payload'
import type { MongooseAdapter } from './index.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { handleError } from './utilities/handleError.js'
import { transform } from './utilities/transform.js'
export const create: Create = async function create(
this: MongooseAdapter,
{ collection: collectionSlug, data, req, returning },
{ collection, data, req, returning },
) {
const { collectionConfig, customIDType, Model } = getCollection({ adapter: this, collectionSlug })
const Model = this.collections[collection]
const options: CreateOptions = {
session: await getSession(this, req),
}
@@ -23,18 +21,18 @@ export const create: Create = async function create(
transform({
adapter: this,
data,
fields: collectionConfig.fields,
fields: this.payload.collections[collection].config.fields,
operation: 'write',
})
if (customIDType) {
if (this.payload.collections[collection].customIDType) {
data._id = data.id
}
try {
;[doc] = await Model.create([data], options)
} catch (error) {
handleError({ collection: collectionSlug, error, req })
handleError({ collection, error, req })
}
if (returning === false) {
return null
@@ -45,7 +43,7 @@ export const create: Create = async function create(
transform({
adapter: this,
data: doc,
fields: collectionConfig.fields,
fields: this.payload.collections[collection].config.fields,
operation: 'read',
})

View File

@@ -1,24 +1,22 @@
import type { CreateOptions } from 'mongoose'
import { type CreateGlobal } from 'payload'
import type { CreateGlobal } from 'payload'
import type { MongooseAdapter } from './index.js'
import { getGlobal } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { transform } from './utilities/transform.js'
export const createGlobal: CreateGlobal = async function createGlobal(
this: MongooseAdapter,
{ slug: globalSlug, data, req, returning },
{ slug, data, req, returning },
) {
const { globalConfig, Model } = getGlobal({ adapter: this, globalSlug })
const Model = this.globals
transform({
adapter: this,
data,
fields: globalConfig.fields,
globalSlug,
fields: this.payload.config.globals.find((globalConfig) => globalConfig.slug === slug).fields,
globalSlug: slug,
operation: 'write',
})
@@ -36,7 +34,7 @@ export const createGlobal: CreateGlobal = async function createGlobal(
transform({
adapter: this,
data: result,
fields: globalConfig.fields,
fields: this.payload.config.globals.find((globalConfig) => globalConfig.slug === slug).fields,
operation: 'read',
})

View File

@@ -1,8 +1,9 @@
import type { CreateOptions } from 'mongoose'
import { buildVersionGlobalFields, type CreateGlobalVersion } from 'payload'
import type { MongooseAdapter } from './index.js'
import { getGlobal } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { transform } from './utilities/transform.js'
@@ -21,9 +22,8 @@ export const createGlobalVersion: CreateGlobalVersion = async function createGlo
versionData,
},
) {
const { globalConfig, Model } = getGlobal({ adapter: this, globalSlug, versions: true })
const options = {
const VersionModel = this.versions[globalSlug]
const options: CreateOptions = {
session: await getSession(this, req),
}
@@ -38,7 +38,10 @@ export const createGlobalVersion: CreateGlobalVersion = async function createGlo
version: versionData,
}
const fields = buildVersionGlobalFields(this.payload.config, globalConfig)
const fields = buildVersionGlobalFields(
this.payload.config,
this.payload.config.globals.find((global) => global.slug === globalSlug),
)
transform({
adapter: this,
@@ -47,9 +50,9 @@ export const createGlobalVersion: CreateGlobalVersion = async function createGlo
operation: 'write',
})
let [doc] = await Model.create([data], options, req)
let [doc] = await VersionModel.create([data], options, req)
await Model.updateMany(
await VersionModel.updateMany(
{
$and: [
{

View File

@@ -42,9 +42,8 @@ export const createMigration: CreateMigration = async function createMigration({
const migrationFileContent = migrationTemplate(predefinedMigration)
const [yyymmdd, hhmmss] = new Date().toISOString().split('T')
const formattedDate = yyymmdd!.replace(/\D/g, '')
const formattedTime = hhmmss!.split('.')[0]!.replace(/\D/g, '')
const formattedDate = yyymmdd.replace(/\D/g, '')
const formattedTime = hhmmss.split('.')[0].replace(/\D/g, '')
const timestamp = `${formattedDate}_${formattedTime}`

View File

@@ -1,8 +1,9 @@
import type { CreateOptions } from 'mongoose'
import { buildVersionCollectionFields, type CreateVersion } from 'payload'
import type { MongooseAdapter } from './index.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { transform } from './utilities/transform.js'
@@ -21,13 +22,8 @@ export const createVersion: CreateVersion = async function createVersion(
versionData,
},
) {
const { collectionConfig, Model } = getCollection({
adapter: this,
collectionSlug,
versions: true,
})
const options = {
const VersionModel = this.versions[collectionSlug]
const options: CreateOptions = {
session: await getSession(this, req),
}
@@ -42,7 +38,10 @@ export const createVersion: CreateVersion = async function createVersion(
version: versionData,
}
const fields = buildVersionCollectionFields(this.payload.config, collectionConfig)
const fields = buildVersionCollectionFields(
this.payload.config,
this.payload.collections[collectionSlug].config,
)
transform({
adapter: this,
@@ -51,7 +50,7 @@ export const createVersion: CreateVersion = async function createVersion(
operation: 'write',
})
let [doc] = await Model.create([data], options, req)
let [doc] = await VersionModel.create([data], options, req)
const parentQuery = {
$or: [
@@ -63,7 +62,7 @@ export const createVersion: CreateVersion = async function createVersion(
],
}
await Model.updateMany(
await VersionModel.updateMany(
{
$and: [
{

View File

@@ -1,27 +1,24 @@
import type { DeleteOptions } from 'mongodb'
import { type DeleteMany } from 'payload'
import type { DeleteMany } from 'payload'
import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
export const deleteMany: DeleteMany = async function deleteMany(
this: MongooseAdapter,
{ collection: collectionSlug, req, where },
{ collection, req, where },
) {
const { collectionConfig, Model } = getCollection({ adapter: this, collectionSlug })
const Model = this.collections[collection]
const options: DeleteOptions = {
session: await getSession(this, req),
}
const query = await buildQuery({
adapter: this,
collectionSlug,
fields: collectionConfig.flattenedFields,
collectionSlug: collection,
fields: this.payload.collections[collection].config.flattenedFields,
where,
})

View File

@@ -5,20 +5,18 @@ import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { transform } from './utilities/transform.js'
export const deleteOne: DeleteOne = async function deleteOne(
this: MongooseAdapter,
{ collection: collectionSlug, req, returning, select, where },
{ collection, req, returning, select, where },
) {
const { collectionConfig, Model } = getCollection({ adapter: this, collectionSlug })
const Model = this.collections[collection]
const options: MongooseUpdateQueryOptions = {
projection: buildProjectionFromSelect({
adapter: this,
fields: collectionConfig.flattenedFields,
fields: this.payload.collections[collection].config.flattenedFields,
select,
}),
session: await getSession(this, req),
@@ -26,8 +24,8 @@ export const deleteOne: DeleteOne = async function deleteOne(
const query = await buildQuery({
adapter: this,
collectionSlug,
fields: collectionConfig.flattenedFields,
collectionSlug: collection,
fields: this.payload.collections[collection].config.flattenedFields,
where,
})
@@ -45,7 +43,7 @@ export const deleteOne: DeleteOne = async function deleteOne(
transform({
adapter: this,
data: doc,
fields: collectionConfig.fields,
fields: this.payload.collections[collection].config.fields,
operation: 'read',
})

View File

@@ -3,27 +3,26 @@ import { buildVersionCollectionFields, type DeleteVersions } from 'payload'
import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
export const deleteVersions: DeleteVersions = async function deleteVersions(
this: MongooseAdapter,
{ collection: collectionSlug, locale, req, where },
{ collection, locale, req, where },
) {
const { collectionConfig, Model } = getCollection({
adapter: this,
collectionSlug,
versions: true,
})
const VersionsModel = this.versions[collection]
const session = await getSession(this, req)
const query = await buildQuery({
adapter: this,
fields: buildVersionCollectionFields(this.payload.config, collectionConfig, true),
fields: buildVersionCollectionFields(
this.payload.config,
this.payload.collections[collection].config,
true,
),
locale,
where,
})
await Model.deleteMany(query, { session })
await VersionsModel.deleteMany(query, { session })
}

View File

@@ -7,17 +7,15 @@ import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { buildSortParam } from './queries/buildSortParam.js'
import { aggregatePaginate } from './utilities/aggregatePaginate.js'
import { buildJoinAggregation } from './utilities/buildJoinAggregation.js'
import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { transform } from './utilities/transform.js'
export const find: Find = async function find(
this: MongooseAdapter,
{
collection: collectionSlug,
collection,
joins = {},
limit = 0,
locale,
@@ -27,10 +25,11 @@ export const find: Find = async function find(
req,
select,
sort: sortArg,
where = {},
where,
},
) {
const { collectionConfig, Model } = getCollection({ adapter: this, collectionSlug })
const Model = this.collections[collection]
const collectionConfig = this.payload.collections[collection].config
const session = await getSession(this, req)
@@ -54,8 +53,8 @@ export const find: Find = async function find(
const query = await buildQuery({
adapter: this,
collectionSlug,
fields: collectionConfig.flattenedFields,
collectionSlug: collection,
fields: this.payload.collections[collection].config.flattenedFields,
locale,
where,
})
@@ -109,8 +108,7 @@ export const find: Find = async function find(
if (limit >= 0) {
paginationOptions.limit = limit
// limit must also be set here, it's ignored when pagination is false
paginationOptions.options!.limit = limit
paginationOptions.options.limit = limit
// Disable pagination if limit is 0
if (limit === 0) {
@@ -122,7 +120,7 @@ export const find: Find = async function find(
const aggregate = await buildJoinAggregation({
adapter: this,
collection: collectionSlug,
collection,
collectionConfig,
joins,
locale,
@@ -130,20 +128,7 @@ export const find: Find = async function find(
})
// build join aggregation
if (aggregate) {
result = await aggregatePaginate({
adapter: this,
collation: paginationOptions.collation,
joinAggregation: aggregate,
limit: paginationOptions.limit,
Model,
page: paginationOptions.page,
pagination: paginationOptions.pagination,
projection: paginationOptions.projection,
query,
session: paginationOptions.options?.session ?? undefined,
sort: paginationOptions.sort as object,
useEstimatedCount: paginationOptions.useEstimatedCount,
})
result = await Model.aggregatePaginate(Model.aggregate(aggregate), paginationOptions)
} else {
result = await Model.paginate(query, paginationOptions)
}
@@ -151,7 +136,7 @@ export const find: Find = async function find(
transform({
adapter: this,
data: result.docs,
fields: collectionConfig.fields,
fields: this.payload.collections[collection].config.fields,
operation: 'read',
})

View File

@@ -7,16 +7,15 @@ import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
import { getGlobal } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { transform } from './utilities/transform.js'
export const findGlobal: FindGlobal = async function findGlobal(
this: MongooseAdapter,
{ slug: globalSlug, locale, req, select, where = {} },
{ slug, locale, req, select, where },
) {
const { globalConfig, Model } = getGlobal({ adapter: this, globalSlug })
const Model = this.globals
const globalConfig = this.payload.globals.config.find((each) => each.slug === slug)
const fields = globalConfig.flattenedFields
const options: QueryOptions = {
lean: true,
@@ -31,12 +30,12 @@ export const findGlobal: FindGlobal = async function findGlobal(
const query = await buildQuery({
adapter: this,
fields,
globalSlug,
globalSlug: slug,
locale,
where: combineQueries({ globalType: { equals: globalSlug } }, where),
where: combineQueries({ globalType: { equals: slug } }, where),
})
const doc: any = await Model.findOne(query, {}, options)
const doc = (await Model.findOne(query, {}, options)) as any
if (!doc) {
return null

View File

@@ -1,34 +1,22 @@
import type { PaginateOptions, QueryOptions } from 'mongoose'
import type { FindGlobalVersions } from 'payload'
import { APIError, buildVersionGlobalFields, flattenWhereToOperators } from 'payload'
import { buildVersionGlobalFields, flattenWhereToOperators } from 'payload'
import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { buildSortParam } from './queries/buildSortParam.js'
import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
import { getGlobal } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { transform } from './utilities/transform.js'
export const findGlobalVersions: FindGlobalVersions = async function findGlobalVersions(
this: MongooseAdapter,
{
global: globalSlug,
limit,
locale,
page,
pagination,
req,
select,
skip,
sort: sortArg,
where = {},
},
{ global, limit, locale, page, pagination, req, select, skip, sort: sortArg, where },
) {
const { globalConfig, Model } = getGlobal({ adapter: this, globalSlug, versions: true })
const globalConfig = this.payload.globals.config.find(({ slug }) => slug === global)
const Model = this.versions[global]
const versionFields = buildVersionGlobalFields(this.payload.config, globalConfig, true)
const session = await getSession(this, req)
@@ -100,11 +88,10 @@ export const findGlobalVersions: FindGlobalVersions = async function findGlobalV
}
}
if (limit && limit >= 0) {
if (limit >= 0) {
paginationOptions.limit = limit
// limit must also be set here, it's ignored when pagination is false
paginationOptions.options!.limit = limit
paginationOptions.options.limit = limit
// Disable pagination if limit is 0
if (limit === 0) {

View File

@@ -1,23 +1,20 @@
import type { AggregateOptions, QueryOptions } from 'mongoose'
import { type FindOne } from 'payload'
import type { FindOne } from 'payload'
import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { aggregatePaginate } from './utilities/aggregatePaginate.js'
import { buildJoinAggregation } from './utilities/buildJoinAggregation.js'
import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { transform } from './utilities/transform.js'
export const findOne: FindOne = async function findOne(
this: MongooseAdapter,
{ collection: collectionSlug, joins, locale, req, select, where = {} },
{ collection, joins, locale, req, select, where },
) {
const { collectionConfig, Model } = getCollection({ adapter: this, collectionSlug })
const Model = this.collections[collection]
const collectionConfig = this.payload.collections[collection].config
const session = await getSession(this, req)
const options: AggregateOptions & QueryOptions = {
lean: true,
@@ -26,7 +23,7 @@ export const findOne: FindOne = async function findOne(
const query = await buildQuery({
adapter: this,
collectionSlug,
collectionSlug: collection,
fields: collectionConfig.flattenedFields,
locale,
where,
@@ -40,9 +37,10 @@ export const findOne: FindOne = async function findOne(
const aggregate = await buildJoinAggregation({
adapter: this,
collection: collectionSlug,
collection,
collectionConfig,
joins,
limit: 1,
locale,
projection,
query,
@@ -50,17 +48,7 @@ export const findOne: FindOne = async function findOne(
let doc
if (aggregate) {
const { docs } = await aggregatePaginate({
adapter: this,
joinAggregation: aggregate,
limit: 1,
Model,
pagination: false,
projection,
query,
session,
})
doc = docs[0]
;[doc] = await Model.aggregate(aggregate, { session })
} else {
;(options as Record<string, unknown>).projection = projection
doc = await Model.findOne(query, {}, options)

View File

@@ -8,31 +8,15 @@ import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { buildSortParam } from './queries/buildSortParam.js'
import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { transform } from './utilities/transform.js'
export const findVersions: FindVersions = async function findVersions(
this: MongooseAdapter,
{
collection: collectionSlug,
limit,
locale,
page,
pagination,
req = {},
select,
skip,
sort: sortArg,
where = {},
},
{ collection, limit, locale, page, pagination, req = {}, select, skip, sort: sortArg, where },
) {
const { collectionConfig, Model } = getCollection({
adapter: this,
collectionSlug,
versions: true,
})
const Model = this.versions[collection]
const collectionConfig = this.payload.collections[collection].config
const session = await getSession(this, req)
const options: QueryOptions = {
limit,
@@ -108,11 +92,10 @@ export const findVersions: FindVersions = async function findVersions(
}
}
if (limit && limit >= 0) {
if (limit >= 0) {
paginationOptions.limit = limit
// limit must also be set here, it's ignored when pagination is false
paginationOptions.options!.limit = limit
paginationOptions.options.limit = limit
// Disable pagination if limit is 0
if (limit === 0) {

View File

@@ -11,7 +11,6 @@ import type {
BaseDatabaseAdapter,
CollectionSlug,
DatabaseAdapterObj,
Migration,
Payload,
TypeWithID,
TypeWithVersion,
@@ -63,13 +62,6 @@ import { upsert } from './upsert.js'
export type { MigrateDownArgs, MigrateUpArgs } from './types.js'
export interface Args {
/**
* By default, Payload strips all additional keys from MongoDB data that don't exist
* in the Payload schema. If you have some data that you want to include to the result
* but it doesn't exist in Payload, you can enable this flag
* @default false
*/
allowAdditionalKeys?: boolean
/** Set to false to disable auto-pluralization of collection names, Defaults to true */
autoPluralization?: boolean
/**
@@ -96,15 +88,11 @@ export interface Args {
* Defaults to disabled.
*/
collation?: Omit<CollationOptions, 'locale'>
collectionsSchemaOptions?: Partial<Record<CollectionSlug, SchemaOptions>>
/** Extra configuration options */
connectOptions?: {
/**
* Set false to disable $facet aggregation in non-supporting databases, Defaults to true
* @deprecated Payload doesn't use `$facet` anymore anywhere.
*/
/** Set false to disable $facet aggregation in non-supporting databases, Defaults to true */
useFacet?: boolean
} & ConnectOptions
/** Set to true to disable hinting to MongoDB to use 'id' as index. This is currently done when counting documents for pagination. Disabling this optimization might fix some problems with AWS DocumentDB. Defaults to false */
@@ -119,7 +107,11 @@ export interface Args {
* typed as any to avoid dependency
*/
mongoMemoryServer?: MongoMemoryReplSet
prodMigrations?: Migration[]
prodMigrations?: {
down: (args: MigrateDownArgs) => Promise<void>
name: string
up: (args: MigrateUpArgs) => Promise<void>
}[]
transactionOptions?: false | TransactionOptions
/** The URL to connect to MongoDB or false to start payload and prevent connecting */
@@ -182,12 +174,11 @@ declare module 'payload' {
}
export function mongooseAdapter({
allowAdditionalKeys = false,
autoPluralization = true,
collectionsSchemaOptions = {},
connectOptions,
disableIndexHints = false,
ensureIndexes = false,
ensureIndexes,
migrationDir: migrationDirArg,
mongoMemoryServer,
prodMigrations,
@@ -204,14 +195,11 @@ export function mongooseAdapter({
// Mongoose-specific
autoPluralization,
collections: {},
// @ts-expect-error initialize without a connection
connection: undefined,
connectOptions: connectOptions || {},
disableIndexHints,
ensureIndexes,
// @ts-expect-error don't have globals model yet
globals: undefined,
// @ts-expect-error Should not be required
mongoMemoryServer,
sessions: {},
transactionOptions: transactionOptions === false ? undefined : transactionOptions,
@@ -219,7 +207,6 @@ export function mongooseAdapter({
url,
versions: {},
// DatabaseAdapter
allowAdditionalKeys,
beginTransaction: transactionOptions === false ? defaultBeginTransaction() : beginTransaction,
collectionsSchemaOptions,
commitTransaction,

View File

@@ -2,15 +2,12 @@ import type { PaginateOptions } from 'mongoose'
import type { Init, SanitizedCollectionConfig } from 'payload'
import mongoose from 'mongoose'
import mongooseAggregatePaginate from 'mongoose-aggregate-paginate-v2'
import paginate from 'mongoose-paginate-v2'
import {
buildVersionCollectionFields,
buildVersionCompoundIndexes,
buildVersionGlobalFields,
} from 'payload'
import { buildVersionCollectionFields, buildVersionGlobalFields } from 'payload'
import type { MongooseAdapter } from './index.js'
import type { CollectionModel, GlobalModel } from './types.js'
import type { CollectionModel } from './types.js'
import { buildCollectionSchema } from './models/buildCollectionSchema.js'
import { buildGlobalModel } from './models/buildGlobalModel.js'
@@ -20,7 +17,7 @@ import { getDBName } from './utilities/getDBName.js'
export const init: Init = function init(this: MongooseAdapter) {
this.payload.config.collections.forEach((collection: SanitizedCollectionConfig) => {
const schemaOptions = this.collectionsSchemaOptions?.[collection.slug]
const schemaOptions = this.collectionsSchemaOptions[collection.slug]
const schema = buildCollectionSchema(collection, this.payload, schemaOptions)
@@ -40,7 +37,6 @@ export const init: Init = function init(this: MongooseAdapter) {
},
...schemaOptions,
},
compoundIndexes: buildVersionCompoundIndexes({ indexes: collection.sanitizedIndexes }),
configFields: versionCollectionFields,
payload: this.payload,
})
@@ -52,6 +48,10 @@ export const init: Init = function init(this: MongooseAdapter) {
}),
)
if (Object.keys(collection.joins).length > 0) {
versionSchema.plugin(mongooseAggregatePaginate)
}
const versionCollectionName =
this.autoPluralization === true && !collection.dbName ? undefined : versionModelName
@@ -59,21 +59,21 @@ export const init: Init = function init(this: MongooseAdapter) {
versionModelName,
versionSchema,
versionCollectionName,
) as unknown as CollectionModel
) as CollectionModel
}
const modelName = getDBName({ config: collection })
const collectionName =
this.autoPluralization === true && !collection.dbName ? undefined : modelName
this.collections[collection.slug] = mongoose.model<any>(
this.collections[collection.slug] = mongoose.model(
modelName,
schema,
collectionName,
) as CollectionModel
})
this.globals = buildGlobalModel(this.payload) as GlobalModel
this.globals = buildGlobalModel(this.payload)
this.payload.config.globals.forEach((global) => {
if (global.versions) {
@@ -101,7 +101,7 @@ export const init: Init = function init(this: MongooseAdapter) {
}),
)
this.versions[global.slug] = mongoose.model<any>(
this.versions[global.slug] = mongoose.model(
versionModelName,
versionSchema,
versionModelName,

View File

@@ -1,3 +1,5 @@
import type { PayloadRequest } from 'payload'
import { commitTransaction, initTransaction, killTransaction, readMigrationFiles } from 'payload'
import prompts from 'prompts'

View File

@@ -1,6 +1,7 @@
import type { PaginateOptions, Schema } from 'mongoose'
import type { Payload, SanitizedCollectionConfig } from 'payload'
import mongooseAggregatePaginate from 'mongoose-aggregate-paginate-v2'
import paginate from 'mongoose-paginate-v2'
import { getBuildQueryPlugin } from '../queries/getBuildQueryPlugin.js'
@@ -23,13 +24,12 @@ export const buildCollectionSchema = (
...schemaOptions,
},
},
compoundIndexes: collection.sanitizedIndexes,
configFields: collection.fields,
payload,
})
if (Array.isArray(collection.upload.filenameCompoundIndex)) {
const indexDefinition = collection.upload.filenameCompoundIndex.reduce<Record<string, 1>>(
const indexDefinition: Record<string, 1> = collection.upload.filenameCompoundIndex.reduce(
(acc, index) => {
acc[index] = 1
return acc
@@ -44,5 +44,12 @@ export const buildCollectionSchema = (
.plugin<any, PaginateOptions>(paginate, { useEstimatedCount: true })
.plugin(getBuildQueryPlugin({ collectionSlug: collection.slug }))
if (
Object.keys(collection.joins).length > 0 ||
Object.keys(collection.polymorphicJoins).length > 0
) {
schema.plugin(mongooseAggregatePaginate)
}
return schema
}

File diff suppressed because it is too large Load Diff

View File

@@ -1,16 +1,16 @@
import type { ClientSession, Model } from 'mongoose'
import type { Field, PayloadRequest } from 'payload'
import type { Field, PayloadRequest, SanitizedConfig } from 'payload'
import { buildVersionCollectionFields, buildVersionGlobalFields } from 'payload'
import type { MongooseAdapter } from '../index.js'
import { getCollection, getGlobal } from '../utilities/getEntity.js'
import { getSession } from '../utilities/getSession.js'
import { transform } from '../utilities/transform.js'
const migrateModelWithBatching = async ({
batchSize,
config,
db,
fields,
Model,
@@ -18,11 +18,12 @@ const migrateModelWithBatching = async ({
session,
}: {
batchSize: number
config: SanitizedConfig
db: MongooseAdapter
fields: Field[]
Model: Model<any>
parentIsLocalized: boolean
session?: ClientSession
session: ClientSession
}): Promise<void> => {
let hasNext = true
let skip = 0
@@ -54,7 +55,6 @@ const migrateModelWithBatching = async ({
}
await Model.collection.bulkWrite(
// @ts-expect-error bulkWrite has a weird type, insertOne, updateMany etc are required here as well.
docs.map((doc) => ({
updateOne: {
filter: { _id: doc._id },
@@ -123,13 +123,12 @@ export async function migrateRelationshipsV2_V3({
if (hasRelationshipOrUploadField(collection)) {
payload.logger.info(`Migrating collection "${collection.slug}"`)
const { Model } = getCollection({ adapter: db, collectionSlug: collection.slug })
await migrateModelWithBatching({
batchSize,
config,
db,
fields: collection.fields,
Model,
Model: db.collections[collection.slug],
parentIsLocalized: false,
session,
})
@@ -140,17 +139,12 @@ export async function migrateRelationshipsV2_V3({
if (collection.versions) {
payload.logger.info(`Migrating collection versions "${collection.slug}"`)
const { Model } = getCollection({
adapter: db,
collectionSlug: collection.slug,
versions: true,
})
await migrateModelWithBatching({
batchSize,
config,
db,
fields: buildVersionCollectionFields(config, collection),
Model,
Model: db.versions[collection.slug],
parentIsLocalized: false,
session,
})
@@ -199,13 +193,12 @@ export async function migrateRelationshipsV2_V3({
if (global.versions) {
payload.logger.info(`Migrating global versions "${global.slug}"`)
const { Model } = getGlobal({ adapter: db, globalSlug: global.slug, versions: true })
await migrateModelWithBatching({
batchSize,
config,
db,
fields: buildVersionGlobalFields(config, global),
Model,
Model: db.versions[global.slug],
parentIsLocalized: false,
session,
})

View File

@@ -3,20 +3,18 @@ import type { Payload, PayloadRequest } from 'payload'
import type { MongooseAdapter } from '../index.js'
import { getCollection, getGlobal } from '../utilities/getEntity.js'
import { getSession } from '../utilities/getSession.js'
export async function migrateVersionsV1_V2({ req }: { req: PayloadRequest }) {
const { payload } = req
const adapter = payload.db as MongooseAdapter
const session = await getSession(adapter, req)
const session = await getSession(payload.db as MongooseAdapter, req)
// For each collection
for (const { slug, versions } of payload.config.collections) {
if (versions?.drafts) {
await migrateCollectionDocs({ slug, adapter, payload, session })
await migrateCollectionDocs({ slug, payload, session })
payload.logger.info(`Migrated the "${slug}" collection.`)
}
@@ -25,13 +23,9 @@ export async function migrateVersionsV1_V2({ req }: { req: PayloadRequest }) {
// For each global
for (const { slug, versions } of payload.config.globals) {
if (versions) {
const { Model } = getGlobal({
adapter,
globalSlug: slug,
versions: true,
})
const VersionsModel = payload.db.versions[slug]
await Model.findOneAndUpdate(
await VersionsModel.findOneAndUpdate(
{},
{ latest: true },
{
@@ -47,23 +41,17 @@ export async function migrateVersionsV1_V2({ req }: { req: PayloadRequest }) {
async function migrateCollectionDocs({
slug,
adapter,
docsAtATime = 100,
payload,
session,
}: {
adapter: MongooseAdapter
docsAtATime?: number
payload: Payload
session?: ClientSession
session: ClientSession
slug: string
}) {
const { Model } = getCollection({
adapter,
collectionSlug: slug,
versions: true,
})
const remainingDocs = await Model.aggregate(
const VersionsModel = payload.db.versions[slug]
const remainingDocs = await VersionsModel.aggregate(
[
// Sort so that newest are first
{
@@ -99,7 +87,7 @@ async function migrateCollectionDocs({
).exec()
if (!remainingDocs || remainingDocs.length === 0) {
const newVersions = await Model.find(
const newVersions = await VersionsModel.find(
{
latest: {
$eq: true,
@@ -120,7 +108,7 @@ async function migrateCollectionDocs({
const remainingDocIDs = remainingDocs.map((doc) => doc._versionID)
await Model.updateMany(
await VersionsModel.updateMany(
{
_id: {
$in: remainingDocIDs,
@@ -134,5 +122,5 @@ async function migrateCollectionDocs({
},
)
await migrateCollectionDocs({ slug, adapter, payload, session })
await migrateCollectionDocs({ slug, payload, session })
}

View File

@@ -1,14 +1,11 @@
import type { FilterQuery } from 'mongoose'
import type { FlattenedField, Operator, PathToQuery, Payload } from 'payload'
import { Types } from 'mongoose'
import { APIError, getLocalizedPaths } from 'payload'
import { getLocalizedPaths } from 'payload'
import { validOperatorSet } from 'payload/shared'
import type { MongooseAdapter } from '../index.js'
import type { OperatorMapKey } from './operatorMap.js'
import { getCollection } from '../utilities/getEntity.js'
import { operatorMap } from './operatorMap.js'
import { sanitizeQueryValue } from './sanitizeQueryValue.js'
@@ -46,7 +43,7 @@ export async function buildSearchParam({
parentIsLocalized: boolean
payload: Payload
val: unknown
}): Promise<SearchParam | undefined> {
}): Promise<SearchParam> {
// Replace GraphQL nested field double underscore formatting
let sanitizedPath = incomingPath.replace(/__/g, '.')
if (sanitizedPath === 'id') {
@@ -58,9 +55,7 @@ export async function buildSearchParam({
let hasCustomID = false
if (sanitizedPath === '_id') {
const customIDFieldType = collectionSlug
? payload.collections[collectionSlug]?.customIDType
: undefined
const customIDFieldType = payload.collections[collectionSlug]?.customIDType
let idFieldType: 'number' | 'text' = 'text'
@@ -76,7 +71,7 @@ export async function buildSearchParam({
name: 'id',
type: idFieldType,
} as FlattenedField,
parentIsLocalized: parentIsLocalized ?? false,
parentIsLocalized,
path: '_id',
})
} else {
@@ -91,10 +86,6 @@ export async function buildSearchParam({
})
}
if (!paths[0]) {
return undefined
}
const [{ field, path }] = paths
if (path) {
const sanitizedQueryValue = sanitizeQueryValue({
@@ -118,10 +109,6 @@ export async function buildSearchParam({
return { value: rawQuery }
}
if (!formattedOperator) {
return undefined
}
// If there are multiple collections to search through,
// Recursively build up a list of query constraints
if (paths.length > 1) {
@@ -129,86 +116,84 @@ export async function buildSearchParam({
// to work backwards from top
const pathsToQuery = paths.slice(1).reverse()
let relationshipQuery: SearchParam = {
const initialRelationshipQuery = {
value: {},
}
} as SearchParam
for (const [i, { collectionSlug, path: subPath }] of pathsToQuery.entries()) {
if (!collectionSlug) {
throw new APIError(`Collection with the slug ${collectionSlug} was not found.`)
}
const relationshipQuery = await pathsToQuery.reduce(
async (priorQuery, { collectionSlug: slug, path: subPath }, i) => {
const priorQueryResult = await priorQuery
const { Model: SubModel } = getCollection({
adapter: payload.db as MongooseAdapter,
collectionSlug,
})
const SubModel = (payload.db as MongooseAdapter).collections[slug]
if (i === 0) {
const subQuery = await SubModel.buildQuery({
locale,
payload,
where: {
[subPath]: {
[formattedOperator]: val,
// On the "deepest" collection,
// Search on the value passed through the query
if (i === 0) {
const subQuery = await SubModel.buildQuery({
locale,
payload,
where: {
[subPath]: {
[formattedOperator]: val,
},
},
},
})
})
const result = await SubModel.find(subQuery, subQueryOptions)
const $in: unknown[] = []
result.forEach((doc) => {
const stringID = doc._id.toString()
$in.push(stringID)
if (Types.ObjectId.isValid(stringID)) {
$in.push(doc._id)
}
})
if (pathsToQuery.length === 1) {
return {
path,
value: { $in },
}
}
const nextSubPath = pathsToQuery[i + 1].path
return {
value: { [nextSubPath]: { $in } },
}
}
const subQuery = priorQueryResult.value
const result = await SubModel.find(subQuery, subQueryOptions)
const $in: unknown[] = []
const $in = result.map((doc) => doc._id)
result.forEach((doc) => {
const stringID = doc._id.toString()
$in.push(stringID)
if (Types.ObjectId.isValid(stringID)) {
$in.push(doc._id)
}
})
if (pathsToQuery.length === 1) {
// If it is the last recursion
// then pass through the search param
if (i + 1 === pathsToQuery.length) {
return {
path,
value: { $in },
}
}
const nextSubPath = pathsToQuery[i + 1]?.path
if (nextSubPath) {
relationshipQuery = { value: { [nextSubPath]: $in } }
}
continue
}
const subQuery = relationshipQuery.value as FilterQuery<any>
const result = await SubModel.find(subQuery, subQueryOptions)
const $in = result.map((doc) => doc._id)
// If it is the last recursion
// then pass through the search param
if (i + 1 === pathsToQuery.length) {
relationshipQuery = {
path,
value: { $in },
}
} else {
relationshipQuery = {
return {
value: {
_id: { $in },
},
}
}
}
},
Promise.resolve(initialRelationshipQuery),
)
return relationshipQuery
}
if (formattedOperator && validOperatorSet.has(formattedOperator as Operator)) {
const operatorKey = operatorMap[formattedOperator as OperatorMapKey]
const operatorKey = operatorMap[formattedOperator]
if (field.type === 'relationship' || field.type === 'upload') {
let hasNumberIDRelation
@@ -225,7 +210,7 @@ export async function buildSearchParam({
if (typeof formattedValue === 'string') {
if (Types.ObjectId.isValid(formattedValue)) {
result.value[multiIDCondition]?.push({
result.value[multiIDCondition].push({
[path]: { [operatorKey]: new Types.ObjectId(formattedValue) },
})
} else {
@@ -241,16 +226,14 @@ export async function buildSearchParam({
)
if (hasNumberIDRelation) {
result.value[multiIDCondition]?.push({
result.value[multiIDCondition].push({
[path]: { [operatorKey]: parseFloat(formattedValue) },
})
}
}
}
const length = result.value[multiIDCondition]?.length
if (typeof length === 'number' && length > 1) {
if (result.value[multiIDCondition].length > 1) {
return result
}
}

View File

@@ -1,3 +1,4 @@
import type { PaginateOptions } from 'mongoose'
import type { FlattenedField, SanitizedConfig, Sort } from 'payload'
import { getLocalizedSortProperty } from './getLocalizedSortProperty.js'
@@ -5,7 +6,7 @@ import { getLocalizedSortProperty } from './getLocalizedSortProperty.js'
type Args = {
config: SanitizedConfig
fields: FlattenedField[]
locale?: string
locale: string
parentIsLocalized?: boolean
sort: Sort
timestamps: boolean
@@ -22,10 +23,10 @@ export const buildSortParam = ({
config,
fields,
locale,
parentIsLocalized = false,
parentIsLocalized,
sort,
timestamps,
}: Args): Record<string, string> => {
}: Args): PaginateOptions['sort'] => {
if (!sort) {
if (timestamps) {
sort = '-createdAt'
@@ -38,7 +39,7 @@ export const buildSortParam = ({
sort = [sort]
}
const sorting = sort.reduce<Record<string, string>>((acc, item) => {
const sorting = sort.reduce<PaginateOptions['sort']>((acc, item) => {
let sortProperty: string
let sortDirection: SortDirection
if (item.indexOf('-') === 0) {

View File

@@ -1,6 +1,6 @@
import type { FlattenedField, Payload, Where } from 'payload'
import { APIError } from 'payload'
import { QueryError } from 'payload'
import { parseParams } from './parseParams.js'
@@ -23,7 +23,7 @@ export const getBuildQueryPlugin = ({
collectionSlug,
versionsFields,
}: GetBuildQueryPluginArgs = {}) => {
return function buildQueryPlugin(schema: any) {
return function buildQueryPlugin(schema) {
const modifiedSchema = schema
async function schemaBuildQuery({
globalSlug,
@@ -31,35 +31,19 @@ export const getBuildQueryPlugin = ({
payload,
where,
}: BuildQueryArgs): Promise<Record<string, unknown>> {
let fields: FlattenedField[] | null = null
if (versionsFields) {
fields = versionsFields
} else {
let fields = versionsFields
if (!fields) {
if (globalSlug) {
const globalConfig = payload.globals.config.find(({ slug }) => slug === globalSlug)
if (!globalConfig) {
throw new APIError(`Global with the slug ${globalSlug} was not found`)
}
fields = globalConfig.flattenedFields
}
if (collectionSlug) {
const collectionConfig = payload.collections[collectionSlug]?.config
if (!collectionConfig) {
throw new APIError(`Collection with the slug ${globalSlug} was not found`)
}
const collectionConfig = payload.collections[collectionSlug].config
fields = collectionConfig.flattenedFields
}
}
if (fields === null) {
throw new APIError('Fields are not initialized.')
}
const errors = []
const result = await parseParams({
collectionSlug,
fields,
@@ -70,6 +54,10 @@ export const getBuildQueryPlugin = ({
where,
})
if (errors.length > 0) {
throw new QueryError(errors)
}
return result
}
modifiedSchema.statics.buildQuery = schemaBuildQuery

View File

@@ -19,7 +19,6 @@ describe('get localized sort property', () => {
it('passes through a non-localized sort property', () => {
const result = getLocalizedSortProperty({
config,
parentIsLocalized: false,
fields: [
{
name: 'title',
@@ -36,7 +35,6 @@ describe('get localized sort property', () => {
it('properly localizes an un-localized sort property', () => {
const result = getLocalizedSortProperty({
config,
parentIsLocalized: false,
fields: [
{
name: 'title',
@@ -54,7 +52,6 @@ describe('get localized sort property', () => {
it('keeps specifically asked-for localized sort properties', () => {
const result = getLocalizedSortProperty({
config,
parentIsLocalized: false,
fields: [
{
name: 'title',
@@ -72,7 +69,6 @@ describe('get localized sort property', () => {
it('properly localizes nested sort properties', () => {
const result = getLocalizedSortProperty({
config,
parentIsLocalized: false,
fields: flattenAllFields({
fields: [
{
@@ -98,7 +94,6 @@ describe('get localized sort property', () => {
it('keeps requested locale with nested sort properties', () => {
const result = getLocalizedSortProperty({
config,
parentIsLocalized: false,
fields: flattenAllFields({
fields: [
{
@@ -124,7 +119,6 @@ describe('get localized sort property', () => {
it('properly localizes field within row', () => {
const result = getLocalizedSortProperty({
config,
parentIsLocalized: false,
fields: flattenAllFields({
fields: [
{
@@ -149,7 +143,6 @@ describe('get localized sort property', () => {
it('properly localizes field within named tab', () => {
const result = getLocalizedSortProperty({
config,
parentIsLocalized: false,
fields: flattenAllFields({
fields: [
{
@@ -179,7 +172,6 @@ describe('get localized sort property', () => {
it('properly localizes field within unnamed tab', () => {
const result = getLocalizedSortProperty({
config,
parentIsLocalized: false,
fields: flattenAllFields({
fields: [
{

View File

@@ -5,7 +5,7 @@ import { fieldAffectsData, fieldIsPresentationalOnly, fieldShouldBeLocalized } f
type Args = {
config: SanitizedConfig
fields: FlattenedField[]
locale?: string
locale: string
parentIsLocalized: boolean
result?: string
segments: string[]
@@ -36,16 +36,14 @@ export const getLocalizedSortProperty = ({
)
if (matchedField && !fieldIsPresentationalOnly(matchedField)) {
let nextFields: FlattenedField[] | null = null
let nextFields: FlattenedField[]
let nextParentIsLocalized = parentIsLocalized
const remainingSegments = [...segments]
let localizedSegment = matchedField.name
if (
fieldShouldBeLocalized({ field: matchedField, parentIsLocalized: parentIsLocalized ?? false })
) {
if (fieldShouldBeLocalized({ field: matchedField, parentIsLocalized })) {
// Check to see if next segment is a locale
if (segments.length > 0 && remainingSegments[0]) {
if (segments.length > 0) {
const nextSegmentIsLocale = config.localization.localeCodes.includes(remainingSegments[0])
// If next segment is locale, remove it from remaining segments
@@ -68,21 +66,16 @@ export const getLocalizedSortProperty = ({
) {
nextFields = matchedField.flattenedFields
if (!nextParentIsLocalized) {
nextParentIsLocalized = matchedField.localized ?? false
nextParentIsLocalized = matchedField.localized
}
}
if (matchedField.type === 'blocks') {
nextFields = (matchedField.blockReferences ?? matchedField.blocks).reduce<FlattenedField[]>(
nextFields = (matchedField.blockReferences ?? matchedField.blocks).reduce(
(flattenedBlockFields, _block) => {
// TODO: iterate over blocks mapped to block slug in v4, or pass through payload.blocks
const block =
typeof _block === 'string' ? config.blocks?.find((b) => b.slug === _block) : _block
if (!block) {
return [...flattenedBlockFields]
}
typeof _block === 'string' ? config.blocks.find((b) => b.slug === _block) : _block
return [
...flattenedBlockFields,
...block.flattenedFields.filter(
@@ -100,7 +93,7 @@ export const getLocalizedSortProperty = ({
const result = incomingResult ? `${incomingResult}.${localizedSegment}` : localizedSegment
if (nextFields !== null) {
if (nextFields) {
return getLocalizedSortProperty({
config,
fields: nextFields,

View File

@@ -1,5 +1,3 @@
export type OperatorMapKey = keyof typeof operatorMap
export const operatorMap = {
all: '$all',
equals: '$eq',

View File

@@ -19,7 +19,7 @@ export async function parseParams({
collectionSlug?: string
fields: FlattenedField[]
globalSlug?: string
locale?: string
locale: string
parentIsLocalized: boolean
payload: Payload
where: Where
@@ -30,7 +30,7 @@ export async function parseParams({
// We need to determine if the whereKey is an AND, OR, or a schema path
for (const relationOrPath of Object.keys(where)) {
const condition = where[relationOrPath]
let conditionOperator: '$and' | '$or' | null = null
let conditionOperator: '$and' | '$or'
if (relationOrPath.toLowerCase() === 'and') {
conditionOperator = '$and'
} else if (relationOrPath.toLowerCase() === 'or') {
@@ -46,7 +46,7 @@ export async function parseParams({
payload,
where: condition,
})
if (builtConditions.length > 0 && conditionOperator !== null) {
if (builtConditions.length > 0) {
result[conditionOperator] = builtConditions
}
} else {
@@ -58,7 +58,6 @@ export async function parseParams({
const validOperators = Object.keys(pathOperators).filter((operator) =>
validOperatorSet.has(operator as Operator),
)
for (const operator of validOperators) {
const searchParam = await buildSearchParam({
collectionSlug,
@@ -69,7 +68,7 @@ export async function parseParams({
operator,
parentIsLocalized,
payload,
val: (pathOperators as Record<string, Where>)[operator],
val: pathOperators[operator],
})
if (searchParam?.value && searchParam?.path) {
@@ -84,7 +83,7 @@ export async function parseParams({
result[searchParam.path] = searchParam.value
}
} else if (typeof searchParam?.value === 'object') {
result = deepMergeWithCombinedArrays(result, searchParam.value ?? {}, {
result = deepMergeWithCombinedArrays(result, searchParam.value, {
// dont clone Types.ObjectIDs
clone: false,
})

View File

@@ -21,7 +21,7 @@ type SanitizeQueryValueArgs = {
val: any
}
const buildExistsQuery = (formattedValue: unknown, path: string, treatEmptyString = true) => {
const buildExistsQuery = (formattedValue, path, treatEmptyString = true) => {
if (formattedValue) {
return {
rawQuery: {
@@ -54,17 +54,14 @@ const getFieldFromSegments = ({
field: FlattenedBlock | FlattenedField
payload: Payload
segments: string[]
}): FlattenedField | undefined => {
}) => {
if ('blocks' in field || 'blockReferences' in field) {
const _field: FlattenedBlocksField = field as FlattenedBlocksField
for (const _block of _field.blockReferences ?? _field.blocks) {
const block: FlattenedBlock | undefined =
typeof _block === 'string' ? payload.blocks[_block] : _block
if (block) {
const field = getFieldFromSegments({ field: block, payload, segments })
if (field) {
return field
}
const block: FlattenedBlock = typeof _block === 'string' ? payload.blocks[_block] : _block
const field = getFieldFromSegments({ field: block, payload, segments })
if (field) {
return field
}
}
}
@@ -96,13 +93,11 @@ export const sanitizeQueryValue = ({
path,
payload,
val,
}: SanitizeQueryValueArgs):
| {
operator?: string
rawQuery?: unknown
val?: unknown
}
| undefined => {
}: SanitizeQueryValueArgs): {
operator?: string
rawQuery?: unknown
val?: unknown
} => {
let formattedValue = val
let formattedOperator = operator
if (['array', 'blocks', 'group', 'tab'].includes(field.type) && path.includes('.')) {
@@ -146,26 +141,24 @@ export const sanitizeQueryValue = ({
formattedValue = createArrayFromCommaDelineated(val)
}
if (Array.isArray(formattedValue)) {
formattedValue = formattedValue.reduce<unknown[]>((formattedValues, inVal) => {
if (!hasCustomID) {
if (Types.ObjectId.isValid(inVal)) {
formattedValues.push(new Types.ObjectId(inVal))
}
formattedValue = formattedValue.reduce((formattedValues, inVal) => {
if (!hasCustomID) {
if (Types.ObjectId.isValid(inVal)) {
formattedValues.push(new Types.ObjectId(inVal))
}
}
if (field.type === 'number') {
const parsedNumber = parseFloat(inVal)
if (!Number.isNaN(parsedNumber)) {
formattedValues.push(parsedNumber)
}
} else {
formattedValues.push(inVal)
if (field.type === 'number') {
const parsedNumber = parseFloat(inVal)
if (!Number.isNaN(parsedNumber)) {
formattedValues.push(parsedNumber)
}
} else {
formattedValues.push(inVal)
}
return formattedValues
}, [])
}
return formattedValues
}, [])
}
}
@@ -182,7 +175,7 @@ export const sanitizeQueryValue = ({
if (['all', 'in', 'not_in'].includes(operator) && typeof formattedValue === 'string') {
formattedValue = createArrayFromCommaDelineated(formattedValue)
if (field.type === 'number' && Array.isArray(formattedValue)) {
if (field.type === 'number') {
formattedValue = formattedValue.map((arrayVal) => parseFloat(arrayVal))
}
}
@@ -271,7 +264,7 @@ export const sanitizeQueryValue = ({
return formattedValues
}
if (typeof relationTo === 'string' && payload.collections[relationTo]?.customIDType) {
if (typeof relationTo === 'string' && payload.collections[relationTo].customIDType) {
if (payload.collections[relationTo].customIDType === 'number') {
const parsedNumber = parseFloat(inVal)
if (!Number.isNaN(parsedNumber)) {
@@ -286,7 +279,7 @@ export const sanitizeQueryValue = ({
if (
Array.isArray(relationTo) &&
relationTo.some((relationTo) => !!payload.collections[relationTo]?.customIDType)
relationTo.some((relationTo) => !!payload.collections[relationTo].customIDType)
) {
if (Types.ObjectId.isValid(inVal.toString())) {
formattedValues.push(new Types.ObjectId(inVal))
@@ -309,7 +302,7 @@ export const sanitizeQueryValue = ({
(!Array.isArray(relationTo) || !path.endsWith('.relationTo'))
) {
if (typeof relationTo === 'string') {
const customIDType = payload.collections[relationTo]?.customIDType
const customIDType = payload.collections[relationTo].customIDType
if (customIDType) {
if (customIDType === 'number') {
@@ -327,7 +320,7 @@ export const sanitizeQueryValue = ({
}
} else {
const hasCustomIDType = relationTo.some(
(relationTo) => !!payload.collections[relationTo]?.customIDType,
(relationTo) => !!payload.collections[relationTo].customIDType,
)
if (hasCustomIDType) {

View File

@@ -7,34 +7,17 @@ import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { buildSortParam } from './queries/buildSortParam.js'
import { aggregatePaginate } from './utilities/aggregatePaginate.js'
import { buildJoinAggregation } from './utilities/buildJoinAggregation.js'
import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { transform } from './utilities/transform.js'
export const queryDrafts: QueryDrafts = async function queryDrafts(
this: MongooseAdapter,
{
collection: collectionSlug,
joins,
limit,
locale,
page,
pagination,
req,
select,
sort: sortArg,
where = {},
},
{ collection, joins, limit, locale, page, pagination, req, select, sort: sortArg, where },
) {
const { collectionConfig, Model } = getCollection({
adapter: this,
collectionSlug,
versions: true,
})
const VersionModel = this.versions[collection]
const collectionConfig = this.payload.collections[collection].config
const options: QueryOptions = {
session: await getSession(this, req),
}
@@ -105,25 +88,24 @@ export const queryDrafts: QueryDrafts = async function queryDrafts(
// the correct indexed field
paginationOptions.useCustomCountFn = () => {
return Promise.resolve(
Model.countDocuments(versionQuery, {
VersionModel.countDocuments(versionQuery, {
hint: { _id: 1 },
}),
)
}
}
if (limit && limit > 0) {
if (limit > 0) {
paginationOptions.limit = limit
// limit must also be set here, it's ignored when pagination is false
paginationOptions.options!.limit = limit
paginationOptions.options.limit = limit
}
let result
const aggregate = await buildJoinAggregation({
adapter: this,
collection: collectionSlug,
collection,
collectionConfig,
joins,
locale,
@@ -134,22 +116,12 @@ export const queryDrafts: QueryDrafts = async function queryDrafts(
// build join aggregation
if (aggregate) {
result = await aggregatePaginate({
adapter: this,
collation: paginationOptions.collation,
joinAggregation: aggregate,
limit: paginationOptions.limit,
Model,
page: paginationOptions.page,
pagination: paginationOptions.pagination,
projection: paginationOptions.projection,
query: versionQuery,
session: paginationOptions.options?.session ?? undefined,
sort: paginationOptions.sort as object,
useEstimatedCount: paginationOptions.useEstimatedCount,
})
result = await VersionModel.aggregatePaginate(
VersionModel.aggregate(aggregate),
paginationOptions,
)
} else {
result = await Model.paginate(versionQuery, paginationOptions)
result = await VersionModel.paginate(versionQuery, paginationOptions)
}
transform({

View File

@@ -7,7 +7,6 @@ import { v4 as uuid } from 'uuid'
import type { MongooseAdapter } from '../index.js'
// Needs await to fulfill the interface
// @ts-expect-error TransactionOptions isn't compatible with BeginTransaction of the DatabaseAdapter interface.
// eslint-disable-next-line @typescript-eslint/require-await
export const beginTransaction: BeginTransaction = async function beginTransaction(
this: MongooseAdapter,
@@ -21,13 +20,12 @@ export const beginTransaction: BeginTransaction = async function beginTransactio
const id = uuid()
if (!this.sessions[id]) {
// @ts-expect-error BaseDatabaseAdapter and MongoosAdapter (that extends Base) sessions aren't compatible.
this.sessions[id] = client.startSession()
}
if (this.sessions[id]?.inTransaction()) {
if (this.sessions[id].inTransaction()) {
this.payload.logger.warn('beginTransaction called while transaction already exists')
} else {
this.sessions[id]?.startTransaction(options || (this.transactionOptions as TransactionOptions))
this.sessions[id].startTransaction(options || (this.transactionOptions as TransactionOptions))
}
return id

View File

@@ -1,11 +1,6 @@
import type { CommitTransaction } from 'payload'
import type { MongooseAdapter } from '../index.js'
export const commitTransaction: CommitTransaction = async function commitTransaction(
this: MongooseAdapter,
id,
) {
export const commitTransaction: CommitTransaction = async function commitTransaction(id) {
if (id instanceof Promise) {
return
}
@@ -17,7 +12,7 @@ export const commitTransaction: CommitTransaction = async function commitTransac
await this.sessions[id].commitTransaction()
try {
await this.sessions[id].endSession()
} catch (_) {
} catch (error) {
// ending sessions is only best effort and won't impact anything if it fails since the transaction was committed
}
delete this.sessions[id]

View File

@@ -1,9 +1,6 @@
import type { RollbackTransaction } from 'payload'
import type { MongooseAdapter } from '../index.js'
export const rollbackTransaction: RollbackTransaction = async function rollbackTransaction(
this: MongooseAdapter,
incomingID = '',
) {
let transactionID: number | string
@@ -21,7 +18,7 @@ export const rollbackTransaction: RollbackTransaction = async function rollbackT
}
// when session exists but is not inTransaction something unexpected is happening to the session
if (!this.sessions[transactionID]?.inTransaction()) {
if (!this.sessions[transactionID].inTransaction()) {
this.payload.logger.warn('rollbackTransaction called when no transaction exists')
delete this.sessions[transactionID]
return
@@ -29,8 +26,8 @@ export const rollbackTransaction: RollbackTransaction = async function rollbackT
// the first call for rollback should be aborted and deleted causing any other operations with the same transaction to fail
try {
await this.sessions[transactionID]?.abortTransaction()
await this.sessions[transactionID]?.endSession()
await this.sessions[transactionID].abortTransaction()
await this.sessions[transactionID].endSession()
} catch (error) {
// ignore the error as it is likely a race condition from multiple errors
}

View File

@@ -1,5 +1,12 @@
import type { ClientSession } from 'mongodb'
import type { IndexDefinition, IndexOptions, Model, PaginateModel, SchemaOptions } from 'mongoose'
import type {
AggregatePaginateModel,
IndexDefinition,
IndexOptions,
Model,
PaginateModel,
SchemaOptions,
} from 'mongoose'
import type {
ArrayField,
BlocksField,
@@ -30,7 +37,10 @@ import type {
import type { BuildQueryArgs } from './queries/getBuildQueryPlugin.js'
export interface CollectionModel extends Model<any>, PaginateModel<any> {
export interface CollectionModel
extends Model<any>,
PaginateModel<any>,
AggregatePaginateModel<any> {
/** buildQuery is used to transform payload's where operator into what can be used by mongoose (e.g. id => _id) */
buildQuery: (args: BuildQueryArgs) => Promise<Record<string, unknown>> // TODO: Delete this
}

View File

@@ -4,17 +4,15 @@ import type { UpdateGlobal } from 'payload'
import type { MongooseAdapter } from './index.js'
import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
import { getGlobal } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { transform } from './utilities/transform.js'
export const updateGlobal: UpdateGlobal = async function updateGlobal(
this: MongooseAdapter,
{ slug: globalSlug, data, options: optionsArgs = {}, req, returning, select },
{ slug, data, options: optionsArgs = {}, req, returning, select },
) {
const { globalConfig, Model } = getGlobal({ adapter: this, globalSlug })
const fields = globalConfig.fields
const Model = this.globals
const fields = this.payload.config.globals.find((global) => global.slug === slug).fields
const options: MongooseUpdateQueryOptions = {
...optionsArgs,
@@ -22,22 +20,22 @@ export const updateGlobal: UpdateGlobal = async function updateGlobal(
new: true,
projection: buildProjectionFromSelect({
adapter: this,
fields: globalConfig.flattenedFields,
fields: this.payload.config.globals.find((global) => global.slug === slug).flattenedFields,
select,
}),
session: await getSession(this, req),
}
transform({ adapter: this, data, fields, globalSlug, operation: 'write' })
transform({ adapter: this, data, fields, globalSlug: slug, operation: 'write' })
if (returning === false) {
await Model.updateOne({ globalType: globalSlug }, data, options)
await Model.updateOne({ globalType: slug }, data, options)
return null
}
const result: any = await Model.findOneAndUpdate({ globalType: globalSlug }, data, options)
const result: any = await Model.findOneAndUpdate({ globalType: slug }, data, options)
transform({ adapter: this, data: result, fields, globalSlug, operation: 'read' })
transform({ adapter: this, data: result, fields, globalSlug: slug, operation: 'read' })
return result
}

View File

@@ -6,7 +6,6 @@ import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
import { getGlobal } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { transform } from './utilities/transform.js'
@@ -24,11 +23,12 @@ export async function updateGlobalVersion<T extends TypeWithID>(
where,
}: UpdateGlobalVersionArgs<T>,
) {
const { globalConfig, Model } = getGlobal({ adapter: this, globalSlug, versions: true })
const VersionModel = this.versions[globalSlug]
const whereToUse = where || { id: { equals: id } }
const fields = buildVersionGlobalFields(this.payload.config, globalConfig)
const flattenedFields = buildVersionGlobalFields(this.payload.config, globalConfig, true)
const currentGlobal = this.payload.config.globals.find((global) => global.slug === globalSlug)
const fields = buildVersionGlobalFields(this.payload.config, currentGlobal)
const flattenedFields = buildVersionGlobalFields(this.payload.config, currentGlobal, true)
const options: MongooseUpdateQueryOptions = {
...optionsArgs,
lean: true,
@@ -51,11 +51,11 @@ export async function updateGlobalVersion<T extends TypeWithID>(
transform({ adapter: this, data: versionData, fields, operation: 'write' })
if (returning === false) {
await Model.updateOne(query, versionData, options)
await VersionModel.updateOne(query, versionData, options)
return null
}
const doc = await Model.findOneAndUpdate(query, versionData, options)
const doc = await VersionModel.findOneAndUpdate(query, versionData, options)
if (!doc) {
return null

View File

@@ -5,26 +5,16 @@ import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { handleError } from './utilities/handleError.js'
import { transform } from './utilities/transform.js'
export const updateMany: UpdateMany = async function updateMany(
this: MongooseAdapter,
{
collection: collectionSlug,
data,
limit,
locale,
options: optionsArgs = {},
req,
returning,
select,
where,
},
{ collection, data, locale, options: optionsArgs = {}, req, returning, select, where },
) {
const { collectionConfig, Model } = getCollection({ adapter: this, collectionSlug })
const Model = this.collections[collection]
const fields = this.payload.collections[collection].config.fields
const options: MongooseUpdateQueryOptions = {
...optionsArgs,
@@ -32,39 +22,26 @@ export const updateMany: UpdateMany = async function updateMany(
new: true,
projection: buildProjectionFromSelect({
adapter: this,
fields: collectionConfig.flattenedFields,
fields: this.payload.collections[collection].config.flattenedFields,
select,
}),
session: await getSession(this, req),
}
let query = await buildQuery({
const query = await buildQuery({
adapter: this,
collectionSlug,
fields: collectionConfig.flattenedFields,
collectionSlug: collection,
fields: this.payload.collections[collection].config.flattenedFields,
locale,
where,
})
transform({ adapter: this, data, fields: collectionConfig.fields, operation: 'write' })
transform({ adapter: this, data, fields, operation: 'write' })
try {
if (typeof limit === 'number' && limit > 0) {
const documentsToUpdate = await Model.find(
query,
{},
{ ...options, limit, projection: { _id: 1 } },
)
if (documentsToUpdate.length === 0) {
return null
}
query = { _id: { $in: documentsToUpdate.map((doc) => doc._id) } }
}
await Model.updateMany(query, data, options)
} catch (error) {
handleError({ collection: collectionSlug, error, req })
handleError({ collection, error, req })
}
if (returning === false) {
@@ -76,7 +53,7 @@ export const updateMany: UpdateMany = async function updateMany(
transform({
adapter: this,
data: result,
fields: collectionConfig.fields,
fields,
operation: 'read',
})

View File

@@ -5,7 +5,6 @@ import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { handleError } from './utilities/handleError.js'
import { transform } from './utilities/transform.js'
@@ -14,27 +13,26 @@ export const updateOne: UpdateOne = async function updateOne(
this: MongooseAdapter,
{
id,
collection: collectionSlug,
collection,
data,
locale,
options: optionsArgs = {},
req,
returning,
select,
where: whereArg = {},
where: whereArg,
},
) {
const { collectionConfig, Model } = getCollection({ adapter: this, collectionSlug })
const where = id ? { id: { equals: id } } : whereArg
const fields = collectionConfig.fields
const Model = this.collections[collection]
const fields = this.payload.collections[collection].config.fields
const options: MongooseUpdateQueryOptions = {
...optionsArgs,
lean: true,
new: true,
projection: buildProjectionFromSelect({
adapter: this,
fields: collectionConfig.flattenedFields,
fields: this.payload.collections[collection].config.flattenedFields,
select,
}),
session: await getSession(this, req),
@@ -42,8 +40,8 @@ export const updateOne: UpdateOne = async function updateOne(
const query = await buildQuery({
adapter: this,
collectionSlug,
fields: collectionConfig.flattenedFields,
collectionSlug: collection,
fields: this.payload.collections[collection].config.flattenedFields,
locale,
where,
})
@@ -60,7 +58,7 @@ export const updateOne: UpdateOne = async function updateOne(
result = await Model.findOneAndUpdate(query, data, options)
}
} catch (error) {
handleError({ collection: collectionSlug, error, req })
handleError({ collection, error, req })
}
if (!result) {

View File

@@ -6,34 +6,25 @@ import type { MongooseAdapter } from './index.js'
import { buildQuery } from './queries/buildQuery.js'
import { buildProjectionFromSelect } from './utilities/buildProjectionFromSelect.js'
import { getCollection } from './utilities/getEntity.js'
import { getSession } from './utilities/getSession.js'
import { transform } from './utilities/transform.js'
export const updateVersion: UpdateVersion = async function updateVersion(
this: MongooseAdapter,
{
id,
collection: collectionSlug,
locale,
options: optionsArgs = {},
req,
returning,
select,
versionData,
where,
},
{ id, collection, locale, options: optionsArgs = {}, req, returning, select, versionData, where },
) {
const { collectionConfig, Model } = getCollection({
adapter: this,
collectionSlug,
versions: true,
})
const VersionModel = this.versions[collection]
const whereToUse = where || { id: { equals: id } }
const fields = buildVersionCollectionFields(this.payload.config, collectionConfig)
const fields = buildVersionCollectionFields(
this.payload.config,
this.payload.collections[collection].config,
)
const flattenedFields = buildVersionCollectionFields(this.payload.config, collectionConfig, true)
const flattenedFields = buildVersionCollectionFields(
this.payload.config,
this.payload.collections[collection].config,
true,
)
const options: MongooseUpdateQueryOptions = {
...optionsArgs,
@@ -57,11 +48,11 @@ export const updateVersion: UpdateVersion = async function updateVersion(
transform({ adapter: this, data: versionData, fields, operation: 'write' })
if (returning === false) {
await Model.updateOne(query, versionData, options)
await VersionModel.updateOne(query, versionData, options)
return null
}
const doc = await Model.findOneAndUpdate(query, versionData, options)
const doc = await VersionModel.findOneAndUpdate(query, versionData, options)
if (!doc) {
return null

View File

@@ -1,106 +0,0 @@
import type { CollationOptions } from 'mongodb'
import type { ClientSession, Model, PipelineStage } from 'mongoose'
import type { PaginatedDocs } from 'payload'
import type { MongooseAdapter } from '../index.js'
export const aggregatePaginate = async ({
adapter,
collation,
joinAggregation,
limit,
Model,
page,
pagination,
projection,
query,
session,
sort,
useEstimatedCount,
}: {
adapter: MongooseAdapter
collation?: CollationOptions
joinAggregation?: PipelineStage[]
limit?: number
Model: Model<any>
page?: number
pagination?: boolean
projection?: Record<string, boolean>
query: Record<string, unknown>
session?: ClientSession
sort?: object
useEstimatedCount?: boolean
}): Promise<PaginatedDocs<any>> => {
const aggregation: PipelineStage[] = [{ $match: query }]
if (sort) {
const $sort: Record<string, -1 | 1> = {}
Object.entries(sort).forEach(([key, value]) => {
$sort[key] = value === 'desc' ? -1 : 1
})
aggregation.push({ $sort })
}
if (page) {
aggregation.push({ $skip: (page - 1) * (limit ?? 0) })
}
if (limit) {
aggregation.push({ $limit: limit })
}
if (joinAggregation) {
for (const stage of joinAggregation) {
aggregation.push(stage)
}
}
if (projection) {
aggregation.push({ $project: projection })
}
let countPromise: Promise<null | number> = Promise.resolve(null)
if (pagination !== false && limit) {
if (useEstimatedCount) {
countPromise = Model.estimatedDocumentCount(query)
} else {
const hint = adapter.disableIndexHints !== true ? { _id: 1 } : undefined
countPromise = Model.countDocuments(query, { collation, hint, session })
}
}
const [docs, countResult] = await Promise.all([
Model.aggregate(aggregation, { collation, session }),
countPromise,
])
const count = countResult === null ? docs.length : countResult
const totalPages =
pagination !== false && typeof limit === 'number' && limit !== 0 ? Math.ceil(count / limit) : 1
const hasPrevPage = typeof page === 'number' && pagination !== false && page > 1
const hasNextPage = typeof page === 'number' && pagination !== false && totalPages > page
const pagingCounter =
typeof page === 'number' && pagination !== false && typeof limit === 'number'
? (page - 1) * limit + 1
: 1
const result: PaginatedDocs = {
docs,
hasNextPage,
hasPrevPage,
limit: limit ?? 0,
nextPage: hasNextPage ? page + 1 : null,
page,
pagingCounter,
prevPage: hasPrevPage ? page - 1 : null,
totalDocs: count,
totalPages,
}
return result
}

View File

@@ -1,29 +1,30 @@
import type { PipelineStage } from 'mongoose'
import {
APIError,
type CollectionSlug,
type FlattenedField,
type JoinQuery,
type SanitizedCollectionConfig,
import type {
CollectionSlug,
FlattenedField,
JoinQuery,
SanitizedCollectionConfig,
Where,
} from 'payload'
import { fieldShouldBeLocalized } from 'payload/shared'
import type { MongooseAdapter } from '../index.js'
import { buildQuery } from '../queries/buildQuery.js'
import { buildSortParam } from '../queries/buildSortParam.js'
import { getCollection } from './getEntity.js'
type BuildJoinAggregationArgs = {
adapter: MongooseAdapter
collection: CollectionSlug
collectionConfig: SanitizedCollectionConfig
joins?: JoinQuery
locale?: string
joins: JoinQuery
// the number of docs to get at the top collection level
limit?: number
locale: string
projection?: Record<string, true>
// the where clause for the top collection
query?: Record<string, unknown>
query?: Where
/** whether the query is from drafts */
versions?: boolean
}
@@ -33,8 +34,10 @@ export const buildJoinAggregation = async ({
collection,
collectionConfig,
joins,
limit,
locale,
projection,
query,
versions,
}: BuildJoinAggregationArgs): Promise<PipelineStage[] | undefined> => {
if (
@@ -45,17 +48,24 @@ export const buildJoinAggregation = async ({
return
}
const joinConfig = adapter.payload.collections[collection]?.config?.joins
const joinConfig = adapter.payload.collections[collection].config.joins
const polymorphicJoinsConfig = adapter.payload.collections[collection].config.polymorphicJoins
const aggregate: PipelineStage[] = [
{
$sort: { createdAt: -1 },
},
]
if (!joinConfig) {
throw new APIError(`Could not retrieve sanitized join config for ${collection}.`)
if (query) {
aggregate.push({
$match: query,
})
}
const aggregate: PipelineStage[] = []
const polymorphicJoinsConfig = adapter.payload.collections[collection]?.config?.polymorphicJoins
if (!polymorphicJoinsConfig) {
throw new APIError(`Could not retrieve sanitized polymorphic joins config for ${collection}.`)
if (limit) {
aggregate.push({
$limit: limit,
})
}
for (const join of polymorphicJoinsConfig) {
@@ -72,14 +82,12 @@ export const buildJoinAggregation = async ({
limit: limitJoin = join.field.defaultLimit ?? 10,
page,
sort: sortJoin = join.field.defaultSort || collectionConfig.defaultSort,
where: whereJoin = {},
where: whereJoin,
} = joins?.[join.joinPath] || {}
const aggregatedFields: FlattenedField[] = []
for (const collectionSlug of join.field.collection) {
const { collectionConfig } = getCollection({ adapter, collectionSlug })
for (const field of collectionConfig.flattenedFields) {
for (const field of adapter.payload.collections[collectionSlug].config.flattenedFields) {
if (!aggregatedFields.some((eachField) => eachField.name === field.name)) {
aggregatedFields.push(field)
}
@@ -101,7 +109,7 @@ export const buildJoinAggregation = async ({
where: whereJoin,
})
const sortProperty = Object.keys(sort)[0]! // assert because buildSortParam always returns at least 1 key.
const sortProperty = Object.keys(sort)[0]
const sortDirection = sort[sortProperty] === 'asc' ? 1 : -1
const projectSort = sortProperty !== '_id' && sortProperty !== 'relationTo'
@@ -136,12 +144,10 @@ export const buildJoinAggregation = async ({
},
]
const { Model: JoinModel } = getCollection({ adapter, collectionSlug })
aggregate.push({
$lookup: {
as: alias,
from: JoinModel.collection.name,
from: adapter.collections[collectionSlug].collection.name,
let: {
root_id_: '$_id',
},
@@ -173,7 +179,7 @@ export const buildJoinAggregation = async ({
aggregate.push({
$lookup: {
as: `${as}.totalDocs.${alias}`,
from: JoinModel.collection.name,
from: adapter.collections[collectionSlug].collection.name,
let: {
root_id_: '$_id',
},
@@ -246,13 +252,7 @@ export const buildJoinAggregation = async ({
}
for (const slug of Object.keys(joinConfig)) {
const joinsList = joinConfig[slug]
if (!joinsList) {
throw new APIError(`Failed to retrieve array of joins for ${slug} in collectio ${collection}`)
}
for (const join of joinsList) {
for (const join of joinConfig[slug]) {
if (projection && !projection[join.joinPath]) {
continue
}
@@ -261,34 +261,31 @@ export const buildJoinAggregation = async ({
continue
}
const { collectionConfig, Model: JoinModel } = getCollection({
adapter,
collectionSlug: join.field.collection as string,
})
const {
count,
limit: limitJoin = join.field.defaultLimit ?? 10,
page,
sort: sortJoin = join.field.defaultSort || collectionConfig.defaultSort,
where: whereJoin = {},
where: whereJoin,
} = joins?.[join.joinPath] || {}
if (Array.isArray(join.field.collection)) {
throw new Error('Unreachable')
}
const joinModel = adapter.collections[join.field.collection]
const sort = buildSortParam({
config: adapter.payload.config,
fields: collectionConfig.flattenedFields,
fields: adapter.payload.collections[slug].config.flattenedFields,
locale,
sort: sortJoin,
timestamps: true,
})
const sortProperty = Object.keys(sort)[0]!
const sortProperty = Object.keys(sort)[0]
const sortDirection = sort[sortProperty] === 'asc' ? 1 : -1
const $match = await JoinModel.buildQuery({
const $match = await joinModel.buildQuery({
locale,
payload: adapter.payload,
where: whereJoin,
@@ -324,7 +321,7 @@ export const buildJoinAggregation = async ({
$lookup: {
as: `${as}.totalDocs`,
foreignField,
from: JoinModel.collection.name,
from: adapter.collections[slug].collection.name,
localField: versions ? 'parent' : '_id',
pipeline: [
{
@@ -352,7 +349,7 @@ export const buildJoinAggregation = async ({
$lookup: {
as: `${as}.docs`,
foreignField: `${join.field.on}${code}${polymorphicSuffix}`,
from: JoinModel.collection.name,
from: adapter.collections[slug].collection.name,
localField: versions ? 'parent' : '_id',
pipeline,
},
@@ -413,7 +410,7 @@ export const buildJoinAggregation = async ({
$lookup: {
as: `${as}.docs`,
foreignField,
from: JoinModel.collection.name,
from: adapter.collections[slug].collection.name,
localField: versions ? 'parent' : '_id',
pipeline,
},
@@ -451,5 +448,9 @@ export const buildJoinAggregation = async ({
}
}
if (projection) {
aggregate.push({ $project: projection })
}
return aggregate
}

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