From 0711f880ff57ff09eb7f33c3cf9a870e3387fa68 Mon Sep 17 00:00:00 2001 From: Jarrod Flesch <30633324+JarrodMFlesch@users.noreply.github.com> Date: Tue, 2 Jul 2024 09:47:03 -0400 Subject: [PATCH] chore!: simplify api handler (#6910) Removes PayloadRequestWithData in favour of just PayloadRequest with optional types for `data` and `locale` `addDataAndFileToRequest` and `addLocalesToRequestFromData` now takes in a single argument instead of an object ```ts // before await addDataAndFileToRequest({ request: req }) addLocalesToRequestFromData({ request: req }) // current await addDataAndFileToRequest(req) addLocalesToRequestFromData(req) ``` --------- Co-authored-by: Paul Popus --- docs/rest-api/overview.mdx | 82 ++++++++++- .../_components/HydrateClientUser/index.tsx | 4 +- packages/db-mongodb/src/count.ts | 4 +- packages/db-mongodb/src/create.ts | 4 +- packages/db-mongodb/src/createGlobal.ts | 4 +- .../db-mongodb/src/createGlobalVersion.ts | 12 +- packages/db-mongodb/src/createVersion.ts | 4 +- packages/db-mongodb/src/deleteMany.ts | 4 +- packages/db-mongodb/src/deleteOne.ts | 4 +- packages/db-mongodb/src/deleteVersions.ts | 4 +- packages/db-mongodb/src/find.ts | 13 +- packages/db-mongodb/src/findGlobal.ts | 4 +- packages/db-mongodb/src/findGlobalVersions.ts | 4 +- packages/db-mongodb/src/findOne.ts | 4 +- packages/db-mongodb/src/findVersions.ts | 4 +- packages/db-mongodb/src/migrateFresh.ts | 4 +- packages/db-mongodb/src/queryDrafts.ts | 13 +- packages/db-mongodb/src/updateGlobal.ts | 4 +- .../db-mongodb/src/updateGlobalVersion.ts | 4 +- packages/db-mongodb/src/updateOne.ts | 4 +- packages/db-mongodb/src/updateVersion.ts | 4 +- packages/db-postgres/src/createGlobal.ts | 4 +- .../db-postgres/src/createGlobalVersion.ts | 9 +- packages/db-postgres/src/createVersion.ts | 9 +- packages/db-postgres/src/deleteMany.ts | 4 +- packages/db-postgres/src/deleteOne.ts | 4 +- packages/db-postgres/src/deleteVersions.ts | 4 +- packages/db-postgres/src/find.ts | 4 +- packages/db-postgres/src/find/findMany.ts | 4 +- .../db-postgres/src/findGlobalVersions.ts | 4 +- packages/db-postgres/src/findOne.ts | 9 +- packages/db-postgres/src/findVersions.ts | 4 +- packages/db-postgres/src/migrate.ts | 4 +- packages/db-postgres/src/migrateDown.ts | 4 +- packages/db-postgres/src/migrateFresh.ts | 4 +- packages/db-postgres/src/migrateRefresh.ts | 4 +- packages/db-postgres/src/migrateReset.ts | 4 +- .../v2-v3/fetchAndResave/index.ts | 4 +- .../src/predefinedMigrations/v2-v3/index.ts | 4 +- .../v2-v3/migrateRelationships.ts | 6 +- packages/db-postgres/src/queryDrafts.ts | 13 +- packages/db-postgres/src/types.ts | 6 +- packages/db-postgres/src/updateGlobal.ts | 4 +- .../db-postgres/src/updateGlobalVersion.ts | 4 +- packages/db-postgres/src/updateVersion.ts | 4 +- packages/db-postgres/src/upsertRow/types.ts | 4 +- .../src/resolvers/collections/count.ts | 4 +- .../src/resolvers/collections/create.ts | 4 +- .../src/resolvers/collections/delete.ts | 9 +- .../src/resolvers/collections/docAccess.ts | 9 +- .../src/resolvers/collections/duplicate.ts | 9 +- .../graphql/src/resolvers/collections/find.ts | 4 +- .../src/resolvers/collections/findByID.ts | 9 +- .../resolvers/collections/findVersionByID.ts | 4 +- .../src/resolvers/collections/findVersions.ts | 4 +- .../resolvers/collections/restoreVersion.ts | 4 +- .../src/resolvers/collections/update.ts | 9 +- .../src/resolvers/globals/docAccess.ts | 4 +- .../src/resolvers/globals/findVersionByID.ts | 4 +- .../src/resolvers/globals/findVersions.ts | 4 +- .../src/resolvers/globals/restoreVersion.ts | 4 +- .../graphql/src/resolvers/globals/update.ts | 9 +- packages/graphql/src/resolvers/types.ts | 4 +- .../src/utilities/wrapCustomResolver.ts | 4 +- packages/next/src/routes/graphql/handler.ts | 16 +-- .../next/src/routes/rest/buildFormState.ts | 4 +- .../src/routes/rest/files/checkFileAccess.ts | 4 +- .../next/src/routes/rest/files/getFile.ts | 4 +- packages/next/src/routes/rest/index.ts | 132 ++++++++---------- packages/next/src/routes/rest/og/index.tsx | 4 +- packages/next/src/routes/rest/routeError.ts | 4 +- packages/next/src/routes/rest/types.ts | 16 +-- .../src/utilities/addDataAndFileToRequest.ts | 44 +++--- .../next/src/utilities/addLocalesToRequest.ts | 26 +--- .../next/src/utilities/headersWithCors.ts | 4 +- packages/next/src/utilities/initPage/index.ts | 4 +- .../src/views/Document/getDocumentData.tsx | 4 +- .../src/views/Edit/Default/Auth/APIKey.tsx | 4 +- .../ForgotPasswordForm/index.tsx | 4 +- .../next/src/views/Login/LoginForm/index.tsx | 6 +- packages/payload/src/admin/RichText.ts | 6 +- packages/payload/src/admin/views/types.ts | 4 +- packages/payload/src/auth/defaultAccess.ts | 4 +- packages/payload/src/auth/executeAccess.ts | 4 +- packages/payload/src/auth/getAccessResults.ts | 4 +- packages/payload/src/auth/getFieldsToSign.ts | 4 +- .../payload/src/auth/operations/access.ts | 4 +- packages/payload/src/auth/operations/auth.ts | 6 +- .../src/auth/operations/forgotPassword.ts | 4 +- packages/payload/src/auth/operations/init.ts | 4 +- .../payload/src/auth/operations/local/auth.ts | 4 +- .../auth/operations/local/forgotPassword.ts | 4 +- .../src/auth/operations/local/login.ts | 4 +- .../auth/operations/local/resetPassword.ts | 4 +- .../src/auth/operations/local/unlock.ts | 4 +- .../src/auth/operations/local/verifyEmail.ts | 4 +- packages/payload/src/auth/operations/login.ts | 4 +- .../payload/src/auth/operations/logout.ts | 4 +- packages/payload/src/auth/operations/me.ts | 4 +- .../payload/src/auth/operations/refresh.ts | 4 +- .../src/auth/operations/registerFirstUser.ts | 4 +- .../src/auth/operations/resetPassword.ts | 4 +- .../payload/src/auth/operations/unlock.ts | 4 +- .../src/auth/operations/verifyEmail.ts | 4 +- .../payload/src/auth/sendVerificationEmail.ts | 4 +- .../local/incrementLoginAttempts.ts | 4 +- .../src/auth/strategies/local/register.ts | 4 +- .../strategies/local/resetLoginAttempts.ts | 4 +- packages/payload/src/auth/types.ts | 10 +- .../payload/src/collections/config/types.ts | 30 ++-- .../payload/src/collections/dataloader.ts | 4 +- .../src/collections/operations/count.ts | 6 +- .../src/collections/operations/create.ts | 6 +- .../src/collections/operations/delete.ts | 4 +- .../src/collections/operations/deleteByID.ts | 4 +- .../src/collections/operations/docAccess.ts | 4 +- .../src/collections/operations/duplicate.ts | 4 +- .../src/collections/operations/find.ts | 4 +- .../src/collections/operations/findByID.ts | 6 +- .../collections/operations/findVersionByID.ts | 4 +- .../collections/operations/findVersions.ts | 4 +- .../src/collections/operations/local/count.ts | 9 +- .../collections/operations/local/create.ts | 4 +- .../collections/operations/local/delete.ts | 9 +- .../collections/operations/local/duplicate.ts | 4 +- .../src/collections/operations/local/find.ts | 9 +- .../collections/operations/local/findByID.ts | 4 +- .../operations/local/findVersionByID.ts | 4 +- .../operations/local/findVersions.ts | 9 +- .../operations/local/restoreVersion.ts | 4 +- .../collections/operations/local/update.ts | 9 +- .../collections/operations/restoreVersion.ts | 4 +- .../src/collections/operations/update.ts | 4 +- .../src/collections/operations/updateByID.ts | 4 +- .../src/collections/operations/utils.ts | 4 +- packages/payload/src/config/types.ts | 6 +- .../src/database/migrations/migrate.ts | 4 +- .../src/database/migrations/migrateDown.ts | 4 +- .../src/database/migrations/migrateRefresh.ts | 4 +- .../src/database/migrations/migrateReset.ts | 4 +- .../queryValidation/validateQueryPaths.ts | 10 +- .../queryValidation/validateSearchParams.ts | 4 +- packages/payload/src/database/types.ts | 40 +++--- packages/payload/src/fields/config/types.ts | 12 +- .../payload/src/fields/getDefaultValue.ts | 4 +- .../src/fields/hooks/afterChange/index.ts | 4 +- .../src/fields/hooks/afterChange/promise.ts | 4 +- .../hooks/afterChange/traverseFields.ts | 4 +- .../src/fields/hooks/afterRead/index.ts | 4 +- .../src/fields/hooks/afterRead/promise.ts | 4 +- .../relationshipPopulationPromise.ts | 6 +- .../fields/hooks/afterRead/traverseFields.ts | 4 +- .../src/fields/hooks/beforeChange/index.ts | 4 +- .../src/fields/hooks/beforeChange/promise.ts | 4 +- .../hooks/beforeChange/traverseFields.ts | 4 +- .../src/fields/hooks/beforeValidate/index.ts | 4 +- .../fields/hooks/beforeValidate/promise.ts | 4 +- .../hooks/beforeValidate/traverseFields.ts | 4 +- packages/payload/src/globals/config/types.ts | 14 +- .../src/globals/operations/docAccess.ts | 4 +- .../payload/src/globals/operations/findOne.ts | 4 +- .../src/globals/operations/findVersionByID.ts | 4 +- .../src/globals/operations/findVersions.ts | 4 +- .../src/globals/operations/local/findOne.ts | 4 +- .../operations/local/findVersionByID.ts | 4 +- .../globals/operations/local/findVersions.ts | 4 +- .../operations/local/restoreVersion.ts | 4 +- .../src/globals/operations/local/update.ts | 4 +- .../src/globals/operations/restoreVersion.ts | 4 +- .../payload/src/globals/operations/update.ts | 4 +- .../src/preferences/deleteUserPreferences.ts | 4 +- .../src/preferences/requestHandlers/delete.ts | 4 +- .../preferences/requestHandlers/findOne.ts | 4 +- .../src/preferences/requestHandlers/update.ts | 4 +- packages/payload/src/preferences/types.ts | 6 +- packages/payload/src/types/index.ts | 21 ++- .../src/uploads/deleteAssociatedFiles.ts | 4 +- .../src/uploads/docWithFilenameExists.ts | 4 +- .../payload/src/uploads/generateFileData.ts | 6 +- .../payload/src/uploads/getExternalFile.ts | 4 +- packages/payload/src/uploads/getFileByPath.ts | 4 +- packages/payload/src/uploads/getImageSize.ts | 4 +- .../payload/src/uploads/getSafeFilename.ts | 4 +- packages/payload/src/uploads/imageResizer.ts | 6 +- packages/payload/src/uploads/types.ts | 4 +- .../payload/src/uploads/unlinkTempFiles.ts | 4 +- packages/payload/src/uploads/uploadFiles.ts | 4 +- .../src/utilities/commitTransaction.ts | 4 +- .../payload/src/utilities/createLocalReq.ts | 12 +- .../src/utilities/getEntityPolicies.ts | 4 +- .../payload/src/utilities/initTransaction.ts | 4 +- .../payload/src/utilities/isEntityHidden.ts | 4 +- .../payload/src/utilities/killTransaction.ts | 4 +- .../utilities/telemetry/events/adminInit.ts | 4 +- .../src/versions/deleteCollectionVersions.ts | 4 +- .../drafts/replaceWithDraftIfAvailable.ts | 4 +- .../src/versions/enforceMaxVersions.ts | 4 +- .../versions/getLatestCollectionVersion.ts | 4 +- .../src/versions/getLatestGlobalVersion.ts | 4 +- packages/payload/src/versions/saveVersion.ts | 4 +- packages/plugin-cloud-storage/src/types.ts | 8 +- .../src/utilities/getFilePrefix.ts | 4 +- .../src/utilities/getIncomingFiles.ts | 4 +- .../plugin-cloud/src/hooks/uploadCache.ts | 8 +- packages/plugin-cloud/src/types.ts | 14 +- .../src/utilities/getIncomingFiles.ts | 4 +- .../src/hooks/resaveChildren.ts | 4 +- packages/plugin-search/src/types.ts | 9 +- packages/plugin-seo/src/index.tsx | 37 ++--- packages/plugin-stripe/src/routes/rest.ts | 6 +- .../src/features/typesServer.ts | 14 +- .../src/populateGraphQL/populate.ts | 4 +- .../recursivelyPopulateFieldsForGraphQL.ts | 4 +- packages/richtext-slate/src/data/populate.ts | 4 +- .../src/data/recurseNestedFields.ts | 4 +- .../src/data/richTextRelationshipPromise.ts | 4 +- .../src/elements/HydrateClientUser/index.tsx | 4 +- .../addFieldStatePromise.ts | 4 +- .../src/forms/buildStateFromSchema/index.tsx | 4 +- .../buildStateFromSchema/iterateFields.ts | 4 +- packages/ui/src/utilities/buildFormState.ts | 16 +-- test/access-control/int.spec.ts | 4 +- test/database/int.spec.ts | 10 +- test/helpers/reInit.ts | 4 +- test/helpers/sdk/endpoint.ts | 6 +- test/hooks/collections/ContextHooks/index.ts | 4 +- test/plugin-form-builder/seed/index.ts | 4 +- test/plugin-search/seed/index.ts | 4 +- test/plugin-seo/seed/index.ts | 4 +- test/plugin-stripe/seed/index.ts | 4 +- test/relationships/int.spec.ts | 4 +- 231 files changed, 737 insertions(+), 815 deletions(-) diff --git a/docs/rest-api/overview.mdx b/docs/rest-api/overview.mdx index 73282afce..790f84bd0 100644 --- a/docs/rest-api/overview.mdx +++ b/docs/rest-api/overview.mdx @@ -598,15 +598,37 @@ export const Orders: CollectionConfig = { { path: '/:id/tracking', method: 'get', - handler: async (req, res, next) => { + handler: (req) => { const tracking = await getTrackingInfo(req.params.id) - if (tracking) { - res.status(200).send({ tracking }) - } else { - res.status(404).send({ error: 'not found' }) + + if (!tracking) { + return Response.json({ error: 'not found' }, { status: 404}) } + + return Response.json({ + message: `Hello ${req.routeParams.name as string} @ ${req.routeParams.group as string}`, + }) }, }, + { + path: '/:id/tracking', + method: 'post', + handler: (req) => { + // `data` is not automatically appended to the request + // if you would like to read the body of the request + // you can use `data = await req.json()` + const data = await req.json() + await req.payload.update({ + collection: 'tracking', + data: { + // data to update the document with + } + }) + return Response.json({ + message: 'successfully updated tracking info' + }) + } + } ], // highlight-end } @@ -619,6 +641,56 @@ export const Orders: CollectionConfig = { calls like req.payload.find() that will make use of access control and hooks. +#### Helpful tips +`req.data` + +Data is not automatically appended to the request. You can read the body data by calling `await req.json()`. + +Or you could use our helper function that mutates the request and appends data and file if found. + +```ts +import { addDataAndFileToRequest } from '@payloadcms/next/utilities' + +// custom endpoint example +{ + path: '/:id/tracking', + method: 'post', + handler: (req) => { + await addDataAndFileToRequest(req) + await req.payload.update({ + collection: 'tracking', + data: { + // data to update the document with + } + }) + return Response.json({ + message: 'successfully updated tracking info' + }) + } +} +``` + +`req.locale` & `req.fallbackLocale` + +The locale and the fallback locale are not automatically appended to custom endpoint requests. If you would like to add them you can use this helper function. + +```ts +import { addLocalesToRequestFromData } from '@payloadcms/next/utilities' + +// custom endpoint example +{ + path: '/:id/tracking', + method: 'post', + handler: (req) => { + await addLocalesToRequestFromData(req) + // you now can access req.locale & req.fallbackLocale + return Response.json({ message: 'success' }) + } +} +``` + + + ## 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. diff --git a/examples/auth/payload/src/app/(app)/_components/HydrateClientUser/index.tsx b/examples/auth/payload/src/app/(app)/_components/HydrateClientUser/index.tsx index 6dca3e563..01ffd7d4f 100644 --- a/examples/auth/payload/src/app/(app)/_components/HydrateClientUser/index.tsx +++ b/examples/auth/payload/src/app/(app)/_components/HydrateClientUser/index.tsx @@ -1,7 +1,7 @@ 'use client' import type { Permissions } from 'payload/auth' -import type { PayloadRequestWithData } from 'payload/types' +import type { PayloadRequest } from 'payload/types' import { useEffect } from 'react' @@ -9,7 +9,7 @@ import { useAuth } from '../../_providers/Auth' export const HydrateClientUser: React.FC<{ permissions: Permissions - user: PayloadRequestWithData['user'] + user: PayloadRequest['user'] }> = ({ permissions, user }) => { const { setPermissions, setUser } = useAuth() diff --git a/packages/db-mongodb/src/count.ts b/packages/db-mongodb/src/count.ts index 7f684d45d..91408408d 100644 --- a/packages/db-mongodb/src/count.ts +++ b/packages/db-mongodb/src/count.ts @@ -1,5 +1,5 @@ import type { QueryOptions } from 'mongoose' -import type { Count, PayloadRequestWithData } from 'payload' +import type { Count, PayloadRequest } from 'payload' import { flattenWhereToOperators } from 'payload' @@ -9,7 +9,7 @@ import { withSession } from './withSession.js' export const count: Count = async function count( this: MongooseAdapter, - { collection, locale, req = {} as PayloadRequestWithData, where }, + { collection, locale, req = {} as PayloadRequest, where }, ) { const Model = this.collections[collection] const options: QueryOptions = withSession(this, req.transactionID) diff --git a/packages/db-mongodb/src/create.ts b/packages/db-mongodb/src/create.ts index cc71697cc..621b82e96 100644 --- a/packages/db-mongodb/src/create.ts +++ b/packages/db-mongodb/src/create.ts @@ -1,4 +1,4 @@ -import type { Create, Document, PayloadRequestWithData } from 'payload' +import type { Create, Document, PayloadRequest } from 'payload' import type { MongooseAdapter } from './index.js' @@ -7,7 +7,7 @@ import { withSession } from './withSession.js' export const create: Create = async function create( this: MongooseAdapter, - { collection, data, req = {} as PayloadRequestWithData }, + { collection, data, req = {} as PayloadRequest }, ) { const Model = this.collections[collection] const options = withSession(this, req.transactionID) diff --git a/packages/db-mongodb/src/createGlobal.ts b/packages/db-mongodb/src/createGlobal.ts index 67fb560c2..9f75a6876 100644 --- a/packages/db-mongodb/src/createGlobal.ts +++ b/packages/db-mongodb/src/createGlobal.ts @@ -1,4 +1,4 @@ -import type { CreateGlobal, PayloadRequestWithData } from 'payload' +import type { CreateGlobal, PayloadRequest } from 'payload' import type { MongooseAdapter } from './index.js' @@ -7,7 +7,7 @@ import { withSession } from './withSession.js' export const createGlobal: CreateGlobal = async function createGlobal( this: MongooseAdapter, - { slug, data, req = {} as PayloadRequestWithData }, + { slug, data, req = {} as PayloadRequest }, ) { const Model = this.globals const global = { diff --git a/packages/db-mongodb/src/createGlobalVersion.ts b/packages/db-mongodb/src/createGlobalVersion.ts index f93dfb800..71d196d45 100644 --- a/packages/db-mongodb/src/createGlobalVersion.ts +++ b/packages/db-mongodb/src/createGlobalVersion.ts @@ -1,4 +1,4 @@ -import type { CreateGlobalVersion, Document, PayloadRequestWithData } from 'payload' +import type { CreateGlobalVersion, Document, PayloadRequest } from 'payload' import type { MongooseAdapter } from './index.js' @@ -6,15 +6,7 @@ import { withSession } from './withSession.js' export const createGlobalVersion: CreateGlobalVersion = async function createGlobalVersion( this: MongooseAdapter, - { - autosave, - createdAt, - globalSlug, - parent, - req = {} as PayloadRequestWithData, - updatedAt, - versionData, - }, + { autosave, createdAt, globalSlug, parent, req = {} as PayloadRequest, updatedAt, versionData }, ) { const VersionModel = this.versions[globalSlug] const options = withSession(this, req.transactionID) diff --git a/packages/db-mongodb/src/createVersion.ts b/packages/db-mongodb/src/createVersion.ts index 8d096c0a6..8cdb36b5e 100644 --- a/packages/db-mongodb/src/createVersion.ts +++ b/packages/db-mongodb/src/createVersion.ts @@ -1,4 +1,4 @@ -import type { CreateVersion, Document, PayloadRequestWithData } from 'payload' +import type { CreateVersion, Document, PayloadRequest } from 'payload' import type { MongooseAdapter } from './index.js' @@ -11,7 +11,7 @@ export const createVersion: CreateVersion = async function createVersion( collectionSlug, createdAt, parent, - req = {} as PayloadRequestWithData, + req = {} as PayloadRequest, updatedAt, versionData, }, diff --git a/packages/db-mongodb/src/deleteMany.ts b/packages/db-mongodb/src/deleteMany.ts index bc14df489..eee1bb088 100644 --- a/packages/db-mongodb/src/deleteMany.ts +++ b/packages/db-mongodb/src/deleteMany.ts @@ -1,4 +1,4 @@ -import type { DeleteMany, PayloadRequestWithData } from 'payload' +import type { DeleteMany, PayloadRequest } from 'payload' import type { MongooseAdapter } from './index.js' @@ -6,7 +6,7 @@ import { withSession } from './withSession.js' export const deleteMany: DeleteMany = async function deleteMany( this: MongooseAdapter, - { collection, req = {} as PayloadRequestWithData, where }, + { collection, req = {} as PayloadRequest, where }, ) { const Model = this.collections[collection] const options = { diff --git a/packages/db-mongodb/src/deleteOne.ts b/packages/db-mongodb/src/deleteOne.ts index b0888eaa8..f22373de2 100644 --- a/packages/db-mongodb/src/deleteOne.ts +++ b/packages/db-mongodb/src/deleteOne.ts @@ -1,4 +1,4 @@ -import type { DeleteOne, Document, PayloadRequestWithData } from 'payload' +import type { DeleteOne, Document, PayloadRequest } from 'payload' import type { MongooseAdapter } from './index.js' @@ -7,7 +7,7 @@ import { withSession } from './withSession.js' export const deleteOne: DeleteOne = async function deleteOne( this: MongooseAdapter, - { collection, req = {} as PayloadRequestWithData, where }, + { collection, req = {} as PayloadRequest, where }, ) { const Model = this.collections[collection] const options = withSession(this, req.transactionID) diff --git a/packages/db-mongodb/src/deleteVersions.ts b/packages/db-mongodb/src/deleteVersions.ts index 1b845f60d..90486dcc6 100644 --- a/packages/db-mongodb/src/deleteVersions.ts +++ b/packages/db-mongodb/src/deleteVersions.ts @@ -1,4 +1,4 @@ -import type { DeleteVersions, PayloadRequestWithData } from 'payload' +import type { DeleteVersions, PayloadRequest } from 'payload' import type { MongooseAdapter } from './index.js' @@ -6,7 +6,7 @@ import { withSession } from './withSession.js' export const deleteVersions: DeleteVersions = async function deleteVersions( this: MongooseAdapter, - { collection, locale, req = {} as PayloadRequestWithData, where }, + { collection, locale, req = {} as PayloadRequest, where }, ) { const VersionsModel = this.versions[collection] const options = { diff --git a/packages/db-mongodb/src/find.ts b/packages/db-mongodb/src/find.ts index b92056cdb..0a668c78c 100644 --- a/packages/db-mongodb/src/find.ts +++ b/packages/db-mongodb/src/find.ts @@ -1,5 +1,5 @@ import type { PaginateOptions } from 'mongoose' -import type { Find, PayloadRequestWithData } from 'payload' +import type { Find, PayloadRequest } from 'payload' import { flattenWhereToOperators } from 'payload' @@ -11,16 +11,7 @@ import { withSession } from './withSession.js' export const find: Find = async function find( this: MongooseAdapter, - { - collection, - limit, - locale, - page, - pagination, - req = {} as PayloadRequestWithData, - sort: sortArg, - where, - }, + { collection, limit, locale, page, pagination, req = {} as PayloadRequest, sort: sortArg, where }, ) { const Model = this.collections[collection] const collectionConfig = this.payload.collections[collection].config diff --git a/packages/db-mongodb/src/findGlobal.ts b/packages/db-mongodb/src/findGlobal.ts index 63b105013..3a89508b7 100644 --- a/packages/db-mongodb/src/findGlobal.ts +++ b/packages/db-mongodb/src/findGlobal.ts @@ -1,4 +1,4 @@ -import type { FindGlobal, PayloadRequestWithData } from 'payload' +import type { FindGlobal, PayloadRequest } from 'payload' import { combineQueries } from 'payload' @@ -9,7 +9,7 @@ import { withSession } from './withSession.js' export const findGlobal: FindGlobal = async function findGlobal( this: MongooseAdapter, - { slug, locale, req = {} as PayloadRequestWithData, where }, + { slug, locale, req = {} as PayloadRequest, where }, ) { const Model = this.globals const options = { diff --git a/packages/db-mongodb/src/findGlobalVersions.ts b/packages/db-mongodb/src/findGlobalVersions.ts index f55ae3d15..b61c63817 100644 --- a/packages/db-mongodb/src/findGlobalVersions.ts +++ b/packages/db-mongodb/src/findGlobalVersions.ts @@ -1,5 +1,5 @@ import type { PaginateOptions } from 'mongoose' -import type { FindGlobalVersions, PayloadRequestWithData } from 'payload' +import type { FindGlobalVersions, PayloadRequest } from 'payload' import { buildVersionGlobalFields, flattenWhereToOperators } from 'payload' @@ -17,7 +17,7 @@ export const findGlobalVersions: FindGlobalVersions = async function findGlobalV locale, page, pagination, - req = {} as PayloadRequestWithData, + req = {} as PayloadRequest, skip, sort: sortArg, where, diff --git a/packages/db-mongodb/src/findOne.ts b/packages/db-mongodb/src/findOne.ts index 01ac89edd..bc1e7e56d 100644 --- a/packages/db-mongodb/src/findOne.ts +++ b/packages/db-mongodb/src/findOne.ts @@ -1,5 +1,5 @@ import type { MongooseQueryOptions } from 'mongoose' -import type { Document, FindOne, PayloadRequestWithData } from 'payload' +import type { Document, FindOne, PayloadRequest } from 'payload' import type { MongooseAdapter } from './index.js' @@ -8,7 +8,7 @@ import { withSession } from './withSession.js' export const findOne: FindOne = async function findOne( this: MongooseAdapter, - { collection, locale, req = {} as PayloadRequestWithData, where }, + { collection, locale, req = {} as PayloadRequest, where }, ) { const Model = this.collections[collection] const options: MongooseQueryOptions = { diff --git a/packages/db-mongodb/src/findVersions.ts b/packages/db-mongodb/src/findVersions.ts index fe919e10f..7e26fc393 100644 --- a/packages/db-mongodb/src/findVersions.ts +++ b/packages/db-mongodb/src/findVersions.ts @@ -1,5 +1,5 @@ import type { PaginateOptions } from 'mongoose' -import type { FindVersions, PayloadRequestWithData } from 'payload' +import type { FindVersions, PayloadRequest } from 'payload' import { flattenWhereToOperators } from 'payload' @@ -17,7 +17,7 @@ export const findVersions: FindVersions = async function findVersions( locale, page, pagination, - req = {} as PayloadRequestWithData, + req = {} as PayloadRequest, skip, sort: sortArg, where, diff --git a/packages/db-mongodb/src/migrateFresh.ts b/packages/db-mongodb/src/migrateFresh.ts index 28c69f641..c8207fbfd 100644 --- a/packages/db-mongodb/src/migrateFresh.ts +++ b/packages/db-mongodb/src/migrateFresh.ts @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' import { commitTransaction, initTransaction, killTransaction, readMigrationFiles } from 'payload' import prompts from 'prompts' @@ -45,7 +45,7 @@ export async function migrateFresh( msg: `Found ${migrationFiles.length} migration files.`, }) - const req = { payload } as PayloadRequestWithData + const req = { payload } as PayloadRequest // Run all migrate up for (const migration of migrationFiles) { diff --git a/packages/db-mongodb/src/queryDrafts.ts b/packages/db-mongodb/src/queryDrafts.ts index 707aa470d..30d27799b 100644 --- a/packages/db-mongodb/src/queryDrafts.ts +++ b/packages/db-mongodb/src/queryDrafts.ts @@ -1,5 +1,5 @@ import type { PaginateOptions } from 'mongoose' -import type { PayloadRequestWithData, QueryDrafts } from 'payload' +import type { PayloadRequest, QueryDrafts } from 'payload' import { combineQueries, flattenWhereToOperators } from 'payload' @@ -11,16 +11,7 @@ import { withSession } from './withSession.js' export const queryDrafts: QueryDrafts = async function queryDrafts( this: MongooseAdapter, - { - collection, - limit, - locale, - page, - pagination, - req = {} as PayloadRequestWithData, - sort: sortArg, - where, - }, + { collection, limit, locale, page, pagination, req = {} as PayloadRequest, sort: sortArg, where }, ) { const VersionModel = this.versions[collection] const collectionConfig = this.payload.collections[collection].config diff --git a/packages/db-mongodb/src/updateGlobal.ts b/packages/db-mongodb/src/updateGlobal.ts index 6a65cff19..8c1af6d77 100644 --- a/packages/db-mongodb/src/updateGlobal.ts +++ b/packages/db-mongodb/src/updateGlobal.ts @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData, UpdateGlobal } from 'payload' +import type { PayloadRequest, UpdateGlobal } from 'payload' import type { MongooseAdapter } from './index.js' @@ -7,7 +7,7 @@ import { withSession } from './withSession.js' export const updateGlobal: UpdateGlobal = async function updateGlobal( this: MongooseAdapter, - { slug, data, req = {} as PayloadRequestWithData }, + { slug, data, req = {} as PayloadRequest }, ) { const Model = this.globals const options = { diff --git a/packages/db-mongodb/src/updateGlobalVersion.ts b/packages/db-mongodb/src/updateGlobalVersion.ts index 32fdb5b84..f0e98d43c 100644 --- a/packages/db-mongodb/src/updateGlobalVersion.ts +++ b/packages/db-mongodb/src/updateGlobalVersion.ts @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData, TypeWithID, UpdateGlobalVersionArgs } from 'payload' +import type { PayloadRequest, TypeWithID, UpdateGlobalVersionArgs } from 'payload' import type { MongooseAdapter } from './index.js' @@ -10,7 +10,7 @@ export async function updateGlobalVersion( id, global, locale, - req = {} as PayloadRequestWithData, + req = {} as PayloadRequest, versionData, where, }: UpdateGlobalVersionArgs, diff --git a/packages/db-mongodb/src/updateOne.ts b/packages/db-mongodb/src/updateOne.ts index 64484a2fd..4155c9fd2 100644 --- a/packages/db-mongodb/src/updateOne.ts +++ b/packages/db-mongodb/src/updateOne.ts @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData, UpdateOne } from 'payload' +import type { PayloadRequest, UpdateOne } from 'payload' import type { MongooseAdapter } from './index.js' @@ -8,7 +8,7 @@ import { withSession } from './withSession.js' export const updateOne: UpdateOne = async function updateOne( this: MongooseAdapter, - { id, collection, data, locale, req = {} as PayloadRequestWithData, where: whereArg }, + { id, collection, data, locale, req = {} as PayloadRequest, where: whereArg }, ) { const where = id ? { id: { equals: id } } : whereArg const Model = this.collections[collection] diff --git a/packages/db-mongodb/src/updateVersion.ts b/packages/db-mongodb/src/updateVersion.ts index 5add9f0cf..793d11124 100644 --- a/packages/db-mongodb/src/updateVersion.ts +++ b/packages/db-mongodb/src/updateVersion.ts @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData, UpdateVersion } from 'payload' +import type { PayloadRequest, UpdateVersion } from 'payload' import type { MongooseAdapter } from './index.js' @@ -6,7 +6,7 @@ import { withSession } from './withSession.js' export const updateVersion: UpdateVersion = async function updateVersion( this: MongooseAdapter, - { id, collection, locale, req = {} as PayloadRequestWithData, versionData, where }, + { id, collection, locale, req = {} as PayloadRequest, versionData, where }, ) { const VersionModel = this.versions[collection] const whereToUse = where || { id: { equals: id } } diff --git a/packages/db-postgres/src/createGlobal.ts b/packages/db-postgres/src/createGlobal.ts index 86549f940..3b0107633 100644 --- a/packages/db-postgres/src/createGlobal.ts +++ b/packages/db-postgres/src/createGlobal.ts @@ -1,4 +1,4 @@ -import type { CreateGlobalArgs, PayloadRequestWithData } from 'payload' +import type { CreateGlobalArgs, PayloadRequest } from 'payload' import toSnakeCase from 'to-snake-case' @@ -8,7 +8,7 @@ import { upsertRow } from './upsertRow/index.js' export async function createGlobal>( this: PostgresAdapter, - { slug, data, req = {} as PayloadRequestWithData }: CreateGlobalArgs, + { slug, data, req = {} as PayloadRequest }: CreateGlobalArgs, ): Promise { const db = this.sessions[req.transactionID]?.db || this.drizzle const globalConfig = this.payload.globals.config.find((config) => config.slug === slug) diff --git a/packages/db-postgres/src/createGlobalVersion.ts b/packages/db-postgres/src/createGlobalVersion.ts index f7708671b..0494f1c26 100644 --- a/packages/db-postgres/src/createGlobalVersion.ts +++ b/packages/db-postgres/src/createGlobalVersion.ts @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData, TypeWithID, TypeWithVersion } from 'payload' +import type { PayloadRequest, TypeWithID, TypeWithVersion } from 'payload' import { sql } from 'drizzle-orm' import { type CreateGlobalVersionArgs, buildVersionGlobalFields } from 'payload' @@ -10,12 +10,7 @@ import { upsertRow } from './upsertRow/index.js' export async function createGlobalVersion( this: PostgresAdapter, - { - autosave, - globalSlug, - req = {} as PayloadRequestWithData, - versionData, - }: CreateGlobalVersionArgs, + { autosave, globalSlug, req = {} as PayloadRequest, versionData }: CreateGlobalVersionArgs, ) { const db = this.sessions[req.transactionID]?.db || this.drizzle const global = this.payload.globals.config.find(({ slug }) => slug === globalSlug) diff --git a/packages/db-postgres/src/createVersion.ts b/packages/db-postgres/src/createVersion.ts index 46ccf6640..839615d54 100644 --- a/packages/db-postgres/src/createVersion.ts +++ b/packages/db-postgres/src/createVersion.ts @@ -1,9 +1,4 @@ -import type { - CreateVersionArgs, - PayloadRequestWithData, - TypeWithID, - TypeWithVersion, -} from 'payload' +import type { CreateVersionArgs, PayloadRequest, TypeWithID, TypeWithVersion } from 'payload' import { sql } from 'drizzle-orm' import { buildVersionCollectionFields } from 'payload' @@ -19,7 +14,7 @@ export async function createVersion( autosave, collectionSlug, parent, - req = {} as PayloadRequestWithData, + req = {} as PayloadRequest, versionData, }: CreateVersionArgs, ) { diff --git a/packages/db-postgres/src/deleteMany.ts b/packages/db-postgres/src/deleteMany.ts index cabc03ab2..b385375e5 100644 --- a/packages/db-postgres/src/deleteMany.ts +++ b/packages/db-postgres/src/deleteMany.ts @@ -1,4 +1,4 @@ -import type { DeleteMany, PayloadRequestWithData } from 'payload' +import type { DeleteMany, PayloadRequest } from 'payload' import { inArray } from 'drizzle-orm' import toSnakeCase from 'to-snake-case' @@ -9,7 +9,7 @@ import { findMany } from './find/findMany.js' export const deleteMany: DeleteMany = async function deleteMany( this: PostgresAdapter, - { collection, req = {} as PayloadRequestWithData, where }, + { collection, req = {} as PayloadRequest, where }, ) { const db = this.sessions[req.transactionID]?.db || this.drizzle const collectionConfig = this.payload.collections[collection].config diff --git a/packages/db-postgres/src/deleteOne.ts b/packages/db-postgres/src/deleteOne.ts index 71de14685..87603d94b 100644 --- a/packages/db-postgres/src/deleteOne.ts +++ b/packages/db-postgres/src/deleteOne.ts @@ -1,4 +1,4 @@ -import type { DeleteOne, PayloadRequestWithData } from 'payload' +import type { DeleteOne, PayloadRequest } from 'payload' import { eq } from 'drizzle-orm' import toSnakeCase from 'to-snake-case' @@ -12,7 +12,7 @@ import { transform } from './transform/read/index.js' export const deleteOne: DeleteOne = async function deleteOne( this: PostgresAdapter, - { collection: collectionSlug, req = {} as PayloadRequestWithData, where: whereArg }, + { collection: collectionSlug, req = {} as PayloadRequest, where: whereArg }, ) { const db = this.sessions[req.transactionID]?.db || this.drizzle const collection = this.payload.collections[collectionSlug].config diff --git a/packages/db-postgres/src/deleteVersions.ts b/packages/db-postgres/src/deleteVersions.ts index 45b23a2ca..239b9a8fa 100644 --- a/packages/db-postgres/src/deleteVersions.ts +++ b/packages/db-postgres/src/deleteVersions.ts @@ -1,4 +1,4 @@ -import type { DeleteVersions, PayloadRequestWithData, SanitizedCollectionConfig } from 'payload' +import type { DeleteVersions, PayloadRequest, SanitizedCollectionConfig } from 'payload' import { inArray } from 'drizzle-orm' import { buildVersionCollectionFields } from 'payload' @@ -10,7 +10,7 @@ import { findMany } from './find/findMany.js' export const deleteVersions: DeleteVersions = async function deleteVersion( this: PostgresAdapter, - { collection, locale, req = {} as PayloadRequestWithData, where: where }, + { collection, locale, req = {} as PayloadRequest, where: where }, ) { const db = this.sessions[req.transactionID]?.db || this.drizzle const collectionConfig: SanitizedCollectionConfig = this.payload.collections[collection].config diff --git a/packages/db-postgres/src/find.ts b/packages/db-postgres/src/find.ts index 58bb1209b..5a22ced2f 100644 --- a/packages/db-postgres/src/find.ts +++ b/packages/db-postgres/src/find.ts @@ -1,4 +1,4 @@ -import type { Find, PayloadRequestWithData, SanitizedCollectionConfig } from 'payload' +import type { Find, PayloadRequest, SanitizedCollectionConfig } from 'payload' import toSnakeCase from 'to-snake-case' @@ -14,7 +14,7 @@ export const find: Find = async function find( locale, page = 1, pagination, - req = {} as PayloadRequestWithData, + req = {} as PayloadRequest, sort: sortArg, where, }, diff --git a/packages/db-postgres/src/find/findMany.ts b/packages/db-postgres/src/find/findMany.ts index 857c32392..a8f0fe9ce 100644 --- a/packages/db-postgres/src/find/findMany.ts +++ b/packages/db-postgres/src/find/findMany.ts @@ -1,4 +1,4 @@ -import type { Field, FindArgs, PayloadRequestWithData, TypeWithID } from 'payload' +import type { Field, FindArgs, PayloadRequest, TypeWithID } from 'payload' import { inArray, sql } from 'drizzle-orm' @@ -24,7 +24,7 @@ export const findMany = async function find({ locale, page = 1, pagination, - req = {} as PayloadRequestWithData, + req = {} as PayloadRequest, skip, sort, tableName, diff --git a/packages/db-postgres/src/findGlobalVersions.ts b/packages/db-postgres/src/findGlobalVersions.ts index 9fcf5325a..0c174fb24 100644 --- a/packages/db-postgres/src/findGlobalVersions.ts +++ b/packages/db-postgres/src/findGlobalVersions.ts @@ -1,4 +1,4 @@ -import type { FindGlobalVersions, PayloadRequestWithData, SanitizedGlobalConfig } from 'payload' +import type { FindGlobalVersions, PayloadRequest, SanitizedGlobalConfig } from 'payload' import { buildVersionGlobalFields } from 'payload' import toSnakeCase from 'to-snake-case' @@ -15,7 +15,7 @@ export const findGlobalVersions: FindGlobalVersions = async function findGlobalV locale, page, pagination, - req = {} as PayloadRequestWithData, + req = {} as PayloadRequest, skip, sort: sortArg, where, diff --git a/packages/db-postgres/src/findOne.ts b/packages/db-postgres/src/findOne.ts index 7856a1730..e491d8c7c 100644 --- a/packages/db-postgres/src/findOne.ts +++ b/packages/db-postgres/src/findOne.ts @@ -1,9 +1,4 @@ -import type { - FindOneArgs, - PayloadRequestWithData, - SanitizedCollectionConfig, - TypeWithID, -} from 'payload' +import type { FindOneArgs, PayloadRequest, SanitizedCollectionConfig, TypeWithID } from 'payload' import toSnakeCase from 'to-snake-case' @@ -13,7 +8,7 @@ import { findMany } from './find/findMany.js' export async function findOne( this: PostgresAdapter, - { collection, locale, req = {} as PayloadRequestWithData, where }: FindOneArgs, + { collection, locale, req = {} as PayloadRequest, where }: FindOneArgs, ): Promise { const collectionConfig: SanitizedCollectionConfig = this.payload.collections[collection].config diff --git a/packages/db-postgres/src/findVersions.ts b/packages/db-postgres/src/findVersions.ts index 6b89aadf4..ff5a50ae1 100644 --- a/packages/db-postgres/src/findVersions.ts +++ b/packages/db-postgres/src/findVersions.ts @@ -1,4 +1,4 @@ -import type { FindVersions, PayloadRequestWithData, SanitizedCollectionConfig } from 'payload' +import type { FindVersions, PayloadRequest, SanitizedCollectionConfig } from 'payload' import { buildVersionCollectionFields } from 'payload' import toSnakeCase from 'to-snake-case' @@ -15,7 +15,7 @@ export const findVersions: FindVersions = async function findVersions( locale, page, pagination, - req = {} as PayloadRequestWithData, + req = {} as PayloadRequest, skip, sort: sortArg, where, diff --git a/packages/db-postgres/src/migrate.ts b/packages/db-postgres/src/migrate.ts index b96bb496f..7d9e99989 100644 --- a/packages/db-postgres/src/migrate.ts +++ b/packages/db-postgres/src/migrate.ts @@ -1,6 +1,6 @@ /* eslint-disable no-restricted-syntax, no-await-in-loop */ import type { Payload } from 'payload' -import type { PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' import type { Migration } from 'payload' import { createRequire } from 'module' @@ -83,7 +83,7 @@ async function runMigrationFile(payload: Payload, migration: Migration, batch: n const { generateDrizzleJson } = require('drizzle-kit/payload') const start = Date.now() - const req = { payload } as PayloadRequestWithData + const req = { payload } as PayloadRequest payload.logger.info({ msg: `Migrating: ${migration.name}` }) diff --git a/packages/db-postgres/src/migrateDown.ts b/packages/db-postgres/src/migrateDown.ts index e3fde11ae..5ae47debf 100644 --- a/packages/db-postgres/src/migrateDown.ts +++ b/packages/db-postgres/src/migrateDown.ts @@ -1,5 +1,5 @@ /* eslint-disable no-restricted-syntax, no-await-in-loop */ -import type { PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' import { commitTransaction, @@ -40,7 +40,7 @@ export async function migrateDown(this: PostgresAdapter): Promise { } const start = Date.now() - const req = { payload } as PayloadRequestWithData + const req = { payload } as PayloadRequest try { payload.logger.info({ msg: `Migrating down: ${migrationFile.name}` }) diff --git a/packages/db-postgres/src/migrateFresh.ts b/packages/db-postgres/src/migrateFresh.ts index 014e8bd99..4b7fb30c7 100644 --- a/packages/db-postgres/src/migrateFresh.ts +++ b/packages/db-postgres/src/migrateFresh.ts @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' import { sql } from 'drizzle-orm' import { commitTransaction, initTransaction, killTransaction, readMigrationFiles } from 'payload' @@ -51,7 +51,7 @@ export async function migrateFresh( msg: `Found ${migrationFiles.length} migration files.`, }) - const req = { payload } as PayloadRequestWithData + const req = { payload } as PayloadRequest // Run all migrate up for (const migration of migrationFiles) { payload.logger.info({ msg: `Migrating: ${migration.name}` }) diff --git a/packages/db-postgres/src/migrateRefresh.ts b/packages/db-postgres/src/migrateRefresh.ts index 500b5cc03..cf4270a2e 100644 --- a/packages/db-postgres/src/migrateRefresh.ts +++ b/packages/db-postgres/src/migrateRefresh.ts @@ -1,5 +1,5 @@ /* eslint-disable no-restricted-syntax, no-await-in-loop */ -import type { PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' import { commitTransaction, @@ -34,7 +34,7 @@ export async function migrateRefresh(this: PostgresAdapter) { msg: `Rolling back batch ${latestBatch} consisting of ${existingMigrations.length} migration(s).`, }) - const req = { payload } as PayloadRequestWithData + const req = { payload } as PayloadRequest // Reverse order of migrations to rollback existingMigrations.reverse() diff --git a/packages/db-postgres/src/migrateReset.ts b/packages/db-postgres/src/migrateReset.ts index ddec94373..932835ce6 100644 --- a/packages/db-postgres/src/migrateReset.ts +++ b/packages/db-postgres/src/migrateReset.ts @@ -1,5 +1,5 @@ /* eslint-disable no-restricted-syntax, no-await-in-loop */ -import type { PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' import { commitTransaction, @@ -27,7 +27,7 @@ export async function migrateReset(this: PostgresAdapter): Promise { return } - const req = { payload } as PayloadRequestWithData + const req = { payload } as PayloadRequest // Rollback all migrations in order for (const migration of existingMigrations) { diff --git a/packages/db-postgres/src/predefinedMigrations/v2-v3/fetchAndResave/index.ts b/packages/db-postgres/src/predefinedMigrations/v2-v3/fetchAndResave/index.ts index 7aa8e0856..f1514c449 100644 --- a/packages/db-postgres/src/predefinedMigrations/v2-v3/fetchAndResave/index.ts +++ b/packages/db-postgres/src/predefinedMigrations/v2-v3/fetchAndResave/index.ts @@ -1,4 +1,4 @@ -import type { Field, Payload, PayloadRequestWithData } from 'payload' +import type { Field, Payload, PayloadRequest } from 'payload' import type { DrizzleTransaction, PostgresAdapter } from '../../../types.js' import type { DocsToResave } from '../types.js' @@ -16,7 +16,7 @@ type Args = { globalSlug?: string isVersions: boolean payload: Payload - req: PayloadRequestWithData + req: PayloadRequest tableName: string } diff --git a/packages/db-postgres/src/predefinedMigrations/v2-v3/index.ts b/packages/db-postgres/src/predefinedMigrations/v2-v3/index.ts index d4bfa1d99..3b556070f 100644 --- a/packages/db-postgres/src/predefinedMigrations/v2-v3/index.ts +++ b/packages/db-postgres/src/predefinedMigrations/v2-v3/index.ts @@ -1,5 +1,5 @@ import type { DrizzleSnapshotJSON } from 'drizzle-kit/payload' -import type { Payload, PayloadRequestWithData } from 'payload' +import type { Payload, PayloadRequest } from 'payload' import { sql } from 'drizzle-orm' import fs from 'fs' @@ -19,7 +19,7 @@ const require = createRequire(import.meta.url) type Args = { debug?: boolean payload: Payload - req?: Partial + req?: Partial } /** diff --git a/packages/db-postgres/src/predefinedMigrations/v2-v3/migrateRelationships.ts b/packages/db-postgres/src/predefinedMigrations/v2-v3/migrateRelationships.ts index 4d73a0d6f..ddc4ed444 100644 --- a/packages/db-postgres/src/predefinedMigrations/v2-v3/migrateRelationships.ts +++ b/packages/db-postgres/src/predefinedMigrations/v2-v3/migrateRelationships.ts @@ -1,4 +1,4 @@ -import type { Field, Payload, PayloadRequestWithData } from 'payload' +import type { Field, Payload, PayloadRequest } from 'payload' import { sql } from 'drizzle-orm' @@ -17,7 +17,7 @@ type Args = { isVersions: boolean pathsToQuery: PathsToQuery payload: Payload - req?: Partial + req?: Partial tableName: string } @@ -88,7 +88,7 @@ export const migrateRelationships = async ({ globalSlug, isVersions, payload, - req: req as unknown as PayloadRequestWithData, + req: req as unknown as PayloadRequest, tableName, }) } diff --git a/packages/db-postgres/src/queryDrafts.ts b/packages/db-postgres/src/queryDrafts.ts index b1d957e7d..f12fc215e 100644 --- a/packages/db-postgres/src/queryDrafts.ts +++ b/packages/db-postgres/src/queryDrafts.ts @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData, SanitizedCollectionConfig } from 'payload' +import type { PayloadRequest, SanitizedCollectionConfig } from 'payload' import { type QueryDrafts, buildVersionCollectionFields, combineQueries } from 'payload' import toSnakeCase from 'to-snake-case' @@ -9,16 +9,7 @@ import { findMany } from './find/findMany.js' export const queryDrafts: QueryDrafts = async function queryDrafts( this: PostgresAdapter, - { - collection, - limit, - locale, - page = 1, - pagination, - req = {} as PayloadRequestWithData, - sort, - where, - }, + { collection, limit, locale, page = 1, pagination, req = {} as PayloadRequest, sort, where }, ) { const collectionConfig: SanitizedCollectionConfig = this.payload.collections[collection].config const tableName = this.tableNameMap.get( diff --git a/packages/db-postgres/src/types.ts b/packages/db-postgres/src/types.ts index 0832304d6..1be568826 100644 --- a/packages/db-postgres/src/types.ts +++ b/packages/db-postgres/src/types.ts @@ -15,7 +15,7 @@ import type { PgTransaction, } from 'drizzle-orm/pg-core' import type { PgTableFn } from 'drizzle-orm/pg-core/table' -import type { BaseDatabaseAdapter, Payload, PayloadRequestWithData } from 'payload' +import type { BaseDatabaseAdapter, Payload, PayloadRequest } from 'payload' import type { Pool, PoolConfig } from 'pg' export type DrizzleDB = NodePgDatabase> @@ -96,8 +96,8 @@ export type IDType = 'integer' | 'numeric' | 'uuid' | 'varchar' export type PostgresAdapterResult = (args: { payload: Payload }) => PostgresAdapter -export type MigrateUpArgs = { payload: Payload; req?: Partial } -export type MigrateDownArgs = { payload: Payload; req?: Partial } +export type MigrateUpArgs = { payload: Payload; req?: Partial } +export type MigrateDownArgs = { payload: Payload; req?: Partial } declare module 'payload' { export interface DatabaseAdapter diff --git a/packages/db-postgres/src/updateGlobal.ts b/packages/db-postgres/src/updateGlobal.ts index a77151e35..285feee3a 100644 --- a/packages/db-postgres/src/updateGlobal.ts +++ b/packages/db-postgres/src/updateGlobal.ts @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData, UpdateGlobalArgs } from 'payload' +import type { PayloadRequest, UpdateGlobalArgs } from 'payload' import toSnakeCase from 'to-snake-case' @@ -8,7 +8,7 @@ import { upsertRow } from './upsertRow/index.js' export async function updateGlobal>( this: PostgresAdapter, - { slug, data, req = {} as PayloadRequestWithData }: UpdateGlobalArgs, + { slug, data, req = {} as PayloadRequest }: UpdateGlobalArgs, ): Promise { const db = this.sessions[req.transactionID]?.db || this.drizzle const globalConfig = this.payload.globals.config.find((config) => config.slug === slug) diff --git a/packages/db-postgres/src/updateGlobalVersion.ts b/packages/db-postgres/src/updateGlobalVersion.ts index dc89c7cea..9dacd25b4 100644 --- a/packages/db-postgres/src/updateGlobalVersion.ts +++ b/packages/db-postgres/src/updateGlobalVersion.ts @@ -1,5 +1,5 @@ import type { - PayloadRequestWithData, + PayloadRequest, SanitizedGlobalConfig, TypeWithID, TypeWithVersion, @@ -20,7 +20,7 @@ export async function updateGlobalVersion( id, global, locale, - req = {} as PayloadRequestWithData, + req = {} as PayloadRequest, versionData, where: whereArg, }: UpdateGlobalVersionArgs, diff --git a/packages/db-postgres/src/updateVersion.ts b/packages/db-postgres/src/updateVersion.ts index b5756a919..c2521a6be 100644 --- a/packages/db-postgres/src/updateVersion.ts +++ b/packages/db-postgres/src/updateVersion.ts @@ -1,5 +1,5 @@ import type { - PayloadRequestWithData, + PayloadRequest, SanitizedCollectionConfig, TypeWithID, TypeWithVersion, @@ -20,7 +20,7 @@ export async function updateVersion( id, collection, locale, - req = {} as PayloadRequestWithData, + req = {} as PayloadRequest, versionData, where: whereArg, }: UpdateVersionArgs, diff --git a/packages/db-postgres/src/upsertRow/types.ts b/packages/db-postgres/src/upsertRow/types.ts index b0babe7ce..3b9fc9ce7 100644 --- a/packages/db-postgres/src/upsertRow/types.ts +++ b/packages/db-postgres/src/upsertRow/types.ts @@ -1,5 +1,5 @@ import type { SQL } from 'drizzle-orm' -import type { Field, PayloadRequestWithData } from 'payload' +import type { Field, PayloadRequest } from 'payload' import type { DrizzleDB, GenericColumn, PostgresAdapter } from '../types.js' @@ -14,7 +14,7 @@ type BaseArgs = { */ ignoreResult?: boolean path?: string - req: PayloadRequestWithData + req: PayloadRequest tableName: string } diff --git a/packages/graphql/src/resolvers/collections/count.ts b/packages/graphql/src/resolvers/collections/count.ts index 127e28b7f..faf781688 100644 --- a/packages/graphql/src/resolvers/collections/count.ts +++ b/packages/graphql/src/resolvers/collections/count.ts @@ -1,4 +1,4 @@ -import type { Collection, PayloadRequestWithData, Where } from 'payload' +import type { Collection, PayloadRequest, Where } from 'payload' import { countOperation, isolateObjectProperty } from 'payload' @@ -12,7 +12,7 @@ export type Resolver = ( where?: Where }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, // eslint-disable-next-line @typescript-eslint/no-explicit-any ) => Promise<{ totalDocs: number }> diff --git a/packages/graphql/src/resolvers/collections/create.ts b/packages/graphql/src/resolvers/collections/create.ts index 66b86add9..9bd99e5d9 100644 --- a/packages/graphql/src/resolvers/collections/create.ts +++ b/packages/graphql/src/resolvers/collections/create.ts @@ -2,7 +2,7 @@ import type { Collection, CollectionSlug, DataFromCollectionSlug, - PayloadRequestWithData, + PayloadRequest, RequiredDataFromCollectionSlug, } from 'payload' @@ -18,7 +18,7 @@ export type Resolver = ( locale?: string }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, ) => Promise> diff --git a/packages/graphql/src/resolvers/collections/delete.ts b/packages/graphql/src/resolvers/collections/delete.ts index 023a15483..680141c1e 100644 --- a/packages/graphql/src/resolvers/collections/delete.ts +++ b/packages/graphql/src/resolvers/collections/delete.ts @@ -1,9 +1,4 @@ -import type { - Collection, - CollectionSlug, - DataFromCollectionSlug, - PayloadRequestWithData, -} from 'payload' +import type { Collection, CollectionSlug, DataFromCollectionSlug, PayloadRequest } from 'payload' import { deleteByIDOperation, isolateObjectProperty } from 'payload' @@ -18,7 +13,7 @@ export type Resolver = ( locale?: string }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, ) => Promise> diff --git a/packages/graphql/src/resolvers/collections/docAccess.ts b/packages/graphql/src/resolvers/collections/docAccess.ts index f5f7b95ec..4909b53e1 100644 --- a/packages/graphql/src/resolvers/collections/docAccess.ts +++ b/packages/graphql/src/resolvers/collections/docAccess.ts @@ -1,9 +1,4 @@ -import type { - Collection, - CollectionPermission, - GlobalPermission, - PayloadRequestWithData, -} from 'payload' +import type { Collection, CollectionPermission, GlobalPermission, PayloadRequest } from 'payload' import { docAccessOperation, isolateObjectProperty } from 'payload' @@ -15,7 +10,7 @@ export type Resolver = ( id: number | string }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, ) => Promise diff --git a/packages/graphql/src/resolvers/collections/duplicate.ts b/packages/graphql/src/resolvers/collections/duplicate.ts index b5ed84bc7..922772a38 100644 --- a/packages/graphql/src/resolvers/collections/duplicate.ts +++ b/packages/graphql/src/resolvers/collections/duplicate.ts @@ -1,9 +1,4 @@ -import type { - Collection, - CollectionSlug, - DataFromCollectionSlug, - PayloadRequestWithData, -} from 'payload' +import type { Collection, CollectionSlug, DataFromCollectionSlug, PayloadRequest } from 'payload' import { duplicateOperation, isolateObjectProperty } from 'payload' @@ -18,7 +13,7 @@ export type Resolver = ( locale?: string }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, ) => Promise diff --git a/packages/graphql/src/resolvers/collections/find.ts b/packages/graphql/src/resolvers/collections/find.ts index c25da5ac6..88d715b1a 100644 --- a/packages/graphql/src/resolvers/collections/find.ts +++ b/packages/graphql/src/resolvers/collections/find.ts @@ -1,4 +1,4 @@ -import type { Collection, PaginatedDocs, PayloadRequestWithData, Where } from 'payload' +import type { Collection, PaginatedDocs, PayloadRequest, Where } from 'payload' import { findOperation, isolateObjectProperty } from 'payload' @@ -17,7 +17,7 @@ export type Resolver = ( where?: Where }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, // eslint-disable-next-line @typescript-eslint/no-explicit-any ) => Promise> diff --git a/packages/graphql/src/resolvers/collections/findByID.ts b/packages/graphql/src/resolvers/collections/findByID.ts index cb2f80ef4..d6108d4d8 100644 --- a/packages/graphql/src/resolvers/collections/findByID.ts +++ b/packages/graphql/src/resolvers/collections/findByID.ts @@ -1,9 +1,4 @@ -import type { - Collection, - CollectionSlug, - DataFromCollectionSlug, - PayloadRequestWithData, -} from 'payload' +import type { Collection, CollectionSlug, DataFromCollectionSlug, PayloadRequest } from 'payload' import { findByIDOperation, isolateObjectProperty } from 'payload' @@ -18,7 +13,7 @@ export type Resolver = ( locale?: string }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, ) => Promise diff --git a/packages/graphql/src/resolvers/collections/findVersionByID.ts b/packages/graphql/src/resolvers/collections/findVersionByID.ts index 85729327f..25b05f329 100644 --- a/packages/graphql/src/resolvers/collections/findVersionByID.ts +++ b/packages/graphql/src/resolvers/collections/findVersionByID.ts @@ -1,4 +1,4 @@ -import type { Collection, PayloadRequestWithData, TypeWithID, TypeWithVersion } from 'payload' +import type { Collection, PayloadRequest, TypeWithID, TypeWithVersion } from 'payload' import { findVersionByIDOperation, isolateObjectProperty } from 'payload' @@ -12,7 +12,7 @@ export type Resolver = ( locale?: string }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, ) => Promise> diff --git a/packages/graphql/src/resolvers/collections/findVersions.ts b/packages/graphql/src/resolvers/collections/findVersions.ts index c4f256f96..79624632a 100644 --- a/packages/graphql/src/resolvers/collections/findVersions.ts +++ b/packages/graphql/src/resolvers/collections/findVersions.ts @@ -1,4 +1,4 @@ -import type { Collection, PaginatedDocs, PayloadRequestWithData, Where } from 'payload' +import type { Collection, PaginatedDocs, PayloadRequest, Where } from 'payload' import { findVersionsOperation, isolateObjectProperty } from 'payload' @@ -16,7 +16,7 @@ export type Resolver = ( where: Where }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, ) => Promise> diff --git a/packages/graphql/src/resolvers/collections/restoreVersion.ts b/packages/graphql/src/resolvers/collections/restoreVersion.ts index 396fae064..a6bae3817 100644 --- a/packages/graphql/src/resolvers/collections/restoreVersion.ts +++ b/packages/graphql/src/resolvers/collections/restoreVersion.ts @@ -1,4 +1,4 @@ -import type { Collection, PayloadRequestWithData } from 'payload' +import type { Collection, PayloadRequest } from 'payload' import { isolateObjectProperty, restoreVersionOperation } from 'payload' @@ -10,7 +10,7 @@ export type Resolver = ( id: number | string }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, ) => Promise diff --git a/packages/graphql/src/resolvers/collections/update.ts b/packages/graphql/src/resolvers/collections/update.ts index cd413863a..92626dc76 100644 --- a/packages/graphql/src/resolvers/collections/update.ts +++ b/packages/graphql/src/resolvers/collections/update.ts @@ -1,9 +1,4 @@ -import type { - Collection, - CollectionSlug, - DataFromCollectionSlug, - PayloadRequestWithData, -} from 'payload' +import type { Collection, CollectionSlug, DataFromCollectionSlug, PayloadRequest } from 'payload' import { isolateObjectProperty, updateByIDOperation } from 'payload' @@ -20,7 +15,7 @@ export type Resolver = ( locale?: string }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, ) => Promise> diff --git a/packages/graphql/src/resolvers/globals/docAccess.ts b/packages/graphql/src/resolvers/globals/docAccess.ts index bbccdd5c7..72d137948 100644 --- a/packages/graphql/src/resolvers/globals/docAccess.ts +++ b/packages/graphql/src/resolvers/globals/docAccess.ts @@ -1,7 +1,7 @@ import type { CollectionPermission, GlobalPermission, - PayloadRequestWithData, + PayloadRequest, SanitizedGlobalConfig, } from 'payload' @@ -12,7 +12,7 @@ import type { Context } from '../types.js' export type Resolver = ( _: unknown, context: { - req: PayloadRequestWithData + req: PayloadRequest }, ) => Promise diff --git a/packages/graphql/src/resolvers/globals/findVersionByID.ts b/packages/graphql/src/resolvers/globals/findVersionByID.ts index 57717768d..32f642f42 100644 --- a/packages/graphql/src/resolvers/globals/findVersionByID.ts +++ b/packages/graphql/src/resolvers/globals/findVersionByID.ts @@ -1,4 +1,4 @@ -import type { Document, PayloadRequestWithData, SanitizedGlobalConfig } from 'payload' +import type { Document, PayloadRequest, SanitizedGlobalConfig } from 'payload' import { findVersionByIDOperationGlobal, isolateObjectProperty } from 'payload' @@ -13,7 +13,7 @@ export type Resolver = ( locale?: string }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, ) => Promise diff --git a/packages/graphql/src/resolvers/globals/findVersions.ts b/packages/graphql/src/resolvers/globals/findVersions.ts index 824646aae..1a2151df3 100644 --- a/packages/graphql/src/resolvers/globals/findVersions.ts +++ b/packages/graphql/src/resolvers/globals/findVersions.ts @@ -1,4 +1,4 @@ -import type { Document, PayloadRequestWithData, SanitizedGlobalConfig, Where } from 'payload' +import type { Document, PayloadRequest, SanitizedGlobalConfig, Where } from 'payload' import { findVersionsOperationGlobal, isolateObjectProperty } from 'payload' @@ -15,7 +15,7 @@ export type Resolver = ( where: Where }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, ) => Promise diff --git a/packages/graphql/src/resolvers/globals/restoreVersion.ts b/packages/graphql/src/resolvers/globals/restoreVersion.ts index fb289d50f..56ba30d79 100644 --- a/packages/graphql/src/resolvers/globals/restoreVersion.ts +++ b/packages/graphql/src/resolvers/globals/restoreVersion.ts @@ -1,4 +1,4 @@ -import type { Document, PayloadRequestWithData, SanitizedGlobalConfig } from 'payload' +import type { Document, PayloadRequest, SanitizedGlobalConfig } from 'payload' import { isolateObjectProperty, restoreVersionOperationGlobal } from 'payload' @@ -10,7 +10,7 @@ type Resolver = ( id: number | string }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, ) => Promise export default function restoreVersionResolver(globalConfig: SanitizedGlobalConfig): Resolver { diff --git a/packages/graphql/src/resolvers/globals/update.ts b/packages/graphql/src/resolvers/globals/update.ts index e2b664a94..9edce3ff3 100644 --- a/packages/graphql/src/resolvers/globals/update.ts +++ b/packages/graphql/src/resolvers/globals/update.ts @@ -1,9 +1,4 @@ -import type { - DataFromGlobalSlug, - GlobalSlug, - PayloadRequestWithData, - SanitizedGlobalConfig, -} from 'payload' +import type { DataFromGlobalSlug, GlobalSlug, PayloadRequest, SanitizedGlobalConfig } from 'payload' import type { DeepPartial } from 'ts-essentials' import { isolateObjectProperty, updateOperationGlobal } from 'payload' @@ -19,7 +14,7 @@ type Resolver = ( locale?: string }, context: { - req: PayloadRequestWithData + req: PayloadRequest }, ) => Promise> diff --git a/packages/graphql/src/resolvers/types.ts b/packages/graphql/src/resolvers/types.ts index 8309193bf..b9f084753 100644 --- a/packages/graphql/src/resolvers/types.ts +++ b/packages/graphql/src/resolvers/types.ts @@ -1,8 +1,8 @@ -import type { PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' export type Context = { headers: { [key: string]: string } - req: PayloadRequestWithData + req: PayloadRequest } diff --git a/packages/graphql/src/utilities/wrapCustomResolver.ts b/packages/graphql/src/utilities/wrapCustomResolver.ts index 6e44734fb..9c6f3c98b 100644 --- a/packages/graphql/src/utilities/wrapCustomResolver.ts +++ b/packages/graphql/src/utilities/wrapCustomResolver.ts @@ -1,10 +1,10 @@ import type { ObjMap } from 'graphql/jsutils/ObjMap.js' import type { GraphQLFieldConfig, GraphQLFieldResolver } from 'graphql/type/definition.js' -import type { PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' import { isolateObjectProperty } from 'payload' -type PayloadContext = { req: PayloadRequestWithData } +type PayloadContext = { req: PayloadRequest } function wrapCustomResolver( resolver: GraphQLFieldResolver, diff --git a/packages/next/src/routes/graphql/handler.ts b/packages/next/src/routes/graphql/handler.ts index 02ba783d5..be8395752 100644 --- a/packages/next/src/routes/graphql/handler.ts +++ b/packages/next/src/routes/graphql/handler.ts @@ -84,24 +84,24 @@ export const getGraphql = async (config: Promise | SanitizedCon export const POST = (config: Promise | SanitizedConfig) => async (request: Request) => { const originalRequest = request.clone() - const basePayloadRequest = await createPayloadRequest({ + const req = await createPayloadRequest({ config, request, }) - const reqWithData = await addDataAndFileToRequest({ request: basePayloadRequest }) - const payloadRequest = addLocalesToRequestFromData({ request: reqWithData }) + await addDataAndFileToRequest(req) + addLocalesToRequestFromData(req) const { schema, validationRules } = await getGraphql(config) - const { payload } = payloadRequest + const { payload } = req const afterErrorHook = typeof payload.config.hooks.afterError === 'function' ? payload.config.hooks.afterError : null const headers = {} const apiResponse = await createHandler({ - context: { headers, req: payloadRequest }, + context: { headers, req }, onOperation: async (request, args, result) => { const response = typeof payload.extensions === 'function' @@ -128,15 +128,15 @@ export const POST = const resHeaders = headersWithCors({ headers: new Headers(apiResponse.headers), - req: payloadRequest, + req, }) for (const key in headers) { resHeaders.append(key, headers[key]) } - if (basePayloadRequest.responseHeaders) { - mergeHeaders(basePayloadRequest.responseHeaders, resHeaders) + if (req.responseHeaders) { + mergeHeaders(req.responseHeaders, resHeaders) } return new Response(apiResponse.body, { diff --git a/packages/next/src/routes/rest/buildFormState.ts b/packages/next/src/routes/rest/buildFormState.ts index 19ecac04b..07b57e0a2 100644 --- a/packages/next/src/routes/rest/buildFormState.ts +++ b/packages/next/src/routes/rest/buildFormState.ts @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' import { buildFormState as buildFormStateFn } from '@payloadcms/ui/utilities/buildFormState' import httpStatus from 'http-status' @@ -6,7 +6,7 @@ import httpStatus from 'http-status' import { headersWithCors } from '../../utilities/headersWithCors.js' import { routeError } from './routeError.js' -export const buildFormState = async ({ req }: { req: PayloadRequestWithData }) => { +export const buildFormState = async ({ req }: { req: PayloadRequest }) => { const headers = headersWithCors({ headers: new Headers(), req, diff --git a/packages/next/src/routes/rest/files/checkFileAccess.ts b/packages/next/src/routes/rest/files/checkFileAccess.ts index 7e281d2d2..b05ac9cb5 100644 --- a/packages/next/src/routes/rest/files/checkFileAccess.ts +++ b/packages/next/src/routes/rest/files/checkFileAccess.ts @@ -1,4 +1,4 @@ -import type { Collection, PayloadRequestWithData, TypeWithID, Where } from 'payload' +import type { Collection, PayloadRequest, TypeWithID, Where } from 'payload' import { Forbidden, executeAccess } from 'payload' @@ -11,7 +11,7 @@ export async function checkFileAccess({ }: { collection: Collection filename: string - req: PayloadRequestWithData + req: PayloadRequest }): Promise { const { config } = collection const disableEndpoints = endpointsAreDisabled({ endpoints: config.endpoints, request: req }) diff --git a/packages/next/src/routes/rest/files/getFile.ts b/packages/next/src/routes/rest/files/getFile.ts index 349c7489a..e9c784c2e 100644 --- a/packages/next/src/routes/rest/files/getFile.ts +++ b/packages/next/src/routes/rest/files/getFile.ts @@ -1,4 +1,4 @@ -import type { Collection, PayloadRequestWithData } from 'payload' +import type { Collection, PayloadRequest } from 'payload' import { fileTypeFromFile } from 'file-type' import fsPromises from 'fs/promises' @@ -16,7 +16,7 @@ import { getFileTypeFallback } from './getFileTypeFallback.js' type Args = { collection: Collection filename: string - req: PayloadRequestWithData + req: PayloadRequest } export const getFile = async ({ collection, filename, req }: Args): Promise => { try { diff --git a/packages/next/src/routes/rest/index.ts b/packages/next/src/routes/rest/index.ts index f0ca605e8..f07973883 100644 --- a/packages/next/src/routes/rest/index.ts +++ b/packages/next/src/routes/rest/index.ts @@ -1,11 +1,4 @@ -import type { - Collection, - Endpoint, - GlobalConfig, - PayloadRequest, - PayloadRequestData, - SanitizedConfig, -} from 'payload' +import type { Collection, Endpoint, GlobalConfig, PayloadRequest, SanitizedConfig } from 'payload' import httpStatus from 'http-status' import { match } from 'path-to-regexp' @@ -126,22 +119,22 @@ const endpoints = { const handleCustomEndpoints = async ({ endpoints, entitySlug, - payloadRequest, + req, }: { endpoints: Endpoint[] | GlobalConfig['endpoints'] entitySlug?: string - payloadRequest: PayloadRequest + req: PayloadRequest }): Promise => { if (endpoints && endpoints.length > 0) { let handlerParams = {} - const { pathname } = payloadRequest + const { pathname } = req /* * This makes sure the next.js basePath property is supported. If basePath is used, payload config.routes.api should include it. This makes all outgoing frontend request * target the correct API endpoint starting with basePath, which is good! * * The incoming request (here) will not include the basePath though, as it's automatically stripped by Next.js. Since we are adding the basePath to the pathPrefix below though - * (from payloadRequest.payload.config.routes.api) we need to add it to pathname, which does not contain the basePath. Otherwise, no endpoint will be matched if basePath is set. + * (from req.payload.config.routes.api) we need to add it to pathname, which does not contain the basePath. Otherwise, no endpoint will be matched if basePath is set. */ let adjustedPathname = pathname @@ -149,11 +142,10 @@ const handleCustomEndpoints = async ({ adjustedPathname = process.env.NEXT_BASE_PATH + pathname } - const pathPrefix = - payloadRequest.payload.config.routes.api + (entitySlug ? `/${entitySlug}` : '') + const pathPrefix = req.payload.config.routes.api + (entitySlug ? `/${entitySlug}` : '') const customEndpoint = endpoints.find((endpoint) => { - if (endpoint.method === payloadRequest.method.toLowerCase()) { + if (endpoint.method === req.method.toLowerCase()) { const pathMatchFn = match(`${pathPrefix}${endpoint.path}`, { decode: decodeURIComponent, }) @@ -167,15 +159,15 @@ const handleCustomEndpoints = async ({ }) if (customEndpoint) { - payloadRequest.routeParams = { - ...payloadRequest.routeParams, + req.routeParams = { + ...req.routeParams, ...handlerParams, } - const res = await customEndpoint.handler(payloadRequest) + const res = await customEndpoint.handler(req) if (res instanceof Response) { - if (payloadRequest.responseHeaders) { - mergeHeaders(payloadRequest.responseHeaders, res.headers) + if (req.responseHeaders) { + mergeHeaders(req.responseHeaders, res.headers) } return res @@ -233,7 +225,7 @@ export const GET = (config: Promise | SanitizedConfig) => async (request: Request, { params: { slug } }: { params: { slug: string[] } }) => { const [slug1, slug2, slug3, slug4] = slug - let req: PayloadRequest | (PayloadRequest & PayloadRequestData) + let req: PayloadRequest let res: Response let collection: Collection @@ -263,19 +255,19 @@ export const GET = const customEndpointResponse = await handleCustomEndpoints({ endpoints: collection.config.endpoints, entitySlug: slug1, - payloadRequest: req, + req, }) if (customEndpointResponse) { return customEndpointResponse } else { - const reqWithData = await addDataAndFileToRequest({ request: req }) - const payloadRequest = addLocalesToRequestFromData({ request: reqWithData }) + await addDataAndFileToRequest(req) + addLocalesToRequestFromData(req) switch (slug.length) { case 1: // /:collection - res = await endpoints.collection.GET.find({ collection, req: payloadRequest }) + res = await endpoints.collection.GET.find({ collection, req }) break case 2: if (slug2 in endpoints.collection.GET) { @@ -285,14 +277,14 @@ export const GET = // /:collection/count res = await (endpoints.collection.GET[slug2] as CollectionRouteHandler)({ collection, - req: payloadRequest, + req, }) } else { // /:collection/:id res = await endpoints.collection.GET.findByID({ id: slug2, collection, - req: payloadRequest, + req, }) } break @@ -302,21 +294,21 @@ export const GET = res = await endpoints.collection.GET.getFile({ collection, filename: slug3, - req: payloadRequest, + req, }) } else if (slug3 in endpoints.collection.GET) { // /:collection/:id/preview res = await (endpoints.collection.GET[slug3] as CollectionRouteHandlerWithID)({ id: slug2, collection, - req: payloadRequest, + req, }) } else if (`doc-${slug2}-by-id` in endpoints.collection.GET) { // /:collection/access/:id // /:collection/versions/:id res = await ( endpoints.collection.GET[`doc-${slug2}-by-id`] as CollectionRouteHandlerWithID - )({ id: slug3, collection, req: payloadRequest }) + )({ id: slug3, collection, req }) } break } @@ -334,26 +326,26 @@ export const GET = const customEndpointResponse = await handleCustomEndpoints({ endpoints: globalConfig.endpoints, entitySlug: `${slug1}/${slug2}`, - payloadRequest: req, + req, }) if (customEndpointResponse) { return customEndpointResponse } else { - const reqWithData = await addDataAndFileToRequest({ request: req }) - const payloadRequest = addLocalesToRequestFromData({ request: reqWithData }) + await addDataAndFileToRequest(req) + addLocalesToRequestFromData(req) switch (slug.length) { case 2: // /globals/:slug - res = await endpoints.global.GET.findOne({ globalConfig, req: payloadRequest }) + res = await endpoints.global.GET.findOne({ globalConfig, req }) break case 3: if (slug3 in endpoints.global.GET) { // /globals/:slug/preview res = await (endpoints.global.GET[slug3] as GlobalRouteHandler)({ globalConfig, - req: payloadRequest, + req, }) } else if (`doc-${slug3}` in endpoints.global.GET) { // /globals/:slug/access @@ -361,7 +353,7 @@ export const GET = // /globals/:slug/preview res = await (endpoints.global.GET?.[`doc-${slug3}`] as GlobalRouteHandler)({ globalConfig, - req: payloadRequest, + req, }) } break @@ -373,16 +365,16 @@ export const GET = )({ id: slug4, globalConfig, - req: payloadRequest, + req, }) } break } } } else if (slug.length === 1 && slug1 in endpoints.root.GET) { - const reqWithData = await addDataAndFileToRequest({ request: req }) - const payloadRequest = addLocalesToRequestFromData({ request: reqWithData }) - res = await endpoints.root.GET[slug1]({ req: payloadRequest }) + await addDataAndFileToRequest(req) + addLocalesToRequestFromData(req) + res = await endpoints.root.GET[slug1]({ req }) } if (res instanceof Response) { @@ -396,7 +388,7 @@ export const GET = // root routes const customEndpointResponse = await handleCustomEndpoints({ endpoints: req.payload.config.endpoints, - payloadRequest: req, + req, }) if (customEndpointResponse) return customEndpointResponse @@ -454,19 +446,19 @@ export const POST = const customEndpointResponse = await handleCustomEndpoints({ endpoints: collection.config.endpoints, entitySlug: slug1, - payloadRequest: req, + req, }) if (customEndpointResponse) { return customEndpointResponse } else { - const reqWithData = await addDataAndFileToRequest({ request: req }) - const payloadRequest = addLocalesToRequestFromData({ request: reqWithData }) + await addDataAndFileToRequest(req) + addLocalesToRequestFromData(req) switch (slug.length) { case 1: // /:collection - res = await endpoints.collection.POST.create({ collection, req: payloadRequest }) + res = await endpoints.collection.POST.create({ collection, req }) break case 2: if (slug2 in endpoints.collection.POST) { @@ -481,7 +473,7 @@ export const POST = res = await (endpoints.collection.POST?.[slug2] as CollectionRouteHandler)({ collection, - req: payloadRequest, + req, }) } break @@ -492,13 +484,13 @@ export const POST = // /:collection/verify/:token ("doc-verify-by-id" uses id as token internally) res = await ( endpoints.collection.POST[`doc-${slug2}-by-id`] as CollectionRouteHandlerWithID - )({ id: slug3, collection, req: payloadRequest }) + )({ id: slug3, collection, req }) } else if (slug3 === 'duplicate' && collection.config.disableDuplicate !== true) { // /:collection/:id/duplicate res = await endpoints.collection.POST.duplicate({ id: slug2, collection, - req: payloadRequest, + req, }) } break @@ -517,25 +509,25 @@ export const POST = const customEndpointResponse = await handleCustomEndpoints({ endpoints: globalConfig.endpoints, entitySlug: `${slug1}/${slug2}`, - payloadRequest: req, + req, }) if (customEndpointResponse) { return customEndpointResponse } else { - const reqWithData = await addDataAndFileToRequest({ request: req }) - const payloadRequest = addLocalesToRequestFromData({ request: reqWithData }) + await addDataAndFileToRequest(req) + addLocalesToRequestFromData(req) switch (slug.length) { case 2: // /globals/:slug - res = await endpoints.global.POST.update({ globalConfig, req: payloadRequest }) + res = await endpoints.global.POST.update({ globalConfig, req }) break case 3: if (`doc-${slug3}` in endpoints.global.POST) { // /globals/:slug/access res = await (endpoints.global.POST?.[`doc-${slug3}`] as GlobalRouteHandler)({ globalConfig, - req: payloadRequest, + req, }) } break @@ -547,7 +539,7 @@ export const POST = )({ id: slug4, globalConfig, - req: payloadRequest, + req, }) } break @@ -556,9 +548,9 @@ export const POST = } } } else if (slug.length === 1 && slug1 in endpoints.root.POST) { - const reqWithData = await addDataAndFileToRequest({ request: req }) - const payloadRequest = addLocalesToRequestFromData({ request: reqWithData }) - res = await endpoints.root.POST[slug1]({ req: payloadRequest }) + await addDataAndFileToRequest(req) + addLocalesToRequestFromData(req) + res = await endpoints.root.POST[slug1]({ req }) } if (res instanceof Response) { @@ -572,7 +564,7 @@ export const POST = // root routes const customEndpointResponse = await handleCustomEndpoints({ endpoints: req.payload.config.endpoints, - payloadRequest: req, + req, }) if (customEndpointResponse) return customEndpointResponse @@ -624,25 +616,25 @@ export const DELETE = const customEndpointResponse = await handleCustomEndpoints({ endpoints: collection.config.endpoints, entitySlug: slug1, - payloadRequest: req, + req, }) if (customEndpointResponse) { return customEndpointResponse } else { - const reqWithData = await addDataAndFileToRequest({ request: req }) - const payloadRequest = addLocalesToRequestFromData({ request: reqWithData }) + await addDataAndFileToRequest(req) + addLocalesToRequestFromData(req) switch (slug.length) { case 1: // /:collection - res = await endpoints.collection.DELETE.delete({ collection, req: payloadRequest }) + res = await endpoints.collection.DELETE.delete({ collection, req }) break case 2: // /:collection/:id res = await endpoints.collection.DELETE.deleteByID({ id: slug2, collection, - req: payloadRequest, + req, }) break } @@ -660,7 +652,7 @@ export const DELETE = // root routes const customEndpointResponse = await handleCustomEndpoints({ endpoints: req.payload.config.endpoints, - payloadRequest: req, + req, }) if (customEndpointResponse) return customEndpointResponse @@ -712,26 +704,26 @@ export const PATCH = const customEndpointResponse = await handleCustomEndpoints({ endpoints: collection.config.endpoints, entitySlug: slug1, - payloadRequest: req, + req, }) if (customEndpointResponse) { return customEndpointResponse } else { - const reqWithData = await addDataAndFileToRequest({ request: req }) - const payloadRequest = addLocalesToRequestFromData({ request: reqWithData }) + await addDataAndFileToRequest(req) + addLocalesToRequestFromData(req) switch (slug.length) { case 1: // /:collection - res = await endpoints.collection.PATCH.update({ collection, req: payloadRequest }) + res = await endpoints.collection.PATCH.update({ collection, req }) break case 2: // /:collection/:id res = await endpoints.collection.PATCH.updateByID({ id: slug2, collection, - req: payloadRequest, + req, }) break } @@ -749,7 +741,7 @@ export const PATCH = // root routes const customEndpointResponse = await handleCustomEndpoints({ endpoints: req.payload.config.endpoints, - payloadRequest: req, + req, }) if (customEndpointResponse) return customEndpointResponse diff --git a/packages/next/src/routes/rest/og/index.tsx b/packages/next/src/routes/rest/og/index.tsx index c88729e9b..9e937bfe1 100644 --- a/packages/next/src/routes/rest/og/index.tsx +++ b/packages/next/src/routes/rest/og/index.tsx @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' import { PayloadIcon } from '@payloadcms/ui/shared' import fs from 'fs/promises' @@ -17,7 +17,7 @@ export const runtime = 'nodejs' export const contentType = 'image/png' -export const generateOGImage = async ({ req }: { req: PayloadRequestWithData }) => { +export const generateOGImage = async ({ req }: { req: PayloadRequest }) => { const config = req.payload.config if (config.admin.meta.defaultOGImageType === 'off') { diff --git a/packages/next/src/routes/rest/routeError.ts b/packages/next/src/routes/rest/routeError.ts index a590ad7d8..d6eff867a 100644 --- a/packages/next/src/routes/rest/routeError.ts +++ b/packages/next/src/routes/rest/routeError.ts @@ -1,4 +1,4 @@ -import type { Collection, PayloadRequestWithData, SanitizedConfig } from 'payload' +import type { Collection, PayloadRequest, SanitizedConfig } from 'payload' import httpStatus from 'http-status' import { APIError } from 'payload' @@ -78,7 +78,7 @@ export const routeError = async ({ collection?: Collection config: Promise | SanitizedConfig err: APIError - req: Partial + req: Partial }) => { let payload = req?.payload diff --git a/packages/next/src/routes/rest/types.ts b/packages/next/src/routes/rest/types.ts index d837873e6..86a10d108 100644 --- a/packages/next/src/routes/rest/types.ts +++ b/packages/next/src/routes/rest/types.ts @@ -1,17 +1,13 @@ -import type { Collection, PayloadRequestWithData, SanitizedGlobalConfig } from 'payload' +import type { Collection, PayloadRequest, SanitizedGlobalConfig } from 'payload' -export type BaseRouteHandler = ({ - req, -}: { - req: PayloadRequestWithData -}) => Promise | Response +export type BaseRouteHandler = ({ req }: { req: PayloadRequest }) => Promise | Response export type CollectionRouteHandler = ({ collection, req, }: { collection: Collection - req: PayloadRequestWithData + req: PayloadRequest }) => Promise | Response export type CollectionRouteHandlerWithID = ({ @@ -21,7 +17,7 @@ export type CollectionRouteHandlerWithID = ({ }: { collection: Collection id: string - req: PayloadRequestWithData + req: PayloadRequest }) => Promise | Response export type GlobalRouteHandler = ({ @@ -29,7 +25,7 @@ export type GlobalRouteHandler = ({ req, }: { globalConfig: SanitizedGlobalConfig - req: PayloadRequestWithData + req: PayloadRequest }) => Promise | Response export type GlobalRouteHandlerWithID = ({ @@ -39,5 +35,5 @@ export type GlobalRouteHandlerWithID = ({ }: { globalConfig: SanitizedGlobalConfig id: string - req: PayloadRequestWithData + req: PayloadRequest }) => Promise | Response diff --git a/packages/next/src/utilities/addDataAndFileToRequest.ts b/packages/next/src/utilities/addDataAndFileToRequest.ts index d2cf45181..e2a6febd2 100644 --- a/packages/next/src/utilities/addDataAndFileToRequest.ts +++ b/packages/next/src/utilities/addDataAndFileToRequest.ts @@ -1,4 +1,4 @@ -import type { PayloadRequest, PayloadRequestData } from 'payload' +import type { PayloadRequest } from 'payload' import { APIError } from 'payload' @@ -6,40 +6,32 @@ import type { FetchAPIFileUploadOptions } from '../fetchAPI-multipart/index.js' import { fetchAPIFileUpload } from '../fetchAPI-multipart/index.js' -type ReturnType = PayloadRequest & PayloadRequestData -type AddDataAndFileToRequest = (args: { request: PayloadRequest }) => Promise +type AddDataAndFileToRequest = (req: PayloadRequest) => Promise /** - * Mutates the Request to contain 'data' and 'file' if present + * Mutates the Request, appending 'data' and 'file' if found */ -export const addDataAndFileToRequest: AddDataAndFileToRequest = async ({ - request: incomingRequest, -}) => { - const config = incomingRequest.payload.config +export const addDataAndFileToRequest: AddDataAndFileToRequest = async (req) => { + const { body, headers, method, payload } = req - if ( - incomingRequest.method && - ['PATCH', 'POST', 'PUT'].includes(incomingRequest.method.toUpperCase()) && - incomingRequest.body - ) { - const [contentType] = (incomingRequest.headers.get('Content-Type') || '').split(';') - const mutableRequest = incomingRequest as ReturnType - const bodyByteSize = parseInt(incomingRequest.headers.get('Content-Length') || '0', 10) + if (method && ['PATCH', 'POST', 'PUT'].includes(method.toUpperCase()) && body) { + const [contentType] = (headers.get('Content-Type') || '').split(';') + const bodyByteSize = parseInt(req.headers.get('Content-Length') || '0', 10) if (contentType === 'application/json') { let data = {} try { - data = await mutableRequest.json() + data = await req.json() } catch (error) { - mutableRequest.payload.logger.error(error) + req.payload.logger.error(error) } finally { - mutableRequest.data = data - mutableRequest.json = () => Promise.resolve(data) + req.data = data + req.json = () => Promise.resolve(data) } } else if (bodyByteSize && contentType.includes('multipart/')) { const { error, fields, files } = await fetchAPIFileUpload({ - options: config.upload as FetchAPIFileUploadOptions, - request: mutableRequest as Request, + options: payload.config.upload as FetchAPIFileUploadOptions, + request: req as Request, }) if (error) { @@ -47,16 +39,12 @@ export const addDataAndFileToRequest: AddDataAndFileToRequest = async ({ } if (files?.file) { - mutableRequest.file = files.file + req.file = files.file } if (fields?._payload && typeof fields._payload === 'string') { - mutableRequest.data = JSON.parse(fields._payload) + req.data = JSON.parse(fields._payload) } } - - return mutableRequest } - - return incomingRequest } diff --git a/packages/next/src/utilities/addLocalesToRequest.ts b/packages/next/src/utilities/addLocalesToRequest.ts index 540e0640d..d1807c3c6 100644 --- a/packages/next/src/utilities/addLocalesToRequest.ts +++ b/packages/next/src/utilities/addLocalesToRequest.ts @@ -1,25 +1,17 @@ -import type { - PayloadRequest, - PayloadRequestData, - PayloadRequestWithData, - SanitizedConfig, -} from 'payload' +import type { PayloadRequest, SanitizedConfig } from 'payload' /** * Mutates the Request to contain 'locale' and 'fallbackLocale' based on data or searchParams */ -type Args = { - request: PayloadRequest & PayloadRequestData -} -export function addLocalesToRequestFromData({ request }: Args): PayloadRequestWithData { +export function addLocalesToRequestFromData(req: PayloadRequest): void { const { data, payload: { config }, - } = request + } = req if (data) { - let localeOnReq = request.locale - let fallbackLocaleOnReq = request.fallbackLocale + let localeOnReq = req.locale + let fallbackLocaleOnReq = req.fallbackLocale if (!localeOnReq && data?.locale && typeof data.locale === 'string') { localeOnReq = data.locale @@ -39,13 +31,9 @@ export function addLocalesToRequestFromData({ request }: Args): PayloadRequestWi localization: config.localization, }) - const mutableRequest = request - if (locale) mutableRequest.locale = locale - if (fallbackLocale) mutableRequest.fallbackLocale = fallbackLocale - return mutableRequest + if (locale) req.locale = locale + if (fallbackLocale) req.fallbackLocale = fallbackLocale } - - return request } type SanitizeLocalesArgs = { diff --git a/packages/next/src/utilities/headersWithCors.ts b/packages/next/src/utilities/headersWithCors.ts index 6af1e4553..09565c28c 100644 --- a/packages/next/src/utilities/headersWithCors.ts +++ b/packages/next/src/utilities/headersWithCors.ts @@ -1,8 +1,8 @@ -import type { PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' type CorsArgs = { headers: Headers - req: Partial + req: Partial } export const headersWithCors = ({ headers, req }: CorsArgs): Headers => { const cors = req?.payload.config.cors diff --git a/packages/next/src/utilities/initPage/index.ts b/packages/next/src/utilities/initPage/index.ts index 1bce6f0e5..4dccd194b 100644 --- a/packages/next/src/utilities/initPage/index.ts +++ b/packages/next/src/utilities/initPage/index.ts @@ -1,5 +1,5 @@ import type { I18nClient } from '@payloadcms/translations' -import type { InitPageResult, Locale, PayloadRequestWithData, VisibleEntities } from 'payload' +import type { InitPageResult, Locale, PayloadRequest, VisibleEntities } from 'payload' import { initI18n } from '@payloadcms/translations' import { findLocaleFromCode } from '@payloadcms/ui/shared' @@ -66,7 +66,7 @@ export const initPage = async ({ ignoreQueryPrefix: true, }), url: `${payload.config.serverURL}${route}${searchParams ? queryString : ''}`, - } as PayloadRequestWithData, + } as PayloadRequest, }, payload, ) diff --git a/packages/next/src/views/Document/getDocumentData.tsx b/packages/next/src/views/Document/getDocumentData.tsx index c98f67fde..b19246851 100644 --- a/packages/next/src/views/Document/getDocumentData.tsx +++ b/packages/next/src/views/Document/getDocumentData.tsx @@ -1,7 +1,7 @@ import type { Data, Locale, - PayloadRequestWithData, + PayloadRequest, SanitizedCollectionConfig, SanitizedGlobalConfig, } from 'payload' @@ -14,7 +14,7 @@ export const getDocumentData = async (args: { globalConfig?: SanitizedGlobalConfig id?: number | string locale: Locale - req: PayloadRequestWithData + req: PayloadRequest }): Promise => { const { id, collectionConfig, globalConfig, locale, req } = args diff --git a/packages/next/src/views/Edit/Default/Auth/APIKey.tsx b/packages/next/src/views/Edit/Default/Auth/APIKey.tsx index ce76fadd5..f914d4546 100644 --- a/packages/next/src/views/Edit/Default/Auth/APIKey.tsx +++ b/packages/next/src/views/Edit/Default/Auth/APIKey.tsx @@ -1,5 +1,5 @@ 'use client' -import type { PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' import { CopyToClipboard, @@ -42,7 +42,7 @@ export const APIKey: React.FC<{ enabled: boolean; readOnly?: boolean }> = ({ config, }, t, - } as PayloadRequestWithData, + } as PayloadRequest, siblingData: {}, }) diff --git a/packages/next/src/views/ForgotPassword/ForgotPasswordForm/index.tsx b/packages/next/src/views/ForgotPassword/ForgotPasswordForm/index.tsx index a6c8f975f..b208a6d2a 100644 --- a/packages/next/src/views/ForgotPassword/ForgotPasswordForm/index.tsx +++ b/packages/next/src/views/ForgotPassword/ForgotPasswordForm/index.tsx @@ -1,7 +1,7 @@ 'use client' import type { FormProps } from '@payloadcms/ui' -import type { FormState, PayloadRequestWithData } from 'payload' +import type { FormState, PayloadRequest } from 'payload' import { EmailField, Form, FormSubmit, useConfig, useTranslation } from '@payloadcms/ui' import { email } from 'payload/shared' @@ -67,7 +67,7 @@ export const ForgotPasswordForm: React.FC = () => { type: 'email', data: {}, preferences: { fields: {} }, - req: { t } as PayloadRequestWithData, + req: { t } as PayloadRequest, required: true, siblingData: {}, }) diff --git a/packages/next/src/views/Login/LoginForm/index.tsx b/packages/next/src/views/Login/LoginForm/index.tsx index ec80a19f2..287854b57 100644 --- a/packages/next/src/views/Login/LoginForm/index.tsx +++ b/packages/next/src/views/Login/LoginForm/index.tsx @@ -6,7 +6,7 @@ import React from 'react' const baseClass = 'login__form' const Link = (LinkImport.default || LinkImport) as unknown as typeof LinkImport.default -import type { FormState, PayloadRequestWithData } from 'payload' +import type { FormState, PayloadRequest } from 'payload' import { EmailField, @@ -73,7 +73,7 @@ export const LoginForm: React.FC<{ type: 'email', data: {}, preferences: { fields: {} }, - req: { t } as PayloadRequestWithData, + req: { t } as PayloadRequest, required: true, siblingData: {}, }) @@ -95,7 +95,7 @@ export const LoginForm: React.FC<{ config, }, t, - } as PayloadRequestWithData, + } as PayloadRequest, required: true, siblingData: {}, }) diff --git a/packages/payload/src/admin/RichText.ts b/packages/payload/src/admin/RichText.ts index 2c36f0eb0..ee62c4776 100644 --- a/packages/payload/src/admin/RichText.ts +++ b/packages/payload/src/admin/RichText.ts @@ -6,7 +6,7 @@ import type { SanitizedCollectionConfig, TypeWithID } from '../collections/confi import type { SanitizedConfig } from '../config/types.js' import type { Field, FieldAffectingData, RichTextField, Validate } from '../fields/config/types.js' import type { SanitizedGlobalConfig } from '../globals/config/types.js' -import type { PayloadRequestWithData, RequestContext } from '../types/index.js' +import type { PayloadRequest, RequestContext } from '../types/index.js' import type { WithServerSidePropsComponentProps } from './elements/WithServerSideProps.js' export type RichTextFieldProps< @@ -130,7 +130,7 @@ export type BaseRichTextHookArgs< path: (number | string)[] /** The Express request object. It is mocked for Local API operations. */ - req: PayloadRequestWithData + req: PayloadRequest /** * The schemaPath of the field, e.g. ["group", "myArray", "textField"]. The schemaPath is the path but without indexes and would be used in the context of field schemas, not field data. */ @@ -218,7 +218,7 @@ type RichTextAdapterBase< flattenLocales: boolean overrideAccess?: boolean populationPromises: Promise[] - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields: boolean siblingDoc: Record }) => void diff --git a/packages/payload/src/admin/views/types.ts b/packages/payload/src/admin/views/types.ts index 5f68e135e..46b04a86a 100644 --- a/packages/payload/src/admin/views/types.ts +++ b/packages/payload/src/admin/views/types.ts @@ -4,7 +4,7 @@ import type { Permissions } from '../../auth/index.js' import type { SanitizedCollectionConfig } from '../../collections/config/types.js' import type { Locale } from '../../config/types.js' import type { SanitizedGlobalConfig } from '../../globals/config/types.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { LanguageOptions } from '../LanguageOptions.js' export type AdminViewConfig = { @@ -44,7 +44,7 @@ export type InitPageResult = { languageOptions: LanguageOptions locale?: Locale permissions: Permissions - req: PayloadRequestWithData + req: PayloadRequest translations: ClientTranslationsObject visibleEntities: VisibleEntities } diff --git a/packages/payload/src/auth/defaultAccess.ts b/packages/payload/src/auth/defaultAccess.ts index c94cc1e00..18f327626 100644 --- a/packages/payload/src/auth/defaultAccess.ts +++ b/packages/payload/src/auth/defaultAccess.ts @@ -1,3 +1,3 @@ -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' -export default ({ req: { user } }: { req: PayloadRequestWithData }): boolean => Boolean(user) +export default ({ req: { user } }: { req: PayloadRequest }): boolean => Boolean(user) diff --git a/packages/payload/src/auth/executeAccess.ts b/packages/payload/src/auth/executeAccess.ts index 407683ad7..8ac52baee 100644 --- a/packages/payload/src/auth/executeAccess.ts +++ b/packages/payload/src/auth/executeAccess.ts @@ -1,5 +1,5 @@ import type { Access, AccessResult } from '../config/types.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import { Forbidden } from '../errors/index.js' @@ -8,7 +8,7 @@ type OperationArgs = { disableErrors?: boolean id?: number | string isReadingStaticFile?: boolean - req: PayloadRequestWithData + req: PayloadRequest } const executeAccess = async ( { id, data, disableErrors, isReadingStaticFile = false, req }: OperationArgs, diff --git a/packages/payload/src/auth/getAccessResults.ts b/packages/payload/src/auth/getAccessResults.ts index 0a6dc1e19..de50b4d2a 100644 --- a/packages/payload/src/auth/getAccessResults.ts +++ b/packages/payload/src/auth/getAccessResults.ts @@ -1,11 +1,11 @@ -import type { AllOperations, PayloadRequestWithData } from '../types/index.js' +import type { AllOperations, PayloadRequest } from '../types/index.js' import type { Permissions } from './types.js' import { getEntityPolicies } from '../utilities/getEntityPolicies.js' import isolateObjectProperty from '../utilities/isolateObjectProperty.js' type GetAccessResultsArgs = { - req: PayloadRequestWithData + req: PayloadRequest } export async function getAccessResults({ req }: GetAccessResultsArgs): Promise { const results = {} as Permissions diff --git a/packages/payload/src/auth/getFieldsToSign.ts b/packages/payload/src/auth/getFieldsToSign.ts index b643f8d23..a9fa9646f 100644 --- a/packages/payload/src/auth/getFieldsToSign.ts +++ b/packages/payload/src/auth/getFieldsToSign.ts @@ -1,7 +1,7 @@ /* eslint-disable no-param-reassign */ import type { CollectionConfig } from '../collections/config/types.js' import type { Field, TabAsField } from '../fields/config/types.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import { fieldAffectsData, tabHasName } from '../fields/config/types.js' @@ -105,7 +105,7 @@ const traverseFields = ({ export const getFieldsToSign = (args: { collectionConfig: CollectionConfig email: string - user: PayloadRequestWithData['user'] + user: PayloadRequest['user'] }): Record => { const { collectionConfig, email, user } = args diff --git a/packages/payload/src/auth/operations/access.ts b/packages/payload/src/auth/operations/access.ts index 76bf7e1b2..ebe30957f 100644 --- a/packages/payload/src/auth/operations/access.ts +++ b/packages/payload/src/auth/operations/access.ts @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { Permissions } from '../types.js' import { commitTransaction } from '../../utilities/commitTransaction.js' @@ -8,7 +8,7 @@ import { adminInit as adminInitTelemetry } from '../../utilities/telemetry/event import { getAccessResults } from '../getAccessResults.js' type Arguments = { - req: PayloadRequestWithData + req: PayloadRequest } export const accessOperation = async (args: Arguments): Promise => { diff --git a/packages/payload/src/auth/operations/auth.ts b/packages/payload/src/auth/operations/auth.ts index ae9236b80..2e5e924c5 100644 --- a/packages/payload/src/auth/operations/auth.ts +++ b/packages/payload/src/auth/operations/auth.ts @@ -1,5 +1,5 @@ import type { TypedUser } from '../../index.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { Permissions } from '../types.js' import { commitTransaction } from '../../utilities/commitTransaction.js' @@ -10,7 +10,7 @@ import { getAccessResults } from '../getAccessResults.js' export type AuthArgs = { headers: Request['headers'] - req?: Omit + req?: Omit } export type AuthResult = { @@ -21,7 +21,7 @@ export type AuthResult = { export const auth = async (args: Required): Promise => { const { headers } = args - const req = args.req as PayloadRequestWithData + const req = args.req as PayloadRequest const { payload } = req try { diff --git a/packages/payload/src/auth/operations/forgotPassword.ts b/packages/payload/src/auth/operations/forgotPassword.ts index 0e20aa23f..60d0f8368 100644 --- a/packages/payload/src/auth/operations/forgotPassword.ts +++ b/packages/payload/src/auth/operations/forgotPassword.ts @@ -3,7 +3,7 @@ import httpStatus from 'http-status' import { URL } from 'url' import type { Collection } from '../../collections/config/types.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import { buildAfterOperation } from '../../collections/operations/utils.js' import { APIError } from '../../errors/index.js' @@ -19,7 +19,7 @@ export type Arguments = { } disableEmail?: boolean expiration?: number - req: PayloadRequestWithData + req: PayloadRequest } export type Result = string diff --git a/packages/payload/src/auth/operations/init.ts b/packages/payload/src/auth/operations/init.ts index b4382e226..296e0d462 100644 --- a/packages/payload/src/auth/operations/init.ts +++ b/packages/payload/src/auth/operations/init.ts @@ -1,8 +1,8 @@ -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' export const initOperation = async (args: { collection: string - req: PayloadRequestWithData + req: PayloadRequest }): Promise => { const { collection: slug, req } = args diff --git a/packages/payload/src/auth/operations/local/auth.ts b/packages/payload/src/auth/operations/local/auth.ts index 16e634a95..b221d550f 100644 --- a/packages/payload/src/auth/operations/local/auth.ts +++ b/packages/payload/src/auth/operations/local/auth.ts @@ -1,5 +1,5 @@ import type { Payload } from '../../../index.js' -import type { PayloadRequestWithData } from '../../../types/index.js' +import type { PayloadRequest } from '../../../types/index.js' import type { AuthArgs, AuthResult } from '../auth.js' import { createLocalReq } from '../../../utilities/createLocalReq.js' @@ -10,6 +10,6 @@ export const auth = async (payload: Payload, options: AuthArgs): Promise = { } disableEmail?: boolean expiration?: number - req?: PayloadRequestWithData + req?: PayloadRequest } async function localForgotPassword( diff --git a/packages/payload/src/auth/operations/local/login.ts b/packages/payload/src/auth/operations/local/login.ts index 1815c9c20..ef0f337ab 100644 --- a/packages/payload/src/auth/operations/local/login.ts +++ b/packages/payload/src/auth/operations/local/login.ts @@ -4,7 +4,7 @@ import type { Payload, RequestContext, } from '../../../index.js' -import type { PayloadRequestWithData } from '../../../types/index.js' +import type { PayloadRequest } from '../../../types/index.js' import type { Result } from '../login.js' import { APIError } from '../../../errors/index.js' @@ -22,7 +22,7 @@ export type Options = { fallbackLocale?: string locale?: string overrideAccess?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean } diff --git a/packages/payload/src/auth/operations/local/resetPassword.ts b/packages/payload/src/auth/operations/local/resetPassword.ts index 79b7c4e00..9b624c158 100644 --- a/packages/payload/src/auth/operations/local/resetPassword.ts +++ b/packages/payload/src/auth/operations/local/resetPassword.ts @@ -1,5 +1,5 @@ import type { CollectionSlug, Payload, RequestContext } from '../../../index.js' -import type { PayloadRequestWithData } from '../../../types/index.js' +import type { PayloadRequest } from '../../../types/index.js' import type { Result } from '../resetPassword.js' import { APIError } from '../../../errors/index.js' @@ -14,7 +14,7 @@ export type Options = { token: string } overrideAccess: boolean - req?: PayloadRequestWithData + req?: PayloadRequest } async function localResetPassword( diff --git a/packages/payload/src/auth/operations/local/unlock.ts b/packages/payload/src/auth/operations/local/unlock.ts index 721db62f9..e75cc6208 100644 --- a/packages/payload/src/auth/operations/local/unlock.ts +++ b/packages/payload/src/auth/operations/local/unlock.ts @@ -1,5 +1,5 @@ import type { CollectionSlug, Payload, RequestContext } from '../../../index.js' -import type { PayloadRequestWithData } from '../../../types/index.js' +import type { PayloadRequest } from '../../../types/index.js' import { APIError } from '../../../errors/index.js' import { createLocalReq } from '../../../utilities/createLocalReq.js' @@ -12,7 +12,7 @@ export type Options = { email } overrideAccess: boolean - req?: PayloadRequestWithData + req?: PayloadRequest } async function localUnlock( diff --git a/packages/payload/src/auth/operations/local/verifyEmail.ts b/packages/payload/src/auth/operations/local/verifyEmail.ts index d75df2c5b..9b8f12b6d 100644 --- a/packages/payload/src/auth/operations/local/verifyEmail.ts +++ b/packages/payload/src/auth/operations/local/verifyEmail.ts @@ -1,5 +1,5 @@ import type { CollectionSlug, Payload, RequestContext } from '../../../index.js' -import type { PayloadRequestWithData } from '../../../types/index.js' +import type { PayloadRequest } from '../../../types/index.js' import { APIError } from '../../../errors/index.js' import { createLocalReq } from '../../../utilities/createLocalReq.js' @@ -8,7 +8,7 @@ import { verifyEmailOperation } from '../verifyEmail.js' export type Options = { collection: T context?: RequestContext - req?: PayloadRequestWithData + req?: PayloadRequest token: string } diff --git a/packages/payload/src/auth/operations/login.ts b/packages/payload/src/auth/operations/login.ts index 2302300a7..2954aac7d 100644 --- a/packages/payload/src/auth/operations/login.ts +++ b/packages/payload/src/auth/operations/login.ts @@ -2,7 +2,7 @@ import jwt from 'jsonwebtoken' import type { Collection, DataFromCollectionSlug } from '../../collections/config/types.js' import type { CollectionSlug } from '../../index.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { User } from '../types.js' import { buildAfterOperation } from '../../collections/operations/utils.js' @@ -32,7 +32,7 @@ export type Arguments = { } depth?: number overrideAccess?: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields?: boolean } diff --git a/packages/payload/src/auth/operations/logout.ts b/packages/payload/src/auth/operations/logout.ts index 617a991c8..a84b4476a 100644 --- a/packages/payload/src/auth/operations/logout.ts +++ b/packages/payload/src/auth/operations/logout.ts @@ -1,13 +1,13 @@ import httpStatus from 'http-status' import type { Collection } from '../../collections/config/types.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import { APIError } from '../../errors/index.js' export type Arguments = { collection: Collection - req: PayloadRequestWithData + req: PayloadRequest } export const logoutOperation = async (incomingArgs: Arguments): Promise => { diff --git a/packages/payload/src/auth/operations/me.ts b/packages/payload/src/auth/operations/me.ts index 87602c8d1..c997c0206 100644 --- a/packages/payload/src/auth/operations/me.ts +++ b/packages/payload/src/auth/operations/me.ts @@ -1,7 +1,7 @@ import jwt from 'jsonwebtoken' import type { Collection } from '../../collections/config/types.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { ClientUser, User } from '../types.js' export type MeOperationResult = { @@ -15,7 +15,7 @@ export type MeOperationResult = { export type Arguments = { collection: Collection currentToken?: string - req: PayloadRequestWithData + req: PayloadRequest } export const meOperation = async (args: Arguments): Promise => { diff --git a/packages/payload/src/auth/operations/refresh.ts b/packages/payload/src/auth/operations/refresh.ts index 345575a29..bea626581 100644 --- a/packages/payload/src/auth/operations/refresh.ts +++ b/packages/payload/src/auth/operations/refresh.ts @@ -2,7 +2,7 @@ import jwt from 'jsonwebtoken' import url from 'url' import type { BeforeOperationHook, Collection } from '../../collections/config/types.js' -import type { Document, PayloadRequestWithData } from '../../types/index.js' +import type { Document, PayloadRequest } from '../../types/index.js' import { buildAfterOperation } from '../../collections/operations/utils.js' import { Forbidden } from '../../errors/index.js' @@ -21,7 +21,7 @@ export type Result = { export type Arguments = { collection: Collection - req: PayloadRequestWithData + req: PayloadRequest } export const refreshOperation = async (incomingArgs: Arguments): Promise => { diff --git a/packages/payload/src/auth/operations/registerFirstUser.ts b/packages/payload/src/auth/operations/registerFirstUser.ts index aa67bbe0f..a858e4ca6 100644 --- a/packages/payload/src/auth/operations/registerFirstUser.ts +++ b/packages/payload/src/auth/operations/registerFirstUser.ts @@ -4,7 +4,7 @@ import type { RequiredDataFromCollectionSlug, } from '../../collections/config/types.js' import type { CollectionSlug } from '../../index.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import { Forbidden } from '../../errors/index.js' import { commitTransaction } from '../../utilities/commitTransaction.js' @@ -17,7 +17,7 @@ export type Arguments = { email: string password: string } - req: PayloadRequestWithData + req: PayloadRequest } export type Result = { diff --git a/packages/payload/src/auth/operations/resetPassword.ts b/packages/payload/src/auth/operations/resetPassword.ts index 3e7161a50..3211140c0 100644 --- a/packages/payload/src/auth/operations/resetPassword.ts +++ b/packages/payload/src/auth/operations/resetPassword.ts @@ -2,7 +2,7 @@ import httpStatus from 'http-status' import jwt from 'jsonwebtoken' import type { Collection } from '../../collections/config/types.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import { APIError } from '../../errors/index.js' import { commitTransaction } from '../../utilities/commitTransaction.js' @@ -25,7 +25,7 @@ export type Arguments = { } depth?: number overrideAccess?: boolean - req: PayloadRequestWithData + req: PayloadRequest } export const resetPasswordOperation = async (args: Arguments): Promise => { diff --git a/packages/payload/src/auth/operations/unlock.ts b/packages/payload/src/auth/operations/unlock.ts index f49f1d149..2d4d82a5b 100644 --- a/packages/payload/src/auth/operations/unlock.ts +++ b/packages/payload/src/auth/operations/unlock.ts @@ -1,7 +1,7 @@ import httpStatus from 'http-status' import type { Collection } from '../../collections/config/types.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import { APIError } from '../../errors/index.js' import { commitTransaction } from '../../utilities/commitTransaction.js' @@ -16,7 +16,7 @@ export type Args = { email: string } overrideAccess?: boolean - req: PayloadRequestWithData + req: PayloadRequest } export const unlockOperation = async (args: Args): Promise => { diff --git a/packages/payload/src/auth/operations/verifyEmail.ts b/packages/payload/src/auth/operations/verifyEmail.ts index df3c971b0..ae4a157d2 100644 --- a/packages/payload/src/auth/operations/verifyEmail.ts +++ b/packages/payload/src/auth/operations/verifyEmail.ts @@ -1,7 +1,7 @@ import httpStatus from 'http-status' import type { Collection } from '../../collections/config/types.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import { APIError } from '../../errors/index.js' import { commitTransaction } from '../../utilities/commitTransaction.js' @@ -10,7 +10,7 @@ import { killTransaction } from '../../utilities/killTransaction.js' export type Args = { collection: Collection - req: PayloadRequestWithData + req: PayloadRequest token: string } diff --git a/packages/payload/src/auth/sendVerificationEmail.ts b/packages/payload/src/auth/sendVerificationEmail.ts index 0bb1b5efe..3e3060a66 100644 --- a/packages/payload/src/auth/sendVerificationEmail.ts +++ b/packages/payload/src/auth/sendVerificationEmail.ts @@ -3,7 +3,7 @@ import { URL } from 'url' import type { Collection } from '../collections/config/types.js' import type { SanitizedConfig } from '../config/types.js' import type { InitializedEmailAdapter } from '../email/types.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import type { User, VerifyConfig } from './types.js' type Args = { @@ -11,7 +11,7 @@ type Args = { config: SanitizedConfig disableEmail: boolean email: InitializedEmailAdapter - req: PayloadRequestWithData + req: PayloadRequest token: string user: User } diff --git a/packages/payload/src/auth/strategies/local/incrementLoginAttempts.ts b/packages/payload/src/auth/strategies/local/incrementLoginAttempts.ts index 5a71852f7..7538b79d4 100644 --- a/packages/payload/src/auth/strategies/local/incrementLoginAttempts.ts +++ b/packages/payload/src/auth/strategies/local/incrementLoginAttempts.ts @@ -1,12 +1,12 @@ import type { SanitizedCollectionConfig, TypeWithID } from '../../../collections/config/types.js' import type { Payload } from '../../../index.js' -import type { PayloadRequestWithData } from '../../../types/index.js' +import type { PayloadRequest } from '../../../types/index.js' type Args = { collection: SanitizedCollectionConfig doc: TypeWithID & Record payload: Payload - req: PayloadRequestWithData + req: PayloadRequest } export const incrementLoginAttempts = async ({ diff --git a/packages/payload/src/auth/strategies/local/register.ts b/packages/payload/src/auth/strategies/local/register.ts index 2ea1932de..9cf0de8ee 100644 --- a/packages/payload/src/auth/strategies/local/register.ts +++ b/packages/payload/src/auth/strategies/local/register.ts @@ -1,6 +1,6 @@ import type { SanitizedCollectionConfig } from '../../../collections/config/types.js' import type { Payload } from '../../../index.js' -import type { PayloadRequestWithData } from '../../../types/index.js' +import type { PayloadRequest } from '../../../types/index.js' import { ValidationError } from '../../../errors/index.js' import { generatePasswordSaltHash } from './generatePasswordSaltHash.js' @@ -10,7 +10,7 @@ type Args = { doc: Record password: string payload: Payload - req: PayloadRequestWithData + req: PayloadRequest } export const registerLocalStrategy = async ({ diff --git a/packages/payload/src/auth/strategies/local/resetLoginAttempts.ts b/packages/payload/src/auth/strategies/local/resetLoginAttempts.ts index d6448be4e..142fa31a3 100644 --- a/packages/payload/src/auth/strategies/local/resetLoginAttempts.ts +++ b/packages/payload/src/auth/strategies/local/resetLoginAttempts.ts @@ -1,12 +1,12 @@ import type { SanitizedCollectionConfig, TypeWithID } from '../../../collections/config/types.js' import type { Payload } from '../../../index.js' -import type { PayloadRequestWithData } from '../../../types/index.js' +import type { PayloadRequest } from '../../../types/index.js' type Args = { collection: SanitizedCollectionConfig doc: TypeWithID & Record payload: Payload - req: PayloadRequestWithData + req: PayloadRequest } export const resetLoginAttempts = async ({ diff --git a/packages/payload/src/auth/types.ts b/packages/payload/src/auth/types.ts index 857220ead..9963ca256 100644 --- a/packages/payload/src/auth/types.ts +++ b/packages/payload/src/auth/types.ts @@ -1,7 +1,7 @@ import type { DeepRequired } from 'ts-essentials' import type { Payload } from '../index.js' -import type { PayloadRequestWithData, Where } from '../types/index.js' +import type { PayloadRequest, Where } from '../types/index.js' export type Permission = { permission: boolean @@ -75,25 +75,25 @@ export type User = { export type ClientUser = Omit type GenerateVerifyEmailHTML = (args: { - req: PayloadRequestWithData + req: PayloadRequest token: string user: TUser }) => Promise | string type GenerateVerifyEmailSubject = (args: { - req: PayloadRequestWithData + req: PayloadRequest token: string user: TUser }) => Promise | string type GenerateForgotPasswordEmailHTML = (args?: { - req?: PayloadRequestWithData + req?: PayloadRequest token?: string user?: TUser }) => Promise | string type GenerateForgotPasswordEmailSubject = (args?: { - req?: PayloadRequestWithData + req?: PayloadRequest token?: string user?: TUser }) => Promise | string diff --git a/packages/payload/src/collections/config/types.ts b/packages/payload/src/collections/config/types.ts index 6de6f3564..b062c1d90 100644 --- a/packages/payload/src/collections/config/types.ts +++ b/packages/payload/src/collections/config/types.ts @@ -29,7 +29,7 @@ import type { import type { DBIdentifierName } from '../../database/types.js' import type { Field } from '../../fields/config/types.js' import type { CollectionSlug, TypedCollection } from '../../index.js' -import type { PayloadRequestWithData, RequestContext } from '../../types/index.js' +import type { PayloadRequest, RequestContext } from '../../types/index.js' import type { SanitizedUploadConfig, UploadConfig } from '../../uploads/types.js' import type { IncomingCollectionVersions, @@ -69,7 +69,7 @@ export type BeforeOperationHook = (args: { * Hook operation being performed */ operation: HookOperationType - req: PayloadRequestWithData + req: PayloadRequest }) => any export type BeforeValidateHook = (args: { @@ -87,7 +87,7 @@ export type BeforeValidateHook = (args: { * `undefined` on 'create' operation */ originalDoc?: T - req: PayloadRequestWithData + req: PayloadRequest }) => any export type BeforeChangeHook = (args: { @@ -105,7 +105,7 @@ export type BeforeChangeHook = (args: { * `undefined` on 'create' operation */ originalDoc?: T - req: PayloadRequestWithData + req: PayloadRequest }) => any export type AfterChangeHook = (args: { @@ -118,7 +118,7 @@ export type AfterChangeHook = (args: { */ operation: CreateOrUpdateOperation previousDoc: T - req: PayloadRequestWithData + req: PayloadRequest }) => any export type BeforeReadHook = (args: { @@ -127,7 +127,7 @@ export type BeforeReadHook = (args: { context: RequestContext doc: T query: { [key: string]: any } - req: PayloadRequestWithData + req: PayloadRequest }) => any export type AfterReadHook = (args: { @@ -137,7 +137,7 @@ export type AfterReadHook = (args: { doc: T findMany?: boolean query?: { [key: string]: any } - req: PayloadRequestWithData + req: PayloadRequest }) => any export type BeforeDeleteHook = (args: { @@ -145,7 +145,7 @@ export type BeforeDeleteHook = (args: { collection: SanitizedCollectionConfig context: RequestContext id: number | string - req: PayloadRequestWithData + req: PayloadRequest }) => any export type AfterDeleteHook = (args: { @@ -154,7 +154,7 @@ export type AfterDeleteHook = (args: { context: RequestContext doc: T id: number | string - req: PayloadRequestWithData + req: PayloadRequest }) => any export type AfterOperationHook = ( @@ -181,7 +181,7 @@ export type BeforeLoginHook = (args: { /** The collection which this hook is being run on */ collection: SanitizedCollectionConfig context: RequestContext - req: PayloadRequestWithData + req: PayloadRequest user: T }) => any @@ -189,7 +189,7 @@ export type AfterLoginHook = (args: { /** The collection which this hook is being run on */ collection: SanitizedCollectionConfig context: RequestContext - req: PayloadRequestWithData + req: PayloadRequest token: string user: T }) => any @@ -198,14 +198,14 @@ export type AfterLogoutHook = (args: { /** The collection which this hook is being run on */ collection: SanitizedCollectionConfig context: RequestContext - req: PayloadRequestWithData + req: PayloadRequest }) => any export type AfterMeHook = (args: { /** The collection which this hook is being run on */ collection: SanitizedCollectionConfig context: RequestContext - req: PayloadRequestWithData + req: PayloadRequest response: unknown }) => any @@ -224,7 +224,7 @@ export type AfterRefreshHook = (args: { collection: SanitizedCollectionConfig context: RequestContext exp: number - req: PayloadRequestWithData + req: PayloadRequest token: string }) => any @@ -346,7 +346,7 @@ export type CollectionConfig = { * Access control */ access?: { - admin?: ({ req }: { req: PayloadRequestWithData }) => Promise | boolean + admin?: ({ req }: { req: PayloadRequest }) => Promise | boolean create?: Access delete?: Access read?: Access diff --git a/packages/payload/src/collections/dataloader.ts b/packages/payload/src/collections/dataloader.ts index aacf9f946..512b6be07 100644 --- a/packages/payload/src/collections/dataloader.ts +++ b/packages/payload/src/collections/dataloader.ts @@ -2,7 +2,7 @@ import type { BatchLoadFn } from 'dataloader' import DataLoader from 'dataloader' -import type { PayloadRequest, PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import type { TypeWithID } from './config/types.js' import { isValidID } from '../utilities/isValidID.js' @@ -115,7 +115,7 @@ const batchAndLoadDocs = locale, overrideAccess: Boolean(overrideAccess), pagination: false, - req: req as PayloadRequestWithData, + req, showHiddenFields: Boolean(showHiddenFields), where: { id: { diff --git a/packages/payload/src/collections/operations/count.ts b/packages/payload/src/collections/operations/count.ts index cba7b851a..f2ed96ce7 100644 --- a/packages/payload/src/collections/operations/count.ts +++ b/packages/payload/src/collections/operations/count.ts @@ -1,7 +1,7 @@ import type { AccessResult } from '../../config/types.js' import type { CollectionSlug } from '../../index.js' -import type { PayloadRequestWithData, Where } from '../../types/index.js' -import type { Collection, TypeWithID } from '../config/types.js' +import type { PayloadRequest, Where } from '../../types/index.js' +import type { Collection } from '../config/types.js' import executeAccess from '../../auth/executeAccess.js' import { combineQueries } from '../../database/combineQueries.js' @@ -15,7 +15,7 @@ export type Arguments = { collection: Collection disableErrors?: boolean overrideAccess?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest where?: Where } diff --git a/packages/payload/src/collections/operations/create.ts b/packages/payload/src/collections/operations/create.ts index 9b48923b2..16cae7825 100644 --- a/packages/payload/src/collections/operations/create.ts +++ b/packages/payload/src/collections/operations/create.ts @@ -1,7 +1,7 @@ import crypto from 'crypto' -import type { CollectionSlug, GeneratedTypes } from '../../index.js' -import type { Document, PayloadRequestWithData } from '../../types/index.js' +import type { CollectionSlug } from '../../index.js' +import type { Document, PayloadRequest } from '../../types/index.js' import type { AfterChangeHook, BeforeOperationHook, @@ -37,7 +37,7 @@ export type Arguments = { draft?: boolean overrideAccess?: boolean overwriteExistingFiles?: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields?: boolean } diff --git a/packages/payload/src/collections/operations/delete.ts b/packages/payload/src/collections/operations/delete.ts index abc261203..780fdc2a6 100644 --- a/packages/payload/src/collections/operations/delete.ts +++ b/packages/payload/src/collections/operations/delete.ts @@ -2,7 +2,7 @@ import httpStatus from 'http-status' import type { AccessResult } from '../../config/types.js' import type { CollectionSlug, GeneratedTypes } from '../../index.js' -import type { PayloadRequestWithData, Where } from '../../types/index.js' +import type { PayloadRequest, Where } from '../../types/index.js' import type { BeforeOperationHook, Collection, DataFromCollectionSlug } from '../config/types.js' import executeAccess from '../../auth/executeAccess.js' @@ -22,7 +22,7 @@ export type Arguments = { collection: Collection depth?: number overrideAccess?: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields?: boolean where: Where } diff --git a/packages/payload/src/collections/operations/deleteByID.ts b/packages/payload/src/collections/operations/deleteByID.ts index 31b88ce1e..a2929d7ee 100644 --- a/packages/payload/src/collections/operations/deleteByID.ts +++ b/packages/payload/src/collections/operations/deleteByID.ts @@ -1,5 +1,5 @@ import type { CollectionSlug } from '../../index.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { BeforeOperationHook, Collection, DataFromCollectionSlug } from '../config/types.js' import executeAccess from '../../auth/executeAccess.js' @@ -20,7 +20,7 @@ export type Arguments = { depth?: number id: number | string overrideAccess?: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields?: boolean } diff --git a/packages/payload/src/collections/operations/docAccess.ts b/packages/payload/src/collections/operations/docAccess.ts index 6f9a87437..0f39c293f 100644 --- a/packages/payload/src/collections/operations/docAccess.ts +++ b/packages/payload/src/collections/operations/docAccess.ts @@ -1,5 +1,5 @@ import type { CollectionPermission } from '../../auth/index.js' -import type { AllOperations, PayloadRequestWithData } from '../../types/index.js' +import type { AllOperations, PayloadRequest } from '../../types/index.js' import type { Collection } from '../config/types.js' import { commitTransaction } from '../../utilities/commitTransaction.js' @@ -12,7 +12,7 @@ const allOperations: AllOperations[] = ['create', 'read', 'update', 'delete'] type Arguments = { collection: Collection id: string - req: PayloadRequestWithData + req: PayloadRequest } export async function docAccessOperation(args: Arguments): Promise { diff --git a/packages/payload/src/collections/operations/duplicate.ts b/packages/payload/src/collections/operations/duplicate.ts index 977ba2901..9248a5400 100644 --- a/packages/payload/src/collections/operations/duplicate.ts +++ b/packages/payload/src/collections/operations/duplicate.ts @@ -4,7 +4,7 @@ import httpStatus from 'http-status' import type { FindOneArgs } from '../../database/types.js' import type { CollectionSlug } from '../../index.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { Collection, DataFromCollectionSlug } from '../config/types.js' import executeAccess from '../../auth/executeAccess.js' @@ -28,7 +28,7 @@ export type Arguments = { draft?: boolean id: number | string overrideAccess?: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields?: boolean } diff --git a/packages/payload/src/collections/operations/find.ts b/packages/payload/src/collections/operations/find.ts index 61d14e12e..c0d182441 100644 --- a/packages/payload/src/collections/operations/find.ts +++ b/packages/payload/src/collections/operations/find.ts @@ -1,7 +1,7 @@ import type { AccessResult } from '../../config/types.js' import type { PaginatedDocs } from '../../database/types.js' import type { CollectionSlug } from '../../index.js' -import type { PayloadRequestWithData, Where } from '../../types/index.js' +import type { PayloadRequest, Where } from '../../types/index.js' import type { Collection, DataFromCollectionSlug } from '../config/types.js' import executeAccess from '../../auth/executeAccess.js' @@ -26,7 +26,7 @@ export type Arguments = { overrideAccess?: boolean page?: number pagination?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean sort?: string where?: Where diff --git a/packages/payload/src/collections/operations/findByID.ts b/packages/payload/src/collections/operations/findByID.ts index 42fa5b645..75ed4fefe 100644 --- a/packages/payload/src/collections/operations/findByID.ts +++ b/packages/payload/src/collections/operations/findByID.ts @@ -1,7 +1,7 @@ /* eslint-disable no-underscore-dangle */ import type { FindOneArgs } from '../../database/types.js' import type { CollectionSlug } from '../../index.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { Collection, DataFromCollectionSlug } from '../config/types.js' import executeAccess from '../../auth/executeAccess.js' @@ -22,7 +22,7 @@ export type Arguments = { draft?: boolean id: number | string overrideAccess?: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields?: boolean } @@ -80,7 +80,7 @@ export const findByIDOperation = async ( locale, req: { transactionID: req.transactionID, - } as PayloadRequestWithData, + } as PayloadRequest, where: combineQueries({ id: { equals: id } }, accessResult), } diff --git a/packages/payload/src/collections/operations/findVersionByID.ts b/packages/payload/src/collections/operations/findVersionByID.ts index f5a300b60..46b771ca4 100644 --- a/packages/payload/src/collections/operations/findVersionByID.ts +++ b/packages/payload/src/collections/operations/findVersionByID.ts @@ -1,7 +1,7 @@ /* eslint-disable no-underscore-dangle */ import httpStatus from 'http-status' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { TypeWithVersion } from '../../versions/types.js' import type { Collection, TypeWithID } from '../config/types.js' @@ -20,7 +20,7 @@ export type Arguments = { disableErrors?: boolean id: number | string overrideAccess?: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields?: boolean } diff --git a/packages/payload/src/collections/operations/findVersions.ts b/packages/payload/src/collections/operations/findVersions.ts index 5c463b011..c64f44324 100644 --- a/packages/payload/src/collections/operations/findVersions.ts +++ b/packages/payload/src/collections/operations/findVersions.ts @@ -1,5 +1,5 @@ import type { PaginatedDocs } from '../../database/types.js' -import type { PayloadRequestWithData, Where } from '../../types/index.js' +import type { PayloadRequest, Where } from '../../types/index.js' import type { TypeWithVersion } from '../../versions/types.js' import type { Collection } from '../config/types.js' @@ -20,7 +20,7 @@ export type Arguments = { overrideAccess?: boolean page?: number pagination?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean sort?: string where?: Where diff --git a/packages/payload/src/collections/operations/local/count.ts b/packages/payload/src/collections/operations/local/count.ts index e2eb4bb82..bb7e13234 100644 --- a/packages/payload/src/collections/operations/local/count.ts +++ b/packages/payload/src/collections/operations/local/count.ts @@ -1,10 +1,5 @@ import type { CollectionSlug, Payload, TypedLocale } from '../../../index.js' -import type { - Document, - PayloadRequestWithData, - RequestContext, - Where, -} from '../../../types/index.js' +import type { Document, PayloadRequest, RequestContext, Where } from '../../../types/index.js' import { APIError } from '../../../errors/index.js' import { createLocalReq } from '../../../utilities/createLocalReq.js' @@ -20,7 +15,7 @@ export type Options = { disableErrors?: boolean locale?: TypedLocale overrideAccess?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest user?: Document where?: Where } diff --git a/packages/payload/src/collections/operations/local/create.ts b/packages/payload/src/collections/operations/local/create.ts index 21ca77b22..c4d26ef18 100644 --- a/packages/payload/src/collections/operations/local/create.ts +++ b/packages/payload/src/collections/operations/local/create.ts @@ -1,5 +1,5 @@ import type { CollectionSlug, Payload, TypedLocale } from '../../../index.js' -import type { Document, PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { Document, PayloadRequest, RequestContext } from '../../../types/index.js' import type { File } from '../../../uploads/types.js' import type { DataFromCollectionSlug, RequiredDataFromCollectionSlug } from '../../config/types.js' @@ -24,7 +24,7 @@ export type Options = { locale?: TypedLocale overrideAccess?: boolean overwriteExistingFiles?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean user?: Document } diff --git a/packages/payload/src/collections/operations/local/delete.ts b/packages/payload/src/collections/operations/local/delete.ts index 66b73b697..33cc1f26f 100644 --- a/packages/payload/src/collections/operations/local/delete.ts +++ b/packages/payload/src/collections/operations/local/delete.ts @@ -1,10 +1,5 @@ import type { CollectionSlug, Payload, TypedLocale } from '../../../index.js' -import type { - Document, - PayloadRequestWithData, - RequestContext, - Where, -} from '../../../types/index.js' +import type { Document, PayloadRequest, RequestContext, Where } from '../../../types/index.js' import type { BulkOperationResult, DataFromCollectionSlug } from '../../config/types.js' import { APIError } from '../../../errors/index.js' @@ -22,7 +17,7 @@ export type BaseOptions = { fallbackLocale?: TypedLocale locale?: TypedLocale overrideAccess?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean user?: Document } diff --git a/packages/payload/src/collections/operations/local/duplicate.ts b/packages/payload/src/collections/operations/local/duplicate.ts index afbc050d1..74a2d7b00 100644 --- a/packages/payload/src/collections/operations/local/duplicate.ts +++ b/packages/payload/src/collections/operations/local/duplicate.ts @@ -1,6 +1,6 @@ import type { CollectionSlug, TypedLocale } from '../../..//index.js' import type { Payload } from '../../../index.js' -import type { Document, PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { Document, PayloadRequest, RequestContext } from '../../../types/index.js' import type { DataFromCollectionSlug } from '../../config/types.js' import { APIError } from '../../../errors/index.js' @@ -19,7 +19,7 @@ export type Options = { id: number | string locale?: TypedLocale overrideAccess?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean user?: Document } diff --git a/packages/payload/src/collections/operations/local/find.ts b/packages/payload/src/collections/operations/local/find.ts index a06c8072e..1563a7e44 100644 --- a/packages/payload/src/collections/operations/local/find.ts +++ b/packages/payload/src/collections/operations/local/find.ts @@ -1,11 +1,6 @@ import type { PaginatedDocs } from '../../../database/types.js' import type { CollectionSlug, Payload, TypedLocale } from '../../../index.js' -import type { - Document, - PayloadRequestWithData, - RequestContext, - Where, -} from '../../../types/index.js' +import type { Document, PayloadRequest, RequestContext, Where } from '../../../types/index.js' import type { DataFromCollectionSlug } from '../../config/types.js' import { APIError } from '../../../errors/index.js' @@ -28,7 +23,7 @@ export type Options = { overrideAccess?: boolean page?: number pagination?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean sort?: string user?: Document diff --git a/packages/payload/src/collections/operations/local/findByID.ts b/packages/payload/src/collections/operations/local/findByID.ts index 5416c3494..362fb40f8 100644 --- a/packages/payload/src/collections/operations/local/findByID.ts +++ b/packages/payload/src/collections/operations/local/findByID.ts @@ -1,5 +1,5 @@ import type { CollectionSlug, Payload, TypedLocale } from '../../../index.js' -import type { Document, PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { Document, PayloadRequest, RequestContext } from '../../../types/index.js' import type { DataFromCollectionSlug } from '../../config/types.js' import { APIError } from '../../../errors/index.js' @@ -20,7 +20,7 @@ export type Options = { id: number | string locale?: 'all' | TypedLocale overrideAccess?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean user?: Document } diff --git a/packages/payload/src/collections/operations/local/findVersionByID.ts b/packages/payload/src/collections/operations/local/findVersionByID.ts index ea7dc0aef..53de77b65 100644 --- a/packages/payload/src/collections/operations/local/findVersionByID.ts +++ b/packages/payload/src/collections/operations/local/findVersionByID.ts @@ -1,5 +1,5 @@ import type { CollectionSlug, Payload, TypedLocale } from '../../../index.js' -import type { Document, PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { Document, PayloadRequest, RequestContext } from '../../../types/index.js' import type { TypeWithVersion } from '../../../versions/types.js' import type { DataFromCollectionSlug } from '../../config/types.js' @@ -20,7 +20,7 @@ export type Options = { id: string locale?: 'all' | TypedLocale overrideAccess?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean user?: Document } diff --git a/packages/payload/src/collections/operations/local/findVersions.ts b/packages/payload/src/collections/operations/local/findVersions.ts index a033be57b..9cb1caa86 100644 --- a/packages/payload/src/collections/operations/local/findVersions.ts +++ b/packages/payload/src/collections/operations/local/findVersions.ts @@ -1,11 +1,6 @@ import type { PaginatedDocs } from '../../../database/types.js' import type { CollectionSlug, Payload, TypedLocale } from '../../../index.js' -import type { - Document, - PayloadRequestWithData, - RequestContext, - Where, -} from '../../../types/index.js' +import type { Document, PayloadRequest, RequestContext, Where } from '../../../types/index.js' import type { TypeWithVersion } from '../../../versions/types.js' import type { DataFromCollectionSlug } from '../../config/types.js' @@ -26,7 +21,7 @@ export type Options = { locale?: 'all' | TypedLocale overrideAccess?: boolean page?: number - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean sort?: string user?: Document diff --git a/packages/payload/src/collections/operations/local/restoreVersion.ts b/packages/payload/src/collections/operations/local/restoreVersion.ts index c7bde8887..fc2b6bfe0 100644 --- a/packages/payload/src/collections/operations/local/restoreVersion.ts +++ b/packages/payload/src/collections/operations/local/restoreVersion.ts @@ -1,5 +1,5 @@ import type { CollectionSlug, Payload, TypedLocale } from '../../../index.js' -import type { Document, PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { Document, PayloadRequest, RequestContext } from '../../../types/index.js' import type { DataFromCollectionSlug } from '../../config/types.js' import { APIError } from '../../../errors/index.js' @@ -18,7 +18,7 @@ export type Options = { id: string locale?: TypedLocale overrideAccess?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean user?: Document } diff --git a/packages/payload/src/collections/operations/local/update.ts b/packages/payload/src/collections/operations/local/update.ts index 99466b02d..eb9ef3410 100644 --- a/packages/payload/src/collections/operations/local/update.ts +++ b/packages/payload/src/collections/operations/local/update.ts @@ -1,12 +1,7 @@ import type { DeepPartial } from 'ts-essentials' import type { CollectionSlug, Payload, TypedLocale } from '../../../index.js' -import type { - Document, - PayloadRequestWithData, - RequestContext, - Where, -} from '../../../types/index.js' +import type { Document, PayloadRequest, RequestContext, Where } from '../../../types/index.js' import type { File } from '../../../uploads/types.js' import type { BulkOperationResult, @@ -36,7 +31,7 @@ export type BaseOptions = { locale?: TypedLocale overrideAccess?: boolean overwriteExistingFiles?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean user?: Document } diff --git a/packages/payload/src/collections/operations/restoreVersion.ts b/packages/payload/src/collections/operations/restoreVersion.ts index c898954ab..fba874a02 100644 --- a/packages/payload/src/collections/operations/restoreVersion.ts +++ b/packages/payload/src/collections/operations/restoreVersion.ts @@ -2,7 +2,7 @@ import httpStatus from 'http-status' import type { FindOneArgs } from '../../database/types.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { Collection, TypeWithID } from '../config/types.js' import executeAccess from '../../auth/executeAccess.js' @@ -23,7 +23,7 @@ export type Arguments = { disableErrors?: boolean id: number | string overrideAccess?: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields?: boolean } diff --git a/packages/payload/src/collections/operations/update.ts b/packages/payload/src/collections/operations/update.ts index 9bfe75a5e..da0f12c3a 100644 --- a/packages/payload/src/collections/operations/update.ts +++ b/packages/payload/src/collections/operations/update.ts @@ -4,7 +4,7 @@ import httpStatus from 'http-status' import type { AccessResult } from '../../config/types.js' import type { CollectionSlug } from '../../index.js' -import type { PayloadRequestWithData, Where } from '../../types/index.js' +import type { PayloadRequest, Where } from '../../types/index.js' import type { BulkOperationResult, Collection, @@ -40,7 +40,7 @@ export type Arguments = { draft?: boolean overrideAccess?: boolean overwriteExistingFiles?: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields?: boolean where: Where } diff --git a/packages/payload/src/collections/operations/updateByID.ts b/packages/payload/src/collections/operations/updateByID.ts index 0a8253d80..11dfcbce8 100644 --- a/packages/payload/src/collections/operations/updateByID.ts +++ b/packages/payload/src/collections/operations/updateByID.ts @@ -4,7 +4,7 @@ import httpStatus from 'http-status' import type { FindOneArgs } from '../../database/types.js' import type { CollectionSlug, GeneratedTypes } from '../../index.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { Collection, DataFromCollectionSlug, @@ -41,7 +41,7 @@ export type Arguments = { id: number | string overrideAccess?: boolean overwriteExistingFiles?: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields?: boolean } diff --git a/packages/payload/src/collections/operations/utils.ts b/packages/payload/src/collections/operations/utils.ts index 1fbdfc2f4..eeceb9aa3 100644 --- a/packages/payload/src/collections/operations/utils.ts +++ b/packages/payload/src/collections/operations/utils.ts @@ -2,7 +2,7 @@ import type { forgotPasswordOperation } from '../../auth/operations/forgotPasswo import type { loginOperation } from '../../auth/operations/login.js' import type { refreshOperation } from '../../auth/operations/refresh.js' import type { CollectionSlug } from '../../index.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { AfterOperationHook, SanitizedCollectionConfig } from '../config/types.js' import type { countOperation } from './count.js' import type { createOperation } from './create.js' @@ -30,7 +30,7 @@ export type AfterOperationMap = { export type AfterOperationArg = { /** The collection which this hook is being run on */ collection: SanitizedCollectionConfig - req: PayloadRequestWithData + req: PayloadRequest } & ( | { args: Parameters['count']>[0] diff --git a/packages/payload/src/config/types.ts b/packages/payload/src/config/types.ts index cb6221397..a6cc21e97 100644 --- a/packages/payload/src/config/types.ts +++ b/packages/payload/src/config/types.ts @@ -26,7 +26,7 @@ import type { DatabaseAdapterResult } from '../database/types.js' import type { EmailAdapter, SendEmailOptions } from '../email/types.js' import type { GlobalConfig, Globals, SanitizedGlobalConfig } from '../globals/config/types.js' import type { Payload, TypedUser } from '../index.js' -import type { PayloadRequest, PayloadRequestWithData, Where } from '../types/index.js' +import type { PayloadRequest, Where } from '../types/index.js' import type { PayloadLogger } from '../utilities/logger.js' export type BinScriptConfig = { @@ -147,7 +147,7 @@ export type ServerOnlyLivePreviewProperties = keyof Pick = { /** If true, the request is for a static file */ isReadingStaticFile?: boolean /** The original request that requires an access check */ - req: PayloadRequestWithData + req: PayloadRequest } /** diff --git a/packages/payload/src/database/migrations/migrate.ts b/packages/payload/src/database/migrations/migrate.ts index a4ef0ccb3..505345b6a 100644 --- a/packages/payload/src/database/migrations/migrate.ts +++ b/packages/payload/src/database/migrations/migrate.ts @@ -1,5 +1,5 @@ /* eslint-disable no-restricted-syntax, no-await-in-loop */ -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { BaseDatabaseAdapter } from '../types.js' import { commitTransaction } from '../../utilities/commitTransaction.js' @@ -27,7 +27,7 @@ export async function migrate(this: BaseDatabaseAdapter): Promise { } const start = Date.now() - const req = { payload } as PayloadRequestWithData + const req = { payload } as PayloadRequest payload.logger.info({ msg: `Migrating: ${migration.name}` }) diff --git a/packages/payload/src/database/migrations/migrateDown.ts b/packages/payload/src/database/migrations/migrateDown.ts index e3c34a17f..d7f121025 100644 --- a/packages/payload/src/database/migrations/migrateDown.ts +++ b/packages/payload/src/database/migrations/migrateDown.ts @@ -1,5 +1,5 @@ /* eslint-disable no-restricted-syntax, no-await-in-loop */ -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { BaseDatabaseAdapter } from '../types.js' import { commitTransaction } from '../../utilities/commitTransaction.js' @@ -34,7 +34,7 @@ export async function migrateDown(this: BaseDatabaseAdapter): Promise { } const start = Date.now() - const req = { payload } as PayloadRequestWithData + const req = { payload } as PayloadRequest try { payload.logger.info({ msg: `Migrating down: ${migrationFile.name}` }) diff --git a/packages/payload/src/database/migrations/migrateRefresh.ts b/packages/payload/src/database/migrations/migrateRefresh.ts index 10b986ab2..363b31fde 100644 --- a/packages/payload/src/database/migrations/migrateRefresh.ts +++ b/packages/payload/src/database/migrations/migrateRefresh.ts @@ -1,5 +1,5 @@ /* eslint-disable no-restricted-syntax, no-await-in-loop */ -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { BaseDatabaseAdapter } from '../types.js' import { commitTransaction } from '../../utilities/commitTransaction.js' @@ -28,7 +28,7 @@ export async function migrateRefresh(this: BaseDatabaseAdapter) { msg: `Rolling back batch ${latestBatch} consisting of ${existingMigrations.length} migration(s).`, }) - const req = { payload } as PayloadRequestWithData + const req = { payload } as PayloadRequest // Reverse order of migrations to rollback existingMigrations.reverse() diff --git a/packages/payload/src/database/migrations/migrateReset.ts b/packages/payload/src/database/migrations/migrateReset.ts index a2949bd56..6a40bb1d0 100644 --- a/packages/payload/src/database/migrations/migrateReset.ts +++ b/packages/payload/src/database/migrations/migrateReset.ts @@ -1,5 +1,5 @@ /* eslint-disable no-restricted-syntax, no-await-in-loop */ -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { BaseDatabaseAdapter } from '../types.js' import { commitTransaction } from '../../utilities/commitTransaction.js' @@ -19,7 +19,7 @@ export async function migrateReset(this: BaseDatabaseAdapter): Promise { return } - const req = { payload } as PayloadRequestWithData + const req = { payload } as PayloadRequest // Rollback all migrations in order for (const migration of migrationFiles) { diff --git a/packages/payload/src/database/queryValidation/validateQueryPaths.ts b/packages/payload/src/database/queryValidation/validateQueryPaths.ts index 8d4f478bb..302102313 100644 --- a/packages/payload/src/database/queryValidation/validateQueryPaths.ts +++ b/packages/payload/src/database/queryValidation/validateQueryPaths.ts @@ -3,7 +3,7 @@ import type { SanitizedCollectionConfig } from '../../collections/config/types.j import type { Field, FieldAffectingData } from '../../fields/config/types.js' import type { SanitizedGlobalConfig } from '../../globals/config/types.js' /* eslint-disable no-await-in-loop */ -import type { Operator, PayloadRequestWithData, Where, WhereField } from '../../types/index.js' +import type { Operator, PayloadRequest, Where, WhereField } from '../../types/index.js' import type { EntityPolicies } from './types.js' import { QueryError } from '../../errors/QueryError.js' @@ -16,7 +16,7 @@ type Args = { errors?: { path: string }[] overrideAccess: boolean policies?: EntityPolicies - req: PayloadRequestWithData + req: PayloadRequest versionFields?: Field[] where: Where } & ( @@ -63,9 +63,9 @@ export async function validateQueryPaths({ const whereFields = flattenWhere(where) // We need to determine if the whereKey is an AND, OR, or a schema path const promises = [] - whereFields.map(async (constraint) => { - Object.keys(constraint).map(async (path) => { - Object.entries(constraint[path]).map(async ([operator, val]) => { + void whereFields.map((constraint) => { + void Object.keys(constraint).map((path) => { + void Object.entries(constraint[path]).map(([operator, val]) => { if (validOperators.includes(operator as Operator)) { promises.push( validateSearchParam({ diff --git a/packages/payload/src/database/queryValidation/validateSearchParams.ts b/packages/payload/src/database/queryValidation/validateSearchParams.ts index f7ffa529b..6709a6a91 100644 --- a/packages/payload/src/database/queryValidation/validateSearchParams.ts +++ b/packages/payload/src/database/queryValidation/validateSearchParams.ts @@ -1,7 +1,7 @@ import type { SanitizedCollectionConfig } from '../../collections/config/types.js' import type { Field } from '../../fields/config/types.js' import type { SanitizedGlobalConfig } from '../../globals/config/types.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { EntityPolicies, PathToQuery } from './types.js' import { fieldAffectsData } from '../../fields/config/types.js' @@ -19,7 +19,7 @@ type Args = { overrideAccess: boolean path: string policies: EntityPolicies - req: PayloadRequestWithData + req: PayloadRequest val: unknown versionFields?: Field[] } diff --git a/packages/payload/src/database/types.ts b/packages/payload/src/database/types.ts index db2d5ac0f..38fc818b3 100644 --- a/packages/payload/src/database/types.ts +++ b/packages/payload/src/database/types.ts @@ -1,5 +1,5 @@ import type { TypeWithID } from '../collections/config/types.js' -import type { Document, Payload, PayloadRequestWithData, Where } from '../types/index.js' +import type { Document, Payload, PayloadRequest, Where } from '../types/index.js' import type { TypeWithVersion } from '../versions/types.js' export type { TypeWithVersion } @@ -169,7 +169,7 @@ export type QueryDraftsArgs = { locale?: string page?: number pagination?: boolean - req: PayloadRequestWithData + req: PayloadRequest sort?: string where?: Where } @@ -179,7 +179,7 @@ export type QueryDrafts = (args: QueryDraftsArgs) => Promise(args: FindArgs) => Promise> export type CountArgs = { collection: string locale?: string - req: PayloadRequestWithData + req: PayloadRequest where?: Where } @@ -215,7 +215,7 @@ type BaseVersionArgs = { locale?: string page?: number pagination?: boolean - req: PayloadRequestWithData + req: PayloadRequest skip?: number sort?: string versions?: boolean @@ -236,7 +236,7 @@ export type FindGlobalVersionsArgs = BaseVersionArgs & { export type FindGlobalArgs = { locale?: string - req: PayloadRequestWithData + req: PayloadRequest slug: string where?: Where } @@ -244,7 +244,7 @@ export type FindGlobalArgs = { export type UpdateGlobalVersionArgs = { global: string locale?: string - req: PayloadRequestWithData + req: PayloadRequest versionData: T } & ( | { @@ -267,7 +267,7 @@ export type FindGlobal = = any>( export type CreateGlobalArgs = any> = { data: T - req: PayloadRequestWithData + req: PayloadRequest slug: string } export type CreateGlobal = = any>( @@ -276,7 +276,7 @@ export type CreateGlobal = = any>( export type UpdateGlobalArgs = any> = { data: T - req: PayloadRequestWithData + req: PayloadRequest slug: string } export type UpdateGlobal = = any>( @@ -291,7 +291,7 @@ export type FindGlobalVersions = ( export type DeleteVersionsArgs = { collection: string locale?: string - req: PayloadRequestWithData + req: PayloadRequest sort?: { [key: string]: string } @@ -304,7 +304,7 @@ export type CreateVersionArgs = { createdAt: string /** ID of the parent document for which the version should be created for */ parent: number | string - req: PayloadRequestWithData + req: PayloadRequest updatedAt: string versionData: T } @@ -319,7 +319,7 @@ export type CreateGlobalVersionArgs = { globalSlug: string /** ID of the parent document for which the version should be created for */ parent: number | string - req: PayloadRequestWithData + req: PayloadRequest updatedAt: string versionData: T } @@ -333,7 +333,7 @@ export type DeleteVersions = (args: DeleteVersionsArgs) => Promise export type UpdateVersionArgs = { collection: string locale?: string - req: PayloadRequestWithData + req: PayloadRequest versionData: T } & ( | { @@ -355,7 +355,7 @@ export type CreateArgs = { data: Record draft?: boolean locale?: string - req: PayloadRequestWithData + req: PayloadRequest } export type Create = (args: CreateArgs) => Promise @@ -365,7 +365,7 @@ export type UpdateOneArgs = { data: Record draft?: boolean locale?: string - req: PayloadRequestWithData + req: PayloadRequest } & ( | { id: number | string @@ -381,7 +381,7 @@ export type UpdateOne = (args: UpdateOneArgs) => Promise export type DeleteOneArgs = { collection: string - req: PayloadRequestWithData + req: PayloadRequest where: Where } @@ -389,15 +389,15 @@ export type DeleteOne = (args: DeleteOneArgs) => Promise export type DeleteManyArgs = { collection: string - req: PayloadRequestWithData + req: PayloadRequest where: Where } export type DeleteMany = (args: DeleteManyArgs) => Promise export type Migration = MigrationData & { - down: ({ payload, req }: { payload: Payload; req: PayloadRequestWithData }) => Promise - up: ({ payload, req }: { payload: Payload; req: PayloadRequestWithData }) => 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/fields/config/types.ts b/packages/payload/src/fields/config/types.ts index bdb9f3a16..2d6484f62 100644 --- a/packages/payload/src/fields/config/types.ts +++ b/packages/payload/src/fields/config/types.ts @@ -22,7 +22,7 @@ import type { DBIdentifierName } from '../../database/types.js' import type { SanitizedGlobalConfig } from '../../globals/config/types.js' import type { CollectionSlug, GeneratedTypes } from '../../index.js' import type { DocumentPreferences } from '../../preferences/types.js' -import type { Operation, PayloadRequestWithData, RequestContext, Where } from '../../types/index.js' +import type { Operation, PayloadRequest, RequestContext, Where } from '../../types/index.js' import type { ClientFieldConfig } from './client.js' export type FieldHookArgs = { @@ -53,7 +53,7 @@ export type FieldHookArgs = (a */ id?: number | string /** The `payload` object to interface with the payload API */ - req: PayloadRequestWithData + req: PayloadRequest /** * Immediately adjacent data to this field. For example, if this is a `group` field, then `siblingData` will be the other fields within the group. */ @@ -96,7 +96,7 @@ export type FieldAccess = (a export type Condition = ( data: Partial, siblingData: Partial, - { user }: { user: PayloadRequestWithData['user'] }, + { user }: { user: PayloadRequest['user'] }, ) => boolean export type FilterOptionsProps = { @@ -119,7 +119,7 @@ export type FilterOptionsProps = { /** * An object containing the currently authenticated user. */ - user: Partial + user: Partial } export type FilterOptions = @@ -175,7 +175,7 @@ export type BaseValidateOptions = { id?: number | string operation?: Operation preferences: DocumentPreferences - req: PayloadRequestWithData + req: PayloadRequest siblingData: Partial } diff --git a/packages/payload/src/fields/getDefaultValue.ts b/packages/payload/src/fields/getDefaultValue.ts index ac463b7a1..0ed59c46b 100644 --- a/packages/payload/src/fields/getDefaultValue.ts +++ b/packages/payload/src/fields/getDefaultValue.ts @@ -1,11 +1,11 @@ -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import { deepCopyObject } from '../utilities/deepCopyObject.js' type Args = { defaultValue: unknown locale: string | undefined - user: PayloadRequestWithData['user'] + user: PayloadRequest['user'] value?: unknown } diff --git a/packages/payload/src/fields/hooks/afterChange/index.ts b/packages/payload/src/fields/hooks/afterChange/index.ts index 835632a76..ec0bb5423 100644 --- a/packages/payload/src/fields/hooks/afterChange/index.ts +++ b/packages/payload/src/fields/hooks/afterChange/index.ts @@ -1,6 +1,6 @@ import type { SanitizedCollectionConfig } from '../../../collections/config/types.js' import type { SanitizedGlobalConfig } from '../../../globals/config/types.js' -import type { PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { PayloadRequest, RequestContext } from '../../../types/index.js' import { deepCopyObject } from '../../../utilities/deepCopyObject.js' import { traverseFields } from './traverseFields.js' @@ -19,7 +19,7 @@ type Args = { global: SanitizedGlobalConfig | null operation: 'create' | 'update' previousDoc: Record | T - req: PayloadRequestWithData + req: PayloadRequest } /** diff --git a/packages/payload/src/fields/hooks/afterChange/promise.ts b/packages/payload/src/fields/hooks/afterChange/promise.ts index 814247125..6af7cd845 100644 --- a/packages/payload/src/fields/hooks/afterChange/promise.ts +++ b/packages/payload/src/fields/hooks/afterChange/promise.ts @@ -2,7 +2,7 @@ import type { RichTextAdapter } from '../../../admin/RichText.js' import type { SanitizedCollectionConfig } from '../../../collections/config/types.js' import type { SanitizedGlobalConfig } from '../../../globals/config/types.js' -import type { PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { PayloadRequest, RequestContext } from '../../../types/index.js' import type { Field, TabAsField } from '../../config/types.js' import { MissingEditorProp } from '../../../errors/index.js' @@ -28,7 +28,7 @@ type Args = { parentSchemaPath: string[] previousDoc: Record previousSiblingDoc: Record - req: PayloadRequestWithData + req: PayloadRequest siblingData: Record siblingDoc: Record } diff --git a/packages/payload/src/fields/hooks/afterChange/traverseFields.ts b/packages/payload/src/fields/hooks/afterChange/traverseFields.ts index 09c90fdb9..a4c69a576 100644 --- a/packages/payload/src/fields/hooks/afterChange/traverseFields.ts +++ b/packages/payload/src/fields/hooks/afterChange/traverseFields.ts @@ -1,6 +1,6 @@ import type { SanitizedCollectionConfig } from '../../../collections/config/types.js' import type { SanitizedGlobalConfig } from '../../../globals/config/types.js' -import type { PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { PayloadRequest, RequestContext } from '../../../types/index.js' import type { Field, TabAsField } from '../../config/types.js' import { promise } from './promise.js' @@ -16,7 +16,7 @@ type Args = { path: (number | string)[] previousDoc: Record previousSiblingDoc: Record - req: PayloadRequestWithData + req: PayloadRequest schemaPath: string[] siblingData: Record siblingDoc: Record diff --git a/packages/payload/src/fields/hooks/afterRead/index.ts b/packages/payload/src/fields/hooks/afterRead/index.ts index 670952272..efa3ccf28 100644 --- a/packages/payload/src/fields/hooks/afterRead/index.ts +++ b/packages/payload/src/fields/hooks/afterRead/index.ts @@ -1,6 +1,6 @@ import type { SanitizedCollectionConfig } from '../../../collections/config/types.js' import type { SanitizedGlobalConfig } from '../../../globals/config/types.js' -import type { PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { PayloadRequest, RequestContext } from '../../../types/index.js' import { deepCopyObject } from '../../../utilities/deepCopyObject.js' import { traverseFields } from './traverseFields.js' @@ -18,7 +18,7 @@ type Args = { global: SanitizedGlobalConfig | null locale: string overrideAccess: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields: boolean } diff --git a/packages/payload/src/fields/hooks/afterRead/promise.ts b/packages/payload/src/fields/hooks/afterRead/promise.ts index aa29c1ade..3a60aa715 100644 --- a/packages/payload/src/fields/hooks/afterRead/promise.ts +++ b/packages/payload/src/fields/hooks/afterRead/promise.ts @@ -2,7 +2,7 @@ import type { RichTextAdapter } from '../../../admin/RichText.js' import type { SanitizedCollectionConfig } from '../../../collections/config/types.js' import type { SanitizedGlobalConfig } from '../../../globals/config/types.js' -import type { PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { PayloadRequest, RequestContext } from '../../../types/index.js' import type { Field, TabAsField } from '../../config/types.js' import { MissingEditorProp } from '../../../errors/index.js' @@ -39,7 +39,7 @@ type Args = { */ parentSchemaPath: string[] populationPromises: Promise[] - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields: boolean siblingDoc: Record triggerAccessControl?: boolean diff --git a/packages/payload/src/fields/hooks/afterRead/relationshipPopulationPromise.ts b/packages/payload/src/fields/hooks/afterRead/relationshipPopulationPromise.ts index 5d8a9aa18..41b2c39e4 100644 --- a/packages/payload/src/fields/hooks/afterRead/relationshipPopulationPromise.ts +++ b/packages/payload/src/fields/hooks/afterRead/relationshipPopulationPromise.ts @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData } from '../../../types/index.js' +import type { PayloadRequest } from '../../../types/index.js' import type { RelationshipField, UploadField } from '../../config/types.js' import { createDataloaderCacheKey } from '../../../collections/dataloader.js' @@ -16,7 +16,7 @@ type PopulateArgs = { key?: string locale: null | string overrideAccess: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields: boolean } @@ -103,7 +103,7 @@ type PromiseArgs = { field: RelationshipField | UploadField locale: null | string overrideAccess: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields: boolean siblingDoc: Record } diff --git a/packages/payload/src/fields/hooks/afterRead/traverseFields.ts b/packages/payload/src/fields/hooks/afterRead/traverseFields.ts index 36c9ec106..8f1f02bd7 100644 --- a/packages/payload/src/fields/hooks/afterRead/traverseFields.ts +++ b/packages/payload/src/fields/hooks/afterRead/traverseFields.ts @@ -1,6 +1,6 @@ import type { SanitizedCollectionConfig } from '../../../collections/config/types.js' import type { SanitizedGlobalConfig } from '../../../globals/config/types.js' -import type { PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { PayloadRequest, RequestContext } from '../../../types/index.js' import type { Field, TabAsField } from '../../config/types.js' import { promise } from './promise.js' @@ -25,7 +25,7 @@ type Args = { overrideAccess: boolean path: (number | string)[] populationPromises: Promise[] - req: PayloadRequestWithData + req: PayloadRequest schemaPath: string[] showHiddenFields: boolean siblingDoc: Record diff --git a/packages/payload/src/fields/hooks/beforeChange/index.ts b/packages/payload/src/fields/hooks/beforeChange/index.ts index 0a0f1ff8a..0bcdd2230 100644 --- a/packages/payload/src/fields/hooks/beforeChange/index.ts +++ b/packages/payload/src/fields/hooks/beforeChange/index.ts @@ -1,6 +1,6 @@ import type { SanitizedCollectionConfig } from '../../../collections/config/types.js' import type { SanitizedGlobalConfig } from '../../../globals/config/types.js' -import type { Operation, PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { Operation, PayloadRequest, RequestContext } from '../../../types/index.js' import { ValidationError } from '../../../errors/index.js' import { deepCopyObject } from '../../../utilities/deepCopyObject.js' @@ -16,7 +16,7 @@ type Args = { global: SanitizedGlobalConfig | null id?: number | string operation: Operation - req: PayloadRequestWithData + req: PayloadRequest skipValidation?: boolean } diff --git a/packages/payload/src/fields/hooks/beforeChange/promise.ts b/packages/payload/src/fields/hooks/beforeChange/promise.ts index 18c8a36e9..62de9ec1d 100644 --- a/packages/payload/src/fields/hooks/beforeChange/promise.ts +++ b/packages/payload/src/fields/hooks/beforeChange/promise.ts @@ -3,7 +3,7 @@ import merge from 'deepmerge' import type { RichTextAdapter } from '../../../admin/RichText.js' import type { SanitizedCollectionConfig } from '../../../collections/config/types.js' import type { SanitizedGlobalConfig } from '../../../globals/config/types.js' -import type { Operation, PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { Operation, PayloadRequest, RequestContext } from '../../../types/index.js' import type { Field, FieldHookArgs, TabAsField, ValidateOptions } from '../../config/types.js' import { MissingEditorProp } from '../../../errors/index.js' @@ -34,7 +34,7 @@ type Args = { * The parent's schemaPath (path without indexes). */ parentSchemaPath: string[] - req: PayloadRequestWithData + req: PayloadRequest siblingData: Record siblingDoc: Record siblingDocWithLocales?: Record diff --git a/packages/payload/src/fields/hooks/beforeChange/traverseFields.ts b/packages/payload/src/fields/hooks/beforeChange/traverseFields.ts index 5c9bbac79..ff3df2477 100644 --- a/packages/payload/src/fields/hooks/beforeChange/traverseFields.ts +++ b/packages/payload/src/fields/hooks/beforeChange/traverseFields.ts @@ -1,6 +1,6 @@ import type { SanitizedCollectionConfig } from '../../../collections/config/types.js' import type { SanitizedGlobalConfig } from '../../../globals/config/types.js' -import type { Operation, PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { Operation, PayloadRequest, RequestContext } from '../../../types/index.js' import type { Field, TabAsField } from '../../config/types.js' import { promise } from './promise.js' @@ -25,7 +25,7 @@ type Args = { mergeLocaleActions: (() => Promise)[] operation: Operation path: (number | string)[] - req: PayloadRequestWithData + req: PayloadRequest schemaPath: string[] siblingData: Record /** diff --git a/packages/payload/src/fields/hooks/beforeValidate/index.ts b/packages/payload/src/fields/hooks/beforeValidate/index.ts index 59f5cca89..0c3395f35 100644 --- a/packages/payload/src/fields/hooks/beforeValidate/index.ts +++ b/packages/payload/src/fields/hooks/beforeValidate/index.ts @@ -1,6 +1,6 @@ import type { SanitizedCollectionConfig } from '../../../collections/config/types.js' import type { SanitizedGlobalConfig } from '../../../globals/config/types.js' -import type { PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { PayloadRequest, RequestContext } from '../../../types/index.js' import { deepCopyObject } from '../../../utilities/deepCopyObject.js' import { traverseFields } from './traverseFields.js' @@ -15,7 +15,7 @@ type Args = { id?: number | string operation: 'create' | 'update' overrideAccess: boolean - req: PayloadRequestWithData + req: PayloadRequest } /** diff --git a/packages/payload/src/fields/hooks/beforeValidate/promise.ts b/packages/payload/src/fields/hooks/beforeValidate/promise.ts index 0e7a6c1ed..b569afe5a 100644 --- a/packages/payload/src/fields/hooks/beforeValidate/promise.ts +++ b/packages/payload/src/fields/hooks/beforeValidate/promise.ts @@ -2,7 +2,7 @@ import type { RichTextAdapter } from '../../../admin/RichText.js' import type { SanitizedCollectionConfig } from '../../../collections/config/types.js' import type { SanitizedGlobalConfig } from '../../../globals/config/types.js' -import type { PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { PayloadRequest, RequestContext } from '../../../types/index.js' import type { Field, TabAsField } from '../../config/types.js' import { MissingEditorProp } from '../../../errors/index.js' @@ -28,7 +28,7 @@ type Args = { overrideAccess: boolean parentPath: (number | string)[] parentSchemaPath: string[] - req: PayloadRequestWithData + req: PayloadRequest siblingData: Record /** * The original siblingData (not modified by any hooks) diff --git a/packages/payload/src/fields/hooks/beforeValidate/traverseFields.ts b/packages/payload/src/fields/hooks/beforeValidate/traverseFields.ts index e0ef4ccf3..64fe9d233 100644 --- a/packages/payload/src/fields/hooks/beforeValidate/traverseFields.ts +++ b/packages/payload/src/fields/hooks/beforeValidate/traverseFields.ts @@ -1,6 +1,6 @@ import type { SanitizedCollectionConfig } from '../../../collections/config/types.js' import type { SanitizedGlobalConfig } from '../../../globals/config/types.js' -import type { PayloadRequestWithData, RequestContext } from '../../../types/index.js' +import type { PayloadRequest, RequestContext } from '../../../types/index.js' import type { Field, TabAsField } from '../../config/types.js' import { promise } from './promise.js' @@ -19,7 +19,7 @@ type Args = { operation: 'create' | 'update' overrideAccess: boolean path: (number | string)[] - req: PayloadRequestWithData + req: PayloadRequest schemaPath: string[] siblingData: Record /** diff --git a/packages/payload/src/globals/config/types.ts b/packages/payload/src/globals/config/types.ts index 2629f841d..dece8b7df 100644 --- a/packages/payload/src/globals/config/types.ts +++ b/packages/payload/src/globals/config/types.ts @@ -20,7 +20,7 @@ import type { import type { DBIdentifierName } from '../../database/types.js' import type { Field } from '../../fields/config/types.js' import type { GlobalSlug, TypedGlobal } from '../../index.js' -import type { PayloadRequestWithData, RequestContext, Where } from '../../types/index.js' +import type { PayloadRequest, RequestContext, Where } from '../../types/index.js' import type { IncomingGlobalVersions, SanitizedGlobalVersions } from '../../versions/types.js' export type DataFromGlobalSlug = TypedGlobal[TSlug] @@ -31,7 +31,7 @@ export type BeforeValidateHook = (args: { /** The global which this hook is being run on */ global: SanitizedGlobalConfig originalDoc?: any - req: PayloadRequestWithData + req: PayloadRequest }) => any export type BeforeChangeHook = (args: { @@ -40,7 +40,7 @@ export type BeforeChangeHook = (args: { /** The global which this hook is being run on */ global: SanitizedGlobalConfig originalDoc?: any - req: PayloadRequestWithData + req: PayloadRequest }) => any export type AfterChangeHook = (args: { @@ -49,7 +49,7 @@ export type AfterChangeHook = (args: { /** The global which this hook is being run on */ global: SanitizedGlobalConfig previousDoc: any - req: PayloadRequestWithData + req: PayloadRequest }) => any export type BeforeReadHook = (args: { @@ -57,7 +57,7 @@ export type BeforeReadHook = (args: { doc: any /** The global which this hook is being run on */ global: SanitizedGlobalConfig - req: PayloadRequestWithData + req: PayloadRequest }) => any export type AfterReadHook = (args: { @@ -67,7 +67,7 @@ export type AfterReadHook = (args: { /** The global which this hook is being run on */ global: SanitizedGlobalConfig query?: Where - req: PayloadRequestWithData + req: PayloadRequest }) => any export type GlobalAdminOptions = { @@ -119,7 +119,7 @@ export type GlobalAdminOptions = { /** * Exclude the global from the admin nav and routes */ - hidden?: ((args: { user: PayloadRequestWithData['user'] }) => boolean) | boolean + hidden?: ((args: { user: PayloadRequest['user'] }) => boolean) | boolean /** * Hide the API URL within the Edit view */ diff --git a/packages/payload/src/globals/operations/docAccess.ts b/packages/payload/src/globals/operations/docAccess.ts index bf58c12ba..7d603ae53 100644 --- a/packages/payload/src/globals/operations/docAccess.ts +++ b/packages/payload/src/globals/operations/docAccess.ts @@ -1,5 +1,5 @@ import type { GlobalPermission } from '../../auth/index.js' -import type { AllOperations, PayloadRequestWithData } from '../../types/index.js' +import type { AllOperations, PayloadRequest } from '../../types/index.js' import type { SanitizedGlobalConfig } from '../config/types.js' import { commitTransaction } from '../../utilities/commitTransaction.js' @@ -9,7 +9,7 @@ import { killTransaction } from '../../utilities/killTransaction.js' type Arguments = { globalConfig: SanitizedGlobalConfig - req: PayloadRequestWithData + req: PayloadRequest } export const docAccessOperation = async (args: Arguments): Promise => { diff --git a/packages/payload/src/globals/operations/findOne.ts b/packages/payload/src/globals/operations/findOne.ts index 7bbcd23b2..eb74499d9 100644 --- a/packages/payload/src/globals/operations/findOne.ts +++ b/packages/payload/src/globals/operations/findOne.ts @@ -1,6 +1,6 @@ import type { AccessResult } from '../../config/types.js' import type { GeneratedTypes } from '../../index.js' -import type { PayloadRequestWithData, Where } from '../../types/index.js' +import type { PayloadRequest, Where } from '../../types/index.js' import type { SanitizedGlobalConfig } from '../config/types.js' import executeAccess from '../../auth/executeAccess.js' @@ -15,7 +15,7 @@ type Args = { draft?: boolean globalConfig: SanitizedGlobalConfig overrideAccess?: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields?: boolean slug: string } diff --git a/packages/payload/src/globals/operations/findVersionByID.ts b/packages/payload/src/globals/operations/findVersionByID.ts index 22ecc5bd2..6cd2710d1 100644 --- a/packages/payload/src/globals/operations/findVersionByID.ts +++ b/packages/payload/src/globals/operations/findVersionByID.ts @@ -1,6 +1,6 @@ /* eslint-disable no-underscore-dangle */ import type { FindGlobalVersionsArgs } from '../../database/types.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { TypeWithVersion } from '../../versions/types.js' import type { SanitizedGlobalConfig } from '../config/types.js' @@ -19,7 +19,7 @@ export type Arguments = { globalConfig: SanitizedGlobalConfig id: number | string overrideAccess?: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields?: boolean } diff --git a/packages/payload/src/globals/operations/findVersions.ts b/packages/payload/src/globals/operations/findVersions.ts index 52e2c12de..ee73878ee 100644 --- a/packages/payload/src/globals/operations/findVersions.ts +++ b/packages/payload/src/globals/operations/findVersions.ts @@ -1,5 +1,5 @@ import type { PaginatedDocs } from '../../database/types.js' -import type { PayloadRequestWithData, Where } from '../../types/index.js' +import type { PayloadRequest, Where } from '../../types/index.js' import type { TypeWithVersion } from '../../versions/types.js' import type { SanitizedGlobalConfig } from '../config/types.js' @@ -19,7 +19,7 @@ export type Arguments = { limit?: number overrideAccess?: boolean page?: number - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean sort?: string where?: Where diff --git a/packages/payload/src/globals/operations/local/findOne.ts b/packages/payload/src/globals/operations/local/findOne.ts index 98c774296..8f5a3359b 100644 --- a/packages/payload/src/globals/operations/local/findOne.ts +++ b/packages/payload/src/globals/operations/local/findOne.ts @@ -1,5 +1,5 @@ import type { GlobalSlug, Payload, RequestContext, TypedLocale } from '../../../index.js' -import type { Document, PayloadRequestWithData } from '../../../types/index.js' +import type { Document, PayloadRequest } from '../../../types/index.js' import type { DataFromGlobalSlug } from '../../config/types.js' import { APIError } from '../../../errors/index.js' @@ -13,7 +13,7 @@ export type Options = { fallbackLocale?: TypedLocale locale?: 'all' | TypedLocale overrideAccess?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean slug: TSlug user?: Document diff --git a/packages/payload/src/globals/operations/local/findVersionByID.ts b/packages/payload/src/globals/operations/local/findVersionByID.ts index 5c7baa91c..8bae4aa76 100644 --- a/packages/payload/src/globals/operations/local/findVersionByID.ts +++ b/packages/payload/src/globals/operations/local/findVersionByID.ts @@ -1,5 +1,5 @@ import type { GlobalSlug, Payload, RequestContext, TypedLocale } from '../../../index.js' -import type { Document, PayloadRequestWithData } from '../../../types/index.js' +import type { Document, PayloadRequest } from '../../../types/index.js' import type { TypeWithVersion } from '../../../versions/types.js' import type { DataFromGlobalSlug } from '../../config/types.js' @@ -15,7 +15,7 @@ export type Options = { id: string locale?: 'all' | TypedLocale overrideAccess?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean slug: TSlug user?: Document diff --git a/packages/payload/src/globals/operations/local/findVersions.ts b/packages/payload/src/globals/operations/local/findVersions.ts index 5fd3a864f..80ab12dc4 100644 --- a/packages/payload/src/globals/operations/local/findVersions.ts +++ b/packages/payload/src/globals/operations/local/findVersions.ts @@ -1,6 +1,6 @@ import type { PaginatedDocs } from '../../../database/types.js' import type { GlobalSlug, Payload, RequestContext, TypedLocale } from '../../../index.js' -import type { Document, PayloadRequestWithData, Where } from '../../../types/index.js' +import type { Document, PayloadRequest, Where } from '../../../types/index.js' import type { TypeWithVersion } from '../../../versions/types.js' import type { DataFromGlobalSlug } from '../../config/types.js' @@ -16,7 +16,7 @@ export type Options = { locale?: 'all' | TypedLocale overrideAccess?: boolean page?: number - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean slug: TSlug sort?: string diff --git a/packages/payload/src/globals/operations/local/restoreVersion.ts b/packages/payload/src/globals/operations/local/restoreVersion.ts index 7ba250594..48a8c8f29 100644 --- a/packages/payload/src/globals/operations/local/restoreVersion.ts +++ b/packages/payload/src/globals/operations/local/restoreVersion.ts @@ -1,5 +1,5 @@ import type { GlobalSlug, Payload, RequestContext, TypedLocale } from '../../../index.js' -import type { Document, PayloadRequestWithData } from '../../../types/index.js' +import type { Document, PayloadRequest } from '../../../types/index.js' import type { DataFromGlobalSlug } from '../../config/types.js' import { APIError } from '../../../errors/index.js' @@ -13,7 +13,7 @@ export type Options = { id: string locale?: TypedLocale overrideAccess?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean slug: TSlug user?: Document diff --git a/packages/payload/src/globals/operations/local/update.ts b/packages/payload/src/globals/operations/local/update.ts index 061e13ce0..01fa21e2f 100644 --- a/packages/payload/src/globals/operations/local/update.ts +++ b/packages/payload/src/globals/operations/local/update.ts @@ -1,7 +1,7 @@ import type { DeepPartial } from 'ts-essentials' import type { GlobalSlug, Payload, RequestContext, TypedLocale } from '../../../index.js' -import type { Document, PayloadRequestWithData } from '../../../types/index.js' +import type { Document, PayloadRequest } from '../../../types/index.js' import type { DataFromGlobalSlug } from '../../config/types.js' import { APIError } from '../../../errors/index.js' @@ -16,7 +16,7 @@ export type Options = { fallbackLocale?: TypedLocale locale?: TypedLocale overrideAccess?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean slug: TSlug user?: Document diff --git a/packages/payload/src/globals/operations/restoreVersion.ts b/packages/payload/src/globals/operations/restoreVersion.ts index b7db497f8..7e4537d46 100644 --- a/packages/payload/src/globals/operations/restoreVersion.ts +++ b/packages/payload/src/globals/operations/restoreVersion.ts @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import type { TypeWithVersion } from '../../versions/types.js' import type { SanitizedGlobalConfig } from '../config/types.js' @@ -15,7 +15,7 @@ export type Arguments = { globalConfig: SanitizedGlobalConfig id: number | string overrideAccess?: boolean - req?: PayloadRequestWithData + req?: PayloadRequest showHiddenFields?: boolean } diff --git a/packages/payload/src/globals/operations/update.ts b/packages/payload/src/globals/operations/update.ts index 71b24a48a..70e66526e 100644 --- a/packages/payload/src/globals/operations/update.ts +++ b/packages/payload/src/globals/operations/update.ts @@ -1,7 +1,7 @@ import type { DeepPartial } from 'ts-essentials' import type { GlobalSlug } from '../../index.js' -import type { PayloadRequestWithData, Where } from '../../types/index.js' +import type { PayloadRequest, Where } from '../../types/index.js' import type { DataFromGlobalSlug, SanitizedGlobalConfig } from '../config/types.js' import executeAccess from '../../auth/executeAccess.js' @@ -22,7 +22,7 @@ type Args = { draft?: boolean globalConfig: SanitizedGlobalConfig overrideAccess?: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields?: boolean slug: string } diff --git a/packages/payload/src/preferences/deleteUserPreferences.ts b/packages/payload/src/preferences/deleteUserPreferences.ts index b77081edf..1bf2ee3a9 100644 --- a/packages/payload/src/preferences/deleteUserPreferences.ts +++ b/packages/payload/src/preferences/deleteUserPreferences.ts @@ -1,6 +1,6 @@ import type { SanitizedCollectionConfig } from '../collections/config/types.js' import type { Payload } from '../index.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' type Args = { collectionConfig: SanitizedCollectionConfig @@ -9,7 +9,7 @@ type Args = { */ ids: (number | string)[] payload: Payload - req: PayloadRequestWithData + req: PayloadRequest } export const deleteUserPreferences = async ({ collectionConfig, ids, payload, req }: Args) => { if (collectionConfig.auth) { diff --git a/packages/payload/src/preferences/requestHandlers/delete.ts b/packages/payload/src/preferences/requestHandlers/delete.ts index b90c11ae6..ef1973a0d 100644 --- a/packages/payload/src/preferences/requestHandlers/delete.ts +++ b/packages/payload/src/preferences/requestHandlers/delete.ts @@ -1,7 +1,7 @@ import httpStatus from 'http-status' import type { PayloadHandler } from '../../config/types.js' -import type { PayloadRequestWithData } from '../../types/index.js' +import type { PayloadRequest } from '../../types/index.js' import deleteOperation from '../operations/delete.js' @@ -16,7 +16,7 @@ export const deleteHandler: PayloadHandler = async (incomingReq): Promise { data = {} } - const reqWithData: PayloadRequestWithData = incomingReq + const reqWithData: PayloadRequest = incomingReq if (data) { reqWithData.data = data diff --git a/packages/payload/src/preferences/types.ts b/packages/payload/src/preferences/types.ts index 6e0c890a0..b1819b961 100644 --- a/packages/payload/src/preferences/types.ts +++ b/packages/payload/src/preferences/types.ts @@ -1,11 +1,11 @@ import type { User } from '../auth/index.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' export type PreferenceRequest = { key: string overrideAccess?: boolean - req: PayloadRequestWithData - user: PayloadRequestWithData['user'] + req: PayloadRequest + user: PayloadRequest['user'] } export type PreferenceUpdateRequest = PreferenceRequest & { value: unknown } diff --git a/packages/payload/src/types/index.ts b/packages/payload/src/types/index.ts index bcca8c1ca..1930478fb 100644 --- a/packages/payload/src/types/index.ts +++ b/packages/payload/src/types/index.ts @@ -55,10 +55,20 @@ export type CustomPayloadRequestProperties = { URL, 'hash' | 'host' | 'href' | 'origin' | 'pathname' | 'port' | 'protocol' | 'search' | 'searchParams' > -export type PayloadRequestData = { - /** Data from the request body */ +type PayloadRequestData = { + /** + * Data from the request body + * + * Within Payload operations, i.e. hooks, data will be there + * BUT in custom endpoints it will not be, you will need to + * use either: + * 1. `const data = await req.json()` + * + * 2. import { addDataAndFileToRequest } from '@payloadcms/next/utilities' + * `await addDataAndFileToRequest(req)` + * */ data?: Record - /** The locale that should be used for a field when it is not translated to the requested locale */ + /** The file on the request, same rules apply as the `data` property */ file?: { data: Buffer mimetype: string @@ -69,8 +79,9 @@ export type PayloadRequestData = { } export type PayloadRequest = Partial & Required> & - CustomPayloadRequestProperties -export type PayloadRequestWithData = PayloadRequest & PayloadRequestData + CustomPayloadRequestProperties & + PayloadRequestData + export interface RequestContext { [key: string]: unknown } diff --git a/packages/payload/src/uploads/deleteAssociatedFiles.ts b/packages/payload/src/uploads/deleteAssociatedFiles.ts index 4363e51ac..0cb8dbd58 100644 --- a/packages/payload/src/uploads/deleteAssociatedFiles.ts +++ b/packages/payload/src/uploads/deleteAssociatedFiles.ts @@ -2,7 +2,7 @@ import fs from 'fs' import type { SanitizedCollectionConfig } from '../collections/config/types.js' import type { SanitizedConfig } from '../config/types.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import type { FileData, FileToSave } from './types.js' import { ErrorDeletingFile } from '../errors/index.js' @@ -14,7 +14,7 @@ type Args = { doc: Record files?: FileToSave[] overrideDelete: boolean - req: PayloadRequestWithData + req: PayloadRequest } export const deleteAssociatedFiles: (args: Args) => Promise = async ({ diff --git a/packages/payload/src/uploads/docWithFilenameExists.ts b/packages/payload/src/uploads/docWithFilenameExists.ts index 975540305..f7bff3cd0 100644 --- a/packages/payload/src/uploads/docWithFilenameExists.ts +++ b/packages/payload/src/uploads/docWithFilenameExists.ts @@ -1,10 +1,10 @@ -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' type Args = { collectionSlug: string filename: string path: string - req: PayloadRequestWithData + req: PayloadRequest } const docWithFilenameExists = async ({ collectionSlug, filename, req }: Args): Promise => { diff --git a/packages/payload/src/uploads/generateFileData.ts b/packages/payload/src/uploads/generateFileData.ts index a156a2447..5ab38f4a1 100644 --- a/packages/payload/src/uploads/generateFileData.ts +++ b/packages/payload/src/uploads/generateFileData.ts @@ -7,7 +7,7 @@ import sanitize from 'sanitize-filename' import type { Collection } from '../collections/config/types.js' import type { SanitizedConfig } from '../config/types.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import type { FileData, FileToSave, ProbedImageSize, UploadEdits } from './types.js' import { FileRetrievalError, FileUploadError, MissingFile } from '../errors/index.js' @@ -27,7 +27,7 @@ type Args = { operation: 'create' | 'update' originalDoc?: T overwriteExistingFiles?: boolean - req: PayloadRequestWithData + req: PayloadRequest throwOnMissingFile?: boolean } @@ -297,7 +297,7 @@ function parseUploadEditsFromReqOrIncomingData(args: { data: unknown operation: 'create' | 'update' originalDoc: unknown - req: PayloadRequestWithData + req: PayloadRequest }): UploadEdits { const { data, operation, originalDoc, req } = args diff --git a/packages/payload/src/uploads/getExternalFile.ts b/packages/payload/src/uploads/getExternalFile.ts index 1babff822..0498d7ae4 100644 --- a/packages/payload/src/uploads/getExternalFile.ts +++ b/packages/payload/src/uploads/getExternalFile.ts @@ -1,11 +1,11 @@ -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import type { File, FileData, UploadConfig } from './types.js' import { APIError } from '../errors/index.js' type Args = { data: FileData - req: PayloadRequestWithData + req: PayloadRequest uploadConfig: UploadConfig } export const getExternalFile = async ({ data, req, uploadConfig }: Args): Promise => { diff --git a/packages/payload/src/uploads/getFileByPath.ts b/packages/payload/src/uploads/getFileByPath.ts index 2bb498c9d..0f6beef74 100644 --- a/packages/payload/src/uploads/getFileByPath.ts +++ b/packages/payload/src/uploads/getFileByPath.ts @@ -2,13 +2,13 @@ import { fileTypeFromFile } from 'file-type' import fs from 'fs' import path from 'path' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' const mimeTypeEstimate = { svg: 'image/svg+xml', } -export const getFileByPath = async (filePath: string): Promise => { +export const getFileByPath = async (filePath: string): Promise => { if (typeof filePath === 'string') { const data = fs.readFileSync(filePath) const mimetype = fileTypeFromFile(filePath) diff --git a/packages/payload/src/uploads/getImageSize.ts b/packages/payload/src/uploads/getImageSize.ts index 2545b8f0b..2313f5468 100644 --- a/packages/payload/src/uploads/getImageSize.ts +++ b/packages/payload/src/uploads/getImageSize.ts @@ -2,7 +2,7 @@ import fs from 'fs' import sizeOfImport from 'image-size' import { promisify } from 'util' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import type { ProbedImageSize } from './types.js' import { temporaryFileTask } from './tempFile.js' @@ -10,7 +10,7 @@ import { temporaryFileTask } from './tempFile.js' const { imageSize } = sizeOfImport const imageSizePromise = promisify(imageSize) -export async function getImageSize(file: PayloadRequestWithData['file']): Promise { +export async function getImageSize(file: PayloadRequest['file']): Promise { if (file.tempFilePath) { return imageSizePromise(file.tempFilePath) } diff --git a/packages/payload/src/uploads/getSafeFilename.ts b/packages/payload/src/uploads/getSafeFilename.ts index 79fddae80..a33697f38 100644 --- a/packages/payload/src/uploads/getSafeFilename.ts +++ b/packages/payload/src/uploads/getSafeFilename.ts @@ -1,6 +1,6 @@ import sanitize from 'sanitize-filename' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import docWithFilenameExists from './docWithFilenameExists.js' import fileExists from './fileExists.js' @@ -25,7 +25,7 @@ const incrementName = (name: string) => { type Args = { collectionSlug: string desiredFilename: string - req: PayloadRequestWithData + req: PayloadRequest staticPath: string } diff --git a/packages/payload/src/uploads/imageResizer.ts b/packages/payload/src/uploads/imageResizer.ts index f3fb69a8f..0bbc89bba 100644 --- a/packages/payload/src/uploads/imageResizer.ts +++ b/packages/payload/src/uploads/imageResizer.ts @@ -6,7 +6,7 @@ import sanitize from 'sanitize-filename' import type { SanitizedCollectionConfig } from '../collections/config/types.js' import type { SharpDependency } from '../config/types.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import type { FileSize, FileSizes, @@ -22,9 +22,9 @@ import fileExists from './fileExists.js' type ResizeArgs = { config: SanitizedCollectionConfig dimensions: ProbedImageSize - file: PayloadRequestWithData['file'] + file: PayloadRequest['file'] mimeType: string - req: PayloadRequestWithData + req: PayloadRequest savedFilename: string sharp?: SharpDependency staticPath: string diff --git a/packages/payload/src/uploads/types.ts b/packages/payload/src/uploads/types.ts index 89490757a..7100a100b 100644 --- a/packages/payload/src/uploads/types.ts +++ b/packages/payload/src/uploads/types.ts @@ -1,7 +1,7 @@ import type { ResizeOptions, Sharp } from 'sharp' import type { TypeWithID } from '../collections/config/types.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' export type FileSize = { filename: null | string @@ -123,7 +123,7 @@ export type UploadConfig = { * @default undefined */ handlers?: (( - req: PayloadRequestWithData, + req: PayloadRequest, args: { doc: TypeWithID params: { collection: string; filename: string } diff --git a/packages/payload/src/uploads/unlinkTempFiles.ts b/packages/payload/src/uploads/unlinkTempFiles.ts index aae466eb5..d3be514a5 100644 --- a/packages/payload/src/uploads/unlinkTempFiles.ts +++ b/packages/payload/src/uploads/unlinkTempFiles.ts @@ -3,7 +3,7 @@ import { promisify } from 'util' import type { SanitizedCollectionConfig } from '../collections/config/types.js' import type { SanitizedConfig } from '../config/types.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import { mapAsync } from '../utilities/mapAsync.js' @@ -12,7 +12,7 @@ const unlinkFile = promisify(fs.unlink) type Args = { collectionConfig: SanitizedCollectionConfig config: SanitizedConfig - req: PayloadRequestWithData + req: PayloadRequest } /** * Cleanup temp files after operation lifecycle diff --git a/packages/payload/src/uploads/uploadFiles.ts b/packages/payload/src/uploads/uploadFiles.ts index 7c5093bdb..b3f772f3d 100644 --- a/packages/payload/src/uploads/uploadFiles.ts +++ b/packages/payload/src/uploads/uploadFiles.ts @@ -1,5 +1,5 @@ import type { Payload } from '../index.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import type { FileToSave } from './types.js' import { FileUploadError } from '../errors/index.js' @@ -8,7 +8,7 @@ import saveBufferToFile from './saveBufferToFile.js' export const uploadFiles = async ( payload: Payload, files: FileToSave[], - req: PayloadRequestWithData, + req: PayloadRequest, ): Promise => { try { await Promise.all( diff --git a/packages/payload/src/utilities/commitTransaction.ts b/packages/payload/src/utilities/commitTransaction.ts index 7c2975a5c..45384e311 100644 --- a/packages/payload/src/utilities/commitTransaction.ts +++ b/packages/payload/src/utilities/commitTransaction.ts @@ -1,9 +1,9 @@ -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' /** * complete a transaction calling adapter db.commitTransaction and delete the transactionID from req */ -export async function commitTransaction(req: PayloadRequestWithData): Promise { +export async function commitTransaction(req: PayloadRequest): Promise { const { payload, transactionID } = req await payload.db.commitTransaction(transactionID) diff --git a/packages/payload/src/utilities/createLocalReq.ts b/packages/payload/src/utilities/createLocalReq.ts index a84480b0c..4324930c3 100644 --- a/packages/payload/src/utilities/createLocalReq.ts +++ b/packages/payload/src/utilities/createLocalReq.ts @@ -1,12 +1,12 @@ import type { User } from '../auth/types.js' import type { Payload, RequestContext } from '../index.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import { getDataLoader } from '../collections/dataloader.js' import { getLocalI18n } from '../translations/getLocalI18n.js' function getRequestContext( - req: PayloadRequestWithData = { context: null } as PayloadRequestWithData, + req: PayloadRequest = { context: null } as PayloadRequest, context: RequestContext = {}, ): RequestContext { if (req.context) { @@ -21,7 +21,7 @@ function getRequestContext( } } -const attachFakeURLProperties = (req: PayloadRequestWithData) => { +const attachFakeURLProperties = (req: PayloadRequest) => { /** * *NOTE* * If no URL is provided, the local API was called directly outside @@ -59,13 +59,13 @@ type CreateLocalReq = ( context?: RequestContext fallbackLocale?: string locale?: string - req?: PayloadRequestWithData + req?: PayloadRequest user?: User }, payload: Payload, -) => Promise +) => Promise export const createLocalReq: CreateLocalReq = async ( - { context, fallbackLocale, locale: localeArg, req = {} as PayloadRequestWithData, user }, + { context, fallbackLocale, locale: localeArg, req = {} as PayloadRequest, user }, payload, ) => { if (payload.config?.localization) { diff --git a/packages/payload/src/utilities/getEntityPolicies.ts b/packages/payload/src/utilities/getEntityPolicies.ts index 62108301a..f5452cc53 100644 --- a/packages/payload/src/utilities/getEntityPolicies.ts +++ b/packages/payload/src/utilities/getEntityPolicies.ts @@ -3,7 +3,7 @@ import type { SanitizedCollectionConfig, TypeWithID } from '../collections/confi import type { Access } from '../config/types.js' import type { FieldAccess } from '../fields/config/types.js' import type { SanitizedGlobalConfig } from '../globals/config/types.js' -import type { AllOperations, Document, PayloadRequestWithData, Where } from '../types/index.js' +import type { AllOperations, Document, PayloadRequest, Where } from '../types/index.js' import { tabHasName } from '../fields/config/types.js' @@ -11,7 +11,7 @@ type Args = { entity: SanitizedCollectionConfig | SanitizedGlobalConfig id?: number | string operations: AllOperations[] - req: PayloadRequestWithData + req: PayloadRequest type: 'collection' | 'global' } diff --git a/packages/payload/src/utilities/initTransaction.ts b/packages/payload/src/utilities/initTransaction.ts index b332c517f..f4aa57056 100644 --- a/packages/payload/src/utilities/initTransaction.ts +++ b/packages/payload/src/utilities/initTransaction.ts @@ -1,10 +1,10 @@ -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' /** * Starts a new transaction using the db adapter with a random id and then assigns it to the req.transaction * @returns true if beginning a transaction and false when req already has a transaction to use */ -export async function initTransaction(req: PayloadRequestWithData): Promise { +export async function initTransaction(req: PayloadRequest): Promise { const { payload, transactionID, transactionIDPromise } = req if (transactionID) { // we already have a transaction, we're not in charge of committing it diff --git a/packages/payload/src/utilities/isEntityHidden.ts b/packages/payload/src/utilities/isEntityHidden.ts index 5157d5225..72ec9078e 100644 --- a/packages/payload/src/utilities/isEntityHidden.ts +++ b/packages/payload/src/utilities/isEntityHidden.ts @@ -1,13 +1,13 @@ import type { SanitizedCollectionConfig } from '../collections/config/types.js' import type { SanitizedGlobalConfig } from '../globals/config/types.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' export const isEntityHidden = ({ hidden, user, }: { hidden: SanitizedCollectionConfig['admin']['hidden'] | SanitizedGlobalConfig['admin']['hidden'] - user: PayloadRequestWithData['user'] + user: PayloadRequest['user'] }) => { return typeof hidden === 'function' ? hidden({ user }) : hidden === true } diff --git a/packages/payload/src/utilities/killTransaction.ts b/packages/payload/src/utilities/killTransaction.ts index 27189b5fd..3c8fc2dd8 100644 --- a/packages/payload/src/utilities/killTransaction.ts +++ b/packages/payload/src/utilities/killTransaction.ts @@ -1,9 +1,9 @@ -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' /** * Rollback the transaction from the req using the db adapter and removes it from the req */ -export async function killTransaction(req: PayloadRequestWithData): Promise { +export async function killTransaction(req: PayloadRequest): Promise { const { payload, transactionID } = req if (transactionID) { await payload.db.rollbackTransaction(req.transactionID) diff --git a/packages/payload/src/utilities/telemetry/events/adminInit.ts b/packages/payload/src/utilities/telemetry/events/adminInit.ts index 7c98ee029..a9b0f8c37 100644 --- a/packages/payload/src/utilities/telemetry/events/adminInit.ts +++ b/packages/payload/src/utilities/telemetry/events/adminInit.ts @@ -1,6 +1,6 @@ import type { User } from '../../../auth/types.js' import type { Payload } from '../../../index.js' -import type { PayloadRequestWithData } from '../../../types/index.js' +import type { PayloadRequest } from '../../../types/index.js' import { sendEvent } from '../index.js' import { oneWayHash } from '../oneWayHash.js' @@ -14,7 +14,7 @@ export type AdminInitEvent = { type Args = { headers: Request['headers'] payload: Payload - user: PayloadRequestWithData['user'] + user: PayloadRequest['user'] } export const adminInit = ({ headers, payload, user }: Args): void => { const host = headers.get('host') diff --git a/packages/payload/src/versions/deleteCollectionVersions.ts b/packages/payload/src/versions/deleteCollectionVersions.ts index 602b4fe9d..6cfa71533 100644 --- a/packages/payload/src/versions/deleteCollectionVersions.ts +++ b/packages/payload/src/versions/deleteCollectionVersions.ts @@ -1,10 +1,10 @@ import type { Payload } from '../index.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' type Args = { id?: number | string payload: Payload - req?: PayloadRequestWithData + req?: PayloadRequest slug: string } diff --git a/packages/payload/src/versions/drafts/replaceWithDraftIfAvailable.ts b/packages/payload/src/versions/drafts/replaceWithDraftIfAvailable.ts index 918ddc1a7..01eea49a2 100644 --- a/packages/payload/src/versions/drafts/replaceWithDraftIfAvailable.ts +++ b/packages/payload/src/versions/drafts/replaceWithDraftIfAvailable.ts @@ -2,7 +2,7 @@ import type { SanitizedCollectionConfig, TypeWithID } from '../../collections/co import type { AccessResult } from '../../config/types.js' import type { FindGlobalVersionsArgs, FindVersionsArgs } from '../../database/types.js' import type { SanitizedGlobalConfig } from '../../globals/config/types.js' -import type { PayloadRequestWithData, Where } from '../../types/index.js' +import type { PayloadRequest, Where } from '../../types/index.js' import { hasWhereAccessResult } from '../../auth/index.js' import { combineQueries } from '../../database/combineQueries.js' @@ -16,7 +16,7 @@ type Arguments = { entity: SanitizedCollectionConfig | SanitizedGlobalConfig entityType: 'collection' | 'global' overrideAccess: boolean - req: PayloadRequestWithData + req: PayloadRequest } const replaceWithDraftIfAvailable = async ({ diff --git a/packages/payload/src/versions/enforceMaxVersions.ts b/packages/payload/src/versions/enforceMaxVersions.ts index 94d0f4399..9c54a30dc 100644 --- a/packages/payload/src/versions/enforceMaxVersions.ts +++ b/packages/payload/src/versions/enforceMaxVersions.ts @@ -1,6 +1,6 @@ import type { SanitizedCollectionConfig } from '../collections/config/types.js' import type { SanitizedGlobalConfig } from '../globals/config/types.js' -import type { Payload, PayloadRequestWithData, Where } from '../types/index.js' +import type { Payload, PayloadRequest, Where } from '../types/index.js' type Args = { collection?: SanitizedCollectionConfig @@ -8,7 +8,7 @@ type Args = { id?: number | string max: number payload: Payload - req?: PayloadRequestWithData + req?: PayloadRequest } export const enforceMaxVersions = async ({ diff --git a/packages/payload/src/versions/getLatestCollectionVersion.ts b/packages/payload/src/versions/getLatestCollectionVersion.ts index 32a836153..c68017a48 100644 --- a/packages/payload/src/versions/getLatestCollectionVersion.ts +++ b/packages/payload/src/versions/getLatestCollectionVersion.ts @@ -1,6 +1,6 @@ import type { SanitizedCollectionConfig, TypeWithID } from '../collections/config/types.js' import type { FindOneArgs } from '../database/types.js' -import type { Payload, PayloadRequestWithData } from '../types/index.js' +import type { Payload, PayloadRequest } from '../types/index.js' import type { TypeWithVersion } from './types.js' import { docHasTimestamps } from '../types/index.js' @@ -10,7 +10,7 @@ type Args = { id: number | string payload: Payload query: FindOneArgs - req?: PayloadRequestWithData + req?: PayloadRequest } export const getLatestCollectionVersion = async ({ diff --git a/packages/payload/src/versions/getLatestGlobalVersion.ts b/packages/payload/src/versions/getLatestGlobalVersion.ts index 77bafcf08..534fb98d6 100644 --- a/packages/payload/src/versions/getLatestGlobalVersion.ts +++ b/packages/payload/src/versions/getLatestGlobalVersion.ts @@ -1,5 +1,5 @@ import type { SanitizedGlobalConfig } from '../globals/config/types.js' -import type { Document, Payload, PayloadRequestWithData, Where } from '../types/index.js' +import type { Document, Payload, PayloadRequest, Where } from '../types/index.js' import { docHasTimestamps } from '../types/index.js' @@ -7,7 +7,7 @@ type Args = { config: SanitizedGlobalConfig locale?: string payload: Payload - req?: PayloadRequestWithData + req?: PayloadRequest slug: string where: Where } diff --git a/packages/payload/src/versions/saveVersion.ts b/packages/payload/src/versions/saveVersion.ts index 29c8e9a79..cd3bf2f11 100644 --- a/packages/payload/src/versions/saveVersion.ts +++ b/packages/payload/src/versions/saveVersion.ts @@ -1,7 +1,7 @@ import type { SanitizedCollectionConfig, TypeWithID } from '../collections/config/types.js' import type { SanitizedGlobalConfig } from '../globals/config/types.js' import type { Payload } from '../index.js' -import type { PayloadRequestWithData } from '../types/index.js' +import type { PayloadRequest } from '../types/index.js' import { deepCopyObject } from '../utilities/deepCopyObject.js' import sanitizeInternalFields from '../utilities/sanitizeInternalFields.js' @@ -15,7 +15,7 @@ type Args = { global?: SanitizedGlobalConfig id?: number | string payload: Payload - req?: PayloadRequestWithData + req?: PayloadRequest } export const saveVersion = async ({ diff --git a/packages/plugin-cloud-storage/src/types.ts b/packages/plugin-cloud-storage/src/types.ts index f734a5faa..568b4e4ff 100644 --- a/packages/plugin-cloud-storage/src/types.ts +++ b/packages/plugin-cloud-storage/src/types.ts @@ -3,7 +3,7 @@ import type { Field, FileData, ImageSize, - PayloadRequestWithData, + PayloadRequest, TypeWithID, } from 'payload' @@ -19,7 +19,7 @@ export type HandleUpload = (args: { collection: CollectionConfig data: any file: File - req: PayloadRequestWithData + req: PayloadRequest }) => Promise | void export interface TypeWithPrefix { @@ -30,7 +30,7 @@ export type HandleDelete = (args: { collection: CollectionConfig doc: TypeWithID & FileData & TypeWithPrefix filename: string - req: PayloadRequestWithData + req: PayloadRequest }) => Promise | void export type GenerateURL = (args: { @@ -41,7 +41,7 @@ export type GenerateURL = (args: { }) => Promise | string export type StaticHandler = ( - req: PayloadRequestWithData, + req: PayloadRequest, args: { doc?: TypeWithID; params: { collection: string; filename: string } }, ) => Promise | Response diff --git a/packages/plugin-cloud-storage/src/utilities/getFilePrefix.ts b/packages/plugin-cloud-storage/src/utilities/getFilePrefix.ts index 43a4ee630..fd9778acb 100644 --- a/packages/plugin-cloud-storage/src/utilities/getFilePrefix.ts +++ b/packages/plugin-cloud-storage/src/utilities/getFilePrefix.ts @@ -1,4 +1,4 @@ -import type { CollectionConfig, PayloadRequestWithData, UploadConfig } from 'payload' +import type { CollectionConfig, PayloadRequest, UploadConfig } from 'payload' export async function getFilePrefix({ collection, @@ -7,7 +7,7 @@ export async function getFilePrefix({ }: { collection: CollectionConfig filename: string - req: PayloadRequestWithData + req: PayloadRequest }): Promise { const imageSizes = (collection?.upload as UploadConfig)?.imageSizes || [] diff --git a/packages/plugin-cloud-storage/src/utilities/getIncomingFiles.ts b/packages/plugin-cloud-storage/src/utilities/getIncomingFiles.ts index 18746341d..7fa8b8557 100644 --- a/packages/plugin-cloud-storage/src/utilities/getIncomingFiles.ts +++ b/packages/plugin-cloud-storage/src/utilities/getIncomingFiles.ts @@ -1,4 +1,4 @@ -import type { FileData, PayloadRequestWithData } from 'payload' +import type { FileData, PayloadRequest } from 'payload' import type { File } from '../types.js' @@ -7,7 +7,7 @@ export function getIncomingFiles({ req, }: { data: Partial - req: PayloadRequestWithData + req: PayloadRequest }): File[] { const file = req.file diff --git a/packages/plugin-cloud/src/hooks/uploadCache.ts b/packages/plugin-cloud/src/hooks/uploadCache.ts index 2078f3819..e2010c420 100644 --- a/packages/plugin-cloud/src/hooks/uploadCache.ts +++ b/packages/plugin-cloud/src/hooks/uploadCache.ts @@ -1,8 +1,4 @@ -import type { - CollectionAfterChangeHook, - CollectionAfterDeleteHook, - PayloadRequestWithData, -} from 'payload' +import type { CollectionAfterChangeHook, CollectionAfterDeleteHook, PayloadRequest } from 'payload' interface Args { endpoint: string @@ -45,7 +41,7 @@ type PurgeRequest = { doc: any endpoint: string operation: string - req: PayloadRequestWithData + req: PayloadRequest } async function purge({ doc, endpoint, operation, req }: PurgeRequest) { diff --git a/packages/plugin-cloud/src/types.ts b/packages/plugin-cloud/src/types.ts index 59489279b..f067b2536 100644 --- a/packages/plugin-cloud/src/types.ts +++ b/packages/plugin-cloud/src/types.ts @@ -1,10 +1,4 @@ -import type { - CollectionConfig, - Config, - FileData, - PayloadRequestWithData, - TypeWithID, -} from 'payload' +import type { CollectionConfig, Config, FileData, PayloadRequest, TypeWithID } from 'payload' export interface File { buffer: Buffer @@ -18,7 +12,7 @@ export type HandleUpload = (args: { collection: CollectionConfig data: any file: File - req: PayloadRequestWithData + req: PayloadRequest }) => Promise | void export interface TypeWithPrefix { @@ -29,7 +23,7 @@ export type HandleDelete = (args: { collection: CollectionConfig doc: TypeWithID & FileData & TypeWithPrefix filename: string - req: PayloadRequestWithData + req: PayloadRequest }) => Promise | void export type GenerateURL = (args: { @@ -39,7 +33,7 @@ export type GenerateURL = (args: { }) => Promise | string export type StaticHandler = ( - req: PayloadRequestWithData, + req: PayloadRequest, args: { params: { collection: string; filename: string } }, ) => Promise | Promise | Response | void diff --git a/packages/plugin-cloud/src/utilities/getIncomingFiles.ts b/packages/plugin-cloud/src/utilities/getIncomingFiles.ts index 18746341d..7fa8b8557 100644 --- a/packages/plugin-cloud/src/utilities/getIncomingFiles.ts +++ b/packages/plugin-cloud/src/utilities/getIncomingFiles.ts @@ -1,4 +1,4 @@ -import type { FileData, PayloadRequestWithData } from 'payload' +import type { FileData, PayloadRequest } from 'payload' import type { File } from '../types.js' @@ -7,7 +7,7 @@ export function getIncomingFiles({ req, }: { data: Partial - req: PayloadRequestWithData + req: PayloadRequest }): File[] { const file = req.file diff --git a/packages/plugin-nested-docs/src/hooks/resaveChildren.ts b/packages/plugin-nested-docs/src/hooks/resaveChildren.ts index 48e2f8fa0..33475770c 100644 --- a/packages/plugin-nested-docs/src/hooks/resaveChildren.ts +++ b/packages/plugin-nested-docs/src/hooks/resaveChildren.ts @@ -1,4 +1,4 @@ -import type { CollectionAfterChangeHook, CollectionConfig, PayloadRequestWithData } from 'payload' +import type { CollectionAfterChangeHook, CollectionConfig, PayloadRequest } from 'payload' import type { NestedDocsPluginConfig } from '../types.js' @@ -9,7 +9,7 @@ type ResaveArgs = { doc: Record draft: boolean pluginConfig: NestedDocsPluginConfig - req: PayloadRequestWithData + req: PayloadRequest } const resave = async ({ collection, doc, draft, pluginConfig, req }: ResaveArgs) => { diff --git a/packages/plugin-search/src/types.ts b/packages/plugin-search/src/types.ts index 38722734f..71bf81cfa 100644 --- a/packages/plugin-search/src/types.ts +++ b/packages/plugin-search/src/types.ts @@ -1,9 +1,4 @@ -import type { - CollectionAfterChangeHook, - CollectionConfig, - Payload, - PayloadRequestWithData, -} from 'payload' +import type { CollectionAfterChangeHook, CollectionConfig, Payload, PayloadRequest } from 'payload' export type DocToSync = { [key: string]: any @@ -19,7 +14,7 @@ export type BeforeSync = (args: { [key: string]: any } payload: Payload - req: PayloadRequestWithData + req: PayloadRequest searchDoc: DocToSync }) => DocToSync | Promise diff --git a/packages/plugin-seo/src/index.tsx b/packages/plugin-seo/src/index.tsx index 2942e1b9b..403fee608 100644 --- a/packages/plugin-seo/src/index.tsx +++ b/packages/plugin-seo/src/index.tsx @@ -200,10 +200,13 @@ export const seoPlugin = ...(config.endpoints ?? []), { handler: async (req) => { - const reqWithData = await addDataAndFileToRequest({ request: req }) - const args: Parameters[0] = - reqWithData.data as unknown as Parameters[0] - const result = pluginConfig.generateTitle ? await pluginConfig.generateTitle(args) : '' + await addDataAndFileToRequest(req) + req.t + const result = pluginConfig.generateTitle + ? await pluginConfig.generateTitle( + req.data as unknown as Parameters[0], + ) + : '' return new Response(JSON.stringify({ result }), { status: 200 }) }, method: 'post', @@ -211,11 +214,11 @@ export const seoPlugin = }, { handler: async (req) => { - const reqWithData = await addDataAndFileToRequest({ request: req }) - const args: Parameters[0] = - reqWithData.data as unknown as Parameters[0] + await addDataAndFileToRequest(req) const result = pluginConfig.generateDescription - ? await pluginConfig.generateDescription(args) + ? await pluginConfig.generateDescription( + req.data as unknown as Parameters[0], + ) : '' return new Response(JSON.stringify({ result }), { status: 200 }) }, @@ -224,10 +227,10 @@ export const seoPlugin = }, { handler: async (req) => { - const reqWithData = await addDataAndFileToRequest({ request: req }) - const args: Parameters[0] = - reqWithData.data as unknown as Parameters[0] - const result = pluginConfig.generateURL ? await pluginConfig.generateURL(args) : '' + await addDataAndFileToRequest(req) + const result = pluginConfig.generateURL + ? await pluginConfig.generateURL(req.data as unknown as Parameters[0]) + : '' return new Response(JSON.stringify({ result }), { status: 200 }) }, method: 'post', @@ -235,10 +238,12 @@ export const seoPlugin = }, { handler: async (req) => { - const reqWithData = await addDataAndFileToRequest({ request: req }) - const args: Parameters[0] = - reqWithData.data as unknown as Parameters[0] - const result = pluginConfig.generateImage ? await pluginConfig.generateImage(args) : '' + await addDataAndFileToRequest(req) + const result = pluginConfig.generateImage + ? await pluginConfig.generateImage( + req.data as unknown as Parameters[0], + ) + : '' return new Response(result, { status: 200 }) }, method: 'post', diff --git a/packages/plugin-stripe/src/routes/rest.ts b/packages/plugin-stripe/src/routes/rest.ts index 768258e50..da0eb9af7 100644 --- a/packages/plugin-stripe/src/routes/rest.ts +++ b/packages/plugin-stripe/src/routes/rest.ts @@ -1,4 +1,4 @@ -import type { PayloadRequest, PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' import { addDataAndFileToRequest } from '@payloadcms/next/utilities' import { Forbidden } from 'payload' @@ -16,9 +16,9 @@ export const stripeREST = async (args: { const { pluginConfig, req } = args - await addDataAndFileToRequest({ request: req }) + await addDataAndFileToRequest(req) - const requestWithData = req as PayloadRequestWithData + const requestWithData = req const { data: { diff --git a/packages/richtext-lexical/src/features/typesServer.ts b/packages/richtext-lexical/src/features/typesServer.ts index 73a712423..9b35c8e7f 100644 --- a/packages/richtext-lexical/src/features/typesServer.ts +++ b/packages/richtext-lexical/src/features/typesServer.ts @@ -10,7 +10,7 @@ import type { } from 'lexical' import type { Field, - PayloadRequestWithData, + PayloadRequest, ReplaceAny, RequestContext, RichTextField, @@ -59,7 +59,7 @@ export type PopulationPromise[] - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields: boolean siblingDoc: Record }) => void @@ -199,7 +199,7 @@ export type BaseNodeHookArgs = { parentRichTextFieldPath: (number | string)[] parentRichTextFieldSchemaPath: string[] /** The payload request object. It is mocked for Local API operations. */ - req: PayloadRequestWithData + req: PayloadRequest } export type AfterReadNodeHook = ( @@ -233,14 +233,14 @@ export type NodeWithHooks = { */ getSubFields?: (args: { node: ReturnType['exportJSON']> - req: PayloadRequestWithData + req: PayloadRequest }) => Field[] | null /** * If a node includes sub-fields, the sub-fields data needs to be returned here, alongside `getSubFields` which returns their schema. */ getSubFieldsData?: (args: { node: ReturnType['exportJSON']> - req: PayloadRequestWithData + req: PayloadRequest }) => Record /** * Allows you to run population logic when a node's data was requested from graphQL. @@ -398,11 +398,11 @@ export type SanitizedServerFeatures = Required< getSubFields?: Map< string, - (args: { node: SerializedLexicalNode; req: PayloadRequestWithData }) => Field[] | null + (args: { node: SerializedLexicalNode; req: PayloadRequest }) => Field[] | null > getSubFieldsData?: Map< string, - (args: { node: SerializedLexicalNode; req: PayloadRequestWithData }) => Record + (args: { node: SerializedLexicalNode; req: PayloadRequest }) => Record > graphQLPopulationPromises: Map> hooks?: { diff --git a/packages/richtext-lexical/src/populateGraphQL/populate.ts b/packages/richtext-lexical/src/populateGraphQL/populate.ts index 7846fa5bc..67821a6d5 100644 --- a/packages/richtext-lexical/src/populateGraphQL/populate.ts +++ b/packages/richtext-lexical/src/populateGraphQL/populate.ts @@ -1,4 +1,4 @@ -import type { Collection, PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' import { createDataloaderCacheKey } from 'payload' @@ -9,7 +9,7 @@ type Arguments = { draft: boolean key: number | string overrideAccess: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields: boolean } diff --git a/packages/richtext-lexical/src/populateGraphQL/recursivelyPopulateFieldsForGraphQL.ts b/packages/richtext-lexical/src/populateGraphQL/recursivelyPopulateFieldsForGraphQL.ts index 383d4efb6..beaed4c7c 100644 --- a/packages/richtext-lexical/src/populateGraphQL/recursivelyPopulateFieldsForGraphQL.ts +++ b/packages/richtext-lexical/src/populateGraphQL/recursivelyPopulateFieldsForGraphQL.ts @@ -1,4 +1,4 @@ -import type { Field, PayloadRequestWithData, RequestContext } from 'payload' +import type { Field, PayloadRequest, RequestContext } from 'payload' import { afterReadTraverseFields } from 'payload' @@ -23,7 +23,7 @@ type NestedRichTextFieldsArgs = { flattenLocales: boolean overrideAccess: boolean populationPromises: Promise[] - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields: boolean siblingDoc: Record } diff --git a/packages/richtext-slate/src/data/populate.ts b/packages/richtext-slate/src/data/populate.ts index 0967c32f9..5c6540c5a 100644 --- a/packages/richtext-slate/src/data/populate.ts +++ b/packages/richtext-slate/src/data/populate.ts @@ -1,4 +1,4 @@ -import type { Collection, Field, PayloadRequestWithData, RichTextField } from 'payload' +import type { Collection, Field, PayloadRequest, RichTextField } from 'payload' import { createDataloaderCacheKey } from 'payload' @@ -12,7 +12,7 @@ type Arguments = { field: RichTextField key: number | string overrideAccess?: boolean - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields: boolean } diff --git a/packages/richtext-slate/src/data/recurseNestedFields.ts b/packages/richtext-slate/src/data/recurseNestedFields.ts index 5bd267e5e..cb8f3c0ab 100644 --- a/packages/richtext-slate/src/data/recurseNestedFields.ts +++ b/packages/richtext-slate/src/data/recurseNestedFields.ts @@ -1,4 +1,4 @@ -import type { Field, PayloadRequestWithData } from 'payload' +import type { Field, PayloadRequest } from 'payload' import { fieldAffectsData, fieldHasSubFields, fieldIsArrayType } from 'payload/shared' @@ -13,7 +13,7 @@ type NestedRichTextFieldsArgs = { fields: Field[] overrideAccess: boolean populationPromises: Promise[] - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields: boolean } diff --git a/packages/richtext-slate/src/data/richTextRelationshipPromise.ts b/packages/richtext-slate/src/data/richTextRelationshipPromise.ts index a379f8573..4cd6e7d67 100644 --- a/packages/richtext-slate/src/data/richTextRelationshipPromise.ts +++ b/packages/richtext-slate/src/data/richTextRelationshipPromise.ts @@ -1,4 +1,4 @@ -import type { PayloadRequestWithData, RichTextAdapter, RichTextField } from 'payload' +import type { PayloadRequest, RichTextAdapter, RichTextField } from 'payload' import type { AdapterArguments } from '../types.js' @@ -17,7 +17,7 @@ type RecurseRichTextArgs = { field: RichTextField overrideAccess: boolean populationPromises: Promise[] - req: PayloadRequestWithData + req: PayloadRequest showHiddenFields: boolean } diff --git a/packages/ui/src/elements/HydrateClientUser/index.tsx b/packages/ui/src/elements/HydrateClientUser/index.tsx index f473cb1c2..e48a8d6c7 100644 --- a/packages/ui/src/elements/HydrateClientUser/index.tsx +++ b/packages/ui/src/elements/HydrateClientUser/index.tsx @@ -1,6 +1,6 @@ 'use client' -import type { PayloadRequestWithData, Permissions } from 'payload' +import type { PayloadRequest, Permissions } from 'payload' import { useEffect } from 'react' @@ -8,7 +8,7 @@ import { useAuth } from '../../providers/Auth/index.js' export const HydrateClientUser: React.FC<{ permissions: Permissions - user: PayloadRequestWithData['user'] + user: PayloadRequest['user'] }> = ({ permissions, user }) => { const { setPermissions, setUser } = useAuth() diff --git a/packages/ui/src/forms/buildStateFromSchema/addFieldStatePromise.ts b/packages/ui/src/forms/buildStateFromSchema/addFieldStatePromise.ts index 3a1d940ef..3ab2f37c5 100644 --- a/packages/ui/src/forms/buildStateFromSchema/addFieldStatePromise.ts +++ b/packages/ui/src/forms/buildStateFromSchema/addFieldStatePromise.ts @@ -5,7 +5,7 @@ import type { Field, FormField, FormState, - PayloadRequestWithData, + PayloadRequest, } from 'payload' import ObjectIdImport from 'bson-objectid' @@ -53,7 +53,7 @@ export type AddFieldStatePromiseArgs = { * Req is used for validation and defaultValue calculation. If you don't need validation, * just create your own req and pass in the locale and the user */ - req: PayloadRequestWithData + req: PayloadRequest /** * Whether to skip checking the field's condition. @default false */ diff --git a/packages/ui/src/forms/buildStateFromSchema/index.tsx b/packages/ui/src/forms/buildStateFromSchema/index.tsx index 034a70659..1c9787f2d 100644 --- a/packages/ui/src/forms/buildStateFromSchema/index.tsx +++ b/packages/ui/src/forms/buildStateFromSchema/index.tsx @@ -3,7 +3,7 @@ import type { DocumentPreferences, Field as FieldSchema, FormState, - PayloadRequestWithData, + PayloadRequest, } from 'payload' import { calculateDefaultValues } from './calculateDefaultValues/index.js' @@ -15,7 +15,7 @@ type Args = { id?: number | string operation?: 'create' | 'update' preferences: DocumentPreferences - req: PayloadRequestWithData + req: PayloadRequest siblingData?: Data } diff --git a/packages/ui/src/forms/buildStateFromSchema/iterateFields.ts b/packages/ui/src/forms/buildStateFromSchema/iterateFields.ts index 8f35ebfc4..456b07981 100644 --- a/packages/ui/src/forms/buildStateFromSchema/iterateFields.ts +++ b/packages/ui/src/forms/buildStateFromSchema/iterateFields.ts @@ -3,7 +3,7 @@ import type { DocumentPreferences, Field as FieldSchema, FormState, - PayloadRequestWithData, + PayloadRequest, } from 'payload' import { fieldIsPresentationalOnly } from 'payload/shared' @@ -45,7 +45,7 @@ type Args = { */ path?: string preferences?: DocumentPreferences - req: PayloadRequestWithData + req: PayloadRequest /** * Whether to skip checking the field's condition. @default false */ diff --git a/packages/ui/src/utilities/buildFormState.ts b/packages/ui/src/utilities/buildFormState.ts index d5c9f35b4..c55609be5 100644 --- a/packages/ui/src/utilities/buildFormState.ts +++ b/packages/ui/src/utilities/buildFormState.ts @@ -1,10 +1,4 @@ -import type { - DocumentPreferences, - Field, - FormState, - PayloadRequestWithData, - TypeWithID, -} from 'payload' +import type { DocumentPreferences, Field, FormState, PayloadRequest, TypeWithID } from 'payload' import type { BuildFormStateArgs } from '../forms/buildStateFromSchema/index.js' import type { FieldSchemaMap } from './buildFieldSchemaMap/types.js' @@ -23,7 +17,7 @@ if (!cached) { cached = global._payload_fieldSchemaMap = null } -export const getFieldSchemaMap = (req: PayloadRequestWithData): FieldSchemaMap => { +export const getFieldSchemaMap = (req: PayloadRequest): FieldSchemaMap => { if (cached && process.env.NODE_ENV !== 'development') { return cached } @@ -36,11 +30,7 @@ export const getFieldSchemaMap = (req: PayloadRequestWithData): FieldSchemaMap = return cached } -export const buildFormState = async ({ - req, -}: { - req: PayloadRequestWithData -}): Promise => { +export const buildFormState = async ({ req }: { req: PayloadRequest }): Promise => { const reqData: BuildFormStateArgs = req.data as BuildFormStateArgs const { collectionSlug, formState, globalSlug, locale, operation, schemaPath } = reqData diff --git a/test/access-control/int.spec.ts b/test/access-control/int.spec.ts index f40d3a865..b3e5f0034 100644 --- a/test/access-control/int.spec.ts +++ b/test/access-control/int.spec.ts @@ -1,4 +1,4 @@ -import type { Payload, PayloadRequestWithData } from 'payload' +import type { Payload, PayloadRequest } from 'payload' import { Forbidden } from 'payload' @@ -186,7 +186,7 @@ describe('Access Control', () => { it('access control ok when passing request headers', async () => { const req = { headers: requestHeaders, - } as PayloadRequestWithData + } as PayloadRequest const name = 'name' const overrideAccess = false diff --git a/test/database/int.spec.ts b/test/database/int.spec.ts index cd0e11e21..b99c888e2 100644 --- a/test/database/int.spec.ts +++ b/test/database/int.spec.ts @@ -1,6 +1,6 @@ import type { PostgresAdapter } from '@payloadcms/db-postgres/types' import type { NextRESTClient } from 'helpers/NextRESTClient.js' -import type { Payload, PayloadRequestWithData, TypeWithID } from 'payload' +import type { Payload, PayloadRequest, TypeWithID } from 'payload' import { migratePostgresV2toV3 } from '@payloadcms/db-postgres/migration-utils' import { sql } from 'drizzle-orm' @@ -270,7 +270,7 @@ describe('database', () => { const req = { payload, user, - } as PayloadRequestWithData + } as PayloadRequest await initTransaction(req) @@ -320,7 +320,7 @@ describe('database', () => { const req = { payload, user, - } as PayloadRequestWithData + } as PayloadRequest let first let second @@ -373,7 +373,7 @@ describe('database', () => { const req = { payload, user, - } as PayloadRequestWithData + } as PayloadRequest await initTransaction(req) @@ -555,7 +555,7 @@ describe('database', () => { locale: 'es', }) - const req: PayloadRequestWithData = {} as PayloadRequestWithData + const req: PayloadRequest = {} as PayloadRequest await initTransaction(req) await migratePostgresV2toV3({ diff --git a/test/helpers/reInit.ts b/test/helpers/reInit.ts index 2e9b25b7a..2c0b0d99b 100644 --- a/test/helpers/reInit.ts +++ b/test/helpers/reInit.ts @@ -8,8 +8,8 @@ import { seedDB } from './seed.js' const handler: PayloadHandler = async (req) => { process.env.SEED_IN_CONFIG_ONINIT = 'true' - const reqWithData = await addDataAndFileToRequest({ request: req }) - const { data, payload } = reqWithData + await addDataAndFileToRequest(req) + const { data, payload } = req try { await seedDB({ diff --git a/test/helpers/sdk/endpoint.ts b/test/helpers/sdk/endpoint.ts index c88171c36..42a7a90ff 100644 --- a/test/helpers/sdk/endpoint.ts +++ b/test/helpers/sdk/endpoint.ts @@ -3,10 +3,10 @@ import type { Endpoint, PayloadHandler } from 'payload' import { addDataAndFileToRequest } from '@payloadcms/next/utilities' import httpStatus from 'http-status' -export const handler: PayloadHandler = async (incomingRequest) => { - const reqWithData = await addDataAndFileToRequest({ request: incomingRequest }) +export const handler: PayloadHandler = async (req) => { + await addDataAndFileToRequest(req) - const { data, payload, user } = reqWithData + const { data, payload, user } = req const operation = data?.operation ? String(data.operation) : undefined if (data?.operation && typeof payload[operation] === 'function') { diff --git a/test/hooks/collections/ContextHooks/index.ts b/test/hooks/collections/ContextHooks/index.ts index 44602ed47..2fcfeffe5 100644 --- a/test/hooks/collections/ContextHooks/index.ts +++ b/test/hooks/collections/ContextHooks/index.ts @@ -1,6 +1,6 @@ /* eslint-disable no-param-reassign */ import type { CollectionConfig } from 'payload' -import type { PayloadRequestWithData } from 'payload' +import type { PayloadRequest } from 'payload' export const contextHooksSlug = 'context-hooks' const ContextHooks: CollectionConfig = { @@ -15,7 +15,7 @@ const ContextHooks: CollectionConfig = { beforeOperation: [ ({ context, args }) => { // eslint-disable-next-line prefer-destructuring - const req: PayloadRequestWithData = args.req + const req: PayloadRequest = args.req if (req.searchParams.size === 0) { return args diff --git a/test/plugin-form-builder/seed/index.ts b/test/plugin-form-builder/seed/index.ts index fc3ec4be7..11e1cf2cc 100644 --- a/test/plugin-form-builder/seed/index.ts +++ b/test/plugin-form-builder/seed/index.ts @@ -1,10 +1,10 @@ -import type { Payload, PayloadRequestWithData } from 'payload' +import type { Payload, PayloadRequest } from 'payload' import { formSubmissionsSlug, formsSlug, pagesSlug } from '../shared.js' export const seed = async (payload: Payload): Promise => { payload.logger.info('Seeding data...') - const req = {} as PayloadRequestWithData + const req = {} as PayloadRequest try { await payload.create({ diff --git a/test/plugin-search/seed/index.ts b/test/plugin-search/seed/index.ts index 1cd984445..769fbd5e2 100644 --- a/test/plugin-search/seed/index.ts +++ b/test/plugin-search/seed/index.ts @@ -1,8 +1,8 @@ -import type { Payload, PayloadRequestWithData } from 'payload' +import type { Payload, PayloadRequest } from 'payload' export const seed = async (payload: Payload): Promise => { payload.logger.info('Seeding data...') - const req = {} as PayloadRequestWithData + const req = {} as PayloadRequest try { await payload.create({ diff --git a/test/plugin-seo/seed/index.ts b/test/plugin-seo/seed/index.ts index f48025049..acdb6d1b4 100644 --- a/test/plugin-seo/seed/index.ts +++ b/test/plugin-seo/seed/index.ts @@ -1,4 +1,4 @@ -import type { Payload, PayloadRequestWithData } from 'payload' +import type { Payload, PayloadRequest } from 'payload' import { fileURLToPath } from 'node:url' import path from 'path' @@ -10,7 +10,7 @@ const dirname = path.dirname(filename) export const seed = async (payload: Payload): Promise => { payload.logger.info('Seeding data...') - const req = {} as PayloadRequestWithData + const req = {} as PayloadRequest try { // Create image diff --git a/test/plugin-stripe/seed/index.ts b/test/plugin-stripe/seed/index.ts index 1cd984445..769fbd5e2 100644 --- a/test/plugin-stripe/seed/index.ts +++ b/test/plugin-stripe/seed/index.ts @@ -1,8 +1,8 @@ -import type { Payload, PayloadRequestWithData } from 'payload' +import type { Payload, PayloadRequest } from 'payload' export const seed = async (payload: Payload): Promise => { payload.logger.info('Seeding data...') - const req = {} as PayloadRequestWithData + const req = {} as PayloadRequest try { await payload.create({ diff --git a/test/relationships/int.spec.ts b/test/relationships/int.spec.ts index 1281876f9..cc2adeecc 100644 --- a/test/relationships/int.spec.ts +++ b/test/relationships/int.spec.ts @@ -1,4 +1,4 @@ -import type { Payload, PayloadRequestWithData } from 'payload' +import type { Payload, PayloadRequest } from 'payload' import { randomBytes } from 'crypto' @@ -895,7 +895,7 @@ describe('Relationships', () => { describe('Creating', () => { describe('With transactions', () => { it('should be able to create filtered relations within a transaction', async () => { - const req = {} as PayloadRequestWithData + const req = {} as PayloadRequest req.transactionID = await payload.db.beginTransaction?.() const related = await payload.create({ collection: relationSlug,