Repository navigation
BPMN designer contract, per-designer Studio modules and a shared conformance suite #8927
Description
Phase 3 groundwork of #8898, per ADR Offer selectable BPMN designers (#8926).
Change
- Define the BPMN designer contract:
load(returns{ imported, error?, warnings }),save,select,applyOverlays/clearOverlays,change/selectionevents,dispose. Start from the payload shapes the spike used (Spike: host a bpmn-js modeler in the Blazor Studio #8901). - Split designers into Studio modules (for example
Elsa.Studio.Bpmn.BpmnJs,Elsa.Studio.Bpmn.X6). The BPMN feature enables bpmn-js when the host enables no designer, and a designer that isn't enabled adds nothing to the download. - Put the canvas-independent rules in shared code:
- the
elsa:binding model; - DI generation for documents without DI;
- the save flow that requires explicit acknowledgement after a load warning reports dropped content.
- the
- Build one conformance suite that every designer must pass:
- round-trip preservation of
elsa:extensions, foreign extensions and attributes, subprocess bodies at every depth, and DI; - the load-warning contract;
- Elsa import equivalence;
- overlays and events.
- round-trip preservation of
Done when
- The contract is documented and the bpmn-js designer implements it. (feat(studio): add the BPMN designer contract and its shared binding and save rules #8980, feat(studio): compute BPMN designer load warnings and generate missing diagram layout #8981, feat(studio): add the bpmn-js BPMN designer and the designer contract suite #8982)
- The conformance suite runs in CI against the bpmn-js designer. (feat(studio): add the bpmn-js BPMN designer and the designer contract suite #8982, test(studio): add round-trip preservation and Elsa import equivalence to the designer suite #8983)
- A host can enable a designer module and gets bpmn-js when it enables none. (feat(studio): choose and host a BPMN designer in the Blazor Studio #9021, feat(studio): client for the BPMN XML endpoints #9024, feat(studio): edit a BPMN workflow's document in the enabled BPMN designer #9031, feat(studio): choose the activity that performs a task in the BPMN designer #9034, feat(studio): create a BPMN workflow from scratch in the enabled BPMN designer #9036, feat(studio): show BPMN workflows and their instances in the enabled BPMN designer #9037; default flip feat(studio): make bpmn-js the default BPMN designer #9038)
Activity
sfmskywalker commentedon Oct 22, 2026
[Claude] Decisions from the owner on the open #8927 questions:
PUT bpmn/definitions/{id}/xml, D3), not before. Until then it ships as a selectable designer and X6 stays the default, so the view never loses its fallback-layout diagnostics or its subprocess drill-down while still read-only.Elsa.Studio.Workflowsto the bpmn-js module. With no designer registered, the resolver falls back to X6, and hosts opt into bpmn-js by registering its module. At the flip the reference is added, so the small wrapper DLL ships to every host; the JS bundle stays lazy.studio/docs/specs/defines "BPMN designer contract v1": methods,getBinding/setBinding,SetBindingResult, thereadOnlyoption, events and thecontractVersionrule.rewrittenload warning, and the suite asserts that the warning appears.Plan changes:
Generated by Claude Code
feat(studio): add the BPMN designer contract and its shared binding a…
feat(studio): client for the BPMN XML endpoints (#9024)
feat(studio): choose and host a BPMN designer in the Blazor Studio (#…
sfmskywalker commentedon Oct 22, 2026
[Claude] Every "Done when" item has landed on
main, so I'm closing this issue.What shipped:
BpmnDesignerResolverandBpmnCanvasHost.PUT bpmn/definitions/{id}/xml(D3: feat(bpmn): save a BPMN workflow as XML through GET/PUT bpmn/definitions/{id}/xml #8995, feat(bpmn): create a BPMN workflow from scratch with POST bpmn/definitions #8998).elsa:bindings through the contract'sgetBinding/setBinding.AddWorkflowsModulefalls back to bpmn-js when a host enables no designer. A designer the host enables takes precedence.Elsa.Studio.Bpmn.BpmnJsis now packable, and its bundle is checked in the package proof.What remains: the X6 designer module (plan step 6) is the work of #8928. Until then, the read-only X6 view shows only BPMN scopes that have no source document, and a host that removes the default.
Generated by Claude Code