Installation

Version 0.1.0-alpha.1

Every public package shares one version, and every published version so far is a prerelease. Until a stable release exists, latest follows the newest prerelease, so a bare pnpm add installs the current one. The API is provisional; see Support and stability for what a version number promises.

Requirements

• Node.js 22.12 or newer; 24 is what the repository develops on. Browser-only packages carry the same engines range for consistency.
• TypeScript 5.5 or newer to get the inferred model types; the published declarations are compiled against 5.5 on every change.
• ESM. Every package is ESM-only and declares "type": "module".

The full support matrix lists the tested Vue, Vue Router, Nuxt, and browser versions.

What to install

1. Always install the engine.

   pnpm add @queryweave/core

   @queryweave/core has no runtime dependencies and no framework dependency. It targets ECMAScript library types only.

2. Add the package for the environment that stores the query.

   # A browser history stack
   pnpm add @queryweave/browser
   
   # A web-standard Request, on any server, edge, or worker runtime
   pnpm add @queryweave/server
   
   # Node.js request primitives
   pnpm add @queryweave/node

3. Add a framework binding if you want one.

   pnpm add @queryweave/vue
   pnpm add @queryweave/vue-router
   pnpm add @queryweave/nuxt

   These are optional. The runtime works without any of them.

4. Add the test adapter as a development dependency.

   pnpm add -D @queryweave/testing

Package manager

QueryWeave itself is developed with pnpm, and the documentation uses pnpm add throughout. npm, Yarn, and Bun work the same way; only the command word changes.

Peer dependencies

Package	Peers
@queryweave/vue	vue >=3.5.0 <4
@queryweave/vue-router	vue >=3.5.0 <4, vue-router >=4.4.0 <6
@queryweave/nuxt	nuxt >=4.5.0 <5, vue >=3.5.0 <4, vue-router >=5.2.0 <6

No other package has a peer dependency. @queryweave/standard-schema depends on @standard-schema/spec, a types-only package, and none of them declares a dependency on a validation library or on a frontend framework.

Every package

Core

@queryweave/coreOwns the domain vocabulary: parameters, codecs, models, decode results, issues, and the runtime.Version: v0.1.0-alpha.1Runtime: Any ECMAScript runtime

Runtime adapters

@queryweave/browserSynchronizes a runtime with the History API and reports `popstate` changes.Version: v0.1.0-alpha.1Runtime: Browser@queryweave/serverDecodes and builds queries from web-standard `Request` and `URL` values.Version: v0.1.0-alpha.1Runtime: Any web-standard server, edge, or worker runtime@queryweave/nodeResolves an absolute URL from a Node request and delegates decoding.Version: v0.1.0-alpha.1Runtime: Node.js

Validation

@queryweave/standard-schemaTurns any Standard Schema validator into a QueryWeave refinement.Version: v0.1.0-alpha.1Runtime: Any ECMAScript runtime

Framework integrations

@queryweave/vueBinds one model to Vue reactivity with readonly values and explicit operations.Version: v0.1.0-alpha.1Runtime: Vue application@queryweave/vue-routerTurns a Vue Router instance into an adapter, preserving path and hash.Version: v0.1.0-alpha.1Runtime: Vue Router application@queryweave/nuxtRegisters a request-scoped runtime plugin and the Vue auto-imports.Version: v0.1.0-alpha.1Runtime: Nuxt server and client

Testing

@queryweave/testingProvides the memory adapter every other package is tested against.Version: v0.1.0-alpha.1Runtime: Any ECMAScript runtime

Next

Quick start builds a model and runs it in three environments.