@queryweave/nuxt 0.1.0-alpha.1 → 0.1.0-beta.1

package/README.md

@@ -2,6 +2,10 @@
 
 A minimal Nuxt module and runtime plugin.
 
+```sh
+pnpm add @queryweave/nuxt
+```
+
 ```ts
 export default defineNuxtConfig({
   modules: ["@queryweave/nuxt"],
@@ -17,3 +21,5 @@ hydration matches.
 
 Module-time exports and `./runtime` exports stay separate, and no runtime state is held at module
 scope. The Nuxt-specific API is deliberately small and not final.
+
+Documentation: https://queryweave-docs.vercel.app/frameworks/nuxt/

package/dist/index.js

@@ -9,7 +9,7 @@ const queryWeaveModule = defineNuxtModule({
 	meta: {
 		name: "@queryweave/nuxt",
 		configKey: "queryweave",
-		compatibility: { nuxt: ">=4.0.0" }
+		compatibility: { nuxt: ">=4.5.0" }
 	},
 	defaults: {
 		autoImports: true,

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { addImports, addPlugin, createResolver, defineNuxtModule } from \"@nuxt/kit\";\nimport type { NuxtModule } from \"@nuxt/schema\";\n\n/**\n * Module-time surface.\n *\n * Nothing here runs per request. Request-scoped state is created by the runtime plugin, which is\n * registered below and exported separately under `@queryweave/nuxt/runtime`.\n */\n\n/** Options accepted under the `queryweave` key of `nuxt.config`. */\nexport interface QueryWeaveModuleOptions {\n  /** Register auto-imports for the Vue binding. Enabled by default. */\n  readonly autoImports?: boolean;\n  /** Register the runtime plugin. Enabled by default. */\n  readonly enabled?: boolean;\n}\n\n/**\n * The module is annotated explicitly so the generated declaration stays self-contained. Without\n * it, the inferred type references type parameters a consumer cannot resolve.\n */\nconst queryWeaveModule: NuxtModule<QueryWeaveModuleOptions> =\n  defineNuxtModule<QueryWeaveModuleOptions>({\n    meta: {\n      name: \"@queryweave/nuxt\",\n      configKey: \"queryweave\",\n      compatibility: {\n        nuxt: \">=4.0.0\",\n      },\n    },\n    defaults: {\n      autoImports: true,\n      enabled: true,\n    },\n    setup(options: QueryWeaveModuleOptions) {\n      if (options.enabled === false) {\n        return;\n      }\n\n      const resolver = createResolver(import.meta.url);\n      addPlugin(resolver.resolve(\"./runtime/plugin\"));\n\n      if (options.autoImports === false) {\n        return;\n      }\n\n      addImports([\n        { name: \"useQueryModel\", from: \"@queryweave/vue\" },\n        { name: \"provideQueryAdapter\", from: \"@queryweave/vue\" },\n      ]);\n    },\n  });\n\nexport default queryWeaveModule;\n"],"mappings":";;;;;;;AAsBA,MAAM,mBACJ,iBAA0C;CACxC,MAAM;EACJ,MAAM;EACN,WAAW;EACX,eAAe,EACb,MAAM,UACR;CACF;CACA,UAAU;EACR,aAAa;EACb,SAAS;CACX;CACA,MAAM,SAAkC;EACtC,IAAI,QAAQ,YAAY,OACtB;EAIF,UADiB,eAAe,OAAO,KAAK,GAC3B,CAAC,CAAC,QAAQ,kBAAkB,CAAC;EAE9C,IAAI,QAAQ,gBAAgB,OAC1B;EAGF,WAAW,CACT;GAAE,MAAM;GAAiB,MAAM;EAAkB,GACjD;GAAE,MAAM;GAAuB,MAAM;EAAkB,CACzD,CAAC;CACH;AACF,CAAC"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { addImports, addPlugin, createResolver, defineNuxtModule } from \"@nuxt/kit\";\nimport type { NuxtModule } from \"@nuxt/schema\";\n\n/**\n * Module-time surface.\n *\n * Nothing here runs per request. Request-scoped state is created by the runtime plugin, which is\n * registered below and exported separately under `@queryweave/nuxt/runtime`.\n */\n\n/** Options accepted under the `queryweave` key of `nuxt.config`. */\nexport interface QueryWeaveModuleOptions {\n  /** Register auto-imports for the Vue binding. Enabled by default. */\n  readonly autoImports?: boolean;\n  /** Register the runtime plugin. Enabled by default. */\n  readonly enabled?: boolean;\n}\n\n/**\n * The module is annotated explicitly so the generated declaration stays self-contained. Without\n * it, the inferred type references type parameters a consumer cannot resolve.\n */\nconst queryWeaveModule: NuxtModule<QueryWeaveModuleOptions> =\n  defineNuxtModule<QueryWeaveModuleOptions>({\n    meta: {\n      name: \"@queryweave/nuxt\",\n      configKey: \"queryweave\",\n      compatibility: {\n        nuxt: \">=4.5.0\",\n      },\n    },\n    defaults: {\n      autoImports: true,\n      enabled: true,\n    },\n    setup(options: QueryWeaveModuleOptions) {\n      if (options.enabled === false) {\n        return;\n      }\n\n      const resolver = createResolver(import.meta.url);\n      addPlugin(resolver.resolve(\"./runtime/plugin\"));\n\n      if (options.autoImports === false) {\n        return;\n      }\n\n      addImports([\n        { name: \"useQueryModel\", from: \"@queryweave/vue\" },\n        { name: \"provideQueryAdapter\", from: \"@queryweave/vue\" },\n      ]);\n    },\n  });\n\nexport default queryWeaveModule;\n"],"mappings":";;;;;;;AAsBA,MAAM,mBACJ,iBAA0C;CACxC,MAAM;EACJ,MAAM;EACN,WAAW;EACX,eAAe,EACb,MAAM,UACR;CACF;CACA,UAAU;EACR,aAAa;EACb,SAAS;CACX;CACA,MAAM,SAAkC;EACtC,IAAI,QAAQ,YAAY,OACtB;EAIF,UADiB,eAAe,OAAO,KAAK,GAC3B,CAAC,CAAC,QAAQ,kBAAkB,CAAC;EAE9C,IAAI,QAAQ,gBAAgB,OAC1B;EAGF,WAAW,CACT;GAAE,MAAM;GAAiB,MAAM;EAAkB,GACjD;GAAE,MAAM;GAAuB,MAAM;EAAkB,CACzD,CAAC;CACH;AACF,CAAC"}

package/dist/runtime/index.d.ts

@@ -9,8 +9,16 @@ import { Router } from "vue-router";
  * Every helper here takes the Vue application and router it should serve. Nothing is stored at
  * module scope, so a server rendering two requests never shares adapter state between them.
  */
+/** Options accepted by {@link createNuxtQueryAdapter}. */
+interface NuxtQueryAdapterOptions {
+  /**
+   * Whether the adapter serves a server render. Transitions are then refused with a reason
+   * instead of moving a router whose response is already being written; reading still works.
+   */
+  readonly server?: boolean | undefined;
+}
 /** Create the adapter a Nuxt application should use. */
-declare function createNuxtQueryAdapter(router: Router): VueRouterQueryAdapter$1;
+declare function createNuxtQueryAdapter(router: Router, options?: NuxtQueryAdapterOptions): VueRouterQueryAdapter$1;
 /**
  * Install an adapter into one Vue application instance.
  *
@@ -18,5 +26,5 @@ declare function createNuxtQueryAdapter(router: Router): VueRouterQueryAdapter$1
  */
 declare function installQueryAdapter(app: App, adapter: QueryAdapter): void;
 //#endregion
-export { type VueRouterQueryAdapter, createNuxtQueryAdapter, installQueryAdapter };
+export { type NuxtQueryAdapterOptions, type VueRouterQueryAdapter, createNuxtQueryAdapter, installQueryAdapter };
 //# sourceMappingURL=index.d.ts.map

package/dist/runtime/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/runtime/adapter.ts"],"mappings":";;;;;;;;;;;;iBAcgB,uBAAuB,QAAQ,SAAS;;;;;;iBASxC,oBAAoB,KAAK,KAAK,SAAS"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/runtime/adapter.ts"],"mappings":";;;;;;;;;;;;UAciB;;;;;WAKN;;;iBAIK,uBACd,QAAQ,QACR,UAAS,0BACR;;;;;;iBAmBa,oBAAoB,KAAK,KAAK,SAAS"}

package/dist/runtime/plugin.js

@@ -12,7 +12,7 @@ var plugin_default = defineNuxtPlugin({
 	name: "queryweave:adapter",
 	setup(nuxtApp) {
 		const router = nuxtApp["$router"];
-		const adapter = createNuxtQueryAdapter(router);
+		const adapter = createNuxtQueryAdapter(router, { server: import.meta.server });
 		installQueryAdapter(nuxtApp.vueApp, adapter);
 		return { provide: { queryWeaveAdapter: adapter } };
 	}

package/dist/runtime/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","names":[],"sources":["../../src/runtime/plugin.ts"],"sourcesContent":["import { defineNuxtPlugin } from \"nuxt/app\";\nimport type { Router } from \"vue-router\";\n\nimport { createNuxtQueryAdapter, installQueryAdapter } from \"./adapter\";\n\n/**\n * Registers one adapter per Vue application instance.\n *\n * Nuxt creates a fresh application for every server render, so the adapter is request-scoped by\n * construction. No runtime global is read here, which keeps server rendering safe.\n */\nexport default defineNuxtPlugin({\n  name: \"queryweave:adapter\",\n  setup(nuxtApp) {\n    const router = nuxtApp[\"$router\"] as Router;\n    const adapter = createNuxtQueryAdapter(router);\n    installQueryAdapter(nuxtApp.vueApp, adapter);\n\n    return {\n      provide: {\n        queryWeaveAdapter: adapter,\n      },\n    };\n  },\n});\n"],"mappings":";;;;;;;;;;AAWA,qBAAe,iBAAiB;CAC9B,MAAM;CACN,MAAM,SAAS;EACb,MAAM,SAAS,QAAQ;EACvB,MAAM,UAAU,uBAAuB,MAAM;EAC7C,oBAAoB,QAAQ,QAAQ,OAAO;EAE3C,OAAO,EACL,SAAS,EACP,mBAAmB,QACrB,EACF;CACF;AACF,CAAC"}
+{"version":3,"file":"plugin.js","names":[],"sources":["../../src/runtime/plugin.ts"],"sourcesContent":["import { defineNuxtPlugin } from \"nuxt/app\";\nimport type { Router } from \"vue-router\";\n\nimport { createNuxtQueryAdapter, installQueryAdapter } from \"./adapter\";\n\n/**\n * Registers one adapter per Vue application instance.\n *\n * Nuxt creates a fresh application for every server render, so the adapter is request-scoped by\n * construction. No runtime global is read here, which keeps server rendering safe.\n */\nexport default defineNuxtPlugin({\n  name: \"queryweave:adapter\",\n  setup(nuxtApp) {\n    const router = nuxtApp[\"$router\"] as Router;\n    const adapter = createNuxtQueryAdapter(router, { server: import.meta.server });\n    installQueryAdapter(nuxtApp.vueApp, adapter);\n\n    return {\n      provide: {\n        queryWeaveAdapter: adapter,\n      },\n    };\n  },\n});\n"],"mappings":";;;;;;;;;;AAWA,qBAAe,iBAAiB;CAC9B,MAAM;CACN,MAAM,SAAS;EACb,MAAM,SAAS,QAAQ;EACvB,MAAM,UAAU,uBAAuB,QAAQ,EAAE,QAAQ,OAAO,KAAK,OAAO,CAAC;EAC7E,oBAAoB,QAAQ,QAAQ,OAAO;EAE3C,OAAO,EACL,SAAS,EACP,mBAAmB,QACrB,EACF;CACF;AACF,CAAC"}

package/dist/shared/adapter.js

@@ -2,15 +2,19 @@ import { queryAdapterKey } from "@queryweave/vue";
 import { createVueRouterAdapter } from "@queryweave/vue-router";
 
 //#region src/runtime/adapter.ts
-/**
-* Request-scoped runtime wiring.
-*
-* Every helper here takes the Vue application and router it should serve. Nothing is stored at
-* module scope, so a server rendering two requests never shares adapter state between them.
-*/
 /** Create the adapter a Nuxt application should use. */
-function createNuxtQueryAdapter(router) {
-	return createVueRouterAdapter(router);
+function createNuxtQueryAdapter(router, options = {}) {
+	const adapter = createVueRouterAdapter(router);
+	if (options.server !== true) return adapter;
+	const refuse = () => ({
+		outcome: "refused",
+		reason: /* @__PURE__ */ new Error("QueryWeave transitions are not available during server rendering. Redirect with navigateTo() instead.")
+	});
+	return {
+		...adapter,
+		push: () => refuse(),
+		replace: () => refuse()
+	};
 }
 /**
 * Install an adapter into one Vue application instance.

package/dist/shared/adapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"adapter.js","names":[],"sources":["../../src/runtime/adapter.ts"],"sourcesContent":["import type { QueryAdapter } from \"@queryweave/core\";\nimport { queryAdapterKey } from \"@queryweave/vue\";\nimport { createVueRouterAdapter, type VueRouterQueryAdapter } from \"@queryweave/vue-router\";\nimport type { App } from \"vue\";\nimport type { Router } from \"vue-router\";\n\n/**\n * Request-scoped runtime wiring.\n *\n * Every helper here takes the Vue application and router it should serve. Nothing is stored at\n * module scope, so a server rendering two requests never shares adapter state between them.\n */\n\n/** Create the adapter a Nuxt application should use. */\nexport function createNuxtQueryAdapter(router: Router): VueRouterQueryAdapter {\n  return createVueRouterAdapter(router);\n}\n\n/**\n * Install an adapter into one Vue application instance.\n *\n * Any adapter is accepted, so an application can substitute its own without leaving the module.\n */\nexport function installQueryAdapter(app: App, adapter: QueryAdapter): void {\n  app.provide(queryAdapterKey, adapter);\n}\n"],"mappings":";;;;;;;;;;;AAcA,SAAgB,uBAAuB,QAAuC;CAC5E,OAAO,uBAAuB,MAAM;AACtC;;;;;;AAOA,SAAgB,oBAAoB,KAAU,SAA6B;CACzE,IAAI,QAAQ,iBAAiB,OAAO;AACtC"}
+{"version":3,"file":"adapter.js","names":[],"sources":["../../src/runtime/adapter.ts"],"sourcesContent":["import type { QueryAdapter, QueryNavigationResult } from \"@queryweave/core\";\nimport { queryAdapterKey } from \"@queryweave/vue\";\nimport { createVueRouterAdapter, type VueRouterQueryAdapter } from \"@queryweave/vue-router\";\nimport type { App } from \"vue\";\nimport type { Router } from \"vue-router\";\n\n/**\n * Request-scoped runtime wiring.\n *\n * Every helper here takes the Vue application and router it should serve. Nothing is stored at\n * module scope, so a server rendering two requests never shares adapter state between them.\n */\n\n/** Options accepted by {@link createNuxtQueryAdapter}. */\nexport interface NuxtQueryAdapterOptions {\n  /**\n   * Whether the adapter serves a server render. Transitions are then refused with a reason\n   * instead of moving a router whose response is already being written; reading still works.\n   */\n  readonly server?: boolean | undefined;\n}\n\n/** Create the adapter a Nuxt application should use. */\nexport function createNuxtQueryAdapter(\n  router: Router,\n  options: NuxtQueryAdapterOptions = {},\n): VueRouterQueryAdapter {\n  const adapter = createVueRouterAdapter(router);\n  if (options.server !== true) {\n    return adapter;\n  }\n  const refuse = (): QueryNavigationResult => ({\n    outcome: \"refused\",\n    reason: new Error(\n      \"QueryWeave transitions are not available during server rendering. Redirect with navigateTo() instead.\",\n    ),\n  });\n  return { ...adapter, push: () => refuse(), replace: () => refuse() };\n}\n\n/**\n * Install an adapter into one Vue application instance.\n *\n * Any adapter is accepted, so an application can substitute its own without leaving the module.\n */\nexport function installQueryAdapter(app: App, adapter: QueryAdapter): void {\n  app.provide(queryAdapterKey, adapter);\n}\n"],"mappings":";;;;;AAuBA,SAAgB,uBACd,QACA,UAAmC,CAAC,GACb;CACvB,MAAM,UAAU,uBAAuB,MAAM;CAC7C,IAAI,QAAQ,WAAW,MACrB,OAAO;CAET,MAAM,gBAAuC;EAC3C,SAAS;EACT,wBAAQ,IAAI,MACV,uGACF;CACF;CACA,OAAO;EAAE,GAAG;EAAS,YAAY,OAAO;EAAG,eAAe,OAAO;CAAE;AACrE;;;;;;AAOA,SAAgB,oBAAoB,KAAU,SAA6B;CACzE,IAAI,QAAQ,iBAAiB,OAAO;AACtC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@queryweave/nuxt",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-beta.1",
   "description": "Nuxt module and runtime integration contracts for QueryWeave.",
   "keywords": [
     "nuxt",
@@ -46,11 +46,11 @@
     "provenance": true
   },
   "dependencies": {
-    "@nuxt/kit": "4.5.0",
-    "@nuxt/schema": "4.5.0",
-    "@queryweave/core": "0.1.0-alpha.1",
-    "@queryweave/vue": "0.1.0-alpha.1",
-    "@queryweave/vue-router": "0.1.0-alpha.1"
+    "@nuxt/kit": "^4.5.0",
+    "@nuxt/schema": "^4.5.0",
+    "@queryweave/core": "0.1.0-beta.1",
+    "@queryweave/vue": "0.1.0-beta.1",
+    "@queryweave/vue-router": "0.1.0-beta.1"
   },
   "devDependencies": {
     "nuxt": "4.5.0",
@@ -64,7 +64,7 @@
     "vue-router": ">=5.2.0 <6"
   },
   "engines": {
-    "node": ">=24.18.0"
+    "node": ">=22.12.0"
   },
   "scripts": {
     "build": "tsdown",