@soat/cli 0.15.6 → 0.15.8

package/dist/index.mjs

@@ -13,7 +13,7 @@ import { load } from "js-yaml";
 import * as os from "node:os";
 
 //#region package.json
-var version = "0.15.6";
+var version = "0.15.8";
 
 //#endregion
 //#region src/cli-wrappers/wrappers/formations.ts
@@ -1313,7 +1313,7 @@ var routes = {
   "create-api-key": {
     serviceClass: "APIKeys",
     operationId: "createApiKey",
-    description: "Creates a new API key for the authenticated user. - `project_id` is required: every key is scoped to exactly one project. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions, confined to the key's project.",
+    description: "Creates a new API key for the authenticated user. - `project_id` is optional. When set, the key is scoped to that single project. When omitted or null, the key is **unscoped** and spans every project its owner can reach. - If `policy_ids` is provided, the key's effective permissions are the intersection of the user's policies and the key's policies. - Otherwise the key inherits the user's permissions (confined to the key's project when scoped).",
     moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/api-keys",
     pathParams: [],
     queryParams: [],
@@ -1325,8 +1325,8 @@ var routes = {
       "in": "body"
     }, {
       "name": "project_id",
-      "description": "Project ID this key is scoped to. Required — keys cannot span projects.",
-      "required": true,
+      "description": "Optional project ID to scope the key to. Omit or set null to create an unscoped key that spans projects.",
+      "required": false,
       "type": "string",
       "in": "body"
     }, {
@@ -1355,7 +1355,7 @@ var routes = {
   "update-api-key": {
     serviceClass: "APIKeys",
     operationId: "updateApiKey",
-    description: "Updates an API key's name, project scope, or policies. The project scope can be changed to another project but never cleared. Only the owner or an admin can update it.",
+    description: "Updates an API key's name, project scope, or policies. The project scope can be changed to another project, set (scoping a previously unscoped key), or cleared with null (unscoping the key). Only the owner or an admin can update it.",
     moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/api-keys",
     pathParams: ["api_key_id"],
     queryParams: [],
@@ -1373,7 +1373,7 @@ var routes = {
       "in": "body"
     }, {
       "name": "project_id",
-      "description": "Re-scope the key to a different project. Cannot be null — keys are always project-scoped.",
+      "description": "Re-scope the key to a different project, or set null to clear the scope (unscoped key). Omit to leave the scope unchanged.",
       "required": false,
       "type": "string",
       "in": "body"
@@ -3005,7 +3005,7 @@ var routes = {
       "in": "body"
     }, {
       "name": "metadata",
-      "description": "",
+      "description": "Static annotations stored on the formation record. This field is NOT a substitution site: `sub`/`param`/`ref` expressions are rejected with 400 (`FORMATION_INVALID_METADATA`). For deploy-time substitution use the template's top-level `metadata` block, which is resolved into `resolved_metadata`.\n",
       "required": false,
       "type": "object",
       "in": "body"
@@ -3053,7 +3053,7 @@ var routes = {
       "in": "body"
     }, {
       "name": "metadata",
-      "description": "",
+      "description": "Static annotations stored on the formation record. This field is NOT a substitution site: `sub`/`param`/`ref` expressions are rejected with 400 (`FORMATION_INVALID_METADATA`). For deploy-time substitution use the template's top-level `metadata` block, which is resolved into `resolved_metadata`.\n",
       "required": false,
       "type": "object",
       "in": "body"
@@ -3710,7 +3710,7 @@ var routes = {
   "create-orchestration": {
     serviceClass: "Orchestrations",
     operationId: "createOrchestration",
-    description: "Creates a new orchestration workflow definition in the project.",
+    description: "Creates a new orchestration (pipeline) definition in the project.",
     moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/orchestrations",
     pathParams: [],
     queryParams: [],
@@ -4628,6 +4628,189 @@ var routes = {
       "in": "path"
     }]
   },
+  "list-tasks": {
+    serviceClass: "Tasks",
+    operationId: "listTasks",
+    description: "Lists tasks (the board query). Filter by workflow, state, status, or assignee — `GET /tasks?workflow_id=...&state=...` is one board column.",
+    moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/tasks",
+    pathParams: [],
+    queryParams: ["project_id", "workflow_id", "state", "status", "assignee"],
+    flags: [{
+      "name": "project_id",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "query"
+    }, {
+      "name": "workflow_id",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "query"
+    }, {
+      "name": "state",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "query"
+    }, {
+      "name": "status",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "query"
+    }, {
+      "name": "assignee",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "query"
+    }]
+  },
+  "create-task": {
+    serviceClass: "Tasks",
+    operationId: "createTask",
+    description: "Creates a task bound to a workflow. The task is placed in the workflow's initial state and that state's `on_enter` automation fires.",
+    moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/tasks",
+    pathParams: [],
+    queryParams: [],
+    flags: [{
+      "name": "project_id",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "body"
+    }, {
+      "name": "workflow_id",
+      "description": "",
+      "required": true,
+      "type": "string",
+      "in": "body"
+    }, {
+      "name": "title",
+      "description": "",
+      "required": true,
+      "type": "string",
+      "in": "body"
+    }, {
+      "name": "payload",
+      "description": "",
+      "required": false,
+      "type": "object",
+      "in": "body"
+    }, {
+      "name": "assignee",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "body"
+    }]
+  },
+  "get-task": {
+    serviceClass: "Tasks",
+    operationId: "getTask",
+    description: "Retrieves a task, including its active dispatch and automation status.",
+    moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/tasks",
+    pathParams: ["task_id"],
+    queryParams: [],
+    flags: [{
+      "name": "task_id",
+      "description": "",
+      "required": true,
+      "type": "string",
+      "in": "path"
+    }]
+  },
+  "update-task": {
+    serviceClass: "Tasks",
+    operationId: "updateTask",
+    description: "Updates a task's payload, title, or assignee. `state` is never directly writable — move it with a transition.",
+    moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/tasks",
+    pathParams: ["task_id"],
+    queryParams: [],
+    flags: [{
+      "name": "task_id",
+      "description": "",
+      "required": true,
+      "type": "string",
+      "in": "path"
+    }, {
+      "name": "title",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "body"
+    }, {
+      "name": "payload",
+      "description": "",
+      "required": false,
+      "type": "object",
+      "in": "body"
+    }, {
+      "name": "assignee",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "body"
+    }]
+  },
+  "delete-task": {
+    serviceClass: "Tasks",
+    operationId: "deleteTask",
+    description: "Deletes a task. Its transition history cascades.",
+    moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/tasks",
+    pathParams: ["task_id"],
+    queryParams: [],
+    flags: [{
+      "name": "task_id",
+      "description": "",
+      "required": true,
+      "type": "string",
+      "in": "path"
+    }]
+  },
+  "transition-task": {
+    serviceClass: "Tasks",
+    operationId: "transitionTask",
+    description: "Fires a named transition on a task. The transition must exist in the workflow and be valid from the task's current state; its guard must pass. This is the single path every state change routes through.",
+    moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/tasks",
+    pathParams: ["task_id"],
+    queryParams: [],
+    flags: [{
+      "name": "task_id",
+      "description": "",
+      "required": true,
+      "type": "string",
+      "in": "path"
+    }, {
+      "name": "transition",
+      "description": "",
+      "required": true,
+      "type": "string",
+      "in": "body"
+    }, {
+      "name": "note",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "body"
+    }]
+  },
+  "get-task-history": {
+    serviceClass: "Tasks",
+    operationId: "getTaskHistory",
+    description: "Returns the append-only transition history of a task.",
+    moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/tasks",
+    pathParams: ["task_id"],
+    queryParams: [],
+    flags: [{
+      "name": "task_id",
+      "description": "",
+      "required": true,
+      "type": "string",
+      "in": "path"
+    }]
+  },
   "list-tools": {
     serviceClass: "Tools",
     operationId: "listTools",
@@ -5779,6 +5962,141 @@ var routes = {
       "type": "string",
       "in": "path"
     }]
+  },
+  "list-workflows": {
+    serviceClass: "Workflows",
+    operationId: "listWorkflows",
+    description: "Lists workflow definitions in a project.",
+    moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/workflows",
+    pathParams: [],
+    queryParams: ["project_id"],
+    flags: [{
+      "name": "project_id",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "query"
+    }]
+  },
+  "create-workflow": {
+    serviceClass: "Workflows",
+    operationId: "createWorkflow",
+    description: "Creates a new workflow definition. The definition is statically validated.",
+    moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/workflows",
+    pathParams: [],
+    queryParams: [],
+    flags: [{
+      "name": "project_id",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "body"
+    }, {
+      "name": "name",
+      "description": "",
+      "required": true,
+      "type": "string",
+      "in": "body"
+    }, {
+      "name": "description",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "body"
+    }, {
+      "name": "states",
+      "description": "",
+      "required": true,
+      "type": "array",
+      "in": "body"
+    }, {
+      "name": "transitions",
+      "description": "",
+      "required": true,
+      "type": "array",
+      "in": "body"
+    }, {
+      "name": "payload_schema",
+      "description": "",
+      "required": false,
+      "type": "object",
+      "in": "body"
+    }]
+  },
+  "get-workflow": {
+    serviceClass: "Workflows",
+    operationId: "getWorkflow",
+    description: "Retrieves a workflow definition.",
+    moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/workflows",
+    pathParams: ["workflow_id"],
+    queryParams: [],
+    flags: [{
+      "name": "workflow_id",
+      "description": "",
+      "required": true,
+      "type": "string",
+      "in": "path"
+    }]
+  },
+  "update-workflow": {
+    serviceClass: "Workflows",
+    operationId: "updateWorkflow",
+    description: "Updates a workflow definition. Structural changes (states/transitions) are re-validated. Existing tasks in a removed state stay put but can only leave via transitions valid in the new definition.",
+    moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/workflows",
+    pathParams: ["workflow_id"],
+    queryParams: [],
+    flags: [{
+      "name": "workflow_id",
+      "description": "",
+      "required": true,
+      "type": "string",
+      "in": "path"
+    }, {
+      "name": "name",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "body"
+    }, {
+      "name": "description",
+      "description": "",
+      "required": false,
+      "type": "string",
+      "in": "body"
+    }, {
+      "name": "states",
+      "description": "",
+      "required": false,
+      "type": "array",
+      "in": "body"
+    }, {
+      "name": "transitions",
+      "description": "",
+      "required": false,
+      "type": "array",
+      "in": "body"
+    }, {
+      "name": "payload_schema",
+      "description": "",
+      "required": false,
+      "type": "object",
+      "in": "body"
+    }]
+  },
+  "delete-workflow": {
+    serviceClass: "Workflows",
+    operationId: "deleteWorkflow",
+    description: "Deletes a workflow. Rejected while open tasks exist.",
+    moduleDocsUrl: "https://soat.ttoss.dev/docs/modules/workflows",
+    pathParams: ["workflow_id"],
+    queryParams: [],
+    flags: [{
+      "name": "workflow_id",
+      "description": "",
+      "required": true,
+      "type": "string",
+      "in": "path"
+    }]
   }
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soat/cli",
-  "version": "0.15.6",
+  "version": "0.15.8",
   "type": "module",
   "dependencies": {
     "@inquirer/input": "^5.1.2",
@@ -8,7 +8,7 @@
     "@ttoss/logger": "^0.8.19",
     "commander": "^15.0.0",
     "js-yaml": "^5.2.1",
-    "@soat/sdk": "0.15.6"
+    "@soat/sdk": "0.15.8"
   },
   "devDependencies": {
     "@ttoss/config": "^1.37.17",