diff --git a/packages/next/src/pages/Dashboard/index.tsx b/packages/next/src/pages/Dashboard/index.tsx
index 1ba6e4d3d19..25a8be78f7e 100644
--- a/packages/next/src/pages/Dashboard/index.tsx
+++ b/packages/next/src/pages/Dashboard/index.tsx
@@ -1,5 +1,5 @@
-import type { Metadata } from 'next'
import type { SanitizedConfig } from 'payload/types'
+import type { Metadata } from 'next'
import { HydrateClientUser, RenderCustomComponent } from '@payloadcms/ui'
import Link from 'next/link'
@@ -10,7 +10,6 @@ import type { DashboardProps } from './Default'
import { getNextI18n } from '../../utilities/getNextI18n'
import { initPage } from '../../utilities/initPage'
-import { meta } from '../../utilities/meta'
import { DefaultDashboard } from './Default'
export const generateMetadata = async ({
diff --git a/packages/next/src/pages/Edit/Default/RenderCustomView.tsx b/packages/next/src/pages/Edit/Default/RenderCustomView.tsx
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/packages/next/src/pages/Edit/Default/index.tsx b/packages/next/src/pages/Edit/Default/index.tsx
index 2ea1231f01d..49c7ee2b16c 100644
--- a/packages/next/src/pages/Edit/Default/index.tsx
+++ b/packages/next/src/pages/Edit/Default/index.tsx
@@ -72,6 +72,7 @@ export const DefaultEditView: React.FC = () => {
globalSlug: globalConfig?.slug,
})
+ const isEditing = 'isEditing' in props ? props.isEditing : undefined
const operation = id ? 'update' : 'create'
const auth = collectionConfig ? collectionConfig.auth : undefined
@@ -183,7 +184,7 @@ export const DefaultEditView: React.FC = () => {
collectionSlug={collectionConfig?.slug}
globalSlug={globalConfig?.slug}
id={id}
- isEditing={Boolean(id) || false}
+ isEditing={isEditing || false}
pluralLabel={collectionConfig?.labels?.plural}
useAsTitle={collectionConfig?.admin?.useAsTitle}
/>
@@ -198,7 +199,7 @@ export const DefaultEditView: React.FC = () => {
disableActions={disableActions}
hasSavePermission={hasSavePermission}
id={id}
- isEditing={Boolean(id)}
+ isEditing={isEditing}
permissions={docPermissions}
slug={collectionConfig?.slug}
/>
diff --git a/packages/next/src/pages/List/Default/Cell/fields/Richtext/index.tsx b/packages/next/src/pages/List/Default/Cell/fields/Richtext/index.tsx
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/packages/next/src/pages/LivePreview/index.tsx b/packages/next/src/pages/LivePreview/index.tsx
index 0ac68f2a4d3..afe8c6cb8e3 100644
--- a/packages/next/src/pages/LivePreview/index.tsx
+++ b/packages/next/src/pages/LivePreview/index.tsx
@@ -194,6 +194,10 @@ export const LivePreviewView: React.FC<
: []
setViewActions(livePreviewActions)
+
+ return () => {
+ setViewActions([])
+ }
}, [collection, global, setViewActions])
const breakpoints: LivePreviewConfig['breakpoints'] = [
diff --git a/packages/next/src/routes/rest/collections/buildFormState.ts b/packages/next/src/routes/rest/collections/buildFormState.ts
new file mode 100644
index 00000000000..64685655885
--- /dev/null
+++ b/packages/next/src/routes/rest/collections/buildFormState.ts
@@ -0,0 +1,28 @@
+import httpStatus from 'http-status'
+
+import { CollectionRouteHandler } from '../types'
+
+import { BuildFormStateArgs, buildStateFromSchema, reduceFieldsToValues } from '@payloadcms/ui'
+
+export const buildFormStateCollection: CollectionRouteHandler = async ({ req, collection }) => {
+ const { data: reqData, user, t, locale } = req
+
+ const { id, operation, docPreferences, formState } = reqData as BuildFormStateArgs
+
+ const data = reduceFieldsToValues(formState, true)
+
+ const result = await buildStateFromSchema({
+ id,
+ data,
+ fieldSchema: collection.config.fields,
+ locale,
+ operation,
+ preferences: docPreferences,
+ t,
+ user,
+ })
+
+ return Response.json(result, {
+ status: httpStatus.OK,
+ })
+}
diff --git a/packages/next/src/routes/rest/globals/buildFormState.ts b/packages/next/src/routes/rest/globals/buildFormState.ts
new file mode 100644
index 00000000000..86a1deaca7f
--- /dev/null
+++ b/packages/next/src/routes/rest/globals/buildFormState.ts
@@ -0,0 +1,26 @@
+import httpStatus from 'http-status'
+
+import { GlobalRouteHandler } from '../types'
+
+import { BuildFormStateArgs, buildStateFromSchema, reduceFieldsToValues } from '@payloadcms/ui'
+
+export const buildFormStateGlobal: GlobalRouteHandler = async ({ req, globalConfig }) => {
+ const { data: reqData, user, t, locale } = req
+
+ const { docPreferences, formState } = reqData as BuildFormStateArgs
+
+ const data = reduceFieldsToValues(formState, true)
+
+ const result = await buildStateFromSchema({
+ data,
+ fieldSchema: globalConfig.fields,
+ locale,
+ preferences: docPreferences,
+ t,
+ user,
+ })
+
+ return Response.json(result, {
+ status: httpStatus.OK,
+ })
+}
diff --git a/packages/next/src/utilities/createClientConfig.ts b/packages/next/src/utilities/createClientConfig.ts
new file mode 100644
index 00000000000..757cce57b56
--- /dev/null
+++ b/packages/next/src/utilities/createClientConfig.ts
@@ -0,0 +1,117 @@
+import type { ClientConfig, Field, SanitizedConfig } from 'payload/types'
+
+export const sanitizeField = (f) => {
+ const field = { ...f }
+
+ if ('access' in field) delete field.access
+ if ('hooks' in field) delete field.hooks
+ if ('validate' in field) delete field.validate
+ if ('defaultValue' in field) delete field.defaultValue
+ if ('label' in field) delete field.label
+
+ if ('fields' in field) {
+ field.fields = sanitizeFields(field.fields)
+ }
+
+ if ('editor' in field) {
+ delete field.editor
+ }
+
+ if ('blocks' in field) {
+ field.blocks = field.blocks.map((block) => {
+ const sanitized = { ...block }
+ sanitized.fields = sanitizeFields(sanitized.fields)
+ return sanitized
+ })
+ }
+
+ if ('tabs' in field) {
+ field.tabs = field.tabs.map((tab) => sanitizeField(tab))
+ }
+
+ if ('admin' in field) {
+ field.admin = { ...field.admin }
+
+ if ('components' in field.admin) {
+ delete field.admin.components
+ }
+
+ if ('condition' in field.admin) {
+ delete field.admin.condition
+ }
+
+ if ('description' in field.admin) {
+ delete field.admin.description
+ }
+ }
+
+ return field
+}
+
+const sanitizeCollections = (
+ collections: SanitizedConfig['collections'],
+): ClientConfig['collections'] =>
+ collections.map((collection) => {
+ const sanitized = { ...collection }
+ sanitized.fields = sanitizeFields(sanitized.fields)
+ delete sanitized.hooks
+ delete sanitized.access
+ delete sanitized.endpoints
+
+ if ('editor' in sanitized) delete sanitized.editor
+
+ if ('admin' in sanitized) {
+ sanitized.admin = { ...sanitized.admin }
+
+ if ('components' in sanitized.admin) {
+ delete sanitized.admin.components
+ }
+ }
+
+ return sanitized
+ })
+
+const sanitizeGlobals = (globals: SanitizedConfig['globals']): ClientConfig['globals'] =>
+ globals.map((global) => {
+ const sanitized = { ...global }
+ sanitized.fields = sanitizeFields(sanitized.fields)
+ delete sanitized.hooks
+ delete sanitized.access
+ delete sanitized.endpoints
+
+ if ('admin' in sanitized) {
+ sanitized.admin = { ...sanitized.admin }
+
+ if ('components' in sanitized.admin) {
+ delete sanitized.admin.components
+ }
+ }
+
+ return sanitized
+ })
+
+export const sanitizeFields = (fields: Field[]): Field[] => fields.map(sanitizeField)
+
+export const createClientConfig = async (
+ configPromise: Promise
| SanitizedConfig,
+): Promise => {
+ const config = await configPromise
+ const clientConfig = { ...config }
+
+ delete clientConfig.endpoints
+ delete clientConfig.db
+ delete clientConfig.editor
+
+ 'localization' in clientConfig &&
+ clientConfig.localization &&
+ clientConfig.localization.locales.forEach((locale) => {
+ delete locale.toString
+ })
+
+ clientConfig.onInit = undefined
+
+ clientConfig.collections = sanitizeCollections(clientConfig.collections)
+ clientConfig.globals = sanitizeGlobals(clientConfig.globals)
+
+ return clientConfig
+}
diff --git a/packages/next/src/utilities/getNextT.ts b/packages/next/src/utilities/getNextT.ts
new file mode 100644
index 00000000000..b778964d8a7
--- /dev/null
+++ b/packages/next/src/utilities/getNextT.ts
@@ -0,0 +1,25 @@
+import type { TFunction } from '@payloadcms/translations'
+import type { SanitizedConfig } from 'payload/types'
+
+import { initI18n } from '@payloadcms/translations'
+import { translations } from '@payloadcms/translations/client'
+import { cookies, headers } from 'next/headers'
+
+import { getRequestLanguage } from './getRequestLanguage'
+
+export const getNextT = async ({
+ config,
+ language,
+}: {
+ config: SanitizedConfig
+ language?: string
+}): Promise => {
+ const i18n = await initI18n({
+ config: config.i18n,
+ context: 'client',
+ language: language || getRequestLanguage({ cookies: cookies(), headers: headers() }),
+ translations,
+ })
+
+ return i18n.t
+}
diff --git a/packages/payload/package.json b/packages/payload/package.json
index 2cedd91a5f0..94bbaab35e3 100644
--- a/packages/payload/package.json
+++ b/packages/payload/package.json
@@ -18,11 +18,6 @@
"import": "./src/exports/*.ts",
"require": "./src/exports/*.ts",
"types": "./src/exports/*.ts"
- },
- "./dist/*": {
- "import": "./src/*.ts",
- "require": "./src/*.ts",
- "types": "./src/*.ts"
}
},
"scripts": {
diff --git a/packages/payload/src/auth/baseFields/apiKey.ts b/packages/payload/src/auth/baseFields/apiKey.ts
index da928da394e..7e525e9ff81 100644
--- a/packages/payload/src/auth/baseFields/apiKey.ts
+++ b/packages/payload/src/auth/baseFields/apiKey.ts
@@ -7,13 +7,14 @@ import { extractTranslations } from '../../translations/extractTranslations'
const labels = extractTranslations(['authentication:enableAPIKey', 'authentication:apiKey'])
const encryptKey: FieldHook = ({ req, value }) =>
- value ? req.payload.encrypt(value as string) : undefined
+ value ? req.payload.encrypt(value as string) : null
const decryptKey: FieldHook = ({ req, value }) =>
value ? req.payload.decrypt(value as string) : undefined
export default [
{
name: 'enableAPIKey',
+ type: 'checkbox',
admin: {
components: {
Field: () => null,
@@ -21,10 +22,10 @@ export default [
},
defaultValue: false,
label: labels['authentication:enableAPIKey'],
- type: 'checkbox',
},
{
name: 'apiKey',
+ type: 'text',
admin: {
components: {
Field: () => null,
@@ -35,10 +36,10 @@ export default [
beforeChange: [encryptKey],
},
label: labels['authentication:apiKey'],
- type: 'text',
},
{
name: 'apiKeyIndex',
+ type: 'text',
admin: {
disabled: true,
},
@@ -59,6 +60,5 @@ export default [
},
],
},
- type: 'text',
},
] as Field[]
diff --git a/packages/payload/src/auth/operations/forgotPassword.ts b/packages/payload/src/auth/operations/forgotPassword.ts
index ce44eeac67f..8c147e91b18 100644
--- a/packages/payload/src/auth/operations/forgotPassword.ts
+++ b/packages/payload/src/auth/operations/forgotPassword.ts
@@ -30,21 +30,25 @@ export const forgotPasswordOperation = async (incomingArgs: Arguments): Promise<
let args = incomingArgs
- // /////////////////////////////////////
- // beforeOperation - Collection
- // /////////////////////////////////////
-
- await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
- await priorHook
-
- args =
- (await hook({
- args,
- collection: args.collection?.config,
- context: args.req.context,
- operation: 'forgotPassword',
- })) || args
- }, Promise.resolve())
+ try {
+ const shouldCommit = await initTransaction(args.req)
+
+ // /////////////////////////////////////
+ // beforeOperation - Collection
+ // /////////////////////////////////////
+
+ await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
+ await priorHook
+
+ args =
+ (await hook({
+ args,
+ collection: args.collection?.config,
+ context: args.req.context,
+ operation: 'forgotPassword',
+ req: args.req,
+ })) || args
+ }, Promise.resolve())
const {
collection: { config: collectionConfig },
@@ -58,9 +62,6 @@ export const forgotPasswordOperation = async (incomingArgs: Arguments): Promise<
req,
} = args
- try {
- const shouldCommit = await initTransaction(req)
-
// /////////////////////////////////////
// Forget password
// /////////////////////////////////////
@@ -159,7 +160,7 @@ export const forgotPasswordOperation = async (incomingArgs: Arguments): Promise<
return token
} catch (error: unknown) {
- await killTransaction(req)
+ await killTransaction(args.req)
throw error
}
}
diff --git a/packages/payload/src/auth/operations/login.ts b/packages/payload/src/auth/operations/login.ts
index d63cc9115f9..57f0d90e59c 100644
--- a/packages/payload/src/auth/operations/login.ts
+++ b/packages/payload/src/auth/operations/login.ts
@@ -16,7 +16,7 @@ import { getFieldsToSign } from '../getFieldsToSign'
import isLocked from '../isLocked'
import { authenticateLocalStrategy } from '../strategies/local/authenticate'
import { incrementLoginAttempts } from '../strategies/local/incrementLoginAttempts'
-import { unlockOperation } from './unlock'
+import { resetLoginAttempts } from '../strategies/local/resetLoginAttempts'
export type Result = {
exp?: number
@@ -41,37 +41,40 @@ export const loginOperation = async => {
let args = incomingArgs
- // /////////////////////////////////////
- // beforeOperation - Collection
- // /////////////////////////////////////
-
- await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
- await priorHook
-
- args =
- (await hook({
- args,
- collection: args.collection?.config,
- context: args.req.context,
- operation: 'login',
- })) || args
- }, Promise.resolve())
-
- const {
- collection: { config: collectionConfig },
- data,
- depth,
- overrideAccess,
- req,
- req: {
- payload,
- payload: { secret },
- },
- showHiddenFields,
- } = args
-
try {
- const shouldCommit = await initTransaction(req)
+ const shouldCommit = await initTransaction(args.req)
+
+ // /////////////////////////////////////
+ // beforeOperation - Collection
+ // /////////////////////////////////////
+
+ await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
+ await priorHook
+
+ args =
+ (await hook({
+ args,
+ collection: args.collection?.config,
+ context: args.req.context,
+ operation: 'login',
+ req: args.req,
+ })) || args
+ }, Promise.resolve())
+
+ const {
+ collection: { config: collectionConfig },
+ data,
+ depth,
+ overrideAccess,
+ req,
+ req: {
+ fallbackLocale,
+ locale,
+ payload,
+ payload: { secret },
+ },
+ showHiddenFields,
+ } = args
// /////////////////////////////////////
// Login
@@ -111,16 +114,16 @@ export const loginOperation = async => {
let args = incomingArgs
- // /////////////////////////////////////
- // beforeOperation - Collection
- // /////////////////////////////////////
-
- await args.collection.config.hooks.beforeOperation.reduce(
- async (priorHook: BeforeOperationHook | Promise, hook: BeforeOperationHook) => {
+ try {
+ const shouldCommit = await initTransaction(args.req)
+
+ // /////////////////////////////////////
+ // beforeOperation - Collection
+ // /////////////////////////////////////
+
+ await args.collection.config.hooks.beforeOperation.reduce(
+ async (priorHook: BeforeOperationHook | Promise, hook: BeforeOperationHook) => {
+ await priorHook
+
+ args =
+ (await hook({
+ args,
+ collection: args.collection?.config,
+ context: args.req.context,
+ operation: 'refresh',
+ req: args.req,
+ })) || args
+ },
+ Promise.resolve(),
+ )
+
+ // /////////////////////////////////////
+ // Refresh
+ // /////////////////////////////////////
+
+ const {
+ collection: { config: collectionConfig },
+ req,
+ req: {
+ payload: { config, secret },
+ },
+ } = args
+
+ if (typeof args.token !== 'string' || !args.req.user) throw new Forbidden(args.req.t)
+
+ const parsedURL = url.parse(args.req.url)
+ const isGraphQL = parsedURL.pathname === config.routes.graphQL
+
+ const user = await args.req.payload.findByID({
+ id: args.req.user.id,
+ collection: args.req.user.collection,
+ depth: isGraphQL ? 0 : args.collection.config.auth.depth,
+ req: args.req,
+ })
+
+ const fieldsToSign = getFieldsToSign({
+ collectionConfig,
+ email: user?.email as string,
+ user: args?.req?.user,
+ })
+
+ const refreshedToken = jwt.sign(fieldsToSign, secret, {
+ expiresIn: collectionConfig.auth.tokenExpiration,
+ })
+
+ const exp = (jwt.decode(refreshedToken) as Record).exp as number
+
+ let result: Result = {
+ exp,
+ refreshedToken,
+ user,
+ }
+
+ // /////////////////////////////////////
+ // After Refresh - Collection
+ // /////////////////////////////////////
+
+ await collectionConfig.hooks.afterRefresh.reduce(async (priorHook, hook) => {
await priorHook
- args =
+ result =
(await hook({
- args,
collection: args.collection?.config,
context: args.req.context,
- operation: 'refresh',
- })) || args
- },
- Promise.resolve(),
- )
-
- // /////////////////////////////////////
- // Refresh
- // /////////////////////////////////////
-
- const {
- collection: { config: collectionConfig },
- req: {
- payload: { config, secret },
- },
- } = args
-
- if (typeof args.token !== 'string' || !args.req.user) throw new Forbidden(args.req.t)
-
- const parsedURL = url.parse(args.req.url)
- const isGraphQL = parsedURL.pathname === config.routes.graphQL
-
- const user = await args.req.payload.findByID({
- id: args.req.user.id,
- collection: args.req.user.collection,
- depth: isGraphQL ? 0 : args.collection.config.auth.depth,
- req: args.req,
- })
-
- const fieldsToSign = getFieldsToSign({
- collectionConfig,
- email: user?.email as string,
- user: args?.req?.user,
- })
-
- const refreshedToken = jwt.sign(fieldsToSign, secret, {
- expiresIn: collectionConfig.auth.tokenExpiration,
- })
-
- const exp = (jwt.decode(refreshedToken) as Record).exp as number
-
- let result: Result = {
- exp,
- refreshedToken,
- user,
+ exp,
+ req: args.req,
+ token: refreshedToken,
+ })) || result
+ }, Promise.resolve())
+
+ // /////////////////////////////////////
+ // afterOperation - Collection
+ // /////////////////////////////////////
+
+ result = await buildAfterOperation({
+ args,
+ collection: args.collection?.config,
+ operation: 'refresh',
+ result,
+ })
+
+ // /////////////////////////////////////
+ // Return results
+ // /////////////////////////////////////
+
+ if (shouldCommit) await commitTransaction(req)
+
+ return result
+ } catch (error: unknown) {
+ await killTransaction(args.req)
+ throw error
}
-
- // /////////////////////////////////////
- // After Refresh - Collection
- // /////////////////////////////////////
-
- await collectionConfig.hooks.afterRefresh.reduce(async (priorHook, hook) => {
- await priorHook
-
- result =
- (await hook({
- collection: args.collection?.config,
- context: args.req.context,
- exp,
- req: args.req,
- token: refreshedToken,
- })) || result
- }, Promise.resolve())
-
- // /////////////////////////////////////
- // afterOperation - Collection
- // /////////////////////////////////////
-
- result = await buildAfterOperation({
- args,
- collection: args.collection?.config,
- operation: 'refresh',
- result,
- })
-
- // /////////////////////////////////////
- // Return results
- // /////////////////////////////////////
-
- return result
}
diff --git a/packages/payload/src/auth/strategies/local/incrementLoginAttempts.ts b/packages/payload/src/auth/strategies/local/incrementLoginAttempts.ts
index 2612bf7b53f..c142dde7d9e 100644
--- a/packages/payload/src/auth/strategies/local/incrementLoginAttempts.ts
+++ b/packages/payload/src/auth/strategies/local/incrementLoginAttempts.ts
@@ -20,7 +20,7 @@ export const incrementLoginAttempts = async ({
} = collection
if ('lockUntil' in doc && typeof doc.lockUntil === 'string') {
- const lockUntil = Math.floor(new Date(doc.lockUntil).getTime() / 1000)
+ const lockUntil = new Date(doc.lockUntil).getTime()
// Expired lock, restart count at 1
if (lockUntil < Date.now()) {
@@ -52,5 +52,6 @@ export const incrementLoginAttempts = async ({
id: doc.id,
collection: collection.slug,
data,
+ req,
})
}
diff --git a/packages/payload/src/auth/strategies/local/resetLoginAttempts.ts b/packages/payload/src/auth/strategies/local/resetLoginAttempts.ts
index de45e5b46b6..5d55626e810 100644
--- a/packages/payload/src/auth/strategies/local/resetLoginAttempts.ts
+++ b/packages/payload/src/auth/strategies/local/resetLoginAttempts.ts
@@ -15,6 +15,7 @@ export const resetLoginAttempts = async ({
payload,
req,
}: Args): Promise => {
+ if (!('lockUntil' in doc && typeof doc.lockUntil === 'string') || doc.loginAttempts === 0) return
await payload.update({
id: doc.id,
collection: collection.slug,
@@ -22,6 +23,7 @@ export const resetLoginAttempts = async ({
lockUntil: null,
loginAttempts: 0,
},
+ overrideAccess: true,
req,
})
}
diff --git a/packages/payload/src/bin/migrate.ts b/packages/payload/src/bin/migrate.ts
index 140d40d8e30..d3a2d8e7554 100644
--- a/packages/payload/src/bin/migrate.ts
+++ b/packages/payload/src/bin/migrate.ts
@@ -28,7 +28,7 @@ const availableCommands = [
const availableCommandsMsg = `Available commands: ${availableCommands.join(', ')}`
export const migrate = async (parsedArgs: ParsedArgs): Promise => {
- const { _: args, file, help } = parsedArgs
+ const { _: args, file, forceAcceptWarning, help } = parsedArgs
if (help) {
// eslint-disable-next-line no-console
console.log(`\n\n${availableCommandsMsg}\n`) // Avoid having to init payload to get the logger
@@ -74,11 +74,16 @@ export const migrate = async (parsedArgs: ParsedArgs): Promise => {
await adapter.migrateReset()
break
case 'migrate:fresh':
- await adapter.migrateFresh()
+ await adapter.migrateFresh({ forceAcceptWarning })
break
case 'migrate:create':
try {
- await adapter.createMigration({ file, migrationName: args[1], payload })
+ await adapter.createMigration({
+ file,
+ forceAcceptWarning,
+ migrationName: args[1],
+ payload,
+ })
} catch (err) {
throw new Error(`Error creating migration: ${err.message}`)
}
diff --git a/packages/payload/src/bundlers/mocks/db-mongodb.js b/packages/payload/src/bundlers/mocks/db-mongodb.js
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/packages/db-postgres/mock.js b/packages/payload/src/bundlers/mocks/db-postgres.js
similarity index 100%
rename from packages/db-postgres/mock.js
rename to packages/payload/src/bundlers/mocks/db-postgres.js
diff --git a/packages/payload/src/collections/config/types.ts b/packages/payload/src/collections/config/types.ts
index 1eff74605b9..7fdcbc92754 100644
--- a/packages/payload/src/collections/config/types.ts
+++ b/packages/payload/src/collections/config/types.ts
@@ -46,6 +46,7 @@ export type BeforeOperationHook = (args: {
* Hook operation being performed
*/
operation: HookOperationType
+ req: PayloadRequest
}) => any
export type BeforeValidateHook = (args: {
diff --git a/packages/payload/src/collections/operations/create.ts b/packages/payload/src/collections/operations/create.ts
index 19eeff11030..3e39dc92535 100644
--- a/packages/payload/src/collections/operations/create.ts
+++ b/packages/payload/src/collections/operations/create.ts
@@ -15,7 +15,6 @@ import type {
import executeAccess from '../../auth/executeAccess'
import sendVerificationEmail from '../../auth/sendVerificationEmail'
import { registerLocalStrategy } from '../../auth/strategies/local/register'
-import { fieldAffectsData } from '../../fields/config/types'
import { afterChange } from '../../fields/hooks/afterChange'
import { afterRead } from '../../fields/hooks/afterRead'
import { beforeChange } from '../../fields/hooks/beforeChange'
@@ -24,6 +23,7 @@ import { generateFileData } from '../../uploads/generateFileData'
import { unlinkTempFiles } from '../../uploads/unlinkTempFiles'
import { uploadFiles } from '../../uploads/uploadFiles'
import { commitTransaction } from '../../utilities/commitTransaction'
+import flattenFields from '../../utilities/flattenTopLevelFields'
import { initTransaction } from '../../utilities/initTransaction'
import { killTransaction } from '../../utilities/killTransaction'
import sanitizeInternalFields from '../../utilities/sanitizeInternalFields'
@@ -50,44 +50,47 @@ export const createOperation = async => {
let args = incomingArgs
- // /////////////////////////////////////
- // beforeOperation - Collection
- // /////////////////////////////////////
+ try {
+ const shouldCommit = await initTransaction(args.req)
- await args.collection.config.hooks.beforeOperation.reduce(
- async (priorHook: BeforeOperationHook | Promise, hook: BeforeOperationHook) => {
- await priorHook
+ // /////////////////////////////////////
+ // beforeOperation - Collection
+ // /////////////////////////////////////
- args =
- (await hook({
- args,
- collection: args.collection.config,
- context: args.req.context,
- operation: 'create',
- })) || args
- },
- Promise.resolve(),
- )
-
- const {
- autosave = false,
- collection: { config: collectionConfig },
- collection,
- depth,
- disableVerificationEmail,
- draft = false,
- overrideAccess,
- overwriteExistingFiles = false,
- req: {
- payload,
- payload: { config, emailOptions },
- },
- req,
- showHiddenFields,
- } = args
+ await args.collection.config.hooks.beforeOperation.reduce(
+ async (priorHook: BeforeOperationHook | Promise, hook: BeforeOperationHook) => {
+ await priorHook
- try {
- const shouldCommit = await initTransaction(req)
+ args =
+ (await hook({
+ args,
+ collection: args.collection.config,
+ context: args.req.context,
+ operation: 'create',
+ req: args.req,
+ })) || args
+ },
+ Promise.resolve(),
+ )
+
+ const {
+ autosave = false,
+ collection: { config: collectionConfig },
+ collection,
+ depth,
+ disableVerificationEmail,
+ draft = false,
+ overrideAccess,
+ overwriteExistingFiles = false,
+ req: {
+ fallbackLocale,
+ locale,
+ payload,
+ payload: { config, emailOptions },
+ },
+ req,
+ showHiddenFields,
+ } = args
let { data } = args
@@ -104,10 +107,10 @@ export const createOperation = async fieldAffectsData(field) && field.name === 'id') >
- -1
+ flattenFields(collectionConfig.fields).findIndex((field) => field.name === 'id') > -1
+
if (hasIdField) {
data = {
_id: data.id,
@@ -166,6 +169,14 @@ export const createOperation = async => {
let args = incomingArgs
- // /////////////////////////////////////
- // beforeOperation - Collection
- // /////////////////////////////////////
-
- await args.collection.config.hooks.beforeOperation.reduce(
- async (priorHook: BeforeOperationHook | Promise, hook: BeforeOperationHook) => {
- await priorHook
-
- args =
- (await hook({
- args,
- collection: args.collection.config,
- context: args.req.context,
- operation: 'delete',
- })) || args
- },
- Promise.resolve(),
- )
-
- const {
- collection: { config: collectionConfig },
- depth,
- overrideAccess,
- req: {
- locale,
+ try {
+ const shouldCommit = await initTransaction(args.req)
+ // /////////////////////////////////////
+ // beforeOperation - Collection
+ // /////////////////////////////////////
+
+ await args.collection.config.hooks.beforeOperation.reduce(
+ async (priorHook: BeforeOperationHook | Promise, hook: BeforeOperationHook) => {
+ await priorHook
+
+ args =
+ (await hook({
+ args,
+ collection: args.collection.config,
+ context: args.req.context,
+ operation: 'delete',
+ req: args.req,
+ })) || args
+ },
+ Promise.resolve(),
+ )
+
+ const {
+ collection: { config: collectionConfig },
+ depth,
+ overrideAccess,
+ req: {
+ fallbackLocale,locale,
payload: { config },
payload,
},
@@ -72,9 +75,6 @@ export const deleteOperation = async => {
let args = incomingArgs
- // /////////////////////////////////////
- // beforeOperation - Collection
- // /////////////////////////////////////
+ try {
+ const shouldCommit = await initTransaction(args.req)
- await args.collection.config.hooks.beforeOperation.reduce(
- async (priorHook: BeforeOperationHook | Promise, hook: BeforeOperationHook) => {
- await priorHook
+ // /////////////////////////////////////
+ // beforeOperation - Collection
+ // /////////////////////////////////////
- args =
- (await hook({
- args,
- collection: args.collection.config,
- context: args.req.context,
- operation: 'delete',
- })) || args
- },
- Promise.resolve(),
- )
-
- const {
- id,
- collection: { config: collectionConfig },
- depth,
- overrideAccess,
- req: {
- payload: { config },
- payload,
- },
- req,
- showHiddenFields,
- } = args
+ await args.collection.config.hooks.beforeOperation.reduce(
+ async (priorHook: BeforeOperationHook | Promise, hook: BeforeOperationHook) => {
+ await priorHook
- try {
- const shouldCommit = await initTransaction(req)
+ args =
+ (await hook({
+ args,
+ collection: args.collection.config,
+ context: args.req.context,
+ operation: 'delete',
+ req: args.req,
+ })) || args
+ },
+ Promise.resolve(),
+ )
+
+ const {
+ id,
+ collection: { config: collectionConfig },
+ depth,
+ overrideAccess,
+ req: {
+ fallbackLocale,
+ locale,
+ payload: { config },
+ payload,
+
+ },
+ req,
+ showHiddenFields,
+ } = args
// /////////////////////////////////////
// Access
@@ -118,9 +122,9 @@ export const deleteByIDOperation = async > => {
let args = incomingArgs
- // /////////////////////////////////////
- // beforeOperation - Collection
- // /////////////////////////////////////
-
- await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
- await priorHook
-
- args =
- (await hook({
- args,
- collection: args.collection.config,
- context: args.req.context,
- operation: 'read',
- })) || args
- }, Promise.resolve())
-
- const {
- collection: { config: collectionConfig },
- collection,
- currentDepth,
- depth,
- disableErrors,
- draft: draftsEnabled,
- limit,
- overrideAccess,
- page,
- pagination = true,
- req: { locale, payload },
- req,
- showHiddenFields,
- sort,
- where,
- } = args
-
try {
- const shouldCommit = await initTransaction(req)
+ const shouldCommit = await initTransaction(args.req)
+
+ // /////////////////////////////////////
+ // beforeOperation - Collection
+ // /////////////////////////////////////
+
+ await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
+ await priorHook
+
+ args =
+ (await hook({
+ args,
+ collection: args.collection.config,
+ context: args.req.context,
+ operation: 'read',
+ req: args.req,
+ })) || args
+ }, Promise.resolve())
+
+ const {
+ collection: { config: collectionConfig },
+ collection,
+ currentDepth,
+ depth,
+ disableErrors,
+ draft: draftsEnabled,
+ limit,
+ overrideAccess,
+ page,
+ pagination = true,
+ req: { fallbackLocale, locale, payload },
+ req,
+ showHiddenFields,
+ sort,
+ where,
+ } = args
// /////////////////////////////////////
// Access
@@ -195,8 +196,10 @@ export const findOperation = async (
): Promise => {
let args = incomingArgs
- // /////////////////////////////////////
- // beforeOperation - Collection
- // /////////////////////////////////////
-
- await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
- await priorHook
-
- args =
- (await hook({
- args,
- collection: args.collection.config,
- context: args.req.context,
- operation: 'read',
- })) || args
- }, Promise.resolve())
-
- const {
- id,
- collection: { config: collectionConfig },
- currentDepth,
- depth,
- disableErrors,
- draft: draftEnabled = false,
- overrideAccess = false,
- req: { locale },
- req,
- showHiddenFields,
- } = args
-
try {
- const shouldCommit = await initTransaction(req)
+ const shouldCommit = await initTransaction(args.req)
+
+ // /////////////////////////////////////
+ // beforeOperation - Collection
+ // /////////////////////////////////////
+
+ await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
+ await priorHook
+
+ args =
+ (await hook({
+ args,
+ collection: args.collection.config,
+ context: args.req.context,
+ operation: 'read',
+ req: args.req,
+ })) || args
+ }, Promise.resolve())
+
+ const {
+ id,
+ collection: { config: collectionConfig },
+ currentDepth,
+ depth,
+ disableErrors,
+ draft: draftEnabled = false,
+ overrideAccess = false,
+ req: { fallbackLocale, locale, t },
+ req,
+ showHiddenFields,
+ } = args
// /////////////////////////////////////
// Access
@@ -86,9 +87,9 @@ export const findByIDOperation = async (
// Find by ID
// /////////////////////////////////////
- if (!findOneArgs.where.and[0].id) throw new NotFound(req.t)
+ if (!findOneArgs.where.and[0].id) throw new NotFound(t)
- let result = await req.payload.db.findOne(findOneArgs)
+ let result: T = await req.payload.db.findOne(findOneArgs)
if (!result) {
if (!disableErrors) {
@@ -98,9 +99,6 @@ export const findByIDOperation = async (
return null
}
- // Clone the result - it may have come back memoized
- result = JSON.parse(JSON.stringify(result))
-
// /////////////////////////////////////
// Replace document with draft if available
// /////////////////////////////////////
@@ -143,7 +141,9 @@ export const findByIDOperation = async (
currentDepth,
depth,
doc: result,
+ fallbackLocale,
global: null,
+ locale,
overrideAccess,
req,
showHiddenFields,
@@ -185,7 +185,7 @@ export const findByIDOperation = async (
return result
} catch (error: unknown) {
- await killTransaction(req)
+ await killTransaction(args.req)
throw error
}
}
diff --git a/packages/payload/src/collections/operations/findVersionByID.ts b/packages/payload/src/collections/operations/findVersionByID.ts
index 7906102d558..5c58636ce1e 100644
--- a/packages/payload/src/collections/operations/findVersionByID.ts
+++ b/packages/payload/src/collections/operations/findVersionByID.ts
@@ -34,7 +34,7 @@ export const findVersionByIDOperation = async (
depth,
disableErrors,
overrideAccess,
- req: { locale, payload },
+ req: { fallbackLocale, locale, payload },
req,
showHiddenFields,
} = args
@@ -112,7 +112,9 @@ export const findVersionByIDOperation = async (
currentDepth,
depth,
doc: result.version,
+ fallbackLocale,
global: null,
+ locale,
overrideAccess,
req,
showHiddenFields,
diff --git a/packages/payload/src/collections/operations/findVersions.ts b/packages/payload/src/collections/operations/findVersions.ts
index fb767ae8a27..0575e177abb 100644
--- a/packages/payload/src/collections/operations/findVersions.ts
+++ b/packages/payload/src/collections/operations/findVersions.ts
@@ -37,7 +37,7 @@ export const findVersionsOperation = async >(
overrideAccess,
page,
pagination = true,
- req: { locale, payload },
+ req: { fallbackLocale, locale, payload },
req,
showHiddenFields,
sort,
@@ -125,8 +125,10 @@ export const findVersionsOperation = async >(
context: req.context,
depth,
doc: data.version,
+ fallbackLocale,
findMany: true,
global: null,
+ locale,
overrideAccess,
req,
showHiddenFields,
diff --git a/packages/payload/src/collections/operations/local/update.ts b/packages/payload/src/collections/operations/local/update.ts
index 896f4106a9b..a8c4e132bb6 100644
--- a/packages/payload/src/collections/operations/local/update.ts
+++ b/packages/payload/src/collections/operations/local/update.ts
@@ -1,3 +1,4 @@
+import type { UploadedFile } from 'express-fileupload'
import type { DeepPartial } from 'ts-essentials'
import type { GeneratedTypes, Payload } from '../../../'
diff --git a/packages/payload/src/collections/operations/restoreVersion.ts b/packages/payload/src/collections/operations/restoreVersion.ts
index 5cafb5846f4..2b001e9cb64 100644
--- a/packages/payload/src/collections/operations/restoreVersion.ts
+++ b/packages/payload/src/collections/operations/restoreVersion.ts
@@ -36,7 +36,7 @@ export const restoreVersionOperation = async (
depth,
overrideAccess = false,
req,
- req: { locale, payload },
+ req: { fallbackLocale, locale, payload },
showHiddenFields,
} = args
@@ -142,7 +142,9 @@ export const restoreVersionOperation = async (
context: req.context,
depth,
doc: result,
+ fallbackLocale,
global: null,
+ locale,
overrideAccess,
req,
showHiddenFields,
diff --git a/packages/payload/src/collections/operations/update.ts b/packages/payload/src/collections/operations/update.ts
index 8dbc5584eda..7b39d300969 100644
--- a/packages/payload/src/collections/operations/update.ts
+++ b/packages/payload/src/collections/operations/update.ts
@@ -47,41 +47,43 @@ export const updateOperation = async > => {
let args = incomingArgs
- // /////////////////////////////////////
- // beforeOperation - Collection
- // /////////////////////////////////////
-
- await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
- await priorHook
-
- args =
- (await hook({
- args,
- collection: args.collection.config,
- context: args.req.context,
- operation: 'update',
- })) || args
- }, Promise.resolve())
-
- const {
- collection: { config: collectionConfig },
- collection,
- depth,
- draft: draftArg = false,
- overrideAccess,
- overwriteExistingFiles = false,
- req: {
- locale,
- payload: { config },
- payload,
- },
- req,
- showHiddenFields,
- where,
- } = args
-
try {
- const shouldCommit = await initTransaction(req)
+ const shouldCommit = await initTransaction(args.req)
+
+ // /////////////////////////////////////
+ // beforeOperation - Collection
+ // /////////////////////////////////////
+
+ await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
+ await priorHook
+
+ args =
+ (await hook({
+ args,
+ collection: args.collection.config,
+ context: args.req.context,
+ operation: 'update',
+ req: args.req,
+ })) || args
+ }, Promise.resolve())
+
+ const {
+ collection: { config: collectionConfig },
+ collection,
+ depth,
+ draft: draftArg = false,
+ overrideAccess,
+ overwriteExistingFiles = false,
+ req: {
+ fallbackLocale,
+ locale,
+ payload: { config },
+ payload,
+ },
+ req,
+ showHiddenFields,
+ where,
+ } = args
if (!where) {
throw new APIError("Missing 'where' query of documents to update.", httpStatus.BAD_REQUEST)
@@ -174,7 +176,9 @@ export const updateOperation = async => {
let args = incomingArgs
- // /////////////////////////////////////
- // beforeOperation - Collection
- // /////////////////////////////////////
-
- await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
- await priorHook
-
- args =
- (await hook({
- args,
- collection: args.collection.config,
- context: args.req.context,
- operation: 'update',
- })) || args
- }, Promise.resolve())
-
- const {
- id,
- autosave = false,
- collection: { config: collectionConfig },
- collection,
- depth,
- draft: draftArg = false,
- overrideAccess,
- overwriteExistingFiles = false,
- req: {
- locale,
- payload: { config },
- payload,
- },
- req,
- showHiddenFields,
- } = args
-
try {
- const shouldCommit = await initTransaction(req)
+ const shouldCommit = await initTransaction(args.req)
+
+ // /////////////////////////////////////
+ // beforeOperation - Collection
+ // /////////////////////////////////////
+
+ await args.collection.config.hooks.beforeOperation.reduce(async (priorHook, hook) => {
+ await priorHook
+
+ args =
+ (await hook({
+ args,
+ collection: args.collection.config,
+ context: args.req.context,
+ operation: 'update',
+ req: args.req,
+ })) || args
+ }, Promise.resolve())
+
+ const {
+ id,
+ autosave = false,
+ collection: { config: collectionConfig },
+ collection,
+ depth,
+ draft: draftArg = false,
+ overrideAccess,
+ overwriteExistingFiles = false,
+ req: {
+ fallbackLocale,
+ locale,
+ payload: { config },
+ payload,
+
+ },
+ req,
+ showHiddenFields,
+ } = args
if (!id) {
throw new APIError('Missing ID of document to update.', httpStatus.BAD_REQUEST)
@@ -128,7 +131,9 @@ export const updateByIDOperation = async = {
update: typeof updateOperation // todo: pass correct generic
updateByID: typeof updateByIDOperation // todo: pass correct generic
}
-export type AfterOperationArg =
+export type AfterOperationArg = {
+ /** The collection which this hook is being run on */
+ collection: SanitizedCollectionConfig
+ req: PayloadRequest
+} & (
| {
args: Parameters['create']>[0]
- /** The collection which this hook is being run on */
- collection: SanitizedCollectionConfig
operation: 'create'
result: Awaited['create']>>
}
| {
args: Parameters['delete']>[0]
- /** The collection which this hook is being run on */
- collection: SanitizedCollectionConfig
operation: 'delete'
result: Awaited['delete']>>
}
| {
args: Parameters['deleteByID']>[0]
- /** The collection which this hook is being run on */
- collection: SanitizedCollectionConfig
operation: 'deleteByID'
result: Awaited['deleteByID']>>
}
| {
args: Parameters['find']>[0]
- /** The collection which this hook is being run on */
- collection: SanitizedCollectionConfig
operation: 'find'
result: Awaited['find']>>
}
| {
args: Parameters['findByID']>[0]
- /** The collection which this hook is being run on */
- collection: SanitizedCollectionConfig
operation: 'findByID'
result: Awaited['findByID']>>
}
| {
args: Parameters['forgotPassword']>[0]
- /** The collection which this hook is being run on */
- collection: SanitizedCollectionConfig
operation: 'forgotPassword'
result: Awaited['forgotPassword']>>
}
| {
args: Parameters['login']>[0]
- /** The collection which this hook is being run on */
- collection: SanitizedCollectionConfig
operation: 'login'
result: Awaited['login']>>
}
| {
args: Parameters['refresh']>[0]
- /** The collection which this hook is being run on */
- collection: SanitizedCollectionConfig
operation: 'refresh'
result: Awaited['refresh']>>
}
| {
args: Parameters['update']>[0]
- /** The collection which this hook is being run on */
- collection: SanitizedCollectionConfig
operation: 'update'
result: Awaited['update']>>
}
| {
args: Parameters['updateByID']>[0]
- /** The collection which this hook is being run on */
- collection: SanitizedCollectionConfig
operation: 'updateByID'
result: Awaited['updateByID']>>
}
+)
// export type AfterOperationHook = typeof buildAfterOperation;
@@ -100,7 +86,7 @@ export const buildAfterOperation = async <
T extends TypeWithID = any,
O extends keyof AfterOperationMap = keyof AfterOperationMap,
>(
- operationArgs: AfterOperationArg & { operation: O },
+ operationArgs: Omit, 'req'> & { operation: O },
): Promise[O]>>> => {
const { args, collection, operation, result } = operationArgs
@@ -114,6 +100,7 @@ export const buildAfterOperation = async <
args,
collection,
operation,
+ req: args.req,
result: newResult,
} as AfterOperationArg)
diff --git a/packages/payload/src/config/schema.ts b/packages/payload/src/config/schema.ts
index b9d2f343511..ae17e3f6cab 100644
--- a/packages/payload/src/config/schema.ts
+++ b/packages/payload/src/config/schema.ts
@@ -136,6 +136,7 @@ export default joi.object({
joi.array().items(
joi.object().keys({
code: joi.string(),
+ fallbackLocale: joi.string(),
label: joi
.alternatives()
.try(
diff --git a/packages/payload/src/config/types.ts b/packages/payload/src/config/types.ts
index 1ec3898a50f..e4c1b576514 100644
--- a/packages/payload/src/config/types.ts
+++ b/packages/payload/src/config/types.ts
@@ -7,7 +7,6 @@ import type SMTPConnection from 'nodemailer/lib/smtp-connection'
import type { DestinationStream, LoggerOptions } from 'pino'
import type React from 'react'
import type { DeepRequired } from 'ts-essentials'
-// @ts-ignore-next-line
import type { Payload } from '..'
import type { DocumentTab, RichTextAdapter } from '../admin/types'
@@ -22,8 +21,8 @@ import type {
import type { DatabaseAdapterResult } from '../database/types'
import type { ClientConfigField } from '../fields/config/types'
import type { GlobalConfig, Globals, SanitizedGlobalConfig } from '../globals/config/types'
-import type { PayloadRequest } from '../types'
-import type { Where } from '../types'
+import type { PayloadRequest, Where } from '../types'
+import type { PayloadLogger } from '../utilities/logger'
export type BinScriptConfig = {
key: string
@@ -169,6 +168,12 @@ export type InitOptions = {
/** Express app for Payload to use */
express?: Express
+ /**
+ * A previously instantiated logger instance. Must conform to the PayloadLogger interface which uses Pino
+ * This allows you to bring your own logger instance and let payload use it
+ */
+ logger?: PayloadLogger
+
loggerDestination?: DestinationStream
/**
@@ -232,6 +237,7 @@ export type PayloadHandler = (req: PayloadRequest) => Promise | Respon
export type Endpoint = {
/** Extension point to add your custom data. */
custom?: Record
+
/**
* Middleware that will be called when the path/method matches
*
diff --git a/packages/payload/src/database/createDatabaseAdapter.ts b/packages/payload/src/database/createDatabaseAdapter.ts
index 97300090eff..ad08b199a5d 100644
--- a/packages/payload/src/database/createDatabaseAdapter.ts
+++ b/packages/payload/src/database/createDatabaseAdapter.ts
@@ -39,7 +39,7 @@ export function createDatabaseAdapter(
createMigration,
migrate,
migrateDown,
- migrateFresh: async () => null,
+ migrateFresh: async ({ forceAcceptWarning = null }) => null,
migrateRefresh,
migrateReset,
migrateStatus,
diff --git a/packages/payload/src/database/getLocalizedPaths.ts b/packages/payload/src/database/getLocalizedPaths.ts
index 049b5544802..d3c51ae8b17 100644
--- a/packages/payload/src/database/getLocalizedPaths.ts
+++ b/packages/payload/src/database/getLocalizedPaths.ts
@@ -62,6 +62,17 @@ export async function getLocalizedPaths({
return paths
}
+ if (!matchedField && currentPath === 'id' && i === pathSegments.length - 1) {
+ lastIncompletePath.path = currentPath
+ const idField: Field = {
+ name: 'id',
+ type: payload.db.defaultIDType as 'text',
+ }
+ lastIncompletePath.field = idField
+ lastIncompletePath.complete = true
+ return paths
+ }
+
if (matchedField) {
if ('hidden' in matchedField && matchedField.hidden && !overrideAccess) {
lastIncompletePath.invalid = true
@@ -96,9 +107,9 @@ export async function getLocalizedPaths({
// If this is a polymorphic relation,
// We only support querying directly (no nested querying)
if (typeof matchedField.relationTo !== 'string') {
- const lastSegmentIsValid = ['relationTo', 'value'].includes(
- pathSegments[pathSegments.length - 1],
- )
+ const lastSegmentIsValid =
+ ['relationTo', 'value'].includes(pathSegments[pathSegments.length - 1]) ||
+ pathSegments.length === 1
if (lastSegmentIsValid) {
lastIncompletePath.complete = true
diff --git a/packages/payload/src/database/migrations/migrate.ts b/packages/payload/src/database/migrations/migrate.ts
index fada301c54f..87094c78df7 100644
--- a/packages/payload/src/database/migrations/migrate.ts
+++ b/packages/payload/src/database/migrations/migrate.ts
@@ -2,6 +2,9 @@
import type { PayloadRequest } from '../../types'
import type { BaseDatabaseAdapter } from '../types'
+import { commitTransaction } from '../../utilities/commitTransaction'
+import { initTransaction } from '../../utilities/initTransaction'
+import { killTransaction } from '../../utilities/killTransaction'
import { getMigrations } from './getMigrations'
import { readMigrationFiles } from './readMigrationFiles'
@@ -24,13 +27,13 @@ export async function migrate(this: BaseDatabaseAdapter): Promise {
}
const start = Date.now()
- let transactionID: number | string | undefined
+ const req = { payload } as PayloadRequest
payload.logger.info({ msg: `Migrating: ${migration.name}` })
try {
- transactionID = await this.beginTransaction()
- await migration.up({ payload })
+ await initTransaction(req)
+ await migration.up({ payload, req })
payload.logger.info({ msg: `Migrated: ${migration.name} (${Date.now() - start}ms)` })
await payload.create({
collection: 'payload-migrations',
@@ -38,11 +41,11 @@ export async function migrate(this: BaseDatabaseAdapter): Promise {
name: migration.name,
batch: newBatch,
},
- ...(transactionID && { req: { transactionID } as PayloadRequest }),
+ req,
})
- await this.commitTransaction(transactionID)
+ await commitTransaction(req)
} catch (err: unknown) {
- await this.rollbackTransaction(transactionID)
+ await killTransaction(req)
payload.logger.error({ err, msg: `Error running migration ${migration.name}` })
throw err
}
diff --git a/packages/payload/src/database/migrations/migrateDown.ts b/packages/payload/src/database/migrations/migrateDown.ts
index b9fef7b6a5d..7b48229fb8c 100644
--- a/packages/payload/src/database/migrations/migrateDown.ts
+++ b/packages/payload/src/database/migrations/migrateDown.ts
@@ -2,6 +2,9 @@
import type { PayloadRequest } from '../../types'
import type { BaseDatabaseAdapter } from '../types'
+import { commitTransaction } from '../../utilities/commitTransaction'
+import { initTransaction } from '../../utilities/initTransaction'
+import { killTransaction } from '../../utilities/killTransaction'
import { getMigrations } from './getMigrations'
import { readMigrationFiles } from './readMigrationFiles'
@@ -22,19 +25,21 @@ export async function migrateDown(this: BaseDatabaseAdapter): Promise {
msg: `Rolling back batch ${latestBatch} consisting of ${existingMigrations.length} migration(s).`,
})
- for (const migration of existingMigrations) {
+ const latestBatchMigrations = existingMigrations.filter(({ batch }) => batch === latestBatch)
+
+ for (const migration of latestBatchMigrations) {
const migrationFile = migrationFiles.find((m) => m.name === migration.name)
if (!migrationFile) {
throw new Error(`Migration ${migration.name} not found locally.`)
}
const start = Date.now()
- let transactionID
+ const req = { payload } as PayloadRequest
try {
payload.logger.info({ msg: `Migrating down: ${migrationFile.name}` })
- transactionID = await this.beginTransaction()
- await migrationFile.down({ payload })
+ await initTransaction(req)
+ await migrationFile.down({ payload, req })
payload.logger.info({
msg: `Migrated down: ${migrationFile.name} (${Date.now() - start}ms)`,
})
@@ -42,13 +47,12 @@ export async function migrateDown(this: BaseDatabaseAdapter): Promise {
await payload.delete({
id: migration.id,
collection: 'payload-migrations',
- req: {
- transactionID,
- } as PayloadRequest,
+ req,
})
- await this.commitTransaction(transactionID)
+
+ await commitTransaction(req)
} catch (err: unknown) {
- await this.rollbackTransaction(transactionID)
+ await killTransaction(req)
payload.logger.error({
err,
msg: `Error running migration ${migrationFile.name}`,
diff --git a/packages/payload/src/database/migrations/migrateRefresh.ts b/packages/payload/src/database/migrations/migrateRefresh.ts
index cdb9ccd73e6..0a71cf11be8 100644
--- a/packages/payload/src/database/migrations/migrateRefresh.ts
+++ b/packages/payload/src/database/migrations/migrateRefresh.ts
@@ -2,6 +2,9 @@
import type { PayloadRequest } from '../../types'
import type { BaseDatabaseAdapter } from '../types'
+import { commitTransaction } from '../../utilities/commitTransaction'
+import { initTransaction } from '../../utilities/initTransaction'
+import { killTransaction } from '../../utilities/killTransaction'
import { getMigrations } from './getMigrations'
import { readMigrationFiles } from './readMigrationFiles'
@@ -25,7 +28,7 @@ export async function migrateRefresh(this: BaseDatabaseAdapter) {
msg: `Rolling back batch ${latestBatch} consisting of ${existingMigrations.length} migration(s).`,
})
- let transactionID
+ const req = { payload } as PayloadRequest
// Reverse order of migrations to rollback
existingMigrations.reverse()
@@ -39,16 +42,14 @@ export async function migrateRefresh(this: BaseDatabaseAdapter) {
payload.logger.info({ msg: `Migrating down: ${migration.name}` })
const start = Date.now()
- transactionID = await this.beginTransaction()
- await migrationFile.down({ payload })
+ await initTransaction(req)
+ await migrationFile.down({ payload, req })
payload.logger.info({
msg: `Migrated down: ${migration.name} (${Date.now() - start}ms)`,
})
await payload.delete({
collection: 'payload-migrations',
- req: {
- transactionID,
- } as PayloadRequest,
+ req,
where: {
name: {
equals: migration.name,
@@ -56,7 +57,7 @@ export async function migrateRefresh(this: BaseDatabaseAdapter) {
},
})
} catch (err: unknown) {
- await this.rollbackTransaction(transactionID)
+ await killTransaction(req)
let msg = `Error running migration ${migration.name}. Rolling back.`
if (err instanceof Error) {
msg += ` ${err.message}`
@@ -74,23 +75,21 @@ export async function migrateRefresh(this: BaseDatabaseAdapter) {
payload.logger.info({ msg: `Migrating: ${migration.name}` })
try {
const start = Date.now()
- transactionID = await this.beginTransaction()
- await migration.up({ payload })
+ await initTransaction(req)
+ await migration.up({ payload, req })
await payload.create({
collection: 'payload-migrations',
data: {
name: migration.name,
executed: true,
},
- req: {
- transactionID,
- } as PayloadRequest,
+ req,
})
- await this.commitTransaction(transactionID)
+ await commitTransaction(req)
payload.logger.info({ msg: `Migrated: ${migration.name} (${Date.now() - start}ms)` })
} catch (err: unknown) {
- await this.rollbackTransaction(transactionID)
+ await killTransaction(req)
let msg = `Error running migration ${migration.name}. Rolling back.`
if (err instanceof Error) {
msg += ` ${err.message}`
diff --git a/packages/payload/src/database/migrations/migrateReset.ts b/packages/payload/src/database/migrations/migrateReset.ts
index f1575c4c667..2e40fba4c29 100644
--- a/packages/payload/src/database/migrations/migrateReset.ts
+++ b/packages/payload/src/database/migrations/migrateReset.ts
@@ -2,6 +2,9 @@
import type { PayloadRequest } from '../../types'
import type { BaseDatabaseAdapter } from '../types'
+import { commitTransaction } from '../../utilities/commitTransaction'
+import { initTransaction } from '../../utilities/initTransaction'
+import { killTransaction } from '../../utilities/killTransaction'
import { getMigrations } from './getMigrations'
import { readMigrationFiles } from './readMigrationFiles'
@@ -16,7 +19,7 @@ export async function migrateReset(this: BaseDatabaseAdapter): Promise {
return
}
- let transactionID
+ const req = { payload } as PayloadRequest
// Rollback all migrations in order
for (const migration of migrationFiles) {
@@ -28,21 +31,21 @@ export async function migrateReset(this: BaseDatabaseAdapter): Promise {
payload.logger.info({ msg: `Migrating down: ${migration.name}` })
try {
const start = Date.now()
- transactionID = await this.beginTransaction()
- await migration.down({ payload })
+ await initTransaction(req)
+ await migration.down({ payload, req })
await payload.delete({
collection: 'payload-migrations',
- req: { transactionID } as PayloadRequest,
+ req,
where: {
id: {
equals: existingMigration.id,
},
},
})
- await this.commitTransaction(transactionID)
+ await commitTransaction(req)
payload.logger.info({ msg: `Migrated down: ${migration.name} (${Date.now() - start}ms)` })
} catch (err: unknown) {
- await this.rollbackTransaction(transactionID)
+ await killTransaction(req)
payload.logger.error({ err, msg: `Error running migration ${migration.name}` })
throw err
}
diff --git a/packages/payload/src/database/migrations/migrationTemplate.ts b/packages/payload/src/database/migrations/migrationTemplate.ts
index ab5f4fa6e32..b5add526422 100644
--- a/packages/payload/src/database/migrations/migrationTemplate.ts
+++ b/packages/payload/src/database/migrations/migrationTemplate.ts
@@ -4,11 +4,11 @@ import {
MigrateDownArgs,
} from "@payloadcms/db-mongodb";
-export async function up({ payload }: MigrateUpArgs): Promise {
+export async function up({ payload, req }: MigrateUpArgs): Promise {
// Migration code
};
-export async function down({ payload }: MigrateDownArgs): Promise {
+export async function down({ payload, req }: MigrateDownArgs): Promise {
// Migration code
};
`
diff --git a/packages/payload/src/database/migrations/migrationsCollection.ts b/packages/payload/src/database/migrations/migrationsCollection.ts
index 8ec99e33bd2..6202618c119 100644
--- a/packages/payload/src/database/migrations/migrationsCollection.ts
+++ b/packages/payload/src/database/migrations/migrationsCollection.ts
@@ -1,9 +1,11 @@
import type { CollectionConfig } from '../../collections/config/types'
export const migrationsCollection: CollectionConfig = {
+ slug: 'payload-migrations',
admin: {
hidden: true,
},
+ endpoints: false,
fields: [
{
name: 'name',
@@ -14,22 +16,6 @@ export const migrationsCollection: CollectionConfig = {
type: 'number',
// NOTE: This value is -1 if it is a "dev push"
},
- // TODO: do we need to persist the indexes separate from the schema?
- // {
- // name: 'indexes',
- // type: 'array',
- // fields: [
- // {
- // name: 'index',
- // type: 'text',
- // },
- // {
- // name: 'value',
- // type: 'json',
- // },
- // ],
- // },
],
graphQL: false,
- slug: 'payload-migrations',
}
diff --git a/packages/payload/src/database/types.ts b/packages/payload/src/database/types.ts
index 58ed1c6bd55..7cf9f2cb814 100644
--- a/packages/payload/src/database/types.ts
+++ b/packages/payload/src/database/types.ts
@@ -78,7 +78,7 @@ export interface BaseDatabaseAdapter {
/**
* Drop the current database and run all migrate up functions
*/
- migrateFresh: () => Promise
+ migrateFresh: (args: { forceAcceptWarning?: boolean }) => Promise
/**
* Run all migration down functions before running up
*/
@@ -116,8 +116,8 @@ export interface BaseDatabaseAdapter {
sessions?: {
[id: string]: {
db: unknown
- reject: () => void
- resolve: () => void
+ reject: () => Promise
+ resolve: () => Promise
}
}
@@ -138,6 +138,10 @@ export type Destroy = (payload: Payload) => Promise
export type CreateMigration = (args: {
file?: string
+ /**
+ * Skips the prompt asking to create empty migrations
+ */
+ forceAcceptWarning?: boolean
migrationName?: string
payload: Payload
}) => Promise
@@ -377,8 +381,8 @@ export type DeleteManyArgs = {
export type DeleteMany = (args: DeleteManyArgs) => Promise
export type Migration = MigrationData & {
- down: ({ payload }: { payload }) => Promise
- up: ({ payload }: { payload }) => Promise
+ down: ({ payload, req }: { payload: Payload; req: PayloadRequest }) => Promise
+ up: ({ payload, req }: { payload: Payload; req: PayloadRequest }) => Promise
}
export type MigrationData = {
diff --git a/packages/payload/src/exports/components/utilities.ts b/packages/payload/src/exports/components/utilities.ts
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/packages/payload/src/exports/types.ts b/packages/payload/src/exports/types.ts
index 035f8c71dba..e48279cdc19 100644
--- a/packages/payload/src/exports/types.ts
+++ b/packages/payload/src/exports/types.ts
@@ -90,6 +90,7 @@ export {
fieldHasSubFields,
fieldIsArrayType,
fieldIsBlockType,
+ fieldIsGroupType,
fieldIsLocalized,
fieldIsPresentationalOnly,
fieldSupportsMany,
diff --git a/packages/payload/src/exports/utilities.ts b/packages/payload/src/exports/utilities.ts
index cbd560b4568..29f2e82fbb6 100644
--- a/packages/payload/src/exports/utilities.ts
+++ b/packages/payload/src/exports/utilities.ts
@@ -29,6 +29,7 @@ export { default as getUniqueListBy } from '../utilities/getUniqueListBy'
export { isEntityHidden } from '../utilities/isEntityHidden'
export { isNumber } from '../utilities/isNumber'
export { isValidID } from '../utilities/isValidID'
+export { default as isolateObjectProperty } from '../utilities/isolateObjectProperty'
export { setsAreEqual } from '../utilities/setsAreEqual'
export { splitPathByArrayFields } from '../utilities/splitPathByArrayFields'
diff --git a/packages/payload/src/express/middleware/errorHandler.ts b/packages/payload/src/express/middleware/errorHandler.ts
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/packages/payload/src/express/middleware/index.ts b/packages/payload/src/express/middleware/index.ts
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/packages/payload/src/fields/config/schema.ts b/packages/payload/src/fields/config/schema.ts
index dbbb6b29852..298fbcf5909 100644
--- a/packages/payload/src/fields/config/schema.ts
+++ b/packages/payload/src/fields/config/schema.ts
@@ -83,8 +83,11 @@ export const text = baseField.keys({
rtl: joi.boolean(),
}),
defaultValue: joi.alternatives().try(joi.string(), joi.func()),
+ hasMany: joi.boolean().default(false),
maxLength: joi.number(),
+ maxRows: joi.number().when('hasMany', { is: joi.not(true), then: joi.forbidden() }),
minLength: joi.number(),
+ minRows: joi.number().when('hasMany', { is: joi.not(true), then: joi.forbidden() }),
type: joi.string().valid('text').required(),
})
@@ -174,6 +177,7 @@ export const json = baseField.keys({
Error: componentSchema,
Label: componentSchema,
}),
+ editorOptions: joi.object().unknown(), // Editor['options'] @monaco-editor/react
}),
defaultValue: joi.alternatives().try(joi.array(), joi.object()),
type: joi.string().valid('json').required(),
@@ -412,6 +416,7 @@ export const blocks = baseField.keys({
.try(joi.string(), joi.object().pattern(joi.string(), [joi.string()])),
}),
slug: joi.string().required(),
+ custom: joi.object().pattern(joi.string(), joi.any()),
}),
)
.required(),
diff --git a/packages/payload/src/fields/config/types.ts b/packages/payload/src/fields/config/types.ts
index 3b48dc348be..ef70cfac499 100644
--- a/packages/payload/src/fields/config/types.ts
+++ b/packages/payload/src/fields/config/types.ts
@@ -41,8 +41,9 @@ export type FieldHookArgs = {
originalDoc?: T
/** The document before changes were applied, only in `afterChange` hooks. */
previousDoc?: T
- /** The sibling data from the previous document in `afterChange` hook. */
+ /** The sibling data of the document before changes being applied, only in `beforeChange` and `afterChange` hook. */
previousSiblingDoc?: T
+ /** The previous value of the field, before changes, only in `beforeChange` and `afterChange` hooks. */
previousValue?: P
/** The Express request object. It is mocked for Local API operations. */
req: PayloadRequest
@@ -227,7 +228,24 @@ export type TextField = FieldBase & {
maxLength?: number
minLength?: number
type: 'text'
-}
+} & (
+ | {
+ /** Makes this field an ordered array of strings instead of just a single string. */
+ hasMany: true
+ /** Maximum number of strings in the strings array, if `hasMany` is set to true. */
+ maxRows?: number
+ /** Minimum number of strings in the strings array, if `hasMany` is set to true. */
+ minRows?: number
+ }
+ | {
+ /** Makes this field an ordered array of strings instead of just a single string. */
+ hasMany?: false | undefined
+ /** Maximum number of strings in the strings array, if `hasMany` is set to true. */
+ maxRows?: undefined
+ /** Minimum number of strings in the strings array, if `hasMany` is set to true. */
+ minRows?: undefined
+ }
+ )
export type EmailField = FieldBase & {
admin?: Admin & {
@@ -508,7 +526,7 @@ export type RichTextField<
ExtraProperties = {},
> = FieldBase & {
admin?: Admin
- editor?: RichTextAdapter
+ editor: RichTextAdapter
type: 'richText'
} & ExtraProperties
@@ -562,6 +580,8 @@ export type Block = {
interfaceName?: string
labels?: Labels
slug: string
+ /** Extension point to add your custom data. */
+ custom?: Record
}
export type BlockField = FieldBase & {
@@ -676,6 +696,10 @@ export function fieldIsBlockType(field: Field): field is BlockField {
return field.type === 'blocks'
}
+export function fieldIsGroupType(field: Field): field is GroupField {
+ return field.type === 'group'
+}
+
export function optionIsObject(option: Option): option is OptionObject {
return typeof option === 'object'
}
diff --git a/packages/payload/src/fields/hooks/afterRead/index.ts b/packages/payload/src/fields/hooks/afterRead/index.ts
index e41597e423e..9c4e33f557f 100644
--- a/packages/payload/src/fields/hooks/afterRead/index.ts
+++ b/packages/payload/src/fields/hooks/afterRead/index.ts
@@ -11,9 +11,11 @@ type Args = {
currentDepth?: number
depth: number
doc: Record