@softr/cli 0.1.1 → 0.1.2

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_PINNED_APP_ID` pins 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>] [--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` pins it to an application, so the app lists 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

@@ -14401,6 +14401,12 @@ 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}`, {});
 }
@@ -14465,6 +14471,9 @@ function authorizeUrl(target, redirectUri, state, challenge) {
   }).toString();
   return url.toString();
 }
+function refreshFailureHint(status) {
+  return status === 401 ? "The OAuth grant is gone (revoked or older than 30 days). Run: softr login" : "The studio could not renew the login right now; try again in a moment.";
+}
 async function tokenRequest(target, form) {
   const path13 = "/v1/oauth/token";
   const response = await fetch(`${target.studioApiUrl}${path13}`, {
@@ -14478,7 +14487,7 @@ async function tokenRequest(target, form) {
       `POST ${path13} failed with status ${response.status}${text ? `: ${text}` : ""}`,
       response.status,
       text,
-      form["grant_type"] === "refresh_token" ? "The OAuth grant is gone (revoked or older than 30 days). Run: softr login" : void 0
+      form["grant_type"] === "refresh_token" ? refreshFailureHint(response.status) : void 0
     );
   }
   const tokens = await response.json();
@@ -14725,7 +14734,8 @@ 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 } = {}) {
@@ -14757,16 +14767,24 @@ 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"],
+    // Only the free-text title wraps; the other columns size to their content, so trigger types are never cut off.
+    colWidths: [null, TITLE_WIDTH, null, null, null, null],
     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();
 }
@@ -16071,6 +16089,18 @@ type: ${type}${example3}  (${status})`, {
 import { stdin as stdin2, stdout } from "node:process";
 import { createInterface as createInterface2 } from "node:readline/promises";
 
+// src/project/open-workflow.ts
+async function openWorkflow(dir, missingIdHint = "Pull an existing workflow or create one with init first.") {
+  const config = await readConfig(dir);
+  if (!config.id) {
+    throw new CliError('softr-workflows.jsonc has no "id".', missingIdHint);
+  }
+  const state = await readState(dir);
+  const target = resolveTarget(state);
+  const client = await authenticatedClient(target);
+  return { config, id: config.id, state, target, client };
+}
+
 // src/project/readiness.ts
 var REASONS = {
   REFERENCED_NODE_UNKNOWN: "no node with that id",
@@ -16128,19 +16158,6 @@ async function assess(client, workflowId) {
 }
 
 // src/commands/publish.ts
-async function openWorkflow(dir) {
-  const config = await readConfig(dir);
-  if (!config.id) {
-    throw new CliError(
-      'softr-workflows.jsonc has no "id".',
-      "Pull an existing workflow or create one with init first."
-    );
-  }
-  const state = await readState(dir);
-  const target = resolveTarget(state);
-  const client = await authenticatedClient(target);
-  return { config, id: config.id, state, target, client };
-}
 function issuesOf(assessment, config) {
   return [
     ...assessment.testIssues,
@@ -16258,6 +16275,52 @@ ${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 { id, client } = await openWorkflow(
+    await findWorkflowDir(process.cwd(), opts.dir),
+    "Pass --id <workflowId>, or pull or init the workflow first."
+  );
+  return { applicationId, workflowId: id, client };
+}
+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";
 
@@ -16703,7 +16766,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",
+  version: "0.1.2",
   description: "The Softr command line: build, test and publish Softr workflows from local files; more Softr APIs to come",
   keywords: [
     "softr",
@@ -16770,6 +16833,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",
+  "version": "0.1.2",
   "description": "The Softr command line: build, test and publish Softr workflows from local files; more Softr APIs to come",
   "keywords": [
     "softr",