@apifuse/provider-sdk 2.1.0-beta.1 → 2.1.0-beta.10

package/src/cli/commands.ts

@@ -2,6 +2,8 @@ export type ApifuseCommandName =
 	| "create"
 	| "dev"
 	| "check"
+	| "submit-check"
+	| "bounty-check"
 	| "record"
 	| "test"
 	| "perf";
@@ -22,11 +24,9 @@ export const COMMAND_MANIFEST: Record<
 		name: "create",
 		summary:
 			"Scaffold a provider, install dependencies, run baseline validation, and print the next local-dev command.",
-		usage:
-			"apifuse create <provider-name> [--preset standalone|monorepo] [--json] [--dry-run]",
+		usage: "apifuse create <provider-name> [--json] [--dry-run]",
 		examples: [
 			"apifuse create weather-provider",
-			"apifuse create weather-provider --preset monorepo",
 			"apifuse create --config ./apifuse.create.json --json",
 		],
 		modulePath: "./apifuse-create",
@@ -36,24 +36,43 @@ export const COMMAND_MANIFEST: Record<
 		summary:
 			"Start the local provider dev server with the standard provider server contract.",
 		usage: "apifuse dev [path]",
-		examples: ["apifuse dev .", "apifuse dev providers/airkorea"],
+		examples: ["apifuse dev .", "apifuse dev providers/korea-air-quality"],
 		modulePath: "./apifuse-dev",
 	},
 	check: {
 		name: "check",
 		summary: "Validate provider structure, metadata, fixtures, and schemas.",
 		usage: "apifuse check [path]",
-		examples: ["apifuse check .", "apifuse check providers/airkorea"],
+		examples: ["apifuse check .", "apifuse check providers/korea-air-quality"],
 		modulePath: "./apifuse-check",
 	},
+	"submit-check": {
+		name: "submit-check",
+		summary:
+			"Score provider bounty submission readiness and emit checklist evidence.",
+		usage:
+			"apifuse submit-check [path] [--tier bronze|silver|gold|diamond] [--json] [--markdown <path>] [--smoke-note <text>]",
+		examples: [
+			"apifuse submit-check .",
+			"apifuse submit-check . --tier silver --markdown submission-report.md",
+		],
+		modulePath: "./apifuse-submit-check",
+	},
+	"bounty-check": {
+		name: "bounty-check",
+		summary: "Alias for submit-check.",
+		usage:
+			"apifuse bounty-check [path] [--tier bronze|silver|gold|diamond] [--json] [--markdown <path>] [--smoke-note <text>]",
+		examples: ["apifuse bounty-check . --markdown submission-report.md"],
+		modulePath: "./apifuse-submit-check",
+	},
 	record: {
 		name: "record",
 		summary: "Call a provider operation and capture upstream raw fixture data.",
 		usage:
 			'apifuse record [path] --operation <operation> --params \'{"value":"hello"}\'',
 		examples: [
-			'apifuse record . --operation ping --params \'{"value":"hello"}\'',
-			'apifuse record providers/airkorea --operation realtime --params \'{"stationName":"종로구"}\'',
+			'apifuse record providers/korea-air-quality --operation realtime --params \'{"stationName":"종로구"}\'',
 		],
 		modulePath: "./apifuse-record",
 	},
@@ -61,17 +80,20 @@ export const COMMAND_MANIFEST: Record<
 		name: "test",
 		summary: "Run provider-focused tests and surface actionable failures.",
 		usage: "apifuse test [path] [--json] [--verbose]",
-		examples: ["apifuse test .", "apifuse test providers/airkorea --json"],
+		examples: [
+			"apifuse test .",
+			"apifuse test providers/korea-air-quality --json",
+		],
 		modulePath: "./apifuse-test",
 	},
 	perf: {
 		name: "perf",
 		summary:
 			"Profile a provider operation and export latency/trace diagnostics.",
-		usage: "apifuse perf <path> --operation <operation> [options]",
+		usage:
+			"apifuse perf <path> --operation <operation> [--params '<json>'] [options]",
 		examples: [
-			"apifuse perf . --operation ping",
-			"apifuse perf providers/airkorea --operation realtime --runs 5",
+			'apifuse perf providers/korea-air-quality --operation realtime --params \'{"stationName":"종로구"}\' --runs 5',
 		],
 		modulePath: "./apifuse-perf",
 	},
@@ -81,6 +103,7 @@ export const COMMAND_ORDER: ApifuseCommandName[] = [
 	"create",
 	"dev",
 	"check",
+	"submit-check",
 	"record",
 	"test",
 	"perf",

package/src/cli/create.ts

@@ -1,5 +1,5 @@
 import { spawn } from "node:child_process";
-import { existsSync } from "node:fs";
+import { existsSync, readFileSync } from "node:fs";
 import { mkdir, readFile, writeFile } from "node:fs/promises";
 import { dirname, relative, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
@@ -101,11 +101,9 @@ const TEMPLATE_DIR = fileURLToPath(
 const HELP_TEXT = `Usage: apifuse create <provider-name> [options]
 Examples:
   apifuse create my-provider
-  apifuse create my-provider --preset monorepo
   apifuse create --config ./apifuse.create.json --json
 
 Options:
-  --preset <standalone|monorepo>
   --config <path>
   --output-dir <path>
   --display-name <name>
@@ -115,7 +113,7 @@ Options:
   --yes
   --dry-run
   --json
-  --sdk-specifier <specifier>   # internal/testing override for standalone dependency resolution
+  --sdk-specifier <specifier>   # internal/testing override for dependency resolution
   --help, -h`;
 
 export async function main() {
@@ -273,14 +271,11 @@ async function resolveCreateOptions(
 	config: CreateConfigFile | undefined,
 	cwd: string,
 ): Promise<CreateResolvedOptions> {
-	const detectedWorkspaceRoot = findWorkspaceRoot(cwd);
-	const detectedPreset: CreatePreset = detectedWorkspaceRoot
-		? "monorepo"
-		: "standalone";
+	const internalWorkspaceRoot = findApifuseInternalWorkspaceRoot(cwd);
 
 	const partial: Partial<CreateResolvedOptions> = {
 		name: parsed.name ?? config?.name,
-		preset: parsed.preset ?? config?.preset ?? detectedPreset,
+		preset: parsed.preset ?? config?.preset ?? "standalone",
 		outputDir: parsed.outputDir ?? config?.outputDir,
 		displayName: parsed.displayName ?? config?.displayName,
 		category: parsed.category ?? config?.category,
@@ -289,15 +284,15 @@ async function resolveCreateOptions(
 		sdkSpecifier:
 			parsed.sdkSpecifier ??
 			config?.sdkSpecifier ??
-			process.env.APIFUSE_SDK_SPECIFIER,
+			process.env.APIFUSE__SDK__SPECIFIER,
 		dryRun: parsed.dryRun,
 		json: parsed.json,
 		yes: parsed.yes,
 	};
 
-	if (partial.preset === "monorepo" && !detectedWorkspaceRoot) {
+	if (partial.preset === "monorepo" && !internalWorkspaceRoot) {
 		throw new Error(
-			"Monorepo preset requires a workspace root with a providers/ directory.",
+			"Monorepo preset is internal to the APIFuse repository. External bounty workspaces are one-provider repositories; use the standalone default create flow.",
 		);
 	}
 
@@ -314,7 +309,7 @@ async function resolveCreateOptions(
 			category: partial.category ?? "other",
 			authMode: partial.authMode ?? "none",
 			runtime: partial.runtime ?? "standard",
-			preset: partial.preset ?? detectedPreset,
+			preset: partial.preset ?? "standalone",
 			outputDir: partial.outputDir,
 			dryRun: partial.dryRun ?? false,
 			json: partial.json ?? false,
@@ -324,10 +319,10 @@ async function resolveCreateOptions(
 	}
 
 	if (!partial.json) {
-		intro("Create a new ApiFuse provider");
+		intro("Create a new APIFuse provider");
 		note(
-			`Preset precedence: explicit flags > config file > workspace detection > standalone default\nDetected workspace preset: ${detectedPreset}`,
-			"Preset resolution",
+			"External bounty workspaces are one-provider repositories. The public create flow defaults to standalone.",
+			"Provider workspace",
 		);
 	}
 
@@ -392,22 +387,7 @@ async function resolveCreateOptions(
 					initialValue: "standard",
 				}),
 			)),
-		preset:
-			partial.preset ??
-			(await promptValue(
-				select({
-					message: "Generation preset",
-					options: PRESET_OPTIONS.map((value) => ({
-						label: value,
-						value,
-						hint:
-							value === "standalone"
-								? "Create a clean-room npm-ready provider package."
-								: "Create the provider inside the current ApiFuse monorepo.",
-					})),
-					initialValue: detectedPreset,
-				}),
-			)),
+		preset: partial.preset ?? "standalone",
 		outputDir: partial.outputDir,
 		dryRun: partial.dryRun ?? false,
 		json: partial.json ?? false,
@@ -429,15 +409,15 @@ export async function buildProviderCreatePlan(
 	options: CreateResolvedOptions,
 	cwd: string,
 ): Promise<ProviderCreatePlan> {
-	const workspaceRoot =
-		options.preset === "monorepo" ? findWorkspaceRoot(cwd) : undefined;
-	if (options.preset === "monorepo" && !workspaceRoot) {
+	const resolvedWorkspaceRoot =
+		options.preset === "monorepo"
+			? findApifuseInternalWorkspaceRoot(cwd)
+			: undefined;
+	if (options.preset === "monorepo" && !resolvedWorkspaceRoot) {
 		throw new Error(
-			"Monorepo preset requires a workspace root with a providers/ directory.",
+			"Monorepo preset is internal to the APIFuse repository. External bounty workspaces are one-provider repositories; use the standalone default create flow.",
 		);
 	}
-	const resolvedWorkspaceRoot =
-		options.preset === "monorepo" ? workspaceRoot : undefined;
 	let providerRoot: string;
 	let installCwd: string;
 
@@ -459,33 +439,104 @@ export async function buildProviderCreatePlan(
 		throw new Error(`Target directory already exists: ${providerRoot}`);
 	}
 
+	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.",
+		);
+	}
+
 	const sdkSpecifier =
 		options.sdkSpecifier ??
-		(options.preset === "monorepo" ? "workspace:*" : `^${packageJson.version}`);
+		(options.preset === "monorepo" && resolvedWorkspaceRoot
+			? "workspace:*"
+			: `^${packageJson.version}`);
 	const relativeProviderRoot = relative(cwd, providerRoot) || options.name;
 	const nextDevCommand = `cd ${relativeProviderRoot} && bun run dev`;
 	const packageName =
 		options.preset === "monorepo"
 			? `@apifuse/provider-${options.name}`
 			: `apifuse-provider-${options.name}`;
+	const templateValues = {
+		PROVIDER_ID: options.name,
+		DISPLAY_NAME: escapeTemplate(options.displayName),
+		CATEGORY: options.category,
+		RUNTIME: options.runtime,
+		BROWSER_BLOCK:
+			options.runtime === "browser"
+				? ',\n  browser: {\n    engine: "playwright-stealth",\n  }'
+				: "",
+		SECRETS_BLOCK: renderSecretsBlock(options.authMode),
+		CREDENTIAL_BLOCK: renderCredentialBlock(options.authMode),
+		AUTH_BLOCK: renderAuthBlock(options.authMode),
+	};
 
 	const files: ProviderPlanFile[] = [
+		{
+			path: resolve(providerRoot, ".dockerignore"),
+			content: await renderTemplate(".dockerignore.tpl", {}),
+		},
+		{
+			path: resolve(providerRoot, ".gitignore"),
+			content: await renderTemplate(".gitignore.tpl", {}),
+		},
 		{
 			path: resolve(providerRoot, "index.ts"),
-			content: await renderTemplate("index.ts.tpl", {
+			content: await renderTemplate("index.ts.tpl", templateValues),
+		},
+		{
+			path: resolve(providerRoot, "meta.ts"),
+			content: await renderTemplate("meta.ts.tpl", {
 				PROVIDER_ID: options.name,
 				DISPLAY_NAME: escapeTemplate(options.displayName),
 				CATEGORY: options.category,
-				RUNTIME: options.runtime,
-				BROWSER_BLOCK:
+			}),
+		},
+		{
+			path: resolve(providerRoot, "operations", "index.ts"),
+			content: await renderTemplate("operations/index.ts.tpl", {}),
+		},
+		{
+			path: resolve(providerRoot, "operations", "ping.ts"),
+			content: await renderTemplate("operations/ping.ts.tpl", {
+				DISPLAY_NAME: escapeTemplate(options.displayName),
+				HANDLER_CTX: options.runtime === "browser" ? "ctx" : "_ctx",
+				BROWSER_HANDLER_BLOCK:
 					options.runtime === "browser"
-						? ',\n  browser: {\n    engine: "nodriver",\n  }'
+						? '\n    const page = await ctx.browser.newPage();\n    await page.goto("https://example.com");\n    const title = await page.title();\n    const frames = await page.frames();\n    await page.close();\n'
+						: "",
+				BROWSER_RESPONSE_FIELDS:
+					options.runtime === "browser"
+						? ",\n      pageTitle: title,\n      frameCount: frames.length"
 						: "",
-				SECRETS_BLOCK: renderSecretsBlock(options.authMode),
-				CREDENTIAL_BLOCK: renderCredentialBlock(options.authMode),
-				AUTH_BLOCK: renderAuthBlock(options.authMode),
 			}),
 		},
+		{
+			path: resolve(providerRoot, "schemas", "ping.ts"),
+			content: await renderTemplate("schemas/ping.ts.tpl", {}),
+		},
+		{
+			path: resolve(providerRoot, "upstream", "README.md"),
+			content: await renderTemplate("upstream/README.md.tpl", {}),
+		},
+		{
+			path: resolve(providerRoot, "mappers", "README.md"),
+			content: await renderTemplate("mappers/README.md.tpl", {}),
+		},
+		{
+			path: resolve(providerRoot, "domain", "README.md"),
+			content: await renderTemplate("domain/README.md.tpl", {}),
+		},
+		{
+			path: resolve(providerRoot, "locales", "en.json"),
+			content: renderStarterLocaleCatalog(options.displayName, "en"),
+		},
+		{
+			path: resolve(providerRoot, "locales", "ko.json"),
+			content: renderStarterLocaleCatalog(options.displayName, "ko"),
+		},
 		{
 			path: resolve(providerRoot, "package.json"),
 			content: renderPackageJson({
@@ -538,7 +589,12 @@ export async function buildProviderCreatePlan(
 		packageName,
 		preset: options.preset,
 		providerRoot,
-		validationCommands: ["bun run check", "bun run test"],
+		validationCommands: [
+			"bun run check",
+			"bun run type-check",
+			"bun run submit-check",
+			"bun run test",
+		],
 		workspaceRoot: resolvedWorkspaceRoot,
 	};
 }
@@ -567,10 +623,12 @@ function renderPackageJson(input: {
 			main: "./index.ts",
 			scripts: {
 				dev: "apifuse dev .",
-				check: "apifuse check .",
-				"record:sample":
-					'apifuse record . --operation ping --params \'{"value":"hello"}\'',
+				check: "apifuse check . && bun run type-check",
+				"type-check": "tsc --noEmit",
+				"submit-check":
+					"apifuse submit-check . --markdown submission-report.md",
 				test: "apifuse test .",
+				record: "apifuse record .",
 				"perf:sample": "apifuse perf . --operation ping --runs 3",
 				start: "bun start.ts",
 			},
@@ -579,6 +637,7 @@ function renderPackageJson(input: {
 			},
 			devDependencies: {
 				"@types/bun": "latest",
+				typescript: "^6.0.3",
 			},
 		},
 		null,
@@ -597,6 +656,7 @@ function renderTsconfig(): string {
 				noEmit: true,
 				skipLibCheck: true,
 				resolveJsonModule: true,
+				types: ["bun"],
 			},
 			include: ["**/*.ts"],
 			exclude: ["node_modules"],
@@ -606,6 +666,64 @@ function renderTsconfig(): string {
 	)}\n`;
 }
 
+function renderStarterLocaleCatalog(
+	displayName: string,
+	locale: "en" | "ko",
+): string {
+	const catalog = {
+		meta: {
+			displayName,
+			description:
+				locale === "ko"
+					? `${displayName} APIFuse 커뮤니티 기여용 provider starter입니다.`
+					: `${displayName} provider starter for APIFuse community contributions.`,
+		},
+		operations: {
+			ping: {
+				description:
+					locale === "ko"
+						? "생성된 provider wiring이 APIFuse runtime contract를 통해 작은 샘플 payload를 정상적으로 round-trip하는지 확인합니다. 로컬 개발, baseline check, 첫 bounty scaffold 검증에 사용합니다. production data retrieval이나 upstream-specific workflow에는 사용하지 마세요. 이 starter operation은 생성된 프로젝트가 compile, serve, input/output round-trip을 수행하는지 증명하기 위한 용도입니다."
+						: "Confirms the generated provider wiring is operational by echoing a small sample payload through the APIFuse runtime contract. Use when validating local development, baseline checks, or first-pass bounty scaffolds. Do NOT use for production data retrieval or upstream-specific workflows because this starter operation exists only to prove the generated project compiles, serves, and round-trips input/output correctly.",
+			},
+		},
+		schemaDescriptions: {
+			input: {
+				root:
+					locale === "ko"
+						? "생성된 ping operation의 입력 payload"
+						: "Input payload for the generated ping operation.",
+				value:
+					locale === "ko"
+						? "생성된 provider scaffold wiring 검증에 사용하는 샘플 입력값"
+						: "Sample input value used to verify the generated provider scaffold is wired correctly.",
+			},
+			output: {
+				root:
+					locale === "ko"
+						? "생성된 ping operation이 반환하는 출력 payload"
+						: "Output payload returned by the generated ping operation.",
+				ok:
+					locale === "ko"
+						? "생성된 provider가 샘플 요청을 성공적으로 처리했는지 여부"
+						: "Whether the generated provider handled the sample request successfully.",
+				message:
+					locale === "ko"
+						? "생성된 provider가 샘플 payload를 round-trip했음을 보여주는 사람이 읽을 수 있는 확인 메시지"
+						: "Human-readable confirmation that the generated provider round-tripped the sample payload.",
+				pageTitle:
+					locale === "ko"
+						? "browser 런타임 provider일 때 로드된 페이지의 제목 (해당되지 않으면 생략)"
+						: "Title of the loaded page when the provider uses the browser runtime; omitted otherwise.",
+				frameCount:
+					locale === "ko"
+						? "browser 런타임 provider일 때 로드된 페이지의 frame 개수 (해당되지 않으면 생략)"
+						: "Number of frames in the loaded page when the provider uses the browser runtime; omitted otherwise.",
+			},
+		},
+	};
+	return `${JSON.stringify(catalog, null, 2)}\n`;
+}
+
 function renderAuthBlock(authMode: CreateAuthMode): string {
 	switch (authMode) {
 		case "none":
@@ -643,6 +761,17 @@ function renderAuthBlock(authMode: CreateAuthMode): string {
         },
         hint: "Generated placeholder credential flow completed. Replace this with real auth logic.",
       }),
+      refresh: async () => ({
+        kind: "complete",
+        turnId: crypto.randomUUID(),
+        data: {
+          credential: {
+            username: "replace-with-refreshed-username",
+            password: "replace-with-refreshed-password",
+          },
+        },
+        hint: "Return refreshed credential data here, or throw AuthError with code AUTH_REQUIRED when silent refresh is not possible.",
+      }),
     },
   }`;
 		case "oauth2":
@@ -714,11 +843,11 @@ export function toDisplayName(name: string): string {
 		.join(" ");
 }
 
-function findWorkspaceRoot(cwd: string): string | undefined {
+function findApifuseInternalWorkspaceRoot(cwd: string): string | undefined {
 	let currentDirectory = cwd;
 
 	while (true) {
-		if (existsSync(resolve(currentDirectory, "providers"))) {
+		if (isApifuseInternalWorkspaceRoot(currentDirectory)) {
 			return currentDirectory;
 		}
 
@@ -731,6 +860,31 @@ function findWorkspaceRoot(cwd: string): string | undefined {
 	}
 }
 
+function isApifuseInternalWorkspaceRoot(workspaceRoot: string): boolean {
+	const providerSdkPackageJsonPath = resolve(
+		workspaceRoot,
+		"packages",
+		"provider-sdk",
+		"package.json",
+	);
+	if (!existsSync(providerSdkPackageJsonPath)) {
+		return false;
+	}
+	try {
+		const packageJson = JSON.parse(
+			readFileSync(providerSdkPackageJsonPath, "utf8"),
+		);
+		return (
+			typeof packageJson === "object" &&
+			packageJson !== null &&
+			"name" in packageJson &&
+			packageJson.name === "@apifuse/provider-sdk"
+		);
+	} catch {
+		return false;
+	}
+}
+
 async function writePlan(plan: ProviderCreatePlan): Promise<void> {
 	for (const file of plan.files) {
 		await mkdir(dirname(file.path), { recursive: true });
@@ -838,6 +992,14 @@ function printResult(
 		console.log(`Validation: (cd ${plan.providerRoot} && ${command})`);
 	}
 	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.",
+	);
+	if (plan.files.some((file) => file.content.includes('runtime: "browser"'))) {
+		console.log(
+			"Browser runtime: run `bunx playwright install chromium` locally or set `APIFUSE__CDP_POOL__URL` before browser-backed smoke tests.",
+		);
+	}
 }
 
 function escapeTemplate(value: string): string {

package/src/cli/templates/provider/.dockerignore.tpl

@@ -0,0 +1,22 @@
+node_modules/
+.git/
+.github/
+
+# Environment and local secrets
+.env
+.env.*
+!.env.example
+
+# Local reports and generated artifacts
+submission-report.md
+coverage/
+dist/
+.cache/
+.turbo/
+.bun/
+*.tsbuildinfo
+
+# OS/editor junk
+.DS_Store
+Thumbs.db
+*.swp

package/src/cli/templates/provider/.gitignore.tpl

@@ -0,0 +1,22 @@
+node_modules/
+
+# Environment and local secrets
+.env
+.env.*
+!.env.example
+
+# Build, coverage, cache, and local runtime artifacts
+coverage/
+dist/
+.cache/
+.turbo/
+.bun/
+*.tsbuildinfo
+
+# Bounty submission output
+submission-report.md
+
+# OS/editor junk
+.DS_Store
+Thumbs.db
+*.swp