svedit 0.11.0 → 0.12.0

package/dist/doc_utils.d.ts

@@ -55,6 +55,17 @@ export function fill_document_defaults(doc: Document, schema: DocumentSchema): D
  * @throws {Error} Throws if the document schema is invalid
  */
 export function validate_document_schema(document_schema: DocumentSchema): void;
+/**
+ * Validate that no annotation node type has a registered component.
+ *
+ * Marks render in-place via components; annotations are data-only overlay
+ * ranges that must be interpreted by the app (via CSS classes or props).
+ *
+ * @param {DocumentSchema} schema - The document schema
+ * @param {any} config - The Svedit config
+ * @throws {Error} Throws if a kind 'annotation' type has a registered component
+ */
+export function validate_config_components(schema: DocumentSchema, config: any): void;
 /**
  * @param {string} id
  * @returns {boolean}
@@ -98,23 +109,13 @@ export function get(schema: DocumentSchema, doc: Document, path: DocumentPath |
  */
 export function property_type(schema: object, type: string, property: string): string;
 /**
- * Determines the kind of a node ('block', 'text', or 'annotation').
+ * Determines the kind of a node ('block', 'text', 'mark', or 'annotation').
  *
  * @param {object} schema - The document schema
  * @param {any} node - The node to check
- * @returns {'block'|'text'|'annotation'} The node kind
+ * @returns {'block'|'text'|'mark'|'annotation'} The node kind
  */
-export function kind(schema: object, node: any): "block" | "text" | "annotation";
-/**
- * Checks whether an annotation node can be switched to another annotation type
- * without losing data.
- *
- * @param {DocumentSchema} schema - The document schema
- * @param {any} annotation_node - The annotation node to switch
- * @param {string} target_annotation_type - The target annotation type
- * @returns {boolean} True if the annotation can be switched safely
- */
-export function can_switch_annotation_type(schema: DocumentSchema, annotation_node: any, target_annotation_type: string): boolean;
+export function kind(schema: object, node: any): "block" | "text" | "mark" | "annotation";
 /**
  * Inspects a path to get metadata about the value at that location.
  *
@@ -127,6 +128,32 @@ export function inspect(schema: DocumentSchema, doc: Document, path: DocumentPat
     kind: "property" | "node";
     [key: string]: any;
 };
+/**
+ * Creates a mutable draft of a document: a new document object with a new
+ * nodes map, sharing the (immutable) node objects with the original.
+ *
+ * apply_op_to_draft mutates the draft's nodes map but copies node objects
+ * before changing them, so node identity is preserved for unchanged nodes
+ * (fine-grained rendering relies on this) and the original document is
+ * never touched.
+ *
+ * @param {Document} doc - The document to create a draft of
+ * @returns {Document} A draft document safe to mutate via apply_op_to_draft
+ */
+export function create_document_draft(doc: Document): Document;
+/**
+ * Applies an operation to a document draft in place.
+ *
+ * The draft's nodes map is mutated, but node objects are copied on write —
+ * one nodes-map copy per draft (see create_document_draft) replaces the
+ * previous one-copy-per-op behavior, which made transactions with many ops
+ * (paste, cascade delete) O(N·ops).
+ *
+ * @param {Document} draft - A draft created via create_document_draft
+ * @param {Array} op - The operation to apply [type, ...args]
+ * @returns {Document} The same draft, for convenience
+ */
+export function apply_op_to_draft(draft: Document, op: any[]): Document;
 /**
  * Applies an operation to a document and returns the new document.
  * Uses copy-on-write semantics.
@@ -146,20 +173,44 @@ export function apply_op(doc: Document, op: any[]): Document;
  */
 export function count_references(schema: DocumentSchema, doc: Document, node_id: NodeId): number;
 /**
- * Gets the currently active annotation at the selection, optionally filtered by type.
+ * @param {DocumentSchema} schema - The document schema
+ * @param {string} from_type - Current mark type
+ * @param {string} to_type - Target mark type
+ * @returns {boolean} Whether a mark can be switched between these types
+ */
+export function can_switch_mark_type(schema: DocumentSchema, from_type: string, to_type: string): boolean;
+/**
+ * Gets marks touched by the current selection.
  *
- * An annotation is considered "active" if it overlaps with the current selection in any way:
- * - Annotation contains the selection start
- * - Annotation contains the selection end
- * - Selection fully contains the annotation
+ * @param {DocumentSchema} schema - The document schema
+ * @param {Document} doc - The document containing nodes
+ * @param {Selection} [selection] - The current selection
+ * @returns {(Mark & { index: number, node: any })[]} Selected mark records
+ */
+export function get_selected_marks(schema: DocumentSchema, doc: Document, selection?: Selection): (Mark & {
+    index: number;
+    node: any;
+})[];
+/**
+ * Gets annotations touched by the current selection.
  *
  * @param {DocumentSchema} schema - The document schema
  * @param {Document} doc - The document containing nodes
  * @param {Selection} [selection] - The current selection
- * @param {string} [annotation_type] - Optional annotation type to filter by
- * @returns {Annotation | null} The active annotation, or null if none found
+ * @returns {(Annotation & { index: number, node: any })[]} Selected annotation records
+ */
+export function get_selected_annotations(schema: DocumentSchema, doc: Document, selection?: Selection): (Annotation & {
+    index: number;
+    node: any;
+})[];
+/**
+ * @param {(Attachment & { index: number, node: any })[]} selected_ranges
+ * @returns {Set<string>} Node types represented in the selected ranges
  */
-export function get_active_annotation(schema: DocumentSchema, doc: Document, selection?: Selection, annotation_type?: string): Annotation | null;
+export function get_selected_range_types(selected_ranges: (Attachment & {
+    index: number;
+    node: any;
+})[]): Set<string>;
 /**
  * Counts references to a node, excluding nodes marked for deletion.
  *
@@ -170,6 +221,28 @@ export function get_active_annotation(schema: DocumentSchema, doc: Document, sel
  * @returns {number} The number of references excluding deleted nodes
  */
 export function count_references_excluding_deleted(schema: DocumentSchema, doc: Document, target_node_id: NodeId, nodes_to_delete: Record<NodeId, boolean>): number;
+/**
+ * Iterates all node references going out of a node, invoking the visitor
+ * once per occurrence (multiplicity matters for reference counting).
+ * Covers the same reference kinds as count_references_excluding_deleted:
+ * a `node` property, `node_array` .nodes ids, and the mark/annotation
+ * node_ids carried on `text` and `node_array` properties.
+ *
+ * @param {DocumentSchema} schema - The document schema
+ * @param {any} node - The node whose outgoing references to visit
+ * @param {(referenced_id: NodeId) => void} visit - Called per reference occurrence
+ */
+export function visit_node_references(schema: DocumentSchema, node: any, visit: (referenced_id: NodeId) => void): void;
+/**
+ * Builds reference counts for every referenced node in one full-document
+ * scan. Used by cascade deletion so the fixpoint can decrement counts
+ * incrementally instead of re-scanning the document per candidate node.
+ *
+ * @param {DocumentSchema} schema - The document schema
+ * @param {Document} doc - The document containing nodes
+ * @returns {Map<NodeId, number>} Reference count per referenced node id
+ */
+export function build_reference_counts(schema: DocumentSchema, doc: Document): Map<NodeId, number>;
 /**
  * Gets ids of nodes that reference any of the target nodes.
  *
@@ -201,5 +274,7 @@ import type { Document } from './types';
 import type { DocumentPath } from './types';
 import type { NodeId } from './types';
 import type { Selection } from './types';
+import type { Mark } from './types';
 import type { Annotation } from './types';
+import type { Attachment } from './types';
 //# sourceMappingURL=doc_utils.d.ts.map

package/dist/doc_utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"doc_utils.d.ts","sourceRoot":"","sources":["../src/lib/doc_utils.js"],"names":[],"mappings":"AAiBA;;;;;;;GAOG;AACH,uCAJ0C,CAAC,SAA7B,MAAM,CAAC,MAAM,EAAE,UAAU,CAAE,UAC9B,CAAC,GAAG,uBAAuB,CAAC,CAAC,GAC3B,CAAC,CAIb;AAED;;;;GAIG;AACH,wCAHW,MAAM,GACJ,IAAI,IAAI,aAAa,CAejC;AAED;;;;GAIG;AACH,2DAHW,YAAY,GAAG,iBAAiB,GAC9B,MAAM,GAAG,IAAI,CAWzB;AAED;;;GAGG;AACH,0DAHW,OAAO,SAAS,EAAE,kBAAkB,GAClC,GAAG,CAqBf;AAED;;;;;;;;;;;GAWG;AACH,yCAJW,GAAG,UACH,cAAc,GACZ,GAAG,CAgBf;AAED;;;;;;;;;;GAUG;AACH,4CAJW,QAAQ,UACR,cAAc,GACZ,QAAQ,CAcpB;AAED;;;;GAIG;AACH,0DAHW,cAAc,QAoBxB;AAoHD;;;GAGG;AACH,gCAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;;;GAOG;AACH,oCANW,GAAG,UACH,cAAc,cACd,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YACnB;IAAE,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAAE,QAwF1C;AAED;;;;;;GAMG;AACH,uCAJW,QAAQ,UACR,cAAc,QAUxB;AAED;;;;;;;GAOG;AACH,4BALW,cAAc,OACd,QAAQ,QACR,YAAY,GAAC,MAAM,GACjB,GAAG,CA4Ef;AAED;;;;;;;GAOG;AACH,sCALW,MAAM,QACN,MAAM,YACN,MAAM,GACJ,MAAM,CAclB;AAED;;;;;;GAMG;AACH,6BAJW,MAAM,QACN,GAAG,GACD,OAAO,GAAC,MAAM,GAAC,YAAY,CAIvC;AAED;;;;;;;;GAQG;AACH,mDALW,cAAc,mBACd,GAAG,0BACH,MAAM,GACJ,OAAO,CAgBnB;AAED;;;;;;;GAOG;AACH,gCALW,cAAc,OACd,QAAQ,QACR,YAAY,GACV;IAAC,IAAI,EAAE,UAAU,GAAC,MAAM,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC,CAoBzD;AAED;;;;;;;GAOG;AACH,8BAJW,QAAQ,cAEN,QAAQ,CAkCpB;AAED;;;;;;;GAOG;AACH,yCALW,cAAc,OACd,QAAQ,WACR,MAAM,GACJ,MAAM,CAoBlB;AAED;;;;;;;;;;;;;GAaG;AACH,8CANW,cAAc,OACd,QAAQ,cACR,SAAS,oBACT,MAAM,GACJ,UAAU,GAAG,IAAI,CAwB7B;AAED;;;;;;;;GAQG;AACH,2DANW,cAAc,OACd,QAAQ,kBACR,MAAM,mBACN,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACrB,MAAM,CA0BlB;AAED;;;;;;;GAOG;AACH,iDALW,cAAc,OACd,QAAQ,mBACR,QAAQ,CAAC,MAAM,CAAC,GACd,MAAM,EAAE,CA4BpB;AAED;;;;;;;GAOG;AACH,8CAJW,SAAS,0BACT;IAAE,GAAG,WAAW;IAAC,OAAO,WAAU;CAAE,QAoD9C;gCAhyBmN,SAAS;4CAAT,SAAS;mCAAT,SAAS;kCAAT,SAAS;uCAAT,SAAS;oCAAT,SAAS;8BAAT,SAAS;kCAAT,SAAS;4BAAT,SAAS;+BAAT,SAAS;gCAAT,SAAS"}
+{"version":3,"file":"doc_utils.d.ts","sourceRoot":"","sources":["../src/lib/doc_utils.js"],"names":[],"mappings":"AAkBA;;;;;;;GAOG;AACH,uCAJ0C,CAAC,SAA7B,MAAM,CAAC,MAAM,EAAE,UAAU,CAAE,UAC9B,CAAC,GAAG,uBAAuB,CAAC,CAAC,GAC3B,CAAC,CAIb;AAED;;;;GAIG;AACH,wCAHW,MAAM,GACJ,IAAI,IAAI,aAAa,CAejC;AAED;;;;GAIG;AACH,2DAHW,YAAY,GAAG,iBAAiB,GAC9B,MAAM,GAAG,IAAI,CAWzB;AAED;;;GAGG;AACH,0DAHW,OAAO,SAAS,EAAE,kBAAkB,GAClC,GAAG,CAqBf;AAED;;;;;;;;;;;GAWG;AACH,yCAJW,GAAG,UACH,cAAc,GACZ,GAAG,CAgBf;AAED;;;;;;;;;;GAUG;AACH,4CAJW,QAAQ,UACR,cAAc,GACZ,QAAQ,CAcpB;AAED;;;;GAIG;AACH,0DAHW,cAAc,QAoCxB;AAED;;;;;;;;;GASG;AACH,mDAJW,cAAc,UACd,GAAG,QAWb;AA+LD;;;GAGG;AACH,gCAHW,MAAM,GACJ,OAAO,CAInB;AAED;;;;;;;GAOG;AACH,oCANW,GAAG,UACH,cAAc,cACd,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,YACnB;IAAE,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAAE,QA6G1C;AAED;;;;;;GAMG;AACH,uCAJW,QAAQ,UACR,cAAc,QAgBxB;AAED;;;;;;;GAOG;AACH,4BALW,cAAc,OACd,QAAQ,QACR,YAAY,GAAC,MAAM,GACjB,GAAG,CAiGf;AAED;;;;;;;GAOG;AACH,sCALW,MAAM,QACN,MAAM,YACN,MAAM,GACJ,MAAM,CAclB;AAED;;;;;;GAMG;AACH,6BAJW,MAAM,QACN,GAAG,GACD,OAAO,GAAC,MAAM,GAAC,MAAM,GAAC,YAAY,CAI9C;AAED;;;;;;;GAOG;AACH,gCALW,cAAc,OACd,QAAQ,QACR,YAAY,GACV;IAAC,IAAI,EAAE,UAAU,GAAC,MAAM,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAC,CAoBzD;AAED;;;;;;;;;;;GAWG;AACH,2CAHW,QAAQ,GACN,QAAQ,CAOpB;AAED;;;;;;;;;;;GAWG;AACH,yCAJW,QAAQ,cAEN,QAAQ,CAgBpB;AAED;;;;;;;GAOG;AACH,8BAJW,QAAQ,cAEN,QAAQ,CAIpB;AAED;;;;;;;GAOG;AACH,yCALW,cAAc,OACd,QAAQ,WACR,MAAM,GACJ,MAAM,CA0BlB;AAED;;;;;GAKG;AACH,6CALW,cAAc,aACd,MAAM,WACN,MAAM,GACJ,OAAO,CAWnB;AA2CD;;;;;;;GAOG;AACH,2CALW,cAAc,OACd,QAAQ,cACR,SAAS,GACP,CAAC,IAAI,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,GAAG,CAAA;CAAE,CAAC,EAAE,CAInD;AAED;;;;;;;GAOG;AACH,iDALW,cAAc,OACd,QAAQ,cACR,SAAS,GACP,CAAC,UAAU,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,GAAG,CAAA;CAAE,CAAC,EAAE,CAIzD;AAED;;;GAGG;AACH,0DAHW,CAAC,UAAU,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,GAAG,CAAA;CAAE,CAAC,EAAE,GAC3C,GAAG,CAAC,MAAM,CAAC,CAIvB;AAED;;;;;;;;GAQG;AACH,2DANW,cAAc,OACd,QAAQ,kBACR,MAAM,mBACN,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACrB,MAAM,CA4BlB;AAED;;;;;;;;;;GAUG;AACH,8CAJW,cAAc,QACd,GAAG,SACH,CAAC,aAAa,EAAE,MAAM,KAAK,IAAI,QAuBzC;AAED;;;;;;;;GAQG;AACH,+CAJW,cAAc,OACd,QAAQ,GACN,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAW/B;AAED;;;;;;;GAOG;AACH,iDALW,cAAc,OACd,QAAQ,mBACR,QAAQ,CAAC,MAAM,CAAC,GACd,MAAM,EAAE,CAkCpB;AAED;;;;;;;GAOG;AACH,8CAJW,SAAS,0BACT;IAAE,GAAG,WAAW;IAAC,OAAO,WAAU;CAAE,QAoD9C;gCAhjC4N,SAAS;4CAAT,SAAS;mCAAT,SAAS;kCAAT,SAAS;uCAAT,SAAS;oCAAT,SAAS;8BAAT,SAAS;kCAAT,SAAS;4BAAT,SAAS;+BAAT,SAAS;0BAAT,SAAS;gCAAT,SAAS;gCAAT,SAAS"}