@mocanvas/mocanvas 3.1.1 → 4.0.1

package/CLEAN_ROOM.md

@@ -1,6 +1,6 @@
 # Clean-room policy
 
-mocanvas is an original work licensed under MIT. It is *shaped like* tldraw so
+mocanvas is an original work. It is *shaped like* tldraw so
 that projects can migrate, but it is not derived from it.
 
 ## Rules for contributors (human or agent)

package/COMPAT.md

@@ -1,6 +1,6 @@
 # Compatibility with tldraw 5.4
 
-mocanvas reimplements the tldraw API from scratch, under MIT, without reading
+mocanvas reimplements the tldraw API from scratch, without reading
 tldraw's source — see [CLEAN_ROOM.md](CLEAN_ROOM.md). This document says what
 that covers today, what it deliberately does not, and where the two libraries
 behave differently on purpose.
@@ -199,7 +199,7 @@ services tldraw operates", which was wrong about sync — see below.
 
 | | Why |
 | :--- | :--- |
-| Licensing, watermark, license telemetry | mocanvas is MIT; there is no licence to check. `licenseKey` is accepted and ignored. |
+| Licensing, watermark, license telemetry | mocanvas's own licence is a written agreement, not a key the canvas checks at runtime, so there is nothing to verify and no watermark to draw. `licenseKey` is accepted and ignored. |
 | `useSyncDemo` | Points at demo servers tldraw hosts. The only symbol in `@tldraw/sync` that genuinely does. |
 | The tldraw asset CDN defaults | The asset mechanism is kept; the host is not. Supply your own `AssetStore`. |
 | Third-party embed unfurling and integrations | Each is a call to somebody's API. `EmbedShapeUtil.configure({ embedConfig })` lets an app supply its own. |

package/LICENSE

@@ -1,21 +1,115 @@
-MIT License
+mocanvas License
+Copyright (c) 2026 Symbio Digital. All rights reserved.
 
-Copyright (c) 2026 Symbio Digital
+This software is source-available, not open source. It is free for the uses
+listed in section 2. Commercial Use requires a separate written agreement with
+Symbio Digital: contact mocanvas@symbio.agency.
 
-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.
+1. DEFINITIONS
+
+"Software" means mocanvas — the packages published under the @mocanvas scope,
+their source code, compiled artefacts, documentation and accompanying files.
+
+"You" means the individual or legal entity exercising the rights granted below.
+
+"Commercial Use" means any use of the Software in, or in the development or
+operation of, a product, service, website, application or internal tool that is:
+
+  (a) sold, licensed, rented or otherwise offered for a fee;
+  (b) used to generate revenue directly or indirectly, including through
+      advertising, sponsorship, subscription or transaction fees; or
+  (c) used in the ordinary business operations of a for-profit entity.
+
+"Non-Profit Organisation" means an entity organised and operated for charitable,
+educational, scientific, cultural, religious or similar purposes, which does not
+distribute profits to owners or shareholders, and which is recognised as such
+under the law of its jurisdiction.
+
+"Development Use" means use on a developer's own machine, or in evaluation,
+testing, continuous integration, review or staging environments, where the
+result is not offered to the public and is not used to operate a product or
+service.
+
+
+2. GRANT
+
+Subject to the terms of this Licence, Symbio Digital grants You a worldwide,
+royalty-free, non-exclusive, non-transferable, revocable licence to use, copy,
+modify and create derivative works of the Software, solely for:
+
+  (a) personal use that is not Commercial Use;
+  (b) use by a Non-Profit Organisation in pursuit of its non-profit purposes;
+  (c) Development Use, including by a for-profit entity evaluating the Software;
+  (d) teaching, study and academic research.
+
+You may distribute the Software, or a derivative work of it, only if the
+recipient receives it under this Licence, unmodified, with the notices in
+section 4 intact, and only for the purposes above.
+
+
+3. COMMERCIAL USE
+
+Commercial Use is not granted by this Licence. It requires a separate written
+agreement with Symbio Digital.
+
+Development Use under section 2(c) is permitted before such an agreement is in
+place, so that a for-profit entity may evaluate the Software and build against
+it — but shipping, deploying or operating the result as part of a commercial
+product, service or website is Commercial Use and requires the agreement first.
+
+To obtain one, contact:
+
+    mocanvas@symbio.agency
+
+
+4. CONDITIONS
+
+You must retain, in all copies and derivative works of the Software, this
+Licence text, the copyright notice above, and any notices identifying Symbio
+Digital as the author.
+
+You may not sublicense the Software, remove or alter its licence notices, or
+represent that the Software is available under different terms.
+
+
+5. THIRD-PARTY COMPONENTS
+
+The Software depends on third-party components distributed under their own
+licences. Those licences govern those components, and nothing in this Licence
+limits rights You have under them.
+
+
+6. NO WARRANTY
 
 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.
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+
+
+7. LIMITATION OF LIABILITY
+
+TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL SYMBIO
+DIGITAL 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.
+
+
+8. TERMINATION
+
+This Licence terminates automatically if You breach it. On termination You must
+stop using the Software and destroy all copies in Your possession. Sections 5
+through 7 survive termination.
+
+
+9. PRIOR RELEASES
+
+Versions of the Software released under the MIT Licence remain available under
+that licence, on the terms under which they were released. This Licence governs
+this version and later ones.
+
+
+10. CONTACT
+
+    mocanvas@symbio.agency
+    Symbio Digital

package/README.md

@@ -5,10 +5,96 @@ tools and UI, on top of a Rust + WebAssembly engine that does geometry,
 hit-testing, culling and tessellation and writes GPU buffers straight into
 linear memory.
 
-The guides ship inside this package rather than being linked: `COMPAT.md` for
-what exists of the tldraw API, `MIGRATION.md` for moving an app across,
-`CUSTOM_SHAPES.md` for writing a shape util and its tool, and `CLEAN_ROOM.md`
-for how this library was built.
+## Why this exists
+
+We built products on [tldraw](https://tldraw.dev), and it is a genuinely
+excellent library — the API model in this package is shaped after it because we
+think they got that design right. What we ran out of was headroom: our canvases
+grew past the point where a DOM-and-SVG renderer kept up, and the work we needed
+to move off the main thread had nowhere to go.
+
+So mocanvas is that same shape of API with a different engine underneath, and it
+is built so you can come across without rewriting your app:
+
+- **The API is the one you know.** `Editor`, `ShapeUtil`, `StateNode`, records
+  with `shape:` / `page:` ids, `createShapes`, `zoomToFit`, `.tldr` files.
+- **Every symbol tldraw's reference documents exists here under the same name.**
+  1,420 of 1,420 — see *Compatibility with tldraw* below for what that does and
+  does not promise.
+- **`@mocanvas/compat` gives you the `TL`-prefixed spellings**, so a migration
+  can change import paths first and rename later. `MIGRATION.md`, shipped in
+  this package, walks through it.
+
+## Performance
+
+The engine is the point. Geometry, hit-testing, spatial indexing, culling and
+tessellation run in WebAssembly and write GPU vertex buffers straight into
+linear memory; the renderer is WebGL2 today and WebGPU behind the same
+interface next.
+
+Creating shapes, median milliseconds — lower is better:
+
+| Scene | mocanvas | tldraw 5.4 | |
+| :--- | ---: | ---: | ---: |
+| 1,000 geo shapes | 15.1 ms | 37.8 ms | **2.5× faster** |
+| 5,000 geo shapes | 40.1 ms | 120.0 ms | **3.0× faster** |
+| 20,000 geo shapes | 134.2 ms | 433.2 ms | **3.2× faster** |
+| 1,000 mixed | 25.7 ms | 76.0 ms | **3.0× faster** |
+| 5,000 mixed | 67.8 ms | 241.5 ms | **3.6× faster** |
+| 20,000 mixed | 249.4 ms | 753.7 ms | **3.0× faster** |
+
+Interaction at scale, dragging a selection, median milliseconds per frame:
+
+| Scene | mocanvas | tldraw 5.4 | |
+| :--- | ---: | ---: | ---: |
+| 1,000 geo shapes | 33.0 ms | 25.1 ms | tldraw ahead |
+| 5,000 geo shapes | 116.6 ms | 150.0 ms | **1.3× faster** |
+| 20,000 geo shapes | 400.0 ms | 858.4 ms | **2.1× faster** |
+| 20,000 mixed | 841.6 ms | 1,124.9 ms | **1.3× faster** |
+
+The shape of it is that mocanvas scales: it wins by ~3× on building a scene at
+every size, and the interaction gap opens as the scene grows. On small scenes
+tldraw's renderer is ahead.
+
+**Read these numbers with their caveats.** They were measured on 2026-09-04 on an
+Apple M3 Pro in headless Chromium **with no hardware GPU** — Chromium fell back
+to software rasterisation, which penalises mocanvas's WebGL2 renderer far more
+than it penalises tldraw's DOM one, so the interaction numbers above are close to
+a worst case for mocanvas. Both libraries ran on default settings, and this is
+our own benchmark of our own library. `BENCHMARK.md`, shipped in this package,
+has the method, the full tables and a longer list of caveats — including a
+rendering-fidelity comparison against tldraw at 99.2% interior IoU.
+
+## Compatibility with tldraw
+
+The API is shaped after **tldraw 5.4**, and every symbol its public reference
+documents exists here under the same name — 1,420 of 1,420, across `tldraw`,
+`@tldraw/editor`, `@tldraw/tlschema`, `@tldraw/store`, `@tldraw/state`,
+`@tldraw/state-react` and `@tldraw/validate`. `@mocanvas/compat` carries the
+`TL`-prefixed spellings so an existing codebase can switch imports first and
+rename later.
+
+Names are not behaviour, and the honest number is lower: across the symbols both
+libraries share, 86.4% of `@tldraw/editor`'s members are present. `Vec`, `Box`
+and `Mat` are complete; `Editor` has 304 of its 313 members and `ShapeUtil` 52 of
+77, the gap there being mostly the `can*` predicates.
+
+Four documented packages are not implemented. `@tldraw/mermaid` and
+`@tldraw/driver` are wanted and unbuilt. `@tldraw/sync` and `@tldraw/sync-core`
+are a deliberate difference: mocanvas has multiplayer — `@mocanvas/sync`, with
+its own transport and a field-level CRDT — but not tldraw's sync protocol, so an
+app keeping its existing tldraw sync *server* would have to move. Licensing and
+watermark checks, `useSyncDemo` and the asset CDN defaults are tied to services
+tldraw runs and are not coming; each has a seam to supply your own.
+
+`COMPAT.md` in this package has the measured breakdown and names what is missing.
+
+## Guides, shipped in this package
+
+`COMPAT.md` for what exists of the tldraw API, `MIGRATION.md` for moving an app
+across, `CUSTOM_SHAPES.md` for writing a shape util and its tool, `BENCHMARK.md`
+for the performance and fidelity method, `ARCHITECTURE.md` for how the engine
+works, and `CLEAN_ROOM.md` for how this library was built.
 
 ## Install
 
@@ -108,30 +194,6 @@ Two optional notes:
 | `@mocanvas/sync`   | multiplayer: record diffs, presence, cursors                |
 | `@mocanvas/compat` | `TL`-prefixed aliases for a tldraw migration                |
 
-## Compatibility with tldraw
-
-The API is shaped after **tldraw 5.4**, and every symbol its public reference
-documents exists here under the same name — 1,420 of 1,420, across `tldraw`,
-`@tldraw/editor`, `@tldraw/tlschema`, `@tldraw/store`, `@tldraw/state`,
-`@tldraw/state-react` and `@tldraw/validate`. `@mocanvas/compat` carries the
-`TL`-prefixed spellings so an existing codebase can switch imports first and
-rename later.
-
-Names are not behaviour, and the honest number is lower: across the symbols both
-libraries share, 86.4% of `@tldraw/editor`'s members are present. `Vec`, `Box`
-and `Mat` are complete; `Editor` has 304 of its 313 members and `ShapeUtil` 52 of
-77, the gap there being mostly the `can*` predicates.
-
-Four documented packages are not implemented. `@tldraw/mermaid` and
-`@tldraw/driver` are wanted and unbuilt. `@tldraw/sync` and `@tldraw/sync-core`
-are a deliberate difference: mocanvas has multiplayer — `@mocanvas/sync`, with
-its own transport and a field-level CRDT — but not tldraw's sync protocol, so an
-app keeping its existing tldraw sync *server* would have to move. Licensing and
-watermark checks, `useSyncDemo` and the asset CDN defaults are tied to services
-tldraw runs and are not coming; each has a seam to supply your own.
-
-`COMPAT.md` in this package has the measured breakdown and names what is missing.
-
 ## Clean room
 
 **mocanvas has never been built by reading tldraw's source** — not the
@@ -139,11 +201,28 @@ repository, not a copy in `node_modules`, not a fork. It is written from first
 principles against the public API reference and guides on tldraw.dev and sample
 `.tldr` documents, and its compatibility is *measured* against that same
 reference. Names are not copyrightable expression (*Google v. Oracle*, 2021);
-the implementation behind them is original work under MIT. `CLEAN_ROOM.md` in
+the implementation behind them is our own original work. `CLEAN_ROOM.md` in
 this package is the full policy.
 
 mocanvas is not affiliated with or endorsed by tldraw.
 
 ## License
 
-MIT
+**Source-available, not open source.** Free to use for:
+
+- personal, non-commercial projects;
+- non-profit organisations;
+- development, evaluation, testing and staging — including inside a for-profit
+  company, so you can try it and build against it before committing;
+- teaching and academic research.
+
+**Shipping it in a commercial product, service or website needs a written
+agreement with us.** That includes anything sold, anything that earns revenue
+directly or through advertising, and internal tools running a for-profit
+business.
+
+To arrange one, or if you are unsure which side of the line you are on, write to
+**mocanvas@symbio.agency** — we would rather answer the question than have you
+guess.
+
+The full terms are in `LICENSE`, shipped in this package.

package/dist/index.d.ts

@@ -8493,7 +8493,8 @@ interface MocanvasProps {
      */
     assetUrls?: TLAssetUrls;
     /**
-     * Accepted and ignored. mocanvas is MIT and has no licence to check; the
+     * Accepted and ignored. mocanvas's licence is a written agreement rather
+     * than a key the canvas verifies at runtime, so there is nothing to check; the
      * prop exists so an app migrating from a licensed canvas does not have to
      * strip it from every mount, and so that leaving it in place stays a no-op
      * rather than becoming a type error.