payload 3.0.0-beta.13 → 3.0.0-beta.131

package/dist/collections/config/reservedFieldNames.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/collections/config/reservedFieldNames.spec.ts"],"sourcesContent":["import type { Config } from '../../config/types.js'\nimport type { CollectionConfig, Field } from '../../index.js'\n\nimport { ReservedFieldName } from '../../errors/index.js'\nimport { sanitizeCollection } from './sanitize.js'\n\ndescribe('reservedFieldNames - collections -', () => {\n  const config = {\n    collections: [],\n    globals: [],\n  } as Partial<Config>\n\n  describe('uploads -', () => {\n    const collectionWithUploads: CollectionConfig = {\n      slug: 'collection-with-uploads',\n      fields: [],\n      upload: true,\n    }\n\n    it('should throw on file', async () => {\n      const fields: Field[] = [\n        {\n          name: 'file',\n          type: 'text',\n          label: 'some-collection',\n        },\n      ]\n      await expect(async () => {\n        await sanitizeCollection(\n          // @ts-expect-error\n          {\n            ...config,\n            collections: [\n              {\n                ...collectionWithUploads,\n                fields,\n              },\n            ],\n          },\n          {\n            ...collectionWithUploads,\n            fields,\n          },\n        )\n      }).rejects.toThrow(ReservedFieldName)\n    })\n\n    it('should not throw on a custom field', async () => {\n      const fields: Field[] = [\n        {\n          name: 'customField',\n          type: 'text',\n          label: 'some-collection',\n        },\n      ]\n      await expect(async () => {\n        await sanitizeCollection(\n          // @ts-expect-error\n          {\n            ...config,\n            collections: [\n              {\n                ...collectionWithUploads,\n                fields,\n              },\n            ],\n          },\n          {\n            ...collectionWithUploads,\n            fields,\n          },\n        )\n      }).not.toThrow()\n    })\n  })\n\n  describe('auth -', () => {\n    const collectionWithAuth: CollectionConfig = {\n      slug: 'collection-with-auth',\n      auth: {\n        loginWithUsername: true,\n        useAPIKey: true,\n        verify: true,\n      },\n      fields: [],\n    }\n\n    it('should throw on hash', async () => {\n      const fields: Field[] = [\n        {\n          name: 'hash',\n          type: 'text',\n          label: 'some-collection',\n        },\n      ]\n      await expect(async () => {\n        await sanitizeCollection(\n          // @ts-expect-error\n          {\n            ...config,\n            collections: [\n              {\n                ...collectionWithAuth,\n                fields,\n              },\n            ],\n          },\n          {\n            ...collectionWithAuth,\n            fields,\n          },\n        )\n      }).rejects.toThrow(ReservedFieldName)\n    })\n\n    it('should throw on salt', async () => {\n      const fields: Field[] = [\n        {\n          name: 'salt',\n          type: 'text',\n          label: 'some-collection',\n        },\n      ]\n      await expect(async () => {\n        await sanitizeCollection(\n          // @ts-expect-error\n          {\n            ...config,\n            collections: [\n              {\n                ...collectionWithAuth,\n                fields,\n              },\n            ],\n          },\n          {\n            ...collectionWithAuth,\n            fields,\n          },\n        )\n      }).rejects.toThrow(ReservedFieldName)\n    })\n\n    it('should not throw on a custom field', async () => {\n      const fields: Field[] = [\n        {\n          name: 'customField',\n          type: 'text',\n          label: 'some-collection',\n        },\n      ]\n      await expect(async () => {\n        await sanitizeCollection(\n          // @ts-expect-error\n          {\n            ...config,\n            collections: [\n              {\n                ...collectionWithAuth,\n                fields,\n              },\n            ],\n          },\n          {\n            ...collectionWithAuth,\n            fields,\n          },\n        )\n      }).not.toThrow()\n    })\n  })\n})\n"],"names":["ReservedFieldName","sanitizeCollection","describe","config","collections","globals","collectionWithUploads","slug","fields","upload","it","name","type","label","expect","rejects","toThrow","not","collectionWithAuth","auth","loginWithUsername","useAPIKey","verify"],"mappings":"AAGA,SAASA,iBAAiB,QAAQ,wBAAuB;AACzD,SAASC,kBAAkB,QAAQ,gBAAe;AAElDC,SAAS,sCAAsC;IAC7C,MAAMC,SAAS;QACbC,aAAa,EAAE;QACfC,SAAS,EAAE;IACb;IAEAH,SAAS,aAAa;QACpB,MAAMI,wBAA0C;YAC9CC,MAAM;YACNC,QAAQ,EAAE;YACVC,QAAQ;QACV;QAEAC,GAAG,wBAAwB;YACzB,MAAMF,SAAkB;gBACtB;oBACEG,MAAM;oBACNC,MAAM;oBACNC,OAAO;gBACT;aACD;YACD,MAAMC,OAAO;gBACX,MAAMb,mBACJ,mBAAmB;gBACnB;oBACE,GAAGE,MAAM;oBACTC,aAAa;wBACX;4BACE,GAAGE,qBAAqB;4BACxBE;wBACF;qBACD;gBACH,GACA;oBACE,GAAGF,qBAAqB;oBACxBE;gBACF;YAEJ,GAAGO,OAAO,CAACC,OAAO,CAAChB;QACrB;QAEAU,GAAG,sCAAsC;YACvC,MAAMF,SAAkB;gBACtB;oBACEG,MAAM;oBACNC,MAAM;oBACNC,OAAO;gBACT;aACD;YACD,MAAMC,OAAO;gBACX,MAAMb,mBACJ,mBAAmB;gBACnB;oBACE,GAAGE,MAAM;oBACTC,aAAa;wBACX;4BACE,GAAGE,qBAAqB;4BACxBE;wBACF;qBACD;gBACH,GACA;oBACE,GAAGF,qBAAqB;oBACxBE;gBACF;YAEJ,GAAGS,GAAG,CAACD,OAAO;QAChB;IACF;IAEAd,SAAS,UAAU;QACjB,MAAMgB,qBAAuC;YAC3CX,MAAM;YACNY,MAAM;gBACJC,mBAAmB;gBACnBC,WAAW;gBACXC,QAAQ;YACV;YACAd,QAAQ,EAAE;QACZ;QAEAE,GAAG,wBAAwB;YACzB,MAAMF,SAAkB;gBACtB;oBACEG,MAAM;oBACNC,MAAM;oBACNC,OAAO;gBACT;aACD;YACD,MAAMC,OAAO;gBACX,MAAMb,mBACJ,mBAAmB;gBACnB;oBACE,GAAGE,MAAM;oBACTC,aAAa;wBACX;4BACE,GAAGc,kBAAkB;4BACrBV;wBACF;qBACD;gBACH,GACA;oBACE,GAAGU,kBAAkB;oBACrBV;gBACF;YAEJ,GAAGO,OAAO,CAACC,OAAO,CAAChB;QACrB;QAEAU,GAAG,wBAAwB;YACzB,MAAMF,SAAkB;gBACtB;oBACEG,MAAM;oBACNC,MAAM;oBACNC,OAAO;gBACT;aACD;YACD,MAAMC,OAAO;gBACX,MAAMb,mBACJ,mBAAmB;gBACnB;oBACE,GAAGE,MAAM;oBACTC,aAAa;wBACX;4BACE,GAAGc,kBAAkB;4BACrBV;wBACF;qBACD;gBACH,GACA;oBACE,GAAGU,kBAAkB;oBACrBV;gBACF;YAEJ,GAAGO,OAAO,CAACC,OAAO,CAAChB;QACrB;QAEAU,GAAG,sCAAsC;YACvC,MAAMF,SAAkB;gBACtB;oBACEG,MAAM;oBACNC,MAAM;oBACNC,OAAO;gBACT;aACD;YACD,MAAMC,OAAO;gBACX,MAAMb,mBACJ,mBAAmB;gBACnB;oBACE,GAAGE,MAAM;oBACTC,aAAa;wBACX;4BACE,GAAGc,kBAAkB;4BACrBV;wBACF;qBACD;gBACH,GACA;oBACE,GAAGU,kBAAkB;oBACrBV;gBACF;YAEJ,GAAGS,GAAG,CAACD,OAAO;QAChB;IACF;AACF"}

package/dist/collections/config/sanitize.d.ts

@@ -1,5 +1,4 @@
-import type { Config } from '../../config/types.js';
+import type { Config, SanitizedConfig } from '../../config/types.js';
 import type { CollectionConfig, SanitizedCollectionConfig } from './types.js';
-declare const sanitizeCollection: (config: Config, collection: CollectionConfig) => SanitizedCollectionConfig;
-export default sanitizeCollection;
+export declare const sanitizeCollection: (config: Config, collection: CollectionConfig, richTextSanitizationPromises?: Array<(config: SanitizedConfig) => Promise<void>>) => Promise<SanitizedCollectionConfig>;
 //# sourceMappingURL=sanitize.d.ts.map

package/dist/collections/config/sanitize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sanitize.d.ts","sourceRoot":"","sources":["../../../src/collections/config/sanitize.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,KAAK,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAA;AAgB7E,QAAA,MAAM,kBAAkB,WACd,MAAM,cACF,gBAAgB,KAC3B,yBA0IF,CAAA;AAED,eAAe,kBAAkB,CAAA"}
+{"version":3,"file":"sanitize.d.ts","sourceRoot":"","sources":["../../../src/collections/config/sanitize.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,yBAAyB,EAAkB,MAAM,YAAY,CAAA;AAgB7F,eAAO,MAAM,kBAAkB,WACrB,MAAM,cACF,gBAAgB,iCAKG,KAAK,CAAC,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,KAC/E,OAAO,CAAC,yBAAyB,CAkLnC,CAAA"}

package/dist/collections/config/sanitize.js

@@ -1,23 +1,38 @@
-import merge from 'deepmerge';
-import baseAccountLockFields from '../../auth/baseFields/accountLock.js';
-import baseAPIKeyFields from '../../auth/baseFields/apiKey.js';
-import baseAuthFields from '../../auth/baseFields/auth.js';
-import baseVerificationFields from '../../auth/baseFields/verification.js';
-import TimestampsRequired from '../../errors/TimestampsRequired.js';
+import { getBaseAuthFields } from '../../auth/getAuthFields.js';
+import { TimestampsRequired } from '../../errors/TimestampsRequired.js';
 import { sanitizeFields } from '../../fields/config/sanitize.js';
 import { fieldAffectsData } from '../../fields/config/types.js';
 import mergeBaseFields from '../../fields/mergeBaseFields.js';
 import { getBaseUploadFields } from '../../uploads/getBaseFields.js';
+import { deepMergeWithReactComponents } from '../../utilities/deepMerge.js';
 import { formatLabels } from '../../utilities/formatLabels.js';
-import { isPlainObject } from '../../utilities/isPlainObject.js';
 import baseVersionFields from '../../versions/baseFields.js';
-import { authDefaults, defaults } from './defaults.js';
-const sanitizeCollection = (config, collection)=>{
+import { versionDefaults } from '../../versions/defaults.js';
+import { authDefaults, defaults, loginWithUsernameDefaults } from './defaults.js';
+import { sanitizeAuthFields, sanitizeUploadFields } from './reservedFieldNames.js';
+import { validateUseAsTitle } from './useAsTitle.js';
+export const sanitizeCollection = async (config, collection, /**
+   * If this property is set, RichText fields won't be sanitized immediately. Instead, they will be added to this array as promises
+   * so that you can sanitize them together, after the config has been sanitized.
+   */ richTextSanitizationPromises)=>{
     // /////////////////////////////////
     // Make copy of collection config
     // /////////////////////////////////
-    const sanitized = merge(defaults, collection, {
-        isMergeableObject: isPlainObject
+    const sanitized = deepMergeWithReactComponents(defaults, collection);
+    // /////////////////////////////////
+    // Sanitize fields
+    // /////////////////////////////////
+    const validRelationships = config.collections.map((c)=>c.slug) || [];
+    const joins = {};
+    sanitized.fields = await sanitizeFields({
+        collectionConfig: sanitized,
+        config,
+        fields: sanitized.fields,
+        joinPath: '',
+        joins,
+        parentIsLocalized: false,
+        richTextSanitizationPromises,
+        validRelationships
     });
     if (sanitized.timestamps !== false) {
         // add default timestamps fields only as needed
@@ -25,8 +40,12 @@ const sanitizeCollection = (config, collection)=>{
         let hasCreatedAt = null;
         sanitized.fields.some((field)=>{
             if (fieldAffectsData(field)) {
-                if (field.name === 'updatedAt') hasUpdatedAt = true;
-                if (field.name === 'createdAt') hasCreatedAt = true;
+                if (field.name === 'updatedAt') {
+                    hasUpdatedAt = true;
+                }
+                if (field.name === 'createdAt') {
+                    hasCreatedAt = true;
+                }
             }
             return hasCreatedAt && hasUpdatedAt;
         });
@@ -38,6 +57,7 @@ const sanitizeCollection = (config, collection)=>{
                     disableBulkEdit: true,
                     hidden: true
                 },
+                index: true,
                 label: ({ t })=>t('general:updatedAt')
             });
         }
@@ -57,30 +77,41 @@ const sanitizeCollection = (config, collection)=>{
     }
     sanitized.labels = sanitized.labels || formatLabels(sanitized.slug);
     if (sanitized.versions) {
-        if (sanitized.versions === true) sanitized.versions = {
-            drafts: false
-        };
+        if (sanitized.versions === true) {
+            sanitized.versions = {
+                drafts: false,
+                maxPerDoc: 100
+            };
+        }
         if (sanitized.timestamps === false) {
             throw new TimestampsRequired(collection);
         }
+        sanitized.versions.maxPerDoc = typeof sanitized.versions.maxPerDoc === 'number' ? sanitized.versions.maxPerDoc : 100;
         if (sanitized.versions.drafts) {
             if (sanitized.versions.drafts === true) {
                 sanitized.versions.drafts = {
-                    autosave: false
+                    autosave: false,
+                    validate: false
                 };
             }
             if (sanitized.versions.drafts.autosave === true) {
                 sanitized.versions.drafts.autosave = {
-                    interval: 2000
+                    interval: versionDefaults.autosaveInterval
                 };
             }
+            if (sanitized.versions.drafts.validate === undefined) {
+                sanitized.versions.drafts.validate = false;
+            }
             sanitized.fields = mergeBaseFields(sanitized.fields, baseVersionFields);
         }
     }
     if (sanitized.upload) {
-        if (sanitized.upload === true) sanitized.upload = {};
-        // disable duplicate for uploads by default
-        sanitized.disableDuplicate = sanitized.disableDuplicate || true;
+        if (sanitized.upload === true) {
+            sanitized.upload = {};
+        }
+        // sanitize fields for reserved names
+        sanitizeUploadFields(sanitized.fields, sanitized);
+        sanitized.upload.bulkUpload = sanitized.upload?.bulkUpload ?? true;
         sanitized.upload.staticDir = sanitized.upload.staticDir || sanitized.slug;
         sanitized.admin.useAsTitle = sanitized.admin.useAsTitle && sanitized.admin.useAsTitle !== 'id' ? sanitized.admin.useAsTitle : 'filename';
         const uploadFields = getBaseUploadFields({
@@ -90,41 +121,43 @@ const sanitizeCollection = (config, collection)=>{
         sanitized.fields = mergeBaseFields(sanitized.fields, uploadFields);
     }
     if (sanitized.auth) {
-        sanitized.auth = merge(authDefaults, typeof sanitized.auth === 'object' ? sanitized.auth : {}, {
-            isMergeableObject: isPlainObject
-        });
-        let authFields = [];
-        if (sanitized.auth.useAPIKey) {
-            authFields = authFields.concat(baseAPIKeyFields);
-        }
-        if (!sanitized.auth.disableLocalStrategy) {
-            authFields = authFields.concat(baseAuthFields);
-            if (sanitized.auth.verify) {
-                if (sanitized.auth.verify === true) sanitized.auth.verify = {};
-                authFields = authFields.concat(baseVerificationFields);
-            }
-            if (sanitized.auth.maxLoginAttempts > 0) {
-                authFields = authFields.concat(baseAccountLockFields);
-            }
+        // sanitize fields for reserved names
+        sanitizeAuthFields(sanitized.fields, sanitized);
+        sanitized.auth = deepMergeWithReactComponents(authDefaults, typeof sanitized.auth === 'object' ? sanitized.auth : {});
+        if (!sanitized.auth.disableLocalStrategy && sanitized.auth.verify === true) {
+            sanitized.auth.verify = {};
         }
         // disable duplicate for auth enabled collections by default
-        sanitized.disableDuplicate = sanitized.disableDuplicate || true;
+        sanitized.disableDuplicate = sanitized.disableDuplicate ?? true;
         if (!sanitized.auth.strategies) {
             sanitized.auth.strategies = [];
         }
-        sanitized.fields = mergeBaseFields(sanitized.fields, authFields);
+        if (sanitized.auth.loginWithUsername) {
+            if (sanitized.auth.loginWithUsername === true) {
+                sanitized.auth.loginWithUsername = loginWithUsernameDefaults;
+            } else {
+                const loginWithUsernameWithDefaults = {
+                    ...loginWithUsernameDefaults,
+                    ...sanitized.auth.loginWithUsername
+                };
+                // if allowEmailLogin is false, requireUsername must be true
+                if (loginWithUsernameWithDefaults.allowEmailLogin === false) {
+                    loginWithUsernameWithDefaults.requireUsername = true;
+                }
+                sanitized.auth.loginWithUsername = loginWithUsernameWithDefaults;
+            }
+        } else {
+            sanitized.auth.loginWithUsername = false;
+        }
+        sanitized.fields = mergeBaseFields(sanitized.fields, getBaseAuthFields(sanitized.auth));
     }
-    // /////////////////////////////////
-    // Sanitize fields
-    // /////////////////////////////////
-    const validRelationships = config.collections.map((c)=>c.slug) || [];
-    sanitized.fields = sanitizeFields({
-        config,
-        fields: sanitized.fields,
-        validRelationships
-    });
-    return sanitized;
+    if (collection?.admin?.pagination?.limits?.length) {
+        sanitized.admin.pagination.limits = collection.admin.pagination.limits;
+    }
+    validateUseAsTitle(sanitized);
+    const sanitizedConfig = sanitized;
+    sanitizedConfig.joins = joins;
+    return sanitizedConfig;
 };
-export default sanitizeCollection;
 
 //# sourceMappingURL=sanitize.js.map

package/dist/collections/config/sanitize.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/collections/config/sanitize.ts"],"sourcesContent":["import merge from 'deepmerge'\n\nimport type { Config } from '../../config/types.js'\nimport type { CollectionConfig, SanitizedCollectionConfig } from './types.js'\n\nimport baseAccountLockFields from '../../auth/baseFields/accountLock.js'\nimport baseAPIKeyFields from '../../auth/baseFields/apiKey.js'\nimport baseAuthFields from '../../auth/baseFields/auth.js'\nimport baseVerificationFields from '../../auth/baseFields/verification.js'\nimport TimestampsRequired from '../../errors/TimestampsRequired.js'\nimport { sanitizeFields } from '../../fields/config/sanitize.js'\nimport { fieldAffectsData } from '../../fields/config/types.js'\nimport mergeBaseFields from '../../fields/mergeBaseFields.js'\nimport { getBaseUploadFields } from '../../uploads/getBaseFields.js'\nimport { formatLabels } from '../../utilities/formatLabels.js'\nimport { isPlainObject } from '../../utilities/isPlainObject.js'\nimport baseVersionFields from '../../versions/baseFields.js'\nimport { authDefaults, defaults } from './defaults.js'\n\nconst sanitizeCollection = (\n  config: Config,\n  collection: CollectionConfig,\n): SanitizedCollectionConfig => {\n  // /////////////////////////////////\n  // Make copy of collection config\n  // /////////////////////////////////\n\n  const sanitized: CollectionConfig = merge(defaults, collection, {\n    isMergeableObject: isPlainObject,\n  })\n\n  if (sanitized.timestamps !== false) {\n    // add default timestamps fields only as needed\n    let hasUpdatedAt = null\n    let hasCreatedAt = null\n    sanitized.fields.some((field) => {\n      if (fieldAffectsData(field)) {\n        if (field.name === 'updatedAt') hasUpdatedAt = true\n        if (field.name === 'createdAt') hasCreatedAt = true\n      }\n      return hasCreatedAt && hasUpdatedAt\n    })\n    if (!hasUpdatedAt) {\n      sanitized.fields.push({\n        name: 'updatedAt',\n        type: 'date',\n        admin: {\n          disableBulkEdit: true,\n          hidden: true,\n        },\n        label: ({ t }) => t('general:updatedAt'),\n      })\n    }\n    if (!hasCreatedAt) {\n      sanitized.fields.push({\n        name: 'createdAt',\n        admin: {\n          disableBulkEdit: true,\n          hidden: true,\n        },\n        // The default sort for list view is createdAt. Thus, enabling indexing by default, is a major performance improvement, especially for large or a large amount of collections.\n        type: 'date',\n        index: true,\n        label: ({ t }) => t('general:createdAt'),\n      })\n    }\n  }\n\n  sanitized.labels = sanitized.labels || formatLabels(sanitized.slug)\n\n  if (sanitized.versions) {\n    if (sanitized.versions === true) sanitized.versions = { drafts: false }\n\n    if (sanitized.timestamps === false) {\n      throw new TimestampsRequired(collection)\n    }\n\n    if (sanitized.versions.drafts) {\n      if (sanitized.versions.drafts === true) {\n        sanitized.versions.drafts = {\n          autosave: false,\n        }\n      }\n\n      if (sanitized.versions.drafts.autosave === true) {\n        sanitized.versions.drafts.autosave = {\n          interval: 2000,\n        }\n      }\n\n      sanitized.fields = mergeBaseFields(sanitized.fields, baseVersionFields)\n    }\n  }\n\n  if (sanitized.upload) {\n    if (sanitized.upload === true) sanitized.upload = {}\n\n    // disable duplicate for uploads by default\n    sanitized.disableDuplicate = sanitized.disableDuplicate || true\n\n    sanitized.upload.staticDir = sanitized.upload.staticDir || sanitized.slug\n    sanitized.admin.useAsTitle =\n      sanitized.admin.useAsTitle && sanitized.admin.useAsTitle !== 'id'\n        ? sanitized.admin.useAsTitle\n        : 'filename'\n\n    const uploadFields = getBaseUploadFields({\n      collection: sanitized,\n      config,\n    })\n\n    sanitized.fields = mergeBaseFields(sanitized.fields, uploadFields)\n  }\n\n  if (sanitized.auth) {\n    sanitized.auth = merge(authDefaults, typeof sanitized.auth === 'object' ? sanitized.auth : {}, {\n      isMergeableObject: isPlainObject,\n    })\n\n    let authFields = []\n\n    if (sanitized.auth.useAPIKey) {\n      authFields = authFields.concat(baseAPIKeyFields)\n    }\n\n    if (!sanitized.auth.disableLocalStrategy) {\n      authFields = authFields.concat(baseAuthFields)\n\n      if (sanitized.auth.verify) {\n        if (sanitized.auth.verify === true) sanitized.auth.verify = {}\n        authFields = authFields.concat(baseVerificationFields)\n      }\n\n      if (sanitized.auth.maxLoginAttempts > 0) {\n        authFields = authFields.concat(baseAccountLockFields)\n      }\n    }\n\n    // disable duplicate for auth enabled collections by default\n    sanitized.disableDuplicate = sanitized.disableDuplicate || true\n\n    if (!sanitized.auth.strategies) {\n      sanitized.auth.strategies = []\n    }\n\n    sanitized.fields = mergeBaseFields(sanitized.fields, authFields)\n  }\n\n  // /////////////////////////////////\n  // Sanitize fields\n  // /////////////////////////////////\n\n  const validRelationships = config.collections.map((c) => c.slug) || []\n  sanitized.fields = sanitizeFields({\n    config,\n    fields: sanitized.fields,\n    validRelationships,\n  })\n\n  return sanitized as SanitizedCollectionConfig\n}\n\nexport default sanitizeCollection\n"],"names":["merge","baseAccountLockFields","baseAPIKeyFields","baseAuthFields","baseVerificationFields","TimestampsRequired","sanitizeFields","fieldAffectsData","mergeBaseFields","getBaseUploadFields","formatLabels","isPlainObject","baseVersionFields","authDefaults","defaults","sanitizeCollection","config","collection","sanitized","isMergeableObject","timestamps","hasUpdatedAt","hasCreatedAt","fields","some","field","name","push","type","admin","disableBulkEdit","hidden","label","t","index","labels","slug","versions","drafts","autosave","interval","upload","disableDuplicate","staticDir","useAsTitle","uploadFields","auth","authFields","useAPIKey","concat","disableLocalStrategy","verify","maxLoginAttempts","strategies","validRelationships","collections","map","c"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,OAAOA,WAAW,YAAW;AAK7B,OAAOC,2BAA2B,uCAAsC;AACxE,OAAOC,sBAAsB,kCAAiC;AAC9D,OAAOC,oBAAoB,gCAA+B;AAC1D,OAAOC,4BAA4B,wCAAuC;AAC1E,OAAOC,wBAAwB,qCAAoC;AACnE,SAASC,cAAc,QAAQ,kCAAiC;AAChE,SAASC,gBAAgB,QAAQ,+BAA8B;AAC/D,OAAOC,qBAAqB,kCAAiC;AAC7D,SAASC,mBAAmB,QAAQ,iCAAgC;AACpE,SAASC,YAAY,QAAQ,kCAAiC;AAC9D,SAASC,aAAa,QAAQ,mCAAkC;AAChE,OAAOC,uBAAuB,+BAA8B;AAC5D,SAASC,YAAY,EAAEC,QAAQ,QAAQ,gBAAe;AAEtD,MAAMC,qBAAqB,CACzBC,QACAC;IAEA,oCAAoC;IACpC,iCAAiC;IACjC,oCAAoC;IAEpC,MAAMC,YAA8BlB,MAAMc,UAAUG,YAAY;QAC9DE,mBAAmBR;IACrB;IAEA,IAAIO,UAAUE,UAAU,KAAK,OAAO;QAClC,+CAA+C;QAC/C,IAAIC,eAAe;QACnB,IAAIC,eAAe;QACnBJ,UAAUK,MAAM,CAACC,IAAI,CAAC,CAACC;YACrB,IAAIlB,iBAAiBkB,QAAQ;gBAC3B,IAAIA,MAAMC,IAAI,KAAK,aAAaL,eAAe;gBAC/C,IAAII,MAAMC,IAAI,KAAK,aAAaJ,eAAe;YACjD;YACA,OAAOA,gBAAgBD;QACzB;QACA,IAAI,CAACA,cAAc;YACjBH,UAAUK,MAAM,CAACI,IAAI,CAAC;gBACpBD,MAAM;gBACNE,MAAM;gBACNC,OAAO;oBACLC,iBAAiB;oBACjBC,QAAQ;gBACV;gBACAC,OAAO,CAAC,EAAEC,CAAC,EAAE,GAAKA,EAAE;YACtB;QACF;QACA,IAAI,CAACX,cAAc;YACjBJ,UAAUK,MAAM,CAACI,IAAI,CAAC;gBACpBD,MAAM;gBACNG,OAAO;oBACLC,iBAAiB;oBACjBC,QAAQ;gBACV;gBACA,8KAA8K;gBAC9KH,MAAM;gBACNM,OAAO;gBACPF,OAAO,CAAC,EAAEC,CAAC,EAAE,GAAKA,EAAE;YACtB;QACF;IACF;IAEAf,UAAUiB,MAAM,GAAGjB,UAAUiB,MAAM,IAAIzB,aAAaQ,UAAUkB,IAAI;IAElE,IAAIlB,UAAUmB,QAAQ,EAAE;QACtB,IAAInB,UAAUmB,QAAQ,KAAK,MAAMnB,UAAUmB,QAAQ,GAAG;YAAEC,QAAQ;QAAM;QAEtE,IAAIpB,UAAUE,UAAU,KAAK,OAAO;YAClC,MAAM,IAAIf,mBAAmBY;QAC/B;QAEA,IAAIC,UAAUmB,QAAQ,CAACC,MAAM,EAAE;YAC7B,IAAIpB,UAAUmB,QAAQ,CAACC,MAAM,KAAK,MAAM;gBACtCpB,UAAUmB,QAAQ,CAACC,MAAM,GAAG;oBAC1BC,UAAU;gBACZ;YACF;YAEA,IAAIrB,UAAUmB,QAAQ,CAACC,MAAM,CAACC,QAAQ,KAAK,MAAM;gBAC/CrB,UAAUmB,QAAQ,CAACC,MAAM,CAACC,QAAQ,GAAG;oBACnCC,UAAU;gBACZ;YACF;YAEAtB,UAAUK,MAAM,GAAGf,gBAAgBU,UAAUK,MAAM,EAAEX;QACvD;IACF;IAEA,IAAIM,UAAUuB,MAAM,EAAE;QACpB,IAAIvB,UAAUuB,MAAM,KAAK,MAAMvB,UAAUuB,MAAM,GAAG,CAAC;QAEnD,2CAA2C;QAC3CvB,UAAUwB,gBAAgB,GAAGxB,UAAUwB,gBAAgB,IAAI;QAE3DxB,UAAUuB,MAAM,CAACE,SAAS,GAAGzB,UAAUuB,MAAM,CAACE,SAAS,IAAIzB,UAAUkB,IAAI;QACzElB,UAAUW,KAAK,CAACe,UAAU,GACxB1B,UAAUW,KAAK,CAACe,UAAU,IAAI1B,UAAUW,KAAK,CAACe,UAAU,KAAK,OACzD1B,UAAUW,KAAK,CAACe,UAAU,GAC1B;QAEN,MAAMC,eAAepC,oBAAoB;YACvCQ,YAAYC;YACZF;QACF;QAEAE,UAAUK,MAAM,GAAGf,gBAAgBU,UAAUK,MAAM,EAAEsB;IACvD;IAEA,IAAI3B,UAAU4B,IAAI,EAAE;QAClB5B,UAAU4B,IAAI,GAAG9C,MAAMa,cAAc,OAAOK,UAAU4B,IAAI,KAAK,WAAW5B,UAAU4B,IAAI,GAAG,CAAC,GAAG;YAC7F3B,mBAAmBR;QACrB;QAEA,IAAIoC,aAAa,EAAE;QAEnB,IAAI7B,UAAU4B,IAAI,CAACE,SAAS,EAAE;YAC5BD,aAAaA,WAAWE,MAAM,CAAC/C;QACjC;QAEA,IAAI,CAACgB,UAAU4B,IAAI,CAACI,oBAAoB,EAAE;YACxCH,aAAaA,WAAWE,MAAM,CAAC9C;YAE/B,IAAIe,UAAU4B,IAAI,CAACK,MAAM,EAAE;gBACzB,IAAIjC,UAAU4B,IAAI,CAACK,MAAM,KAAK,MAAMjC,UAAU4B,IAAI,CAACK,MAAM,GAAG,CAAC;gBAC7DJ,aAAaA,WAAWE,MAAM,CAAC7C;YACjC;YAEA,IAAIc,UAAU4B,IAAI,CAACM,gBAAgB,GAAG,GAAG;gBACvCL,aAAaA,WAAWE,MAAM,CAAChD;YACjC;QACF;QAEA,4DAA4D;QAC5DiB,UAAUwB,gBAAgB,GAAGxB,UAAUwB,gBAAgB,IAAI;QAE3D,IAAI,CAACxB,UAAU4B,IAAI,CAACO,UAAU,EAAE;YAC9BnC,UAAU4B,IAAI,CAACO,UAAU,GAAG,EAAE;QAChC;QAEAnC,UAAUK,MAAM,GAAGf,gBAAgBU,UAAUK,MAAM,EAAEwB;IACvD;IAEA,oCAAoC;IACpC,kBAAkB;IAClB,oCAAoC;IAEpC,MAAMO,qBAAqBtC,OAAOuC,WAAW,CAACC,GAAG,CAAC,CAACC,IAAMA,EAAErB,IAAI,KAAK,EAAE;IACtElB,UAAUK,MAAM,GAAGjB,eAAe;QAChCU;QACAO,QAAQL,UAAUK,MAAM;QACxB+B;IACF;IAEA,OAAOpC;AACT;AAEA,eAAeH,mBAAkB"}
+{"version":3,"sources":["../../../src/collections/config/sanitize.ts"],"sourcesContent":["import type { LoginWithUsernameOptions } from '../../auth/types.js'\nimport type { Config, SanitizedConfig } from '../../config/types.js'\nimport type { CollectionConfig, SanitizedCollectionConfig, SanitizedJoins } from './types.js'\n\nimport { getBaseAuthFields } from '../../auth/getAuthFields.js'\nimport { TimestampsRequired } from '../../errors/TimestampsRequired.js'\nimport { sanitizeFields } from '../../fields/config/sanitize.js'\nimport { fieldAffectsData } from '../../fields/config/types.js'\nimport mergeBaseFields from '../../fields/mergeBaseFields.js'\nimport { getBaseUploadFields } from '../../uploads/getBaseFields.js'\nimport { deepMergeWithReactComponents } from '../../utilities/deepMerge.js'\nimport { formatLabels } from '../../utilities/formatLabels.js'\nimport baseVersionFields from '../../versions/baseFields.js'\nimport { versionDefaults } from '../../versions/defaults.js'\nimport { authDefaults, defaults, loginWithUsernameDefaults } from './defaults.js'\nimport { sanitizeAuthFields, sanitizeUploadFields } from './reservedFieldNames.js'\nimport { validateUseAsTitle } from './useAsTitle.js'\n\nexport const sanitizeCollection = async (\n  config: Config,\n  collection: CollectionConfig,\n  /**\n   * If this property is set, RichText fields won't be sanitized immediately. Instead, they will be added to this array as promises\n   * so that you can sanitize them together, after the config has been sanitized.\n   */\n  richTextSanitizationPromises?: Array<(config: SanitizedConfig) => Promise<void>>,\n): Promise<SanitizedCollectionConfig> => {\n  // /////////////////////////////////\n  // Make copy of collection config\n  // /////////////////////////////////\n\n  const sanitized: CollectionConfig = deepMergeWithReactComponents(defaults, collection)\n\n  // /////////////////////////////////\n  // Sanitize fields\n  // /////////////////////////////////\n\n  const validRelationships = config.collections.map((c) => c.slug) || []\n  const joins: SanitizedJoins = {}\n  sanitized.fields = await sanitizeFields({\n    collectionConfig: sanitized,\n    config,\n    fields: sanitized.fields,\n    joinPath: '',\n    joins,\n    parentIsLocalized: false,\n    richTextSanitizationPromises,\n    validRelationships,\n  })\n\n  if (sanitized.timestamps !== false) {\n    // add default timestamps fields only as needed\n    let hasUpdatedAt = null\n    let hasCreatedAt = null\n    sanitized.fields.some((field) => {\n      if (fieldAffectsData(field)) {\n        if (field.name === 'updatedAt') {\n          hasUpdatedAt = true\n        }\n        if (field.name === 'createdAt') {\n          hasCreatedAt = true\n        }\n      }\n      return hasCreatedAt && hasUpdatedAt\n    })\n    if (!hasUpdatedAt) {\n      sanitized.fields.push({\n        name: 'updatedAt',\n        type: 'date',\n        admin: {\n          disableBulkEdit: true,\n          hidden: true,\n        },\n        index: true,\n        label: ({ t }) => t('general:updatedAt'),\n      })\n    }\n    if (!hasCreatedAt) {\n      sanitized.fields.push({\n        name: 'createdAt',\n        admin: {\n          disableBulkEdit: true,\n          hidden: true,\n        },\n        // The default sort for list view is createdAt. Thus, enabling indexing by default, is a major performance improvement, especially for large or a large amount of collections.\n        type: 'date',\n        index: true,\n        label: ({ t }) => t('general:createdAt'),\n      })\n    }\n  }\n\n  sanitized.labels = sanitized.labels || formatLabels(sanitized.slug)\n\n  if (sanitized.versions) {\n    if (sanitized.versions === true) {\n      sanitized.versions = { drafts: false, maxPerDoc: 100 }\n    }\n\n    if (sanitized.timestamps === false) {\n      throw new TimestampsRequired(collection)\n    }\n\n    sanitized.versions.maxPerDoc =\n      typeof sanitized.versions.maxPerDoc === 'number' ? sanitized.versions.maxPerDoc : 100\n\n    if (sanitized.versions.drafts) {\n      if (sanitized.versions.drafts === true) {\n        sanitized.versions.drafts = {\n          autosave: false,\n          validate: false,\n        }\n      }\n\n      if (sanitized.versions.drafts.autosave === true) {\n        sanitized.versions.drafts.autosave = {\n          interval: versionDefaults.autosaveInterval,\n        }\n      }\n\n      if (sanitized.versions.drafts.validate === undefined) {\n        sanitized.versions.drafts.validate = false\n      }\n\n      sanitized.fields = mergeBaseFields(sanitized.fields, baseVersionFields)\n    }\n  }\n\n  if (sanitized.upload) {\n    if (sanitized.upload === true) {\n      sanitized.upload = {}\n    }\n\n    // sanitize fields for reserved names\n    sanitizeUploadFields(sanitized.fields, sanitized)\n\n    sanitized.upload.bulkUpload = sanitized.upload?.bulkUpload ?? true\n    sanitized.upload.staticDir = sanitized.upload.staticDir || sanitized.slug\n    sanitized.admin.useAsTitle =\n      sanitized.admin.useAsTitle && sanitized.admin.useAsTitle !== 'id'\n        ? sanitized.admin.useAsTitle\n        : 'filename'\n\n    const uploadFields = getBaseUploadFields({\n      collection: sanitized,\n      config,\n    })\n\n    sanitized.fields = mergeBaseFields(sanitized.fields, uploadFields)\n  }\n\n  if (sanitized.auth) {\n    // sanitize fields for reserved names\n    sanitizeAuthFields(sanitized.fields, sanitized)\n\n    sanitized.auth = deepMergeWithReactComponents(\n      authDefaults,\n      typeof sanitized.auth === 'object' ? sanitized.auth : {},\n    )\n\n    if (!sanitized.auth.disableLocalStrategy && sanitized.auth.verify === true) {\n      sanitized.auth.verify = {}\n    }\n\n    // disable duplicate for auth enabled collections by default\n    sanitized.disableDuplicate = sanitized.disableDuplicate ?? true\n\n    if (!sanitized.auth.strategies) {\n      sanitized.auth.strategies = []\n    }\n\n    if (sanitized.auth.loginWithUsername) {\n      if (sanitized.auth.loginWithUsername === true) {\n        sanitized.auth.loginWithUsername = loginWithUsernameDefaults\n      } else {\n        const loginWithUsernameWithDefaults = {\n          ...loginWithUsernameDefaults,\n          ...sanitized.auth.loginWithUsername,\n        } as LoginWithUsernameOptions\n\n        // if allowEmailLogin is false, requireUsername must be true\n        if (loginWithUsernameWithDefaults.allowEmailLogin === false) {\n          loginWithUsernameWithDefaults.requireUsername = true\n        }\n        sanitized.auth.loginWithUsername = loginWithUsernameWithDefaults\n      }\n    } else {\n      sanitized.auth.loginWithUsername = false\n    }\n\n    sanitized.fields = mergeBaseFields(sanitized.fields, getBaseAuthFields(sanitized.auth))\n  }\n\n  if (collection?.admin?.pagination?.limits?.length) {\n    sanitized.admin.pagination.limits = collection.admin.pagination.limits\n  }\n\n  validateUseAsTitle(sanitized)\n\n  const sanitizedConfig = sanitized as SanitizedCollectionConfig\n\n  sanitizedConfig.joins = joins\n\n  return sanitizedConfig\n}\n"],"names":["getBaseAuthFields","TimestampsRequired","sanitizeFields","fieldAffectsData","mergeBaseFields","getBaseUploadFields","deepMergeWithReactComponents","formatLabels","baseVersionFields","versionDefaults","authDefaults","defaults","loginWithUsernameDefaults","sanitizeAuthFields","sanitizeUploadFields","validateUseAsTitle","sanitizeCollection","config","collection","richTextSanitizationPromises","sanitized","validRelationships","collections","map","c","slug","joins","fields","collectionConfig","joinPath","parentIsLocalized","timestamps","hasUpdatedAt","hasCreatedAt","some","field","name","push","type","admin","disableBulkEdit","hidden","index","label","t","labels","versions","drafts","maxPerDoc","autosave","validate","interval","autosaveInterval","undefined","upload","bulkUpload","staticDir","useAsTitle","uploadFields","auth","disableLocalStrategy","verify","disableDuplicate","strategies","loginWithUsername","loginWithUsernameWithDefaults","allowEmailLogin","requireUsername","pagination","limits","length","sanitizedConfig"],"mappings":"AAIA,SAASA,iBAAiB,QAAQ,8BAA6B;AAC/D,SAASC,kBAAkB,QAAQ,qCAAoC;AACvE,SAASC,cAAc,QAAQ,kCAAiC;AAChE,SAASC,gBAAgB,QAAQ,+BAA8B;AAC/D,OAAOC,qBAAqB,kCAAiC;AAC7D,SAASC,mBAAmB,QAAQ,iCAAgC;AACpE,SAASC,4BAA4B,QAAQ,+BAA8B;AAC3E,SAASC,YAAY,QAAQ,kCAAiC;AAC9D,OAAOC,uBAAuB,+BAA8B;AAC5D,SAASC,eAAe,QAAQ,6BAA4B;AAC5D,SAASC,YAAY,EAAEC,QAAQ,EAAEC,yBAAyB,QAAQ,gBAAe;AACjF,SAASC,kBAAkB,EAAEC,oBAAoB,QAAQ,0BAAyB;AAClF,SAASC,kBAAkB,QAAQ,kBAAiB;AAEpD,OAAO,MAAMC,qBAAqB,OAChCC,QACAC,YACA;;;GAGC,GACDC;IAEA,oCAAoC;IACpC,iCAAiC;IACjC,oCAAoC;IAEpC,MAAMC,YAA8Bd,6BAA6BK,UAAUO;IAE3E,oCAAoC;IACpC,kBAAkB;IAClB,oCAAoC;IAEpC,MAAMG,qBAAqBJ,OAAOK,WAAW,CAACC,GAAG,CAAC,CAACC,IAAMA,EAAEC,IAAI,KAAK,EAAE;IACtE,MAAMC,QAAwB,CAAC;IAC/BN,UAAUO,MAAM,GAAG,MAAMzB,eAAe;QACtC0B,kBAAkBR;QAClBH;QACAU,QAAQP,UAAUO,MAAM;QACxBE,UAAU;QACVH;QACAI,mBAAmB;QACnBX;QACAE;IACF;IAEA,IAAID,UAAUW,UAAU,KAAK,OAAO;QAClC,+CAA+C;QAC/C,IAAIC,eAAe;QACnB,IAAIC,eAAe;QACnBb,UAAUO,MAAM,CAACO,IAAI,CAAC,CAACC;YACrB,IAAIhC,iBAAiBgC,QAAQ;gBAC3B,IAAIA,MAAMC,IAAI,KAAK,aAAa;oBAC9BJ,eAAe;gBACjB;gBACA,IAAIG,MAAMC,IAAI,KAAK,aAAa;oBAC9BH,eAAe;gBACjB;YACF;YACA,OAAOA,gBAAgBD;QACzB;QACA,IAAI,CAACA,cAAc;YACjBZ,UAAUO,MAAM,CAACU,IAAI,CAAC;gBACpBD,MAAM;gBACNE,MAAM;gBACNC,OAAO;oBACLC,iBAAiB;oBACjBC,QAAQ;gBACV;gBACAC,OAAO;gBACPC,OAAO,CAAC,EAAEC,CAAC,EAAE,GAAKA,EAAE;YACtB;QACF;QACA,IAAI,CAACX,cAAc;YACjBb,UAAUO,MAAM,CAACU,IAAI,CAAC;gBACpBD,MAAM;gBACNG,OAAO;oBACLC,iBAAiB;oBACjBC,QAAQ;gBACV;gBACA,8KAA8K;gBAC9KH,MAAM;gBACNI,OAAO;gBACPC,OAAO,CAAC,EAAEC,CAAC,EAAE,GAAKA,EAAE;YACtB;QACF;IACF;IAEAxB,UAAUyB,MAAM,GAAGzB,UAAUyB,MAAM,IAAItC,aAAaa,UAAUK,IAAI;IAElE,IAAIL,UAAU0B,QAAQ,EAAE;QACtB,IAAI1B,UAAU0B,QAAQ,KAAK,MAAM;YAC/B1B,UAAU0B,QAAQ,GAAG;gBAAEC,QAAQ;gBAAOC,WAAW;YAAI;QACvD;QAEA,IAAI5B,UAAUW,UAAU,KAAK,OAAO;YAClC,MAAM,IAAI9B,mBAAmBiB;QAC/B;QAEAE,UAAU0B,QAAQ,CAACE,SAAS,GAC1B,OAAO5B,UAAU0B,QAAQ,CAACE,SAAS,KAAK,WAAW5B,UAAU0B,QAAQ,CAACE,SAAS,GAAG;QAEpF,IAAI5B,UAAU0B,QAAQ,CAACC,MAAM,EAAE;YAC7B,IAAI3B,UAAU0B,QAAQ,CAACC,MAAM,KAAK,MAAM;gBACtC3B,UAAU0B,QAAQ,CAACC,MAAM,GAAG;oBAC1BE,UAAU;oBACVC,UAAU;gBACZ;YACF;YAEA,IAAI9B,UAAU0B,QAAQ,CAACC,MAAM,CAACE,QAAQ,KAAK,MAAM;gBAC/C7B,UAAU0B,QAAQ,CAACC,MAAM,CAACE,QAAQ,GAAG;oBACnCE,UAAU1C,gBAAgB2C,gBAAgB;gBAC5C;YACF;YAEA,IAAIhC,UAAU0B,QAAQ,CAACC,MAAM,CAACG,QAAQ,KAAKG,WAAW;gBACpDjC,UAAU0B,QAAQ,CAACC,MAAM,CAACG,QAAQ,GAAG;YACvC;YAEA9B,UAAUO,MAAM,GAAGvB,gBAAgBgB,UAAUO,MAAM,EAAEnB;QACvD;IACF;IAEA,IAAIY,UAAUkC,MAAM,EAAE;QACpB,IAAIlC,UAAUkC,MAAM,KAAK,MAAM;YAC7BlC,UAAUkC,MAAM,GAAG,CAAC;QACtB;QAEA,qCAAqC;QACrCxC,qBAAqBM,UAAUO,MAAM,EAAEP;QAEvCA,UAAUkC,MAAM,CAACC,UAAU,GAAGnC,UAAUkC,MAAM,EAAEC,cAAc;QAC9DnC,UAAUkC,MAAM,CAACE,SAAS,GAAGpC,UAAUkC,MAAM,CAACE,SAAS,IAAIpC,UAAUK,IAAI;QACzEL,UAAUmB,KAAK,CAACkB,UAAU,GACxBrC,UAAUmB,KAAK,CAACkB,UAAU,IAAIrC,UAAUmB,KAAK,CAACkB,UAAU,KAAK,OACzDrC,UAAUmB,KAAK,CAACkB,UAAU,GAC1B;QAEN,MAAMC,eAAerD,oBAAoB;YACvCa,YAAYE;YACZH;QACF;QAEAG,UAAUO,MAAM,GAAGvB,gBAAgBgB,UAAUO,MAAM,EAAE+B;IACvD;IAEA,IAAItC,UAAUuC,IAAI,EAAE;QAClB,qCAAqC;QACrC9C,mBAAmBO,UAAUO,MAAM,EAAEP;QAErCA,UAAUuC,IAAI,GAAGrD,6BACfI,cACA,OAAOU,UAAUuC,IAAI,KAAK,WAAWvC,UAAUuC,IAAI,GAAG,CAAC;QAGzD,IAAI,CAACvC,UAAUuC,IAAI,CAACC,oBAAoB,IAAIxC,UAAUuC,IAAI,CAACE,MAAM,KAAK,MAAM;YAC1EzC,UAAUuC,IAAI,CAACE,MAAM,GAAG,CAAC;QAC3B;QAEA,4DAA4D;QAC5DzC,UAAU0C,gBAAgB,GAAG1C,UAAU0C,gBAAgB,IAAI;QAE3D,IAAI,CAAC1C,UAAUuC,IAAI,CAACI,UAAU,EAAE;YAC9B3C,UAAUuC,IAAI,CAACI,UAAU,GAAG,EAAE;QAChC;QAEA,IAAI3C,UAAUuC,IAAI,CAACK,iBAAiB,EAAE;YACpC,IAAI5C,UAAUuC,IAAI,CAACK,iBAAiB,KAAK,MAAM;gBAC7C5C,UAAUuC,IAAI,CAACK,iBAAiB,GAAGpD;YACrC,OAAO;gBACL,MAAMqD,gCAAgC;oBACpC,GAAGrD,yBAAyB;oBAC5B,GAAGQ,UAAUuC,IAAI,CAACK,iBAAiB;gBACrC;gBAEA,4DAA4D;gBAC5D,IAAIC,8BAA8BC,eAAe,KAAK,OAAO;oBAC3DD,8BAA8BE,eAAe,GAAG;gBAClD;gBACA/C,UAAUuC,IAAI,CAACK,iBAAiB,GAAGC;YACrC;QACF,OAAO;YACL7C,UAAUuC,IAAI,CAACK,iBAAiB,GAAG;QACrC;QAEA5C,UAAUO,MAAM,GAAGvB,gBAAgBgB,UAAUO,MAAM,EAAE3B,kBAAkBoB,UAAUuC,IAAI;IACvF;IAEA,IAAIzC,YAAYqB,OAAO6B,YAAYC,QAAQC,QAAQ;QACjDlD,UAAUmB,KAAK,CAAC6B,UAAU,CAACC,MAAM,GAAGnD,WAAWqB,KAAK,CAAC6B,UAAU,CAACC,MAAM;IACxE;IAEAtD,mBAAmBK;IAEnB,MAAMmD,kBAAkBnD;IAExBmD,gBAAgB7C,KAAK,GAAGA;IAExB,OAAO6C;AACT,EAAC"}

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

@@ -1,15 +1,23 @@
 import type { GraphQLInputObjectType, GraphQLNonNull, GraphQLObjectType } from 'graphql';
-import type { DeepRequired } from 'ts-essentials';
-import type { CustomPreviewButton, CustomPublishButton, CustomSaveButton, CustomSaveDraftButton } from '../../admin/types.js';
+import type { DeepRequired, IsAny, MarkOptional } from 'ts-essentials';
+import type { CustomPreviewButton, CustomPublishButton, CustomSaveButton, CustomSaveDraftButton, CustomUpload } from '../../admin/types.js';
+import type { Arguments as MeArguments } from '../../auth/operations/me.js';
+import type { Arguments as RefreshArguments, Result as RefreshResult } from '../../auth/operations/refresh.js';
 import type { Auth, ClientUser, IncomingAuthType } from '../../auth/types.js';
-import type { Access, CustomComponent, EditConfig, Endpoint, EntityDescription, GeneratePreviewURL, LabelFunction, LivePreviewConfig } from '../../config/types.js';
-import type { Field } from '../../fields/config/types.js';
-import type { GeneratedTypes } from '../../index.js';
-import type { PayloadRequest, RequestContext } from '../../types/index.js';
+import type { Access, AfterErrorHookArgs, AfterErrorResult, CustomComponent, EditConfig, Endpoint, EntityDescription, EntityDescriptionComponent, GeneratePreviewURL, LabelFunction, LivePreviewConfig, MetaConfig, PayloadComponent, StaticLabel } from '../../config/types.js';
+import type { DBIdentifierName } from '../../database/types.js';
+import type { Field, JoinField, RelationshipField, UploadField } from '../../fields/config/types.js';
+import type { CollectionSlug, JsonObject, RequestContext, TypedAuthOperations, TypedCollection, TypedCollectionSelect, TypedLocale } from '../../index.js';
+import type { PayloadRequest, SelectType, Sort, TransformCollectionWithSelect, Where } from '../../types/index.js';
 import type { SanitizedUploadConfig, UploadConfig } from '../../uploads/types.js';
 import type { IncomingCollectionVersions, SanitizedCollectionVersions } from '../../versions/types.js';
 import type { AfterOperationArg, AfterOperationMap } from '../operations/utils.js';
-export type HookOperationType = 'autosave' | 'count' | 'create' | 'delete' | 'forgotPassword' | 'login' | 'read' | 'refresh' | 'update';
+export type DataFromCollectionSlug<TSlug extends CollectionSlug> = TypedCollection[TSlug];
+export type SelectFromCollectionSlug<TSlug extends CollectionSlug> = TypedCollectionSelect[TSlug];
+export type AuthOperationsFromCollectionSlug<TSlug extends CollectionSlug> = TypedAuthOperations[TSlug];
+export type RequiredDataFromCollection<TData extends JsonObject> = MarkOptional<TData, 'createdAt' | 'id' | 'sizes' | 'updatedAt'>;
+export type RequiredDataFromCollectionSlug<TSlug extends CollectionSlug> = RequiredDataFromCollection<DataFromCollectionSlug<TSlug>>;
+export type HookOperationType = 'autosave' | 'count' | 'countVersions' | 'create' | 'delete' | 'forgotPassword' | 'login' | 'read' | 'refresh' | 'update';
 type CreateOrUpdateOperation = Extract<HookOperationType, 'create' | 'update'>;
 export type BeforeOperationHook = (args: {
     args?: any;
@@ -104,13 +112,7 @@ export type AfterDeleteHook<T extends TypeWithID = any> = (args: {
     id: number | string;
     req: PayloadRequest;
 }) => any;
-export type AfterOperationHook<T extends TypeWithID = any> = (arg: AfterOperationArg<T>) => Promise<ReturnType<AfterOperationMap<T>[keyof AfterOperationMap<T>]>>;
-export type AfterErrorHook = (err: Error, res: unknown, context: RequestContext, 
-/** The collection which this hook is being run on. This is null if the AfterError hook was be added to the payload-wide config */
-collection: SanitizedCollectionConfig | null) => {
-    response: any;
-    status: number;
-} | void;
+export type AfterOperationHook<TOperationGeneric extends CollectionSlug = string> = (arg: AfterOperationArg<TOperationGeneric>) => Awaited<ReturnType<AfterOperationMap<TOperationGeneric>[keyof AfterOperationMap<TOperationGeneric>]>> | Promise<Awaited<ReturnType<AfterOperationMap<TOperationGeneric>[keyof AfterOperationMap<TOperationGeneric>]>>>;
 export type BeforeLoginHook<T extends TypeWithID = any> = (args: {
     /** The collection which this hook is being run on */
     collection: SanitizedCollectionConfig;
@@ -139,6 +141,20 @@ export type AfterMeHook<T extends TypeWithID = any> = (args: {
     req: PayloadRequest;
     response: unknown;
 }) => any;
+export type RefreshHook<T extends TypeWithID = any> = (args: {
+    args: RefreshArguments;
+    user: T;
+}) => Promise<RefreshResult | void> | (RefreshResult | void);
+export type MeHook<T extends TypeWithID = any> = (args: {
+    args: MeArguments;
+    user: T;
+}) => ({
+    exp: number;
+    user: T;
+} | void) | Promise<{
+    exp: number;
+    user: T;
+} | void>;
 export type AfterRefreshHook<T extends TypeWithID = any> = (args: {
     /** The collection which this hook is being run on */
     collection: SanitizedCollectionConfig;
@@ -147,21 +163,33 @@ export type AfterRefreshHook<T extends TypeWithID = any> = (args: {
     req: PayloadRequest;
     token: string;
 }) => any;
+export type AfterErrorHook = (args: {
+    collection: SanitizedCollectionConfig;
+} & AfterErrorHookArgs) => AfterErrorResult | Promise<AfterErrorResult>;
 export type AfterForgotPasswordHook = (args: {
     args?: any;
     /** The collection which this hook is being run on */
     collection: SanitizedCollectionConfig;
     context: RequestContext;
 }) => any;
+export type BaseListFilter = (args: {
+    limit: number;
+    locale?: TypedLocale;
+    page: number;
+    req: PayloadRequest;
+    sort: string;
+}) => null | Promise<null | Where> | Where;
 export type CollectionAdminOptions = {
+    baseListFilter?: BaseListFilter;
     /**
      * Custom admin components
      */
     components?: {
-        AfterList?: CustomComponent[];
-        AfterListTable?: CustomComponent[];
-        BeforeList?: CustomComponent[];
-        BeforeListTable?: CustomComponent[];
+        afterList?: CustomComponent[];
+        afterListTable?: CustomComponent[];
+        beforeList?: CustomComponent[];
+        beforeListTable?: CustomComponent[];
+        Description?: EntityDescriptionComponent;
         /**
          * Components within the edit view
          */
@@ -186,17 +214,22 @@ export type CollectionAdminOptions = {
              * + autosave must be disabled
              */
             SaveDraftButton?: CustomSaveDraftButton;
+            /**
+             * Replaces the "Upload" section
+             * + upload must be enabled
+             */
+            Upload?: CustomUpload;
         };
         views?: {
             /**
-             * Set to a React component to replace the entire "Edit" view, including all nested routes.
+             * Set to a React component to replace the entire Edit View, including all nested routes.
              * Set to an object to replace or modify individual nested routes, or to add new ones.
              */
-            Edit?: EditConfig;
-            List?: {
-                Component?: React.ComponentType<any>;
+            edit?: EditConfig;
+            list?: {
                 actions?: CustomComponent[];
-            } | React.ComponentType<any>;
+                Component?: PayloadComponent;
+            };
         };
     };
     /** Extension point to add your custom data. Available in server and client. */
@@ -233,6 +266,7 @@ export type CollectionAdminOptions = {
      * Live preview options
      */
     livePreview?: LivePreviewConfig;
+    meta?: MetaConfig;
     pagination?: {
         defaultLimit?: number;
         limits?: number[];
@@ -242,19 +276,19 @@ export type CollectionAdminOptions = {
      */
     preview?: GeneratePreviewURL;
     /**
-     * Field to use as title in Edit view and first column in List view
+     * Field to use as title in Edit View and first column in List view
      */
     useAsTitle?: string;
 };
 /** Manage all aspects of a data collection */
-export type CollectionConfig = {
+export type CollectionConfig<TSlug extends CollectionSlug = any> = {
     /**
      * Access control
      */
     access?: {
         admin?: ({ req }: {
             req: PayloadRequest;
-        }) => Promise<boolean> | boolean;
+        }) => boolean | Promise<boolean>;
         create?: Access;
         delete?: Access;
         read?: Access;
@@ -271,13 +305,19 @@ export type CollectionConfig = {
      *
      * Use `true` to enable with default options
      */
-    auth?: IncomingAuthType | boolean;
+    auth?: boolean | IncomingAuthType;
     /** Extension point to add your custom data. Server only. */
     custom?: Record<string, any>;
+    /**
+     * Used to override the default naming of the database table or collection with your using a function or string
+     * @WARNING: If you change this property with existing data, you will need to handle the renaming of the table in your database or by using migrations
+     */
+    dbName?: DBIdentifierName;
+    defaultPopulate?: IsAny<SelectFromCollectionSlug<TSlug>> extends true ? SelectType : SelectFromCollectionSlug<TSlug>;
     /**
      * Default field to sort by in collection list view
      */
-    defaultSort?: string;
+    defaultSort?: Sort;
     /**
      * When true, do not show the "Duplicate" button while editing documents within this collection and prevent `duplicate` from all APIs
      */
@@ -285,7 +325,7 @@ export type CollectionConfig = {
     /**
      * Custom rest api endpoints, set false to disable all rest endpoints for this collection.
      */
-    endpoints?: Omit<Endpoint, 'root'>[] | false;
+    endpoints?: false | Omit<Endpoint, 'root'>[];
     fields: Field[];
     /**
      * GraphQL configuration
@@ -300,12 +340,12 @@ export type CollectionConfig = {
     hooks?: {
         afterChange?: AfterChangeHook[];
         afterDelete?: AfterDeleteHook[];
-        afterError?: AfterErrorHook;
+        afterError?: AfterErrorHook[];
         afterForgotPassword?: AfterForgotPasswordHook[];
         afterLogin?: AfterLoginHook[];
         afterLogout?: AfterLogoutHook[];
         afterMe?: AfterMeHook[];
-        afterOperation?: AfterOperationHook[];
+        afterOperation?: AfterOperationHook<TSlug>[];
         afterRead?: AfterReadHook[];
         afterRefresh?: AfterRefreshHook[];
         beforeChange?: BeforeChangeHook[];
@@ -314,14 +354,34 @@ export type CollectionConfig = {
         beforeOperation?: BeforeOperationHook[];
         beforeRead?: BeforeReadHook[];
         beforeValidate?: BeforeValidateHook[];
+        /**
+        /**
+         * Use the `me` hook to control the `me` operation.
+         * Here, you can optionally instruct the me operation to return early,
+         * and skip its default logic.
+         */
+        me?: MeHook[];
+        /**
+         * Use the `refresh` hook to control the refresh operation.
+         * Here, you can optionally instruct the refresh operation to return early,
+         * and skip its default logic.
+         */
+        refresh?: RefreshHook[];
     };
     /**
      * Label configuration
      */
     labels?: {
-        plural?: LabelFunction | Record<string, string> | string;
-        singular?: LabelFunction | Record<string, string> | string;
+        plural?: LabelFunction | StaticLabel;
+        singular?: LabelFunction | StaticLabel;
     };
+    /**
+     * Enables / Disables the ability to lock documents while editing
+     * @default true
+     */
+    lockDocuments?: {
+        duration: number;
+    } | false;
     slug: string;
     /**
      * Add `createdAt` and `updatedAt` fields
@@ -343,18 +403,39 @@ export type CollectionConfig = {
      *
      * @default false // disable uploads
      */
-    upload?: UploadConfig | boolean;
+    upload?: boolean | UploadConfig;
     /**
-     * Customize the handling of incoming file uploads
+     * Enable versioning. Set it to true to enable default versions settings,
+     * or customize versions options by setting the property equal to an object
+     * containing the version options.
      *
      * @default false // disable versioning
      */
-    versions?: IncomingCollectionVersions | boolean;
+    versions?: boolean | IncomingCollectionVersions;
+};
+export type SanitizedJoin = {
+    /**
+     * The field configuration defining the join
+     */
+    field: JoinField;
+    /**
+     * The path of the join field in dot notation
+     */
+    joinPath: string;
+    targetField: RelationshipField | UploadField;
+};
+export type SanitizedJoins = {
+    [collectionSlug: string]: SanitizedJoin[];
 };
-export interface SanitizedCollectionConfig extends Omit<DeepRequired<CollectionConfig>, 'auth' | 'endpoints' | 'fields' | 'upload' | 'versions'> {
+export interface SanitizedCollectionConfig extends Omit<DeepRequired<CollectionConfig>, 'auth' | 'endpoints' | 'fields' | 'slug' | 'upload' | 'versions'> {
     auth: Auth;
     endpoints: Endpoint[] | false;
     fields: Field[];
+    slug: CollectionSlug;
+    /**
+     * Object of collections to join 'Join Fields object keyed by collection
+     */
+    joins: SanitizedJoins;
     upload: SanitizedUploadConfig;
     versions: SanitizedCollectionVersions;
 }
@@ -362,8 +443,8 @@ export type Collection = {
     config: SanitizedCollectionConfig;
     customIDType?: 'number' | 'text';
     graphQL?: {
-        JWT: GraphQLObjectType;
         countType: GraphQLObjectType;
+        JWT: GraphQLObjectType;
         mutationInputType: GraphQLNonNull<any>;
         paginatedType: GraphQLObjectType;
         type: GraphQLObjectType;
@@ -372,10 +453,10 @@ export type Collection = {
         whereInputType: GraphQLInputObjectType;
     };
 };
-export type BulkOperationResult<TSlug extends keyof GeneratedTypes['collections']> = {
-    docs: GeneratedTypes['collections'][TSlug][];
+export type BulkOperationResult<TSlug extends CollectionSlug, TSelect extends SelectType> = {
+    docs: TransformCollectionWithSelect<TSlug, TSelect>[];
     errors: {
-        id: GeneratedTypes['collections'][TSlug]['id'];
+        id: DataFromCollectionSlug<TSlug>['id'];
         message: string;
     }[];
 };
@@ -383,6 +464,7 @@ export type AuthCollection = {
     config: SanitizedCollectionConfig;
 };
 export type TypeWithID = {
+    docId?: any;
     id: number | string;
 };
 export type TypeWithTimestamps = {