Skip to content

fix: polymorphic relationship returns null when target is trashed #16403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KibbeWater wants to merge 5 commits into
base: main
Choose a base branch
from
Open

fix: polymorphic relationship returns null when target is trashed #16403

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
74f18e7
fix: polymorphic single relationship to trashed doc returns null
KibbeWater Apr 28, 2026
8750215
fix: relationships to trashable collections admit null in generated t…
KibbeWater Apr 28, 2026
357d8f4
test: cover polymorphic relationships pointing to trashed targets
KibbeWater Apr 28, 2026
42b3e52
templates: null-guard CMSLink reference value before slug access
KibbeWater Apr 28, 2026
b55c8fa
examples: null-guard CMSLink reference value before slug access
KibbeWater Apr 28, 2026
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: relationships to trashable collections admit null in generated t… 
…ypes
  • Loading branch information
@KibbeWater
KibbeWater committed Apr 28, 2026
commit 8750215183961ba7e3e04d90c0acf9226ad6e812
25 changes: 23 additions & 2 deletions packages/payload/src/utilities/configToJSONSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,23 @@ export function withNullableJSONSchemaType(
return fieldTypes
}

/**
* Single relationships whose target collection has `trash: true` can be
* silently nulled at read time when the target document is trashed (see
* `relationshipPopulationPromise`). The generated type must reflect that
* even when the field is `required`.
*/
function isAnyRelationTargetTrashable(
relationTo: string | string[],
collections?: SanitizedCollectionConfig[],
): boolean {
if (!collections) {
return false
}
const targets = Array.isArray(relationTo) ? relationTo : [relationTo]
return targets.some((slug) => collections.find((c) => c.slug === slug)?.trash === true)
}

function entityOrFieldToJsDocs({
entity,
i18n,
Expand Down Expand Up @@ -669,11 +686,13 @@ export function fieldsToJSONSchema(
},
}
} else {
const isRequiredAndStable =
isRequired && !isAnyRelationTargetTrashable(field.relationTo, config?.collections)
fieldSchema = {
...baseFieldSchema,
oneOf: field.relationTo.map((relation) => {
return {
type: withNullableJSONSchemaType('object', isRequired),
type: withNullableJSONSchemaType('object', isRequiredAndStable),
additionalProperties: false,
properties: {
relationTo: {
Expand Down Expand Up @@ -711,13 +730,15 @@ export function fieldsToJSONSchema(
},
}
} else {
const isRequiredAndStable =
isRequired && !isAnyRelationTargetTrashable(field.relationTo, config?.collections)
fieldSchema = {
...baseFieldSchema,
oneOf: [
{
type: withNullableJSONSchemaType(
collectionIDFieldTypes[field.relationTo]!,
isRequired,
isRequiredAndStable,
),
},
{ $ref: `#/definitions/${field.relationTo}` },
Expand Down