@softr/cli 0.1.1-se21216.9 → 0.1.2-se21873.13

package/README.md

@@ -49,7 +49,7 @@ ones. A workflow directory remembers the target it was pulled from.
 | `workspaces`                                                     | The workspaces the stored token reaches, with your role in each and the default one. Commands that take `--workspace` default to `SOFTR_WORKSPACE_ID` when it is set, else to your only or default workspace.                                                      |
 | `integrations [--workspace <id>] [--type <TYPE>]`                | List the workspace's connected integrations (id, name, type, account, auth kind) from the studio API; the id goes into a node's `integrationId` input. Inside a workflow directory the workspace is the workflow's; `--type` filters. Credentials are never shown. |
 
-Every command accepts `--json`. `SOFTR_TOKEN` overrides the stored token; `SOFTR_WORKSPACE_ID` is the default workspace; `SOFTR_APP_ID` links the workflows `init` creates to that application.
+Every command accepts `--json`. `SOFTR_TOKEN` overrides the stored token; `SOFTR_WORKSPACE_ID` is the default workspace.
 
 ## Workflows
 
@@ -133,10 +133,11 @@ node still on 1.0.0 or 1.1.0 keeps its synchronous runtime without `fetch`, and
 
 | Command                                                                                                                                | What it does                                                                                                                                                                                                                                                                                                                                                                                                          |
 | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `workflows list [--workspace <id>] [--app <id>]`                                                                                       | List the workflows you can access, one table per workspace; `--app` keeps only those linked to that application. A workspace whose listing fails is reported at the end and skipped.                                                                                                                                                                                                                                  |
+| `workflows list [--workspace <id>] [--app <id>]`                                                                                       | List the workflows you can access, one table per workspace, with their trigger types; `--json` gives each trigger's id too (`triggers`), the `triggerId` app code fires a workflow by. `--app` keeps only those pinned to that application. A workspace whose listing fails is reported at the end and skipped.                                                                                                       |
 | `workflows pull [<workflowId>] [--dir <path>] [--force]`                                                                               | Download a workflow into a directory (new `./<title-slug>/` by default). Without an id, list what you can pull.                                                                                                                                                                                                                                                                                                       |
 | `workflows push [--dir <path>] [--dry-run] [--force]`                                                                                  | Inline `@@` references and code files, save as a new draft. Sends nothing when the files match the last sync, and refuses when the server copy changed since then (`--force` overrides both). Warns about placeholders that no saved test data backs.                                                                                                                                                                 |
-| `workflows init <title> [--workspace <id>] [--app <id>] [--trigger <TYPE>] [--dir <path>]`                                             | Create a workflow on the server with one trigger (default `WEBHOOK`) and the local directory for it; `--app` links it to an application: the app lists it, and the app's members may view it.                                                                                                                                                                                                                         |
+| `workflows init <title> [--workspace <id>] [--pin-to-app <id>] [--trigger <TYPE>] [--dir <path>]`                                      | Create a workflow on the server with one trigger (default `WEBHOOK`) and the local directory for it; `--pin-to-app` (default `SOFTR_PINNED_APP_ID`) pins it to an application of the same workspace, so the app lists it.                                                                                                                                                                                             |
+| `workflows pin [--app <id>] [--id <workflowId>] [--dir <path>]` / `unpin`                                                              | Pin an existing workflow to an application of its workspace, or remove it from the app. The app defaults to `SOFTR_PINNED_APP_ID`, the workflow to the one in the directory.                                                                                                                                                                                                                                          |
 | `workflows upgrade [<nodeId>...] [--dir <path>]`                                                                                       | Move nodes on an older version of their type to the current one (CUSTOM_CODE 1.0.0 and 1.1.0 become 1.2.0: the integrations list is added, the code file keeps its body and gets the new header). Every command that touches a workflow lists such nodes in a note.                                                                                                                                                   |
 | `workflows add <TYPE> [--id <id>] [--after <nodeId>] [--in-loop <loopId>] [--to <actionId>] [--lang JAVASCRIPT\|PYTHON] [--title <t>]` | Append an action after a node (default: the only node without a successor) and the path to it, or append a trigger (`--to` connects it). Custom code gets `actions/<id>.js\|py` with an empty function. Comments in the config survive.                                                                                                                                                                               |
 | `workflows replace <nodeId> <TYPE>`                                                                                                    | Give a node another type of the same kind: id, title and paths stay, inputs start from the new template.                                                                                                                                                                                                                                                                                                              |

package/dist/cli.mjs

@@ -14397,10 +14397,16 @@ function updateWorkflow(client, workflowId, body) {
 function getWorkflowOutputs(client, workflowId) {
   return apiRequest(client, "GET", `/v1/workflows/${workflowId}/outputs`);
 }
-function listWorkflows(client, workspaceId, applicationId) {
+function listWorkflows(client, workspaceId, { applicationId } = {}) {
   const query = new URLSearchParams({ workspaceId, ...applicationId ? { applicationId } : {}, limit: "500" });
   return apiRequest(client, "GET", `/v1/workflows?${query}`);
 }
+function pinWorkflow(client, workflowId, applicationId) {
+  return apiRequestVoid(client, "POST", `/v1/workflows/${workflowId}/pinned-applications/${applicationId}`);
+}
+function unpinWorkflow(client, workflowId, applicationId) {
+  return apiRequestVoid(client, "DELETE", `/v1/workflows/${workflowId}/pinned-applications/${applicationId}`);
+}
 function testAction(client, workflowId, hierarchyPath2, mode) {
   return apiRequest(client, "POST", `/v1/workflows/${workflowId}/outputs/${mode}/actions/${hierarchyPath2}`, {});
 }
@@ -14549,6 +14555,9 @@ function tokenKind(token) {
 var TOKEN_ENV_VAR = "SOFTR_TOKEN";
 var AUTH_ENV_VAR = "SOFTR_AUTH";
 var PROXY_AUTH = "proxy";
+function isProxyAuth() {
+  return process.env[AUTH_ENV_VAR] === PROXY_AUTH;
+}
 var REFRESH_MARGIN_MS = 5 * 60 * 1e3;
 function credentialsPath() {
   return path6.join(homedir(), ".softr", "credentials.json");
@@ -14613,7 +14622,7 @@ async function refreshedAccessToken(target, stored) {
   }
 }
 async function authenticatedClient(target) {
-  if (process.env[AUTH_ENV_VAR] === PROXY_AUTH) {
+  if (isProxyAuth()) {
     return { target, kind: "proxy" };
   }
   const fromEnv = process.env[TOKEN_ENV_VAR];
@@ -14722,10 +14731,11 @@ function toRow(workflow, workspace) {
     live: workflow.enabledVersion ?? null,
     version: workflow.version,
     draft: workflow.draft,
-    updatedAt: workflow.updatedAt ?? null
+    updatedAt: workflow.updatedAt ?? null,
+    triggers: (workflow.triggerSummaries ?? []).map(({ id, type }) => ({ id, type }))
   };
 }
-async function collectWorkflows(client, workspaceId, applicationId) {
+async function collectWorkflows(client, { workspaceId, applicationId } = {}) {
   const workspaces = await listWorkspaces(client);
   const selected = workspaceId ? workspaces.filter((workspace) => workspace.id === workspaceId) : workspaces;
   if (workspaceId && !selected.length) {
@@ -14737,7 +14747,7 @@ async function collectWorkflows(client, workspaceId, applicationId) {
   const listing = { workspaces: [], workflows: [], failures: [] };
   for (const workspace of selected) {
     try {
-      const page = await listWorkflows(client, workspace.id, applicationId);
+      const page = await listWorkflows(client, workspace.id, { applicationId });
       listing.workspaces.push({ id: workspace.id, name: workspace.name });
       listing.workflows.push(...page.items.map((workflow) => toRow(workflow, workspace)));
     } catch (error) {
@@ -14754,16 +14764,23 @@ async function collectWorkflows(client, workspaceId, applicationId) {
   }
   return listing;
 }
-var TITLE_WIDTH = 42;
+var TITLE_WIDTH = 34;
 function workflowTable(rows) {
   const table = new import_cli_table3.default({
-    head: ["ID", "Title", "Status", "Version", "Draft"],
-    colWidths: [38, TITLE_WIDTH, 14, 9, 7],
+    head: ["ID", "Title", "Triggers", "Status", "Version", "Draft"],
+    colWidths: [38, TITLE_WIDTH, 30, 14, 9, 7],
     wordWrap: true,
     style: { head: [], border: [], "padding-left": 1, "padding-right": 1 }
   });
   for (const row of rows) {
-    table.push([row.id, row.title, row.live === null ? "not enabled" : `live v${row.live}`, row.version, row.draft]);
+    table.push([
+      row.id,
+      row.title,
+      row.triggers.map((trigger) => trigger.type).join("\n"),
+      row.live === null ? "not enabled" : `live v${row.live}`,
+      row.version,
+      row.draft
+    ]);
   }
   return table.toString();
 }
@@ -14788,8 +14805,8 @@ ${workflowTable(rows)}` : `${heading}
   }
   return blocks.join("\n\n");
 }
-async function emitWorkflowList(options, client, workspaceId, human, applicationId) {
-  const listing = await collectWorkflows(client, workspaceId, applicationId);
+async function emitWorkflowList(options, client, { workspaceId, applicationId, human } = {}) {
+  const listing = await collectWorkflows(client, { workspaceId, applicationId });
   emit(options, [human, renderWorkflows(listing)].filter(Boolean).join("\n\n"), { ...listing });
 }
 function registerList(program3) {
@@ -14797,7 +14814,10 @@ function registerList(program3) {
     const options = globalOptions(command);
     const target = resolveTarget(await readState(process.cwd()));
     const client = await authenticatedClient(target);
-    await emitWorkflowList(options, client, opts.workspace ?? process.env["SOFTR_WORKSPACE_ID"], void 0, opts.app);
+    await emitWorkflowList(options, client, {
+      workspaceId: opts.workspace ?? process.env["SOFTR_WORKSPACE_ID"],
+      applicationId: opts.app
+    });
   });
 }
 
@@ -15060,12 +15080,9 @@ function registerPull(program3) {
     const target = resolveTarget(remembered);
     const client = await authenticatedClient(target);
     if (!workflowId) {
-      await emitWorkflowList(
-        options,
-        client,
-        void 0,
-        "Pick a workflow and run: softr workflows pull <workflowId>"
-      );
+      await emitWorkflowList(options, client, {
+        human: "Pick a workflow and run: softr workflows pull <workflowId>"
+      });
       return;
     }
     const workflow = await getWorkflow(client, workflowId);
@@ -15268,7 +15285,7 @@ function registerInit(program3) {
   program3.command("init").description("Create a new workflow with one trigger, on the server and as a local directory").argument("<title>", "the workflow title").option(
     "--workspace <id>",
     "workspace to create it in (default: $SOFTR_WORKSPACE_ID, else your only or default workspace)"
-  ).option("--app <id>", "application to link the workflow to (default: $SOFTR_APP_ID when set)").option("--trigger <TYPE>", 'trigger type from "spec" (default WEBHOOK)', "WEBHOOK").option("--dir <path>", "directory to create (default: ./<title-slug>)").action(
+  ).option("--pin-to-app <id>", "application to pin the workflow to (default: $SOFTR_PINNED_APP_ID when set)").option("--trigger <TYPE>", 'trigger type from "spec" (default WEBHOOK)', "WEBHOOK").option("--dir <path>", "directory to create (default: ./<title-slug>)").action(
     async (title, opts, command) => {
       const options = globalOptions(command);
       const cwd = process.cwd();
@@ -15280,12 +15297,11 @@ function registerInit(program3) {
       const target = resolveTarget();
       const client = await authenticatedClient(target);
       const workspaceId = await resolveWorkspace(client, opts.workspace ?? process.env["SOFTR_WORKSPACE_ID"]);
-      const applicationId = opts.app ?? process.env["SOFTR_APP_ID"] ?? null;
+      const pinToApplicationId = opts.pinToApp ?? process.env["SOFTR_PINNED_APP_ID"];
       const created = await createWorkflow(client, {
         workspaceId,
-        // Both halves of a link: the workflow belongs to the app (its members may view it), and the app lists it.
-        applicationId,
-        ...applicationId ? { pinToApplicationId: applicationId } : {},
+        applicationId: null,
+        ...pinToApplicationId ? { pinToApplicationId } : {},
         title,
         thumbnail: null,
         triggers: [{ id: TRIGGER_ID, type: trigger.type, version: trigger.version, inputs: trigger.template }],
@@ -15309,14 +15325,14 @@ function registerInit(program3) {
       const studioUrl = `${target.studioUrl}/workflow/${created.id}`;
       emit(
         options,
-        `Created "${title}" (${created.id}) with a ${trigger.type} trigger "${TRIGGER_ID}" in workspace ${workspaceId}${applicationId ? `, linked to application ${applicationId}` : ""}.
+        `Created "${title}" (${created.id}) with a ${trigger.type} trigger "${TRIGGER_ID}" in workspace ${workspaceId}${pinToApplicationId ? `, linked to application ${pinToApplicationId}` : ""}.
   ${path10.relative(cwd, configFile)}
 ${studioUrl}
 Next: softr workflows add <TYPE> --dir ${path10.relative(cwd, dir) || "."} (see "spec" for the types), then push and test.`,
         {
           workflowId: created.id,
           workspaceId,
-          applicationId,
+          pinnedToApplicationId: pinToApplicationId ?? null,
           title,
           triggerId: TRIGGER_ID,
           triggerType: trigger.type,
@@ -15553,7 +15569,7 @@ function registerLogin(program3) {
   ).option("--no-browser", "browser login, but print the URL instead of opening it (for remote shells and agents)").action(async (opts, command) => {
     const options = globalOptions(command);
     const target = resolveTarget();
-    if (process.env[AUTH_ENV_VAR] === "proxy") {
+    if (isProxyAuth()) {
       throw new CliError(
         `Login is not needed: the target authenticates the requests itself ($${AUTH_ENV_VAR}=proxy).`
       );
@@ -15566,6 +15582,11 @@ function registerLogin(program3) {
   program3.command("logout").description("Forget the stored token of the current target").action(async (_opts, command) => {
     const options = globalOptions(command);
     const target = resolveTarget();
+    if (isProxyAuth()) {
+      throw new CliError(
+        `Nothing to log out from: the target authenticates the requests itself ($${AUTH_ENV_VAR}=proxy).`
+      );
+    }
     const removed = await forgetToken(target);
     emit(
       options,
@@ -16251,6 +16272,57 @@ ${renderIssues(issues)}` : "every node tested on current data"}`
   });
 }
 
+// src/commands/pin.ts
+async function pinTarget(opts) {
+  const applicationId = opts.app ?? process.env["SOFTR_PINNED_APP_ID"];
+  if (!applicationId) {
+    throw new CliError("No application given.", "Pass --app <applicationId> or set SOFTR_PINNED_APP_ID.");
+  }
+  if (opts.id && opts.dir) {
+    throw new CliError("Pass either --id or --dir, not both.");
+  }
+  if (opts.id) {
+    return { applicationId, workflowId: opts.id, client: await authenticatedClient(resolveTarget()) };
+  }
+  const dir = await findWorkflowDir(process.cwd(), opts.dir);
+  const config = await readConfig(dir);
+  if (!config.id) {
+    throw new CliError(
+      'softr-workflows.jsonc has no "id".',
+      "Pass --id <workflowId>, or pull or init the workflow first."
+    );
+  }
+  const target = resolveTarget(await readState(dir));
+  return { applicationId, workflowId: config.id, client: await authenticatedClient(target) };
+}
+function withPinOptions(command) {
+  return command.option("--app <applicationId>", "the application (default: $SOFTR_PINNED_APP_ID)").option("--id <workflowId>", "the workflow (default: the one in the workflow directory)").option("--dir <path>", "workflow directory (default: the current directory)");
+}
+function registerPin(program3) {
+  withPinOptions(
+    program3.command("pin").description("Pin the workflow to an application of its workspace; it then lists under that app")
+  ).action(async (opts, command) => {
+    const { applicationId, workflowId, client } = await pinTarget(opts);
+    await pinWorkflow(client, workflowId, applicationId);
+    emit(globalOptions(command), `Pinned workflow ${workflowId} to application ${applicationId}.`, {
+      workflowId,
+      applicationId,
+      pinned: true
+    });
+  });
+  withPinOptions(program3.command("unpin").description("Remove the workflow from an application")).action(
+    async (opts, command) => {
+      const { applicationId, workflowId, client } = await pinTarget(opts);
+      await unpinWorkflow(client, workflowId, applicationId);
+      emit(globalOptions(command), `Unpinned workflow ${workflowId} from application ${applicationId}.`, {
+        workflowId,
+        applicationId,
+        pinned: false
+      });
+    }
+  );
+}
+
 // src/commands/push.ts
 import path12 from "node:path";
 
@@ -16696,7 +16768,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.1-se21216.9",
+  version: "0.1.2-se21873.13",
   description: "The Softr command line: build, test and publish Softr workflows from local files; more Softr APIs to come",
   keywords: [
     "softr",
@@ -16763,6 +16835,7 @@ registerAdd(workflows);
 registerEdit(workflows);
 registerUpgrade(workflows);
 registerPublish(workflows);
+registerPin(workflows);
 registerSpec(workflows);
 registerSchema(workflows);
 program2.parseAsync(process.argv).catch(reportError);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softr/cli",
-  "version": "0.1.1-se21216.9",
+  "version": "0.1.2-se21873.13",
   "description": "The Softr command line: build, test and publish Softr workflows from local files; more Softr APIs to come",
   "keywords": [
     "softr",