axyseo 2.1.11 → 2.1.13

package/build/cjs/scoring/assessors/assessor.js

@@ -0,0 +1,278 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _AssessmentResult = _interopRequireDefault(require("../../values/AssessmentResult.js"));
+var _build = require("../../parse/build");
+var _LanguageProcessor = _interopRequireDefault(require("../../parse/language/LanguageProcessor.js"));
+var _missingArgument = _interopRequireDefault(require("../../errors/missingArgument.js"));
+var _errors = require("../../helpers/errors.js");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// External dependencies.
+
+// Internal dependencies.
+
+// The maximum score of individual assessment is 9. This is why we set the "score rating" here to 9.
+const ScoreRating = 9;
+
+/**
+ * The Assessor is a base class for all assessors.
+ */
+class Assessor {
+  /**
+   * Creates a new Assessor instance.
+   * @param {Researcher}	researcher	The researcher to use.
+   * @param {Object}		[config]	The assessor config.
+   */
+  constructor(researcher, config) {
+    this.type = 'assessor';
+    this.setResearcher(researcher);
+    this._assessments = [];
+  }
+
+  /**
+   * Checks if the researcher is defined and sets it.
+   *
+   * @param   {Researcher} researcher The researcher to use in the assessor.
+   *
+   * @throws  {MissingArgument} Parameter needs to be a valid researcher object.
+   * @returns {void}
+   */
+  setResearcher(researcher) {
+    if ((0, _lodash.isUndefined)(researcher)) {
+      throw new _missingArgument.default('The assessor requires a researcher.');
+    }
+    this._researcher = researcher;
+  }
+
+  /**
+   * Gets all available assessments.
+   * @returns {Assessment[]} assessment
+   */
+  getAvailableAssessments() {
+    return this._assessments;
+  }
+
+  /**
+   * Checks whether the Assessment is applicable.
+   *
+   * @param {Assessment} assessment The Assessment object that needs to be checked.
+   * @param {Paper} paper The Paper object to check against.
+   * @param {Researcher} [researcher] The Researcher object containing additional information.
+   * @returns {boolean} Whether or not the Assessment is applicable.
+   */
+  isApplicable(assessment, paper, researcher) {
+    const ignoreAssessments = paper.getIgnoredAssessments();
+    if (ignoreAssessments.includes(assessment._config.id)) {
+      return false;
+    }
+    if (assessment.hasOwnProperty('isApplicable') || typeof assessment.isApplicable === 'function') {
+      return assessment.isApplicable(paper, researcher);
+    }
+    return true;
+  }
+
+  /**
+   * Determines whether an assessment has a marker.
+   *
+   * @param {Assessment} assessment The assessment to check for.
+   * @returns {boolean} Whether or not the assessment has a marker.
+   */
+  hasMarker(assessment) {
+    return (0, _lodash.isFunction)(this._config.marker) && (assessment.hasOwnProperty('getMarks') || typeof assessment.getMarks === 'function');
+  }
+
+  /**
+   * Returns the specific marker for this assessor.
+   *
+   * @returns {Function} The specific marker for this assessor.
+   */
+  getSpecificMarker() {
+    return this._config.marker;
+  }
+
+  /**
+   * Returns the paper that was most recently assessed.
+   *
+   * @returns {Paper} The paper that was most recently assessed.
+   */
+  getPaper() {
+    return this._lastPaper;
+  }
+
+  /**
+   * Runs the researches defined in the task list or the default researches.
+   *
+   * @param {Paper} paper The paper to run assessments on.
+   * @param i18n
+   * @returns {void}
+   */
+  assess(paper, i18n) {
+    this._researcher.setPaper(paper);
+    const languageProcessor = new _LanguageProcessor.default(this._researcher);
+    const shortcodes = paper._attributes && paper._attributes.shortcodes;
+    paper.setTree((0, _build.build)(paper, languageProcessor, shortcodes));
+    let assessments = this.getAvailableAssessments();
+    this.results = [];
+    assessments = (0, _lodash.filter)(assessments, function (assessment) {
+      return this.isApplicable(assessment, paper, this._researcher);
+    }.bind(this));
+    this.results = (0, _lodash.map)(assessments, assessment => this.executeAssessment({
+      paper,
+      researcher: this._researcher,
+      assessment,
+      i18n
+    }));
+    this._lastPaper = paper;
+  }
+
+  /**
+   * Executes an assessment and returns the AssessmentResult.
+   *
+   * @param {Paper} paper The paper to pass to the assessment.
+   * @param {Researcher} researcher The researcher to pass to the assessment.
+   * @param {Assessment} assessment The assessment to execute.
+   * @param i18n
+   * @returns {AssessmentResult} The result of the assessment.
+   */
+  executeAssessment({
+    paper,
+    researcher,
+    assessment,
+    i18n
+  }) {
+    let result;
+    try {
+      if (i18n) {
+        assessment._config.title = i18n.translate(`Axyseo.${assessment._config.id}.title`);
+        assessment._config.content = {
+          good: i18n.translate(`Axyseo.${assessment._config.id}.good`),
+          improve: i18n.translate(`Axyseo.${assessment._config.id}.improve`),
+          bad: i18n.translate(`Axyseo.${assessment._config.id}.bad`)
+        };
+      }
+      const skippedAssessments = paper.getSkippedAssessments();
+      if (skippedAssessments.includes(assessment._config.id)) {
+        const assessmentResult = new _AssessmentResult.default({
+          config: assessment._config
+        });
+        const score = assessment.getScore(assessment._config.priority, 'good', assessment._config.factor);
+        assessmentResult.setScore(score);
+        assessmentResult.setStatus('good');
+        assessmentResult.setTitle(assessment._config.title);
+        result = assessmentResult;
+      } else {
+        result = assessment.getResult({
+          paper,
+          researcher,
+          i18n
+        });
+      }
+      result.setIdentifier(assessment._config.id);
+    } catch (assessmentError) {
+      (0, _errors.showTrace)(assessmentError);
+      result = new _AssessmentResult.default();
+      result.setScore(-1);
+    }
+    if (assessment?._config?.factor) {
+      result.setFactor(assessment._config.factor);
+    }
+    return result;
+  }
+
+  /**
+   * Filters out all assessment results that have no score and no text.
+   *
+   * @returns {AssessmentResult[]} The array with all the valid assessments.
+   */
+  getValidResults() {
+    return (0, _lodash.filter)(this.results, function (result) {
+      return this.isValidResult(result);
+    }.bind(this));
+  }
+
+  /**
+   * Returns if an assessmentResult is valid.
+   *
+   * @param {AssessmentResult} assessmentResult The assessmentResult to validate.
+   * @returns {boolean} whether or not the result is valid.
+   */
+  isValidResult(assessmentResult) {
+    return assessmentResult.hasScore() && assessmentResult.hasText();
+  }
+
+  /**
+   * Returns the overall score. Calculates the total score by adding all scores and dividing these
+   * by the number of results times the ScoreRating.
+   *
+   * @returns {number} The overall score.
+   */
+  calculateOverallScore() {
+    const results = this.getValidResults();
+    const totalScore = results.reduce((total, assessmentResult) => total + assessmentResult.getScore(), 0);
+    return Math.round(totalScore / (results.length * ScoreRating) * 100) || 0;
+  }
+
+  /**
+   * Registers an assessment and adds it to the internal assessments object.
+   *
+   * @param {string} name The name of the assessment.
+   * @param {Assessment} assessment The object containing function to run as an assessment and it's requirements.
+   * @returns {boolean} Whether registering the assessment was successful.
+   */
+  addAssessment(name, assessment) {
+    if (!assessment.hasOwnProperty('identifier')) {
+      assessment.identifier = name;
+    }
+    // If the assessor already has the same assessment, remove it and replace it with the new assessment with the same identifier.
+    if (this.getAssessment(assessment.identifier)) {
+      this.removeAssessment(assessment.identifier);
+    }
+    this._assessments.push(assessment);
+    return true;
+  }
+
+  /**
+   * Removes a specific Assessment from the list of Assessments.
+   *
+   * @param {string} name The Assessment to remove from the list of assessments.
+   * @returns {void}
+   */
+  removeAssessment(name) {
+    const toDelete = (0, _lodash.findIndex)(this._assessments, function (assessment) {
+      return assessment.hasOwnProperty('identifier') && name === assessment.identifier;
+    });
+    if (-1 !== toDelete) {
+      this._assessments.splice(toDelete, 1);
+    }
+  }
+
+  /**
+   * Returns an assessment by identifier
+   *
+   * @param {string} identifier The identifier of the assessment.
+   * @returns {undefined|Assessment} The object if found, otherwise undefined.
+   */
+  getAssessment(identifier) {
+    return (0, _lodash.find)(this._assessments, function (assessment) {
+      return assessment.hasOwnProperty('identifier') && identifier === assessment.identifier;
+    });
+  }
+
+  /**
+   * Checks which of the available assessments are applicable and returns an array with applicable assessments.
+   *
+   * @returns {Assessment[]} The array with applicable assessments.
+   */
+  getApplicableAssessments() {
+    const availableAssessments = this.getAvailableAssessments();
+    return (0, _lodash.filter)(availableAssessments, function (availableAssessment) {
+      return this.isApplicable(availableAssessment, this.getPaper(), this._researcher);
+    }.bind(this));
+  }
+}
+var _default = exports.default = Assessor;
+//# sourceMappingURL=assessor.js.map

package/build/cjs/scoring/assessors/assessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assessor.js","names":["_lodash","require","_AssessmentResult","_interopRequireDefault","_build","_LanguageProcessor","_missingArgument","_errors","e","__esModule","default","ScoreRating","Assessor","constructor","researcher","config","type","setResearcher","_assessments","isUndefined","MissingArgument","_researcher","getAvailableAssessments","isApplicable","assessment","paper","ignoreAssessments","getIgnoredAssessments","includes","_config","id","hasOwnProperty","hasMarker","isFunction","marker","getMarks","getSpecificMarker","getPaper","_lastPaper","assess","i18n","setPaper","languageProcessor","LanguageProcessor","shortcodes","_attributes","setTree","build","assessments","results","filter","bind","map","executeAssessment","result","title","translate","content","good","improve","bad","skippedAssessments","getSkippedAssessments","assessmentResult","AssessmentResult","score","getScore","priority","factor","setScore","setStatus","setTitle","getResult","setIdentifier","assessmentError","showTrace","setFactor","getValidResults","isValidResult","hasScore","hasText","calculateOverallScore","totalScore","reduce","total","Math","round","length","addAssessment","name","identifier","getAssessment","removeAssessment","push","toDelete","findIndex","splice","find","getApplicableAssessments","availableAssessments","availableAssessment","_default","exports"],"sources":["../../../../src/scoring/assessors/assessor.js"],"sourcesContent":["// External dependencies.\nimport {filter, find, findIndex, isFunction, isUndefined, map} from 'lodash';\n\n// Internal dependencies.\nimport AssessmentResult from '../../values/AssessmentResult.js';\nimport {build} from '../../parse/build';\nimport LanguageProcessor from '../../parse/language/LanguageProcessor.js';\nimport MissingArgument from '../../errors/missingArgument.js';\nimport {showTrace} from '../../helpers/errors.js';\n\n// The maximum score of individual assessment is 9. This is why we set the \"score rating\" here to 9.\nconst ScoreRating = 9;\n\n/**\n * The Assessor is a base class for all assessors.\n */\nclass Assessor {\n  /**\n   * Creates a new Assessor instance.\n   * @param {Researcher}\tresearcher\tThe researcher to use.\n   * @param {Object}\t\t[config]\tThe assessor config.\n   */\n  constructor(researcher, config) {\n    this.type = 'assessor';\n    this.setResearcher(researcher);\n    this._assessments = [];\n  }\n\n  /**\n   * Checks if the researcher is defined and sets it.\n   *\n   * @param   {Researcher} researcher The researcher to use in the assessor.\n   *\n   * @throws  {MissingArgument} Parameter needs to be a valid researcher object.\n   * @returns {void}\n   */\n  setResearcher(researcher) {\n    if (isUndefined(researcher)) {\n      throw new MissingArgument('The assessor requires a researcher.');\n    }\n    this._researcher = researcher;\n  }\n\n  /**\n   * Gets all available assessments.\n   * @returns {Assessment[]} assessment\n   */\n  getAvailableAssessments() {\n    return this._assessments;\n  }\n\n  /**\n   * Checks whether the Assessment is applicable.\n   *\n   * @param {Assessment} assessment The Assessment object that needs to be checked.\n   * @param {Paper} paper The Paper object to check against.\n   * @param {Researcher} [researcher] The Researcher object containing additional information.\n   * @returns {boolean} Whether or not the Assessment is applicable.\n   */\n  isApplicable(assessment, paper, researcher) {\n    const ignoreAssessments = paper.getIgnoredAssessments();\n\n    if (ignoreAssessments.includes(assessment._config.id)) {\n      return false;\n    }\n\n    if (\n      assessment.hasOwnProperty('isApplicable') ||\n      typeof assessment.isApplicable === 'function'\n    ) {\n      return assessment.isApplicable(paper, researcher);\n    }\n\n    return true;\n  }\n\n  /**\n   * Determines whether an assessment has a marker.\n   *\n   * @param {Assessment} assessment The assessment to check for.\n   * @returns {boolean} Whether or not the assessment has a marker.\n   */\n  hasMarker(assessment) {\n    return (\n      isFunction(this._config.marker) &&\n      (assessment.hasOwnProperty('getMarks') || typeof assessment.getMarks === 'function')\n    );\n  }\n\n  /**\n   * Returns the specific marker for this assessor.\n   *\n   * @returns {Function} The specific marker for this assessor.\n   */\n  getSpecificMarker() {\n    return this._config.marker;\n  }\n\n  /**\n   * Returns the paper that was most recently assessed.\n   *\n   * @returns {Paper} The paper that was most recently assessed.\n   */\n  getPaper() {\n    return this._lastPaper;\n  }\n\n  /**\n   * Runs the researches defined in the task list or the default researches.\n   *\n   * @param {Paper} paper The paper to run assessments on.\n   * @param i18n\n   * @returns {void}\n   */\n  assess(paper, i18n) {\n    this._researcher.setPaper(paper);\n\n    const languageProcessor = new LanguageProcessor(this._researcher);\n    const shortcodes = paper._attributes && paper._attributes.shortcodes;\n    paper.setTree(build(paper, languageProcessor, shortcodes));\n\n    let assessments = this.getAvailableAssessments();\n\n    this.results = [];\n\n    assessments = filter(\n      assessments,\n      function(assessment) {\n        return this.isApplicable(assessment, paper, this._researcher);\n      }.bind(this)\n    );\n\n    this.results = map(assessments, assessment =>\n      this.executeAssessment({\n        paper,\n        researcher: this._researcher,\n        assessment,\n        i18n\n      })\n    );\n    this._lastPaper = paper;\n  }\n\n  /**\n   * Executes an assessment and returns the AssessmentResult.\n   *\n   * @param {Paper} paper The paper to pass to the assessment.\n   * @param {Researcher} researcher The researcher to pass to the assessment.\n   * @param {Assessment} assessment The assessment to execute.\n   * @param i18n\n   * @returns {AssessmentResult} The result of the assessment.\n   */\n  executeAssessment({paper, researcher, assessment, i18n}) {\n    let result;\n\n    try {\n      if (i18n) {\n        assessment._config.title = i18n.translate(`Axyseo.${assessment._config.id}.title`);\n        assessment._config.content = {\n          good: i18n.translate(`Axyseo.${assessment._config.id}.good`),\n          improve: i18n.translate(`Axyseo.${assessment._config.id}.improve`),\n          bad: i18n.translate(`Axyseo.${assessment._config.id}.bad`)\n        };\n      }\n\n      const skippedAssessments = paper.getSkippedAssessments();\n\n      if (skippedAssessments.includes(assessment._config.id)) {\n        const assessmentResult = new AssessmentResult({config: assessment._config});\n\n        const score = assessment.getScore(\n          assessment._config.priority,\n          'good',\n          assessment._config.factor\n        );\n\n        assessmentResult.setScore(score);\n        assessmentResult.setStatus('good');\n        assessmentResult.setTitle(assessment._config.title);\n\n        result = assessmentResult;\n      } else {\n        result = assessment.getResult({paper, researcher, i18n});\n      }\n      result.setIdentifier(assessment._config.id);\n    } catch (assessmentError) {\n      showTrace(assessmentError);\n\n      result = new AssessmentResult();\n\n      result.setScore(-1);\n    }\n\n    if (assessment?._config?.factor) {\n      result.setFactor(assessment._config.factor);\n    }\n\n    return result;\n  }\n\n  /**\n   * Filters out all assessment results that have no score and no text.\n   *\n   * @returns {AssessmentResult[]} The array with all the valid assessments.\n   */\n  getValidResults() {\n    return filter(\n      this.results,\n      function(result) {\n        return this.isValidResult(result);\n      }.bind(this)\n    );\n  }\n\n  /**\n   * Returns if an assessmentResult is valid.\n   *\n   * @param {AssessmentResult} assessmentResult The assessmentResult to validate.\n   * @returns {boolean} whether or not the result is valid.\n   */\n  isValidResult(assessmentResult) {\n    return assessmentResult.hasScore() && assessmentResult.hasText();\n  }\n\n  /**\n   * Returns the overall score. Calculates the total score by adding all scores and dividing these\n   * by the number of results times the ScoreRating.\n   *\n   * @returns {number} The overall score.\n   */\n  calculateOverallScore() {\n    const results = this.getValidResults();\n\n    const totalScore = results.reduce(\n      (total, assessmentResult) => total + assessmentResult.getScore(),\n      0\n    );\n\n    return Math.round((totalScore / (results.length * ScoreRating)) * 100) || 0;\n  }\n\n  /**\n   * Registers an assessment and adds it to the internal assessments object.\n   *\n   * @param {string} name The name of the assessment.\n   * @param {Assessment} assessment The object containing function to run as an assessment and it's requirements.\n   * @returns {boolean} Whether registering the assessment was successful.\n   */\n  addAssessment(name, assessment) {\n    if (!assessment.hasOwnProperty('identifier')) {\n      assessment.identifier = name;\n    }\n    // If the assessor already has the same assessment, remove it and replace it with the new assessment with the same identifier.\n    if (this.getAssessment(assessment.identifier)) {\n      this.removeAssessment(assessment.identifier);\n    }\n\n    this._assessments.push(assessment);\n    return true;\n  }\n\n  /**\n   * Removes a specific Assessment from the list of Assessments.\n   *\n   * @param {string} name The Assessment to remove from the list of assessments.\n   * @returns {void}\n   */\n  removeAssessment(name) {\n    const toDelete = findIndex(this._assessments, function(assessment) {\n      return assessment.hasOwnProperty('identifier') && name === assessment.identifier;\n    });\n\n    if (-1 !== toDelete) {\n      this._assessments.splice(toDelete, 1);\n    }\n  }\n\n  /**\n   * Returns an assessment by identifier\n   *\n   * @param {string} identifier The identifier of the assessment.\n   * @returns {undefined|Assessment} The object if found, otherwise undefined.\n   */\n  getAssessment(identifier) {\n    return find(this._assessments, function(assessment) {\n      return assessment.hasOwnProperty('identifier') && identifier === assessment.identifier;\n    });\n  }\n\n  /**\n   * Checks which of the available assessments are applicable and returns an array with applicable assessments.\n   *\n   * @returns {Assessment[]} The array with applicable assessments.\n   */\n  getApplicableAssessments() {\n    const availableAssessments = this.getAvailableAssessments();\n    return filter(\n      availableAssessments,\n      function(availableAssessment) {\n        return this.isApplicable(availableAssessment, this.getPaper(), this._researcher);\n      }.bind(this)\n    );\n  }\n}\n\nexport default Assessor;\n"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AAGA,IAAAC,iBAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,MAAA,GAAAH,OAAA;AACA,IAAAI,kBAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,gBAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,OAAA,GAAAN,OAAA;AAAkD,SAAAE,uBAAAK,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AARlD;;AAGA;;AAOA;AACA,MAAMG,WAAW,GAAG,CAAC;;AAErB;AACA;AACA;AACA,MAAMC,QAAQ,CAAC;EACb;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,MAAM,EAAE;IAC9B,IAAI,CAACC,IAAI,GAAG,UAAU;IACtB,IAAI,CAACC,aAAa,CAACH,UAAU,CAAC;IAC9B,IAAI,CAACI,YAAY,GAAG,EAAE;EACxB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACED,aAAaA,CAACH,UAAU,EAAE;IACxB,IAAI,IAAAK,mBAAW,EAACL,UAAU,CAAC,EAAE;MAC3B,MAAM,IAAIM,wBAAe,CAAC,qCAAqC,CAAC;IAClE;IACA,IAAI,CAACC,WAAW,GAAGP,UAAU;EAC/B;;EAEA;AACF;AACA;AACA;EACEQ,uBAAuBA,CAAA,EAAG;IACxB,OAAO,IAAI,CAACJ,YAAY;EAC1B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEK,YAAYA,CAACC,UAAU,EAAEC,KAAK,EAAEX,UAAU,EAAE;IAC1C,MAAMY,iBAAiB,GAAGD,KAAK,CAACE,qBAAqB,CAAC,CAAC;IAEvD,IAAID,iBAAiB,CAACE,QAAQ,CAACJ,UAAU,CAACK,OAAO,CAACC,EAAE,CAAC,EAAE;MACrD,OAAO,KAAK;IACd;IAEA,IACEN,UAAU,CAACO,cAAc,CAAC,cAAc,CAAC,IACzC,OAAOP,UAAU,CAACD,YAAY,KAAK,UAAU,EAC7C;MACA,OAAOC,UAAU,CAACD,YAAY,CAACE,KAAK,EAAEX,UAAU,CAAC;IACnD;IAEA,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEkB,SAASA,CAACR,UAAU,EAAE;IACpB,OACE,IAAAS,kBAAU,EAAC,IAAI,CAACJ,OAAO,CAACK,MAAM,CAAC,KAC9BV,UAAU,CAACO,cAAc,CAAC,UAAU,CAAC,IAAI,OAAOP,UAAU,CAACW,QAAQ,KAAK,UAAU,CAAC;EAExF;;EAEA;AACF;AACA;AACA;AACA;EACEC,iBAAiBA,CAAA,EAAG;IAClB,OAAO,IAAI,CAACP,OAAO,CAACK,MAAM;EAC5B;;EAEA;AACF;AACA;AACA;AACA;EACEG,QAAQA,CAAA,EAAG;IACT,OAAO,IAAI,CAACC,UAAU;EACxB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,MAAMA,CAACd,KAAK,EAAEe,IAAI,EAAE;IAClB,IAAI,CAACnB,WAAW,CAACoB,QAAQ,CAAChB,KAAK,CAAC;IAEhC,MAAMiB,iBAAiB,GAAG,IAAIC,0BAAiB,CAAC,IAAI,CAACtB,WAAW,CAAC;IACjE,MAAMuB,UAAU,GAAGnB,KAAK,CAACoB,WAAW,IAAIpB,KAAK,CAACoB,WAAW,CAACD,UAAU;IACpEnB,KAAK,CAACqB,OAAO,CAAC,IAAAC,YAAK,EAACtB,KAAK,EAAEiB,iBAAiB,EAAEE,UAAU,CAAC,CAAC;IAE1D,IAAII,WAAW,GAAG,IAAI,CAAC1B,uBAAuB,CAAC,CAAC;IAEhD,IAAI,CAAC2B,OAAO,GAAG,EAAE;IAEjBD,WAAW,GAAG,IAAAE,cAAM,EAClBF,WAAW,EACX,UAASxB,UAAU,EAAE;MACnB,OAAO,IAAI,CAACD,YAAY,CAACC,UAAU,EAAEC,KAAK,EAAE,IAAI,CAACJ,WAAW,CAAC;IAC/D,CAAC,CAAC8B,IAAI,CAAC,IAAI,CACb,CAAC;IAED,IAAI,CAACF,OAAO,GAAG,IAAAG,WAAG,EAACJ,WAAW,EAAExB,UAAU,IACxC,IAAI,CAAC6B,iBAAiB,CAAC;MACrB5B,KAAK;MACLX,UAAU,EAAE,IAAI,CAACO,WAAW;MAC5BG,UAAU;MACVgB;IACF,CAAC,CACH,CAAC;IACD,IAAI,CAACF,UAAU,GAAGb,KAAK;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE4B,iBAAiBA,CAAC;IAAC5B,KAAK;IAAEX,UAAU;IAAEU,UAAU;IAAEgB;EAAI,CAAC,EAAE;IACvD,IAAIc,MAAM;IAEV,IAAI;MACF,IAAId,IAAI,EAAE;QACRhB,UAAU,CAACK,OAAO,CAAC0B,KAAK,GAAGf,IAAI,CAACgB,SAAS,CAAC,UAAUhC,UAAU,CAACK,OAAO,CAACC,EAAE,QAAQ,CAAC;QAClFN,UAAU,CAACK,OAAO,CAAC4B,OAAO,GAAG;UAC3BC,IAAI,EAAElB,IAAI,CAACgB,SAAS,CAAC,UAAUhC,UAAU,CAACK,OAAO,CAACC,EAAE,OAAO,CAAC;UAC5D6B,OAAO,EAAEnB,IAAI,CAACgB,SAAS,CAAC,UAAUhC,UAAU,CAACK,OAAO,CAACC,EAAE,UAAU,CAAC;UAClE8B,GAAG,EAAEpB,IAAI,CAACgB,SAAS,CAAC,UAAUhC,UAAU,CAACK,OAAO,CAACC,EAAE,MAAM;QAC3D,CAAC;MACH;MAEA,MAAM+B,kBAAkB,GAAGpC,KAAK,CAACqC,qBAAqB,CAAC,CAAC;MAExD,IAAID,kBAAkB,CAACjC,QAAQ,CAACJ,UAAU,CAACK,OAAO,CAACC,EAAE,CAAC,EAAE;QACtD,MAAMiC,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;UAACjD,MAAM,EAAES,UAAU,CAACK;QAAO,CAAC,CAAC;QAE3E,MAAMoC,KAAK,GAAGzC,UAAU,CAAC0C,QAAQ,CAC/B1C,UAAU,CAACK,OAAO,CAACsC,QAAQ,EAC3B,MAAM,EACN3C,UAAU,CAACK,OAAO,CAACuC,MACrB,CAAC;QAEDL,gBAAgB,CAACM,QAAQ,CAACJ,KAAK,CAAC;QAChCF,gBAAgB,CAACO,SAAS,CAAC,MAAM,CAAC;QAClCP,gBAAgB,CAACQ,QAAQ,CAAC/C,UAAU,CAACK,OAAO,CAAC0B,KAAK,CAAC;QAEnDD,MAAM,GAAGS,gBAAgB;MAC3B,CAAC,MAAM;QACLT,MAAM,GAAG9B,UAAU,CAACgD,SAAS,CAAC;UAAC/C,KAAK;UAAEX,UAAU;UAAE0B;QAAI,CAAC,CAAC;MAC1D;MACAc,MAAM,CAACmB,aAAa,CAACjD,UAAU,CAACK,OAAO,CAACC,EAAE,CAAC;IAC7C,CAAC,CAAC,OAAO4C,eAAe,EAAE;MACxB,IAAAC,iBAAS,EAACD,eAAe,CAAC;MAE1BpB,MAAM,GAAG,IAAIU,yBAAgB,CAAC,CAAC;MAE/BV,MAAM,CAACe,QAAQ,CAAC,CAAC,CAAC,CAAC;IACrB;IAEA,IAAI7C,UAAU,EAAEK,OAAO,EAAEuC,MAAM,EAAE;MAC/Bd,MAAM,CAACsB,SAAS,CAACpD,UAAU,CAACK,OAAO,CAACuC,MAAM,CAAC;IAC7C;IAEA,OAAOd,MAAM;EACf;;EAEA;AACF;AACA;AACA;AACA;EACEuB,eAAeA,CAAA,EAAG;IAChB,OAAO,IAAA3B,cAAM,EACX,IAAI,CAACD,OAAO,EACZ,UAASK,MAAM,EAAE;MACf,OAAO,IAAI,CAACwB,aAAa,CAACxB,MAAM,CAAC;IACnC,CAAC,CAACH,IAAI,CAAC,IAAI,CACb,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE2B,aAAaA,CAACf,gBAAgB,EAAE;IAC9B,OAAOA,gBAAgB,CAACgB,QAAQ,CAAC,CAAC,IAAIhB,gBAAgB,CAACiB,OAAO,CAAC,CAAC;EAClE;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,qBAAqBA,CAAA,EAAG;IACtB,MAAMhC,OAAO,GAAG,IAAI,CAAC4B,eAAe,CAAC,CAAC;IAEtC,MAAMK,UAAU,GAAGjC,OAAO,CAACkC,MAAM,CAC/B,CAACC,KAAK,EAAErB,gBAAgB,KAAKqB,KAAK,GAAGrB,gBAAgB,CAACG,QAAQ,CAAC,CAAC,EAChE,CACF,CAAC;IAED,OAAOmB,IAAI,CAACC,KAAK,CAAEJ,UAAU,IAAIjC,OAAO,CAACsC,MAAM,GAAG5E,WAAW,CAAC,GAAI,GAAG,CAAC,IAAI,CAAC;EAC7E;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACE6E,aAAaA,CAACC,IAAI,EAAEjE,UAAU,EAAE;IAC9B,IAAI,CAACA,UAAU,CAACO,cAAc,CAAC,YAAY,CAAC,EAAE;MAC5CP,UAAU,CAACkE,UAAU,GAAGD,IAAI;IAC9B;IACA;IACA,IAAI,IAAI,CAACE,aAAa,CAACnE,UAAU,CAACkE,UAAU,CAAC,EAAE;MAC7C,IAAI,CAACE,gBAAgB,CAACpE,UAAU,CAACkE,UAAU,CAAC;IAC9C;IAEA,IAAI,CAACxE,YAAY,CAAC2E,IAAI,CAACrE,UAAU,CAAC;IAClC,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEoE,gBAAgBA,CAACH,IAAI,EAAE;IACrB,MAAMK,QAAQ,GAAG,IAAAC,iBAAS,EAAC,IAAI,CAAC7E,YAAY,EAAE,UAASM,UAAU,EAAE;MACjE,OAAOA,UAAU,CAACO,cAAc,CAAC,YAAY,CAAC,IAAI0D,IAAI,KAAKjE,UAAU,CAACkE,UAAU;IAClF,CAAC,CAAC;IAEF,IAAI,CAAC,CAAC,KAAKI,QAAQ,EAAE;MACnB,IAAI,CAAC5E,YAAY,CAAC8E,MAAM,CAACF,QAAQ,EAAE,CAAC,CAAC;IACvC;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEH,aAAaA,CAACD,UAAU,EAAE;IACxB,OAAO,IAAAO,YAAI,EAAC,IAAI,CAAC/E,YAAY,EAAE,UAASM,UAAU,EAAE;MAClD,OAAOA,UAAU,CAACO,cAAc,CAAC,YAAY,CAAC,IAAI2D,UAAU,KAAKlE,UAAU,CAACkE,UAAU;IACxF,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;EACEQ,wBAAwBA,CAAA,EAAG;IACzB,MAAMC,oBAAoB,GAAG,IAAI,CAAC7E,uBAAuB,CAAC,CAAC;IAC3D,OAAO,IAAA4B,cAAM,EACXiD,oBAAoB,EACpB,UAASC,mBAAmB,EAAE;MAC5B,OAAO,IAAI,CAAC7E,YAAY,CAAC6E,mBAAmB,EAAE,IAAI,CAAC/D,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAChB,WAAW,CAAC;IAClF,CAAC,CAAC8B,IAAI,CAAC,IAAI,CACb,CAAC;EACH;AACF;AAAC,IAAAkD,QAAA,GAAAC,OAAA,CAAA5F,OAAA,GAEcE,QAAQ","ignoreList":[]}

package/build/cjs/scoring/assessors/avadaAssessor.js

@@ -0,0 +1,91 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _index = require("./index");
+var _helpers = require("../helpers");
+/**
+ * The AvadaAssessor class is used for the general SEO analysis.
+ */
+class AvadaAssessor {
+  /**
+   * Creates a new AvadaAssessor instance.
+   * @param {Researcher}  researcher  The researcher to use.
+   * @param {Object}    [config]  The assessor config.
+   * @param {Object}  [config.textParagraphTooLong]
+   * @param {Object}  [config.textSentenceLength]
+   * @param {Object}  [config.textTransitionWords]
+   * @param {Object}  [config.sentenceBeginnings]
+   * @param {Object}  [config.relatedKeywords]
+   * @param {Object}  [config.titleKeyword]
+   * @param {Object}  [config.textImages]
+   * @param {Object}  [config.numberTitle]
+   * @param {Object}  [config.introductionKeyword]
+   * @param {Object}  [config.keyphraseLength]
+   * @param {Object}  [config.metaDescriptionKeyword]
+   * @param {Object}  [config.metaDescriptionLength]
+   * @param {Object}  [config.subheadingsKeyword]
+   * @param {Object}  [config.externalLinks]
+   * @param {Object}  [config.keyphraseDensity]
+   * @param {Object}  [config.media]
+   * @param {Object}  [config.urlLength]
+   * @param {Object}  [config.textLength]
+   * @param {Object}  [config.singleTitle]
+   * @param {Object}  [config.keyphrase]
+   * @param {Object}  [config.internalLinks]
+   * @param {Object}  [config.titleWidth]
+   * @param {Object}  [config.slugKeyword]
+   * @param {Object}  [config.singleH1]
+   * @param {Object}  [config.schema]
+   */
+  constructor(researcher, config = {}) {
+    const seoAssessor = new _index.SEOAssessor(researcher, config);
+    const contentAssessor = new _index.ContentAssessor(researcher, config);
+    this.seoAssessor = seoAssessor;
+    this.contentAssessor = contentAssessor;
+    this.researcher = researcher;
+    this.config = config;
+  }
+  assess(paper, i18n) {
+    this.seoAssessor.assess(paper, i18n);
+    this.contentAssessor.assess(paper, i18n);
+    let assessments = [...this.seoAssessor.results, ...this.contentAssessor.results];
+    assessments = assessments.map(assessment => ({
+      ...assessment.config,
+      status: assessment.status,
+      score: assessment.score,
+      data: assessment.data,
+      title: assessment.title || assessment.config.title
+    }));
+    this.assessments = assessments;
+  }
+  getResult(groupBy = 'category', getScore = true) {
+    let assessments = [];
+    switch (groupBy) {
+      case 'category':
+        assessments = (0, _helpers.groupAssessmentsByCategory)(this.assessments);
+        break;
+      case 'status':
+        assessments = (0, _helpers.groupAssessmentsByStatus)(this.assessments);
+        break;
+    }
+    return {
+      assessments,
+      ...(getScore ? {
+        score: this.getScore()
+      } : {})
+    };
+  }
+  getScore() {
+    let point = 0;
+    this.assessments.forEach(assessment => {
+      point += assessment.score;
+    });
+    const maxPoint = (0, _helpers.getMaxPoint)(this.assessments);
+    return Math.round(point * 100 / maxPoint);
+  }
+}
+exports.default = AvadaAssessor;
+//# sourceMappingURL=avadaAssessor.js.map

package/build/cjs/scoring/assessors/avadaAssessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"avadaAssessor.js","names":["_index","require","_helpers","AvadaAssessor","constructor","researcher","config","seoAssessor","SEOAssessor","contentAssessor","ContentAssessor","assess","paper","i18n","assessments","results","map","assessment","status","score","data","title","getResult","groupBy","getScore","groupAssessmentsByCategory","groupAssessmentsByStatus","point","forEach","maxPoint","getMaxPoint","Math","round","exports","default"],"sources":["../../../../src/scoring/assessors/avadaAssessor.js"],"sourcesContent":["import {ContentAssessor, SEOAssessor} from '@axyseo/scoring/assessors/index';\nimport {getMaxPoint, groupAssessmentsByCategory, groupAssessmentsByStatus} from '../helpers';\n\n/**\n * The AvadaAssessor class is used for the general SEO analysis.\n */\nexport default class AvadaAssessor {\n  /**\n   * Creates a new AvadaAssessor instance.\n   * @param {Researcher}  researcher  The researcher to use.\n   * @param {Object}    [config]  The assessor config.\n   * @param {Object}  [config.textParagraphTooLong]\n   * @param {Object}  [config.textSentenceLength]\n   * @param {Object}  [config.textTransitionWords]\n   * @param {Object}  [config.sentenceBeginnings]\n   * @param {Object}  [config.relatedKeywords]\n   * @param {Object}  [config.titleKeyword]\n   * @param {Object}  [config.textImages]\n   * @param {Object}  [config.numberTitle]\n   * @param {Object}  [config.introductionKeyword]\n   * @param {Object}  [config.keyphraseLength]\n   * @param {Object}  [config.metaDescriptionKeyword]\n   * @param {Object}  [config.metaDescriptionLength]\n   * @param {Object}  [config.subheadingsKeyword]\n   * @param {Object}  [config.externalLinks]\n   * @param {Object}  [config.keyphraseDensity]\n   * @param {Object}  [config.media]\n   * @param {Object}  [config.urlLength]\n   * @param {Object}  [config.textLength]\n   * @param {Object}  [config.singleTitle]\n   * @param {Object}  [config.keyphrase]\n   * @param {Object}  [config.internalLinks]\n   * @param {Object}  [config.titleWidth]\n   * @param {Object}  [config.slugKeyword]\n   * @param {Object}  [config.singleH1]\n   * @param {Object}  [config.schema]\n   */\n  constructor(researcher, config = {}) {\n    const seoAssessor = new SEOAssessor(researcher, config);\n    const contentAssessor = new ContentAssessor(researcher, config);\n    this.seoAssessor = seoAssessor;\n    this.contentAssessor = contentAssessor;\n    this.researcher = researcher;\n    this.config = config;\n  }\n\n  assess(paper, i18n) {\n    this.seoAssessor.assess(paper, i18n);\n    this.contentAssessor.assess(paper, i18n);\n    let assessments = [...this.seoAssessor.results, ...this.contentAssessor.results];\n    assessments = assessments.map(assessment => ({\n      ...assessment.config,\n      status: assessment.status,\n      score: assessment.score,\n      data: assessment.data,\n      title: assessment.title || assessment.config.title\n    }));\n    this.assessments = assessments;\n  }\n\n  getResult(groupBy = 'category', getScore = true) {\n    let assessments = [];\n    switch (groupBy) {\n      case 'category':\n        assessments = groupAssessmentsByCategory(this.assessments);\n        break;\n      case 'status':\n        assessments = groupAssessmentsByStatus(this.assessments);\n        break;\n    }\n\n    return {\n      assessments,\n      ...(getScore ? {score: this.getScore()} : {})\n    };\n  }\n\n  getScore() {\n    let point = 0;\n    this.assessments.forEach(assessment => {\n      point += assessment.score;\n    });\n\n    const maxPoint = getMaxPoint(this.assessments);\n    return Math.round((point * 100) / maxPoint);\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,QAAA,GAAAD,OAAA;AAEA;AACA;AACA;AACe,MAAME,aAAa,CAAC;EACjC;AACF;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;EACEC,WAAWA,CAACC,UAAU,EAAEC,MAAM,GAAG,CAAC,CAAC,EAAE;IACnC,MAAMC,WAAW,GAAG,IAAIC,kBAAW,CAACH,UAAU,EAAEC,MAAM,CAAC;IACvD,MAAMG,eAAe,GAAG,IAAIC,sBAAe,CAACL,UAAU,EAAEC,MAAM,CAAC;IAC/D,IAAI,CAACC,WAAW,GAAGA,WAAW;IAC9B,IAAI,CAACE,eAAe,GAAGA,eAAe;IACtC,IAAI,CAACJ,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACC,MAAM,GAAGA,MAAM;EACtB;EAEAK,MAAMA,CAACC,KAAK,EAAEC,IAAI,EAAE;IAClB,IAAI,CAACN,WAAW,CAACI,MAAM,CAACC,KAAK,EAAEC,IAAI,CAAC;IACpC,IAAI,CAACJ,eAAe,CAACE,MAAM,CAACC,KAAK,EAAEC,IAAI,CAAC;IACxC,IAAIC,WAAW,GAAG,CAAC,GAAG,IAAI,CAACP,WAAW,CAACQ,OAAO,EAAE,GAAG,IAAI,CAACN,eAAe,CAACM,OAAO,CAAC;IAChFD,WAAW,GAAGA,WAAW,CAACE,GAAG,CAACC,UAAU,KAAK;MAC3C,GAAGA,UAAU,CAACX,MAAM;MACpBY,MAAM,EAAED,UAAU,CAACC,MAAM;MACzBC,KAAK,EAAEF,UAAU,CAACE,KAAK;MACvBC,IAAI,EAAEH,UAAU,CAACG,IAAI;MACrBC,KAAK,EAAEJ,UAAU,CAACI,KAAK,IAAIJ,UAAU,CAACX,MAAM,CAACe;IAC/C,CAAC,CAAC,CAAC;IACH,IAAI,CAACP,WAAW,GAAGA,WAAW;EAChC;EAEAQ,SAASA,CAACC,OAAO,GAAG,UAAU,EAAEC,QAAQ,GAAG,IAAI,EAAE;IAC/C,IAAIV,WAAW,GAAG,EAAE;IACpB,QAAQS,OAAO;MACb,KAAK,UAAU;QACbT,WAAW,GAAG,IAAAW,mCAA0B,EAAC,IAAI,CAACX,WAAW,CAAC;QAC1D;MACF,KAAK,QAAQ;QACXA,WAAW,GAAG,IAAAY,iCAAwB,EAAC,IAAI,CAACZ,WAAW,CAAC;QACxD;IACJ;IAEA,OAAO;MACLA,WAAW;MACX,IAAIU,QAAQ,GAAG;QAACL,KAAK,EAAE,IAAI,CAACK,QAAQ,CAAC;MAAC,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;EACH;EAEAA,QAAQA,CAAA,EAAG;IACT,IAAIG,KAAK,GAAG,CAAC;IACb,IAAI,CAACb,WAAW,CAACc,OAAO,CAACX,UAAU,IAAI;MACrCU,KAAK,IAAIV,UAAU,CAACE,KAAK;IAC3B,CAAC,CAAC;IAEF,MAAMU,QAAQ,GAAG,IAAAC,oBAAW,EAAC,IAAI,CAAChB,WAAW,CAAC;IAC9C,OAAOiB,IAAI,CAACC,KAAK,CAAEL,KAAK,GAAG,GAAG,GAAIE,QAAQ,CAAC;EAC7C;AACF;AAACI,OAAA,CAAAC,OAAA,GAAA/B,aAAA","ignoreList":[]}

package/build/cjs/scoring/assessors/contentAssessor.js

@@ -0,0 +1,150 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _assessor = _interopRequireDefault(require("./assessor.js"));
+var _ParagraphTooLongAssessment = _interopRequireDefault(require("../assessments/readability/ParagraphTooLongAssessment.js"));
+var _SentenceLengthInTextAssessment = _interopRequireDefault(require("../assessments/readability/SentenceLengthInTextAssessment.js"));
+var _SentenceBeginningsAssessment = _interopRequireDefault(require("../assessments/readability/SentenceBeginningsAssessment.js"));
+var _TransitionWordsAssessment = _interopRequireDefault(require("../assessments/readability/TransitionWordsAssessment.js"));
+var _scoreToRating = _interopRequireDefault(require("../interpreters/scoreToRating.js"));
+var _RelatedKeywordsAssessment = _interopRequireDefault(require("../assessments/readability/RelatedKeywordsAssessment"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * The ContentAssessor class is used for the readability analysis.
+ */
+class ContentAssessor extends _assessor.default {
+  /**
+   * Creates a new ContentAssessor instance.
+   * @param {Researcher}	researcher	The researcher to use.
+   * @param {Object}		[config]	The assessor config.
+   */
+  constructor(researcher, config) {
+    super(researcher, config);
+    this.type = 'contentAssessor';
+    this._assessments = [new _ParagraphTooLongAssessment.default(config?.textParagraphTooLong), new _SentenceLengthInTextAssessment.default(config?.textSentenceLength), new _TransitionWordsAssessment.default(config?.textTransitionWords), new _SentenceBeginningsAssessment.default(config?.sentenceBeginnings), new _RelatedKeywordsAssessment.default(config?.relatedKeywords)];
+  }
+
+  /**
+   * Calculates the weighted rating for languages that have all assessments based on a given rating.
+   *
+   * @param {string} rating The rating to be weighted.
+   * @returns {number} The weighted rating.
+   */
+  calculatePenaltyPointsFullSupport(rating) {
+    switch (rating) {
+      case 'bad':
+        return 3;
+      case 'ok':
+        return 2;
+      default:
+      case 'good':
+        return 0;
+    }
+  }
+
+  /**
+   * Calculates the weighted rating for languages that don't have all assessments based on a given rating.
+   *
+   * @param {string} rating The rating to be weighted.
+   * @returns {number} The weighted rating.
+   */
+  calculatePenaltyPointsPartialSupport(rating) {
+    switch (rating) {
+      case 'bad':
+        return 4;
+      case 'ok':
+        return 2;
+      default:
+      case 'good':
+        return 0;
+    }
+  }
+
+  /**
+   * Determines whether a language is fully supported. If a language supports 7 content assessments,
+   * it is fully supported
+   *
+   * @returns {boolean} True if fully supported.
+   */
+  _allAssessmentsSupported() {
+    const numberOfAssessments = this._assessments.length;
+    const applicableAssessments = this.getApplicableAssessments();
+    return applicableAssessments.length === numberOfAssessments;
+  }
+
+  /**
+   * Calculates the penalty points based on the assessment results.
+   *
+   * @returns {number} The total penalty points for the results.
+   */
+  calculatePenaltyPoints() {
+    const results = this.getValidResults();
+    const penaltyPoints = (0, _lodash.map)(results, function (result) {
+      const rating = (0, _scoreToRating.default)(result.getScore());
+      if (this._allAssessmentsSupported()) {
+        return this.calculatePenaltyPointsFullSupport(rating);
+      }
+      return this.calculatePenaltyPointsPartialSupport(rating);
+    }.bind(this));
+    return (0, _lodash.sum)(penaltyPoints);
+  }
+
+  /**
+   * Rates the penalty points
+   *
+   * @param {number} totalPenaltyPoints The amount of penalty points.
+   * @returns {number} The score based on the amount of penalty points.
+   *
+   * @private
+   */
+  _ratePenaltyPoints(totalPenaltyPoints) {
+    if (this.getValidResults().length === 1) {
+      // If we have only 1 result, we only have a "no content" result
+      return 30;
+    }
+    if (this._allAssessmentsSupported()) {
+      // Determine the total score based on the total penalty points.
+      if (totalPenaltyPoints > 6) {
+        // A red indicator.
+        return 30;
+      }
+      if (totalPenaltyPoints > 4) {
+        // An orange indicator.
+        return 60;
+      }
+    } else {
+      if (totalPenaltyPoints > 4) {
+        // A red indicator.
+        return 30;
+      }
+      if (totalPenaltyPoints > 2) {
+        // An orange indicator.
+        return 60;
+      }
+    }
+    // A green indicator.
+    return 90;
+  }
+
+  /**
+   * Calculates the overall score based on the assessment results.
+   *
+   * @returns {number} The overall score.
+   */
+  calculateOverallScore() {
+    const results = this.getValidResults();
+
+    // If you have no content, you have a red indicator.
+    if (results.length === 0) {
+      return 30;
+    }
+    const totalPenaltyPoints = this.calculatePenaltyPoints();
+    return this._ratePenaltyPoints(totalPenaltyPoints);
+  }
+}
+exports.default = ContentAssessor;
+//# sourceMappingURL=contentAssessor.js.map

package/build/cjs/scoring/assessors/contentAssessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentAssessor.js","names":["_lodash","require","_assessor","_interopRequireDefault","_ParagraphTooLongAssessment","_SentenceLengthInTextAssessment","_SentenceBeginningsAssessment","_TransitionWordsAssessment","_scoreToRating","_RelatedKeywordsAssessment","e","__esModule","default","ContentAssessor","Assessor","constructor","researcher","config","type","_assessments","ParagraphTooLong","textParagraphTooLong","SentenceLengthInText","textSentenceLength","TransitionWords","textTransitionWords","SentenceBeginnings","sentenceBeginnings","RelatedKeywordsAssessment","relatedKeywords","calculatePenaltyPointsFullSupport","rating","calculatePenaltyPointsPartialSupport","_allAssessmentsSupported","numberOfAssessments","length","applicableAssessments","getApplicableAssessments","calculatePenaltyPoints","results","getValidResults","penaltyPoints","map","result","scoreToRating","getScore","bind","sum","_ratePenaltyPoints","totalPenaltyPoints","calculateOverallScore","exports"],"sources":["../../../../src/scoring/assessors/contentAssessor.js"],"sourcesContent":["import {map, sum} from 'lodash';\nimport Assessor from './assessor.js';\nimport ParagraphTooLong from '../assessments/readability/ParagraphTooLongAssessment.js';\nimport SentenceLengthInText from '../assessments/readability/SentenceLengthInTextAssessment.js';\nimport SentenceBeginnings from '../assessments/readability/SentenceBeginningsAssessment.js';\nimport TransitionWords from '../assessments/readability/TransitionWordsAssessment.js';\nimport scoreToRating from '../interpreters/scoreToRating.js';\nimport RelatedKeywordsAssessment from '../assessments/readability/RelatedKeywordsAssessment';\n\n/**\n * The ContentAssessor class is used for the readability analysis.\n */\nexport default class ContentAssessor extends Assessor {\n  /**\n   * Creates a new ContentAssessor instance.\n   * @param {Researcher}\tresearcher\tThe researcher to use.\n   * @param {Object}\t\t[config]\tThe assessor config.\n   */\n  constructor(researcher, config) {\n    super(researcher, config);\n    this.type = 'contentAssessor';\n\n    this._assessments = [\n      new ParagraphTooLong(config?.textParagraphTooLong),\n      new SentenceLengthInText(config?.textSentenceLength),\n      new TransitionWords(config?.textTransitionWords),\n      new SentenceBeginnings(config?.sentenceBeginnings),\n      new RelatedKeywordsAssessment(config?.relatedKeywords)\n    ];\n  }\n\n  /**\n   * Calculates the weighted rating for languages that have all assessments based on a given rating.\n   *\n   * @param {string} rating The rating to be weighted.\n   * @returns {number} The weighted rating.\n   */\n  calculatePenaltyPointsFullSupport(rating) {\n    switch (rating) {\n      case 'bad':\n        return 3;\n      case 'ok':\n        return 2;\n      default:\n      case 'good':\n        return 0;\n    }\n  }\n\n  /**\n   * Calculates the weighted rating for languages that don't have all assessments based on a given rating.\n   *\n   * @param {string} rating The rating to be weighted.\n   * @returns {number} The weighted rating.\n   */\n  calculatePenaltyPointsPartialSupport(rating) {\n    switch (rating) {\n      case 'bad':\n        return 4;\n      case 'ok':\n        return 2;\n      default:\n      case 'good':\n        return 0;\n    }\n  }\n\n  /**\n   * Determines whether a language is fully supported. If a language supports 7 content assessments,\n   * it is fully supported\n   *\n   * @returns {boolean} True if fully supported.\n   */\n  _allAssessmentsSupported() {\n    const numberOfAssessments = this._assessments.length;\n    const applicableAssessments = this.getApplicableAssessments();\n    return applicableAssessments.length === numberOfAssessments;\n  }\n\n  /**\n   * Calculates the penalty points based on the assessment results.\n   *\n   * @returns {number} The total penalty points for the results.\n   */\n  calculatePenaltyPoints() {\n    const results = this.getValidResults();\n\n    const penaltyPoints = map(\n      results,\n      function(result) {\n        const rating = scoreToRating(result.getScore());\n\n        if (this._allAssessmentsSupported()) {\n          return this.calculatePenaltyPointsFullSupport(rating);\n        }\n\n        return this.calculatePenaltyPointsPartialSupport(rating);\n      }.bind(this)\n    );\n\n    return sum(penaltyPoints);\n  }\n\n  /**\n   * Rates the penalty points\n   *\n   * @param {number} totalPenaltyPoints The amount of penalty points.\n   * @returns {number} The score based on the amount of penalty points.\n   *\n   * @private\n   */\n  _ratePenaltyPoints(totalPenaltyPoints) {\n    if (this.getValidResults().length === 1) {\n      // If we have only 1 result, we only have a \"no content\" result\n      return 30;\n    }\n\n    if (this._allAssessmentsSupported()) {\n      // Determine the total score based on the total penalty points.\n      if (totalPenaltyPoints > 6) {\n        // A red indicator.\n        return 30;\n      }\n\n      if (totalPenaltyPoints > 4) {\n        // An orange indicator.\n        return 60;\n      }\n    } else {\n      if (totalPenaltyPoints > 4) {\n        // A red indicator.\n        return 30;\n      }\n\n      if (totalPenaltyPoints > 2) {\n        // An orange indicator.\n        return 60;\n      }\n    }\n    // A green indicator.\n    return 90;\n  }\n\n  /**\n   * Calculates the overall score based on the assessment results.\n   *\n   * @returns {number} The overall score.\n   */\n  calculateOverallScore() {\n    const results = this.getValidResults();\n\n    // If you have no content, you have a red indicator.\n    if (results.length === 0) {\n      return 30;\n    }\n\n    const totalPenaltyPoints = this.calculatePenaltyPoints();\n\n    return this._ratePenaltyPoints(totalPenaltyPoints);\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,SAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,2BAAA,GAAAD,sBAAA,CAAAF,OAAA;AACA,IAAAI,+BAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,6BAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,0BAAA,GAAAJ,sBAAA,CAAAF,OAAA;AACA,IAAAO,cAAA,GAAAL,sBAAA,CAAAF,OAAA;AACA,IAAAQ,0BAAA,GAAAN,sBAAA,CAAAF,OAAA;AAA6F,SAAAE,uBAAAO,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE7F;AACA;AACA;AACe,MAAMG,eAAe,SAASC,iBAAQ,CAAC;EACpD;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,MAAM,EAAE;IAC9B,KAAK,CAACD,UAAU,EAAEC,MAAM,CAAC;IACzB,IAAI,CAACC,IAAI,GAAG,iBAAiB;IAE7B,IAAI,CAACC,YAAY,GAAG,CAClB,IAAIC,mCAAgB,CAACH,MAAM,EAAEI,oBAAoB,CAAC,EAClD,IAAIC,uCAAoB,CAACL,MAAM,EAAEM,kBAAkB,CAAC,EACpD,IAAIC,kCAAe,CAACP,MAAM,EAAEQ,mBAAmB,CAAC,EAChD,IAAIC,qCAAkB,CAACT,MAAM,EAAEU,kBAAkB,CAAC,EAClD,IAAIC,kCAAyB,CAACX,MAAM,EAAEY,eAAe,CAAC,CACvD;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,iCAAiCA,CAACC,MAAM,EAAE;IACxC,QAAQA,MAAM;MACZ,KAAK,KAAK;QACR,OAAO,CAAC;MACV,KAAK,IAAI;QACP,OAAO,CAAC;MACV;MACA,KAAK,MAAM;QACT,OAAO,CAAC;IACZ;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,oCAAoCA,CAACD,MAAM,EAAE;IAC3C,QAAQA,MAAM;MACZ,KAAK,KAAK;QACR,OAAO,CAAC;MACV,KAAK,IAAI;QACP,OAAO,CAAC;MACV;MACA,KAAK,MAAM;QACT,OAAO,CAAC;IACZ;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEE,wBAAwBA,CAAA,EAAG;IACzB,MAAMC,mBAAmB,GAAG,IAAI,CAACf,YAAY,CAACgB,MAAM;IACpD,MAAMC,qBAAqB,GAAG,IAAI,CAACC,wBAAwB,CAAC,CAAC;IAC7D,OAAOD,qBAAqB,CAACD,MAAM,KAAKD,mBAAmB;EAC7D;;EAEA;AACF;AACA;AACA;AACA;EACEI,sBAAsBA,CAAA,EAAG;IACvB,MAAMC,OAAO,GAAG,IAAI,CAACC,eAAe,CAAC,CAAC;IAEtC,MAAMC,aAAa,GAAG,IAAAC,WAAG,EACvBH,OAAO,EACP,UAASI,MAAM,EAAE;MACf,MAAMZ,MAAM,GAAG,IAAAa,sBAAa,EAACD,MAAM,CAACE,QAAQ,CAAC,CAAC,CAAC;MAE/C,IAAI,IAAI,CAACZ,wBAAwB,CAAC,CAAC,EAAE;QACnC,OAAO,IAAI,CAACH,iCAAiC,CAACC,MAAM,CAAC;MACvD;MAEA,OAAO,IAAI,CAACC,oCAAoC,CAACD,MAAM,CAAC;IAC1D,CAAC,CAACe,IAAI,CAAC,IAAI,CACb,CAAC;IAED,OAAO,IAAAC,WAAG,EAACN,aAAa,CAAC;EAC3B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEO,kBAAkBA,CAACC,kBAAkB,EAAE;IACrC,IAAI,IAAI,CAACT,eAAe,CAAC,CAAC,CAACL,MAAM,KAAK,CAAC,EAAE;MACvC;MACA,OAAO,EAAE;IACX;IAEA,IAAI,IAAI,CAACF,wBAAwB,CAAC,CAAC,EAAE;MACnC;MACA,IAAIgB,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;MAEA,IAAIA,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;IACF,CAAC,MAAM;MACL,IAAIA,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;MAEA,IAAIA,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;IACF;IACA;IACA,OAAO,EAAE;EACX;;EAEA;AACF;AACA;AACA;AACA;EACEC,qBAAqBA,CAAA,EAAG;IACtB,MAAMX,OAAO,GAAG,IAAI,CAACC,eAAe,CAAC,CAAC;;IAEtC;IACA,IAAID,OAAO,CAACJ,MAAM,KAAK,CAAC,EAAE;MACxB,OAAO,EAAE;IACX;IAEA,MAAMc,kBAAkB,GAAG,IAAI,CAACX,sBAAsB,CAAC,CAAC;IAExD,OAAO,IAAI,CAACU,kBAAkB,CAACC,kBAAkB,CAAC;EACpD;AACF;AAACE,OAAA,CAAAvC,OAAA,GAAAC,eAAA","ignoreList":[]}

package/build/cjs/scoring/assessors/index.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "Assessor", {
+  enumerable: true,
+  get: function () {
+    return _assessor.default;
+  }
+});
+Object.defineProperty(exports, "AvadaAssessor", {
+  enumerable: true,
+  get: function () {
+    return _avadaAssessor.default;
+  }
+});
+Object.defineProperty(exports, "ContentAssessor", {
+  enumerable: true,
+  get: function () {
+    return _contentAssessor.default;
+  }
+});
+Object.defineProperty(exports, "SEOAssessor", {
+  enumerable: true,
+  get: function () {
+    return _seoAssessor.default;
+  }
+});
+var _assessor = _interopRequireDefault(require("./assessor.js"));
+var _contentAssessor = _interopRequireDefault(require("./contentAssessor.js"));
+var _seoAssessor = _interopRequireDefault(require("./seoAssessor.js"));
+var _avadaAssessor = _interopRequireDefault(require("./avadaAssessor.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+//# sourceMappingURL=index.js.map

package/build/cjs/scoring/assessors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_assessor","_interopRequireDefault","require","_contentAssessor","_seoAssessor","_avadaAssessor","e","__esModule","default"],"sources":["../../../../src/scoring/assessors/index.js"],"sourcesContent":["export {default as Assessor} from './assessor.js';\nexport {default as ContentAssessor} from './contentAssessor.js';\nexport {default as SEOAssessor} from './seoAssessor.js';\nexport {default as AvadaAssessor} from './avadaAssessor.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAAA,SAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,gBAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,YAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,cAAA,GAAAJ,sBAAA,CAAAC,OAAA;AAA4D,SAAAD,uBAAAK,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA","ignoreList":[]}