@pixerate/editor 0.153.0 → 0.155.0

package/dist/chunk-NHLYK3AX.js

@@ -0,0 +1,393 @@
+import {
+  isUnsafeJsonKey,
+  stripPrototypeKeys
+} from "./chunk-HF5QZS7Z.js";
+
+// src/persistence/assets.ts
+var EDITOR_ASSET_PREFIX = "pixerate-asset:";
+var REF = /pixerate-asset:[0-9a-z]+-[0-9a-z]+(?:~[0-9]+)?/g;
+var BASE64 = /^[A-Za-z0-9+/=\r\n]+$/;
+function isInlineAsset(value) {
+  if (value.startsWith("data:")) return value.length >= 512;
+  return value.length >= 4096 && BASE64.test(value);
+}
+function hash53(text) {
+  let h1 = 3735928559;
+  let h2 = 1103547991;
+  for (let i = 0; i < text.length; i++) {
+    const c = text.charCodeAt(i);
+    h1 = Math.imul(h1 ^ c, 2654435761);
+    h2 = Math.imul(h2 ^ c, 1597334677);
+  }
+  h1 = Math.imul(h1 ^ h1 >>> 16, 2246822507) ^ Math.imul(h2 ^ h2 >>> 13, 3266489909);
+  h2 = Math.imul(h2 ^ h2 >>> 16, 2246822507) ^ Math.imul(h1 ^ h1 >>> 13, 3266489909);
+  return 4294967296 * (2097151 & h2) + (h1 >>> 0);
+}
+function createEditorAssetRegistry() {
+  const byRef = /* @__PURE__ */ new Map();
+  const byData = /* @__PURE__ */ new Map();
+  return {
+    put(data) {
+      const known = byData.get(data);
+      if (known) return known;
+      const base = `${EDITOR_ASSET_PREFIX}${data.length.toString(36)}-${hash53(data).toString(36)}`;
+      let ref = base;
+      for (let n = 1; byRef.has(ref) && byRef.get(ref) !== data; n++) ref = `${base}~${n}`;
+      byRef.set(ref, data);
+      byData.set(data, ref);
+      return ref;
+    },
+    get: (ref) => byRef.get(ref),
+    has: (ref) => byRef.has(ref),
+    set(ref, data) {
+      byRef.set(ref, data);
+      byData.set(data, ref);
+    },
+    get size() {
+      return byRef.size;
+    }
+  };
+}
+function externalizeAssets(value, registry) {
+  const walk = (v) => {
+    if (typeof v === "string") return isInlineAsset(v) ? registry.put(v) : v;
+    if (Array.isArray(v)) return v.map(walk);
+    if (v && typeof v === "object") {
+      const out = {};
+      for (const [k, x] of Object.entries(v)) out[k] = walk(x);
+      return out;
+    }
+    return v;
+  };
+  return walk(value);
+}
+function collectAssetRefs(value) {
+  const text = typeof value === "string" ? value : JSON.stringify(value) ?? "";
+  return [...new Set(text.match(REF) ?? [])];
+}
+function internalizeAssets(value, registry) {
+  const missing = collectAssetRefs(value).filter((ref) => !registry.has(ref));
+  if (missing.length) {
+    throw new Error(
+      `The document refers to ${missing.length} asset${missing.length === 1 ? "" : "s"} that ${missing.length === 1 ? "is" : "are"} not loaded (${missing.slice(0, 3).join(", ")}${missing.length > 3 ? ", \u2026" : ""}). Pass a document from get_*_document in this session, or open it from storage so its assets are read first.`
+    );
+  }
+  const walk = (v) => {
+    if (typeof v === "string") return v.startsWith(EDITOR_ASSET_PREFIX) && registry.has(v) ? registry.get(v) : v;
+    if (Array.isArray(v)) return v.map(walk);
+    if (v && typeof v === "object") {
+      const out = {};
+      for (const [k, x] of Object.entries(v)) out[k] = walk(x);
+      return out;
+    }
+    return v;
+  };
+  return walk(value);
+}
+var persisted = /* @__PURE__ */ new WeakMap();
+var assetKey = (ref, options) => `${options.prefix ?? "pixerate.assets:"}${ref.slice(EDITOR_ASSET_PREFIX.length)}`;
+async function persistEditorAssets(storage, registry, document, options = {}) {
+  const written = persisted.get(storage) ?? /* @__PURE__ */ new Set();
+  persisted.set(storage, written);
+  for (const ref of collectAssetRefs(document)) {
+    const key = assetKey(ref, options);
+    if (written.has(key)) continue;
+    const data = registry.get(ref);
+    if (data === void 0) continue;
+    await storage.set(key, data);
+    written.add(key);
+  }
+}
+async function preloadEditorAssets(storage, registry, document, options = {}) {
+  const missing = [];
+  for (const ref of collectAssetRefs(document)) {
+    if (registry.has(ref)) continue;
+    const data = await storage.get(assetKey(ref, options));
+    if (data === null) missing.push(ref);
+    else registry.set(ref, data);
+  }
+  return missing;
+}
+function withEditorAssets(storage, registry, options = {}) {
+  return {
+    kind: storage.kind,
+    get available() {
+      return storage.available;
+    },
+    async get(key) {
+      const value = await storage.get(key);
+      if (value !== null && value.includes(EDITOR_ASSET_PREFIX)) await preloadEditorAssets(storage, registry, value, options);
+      return value;
+    },
+    async set(key, value) {
+      if (value.includes(EDITOR_ASSET_PREFIX)) await persistEditorAssets(storage, registry, value, options);
+      await storage.set(key, value);
+    },
+    remove: (key) => storage.remove(key)
+  };
+}
+
+// src/persistence/migrate.ts
+function hasLoadProblems(report) {
+  return report.problems.length > 0 || report.readOnly !== null;
+}
+function createLoadReport(partial = {}) {
+  return {
+    migratedFrom: null,
+    version: null,
+    problems: [],
+    readOnly: null,
+    unknownKeys: [],
+    ...partial
+  };
+}
+var isObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+var deepClone = (value) => typeof structuredClone === "function" ? structuredClone(value) : JSON.parse(JSON.stringify(value));
+function toObject(json) {
+  let value = json;
+  if (typeof json === "string") {
+    try {
+      value = JSON.parse(json);
+    } catch {
+      return void 0;
+    }
+  }
+  return isObject(value) ? stripPrototypeKeys(deepClone(value)) : void 0;
+}
+function migrateDocument(json, options) {
+  const versionKey = options.versionKey ?? "version";
+  const target = options.currentVersion;
+  const original = toObject(json);
+  if (!original) {
+    return {
+      doc: { [versionKey]: target },
+      report: createLoadReport({
+        readOnly: { kind: "invalid", message: "document is not a JSON object" }
+      })
+    };
+  }
+  const raw = original[versionKey];
+  const found = typeof raw === "number" && Number.isInteger(raw) && raw >= 0 ? raw : null;
+  const from = found ?? options.missingVersion ?? target;
+  const report = createLoadReport({ version: found });
+  if (from > target) {
+    report.readOnly = {
+      kind: "newerVersion",
+      version: from,
+      supported: target,
+      message: `document has version ${from}, newer than the supported ${target}`
+    };
+    return { doc: original, report };
+  }
+  if (from === target) {
+    original[versionKey] = target;
+    return { doc: original, report };
+  }
+  let doc = deepClone(original);
+  for (let step = from; step < target; step++) {
+    const fn = options.steps?.[step];
+    if (!fn) {
+      report.readOnly = {
+        kind: "migrationFailed",
+        from: step,
+        message: `no migration step from version ${step}`
+      };
+      return { doc: original, report };
+    }
+    try {
+      doc = fn(doc) ?? doc;
+    } catch (error) {
+      report.readOnly = {
+        kind: "migrationFailed",
+        from: step,
+        message: `migration from version ${step} failed: ${error instanceof Error ? error.message : String(error)}`
+      };
+      return { doc: original, report };
+    }
+    doc[versionKey] = step + 1;
+  }
+  report.migratedFrom = from;
+  return { doc, report };
+}
+function loadSections(doc, sections, options = {}) {
+  const source = isObject(doc) ? doc : {};
+  const ignore = new Set(options.ignore ?? ["version"]);
+  const value = {};
+  const problems = [];
+  for (const key of Object.keys(sections)) {
+    const spec = sections[key];
+    const fallback = () => typeof spec.defaults === "function" ? spec.defaults() : spec.defaults;
+    if (!Object.prototype.hasOwnProperty.call(source, key)) {
+      value[key] = fallback();
+      continue;
+    }
+    try {
+      const parsed = spec.parse(source[key]);
+      if (parsed === void 0) throw new Error("invalid value");
+      value[key] = parsed;
+    } catch (error) {
+      problems.push({
+        section: key,
+        message: error instanceof Error ? error.message : String(error)
+      });
+      value[key] = fallback();
+    }
+  }
+  const unknown = {};
+  for (const key of Object.keys(source)) {
+    if (!(key in sections) && !ignore.has(key) && !isUnsafeJsonKey(key)) unknown[key] = source[key];
+  }
+  return { value, problems, unknown };
+}
+function loadDocument(json, sections, options) {
+  const { doc, report } = migrateDocument(json, options);
+  const ignore = options.ignore ?? [options.versionKey ?? "version"];
+  const result = loadSections(report.readOnly?.kind === "invalid" ? {} : doc, sections, {
+    ignore
+  });
+  report.problems = result.problems;
+  report.unknownKeys = Object.keys(result.unknown);
+  return { ...result, report };
+}
+
+// src/persistence/editorDocument.ts
+var EditorDocumentLoadError = class extends Error {
+  /** The `LoadReport` when the input was a file that could not be migrated. */
+  report;
+  constructor(message, report) {
+    super(message);
+    this.name = "EditorDocumentLoadError";
+    this.report = report;
+  }
+};
+var EDITOR_DOCUMENT_FORMAT = "pixerate.editor-document";
+var KIND = /^[a-z][a-z0-9_]*$/;
+function isEditorDocumentFile(value) {
+  if (!value || typeof value !== "object" || Array.isArray(value)) return false;
+  const v = value;
+  return v.format === EDITOR_DOCUMENT_FORMAT && typeof v.kind === "string" && typeof v.formatVersion === "number" && "document" in v;
+}
+function toEditorDocumentFile(doc, name) {
+  return {
+    format: EDITOR_DOCUMENT_FORMAT,
+    kind: doc.kind,
+    formatVersion: doc.formatVersion,
+    ...name ? { name } : {},
+    document: doc.getDocument()
+  };
+}
+function serializeEditorDocument(doc, options = {}) {
+  return JSON.stringify(toEditorDocumentFile(doc, options.name), null, options.space);
+}
+function parseEditorDocument(text, options = {}) {
+  let value;
+  try {
+    value = stripPrototypeKeys(JSON.parse(text));
+  } catch (error) {
+    throw new EditorDocumentLoadError(`The file is not valid JSON: ${error instanceof Error ? error.message : String(error)}`);
+  }
+  if (!isEditorDocumentFile(value)) {
+    throw new EditorDocumentLoadError(`The file is not a saved editor document (expected "format": "${EDITOR_DOCUMENT_FORMAT}").`);
+  }
+  if (options.kind && value.kind !== options.kind) {
+    throw new EditorDocumentLoadError(`The file is a ${value.kind} document, not a ${options.kind} document.`);
+  }
+  return value;
+}
+function defineEditorDocument(spec) {
+  if (!KIND.test(spec.kind)) throw new Error(`Editor document kind "${spec.kind}" must match ${KIND}.`);
+  const formatVersion = spec.formatVersion ?? 1;
+  const listeners = /* @__PURE__ */ new Set();
+  let revision = 0;
+  let unsubscribe = null;
+  let connected = false;
+  const connect = () => {
+    if (unsubscribe) return;
+    if (connected) revision++;
+    connected = true;
+    unsubscribe = spec.subscribe(() => {
+      revision++;
+      listeners.forEach((listener) => {
+        try {
+          listener();
+        } catch (error) {
+          console.error(`[${spec.kind} document] Error in change listener:`, error);
+        }
+      });
+    });
+  };
+  connect();
+  const unwrap = (input) => {
+    if (!isEditorDocumentFile(input)) return { document: input, report: createLoadReport({ version: formatVersion }) };
+    if (input.kind !== spec.kind) throw new EditorDocumentLoadError(`This is a ${input.kind} document; it cannot be opened in the ${spec.kind} editor.`);
+    const steps = Object.fromEntries(
+      Object.entries(spec.migrations ?? {}).map(([v, step]) => [v, (w) => ({ ...w, document: step(w.document) })])
+    );
+    const { doc, report } = migrateDocument(
+      { formatVersion: input.formatVersion, document: input.document },
+      { currentVersion: formatVersion, versionKey: "formatVersion", steps }
+    );
+    if (report.readOnly) throw new EditorDocumentLoadError(`Cannot open the ${spec.kind} document: ${report.readOnly.message}.`, report);
+    return { document: doc.document, report };
+  };
+  return {
+    kind: spec.kind,
+    formatVersion,
+    recordsLoads: spec.recordsLoads !== false,
+    getDocument: () => spec.assets ? externalizeAssets(spec.get(), spec.assets) : spec.get(),
+    loadDocument(input, options = {}) {
+      const { document, report } = unwrap(input);
+      if (document === void 0 || document === null) throw new EditorDocumentLoadError(`No ${spec.kind} document was given.`);
+      try {
+        const result = spec.load(spec.assets ? internalizeAssets(document, spec.assets) : document, { history: options.history ?? "reset" });
+        if (result?.problems?.length) report.problems.push(...result.problems);
+      } catch (error) {
+        if (error instanceof EditorDocumentLoadError) throw error;
+        throw new EditorDocumentLoadError(error instanceof Error ? error.message : String(error));
+      }
+      return report;
+    },
+    revision: () => {
+      connect();
+      return revision;
+    },
+    subscribe(listener) {
+      connect();
+      listeners.add(listener);
+      return () => {
+        listeners.delete(listener);
+      };
+    },
+    history: spec.history,
+    ...spec.assets ? { assets: spec.assets } : {},
+    readOnly: () => spec.readOnly?.() ?? false,
+    destroy() {
+      unsubscribe?.();
+      unsubscribe = null;
+    }
+  };
+}
+
+export {
+  EDITOR_ASSET_PREFIX,
+  isInlineAsset,
+  createEditorAssetRegistry,
+  externalizeAssets,
+  collectAssetRefs,
+  internalizeAssets,
+  persistEditorAssets,
+  preloadEditorAssets,
+  withEditorAssets,
+  hasLoadProblems,
+  createLoadReport,
+  migrateDocument,
+  loadSections,
+  loadDocument,
+  EditorDocumentLoadError,
+  EDITOR_DOCUMENT_FORMAT,
+  isEditorDocumentFile,
+  toEditorDocumentFile,
+  serializeEditorDocument,
+  parseEditorDocument,
+  defineEditorDocument
+};

package/dist/{chunk-XFDQEAOS.cjs → chunk-RQCMSEM5.cjs}

@@ -44,7 +44,7 @@ var _chunk55AKPTLMcjs = require('./chunk-55AKPTLM.cjs');
 var _chunkN3KJFGXTcjs = require('./chunk-N3KJFGXT.cjs');
 
 
-var _chunk5H2C3QSFcjs = require('./chunk-5H2C3QSF.cjs');
+var _chunkM4MIZPQIcjs = require('./chunk-M4MIZPQI.cjs');
 
 // src/spreadsheet/formula/dependency-graph.ts
 function extractNameDependencies(node) {
@@ -6440,7 +6440,7 @@ function checkWorkbook(document) {
   if (document.names !== void 0 && !Array.isArray(document.names)) throw new Error(`names must be an array. ${hint}`);
 }
 function createSpreadsheetEditorDocument(controller) {
-  return _chunk5H2C3QSFcjs.defineEditorDocument.call(void 0, {
+  return _chunkM4MIZPQIcjs.defineEditorDocument.call(void 0, {
     kind: "spreadsheet",
     get: () => controller.getWorkbook(),
     load: (document, { history }) => {

package/dist/{chunk-BCY22GBH.js → chunk-SDHZG5TF.js}

@@ -1,6 +1,6 @@
 import {
   defineEditorDocument
-} from "./chunk-GNV54DLO.js";
+} from "./chunk-NHLYK3AX.js";
 import {
   hexToRgba,
   normalizeTokenColor

package/dist/{chunk-HVX35M2I.cjs → chunk-WI7QJA7A.cjs}

@@ -1,6 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; } var _class;
 
-var _chunk5H2C3QSFcjs = require('./chunk-5H2C3QSF.cjs');
+var _chunkM4MIZPQIcjs = require('./chunk-M4MIZPQI.cjs');
 
 
 
@@ -1275,7 +1275,7 @@ function importW3CTokens(state, input, options = {}) {
 
 // src/tokens/editorDocument.ts
 function createTokensEditorDocument(store) {
-  return _chunk5H2C3QSFcjs.defineEditorDocument.call(void 0, {
+  return _chunkM4MIZPQIcjs.defineEditorDocument.call(void 0, {
     kind: "tokens",
     get: () => store.toJSON(),
     load: (document, { history }) => {

package/dist/{chunk-4J4MC3F5.js → chunk-YXOW456B.js}

@@ -44,7 +44,7 @@ import {
 } from "./chunk-WJSD3MAZ.js";
 import {
   defineEditorDocument
-} from "./chunk-GNV54DLO.js";
+} from "./chunk-NHLYK3AX.js";
 
 // src/spreadsheet/formula/dependency-graph.ts
 function extractNameDependencies(node) {

package/dist/diagram/index.cjs

@@ -126,8 +126,7 @@ var _chunkZVNAMTFOcjs = require('../chunk-ZVNAMTFO.cjs');
 var _chunkSWTUM32Hcjs = require('../chunk-SWTUM32H.cjs');
 
 
-var _chunk5H2C3QSFcjs = require('../chunk-5H2C3QSF.cjs');
-require('../chunk-L5OWG2NA.cjs');
+var _chunkM4MIZPQIcjs = require('../chunk-M4MIZPQI.cjs');
 require('../chunk-2BSBFBOA.cjs');
 
 
@@ -138,7 +137,7 @@ var DIRECTIONS = ["TB", "TD", "BT", "LR", "RL"];
 
 // src/diagram/editorDocument.ts
 function createDiagramEditorDocument(controller) {
-  return _chunk5H2C3QSFcjs.defineEditorDocument.call(void 0, {
+  return _chunkM4MIZPQIcjs.defineEditorDocument.call(void 0, {
     kind: "diagram",
     get: () => ({ source: controller.getSource() }),
     load: (document, { history }) => {

package/dist/diagram/index.js

@@ -126,8 +126,7 @@ import {
 } from "../chunk-O2ANJFUF.js";
 import {
   defineEditorDocument
-} from "../chunk-GNV54DLO.js";
-import "../chunk-WHKNYFM2.js";
+} from "../chunk-NHLYK3AX.js";
 import "../chunk-HF5QZS7Z.js";
 import {
   HistoryManager

package/dist/image-editor/controller.d.cts

@@ -646,6 +646,14 @@ export declare class ImageEditorController {
     get historyBytes(): number;
     private trimHistoryBytes;
     get canUndo(): boolean;
+    private docRevision;
+    /**
+     * Bumped on every change to the document (an undoable edit, a stroke, undo, redo), not on view
+     * or tool changes, nor on `loadImage` (the source image is the host's, not part of the document). `createImageEditorDocument` uses it to tell document changes apart.
+     */
+    get documentRevision(): number;
+    /** Drops the undo and redo steps (e.g. after opening a document). */
+    clearHistory(): void;
     get canRedo(): boolean;
     undo(): boolean;
     redo(): boolean;

package/dist/image-editor/controller.d.ts

@@ -646,6 +646,14 @@ export declare class ImageEditorController {
     get historyBytes(): number;
     private trimHistoryBytes;
     get canUndo(): boolean;
+    private docRevision;
+    /**
+     * Bumped on every change to the document (an undoable edit, a stroke, undo, redo), not on view
+     * or tool changes, nor on `loadImage` (the source image is the host's, not part of the document). `createImageEditorDocument` uses it to tell document changes apart.
+     */
+    get documentRevision(): number;
+    /** Drops the undo and redo steps (e.g. after opening a document). */
+    clearHistory(): void;
     get canRedo(): boolean;
     undo(): boolean;
     redo(): boolean;

package/dist/image-editor/editorDocument.d.cts

@@ -0,0 +1,16 @@
+import { type EditorAssetRegistry } from '../persistence/assets.cjs';
+import { type EditorDocument } from '../persistence/editorDocument.cjs';
+import type { ImageEditorController } from './controller.cjs';
+import type { SerializedImageEditorState } from './types.cjs';
+export interface ImageEditorDocumentOptions {
+    /** Where layer pixels are kept (default: a registry of its own). Share one between editors to share assets. */
+    assets?: EditorAssetRegistry;
+}
+/**
+ * The save / load / undo contract for an `ImageEditorController` (kind `image`, document: the
+ * saved state from `toJSON()`, with layer pixels, masks and other images as asset references kept
+ * in `assets`). The source image (`sourceUrl`) stays the host's, as in `toJSON()`. Agent loads are
+ * one undo step; opening (`history: "reset"`) clears the history. A document from a newer build is
+ * refused rather than opened read-only.
+ */
+export declare function createImageEditorDocument(controller: ImageEditorController, options?: ImageEditorDocumentOptions): EditorDocument<SerializedImageEditorState>;

package/dist/image-editor/editorDocument.d.ts

@@ -0,0 +1,16 @@
+import { type EditorAssetRegistry } from '../persistence/assets.js';
+import { type EditorDocument } from '../persistence/editorDocument.js';
+import type { ImageEditorController } from './controller.js';
+import type { SerializedImageEditorState } from './types.js';
+export interface ImageEditorDocumentOptions {
+    /** Where layer pixels are kept (default: a registry of its own). Share one between editors to share assets. */
+    assets?: EditorAssetRegistry;
+}
+/**
+ * The save / load / undo contract for an `ImageEditorController` (kind `image`, document: the
+ * saved state from `toJSON()`, with layer pixels, masks and other images as asset references kept
+ * in `assets`). The source image (`sourceUrl`) stays the host's, as in `toJSON()`. Agent loads are
+ * one undo step; opening (`history: "reset"`) clears the history. A document from a newer build is
+ * refused rather than opened read-only.
+ */
+export declare function createImageEditorDocument(controller: ImageEditorController, options?: ImageEditorDocumentOptions): EditorDocument<SerializedImageEditorState>;