@ls-stack/utils 3.11.0 → 3.11.1

package/lib/{xmlSerializer.cjs → serializeXML.cjs}

@@ -17,12 +17,12 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/xmlSerializer.ts
-var xmlSerializer_exports = {};
-__export(xmlSerializer_exports, {
+// src/serializeXML.ts
+var serializeXML_exports = {};
+__export(serializeXML_exports, {
   serializeXML: () => serializeXML
 });
-module.exports = __toCommonJS(xmlSerializer_exports);
+module.exports = __toCommonJS(serializeXML_exports);
 
 // src/arrayUtils.ts
 function filterAndMap(array, mapFilter) {
@@ -38,7 +38,7 @@ function filterAndMap(array, mapFilter) {
   return result;
 }
 
-// src/xmlSerializer.ts
+// src/serializeXML.ts
 var XML_TAG_NAME_REGEX = /^[a-zA-Z_][a-zA-Z0-9._-]*$/;
 var XML_PREFIX_REGEX = /^xml/i;
 var XML_ESCAPE_MAP = {
@@ -50,25 +50,41 @@ var XML_ESCAPE_MAP = {
 };
 var XML_ESCAPE_REGEX = /[&<>"']/g;
 function serializeXML(node, options) {
+  if (Array.isArray(node)) {
+    const EMPTY_LINE_MARKER = "\0EMPTY_LINE\0";
+    return node.map((n) => {
+      if (n.type === "emptyLine") {
+        return EMPTY_LINE_MARKER;
+      }
+      return serializeWithLevel(n, options, 0);
+    }).filter(Boolean).join(options?.indent ? "\n" : "").replace(new RegExp(EMPTY_LINE_MARKER, "g"), "");
+  }
   return serializeWithLevel(node, options, 0);
 }
 function serializeWithLevel(node, options = {}, level) {
-  const { name, attributes = {}, children, escapeText: nodeEscapeText } = node;
   const {
     indent,
     escapeText: globalEscapeText = true,
-    validateTagName = "throw"
+    validateTagName = true,
+    invalidNodes = "throw"
   } = options;
-  const shouldEscapeText = nodeEscapeText !== void 0 ? nodeEscapeText : globalEscapeText;
   const indentStr = indent ? getIndentString(indent, level) : "";
   const newline = indent ? "\n" : "";
-  if (validateTagName) {
-    if (!isValidXmlTagName(name)) {
-      if (validateTagName === "throw") {
-        throw new Error(`Invalid XML tag name: "${name}"`);
-      }
-      return "";
+  if (node.type === "comment") {
+    const shouldEscapeText2 = node.escapeText !== void 0 ? node.escapeText : globalEscapeText;
+    const content = shouldEscapeText2 ? escapeXml(node.content) : node.content;
+    return `${indentStr}<!-- ${content} -->`;
+  }
+  if (node.type === "emptyLine") {
+    return "";
+  }
+  const { name, attributes = {}, children, escapeText: nodeEscapeText } = node;
+  const shouldEscapeText = nodeEscapeText !== void 0 ? nodeEscapeText : globalEscapeText;
+  if (validateTagName && !isValidXmlTagName(name)) {
+    if (invalidNodes === "throw") {
+      throw new Error(`Invalid XML tag name: "${name}"`);
     }
+    return "";
   }
   const attributesStr = filterAndMap(
     Object.entries(attributes),

package/lib/{xmlSerializer.d.cts → serializeXML.d.cts}

@@ -1,14 +1,22 @@
 type XMLNode = {
+    type?: 'node';
     name: string;
     attributes?: Record<string, string | number | boolean | null | undefined>;
     children?: (XMLNode | null | undefined | false)[] | string;
     escapeText?: boolean;
+} | {
+    type: 'comment';
+    content: string;
+    escapeText?: boolean;
+} | {
+    type: 'emptyLine';
 };
 type SerializeOptions = {
     indent?: number | string;
     escapeText?: boolean;
-    validateTagName?: 'throw' | 'reject' | false;
+    validateTagName?: boolean;
+    invalidNodes?: 'throw' | 'reject';
 };
-declare function serializeXML(node: XMLNode, options?: SerializeOptions): string;
+declare function serializeXML(node: XMLNode | XMLNode[], options?: SerializeOptions): string;
 
 export { type SerializeOptions, type XMLNode, serializeXML };

package/lib/{xmlSerializer.d.ts → serializeXML.d.ts}

@@ -1,14 +1,22 @@
 type XMLNode = {
+    type?: 'node';
     name: string;
     attributes?: Record<string, string | number | boolean | null | undefined>;
     children?: (XMLNode | null | undefined | false)[] | string;
     escapeText?: boolean;
+} | {
+    type: 'comment';
+    content: string;
+    escapeText?: boolean;
+} | {
+    type: 'emptyLine';
 };
 type SerializeOptions = {
     indent?: number | string;
     escapeText?: boolean;
-    validateTagName?: 'throw' | 'reject' | false;
+    validateTagName?: boolean;
+    invalidNodes?: 'throw' | 'reject';
 };
-declare function serializeXML(node: XMLNode, options?: SerializeOptions): string;
+declare function serializeXML(node: XMLNode | XMLNode[], options?: SerializeOptions): string;
 
 export { type SerializeOptions, type XMLNode, serializeXML };

package/lib/{xmlSerializer.js → serializeXML.js}

@@ -3,7 +3,7 @@ import {
 } from "./chunk-UTFE4P3P.js";
 import "./chunk-3XCS7FVO.js";
 
-// src/xmlSerializer.ts
+// src/serializeXML.ts
 var XML_TAG_NAME_REGEX = /^[a-zA-Z_][a-zA-Z0-9._-]*$/;
 var XML_PREFIX_REGEX = /^xml/i;
 var XML_ESCAPE_MAP = {
@@ -15,25 +15,41 @@ var XML_ESCAPE_MAP = {
 };
 var XML_ESCAPE_REGEX = /[&<>"']/g;
 function serializeXML(node, options) {
+  if (Array.isArray(node)) {
+    const EMPTY_LINE_MARKER = "\0EMPTY_LINE\0";
+    return node.map((n) => {
+      if (n.type === "emptyLine") {
+        return EMPTY_LINE_MARKER;
+      }
+      return serializeWithLevel(n, options, 0);
+    }).filter(Boolean).join(options?.indent ? "\n" : "").replace(new RegExp(EMPTY_LINE_MARKER, "g"), "");
+  }
   return serializeWithLevel(node, options, 0);
 }
 function serializeWithLevel(node, options = {}, level) {
-  const { name, attributes = {}, children, escapeText: nodeEscapeText } = node;
   const {
     indent,
     escapeText: globalEscapeText = true,
-    validateTagName = "throw"
+    validateTagName = true,
+    invalidNodes = "throw"
   } = options;
-  const shouldEscapeText = nodeEscapeText !== void 0 ? nodeEscapeText : globalEscapeText;
   const indentStr = indent ? getIndentString(indent, level) : "";
   const newline = indent ? "\n" : "";
-  if (validateTagName) {
-    if (!isValidXmlTagName(name)) {
-      if (validateTagName === "throw") {
-        throw new Error(`Invalid XML tag name: "${name}"`);
-      }
-      return "";
+  if (node.type === "comment") {
+    const shouldEscapeText2 = node.escapeText !== void 0 ? node.escapeText : globalEscapeText;
+    const content = shouldEscapeText2 ? escapeXml(node.content) : node.content;
+    return `${indentStr}<!-- ${content} -->`;
+  }
+  if (node.type === "emptyLine") {
+    return "";
+  }
+  const { name, attributes = {}, children, escapeText: nodeEscapeText } = node;
+  const shouldEscapeText = nodeEscapeText !== void 0 ? nodeEscapeText : globalEscapeText;
+  if (validateTagName && !isValidXmlTagName(name)) {
+    if (invalidNodes === "throw") {
+      throw new Error(`Invalid XML tag name: "${name}"`);
     }
+    return "";
   }
   const attributesStr = filterAndMap(
     Object.entries(attributes),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ls-stack/utils",
   "description": "Typescript utils",
-  "version": "3.11.0",
+  "version": "3.11.1",
   "license": "MIT",
   "files": [
     "lib"
@@ -118,6 +118,10 @@
       "import": "./lib/saferTyping.js",
       "require": "./lib/saferTyping.cjs"
     },
+    "./serializeXML": {
+      "import": "./lib/serializeXML.js",
+      "require": "./lib/serializeXML.cjs"
+    },
     "./shallowEqual": {
       "import": "./lib/shallowEqual.js",
       "require": "./lib/shallowEqual.cjs"
@@ -154,10 +158,6 @@
       "import": "./lib/typingUtils.js",
       "require": "./lib/typingUtils.cjs"
     },
-    "./xmlSerializer": {
-      "import": "./lib/xmlSerializer.js",
-      "require": "./lib/xmlSerializer.cjs"
-    },
     "./yamlStringify": {
       "import": "./lib/yamlStringify.js",
       "require": "./lib/yamlStringify.cjs"