@tailor-platform/sdk-codemod 0.3.0-next.7 → 0.3.0-next.8

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @tailor-platform/sdk-codemod
 
+## 0.3.0-next.8
+
+### Patch Changes
+
+- [#1811](https://github.com/tailor-platform/sdk/pull/1811) [`b2fc104`](https://github.com/tailor-platform/sdk/commit/b2fc104d9cdfc52e98c97bc18d80a9e2e9d5f4c2) Thanks [@toiroakr](https://github.com/toiroakr)! - Move the TailorDB `erdSite` setting out of the core config schema into the ERD plugin's own configuration. `db.<namespace>.erdSite` is no longer accepted in `tailor.config.ts`; configure the ERD deploy target on the plugin instead:
+  
+  ```ts
+  import { definePlugins } from "@tailor-platform/sdk";
+  import { tailordbErdPlugin } from "@tailor-platform/sdk-plugin-tailordb-erd";
+  
+  export const plugins = definePlugins(
+    // TailorDB namespace name → static website name
+    tailordbErdPlugin({ sites: { tailordb: "my-erd-site" } }),
+  );
+  ```
+  
+  The `tailor tailordb erd` commands resolve deploy targets from `tailordbErdPlugin({ sites })` and now validate each namespace against `config.db` and each site name against `staticWebsites`, so typos surface when the config is loaded instead of at deploy time. The `v2/erd-site-to-plugin` codemod migrates existing configs automatically. For programmatic users, `loadTailorDBNamespaces()` additionally returns the config module's registered `plugins`, and namespace selector callbacks receive them as a second argument.
+
+- [#1807](https://github.com/tailor-platform/sdk/pull/1807) [`817454f`](https://github.com/tailor-platform/sdk/commit/817454fff35e4093bce5fdcb9e1fcda8bbd1d7ef) Thanks [@dqn](https://github.com/dqn)! - `seedPlugin` no longer generates the `exec.mjs` seed runner. Seeding and validation move to the `tailor seed` commands provided by the `@tailor-platform/sdk-plugin-seed` CLI plugin: install it with `npm install -D @tailor-platform/sdk-plugin-seed`, replace `node <distPath>/exec.mjs` with `tailor seed apply` and `node <distPath>/exec.mjs validate` with `tailor seed validate`, and delete the stale generated `exec.mjs`. Seed data and schema generation (`data/*.jsonl`, `data/*.schema.ts`) is unchanged. Because the plugin reads the config at run time, `machineUserName` changes in seedPlugin options now take effect without regenerating. `@tailor-platform/sdk/cli` gains `loadSeedContext` (and `SeedContext` types) for this, `SeedData` is now JSON-typed, and `executeScript` accepts a plain object `invoker` (`ScriptInvoker`).
+
 ## 0.3.0-next.7
 
 ### Patch Changes

package/dist/codemods/v2/erd-site-to-plugin/scripts/transform.js

@@ -0,0 +1,195 @@
+import { Lang, parse } from "@ast-grep/napi";
+//#region codemods/v2/erd-site-to-plugin/scripts/transform.ts
+const PLUGIN_IMPORT = "import { tailordbErdPlugin } from \"@tailor-platform/sdk-plugin-tailordb-erd\";";
+const DEFINE_PLUGINS_IMPORT = "import { definePlugins } from \"@tailor-platform/sdk\";";
+const SDK_VALUE_IMPORT_REGEX = /(^|\n)import\s*\{[^}\n]*\}\s*from\s*["']@tailor-platform\/sdk["'];?/;
+const FUNCTION_KINDS = /* @__PURE__ */ new Set([
+	"arrow_function",
+	"function_declaration",
+	"function_expression",
+	"generator_function",
+	"generator_function_declaration",
+	"method_definition"
+]);
+function unquote(text) {
+	return text.replace(/^["']|["']$/g, "");
+}
+function propertyName(pair) {
+	const key = pair.field("key");
+	if (!key || key.kind() === "computed_property_name") return null;
+	return unquote(key.text());
+}
+function insideFunction(node) {
+	for (let current = node.parent(); current; current = current.parent()) if (FUNCTION_KINDS.has(current.kind())) return true;
+	return false;
+}
+/**
+* Resolve the local binding name of `definePlugins` imported from
+* `@tailor-platform/sdk`, honoring `import { definePlugins as alias }`.
+* @param tree - Parsed source tree root.
+* @returns Local binding name, or null when it is not imported.
+*/
+function definePluginsLocalName(tree) {
+	const importStatements = tree.findAll({ rule: {
+		kind: "import_statement",
+		has: {
+			kind: "string",
+			regex: "^[\"']@tailor-platform/sdk[\"']$"
+		}
+	} });
+	for (const statement of importStatements) for (const specifier of statement.findAll({ rule: { kind: "import_specifier" } })) {
+		const name = specifier.field("name");
+		if (name?.text() !== "definePlugins") continue;
+		return (specifier.field("alias") ?? name).text();
+	}
+	return null;
+}
+/**
+* Build an edit that removes a property pair from an object literal, cleaning
+* up the separating comma, an inline line comment that documented the removed
+* property, and the removed line's indentation.
+* @param objectNode - Object literal containing the pair.
+* @param pairNode - Property pair to remove.
+* @returns Edit replacing the object literal with the pair removed.
+*/
+function removePairEdit(objectNode, pairNode) {
+	const objText = objectNode.text();
+	const objStart = objectNode.range().start.index;
+	const start = pairNode.range().start.index - objStart;
+	const end = pairNode.range().end.index - objStart;
+	const before = objText.slice(0, start);
+	const after = objText.slice(end);
+	let removeFrom = start;
+	let removeTo = end;
+	const trailing = after.match(/^[ \t]*,[ \t]*(?:\/\/[^\n]*)?\n?/);
+	if (trailing) {
+		removeTo = end + trailing[0].length;
+		const indent = before.match(/\n[ \t]*$/);
+		if (indent) removeFrom = start - (indent[0].length - 1);
+	} else {
+		const leading = before.match(/,\s*$/);
+		if (leading) removeFrom = start - leading[0].length;
+		const inlineComment = after.match(/^[ \t]*\/\/[^\n]*/);
+		if (inlineComment) removeTo = end + inlineComment[0].length;
+	}
+	return objectNode.replace(objText.slice(0, removeFrom) + objText.slice(removeTo));
+}
+/**
+* Build an edit that appends an argument to a call expression, preserving the
+* call's single-line or multi-line formatting. Insertion points are derived
+* from argument-list AST nodes so a trailing line comment after the last
+* argument cannot swallow the separating comma.
+* @param callNode - Call expression to extend.
+* @param arg - Argument expression to append.
+* @returns Edit replacing the call expression with the argument appended.
+*/
+function appendArgEdit(callNode, arg) {
+	const callText = callNode.text();
+	const base = callNode.range().start.index;
+	const children = callNode.field("arguments").children();
+	const args = children.filter((child) => child.isNamed() && child.kind() !== "comment");
+	const closeOffset = children.at(-1).range().start.index - base;
+	const multiline = callText.includes("\n");
+	const closeIndent = callText.slice(0, closeOffset).match(/\n([ \t]*)$/)?.[1] ?? "";
+	const argIndent = `${closeIndent}  `;
+	if (args.length === 0) {
+		const head = callText.slice(0, closeOffset).replace(/[ \t]*$/, "");
+		const rewritten = multiline ? `${head}${argIndent}${arg},\n${closeIndent})` : `${head}${arg})`;
+		return callNode.replace(rewritten);
+	}
+	const lastArg = args.at(-1);
+	const followers = children.slice(children.indexOf(lastArg) + 1);
+	const trailingComma = followers.find((child) => !child.isNamed() && child.text() === ",");
+	const anchor = trailingComma ?? lastArg;
+	if (!multiline) {
+		const insertAt = anchor.range().end.index - base;
+		const insertion = `${trailingComma ? "" : ","} ${arg}`;
+		return callNode.replace(callText.slice(0, insertAt) + insertion + callText.slice(insertAt));
+	}
+	const argInsertAt = (followers.findLast((child) => child.kind() === "comment" && child.range().start.index >= anchor.range().end.index && child.range().start.line === anchor.range().end.line) ?? anchor).range().end.index - base;
+	let rewritten = callText.slice(0, argInsertAt) + `\n${argIndent}${arg},` + callText.slice(argInsertAt);
+	if (!trailingComma) {
+		const commaAt = lastArg.range().end.index - base;
+		rewritten = rewritten.slice(0, commaAt) + "," + rewritten.slice(commaAt);
+	}
+	return callNode.replace(rewritten);
+}
+/**
+* Add `definePlugins` to an existing single-line value import from
+* `@tailor-platform/sdk`, or return null when no such import exists.
+* @param source - Source code to modify.
+* @returns Modified source, or null when a separate import line is needed.
+*/
+function addDefinePluginsSpecifier(source) {
+	const match = source.match(SDK_VALUE_IMPORT_REGEX);
+	if (!match) return null;
+	const updated = match[0].replace(/,?\s*\}/, ", definePlugins }");
+	return source.replace(match[0], updated);
+}
+function insertImports(source, importLines) {
+	const sdkImportRegex = /^import\s+.*from\s+["']@tailor-platform\/sdk[^"']*["'];?$/gm;
+	let lastMatch = null;
+	for (let match = sdkImportRegex.exec(source); match; match = sdkImportRegex.exec(source)) lastMatch = match;
+	const block = importLines.join("\n");
+	if (lastMatch) {
+		const insertPos = lastMatch.index + lastMatch[0].length;
+		return source.slice(0, insertPos) + "\n" + block + source.slice(insertPos);
+	}
+	return block + "\n" + source;
+}
+/**
+* Move `db.<namespace>.erdSite` entries in defineConfig() into a
+* `tailordbErdPlugin({ sites })` argument of definePlugins():
+*
+* 1. Remove each `erdSite` property from `db.<namespace>` objects of
+*    top-level defineConfig() calls (factory-wrapped configs are left for
+*    manual review, since their erdSite values may reference local bindings)
+* 2. Append `tailordbErdPlugin({ sites: { <namespace>: <value> } })` to the
+*    existing definePlugins() call (honoring an import alias), or add a
+*    `plugins` export when none exists
+* 3. Add the plugin import (and a definePlugins import when newly needed)
+* @param source - Source code to transform
+* @returns Transformed source or null if no changes needed
+*/
+function transform(source) {
+	if (!source.includes("erdSite") || !source.includes("@tailor-platform/sdk")) return null;
+	if (source.includes("tailordbErdPlugin")) return null;
+	const tree = parse(Lang.TypeScript, source).root();
+	const edits = [];
+	const siteEntries = [];
+	for (const call of tree.findAll({ rule: { pattern: "defineConfig($CONFIG)" } })) {
+		if (insideFunction(call)) continue;
+		const config = call.getMatch("CONFIG");
+		if (!config || config.kind() !== "object") continue;
+		const dbObject = config.children().find((child) => child.kind() === "pair" && propertyName(child) === "db")?.field("value");
+		if (!dbObject || dbObject.kind() !== "object") continue;
+		for (const nsPair of dbObject.children().filter((child) => child.kind() === "pair")) {
+			const nsKey = nsPair.field("key");
+			const nsObject = nsPair.field("value");
+			if (!nsKey || nsKey.kind() === "computed_property_name") continue;
+			if (!nsObject || nsObject.kind() !== "object") continue;
+			const erdPair = nsObject.children().find((child) => child.kind() === "pair" && propertyName(child) === "erdSite");
+			const valueNode = erdPair?.field("value");
+			if (!erdPair || !valueNode) continue;
+			siteEntries.push(`${nsKey.text()}: ${valueNode.text()}`);
+			edits.push(removePairEdit(nsObject, erdPair));
+		}
+	}
+	if (siteEntries.length === 0) return null;
+	const pluginExpr = `tailordbErdPlugin({ sites: { ${siteEntries.join(", ")} } })`;
+	const localDefinePlugins = definePluginsLocalName(tree);
+	const pluginsCall = tree.find({ rule: { pattern: `${localDefinePlugins ?? "definePlugins"}($$$ARGS)` } });
+	if (pluginsCall) edits.push(appendArgEdit(pluginsCall, pluginExpr));
+	let result = tree.commitEdits(edits);
+	const importLines = [PLUGIN_IMPORT];
+	if (!pluginsCall && !localDefinePlugins) {
+		const merged = addDefinePluginsSpecifier(result);
+		if (merged !== null) result = merged;
+		else importLines.push(DEFINE_PLUGINS_IMPORT);
+	}
+	result = insertImports(result, importLines);
+	if (!pluginsCall) result = result.replace(/\s*$/, "\n\n") + `export const plugins = ${localDefinePlugins ?? "definePlugins"}(\n  ${pluginExpr},\n);\n`;
+	return result;
+}
+//#endregion
+export { transform as default };

package/dist/index.js

@@ -119,6 +119,8 @@ const V2_NEXT_2 = "2.0.0-next.2";
 const V2_NEXT_4 = "2.0.0-next.4";
 const V2_NEXT_5 = "2.0.0-next.5";
 const V2_NEXT_6 = "2.0.0-next.6";
+const V2_NEXT_7 = "2.0.0-next.7";
+const V2_NEXT_9 = "2.0.0-next.9";
 /** All registered codemods, in registration order. */
 const allCodemods = [
 	{
@@ -855,7 +857,7 @@ const allCodemods = [
 		description: "Rename `Workflow.trigger()` (returned by `createWorkflow()`) and `WorkflowJob.trigger()` (returned by `createWorkflowJob()`) to `.start()`, aligning the SDK's ergonomic verb with the platform's `start*` RPC vocabulary. No codemod ships for this rename: distinguishing a workflow/job `.trigger()` call from an unrelated object's own `.trigger()` method requires resolving the receiver back to a `createWorkflow`/`createWorkflowJob` result across files, which the SDK's own CLI bundler already does for build-time rewriting. Reusing that logic in a standalone script is a nontrivial lift, and — unlike the bundler, which fails loudly when it cannot rewrite a call — a codemod false positive would silently rewrite an unrelated `.trigger()` call with no error. For the call-site volume this rename typically involves, manual review guided by the prompt below is the safer trade-off.",
 		since: "1.0.0",
 		until: "2.0.0",
-		prereleaseUntil: "2.0.0-next.7",
+		prereleaseUntil: V2_NEXT_7,
 		filePatterns: ["**/*.{ts,tsx,mts,cts,js,jsx,mjs,cjs}"],
 		suspiciousPatterns: [".trigger("],
 		examples: [{
@@ -1071,6 +1073,73 @@ const allCodemods = [
 			"3. Remove unused `Hooks<F>` / `HookFn<>` type imports"
 		].join("\n")
 	},
+	{
+		id: "v2/erd-site-to-plugin",
+		name: "`db.<namespace>.erdSite` → `tailordbErdPlugin({ sites })`",
+		description: "Move the TailorDB `erdSite` setting from `db.<namespace>` in tailor.config.ts into `tailordbErdPlugin({ sites })` from `@tailor-platform/sdk-plugin-tailordb-erd`, registered via definePlugins(). The core config schema no longer accepts `erdSite`; the `tailor tailordb erd` commands read the target static website from the plugin configuration and validate each site name against `staticWebsites`. Install `@tailor-platform/sdk-plugin-tailordb-erd` as a dev dependency: the migrated config imports it, so config loading fails with a module-not-found error until it is installed.",
+		since: "1.0.0",
+		until: "2.0.0",
+		prereleaseUntil: V2_NEXT_9,
+		scriptPath: "v2/erd-site-to-plugin/scripts/transform.js",
+		legacyPatterns: ["erdSite:"],
+		sourceStringLegacyPatterns: ["erdSite"],
+		suspiciousPatterns: [
+			"erdSite:",
+			/\berdSite\s*[,}]/,
+			"tailordbErdPlugin"
+		],
+		sourceStringSuspiciousPatterns: ["erdSite"],
+		examples: [{
+			before: [
+				"export default defineConfig({",
+				"  db: {",
+				"    tailordb: {",
+				"      files: [\"./tailordb/*.ts\"],",
+				"      erdSite: \"my-erd-site\",",
+				"    },",
+				"  },",
+				"});"
+			].join("\n"),
+			after: [
+				"import { tailordbErdPlugin } from \"@tailor-platform/sdk-plugin-tailordb-erd\";",
+				"",
+				"export default defineConfig({",
+				"  db: {",
+				"    tailordb: {",
+				"      files: [\"./tailordb/*.ts\"],",
+				"    },",
+				"  },",
+				"});",
+				"",
+				"export const plugins = definePlugins(",
+				"  tailordbErdPlugin({ sites: { tailordb: \"my-erd-site\" } }),",
+				");"
+			].join("\n")
+		}],
+		prompt: [
+			"In Tailor SDK v2 the TailorDB `erdSite` setting is removed from the core config",
+			"schema; the ERD deploy target is configured on the ERD CLI plugin instead. The",
+			"codemod rewrites literal `db.<namespace>.erdSite` entries inside top-level",
+			"defineConfig() calls into a `tailordbErdPlugin({ sites: { <namespace>: <value> } })`",
+			"argument of definePlugins(), importing it from @tailor-platform/sdk-plugin-tailordb-erd.",
+			"",
+			"First, for every config that now registers tailordbErdPlugin, make sure",
+			"@tailor-platform/sdk-plugin-tailordb-erd is installed as a dev dependency — the",
+			"migrated config imports it, so config loading fails with ERR_MODULE_NOT_FOUND",
+			"until it is installed.",
+			"",
+			"For any remaining `erdSite` config keys the codemod did not rewrite — a db config",
+			"built dynamically or passed via a variable, quoted or computed keys, spread",
+			"properties, a defineConfig() call inside a factory function, or a file that",
+			"already registers tailordbErdPlugin — move the namespace → static-website-name",
+			"mapping into tailordbErdPlugin({ sites }) and delete the `erdSite` key. For",
+			"factory-built configs, keep any referenced parameters or locals in scope when",
+			"moving the value to the module-level definePlugins() export. Each site name",
+			"must match a static website defined in staticWebsites. Leave unrelated",
+			"identifiers that merely contain the name (e.g. a defineStaticWebSite variable",
+			"named erdSite) unchanged."
+		].join("\n")
+	},
 	{
 		id: "v2/generate-watch-flag",
 		name: "generate --watch flag removed",
@@ -1107,6 +1176,36 @@ const allCodemods = [
 			"single generation pass and resolves once it completes."
 		].join("\n")
 	},
+	{
+		id: "v2/seed-exec-to-cli-plugin",
+		name: "Generated seed exec.mjs → tailor seed CLI plugin",
+		description: "`seedPlugin` no longer generates the `exec.mjs` seed runner. Seeding and validation move to the `tailor seed` commands provided by the `@tailor-platform/sdk-plugin-seed` CLI plugin: install it as a devDependency, replace `node <distPath>/exec.mjs` invocations with `tailor seed apply` and `node <distPath>/exec.mjs validate` with `tailor seed validate`, and delete the stale generated `<distPath>/exec.mjs` file. Seed data and schema generation (`data/*.jsonl`, `data/*.schema.ts`) is unchanged, and the `tailor seed apply` options mirror the old script (`--machine-user`, `--namespace`, `--skip-idp`, `--truncate`, `--yes`, type-name arguments).",
+		since: "1.0.0",
+		until: "2.0.0",
+		prereleaseUntil: V2_NEXT_9,
+		filePatterns: ["**/package.json", "**/*.{sh,yml,yaml,md,mjs,ts}"],
+		suspiciousPatterns: ["exec.mjs"],
+		sourceStringSuspiciousPatterns: ["exec.mjs"],
+		examples: [{
+			before: "\"seed\": \"node ./seed/exec.mjs\",\n\"seed:validate\": \"node ./seed/exec.mjs validate\"",
+			after: "\"seed\": \"tailor seed apply\",\n\"seed:validate\": \"tailor seed validate\"",
+			lang: "jsonc"
+		}],
+		prompt: [
+			"seedPlugin no longer generates the exec.mjs seed runner in v2. The tailor seed",
+			"CLI plugin (@tailor-platform/sdk-plugin-seed) replaces it:",
+			"",
+			"- Install @tailor-platform/sdk-plugin-seed as a devDependency next to",
+			"  @tailor-platform/sdk.",
+			"- Replace `node <distPath>/exec.mjs [options] [types...]` invocations with",
+			"  `tailor seed apply [options] [types...]` (same options: --machine-user/-m,",
+			"  --namespace/-n, --skip-idp, --truncate, --yes, and type-name arguments).",
+			"- Replace `node <distPath>/exec.mjs validate [path]` with",
+			"  `tailor seed validate [path]`.",
+			"- Delete the stale generated `<distPath>/exec.mjs` file; keep the data/",
+			"  directory (JSONL data and generated schemas) as-is."
+		].join("\n")
+	},
 	{
 		id: "v2/node-minimum-22-15-0",
 		name: "Node.js minimum version raised to 22.15.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tailor-platform/sdk-codemod",
-  "version": "0.3.0-next.7",
+  "version": "0.3.0-next.8",
   "description": "Codemod runner for Tailor Platform SDK upgrades",
   "license": "MIT",
   "repository": {