yoastseo-dep/src/values/Paper.js

Yoast clientside page analysis

import { defaults, isEmpty, isEqual, isNil } from "lodash-es";

/**
 * Default attributes to be used by the Paper if they are left undefined.
 * @type {{keyword: string, synonyms: string, description: string, title: string, titleWidth: number,
 * 		   slug: string, locale: string, permalink: string, date: string, customData: object, textTitle: string, writingDirection: "LTR" }}
 */
const defaultAttributes = {
	keyword: "",
	synonyms: "",
	description: "",
	title: "",
	titleWidth: 0,
	slug: "",
	locale: "en_US",
	permalink: "",
	date: "",
	customData: {},
	textTitle: "",
	writingDirection: "LTR",
};

/**
 * Constructs the Paper object and sets the keyword property.
 *
 * @param {string}  text                            The text to use in the analysis.
 * @param {object}  [attributes]                    The object containing all attributes.
 * @param {string}  [attributes.keyword]            The main keyword.
 * @param {string}  [attributes.synonyms]           The main keyword's synonyms.
 * @param {string}  [attributes.description]        The SEO description.
 * @param {string}  [attributes.title]              The SEO title.
 * @param {number}  [attributes.titleWidth]         The width of the title in pixels.
 * @param {string}  [attributes.slug]               The slug.
 * @param {string}  [attributes.locale]             The locale.
 * @param {string}  [attributes.permalink]          The base url + slug.
 * @param {string}  [attributes.date]               The date.
 * @param {Object}  [attributes.wpBlocks]           The text, encoded in WordPress block editor blocks.
 * @param {Object}  [attributes.customData]         Custom data.
 * @param {string}  [attributes.textTitle]          The title of the text.
 * @param {string}  [attributes.writingDirection]   The writing direction of the paper. Defaults to left to right (LTR).
 *
 * @constructor
 */
function Paper( text, attributes ) {
	this._text = text || "";

	this._tree = null;

	attributes = attributes || {};
	defaults( attributes, defaultAttributes );

	if ( attributes.locale === "" ) {
		attributes.locale = defaultAttributes.locale;
	}

	if ( attributes.hasOwnProperty( "url" ) ) {
		// The 'url' attribute has been deprecated since version 18.8, refer to hasUrl and getUrl below.
		console.warn( "The 'url' attribute is deprecated, use 'slug' instead." );
		attributes.slug = attributes.url || attributes.slug;
	}

	const onlyLetters = attributes.keyword.replace( /[‘’“”"'.?!:;,¿¡«»&*@#±^%|~`[\](){}⟨⟩<>/\\–\-\u2014\u00d7\u002b\u0026\s]/g, "" );

	if ( isEmpty( onlyLetters ) ) {
		attributes.keyword = defaultAttributes.keyword;
	}

	this._attributes = attributes;
}


/**
 * Checks whether a keyword is available.
 * @returns {boolean} Returns true if the Paper has a keyword.
 */
Paper.prototype.hasKeyword = function() {
	return this._attributes.keyword !== "";
};

/**
 * Returns the associated keyword or an empty string if no keyword is available.
 * @returns {string} Returns Keyword
 */
Paper.prototype.getKeyword = function() {
	return this._attributes.keyword;
};

/**
 * Checks whether synonyms are available.
 * @returns {boolean} Returns true if the Paper has synonyms.
 */
Paper.prototype.hasSynonyms = function() {
	return this._attributes.synonyms !== "";
};

/**
 * Returns the associated synonyms or an empty string if no synonyms is available.
 * @returns {string} Returns synonyms.
 */
Paper.prototype.getSynonyms = function() {
	return this._attributes.synonyms;
};

/**
 * Checks whether the text is available.
 * @returns {boolean} Returns true if the paper has a text.
 */
Paper.prototype.hasText = function() {
	return this._text !== "";
};

/**
 * Returns the associated text or am empty string if no text is available.
 * @returns {string} Returns text
 */
Paper.prototype.getText = function() {
	return this._text;
};

/**
 * Sets the tree.
 *
 * @param {Node} tree The tree to set.
 *
 * @returns {void}
 */
Paper.prototype.setTree = function( tree ) {
	this._tree = tree;
};

/**
 * Returns the tree.
 *
 * @returns {Node} The tree.
 */
Paper.prototype.getTree = function() {
	return this._tree;
};

/**
 * Checks whether a description is available.
 * @returns {boolean} Returns true if the paper has a description.
 */
Paper.prototype.hasDescription = function() {
	return this._attributes.description !== "";
};

/**
 * Returns the description or an empty string if no description is available.
 * @returns {string} Returns the description.
 */
Paper.prototype.getDescription = function() {
	return this._attributes.description;
};

/**
 * Checks whether a title is available
 * @returns {boolean} Returns true if the Paper has a title.
 */
Paper.prototype.hasTitle = function() {
	return this._attributes.title !== "";
};

/**
 * Returns the title, or an empty string of no title is available.
 * @returns {string} Returns the title
 */
Paper.prototype.getTitle = function() {
	return this._attributes.title;
};

/**
 * Checks whether a title width in pixels is available
 * @returns {boolean} Returns true if the Paper has a title.
 */
Paper.prototype.hasTitleWidth = function() {
	return this._attributes.titleWidth !== 0;
};

/**
 * Returns the title width in pixels, or an empty string of no title width in pixels is available.
 * @returns {string} Returns the title
 */
Paper.prototype.getTitleWidth = function() {
	return this._attributes.titleWidth;
};

/**
 * Checks whether a slug is available
 * @returns {boolean} Returns true if the Paper has a slug.
 */
Paper.prototype.hasSlug = function() {
	return this._attributes.slug !== "";
};

/**
 * Returns the slug, or an empty string of no slug is available.
 * @returns {string} Returns the url
 */
Paper.prototype.getSlug = function() {
	return this._attributes.slug;
};

/**
 * Checks whether an url is available
 * @deprecated Since version 18.7. Use hasSlug instead.
 * @returns {boolean} Returns true if the Paper has a slug.
 */
Paper.prototype.hasUrl = function() {
	console.warn( "This function is deprecated, use hasSlug instead" );
	return this.hasSlug();
};

/**
 * Returns the url, or an empty string if no url is available.
 * @deprecated Since version 18.8. Use getSlug instead.
 * @returns {string} Returns the url
 */
Paper.prototype.getUrl = function() {
	console.warn( "This function is deprecated, use getSlug instead" );
	return this.getSlug();
};

/**
 * Checks whether a locale is available
 * @returns {boolean} Returns true if the paper has a locale
 */
Paper.prototype.hasLocale = function() {
	return this._attributes.locale !== "";
};

/**
 * Returns the locale or an empty string if no locale is available
 * @returns {string} Returns the locale
 */
Paper.prototype.getLocale = function() {
	return this._attributes.locale;
};

/**
 * Gets the information of the writing direction of the paper.
 * It returns "LTR" (left to right) if this attribute is not provided.
 *
 * @returns {string} Returns the information of the writing direction of the paper.
 */
Paper.prototype.getWritingDirection = function() {
	return this._attributes.writingDirection;
};

/**
 * Checks whether a permalink is available
 * @returns {boolean} Returns true if the Paper has a permalink.
 */
Paper.prototype.hasPermalink = function() {
	return this._attributes.permalink !== "";
};

/**
 * Returns the permalink, or an empty string if no permalink is available.
 * @returns {string} Returns the permalink.
 */
Paper.prototype.getPermalink = function() {
	return this._attributes.permalink;
};

/**
 * Checks whether a date is available.
 * @returns {boolean} Returns true if the Paper has a date.
 */
Paper.prototype.hasDate = function() {
	return this._attributes.date !== "";
};

/**
 * Returns the date, or an empty string if no date is available.
 * @returns {string} Returns the date.
 */
Paper.prototype.getDate = function() {
	return this._attributes.date;
};

/**
 * Checks whether custom data is available.
 * @returns {boolean} Returns true if the Paper has custom data.
 */
Paper.prototype.hasCustomData = function() {
	return ! isEmpty( this._attributes.customData );
};

/**
 * Returns the custom data, or an empty object if no data is available.
 * @returns {Object} Returns the custom data.
 */
Paper.prototype.getCustomData = function() {
	return this._attributes.customData;
};

/**
 * Checks whether a text title is available.
 * @returns {boolean} Returns true if the Paper has a text title.
 */
Paper.prototype.hasTextTitle = function() {
	return this._attributes.textTitle !== "" && ! isNil( this._attributes.textTitle );
};

/**
 * Returns the text title, or an empty string if no data is available.
 * @returns {string} Returns the text title.
 */
Paper.prototype.getTextTitle = function() {
	return this._attributes.textTitle;
};

/**
 * Serializes the Paper instance to an object.
 *
 * @returns {Object} The serialized Paper.
 */
Paper.prototype.serialize = function() {
	return {
		_parseClass: "Paper",
		text: this._text,
		...this._attributes,
	};
};

/**
 * Checks whether the given paper has the same properties as this instance.
 *
 * @param {Paper} paper The paper to compare to.
 *
 * @returns {boolean} Whether the given paper is identical or not.
 */
Paper.prototype.equals = function( paper ) {
	return this._text === paper.getText() && isEqual( this._attributes, paper._attributes );
};

/**
 * Parses the object to a Paper.
 *
 * @param {Object|Paper} serialized The serialized object or Paper instance.
 *
 * @returns {Paper} The parsed Paper.
 */
Paper.parse = function( serialized ) {
	// For ease of use, check if it is not already a Paper instance.
	if ( serialized instanceof Paper ) {
		return serialized;
	}

	// _parseClass is taken here, so it doesn't end up in the attributes.
	// eslint-disable-next-line no-unused-vars
	const { text, _parseClass, ...attributes } = serialized;

	return new Paper( text, attributes );
};

export default Paper;