@rgrove/parse-xml 3.0.0 → 4.0.0

package/src/lib/StringScanner.js

@@ -1,312 +0,0 @@
-'use strict';
-
-const emptyString = '';
-
-/**
-@private
-*/
-class StringScanner {
-  /**
-  @param {string} string
-  */
-  constructor(string) {
-    /** @type {string[]} */
-    this.chars = [ ...string ];
-
-    /** @type {number} */
-    this.charCount = this.chars.length;
-
-    /** @type {number} */
-    this.charIndex = 0;
-
-    /** @type {number[]} */
-    this.charsToBytes = new Array(this.charCount);
-
-    /** @type {boolean} */
-    this.multiByteMode = false;
-
-    /** @type {string} */
-    this.string = string;
-
-    let { chars, charCount, charsToBytes } = this;
-
-    if (charCount === string.length) {
-      // There are no multibyte characters in the input string, so char indexes
-      // and byte indexes are the same.
-      for (let i = 0; i < charCount; ++i) {
-        charsToBytes[i] = i;
-      }
-    } else {
-      // Create a mapping of character indexes to byte indexes. When the string
-      // contains multibyte characters, a byte index may not necessarily align
-      // with a character index.
-      for (let byteIndex = 0, charIndex = 0; charIndex < charCount; ++charIndex) {
-        charsToBytes[charIndex] = byteIndex;
-        byteIndex += chars[charIndex].length;
-      }
-
-      this.multiByteMode = true;
-    }
-  }
-
-  /**
-  Whether the current character index is at the end of the input string.
-
-  @type {boolean}
-  */
-  get isEnd() {
-    return this.charIndex >= this.charCount;
-  }
-
-  // -- Protected Methods ------------------------------------------------------
-
-  /**
-  Returns the number of characters in the given _string_, which may differ from
-  the byte length if the string contains multibyte characters.
-
-  @param {string} string
-  @returns {number}
-  */
-  _charLength(string) {
-    let { length } = string;
-
-    if (length < 2 || !this.multiByteMode) {
-      return length;
-    }
-
-    // We could get the char length with `[ ...string ].length`, but that's
-    // actually slower than this approach, which replaces surrogate pairs with
-    // single-byte characters.
-    return string.replace(/[\uD800-\uDBFF][\uDC00-\uDFFF]/g, '_').length;
-  }
-
-  // -- Public Methods ---------------------------------------------------------
-
-  /**
-  Advances the scanner by the given number of characters, stopping if the end of
-  the string is reached.
-
-  @param {number} [count]
-  */
-  advance(count = 1) {
-    this.charIndex = Math.min(this.charCount, this.charIndex + count);
-  }
-
-  /**
-  Consumes and returns the given number of characters if possible, advancing the
-  scanner and stopping if the end of the string is reached.
-
-  If no characters could be consumed, an empty string will be returned.
-
-  @param {number} [count]
-  @returns {string}
-  */
-  consume(count = 1) {
-    let chars = this.peek(count);
-    this.advance(count);
-    return chars;
-  }
-
-  /**
-  Consumes a match for the given sticky regex, advances the scanner, updates the
-  `lastIndex` property of the regex, and returns the matching string.
-
-  The regex must have a sticky flag ("y") so that its `lastIndex` prop can be
-  used to anchor the match at the current scanner position.
-
-  Returns the consumed string, or an empty string if nothing was consumed.
-
-  @param {RegExp} regex
-  @returns {string}
-  */
-  consumeMatch(regex) {
-    if (!regex.sticky) {
-      throw new Error('`regex` must have a sticky flag ("y")');
-    }
-
-    regex.lastIndex = this.charsToBytes[this.charIndex];
-
-    let result = regex.exec(this.string);
-
-    if (result === null) {
-      return emptyString;
-    }
-
-    let match = result[0];
-    this.advance(this._charLength(match));
-    return match;
-  }
-
-  /**
-  Consumes and returns all characters for which the given function returns a
-  truthy value, stopping on the first falsy return value or if the end of the
-  input is reached.
-
-  @param {(char: string) => boolean} fn
-  @returns {string}
-  */
-  consumeMatchFn(fn) {
-    let startIndex = this.charIndex;
-
-    while (!this.isEnd && fn(this.peek())) {
-      this.advance();
-    }
-
-    return this.charIndex > startIndex
-      ? this.string.slice(this.charsToBytes[startIndex], this.charsToBytes[this.charIndex])
-      : emptyString;
-  }
-
-  /**
-  Consumes the given string if it exists at the current character index, and
-  advances the scanner.
-
-  If the given string doesn't exist at the current character index, an empty
-  string will be returned and the scanner will not be advanced.
-
-  @param {string} stringToConsume
-  @returns {string}
-  */
-  consumeString(stringToConsume) {
-    if (this.consumeStringFast(stringToConsume)) {
-      return stringToConsume;
-    }
-
-    if (!this.multiByteMode) {
-      return emptyString;
-    }
-
-    let { length } = stringToConsume;
-    let charLengthToMatch = this._charLength(stringToConsume);
-
-    if (charLengthToMatch !== length
-        && stringToConsume === this.peek(charLengthToMatch)) {
-
-      this.advance(charLengthToMatch);
-      return stringToConsume;
-    }
-
-    return emptyString;
-  }
-
-  /**
-   * Does the same thing as `consumeString()`, but doesn't support consuming
-   * multibyte characters. This can be much faster if you only need to match
-   * single byte characters.
-   *
-   * @param {string} stringToConsume
-   * @returns {string}
-   */
-  consumeStringFast(stringToConsume) {
-    if (this.peek() === stringToConsume[0]) {
-      let { length } = stringToConsume;
-
-      if (length === 1) {
-        this.advance();
-        return stringToConsume;
-      }
-
-      if (this.peek(length) === stringToConsume) {
-        this.advance(length);
-        return stringToConsume;
-      }
-    }
-
-    return emptyString;
-  }
-
-  /**
-  Consumes characters until the given global regex is matched, advancing the
-  scanner up to (but not beyond) the beginning of the match and updating the
-  `lastIndex` property of the regex.
-
-  The regex must have a global flag ("g") so that its `lastIndex` prop can be
-  used to begin the search at the current scanner position.
-
-  Returns the consumed string, or an empty string if nothing was consumed.
-
-  @param {RegExp} regex
-  @returns {string}
-  */
-  consumeUntilMatch(regex) {
-    if (!regex.global) {
-      throw new Error('`regex` must have a global flag ("g")');
-    }
-
-    let byteIndex = this.charsToBytes[this.charIndex];
-    regex.lastIndex = byteIndex;
-
-    let match = regex.exec(this.string);
-
-    if (match === null || match.index === byteIndex) {
-      return emptyString;
-    }
-
-    let result = this.string.slice(byteIndex, match.index);
-    this.advance(this._charLength(result));
-    return result;
-  }
-
-  /**
-  Consumes characters until the given string is found, advancing the scanner up
-  to (but not beyond) that point.
-
-  Returns the consumed string, or an empty string if nothing was consumed.
-
-  @param {string} searchString
-  @returns {string}
-  */
-  consumeUntilString(searchString) {
-    let { charIndex, charsToBytes, string } = this;
-    let byteIndex = charsToBytes[charIndex];
-    let matchByteIndex = string.indexOf(searchString, byteIndex);
-
-    if (matchByteIndex <= 0) {
-      return emptyString;
-    }
-
-    let result = string.slice(byteIndex, matchByteIndex);
-    this.advance(this._charLength(result));
-    return result;
-  }
-
-  /**
-  Returns the given number of characters starting at the current character
-  index, without advancing the scanner and without exceeding the end of the
-  input string.
-
-  @param {number} [count]
-  @returns {string}
-  */
-  peek(count = 1) {
-    // Inlining this comparison instead of checking `this.isEnd` improves perf
-    // slightly since `peek()` is called so frequently.
-    if (this.charIndex >= this.charCount) {
-      return emptyString;
-    }
-
-    if (count === 1) {
-      return this.chars[this.charIndex];
-    }
-
-    let { charsToBytes, charIndex } = this;
-    return this.string.slice(charsToBytes[charIndex], charsToBytes[charIndex + count]);
-  }
-
-  /**
-  Resets the scanner position to the given character _index_, or to the start of
-  the input string if no index is given.
-
-  If _index_ is negative, the scanner position will be moved backward by that
-  many characters, stopping if the beginning of the string is reached.
-
-  @param {number} [index]
-  */
-  reset(index = 0) {
-    this.charIndex = index >= 0
-      ? Math.min(this.charCount, index)
-      : Math.max(0, this.charIndex + index);
-  }
-}
-
-module.exports = StringScanner;

package/src/lib/XmlCdata.js

@@ -1,17 +0,0 @@
-'use strict';
-
-const XmlNode = require('./XmlNode');
-const XmlText = require('./XmlText');
-
-/**
-A CDATA section within an XML document.
-
-@public
-*/
-class XmlCdata extends XmlText {
-  get type() {
-    return XmlNode.TYPE_CDATA;
-  }
-}
-
-module.exports = XmlCdata;

package/src/lib/XmlComment.js

@@ -1,37 +0,0 @@
-'use strict';
-
-const XmlNode = require('./XmlNode');
-
-/**
-A comment within an XML document.
-
-@public
-*/
-class XmlComment extends XmlNode {
-  /**
-  @param {string} [content]
-  */
-  constructor(content = '') {
-    super();
-
-    /**
-    Content of this comment.
-
-    @type {string}
-    @public
-    */
-    this.content = content;
-  }
-
-  get type() {
-    return XmlNode.TYPE_COMMENT;
-  }
-
-  toJSON() {
-    return Object.assign(XmlNode.prototype.toJSON.call(this), {
-      content: this.content
-    });
-  }
-}
-
-module.exports = XmlComment;

package/src/lib/XmlDocument.js

@@ -1,69 +0,0 @@
-'use strict';
-
-const XmlElement = require('./XmlElement');
-const XmlNode = require('./XmlNode');
-
-/**
-Represents an XML document. All elements within the document are descendants of
-this node.
-
-@public
-*/
-class XmlDocument extends XmlNode {
-  /**
-  @param {Array<XmlComment|XmlElement|XmlProcessingInstruction>} [children]
-  */
-  constructor(children = []) {
-    super();
-
-    /**
-    Child nodes of this document.
-
-    @type {Array<XmlComment|XmlElement|XmlProcessingInstruction>}
-    @public
-    */
-    this.children = children;
-  }
-
-  get document() {
-    return this;
-  }
-
-  /**
-  Root element of this document, or `null` if this document is empty.
-
-  @type {XmlElement?}
-  @public
-  */
-  get root() {
-    // @ts-ignore
-    return this.children.find((child) => child instanceof XmlElement) || null;
-  }
-
-  /**
-  Text content of this document and all its descendants.
-
-  @type {string}
-  @public
-  */
-  get text() {
-    return this.children
-      .map(child => 'text' in child ? child.text : '')
-      .join('');
-  }
-
-  get type() {
-    return XmlNode.TYPE_DOCUMENT;
-  }
-
-  toJSON() {
-    return Object.assign(XmlNode.prototype.toJSON.call(this), {
-      children: this.children.map(child => child.toJSON()),
-    });
-  }
-}
-
-module.exports = XmlDocument;
-
-/** @typedef {import('./XmlComment')} XmlComment */
-/** @typedef {import('./XmlProcessingInstruction')} XmlProcessingInstruction */

package/src/lib/XmlElement.js

@@ -1,101 +0,0 @@
-'use strict';
-
-const XmlNode = require('./XmlNode');
-
-/**
-Element in an XML document.
-
-@public
-*/
-class XmlElement extends XmlNode {
-  /**
-  @param {string} name
-  @param {{[attrName: string]: string}} [attributes]
-  @param {Array<XmlCdata|XmlComment|XmlElement|XmlProcessingInstruction|XmlText>} [children]
-  */
-  constructor(name, attributes = Object.create(null), children = []) {
-    super();
-
-    /**
-    Name of this element.
-
-    @type {string}
-    @public
-    */
-    this.name = name;
-
-    /**
-    Attributes on this element.
-
-    @type {{[attrName: string]: string}}
-    @public
-    */
-    this.attributes = attributes;
-
-    /**
-    Child nodes of this element.
-
-    @type {Array<XmlCdata|XmlComment|XmlElement|XmlProcessingInstruction|XmlText>}
-    @public
-    */
-    this.children = children;
-  }
-
-  /**
-  Whether this node is empty (meaning it has no children).
-
-  @type {boolean}
-  @public
-  */
-  get isEmpty() {
-    return this.children.length === 0;
-  }
-
-  /** @type {boolean} */
-  get preserveWhitespace() {
-    /** @type {XmlNode?} */
-    let node = this;
-
-    while (node instanceof XmlElement) {
-      if ('xml:space' in node.attributes) {
-        return node.attributes['xml:space'] === 'preserve';
-      }
-
-      node = node.parent;
-    }
-
-    return false;
-  }
-
-  /**
-  Text content of this element and all its descendants.
-
-  @type {string}
-  @public
-  */
-  get text() {
-    return this.children
-      .map(child => 'text' in child ? child.text : '')
-      .join('');
-  }
-
-  get type() {
-    return XmlNode.TYPE_ELEMENT;
-  }
-
-  /** @returns {{[key: string]: any}} */
-  toJSON() {
-    return Object.assign(XmlNode.prototype.toJSON.call(this), {
-      name: this.name,
-      attributes: this.attributes,
-      children: this.children.map(child => child.toJSON()),
-    });
-  }
-}
-
-module.exports = XmlElement;
-
-/** @typedef {import('./XmlCdata')} XmlCdata */
-/** @typedef {import('./XmlComment')} XmlComment */
-/** @typedef {import('./XmlProcessingInstruction')} XmlProcessingInstruction */
-/** @typedef {import('./XmlText')} XmlText */

package/src/lib/XmlNode.js

@@ -1,152 +0,0 @@
-'use strict';
-
-/**
-Base interface for a node in an XML document.
-
-@public
-*/
-class XmlNode {
-  constructor() {
-    /**
-    Parent node of this node, or `null` if this node has no parent.
-
-    @type {XmlDocument|XmlElement|null}
-    @public
-    */
-    this.parent = null;
-  }
-
-  /**
-  Document that contains this node, or `null` if this node is not associated
-  with a document.
-
-  @type {XmlDocument?}
-  @public
-  */
-  get document() {
-    return this.parent
-      ? this.parent.document
-      : null;
-  }
-
-  /**
-  Whether this node is the root node of the document.
-
-  @returns {boolean}
-  @public
-  */
-  get isRootNode() {
-    return this.parent
-      ? this.parent === this.document
-      : false;
-  }
-
-  /**
-  Whether whitespace should be preserved in the content of this element and
-  its children.
-
-  This is influenced by the value of the special `xml:space` attribute, and
-  will be `true` for any node whose `xml:space` attribute is set to
-  "preserve". If a node has no such attribute, it will inherit the value of
-  the nearest ancestor that does (if any).
-
-  @type {boolean}
-  @see https://www.w3.org/TR/2008/REC-xml-20081126/#sec-white-space
-  @public
-  */
-  get preserveWhitespace() {
-    return Boolean(this.parent && this.parent.preserveWhitespace);
-  }
-
-  /**
-  Type of this node.
-
-  The value of this property is a string that matches one of the static `TYPE_*`
-  properties on the `XmlNode` class (e.g. `TYPE_ELEMENT`, `TYPE_TEXT`, etc.).
-
-  The `XmlNode` class itself is a base class and doesn't have its own type name.
-
-  @type {string}
-  @public
-  */
-  get type() {
-    return '';
-  }
-
-  /**
-  Returns a JSON-serializable object representing this node, minus properties
-  that could result in circular references.
-
-  @returns {{[key: string]: any}}
-  @public
-  */
-  toJSON() {
-    /** @type {{[key: string]: any}} */
-    let json = {
-      type: this.type
-    };
-
-    if (this.isRootNode) {
-      json.isRootNode = true;
-    }
-
-    if (this.preserveWhitespace) {
-      json.preserveWhitespace = true;
-    }
-
-    return json;
-  }
-}
-
-/**
-Type value for an `XmlCdata` node.
-
-@type {string}
-@public
-*/
-XmlNode.TYPE_CDATA = 'cdata';
-
-/**
-Type value for an `XmlComment` node.
-
-@type {string}
-@public
-*/
-XmlNode.TYPE_COMMENT = 'comment';
-
-/**
-Type value for an `XmlDocument` node.
-
-@type {string}
-@public
-*/
-XmlNode.TYPE_DOCUMENT = 'document';
-
-/**
-Type value for an `XmlElement` node.
-
-@type {string}
-@public
-*/
-XmlNode.TYPE_ELEMENT = 'element';
-
-/**
-Type value for an `XmlProcessingInstruction` node.
-
-@type {string}
-@public
-*/
-XmlNode.TYPE_PROCESSING_INSTRUCTION = 'pi';
-
-/**
-Type value for an `XmlText` node.
-
-@type {string}
-@public
-*/
-XmlNode.TYPE_TEXT = 'text';
-
-module.exports = XmlNode;
-
-/** @typedef {import('./XmlDocument')} XmlDocument */
-/** @typedef {import('./XmlElement')} XmlElement */