initial commit

src/module.ts

@@ -0,0 +1,59 @@
+import { addServerPlugin, addTemplate, createResolver, defineNuxtModule } from '@nuxt/kit'
+import { defu } from 'defu'
+import type { ConnectOptions } from 'mongoose'
+
+export interface ModuleOptions {
+  uri?: string
+  options?: ConnectOptions
+}
+
+export default defineNuxtModule<ModuleOptions>({
+  meta: {
+    name: 'nuxt-mongoose',
+    configKey: 'mongoose',
+  },
+  defaults: {
+    uri: process.env.MONGODB_URI as string,
+    options: {},
+  },
+  setup(options, nuxt) {
+    const { resolve } = createResolver(import.meta.url)
+
+    if (!options.uri)
+      console.warn('Missing `MONGODB_URI` in `.env`')
+
+    // Public runtimeConfig
+    nuxt.options.runtimeConfig.public.mongoose = defu(nuxt.options.runtimeConfig.public.mongoose || {}, {
+      uri: options.uri,
+      options: options.options,
+    })
+
+    // virtual imports
+    nuxt.hook('nitro:config', (nitroConfig) => {
+      nitroConfig.alias = nitroConfig.alias || {}
+
+      // Inline module runtime in Nitro bundle
+      nitroConfig.externals = defu(typeof nitroConfig.externals === 'object' ? nitroConfig.externals : {}, {
+        inline: [resolve('./runtime')],
+      })
+      nitroConfig.alias['#nuxt/mongoose'] = resolve('./runtime/server/services')
+    })
+
+    addTemplate({
+      filename: 'types/nuxt-mongoose.d.ts',
+      getContents: () => [
+        'declare module \'#nuxt/mongoose\' {',
+        `  const defineMongooseConnection: typeof import('${resolve('./runtime/server/services')}').defineMongooseConnection`,
+        `  const defineMongooseModel: typeof import('${resolve('./runtime/server/services')}').defineMongooseModel`,
+        '}',
+      ].join('\n'),
+    })
+
+    nuxt.hook('prepare:types', (options) => {
+      options.references.push({ path: resolve(nuxt.options.buildDir, 'types/nuxt-mongoose.d.ts') })
+    })
+
+    // Add server-plugin for database connection
+    addServerPlugin(resolve('./runtime/server/plugins/mongoose.db'))
+  },
+})

src/runtime/server/plugins/mongoose.db.ts

@@ -0,0 +1,15 @@
+/**
+ * Due to an upstream bug in Nuxt 3 we need to stub the plugin here, track:https://github.com/nuxt/nuxt/issues/18556
+ * */
+import type { NitroApp } from 'nitropack'
+import { defineMongooseConnection } from '../services/mongoose'
+
+type NitroAppPlugin = (nitro: NitroApp) => void
+
+function defineNitroPlugin(def: NitroAppPlugin): NitroAppPlugin {
+  return def
+}
+
+export default defineNitroPlugin(() => {
+  defineMongooseConnection()
+})

src/runtime/server/services/index.ts

@@ -0,0 +1 @@
+export { defineMongooseConnection, defineMongooseModel } from './mongoose'

src/runtime/server/services/mongoose.ts

@@ -0,0 +1,36 @@
+import type { ConnectOptions, Model, SchemaDefinition, SchemaOptions } from 'mongoose'
+import { Schema, connect, model } from 'mongoose'
+import { logger } from '@nuxt/kit'
+
+import { useRuntimeConfig } from '#imports'
+
+export async function defineMongooseConnection({ uri, options }: { uri?: string; options?: ConnectOptions } = {}): Promise<void> {
+  const config = useRuntimeConfig().public.mongoose
+  const mongooseUri = uri || config.uri
+  const mongooseOptions = options || config.options
+
+  try {
+    await connect(mongooseUri, { ...mongooseOptions })
+    logger.info('Connected to database')
+  }
+  catch (err) {
+    logger.error('Error connecting to database', err)
+  }
+}
+
+export function defineMongooseModel(nameOrOptions: string | { name: string; schema: SchemaDefinition; options?: SchemaOptions }, schema?: SchemaDefinition, options?: SchemaOptions): Model<any> {
+  let name: string
+  if (typeof nameOrOptions === 'string') {
+    name = nameOrOptions
+  }
+  else {
+    name = nameOrOptions.name
+    schema = nameOrOptions.schema
+    options = nameOrOptions.options
+  }
+
+  const newSchema = new Schema({
+    ...schema,
+  }, { ...options })
+  return model(name, newSchema)
+}