payload 1.2.1 → 1.2.2

package/dist/config/types.d.ts

@@ -48,14 +48,16 @@ export declare function hasTransportOptions(emailConfig: EmailOptions): emailCon
 export declare type InitOptions = {
     /** Express app for Payload to use */
     express?: Express;
+    /** Mongo connection URL, starts with `mongo` */
     mongoURL: string | false;
+    /** Extra configuration options that will be passed to Mongo */
     mongoOptions?: ConnectOptions;
     /** Secure string that Payload will use for any encryption workflows */
     secret: string;
     /**
      * Configuration for Payload's email functionality
      *
-     * https://payloadcms.com/docs/email/overview
+     * @see https://payloadcms.com/docs/email/overview
      */
     email?: EmailOptions;
     /**
@@ -76,23 +78,65 @@ export declare type InitOptions = {
      */
     loggerOptions?: LoggerOptions;
 };
+/**
+ * This result is calculated on the server
+ * and then sent to the client allowing the dashboard to show accessible data and actions.
+ *
+ * If the result is `true`, the user has access.
+ * If the result is an object, it is interpreted as a Mongo query.
+ *
+ * @example `{ createdBy: { equals: id } }`
+ *
+ * @example `{ tenant: { in: tenantIds } }`
+ *
+ * @see https://payloadcms.com/docs/access-control/overview
+ */
 export declare type AccessResult = boolean | Where;
 declare type AccessArgs<T = any, U = any> = {
+    /** The original request that requires an access check */
     req: PayloadRequest<U>;
+    /** ID of the resource being accessed */
     id?: string | number;
+    /**
+     * The relevant resource that is being accessed.
+     *
+     * `data` is null when a list is requested
+     */
     data?: T;
 };
 /**
- * Access function
+ * Access function runs on the server
+ * and is sent to the client allowing the dashboard to show accessible data and actions.
+ *
+ * @see https://payloadcms.com/docs/access-control/overview
  */
 export declare type Access<T = any, U = any> = (args: AccessArgs<T, U>) => AccessResult | Promise<AccessResult>;
+/** Equivalent to express middleware, but with an enhanced request object */
 export interface PayloadHandler {
     (req: PayloadRequest, res: Response, next: NextFunction): void;
 }
+/**
+ * Docs: https://payloadcms.com/docs/rest-api/overview#custom-endpoints
+ */
 export declare type Endpoint = {
+    /**
+     * Pattern that should match the path of the incoming request
+     *
+     * Compatible with the Express router
+     */
     path: string;
+    /** HTTP method (or "all") */
     method: 'get' | 'head' | 'post' | 'put' | 'patch' | 'delete' | 'connect' | 'options' | string;
+    /**
+     * Middleware that will be called when the path/method matches
+     *
+     * Compatible with Express middleware
+     */
     handler: PayloadHandler | PayloadHandler[];
+    /**
+     * Set to `true` to disable the Payload middleware for this endpoint
+     * @default false
+     */
     root?: boolean;
 };
 export declare type AdminView = React.ComponentType<{
@@ -102,82 +146,232 @@ export declare type AdminView = React.ComponentType<{
 export declare type AdminRoute = {
     Component: AdminView;
     path: string;
+    /** Whether the path should be matched exactly or as a prefix */
     exact?: boolean;
     strict?: boolean;
     sensitive?: boolean;
 };
+/**
+ * @see https://payloadcms.com/docs/configuration/localization#localization
+ */
 export declare type LocalizationConfig = {
+    /**
+     * List of supported locales
+     * @exanple `["en", "es", "fr", "nl", "de", "jp"]`
+     */
     locales: string[];
+    /**
+     * Locale for users that have not expressed their preference for a specific locale
+     * @exanple `"en"`
+     */
     defaultLocale: string;
+    /** Set to `true` to let missing values in localised fields fall back to the values in `defaultLocale` */
     fallback?: boolean;
 };
+/**
+ * This is the central configuration
+ *
+ * @see https://payloadcms.com/docs/configuration/overview
+ */
 export declare type Config = {
+    /** Configure admin dashboard */
     admin?: {
+        /** The slug of a Collection that you want be used to log in to the Admin dashboard. */
         user?: string;
+        /** Base meta data to use for the Admin panel. Included properties are titleSuffix, ogImage, and favicon. */
         meta?: {
+            /**
+             * String to append to the <title> of admin pages
+             * @example `" - My Brand"`
+             */
             titleSuffix?: string;
+            /**
+             * Public path to an image
+             *
+             * This image may be displayed as preview when the link is shared on social media
+             */
             ogImage?: string;
+            /**
+             * Public path to an icon
+             *
+             * This image may be displayed in the browser next to the title of the page
+             */
             favicon?: string;
         };
+        /** If set to true, the entire Admin panel will be disabled. */
         disable?: boolean;
+        /** Replace the entirety of the index.html file used by the Admin panel. Reference the base index.html file to ensure your replacement has the appropriate HTML elements. */
         indexHTML?: string;
+        /** Absolute path to a stylesheet that you can use to override / customize the Admin panel styling. */
         css?: string;
+        /** 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;
+        /** Set account profile picture. Options: gravatar, default or a custom React component. */
         avatar?: 'default' | 'gravatar' | React.ComponentType<any>;
+        /** The route for the logout page. */
         logoutRoute?: string;
+        /** The route the user will be redirected to after being inactive for too long. */
         inactivityRoute?: string;
+        /**
+         * Add extra and/or replace built-in components with custom components
+         *
+         * @see https://payloadcms.com/docs/admin/components
+         */
         components?: {
+            /**
+             * Add custom routes in the admin dashboard
+             */
             routes?: AdminRoute[];
+            /**
+             * Wrap the admin dashboard in custom context providers
+             */
             providers?: React.ComponentType<{
                 children: React.ReactNode;
             }>[];
+            /**
+             * Add custom components before the collection overview
+             */
             beforeDashboard?: React.ComponentType<any>[];
+            /**
+             * Add custom components after the collection overview
+             */
             afterDashboard?: React.ComponentType<any>[];
+            /**
+            * Add custom components before the email/password field
+            */
             beforeLogin?: React.ComponentType<any>[];
+            /**
+             * Add custom components after the email/password field
+             */
             afterLogin?: React.ComponentType<any>[];
+            /**
+             * Add custom components before the navigation links
+             */
             beforeNavLinks?: React.ComponentType<any>[];
+            /**
+             * Add custom components after the navigation links
+             */
             afterNavLinks?: React.ComponentType<any>[];
+            /**
+             * Replace the navigation with a custom component
+             */
             Nav?: React.ComponentType<any>;
+            /** Replace logout related components */
             logout?: {
+                /** Replace the logout button  */
                 Button?: React.ComponentType<any>;
             };
+            /** Replace graphical components */
             graphics?: {
+                /** Replace the icon in the navigation */
                 Icon?: React.ComponentType<any>;
+                /** Replace the logo on the login page */
                 Logo?: React.ComponentType<any>;
+                v: any;
             };
             views?: {
+                /** Replace the account screen */
                 Account?: React.ComponentType<any>;
+                /** Replace the admin homepage */
                 Dashboard?: React.ComponentType<any>;
+                v: any;
             };
         };
+        /**
+         * Control pagination when querying collections.
+         *
+         * @see https://payloadcms.com/docs/queries/overview
+        */
         pagination?: {
+            /**
+             * Limit the number of documents that are displayed on 1 page in the list view
+             *
+             * @default 10
+             */
             defaultLimit?: number;
-            options?: number[];
+            /**
+             * Suggest alternative options for the limit of documents on the list view
+             *
+             * @default [5, 10, 25, 50, 100]
+             */
+            limits?: number[];
         };
+        /** Customize the Webpack config that's used to generate the Admin panel. */
         webpack?: (config: Configuration) => Configuration;
     };
+    /**
+     * Manage the datamodel of your application
+     *
+     * @see https://payloadcms.com/docs/configuration/collections#collection-configs
+     */
     collections?: CollectionConfig[];
+    /** Custom REST endpoints */
     endpoints?: Endpoint[];
+    /**
+     * @see https://payloadcms.com/docs/configuration/globals#global-configs
+     */
     globals?: GlobalConfig[];
+    /**
+     * Control the behaviour of the admin internationalisation.
+     *
+     * See i18next options.
+     *
+     * @default
+     * {
+     *   fallbackLng: 'en',
+     *   debug: false,
+     *   supportedLngs: Object.keys(translations),
+     *   resources: translations,
+     * }
+     */
     i18n?: i18nInitOptions;
+    /**
+     * Define the absolute URL of your app including the protocol, for example `https://example.org`.
+     * No paths allowed, only protocol, domain and (optionally) port.
+     *
+     * @see https://payloadcms.com/docs/configuration/overview#options
+     */
     serverURL?: string;
+    /**
+     * Prefix a string to all cookies that Payload sets.
+     *
+     * @default "payload"
+     */
     cookiePrefix?: string;
+    /** A whitelist array of URLs to allow Payload cookies to be accepted from as a form of CSRF protection. */
     csrf?: 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[] | '*';
+    /** Control the routing structure that Payload binds itself to. */
     routes?: {
+        /** Defaults to /api  */
         api?: string;
+        /** Defaults to /admin */
         admin?: string;
+        /** Defaults to /graphql  */
         graphQL?: string;
+        /** Defaults to /playground */
         graphQLPlayground?: string;
     };
+    /** Control how typescript interfaces are generated from your collections. */
     typescript?: {
+        /** Filename to write the generated types to */
         outputFile?: string;
     };
+    /** Enable to expose more detailed error information. */
     debug?: boolean;
+    /**
+     * Express-specific middleware options such as compression and JSON parsing.
+     *
+     * @see https://payloadcms.com/docs/configuration/express
+     */
     express?: {
+        /** Control the way JSON is parsed */
         json?: {
+            /** Defaults to 2MB  */
             limit?: number;
         };
+        /** Control the way responses are compressed */
         compression?: {
             [key: string]: unknown;
         };
@@ -188,34 +382,103 @@ export declare type Config = {
         preMiddleware?: any[];
         postMiddleware?: any[];
     };
+    /**
+     * If a user does not specify `depth` while requesting a resource, this depth will be used.
+     *
+     * @see https://payloadcms.com/docs/getting-started/concepts#depth
+     *
+     * @default 2
+     */
     defaultDepth?: number;
+    /**
+     * The maximum allowed depth to be permitted application-wide. This setting helps prevent against malicious queries.
+     *
+     * @see https://payloadcms.com/docs/getting-started/concepts#depth
+     *
+     * @default 10
+     */
     maxDepth?: number;
+    /**
+     * The maximum allowed depth to be permitted application-wide. This setting helps prevent against malicious queries.
+     *
+     * @default 40000
+     */
     defaultMaxTextLength?: number;
+    /** 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;
+    /**
+     * Limit heavy usage
+     *
+     * @default
+     * {
+     *   window: 15 * 60 * 100, // 1.5 minutes,
+     *   max: 500,
+     * }
+    */
     rateLimit?: {
         window?: number;
         max?: number;
         trustProxy?: boolean;
         skip?: (req: PayloadRequest) => boolean;
     };
+    /**
+     * Customize the handling of incoming file uploads for collections that have uploads enabled.
+     */
     upload?: Options;
+    /**
+     * Translate your content to different languages/locales.
+     *
+     * @default false // disable localization
+     */
     localization?: LocalizationConfig | false;
+    /**
+     * Manage the GraphQL API
+     *
+     * You can add your own GraphQL queries and mutations to Payload, making use of all the types that Payload has defined for you.
+     *
+     * @see https://payloadcms.com/docs/access-control/overview
+     */
     graphQL?: {
-        mutations?: ((graphQL: typeof GraphQL, payload: Payload) => Record<string, unknown>);
-        queries?: ((graphQL: typeof GraphQL, payload: Payload) => Record<string, unknown>);
+        /**
+         * Function that returns an object containing keys to custom GraphQL mutations
+         *
+         * @see https://payloadcms.com/docs/access-control/overview
+         */
+        mutations?: (graphQL: typeof GraphQL, payload: Payload) => Record<string, unknown>;
+        /**
+        * Function that returns an object containing keys to custom GraphQL queries
+        *
+        * @see https://payloadcms.com/docs/access-control/overview
+        */
+        queries?: (graphQL: typeof GraphQL, payload: Payload) => Record<string, unknown>;
         maxComplexity?: number;
         disablePlaygroundInProduction?: boolean;
         disable?: boolean;
         schemaOutputFile?: string;
     };
+    /**
+     * Replace the built-in components with custom ones
+     */
     components?: {
         [key: string]: JSX.Element | (() => JSX.Element);
     };
+    /**
+     * Tap into Payload-wide hooks.
+     *
+     * @see https://payloadcms.com/docs/hooks/overview
+     */
     hooks?: {
         afterError?: AfterErrorHook;
     };
+    /**
+     * An array of Payload plugins.
+     *
+     * @see https://payloadcms.com/docs/plugins/overview
+     */
     plugins?: Plugin[];
+    /** Send anonymous telemetry data about general usage. */
     telemetry?: boolean;
+    /** A function that is called immediately following startup that receives the Payload instance as its only argument. */
     onInit?: (payload: Payload) => Promise<void> | void;
 };
 export declare type SanitizedConfig = Omit<DeepRequired<Config>, 'collections' | 'globals'> & {
@@ -225,5 +488,5 @@ export declare type SanitizedConfig = Omit<DeepRequired<Config>, 'collections' |
         [key: string]: string;
     };
 };
-export declare type EntityDescription = string | Record<string, string> | (() => string) | React.ComponentType<any>;
+export declare type EntityDescription = string | (() => string) | React.ComponentType<any>;
 export {};

package/dist/config/types.js

@@ -17,4 +17,4 @@ function hasTransportOptions(emailConfig) {
     return emailConfig.transportOptions !== undefined;
 }
 exports.hasTransportOptions = hasTransportOptions;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29uZmlnL3R5cGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQThDQTs7O0dBR0c7QUFDSCxTQUFnQixZQUFZLENBQUMsV0FBeUI7SUFDcEQsT0FBUSxXQUE4QixDQUFDLFNBQVMsS0FBSyxTQUFTLENBQUM7QUFDakUsQ0FBQztBQUZELG9DQUVDO0FBRUQ7OztHQUdHO0FBQ0gsU0FBZ0IsbUJBQW1CLENBQUMsV0FBeUI7SUFDM0QsT0FBUSxXQUFxQyxDQUFDLGdCQUFnQixLQUFLLFNBQVMsQ0FBQztBQUMvRSxDQUFDO0FBRkQsa0RBRUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29uZmlnL3R5cGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQXFEQTs7O0dBR0c7QUFDSCxTQUFnQixZQUFZLENBQzFCLFdBQXlCO0lBRXpCLE9BQVEsV0FBOEIsQ0FBQyxTQUFTLEtBQUssU0FBUyxDQUFDO0FBQ2pFLENBQUM7QUFKRCxvQ0FJQztBQUVEOzs7R0FHRztBQUNILFNBQWdCLG1CQUFtQixDQUNqQyxXQUF5QjtJQUV6QixPQUFRLFdBQXFDLENBQUMsZ0JBQWdCLEtBQUssU0FBUyxDQUFDO0FBQy9FLENBQUM7QUFKRCxrREFJQyJ9

package/dist/email/build.js

@@ -12,7 +12,7 @@ async function handleTransport(transport, email, logger) {
         await transport.verify();
     }
     catch (err) {
-        logger.error('There is an error with the email configuration you have provided.', err);
+        logger.error(`There is an error with the email configuration you have provided. ${err.message}`);
     }
     return { ...email, transport };
 }
@@ -54,4 +54,4 @@ async function buildEmail(emailConfig, logger) {
     return handleMockAccount(emailConfig, logger);
 }
 exports.default = buildEmail;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYnVpbGQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZW1haWwvYnVpbGQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSw0REFBcUQ7QUFFckQsMkNBQWtHO0FBQ2xHLHNDQUFpRDtBQUNqRCxnRUFBd0M7QUFHeEMsS0FBSyxVQUFVLGVBQWUsQ0FBQyxTQUFzQixFQUFFLEtBQXFCLEVBQUUsTUFBYztJQUMxRixJQUFJO1FBQ0YsTUFBTSxTQUFTLENBQUMsTUFBTSxFQUFFLENBQUM7S0FDMUI7SUFBQyxPQUFPLEdBQUcsRUFBRTtRQUNaLE1BQU0sQ0FBQyxLQUFLLENBQ1YsbUVBQW1FLEVBQ25FLEdBQUcsQ0FDSixDQUFDO0tBQ0g7SUFFRCxPQUFPLEVBQUUsR0FBRyxLQUFLLEVBQUUsU0FBUyxFQUFFLENBQUM7QUFDakMsQ0FBQztBQUVELE1BQU0sbUJBQW1CLEdBQUcsQ0FBQyxXQUFXLEVBQUUsRUFBRTtJQUMxQyxJQUFJLENBQUMsV0FBVyxDQUFDLFFBQVEsSUFBSSxDQUFDLFdBQVcsQ0FBQyxXQUFXLEVBQUU7UUFDckQsTUFBTSxJQUFJLDZCQUFvQixDQUFDLGdGQUFnRixDQUFDLENBQUM7S0FDbEg7QUFDSCxDQUFDLENBQUM7QUFFRixNQUFNLGlCQUFpQixHQUFHLEtBQUssRUFBRSxXQUF5QixFQUFFLE1BQWMsRUFBRSxFQUFFO0lBQzVFLElBQUksV0FBNkIsQ0FBQztJQUNsQyxJQUFJO1FBQ0YsV0FBVyxHQUFHLE1BQU0sSUFBQSxxQkFBVyxFQUFDLFdBQVcsQ0FBQyxDQUFDO1FBQzdDLE1BQU0sRUFBRSxPQUFPLEVBQUUsRUFBRSxHQUFHLEVBQUUsSUFBSSxFQUFFLElBQUksRUFBRSxFQUFFLEdBQUcsV0FBVyxDQUFDO1FBQ3JELElBQUksV0FBVyxDQUFDLGtCQUFrQixFQUFFO1lBQ2xDLE1BQU0sQ0FBQyxJQUFJLENBQUMsMkNBQTJDLENBQUMsQ0FBQztZQUN6RCxNQUFNLENBQUMsSUFBSSxDQUFDLG1DQUFtQyxHQUFHLEVBQUUsQ0FBQyxDQUFDO1lBQ3RELE1BQU0sQ0FBQyxJQUFJLENBQUMsZ0NBQWdDLElBQUksRUFBRSxDQUFDLENBQUM7WUFDcEQsTUFBTSxDQUFDLElBQUksQ0FBQyxnQ0FBZ0MsSUFBSSxFQUFFLENBQUMsQ0FBQztTQUNyRDtLQUNGO0lBQUMsT0FBTyxHQUFHLEVBQUU7UUFDWixNQUFNLENBQUMsS0FBSyxDQUFDLHVEQUF1RCxFQUFFLEdBQUcsQ0FBQyxDQUFDO0tBQzVFO0lBQ0QsT0FBTyxXQUFXLENBQUM7QUFDckIsQ0FBQyxDQUFDO0FBRWEsS0FBSyxVQUFVLFVBQVUsQ0FBQyxXQUF5QixFQUFFLE1BQWM7SUFDaEYsSUFBSSxJQUFBLG9CQUFZLEVBQUMsV0FBVyxDQUFDLElBQUksV0FBVyxDQUFDLFNBQVMsRUFBRTtRQUN0RCxtQkFBbUIsQ0FBQyxXQUFXLENBQUMsQ0FBQztRQUNqQyxNQUFNLEtBQUssR0FBRyxFQUFFLEdBQUcsV0FBVyxFQUFFLENBQUM7UUFDakMsTUFBTSxFQUFFLFNBQVMsRUFBRSxHQUE4QixXQUFXLENBQUM7UUFDN0QsT0FBTyxlQUFlLENBQUMsU0FBUyxFQUFFLEtBQUssRUFBRSxNQUFNLENBQUMsQ0FBQztLQUNsRDtJQUVELElBQUksSUFBQSwyQkFBbUIsRUFBQyxXQUFXLENBQUMsSUFBSSxXQUFXLENBQUMsZ0JBQWdCLEVBQUU7UUFDcEUsbUJBQW1CLENBQUMsV0FBVyxDQUFDLENBQUM7UUFDakMsTUFBTSxLQUFLLEdBQUcsRUFBRSxHQUFHLFdBQVcsRUFBb0IsQ0FBQztRQUNuRCxNQUFNLFNBQVMsR0FBRyxvQkFBVSxDQUFDLGVBQWUsQ0FBQyxXQUFXLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztRQUMzRSxPQUFPLGVBQWUsQ0FBQyxTQUFTLEVBQUUsS0FBSyxFQUFFLE1BQU0sQ0FBQyxDQUFDO0tBQ2xEO0lBRUQsT0FBTyxpQkFBaUIsQ0FBQyxXQUFXLEVBQUUsTUFBTSxDQUFDLENBQUM7QUFDaEQsQ0FBQztBQWhCRCw2QkFnQkMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYnVpbGQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvZW1haWwvYnVpbGQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSw0REFBcUQ7QUFFckQsMkNBQWtHO0FBQ2xHLHNDQUFpRDtBQUNqRCxnRUFBd0M7QUFHeEMsS0FBSyxVQUFVLGVBQWUsQ0FBQyxTQUFzQixFQUFFLEtBQXFCLEVBQUUsTUFBYztJQUMxRixJQUFJO1FBQ0YsTUFBTSxTQUFTLENBQUMsTUFBTSxFQUFFLENBQUM7S0FDMUI7SUFBQyxPQUFPLEdBQUcsRUFBRTtRQUNaLE1BQU0sQ0FBQyxLQUFLLENBQ1YscUVBQXFFLEdBQUcsQ0FBQyxPQUFPLEVBQUUsQ0FDbkYsQ0FBQztLQUNIO0lBRUQsT0FBTyxFQUFFLEdBQUcsS0FBSyxFQUFFLFNBQVMsRUFBRSxDQUFDO0FBQ2pDLENBQUM7QUFFRCxNQUFNLG1CQUFtQixHQUFHLENBQUMsV0FBVyxFQUFFLEVBQUU7SUFDMUMsSUFBSSxDQUFDLFdBQVcsQ0FBQyxRQUFRLElBQUksQ0FBQyxXQUFXLENBQUMsV0FBVyxFQUFFO1FBQ3JELE1BQU0sSUFBSSw2QkFBb0IsQ0FBQyxnRkFBZ0YsQ0FBQyxDQUFDO0tBQ2xIO0FBQ0gsQ0FBQyxDQUFDO0FBRUYsTUFBTSxpQkFBaUIsR0FBRyxLQUFLLEVBQUUsV0FBeUIsRUFBRSxNQUFjLEVBQUUsRUFBRTtJQUM1RSxJQUFJLFdBQTZCLENBQUM7SUFDbEMsSUFBSTtRQUNGLFdBQVcsR0FBRyxNQUFNLElBQUEscUJBQVcsRUFBQyxXQUFXLENBQUMsQ0FBQztRQUM3QyxNQUFNLEVBQUUsT0FBTyxFQUFFLEVBQUUsR0FBRyxFQUFFLElBQUksRUFBRSxJQUFJLEVBQUUsRUFBRSxHQUFHLFdBQVcsQ0FBQztRQUNyRCxJQUFJLFdBQVcsQ0FBQyxrQkFBa0IsRUFBRTtZQUNsQyxNQUFNLENBQUMsSUFBSSxDQUFDLDJDQUEyQyxDQUFDLENBQUM7WUFDekQsTUFBTSxDQUFDLElBQUksQ0FBQyxtQ0FBbUMsR0FBRyxFQUFFLENBQUMsQ0FBQztZQUN0RCxNQUFNLENBQUMsSUFBSSxDQUFDLGdDQUFnQyxJQUFJLEVBQUUsQ0FBQyxDQUFDO1lBQ3BELE1BQU0sQ0FBQyxJQUFJLENBQUMsZ0NBQWdDLElBQUksRUFBRSxDQUFDLENBQUM7U0FDckQ7S0FDRjtJQUFDLE9BQU8sR0FBRyxFQUFFO1FBQ1osTUFBTSxDQUFDLEtBQUssQ0FBQyx1REFBdUQsRUFBRSxHQUFHLENBQUMsQ0FBQztLQUM1RTtJQUNELE9BQU8sV0FBVyxDQUFDO0FBQ3JCLENBQUMsQ0FBQztBQUVhLEtBQUssVUFBVSxVQUFVLENBQUMsV0FBeUIsRUFBRSxNQUFjO0lBQ2hGLElBQUksSUFBQSxvQkFBWSxFQUFDLFdBQVcsQ0FBQyxJQUFJLFdBQVcsQ0FBQyxTQUFTLEVBQUU7UUFDdEQsbUJBQW1CLENBQUMsV0FBVyxDQUFDLENBQUM7UUFDakMsTUFBTSxLQUFLLEdBQUcsRUFBRSxHQUFHLFdBQVcsRUFBRSxDQUFDO1FBQ2pDLE1BQU0sRUFBRSxTQUFTLEVBQUUsR0FBOEIsV0FBVyxDQUFDO1FBQzdELE9BQU8sZUFBZSxDQUFDLFNBQVMsRUFBRSxLQUFLLEVBQUUsTUFBTSxDQUFDLENBQUM7S0FDbEQ7SUFFRCxJQUFJLElBQUEsMkJBQW1CLEVBQUMsV0FBVyxDQUFDLElBQUksV0FBVyxDQUFDLGdCQUFnQixFQUFFO1FBQ3BFLG1CQUFtQixDQUFDLFdBQVcsQ0FBQyxDQUFDO1FBQ2pDLE1BQU0sS0FBSyxHQUFHLEVBQUUsR0FBRyxXQUFXLEVBQW9CLENBQUM7UUFDbkQsTUFBTSxTQUFTLEdBQUcsb0JBQVUsQ0FBQyxlQUFlLENBQUMsV0FBVyxDQUFDLGdCQUFnQixDQUFDLENBQUM7UUFDM0UsT0FBTyxlQUFlLENBQUMsU0FBUyxFQUFFLEtBQUssRUFBRSxNQUFNLENBQUMsQ0FBQztLQUNsRDtJQUVELE9BQU8saUJBQWlCLENBQUMsV0FBVyxFQUFFLE1BQU0sQ0FBQyxDQUFDO0FBQ2hELENBQUM7QUFoQkQsNkJBZ0JDIn0=

package/dist/express/types.d.ts

@@ -8,20 +8,44 @@ import { Collection } from '../collections/config/types';
 import { User } from '../auth/types';
 import { Document } from '../types';
 import { TypeWithID } from '../globals/config/types';
-export declare type PayloadRequest<T = any> = Request & {
+/** Express request with some Payload related context added */
+export declare type PayloadRequest<U = any> = Request & {
+    /** The global payload object */
     payload: Payload;
+    /** Optimized document loader */
     payloadDataLoader: DataLoader<string, TypeWithID>;
+    /**
+     * The requested locale if specified
+     * Only available for localised collections
+     */
     locale?: string;
+    /** The locale that should be used for a field when it is not translated to the requested locale */
     fallbackLocale?: string;
+    /** Information about the collection that is being accessed
+     * - Configuration from payload-config.ts
+     * - Mongo model for this collection
+     * - GraphQL type metadata
+     * */
     collection?: Collection;
+    /** What triggered this request */
     payloadAPI: 'REST' | 'local' | 'graphQL';
+    /** Uploaded files */
     files?: {
+        /**
+         * This is the file that Payload will use for the file upload, other files are ignored.
+         *
+         */
         file: UploadedFile;
     };
+    /** I18next instance */
     i18n: Ii18n;
+    /** Get a translation for the admin screen */
     t: TFunction;
-    user: T & User | null;
+    /** The signed in user */
+    user: (U & User) | null;
+    /** Resized versions of the image that was uploaded during this request */
     payloadUploadSizes?: Record<string, Buffer>;
+    /** Cache of documents related to the current request */
     findByID?: {
         [slug: string]: (q: unknown) => Document;
     };

package/dist/fields/config/sanitize.spec.js

@@ -19,13 +19,13 @@ describe('sanitizeFields', () => {
             (0, sanitize_1.default)(fields, []);
         }).toThrow(errors_1.MissingFieldType);
     });
-    it("should throw on invalid field name", () => {
+    it('should throw on invalid field name', () => {
         const fields = [
             {
-                label: "some.collection",
-                name: "some.collection",
-                type: "text",
-            }
+                label: 'some.collection',
+                name: 'some.collection',
+                type: 'text',
+            },
         ];
         expect(() => {
             (0, sanitize_1.default)(fields, []);

package/dist/fields/config/types.d.ts

@@ -39,14 +39,14 @@ export declare type FieldAccess<T extends TypeWithID = any, P = any, U = any> =
     doc?: T;
 }) => Promise<boolean> | boolean;
 export declare type Condition<T extends TypeWithID = any, P = any> = (data: Partial<T>, siblingData: Partial<P>) => boolean;
-export declare type FilterOptionsProps = {
+export declare type FilterOptionsProps<T = any> = {
     id: string | number;
     user: Partial<User>;
-    data: unknown;
+    data: T;
     siblingData: unknown;
     relationTo: string | string[];
 };
-export declare type FilterOptions = Where | ((options: FilterOptionsProps) => Where);
+export declare type FilterOptions<T = any> = Where | ((options: FilterOptionsProps<T>) => Where);
 declare type Admin = {
     position?: 'sidebar';
     width?: string;