@payloadcms/next 3.0.0-canary.92e4997 → 3.0.0-canary.a0b06af

package/dist/routes/rest/index.js

@@ -4,6 +4,7 @@ import { addDataAndFileToRequest } from '../../utilities/addDataAndFileToRequest
 import { addLocalesToRequestFromData } from '../../utilities/addLocalesToRequest.js';
 import { createPayloadRequest } from '../../utilities/createPayloadRequest.js';
 import { headersWithCors } from '../../utilities/headersWithCors.js';
+import { mergeHeaders } from '../../utilities/mergeHeaders.js';
 import { access } from './auth/access.js';
 import { forgotPassword } from './auth/forgotPassword.js';
 import { init } from './auth/init.js';
@@ -39,6 +40,7 @@ import { findVersions as findVersionsGlobal } from './globals/findVersions.js';
 import { preview as previewGlobal } from './globals/preview.js';
 import { restoreVersion as restoreVersionGlobal } from './globals/restoreVersion.js';
 import { update as updateGlobal } from './globals/update.js';
+import { generateOGImage } from './og/index.js';
 import { routeError } from './routeError.js';
 const endpoints = {
     collection: {
@@ -94,24 +96,35 @@ const endpoints = {
     },
     root: {
         GET: {
-            access
+            access,
+            og: generateOGImage
         },
         POST: {
             'form-state': buildFormState
         }
     }
 };
-const handleCustomEndpoints = ({ endpoints, entitySlug, payloadRequest })=>{
+const handleCustomEndpoints = async ({ endpoints, entitySlug, req })=>{
     if (endpoints && endpoints.length > 0) {
         let handlerParams = {};
-        const { pathname } = payloadRequest;
-        const pathPrefix = payloadRequest.payload.config.routes.api + (entitySlug ? `/${entitySlug}` : '');
+        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 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;
+        if (process.env.NEXT_BASE_PATH) {
+            adjustedPathname = process.env.NEXT_BASE_PATH + pathname;
+        }
+        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
                 });
-                const tempParams = pathMatchFn(pathname);
+                const tempParams = pathMatchFn(adjustedPathname);
                 if (tempParams) {
                     handlerParams = tempParams.params;
                     return true;
@@ -119,11 +132,17 @@ const handleCustomEndpoints = ({ endpoints, entitySlug, payloadRequest })=>{
             }
         });
         if (customEndpoint) {
-            payloadRequest.routeParams = {
-                ...payloadRequest.routeParams,
+            req.routeParams = {
+                ...req.routeParams,
                 ...handlerParams
             };
-            return customEndpoint.handler(payloadRequest);
+            const res = await customEndpoint.handler(req);
+            if (res instanceof Response) {
+                if (req.responseHeaders) {
+                    mergeHeaders(req.responseHeaders, res.headers);
+                }
+                return res;
+            }
         }
     }
     return null;
@@ -185,23 +204,19 @@ export const GET = (config)=>async (request, { params: { slug } })=>{
                 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
+                                req
                             });
                             break;
                         case 2:
@@ -212,14 +227,14 @@ export const GET = (config)=>async (request, { params: { slug } })=>{
                                 // /:collection/count
                                 res = await endpoints.collection.GET[slug2]({
                                     collection,
-                                    req: payloadRequest
+                                    req
                                 });
                             } else {
                                 // /:collection/:id
                                 res = await endpoints.collection.GET.findByID({
                                     id: slug2,
                                     collection,
-                                    req: payloadRequest
+                                    req
                                 });
                             }
                             break;
@@ -229,14 +244,14 @@ export const GET = (config)=>async (request, { params: { slug } })=>{
                                 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]({
                                     id: slug2,
                                     collection,
-                                    req: payloadRequest
+                                    req
                                 });
                             } else if (`doc-${slug2}-by-id` in endpoints.collection.GET) {
                                 // /:collection/access/:id
@@ -244,7 +259,7 @@ export const GET = (config)=>async (request, { params: { slug } })=>{
                                 res = await endpoints.collection.GET[`doc-${slug2}-by-id`]({
                                     id: slug3,
                                     collection,
-                                    req: payloadRequest
+                                    req
                                 });
                             }
                             break;
@@ -261,23 +276,19 @@ export const GET = (config)=>async (request, { params: { slug } })=>{
                 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
+                                req
                             });
                             break;
                         case 3:
@@ -285,7 +296,7 @@ export const GET = (config)=>async (request, { params: { slug } })=>{
                                 // /globals/:slug/preview
                                 res = await endpoints.global.GET[slug3]({
                                     globalConfig,
-                                    req: payloadRequest
+                                    req
                                 });
                             } else if (`doc-${slug3}` in endpoints.global.GET) {
                                 // /globals/:slug/access
@@ -293,7 +304,7 @@ export const GET = (config)=>async (request, { params: { slug } })=>{
                                 // /globals/:slug/preview
                                 res = await (endpoints.global.GET?.[`doc-${slug3}`])({
                                     globalConfig,
-                                    req: payloadRequest
+                                    req
                                 });
                             }
                             break;
@@ -303,28 +314,29 @@ export const GET = (config)=>async (request, { params: { slug } })=>{
                                 res = await (endpoints.global.GET?.[`doc-${slug3}-by-id`])({
                                     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
-                });
+                await addDataAndFileToRequest(req);
+                addLocalesToRequestFromData(req);
                 res = await endpoints.root.GET[slug1]({
-                    req: payloadRequest
+                    req
                 });
             }
-            if (res instanceof Response) return res;
+            if (res instanceof Response) {
+                if (req.responseHeaders) {
+                    mergeHeaders(req.responseHeaders, res.headers);
+                }
+                return res;
+            }
             // root routes
             const customEndpointResponse = await handleCustomEndpoints({
                 endpoints: req.payload.config.endpoints,
-                payloadRequest: req
+                req
             });
             if (customEndpointResponse) return customEndpointResponse;
             return RouteNotFoundResponse({
@@ -345,6 +357,14 @@ export const POST = (config)=>async (request, { params: { slug } })=>{
         let req;
         let res;
         let collection;
+        const overrideHttpMethod = request.headers.get('X-HTTP-Method-Override');
+        if (overrideHttpMethod === 'GET') {
+            return await GET(config)(request, {
+                params: {
+                    slug
+                }
+            });
+        }
         try {
             req = await createPayloadRequest({
                 config,
@@ -366,23 +386,19 @@ export const POST = (config)=>async (request, { params: { slug } })=>{
                 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
+                                req
                             });
                             break;
                         case 2:
@@ -397,7 +413,7 @@ export const POST = (config)=>async (request, { params: { slug } })=>{
                                 // /:collection/refresh-token
                                 res = await (endpoints.collection.POST?.[slug2])({
                                     collection,
-                                    req: payloadRequest
+                                    req
                                 });
                             }
                             break;
@@ -409,14 +425,14 @@ export const POST = (config)=>async (request, { params: { slug } })=>{
                                 res = await endpoints.collection.POST[`doc-${slug2}-by-id`]({
                                     id: slug3,
                                     collection,
-                                    req: payloadRequest
+                                    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;
@@ -433,23 +449,19 @@ export const POST = (config)=>async (request, { params: { slug } })=>{
                 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
+                                req
                             });
                             break;
                         case 3:
@@ -457,7 +469,7 @@ export const POST = (config)=>async (request, { params: { slug } })=>{
                                 // /globals/:slug/access
                                 res = await (endpoints.global.POST?.[`doc-${slug3}`])({
                                     globalConfig,
-                                    req: payloadRequest
+                                    req
                                 });
                             }
                             break;
@@ -467,7 +479,7 @@ export const POST = (config)=>async (request, { params: { slug } })=>{
                                 res = await (endpoints.global.POST?.[`doc-${slug3}-by-id`])({
                                     id: slug4,
                                     globalConfig,
-                                    req: payloadRequest
+                                    req
                                 });
                             }
                             break;
@@ -478,21 +490,22 @@ export const POST = (config)=>async (request, { params: { slug } })=>{
                     }
                 }
             } else if (slug.length === 1 && slug1 in endpoints.root.POST) {
-                const reqWithData = await addDataAndFileToRequest({
-                    request: req
-                });
-                const payloadRequest = addLocalesToRequestFromData({
-                    request: reqWithData
-                });
+                await addDataAndFileToRequest(req);
+                addLocalesToRequestFromData(req);
                 res = await endpoints.root.POST[slug1]({
-                    req: payloadRequest
+                    req
                 });
             }
-            if (res instanceof Response) return res;
+            if (res instanceof Response) {
+                if (req.responseHeaders) {
+                    mergeHeaders(req.responseHeaders, res.headers);
+                }
+                return res;
+            }
             // root routes
             const customEndpointResponse = await handleCustomEndpoints({
                 endpoints: req.payload.config.endpoints,
-                payloadRequest: req
+                req
             });
             if (customEndpointResponse) return customEndpointResponse;
             return RouteNotFoundResponse({
@@ -534,23 +547,19 @@ export const DELETE = (config)=>async (request, { params: { slug } })=>{
                 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
+                                req
                             });
                             break;
                         case 2:
@@ -558,17 +567,22 @@ export const DELETE = (config)=>async (request, { params: { slug } })=>{
                             res = await endpoints.collection.DELETE.deleteByID({
                                 id: slug2,
                                 collection,
-                                req: payloadRequest
+                                req
                             });
                             break;
                     }
                 }
             }
-            if (res instanceof Response) return res;
+            if (res instanceof Response) {
+                if (req.responseHeaders) {
+                    mergeHeaders(req.responseHeaders, res.headers);
+                }
+                return res;
+            }
             // root routes
             const customEndpointResponse = await handleCustomEndpoints({
                 endpoints: req.payload.config.endpoints,
-                payloadRequest: req
+                req
             });
             if (customEndpointResponse) return customEndpointResponse;
             return RouteNotFoundResponse({
@@ -610,23 +624,19 @@ export const PATCH = (config)=>async (request, { params: { slug } })=>{
                 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
+                                req
                             });
                             break;
                         case 2:
@@ -634,17 +644,22 @@ export const PATCH = (config)=>async (request, { params: { slug } })=>{
                             res = await endpoints.collection.PATCH.updateByID({
                                 id: slug2,
                                 collection,
-                                req: payloadRequest
+                                req
                             });
                             break;
                     }
                 }
             }
-            if (res instanceof Response) return res;
+            if (res instanceof Response) {
+                if (req.responseHeaders) {
+                    mergeHeaders(req.responseHeaders, res.headers);
+                }
+                return res;
+            }
             // root routes
             const customEndpointResponse = await handleCustomEndpoints({
                 endpoints: req.payload.config.endpoints,
-                payloadRequest: req
+                req
             });
             if (customEndpointResponse) return customEndpointResponse;
             return RouteNotFoundResponse({