@uipath/maestro-builder-sdk 6.14.5 → 6.15.0
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.
- package/dist/api-index.md +71 -71
- package/dist/api-members.md +324 -323
- package/dist/bpmn/bpmn-sdk.d.ts +16 -0
- package/dist/bpmn/bpmn-sdk.js +2 -0
- package/dist/bpmn/check-cli.js +22 -5
- package/dist/bpmn/check.d.ts +15 -1
- package/dist/bpmn/check.js +69 -2
- package/dist/bpmn/compile-cli.js +24 -14
- package/dist/bpmn/connector.js +29 -14
- package/dist/bpmn/intsvc.js +5 -2
- package/dist/bpmn/serialize.d.ts +2 -0
- package/dist/bpmn/serialize.js +1 -1
- package/dist/case/compile-cli.js +6 -9
- package/dist/case/serialize.js +1 -1
- package/dist/check-cli.js +6 -35
- package/dist/check.d.ts +16 -148
- package/dist/check.js +33 -709
- package/dist/cli/commands/bpmn.js +15 -0
- package/dist/cli-library.d.ts +6 -25
- package/dist/cli-library.js +6 -73
- package/dist/core/cli-library.d.ts +47 -0
- package/dist/core/cli-library.js +150 -0
- package/dist/core/connector-checks.d.ts +226 -0
- package/dist/core/connector-checks.js +518 -0
- package/dist/core/connector-inputs.d.ts +80 -0
- package/dist/core/connector-inputs.js +453 -0
- package/dist/core/event-checks.d.ts +137 -0
- package/dist/core/event-checks.js +321 -0
- package/dist/decompile.js +1 -1
- package/dist/registry/generators/markdown/sections/example.d.ts +7 -1
- package/dist/registry/generators/markdown/sections/example.js +70 -5
- package/dist/registry/generators/markdown/sections/lookups.js +29 -8
- package/dist/registry/prepare/messages.js +6 -1
- package/dist/registry/prepare/source-import.d.ts +3 -3
- package/dist/registry/prepare/source-import.js +15 -4
- package/dist/registry/prepare/source-labels.js +31 -4
- package/dist/serialize.d.ts +11 -11
- package/dist/serialize.js +27 -420
- package/package.json +2 -2
- /package/dist/{event-filters.d.ts → core/event-filters.d.ts} +0 -0
- /package/dist/{event-filters.js → core/event-filters.js} +0 -0
package/dist/check.d.ts
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
|
-
import { type LookupResolutions, type LookupSpec } from './core/lookups.js';
|
|
2
|
-
import type { SchemaReadiness } from './core/library.js';
|
|
3
1
|
import type { BuiltFlow } from './flow-sdk.js';
|
|
4
|
-
import { type
|
|
5
|
-
|
|
2
|
+
import { type EventCheckOpts } from './core/event-checks.js';
|
|
3
|
+
export type { EventParamFields } from './core/event-checks.js';
|
|
4
|
+
import { type ConnectorCheckOpts } from './core/connector-checks.js';
|
|
6
5
|
export interface Diagnostic {
|
|
7
6
|
level: 'error' | 'warning';
|
|
8
7
|
code: string;
|
|
@@ -10,157 +9,26 @@ export interface Diagnostic {
|
|
|
10
9
|
step?: string;
|
|
11
10
|
suggestion?: string;
|
|
12
11
|
}
|
|
13
|
-
/**
|
|
14
|
-
* What a connector operation declares as its EVENT PARAMETERS — the `where` half
|
|
15
|
-
* of a subscription. `known: false` means "no library was supplied", which is a
|
|
16
|
-
* different answer from `known: true, names: []` ("this operation takes none").
|
|
17
|
-
* Conflating the two is what made `EVENT_NO_SCOPE` an error for the HTTP Webhook
|
|
18
|
-
* connector, whose only correct `where` is empty.
|
|
19
|
-
*/
|
|
20
|
-
export interface EventParamFields {
|
|
21
|
-
known: boolean;
|
|
22
|
-
names: string[];
|
|
23
|
-
/**
|
|
24
|
-
* The operation is a GENERIC event (`activityType: GenericTrigger`): its node type
|
|
25
|
-
* covers every object of the connection, so the subscription must name one with
|
|
26
|
-
* `object`. Unknown (no library) reads as `false`, which fails open.
|
|
27
|
-
*/
|
|
28
|
-
generic?: boolean;
|
|
29
|
-
/** The entry's own object — `''` for a generic event, the built-in one for a curated event. */
|
|
30
|
-
object?: string;
|
|
31
|
-
/**
|
|
32
|
-
* Required parameters that SELECT the schema rather than scope the
|
|
33
|
-
* subscription (Jira's `project` / `issuetype`). Their values decide which
|
|
34
|
-
* filter and output fields exist, and no CLI surface accepts them — so when
|
|
35
|
-
* this is non-empty the known filter vocabulary is a BASELINE, and a leaf
|
|
36
|
-
* outside it may still be legal.
|
|
37
|
-
*/
|
|
38
|
-
selectors?: string[];
|
|
39
|
-
/**
|
|
40
|
-
* The named object has no prepared variant on a connector whose objects come
|
|
41
|
-
* from the connection — the generic template answered instead.
|
|
42
|
-
*/
|
|
43
|
-
objectUnprepared?: boolean;
|
|
44
|
-
/**
|
|
45
|
-
* The connector discovers custom fields per connection and nothing has
|
|
46
|
-
* prepared this event, so the known vocabulary is a strict subset of the
|
|
47
|
-
* tenant's BY DESIGN.
|
|
48
|
-
*/
|
|
49
|
-
customFieldsUnprepared?: boolean;
|
|
50
|
-
/**
|
|
51
|
-
* The filter vocabulary is a subset that NO prepare can complete.
|
|
52
|
-
*
|
|
53
|
-
* An activity closes this gap: `resources describe` takes `-f name=value`
|
|
54
|
-
* and `--action`, so supplying the parent values runs the connector's
|
|
55
|
-
* ObjectAction (Jira `GenerateSchema`, Salesforce `GenerateQuerySchema`) and
|
|
56
|
-
* the custom fields come back. `uip is triggers describe` has neither flag,
|
|
57
|
-
* so for an EVENT on a custom-field-discovering connector there is no call
|
|
58
|
-
* that reaches the parent-scoped fields — the designer grows Jira's filter
|
|
59
|
-
* list once a project and issue type are picked, and nothing in this CLI
|
|
60
|
-
* can. Distinct from `customFieldsUnprepared`, which preparing DOES fix.
|
|
61
|
-
*/
|
|
62
|
-
filtersPartial?: boolean;
|
|
63
|
-
}
|
|
64
12
|
export interface ListEnvelopeFields {
|
|
65
13
|
envelope: string | null;
|
|
66
14
|
source: string;
|
|
67
15
|
tier: string;
|
|
68
16
|
}
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
* `undefined` when the library resolves it. `kind` is the node form compile
|
|
83
|
-
* asks for: `trigger` for `onEvent` (the flow's trigger and every entry point),
|
|
84
|
-
* `event` for `waitForEvent`. Supplied by the CLIs from the same
|
|
85
|
-
* `library.resolveEvent(kind, connector, event, version, object)` call
|
|
86
|
-
* `serialize` makes (`eventResolveErrorFor` in `cli-library.ts`), so the two
|
|
87
|
-
* cannot disagree; omitted (no library) → not checked.
|
|
88
|
-
*
|
|
89
|
-
* Before this hook `check` could only warn EVENT_UNPREPARED here, because
|
|
90
|
-
* `eventParams` answers `undefined` for "cannot resolve" and for "no facts"
|
|
91
|
-
* alike: it printed `0 error(s)` on a source `compile` then refused
|
|
92
|
-
* (2026-09-23, `skill-flow-datafabric-trigger-lifecycle`, v2 commands 31 and 46).
|
|
93
|
-
*/
|
|
94
|
-
eventResolveError?: (kind: 'trigger' | 'event', subscription: {
|
|
95
|
-
connector: string;
|
|
96
|
-
event: string;
|
|
97
|
-
version?: string;
|
|
98
|
-
object?: string;
|
|
99
|
-
}) => string | undefined;
|
|
100
|
-
/**
|
|
101
|
-
* Resolve a connector event's FILTERABLE field names — the vocabulary a
|
|
102
|
-
* `filters` leaf may name — sourced the same way as `eventParams`. A GENERIC
|
|
103
|
-
* event's vocabulary is per object, so the subscription's `object` rides
|
|
104
|
-
* along. `undefined` means unknown and fails open; a known-EMPTY list also
|
|
105
|
-
* fails open, because connectors that declare no filter fields exist and
|
|
106
|
-
* refusing every leaf on their events would turn a coverage gap into a
|
|
107
|
-
* false error.
|
|
108
|
-
*/
|
|
109
|
-
eventFilterFields?: (connector: string, event: string, object?: string) => string[] | undefined;
|
|
110
|
-
/**
|
|
111
|
-
* Resolve one connector operation's generated lookup table, keyed by field.
|
|
112
|
-
*
|
|
113
|
-
* Supplied by the CLIs when a library is on hand, omitted otherwise — so a
|
|
114
|
-
* `check` with no library simply does not fire the lookup rules rather than
|
|
115
|
-
* guessing at them.
|
|
116
|
-
*/
|
|
117
|
-
lookups?: (connector: string, action: string, version?: string, object?: string) => Readonly<Record<string, LookupSpec>> | undefined;
|
|
118
|
-
/** Everything `registry prepare --resolve` has recorded in the local overlay. */
|
|
119
|
-
resolutions?: LookupResolutions;
|
|
120
|
-
/**
|
|
121
|
-
* A connector event's BYOA and webhook-URL facts, or `undefined` when unknown.
|
|
122
|
-
* Supplied by the CLIs from `library.eventFacts` — the call `serialize` makes
|
|
123
|
-
* for the same refusal — so check and compile cannot disagree; omitted (no
|
|
124
|
-
* library) → EVENT_BYOA_UNVERIFIED is not checked.
|
|
125
|
-
*/
|
|
126
|
-
eventFacts?: (connector: string, event: string, object?: string) => ByoaEventFacts | undefined;
|
|
127
|
-
/**
|
|
128
|
-
* The BYOA checks `registry prepare` recorded — the `byoa` section of the
|
|
129
|
-
* overlay's `resolutions.json`, as `library.byoaVerifications` loads it.
|
|
130
|
-
*/
|
|
131
|
-
byoa?: ByoaLedger;
|
|
132
|
-
/**
|
|
133
|
-
* Whether a connector step's schema is materialized locally — the fact behind
|
|
134
|
-
* the OBJECT_UNPREPARED and CUSTOM_FIELDS_UNPREPARED warnings. Supplied by the
|
|
135
|
-
* CLIs when a library is on hand, omitted otherwise, same as `lookups`: with
|
|
136
|
-
* no library, `check` cannot know what is owed and says nothing.
|
|
137
|
-
*/
|
|
138
|
-
schemaReadiness?: (connector: string, action: string, version?: string, object?: string) => SchemaReadiness | undefined;
|
|
17
|
+
/**
|
|
18
|
+
* The facts `check` cannot derive from the built flow.
|
|
19
|
+
*
|
|
20
|
+
* Two of the three bags are shared with the other families — the connector rules
|
|
21
|
+
* (`core/connector-checks.ts`) and the event rules (`core/event-checks.ts`) were
|
|
22
|
+
* never flow-shaped. What is left here is the one hook only Flow has a site for.
|
|
23
|
+
*
|
|
24
|
+
* Every member is optional and every rule that reads one fails OPEN: `check` is
|
|
25
|
+
* the fast inner-loop rung and stays a pure function of the built flow without a
|
|
26
|
+
* library. Given one, `compile` and `check` make the SAME call with the facts in
|
|
27
|
+
* hand, which is what keeps the two rungs from disagreeing.
|
|
28
|
+
*/
|
|
29
|
+
export interface CheckOpts extends ConnectorCheckOpts, EventCheckOpts {
|
|
139
30
|
/** Resolve the measured collection envelope for one connector operation. */
|
|
140
31
|
listEnvelope?: (connector: string, operation: string, version?: string, object?: string) => ListEnvelopeFields | undefined;
|
|
141
|
-
/**
|
|
142
|
-
* What `compile` would refuse one connector step's inputs with — a missing
|
|
143
|
-
* required field, an unknown or mistyped input, a container part given a value —
|
|
144
|
-
* or `undefined` when it would accept them. Supplied by the CLIs from the same
|
|
145
|
-
* library-backed validator `serialize` runs (`connectorInputErrors`), so the
|
|
146
|
-
* inner loop and the emit rung cannot disagree; omitted (no library) → not checked.
|
|
147
|
-
* Before this hook, `check` printed `0 error(s)` for a source `compile` then
|
|
148
|
-
* refused twice in a row (teams-decision, 2026-09-01, turns 22–25).
|
|
149
|
-
*/
|
|
150
|
-
connectorInputs?: (spec: {
|
|
151
|
-
key: string;
|
|
152
|
-
action: string;
|
|
153
|
-
version?: string;
|
|
154
|
-
object?: string;
|
|
155
|
-
}, inputs: Record<string, unknown>) => string | undefined;
|
|
156
|
-
/**
|
|
157
|
-
* The project's `bindings.json`, when there is one — enough of it to detect the
|
|
158
|
-
* two labels `compile` refuses: an entry that answers with its own name
|
|
159
|
-
* (BINDING_SELF_NAME), and a label a populated file does not declare
|
|
160
|
-
* (BINDING_UNDECLARED). `declared` and `entry` are optional so a caller holding
|
|
161
|
-
* only `resolve` still gets the first rule; the `Bindings` class has all three.
|
|
162
|
-
*/
|
|
163
|
-
bindings?: BindingsView;
|
|
164
32
|
}
|
|
165
33
|
export declare function check(built: BuiltFlow, opts?: CheckOpts): Diagnostic[];
|
|
166
34
|
/**
|