@uipath/maestro-builder-sdk 6.33.1 → 6.33.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9,6 +9,8 @@ export interface FlowGlobalDeclaration {
9
9
  subType?: string;
10
10
  schema?: Record<string, unknown>;
11
11
  }
12
+ /** The keys of `variables` that hold declarations rather than name one (the map spelling). */
13
+ export declare const CONTAINER_KEYS: ReadonlySet<string>;
12
14
  /** Read both supported Flow variable spellings into one declaration table. */
13
15
  export declare function readFlowGlobals(variables: unknown, strict?: boolean): FlowGlobalDeclaration[];
14
16
  /** The declaration fields `planFlowGlobals` reads (structurally a `VarDecl`). */
@@ -1,5 +1,6 @@
1
1
  import { globalNameCollisionMessage, globalNameCollisions } from './core/global-names.js';
2
- const CONTAINER_KEYS = new Set(['globals', 'nodes', 'variableUpdates']);
2
+ /** The keys of `variables` that hold declarations rather than name one (the map spelling). */
3
+ export const CONTAINER_KEYS = new Set(['globals', 'nodes', 'variableUpdates']);
3
4
  const DIRECTIONS = new Set(['in', 'out', 'inout']);
4
5
  /** Read both supported Flow variable spellings into one declaration table. */
5
6
  export function readFlowGlobals(variables, strict = false) {
@@ -33,7 +33,7 @@ interface RtFlow {
33
33
  /** One difference, or one inconsistency in the merged file. */
34
34
  export interface MergeFinding {
35
35
  /** Which comparison found it. */
36
- kind: 'node-removed' | 'node-added' | 'node-type' | 'implicit-end' | 'edge-handle-renamed' | 'edge-rewired' | 'edge-removed' | 'edge-added' | 'handle-ids' | 'binding-removed' | 'binding-added' | 'undeclared-handle' | 'duplicate-binding' | 'agent-sidecar' | 'agent-storage' | 'agent-prompt-input' | 'agent-embedded-edit';
36
+ kind: 'node-removed' | 'node-added' | 'node-type' | 'implicit-end' | 'edge-handle-renamed' | 'edge-rewired' | 'edge-removed' | 'edge-added' | 'handle-ids' | 'binding-removed' | 'binding-added' | 'variable-added' | 'variable-changed' | 'undeclared-handle' | 'duplicate-binding' | 'agent-sidecar' | 'agent-storage' | 'agent-prompt-input' | 'agent-embedded-edit';
37
37
  /** The finding, phrased for the author, naming the node, edge or row. */
38
38
  message: string;
39
39
  /**
@@ -27,7 +27,10 @@
27
27
  * - switch case ids and human-task outcome ids, which name the handles the
28
28
  * edges leave from;
29
29
  * - binding rows by what they bind (`core/binding-identity.ts`), never by the
30
- * row `id`.
30
+ * row `id`;
31
+ * - root `variables` entries (`globals`, `nodes`) by id. Merge restores an
32
+ * entry the author did not touch (merge-variables.ts), so this reports only
33
+ * what slipped past that rule, such as a section taken whole.
31
34
  *
32
35
  * Two checks run on the MERGED file whatever the baseline says, because merge
33
36
  * mixes sources (untouched nodes from the original, edges from the edited file):
@@ -52,6 +55,7 @@
52
55
  import { bindingIdentity } from './core/binding-identity.js';
53
56
  import { expandSourceHandles } from './core/definition-handles.js';
54
57
  import { OUTCOME_HANDLE_NODE_TYPES } from './core/hitl-routing.js';
58
+ import { isDeltaSpelling, stableJson } from './merge-variables.js';
55
59
  /** A file's definitions, keyed `nodeType@version`. */
56
60
  function defsOf(f) {
57
61
  const out = new Map();
@@ -276,6 +280,33 @@ export function roundTripFindings(original, baseline, merged) {
276
280
  out.push({ kind: 'binding-added', refuses: true, message: `the round trip adds a binding row for ${bindingText(r)}; merge will write it.` });
277
281
  }
278
282
  }
283
+ // ── Root variables, by section and id ──
284
+ // A map-spelled original is taken whole on any edit (merge-variables.ts), so
285
+ // what that carries is reported but never refused: the author cannot avoid it.
286
+ const refuses = isDeltaSpelling(original.variables);
287
+ const tail = refuses ? '' : ' (the original uses the map spelling, so merge takes the edited section whole; not refused under --strict)';
288
+ for (const section of ['globals', 'nodes']) {
289
+ const entries = (f) => {
290
+ const list = f.variables?.[section];
291
+ return new Map((Array.isArray(list) ? list : [])
292
+ .filter((v) => typeof v?.id === 'string').map((v) => [v.id, v]));
293
+ };
294
+ const o = entries(original);
295
+ const b = entries(baseline);
296
+ const m = entries(merged);
297
+ for (const [id, bv] of b) {
298
+ const mv = m.get(id);
299
+ const ov = o.get(id);
300
+ if (mv === undefined || stableJson(mv) !== stableJson(bv) || (ov !== undefined && stableJson(ov) === stableJson(bv)))
301
+ continue;
302
+ if (ov === undefined) {
303
+ out.push({ kind: 'variable-added', refuses, message: `the round trip adds variables.${section} "${id}"; merge will write it${tail}.` });
304
+ continue;
305
+ }
306
+ const fields = [...new Set([...Object.keys(ov), ...Object.keys(bv)])].filter((k) => stableJson(ov[k]) !== stableJson(bv[k]));
307
+ out.push({ kind: 'variable-changed', refuses, message: `the round trip rewrites ${fields.join(', ')} of variables.${section} "${id}"; merge will write it${tail}.` });
308
+ }
309
+ }
279
310
  return out;
280
311
  }
281
312
  /** The source handles a node's definition declares, or `undefined` when they cannot be known. */
@@ -0,0 +1,19 @@
1
+ type Json = unknown;
2
+ /** JSON with object keys sorted, so key order is not a difference. */
3
+ export declare function stableJson(v: Json): string;
4
+ /**
5
+ * Whether `variables` is spelled the way the delta reads it: absent, or an
6
+ * object whose keys are only the container keys (`globals`, `nodes`,
7
+ * `variableUpdates`). A map-spelled original is not, and is taken whole.
8
+ */
9
+ export declare function isDeltaSpelling(variables: Json): boolean;
10
+ /**
11
+ * The merged root `variables`. `goneNodeIds` are the original's nodes (root and
12
+ * subflows) the merged file no longer has: a node variable, or a
13
+ * `variableUpdates` key, kept from the original for one of them is dropped
14
+ * with the node.
15
+ */
16
+ export declare function mergeVariables(original: Json, edited: Json, baseline: {
17
+ variables?: Json;
18
+ } | undefined, goneNodeIds: Set<string>): Json;
19
+ export {};
@@ -0,0 +1,191 @@
1
+ /**
2
+ * merge-variables — the delta rule for a flow's root `variables` (#1261).
3
+ *
4
+ * Nodes merge as a delta: one the author did not touch (edited equals
5
+ * baseline) is restored from the original. `variables` follow the same rule.
6
+ *
7
+ * The same rule, applied at three levels:
8
+ *
9
+ * - the whole section: edited equals baseline → the original's, verbatim;
10
+ * - a top-level key (`globals`, `nodes`, `variableUpdates`): edited equals
11
+ * baseline → the original's (absent stays absent);
12
+ * - an entry of an id-keyed list (`globals`, `nodes`) or a key of a map
13
+ * (`variableUpdates`): the same, and inside an entry each field the same,
14
+ * so an edited global's new `type` lands without the `name` compile adds.
15
+ *
16
+ * Presence follows the same logic. An entry the edited file lacks was removed
17
+ * by the author when the baseline has it, and lost by the round trip when it
18
+ * does not (kept). An entry the original lacks is the author's when the
19
+ * baseline lacks it or differs, and the round trip's when the baseline has it
20
+ * unchanged (dropped).
21
+ *
22
+ * Example, after the author changes `creditAmount`'s type and nothing else:
23
+ *
24
+ * original { id: 'creditAmount', direction: 'out', type: 'string' }
25
+ * baseline { id: 'creditAmount', name: 'creditAmount', direction: 'out', type: 'string' }
26
+ * edited { id: 'creditAmount', name: 'creditAmount', direction: 'out', type: 'number' }
27
+ * merged { id: 'creditAmount', direction: 'out', type: 'number' }
28
+ *
29
+ * An original with no `variables` section, or with no `globals` / `nodes` /
30
+ * `variableUpdates` key, is treated as empty there: what compile minted for
31
+ * the untouched part is still the round trip's, and only the author's
32
+ * additions land.
33
+ *
34
+ * Without a baseline there is nothing to tell an edit from the round trip, so
35
+ * the edited section is taken whole. So is a section whose original uses a key
36
+ * this file does not know (the older map spelling, `variables.city = {...}`)
37
+ * once the author changed anything: mixing two spellings in one section is
38
+ * worse than taking the compile's. The round-trip report still lists what that
39
+ * carries, but does not refuse it under `--strict`, because the author cannot
40
+ * avoid it short of making no edit ({@link isDeltaSpelling}).
41
+ */
42
+ import { jsonClone } from './core/json-clone.js';
43
+ import { CONTAINER_KEYS } from './flow-variables.js';
44
+ /** `jsonClone`, which also passes `undefined` (an absent section or key) through. */
45
+ const copy = (v) => (v === undefined ? v : jsonClone(v));
46
+ const isObj = (v) => typeof v === 'object' && v !== null && !Array.isArray(v);
47
+ /** JSON with object keys sorted, so key order is not a difference. */
48
+ export function stableJson(v) {
49
+ return JSON.stringify(v, (_k, val) => (isObj(val)
50
+ ? Object.fromEntries(Object.keys(val).sort().map((k) => [k, val[k]]))
51
+ : val));
52
+ }
53
+ const same = (a, b) => stableJson(a) === stableJson(b);
54
+ /**
55
+ * Whether `variables` is spelled the way the delta reads it: absent, or an
56
+ * object whose keys are only the container keys (`globals`, `nodes`,
57
+ * `variableUpdates`). A map-spelled original is not, and is taken whole.
58
+ */
59
+ export function isDeltaSpelling(variables) {
60
+ return variables === undefined || (isObj(variables) && Object.keys(variables).every((k) => CONTAINER_KEYS.has(k)));
61
+ }
62
+ /**
63
+ * The merged root `variables`. `goneNodeIds` are the original's nodes (root and
64
+ * subflows) the merged file no longer has: a node variable, or a
65
+ * `variableUpdates` key, kept from the original for one of them is dropped
66
+ * with the node.
67
+ */
68
+ export function mergeVariables(original, edited, baseline, goneNodeIds) {
69
+ if (!baseline)
70
+ return copy(edited);
71
+ const base = baseline.variables;
72
+ if (same(edited, base))
73
+ return withoutGoneUpdates(copy(original), goneNodeIds);
74
+ if (!isDeltaSpelling(original) || !isObj(edited))
75
+ return copy(edited);
76
+ const orig = isObj(original) ? original : {};
77
+ const baseObj = isObj(base) ? base : {};
78
+ const out = {};
79
+ for (const key of keysInOrder(orig, edited)) {
80
+ const updates = key === 'variableUpdates';
81
+ const inner = updates
82
+ ? (o, b, e) => (isObj(o) && isObj(e) ? mergeFields(o, isObj(b) ? b : undefined, e) : copy(e))
83
+ : (o, b, e) => mergeList(o, b, e, goneNodeIds);
84
+ // A section the original lacks but the round trip writes is merged as an
85
+ // empty one, so its minted entries stay out and only the author's land.
86
+ const absent = !(key in orig) && key in baseObj && key in edited && !same(edited[key], baseObj[key]);
87
+ const value = absent
88
+ ? nonEmpty(inner(updates ? {} : [], baseObj[key], edited[key]))
89
+ : mergeKey(orig[key], baseObj[key], edited[key], key in orig, key in baseObj, key in edited, inner);
90
+ if (value !== undefined)
91
+ out[key] = value;
92
+ }
93
+ if (original === undefined && Object.keys(out).length === 0)
94
+ return undefined;
95
+ return withoutGoneUpdates(out, goneNodeIds);
96
+ }
97
+ /** `undefined` for an empty list or map, so an absent section stays absent. */
98
+ function nonEmpty(v) {
99
+ if (Array.isArray(v))
100
+ return v.length ? v : undefined;
101
+ if (isObj(v))
102
+ return Object.keys(v).length ? v : undefined;
103
+ return v;
104
+ }
105
+ /**
106
+ * `variables` without the `variableUpdates` keys (node ids) of nodes the merge
107
+ * dropped. A key the round trip lost is kept from the original, so without
108
+ * this it would outlive its node.
109
+ */
110
+ function withoutGoneUpdates(variables, goneNodeIds) {
111
+ const updates = isObj(variables) ? variables.variableUpdates : undefined;
112
+ if (!isObj(updates) || !Object.keys(updates).some((k) => goneNodeIds.has(k)))
113
+ return variables;
114
+ return { ...variables, variableUpdates: Object.fromEntries(Object.entries(updates).filter(([k]) => !goneNodeIds.has(k))) };
115
+ }
116
+ /** Original's keys in its order, then the edited file's new ones. */
117
+ function keysInOrder(original, edited) {
118
+ return [...Object.keys(original), ...Object.keys(edited).filter((k) => !(k in original))];
119
+ }
120
+ /**
121
+ * One key's value under the delta rule; `undefined` = leave the key out.
122
+ * `inner` merges a value both sides have and the author changed.
123
+ */
124
+ function mergeKey(o, b, e, inOriginal, inBaseline, inEdited, inner) {
125
+ if (!inEdited)
126
+ return inBaseline || !inOriginal ? undefined : copy(o); // removed by the author / lost by the round trip
127
+ if (inBaseline && same(e, b))
128
+ return inOriginal ? copy(o) : undefined; // untouched
129
+ if (!inOriginal)
130
+ return copy(e); // the author's addition
131
+ return inner(o, b, e);
132
+ }
133
+ /** An id-keyed list (`globals`, `nodes`): per entry, then per field. */
134
+ function mergeList(o, b, e, goneNodeIds) {
135
+ if (!idList(o) || !idList(e))
136
+ return copy(e);
137
+ const base = new Map((idList(b) ? b : []).map((x) => [x.id, x]));
138
+ const edits = new Map(e.map((x) => [x.id, x]));
139
+ const out = [];
140
+ for (const entry of o) {
141
+ const id = entry.id;
142
+ if (!edits.has(id)) {
143
+ // The author removed it (baseline has it), or the round trip lost it; a
144
+ // lost node variable whose node is gone goes with the node.
145
+ if (!base.has(id) && !boundToGoneNode(entry, goneNodeIds))
146
+ out.push(copy(entry));
147
+ continue;
148
+ }
149
+ const ed = edits.get(id);
150
+ out.push(base.has(id) && same(ed, base.get(id)) ? copy(entry) : mergeFields(entry, base.get(id), ed));
151
+ }
152
+ const originalIds = new Set(o.map((x) => x.id));
153
+ for (const [i, ed] of e.entries()) {
154
+ const id = ed.id;
155
+ if (originalIds.has(id) || (base.has(id) && same(ed, base.get(id))))
156
+ continue; // kept above / minted by the round trip
157
+ out.splice(insertAt(out, e, i), 0, copy(ed));
158
+ }
159
+ return out;
160
+ }
161
+ /** After the nearest earlier edited entry already in `out`, else first. */
162
+ function insertAt(out, edited, i) {
163
+ for (let j = i - 1; j >= 0; j--) {
164
+ const at = out.findIndex((x) => x.id === edited[j].id);
165
+ if (at >= 0)
166
+ return at + 1;
167
+ }
168
+ return 0;
169
+ }
170
+ /**
171
+ * An object the author changed — a list entry, or the `variableUpdates` map
172
+ * (keyed by node id): each key under the delta rule, each value taken whole,
173
+ * keys in the original's order.
174
+ */
175
+ function mergeFields(o, b, e) {
176
+ const base = b ?? {};
177
+ const out = {};
178
+ for (const key of keysInOrder(o, e)) {
179
+ const v = mergeKey(o[key], base[key], e[key], key in o, key in base, key in e, (_o, _b, ev) => copy(ev));
180
+ if (v !== undefined)
181
+ out[key] = v;
182
+ }
183
+ return out;
184
+ }
185
+ function idList(v) {
186
+ return Array.isArray(v) && v.every((x) => isObj(x) && typeof x.id === 'string');
187
+ }
188
+ function boundToGoneNode(entry, goneNodeIds) {
189
+ const nodeId = isObj(entry.binding) ? entry.binding.nodeId : undefined;
190
+ return typeof nodeId === 'string' && goneNodeIds.has(nodeId);
191
+ }
package/dist/merge.d.ts CHANGED
@@ -26,7 +26,8 @@
26
26
  *
27
27
  * Layout, `metadata`, `solutionId`, `projectId`, `runtime` and `layout` are
28
28
  * preserved from the original; `subflows` and edges (with their ids) come from
29
- * `edited`; `definitions` and `bindings` are unioned
29
+ * `edited`; root `variables` merge as a delta per entry, like nodes
30
+ * (merge-variables.ts); `definitions` and `bindings` are unioned
30
31
  * (original wins on conflict, since the original's are the tenant-resolved
31
32
  * authority). A binding row's identity is what it binds, not its row id, and a
32
33
  * row the no-edit recompile minted only for nodes merge kept from the original
@@ -143,8 +144,8 @@ export interface MergeOptions {
143
144
  * - with a `baseline`, each wire-identity difference between the baseline
144
145
  * (the no-edit round trip) and the original — a node or edge added, dropped
145
146
  * or rewired, a switch case id or human-task outcome id renamed, a binding
146
- * row added or dropped — that the merged file still carries, i.e. the
147
- * author's edit did not undo it;
147
+ * row added or dropped, a root `variables` entry added or rewritten — that
148
+ * the merged file still carries, i.e. the author's edit did not undo it;
148
149
  * - an edited node whose `typeVersion` differs from the original node with
149
150
  * the same id, because the edit took the SDK's version;
150
151
  * - a merged edge whose `sourcePort` is not a handle its source node declares,
package/dist/merge.js CHANGED
@@ -26,7 +26,8 @@
26
26
  *
27
27
  * Layout, `metadata`, `solutionId`, `projectId`, `runtime` and `layout` are
28
28
  * preserved from the original; `subflows` and edges (with their ids) come from
29
- * `edited`; `definitions` and `bindings` are unioned
29
+ * `edited`; root `variables` merge as a delta per entry, like nodes
30
+ * (merge-variables.ts); `definitions` and `bindings` are unioned
30
31
  * (original wins on conflict, since the original's are the tenant-resolved
31
32
  * authority). A binding row's identity is what it binds, not its row id, and a
32
33
  * row the no-edit recompile minted only for nodes merge kept from the original
@@ -89,6 +90,7 @@ import { MergeRefusedError, mergedFileFindings, roundTripFindings } from './merg
89
90
  import { placeAddedNodes } from './node-placement.js';
90
91
  import { mergeAgentSidecars } from './merge-sidecars.js';
91
92
  import { embeddedAgentFindings, isEmbeddedAgent, mergeEmbeddedAgentNode } from './merge-embedded-agent.js';
93
+ import { mergeVariables } from './merge-variables.js';
92
94
  export { MergeRefusedError } from './merge-roundtrip.js';
93
95
  function byId(nodes) {
94
96
  return new Map((nodes ?? []).map((n) => [n.id, n]));
@@ -256,8 +258,7 @@ function mergeFlowFindings(original, edited, options) {
256
258
  result.nodes = finalNodes;
257
259
  // Nodes present in the original but absent from `edited` were deleted by the
258
260
  // user; they are simply not carried over.
259
- // ── Variables & subflows: the edited flow is authoritative (the user's graph). ──
260
- result.variables = jsonClone(edited.variables);
261
+ // ── Subflows: the edited flow is authoritative (the user's graph). ──
261
262
  result.subflows = jsonClone(edited.subflows ?? {});
262
263
  // A subflow is taken from `edited` whole, so an embedded agent inside one
263
264
  // would flip to the edited shell even with no edit. Keep it embedded too.
@@ -267,6 +268,20 @@ function mergeFlowFindings(original, edited, options) {
267
268
  if (options.baseline)
268
269
  keepOriginalSourcesInSubflows(original, result.subflows, options.baseline);
269
270
  const subflowScopes = Object.values(result.subflows);
271
+ // ── Variables: the same delta as nodes, per entry — what the author did not
272
+ // change stays the original's, so compile's own spellings (an added
273
+ // `name`, a re-derived End output type) do not reach the file (#1261).
274
+ // See merge-variables.ts. ──
275
+ const mergedNodeIds = new Set([...finalNodes, ...subflowScopes.flatMap((sf) => sf?.nodes ?? [])].map((n) => n.id));
276
+ const goneNodeIds = new Set([
277
+ ...(original.nodes ?? []),
278
+ ...Object.values(original.subflows ?? {}).flatMap((sf) => sf?.nodes ?? []),
279
+ ].map((n) => n.id).filter((id) => !mergedNodeIds.has(id)));
280
+ const variables = mergeVariables(original.variables, edited.variables, options.baseline, goneNodeIds);
281
+ if (variables === undefined)
282
+ delete result.variables;
283
+ else
284
+ result.variables = variables;
270
285
  // ── Edges: the edited graph's edges define the wiring, under the edited
271
286
  // file's own ids. compile draws every edge id — root AND subflows — from
272
287
  // one file-wide counter, so they are already unique. Renumbering the root
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uipath/maestro-builder-sdk",
3
- "version": "6.33.1",
3
+ "version": "6.33.2",
4
4
  "description": "Build UiPath Flow, Case, and BPMN artifacts by writing TypeScript.",
5
5
  "license": "MIT",
6
6
  "homepage": "https://docs.uipath.com/maestro",
@@ -93,5 +93,5 @@
93
93
  "@types/node": "^22.7.0",
94
94
  "esbuild": "^0.28.1"
95
95
  },
96
- "gitref": "a27439803ad2ab68ce5be0c4299649d3f4d92e0b"
96
+ "gitref": "04124f15f4e70827cb18bbd0f52c0bf676ceedd1"
97
97
  }