@apifuse/provider-sdk 2.0.0-beta.1 → 2.1.0-beta.0

package/src/cli/commands.ts

@@ -0,0 +1,87 @@
+export type ApifuseCommandName =
+	| "create"
+	| "dev"
+	| "check"
+	| "record"
+	| "test"
+	| "perf";
+
+export type ApifuseCommandManifest = {
+	name: ApifuseCommandName;
+	summary: string;
+	usage: string;
+	examples: string[];
+	modulePath: string;
+};
+
+export const COMMAND_MANIFEST: Record<
+	ApifuseCommandName,
+	ApifuseCommandManifest
+> = {
+	create: {
+		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]",
+		examples: [
+			"apifuse create weather-provider",
+			"apifuse create weather-provider --preset monorepo",
+			"apifuse create --config ./apifuse.create.json --json",
+		],
+		modulePath: "./apifuse-create",
+	},
+	dev: {
+		name: "dev",
+		summary:
+			"Start the local provider dev server with the standard provider server contract.",
+		usage: "apifuse dev [path]",
+		examples: ["apifuse dev .", "apifuse dev providers/airkorea"],
+		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"],
+		modulePath: "./apifuse-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":"종로구"}\'',
+		],
+		modulePath: "./apifuse-record",
+	},
+	test: {
+		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"],
+		modulePath: "./apifuse-test",
+	},
+	perf: {
+		name: "perf",
+		summary:
+			"Profile a provider operation and export latency/trace diagnostics.",
+		usage: "apifuse perf <path> --operation <operation> [options]",
+		examples: [
+			"apifuse perf . --operation ping",
+			"apifuse perf providers/airkorea --operation realtime --runs 5",
+		],
+		modulePath: "./apifuse-perf",
+	},
+};
+
+export const COMMAND_ORDER: ApifuseCommandName[] = [
+	"create",
+	"dev",
+	"check",
+	"record",
+	"test",
+	"perf",
+];