@softr/cli 0.1.6 → 0.1.7-se22117.20

package/README.md

@@ -188,9 +188,13 @@ synced. That is how `push` knows there is nothing to send, how it notices that t
 
 #### The node types on offer
 
-`spec` lists them. The set is small on purpose: the generic triggers (webhook, schedules, Softr Tables and Softr Apps
+`spec` lists the curated set, small on purpose: the generic triggers (webhook, schedules, Softr Tables and Softr Apps
 events, incoming email), the control nodes (branch, filter, loop, wait), `RESPONDED_TO_WEBHOOK`, `CALL_API`, and
-`CUSTOM_CODE` for everything else. Other integrations stay in the studio. Each entry points to its public docs page.
+`CUSTOM_CODE` for code. Each entry points to its public docs page and comes with a template and an example.
+
+Any other node type the workflows service knows works in the file as well; the CLI just has no specification for it.
+`spec <TYPE>` says where to get one (the Softr MCP server or the studio), `add <TYPE> --node-version <v>` writes the node
+with empty inputs, and the service validates it on publish, as for every node.
 
 #### A typical session
 

package/dist/cli.mjs

@@ -6070,18 +6070,74 @@ var CATALOG = catalog_default;
 function catalogEntries(kind) {
   return CATALOG.filter((entry) => !kind || entry.kind === kind);
 }
-function findCatalogEntry(type, kind) {
+function catalogEntryOrNull(type, kind) {
   const wanted = type.trim().toUpperCase();
-  const entry = CATALOG.find((candidate) => candidate.type === wanted && (!kind || candidate.kind === kind));
+  return CATALOG.find((candidate) => candidate.type === wanted && (!kind || candidate.kind === kind));
+}
+function findCatalogEntry(type, kind) {
+  const entry = catalogEntryOrNull(type, kind);
   if (!entry) {
     const known = catalogEntries(kind).map((candidate) => candidate.type).join(", ");
     throw new CliError(
-      `"${type}" is not a node type this CLI offers${kind ? ` as a ${kind}` : ""}.`,
-      `Available: ${known}. The CLI is limited to code-first workflows on purpose; other integrations are configured in the studio.`
+      `"${type.trim().toUpperCase()}" is not in the CLI's curated set${kind ? ` of ${kind}s` : ""}.`,
+      `Curated: ${known}.
+${uncuratedGuidance(type)}`
     );
   }
   return entry;
 }
+function uncuratedGuidance(type) {
+  const wanted = type.trim().toUpperCase();
+  return [
+    `${wanted} is not in the curated set, so the CLI has no template or specification for it; the workflows service`,
+    "still runs it. Take its specification (inputs, the required ones, fixed options, version) from the Softr MCP server",
+    "(get_node_specifications; workflow_get_node_specifications in an agent runtime) or from the studio. Then write the",
+    "node with its type, version and inputs, or scaffold it: softr workflows add <TYPE> --node-version <v> [--kind trigger].",
+    "Push and test it as any node: the service validates it on publish and names what is wrong."
+  ].join("\n");
+}
+function resolveNodeType(type, choice) {
+  const entry = catalogEntryOrNull(type, choice.kind);
+  if (entry) {
+    if (choice.version) {
+      throw new CliError(
+        `${entry.type} is curated: the CLI pins its version (${entry.version}).`,
+        'Drop --node-version; "softr workflows upgrade" moves nodes to the current one.'
+      );
+    }
+    const { type: curatedType, kind, label, version: version2, template } = entry;
+    return { type: curatedType, kind, label, version: version2, template: structuredClone(template), curated: true };
+  }
+  const otherKind = catalogEntryOrNull(type);
+  if (otherKind) {
+    throw new CliError(
+      `${otherKind.type} is curated as ${article(otherKind.kind)}, not ${article(choice.kind ?? "action")}.`,
+      `Curated ${choice.kind ?? "action"}s: ${catalogEntries(choice.kind ?? "action").map((candidate) => candidate.type).join(", ")}.`
+    );
+  }
+  const wanted = type.trim().toUpperCase();
+  if (!choice.version) {
+    throw new CliError(
+      `"${wanted}" is not in the CLI's curated set, so pass --node-version <v>: the node version the service runs.`,
+      uncuratedGuidance(type)
+    );
+  }
+  return {
+    type: wanted,
+    kind: choice.kind ?? "action",
+    label: labelOf(wanted),
+    version: choice.version,
+    template: {},
+    curated: false
+  };
+}
+function article(kind) {
+  return kind === "action" ? "an action" : "a trigger";
+}
+function labelOf(type) {
+  const words = type.toLowerCase().split("_");
+  return [words[0].charAt(0).toUpperCase() + words[0].slice(1), ...words.slice(1)].join(" ");
+}
 function isTestableType(type) {
   return !NOT_TESTABLE_TYPES.has(type);
 }
@@ -14346,42 +14402,48 @@ function pathsAt(config, pathsPath) {
   return Array.isArray(current2) ? current2 : [];
 }
 function registerEdit(program3) {
-  program3.command("replace").description("Give a node another type: keeps its id, title and paths; inputs start from the new type's template").argument("<nodeId>", "the trigger or action to change").argument("<type>", 'the new type from "spec", of the same kind (trigger or action)').option("--lang <language>", "for CUSTOM_CODE: JAVASCRIPT or PYTHON (default JAVASCRIPT)").option("--dir <path>", "workflow directory (default: the current directory)").action(async (nodeId, type, opts, command) => {
-    const options = globalOptions(command);
-    const dir = await findWorkflowDir(process.cwd(), opts.dir);
-    const config = await readConfig(dir);
-    const location = locateNode(config, nodeId);
-    if (!location) {
-      throw new CliError(`No node "${nodeId}" in softr-workflows.jsonc.`);
-    }
-    const entry = findCatalogEntry(type, location.kind);
-    if (location.node.type === LOOP_TYPE && entry.type !== LOOP_TYPE) {
-      throw new CliError(`"${nodeId}" is a loop with a body; remove it instead of replacing it.`);
-    }
-    const title = location.node.title ?? entry.label;
-    const { inputs, codeFile } = await newNodeInputs(entry, nodeId, title, opts.lang, dir);
-    const node = { ...location.node, type: entry.type, version: entry.version, inputs };
-    delete node["outputSchema"];
-    await editConfig(dir, [{ path: location.path, value: node }]);
-    const oldCode = location.node.type === CUSTOM_CODE_TYPE && isFileRef(location.node.inputs?.["code"]) ? location.node.inputs?.["code"] : void 0;
-    const notes = [
-      oldCode && oldCode !== inputs["code"] ? `The previous code file (${oldCode}) is left in place; delete it when you no longer need it.` : "",
-      entry.kind === "trigger" && (config.triggers?.length ?? 0) > 1 ? "The service accepts one trigger per published workflow for now." : "",
-      `Fill inputs.${Object.keys(entry.template)[0] ?? "\u2026"} etc. in softr-workflows.jsonc (see "spec ${entry.type}"), then push and test ${nodeId}.`
-    ].filter(Boolean);
-    emitWithVersionNote(
-      options,
-      await readConfig(dir),
-      `Replaced "${nodeId}" (${location.node.type}) with ${entry.type}; paths kept.
+  program3.command("replace").description("Give a node another type: keeps its id, title and paths; inputs start from the new type's template").argument("<nodeId>", "the trigger or action to change").argument(
+    "<type>",
+    'the new type from "spec" (same kind: trigger or action), or any type the service knows (with --node-version)'
+  ).option("--lang <language>", "for CUSTOM_CODE: JAVASCRIPT or PYTHON (default JAVASCRIPT)").option("--node-version <version>", "for a type outside the curated set: the node version the service runs").option("--dir <path>", "workflow directory (default: the current directory)").action(
+    async (nodeId, type, opts, command) => {
+      const options = globalOptions(command);
+      const dir = await findWorkflowDir(process.cwd(), opts.dir);
+      const config = await readConfig(dir);
+      const location = locateNode(config, nodeId);
+      if (!location) {
+        throw new CliError(`No node "${nodeId}" in softr-workflows.jsonc.`);
+      }
+      const entry = resolveNodeType(type, { kind: location.kind, version: opts.nodeVersion });
+      if (location.node.type === LOOP_TYPE && entry.type !== LOOP_TYPE) {
+        throw new CliError(`"${nodeId}" is a loop with a body; remove it instead of replacing it.`);
+      }
+      const title = location.node.title ?? entry.label;
+      const { inputs, codeFile } = await newNodeInputs(entry, nodeId, title, opts.lang, dir);
+      const node = { ...location.node, type: entry.type, version: entry.version, inputs };
+      delete node["outputSchema"];
+      await editConfig(dir, [{ path: location.path, value: node }]);
+      const oldCode = location.node.type === CUSTOM_CODE_TYPE && isFileRef(location.node.inputs?.["code"]) ? location.node.inputs?.["code"] : void 0;
+      const notes = [
+        oldCode && oldCode !== inputs["code"] ? `The previous code file (${oldCode}) is left in place; delete it when you no longer need it.` : "",
+        entry.kind === "trigger" && (config.triggers?.length ?? 0) > 1 ? "The service accepts one trigger per published workflow for now." : "",
+        entry.curated ? `Fill inputs.${Object.keys(entry.template)[0] ?? "\u2026"} etc. in softr-workflows.jsonc (see "spec ${entry.type}"), then push and test ${nodeId}.` : `Fill its inputs in softr-workflows.jsonc from its specification ("spec ${entry.type}" says where to find it), then push and test ${nodeId}.`
+      ].filter(Boolean);
+      emitWithVersionNote(
+        options,
+        await readConfig(dir),
+        `Replaced "${nodeId}" (${location.node.type}) with ${entry.type}; paths kept.
 ${notes.join("\n")}`,
-      {
-        id: nodeId,
-        from: location.node.type,
-        to: entry.type,
-        codeFile: codeFile ? path5.relative(process.cwd(), codeFile) : null
-      }
-    );
-  });
+        {
+          id: nodeId,
+          from: location.node.type,
+          to: entry.type,
+          curated: entry.curated,
+          codeFile: codeFile ? path5.relative(process.cwd(), codeFile) : null
+        }
+      );
+    }
+  );
   program3.command("remove").description("Remove a node and every path that leads to or from it (a loop goes with its body)").argument("<nodeId>", "the trigger or action to remove").option("--dir <path>", "workflow directory (default: the current directory)").action(async (nodeId, opts, command) => {
     const options = globalOptions(command);
     const dir = await findWorkflowDir(process.cwd(), opts.dir);
@@ -14430,6 +14492,15 @@ function slug(title, fallback = "workflow") {
 }
 
 // src/commands/add.ts
+function parseKind(kind) {
+  if (kind === void 0) {
+    return void 0;
+  }
+  if (kind === "trigger" || kind === "action") {
+    return kind;
+  }
+  throw new CliError(`--kind takes trigger or action, not "${kind}".`);
+}
 function uniqueId(base, taken) {
   if (!taken.has(base)) {
     return base;
@@ -14465,11 +14536,14 @@ function defaultAfter(config, loopId) {
   );
 }
 function registerAdd(program3) {
-  program3.command("add").description("Add an action after an existing node, or a trigger; custom code gets its own file under actions/").argument("<type>", 'node type from "spec", e.g. CUSTOM_CODE or WEBHOOK').option("--id <id>", "node id, readable and unique (default: derived from the type)").option("--title <title>", "node title shown in the studio (default: the type label)").option("--after <nodeId>", "actions: the node the new one follows (default: the only node without a successor)").option("--to <nodeId>", "triggers: an action the new trigger leads to").option("--in-loop <loopId>", "put the node inside this loop body").option("--lang <language>", "for CUSTOM_CODE: JAVASCRIPT or PYTHON (default JAVASCRIPT)").option("--dir <path>", "workflow directory (default: the current directory)").action(async (type, opts, command) => {
+  program3.command("add").description("Add an action after an existing node, or a trigger; custom code gets its own file under actions/").argument(
+    "<type>",
+    'node type from "spec", e.g. CUSTOM_CODE or WEBHOOK, or any type the service knows (with --node-version)'
+  ).option("--id <id>", "node id, readable and unique (default: derived from the type)").option("--title <title>", "node title shown in the studio (default: the type label)").option("--after <nodeId>", "actions: the node the new one follows (default: the only node without a successor)").option("--to <nodeId>", "triggers: an action the new trigger leads to").option("--in-loop <loopId>", "put the node inside this loop body").option("--lang <language>", "for CUSTOM_CODE: JAVASCRIPT or PYTHON (default JAVASCRIPT)").option("--node-version <version>", "for a type outside the curated set: the node version the service runs").option("--kind <kind>", "for a type outside the curated set: trigger or action (default action)").option("--dir <path>", "workflow directory (default: the current directory)").action(async (type, opts, command) => {
     const options = globalOptions(command);
     const dir = await findWorkflowDir(process.cwd(), opts.dir);
     const config = await readConfig(dir);
-    const entry = findCatalogEntry(type);
+    const entry = resolveNodeType(type, { kind: parseKind(opts.kind), version: opts.nodeVersion });
     const nodes = [...config.triggers ?? [], ...allActions(config.actions)];
     const taken = new Set(nodes.map((node2) => node2.id));
     const id = opts.id ?? uniqueId(entry.kind === "trigger" ? "trigger" : slug(entry.label), taken);
@@ -14509,6 +14583,7 @@ ${notes.join("\n")}`,
           id,
           kind: "trigger",
           type: entry.type,
+          curated: entry.curated,
           to: opts.to ?? null
         }
       );
@@ -14533,6 +14608,7 @@ ${notes.join("\n")}`,
     const next = [
       codeFile ? `Write the function in ${path6.relative(process.cwd(), codeFile)} and map its inputs under inputs.inputData in softr-workflows.jsonc.` : "",
       entry.type === "BRANCH" || entry.type === "FILTER" ? `Add the condition(s) on the path(s) leaving it in softr-workflows.jsonc (see "spec ${entry.type}").` : "",
+      entry.curated ? "" : `Fill its inputs in softr-workflows.jsonc from its specification ("spec ${entry.type}" says where to find it).`,
       `Then: softr workflows push, softr workflows test ${id}.`
     ].filter(Boolean);
     emitWithVersionNote(
@@ -14544,6 +14620,7 @@ ${next.join("\n")}`,
         id,
         kind: "action",
         type: entry.type,
+        curated: entry.curated,
         after,
         loopId: opts.inLoop ?? null,
         codeFile: codeFile ? path6.relative(process.cwd(), codeFile) : null
@@ -17697,7 +17774,8 @@ function renderList() {
   }
   return [
     table.toString(),
-    "This CLI offers only these node types on purpose: code-first workflows use custom code for everything else.",
+    "These are the curated types: documented here, with a template and an example each. Any other node type the",
+    'workflows service knows can be written into softr-workflows.jsonc as well; "softr workflows spec <TYPE>" says how.',
     'Run "softr workflows spec <TYPE>" for the inputs, output and an example of one type.'
   ].join("\n");
 }
@@ -17756,7 +17834,9 @@ ${JSON.stringify(extra.json, null, 2)}`);
   return blocks.join("\n\n");
 }
 function registerSpec(program3) {
-  program3.command("spec").description("List the node types this CLI offers, or show the inputs, output and an example of one").argument("[type]", "a node type such as CUSTOM_CODE").action((type, _opts, command) => {
+  program3.command("spec").description(
+    "List the curated node types, or show the inputs, output and an example of one; any other type: how to add it"
+  ).argument("[type]", "a node type such as CUSTOM_CODE").action((type, _opts, command) => {
     const options = globalOptions(command);
     if (!type) {
       emit(options, renderList(), {
@@ -17770,8 +17850,13 @@ function registerSpec(program3) {
       });
       return;
     }
-    const entry = findCatalogEntry(type);
-    emit(options, renderEntry(entry), { ...entry, testable: isTestableType(entry.type) });
+    const entry = catalogEntryOrNull(type);
+    if (!entry) {
+      const guidance = uncuratedGuidance(type);
+      emit(options, guidance, { type: type.trim().toUpperCase(), curated: false, guidance });
+      return;
+    }
+    emit(options, renderEntry(entry), { ...entry, curated: true, testable: isTestableType(entry.type) });
   });
 }
 
@@ -17998,7 +18083,7 @@ Pass --workspace <id> to a command, or set SOFTR_WORKSPACE_ID, to work in one of
 // package.json
 var package_default = {
   name: "@softr/cli",
-  version: "0.1.6",
+  version: "0.1.7-se22117.20",
   description: "The Softr command line: build, test and publish Softr workflows from local files, manage Softr Databases; more Softr APIs to come",
   keywords: [
     "softr",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softr/cli",
-  "version": "0.1.6",
+  "version": "0.1.7-se22117.20",
   "description": "The Softr command line: build, test and publish Softr workflows from local files, manage Softr Databases; more Softr APIs to come",
   "keywords": [
     "softr",