eve
Version:
Filesystem-first framework for durable backend AI agents that run anywhere.
58 lines (57 loc) • 3.03 kB
TypeScript
import type * as Vercel from "#compiled/@vercel/sandbox/index.js";
type VercelCreateOptions = NonNullable<Parameters<typeof Vercel.Sandbox.create>[0]>;
type VercelUpdateOptions = Parameters<Vercel.Sandbox["update"]>[0];
type VercelSandboxInternalCreateOptions = {
readonly [key: `__${string}`]: unknown;
};
type VercelSandboxAuthorCreateOptions<T> = T extends unknown ? Omit<T, "name" | "onResume" | "persistent" | "runtime" | "signal"> & VercelSandboxInternalCreateOptions : never;
/**
* Options accepted by `vercel(opts)`. Forwarded to Vercel
* Sandbox creation for every fresh sandbox the framework creates
* (template at prewarm time, session at first-time session-create).
* Skipped on resume (`Sandbox.get`) since no create happens there.
*
* `networkPolicy` is deferred until after framework-owned base setup
* for fresh templates and template-less sessions, so eve can install
* required packages before authored bootstrap code runs. Template-backed
* session creates receive it at creation time because the template
* already contains the prepared base runtime.
*
* Framework-injected fields (`name`, `onResume`, `persistent`, `signal`)
* are excluded: the framework owns those and overrides any
* author-supplied values.
*
* `runtime` is excluded as well: eve always boots its sandboxes from the
* published eve image, which is mutually exclusive with a stock runtime.
*
* `source` is honored only on the template create at prewarm time, so
* an author-supplied snapshot, git revision, or tarball becomes the
* base layer for the template. Framework setup, bootstrap, and seed
* files all run on top, and the resulting
* framework-owned snapshot is what every later session derives from,
* so `source` is stripped from the session-create path. eve does not
* detect external snapshot changes; to pick up a rebuilt external
* snapshot, force a template rebuild (e.g. by changing the sandbox
* definition so its template key changes).
*/
export type VercelSandboxCreateOptions = VercelSandboxAuthorCreateOptions<VercelCreateOptions>;
/**
* Options accepted by the Vercel backend's `bootstrap({ use })` hook.
* Tracks the Vercel SDK's `Sandbox.update(...)` parameter because bootstrap
* applies its options to the template via `sandbox.update(...)` after
* `Sandbox.create()` and before the snapshot is captured. The Vercel
* SDK persists `update`-d settings on the sandbox so they survive into
* the snapshot, which becomes the seed for every later session.
*
* Today this is the same shape as
* {@link VercelSandboxSessionUseOptions}; both are exposed as separate
* named aliases so future divergence is non-breaking.
*/
export type VercelSandboxBootstrapUseOptions = VercelUpdateOptions;
/**
* Options accepted by the Vercel backend's `onSession({ use })` hook.
* Tracks the Vercel SDK's `Sandbox.update(...)` parameter; passed values are
* applied to the live session via the SDK's `update`.
*/
export type VercelSandboxSessionUseOptions = VercelUpdateOptions;
export {};