@miy2/xml-api 0.9.0 → 0.9.1

package/dist/xml-api.js

@@ -1,14 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.XMLAPI = void 0;
-const dom_1 = require("./dom");
-const sync_engine_1 = require("./engine/sync-engine");
-const xml_api_model_1 = require("./model/xml-api-model");
+import { createWrapper, Document, Element, } from "./dom";
+import { SyncEngine } from "./engine/sync-engine";
+import { ModelElement } from "./model/xml-api-model";
+import { SchemaView } from "./view/schema-view";
 /**
  * The primary entry point for the XML API.
- * Orchestrates the synchronization between source code (CST) and the logical Model.
+ * Orchestrates the synchronization between source code (CST), the logical Model, and Schema Views.
+ *
+ * This class serves as the central hub for the "Three-Level Reconciliation" architecture:
+ * 1. Source <-> CST: Incremental parsing.
+ * 2. CST <-> Model: Logical binding and identity preservation.
+ * 3. Model <-> View: Schema projection and filtering (via `createView`).
  */
-class XMLAPI {
+export class XMLAPI {
     /**
      * Initializes the API with the source XML string.
      * @param source The initial XML source code.
@@ -16,49 +19,58 @@ class XMLAPI {
      */
     constructor(source, grammar) {
         this.document = null;
-        this.engine = new sync_engine_1.SyncEngine(source, grammar);
+        this._engine = new SyncEngine(source, grammar);
     }
     // --- Read-only State Access ---
+    /** The underlying synchronization engine. */
+    get engine() {
+        return this._engine;
+    }
     /** The current source code string. */
     get source() {
-        return this.engine.source;
-    }
-    /**
-     * Alias for `source` to maintain compatibility with existing tests/demos temporarily.
-     * @deprecated Use `source` instead.
-     */
-    get input() {
-        return this.engine.source;
+        return this._engine.source;
     }
     /** The authoritative logical model. */
     get model() {
-        return this.engine.model;
+        return this._engine.model;
     }
     /** The Concrete Syntax Tree (Physical layer). */
     get cst() {
-        return this.engine.cst;
+        return this._engine.cst;
     }
     /** The grammar used for parsing. */
     get grammar() {
-        return this.engine.grammar;
+        return this._engine.grammar;
     }
     // --- Operations ---
+    /**
+     * Creates a projected view of the document.
+     *
+     * A SchemaView allows you to work with a filtered subset of the document (e.g., only XHTML tags)
+     * while the underlying system maintains full fidelity of the original source (including comments,
+     * custom tags, and formatting) in the background.
+     *
+     * @param config Configuration for the view, including filter logic.
+     * @returns A `SchemaView` instance providing a DOM-like interface for the projected content.
+     */
+    createView(config = {}) {
+        if (!this._engine.model) {
+            throw new Error("Cannot create view: Model not initialized");
+        }
+        return new SchemaView(this._engine.model, this._engine, config);
+    }
     /**
      * Updates the source code directly (e.g. from a text editor).
      * Attempts an optimized incremental update, falling back to full re-parse if needed.
      * @param from Start index of the range to replace.
      * @param to End index of the range.
      * @param text The new text to insert.
+     * @param meta (Optional) Metadata for the transaction.
      */
-    updateSource(from, to, text) {
-        this.engine.updateSource(from, to, text);
-    }
-    /**
-     * Alias for `updateSource` to maintain compatibility.
-     * @deprecated Use `updateSource` instead.
-     */
-    updateInput(from, to, text) {
-        this.updateSource(from, to, text);
+    updateSource(from, to, text, 
+    // biome-ignore lint/suspicious/noExplicitAny: Metadata can store any type
+    meta) {
+        this._engine.updateSource(from, to, text, meta);
     }
     /**
      * Returns a DOM-compatible Document object linked to this API.
@@ -67,11 +79,11 @@ class XMLAPI {
     getDocument() {
         if (this.document)
             return this.document;
-        const doc = new dom_1.Document();
+        const doc = new Document();
         this.document = doc;
         if (this.model) {
-            const rootWrapper = (0, dom_1.createWrapper)(this.model, doc);
-            if (rootWrapper instanceof dom_1.Element) {
+            const rootWrapper = createWrapper(this.model, doc);
+            if (rootWrapper instanceof Element) {
                 doc.documentElement = rootWrapper;
             }
         }
@@ -79,17 +91,17 @@ class XMLAPI {
         doc.setObserver({
             onAttributeChange: (element, name, value) => {
                 const model = element.getModel();
-                if (model instanceof xml_api_model_1.ModelElement) {
+                if (model instanceof ModelElement && model.cst) {
                     if (value === null) {
                         // Attribute removal support needed in Engine/Binder
                         console.warn("Attribute removal not fully supported yet");
                     }
                     else {
-                        this.engine.setAttribute(model, name, value);
+                        this._engine.setAttribute(model, name, value);
                     }
                 }
             },
-            onTextChange: (node, text) => {
+            onTextChange: (_node, _text) => {
                 // Direct text update on CharacterData
                 // Need to find parent element to update properly or support direct node replacement
                 // For now, simple text node update via parent if available
@@ -100,22 +112,33 @@ class XMLAPI {
             },
             onElementTextChange: (element, text) => {
                 const model = element.getModel();
-                if (model instanceof xml_api_model_1.ModelElement) {
-                    this.engine.updateText(model, text);
+                if (model instanceof ModelElement && model.cst) {
+                    this._engine.updateText(model, text);
                 }
             },
             onChildAdded: (parent, child, index) => {
                 const parentModel = parent.getModel();
                 const childModel = child.getModel();
-                if (parentModel instanceof xml_api_model_1.ModelElement) {
-                    this.engine.insertNode(parentModel, childModel, index);
+                if (parentModel instanceof ModelElement && parentModel.cst) {
+                    this._engine.insertNode(parentModel, childModel, index);
                 }
             },
-            onChildRemoved: (parent, child, index) => {
+            onChildRemoved: (parent, child, _index) => {
                 const parentModel = parent.getModel();
                 const childModel = child.getModel();
-                if (parentModel instanceof xml_api_model_1.ModelElement) {
-                    this.engine.removeNode(parentModel, childModel);
+                if (parentModel instanceof ModelElement && parentModel.cst) {
+                    if (childModel.cst) {
+                        this._engine.removeNode(parentModel, childModel);
+                    }
+                }
+            },
+            onChildReplaced: (_parent, newChild, oldChild) => {
+                const newModel = newChild.getModel();
+                const oldModel = oldChild.getModel();
+                // Use replaceNode on the engine.
+                // Even if oldModel is detached from parent, it retains CST info needed for replacement.
+                if (oldModel.cst) {
+                    this._engine.replaceNode(oldModel, newModel);
                 }
             },
         });
@@ -126,27 +149,22 @@ class XMLAPI {
      * Registers an event handler to listen for model changes.
      */
     on(handler) {
-        return this.engine.on(handler);
+        return this._engine.on(handler);
     }
     // --- History ---
     undo() {
-        this.engine.undo();
+        this._engine.undo();
     }
     redo() {
-        this.engine.redo();
-    }
-    // --- Advanced/Legacy Operation Shortcuts (Proxy to Engine) ---
-    /** @deprecated Use DOM interface or Engine directly if needed. */
-    setAttribute(modelNode, key, value) {
-        this.engine.setAttribute(modelNode, key, value);
-    }
-    /** @deprecated Use DOM interface or Engine directly if needed. */
-    updateText(modelNode, text) {
-        this.engine.updateText(modelNode, text);
-    }
-    /** @deprecated Use DOM interface or Engine directly if needed. */
-    replaceNode(target, content) {
-        this.engine.replaceNode(target, content);
+        this._engine.redo();
     }
 }
-exports.XMLAPI = XMLAPI;
+export { CST } from "./cst/xml-cst";
+export { CDATASection, Comment, Document, Element, Node, NodeList, Text, } from "./dom";
+export { EditorState } from "./engine/editor-state";
+export { Transaction } from "./engine/transaction";
+export { ModelCDATA, ModelComment, ModelElement, ModelNode, ModelNodeType, ModelText, } from "./model/xml-api-model";
+export { XMLBinder } from "./model/xml-binder";
+export { SchemaView } from "./view/schema-view";
+export { ViewBinder } from "./view/view-binder";
+export { EventEmitter, } from "./xml-api-events";

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@miy2/xml-api",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "An XML library that faithfully synchronizes documents and AST.",
+  "type": "module",
   "main": "dist/xml-api.js",
   "exports": {
     ".": {
@@ -29,8 +30,9 @@
     "test:all": "jest",
     "docs:dev": "vitepress dev docs",
     "docs:build": "vitepress build docs",
-    "docs:gen-api": "typedoc && ts-node scripts/generate-sidebar.ts",
+    "docs:gen-api": "typedoc && pnpm exec esbuild scripts/generate-sidebar.ts --bundle --platform=node --format=esm --outfile=scripts/generate-sidebar.mjs && pnpm exec node scripts/generate-sidebar.mjs && rm scripts/generate-sidebar.mjs",
     "docs:preview": "vitepress preview docs",
+    "lint": "biome check --write .",
     "format": "biome format --write ."
   },
   "keywords": [

package/LICENSE.md

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright 2026 Kazuya Miyashita
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.