axyseo 2.0.0-alpha.1

package/build/parsedPaper/research/researches/LinkStatistics.js

@@ -0,0 +1,129 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _url = _interopRequireDefault(require("url"));
+var _Research = _interopRequireDefault(require("./Research"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/* Internal dependencies */
+
+/**
+ * Calculates link statistics.
+ * E.g. which links a node or its children contains, and whether these links are:
+ *  * internal (points to a page in the same domain), external (a page in another domain) or other.
+ *  * marked as follow (search engines are allowed to follow this link) or no-follow (search engines are not allowed to follow the link).
+ *
+ *  @memberOf module:parsedPaper/research
+ */
+class LinkStatistics extends _Research.default {
+  /**
+   * Checks whether the given link is marked for search engines to not follow.
+   *
+   * @param {module:parsedPaper/structure.FormattingElement} linkElement The link to check.
+   *
+   * @returns {boolean} `true` if the link is marked as 'no-follow'.
+   *
+   * @private
+   */
+  _isNoFollow(linkElement) {
+    const rel = linkElement.getAttribute("rel");
+    if (!rel) {
+      return false;
+    }
+
+    // Check if the `rel` attribute includes "nofollow".
+    return rel.split(/\s+/).includes("nofollow");
+  }
+
+  /**
+   * Checks whether the given protocol string is either HTTP or HTTPS.
+   *
+   * @param {String} protocol The protocol string to check.
+   *
+   * @returns {boolean} Whether the protocol is either HTTP or HTTPS.
+   *
+   * @private
+   */
+  _isHttp(protocol) {
+    if (!protocol) {
+      return false;
+    }
+    return protocol === "http:" || protocol === "https:";
+  }
+
+  /**
+   * Checks whether the given link is:
+   *  * internal: points to a web page in the same domain as the current site.
+   *  * external: points to a web page in another domain as the current site.
+   *  * other: e.g. uses another protocol like `ftp`.
+   *
+   * @param {module:parsedPaper/structure.FormattingElement} linkElement The link to check.
+   * @param {string}                                         domain The domain to check against.
+   *
+   * @returns {"external"|"internal"|"other"} Whether the link points to an external, internal or other web page.
+   *
+   * @private
+   */
+  _whichTarget(linkElement, domain) {
+    const link = linkElement.getAttribute("href");
+    if (!link) {
+      return "other";
+    }
+    const url = _url.default.parse(link);
+    if (!this._isHttp(url.protocol) || url.hash) {
+      return "other";
+    }
+    if (url.hostname === domain) {
+      return "internal";
+    }
+    return "external";
+  }
+
+  /**
+   * Returns the permalink from the metadata.
+   *
+   * @param {module:parsedPaper/structure.Node} metadata The metadata to retrieve the permalink from.
+   *
+   * @returns {string} The permalink.
+   *
+   * @private
+   */
+  _getPermalink(metadata) {
+    const permalinkElement = metadata.children.find(child => child.tag === "permalink");
+    const paragraph = permalinkElement.children[0];
+    return paragraph.textContainer.text;
+  }
+
+  /**
+   * Calculates link statistics for the given node.
+   *
+   * @param {module:parsedPaper/structure.Node} node     The node to calculate the research for.
+   * @param {module:parsedPaper/structure.Node} metadata The document's metadata.
+   *
+   * @returns {Promise<Object[]>} The research results.
+   */
+  calculateFor(node, metadata) {
+    // Collect link elements.
+    const links = node.textContainer.formatting.filter(element => element.type === "a");
+
+    // URL of the current page.
+    const permalink = this._getPermalink(metadata);
+    const url = _url.default.parse(permalink);
+
+    // Collect statistics about the links.
+    const results = links.map(link => {
+      const noFollow = this._isNoFollow(link);
+      const target = this._whichTarget(link, url.hostname);
+      return {
+        link,
+        noFollow,
+        target
+      };
+    });
+    return Promise.resolve(results);
+  }
+}
+var _default = exports.default = LinkStatistics;
+//# sourceMappingURL=LinkStatistics.js.map

package/build/parsedPaper/research/researches/LinkStatistics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LinkStatistics.js","names":["_url","_interopRequireDefault","require","_Research","e","__esModule","default","LinkStatistics","Research","_isNoFollow","linkElement","rel","getAttribute","split","includes","_isHttp","protocol","_whichTarget","domain","link","url","urlMethods","parse","hash","hostname","_getPermalink","metadata","permalinkElement","children","find","child","tag","paragraph","textContainer","text","calculateFor","node","links","formatting","filter","element","type","permalink","results","map","noFollow","target","Promise","resolve","_default","exports"],"sources":["../../../../src/parsedPaper/research/researches/LinkStatistics.js"],"sourcesContent":["import urlMethods from \"url\";\n\n/* Internal dependencies */\nimport Research from \"./Research\";\n\n/**\n * Calculates link statistics.\n * E.g. which links a node or its children contains, and whether these links are:\n *  * internal (points to a page in the same domain), external (a page in another domain) or other.\n *  * marked as follow (search engines are allowed to follow this link) or no-follow (search engines are not allowed to follow the link).\n *\n *  @memberOf module:parsedPaper/research\n */\nclass LinkStatistics extends Research {\n\t/**\n\t * Checks whether the given link is marked for search engines to not follow.\n\t *\n\t * @param {module:parsedPaper/structure.FormattingElement} linkElement The link to check.\n\t *\n\t * @returns {boolean} `true` if the link is marked as 'no-follow'.\n\t *\n\t * @private\n\t */\n\t_isNoFollow( linkElement ) {\n\t\tconst rel = linkElement.getAttribute( \"rel\" );\n\n\t\tif ( ! rel ) {\n\t\t\treturn false;\n\t\t}\n\n\t\t// Check if the `rel` attribute includes \"nofollow\".\n\t\treturn rel.split( /\\s+/ ).includes( \"nofollow\" );\n\t}\n\n\t/**\n\t * Checks whether the given protocol string is either HTTP or HTTPS.\n\t *\n\t * @param {String} protocol The protocol string to check.\n\t *\n\t * @returns {boolean} Whether the protocol is either HTTP or HTTPS.\n\t *\n\t * @private\n\t */\n\t_isHttp( protocol ) {\n\t\tif ( ! protocol ) {\n\t\t\treturn false;\n\t\t}\n\n\t\treturn ( protocol === \"http:\" || protocol === \"https:\" );\n\t}\n\n\t/**\n\t * Checks whether the given link is:\n\t *  * internal: points to a web page in the same domain as the current site.\n\t *  * external: points to a web page in another domain as the current site.\n\t *  * other: e.g. uses another protocol like `ftp`.\n\t *\n\t * @param {module:parsedPaper/structure.FormattingElement} linkElement The link to check.\n\t * @param {string}                                         domain The domain to check against.\n\t *\n\t * @returns {\"external\"|\"internal\"|\"other\"} Whether the link points to an external, internal or other web page.\n\t *\n\t * @private\n\t */\n\t_whichTarget( linkElement, domain ) {\n\t\tconst link = linkElement.getAttribute( \"href\" );\n\n\t\tif ( ! link ) {\n\t\t\treturn \"other\";\n\t\t}\n\n\t\tconst url = urlMethods.parse( link );\n\n\t\tif ( ! this._isHttp( url.protocol ) || url.hash ) {\n\t\t\treturn \"other\";\n\t\t}\n\n\t\tif ( url.hostname === domain ) {\n\t\t\treturn \"internal\";\n\t\t}\n\n\t\treturn \"external\";\n\t}\n\n\t/**\n\t * Returns the permalink from the metadata.\n\t *\n\t * @param {module:parsedPaper/structure.Node} metadata The metadata to retrieve the permalink from.\n\t *\n\t * @returns {string} The permalink.\n\t *\n\t * @private\n\t */\n\t_getPermalink( metadata ) {\n\t\tconst permalinkElement = metadata.children.find( child => child.tag === \"permalink\" );\n\t\tconst paragraph = permalinkElement.children[ 0 ];\n\t\treturn paragraph.textContainer.text;\n\t}\n\n\t/**\n\t * Calculates link statistics for the given node.\n\t *\n\t * @param {module:parsedPaper/structure.Node} node     The node to calculate the research for.\n\t * @param {module:parsedPaper/structure.Node} metadata The document's metadata.\n\t *\n\t * @returns {Promise<Object[]>} The research results.\n\t */\n\tcalculateFor( node, metadata ) {\n\t\t// Collect link elements.\n\t\tconst links = node.textContainer.formatting.filter( element => element.type === \"a\" );\n\n\t\t// URL of the current page.\n\t\tconst permalink = this._getPermalink( metadata );\n\t\tconst url = urlMethods.parse( permalink );\n\n\t\t// Collect statistics about the links.\n\t\tconst results = links.map( link => {\n\t\t\tconst noFollow = this._isNoFollow( link );\n\t\t\tconst target = this._whichTarget( link, url.hostname );\n\n\t\t\treturn { link, noFollow, target };\n\t\t} );\n\n\t\treturn Promise.resolve( results );\n\t}\n}\n\nexport default LinkStatistics;\n"],"mappings":";;;;;;AAAA,IAAAA,IAAA,GAAAC,sBAAA,CAAAC,OAAA;AAGA,IAAAC,SAAA,GAAAF,sBAAA,CAAAC,OAAA;AAAkC,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AADlC;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMG,cAAc,SAASC,iBAAQ,CAAC;EACrC;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACCC,WAAWA,CAAEC,WAAW,EAAG;IAC1B,MAAMC,GAAG,GAAGD,WAAW,CAACE,YAAY,CAAE,KAAM,CAAC;IAE7C,IAAK,CAAED,GAAG,EAAG;MACZ,OAAO,KAAK;IACb;;IAEA;IACA,OAAOA,GAAG,CAACE,KAAK,CAAE,KAAM,CAAC,CAACC,QAAQ,CAAE,UAAW,CAAC;EACjD;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACCC,OAAOA,CAAEC,QAAQ,EAAG;IACnB,IAAK,CAAEA,QAAQ,EAAG;MACjB,OAAO,KAAK;IACb;IAEA,OAASA,QAAQ,KAAK,OAAO,IAAIA,QAAQ,KAAK,QAAQ;EACvD;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACCC,YAAYA,CAAEP,WAAW,EAAEQ,MAAM,EAAG;IACnC,MAAMC,IAAI,GAAGT,WAAW,CAACE,YAAY,CAAE,MAAO,CAAC;IAE/C,IAAK,CAAEO,IAAI,EAAG;MACb,OAAO,OAAO;IACf;IAEA,MAAMC,GAAG,GAAGC,YAAU,CAACC,KAAK,CAAEH,IAAK,CAAC;IAEpC,IAAK,CAAE,IAAI,CAACJ,OAAO,CAAEK,GAAG,CAACJ,QAAS,CAAC,IAAII,GAAG,CAACG,IAAI,EAAG;MACjD,OAAO,OAAO;IACf;IAEA,IAAKH,GAAG,CAACI,QAAQ,KAAKN,MAAM,EAAG;MAC9B,OAAO,UAAU;IAClB;IAEA,OAAO,UAAU;EAClB;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACCO,aAAaA,CAAEC,QAAQ,EAAG;IACzB,MAAMC,gBAAgB,GAAGD,QAAQ,CAACE,QAAQ,CAACC,IAAI,CAAEC,KAAK,IAAIA,KAAK,CAACC,GAAG,KAAK,WAAY,CAAC;IACrF,MAAMC,SAAS,GAAGL,gBAAgB,CAACC,QAAQ,CAAE,CAAC,CAAE;IAChD,OAAOI,SAAS,CAACC,aAAa,CAACC,IAAI;EACpC;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;AACA;EACCC,YAAYA,CAAEC,IAAI,EAAEV,QAAQ,EAAG;IAC9B;IACA,MAAMW,KAAK,GAAGD,IAAI,CAACH,aAAa,CAACK,UAAU,CAACC,MAAM,CAAEC,OAAO,IAAIA,OAAO,CAACC,IAAI,KAAK,GAAI,CAAC;;IAErF;IACA,MAAMC,SAAS,GAAG,IAAI,CAACjB,aAAa,CAAEC,QAAS,CAAC;IAChD,MAAMN,GAAG,GAAGC,YAAU,CAACC,KAAK,CAAEoB,SAAU,CAAC;;IAEzC;IACA,MAAMC,OAAO,GAAGN,KAAK,CAACO,GAAG,CAAEzB,IAAI,IAAI;MAClC,MAAM0B,QAAQ,GAAG,IAAI,CAACpC,WAAW,CAAEU,IAAK,CAAC;MACzC,MAAM2B,MAAM,GAAG,IAAI,CAAC7B,YAAY,CAAEE,IAAI,EAAEC,GAAG,CAACI,QAAS,CAAC;MAEtD,OAAO;QAAEL,IAAI;QAAE0B,QAAQ;QAAEC;MAAO,CAAC;IAClC,CAAE,CAAC;IAEH,OAAOC,OAAO,CAACC,OAAO,CAAEL,OAAQ,CAAC;EAClC;AACD;AAAC,IAAAM,QAAA,GAAAC,OAAA,CAAA5C,OAAA,GAEcC,cAAc","ignoreList":[]}

package/build/parsedPaper/research/researches/Research.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _tree = require("../../structure/tree");
+/**
+ * A research that can be applied to the tree.
+ *
+ * @memberOf module:parsedPaper/research
+ *
+ * @abstract
+ */
+class Research {
+  /**
+   * Checks if the given node is a leaf node for this research.
+   *
+   * @param {module:parsedPaper/structure.Node} node The node to check.
+   *
+   * @returns {boolean} If the given node is considered a leaf node for this research.
+   *
+   */
+  isLeafNode(node) {
+    // eslint-disable-line no-unused-vars
+    return node instanceof _tree.LeafNode;
+  }
+
+  /**
+   * Calculates the result of the research for the given Node.
+   *
+   * @param {module:parsedPaper/structure.Node} node The node to calculate the research for.
+   * @param {module:parsedPaper/structure.Node} metadata The document's metadata.
+   *
+   * @returns {Promise<*>} The result of the research.
+   *
+   * @abstract
+   */
+  calculateFor(node, metadata) {
+    // eslint-disable-line no-unused-vars
+    console.warn("calculateFor should be implemented by a child class of Researcher.");
+  }
+
+  /**
+   * Merges results of this research according to a predefined strategy.
+   *
+   * @param {Array<*>} results The results of this research to merge.
+   *
+   * @returns {*} The merged results.
+   */
+  mergeChildrenResults(results) {
+    // eslint-disable-line no-unused-vars
+    return (0, _lodash.flatten)(results);
+  }
+}
+var _default = exports.default = Research;
+//# sourceMappingURL=Research.js.map

package/build/parsedPaper/research/researches/Research.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Research.js","names":["_lodash","require","_tree","Research","isLeafNode","node","LeafNode","calculateFor","metadata","console","warn","mergeChildrenResults","results","flatten","_default","exports","default"],"sources":["../../../../src/parsedPaper/research/researches/Research.js"],"sourcesContent":["import { flatten } from \"lodash\";\nimport { LeafNode } from \"../../structure/tree\";\n\n/**\n * A research that can be applied to the tree.\n *\n * @memberOf module:parsedPaper/research\n *\n * @abstract\n */\nclass Research {\n\t/**\n\t * Checks if the given node is a leaf node for this research.\n\t *\n\t * @param {module:parsedPaper/structure.Node} node The node to check.\n\t *\n\t * @returns {boolean} If the given node is considered a leaf node for this research.\n\t *\n\t */\n\tisLeafNode( node ) { // eslint-disable-line no-unused-vars\n\t\treturn node instanceof LeafNode;\n\t}\n\n\t/**\n\t * Calculates the result of the research for the given Node.\n\t *\n\t * @param {module:parsedPaper/structure.Node} node The node to calculate the research for.\n\t * @param {module:parsedPaper/structure.Node} metadata The document's metadata.\n\t *\n\t * @returns {Promise<*>} The result of the research.\n\t *\n\t * @abstract\n\t */\n\tcalculateFor( node, metadata ) { // eslint-disable-line no-unused-vars\n\t\tconsole.warn( \"calculateFor should be implemented by a child class of Researcher.\" );\n\t}\n\n\t/**\n\t * Merges results of this research according to a predefined strategy.\n\t *\n\t * @param {Array<*>} results The results of this research to merge.\n\t *\n\t * @returns {*} The merged results.\n\t */\n\tmergeChildrenResults( results ) { // eslint-disable-line no-unused-vars\n\t\treturn flatten( results );\n\t}\n}\n\nexport default Research;\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,KAAA,GAAAD,OAAA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAME,QAAQ,CAAC;EACd;AACD;AACA;AACA;AACA;AACA;AACA;AACA;EACCC,UAAUA,CAAEC,IAAI,EAAG;IAAE;IACpB,OAAOA,IAAI,YAAYC,cAAQ;EAChC;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACCC,YAAYA,CAAEF,IAAI,EAAEG,QAAQ,EAAG;IAAE;IAChCC,OAAO,CAACC,IAAI,CAAE,oEAAqE,CAAC;EACrF;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;EACCC,oBAAoBA,CAAEC,OAAO,EAAG;IAAE;IACjC,OAAO,IAAAC,eAAO,EAAED,OAAQ,CAAC;EAC1B;AACD;AAAC,IAAAE,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAEcb,QAAQ","ignoreList":[]}

package/build/parsedPaper/research/researches/index.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "Headings", {
+  enumerable: true,
+  get: function () {
+    return _Headings.default;
+  }
+});
+var _Headings = _interopRequireDefault(require("./Headings"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+//# sourceMappingURL=index.js.map

package/build/parsedPaper/research/researches/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_Headings","_interopRequireDefault","require","e","__esModule","default"],"sources":["../../../../src/parsedPaper/research/researches/index.js"],"sourcesContent":["export { default as Headings } from \"./Headings\";\n"],"mappings":";;;;;;;;;;;AAAA,IAAAA,SAAA,GAAAC,sBAAA,CAAAC,OAAA;AAAiD,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA","ignoreList":[]}

package/build/parsedPaper/structure/tree/FormattingElement.js

@@ -0,0 +1,73 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _SourceCodeLocation = _interopRequireDefault(require("./SourceCodeLocation"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Represents formatting elements (e.g. link, image, bold text) within a document.
+ *
+ * @memberOf module:parsedPaper/structure
+ */
+class FormattingElement {
+  /**
+   * Represents a formatting element (e.g. link, image, bold text) within a document.
+   *
+   * @param {string} type               The type of this element ("link", "image", "bold", etc.).
+   * @param {Object} sourceCodeLocation The parse5 formatted location of the element inside of the source code.
+   * @param {Object} [attributes=null]  The attributes (as key-value pairs, e.g. `{ href: '...' }` ).
+   */
+  constructor(type, sourceCodeLocation, attributes = null) {
+    /**
+     * Type of formatting element (e.g. "strong", "a").
+     * @type {string}
+     */
+    this.type = type;
+    /**
+     * Attributes of this element (e.g. "href", "id").
+     * @type {?Object}
+     */
+    this.attributes = attributes;
+    /**
+     * Location inside of the source code.
+     * @type {SourceCodeLocation}
+     */
+    this.sourceCodeLocation = new _SourceCodeLocation.default(sourceCodeLocation);
+    /**
+     * Start of this element's content within the parent textContainer's text.
+     * @type {?number}
+     */
+    this.textStartIndex = null;
+    /**
+     * End of this element's content within the parent textContainer's text.
+     * @type {?number}
+     */
+    this.textEndIndex = null;
+    /**
+     * This formatting element's parent.
+     * @type {LeafNode}
+     */
+    this.parent = null;
+  }
+
+  /**
+   * Returns the attribute with the given name if it exists.
+   *
+   * @param {string} name The name of the attribute.
+   *
+   * @returns {false|*} The attribute or `false` if the attribute does not exist.
+   */
+  getAttribute(name) {
+    if (!this.attributes) {
+      return false;
+    }
+    if (name in this.attributes) {
+      return this.attributes[name];
+    }
+    return false;
+  }
+}
+var _default = exports.default = FormattingElement;
+//# sourceMappingURL=FormattingElement.js.map

package/build/parsedPaper/structure/tree/FormattingElement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormattingElement.js","names":["_SourceCodeLocation","_interopRequireDefault","require","e","__esModule","default","FormattingElement","constructor","type","sourceCodeLocation","attributes","SourceCodeLocation","textStartIndex","textEndIndex","parent","getAttribute","name","_default","exports"],"sources":["../../../../src/parsedPaper/structure/tree/FormattingElement.js"],"sourcesContent":["import SourceCodeLocation from \"./SourceCodeLocation\";\n\n/**\n * Represents formatting elements (e.g. link, image, bold text) within a document.\n *\n * @memberOf module:parsedPaper/structure\n */\nclass FormattingElement {\n\t/**\n\t * Represents a formatting element (e.g. link, image, bold text) within a document.\n\t *\n\t * @param {string} type               The type of this element (\"link\", \"image\", \"bold\", etc.).\n\t * @param {Object} sourceCodeLocation The parse5 formatted location of the element inside of the source code.\n\t * @param {Object} [attributes=null]  The attributes (as key-value pairs, e.g. `{ href: '...' }` ).\n\t */\n\tconstructor( type, sourceCodeLocation, attributes = null ) {\n\t\t/**\n\t\t * Type of formatting element (e.g. \"strong\", \"a\").\n\t\t * @type {string}\n\t\t */\n\t\tthis.type = type;\n\t\t/**\n\t\t * Attributes of this element (e.g. \"href\", \"id\").\n\t\t * @type {?Object}\n\t\t */\n\t\tthis.attributes = attributes;\n\t\t/**\n\t\t * Location inside of the source code.\n\t\t * @type {SourceCodeLocation}\n\t\t */\n\t\tthis.sourceCodeLocation = new SourceCodeLocation( sourceCodeLocation );\n\t\t/**\n\t\t * Start of this element's content within the parent textContainer's text.\n\t\t * @type {?number}\n\t\t */\n\t\tthis.textStartIndex = null;\n\t\t/**\n\t\t * End of this element's content within the parent textContainer's text.\n\t\t * @type {?number}\n\t\t */\n\t\tthis.textEndIndex = null;\n\t\t/**\n\t\t * This formatting element's parent.\n\t\t * @type {LeafNode}\n\t\t */\n\t\tthis.parent = null;\n\t}\n\n\t/**\n\t * Returns the attribute with the given name if it exists.\n\t *\n\t * @param {string} name The name of the attribute.\n\t *\n\t * @returns {false|*} The attribute or `false` if the attribute does not exist.\n\t */\n\tgetAttribute( name ) {\n\t\tif ( ! this.attributes ) {\n\t\t\treturn false;\n\t\t}\n\t\tif ( name in this.attributes ) {\n\t\t\treturn this.attributes[ name ];\n\t\t}\n\t\treturn false;\n\t}\n}\n\nexport default FormattingElement;\n"],"mappings":";;;;;;AAAA,IAAAA,mBAAA,GAAAC,sBAAA,CAAAC,OAAA;AAAsD,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEtD;AACA;AACA;AACA;AACA;AACA,MAAMG,iBAAiB,CAAC;EACvB;AACD;AACA;AACA;AACA;AACA;AACA;EACCC,WAAWA,CAAEC,IAAI,EAAEC,kBAAkB,EAAEC,UAAU,GAAG,IAAI,EAAG;IAC1D;AACF;AACA;AACA;IACE,IAAI,CAACF,IAAI,GAAGA,IAAI;IAChB;AACF;AACA;AACA;IACE,IAAI,CAACE,UAAU,GAAGA,UAAU;IAC5B;AACF;AACA;AACA;IACE,IAAI,CAACD,kBAAkB,GAAG,IAAIE,2BAAkB,CAAEF,kBAAmB,CAAC;IACtE;AACF;AACA;AACA;IACE,IAAI,CAACG,cAAc,GAAG,IAAI;IAC1B;AACF;AACA;AACA;IACE,IAAI,CAACC,YAAY,GAAG,IAAI;IACxB;AACF;AACA;AACA;IACE,IAAI,CAACC,MAAM,GAAG,IAAI;EACnB;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;EACCC,YAAYA,CAAEC,IAAI,EAAG;IACpB,IAAK,CAAE,IAAI,CAACN,UAAU,EAAG;MACxB,OAAO,KAAK;IACb;IACA,IAAKM,IAAI,IAAI,IAAI,CAACN,UAAU,EAAG;MAC9B,OAAO,IAAI,CAACA,UAAU,CAAEM,IAAI,CAAE;IAC/B;IACA,OAAO,KAAK;EACb;AACD;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAb,OAAA,GAEcC,iBAAiB","ignoreList":[]}

package/build/parsedPaper/structure/tree/SourceCodeLocation.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/**
+ * A location of an element in the source code.
+ */
+class SourceCodeLocation {
+  /**
+   * A location of an element in the source code.
+   *
+   * @param {Object?} startTag The location of the start tag of the element, if it has one.
+   * @param {number} startTag.startOffset The start position of the start tag.
+   * @param {number} startTag.endOffset The end position of the start tag.
+   *
+   * @param {Object?} endTag The location of the end tag of the element, if it has one.
+   * @param {number} endTag.startOffset The start position of the end tag.
+   * @param {number} endTag.endOffset The end position of the end tag.
+   *
+   * @param {Object} startOffset The start position of the element.
+   * @param {Object} endOffset The end position of the element.
+   */
+  constructor({
+    startTag,
+    endTag,
+    startOffset,
+    endOffset
+  }) {
+    if (startTag) {
+      this.startTag = {
+        startOffset: startTag.startOffset,
+        endOffset: startTag.endOffset
+      };
+    }
+    if (endTag) {
+      this.endTag = {
+        startOffset: endTag.startOffset,
+        endOffset: endTag.endOffset
+      };
+    }
+    this.startOffset = startOffset;
+    this.endOffset = endOffset;
+  }
+}
+var _default = exports.default = SourceCodeLocation;
+//# sourceMappingURL=SourceCodeLocation.js.map

package/build/parsedPaper/structure/tree/SourceCodeLocation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SourceCodeLocation.js","names":["SourceCodeLocation","constructor","startTag","endTag","startOffset","endOffset","_default","exports","default"],"sources":["../../../../src/parsedPaper/structure/tree/SourceCodeLocation.js"],"sourcesContent":["/**\n * A location of an element in the source code.\n */\nclass SourceCodeLocation {\n\t/**\n\t * A location of an element in the source code.\n\t *\n\t * @param {Object?} startTag The location of the start tag of the element, if it has one.\n\t * @param {number} startTag.startOffset The start position of the start tag.\n\t * @param {number} startTag.endOffset The end position of the start tag.\n\t *\n\t * @param {Object?} endTag The location of the end tag of the element, if it has one.\n\t * @param {number} endTag.startOffset The start position of the end tag.\n\t * @param {number} endTag.endOffset The end position of the end tag.\n\t *\n\t * @param {Object} startOffset The start position of the element.\n\t * @param {Object} endOffset The end position of the element.\n\t */\n\tconstructor( { startTag, endTag, startOffset, endOffset } ) {\n\t\tif ( startTag ) {\n\t\t\tthis.startTag = { startOffset: startTag.startOffset, endOffset: startTag.endOffset };\n\t\t}\n\t\tif ( endTag ) {\n\t\t\tthis.endTag = { startOffset: endTag.startOffset, endOffset: endTag.endOffset };\n\t\t}\n\t\tthis.startOffset = startOffset;\n\t\tthis.endOffset = endOffset;\n\t}\n}\n\nexport default SourceCodeLocation;\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA,MAAMA,kBAAkB,CAAC;EACxB;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACCC,WAAWA,CAAE;IAAEC,QAAQ;IAAEC,MAAM;IAAEC,WAAW;IAAEC;EAAU,CAAC,EAAG;IAC3D,IAAKH,QAAQ,EAAG;MACf,IAAI,CAACA,QAAQ,GAAG;QAAEE,WAAW,EAAEF,QAAQ,CAACE,WAAW;QAAEC,SAAS,EAAEH,QAAQ,CAACG;MAAU,CAAC;IACrF;IACA,IAAKF,MAAM,EAAG;MACb,IAAI,CAACA,MAAM,GAAG;QAAEC,WAAW,EAAED,MAAM,CAACC,WAAW;QAAEC,SAAS,EAAEF,MAAM,CAACE;MAAU,CAAC;IAC/E;IACA,IAAI,CAACD,WAAW,GAAGA,WAAW;IAC9B,IAAI,CAACC,SAAS,GAAGA,SAAS;EAC3B;AACD;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAEcR,kBAAkB","ignoreList":[]}

package/build/parsedPaper/structure/tree/TextContainer.js

@@ -0,0 +1,89 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _parseText = require("../../build/linguisticParsing/parseText");
+/**
+ * Represents a text (with optional formatting element(s)) within a document that can be read by a reader.
+ *
+ * Example (in the case of HTML):
+ * ```html
+ * This text is <strong id="elem-id">very strong</strong>.
+ * ```
+ * is transformed to:
+ * ```js
+ * TextContainer {
+ *     text: "This text is very strong".
+ *     formatting: [
+ *         FormattingElement {
+ *             type: "strong",
+ *             sourceStartIndex: 13, // "This text is ".length
+ *             sourceEndIndex: 54,   // "This text is <strong id="elem-id">very strong</strong>".length
+ *             textStartIndex: 13,  // "This text is ".length
+ *             textEndIndex: 24,    // "This text is very strong".length
+ *             attributes: {
+ *                 id: "elem-id"
+ *             }
+ *         }
+ *     ]
+ * }
+ * ```
+ *
+ * @memberOf module:parsedPaper/structure
+ */
+class TextContainer {
+  /**
+   * Represents a text (with optional formatting element(s)) within a document that can be read by a reader.
+   */
+  constructor() {
+    /**
+     * Clean, analyzable text, without formatting.
+     * @type {string}
+     */
+    this.text = "";
+    /**
+     * This text's formatting (e.g. bold text, links, etc.).
+     * @type {Array<module:parsedPaper/structure.FormattingElement>}
+     */
+    this.formatting = [];
+
+    /**
+     * A cache for the tree representations of this container's text.
+     */
+    this._tree = {};
+  }
+
+  /**
+   * Adds a text string to this container's text.
+   *
+   * @param {string} text The text to be added to the TextContainer.
+   *
+   * @returns {void}
+   */
+  appendText(text) {
+    // If the text changes, the 'linguistic' tree should be rebuilt. This means the cache should be cleared.
+    this.text += text;
+    this._tree = {};
+  }
+
+  /**
+   * Returns the tree representation of this container's text.
+   *
+   * If the cache is filled, it will return the cached tree.
+   * If the cache is empty, it will additionally construct the tree and fill the cache.
+   *
+   * @returns {Object} The tree representation of the text.
+   */
+  getTree() {
+    if (!(0, _lodash.isEmpty)(this._tree)) {
+      return this._tree;
+    }
+    this._tree = (0, _parseText.parseTextIntoSentences)(this.text);
+    return this._tree;
+  }
+}
+var _default = exports.default = TextContainer;
+//# sourceMappingURL=TextContainer.js.map

package/build/parsedPaper/structure/tree/TextContainer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextContainer.js","names":["_lodash","require","_parseText","TextContainer","constructor","text","formatting","_tree","appendText","getTree","isEmpty","parseTextIntoSentences","_default","exports","default"],"sources":["../../../../src/parsedPaper/structure/tree/TextContainer.js"],"sourcesContent":["import { isEmpty } from \"lodash\";\nimport { parseTextIntoSentences } from \"../../build/linguisticParsing/parseText\";\n\n/**\n * Represents a text (with optional formatting element(s)) within a document that can be read by a reader.\n *\n * Example (in the case of HTML):\n * ```html\n * This text is <strong id=\"elem-id\">very strong</strong>.\n * ```\n * is transformed to:\n * ```js\n * TextContainer {\n *     text: \"This text is very strong\".\n *     formatting: [\n *         FormattingElement {\n *             type: \"strong\",\n *             sourceStartIndex: 13, // \"This text is \".length\n *             sourceEndIndex: 54,   // \"This text is <strong id=\"elem-id\">very strong</strong>\".length\n *             textStartIndex: 13,  // \"This text is \".length\n *             textEndIndex: 24,    // \"This text is very strong\".length\n *             attributes: {\n *                 id: \"elem-id\"\n *             }\n *         }\n *     ]\n * }\n * ```\n *\n * @memberOf module:parsedPaper/structure\n */\nclass TextContainer {\n\t/**\n\t * Represents a text (with optional formatting element(s)) within a document that can be read by a reader.\n\t */\n\tconstructor() {\n\t\t/**\n\t\t * Clean, analyzable text, without formatting.\n\t\t * @type {string}\n\t\t */\n\t\tthis.text = \"\";\n\t\t/**\n\t\t * This text's formatting (e.g. bold text, links, etc.).\n\t\t * @type {Array<module:parsedPaper/structure.FormattingElement>}\n\t\t */\n\t\tthis.formatting = [];\n\n\t\t/**\n\t\t * A cache for the tree representations of this container's text.\n\t\t */\n\t\tthis._tree = {};\n\t}\n\n\t/**\n\t * Adds a text string to this container's text.\n\t *\n\t * @param {string} text The text to be added to the TextContainer.\n\t *\n\t * @returns {void}\n\t */\n\tappendText( text ) {\n\t\t// If the text changes, the 'linguistic' tree should be rebuilt. This means the cache should be cleared.\n\t\tthis.text += text;\n\t\tthis._tree = {};\n\t}\n\n\t/**\n\t * Returns the tree representation of this container's text.\n\t *\n\t * If the cache is filled, it will return the cached tree.\n\t * If the cache is empty, it will additionally construct the tree and fill the cache.\n\t *\n\t * @returns {Object} The tree representation of the text.\n\t */\n\tgetTree() {\n\t\tif ( ! isEmpty( this._tree ) ) {\n\t\t\treturn this._tree;\n\t\t}\n\n\t\tthis._tree = parseTextIntoSentences( this.text );\n\t\treturn this._tree;\n\t}\n}\n\nexport default TextContainer;\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAME,aAAa,CAAC;EACnB;AACD;AACA;EACCC,WAAWA,CAAA,EAAG;IACb;AACF;AACA;AACA;IACE,IAAI,CAACC,IAAI,GAAG,EAAE;IACd;AACF;AACA;AACA;IACE,IAAI,CAACC,UAAU,GAAG,EAAE;;IAEpB;AACF;AACA;IACE,IAAI,CAACC,KAAK,GAAG,CAAC,CAAC;EAChB;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;EACCC,UAAUA,CAAEH,IAAI,EAAG;IAClB;IACA,IAAI,CAACA,IAAI,IAAIA,IAAI;IACjB,IAAI,CAACE,KAAK,GAAG,CAAC,CAAC;EAChB;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;AACA;EACCE,OAAOA,CAAA,EAAG;IACT,IAAK,CAAE,IAAAC,eAAO,EAAE,IAAI,CAACH,KAAM,CAAC,EAAG;MAC9B,OAAO,IAAI,CAACA,KAAK;IAClB;IAEA,IAAI,CAACA,KAAK,GAAG,IAAAI,iCAAsB,EAAE,IAAI,CAACN,IAAK,CAAC;IAChD,OAAO,IAAI,CAACE,KAAK;EAClB;AACD;AAAC,IAAAK,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAEcX,aAAa","ignoreList":[]}

package/build/parsedPaper/structure/tree/index.js

@@ -0,0 +1,76 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "FormattingElement", {
+  enumerable: true,
+  get: function () {
+    return _FormattingElement.default;
+  }
+});
+Object.defineProperty(exports, "Heading", {
+  enumerable: true,
+  get: function () {
+    return _nodes.Heading;
+  }
+});
+Object.defineProperty(exports, "LeafNode", {
+  enumerable: true,
+  get: function () {
+    return _nodes.LeafNode;
+  }
+});
+Object.defineProperty(exports, "List", {
+  enumerable: true,
+  get: function () {
+    return _nodes.List;
+  }
+});
+Object.defineProperty(exports, "ListItem", {
+  enumerable: true,
+  get: function () {
+    return _nodes.ListItem;
+  }
+});
+Object.defineProperty(exports, "MetadataMiscellaneous", {
+  enumerable: true,
+  get: function () {
+    return _nodes.MetadataMiscellaneous;
+  }
+});
+Object.defineProperty(exports, "MetadataText", {
+  enumerable: true,
+  get: function () {
+    return _nodes.MetadataText;
+  }
+});
+Object.defineProperty(exports, "Node", {
+  enumerable: true,
+  get: function () {
+    return _nodes.Node;
+  }
+});
+Object.defineProperty(exports, "Paragraph", {
+  enumerable: true,
+  get: function () {
+    return _nodes.Paragraph;
+  }
+});
+Object.defineProperty(exports, "StructuredNode", {
+  enumerable: true,
+  get: function () {
+    return _nodes.StructuredNode;
+  }
+});
+Object.defineProperty(exports, "TextContainer", {
+  enumerable: true,
+  get: function () {
+    return _TextContainer.default;
+  }
+});
+var _FormattingElement = _interopRequireDefault(require("./FormattingElement"));
+var _nodes = require("./nodes");
+var _TextContainer = _interopRequireDefault(require("./TextContainer"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+//# sourceMappingURL=index.js.map

package/build/parsedPaper/structure/tree/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_FormattingElement","_interopRequireDefault","require","_nodes","_TextContainer","e","__esModule","default"],"sources":["../../../../src/parsedPaper/structure/tree/index.js"],"sourcesContent":["import FormattingElement from \"./FormattingElement\";\nimport { Heading, LeafNode, List, ListItem, MetadataMiscellaneous, MetadataText, Node, Paragraph, StructuredNode } from \"./nodes\";\nimport TextContainer from \"./TextContainer\";\n\n/**\n * The collection of elements used in constructing the tree structure.\n *\n * @module parsedPaper/structure\n */\nexport {\n\tHeading,\n\tLeafNode,\n\tList,\n\tListItem,\n\tMetadataText,\n\tMetadataMiscellaneous,\n\tNode,\n\tParagraph,\n\tStructuredNode,\n\tTextContainer,\n\tFormattingElement,\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAAA,kBAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,MAAA,GAAAD,OAAA;AACA,IAAAE,cAAA,GAAAH,sBAAA,CAAAC,OAAA;AAA4C,SAAAD,uBAAAI,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA","ignoreList":[]}

package/build/parsedPaper/structure/tree/nodes/Heading.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _LeafNode = _interopRequireDefault(require("./LeafNode"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * A header in a document.
+ *
+ * @extends module:parsedPaper/structure.LeafNode
+ *
+ * @memberOf module:parsedPaper/structure
+ */
+class Heading extends _LeafNode.default {
+  /**
+   * Makes a new header object.
+   *
+   * @param {number} level              The header level (e.g. 1 for main heading, 2 for subheading lvl 2, etc.)
+   * @param {Object} sourceCodeLocation The parse5 formatted location of the element inside of the source code.
+   */
+  constructor(level, sourceCodeLocation) {
+    super("Heading", sourceCodeLocation);
+    /**
+     * Heading's level (e.g. 1 for "h1", 2 for "h2", ... ).
+     * @type {number}
+     */
+    this.level = level;
+  }
+}
+var _default = exports.default = Heading;
+//# sourceMappingURL=Heading.js.map

package/build/parsedPaper/structure/tree/nodes/Heading.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Heading.js","names":["_LeafNode","_interopRequireDefault","require","e","__esModule","default","Heading","LeafNode","constructor","level","sourceCodeLocation","_default","exports"],"sources":["../../../../../src/parsedPaper/structure/tree/nodes/Heading.js"],"sourcesContent":["import LeafNode from \"./LeafNode\";\n\n/**\n * A header in a document.\n *\n * @extends module:parsedPaper/structure.LeafNode\n *\n * @memberOf module:parsedPaper/structure\n */\nclass Heading extends LeafNode {\n\t/**\n\t * Makes a new header object.\n\t *\n\t * @param {number} level              The header level (e.g. 1 for main heading, 2 for subheading lvl 2, etc.)\n\t * @param {Object} sourceCodeLocation The parse5 formatted location of the element inside of the source code.\n\t */\n\tconstructor( level, sourceCodeLocation ) {\n\t\tsuper( \"Heading\", sourceCodeLocation );\n\t\t/**\n\t\t * Heading's level (e.g. 1 for \"h1\", 2 for \"h2\", ... ).\n\t\t * @type {number}\n\t\t */\n\t\tthis.level = level;\n\t}\n}\nexport default Heading;\n"],"mappings":";;;;;;AAAA,IAAAA,SAAA,GAAAC,sBAAA,CAAAC,OAAA;AAAkC,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAElC;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMG,OAAO,SAASC,iBAAQ,CAAC;EAC9B;AACD;AACA;AACA;AACA;AACA;EACCC,WAAWA,CAAEC,KAAK,EAAEC,kBAAkB,EAAG;IACxC,KAAK,CAAE,SAAS,EAAEA,kBAAmB,CAAC;IACtC;AACF;AACA;AACA;IACE,IAAI,CAACD,KAAK,GAAGA,KAAK;EACnB;AACD;AAAC,IAAAE,QAAA,GAAAC,OAAA,CAAAP,OAAA,GACcC,OAAO","ignoreList":[]}