xml-model 2.0.0-beta.3 → 2.0.0-beta.4

package/dist/xml/xml-js.d.ts

@@ -120,21 +120,6 @@ export type ParseOptions = IgnoreOptions & ChangingKeyNames & {
      * @default false
      */
     addParent?: boolean;
-    /**
-     * Whether to always wrap sub-elements in an array, even when there is only one.
-     * Pass an array of element names to restrict this behaviour to those names only.
-     * Only applicable in compact mode.
-     * @default false
-     */
-    alwaysArray?: boolean | Array<string>;
-    /**
-     * Whether to always emit an `elements` array even on empty elements.
-     * `<a></a>` becomes `{ elements: [{ type: "element", name: "a", elements: [] }] }`
-     * instead of `{ elements: [{ type: "element", name: "a" }] }`.
-     * Only applicable in non-compact mode.
-     * @default false
-     */
-    alwaysChildren?: boolean;
     /**
      * Whether to parse the contents of processing instructions as attributes.
      * `<?go to="there"?>` becomes `{ go: { attributes: { to: "there" } } }`
@@ -221,14 +206,8 @@ declare function isEmpty(xml: object): xml is XMLVoid;
  */
 declare function getContent(xml: XMLElement): string;
 /**
- * Creates a minimal element structure wrapping the given text content.
- * When no tag name is provided, returns a fragment with a text child.
- * When a tag name is provided, returns a full element with the given name and optional attributes.
- *
+ * Creates a text-only fragment wrapping the given content.
  * @param content - The text content to wrap (defaults to empty string).
- * @param tag - Optional element tag name.
- * @param attributes - Optional attributes; only valid when `tag` is provided.
- * @throws {TypeError} When `attributes` are provided without a `tag`.
  */
 declare function fromContent(content: string): {
     elements: [{
@@ -236,6 +215,12 @@ declare function fromContent(content: string): {
         text: string;
     }] | [];
 };
+/**
+ * Creates a full element wrapping the given text content.
+ * @param content - The text content to wrap (defaults to empty string).
+ * @param tag - Element tag name.
+ * @param attributes - Optional attributes.
+ */
 declare function fromContent(content: string, tag: string, attributes?: XMLElement["attributes"]): {
     type: "element";
     name: string;

package/dist/xml/xml-js.js

@@ -25,14 +25,22 @@ var ZXMLNode = z.discriminatedUnion("type", [
 ]);
 var ZXMLRoot = z.object({ elements: z.array(ZXMLNode) });
 function parse(xml, options = {}) {
-	const strippedOptions = { ...options };
-	delete strippedOptions["compact"];
-	const res = (0, import_lib.xml2js)(xml, strippedOptions);
+	if ("compact" in options) throw new Error("xml-model always uses non-compact mode (compact is forced to false)");
+	if ("alwaysChildren" in options) throw new Error("xml-model always parses with alwaysChildren: true");
+	const res = (0, import_lib.xml2js)(xml, {
+		...options,
+		compact: false,
+		alwaysChildren: true
+	});
 	if ("elements" in res) return res;
 	throw new Error("Got empty XML");
 }
 function stringify(xml, options = {}) {
-	return (0, import_lib.js2xml)(xml, options);
+	if ("compact" in options) throw new Error("xml-model always uses non-compact mode (compact is forced to false)");
+	return (0, import_lib.js2xml)(xml, {
+		...options,
+		compact: false
+	});
 }
 function isRoot(xml) {
 	return Object.keys(xml).length === 1 && "elements" in xml && Array.isArray(xml.elements);
@@ -51,11 +59,11 @@ function isEmpty(xml) {
 * @throws {TypeError} When the element has multiple or non-text children.
 */
 function getContent(xml) {
-	if (xml.elements?.length === 1) {
+	if (!xml.elements.length) return "";
+	if (xml.elements.length === 1) {
 		const content = xml.elements[0];
 		if (content.type === "text") return content.text;
 	}
-	if (!xml.elements) return "";
 	throw new TypeError(`can't get text from XMLElement: ${JSON.stringify(xml)}`);
 }
 function fromContent(content = "", tag, attributes) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xml-model",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.0-beta.4",
   "description": "allows transparent XML <-> Object conversion in typescript",
   "license": "MIT",
   "author": "MathisTLD",