mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-30 21:01:54 +08:00
- Added a new script for seeding a local dashboard project linked to a GitHub repository, facilitating end-to-end testing of the config-agent flow. - Introduced new API routes for preparing and applying configuration updates via the GitHub repo agent, improving the workflow for managing config changes. - Updated the command hook in settings to provide clearer instructions on handling typecheck and lint failures. - Refactored the config update logic to ensure seamless integration with the new agent routes. Co-Authored-By: mantra <mantra@stack-auth.com>
119 lines
4.7 KiB
TypeScript
119 lines
4.7 KiB
TypeScript
import { isValidConfig, normalize } from "./config/format";
|
|
|
|
const DEFAULT_CONFIG_IMPORT_PACKAGE = "@hexclave/js";
|
|
|
|
/**
|
|
* Packages that export the `HexclaveConfig` type, in priority order.
|
|
* The first match found in a project's dependencies wins. Hexclave-branded
|
|
* packages come first (canonical); the legacy `@stackframe/*` names remain
|
|
* so projects pinned to the last legacy release still render a config file
|
|
* that compiles against their installed SDK.
|
|
*/
|
|
const CONFIG_IMPORT_PACKAGES = [
|
|
"@hexclave/next",
|
|
"@hexclave/react",
|
|
"@hexclave/tanstack-start",
|
|
"@hexclave/js",
|
|
"@hexclave/template",
|
|
"@stackframe/stack",
|
|
"@stackframe/react",
|
|
"@stackframe/js",
|
|
"@stackframe/template",
|
|
] as const;
|
|
|
|
/**
|
|
* Given a list of dependency names (from package.json), returns the SDK
|
|
* package that should be used for the `HexclaveConfig` import, or `undefined`
|
|
* if none of the known packages are installed.
|
|
*/
|
|
export function detectConfigImportPackage(dependencies: string[]): string | undefined {
|
|
for (const pkg of CONFIG_IMPORT_PACKAGES) {
|
|
if (dependencies.includes(pkg)) {
|
|
return pkg;
|
|
}
|
|
}
|
|
return undefined;
|
|
}
|
|
|
|
/**
|
|
* Renders a config object into the source text of a `stack.config.ts` file.
|
|
*/
|
|
export function renderConfigFileContent(config: unknown, importPackage?: string): string {
|
|
if (!isValidConfig(config)) {
|
|
throw new Error("Invalid config: expected a plain object.");
|
|
}
|
|
|
|
const droppedKeys: string[] = [];
|
|
const normalizedConfig = normalize(config, {
|
|
onDotIntoNonObject: "ignore",
|
|
onDotIntoNull: "empty-object",
|
|
droppedKeys,
|
|
});
|
|
if (droppedKeys.length > 0) {
|
|
throw new Error(`Config has conflicting keys that would be dropped during normalization: ${droppedKeys.map(k => JSON.stringify(k)).join(", ")}`);
|
|
}
|
|
const pkg = importPackage ?? DEFAULT_CONFIG_IMPORT_PACKAGE;
|
|
const importSpecifier = pkg.startsWith("@hexclave/") ? `${pkg}/config` : pkg;
|
|
const importLine = `import type { HexclaveConfig } from "${importSpecifier}";`;
|
|
return `${importLine}\n\nexport const config: HexclaveConfig = ${JSON.stringify(normalizedConfig, null, 2)};\n`;
|
|
}
|
|
|
|
// --- inline vitest tests ---
|
|
|
|
import.meta.vitest?.test("renderConfigFileContent normalizes config exports", ({ expect }) => {
|
|
expect(renderConfigFileContent({
|
|
"payments.items.todos.displayName": "Todo Slots",
|
|
"payments.items.todos.customerType": "user",
|
|
})).toContain(`export const config: HexclaveConfig = {
|
|
"payments": {
|
|
"items": {
|
|
"todos": {
|
|
"displayName": "Todo Slots",
|
|
"customerType": "user"
|
|
}
|
|
}
|
|
}
|
|
};`);
|
|
});
|
|
|
|
import.meta.vitest?.test("renderConfigFileContent rejects conflicting dotted keys", ({ expect }) => {
|
|
expect(() => renderConfigFileContent({
|
|
"a.b": 1,
|
|
"a.b.c": 2,
|
|
})).toThrowError(/conflicting keys.*"a\.b\.c"/);
|
|
});
|
|
|
|
import.meta.vitest?.test("renderConfigFileContent rejects invalid config exports", ({ expect }) => {
|
|
expect(() => renderConfigFileContent(null)).toThrowErrorMatchingInlineSnapshot(
|
|
`[Error: Invalid config: expected a plain object.]`,
|
|
);
|
|
});
|
|
|
|
import.meta.vitest?.test("renderConfigFileContent uses custom import package", ({ expect }) => {
|
|
const content = renderConfigFileContent({}, "@hexclave/next");
|
|
expect(content).toContain('import type { HexclaveConfig } from "@hexclave/next/config";');
|
|
});
|
|
|
|
import.meta.vitest?.test("renderConfigFileContent defaults to @hexclave/js", ({ expect }) => {
|
|
const content = renderConfigFileContent({});
|
|
expect(content).toContain('import type { HexclaveConfig } from "@hexclave/js/config";');
|
|
});
|
|
|
|
import.meta.vitest?.test("renderConfigFileContent keeps legacy @stackframe packages on their root entrypoint", ({ expect }) => {
|
|
const content = renderConfigFileContent({}, "@stackframe/next");
|
|
expect(content).toContain('import type { HexclaveConfig } from "@stackframe/next";');
|
|
});
|
|
|
|
import.meta.vitest?.test("detectConfigImportPackage picks first matching package by priority", ({ expect }) => {
|
|
expect(detectConfigImportPackage(["@hexclave/next", "@hexclave/js"])).toBe("@hexclave/next");
|
|
expect(detectConfigImportPackage(["@hexclave/react", "@hexclave/js"])).toBe("@hexclave/react");
|
|
expect(detectConfigImportPackage(["@hexclave/js"])).toBe("@hexclave/js");
|
|
expect(detectConfigImportPackage(["@hexclave/tanstack-start"])).toBe("@hexclave/tanstack-start");
|
|
expect(detectConfigImportPackage(["@stackframe/stack", "@hexclave/next"])).toBe("@hexclave/next");
|
|
expect(detectConfigImportPackage(["@stackframe/stack"])).toBe("@stackframe/stack");
|
|
expect(detectConfigImportPackage(["@stackframe/template"])).toBe("@stackframe/template");
|
|
expect(detectConfigImportPackage(["lodash", "express"])).toBeUndefined();
|
|
expect(detectConfigImportPackage([])).toBeUndefined();
|
|
});
|
|
|