@sanity/workflow-diagram 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sanity, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,48 @@
+# @sanity/workflow-diagram
+
+React component rendering a `@sanity/workflow-engine` definition as a stage
+diagram: stages laid out left-to-right by [ELK](https://eclipse.dev/elk/)'s
+layered algorithm, rendered with [@xyflow/react](https://reactflow.dev).
+
+- Every **stage** is the same label-sized capsule pill — run state lives in
+  the inline status icon, and position says what's first and last.
+- **Transitions** are orthogonal rounded polylines; hovering anywhere along a
+  line opens a tooltip with the transition's title and description (plus
+  machine name, GROQ filter and effects when `devMode` is on — never for end
+  users). Only a gated transition carries a visible on-line marker (a lock
+  disc). No inline edge labels — the layout stays compressed.
+- Pass `explain` to phrase the workflow in human language: transition
+  tooltips gain the filter's requirements as a checklist ("Transitions
+  when: • «Cancellation requested» must be true"), stage tooltips list the
+  stage's activity and editability gates. Derived from the definition
+  alone — no instance needed.
+- Pass `currentStage` / `history` to tone the instance's position and the
+  visited path; `guardCount` shows a lock on the current stage.
+- Pass `onSelectStage` (+ controlled `selectedStage`) to build inspection UX
+  around the diagram — clicking a stage reports its name, clicking the pane
+  reports `undefined`.
+
+```tsx
+import {WorkflowDiagram} from '@sanity/workflow-diagram'
+;<WorkflowDiagram
+  definition={definition}
+  currentStage={instance?.currentStage}
+  history={instance?.history}
+/>
+```
+
+The component follows the ambient Sanity UI theme (render inside a
+`@sanity/ui` `ThemeProvider`); retheme by overriding the `--ws-*` CSS
+variables on a wrapping element — `WS_CARD_TOKENS`, the exported base token
+map (`--ws-*` → Sanity UI card vars), is the reference for what exists.
+Key the component by instance id — layout fits the viewport once per mount
+and preserves the user's zoom/pan afterwards.
+
+The package entry imports `@xyflow/react`'s stylesheet as a side effect, so
+it expects a CSS-capable bundler (Vite, Next.js, Studio, the App SDK all
+qualify); importing it from plain Node without a CSS loader will fail on
+that import.
+
+`flattenTransitions` is also exported: the definition's nested per-stage
+transitions as the flat `from`-keyed list the diagram renders — useful when
+building transition UI beside the diagram.