@stonecrop/nuxt-grafserv 0.13.12 → 0.14.0

package/README.md

@@ -138,7 +138,7 @@ Use `type: 'postgraphile'` for PostGraphile-based GraphQL APIs:
 | `schemas` | `string[]` | ❌ | PostgreSQL schemas to expose (default: `['public']`). Ignored when `preset` is set. |
 | `explain` | `boolean` | ❌ | Enable Ruru Explain tab. **Never use in production.** Ignored when `preset` is set. |
 | `url` | `string` | ❌ | GraphQL endpoint URL (default: `/graphql/`) |
-| `graphiql` | `boolean` | ❌ | Enable GraphiQL IDE (default: `true`) |
+| `graphiql` | `boolean` | ❌ | Serve the Ruru GraphiQL IDE and its static assets. Defaults to `true` in development and `false` in production. |
 
 **Minimal example (no preset file):**
 
@@ -181,7 +181,7 @@ Use `type: 'schema'` for custom GraphQL schemas with Grafast resolvers:
 | `schema` | `string \| string[] \| SchemaProvider` | ✅ | Path(s) to .graphql files or schema provider function |
 | `resolvers` | `string` | ❌ | Path to resolvers file (required for .graphql files) |
 | `url` | `string` | ❌ | GraphQL endpoint URL (default: `/graphql/`) |
-| `graphiql` | `boolean` | ❌ | Enable GraphiQL IDE (default: `true`) |
+| `graphiql` | `boolean` | ❌ | Serve the Ruru GraphiQL IDE and its static assets. Defaults to `true` in development and `false` in production. |
 
 **Example with files:**
 
@@ -551,13 +551,11 @@ This package lives inside the Stonecrop Rush monorepo. Use `rushx` instead of `p
 # Install all monorepo dependencies (run from the repo root)
 rush install
 
-# Bootstrap the playground database (first time only — requires Docker)
-cd playground && node scripts/bootstrap.mjs
-
 # Generate type stubs
 rushx dev:prepare
 
-# Develop with the playground (from nuxt_grafserv/)
+# Develop with the playground (from nuxt_grafserv/).
+# Starts + migrates the Postgres container (Docker required), then runs Nuxt.
 rushx dev
 
 # Build the module
@@ -571,7 +569,7 @@ rushx test
 rushx test:watch
 ```
 
-The playground runs against a PostgreSQL container managed by Docker Compose. The bootstrap script handles container startup, `.env` creation, and running the initial migration. On subsequent runs `rushx dev` is all that's needed (the container persists via a named volume).
+The playground runs against a PostgreSQL container managed by Docker Compose. `rushx dev` starts the container and applies migrations automatically (via `playground/scripts/bootstrap.mjs`) before launching Nuxt, so Docker must be running; both steps are idempotent, so this is a fast no-op once the container exists (it persists via a named volume). To manage the database on its own, run `pnpm db:up` / `pnpm db:down` (or `node scripts/bootstrap.mjs` to recreate and migrate) from `playground/`.
 
 <!-- Badges -->
 [npm-version-src]: https://img.shields.io/npm/v/@stonecrop/nuxt-grafserv/latest.svg?style=flat&colorA=020420&colorB=00DC82

package/dist/module.d.mts

@@ -110,7 +110,10 @@ interface PostGraphileConfig {
     debug?: boolean;
     /** GraphQL endpoint URL (default: '/graphql/') */
     url?: string;
-    /** Whether to enable GraphiQL IDE (default: true in dev, false in prod) */
+    /**
+     * Serve the GraphiQL IDE (Ruru) and its static assets. Defaults to `true` in
+     * development and `false` in production.
+     */
     graphiql?: boolean;
 }
 /**
@@ -165,7 +168,10 @@ interface SchemaConfig {
     resolvers?: string;
     /** GraphQL endpoint URL (default: '/graphql/') */
     url?: string;
-    /** Whether to enable GraphiQL IDE (default: true in dev, false in prod) */
+    /**
+     * Serve the GraphiQL IDE (Ruru) and its static assets. Defaults to `true` in
+     * development and `false` in production.
+     */
     graphiql?: boolean;
 }
 /**

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@stonecrop/nuxt-grafserv",
   "configKey": "grafserv",
-  "version": "0.13.12",
+  "version": "0.14.0",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -49,6 +49,7 @@ const module$1 = defineNuxtModule({
       return;
     }
     validateConfig(options);
+    const graphiqlEnabled = options.graphiql ?? nuxt.options.dev;
     const { resolve } = createResolver(import.meta.url);
     const require = createRequire(import.meta.url);
     nuxt.hook("nitro:config", (config) => {
@@ -179,7 +180,7 @@ export default {
         config.runtimeConfig.grafserv = {
           type: "postgraphile",
           url: options.url || "/graphql/",
-          graphiql: options.graphiql
+          graphiql: graphiqlEnabled
         };
       } else if (options.type === "schema") {
         logger.info("Using schema configuration");
@@ -208,7 +209,7 @@ export default {
           schema: runtimeSchema,
           resolversPath: resolverPath,
           url: options.url || "/graphql/",
-          graphiql: options.graphiql
+          graphiql: graphiqlEnabled
         };
         config.virtual = config.virtual || {};
         if (resolverPath) {
@@ -245,7 +246,7 @@ export default {
       addServerPlugin(resolve("./runtime/startup-check"));
     }
     addServerHandler({ route: options.url || "/graphql/", handler: resolve("./runtime/handler") });
-    if (options.graphiql) {
+    if (graphiqlEnabled) {
       addServerHandler({ route: "/ruru-static/**", handler: resolve("./runtime/ruru-static") });
     }
     if (nuxt.options.dev) {

package/dist/runtime/handler.js

@@ -2,7 +2,7 @@ import { GraphQLFileLoader } from "@graphql-tools/graphql-file-loader";
 import { loadTypedefs } from "@graphql-tools/load";
 import { grafserv } from "grafserv/h3/v1";
 import { makeGrafastSchema } from "grafast";
-import { defineEventHandler } from "h3";
+import { defineEventHandler, setResponseStatus } from "h3";
 import { useRuntimeConfig } from "nitropack/runtime";
 let grafservInstance = null;
 let cachedSchema = null;
@@ -94,13 +94,22 @@ export async function clearGrafservCache() {
 export default defineEventHandler(async (event) => {
   const config = useRuntimeConfig();
   const options = config.grafserv;
+  const graphiqlEnabled = options.graphiql ?? false;
   try {
     const serv = await getGrafservInstance(options);
+    if (!graphiqlEnabled && event.method === "GET") {
+      setResponseStatus(event, 404);
+      return "GraphiQL is disabled";
+    }
     const graphqlResult = await serv.handleGraphQLEvent(event);
     if (graphqlResult !== null) {
       return graphqlResult;
     }
-    return serv.handleGraphiqlEvent(event);
+    if (graphiqlEnabled) {
+      return serv.handleGraphiqlEvent(event);
+    }
+    setResponseStatus(event, 404);
+    return "GraphiQL is disabled";
   } catch (error) {
     console.error("[@stonecrop/nuxt-grafserv] Error in GraphQL handler:", error);
     throw error;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stonecrop/nuxt-grafserv",
-  "version": "0.13.12",
+  "version": "0.14.0",
   "description": "Pluggable Grafserv GraphQL server as Nuxt Module",
   "license": "MIT",
   "type": "module",
@@ -44,31 +44,31 @@
     "grafserv": "^1.0.0",
     "graphql": "^16.14.0",
     "postgraphile": "^5.0.3",
-    "@stonecrop/graphql-middleware": "0.13.12"
+    "@stonecrop/graphql-middleware": "0.14.0"
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
     "@nuxt/devtools": "^3.2.4",
-    "@nuxt/eslint-config": "^1.15.2",
+    "@nuxt/eslint-config": "^1.16.0",
     "@nuxt/kit": "^4.4.4",
     "@nuxt/module-builder": "^1.0.2",
-    "@nuxt/schema": "^4.4.4",
+    "@nuxt/schema": "^4.4.8",
     "@nuxt/test-utils": "^4.0.3",
     "@vitest/coverage-istanbul": "^4.1.5",
     "@types/node": "^24.12.4",
-    "h3": "^1.15.5",
+    "h3": "^1.15.11",
     "nitropack": "^2.13.1",
     "changelogen": "^0.6.2",
-    "eslint": "^10.3.0",
+    "eslint": "^10.6.0",
     "jsdom": "^29.1.1",
-    "nuxt": "^4.4.4",
+    "nuxt": "^4.4.8",
     "postgraphile": "^5.0.3",
     "typescript": "^6.0.3",
     "vite": "^7.3.2",
     "vitest": "^4.1.5",
     "vue": "^3.5.33",
     "vue-router": "^5.0.6",
-    "vue-tsc": "^3.2.7"
+    "vue-tsc": "^3.3.6"
   },
   "peerDependencies": {
     "@stonecrop/casl-middleware": "*",
@@ -91,7 +91,7 @@
     "build": "rushx dev:prepare && rushx prepack",
     "build:module": "rushx dev:prepare && rushx prepack",
     "docs": "echo 'Nuxt modules use custom build system - skipping API docs generation'",
-    "dev": "nuxi dev playground",
+    "dev": "node playground/scripts/bootstrap.mjs && nuxi dev playground --host",
     "dev:build": "nuxi build playground",
     "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
     "lint": "eslint .",

package/dist/runtime/graphql.d.ts

@@ -1,6 +0,0 @@
-/**
- * GraphQL operations handler
- * Handles POST requests with GraphQL queries, mutations, and subscriptions
- */
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<Buffer<ArrayBufferLike> | import("grafserv").JSONValue | undefined>>;
-export default _default;

package/dist/runtime/graphql.js

@@ -1,9 +0,0 @@
-import { defineEventHandler } from "h3";
-import { useRuntimeConfig } from "nitropack/runtime";
-import { getGrafservInstance } from "./handler.js";
-export default defineEventHandler(async (event) => {
-  const config = useRuntimeConfig();
-  const options = config.grafserv;
-  const serv = await getGrafservInstance(options);
-  return serv.handleGraphQLEvent(event);
-});

package/dist/runtime/ruru.d.ts

@@ -1,6 +0,0 @@
-/**
- * Ruru/GraphiQL UI handler
- * Serves the GraphQL IDE interface for exploring and testing the API
- */
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<Buffer<ArrayBufferLike> | import("grafserv").JSONValue | undefined>>;
-export default _default;

package/dist/runtime/ruru.js

@@ -1,9 +0,0 @@
-import { defineEventHandler } from "h3";
-import { useRuntimeConfig } from "nitropack/runtime";
-import { getGrafservInstance } from "./handler.js";
-export default defineEventHandler(async (event) => {
-  const config = useRuntimeConfig();
-  const options = config.grafserv;
-  const serv = await getGrafservInstance(options);
-  return serv.handleGraphiqlEvent(event);
-});