@amazon/vinyl-xml 1.0.0

package/dist/types/current/xml/ParseXmlHandlerImpl.js

@@ -0,0 +1,198 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { clone, decodeEntities, IllegalStateError, last, substitute, toJson, } from '@amazon/vinyl-util';
+import { EmptyRules, mapXmlRules, xmlRuleKey } from './mappedXmlRules';
+import { XmlSchemaError, xmlSchemaErrorLocale } from './XmlSchemaError';
+/**
+ * Choose the rule using namespaces first, if there is no match, query the wildcard namespace rules.
+ */
+function getRule(name, rules) {
+    return rules.get(xmlRuleKey(name.localPart, name.namespaceUri));
+}
+/**
+ * A {@link ParseXmlHandler} implementation that follows {@link XmlRules}, building an object of
+ * the parameterized type.
+ */
+export class ParseXmlHandlerImpl {
+    rules;
+    stack = [];
+    options;
+    busy = false;
+    constructor(rules, options) {
+        this.rules = rules;
+        this.options = { validateRules: true, ...options };
+    }
+    startDocument() {
+        if (this.busy)
+            throw new IllegalStateError('XML content handler is busy');
+        this.busy = true;
+        const rules = this.rules;
+        this.stack.push({
+            element: new XmlElementImpl(),
+            rules,
+            characters: '',
+        });
+    }
+    startElement(name, attributes) {
+        const parent = last(this.stack);
+        let element = null;
+        const elementRule = getRule(name, parent.rules.elements);
+        const rules = elementRule?.rules() ?? EmptyRules;
+        if (elementRule) {
+            const prop = elementRule.property;
+            element = new XmlElementImpl(parent.element);
+            if (elementRule.array) {
+                const arr = parent.element[prop];
+                if (Array.isArray(arr)) {
+                    arr.push(element);
+                }
+                else {
+                    parent.element[prop] = [element];
+                }
+            }
+            else {
+                if (parent.element[prop]) {
+                    throw new XmlSchemaError(`Expected single element with name ${name.qName}`);
+                }
+                else {
+                    parent.element[prop] = element;
+                }
+            }
+            const attributeRules = rules.attributes;
+            for (const k in attributes) {
+                const attribute = attributes[k];
+                const name = attribute.name;
+                const attributeRule = getRule(name, attributeRules);
+                if (attributeRule) {
+                    element[attributeRule.property] = attributeRule.parse(attribute.value);
+                }
+            }
+            // Set attribute defaults:
+            attributeRules.forEach((_value, key) => {
+                const rule = attributeRules.get(key);
+                if (!(rule.property in element)) {
+                    if (rule.default != null) {
+                        element[rule.property] = rule.default;
+                    }
+                    else if (this.options.validateRules && rule.required) {
+                        throw new XmlSchemaError(substitute(xmlSchemaErrorLocale.requiredAttribute, {
+                            property: rule.property,
+                        }));
+                    }
+                }
+            });
+        }
+        this.stack.push({
+            element,
+            rules,
+            characters: '',
+        });
+    }
+    textNode(str) {
+        const current = last(this.stack);
+        if (!current.rules.characters)
+            return;
+        current.characters += decodeEntities(str.trim());
+    }
+    cDataNode(str) {
+        const current = last(this.stack);
+        if (!current.rules.characters)
+            return;
+        current.characters += str;
+    }
+    endElement() {
+        const lastEl = this.stack.pop();
+        const charactersRule = lastEl.rules.characters;
+        if (charactersRule)
+            lastEl.element[charactersRule.property] = charactersRule.parse(lastEl.characters);
+        lastEl.rules.elements.forEach((rule) => {
+            if (rule.array && !(rule.property in lastEl.element)) {
+                if (rule.useEmptyArrays) {
+                    lastEl.element[rule.property] = [];
+                }
+            }
+        });
+        this.validate(lastEl);
+    }
+    endDocument() {
+        this.busy = false;
+        const last = this.stack.pop();
+        this.validate(last);
+        return last.element;
+    }
+    validate(current) {
+        if (!this.options.validateRules)
+            return;
+        current.rules.elements.forEach((rule) => {
+            const length = rule.array
+                ? (current.element[rule.property]?.length ?? 0)
+                : current.element[rule.property]
+                    ? 1
+                    : 0;
+            if (length < rule.minOccurs) {
+                throw new XmlSchemaError(substitute(xmlSchemaErrorLocale.atLeastElements, {
+                    property: rule.property,
+                    expected: rule.minOccurs,
+                    actual: length,
+                }));
+            }
+            if (rule.maxOccurs != null && length > rule.maxOccurs) {
+                throw new XmlSchemaError(substitute(xmlSchemaErrorLocale.atMostElements, {
+                    property: rule.property,
+                    expected: rule.maxOccurs,
+                    actual: length,
+                }));
+            }
+        });
+    }
+}
+/**
+ * Creates an XML content handler for the given parsing rules.
+ *
+ * @param rules
+ * @param options
+ */
+export function parseXmlHandler(rules, options) {
+    return new ParseXmlHandlerImpl(mapXmlRules(rules), options);
+}
+// Use a symbol to prevent parent from inclusion in property enumeration.
+const parentSymbol = Symbol('parent');
+export class XmlElementImpl {
+    [parentSymbol];
+    constructor(parent = null) {
+        this[parentSymbol] = parent;
+    }
+    get parent() {
+        return this[parentSymbol];
+    }
+    set parent(value) {
+        this[parentSymbol] = value;
+    }
+    clone() {
+        const out = new XmlElementImpl(this.parent);
+        for (const key in this) {
+            // Clone all children, setting their parent references to the new cloned parent.
+            const child = clone(this[key]);
+            if (Array.isArray(child)) {
+                for (const e of child) {
+                    if (typeof e === 'object' && 'parent' in e)
+                        e.parent = out;
+                }
+            }
+            else if (typeof child === 'object' && 'parent' in child) {
+                child.parent = out;
+            }
+            out[key] = child;
+        }
+        return out;
+    }
+    toJSON() {
+        const out = {};
+        for (const key in this) {
+            out[key] = toJson(this[key]);
+        }
+        return out;
+    }
+}

package/dist/types/current/xml/QName.d.ts

@@ -0,0 +1,33 @@
+import type { Uri } from '../xmlns/org/w3/2001/XmlSchema';
+/**
+ * An XML name for an element or attribute.
+ */
+export interface QName {
+    /**
+     * The fully qualified name.
+     * This will be the prefixed name or the unprefixed name if the prefix is empty.
+     * The prefixed name will be `prefix ':' localPart`
+     */
+    readonly qName: string;
+    /**
+     * The xmlns prefix.
+     */
+    readonly prefix: string | null;
+    /**
+     * The local part of this name.
+     */
+    readonly localPart: string;
+    /**
+     * The resolved xmlns uri for the associated prefix.
+     */
+    readonly namespaceUri: Uri | null;
+}
+/**
+ * Creates a new {@link QName} object.
+ *
+ * @param localPart
+ * @param prefix
+ * @param namespaceUri
+ */
+export declare function qName(localPart: string, prefix?: string | null, namespaceUri?: Uri | null): QName;
+//# sourceMappingURL=QName.d.ts.map

package/dist/types/current/xml/QName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QName.d.ts","sourceRoot":"","sources":["../../../../src/xml/QName.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,+BAA+B,CAAA;AAExD;;GAEG;AACH,MAAM,WAAW,KAAK;IAClB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IAE9B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,GAAG,GAAG,IAAI,CAAA;CACpC;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CACjB,SAAS,EAAE,MAAM,EACjB,MAAM,GAAE,MAAM,GAAG,IAAW,EAC5B,YAAY,GAAE,GAAG,GAAG,IAAW,GAChC,KAAK,CAOP"}

package/dist/types/current/xml/QName.js

@@ -0,0 +1,19 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Creates a new {@link QName} object.
+ *
+ * @param localPart
+ * @param prefix
+ * @param namespaceUri
+ */
+export function qName(localPart, prefix = null, namespaceUri = null) {
+    return {
+        localPart,
+        prefix,
+        namespaceUri,
+        qName: prefix ? `${prefix}:${localPart}` : localPart,
+    };
+}

package/dist/types/current/xml/XmlSchemaError.d.ts

@@ -0,0 +1,15 @@
+import { ReportableError } from '@amazon/vinyl-util';
+/**
+ * @private
+ */
+export declare const xmlSchemaErrorLocale: {
+    readonly atLeastElements: "Expected at least {expected} occurrences of {property} but was {actual}";
+    readonly atMostElements: "Expected at most {expected} occurrences of {property} but was {actual}";
+    readonly cyclicReferences: "Cyclic reference detected";
+    readonly requiredAttribute: "Attribute '{property}' is required";
+};
+export declare class XmlSchemaError extends ReportableError {
+    get [Symbol.toStringTag](): string;
+    constructor(message: string);
+}
+//# sourceMappingURL=XmlSchemaError.d.ts.map

package/dist/types/current/xml/XmlSchemaError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"XmlSchemaError.d.ts","sourceRoot":"","sources":["../../../../src/xml/XmlSchemaError.ts"],"names":[],"mappings":"AAKA,OAAO,EAAe,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAEjE;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;CAOvB,CAAA;AAEV,qBAAa,cAAe,SAAQ,eAAe;IAC/C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;gBAEW,OAAO,EAAE,MAAM;CAI9B"}

package/dist/types/current/xml/XmlSchemaError.js

@@ -0,0 +1,23 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ErrorOrigin, ReportableError } from '@amazon/vinyl-util';
+/**
+ * @private
+ */
+export const xmlSchemaErrorLocale = {
+    atLeastElements: 'Expected at least {expected} occurrences of {property} but was {actual}',
+    atMostElements: 'Expected at most {expected} occurrences of {property} but was {actual}',
+    cyclicReferences: 'Cyclic reference detected',
+    requiredAttribute: `Attribute '{property}' is required`,
+};
+export class XmlSchemaError extends ReportableError {
+    get [Symbol.toStringTag]() {
+        return 'XmlSchemaError';
+    }
+    constructor(message) {
+        super(message, ErrorOrigin.PARSING);
+        Object.setPrototypeOf(this, XmlSchemaError.prototype);
+    }
+}

package/dist/types/current/xml/mappedXmlRules.d.ts

@@ -0,0 +1,118 @@
+import { type AnyRecord, type Invariant } from '@amazon/vinyl-util';
+import type { XmlRules } from './xmlRules';
+import type { Uri } from '../xmlns/org/w3/2001/XmlSchema';
+/**
+ * A machine-readable representation of parse rules for random access based on qualified namespace
+ * keys.
+ *
+ * Rule keys will either be `namespaceUri:localPart` or just `localPart` for wildcard rules if
+ * namespaceUri is not defined in the handler.
+ */
+export interface MappedXmlRules<T> {
+    /**
+     * Enforces that this rule set can only be used to parse the expected type T.
+     */
+    readonly __type: Invariant<T>;
+    readonly attributes: ReadonlyMap<string, MappedAttributeRule>;
+    readonly elements: ReadonlyMap<string, MappedElementsRule>;
+    readonly characters: MappedCharactersRule | undefined;
+}
+export interface MappedAttributeRule {
+    /**
+     * The property name.
+     */
+    readonly property: keyof any;
+    /**
+     * If true, a parsing error will be thrown if the value is undefined.
+     */
+    readonly required: boolean;
+    /**
+     * If the current element has no matching attribute, default will be used.
+     */
+    readonly default: any;
+    /**
+     * Parses the attribute value.
+     */
+    readonly parse: (value: string) => any;
+    /**
+     * Converts the attribute value to a string.
+     */
+    readonly stringify: (value: any) => string;
+    /**
+     * The local part of the QName.
+     */
+    readonly localPart: string;
+    /**
+     * The namespace uri that must match.
+     */
+    readonly namespaceUri: Uri | null;
+}
+export interface MappedElementsRule {
+    /**
+     * The name of the property to set on the parent element.
+     */
+    readonly property: keyof any;
+    /**
+     * True if the parsed elements should populate into an array.
+     */
+    readonly array: boolean;
+    /**
+     * The minimum number of elements.
+     */
+    readonly minOccurs: number;
+    /**
+     * The maximum number of elements. Use null for unbounded.
+     */
+    readonly maxOccurs: number | null;
+    /**
+     * If true and there are 0 occurrences of the element, the parsed value will be an empty array
+     * instead of undefined.
+     */
+    readonly useEmptyArrays: boolean;
+    /**
+     * Returns the mappings for matched element(s).
+     */
+    readonly rules: () => MappedXmlRules<any>;
+    /**
+     * The local part of the QName.
+     */
+    readonly localPart: string;
+    /**
+     * The namespace uri that must match.
+     */
+    readonly namespaceUri: Uri | null;
+}
+export interface MappedCharactersRule {
+    readonly property: keyof any;
+    /**
+     * Parses the unescaped/processed characters.
+     * This will always be called, but characters may be an empty string if the element has no
+     * text content.
+     */
+    readonly parse: (characters: string) => any;
+    /**
+     * Converts the value to a string.
+     */
+    readonly stringify: (value: any) => string;
+}
+/**
+ * An empty rules map, used when there was no match for the started element.
+ * @private
+ */
+export declare const EmptyRules: MappedXmlRules<AnyRecord>;
+/**
+ * Creates machine-friendly content handler rules from the given {@link XmlRules}.
+ *
+ * @param rules The {@link XmlRules} to convert.
+ * @param parentNamespaceUri
+ */
+export declare function mapXmlRules<T extends object>(rules: XmlRules<T>, parentNamespaceUri?: Uri | null): MappedXmlRules<T>;
+/**
+ * Creates a rule key for mapped xml rules.
+ *
+ * @private
+ * @param localPart The {@link QName.localPart}
+ * @param namespaceUri The `namespaceUri` of the element.
+ */
+export declare function xmlRuleKey(localPart: string, namespaceUri?: Uri | null): string;
+//# sourceMappingURL=mappedXmlRules.d.ts.map

package/dist/types/current/xml/mappedXmlRules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mappedXmlRules.d.ts","sourceRoot":"","sources":["../../../../src/xml/mappedXmlRules.ts"],"names":[],"mappings":"AAKA,OAAO,EACH,KAAK,SAAS,EAGd,KAAK,SAAS,EAEjB,MAAM,oBAAoB,CAAA;AAE3B,OAAO,KAAK,EAAW,QAAQ,EAAE,MAAM,YAAY,CAAA;AAEnD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,+BAA+B,CAAA;AAExD;;;;;;GAMG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IAC7B,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;IAC7D,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;IAC1D,QAAQ,CAAC,UAAU,EAAE,oBAAoB,GAAG,SAAS,CAAA;CACxD;AAED,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAA;IAE5B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,CAAA;IAEtC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,CAAA;IAE1C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,GAAG,GAAG,IAAI,CAAA;CACpC;AAED,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAA;IAE5B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;IAEvB;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IAEjC;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,cAAc,CAAC,GAAG,CAAC,CAAA;IAEzC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,GAAG,GAAG,IAAI,CAAA;CACpC;AAED,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAA;IAE5B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,GAAG,CAAA;IAE3C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,CAAA;CAC7C;AAED;;;GAGG;AACH,eAAO,MAAM,UAAU,EAAE,cAAc,CAAC,SAAS,CAKvC,CAAA;AAEV;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EACxC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAClB,kBAAkB,GAAE,GAAG,GAAG,IAAW,GACtC,cAAc,CAAC,CAAC,CAAC,CA+FnB;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CACtB,SAAS,EAAE,MAAM,EACjB,YAAY,GAAE,GAAG,GAAG,IAAW,GAChC,MAAM,CAER"}

package/dist/types/current/xml/mappedXmlRules.js

@@ -0,0 +1,122 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { IllegalArgumentError, invariant, memoize, } from '@amazon/vinyl-util';
+import { XmlRuleType } from './xmlRules';
+/**
+ * An empty rules map, used when there was no match for the started element.
+ * @private
+ */
+export const EmptyRules = {
+    __type: invariant(),
+    attributes: new Map(),
+    elements: new Map(),
+    characters: undefined,
+};
+/**
+ * Creates machine-friendly content handler rules from the given {@link XmlRules}.
+ *
+ * @param rules The {@link XmlRules} to convert.
+ * @param parentNamespaceUri
+ */
+export function mapXmlRules(rules, parentNamespaceUri = null) {
+    const attributeRules = new Map();
+    const elementRules = new Map();
+    let charactersRule = undefined;
+    for (const property in rules) {
+        const handlerOrFunction = rules[property];
+        let handler;
+        if (typeof handlerOrFunction === 'function') {
+            handler = handlerOrFunction();
+        }
+        else {
+            handler = handlerOrFunction;
+        }
+        let key;
+        switch (handler.type) {
+            case XmlRuleType.CHARACTERS:
+                if (charactersRule !== undefined)
+                    throw new IllegalArgumentError('characters handler already defined');
+                charactersRule = {
+                    property,
+                    parse: handler.parse,
+                    stringify: handler.stringify,
+                };
+                break;
+            case XmlRuleType.ELEMENT:
+            case XmlRuleType.ELEMENTS: {
+                const localPart = handler.localPart ?? property;
+                const namespaceUri = handler.namespaceUri === undefined
+                    ? parentNamespaceUri
+                    : handler.namespaceUri;
+                key = xmlRuleKey(localPart, namespaceUri);
+                if (elementRules.has(key)) {
+                    throw new IllegalArgumentError(`Multiple element rules for ${key}`);
+                }
+                if (handler.type === XmlRuleType.ELEMENT) {
+                    const rules = handler.rules;
+                    elementRules.set(key, {
+                        array: false,
+                        property,
+                        minOccurs: handler.required ? 1 : 0,
+                        maxOccurs: 1,
+                        rules: memoize(() => mapXmlRules(rules, namespaceUri)),
+                        useEmptyArrays: false,
+                        localPart,
+                        namespaceUri,
+                    });
+                }
+                else {
+                    const rules = handler.rules;
+                    elementRules.set(key, {
+                        array: true,
+                        property,
+                        maxOccurs: handler.maxOccurs,
+                        minOccurs: handler.minOccurs,
+                        rules: memoize(() => mapXmlRules(rules, namespaceUri)),
+                        useEmptyArrays: handler.useEmptyArrays,
+                        localPart,
+                        namespaceUri,
+                    });
+                }
+                break;
+            }
+            case XmlRuleType.ATTRIBUTE: {
+                // Attributes should not inherit the namespace of the parent element.
+                const namespaceUri = handler.namespaceUri;
+                const localPart = handler.localPart ?? property;
+                key = xmlRuleKey(localPart, namespaceUri);
+                if (attributeRules.has(key)) {
+                    throw new IllegalArgumentError(`Multiple attribute rules for ${key}`);
+                }
+                attributeRules.set(key, {
+                    property,
+                    default: handler.default,
+                    parse: handler.parse,
+                    stringify: handler.stringify,
+                    required: handler.required,
+                    localPart,
+                    namespaceUri: handler.namespaceUri ?? null,
+                });
+                break;
+            }
+        }
+    }
+    return {
+        __type: invariant(),
+        attributes: attributeRules,
+        elements: elementRules,
+        characters: charactersRule,
+    };
+}
+/**
+ * Creates a rule key for mapped xml rules.
+ *
+ * @private
+ * @param localPart The {@link QName.localPart}
+ * @param namespaceUri The `namespaceUri` of the element.
+ */
+export function xmlRuleKey(localPart, namespaceUri = null) {
+    return `${namespaceUri ?? ''}:${localPart}`;
+}

package/dist/types/current/xml/mergeXmlRules.d.ts

@@ -0,0 +1,62 @@
+import { type Fun } from '@amazon/vinyl-util';
+import { type XmlRules } from '../xml/xmlRules';
+/**
+ * Recursively merges array types so that S[] & T[] becomes (S & T)[]
+ * When two array elements parsing rules are merged, the result is an array with intersected
+ * element types.
+ */
+export type Merged<T> = T extends readonly any[] ? MergedTupleOrArray<T> : T extends Fun ? T : T extends object ? {
+    [P in keyof T]: Merged<T[P]>;
+} : T;
+/**
+ * `[S0, T0] & [S1, T1]` cannot be converted to `[S0 & S1, T0 & T1]`, but we can at least preserve
+ * the tuple when not intersected.
+ *
+ * Intersected tuples become arrays. E.g. `[S0, T0] & [S1, T1]` becomes `Array<S0 | S1 | T0 | T1>`
+ */
+export type MergedTupleOrArray<T extends readonly any[]> = T extends [infer V0] ? [
+    Merged<V0>
+] : T extends [infer V0, infer V1] ? [Merged<V0>, Merged<V1>] : T extends [infer V0, infer V1, infer V2] ? [Merged<V0>, Merged<V1>, Merged<V2>] : T extends [infer V0, infer V1, infer V2, infer V3] ? [Merged<V0>, Merged<V1>, Merged<V2>, Merged<V3>] : T extends [infer V0, infer V1, infer V2, infer V3, infer V4] ? [Merged<V0>, Merged<V1>, Merged<V2>, Merged<V3>, Merged<V4>] : T extends any[] ? Array<Merged<T[number]>> : T extends readonly [infer V0] ? readonly [Merged<V0>] : T extends readonly [infer V0, infer V1] ? readonly [Merged<V0>, Merged<V1>] : T extends readonly [infer V0, infer V1, infer V2] ? readonly [Merged<V0>, Merged<V1>, Merged<V2>] : T extends readonly [
+    infer V0,
+    infer V1,
+    infer V2,
+    infer V3
+] ? readonly [
+    Merged<V0>,
+    Merged<V1>,
+    Merged<V2>,
+    Merged<V3>
+] : T extends readonly [
+    infer V0,
+    infer V1,
+    infer V2,
+    infer V3,
+    infer V4
+] ? readonly [
+    Merged<V0>,
+    Merged<V1>,
+    Merged<V2>,
+    Merged<V3>,
+    Merged<V4>
+] : ReadonlyArray<Merged<T[number]>>;
+/**
+ * Merges the given two xml rule sets into one.
+ */
+export declare function mergeXmlRules<A extends object, B extends object>(a: XmlRules<A>, b: XmlRules<B>): XmlRules<Merged<A & B>>;
+/**
+ * Merges the given three xml rule sets into one.
+ */
+export declare function mergeXmlRules<A extends object, B extends object, C extends object>(a: XmlRules<A>, b: XmlRules<B>, c: XmlRules<C>): XmlRules<Merged<A & B & C>>;
+/**
+ * Merges the given four xml rule sets into one.
+ */
+export declare function mergeXmlRules<A extends object, B extends object, C extends object, D extends object>(a: XmlRules<A>, b: XmlRules<B>, c: XmlRules<C>, d: XmlRules<D>): XmlRules<Merged<A & B & C & D>>;
+/**
+ * Merges the given five xml rule sets into one.
+ */
+export declare function mergeXmlRules<A extends object, B extends object, C extends object, D extends object, E extends object>(a: XmlRules<A>, b: XmlRules<B>, c: XmlRules<C>, d: XmlRules<D>, e: XmlRules<E>): XmlRules<Merged<A & B & C & D & E>>;
+/**
+ * Merges the given six xml rule sets into one.
+ */
+export declare function mergeXmlRules<A extends object, B extends object, C extends object, D extends object, E extends object, F extends object>(a: XmlRules<A>, b: XmlRules<B>, c: XmlRules<C>, d: XmlRules<D>, e: XmlRules<E>, f: XmlRules<F>): XmlRules<Merged<A & B & C & D & E & F>>;
+//# sourceMappingURL=mergeXmlRules.d.ts.map

package/dist/types/current/xml/mergeXmlRules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mergeXmlRules.d.ts","sourceRoot":"","sources":["../../../../src/xml/mergeXmlRules.ts"],"names":[],"mappings":"AAKA,OAAO,EACH,KAAK,GAAG,EAIX,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EAMH,KAAK,QAAQ,EAEhB,MAAM,gBAAgB,CAAA;AASvB;;;;GAIG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,EAAE,GAC1C,kBAAkB,CAAC,CAAC,CAAC,GACrB,CAAC,SAAS,GAAG,GACX,CAAC,GACD,CAAC,SAAS,MAAM,GACd;KACK,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC/B,GACD,CAAC,CAAA;AAEX;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,SAAS,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,GAEzE;IAAC,MAAM,CAAC,EAAE,CAAC;CAAC,GACZ,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,GAC5B,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,GACxB,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,GACtC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,GACpC,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,GAChD,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,GAChD,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,GAC1D,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,GAC5D,CAAC,SAAS,GAAG,EAAE,GACb,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GACxB,CAAC,SAAS,SAAS,CAAC,MAAM,EAAE,CAAC,GAC3B,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,GACrB,CAAC,SAAS,SAAS,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,GACrC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,GACjC,CAAC,SAAS,SAAS,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,GAC/C,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,GAC7C,CAAC,SAAS,SAAS;IACb,MAAM,EAAE;IACR,MAAM,EAAE;IACR,MAAM,EAAE;IACR,MAAM,EAAE;CACX,GACD,SAAS;IACL,MAAM,CAAC,EAAE,CAAC;IACV,MAAM,CAAC,EAAE,CAAC;IACV,MAAM,CAAC,EAAE,CAAC;IACV,MAAM,CAAC,EAAE,CAAC;CACb,GACD,CAAC,SAAS,SAAS;IACb,MAAM,EAAE;IACR,MAAM,EAAE;IACR,MAAM,EAAE;IACR,MAAM,EAAE;IACR,MAAM,EAAE;CACX,GACD,SAAS;IACL,MAAM,CAAC,EAAE,CAAC;IACV,MAAM,CAAC,EAAE,CAAC;IACV,MAAM,CAAC,EAAE,CAAC;IACV,MAAM,CAAC,EAAE,CAAC;IACV,MAAM,CAAC,EAAE,CAAC;CACb,GACD,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;AAE1D;;GAEG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAC5D,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EACd,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,GACf,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;AAE1B;;GAEG;AACH,wBAAgB,aAAa,CACzB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAClB,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;AAE9E;;GAEG;AACH,wBAAgB,aAAa,CACzB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAEhB,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EACd,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EACd,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EACd,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,GACf,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;AAElC;;GAEG;AACH,wBAAgB,aAAa,CACzB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAEhB,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EACd,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EACd,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EACd,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EACd,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,GACf,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;AAEtC;;GAEG;AACH,wBAAgB,aAAa,CACzB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,EAEhB,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EACd,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EACd,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EACd,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EACd,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EACd,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,GACf,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA"}