yoastseo-dep/src/bundledPlugins/previouslyUsedKeywords.js

Yoast clientside page analysis

import { __, sprintf } from "@wordpress/i18n";
import { isUndefined } from "lodash-es";

import MissingArgument from "../errors/missingArgument";
import { createAnchorOpeningTag } from "../helpers/shortlinker";
import AssessmentResult from "../values/AssessmentResult.js";


/**
 * @param {object} app The app
 * @param {object} args An arguments object with usedKeywords, searchUrl, postUrl,
 * @param {object} args.usedKeywords An object with keywords and ids where they are used.
 * @param {object} args.usedKeywordsPostTypes An object with the post types of the post ids from usedKeywords.
 * @param {string} args.searchUrl The url used to link to a search page when multiple usages of the keyword are found.
 * @param {string} args.postUrl The url used to link to a post when 1 usage of the keyword is found.
 * @constructor
 */
var PreviouslyUsedKeyword = function( app, args ) {
	if ( isUndefined( app ) ) {
		throw new MissingArgument( "The previously keyword plugin requires the YoastSEO app" );
	}

	if ( isUndefined( args ) ) {
		args = {
			usedKeywords: {},
			usedKeywordsPostTypes: {},
			searchUrl: "",
			postUrl: "",
		};
	}

	this.app = app;
	this.usedKeywords = args.usedKeywords;
	this.usedKeywordsPostTypes = args.usedKeywordsPostTypes;
	this.searchUrl = args.searchUrl;
	this.postUrl = args.postUrl;
	this.urlTitle = createAnchorOpeningTag( "https://yoa.st/33x" );
	this.urlCallToAction = createAnchorOpeningTag( "https://yoa.st/33y" );
};

/**
 * Registers the assessment with the assessor.
 *
 * @returns {void}
 */
PreviouslyUsedKeyword.prototype.registerPlugin = function() {
	this.app.registerAssessment( "usedKeywords", {
		getResult: this.assess.bind( this ),
		/**
		 * Checks if the paper has a keyphrase, which is a prerequisite for the assessment to run.
		 *
		 * @param {Paper} paper The paper.
		 *
		 * @returns {boolean} Whether the paper has a keyphrase.
		 */
		isApplicable: function( paper ) {
			return paper.hasKeyword();
		},
	}, "previouslyUsedKeywords" );
};

/**
 * Updates the usedKeywords.
 *
 * @param {object} usedKeywords An object with keywords and ids where they are used.
 * @param {object} usedKeywordsPostTypes An object with keywords and in which post types they are used.
 * The post types correspond with the ids in the usedKeywords parameter.
 * @returns {void}
 */
PreviouslyUsedKeyword.prototype.updateKeywordUsage = function( usedKeywords, usedKeywordsPostTypes ) {
	this.usedKeywords = usedKeywords;
	this.usedKeywordsPostTypes = usedKeywordsPostTypes;
};

/**
 * Scores the previously used keyword assessment based on the count.
 *
 * @param {object} previouslyUsedKeywords The result of the previously used keywords research
 * @param {Paper} paper The paper object to research.
 * @returns {object} the scoreobject with text and score.
 */
PreviouslyUsedKeyword.prototype.scoreAssessment = function( previouslyUsedKeywords, paper ) {
	const count = previouslyUsedKeywords.count;
	const id = previouslyUsedKeywords.id;
	const postTypeToDisplay = previouslyUsedKeywords.postTypeToDisplay;
	let url;

	if ( count === 0 ) {
		return {
			text: sprintf(
				/* translators:
				%1$s expands to a link to an article on yoast.com,
				%2$s expands to an anchor tag. */
				__( "%1$sPreviously used keyphrase%2$s: You've not used this keyphrase before, very good.", "wordpress-seo" ),
				this.urlTitle,
				"</a>"
			),
			score: 9,
		};
	}
	if ( count === 1 ) {
		url = `<a href='${this.postUrl.replace( "{id}", id )}' target='_blank'>`;
		return {
			/* translators: %1$s and %2$s expand to an admin link where the keyword is already used. %3$s and %4$s
			expand to links on yoast.com, %4$s expands to the anchor end tag. */
			text: sprintf( __(
				// eslint-disable-next-line max-len
				"%3$sPreviously used keyphrase%5$s: You've used this keyphrase %1$sonce before%2$s. %4$sDo not use your keyphrase more than once%5$s.",
				"wordpress-seo"
			),
			url,
			"</a>",
			this.urlTitle,
			this.urlCallToAction,
			"</a>"
			),
			score: 6,
		};
	}

	if ( count > 1 ) {
		if ( postTypeToDisplay ) {
			// eslint-disable-next-line max-len
			url = `<a href='${this.searchUrl.replace( "{keyword}", encodeURIComponent( paper.getKeyword() ) )}&post_type=${postTypeToDisplay}' target='_blank'>`;
		} else {
			url = `<a href='${this.searchUrl.replace( "{keyword}", encodeURIComponent( paper.getKeyword() ) )}' target='_blank'>`;
		}

		return {
			/* translators: %1$s and $3$s expand to the admin search page for the keyword, %2$d expands to the number
			of times this keyword has been used before, %4$s and %5$s expand to links to yoast.com, %6$s expands to
			the anchor end tag */
			text: sprintf( __(
				// eslint-disable-next-line max-len
				"%4$sPreviously used keyphrase%6$s: You've used this keyphrase %1$s multiple times before%3$s. %5$sDo not use your keyphrase more than once%6$s.",
				"wordpress-seo"
			),
			url,
			count,
			"</a>",
			this.urlTitle,
			this.urlCallToAction,
			"</a>"
			),
			score: 1,
		};
	}
};

/**
 * Researches the previously used keywords, based on the used keywords and the keyword in the paper.
 *
 * @param {Paper} paper The paper object to research.
 * @returns {{id: number, count: number}} The object with the count and the id of the previously used keyword
 */
PreviouslyUsedKeyword.prototype.researchPreviouslyUsedKeywords = function( paper ) {
	const keyword = paper.getKeyword();
	let count = 0;
	let postTypeToDisplay = "";
	let id = 0;

	if ( ! isUndefined( this.usedKeywords[ keyword ] ) && this.usedKeywords[ keyword ].length > 0 ) {
		count = this.usedKeywords[ keyword ].length;
		if ( this.usedKeywordsPostTypes ) {
			postTypeToDisplay = this.usedKeywordsPostTypes[ keyword ][ 0 ];
		}
		id = this.usedKeywords[ keyword ][ 0 ];
	}

	return {
		id: id,
		count: count,
		postTypeToDisplay: postTypeToDisplay,
	};
};

/**
 * The assessment for the previously used keywords.
 *
 * @param {Paper} paper The Paper object to assess.
 * @returns {AssessmentResult} The assessment result of the assessment
 */
PreviouslyUsedKeyword.prototype.assess = function( paper ) {
	var previouslyUsedKeywords = this.researchPreviouslyUsedKeywords( paper );
	var previouslyUsedKeywordsResult = this.scoreAssessment( previouslyUsedKeywords, paper );

	var assessmentResult =  new AssessmentResult();
	assessmentResult.setScore( previouslyUsedKeywordsResult.score );
	assessmentResult.setText( previouslyUsedKeywordsResult.text );

	return assessmentResult;
};

export default PreviouslyUsedKeyword;