@apifuse/provider-sdk 2.2.0-beta.52 → 2.2.0-beta.53

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @apifuse/provider-sdk Changelog
 
+## 2.2.0-beta.53
+
+- Release candidate for main commit 40a916bac16bb2b2bbda7fc4a96132d10ca103bf.
+
 ## 2.2.0-beta.52
 
 - Release candidate for main commit 6e64ae0ad2e735b3de0c115f5ea29517efcf4ff2.

package/dist/cli/migrate-operation-declaration.d.ts

@@ -1,4 +1,4 @@
-export type OperationDeclarationRefusalReason = "no_safety" | "safety_conflict" | "locale_key_conflict" | "connection_mode_conflict" | "execution_conflict" | "approval_conflict" | "non_literal" | "unsupported_member" | "factory_composed_operations" | "source_syntax" | "codemod_syntax" | "missing_english_locale" | "operation_id_unresolved" | "examples_conflict" | "locale_todo_conflict";
+export type OperationDeclarationRefusalReason = "no_safety" | "safety_conflict" | "locale_key_conflict" | "connection_mode_conflict" | "execution_conflict" | "approval_conflict" | "non_literal" | "unsupported_member" | "factory_composed_operations" | "source_syntax" | "codemod_syntax" | "missing_english_locale" | "operation_id_unresolved" | "examples_conflict" | "invalid_locale_key" | "locale_todo_conflict";
 export type OperationDeclarationRefusal = {
     readonly file: string;
     readonly operationKey: string;

package/dist/cli/migrate-operation-declaration.js

@@ -1,5 +1,7 @@
 import { existsSync, readdirSync, readFileSync, writeFileSync } from "node:fs";
 import { dirname, extname, join, relative, resolve } from "node:path";
+import { assertProviderLocaleKey } from "../i18n/keys.js";
+import { operationIdToLocaleNamespace } from "../i18n/operation-locale-namespace.js";
 const ts = await loadTypeScript();
 async function loadTypeScript() {
     try {
@@ -81,6 +83,10 @@ export function migrateOperationDeclaration(sourceText, fileName, options = {})
     }
     if (refusals.length > 0)
         return { status: "refused", refusals };
+    const invalidLocaleKey = findInvalidLocaleTodo(todos, fileName);
+    if (invalidLocaleKey !== undefined) {
+        return { status: "refused", refusals: [invalidLocaleKey] };
+    }
     if (edits.length === 0) {
         return {
             status: "unchanged",
@@ -221,7 +227,20 @@ function planOperationMigration(source, fileName, site, constObjects, constArray
         if (merged.insert !== undefined)
             addInsertion(insertions, "docs", merged.insert);
     }
-    const examples = planExamples(top.byName.get("inputExamples"), top.byName.get("examples"), fileName, site, source, constArrays, localeFiles);
+    const title = planTitleLocale(top.byName.get("title"), top.byName.get("titleKey"), docs.get("titleKey"), fileName, site, localeFiles);
+    if ("refusal" in title)
+        return title;
+    const localeNamespace = top.byName.get("inputExamples") === undefined
+        ? { namespace: site.operationKey }
+        : resolveOperationLocaleNamespace([
+            top.byName.get("titleKey"),
+            docs.get("titleKey"),
+            top.byName.get("descriptionKey"),
+            docs.get("descriptionKey"),
+        ], fileName, site);
+    if ("refusal" in localeNamespace)
+        return localeNamespace;
+    const examples = planExamples(top.byName.get("inputExamples"), top.byName.get("examples"), fileName, site, source, constArrays, localeFiles, localeNamespace.namespace);
     if ("refusal" in examples)
         return examples;
     const edits = [...examples.edits];
@@ -245,7 +264,66 @@ function planOperationMigration(source, fileName, site, constObjects, constArray
         if (!edits.some((existing) => rangesOverlap(existing, edit)))
             edits.push(edit);
     }
-    return { edits, localeTodos: examples.localeTodos };
+    return { edits, localeTodos: [...title.localeTodos, ...examples.localeTodos] };
+}
+function planTitleLocale(title, flatTitleKey, nestedTitleKey, fileName, site, localeFiles) {
+    if (title === undefined)
+        return { localeTodos: [] };
+    const originalProse = literalString(title.initializer);
+    if (originalProse === undefined) {
+        return nonLiteral(fileName, site.operationKey, "title must be a string literal so its authored prose can be preserved in the English locale catalog.");
+    }
+    if (!site.operationIdProven) {
+        return {
+            refusal: refusal(fileName, site.operationKey, "operation_id_unresolved", "title requires an exact operation id proven from a static operations map."),
+        };
+    }
+    if (!localeFiles.includes("locales/en.json")) {
+        return {
+            refusal: refusal(fileName, site.operationKey, "missing_english_locale", "title cannot be migrated because locales/en.json does not exist."),
+        };
+    }
+    let selectedTitleKey = flatTitleKey ?? nestedTitleKey;
+    if (flatTitleKey !== undefined && nestedTitleKey !== undefined) {
+        const same = equivalentLiteral(flatTitleKey.initializer, nestedTitleKey.initializer);
+        if (same === undefined) {
+            return nonLiteral(fileName, site.operationKey, "titleKey must be literal when both top-level and nested declarations exist.");
+        }
+        if (!same) {
+            return {
+                refusal: refusal(fileName, site.operationKey, "locale_key_conflict", "Top-level titleKey conflicts with nested titleKey."),
+            };
+        }
+        selectedTitleKey = flatTitleKey;
+    }
+    const explicitTitleKey = selectedTitleKey === undefined ? undefined : literalString(selectedTitleKey.initializer);
+    if (selectedTitleKey !== undefined && explicitTitleKey === undefined) {
+        return nonLiteral(fileName, site.operationKey, "titleKey must be a string literal so the title locale destination is provable.");
+    }
+    let selectedTitleLocaleKey;
+    if (explicitTitleKey !== undefined) {
+        selectedTitleLocaleKey = explicitTitleKey;
+    }
+    else {
+        try {
+            selectedTitleLocaleKey = `operations.${operationIdToLocaleNamespace(site.operationKey)}.title`;
+        }
+        catch (error) {
+            return {
+                refusal: invalidLocaleKeyRefusal(fileName, site.operationKey, `operations.${site.operationKey}.title`, error),
+            };
+        }
+    }
+    return {
+        localeTodos: [
+            {
+                localeFile: "locales/en.json",
+                operationKey: site.operationKey,
+                key: selectedTitleLocaleKey,
+                originalProse,
+            },
+        ],
+    };
 }
 function resolveRiskClass(top, annotations, toolRouter, fileName, operationKey) {
     const topRisk = top.get("riskClass");
@@ -381,7 +459,7 @@ function mergeFlatAndNested(field, flat, nested, fileName, operationKey, source,
     }
     return {};
 }
-function planExamples(inputExamples, existingExamples, fileName, site, source, constArrays, localeFiles) {
+function planExamples(inputExamples, existingExamples, fileName, site, source, constArrays, localeFiles, localeNamespace) {
     if (inputExamples === undefined)
         return { edits: [], localeTodos: [] };
     if (existingExamples !== undefined) {
@@ -440,7 +518,7 @@ function planExamples(inputExamples, existingExamples, fileName, site, source, c
         if (scenarioProse === undefined) {
             return nonLiteral(fileName, site.operationKey, `inputExamples[${index}].scenario must be a string literal.`);
         }
-        const scenarioKey = `operations.${site.operationKey}.examples.${index}.scenario`;
+        const scenarioKey = `operations.${localeNamespace}.examples.${index}.scenario`;
         edits.push(replaceExampleLocaleMember(scenario, "scenarioKey", scenarioKey, source));
         for (const localeFile of localeFiles) {
             todos.push({
@@ -456,7 +534,7 @@ function planExamples(inputExamples, existingExamples, fileName, site, source, c
             if (rationaleProse === undefined) {
                 return nonLiteral(fileName, site.operationKey, `inputExamples[${index}].rationale must be a string literal.`);
             }
-            const rationaleKey = `operations.${site.operationKey}.examples.${index}.rationale`;
+            const rationaleKey = `operations.${localeNamespace}.examples.${index}.rationale`;
             edits.push(replaceExampleLocaleMember(rationale, "rationaleKey", rationaleKey, source));
             for (const localeFile of localeFiles) {
                 todos.push({
@@ -470,6 +548,34 @@ function planExamples(inputExamples, existingExamples, fileName, site, source, c
     }
     return { edits, localeTodos: todos };
 }
+function resolveOperationLocaleNamespace(members, fileName, site) {
+    const authoredNamespaces = new Set();
+    for (const member of members) {
+        const localeKey = literalString(member?.initializer);
+        if (localeKey === undefined)
+            continue;
+        const segments = localeKey.split(".");
+        if (segments[0] === "operations" && segments[1] !== undefined) {
+            authoredNamespaces.add(segments[1]);
+        }
+    }
+    if (authoredNamespaces.size > 1) {
+        return {
+            refusal: refusal(fileName, site.operationKey, "locale_key_conflict", `Operation titleKey and descriptionKey declarations use different locale namespaces: ${[...authoredNamespaces].join(", ")}.`),
+        };
+    }
+    const authored = authoredNamespaces.values().next().value;
+    if (authored !== undefined)
+        return { namespace: authored };
+    try {
+        return { namespace: operationIdToLocaleNamespace(site.operationKey) };
+    }
+    catch (error) {
+        return {
+            refusal: invalidLocaleKeyRefusal(fileName, site.operationKey, `operations.${site.operationKey}.examples`, error),
+        };
+    }
+}
 function replaceExampleLocaleMember(member, newName, localeKey, source) {
     return {
         start: member.property.getStart(source),
@@ -1049,6 +1155,21 @@ function firstSyntaxError(source) {
 function refusal(file, operationKey, reason, detail) {
     return { file, operationKey, reason, detail };
 }
+function findInvalidLocaleTodo(todos, fileName) {
+    for (const todo of todos) {
+        try {
+            assertProviderLocaleKey(todo.key);
+        }
+        catch (error) {
+            return invalidLocaleKeyRefusal(fileName, todo.operationKey, todo.key, error);
+        }
+    }
+    return undefined;
+}
+function invalidLocaleKeyRefusal(fileName, operationKey, localeKey, error) {
+    const validatorDetail = error instanceof Error ? error.message : String(error);
+    return refusal(fileName, operationKey, "invalid_locale_key", `Refusing to write invalid provider locale key ${JSON.stringify(localeKey)}: ${validatorDetail}`);
+}
 function nonLiteral(fileName, operationKey, detail) {
     return {
         refusal: refusal(fileName, operationKey, "non_literal", detail),

package/dist/i18n/operation-locale-namespace.d.ts

@@ -0,0 +1,2 @@
+/** Canonical locale-catalog namespace for a URL-safe provider operation id. */
+export declare function operationIdToLocaleNamespace(operationId: string): string;

package/dist/i18n/operation-locale-namespace.js

@@ -0,0 +1,7 @@
+import { assertProviderLocaleKey } from "./keys.js";
+/** Canonical locale-catalog namespace for a URL-safe provider operation id. */
+export function operationIdToLocaleNamespace(operationId) {
+    const namespace = operationId.replace(/[-_]([a-z0-9])/g, (_separator, character) => character.toUpperCase());
+    assertProviderLocaleKey(`operations.${namespace}.description`);
+    return namespace;
+}

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "2.2.0-beta.52",
+	"version": "2.2.0-beta.53",
 	"name": "@apifuse/provider-sdk",
 	"private": false,
 	"type": "module",

package/src/cli/__tests__/fixtures/migrate-operation-declaration/examples-kebab-operation-id.ts.txt

@@ -0,0 +1,17 @@
+const listHospitalsOperation = defineOperation<ProviderContext>()({
+	annotations: { readOnly: true },
+	inputExamples: [
+		{
+			scenario: "List nearby hospitals",
+			input: { latitude: 37.5665, longitude: 126.978 },
+			rationale: "Exercises a kebab-case operation id.",
+		},
+	],
+	input: InputSchema,
+	output: OutputSchema,
+	handler,
+});
+
+export default buildProvider({
+	operations: { "list-hospitals": listHospitalsOperation },
+});

package/src/cli/__tests__/fixtures/migrate-operation-declaration/examples-snake-operation-id.ts.txt

@@ -0,0 +1,21 @@
+const listRecentEarthquakesOperation = defineOperation<ProviderContext>()({
+	annotations: { readOnly: true },
+	docs: {
+		titleKey: "operations.listRecentEarthquakes.title",
+		descriptionKey: "operations.listRecentEarthquakes.description",
+	},
+	inputExamples: [
+		{
+			scenario: "List recent earthquakes",
+			input: { limit: 10 },
+			rationale: "Exercises a snake-case operation id.",
+		},
+	],
+	input: InputSchema,
+	output: OutputSchema,
+	handler,
+});
+
+export default buildProvider({
+	operations: { list_recent_earthquakes: listRecentEarthquakesOperation },
+});

package/src/cli/__tests__/fixtures/migrate-operation-declaration/locale-existing-operation-namespace-en.json

@@ -0,0 +1,8 @@
+{
+	"operations": {
+		"listRecentEarthquakes": {
+			"title": "Recent earthquakes",
+			"description": "Lists recent earthquakes."
+		}
+	}
+}

package/src/cli/migrate-operation-declaration.ts

@@ -3,6 +3,9 @@ import { dirname, extname, join, relative, resolve } from "node:path";
 
 import type TS from "typescript";
 
+import { assertProviderLocaleKey } from "../i18n/keys.js";
+import { operationIdToLocaleNamespace } from "../i18n/operation-locale-namespace.js";
+
 const ts: typeof import("typescript") = await loadTypeScript();
 
 async function loadTypeScript(): Promise<typeof import("typescript")> {
@@ -67,6 +70,7 @@ export type OperationDeclarationRefusalReason =
 	| "missing_english_locale"
 	| "operation_id_unresolved"
 	| "examples_conflict"
+	| "invalid_locale_key"
 	| "locale_todo_conflict";
 
 export type OperationDeclarationRefusal = {
@@ -180,6 +184,10 @@ export function migrateOperationDeclaration(
 		todos.push(...plan.localeTodos);
 	}
 	if (refusals.length > 0) return { status: "refused", refusals };
+	const invalidLocaleKey = findInvalidLocaleTodo(todos, fileName);
+	if (invalidLocaleKey !== undefined) {
+		return { status: "refused", refusals: [invalidLocaleKey] };
+	}
 
 	if (edits.length === 0) {
 		return {
@@ -400,6 +408,30 @@ function planOperationMigration(
 		if (merged.insert !== undefined) addInsertion(insertions, "docs", merged.insert);
 	}
 
+	const title = planTitleLocale(
+		top.byName.get("title"),
+		top.byName.get("titleKey"),
+		docs.get("titleKey"),
+		fileName,
+		site,
+		localeFiles,
+	);
+	if ("refusal" in title) return title;
+	const localeNamespace =
+		top.byName.get("inputExamples") === undefined
+			? { namespace: site.operationKey }
+			: resolveOperationLocaleNamespace(
+					[
+						top.byName.get("titleKey"),
+						docs.get("titleKey"),
+						top.byName.get("descriptionKey"),
+						docs.get("descriptionKey"),
+					],
+					fileName,
+					site,
+				);
+	if ("refusal" in localeNamespace) return localeNamespace;
+
 	const examples = planExamples(
 		top.byName.get("inputExamples"),
 		top.byName.get("examples"),
@@ -408,6 +440,7 @@ function planOperationMigration(
 		source,
 		constArrays,
 		localeFiles,
+		localeNamespace.namespace,
 	);
 	if ("refusal" in examples) return examples;
 
@@ -431,7 +464,107 @@ function planOperationMigration(
 		if (!edits.some((existing) => rangesOverlap(existing, edit))) edits.push(edit);
 	}
 
-	return { edits, localeTodos: examples.localeTodos };
+	return { edits, localeTodos: [...title.localeTodos, ...examples.localeTodos] };
+}
+
+function planTitleLocale(
+	title: ResolvedMember | undefined,
+	flatTitleKey: ResolvedMember | undefined,
+	nestedTitleKey: ResolvedMember | undefined,
+	fileName: string,
+	site: OperationSite,
+	localeFiles: readonly string[],
+):
+	| { readonly localeTodos: readonly LocaleTodo[] }
+	| { readonly refusal: OperationDeclarationRefusal } {
+	if (title === undefined) return { localeTodos: [] };
+	const originalProse = literalString(title.initializer);
+	if (originalProse === undefined) {
+		return nonLiteral(
+			fileName,
+			site.operationKey,
+			"title must be a string literal so its authored prose can be preserved in the English locale catalog.",
+		);
+	}
+	if (!site.operationIdProven) {
+		return {
+			refusal: refusal(
+				fileName,
+				site.operationKey,
+				"operation_id_unresolved",
+				"title requires an exact operation id proven from a static operations map.",
+			),
+		};
+	}
+	if (!localeFiles.includes("locales/en.json")) {
+		return {
+			refusal: refusal(
+				fileName,
+				site.operationKey,
+				"missing_english_locale",
+				"title cannot be migrated because locales/en.json does not exist.",
+			),
+		};
+	}
+
+	let selectedTitleKey = flatTitleKey ?? nestedTitleKey;
+	if (flatTitleKey !== undefined && nestedTitleKey !== undefined) {
+		const same = equivalentLiteral(flatTitleKey.initializer, nestedTitleKey.initializer);
+		if (same === undefined) {
+			return nonLiteral(
+				fileName,
+				site.operationKey,
+				"titleKey must be literal when both top-level and nested declarations exist.",
+			);
+		}
+		if (!same) {
+			return {
+				refusal: refusal(
+					fileName,
+					site.operationKey,
+					"locale_key_conflict",
+					"Top-level titleKey conflicts with nested titleKey.",
+				),
+			};
+		}
+		selectedTitleKey = flatTitleKey;
+	}
+	const explicitTitleKey =
+		selectedTitleKey === undefined ? undefined : literalString(selectedTitleKey.initializer);
+	if (selectedTitleKey !== undefined && explicitTitleKey === undefined) {
+		return nonLiteral(
+			fileName,
+			site.operationKey,
+			"titleKey must be a string literal so the title locale destination is provable.",
+		);
+	}
+	let selectedTitleLocaleKey: string;
+	if (explicitTitleKey !== undefined) {
+		selectedTitleLocaleKey = explicitTitleKey;
+	} else {
+		try {
+			selectedTitleLocaleKey = `operations.${operationIdToLocaleNamespace(site.operationKey)}.title`;
+		} catch (error) {
+			return {
+				refusal: invalidLocaleKeyRefusal(
+					fileName,
+					site.operationKey,
+					`operations.${site.operationKey}.title`,
+					error,
+				),
+			};
+		}
+	}
+	return {
+		localeTodos: [
+			{
+				localeFile: "locales/en.json",
+				operationKey: site.operationKey,
+				key: selectedTitleLocaleKey,
+				originalProse,
+			},
+		],
+	};
 }
 
 function resolveRiskClass(
@@ -664,6 +797,7 @@ function planExamples(
 	source: TS.SourceFile,
 	constArrays: ReadonlyMap<string, TS.ArrayLiteralExpression>,
 	localeFiles: readonly string[],
+	localeNamespace: string,
 ):
 	| { readonly edits: readonly TextEdit[]; readonly localeTodos: readonly LocaleTodo[] }
 	| { readonly refusal: OperationDeclarationRefusal } {
@@ -760,7 +894,7 @@ function planExamples(
 				`inputExamples[${index}].scenario must be a string literal.`,
 			);
 		}
-		const scenarioKey = `operations.${site.operationKey}.examples.${index}.scenario`;
+		const scenarioKey = `operations.${localeNamespace}.examples.${index}.scenario`;
 		edits.push(replaceExampleLocaleMember(scenario, "scenarioKey", scenarioKey, source));
 		for (const localeFile of localeFiles) {
 			todos.push({
@@ -781,7 +915,7 @@ function planExamples(
 					`inputExamples[${index}].rationale must be a string literal.`,
 				);
 			}
-			const rationaleKey = `operations.${site.operationKey}.examples.${index}.rationale`;
+			const rationaleKey = `operations.${localeNamespace}.examples.${index}.rationale`;
 			edits.push(replaceExampleLocaleMember(rationale, "rationaleKey", rationaleKey, source));
 			for (const localeFile of localeFiles) {
 				todos.push({
@@ -796,6 +930,47 @@ function planExamples(
 	return { edits, localeTodos: todos };
 }
 
+function resolveOperationLocaleNamespace(
+	members: readonly (ResolvedMember | undefined)[],
+	fileName: string,
+	site: OperationSite,
+): { readonly namespace: string } | { readonly refusal: OperationDeclarationRefusal } {
+	const authoredNamespaces = new Set<string>();
+	for (const member of members) {
+		const localeKey = literalString(member?.initializer);
+		if (localeKey === undefined) continue;
+		const segments = localeKey.split(".");
+		if (segments[0] === "operations" && segments[1] !== undefined) {
+			authoredNamespaces.add(segments[1]);
+		}
+	}
+	if (authoredNamespaces.size > 1) {
+		return {
+			refusal: refusal(
+				fileName,
+				site.operationKey,
+				"locale_key_conflict",
+				`Operation titleKey and descriptionKey declarations use different locale namespaces: ${[...authoredNamespaces].join(", ")}.`,
+			),
+		};
+	}
+	const authored = authoredNamespaces.values().next().value;
+	if (authored !== undefined) return { namespace: authored };
+
+	try {
+		return { namespace: operationIdToLocaleNamespace(site.operationKey) };
+	} catch (error) {
+		return {
+			refusal: invalidLocaleKeyRefusal(
+				fileName,
+				site.operationKey,
+				`operations.${site.operationKey}.examples`,
+				error,
+			),
+		};
+	}
+}
+
 function replaceExampleLocaleMember(
 	member: ResolvedMember,
 	newName: string,
@@ -984,9 +1159,7 @@ function isProviderOperationsProperty(
 	// (a) The initializer (direct or via same-file const) mentions
 	// defineOperation / defineStreamOperation — the strongest signal.
 	const target = ts.isIdentifier(unwrapExpression(node.initializer) ?? node.initializer)
-		? constObjects.get(
-				(unwrapExpression(node.initializer) as TS.Identifier).text,
-			)
+		? constObjects.get((unwrapExpression(node.initializer) as TS.Identifier).text)
 		: undefined;
 	const initializerText = (target ?? node.initializer).getText();
 	if (/\bdefine(?:Stream)?Operation\b/.test(initializerText)) return true;
@@ -1513,6 +1686,35 @@ function refusal(
 	return { file, operationKey, reason, detail };
 }
 
+function findInvalidLocaleTodo(
+	todos: readonly LocaleTodo[],
+	fileName: string,
+): OperationDeclarationRefusal | undefined {
+	for (const todo of todos) {
+		try {
+			assertProviderLocaleKey(todo.key);
+		} catch (error) {
+			return invalidLocaleKeyRefusal(fileName, todo.operationKey, todo.key, error);
+		}
+	}
+	return undefined;
+}
+
+function invalidLocaleKeyRefusal(
+	fileName: string,
+	operationKey: string,
+	localeKey: string,
+	error: unknown,
+): OperationDeclarationRefusal {
+	const validatorDetail = error instanceof Error ? error.message : String(error);
+	return refusal(
+		fileName,
+		operationKey,
+		"invalid_locale_key",
+		`Refusing to write invalid provider locale key ${JSON.stringify(localeKey)}: ${validatorDetail}`,
+	);
+}
+
 function nonLiteral(
 	fileName: string,
 	operationKey: string,

package/src/i18n/operation-locale-namespace.ts

@@ -0,0 +1,10 @@
+import { assertProviderLocaleKey } from "./keys.js";
+
+/** Canonical locale-catalog namespace for a URL-safe provider operation id. */
+export function operationIdToLocaleNamespace(operationId: string): string {
+	const namespace = operationId.replace(/[-_]([a-z0-9])/g, (_separator, character: string) =>
+		character.toUpperCase(),
+	);
+	assertProviderLocaleKey(`operations.${namespace}.description`);
+	return namespace;
+}