feat: generate typescript definitions for resolvers (#6)

Author: tobiasdiez

README.md

@@ -10,6 +10,7 @@ This package allows you to easily develop a GraphQL server in your [nuxt](v3.nux
 ## Features
 
 - Provides a virtual module `#graphql/schema` from where you can import your schema. Under the hood, it automatically merges multiple schema files together into a complete schema. Moreover, you no longer need to worry about deploying schema `graphql` files.
+- Automatically generates typescript definitions for your resolvers.
 
 ## Installation
 
@@ -24,6 +25,31 @@ yarn add @apollo/server graphql @as-integrations/h3 @tobiasdiez/nuxt-graphql-ser
 pnpm add @apollo/server graphql @as-integrations/h3 @tobiasdiez/nuxt-graphql-server
 ```
 
+## Usage
+
+1. Define the GraphQL schema in `.graphql` files located in the `server` folder.
+2. Expose the GraphQL API endpoint by creating `server/api/graphql.ts` with the following content:
+
+   ```ts
+   import { Resolvers } from '#graphql/resolver'
+   import { schema } from '#graphql/schema'
+   import { ApolloServer } from '@apollo/server'
+   import { startServerAndCreateH3Handler } from '@as-integrations/h3'
+
+   const resolvers: Resolvers = {
+      Query: {
+         // Typed resolvers
+      },
+   }
+
+   const apollo = new ApolloServer({typeDefs: schema, resolvers})
+
+   export default startServerAndCreateH3Handler(apollo, {
+      // Optional: Specify context
+      context: (event) => {...},
+   })
+   ```
+
 ## 💻 Development
 
 - Clone this repository

package.json

@@ -27,6 +27,10 @@
     "release": "standard-version && git push --follow-tags && pnpm publish"
   },
   "dependencies": {
+    "@graphql-codegen/core": "^2.6.2",
+    "@graphql-codegen/plugin-helpers": "^2.7.1",
+    "@graphql-codegen/typescript": "^2.8.0",
+    "@graphql-codegen/typescript-resolvers": "^2.7.5",
     "@graphql-tools/graphql-file-loader": "^7.5.5",
     "@graphql-tools/load": "^7.8.0",
     "@nuxt/kit": "^3.0.0-rc.12"
@@ -35,6 +39,8 @@
     "graphql": "^16.6.0"
   },
   "devDependencies": {
+    "@apollo/server": "^4.0.4",
+    "@as-integrations/h3": "^1.1.0",
     "@nuxt/module-builder": "^0.2.0",
     "@nuxt/schema": "^3.0.0-rc.12",
     "@nuxtjs/eslint-config-typescript": "^11.0.0",

playground/server/api/graphql.ts

@@ -0,0 +1,20 @@
+import { Resolvers } from '#graphql/resolver'
+import { schema } from '#graphql/schema'
+import { ApolloServer } from '@apollo/server'
+import { startServerAndCreateH3Handler } from '@as-integrations/h3'
+
+const resolvers: Resolvers = {
+  Query: {
+    books: () => {
+      return [
+        {
+          title: 'GraphQL with Nuxt',
+        },
+      ]
+    },
+  },
+}
+
+const apollo = new ApolloServer({ typeDefs: schema, resolvers })
+
+export default startServerAndCreateH3Handler(apollo)

playground/server/schema.graphql

@@ -1,3 +1,7 @@
+type Query {
+  books: [Book]
+}
+
 type Book {
   title: String
   author: Author