toon-parser 2.0.0 → 2.1.0

package/dist/xml.cjs

@@ -18,6 +18,7 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var xml_exports = {};
 __export(xml_exports, {
+  xmlToJson: () => xmlToJson,
   xmlToToon: () => xmlToToon
 });
 module.exports = __toCommonJS(xml_exports);
@@ -34,6 +35,14 @@ const DEFAULT_XML_OPTIONS = {
   // but users can override this via xmlOptions.
 };
 function xmlToToon(xml, options = {}) {
+  const trimmed = xml.trim();
+  if (!trimmed) {
+    return (0, import_index.jsonToToon)({}, options);
+  }
+  const validation = import_fast_xml_parser.XMLValidator.validate(xml);
+  if (validation !== true) {
+    throw new Error("Malformed XML");
+  }
   const parser = new import_fast_xml_parser.XMLParser({
     ...DEFAULT_XML_OPTIONS,
     ...options.xmlOptions
@@ -41,7 +50,20 @@ function xmlToToon(xml, options = {}) {
   const jsonObj = parser.parse(xml);
   return (0, import_index.jsonToToon)(jsonObj, options);
 }
+function xmlToJson(xml, options = {}) {
+  if (!xml.trim()) return {};
+  const validation = import_fast_xml_parser.XMLValidator.validate(xml);
+  if (validation !== true) {
+    throw new Error("Malformed XML");
+  }
+  const parser = new import_fast_xml_parser.XMLParser({
+    ...DEFAULT_XML_OPTIONS,
+    ...options.xmlOptions
+  });
+  return parser.parse(xml);
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  xmlToJson,
   xmlToToon
 });

package/dist/xml.d.ts

@@ -21,4 +21,5 @@ export interface XmlToToonOptions extends JsonToToonOptions {
  * @returns The resulting TOON string.
  */
 export declare function xmlToToon(xml: string, options?: XmlToToonOptions): string;
+export declare function xmlToJson(xml: string, options?: XmlToToonOptions): unknown;
 //# sourceMappingURL=xml.d.ts.map

package/dist/xml.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"xml.d.ts","sourceRoot":"","sources":["../src/xml.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAc,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE3D,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IACzD;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;CAClC;AAaD;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,MAAM,CAQ7E"}
+{"version":3,"file":"xml.d.ts","sourceRoot":"","sources":["../src/xml.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACtE,OAAO,EAAc,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAE3D,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IACzD;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;CAClC;AAaD;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,MAAM,CAkB7E;AAED,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB,GAAG,OAAO,CAc9E"}

package/dist/xml.edge.test.cjs

@@ -0,0 +1,16 @@
+"use strict";
+var import_xml = require("../src/xml");
+var import_vitest = require("vitest");
+(0, import_vitest.test)("malformed XML throws error", () => {
+  const badXml = "<root><unclosed></root>";
+  (0, import_vitest.expect)(() => (0, import_xml.xmlToJson)(badXml)).toThrow();
+});
+(0, import_vitest.test)("empty XML returns empty object", () => {
+  const empty = "";
+  const result = (0, import_xml.xmlToJson)(empty);
+  (0, import_vitest.expect)(result).toEqual({});
+});
+(0, import_vitest.test)("malformed XML throws in xmlToToon", () => {
+  const badXml = "<root><unclosed></root>";
+  (0, import_vitest.expect)(() => (0, import_xml.xmlToToon)(badXml)).toThrow();
+});

package/dist/xml.js

@@ -1,4 +1,4 @@
-import { XMLParser } from 'fast-xml-parser';
+import { XMLParser, XMLValidator } from 'fast-xml-parser';
 import { jsonToToon } from './index.js';
 const DEFAULT_XML_OPTIONS = {
     ignoreAttributes: false,
@@ -18,6 +18,14 @@ const DEFAULT_XML_OPTIONS = {
  * @returns The resulting TOON string.
  */
 export function xmlToToon(xml, options = {}) {
+    const trimmed = xml.trim();
+    if (!trimmed) {
+        return jsonToToon({}, options);
+    }
+    const validation = XMLValidator.validate(xml);
+    if (validation !== true) {
+        throw new Error('Malformed XML');
+    }
     const parser = new XMLParser({
         ...DEFAULT_XML_OPTIONS,
         ...options.xmlOptions
@@ -25,4 +33,17 @@ export function xmlToToon(xml, options = {}) {
     const jsonObj = parser.parse(xml);
     return jsonToToon(jsonObj, options);
 }
+export function xmlToJson(xml, options = {}) {
+    if (!xml.trim())
+        return {};
+    const validation = XMLValidator.validate(xml);
+    if (validation !== true) {
+        throw new Error('Malformed XML');
+    }
+    const parser = new XMLParser({
+        ...DEFAULT_XML_OPTIONS,
+        ...options.xmlOptions
+    });
+    return parser.parse(xml);
+}
 //# sourceMappingURL=xml.js.map

package/dist/xml.js.map

@@ -1 +1 @@
-{"version":3,"file":"xml.js","sourceRoot":"","sources":["../src/xml.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAc,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAqB,MAAM,YAAY,CAAC;AAgB3D,MAAM,mBAAmB,GAAwB;IAC/C,gBAAgB,EAAE,KAAK;IACvB,mBAAmB,EAAE,IAAI;IACzB,mBAAmB,EAAE,IAAI;IACzB,iBAAiB,EAAE,IAAI;IACvB,gEAAgE;IAChE,4CAA4C;IAC5C,iFAAiF;IACjF,8CAA8C;CAC/C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW,EAAE,UAA4B,EAAE;IACnE,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;QAC3B,GAAG,mBAAmB;QACtB,GAAG,OAAO,CAAC,UAAU;KACtB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAClC,OAAO,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AACtC,CAAC"}
+{"version":3,"file":"xml.js","sourceRoot":"","sources":["../src/xml.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAc,MAAM,iBAAiB,CAAC;AACtE,OAAO,EAAE,UAAU,EAAqB,MAAM,YAAY,CAAC;AAgB3D,MAAM,mBAAmB,GAAwB;IAC/C,gBAAgB,EAAE,KAAK;IACvB,mBAAmB,EAAE,IAAI;IACzB,mBAAmB,EAAE,IAAI;IACzB,iBAAiB,EAAE,IAAI;IACvB,gEAAgE;IAChE,4CAA4C;IAC5C,iFAAiF;IACjF,8CAA8C;CAC/C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW,EAAE,UAA4B,EAAE;IACnE,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IAC3B,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,UAAU,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC9C,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;QAC3B,GAAG,mBAAmB;QACtB,GAAG,OAAO,CAAC,UAAU;KACtB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAClC,OAAO,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,GAAW,EAAE,UAA4B,EAAE;IACnE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,CAAC;IAE3B,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC9C,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC;QAC3B,GAAG,mBAAmB;QACtB,GAAG,OAAO,CAAC,UAAU;KACtB,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC3B,CAAC"}

package/dist/xml.test.cjs

@@ -0,0 +1,86 @@
+"use strict";
+var import_vitest = require("vitest");
+var import_xml = require("./xml");
+(0, import_vitest.describe)("xmlToToon", () => {
+  (0, import_vitest.it)("converts simple XML to TOON", () => {
+    const xml = `<root><key>value</key></root>`;
+    const toon = (0, import_xml.xmlToToon)(xml);
+    (0, import_vitest.expect)(toon).toContain("root:");
+    (0, import_vitest.expect)(toon).toContain("key: value");
+  });
+  (0, import_vitest.it)("handles attributes", () => {
+    const xml = `<user id="123"><name>Alice</name></user>`;
+    const toon = (0, import_xml.xmlToToon)(xml);
+    (0, import_vitest.expect)(toon).toContain('"@_id": 123');
+    (0, import_vitest.expect)(toon).toContain("name: Alice");
+  });
+  (0, import_vitest.it)("handles nested structures", () => {
+    const xml = `
+       <order>
+         <id>99</id>
+         <item>
+           <name>Apple</name>
+           <price>1.5</price>
+         </item>
+         <item>
+           <name>Banana</name>
+           <price>2.0</price>
+         </item>
+       </order>
+     `;
+    const toon = (0, import_xml.xmlToToon)(xml);
+    (0, import_vitest.expect)(toon).toContain("order:");
+    (0, import_vitest.expect)(toon).toContain("item[2]");
+    (0, import_vitest.expect)(toon).toContain("Apple");
+    (0, import_vitest.expect)(toon).toContain("Banana");
+  });
+  (0, import_vitest.it)("allows customizing xml options", () => {
+    const xml = `<data val="true" />`;
+    const toon1 = (0, import_xml.xmlToToon)(xml);
+    const toon2 = (0, import_xml.xmlToToon)(xml, { xmlOptions: { parseAttributeValue: false } });
+    (0, import_vitest.expect)(toon2).toContain('"true"');
+  });
+});
+(0, import_vitest.describe)("Edge Cases", () => {
+  (0, import_vitest.it)("throws or handles invalid XML gracefully (fast-xml-parser usually returns partial or throws)", () => {
+    const xml = `<root><unclosed></root>`;
+    try {
+      const toon = (0, import_xml.xmlToToon)(xml);
+      (0, import_vitest.expect)(typeof toon).toBe("string");
+    } catch (e) {
+      (0, import_vitest.expect)(e).toBeDefined();
+    }
+  });
+  (0, import_vitest.it)("handles CDATA sections", () => {
+    const xml = `<msg><![CDATA[<sender>John</sender>]]></msg>`;
+    const toon = (0, import_xml.xmlToToon)(xml);
+    (0, import_vitest.expect)(toon).toContain("<sender>John</sender>");
+  });
+  (0, import_vitest.it)("handles mixed content (text + child nodes)", () => {
+    const xml = `<p>some <b>bold</b> text</p>`;
+    const toon = (0, import_xml.xmlToToon)(xml);
+    (0, import_vitest.expect)(toon).toContain("#text");
+    (0, import_vitest.expect)(toon).toContain("b: bold");
+  });
+  (0, import_vitest.it)("handles HTML entities", () => {
+    const xml = `<val>Running &amp; Jumping</val>`;
+    const toon = (0, import_xml.xmlToToon)(xml);
+    (0, import_vitest.expect)(toon).toContain("Running & Jumping");
+  });
+  (0, import_vitest.it)("handles numeric-like values preserved as strings if configured", () => {
+    const xml = `<item>007</item>`;
+    const toon = (0, import_xml.xmlToToon)(xml, { xmlOptions: { parseTagValue: false } });
+    (0, import_vitest.expect)(toon).toContain('"007"');
+  });
+  (0, import_vitest.it)("handles empty elements", () => {
+    const xml = `<void />`;
+    const toon = (0, import_xml.xmlToToon)(xml);
+    (0, import_vitest.expect)(toon).toContain('void: ""');
+  });
+  (0, import_vitest.it)("handles namespaces", () => {
+    const xml = `<ns:root xmlns:ns="http://example.com"><ns:child>val</ns:child></ns:root>`;
+    const toon = (0, import_xml.xmlToToon)(xml);
+    (0, import_vitest.expect)(toon).toContain('"ns:root":');
+    (0, import_vitest.expect)(toon).toContain('"ns:child": val');
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "toon-parser",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Safe JSON <-> TOON encoder/decoder with strict validation.",
   "type": "module",
   "main": "dist/index.cjs",
@@ -20,11 +20,15 @@
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "build:types": "tsc -p tsconfig.json --emitDeclarationOnly",
     "build:js": "tsc -p tsconfig.json",
-    "build:cjs": "esbuild src/index.ts src/xml.ts --format=cjs --outdir=dist/cjs --platform=node && node ./scripts/build-copy-cjs-output.js",
+    "build:cjs": "esbuild src/**/*.ts --format=cjs --outdir=dist/cjs --platform=node && node ./scripts/build-copy-cjs-output.js",
     "build": "npm run typecheck && npm run build:types && npm run build:js && npm run build:cjs",
     "clean": "rimraf dist",
     "clean:node": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true })\"",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "lint": "eslint . --ext .ts,.tsx",
+    "verify-docs": "node scripts/verify-docs.js",
+    "test": "vitest --run",
+    "coverage": "vitest --run --coverage"
   },
   "keywords": [
     "json",
@@ -47,12 +51,16 @@
   "sideEffects": false,
   "devDependencies": {
     "fast-check": "^4.3.0",
-    "rimraf": "^6.0.0"
+    "rimraf": "^6.0.0",
+    "eslint": "^9.0.0",
+    "@typescript-eslint/parser": "^8.48.1",
+    "@typescript-eslint/eslint-plugin": "^8.48.1"
   },
   "engines": {
     "node": ">=18"
   },
   "dependencies": {
-    "fast-xml-parser": "^5.3.2"
+    "fast-xml-parser": "^5.3.2",
+    "node-html-parser": "^7.0.1"
   }
-}
+}