svedit 0.4.0 → 0.5.0

package/README.md

@@ -1,6 +1,6 @@
 # Svedit
 
-Svedit (think Svelte Edit) is a tiny library for building **rich content editors** with Svelte 5. You can model your content in JSON, render it with custom Svelte components, and edit it directly in the layout.
+Svedit (think Svelte Edit) is a a tiny library for building editable websites in Svelte. You can model your content in JSON, render it with custom Svelte components, and edit it directly in the layout.
 
 Try the [demo](https://svedit.vercel.app).
 
@@ -217,7 +217,8 @@ const document_config = {
         layout,
    			content
   		};
-  		tr.insert_nodes([new_text]);
+      tr.create(new_text);
+  		tr.insert_nodes([new_text.id]);
     },
   }
 };
@@ -376,4 +377,4 @@ It's early. Expect bugs. Expect missing features. Expect the need for more work
 
 ## Credits
 
-Svedit led by [Michael Aufreiter](https://michaelaufreiter.com) with guidance and support from [Johannes Mutter](https://mutter.co).
+Svedit is led by [Michael Aufreiter](https://michaelaufreiter.com) with guidance and support from [Johannes Mutter](https://mutter.co).

package/dist/Document.svelte.d.ts

@@ -5,13 +5,10 @@
  *   Selection,
  *   Annotation,
  *   PrimitiveType,
- *   DocumentSchemaPrimitive,
  *   NodeProperty,
  *   NodeArrayProperty,
  *   NodeKind,
  *   NodeSchema,
- *   TextNodeSchema,
- *   NonTextNodeSchema,
  *   DocumentSchema,
  *   SerializedDocument
  * } from './types.d.ts';
@@ -168,6 +165,20 @@ export default class Document {
      * @returns {NodeKind}
      */
     kind(node: any): NodeKind;
+    /**
+     * Determines whether a node type can be inserted at a given selection.
+     * @param {string} node_type - The type of node to insert.
+     * @param {Selection} [selection] - The selection at which to insert the node.
+     * @returns {boolean} True if the node type can be inserted, false otherwise.
+     */
+    can_insert(node_type: string, selection?: Selection): boolean;
+    /**
+     * Compute next possible insert position from a given selection
+     *
+     * @param {Selection} [selection] - Reference selection
+     * @returns {Selection} True if the paste operation was successful, false otherwise
+     */
+    get_next_node_insert_cursor(selection?: Selection): Selection;
     /**
      * Returns the annotation object that is currently "under the cursor".
      * NOTE: Annotations in Svedit are exclusive, so there can only be one active_annotation
@@ -176,6 +187,11 @@ export default class Document {
      * @returns {Annotation|null}
      */
     active_annotation(annotation_type: string): Annotation | null;
+    get_selected_annotated_text(): {
+        text: string;
+        annotations: any;
+        nodes: {};
+    };
     get_selected_plain_text(): string;
     get_selected_nodes(): any;
     select_parent(): void;
@@ -190,7 +206,7 @@ export default class Document {
      * @returns {SerializedDocument} The serialized document array
      */
     to_json(): SerializedDocument;
-    property_type(type: any, property: any): "string" | "number" | "boolean" | "node" | "node_array" | "annotated_text" | "integer" | "datetime" | "string_array" | "number_array" | "boolean_array" | "integer_array";
+    property_type(type: any, property: any): "string" | "number" | "boolean" | "node_array" | "node" | "annotated_text" | "integer" | "integer_array" | "number_array" | "string_array" | "datetime" | "boolean_array";
     count_references(node_id: any): number;
     /**
      * @param {NodeId} node_id

package/dist/Document.svelte.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Document.svelte.d.ts","sourceRoot":"","sources":["../src/lib/Document.svelte.js"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;GAOG;AACH,uCAJ0C,CAAC,SAA7B,MAAM,CAAC,MAAM,EAAE,UAAU,CAAE,UAC9B,CAAC,GACC,CAAC,CAIb;AAED;;;;GAIG;AACH,wCAHW,MAAM,GACJ,IAAI,IAAI,aAAa,CAQjC;AAED;;;;GAIG;AACH,2DAHW,YAAY,GAAG,iBAAiB,GAC9B,MAAM,GAAG,IAAI,CASzB;AAED;;;;GAIG;AACH,0DAHW,cAAc,QAexB;AAuGD;IAgGE;;;;;;OAMG;IACH,oBANW,cAAc,kBACd,kBAAkB,0BAE1B;QAA4B,SAAS,GAA7B,SAAS;QACK,MAAM,GAApB,GAAG;KACb,EAqBA;IAxHD,YAAkB;IAClB,iBAAuB;IACvB,WAAiB;IACjB,eAAqB;IACrB,sBAA2B;IAG3B,kBAA6C;IAC7C,kBAAkE;IAGnE,mBAAmD;IACnD,iBAA+C;IAC/C,gCAA6E;IAU5E;;;;OAIG;IACH,qBAHW,SAAS,GAAG,SAAS,EAQ/B;IAlBD;;;OAGG;IACH,iBAFa,SAAS,GAAG,SAAS,CAIjC;IAcD;;;;;;OAMG;IACH,4BAiDC;IAaC,uBAAoB;IAkBtB,mBAMC;IAED,sCAKA;IAGD,yBAkBC;IAID,uBAoBC;IAGA,yBAWC;IAED;;;;OAIG;IACH,oBAHW,GAAG,QAKb;IAED;;;;OAIG;IACH,UAFa,WAAW,CASvB;IAED;;;;OAIG;IACH,mBAFW,WAAW,QAkBrB;IAED,aAWC;IAED,aAaC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,UAlBW,YAAY,GAAC,MAAM,GACjB,GAAG,CAoFf;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,cAHW,YAAY,GACV;QAAC,IAAI,EAAE,UAAU,GAAC,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAuBzD;IAED;;;;;OAKG;IACH,WAHW,GAAG,GACD,QAAQ,CAIpB;IAED;;;;;;OAMG;IACH,mCAHW,MAAM,GACJ,UAAU,GAAC,IAAI,CAqB3B;IAGD,kCAOC;IAED,0BAOC;IAED,sBAmCC;IAED;;;;MAaC;IAKD,8BAgCC;IAED;;;OAGG;IACH,WAFa,kBAAkB,CAI9B;IAID,mNAWC;IAGD,uCAkBC;IAGD;;;OAGG;IACH,8BAHW,MAAM,GACJ,MAAM,EAAE,CASpB;;CACF;gCAxwBS,cAAc;mCAAd,cAAc;kCAAd,cAAc;uCAAd,cAAc;oCAAd,cAAc;+BAAd,cAAc;wBAnBA,yBAAyB;kCAmBvC,cAAc;8BAAd,cAAc;gCAAd,cAAc;wCAAd,cAAc;4BAAd,cAAc"}
+{"version":3,"file":"Document.svelte.d.ts","sourceRoot":"","sources":["../src/lib/Document.svelte.js"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;GAcG;AAEH;;;;;;;GAOG;AACH,uCAJ0C,CAAC,SAA7B,MAAM,CAAC,MAAM,EAAE,UAAU,CAAE,UAC9B,CAAC,GACC,CAAC,CAIb;AAED;;;;GAIG;AACH,wCAHW,MAAM,GACJ,IAAI,IAAI,aAAa,CAQjC;AAED;;;;GAIG;AACH,2DAHW,YAAY,GAAG,iBAAiB,GAC9B,MAAM,GAAG,IAAI,CASzB;AAED;;;;GAIG;AACH,0DAHW,cAAc,QAexB;AAuGD;IAgGE;;;;;;OAMG;IACH,oBANW,cAAc,kBACd,kBAAkB,0BAE1B;QAA4B,SAAS,GAA7B,SAAS;QACK,MAAM,GAApB,GAAG;KACb,EAqBA;IAxHD,YAAkB;IAClB,iBAAuB;IACvB,WAAiB;IACjB,eAAqB;IACrB,sBAA2B;IAG3B,kBAA6C;IAC7C,kBAAkE;IAGnE,mBAAmD;IACnD,iBAA+C;IAC/C,gCAA6E;IAU5E;;;;OAIG;IACH,qBAHW,SAAS,GAAG,SAAS,EAQ/B;IAlBD;;;OAGG;IACH,iBAFa,SAAS,GAAG,SAAS,CAIjC;IAcD;;;;;;OAMG;IACH,4BAiDC;IAaC,uBAAoB;IAkBtB,mBAMC;IAED,sCAKA;IAGD,yBAkBC;IAID,uBAoBC;IAGA,yBAWC;IAED;;;;OAIG;IACH,oBAHW,GAAG,QAKb;IAED;;;;OAIG;IACH,UAFa,WAAW,CASvB;IAED;;;;OAIG;IACH,mBAFW,WAAW,QAkBrB;IAED,aAWC;IAED,aAaC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,UAlBW,YAAY,GAAC,MAAM,GACjB,GAAG,CAoFf;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,cAHW,YAAY,GACV;QAAC,IAAI,EAAE,UAAU,GAAC,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAuBzD;IAED;;;;;OAKG;IACH,WAHW,GAAG,GACD,QAAQ,CAIpB;IAED;;;;;OAKG;IACH,sBAJW,MAAM,cACN,SAAS,GACP,OAAO,CAcnB;IAED;;;;;OAKG;IACH,wCAHW,SAAS,GACP,SAAS,CAerB;IAED;;;;;;OAMG;IACH,mCAHW,MAAM,GACJ,UAAU,GAAC,IAAI,CAqB3B;IAED;;;;MA2BC;IAGD,kCAOC;IAED,0BAOC;IAED,sBAmCC;IAED;;;;MAaC;IAKD,8BAEC;IAED;;;OAGG;IACH,WAFa,kBAAkB,CAI9B;IAID,mNAWC;IAGD,uCAkBC;IAGD;;;OAGG;IACH,8BAHW,MAAM,GACJ,MAAM,EAAE,CASpB;;CACF;gCAhzBS,cAAc;mCAAd,cAAc;kCAAd,cAAc;uCAAd,cAAc;oCAAd,cAAc;+BAAd,cAAc;wBAhBA,yBAAyB;kCAgBvC,cAAc;8BAAd,cAAc;gCAAd,cAAc;wCAAd,cAAc;4BAAd,cAAc"}

package/dist/Document.svelte.js

@@ -1,5 +1,5 @@
 import Transaction from './Transaction.svelte.js';
-import { char_slice, get_char_length } from './util.js';
+import { char_slice, get_char_length, traverse } from './util.js';
 
 /**
  * @import {
@@ -8,13 +8,10 @@ import { char_slice, get_char_length } from './util.js';
  *   Selection,
  *   Annotation,
  *   PrimitiveType,
- *   DocumentSchemaPrimitive,
  *   NodeProperty,
  *   NodeArrayProperty,
  *   NodeKind,
  *   NodeSchema,
- *   TextNodeSchema,
- *   NonTextNodeSchema,
  *   DocumentSchema,
  *   SerializedDocument
  * } from './types.d.ts';
@@ -315,8 +312,8 @@ export default class Document {
  	get_available_annotation_types() {
     if (this.selection?.type !== 'text') return [];
     const path = this.selection.path;
-    const property_schema = this.inspect(path);
-    return property_schema.node_types || [];
+    const property_definition = this.inspect(path);
+    return property_definition.node_types || [];
 	}
 
  	// Helper function to get the currently selected node
@@ -600,6 +597,47 @@ export default class Document {
     return this.schema[node.type].kind;
   }
 
+  /**
+   * Determines whether a node type can be inserted at a given selection.
+   * @param {string} node_type - The type of node to insert.
+   * @param {Selection} [selection] - The selection at which to insert the node.
+   * @returns {boolean} True if the node type can be inserted, false otherwise.
+   */
+  can_insert(node_type, selection = this.selection) {
+    if (selection?.type === 'node') {
+      const property_definition = this.inspect(selection.path);
+      if (property_definition.node_types.includes(node_type)) {
+        return true;
+      }
+    }
+
+    // No insert position found yet, and root not reached, try one level up if possible
+    let next_node_insert_cursor = this.get_next_node_insert_cursor(selection);
+    if (!next_node_insert_cursor) return false;
+    return this.can_insert(node_type, next_node_insert_cursor);
+  }
+
+  /**
+   * Compute next possible insert position from a given selection
+   *
+   * @param {Selection} [selection] - Reference selection
+   * @returns {Selection} True if the paste operation was successful, false otherwise
+   */
+  get_next_node_insert_cursor(selection = this.selection) {
+    // There's no parent path to insert into
+    if (!selection || selection.path.length <= 2) {
+      return null;
+    }
+
+    const node_offset = parseInt(String(selection.path.at(-2)), 10) + 1;
+    return {
+      type: 'node',
+      path: selection.path.slice(0, -2),
+      anchor_offset: node_offset,
+      focus_offset: node_offset,
+    };
+  }
+
   /**
    * Returns the annotation object that is currently "under the cursor".
    * NOTE: Annotations in Svedit are exclusive, so there can only be one active_annotation
@@ -628,6 +666,35 @@ export default class Document {
     }
   }
 
+  get_selected_annotated_text() {
+    if (this.selection?.type !== 'text') return null;
+
+    const selection_start =   Math.min(this.selection.anchor_offset, this.selection.focus_offset);
+    const selection_end = Math.max(this.selection.anchor_offset, this.selection.focus_offset);
+    const annotated_text = this.get(this.selection.path);
+    const text = char_slice(annotated_text.text, selection_start, selection_end);
+    const nodes = {};
+    const annotations = annotated_text.annotations.map(a => {
+      if (selection_start < a.end_offset && selection_end > a.start_offset) {
+        const sub_graph = this.traverse(a.node_id);
+        for (const node of sub_graph) {
+          if (!nodes[node.id]) {
+            nodes[node.id] = node;
+          }
+        }
+        return {
+          start_offset: Math.max(a.start_offset - selection_start, 0),
+          end_offset: Math.min(a.end_offset - selection_start, selection_end - selection_start),
+          node_id: a.node_id
+        };
+      } else {
+        return null;
+      }
+    }).filter(Boolean);
+
+    return { text, annotations, nodes };
+  }
+
   // TODO: think about ways how we can also turn a node selection into plain text.
   get_selected_plain_text() {
     if (this.selection?.type !== 'text') return null;
@@ -703,37 +770,7 @@ export default class Document {
   // IMPORTANT: Leaf nodes must go first, branches second and the root node (entry point) last (depth-first traversal)
   // NOTE: Nodes that are not reachable from the entry point node will not be included in the serialization
   traverse(node_id) {
-    const json = [];
-    const visited = {};
-    const visit = (node) => {
-      if (!node || visited[node.id]) {
-        return;
-      }
-      visited[node.id] = true;
-      for (const [property_name, value] of Object.entries(node)) {
-        const property_schema = this.schema[node.type].properties[property_name];
-
-        if (property_schema?.type === 'node_array') {
-          for (const v of value) {
-            if (typeof v === 'string') {
-              visit($state.snapshot(this.get(v)));
-            }
-          }
-        } else if (property_schema?.type === 'node') {
-          visit($state.snapshot(this.get(value)));
-        } else if (property_schema?.type === 'annotated_text') {
-          for (const annotation of value.annotations) {
-            visit($state.snapshot(this.get(annotation.node_id)));
-          }
-        }
-      }
-      // Finally add the node to the result.
-      // We use a deep clone, so we make sure nothing of the original document is referenced.
-      json.push(structuredClone(node));
-    }
-    // Start with the root node (document_id)
-    visit($state.snapshot(this.get(node_id)));
-    return json;
+    return traverse(node_id, this.schema, $state.snapshot(this.nodes));
   }
 
   /**