@tenonhq/dovetail-servicenow 0.0.8 → 0.0.10

package/README.md

@@ -162,6 +162,9 @@ npx dove-sn view-flow --sys-id <sys_id> --json --raw   # structured + full model
 # View a Custom Action Type's model (inputs/outputs)
 npx dove-sn view-action --sys-id <action_type_sys_id> --scope <scope_sys_id>
 
+# Copy a flow / subflow (creates an INACTIVE DRAFT) via the Designer's Copy endpoint
+npx dove-sn copy-flow --sys-id <sys_id> --name "My Copy"   # scope defaults to source's
+
 # Publish (compile the snapshot of) a flow / subflow after editing in the Designer
 npx dove-sn publish-flow --sys-id <sys_id>             # scope defaults to the flow's
 
@@ -169,17 +172,27 @@ npx dove-sn publish-flow --sys-id <sys_id>             # scope defaults to the f
 npx dove-sn test-flow --sys-id <sys_id> --inputs '{"phone":"+1555..."}'
 npx dove-sn test-flow --sys-id <sys_id> --execute --confirm --inputs '{...}'  # runs it
 
-# Edit a flow in place (rename / description / step inputs), then publish
+# Edit a flow in place (rename / description / step inputs)
 echo '{"rename":{"name":"New Name"},"patchStepInputs":[{"step":"Calculate SMS Send At","input":"send_rate","value":"5"}]}' > ops.json
-npx dove-sn edit-flow --sys-id <sys_id> --from-json ops.json            # dry-run (diff)
-npx dove-sn edit-flow --sys-id <sys_id> --from-json ops.json --apply    # publish the edit
+npx dove-sn edit-flow --sys-id <sys_id> --from-json ops.json                          # dry-run (diff)
+npx dove-sn edit-flow --sys-id <sys_id> --from-json ops.json --apply --update-set <id> # persist
 ```
 
+`copy-flow` calls the Designer's own `POST /processflow/flow/{id}/copy` — a
+complete, faithful clone created as an **inactive draft**. (Don't publish +
+activate a copy of a triggered production flow unless you intend it to fire.)
 `test-flow` defaults to **validate** — a safe pre-flight (published? inputs match
-declared variables?) that never runs the flow. `--execute --confirm` runs it via
-the server-side FlowAPI runner (deploy `resources/runFlow.md` first); running a
-flow can cause real side effects. `edit-flow` defaults to a **dry-run** diff;
-`--apply` re-publishes the patched model via the snapshot endpoint.
+declared variables?) that never runs the flow; `--execute --confirm` runs it via
+the server-side FlowAPI runner (deploy `resources/runFlow.md` first).
+
+`edit-flow` defaults to a **dry-run** diff. With `--apply`: rename/description are
+written to `sys_hub_flow` through the update-set-aware API (so `--update-set` is
+**required** for those), while `patchStepInputs` ride a snapshot recompile (the
+`/snapshot` POST persists step input values but NOT top-level flow fields).
+Step-input persistence via the snapshot POST is verified for action types but is
+**best-effort for flows** — after the recompile, `edit-flow` reads the model back
+and **warns** if a value didn't actually persist, so a no-op never reports as a
+silent success.
 
 `view-flow` reads `GET /api/now/processflow/flow/{id}` — the Designer's own model
 endpoint — and prints the ordered, nesting-aware action + flow-logic step graph
@@ -229,9 +242,10 @@ console.log(formatLayoutResult("form layout", result));
 Claude Code and agents: `create_view`, `set_list_layout`, `set_form_layout`,
 `set_related_lists`, `add_choices_to_field`, plus the Flow Designer tools
 `flow_view` (read a flow/subflow's step graph), `action_view` (read an action
-type's model), `flow_publish` (compile a flow/subflow snapshot), `flow_test`
-(validate or run a flow), and `flow_edit` (patch a flow + publish). It reads
-ServiceNow credentials from the same env vars as the CLI.
+type's model), `flow_publish` (compile a flow/subflow snapshot), `flow_copy`
+(copy a flow as an inactive draft), `flow_test` (validate or run a flow), and
+`flow_edit` (patch a flow). It reads ServiceNow credentials from the same env
+vars as the CLI.
 
 ```bash
 npx dove-sn mcp --smoke   # list the registered tools and exit

package/dist/cli.js

@@ -71,6 +71,7 @@ const flowDesigner_formatter_1 = require("./flowDesigner-formatter");
 const readFlow_1 = require("./flowDesigner/readFlow");
 const readActionType_1 = require("./flowDesigner/readActionType");
 const publishFlow_1 = require("./flowDesigner/publishFlow");
+const copyFlow_1 = require("./flowDesigner/copyFlow");
 const editFlow_1 = require("./flowDesigner/editFlow");
 const testFlow_1 = require("./flowDesigner/testFlow");
 const flowDesigner_formatter_2 = require("./flowDesigner-formatter");
@@ -390,6 +391,38 @@ async function runPublishFlow(flags) {
         + (result.snapshotSysId ? " — snapshot " + result.snapshotSysId : "") + "\n");
     return 0;
 }
+/**
+ * dove-sn copy-flow:
+ *   --sys-id <sys_id>   Required. Source sys_hub_flow sys_id (flow or subflow).
+ *   --name <name>       Required. Name for the copy.
+ *   --scope <sys_id>    Optional. Target scope (defaults to the source's scope).
+ *   --json              Optional. Emit the structured CopyFlowResult.
+ *
+ * Copies the flow via the Designer's own Copy endpoint — a complete, faithful
+ * clone created as an INACTIVE DRAFT. Publish it with publish-flow when ready.
+ * (Do NOT publish + activate a copy of a triggered production flow unless you
+ * intend it to fire.)
+ */
+async function runCopyFlow(flags) {
+    var sysId = flags["sys-id"] || flags.sysId;
+    var name = flags.name;
+    if (!sysId || !name) {
+        process.stderr.write("copy-flow: --sys-id <sys_id> and --name <name> are required\n");
+        return 1;
+    }
+    var params = { client: (0, client_1.createClient)({}), sourceSysId: sysId, newName: name };
+    if (flags.scope || flags.scopeSysId) {
+        params.scopeSysId = flags.scope || flags.scopeSysId;
+    }
+    var result = await (0, copyFlow_1.copyFlow)(params);
+    if (flags.json === "true") {
+        process.stdout.write(JSON.stringify(result, null, 2) + "\n");
+        return 0;
+    }
+    process.stdout.write("Copied to '" + result.name + "' (sys_id " + result.sysId + ", scope " + result.scopeSysId
+        + ") — inactive draft. Publish with: dove-sn publish-flow --sys-id " + result.sysId + "\n");
+    return 0;
+}
 /**
  * dove-sn test-flow:
  *   --sys-id <sys_id>   Required. sys_hub_flow sys_id (flow or subflow).
@@ -440,12 +473,14 @@ async function runTestFlow(flags) {
  * dove-sn edit-flow:
  *   --sys-id <sys_id>     Required. sys_hub_flow sys_id (flow or subflow).
  *   --from-json <path>    Required. JSON EditFlowOps { rename?, description?, patchStepInputs? }.
- *   --apply               Optional. Publish the edit (default is a dry-run diff).
+ *   --apply               Optional. Persist the edit (default is a dry-run diff).
  *   --scope <sys_id>      Optional. sysparm_transaction_scope for the publish.
+ *   --update-set <sys_id> Required with --apply when ops include rename/description.
  *   --json                Optional. Emit the structured EditFlowResult.
  *
- * Reads the model, applies the declarative edits, and (with --apply) re-publishes
- * via the snapshot endpoint. Without --apply it prints the would-be changes.
+ * Reads the model, applies the declarative edits, and (with --apply) persists them:
+ * rename/description via the update-set-aware record write, step inputs via a
+ * snapshot recompile. Without --apply it prints the would-be changes.
  */
 async function runEditFlow(flags) {
     var sysId = flags["sys-id"] || flags.sysId;
@@ -467,6 +502,9 @@ async function runEditFlow(flags) {
     if (flags.scope || flags.scopeSysId) {
         params.scopeSysId = flags.scope || flags.scopeSysId;
     }
+    if (flags["update-set"] || flags.updateSetSysId) {
+        params.updateSetSysId = flags["update-set"] || flags.updateSetSysId;
+    }
     var result = await (0, editFlow_1.editFlow)(params);
     if (flags.json === "true") {
         process.stdout.write(JSON.stringify(result, null, 2) + "\n");
@@ -513,10 +551,12 @@ function printHelp() {
         "                     (--sys-id <sys_id> --scope <sys_id> [--json] [--raw])\n" +
         "  publish-flow       Compile a flow/subflow snapshot (write)\n" +
         "                     (--sys-id <sys_id> [--scope <sys_id>] [--json])\n" +
+        "  copy-flow          Copy a flow/subflow (inactive draft) via the Designer Copy API\n" +
+        "                     (--sys-id <sys_id> --name <name> [--scope <sys_id>] [--json])\n" +
         "  test-flow          Validate (default) or run a flow/subflow\n" +
         "                     (--sys-id <sys_id> [--execute --confirm] [--inputs <json>] [--json])\n" +
-        "  edit-flow          Patch a flow/subflow (rename, description, step inputs) + publish\n" +
-        "                     (--sys-id <sys_id> --from-json <ops.json> [--apply] [--scope <sys_id>] [--json])\n" +
+        "  edit-flow          Patch a flow/subflow (rename, description, step inputs)\n" +
+        "                     (--sys-id <sys_id> --from-json <ops.json> [--apply] [--update-set <sys_id>] [--scope <sys_id>] [--json])\n" +
         "  mcp                Run the MCP stdio server (--smoke lists tools and exits)\n");
 }
 async function main() {
@@ -537,6 +577,9 @@ async function main() {
     if (parsed.command === "publish-flow") {
         return await runPublishFlow(parsed.flags);
     }
+    if (parsed.command === "copy-flow") {
+        return await runCopyFlow(parsed.flags);
+    }
     if (parsed.command === "test-flow") {
         return await runTestFlow(parsed.flags);
     }

package/dist/client.d.ts

@@ -6,15 +6,15 @@
  *   - `buildAgent.*`  — reads via the sn_build_agent API, with graceful
  *                       fallback to Table API / sys_dictionary when the
  *                       Build Agent plugin is unavailable
- *   - `claude.*`      — writes via the Dovetail Scripted REST API
- *                       (/api/cadso/dovetail/*), which handles update-set + scope
- *                       switching atomically so every write lands in the right
- *                       update set without touching sys_user_preference.
- *                       Falls back to the legacy /api/cadso/claude/* path on
- *                       instances where the API has not yet been re-imported.
- *                       The namespace name `claude` is preserved for API
- *                       compatibility; the underlying server-side API is now
- *                       named "Dovetail".
+ *   - `claude.*`      — writes via the Dovetail core Scripted REST API
+ *                       (/api/cadso/dovetail_core/*), which handles update-set +
+ *                       scope switching atomically so every write lands in the
+ *                       right update set without touching sys_user_preference.
+ *                       Falls back to the legacy global-scope /api/cadso/dovetail/*
+ *                       path on instances without the Dovetail app installed.
+ *                       The `claude.*` property name is preserved for API
+ *                       compatibility; the server-side API now lives in the
+ *                       Dovetail scoped application as "Dovetail Core".
  *
  * Env fallbacks mirror prior dashboard-fetch helpers so dev setups that already
  * have SN_INSTANCE/SN_USER/SN_PASSWORD work without reconfiguration.
@@ -62,7 +62,7 @@ export interface ServiceNowClient {
         getTableSchema: (table: string) => Promise<TableSchema>;
     };
     claude: {
-        /** POST /api/cadso/dovetail/createRecord (legacy path: /api/cadso/claude/createRecord). */
+        /** POST /api/cadso/dovetail_core/createRecord (legacy: /api/cadso/dovetail/createRecord). */
         createRecord: (params: {
             table: string;
             fields: Record<string, any>;
@@ -73,7 +73,7 @@ export interface ServiceNowClient {
             sys_id: string;
             [k: string]: any;
         }>;
-        /** POST /api/cadso/dovetail/pushWithUpdateSet (legacy: /api/cadso/claude/pushWithUpdateSet). */
+        /** POST /api/cadso/dovetail_core/pushWithUpdateSet (legacy: /api/cadso/dovetail/pushWithUpdateSet). */
         pushWithUpdateSet: (params: {
             update_set_sys_id: string;
             table: string;
@@ -83,18 +83,18 @@ export interface ServiceNowClient {
             sys_id: string;
             [k: string]: any;
         }>;
-        /** GET /api/cadso/dovetail/currentUpdateSet?scope=... (legacy: /api/cadso/claude/currentUpdateSet). */
+        /** GET /api/cadso/dovetail_core/currentUpdateSet?scope=... (legacy: /api/cadso/dovetail/currentUpdateSet). */
         currentUpdateSet: (scope?: string) => Promise<{
             sys_id: string;
             name: string;
         }>;
-        /** GET /api/cadso/dovetail/changeUpdateSet?sysId=... — pins the REST session's active update set. */
+        /** GET /api/cadso/dovetail_core/changeUpdateSet?sysId=... — pins the REST session's active update set. */
         changeUpdateSet: (params: {
             sysId: string;
         }) => Promise<{
             [k: string]: any;
         }>;
-        /** POST /api/cadso/dovetail/deleteRecord — body { table, sys_id }. Returns the deleted record. */
+        /** POST /api/cadso/dovetail_core/deleteRecord — body { table, sys_id }. Returns the deleted record. */
         deleteRecord: (params: {
             table: string;
             sys_id: string;

package/dist/client.js

@@ -7,15 +7,15 @@
  *   - `buildAgent.*`  — reads via the sn_build_agent API, with graceful
  *                       fallback to Table API / sys_dictionary when the
  *                       Build Agent plugin is unavailable
- *   - `claude.*`      — writes via the Dovetail Scripted REST API
- *                       (/api/cadso/dovetail/*), which handles update-set + scope
- *                       switching atomically so every write lands in the right
- *                       update set without touching sys_user_preference.
- *                       Falls back to the legacy /api/cadso/claude/* path on
- *                       instances where the API has not yet been re-imported.
- *                       The namespace name `claude` is preserved for API
- *                       compatibility; the underlying server-side API is now
- *                       named "Dovetail".
+ *   - `claude.*`      — writes via the Dovetail core Scripted REST API
+ *                       (/api/cadso/dovetail_core/*), which handles update-set +
+ *                       scope switching atomically so every write lands in the
+ *                       right update set without touching sys_user_preference.
+ *                       Falls back to the legacy global-scope /api/cadso/dovetail/*
+ *                       path on instances without the Dovetail app installed.
+ *                       The `claude.*` property name is preserved for API
+ *                       compatibility; the server-side API now lives in the
+ *                       Dovetail scoped application as "Dovetail Core".
  *
  * Env fallbacks mirror prior dashboard-fetch helpers so dev setups that already
  * have SN_INSTANCE/SN_USER/SN_PASSWORD work without reconfiguration.
@@ -104,11 +104,12 @@ function createClient(config = {}) {
         validateStatus: function () { return true; }
     });
     var lastAt = 0;
-    // Dovetail Scripted REST API rebrand: prefer /api/cadso/dovetail/* and fall back
-    // to the legacy /api/cadso/claude/* path on instances where the rename hasn't
-    // been imported yet. Latch the legacy flag after the first 404 to avoid paying
-    // the round-trip cost on every subsequent call.
-    var useDovetailLegacyClaudePath = false;
+    // Dovetail core Scripted REST API: prefer the Dovetail-app path
+    // /api/cadso/dovetail_core/* and fall back to the legacy global-scope path
+    // /api/cadso/dovetail/* on instances that don't have the Dovetail app yet.
+    // Latch the legacy flag after the first 404 to avoid paying the round-trip
+    // cost on every subsequent call.
+    var useDovetailLegacyPath = false;
     async function request(cfg, ctx) {
         var attempt429 = 0;
         var attempt5xx = 0;
@@ -160,24 +161,24 @@ function createClient(config = {}) {
             return res.data;
         }
     }
-    // Dovetail Scripted REST API request: try /api/cadso/dovetail/<op>, fall back to
-    // /api/cadso/claude/<op> on 404 (with a one-time deprecation warning).
+    // Dovetail core Scripted REST API request: try /api/cadso/dovetail_core/<op>,
+    // fall back to the legacy /api/cadso/dovetail/<op> on 404 (one-time warning).
     async function dovetailRequest(method, op, body, params, ctx) {
-        var url = useDovetailLegacyClaudePath
-            ? "/api/cadso/claude/" + op
-            : "/api/cadso/dovetail/" + op;
+        var url = useDovetailLegacyPath
+            ? "/api/cadso/dovetail/" + op
+            : "/api/cadso/dovetail_core/" + op;
         try {
             return await request({ method: method, url: url, data: body, params: params }, ctx);
         }
         catch (e) {
             var msg = e && e.message ? String(e.message) : "";
-            if (!useDovetailLegacyClaudePath && msg.indexOf("SN 404 on") === 0) {
+            if (!useDovetailLegacyPath && msg.indexOf("SN 404 on") === 0) {
                 // eslint-disable-next-line no-console
-                console.warn("[deprecation] /api/cadso/dovetail/" + op +
-                    " returned 404. Falling back to legacy /api/cadso/claude/" + op +
-                    ". Re-import the Dovetail Scripted REST API XML on your ServiceNow instance to silence this warning.");
-                useDovetailLegacyClaudePath = true;
-                var legacyUrl = "/api/cadso/claude/" + op;
+                console.warn("[deprecation] /api/cadso/dovetail_core/" + op +
+                    " returned 404. Falling back to legacy /api/cadso/dovetail/" + op +
+                    ". Install the Dovetail application's Scripted REST APIs to silence this warning.");
+                useDovetailLegacyPath = true;
+                var legacyUrl = "/api/cadso/dovetail/" + op;
                 return await request({ method: method, url: legacyUrl, data: body, params: params }, ctx);
             }
             throw e;

package/dist/flowDesigner/copyFlow.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Copy a Flow Designer flow or subflow — the Designer's own "Copy flow" action,
+ * headless.
+ *
+ * The Workflow Studio "Copy flow" button calls a clean REST endpoint (captured
+ * from a HAR, same family as the publish/snapshot endpoint), which works for the
+ * integration user with basic auth:
+ *
+ *   POST /api/now/processflow/flow/{sourceSysId}/copy?sysparm_transaction_scope={scope}
+ *     body: { name: "<new flow name>", scope: "<target scope sys_id>" }
+ *     -> 200, { result: { data: "<new flow sys_id>" } } — the copy is a complete,
+ *        faithful clone (trigger + all actions + variables + properties), created
+ *        as an INACTIVE DRAFT.
+ *
+ * This supersedes the record-graph clone (cloneSubflow), which can't work for
+ * the integration user: the design tables (sys_hub_flow_input/action_instance)
+ * ignore sysparm_query on the plain Table API, and the build-agent endpoint that
+ * honors the filter returns 401 without the Build Agent role — so a record-graph
+ * read either 401s or scans the whole table. The platform copy endpoint sidesteps
+ * all of that: ServiceNow assembles the copy server-side.
+ *
+ * The copy lands in `scopeSysId` (sysparm_transaction_scope) — which may differ
+ * from the source's scope — as an inactive draft. Publish it with publishFlow
+ * when ready. Do NOT publish + activate a copy of a triggered production flow
+ * unless you intend it to fire (e.g. a Send-SMS flow would duplicate sends).
+ */
+import type { ServiceNowClient } from "../client";
+export interface CopyFlowParams {
+    client: ServiceNowClient;
+    /** sys_id of the sys_hub_flow (flow or subflow) to copy. */
+    sourceSysId: string;
+    /** Name for the new copy. */
+    newName: string;
+    /**
+     * Target application scope sys_id (sysparm_transaction_scope) the copy is
+     * created in. Optional — defaults to the source flow's own scope (read first).
+     */
+    scopeSysId?: string;
+}
+export interface CopyFlowResult {
+    /** sys_id of the newly created copy. */
+    sysId: string;
+    /** Name of the copy (echoes newName). */
+    name: string;
+    /** The scope the copy was created in. */
+    scopeSysId: string;
+}
+export declare function copyFlow(params: CopyFlowParams): Promise<CopyFlowResult>;

package/dist/flowDesigner/copyFlow.js

@@ -0,0 +1,106 @@
+"use strict";
+/**
+ * Copy a Flow Designer flow or subflow — the Designer's own "Copy flow" action,
+ * headless.
+ *
+ * The Workflow Studio "Copy flow" button calls a clean REST endpoint (captured
+ * from a HAR, same family as the publish/snapshot endpoint), which works for the
+ * integration user with basic auth:
+ *
+ *   POST /api/now/processflow/flow/{sourceSysId}/copy?sysparm_transaction_scope={scope}
+ *     body: { name: "<new flow name>", scope: "<target scope sys_id>" }
+ *     -> 200, { result: { data: "<new flow sys_id>" } } — the copy is a complete,
+ *        faithful clone (trigger + all actions + variables + properties), created
+ *        as an INACTIVE DRAFT.
+ *
+ * This supersedes the record-graph clone (cloneSubflow), which can't work for
+ * the integration user: the design tables (sys_hub_flow_input/action_instance)
+ * ignore sysparm_query on the plain Table API, and the build-agent endpoint that
+ * honors the filter returns 401 without the Build Agent role — so a record-graph
+ * read either 401s or scans the whole table. The platform copy endpoint sidesteps
+ * all of that: ServiceNow assembles the copy server-side.
+ *
+ * The copy lands in `scopeSysId` (sysparm_transaction_scope) — which may differ
+ * from the source's scope — as an inactive draft. Publish it with publishFlow
+ * when ready. Do NOT publish + activate a copy of a triggered production flow
+ * unless you intend it to fire (e.g. a Send-SMS flow would duplicate sends).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.copyFlow = copyFlow;
+/**
+ * Pull the new flow's sys_id from the copy response. The endpoint returns the
+ * new sys_id as a bare string under `result.data`; older/alternate shapes may
+ * nest it under a model object's `id`/`sys_id`.
+ */
+function extractCopiedSysId(resp) {
+    if (resp && typeof resp === "object" && resp.result && typeof resp.result === "object") {
+        var d = resp.result.data;
+        if (typeof d === "string" && d.length >= 32) {
+            return d;
+        }
+        if (d && typeof d === "object") {
+            if (typeof d.id === "string")
+                return d.id;
+            if (typeof d.sys_id === "string")
+                return d.sys_id;
+        }
+    }
+    if (resp && typeof resp === "object") {
+        if (typeof resp.id === "string")
+            return resp.id;
+        if (typeof resp.sys_id === "string")
+            return resp.sys_id;
+    }
+    return "";
+}
+function flowGetPath(sysId) {
+    return "/api/now/processflow/flow/" + encodeURIComponent(sysId);
+}
+function copyPath(sourceSysId, scopeSysId) {
+    return "/api/now/processflow/flow/" + encodeURIComponent(sourceSysId) + "/copy"
+        + "?sysparm_transaction_scope=" + encodeURIComponent(scopeSysId);
+}
+function unwrapModel(data) {
+    if (data && typeof data === "object" && data.result && typeof data.result === "object") {
+        if (data.result.data && typeof data.result.data === "object") {
+            return data.result.data;
+        }
+        return data.result;
+    }
+    if (data && typeof data === "object" && data.data && typeof data.data === "object") {
+        return data.data;
+    }
+    return data;
+}
+async function copyFlow(params) {
+    var client = params.client;
+    var sourceSysId = params.sourceSysId;
+    if (!sourceSysId) {
+        throw new Error("copyFlow: sourceSysId is required.");
+    }
+    if (typeof params.newName !== "string" || params.newName.trim().length === 0) {
+        throw new Error("copyFlow: newName is required.");
+    }
+    // Resolve the target scope: explicit param, else the source flow's own scope.
+    var scopeSysId = params.scopeSysId;
+    if (!scopeSysId) {
+        var src = unwrapModel(await client.now.get(flowGetPath(sourceSysId)));
+        if (src && typeof src.scope === "string") {
+            scopeSysId = src.scope;
+        }
+    }
+    if (!scopeSysId) {
+        throw new Error("copyFlow: scopeSysId is required and the source flow carried no `scope` to default from.");
+    }
+    var resp = await client.now.post(copyPath(sourceSysId, scopeSysId), { name: params.newName, scope: scopeSysId });
+    var newSysId = extractCopiedSysId(resp);
+    if (!newSysId) {
+        throw new Error("copyFlow: the copy succeeded but no new flow sys_id was found in the response: "
+            + JSON.stringify(resp).substring(0, 300));
+    }
+    return {
+        sysId: newSysId,
+        name: params.newName,
+        scopeSysId: scopeSysId
+    };
+}

package/dist/flowDesigner/editFlow.d.ts

@@ -41,14 +41,26 @@ export interface EditFlowParams {
     /** sys_id of the sys_hub_flow (flow or subflow) to edit. */
     sysId: string;
     ops: EditFlowOps;
-    /** When true, publish the edited model. When false/omitted, dry-run (no write). */
+    /** When true, persist the edits. When false/omitted, dry-run (no write). */
     apply?: boolean;
     /** Override sysparm_transaction_scope for the publish; defaults to the model's scope. */
     scopeSysId?: string;
+    /**
+     * Update set sys_id that captures top-level field writes (rename/description).
+     * REQUIRED when apply=true and the ops include rename or description — those
+     * fields are written to sys_hub_flow through the update-set-aware Dovetail API
+     * (the snapshot POST does NOT persist them). Not needed for patchStepInputs-only
+     * edits (those ride the snapshot POST).
+     */
+    updateSetSysId?: string;
 }
 export interface EditFlowResult {
-    /** "dry-run" (computed, not published) or "published". */
-    status: "dry-run" | "published";
+    /**
+     * "dry-run"  — computed, nothing written;
+     * "applied"  — edits persisted (record fields written; snapshot recompiled iff
+     *              a step input changed).
+     */
+    status: "dry-run" | "applied";
     /** Human-readable list of changes that were applied to the model. */
     changes: Array<string>;
     /** Requested edits that could not be matched (e.g. unknown step or input). */

package/dist/flowDesigner/editFlow.js

@@ -73,31 +73,42 @@ async function editFlow(params) {
     if (!sysId) {
         throw new Error("editFlow: sysId is required.");
     }
-    // Read the full model — we need the raw instance graph to patch it.
+    // Read the full model — we need the raw instance graph to patch step inputs
+    // and to resolve the flow's scope for the update-set-aware record write.
     var read = await (0, readFlow_1.readFlow)({ client: client, sysId: sysId, raw: true });
     var model = read.raw;
     if (!model || typeof model !== "object") {
-        // Defensive — readFlow already throws on a bad response, but the raw model
-        // could in theory be absent.
         var resp = await client.now.get("/api/now/processflow/flow/" + encodeURIComponent(sysId));
         model = unwrapModel(resp);
     }
+    var scopeSysId = params.scopeSysId || (typeof model.scope === "string" ? model.scope : "");
     var changes = [];
     var warnings = [];
+    // Top-level sys_hub_flow columns. These are NOT persisted by the snapshot POST
+    // (that only writes step input values), so they go through a direct,
+    // update-set-aware record write — see recordFields below.
+    var recordFields = {};
     if (ops.rename) {
         if (ops.rename.name) {
-            model.name = ops.rename.name;
+            recordFields.name = ops.rename.name;
             changes.push("name -> " + ops.rename.name);
         }
         if (ops.rename.internalName) {
-            model.internalName = ops.rename.internalName;
+            recordFields.internal_name = ops.rename.internalName;
             changes.push("internalName -> " + ops.rename.internalName);
         }
     }
     if (typeof ops.description === "string") {
-        model.description = ops.description;
+        recordFields.description = ops.description;
         changes.push("description updated");
     }
+    // Step input values ride the snapshot POST — the publish is documented to
+    // persist step input values back to the design records (verified for action
+    // types). For FLOWS this is best-effort: we apply, republish, then read back
+    // and confirm each value actually took (see the verify pass after publish), so
+    // a non-persist surfaces as a warning instead of a silent false success.
+    var stepInputsChanged = false;
+    var verifyTargets = [];
     if (ops.patchStepInputs && ops.patchStepInputs.length > 0) {
         for (var i = 0; i < ops.patchStepInputs.length; i += 1) {
             var patch = ops.patchStepInputs[i];
@@ -108,6 +119,8 @@ async function editFlow(params) {
             }
             var ok = setInputValue(step, patch.input, patch.value);
             if (ok) {
+                stepInputsChanged = true;
+                verifyTargets.push({ step: patch.step, input: patch.input, value: patch.value });
                 changes.push("step '" + (step.name || patch.step) + "' input '" + patch.input + "' updated");
             }
             else {
@@ -115,18 +128,59 @@ async function editFlow(params) {
             }
         }
     }
-    if (!params.apply) {
+    if (!params.apply || changes.length === 0) {
+        // Dry-run, or nothing matched — never write/publish a no-op.
         return { status: "dry-run", changes: changes, warnings: warnings };
     }
-    if (changes.length === 0) {
-        // Nothing matched — don't publish a no-op (which would still recompile).
-        return { status: "dry-run", changes: changes, warnings: warnings };
+    // 1. Persist top-level field edits via the Dovetail write API, pinned to the
+    //    caller-supplied update set so the change is captured for promotion.
+    if (Object.keys(recordFields).length > 0) {
+        if (!params.updateSetSysId) {
+            throw new Error("editFlow: updateSetSysId is required to apply rename/description edits "
+                + "(they write sys_hub_flow through the update-set-aware API). Pass an "
+                + "in-progress update set sys_id, or limit ops to patchStepInputs.");
+        }
+        await client.claude.pushWithUpdateSet({
+            update_set_sys_id: params.updateSetSysId,
+            table: "sys_hub_flow",
+            record_sys_id: sysId,
+            fields: recordFields
+        });
+    }
+    // 2. Republish only when step inputs changed (recompiles the snapshot AND
+    //    persists the step values). Metadata-only edits need no recompile.
+    var snapshotSysId;
+    if (stepInputsChanged) {
+        var pub = await (0, publishFlow_1.publishFlow)({ client: client, sysId: sysId, model: model, scopeSysId: scopeSysId || undefined });
+        snapshotSysId = pub.snapshotSysId;
+        // 3. Verify the step-input changes actually persisted. The snapshot POST is
+        //    only documented to persist step values for action types; for flows it
+        //    can no-op. Read the model back and confirm each value took — a miss is
+        //    surfaced as a warning rather than a silent false "applied".
+        var afterResp = await client.now.get("/api/now/processflow/flow/" + encodeURIComponent(sysId));
+        var afterModel = unwrapModel(afterResp);
+        for (var v = 0; v < verifyTargets.length; v += 1) {
+            var t = verifyTargets[v];
+            var liveStep = afterModel ? findStep(afterModel, t.step) : null;
+            var persisted = false;
+            if (liveStep && Array.isArray(liveStep.inputs)) {
+                for (var k = 0; k < liveStep.inputs.length; k += 1) {
+                    if (liveStep.inputs[k] && liveStep.inputs[k].name === t.input) {
+                        persisted = String(liveStep.inputs[k].value) === String(t.value);
+                        break;
+                    }
+                }
+            }
+            if (!persisted) {
+                warnings.push("step input '" + t.input + "' on '" + t.step + "' did not persist via the snapshot POST "
+                    + "— verify in the Designer (flow step-input persistence is best-effort).");
+            }
+        }
     }
-    var pub = await (0, publishFlow_1.publishFlow)({ client: client, sysId: sysId, model: model, scopeSysId: params.scopeSysId });
     return {
-        status: "published",
+        status: "applied",
         changes: changes,
         warnings: warnings,
-        snapshotSysId: pub.snapshotSysId
+        snapshotSysId: snapshotSysId
     };
 }

package/dist/flowDesigner/index.d.ts

@@ -22,6 +22,8 @@ export { readActionType } from "./readActionType";
 export type { ReadActionTypeParams, ReadActionTypeResult, ActionIo } from "./readActionType";
 export { publishFlow } from "./publishFlow";
 export type { PublishFlowParams, PublishFlowResult } from "./publishFlow";
+export { copyFlow } from "./copyFlow";
+export type { CopyFlowParams, CopyFlowResult } from "./copyFlow";
 export { editFlow } from "./editFlow";
 export type { EditFlowParams, EditFlowResult, EditFlowOps, StepInputPatch } from "./editFlow";
 export { testFlow, DEFAULT_RUN_FLOW_PATH } from "./testFlow";

package/dist/flowDesigner/index.js

@@ -6,7 +6,7 @@
  * functions land in Phase 1.C/D.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WriteOrderError = exports.executeWritePlan = exports.topoSort = exports.SYSTEM_FIELDS_TO_STRIP = exports.assertSysId = exports.applyScope = exports.stripSystemFields = exports.generateSysId = exports.DEFAULT_RUN_FLOW_PATH = exports.testFlow = exports.editFlow = exports.publishFlow = exports.readActionType = exports.readFlow = exports.publishActionType = exports.triggerPublication = exports.cloneActionType = exports.cloneSubflow = exports.verifyArtifact = exports.listTemplates = void 0;
+exports.WriteOrderError = exports.executeWritePlan = exports.topoSort = exports.SYSTEM_FIELDS_TO_STRIP = exports.assertSysId = exports.applyScope = exports.stripSystemFields = exports.generateSysId = exports.DEFAULT_RUN_FLOW_PATH = exports.testFlow = exports.editFlow = exports.copyFlow = exports.publishFlow = exports.readActionType = exports.readFlow = exports.publishActionType = exports.triggerPublication = exports.cloneActionType = exports.cloneSubflow = exports.verifyArtifact = exports.listTemplates = void 0;
 var listTemplates_1 = require("./listTemplates");
 Object.defineProperty(exports, "listTemplates", { enumerable: true, get: function () { return listTemplates_1.listTemplates; } });
 var verifyArtifact_1 = require("./verifyArtifact");
@@ -25,6 +25,8 @@ var readActionType_1 = require("./readActionType");
 Object.defineProperty(exports, "readActionType", { enumerable: true, get: function () { return readActionType_1.readActionType; } });
 var publishFlow_1 = require("./publishFlow");
 Object.defineProperty(exports, "publishFlow", { enumerable: true, get: function () { return publishFlow_1.publishFlow; } });
+var copyFlow_1 = require("./copyFlow");
+Object.defineProperty(exports, "copyFlow", { enumerable: true, get: function () { return copyFlow_1.copyFlow; } });
 var editFlow_1 = require("./editFlow");
 Object.defineProperty(exports, "editFlow", { enumerable: true, get: function () { return editFlow_1.editFlow; } });
 var testFlow_1 = require("./testFlow");

package/dist/index.d.ts

@@ -14,6 +14,6 @@ export { setFormLayout } from "./layout/formLayout";
 export { setRelatedLists } from "./layout/relatedLists";
 export { formatLayoutResult, formatCreateViewResult } from "./layout/formatter";
 export { sincPlugin } from "./plugin";
-export { listTemplates, verifyArtifact, cloneSubflow, cloneActionType, triggerPublication, publishActionType, readFlow, readActionType, publishFlow, editFlow, testFlow, DEFAULT_RUN_FLOW_PATH, generateSysId, topoSort, executeWritePlan, WriteOrderError } from "./flowDesigner";
-export type { TemplateRef, ListTemplatesParams, FlowKind, VerifyExpect, VerifyFound, VerifyFailure, VerifyReport, VerifyArtifactParams, CloneSubflowParams, CloneSubflowResult, CloneActionTypeParams, CloneActionTypeResult, TriggerPublicationParams, TriggerPublicationResult, PublishActionTypeParams, PublishActionTypeResult, ReadFlowParams, ReadFlowResult, FlowStep, FlowVariable, ReadActionTypeParams, ReadActionTypeResult, ActionIo, PublishFlowParams, PublishFlowResult, EditFlowParams, EditFlowResult, EditFlowOps, StepInputPatch, TestFlowParams, TestFlowResult, WriteOp, WriteOpResult } from "./flowDesigner";
+export { listTemplates, verifyArtifact, cloneSubflow, cloneActionType, triggerPublication, publishActionType, readFlow, readActionType, publishFlow, copyFlow, editFlow, testFlow, DEFAULT_RUN_FLOW_PATH, generateSysId, topoSort, executeWritePlan, WriteOrderError } from "./flowDesigner";
+export type { TemplateRef, ListTemplatesParams, FlowKind, VerifyExpect, VerifyFound, VerifyFailure, VerifyReport, VerifyArtifactParams, CloneSubflowParams, CloneSubflowResult, CloneActionTypeParams, CloneActionTypeResult, TriggerPublicationParams, TriggerPublicationResult, PublishActionTypeParams, PublishActionTypeResult, ReadFlowParams, ReadFlowResult, FlowStep, FlowVariable, ReadActionTypeParams, ReadActionTypeResult, ActionIo, PublishFlowParams, PublishFlowResult, CopyFlowParams, CopyFlowResult, EditFlowParams, EditFlowResult, EditFlowOps, StepInputPatch, TestFlowParams, TestFlowResult, WriteOp, WriteOpResult } from "./flowDesigner";
 export type { ServiceNowClientConfig, ChoiceValue, ChoiceType, AddChoicesParams, AddChoicesResult, ChoiceActionResult, DictionaryRecord, UpdateSetRecord, LayoutAction, LayoutRecordResult, LayoutResult, CreateViewParams, CreateViewResult, FormSectionSpec, SetFormLayoutParams, SetListLayoutParams, SetRelatedListsParams } from "./types";

package/dist/index.js

@@ -6,7 +6,7 @@
  * REST API so every change lands in the target update set and scope.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WriteOrderError = exports.executeWritePlan = exports.topoSort = exports.generateSysId = exports.DEFAULT_RUN_FLOW_PATH = exports.testFlow = exports.editFlow = exports.publishFlow = exports.readActionType = exports.readFlow = exports.publishActionType = exports.triggerPublication = exports.cloneActionType = exports.cloneSubflow = exports.verifyArtifact = exports.listTemplates = exports.sincPlugin = exports.formatCreateViewResult = exports.formatLayoutResult = exports.setRelatedLists = exports.setFormLayout = exports.setListLayout = exports.createView = exports.formatAddChoicesResult = exports.addChoicesToField = exports.createClient = void 0;
+exports.WriteOrderError = exports.executeWritePlan = exports.topoSort = exports.generateSysId = exports.DEFAULT_RUN_FLOW_PATH = exports.testFlow = exports.editFlow = exports.copyFlow = exports.publishFlow = exports.readActionType = exports.readFlow = exports.publishActionType = exports.triggerPublication = exports.cloneActionType = exports.cloneSubflow = exports.verifyArtifact = exports.listTemplates = exports.sincPlugin = exports.formatCreateViewResult = exports.formatLayoutResult = exports.setRelatedLists = exports.setFormLayout = exports.setListLayout = exports.createView = exports.formatAddChoicesResult = exports.addChoicesToField = exports.createClient = void 0;
 var client_1 = require("./client");
 Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return client_1.createClient; } });
 var choices_1 = require("./choices");
@@ -36,6 +36,7 @@ Object.defineProperty(exports, "publishActionType", { enumerable: true, get: fun
 Object.defineProperty(exports, "readFlow", { enumerable: true, get: function () { return flowDesigner_1.readFlow; } });
 Object.defineProperty(exports, "readActionType", { enumerable: true, get: function () { return flowDesigner_1.readActionType; } });
 Object.defineProperty(exports, "publishFlow", { enumerable: true, get: function () { return flowDesigner_1.publishFlow; } });
+Object.defineProperty(exports, "copyFlow", { enumerable: true, get: function () { return flowDesigner_1.copyFlow; } });
 Object.defineProperty(exports, "editFlow", { enumerable: true, get: function () { return flowDesigner_1.editFlow; } });
 Object.defineProperty(exports, "testFlow", { enumerable: true, get: function () { return flowDesigner_1.testFlow; } });
 Object.defineProperty(exports, "DEFAULT_RUN_FLOW_PATH", { enumerable: true, get: function () { return flowDesigner_1.DEFAULT_RUN_FLOW_PATH; } });

package/dist/mcp/registry.d.ts

@@ -9,7 +9,7 @@
 import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { z } from "zod";
 import type { ServiceNowClient } from "../client";
-export declare var TOOL_NAMES: readonly ["create_view", "set_list_layout", "set_form_layout", "set_related_lists", "add_choices_to_field", "flow_view", "action_view", "flow_publish", "flow_test", "flow_edit"];
+export declare var TOOL_NAMES: readonly ["create_view", "set_list_layout", "set_form_layout", "set_related_lists", "add_choices_to_field", "flow_view", "action_view", "flow_publish", "flow_copy", "flow_test", "flow_edit"];
 export type ToolName = typeof TOOL_NAMES[number];
 export interface RegistryDeps {
     /** Optional client injection for tests; defaults to createClient({}). */

package/dist/mcp/registry.js

@@ -20,6 +20,7 @@ const choices_1 = require("../choices");
 const readFlow_1 = require("../flowDesigner/readFlow");
 const readActionType_1 = require("../flowDesigner/readActionType");
 const publishFlow_1 = require("../flowDesigner/publishFlow");
+const copyFlow_1 = require("../flowDesigner/copyFlow");
 const editFlow_1 = require("../flowDesigner/editFlow");
 const testFlow_1 = require("../flowDesigner/testFlow");
 const schemas_1 = require("./schemas");
@@ -32,6 +33,7 @@ exports.TOOL_NAMES = [
     "flow_view",
     "action_view",
     "flow_publish",
+    "flow_copy",
     "flow_test",
     "flow_edit"
 ];
@@ -126,6 +128,19 @@ function buildDescriptors(deps = {}) {
                 return (0, publishFlow_1.publishFlow)({ client: client(), sysId: p.sysId, scopeSysId: p.scopeSysId });
             }
         },
+        {
+            name: "flow_copy",
+            description: "Copy a ServiceNow flow/subflow via the Designer's Copy endpoint — a complete, faithful "
+                + "clone created as an INACTIVE DRAFT in the target scope. sourceSysId is the sys_hub_flow "
+                + "to copy; newName is the copy's name; scopeSysId defaults to the source's scope. Publish "
+                + "with flow_publish when ready. Do NOT publish + activate a copy of a triggered production "
+                + "flow unless you intend it to fire.",
+            shape: schemas_1.copyFlowSchema.shape,
+            handler: async function (args) {
+                var p = schemas_1.copyFlowSchema.parse(args);
+                return (0, copyFlow_1.copyFlow)({ client: client(), sourceSysId: p.sourceSysId, newName: p.newName, scopeSysId: p.scopeSysId });
+            }
+        },
         {
             name: "flow_test",
             description: "Test or run a ServiceNow flow/subflow. mode='validate' (default) is a safe, read-only "
@@ -148,10 +163,11 @@ function buildDescriptors(deps = {}) {
         },
         {
             name: "flow_edit",
-            description: "Edit a ServiceNow flow/subflow in place and re-publish. Supports rename "
-                + "(name/internalName), description, and patchStepInputs (set named input values on steps "
-                + "by uiId or label). apply=false (default) is a dry-run that returns the diff; apply=true "
-                + "publishes the edit (a write). sysId is the sys_hub_flow sys_id.",
+            description: "Edit a ServiceNow flow/subflow in place. Supports rename (name/internalName), description, "
+                + "and patchStepInputs (set named input values on steps by uiId or label). apply=false "
+                + "(default) is a dry-run that returns the diff; apply=true persists the edit (a write). "
+                + "Rename/description require updateSetSysId (they write sys_hub_flow via the update-set-aware "
+                + "API); patchStepInputs ride a snapshot recompile. sysId is the sys_hub_flow sys_id.",
             shape: schemas_1.editFlowSchema.shape,
             handler: async function (args) {
                 var p = schemas_1.editFlowSchema.parse(args);
@@ -160,7 +176,8 @@ function buildDescriptors(deps = {}) {
                     sysId: p.sysId,
                     ops: p.ops,
                     apply: p.apply,
-                    scopeSysId: p.scopeSysId
+                    scopeSysId: p.scopeSysId,
+                    updateSetSysId: p.updateSetSysId
                 });
             }
         }

package/dist/mcp/schemas.d.ts

@@ -218,6 +218,19 @@ export declare var publishFlowSchema: z.ZodObject<{
     sysId: string;
     scopeSysId?: string | undefined;
 }>;
+export declare var copyFlowSchema: z.ZodObject<{
+    sourceSysId: z.ZodString;
+    newName: z.ZodString;
+    scopeSysId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    sourceSysId: string;
+    newName: string;
+    scopeSysId?: string | undefined;
+}, {
+    sourceSysId: string;
+    newName: string;
+    scopeSysId?: string | undefined;
+}>;
 export declare var testFlowSchema: z.ZodObject<{
     sysId: z.ZodString;
     mode: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"validate">, z.ZodLiteral<"execute">]>>;
@@ -302,6 +315,7 @@ export declare var editFlowSchema: z.ZodObject<{
     }>;
     apply: z.ZodOptional<z.ZodBoolean>;
     scopeSysId: z.ZodOptional<z.ZodString>;
+    updateSetSysId: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     sysId: string;
     ops: {
@@ -317,6 +331,7 @@ export declare var editFlowSchema: z.ZodObject<{
         }[] | undefined;
     };
     scopeSysId?: string | undefined;
+    updateSetSysId?: string | undefined;
     apply?: boolean | undefined;
 }, {
     sysId: string;
@@ -333,5 +348,6 @@ export declare var editFlowSchema: z.ZodObject<{
         }[] | undefined;
     };
     scopeSysId?: string | undefined;
+    updateSetSysId?: string | undefined;
     apply?: boolean | undefined;
 }>;

package/dist/mcp/schemas.js

@@ -4,7 +4,7 @@
  * own file so registry.ts stays focused on wiring.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.editFlowSchema = exports.stepInputPatchSchema = exports.testFlowSchema = exports.publishFlowSchema = exports.viewActionSchema = exports.viewFlowSchema = exports.addChoicesToFieldSchema = exports.choiceValueSchema = exports.setRelatedListsSchema = exports.setFormLayoutSchema = exports.formSectionSchema = exports.setListLayoutSchema = exports.createViewSchema = void 0;
+exports.editFlowSchema = exports.stepInputPatchSchema = exports.testFlowSchema = exports.copyFlowSchema = exports.publishFlowSchema = exports.viewActionSchema = exports.viewFlowSchema = exports.addChoicesToFieldSchema = exports.choiceValueSchema = exports.setRelatedListsSchema = exports.setFormLayoutSchema = exports.formSectionSchema = exports.setListLayoutSchema = exports.createViewSchema = void 0;
 const zod_1 = require("zod");
 exports.createViewSchema = zod_1.z.object({
     name: zod_1.z.string().min(1),
@@ -71,6 +71,11 @@ exports.publishFlowSchema = zod_1.z.object({
     sysId: zod_1.z.string().min(1),
     scopeSysId: zod_1.z.string().optional()
 });
+exports.copyFlowSchema = zod_1.z.object({
+    sourceSysId: zod_1.z.string().min(1),
+    newName: zod_1.z.string().min(1),
+    scopeSysId: zod_1.z.string().optional()
+});
 exports.testFlowSchema = zod_1.z.object({
     sysId: zod_1.z.string().min(1),
     mode: zod_1.z.union([zod_1.z.literal("validate"), zod_1.z.literal("execute")]).optional(),
@@ -94,5 +99,6 @@ exports.editFlowSchema = zod_1.z.object({
         patchStepInputs: zod_1.z.array(exports.stepInputPatchSchema).optional()
     }),
     apply: zod_1.z.boolean().optional(),
-    scopeSysId: zod_1.z.string().optional()
+    scopeSysId: zod_1.z.string().optional(),
+    updateSetSysId: zod_1.z.string().optional()
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tenonhq/dovetail-servicenow",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "engines": {
     "node": ">=22"
   },