Package Exports
Reference for supported import paths, Nuxt aliases, and auto-import boundaries.
Application-facing entries
| Import | Purpose |
|---|---|
@lupinum/better-convex-nuxt | Nuxt module and ordinary root types |
@lupinum/better-convex-nuxt/auth-client | Advanced Better Auth client definition and inference types |
@lupinum/better-convex-nuxt/convex-auth | Convex-side Better Auth integration and user projection helper |
@lupinum/better-convex-nuxt/errors | Framework-free call error contract |
@lupinum/better-convex-nuxt/server | Server caller and token-exchange boundaries |
The package also publishes generated Convex component/configuration paths used by codegen and
testing. The generated API surface is the single exact inventory.
Do not deep-import dist, src/runtime, or build-directory files.
Vue entries
| Import | Status | Purpose |
|---|---|---|
@lupinum/better-convex-vue | Beta | Vue plugin plus query, pagination, mutation, action, and connection state |
@lupinum/better-convex-vue/errors | Beta | Framework-neutral sanitized client error contract |
@lupinum/better-convex-vue/embedded | Beta | Frozen token-free runtime attachment for an embedded Vue root |
@lupinum/better-convex-vue/mcp-app | Experimental | Official MCP Apps client lifecycle for a sandboxed App iframe |
The ordinary Vue entry does not import the MCP Apps SDK. The embedded entry does not expose credentials or a raw replaceable Convex client.
MCP entry
@lupinum/better-convex-mcp is an experimental, provider-neutral resource-server
package. Its current beta exposes the bounded Convex HTTP handler, verifier
contracts, safe access context, and sanitized tool-result helper. It does not
depend on Nuxt or Better Auth, auto-export Convex functions, or own application
authorization.
Nuxt aliases
| Alias | Target |
|---|---|
#convex/api | Consumer convex/_generated/api |
#convex/server | Published Better Convex Nuxt server surface |
Use #convex/api in components, composables, middleware, and Nitro handlers. Convex code under convex/ uses its relative generated imports instead.
Auto-imports
The module auto-imports the documented core composables into Nuxt application code and
request-bound serverConvex into Nitro server code. Auth-enabled builds additionally auto-import
useConvexAuth and the auth route middleware. No auth facade or global auth components exist in a
Convex-only build.
Root types
The root exports ordinary types for module options, auth status/options, runtime configuration, client handle, and primary composable options. Advanced auth-client inference, error taxonomy, and server-only options live on their dedicated subpaths.
Runtime values other than the default Nuxt module live in their dedicated entries or Nuxt auto-import surface.
Missing generated API
Before Convex codegen creates convex/_generated/api, #convex/api points to a diagnostic placeholder. Accessing a function produces a codegen-oriented error instead of an untyped fallback.
See the generated API surface for the exact current inventory.