@amazon/vinyl-xml 1.0.0

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

@@ -0,0 +1,225 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { encodeEntities, equalDeep, getOrSet, substitute, } from '@amazon/vinyl-util';
+import { XmlSchemaError, xmlSchemaErrorLocale } from './XmlSchemaError';
+/**
+ * @private
+ */
+const locale = {
+    /**
+     * When a namespace binding is generated, if the prefix was not provided in the stringifier
+     * options, it will be generated from this template.
+     */
+    prefixTemplate: 'ns_{value}',
+};
+const defaultStringifyOptions = {
+    indent: '    ',
+    newline: '\n',
+    prefixMap: new Map(),
+    includeXmlDeclaration: true,
+};
+export class XmlWriter {
+    rules;
+    options;
+    usedPrefixes = new Map();
+    traversed = new Set();
+    constructor(rules, options) {
+        this.rules = rules;
+        this.options = {
+            ...defaultStringifyOptions,
+            ...options,
+        };
+    }
+    stringify(object) {
+        let str = this.options.includeXmlDeclaration
+            ? '<?xml version="1.0"?>' + this.options.newline
+            : '';
+        const state = new StringifyState();
+        str += this.stringifyChildren(object, this.rules.elements, state);
+        this.usedPrefixes.clear();
+        this.traversed.clear();
+        return str;
+    }
+    qName(localPart, namespaceUri) {
+        if (!namespaceUri)
+            return localPart;
+        const prefixMap = this.options.prefixMap;
+        const prefix = getOrSet(this.usedPrefixes, namespaceUri, () => {
+            if (prefixMap.has(namespaceUri)) {
+                return prefixMap.get(namespaceUri);
+            }
+            return substitute(locale.prefixTemplate, {
+                value: (this.usedPrefixes.size + 1).toString(36),
+            });
+        });
+        return `${prefix}:${localPart}`;
+    }
+    /**
+     * Stringifies an element.
+     *
+     * @param object
+     * @param rule
+     * @param state
+     */
+    stringifyElement(object, rule, state) {
+        if (this.traversed.has(object))
+            throw new XmlSchemaError(xmlSchemaErrorLocale.cyclicReferences);
+        this.traversed.add(object);
+        const nl = this.options.newline;
+        const isDocument = state.depth === 0;
+        let namespaces = '';
+        let xmlns = state.xmlns;
+        if (xmlns !== rule.namespaceUri &&
+            (xmlns == null || !rule.namespaceUri)) {
+            // The element's namespace is different from the parent.
+            // Change the default namespace if moving to or from a null namespace.
+            xmlns = rule.namespaceUri;
+            namespaces += ` xmlns="${rule.namespaceUri ?? ''}"`;
+        }
+        const childState = state.createChild(xmlns, this.options.indent);
+        const rules = rule.rules();
+        const attributes = this.stringifyAttributes(object, rules.attributes);
+        const children = this.stringifyChildren(object, rules.elements, childState);
+        const text = this.stringifyCharacters(object, rules.characters);
+        if (isDocument) {
+            this.usedPrefixes.forEach((prefix, uri) => {
+                namespaces += ` xmlns:${prefix}="${uri}"`;
+            });
+        }
+        const indent = state.indent;
+        const childIndent = childState.indent;
+        const qName = rule.namespaceUri === xmlns
+            ? rule.localPart
+            : this.qName(rule.localPart, rule.namespaceUri);
+        let str = `${indent}<${qName}${namespaces}${attributes}`;
+        if (children) {
+            str += `>`;
+            if (text)
+                str += `${nl}${childIndent}${text}`;
+            str += nl + children;
+            str += `${nl}${indent}</${qName}>`;
+        }
+        else if (text) {
+            str += `>${text}</${qName}>`;
+        }
+        else {
+            str += '/>';
+        }
+        return str;
+    }
+    /**
+     * Stringifies an element's attributes.
+     *
+     * @param object
+     * @param attributes
+     * @return Returns the attributes string. This will include a leading space if there are any
+     * found attributes.
+     */
+    stringifyAttributes(object, attributes) {
+        let str = '';
+        attributes.forEach((attributeRule) => {
+            const propertyValue = object[attributeRule.property];
+            if (propertyValue !== undefined) {
+                const attributeValue = attributeRule.stringify(propertyValue);
+                if (attributeRule.default === undefined ||
+                    !equalDeep(propertyValue, attributeRule.default)) {
+                    str += ` ${this.qName(attributeRule.localPart, attributeRule.namespaceUri)}="${encodeEntities(attributeValue)}"`;
+                }
+            }
+            else {
+                if (attributeRule.required) {
+                    throw new XmlSchemaError(substitute(xmlSchemaErrorLocale.requiredAttribute, {
+                        property: attributeRule.property,
+                    }));
+                }
+            }
+        });
+        return str;
+    }
+    /**
+     * Stringifies a property as a CDATA node.
+     *
+     * @param object
+     * @param charactersRule
+     */
+    stringifyCharacters(object, charactersRule) {
+        if (!charactersRule)
+            return null;
+        const str = charactersRule.stringify(object[charactersRule.property]);
+        if (!str)
+            return '';
+        return `<![CDATA[${str}]]>`;
+    }
+    /**
+     * Stringifies an element's child elements.
+     *
+     * @param object
+     * @param elements
+     * @param state
+     */
+    stringifyChildren(object, elements, state) {
+        let str = '';
+        elements.forEach((elementsRule) => {
+            const child = object[elementsRule.property];
+            if (child) {
+                if (elementsRule.array) {
+                    const arr = child;
+                    if (elementsRule.minOccurs > arr.length) {
+                        throw new XmlSchemaError(substitute(xmlSchemaErrorLocale.atLeastElements, {
+                            property: elementsRule.property,
+                            expected: elementsRule.minOccurs,
+                            actual: arr.length,
+                        }));
+                    }
+                    if (elementsRule.maxOccurs != null &&
+                        elementsRule.maxOccurs < arr.length) {
+                        throw new XmlSchemaError(substitute(xmlSchemaErrorLocale.atMostElements, {
+                            property: elementsRule.property,
+                            expected: elementsRule.maxOccurs,
+                            actual: arr.length,
+                        }));
+                    }
+                    for (const element of arr) {
+                        if (str)
+                            str += this.options.newline;
+                        str += this.stringifyElement(element, elementsRule, state);
+                    }
+                }
+                else {
+                    if (str)
+                        str += this.options.newline;
+                    str += this.stringifyElement(child, elementsRule, state);
+                }
+            }
+            else {
+                if (elementsRule.minOccurs > 0) {
+                    throw new XmlSchemaError(substitute(xmlSchemaErrorLocale.atLeastElements, {
+                        property: elementsRule.property,
+                        expected: elementsRule.minOccurs,
+                        actual: 0,
+                    }));
+                }
+            }
+        });
+        return str;
+    }
+}
+class StringifyState {
+    depth;
+    xmlns;
+    indent;
+    constructor(depth = 0, xmlns = null, indent = '') {
+        this.depth = depth;
+        this.xmlns = xmlns;
+        this.indent = indent;
+    }
+    createChild(xmlns, indent) {
+        return new StringifyState(this.depth + 1, xmlns, this.indent + indent);
+    }
+}
+export function stringifyXml(object, rules, options) {
+    const writer = new XmlWriter(rules, options);
+    return writer.stringify(object);
+}

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

@@ -0,0 +1,207 @@
+/**
+ * A set of utilities for easily writing schema-based rule definitions to be used with the
+ * `parseXml` parser.
+ *
+ * @module
+ */
+import { type Invariant, type Maybe, type ReadonlyDate } from '@amazon/vinyl-util';
+import type { Uri } from '../xmlns/org/w3/2001/XmlSchema';
+export declare enum XmlRuleType {
+    CHARACTERS = "characters",
+    ATTRIBUTE = "attribute",
+    ELEMENT = "element",
+    ELEMENTS = "elements"
+}
+/**
+ * Reserved keys that may not be used in XmlRules.
+ *
+ * If a schema uses a reserved word, set `localPart` in the rule options to associate.
+ */
+export type ReservedXmlRuleKeys = 'parent' | 'clone' | 'toJSON';
+/**
+ * A schema for XML serialization and deserialization.
+ *
+ * The parser values may be lazy, represented as a function that returns a property parser.
+ * @typeParam T The object type these parsing rules model.
+ */
+export type XmlRules<T extends object> = {
+    readonly [P in Exclude<keyof T, ReservedXmlRuleKeys>]-?: XmlRule<T[P]> | LazyXmlRule<T[P]>;
+};
+/**
+ * A union of the supported parsing types.
+ */
+export type XmlRule<T> = AttributeRule<T> | CharactersRule<T> | ElementsRule<T & (readonly object[] | undefined)> | ElementRule<T & (object | undefined)>;
+/**
+ * A function that returns a property handler.
+ * Useful when there are recursive rules.
+ */
+export type LazyXmlRule<T> = () => XmlRule<T>;
+export interface NamespacedRuleOptions {
+    /**
+     * Matches the `QName.localPart` of the element. If undefined, this will match against
+     * the property name from {@link XmlRules}.
+     */
+    readonly localPart?: string | undefined;
+    /**
+     * Matches the `namespaceUri` of the element or attribute.
+     *
+     * If null, this will only match against a null namespace.
+     * If undefined, this will default to the namespace of the parent element for elements, or
+     * null for attributes.
+     *
+     * Note that attributes do not inherit default namespaces as elements do.
+     */
+    readonly namespaceUri?: Maybe<Uri>;
+}
+/**
+ * A rule definition for a list of elements.
+ */
+export interface ElementsRule<T extends readonly object[] | undefined> extends Required<ElementsRuleOptions> {
+    readonly type: XmlRuleType.ELEMENTS;
+    /**
+     * Prevents rule from losing nullable type information.
+     */
+    readonly __invariant?: Invariant<T>;
+    /**
+     * Returns the schema for matched elements.
+     * These rules will be applied per element, collecting into an array.
+     */
+    readonly rules: XmlRules<NonNullable<T>[number]>;
+}
+export interface ElementsRuleOptions extends NamespacedRuleOptions {
+    /**
+     * 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;
+}
+/**
+ * A rule definition for a single element.
+ */
+export interface ElementRule<T extends object | undefined> extends Required<ElementRuleOptions> {
+    /**
+     * Prevents rule from losing nullable type information.
+     */
+    readonly __invariant?: Invariant<T>;
+    readonly type: XmlRuleType.ELEMENT;
+    /**
+     * Returns the schema for the matched element.
+     */
+    readonly rules: XmlRules<NonNullable<T>>;
+}
+export interface ElementRuleOptions extends NamespacedRuleOptions {
+    /**
+     * If true, a parsing error will be thrown if the value is undefined.
+     */
+    readonly required?: boolean;
+}
+/**
+ * A rule definition for an attribute.
+ */
+export interface AttributeRule<T> extends Required<AttributeRuleOptions<T>> {
+    readonly type: XmlRuleType.ATTRIBUTE;
+    /**
+     * Parses the attribute value.
+     */
+    readonly parse: (value: string) => T;
+    /**
+     * Stringifies the value.
+     */
+    readonly stringify: (value: NonNullable<T>) => string;
+}
+export interface AttributeRuleOptions<T> extends NamespacedRuleOptions {
+    /**
+     * 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?: T | undefined;
+    /**
+     * Matches the `namespaceUri` of the attribute.
+     *
+     * If null, this will only match against a null namespace.
+     *
+     * Note that attributes do not inherit default namespaces as elements do.
+     */
+    readonly namespaceUri?: Uri | null;
+}
+/**
+ * A rule definition for an element's text content.
+ */
+export interface CharactersRule<T> {
+    readonly type: XmlRuleType.CHARACTERS;
+    /**
+     * 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) => T;
+    /**
+     * Stringifies the value.
+     */
+    readonly stringify: (value: NonNullable<T>) => string;
+}
+export interface RequiredElementRuleOptions extends ElementRuleOptions {
+    readonly required: true;
+}
+export declare function element<T extends object>(rules: XmlRules<T>, options: RequiredElementRuleOptions): ElementRule<T>;
+export declare function element<T extends object | undefined>(rules: XmlRules<NonNullable<T>>, options?: ElementRuleOptions): ElementRule<T | undefined>;
+/**
+ * Elements options that guarantee that there is a non-null array.
+ * For minOccurs types greater than 10, a type cast is required.
+ */
+export type RequiredElementsOptions = (ElementsRuleOptions & {
+    readonly useEmptyArrays: true;
+}) | (ElementsRuleOptions & {
+    readonly minOccurs: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
+});
+export declare function elements<T extends object>(rules: XmlRules<T>, options: RequiredElementsOptions): ElementsRule<readonly T[]>;
+export declare function elements<T extends object>(rules: XmlRules<T>, options?: ElementsRuleOptions): ElementsRule<readonly T[] | undefined>;
+/**
+ * Parses the text content of the current element via the given parse and stringify functions.
+ *
+ * Does not currently support mixing text and element nodes.
+ * E.g. the XML `<note>Dear <name>John</name>, I regret to inform you...</note>` could not be
+ * serialized or deserialized using xml rule mappings.
+ *
+ * @param parse The string passed to this parser is the processed text content of the current
+ * element.
+ * @param stringify Serializes the value.
+ *
+ * @see processCharacters
+ */
+export declare function characters<T>(parse: (str: string) => T, stringify: (value: T) => string): CharactersRule<T>;
+/**
+ * Handles the processed text content without any modification.
+ *
+ * @see characters
+ */
+export declare const charactersString: CharactersRule<string>;
+export type RequiredAttributeOptions<T> = AttributeRuleOptions<T> & ({
+    required: true;
+} | {
+    default: T;
+});
+export declare function attr<T>(parse: (value: string) => T, stringify: (value: T) => string, options: RequiredAttributeOptions<T>): AttributeRule<T>;
+export declare function attr<T>(parse: (value: string) => T, stringify: (value: NonNullable<T>) => string, options?: AttributeRuleOptions<T>): AttributeRule<T | undefined>;
+export declare function attrString(options: RequiredAttributeOptions<string>): AttributeRule<string>;
+export declare function attrString(options?: AttributeRuleOptions<string>): AttributeRule<string | undefined>;
+export declare function attrInt(options: RequiredAttributeOptions<number>): AttributeRule<number>;
+export declare function attrInt(options?: AttributeRuleOptions<number>): AttributeRule<number | undefined>;
+export declare function attrFloat(options: RequiredAttributeOptions<number>): AttributeRule<number>;
+export declare function attrFloat(options?: AttributeRuleOptions<number>): AttributeRule<number | undefined>;
+export declare function attrBoolean(options: RequiredAttributeOptions<boolean>): AttributeRule<boolean>;
+export declare function attrBoolean(options?: AttributeRuleOptions<boolean>): AttributeRule<boolean | undefined>;
+export declare function attrDateTime(options: RequiredAttributeOptions<Date>): AttributeRule<ReadonlyDate>;
+export declare function attrDateTime(options?: AttributeRuleOptions<ReadonlyDate>): AttributeRule<ReadonlyDate | undefined>;
+//# sourceMappingURL=xmlRules.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"xmlRules.d.ts","sourceRoot":"","sources":["../../../../src/xml/xmlRules.ts"],"names":[],"mappings":"AAKA;;;;;GAKG;AAEH,OAAO,EAKH,KAAK,SAAS,EACd,KAAK,KAAK,EACV,KAAK,YAAY,EACpB,MAAM,oBAAoB,CAAA;AAE3B,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,+BAA+B,CAAA;AAExD,oBAAY,WAAW;IACnB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,QAAQ,aAAa;CACxB;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;AAE/D;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,MAAM,IAAI;IACrC,QAAQ,EAAE,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAChD,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GACb,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC1B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IACf,aAAa,CAAC,CAAC,CAAC,GAChB,cAAc,CAAC,CAAC,CAAC,GACjB,YAAY,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC,GACjD,WAAW,CAAC,CAAC,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC,CAAA;AAE3C;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,CAAA;AAE7C,MAAM,WAAW,qBAAqB;IAClC;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAEvC;;;;;;;;OAQG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAA;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CACzB,CAAC,SAAS,SAAS,MAAM,EAAE,GAAG,SAAS,CACzC,SAAQ,QAAQ,CAAC,mBAAmB,CAAC;IACnC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,QAAQ,CAAA;IAEnC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IAEnC;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA;CACnD;AAED,MAAM,WAAW,mBAAoB,SAAQ,qBAAqB;IAC9D;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAElC;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAA;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CACxB,CAAC,SAAS,MAAM,GAAG,SAAS,CAC9B,SAAQ,QAAQ,CAAC,kBAAkB,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;IAEnC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,OAAO,CAAA;IAElC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;CAC3C;AAED,MAAM,WAAW,kBAAmB,SAAQ,qBAAqB;IAC7D;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,CAAE,SAAQ,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;IACvE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,SAAS,CAAA;IAEpC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC,CAAA;IAEpC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,MAAM,CAAA;CACxD;AAED,MAAM,WAAW,oBAAoB,CAAC,CAAC,CAAE,SAAQ,qBAAqB;IAClE;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;IAEhC;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,GAAG,IAAI,CAAA;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,UAAU,CAAA;IAErC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,CAAC,CAAA;IAEzC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,MAAM,CAAA;CACxD;AAED,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IAClE,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAA;CAC1B;AAED,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,EACpC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAClB,OAAO,EAAE,0BAA0B,GACpC,WAAW,CAAC,CAAC,CAAC,CAAA;AAEjB,wBAAgB,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,SAAS,EAChD,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAC/B,OAAO,CAAC,EAAE,kBAAkB,GAC7B,WAAW,CAAC,CAAC,GAAG,SAAS,CAAC,CAAA;AAqB7B;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAC7B,CAAC,mBAAmB,GAAG;IAAE,QAAQ,CAAC,cAAc,EAAE,IAAI,CAAA;CAAE,CAAC,GACzD,CAAC,mBAAmB,GAAG;IACnB,QAAQ,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;CAC7D,CAAC,CAAA;AAER,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,EACrC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAClB,OAAO,EAAE,uBAAuB,GACjC,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;AAE7B,wBAAgB,QAAQ,CAAC,CAAC,SAAS,MAAM,EACrC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAClB,OAAO,CAAC,EAAE,mBAAmB,GAC9B,YAAY,CAAC,SAAS,CAAC,EAAE,GAAG,SAAS,CAAC,CAAA;AA0BzC;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,CAAC,EACxB,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,CAAC,EACzB,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,GAChC,cAAc,CAAC,CAAC,CAAC,CAEnB;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,wBAAkC,CAAA;AAE/D,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAC,CAAC,GAC7D,CAAC;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,CAAC,CAAA;CAAE,CAAC,CAAA;AAEzC,wBAAgB,IAAI,CAAC,CAAC,EAClB,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC,EAC3B,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,MAAM,EAC/B,OAAO,EAAE,wBAAwB,CAAC,CAAC,CAAC,GACrC,aAAa,CAAC,CAAC,CAAC,CAAA;AAEnB,wBAAgB,IAAI,CAAC,CAAC,EAClB,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC,EAC3B,SAAS,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,MAAM,EAC5C,OAAO,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAClC,aAAa,CAAC,CAAC,GAAG,SAAS,CAAC,CAAA;AA0B/B,wBAAgB,UAAU,CACtB,OAAO,EAAE,wBAAwB,CAAC,MAAM,CAAC,GAC1C,aAAa,CAAC,MAAM,CAAC,CAAA;AAExB,wBAAgB,UAAU,CACtB,OAAO,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GACvC,aAAa,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;AAapC,wBAAgB,OAAO,CACnB,OAAO,EAAE,wBAAwB,CAAC,MAAM,CAAC,GAC1C,aAAa,CAAC,MAAM,CAAC,CAAA;AAExB,wBAAgB,OAAO,CACnB,OAAO,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GACvC,aAAa,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;AAapC,wBAAgB,SAAS,CACrB,OAAO,EAAE,wBAAwB,CAAC,MAAM,CAAC,GAC1C,aAAa,CAAC,MAAM,CAAC,CAAA;AAExB,wBAAgB,SAAS,CACrB,OAAO,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GACvC,aAAa,CAAC,MAAM,GAAG,SAAS,CAAC,CAAA;AAapC,wBAAgB,WAAW,CACvB,OAAO,EAAE,wBAAwB,CAAC,OAAO,CAAC,GAC3C,aAAa,CAAC,OAAO,CAAC,CAAA;AAEzB,wBAAgB,WAAW,CACvB,OAAO,CAAC,EAAE,oBAAoB,CAAC,OAAO,CAAC,GACxC,aAAa,CAAC,OAAO,GAAG,SAAS,CAAC,CAAA;AAarC,wBAAgB,YAAY,CACxB,OAAO,EAAE,wBAAwB,CAAC,IAAI,CAAC,GACxC,aAAa,CAAC,YAAY,CAAC,CAAA;AAE9B,wBAAgB,YAAY,CACxB,OAAO,CAAC,EAAE,oBAAoB,CAAC,YAAY,CAAC,GAC7C,aAAa,CAAC,YAAY,GAAG,SAAS,CAAC,CAAA"}

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

@@ -0,0 +1,134 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * A set of utilities for easily writing schema-based rule definitions to be used with the
+ * `parseXml` parser.
+ *
+ * @module
+ */
+import { parseDate, stringifyDate, parseBoolean, stringify, } from '@amazon/vinyl-util';
+export var XmlRuleType;
+(function (XmlRuleType) {
+    XmlRuleType["CHARACTERS"] = "characters";
+    XmlRuleType["ATTRIBUTE"] = "attribute";
+    XmlRuleType["ELEMENT"] = "element";
+    XmlRuleType["ELEMENTS"] = "elements";
+})(XmlRuleType || (XmlRuleType = {}));
+/**
+ * Returns a schema for a single object based on a map of rules.
+ *
+ * If more than one element is found with a matching name, a `ParseError` is thrown.
+ */
+export function element(rules, options) {
+    return {
+        type: XmlRuleType.ELEMENT,
+        localPart: undefined,
+        namespaceUri: undefined,
+        required: false,
+        ...options,
+        rules,
+    };
+}
+/**
+ * Handles a list of child nodes where each matching child node is parsed into a corresponding
+ * object represented by the given rules.
+ *
+ * @param rules The parsing rules to use for each element.
+ * @param options
+ * @see parseChildNodes
+ */
+export function elements(rules, options) {
+    return {
+        type: XmlRuleType.ELEMENTS,
+        localPart: undefined,
+        namespaceUri: undefined,
+        minOccurs: 0,
+        maxOccurs: null,
+        useEmptyArrays: false,
+        ...options,
+        rules,
+    };
+}
+/**
+ * Parses the text content of the current element via the given parse and stringify functions.
+ *
+ * Does not currently support mixing text and element nodes.
+ * E.g. the XML `<note>Dear <name>John</name>, I regret to inform you...</note>` could not be
+ * serialized or deserialized using xml rule mappings.
+ *
+ * @param parse The string passed to this parser is the processed text content of the current
+ * element.
+ * @param stringify Serializes the value.
+ *
+ * @see processCharacters
+ */
+export function characters(parse, stringify) {
+    return { type: XmlRuleType.CHARACTERS, parse, stringify };
+}
+/**
+ * Handles the processed text content without any modification.
+ *
+ * @see characters
+ */
+export const charactersString = characters((i) => i, stringify);
+/**
+ * Handles an attribute using the given parse and stringify functions.
+ *
+ * @param parse
+ * @param stringify
+ * @param options
+ */
+export function attr(parse, stringify, options) {
+    return {
+        type: XmlRuleType.ATTRIBUTE,
+        localPart: undefined,
+        namespaceUri: null,
+        required: false,
+        default: undefined,
+        ...options,
+        parse,
+        stringify,
+    };
+}
+/**
+ * Keeps an attribute's string value as is.
+ *
+ * @param options
+ */
+export function attrString(options) {
+    return attr((i) => i, stringify, options);
+}
+/**
+ * Parses an attribute's value using `parseInt`
+ *
+ * @param options
+ */
+export function attrInt(options) {
+    return attr(parseInt, stringify, options);
+}
+/**
+ * Parses an attribute using `parseFloat`
+ *
+ * @param options
+ */
+export function attrFloat(options) {
+    return attr(parseFloat, stringify, options);
+}
+/**
+ * Parses an attribute's value `"true"` or `"1"` as `true`.
+ *
+ * @param options
+ */
+export function attrBoolean(options) {
+    return attr(parseBoolean, stringify, options);
+}
+/**
+ * Parses an attribute using `Date.parse`
+ *
+ * @param options
+ */
+export function attrDateTime(options) {
+    return attr(parseDate, stringifyDate, options);
+}

package/dist/types/current/xmlns/org/w3/1999/xlink.d.ts

@@ -0,0 +1,7 @@
+/**
+ * A subset of types defined in xlink xml schema needed for dash parsing.
+ * Source: https://www.w3.org/TR/xlink/
+ * @module
+ */
+export type actuateType = 'onLoad' | 'onRequest';
+//# sourceMappingURL=xlink.d.ts.map

package/dist/types/current/xmlns/org/w3/1999/xlink.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xlink.d.ts","sourceRoot":"","sources":["../../../../../../../src/xmlns/org/w3/1999/xlink.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AAEH,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAA"}

package/dist/types/current/xmlns/org/w3/1999/xlink.js

@@ -0,0 +1,5 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export {};

package/dist/types/current/xmlns/org/w3/2001/XmlSchema.d.ts

@@ -0,0 +1,17 @@
+/**
+ * A subset of types defined in 2001 XmlSchema needed for dash parsing.
+ * Source: https://www.w3.org/2001/XmlSchema.xsd
+ *
+ * @module
+ */
+/**
+ * A Uniform Resource Identifier Reference
+ */
+export type Uri = string;
+export interface Base64BinaryType {
+    _content: string;
+}
+export interface UriType {
+    _content: Uri;
+}
+//# sourceMappingURL=XmlSchema.d.ts.map

package/dist/types/current/xmlns/org/w3/2001/XmlSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"XmlSchema.d.ts","sourceRoot":"","sources":["../../../../../../../src/xmlns/org/w3/2001/XmlSchema.ts"],"names":[],"mappings":"AAKA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,MAAM,CAAA;AAExB,MAAM,WAAW,gBAAgB;IAC7B,QAAQ,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,OAAO;IACpB,QAAQ,EAAE,GAAG,CAAA;CAChB"}

package/dist/types/current/xmlns/org/w3/2001/XmlSchema.js

@@ -0,0 +1,5 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export {};

package/dist/types/ts3.7/index.d.ts

@@ -0,0 +1,14 @@
+/** Auto-generated from build scripts */
+export * from './xmlns/org/w3/2001/XmlSchema';
+export * from './xmlns/org/w3/1999/xlink';
+export * from './xml/xmlRules';
+export * from './xml/stringifyXml';
+export * from './xml/parseXml';
+export * from './xml/mergeXmlRules';
+export * from './xml/mappedXmlRules';
+export * from './xml/XmlSchemaError';
+export * from './xml/QName';
+export * from './xml/ParseXmlHandlerImpl';
+export * from './xml/ParseXmlHandler';
+export * from './xlink/actuateValidator';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/ts3.7/xlink/actuateValidator.d.ts

@@ -0,0 +1,3 @@
+import { actuateType } from '../xmlns/org/w3/1999/xlink';
+export declare function assertActuateEnum(str: string): actuateType;
+//# sourceMappingURL=actuateValidator.d.ts.map