Swappable inline YAML editor for F∆I Studio flows.
Step run events were previously visible only on the run tab. Operators who triggered a run there and then switched to the graph tab saw a static graph — the canvas had no idea something was executing. Wire the run events through the FlowEditorController so all three tabs share the same status snapshot: - New StepRunStatus enum on the controller (idle / running / done / failed / awaiting). - controller.stepStatuses exposes the live map. - controller.updateStepStatus is called from the run tab's event handler — one source of truth, both views read it. - FlowCanvas drops its own stepStatuses parameter and pulls from the controller instead, so the canvas now shows the running pulse + done check + error cross + pause icon in each step's header live, in lockstep with the step list on the run tab. When a fresh run starts (controller.running = true) the status map is cleared so stale events from a previous run don't paint the new one. Signed-off-by: flemming-it <sf@flemming.it> |
||
|---|---|---|
| lib | ||
| test | ||
| .gitignore | ||
| pubspec.yaml | ||
| 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>.yamlon 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
*.yamlin~/.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 nextListFlows/RunSavedFlowcall. - 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:
- Fork this repo (or write your own from scratch).
- Keep the
FlowEditorPageconstructor signature (initialFlowName,locale,onRun) — that's the stable host contract. - 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 - 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.