feat: documentDriven configuration (#1378)

docs/content/3.guide/1.writing/7.document-driven.md

@@ -195,6 +195,40 @@ definePageMeta({
 </script>
 ```
 
+### Config content
+
+You can pass custom path/query to `page` and `surround` options to config documentDriven content.
+
+```html
+<script setup lang="ts">
+definePageMeta({
+  documentDriven: {
+    // Simple Path
+    page: '/foo',
+    // Rich Query
+    surround: {
+      _path: '/foo/bar'
+    }
+  }
+})
+</script>
+```
+
+::alert
+If you change `page` option and leave `surround` unset, `surround` option will use same config and `page`.
+```html
+<script setup lang="ts">
+definePageMeta({
+  documentDriven: {
+    page: {
+      _path: '/foo/bar'
+    },
+    // surround will use `{ _path: '/foo/bar' }`
+  }
+})
+</script>
+```
+::
 
 ## Example
 

playground/document-driven/pages/home.vue

@@ -0,0 +1,16 @@
+<script setup>
+definePageMeta({
+  documentDriven: {
+    page: '/'
+  }
+})
+
+const { page } = useContent()
+useContentHead(page)
+</script>
+
+<template>
+  <NuxtLayout name="reversed">
+    <ContentRenderer :value="page" />
+  </NuxtLayout>
+</template>

src/runtime/plugins/documentDriven.ts

@@ -138,6 +138,13 @@ export default defineNuxtPlugin((nuxt) => {
      * `page`
      */
     if (moduleOptions.page && routeConfig.page !== false) {
+      let where = { _path }
+      if (typeof routeConfig.page === 'string') {
+        where = { _path: routeConfig.page }
+      }
+      if (typeof routeConfig.page === 'object') {
+        where = routeConfig.page
+      }
       const pageQuery = () => {
         const { pages } = useContentState()
 
@@ -147,7 +154,7 @@ export default defineNuxtPlugin((nuxt) => {
         }
 
         return queryContent()
-          .where({ _path })
+          .where(where)
           .findOne()
           .catch(() => {
             // eslint-disable-next-line no-console
@@ -164,6 +171,13 @@ export default defineNuxtPlugin((nuxt) => {
      * `surround`
      */
     if (moduleOptions.surround && routeConfig.surround !== false) {
+      let surround: any = _path
+      if (['string', 'object'].includes(typeof routeConfig.page)) {
+        surround = routeConfig.page
+      }
+      if (['string', 'object'].includes(typeof routeConfig.surround)) {
+        surround = routeConfig.surround
+      }
       const surroundQuery = () => {
         const { surrounds } = useContentState()
 
@@ -179,7 +193,7 @@ export default defineNuxtPlugin((nuxt) => {
           })
         // Exclude `body` for `surround`
           .without(['body'])
-          .findSurround(_path)
+          .findSurround(surround)
           .catch(() => {
             // eslint-disable-next-line no-console
             // console.log(`Could not find surrounding pages for: ${to.path}`)

test/document-driven.test.ts

@@ -21,10 +21,29 @@ describe('fixtures:document-driven', async () => {
     expect(html).contains('<div>page: </div>')
   })
 
-  test('disabled surround document driven', async () => {
+  test('disabled surround', async () => {
     const html = await $fetch('/no-surround')
 
     expect(html).contains('<div>surround: </div>')
     expect(html).contains('<div>page: {')
   })
+
+  test('custom content with path', async () => {
+    const html = await $fetch('/home')
+
+    expect(html).contains('Home')
+    expect(html).contains('Hello World!')
+
+    expect(html).contains('with previous link /')
+    expect(html).contains('with next link /layout')
+  })
+
+  test('custom content with condition', async () => {
+    const html = await $fetch('/custom-search')
+
+    expect(html).contains('FM Data')
+
+    expect(html).contains('with previous link /layout')
+    expect(html).contains('with next link /no-surround')
+  })
 })

test/fixtures/document-driven/content/3.fm-data.md

@@ -0,0 +1,5 @@
+---
+score: 23.5
+---
+
+# FM Data

test/fixtures/document-driven/pages/custom-search.vue

@@ -0,0 +1,34 @@
+<script setup>
+definePageMeta({
+  documentDriven: {
+    page: {
+      score: {
+        $eq: 23.5
+      }
+    }
+  }
+})
+
+const { page, surround } = useContent()
+useContentHead(page)
+</script>
+
+<template>
+  <div>
+    <ContentRenderer :value="page" />
+    <div>
+      <div v-if="surround[0]">
+        with previous link {{ surround[0]._path }}
+      </div>
+      <div v-else>
+        no previous link
+      </div>
+      <div v-if="surround[1]">
+        with next link {{ surround[1]._path }}
+      </div>
+      <div v-else>
+        no next link
+      </div>
+    </div>
+  </div>
+</template>

test/fixtures/document-driven/pages/home.vue

@@ -0,0 +1,31 @@
+<script setup>
+definePageMeta({
+  documentDriven: {
+    page: '/',
+    surround: '/debug'
+  }
+})
+
+const { page, surround } = useContent()
+useContentHead(page)
+</script>
+
+<template>
+  <div>
+    <ContentRenderer :value="page" />
+    <div>
+      <div v-if="surround[0]">
+        with previous link {{ surround[0]._path }}
+      </div>
+      <div v-else>
+        no previous link
+      </div>
+      <div v-if="surround[1]">
+        with next link {{ surround[1]._path }}
+      </div>
+      <div v-else>
+        no next link
+      </div>
+    </div>
+  </div>
+</template>