@apifuse/provider-sdk 2.2.0-beta.40 → 2.2.0-beta.41

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @apifuse/provider-sdk Changelog
 
+## 2.2.0-beta.41
+
+- Release candidate for main commit e1bde60e6a9e0424074a357afd9e8af56549080d.
+
 ## 2.2.0-beta.40
 
 - Release candidate for main commit 7e2f05a954c23593a77e89e463a9bcbc2cdc7695.

package/bin/apifuse-check.ts

@@ -123,6 +123,7 @@ export async function runChecks(
 	const indexPath = resolve(providerRoot, "index.ts");
 	const dockerfilePath = resolve(providerRoot, "Dockerfile");
 	const packageJsonPath = resolve(providerRoot, "package.json");
+	const providerJsonPath = resolve(providerRoot, "provider.json");
 
 	let providerModule: Record<string, unknown> | undefined;
 	let providerImportError: unknown;
@@ -150,6 +151,7 @@ export async function runChecks(
 		checkProviderMetadata(provider),
 		checkDockerfile(dockerfilePath),
 		checkPackageJson(packageJsonPath),
+		checkProviderJson(providerJsonPath, packageJsonPath),
 		checkPromptAssets(providerRoot),
 	];
 }
@@ -478,6 +480,65 @@ function checkPackageJson(packageJsonPath: string): CheckResult {
 	}
 }
 
+export const PROVIDER_JSON_CHECK_MESSAGE = "provider.json exists with a valid declaration";
+
+const providerDeclarationSchema = z
+	.object({
+		schemaVersion: z.literal(1),
+		providerId: z.string(),
+		owner: z.string(),
+		lifecycle: z.enum(["draft", "ready", "live", "retired"]),
+	})
+	.strict();
+
+function checkProviderJson(providerJsonPath: string, packageJsonPath: string): CheckResult {
+	if (!existsSync(providerJsonPath)) {
+		return {
+			message: PROVIDER_JSON_CHECK_MESSAGE,
+			passed: false,
+			details: ["Missing provider.json at the provider root"],
+		};
+	}
+
+	try {
+		const declaration = providerDeclarationSchema.parse(
+			JSON.parse(readFileSync(providerJsonPath, "utf-8")) as unknown,
+		);
+		const expectedProviderId = readProviderIdFromPackageName(packageJsonPath);
+		if (expectedProviderId !== undefined && declaration.providerId !== expectedProviderId) {
+			return {
+				message: PROVIDER_JSON_CHECK_MESSAGE,
+				passed: false,
+				details: [
+					`provider.json providerId "${declaration.providerId}" does not match package.json name (expected "${expectedProviderId}")`,
+				],
+			};
+		}
+
+		return {
+			message: PROVIDER_JSON_CHECK_MESSAGE,
+			passed: true,
+			details: [`providerId: ${declaration.providerId}`, `lifecycle: ${declaration.lifecycle}`],
+		};
+	} catch (error) {
+		return {
+			message: PROVIDER_JSON_CHECK_MESSAGE,
+			passed: false,
+			details: [error instanceof Error ? error.message : String(error)],
+		};
+	}
+}
+
+function readProviderIdFromPackageName(packageJsonPath: string): string | undefined {
+	try {
+		const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8")) as unknown;
+		if (!isRecord(packageJson) || typeof packageJson.name !== "string") return undefined;
+		return /^(?:apifuse-provider-|@apifuse\/provider-)(.+)$/.exec(packageJson.name)?.[1];
+	} catch {
+		return undefined;
+	}
+}
+
 function assertProviderDefinition(value: unknown): ProviderDefinition | undefined {
 	return isProviderDefinition(value) ? value : undefined;
 }

package/bin/apifuse-migrate-shape.ts

@@ -0,0 +1,84 @@
+#!/usr/bin/env bun
+
+/**
+ * `apifuse migrate-shape [path] [--check] [--json]`
+ *
+ * Applies the provider authoring-shape migration (single-phase
+ * `defineProvider({...operations})` to the two-phase declaration builder) to
+ * a provider's `index.ts`. This is the source half of a breaking SDK bump:
+ * the pin bump and this transform must land in the same commit, because the
+ * single-phase shape default-exports a builder function under 2.2.0-beta.37+
+ * and the module stops loading.
+ *
+ * Exit codes: 0 migrated or already two-phase; 1 skipped (the transform
+ * refuses to guess) or the file is missing. `--check` reports without
+ * writing. A skip is a hard stop for fan-out callers — never pair a pin bump
+ * with a skipped migration.
+ */
+
+import { existsSync, readFileSync, writeFileSync } from "node:fs";
+import { resolve } from "node:path";
+
+import { migrateProviderShape } from "../src/cli/migrate-provider-shape.js";
+
+export async function main(): Promise<void> {
+	const args = process.argv.slice(3);
+	const check = args.includes("--check");
+	const json = args.includes("--json");
+	const positional = args.filter((argument) => !argument.startsWith("--"));
+	const providerRoot = resolve(positional[0] ?? ".");
+	const indexPath = resolve(providerRoot, "index.ts");
+
+	const report = (payload: Record<string, unknown>, humanText: string): void => {
+		if (json) {
+			console.log(JSON.stringify({ schemaVersion: 1, indexPath, ...payload }));
+		} else {
+			console.log(humanText);
+		}
+	};
+
+	if (!existsSync(indexPath)) {
+		report(
+			{ status: "skipped", reason: "index.ts not found" },
+			`migrate-shape: ${indexPath} not found.`,
+		);
+		process.exit(1);
+	}
+
+	const sourceText = readFileSync(indexPath, "utf8");
+	const result = migrateProviderShape(sourceText, indexPath);
+
+	if (result.status === "skipped") {
+		report(
+			{ status: "skipped", reason: result.reason },
+			`migrate-shape: skipped — ${result.reason}\nThis provider needs a manual migration; do not bump its SDK pin without one.`,
+		);
+		process.exit(1);
+	}
+
+	if (result.status === "unchanged") {
+		report(
+			{ status: "unchanged" },
+			"migrate-shape: already two-phase; nothing to do.",
+		);
+		return;
+	}
+
+	if (check) {
+		report(
+			{ status: "would-migrate", kind: result.kind },
+			`migrate-shape: would migrate (${result.kind}). Run without --check to write.`,
+		);
+		return;
+	}
+
+	writeFileSync(indexPath, result.code, "utf8");
+	report(
+		{ status: "migrated", kind: result.kind },
+		`migrate-shape: migrated (${result.kind}). Review the diff, then run \`apifuse check\` and \`bun test\`.`,
+	);
+}
+
+if (import.meta.main) {
+	await main();
+}