feat: streamline GraphQL configuration by removing unused client options and enhancing framework integration

Author: productdevbook

README.md

@@ -46,21 +46,6 @@ export default defineNitroConfig({
     endpoint: '/api/graphql', // default
     playground: true, // default (Apollo Sandbox)
     cors: false, // default
-    cacheHeaders: {
-      enabled: true, // default
-      maxAge: 604800, // default (1 week)
-    },
-    client: {
-      enabled: false, // default
-      outputPath: undefined, // Will default to .nitro/types/graphql-client.generated.ts
-      watchPatterns: undefined, // Will default to src/**/*.{graphql,gql} excluding server/graphql
-      config: {
-        documentMode: 'string',
-        emitLegacyCommonJSImports: false,
-        useTypeImports: true,
-        enumsAsTypes: true,
-      }
-    }
   }
 })
 ```
@@ -258,12 +243,6 @@ interface NitroGraphQLYogaOptions {
     methods?: string[]
   }
 
-  // Cache headers configuration
-  cacheHeaders?: {
-    enabled?: boolean // default: true
-    maxAge?: number // default: 604800 (1 week)
-  }
-
   // Client type generation
   client?: {
     enabled?: boolean // default: false
@@ -362,14 +341,6 @@ Enable client type generation for your frontend queries:
 // nitro.config.ts
 export default defineNitroConfig({
   graphqlYoga: {
-    client: {
-      enabled: true,
-      watchPatterns: [
-        'client/**/*.graphql',
-        'pages/**/*.vue',
-        'components/**/*.vue'
-      ]
-    }
   }
 })
 ```

playground-nuxt/nuxt.config.ts

@@ -11,7 +11,7 @@ export default defineNuxtConfig({
     modules: ['nitro-graphql'],
     // GraphQL Yoga configuration
     graphql: {
-
+      framework: 'graphql-yoga',
     },
   },
 

playground/nitro.config.ts

@@ -6,19 +6,7 @@ export default defineNitroConfig({
   modules: ['nitro-graphql'],
   compatibilityDate: '2025-07-01',
   graphql: {
-    endpoint: '/api/graphql',
-    playground: true,
-    cors: {
-      origin: '*',
-      credentials: true,
-    },
-    client: {
-      enabled: true,
-      watchPatterns: [
-        'client/**/*.graphql',
-        'client/**/*.gql',
-      ],
-    },
+    framework: 'graphql-yoga',
   },
   esbuild: {
     options: {

src/index.ts

@@ -123,24 +123,26 @@ export default defineNitroModule({
       new URL('routes', import.meta.url),
     )
     // Main GraphQL endpoint
-    nitro.options.handlers.push({
-      route: nitro.options.runtimeConfig.graphql?.endpoint?.graphql || '/api/graphql',
-      handler: join(runtime, 'graphql'),
-      method: 'get',
-    })
+    if (nitro.options.graphql?.framework === 'graphql-yoga') {
+      nitro.options.handlers.push({
+        route: nitro.options.runtimeConfig.graphql?.endpoint?.graphql || '/api/graphql',
+        handler: join(runtime, 'graphql'),
+        method: 'get',
+      })
 
-    // Main GraphQL endpoint
-    nitro.options.handlers.push({
-      route: nitro.options.runtimeConfig.graphql?.endpoint?.graphql || '/api/graphql',
-      handler: join(runtime, 'graphql'),
-      method: 'post',
-    })
+      // Main GraphQL endpoint
+      nitro.options.handlers.push({
+        route: nitro.options.runtimeConfig.graphql?.endpoint?.graphql || '/api/graphql',
+        handler: join(runtime, 'graphql'),
+        method: 'post',
+      })
 
-    nitro.options.handlers.push({
-      route: nitro.options.runtimeConfig.graphql?.endpoint?.graphql || '/api/graphql',
-      handler: join(runtime, 'graphql'),
-      method: 'options',
-    })
+      nitro.options.handlers.push({
+        route: nitro.options.runtimeConfig.graphql?.endpoint?.graphql || '/api/graphql',
+        handler: join(runtime, 'graphql'),
+        method: 'options',
+      })
+    }
 
     // Health check endpoint
     nitro.options.handlers.push({

src/types/index.ts

@@ -60,6 +60,7 @@ export interface CodegenClientConfig extends TypeScriptPluginConfig, TypeScriptD
 }
 
 export interface NitroGraphQLOptions {
+  framework: 'graphql-yoga' | 'apollo-server'
   endpoint?: {
     graphql?: string
     healthCheck?: string
@@ -73,19 +74,9 @@ export interface NitroGraphQLOptions {
     exclude?: RegExp
     validate?: boolean
   }
-  cacheHeaders?: {
-    enabled?: boolean
-    maxAge?: number
-  }
   codegen?: {
     server?: CodegenServerConfig
     client?: CodegenClientConfig
   }
-  client?: {
-    enabled?: boolean
-    outputPath?: string
-    watchPatterns?: string[]
-    nuxtPatterns?: string[]
-  }
   yogaConfig?: Partial<YogaServerOptions<any, any>>
 }