@tenonhq/dovetail-servicenow 0.0.23 → 0.0.24

package/dist/cli.js

@@ -79,6 +79,8 @@ const editFlow_1 = require("./flowDesigner/editFlow");
 const editActionType_1 = require("./flowDesigner/editActionType");
 const testFlow_1 = require("./flowDesigner/testFlow");
 const table_1 = require("./table");
+const setField_1 = require("./setField");
+const createRecord_1 = require("./createRecord");
 const hostAssets_1 = require("./hostAssets");
 const flowDesigner_formatter_2 = require("./flowDesigner-formatter");
 function parseArgs(argv) {
@@ -711,6 +713,12 @@ function printHelp() {
         "                     (--table <name|sys_id> --label <l> --type <t>\n" +
         "                      [--name <element>] [--max-length <n>] [--reference <table>]\n" +
         "                      [--scope <s>] [--update-set <sys_id>] [--dry-run] [--json])\n" +
+        "  set-field          Set scalar field value(s) on an EXISTING record, into an update set, then verify\n" +
+        "                     (--table <t> --sys-id <id>|--query <q> --fields \"k=v,k2=v2\"\n" +
+        "                      --update-set <sys_id> [--dry-run] [--json])\n" +
+        "  create-record      Create ONE NEW record in a data table, into an update set, then verify\n" +
+        "                     (--table <t> --fields \"k=v,k2=v2\" --scope <s> --update-set <sys_id>\n" +
+        "                      [--if-absent <encoded-query>] [--dry-run] [--json])\n" +
         "  host-assets        Deploy a built dist/ to ServiceNow (carrier sys_ui_script + attachment + m2m)\n" +
         "                     (--dir <dist> --app <sys_id> --scope <namespace>\n" +
         "                      [--update-set <sys_id>] [--max-bytes <n>] [--allow-oversize] [--dry-run] [--json])\n" +
@@ -875,6 +883,111 @@ async function runAddColumn(flags) {
         return 2;
     return 0;
 }
+/** Parse inline `--fields "k=v, k2=v2"` into a field map. */
+function parseFieldsInline(input) {
+    var out = {};
+    if (!input)
+        return out;
+    var parts = input.split(",");
+    for (var i = 0; i < parts.length; i += 1) {
+        var piece = parts[i].trim();
+        if (!piece)
+            continue;
+        var eq = piece.indexOf("=");
+        if (eq === -1)
+            continue;
+        var key = piece.slice(0, eq).trim();
+        if (key)
+            out[key] = piece.slice(eq + 1).trim();
+    }
+    return out;
+}
+/**
+ * dove-sn set-field:
+ *   --table x_cadso_core_metric_point_type
+ *   --sys-id <id>  |  --query "name=send_size"   (query must resolve to exactly 1 row)
+ *   --fields "order=20"                          (comma-separated key=value pairs)
+ *   --update-set <sys_id>                        (required — the change is captured here)
+ *   [--dry-run] [--json]
+ * Exit codes: 0 applied/dry-run, 1 bad args, 2 write landed but read-back unverified.
+ */
+async function runSetField(flags) {
+    var table = flags.table;
+    var fields = parseFieldsInline(flags.fields || "");
+    var hasTarget = Boolean(flags["sys-id"] || flags.query);
+    if (!table || Object.keys(fields).length === 0 || !hasTarget || !flags["update-set"]) {
+        process.stderr.write("set-field: --table, --fields \"k=v\", one of --sys-id/--query, and --update-set are required\n");
+        return 1;
+    }
+    var params = {
+        client: (0, client_1.createClient)({}),
+        table: table,
+        fields: fields,
+        updateSetSysId: flags["update-set"]
+    };
+    if (flags["sys-id"])
+        params.sysId = flags["sys-id"];
+    if (flags.query)
+        params.query = flags.query;
+    if (flags["dry-run"] === "true")
+        params.dryRun = true;
+    var result = await (0, setField_1.setField)(params);
+    if (flags.json === "true") {
+        process.stdout.write(JSON.stringify(result, null, 2) + "\n");
+    }
+    else {
+        process.stdout.write("[" + result.status + "] " + result.table + "/" + result.sysId + " "
+            + JSON.stringify(result.fields) + (result.verified ? " — verified" : "")
+            + "\n" + result.note + "\n");
+    }
+    if (result.status === "failed")
+        return 2;
+    return 0;
+}
+/**
+ * dove-sn create-record:
+ *   --table x_cadso_core_metric_point_type
+ *   --fields "name=avg_message_parts,label=Avg. Message Parts,order=35"
+ *   --scope x_cadso_core                         (the app that owns the new record)
+ *   --update-set <sys_id>                        (required — the insert is captured here)
+ *   [--if-absent "name=avg_message_parts"]       (skip the insert when this query already matches)
+ *   [--dry-run] [--json]
+ * Exit codes: 0 created/skipped-in-sync/dry-run, 1 bad args, 2 write landed but read-back unverified
+ * (or skipped with drift).
+ */
+async function runCreateRecord(flags) {
+    var table = flags.table;
+    var fields = parseFieldsInline(flags.fields || "");
+    if (!table || Object.keys(fields).length === 0 || !flags.scope || !flags["update-set"]) {
+        process.stderr.write("create-record: --table, --fields \"k=v\", --scope and --update-set are required\n");
+        return 1;
+    }
+    var params = {
+        client: (0, client_1.createClient)({}),
+        table: table,
+        fields: fields,
+        scope: flags.scope,
+        updateSetSysId: flags["update-set"]
+    };
+    if (flags["if-absent"])
+        params.ifAbsentQuery = flags["if-absent"];
+    if (flags["dry-run"] === "true")
+        params.dryRun = true;
+    var result = await (0, createRecord_1.createRecord)(params);
+    if (flags.json === "true") {
+        process.stdout.write(JSON.stringify(result, null, 2) + "\n");
+    }
+    else {
+        process.stdout.write("[" + result.status + "] " + result.table + "/" + (result.sysId || "(new)") + " "
+            + JSON.stringify(result.fields) + (result.verified ? " — verified" : "")
+            + "\n" + result.note + "\n");
+    }
+    if (result.status === "failed")
+        return 2;
+    if (result.status === "skipped" && !result.verified)
+        return 2;
+    return 0;
+}
 /**
  * dove-sn host-assets:
  *   --dir <dist>            Required. Path to the pre-built dist/ directory.
@@ -951,6 +1064,12 @@ async function main() {
     if (parsed.command === "add-column") {
         return await runAddColumn(parsed.flags);
     }
+    if (parsed.command === "set-field") {
+        return await runSetField(parsed.flags);
+    }
+    if (parsed.command === "create-record") {
+        return await runCreateRecord(parsed.flags);
+    }
     if (parsed.command === "host-assets") {
         return await runHostAssets(parsed.flags);
     }

package/dist/createRecord.d.ts

@@ -0,0 +1,39 @@
+/**
+ * dove-sn create-record — create ONE new record in a data table, captured
+ * into a specified update set, then read back and verify.
+ *
+ * Wraps the Dovetail core Scripted REST `createRecord` op, which switches the
+ * executing user's app scope and update set server-side, inserts, and
+ * restores both — so the record is owned by the right app and the insert is
+ * captured in the right update set without touching sys_user_preference.
+ * The INSERT counterpart to `set-field`.
+ *
+ * NOT for schema tables (sys_db_object / sys_dictionary) — that's
+ * create-table / add-column. To UPDATE an existing record, use `set-field`.
+ */
+import type { ServiceNowClient } from "./client";
+export interface CreateRecordParams {
+    client?: ServiceNowClient;
+    table: string;
+    /** Field name -> value for the new record. Values are sent as strings; ServiceNow coerces. */
+    fields: Record<string, string>;
+    /** App scope that will own the record. Required — session-scope stamping is the #1 wrong-scope cause. */
+    scope?: string;
+    /** Update set to capture the insert into. Required for a tracked write. */
+    updateSetSysId?: string;
+    /** Encoded query; when it already matches a row the insert is skipped (idempotent re-runs). */
+    ifAbsentQuery?: string;
+    dryRun?: boolean;
+}
+export interface CreateRecordResult {
+    status: "dry-run" | "created" | "skipped" | "failed";
+    table: string;
+    sysId: string;
+    scope: string;
+    updateSetSysId: string;
+    fields: Record<string, string>;
+    after: Record<string, string>;
+    verified: boolean;
+    note: string;
+}
+export declare function createRecord(params: CreateRecordParams): Promise<CreateRecordResult>;

package/dist/createRecord.js

@@ -0,0 +1,137 @@
+"use strict";
+/**
+ * dove-sn create-record — create ONE new record in a data table, captured
+ * into a specified update set, then read back and verify.
+ *
+ * Wraps the Dovetail core Scripted REST `createRecord` op, which switches the
+ * executing user's app scope and update set server-side, inserts, and
+ * restores both — so the record is owned by the right app and the insert is
+ * captured in the right update set without touching sys_user_preference.
+ * The INSERT counterpart to `set-field`.
+ *
+ * NOT for schema tables (sys_db_object / sys_dictionary) — that's
+ * create-table / add-column. To UPDATE an existing record, use `set-field`.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRecord = createRecord;
+const client_1 = require("./client");
+const setField_1 = require("./setField");
+// Same guard as set-field: schema tables are never written as data — routed to
+// the dedicated schema verbs instead so we never orphan or corrupt metadata.
+var REFUSED_TABLES = ["sys_db_object", "sys_dictionary"];
+async function createRecord(params) {
+    var client = params.client || (0, client_1.createClient)({});
+    var table = params.table;
+    if (!table) {
+        throw new Error("create-record: --table is required.");
+    }
+    if (REFUSED_TABLES.indexOf(table) !== -1) {
+        throw new Error("create-record: refusing to write " + table + " as data — it is a schema table. "
+            + "Use add-column / create-table for schema changes.");
+    }
+    var fieldNames = params.fields ? Object.keys(params.fields) : [];
+    if (fieldNames.length === 0) {
+        throw new Error("create-record: at least one field (--fields key=value) is required.");
+    }
+    if (!params.scope) {
+        throw new Error("create-record: --scope is required so the record is owned by the right app.");
+    }
+    if (!params.updateSetSysId) {
+        throw new Error("create-record: --update-set <sys_id> is required so the insert is captured.");
+    }
+    var readFields = ["sys_id"].concat(fieldNames);
+    // Idempotent re-runs: skip the insert when the guard query already matches.
+    if (params.ifAbsentQuery) {
+        var existing = await client.table.query(table, params.ifAbsentQuery, {
+            limit: 1,
+            fields: readFields
+        });
+        if (existing.length > 0) {
+            var existingSysId = (0, setField_1.fieldToString)(existing[0].sys_id);
+            var existingValues = (0, setField_1.pickFields)(existing[0], fieldNames);
+            var matches = true;
+            for (var i = 0; i < fieldNames.length; i += 1) {
+                if (existingValues[fieldNames[i]] !== (0, setField_1.fieldToString)(params.fields[fieldNames[i]])) {
+                    matches = false;
+                }
+            }
+            return {
+                status: "skipped",
+                table: table,
+                sysId: existingSysId,
+                scope: params.scope,
+                updateSetSysId: params.updateSetSysId,
+                fields: params.fields,
+                after: existingValues,
+                verified: matches,
+                note: matches
+                    ? "skipped: --if-absent matched " + table + "/" + existingSysId
+                        + " and its values already match."
+                    : "skipped: --if-absent matched " + table + "/" + existingSysId
+                        + " but its values differ from the requested fields — use set-field to update it."
+            };
+        }
+    }
+    if (params.dryRun) {
+        return {
+            status: "dry-run",
+            table: table,
+            sysId: "",
+            scope: params.scope,
+            updateSetSysId: params.updateSetSysId,
+            fields: params.fields,
+            after: {},
+            verified: false,
+            note: "dry-run: no write. Would create a " + table + " record with "
+                + JSON.stringify(params.fields) + " in scope " + params.scope
+                + ", captured into update set " + params.updateSetSysId + "."
+        };
+    }
+    // Insert via the scope- and update-set-aware core REST op.
+    var created = await client.claude.createRecord({
+        table: table,
+        fields: params.fields,
+        scope: params.scope,
+        update_set_sys_id: params.updateSetSysId
+    });
+    var sysId = (0, setField_1.fieldToString)(created && created.sys_id);
+    if (!sysId) {
+        return {
+            status: "failed",
+            table: table,
+            sysId: "",
+            scope: params.scope,
+            updateSetSysId: params.updateSetSysId,
+            fields: params.fields,
+            after: {},
+            verified: false,
+            note: "createRecord returned no sys_id — the insert may not have landed; check the instance."
+        };
+    }
+    // Read back and verify each field equals what we sent.
+    var afterRows = await client.table.query(table, "sys_id=" + sysId, {
+        limit: 1,
+        fields: readFields
+    });
+    var after = (0, setField_1.pickFields)(afterRows[0] || {}, fieldNames);
+    var verified = afterRows.length > 0;
+    for (var j = 0; j < fieldNames.length; j += 1) {
+        if (after[fieldNames[j]] !== (0, setField_1.fieldToString)(params.fields[fieldNames[j]])) {
+            verified = false;
+        }
+    }
+    return {
+        status: verified ? "created" : "failed",
+        table: table,
+        sysId: sysId,
+        scope: params.scope,
+        updateSetSysId: params.updateSetSysId,
+        fields: params.fields,
+        after: after,
+        verified: verified,
+        note: verified
+            ? "Created " + table + "/" + sysId + " and verified via read-back."
+            : "Insert landed as " + sysId
+                + " but read-back does not match the requested values — check field types / ACLs."
+    };
+}

package/dist/setField.d.ts

@@ -0,0 +1,41 @@
+/**
+ * dove-sn set-field — set scalar field value(s) on an EXISTING ServiceNow
+ * record, captured into a specified update set, then read back and verify.
+ *
+ * Wraps the Dovetail core Scripted REST `pushWithUpdateSet` op (update-set +
+ * scope switching handled atomically server-side), so the change lands in the
+ * right update set without touching sys_user_preference. This is the
+ * change-and-KEEP counterpart to sn-capture-fields' change-and-revert capture.
+ *
+ * NOT for schema tables (sys_db_object / sys_dictionary) — that's add-column /
+ * create-table. To INSERT a new record, use `dove create`.
+ */
+import type { ServiceNowClient } from "./client";
+export interface SetFieldParams {
+    client?: ServiceNowClient;
+    table: string;
+    /** Target record by sys_id, OR by a query that resolves to EXACTLY one row. */
+    sysId?: string;
+    query?: string;
+    /** Field name -> value to set. Values are sent as strings; ServiceNow coerces. */
+    fields: Record<string, string>;
+    /** Update set to capture the change into. Required for a tracked write. */
+    updateSetSysId?: string;
+    dryRun?: boolean;
+}
+export interface SetFieldResult {
+    status: "dry-run" | "applied" | "failed";
+    table: string;
+    sysId: string;
+    updateSetSysId: string;
+    fields: Record<string, string>;
+    before: Record<string, string>;
+    after: Record<string, string>;
+    verified: boolean;
+    note: string;
+}
+/** Coerce a Table-API field value to a comparable string. Reference/display
+ *  fields (sysparm_display_value=false) come back as { link, value } objects. */
+export declare function fieldToString(value: any): string;
+export declare function pickFields(row: Record<string, any>, names: Array<string>): Record<string, string>;
+export declare function setField(params: SetFieldParams): Promise<SetFieldResult>;

package/dist/setField.js

@@ -0,0 +1,121 @@
+"use strict";
+/**
+ * dove-sn set-field — set scalar field value(s) on an EXISTING ServiceNow
+ * record, captured into a specified update set, then read back and verify.
+ *
+ * Wraps the Dovetail core Scripted REST `pushWithUpdateSet` op (update-set +
+ * scope switching handled atomically server-side), so the change lands in the
+ * right update set without touching sys_user_preference. This is the
+ * change-and-KEEP counterpart to sn-capture-fields' change-and-revert capture.
+ *
+ * NOT for schema tables (sys_db_object / sys_dictionary) — that's add-column /
+ * create-table. To INSERT a new record, use `dove create`.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fieldToString = fieldToString;
+exports.pickFields = pickFields;
+exports.setField = setField;
+const client_1 = require("./client");
+// Platform/schema tables that must not be written as data — routed to the
+// dedicated schema verbs instead so we never orphan or corrupt metadata.
+var REFUSED_TABLES = ["sys_db_object", "sys_dictionary"];
+/** Coerce a Table-API field value to a comparable string. Reference/display
+ *  fields (sysparm_display_value=false) come back as { link, value } objects. */
+function fieldToString(value) {
+    if (value === undefined || value === null)
+        return "";
+    if (typeof value === "object") {
+        return value.value !== undefined && value.value !== null ? String(value.value) : "";
+    }
+    return String(value);
+}
+function pickFields(row, names) {
+    var out = {};
+    for (var i = 0; i < names.length; i += 1) {
+        out[names[i]] = fieldToString(row ? row[names[i]] : undefined);
+    }
+    return out;
+}
+async function setField(params) {
+    var client = params.client || (0, client_1.createClient)({});
+    var table = params.table;
+    if (!table) {
+        throw new Error("set-field: --table is required.");
+    }
+    if (REFUSED_TABLES.indexOf(table) !== -1) {
+        throw new Error("set-field: refusing to write " + table + " as data — it is a schema table. "
+            + "Use add-column / create-table for schema changes.");
+    }
+    var fieldNames = params.fields ? Object.keys(params.fields) : [];
+    if (fieldNames.length === 0) {
+        throw new Error("set-field: at least one field (--fields key=value) is required.");
+    }
+    if (!params.updateSetSysId) {
+        throw new Error("set-field: --update-set <sys_id> is required so the change is captured.");
+    }
+    // Resolve the target sys_id (explicit, or a single-match query).
+    var sysId = params.sysId;
+    if (!sysId) {
+        if (!params.query) {
+            throw new Error("set-field: one of --sys-id or --query is required.");
+        }
+        var matches = await client.table.query(table, params.query, { limit: 2, fields: ["sys_id"] });
+        if (matches.length === 0) {
+            throw new Error("set-field: --query matched no rows on " + table + ".");
+        }
+        if (matches.length > 1) {
+            throw new Error("set-field: --query matched 2+ rows on " + table + " — refine to exactly one.");
+        }
+        sysId = fieldToString(matches[0].sys_id);
+    }
+    // Read current values (also confirms the record exists).
+    var readFields = ["sys_id"].concat(fieldNames);
+    var beforeRows = await client.table.query(table, "sys_id=" + sysId, { limit: 1, fields: readFields });
+    if (beforeRows.length === 0) {
+        throw new Error("set-field: no record " + sysId + " found on " + table + ".");
+    }
+    var before = pickFields(beforeRows[0], fieldNames);
+    if (params.dryRun) {
+        return {
+            status: "dry-run",
+            table: table,
+            sysId: sysId,
+            updateSetSysId: params.updateSetSysId,
+            fields: params.fields,
+            before: before,
+            after: before,
+            verified: false,
+            note: "dry-run: no write. Would set " + JSON.stringify(params.fields)
+                + " on " + table + "/" + sysId + " into update set " + params.updateSetSysId + "."
+        };
+    }
+    // Write via the update-set-aware core REST op.
+    await client.claude.pushWithUpdateSet({
+        update_set_sys_id: params.updateSetSysId,
+        table: table,
+        record_sys_id: sysId,
+        fields: params.fields
+    });
+    // Read back and verify each field equals what we set.
+    var afterRows = await client.table.query(table, "sys_id=" + sysId, { limit: 1, fields: readFields });
+    var after = pickFields(afterRows[0] || {}, fieldNames);
+    var verified = true;
+    for (var j = 0; j < fieldNames.length; j += 1) {
+        if (after[fieldNames[j]] !== fieldToString(params.fields[fieldNames[j]])) {
+            verified = false;
+        }
+    }
+    return {
+        status: verified ? "applied" : "failed",
+        table: table,
+        sysId: sysId,
+        updateSetSysId: params.updateSetSysId,
+        fields: params.fields,
+        before: before,
+        after: after,
+        verified: verified,
+        note: verified
+            ? "Set " + fieldNames.join(", ") + " on " + table + "/" + sysId + " and verified via read-back."
+            : "Write landed but read-back does not match the requested values — check field types / ACLs."
+    };
+}

package/package.json

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