@trayai/tray-sync-cli 1.0.12 → 1.0.13

package/dist/api/resources/workflow.js

@@ -0,0 +1,38 @@
+export async function getWorkflow(client, workflowId) {
+    return (await client.request("GET", `/v2/workflows/${workflowId}`));
+}
+export async function setWorkflowEnabled(client, workflowId, enabled) {
+    await client.request("PUT", `/v2/workflows/${workflowId}/unversioned`, { enabled });
+}
+export async function deleteWorkflow(client, workflowId) {
+    await client.request("DELETE", `/v2/workflows/${workflowId}`);
+}
+const EDITABLE_FIELDS = new Set([
+    "name",
+    "description",
+    "tags",
+    "alerting_workflow",
+    "legacy_error_handling",
+]);
+export function assertValidWorkflowEditPayload(payload) {
+    const unknownKeys = Object.keys(payload).filter((key) => !EDITABLE_FIELDS.has(key));
+    if (unknownKeys.length > 0) {
+        throw new Error(`Unknown field(s) in edit payload: ${unknownKeys.join(", ")}. ` +
+            `Editable fields are: ${[...EDITABLE_FIELDS].join(", ")}.`);
+    }
+}
+export async function updateWorkflowUnversioned(client, workflowId, payload) {
+    const body = {};
+    if (payload.name !== undefined)
+        body.name = payload.name;
+    if (payload.description !== undefined)
+        body.description = { value: payload.description };
+    if (payload.tags !== undefined)
+        body.tags = payload.tags;
+    if (payload.alerting_workflow !== undefined)
+        body.alerting_workflow = { value: payload.alerting_workflow };
+    if (payload.legacy_error_handling !== undefined)
+        body.legacy_error_handling = payload.legacy_error_handling;
+    await client.request("PUT", `/v2/workflows/${workflowId}/unversioned`, body);
+}
+//# sourceMappingURL=workflow.js.map

package/dist/commands/api/api.js

@@ -1,5 +1,7 @@
 import { Command } from "commander";
 import { projectCommand } from "./project.js";
+import { workflowCommand } from "./workflow.js";
 export const apiCommand = new Command("api").description("Direct, authenticated access to the Tray API");
 apiCommand.addCommand(projectCommand);
+apiCommand.addCommand(workflowCommand);
 //# sourceMappingURL=api.js.map

package/dist/commands/api/workflow.js

@@ -0,0 +1,166 @@
+import { Command, InvalidArgumentError } from "commander";
+import ansis from "ansis";
+import { assertValidWorkflowEditPayload, deleteWorkflow, getWorkflow, setWorkflowEnabled, updateWorkflowUnversioned, } from "../../api/resources/workflow.js";
+import { isUuid } from "../../lib/uuid.js";
+import { OutputFormats } from "../../lib/outputFormat.js";
+import { printWorkflowDeletedResult, printWorkflowEditedResult, printWorkflowEnabledResult, printWorkflowShowResult, } from "../../views/api/workflow.v2.js";
+import { printConfirmationJson } from "../../views/api/shared.js";
+import { FAILURE_ICON } from "../../views/icons.js";
+import { COMMAND_COLOR } from "../../views/help.js";
+import { addCommonApiOptions, apiClientFor, realDeps, runApiAction, } from "./shared.js";
+async function runWorkflowSetEnabled(deps, options, enabled) {
+    const client = apiClientFor(deps, options);
+    await setWorkflowEnabled(client, options.workflowId, enabled);
+    if (options.format === OutputFormats.JSON) {
+        printConfirmationJson(deps.stdout, { workflowId: options.workflowId, enabled });
+    }
+    else {
+        printWorkflowEnabledResult(deps.stdout, options.workflowId, enabled);
+    }
+    return 0;
+}
+export async function runWorkflowEnable(deps, options) {
+    return runWorkflowSetEnabled(deps, options, true);
+}
+export async function runWorkflowDisable(deps, options) {
+    return runWorkflowSetEnabled(deps, options, false);
+}
+export async function runWorkflowShow(deps, options) {
+    const client = apiClientFor(deps, options);
+    const workflow = await getWorkflow(client, options.workflowId);
+    if (options.format === OutputFormats.JSON) {
+        deps.stdout(JSON.stringify(workflow, null, 2));
+    }
+    else {
+        printWorkflowShowResult(deps.stdout, options.workflowId, workflow);
+    }
+    return 0;
+}
+export async function runWorkflowDelete(deps, options) {
+    const client = apiClientFor(deps, options);
+    await deleteWorkflow(client, options.workflowId);
+    if (options.format === OutputFormats.JSON) {
+        printConfirmationJson(deps.stdout, { workflowId: options.workflowId, deleted: true });
+    }
+    else {
+        printWorkflowDeletedResult(deps.stdout, options.workflowId);
+    }
+    return 0;
+}
+export async function runWorkflowEdit(deps, options) {
+    if (Object.keys(options.payload).length === 0) {
+        deps.stderr(`${FAILURE_ICON} Nothing to edit — payload has no fields.`);
+        return 1;
+    }
+    const client = apiClientFor(deps, options);
+    await updateWorkflowUnversioned(client, options.workflowId, options.payload);
+    if (options.format === OutputFormats.JSON) {
+        printConfirmationJson(deps.stdout, { workflowId: options.workflowId, edited: true });
+    }
+    else {
+        printWorkflowEditedResult(deps.stdout, options.workflowId);
+    }
+    return 0;
+}
+function parseWorkflowId(value) {
+    if (!isUuid(value)) {
+        throw new InvalidArgumentError("workflow id must be a UUID");
+    }
+    return value;
+}
+function parseEditPayload(value) {
+    let parsed;
+    try {
+        parsed = JSON.parse(value);
+    }
+    catch (err) {
+        throw new InvalidArgumentError(`payload is not valid JSON: ${err.message}`);
+    }
+    if (typeof parsed !== "object" || parsed === null || Array.isArray(parsed)) {
+        throw new InvalidArgumentError("payload must be a JSON object");
+    }
+    const record = parsed;
+    try {
+        assertValidWorkflowEditPayload(record);
+    }
+    catch (err) {
+        throw new InvalidArgumentError(err.message);
+    }
+    return record;
+}
+export const workflowCommand = new Command("workflow").description("Manage workflows");
+addCommonApiOptions(workflowCommand
+    .command("enable")
+    .description("Enable a workflow")
+    .argument("<workflow-id>", "Tray workflow UUID", parseWorkflowId)).action(async (workflowId, opts) => {
+    const deps = realDeps();
+    await runApiAction(deps, () => runWorkflowEnable(deps, {
+        workflowId,
+        region: opts.region,
+        token: opts.token,
+        format: opts.format,
+    }));
+});
+addCommonApiOptions(workflowCommand
+    .command("disable")
+    .description("Disable a workflow")
+    .argument("<workflow-id>", "Tray workflow UUID", parseWorkflowId)).action(async (workflowId, opts) => {
+    const deps = realDeps();
+    await runApiAction(deps, () => runWorkflowDisable(deps, {
+        workflowId,
+        region: opts.region,
+        token: opts.token,
+        format: opts.format,
+    }));
+});
+addCommonApiOptions(workflowCommand
+    .command("show")
+    .description("Show a workflow")
+    .argument("<workflow-id>", "Tray workflow UUID", parseWorkflowId)).action(async (workflowId, opts) => {
+    const deps = realDeps();
+    await runApiAction(deps, () => runWorkflowShow(deps, {
+        workflowId,
+        region: opts.region,
+        token: opts.token,
+        format: opts.format,
+    }));
+});
+addCommonApiOptions(workflowCommand
+    .command("delete")
+    .description("Delete a workflow")
+    .argument("<workflow-id>", "Tray workflow UUID", parseWorkflowId)).action(async (workflowId, opts) => {
+    const deps = realDeps();
+    await runApiAction(deps, () => runWorkflowDelete(deps, {
+        workflowId,
+        region: opts.region,
+        token: opts.token,
+        format: opts.format,
+    }));
+});
+const teal = ansis.hex(COMMAND_COLOR);
+const EDIT_PAYLOAD_EXAMPLE = `${ansis.bold("Example:")}
+  $ ${teal(`tray api workflow edit <workflow-id> '{"name": "New name", "tags": ["prod", "reviewed"]}'`)}
+
+  Editable fields (all optional, only the ones you include are changed):
+    ${teal("name")}                    string
+    ${teal("description")}             string, or null to clear
+    ${teal("tags")}                    string[] — replaces the FULL tag list, does not add/remove single tags
+    ${teal("alerting_workflow")}       string (a workflow id), or null to clear
+    ${teal("legacy_error_handling")}   boolean
+`;
+addCommonApiOptions(workflowCommand
+    .command("edit")
+    .description("Edit a workflow's name, description, tags, alerting workflow, or legacy error handling")
+    .argument("<workflow-id>", "Tray workflow UUID", parseWorkflowId)
+    .argument("<payload>", "JSON object of fields to change", parseEditPayload)
+    .addHelpText("after", `\n${EDIT_PAYLOAD_EXAMPLE}`)).action(async (workflowId, payload, opts) => {
+    const deps = realDeps();
+    await runApiAction(deps, () => runWorkflowEdit(deps, {
+        workflowId,
+        payload,
+        region: opts.region,
+        token: opts.token,
+        format: opts.format,
+    }));
+});
+//# sourceMappingURL=workflow.js.map

package/dist/views/api/workflow.v2.js

@@ -0,0 +1,21 @@
+import ansis from "ansis";
+export function printWorkflowEnabledResult(stdout, workflowId, enabled) {
+    const verb = enabled ? "Enabled" : "Disabled";
+    stdout(`${ansis.bold(verb)} workflow ${ansis.bold(workflowId)}.`);
+}
+export function printWorkflowShowResult(stdout, workflowId, workflow) {
+    const data = workflow.unversioned_data;
+    stdout(`${ansis.bold(data.name)} (${workflowId})`);
+    stdout(`  Enabled: ${data.enabled ? "yes" : "no"}`);
+    if (data.description)
+        stdout(`  Description: ${data.description}`);
+    if (data.tags.length > 0)
+        stdout(`  Tags: ${data.tags.join(", ")}`);
+}
+export function printWorkflowDeletedResult(stdout, workflowId) {
+    stdout(`${ansis.bold("Deleted")} workflow ${ansis.bold(workflowId)}.`);
+}
+export function printWorkflowEditedResult(stdout, workflowId) {
+    stdout(`${ansis.bold("Edited")} workflow ${ansis.bold(workflowId)}.`);
+}
+//# sourceMappingURL=workflow.v2.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayai/tray-sync-cli",
-  "version": "1.0.12",
+  "version": "1.0.13",
   "description": "CLI tool to clone Tray projects and related assets to a local directory, and promote them between Tray environments",
   "bin": {
     "tray": "dist/cli.js"