orcasvn-react-diagrams 0.1.82 → 0.2.0

package/README.md

@@ -1,46 +1,78 @@
-# Getting Started with Create React App
+# orcasvn-react-diagrams
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+Diagram editor library with a Konva-backed editor (`createDiagramEditor`) and an engine-only API (`createDiagramEngine`).
 
-## Available Scripts
+## Install
 
-In the project directory, you can run:
+```bash
+npm install orcasvn-react-diagrams
+```
 
-### `npm start`
+Node engine for this repository/toolchain: `>=18.17.0 <19.0.0`.
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+## Quick Start
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+```ts
+import { createDiagramEditor } from 'orcasvn-react-diagrams';
 
-### `npm test`
+const editor = createDiagramEditor({
+  container: document.getElementById('diagram-root') as HTMLDivElement,
+  width: 960,
+  height: 600,
+  initialState: { elements: [], ports: [], links: [], texts: [] },
+});
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+editor.addElement({
+  id: 'node-1',
+  position: { x: 80, y: 80 },
+  size: { width: 160, height: 100 },
+  shapeId: 'default',
+});
+```
 
-### `npm run build`
+## API Docs
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+- Human-first docs index: `docs/INDEX.md`
+- API contract: `docs/API_CONTRACT.md`
+- State invariants: `docs/STATE_INVARIANTS.md`
+- Integration: `docs/INTEGRATION_PLAYBOOK.md`
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
+Machine-readable docs shipped in npm package:
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+- `ai/manifest.json`
+- `ai/api-contract.json`
+- `ai/invariants.json`
 
-### `npm run eject`
+UNPKG examples:
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+- `https://unpkg.com/orcasvn-react-diagrams@<version>/ai/manifest.json`
+- `https://unpkg.com/orcasvn-react-diagrams@<version>/docs/INDEX.md`
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+Node subpath export:
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+- `orcasvn-react-diagrams/ai-manifest`
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+## External Drag And Drop
 
-## Learn More
+```ts
+const world = editor.clientToWorld(
+  { x: event.clientX, y: event.clientY },
+  stageContainer
+);
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+editor.addElement({
+  id,
+  position: { x: world.x - width / 2, y: world.y - height / 2 },
+  size: { width, height },
+  shapeId,
+});
+```
 
-To learn React, check out the [React documentation](https://reactjs.org/).
+## Scripts (Repository Development)
+
+- `npm start`: run demo app.
+- `npm run start-doc`: serve `analysis/`.
+- `npm test`: run tests (watch mode).
+- `npm run typecheck`: run TypeScript checks.
+- `npm run build`: CRA build to `build/`.
+- `npm run rollup-build-lib`: library build to `dist/`.

package/ai/api-contract.json

@@ -0,0 +1,205 @@
+{
+  "schemaVersion": "1.1.0",
+  "typeSource": "src/api/types.ts",
+  "entrypoints": [
+    {
+      "name": "createDiagramEditor",
+      "source": "src/api/createDiagramEditor.ts",
+      "returns": "DiagramEditorHandle"
+    },
+    {
+      "name": "createDiagramEngine",
+      "source": "src/engine/DiagramEngine.ts",
+      "returns": "DiagramEngineHandle"
+    }
+  ],
+  "configs": {
+    "diagramEditorConfig": {
+      "required": {
+        "container": "HTMLDivElement | string"
+      },
+      "optional": {
+        "width": "number",
+        "height": "number",
+        "initialState": "DiagramState",
+        "elementShapes": "SimpleShape[]",
+        "portShapes": "SimpleShape[]",
+        "panKey": "'Control' | 'Shift' | 'Alt' | 'Meta'",
+        "onChange": "(event: EngineChangeEvent) => void",
+        "onSelection": "(event: EngineSelectionEvent) => void"
+      },
+      "defaults": {
+        "width": 900,
+        "height": 560,
+        "panKey": "Control"
+      }
+    },
+    "diagramEngineConfig": {
+      "required": {
+        "renderer": "Renderer"
+      },
+      "optional": {
+        "scheduler": "RenderScheduler",
+        "router": "RouterStrategy",
+        "snapper": "SnapStrategy",
+        "shapeRegistry": "ShapeRegistry",
+        "textMeasurer": "TextMeasurer"
+      },
+      "defaults": {
+        "scheduler": "RenderScheduler",
+        "router": "ObstacleRouter",
+        "snapper": "DefaultSnapper",
+        "shapeRegistry": "ShapeRegistry",
+        "textMeasurer": "CanvasTextMeasurer"
+      }
+    }
+  },
+  "stateTypes": {
+    "diagramState": {
+      "required": [
+        "elements",
+        "ports",
+        "links",
+        "texts"
+      ]
+    },
+    "elementData": {
+      "required": [
+        "id",
+        "position",
+        "size",
+        "shapeId"
+      ],
+      "optional": [
+        "style",
+        "portIds",
+        "textIds",
+        "parentId",
+        "moveMode",
+        "anchorCenter",
+        "layout"
+      ],
+      "defaults": {
+        "portIds": [],
+        "textIds": [],
+        "parentId": null
+      }
+    },
+    "portData": {
+      "required": [
+        "id",
+        "elementId",
+        "position"
+      ],
+      "optional": [
+        "shapeId",
+        "size",
+        "style",
+        "textIds",
+        "moveMode",
+        "anchorCenter"
+      ],
+      "defaults": {
+        "textIds": [],
+        "anchorCenter": true
+      }
+    },
+    "linkData": {
+      "required": [
+        "id",
+        "sourcePortId",
+        "targetPortId",
+        "points"
+      ],
+      "optional": [
+        "routing",
+        "style",
+        "textIds"
+      ],
+      "defaults": {
+        "routing": "auto",
+        "textIds": []
+      }
+    },
+    "textData": {
+      "required": [
+        "id",
+        "content",
+        "position"
+      ],
+      "optional": [
+        "size",
+        "style",
+        "ownerId"
+      ],
+      "defaults": {
+        "ownerId": null
+      }
+    },
+    "elementLayoutDefaults": {
+      "padding": 12,
+      "gap": 12,
+      "align": "center"
+    }
+  },
+  "handleMethods": {
+    "shared": [
+      "load",
+      "getState",
+      "getViewport",
+      "clientToWorld",
+      "createOverlayShape",
+      "on",
+      "addElement",
+      "moveElementTo",
+      "resizeElement",
+      "setElementLayout",
+      "removeElement",
+      "addPortToElement",
+      "movePortTo",
+      "removePort",
+      "addLink",
+      "updateLinkPoints",
+      "setLinkRoutingMode",
+      "rerouteAllLinks",
+      "rerouteLinks",
+      "removeLink",
+      "addText",
+      "updateText",
+      "moveTextTo",
+      "removeText",
+      "setSelection",
+      "setViewport",
+      "setRouting",
+      "setSnapping",
+      "registerShape",
+      "render"
+    ],
+    "editorOnly": [
+      "resize",
+      "destroy"
+    ]
+  },
+  "events": {
+    "change": "EngineChangeEvent",
+    "selection": "EngineSelectionEvent",
+    "config": "EngineConfigEvent",
+    "element-drop": "ElementDropEvent",
+    "elementDrop": "ElementDropEvent",
+    "paperClick": "PaperClickEvent",
+    "portMouseDown": "PortMouseEvent",
+    "portMouseUp": "PortMouseEvent",
+    "portMoved": "PortMovedEvent",
+    "portSelected": "PortSelectedEvent",
+    "elementClick": "ElementPointerEvent",
+    "elementDragged": "ElementDropEvent",
+    "elementMoved": "ElementMovedEvent",
+    "elementResized": "ElementResizedEvent",
+    "elementDeleted": "ElementDeletedEvent",
+    "elementSelected": "ElementSelectedEvent",
+    "elementLinkStarted": "ElementLinkStartedEvent",
+    "elementLinkConnecting": "ElementLinkConnectingEvent",
+    "elementLinkEnded": "ElementLinkEndedEvent",
+    "textSelected": "TextSelectedEvent"
+  }
+}

package/ai/invariants.json

@@ -0,0 +1,41 @@
+{
+  "stateShape": [
+    "elements[]",
+    "ports[]",
+    "links[]",
+    "texts[]"
+  ],
+  "defaults": {
+    "port.anchorCenter": true,
+    "link.routing": "auto"
+  },
+  "entityRules": {
+    "element": [
+      "child element positions are parent-relative when parentId is set",
+      "deleting an element removes its ports, links via ports, and owned texts"
+    ],
+    "port": [
+      "port positions are relative to element",
+      "moving a port can be constrained by moveMode/moveAxis/moveBounds"
+    ],
+    "link": [
+      "manual routing preserves interior bend points on endpoint updates",
+      "auto routing normalizes first/last points to source/target port world positions"
+    ],
+    "text": [
+      "owner-bound text stores owner-relative position",
+      "orphan owner references are tolerated as standalone world text"
+    ]
+  },
+  "eventRules": [
+    "mutations emit change with patches and full state snapshot",
+    "setSelection emits selection plus derived selected entity events",
+    "setViewport emits viewport patch without immediate render"
+  ],
+  "verificationTests": [
+    "src/models/__tests__/DiagramModel.test.ts",
+    "src/engine/__tests__/DiagramEngine.test.ts",
+    "src/renderer/konva/__tests__/KonvaInteraction.test.ts"
+  ]
+}
+

package/ai/manifest.json

@@ -0,0 +1,34 @@
+{
+  "schemaVersion": "1.0.0",
+  "packageName": "orcasvn-react-diagrams",
+  "packageVersionSource": "package.json",
+  "description": "Machine-readable entrypoint for AI agent onboarding and reuse.",
+  "entrypoints": {
+    "indexDoc": "docs/INDEX.md",
+    "apiContractDoc": "docs/API_CONTRACT.md",
+    "capabilitiesDoc": "docs/CAPABILITIES.md",
+    "architectureDoc": "docs/ARCHITECTURE.md",
+    "invariantsDoc": "docs/STATE_INVARIANTS.md",
+    "commandsEventsDoc": "docs/COMMANDS_EVENTS.md",
+    "integrationPlaybookDoc": "docs/INTEGRATION_PLAYBOOK.md",
+    "portingChecklistDoc": "docs/PORTING_CHECKLIST.md",
+    "documentationWorkflowDoc": "docs/DOCUMENTATION_WORKFLOW.md",
+    "apiContractJson": "ai/api-contract.json",
+    "invariantsJson": "ai/invariants.json"
+  },
+  "fixtures": [
+    "docs/fixtures/empty-state.json",
+    "docs/fixtures/basic-linked-elements.json",
+    "docs/fixtures/nested-layout.json"
+  ],
+  "sourcePointers": [
+    "src/api/types.ts",
+    "src/api/createDiagramEditor.ts",
+    "src/engine/DiagramEngine.ts",
+    "src/models/DiagramModel.ts",
+    "src/renderer/Renderer.ts",
+    "analysis/White paper/Overview.md",
+    "analysis/White paper/Requirements-Functional.md"
+  ],
+  "updatedAt": "2026-02-26"
+}