payload 4.0.0-internal.cd69eef → 4.0.0-internal.ce66a41

package/dist/index.js

@@ -1,13 +1,13 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */ import { spawn } from 'child_process';
-import crypto from 'crypto';
 import { fileURLToPath } from 'node:url';
 import path from 'path';
-import WebSocket from 'ws';
+import { getRegisteredDevReloadStrategy } from './admin/adapters/devReload.js';
 import { forgotPasswordLocal } from './auth/operations/local/forgotPassword.js';
 import { loginLocal } from './auth/operations/local/login.js';
 import { resetPasswordLocal } from './auth/operations/local/resetPassword.js';
 import { unlockLocal } from './auth/operations/local/unlock.js';
 import { verifyEmailLocal } from './auth/operations/local/verifyEmail.js';
+export { getRegisteredDevReloadStrategy, registerDevReloadStrategy } from './admin/adapters/devReload.js';
 import { countLocal } from './collections/operations/local/count.js';
 import { createLocal } from './collections/operations/local/create.js';
 import { deleteLocal } from './collections/operations/local/delete.js';
@@ -26,17 +26,13 @@ import { findGlobalVersionsLocal } from './globals/operations/local/findVersions
 import { restoreGlobalVersionLocal } from './globals/operations/local/restoreVersion.js';
 import { updateGlobalLocal } from './globals/operations/local/update.js';
 export { EntityType } from './admin/views/dashboard.js';
-/**
- * Export of all base fields that could potentially be
- * useful as users wish to extend built-in fields with custom logic
- */ export { accountLockFields as baseAccountLockFields } from './auth/baseFields/accountLock.js';
 import { Cron } from 'croner';
-import { decrypt, encrypt } from './auth/crypto.js';
+import { buildEncryptionKeyring, decrypt, encrypt, reencrypt } from './auth/crypto.js';
 import { authLocal } from './auth/operations/local/auth.js';
 import { APIKeyAuthentication } from './auth/strategies/apiKey.js';
 import { JWTAuthentication } from './auth/strategies/jwt.js';
-import { generateImportMap } from './bin/generateImportMap/index.js';
 import { checkPayloadDependencies } from './checkPayloadDependencies.js';
+import { generateImportMap } from './cli/commands/generateImportMap/generateImportMap.js';
 import { countVersionsLocal } from './collections/operations/local/countVersions.js';
 import { consoleEmailAdapter } from './email/consoleEmailAdapter.js';
 import { fieldAffectsData } from './fields/config/types.js';
@@ -45,8 +41,13 @@ import { _internal_jobSystemGlobals } from './queues/utilities/getCurrentDate.js
 import { formatAdminURL } from './utilities/formatAdminURL.js';
 import { isNextBuild } from './utilities/isNextBuild.js';
 import { getLogger } from './utilities/logger.js';
+import { defaultNextJsDevReloadStrategy } from './utilities/nextJsDevReloadStrategy.js';
 import { serverInit as serverInitTelemetry } from './utilities/telemetry/events/serverInit.js';
 import { traverseFields } from './utilities/traverseFields.js';
+/**
+ * Export of all base fields that could potentially be
+ * useful as users wish to extend built-in fields with custom logic
+ */ export { accountLockFields as baseAccountLockFields } from './auth/baseFields/accountLock.js';
 export { createAPIKeyFields } from './auth/baseFields/apiKey.js';
 export { baseAuthFields } from './auth/baseFields/auth.js';
 export { emailFieldConfig as baseEmailField } from './auth/baseFields/email.js';
@@ -60,7 +61,6 @@ export { extractAccessFromPermission } from './auth/extractAccessFromPermission.
 export { getAccessResults } from './auth/getAccessResults.js';
 export { getFieldsToSign } from './auth/getFieldsToSign.js';
 export { getLoginOptions } from './auth/getLoginOptions.js';
-export * from './auth/index.js';
 const filename = fileURLToPath(import.meta.url);
 const dirname = path.dirname(filename);
 let checkedDependencies = false;
@@ -126,6 +126,7 @@ let checkedDependencies = false;
     // TODO: re-implement or remove?
     // errorHandler: ErrorHandler
     encrypt = encrypt;
+    encryptionKeyring;
     extensions;
     /**
    * @description Find documents with criteria
@@ -202,6 +203,7 @@ let checkedDependencies = false;
     login = async (options)=>{
         return loginLocal(this, options);
     };
+    reencrypt = reencrypt;
     resetPassword = async (options)=>{
         return resetPasswordLocal(this, options);
     };
@@ -253,13 +255,13 @@ let checkedDependencies = false;
                     if (typeof this.config.jobs.shouldAutoRun === 'function') {
                         const shouldAutoRun = await this.config.jobs.shouldAutoRun(this);
                         if (!shouldAutoRun) {
-                            jobAutorunCron.stop();
                             return;
                         }
                     }
                     await this.jobs.run({
                         allQueues: cronConfig.allQueues,
                         limit: cronConfig.limit ?? DEFAULT_LIMIT,
+                        overrideAccess: true,
                         queue: cronConfig.queue,
                         silent: cronConfig.silent
                     });
@@ -316,7 +318,11 @@ let checkedDependencies = false;
         if (!this.config.secret) {
             throw new Error('Error: missing secret key. A secret key is needed to secure Payload.');
         }
-        this.secret = crypto.createHash('sha256').update(this.config.secret).digest('hex').slice(0, 32);
+        this.encryptionKeyring = buildEncryptionKeyring([
+            this.config.secret,
+            ...this.config.previousSecrets ?? []
+        ]);
+        this.secret = this.encryptionKeyring.active.legacyKey;
         this.globals = {
             config: this.config.globals
         };
@@ -395,10 +401,6 @@ let checkedDependencies = false;
                 payload: this
             });
         }
-        // Warn if image resizing is enabled but sharp is not installed
-        if (!this.config.sharp && this.config.collections.some((c)=>c.upload.imageSizes || c.upload.formatOptions)) {
-            this.logger.warn(`Image resizing is enabled for one or more collections, but sharp not installed. Please install 'sharp' and pass into the config.`);
-        }
         // Warn if user is deploying to Vercel, and any upload collection is missing a storage adapter
         if (process.env.VERCEL) {
             const uploadCollWithoutAdapter = this.config.collections.filter((c)=>c.upload && c.upload.adapter === undefined);
@@ -528,47 +530,55 @@ if (!_cached) {
     _cached = global._payload = new Map();
 }
 /**
- * Get a payload instance.
- * This function is a wrapper around new BasePayload().init() that adds the following functionality on top of that:
+ * Memoized so the strategy has a stable identity across `getPayload` calls -
+ * {@link connectDevReload} reconnects whenever the strategy in effect changes.
+ */ let memoizedNextJsDevReloadStrategy;
+/**
+ * Subscribes the cached instance to the dev reload strategy currently in effect,
+ * reconnecting if that strategy has been replaced since the last call.
  *
- * - smartly caches Payload instance on the module scope. That way, we prevent unnecessarily initializing Payload over and over again
- * when calling getPayload multiple times or from multiple locations.
- * - adds HMR support and reloads the payload instance when the config changes.
- */ /**
- * Default HMR reload strategy using Next.js webpack-hmr WebSocket.
- * Used as fallback when no custom devReloadStrategy is provided.
- */ function defaultNextJsDevReloadStrategy() {
+ * Reconnecting matters for adapters whose server runtime is itself hot-reloadable:
+ * Vite discards and re-evaluates the module that called `registerDevReloadStrategy`,
+ * orphaning its subscription, while the cached instance lives on the Node global
+ * and survives. Connecting only once would leave the instance permanently deaf to
+ * further config changes.
+ */ function connectDevReload({ cached, strategyFromOptions }) {
+    if (process.env.NODE_ENV === 'production' || process.env.NODE_ENV === 'test' || process.env.DISABLE_PAYLOAD_HMR === 'true') {
+        return;
+    }
+    if (memoizedNextJsDevReloadStrategy === undefined) {
+        memoizedNextJsDevReloadStrategy = defaultNextJsDevReloadStrategy();
+    }
+    const strategy = strategyFromOptions ?? getRegisteredDevReloadStrategy() ?? memoizedNextJsDevReloadStrategy;
+    if (!strategy || strategy === cached.devReloadStrategy) {
+        return;
+    }
+    cached.devReloadStrategy = strategy;
     try {
-        const port = process.env.PORT || '3000';
-        const hasHTTPS = process.env.USE_HTTPS === 'true' || process.argv.includes('--experimental-https');
-        const protocol = hasHTTPS ? 'wss' : 'ws';
-        const hmrPath = '/_next/webpack-hmr';
-        const prefix = process.env.__NEXT_ASSET_PREFIX ?? '';
-        const url = process.env.PAYLOAD_HMR_URL_OVERRIDE ?? `${protocol}://localhost:${port}${prefix}${hmrPath}`;
-        return {
-            connect (onReload) {
-                const ws = new WebSocket(url);
-                ws.onmessage = (event)=>{
-                    if (typeof event.data === 'string') {
-                        const data = JSON.parse(event.data);
-                        if (data.type === 'serverComponentChanges' || data.action === 'serverComponentChanges') {
-                            onReload();
-                        }
-                    }
-                };
-                ws.onerror = ()=>{
-                // swallow any websocket connection error
-                };
-                return ()=>{
-                    ws.close();
-                };
+        cached.devReloadCleanup?.();
+    } catch (_) {
+    // swallow cleanup errors from the strategy being replaced
+    }
+    cached.devReloadCleanup = null;
+    try {
+        cached.devReloadCleanup = strategy.connect(()=>{
+            if (cached.reload instanceof Promise) {
+                return;
             }
-        };
+            cached.reload = true;
+        });
     } catch (_) {
-        return null;
+    // swallow connection errors
     }
 }
-export const getPayload = async (options)=>{
+/**
+ * Get a payload instance.
+ * This function is a wrapper around new BasePayload().init() that adds the following functionality on top of that:
+ *
+ * - smartly caches Payload instance on the module scope. That way, we prevent unnecessarily initializing Payload over and over again
+ * when calling getPayload multiple times or from multiple locations.
+ * - adds HMR support and reloads the payload instance when the config changes.
+ */ export const getPayload = async (options)=>{
     if (!options?.config) {
         throw new Error('Error: the payload config is required for getPayload to work.');
     }
@@ -577,6 +587,7 @@ export const getPayload = async (options)=>{
     if (!cached) {
         cached = {
             devReloadCleanup: null,
+            devReloadStrategy: null,
             initializedCrons: Boolean(options.cron),
             payload: null,
             promise: null,
@@ -592,6 +603,10 @@ export const getPayload = async (options)=>{
         options.disableOnInit = true;
     }
     if (cached.payload) {
+        connectDevReload({
+            cached,
+            strategyFromOptions: options.devReloadStrategy
+        });
         if (options.cron && !cached.initializedCrons) {
             // getPayload called with crons enabled, but existing cached version does not have crons initialized. => Initialize crons in existing cached version
             cached.initializedCrons = true;
@@ -632,21 +647,10 @@ export const getPayload = async (options)=>{
             cached.promise = new BasePayload().init(options);
         }
         cached.payload = await cached.promise;
-        if (!cached.devReloadCleanup && process.env.NODE_ENV !== 'production' && process.env.NODE_ENV !== 'test' && process.env.DISABLE_PAYLOAD_HMR !== 'true') {
-            const strategy = options.devReloadStrategy ?? defaultNextJsDevReloadStrategy();
-            if (strategy) {
-                try {
-                    cached.devReloadCleanup = strategy.connect(()=>{
-                        if (cached.reload instanceof Promise) {
-                            return;
-                        }
-                        cached.reload = true;
-                    });
-                } catch (_) {
-                // swallow connection errors
-                }
-            }
-        }
+        connectDevReload({
+            cached,
+            strategyFromOptions: options.devReloadStrategy
+        });
     } catch (e) {
         cached.promise = null;
         e.payloadInitError = true;
@@ -657,7 +661,9 @@ export const getPayload = async (options)=>{
     }
     return cached.payload;
 };
+export * from './auth/index.js';
 export { jwtSign } from './auth/jwt.js';
+export { JWT_AUTH_VERSION } from './auth/jwtAuth.js';
 export { accessOperation } from './auth/operations/access.js';
 export { forgotPasswordOperation } from './auth/operations/forgotPassword.js';
 export { initOperation } from './auth/operations/init.js';
@@ -670,12 +676,12 @@ export { registerFirstUserOperation } from './auth/operations/registerFirstUser.
 export { resetPasswordOperation } from './auth/operations/resetPassword.js';
 export { unlockOperation } from './auth/operations/unlock.js';
 export { verifyEmailOperation } from './auth/operations/verifyEmail.js';
+export { rotateSecret } from './auth/rotateSecret.js';
 export { JWTAuthentication } from './auth/strategies/jwt.js';
 export { incrementLoginAttempts } from './auth/strategies/local/incrementLoginAttempts.js';
 export { resetLoginAttempts } from './auth/strategies/local/resetLoginAttempts.js';
-export { generateImportMap } from './bin/generateImportMap/index.js';
-export { genImportMapIterateFields } from './bin/generateImportMap/iterateFields.js';
-export { migrate as migrateCLI } from './bin/migrate.js';
+export { generateImportMap } from './cli/commands/generateImportMap/generateImportMap.js';
+export { genImportMapIterateFields } from './cli/commands/generateImportMap/iterateFields.js';
 export { createClientCollectionConfig, createClientCollectionConfigs } from './collections/config/client.js';
 export { createDataloaderCacheKey, getDataLoader } from './collections/dataloader.js';
 export { countOperation } from './collections/operations/count.js';
@@ -688,6 +694,7 @@ export { findOperation } from './collections/operations/find.js';
 export { findByIDOperation } from './collections/operations/findByID.js';
 export { findVersionByIDOperation } from './collections/operations/findVersionByID.js';
 export { findVersionsOperation } from './collections/operations/findVersions.js';
+export { countDocumentsInputSchema, countDocumentsLocalInputSchema, countVersionsInputSchema, countVersionsLocalInputSchema, createDocumentsInputSchema, createDocumentsLocalInputSchema, deleteDocumentsInputSchema, deleteDocumentsLocalInputSchema, duplicateDocumentInputSchema, duplicateDocumentLocalInputSchema, findDistinctInputSchema, findDistinctLocalInputSchema, findDocumentsInputSchema, findDocumentsLocalInputSchema, findVersionByIDInputSchema, findVersionByIDLocalInputSchema, findVersionsInputSchema, findVersionsLocalInputSchema, getCollectionSchemaInputSchema, restoreVersionInputSchema, restoreVersionLocalInputSchema, updateDocumentInputSchema, updateDocumentLocalInputSchema } from './collections/operations/inputSchemas.js';
 export { restoreVersionOperation } from './collections/operations/restoreVersion.js';
 export { updateOperation } from './collections/operations/update.js';
 export { updateByIDOperation } from './collections/operations/updateByID.js';
@@ -716,9 +723,11 @@ export { readMigrationFiles } from './database/migrations/readMigrationFiles.js'
 export { writeMigrationIndex } from './database/migrations/writeMigrationIndex.js';
 export { validateQueryPaths } from './database/queryValidation/validateQueryPaths.js';
 export { validateSearchParam } from './database/queryValidation/validateSearchParams.js';
-export { APIError, APIErrorName, AuthenticationError, DuplicateCollection, DuplicateFieldName, DuplicateGlobal, ErrorDeletingFile, FileRetrievalError, FileUploadError, Forbidden, InvalidConfiguration, InvalidFieldName, InvalidFieldRelationship, Locked, LockedAuth, MissingCollectionLabel, MissingEditorProp, MissingFieldInputOptions, MissingFieldType, MissingFile, NotFound, QueryError, UnauthorizedError, UnverifiedEmail, ValidationError, ValidationErrorName } from './errors/index.js';
+export { APIError, APIErrorName, AuthenticationError, DuplicateCollection, DuplicateFieldName, DuplicateGlobal, ErrorDeletingFile, FileRetrievalError, FileUploadError, Forbidden, InvalidConfiguration, InvalidFieldName, InvalidFieldRelationship, Locked, LockedAuth, MissingCollectionLabel, MissingEditorProp, MissingFieldInputOptions, MissingFieldType, MissingFile, NotFound, QueryError, TransformerContractError, UnauthorizedError, UnverifiedEmail, ValidationError, ValidationErrorName } from './errors/index.js';
+export { createCreatedByField, createUpdatedByField } from './fields/baseFields/authorship/index.js';
 export { baseBlockFields } from './fields/baseFields/baseBlockFields.js';
 export { baseIDField } from './fields/baseFields/baseIDField.js';
+export { getSlugFallbackValue } from './fields/baseFields/slug/getSlugFallbackValue.js';
 export { createClientBlocks, createClientField, createClientFields } from './fields/config/client.js';
 export { sanitizeField, sanitizeFields } from './fields/config/sanitize.js';
 export { getDefaultValue } from './fields/getDefaultValue.js';
@@ -734,6 +743,7 @@ export { docAccessOperation as docAccessOperationGlobal } from './globals/operat
 export { findOneOperation } from './globals/operations/findOne.js';
 export { findVersionByIDOperation as findVersionByIDOperationGlobal } from './globals/operations/findVersionByID.js';
 export { findVersionsOperation as findVersionsOperationGlobal } from './globals/operations/findVersions.js';
+export { countGlobalVersionsInputSchema, countGlobalVersionsLocalInputSchema, findGlobalInputSchema, findGlobalLocalInputSchema, findGlobalVersionByIDInputSchema, findGlobalVersionByIDLocalInputSchema, findGlobalVersionsInputSchema, findGlobalVersionsLocalInputSchema, getGlobalSchemaInputSchema, restoreGlobalVersionInputSchema, restoreGlobalVersionLocalInputSchema, updateGlobalInputSchema, updateGlobalLocalInputSchema } from './globals/operations/inputSchemas.js';
 export { restoreVersionOperation as restoreVersionOperationGlobal } from './globals/operations/restoreVersion.js';
 export { updateOperation as updateOperationGlobal } from './globals/operations/update.js';
 export { DEFAULT_ALLOW_HAS_MANY, DEFAULT_HIERARCHY_TREE_LIMIT, getHierarchyFieldName, HIERARCHY_DEFAULT_LOCALE, HIERARCHY_SLUG_PATH_FIELD, HIERARCHY_TITLE_PATH_FIELD } from './hierarchy/constants.js';
@@ -753,6 +763,7 @@ export { importHandlerPath } from './queues/operations/runJobs/runJob/importHand
 export { _internal_jobSystemGlobals, _internal_resetJobSystemGlobals, getCurrentDate } from './queues/utilities/getCurrentDate.js';
 export { getLocalI18n } from './translations/getLocalI18n.js';
 export * from './types/index.js';
+export { generatePayloadFileURL } from './uploads/generatePayloadFileURL.js';
 export { getFileByPath } from './uploads/getFileByPath.js';
 export { _internal_safeFetchGlobal } from './uploads/safeFetch.js';
 export { addDataAndFileToRequest } from './utilities/addDataAndFileToRequest.js';
@@ -761,13 +772,15 @@ export { canAccessAdmin } from './utilities/canAccessAdmin.js';
 export { commitTransaction } from './utilities/commitTransaction.js';
 export { configToJSONSchema, entityToJSONSchema, entityToStandaloneJSONSchema, fieldsToJSONSchema, registerBlockInterface, withNullableJSONSchemaType } from './utilities/configToJSONSchema.js';
 export { createArrayFromCommaDelineated } from './utilities/createArrayFromCommaDelineated.js';
-export { createLocalReq } from './utilities/createLocalReq.js';
 export { createPayloadRequest } from './utilities/createPayloadRequest.js';
+export { createPayloadRequestFromWebRequest } from './utilities/createPayloadRequestFromWebRequest.js';
 export { deepCopyObject, deepCopyObjectComplex, deepCopyObjectSimple } from './utilities/deepCopyObject.js';
 export { deepMerge, deepMergeWithCombinedArrays, deepMergeWithReactComponents, deepMergeWithSourceArrays } from './utilities/deepMerge.js';
 export { checkDependencies } from './utilities/dependencies/dependencyChecker.js';
 export { getDependencies } from './utilities/dependencies/getDependencies.js';
 export { dynamicImport } from './utilities/dynamicImport.js';
+export { getCollectionInputSchema, getGlobalInputSchema } from './utilities/entityInputSchema/getEntityInputSchema.js';
+export { validateCollectionData, validateGlobalData } from './utilities/entityInputSchema/validateEntityData.js';
 export { escapeRegExp } from './utilities/escapeRegExp.js';
 export { findUp, findUpSync, pathExistsAndIsAccessible, pathExistsAndIsAccessibleSync } from './utilities/findUp.js';
 export { flattenAllFields } from './utilities/flattenAllFields.js';
@@ -779,6 +792,9 @@ export { getCollectionIDFieldTypes } from './utilities/getCollectionIDFieldTypes
 export { getFieldByPath } from './utilities/getFieldByPath.js';
 export { getObjectDotNotation } from './utilities/getObjectDotNotation.js';
 export { getRequestLanguage } from './utilities/getRequestLanguage.js';
+export { getUniqueFieldValue } from './utilities/getUniqueFieldValue.js';
+export { hasDraftsEnabled, hasDraftValidationEnabled } from './utilities/getVersionsConfig.js';
+export { getCollectionVirtualFieldNames, getGlobalVirtualFieldNames, stripVirtualFields } from './utilities/getVirtualFieldNames.js';
 export { handleEndpoints } from './utilities/handleEndpoints.js';
 export { headersWithCors } from './utilities/headersWithCors.js';
 export { initTransaction } from './utilities/initTransaction.js';
@@ -798,8 +814,11 @@ export { sanitizeJoinParams } from './utilities/sanitizeJoinParams.js';
 export { sanitizePopulateParam } from './utilities/sanitizePopulateParam.js';
 export { sanitizeSelectParam } from './utilities/sanitizeSelectParam.js';
 export { sanitizeSortParams } from './utilities/sanitizeSortParams.js';
+export { getConfigInfoInputSchema } from './utilities/sharedInputSchemas.js';
 export { stripUnselectedFields } from './utilities/stripUnselectedFields.js';
+export { transformPointDataToPayload } from './utilities/transformPointDataToPayload.js';
 export { traverseFields } from './utilities/traverseFields.js';
+export { strictObject } from './utilities/zod.js';
 export { buildVersionCollectionFields } from './versions/buildCollectionFields.js';
 export { buildVersionGlobalFields } from './versions/buildGlobalFields.js';
 export { buildVersionCompoundIndexes } from './versions/buildVersionCompoundIndexes.js';
@@ -812,5 +831,6 @@ export { getLatestCollectionVersion } from './versions/getLatestCollectionVersio
 export { getLatestGlobalVersion } from './versions/getLatestGlobalVersion.js';
 export { saveVersion } from './versions/saveVersion.js';
 export { deepMergeSimple } from '@payloadcms/translations/utilities';
+export { z } from 'zod/mini';
 
 //# sourceMappingURL=index.js.map