@sanity/workflow-mcp 0.3.0 → 0.5.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 +1 -1
- package/dist/index.cjs +101 -68
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +18 -18
- package/dist/index.d.ts +18 -18
- package/dist/index.js +101 -68
- package/dist/index.js.map +1 -1
- package/dist/stdio.js +6 -2
- package/dist/stdio.js.map +1 -1
- package/package.json +4 -4
package/dist/index.js
CHANGED
|
@@ -2,16 +2,15 @@ import { extractDocumentId, actionVerdict, isTerminalStage, validateDefinition,
|
|
|
2
2
|
import { defineWorkflow } from "@sanity/workflow-engine/define";
|
|
3
3
|
const minimalExample = {
|
|
4
4
|
name: "quick-approval",
|
|
5
|
-
version: 1,
|
|
6
5
|
title: "Quick approval",
|
|
7
6
|
description: "One review stage with a single approve action, then a terminal stage.",
|
|
8
7
|
initialStage: "review",
|
|
9
|
-
fields: [{ type: "doc.ref", name: "subject", title: "Document",
|
|
8
|
+
fields: [{ type: "doc.ref", name: "subject", title: "Document", initialValue: { type: "input" } }],
|
|
10
9
|
stages: [
|
|
11
10
|
{
|
|
12
11
|
name: "review",
|
|
13
12
|
title: "Review",
|
|
14
|
-
|
|
13
|
+
activities: [
|
|
15
14
|
{
|
|
16
15
|
name: "decide",
|
|
17
16
|
title: "Decide",
|
|
@@ -25,16 +24,15 @@ const minimalExample = {
|
|
|
25
24
|
]
|
|
26
25
|
}, reviewLoopExample = {
|
|
27
26
|
name: "doc-review",
|
|
28
|
-
version: 1,
|
|
29
27
|
title: "Document review",
|
|
30
28
|
description: "Draft, then editorial review that approves or rejects back to drafting.",
|
|
31
29
|
initialStage: "drafting",
|
|
32
|
-
fields: [{ type: "doc.ref", name: "subject", title: "Document",
|
|
30
|
+
fields: [{ type: "doc.ref", name: "subject", title: "Document", initialValue: { type: "input" } }],
|
|
33
31
|
stages: [
|
|
34
32
|
{
|
|
35
33
|
name: "drafting",
|
|
36
34
|
title: "Drafting",
|
|
37
|
-
|
|
35
|
+
activities: [
|
|
38
36
|
{
|
|
39
37
|
name: "write",
|
|
40
38
|
title: "Write the draft",
|
|
@@ -47,7 +45,7 @@ const minimalExample = {
|
|
|
47
45
|
{
|
|
48
46
|
name: "review",
|
|
49
47
|
title: "Editorial review",
|
|
50
|
-
|
|
48
|
+
activities: [
|
|
51
49
|
{
|
|
52
50
|
name: "review",
|
|
53
51
|
title: "Review the draft",
|
|
@@ -60,18 +58,18 @@ const minimalExample = {
|
|
|
60
58
|
],
|
|
61
59
|
transitions: [
|
|
62
60
|
{ name: "to-approved", title: "Approve and finish", to: "approved" },
|
|
63
|
-
// Reject flips the
|
|
61
|
+
// Reject flips the activity to `failed`; this routes the instance back.
|
|
64
62
|
{
|
|
65
63
|
name: "to-drafting",
|
|
66
64
|
title: "Send back to drafting",
|
|
67
65
|
to: "drafting",
|
|
68
|
-
filter: "$
|
|
66
|
+
filter: "$anyActivityFailed"
|
|
69
67
|
}
|
|
70
68
|
]
|
|
71
69
|
},
|
|
72
70
|
{ name: "approved", title: "Approved", description: "Terminal \u2014 no transitions out." }
|
|
73
71
|
]
|
|
74
|
-
}, ORIENTATION = "# Authoring a workflow definition\n\nA workflow definition is a plain JSON object. There is no code in it \u2014 every\ncondition (filters, predicates, guards) is a GROQ *string*. Generate the JSON,\nthen call `validate_workflow_definition` to check it; fix the reported errors\nand re-validate until it returns `valid: true`. The validator returns the\n*desugared* definition under `definition` \u2014 that is exactly what would deploy.\n\n## Shape\n\n- **Workflow**: `{ name,
|
|
72
|
+
}, ORIENTATION = "# Authoring a workflow definition\n\nA workflow definition is a plain JSON object. There is no code in it \u2014 every\ncondition (filters, predicates, guards) is a GROQ *string*. Generate the JSON,\nthen call `validate_workflow_definition` to check it; fix the reported errors\nand re-validate until it returns `valid: true`. The validator returns the\n*desugared* definition under `definition` \u2014 that is exactly what would deploy.\n\n## Shape\n\n- **Workflow**: `{ name, title, description?, initialStage, fields?, stages[], predicates? }`.\n `initialStage` must be the `name` of a declared stage. Do NOT include a\n `version` \u2014 definitions are immutable and content-addressed; deploy assigns\n the version from the content, the author never writes one.\n- **Stage**: `{ name, title?, description?, activities?, transitions? }`. A stage with\n no transitions is terminal. Reaching a terminal stage ends the workflow.\n- **Activity**: `{ name, title?, activation?, actions? }`. `activation` is `'auto'`\n (starts when the stage is entered) or `'manual'` (default \u2014 a human starts it).\n- **Action**: `{ name, title?, status?, params?, ops? }`.\n `status: 'done' | 'skipped' | 'failed'` is sugar that flips the *firing activity* to\n that status when the action fires. `ops` are mutations applied when the action\n fires (e.g. `{type:'field.set', target:{field:'x'}, value:{type:'param', param:'p'}}`).\n `params` are values the action collects from the caller (referenced by\n `{type:'param', param:'<name>'}` sources).\n- **Transition**: `{ name, title?, to, filter? }`. `to` must name a declared\n stage. `filter` is a GROQ condition gating the exit; omit it and it defaults\n to `$allActivitiesDone`.\n- **Field** (workflow- or stage-scoped persistent state): `{ type, name, title?, initialValue? }`.\n Scalar `type`s mirror Sanity: `string`, `text` (multiline), `number`,\n `boolean`, `date` (YYYY-MM-DD), `datetime` (ISO), `url`. Plus references\n (`doc.ref`, `doc.refs`, `release.ref`), identities (`actor` \u2014 one concrete\n principal; `assignee` / `assignees` \u2014 one or many user-or-role assignees), and\n the compositional kinds `object` (`{ type:'object', name, fields: [...] }`) and\n `array` (`{ type:'array', name, of: [...] }`) \u2014 `fields`/`of` are themselves\n field shapes, so any structure composes. `initialValue` seeds the slot once at\n materialisation and is **optional** \u2014 omit it for op-filled working memory\n (the common default). Arms: `{type:'input'}` (the caller supplies it when the\n instance starts), `{type:'query', query:'<groq>'}` (computed from the lake),\n `{type:'literal', value:<json>}`, or `{type:'fieldRead', field:'<name>'}`.\n By convention a workflow has an `input`-sourced `doc.ref` named `subject` \u2014 the\n headline document it is about.\n Two list sugars desugar to `array`: `{type:'todoList', name}` (ad-hoc\n status-tracked work \u2014 rows `{ label, status, assignee?, dueDate? }`) and\n `{type:'notes', name}` (an append-only audit/comment log \u2014 rows\n `{ body, actor, at }`; pairs with the `audit` op, which stamps `actor`/`at`).\n\n## GROQ in conditions\n\nBuilt-in variables available in filters/predicates: `$allActivitiesDone`,\n`$anyActivityFailed` (booleans over the current stage's activities), `$activities` (the activity\nlist), `$fields` (field values), `$now`, and the caller-scoped vars `$actor`\n(the acting user), `$assigned` (whether the caller is the activity's assignee \u2014 the\nidiomatic permission gate, used as `filter: '$assigned'`), and `$can`. Define\nreusable named conditions under top-level `predicates: { name: '<groq>' }` and\nreference them as `$name` (e.g.\n`predicates: { ready: \"count($activities[status != 'done']) == 0\" }` \u2192 `$ready`).\n\nConditions evaluate against an in-memory snapshot (the instance + its subject +\nfield-declared docs) \u2014 **never** scan by `_type` (e.g. `*[_type==\"article\"]`);\nthat is a discovery query and the validator rejects it. To bring a document into\nscope, declare a `doc.ref` field for it.\n\n## Sugars worth knowing\n\n- Action `status: 'done' | 'skipped' | 'failed'` \u2014 flips the firing activity (shown above).\n- Omitted transition `filter` \u2014 defaults to `$allActivitiesDone`.\n- Omitted activity `activation` \u2014 defaults to `'manual'`.\n\n## Modeling defaults\n\nValid is not the same as good. Prefer these unless the request says otherwise:\n\n- **A decline/reject loops back.** Route a rejected / changes-requested\n transition to an *earlier* stage for revision (e.g. `review \u2192 drafting` gated\n on `$anyActivityFailed`), not to a terminal stage. Reserve terminal stages for\n completion and for explicit cancellation/abandonment \u2014 a workflow should not\n dead-end just because something was declined.\n- **Prefer draft \u2192 review.** Model an author working in a drafting stage who\n submits, then a review stage that gates. Don't add more review stages unless\n the request asks for multiple approvers or rounds.\n- **When the shape is ambiguous, pick the conventional one and confirm** with the\n user rather than inventing extra stages.\n\n## Rules the validator enforces\n\n- Stage names, activity names (per stage) and transition names are unique.\n- Every transition `to` and `initialStage` names a declared stage.\n- Custom `predicates` must not shadow a built-in (e.g. `allActivitiesDone`).\n- Every GROQ string must parse and must not be a `_type` discovery scan.", AUTHORING_GUIDE = `${ORIENTATION}
|
|
75
73
|
|
|
76
74
|
## Examples
|
|
77
75
|
|
|
@@ -106,7 +104,7 @@ ${JSON.stringify(reviewLoopExample, null, 2)}
|
|
|
106
104
|
},
|
|
107
105
|
{
|
|
108
106
|
name: "get_workflow_state",
|
|
109
|
-
description: "Get the current state of a single workflow instance, projected for action. Returns the workflow's id and human-readable `workflowTitle`, the current stage, the subject document the workflow is about (when the workflow has a conventional subject \u2014 its ref and title), every
|
|
107
|
+
description: "Get the current state of a single workflow instance, projected for action. Returns the workflow's id and human-readable `workflowTitle`, the current stage, the subject document the workflow is about (when the workflow has a conventional subject \u2014 its ref and title), every activity on the current stage with its available actions (and whether each action is currently allowed), and the most recent history entries. Use this whenever you need to understand what's possible on an instance before deciding to act. This is a pure read \u2014 it does not change anything. If you only need to discover what instances exist, use list_workflow_instances instead; this tool requires you to know the instance id. list_workflow_instances also returns the same `workflowTitle` and `subject` fields, so prefer it for fan-out discovery rather than polling get_workflow_state per instance.",
|
|
110
108
|
input_schema: {
|
|
111
109
|
type: "object",
|
|
112
110
|
properties: {
|
|
@@ -121,7 +119,7 @@ ${JSON.stringify(reviewLoopExample, null, 2)}
|
|
|
121
119
|
},
|
|
122
120
|
{
|
|
123
121
|
name: "diagnose_workflow",
|
|
124
|
-
description: "Explain why a single workflow instance is or isn't progressing. Returns a verdict (`state`: progressing, waiting, blocked, completed, aborted, or stuck), a one-line `summary`, and \u2014 when stuck \u2014 a structured `cause` plus the `remediations` that would unstick it. Use this when an instance seems stalled or the user asks \"why isn't this moving?\": it distinguishes a healthy instance (waiting on a human, or will advance on its own) from a genuinely stuck one (a failed effect or
|
|
122
|
+
description: "Explain why a single workflow instance is or isn't progressing. Returns a verdict (`state`: progressing, waiting, blocked, completed, aborted, or stuck), a one-line `summary`, and \u2014 when stuck \u2014 a structured `cause` plus the `remediations` that would unstick it. Use this when an instance seems stalled or the user asks \"why isn't this moving?\": it distinguishes a healthy instance (waiting on a human, or will advance on its own) from a genuinely stuck one (a failed effect or activity, a dead-end transition). This is a pure read \u2014 it changes nothing, and the remediations it names are advisory: none can be executed through this server. To actually advance a healthy waiting instance use fire_action; for per-activity action detail use get_workflow_state.",
|
|
125
123
|
input_schema: {
|
|
126
124
|
type: "object",
|
|
127
125
|
properties: {
|
|
@@ -136,7 +134,7 @@ ${JSON.stringify(reviewLoopExample, null, 2)}
|
|
|
136
134
|
},
|
|
137
135
|
{
|
|
138
136
|
name: "fire_action",
|
|
139
|
-
description: "Advance a workflow instance by firing an action on one of its
|
|
137
|
+
description: "Advance a workflow instance by firing an action on one of its activities. This is the only way to advance workflow state from the outside \u2014 there is no separate 'complete activity' or 'transition stage' tool. To find the right (activity, action) pair, call get_workflow_state first and pick from the allowed actions listed on the current stage's activities. After firing, the engine cascades any auto-transitions that become eligible (so an 'approve' action on a review activity may transition the workflow to a terminal stage in one shot). Returns the resulting state, same shape as get_workflow_state. If the action is not currently allowed (e.g. the activity is already done, or a guard fails), this returns an error describing why.",
|
|
140
138
|
input_schema: {
|
|
141
139
|
type: "object",
|
|
142
140
|
properties: {
|
|
@@ -144,16 +142,21 @@ ${JSON.stringify(reviewLoopExample, null, 2)}
|
|
|
144
142
|
type: "string",
|
|
145
143
|
description: "The workflow instance id."
|
|
146
144
|
},
|
|
147
|
-
|
|
145
|
+
activity: {
|
|
148
146
|
type: "string",
|
|
149
|
-
description: "The id of the
|
|
147
|
+
description: "The id of the activity on the current stage. Must be one of the activities returned by get_workflow_state."
|
|
150
148
|
},
|
|
151
149
|
action: {
|
|
152
150
|
type: "string",
|
|
153
|
-
description: "The id of the action on that
|
|
151
|
+
description: "The id of the action on that activity. Must be one of the actions listed as allowed=true on the activity."
|
|
152
|
+
},
|
|
153
|
+
params: {
|
|
154
|
+
type: "object",
|
|
155
|
+
description: `Optional. Values for the action's declared params, keyed by param name (e.g. {"note": "Unsupported claim in paragraph 3."}). Required when the action declares a required param \u2014 get_workflow_state lists each action's params and whether they are required. The shape is per-action, so this is a free-form object; the engine validates the supplied values against the action's declared params and rejects the call if a required one is missing.`,
|
|
156
|
+
additionalProperties: !0
|
|
154
157
|
}
|
|
155
158
|
},
|
|
156
|
-
required: ["instance_id", "
|
|
159
|
+
required: ["instance_id", "activity", "action"],
|
|
157
160
|
additionalProperties: !1
|
|
158
161
|
}
|
|
159
162
|
},
|
|
@@ -236,8 +239,12 @@ function projectSummary(doc, subjectTitles) {
|
|
|
236
239
|
...subject !== void 0 ? { subject } : {}
|
|
237
240
|
};
|
|
238
241
|
}
|
|
239
|
-
function projectState(
|
|
240
|
-
|
|
242
|
+
function projectState({
|
|
243
|
+
instance,
|
|
244
|
+
evaluation,
|
|
245
|
+
subjectTitles
|
|
246
|
+
}) {
|
|
247
|
+
const workflowTitle = JSON.parse(instance.definitionSnapshot).title, stageTitle = evaluation.currentStage.stage.title, activities = evaluation.currentStage.activities.map((te) => {
|
|
241
248
|
const actions = te.actions.map((ae) => {
|
|
242
249
|
const verdict = actionVerdict(te, ae);
|
|
243
250
|
return {
|
|
@@ -248,9 +255,9 @@ function projectState(instance, evaluation, subjectTitles) {
|
|
|
248
255
|
};
|
|
249
256
|
});
|
|
250
257
|
return {
|
|
251
|
-
|
|
252
|
-
...te.
|
|
253
|
-
...te.
|
|
258
|
+
activity: te.activity.name,
|
|
259
|
+
...te.activity.title !== void 0 ? { title: te.activity.title } : {},
|
|
260
|
+
...te.activity.description !== void 0 ? { description: te.activity.description } : {},
|
|
254
261
|
status: te.status,
|
|
255
262
|
actions
|
|
256
263
|
};
|
|
@@ -267,7 +274,7 @@ function projectState(instance, evaluation, subjectTitles) {
|
|
|
267
274
|
...stageTitle !== void 0 ? { currentStageTitle: stageTitle } : {},
|
|
268
275
|
done: isInstanceDone(instance),
|
|
269
276
|
...subject !== void 0 ? { subject } : {},
|
|
270
|
-
|
|
277
|
+
activities,
|
|
271
278
|
recentHistory
|
|
272
279
|
};
|
|
273
280
|
}
|
|
@@ -280,15 +287,21 @@ function isInstanceDone(instance) {
|
|
|
280
287
|
return !1;
|
|
281
288
|
}
|
|
282
289
|
}
|
|
283
|
-
const DISABLED_REASON_TEXT = {
|
|
284
|
-
"filter-failed": "action's filter condition did not hold for this actor",
|
|
285
|
-
"task-not-active": "task is not currently active",
|
|
286
|
-
"stage-terminal": "stage is terminal \u2014 no further actions possible",
|
|
287
|
-
"instance-completed": "instance has already completed",
|
|
288
|
-
"requirements-unmet": "task's declared requirements are not yet satisfied"
|
|
289
|
-
};
|
|
290
290
|
function formatDisabledReason(reason) {
|
|
291
|
-
|
|
291
|
+
switch (reason.kind) {
|
|
292
|
+
case "filter-failed":
|
|
293
|
+
return "action's filter condition did not hold for this actor";
|
|
294
|
+
case "activity-not-active":
|
|
295
|
+
return "activity is not currently active";
|
|
296
|
+
case "stage-terminal":
|
|
297
|
+
return "stage is terminal \u2014 no further actions possible";
|
|
298
|
+
case "mutation-guard-denied":
|
|
299
|
+
return `blocked by mutation guard(s): ${reason.guardIds.join(", ")}`;
|
|
300
|
+
case "instance-completed":
|
|
301
|
+
return "instance has already completed";
|
|
302
|
+
case "requirements-unmet":
|
|
303
|
+
return "activity's declared requirements are not yet satisfied";
|
|
304
|
+
}
|
|
292
305
|
}
|
|
293
306
|
function summariseHistoryEntry(entry) {
|
|
294
307
|
switch (entry._type) {
|
|
@@ -296,12 +309,12 @@ function summariseHistoryEntry(entry) {
|
|
|
296
309
|
return `entered stage "${String(entry.stage)}"`;
|
|
297
310
|
case "stageExited":
|
|
298
311
|
return `exited stage "${String(entry.stage)}" \u2192 "${String(entry.toStage)}"`;
|
|
299
|
-
case "
|
|
300
|
-
return `
|
|
301
|
-
case "
|
|
302
|
-
return `
|
|
312
|
+
case "activityActivated":
|
|
313
|
+
return `activity "${String(entry.activity)}" activated`;
|
|
314
|
+
case "activityStatusChanged":
|
|
315
|
+
return `activity "${String(entry.activity)}" status: ${String(entry.from)} \u2192 ${String(entry.to)}`;
|
|
303
316
|
case "actionFired":
|
|
304
|
-
return `action "${String(entry.action)}" fired on
|
|
317
|
+
return `action "${String(entry.action)}" fired on activity "${String(entry.activity)}"`;
|
|
305
318
|
case "transitionFired":
|
|
306
319
|
return `transition fired: "${String(entry.fromStage)}" \u2192 "${String(entry.toStage)}"`;
|
|
307
320
|
case "effectQueued":
|
|
@@ -309,7 +322,7 @@ function summariseHistoryEntry(entry) {
|
|
|
309
322
|
case "effectCompleted":
|
|
310
323
|
return `effect "${String(entry.effect)}" completed (${String(entry.status)})`;
|
|
311
324
|
case "spawned":
|
|
312
|
-
return `spawned child workflow from
|
|
325
|
+
return `spawned child workflow from activity "${String(entry.activity)}"`;
|
|
313
326
|
default:
|
|
314
327
|
return entry._type;
|
|
315
328
|
}
|
|
@@ -319,9 +332,9 @@ function diagnosisSummary(diagnosis) {
|
|
|
319
332
|
case "progressing":
|
|
320
333
|
return "This instance will advance on its own.";
|
|
321
334
|
case "waiting":
|
|
322
|
-
return `Waiting for action on
|
|
335
|
+
return `Waiting for action on activity "${diagnosis.activity}": ${diagnosis.actions.join(" or ")}. This is the normal in-flight state \u2014 it advances when someone acts.`;
|
|
323
336
|
case "blocked":
|
|
324
|
-
return `
|
|
337
|
+
return `Activity "${diagnosis.activity}" is visible but not yet executable \u2014 unmet requirement(s): ${diagnosis.requirements.join(", ")}. It will not advance until those are satisfied.`;
|
|
325
338
|
case "completed":
|
|
326
339
|
return `Completed at ${diagnosis.at}.`;
|
|
327
340
|
case "aborted":
|
|
@@ -333,13 +346,13 @@ function diagnosisSummary(diagnosis) {
|
|
|
333
346
|
function stuckSummary(cause) {
|
|
334
347
|
switch (cause.kind) {
|
|
335
348
|
case "failed-effect":
|
|
336
|
-
return `Stuck: a failed effect "${cause.effect.name}" is blocking
|
|
349
|
+
return `Stuck: a failed effect "${cause.effect.name}" is blocking activity "${cause.effect.origin.name}", which can't complete until the effect succeeds.`;
|
|
337
350
|
case "hung-effect":
|
|
338
351
|
return `Stuck: effect "${cause.effect.name}" was claimed but never completed \u2014 the drainer likely died mid-dispatch, so it won't drain on its own.`;
|
|
339
|
-
case "failed-
|
|
340
|
-
return `Stuck:
|
|
352
|
+
case "failed-activity":
|
|
353
|
+
return `Stuck: activity "${cause.activity}" is in a terminal failed state, so any exit transition gated on it can never fire.`;
|
|
341
354
|
case "no-transition-fires":
|
|
342
|
-
return "Stuck: every
|
|
355
|
+
return "Stuck: every activity is resolved but no exit transition's filter is satisfied \u2014 likely a routing state value a filter reads was never written.";
|
|
343
356
|
case "transition-unevaluable":
|
|
344
357
|
return `Stuck (recoverable): exit transition(s) ${cause.transitions.join(", ")} read an operand that is missing or unreadable (GROQ null). It advances on its own once that data becomes readable \u2014 no manual fix needed.`;
|
|
345
358
|
}
|
|
@@ -353,20 +366,21 @@ function buildTools(engine, options = {}) {
|
|
|
353
366
|
},
|
|
354
367
|
get_workflow_state: async (rawInput) => {
|
|
355
368
|
const input = parseInstanceIdInput(rawInput, "get_workflow_state");
|
|
356
|
-
return getInstanceState(engine, input.instance_id, accessOverride);
|
|
369
|
+
return getInstanceState({ engine, instanceId: input.instance_id, accessOverride });
|
|
357
370
|
},
|
|
358
371
|
diagnose_workflow: async (rawInput) => {
|
|
359
372
|
const input = parseInstanceIdInput(rawInput, "diagnose_workflow");
|
|
360
|
-
return getInstanceDiagnosis(engine, input.instance_id, accessOverride);
|
|
373
|
+
return getInstanceDiagnosis({ engine, instanceId: input.instance_id, accessOverride });
|
|
361
374
|
},
|
|
362
375
|
fire_action: async (rawInput) => {
|
|
363
376
|
const input = parseFireActionInput(rawInput);
|
|
364
377
|
return await engine.fireAction({
|
|
365
378
|
instanceId: input.instance_id,
|
|
366
|
-
|
|
379
|
+
activity: input.activity,
|
|
367
380
|
action: input.action,
|
|
381
|
+
...input.params !== void 0 ? { params: input.params } : {},
|
|
368
382
|
...accessOverride !== void 0 ? { access: accessOverride } : {}
|
|
369
|
-
}), getInstanceState(engine, input.instance_id, accessOverride);
|
|
383
|
+
}), getInstanceState({ engine, instanceId: input.instance_id, accessOverride });
|
|
370
384
|
},
|
|
371
385
|
// Authoring tools — engine-independent: they teach and check the DSL, they
|
|
372
386
|
// don't touch the lake or an instance.
|
|
@@ -388,33 +402,44 @@ function parseListInput(raw) {
|
|
|
388
402
|
const obj = raw, status = obj.status === "done" || obj.status === "any" ? obj.status : "in_flight", definition = typeof obj.definition == "string" ? obj.definition : void 0;
|
|
389
403
|
return definition !== void 0 ? { definition, status } : { status };
|
|
390
404
|
}
|
|
391
|
-
function
|
|
405
|
+
function asObject(raw, tool) {
|
|
392
406
|
if (raw === null || typeof raw != "object")
|
|
393
|
-
throw new Error(
|
|
394
|
-
|
|
407
|
+
throw new Error(`${tool}: input must be an object`);
|
|
408
|
+
return raw;
|
|
409
|
+
}
|
|
410
|
+
function requireString({
|
|
411
|
+
obj,
|
|
412
|
+
key,
|
|
413
|
+
tool
|
|
414
|
+
}) {
|
|
415
|
+
const value = obj[key];
|
|
416
|
+
if (typeof value != "string" || value === "")
|
|
417
|
+
throw new Error(`${tool}: ${key} is required`);
|
|
418
|
+
return value;
|
|
419
|
+
}
|
|
420
|
+
function parseValidateInput(raw) {
|
|
421
|
+
const obj = asObject(raw, "validate_workflow_definition");
|
|
395
422
|
if (obj.definition === null || typeof obj.definition != "object")
|
|
396
423
|
throw new Error("validate_workflow_definition: `definition` is required and must be an object");
|
|
397
424
|
return { definition: obj.definition };
|
|
398
425
|
}
|
|
399
426
|
function parseInstanceIdInput(raw, tool) {
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
const obj = raw;
|
|
403
|
-
if (typeof obj.instance_id != "string" || obj.instance_id === "")
|
|
404
|
-
throw new Error(`${tool}: instance_id is required`);
|
|
405
|
-
return { instance_id: obj.instance_id };
|
|
427
|
+
const obj = asObject(raw, tool);
|
|
428
|
+
return { instance_id: requireString({ obj, key: "instance_id", tool }) };
|
|
406
429
|
}
|
|
407
430
|
function parseFireActionInput(raw) {
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
431
|
+
const obj = asObject(raw, "fire_action");
|
|
432
|
+
let params;
|
|
433
|
+
if (obj.params !== void 0) {
|
|
434
|
+
if (obj.params === null || typeof obj.params != "object" || Array.isArray(obj.params))
|
|
435
|
+
throw new Error("fire_action: params must be an object");
|
|
436
|
+
params = obj.params;
|
|
437
|
+
}
|
|
414
438
|
return {
|
|
415
|
-
instance_id: obj
|
|
416
|
-
|
|
417
|
-
action: obj
|
|
439
|
+
instance_id: requireString({ obj, key: "instance_id", tool: "fire_action" }),
|
|
440
|
+
activity: requireString({ obj, key: "activity", tool: "fire_action" }),
|
|
441
|
+
action: requireString({ obj, key: "action", tool: "fire_action" }),
|
|
442
|
+
...params !== void 0 ? { params } : {}
|
|
418
443
|
};
|
|
419
444
|
}
|
|
420
445
|
async function listInstances(engine, input) {
|
|
@@ -430,14 +455,22 @@ async function listInstances(engine, input) {
|
|
|
430
455
|
instances: filtered.map((doc) => projectSummary(doc, subjectTitles))
|
|
431
456
|
};
|
|
432
457
|
}
|
|
433
|
-
async function getInstanceState(
|
|
458
|
+
async function getInstanceState({
|
|
459
|
+
engine,
|
|
460
|
+
instanceId,
|
|
461
|
+
accessOverride
|
|
462
|
+
}) {
|
|
434
463
|
const evaluation = await engine.evaluateInstance({
|
|
435
464
|
instanceId,
|
|
436
465
|
...accessOverride !== void 0 ? { access: accessOverride } : {}
|
|
437
466
|
}), instance = await engine.getInstance({ instanceId }), subjectTitles = await fetchSubjectTitles(engine, [instance]);
|
|
438
|
-
return projectState(instance, evaluation, subjectTitles);
|
|
467
|
+
return projectState({ instance, evaluation, subjectTitles });
|
|
439
468
|
}
|
|
440
|
-
async function getInstanceDiagnosis(
|
|
469
|
+
async function getInstanceDiagnosis({
|
|
470
|
+
engine,
|
|
471
|
+
instanceId,
|
|
472
|
+
accessOverride
|
|
473
|
+
}) {
|
|
441
474
|
const { diagnosis, remediations } = await engine.diagnose({
|
|
442
475
|
instanceId,
|
|
443
476
|
...accessOverride !== void 0 ? { access: accessOverride } : {}
|