Skip to content
fold-kit-experiments

Foldkit Zloz API and type contracts

The Zloz API reference is generated with TypeDoc from public package entry points, using the same tool as FoldKit Viz. It describes the source revision used for the build; the packages remain local release candidates until separately published.

Open the Zloz API reference. The route is populated by the updated Pages workflow after merge/deployment.

The reference includes:

  • @opsydyn/foldkit-zloz: graph/port types, editor state/events, serialization, history, layout publication, shared edge geometry, custom port anchors and connection-preview policies. The root also exports C4/DDD node descriptors, architecture presets/factory, shape geometry and undoable architecture/appearance events. These are headless contracts; opt-in C4 artwork lives in the optional view entry. DDD artwork and pattern builders remain subsequent slices.
  • @opsydyn/foldkit-zloz/foldkit: view options, node/group shells, public interaction primitives, diagnostics and background contracts. Opt-in zlozC4Node/zlozC4Group presets expose content/control slots and scoped themes through the same public primitives.
  • @opsydyn/foldkit-zloz-elk: ELK layout options and adapter factory.
  • @opsydyn/foldkit-zloz-force: force layout factory and support checks.
  • @opsydyn/foldkit-zloz-force/eligibility: the lightweight eligibility entry.
  • @opsydyn/foldkit-zloz-mermaid: Mermaid export options, identity metadata, conversion diagnostics and nested subgraph projections.

Preferred contracts use Zloz* types and zloz* views. Deprecated source aliases remain available for existing integrations; see migration notes.

Generate locally

Terminal window
bun run --filter @opsydyn/foldkit-zloz docs

Serve packages/foldkit-zloz/docs/ with a static server. Generated HTML is ignored by Git and built afresh for Pages. It is not included in the npm tarball. The landing guide is maintained at packages/foldkit-zloz/typedoc-readme.md; the type and API pages come directly from source exports and their TSDoc comments.

The core stays independent of FoldKit, browser globals and layout engines. The application owns Model, commands and persistence; optional adapters remain separate dependencies. See the composition decision for the current extensibility boundaries.