Expose portable scene bindings and an explicit React Flow peer adapter
This commit is contained in:
+33
-4
@@ -12,6 +12,8 @@ Public exports:
|
||||
| `/runtime` | Project/Workspace/Host, storage and service port types, recovery, scoped loader and compute/display pools |
|
||||
| `/service` | Foundry protocol codecs and transport adapters; credentials remain in the host |
|
||||
| `/browser` | Explicit IndexedDB/Web Locks and module Worker adapters |
|
||||
| `/bindings` | Portable projection, renderer descriptors, caches, connectors and hit queries |
|
||||
| `/react-flow` | Explicit client adapter, renderer command context and framework node/edge types |
|
||||
|
||||
The portable entries have no React, Next, React Flow or other runtime package
|
||||
dependency. They use standard platform APIs such as AbortController, Blob, URL,
|
||||
@@ -30,10 +32,9 @@ TypeScript consumers without the DOM library, and exercises compiled browser ada
|
||||
and module Worker URLs in isolated Chromium. The browser checks load the emitted JS
|
||||
directly, without TypeScript stripping or a Next bundler.
|
||||
|
||||
This preview does not yet package the React renderer/bindings. Their legacy
|
||||
projection DTO types still require an explicit adapter boundary. No registry
|
||||
publication, release support promise, server deployment or full-goal completion is
|
||||
implied by this local package.
|
||||
The React adapter has an explicit entry and optional peer dependencies; portable
|
||||
consumers do not load it. No registry publication, release support promise, server
|
||||
deployment or full-goal completion is implied by this local package.
|
||||
|
||||
Experimental partial-model runtime: pass a validated prefix plus `loading` in
|
||||
`EngineOptions`. Version 1 uses recovery format 7; version 2 carries snapshot-bound direct canvas
|
||||
@@ -180,3 +181,31 @@ Undo/redo, source failure, quota retry and late chunks do not re-upload bytes or
|
||||
restore deleted incarnations. Earlier loading/recovery versions retain their old
|
||||
restrictions; future format 13 is rejected. Generation, cross-project durable depot
|
||||
sharing and broader lifecycle/acceptance work remain separate unfinished goals.
|
||||
|
||||
The package now exposes `/bindings` for pure projection, renderer descriptors,
|
||||
geometry/projection caches, hit queries, connectors and resource-view handles.
|
||||
`projectCanvas` consumes the captured Document/Registry/queries and optional gesture
|
||||
geometry. It returns view DTOs; it does not own another document, history or queue.
|
||||
Projection DTOs and compatibility card/edge hints no longer import React Flow types
|
||||
or the legacy element classes. Legacy views re-export the same shared data types.
|
||||
|
||||
`/react-flow` is the explicit client/framework entry. It exports renderer factories,
|
||||
the command context/hook, and `ReactFlowProjectionNode`/`ReactFlowProjectionEdge`
|
||||
structural adapter types. React, React DOM and React Flow are optional peers at the
|
||||
package level, required when a host opts into this entry. Core/runtime/service and
|
||||
pure bindings remain usable without them. The declared floors are React/React DOM
|
||||
19.3.0 and React Flow 12.12.1; tests use the locally installed compatible versions,
|
||||
not a claim to have tested every allowed version.
|
||||
|
||||
A host retains the immutable renderer catalog and creates view-local projection
|
||||
caches; installed components submit commands through its scoped Provider. Attaching
|
||||
or removing UI does not replace the ProjectEngine or terminate durable jobs.
|
||||
Compatibility DTOs are rendering hints, not the model schema or a migration format.
|
||||
The existing application now uses the same explicit framework entry.
|
||||
|
||||
The packed Node consumer projects and hits its custom counter using only public
|
||||
exports, with DOM globals and external runtime dependency resolution blocked. Its
|
||||
NodeNext type check excludes DOM libraries. A separate peer consumer renders a
|
||||
registered component, verifies its command context, and checks typed NodeProps and
|
||||
EdgeProps with the declared peers. Browser tests still execute the compiled ESM
|
||||
storage and Worker artifacts independently of Next.js/TypeScript stripping.
|
||||
|
||||
@@ -6,6 +6,7 @@ import assert from 'node:assert/strict';
|
||||
import { randomUUID } from 'node:crypto';
|
||||
import { createDocument, createRegistry, builtinComponents, defineComponent, editable, movable, resizable, rectangleGeometry, applyChanges, validateDocument } from '@endoleap/headless-canvas/core';
|
||||
import { openProjectEngine } from '@endoleap/headless-canvas/runtime';
|
||||
import {projectCanvas,createRendererCatalog,builtinRendererDefinitions,createGeometryProjectionCache,hitProjectedCanvas} from '@endoleap/headless-canvas/bindings';
|
||||
import { createFoundryPersistence, loadFoundryModel } from '@endoleap/headless-canvas/service';
|
||||
|
||||
const scope={accountId:'10000000-0000-4000-8000-000000000001',workspaceId:'10000000-0000-4000-8000-000000000002',projectId:'10000000-0000-4000-8000-000000000003'};
|
||||
@@ -60,5 +61,8 @@ try{
|
||||
const loaded=await loadFoundryModel(transport,scope.workspaceId,scope.projectId,registry);assert.equal(loaded.status,'ready');assert.equal(loaded.document.elements.size,2);
|
||||
const snapshot=engine.getSnapshot(),undoDepth=snapshot.history.undo.length;await engine.close();engine=await open();await engine.settle();
|
||||
assert.equal(engine.getSnapshot().document.elements.size,2);assert.equal(engine.getSnapshot().document.elements.get(target.id).data.count,2);assert.equal(engine.getSnapshot().history.undo.length,undoDepth);assert.equal(engine.sessions.getSnapshot().views.size,0);assert.ok([...engine.getSnapshot().runtime.ledger.operations.values()].every(record=>record.phase==='resolved'));
|
||||
console.log(JSON.stringify({status:'ok',elements:2,count:2,undoDepth,reopened:true,transientViews:0,protocol:2,requests:requests.size,sourceFiles:files.size}));
|
||||
const current=engine.getSnapshot(),queries=engine.editor.getQueries(),renderers=createRendererCatalog([...builtinRendererDefinitions,{componentId:'example.counter',dataVersion:1,structure:'node',rendererId:'counter',projection:'record-v1'}]);
|
||||
const projection=projectCanvas(current.document,scope.projectId,registry,new Set(),()=>undefined,null,renderers,{queries,geometry:createGeometryProjectionCache()});assert.equal(projection.nodes.length,2);assert.ok(projection.nodes.every(node=>node.type==='counter'&&node.data.__headlessRecord));
|
||||
const hit=hitProjectedCanvas(projection,queries,registry,'portable-view',{space:'scene',point:{x:40,y:10},zoom:1});assert.equal(hit.complete,true);assert.ok(hit.hits.some(hit=>hit.target.id===target.id));
|
||||
console.log(JSON.stringify({status:'ok',portableBindings:true,elements:2,count:2,undoDepth,reopened:true,transientViews:0,protocol:2,requests:requests.size,sourceFiles:files.size}));
|
||||
}finally{await engine.close();storage.close();}
|
||||
|
||||
+53
-8
@@ -3,13 +3,58 @@
|
||||
"version": "0.1.0",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"engines": { "node": ">=22" },
|
||||
"exports": {
|
||||
".": { "types": "./modules/canvas-core/index.d.ts", "import": "./modules/canvas-core/index.js" },
|
||||
"./core": { "types": "./modules/canvas-core/index.d.ts", "import": "./modules/canvas-core/index.js" },
|
||||
"./runtime": { "types": "./modules/canvas-runtime/index.d.ts", "import": "./modules/canvas-runtime/index.js" },
|
||||
"./browser": { "types": "./modules/canvas-runtime/browser.d.ts", "import": "./modules/canvas-runtime/browser.js" },
|
||||
"./service": { "types": "./modules/canvas-service/index.d.ts", "import": "./modules/canvas-service/index.js" }
|
||||
"engines": {
|
||||
"node": ">=22"
|
||||
},
|
||||
"files": ["modules", "consumer.mjs", "README.md"]
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./modules/canvas-core/index.d.ts",
|
||||
"import": "./modules/canvas-core/index.js"
|
||||
},
|
||||
"./core": {
|
||||
"types": "./modules/canvas-core/index.d.ts",
|
||||
"import": "./modules/canvas-core/index.js"
|
||||
},
|
||||
"./runtime": {
|
||||
"types": "./modules/canvas-runtime/index.d.ts",
|
||||
"import": "./modules/canvas-runtime/index.js"
|
||||
},
|
||||
"./browser": {
|
||||
"types": "./modules/canvas-runtime/browser.d.ts",
|
||||
"import": "./modules/canvas-runtime/browser.js"
|
||||
},
|
||||
"./service": {
|
||||
"types": "./modules/canvas-service/index.d.ts",
|
||||
"import": "./modules/canvas-service/index.js"
|
||||
},
|
||||
"./bindings": {
|
||||
"types": "./modules/canvas-bindings/index.d.ts",
|
||||
"import": "./modules/canvas-bindings/index.js"
|
||||
},
|
||||
"./react-flow": {
|
||||
"types": "./modules/canvas-bindings/react-flow.d.ts",
|
||||
"import": "./modules/canvas-bindings/react-flow.js"
|
||||
}
|
||||
},
|
||||
"files": [
|
||||
"modules",
|
||||
"consumer.mjs",
|
||||
"README.md"
|
||||
],
|
||||
"peerDependencies": {
|
||||
"react": ">=19.3.0 <20",
|
||||
"react-dom": ">=19.3.0 <20",
|
||||
"@xyflow/react": ">=12.12.1 <13"
|
||||
},
|
||||
"peerDependenciesMeta": {
|
||||
"react": {
|
||||
"optional": true
|
||||
},
|
||||
"react-dom": {
|
||||
"optional": true
|
||||
},
|
||||
"@xyflow/react": {
|
||||
"optional": true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user