@openfairygui/backend 0.2.0-alpha.0 → 0.2.0-alpha.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 OpenFairyGUI Contributors
+
+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

@@ -11,7 +11,9 @@ It owns:
 - project/session lifecycle
 - revisioned request handling
 - coordinated but non-atomic save semantics
-- backend-local advisory locking
+- browser-safe project sessions
+- browser-safe async project storage adapter
+- adapter-backed file sessions and backend-local advisory locking
 - capability discovery
 - transport-neutral bootstrap
 
@@ -26,9 +28,13 @@ It also provides:
 - polling runtime events with per-runtime monotonic sequence and bounded retention
 - `cache.refresh` in-memory jobs with cooperative cancel and terminal retention
 - revision-bound derived read-only cache snapshots
+- explicit Node bridge boundaries for publish/restore
 
 It does **not** redefine transaction grammar or expose `Document`.
 It also does **not** implement MCP or any transport-specific wire protocol.
+The root `@openfairygui/backend` entrypoint is browser-safe: pure authoring sessions can run in memory,
+and browser editors can inject an async storage adapter for OPFS, IndexedDB, ZIP-backed virtual filesystems,
+or File System Access API bridges. The default Node filesystem/runtime lives under `@openfairygui/backend/node`.
 
 ## Relationship to other packages
 
@@ -38,16 +44,71 @@ It also does **not** implement MCP or any transport-specific wire protocol.
 
 ## Example
 
+Browser-safe project session:
+
 ```ts
 import { BackendRuntime } from '@openfairygui/backend';
 
 const runtime = new BackendRuntime();
+const opened = runtime.openProjectSession({ project: uamProject });
+if (!opened.ok) throw new Error(opened.error.message);
+
+const applied = await runtime.applyTransaction({
+	sessionId: opened.data.sessionId,
+	expectedRevision: opened.data.revision,
+	operations,
+});
+```
+
+Browser-safe project session with injected storage:
+
+```ts
+import { BackendRuntime, createBackendStorageFileSystem } from '@openfairygui/backend';
+
+const fileSystem = createBackendStorageFileSystem({
+	async readFile(filePath) { return storage.readText(filePath); },
+	async readFileRaw(filePath) { return storage.readBytes(filePath); },
+	async writeFile(filePath, content) { await storage.writeText(filePath, content); },
+	async writeFileRaw(filePath, data) { await storage.writeBytes(filePath, data); },
+	async mkdir(dirPath) { await storage.mkdir(dirPath); },
+	async readdir(dirPath) { return storage.readdir(dirPath); },
+	async exists(filePath) { return storage.exists(filePath); },
+});
+
+const runtime = new BackendRuntime();
+const opened = runtime.openProjectSession({
+	project: uamProject,
+	storage: {
+		fileSystem,
+		fairyPath: 'Project.fairy',
+	},
+});
+if (!opened.ok) throw new Error(opened.error.message);
+
+const bootstrapped = await runtime.materializeSession({
+	sessionId: opened.data.sessionId,
+	expectedRevision: opened.data.revision,
+	mode: 'fullProject',
+	reason: 'workspace_bootstrap',
+});
+if (!bootstrapped.ok) throw new Error(bootstrapped.error.message);
+
+console.log(bootstrapped.data.writtenPaths);
+```
+
+Node file-backed session:
+
+```ts
+import { createNodeBackendRuntime } from '@openfairygui/backend/node';
+
+const runtime = createNodeBackendRuntime();
 const opened = await runtime.openSession({ projectPath: './MyProject' });
 if (!opened.ok) throw new Error(opened.error.message);
 
 const capabilities = runtime.getCapabilities();
 console.log(capabilities.data.runtimeOwner);
 console.log(capabilities.data.contractVersion);
+console.log(capabilities.data.artifact.publishBridge.executionBoundary);
 console.log(capabilities.data.compatibilityPolicy.incompatibleChange);
 
 const refresh = runtime.refreshCache({ sessionId: opened.data.sessionId });