@apifuse/provider-sdk 2.1.0-beta.9 → 2.2.0-beta.10

package/src/cli/create.ts

@@ -1,21 +1,18 @@
 import { spawn } from "node:child_process";
 import { existsSync, readFileSync } from "node:fs";
-import { mkdir, readFile, writeFile } from "node:fs/promises";
+import { mkdir, readFile, rm, symlink, writeFile } from "node:fs/promises";
 import { dirname, relative, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
 
-import {
-	cancel,
-	intro,
-	isCancel,
-	note,
-	outro,
-	select,
-	text,
-} from "@clack/prompts";
+import { cancel, intro, isCancel, note, outro, select, text } from "@clack/prompts";
 import { z } from "zod";
 
 import packageJson from "../../package.json";
+import {
+	buildPromptAssetManifest,
+	buildPromptAssetPlanEntries,
+	PROMPT_ASSET_MANIFEST_PATH,
+} from "./prompt-assets.js";
 
 export const PROVIDER_NAME_REGEX = /^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/;
 export const CATEGORY_OPTIONS = [
@@ -28,12 +25,7 @@ export const CATEGORY_OPTIONS = [
 	"communication",
 	"other",
 ] as const;
-export const AUTH_MODE_OPTIONS = [
-	"none",
-	"platform-managed",
-	"credentials",
-	"oauth2",
-] as const;
+export const AUTH_MODE_OPTIONS = ["none", "platform-managed", "credentials", "oauth2"] as const;
 export const RUNTIME_OPTIONS = ["standard", "browser"] as const;
 export const PRESET_OPTIONS = ["standalone", "monorepo"] as const;
 
@@ -77,7 +69,10 @@ export type CreateResolvedOptions = {
 
 export type ProviderPlanFile = {
 	path: string;
+	/** File content, or the symlink target (relative path) for kind "symlink". */
 	content: string;
+	/** Absent kind means "file" (backward compatible with older consumers). */
+	kind?: "file" | "symlink";
 };
 
 export type ProviderCreatePlan = {
@@ -95,9 +90,7 @@ export type ProviderCreatePlan = {
 	workspaceRoot?: string;
 };
 
-const TEMPLATE_DIR = fileURLToPath(
-	new URL("./templates/provider/", import.meta.url),
-);
+const TEMPLATE_DIR = fileURLToPath(new URL("./templates/provider/", import.meta.url));
 const HELP_TEXT = `Usage: apifuse create <provider-name> [options]
 Examples:
   apifuse create my-provider
@@ -126,9 +119,7 @@ export async function main() {
 	}
 
 	const parsed = parseArgs(normalizedArgs);
-	const config = parsed.configPath
-		? await loadConfig(parsed.configPath)
-		: undefined;
+	const config = parsed.configPath ? await loadConfig(parsed.configPath) : undefined;
 	const resolved = await resolveCreateOptions(parsed, config, process.cwd());
 	const plan = await buildProviderCreatePlan(resolved, process.cwd());
 
@@ -195,18 +186,10 @@ function parseArgs(argv: string[]): ParsedArgs {
 				parsed.displayName = ensureValue(flag, consumeValue());
 				break;
 			case "--category":
-				parsed.category = parseEnum(
-					"category",
-					consumeValue(),
-					CATEGORY_OPTIONS,
-				);
+				parsed.category = parseEnum("category", consumeValue(), CATEGORY_OPTIONS);
 				break;
 			case "--auth-mode":
-				parsed.authMode = parseEnum(
-					"auth mode",
-					consumeValue(),
-					AUTH_MODE_OPTIONS,
-				);
+				parsed.authMode = parseEnum("auth mode", consumeValue(), AUTH_MODE_OPTIONS);
 				break;
 			case "--runtime":
 				parsed.runtime = parseEnum("runtime", consumeValue(), RUNTIME_OPTIONS);
@@ -253,9 +236,7 @@ function parseEnum<T extends readonly string[]>(
 	const resolvedValue = ensureValue(`--${label}`, value);
 	const matchedValue = options.find((option) => option === resolvedValue);
 	if (!matchedValue) {
-		throw new Error(
-			`Invalid ${label}: ${resolvedValue}. Expected one of: ${options.join(", ")}`,
-		);
+		throw new Error(`Invalid ${label}: ${resolvedValue}. Expected one of: ${options.join(", ")}`);
 	}
 	return matchedValue;
 }
@@ -282,9 +263,7 @@ async function resolveCreateOptions(
 		authMode: parsed.authMode ?? config?.authMode,
 		runtime: parsed.runtime ?? config?.runtime,
 		sdkSpecifier:
-			parsed.sdkSpecifier ??
-			config?.sdkSpecifier ??
-			process.env.APIFUSE__SDK__SPECIFIER,
+			parsed.sdkSpecifier ?? config?.sdkSpecifier ?? process.env.APIFUSE__SDK__SPECIFIER,
 		dryRun: parsed.dryRun,
 		json: parsed.json,
 		yes: parsed.yes,
@@ -298,9 +277,7 @@ async function resolveCreateOptions(
 
 	if (partial.yes) {
 		if (!partial.name) {
-			throw new Error(
-				"--yes requires a provider name (positional or via config).",
-			);
+			throw new Error("--yes requires a provider name (positional or via config).");
 		}
 
 		return {
@@ -410,9 +387,7 @@ export async function buildProviderCreatePlan(
 	cwd: string,
 ): Promise<ProviderCreatePlan> {
 	const resolvedWorkspaceRoot =
-		options.preset === "monorepo"
-			? findApifuseInternalWorkspaceRoot(cwd)
-			: undefined;
+		options.preset === "monorepo" ? findApifuseInternalWorkspaceRoot(cwd) : undefined;
 	if (options.preset === "monorepo" && !resolvedWorkspaceRoot) {
 		throw new Error(
 			"Monorepo preset is internal to the APIFuse repository. External bounty workspaces are one-provider repositories; use the standalone default create flow.",
@@ -424,9 +399,7 @@ export async function buildProviderCreatePlan(
 	if (options.outputDir) {
 		providerRoot = resolve(cwd, options.outputDir);
 		installCwd =
-			options.preset === "monorepo" && resolvedWorkspaceRoot
-				? resolvedWorkspaceRoot
-				: providerRoot;
+			options.preset === "monorepo" && resolvedWorkspaceRoot ? resolvedWorkspaceRoot : providerRoot;
 	} else if (options.preset === "monorepo" && resolvedWorkspaceRoot) {
 		providerRoot = resolve(resolvedWorkspaceRoot, "providers", options.name);
 		installCwd = resolvedWorkspaceRoot;
@@ -439,20 +412,22 @@ export async function buildProviderCreatePlan(
 		throw new Error(`Target directory already exists: ${providerRoot}`);
 	}
 
-	if (
-		options.sdkSpecifier?.startsWith("workspace:") &&
-		!resolvedWorkspaceRoot
-	) {
+	if (options.sdkSpecifier?.startsWith("workspace:") && !resolvedWorkspaceRoot) {
 		throw new Error(
 			"workspace:* is only valid inside the APIFuse monorepo because public Provider SDK scaffolds must install from npm or an explicit tarball/file specifier.",
 		);
 	}
 
+	// Exact pin, not a caret range: the prompt-asset freshness gate requires
+	// manifest.sdkVersion === installed SDK version, and the manifest records
+	// this CLI's own version. A caret range would let `bun install` resolve a
+	// newer SDK than the create binary, making a fresh scaffold fail its own
+	// gate. `sync-assets` after an explicit SDK upgrade re-records the version.
 	const sdkSpecifier =
 		options.sdkSpecifier ??
 		(options.preset === "monorepo" && resolvedWorkspaceRoot
 			? "workspace:*"
-			: `^${packageJson.version}`);
+			: packageJson.version);
 	const relativeProviderRoot = relative(cwd, providerRoot) || options.name;
 	const nextDevCommand = `cd ${relativeProviderRoot} && bun run dev`;
 	const packageName =
@@ -578,6 +553,21 @@ export async function buildProviderCreatePlan(
 		},
 	];
 
+	const promptAssetEntries = await buildPromptAssetPlanEntries(renderTemplate);
+	for (const entry of promptAssetEntries) {
+		files.push({
+			path: resolve(providerRoot, entry.path),
+			content: entry.content,
+			...(entry.kind === "symlink" ? { kind: "symlink" as const } : {}),
+		});
+	}
+	// Manifest last: writePlan writes in order, so a crash mid-scaffold never
+	// leaves a manifest that claims assets which were not written.
+	files.push({
+		path: resolve(providerRoot, PROMPT_ASSET_MANIFEST_PATH),
+		content: buildPromptAssetManifest(promptAssetEntries, packageJson.version),
+	});
+
 	return {
 		displayName: options.displayName,
 		files,
@@ -592,17 +582,14 @@ export async function buildProviderCreatePlan(
 		validationCommands: [
 			"bun run check",
 			"bun run type-check",
-			"bun run submit-check",
+			"bun run submit-check -- --smoke",
 			"bun run test",
 		],
 		workspaceRoot: resolvedWorkspaceRoot,
 	};
 }
 
-async function renderTemplate(
-	fileName: string,
-	values: Record<string, string>,
-): Promise<string> {
+async function renderTemplate(fileName: string, values: Record<string, string>): Promise<string> {
 	const templatePath = resolve(TEMPLATE_DIR, fileName);
 	const template = await readFile(templatePath, "utf8");
 	return template.replace(/\{\{([A-Z_]+)\}\}/g, (_match, key: string) => {
@@ -610,10 +597,7 @@ async function renderTemplate(
 	});
 }
 
-function renderPackageJson(input: {
-	packageName: string;
-	sdkSpecifier: string;
-}): string {
+function renderPackageJson(input: { packageName: string; sdkSpecifier: string }): string {
 	return `${JSON.stringify(
 		{
 			name: input.packageName,
@@ -625,11 +609,10 @@ function renderPackageJson(input: {
 				dev: "apifuse dev .",
 				check: "apifuse check . && bun run type-check",
 				"type-check": "tsc --noEmit",
-				"submit-check":
-					"apifuse submit-check . --markdown submission-report.md",
+				"submit-check": "apifuse submit-check . --markdown submission-report.md",
+				"sync-assets": "apifuse sync-assets .",
 				test: "apifuse test .",
 				record: "apifuse record .",
-				"perf:sample": "apifuse perf . --operation ping --runs 3",
 				start: "bun start.ts",
 			},
 			dependencies: {
@@ -666,10 +649,7 @@ function renderTsconfig(): string {
 	)}\n`;
 }
 
-function renderStarterLocaleCatalog(
-	displayName: string,
-	locale: "en" | "ko",
-): string {
+function renderStarterLocaleCatalog(displayName: string, locale: "en" | "ko"): string {
 	const catalog = {
 		meta: {
 			displayName,
@@ -734,8 +714,8 @@ function renderAuthBlock(authMode: CreateAuthMode): string {
 			return `{
     mode: "credentials",
     flow: {
-      start: async () => ({
-        kind: "input",
+      start: async (_ctx) => ({
+        kind: "form",
         turnId: crypto.randomUUID(),
         expectedInput: {
           schema: {
@@ -778,7 +758,7 @@ function renderAuthBlock(authMode: CreateAuthMode): string {
 			return `{
     mode: "oauth2",
     flow: {
-      start: async () => ({
+      start: async (_ctx) => ({
         kind: "redirect",
         turnId: crypto.randomUUID(),
         data: {
@@ -871,9 +851,7 @@ function isApifuseInternalWorkspaceRoot(workspaceRoot: string): boolean {
 		return false;
 	}
 	try {
-		const packageJson = JSON.parse(
-			readFileSync(providerSdkPackageJsonPath, "utf8"),
-		);
+		const packageJson = JSON.parse(readFileSync(providerSdkPackageJsonPath, "utf8"));
 		return (
 			typeof packageJson === "object" &&
 			packageJson !== null &&
@@ -888,31 +866,28 @@ function isApifuseInternalWorkspaceRoot(workspaceRoot: string): boolean {
 async function writePlan(plan: ProviderCreatePlan): Promise<void> {
 	for (const file of plan.files) {
 		await mkdir(dirname(file.path), { recursive: true });
+		if (file.kind === "symlink") {
+			// rm operates on the link itself (lstat semantics) and tolerates
+			// directories, so whatever occupies the path is replaced by the link.
+			await rm(file.path, { recursive: true, force: true });
+			await symlink(file.content, file.path);
+			continue;
+		}
 		await writeFile(file.path, file.content);
 	}
 }
 
-async function installDependencies(
-	plan: ProviderCreatePlan,
-	jsonMode: boolean,
-): Promise<void> {
+async function installDependencies(plan: ProviderCreatePlan, jsonMode: boolean): Promise<void> {
 	await runCommand(plan.installCommand, plan.installCwd, jsonMode);
 }
 
-async function runBaselineValidation(
-	plan: ProviderCreatePlan,
-	jsonMode: boolean,
-): Promise<void> {
+async function runBaselineValidation(plan: ProviderCreatePlan, jsonMode: boolean): Promise<void> {
 	for (const command of plan.validationCommands) {
 		await runCommand(command, plan.providerRoot, jsonMode);
 	}
 }
 
-async function runCommand(
-	command: string,
-	cwd: string,
-	jsonMode: boolean,
-): Promise<void> {
+async function runCommand(command: string, cwd: string, jsonMode: boolean): Promise<void> {
 	const [binary, ...args] = command.split(" ");
 	if (!binary) {
 		throw new Error(`Cannot run empty command in ${cwd}`);
@@ -944,9 +919,7 @@ async function runCommand(
 			rejectPromise(
 				new Error(
 					`Command failed (${command}) in ${cwd}${
-						stdout || stderr
-							? `\n${[stdout, stderr].filter(Boolean).join("\n")}`
-							: ""
+						stdout || stderr ? `\n${[stdout, stderr].filter(Boolean).join("\n")}` : ""
 					}`,
 				),
 			);
@@ -954,11 +927,7 @@ async function runCommand(
 	});
 }
 
-function printResult(
-	plan: ProviderCreatePlan,
-	jsonMode: boolean,
-	dryRun: boolean,
-) {
+function printResult(plan: ProviderCreatePlan, jsonMode: boolean, dryRun: boolean) {
 	const payload = {
 		success: true,
 		dryRun,
@@ -975,9 +944,10 @@ function printResult(
 		},
 		validationCommands: plan.validationCommands,
 		nextDevCommand: plan.nextDevCommand,
-		files: plan.files.map(
-			(file) => relative(plan.providerRoot, file.path) || file.path,
-		),
+		files: plan.files.map((file) => {
+			const relativePath = relative(plan.providerRoot, file.path) || file.path;
+			return file.kind === "symlink" ? `${relativePath} -> ${file.content} (symlink)` : relativePath;
+		}),
 	};
 
 	if (jsonMode) {
@@ -993,7 +963,7 @@ function printResult(
 	}
 	console.log(`Next local dev: ${plan.nextDevCommand}`);
 	console.log(
-		"Submission evidence: run `bun run submit-check`, save the generated report, and note `/health` plus `POST /v1/{operation}` smoke results.",
+		"Submission evidence: run `bun run submit-check -- --smoke` to archive measured `/health` and `POST /v1/{operation}` results.",
 	);
 	if (plan.files.some((file) => file.content.includes('runtime: "browser"'))) {
 		console.log(