@tenonhq/dovetail-servicenow 0.0.21 → 0.0.23

package/dist/cli.js

@@ -79,6 +79,7 @@ const editFlow_1 = require("./flowDesigner/editFlow");
 const editActionType_1 = require("./flowDesigner/editActionType");
 const testFlow_1 = require("./flowDesigner/testFlow");
 const table_1 = require("./table");
+const hostAssets_1 = require("./hostAssets");
 const flowDesigner_formatter_2 = require("./flowDesigner-formatter");
 function parseArgs(argv) {
     var command = argv[0] || "";
@@ -706,6 +707,13 @@ function printHelp() {
         "                      --columns \"Label:type:max, ...\"  OR  --from-json <spec.json>\n" +
         "                      [--extends <t>] [--number-prefix <p>] [--user-role <r>]\n" +
         "                      [--no-acls] [--no-menu] [--update-set <sys_id>] [--dry-run] [--json])\n" +
+        "  add-column         Add ONE column to an EXISTING table via the Studio form save, then verify\n" +
+        "                     (--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" +
+        "  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" +
         "  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)\n" +
@@ -806,6 +814,109 @@ async function runCreateTable(flags) {
         return 2;
     return 0;
 }
+/**
+ * dove-sn add-column:
+ *   --table x_cadso_journey --label URL --type url
+ *   [--name url] [--max-length 1024] [--reference <table>]
+ *   [--scope x_cadso_journey] [--update-set <sys_id>] [--save-action <sys_id>]
+ *   [--columns-rel-id <sys_id>] [--from-json <spec.json>] [--dry-run] [--debug] [--json]
+ */
+async function runAddColumn(flags) {
+    var spec = {};
+    if (flags["from-json"]) {
+        spec = JSON.parse(fs.readFileSync(path.resolve(flags["from-json"]), "utf8"));
+    }
+    var table = flags.table || spec.table;
+    var column = spec.column;
+    if (flags.label || flags.type) {
+        column = { label: flags.label || "", type: flags.type || "string" };
+        if (flags.name)
+            column.name = flags.name;
+        if (flags["max-length"])
+            column.max_length = flags["max-length"];
+        if (flags.reference)
+            column.reference = flags.reference;
+    }
+    if (!table || !column || !column.label) {
+        process.stderr.write("add-column: --table and --label (with --type) are required (or --from-json)\n");
+        return 1;
+    }
+    var params = {
+        client: (0, client_1.createClient)({}),
+        table: table,
+        column: column
+    };
+    var scope = flags.scope || spec.scope;
+    if (scope)
+        params.scope = scope;
+    var us = flags["update-set"] || spec.updateSetSysId;
+    if (us)
+        params.updateSetSysId = us;
+    var sa = flags["save-action"] || spec.saveActionSysId;
+    if (sa)
+        params.saveActionSysId = sa;
+    var relId = flags["columns-rel-id"] || spec.columnsRelId;
+    if (relId)
+        params.columnsRelId = relId;
+    if (flags["dry-run"] === "true" || spec.dryRun === true)
+        params.dryRun = true;
+    if (flags.debug === "true" || spec.debug === true)
+        params.debug = true;
+    var result = await (0, table_1.addColumn)(params);
+    if (flags.json === "true") {
+        process.stdout.write(JSON.stringify(result, null, 2) + "\n");
+    }
+    else {
+        process.stdout.write("[" + result.status + "] " + result.table + "." + result.element + " (" + result.internalType + ")"
+            + (result.verified ? " — verified" : "")
+            + "\n" + result.note + "\n");
+    }
+    if (result.status === "failed")
+        return 2;
+    return 0;
+}
+/**
+ * dove-sn host-assets:
+ *   --dir <dist>            Required. Path to the pre-built dist/ directory.
+ *   --app <sys_id>          Required. Application record sys_id (m2m `application`).
+ *   --scope <namespace>     Required. Carrier scope, e.g. x_cadso_app_shell.
+ *   --update-set <sys_id>   Optional. Defaults to the scope's current update set.
+ *   --max-bytes <n>         Optional. Per-chunk serve cap (default ~5 MB).
+ *   --allow-oversize        Optional. Warn instead of failing on an oversize chunk.
+ *   --dry-run               Optional. Plan only; no writes/uploads/prunes.
+ *   --json                  Optional. Emit the structured HostAssetsResult.
+ *
+ * Exit codes: 0 done/dry-run, 1 bad args, 2 a write landed but read-back is unverified.
+ */
+async function runHostAssets(flags) {
+    var dir = flags.dir;
+    var app = flags.app;
+    var scope = flags.scope;
+    if (!dir || !app || !scope) {
+        process.stderr.write("host-assets: --dir, --app and --scope are required\n");
+        return 1;
+    }
+    var params = { dir: path.resolve(dir), app: app, scope: scope };
+    var us = flags["update-set"] || flags.updateSetSysId;
+    if (us)
+        params.updateSetSysId = us;
+    if (flags["max-bytes"])
+        params.maxBytes = Number(flags["max-bytes"]);
+    if (flags["allow-oversize"] === "true")
+        params.allowOversize = true;
+    if (flags["dry-run"] === "true")
+        params.dryRun = true;
+    var client = (0, client_1.createClient)({});
+    var result = await (0, hostAssets_1.hostAssets)(client, params);
+    if (flags.json === "true") {
+        process.stdout.write(JSON.stringify(result, null, 2) + "\n");
+    }
+    else {
+        process.stdout.write((0, hostAssets_1.formatHostAssetsResult)(result) + "\n");
+    }
+    var unverified = !result.dryRun && result.chunks.some(function (c) { return !c.verified; });
+    return unverified ? 2 : 0;
+}
 async function main() {
     var parsed = parseArgs(process.argv.slice(2));
     // Load credentials before any command runs. `--env`/`--env-file` (or the
@@ -837,6 +948,12 @@ async function main() {
     if (parsed.command === "create-table") {
         return await runCreateTable(parsed.flags);
     }
+    if (parsed.command === "add-column") {
+        return await runAddColumn(parsed.flags);
+    }
+    if (parsed.command === "host-assets") {
+        return await runHostAssets(parsed.flags);
+    }
     if (parsed.command === "test-flow") {
         return await runTestFlow(parsed.flags);
     }

package/dist/client.d.ts

@@ -34,6 +34,15 @@ export interface TableSchema {
     fields: Array<TableSchemaField>;
     primary_key: string;
 }
+/** A sys_attachment row, as returned by the native Attachment API. */
+export interface AttachmentMeta {
+    sys_id: string;
+    file_name: string;
+    content_type: string;
+    /** SHA-256 hex of the file content, computed by ServiceNow. Absent on older instances. */
+    hash?: string;
+    size_bytes?: string;
+}
 export interface ServiceNowClient {
     table: {
         /** GET /api/now/table/<t>?sysparm_query=...&sysparm_limit=N — returns result array. */
@@ -113,5 +122,31 @@ export interface ServiceNowClient {
         /** POST an arbitrary native ServiceNow REST path with a JSON body. See `get`. */
         post: <T = any>(path: string, body: any) => Promise<T>;
     };
+    attachment: {
+        /**
+         * GET /api/now/attachment?sysparm_query=table_name=<t>^table_sys_id=<id> —
+         * list the sys_attachment rows on a record. Read-only.
+         */
+        listFor: (params: {
+            table: string;
+            sysId: string;
+        }) => Promise<Array<AttachmentMeta>>;
+        /**
+         * POST /api/now/attachment/file — upload raw bytes as a sys_attachment on a record.
+         * The Buffer is sent verbatim with `contentType` as the request Content-Type (binary,
+         * not JSON). Reuses the shared auth/retry/throttle transport — not a bespoke HTTP path.
+         */
+        upload: (params: {
+            table: string;
+            sysId: string;
+            fileName: string;
+            contentType: string;
+            data: Buffer;
+        }) => Promise<AttachmentMeta>;
+        /** DELETE /api/now/attachment/<sysId> — remove a single attachment. */
+        remove: (params: {
+            sysId: string;
+        }) => Promise<void>;
+    };
 }
 export declare function createClient(config?: ServiceNowClientConfig): ServiceNowClient;

package/dist/client.js

@@ -316,6 +316,37 @@ function createClient(config = {}) {
             post: function (path, body) {
                 return request({ method: "POST", url: path, data: body }, "now.post(" + path + ")");
             }
+        },
+        attachment: {
+            listFor: async function (params) {
+                var data = await request({
+                    method: "GET",
+                    url: "/api/now/attachment",
+                    params: {
+                        sysparm_query: "table_name=" + params.table + "^table_sys_id=" + params.sysId,
+                        sysparm_fields: "sys_id,file_name,content_type,hash,size_bytes"
+                    }
+                }, "attachment.listFor(" + params.table + ")");
+                return (data && data.result) || [];
+            },
+            upload: async function (params) {
+                var data = await request({
+                    method: "POST",
+                    url: "/api/now/attachment/file",
+                    params: {
+                        table_name: params.table,
+                        table_sys_id: params.sysId,
+                        file_name: params.fileName
+                    },
+                    data: params.data,
+                    // Binary upload: override the client's default application/json.
+                    headers: { "content-type": params.contentType }
+                }, "attachment.upload(" + params.fileName + ")");
+                return (data && data.result) || data;
+            },
+            remove: async function (params) {
+                await request({ method: "DELETE", url: "/api/now/attachment/" + params.sysId }, "attachment.remove(" + params.sysId + ")");
+            }
         }
     };
 }

package/dist/hostAssets.d.ts

@@ -0,0 +1,44 @@
+/**
+ * hostAssets — deploy a pre-built front-end bundle to ServiceNow.
+ *
+ * For each chunk in a built dist/ (index.html + assets/*.{js,css}) this:
+ *   1. Upserts a carrier sys_ui_script named `app_shell_asset:<vite-relative-path>`.
+ *      The name carries the rotating hash on purpose — the Scripted REST serving
+ *      resource resolves an asset request to its carrier by this exact name, so the
+ *      verb's naming MUST match the path the built index.html references, or the
+ *      asset 404s on serve.
+ *   2. Stores the chunk's bytes as a sys_attachment on that record (the script field
+ *      caps at 65 KB; real chunks are far larger). Identical bytes are detected by
+ *      SHA-256 and left in place.
+ *   3. Wires an x_cadso_app_shell_m2m_app_script row (application, script, chunk_role,
+ *      order) so the app shell loads the chunk.
+ *   4. Prunes carriers + m2m rows for chunks no longer in the build — hashes rotate
+ *      every build, so last build's records would otherwise pile up.
+ *
+ * The sys_ui_script + m2m writes route through the Dovetail Scripted REST API and are
+ * captured in the target update set. Attachments are data, not customizations, so they
+ * are not part of the update set. Re-runnable per build, per instance; idempotent for
+ * an identical dist/.
+ *
+ * The serving layer streams each chunk via GlideSysAttachment.getContentStream(), capped
+ * at ~5 MB (glide.scriptable.excel.max_file_size). A chunk at/over the cap truncates on
+ * serve, so the verb fails fast on an oversize chunk unless allowOversize is set.
+ */
+import type { ServiceNowClient } from "./client";
+import type { ChunkInfo, HostAssetsParams, HostAssetsResult } from "./types";
+/**
+ * Classify build files into ordered ChunkInfo. Pure — no filesystem access — so the
+ * naming + role + order logic is unit-testable in isolation.
+ */
+export declare function classifyChunks(files: Array<{
+    viteRelPath: string;
+    ext: string;
+    isIndexHtml: boolean;
+}>): Array<ChunkInfo>;
+/**
+ * Deploy a built dist/ to ServiceNow as app-shell carrier scripts + attachments + m2m
+ * wiring. Idempotent; re-running an identical dist/ reports every chunk unchanged.
+ */
+export declare function hostAssets(client: ServiceNowClient, params: HostAssetsParams): Promise<HostAssetsResult>;
+/** Human-readable one-line-per-chunk summary for the CLI. */
+export declare function formatHostAssetsResult(r: HostAssetsResult): string;