@codecanvas-ide/engine 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniel Feliz
+
+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,53 @@
-# Temporary Holding Version
+# @codecanvas-ide/engine
 
-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.
+The canvas of [CodeCanvas](https://github.com/d-feliz/codecanvas-ide): it shows a TypeScript or JavaScript
+file as a zoomable diagram and lets you edit it there. Every function, class, variable and import is a block;
+usages are drawn as lines; anything changed on the canvas is written back to the text.
+
+- Blocks with previews, nested blocks, and a stable layout you can save in the repo
+- Usage lines, references across files, rename across files (TypeScript language service)
+- Syntax and type errors on the blocks
+- Changes against a base version (e.g. the last commit), and merge conflicts
+- No framework: plain TypeScript and the DOM
+
+## Install
+
+```sh
+npm install @codecanvas-ide/engine
+```
+
+## Use
+
+```ts
+import { CodeCanvas, Project } from '@codecanvas-ide/engine';
+
+const project = new Project({ 'src/cart.ts': cartText, 'src/pricing.ts': pricingText });
+const canvas = new CodeCanvas(document.getElementById('canvas')!, {
+  project,
+  createEditor: ({ parent, text, onChange, onClose }) => myEditor(parent, text, onChange, onClose),
+  onTextChange: (text) => saveFile('src/cart.ts', text),
+  onLayoutChange: (layout) => saveLayout('src/cart.ts', layout),
+});
+canvas.openFile('src/cart.ts', cartText);
+```
+
+Give the project the folder's TypeScript settings, so imports resolve as in the editor. In a monorepo,
+pass every config file and `package.json`: each config gets its own program, and packages that import
+each other by name resolve to their source.
+
+```ts
+project.setWorkspace({
+  configFiles: [{ path: 'packages/web/tsconfig.json', text: webConfigText }],
+  packageFiles: { 'packages/utils/package.json': utilsManifestText },
+});
+```
+
+To keep TypeScript work off the page's thread, run the project in a worker: `serveProject(self)` in the
+worker script, and `connectProjectWorker(worker)` in place of `new Project()` on the page.
+
+`dist/codecanvas-engine.js` is the same engine as one UMD file with TypeScript included, for hosts that
+load scripts with an AMD loader.
+
+## License
+
+MIT

package/dist/codecanvas-engine.d.ts

@@ -0,0 +1 @@
+export * from './types/index.js';