eve/bin/eve.d.ts

Filesystem-first framework for durable backend AI agents that run anywhere.

export interface BootstrapOptions {
  /**
   * Absolute path to the compiled CLI module.
   */
  cliEntrypointPath?: string;

  /**
   * Absolute path to the eve package root.
   */
  packageRoot?: string;

  /**
   * Absolute paths to scripts that run after workspace bootstrap compilation.
   */
  postBuildScriptPaths?: readonly string[];

  /**
   * Absolute path to the tsc CLI entrypoint used for bootstrap builds.
   */
  tscCliPath?: string;
}

export interface BootstrapCommandOptions {
  cwd: string;
}

export interface BootstrapBuildDependencies {
  exists?: (path: string) => Promise<boolean>;
  getLatestBuildInputMtimeMs?: (input: { packageRoot: string }) => Promise<number>;
  getPathMtimeMs?: (path: string) => Promise<number | undefined>;
  runCommand?: (
    command: string,
    args: readonly string[],
    options: BootstrapCommandOptions,
  ) => Promise<void>;
}

export interface BootstrapCliModule {
  runCli(argv?: string[]): Promise<void>;
}

export interface BootstrapSemverModule {
  default: {
    validRange(range: string | undefined): string | null;
    satisfies(version: string, range: string): boolean;
  };
}

export interface BootstrapDependencies extends BootstrapBuildDependencies {
  importBootstrapModule?: (specifier: string) => Promise<BootstrapSemverModule>;

  importModule?: (specifier: string) => Promise<BootstrapCliModule>;

  /**
   * Node.js version string used by tests to exercise the bin version guard.
   */
  nodeVersion?: string;

  /**
   * Node.js engine range used by tests to exercise non-default package contracts.
   */
  nodeEngineRequirement?: string;
}

/**
 * Ensures the compiled CLI entrypoint exists before the workspace bin is executed.
 */
export function ensureBuiltCli(
  overrides?: BootstrapOptions,
  dependencies?: BootstrapBuildDependencies,
): Promise<string>;

/**
 * Runs the compiled eve CLI, building the workspace package on demand when needed.
 */
export function runEveCli(
  argv?: string[],
  overrides?: BootstrapOptions,
  dependencies?: BootstrapDependencies,
): Promise<void>;