@payloadcms/codemod 4.0.0-internal.934870d → 4.0.0-internal.94ef095
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -2
- package/dist/registry.d.ts.map +1 -1
- package/dist/registry.js +2 -0
- package/dist/registry.js.map +1 -1
- package/dist/runbook/v4.mdx +202 -83
- package/dist/transforms/migrate-displayed-field-value-args/basic.input.js +4 -0
- package/dist/transforms/migrate-displayed-field-value-args/basic.input.js.map +1 -0
- package/dist/transforms/migrate-displayed-field-value-args/basic.output.js +8 -0
- package/dist/transforms/migrate-displayed-field-value-args/basic.output.js.map +1 -0
- package/dist/transforms/migrate-displayed-field-value-args/index.d.ts +3 -0
- package/dist/transforms/migrate-displayed-field-value-args/index.d.ts.map +1 -0
- package/dist/transforms/migrate-displayed-field-value-args/index.js +84 -0
- package/dist/transforms/migrate-displayed-field-value-args/index.js.map +1 -0
- package/dist/transforms/migrate-displayed-field-value-args/namespace.input.js +4 -0
- package/dist/transforms/migrate-displayed-field-value-args/namespace.input.js.map +1 -0
- package/dist/transforms/migrate-displayed-field-value-args/namespace.output.js +8 -0
- package/dist/transforms/migrate-displayed-field-value-args/namespace.output.js.map +1 -0
- package/dist/transforms/migrate-displayed-field-value-args/no-match.input.js +4 -0
- package/dist/transforms/migrate-displayed-field-value-args/no-match.input.js.map +1 -0
- package/dist/transforms/migrate-displayed-field-value-args/no-match.output.js +4 -0
- package/dist/transforms/migrate-displayed-field-value-args/no-match.output.js.map +1 -0
- package/dist/upgrade/defaultTag.d.ts +1 -1
- package/dist/upgrade/defaultTag.js +2 -2
- package/dist/upgrade/defaultTag.js.map +1 -1
- package/dist/upgrade/prompt.js +3 -3
- package/dist/upgrade/prompt.js.map +1 -1
- package/package.json +9 -11
package/README.md
CHANGED
|
@@ -42,7 +42,7 @@ the prompt instead of prompting.
|
|
|
42
42
|
`npx @payloadcms/codemod upgrade run` performs the deterministic v3 -> v4 slice against the current
|
|
43
43
|
directory (run it from your project root):
|
|
44
44
|
|
|
45
|
-
1. Resolves the current Payload version from the npm registry, using the dist-tag this CLI was installed under (
|
|
45
|
+
1. Resolves the current Payload version from the npm registry, using the dist-tag this CLI was installed under (its own prerelease id, else `beta`; override with `--tag <dist-tag>`).
|
|
46
46
|
2. Rewrites `package.json`: pins `payload` + every `@payloadcms/*` to that exact version in
|
|
47
47
|
lockstep, removes dependency overrides pinning them, converts their carets to exact, and writes
|
|
48
48
|
the TypeScript / `@types/node` / `engines.node` floors. The `@payloadcms/eslint-*` packages are
|
|
@@ -57,7 +57,7 @@ prints the required Next target.
|
|
|
57
57
|
|
|
58
58
|
Flags:
|
|
59
59
|
|
|
60
|
-
- `--tag <dist-tag>`: dist-tag to resolve Payload versions from. Defaults to the dist-tag this CLI was installed under (
|
|
60
|
+
- `--tag <dist-tag>`: dist-tag to resolve Payload versions from. Defaults to the dist-tag this CLI was installed under (its own prerelease id, else `beta`).
|
|
61
61
|
- `--dry`: preview the `package.json` changes and planned steps; write and install nothing.
|
|
62
62
|
- `--force`: skip the dirty-git-tree warning.
|
|
63
63
|
|
|
@@ -84,6 +84,7 @@ The tool loads your project via [ts-morph](https://ts-morph.com/), using your `t
|
|
|
84
84
|
|
|
85
85
|
- `migrate-list-view-select-api`: Removes `admin.enableListViewSelectAPI` from Collection Configs. The List View's Select API is the default in v4.
|
|
86
86
|
- `migrate-disabled-fields`: migrates `field.admin.disableListColumn`, `disableListFilter`, `disableGroupBy`, `disableBulkEdit` and their equivalents on `imageSize.admin` into the consolidated `disabled` object form.
|
|
87
|
+
- `migrate-displayed-field-value-args`: converts direct `getDisplayedFieldValue(cellData, field, i18n)` calls imported from `@payloadcms/ui/utilities/getDisplayedFieldValue` to the object argument form. Handles named, aliased, and namespace imports. Indirect references and unsupported argument shapes are reported for manual migration.
|
|
87
88
|
- `globals-components-edit`: Globals: rename `admin.components.elements` to `admin.components.edit` and hoist `Description` to top-level `admin.components.Description` to match Collection conventions.
|
|
88
89
|
- `migrate-force-select`: migrates `forceSelect: { ... }` on Collection/Global configs to a `select` function that augments the caller's `select` when present and returns `undefined` (preserving full-document reads) when not. Shallow values become a spread (`{ ...select, ... }`); nested values use `deepMergeSimple` from `payload/shared` (auto-imported) to preserve the previous deep-merge semantics. Non-literal values, sibling `select` already present, and unsupported member kinds are surfaced as notes for manual review.
|
|
89
90
|
- `migrate-field-component-types`: replaces field component aliases—including concrete fields, canonical generics, labels, descriptions, errors, diffs, and block row labels—with the corresponding props types wrapped in `React.FC`. Generic arguments are preserved. Explicit class components, re-exports, namespace references, and inline imports are left unchanged with notes for manual migration.
|
package/dist/registry.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;
|
|
1
|
+
{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAuC3C,eAAO,MAAM,UAAU,EAAE,SAAS,EAqCjC,CAAA"}
|
package/dist/registry.js
CHANGED
|
@@ -10,6 +10,7 @@ import { migrateBlockReferencesToBlocks } from './transforms/migrate-block-refer
|
|
|
10
10
|
import { migrateBuildScript } from './transforms/migrate-build-script/index.js';
|
|
11
11
|
import { migrateDbTypesSubpath } from './transforms/migrate-db-types-subpath/index.js';
|
|
12
12
|
import { migrateDisabledFields } from './transforms/migrate-disabled-fields/index.js';
|
|
13
|
+
import { migrateDisplayedFieldValueArgs } from './transforms/migrate-displayed-field-value-args/index.js';
|
|
13
14
|
import { migrateDocumentTitleContext } from './transforms/migrate-document-title-context/index.js';
|
|
14
15
|
import { migrateFieldComponentTypes } from './transforms/migrate-field-component-types/index.js';
|
|
15
16
|
import { migrateForceSelect } from './transforms/migrate-force-select/index.js';
|
|
@@ -41,6 +42,7 @@ export const transforms = [
|
|
|
41
42
|
globalsComponentsEdit,
|
|
42
43
|
migrateListViewSelectAPI,
|
|
43
44
|
migrateDisabledFields,
|
|
45
|
+
migrateDisplayedFieldValueArgs,
|
|
44
46
|
migrateForceSelect,
|
|
45
47
|
migrateFieldComponentTypes,
|
|
46
48
|
renameDiffValueProps,
|
package/dist/registry.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/registry.ts"],"sourcesContent":["import type { Transform } from './types.js'\n\nimport { addOverrideAccessTrue } from './transforms/add-override-access-true/index.js'\nimport { exampleNoop } from './transforms/example-noop/index.js'\nimport { globalsComponentsEdit } from './transforms/globals-components-edit/index.js'\nimport { migrateAdminContextProperties } from './transforms/migrate-admin-context-properties/index.js'\nimport { migrateAfterOperationRead } from './transforms/migrate-after-operation-read/index.js'\nimport { migrateAliasedExports } from './transforms/migrate-aliased-exports/index.js'\nimport { migrateAuthorshipDefault } from './transforms/migrate-authorship-default/index.js'\nimport { migrateAzureChunkLargeFiles } from './transforms/migrate-azure-chunk-large-files/index.js'\nimport { migrateBlockReferencesToBlocks } from './transforms/migrate-block-references-to-blocks/index.js'\nimport { migrateBuildScript } from './transforms/migrate-build-script/index.js'\nimport { migrateDbTypesSubpath } from './transforms/migrate-db-types-subpath/index.js'\nimport { migrateDisabledFields } from './transforms/migrate-disabled-fields/index.js'\nimport { migrateDocumentTitleContext } from './transforms/migrate-document-title-context/index.js'\nimport { migrateFieldComponentTypes } from './transforms/migrate-field-component-types/index.js'\nimport { migrateForceSelect } from './transforms/migrate-force-select/index.js'\nimport { migrateHideAPIURL } from './transforms/migrate-hide-api-url/index.js'\nimport { migrateImportExportHooks } from './transforms/migrate-import-export-hooks/index.js'\nimport { migrateListViewSelectAPI } from './transforms/migrate-list-view-select-api/index.js'\nimport { migrateNextGenerateViewportExport } from './transforms/migrate-next-generate-viewport-export/index.js'\nimport { migrateNextSubpathExports } from './transforms/migrate-next-subpath-exports/index.js'\nimport { migratePayloadRequestCreation } from './transforms/migrate-payload-request-creation/index.js'\nimport { migrateSharpToTransformer } from './transforms/migrate-sharp-to-transformer/index.js'\nimport { migrateSlugField } from './transforms/migrate-slug-field/index.js'\nimport { migrateStorageAdaptersToConfig } from './transforms/migrate-storage-adapters-to-config/index.js'\nimport { migrateVersionsDefault } from './transforms/migrate-versions-default/index.js'\nimport { removeDefaultLocalePublishOption } from './transforms/remove-default-locale-publish-option/index.js'\nimport { removeGroupByTrue } from './transforms/remove-group-by-true/index.js'\nimport { removeLocalizeStatusConfig } from './transforms/remove-localize-status-config/index.js'\nimport { removePublishSpecificLocale } from './transforms/remove-publish-specific-locale/index.js'\nimport { removeStorageAlwaysInsertFields } from './transforms/remove-storage-always-insert-fields/index.js'\nimport { removeVersionsTrue } from './transforms/remove-versions-true/index.js'\nimport { renameDiffValueProps } from './transforms/rename-diff-value-props/index.js'\nimport { renameExperimentalTableFeature } from './transforms/rename-experimental-table-feature/index.js'\nimport { renameStorageAdaptersToStorage } from './transforms/rename-storage-adapters-to-storage/index.js'\nimport { renameTypescriptSchemaToJsonSchema } from './transforms/rename-typescript-schema-to-json-schema/index.js'\n\nexport const transforms: Transform[] = [\n exampleNoop,\n addOverrideAccessTrue,\n migrateAfterOperationRead,\n migrateHideAPIURL,\n globalsComponentsEdit,\n migrateListViewSelectAPI,\n migrateDisabledFields,\n migrateForceSelect,\n migrateFieldComponentTypes,\n renameDiffValueProps,\n migrateAliasedExports,\n migratePayloadRequestCreation,\n migrateAdminContextProperties,\n migrateBlockReferencesToBlocks,\n migrateBuildScript,\n migrateDocumentTitleContext,\n migrateSharpToTransformer,\n migrateStorageAdaptersToConfig,\n migrateAzureChunkLargeFiles,\n renameStorageAdaptersToStorage,\n migrateImportExportHooks,\n migrateDbTypesSubpath,\n migrateNextGenerateViewportExport,\n migrateNextSubpathExports,\n migrateSlugField,\n migrateVersionsDefault,\n migrateAuthorshipDefault,\n removeDefaultLocalePublishOption,\n removeGroupByTrue,\n removeLocalizeStatusConfig,\n removeVersionsTrue,\n removePublishSpecificLocale,\n removeStorageAlwaysInsertFields,\n renameTypescriptSchemaToJsonSchema,\n renameExperimentalTableFeature,\n]\n"],"names":["addOverrideAccessTrue","exampleNoop","globalsComponentsEdit","migrateAdminContextProperties","migrateAfterOperationRead","migrateAliasedExports","migrateAuthorshipDefault","migrateAzureChunkLargeFiles","migrateBlockReferencesToBlocks","migrateBuildScript","migrateDbTypesSubpath","migrateDisabledFields","migrateDocumentTitleContext","migrateFieldComponentTypes","migrateForceSelect","migrateHideAPIURL","migrateImportExportHooks","migrateListViewSelectAPI","migrateNextGenerateViewportExport","migrateNextSubpathExports","migratePayloadRequestCreation","migrateSharpToTransformer","migrateSlugField","migrateStorageAdaptersToConfig","migrateVersionsDefault","removeDefaultLocalePublishOption","removeGroupByTrue","removeLocalizeStatusConfig","removePublishSpecificLocale","removeStorageAlwaysInsertFields","removeVersionsTrue","renameDiffValueProps","renameExperimentalTableFeature","renameStorageAdaptersToStorage","renameTypescriptSchemaToJsonSchema","transforms"],"mappings":"AAEA,SAASA,qBAAqB,QAAQ,iDAAgD;AACtF,SAASC,WAAW,QAAQ,qCAAoC;AAChE,SAASC,qBAAqB,QAAQ,gDAA+C;AACrF,SAASC,6BAA6B,QAAQ,yDAAwD;AACtG,SAASC,yBAAyB,QAAQ,qDAAoD;AAC9F,SAASC,qBAAqB,QAAQ,gDAA+C;AACrF,SAASC,wBAAwB,QAAQ,mDAAkD;AAC3F,SAASC,2BAA2B,QAAQ,wDAAuD;AACnG,SAASC,8BAA8B,QAAQ,2DAA0D;AACzG,SAASC,kBAAkB,QAAQ,6CAA4C;AAC/E,SAASC,qBAAqB,QAAQ,iDAAgD;AACtF,SAASC,qBAAqB,QAAQ,gDAA+C;AACrF,SAASC,2BAA2B,QAAQ,uDAAsD;AAClG,SAASC,0BAA0B,QAAQ,sDAAqD;AAChG,SAASC,kBAAkB,QAAQ,6CAA4C;AAC/E,SAASC,iBAAiB,QAAQ,6CAA4C;AAC9E,SAASC,wBAAwB,QAAQ,oDAAmD;AAC5F,SAASC,wBAAwB,QAAQ,qDAAoD;AAC7F,SAASC,iCAAiC,QAAQ,8DAA6D;AAC/G,SAASC,yBAAyB,QAAQ,qDAAoD;AAC9F,SAASC,6BAA6B,QAAQ,yDAAwD;AACtG,SAASC,yBAAyB,QAAQ,qDAAoD;AAC9F,SAASC,gBAAgB,QAAQ,2CAA0C;AAC3E,SAASC,8BAA8B,QAAQ,2DAA0D;AACzG,SAASC,sBAAsB,QAAQ,iDAAgD;AACvF,SAASC,gCAAgC,QAAQ,6DAA4D;AAC7G,SAASC,iBAAiB,QAAQ,6CAA4C;AAC9E,SAASC,0BAA0B,QAAQ,sDAAqD;AAChG,SAASC,2BAA2B,QAAQ,uDAAsD;AAClG,SAASC,+BAA+B,QAAQ,4DAA2D;AAC3G,SAASC,kBAAkB,QAAQ,6CAA4C;AAC/E,SAASC,oBAAoB,QAAQ,gDAA+C;AACpF,SAASC,8BAA8B,QAAQ,0DAAyD;AACxG,SAASC,8BAA8B,QAAQ,2DAA0D;AACzG,SAASC,kCAAkC,QAAQ,gEAA+D;AAElH,OAAO,MAAMC,aAA0B;
|
|
1
|
+
{"version":3,"sources":["../src/registry.ts"],"sourcesContent":["import type { Transform } from './types.js'\n\nimport { addOverrideAccessTrue } from './transforms/add-override-access-true/index.js'\nimport { exampleNoop } from './transforms/example-noop/index.js'\nimport { globalsComponentsEdit } from './transforms/globals-components-edit/index.js'\nimport { migrateAdminContextProperties } from './transforms/migrate-admin-context-properties/index.js'\nimport { migrateAfterOperationRead } from './transforms/migrate-after-operation-read/index.js'\nimport { migrateAliasedExports } from './transforms/migrate-aliased-exports/index.js'\nimport { migrateAuthorshipDefault } from './transforms/migrate-authorship-default/index.js'\nimport { migrateAzureChunkLargeFiles } from './transforms/migrate-azure-chunk-large-files/index.js'\nimport { migrateBlockReferencesToBlocks } from './transforms/migrate-block-references-to-blocks/index.js'\nimport { migrateBuildScript } from './transforms/migrate-build-script/index.js'\nimport { migrateDbTypesSubpath } from './transforms/migrate-db-types-subpath/index.js'\nimport { migrateDisabledFields } from './transforms/migrate-disabled-fields/index.js'\nimport { migrateDisplayedFieldValueArgs } from './transforms/migrate-displayed-field-value-args/index.js'\nimport { migrateDocumentTitleContext } from './transforms/migrate-document-title-context/index.js'\nimport { migrateFieldComponentTypes } from './transforms/migrate-field-component-types/index.js'\nimport { migrateForceSelect } from './transforms/migrate-force-select/index.js'\nimport { migrateHideAPIURL } from './transforms/migrate-hide-api-url/index.js'\nimport { migrateImportExportHooks } from './transforms/migrate-import-export-hooks/index.js'\nimport { migrateListViewSelectAPI } from './transforms/migrate-list-view-select-api/index.js'\nimport { migrateNextGenerateViewportExport } from './transforms/migrate-next-generate-viewport-export/index.js'\nimport { migrateNextSubpathExports } from './transforms/migrate-next-subpath-exports/index.js'\nimport { migratePayloadRequestCreation } from './transforms/migrate-payload-request-creation/index.js'\nimport { migrateSharpToTransformer } from './transforms/migrate-sharp-to-transformer/index.js'\nimport { migrateSlugField } from './transforms/migrate-slug-field/index.js'\nimport { migrateStorageAdaptersToConfig } from './transforms/migrate-storage-adapters-to-config/index.js'\nimport { migrateVersionsDefault } from './transforms/migrate-versions-default/index.js'\nimport { removeDefaultLocalePublishOption } from './transforms/remove-default-locale-publish-option/index.js'\nimport { removeGroupByTrue } from './transforms/remove-group-by-true/index.js'\nimport { removeLocalizeStatusConfig } from './transforms/remove-localize-status-config/index.js'\nimport { removePublishSpecificLocale } from './transforms/remove-publish-specific-locale/index.js'\nimport { removeStorageAlwaysInsertFields } from './transforms/remove-storage-always-insert-fields/index.js'\nimport { removeVersionsTrue } from './transforms/remove-versions-true/index.js'\nimport { renameDiffValueProps } from './transforms/rename-diff-value-props/index.js'\nimport { renameExperimentalTableFeature } from './transforms/rename-experimental-table-feature/index.js'\nimport { renameStorageAdaptersToStorage } from './transforms/rename-storage-adapters-to-storage/index.js'\nimport { renameTypescriptSchemaToJsonSchema } from './transforms/rename-typescript-schema-to-json-schema/index.js'\n\nexport const transforms: Transform[] = [\n exampleNoop,\n addOverrideAccessTrue,\n migrateAfterOperationRead,\n migrateHideAPIURL,\n globalsComponentsEdit,\n migrateListViewSelectAPI,\n migrateDisabledFields,\n migrateDisplayedFieldValueArgs,\n migrateForceSelect,\n migrateFieldComponentTypes,\n renameDiffValueProps,\n migrateAliasedExports,\n migratePayloadRequestCreation,\n migrateAdminContextProperties,\n migrateBlockReferencesToBlocks,\n migrateBuildScript,\n migrateDocumentTitleContext,\n migrateSharpToTransformer,\n migrateStorageAdaptersToConfig,\n migrateAzureChunkLargeFiles,\n renameStorageAdaptersToStorage,\n migrateImportExportHooks,\n migrateDbTypesSubpath,\n migrateNextGenerateViewportExport,\n migrateNextSubpathExports,\n migrateSlugField,\n migrateVersionsDefault,\n migrateAuthorshipDefault,\n removeDefaultLocalePublishOption,\n removeGroupByTrue,\n removeLocalizeStatusConfig,\n removeVersionsTrue,\n removePublishSpecificLocale,\n removeStorageAlwaysInsertFields,\n renameTypescriptSchemaToJsonSchema,\n renameExperimentalTableFeature,\n]\n"],"names":["addOverrideAccessTrue","exampleNoop","globalsComponentsEdit","migrateAdminContextProperties","migrateAfterOperationRead","migrateAliasedExports","migrateAuthorshipDefault","migrateAzureChunkLargeFiles","migrateBlockReferencesToBlocks","migrateBuildScript","migrateDbTypesSubpath","migrateDisabledFields","migrateDisplayedFieldValueArgs","migrateDocumentTitleContext","migrateFieldComponentTypes","migrateForceSelect","migrateHideAPIURL","migrateImportExportHooks","migrateListViewSelectAPI","migrateNextGenerateViewportExport","migrateNextSubpathExports","migratePayloadRequestCreation","migrateSharpToTransformer","migrateSlugField","migrateStorageAdaptersToConfig","migrateVersionsDefault","removeDefaultLocalePublishOption","removeGroupByTrue","removeLocalizeStatusConfig","removePublishSpecificLocale","removeStorageAlwaysInsertFields","removeVersionsTrue","renameDiffValueProps","renameExperimentalTableFeature","renameStorageAdaptersToStorage","renameTypescriptSchemaToJsonSchema","transforms"],"mappings":"AAEA,SAASA,qBAAqB,QAAQ,iDAAgD;AACtF,SAASC,WAAW,QAAQ,qCAAoC;AAChE,SAASC,qBAAqB,QAAQ,gDAA+C;AACrF,SAASC,6BAA6B,QAAQ,yDAAwD;AACtG,SAASC,yBAAyB,QAAQ,qDAAoD;AAC9F,SAASC,qBAAqB,QAAQ,gDAA+C;AACrF,SAASC,wBAAwB,QAAQ,mDAAkD;AAC3F,SAASC,2BAA2B,QAAQ,wDAAuD;AACnG,SAASC,8BAA8B,QAAQ,2DAA0D;AACzG,SAASC,kBAAkB,QAAQ,6CAA4C;AAC/E,SAASC,qBAAqB,QAAQ,iDAAgD;AACtF,SAASC,qBAAqB,QAAQ,gDAA+C;AACrF,SAASC,8BAA8B,QAAQ,2DAA0D;AACzG,SAASC,2BAA2B,QAAQ,uDAAsD;AAClG,SAASC,0BAA0B,QAAQ,sDAAqD;AAChG,SAASC,kBAAkB,QAAQ,6CAA4C;AAC/E,SAASC,iBAAiB,QAAQ,6CAA4C;AAC9E,SAASC,wBAAwB,QAAQ,oDAAmD;AAC5F,SAASC,wBAAwB,QAAQ,qDAAoD;AAC7F,SAASC,iCAAiC,QAAQ,8DAA6D;AAC/G,SAASC,yBAAyB,QAAQ,qDAAoD;AAC9F,SAASC,6BAA6B,QAAQ,yDAAwD;AACtG,SAASC,yBAAyB,QAAQ,qDAAoD;AAC9F,SAASC,gBAAgB,QAAQ,2CAA0C;AAC3E,SAASC,8BAA8B,QAAQ,2DAA0D;AACzG,SAASC,sBAAsB,QAAQ,iDAAgD;AACvF,SAASC,gCAAgC,QAAQ,6DAA4D;AAC7G,SAASC,iBAAiB,QAAQ,6CAA4C;AAC9E,SAASC,0BAA0B,QAAQ,sDAAqD;AAChG,SAASC,2BAA2B,QAAQ,uDAAsD;AAClG,SAASC,+BAA+B,QAAQ,4DAA2D;AAC3G,SAASC,kBAAkB,QAAQ,6CAA4C;AAC/E,SAASC,oBAAoB,QAAQ,gDAA+C;AACpF,SAASC,8BAA8B,QAAQ,0DAAyD;AACxG,SAASC,8BAA8B,QAAQ,2DAA0D;AACzG,SAASC,kCAAkC,QAAQ,gEAA+D;AAElH,OAAO,MAAMC,aAA0B;IACrCnC;IACAD;IACAI;IACAY;IACAd;IACAgB;IACAP;IACAC;IACAG;IACAD;IACAkB;IACA3B;IACAgB;IACAlB;IACAK;IACAC;IACAI;IACAS;IACAE;IACAjB;IACA2B;IACAjB;IACAP;IACAS;IACAC;IACAG;IACAE;IACAnB;IACAoB;IACAC;IACAC;IACAG;IACAF;IACAC;IACAK;IACAF;CACD,CAAA"}
|
package/dist/runbook/v4.mdx
CHANGED
|
@@ -1,13 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: 3.0 to 4.0 Migration Guide
|
|
3
3
|
label: 3.0 to 4.0
|
|
4
|
-
order:
|
|
4
|
+
order: 20
|
|
5
5
|
desc: Upgrade guide for Payload 3.x projects migrating to 4.0.
|
|
6
6
|
keywords: local api, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react
|
|
7
7
|
---
|
|
8
8
|
|
|
9
|
-
# Payload 3.0 to 4.0 Migration Guide
|
|
10
|
-
|
|
11
9
|
All breaking changes are listed below. If you encounter changes that are not explicitly listed here, please consider contributing to this documentation by submitting a PR.
|
|
12
10
|
|
|
13
11
|
## Codemod
|
|
@@ -22,6 +20,30 @@ The codemod is idempotent and safe to run on a partially-migrated project.
|
|
|
22
20
|
|
|
23
21
|
## Breaking Changes
|
|
24
22
|
|
|
23
|
+
### Form-state data utilities are renamed
|
|
24
|
+
|
|
25
|
+
The shared form-state utilities exported from `payload/shared` now explicitly name their source:
|
|
26
|
+
|
|
27
|
+
| Old name | New name |
|
|
28
|
+
| ---------------------- | ----------------------------- |
|
|
29
|
+
| `reduceFieldsToValues` | `getDataFromFormState` |
|
|
30
|
+
| `getSiblingData` | `getSiblingDataFromFormState` |
|
|
31
|
+
|
|
32
|
+
Update imports and calls. Their arguments are unchanged:
|
|
33
|
+
|
|
34
|
+
```diff
|
|
35
|
+
-import { reduceFieldsToValues, getSiblingData } from 'payload/shared'
|
|
36
|
+
+import { getDataFromFormState, getSiblingDataFromFormState } from 'payload/shared'
|
|
37
|
+
|
|
38
|
+
-const data = reduceFieldsToValues(fields, true)
|
|
39
|
+
+const data = getDataFromFormState(fields, true)
|
|
40
|
+
|
|
41
|
+
-const siblingData = getSiblingData(fields, 'items.0.title')
|
|
42
|
+
+const siblingData = getSiblingDataFromFormState(fields, 'items.0.title')
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
The form-context methods `useForm().getData()` and `useForm().getSiblingData()` keep their names.
|
|
46
|
+
|
|
25
47
|
### Payload request creation is consolidated
|
|
26
48
|
|
|
27
49
|
Payload request creation now uses `createPayloadRequest` for local contexts and `createPayloadRequestFromWebRequest` to convert a Web `Request`. Admin context setup is exposed as `initAdminContext`.
|
|
@@ -122,9 +144,15 @@ A token is also rejected if its `collection` is not auth-enabled or has `disable
|
|
|
122
144
|
|
|
123
145
|
See [Token Data](../authentication/token-data) for the full token data shape.
|
|
124
146
|
|
|
125
|
-
###
|
|
147
|
+
### Sessions track their refreshes
|
|
148
|
+
|
|
149
|
+
Auth collections with `useSessions` (the default) now store two more fields on each session, `refreshCount` and `refreshedAt`. [Refresh tokens](../authentication/overview#refresh-tokens) use them to tell the latest refresh token apart from older ones.
|
|
150
|
+
|
|
151
|
+
On SQL adapters this adds two columns to each `<collection>_sessions` table, so existing projects need a database migration. In development the schema is pushed automatically; in production, generate a migration with `payload migrate:create` and run `payload migrate`. Existing sessions keep working, since an empty `refreshCount` counts as `0`. MongoDB needs no migration.
|
|
152
|
+
|
|
153
|
+
### Local API access is now enforced by default #overrideaccess-now-defaults-to-false-on-local-api-operations
|
|
126
154
|
|
|
127
|
-
|
|
155
|
+
`overrideAccess` now defaults to `false` on Local API operations, so omitting it respects Access Control instead. Operations that do not expose `overrideAccess`, and operations such as `resetPassword` where it was already required or did not default to `true`, are unaffected by this change.
|
|
128
156
|
|
|
129
157
|
```diff
|
|
130
158
|
const posts = await payload.find({
|
|
@@ -181,7 +209,7 @@ const syncCustomer: CollectionBeforeChangeHook = async ({
|
|
|
181
209
|
|
|
182
210
|
Sanitized collection and global access types now require a `validate` key. Payload supplies this key during configuration sanitization and uses `update` access by default. Code that constructs a sanitized access object directly must add the key.
|
|
183
211
|
|
|
184
|
-
###
|
|
212
|
+
### Access Control callbacks now receive document slugs
|
|
185
213
|
|
|
186
214
|
Collection and Global Access Control callback arguments now include the document's `slug`. This additive property is unlikely to affect most projects, but code that manually invokes access callbacks or `executeAccess` must now pass `slug`. Code that validates, enumerates, or compares the exact callback argument shape may also need updating.
|
|
187
215
|
|
|
@@ -271,7 +299,7 @@ Payload adds built-in command import references to `cli.commands` while sanitizi
|
|
|
271
299
|
|
|
272
300
|
See the [Payload CLI documentation](../configuration/cli) for the complete API.
|
|
273
301
|
|
|
274
|
-
###
|
|
302
|
+
### Legacy migration CLI export removed
|
|
275
303
|
|
|
276
304
|
The undocumented `migrateCLI` export has been removed. It accepted an already-sanitized config, a minimist-shaped `parsedArgs` object, and a special `migrationDir` override. This duplicated migration command registration and kept the old argument format alive after the main CLI moved to Commander.
|
|
277
305
|
|
|
@@ -300,7 +328,7 @@ The spawned CLI discovers the Payload config from `cwd` or `PAYLOAD_CONFIG_PATH`
|
|
|
300
328
|
|
|
301
329
|
`generateTypes` now returns `{ types, outputFile, written }` instead of returning the generated source directly when using `returnString: true`. `generateImportMap` now returns `{ outputFile, written }`, and `payload.db.generateSchema()` returns `{ outputFile }`. Code that ignores these return values does not need to change.
|
|
302
330
|
|
|
303
|
-
### Default query depth
|
|
331
|
+
### Default query depth has been reduced
|
|
304
332
|
|
|
305
333
|
Queries that omit `depth` now populate one relationship level instead of two. This reduces database work and response size by default.
|
|
306
334
|
|
|
@@ -375,7 +403,7 @@ export const Posts: CollectionConfig = {
|
|
|
375
403
|
}
|
|
376
404
|
```
|
|
377
405
|
|
|
378
|
-
### Authorship
|
|
406
|
+
### Authorship is now enabled by default
|
|
379
407
|
|
|
380
408
|
Collections and globals now track authorship by default: Payload injects `createdBy` and `updatedBy` polymorphic relationship fields (related to every auth-enabled collection) and stamps them from `req.user` on each write. Previously there was no authorship tracking; you now opt out with `authorship: false`.
|
|
381
409
|
|
|
@@ -414,7 +442,7 @@ The `admin.enableListViewSelectAPI` Collection Config property has been removed.
|
|
|
414
442
|
|
|
415
443
|
If you previously set `admin.enableListViewSelectAPI: true`, remove the property — the behavior is now default. The `migrate-list-view-select-api` transform in `@payloadcms/codemod` handles this automatically.
|
|
416
444
|
|
|
417
|
-
###
|
|
445
|
+
### Global component slots now match Collections
|
|
418
446
|
|
|
419
447
|
Global configs now use the same `admin.components` shape as Collections. The Edit View slot container is renamed from `elements` to `edit`, the `Description` slot is hoisted to top-level `admin.components.Description`, and `editMenuItems` is now supported.
|
|
420
448
|
|
|
@@ -442,7 +470,7 @@ Globals also now support custom views with arbitrary keys under `admin.component
|
|
|
442
470
|
|
|
443
471
|
This change is auto-migrated by the `globals-components-edit` codemod.
|
|
444
472
|
|
|
445
|
-
###
|
|
473
|
+
### Dynamic selection replaces static forced selection
|
|
446
474
|
|
|
447
475
|
The static `forceSelect` config has been removed. Each Collection and Global now accepts a top-level `select` function that receives the current `operation`, `req`, and the caller's `select`, and returns the final `select` to use. Returning `undefined` leaves the caller's `select` unchanged.
|
|
448
476
|
|
|
@@ -467,9 +495,9 @@ The same change applies to Globals.
|
|
|
467
495
|
|
|
468
496
|
Run `npx @payloadcms/codemod --transform migrate-force-select` to migrate automatically. The codemod handles object-literal `forceSelect` values, including nested ones (which previously deep-merged) — those are rewritten to call `deepMergeSimple` from `payload/shared`, with the import added automatically. Non-literal values, configs that already define a sibling `select`, and unsupported member kinds are surfaced as notes for manual review.
|
|
469
497
|
|
|
470
|
-
####
|
|
498
|
+
#### API tab visibility now uses a condition
|
|
471
499
|
|
|
472
|
-
Use the existing `admin.components.views.edit.api.tab.condition` to hide the API tab instead.
|
|
500
|
+
`admin.hideAPIURL` has been removed from Collections and Globals. Use the existing `admin.components.views.edit.api.tab.condition` to hide the API tab instead.
|
|
473
501
|
|
|
474
502
|
```diff
|
|
475
503
|
// collections/Posts.ts
|
|
@@ -497,7 +525,7 @@ export const PostsCollection: CollectionConfig = {
|
|
|
497
525
|
|
|
498
526
|
Run `npx @payloadcms/codemod --transform remove-hide-api-url` to migrate automatically.
|
|
499
527
|
|
|
500
|
-
### Aliased
|
|
528
|
+
### Aliased UI and Next.js re-exports have been removed
|
|
501
529
|
|
|
502
530
|
Several types and utilities that were re-exported from `@payloadcms/ui` and `@payloadcms/next/utilities` for backwards compatibility have been removed. The canonical exports live in `payload` and `payload/shared`; import directly from there.
|
|
503
531
|
|
|
@@ -616,7 +644,7 @@ npx @payloadcms/codemod --transform rename-diff-value-props
|
|
|
616
644
|
|
|
617
645
|
The codemod updates functions whose props are typed with a Diff props or component type imported from `payload` (e.g. `TextFieldDiffClientProps`), or with a type in the same file built from one. It renames destructured props and reads such as `props.comparisonValue`. Untyped components and props passed on to other components (e.g. `<OtherDiff comparisonValue={...} />`) aren't changed automatically; the codemod prints a note for each leftover in files that import a Diff type.
|
|
618
646
|
|
|
619
|
-
###
|
|
647
|
+
### Default value functions can now return promises ([#17522](https://github.com/payloadcms/payload/pull/17522))
|
|
620
648
|
|
|
621
649
|
The exported `DefaultValue` type's function variant previously declared a synchronous-only return type (`SerializableValue`), even though Payload has always awaited the result of a `defaultValue` function at runtime. The type now correctly reflects this and allows `Promise<SerializableValue> | SerializableValue`.
|
|
622
650
|
|
|
@@ -678,7 +706,7 @@ const interfaceName = global.typescript?.interface
|
|
|
678
706
|
|
|
679
707
|
Properties filled during sanitization, including `_sanitized`, `admin`, `custom`, `label`, standard access functions, hook arrays, endpoints, and flattened fields, remain required. Use `GlobalConfig` for input and `SanitizedGlobalConfig` after sanitization.
|
|
680
708
|
|
|
681
|
-
### User types
|
|
709
|
+
### User types have been consolidated
|
|
682
710
|
|
|
683
711
|
Payload's user types have been consolidated so each one has a clear job. This completes a cleanup already planned in 3.x: `UntypedUser` was deprecated for removal in 4.0, and `TypedUser` was marked to be renamed to `User` in 4.0.
|
|
684
712
|
|
|
@@ -744,7 +772,7 @@ If the field name is dynamic (configurable at runtime), index through `Record<st
|
|
|
744
772
|
const value = (user as Record<string, unknown>)[fieldNameFromConfig]
|
|
745
773
|
```
|
|
746
774
|
|
|
747
|
-
###
|
|
775
|
+
### Plugins now infer generated types automatically
|
|
748
776
|
|
|
749
777
|
The `<ConfigType>` type parameter on `multiTenantPlugin` and `searchPlugin` — and on `MultiTenantPluginConfig` / `SearchPluginConfig` — has been removed. It only existed to override the `user` / `locale` types, which Payload now infers from your generated types automatically: `userHasAccessToAllTenants` receives the generated `User`, and `search`'s `skipSync` callback receives `TypedLocale | undefined`.
|
|
750
778
|
|
|
@@ -755,9 +783,9 @@ Drop the type argument — your callbacks are typed correctly without it.
|
|
|
755
783
|
+ multiTenantPlugin({ ... })
|
|
756
784
|
```
|
|
757
785
|
|
|
758
|
-
###
|
|
786
|
+
### Plugin definitions now require a slug and named options
|
|
759
787
|
|
|
760
|
-
|
|
788
|
+
The experimental `definePlugin` helper now requires a `slug` and passes plugin options through a named `options` argument:
|
|
761
789
|
|
|
762
790
|
- **`slug` is now required.** It registers the plugin in the `plugins` map for cross-plugin discovery. Add one to every `definePlugin` call.
|
|
763
791
|
- **Options are a named `options` argument.** They were previously spread into the `plugin` callback's args alongside `config` and `plugins`; they're now under a single `options` property. `TOptions` is also no longer constrained to `Record<string, unknown>`, so `interface` and generic option types work.
|
|
@@ -771,9 +799,9 @@ export const myPlugin = definePlugin<MyPluginOptions>({
|
|
|
771
799
|
})
|
|
772
800
|
```
|
|
773
801
|
|
|
774
|
-
###
|
|
802
|
+
### Admin routing is now framework-agnostic
|
|
775
803
|
|
|
776
|
-
`@payloadcms/ui` no longer depends on `next` directly. Custom admin components (field components, custom views, plugins) that previously imported router hooks or the `Link` component from `next/*` must now import the framework-agnostic equivalents from `@payloadcms/ui`. Behavior is identical when running on Next.js — the `NextRouterAdapter` shipped by `@payloadcms/next` wires `next/navigation` hooks and `next/link` into the same context — but
|
|
804
|
+
`@payloadcms/ui` no longer depends on `next` directly. Custom admin components (field components, custom views, plugins) that previously imported router hooks or the `Link` component from `next/*` must now import the framework-agnostic equivalents from `@payloadcms/ui`. Behavior is identical when running on Next.js — the `NextRouterAdapter` shipped by `@payloadcms/next` wires `next/navigation` hooks and `next/link` into the same context — but UI code can now also run on non-Next adapters such as TanStack Start without modification.
|
|
777
805
|
|
|
778
806
|
**Hooks** — import from `@payloadcms/ui` instead of `next/navigation`:
|
|
779
807
|
|
|
@@ -825,7 +853,7 @@ If you were relying on Next-specific extras like `prefetch()` on the router inst
|
|
|
825
853
|
/>
|
|
826
854
|
```
|
|
827
855
|
|
|
828
|
-
###
|
|
856
|
+
### Next.js subpath exports have moved to the UI package
|
|
829
857
|
|
|
830
858
|
The `./client`, `./rsc`, and `./templates` subpath exports on `@payloadcms/next` were thin re-exports of components that now live in `@payloadcms/ui`. All admin elements (DocumentHeader, FormHeader, HierarchyTypeField, Logo, Nav) and templates (DefaultTemplate, MinimalTemplate) have been relocated to `@payloadcms/ui` and no longer depend on `next/*` modules. Import them directly from the canonical source.
|
|
831
859
|
|
|
@@ -863,7 +891,7 @@ If you reference any of these components by string path in your Payload config (
|
|
|
863
891
|
|
|
864
892
|
Run `npx @payloadcms/codemod --transform migrate-next-subpath-exports` to migrate automatically. It rewrites both `import` declarations and string component paths.
|
|
865
893
|
|
|
866
|
-
###
|
|
894
|
+
### Document title state has moved to its own hook
|
|
867
895
|
|
|
868
896
|
For performance reasons, the document title state has been split out of `DocumentInfoContext` into its own `DocumentTitleContext`. Access it through the `useDocumentTitle` hook, which exposes the same `title` and `setDocumentTitle` API. Components that subscribed to `useDocumentInfo` solely for the title will no longer re-render when unrelated document state changes.
|
|
869
897
|
|
|
@@ -883,7 +911,43 @@ If you only used `useDocumentInfo` for `title` / `setDocumentTitle`, drop the im
|
|
|
883
911
|
|
|
884
912
|
Run `npx @payloadcms/codemod --transform migrate-document-title-context` to migrate automatically. The codemod splits mixed destructures, removes the `useDocumentInfo` import when no other properties are still used, and preserves any rename aliases (e.g. `{ title: docTitle }`).
|
|
885
913
|
|
|
886
|
-
### `
|
|
914
|
+
### `Form` makes its own form-state requests
|
|
915
|
+
|
|
916
|
+
`Form` owns server form-state requests after field changes and successful saves. Document forms derive their request information from the surrounding document and operation providers. Nested forms identify their schema with `schemaPath`; bulk forms restrict their fields with `select`, and widget forms identify their entity with `widgetSlug`.
|
|
917
|
+
|
|
918
|
+
Remove callbacks that fetch and return server form state:
|
|
919
|
+
|
|
920
|
+
```diff
|
|
921
|
+
-const onChange = async ({ formState, submitted }) => {
|
|
922
|
+
- const { state } = await getFormState({
|
|
923
|
+
- collectionSlug,
|
|
924
|
+
- docPermissions,
|
|
925
|
+
- docPreferences: await getDocPreferences(),
|
|
926
|
+
- formState,
|
|
927
|
+
- operation: 'update',
|
|
928
|
+
- schemaPath,
|
|
929
|
+
- signal: controller.signal,
|
|
930
|
+
- skipValidation: !submitted,
|
|
931
|
+
- })
|
|
932
|
+
- return state
|
|
933
|
+
-}
|
|
934
|
+
-
|
|
935
|
+
-<Form initialState={initialState} onChange={[onChange]}>
|
|
936
|
+
+<Form initialState={initialState} schemaPath={schemaPath}>
|
|
937
|
+
```
|
|
938
|
+
|
|
939
|
+
A document's main form uses `isDocumentForm` and does not need `schemaPath`. It also owns document locking, stale-data detection, permission refreshes and preview URLs. Pass persistent read-only state with `readOnly`; temporary `disabled` or processing state does not make fields read-only on the server.
|
|
940
|
+
|
|
941
|
+
Plain custom forms without `isDocumentForm`, `schemaPath` or `widgetSlug` remain local, even when they receive `initialState` or are rendered inside a document provider. Initial state continues to be built before rendering the form.
|
|
942
|
+
|
|
943
|
+
BREAKING CHANGES:
|
|
944
|
+
|
|
945
|
+
- The return values of `onChange` and `onSuccess` are ignored. Use them for side effects only.
|
|
946
|
+
- `onChange` receives the merged state after an edit refresh or local submit validation, including invalid validation results. Validation notifications have `submitted: true`.
|
|
947
|
+
- Schema-backed forms with a local `onSubmit` validate on the server before committing. Remove `beforeSubmit` callbacks whose only purpose is fetching server form state. Invalid state or a validation request failure prevents the local commit.
|
|
948
|
+
- After a successful save, `Form` refreshes permissions and state before calling `onSuccess`. Creates skip the state refresh because they replace the form. A failed refresh does not change the successful save outcome or suppress `onSuccess`.
|
|
949
|
+
|
|
950
|
+
### Locale hooks can now return null
|
|
887
951
|
|
|
888
952
|
The return type of `useLocale` is now `Locale | null`. It returns `null` when localization is disabled or configured without any locales. In Payload 3, the hook was typed as `Locale` and returned an empty object when localization was unavailable.
|
|
889
953
|
|
|
@@ -919,7 +983,7 @@ The deprecated `readOnly` property has been removed from `FieldType`, the object
|
|
|
919
983
|
|
|
920
984
|
Read `readOnly` from your field component's props instead:
|
|
921
985
|
|
|
922
|
-
|
|
986
|
+
```diff
|
|
923
987
|
'use client'
|
|
924
988
|
import type { TextFieldClientComponent } from 'payload'
|
|
925
989
|
import { useField } from '@payloadcms/ui'
|
|
@@ -928,6 +992,7 @@ import { useField } from '@payloadcms/ui'
|
|
|
928
992
|
- const { readOnly, value } = useField({ path })
|
|
929
993
|
+export const MyField: TextFieldClientComponent = ({ path, readOnly }) => {
|
|
930
994
|
+ const { value } = useField({ path })
|
|
995
|
+
```
|
|
931
996
|
|
|
932
997
|
### Deprecated `TableColumnsProvider` props removed
|
|
933
998
|
|
|
@@ -954,9 +1019,9 @@ The following deprecated props have been removed from `TableColumnsProvider` and
|
|
|
954
1019
|
>
|
|
955
1020
|
{children}
|
|
956
1021
|
</TableColumnsProvider>
|
|
957
|
-
|
|
1022
|
+
```
|
|
958
1023
|
|
|
959
|
-
###
|
|
1024
|
+
### Rich text adapters no longer expose translations
|
|
960
1025
|
|
|
961
1026
|
The `i18n` property on `RichTextAdapter` (and its return type from adapter provider functions) has been removed. It was deprecated in v3 in favour of merging translations directly into `config.i18n.translations` inside the adapter provider.
|
|
962
1027
|
|
|
@@ -1013,7 +1078,7 @@ export const MyFeature = createServerFeature({
|
|
|
1013
1078
|
|
|
1014
1079
|
If an affected adapter or feature performs asynchronous work, move that work to an asynchronous plugin before config sanitization or to a runtime hook. Projects that only use `buildConfig(...)` and `lexicalEditor(...)` normally are not affected; `buildConfig` remains asynchronous.
|
|
1015
1080
|
|
|
1016
|
-
###
|
|
1081
|
+
### Transaction requests now use a single identifier property
|
|
1017
1082
|
|
|
1018
1083
|
The `transactionIDPromise` property on `PayloadRequest` has been removed. It was deprecated and unused — `transactionID` (which already supports `Promise<number | string>`) is the correct property to use for both resolved values and pending transactions.
|
|
1019
1084
|
|
|
@@ -1063,7 +1128,13 @@ Remove `diffMethod` from your props. If you passed it on to a diffing utility, p
|
|
|
1063
1128
|
}) => {
|
|
1064
1129
|
```
|
|
1065
1130
|
|
|
1066
|
-
###
|
|
1131
|
+
### `root` removed from the `Endpoint` type
|
|
1132
|
+
|
|
1133
|
+
The deprecated `root` property has been removed from the `Endpoint` type. It has been typed as `never` since 3.0, so it couldn't be set, and Payload ignored it.
|
|
1134
|
+
|
|
1135
|
+
To serve a route outside of `routes.api`, add it to your app directly, e.g. as a [Next.js route handler](https://nextjs.org/docs/app/api-reference/file-conventions/route).
|
|
1136
|
+
|
|
1137
|
+
### Collection after-operation hooks no longer report read operations
|
|
1067
1138
|
|
|
1068
1139
|
The deprecated `'read'` value for the `operation` argument of collection `afterOperation` hooks has been removed. Payload has not dispatched `afterOperation` with `operation: 'read'` for some time — the `find` and `findByID` operations report their own names (`'find'` and `'findByID'`) instead.
|
|
1069
1140
|
|
|
@@ -1086,14 +1157,14 @@ Run `npx @payloadcms/codemod --transform migrate-after-operation-read` to migrat
|
|
|
1086
1157
|
|
|
1087
1158
|
The `operation: 'read'` value on the `beforeOperation` hook is unchanged.
|
|
1088
1159
|
|
|
1089
|
-
###
|
|
1160
|
+
### Static configuration defaults have been removed ([#17103](https://github.com/payloadcms/payload/pull/17103))
|
|
1090
1161
|
|
|
1091
|
-
The defaults object exported from payload has been removed. It was deprecated because it was a single shared object and mutating it (or any config that used it as a base) leaked changes into every other consumer of the defaults.
|
|
1162
|
+
The `defaults` object exported from `payload` has been removed. It was deprecated because it was a single shared object and mutating it (or any config that used it as a base) leaked changes into every other consumer of the defaults.
|
|
1092
1163
|
|
|
1093
1164
|
If you depended on reading a specific default value at runtime, read it from the sanitized config returned by buildConfig (or payload.config) instead of from the static defaults object.
|
|
1094
1165
|
Alternatively, you can call `addDefaultsToConfig` to get the unsanitized config but populated with the default properties.
|
|
1095
1166
|
|
|
1096
|
-
###
|
|
1167
|
+
### Import and export field callbacks have moved to hooks
|
|
1097
1168
|
|
|
1098
1169
|
The `toCSV` and `fromCSV` field options in `custom['plugin-import-export']` have been removed. Use `hooks.beforeExport` and `hooks.beforeImport` instead — they work for both CSV and JSON formats.
|
|
1099
1170
|
|
|
@@ -1134,7 +1205,7 @@ The `fromCSV` → `hooks.beforeImport` change is non-breaking for the `data` par
|
|
|
1134
1205
|
|
|
1135
1206
|
Run `npx @payloadcms/codemod --transform migrate-import-export-hooks` to migrate automatically. The codemod moves the function values into the correct hook positions and merges with any existing `hooks` object. Review argument names in the migrated functions — `row` references must be renamed to `siblingData` and `doc` references renamed to `data`.
|
|
1136
1207
|
|
|
1137
|
-
###
|
|
1208
|
+
### Database adapter types now use the main package exports
|
|
1138
1209
|
|
|
1139
1210
|
The `/types` subpath export has been removed from all Drizzle-based database adapter packages. All types are available directly from the main package entry point.
|
|
1140
1211
|
|
|
@@ -1181,19 +1252,21 @@ The deprecated `findMigrationDir` re-export has been removed from `@payloadcms/d
|
|
|
1181
1252
|
+ import { findMigrationDir } from 'payload'
|
|
1182
1253
|
```
|
|
1183
1254
|
|
|
1184
|
-
### Minimum supported Node.js version is now 24.
|
|
1255
|
+
### Minimum supported Node.js version is now 24.22.1 ([#16540](https://github.com/payloadcms/payload/pull/16540))
|
|
1185
1256
|
|
|
1186
|
-
The minimum supported Node.js version is now **24.
|
|
1257
|
+
The minimum supported Node.js version is now **24.22.1** (previously 18.20.2). Upgrade your runtime — along with any CI, Docker images, and deployment targets — to the latest node LTS version or newer before upgrading to 4.0.
|
|
1187
1258
|
|
|
1188
|
-
### Minimum supported Next.js version is now 16.4.
|
|
1259
|
+
### Minimum supported Next.js version is now 16.4.1 ([#16537](https://github.com/payloadcms/payload/pull/16537))
|
|
1189
1260
|
|
|
1190
|
-
Older versions of Next.js are no longer supported. Update Next.js to **16.4.
|
|
1261
|
+
Older versions of Next.js are no longer supported. Update Next.js to **16.4.1** or newer within the `16.x` release line.
|
|
1262
|
+
|
|
1263
|
+
React and React DOM must satisfy `^19.3.1`. TanStack Start applications also require `@vitejs/plugin-rsc` `^0.5.38`. These minimums include the fixes for [GHSA-xqc2-xf4c-x3h3](https://github.com/react/react/security/advisories/GHSA-xqc2-xf4c-x3h3) and its [Next.js advisory](https://github.com/vercel/next.js/security/advisories/GHSA-673q-mjm6-r5xr).
|
|
1191
1264
|
|
|
1192
1265
|
### Minimum supported TypeScript version is now 6.0.3 ([#16692](https://github.com/payloadcms/payload/pull/16692))
|
|
1193
1266
|
|
|
1194
1267
|
Payload's generated types are no longer guaranteed to work on TypeScript versions below **6.0.3** (previously 5.7.3). Upgrade the `typescript` dependency in your project to 6.0.3 or newer.
|
|
1195
1268
|
|
|
1196
|
-
###
|
|
1269
|
+
### The Slate rich text editor has been removed ([#16359](https://github.com/payloadcms/payload/pull/16359))
|
|
1197
1270
|
|
|
1198
1271
|
Starting in Payload 4.0, `@payloadcms/richtext-lexical` is the only supported rich text editor. The `@payloadcms/richtext-slate` package has been deleted and will no longer be published.
|
|
1199
1272
|
|
|
@@ -1208,7 +1281,7 @@ The rich text adapter pattern itself is unchanged — `editor: lexicalEditor({})
|
|
|
1208
1281
|
|
|
1209
1282
|
If you are still using Slate, **do not upgrade to 4.0 yet.** Stay on the latest 3.x release and complete the [Slate → Lexical migration](https://payloadcms.com/docs/rich-text/migration) first.
|
|
1210
1283
|
|
|
1211
|
-
###
|
|
1284
|
+
### Legacy Lexical HTML converters have been removed ([#16548](https://github.com/payloadcms/payload/pull/16548))
|
|
1212
1285
|
|
|
1213
1286
|
The deprecated `HTMLConverterFeature`, `lexicalHTML`, and the per-node `converters.html` API have been removed from `@payloadcms/richtext-lexical`. Use `convertLexicalToHTML` and `lexicalHTMLField` from the non-deprecated converter instead.
|
|
1214
1287
|
|
|
@@ -1232,7 +1305,7 @@ The deprecated `HTMLConverterFeature`, `lexicalHTML`, and the per-node `converte
|
|
|
1232
1305
|
|
|
1233
1306
|
Custom nodes that define `converters.html` should export their converters instead.
|
|
1234
1307
|
|
|
1235
|
-
### Lexical
|
|
1308
|
+
### Lexical now uses its built-in HTML element check ([#17104](https://github.com/payloadcms/payload/pull/17104))
|
|
1236
1309
|
|
|
1237
1310
|
The deprecated `isHTMLElement` utility has been removed from `@payloadcms/richtext-lexical`. It was a thin wrapper around `x instanceof HTMLElement` that duplicated a utility already exported by `lexical`. Import it directly from `lexical` instead.
|
|
1238
1311
|
|
|
@@ -1243,9 +1316,9 @@ The deprecated `isHTMLElement` utility has been removed from `@payloadcms/richte
|
|
|
1243
1316
|
|
|
1244
1317
|
`lexical`'s built-in `isHTMLElement` is the canonical implementation and narrows against the node's owning-document `HTMLElement`, so it is also safe across iframes and other realms.
|
|
1245
1318
|
|
|
1246
|
-
### Lexical
|
|
1319
|
+
### Lexical now uses the upstream Markdown package
|
|
1247
1320
|
|
|
1248
|
-
`@payloadcms/richtext-lexical` no longer ships a vendored copy of `@lexical/markdown`. The package is now a direct dependency, every `@lexical/*` package was upgraded from `0.41.0` to `0.
|
|
1321
|
+
`@payloadcms/richtext-lexical` no longer ships a vendored copy of `@lexical/markdown`. The package is now a direct dependency, every `@lexical/*` package was upgraded from `0.41.0` to `0.53.0`, and `@payloadcms/richtext-lexical/lexical/markdown` is a pure passthrough of `@lexical/markdown`.
|
|
1249
1322
|
|
|
1250
1323
|
Most projects use markdown through the editor or through `convertMarkdownToLexical` / `convertLexicalToMarkdown` and need no changes. You are only affected if you import from `@payloadcms/richtext-lexical/lexical/markdown` directly.
|
|
1251
1324
|
|
|
@@ -1269,7 +1342,9 @@ If you keep calling `$convertFromMarkdownString` directly, pass `editorConfig.fe
|
|
|
1269
1342
|
|
|
1270
1343
|
**Whitespace-only markdown table cells now import as an empty paragraph** instead of a text node of padding spaces. This comes from the lexical upgrade, not Payload's own code. No action is required unless you assert on those padding spaces in stored content.
|
|
1271
1344
|
|
|
1272
|
-
|
|
1345
|
+
**Markdown export escapes literal brackets and HTML-like text.** `convertLexicalToMarkdown` now writes text such as `[note]` as `[note]` and `<b>` as `<b>`, so literal text no longer turns into links or HTML when the Markdown is parsed again. Ordinary text such as `AT&T` and `a < b` is unchanged, and `convertMarkdownToLexical` restores the original text. No action is required unless you compare exported Markdown against fixed strings or pass it to a parser that does not decode numeric character references.
|
|
1346
|
+
|
|
1347
|
+
If you import lexical APIs directly through `@payloadcms/richtext-lexical/lexical/*`, also review the [lexical breaking changes](https://github.com/facebook/lexical/releases) between `0.41.0` and `0.53.0`. None of them require action for typical Payload usage.
|
|
1273
1348
|
|
|
1274
1349
|
If your app imports Lexical types or adds custom features, check these changes from `0.50.0`. They also apply to imports through `@payloadcms/richtext-lexical/lexical` and its subpaths:
|
|
1275
1350
|
|
|
@@ -1279,10 +1354,12 @@ If your app imports Lexical types or adds custom features, check these changes f
|
|
|
1279
1354
|
- `SerializedEditorState<T>`, `SerializedElementNode<T>`, and `SerializedRootNode<T>` no longer accept a type argument. Remove `<T>` if you only need the base node type. For a document with your own node types, use Payload's `TypedEditorState<T>` instead. Without a type argument, Lexical's `children` are still typed as `SerializedLexicalNode[]`.
|
|
1280
1355
|
- `ReturnType<Node['exportJSON']>` can now infer partial JSON, making fields such as `version` and `url` optional. If your code expects the full format, use the node's explicit serialized type, such as `SerializedLinkNode`. A normal `node.exportJSON()` call still returns the full format.
|
|
1281
1356
|
- `LexicalNode.getCommonAncestor` was removed. Use `$getCommonAncestor(a, b)?.commonAncestor ?? null`; pass the parents of non-element nodes if you need the old method's behavior.
|
|
1357
|
+
- Node traversal and key lookup methods no longer accept a type argument: `getParent<T>()`, `getParentOrThrow<T>()`, `getChildren<T>()`, `getFirstChild<T>()`, `getNextSibling<T>()`, `$getNodeByKey<T>()` and the rest of that family. Remove `<T>` and narrow the result with a node guard, for example `node.getChildren().filter($isTableCellNode)`. Runtime behavior is unchanged.
|
|
1358
|
+
- The deprecated `LinkImportExtension`, `ListImportExtension` and `RichTextImportExtension` were removed. Use `LinkExtension`, `ListExtension` and `RichTextExtension` instead. `HorizontalRuleImportExtension` was also removed; use `HorizontalRuleExtension` from `@lexical/extension` together with an extension that includes `CoreImportExtension`. The `*ImportRules` arrays remain.
|
|
1282
1359
|
|
|
1283
|
-
### Lexical
|
|
1360
|
+
### Lexical table support is no longer experimental
|
|
1284
1361
|
|
|
1285
|
-
|
|
1362
|
+
`EXPERIMENTAL_TableFeature` has been renamed to `TableFeature` now that the table feature is no longer experimental.
|
|
1286
1363
|
|
|
1287
1364
|
```diff
|
|
1288
1365
|
- import { EXPERIMENTAL_TableFeature } from '@payloadcms/richtext-lexical'
|
|
@@ -1300,9 +1377,10 @@ Stored content is unaffected.
|
|
|
1300
1377
|
|
|
1301
1378
|
The `LexicalEditorProps` type exported from `@payloadcms/richtext-lexical` has been renamed to `LexicalEditorArgs`. It describes the arguments of the `lexicalEditor` function, not component props. The shape is unchanged.
|
|
1302
1379
|
|
|
1303
|
-
|
|
1380
|
+
```diff
|
|
1304
1381
|
- import type { LexicalEditorProps } from '@payloadcms/richtext-lexical'
|
|
1305
1382
|
+ import type { LexicalEditorArgs } from '@payloadcms/richtext-lexical'
|
|
1383
|
+
```
|
|
1306
1384
|
|
|
1307
1385
|
### Lexical: `UploadDataImproved` replaced by `UploadData` ([#18606](https://github.com/payloadcms/payload/pull/18606))
|
|
1308
1386
|
|
|
@@ -1310,7 +1388,7 @@ The internal `UploadDataImproved` type has been removed, and its definition is n
|
|
|
1310
1388
|
|
|
1311
1389
|
```ts
|
|
1312
1390
|
import type { UploadData } from '@payloadcms/richtext-lexical'
|
|
1313
|
-
|
|
1391
|
+
```
|
|
1314
1392
|
|
|
1315
1393
|
### Lexical: the `version` of nodes is ignored
|
|
1316
1394
|
|
|
@@ -1333,7 +1411,7 @@ await upgradeLexicalData({ payload })
|
|
|
1333
1411
|
|
|
1334
1412
|
**Payload doesn't add or remove `version` when it saves rich text.** Rich text created by Lexical, like in the admin panel, still has `version: 1` on every node, because Lexical's JSON export writes it. Payload's own nodes used to write their own numbers instead (like `2` for blocks), and now write `1` as well. Rich text sent through the API, CLI or MCP is saved as sent, so it may not contain `version`. The generated types still include `version`, marked as deprecated, so don't rely on it being there.
|
|
1335
1413
|
|
|
1336
|
-
### Field
|
|
1414
|
+
### Field schema configuration now reflects JSON Schema
|
|
1337
1415
|
|
|
1338
1416
|
`typescriptSchema` accepted JSON Schema, not TypeScript, so the name lied. Renamed to `jsonSchema`. Same shape, same array of transforms. The underlying schema is now also consumed by the MCP plugin for runtime validation, not just type generation.
|
|
1339
1417
|
|
|
@@ -1346,9 +1424,9 @@ await upgradeLexicalData({ payload })
|
|
|
1346
1424
|
}
|
|
1347
1425
|
```
|
|
1348
1426
|
|
|
1349
|
-
###
|
|
1427
|
+
### Rich text output schemas have been renamed
|
|
1350
1428
|
|
|
1351
|
-
|
|
1429
|
+
The Rich Text adapter's `outputSchema` property has been renamed to `jsonSchema`. The arguments object also gains `typeStringDefinitions: Set<string>` — a sink for raw TS source appended to `payload-types.ts`.
|
|
1352
1430
|
|
|
1353
1431
|
```diff
|
|
1354
1432
|
myAdapter: RichTextAdapter = {
|
|
@@ -1361,7 +1439,7 @@ Same story on the editor side. The arguments object also gains `typeStringDefini
|
|
|
1361
1439
|
|
|
1362
1440
|
`@payloadcms/richtext-lexical` is updated. Only third-party adapters need attention.
|
|
1363
1441
|
|
|
1364
|
-
###
|
|
1442
|
+
### Schema generation now returns definitions alongside JSON Schema
|
|
1365
1443
|
|
|
1366
1444
|
`configToJSONSchema` (from `payload`) used to return a `JSONSchema4` directly. It now returns an object with the schema plus the TS-source sink. Destructure to pull the schema out.
|
|
1367
1445
|
|
|
@@ -1372,7 +1450,7 @@ Same story on the editor side. The arguments object also gains `typeStringDefini
|
|
|
1372
1450
|
|
|
1373
1451
|
If you run your own type generation, append `[...typeStringDefinitions].join('\n\n')` to the compiled output. Otherwise ignore it.
|
|
1374
1452
|
|
|
1375
|
-
###
|
|
1453
|
+
### Field schema generation now uses object arguments
|
|
1376
1454
|
|
|
1377
1455
|
`fieldsToJSONSchema` used to take 6 positional arguments. It now takes one object. The new shape also requires `typeStringDefinitions`, and `forceInlineBlocks` is a top-level sibling instead of nested under `opts`.
|
|
1378
1456
|
|
|
@@ -1396,9 +1474,9 @@ If you run your own type generation, append `[...typeStringDefinitions].join('\n
|
|
|
1396
1474
|
+ })
|
|
1397
1475
|
```
|
|
1398
1476
|
|
|
1399
|
-
###
|
|
1477
|
+
### Entity schema generation now requires type definitions
|
|
1400
1478
|
|
|
1401
|
-
|
|
1479
|
+
`entityToJSONSchema` now requires a `typeStringDefinitions` argument at position 5, between `defaultIDType` and `collectionIDFieldTypes`. The old `opts: ConfigToJSONSchemaOptions` is replaced by an optional positional `forceInlineBlocks?: boolean` at the end.
|
|
1402
1480
|
|
|
1403
1481
|
```diff
|
|
1404
1482
|
entityToJSONSchema(
|
|
@@ -1414,7 +1492,7 @@ Inserted at position 5 (between `defaultIDType` and `collectionIDFieldTypes`). T
|
|
|
1414
1492
|
)
|
|
1415
1493
|
```
|
|
1416
1494
|
|
|
1417
|
-
### Lexical
|
|
1495
|
+
### Lexical nodes now provide their own JSON Schemas
|
|
1418
1496
|
|
|
1419
1497
|
`generatedTypes.modifyJSONSchema` on lexical features (and the sanitized `modifyJSONSchemas` array) is removed. Features now contribute per-node JSON Schemas via `createNode({ jsonSchema, node })` instead of mutating a whole-field schema after the fact. The editor composes per-node schemas into the field's union automatically.
|
|
1420
1498
|
|
|
@@ -1470,7 +1548,7 @@ The same rule applies to lexical block nodes — they now emit as `SerializedBlo
|
|
|
1470
1548
|
|
|
1471
1549
|
When two **different** blocks resolve to the same auto-derived name (same slug, different fields — e.g. a shared block overridden in one collection), the first keeps the clean name and any later block with a different shape gets a stable content-hash suffix (`Hero_3F2A1B0C`), so neither is silently mistyped. To choose the name yourself — or to resolve a collision with another type in your generated file (a collection, an array's `interfaceName`, etc.) — set an explicit `interfaceName` on the block. See [Block interface name collisions](/docs/typescript/generating-types#block-interface-name-collisions).
|
|
1472
1550
|
|
|
1473
|
-
###
|
|
1551
|
+
### Block references now share the blocks array
|
|
1474
1552
|
|
|
1475
1553
|
The `blockReferences` property on blocks fields has been removed. The `blocks` property now accepts both inline block configs and string slugs for blocks defined in the top-level Payload Config `blocks` array.
|
|
1476
1554
|
|
|
@@ -1501,7 +1579,7 @@ Inline blocks continue to work as before:
|
|
|
1501
1579
|
}
|
|
1502
1580
|
```
|
|
1503
1581
|
|
|
1504
|
-
### Lexical
|
|
1582
|
+
### Generated Lexical types are now strict
|
|
1505
1583
|
|
|
1506
1584
|
`richText` fields backed by `lexicalEditor` used to emit a permissive `{ [k: string]: unknown }` per field. They now emit a discriminated union of strict per-node interfaces (`SerializedTextNode`, `SerializedParagraphNode`, `SerializedHeadingNode`, `SerializedBlockNode`, etc.) under a hash-named alias like `LexicalNodes_AB12CD34`.
|
|
1507
1585
|
|
|
@@ -1532,7 +1610,7 @@ Element nodes are now generic over their `children`, and you pass the node union
|
|
|
1532
1610
|
|
|
1533
1611
|
`SerializedTextNode` is a leaf, so it stays bare. For the built-in nodes plus a few of your own, `WithDefaultNodes` threads the union for you - pass your custom node(s) as the generic (`type MyNodes = WithDefaultNodes<SerializedBlockNode<MyBlockData>>`), and they're usable anywhere a node can appear, not just at the top level. `DefaultTypedEditorState` with only built-in nodes needs no change.
|
|
1534
1612
|
|
|
1535
|
-
### Generated JSON Schema uses
|
|
1613
|
+
### Generated JSON Schema now uses modern definitions
|
|
1536
1614
|
|
|
1537
1615
|
Payload builds a JSON Schema from your config to generate `payload-types.ts`. That schema now stores its reusable types under the modern `$defs` key instead of the older `definitions` key, and every internal reference points at `#/$defs/...` instead of `#/definitions/...`. This follows the current JSON Schema spec.
|
|
1538
1616
|
|
|
@@ -1590,7 +1668,7 @@ jobs: {
|
|
|
1590
1668
|
|
|
1591
1669
|
Job documents can contain inputs, outputs, logs, and execution state, so avoid enabling write access unless your application specifically requires it.
|
|
1592
1670
|
|
|
1593
|
-
###
|
|
1671
|
+
### Job queries and hooks now have fixed behavior ([#16414](https://github.com/payloadcms/payload/pull/16414))
|
|
1594
1672
|
|
|
1595
1673
|
The deprecated `jobs.depth` and `jobs.runHooks` config options have been removed. Job operations now always use direct database calls with depth `0`.
|
|
1596
1674
|
|
|
@@ -1598,7 +1676,7 @@ If you relied on either option, remove it from your `jobs` config. If you depend
|
|
|
1598
1676
|
|
|
1599
1677
|
The `jobsCollectionOverrides` warning that detected extra hooks and prompted users to set `runHooks` has also been removed.
|
|
1600
1678
|
|
|
1601
|
-
###
|
|
1679
|
+
### The legacy base job type has been removed
|
|
1602
1680
|
|
|
1603
1681
|
The deprecated `BaseJob` type is no longer exported. Use `Job` everywhere you previously used `BaseJob`.
|
|
1604
1682
|
|
|
@@ -1656,9 +1734,9 @@ The deprecated `RunningJob` and `RunningJobSimple` types have also been removed.
|
|
|
1656
1734
|
|
|
1657
1735
|
JSON workflow steps without a `task` must now provide an `inlineTask` handler. This removes a type escape that previously allowed an incomplete step even though it could not run.
|
|
1658
1736
|
|
|
1659
|
-
###
|
|
1737
|
+
### Custom database adapters must support job claiming
|
|
1660
1738
|
|
|
1661
|
-
|
|
1739
|
+
Custom database adapters must now implement `updateJobs` so Payload can use a unique `processingToken` when claiming jobs and prevent multiple workers from running the same job. This adds an internal, nullable `processingToken` field to the `payload-jobs` collection. Existing SQL databases need a migration that adds this column. MongoDB does not require a migration.
|
|
1662
1740
|
|
|
1663
1741
|
The default `updateJobs` implementation has been removed because it could not safely claim jobs across multiple workers. If you maintain a custom database adapter, you must now provide `updateJobs`. It must only claim jobs that still match the provided `where` condition and, when a `processingToken` is provided, return only the jobs claimed with that token. The official Payload database adapters already implement this behavior.
|
|
1664
1742
|
|
|
@@ -1670,7 +1748,7 @@ Worker updates use a 30-second safety buffer by default, so an update only start
|
|
|
1670
1748
|
|
|
1671
1749
|
Existing SQL databases need a migration that replaces `processing` with the nullable, indexed `processingUntil` column. MongoDB does not require a migration.
|
|
1672
1750
|
|
|
1673
|
-
###
|
|
1751
|
+
### Job task results no longer include state ([#16416](https://github.com/payloadcms/payload/pull/16416))
|
|
1674
1752
|
|
|
1675
1753
|
Job task handlers and `inlineTask` callbacks can no longer use the `state` field to signal success or failure. Both shapes were deprecated in v3 and are now removed from tasks and inline tasks.
|
|
1676
1754
|
|
|
@@ -1695,7 +1773,7 @@ const myTask: TaskHandler<'MyTask'> = async ({ input }) => {
|
|
|
1695
1773
|
}
|
|
1696
1774
|
```
|
|
1697
1775
|
|
|
1698
|
-
###
|
|
1776
|
+
### Cron expressions now require explicit ranges ([#16546](https://github.com/payloadcms/payload/pull/16546))
|
|
1699
1777
|
|
|
1700
1778
|
The `sloppyRanges: true` setting that kept Croner v9 stepping syntax working after the v10 upgrade has been removed. Croner now enforces stricter cron parsing rules, so stepping expressions must use either `*` or an explicit range before the `/`.
|
|
1701
1779
|
|
|
@@ -1727,7 +1805,7 @@ Migrate any affected cron expressions:
|
|
|
1727
1805
|
+ cron: '30 * * * *'
|
|
1728
1806
|
```
|
|
1729
1807
|
|
|
1730
|
-
###
|
|
1808
|
+
### Relationship and upload limits now use row-based options ([#16547](https://github.com/payloadcms/payload/pull/16547))
|
|
1731
1809
|
|
|
1732
1810
|
The deprecated `min` and `max` properties have been removed from `relationship` and `upload` fields with `hasMany: true`. Use `minRows` and `maxRows` instead.
|
|
1733
1811
|
|
|
@@ -1746,7 +1824,7 @@ The deprecated `min` and `max` properties have been removed from `relationship`
|
|
|
1746
1824
|
|
|
1747
1825
|
The same change applies to `upload` fields with `hasMany: true`.
|
|
1748
1826
|
|
|
1749
|
-
###
|
|
1827
|
+
### Nested localized fields no longer need a compatibility flag ([#16693](https://github.com/payloadcms/payload/pull/16693))
|
|
1750
1828
|
|
|
1751
1829
|
`config.compatibility.allowLocalizedWithinLocalized` and the `PAYLOAD_DO_NOT_SANITIZE_LOCALIZED_PROPERTY` environment variable have been removed. Sanitize no longer strips `localized: true` from fields nested under a localized parent — `fieldShouldBeLocalized` decides this at runtime instead.
|
|
1752
1830
|
|
|
@@ -1760,7 +1838,7 @@ The same change applies to `upload` fields with `hasMany: true`.
|
|
|
1760
1838
|
- Remove the `compatibility` block from your config. If your MongoDB data still has the redundant nested-localized shape, flatten the config and run a data migration.
|
|
1761
1839
|
- Replace any direct `field.localized` reads in custom code with `fieldShouldBeLocalized({ field, parentIsLocalized })` from `payload/shared`.
|
|
1762
1840
|
|
|
1763
|
-
###
|
|
1841
|
+
### Publishing now defaults to the active locale
|
|
1764
1842
|
|
|
1765
1843
|
The Admin UI Publish button now always defaults to publishing only the active locale when a collection or global has localized fields and you have publish permission. "Publish all locales" is available as a secondary option in the Publish button's dropdown. This previously required opting in via `localization.defaultLocalePublishOption: 'active'`; the config option has been removed since active-locale-only is now the permanent default.
|
|
1766
1844
|
|
|
@@ -1782,7 +1860,7 @@ export default buildConfig({
|
|
|
1782
1860
|
|
|
1783
1861
|
Run `npx @payloadcms/codemod --transform remove-default-locale-publish-option` to remove the property automatically. The codemod surfaces a note for any config that had it set to `'all'`, since that combination previously changed the default and now has no config equivalent.
|
|
1784
1862
|
|
|
1785
|
-
### Storage adapters
|
|
1863
|
+
### Storage adapters have moved to top-level configuration ([#16596](https://github.com/payloadcms/payload/pull/16596))
|
|
1786
1864
|
|
|
1787
1865
|
Storage adapter packages (`@payloadcms/storage-s3`, `-azure`, `-gcs`, `-r2`, `-vercel-blob`) must now be placed under the top-level `storage` key in your Payload config instead of inside `plugins`.
|
|
1788
1866
|
|
|
@@ -1874,6 +1952,15 @@ File versioning adds a required `GeneratedAdapter.copyFile` method. Copy `from`
|
|
|
1874
1952
|
|
|
1875
1953
|
Replace `clientUploadContext` with `uploadReference` in generated file metadata and static handler parameters. `handleUpload` no longer receives it because Payload skips uploading files that are already stored.
|
|
1876
1954
|
|
|
1955
|
+
Payload keeps only `_objectKey`, `prefix`, and `signedReceipt` at the top level of `uploadReference`, plus signed `adapterData` when `requiresUploadReceipt` is set. Read any other field your adapter or client added from `uploadReference.clientData`:
|
|
1956
|
+
|
|
1957
|
+
```diff
|
|
1958
|
+
- const objectID = uploadReference.providerObjectID
|
|
1959
|
+
+ const objectID = uploadReference.clientData?.providerObjectID
|
|
1960
|
+
```
|
|
1961
|
+
|
|
1962
|
+
`clientData` is not verified. To trust a value, sign it into the upload receipt as `adapterData` instead. See [Upload receipts](../upload/storage-adapters#custom-upload-receipts).
|
|
1963
|
+
|
|
1877
1964
|
Set `uploadInstructions.enabled`. When false, Payload adds `adminHandler` to the import map without rendering it. When true, Payload also renders it and exposes the instructions and supporting endpoint.
|
|
1878
1965
|
|
|
1879
1966
|
Move access checks into the generator or supporting endpoint that authorizes the upload:
|
|
@@ -1954,7 +2041,7 @@ uploadInstructions: {
|
|
|
1954
2041
|
|
|
1955
2042
|
Both are optional. Custom handler props are now passed as `props`, and the supporting route is available as `endpointPath` instead of `serverHandlerPath`. The old Admin component `enabled` prop was removed.
|
|
1956
2043
|
|
|
1957
|
-
###
|
|
2044
|
+
### The Uploadthing storage adapter has been removed
|
|
1958
2045
|
|
|
1959
2046
|
The Uploadthing storage adapter, deprecated in a previous release, has been deleted and will no longer be published. Migrate to another storage adapter such as `@payloadcms/storage-s3` before upgrading to 4.0.
|
|
1960
2047
|
|
|
@@ -2009,7 +2096,7 @@ azureStorage({
|
|
|
2009
2096
|
|
|
2010
2097
|
Run `npx @payloadcms/codemod --transform migrate-azure-chunk-large-files` to remove the flag automatically (it collapses `clientUploads: { chunkLargeFiles: true }` to `clientUploads: true` and keeps any other `clientUploads` options).
|
|
2011
2098
|
|
|
2012
|
-
### Sharp
|
|
2099
|
+
### Sharp is now an optional file transformer #sharp-moved-out-of-core-into-payloadcmstransformer-sharp
|
|
2013
2100
|
|
|
2014
2101
|
Image resizing is no longer built into `payload` itself. It now ships as an official [file transformer](../upload/transformers), `@payloadcms/transformer-sharp`, that you register under `upload.transformers`.
|
|
2015
2102
|
|
|
@@ -2069,7 +2156,7 @@ If you inject a custom Sharp build or version, pass it the same way:
|
|
|
2069
2156
|
|
|
2070
2157
|
`sharpTransformer` can also resize images at request time (`/api/media/file/photo.png?width=400`). This is new in Payload 4 and **disabled by default**, so a migrated config keeps serving only the original file and your pre-generated `variants`. The codemod doesn't enable it. To opt in, pass `dynamic: true` or `dynamic: { collections: ['media'] }` — see [Dynamic (request-time) resizing](../upload/transformers#dynamic-request-time-resizing), and [Securing dynamic resizing](../upload/transformers#securing-dynamic-resizing) before enabling it on a publicly readable collection.
|
|
2071
2158
|
|
|
2072
|
-
####
|
|
2159
|
+
#### Upload image data now uses variants
|
|
2073
2160
|
|
|
2074
2161
|
The group field that holds each generated image size on an upload document is now `variants` instead of `sizes`. Every place that reads or queries it changes:
|
|
2075
2162
|
|
|
@@ -2129,7 +2216,7 @@ Registering any transformer under `upload.transformers` — including `sharpTran
|
|
|
2129
2216
|
|
|
2130
2217
|
To link to a file from your own code, including with transformer query parameters, use the new `generatePayloadFileURL` helper (exported from `payload` and `payload/shared`). It always builds the access-controlled Payload file endpoint, so links never bypass `access.read` by pointing straight at storage.
|
|
2131
2218
|
|
|
2132
|
-
### Storage
|
|
2219
|
+
### Storage prefixes are now always included
|
|
2133
2220
|
|
|
2134
2221
|
The `alwaysInsertFields` option (on `cloudStoragePlugin` and every `storage-*` adapter: `-s3`, `-azure`, `-gcs`, `-r2`, `-vercel-blob`) has been removed. The behavior it used to opt into — always inserting the hidden `prefix` field into the collection schema — is now unconditional, so the schema stays consistent whether or not a collection configures a `prefix` and whether or not the plugin is `enabled`.
|
|
2135
2222
|
|
|
@@ -2146,11 +2233,27 @@ The `alwaysInsertFields` option (on `cloudStoragePlugin` and every `storage-*` a
|
|
|
2146
2233
|
|
|
2147
2234
|
### Upload collections retain originals and file history
|
|
2148
2235
|
|
|
2149
|
-
Upload collections now store `original` metadata and a `prefix` and `_objectKey` for each stored file (the main file, `original`, and each variant), so saved versions can find their files. New uploads keep their
|
|
2236
|
+
Upload collections now store `original` metadata and a `prefix` and `_objectKey` for each stored file (the main file, `original`, and each variant), so saved versions can find their files. New uploads keep their uploaded filename. With a storage adapter, each new file is stored under its own `_objectKey` folder, so update any code or infrastructure that relies on the old object key. When a processed main file and its original share a filename, request the original with `?original=true`; `original.url` already includes it. With local storage, the original gets a counter name instead (for example `photo-1.png`). Files saved by earlier v4 beta releases with an `-original` filename keep that name and are still served. Custom storage adapters should handle the new `params.isOriginal` in `staticHandler`; see [Custom Storage Adapters](../upload/storage-adapters#custom-storage-adapters).
|
|
2150
2237
|
|
|
2151
2238
|
**Postgres and SQLite:** after updating, run `payload migrate:create`, check that it adds these columns to each upload collection table and its versions table, then run `payload migrate`. Existing rows keep `null` values until their next write.
|
|
2152
2239
|
|
|
2153
|
-
###
|
|
2240
|
+
### Upload collections save crop and focal point edits in `_transforms`
|
|
2241
|
+
|
|
2242
|
+
Upload collections now have a `_transforms` JSON field that saves the crop and focal point, so an edit can start again from the retained original. See [Saved crop and focal point](../upload/overview#saved-crop-and-focal-point).
|
|
2243
|
+
|
|
2244
|
+
- `_transforms` is a reserved field name on upload collections. If an upload collection defines its own field named `_transforms`, rename it and move its data before you update.
|
|
2245
|
+
- `focalX` and `focalY` stay available and match `_transforms.focalPoint` when it is set. For a document saved before `_transforms` existed, the first write that saves `_transforms` copies its focal point into `_transforms`.
|
|
2246
|
+
- Replacing the file now sets `focalX` and `focalY` to the center, unless the request sends a new focal point. Before, the old values stayed on the document, but the new image sizes did not use them.
|
|
2247
|
+
|
|
2248
|
+
**Postgres and SQLite:** run `payload migrate:create`, check that it adds a `_transforms` column to each upload collection table and its versions table, then run `payload migrate`. Existing rows keep `null` until their next write.
|
|
2249
|
+
|
|
2250
|
+
Upload collections also have a core-controlled `_stored` field on the main file, on `original`, and on each entry under `variants`. A value of `false` marks an entry with no stored object. A missing or `null` value means stored, so existing documents need no data backfill. Payload ignores client writes to this field. It is hidden in the Admin Panel, but can appear in API responses; it is not a field-level hidden value. See [Files with no stored default](../upload/transformers#files-with-no-stored-default).
|
|
2251
|
+
|
|
2252
|
+
`_stored` is now reserved for these file entries. If an upload collection already defines a custom `_stored` field, rename it and move its data, including data in saved versions, before upgrading. Remove the old custom values from `_stored`: existing `false` values would otherwise be treated as files with no stored object, and writes to the custom field would be ignored.
|
|
2253
|
+
|
|
2254
|
+
**Postgres and SQLite:** run `payload migrate:create`, check that it adds the `_stored` columns for file entries in each upload collection and its versions, then run `payload migrate`. Existing rows keep `null`.
|
|
2255
|
+
|
|
2256
|
+
### File size types have been consolidated ([#16593](https://github.com/payloadcms/payload/pull/16593))
|
|
2154
2257
|
|
|
2155
2258
|
`FileSizeImproved` has been merged into `FileSize`. The `url`, `width`, `height`, `filesize`, `mimeType`, and `filename` properties now accept `null` directly on `FileSize`, matching what the database stores for sizes that were not generated.
|
|
2156
2259
|
|
|
@@ -2159,9 +2262,9 @@ Upload collections now store `original` metadata and a `prefix` and `_objectKey`
|
|
|
2159
2262
|
+ import type { FileSize } from 'payload'
|
|
2160
2263
|
```
|
|
2161
2264
|
|
|
2162
|
-
###
|
|
2265
|
+
### Image size admin controls have been consolidated ([#16593](https://github.com/payloadcms/payload/pull/16593))
|
|
2163
2266
|
|
|
2164
|
-
The
|
|
2267
|
+
The `disableListColumn`, `disableListFilter`, and `disableGroupBy` properties under `ImageSize.admin` have been replaced with a single `disabled` object, consistent with the shape used by all other fields.
|
|
2165
2268
|
|
|
2166
2269
|
```diff
|
|
2167
2270
|
{
|
|
@@ -2178,7 +2281,7 @@ The three individual boolean props have been replaced with a single `disabled` o
|
|
|
2178
2281
|
|
|
2179
2282
|
Run `npx @payloadcms/codemod --transform migrate-disabled-fields` to migrate automatically.
|
|
2180
2283
|
|
|
2181
|
-
###
|
|
2284
|
+
### MongoDB queries no longer use facet aggregation ([#16612](https://github.com/payloadcms/payload/pull/16612))
|
|
2182
2285
|
|
|
2183
2286
|
The `useFacet` option in `mongooseAdapter` config has been removed. Payload no longer uses `$facet` aggregation, so the option has no effect.
|
|
2184
2287
|
|
|
@@ -2190,7 +2293,7 @@ The `useFacet` option in `mongooseAdapter` config has been removed. Payload no l
|
|
|
2190
2293
|
})
|
|
2191
2294
|
```
|
|
2192
2295
|
|
|
2193
|
-
###
|
|
2296
|
+
### Search plugin API paths are now derived automatically ([#16597](https://github.com/payloadcms/payload/pull/16597))
|
|
2194
2297
|
|
|
2195
2298
|
The deprecated `apiBasePath` option on the search plugin has been removed. The plugin now derives the correct path from the root config automatically.
|
|
2196
2299
|
|
|
@@ -2202,7 +2305,7 @@ The sha1 HMAC fallback for API key authentication has been removed. API keys are
|
|
|
2202
2305
|
|
|
2203
2306
|
**How to migrate:** Open the user document for each affected API key holder and save it — this regenerates the key under sha256. Alternatively, generate a new API key from the admin panel.
|
|
2204
2307
|
|
|
2205
|
-
###
|
|
2308
|
+
### API key fields now use a factory
|
|
2206
2309
|
|
|
2207
2310
|
The `baseAPIKeyFields` export from `payload` has been removed. Use `createAPIKeyFields()` instead. It returns the same default auth API key storage fields, and also accepts overrides for projects or plugins that need to customize the generated field configs.
|
|
2208
2311
|
|
|
@@ -2231,9 +2334,9 @@ createAPIKeyFields({
|
|
|
2231
2334
|
})
|
|
2232
2335
|
```
|
|
2233
2336
|
|
|
2234
|
-
###
|
|
2337
|
+
### MCP plugin configuration and authentication have changed
|
|
2235
2338
|
|
|
2236
|
-
|
|
2339
|
+
`@payloadcms/plugin-mcp` has a new public config API, built-in tool inputs, and API-key authentication flow. Update your plugin config and recreate MCP credentials as user API keys.
|
|
2237
2340
|
|
|
2238
2341
|
**Collections and globals are now opt-out.** Drop the `enabled` flag. Every collection and global is exposed by default through the generic built-in tools. For collections, this includes tools like `getCollectionSchema`, `findDocuments`, `countDocuments`, `createDocuments`, `updateDocument`, `deleteDocuments`, `duplicateDocument`, and `findDistinct`, plus version tools when versions are enabled. For globals, this includes `getGlobalSchema`, `findGlobal`, and `updateGlobal`, plus version tools when versions are enabled. Turn individual operations off via simple config keys like `tools: { create: false }`.
|
|
2239
2342
|
|
|
@@ -2406,7 +2509,7 @@ By default, MCP items require an authenticated user. Built-in collection and glo
|
|
|
2406
2509
|
|
|
2407
2510
|
**HTTP requests have a size limit.** `POST /api/mcp` now answers request bodies over 4 MiB with `413`. Base64 file uploads count toward this limit. Raise it with `mcp.maxRequestBodySize`.
|
|
2408
2511
|
|
|
2409
|
-
###
|
|
2512
|
+
### Admin UI styles now use CSS and semantic tokens
|
|
2410
2513
|
|
|
2411
2514
|
The Admin UI styles were migrated from SCSS to plain CSS. The `@payloadcms/ui/scss` package export and its SCSS source files have been removed, and the legacy `--theme-*` CSS variables were retired in favor of semantic `--color-*` tokens and the raw `--ramp-*` color palette.
|
|
2412
2515
|
|
|
@@ -2482,7 +2585,7 @@ If you previously used `rest: false`, remove the property; omitting `rest` disab
|
|
|
2482
2585
|
- `hasAPIKey` (3.x virtual field) is removed. Use `apiKeyLast4` and `docPermissions.fields.apiKey`.
|
|
2483
2586
|
- Custom `access.read` on the generated `apiKey` field is inert — reads are hardcoded to deny.
|
|
2484
2587
|
|
|
2485
|
-
###
|
|
2588
|
+
### Uploads now reject oversized files by default
|
|
2486
2589
|
|
|
2487
2590
|
The Payload-wide [`upload.abortOnLimit`](../upload/overview#payload-wide-upload-options) option now defaults to `true`. A file that is bigger than the configured `fileSize` limit now returns an HTTP 413 error by default. Previously, the file was truncated to the limit without any error, and the upload continued.
|
|
2488
2591
|
|
|
@@ -2498,3 +2601,19 @@ export default buildConfig({
|
|
|
2498
2601
|
},
|
|
2499
2602
|
})
|
|
2500
2603
|
```
|
|
2604
|
+
|
|
2605
|
+
### Nodemailer adapter now uses nodemailer 10 ([#18737](https://github.com/payloadcms/payload/pull/18737))
|
|
2606
|
+
|
|
2607
|
+
`@payloadcms/email-nodemailer` now depends on nodemailer 10, which ships its own types. If you pass your own `transport` created with nodemailer 9, it no longer type-checks against the adapter. Upgrade `nodemailer` and remove `@types/nodemailer`:
|
|
2608
|
+
|
|
2609
|
+
```diff
|
|
2610
|
+
"dependencies": {
|
|
2611
|
+
- "nodemailer": "^9.1.1"
|
|
2612
|
+
+ "nodemailer": "^10.1.1"
|
|
2613
|
+
},
|
|
2614
|
+
"devDependencies": {
|
|
2615
|
+
- "@types/nodemailer": "^8.0.0"
|
|
2616
|
+
}
|
|
2617
|
+
```
|
|
2618
|
+
|
|
2619
|
+
If you use `transportOptions`, or pass no config, no changes are needed.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/transforms/migrate-displayed-field-value-args/basic.input.ts"],"sourcesContent":["import { getDisplayedFieldValue as display } from '@payloadcms/ui/utilities/getDisplayedFieldValue'\n\nconst result = display(fileSize, field, i18n)\n"],"names":["getDisplayedFieldValue","display","result","fileSize","field","i18n"],"mappings":"AAAA,SAASA,0BAA0BC,OAAO,QAAQ,kDAAiD;AAEnG,MAAMC,SAASD,QAAQE,UAAUC,OAAOC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/transforms/migrate-displayed-field-value-args/basic.output.ts"],"sourcesContent":["import { getDisplayedFieldValue as display } from '@payloadcms/ui/utilities/getDisplayedFieldValue'\n\nconst result = display({ cellData: fileSize, field: field, i18n: i18n })\n"],"names":["getDisplayedFieldValue","display","result","cellData","fileSize","field","i18n"],"mappings":"AAAA,SAASA,0BAA0BC,OAAO,QAAQ,kDAAiD;AAEnG,MAAMC,SAASD,QAAQ;IAAEE,UAAUC;IAAUC,OAAOA;IAAOC,MAAMA;AAAK"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/transforms/migrate-displayed-field-value-args/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAK/C,eAAO,MAAM,8BAA8B,EAAE,SA+D5C,CAAA"}
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { Node } from 'ts-morph';
|
|
2
|
+
const moduleName = '@payloadcms/ui/utilities/getDisplayedFieldValue';
|
|
3
|
+
const functionName = 'getDisplayedFieldValue';
|
|
4
|
+
export const migrateDisplayedFieldValueArgs = {
|
|
5
|
+
name: 'migrate-displayed-field-value-args',
|
|
6
|
+
apply: ({ project })=>{
|
|
7
|
+
const filesChanged = [];
|
|
8
|
+
const notes = [];
|
|
9
|
+
for (const file of project.getSourceFiles()){
|
|
10
|
+
const calls = new Set();
|
|
11
|
+
for (const declaration of file.getImportDeclarations()){
|
|
12
|
+
if (declaration.getModuleSpecifierValue() !== moduleName) {
|
|
13
|
+
continue;
|
|
14
|
+
}
|
|
15
|
+
for (const specifier of declaration.getNamedImports()){
|
|
16
|
+
if (specifier.getName() !== functionName || specifier.isTypeOnly()) {
|
|
17
|
+
continue;
|
|
18
|
+
}
|
|
19
|
+
const localName = specifier.getAliasNode() ?? specifier.getNameNode();
|
|
20
|
+
if (Node.isIdentifier(localName)) {
|
|
21
|
+
collectCalls({
|
|
22
|
+
calls,
|
|
23
|
+
localName,
|
|
24
|
+
notes
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
const namespace = declaration.getNamespaceImport();
|
|
29
|
+
if (namespace) {
|
|
30
|
+
collectCalls({
|
|
31
|
+
calls,
|
|
32
|
+
isNamespace: true,
|
|
33
|
+
localName: namespace,
|
|
34
|
+
notes
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
const original = file.getFullText();
|
|
39
|
+
for (const call of [
|
|
40
|
+
...calls
|
|
41
|
+
].sort((a, b)=>b.getStart() - a.getStart())){
|
|
42
|
+
const args = call.getArguments();
|
|
43
|
+
if (args.length === 1 && Node.isObjectLiteralExpression(args[0])) {
|
|
44
|
+
continue;
|
|
45
|
+
}
|
|
46
|
+
if (args.length !== 3 || args.some(Node.isSpreadElement)) {
|
|
47
|
+
notes.push(`${file.getFilePath()}:${call.getStartLineNumber()}: ${call.getText()} has unsupported arguments; migrate manually.`);
|
|
48
|
+
continue;
|
|
49
|
+
}
|
|
50
|
+
call.replaceWithText(`${call.getExpression().getText()}({ cellData: ${args[0].getText()}, field: ${args[1].getText()}, i18n: ${args[2].getText()} })`);
|
|
51
|
+
}
|
|
52
|
+
if (file.getFullText() !== original) {
|
|
53
|
+
filesChanged.push(file.getFilePath());
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
return {
|
|
57
|
+
filesChanged,
|
|
58
|
+
...notes.length > 0 ? {
|
|
59
|
+
notes
|
|
60
|
+
} : {}
|
|
61
|
+
};
|
|
62
|
+
},
|
|
63
|
+
description: 'Migrates `getDisplayedFieldValue(cellData, field, i18n)` calls imported from `@payloadcms/ui/utilities/getDisplayedFieldValue` to object arguments.'
|
|
64
|
+
};
|
|
65
|
+
function collectCalls({ calls, isNamespace = false, localName, notes }) {
|
|
66
|
+
for (const reference of localName.findReferencesAsNodes()){
|
|
67
|
+
if (reference === localName) {
|
|
68
|
+
continue;
|
|
69
|
+
}
|
|
70
|
+
const parent = reference.getParent();
|
|
71
|
+
const expression = isNamespace ? Node.isPropertyAccessExpression(parent) && parent.getExpression() === reference && parent.getName() === functionName ? parent : undefined : reference;
|
|
72
|
+
if (!expression) {
|
|
73
|
+
continue;
|
|
74
|
+
}
|
|
75
|
+
const call = expression.getParent();
|
|
76
|
+
if (Node.isCallExpression(call) && call.getExpression() === expression) {
|
|
77
|
+
calls.add(call);
|
|
78
|
+
} else {
|
|
79
|
+
notes.push(`${reference.getSourceFile().getFilePath()}:${reference.getStartLineNumber()}: ${expression.getText()} is referenced without a direct call; migrate manually.`);
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/transforms/migrate-displayed-field-value-args/index.ts"],"sourcesContent":["import type { CallExpression, Identifier } from 'ts-morph'\n\nimport { Node } from 'ts-morph'\n\nimport type { Transform } from '../../types.js'\n\nconst moduleName = '@payloadcms/ui/utilities/getDisplayedFieldValue'\nconst functionName = 'getDisplayedFieldValue'\n\nexport const migrateDisplayedFieldValueArgs: Transform = {\n name: 'migrate-displayed-field-value-args',\n apply: ({ project }) => {\n const filesChanged: string[] = []\n const notes: string[] = []\n\n for (const file of project.getSourceFiles()) {\n const calls = new Set<CallExpression>()\n\n for (const declaration of file.getImportDeclarations()) {\n if (declaration.getModuleSpecifierValue() !== moduleName) {\n continue\n }\n\n for (const specifier of declaration.getNamedImports()) {\n if (specifier.getName() !== functionName || specifier.isTypeOnly()) {\n continue\n }\n\n const localName = specifier.getAliasNode() ?? specifier.getNameNode()\n\n if (Node.isIdentifier(localName)) {\n collectCalls({ calls, localName, notes })\n }\n }\n\n const namespace = declaration.getNamespaceImport()\n\n if (namespace) {\n collectCalls({ calls, isNamespace: true, localName: namespace, notes })\n }\n }\n\n const original = file.getFullText()\n\n for (const call of [...calls].sort((a, b) => b.getStart() - a.getStart())) {\n const args = call.getArguments()\n\n if (args.length === 1 && Node.isObjectLiteralExpression(args[0])) {\n continue\n }\n\n if (args.length !== 3 || args.some(Node.isSpreadElement)) {\n notes.push(\n `${file.getFilePath()}:${call.getStartLineNumber()}: ${call.getText()} has unsupported arguments; migrate manually.`,\n )\n continue\n }\n\n call.replaceWithText(\n `${call.getExpression().getText()}({ cellData: ${args[0]!.getText()}, field: ${args[1]!.getText()}, i18n: ${args[2]!.getText()} })`,\n )\n }\n\n if (file.getFullText() !== original) {\n filesChanged.push(file.getFilePath())\n }\n }\n\n return { filesChanged, ...(notes.length > 0 ? { notes } : {}) }\n },\n description:\n 'Migrates `getDisplayedFieldValue(cellData, field, i18n)` calls imported from `@payloadcms/ui/utilities/getDisplayedFieldValue` to object arguments.',\n}\n\nfunction collectCalls({\n calls,\n isNamespace = false,\n localName,\n notes,\n}: {\n calls: Set<CallExpression>\n isNamespace?: boolean\n localName: Identifier\n notes: string[]\n}): void {\n for (const reference of localName.findReferencesAsNodes()) {\n if (reference === localName) {\n continue\n }\n\n const parent = reference.getParent()\n const expression = isNamespace\n ? Node.isPropertyAccessExpression(parent) &&\n parent.getExpression() === reference &&\n parent.getName() === functionName\n ? parent\n : undefined\n : reference\n\n if (!expression) {\n continue\n }\n\n const call = expression.getParent()\n\n if (Node.isCallExpression(call) && call.getExpression() === expression) {\n calls.add(call)\n } else {\n notes.push(\n `${reference.getSourceFile().getFilePath()}:${reference.getStartLineNumber()}: ${expression.getText()} is referenced without a direct call; migrate manually.`,\n )\n }\n }\n}\n"],"names":["Node","moduleName","functionName","migrateDisplayedFieldValueArgs","name","apply","project","filesChanged","notes","file","getSourceFiles","calls","Set","declaration","getImportDeclarations","getModuleSpecifierValue","specifier","getNamedImports","getName","isTypeOnly","localName","getAliasNode","getNameNode","isIdentifier","collectCalls","namespace","getNamespaceImport","isNamespace","original","getFullText","call","sort","a","b","getStart","args","getArguments","length","isObjectLiteralExpression","some","isSpreadElement","push","getFilePath","getStartLineNumber","getText","replaceWithText","getExpression","description","reference","findReferencesAsNodes","parent","getParent","expression","isPropertyAccessExpression","undefined","isCallExpression","add","getSourceFile"],"mappings":"AAEA,SAASA,IAAI,QAAQ,WAAU;AAI/B,MAAMC,aAAa;AACnB,MAAMC,eAAe;AAErB,OAAO,MAAMC,iCAA4C;IACvDC,MAAM;IACNC,OAAO,CAAC,EAAEC,OAAO,EAAE;QACjB,MAAMC,eAAyB,EAAE;QACjC,MAAMC,QAAkB,EAAE;QAE1B,KAAK,MAAMC,QAAQH,QAAQI,cAAc,GAAI;YAC3C,MAAMC,QAAQ,IAAIC;YAElB,KAAK,MAAMC,eAAeJ,KAAKK,qBAAqB,GAAI;gBACtD,IAAID,YAAYE,uBAAuB,OAAOd,YAAY;oBACxD;gBACF;gBAEA,KAAK,MAAMe,aAAaH,YAAYI,eAAe,GAAI;oBACrD,IAAID,UAAUE,OAAO,OAAOhB,gBAAgBc,UAAUG,UAAU,IAAI;wBAClE;oBACF;oBAEA,MAAMC,YAAYJ,UAAUK,YAAY,MAAML,UAAUM,WAAW;oBAEnE,IAAItB,KAAKuB,YAAY,CAACH,YAAY;wBAChCI,aAAa;4BAAEb;4BAAOS;4BAAWZ;wBAAM;oBACzC;gBACF;gBAEA,MAAMiB,YAAYZ,YAAYa,kBAAkB;gBAEhD,IAAID,WAAW;oBACbD,aAAa;wBAAEb;wBAAOgB,aAAa;wBAAMP,WAAWK;wBAAWjB;oBAAM;gBACvE;YACF;YAEA,MAAMoB,WAAWnB,KAAKoB,WAAW;YAEjC,KAAK,MAAMC,QAAQ;mBAAInB;aAAM,CAACoB,IAAI,CAAC,CAACC,GAAGC,IAAMA,EAAEC,QAAQ,KAAKF,EAAEE,QAAQ,IAAK;gBACzE,MAAMC,OAAOL,KAAKM,YAAY;gBAE9B,IAAID,KAAKE,MAAM,KAAK,KAAKrC,KAAKsC,yBAAyB,CAACH,IAAI,CAAC,EAAE,GAAG;oBAChE;gBACF;gBAEA,IAAIA,KAAKE,MAAM,KAAK,KAAKF,KAAKI,IAAI,CAACvC,KAAKwC,eAAe,GAAG;oBACxDhC,MAAMiC,IAAI,CACR,GAAGhC,KAAKiC,WAAW,GAAG,CAAC,EAAEZ,KAAKa,kBAAkB,GAAG,EAAE,EAAEb,KAAKc,OAAO,GAAG,6CAA6C,CAAC;oBAEtH;gBACF;gBAEAd,KAAKe,eAAe,CAClB,GAAGf,KAAKgB,aAAa,GAAGF,OAAO,GAAG,aAAa,EAAET,IAAI,CAAC,EAAE,CAAES,OAAO,GAAG,SAAS,EAAET,IAAI,CAAC,EAAE,CAAES,OAAO,GAAG,QAAQ,EAAET,IAAI,CAAC,EAAE,CAAES,OAAO,GAAG,GAAG,CAAC;YAEvI;YAEA,IAAInC,KAAKoB,WAAW,OAAOD,UAAU;gBACnCrB,aAAakC,IAAI,CAAChC,KAAKiC,WAAW;YACpC;QACF;QAEA,OAAO;YAAEnC;YAAc,GAAIC,MAAM6B,MAAM,GAAG,IAAI;gBAAE7B;YAAM,IAAI,CAAC,CAAC;QAAE;IAChE;IACAuC,aACE;AACJ,EAAC;AAED,SAASvB,aAAa,EACpBb,KAAK,EACLgB,cAAc,KAAK,EACnBP,SAAS,EACTZ,KAAK,EAMN;IACC,KAAK,MAAMwC,aAAa5B,UAAU6B,qBAAqB,GAAI;QACzD,IAAID,cAAc5B,WAAW;YAC3B;QACF;QAEA,MAAM8B,SAASF,UAAUG,SAAS;QAClC,MAAMC,aAAazB,cACf3B,KAAKqD,0BAA0B,CAACH,WAChCA,OAAOJ,aAAa,OAAOE,aAC3BE,OAAOhC,OAAO,OAAOhB,eACnBgD,SACAI,YACFN;QAEJ,IAAI,CAACI,YAAY;YACf;QACF;QAEA,MAAMtB,OAAOsB,WAAWD,SAAS;QAEjC,IAAInD,KAAKuD,gBAAgB,CAACzB,SAASA,KAAKgB,aAAa,OAAOM,YAAY;YACtEzC,MAAM6C,GAAG,CAAC1B;QACZ,OAAO;YACLtB,MAAMiC,IAAI,CACR,GAAGO,UAAUS,aAAa,GAAGf,WAAW,GAAG,CAAC,EAAEM,UAAUL,kBAAkB,GAAG,EAAE,EAAES,WAAWR,OAAO,GAAG,uDAAuD,CAAC;QAElK;IACF;AACF"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/transforms/migrate-displayed-field-value-args/namespace.input.ts"],"sourcesContent":["import * as display from '@payloadcms/ui/utilities/getDisplayedFieldValue'\n\nconst result = display.getDisplayedFieldValue(fileSize, field, i18n)\n"],"names":["display","result","getDisplayedFieldValue","fileSize","field","i18n"],"mappings":"AAAA,YAAYA,aAAa,kDAAiD;AAE1E,MAAMC,SAASD,QAAQE,sBAAsB,CAACC,UAAUC,OAAOC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/transforms/migrate-displayed-field-value-args/namespace.output.ts"],"sourcesContent":["import * as display from '@payloadcms/ui/utilities/getDisplayedFieldValue'\n\nconst result = display.getDisplayedFieldValue({ cellData: fileSize, field: field, i18n: i18n })\n"],"names":["display","result","getDisplayedFieldValue","cellData","fileSize","field","i18n"],"mappings":"AAAA,YAAYA,aAAa,kDAAiD;AAE1E,MAAMC,SAASD,QAAQE,sBAAsB,CAAC;IAAEC,UAAUC;IAAUC,OAAOA;IAAOC,MAAMA;AAAK"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/transforms/migrate-displayed-field-value-args/no-match.input.ts"],"sourcesContent":["import { getDisplayedFieldValue } from './local-display.js'\n\nconst result = getDisplayedFieldValue(fileSize, field, i18n)\n"],"names":["getDisplayedFieldValue","result","fileSize","field","i18n"],"mappings":"AAAA,SAASA,sBAAsB,QAAQ,qBAAoB;AAE3D,MAAMC,SAASD,uBAAuBE,UAAUC,OAAOC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../../../src/transforms/migrate-displayed-field-value-args/no-match.output.ts"],"sourcesContent":["import { getDisplayedFieldValue } from './local-display.js'\n\nconst result = getDisplayedFieldValue(fileSize, field, i18n)\n"],"names":["getDisplayedFieldValue","result","fileSize","field","i18n"],"mappings":"AAAA,SAASA,sBAAsB,QAAQ,qBAAoB;AAE3D,MAAMC,SAASD,uBAAuBE,UAAUC,OAAOC"}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* the monorepo (this one included) is versioned and published in lockstep, so
|
|
4
4
|
* the dist-tag the codemod was invoked under (`npx @payloadcms/codemod@beta`)
|
|
5
5
|
* surfaces as its own version's prerelease id. Follow that train; fall back to
|
|
6
|
-
*
|
|
6
|
+
* beta for stable or local dev builds that carry no prerelease id.
|
|
7
7
|
*/
|
|
8
8
|
export declare function resolveDefaultTag(version?: string | undefined): string;
|
|
9
9
|
//# sourceMappingURL=defaultTag.d.ts.map
|
|
@@ -2,13 +2,13 @@ import { readFileSync } from 'node:fs';
|
|
|
2
2
|
import { dirname, resolve } from 'node:path';
|
|
3
3
|
import { fileURLToPath } from 'node:url';
|
|
4
4
|
import semver from 'semver';
|
|
5
|
-
/** Dist-tag used when neither --tag nor the running version implies one. */ const FALLBACK_TAG = '
|
|
5
|
+
/** Dist-tag used when neither --tag nor the running version implies one. */ const FALLBACK_TAG = 'beta';
|
|
6
6
|
/**
|
|
7
7
|
* Default Payload dist-tag when the caller did not pass --tag. Every package in
|
|
8
8
|
* the monorepo (this one included) is versioned and published in lockstep, so
|
|
9
9
|
* the dist-tag the codemod was invoked under (`npx @payloadcms/codemod@beta`)
|
|
10
10
|
* surfaces as its own version's prerelease id. Follow that train; fall back to
|
|
11
|
-
*
|
|
11
|
+
* beta for stable or local dev builds that carry no prerelease id.
|
|
12
12
|
*/ export function resolveDefaultTag(version = readOwnVersion()) {
|
|
13
13
|
const id = version ? semver.prerelease(version)?.[0] : undefined;
|
|
14
14
|
return typeof id === 'string' ? id : FALLBACK_TAG;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/upgrade/defaultTag.ts"],"sourcesContent":["import { readFileSync } from 'node:fs'\nimport { dirname, resolve } from 'node:path'\nimport { fileURLToPath } from 'node:url'\nimport semver from 'semver'\n\n/** Dist-tag used when neither --tag nor the running version implies one. */\nconst FALLBACK_TAG = '
|
|
1
|
+
{"version":3,"sources":["../../src/upgrade/defaultTag.ts"],"sourcesContent":["import { readFileSync } from 'node:fs'\nimport { dirname, resolve } from 'node:path'\nimport { fileURLToPath } from 'node:url'\nimport semver from 'semver'\n\n/** Dist-tag used when neither --tag nor the running version implies one. */\nconst FALLBACK_TAG = 'beta'\n\n/**\n * Default Payload dist-tag when the caller did not pass --tag. Every package in\n * the monorepo (this one included) is versioned and published in lockstep, so\n * the dist-tag the codemod was invoked under (`npx @payloadcms/codemod@beta`)\n * surfaces as its own version's prerelease id. Follow that train; fall back to\n * beta for stable or local dev builds that carry no prerelease id.\n */\nexport function resolveDefaultTag(version: string | undefined = readOwnVersion()): string {\n const id = version ? semver.prerelease(version)?.[0] : undefined\n return typeof id === 'string' ? id : FALLBACK_TAG\n}\n\nfunction readOwnVersion(): string | undefined {\n try {\n const pkgPath = resolve(dirname(fileURLToPath(import.meta.url)), '..', '..', 'package.json')\n return JSON.parse(readFileSync(pkgPath, 'utf8')).version as string\n } catch {\n return undefined\n }\n}\n"],"names":["readFileSync","dirname","resolve","fileURLToPath","semver","FALLBACK_TAG","resolveDefaultTag","version","readOwnVersion","id","prerelease","undefined","pkgPath","url","JSON","parse"],"mappings":"AAAA,SAASA,YAAY,QAAQ,UAAS;AACtC,SAASC,OAAO,EAAEC,OAAO,QAAQ,YAAW;AAC5C,SAASC,aAAa,QAAQ,WAAU;AACxC,OAAOC,YAAY,SAAQ;AAE3B,0EAA0E,GAC1E,MAAMC,eAAe;AAErB;;;;;;CAMC,GACD,OAAO,SAASC,kBAAkBC,UAA8BC,gBAAgB;IAC9E,MAAMC,KAAKF,UAAUH,OAAOM,UAAU,CAACH,UAAU,CAAC,EAAE,GAAGI;IACvD,OAAO,OAAOF,OAAO,WAAWA,KAAKJ;AACvC;AAEA,SAASG;IACP,IAAI;QACF,MAAMI,UAAUV,QAAQD,QAAQE,cAAc,YAAYU,GAAG,IAAI,MAAM,MAAM;QAC7E,OAAOC,KAAKC,KAAK,CAACf,aAAaY,SAAS,SAASL,OAAO;IAC1D,EAAE,OAAM;QACN,OAAOI;IACT;AACF"}
|
package/dist/upgrade/prompt.js
CHANGED
|
@@ -16,7 +16,7 @@ Never report a task complete because the edit looks right. Confirm it. A silent
|
|
|
16
16
|
|
|
17
17
|
## 0. Preconditions
|
|
18
18
|
- Work on a clean git tree or a fresh branch.
|
|
19
|
-
- Use Node >=24.
|
|
19
|
+
- Use Node >=24.22.1 (the exact engines floor is printed by the command in step 2).
|
|
20
20
|
|
|
21
21
|
## 1. Pre-upgrade migrations (do these on v3, before touching versions)
|
|
22
22
|
Some migrations need the v3 tooling that v4 deletes, so they MUST run before the upgrade:
|
|
@@ -30,8 +30,8 @@ Run this from the project root:
|
|
|
30
30
|
|
|
31
31
|
${command} upgrade run
|
|
32
32
|
|
|
33
|
-
By default it resolves Payload from the dist-tag this CLI was installed under (
|
|
34
|
-
|
|
33
|
+
By default it resolves Payload from the dist-tag this CLI was installed under (its own
|
|
34
|
+
prerelease id, else \`beta\`). Add \`--tag <dist-tag>\` to pin a specific one.
|
|
35
35
|
This pins the Payload packages to v4, removes conflicting overrides, writes the toolchain
|
|
36
36
|
floors, installs, and runs the AST transforms. Read its report:
|
|
37
37
|
- It prints the resolved payload version, the required Next target, and the path to the
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/upgrade/prompt.ts"],"sourcesContent":["/**\n * Render the overarching agent prompt for a full Payload v3 -> v4 upgrade,\n * Next.js 16 included. The prompt is a thin orchestrator: it sequences the\n * gates, runs this package's `upgrade` command for the deterministic slice,\n * delegates Next.js to Next's own agent workflow, and points at the migration\n * guide for the judgment work rather than restating any of it. The text is\n * project-agnostic (the agent runs it from the project root). `command` is the\n * token that re-invokes this CLI, so a local checkout points followers at the\n * local build instead of the published package. Pure: the caller prints it.\n */\nexport function renderUpgradePrompt({\n command = 'npx @payloadcms/codemod',\n}: { command?: string } = {}): string {\n return `You are upgrading this project from Payload v3 to v4, Next.js 16 included.\n\nGround rule: resolution over intent. A step is done only when it installs, builds, and boots.\nNever report a task complete because the edit looks right. Confirm it. A silent gap reads as\n\"checked and fine\".\n\n## 0. Preconditions\n- Work on a clean git tree or a fresh branch.\n- Use Node >=24.
|
|
1
|
+
{"version":3,"sources":["../../src/upgrade/prompt.ts"],"sourcesContent":["/**\n * Render the overarching agent prompt for a full Payload v3 -> v4 upgrade,\n * Next.js 16 included. The prompt is a thin orchestrator: it sequences the\n * gates, runs this package's `upgrade` command for the deterministic slice,\n * delegates Next.js to Next's own agent workflow, and points at the migration\n * guide for the judgment work rather than restating any of it. The text is\n * project-agnostic (the agent runs it from the project root). `command` is the\n * token that re-invokes this CLI, so a local checkout points followers at the\n * local build instead of the published package. Pure: the caller prints it.\n */\nexport function renderUpgradePrompt({\n command = 'npx @payloadcms/codemod',\n}: { command?: string } = {}): string {\n return `You are upgrading this project from Payload v3 to v4, Next.js 16 included.\n\nGround rule: resolution over intent. A step is done only when it installs, builds, and boots.\nNever report a task complete because the edit looks right. Confirm it. A silent gap reads as\n\"checked and fine\".\n\n## 0. Preconditions\n- Work on a clean git tree or a fresh branch.\n- Use Node >=24.22.1 (the exact engines floor is printed by the command in step 2).\n\n## 1. Pre-upgrade migrations (do these on v3, before touching versions)\nSome migrations need the v3 tooling that v4 deletes, so they MUST run before the upgrade:\n- Slate richtext is removed in v4. Migrate Slate -> Lexical while still on v3; the migration path\n is gone once the packages are pinned to v4.\n\nDo not proceed to step 2 until these are complete and committed.\n\n## 2. Payload mechanical slice\nRun this from the project root:\n\n ${command} upgrade run\n\nBy default it resolves Payload from the dist-tag this CLI was installed under (its own\nprerelease id, else \\`beta\\`). Add \\`--tag <dist-tag>\\` to pin a specific one.\nThis pins the Payload packages to v4, removes conflicting overrides, writes the toolchain\nfloors, installs, and runs the AST transforms. Read its report:\n- It prints the resolved payload version, the required Next target, and the path to the\n bundled runbook and migration guide. Use those paths below.\n- The unmet \\`@payloadcms/next\\` peer against Next 15 is EXPECTED at this point. Do NOT downgrade\n payload to satisfy it; step 3 resolves it by upgrading Next.\n- Do not hand-edit the versions it pinned.\n\n## 3. Next.js 16 (delegate to Next's workflow)\nPayload v4 requires Next 16. The command above did not touch Next. Run Next's own recommended\nagent workflow, which bumps Next + React and migrates the code as one unit:\n<https://nextjs.org/docs/app/guides/upgrading/version-16#use-an-ai-agent-recommended>\n\nIn short: run \\`npx @next/codemod@canary upgrade latest\\`, then\n\\`npx @next/codemod@canary next-async-request-api .\\`, and follow Next's AGENTS.md workflow for\nthe rest. Keep the result within the Next target range printed in step 2's report. Reinstall\nafterward so the \\`@payloadcms/next\\` peer resolves.\n\n## 4. Regenerate generated files\n\\`payload generate:types && payload generate:importmap\\`. Never hand-edit \\`payload-types.ts\\` or\n\\`importMap.js\\`; regenerate them.\n\n## 5. Fix-forward judgment work (against the now-v4 tree)\nThese depend on the v4 APIs and types existing, so they follow the upgrade. Open the bundled\nmigration guide (\\`v4.mdx\\`, path printed in step 2) and the bundled runbook\n(\\`runbook/payload-v4-upgrade.md\\`) and work the items they list: SCSS -> CSS and \\`--theme-*\\` ->\n\\`--color-*\\` token renames, Lexical union type-narrowing, jobs DB migrations, strict cron parsing,\nand anything flagged in the per-transform notes. Consult the guide for each; do not guess from\nmemory.\n\n## 6. Verify\n- \\`tsc --noEmit\\` (delete \\`tsconfig.tsbuildinfo\\` first; set \\`checkJs: true\\` so \\`importMap.js\\` is covered).\n- Run integration and e2e tests separately.\n- Build.\n- Confirm native modules (e.g. \\`sharp\\`) still load.\n\n## 7. Report\nDistinguish verified, cannot-confirm, and broken. Do not call the upgrade complete while any\ngate fails or any generated file is stale.\n`\n}\n"],"names":["renderUpgradePrompt","command"],"mappings":"AAAA;;;;;;;;;CASC,GACD,OAAO,SAASA,oBAAoB,EAClCC,UAAU,yBAAyB,EACd,GAAG,CAAC,CAAC;IAC1B,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;IAoBN,EAAEA,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2Cd,CAAC;AACD"}
|
package/package.json
CHANGED
|
@@ -1,13 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@payloadcms/codemod",
|
|
3
|
-
"version": "4.0.0-internal.
|
|
3
|
+
"version": "4.0.0-internal.94ef095",
|
|
4
4
|
"description": "Codemods for migrating Payload projects across versions.",
|
|
5
5
|
"homepage": "https://payloadcms.com",
|
|
6
|
-
"repository": {
|
|
7
|
-
"type": "git",
|
|
8
|
-
"url": "https://github.com/payloadcms/payload.git",
|
|
9
|
-
"directory": "packages/codemod"
|
|
10
|
-
},
|
|
11
6
|
"license": "MIT",
|
|
12
7
|
"author": "Payload <dev@payloadcms.com> (https://payloadcms.com)",
|
|
13
8
|
"maintainers": [
|
|
@@ -17,8 +12,11 @@
|
|
|
17
12
|
"url": "https://payloadcms.com"
|
|
18
13
|
}
|
|
19
14
|
],
|
|
20
|
-
"
|
|
21
|
-
|
|
15
|
+
"repository": {
|
|
16
|
+
"type": "git",
|
|
17
|
+
"url": "https://github.com/payloadcms/payload.git",
|
|
18
|
+
"directory": "packages/codemod"
|
|
19
|
+
},
|
|
22
20
|
"bin": {
|
|
23
21
|
"payload-codemod": "bin/cli.js"
|
|
24
22
|
},
|
|
@@ -28,6 +26,8 @@
|
|
|
28
26
|
"dist",
|
|
29
27
|
"README.md"
|
|
30
28
|
],
|
|
29
|
+
"type": "module",
|
|
30
|
+
"sideEffects": false,
|
|
31
31
|
"dependencies": {
|
|
32
32
|
"@clack/prompts": "1.2.0",
|
|
33
33
|
"semver": "^7.8.5",
|
|
@@ -42,15 +42,13 @@
|
|
|
42
42
|
"vitest": "5.0.1"
|
|
43
43
|
},
|
|
44
44
|
"engines": {
|
|
45
|
-
"node": ">=24.
|
|
45
|
+
"node": ">=24.22.1"
|
|
46
46
|
},
|
|
47
47
|
"scripts": {
|
|
48
48
|
"build": "pnpm typecheck && pnpm build:swc && pnpm build:copy-docs",
|
|
49
49
|
"build:copy-docs": "node scripts/copy-migration-guide.mjs",
|
|
50
50
|
"build:swc": "swc ./src -d ./dist --config-file .swcrc --strip-leading-paths",
|
|
51
51
|
"clean": "rimraf -g {dist,*.tsbuildinfo}",
|
|
52
|
-
"lint": "eslint .",
|
|
53
|
-
"lint:fix": "eslint . --fix",
|
|
54
52
|
"test": "vitest --run",
|
|
55
53
|
"typecheck": "tsc"
|
|
56
54
|
}
|