svedit 0.5.0 → 0.6.1

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

@@ -0,0 +1 @@
+{"version":3,"file":"transforms.svelte.d.ts","sourceRoot":"","sources":["../src/lib/transforms.svelte.js"],"names":[],"mappings":"AAGA,kDAuDC;AAED,iDAqEC;AAED,sDAuBC"}

package/dist/transforms.svelte.js

@@ -0,0 +1,155 @@
+import { split_annotated_text, join_annotated_text, get_char_length } from './utils.js';
+import { get_default_node_type } from './doc_utils.js';
+
+export function break_text_node(tr) {
+	// Keep a reference of the original selection (before any transforms are applied)
+	const selection = tr.selection;
+	// First we need to ensure we have a text selection
+	if (selection.type !== 'text') return false;
+
+	// Next, we need to determine if the enclosing node is a pure text node (e.g. paragraph),
+	// which is wrapped inside a node_array (e.g. page.body)
+
+	// Owner of the text property (e.g. paragraph)
+	const node = tr.get(selection.path.slice(0, -1));
+	if (tr.kind(node) !== 'text') return false;
+	const is_inside_node_array = tr.inspect(selection.path.slice(0, -2))?.type === 'node_array';
+	// console.log('is_inside_node_array', is_inside_node_array);
+	if (!is_inside_node_array) return false; // Do nothing if we're not inside a node_array
+	const node_array_prop = selection.path.at(-3);
+	// console.log('node_array_prop', node_array_prop);
+	// Get the node that owns the node_array property (e.g. a page.body)
+	const node_array_node = tr.get(selection.path.slice(0, -3));
+	// console.log('node_array_node', $state.snapshot(node_array_node));
+
+	// Delete selection unless collapsed
+	if (selection.anchor_offset !== selection.focus_offset) {
+		tr.delete_selection();
+	}
+
+	const split_at_position = tr.selection.anchor_offset;
+	const content = tr.get(selection.path);
+	const [left_text, right_text] = split_annotated_text(content, split_at_position);
+
+	tr.set([node.id, 'content'], left_text);
+
+	const node_insert_position = {
+		type: 'node',
+		path: tr.selection.path.slice(0, -2),
+		anchor_offset: parseInt(tr.selection.path.at(-2), 10) + 1,
+		focus_offset: parseInt(tr.selection.path.at(-2), 10) + 1
+	};
+
+	// TODO: Only use default_node_type when cursor is at the end of
+	const node_array_property_definition =
+		tr.schema[node_array_node.type].properties[node_array_prop];
+	const target_node_type = get_default_node_type(node_array_property_definition);
+
+	if (!target_node_type) {
+		console.warn(
+			'Cannot determine target node type for break_text_node - no default_ref_type and multiple node_types'
+		);
+		return false;
+	}
+
+	tr.set_selection(node_insert_position);
+
+	tr.config.inserters[target_node_type](tr, right_text);
+	return true;
+}
+
+export function join_text_node(tr) {
+	// Keep a reference of the original selection (before any transforms are applied)
+	const selection = tr.selection;
+	// First we need to ensure we have a text selection
+	if (selection.type !== 'text') return false;
+
+	const node = tr.get(selection.path.slice(0, -1));
+	if (tr.kind(node) !== 'text') return false;
+	const is_inside_node_array = tr.inspect(selection.path.slice(0, -2))?.type === 'node_array';
+	// console.log('is_inside_node_array', is_inside_node_array);
+	if (!is_inside_node_array) return false; // Do nothing if we're not inside a node_array
+
+	const node_index = parseInt(tr.selection.path.at(-2), 10);
+
+	// Determine if we can join with the previous node
+	let can_join = false;
+	let predecessor_node = null;
+
+	if (node_index > 0) {
+		const previous_text_path = [...tr.selection.path.slice(0, -2), node_index - 1];
+		predecessor_node = tr.get(previous_text_path);
+		can_join = tr.kind(predecessor_node) === 'text';
+	}
+
+	// Special behavior: if we can't join and current node is empty, delete it
+	if (!can_join && node.content.text === '') {
+		tr.set_selection({
+			type: 'node',
+			path: tr.selection.path.slice(0, -2),
+			anchor_offset: node_index,
+			focus_offset: node_index + 1
+		});
+		tr.delete_selection();
+		return true;
+	}
+
+	// If we can't join for any reason, return false
+	if (!can_join) {
+		return false;
+	}
+
+	// Normal joining logic - both nodes are text nodes
+	const previous_text_path = [...tr.selection.path.slice(0, -2), node_index - 1];
+	const joined_text = join_annotated_text(predecessor_node.content, node.content);
+
+	// Calculate cursor position based on original predecessor content length
+	const cursor_position = get_char_length(predecessor_node.content.text);
+
+	// First set the joined content on the predecessor node (preserves annotations)
+	tr.set([predecessor_node.id, 'content'], joined_text);
+
+	// Then delete the current node
+	tr.set_selection({
+		type: 'node',
+		path: tr.selection.path.slice(0, -2),
+		anchor_offset: node_index,
+		focus_offset: node_index + 1
+	});
+
+	tr.delete_selection();
+
+	// Finally set the cursor position at the join point using the pre-calculated position
+	tr.set_selection({
+		type: 'text',
+		path: [...previous_text_path, 'content'],
+		anchor_offset: cursor_position,
+		focus_offset: cursor_position
+	});
+	return true;
+}
+
+export function insert_default_node(tr) {
+	const selection = tr.selection;
+
+	// Only work with collapsed node selections
+	if (selection?.type !== 'node' || selection.anchor_offset !== selection.focus_offset) {
+		return false;
+	}
+
+	const path = selection.path;
+	const node_array_node = tr.get(path.slice(0, -1));
+	const property_name = path.at(-1);
+
+	// Get the definition for this property
+	const property_definition = tr.schema[node_array_node.type].properties[property_name];
+	const default_type = get_default_node_type(property_definition);
+
+	// Use the inserter function if available
+	if (tr.config?.inserters?.[default_type]) {
+		tr.config.inserters[default_type](tr);
+		return true;
+	} else {
+		throw new Error(`No inserter function available for default node type '${default_type}'`);
+	}
+}

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type Document from './Document.svelte.js';
+import type Session from './Session.svelte.js';
 import type Svedit from './Svedit.svelte';
 
 // ===== SVELTE TYPE IMPORTS =====
@@ -24,28 +24,28 @@ export type DocumentPath = Array<string | number>;
  * Text selection within a text property
  */
 export type TextSelection = {
-  type: "text";
-  path: DocumentPath;
-  anchor_offset: number;
-  focus_offset: number;
+	type: 'text';
+	path: DocumentPath;
+	anchor_offset: number;
+	focus_offset: number;
 };
 
 /**
  * Node selection within a node array
  */
 export type NodeSelection = {
-  type: "node";
-  path: DocumentPath;
-  anchor_offset: number;
-  focus_offset: number;
+	type: 'node';
+	path: DocumentPath;
+	anchor_offset: number;
+	focus_offset: number;
 };
 
 /**
  * Property selection within a node
  */
 export type PropertySelection = {
-  type: "property";
-  path: DocumentPath;
+	type: 'property';
+	path: DocumentPath;
 };
 
 /**
@@ -53,27 +53,35 @@ export type PropertySelection = {
  */
 export type Selection = TextSelection | NodeSelection | PropertySelection;
 
+/**
+ * Represents only the range (no direction and payload) of a NodeSelection or TextSelection
+ */
+export type SelectionRange = {
+	start_offset: number;
+	end_offset: number;
+};
+
 // ===== SCHEMA TYPE DEFINITIONS =====
 
 /**
  * Basic scalar types supported by the schema system.
  */
-export type ScalarType = "string" | "number" | "boolean" | "integer" | "datetime";
+export type ScalarType = 'string' | 'number' | 'boolean' | 'integer' | 'datetime';
 
 /**
  * Array types for collections of scalar values.
  */
-export type ArrayType = "string_array" | "number_array" | "boolean_array" | "integer_array";
+export type ArrayType = 'string_array' | 'number_array' | 'boolean_array' | 'integer_array';
 
 /**
  * Special types for rich content.
  */
-export type RichType = "annotated_text";
+export type RichType = 'annotated_text';
 
 /**
  * Node reference types for linking to other nodes.
  */
-export type ReferenceType = "node" | "node_array";
+export type ReferenceType = 'node' | 'node_array';
 
 /**
  * All primitive types that can be used in property definitions.
@@ -88,71 +96,178 @@ export type PropertyType = PrimitiveType | ReferenceType;
 /**
  * Document schema primitive types - all possible property types in document schemas.
  */
-export type DocumentSchemaPrimitive = "string" | "number" | "boolean" | "integer" | "datetime" | "string_array" | "number_array" | "boolean_array" | "integer_array" | "annotated_text" | "node" | "node_array";
+export type DocumentSchemaPrimitive =
+	| 'string'
+	| 'number'
+	| 'boolean'
+	| 'integer'
+	| 'datetime'
+	| 'string_array'
+	| 'number_array'
+	| 'boolean_array'
+	| 'integer_array'
+	| 'annotated_text'
+	| 'node'
+	| 'node_array';
 
 /**
  * Maps document schema types to their JavaScript runtime types.
  */
-export type DocumentSchemaValueToJs<T> =
-  T extends "string" ? string :
-  T extends "number" ? number :
-  T extends "boolean" ? boolean :
-  T extends "integer" ? number :
-  T extends "datetime" ? string :
-  T extends "string_array" ? Array<string> :
-  T extends "number_array" ? Array<number> :
-  T extends "boolean_array" ? Array<boolean> :
-  T extends "integer_array" ? Array<number> :
-  T extends "annotated_text" ? AnnotatedText :
-  T extends "node" ? string :
-  T extends "node_array" ? Array<string> :
-  never;
+export type DocumentSchemaValueToJs<T> = T extends 'string'
+	? string
+	: T extends 'number'
+		? number
+		: T extends 'boolean'
+			? boolean
+			: T extends 'integer'
+				? number
+				: T extends 'datetime'
+					? string
+					: T extends 'string_array'
+						? Array<string>
+						: T extends 'number_array'
+							? Array<number>
+							: T extends 'boolean_array'
+								? Array<boolean>
+								: T extends 'integer_array'
+									? Array<number>
+									: T extends 'annotated_text'
+										? AnnotatedText
+										: T extends 'node'
+											? string
+											: T extends 'node_array'
+												? Array<string>
+												: never;
 
 /**
  * Converts a document node schema definition to its inferred JS type.
  * Handles the {type: "..."} wrapper structure used in document schemas.
  */
-export type DocumentNodeToJs<S extends NodeSchema> =
-  { id: string, type: string } & { [K in keyof S["properties"]]: DocumentSchemaValueToJs<S["properties"][K]["type"]> };
+export type DocumentNodeToJs<S extends NodeSchema> = { id: string; type: string } & {
+	[K in keyof S['properties']]: DocumentSchemaValueToJs<S['properties'][K]['type']>;
+};
 
 /**
  * A property that stores an annotated text with required allow_newlines setting.
  */
 export type AnnotatedTextProperty = {
-  type: 'annotated_text';
-  node_types?: string[];
-  allow_newlines: boolean;
+	type: 'annotated_text';
+	node_types?: string[];
+	allow_newlines: boolean;
+};
+
+/**
+ * A property that stores a string value.
+ */
+export type StringProperty = {
+	type: 'string';
+	default?: string;
+};
+
+/**
+ * A property that stores a number value.
+ */
+export type NumberProperty = {
+	type: 'number';
+	default?: number;
+};
+
+/**
+ * A property that stores a boolean value.
+ */
+export type BooleanProperty = {
+	type: 'boolean';
+	default?: boolean;
+};
+
+/**
+ * A property that stores an integer value.
+ */
+export type IntegerProperty = {
+	type: 'integer';
+	default?: number;
+};
+
+/**
+ * A property that stores a datetime value.
+ */
+export type DatetimeProperty = {
+	type: 'datetime';
+	default?: string;
+};
+
+/**
+ * A property that stores an array of strings.
+ */
+export type StringArrayProperty = {
+	type: 'string_array';
+	default?: string[];
+};
+
+/**
+ * A property that stores an array of numbers.
+ */
+export type NumberArrayProperty = {
+	type: 'number_array';
+	default?: number[];
+};
+
+/**
+ * A property that stores an array of booleans.
+ */
+export type BooleanArrayProperty = {
+	type: 'boolean_array';
+	default?: boolean[];
+};
+
+/**
+ * A property that stores an array of integers.
+ */
+export type IntegerArrayProperty = {
+	type: 'integer_array';
+	default?: number[];
 };
 
 /**
  * A property that stores a primitive value (excluding annotated_text).
  */
-export type PrimitiveProperty = {
-  [K in Exclude<PrimitiveType, 'annotated_text'>]: { type: K }
-}[Exclude<PrimitiveType, 'annotated_text'>];
+export type PrimitiveProperty =
+	| StringProperty
+	| NumberProperty
+	| BooleanProperty
+	| IntegerProperty
+	| DatetimeProperty
+	| StringArrayProperty
+	| NumberArrayProperty
+	| BooleanArrayProperty
+	| IntegerArrayProperty;
 
 /**
  * A property that stores a reference to a single node.
  */
 export type NodeProperty = {
-  type: "node";
-  node_types: string[];
-  default_node_type?: string;
+	type: 'node';
+	node_types: string[];
+	default_node_type?: string;
 };
 
 /**
  * A property that stores an array of node references.
  */
 export type NodeArrayProperty = {
-  type: "node_array";
-  node_types: string[];
-  default_node_type?: string;
+	type: 'node_array';
+	node_types: string[];
+	default_node_type?: string;
 };
 
 /**
  * Union type for all possible property definitions.
  */
-export type PropertyDefinition = PrimitiveProperty | AnnotatedTextProperty | NodeProperty | NodeArrayProperty;
+export type PropertyDefinition =
+	| PrimitiveProperty
+	| AnnotatedTextProperty
+	| NodeProperty
+	| NodeArrayProperty;
 
 /**
  * Node kind values for different types of content nodes
@@ -163,18 +278,18 @@ export type NodeKind = 'document' | 'block' | 'text' | 'annotation';
  * Schema for text nodes - must have a content property of type annotated_text
  */
 export type TextNodeSchema = {
-  kind: 'text';
-  properties: {
-    content: AnnotatedTextProperty;
-  } & Record<string, PropertyDefinition>;
+	kind: 'text';
+	properties: {
+		content: AnnotatedTextProperty;
+	} & Record<string, PropertyDefinition>;
 };
 
 /**
  * Schema for non-text nodes
  */
 export type NonTextNodeSchema = {
-  kind: 'document' | 'block' | 'annotation';
-  properties: Record<string, PropertyDefinition>;
+	kind: 'document' | 'block' | 'annotation';
+	properties: Record<string, PropertyDefinition>;
 };
 
 /**
@@ -190,120 +305,151 @@ export type NodeSchema = TextNodeSchema | NonTextNodeSchema;
 export type DocumentSchema = Record<string, NodeSchema>;
 
 /**
- * A serialized node in the document format.
+ * A node in the document.
  * Must have id and type properties, with other properties defined by the schema.
  */
-export type SerializedNode = {
-  id: string;
-  type: string;
-  [key: string]: any;
+export type DocumentNode = {
+	id: string;
+	type: string;
+	[key: string]: any;
 };
 
 /**
- * The document serialization format - an array of serialized nodes.
- * Nodes must be ordered so that referenced nodes come before nodes that reference them.
+ * The document format - an object with document_id and nodes.
+ * The nodes object maps node IDs to their node data.
  */
-export type SerializedDocument = SerializedNode[];
+export type Document = {
+	document_id: string;
+	nodes: {
+		[key: string]: DocumentNode;
+	};
+};
 
 /**
  * Props for the AnnotatedTextProperty component
  */
 export type AnnotatedTextPropertyProps = {
-  /** The full path to the property */
-  path: DocumentPath;
-  /** The `class` attribute on the content element */
-  class?: string;
-  /** A placeholder to be rendered for empty content */
-  placeholder?: string;
+	/** The full path to the property */
+	path: DocumentPath;
+	/** Optional custom HTML tag */
+	tag?: string;
+	/** The `class` attribute on the content element */
+	class?: string;
+	/** A placeholder to be rendered for empty content */
+	placeholder?: string;
 };
 
 /**
  * Props for the CustomProperty component
  */
 export type CustomPropertyProps = {
-  /** The full path to the property */
-  path: DocumentPath;
-  /** The `class` attribute on the content element */
-  class?: string;
-  /** The content of the custom property (e.g. an image) */
-  children: Snippet;
+	/** The full path to the property */
+	path: DocumentPath;
+	/** Optional custom HTML tag */
+	tag?: string;
+	/** The `class` attribute on the content element */
+	class?: string;
+	/** The content of the custom property (e.g. an image) */
+	children: Snippet;
 };
 
 /**
  * Props for the NodeArray component
  */
 export type NodeArrayPropertyProps = {
-  /** The full path to the property */
-  path: DocumentPath;
-  /** The `class` attribute on the container element */
-  class?: string;
+	/** The full path to the property */
+	path: DocumentPath;
+	/** Optional custom HTML tag */
+	tag?: string;
+	/** Optional custom HTML tag */
+	tag?: string;
+	/** The `class` attribute on the container element */
+	class?: string;
 };
 
 /**
  * Props for the Node component
  */
 export type NodeProps = {
-  /** The full path to the node */
-  path: DocumentPath;
-  /** The type-specific content of the node */
-  children: Snippet;
+	/** The full path to the node */
+	path: DocumentPath;
+	/** Optional custom HTML tag */
+	tag?: string;
+	/** Optional string of CSS classes */
+	class?: string;
+	/** The type-specific content of the node */
+	children: Snippet;
 };
 
 /**
  * Props for the CustomProperty component
  */
 export type CustomPropertyProps = {
-  /** The full path to the property */
-  path: DocumentPath;
-  /** The `class` attribute on the content element */
-  class?: string;
-  /** The content of the custom property (e.g. an image) */
-  children: Snippet;
+	/** The full path to the property */
+	path: DocumentPath;
+	/** The `class` attribute on the content element */
+	class?: string;
+	/** The content of the custom property (e.g. an image) */
+	children: Snippet;
 };
 
 /**
  * Props for the CustomProperty component
  */
 export type SveditProps = {
-  /** The full path to the property */
-  doc: Document,
-  /** Determines wether the document should be editable or read-only. */
-  editable?: boolean,
-  /** The path to the root element (e.g. ['page_1']) */
-  path: DocumentPath,
-  /** The `class` attribute on the canvas element */
-  class?: string;
-  /** The `autocapitalize` attribute on the canvas element */
-  autocapitalize?: 'on' | 'off';
-  /** The `spellcheck` attribute on the canvas element */
-  spellcheck?: 'true' | 'false';
+	/** The session instance */
+	session: Session;
+	/** Determines wether the document should be editable or read-only. */
+	editable?: boolean;
+	/** The path to the root element (e.g. ['page_1']) */
+	path: DocumentPath;
+	/** The `class` attribute on the canvas element */
+	class?: string;
+	/** The `autocapitalize` attribute on the canvas element */
+	autocapitalize?: 'on' | 'off';
+	/** The `spellcheck` attribute on the canvas element */
+	spellcheck?: 'true' | 'false';
 };
 
 /**
  * Represents an annotation in an annotated string
  */
 export type Annotation = {
-  start_offset: number;
-  end_offset: number;
-  node_id: NodeId;
+	start_offset: number;
+	end_offset: number;
+	node_id: NodeId;
 };
 
 /**
  * Represents an annotated text with text and annotations
  */
 export type AnnotatedText = {
-  text: string;
-  annotations: Array<Annotation>;
+	text: string;
+	annotations: Array<Annotation>;
 };
 
 /**
- * Represents a fragment of annotated text content
+ * Represents a selection highlight fragment for non-annotated text selections
+ */
+export type SelectionHighlightFragment = {
+	type: 'selection_highlight';
+	content: string;
+};
+
+/**
+ * Represents an annotation fragment in annotated text content
  */
-export type AnnotationFragment = string | {
-  /** NodeId that has annotation type and details */
-  node: any;
-  /** The text content of the annotation */
-  content: string;
-  /** Index of the annotation in the original array */
-  annotation_index: number;
+export type AnnotationFragment = {
+	type: 'annotation';
+	/** NodeId that has annotation type and details */
+	node: any;
+	/** The text content of the annotation */
+	content: string;
+	/** Index of the annotation in the original array */
+	annotation_index: number;
 };
+
+/**
+ * Represents a fragment of annotated text content
+ */
+export type Fragment = string | AnnotationFragment | SelectionHighlightFragment;