xml-stream-editor 0.1.0

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -0,0 +1,171 @@
+xml-stream-editor
+===
+
+Library to edit xml files in a streaming manner. Inspired by
+[xml-stream](https://www.npmjs.com/package/xml-stream), but 1. allows using
+current node versions, and 2. provides a higher level, easier to use API.
+
+The main benefit of `xml-stream-editor` over most other existing
+(and otherwise excellent) libraries for editing XML is that `xml-stream-editor`
+allows you to modify XML without needing to buffer the XML files in memory.
+For small to mid-sized XML files buffering is fine. But when editing very large
+files (e.g., multi-Gb files) buffering can be a problem or an absolute blocker.
+
+Usage
+---
+
+`xml-stream-editor` is designed to be used with node's stream systems
+by subclassing [`stream.Transform`](https://nodejs.org/api/stream.html#class-streamtransform),
+so it can be used with the [streams promises API](https://nodejs.org/api/stream.html#streams-promises-api)
+and stdlib interfaces like [`stream.pipeline`](https://nodejs.org/api/stream.html#streampipelinestreams-options).
+
+The main way to use `xml-stream-editor` is to 1. select which XML elements
+you want to edit using simple declarative selectors (like _very_ simple XPath
+rules or CSS selectors), and 2. write functions to be called with each
+matching XML element in the document. Those functions then either edit and
+return the provided element, or remove the element from the document
+by returning nothing.
+
+Example
+---
+
+Start with this input as `simpsons.xml`:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<simpsons decade="90s" locale="US">
+    <main>
+        <character sex="female">Marge Simpson</character>
+        <character sex="male">Homer Simpson</character>
+        <character sex="female">Lisa Simpson</character>
+        <character sex="male">Bart Simpson</character>
+    </main>
+    <side>
+        <character sex="male">Disco Stu</character>
+        <character sex="male" title="Dr.">Julius Hibbert</character>
+    </side>
+</simpsons>
+```
+
+You can edit in a streaming manner like this:
+
+```javascript
+import { createReadStream } from 'node:fs'
+import { pipeline } from 'node:stream/promises'
+import { createXMLEditor, newElement } from 'xml-stream-editor'
+
+(async () => {
+    const config = {
+        // Map element selectors to editing functions
+        "main character": (elm) => {
+            switch (elm.text) {
+                case "Marge Simpson":
+                    elm.attributes["hair"] = "blue"
+                    break
+                case "Homer Simpson":
+                    elm.text += " (Sr.)"
+                    break
+                case "Lisa Simpson":
+                    elm.text = ""
+
+                    const instrumentElm = newElement("instrument")
+                    instrumentElm.text = "saxophone"
+                    elm.children.push(instrumentElm)
+
+                    const nameElm = newElement("name")
+                    nameElm.text = "Lisa Simpson"
+                    elm.children.push(nameElm)
+                    break
+                case "Bart Simpson":
+                    // Remove the node by not returning an element.
+                    return
+            }
+            return elm
+        }
+    }
+    await pipeline(
+        createReadStream("simpsons.xml"), // above example
+        createXMLEditor(config),
+        process.stdout
+    )
+})()
+```
+
+And you'll find this printed to `STDOUT` (reformatted):
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<simpsons decade="90s" locale="US">
+  <main>
+    <character sex="female" hair="blue">Marge Simpson</character>
+    <character sex="male">Homer Simpson (Sr.)</character>
+    <character sex="female">
+      <instrument>saxophone</instrument>
+      <name>Lisa Simpson</name>
+    </character>
+    <character sex="female">Maggie Simpson</character>
+  </main>
+  <side>
+    <character sex="male">Disco Stu</character>
+    <character sex="male" title="Dr.">Julius Hibbert</character>
+  </side>
+</simpsons>
+```
+
+Notes
+---
+
+Nested editing functions are not supported. You can define as many editing
+rules as you'd like, but only one rule can be matching the xml document
+at a time as its being streamed. So anytime a selector is matching part of a
+document that is already matched by a parent rule, that child rule will
+not be applied.
+
+For example (using to the same example XML document as above):
+
+```javascript
+import { createReadStream } from 'node:fs'
+import { pipeline } from 'node:stream/promises'
+import { createXMLEditor, newElement } from 'xml-stream-editor'
+
+(async () => {
+    const config = {
+        // This rule will match first, since the "main" element will be
+        // identified first during parsing.
+        "main character": (elm) => {
+            // editing goes here
+            return elm
+        },
+        // And as a result, this rule will never be applied during editing
+        // (since anytime "character" would match a <character> element,
+        // that <character> element will have already been matched by the
+        // above "main character" selector.
+        "character": (elm) => {
+            // this function would never be called in this document.
+            return elm
+        },
+    }
+    await pipeline(
+        createReadStream("simpsons.xml"), // above example
+        createXMLEditor(config),
+        process.stdout
+    )
+})()
+```
+
+Motivation
+---
+
+`xml-stream-editor` was built to handle the extremely large XML files
+generated by [Brave Software's PageGraph system](https://github.com/brave/brave-browser/wiki/PageGraph),
+which records both a broad range of actions that occur when loading a web page
+(e.g.,, an image sub-resource being loaded, a WebAPI being called, a HTML
+element being added to the DOM), but also the actor in the page that is
+responsible for that action (e.g., the `<img>` element that included the image,
+the `<script>` element calling the WebAPI, the `<script>` element creating
+and modifying the HTML element).
+
+**PageGraph** records this information in [GraphML](http://graphml.graphdrawing.org/)
+format, an XML format for encoding directed graphs. These GraphML files
+can get enormous quickly (multiple Gb), and so, a streaming system for editing
+these files was needed.

package/dist/index.js

@@ -0,0 +1,2 @@
+import { createXMLEditor, newElement, } from './xml-stream-editor.js';
+export { createXMLEditor, newElement, };

package/dist/markup.js

@@ -0,0 +1,22 @@
+import xmlescape from 'xml-escape';
+import xnv from 'xml-name-validator';
+export const isValidName = xnv.name;
+export const toAttrValue = (value) => {
+    return xmlescape(value);
+};
+export const toOpenTag = (nodeName, attributes) => {
+    let string = '<' + nodeName;
+    if (attributes) {
+        for (const [attrName, attrValue] of Object.entries(attributes)) {
+            string += ` ${attrName}="${xmlescape(attrValue)}"`;
+        }
+    }
+    string += '>';
+    return string;
+};
+export const toCloseTag = (nodeName) => {
+    return `</${nodeName}>`;
+};
+export const toBodyText = (text) => {
+    return xmlescape(text);
+};

package/dist/xml-stream-editor.js

@@ -0,0 +1,218 @@
+import { strict as assert } from 'node:assert';
+import { Transform } from 'node:stream';
+import { SaxesParser } from 'saxes';
+import { isValidName, toAttrValue, toBodyText, toCloseTag, toOpenTag } from './markup.js';
+export const newElement = (name) => {
+    if (isValidName(name) === false) {
+        throw new Error(`"${name}" is not a valid XML element name`);
+    }
+    return {
+        name: name,
+        text: undefined,
+        attributes: {},
+        children: [],
+    };
+};
+const cloneElement = (elm) => {
+    const newElm = newElement(elm.name);
+    newElm.text = elm.text;
+    newElm.attributes = JSON.parse(JSON.stringify(elm.attributes));
+    newElm.children = elm.children.map(cloneElement);
+    return newElm;
+};
+const elementForNode = (node) => {
+    // Here we check if each attribute name is simple (and so just a
+    // string), or in the namespace representation the "saxes" library
+    // uses (in which case attrValue will be a SaxesAttributeNS
+    // object, that we have to unpack a bit)
+    const attributes = {};
+    if (node.attributes) {
+        for (const [attrName, attrValue] of Object.entries(node.attributes)) {
+            if (typeof attrValue === 'string') {
+                attributes[attrName] = attrValue;
+                continue;
+            }
+            attributes[attrValue.name] = attrValue.value;
+        }
+    }
+    return elementForNameAndAttrs(node.name, attributes);
+};
+const elementForNameAndAttrs = (name, attrs) => {
+    const newElm = newElement(name);
+    if (attrs) {
+        newElm.attributes = attrs;
+    }
+    return newElm;
+};
+class XMLStreamEditorTransformer extends Transform {
+    // Used to track how deep in the XML tree the parser is, so that we can
+    // check newly parsed elements against the passed editor rules.
+    #elmStack = [];
+    // This is a map of (VERY) simple xpaths (i.e., only XML element names;
+    // no attributes, no name spaces, etc).
+    #config;
+    // Handle to the 'saxes' xml parser object.
+    #xmlParser;
+    // If set, tracks the current element in the parser stack that matches
+    // a user-provided selector, and the corresponding editor function
+    // the user provided.
+    #elmToEditInfo;
+    // Store any errors we've been passed by the saxes parser so that we
+    // can pass it along in the transformer callback next time we get data.
+    #error;
+    // Checks to see if the current editor stack (which tracks the current
+    // element being parsed in the input XML stream, along with its parent
+    // elements) matches any of the passed editor rules.
+    #doesStackMatchEditorRule() {
+        const currentElementPath = this.#elmStack.map(x => x.name).join(' ');
+        for (const [selector, editorFunc] of Object.entries(this.#config)) {
+            if (currentElementPath.endsWith(selector)) {
+                // The depth of the root of this subtree in the stack
+                const depth = this.#elmStack.length - 1;
+                assert(depth >= 0);
+                const elmToEdit = this.#elmStack[depth];
+                return { selector: selector, func: editorFunc, element: elmToEdit };
+            }
+        }
+        return null;
+    }
+    #isInSubtreeToBeEdited() {
+        return this.#elmToEditInfo !== undefined;
+    }
+    #writeElementToStream(element) {
+        this.push(toOpenTag(element.name, element.attributes));
+        if (element.text) {
+            this.push(toBodyText(element.text));
+        }
+        for (const childElm of element.children) {
+            this.#writeElementToStream(childElm);
+        }
+        this.push(toCloseTag(element.name));
+    }
+    #writeSubtreeToStream() {
+        assert(this.#elmToEditInfo);
+        const clonedElm = cloneElement(this.#elmToEditInfo.element);
+        try {
+            const editedElm = this.#elmToEditInfo.func(clonedElm);
+            if (editedElm) {
+                this.#writeElementToStream(editedElm);
+            }
+            this.#elmToEditInfo = undefined;
+        }
+        catch (e) {
+            this.#error = e;
+            this.#xmlParser.close();
+        }
+    }
+    #configureParserCallbacks() {
+        this.#xmlParser.on('opentag', (node) => {
+            // When we hit a new XML opening tag, the following cases are possible:
+            //
+            // 1. We're a CHILD in a subtree to be edited, in which case we can
+            //    avoid a little work and just append ourselves to the stack.
+            // 2. We are the ROOT of an subtree to be edited, in which case we
+            //    note the current callback function we'll eventually get passed to,
+            //    and append ourselves to the stack.
+            // 3. We are NOT the root of a subtree to be edited, in which case
+            //    we just add ourselves to the stack.
+            const newElement = elementForNode(node);
+            this.#elmStack.push(newElement);
+            // Check for case one
+            if (this.#isInSubtreeToBeEdited()) {
+                return;
+            }
+            // Check for case two, if we're at the root of a subtree to edit.
+            const matchingElementInfo = this.#doesStackMatchEditorRule();
+            if (matchingElementInfo !== null) {
+                this.#elmToEditInfo = matchingElementInfo;
+                return;
+            }
+            // Otherwise we're in case three, so print out the opening tag
+            // immediately.
+            this.push(toOpenTag(newElement.name, newElement.attributes));
+        });
+        this.#xmlParser.on('text', (text) => {
+            // There are two possible cases here
+            //
+            // 1. We're in a subtree to be edited, in which case we buffer
+            //    the text, or
+            // 2. We're not in the subtree being edited, in which case we can
+            //    print the text out immediately.
+            // Check for case one
+            if (this.#isInSubtreeToBeEdited()) {
+                const topOfStack = this.#elmStack.at(-1);
+                assert(topOfStack);
+                topOfStack.text = text;
+                return;
+            }
+            // Otherwise we're in case two, and can print the text out immediately.
+            this.push(toBodyText(text));
+        });
+        this.#xmlParser.on('xmldecl', (decl) => {
+            let xmlDecl = '<?xml version="1.0"';
+            if (decl.encoding) {
+                xmlDecl += ` encoding="${toAttrValue(decl.encoding)}"`;
+            }
+            if (decl.standalone) {
+                xmlDecl += ` standalone="${toAttrValue(decl.standalone)}"`;
+            }
+            xmlDecl += '?>';
+            this.push(xmlDecl);
+        });
+        this.#xmlParser.on('error', (error) => {
+            this.#error = error;
+        });
+        this.#xmlParser.on('closetag', (node) => {
+            // When we hit an XML element's close tag, three cases are possible.
+            //
+            // 1. We've completed a node that is NOT in a subtree with an assigned
+            //    editing function. In that case we write the element as XML
+            //    to the write stream and pop it off the stack.
+            // 2. We've completed a ROOT NODE in a subtree being edited,
+            //    in which case we pass that buffered subtree to the registered
+            //    editing function, write the modified subtree as XML to the
+            //    write stream, loose the reference to the buffered subtree,
+            //    and pop the element off the stack too.
+            // 3. We've completed a CHILD NODE in a subtree being edited,
+            //    in which case we append this node to our buffered subtree
+            //    and pop it off the stack.
+            const completedElm = this.#elmStack.pop();
+            assert(completedElm);
+            // Check for case one
+            if (this.#isInSubtreeToBeEdited() === false) {
+                this.push(toCloseTag(node.name));
+                return;
+            }
+            // Check for case two
+            assert(this.#elmToEditInfo);
+            if (completedElm === this.#elmToEditInfo.element) {
+                this.#writeSubtreeToStream();
+                return;
+            }
+            // Otherwise, we must be in case three
+            assert(this.#elmStack.length > 0);
+            this.#elmStack.at(-1)?.children.push(completedElm);
+        });
+    }
+    constructor(config, saxesOptions) {
+        super();
+        this.#config = config;
+        this.#xmlParser = new SaxesParser(saxesOptions);
+        this.#configureParserCallbacks();
+    }
+    _transform(chunk, encoding, callback) {
+        if (this.#error) {
+            callback(this.#error);
+            return;
+        }
+        this.#xmlParser.write(chunk);
+        if (this.#error) {
+            callback(this.#error);
+            return;
+        }
+        callback();
+    }
+}
+export const createXMLEditor = (config, saxesOptions) => {
+    return new XMLStreamEditorTransformer(config, saxesOptions);
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "xml-stream-editor",
+  "version": "0.1.0",
+  "description": "A streaming xml editor.",
+  "main": "dist/index.js",
+  "files": [
+    "dist/*",
+    "src/types.d.ts"
+  ],
+  "scripts": {
+    "build": "npx tsc",
+    "clean": "rm dist/* || true",
+    "lint": "npx eslint src/**/*.ts src/*.ts",
+    "lint:fix": "npx eslint --fix src/**/*.ts src/*.ts",
+    "test": "npx mocha test/xml-stream-editor.test.js"
+  },
+  "type": "module",
+  "types": "src/types.d.ts",
+  "repository": {
+    "url": "https://github.com/pes10k/xml-stream-editor.git"
+  },
+  "keywords": [
+    "xml",
+    "streams"
+  ],
+  "author": "Peter Snyder <pes@peteresnyder.com> (https://www.peteresnyder.com)",
+  "license": "MPL-2.0",
+  "bugs": {
+    "url": "https://github.com/pes10k/xml-stream-editor/issues"
+  },
+  "homepage": "https://github.com/pes10k/xml-stream-editor#readme",
+  "devDependencies": {
+    "@stylistic/eslint-plugin": "^5.7.0",
+    "@tsconfig/node24": "^24.0.4",
+    "@types/node": "^25.0.10",
+    "@types/xml-escape": "^1.1.3",
+    "@types/xml-name-validator": "^4.0.3",
+    "eslint": "^9.39.2",
+    "mocha": "^11.3.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.53.1",
+    "xml2js": "^0.6.2"
+  },
+  "dependencies": {
+    "saxes": "^6.0.0",
+    "xml-escape": "^1.1.0",
+    "xml-name-validator": "^5.0.0"
+  }
+}

package/src/types.d.ts

@@ -0,0 +1,17 @@
+import { Transform } from 'node:stream'
+
+import { SaxesOptions } from 'saxes'
+
+export declare interface Element {
+  name: string
+  text?: string
+  attributes: Record<string, string>
+  children: Element[]
+}
+
+export type Selector = string
+export type EditorFunc = (elm: Element) => Element | undefined
+export type Config = Record<Selector, EditorFunc>
+export declare const newElement: (name: string) => Element
+export declare const createXMLEditor: (
+  config: Config, saxesOptions?: SaxesOptions) => Transform