@miy2/xml-api 0.9.0 → 0.9.1

package/dist/dom.js

@@ -1,14 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Document = exports.Element = exports.CDATASection = exports.Comment = exports.Text = exports.CharacterData = exports.NodeList = exports.Node = void 0;
-exports.createWrapper = createWrapper;
-const xml_api_model_1 = require("./model/xml-api-model");
+import { ModelCDATA, ModelComment, ModelElement, ModelText, } from "./model/xml-api-model";
 /**
  * Base class for all DOM nodes.
  * Implements a subset of the W3C Node interface to allow applications
  * to interact with the XML model using familiar methods.
  */
-class Node {
+export class Node {
     constructor(model, ownerDocument) {
         this.model = model;
         this.ownerDocument = ownerDocument;
@@ -27,11 +23,16 @@ class Node {
         return createWrapper(this.model.parent, this.ownerDocument);
     }
     /**
-     * Returns a NodeList containing all children of this node.
+     * Returns a NodeList containing all children of this node, respecting the document's filter.
      */
     get childNodes() {
-        if (this.model instanceof xml_api_model_1.ModelElement) {
-            return new NodeList(this.model.children.map((c) => createWrapper(c, this.ownerDocument)));
+        var _a;
+        if (this.model instanceof ModelElement) {
+            let children = this.model.children;
+            if ((_a = this.ownerDocument) === null || _a === void 0 ? void 0 : _a.nodeFilter) {
+                children = children.filter((c) => { var _a; return (_a = this.ownerDocument) === null || _a === void 0 ? void 0 : _a.accepts(c); });
+            }
+            return new NodeList(children.map((c) => createWrapper(c, this.ownerDocument)));
         }
         return new NodeList([]);
     }
@@ -47,9 +48,13 @@ class Node {
         const parent = this.model.parent;
         if (!parent)
             return null;
-        const index = parent.children.indexOf(this.model);
-        if (index >= 0 && index < parent.children.length - 1) {
-            return createWrapper(parent.children[index + 1], this.ownerDocument);
+        let index = parent.children.indexOf(this.model);
+        while (index < parent.children.length - 1) {
+            index++;
+            const sibling = parent.children[index];
+            if (!this.ownerDocument || this.ownerDocument.accepts(sibling)) {
+                return createWrapper(sibling, this.ownerDocument);
+            }
         }
         return null;
     }
@@ -57,20 +62,24 @@ class Node {
         const parent = this.model.parent;
         if (!parent)
             return null;
-        const index = parent.children.indexOf(this.model);
-        if (index > 0) {
-            return createWrapper(parent.children[index - 1], this.ownerDocument);
+        let index = parent.children.indexOf(this.model);
+        while (index > 0) {
+            index--;
+            const sibling = parent.children[index];
+            if (!this.ownerDocument || this.ownerDocument.accepts(sibling)) {
+                return createWrapper(sibling, this.ownerDocument);
+            }
         }
         return null;
     }
     get textContent() {
-        if (this.model instanceof xml_api_model_1.ModelText)
+        if (this.model instanceof ModelText)
             return this.model.text;
-        if (this.model instanceof xml_api_model_1.ModelComment)
+        if (this.model instanceof ModelComment)
             return this.model.content;
-        if (this.model instanceof xml_api_model_1.ModelCDATA)
+        if (this.model instanceof ModelCDATA)
             return this.model.content;
-        if (this.model instanceof xml_api_model_1.ModelElement) {
+        if (this.model instanceof ModelElement) {
             return this.model.children
                 .map((c) => createWrapper(c, this.ownerDocument).textContent)
                 .join("");
@@ -80,23 +89,24 @@ class Node {
     set textContent(value) {
         var _a, _b, _c, _d;
         const val = value || "";
-        if (this.model instanceof xml_api_model_1.ModelText) {
-            this.model.text = val;
+        const m = this.model;
+        if (m instanceof ModelText && this instanceof CharacterData) {
+            m.text = val;
             (_a = this.ownerDocument) === null || _a === void 0 ? void 0 : _a.notifyTextChange(this, val);
         }
-        else if (this.model instanceof xml_api_model_1.ModelComment) {
-            this.model.content = val;
+        else if (m instanceof ModelComment && this instanceof CharacterData) {
+            m.content = val;
             (_b = this.ownerDocument) === null || _b === void 0 ? void 0 : _b.notifyTextChange(this, val);
         }
-        else if (this.model instanceof xml_api_model_1.ModelCDATA) {
-            this.model.content = val;
+        else if (m instanceof ModelCDATA && this instanceof CharacterData) {
+            m.content = val;
             (_c = this.ownerDocument) === null || _c === void 0 ? void 0 : _c.notifyTextChange(this, val);
         }
-        else if (this.model instanceof xml_api_model_1.ModelElement) {
-            this.model.children = [];
+        else if (m instanceof ModelElement && this instanceof Element) {
+            m.children = [];
             if (val) {
-                const textNode = new xml_api_model_1.ModelText(val);
-                this.model.addChild(textNode);
+                const textNode = new ModelText(val);
+                m.addChild(textNode);
             }
             (_d = this.ownerDocument) === null || _d === void 0 ? void 0 : _d.notifyElementTextChange(this, val);
         }
@@ -107,9 +117,8 @@ class Node {
      */
     appendChild(newChild) {
         var _a;
-        if (this.model instanceof xml_api_model_1.ModelElement) {
+        if (this.model instanceof ModelElement) {
             this.model.addChild(newChild.getModel());
-            // @ts-ignore
             newChild.ownerDocument = this.ownerDocument;
             (_a = this.ownerDocument) === null || _a === void 0 ? void 0 : _a.notifyChildAdded(this, newChild, this.model.children.length - 1);
             return newChild;
@@ -123,7 +132,7 @@ class Node {
      */
     insertBefore(newChild, refChild) {
         var _a;
-        if (this.model instanceof xml_api_model_1.ModelElement) {
+        if (this.model instanceof ModelElement) {
             if (!refChild) {
                 return this.appendChild(newChild);
             }
@@ -134,20 +143,42 @@ class Node {
             // Update Model
             this.model.children.splice(index, 0, newChild.getModel());
             newChild.getModel().parent = this.model;
-            // @ts-ignore
             newChild.ownerDocument = this.ownerDocument;
             (_a = this.ownerDocument) === null || _a === void 0 ? void 0 : _a.notifyChildAdded(this, newChild, index);
             return newChild;
         }
         throw new Error("HierarchyRequestError");
     }
+    /**
+     * Replaces a child node with a new node.
+     * @param newChild The new node to add.
+     * @param oldChild The child node to be replaced.
+     */
+    replaceChild(newChild, oldChild) {
+        var _a;
+        if (this.model instanceof ModelElement) {
+            const oldModel = oldChild.getModel();
+            const index = this.model.children.indexOf(oldModel);
+            if (index === -1)
+                throw new Error("NotFoundError");
+            // Update Model
+            this.model.children[index] = newChild.getModel();
+            newChild.getModel().parent = this.model;
+            newChild.ownerDocument = this.ownerDocument;
+            // oldModel.parent = null; // Delayed until after notification
+            (_a = this.ownerDocument) === null || _a === void 0 ? void 0 : _a.notifyChildReplaced(this, newChild, oldChild);
+            oldModel.parent = null;
+            return oldChild;
+        }
+        throw new Error("HierarchyRequestError");
+    }
     /**
      * Removes a child node from the DOM and returns the removed node.
      * @param child The child node to remove.
      */
     removeChild(child) {
         var _a;
-        if (this.model instanceof xml_api_model_1.ModelElement) {
+        if (this.model instanceof ModelElement) {
             const childModel = child.getModel();
             const index = this.model.children.indexOf(childModel);
             if (index === -1)
@@ -165,8 +196,7 @@ class Node {
         return this.model;
     }
 }
-exports.Node = Node;
-class NodeList extends Array {
+export class NodeList extends Array {
     constructor(items) {
         super(...items);
         Object.setPrototypeOf(this, NodeList.prototype);
@@ -175,11 +205,10 @@ class NodeList extends Array {
         return this[index] || null;
     }
 }
-exports.NodeList = NodeList;
 /**
  * Base class for Text, Comment, and CDATASection nodes.
  */
-class CharacterData extends Node {
+export class CharacterData extends Node {
     get data() {
         return this.textContent || "";
     }
@@ -190,8 +219,7 @@ class CharacterData extends Node {
         return this.data.length;
     }
 }
-exports.CharacterData = CharacterData;
-class Text extends CharacterData {
+export class Text extends CharacterData {
     get nodeType() {
         return this.TEXT_NODE;
     }
@@ -199,8 +227,7 @@ class Text extends CharacterData {
         return "#text";
     }
 }
-exports.Text = Text;
-class Comment extends CharacterData {
+export class Comment extends CharacterData {
     get nodeType() {
         return this.COMMENT_NODE;
     }
@@ -208,8 +235,7 @@ class Comment extends CharacterData {
         return "#comment";
     }
 }
-exports.Comment = Comment;
-class CDATASection extends CharacterData {
+export class CDATASection extends CharacterData {
     get nodeType() {
         return this.CDATA_SECTION_NODE;
     }
@@ -217,11 +243,10 @@ class CDATASection extends CharacterData {
         return "#cdata-section";
     }
 }
-exports.CDATASection = CDATASection;
 /**
  * Represents an element in the XML document.
  */
-class Element extends Node {
+export class Element extends Node {
     constructor(model, ownerDocument) {
         super(model, ownerDocument);
         this.model = model;
@@ -283,20 +308,26 @@ class Element extends Node {
         return new NodeList(results);
     }
 }
-exports.Element = Element;
 /**
  * Represents the entire XML document.
  */
-class Document extends Node {
+export class Document extends Node {
     constructor() {
         // Document doesn't strictly have a ModelNode parent in this simplified architecture
         // Or it could wrap a "root" ModelElement
         // For now, we'll create a dummy root model or handle it differently
-        super(new xml_api_model_1.ModelElement("#document"), null);
+        super(new ModelElement("#document"), null);
         this._documentElement = null;
         this.observer = null;
+        this.nodeFilter = null;
         this.ownerDocument = this; // Document owns itself
     }
+    /**
+     * Checks if a node is accepted by the current filter.
+     */
+    accepts(node) {
+        return this.nodeFilter ? this.nodeFilter(node) : true;
+    }
     /**
      * Sets the observer to listen for DOM changes.
      */
@@ -323,6 +354,10 @@ class Document extends Node {
         var _a;
         (_a = this.observer) === null || _a === void 0 ? void 0 : _a.onChildRemoved(parent, child, index);
     }
+    notifyChildReplaced(parent, newChild, oldChild) {
+        var _a;
+        (_a = this.observer) === null || _a === void 0 ? void 0 : _a.onChildReplaced(parent, newChild, oldChild);
+    }
     get nodeType() {
         return this.DOCUMENT_NODE;
     }
@@ -339,21 +374,20 @@ class Document extends Node {
             // Ensure the element is part of the document structure
             // In a real DOM, documentElement is a child of Document
             // Here, we just link them logically
-            // @ts-ignore
             element.ownerDocument = this;
         }
     }
     createElement(tagName) {
-        return new Element(new xml_api_model_1.ModelElement(tagName), this);
+        return new Element(new ModelElement(tagName), this);
     }
     createTextNode(data) {
-        return new Text(new xml_api_model_1.ModelText(data), this);
+        return new Text(new ModelText(data), this);
     }
     createComment(data) {
-        return new Comment(new xml_api_model_1.ModelComment(data), this);
+        return new Comment(new ModelComment(data), this);
     }
     createCDATASection(data) {
-        return new CDATASection(new xml_api_model_1.ModelCDATA(data), this);
+        return new CDATASection(new ModelCDATA(data), this);
     }
     querySelector(selector) {
         if (!this.documentElement)
@@ -366,16 +400,15 @@ class Document extends Node {
         return this.documentElement.querySelectorAll(selector);
     }
 }
-exports.Document = Document;
 // Helper factory
-function createWrapper(model, doc) {
-    if (model instanceof xml_api_model_1.ModelElement)
+export function createWrapper(model, doc) {
+    if (model instanceof ModelElement)
         return new Element(model, doc);
-    if (model instanceof xml_api_model_1.ModelText)
+    if (model instanceof ModelText)
         return new Text(model, doc);
-    if (model instanceof xml_api_model_1.ModelComment)
+    if (model instanceof ModelComment)
         return new Comment(model, doc);
-    if (model instanceof xml_api_model_1.ModelCDATA)
+    if (model instanceof ModelCDATA)
         return new CDATASection(model, doc);
     throw new Error(`Unknown model type: ${model.getType()}`);
 }

package/dist/engine/editor-state.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EditorState = void 0;
 /**
  * Represents a snapshot of the editor state at a specific point in time.
  * Includes the source code, the logical model, and the physical CST.
  */
-class EditorState {
+export class EditorState {
     constructor(config) {
         this.source = config.source;
         this.model = config.model;
@@ -29,4 +26,3 @@ class EditorState {
         });
     }
 }
-exports.EditorState = EditorState;

package/dist/engine/sync-engine.d.ts

@@ -1,10 +1,20 @@
+import type { CollabBridge } from "../collab/bridge";
 import type { Grammar } from "../cst/grammar";
 import type { CST } from "../cst/xml-cst";
 import { ModelElement, type ModelNode } from "../model/xml-api-model";
 import { type EventHandler } from "../xml-api-events";
-import type { CollabBridge } from "../collab/bridge";
 import { EditorState } from "./editor-state";
 import { Transaction } from "./transaction";
+/**
+ * The core engine that manages the editor state and coordinates synchronization.
+ *
+ * It implements a transaction-based update cycle:
+ * 1. Receives a `Transaction` describing changes.
+ * 2. Updates the `EditorState` (Source).
+ * 3. Triggers the `Parser` (Source -> CST).
+ * 4. Triggers the `XMLBinder` (CST -> Model).
+ * 5. Notifies listeners (including `SchemaView`s) of changes.
+ */
 export declare class SyncEngine {
     private _state;
     private parser;
@@ -26,30 +36,54 @@ export declare class SyncEngine {
     on(handler: EventHandler): () => void;
     /**
      * Applies a transaction to the engine, updating the state and notifying listeners.
+     * This is the single point of truth for all state transitions in the system.
+     *
+     * It handles:
+     * - History recording (Undo/Redo)
+     * - Incremental Parsing and Reconciliation
+     * - Event Dispatching
+     * - Collaboration hooks
+     *
+     * @param tr The transaction to apply.
      */
     dispatch(tr: Transaction): void;
     /**
      * Update the source code (e.g. from text editor).
      * Handles history recording and incremental parsing.
      */
-    updateSource(from: number, to: number, text: string): void;
+    updateSource(from: number, to: number, text: string, meta?: Record<string, any>): void;
     /**
      * Apply a programmatic change derived from Model operations.
      * This is the "Application -> Source" flow.
+     * @deprecated Use `dispatch(new Transaction(state).replace(...))` instead.
      */
-    applyPatch(start: number, end: number, text: string): void;
+    applyPatch(start: number, end: number, text: string, meta?: Record<string, any>): void;
     undo(): void;
     redo(): void;
-    setAttribute(modelNode: ModelElement, key: string, value: string): void;
-    updateText(modelNode: ModelElement, text: string): void;
-    replaceNode(target: ModelNode, content: ModelNode): void;
-    insertNode(parent: ModelElement, child: ModelNode, index: number): void;
-    removeNode(parent: ModelElement, child: ModelNode): void;
+    /**
+     * @deprecated Use `dispatch(new TransactionBuilder(engine.state, engine.binder).setAttribute(...))` instead.
+     */
+    setAttribute(modelNode: ModelElement, key: string, value: string, meta?: Record<string, any>): void;
+    /**
+     * @deprecated Use `dispatch(new TransactionBuilder(engine.state, engine.binder).updateText(...))` instead.
+     */
+    updateText(modelNode: ModelElement, text: string, meta?: Record<string, any>): void;
+    /**
+     * @deprecated Use `dispatch(new TransactionBuilder(engine.state, engine.binder).replaceNode(...))` instead.
+     */
+    replaceNode(target: ModelNode, content: ModelNode, meta?: Record<string, any>): void;
+    /**
+     * @deprecated Use `dispatch(new TransactionBuilder(engine.state, engine.binder).insertNode(...))` instead.
+     */
+    insertNode(parent: ModelElement, child: ModelNode, index: number, meta?: Record<string, any>): void;
+    /**
+     * @deprecated Use `dispatch(new TransactionBuilder(engine.state, engine.binder).removeNode(...))` instead.
+     */
+    removeNode(parent: ModelElement, child: ModelNode, meta?: Record<string, any>): void;
     private fullParse;
     private tryIncrementalUpdate;
     private updateModelIncremental;
     private findNodeAt;
     private findModelNodePath;
     private updateAncestorsWellFormed;
-    private detectIndent;
 }