ui/server/src/envelopesApi · Developer Docs

thin REST adapter over packages/core/flows.mjs: every named, reusable flow saved under the open project's .construct/flows/, a deterministic envelope preview, a preview/commit save, and "Run this flow" through the e...

Cockpit server, next. Source: ui/server/src/envelopesApi.mjs.

Functions#

createEnvelopesRouter()#

createEnvelopesRouter(deps): any

Defined in: ui/server/src/envelopesApi.mjs:96

Parameters#

deps

getBlockSettings?

(root) => unknown

getRoot

() => { ok: true; root: string; } | { error: string; ok: false; }

startPlan?

(plan) => object

Returns#

any

envelopePreview()#

envelopePreview(steps): object

Defined in: ui/server/src/envelopesApi.mjs:35

-- the envelope each step of a composed flow would receive, computed deterministically (no generator runs, nothing written): steps[i].envelope is what construct pipeline run would be handed if started at step i, in schemas/envelope.v1.json's input shape (layers empty -- nothing has committed yet from this preview's point of view; steps is the remaining generation work flowToEnvelopeSteps derives from create.unit steps onward, in order).

Parameters#

steps

any

Returns#

object

body

body: any

status

status: number

envelopeRun()#

envelopeRun(root, body, __namedParameters): object

Defined in: ui/server/src/envelopesApi.mjs:82

-- "Run this flow": the exact same re-validate-then-start pipeline planService.run() uses (checkPlan, then startPlan, the process-engine dependency createProcessesService and the Processes drawer share). The flow's steps become a synthetic plan's steps; nothing here creates a second way to run a step.

Parameters#

root

any

body

any

__namedParameters

getBlockSettings

any

startPlan

any

Returns#

object

body

body: any

status

status: number

envelopeSave()#

envelopeSave(root, name, body): object

Defined in: ui/server/src/envelopesApi.mjs:52

-- "Save this flow": preview/commit, same shape as rulesApi.mjs's writers (nothing written until commit: true). Preview validates without writing; commit calls 's saveFlow, which never writes an invalid flow.

Parameters#

root

any

name

any

body

any

Returns#

object

body

body: any

status

status: number

envelopeShow()#

envelopeShow(root, name): object

Defined in: ui/server/src/envelopesApi.mjs:23

Parameters#

root

any

name

any

Returns#

object

body

body: any

status

status: number

envelopesIndex()#

envelopesIndex(root): object

Defined in: ui/server/src/envelopesApi.mjs:13

Parameters#

root

any

Returns#

object

body

body: any

status

status: number