@payloadcms/next 3.70.0 → 3.71.0-internal-debug.80dab4c

package/dist/views/Root/getRouteData.js

@@ -20,340 +20,348 @@ import { getCustomViewByRoute } from './getCustomViewByRoute.js';
 import { getDocumentViewInfo } from './getDocumentViewInfo.js';
 import { isPathMatchingRoute } from './isPathMatchingRoute.js';
 const baseClasses = {
-  account: 'account',
-  folders: 'folders',
-  forgot: forgotPasswordBaseClass,
-  login: loginBaseClass,
-  reset: resetPasswordBaseClass,
-  verify: verifyBaseClass
+    account: 'account',
+    folders: 'folders',
+    forgot: forgotPasswordBaseClass,
+    login: loginBaseClass,
+    reset: resetPasswordBaseClass,
+    verify: verifyBaseClass
 };
 const oneSegmentViews = {
-  account: AccountView,
-  browseByFolder: BrowseByFolder,
-  createFirstUser: CreateFirstUserView,
-  forgot: ForgotPasswordView,
-  inactivity: LogoutInactivity,
-  login: LoginView,
-  logout: LogoutView,
-  unauthorized: UnauthorizedView
+    account: AccountView,
+    browseByFolder: BrowseByFolder,
+    createFirstUser: CreateFirstUserView,
+    forgot: ForgotPasswordView,
+    inactivity: LogoutInactivity,
+    login: LoginView,
+    logout: LogoutView,
+    unauthorized: UnauthorizedView
 };
-export const getRouteData = ({
-  adminRoute,
-  collectionConfig,
-  collectionPreferences = undefined,
-  currentRoute,
-  globalConfig,
-  payload,
-  segments
-}) => {
-  const {
-    config
-  } = payload;
-  let ViewToRender = null;
-  let templateClassName;
-  let templateType;
-  let documentSubViewType;
-  let viewType;
-  const routeParams = {};
-  const [segmentOne, segmentTwo, segmentThree, segmentFour, segmentFive, segmentSix] = segments;
-  const isBrowseByFolderEnabled = config.folders && config.folders.browseByFolder;
-  const browseByFolderSlugs = isBrowseByFolderEnabled && config.collections.reduce((acc, {
-    slug,
-    folders
-  }) => {
-    if (folders && folders.browseByFolder) {
-      return [...acc, slug];
-    }
-    return acc;
-  }, []) || [];
-  const viewActions = [...(config?.admin?.components?.actions || [])];
-  switch (segments.length) {
-    case 0:
-      {
-        if (currentRoute === adminRoute) {
-          ViewToRender = {
-            Component: DashboardView
-          };
-          templateClassName = 'dashboard';
-          templateType = 'default';
-          viewType = 'dashboard';
-        }
-        break;
-      }
-    case 1:
-      {
-        // users can override the default routes via `admin.routes` config
-        // i.e.{ admin: { routes: { logout: '/sign-out', inactivity: '/idle' }}}
-        let viewKey;
-        if (config.admin.routes) {
-          const matchedRoute = Object.entries(config.admin.routes).find(([, route]) => {
-            return isPathMatchingRoute({
-              currentRoute,
-              exact: true,
-              path: formatAdminURL({
-                adminRoute,
-                path: route
-              })
-            });
-          });
-          if (matchedRoute) {
-            viewKey = matchedRoute[0];
-          }
+/**
+   * User preferences for a collection.
+   *
+   * These preferences are normally undefined
+   * unless the user is on the list view and the
+   * collection is folder enabled.
+   */ export const getRouteData = ({ adminRoute, collectionConfig, collectionPreferences = undefined, currentRoute, globalConfig, payload, segments })=>{
+    const { config } = payload;
+    let ViewToRender = null;
+    let templateClassName;
+    let templateType;
+    let documentSubViewType;
+    let viewType;
+    const routeParams = {};
+    const [segmentOne, segmentTwo, segmentThree, segmentFour, segmentFive, segmentSix] = segments;
+    const isBrowseByFolderEnabled = config.folders && config.folders.browseByFolder;
+    const browseByFolderSlugs = isBrowseByFolderEnabled && config.collections.reduce((acc, { slug, folders })=>{
+        if (folders && folders.browseByFolder) {
+            return [
+                ...acc,
+                slug
+            ];
         }
-        // Check if a custom view is configured for this viewKey
-        // First try to get custom view by the known viewKey, then fallback to route matching
-        const customView = viewKey && getCustomViewByKey({
-          config,
-          viewKey
-        }) || getCustomViewByRoute({
-          config,
-          currentRoute
-        });
-        if (customView?.view?.payloadComponent || customView?.view?.Component) {
-          // User has configured a custom view (either overriding a built-in or a new custom view)
-          ViewToRender = customView.view;
-          // If this custom view is overriding a built-in view (viewKey matches a built-in),
-          // use the built-in's template settings and viewType
-          if (viewKey && oneSegmentViews[viewKey]) {
-            viewType = viewKey;
-            templateClassName = baseClasses[viewKey] || viewKey;
-            templateType = 'minimal';
-            if (viewKey === 'account') {
-              templateType = 'default';
+        return acc;
+    }, []) || [];
+    const viewActions = [
+        ...config?.admin?.components?.actions || []
+    ];
+    switch(segments.length){
+        case 0:
+            {
+                if (currentRoute === adminRoute) {
+                    ViewToRender = {
+                        Component: DashboardView
+                    };
+                    templateClassName = 'dashboard';
+                    templateType = 'default';
+                    viewType = 'dashboard';
+                }
+                break;
             }
-            if (isBrowseByFolderEnabled && viewKey === 'browseByFolder') {
-              templateType = 'default';
-              viewType = 'folders';
+        case 1:
+            {
+                // users can override the default routes via `admin.routes` config
+                // i.e.{ admin: { routes: { logout: '/sign-out', inactivity: '/idle' }}}
+                let viewKey;
+                if (config.admin.routes) {
+                    const matchedRoute = Object.entries(config.admin.routes).find(([, route])=>{
+                        return isPathMatchingRoute({
+                            currentRoute,
+                            exact: true,
+                            path: formatAdminURL({
+                                adminRoute,
+                                path: route
+                            })
+                        });
+                    });
+                    if (matchedRoute) {
+                        viewKey = matchedRoute[0];
+                    }
+                }
+                // Check if a custom view is configured for this viewKey
+                // First try to get custom view by the known viewKey, then fallback to route matching
+                const customView = viewKey && getCustomViewByKey({
+                    config,
+                    viewKey
+                }) || getCustomViewByRoute({
+                    config,
+                    currentRoute
+                });
+                if (customView?.view?.payloadComponent || customView?.view?.Component) {
+                    // User has configured a custom view (either overriding a built-in or a new custom view)
+                    ViewToRender = customView.view;
+                    // If this custom view is overriding a built-in view (viewKey matches a built-in),
+                    // use the built-in's template settings and viewType
+                    if (viewKey && oneSegmentViews[viewKey]) {
+                        viewType = viewKey;
+                        templateClassName = baseClasses[viewKey] || viewKey;
+                        templateType = 'minimal';
+                        if (viewKey === 'account') {
+                            templateType = 'default';
+                        }
+                        if (isBrowseByFolderEnabled && viewKey === 'browseByFolder') {
+                            templateType = 'default';
+                            viewType = 'folders';
+                        }
+                    }
+                } else if (oneSegmentViews[viewKey]) {
+                    // --> /account
+                    // --> /create-first-user
+                    // --> /browse-by-folder
+                    // --> /forgot
+                    // --> /login
+                    // --> /logout
+                    // --> /logout-inactivity
+                    // --> /unauthorized
+                    ViewToRender = {
+                        Component: oneSegmentViews[viewKey]
+                    };
+                    viewType = viewKey;
+                    templateClassName = baseClasses[viewKey];
+                    templateType = 'minimal';
+                    if (viewKey === 'account') {
+                        templateType = 'default';
+                    }
+                    if (isBrowseByFolderEnabled && viewKey === 'browseByFolder') {
+                        templateType = 'default';
+                        viewType = 'folders';
+                    }
+                }
+                break;
             }
-          }
-        } else if (oneSegmentViews[viewKey]) {
-          // --> /account
-          // --> /create-first-user
-          // --> /browse-by-folder
-          // --> /forgot
-          // --> /login
-          // --> /logout
-          // --> /logout-inactivity
-          // --> /unauthorized
-          ViewToRender = {
-            Component: oneSegmentViews[viewKey]
-          };
-          viewType = viewKey;
-          templateClassName = baseClasses[viewKey];
-          templateType = 'minimal';
-          if (viewKey === 'account') {
-            templateType = 'default';
-          }
-          if (isBrowseByFolderEnabled && viewKey === 'browseByFolder') {
-            templateType = 'default';
-            viewType = 'folders';
-          }
-        }
-        break;
-      }
-    case 2:
-      {
-        if (`/${segmentOne}` === config.admin.routes.reset) {
-          // --> /reset/:token
-          ViewToRender = {
-            Component: ResetPassword
-          };
-          templateClassName = baseClasses[segmentTwo];
-          templateType = 'minimal';
-          viewType = 'reset';
-        } else if (isBrowseByFolderEnabled && `/${segmentOne}` === config.admin.routes.browseByFolder) {
-          // --> /browse-by-folder/:folderID
-          routeParams.folderID = segmentTwo;
-          ViewToRender = {
-            Component: oneSegmentViews.browseByFolder
-          };
-          templateClassName = baseClasses.folders;
-          templateType = 'default';
-          viewType = 'folders';
-        } else if (collectionConfig) {
-          // --> /collections/:collectionSlug'
-          routeParams.collection = collectionConfig.slug;
-          if (collectionPreferences?.listViewType && collectionPreferences.listViewType === 'folders') {
-            // Render folder view by default if set in preferences
-            ViewToRender = {
-              Component: CollectionFolderView
-            };
-            templateClassName = `collection-folders`;
-            templateType = 'default';
-            viewType = 'collection-folders';
-          } else {
-            ViewToRender = {
-              Component: ListView
-            };
-            templateClassName = `${segmentTwo}-list`;
-            templateType = 'default';
-            viewType = 'list';
-          }
-          viewActions.push(...(collectionConfig.admin.components?.views?.list?.actions || []));
-        } else if (globalConfig) {
-          // --> /globals/:globalSlug
-          routeParams.global = globalConfig.slug;
-          ViewToRender = {
-            Component: DocumentView
-          };
-          templateClassName = 'global-edit';
-          templateType = 'default';
-          viewType = 'document';
-          // add default view actions
-          viewActions.push(...getViewActions({
-            editConfig: globalConfig.admin?.components?.views?.edit,
-            viewKey: 'default'
-          }));
+        case 2:
+            {
+                if (`/${segmentOne}` === config.admin.routes.reset) {
+                    // --> /reset/:token
+                    ViewToRender = {
+                        Component: ResetPassword
+                    };
+                    templateClassName = baseClasses[segmentTwo];
+                    templateType = 'minimal';
+                    viewType = 'reset';
+                } else if (isBrowseByFolderEnabled && `/${segmentOne}` === config.admin.routes.browseByFolder) {
+                    // --> /browse-by-folder/:folderID
+                    routeParams.folderID = segmentTwo;
+                    ViewToRender = {
+                        Component: oneSegmentViews.browseByFolder
+                    };
+                    templateClassName = baseClasses.folders;
+                    templateType = 'default';
+                    viewType = 'folders';
+                } else if (collectionConfig) {
+                    // --> /collections/:collectionSlug'
+                    routeParams.collection = collectionConfig.slug;
+                    if (collectionPreferences?.listViewType && collectionPreferences.listViewType === 'folders') {
+                        // Render folder view by default if set in preferences
+                        ViewToRender = {
+                            Component: CollectionFolderView
+                        };
+                        templateClassName = `collection-folders`;
+                        templateType = 'default';
+                        viewType = 'collection-folders';
+                    } else {
+                        ViewToRender = {
+                            Component: ListView
+                        };
+                        templateClassName = `${segmentTwo}-list`;
+                        templateType = 'default';
+                        viewType = 'list';
+                    }
+                    viewActions.push(...collectionConfig.admin.components?.views?.list?.actions || []);
+                } else if (globalConfig) {
+                    // --> /globals/:globalSlug
+                    routeParams.global = globalConfig.slug;
+                    ViewToRender = {
+                        Component: DocumentView
+                    };
+                    templateClassName = 'global-edit';
+                    templateType = 'default';
+                    viewType = 'document';
+                    // add default view actions
+                    viewActions.push(...getViewActions({
+                        editConfig: globalConfig.admin?.components?.views?.edit,
+                        viewKey: 'default'
+                    }));
+                }
+                break;
+            }
+        default:
+            if (segmentTwo === 'verify') {
+                // --> /:collectionSlug/verify/:token
+                routeParams.collection = segmentOne;
+                routeParams.token = segmentThree;
+                ViewToRender = {
+                    Component: Verify
+                };
+                templateClassName = 'verify';
+                templateType = 'minimal';
+                viewType = 'verify';
+            } else if (collectionConfig) {
+                routeParams.collection = collectionConfig.slug;
+                if (segmentThree === 'trash' && typeof segmentFour === 'string') {
+                    // --> /collections/:collectionSlug/trash/:id (read-only)
+                    // --> /collections/:collectionSlug/trash/:id/api
+                    // --> /collections/:collectionSlug/trash/:id/preview
+                    // --> /collections/:collectionSlug/trash/:id/versions
+                    // --> /collections/:collectionSlug/trash/:id/versions/:versionID
+                    routeParams.id = segmentFour;
+                    routeParams.versionID = segmentSix;
+                    ViewToRender = {
+                        Component: DocumentView
+                    };
+                    templateClassName = `collection-default-edit`;
+                    templateType = 'default';
+                    const viewInfo = getDocumentViewInfo([
+                        segmentFive,
+                        segmentSix
+                    ]);
+                    viewType = viewInfo.viewType;
+                    documentSubViewType = viewInfo.documentSubViewType;
+                    viewActions.push(...getSubViewActions({
+                        collectionOrGlobal: collectionConfig,
+                        viewKeyArg: documentSubViewType
+                    }));
+                } else if (segmentThree === 'trash') {
+                    // --> /collections/:collectionSlug/trash
+                    ViewToRender = {
+                        Component: TrashView
+                    };
+                    templateClassName = `${segmentTwo}-trash`;
+                    templateType = 'default';
+                    viewType = 'trash';
+                    viewActions.push(...collectionConfig.admin.components?.views?.list?.actions || []);
+                } else {
+                    if (config.folders && segmentThree === config.folders.slug && collectionConfig.folders) {
+                        // Collection Folder Views
+                        // --> /collections/:collectionSlug/:folderCollectionSlug
+                        // --> /collections/:collectionSlug/:folderCollectionSlug/:folderID
+                        routeParams.folderCollection = segmentThree;
+                        routeParams.folderID = segmentFour;
+                        ViewToRender = {
+                            Component: CollectionFolderView
+                        };
+                        templateClassName = `collection-folders`;
+                        templateType = 'default';
+                        viewType = 'collection-folders';
+                        viewActions.push(...collectionConfig.admin.components?.views?.list?.actions || []);
+                    } else {
+                        // Collection Edit Views
+                        // --> /collections/:collectionSlug/create
+                        // --> /collections/:collectionSlug/:id
+                        // --> /collections/:collectionSlug/:id/api
+                        // --> /collections/:collectionSlug/:id/versions
+                        // --> /collections/:collectionSlug/:id/versions/:versionID
+                        routeParams.id = segmentThree === 'create' ? undefined : segmentThree;
+                        routeParams.versionID = segmentFive;
+                        ViewToRender = {
+                            Component: DocumentView
+                        };
+                        templateClassName = `collection-default-edit`;
+                        templateType = 'default';
+                        const viewInfo = getDocumentViewInfo([
+                            segmentFour,
+                            segmentFive
+                        ]);
+                        viewType = viewInfo.viewType;
+                        documentSubViewType = viewInfo.documentSubViewType;
+                        viewActions.push(...getSubViewActions({
+                            collectionOrGlobal: collectionConfig,
+                            viewKeyArg: documentSubViewType
+                        }));
+                    }
+                }
+            } else if (globalConfig) {
+                // Global Edit Views
+                // --> /globals/:globalSlug/versions
+                // --> /globals/:globalSlug/versions/:versionID
+                // --> /globals/:globalSlug/api
+                routeParams.global = globalConfig.slug;
+                routeParams.versionID = segmentFour;
+                ViewToRender = {
+                    Component: DocumentView
+                };
+                templateClassName = `global-edit`;
+                templateType = 'default';
+                const viewInfo = getDocumentViewInfo([
+                    segmentThree,
+                    segmentFour
+                ]);
+                viewType = viewInfo.viewType;
+                documentSubViewType = viewInfo.documentSubViewType;
+                viewActions.push(...getSubViewActions({
+                    collectionOrGlobal: globalConfig,
+                    viewKeyArg: documentSubViewType
+                }));
+            }
+            break;
+    }
+    if (!ViewToRender) {
+        ViewToRender = getCustomViewByRoute({
+            config,
+            currentRoute
+        })?.view;
+    }
+    if (collectionConfig) {
+        if (routeParams.id) {
+            routeParams.id = parseDocumentID({
+                id: routeParams.id,
+                collectionSlug: collectionConfig.slug,
+                payload
+            });
         }
-        break;
-      }
-    default:
-      if (segmentTwo === 'verify') {
-        // --> /:collectionSlug/verify/:token
-        routeParams.collection = segmentOne;
-        routeParams.token = segmentThree;
-        ViewToRender = {
-          Component: Verify
-        };
-        templateClassName = 'verify';
-        templateType = 'minimal';
-        viewType = 'verify';
-      } else if (collectionConfig) {
-        routeParams.collection = collectionConfig.slug;
-        if (segmentThree === 'trash' && typeof segmentFour === 'string') {
-          // --> /collections/:collectionSlug/trash/:id (read-only)
-          // --> /collections/:collectionSlug/trash/:id/api
-          // --> /collections/:collectionSlug/trash/:id/preview
-          // --> /collections/:collectionSlug/trash/:id/versions
-          // --> /collections/:collectionSlug/trash/:id/versions/:versionID
-          routeParams.id = segmentFour;
-          routeParams.versionID = segmentSix;
-          ViewToRender = {
-            Component: DocumentView
-          };
-          templateClassName = `collection-default-edit`;
-          templateType = 'default';
-          const viewInfo = getDocumentViewInfo([segmentFive, segmentSix]);
-          viewType = viewInfo.viewType;
-          documentSubViewType = viewInfo.documentSubViewType;
-          viewActions.push(...getSubViewActions({
-            collectionOrGlobal: collectionConfig,
-            viewKeyArg: documentSubViewType
-          }));
-        } else if (segmentThree === 'trash') {
-          // --> /collections/:collectionSlug/trash
-          ViewToRender = {
-            Component: TrashView
-          };
-          templateClassName = `${segmentTwo}-trash`;
-          templateType = 'default';
-          viewType = 'trash';
-          viewActions.push(...(collectionConfig.admin.components?.views?.list?.actions || []));
-        } else {
-          if (config.folders && segmentThree === config.folders.slug && collectionConfig.folders) {
-            // Collection Folder Views
-            // --> /collections/:collectionSlug/:folderCollectionSlug
-            // --> /collections/:collectionSlug/:folderCollectionSlug/:folderID
-            routeParams.folderCollection = segmentThree;
-            routeParams.folderID = segmentFour;
-            ViewToRender = {
-              Component: CollectionFolderView
-            };
-            templateClassName = `collection-folders`;
-            templateType = 'default';
-            viewType = 'collection-folders';
-            viewActions.push(...(collectionConfig.admin.components?.views?.list?.actions || []));
-          } else {
-            // Collection Edit Views
-            // --> /collections/:collectionSlug/create
-            // --> /collections/:collectionSlug/:id
-            // --> /collections/:collectionSlug/:id/api
-            // --> /collections/:collectionSlug/:id/versions
-            // --> /collections/:collectionSlug/:id/versions/:versionID
-            routeParams.id = segmentThree === 'create' ? undefined : segmentThree;
-            routeParams.versionID = segmentFive;
-            ViewToRender = {
-              Component: DocumentView
-            };
-            templateClassName = `collection-default-edit`;
-            templateType = 'default';
-            const viewInfo = getDocumentViewInfo([segmentFour, segmentFive]);
-            viewType = viewInfo.viewType;
-            documentSubViewType = viewInfo.documentSubViewType;
-            viewActions.push(...getSubViewActions({
-              collectionOrGlobal: collectionConfig,
-              viewKeyArg: documentSubViewType
-            }));
-          }
+        if (routeParams.versionID) {
+            routeParams.versionID = parseDocumentID({
+                id: routeParams.versionID,
+                collectionSlug: collectionConfig.slug,
+                payload
+            });
         }
-      } else if (globalConfig) {
-        // Global Edit Views
-        // --> /globals/:globalSlug/versions
-        // --> /globals/:globalSlug/versions/:versionID
-        // --> /globals/:globalSlug/api
-        routeParams.global = globalConfig.slug;
-        routeParams.versionID = segmentFour;
-        ViewToRender = {
-          Component: DocumentView
-        };
-        templateClassName = `global-edit`;
-        templateType = 'default';
-        const viewInfo = getDocumentViewInfo([segmentThree, segmentFour]);
-        viewType = viewInfo.viewType;
-        documentSubViewType = viewInfo.documentSubViewType;
-        viewActions.push(...getSubViewActions({
-          collectionOrGlobal: globalConfig,
-          viewKeyArg: documentSubViewType
-        }));
-      }
-      break;
-  }
-  if (!ViewToRender) {
-    ViewToRender = getCustomViewByRoute({
-      config,
-      currentRoute
-    })?.view;
-  }
-  if (collectionConfig) {
-    if (routeParams.id) {
-      routeParams.id = parseDocumentID({
-        id: routeParams.id,
-        collectionSlug: collectionConfig.slug,
-        payload
-      });
     }
-    if (routeParams.versionID) {
-      routeParams.versionID = parseDocumentID({
-        id: routeParams.versionID,
-        collectionSlug: collectionConfig.slug,
-        payload
-      });
+    if (config.folders && routeParams.folderID) {
+        routeParams.folderID = parseDocumentID({
+            id: routeParams.folderID,
+            collectionSlug: config.folders.slug,
+            payload
+        });
+    }
+    if (globalConfig && routeParams.versionID) {
+        routeParams.versionID = payload.db.defaultIDType === 'number' && isNumber(routeParams.versionID) ? Number(routeParams.versionID) : routeParams.versionID;
+    }
+    if (viewActions.length) {
+        viewActions.reverse();
     }
-  }
-  if (config.folders && routeParams.folderID) {
-    routeParams.folderID = parseDocumentID({
-      id: routeParams.folderID,
-      collectionSlug: config.folders.slug,
-      payload
-    });
-  }
-  if (globalConfig && routeParams.versionID) {
-    routeParams.versionID = payload.db.defaultIDType === 'number' && isNumber(routeParams.versionID) ? Number(routeParams.versionID) : routeParams.versionID;
-  }
-  if (viewActions.length) {
-    viewActions.reverse();
-  }
-  return {
-    browseByFolderSlugs,
-    collectionConfig,
-    DefaultView: ViewToRender,
-    documentSubViewType,
-    globalConfig,
-    routeParams,
-    templateClassName,
-    templateType,
-    viewActions: viewActions.length ? viewActions : undefined,
-    viewType
-  };
+    return {
+        browseByFolderSlugs,
+        collectionConfig,
+        DefaultView: ViewToRender,
+        documentSubViewType,
+        globalConfig,
+        routeParams,
+        templateClassName,
+        templateType,
+        viewActions: viewActions.length ? viewActions : undefined,
+        viewType
+    };
 };
+
 //# sourceMappingURL=getRouteData.js.map