@statelyai/layout 0.0.0 → 0.0.1

package/NOTICE.md

@@ -7,4 +7,12 @@ The project intends to implement algorithms available in the Eclipse Layout
 Kernel. Eclipse Layout Kernel is maintained by the ELK contributors and is a
 trademark of the Eclipse Foundation. See https://github.com/eclipse-elk/elk.
 
-No Eclipse Layout Kernel source has been copied into the initial implementation.
+No Eclipse Layout Kernel implementation source has been copied into the native
+layout implementation.
+
+The demo includes example models derived from the Eclipse ELK Models repository
+at revision ac5af2ba511c0037e4f347e8bd91f013950951c7:
+https://github.com/eclipse/elk-models. Those examples are available under the
+Eclipse Public License 2.0. Their ELKT graph source and upstream paths are
+preserved in the generated example catalog; the upstream repository retains
+the original per-file notices.

package/README.md

@@ -9,13 +9,12 @@ return `VisualGraph`; positions remain node fields and routes remain
 
 ## Status
 
-The native layered implementation currently supports flat graphs, cycles,
-ports, self-loops, four directions, typed constraints, padding, orthogonal
-routes, and replaceable phases. Native fixed, rectangle-packing, and initial
-SPOrE implementations are also available. ELK Box SIMPLE placement and seeded
-Random node placement are translated from Java. Partial, incremental,
-route-only, and native compound layout remain explicit unimplemented
-capabilities.
+The native layered implementation covers the complete 152-option elkjs 0.11.1
+layered inventory with one simplified typed name per ELK option. Flat and
+compound graphs, cross-hierarchy edges, ports, labels, self-loops, wrapping,
+four directions, constraints, and replaceable phases are differential-tested
+against elkjs. Partial, incremental, and route-only layout remain explicit
+unimplemented capabilities.
 
 ## Install
 
@@ -54,7 +53,7 @@ result.metrics;
 
 ## elkjs compatibility
 
-<!-- elkjs-compatible entry point exported from package.json#exports -->
+<!-- elkjs-compatible entry point and layered mapping exports from package.json#exports and src/layered/index.ts -->
 
 Legacy consumers can migrate through an isolated compatibility entry point:
 
@@ -69,32 +68,45 @@ The adapter accepts ELK JSON and option aliases, translates to
 `@statelyai/graph`, runs native algorithms, and translates the result back.
 Native algorithms never consume ELK JSON directly.
 
+Advanced layered settings use shorter names such as
+`layering.strategy`, `spacing.edgeNode`, and `nodePlacement.strategy`.
+`toElkLayeredOptions` and `fromElkLayeredOptionId` provide the exact one-to-one
+mapping when migration tooling needs ELK IDs. `elkLayeredOptionDefinitions`
+exposes the complete mapping, value type, and valid graph-element targets;
+`elkLayeredEnumValues` exposes every accepted enum value.
+
 ## Parity lab
 
-<!-- representative graph count and engines from demo/scenarios.ts -->
+<!-- ELK Live example count and source from demo/generated/elk-live-examples.json -->
 
-The browser lab compares 15 already-laid-out graphs in two renderers: a
-coordinate-faithful SVG geometry inspector and the `@statelyai/sdk` project
-embed. It covers all 11 algorithm families exposed by the elkjs 0.11.1
-demonstrator surface plus cycle, long-edge, named-port, and compound layered
-cases. Native and oracle-backed graphs are labeled separately; elkjs is never
-bundled into the browser.
+The browser lab contains the same 45 categorized examples as ELK Live, sourced
+from the canonical `eclipse/elk-models` catalog. Each is pre-laid out with the
+elkjs oracle after zero-sized nodes and ports receive consistent visual bounds.
+The canonical ELKT source remains unchanged; elkjs is never bundled into the
+browser.
 
-The SVG layer displays exact node dimensions and coordinates, edge label
-rectangles, route points, routing modes, and node-relative ports. The SDK layer
-then shows how the same serialized `@statelyai/graph` value appears in the Viz
-project view.
+The workbench places a CodeMirror JSON5 editor beside a coordinate-faithful SVG
+viewer in keyboard-accessible shadcn resizable panels. Selecting an example
+loads its complete XGraph into the editor; pasted or edited XGraph redraws
+automatically. Existing visual geometry is preserved; topology-only graphs run
+through native layered layout. Invalid input is marked inline while the last
+valid preview remains visible. Pan, zoom, selection details, and optional
+overlays expose exact node coordinates, edge-label rectangles, route points,
+routing modes, and node-relative ports.
 
 ```bash
 pnpm demo:generate
 pnpm demo
 ```
 
+The demo opens at `https://layout.localhost` through Portless.
+
+`pnpm demo:sync` refreshes the pinned ELK Live catalog and its converted ELK
+JSON inputs. Normal generation and browser use remain offline.
+
 The embed target defaults to `http://localhost:3000`. Override it with
 `?editor=http://localhost:4864` when the Viz editor runs elsewhere.
 
-![Native layered graph in the SDK project view](./artifacts/screenshots/layout-parity-layered.png)
-
 ## Extensibility
 
 <!-- layered strategy fields from src/layered/types.ts -->
@@ -120,8 +132,9 @@ const result = getLayeredLayout(graph, {
 });
 ```
 
-See [Architecture](./docs/architecture.md), [Roadmap](./docs/roadmap.md), and
-[Upstream and provenance](./docs/upstream.md). [Parity](./docs/parity.md) tracks
+See [API reference](./docs/api-reference.md), [Architecture](./docs/architecture.md),
+[Roadmap](./docs/roadmap.md), and [Upstream and provenance](./docs/upstream.md).
+[Parity](./docs/parity.md) tracks
 API coverage separately from native algorithm fidelity.
 
 ## Development
@@ -133,8 +146,22 @@ pnpm install
 pnpm verify
 pnpm bench
 pnpm demo
+pnpm changeset
+pnpm release
 ```
 
 `pnpm verify` checks Oxfmt, Oxlint, source and repository TypeScript projects,
-generated corpus freshness, tests, declarations/runtime builds, the demo
-bundle, and the packed package surface.
+generated layered-option and demo-corpus freshness, tests,
+declarations/runtime builds, the demo bundle, and the packed package surface.
+
+## Releases
+
+<!-- release process derived from package.json#scripts and .changeset/config.json -->
+
+Add a release note with `pnpm changeset`. When it reaches `main`, the release
+workflow opens or updates a version pull request. Merging that pull request
+publishes the package to npm and creates the GitHub release and tag.
+
+Before the first automated release, publish the initial `0.0.0` package and
+configure npm Trusted Publishing for `statelyai/layout` using
+`.github/workflows/release.yml`.

package/dist/elkjs/index.d.mts

@@ -25,6 +25,8 @@ interface ElkEdgeSection extends ElkGraphElement {
   startPoint: ElkPoint;
   endPoint: ElkPoint;
   bendPoints?: ElkPoint[];
+  incomingShape?: ElkId;
+  outgoingShape?: ElkId;
 }
 interface ElkEdge extends ElkGraphElement {
   sources?: ElkId[];
@@ -35,6 +37,7 @@ interface ElkEdge extends ElkGraphElement {
   targetPort?: ElkId;
   labels?: ElkLabel[];
   sections?: ElkEdgeSection[];
+  junctionPoints?: ElkPoint[];
 }
 interface ElkNode extends ElkShape {
   labels?: ElkLabel[];