@lewebsimple/nuxt-graphql 0.1.2 → 0.1.4

package/README.md

@@ -11,7 +11,7 @@ Opinionated Nuxt module for using GraphQL Yoga on the server and urql as a clien
 - 🏀 [Online playground](https://stackblitz.com/github/lewebsimple/nuxt-graphql?file=playground%2Fapp.vue)
 
 ## Features
-- 🧘‍♂️ GraphQL Yoga server handler with user-provided schema
+- 🧘‍♂️ GraphQL Yoga server handler with user-provided schema / context
 
 ## Quick Setup
 
@@ -25,8 +25,9 @@ Define your GraphQL schema in `server/graphql/schema.ts`:
 
 ```ts
 import { createSchema } from "graphql-yoga";
+import type { GraphQLContext } from "./context";
 
-export const schema = createSchema({
+export const schema = createSchema<GraphQLContext>({
   typeDefs: /* GraphQL */ `
       type Query {
         hello: String!
@@ -40,6 +41,20 @@ export const schema = createSchema({
 });
 ```
 
+Define your GraphQL context in `server/graphql/context.ts`:
+
+```ts
+import type { H3Event } from "h3";
+
+export async function createContext(_event: H3Event) {
+  return {
+    foo: "bar",
+  };
+}
+
+export type GraphQLContext = Awaited<ReturnType<typeof createContext>>;
+```
+
 That's it! You can now use Nuxt GraphQL in your Nuxt app ✨
 
 

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@lewebsimple/nuxt-graphql",
   "configKey": "graphql",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -1,5 +1,5 @@
-import { useLogger, defineNuxtModule, createResolver, getLayerDirectories, addTypeTemplate, addServerTemplate, addServerHandler, addPlugin } from '@nuxt/kit';
-import { existsSync, readFileSync } from 'node:fs';
+import { useLogger, defineNuxtModule, createResolver, getLayerDirectories, addServerTemplate, addServerHandler, addPlugin } from '@nuxt/kit';
+import { existsSync } from 'node:fs';
 import { join } from 'node:path';
 
 const logger = useLogger("@lewebsimple/nuxt-graphql");
@@ -35,25 +35,31 @@ const module$1 = defineNuxtModule({
     const layerDirs = [...getLayerDirectories(nuxt), { server: serverDir.replace(rootDir, `${rootDir}/playground`) }];
     const schemaPath = findServerFile(layerDirs, "graphql/schema");
     const contextPath = findServerFile(layerDirs, "graphql/context");
-    addTypeTemplate({
-      filename: "types/graphql-runtime.d.ts",
-      getContents: () => readFileSync(resolve("./runtime/types/graphql-runtime.d.ts"), "utf-8").replace("{{schemaPath}}", schemaPath.replace(/\.ts$/, "")).replace("{{contextPath}}", contextPath.replace(/\.ts$/, ""))
-    });
-    nuxt.hook("nitro:prepare:types", ({ references }) => {
-      references.push({ path: resolve(nuxt.options.buildDir, "types/graphql-runtime.d.ts") });
-    });
     nuxt.hook("nitro:config", (nitroConfig) => {
       nitroConfig.alias ||= {};
       nitroConfig.alias["#graphql/schema"] = schemaPath;
       nitroConfig.alias["#graphql/context"] = contextPath;
-      nitroConfig.alias["#graphql/runtime"] = resolve(nuxt.options.buildDir, "types/graphql-runtime.d.ts");
-      nitroConfig.virtual ||= {};
-      nitroConfig.virtual["#graphql/runtime"] = () => "export {};";
     });
     const endpoint = options.yoga?.endpoint ?? "/api/graphql";
     addServerTemplate({
       filename: "graphql/yoga-handler",
-      getContents: () => readFileSync(resolve("./runtime/server/yoga-handler.mjs"), "utf-8").replace("{{endpoint}}", endpoint)
+      getContents: () => `
+import { createYoga } from "graphql-yoga";
+import { defineEventHandler, toWebRequest, sendWebResponse } from "h3";
+import { schema } from "#graphql/schema";
+import { createContext } from "#graphql/context";
+
+const yoga = createYoga({
+  schema,
+  graphqlEndpoint: "${endpoint}",
+});
+
+export default defineEventHandler(async (event) => {
+  const context = await createContext(event);
+  const request = toWebRequest(event);
+  const response = await yoga.handleRequest(request, context);
+  return sendWebResponse(event, response);
+});`.trim()
     });
     addServerHandler({ route: endpoint, handler: "graphql/yoga-handler" });
     nuxt.hook("listen", (_server, { url }) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lewebsimple/nuxt-graphql",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Opinionated Nuxt module for using GraphQL",
   "repository": "lewebsimple/nuxt-graphql",
   "license": "MIT",

package/dist/runtime/server/shims.d.ts

@@ -1,13 +0,0 @@
-declare module "#graphql/schema" {
-  import type { GraphQLSchema } from "graphql";
-
-  const schema: GraphQLSchema;
-  export { schema };
-}
-
-declare module "#graphql/context" {
-  import type { H3Event } from "h3";
-
-  function createContext(event: H3Event): Promise<Record<string, unknown>>;
-  export { createContext };
-}

package/dist/runtime/server/yoga-handler.d.mts

@@ -1,2 +0,0 @@
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<void>>;
-export default _default;

package/dist/runtime/server/yoga-handler.js

@@ -1,16 +0,0 @@
-import { createYoga } from "graphql-yoga";
-import { defineEventHandler, toWebRequest, sendWebResponse } from "h3";
-import { schema } from "#graphql/schema";
-import { createContext } from "#graphql/context";
-
-const yoga = createYoga({
-  schema,
-  graphqlEndpoint: "{{endpoint}}",
-});
-
-export default defineEventHandler(async (event) => {
-  const context = await createContext(event);
-  const request = toWebRequest(event);
-  const response = await yoga.handleRequest(request, context);
-  return sendWebResponse(event, response);
-});

package/dist/runtime/types/graphql-runtime.d.ts

@@ -1,18 +0,0 @@
-import type * as UserSchema from "{{schemaPath}}";
-import type * as UserContext from "{{contextPath}}";
-
-type UserCreateContext = typeof UserContext.createContext;
-
-export type GraphQLContext = Awaited<ReturnType<UserCreateContext>>;
-
-declare module "#graphql/schema" {
-  export const schema: UserSchema.schema;
-}
-
-declare module "#graphql/context" {
-  export const createContext: UserCreateContext;
-}
-
-declare module "#graphql/runtime" {
-  export type { GraphQLContext };
-}