feat: refactor type imports and enhance GraphQL schema definitions

Author: productdevbook

package.json

@@ -31,10 +31,6 @@
       "types": "./dist/utils/index.d.ts",
       "import": "./dist/utils/index.js"
     },
-    "./types": {
-      "types": "./dist/types.d.ts",
-      "import": "./dist/types.js"
-    },
     "./internal": {
       "types": "./dist/internal/index.d.ts",
       "import": "./dist/internal/index.js"

playground-nuxt/nuxt.config.ts

@@ -1,5 +1,5 @@
 // TODO: temporary solution
-import 'nitro-graphql/types'
+// import 'nitro-graphql/types'
 
 export default defineNuxtConfig({
   compatibilityDate: '2024-07-01',
@@ -11,19 +11,7 @@ export default defineNuxtConfig({
     modules: ['nitro-graphql'],
     // GraphQL Yoga configuration
     graphql: {
-      endpoint: '/api/graphql',
-      playground: true,
-      cors: {
-        origin: '*',
-        credentials: true,
-      },
-      client: {
-        enabled: true,
-        watchPatterns: [
-          'server/graphql/**/*.graphql',
-          'server/graphql/**/*.gql',
-        ],
-      },
+
     },
   },
 

src/index.ts

@@ -11,6 +11,12 @@ import { rollupConfig } from './rollup'
 import { relativeWithDot, scanDefs, scanResolvers } from './utils'
 import { clientTypeGeneration, serverTypeGeneration } from './utils/server-type-generation'
 
+export type * from './types'
+
+// This is the main entry point for the nitro-graphql module.
+// It sets up the module, configures the GraphQL endpoints, and handles type generation.
+export interface Resolvers {}
+
 export default defineNitroModule({
   name: 'nitro-graphql',
   async setup(nitro: Nitro) {
@@ -169,7 +175,7 @@ export default defineNitroModule({
     const graphqlDtsContent = `// Auto-generated by nitro-graphql
 import type { Resolvers as Test } from './nitro-graphql-server.d.ts'
 
-declare module 'nitro-graphql/types' {
+declare module 'nitro-graphql' {
   interface Resolvers extends Test {}
 }
 `

src/types.ts renamed to src/types/index.ts

@@ -5,6 +5,8 @@ import type { IResolvers } from '@graphql-tools/utils'
 import type { YogaServerOptions } from 'graphql-yoga'
 import type { IncomingMessage, ServerResponse } from 'node:http'
 
+export type { StandardSchemaV1 } from './standard-schema'
+
 export type CodegenServerConfig = TypeScriptPluginConfig & TypeScriptResolversPluginConfig
 
 declare module 'nitropack/types' {
@@ -74,5 +76,3 @@ export interface NitroGraphQLOptions {
   }
   yogaConfig?: Partial<YogaServerOptions<any, any>>
 }
-
-export interface Resolvers {}

src/types/standard-schema.ts

@@ -0,0 +1,74 @@
+/** The Standard Schema interface. */
+export interface StandardSchemaV1<Input = unknown, Output = Input> {
+  /** The Standard Schema properties. */
+  readonly '~standard': StandardSchemaV1.Props<Input, Output>
+}
+
+// eslint-disable-next-line ts/no-namespace
+export declare namespace StandardSchemaV1 {
+  /** The Standard Schema properties interface. */
+  export interface Props<Input = unknown, Output = Input> {
+    /** The version number of the standard. */
+    readonly version: 1
+    /** The vendor name of the schema library. */
+    readonly vendor: string
+    /** Validates unknown input values. */
+    readonly validate: (
+      value: unknown,
+    ) => Result<Output> | Promise<Result<Output>>
+    /** Inferred types associated with the schema. */
+    readonly types?: Types<Input, Output> | undefined
+  }
+
+  /** The result interface of the validate function. */
+  export type Result<Output> = SuccessResult<Output> | FailureResult
+
+  /** The result interface if validation succeeds. */
+  export interface SuccessResult<Output> {
+    /** The typed output value. */
+    readonly value: Output
+    /** The non-existent issues. */
+    readonly issues?: undefined
+  }
+
+  /** The result interface if validation fails. */
+  export interface FailureResult {
+    /** The issues of failed validation. */
+    readonly issues: ReadonlyArray<Issue>
+  }
+
+  /** The issue interface of the failure output. */
+  export interface Issue {
+    /** The error message of the issue. */
+    readonly message: string
+    /** The path of the issue, if any. */
+    readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined
+  }
+
+  /** The path segment interface of the issue. */
+  export interface PathSegment {
+    /** The key representing a path segment. */
+    readonly key: PropertyKey
+  }
+
+  /** The Standard Schema types interface. */
+  export interface Types<Input = unknown, Output = Input> {
+    /** The input type of the schema. */
+    readonly input: Input
+    /** The output type of the schema. */
+    readonly output: Output
+  }
+
+  /** Infers the input type of a Standard Schema. */
+  export type InferInput<Schema extends StandardSchemaV1> = NonNullable<
+    Schema['~standard']['types']
+  >['input']
+
+  /** Infers the output type of a Standard Schema. */
+  export type InferOutput<Schema extends StandardSchemaV1> = NonNullable<
+    Schema['~standard']['types']
+  >['output']
+
+  // biome-ignore lint/complexity/noUselessEmptyExport: needed for granular visibility control of TS namespace
+  export {}
+}

src/utils/index.ts

@@ -1,5 +1,5 @@
 import type { YogaServerOptions } from 'graphql-yoga'
-import type { GraphQLSchemaConfig, Resolvers } from 'nitro-graphql/types'
+import type { GraphQLSchemaConfig, Resolvers } from 'nitro-graphql'
 import type { Nitro } from 'nitropack'
 import { join, relative } from 'pathe'
 import { glob } from 'tinyglobby'

tsconfig.json

@@ -8,7 +8,6 @@
     "module": "ESNext",
     "moduleResolution": "bundler",
     "paths": {
-      "nitro-graphql/types": ["./src/types"],
       "#nitro-internal-virtual/*": ["./src/virtual/*"],
       "nitro-graphql/internal": ["./src/internal/index.ts"]
     },

tsdown.config.ts

@@ -15,7 +15,6 @@ export default defineConfig({
     'src/client-watcher.ts',
     'src/context.ts',
     'src/utils/index.ts',
-    'src/types.ts',
     'src/routes',
     'src/internal/index.ts',
     'src/graphql.d.ts',
@@ -27,7 +26,7 @@ export default defineConfig({
   name: 'nitro-graphql',
   unbundle: true,
   external: [
-    'nitro-graphql/types',
+    'nitro-graphql',
     'nitropack',
     'nitropack/types',
     'nitropack/kit',