yoastseo-dep/src/parsedPaper/structure/tree/TextContainer.js

Yoast clientside page analysis

import { isEmpty } from "lodash-es";
import { parseTextIntoSentences } from "../../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 ( ! isEmpty( this._tree ) ) {
			return this._tree;
		}

		this._tree = parseTextIntoSentences( this.text );
		return this._tree;
	}
}

export default TextContainer;