@scrawl-board/board 0.1.0-beta.0

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "{}"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright 2026 Igwe Chinonso and Scrawl contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/NOTICE

@@ -0,0 +1,28 @@
+Scrawl Board SDK (@scrawl-board/board)
+Copyright 2026 Igwe Chinonso and Scrawl contributors
+
+This product includes software developed as part of the Scrawl Board
+SDK project (https://github.com/purelogiclimited/scrawl-board-sdk), licensed
+under the Apache License, Version 2.0. See the LICENSE file for the
+full license text.
+
+This package bundles the following third-party software into its
+distributed dist/browser.js and dist/react.js entries:
+
+  bidi-js 1.0.3 (MIT)
+    Copyright (c) 2021 Jason Johnston
+  require-from-string 2.0.2 (MIT)
+    Copyright (c) Vsevolod Strukchinsky <floatdrop@gmail.com> (github.com/floatdrop)
+  three 0.185.1 (MIT)
+    Copyright © 2010-2026 three.js authors
+  troika-three-text 0.52.4 (MIT)
+    Copyright (c) 2019 ProtectWise
+    Copyright (c) 2021 Jason Johnston
+  troika-three-utils 0.52.4 (MIT)
+    Copyright (c) 2019 ProtectWise
+    Copyright (c) 2021 Jason Johnston
+  troika-worker-utils 0.52.0 (MIT)
+    Copyright (c) 2019 ProtectWise
+    Copyright (c) 2021 Jason Johnston
+  webgl-sdf-generator 1.1.1 (MIT)
+    Copyright (c) 2021 Jason Johnston

package/README.md

@@ -0,0 +1,106 @@
+# Scrawl Board SDK
+
+An embeddable, collaborative infinite-canvas whiteboard for React and
+vanilla JS/TS apps. New to the package? Start with
+[GETTING_STARTED.md](./GETTING_STARTED.md) — this file is the deeper
+technical reference (theme tokens, keyboard shortcuts, Document schema).
+
+```tsx
+import { Scrawl } from "@scrawl-board/board/react";
+import "@scrawl-board/board/styles.css";
+
+export function Board() {
+  return <Scrawl document={{ id: "local-board" }} preset="light" />;
+}
+```
+
+`Scrawl` owns a canvas-backed controller and disposes it after unmount. Advanced
+Hosts can compose `ScrawlProvider`, `ScrawlCanvas`, `ScrawlDefaultUI`, and
+`ScrawlPortal` around an existing controller, and observe it with
+`useScrawlController`, `useScrawlSnapshot`, and `useScrawlTheme`. Theme overrides
+are semantic, Board-local runtime configuration. They never enter Documents or
+exports. Importing JavaScript never injects CSS; default UI consumers must import
+the stylesheet explicitly.
+
+`ScrawlDefaultUI` supplies the SDK-owned interaction chrome for tools, ink style,
+undo and redo, zoom and fit, search, JSON import, and PNG, SVG, or JSON export.
+Every control calls a public grouped controller capability. The default keyboard
+surface is scoped to the focused Board: `P` selects marker, `H` selects
+highlighter, `V` selects selection, `E` selects eraser, `N` selects note, `T`
+selects text, `F` fits content, `Mod+Z` undoes, `Mod+Shift+Z` redoes, and `Mod+F`
+opens Board search. Dialogs trap focus, close with Escape, and restore focus to
+their opener. Hosts that replace the default UI can remove it independently while
+retaining `ScrawlProvider` and `ScrawlCanvas`, or disable individual `tools`,
+`history`, `view`, `style`, `search`, `import`, and `export` regions with the
+`ScrawlDefaultUI` `regions` prop.
+
+Use `createBoardController` from `@scrawl-board/board/browser` for imperative Host
+integration. Its grouped capabilities are the public boundary; rendering, input,
+camera, tools, Three.js, and the existing engine stay private.
+
+```ts
+import { createBoardController } from "@scrawl-board/board/browser";
+
+const board = createBoardController({ document: { id: "local-board" } });
+const unsubscribe = board.on("change", (snapshot) => {
+  console.log(snapshot.objectCount, snapshot.canUndo);
+});
+
+board.tools.select("marker");
+board.style.setInkColor("#245b78");
+board.content.add({
+  type: "stroke",
+  color: "#1c1c1e",
+  baseWidth: 2,
+  points: [{ x: 0, y: 0, pressure: 0.5 }],
+});
+board.history.undo();
+board.content.import(importedDocument);
+
+unsubscribe();
+await board.dispose();
+```
+
+The controller exposes a recursively read-only Document view. All writes pass
+through `content` and `history` commands. A canvas-backed controller delegates to
+the private renderer and input engine. Persistence and collaboration are optional
+Host adapters with separate status, abort signals, and explicit `flush()` and
+`dispose()` lifecycle boundaries. `createLocalBoard` remains as a temporary Phase 1
+compatibility facade.
+
+## Durable Documents
+
+The portable `/core` entry owns Document schema version `1`. Load untrusted or
+historical bytes with `loadDocumentBytes`. The result either contains an in-memory
+current Document or a `DocumentRecoveryError` that retains the exact input bytes.
+Loading does not write anything.
+
+```ts
+import { loadDocumentBytes, serializeDocument } from "@scrawl-board/board/core";
+
+const loaded = loadDocumentBytes(bytesFromStorage);
+if (!loaded.ok) {
+  recoverOriginal(loaded.error.originalBytes);
+} else {
+  const currentBytes = serializeDocument(loaded.document);
+}
+```
+
+`serializeDocument` accepts only a complete current-version shape. Historical
+unversioned Documents are migrated sequentially on read, including strokes written
+by the former live-point Op bug. Core time and identifier generation are explicit
+inputs; browser and storage ownership remains with the Host.
+
+## More docs
+
+- [GETTING_STARTED.md](./GETTING_STARTED.md) — install, quickstart, customization levels
+- [Concepts](./docs/concepts.md), [Recipes](./docs/recipes.md), [Framework guides](./docs/framework-guides/)
+- [Compatibility](./docs/compatibility.md), [Migration](./docs/migration.md)
+- [Support](./docs/support.md), [Troubleshooting](./docs/troubleshooting.md)
+- [Generated API reference](./docs/api/)
+
+## License
+
+Apache License 2.0 — see [LICENSE](./LICENSE) and [NOTICE](./NOTICE). See
+[TRADEMARK_POLICY.md](../../TRADEMARK_POLICY.md) in the repository root
+for what use of the "Scrawl" name and marks is and isn't permitted.