eve
Version:
Filesystem-first framework for durable backend AI agents that run anywhere.
44 lines (43 loc) • 1.96 kB
TypeScript
import { EVE_NUXT_SERVICE_PREFIX } from "./routing.js";
export { EVE_NUXT_SERVICE_PREFIX };
/**
* Options for the eve Nuxt module.
*/
export interface EveNuxtModuleOptions {
/**
* Path to the eve application root, resolved relative to the Nuxt project
* root unless absolute. Defaults to the Nuxt project root. The dev server is
* spawned here and written as the eve service entrypoint in `vercel.json`
* (relative to the Nuxt root).
*/
eveRoot?: string;
/**
* Build command for the generated eve Vercel service. Defaults to `"eve build"`.
*/
eveBuildCommand?: string;
/**
* Set to `false` to skip creating or updating `vercel.json`. By default the
* module ensures `vercel.json` contains `experimentalServices` for the Nuxt
* app and eve app.
*/
configureVercelJson?: boolean;
/**
* Private Vercel service prefix eve transport is proxied to. Defaults to
* {@link EVE_NUXT_SERVICE_PREFIX}. When `configureVercelJson` is enabled, it
* is written as the eve service `routePrefix`, but an existing `routePrefix`
* in `vercel.json` takes precedence. Normalized to a leading-slash,
* no-trailing-slash route; cannot resolve to `/`.
*/
servicePrefix?: string;
}
/**
* Nuxt module that wires an eve agent into a Nuxt app. Register under `modules`
* (configured via the `eve` config key). It auto-imports the `useEveAgent()`
* composable, routes eve transport requests (`/eve/v1/**`) to the eve service
* (a shared dev server spawned on demand in dev, a Vercel sibling service or a
* configured origin/port in production), and unless `configureVercelJson` is
* `false`, ensures `vercel.json` declares both the Nuxt and eve services.
* Requires Nuxt >= 4.0.0. Configure via {@link EveNuxtModuleOptions}.
*/
declare const _default: import("nuxt/schema").NuxtModule<EveNuxtModuleOptions, EveNuxtModuleOptions, false>;
export default _default;