simple solution: modify value of relationship field within afterRead hook

unonweblast year

2 2

const relationshipField = {
	type: 'relationship',
	name: 'internal',
	label: 'Document to link to',
	relationTo: ['pages'],
	required: true,
	maxDepth: 0, // <-- important
	hooks: {
		afterRead: [
			(args) => extractFieldsFromRelationship(args, ['url'])
		]
	}
}

async function extractFieldsFromRelationship(args, topLevelFields = []) {
	// afterRead

	if (typeof args.value === 'undefined') return

	const refCollection = args.value.relationTo
	const refID = args.value.value

	const doc = await payload.findByID({
		collection: refCollection,
		id: refID,
		depth: 1,
	})
	
	const extract = {}

	topLevelFields.map(field => {
		if (doc[field]) extract[field] = doc[field]
	})

	// include this - otherwise the admin UI will not work properly
	extract.relationTo = refCollection 
	extract.value = refID

	//return doc // This is the default way. The whole doc is included.
	return extract
}

• Selected Answer
  

  jacobsfletch

  last year

  @unonweb this is great!! The only thing that jumps out at me are that it seems like you should not have to set maxDepth: 0 — because this requires you to make that extra query from within your hook. The entire document is already present in the args, so couldn't you just strip out the irrelevant fields without querying your relationship again?

  That first discussion you linked has some pretty good information, for others who stumble by. Namely, doing this will break GraphQL, and that this is really where GraphQL shines.

  Thank you for this thorough example!
• 

  christian-reichartlast year

  Thanks for that tip!
  Also related, solves that really elegantly: #1288

  I think using REST has a lot of benefits over GraphQL for certain cases, but it's currently handicapped by the relationships because of this select issue, also when using an internal link inside the Rich Text for example.