@uipath/maestro-builder-sdk 6.71.0 → 6.72.0

package/dist/api-index.md

@@ -37,7 +37,7 @@ could hand you spans for a version you do not have.
 
 ## `@uipath/maestro-builder-sdk`
 
-245 symbol(s). Import from `@uipath/maestro-builder-sdk`.
+247 symbol(s). Import from `@uipath/maestro-builder-sdk`.
 
 | Symbol | Kind | Declaration | Area | Summary |
 | --- | --- | --- | --- | --- |
@@ -47,20 +47,20 @@ could hand you spans for a version you do not have.
 | `ActionSchemaSection` | interface | `dist/nodes/hitl/flow/spec.d.ts:274-280` | Supporting types | One section (`inputs`, `outputs`, `inOuts`, `outcomes`) of an `action-schema.json`. |
 | `ActionSpec` | type | `dist/core/actions.d.ts:847-855` | Supporting types | One action step's spec: `{ kind }` plus that kind's body from FlowActionSpecs, for every kind there. |
 | `agent` | function | `dist/nodes/process/flow/factories.d.ts:159-213` | Actions | Invoke an AGENT resource — either one published to Orchestrator or a sibling agent project registered in the same… |
-| `AgentFlavour` | type | `dist/nodes/process/flow/spec.d.ts:260-264` | Supporting types | Which KIND of agent project was published behind a `uipath.core.agent.<key>` resource. |
+| `AgentFlavour` | type | `dist/nodes/process/flow/spec.d.ts:286-290` | Supporting types | Which KIND of agent project was published behind a `uipath.core.agent.<key>` resource. |
 | `AgentGuardrail` | type | `dist/core/actions.d.ts:393` | Supporting types |  |
 | `agenticProcess` | function | `dist/nodes/process/flow/factories.d.ts:113-158` | Actions | Invoke a deployed AGENTIC PROCESS — a Maestro process orchestration published to Orchestrator: a BPMN process that… |
-| `AgenticProcessCompletion` | type | `dist/nodes/process/flow/spec.d.ts:219-257` | Supporting types | Whether an Agentic Process step waits for the process's result. |
-| `AgenticProcessInputs` | type | `dist/nodes/process/flow/spec.d.ts:258-259` | Option shapes | What `agenticProcess()` takes: the shared fields plus the completion policy. |
-| `AgenticProcessInputsBase` | interface | `dist/nodes/process/flow/spec.d.ts:162-218` | Option shapes | 7 field(s) |
-| `AgentInputs` | interface | `dist/nodes/process/flow/spec.d.ts:267-362` | Option shapes | What `agent()` takes: the agent resource to start, its arguments, and the output fields a read may name. |
-| `AgentLocation` | type | `dist/nodes/process/flow/spec.d.ts:265-266` | Supporting types | Where a published agent lives: deployed to a folder (`'published'`) or a sibling project of the same solution… |
+| `AgenticProcessCompletion` | type | `dist/nodes/process/flow/spec.d.ts:245-283` | Supporting types | Whether an Agentic Process step waits for the process's result. |
+| `AgenticProcessInputs` | type | `dist/nodes/process/flow/spec.d.ts:284-285` | Option shapes | What `agenticProcess()` takes: the shared fields plus the completion policy. |
+| `AgenticProcessInputsBase` | interface | `dist/nodes/process/flow/spec.d.ts:188-244` | Option shapes | 7 field(s) |
+| `AgentInputs` | interface | `dist/nodes/process/flow/spec.d.ts:293-388` | Option shapes | What `agent()` takes: the agent resource to start, its arguments, and the output fields a read may name. |
+| `AgentLocation` | type | `dist/nodes/process/flow/spec.d.ts:291-292` | Supporting types | Where a published agent lives: deployed to a folder (`'published'`) or a sibling project of the same solution… |
 | `AgentMemoryRef` | interface | `dist/core/actions.d.ts:538-562` | Supporting types | An episodic memory the agent learns from across runs, wired to the agent's own `memory` handle. |
 | `AgentResourcePlacement` | interface | `dist/core/actions.d.ts:406-441` | Supporting types | Where one of an inline agent's resources (a context index, a tool, an escalation) sits in the `.flow`: the id of its own… |
 | `Aggregation` | interface | `dist/nodes/transform/flow/spec.d.ts:36-42` | Supporting types | 3 field(s) |
 | `AggregationOperation` | type | `dist/nodes/transform/flow/spec.d.ts:35` | Supporting types |  |
 | `apiWorkflow` | function | `dist/nodes/process/flow/factories.d.ts:53-87` | Actions | Invoke a deployed API workflow — a coded workflow published to Orchestrator, run as a serverless job rather than by a… |
-| `ApiWorkflowInputs` | interface | `dist/nodes/process/flow/spec.d.ts:70-101` | Option shapes | 5 field(s) |
+| `ApiWorkflowInputs` | interface | `dist/nodes/process/flow/spec.d.ts:70-127` | Option shapes | 7 field(s) |
 | `AppRef` | interface | `dist/nodes/hitl/flow/spec.d.ts:146-254` | Supporting types | A deployed Action App that supplies a human task's form — the `'action-app'` variant's subject. |
 | `ArmBuilder` | class | `dist/flow-sdk.d.ts:1387-1410` | Builders | The sub-builder an ARM callback receives — a `StepList` that can also name itself with `.label(...)`. |
 | `AskedField` | interface | `dist/core/actions.d.ts:221-240` | Supporting types | A value the reviewer FILLS IN: read downstream with `out('<step>', '<id>')`. |
@@ -143,10 +143,12 @@ could hand you spans for a version you do not have.
 | `FlowActionSpecs` | interface | `dist/core/actions.d.ts:813-846` | Supporting types | Every action kind, keyed by kind, to the body of its spec — the arm's fields other than `kind`. |
 | `FlowBuilder` | class | `dist/flow-sdk.d.ts:1411-1791` | Builders | 15 member(s) |
 | `FlowLayout` | interface | `dist/flow-sdk.d.ts:830-843` | Supporting types | Designer layout for a flow, keyed by AUTHOR-level ids: node entries by step name (plus the trigger id and `end`), edge… |
+| `FlowMetadata` | interface | `dist/nodes/script/flow/spec.d.ts:63-95` | Actions | The instance metadata, as a script function's second parameter sees it. |
 | `FlowNode` | class | `dist/core/node-classes.d.ts:126-161` | Supporting types | The abstract root of every definition-backed node the builder can place. |
 | `FlowResource` | class | `dist/core/node-classes.d.ts:176-183` | Supporting types | A node attached to another semantic node — an inline agent's tool, context, memory, or escalation. |
 | `FlowTrigger` | class | `dist/core/node-classes.d.ts:169-175` | Supporting types | A node that starts the flow — pass an instance to `.trigger(…)`. |
 | `FlowTypeDesc` | type | `dist/flow-types.d.ts:45-51` | Supporting types | A `types.*` descriptor a Flow variable may declare: every member of `types` but the Case-only `float`, `double`, `date`,… |
+| `FlowVars` | type | `dist/nodes/script/flow/spec.d.ts:45-62` | Actions | The runtime's variable scope, as a script function's parameter sees it. |
 | `FormField` | type | `dist/core/actions.d.ts:259` | Supporting types |  |
 | `FormFieldCondition` | interface | `dist/core/actions.d.ts:113-133` | Supporting types | One condition of a form-field rule (`@uipath/hitl-schema-types` `fieldConditionSchema`): `when` names the field it… |
 | `FormFieldControlType` | type | `dist/core/actions.d.ts:105-112` | Supporting types | How a form field renders (`@uipath/hitl-schema-types` `controlType`). |
@@ -216,7 +218,7 @@ could hand you spans for a version you do not have.
 | `ProcessToolKind` | type | `dist/core/actions.d.ts:622-635` | Supporting types | The tool kinds that wrap a DEPLOYED tenant resource. |
 | `ProcessToolRef` | interface | `dist/core/actions.d.ts:636-665` | Supporting types | A deployed tenant resource the agent may invoke. |
 | `publishedFunction` | function | `dist/nodes/process/flow/factories.d.ts:88-112` | Actions | Invoke a published Orchestrator **Function** — a deployed unit of code run as one step (`uipath.core.function.<key>`,… |
-| `PublishedFunctionInputs` | interface | `dist/nodes/process/flow/spec.d.ts:102-161` | Option shapes | A published Orchestrator **Function** — a small, single-purpose unit of code deployed as its own resource and invoked as… |
+| `PublishedFunctionInputs` | interface | `dist/nodes/process/flow/spec.d.ts:128-187` | Option shapes | A published Orchestrator **Function** — a small, single-purpose unit of code deployed as its own resource and invoked as… |
 | `queueItem` | function | `dist/nodes/queue/flow/factories.d.ts:4-49` | Actions | Declare an Orchestrator QUEUE ITEM step. |
 | `QueueItemInputs` | interface | `dist/nodes/queue/flow/spec.d.ts:11-84` | Option shapes | 10 field(s) |
 | `QueuePriority` | type | `dist/nodes/queue/flow/spec.d.ts:9-10` | Supporting types | The three priorities an Orchestrator queue item can carry. |
@@ -236,14 +238,14 @@ could hand you spans for a version you do not have.
 | `ScheduledInputs` | interface | `dist/flow-sdk.d.ts:153-165` | Option shapes | 1 field(s) |
 | `ScheduleEvery` | type | `dist/flow-sdk.d.ts:141-152` | Supporting types | How often a scheduled flow runs, as an ISO-8601 repeating interval: `R/` followed by a duration. |
 | `SchedulePreset` | type | `dist/flow-sdk.d.ts:140` | Supporting types |  |
-| `script` | function | `dist/nodes/script/flow/factories.d.ts:8-36` | Actions | Declare an inline script action, as a TypeScript function the compiler checks. |
-| `script` | function | `dist/nodes/script/flow/factories.d.ts:37-47` | Actions | Declare an inline script action, as a TypeScript function, with no declared return: the body's type is inferred as it is… |
-| `script` | function | `dist/nodes/script/flow/factories.d.ts:48-55` | Actions | Declare an inline script action. |
-| `ScriptInputs` | interface | `dist/nodes/script/flow/spec.d.ts:7-44` | Option shapes | 2 field(s) |
+| `script` | function | `dist/nodes/script/flow/factories.d.ts:8-38` | Actions | Declare an inline script action, as a TypeScript function the compiler checks. |
+| `script` | function | `dist/nodes/script/flow/factories.d.ts:39-49` | Actions | Declare an inline script action, as a TypeScript function, with no declared return: the body's type is inferred as it is… |
+| `script` | function | `dist/nodes/script/flow/factories.d.ts:50-57` | Actions | Declare an inline script action. |
+| `ScriptInputs` | interface | `dist/nodes/script/flow/spec.d.ts:7-44` | Actions | 2 field(s) |
 | `ScriptReturns` | type | `dist/core/script-return.d.ts:42-48` | Supporting types | What an author may write for `script({ returns })`: the type outright, or — for an object return — the FIELDS, which is… |
 | `ScriptReturnType` | type | `dist/core/script-return.d.ts:31-41` | Supporting types | The vocabulary a script's output can be declared as. |
-| `ScriptValue` | type | `dist/nodes/script/flow/spec.d.ts:65-75` | Supporting types | What a script function must return for a given `returns`: the type a name stands for, or, for a field map, an object… |
-| `ScriptValueOf` | type | `dist/nodes/script/flow/spec.d.ts:63-64` | Supporting types | The TypeScript type one of ScriptReturnType's names stands for. |
+| `ScriptValue` | type | `dist/nodes/script/flow/spec.d.ts:98-108` | Actions | What a script function must return for a given `returns`: the type a name stands for, or, for a field map, an object… |
+| `ScriptValueOf` | type | `dist/nodes/script/flow/spec.d.ts:96-97` | Actions | The TypeScript type one of ScriptReturnType's names stands for. |
 | `sendMessage` | function | `dist/nodes/conversation/flow/factories.d.ts:8-26` | Actions | Post an assistant message into a live conversation (`uipath.conversational.send-message`). |
 | `SendMessageInputs` | interface | `dist/nodes/conversation/flow/spec.d.ts:8-27` | Option shapes | 4 field(s) |
 | `ShownField` | interface | `dist/core/actions.d.ts:205-220` | Supporting types | A value the reviewer READS: shown on the form, filled in from the flow. |

package/dist/api-members.md

@@ -5,13 +5,13 @@
 
 # Maestro Builder SDK — member index
 
-**A lookup table of 1236 rows — match one name in it, do not read it.**
+**A lookup table of 1243 rows — match one name in it, do not read it.**
 Grep or search for the member you have; the row it lands on is the whole
 answer. Reading top to bottom costs ~20x what the one row does and tells you
 nothing you asked for.
 
-Every field and method of every exported shape — 1236 across
-228 interfaces and classes — keyed by the MEMBER's own name.
+Every field and method of every exported shape — 1243 across
+229 interfaces and classes — keyed by the MEMBER's own name.
 
 **Use this when the name you have is a field or a method**, which is usually
 the case: the reference pages are "one line per field", so you arrive holding
@@ -28,7 +28,7 @@ truncated summary would, for less. Read the span.
 Member names repeat across shapes (`name` is declared on 69 of them), so the
 `Declared on` column is what makes a match actionable. For the whole shape
 rather than the one field, look that name up in [`api-index.md`](api-index.md) —
-which is why its span is not repeated on all 1236 rows here.
+which is why its span is not repeated on all 1243 rows here.
 
 **A name that misses both indexes is probably not part of the API.** The one
 that comes up is a RUNTIME output key — a human task's `Action`, a step's
@@ -53,15 +53,15 @@ not find it either.
 | `actionSchema` | property | `AppRef` | `dist/nodes/hitl/flow/spec.d.ts:220-244` |
 | `activity` | method | `ScopeBuilder` | `dist/bpmn/bpmn-sdk.d.ts:2998-3031` |
 | `additionalOutputs` | property | `RegistryTypeSpec` | `dist/bpmn/typed-node.d.ts:98-102` |
-| `agent` | property | `FlowActionSpecs` | `dist/nodes/process/flow/spec.d.ts:381-384` |
+| `agent` | property | `FlowActionSpecs` | `dist/nodes/process/flow/spec.d.ts:407-410` |
 | `agent` | method | `TaskBuilder` | `dist/case/case-sdk.d.ts:997-1006` |
-| `agenticProcess` | property | `FlowActionSpecs` | `dist/nodes/process/flow/spec.d.ts:377-380` |
+| `agenticProcess` | property | `FlowActionSpecs` | `dist/nodes/process/flow/spec.d.ts:403-406` |
 | `alias` | property | `Aggregation` | `dist/nodes/transform/flow/spec.d.ts:38-39` |
 | `aliases` | property | `LookupSpec` | `dist/core/lookups.d.ts:31-32` |
 | `allErrors` | property | `RetrySpec` | `dist/bpmn/bpmn-sdk.d.ts:837-838` |
 | `allowAdhocOptionalStageTasks` | property | `BuiltCase` | `dist/case/case-sdk.d.ts:875-876` |
 | `allowAdhocTasks` | method | `CaseBuilder` | `dist/case/case-sdk.d.ts:1509-1516` |
-| `apiWorkflow` | property | `FlowActionSpecs` | `dist/nodes/process/flow/spec.d.ts:369-372` |
+| `apiWorkflow` | property | `FlowActionSpecs` | `dist/nodes/process/flow/spec.d.ts:395-398` |
 | `apiWorkflow` | method | `TaskBuilder` | `dist/case/case-sdk.d.ts:1017-1026` |
 | `app` | property | `EscalationRef` | `dist/core/actions.d.ts:729-756` |
 | `app` | property | `HitlInputs` | `dist/nodes/hitl/flow/spec.d.ts:326-330` |
@@ -299,6 +299,7 @@ not find it either.
 | `effects` | property | `FormFieldRule` | `dist/core/actions.d.ts:159-160` |
 | `element` | property | `PlainTaskOpts` | `dist/bpmn/bpmn-sdk.d.ts:1712-1713` |
 | `element` | property | `RegistryTypeSpec` | `dist/bpmn/typed-node.d.ts:87-88` |
+| `ElementCount` | property | `FlowMetadata` | `dist/nodes/script/flow/spec.d.ts:93-94` |
 | `elementId` | property | `BpmnVarDecl` | `dist/bpmn/bpmn-sdk.d.ts:396-403` |
 | `elementId` | property | `VarOpts` | `dist/bpmn/bpmn-sdk.d.ts:1741-1764` |
 | `enabledForEvals` | property | `BuiltInValidatorGuardrail` | `dist/core/actions.d.ts:360` |
@@ -372,6 +373,7 @@ not find it either.
 | `external` | property | `BuiltTask` | `dist/case/case-sdk.d.ts:720-721` |
 | `externalAgent` | method | `ScopeBuilder` | `dist/bpmn/bpmn-sdk.d.ts:2942-2978` |
 | `externalAgent` | method | `TaskBuilder` | `dist/case/case-sdk.d.ts:1095-1102` |
+| `ExternalId` | property | `FlowMetadata` | `dist/nodes/script/flow/spec.d.ts:91-92` |
 | `externalWorkflow` | method | `ScopeBuilder` | `dist/bpmn/bpmn-sdk.d.ts:2979-2995` |
 | `externalWorkflow` | method | `TaskBuilder` | `dist/case/case-sdk.d.ts:1103-1110` |
 | `extractionResult` | property | `DocValidationInputs` | `dist/nodes/hitl/flow/spec.d.ts:82-87` |
@@ -395,7 +397,7 @@ not find it either.
 | `filters` | property | `DataFabricReadInputs` | `dist/nodes/data-fabric/flow/spec.d.ts:79-80` |
 | `filters` | property | `EventSubscription` | `dist/core/actions.d.ts:1046-1047` |
 | `filters` | property | `TriggerOptions` | `dist/core/actions.d.ts:1003-1004` |
-| `flavour` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:347-361` |
+| `flavour` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:373-387` |
 | `flowIds` | method | `ScopeBuilder` | `dist/bpmn/bpmn-sdk.d.ts:3195-3238` |
 | `flowMode` | method | `ScopeBuilder` | `dist/bpmn/bpmn-sdk.d.ts:2181-2220` |
 | `flowProcess` | method | `TaskBuilder` | `dist/case/case-sdk.d.ts:1039-1048` |
@@ -424,10 +426,11 @@ not find it either.
 | `folderKey` | property | `McpToolRef` | `dist/core/actions.d.ts:457-458` |
 | `folderKey` | property | `OrchestratorOpts` | `dist/bpmn/bpmn-sdk.d.ts:1300-1308` |
 | `folderKey` | property | `RemoteA2aToolRef` | `dist/core/actions.d.ts:489` |
+| `FolderKey` | property | `FlowMetadata` | `dist/nodes/script/flow/spec.d.ts:85-86` |
 | `folderName` | property | `IxpExtractInputs` | `dist/nodes/document/flow/spec.d.ts:108-114` |
-| `folderPath` | property | `AgenticProcessInputsBase` | `dist/nodes/process/flow/spec.d.ts:188-195` |
-| `folderPath` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:291-302` |
-| `folderPath` | property | `ApiWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:81-82` |
+| `folderPath` | property | `AgenticProcessInputsBase` | `dist/nodes/process/flow/spec.d.ts:214-221` |
+| `folderPath` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:317-328` |
+| `folderPath` | property | `ApiWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:92-99` |
 | `folderPath` | property | `AppRef` | `dist/nodes/hitl/flow/spec.d.ts:198-204` |
 | `folderPath` | property | `ConnectorEventOpts` | `dist/bpmn/bpmn-sdk.d.ts:1515-1516` |
 | `folderPath` | property | `ContextIndexRef` | `dist/core/actions.d.ts:789-790` |
@@ -435,14 +438,14 @@ not find it either.
 | `folderPath` | property | `IxpExtractInputs` | `dist/nodes/document/flow/spec.d.ts:134-140` |
 | `folderPath` | property | `McpToolRef` | `dist/core/actions.d.ts:455-456` |
 | `folderPath` | property | `ProcessToolRef` | `dist/core/actions.d.ts:653-654` |
-| `folderPath` | property | `PublishedFunctionInputs` | `dist/nodes/process/flow/spec.d.ts:130-140` |
+| `folderPath` | property | `PublishedFunctionInputs` | `dist/nodes/process/flow/spec.d.ts:156-166` |
 | `folderPath` | property | `QueueItemInputs` | `dist/nodes/queue/flow/spec.d.ts:14-15` |
 | `folderPath` | property | `RemoteA2aToolRef` | `dist/core/actions.d.ts:488` |
 | `folderPath` | property | `RpaWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:31-38` |
 | `folderPath` | property | `TaskRef` | `dist/case/case-sdk.d.ts:568` |
 | `fork` | property | `ParallelOptions` | `dist/flow-sdk.d.ts:475-492` |
 | `fork` | method | `ScopeBuilder` | `dist/bpmn/bpmn-sdk.d.ts:3138-3163` |
-| `form` | property | `AgenticProcessInputsBase` | `dist/nodes/process/flow/spec.d.ts:210-217` |
+| `form` | property | `AgenticProcessInputsBase` | `dist/nodes/process/flow/spec.d.ts:236-243` |
 | `form` | property | `HumanTaskAppOpts` | `dist/bpmn/bpmn-sdk.d.ts:1406-1407` |
 | `form` | property | `HumanTaskFormOpts` | `dist/bpmn/bpmn-sdk.d.ts:1440-1441` |
 | `format` | property | `ActionSchemaProperty` | `dist/nodes/hitl/flow/spec.d.ts:267-268` |
@@ -518,9 +521,9 @@ not find it either.
 | `inputs` | property | `ActionSchemaFile` | `dist/nodes/hitl/flow/spec.d.ts:283-284` |
 | `inputs` | property | `ActionSpecData` | `dist/case/case-sdk.d.ts:665-666` |
 | `inputs` | property | `ActivityNodeOpts` | `dist/bpmn/bpmn-sdk.d.ts:1623-1624` |
-| `inputs` | property | `AgenticProcessInputsBase` | `dist/nodes/process/flow/spec.d.ts:204-209` |
-| `inputs` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:309-326` |
-| `inputs` | property | `ApiWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:83-87` |
+| `inputs` | property | `AgenticProcessInputsBase` | `dist/nodes/process/flow/spec.d.ts:230-235` |
+| `inputs` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:335-352` |
+| `inputs` | property | `ApiWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:109-113` |
 | `inputs` | property | `AppRef` | `dist/nodes/hitl/flow/spec.d.ts:211-219` |
 | `inputs` | property | `BuiltEntryPoint` | `dist/flow-sdk.d.ts:852-853` |
 | `inputs` | property | `BuiltFlow` | `dist/flow-sdk.d.ts:870` |
@@ -531,7 +534,7 @@ not find it either.
 | `inputs` | property | `NodeContribution` | `dist/core/node-classes.d.ts:113-117` |
 | `inputs` | property | `PlatformActionSchema` | `dist/nodes/hitl/flow/spec.d.ts:307-308` |
 | `inputs` | property | `ProcessToolRef` | `dist/core/actions.d.ts:661-662` |
-| `inputs` | property | `PublishedFunctionInputs` | `dist/nodes/process/flow/spec.d.ts:150-151` |
+| `inputs` | property | `PublishedFunctionInputs` | `dist/nodes/process/flow/spec.d.ts:176-177` |
 | `inputs` | property | `RegistryTypeSpec` | `dist/bpmn/typed-node.d.ts:95-96` |
 | `inputs` | property | `RpaWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:47-52` |
 | `inputs` | property | `ScriptTaskOpts` | `dist/bpmn/bpmn-sdk.d.ts:913-927` |
@@ -542,6 +545,7 @@ not find it either.
 | `inputSchema` | property | `AppRef` | `dist/nodes/hitl/flow/spec.d.ts:245-253` |
 | `inputSchema` | property | `ScriptTaskOpts` | `dist/bpmn/bpmn-sdk.d.ts:953-964` |
 | `inputTarget` | property | `RegistryTypeSpec` | `dist/bpmn/typed-node.d.ts:93` |
+| `InstanceId` | property | `FlowMetadata` | `dist/nodes/script/flow/spec.d.ts:87-88` |
 | `intermediateCatchEvent` | method | `ScopeBuilder` | `dist/bpmn/bpmn-sdk.d.ts:2326-2333` |
 | `intermediateThrowEvent` | method | `ScopeBuilder` | `dist/bpmn/bpmn-sdk.d.ts:2334-2341` |
 | `internal` | property | `BpmnVarDecl` | `dist/bpmn/bpmn-sdk.d.ts:410-411` |
@@ -564,15 +568,15 @@ not find it either.
 | `join` | property | `ChooseOpts` | `dist/bpmn/bpmn-sdk.d.ts:1918-1919` |
 | `join` | property | `SplitOpts` | `dist/bpmn/bpmn-sdk.d.ts:1925-1926` |
 | `js` | property | `Expr` | `dist/core/expr.d.ts:17` |
-| `key` | property | `AgenticProcessInputsBase` | `dist/nodes/process/flow/spec.d.ts:163-174` |
-| `key` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:269-282` |
-| `key` | property | `ApiWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:71-78` |
+| `key` | property | `AgenticProcessInputsBase` | `dist/nodes/process/flow/spec.d.ts:189-200` |
+| `key` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:295-308` |
+| `key` | property | `ApiWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:71-82` |
 | `key` | property | `AppRef` | `dist/nodes/hitl/flow/spec.d.ts:179-185` |
 | `key` | property | `HitlConnection` | `dist/nodes/hitl/flow/spec.d.ts:28-29` |
 | `key` | property | `HumanTaskAppOpts` | `dist/bpmn/bpmn-sdk.d.ts:1420-1421` |
 | `key` | property | `McpToolRef` | `dist/core/actions.d.ts:452-453` |
 | `key` | property | `ProcessToolRef` | `dist/core/actions.d.ts:645-650` |
-| `key` | property | `PublishedFunctionInputs` | `dist/nodes/process/flow/spec.d.ts:109-119` |
+| `key` | property | `PublishedFunctionInputs` | `dist/nodes/process/flow/spec.d.ts:135-145` |
 | `key` | property | `QueueItemInputs` | `dist/nodes/queue/flow/spec.d.ts:16-25` |
 | `key` | property | `RemoteA2aToolRef` | `dist/core/actions.d.ts:480-481` |
 | `key` | property | `RpaWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:12-22` |
@@ -614,11 +618,12 @@ not find it either.
 | `limit` | property | `DataFabricReadInputs` | `dist/nodes/data-fabric/flow/spec.d.ts:95-100` |
 | `limit` | property | `DoWhileOptions` | `dist/flow-sdk.d.ts:575-576` |
 | `literal` | property | `Expr` | `dist/core/expr.d.ts:18` |
-| `location` | property | `AgenticProcessInputsBase` | `dist/nodes/process/flow/spec.d.ts:177-187` |
-| `location` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:285-290` |
+| `location` | property | `AgenticProcessInputsBase` | `dist/nodes/process/flow/spec.d.ts:203-213` |
+| `location` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:311-316` |
+| `location` | property | `ApiWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:85-91` |
 | `location` | property | `AppRef` | `dist/nodes/hitl/flow/spec.d.ts:186-197` |
 | `location` | property | `CarriedConnectorField` | `dist/core/carried-connector-fields.d.ts:43-44` |
-| `location` | property | `PublishedFunctionInputs` | `dist/nodes/process/flow/spec.d.ts:122-129` |
+| `location` | property | `PublishedFunctionInputs` | `dist/nodes/process/flow/spec.d.ts:148-155` |
 | `location` | property | `RpaWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:25-30` |
 | `lookups` | property | `ConnectorMeta` | `dist/core/connectors.d.ts:76-87` |
 | `loop` | property | `ActivityNodeFields` | `dist/bpmn/bpmn-sdk.d.ts:353-354` |
@@ -681,10 +686,10 @@ not find it either.
 | `name` | property | `ActionAppRef` | `dist/case/case-sdk.d.ts:642-643` |
 | `name` | property | `ActionField` | `dist/case/case-sdk.d.ts:615-616` |
 | `name` | property | `ActivityNodeOpts` | `dist/bpmn/bpmn-sdk.d.ts:1611-1612` |
-| `name` | property | `AgenticProcessInputsBase` | `dist/nodes/process/flow/spec.d.ts:175-176` |
-| `name` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:283-284` |
+| `name` | property | `AgenticProcessInputsBase` | `dist/nodes/process/flow/spec.d.ts:201-202` |
+| `name` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:309-310` |
 | `name` | property | `AgentMemoryRef` | `dist/core/actions.d.ts:547-548` |
-| `name` | property | `ApiWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:79-80` |
+| `name` | property | `ApiWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:83-84` |
 | `name` | property | `AppRef` | `dist/nodes/hitl/flow/spec.d.ts:177-178` |
 | `name` | property | `BindingContribution` | `dist/core/node-classes.d.ts:87-88` |
 | `name` | property | `BindingDecl` | `dist/bpmn/bpmn-sdk.d.ts:423-424` |
@@ -740,7 +745,7 @@ not find it either.
 | `name` | property | `PlainTaskOpts` | `dist/bpmn/bpmn-sdk.d.ts:1710-1711` |
 | `name` | property | `PlatformActionSchemaArg` | `dist/nodes/hitl/flow/spec.d.ts:294-295` |
 | `name` | property | `ProcessToolRef` | `dist/core/actions.d.ts:651-652` |
-| `name` | property | `PublishedFunctionInputs` | `dist/nodes/process/flow/spec.d.ts:120-121` |
+| `name` | property | `PublishedFunctionInputs` | `dist/nodes/process/flow/spec.d.ts:146-147` |
 | `name` | property | `QueueItemOpts` | `dist/bpmn/bpmn-sdk.d.ts:1343-1344` |
 | `name` | property | `ReceiveMessageOpts` | `dist/bpmn/bpmn-sdk.d.ts:1466-1467` |
 | `name` | property | `RegistryContextField` | `dist/bpmn/typed-node.d.ts:22` |
@@ -882,11 +887,13 @@ not find it either.
 | `process` | property | `OrchestratorOpts` | `dist/bpmn/bpmn-sdk.d.ts:1267-1285` |
 | `process` | method | `TaskBuilder` | `dist/case/case-sdk.d.ts:959-968` |
 | `processId` | property | `SugarRegistry` | `dist/bpmn/bpmn-sdk.d.ts:2060-2065` |
+| `ProcessKey` | property | `FlowMetadata` | `dist/nodes/script/flow/spec.d.ts:89-90` |
 | `project` | property | `IxpExtractInputs` | `dist/nodes/document/flow/spec.d.ts:76-89` |
-| `projectId` | property | `AgenticProcessInputsBase` | `dist/nodes/process/flow/spec.d.ts:196-203` |
-| `projectId` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:303-308` |
+| `projectId` | property | `AgenticProcessInputsBase` | `dist/nodes/process/flow/spec.d.ts:222-229` |
+| `projectId` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:329-334` |
+| `projectId` | property | `ApiWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:100-108` |
 | `projectId` | property | `IxpToolRef` | `dist/core/actions.d.ts:678-688` |
-| `projectId` | property | `PublishedFunctionInputs` | `dist/nodes/process/flow/spec.d.ts:141-149` |
+| `projectId` | property | `PublishedFunctionInputs` | `dist/nodes/process/flow/spec.d.ts:167-175` |
 | `projectId` | property | `RpaWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:39-46` |
 | `prompt` | property | `BatchTransformInputs` | `dist/nodes/ai-patterns/flow/spec.d.ts:54-55` |
 | `prompt` | property | `SummarizeInputs` | `dist/nodes/ai-patterns/flow/spec.d.ts:32-33` |
@@ -895,7 +902,7 @@ not find it either.
 | `propertyAttribute` | property | `BindingContribution` | `dist/core/node-classes.d.ts:97-98` |
 | `propertyAttribute` | property | `BindingDecl` | `dist/bpmn/bpmn-sdk.d.ts:427-428` |
 | `propertyAttribute` | property | `BindingOpts` | `dist/bpmn/bpmn-sdk.d.ts:1069-1070` |
-| `publishedFunction` | property | `FlowActionSpecs` | `dist/nodes/process/flow/spec.d.ts:373-376` |
+| `publishedFunction` | property | `FlowActionSpecs` | `dist/nodes/process/flow/spec.d.ts:399-402` |
 | `query` | property | `BuiltinToolRef` | `dist/core/actions.d.ts:573-578` |
 | `query` | property | `ContextIndexRef` | `dist/core/actions.d.ts:793-798` |
 | `query` | property | `HttpInputsBase` | `dist/nodes/http/flow/spec.d.ts:34` |
@@ -964,13 +971,13 @@ not find it either.
 | `retryCount` | property | `HttpInputsBase` | `dist/nodes/http/flow/spec.d.ts:109-123` |
 | `return` | method | `StepList` | `dist/flow-sdk.d.ts:1376-1385` |
 | `returnCitations` | property | `SummarizeInputs` | `dist/nodes/ai-patterns/flow/spec.d.ts:34-39` |
-| `returns` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:327-346` |
-| `returns` | property | `ApiWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:88-100` |
+| `returns` | property | `AgentInputs` | `dist/nodes/process/flow/spec.d.ts:353-372` |
+| `returns` | property | `ApiWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:114-126` |
 | `returns` | property | `ClientSideToolRef` | `dist/core/actions.d.ts:505-506` |
 | `returns` | property | `HttpInputsBase` | `dist/nodes/http/flow/spec.d.ts:68-90` |
 | `returns` | property | `InlineAgentInputs` | `dist/nodes/agent/flow/spec.d.ts:259-272` |
 | `returns` | property | `ProcessToolRef` | `dist/core/actions.d.ts:663-664` |
-| `returns` | property | `PublishedFunctionInputs` | `dist/nodes/process/flow/spec.d.ts:152-160` |
+| `returns` | property | `PublishedFunctionInputs` | `dist/nodes/process/flow/spec.d.ts:178-186` |
 | `returns` | property | `QueueItemInputs` | `dist/nodes/queue/flow/spec.d.ts:63-83` |
 | `returns` | property | `RpaWorkflowInputs` | `dist/nodes/process/flow/spec.d.ts:53-68` |
 | `returns` | property | `ScriptInputs` | `dist/nodes/script/flow/spec.d.ts:10-43` |
@@ -980,7 +987,7 @@ not find it either.
 | `role` | property | `FlowTrigger` | `dist/core/node-classes.d.ts:173-174` |
 | `routedWaypoints` | property | `EdgeRoute` | `dist/flow-sdk.d.ts:776-781` |
 | `rpa` | method | `TaskBuilder` | `dist/case/case-sdk.d.ts:1007-1016` |
-| `rpaWorkflow` | property | `FlowActionSpecs` | `dist/nodes/process/flow/spec.d.ts:365-368` |
+| `rpaWorkflow` | property | `FlowActionSpecs` | `dist/nodes/process/flow/spec.d.ts:391-394` |
 | `rule` | property | `CaseRule` | `dist/case/case-sdk.d.ts:90` |
 | `rules` | property | `BuiltCaseExitCondition` | `dist/case/case-sdk.d.ts:412` |
 | `rules` | property | `BuiltEntryCondition` | `dist/case/case-sdk.d.ts:354` |
@@ -1008,7 +1015,7 @@ not find it either.
 | `schemaVersion` | method | `FlowBuilder` | `dist/flow-sdk.d.ts:1604-1643` |
 | `scope` | property | `EscalationRecipient` | `dist/case/case-sdk.d.ts:160` |
 | `scopes` | property | `GuardrailSelector` | `dist/core/actions.d.ts:290` |
-| `script` | property | `FlowActionSpecs` | `dist/nodes/script/flow/spec.d.ts:78-81` |
+| `script` | property | `FlowActionSpecs` | `dist/nodes/script/flow/spec.d.ts:111-114` |
 | `script` | property | `ScriptTaskOpts` | `dist/bpmn/bpmn-sdk.d.ts:880-896` |
 | `scriptFormat` | property | `ScriptTaskOpts` | `dist/bpmn/bpmn-sdk.d.ts:897-898` |
 | `scriptTask` | method | `ScopeBuilder` | `dist/bpmn/bpmn-sdk.d.ts:2387-2395` |

package/dist/check.js

@@ -24,6 +24,7 @@ import { FLOW_SCHEMA_VERSIONS } from './format-profile.js';
 import { compareSchemaVersions, schemaVersionRefusal } from './schema-version.js';
 import { planSharedInputs, sharedInputRoots } from './flow-variables.js';
 import { VARS_READ_RE } from './core/vars-read.js';
+import { FLOW_METADATA_KEYS, unknownMetadataKeys } from './core/flow-metadata.js';
 import { endContentKey } from './flow-end-content.js';
 import { FLOW_NODE_TYPES } from './flow-node-registry.js';
 import { stepExits } from './flow-step-exits.js';
@@ -942,6 +943,24 @@ function checkFlow(built, ancestors, opts = {}) {
             }
         }
     }
+    // A `$metadata` key the engine does not set. Its shape is fixed, unlike
+    // `$vars` (core/flow-metadata.ts), so a typo (`$metadata.instanceId`) reads
+    // `undefined`. A warning, not an error: a case can set other keys on an
+    // instance it starts, and the flow cannot tell whether one does. Read from
+    // the parsed code, so a local `$metadata` or a comment is not a read.
+    for (const { js, step } of exprs) {
+        for (const key of unknownMetadataKeys(js)) {
+            const near = FLOW_METADATA_KEYS.find((k) => k.toLowerCase() === key.toLowerCase());
+            diags.push({
+                level: 'warning',
+                code: 'UNKNOWN_METADATA_KEY',
+                step,
+                message: `"${step}" reads $metadata.${key}, which the engine does not set: it sets ${FLOW_METADATA_KEYS.join(', ')}. `
+                    + 'Unless a case that starts this flow sets it, it reads undefined.',
+                ...(near ? { suggestion: `$metadata.${near}` } : {}),
+            });
+        }
+    }
     // A reference that reaches a step through a BRACKET instead of a dot.
     //
     // Both forms resolve at run time — measured, `$vars.call["output"].x` and

package/dist/core/flow-metadata.d.ts

@@ -0,0 +1,18 @@
+/** The keys the engine sets on every instance's `$metadata`. */
+export declare const FLOW_METADATA_KEYS: readonly string[];
+/**
+ * Every `$metadata` key `code` reads by name, in source order: a property
+ * access (`$metadata.InstanceId`, `?.`, with any whitespace or comment around
+ * the dot) or a string-literal element access (`$metadata['InstanceId']`).
+ *
+ * Read from the parsed code, with names resolved by a one-file checker, so only
+ * the runtime's own global counts: a local or parameter named `$metadata`, a
+ * member of that name (`o.$metadata.Region`), and text in a comment or string
+ * are not reads. A computed key reads nothing knowable and is skipped.
+ *
+ * `code` is a script body (top-level `return` allowed) or an expression; one
+ * that parses as neither is read as far as the parser recovers.
+ */
+export declare function metadataReads(code: string): string[];
+/** The keys `code` reads that the engine does not set, each once, in order of first read. */
+export declare function unknownMetadataKeys(code: string): string[];

package/dist/core/flow-metadata.js

@@ -0,0 +1,63 @@
+import { typescript } from './typescript-module.js';
+import { isReference, isUndefinedSymbol, oneFileChecker } from './script-function.js';
+/** The keys the engine sets on every instance's `$metadata`. */
+export const FLOW_METADATA_KEYS = ['FolderKey', 'InstanceId', 'ProcessKey', 'ExternalId', 'ElementCount'];
+const METADATA = '$metadata';
+/**
+ * Every `$metadata` key `code` reads by name, in source order: a property
+ * access (`$metadata.InstanceId`, `?.`, with any whitespace or comment around
+ * the dot) or a string-literal element access (`$metadata['InstanceId']`).
+ *
+ * Read from the parsed code, with names resolved by a one-file checker, so only
+ * the runtime's own global counts: a local or parameter named `$metadata`, a
+ * member of that name (`o.$metadata.Region`), and text in a comment or string
+ * are not reads. A computed key reads nothing knowable and is skipped.
+ *
+ * `code` is a script body (top-level `return` allowed) or an expression; one
+ * that parses as neither is read as far as the parser recovers.
+ */
+export function metadataReads(code) {
+    if (!code.includes(METADATA))
+        return [];
+    const ts = typescript();
+    const sf = parseBodyOrExpression(ts, code);
+    const checker = oneFileChecker(ts, sf);
+    const out = [];
+    const visit = (n) => {
+        if (ts.isIdentifier(n) && n.text === METADATA && isReference(ts, n)) {
+            const symbol = checker.getSymbolAtLocation(n);
+            const key = symbol && !isUndefinedSymbol(symbol) ? undefined : keyRead(ts, n);
+            if (key !== undefined)
+                out.push(key);
+        }
+        ts.forEachChild(n, visit);
+    };
+    visit(sf);
+    return out;
+}
+/** The keys `code` reads that the engine does not set, each once, in order of first read. */
+export function unknownMetadataKeys(code) {
+    return [...new Set(metadataReads(code).filter((k) => !FLOW_METADATA_KEYS.includes(k)))];
+}
+/** The key `id` (the global) is read with: `.key`, `?.key`, or `['key']`. */
+function keyRead(ts, id) {
+    const p = id.parent;
+    if (ts.isPropertyAccessExpression(p) && p.expression === id && ts.isIdentifier(p.name))
+        return p.name.text;
+    if (ts.isElementAccessExpression(p) && p.expression === id && ts.isStringLiteralLike(p.argumentExpression))
+        return p.argumentExpression.text;
+    return undefined;
+}
+/**
+ * `code` as a function body, or, when that does not parse and the expression
+ * does (a bare `{ a: $metadata.X }` is a block otherwise), as an expression.
+ */
+function parseBodyOrExpression(ts, code) {
+    const parse = (text) => ts.createSourceFile('metadata-reads.ts', text, ts.ScriptTarget.ES2020, true, ts.ScriptKind.TS);
+    const errors = (sf) => (sf.parseDiagnostics ?? []).length;
+    const body = parse(`function __body() {\n${code}\n}`);
+    if (errors(body) === 0)
+        return body;
+    const expression = parse(`(${code}\n)`);
+    return errors(expression) === 0 ? expression : body;
+}

package/dist/core/refusals.d.ts

@@ -43,6 +43,9 @@ export declare const REFUSALS: {
     readonly AGENT_READ_WRONG_CASE: "lint";
     readonly APIWF_EMPTY_RETURNS: "lint";
     readonly APIWF_KEY_NOT_KEY: "lint";
+    readonly APIWF_LOCAL_HAS_FOLDER: "lowering";
+    readonly APIWF_LOCAL_NO_PROJECT_ID: "lint";
+    readonly APIWF_LOCAL_PROJECT_ID_NOT_GUID: "lint";
     readonly APIWF_NAME_IS_PATH: "lint";
     readonly APIWF_NO_FOLDER: "lint";
     readonly APIWF_NO_KEY: "lowering";
@@ -680,6 +683,7 @@ export declare const REFUSALS: {
     readonly UNKNOWN_ESCALATION_REF: "lowering";
     readonly UNKNOWN_EXIT_STAGE: "lowering";
     readonly UNKNOWN_LOOP_FIELD: "lint";
+    readonly UNKNOWN_METADATA_KEY: "lint";
     readonly UNKNOWN_REF: "lint";
     readonly UNKNOWN_RULE: "lowering";
     readonly UNKNOWN_SLA_REF: "lowering";

package/dist/core/refusals.js

@@ -92,6 +92,9 @@ export const REFUSALS = {
     AGENT_READ_WRONG_CASE: 'lint',
     APIWF_EMPTY_RETURNS: 'lint',
     APIWF_KEY_NOT_KEY: 'lint',
+    APIWF_LOCAL_HAS_FOLDER: 'lowering',
+    APIWF_LOCAL_NO_PROJECT_ID: 'lint',
+    APIWF_LOCAL_PROJECT_ID_NOT_GUID: 'lint',
     APIWF_NAME_IS_PATH: 'lint',
     APIWF_NO_FOLDER: 'lint',
     APIWF_NO_KEY: 'lowering',
@@ -732,6 +735,7 @@ export const REFUSALS = {
     UNKNOWN_ESCALATION_REF: 'lowering',
     UNKNOWN_EXIT_STAGE: 'lowering',
     UNKNOWN_LOOP_FIELD: 'lint',
+    UNKNOWN_METADATA_KEY: 'lint',
     UNKNOWN_REF: 'lint',
     UNKNOWN_RULE: 'lowering',
     UNKNOWN_SLA_REF: 'lowering',

package/dist/core/script-function.d.ts

@@ -10,27 +10,46 @@
  * artifact goes to a designer, and the author expects to see the script they
  * wrote. Only two edits are made, both because the runtime requires them:
  *
- *   1. the parameter is renamed to the runtime's own scope global (`$vars` in
- *      Flow). The parameter is an authoring-time name for that global; the SDK
- *      never calls the function or passes it anything.
+ *   1. each parameter is renamed to the runtime's own global for its scope
+ *      (`$vars`, then `$metadata`, in Flow). A parameter is an authoring-time
+ *      name for that global; the SDK never calls the function or passes it
+ *      anything.
  *   2. esbuild's `keepNames` wrappers (`__name(fn, "fn")`) are removed. A loader
  *      such as tsx adds them, and the script runtime has no `__name`.
  *
  * Everything else that would make the lowered body behave differently from the
  * function is refused rather than rewritten: a name the runtime does not
- * provide, a `$vars` binding that would capture the rename, a destructured
- * parameter whose step reads `renameRefs` could not see, a reference to the
- * function's own name, which only the body loses.
+ * provide, a `$vars` (or `$metadata`) binding that would capture the rename, a
+ * destructured parameter whose step reads `renameRefs` could not see, a
+ * reference to the function's own name, which only the body loses.
  *
  * Names are resolved with the checker of a one-file program over the function's
  * source, not by text: `a.vars`, `{ vars: 1 }` and an inner `(vars) => …` are
  * not references to the parameter, and only a checker knows that.
  */
 import type * as TS from 'typescript';
-/** How a runtime receives a lowered script: its scope global, and every other name it provides. */
+/** One scope a runtime binds to a global, which a script function takes as a parameter. */
+export interface ScriptScope {
+    /** The identifier the runtime binds it to: `$vars`. */
+    global: string;
+    /** The plain parameter name errors suggest for it: `vars`. */
+    param: string;
+    /** What it holds, as errors name it: `the variable scope`. */
+    holds: string;
+    /** What a dotted read of it names, as errors name it: `step` (`$vars.<step>`). */
+    reads: string;
+    /** A dotted read's tail, as errors show it: `start.output.x`. */
+    example: string;
+    /** What sees only a dotted read, as errors name it: `the step renaming and reference checks`. */
+    checkedBy: string;
+}
+/** How a runtime receives a lowered script: its scope globals, and every other name it provides. */
 export interface ScriptRuntime {
-    /** The identifier the runtime binds the variable scope to (`$vars` in Flow). */
-    scopeGlobal: string;
+    /**
+     * The scopes the runtime binds, in parameter order (`$vars`, then `$metadata`,
+     * in Flow): a script function takes one parameter per scope, or fewer.
+     */
+    scopes: readonly ScriptScope[];
     /** Every other global name the runtime provides: the language built-ins it has, `console`. */
     globals: ReadonlySet<string>;
     /**
@@ -75,19 +94,30 @@ export declare function scriptFunctionLowerings(): readonly string[];
 /** Options for {@link tryLowerScriptFunction}. */
 export interface LowerOptions {
     /**
-     * Refuse any use of the parameter other than a dotted read (`vars.start…`):
+     * Refuse any use of a parameter other than a dotted read (`vars.start…`):
      * an alias (`const v = vars`), a computed read (`vars['start']`), an optional
      * read (`vars?.start`), or passing it on (`pick(vars)`, `{ vars }`) each hides
      * the step it reads from `renameRefs` and the reference check, which see only
-     * `$vars.<name>`. Authoring (`script(fn)`) sets it; decompile's gate does not,
-     * because there the text is the node's own either way.
+     * `$vars.<name>` (and, for `$metadata`, the key it reads from the key check).
+     * Authoring (`script(fn)`) sets it; decompile's gate does not, because there
+     * the text is the node's own either way.
      */
     scopeReadsOnly?: boolean;
 }
 /** What lowering a function's source produced: its body, or every problem with it. */
-export type LoweredScript = {
+export type LoweredScript = 
+/**
+ * `scopesRead` is the scope globals whose parameter the body reads, and
+ * `scopesDeclared` the ones the body binds in the function's own scope (a
+ * top-level `let`, `const`, `class` or `function`, or a `var` outside a nested
+ * function), each in scope order. A body that binds one reads its own local,
+ * and a parameter of that name printed beside it would clash.
+ */
+{
     ok: true;
     code: string;
+    scopesRead: string[];
+    scopesDeclared: string[];
 }
 /**
  * `free` is the names the runtime would not have, also described in `problems`;
@@ -111,18 +141,18 @@ export declare function tryLowerScriptFunction(source: string, runtime: ScriptRu
 export declare function scriptBodySyntaxError(code: string): string | undefined;
 /**
  * The JavaScript engine's early error for a body run as
- * `function (<scopeGlobal>) { "use strict"; <code> }`, or undefined when it has
+ * `function (<params>) { "use strict"; <code> }`, or undefined when it has
  * none.
  *
  * TypeScript's parser does not report early errors (a duplicate `let`, a
- * `const $vars` that clashes with the parameter, an octal literal in strict
+ * `const $vars` that clashes with a parameter, an octal literal in strict
  * code), and the printed function lives in an ES module, which is strict. A body
  * with one would make the whole module unloadable, so decompile asks the engine.
  * The body is compiled, never called. A host without the `Function`
  * constructor (a strict content-security policy) cannot answer, which is
  * reported as an error too, so the caller keeps the string form.
  */
-export declare function scriptBodyEarlyError(code: string, runtime: ScriptRuntime): string | undefined;
+export declare function scriptBodyEarlyError(code: string, params: readonly string[]): string | undefined;
 /**
  * The first piece of TypeScript-only syntax in a body, described, or undefined.
  *
@@ -134,5 +164,9 @@ export declare function scriptBodyEarlyError(code: string, runtime: ScriptRuntim
  * string form.
  */
 export declare function scriptBodyTypeScriptSyntax(code: string): string | undefined;
+/** The checker of a one-file program over `sf`, with no default library: globals resolve to nothing. */
+export declare function oneFileChecker(ts: typeof TS, sf: TS.SourceFile): TS.TypeChecker;
+/** The checker's own symbol for `undefined`, which a no-lib program still binds. */
+export declare function isUndefinedSymbol(s: TS.Symbol): boolean;
 /** Whether `id` is read as a value, not a property name, label, or type. */
 export declare function isReference(ts: typeof TS, id: TS.Identifier): boolean;