@uipath/maestro-builder-sdk 6.20.5 → 6.21.0

package/dist/nodes/queue/flow/node-type.js

@@ -0,0 +1,265 @@
+import { Expr } from '../../../core/expr.js';
+import { jsonClone } from '../../../core/json-file.js';
+import { checkQueueItem } from './check.js';
+import { QUEUE_ITEM_RECORD_SCHEMA } from './record.js';
+const CREATE = 'core.action.queue.create';
+const CREATE_AND_WAIT = 'core.action.queue.create-and-wait';
+/**
+ * Build the definition for one queue-item node.
+ *
+ * Unlike `rpaWorkflowDef`, this one starts from the BUNDLED definition — the queue
+ * node types are generic (no tenant key in the type), so the platform's own copy
+ * can be shipped and is: `core-definitions.json` carries both at `@1.2`, verbatim
+ * from the catalogue the running `uip` consults (`@uipath/flow-core/manifest`'s
+ * `ootbNodes`). A test pins that the emitted definition is that copy plus exactly
+ * the three per-instance edits below, so the bundled snapshot stays diffable
+ * against upstream.
+ *
+ * VERSION 1.2, not the 1.0 the bundled sample carries. The platform is two
+ * migrations on, and both are semantic: 1.0 → 1.1 re-types `itemData` from
+ * `string` to `object`, and 1.1 → 1.2 makes the field validate as an object
+ * expression. `shared/sample-flows/queue-operations.flow` is v1.0-era (a JSON
+ * STRING in `itemData`) and dated 2026-05-20 — the shape the platform no longer
+ * writes. Reading it for the surface would have shipped the wrong field TYPE.
+ *
+ * The three per-instance edits:
+ *
+ *  - `model.bindings.resourceKey` — the queue's own Orchestrator key. The shipped
+ *    definition ships it BLANK, because only an instance knows which queue.
+ *  - `model.context` — the `=bindings.<id>` references. The definition ships
+ *    `<bindings.name>` placeholders; an instance names the actual binding ids,
+ *    which is the second way `resourceBindings` can be resolved and the
+ *    shape the bundled sample has.
+ *  - `outputDefinition.output.schema` — the queue item's record for a plain
+ *    create, or the author's `returns` for a create-and-wait. Without a schema a
+ *    downstream read is unresolvable.
+ */
+function queueItemDef(spec, nodeType, stepName, ids, base) {
+    // The template at the version being emitted: the registry resolved it exactly
+    // (an unregistered pin is NODE_VERSION_UNREGISTERED before this runs).
+    if (!base)
+        throw new Error(`no bundled definition for "${nodeType}"`);
+    const def = jsonClone(base);
+    def.model.bindings.resourceKey = spec.key;
+    def.model.context = [
+        { name: 'name', type: 'string', value: `=bindings.${ids.name}`, default: spec.queue },
+        { name: 'folderPath', type: 'string', value: `=bindings.${ids.folderPath}`, default: spec.folderPath },
+        { name: '_label', type: 'string', value: stepName },
+    ];
+    const schema = spec.wait
+        ? (spec.returns && Object.keys(spec.returns).length
+            ? {
+                type: 'object',
+                properties: Object.fromEntries(Object.entries(spec.returns).map(([k, t]) => [k, { type: t }])),
+            }
+            : undefined)
+        : jsonClone(QUEUE_ITEM_RECORD_SCHEMA);
+    if (schema)
+        def.outputDefinition.output.schema = schema;
+    return def;
+}
+/**
+ * The two bindings a queue reference carries — the same `name` + `folderPath` pair
+ * the process families use, keyed to the queue's own Orchestrator key rather than
+ * to a `<folderPath>.<name>` string. That is what the only queue instance the repo
+ * has (`sample-flows/queue-operations.flow`) uses, and it is the queue's stable
+ * identity: a queue can be renamed, its key cannot.
+ *
+ * ONE PAIR PER QUEUE, not per step. Bindings are addressed by
+ * `resource + resourceKey + propertyAttribute` — that is the key a bindings
+ * lookup map is built on — so a second pair for the same queue is not a second
+ * reference, it is a duplicate that shadows the first: both nodes resolve to
+ * whichever was inserted last, and the other pair sits in the file referenced by
+ * nothing. So two steps on the same queue SHARE these, and the ids come from the
+ * queue rather than from a step name.
+ *
+ * (The rpa family mints its pair from the STEP name, so two steps starting the same
+ * process emit the same duplicate-and-shadow shape. Nothing exercises it today —
+ * every rpa flow in the repo has one process step — and changing those ids would
+ * rewrite the rpa goldens, so it is recorded as a finding rather than fixed here.)
+ */
+function queueItemBindings(spec, existing) {
+    const found = (attr) => [...existing.values()].find((b) => b.resource === 'queue' && b.resourceKey === spec.key && b.propertyAttribute === attr)?.id;
+    const already = { name: found('name'), folderPath: found('folderPath') };
+    if (already.name && already.folderPath) {
+        return { ids: { name: already.name, folderPath: already.folderPath }, entries: [] };
+    }
+    // A readable, stable id per queue. Two queues that share a NAME across folders
+    // would collide, so the id is suffixed until it is free.
+    const slug = spec.queue.replace(/[^A-Za-z0-9]/g, '') || 'Queue';
+    let base = `b${slug.charAt(0).toUpperCase()}${slug.slice(1)}`;
+    for (let n = 2; existing.has(`${base}Name`) || existing.has(`${base}FolderPath`); n++) {
+        base = `b${slug.charAt(0).toUpperCase()}${slug.slice(1)}${n}`;
+    }
+    const ids = { name: `${base}Name`, folderPath: `${base}FolderPath` };
+    return {
+        ids,
+        entries: [
+            {
+                id: ids.name,
+                name: 'name',
+                type: 'string',
+                resource: 'queue',
+                resourceKey: spec.key,
+                default: spec.queue,
+                propertyAttribute: 'name',
+            },
+            {
+                id: ids.folderPath,
+                name: 'folderPath',
+                type: 'string',
+                resource: 'queue',
+                resourceKey: spec.key,
+                default: spec.folderPath,
+                propertyAttribute: 'folderPath',
+            },
+        ],
+    };
+}
+/** A read of a queue step's output: `QUEUE_READ_*`, in the wording the rule had before the port. */
+const read = (wait) => ({
+    codePrefix: 'QUEUE',
+    label: wait ? 'Queue wait' : 'Queue item',
+    whenUndeclared: `What the consumer writes into the processed item's result is that automation's business; `
+        + `declare the fields you read.`,
+});
+/**
+ * A plain enqueue publishes the queue ITEM's Orchestrator record (fixed, from
+ * `QUEUE_ITEM_RECORD_SCHEMA`); a `wait: true` publishes the processed result,
+ * whose fields only the author's `returns` states.
+ */
+function queueOutput(inputs, wait) {
+    if (!wait) {
+        const fields = Object.fromEntries(Object.entries(QUEUE_ITEM_RECORD_SCHEMA.properties)
+            .map(([k, v]) => [k, v.type ?? 'any']));
+        return { kind: 'fields', fields, read: read(false) };
+    }
+    const returns = inputs?.returns ?? {};
+    return {
+        kind: 'fields',
+        fields: Object.keys(returns).length ? returns : undefined,
+        read: read(true),
+    };
+}
+/**
+ * The `returns` a create-and-wait was authored with, from the field map
+ * `queueItemDef` wrote into `outputDefinition.output.schema` and `makeNode`
+ * copied onto this node's own `outputs`. Read from the NODE, not the file's
+ * `definitions[]` entry: that holds one copy per `<type>@<version>` (the last
+ * step's), so two wait steps would share one schema. Undefined when the node
+ * carries no field map, which is what an omitted `returns` emits.
+ */
+function liftReturns(node) {
+    const props = node
+        ?.outputs?.output?.schema?.properties;
+    if (!props || typeof props !== 'object')
+        return undefined;
+    const entries = Object.entries(props)
+        .filter(([, v]) => typeof v?.type === 'string')
+        .map(([k, v]) => [k, v.type]);
+    return entries.length ? Object.fromEntries(entries) : undefined;
+}
+function queueAt(typeName, wait) {
+    return {
+        kind: 'queueItem', typeName, version: '1.2', factory: 'queueItem', definition: 'per-tenant', errorPort: true,
+        rawNode: { factory: wait ? 'queueItem({ wait: true })' : 'queueItem()' },
+        serialize: ({ inputs: s }, ctx) => {
+            // The bindings first: two steps on the same queue share one pair, and the
+            // node's `model.context` has to name the ids that actually exist.
+            const { ids, entries } = queueItemBindings(s, ctx.bindings);
+            for (const b of entries)
+                ctx.bind(b);
+            const manifest = queueItemDef(s, typeName, ctx.step, ids, ctx.definition(typeName, ctx.version));
+            return {
+                definition: { source: 'snapshot', nodeType: typeName, version: ctx.version, manifest },
+                // The result is read as `$vars.<step>.output`, like every other family: the
+                // node's own output block maps the runtime `response` onto the variable
+                // `output` (`source: "=response", var: "output"`), and the product honours
+                // that mapping for both queue variants. The node KEEPS its copy of the model,
+                // as every core action node with a model does.
+                inputs: {
+                    queue: { name: s.queue, folderPath: s.folderPath, key: s.key },
+                    // `itemData`, not `item`: the surface's name is friendlier, the node's is
+                    // the platform's. Rendered one level deep, as the item is FLAT.
+                    itemData: Object.fromEntries(Object.entries(s.item ?? {}).map(([k, v]) => [k, ctx.render(v)])),
+                    priority: s.priority ?? 'Normal',
+                    reference: s.reference === undefined ? '' : ctx.render(s.reference),
+                    deferDate: s.deferDate === undefined ? '' : ctx.render(s.deferDate),
+                    dueDate: s.dueDate === undefined ? '' : ctx.render(s.dueDate),
+                },
+            };
+        },
+        deserialize: (node, ctx) => {
+            const inputs = node.inputs ?? {};
+            const q = (inputs.queue ?? {});
+            // A value as the author wrote it: an expression back to an Expr, a literal
+            // string as itself, any other JSON as is.
+            const value = (raw) => {
+                const text = ctx.sourceText(raw);
+                if (text === undefined)
+                    return raw;
+                return text.startsWith('=js:') ? ctx.expr(text) : text;
+            };
+            // serialize writes '' for an omitted optional; that is not an authored value.
+            const optional = (raw) => {
+                const text = ctx.sourceText(raw);
+                return text === undefined || text === '' ? undefined : value(raw);
+            };
+            const priority = ctx.plainValue(inputs.priority);
+            // A wait's `returns` is the schema serialize wrote for THIS step (the
+            // template ships none), as the node's own `outputs` carries it.
+            const returns = wait ? liftReturns(node) : undefined;
+            return {
+                kind: 'queueItem',
+                inputs: {
+                    queue: q.name, folderPath: q.folderPath, key: q.key,
+                    item: Object.fromEntries(Object.entries((inputs.itemData ?? {}))
+                        .map(([k, v]) => [k, value(v)])),
+                    ...(typeof priority === 'string' ? { priority: priority } : {}),
+                    ...(optional(inputs.reference) !== undefined ? { reference: optional(inputs.reference) } : {}),
+                    ...(optional(inputs.deferDate) !== undefined ? { deferDate: optional(inputs.deferDate) } : {}),
+                    ...(optional(inputs.dueDate) !== undefined ? { dueDate: optional(inputs.dueDate) } : {}),
+                    ...(wait ? { wait: true } : {}),
+                    ...(returns ? { returns } : {}),
+                },
+            };
+        },
+        print: ({ inputs }, ctx) => {
+            const rows = Object.entries(inputs.item ?? {});
+            return {
+                factory: 'queueItem',
+                options: [
+                    ['queue', ctx.string(String(inputs.queue ?? ''))],
+                    ['folderPath', ctx.string(String(inputs.folderPath ?? ''))],
+                    ['key', ctx.string(String(inputs.key ?? ''))],
+                    // An expression as the helper an author writes; any other value as the data
+                    // the node stores, verbatim (a nested value is refused by check, but kept).
+                    ['item', rows.length
+                            ? `{ ${rows.map(([k, v]) => `${ctx.key(k)}: ${v instanceof Expr ? ctx.value(v) : ctx.json(v)}`).join(', ')} }`
+                            : '{}'],
+                    // `Normal` is the definition's default — only a departure was authored.
+                    ['priority', inputs.priority !== undefined && inputs.priority !== 'Normal' ? ctx.string(inputs.priority) : undefined],
+                    ['reference', inputs.reference === undefined ? undefined : ctx.value(inputs.reference)],
+                    ['deferDate', inputs.deferDate === undefined ? undefined : ctx.value(inputs.deferDate)],
+                    ['dueDate', inputs.dueDate === undefined ? undefined : ctx.value(inputs.dueDate)],
+                    ['wait', wait ? 'true' : undefined],
+                    ['returns', inputs.returns && Object.keys(inputs.returns).length
+                            ? `{ ${Object.entries(inputs.returns).map(([k, t]) => `${ctx.key(k)}: ${ctx.string(String(t))}`).join(', ')} }`
+                            : undefined],
+                ],
+            };
+        },
+        check: ({ inputs }, ctx) => checkQueueItem(inputs, ctx),
+        // check collected no expressions for a queue step before the port; unchanged by it.
+        expressions: () => [],
+        output: ({ inputs }) => queueOutput(inputs, wait),
+    };
+}
+function queueType(typeName, wait) {
+    return {
+        kind: 'queueItem', typeName, factory: 'queueItem', defaultVersion: '1.2',
+        versions: { '1.2': queueAt(typeName, wait) },
+        matches: ({ inputs }) => Boolean(inputs?.wait) === wait,
+    };
+}
+export const queueNodeTypes = [queueType(CREATE, false), queueType(CREATE_AND_WAIT, true)];

package/dist/nodes/queue/flow/spec.d.ts

@@ -0,0 +1,92 @@
+/**
+ * The Queue family's authoring types (`core.action.queue.create` and
+ * `core.action.queue.create-and-wait`), and its kind's entry in
+ * `FlowActionSpecs`. Moved from core/actions.ts in Phase 4 of
+ * docs/NODE_TYPE_ARCHITECTURE_DESIGN.md.
+ */
+import type { ReturnFieldType } from '../../../core/actions.js';
+import type { Expr } from '../../../core/expr.js';
+/** The three priorities an Orchestrator queue item can carry. */
+export type QueuePriority = 'Low' | 'Normal' | 'High';
+export interface QueueItemInputs {
+    /** The queue's name in Orchestrator — e.g. `'SupplierInvoices'`. */
+    queue: string;
+    /** The Orchestrator folder holding the queue — e.g. `'Shared'`. */
+    folderPath: string;
+    /**
+     * The queue's own Orchestrator key (a GUID). It is the JOIN between this node
+     * and the flow's queue bindings — a node which does not reference its bindings
+     * cannot be dispatched — and it is what
+     * the designer's queue picker writes. The RUNTIME resolves the queue by
+     * `queue` + `folderPath`, so all three are needed and none is redundant.
+     *
+     * Find it with `uip or queues list --all-folders`.
+     */
+    key: string;
+    /**
+     * The work item's own data: a FLAT object of primitive values. It becomes the
+     * item's `SpecificContent`, and Orchestrator rejects a nested object or array
+     * with "Property values must be simple (like numbers or text)".
+     */
+    item: Record<string, unknown>;
+    /** Processing priority. Defaults to `'Normal'`, as the node type does. */
+    priority?: QueuePriority;
+    /**
+     * A reference string for the item. Optional in general — but a queue created
+     * with "enforce unique reference" REQUIRES one and rejects a repeat with
+     * `HTTP 409: Duplicate Reference`, so derive it from the flow's input rather
+     * than hard-coding it.
+     *
+     * Which is why it takes an {@link Expr} as well as a literal: the serializer
+     * renders it through the same path as any other value, so
+     * `reference: input('invoiceRef')` and
+     * ``reference: js`${input('invoiceRef')} + "-review"` `` both emit. Typing it
+     * as a bare `string` contradicted the advice directly above and stopped two
+     * of the SDK's own examples compiling.
+     */
+    reference?: string | Expr;
+    /** Earliest the item may be processed, ISO-8601 (e.g. `'2026-08-01T09:00:00Z'`). */
+    deferDate?: string;
+    /** Latest the item should be processed, ISO-8601. What an SLA is measured against. */
+    dueDate?: string;
+    /**
+     * `false` (the default) enqueues and moves on — `core.action.queue.create`.
+     * `true` PARKS the flow until whatever consumes the queue has processed the
+     * item, and publishes that result — `core.action.queue.create-and-wait`.
+     *
+     * The two are one construct with two data paths, so this is one field rather
+     * than two factories. Waiting is not free: nothing completes the item but a
+     * consumer (an RPA process bound to the queue), so a flow that waits on a queue
+     * nobody drains waits forever.
+     */
+    wait?: boolean;
+    /**
+     * Only for `wait: true`: the fields the PROCESSED item's result carries, and
+     * their types (e.g. `{ approved: 'boolean' }`). Required if anything reads the
+     * step's output.
+     *
+     * Why you have to say: what a consumer writes into a transaction's `Output` is
+     * that automation's business, not the queue's — no definition declares it and
+     * authoring happens offline. Without it `$vars.<step>.output.<field>` reads from
+     * an object with no declared fields, and nothing could tell a real field from
+     * a typo.
+     *
+     * `wait: false` needs none: what it publishes is the queue ITEM's own
+     * Orchestrator record (`Key`, `Status`, `Reference`, `SpecificContent`, …),
+     * which is the same for every queue, so the serializer declares it for you.
+     *
+     * @enforcedBy QUEUE_READ_UNKNOWN_FIELD A read must name a field of the record
+     * (`wait: false`) or of this `returns` (`wait: true`).
+     * @enforcedBy QUEUE_READ_WITHOUT_RETURNS Reading a field off a `wait: true` result
+     * requires declaring it here.
+     */
+    returns?: Record<string, ReturnFieldType>;
+}
+declare module '../../../core/actions.js' {
+    interface FlowActionSpecs {
+        /** The spec {@link queueItem} builds. */
+        queueItem: {
+            inputs: QueueItemInputs;
+        };
+    }
+}

package/dist/nodes/queue/flow/spec.js

@@ -0,0 +1 @@
+export {};