Merge branch 'mdovhopo-master'

Author: oozcitak

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project are documented in this file. This project adheres to [Semantic Versioning](http://semver.org/#semantic-versioning-200).
 
+## [4.0.3] - 2025-11-01
+
+### Bug Fixes
+
+- Fixed a bug where text-only element nodes were printed on new lines in callback mode (see [#94](https://github.com/oozcitak/xmlbuilder2/issues/94)).
+
 ## [4.0.2] - 2025-11-01
 
 ### Features
@@ -329,6 +335,7 @@ All notable changes to this project are documented in this file. This project ad
 [3.0.2]: https://github.com/oozcitak/xmlbuilder2/compare/v3.0.1...v3.0.2
 [3.1.0]: https://github.com/oozcitak/xmlbuilder2/compare/v3.0.2...v3.1.0
 [3.1.1]: https://github.com/oozcitak/xmlbuilder2/compare/v3.1.0...v3.1.1
-[4.0.0]: https://github.com/oozcitak/xmlbuilder2/compare/v3.1.1...v4.0.0
+[4.0.0]: https://github.com/oozcitak/xmlbuilder2/compare/v3.1.0...v4.0.0
 [4.0.1]: https://github.com/oozcitak/xmlbuilder2/compare/v4.0.0...v4.0.1
-[4.0.2]: https://github.com/oozcitak/xmlbuilder2/compare/v4.0.1...v4.0.2
+[4.0.2]: https://github.com/oozcitak/xmlbuilder2/compare/v4.0.1...v4.0.2
+[4.0.3]: https://github.com/oozcitak/xmlbuilder2/compare/v4.0.2...v4.0.3

package.json

@@ -1,6 +1,6 @@
 {
   "name": "xmlbuilder2",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "keywords": [
     "xml",
     "xmlbuilder"

src/builder/XMLBuilderCBImpl.ts

@@ -46,19 +46,24 @@ export class XMLBuilderCBImpl extends EventEmitter implements XMLBuilderCB {
   private _hasDocumentElement = false
   private _currentElement?: XMLBuilder
   private _currentElementSerialized = false
-  private _openTags: Array<[string, string | null, NamespacePrefixMap, boolean]> = []
-
+  private _openTags: Array<[
+    string,             // qualified name
+    string | null,      // original inherited ns
+    NamespacePrefixMap, // original prefix map
+    boolean,            // has children,
+    boolean | undefined // has text payload
+  ]> = []
   private _prefixMap: NamespacePrefixMap
   private _prefixIndex: PrefixIndex
 
   private _ended = false
 
   /**
    * Initializes a new instance of `XMLStream`.
-   * 
+   *
    * @param options - stream writer options
    * @param fragment - whether to create fragment stream or a document stream
-   * 
+   *
    * @returns XML stream
    */
   public constructor(options?: XMLBuilderCBCreateOptions, fragment = false) {
@@ -217,6 +222,11 @@ export class XMLBuilderCBImpl extends EventEmitter implements XMLBuilderCB {
       .replace(/>/g, '&gt;')
 
     this._push(this._writer.text(markup))
+    const lastEl = this._openTags[this._openTags.length - 1]
+    // edge case: text on top level.
+    if (lastEl) {
+      lastEl[lastEl.length - 1] = true
+    }
     return this
   }
 
@@ -361,7 +371,7 @@ export class XMLBuilderCBImpl extends EventEmitter implements XMLBuilderCB {
 
   /**
    * Serializes the opening tag of an element node.
-   * 
+   *
    * @param hasChildren - whether the element node has child nodes
    */
   private _serializeOpenTag(hasChildren: boolean): void {
@@ -478,7 +488,7 @@ export class XMLBuilderCBImpl extends EventEmitter implements XMLBuilderCB {
      * Save qualified name, original inherited ns, original prefix map, and
      * hasChildren flag.
      */
-    this._openTags.push([qualifiedName, inheritedNS, this._prefixMap, hasChildren])
+    this._openTags.push([qualifiedName, inheritedNS, this._prefixMap, hasChildren, undefined])
 
     /**
      * New values of inherited namespace and prefix map will be used while
@@ -507,20 +517,20 @@ export class XMLBuilderCBImpl extends EventEmitter implements XMLBuilderCB {
       return
     }
 
-    const [qualifiedName, ns, map, hasChildren] = lastEle
+    const [qualifiedName, ns, map, hasChildren, hasTextPayload] = lastEle
     /**
      * Restore original values of inherited namespace and prefix map.
      */
     this._prefixMap = map
     if (!hasChildren) return
 
-    this._push(this._writer.closeTag(qualifiedName))
+    this._push(this._writer.closeTag(qualifiedName, hasTextPayload))
     this._writer.endElement(qualifiedName)
   }
 
   /**
    * Pushes data to internal buffer.
-   * 
+   *
    * @param data - data
    */
   private _push(data: string | null): void {
@@ -537,7 +547,7 @@ export class XMLBuilderCBImpl extends EventEmitter implements XMLBuilderCB {
 
   /**
    * Reads and serializes an XML tree.
-   * 
+   *
    * @param node - root node
    */
   private _fromNode(node: Node) {
@@ -573,7 +583,7 @@ export class XMLBuilderCBImpl extends EventEmitter implements XMLBuilderCB {
 
   /**
    * Produces an XML serialization of the attributes of an element node.
-   * 
+   *
    * @param node - node to serialize
    * @param map - namespace prefix map
    * @param prefixIndex - generated namespace prefix index
@@ -639,7 +649,7 @@ export class XMLBuilderCBImpl extends EventEmitter implements XMLBuilderCB {
             (!map.hasPrefix(attr.prefix) ||
               map.has(attr.prefix, attributeNamespace))) {
             /**
-             * Check if we can use the attribute's own prefix.  
+             * Check if we can use the attribute's own prefix.
              * We deviate from the spec here.
              * TODO: This is not an efficient way of searching for prefixes.
              * Follow developments to the spec.
@@ -669,7 +679,7 @@ export class XMLBuilderCBImpl extends EventEmitter implements XMLBuilderCB {
 
   /**
    * Produces an XML serialization of an attribute value.
-   * 
+   *
    * @param value - attribute value
    * @param requireWellFormed - whether to check conformance
    */
@@ -688,12 +698,12 @@ export class XMLBuilderCBImpl extends EventEmitter implements XMLBuilderCB {
   }
 
   /**
-   * Records namespace information for the given element and returns the 
+   * Records namespace information for the given element and returns the
    * default namespace attribute value.
-   * 
+   *
    * @param node - element node to process
    * @param map - namespace prefix map
-   * @param localPrefixesMap - local prefixes map  
+   * @param localPrefixesMap - local prefixes map
    */
   private _recordNamespaceInformation(node: Element, map: NamespacePrefixMap,
     localPrefixesMap: { [key: string]: string }): string | null {
@@ -732,7 +742,7 @@ export class XMLBuilderCBImpl extends EventEmitter implements XMLBuilderCB {
 
   /**
    * Generates a new prefix for the given namespace.
-   * 
+   *
    * @param newNamespace - a namespace to generate prefix for
    * @param prefixMap - namespace prefix map
    * @param prefixIndex - generated namespace prefix index
@@ -748,7 +758,7 @@ export class XMLBuilderCBImpl extends EventEmitter implements XMLBuilderCB {
 
   /**
    * Determines if the namespace prefix map was modified from its original.
-   * 
+   *
    * @param originalMap - original namespace prefix map
    * @param newMap - new namespace prefix map
    */

src/writers/BaseCBWriter.ts

@@ -103,6 +103,7 @@ export abstract class BaseCBWriter<T extends BaseCBWriterOptions> {
    * 
    * @param name - node name
    */
+  abstract closeTag(name: string, hasTextPayload?: boolean): string
   abstract closeTag(name: string): string
 
   /**

src/writers/XMLCBWriter.ts

@@ -55,7 +55,7 @@ export class XMLCBWriter extends BaseCBWriter<XMLCBWriterOptions> {
   }
   /** @inheritdoc */
   text(data: string): string {
-    return this._beginLine() + data
+    return data
   }
   /** @inheritdoc */
   instruction(target: string, data: string): string {
@@ -91,8 +91,9 @@ export class XMLCBWriter extends BaseCBWriter<XMLCBWriterOptions> {
     }
   }
   /** @inheritdoc */
-  closeTag(name: string): string {
-    return this._beginLine() + "</" + name + ">"
+  closeTag(name: string, hasTextPayload?: boolean): string {
+    const ending = hasTextPayload ? '' : this._beginLine();
+    return ending + "</" + name + ">";
   }
   /** @inheritdoc */
   attribute(name: string, value: string): string {

test/callback/object.test.ts

@@ -35,40 +35,24 @@ $$.suite('object', () => {
 
     await $$.expectCBResult(xmlStream, $$.t`
     <root>
-      <ele>
-        simple element
-      </ele>
+      <ele>simple element</ele>
       <person age="35">
-        <name>
-          John
-        </name>
+        <name>John</name>
         <?pi val?>
         <?pi?>
         <!--Good guy-->
         <![CDATA[well formed!]]>
         <address>
           <?pi?>
-          <city>
-            Istanbul
-          </city>
-          <street>
-            End of long and winding road
-          </street>
+          <city>Istanbul</city>
+          <street>End of long and winding road</street>
         </address>
         <contact>
-          <phone>
-            555-1234
-          </phone>
-          <phone>
-            555-1235
-          </phone>
+          <phone>555-1234</phone>
+          <phone>555-1235</phone>
         </contact>
-        <id>
-          42
-        </id>
-        <details>
-          classified
-        </details>
+        <id>42</id>
+        <details>classified</details>
       </person>
     </root>
     `)

test/callback/parse.test.ts

@@ -10,9 +10,7 @@ $$.suite('parse()', () => {
     xmlStream.ele(str).end()
 
     await $$.expectCBResult(xmlStream, $$.t`
-    <root att="val">
-      text
-    </root>
+    <root att="val">text</root>
     `)
   })
 

test/issues/issue-002.test.ts

@@ -24,20 +24,12 @@ $$.suite("Replicate issue", () => {
     <?xml version="1.0"?>
     <rss>
       <item>
-        <sku>
-          001
-        </sku>
-        <name>
-          Product name 1
-        </name>
+        <sku>001</sku>
+        <name>Product name 1</name>
       </item>
       <item>
-        <sku>
-          002
-        </sku>
-        <name>
-          Product name 2
-        </name>
+        <sku>002</sku>
+        <name>Product name 2</name>
       </item>
     </rss>
     `)

test/issues/issue-078.test.ts

@@ -28,9 +28,7 @@ $$.suite("Replicate issue", () => {
     await $$.expectCBResult(xmlStream, $$.t`
     <root>
       <title/>
-      <description>
-        Test description
-      </description>
+      <description>Test description</description>
     </root>
     `)
   })