fix!: server context type (#16)

* fix: server context type

* fix: remove empty context function from GraphQL configuration

Author: productdevbook

package.json

@@ -67,6 +67,7 @@
   },
   "peerDependencies": {
     "graphql": "^16.11.0",
+    "h3": "^1.15.3",
     "nitropack": "^2.11.13"
   },
   "dependencies": {

pnpm-lock.yaml

@@ -1,6 +1,7 @@
 packages:
   - playground
   - playground-nuxt
+
 catalog:
   '@antfu/eslint-config': ^4.17.0
   '@apollo/server': ^5.0.0
@@ -33,7 +34,7 @@ catalog:
   graphql-config: ^5.1.5
   graphql-scalars: ^1.24.2
   graphql-yoga: ^5.15.1
-  h3: ^1.15.3
+  h3: 1.15.3
   knitwork: ^1.2.0
   nitropack: ^2.12.3
   nuxt: 4.0.0-rc.0

pnpm-workspace.yaml

@@ -2,3 +2,6 @@ export interface StandardSchemaV1 extends Record<string, any> {}
 
 export interface ResolversTypes extends Record<string, any> {}
 export interface Resolvers extends Record<string, any> {}
+export interface NPMConfig {
+  framework: 'any'
+}

src/graphql/server.ts

@@ -14,8 +14,6 @@ import { clientTypeGeneration, serverTypeGeneration } from './utils/type-generat
 
 export type * from './types'
 
-export type GraphQLFramework = 'graphql-yoga'
-
 export default defineNitroModule({
   name: 'nitro-graphql',
   async setup(nitro: Nitro) {
@@ -229,16 +227,6 @@ export default defineNitroModule({
       }
     })
 
-    const graphqlDtsContent = `// Auto-generated by nitro-graphql
-
-import type { SchemaType } from './nitro-graphql-server.d.ts'
-
-declare module 'nitro-graphql' {
-  type GraphQLFramework = '${nitro.options.graphql?.framework || 'graphql-yoga'}'
-}
-`
-
-    writeFileSync(join(typesDir, 'graphql.d.ts'), graphqlDtsContent)
     nitro.options.typescript.strict = true
 
     nitro.hooks.hook('types:extend', (types) => {
@@ -316,13 +304,15 @@ export default defineGraphQLConfig({
 
     if (!existsSync(join(nitro.graphql.serverDir, 'context.d.ts'))) {
       writeFileSync(join(nitro.graphql.serverDir, 'context.d.ts'), `// Example context definition please change it to your needs
-// import type { Database } from '../utils/useDb'
+import type { H3EventContext as OriginalH3EventContext } from 'h3'
+
+export interface ExtendedH3EventContext extends OriginalH3EventContext {
+  // useDatabase: () => Database
+  // tables: typeof import('~~/server/drizzle/schema/index')
+}
 
 declare module 'h3' {
-  interface H3EventContext {
-    // useDatabase: () => Database
-    // tables: typeof import('~~/server/drizzle/schema/index')
-  }
+  interface H3EventContext extends ExtendedH3EventContext {}
 }`, 'utf-8')
     }
   },

src/index.ts

@@ -1,9 +1,9 @@
-import type { Resolvers, ResolversTypes } from '#graphql/server'
+import type { NPMConfig, Resolvers, ResolversTypes } from '#graphql/server'
 import type { ApolloServerOptions } from '@apollo/server'
 import type { YogaServerOptions } from 'graphql-yoga'
 import type { H3Event } from 'h3'
 
-import type { GraphQLFramework, StandardSchemaV1 } from 'nitro-graphql'
+import type { StandardSchemaV1 } from 'nitro-graphql'
 
 type Flatten<T> = T extends infer U ? { [K in keyof U]: U[K] } : never
 
@@ -60,14 +60,14 @@ export function defineType(
   return resolvers
 }
 
-export type DefineServerConfig = GraphQLFramework extends 'graphql-yoga'
+export type DefineServerConfig<T extends NPMConfig = NPMConfig> = T['framework'] extends 'graphql-yoga'
   ? Partial<YogaServerOptions<H3Event, Partial<H3Event>>>
-  : GraphQLFramework extends 'apollo-server'
+  : T['framework'] extends 'apollo-server'
     ? Partial<ApolloServerOptions<H3Event>>
-    : Record<string, any>
+    : Partial<YogaServerOptions<H3Event, Partial<H3Event>>> | Partial<ApolloServerOptions<H3Event>>
 
-export function defineGraphQLConfig(
-  config: Partial<DefineServerConfig>,
-): Partial<DefineServerConfig> {
+export function defineGraphQLConfig<T extends NPMConfig = NPMConfig>(
+  config: Partial<DefineServerConfig<T>>,
+): Partial<DefineServerConfig<T>> {
   return config
 }

src/utils/define.ts

@@ -30,6 +30,7 @@ function pluginContent(_schema: any, _documents: any, _config: any, _info: any)
 }
 
 export async function generateTypes(
+  selectFremework: string,
   schema: GraphQLSchema,
   config: CodegenServerConfig = {},
   outputPath?: string,
@@ -82,6 +83,10 @@ export async function generateTypes(
               `import type { StandardSchemaV1 } from 'nitro-graphql'`,
 
               `
+export interface NPMConfig {
+  framework: '${selectFremework || 'graphql-yoga'}';
+}
+
 export type SchemaType = Partial<Record<Partial<keyof ResolversTypes>, StandardSchemaV1>>
 
 // Check if schemas is empty object, return never if so

src/utils/server-codegen.ts

@@ -59,7 +59,7 @@ export async function serverTypeGeneration(app: Nitro) {
       assumeValid: true,
     })
 
-    const data = await generateTypes(schema, app.options.graphql?.codegen?.server ?? {})
+    const data = await generateTypes(app.options.graphql?.framework || 'graphql-yoga', schema, app.options.graphql?.codegen?.server ?? {})
 
     const printSchema = printSchemaWithDirectives(schema)