Skip to content

Workflow Engine Packages

The current CDX workflow stack is split into runtime, storage, wire types, templates, Flutter feature UI, protocol, and editor packages. A service that only runs workflows does not need Flutter. A Flutter app that only renders user tasks does not need the editor.

Authenticate with pub.vyuh.tech first

Workflow Engine packages is hosted on the private pub.vyuh.tech registry. Before running pub get, register a Bearer token issued by Vyuh Technologies based on your plan.

Run the one-time setup:

dart pub token add https://pub.vyuh.tech

Don't have a token yet? Email ask@vyuh.tech to request one. For full details (CI, Docker, rotation, troubleshooting), see the Pub Token Setup guide.

Packages

Package Version Role
vyuh_workflow_engine3.0.0Pure Dart workflow runtime: workflow models, fluent builder, node processors, executors, effects, token execution, events, and WorkflowStorage interfaces.
vyuh_workflow_storage_supabase3.0.0Supabase/PostgreSQL implementation of WorkflowStorage for definitions, instances, user tasks, and workflow events.
cdx_workflow_types0.4.0Pure Dart wire contracts for approval templates, user task actions, workflow activity, and entity workflow status projections.
cdx_workflow_templates0.4.0Reusable template families on top of the engine. Current canonical template: the shared multi-domain approval workflow.
cdx_feature_workflows0.3.0Flutter/Vyuh workflow inbox primitives, typed action bar, status card, timeline, and inbox/detail widgets.
vyuh_workflow_protocol2.0.0Transport-agnostic command, response, and event protocol between workflow clients/editors and engines.
vyuh_workflow_editor2.0.0Flutter visual workflow editor, simulation environments, run mode, validation, and node editor integration.
  • vyuh_workflow_engine3.0.0

    Pure Dart workflow runtime: workflow models, fluent builder, node processors, executors, effects, token execution, events, and WorkflowStorage interfaces.

  • vyuh_workflow_storage_supabase3.0.0

    Supabase/PostgreSQL implementation of WorkflowStorage for definitions, instances, user tasks, and workflow events.

  • cdx_workflow_types0.4.0

    Pure Dart wire contracts for approval templates, user task actions, workflow activity, and entity workflow status projections.

  • cdx_workflow_templates0.4.0

    Reusable template families on top of the engine. Current canonical template: the shared multi-domain approval workflow.

  • cdx_feature_workflows0.3.0

    Flutter/Vyuh workflow inbox primitives, typed action bar, status card, timeline, and inbox/detail widgets.

  • vyuh_workflow_protocol2.0.0

    Transport-agnostic command, response, and event protocol between workflow clients/editors and engines.

  • vyuh_workflow_editor2.0.0

    Flutter visual workflow editor, simulation environments, run mode, validation, and node editor integration.

How They Fit Together

text
cdx_workflow_types
  shared approval, user-task action, activity, and entity workflow contracts

cdx_workflow_templates
  builds descriptors for canonical workflows
  depends on cdx_workflow_types and vyuh_workflow_engine

vyuh_workflow_engine
  executes workflows
  depends on WorkflowStorage

WorkflowStorage
  InMemoryStorage for tests/dev
  SupabaseStorage from vyuh_workflow_storage_supabase for Supabase/PostgreSQL

cdx_feature_workflows
  Flutter inbox/status/action/timeline widgets
  consumes cdx_workflow_types projections

vyuh_workflow_protocol
  typed command/event envelope
  used by clients/editors to talk to engines over any transport

vyuh_workflow_editor
  Flutter visual editor and simulator
  depends on engine, protocol, and vyuh_node_editor_sdk

Runtime Server

Use this for a workflow service or API server:

yaml
dependencies:
  vyuh_workflow_engine:
    hosted: https://pub.vyuh.tech
    version: ^3.0.0
  vyuh_workflow_storage_supabase:
    hosted: https://pub.vyuh.tech
    version: ^3.0.0
  cdx_workflow_types:
    hosted: https://pub.vyuh.tech
    version: ^0.4.0
  cdx_workflow_templates:
    hosted: https://pub.vyuh.tech
    version: ^0.4.0

Flutter App With Workflow Inbox

Use this for a Vyuh app that renders tasks and submits actions:

yaml
dependencies:
  cdx_workflow_types:
    hosted: https://pub.vyuh.tech
    version: ^0.4.0
  cdx_feature_workflows:
    hosted: https://pub.vyuh.tech
    version: ^0.3.0

cdx_feature_workflows exports inbox row/detail primitives, WorkflowActionBar, WorkflowStatusCard, and workflow activity timeline widgets. It does not own a global descriptor registry; apps contribute inbox descriptors through entity-system extension points.

Visual Workflow Editor

Use this when embedding the editor or simulator:

yaml
dependencies:
  vyuh_workflow_editor:
    hosted: https://pub.vyuh.tech
    version: ^2.0.0
  vyuh_workflow_protocol:
    hosted: https://pub.vyuh.tech
    version: ^2.0.0
  vyuh_workflow_engine:
    hosted: https://pub.vyuh.tech
    version: ^3.0.0

The editor creates WorkflowEnvironments. SimulationEnvironment uses in-memory storage and passthrough execution. DatabaseEnvironment uses real storage/descriptors but still runs in editor simulation mode so users can manually drive decisions while designing.

Package Boundaries

PackageBoundary
vyuh_workflow_engineNo Flutter, no Supabase, no CDX approval domain knowledge.
vyuh_workflow_storage_supabaseSupabase table adapter only; type resolution stays in the engine.
cdx_workflow_typesPure contracts only; no engine runtime, no Flutter widgets, no database client.
cdx_workflow_templatesServer-side template descriptors and canonical definitions.
cdx_feature_workflowsFlutter UI primitives for inboxes and workflow status.
vyuh_workflow_protocolTransport-neutral wire messages and client API.
vyuh_workflow_editorVisual authoring, validation, run mode, and simulation UI.

See Also