payload 3.0.0-beta.12 → 3.0.0-beta.121

package/dist/config/types.d.ts

@@ -1,21 +1,47 @@
-/// <reference types="node" resolution-mode="require"/>
-import type { I18nOptions, TFunction } from '@payloadcms/translations';
-import type { Options as ExpressFileUploadOptions } from 'express-fileupload';
+import type { DefaultTranslationsObject, I18nClient, I18nOptions, TFunction } from '@payloadcms/translations';
+import type { BusboyConfig } from 'busboy';
 import type GraphQL from 'graphql';
-import type { DestinationStream, LoggerOptions } from 'pino';
+import type { GraphQLFormattedError } from 'graphql';
+import type { JSONSchema4 } from 'json-schema';
+import type { DestinationStream, pino } from 'pino';
 import type React from 'react';
 import type { default as sharp } from 'sharp';
 import type { DeepRequired } from 'ts-essentials';
-import type { DocumentTab, RichTextAdapter } from '../admin/types.js';
-import type { AdminView, ServerSideEditViewProps } from '../admin/views/types.js';
-import type { User } from '../auth/types.js';
-import type { AfterErrorHook, Collection, CollectionConfig, SanitizedCollectionConfig } from '../collections/config/types.js';
+import type { RichTextAdapterProvider } from '../admin/RichText.js';
+import type { DocumentTabConfig, RichTextAdapter } from '../admin/types.js';
+import type { AdminViewConfig, ServerSideEditViewProps } from '../admin/views/types.js';
+import type { Permissions } from '../auth/index.js';
+import type { AddToImportMap, ImportMap, Imports, InternalImportMap } from '../bin/generateImportMap/index.js';
+import type { Collection, CollectionConfig, SanitizedCollectionConfig } from '../collections/config/types.js';
 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 } from '../index.js';
+import type { JobsConfig, Payload, RequestContext, TypedUser } from '../index.js';
 import type { PayloadRequest, Where } from '../types/index.js';
 import type { PayloadLogger } from '../utilities/logger.js';
+/**
+ * The string path pointing to the React component. If one of the generics is `never`, you effectively mark it as a server-only or client-only component.
+ *
+ * If it is `false` an empty component will be rendered.
+ */
+export type PayloadComponent<TComponentServerProps extends never | object = Record<string, any>, TComponentClientProps extends never | object = Record<string, any>> = false | RawPayloadComponent<TComponentServerProps, TComponentClientProps> | string;
+export type RawPayloadComponent<TComponentServerProps extends never | object = Record<string, any>, TComponentClientProps extends never | object = Record<string, any>> = {
+    clientProps?: object | TComponentClientProps;
+    exportName?: string;
+    path: string;
+    serverProps?: object | TComponentServerProps;
+};
+export type PayloadComponentProps<TPayloadComponent> = TPayloadComponent extends RawPayloadComponent<infer TComponentServerProps, infer TComponentClientProps> ? TComponentClientProps | TComponentServerProps : never;
+export type PayloadClientComponentProps<TPayloadComponent> = TPayloadComponent extends RawPayloadComponent<infer _, infer TComponentClientProps> ? TComponentClientProps : never;
+export type PayloadServerComponentProps<TPayloadComponent> = TPayloadComponent extends RawPayloadComponent<infer TComponentServerProps, infer _> ? TComponentServerProps : never;
+export type PayloadReactComponent<TPayloadComponent> = React.FC<PayloadComponentProps<TPayloadComponent>>;
+export type PayloadClientReactComponent<TPayloadComponent> = TPayloadComponent extends RawPayloadComponent<infer _, infer TComponentClientProps> ? TComponentClientProps extends never ? never : React.FC<TComponentClientProps> : never;
+export type PayloadServerReactComponent<TPayloadComponent> = TPayloadComponent extends RawPayloadComponent<infer TComponentServerProps, infer _> ? TComponentServerProps extends never ? never : React.FC<TComponentServerProps> : never;
+export type ResolvedComponent<TComponentServerProps extends never | object, TComponentClientProps extends never | object> = {
+    clientProps?: TComponentClientProps;
+    Component: React.FC<TComponentClientProps | TComponentServerProps>;
+    serverProps?: TComponentServerProps;
+};
 export type BinScriptConfig = {
     key: string;
     scriptPath: string;
@@ -51,14 +77,88 @@ export type LivePreviewConfig = {
         payload: Payload;
     }) => Promise<string> | string) | string;
 };
+export type OGImageConfig = {
+    alt?: string;
+    height?: number | string;
+    type?: string;
+    url: string;
+    width?: number | string;
+};
+export type OpenGraphConfig = {
+    description?: string;
+    images?: OGImageConfig | OGImageConfig[];
+    siteName?: string;
+    title?: string;
+};
+export type IconConfig = {
+    color?: string;
+    /**
+     * @see https://developer.mozilla.org/docs/Web/API/HTMLImageElement/fetchPriority
+     */
+    fetchPriority?: 'auto' | 'high' | 'low';
+    media?: string;
+    /** defaults to rel="icon" */
+    rel?: string;
+    sizes?: string;
+    type?: string;
+    /**
+     * URL of the icon to use. You can use a relative path from the public folder (see https://nextjs.org/docs/app/building-your-application/optimizing/static-assets) or an absolute URL.
+     */
+    url: string;
+};
+export type MetaConfig = {
+    /**
+     * When `static`, a pre-made image will be used for all pages.
+     * When `dynamic`, a unique image will be generated for each page based on page content and given overrides.
+     * When `off`, no Open Graph images will be generated and the `/api/og` endpoint will be disabled. You can still provide custom images using the `openGraph.images` property.
+     * @default 'dynamic'
+     */
+    defaultOGImageType?: 'dynamic' | 'off' | 'static';
+    /**
+     * Overrides the auto-generated <meta name="description"> of admin pages
+     * @example `"This is my custom CMS built with Payload."`
+     */
+    description?: string;
+    /**
+     * Icons to be rendered by devices and browsers.
+     *
+     * For example browser tabs, phone home screens, and search engine results.
+     */
+    icons?: IconConfig[];
+    /**
+     * Overrides the auto-generated <meta name="keywords"> of admin pages
+     * @example `"CMS, Payload, Custom"`
+     */
+    keywords?: string;
+    /**
+     * Metadata to be rendered as `og` meta tags in the head of the Admin Panel.
+     *
+     * For example when sharing the Admin Panel on social media or through messaging services.
+     */
+    openGraph?: OpenGraphConfig;
+    /**
+     * Overrides the auto-generated <title> of admin pages
+     * @example `"My Admin Panel"`
+     */
+    title?: string;
+    /**
+     * String to append to the auto-generated <title> of admin pages
+     * @example `" - Custom CMS"`
+     */
+    titleSuffix?: string;
+};
 export type ServerOnlyLivePreviewProperties = keyof Pick<LivePreviewConfig, 'url'>;
 type GeneratePreviewURLOptions = {
     locale: string;
     req: PayloadRequest;
     token: null | string;
 };
-export type GeneratePreviewURL = (doc: Record<string, unknown>, options: GeneratePreviewURLOptions) => Promise<null | string> | null | string;
+export type GeneratePreviewURL = (doc: Record<string, unknown>, options: GeneratePreviewURLOptions) => null | Promise<null | string> | string;
 export type GraphQLInfo = {
+    collections: {
+        [slug: string]: Collection;
+    };
+    globals: Globals;
     Mutation: {
         fields: Record<string, any>;
         name: string;
@@ -67,10 +167,6 @@ export type GraphQLInfo = {
         fields: Record<string, any>;
         name: string;
     };
-    collections: {
-        [slug: number | string | symbol]: Collection;
-    };
-    globals: Globals;
     types: {
         arrayTypes: Record<string, GraphQL.GraphQLType>;
         blockInputTypes: Record<string, GraphQL.GraphQLInputObjectType>;
@@ -99,18 +195,7 @@ export type InitOptions = {
      * Disable running of the `onInit` function
      */
     disableOnInit?: boolean;
-    /**
-     * A previously instantiated logger instance. Must conform to the PayloadLogger interface which uses Pino
-     * This allows you to bring your own logger instance and let payload use it
-     */
-    logger?: PayloadLogger;
-    loggerDestination?: DestinationStream;
-    /**
-     * Specify options for the built-in Pino logger that Payload uses for internal logging.
-     *
-     * See Pino Docs for options: https://getpino.io/#/docs/api?id=options
-     */
-    loggerOptions?: LoggerOptions;
+    importMap?: ImportMap;
     /**
      * A function that is called immediately following startup that receives the Payload instance as it's only argument.
      */
@@ -129,20 +214,20 @@ export type InitOptions = {
  *
  * @see https://payloadcms.com/docs/access-control/overview
  */
-export type AccessResult = Where | boolean;
-export type AccessArgs<T = any, U = any> = {
+export type AccessResult = boolean | Where;
+export type AccessArgs<TData = any> = {
     /**
      * The relevant resource that is being accessed.
      *
      * `data` is null when a list is requested
      */
-    data?: T;
+    data?: TData;
     /** ID of the resource being accessed */
     id?: number | string;
     /** If true, the request is for a static file */
     isReadingStaticFile?: boolean;
     /** The original request that requires an access check */
-    req: PayloadRequest<U>;
+    req: PayloadRequest;
 };
 /**
  * Access function runs on the server
@@ -150,13 +235,13 @@ export type AccessArgs<T = any, U = any> = {
  *
  * @see https://payloadcms.com/docs/access-control/overview
  */
-export type Access<T = any, U = any> = (args: AccessArgs<T, U>) => AccessResult | Promise<AccessResult>;
-/** Web Request/Response model, but the the req has more payload specific properties added to it. */
+export type Access<TData = any> = (args: AccessArgs<TData>) => AccessResult | Promise<AccessResult>;
+/** Web Request/Response model, but the req has more payload specific properties added to it. */
 export type PayloadHandler = (req: PayloadRequest) => Promise<Response> | Response;
 /**
  * Docs: https://payloadcms.com/docs/rest-api/overview#custom-endpoints
  */
-export type Endpoint<U = User> = {
+export type Endpoint = {
     /** Extension point to add your custom data. */
     custom?: Record<string, any>;
     /**
@@ -181,35 +266,40 @@ export type Endpoint<U = User> = {
      */
     root?: never;
 };
-export type EditViewComponent = React.ComponentType<ServerSideEditViewProps>;
+export type EditViewComponent = PayloadComponent<ServerSideEditViewProps>;
 export type EditViewConfig = {
+    meta?: MetaConfig;
+} & ({
+    actions?: CustomComponent[];
+} | {
+    Component: EditViewComponent;
+    path?: string;
+} | {
+    path?: string;
     /**
-     * Add a new Edit view to the admin panel
+     * Add a new Edit View to the admin panel
      * i.e. you can render a custom view that has no tab, if desired
      * Or override a specific properties of an existing one
      * i.e. you can customize the `Default` view tab label, if desired
      */
-    Tab?: DocumentTab;
-    path?: string;
-} | {
-    Component: EditViewComponent;
-    path: string;
-} | {
-    actions?: CustomComponent[];
-};
-/**
- * Override existing views
- * i.e. Dashboard, Account, API, LivePreview, etc.
- * Path is not available here
- * All Tab properties become optional
- * i.e. you can change just the label, if desired
- */
-export type EditView = EditViewComponent | EditViewConfig;
+    tab?: DocumentTabConfig;
+});
 export type ServerProps = {
-    payload: Payload;
+    readonly i18n: I18nClient;
+    readonly locale?: Locale;
+    readonly params?: {
+        [key: string]: string | string[] | undefined;
+    };
+    readonly payload: Payload;
+    readonly permissions?: Permissions;
+    readonly [key: string]: unknown;
+    readonly searchParams?: {
+        [key: string]: string | string[] | undefined;
+    };
+    readonly user?: TypedUser;
 };
 export declare const serverProps: (keyof ServerProps)[];
-export type CustomComponent<T extends any = any> = React.ComponentType<T & ServerProps>;
+export type CustomComponent<TAdditionalProps extends object = Record<string, any>> = PayloadComponent<ServerProps & TAdditionalProps, TAdditionalProps>;
 export type Locale = {
     /**
      * value of supported locale
@@ -239,14 +329,14 @@ export type BaseLocalizationConfig = {
     /** Set to `true` to let missing values in localised fields fall back to the values in `defaultLocale` */
     fallback?: boolean;
 };
-export type LocalizationConfigWithNoLabels = Prettify<BaseLocalizationConfig & {
+export type LocalizationConfigWithNoLabels = Prettify<{
     /**
      * List of supported locales
      * @example `["en", "es", "fr", "nl", "de", "jp"]`
      */
     locales: string[];
-}>;
-export type LocalizationConfigWithLabels = Prettify<BaseLocalizationConfig & {
+} & BaseLocalizationConfig>;
+export type LocalizationConfigWithLabels = Prettify<{
     /**
      * List of supported locales with labels
      * @example {
@@ -256,14 +346,14 @@ export type LocalizationConfigWithLabels = Prettify<BaseLocalizationConfig & {
      * }
      */
     locales: Locale[];
-}>;
-export type SanitizedLocalizationConfig = Prettify<LocalizationConfigWithLabels & {
+} & BaseLocalizationConfig>;
+export type SanitizedLocalizationConfig = Prettify<{
     /**
      * List of supported locales
      * @example `["en", "es", "fr", "nl", "de", "jp"]`
      */
     localeCodes: string[];
-}>;
+} & LocalizationConfigWithLabels>;
 /**
  * @see https://payloadcms.com/docs/configuration/localization#localization
  */
@@ -271,7 +361,151 @@ export type LocalizationConfig = Prettify<LocalizationConfigWithLabels | Localiz
 export type LabelFunction = ({ t }: {
     t: TFunction;
 }) => string;
-export type SharpDependency = (input?: ArrayBuffer | Buffer | Float32Array | Float64Array | Int8Array | Int16Array | Int32Array | Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | string, options?: sharp.SharpOptions) => sharp.Sharp;
+export type StaticLabel = Record<string, string> | string;
+export type SharpDependency = (input?: ArrayBuffer | Buffer | Float32Array | Float64Array | Int8Array | Int16Array | Int32Array | string | Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array, options?: sharp.SharpOptions) => sharp.Sharp;
+export type CORSConfig = {
+    headers?: string[];
+    origins: '*' | string[];
+};
+export type AdminFunction = {
+    args?: object;
+    path: string;
+    type: 'function';
+};
+export type AdminComponent = {
+    clientProps?: object;
+    path: string;
+    serverProps?: object;
+    type: 'component';
+};
+export interface AdminDependencies {
+    [key: string]: AdminComponent | AdminFunction;
+}
+export type FetchAPIFileUploadOptions = {
+    /**
+     * Returns a HTTP 413 when the file is bigger than the size limit if `true`.
+     * Otherwise, it will add a `truncated = true` to the resulting file structure.
+     * @default false
+     */
+    abortOnLimit?: boolean | undefined;
+    /**
+     * Automatically creates the directory path specified in `.mv(filePathName)`
+     * @default false
+     */
+    createParentPath?: boolean | undefined;
+    /**
+     * Turn on/off upload process logging. Can be useful for troubleshooting.
+     * @default false
+     */
+    debug?: boolean | undefined;
+    /**
+     * User defined limit handler which will be invoked if the file is bigger than configured limits.
+     * @default false
+     */
+    limitHandler?: ((args: {
+        request: Request;
+        size: number;
+    }) => void) | boolean | undefined;
+    /**
+     * By default, `req.body` and `req.files` are flattened like this:
+     * `{'name': 'John', 'hobbies[0]': 'Cinema', 'hobbies[1]': 'Bike'}
+     *
+     * When this option is enabled they are parsed in order to be nested like this:
+     * `{'name': 'John', 'hobbies': ['Cinema', 'Bike']}`
+     * @default false
+     */
+    parseNested?: boolean | undefined;
+    /**
+     * Preserves filename extension when using `safeFileNames` option.
+     * If set to `true`, will default to an extension length of `3`.
+     * If set to `number`, this will be the max allowable extension length.
+     * If an extension is smaller than the extension length, it remains untouched. If the extension is longer,
+     * it is shifted.
+     * @default false
+     *
+     * @example
+     * // true
+     * app.use(fileUpload({ safeFileNames: true, preserveExtension: true }));
+     * // myFileName.ext --> myFileName.ext
+     *
+     * @example
+     * // max extension length 2, extension shifted
+     * app.use(fileUpload({ safeFileNames: true, preserveExtension: 2 }));
+     * // myFileName.ext --> myFileNamee.xt
+     */
+    preserveExtension?: boolean | number | undefined;
+    /**
+     * Response which will be send to client if file size limit exceeded when `abortOnLimit` set to `true`.
+     * @default 'File size limit has been reached'
+     */
+    responseOnLimit?: string | undefined;
+    /**
+     * Strips characters from the upload's filename.
+     * You can use custom regex to determine what to strip.
+     * If set to `true`, non-alphanumeric characters _except_ dashes and underscores will be stripped.
+     * This option is off by default.
+     * @default false
+     *
+     * @example
+     * // strip slashes from file names
+     * app.use(fileUpload({ safeFileNames: /\\/g }))
+     *
+     * @example
+     * app.use(fileUpload({ safeFileNames: true }))
+     */
+    safeFileNames?: boolean | RegExp | undefined;
+    /**
+     * Path to store temporary files.
+     * Used along with the `useTempFiles` option. By default this module uses `'tmp'` folder
+     * in the current working directory.
+     * You can use trailing slash, but it is not necessary.
+     * @default './tmp'
+     */
+    tempFileDir?: string | undefined;
+    /**
+     * This defines how long to wait for data before aborting. Set to `0` if you want to turn off timeout checks.
+     * @default 60_000
+     */
+    uploadTimeout?: number | undefined;
+    /**
+     * Applies uri decoding to file names if set `true`.
+     * @default false
+     */
+    uriDecodeFileNames?: boolean | undefined;
+    /**
+     * By default this module uploads files into RAM.
+     * Setting this option to `true` turns on using temporary files instead of utilising RAM.
+     * This avoids memory overflow issues when uploading large files or in case of uploading
+     * lots of files at same time.
+     * @default false
+     */
+    useTempFiles?: boolean | undefined;
+} & Partial<BusboyConfig>;
+export type ErrorResult = {
+    data?: any;
+    errors: unknown[];
+    stack?: string;
+};
+export type AfterErrorResult = {
+    graphqlResult?: GraphQLFormattedError;
+    response?: Partial<ErrorResult> & Record<string, unknown>;
+    status?: number;
+} | void;
+export type AfterErrorHookArgs = {
+    /** The Collection that the hook is operating on. This will be undefined if the hook is executed from a non-collection endpoint or GraphQL. */
+    collection?: SanitizedCollectionConfig;
+    /** 	Custom context passed between hooks */
+    context: RequestContext;
+    /** The error that occurred. */
+    error: Error;
+    /** The GraphQL result object, available if the hook is executed within a GraphQL context. */
+    graphqlResult?: GraphQLFormattedError;
+    /** The Request object containing the currently authenticated user. */
+    req: PayloadRequest;
+    /** The formatted error result object, available if the hook is executed from a REST context. */
+    result?: ErrorResult;
+};
+export type AfterErrorHook = (args: AfterErrorHookArgs) => AfterErrorResult | Promise<AfterErrorResult>;
 /**
  * This is the central configuration
  *
@@ -280,34 +514,33 @@ export type SharpDependency = (input?: ArrayBuffer | Buffer | Float32Array | Flo
 export type Config = {
     /** Configure admin dashboard */
     admin?: {
-        /** Automatically log in as a user when visiting the admin dashboard. */
+        /** Automatically log in as a user */
         autoLogin?: {
             /**
              * The email address of the user to login as
-             *
              */
-            email: string;
-            /** The password of the user to login as */
-            password: string;
+            email?: string;
+            /** The password of the user to login as. This is only needed if `prefillOnly` is set to true */
+            password?: string;
             /**
              * If set to true, the login credentials will be prefilled but the user will still need to click the login button.
              *
              * @default false
              */
             prefillOnly?: boolean;
+            /** The username of the user to login as */
+            username?: string;
         } | false;
         /** Set account profile picture. Options: gravatar, default or a custom React component. */
-        avatar?: 'default' | 'gravatar' | React.ComponentType<any>;
+        avatar?: 'default' | 'gravatar' | {
+            Component: PayloadComponent<never>;
+        };
         /**
          * Add extra and/or replace built-in components with custom components
          *
          * @see https://payloadcms.com/docs/admin/components
          */
         components?: {
-            /**
-             * Replace the navigation with a custom component
-             */
-            Nav?: CustomComponent;
             /**
              * Add custom components to the top right of the Admin Panel
              */
@@ -343,15 +576,25 @@ export type Config = {
                 /** Replace the logo on the login page */
                 Logo?: CustomComponent;
             };
+            /**
+             * Add custom header to top of page globally
+             */
+            header?: CustomComponent[];
             /** Replace logout related components */
             logout?: {
                 /** Replace the logout button  */
                 Button?: CustomComponent;
             };
+            /**
+             * Replace the navigation with a custom component
+             */
+            Nav?: CustomComponent;
             /**
              * Wrap the admin dashboard in custom context providers
              */
-            providers?: React.ComponentType<{
+            providers?: PayloadComponent<{
+                children?: React.ReactNode;
+            }, {
                 children?: React.ReactNode;
             }>[];
             /**
@@ -362,48 +605,79 @@ export type Config = {
              */
             views?: {
                 /** Add custom admin views */
-                [key: string]: AdminView;
+                [key: string]: AdminViewConfig;
                 /** Replace the account screen */
-                Account?: AdminView;
+                Account?: AdminViewConfig;
                 /** Replace the admin homepage */
-                Dashboard?: AdminView;
+                Dashboard?: AdminViewConfig;
             };
         };
         /** Extension point to add your custom data. Available in server and client. */
         custom?: Record<string, any>;
         /** Global date format that will be used for all dates in the Admin panel. Any valid date-fns format pattern can be used. */
         dateFormat?: string;
+        /**
+         * Each entry in this map generates an entry in the importMap,
+         * as well as an entry in the componentMap if the type of the
+         * dependency is 'component'
+         */
+        dependencies?: AdminDependencies;
         /** If set to true, the entire Admin panel will be disabled. */
         disable?: boolean;
-        /** The route the user will be redirected to after being inactive for too long. */
-        inactivityRoute?: string;
-        livePreview?: LivePreviewConfig & {
-            collections?: string[];
-            globals?: string[];
-        };
-        /** The route for the logout page. */
-        logoutRoute?: string;
-        /** Base meta data to use for the Admin panel. Included properties are titleSuffix, ogImage, and favicon. */
-        meta?: {
+        importMap?: {
             /**
-             * Public path to an icon
-             *
-             * This image may be displayed in the browser next to the title of the page
+             * Automatically generate component map during development
+             * @default true
              */
-            favicon?: string;
-            /**
-             * Public path to an image
+            autoGenerate?: boolean;
+            /** The base directory for component paths starting with /.
              *
-             * This image may be displayed as preview when the link is shared on social media
-             */
-            ogImage?: string;
+             * By default, this is process.cwd()
+             **/
+            baseDir?: string;
             /**
-             * String to append to the <title> of admin pages
-             * @example `" - My Brand"`
+             * You can use generators to add custom components to the component import map.
+             * This allows you to import custom components in the admin panel.
              */
-            titleSuffix?: string;
+            generators?: Array<(props: {
+                addToImportMap: AddToImportMap;
+                baseDir: string;
+                config: SanitizedConfig;
+                importMap: InternalImportMap;
+                imports: Imports;
+            }) => void>;
+        };
+        livePreview?: {
+            collections?: string[];
+            globals?: string[];
+        } & LivePreviewConfig;
+        /** Base meta data to use for the Admin Panel. Included properties are titleSuffix, ogImage, and favicon. */
+        meta?: MetaConfig;
+        routes?: {
+            /** The route for the account page. */
+            account?: string;
+            /** The route for the create first user page. */
+            createFirstUser?: string;
+            /** The route for the forgot password page. */
+            forgot?: string;
+            /** The route the user will be redirected to after being inactive for too long. */
+            inactivity?: string;
+            /** The route for the login page. */
+            login?: string;
+            /** The route for the logout page. */
+            logout?: string;
+            /** The route for the reset password page. */
+            reset?: string;
+            /** The route for the unauthorized page. */
+            unauthorized?: string;
         };
-        /** The slug of a Collection that you want be used to log in to the Admin dashboard. */
+        /**
+         * Restrict the Admin Panel theme to use only one of your choice
+         *
+         * @default 'all' // The theme can be configured by users
+         */
+        theme?: 'all' | 'dark' | 'light';
+        /** The slug of a Collection that you want to be used to log in to the Admin dashboard. */
         user?: string;
     };
     /** Custom Payload bin scripts can be injected via the config. */
@@ -415,10 +689,17 @@ export type Config = {
      */
     collections?: CollectionConfig[];
     /**
-     * Replace the built-in components with custom ones
+     * Compatibility flags for prior Payload versions
      */
-    components?: {
-        [key: string]: (() => JSX.Element) | JSX.Element;
+    compatibility?: {
+        /**
+         * By default, Payload will remove the `localized: true` property
+         * from fields if a parent field is localized. Set this property
+         * to `true` only if you have an existing Payload database from pre-3.0
+         * that you would like to maintain without migrating. This is only
+         * relevant for MongoDB databases.
+         */
+        allowLocalizedWithinLocalized: true;
     };
     /**
      * Prefix a string to all cookies that Payload sets.
@@ -427,7 +708,7 @@ export type Config = {
      */
     cookiePrefix?: string;
     /** Either a whitelist array of URLS to allow CORS requests from, or a wildcard string ('*') to accept incoming requests from any domain. */
-    cors?: '*' | string[];
+    cors?: '*' | CORSConfig | string[];
     /** A whitelist array of URLs to allow Payload cookies to be accepted from as a form of CSRF protection. */
     csrf?: string[];
     /** Extension point to add your custom data. Server only. */
@@ -451,7 +732,7 @@ export type Config = {
      */
     defaultMaxTextLength?: number;
     /** Default richtext editor to use for richText fields */
-    editor: RichTextAdapter<any, any, any>;
+    editor?: RichTextAdapterProvider<any, any, any>;
     /**
      * Email Adapter
      *
@@ -487,6 +768,10 @@ export type Config = {
          * @see https://payloadcms.com/docs/graphql/extending
          */
         queries?: GraphQLExtension;
+        /**
+         * Filepath to write the generated schema to
+         */
+        schemaOutputFile?: string;
     };
     /**
      * Tap into Payload-wide hooks.
@@ -494,18 +779,50 @@ export type Config = {
      * @see https://payloadcms.com/docs/hooks/overview
      */
     hooks?: {
-        afterError?: AfterErrorHook;
+        afterError?: AfterErrorHook[];
     };
     /** i18n config settings */
-    i18n?: I18nOptions;
+    i18n?: I18nOptions<{} | DefaultTranslationsObject>;
     /** Automatically index all sortable top-level fields in the database to improve sort performance and add database compatibility for Azure Cosmos and similar. */
     indexSortableFields?: boolean;
+    /**
+     * @experimental There may be frequent breaking changes to this API
+     */
+    jobs?: JobsConfig;
     /**
      * Translate your content to different languages/locales.
      *
      * @default false // disable localization
      */
-    localization?: LocalizationConfig | false;
+    localization?: false | LocalizationConfig;
+    /**
+     * Logger options, logger options with a destination stream, or an instantiated logger instance.
+     *
+     * See Pino Docs for options: https://getpino.io/#/docs/api?id=options
+     *
+     * ```ts
+     * // Logger options only
+     * logger: {
+     *   level: 'info',
+     * }
+     *
+     * // Logger options with destination stream
+     * logger: {
+     *  options: {
+     *   level: 'info',
+     *  },
+     *  destination: process.stdout
+     * },
+     *
+     * // Logger instance
+     * logger: pino({ name: 'my-logger' })
+     *
+     * ```
+     */
+    logger?: 'sync' | {
+        destination?: DestinationStream;
+        options: pino.LoggerOptions;
+    } | PayloadLogger;
     /**
      * The maximum allowed depth to be permitted application-wide. This setting helps prevent against malicious queries.
      *
@@ -524,7 +841,10 @@ export type Config = {
     plugins?: Plugin[];
     /** Control the routing structure that Payload binds itself to. */
     routes?: {
-        /** @default "/admin" */
+        /** The route for the admin panel.
+         * @example "/my-admin"
+         * @default "/admin"
+         */
         admin?: string;
         /** @default "/api"  */
         api?: string;
@@ -551,50 +871,95 @@ export type Config = {
     telemetry?: boolean;
     /** Control how typescript interfaces are generated from your collections. */
     typescript?: {
+        /**
+         * Automatically generate types during development
+         * @default true
+         */
+        autoGenerate?: boolean;
         /** Disable declare block in generated types file */
-        declare?: false;
+        declare?: {
+            /**
+             * @internal internal use only to allow for multiple declarations within a monorepo and suppress the "Duplicate identifier GeneratedTypes" error
+             *
+             * Adds a @ts-ignore flag above the GeneratedTypes interface declaration
+             *
+             * @default false
+             */
+            ignoreTSError?: boolean;
+        } | false;
         /** Filename to write the generated types to */
         outputFile?: string;
+        /**
+         * Allows you to modify the base JSON schema that is generated during generate:types. This JSON schema will be used
+         * to generate the TypeScript interfaces.
+         */
+        schema?: Array<(args: {
+            jsonSchema: JSONSchema4;
+        }) => JSONSchema4>;
     };
     /**
      * Customize the handling of incoming file uploads for collections that have uploads enabled.
      */
-    upload?: ExpressFileUploadOptions;
+    upload?: FetchAPIFileUploadOptions;
 };
-export type SanitizedConfig = Omit<DeepRequired<Config>, 'collections' | 'endpoint' | 'globals' | 'i18n' | 'localization'> & {
+export type SanitizedConfig = {
     collections: SanitizedCollectionConfig[];
+    /** Default richtext editor to use for richText fields */
+    editor?: RichTextAdapter<any, any, any>;
     endpoints: Endpoint[];
     globals: SanitizedGlobalConfig[];
     i18n: Required<I18nOptions>;
-    localization: SanitizedLocalizationConfig | false;
+    jobs: JobsConfig;
+    localization: false | SanitizedLocalizationConfig;
     paths: {
         config: string;
         configDir: string;
         rawConfig: string;
     };
-};
-export type EditConfig = ({
+    upload: {
+        /**
+         * Deduped list of adapters used in the project
+         */
+        adapters: string[];
+    } & FetchAPIFileUploadOptions;
+} & Omit<DeepRequired<Config>, 'collections' | 'editor' | 'endpoint' | 'globals' | 'i18n' | 'localization' | 'upload'>;
+export type EditConfig = {
+    [key: string]: EditViewConfig;
     /**
      * Replace or modify individual nested routes, or add new ones:
-     * + `Default` - `/admin/collections/:collection/:id`
-     * + `API` - `/admin/collections/:collection/:id/api`
-     * + `LivePreview` - `/admin/collections/:collection/:id/preview`
-     * + `References` - `/admin/collections/:collection/:id/references`
-     * + `Relationships` - `/admin/collections/:collection/:id/relationships`
-     * + `Versions` - `/admin/collections/:collection/:id/versions`
-     * + `Version` - `/admin/collections/:collection/:id/versions/:version`
-     * + `CustomView` - `/admin/collections/:collection/:id/:path`
-     */
-    API?: EditViewComponent | Partial<EditViewConfig>;
-    Default?: EditViewComponent | Partial<EditViewConfig>;
-    LivePreview?: EditViewComponent | Partial<EditViewConfig>;
-    Version?: EditViewComponent | Partial<EditViewConfig>;
-    Versions?: EditViewComponent | Partial<EditViewConfig>;
+     * + `default` - `/admin/collections/:collection/:id`
+     * + `api` - `/admin/collections/:collection/:id/api`
+     * + `livePreview` - `/admin/collections/:collection/:id/preview`
+     * + `references` - `/admin/collections/:collection/:id/references`
+     * + `relationships` - `/admin/collections/:collection/:id/relationships`
+     * + `versions` - `/admin/collections/:collection/:id/versions`
+     * + `version` - `/admin/collections/:collection/:id/versions/:version`
+     * + `customView` - `/admin/collections/:collection/:id/:path`
+     *
+     * To override the entire Edit View including all nested views, use the `root` key.
+     */
+    api?: Partial<EditViewConfig>;
+    default?: Partial<EditViewConfig>;
+    livePreview?: Partial<EditViewConfig>;
+    root?: never;
+    version?: Partial<EditViewConfig>;
+    versions?: Partial<EditViewConfig>;
 } | {
-    [key: string]: EditViewConfig;
-}) | EditViewComponent;
+    api?: never;
+    default?: never;
+    livePreview?: never;
+    /**
+     * Replace or modify _all_ nested document views and routes, including the document header, controls, and tabs. This cannot be used in conjunction with other nested views.
+     * + `root` - `/admin/collections/:collection/:id/**\/*`
+     */
+    root: Partial<EditViewConfig>;
+    version?: never;
+    versions?: never;
+};
 export type EntityDescriptionComponent = CustomComponent;
-export type EntityDescriptionFunction = () => string;
-export type EntityDescription = EntityDescriptionComponent | EntityDescriptionFunction | Record<string, string> | string;
+export type EntityDescriptionFunction = ({ t }: {
+    t: TFunction;
+}) => string;
+export type EntityDescription = EntityDescriptionFunction | Record<string, string> | string;
 export type { EmailAdapter, SendEmailOptions };
 //# sourceMappingURL=types.d.ts.map