@sonisoft/now-sdk-ext-core 6.6.3 → 6.8.0

package/dist/sn/workflow/WorkflowConversionModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkflowConversionModels.js","sourceRoot":"","sources":["../../../src/sn/workflow/WorkflowConversionModels.ts"],"names":[],"mappings":""}

package/dist/sn/workflow/WorkflowDiagramClient.d.ts

@@ -0,0 +1,70 @@
+import { ServiceNowInstance } from "../ServiceNowInstance.js";
+import { DiagramProcessorMessages, GraphNodeInput } from "./WorkflowGraphML.js";
+import { WorkflowGraph, WorkflowGraphEdge } from "./WorkflowModels.js";
+/**
+ * Client for the Workflow Editor's diagram processor — the endpoint the legacy Workflow
+ * Editor canvas uses for every structural change (`POST /xmlhttp.do` with
+ * `sysparm_processor=com.glideapp.workflow.ui.WorkflowDiagramProcessor`).
+ *
+ * Going through it, rather than writing wf_* records directly, is what gets the
+ * platform's own behaviour: checkout's deep copy of a version, publish's validation,
+ * path computation and version swap, and node deletes that clean up exits and variables.
+ *
+ * Low level: no argument resolution or permission checks. Use WorkflowManager.
+ */
+export declare class WorkflowDiagramClient {
+    private _instance;
+    constructor(instance: ServiceNowInstance);
+    /** Read a version's diagram, including what the current user may do with it. */
+    get(versionSysId: string): Promise<WorkflowGraph>;
+    /** Read one activity's node and its exits. */
+    getNode(activitySysId: string): Promise<WorkflowGraph>;
+    /**
+     * Check out a published version: creates a new draft version (a deep copy of
+     * activities, exits, transitions, variables and stages) checked out to the caller.
+     *
+     * @returns The draft's diagram (`id` is the new version's sys_id)
+     */
+    checkout(versionSysId: string, name: string): Promise<WorkflowGraph>;
+    /** Take over a checkout held by another user. */
+    forceCheckout(versionSysId: string): Promise<WorkflowGraph>;
+    /**
+     * Publish a draft. With `validate`, validation findings are returned instead of
+     * publishing when there are any Warn or Critical results.
+     */
+    publish(versionSysId: string, validate: boolean): Promise<{
+        graph?: WorkflowGraph;
+        messages: DiagramProcessorMessages;
+    }>;
+    /**
+     * Delete a version. Deleting a draft discards the checkout; deleting a workflow's
+     * last version deletes the workflow.
+     */
+    delete(versionSysId: string): Promise<void>;
+    /** Set the workflow active or inactive. */
+    setActive(versionSysId: string, active: boolean): Promise<void>;
+    /** Reposition activities. */
+    moveNodes(versionSysId: string, nodes: GraphNodeInput[]): Promise<void>;
+    /** Add a transition. The edge id becomes the wf_transition sys_id. */
+    newEdge(versionSysId: string, edge: WorkflowGraphEdge): Promise<void>;
+    /** Re-point an existing transition. */
+    changeEdge(versionSysId: string, edge: WorkflowGraphEdge): Promise<void>;
+    /** Remove a transition. */
+    deleteEdge(versionSysId: string, edge: WorkflowGraphEdge): Promise<void>;
+    /**
+     * What the editor sends when an activity is dropped onto a line: position the node,
+     * re-point the existing transitions, and add the new ones.
+     */
+    newEdgeControlNode(versionSysId: string, node: GraphNodeInput, changedEdges: WorkflowGraphEdge[], newEdges: WorkflowGraphEdge[]): Promise<void>;
+    /**
+     * Delete an activity together with its exits and variables, removing, re-pointing
+     * and adding transitions as given.
+     */
+    deleteNode(versionSysId: string, activitySysId: string, deleteEdges: WorkflowGraphEdge[], changedEdges?: WorkflowGraphEdge[], newEdges?: WorkflowGraphEdge[]): Promise<void>;
+    /** Recompute stage assignments after activities change (the editor calls this after every activity save). */
+    updateStages(versionSysId: string): Promise<void>;
+    private edges;
+    private requireGraph;
+    private call;
+    private request;
+}

package/dist/sn/workflow/WorkflowDiagramClient.js

@@ -0,0 +1,151 @@
+import { SessionManager } from "../../comm/http/SessionManager.js";
+import { READ_ONLY } from "../../policy/PolicyTypes.js";
+import { redactMessage, stripSecretsFromError } from "../../util/redact.js";
+import { parseDiagramResponse, serializeGraph } from "./WorkflowGraphML.js";
+const PROCESSOR = "com.glideapp.workflow.ui.WorkflowDiagramProcessor";
+/**
+ * Client for the Workflow Editor's diagram processor — the endpoint the legacy Workflow
+ * Editor canvas uses for every structural change (`POST /xmlhttp.do` with
+ * `sysparm_processor=com.glideapp.workflow.ui.WorkflowDiagramProcessor`).
+ *
+ * Going through it, rather than writing wf_* records directly, is what gets the
+ * platform's own behaviour: checkout's deep copy of a version, publish's validation,
+ * path computation and version swap, and node deletes that clean up exits and variables.
+ *
+ * Low level: no argument resolution or permission checks. Use WorkflowManager.
+ */
+export class WorkflowDiagramClient {
+    _instance;
+    constructor(instance) {
+        this._instance = instance;
+    }
+    /** Read a version's diagram, including what the current user may do with it. */
+    async get(versionSysId) {
+        return this.requireGraph(await this.call("get", { id: versionSysId }, true), "get");
+    }
+    /** Read one activity's node and its exits. */
+    async getNode(activitySysId) {
+        return this.requireGraph(await this.call("getnode", { id: activitySysId }, true), "getnode");
+    }
+    /**
+     * Check out a published version: creates a new draft version (a deep copy of
+     * activities, exits, transitions, variables and stages) checked out to the caller.
+     *
+     * @returns The draft's diagram (`id` is the new version's sys_id)
+     */
+    async checkout(versionSysId, name) {
+        return this.requireGraph(await this.call("checkout", { sys_id: versionSysId, name }), "checkout");
+    }
+    /** Take over a checkout held by another user. */
+    async forceCheckout(versionSysId) {
+        return this.requireGraph(await this.call("forcecheckout", { sys_id: versionSysId }), "forcecheckout");
+    }
+    /**
+     * Publish a draft. With `validate`, validation findings are returned instead of
+     * publishing when there are any Warn or Critical results.
+     */
+    async publish(versionSysId, validate) {
+        const parsed = await this.call(validate ? "publish" : "publish_novalidate", { sys_id: versionSysId });
+        return { graph: parsed.graph, messages: parsed.messages };
+    }
+    /**
+     * Delete a version. Deleting a draft discards the checkout; deleting a workflow's
+     * last version deletes the workflow.
+     */
+    async delete(versionSysId) {
+        await this.call("delete", { sys_id: versionSysId });
+    }
+    /** Set the workflow active or inactive. */
+    async setActive(versionSysId, active) {
+        await this.call(active ? "activate" : "inactivate", { sys_id: versionSysId });
+    }
+    /** Reposition activities. */
+    async moveNodes(versionSysId, nodes) {
+        await this.call("movenodes", { id: versionSysId, xml: serializeGraph(versionSysId, { nodes }) });
+    }
+    /** Add a transition. The edge id becomes the wf_transition sys_id. */
+    async newEdge(versionSysId, edge) {
+        await this.call("newedge", { id: versionSysId, xml: serializeGraph(versionSysId, { edges: [edge] }) });
+    }
+    /** Re-point an existing transition. */
+    async changeEdge(versionSysId, edge) {
+        await this.call("changeedge", { id: versionSysId, xml: serializeGraph(versionSysId, { edges: [edge] }) });
+    }
+    /** Remove a transition. */
+    async deleteEdge(versionSysId, edge) {
+        await this.call("deleteedge", { id: versionSysId, xml: serializeGraph(versionSysId, { edges: [edge] }) });
+    }
+    /**
+     * What the editor sends when an activity is dropped onto a line: position the node,
+     * re-point the existing transitions, and add the new ones.
+     */
+    async newEdgeControlNode(versionSysId, node, changedEdges, newEdges) {
+        await this.call("newedgecontrolnode", {
+            id: versionSysId,
+            xml: serializeGraph(versionSysId, { nodes: [node] }),
+            changed_edges: this.edges(versionSysId, changedEdges),
+            new_edges: this.edges(versionSysId, newEdges),
+        });
+    }
+    /**
+     * Delete an activity together with its exits and variables, removing, re-pointing
+     * and adding transitions as given.
+     */
+    async deleteNode(versionSysId, activitySysId, deleteEdges, changedEdges = [], newEdges = []) {
+        await this.call("deletenode", {
+            id: versionSysId,
+            xml: serializeGraph(versionSysId, { nodes: [{ id: activitySysId }] }),
+            delete_edges: this.edges(versionSysId, deleteEdges),
+            changed_edges: this.edges(versionSysId, changedEdges),
+            new_edges: this.edges(versionSysId, newEdges),
+        });
+    }
+    /** Recompute stage assignments after activities change (the editor calls this after every activity save). */
+    async updateStages(versionSysId) {
+        await this.call("updatestages", { id: versionSysId });
+    }
+    edges(versionSysId, edges) {
+        return edges.length ? serializeGraph(versionSysId, { edges }) : "";
+    }
+    requireGraph(parsed, type) {
+        if (!parsed.graph)
+            throw new Error(`The workflow diagram processor returned no diagram for '${type}'`);
+        return parsed.graph;
+    }
+    async call(type, params, readOnly = false) {
+        try {
+            const response = await this.request().post({
+                method: "POST", path: "/xmlhttp.do", headers: null, query: null, body: null,
+                responseFormat: "text",
+                ...(readOnly ? { requires: READ_ONLY } : {}),
+                fields: {
+                    sysparm_processor: PROCESSOR,
+                    sysparm_scope: "global",
+                    sysparm_want_session_messages: "true",
+                    sysparm_type: type,
+                    ...params,
+                },
+            });
+            const body = typeof response.data === "string" ? response.data : "";
+            if (!/<xml[\s>]/.test(body) || !body.includes(PROCESSOR)) {
+                throw new Error(`The workflow diagram processor did not answer '${type}' (the session may have expired)`);
+            }
+            const parsed = parseDiagramResponse(body);
+            if (parsed.messages.duplicateName)
+                throw new Error(parsed.messages.duplicateName);
+            if (parsed.messages.differentDomain)
+                throw new Error(parsed.messages.differentDomain);
+            return { graph: parsed.graph, messages: parsed.messages };
+        }
+        catch (error) {
+            if (error instanceof Error)
+                error.message = redactMessage(error.message);
+            throw stripSecretsFromError(error);
+        }
+    }
+    request() {
+        // Shares the Table API's session, so reads and processor writes see the same user state.
+        return SessionManager.getInstance().getRequest(this._instance);
+    }
+}
+//# sourceMappingURL=WorkflowDiagramClient.js.map

package/dist/sn/workflow/WorkflowDiagramClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkflowDiagramClient.js","sourceRoot":"","sources":["../../../src/sn/workflow/WorkflowDiagramClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAEhE,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAC;AAEzE,OAAO,EAA4C,oBAAoB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAGnH,MAAM,SAAS,GAAG,mDAAmD,CAAC;AAEtE;;;;;;;;;;GAUG;AACH,MAAM,OAAO,qBAAqB;IACtB,SAAS,CAAqB;IAEtC,YAAmB,QAA4B;QAC3C,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC9B,CAAC;IAED,gFAAgF;IACzE,KAAK,CAAC,GAAG,CAAC,YAAoB;QACjC,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IACxF,CAAC;IAED,8CAA8C;IACvC,KAAK,CAAC,OAAO,CAAC,aAAqB;QACtC,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,EAAE,EAAE,aAAa,EAAE,EAAE,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;IACjG,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CAAC,YAAoB,EAAE,IAAY;QACpD,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,EAAE,UAAU,CAAC,CAAC;IACtG,CAAC;IAED,iDAAiD;IAC1C,KAAK,CAAC,aAAa,CAAC,YAAoB;QAC3C,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,EAAE,eAAe,CAAC,CAAC;IAC1G,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,YAAoB,EAAE,QAAiB;QACxD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAoB,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;QACtG,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CAAC,YAAoB;QACpC,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;IACxD,CAAC;IAED,2CAA2C;IACpC,KAAK,CAAC,SAAS,CAAC,YAAoB,EAAE,MAAe;QACxD,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;IAClF,CAAC;IAED,6BAA6B;IACtB,KAAK,CAAC,SAAS,CAAC,YAAoB,EAAE,KAAuB;QAChE,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,cAAc,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;IACrG,CAAC;IAED,sEAAsE;IAC/D,KAAK,CAAC,OAAO,CAAC,YAAoB,EAAE,IAAuB;QAC9D,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,cAAc,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC3G,CAAC;IAED,uCAAuC;IAChC,KAAK,CAAC,UAAU,CAAC,YAAoB,EAAE,IAAuB;QACjE,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,cAAc,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC9G,CAAC;IAED,2BAA2B;IACpB,KAAK,CAAC,UAAU,CAAC,YAAoB,EAAE,IAAuB;QACjE,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,cAAc,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAC9G,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,kBAAkB,CAC3B,YAAoB,EACpB,IAAoB,EACpB,YAAiC,EACjC,QAA6B;QAE7B,MAAM,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE;YAClC,EAAE,EAAE,YAAY;YAChB,GAAG,EAAE,cAAc,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACpD,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,YAAY,CAAC;YACrD,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,QAAQ,CAAC;SAChD,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,UAAU,CACnB,YAAoB,EACpB,aAAqB,EACrB,WAAgC,EAChC,eAAoC,EAAE,EACtC,WAAgC,EAAE;QAElC,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YAC1B,EAAE,EAAE,YAAY;YAChB,GAAG,EAAE,cAAc,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;YACrE,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,WAAW,CAAC;YACnD,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,YAAY,CAAC;YACrD,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,QAAQ,CAAC;SAChD,CAAC,CAAC;IACP,CAAC;IAED,6GAA6G;IACtG,KAAK,CAAC,YAAY,CAAC,YAAoB;QAC1C,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC;IAC1D,CAAC;IAEO,KAAK,CAAC,YAAoB,EAAE,KAA0B;QAC1D,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,CAAC;IAEO,YAAY,CAAC,MAAqE,EAAE,IAAY;QACpG,IAAI,CAAC,MAAM,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,2DAA2D,IAAI,GAAG,CAAC,CAAC;QACvG,OAAO,MAAM,CAAC,KAAK,CAAC;IACxB,CAAC;IAEO,KAAK,CAAC,IAAI,CACd,IAAY,EACZ,MAA8B,EAC9B,QAAQ,GAAG,KAAK;QAEhB,IAAI,CAAC;YACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAS;gBAC/C,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI;gBAC3E,cAAc,EAAE,MAAM;gBACtB,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5C,MAAM,EAAE;oBACJ,iBAAiB,EAAE,SAAS;oBAC5B,aAAa,EAAE,QAAQ;oBACvB,6BAA6B,EAAE,MAAM;oBACrC,YAAY,EAAE,IAAI;oBAClB,GAAG,MAAM;iBACZ;aACJ,CAAC,CAAC;YACH,MAAM,IAAI,GAAG,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YACpE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBACvD,MAAM,IAAI,KAAK,CAAC,kDAAkD,IAAI,kCAAkC,CAAC,CAAC;YAC9G,CAAC;YACD,MAAM,MAAM,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;YAC1C,IAAI,MAAM,CAAC,QAAQ,CAAC,aAAa;gBAAE,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YAClF,IAAI,MAAM,CAAC,QAAQ,CAAC,eAAe;gBAAE,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;YACtF,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC;QAC9D,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,IAAI,KAAK,YAAY,KAAK;gBAAE,KAAK,CAAC,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACzE,MAAM,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC;IACL,CAAC;IAEO,OAAO;QACX,yFAAyF;QACzF,OAAO,cAAc,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnE,CAAC;CACJ"}

package/dist/sn/workflow/WorkflowFlowConversion.d.ts

@@ -0,0 +1,19 @@
+import { WorkflowExport } from "./WorkflowModels.js";
+import { FlowConversionPlan, FlowPlanCondition } from "./WorkflowConversionModels.js";
+/** Whether generated code cannot use this name as a binding. */
+export declare function isReservedIdentifier(name: string): boolean;
+/** Text placed in a template literal as is: backslashes, backticks and `${` escaped. */
+export declare function templateLiteralText(text: string): string;
+/** A code-safe lowercase identifier from free text. */
+export declare function identifierFrom(text: string, max?: number): string;
+/**
+ * Plan a Flow Designer flow (or subflow) for a legacy workflow export.
+ */
+export declare function planFlowConversion(data: WorkflowExport): FlowConversionPlan;
+/**
+ * Convert an encoded query on the workflow's record into a flow condition. Terms on catalog
+ * variables or with `javascript:` values cannot become data pills and leave it underived.
+ */
+export declare function encodedQueryToCondition(query: string, recordPill: string, display?: string): FlowPlanCondition;
+/** The plan as readable text: trigger, flow body, notes and the open decisions. */
+export declare function renderFlowPlan(plan: FlowConversionPlan): string;