@uipath/maestro-builder-sdk 6.2.0 → 6.4.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/README.md +3 -2
- package/dist/api-index.md +8 -8
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -151,8 +151,9 @@ to the tenant instead of one per field.
|
|
|
151
151
|
The same builder core, the same four verbs. Import from
|
|
152
152
|
`@uipath/maestro-builder-sdk/case` or `@uipath/maestro-builder-sdk/bpmn`, name the file
|
|
153
153
|
`<Name>.case.ts` or `<Name>.bpmn.ts`, and swap the family in the command:
|
|
154
|
-
`uip maestro case compile` / `uip maestro bpmn compile`. Their builder surfaces
|
|
155
|
-
|
|
154
|
+
`uip maestro case compile` / `uip maestro bpmn compile`. Their builder surfaces are in the same
|
|
155
|
+
generated indexes as Flow's — `api-index.md` by symbol name, `api-members.md` by
|
|
156
|
+
field or method name — which cover all three entry points.
|
|
156
157
|
|
|
157
158
|
## Commands
|
|
158
159
|
|
package/dist/api-index.md
CHANGED
|
@@ -19,7 +19,7 @@ compiler checks your source against, and it carries the `@remarks` and
|
|
|
19
19
|
`@example` bodies the reference pages leave out. The span below is the whole
|
|
20
20
|
declaration including its doc comment, so one read is the complete answer.
|
|
21
21
|
|
|
22
|
-
Paths are relative to the
|
|
22
|
+
Paths are relative to the package root — the directory above this file:
|
|
23
23
|
|
|
24
24
|
```
|
|
25
25
|
node_modules/@uipath/maestro-builder-sdk/dist/core/actions.d.ts lines 539-610
|
|
@@ -29,11 +29,11 @@ Open the file at that line. No search, no `grep`, nothing shell-specific —
|
|
|
29
29
|
which also means this works on Windows, where the command the reference pages
|
|
30
30
|
used to suggest does not.
|
|
31
31
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
versions — a line moves whenever
|
|
35
|
-
|
|
36
|
-
|
|
32
|
+
This file is generated by the build that emits the `.d.ts` files beside it, so
|
|
33
|
+
its spans are always true of THIS installed version. They are not stable across
|
|
34
|
+
versions — a line moves whenever a declaration above it changes — which is why
|
|
35
|
+
the index ships here and nowhere else: anywhere with its own release cadence
|
|
36
|
+
could hand you spans for a version you do not have.
|
|
37
37
|
|
|
38
38
|
## `@uipath/maestro-builder-sdk`
|
|
39
39
|
|
|
@@ -76,7 +76,7 @@ that is the thing to check first.
|
|
|
76
76
|
| `ConnectorLookupValue` | type | `dist/core/connectors.d.ts:50-59` | Generated descriptors | ConnectorValue for a field that also accepts an unresolved lookup. |
|
|
77
77
|
| `ConnectorMeta` | interface | `dist/core/connectors.d.ts:60-88` | Generated descriptors | Runtime metadata a generated descriptor carries. |
|
|
78
78
|
| `ConnectorOpts` | interface | `dist/core/actions.d.ts:177-217` | Option shapes | 4 field(s) |
|
|
79
|
-
| `ConnectorToolRef` | interface | `dist/core/actions.d.ts:1762-1780` | Supporting types | An Integration Service connector operation as a tool — e.g. |
|
|
79
|
+
| `ConnectorToolRef` | interface | `dist/core/actions.d.ts:1762-1780` | Supporting types | An Integration Service connector operation as a tool — e.g. "create a Jira issue". |
|
|
80
80
|
| `ConnectorValue` | type | `dist/core/connectors.d.ts:26-49` | Generated descriptors | What a generated `Inputs` property accepts: the value, or an expression. |
|
|
81
81
|
| `ContextIndexRef` | interface | `dist/core/actions.d.ts:1913-1947` | Supporting types | One Context Grounding index an inline agent is grounded on. |
|
|
82
82
|
| `ContributionContext` | interface | `dist/core/node-classes.d.ts:64-75` | Supporting types | What the serializer tells a contributor before asking for its contribution. |
|
|
@@ -180,7 +180,7 @@ that is the thing to check first.
|
|
|
180
180
|
| `NodeContribution` | interface | `dist/core/node-classes.d.ts:98-121` | Supporting types | One validated construct, returned by FlowNode.contribute. |
|
|
181
181
|
| `NodeLayout` | interface | `dist/flow-sdk.d.ts:530-544` | Supporting types | One node's designer layout: canvas position, and optionally size and collapsed state. |
|
|
182
182
|
| `NodeOptions` | interface | `dist/flow-sdk.d.ts:308-353` | Option shapes | Options shared by every builder method that creates a definition-backed node: `version` selects the exact node… |
|
|
183
|
-
| `onEvent` | function | `dist/flow-sdk.d.ts:140-177` | Flow construction | Start the flow when a connector event fires — e.g. |
|
|
183
|
+
| `onEvent` | function | `dist/flow-sdk.d.ts:140-177` | Flow construction | Start the flow when a connector event fires — e.g. an email arriving in a mailbox folder. |
|
|
184
184
|
| `onEvent` | function | `dist/flow-sdk.d.ts:178-185` | Flow construction | Stringly form, for an event with no prepared module. |
|
|
185
185
|
| `out` | function | `dist/core/expr.d.ts:67-89` | Expressions and types | Reference an upstream step's output → `$vars.<step>.output[.<path>]`. |
|
|
186
186
|
| `Outcome` | type | `dist/core/actions.d.ts:455-466` | Supporting types | One completion button. |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uipath/maestro-builder-sdk",
|
|
3
|
-
"version": "6.
|
|
3
|
+
"version": "6.4.0",
|
|
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",
|
|
@@ -64,9 +64,9 @@
|
|
|
64
64
|
"node": ">=22.6"
|
|
65
65
|
},
|
|
66
66
|
"scripts": {
|
|
67
|
-
"build": "tsc && tsc -p cli/tsconfig.json && cp
|
|
67
|
+
"build": "tsc && tsc -p cli/tsconfig.json && cp src/core-definitions.json dist/core-definitions.json && cp src/ixp-definition.json dist/ixp-definition.json && cp src/bpmn/uipath-moddle.v1.json dist/bpmn/uipath-moddle.v1.json && cp src/bpmn/registry-types.json dist/bpmn/registry-types.json && node scripts/copy-registry-generators.mjs && node scripts/extract-api-model.mjs --check && node scripts/gen-api-index.mjs && node scripts/api-doc-coverage.mjs --check && node scripts/check-api-docs.mjs",
|
|
68
68
|
"check:package": "node scripts/check-package-contents.mjs",
|
|
69
|
-
"generate:api": "node scripts/extract-api-model.mjs && node scripts/gen-api-
|
|
69
|
+
"generate:api": "node scripts/extract-api-model.mjs && node scripts/gen-api-index.mjs",
|
|
70
70
|
"docs:check": "node scripts/check-api-docs.mjs",
|
|
71
71
|
"coverage:flow": "node scripts/audit-flow-coverage.mjs",
|
|
72
72
|
"coverage:case": "node scripts/audit-case-coverage.mjs",
|
|
@@ -87,5 +87,5 @@
|
|
|
87
87
|
"@types/node": "^22.7.0",
|
|
88
88
|
"esbuild": "^0.28.1"
|
|
89
89
|
},
|
|
90
|
-
"gitref": "
|
|
90
|
+
"gitref": "594dde34b44308821784ee0ca69b529f3900374d"
|
|
91
91
|
}
|