yoastseo/build/parsedPaper/assess/assessorFactories.js

Yoast client-side content analysis

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.constructSEOAssessor = exports.constructReadabilityAssessor = void 0;
var _assessmentListFactories = require("./assessmentListFactories");
var _assessmentListFactories2 = require("./cornerstone/assessmentListFactories");
var _scoreAggregators = require("../../scoring/scoreAggregators");
var _TreeAssessor = _interopRequireDefault(require("./TreeAssessor"));
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
/* Assessment list factories. */

/* Score aggregators */

/* Base TreeAssessor class */

/**
 * Maps combinations of assessor parameters (if the assessor is for related keyphrases, cornerstone content and/or taxonomy pages)
 * to functions that generate a list of applicable assessments.
 *
 * @const
 * @private
 * @type {Object}
 */
const SEO_ASSESSMENTS_MAP = {
  Default: _assessmentListFactories.constructSEOAssessments,
  RelatedKeyphrase: _assessmentListFactories.constructRelatedKeyphraseAssessments,
  Taxonomy: _assessmentListFactories.constructTaxonomyAssessments,
  RelatedKeyphraseTaxonomy: _assessmentListFactories.constructRelatedKeyphraseTaxonomyAssessments,
  Cornerstone: _assessmentListFactories2.constructSEOAssessments,
  CornerstoneRelatedKeyphrase: _assessmentListFactories2.constructRelatedKeyphraseAssessments
};

/**
 * Constructs a new SEO assessor.
 *
 * @param {module:parsedPaper/research.TreeResearcher} researcher The researcher the assessments need to use to get information about the text.
 *
 * @param {Object}                              config                    The assessor configuration.
 * @param {boolean}                             [config.relatedKeyphrase] If this assessor is for a related keyphrase, instead of the main one.
 * @param {boolean}                             [config.taxonomy]         If this assessor is for a taxonomy page, instead of a regular page.
 * @param {boolean}                             [config.cornerstone]      If this assessor is for cornerstone content.
 *
 * @returns {module:parsedPaper/assess.TreeAssessor} The created SEO assessor.
 *
 * @throws {Error} An error when no assessor exists for the given combination of configuration options.
 *
 * @memberOf module:parsedPaper/assess
 */
const constructSEOAssessor = function (researcher, config) {
  /*
   * Construct the key to retrieve the right assessment list factory.
   * E.g. "RelatedKeyphraseTaxonomy" for related keyphrase + taxonomy;
   */
  const cornerstone = config.cornerstone ? "Cornerstone" : "";
  const relatedKeyphrase = config.relatedKeyphrase ? "RelatedKeyphrase" : "";
  const taxonomy = config.taxonomy ? "Taxonomy" : "";

  // (Empty key defaults to "Default" key)
  const key = [cornerstone, relatedKeyphrase, taxonomy].join("") || "Default";

  // Retrieve the assessment list factory.
  const assessmentFactory = SEO_ASSESSMENTS_MAP[key];

  // This specific combination of cornerstone, taxonomy and related keyphrase does not exist.
  if (!assessmentFactory) {
    throw new Error("Cannot make an assessor based on the provided combination of configuration options");
  }

  // Construct assessor.
  const assessments = assessmentFactory();
  const scoreAggregator = new _scoreAggregators.SEOScoreAggregator();
  return new _TreeAssessor.default({
    researcher,
    assessments,
    scoreAggregator
  });
};

/**
 * Constructs a new readability assessor.
 *
 * @param {module:parsedPaper/research.TreeResearcher} researcher           The researcher the assessments need to use to
 *                                                                          get information about the text.
 * @param {boolean}                                    isCornerstoneContent If the to be analyzed content is considered cornerstone content
 * (which uses stricter boundaries).
 *
 * @returns {module:parsedPaper/assess.TreeAssessor} The created readability assessor.
 *
 * @memberOf module:parsedPaper/assess
 */
exports.constructSEOAssessor = constructSEOAssessor;
const constructReadabilityAssessor = function (researcher, isCornerstoneContent = false) {
  const assessments = isCornerstoneContent ? (0, _assessmentListFactories.constructReadabilityAssessments)() : (0, _assessmentListFactories2.constructReadabilityAssessments)();
  const scoreAggregator = new _scoreAggregators.ReadabilityScoreAggregator();
  return new _TreeAssessor.default({
    researcher,
    assessments,
    scoreAggregator
  });
};
exports.constructReadabilityAssessor = constructReadabilityAssessor;
//# sourceMappingURL=assessorFactories.js.map