@x12i/diagrams 0.0.0-stage → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 x12i
+
+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

@@ -1,3 +1,48 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @x12i/diagrams
+
+Diagrams for the Unified UI Kit: one versioned JSON diagram document, a headless
+core, and accessible React views themed by kit tokens.
+
+| Import | Contains |
+| --- | --- |
+| `@x12i/diagrams` | Schema, validation, layout, geometry, history, mutations, JSON and static SVG export, the text outline. No React, no DOM. |
+| `@x12i/diagrams/react` | `DiagramCanvas` (node canvas on `@xyflow/react`), `StaticDiagram`, `DiagramOutline`, `MermaidDiagram`, `useDiagramHistory`. Starts with `"use client"`. |
+| `@x12i/diagrams/styles.css` | The one stylesheet. |
+
+`@x12i/ui` and React are peer dependencies. `MermaidDiagram` takes a loader, so
+Mermaid is only installed by apps that use it. The Excalidraw whiteboard is not
+built yet.
+
+```ts
+import { defineDiagram, diagramToOutline } from "@x12i/diagrams";
+
+const diagram = defineDiagram({
+  version: 1,
+  title: "Order approval",
+  nodes: [
+    { id: "a", kind: "start", label: "Order placed", position: { x: 0, y: 0 } },
+    { id: "b", kind: "task", label: "Review", position: { x: 200, y: 0 } },
+    { id: "c", kind: "end", label: "Shipped", position: { x: 400, y: 0 } },
+  ],
+  edges: [
+    { id: "ab", source: "a", target: "b" },
+    { id: "bc", source: "b", target: "c" },
+  ],
+});
+
+diagramToOutline(diagram); // ["Order placed to Review to Shipped"]
+```
+
+Every canvas generates this outline, so a diagram has a form screen readers can
+read (spec section 10).
+
+## Engines
+
+| Tier | Engine | Status |
+| --- | --- | --- |
+| Text to diagram | Mermaid (MIT) | Built, loaded by the app |
+| Node canvas | `@xyflow/react` (MIT) | Built |
+| Automatic layout | dagre (MIT), D3 hierarchy (ISC) | Built |
+| Freeform whiteboard | Excalidraw (MIT) | Planned |
+
+tldraw is excluded on license grounds.