Fields of type reference should be able to embed their data

[seancdavis]

Given the following config:

const Category = defineDocumentType(() => ({
  name: 'Category',
  filePathPattern: 'categories/*.md',
  bodyType: 'none',
  fields: {
    title: { type: 'string', required: true },
  },
}))

const Doc = defineDocumentType(() => ({
  name: 'Doc',
  filePathPattern: '**/*.mdx',
  bodyType: 'mdx',
  fields: {
    title: { type: 'string', required: true },
    category: { type: 'reference', of: Category }
  },
}))

export default makeSource({
  contentDirPath: 'content',
  documentTypes: [Doc, Category],
})

And the following content files:

content/categories/a.md

---
title: My First Category
---

content/docs/index.mdx

---
title: Home Page
category: categories/a.md
---

The output document would have the following:

{
  "title": "Home Page",
  "category": "categories/a.md",
  // ...
}

It would be nice to (optionally) embed the category data directly in the output document. Otherwise, I have to defer that logic to my application. Being that it's data manipulation, it seems right that Contentlayer would handle this.

I'd rather see the output like this:

{
  "title": "Home Page",
  "category": {
    "title": "My First Category"
  },
  // ...
}

[schickling]

Version 0.0.34 introduces experimental support for this by letting you set embedDocument: true e.g. like this:

export const Post = defineDocumentType(() => ({
    name: 'Post',
    fields: {
        // ...
        author: { type: 'reference', of: Person, embedDocument: true },
        // ...
}));

Note: This currently just works properly on the "top level" i.e. for documents referencing other documents but not yet for references in nested document definitions.

[aaronyih1]

Version 0.0.34 introduces experimental support for this by letting you set embedDocument: true e.g. like this:

export const Post = defineDocumentType(() => ({
    name: 'Post',
    fields: {
        // ...
        author: { type: 'reference', of: Person, embedDocument: true },
        // ...
}));

Note: This currently just works properly on the "top level" i.e. for documents referencing other documents but not yet for references in nested document definitions.

This is awesome! Just to clarify, does this mean that there isn't currently a way to create a list of references with embedded documents enabled?

[schickling]

@aaronyih1 I don't know from the top of my head anymore but worth giving it a try and see whether it already works.