@pixerate/editor 0.144.0 → 0.146.0

package/dist/chunk-HRLT5BYO.js

@@ -0,0 +1,133 @@
+import {
+  createLoadReport,
+  migrateDocument
+} from "./chunk-WHKNYFM2.js";
+import {
+  stripPrototypeKeys
+} from "./chunk-HF5QZS7Z.js";
+
+// 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.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 {
+        spec.load(document, { history: options.history ?? "reset" });
+      } 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,
+    readOnly: () => spec.readOnly?.() ?? false,
+    destroy() {
+      unsubscribe?.();
+      unsubscribe = null;
+    }
+  };
+}
+
+export {
+  EditorDocumentLoadError,
+  EDITOR_DOCUMENT_FORMAT,
+  isEditorDocumentFile,
+  toEditorDocumentFile,
+  serializeEditorDocument,
+  parseEditorDocument,
+  defineEditorDocument
+};

package/dist/chunk-KC7HB5GF.cjs

@@ -0,0 +1,133 @@
+"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 _chunkL5OWG2NAcjs = require('./chunk-L5OWG2NA.cjs');
+
+
+var _chunk2BSBFBOAcjs = require('./chunk-2BSBFBOA.cjs');
+
+// src/persistence/editorDocument.ts
+var EditorDocumentLoadError = class extends Error {
+  /** The `LoadReport` when the input was a file that could not be migrated. */
+  
+  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 = _chunk2BSBFBOAcjs.stripPrototypeKeys.call(void 0, 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 = _nullishCoalesce(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: _chunkL5OWG2NAcjs.createLoadReport.call(void 0, { 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(_nullishCoalesce(spec.migrations, () => ( {}))).map(([v, step]) => [v, (w) => ({ ...w, document: step(w.document) })])
+    );
+    const { doc, report } = _chunkL5OWG2NAcjs.migrateDocument.call(void 0, 
+      { 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.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 {
+        spec.load(document, { history: _nullishCoalesce(options.history, () => ( "reset")) });
+      } 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,
+    readOnly: () => _nullishCoalesce(_optionalChain([spec, 'access', _ => _.readOnly, 'optionalCall', _2 => _2()]), () => ( false)),
+    destroy() {
+      _optionalChain([unsubscribe, 'optionalCall', _3 => _3()]);
+      unsubscribe = null;
+    }
+  };
+}
+
+
+
+
+
+
+
+
+
+exports.EditorDocumentLoadError = EditorDocumentLoadError; exports.EDITOR_DOCUMENT_FORMAT = EDITOR_DOCUMENT_FORMAT; exports.isEditorDocumentFile = isEditorDocumentFile; exports.toEditorDocumentFile = toEditorDocumentFile; exports.serializeEditorDocument = serializeEditorDocument; exports.parseEditorDocument = parseEditorDocument; exports.defineEditorDocument = defineEditorDocument;

package/dist/{chunk-I4T4J27S.js → chunk-QX25HWFL.js}

@@ -201,6 +201,15 @@ var AnimationPlayer = class {
   get currentTime() {
     return this.time;
   }
+  /**
+   * The playhead at this moment of the clock, between frames too (`currentTime` is the last
+   * frame's): what input arriving between frames, like a recorded pointer move, happened at.
+   */
+  get liveTime() {
+    if (!this.playing) return this.time;
+    const d = this.duration;
+    return this.loop === "none" || d <= 0 ? this.clamp(this.rawNow()) : wrapAnimationTime(this.rawNow(), d, this.loop);
+  }
   get isPlaying() {
     return this.playing;
   }

package/dist/{chunk-SVR5FR7B.cjs → chunk-UUTTJK77.cjs}

@@ -201,6 +201,15 @@ var AnimationPlayer = (_class2 = class {
   get currentTime() {
     return this.time;
   }
+  /**
+   * The playhead at this moment of the clock, between frames too (`currentTime` is the last
+   * frame's): what input arriving between frames, like a recorded pointer move, happened at.
+   */
+  get liveTime() {
+    if (!this.playing) return this.time;
+    const d = this.duration;
+    return this.loop === "none" || d <= 0 ? this.clamp(this.rawNow()) : wrapAnimationTime(this.rawNow(), d, this.loop);
+  }
   get isPlaying() {
     return this.playing;
   }

package/dist/diagram/editorDocument.d.cts

@@ -0,0 +1,12 @@
+import { type EditorDocument } from '../persistence/editorDocument.cjs';
+import type { DiagramController } from './controller.cjs';
+/** A diagram as it is saved: its Mermaid source (layout rides in the `%% @pixerate` comment). */
+export interface DiagramEditorDocument {
+    source: string;
+}
+/**
+ * The save / load / undo contract for a `DiagramController` (kind `diagram`), for
+ * `createEditorAutosave`, `createDocumentToolProvider` and the React / Svelte wrappers.
+ * Recorded loads are one undo step; read-only controllers refuse them.
+ */
+export declare function createDiagramEditorDocument(controller: DiagramController): EditorDocument<DiagramEditorDocument>;

package/dist/diagram/editorDocument.d.ts

@@ -0,0 +1,12 @@
+import { type EditorDocument } from '../persistence/editorDocument.js';
+import type { DiagramController } from './controller.js';
+/** A diagram as it is saved: its Mermaid source (layout rides in the `%% @pixerate` comment). */
+export interface DiagramEditorDocument {
+    source: string;
+}
+/**
+ * The save / load / undo contract for a `DiagramController` (kind `diagram`), for
+ * `createEditorAutosave`, `createDocumentToolProvider` and the React / Svelte wrappers.
+ * Recorded loads are one undo step; read-only controllers refuse them.
+ */
+export declare function createDiagramEditorDocument(controller: DiagramController): EditorDocument<DiagramEditorDocument>;

package/dist/diagram/index.cjs

@@ -1,5 +1,8 @@
 "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 _chunkKC7HB5GFcjs = require('../chunk-KC7HB5GF.cjs');
+
+
 
 
 
@@ -116,6 +119,8 @@
 
 
 var _chunkZVNAMTFOcjs = require('../chunk-ZVNAMTFO.cjs');
+require('../chunk-L5OWG2NA.cjs');
+require('../chunk-2BSBFBOA.cjs');
 
 
 
@@ -131,6 +136,34 @@ var _chunkFJ2MSI43cjs = require('../chunk-FJ2MSI43.cjs');
 // src/diagram/types.ts
 var DIRECTIONS = ["TB", "TD", "BT", "LR", "RL"];
 
+// src/diagram/editorDocument.ts
+function createDiagramEditorDocument(controller) {
+  return _chunkKC7HB5GFcjs.defineEditorDocument.call(void 0, {
+    kind: "diagram",
+    get: () => ({ source: controller.getSource() }),
+    load: (document, { history }) => {
+      const source = document.source;
+      if (typeof source !== "string") throw new Error("A diagram document is { source: string } (Mermaid text).");
+      const result = controller.load(source, { clearHistory: history === "reset" });
+      if (!result.ok) throw new Error(result.message);
+    },
+    subscribe: (listener) => {
+      let source = controller.getSource();
+      return controller.subscribe((state) => {
+        if (state.source === source) return;
+        source = state.source;
+        listener();
+      });
+    },
+    history: {
+      undo: () => controller.undo(),
+      redo: () => controller.redo(),
+      getState: () => controller.history.getState()
+    },
+    readOnly: () => controller.getState().readOnly ? "The diagram is read-only." : false
+  });
+}
+
 // src/diagram/source/find.ts
 var MERMAID_INFO = /^(mermaid|mmd)\b/i;
 function findMermaidSources(text) {
@@ -2576,4 +2609,5 @@ function planDiagramEdits(source, place, ops, speed = 1) {
 
 
 
-exports.ARCH_METRICS = _chunkZVNAMTFOcjs.ARCH_METRICS; exports.C4_METRICS = _chunkZVNAMTFOcjs.C4_METRICS; exports.CLASS_RELATIONS = _chunkZVNAMTFOcjs.CLASS_RELATIONS; exports.DIRECTIONS = DIRECTIONS; exports.DiagramController = DiagramController; exports.DiagramDirector = DiagramDirector; exports.EDITABLE_DIAGRAM_FAMILIES = EDITABLE_DIAGRAM_FAMILIES; exports.ER_CARDINALITIES = _chunkZVNAMTFOcjs.ER_CARDINALITIES; exports.ER_PATTERNS = _chunkZVNAMTFOcjs.ER_PATTERNS; exports.FAMILY_BLANKS = FAMILY_BLANKS; exports.FAMILY_DESCRIPTIONS = FAMILY_DESCRIPTIONS; exports.FAMILY_TEMPLATES = FAMILY_TEMPLATES; exports.FAMILY_TITLES = FAMILY_TITLES; exports.FLOWCHART_SHAPES = _chunkZVNAMTFOcjs.FLOWCHART_SHAPES; exports.GANTT_CONFIG_KEYS = _chunkZVNAMTFOcjs.GANTT_CONFIG_KEYS; exports.GANTT_METRICS = _chunkZVNAMTFOcjs.GANTT_METRICS; exports.GANTT_TAGS = _chunkZVNAMTFOcjs.GANTT_TAGS; exports.META_COMMENT_PREFIX = _chunkZVNAMTFOcjs.META_COMMENT_PREFIX; exports.META_FRONTMATTER_KEY = _chunkZVNAMTFOcjs.META_FRONTMATTER_KEY; exports.POINT_BOX = _chunkZVNAMTFOcjs.POINT_BOX; exports.PRESENCE_COLORS = _chunkUJGAA6AKcjs.PRESENCE_COLORS; exports.PerformanceQueue = _chunkUJGAA6AKcjs.PerformanceQueue; exports.PresenceStore = _chunkUJGAA6AKcjs.PresenceStore; exports.QUADRANT_METRICS = _chunkZVNAMTFOcjs.QUADRANT_METRICS; exports.RADAR_CHART_BOX = _chunkZVNAMTFOcjs.RADAR_CHART_BOX; exports.SEQUENCE_METRICS = _chunkZVNAMTFOcjs.SEQUENCE_METRICS; exports.STATE_SHAPES = _chunkZVNAMTFOcjs.STATE_SHAPES; exports.XY_CHART_BOX = _chunkZVNAMTFOcjs.XY_CHART_BOX; exports.afterIds = _chunkZVNAMTFOcjs.afterIds; exports.applyEdit = _chunkZVNAMTFOcjs.applyEdit; exports.applyEdits = _chunkZVNAMTFOcjs.applyEdits; exports.applyStatementEdit = _chunkZVNAMTFOcjs.applyStatementEdit; exports.architectureAdapter = _chunkZVNAMTFOcjs.architectureAdapter; exports.architectureArrow = _chunkZVNAMTFOcjs.architectureArrow; exports.architectureEdgeRoute = _chunkZVNAMTFOcjs.architectureEdgeRoute; exports.architectureGrammar = _chunkZVNAMTFOcjs.architectureGrammar; exports.architectureLayout = _chunkZVNAMTFOcjs.architectureLayout; exports.architectureUI = architectureUI; exports.c4Adapter = _chunkZVNAMTFOcjs.c4Adapter; exports.c4ArrowHead = _chunkZVNAMTFOcjs.c4ArrowHead; exports.c4BoundaryText = _chunkZVNAMTFOcjs.c4BoundaryText; exports.c4ElementGeometry = _chunkZVNAMTFOcjs.c4ElementGeometry; exports.c4ElementType = _chunkZVNAMTFOcjs.c4ElementType; exports.c4Grammar = _chunkZVNAMTFOcjs.c4Grammar; exports.c4Layout = _chunkZVNAMTFOcjs.c4Layout; exports.c4RelGeometry = _chunkZVNAMTFOcjs.c4RelGeometry; exports.c4Stereotype = _chunkZVNAMTFOcjs.c4Stereotype; exports.c4UI = c4UI; exports.canonicalShape = _chunkZVNAMTFOcjs.canonicalShape; exports.changedItems = changedItems; exports.checkFieldData = checkFieldData; exports.classGrammar = _chunkZVNAMTFOcjs.classGrammar; exports.classUI = classUI; exports.createDiagramToolProvider = createDiagramToolProvider; exports.createInstantPresenceClock = _chunkUJGAA6AKcjs.createInstantPresenceClock; exports.createLineAdapter = _chunkZVNAMTFOcjs.createLineAdapter; exports.createPassthroughAdapter = _chunkZVNAMTFOcjs.createPassthroughAdapter; exports.createStatementAdapter = _chunkZVNAMTFOcjs.createStatementAdapter; exports.describeDiagram = describeDiagram; exports.describeFields = describeFields; exports.detectFamily = _chunkZVNAMTFOcjs.detectFamily; exports.detectFamilyFromHeader = _chunkZVNAMTFOcjs.detectFamilyFromHeader; exports.diagramShapes = diagramShapes; exports.diagramSupportsDirection = diagramSupportsDirection; exports.diagramSupportsGroups = diagramSupportsGroups; exports.draftFrames = draftFrames; exports.dropMetaKeys = _chunkZVNAMTFOcjs.dropMetaKeys; exports.emptyMeta = _chunkZVNAMTFOcjs.emptyMeta; exports.erGrammar = _chunkZVNAMTFOcjs.erGrammar; exports.erUI = erUI; exports.familyUI = familyUI; exports.filterInPlace = _chunkZVNAMTFOcjs.filterInPlace; exports.findMermaidSources = findMermaidSources; exports.flowchartAdapter = _chunkZVNAMTFOcjs.flowchartAdapter; exports.flowchartUI = flowchartUI; exports.formatAxis = _chunkZVNAMTFOcjs.formatAxis; exports.formatChain = _chunkZVNAMTFOcjs.formatChain; exports.formatGanttDate = _chunkZVNAMTFOcjs.formatGanttDate; exports.formatLink = _chunkZVNAMTFOcjs.formatLink; exports.formatNode = _chunkZVNAMTFOcjs.formatNode; exports.ganttAdapter = _chunkZVNAMTFOcjs.ganttAdapter; exports.ganttGeometry = _chunkZVNAMTFOcjs.ganttGeometry; exports.ganttGrammar = _chunkZVNAMTFOcjs.ganttGrammar; exports.ganttUI = ganttUI; exports.getDiagramAdapter = _chunkZVNAMTFOcjs.getDiagramAdapter; exports.getFamilyLayout = _chunkZVNAMTFOcjs.getFamilyLayout; exports.gitGraphAdapter = _chunkZVNAMTFOcjs.gitGraphAdapter; exports.gitGraphGrammar = _chunkZVNAMTFOcjs.gitGraphGrammar; exports.gitGraphUI = gitGraphUI; exports.indentOf = _chunkZVNAMTFOcjs.indentOf; exports.isMetaEmpty = _chunkZVNAMTFOcjs.isMetaEmpty; exports.journeyAdapter = _chunkZVNAMTFOcjs.journeyAdapter; exports.journeyGrammar = _chunkZVNAMTFOcjs.journeyGrammar; exports.journeyLayout = _chunkZVNAMTFOcjs.journeyLayout; exports.journeyUI = journeyUI; exports.mergeMeta = _chunkZVNAMTFOcjs.mergeMeta; exports.mindmapAdapter = _chunkZVNAMTFOcjs.mindmapAdapter; exports.mindmapGrammar = _chunkZVNAMTFOcjs.mindmapGrammar; exports.mindmapUI = mindmapUI; exports.parseAttributes = _chunkZVNAMTFOcjs.parseAttributes; exports.parseChain = _chunkZVNAMTFOcjs.parseChain; exports.parseFlowchartSource = _chunkZVNAMTFOcjs.parseFlowchartSource; exports.parseGanttDate = _chunkZVNAMTFOcjs.parseGanttDate; exports.parseLink = _chunkZVNAMTFOcjs.parseLink; exports.parseMembers = _chunkZVNAMTFOcjs.parseMembers; exports.parseMermaid = _chunkZVNAMTFOcjs.parseMermaid; exports.parseSankey = parseSankey; exports.parseStatement = _chunkZVNAMTFOcjs.parseStatement; exports.parseStatementDocument = _chunkZVNAMTFOcjs.parseStatementDocument; exports.parseTreemap = parseTreemap; exports.pickFieldData = pickFieldData; exports.pieAdapter = _chunkZVNAMTFOcjs.pieAdapter; exports.pieGrammar = _chunkZVNAMTFOcjs.pieGrammar; exports.pieUI = pieUI; exports.planDiagramEdit = planDiagramEdit; exports.planDiagramEdits = planDiagramEdits; exports.pointCentre = _chunkZVNAMTFOcjs.pointCentre; exports.pointPosition = _chunkZVNAMTFOcjs.pointPosition; exports.positionToData = _chunkZVNAMTFOcjs.positionToData; exports.quadrantAdapter = _chunkZVNAMTFOcjs.quadrantAdapter; exports.quadrantGeometry = _chunkZVNAMTFOcjs.quadrantGeometry; exports.quadrantGrammar = _chunkZVNAMTFOcjs.quadrantGrammar; exports.quadrantSpace = _chunkZVNAMTFOcjs.quadrantSpace; exports.quadrantUI = quadrantUI; exports.quote = _chunkZVNAMTFOcjs.quote; exports.quoteLabelIfNeeded = _chunkZVNAMTFOcjs.quoteLabelIfNeeded; exports.radarAdapter = _chunkZVNAMTFOcjs.radarAdapter; exports.radarGrammar = _chunkZVNAMTFOcjs.radarGrammar; exports.radarUI = radarUI; exports.realPresenceClock = _chunkUJGAA6AKcjs.realPresenceClock; exports.registerDiagramAdapter = _chunkZVNAMTFOcjs.registerDiagramAdapter; exports.registerFamilyLayout = _chunkZVNAMTFOcjs.registerFamilyLayout; exports.relationFor = _chunkZVNAMTFOcjs.relationFor; exports.renameMetaKey = _chunkZVNAMTFOcjs.renameMetaKey; exports.resolveShape = _chunkZVNAMTFOcjs.resolveShape; exports.sequenceAdapter = _chunkZVNAMTFOcjs.sequenceAdapter; exports.sequenceGeometry = _chunkZVNAMTFOcjs.sequenceGeometry; exports.sequenceGrammar = _chunkZVNAMTFOcjs.sequenceGrammar; exports.sequenceUI = sequenceUI; exports.serializeMermaid = _chunkZVNAMTFOcjs.serializeMermaid; exports.serializeMeta = _chunkZVNAMTFOcjs.serializeMeta; exports.serializeStatementDocument = _chunkZVNAMTFOcjs.serializeStatementDocument; exports.serviceLabelLines = _chunkZVNAMTFOcjs.serviceLabelLines; exports.sharedFrameLayout = _chunkZVNAMTFOcjs.sharedFrameLayout; exports.slugId = _chunkZVNAMTFOcjs.slugId; exports.spaceInput = _chunkZVNAMTFOcjs.spaceInput; exports.splitOutsideQuotes = _chunkZVNAMTFOcjs.splitOutsideQuotes; exports.splitSource = _chunkZVNAMTFOcjs.splitSource; exports.splitStatements = _chunkZVNAMTFOcjs.splitStatements; exports.stateGrammar = _chunkZVNAMTFOcjs.stateGrammar; exports.stateUI = stateUI; exports.supportTierOf = _chunkZVNAMTFOcjs.supportTierOf; exports.timelineAdapter = _chunkZVNAMTFOcjs.timelineAdapter; exports.timelineGrammar = _chunkZVNAMTFOcjs.timelineGrammar; exports.timelineLayout = _chunkZVNAMTFOcjs.timelineLayout; exports.timelineUI = timelineUI; exports.treemapValue = treemapValue; exports.uniqueId = _chunkZVNAMTFOcjs.uniqueId; exports.unquote = _chunkZVNAMTFOcjs.unquote; exports.validateDiagramEdit = validateDiagramEdit; exports.xyChartAdapter = _chunkZVNAMTFOcjs.xyChartAdapter; exports.xyChartGrammar = _chunkZVNAMTFOcjs.xyChartGrammar; exports.xyChartUI = xyChartUI;
+
+exports.ARCH_METRICS = _chunkZVNAMTFOcjs.ARCH_METRICS; exports.C4_METRICS = _chunkZVNAMTFOcjs.C4_METRICS; exports.CLASS_RELATIONS = _chunkZVNAMTFOcjs.CLASS_RELATIONS; exports.DIRECTIONS = DIRECTIONS; exports.DiagramController = DiagramController; exports.DiagramDirector = DiagramDirector; exports.EDITABLE_DIAGRAM_FAMILIES = EDITABLE_DIAGRAM_FAMILIES; exports.ER_CARDINALITIES = _chunkZVNAMTFOcjs.ER_CARDINALITIES; exports.ER_PATTERNS = _chunkZVNAMTFOcjs.ER_PATTERNS; exports.FAMILY_BLANKS = FAMILY_BLANKS; exports.FAMILY_DESCRIPTIONS = FAMILY_DESCRIPTIONS; exports.FAMILY_TEMPLATES = FAMILY_TEMPLATES; exports.FAMILY_TITLES = FAMILY_TITLES; exports.FLOWCHART_SHAPES = _chunkZVNAMTFOcjs.FLOWCHART_SHAPES; exports.GANTT_CONFIG_KEYS = _chunkZVNAMTFOcjs.GANTT_CONFIG_KEYS; exports.GANTT_METRICS = _chunkZVNAMTFOcjs.GANTT_METRICS; exports.GANTT_TAGS = _chunkZVNAMTFOcjs.GANTT_TAGS; exports.META_COMMENT_PREFIX = _chunkZVNAMTFOcjs.META_COMMENT_PREFIX; exports.META_FRONTMATTER_KEY = _chunkZVNAMTFOcjs.META_FRONTMATTER_KEY; exports.POINT_BOX = _chunkZVNAMTFOcjs.POINT_BOX; exports.PRESENCE_COLORS = _chunkUJGAA6AKcjs.PRESENCE_COLORS; exports.PerformanceQueue = _chunkUJGAA6AKcjs.PerformanceQueue; exports.PresenceStore = _chunkUJGAA6AKcjs.PresenceStore; exports.QUADRANT_METRICS = _chunkZVNAMTFOcjs.QUADRANT_METRICS; exports.RADAR_CHART_BOX = _chunkZVNAMTFOcjs.RADAR_CHART_BOX; exports.SEQUENCE_METRICS = _chunkZVNAMTFOcjs.SEQUENCE_METRICS; exports.STATE_SHAPES = _chunkZVNAMTFOcjs.STATE_SHAPES; exports.XY_CHART_BOX = _chunkZVNAMTFOcjs.XY_CHART_BOX; exports.afterIds = _chunkZVNAMTFOcjs.afterIds; exports.applyEdit = _chunkZVNAMTFOcjs.applyEdit; exports.applyEdits = _chunkZVNAMTFOcjs.applyEdits; exports.applyStatementEdit = _chunkZVNAMTFOcjs.applyStatementEdit; exports.architectureAdapter = _chunkZVNAMTFOcjs.architectureAdapter; exports.architectureArrow = _chunkZVNAMTFOcjs.architectureArrow; exports.architectureEdgeRoute = _chunkZVNAMTFOcjs.architectureEdgeRoute; exports.architectureGrammar = _chunkZVNAMTFOcjs.architectureGrammar; exports.architectureLayout = _chunkZVNAMTFOcjs.architectureLayout; exports.architectureUI = architectureUI; exports.c4Adapter = _chunkZVNAMTFOcjs.c4Adapter; exports.c4ArrowHead = _chunkZVNAMTFOcjs.c4ArrowHead; exports.c4BoundaryText = _chunkZVNAMTFOcjs.c4BoundaryText; exports.c4ElementGeometry = _chunkZVNAMTFOcjs.c4ElementGeometry; exports.c4ElementType = _chunkZVNAMTFOcjs.c4ElementType; exports.c4Grammar = _chunkZVNAMTFOcjs.c4Grammar; exports.c4Layout = _chunkZVNAMTFOcjs.c4Layout; exports.c4RelGeometry = _chunkZVNAMTFOcjs.c4RelGeometry; exports.c4Stereotype = _chunkZVNAMTFOcjs.c4Stereotype; exports.c4UI = c4UI; exports.canonicalShape = _chunkZVNAMTFOcjs.canonicalShape; exports.changedItems = changedItems; exports.checkFieldData = checkFieldData; exports.classGrammar = _chunkZVNAMTFOcjs.classGrammar; exports.classUI = classUI; exports.createDiagramEditorDocument = createDiagramEditorDocument; exports.createDiagramToolProvider = createDiagramToolProvider; exports.createInstantPresenceClock = _chunkUJGAA6AKcjs.createInstantPresenceClock; exports.createLineAdapter = _chunkZVNAMTFOcjs.createLineAdapter; exports.createPassthroughAdapter = _chunkZVNAMTFOcjs.createPassthroughAdapter; exports.createStatementAdapter = _chunkZVNAMTFOcjs.createStatementAdapter; exports.describeDiagram = describeDiagram; exports.describeFields = describeFields; exports.detectFamily = _chunkZVNAMTFOcjs.detectFamily; exports.detectFamilyFromHeader = _chunkZVNAMTFOcjs.detectFamilyFromHeader; exports.diagramShapes = diagramShapes; exports.diagramSupportsDirection = diagramSupportsDirection; exports.diagramSupportsGroups = diagramSupportsGroups; exports.draftFrames = draftFrames; exports.dropMetaKeys = _chunkZVNAMTFOcjs.dropMetaKeys; exports.emptyMeta = _chunkZVNAMTFOcjs.emptyMeta; exports.erGrammar = _chunkZVNAMTFOcjs.erGrammar; exports.erUI = erUI; exports.familyUI = familyUI; exports.filterInPlace = _chunkZVNAMTFOcjs.filterInPlace; exports.findMermaidSources = findMermaidSources; exports.flowchartAdapter = _chunkZVNAMTFOcjs.flowchartAdapter; exports.flowchartUI = flowchartUI; exports.formatAxis = _chunkZVNAMTFOcjs.formatAxis; exports.formatChain = _chunkZVNAMTFOcjs.formatChain; exports.formatGanttDate = _chunkZVNAMTFOcjs.formatGanttDate; exports.formatLink = _chunkZVNAMTFOcjs.formatLink; exports.formatNode = _chunkZVNAMTFOcjs.formatNode; exports.ganttAdapter = _chunkZVNAMTFOcjs.ganttAdapter; exports.ganttGeometry = _chunkZVNAMTFOcjs.ganttGeometry; exports.ganttGrammar = _chunkZVNAMTFOcjs.ganttGrammar; exports.ganttUI = ganttUI; exports.getDiagramAdapter = _chunkZVNAMTFOcjs.getDiagramAdapter; exports.getFamilyLayout = _chunkZVNAMTFOcjs.getFamilyLayout; exports.gitGraphAdapter = _chunkZVNAMTFOcjs.gitGraphAdapter; exports.gitGraphGrammar = _chunkZVNAMTFOcjs.gitGraphGrammar; exports.gitGraphUI = gitGraphUI; exports.indentOf = _chunkZVNAMTFOcjs.indentOf; exports.isMetaEmpty = _chunkZVNAMTFOcjs.isMetaEmpty; exports.journeyAdapter = _chunkZVNAMTFOcjs.journeyAdapter; exports.journeyGrammar = _chunkZVNAMTFOcjs.journeyGrammar; exports.journeyLayout = _chunkZVNAMTFOcjs.journeyLayout; exports.journeyUI = journeyUI; exports.mergeMeta = _chunkZVNAMTFOcjs.mergeMeta; exports.mindmapAdapter = _chunkZVNAMTFOcjs.mindmapAdapter; exports.mindmapGrammar = _chunkZVNAMTFOcjs.mindmapGrammar; exports.mindmapUI = mindmapUI; exports.parseAttributes = _chunkZVNAMTFOcjs.parseAttributes; exports.parseChain = _chunkZVNAMTFOcjs.parseChain; exports.parseFlowchartSource = _chunkZVNAMTFOcjs.parseFlowchartSource; exports.parseGanttDate = _chunkZVNAMTFOcjs.parseGanttDate; exports.parseLink = _chunkZVNAMTFOcjs.parseLink; exports.parseMembers = _chunkZVNAMTFOcjs.parseMembers; exports.parseMermaid = _chunkZVNAMTFOcjs.parseMermaid; exports.parseSankey = parseSankey; exports.parseStatement = _chunkZVNAMTFOcjs.parseStatement; exports.parseStatementDocument = _chunkZVNAMTFOcjs.parseStatementDocument; exports.parseTreemap = parseTreemap; exports.pickFieldData = pickFieldData; exports.pieAdapter = _chunkZVNAMTFOcjs.pieAdapter; exports.pieGrammar = _chunkZVNAMTFOcjs.pieGrammar; exports.pieUI = pieUI; exports.planDiagramEdit = planDiagramEdit; exports.planDiagramEdits = planDiagramEdits; exports.pointCentre = _chunkZVNAMTFOcjs.pointCentre; exports.pointPosition = _chunkZVNAMTFOcjs.pointPosition; exports.positionToData = _chunkZVNAMTFOcjs.positionToData; exports.quadrantAdapter = _chunkZVNAMTFOcjs.quadrantAdapter; exports.quadrantGeometry = _chunkZVNAMTFOcjs.quadrantGeometry; exports.quadrantGrammar = _chunkZVNAMTFOcjs.quadrantGrammar; exports.quadrantSpace = _chunkZVNAMTFOcjs.quadrantSpace; exports.quadrantUI = quadrantUI; exports.quote = _chunkZVNAMTFOcjs.quote; exports.quoteLabelIfNeeded = _chunkZVNAMTFOcjs.quoteLabelIfNeeded; exports.radarAdapter = _chunkZVNAMTFOcjs.radarAdapter; exports.radarGrammar = _chunkZVNAMTFOcjs.radarGrammar; exports.radarUI = radarUI; exports.realPresenceClock = _chunkUJGAA6AKcjs.realPresenceClock; exports.registerDiagramAdapter = _chunkZVNAMTFOcjs.registerDiagramAdapter; exports.registerFamilyLayout = _chunkZVNAMTFOcjs.registerFamilyLayout; exports.relationFor = _chunkZVNAMTFOcjs.relationFor; exports.renameMetaKey = _chunkZVNAMTFOcjs.renameMetaKey; exports.resolveShape = _chunkZVNAMTFOcjs.resolveShape; exports.sequenceAdapter = _chunkZVNAMTFOcjs.sequenceAdapter; exports.sequenceGeometry = _chunkZVNAMTFOcjs.sequenceGeometry; exports.sequenceGrammar = _chunkZVNAMTFOcjs.sequenceGrammar; exports.sequenceUI = sequenceUI; exports.serializeMermaid = _chunkZVNAMTFOcjs.serializeMermaid; exports.serializeMeta = _chunkZVNAMTFOcjs.serializeMeta; exports.serializeStatementDocument = _chunkZVNAMTFOcjs.serializeStatementDocument; exports.serviceLabelLines = _chunkZVNAMTFOcjs.serviceLabelLines; exports.sharedFrameLayout = _chunkZVNAMTFOcjs.sharedFrameLayout; exports.slugId = _chunkZVNAMTFOcjs.slugId; exports.spaceInput = _chunkZVNAMTFOcjs.spaceInput; exports.splitOutsideQuotes = _chunkZVNAMTFOcjs.splitOutsideQuotes; exports.splitSource = _chunkZVNAMTFOcjs.splitSource; exports.splitStatements = _chunkZVNAMTFOcjs.splitStatements; exports.stateGrammar = _chunkZVNAMTFOcjs.stateGrammar; exports.stateUI = stateUI; exports.supportTierOf = _chunkZVNAMTFOcjs.supportTierOf; exports.timelineAdapter = _chunkZVNAMTFOcjs.timelineAdapter; exports.timelineGrammar = _chunkZVNAMTFOcjs.timelineGrammar; exports.timelineLayout = _chunkZVNAMTFOcjs.timelineLayout; exports.timelineUI = timelineUI; exports.treemapValue = treemapValue; exports.uniqueId = _chunkZVNAMTFOcjs.uniqueId; exports.unquote = _chunkZVNAMTFOcjs.unquote; exports.validateDiagramEdit = validateDiagramEdit; exports.xyChartAdapter = _chunkZVNAMTFOcjs.xyChartAdapter; exports.xyChartGrammar = _chunkZVNAMTFOcjs.xyChartGrammar; exports.xyChartUI = xyChartUI;

package/dist/diagram/index.d.cts

@@ -11,6 +11,7 @@
  * Ported from Ursula.
  */
 export * from './types.cjs';
+export { createDiagramEditorDocument, type DiagramEditorDocument } from './editorDocument.cjs';
 export { parseMermaid, serializeMermaid, applyEdit, applyEdits, detectFamily, type ParseOptions } from './document.cjs';
 export { registerDiagramAdapter, getDiagramAdapter, supportTierOf } from './registry.cjs';
 export { splitSource, detectFamilyFromHeader, splitStatements, type SplitSource } from './source/lines.cjs';

package/dist/diagram/index.d.ts

@@ -11,6 +11,7 @@
  * Ported from Ursula.
  */
 export * from './types.js';
+export { createDiagramEditorDocument, type DiagramEditorDocument } from './editorDocument.js';
 export { parseMermaid, serializeMermaid, applyEdit, applyEdits, detectFamily, type ParseOptions } from './document.js';
 export { registerDiagramAdapter, getDiagramAdapter, supportTierOf } from './registry.js';
 export { splitSource, detectFamilyFromHeader, splitStatements, type SplitSource } from './source/lines.js';

package/dist/diagram/index.js

@@ -1,3 +1,6 @@
+import {
+  defineEditorDocument
+} from "../chunk-HRLT5BYO.js";
 import {
   ARCH_METRICS,
   C4_METRICS,
@@ -116,6 +119,8 @@ import {
   xyChartAdapter,
   xyChartGrammar
 } from "../chunk-GZ2FM3ZB.js";
+import "../chunk-WHKNYFM2.js";
+import "../chunk-HF5QZS7Z.js";
 import {
   PRESENCE_COLORS,
   PerformanceQueue,
@@ -131,6 +136,34 @@ import {
 // src/diagram/types.ts
 var DIRECTIONS = ["TB", "TD", "BT", "LR", "RL"];
 
+// src/diagram/editorDocument.ts
+function createDiagramEditorDocument(controller) {
+  return defineEditorDocument({
+    kind: "diagram",
+    get: () => ({ source: controller.getSource() }),
+    load: (document, { history }) => {
+      const source = document.source;
+      if (typeof source !== "string") throw new Error("A diagram document is { source: string } (Mermaid text).");
+      const result = controller.load(source, { clearHistory: history === "reset" });
+      if (!result.ok) throw new Error(result.message);
+    },
+    subscribe: (listener) => {
+      let source = controller.getSource();
+      return controller.subscribe((state) => {
+        if (state.source === source) return;
+        source = state.source;
+        listener();
+      });
+    },
+    history: {
+      undo: () => controller.undo(),
+      redo: () => controller.redo(),
+      getState: () => controller.history.getState()
+    },
+    readOnly: () => controller.getState().readOnly ? "The diagram is read-only." : false
+  });
+}
+
 // src/diagram/source/find.ts
 var MERMAID_INFO = /^(mermaid|mmd)\b/i;
 function findMermaidSources(text) {
@@ -2466,6 +2499,7 @@ export {
   checkFieldData,
   classGrammar,
   classUI,
+  createDiagramEditorDocument,
   createDiagramToolProvider,
   createInstantPresenceClock,
   createLineAdapter,

package/dist/persistence/documentStore.d.cts

@@ -0,0 +1,51 @@
+import { type EditorDocument, type EditorDocumentFile } from "./editorDocument.cjs";
+import type { LoadReport } from "./migrate.cjs";
+import type { StorageAdapter } from "./storage.cjs";
+/** One saved document as the index lists it (no document read needed). */
+export interface SavedEditorDocument {
+    /** Storage key of the document, e.g. `"diagram/release-flow"`; pass it to `open`. */
+    key: string;
+    kind: string;
+    name: string;
+    formatVersion: number;
+    /** ISO time of the last save. */
+    savedAt: string;
+}
+export interface EditorDocumentStoreOptions {
+    storage: StorageAdapter;
+    /** Prefix of every key this store writes (default `pixerate.documents`). */
+    namespace?: string;
+    /** Wall clock for `savedAt` (default `Date.now`). */
+    now?: () => number;
+}
+export interface EditorDocumentStore {
+    /**
+     * Saves the current document under `name` (one document per kind and name:
+     * saving the same name again replaces it).
+     */
+    save(doc: EditorDocument, name: string): Promise<SavedEditorDocument>;
+    /** Saved documents, newest first; only one kind's with `kind`. */
+    list(kind?: string): Promise<SavedEditorDocument[]>;
+    /** The saved file, or `null` when nothing is stored under `key`. */
+    read(key: string): Promise<EditorDocumentFile | null>;
+    /**
+     * Loads a saved document into `doc` (see `EditorDocument.loadDocument`) and
+     * returns its entry with the load report. Throws when `key` is unknown.
+     */
+    open(doc: EditorDocument, key: string, options?: {
+        history?: "reset" | "record";
+    }): Promise<SavedEditorDocument & {
+        report: LoadReport;
+    }>;
+    /** Deletes a saved document; `false` when there was none. */
+    remove(key: string): Promise<boolean>;
+}
+/** `"Release flow v2"` → `"release-flow-v2"` (the key part of a saved name). */
+export declare function slugifyDocumentName(name: string): string;
+/**
+ * Named documents on a key/value `StorageAdapter`, for every editor kind:
+ * each file under its own key plus one index entry for listing. Operations
+ * run one at a time, so concurrent saves do not lose index entries. The index
+ * is cached after the first read: use one store per storage namespace.
+ */
+export declare function createEditorDocumentStore(options: EditorDocumentStoreOptions): EditorDocumentStore;

package/dist/persistence/documentStore.d.ts

@@ -0,0 +1,51 @@
+import { type EditorDocument, type EditorDocumentFile } from "./editorDocument.js";
+import type { LoadReport } from "./migrate.js";
+import type { StorageAdapter } from "./storage.js";
+/** One saved document as the index lists it (no document read needed). */
+export interface SavedEditorDocument {
+    /** Storage key of the document, e.g. `"diagram/release-flow"`; pass it to `open`. */
+    key: string;
+    kind: string;
+    name: string;
+    formatVersion: number;
+    /** ISO time of the last save. */
+    savedAt: string;
+}
+export interface EditorDocumentStoreOptions {
+    storage: StorageAdapter;
+    /** Prefix of every key this store writes (default `pixerate.documents`). */
+    namespace?: string;
+    /** Wall clock for `savedAt` (default `Date.now`). */
+    now?: () => number;
+}
+export interface EditorDocumentStore {
+    /**
+     * Saves the current document under `name` (one document per kind and name:
+     * saving the same name again replaces it).
+     */
+    save(doc: EditorDocument, name: string): Promise<SavedEditorDocument>;
+    /** Saved documents, newest first; only one kind's with `kind`. */
+    list(kind?: string): Promise<SavedEditorDocument[]>;
+    /** The saved file, or `null` when nothing is stored under `key`. */
+    read(key: string): Promise<EditorDocumentFile | null>;
+    /**
+     * Loads a saved document into `doc` (see `EditorDocument.loadDocument`) and
+     * returns its entry with the load report. Throws when `key` is unknown.
+     */
+    open(doc: EditorDocument, key: string, options?: {
+        history?: "reset" | "record";
+    }): Promise<SavedEditorDocument & {
+        report: LoadReport;
+    }>;
+    /** Deletes a saved document; `false` when there was none. */
+    remove(key: string): Promise<boolean>;
+}
+/** `"Release flow v2"` → `"release-flow-v2"` (the key part of a saved name). */
+export declare function slugifyDocumentName(name: string): string;
+/**
+ * Named documents on a key/value `StorageAdapter`, for every editor kind:
+ * each file under its own key plus one index entry for listing. Operations
+ * run one at a time, so concurrent saves do not lose index entries. The index
+ * is cached after the first read: use one store per storage namespace.
+ */
+export declare function createEditorDocumentStore(options: EditorDocumentStoreOptions): EditorDocumentStore;

package/dist/persistence/documentTools.d.cts

@@ -0,0 +1,35 @@
+import type { AgentToolProvider } from "../tools/registry.cjs";
+import type { EditorDocumentStore } from "./documentStore.cjs";
+import type { EditorDocument } from "./editorDocument.cjs";
+export interface DocumentToolProviderOptions {
+    /** Provider id (default `<kind>-document`). */
+    id?: string;
+    /** Tool-name prefix (`<namespace>__<name>`); defaults to the id, `''` for bare names. */
+    namespace?: string;
+    /** Toolset title (default "<Noun> document"). */
+    title?: string;
+    /** The skill that documents the editor's tools, e.g. `pixerate-diagram`. */
+    skill?: string;
+    /** What the document is called in descriptions (default the kind with spaces, e.g. "video project"). */
+    noun?: string;
+    /**
+     * Add `undo_<kind>` / `redo_<kind>` (default `true`). Pass `false` for editors
+     * whose own provider already has them.
+     */
+    history?: boolean;
+    /** Saved documents: adds `save_<kind>_document`, `list_saved_<kind>_documents` and `open_saved_<kind>_document`. */
+    store?: EditorDocumentStore;
+    /** Name `save_<kind>_document` uses when none is given (default "Untitled <noun>"). */
+    name?: () => string | undefined;
+    /** `get_<kind>_document` refuses documents whose JSON is longer than this (default 200000 characters). */
+    maxChars?: number;
+}
+/**
+ * The same document tools for every editor, named after `doc.kind`:
+ * `get_<kind>_document`, `load_<kind>_document`, `undo_<kind>`, `redo_<kind>`
+ * and, with a `store`, `save_<kind>_document`, `list_saved_<kind>_documents`
+ * and `open_saved_<kind>_document`. Loads are checked before anything changes
+ * and are one undo step where the editor supports it. A read-only document
+ * keeps its read tools; its write tools refuse with the reason.
+ */
+export declare function createDocumentToolProvider(doc: EditorDocument, options?: DocumentToolProviderOptions): AgentToolProvider;