Skip to main content

Data & Persistence

A Scene is a plain, immutable, serialisable data structure. This section covers the data layer around it:

  • Store — the immutable Scene model: pure operations that return { scene, patch }, and invertible patches.
  • Persistence — @oh-just-another/serialization: serializeScene / stringifyScene out, parseScene / deserializeScene back, with forward-only migrations.
  • Validation — every loaded document is validated against the SceneDocumentZ zod schema; failures throw DeserializationError.
  • Image export — browser PNG from the editor, headless SVG/PNG on the server, and document-grade PNG/PDF via @oh-just-another/exporter.
  • Version history — @oh-just-another/versioning: named snapshots, branches, diff, and three-way merge.
  • Signals — the reactivity model: immutable state plus typed events (no fine-grained signals yet).

Quick save/restore through the EditorAPI ref handle (getScene() / loadScene()):

import { stringifyScene, parseScene } from "@oh-just-another/serialization";

const json = stringifyScene(api.getScene(), 2); // pretty-printed JSON string
api.loadScene(parseScene(json)); // resets undo history

Binary blobs (embedded images) live in the Scene.files registry and persist separately via serializeFiles / stringifyFiles / parseFiles — see Assets.