fai/chain-studio-flow-editor
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Swappable inline YAML editor for F∆I Studio flows.
7 commits 1 branch 0 tags 1.2 MiB
Find a file
flemming-it 870cbc29f7 feat(editor): three-tab WYSIWYG editor — graph / text / run 
Full rewrite of the editor surface, layered on top of the
FlowGraph foundation. One in-memory flow drives three tabs
that the operator can flip between freely:

 - Graph: a drag-and-drop canvas. Nodes are step cards with
   port dots on their left (one per `with:` field) and a
   combined output port on the right. Pinned inputs and
   outputs pseudo-nodes sit at the left and right edges so
   every flow has a visually obvious source and sink. Pan +
   zoom via InteractiveViewer; drag a node by its body to
   reposition it (positions persisted to a sidecar JSON file
   under ~/.fai/data/flows/.layout/<name>.json — kept OUT of
   the YAML so `fai run` stays byte-stable).
 - Text: the existing YAML CodeField with expands:true so
   line 1 anchors at the top edge. YAML-aware syntax
   highlighting picks up the theme's primary / secondary /
   tertiary palette for keys / strings / numbers.
 - Run: an inputs form (text fields + file-pick), a Start
   button that calls the host's FlowRunDriver, a live step
   list driven by the driver's event stream (matches the
   `fai run` CLI rendering — ◻ pending, · running, ✔ done +
   duration, ✗ failed, ⏸ awaiting approval), and the typed
   outputs once the run resolves.

Source of truth = the YAML text. Graph edits emit fresh YAML
into the shared CodeController; text edits re-parse the
graph on a 350 ms debounce. Layout sidecar persists drag
positions only.

New public API (lib/fai_studio_flow_editor.dart):

  FlowEditorPage(
    initialFlowName: ...,
    locale: ...,
    runDriver: FlowRunDriver?,        // NEW — host bridge
    availableCapabilities: List<String>, // NEW — for the
                                          // capability picker
                                          // dialog when adding
                                          // a step
  )

The host (Studio) implements FlowRunDriver to bridge the
hub's gRPC SDK into the editor's event vocabulary. The
StepStarted/Completed/Failed/AwaitingApproval events are
shared verbatim with the CLI's run_progress renderer so
both surfaces speak the same visual language.

Files in this commit:
 - lib/src/editor_controller.dart       — shared state +
   debounced reparse loop
 - lib/src/run_driver.dart              — host bridge
   interface + event types
 - lib/src/widgets/flow_canvas.dart     — pan / zoom / drag /
   port-to-port connection drawing
 - lib/src/widgets/flow_node.dart       — node card primitive
   (module / approval / inputs / outputs variants)
 - lib/src/widgets/edge_painter.dart    — single CustomPainter
   for every edge + draft drag line, cubic bezier with
   arrow-head caps
 - lib/src/widgets/properties_panel.dart — right-side editor
   when a step is selected (rename id, change capability, add
   / remove / rename with-fields, delete step)
 - lib/src/widgets/capability_picker.dart — searchable list
   dialog used by Add-step
 - lib/src/widgets/run_tab.dart         — inputs form +
   live step progress + outputs renderer
 - lib/src/flow_editor_page.dart        — host scaffolding,
   toolbar, file list, three-tab body, keyboard shortcuts
 - lib/src/l10n.dart                    — EN + DE strings for
   every new label
 - lib/fai_studio_flow_editor.dart      — exports the new
   public types (FlowRunDriver, FlowRunEvent variants,
   FlowOutputValue variants)

flutter analyze: 0 issues. flutter test: 7/7 green.

Signed-off-by: flemming-it <sf@flemming.it>
2026-06-01 00:48:35 +02:00
lib feat(editor): three-tab WYSIWYG editor — graph / text / run 2026-06-01 00:48:35 +02:00
test feat(model): FlowGraph + LayoutStore foundation for WYSIWYG editor 2026-06-01 00:37:19 +02:00
.gitignore feat: initial scaffold — swappable flow editor 2026-05-30 14:33:03 +02:00
pubspec.yaml feat(model): FlowGraph + LayoutStore foundation for WYSIWYG editor 2026-06-01 00:37:19 +02:00
README.md feat: initial scaffold — swappable flow editor 2026-05-30 14:33:03 +02:00

README.md

fai_studio_flow_editor

Swappable inline YAML editor for F∆I Studio flows.

Public surface

import 'package:fai_studio_flow_editor/fai_studio_flow_editor.dart';

// Studio embeds the page as one of its destinations:
FlowEditorPage(
  initialFlowName: 'hello',                       // optional
  locale: FlowEditorLocale.de,                    // or .en
  onRun: (name) =>                                // optional callback
      HubService.instance.runSavedFlow(name: name),
)
  • initialFlowName — when set, the page loads that flow from ~/.fai/data/flows/<name>.yaml on first build. Used by Studio's Flows-page pencil → editor route push.
  • locale — picks EN or DE for the editor's internal string table. Studio passes its active locale through.
  • onRun — async callback that runs the named flow against the host hub and returns the typed outputs map. When null, the Run button is disabled (e.g. when the editor is embedded in a context without hub access).

Behaviour

  • File browser (left, 240 px) lists *.yaml in ~/.fai/data/flows/.
  • Code field (right) ships YAML syntax highlighting via flutter_code_editor + the highlight package's yaml grammar.
  • Save writes directly to disk via dart:io; the hub picks up the change on its next ListFlows / RunSavedFlow call.
  • Cmd+S / Ctrl+S — save. Cmd+Enter / Ctrl+Enter — run.

Swap it

Studio depends on this package via pubspec.yaml git reference:

dependencies:
  fai_studio_flow_editor:
    git:
      url: https://git.flemming.ai/fai/studio-flow-editor
      ref: main

To use a different editor:

  1. Fork this repo (or write your own from scratch).
  2. Keep the FlowEditorPage constructor signature (initialFlowName, locale, onRun) — that's the stable host contract.
  3. Point Studio's pubspec at your fork (or local-path during development): 
    fai_studio_flow_editor:
  git:
    url: https://your-host/your/flow-editor
    ref: main
  4. Rebuild Studio. Done.

The contract is intentionally minimal: a single page widget with three parameters. The package brings its own tokens, its own empty/error widgets, its own l10n table, so the host doesn't have to share internals. The trade-off is visual drift if Studio's design tokens change — that's the deal you accept for a swappable module.

Develop

flutter pub get
flutter analyze
flutter test

The package's own widget tests live in test/. End-to-end tests against a live hub stay in the host repo (Studio).

License

Apache-2.0. Same as the rest of the F∆I platform.