fix(preset): allow presets to provide default options

Presets can provide default fallback for database

Author: farnabaz

src/module.ts

@@ -13,7 +13,7 @@ import {
 import type { Nuxt } from '@nuxt/schema'
 import type { ModuleOptions as MDCModuleOptions } from '@nuxtjs/mdc'
 import { hash } from 'ohash'
-import { join, isAbsolute } from 'pathe'
+import { join } from 'pathe'
 import htmlTags from '@nuxtjs/mdc/runtime/parser/utils/html-tags-list'
 import { kebabCase, pascalCase } from 'scule'
 import defu from 'defu'
@@ -75,14 +75,6 @@ export default defineNuxtModule<ModuleOptions>({
     },
   },
   async setup(options, nuxt) {
-    // Provide default database configuration here since nuxt is merging defaults and user options
-    if (!options.database) {
-      options.database = {
-        type: 'sqlite',
-        filename: './contents.sqlite',
-      }
-    }
-
     const resolver = createResolver(import.meta.url)
     const manifest: Manifest = {
       checksum: {},
@@ -91,31 +83,9 @@ export default defineNuxtModule<ModuleOptions>({
       collections: [],
     }
 
-    // Create local database
-    await refineDatabaseConfig(options._localDatabase, nuxt)
-    if (options._localDatabase?.type === 'sqlite') {
-      options._localDatabase!.filename = isAbsolute(options._localDatabase!.filename)
-        ? options._localDatabase!.filename
-        : join(nuxt.options.rootDir, options._localDatabase!.filename)
-    }
-
-    // Create sql database
-    await refineDatabaseConfig(options.database, nuxt)
-
     const { collections } = await loadContentConfig(nuxt)
     manifest.collections = collections
 
-    // Module Options
-    nuxt.options.runtimeConfig.public.content = {
-      wsUrl: '',
-    }
-    nuxt.options.runtimeConfig.content = {
-      version,
-      database: options.database,
-      localDatabase: options._localDatabase!,
-      integrityCheck: true,
-    } as never
-
     nuxt.options.vite.optimizeDeps ||= {}
     nuxt.options.vite.optimizeDeps.exclude ||= []
     nuxt.options.vite.optimizeDeps.exclude.push('@sqlite.org/sqlite-wasm')
@@ -159,9 +129,25 @@ export default defineNuxtModule<ModuleOptions>({
       }
     }
 
-    // Load nitro preset and set db adapter
     const preset = findPreset(nuxt)
     await preset?.setup?.(options, nuxt)
+
+    // Provide default database configuration here since nuxt is merging defaults and user options
+    options.database ||= { type: 'sqlite', filename: './contents.sqlite' }
+    await refineDatabaseConfig(options._localDatabase, { rootDir: nuxt.options.rootDir, updateSqliteFileName: true })
+    await refineDatabaseConfig(options.database, { rootDir: nuxt.options.rootDir })
+
+    // Module Options
+    nuxt.options.runtimeConfig.public.content = {
+      wsUrl: '',
+    }
+    nuxt.options.runtimeConfig.content = {
+      version,
+      database: options.database,
+      localDatabase: options._localDatabase!,
+      integrityCheck: true,
+    } as never
+
     nuxt.hook('nitro:config', async (config) => {
       const preset = findPreset(nuxt)
       await preset.setupNitro(config, { manifest, resolver, moduleOptions: options })

src/presets/cloudflare-pages.ts

@@ -9,10 +9,7 @@ export default definePreset({
   async setupNitro(nitroConfig, { manifest, resolver }) {
     if (nitroConfig.runtimeConfig?.content?.database?.type === 'sqlite') {
       logger.warn('Deploying to Cloudflare Pages requires using D1 database, switching to D1 database with binding `DB`.')
-      nitroConfig.runtimeConfig!.content!.database = {
-        type: 'd1',
-        binding: 'DB',
-      }
+      nitroConfig.runtimeConfig!.content!.database = { type: 'd1', bindingName: 'DB' }
     }
 
     nitroConfig.publicAssets ||= []

src/presets/nuxthub.ts

@@ -1,6 +1,7 @@
 import { mkdir, writeFile } from 'node:fs/promises'
 import { resolve } from 'pathe'
 import { definePreset } from '../utils/preset'
+import { logger } from '../utils/dev'
 import cfPreset from './cloudflare-pages'
 
 export default definePreset({
@@ -9,8 +10,16 @@ export default definePreset({
     // Make sure database is enabled
     const nuxthubOptions: { database?: boolean } = (nuxt.options as unknown as { hub: unknown }).hub ||= {}
     nuxthubOptions.database = true
+
+    // Set up database
+    options.database ||= { type: 'd1', bindingName: 'DB' }
   },
   async setupNitro(nitroConfig, options) {
+    if (nitroConfig.runtimeConfig?.content?.database?.type === 'sqlite') {
+      logger.warn('Deploying to NuxtHub requires using D1 database, switching to D1 database with binding `DB`.')
+      nitroConfig.runtimeConfig!.content!.database = { type: 'd1', bindingName: 'DB' }
+    }
+
     await cfPreset.setupNitro(nitroConfig, options)
 
     if (nitroConfig.dev === false) {

src/utils/database.ts

@@ -1,7 +1,6 @@
 import { mkdir } from 'node:fs/promises'
 import type { Connector } from 'db0'
 import type { Resolver } from '@nuxt/kit'
-import type { Nuxt } from '@nuxt/schema'
 import cloudflareD1Connector from 'db0/connectors/cloudflare-d1'
 import { isAbsolute, join, dirname } from 'pathe'
 import { isWebContainer } from '@webcontainer/env'
@@ -25,7 +24,7 @@ function isSqlite3Available() {
   }
 }
 
-export async function refineDatabaseConfig(database: ModuleOptions['database'], nuxt: Nuxt) {
+export async function refineDatabaseConfig(database: ModuleOptions['database'], opts: { rootDir: string, updateSqliteFileName?: boolean }) {
   if (database.type === 'd1') {
     if (!('bindingName' in database)) {
       // @ts-expect-error bindingName
@@ -36,8 +35,12 @@ export async function refineDatabaseConfig(database: ModuleOptions['database'],
   if (database.type === 'sqlite') {
     const path = isAbsolute(database.filename)
       ? database.filename
-      : join(nuxt.options.rootDir, database.filename)
+      : join(opts.rootDir, database.filename)
     await mkdir(dirname(path), { recursive: true }).catch(() => {})
+
+    if (opts.updateSqliteFileName) {
+      database.filename = path
+    }
   }
 }