Skip to content

armgit / eve

Public Imported from GitHub
0

The Open Framework for Building Agents

fix(eve): avoid npm override conflict in web chat setup (#2363)

Shar3811d81d4f95
diff --git a/.changeset/calm-web-scripts.md b/.changeset/calm-web-scripts.md
new file mode 100644
index 000000000..a90049e51
--- /dev/null
+++ b/.changeset/calm-web-scripts.md
@@ -0,0 +1,5 @@
+---
+"eve": patch
+---
+
+Update the project scripts after `eve add channel/web` so `pnpm dev` starts the generated Next.js app.
diff --git a/.changeset/tidy-dingos-chat.md b/.changeset/tidy-dingos-chat.md
new file mode 100644
index 000000000..4e6f171d2
--- /dev/null
+++ b/.changeset/tidy-dingos-chat.md
@@ -0,0 +1,5 @@
+---
+"eve": patch
+---
+
+New npm, Yarn, and Bun agents no longer receive an obsolete AI SDK package-manager pin. Web Chat installation now preserves the AI SDK version already declared by the agent, avoiding npm `EOVERRIDE` failures.
diff --git a/apps/docs/registry.json b/apps/docs/registry.json
index c6b29e9cc..e8e9a4a91 100644
--- a/apps/docs/registry.json
+++ b/apps/docs/registry.json
@@ -1820,7 +1820,6 @@
"@streamdown/[email protected]",
"@streamdown/[email protected]",
"@tailwindcss/[email protected]",
- "ai@^7.0.38",
diff --git a/apps/docs/scripts/validate-channel-registry.ts b/apps/docs/scripts/validate-channel-registry.ts
index 9f4a9b24a..2772cba94 100644
--- a/apps/docs/scripts/validate-channel-registry.ts
+++ b/apps/docs/scripts/validate-channel-registry.ts
@@ -130,6 +130,15 @@ for (const [index, item] of items.entries()) {
if (entry === undefined) throw new Error(`Unexpected channel registry item "${item.name}".`);
const registrySlug = expectedSlugs[index];
+ if (
+ entry.slug === "eve" &&
+ item.dependencies?.some((dependency) => dependency === "ai" || dependency.startsWith("ai@"))
+ ) {
+ throw new Error(
+ `Registry item "${item.name}" must preserve the agent's existing AI SDK dependency.`,
+ );
+ }
+
if (
entry.slug === "slack" ||
entry.slug === "discord" ||
diff --git a/packages/eve/src/cli/commands/init.integration.test.ts b/packages/eve/src/cli/commands/init.integration.test.ts
index 9588ff939..a54922f7a 100644
--- a/packages/eve/src/cli/commands/init.integration.test.ts
+++ b/packages/eve/src/cli/commands/init.integration.test.ts
@@ -161,7 +161,6 @@ describe("runInitCommand", () => {
);
const manifest = await readFile(join(projectPath, "package.json"), "utf8");
expect(manifest).toContain('"eve": "^0.6.0"');
- // pnpm accepts the optional prerelease peer without a manager-specific pin.
const packageJson: unknown = JSON.parse(manifest);
expect(packageJson).not.toHaveProperty("overrides");
expect(packageJson).not.toHaveProperty("resolutions");
@@ -402,12 +401,12 @@ describe("runInitCommand", () => {
});
it.each([
- ["npm", "overrides", ["exec", "--", "eve", "dev", "--input", "/model"]],
- ["yarn", "resolutions", ["eve", "dev", "--input", "/model"]],
- ["bun", "overrides", ["x", "eve", "dev", "--input", "/model"]],
+ ["npm", ["exec", "--", "eve", "dev", "--input", "/model"]],
+ ["yarn", ["eve", "dev", "--input", "/model"]],
+ ["bun", ["x", "eve", "dev", "--input", "/model"]],
] as const)(
- "scaffolds a fresh project owned by the invoking manager %s without pnpm policy",
- async (kind, aiPinField, devArguments) => {
+ "scaffolds a fresh project owned by the invoking manager %s without package-manager pins",
+ async (kind, devArguments) => {
const parentDirectory = await mkdtemp(join(tmpdir(), `eve-init-agent-${kind}-`));
const output = logger();
const deps = dependencies();
@@ -425,10 +424,8 @@ describe("runInitCommand", () => {
const packageJson: unknown = JSON.parse(
await readFile(join(projectPath, "package.json"), "utf8"),
);
- expect(packageJson).toHaveProperty(aiPinField);
- expect(packageJson).not.toHaveProperty(
- aiPinField === "overrides" ? "resolutions" : "overrides",
- );
+ expect(packageJson).not.toHaveProperty("overrides");
+ expect(packageJson).not.toHaveProperty("resolutions");
expect(deps.runPackageManagerInstall).toHaveBeenCalledWith(
kind,
projectPath,
@@ -649,11 +646,11 @@ describe("runInitCommand", () => {
});
it.each([
- ["yarn", "yarn.lock", "resolutions", ["eve", "dev", "--input", "/model"]],
- ["bun", "bun.lock", "overrides", ["x", "eve", "dev", "--input", "/model"]],
+ ["yarn", "yarn.lock", ["eve", "dev", "--input", "/model"]],
+ ["bun", "bun.lock", ["x", "eve", "dev", "--input", "/model"]],
] as const)(
"scaffolds a fresh %s workspace member without nested root-only package fields",
- async (kind, lockfile, rootAiPinField, devArguments) => {
+ async (kind, lockfile, devArguments) => {
const workspaceRoot = await mkdtemp(join(tmpdir(), `eve-init-${kind}-workspace-member-`));
const appsDirectory = join(workspaceRoot, "apps");
await mkdir(appsDirectory, { recursive: true });
@@ -692,11 +689,12 @@ describe("runInitCommand", () => {
await readFile(join(workspaceRoot, "package.json"), "utf8"),
) as {
engines?: { node?: string };
- overrides?: { ai?: string };
- resolutions?: { ai?: string };
+ overrides?: unknown;
+ resolutions?: unknown;
};
expect(rootPackageJson.engines?.node).toBe("24.x");
- expect(rootPackageJson[rootAiPinField]?.ai).toBe("7.0.0");
+ expect(rootPackageJson.overrides).toBeUndefined();
+ expect(rootPackageJson.resolutions).toBeUndefined();
expect(deps.runPackageManagerInstall).toHaveBeenCalledWith(
kind,
projectPath,
diff --git a/packages/eve/src/setup/scaffold/create/add-to-project.ts b/packages/eve/src/setup/scaffold/create/add-to-project.ts
index a7a8ef26a..531a2976d 100644
--- a/packages/eve/src/setup/scaffold/create/add-to-project.ts
+++ b/packages/eve/src/setup/scaffold/create/add-to-project.ts
@@ -165,7 +165,6 @@ export async function addAgentToProject(
packageManager,
options.projectRoot,
{
- aiPackageVersion: aiVersion,
nodeEngineRequirement: evePackage.nodeEngine,
},
);
diff --git a/packages/eve/src/setup/scaffold/create/project.ts b/packages/eve/src/setup/scaffold/create/project.ts
index 488f0f639..f9bdb4a1e 100644
--- a/packages/eve/src/setup/scaffold/create/project.ts
+++ b/packages/eve/src/setup/scaffold/create/project.ts
@@ -181,38 +181,8 @@ __EVE_INIT_REASONING__ modelOptions: {
});
`;
-// `@vercel/connect`'s optional `ai` peer (`^6 || ^7`) excludes prereleases, so
-// npm, Bun, and Yarn need a manager-specific pin for the runtime's prerelease
-// `ai` version. pnpm tolerates the unmet optional peer without either field.
-function packageManagerAiPinTemplateSuffix(packageManager: PackageManagerKind): string {
- switch (packageManager) {
- case "bun":
- case "npm":
- return `,
- "overrides": {
- "ai": "__EVE_INIT_AI_SDK_VERSION__"
- }`;
- case "yarn":
- return `,
- "resolutions": {
- "ai": "__EVE_INIT_AI_SDK_VERSION__"
- }`;
- case "pnpm":
- return "";
- default: {
- const exhaustive: never = packageManager;
- return exhaustive;
- }
- }
-}
-
-function packageJsonTemplate(input: {
- includeRootOnlyFields: boolean;
- packageManager: PackageManagerKind;
-}): string {
- const rootOnlyFields = input.includeRootOnlyFields
- ? `${packageManagerAiPinTemplateSuffix(input.packageManager)}${ROOT_ONLY_PACKAGE_JSON_TEMPLATE_SUFFIX}`
- : "";
+function packageJsonTemplate(includeRootOnlyFields: boolean): string {
+ const rootOnlyFields = includeRootOnlyFields ? ROOT_ONLY_PACKAGE_JSON_TEMPLATE_SUFFIX : "";
return `{
"name": "__EVE_INIT_APP_NAME__",
"version": "0.0.0",
@@ -354,15 +324,11 @@ Run the validation the task requests. When it does not establish the behavior yo
function templateFiles(input: {
byokProvider: boolean;
includeRootOnlyPackageJsonFields: boolean;
- packageManager: PackageManagerKind;
}): Record<string, string> {
return {
"agent/agent.ts": input.byokProvider ? BYOK_AGENT_TEMPLATE : BASE_AGENT_TEMPLATE,
...SHARED_TEMPLATE_FILES,
- "package.json": packageJsonTemplate({
- includeRootOnlyFields: input.includeRootOnlyPackageJsonFields,
- packageManager: input.packageManager,
- }),
+ "package.json": packageJsonTemplate(input.includeRootOnlyPackageJsonFields),
};
}
@@ -469,7 +435,6 @@ export async function scaffoldBaseProject(options: ScaffoldBaseProjectOptions):
templateFiles({
byokProvider,
includeRootOnlyPackageJsonFields: !workspaceMember,
- packageManager,
}),
)) {
const filePath = `${targetRoot}/${relPath}`;
@@ -490,7 +455,6 @@ export async function scaffoldBaseProject(options: ScaffoldBaseProjectOptions):
});
await patchWorkspaceRootPackageJson(packageManager, workspaceProbeRoot, {
- aiPackageVersion: ctx.aiPackageVersion,
nodeEngineRequirement: evePackage.nodeEngine,
onWorkspaceRootMutation: options.onWorkspaceRootMutation,
});
diff --git a/packages/eve/src/setup/scaffold/create/web-template.ts b/packages/eve/src/setup/scaffold/create/web-template.ts
index 8437cbb40..fa50c3b00 100644
--- a/packages/eve/src/setup/scaffold/create/web-template.ts
+++ b/packages/eve/src/setup/scaffold/create/web-template.ts
@@ -112,7 +112,6 @@ export const WEB_APP_TEMPLATE_PACKAGE_JSON = {
"@streamdown/math": "1.0.2",
"@streamdown/mermaid": "1.0.2",
"@tailwindcss/postcss": "4.3.0",
- ai: "^7.0.38",
"class-variance-authority": "0.7.1",
clsx: "2.1.1",
cmdk: "1.1.1",
diff --git a/packages/eve/src/setup/scaffold/index.integration.test.ts b/packages/eve/src/setup/scaffold/index.integration.test.ts
index 12cfd4e81..90336b0e8 100644
--- a/packages/eve/src/setup/scaffold/index.integration.test.ts
+++ b/packages/eve/src/setup/scaffold/index.integration.test.ts
@@ -714,6 +714,53 @@ describe("ensureChannel", () => {
packageJsonUpdated: [],
});
});
+
+ test("finishes package setup after the registry installs Web Chat", async () => {
+ const projectRoot = await createTempDir();
+ const pagePath = join(projectRoot, "app/page.tsx");
+ const packageJsonPath = join(projectRoot, "package.json");
+ await mkdir(join(projectRoot, "app"), { recursive: true });
+ await writeFile(pagePath, "registry-installed\n", "utf8");
+ await writeFile(
+ packageJsonPath,
+ `${JSON.stringify(
+ {
+ name: "demo",
+ type: "module",
+ scripts: { test: "vitest" },
+ dependencies: { next: "16.3.0-preview.6" },
+ },
+ null,
+ 2,
+ )}\n`,
+ "utf8",
+ );
+
+ const result = await ensureChannel({
+ projectRoot,
+ kind: "web",
+ configureVercelServices: false,
+ skipDependencyMutation: true,
+ webPackageVersions: TEST_WEB_PACKAGE_VERSIONS,
+ });
+
+ expect(result.action).toBe("overwritten");
+ await expect(readFile(pagePath, "utf8")).resolves.toBe("registry-installed\n");
+ const packageJson = JSON.parse(await readFile(packageJsonPath, "utf8")) as {
+ dependencies: Record<string, string>;
+ scripts: Record<string, string>;
+ };
+ expect(packageJson.dependencies).toEqual({ next: "16.3.0-preview.6" });
+ expect(packageJson).toMatchObject({
+ scripts: {
+ build: "next build",
+ "build:eve": "eve build",
+ dev: "next dev",
+ start: "next start",
+ test: "vitest",
+ },
+ });
+ });
});
describe("isNextJsProject", () => {
@@ -1016,14 +1063,9 @@ describe("scaffoldBaseProject", () => {
}
});
- test.each([
- ["pnpm", undefined],
- ["npm", "overrides"],
- ["yarn", "resolutions"],
- ["bun", "overrides"],
- ] as const)(
- "scaffolds a standalone %s project with its own package-manager metadata",
- async (packageManager, aiPinField) => {
+ test.each(["pnpm", "npm", "yarn", "bun"] as const)(
+ "scaffolds a standalone %s project without an AI package-manager pin",
+ async (packageManager) => {
const targetDirectory = await createTempDir();
const projectRoot = await scaffoldBaseProject({
projectName: "demo-agent",
@@ -1045,15 +1087,8 @@ describe("scaffoldBaseProject", () => {
const packageJson: unknown = JSON.parse(
await readFile(join(projectRoot, "package.json"), "utf8"),
);
- if (aiPinField === undefined) {
- expect(packageJson).not.toHaveProperty("overrides");
- expect(packageJson).not.toHaveProperty("resolutions");
- } else {
- expect(packageJson).toHaveProperty(`${aiPinField}.ai`, "7.0.0");
- expect(packageJson).not.toHaveProperty(
- aiPinField === "overrides" ? "resolutions" : "overrides",
- );
- }
+ expect(packageJson).not.toHaveProperty("overrides");
+ expect(packageJson).not.toHaveProperty("resolutions");
},
);
@@ -1141,13 +1176,9 @@ describe("scaffoldBaseProject", () => {
});
});
- test.each([
- ["npm", "overrides"],
- ["bun", "overrides"],
- ["yarn", "resolutions"],
- ] as const)(
+ test.each(["npm", "bun", "yarn"] as const)(
"scaffolds a %s workspace member with root-only package fields at the workspace root",
- async (packageManager, rootAiPinField) => {
+ async (packageManager) => {
const workspaceRoot = await createTempDir();
const targetDirectory = join(workspaceRoot, "apps");
await mkdir(targetDirectory, { recursive: true });
@@ -1191,21 +1222,18 @@ describe("scaffoldBaseProject", () => {
await readFile(join(workspaceRoot, "package.json"), "utf8"),
) as {
engines?: { node?: string };
- overrides?: { ai?: string };
- resolutions?: { ai?: string };
+ overrides?: unknown;
+ resolutions?: unknown;
};
expect(rootPackageJson.engines?.node).toBe("24.x");
- expect(rootPackageJson[rootAiPinField]?.ai).toBe("7.0.0");
+ expect(rootPackageJson.overrides).toBeUndefined();
+ expect(rootPackageJson.resolutions).toBeUndefined();
},
);
- test.each([
- ["npm", "overrides"],
- ["bun", "overrides"],
- ["yarn", "resolutions"],
- ] as const)(
+ test.each(["npm", "bun", "yarn"] as const)(
"scaffolds under an unclaimed %s workspace directory by adding a package pattern",
- async (packageManager, rootAiPinField) => {
+ async (packageManager) => {
const workspaceRoot = await createTempDir();
const targetDirectory = join(workspaceRoot, "agents");
await mkdir(targetDirectory, { recursive: true });
@@ -1249,13 +1277,14 @@ describe("scaffoldBaseProject", () => {
await readFile(join(workspaceRoot, "package.json"), "utf8"),
) as {
engines?: { node?: string };
- overrides?: { ai?: string };
- resolutions?: { ai?: string };
+ overrides?: unknown;
+ resolutions?: unknown;
workspaces?: string[];
};
expect(rootPackageJson.workspaces).toEqual(["apps/*", "agents/*"]);
expect(rootPackageJson.engines?.node).toBe("24.x");
- expect(rootPackageJson[rootAiPinField]?.ai).toBe("7.0.0");
+ expect(rootPackageJson.overrides).toBeUndefined();
+ expect(rootPackageJson.resolutions).toBeUndefined();
},
);
diff --git a/packages/eve/src/setup/scaffold/update/channels.ts b/packages/eve/src/setup/scaffold/update/channels.ts
index b819f1649..63e437494 100644
--- a/packages/eve/src/setup/scaffold/update/channels.ts
+++ b/packages/eve/src/setup/scaffold/update/channels.ts
@@ -312,7 +312,6 @@ async function patchWebPackageJson(
packageManager,
workspaceProbeRoot,
{
- aiPackageVersion: dependencies.ai,
nodeEngineRequirement: evePackage.nodeEngine,
onWorkspaceRootMutation,
},
@@ -460,7 +459,7 @@ export interface EnsureChannelOptions {
/** When false, Web Chat leaves Vercel Services config unwritten for preview-only scaffolds. */
configureVercelServices?: boolean;
onWorkspaceRootMutation?: (mutation: WorkspaceRootMutation) => void | Promise<void>;
- /** Dependencies are already owned and installed by a registry item. */
+ /** Web Chat files and dependencies are already installed by a registry item. */
skipDependencyMutation?: boolean;
}
@@ -479,7 +478,11 @@ async function ensureWebChannel(
const packageJsonPath = join(options.projectRoot, "package.json");
const webEntryPath = join(options.projectRoot, "app/page.tsx");
const webEntryAlreadyExists = await pathExists(webEntryPath);
- if (!options.force && (await isNextJsProject(options.projectRoot))) {
+ if (
+ !options.force &&
+ !options.skipDependencyMutation &&
+ (await isNextJsProject(options.projectRoot))
+ ) {
return {
kind: "web",
action: "skipped",
diff --git a/packages/eve/src/setup/scaffold/update/package-json.ts b/packages/eve/src/setup/scaffold/update/package-json.ts
index b0f3532f4..52d83bc02 100644
--- a/packages/eve/src/setup/scaffold/update/package-json.ts
+++ b/packages/eve/src/setup/scaffold/update/package-json.ts
@@ -5,8 +5,6 @@ import { reconcileNodeEngine, type NodeEngineOverride } from "../../node-engine.
export interface PackageJsonPatch {
dependencies?: Record<string, string>;
devDependencies?: Record<string, string>;
- overrides?: Record<string, string>;
- resolutions?: Record<string, string>;
scripts?: Record<string, string>;
/**
* eve's required Node.js range (e.g. `">=24"`). When the target's
@@ -25,8 +23,6 @@ export interface PackageJsonPatchResult {
interface PackageJsonShape {
dependencies?: Record<string, string>;
devDependencies?: Record<string, string>;
- overrides?: Record<string, string>;
- resolutions?: Record<string, string>;
scripts?: Record<string, string>;
engines?: unknown;
[key: string]: unknown;
@@ -56,16 +52,6 @@ export async function patchPackageJson(
};
changed = true;
}
- if (patch.overrides !== undefined) {
- const overrides = isJsonObject(parsed.overrides) ? parsed.overrides : {};
- parsed.overrides = { ...overrides, ...patch.overrides };
- changed = true;
- }
- if (patch.resolutions !== undefined) {
- const resolutions = isJsonObject(parsed.resolutions) ? parsed.resolutions : {};
- parsed.resolutions = { ...resolutions, ...patch.resolutions };
- changed = true;
- }
if (patch.scripts !== undefined) {
parsed.scripts = { ...parsed.scripts, ...patch.scripts };
changed = true;
diff --git a/packages/eve/src/setup/scaffold/workspace-root.ts b/packages/eve/src/setup/scaffold/workspace-root.ts
index cf9e51cd2..475f32f06 100644
--- a/packages/eve/src/setup/scaffold/workspace-root.ts
+++ b/packages/eve/src/setup/scaffold/workspace-root.ts
@@ -15,7 +15,7 @@ import {
workspacePatternsClaimProject,
} from "./workspace-glob.js";
import { patchPackageJson } from "./update/package-json.js";
-import type { PackageJsonPatch, PackageJsonPatchResult } from "./update/package-json.js";
+import type { PackageJsonPatchResult } from "./update/package-json.js";
interface PackageJsonWorkspaceShape {
workspaces?: unknown;
@@ -162,39 +162,11 @@ async function ensurePackageManagerWorkspaceIncludesProject(
}
}
-function packageManagerRootOnlyPackageJsonPatch(
- packageManager: PackageManagerKind,
- input: {
- readonly aiPackageVersion?: string;
- readonly nodeEngineRequirement?: string;
- },
-): PackageJsonPatch {
- const patch: PackageJsonPatch = {};
- if (input.nodeEngineRequirement !== undefined) {
- patch.nodeEngineRequirement = input.nodeEngineRequirement;
- }
- if (input.aiPackageVersion !== undefined) {
- switch (packageManager) {
- case "bun":
- case "npm":
- patch.overrides = { ai: input.aiPackageVersion };
- break;
- case "yarn":
- patch.resolutions = { ai: input.aiPackageVersion };
- break;
- case "pnpm":
- break;
- }
- }
- return patch;
-}
-
/** Applies root-only package.json fields to an ancestor workspace package.json. */
export async function patchWorkspaceRootPackageJson(
packageManager: PackageManagerKind,
projectRoot: string,
input: {
- readonly aiPackageVersion?: string;
readonly nodeEngineRequirement?: string;
readonly onWorkspaceRootMutation?: (mutation: WorkspaceRootMutation) => void | Promise<void>;
},
@@ -208,10 +180,9 @@ export async function patchWorkspaceRootPackageJson(
return { changed: false };
}
- const result = await patchPackageJson(
- path,
- packageManagerRootOnlyPackageJsonPatch(packageManager, input),
- );
+ const result = await patchPackageJson(path, {
+ nodeEngineRequirement: input.nodeEngineRequirement,
+ });
if (result.changed) {
await input.onWorkspaceRootMutation?.({
kind: "package-json",