axyseo 2.1.11 → 2.1.13

package/build/cjs/scoring/renderers/AssessorPresenter.js

@@ -0,0 +1,348 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _scoreToRating = _interopRequireDefault(require("../interpreters/scoreToRating.js"));
+var _presenter = _interopRequireDefault(require("../../config/presenter.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Represents the AssessorPresenter.
+ */
+class AssessorPresenter {
+  /**
+   * Constructs the AssessorPresenter.
+   *
+   * @param {Object} args A list of arguments to use in the presenter.
+   * @param {object} args.targets The HTML elements to render the output to.
+   * @param {string} args.targets.output The HTML element to render the individual ratings out to.
+   * @param {string} args.targets.overall The HTML element to render the overall rating out to.
+   * @param {string} args.keyword The keyword to use for checking, when calculating the overall rating.
+   * @param {SEOAssessor} args.assessor The Assessor object to retrieve assessment results from.
+   *
+   * @constructor
+   */
+  constructor(args) {
+    this.keyword = args.keyword;
+    this.assessor = args.assessor;
+    this.output = args.targets.output;
+    this.overall = args.targets.overall || "overallScore";
+    this.presenterConfig = (0, _presenter.default)();
+    this._disableMarkerButtons = false;
+    this._activeMarker = false;
+  }
+
+  /**
+   * Sets the keyword.
+   *
+   * @param {string} keyword The keyword to use.
+   * @returns {void}
+   */
+  setKeyword(keyword) {
+    this.keyword = keyword;
+  }
+
+  /**
+   * Checks whether a specific property exists in the presenter configuration.
+   *
+   * @param {string} property The property name to search for.
+   * @returns {boolean} Whether or not the property exists.
+   */
+  configHasProperty(property) {
+    return this.presenterConfig.hasOwnProperty(property);
+  }
+
+  /**
+   * Gets a fully formatted indicator object that can be used.
+   *
+   * @param {string} rating The rating to use.
+   * @returns {Object} An object containing the class, the screen reader text, and the full text.
+   */
+  getIndicator(rating) {
+    return {
+      className: this.getIndicatorColorClass(rating),
+      screenReaderText: this.getIndicatorScreenReaderText(rating),
+      fullText: this.getIndicatorFullText(rating),
+      screenReaderReadabilityText: this.getIndicatorScreenReaderReadabilityText(rating)
+    };
+  }
+
+  /**
+   * Gets the indicator color class from the presenter configuration, if it exists.
+   *
+   * @param {string} rating The rating to check against the config.
+   * @returns {string} String containing the CSS class to be used.
+   */
+  getIndicatorColorClass(rating) {
+    if (!this.configHasProperty(rating)) {
+      return "";
+    }
+    return this.presenterConfig[rating].className;
+  }
+
+  /**
+   * Gets the indicator screen reader text from the presenter configuration, if it exists.
+   *
+   * @param {string} rating The rating to check against the config.
+   * @returns {string} Translated string containing the screen reader text to be used.
+   */
+  getIndicatorScreenReaderText(rating) {
+    if (!this.configHasProperty(rating)) {
+      return "";
+    }
+    return this.presenterConfig[rating].screenReaderText;
+  }
+
+  /**
+   * Gets the indicator screen reader readability text from the presenter configuration, if it exists.
+   *
+   * @param {string} rating The rating to check against the config.
+   * @returns {string} Translated string containing the screen reader readability text to be used.
+   */
+  getIndicatorScreenReaderReadabilityText(rating) {
+    if (!this.configHasProperty(rating)) {
+      return "";
+    }
+    return this.presenterConfig[rating].screenReaderReadabilityText;
+  }
+
+  /**
+   * Gets the indicator full text from the presenter configuration, if it exists.
+   *
+   * @param {string} rating The rating to check against the config.
+   * @returns {string} Translated string containing the full text to be used.
+   */
+  getIndicatorFullText(rating) {
+    if (!this.configHasProperty(rating)) {
+      return "";
+    }
+    return this.presenterConfig[rating].fullText;
+  }
+
+  /**
+   * Adds a rating based on the numeric score.
+   *
+   * @param {Object} result Object based on the Assessment result. Requires a score property to work.
+   * @returns {Object} The Assessment result object with the rating added.
+   */
+  resultToRating(result) {
+    if (!(0, _lodash.isObject)(result)) {
+      return "";
+    }
+    result.rating = (0, _scoreToRating.default)(result.score);
+    return result;
+  }
+
+  /**
+   * Takes the individual assessment results, sorts and rates them.
+   *
+   * @returns {Object} Object containing all the individual ratings.
+   */
+  getIndividualRatings() {
+    const ratings = {};
+    const validResults = this.sort(this.assessor.getValidResults());
+    const mappedResults = validResults.map(this.resultToRating);
+    (0, _lodash.forEach)(mappedResults, function (item, key) {
+      ratings[key] = this.addRating(item);
+    }.bind(this));
+    return ratings;
+  }
+
+  /**
+   * Excludes items from the results that are present in the `exclude` array.
+   *
+   * @param {Array} results Array containing the items to filter through.
+   * @param {Array} exclude Array of results to exclude.
+   * @returns {Array} Array containing items that remain after exclusion.
+   */
+  excludeFromResults(results, exclude) {
+    return (0, _lodash.difference)(results, exclude);
+  }
+
+  /**
+   * Sorts results based on their score property and always places items considered to be non-sortable, at the top.
+   *
+   * @param {Array} results Array containing the results that need to be sorted.
+   * @returns {Array} Array containing the sorted results.
+   */
+  sort(results) {
+    const nonSortables = this.getUndefinedScores(results);
+    const sortables = this.excludeFromResults(results, nonSortables);
+    sortables.sort(function (a, b) {
+      return a.score - b.score;
+    });
+    return nonSortables.concat(sortables);
+  }
+
+  /**
+   * Returns a subset of results that have an undefined score or a score set to zero.
+   *
+   * @param {Array} results The results to filter through.
+   * @returns {Array} A subset of results containing items with an undefined score or where the score is zero.
+   */
+  getUndefinedScores(results) {
+    return results.filter(function (result) {
+      return (0, _lodash.isUndefined)(result.score) || result.score === 0;
+    });
+  }
+
+  /**
+   * Creates a rating object based on the item that is being passed.
+   *
+   * @param {Object} item The item to check and create a rating object from.
+   * @returns {Object} Object containing a parsed item, including a colored indicator.
+   */
+  addRating(item) {
+    const indicator = this.getIndicator(item.rating);
+    indicator.text = item.text;
+    indicator.identifier = item.getIdentifier();
+    if (item.hasMarker()) {
+      indicator.marker = item.getMarker();
+    }
+    return indicator;
+  }
+
+  /**
+   * Calculates the overall rating score based on the overall score.
+   *
+   * @param {Number} overallScore The overall score to use in the calculation.
+   * @returns {Object} The rating based on the score.
+   */
+  getOverallRating(overallScore) {
+    let rating = 0;
+    if (this.keyword === "") {
+      return this.resultToRating({
+        score: rating
+      });
+    }
+    if ((0, _lodash.isNumber)(overallScore)) {
+      rating = overallScore / 10;
+    }
+    return this.resultToRating({
+      score: rating
+    });
+  }
+
+  /**
+   * Marks with a given marker. This will set the active marker to the correct value.
+   *
+   * @param {string} identifier The identifier for the assessment/marker.
+   * @param {Function} marker The marker function.
+   * @returns {void}
+   */
+  markAssessment(identifier, marker) {
+    if (this._activeMarker === identifier) {
+      this.removeAllMarks();
+      this._activeMarker = false;
+    } else {
+      marker();
+      this._activeMarker = identifier;
+    }
+    this.render();
+  }
+
+  /**
+   * Disables the currently active marker in the UI.
+   *
+   * @returns {void}
+   */
+  disableMarker() {
+    this._activeMarker = false;
+    this.render();
+  }
+
+  /**
+   * Disables the marker buttons.
+   *
+   * @returns {void}
+   */
+  disableMarkerButtons() {
+    this._disableMarkerButtons = true;
+    this.render();
+  }
+
+  /**
+   * Enables the marker buttons.
+   *
+   * @returns {void}
+   */
+  enableMarkerButtons() {
+    this._disableMarkerButtons = false;
+    this.render();
+  }
+
+  /**
+   * Adds an event listener for the marker button
+   *
+   * @param {string} identifier The identifier for the assessment the marker belongs to.
+   * @param {Function} marker The marker function that can mark the assessment in the text.
+   * @returns {void}
+   */
+  addMarkerEventHandler(identifier, marker) {
+    const container = document.getElementById(this.output);
+    const markButton = container.getElementsByClassName("js-assessment-results__mark-" + identifier)[0];
+    markButton.addEventListener("click", this.markAssessment.bind(this, identifier, marker));
+  }
+
+  /**
+   * Renders out both the individual and the overall ratings.
+   *
+   * @returns {void}
+   */
+  render() {
+    this.renderIndividualRatings();
+    this.renderOverallRating();
+  }
+
+  /**
+   * Adds event handlers to the mark buttons.
+   *
+   * @param {Object} scores The list of rendered scores.
+   *
+   * @returns {void}
+   */
+  bindMarkButtons(scores) {
+    // Make sure the button works for every score with a marker.
+    (0, _lodash.forEach)(scores, function (score) {
+      if (score.hasOwnProperty("marker")) {
+        this.addMarkerEventHandler(score.identifier, score.marker);
+      }
+    }.bind(this));
+  }
+
+  /**
+   * Removes all marks currently on the text.
+   *
+   * @returns {void}
+   */
+  removeAllMarks() {
+    const marker = this.assessor.getSpecificMarker();
+    marker(this.assessor.getPaper(), []);
+  }
+
+  /**
+   * Renders out the individual ratings.
+   * Here, this method is set to noop. In `post-scraper.js` and `term-scraper.js` where this method is called, it is overridden with noop as well.
+   *
+   * @returns {void}
+   */
+  renderIndividualRatings() {}
+
+  /**
+   * Renders out the overall rating.
+   *
+   * @returns {void}
+   */
+  renderOverallRating() {
+    const overallRating = this.getOverallRating(this.assessor.calculateOverallScore());
+    const overallRatingElement = document.getElementById(this.overall);
+    if (!overallRatingElement) {
+      return;
+    }
+    overallRatingElement.className = "overallScore " + this.getIndicatorColorClass(overallRating.rating);
+  }
+}
+var _default = exports.default = AssessorPresenter;
+//# sourceMappingURL=AssessorPresenter.js.map

package/build/cjs/scoring/renderers/AssessorPresenter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssessorPresenter.js","names":["_lodash","require","_scoreToRating","_interopRequireDefault","_presenter","e","__esModule","default","AssessorPresenter","constructor","args","keyword","assessor","output","targets","overall","presenterConfig","createConfig","_disableMarkerButtons","_activeMarker","setKeyword","configHasProperty","property","hasOwnProperty","getIndicator","rating","className","getIndicatorColorClass","screenReaderText","getIndicatorScreenReaderText","fullText","getIndicatorFullText","screenReaderReadabilityText","getIndicatorScreenReaderReadabilityText","resultToRating","result","isObject","scoreToRating","score","getIndividualRatings","ratings","validResults","sort","getValidResults","mappedResults","map","forEach","item","key","addRating","bind","excludeFromResults","results","exclude","difference","nonSortables","getUndefinedScores","sortables","a","b","concat","filter","isUndefined","indicator","text","identifier","getIdentifier","hasMarker","marker","getMarker","getOverallRating","overallScore","isNumber","markAssessment","removeAllMarks","render","disableMarker","disableMarkerButtons","enableMarkerButtons","addMarkerEventHandler","container","document","getElementById","markButton","getElementsByClassName","addEventListener","renderIndividualRatings","renderOverallRating","bindMarkButtons","scores","getSpecificMarker","getPaper","overallRating","calculateOverallScore","overallRatingElement","_default","exports"],"sources":["../../../../src/scoring/renderers/AssessorPresenter.js"],"sourcesContent":["import { difference, forEach, isNumber, isObject, isUndefined } from \"lodash\";\nimport scoreToRating from \"../interpreters/scoreToRating.js\";\nimport createConfig from \"../../config/presenter.js\";\n\n/**\n * Represents the AssessorPresenter.\n */\nclass AssessorPresenter {\n\t/**\n\t * Constructs the AssessorPresenter.\n\t *\n\t * @param {Object} args A list of arguments to use in the presenter.\n\t * @param {object} args.targets The HTML elements to render the output to.\n\t * @param {string} args.targets.output The HTML element to render the individual ratings out to.\n\t * @param {string} args.targets.overall The HTML element to render the overall rating out to.\n\t * @param {string} args.keyword The keyword to use for checking, when calculating the overall rating.\n\t * @param {SEOAssessor} args.assessor The Assessor object to retrieve assessment results from.\n\t *\n\t * @constructor\n\t */\n\tconstructor(  args ) {\n\t\tthis.keyword = args.keyword;\n\t\tthis.assessor = args.assessor;\n\t\tthis.output = args.targets.output;\n\t\tthis.overall = args.targets.overall || \"overallScore\";\n\t\tthis.presenterConfig = createConfig();\n\n\t\tthis._disableMarkerButtons = false;\n\n\t\tthis._activeMarker = false;\n\t}\n\n\t/**\n\t * Sets the keyword.\n\t *\n\t * @param {string} keyword The keyword to use.\n\t * @returns {void}\n\t */\n\tsetKeyword( keyword ) {\n\t\tthis.keyword = keyword;\n\t}\n\n\t/**\n\t * Checks whether a specific property exists in the presenter configuration.\n\t *\n\t * @param {string} property The property name to search for.\n\t * @returns {boolean} Whether or not the property exists.\n\t */\n\tconfigHasProperty( property ) {\n\t\treturn this.presenterConfig.hasOwnProperty( property );\n\t}\n\n\t/**\n\t * Gets a fully formatted indicator object that can be used.\n\t *\n\t * @param {string} rating The rating to use.\n\t * @returns {Object} An object containing the class, the screen reader text, and the full text.\n\t */\n\tgetIndicator( rating ) {\n\t\treturn {\n\t\t\tclassName: this.getIndicatorColorClass( rating ),\n\t\t\tscreenReaderText: this.getIndicatorScreenReaderText( rating ),\n\t\t\tfullText: this.getIndicatorFullText( rating ),\n\t\t\tscreenReaderReadabilityText: this.getIndicatorScreenReaderReadabilityText( rating ),\n\t\t};\n\t}\n\n\t/**\n\t * Gets the indicator color class from the presenter configuration, if it exists.\n\t *\n\t * @param {string} rating The rating to check against the config.\n\t * @returns {string} String containing the CSS class to be used.\n\t */\n\tgetIndicatorColorClass( rating ) {\n\t\tif ( ! this.configHasProperty( rating ) ) {\n\t\t\treturn \"\";\n\t\t}\n\n\t\treturn this.presenterConfig[ rating ].className;\n\t}\n\n\t/**\n\t * Gets the indicator screen reader text from the presenter configuration, if it exists.\n\t *\n\t * @param {string} rating The rating to check against the config.\n\t * @returns {string} Translated string containing the screen reader text to be used.\n\t */\n\tgetIndicatorScreenReaderText( rating ) {\n\t\tif ( ! this.configHasProperty( rating ) ) {\n\t\t\treturn \"\";\n\t\t}\n\n\t\treturn this.presenterConfig[ rating ].screenReaderText;\n\t}\n\n\t/**\n\t * Gets the indicator screen reader readability text from the presenter configuration, if it exists.\n\t *\n\t * @param {string} rating The rating to check against the config.\n\t * @returns {string} Translated string containing the screen reader readability text to be used.\n\t */\n\tgetIndicatorScreenReaderReadabilityText( rating ) {\n\t\tif ( ! this.configHasProperty( rating ) ) {\n\t\t\treturn \"\";\n\t\t}\n\n\t\treturn this.presenterConfig[ rating ].screenReaderReadabilityText;\n\t}\n\n\t/**\n\t * Gets the indicator full text from the presenter configuration, if it exists.\n\t *\n\t * @param {string} rating The rating to check against the config.\n\t * @returns {string} Translated string containing the full text to be used.\n\t */\n\tgetIndicatorFullText( rating ) {\n\t\tif ( ! this.configHasProperty( rating ) ) {\n\t\t\treturn \"\";\n\t\t}\n\n\t\treturn this.presenterConfig[ rating ].fullText;\n\t}\n\n\t/**\n\t * Adds a rating based on the numeric score.\n\t *\n\t * @param {Object} result Object based on the Assessment result. Requires a score property to work.\n\t * @returns {Object} The Assessment result object with the rating added.\n\t */\n\tresultToRating( result ) {\n\t\tif ( ! isObject( result ) ) {\n\t\t\treturn \"\";\n\t\t}\n\n\t\tresult.rating = scoreToRating( result.score );\n\n\t\treturn result;\n\t}\n\n\t/**\n\t * Takes the individual assessment results, sorts and rates them.\n\t *\n\t * @returns {Object} Object containing all the individual ratings.\n\t */\n\tgetIndividualRatings() {\n\t\tconst ratings = {};\n\t\tconst validResults = this.sort( this.assessor.getValidResults() );\n\t\tconst mappedResults = validResults.map( this.resultToRating );\n\n\t\tforEach( mappedResults, function( item, key ) {\n\t\t\tratings[ key ] = this.addRating( item );\n\t\t}.bind( this ) );\n\n\t\treturn ratings;\n\t}\n\n\t/**\n\t * Excludes items from the results that are present in the `exclude` array.\n\t *\n\t * @param {Array} results Array containing the items to filter through.\n\t * @param {Array} exclude Array of results to exclude.\n\t * @returns {Array} Array containing items that remain after exclusion.\n\t */\n\texcludeFromResults( results, exclude ) {\n\t\treturn difference( results, exclude );\n\t}\n\n\t/**\n\t * Sorts results based on their score property and always places items considered to be non-sortable, at the top.\n\t *\n\t * @param {Array} results Array containing the results that need to be sorted.\n\t * @returns {Array} Array containing the sorted results.\n\t */\n\tsort( results ) {\n\t\tconst nonSortables = this.getUndefinedScores( results );\n\t\tconst sortables = this.excludeFromResults( results, nonSortables );\n\n\t\tsortables.sort( function( a, b ) {\n\t\t\treturn a.score - b.score;\n\t\t} );\n\n\t\treturn nonSortables.concat( sortables );\n\t}\n\n\t/**\n\t * Returns a subset of results that have an undefined score or a score set to zero.\n\t *\n\t * @param {Array} results The results to filter through.\n\t * @returns {Array} A subset of results containing items with an undefined score or where the score is zero.\n\t */\n\tgetUndefinedScores( results ) {\n\t\treturn results.filter( function( result ) {\n\t\t\treturn isUndefined( result.score ) || result.score === 0;\n\t\t} );\n\t}\n\n\t/**\n\t * Creates a rating object based on the item that is being passed.\n\t *\n\t * @param {Object} item The item to check and create a rating object from.\n\t * @returns {Object} Object containing a parsed item, including a colored indicator.\n\t */\n\taddRating( item ) {\n\t\tconst indicator = this.getIndicator( item.rating );\n\t\tindicator.text = item.text;\n\t\tindicator.identifier = item.getIdentifier();\n\n\t\tif ( item.hasMarker() ) {\n\t\t\tindicator.marker = item.getMarker();\n\t\t}\n\n\t\treturn indicator;\n\t}\n\n\t/**\n\t * Calculates the overall rating score based on the overall score.\n\t *\n\t * @param {Number} overallScore The overall score to use in the calculation.\n\t * @returns {Object} The rating based on the score.\n\t */\n\tgetOverallRating( overallScore ) {\n\t\tlet rating = 0;\n\n\t\tif ( this.keyword === \"\" ) {\n\t\t\treturn this.resultToRating( { score: rating } );\n\t\t}\n\n\t\tif ( isNumber( overallScore ) ) {\n\t\t\trating = ( overallScore / 10 );\n\t\t}\n\n\t\treturn this.resultToRating( { score: rating } );\n\t}\n\n\t/**\n\t * Marks with a given marker. This will set the active marker to the correct value.\n\t *\n\t * @param {string} identifier The identifier for the assessment/marker.\n\t * @param {Function} marker The marker function.\n\t * @returns {void}\n\t */\n\tmarkAssessment( identifier, marker ) {\n\t\tif ( this._activeMarker === identifier ) {\n\t\t\tthis.removeAllMarks();\n\t\t\tthis._activeMarker = false;\n\t\t} else {\n\t\t\tmarker();\n\t\t\tthis._activeMarker = identifier;\n\t\t}\n\n\t\tthis.render();\n\t}\n\n\t/**\n\t * Disables the currently active marker in the UI.\n\t *\n\t * @returns {void}\n\t */\n\tdisableMarker() {\n\t\tthis._activeMarker = false;\n\t\tthis.render();\n\t}\n\n\t/**\n\t * Disables the marker buttons.\n\t *\n\t * @returns {void}\n\t */\n\tdisableMarkerButtons() {\n\t\tthis._disableMarkerButtons = true;\n\t\tthis.render();\n\t}\n\n\t/**\n\t * Enables the marker buttons.\n\t *\n\t * @returns {void}\n\t */\n\tenableMarkerButtons() {\n\t\tthis._disableMarkerButtons = false;\n\t\tthis.render();\n\t}\n\n\t/**\n\t * Adds an event listener for the marker button\n\t *\n\t * @param {string} identifier The identifier for the assessment the marker belongs to.\n\t * @param {Function} marker The marker function that can mark the assessment in the text.\n\t * @returns {void}\n\t */\n\taddMarkerEventHandler( identifier, marker ) {\n\t\tconst container = document.getElementById( this.output );\n\t\tconst markButton = container.getElementsByClassName( \"js-assessment-results__mark-\" + identifier )[ 0 ];\n\n\t\tmarkButton.addEventListener( \"click\", this.markAssessment.bind( this, identifier, marker ) );\n\t}\n\n\t/**\n\t * Renders out both the individual and the overall ratings.\n\t *\n\t * @returns {void}\n\t */\n\trender() {\n\t\tthis.renderIndividualRatings();\n\t\tthis.renderOverallRating();\n\t}\n\n\t/**\n\t * Adds event handlers to the mark buttons.\n\t *\n\t * @param {Object} scores The list of rendered scores.\n\t *\n\t * @returns {void}\n\t */\n\tbindMarkButtons( scores ) {\n\t\t// Make sure the button works for every score with a marker.\n\t\tforEach( scores, function( score ) {\n\t\t\tif ( score.hasOwnProperty( \"marker\" ) ) {\n\t\t\t\tthis.addMarkerEventHandler( score.identifier, score.marker );\n\t\t\t}\n\t\t}.bind( this ) );\n\t}\n\n\t/**\n\t * Removes all marks currently on the text.\n\t *\n\t * @returns {void}\n\t */\n\tremoveAllMarks() {\n\t\tconst marker = this.assessor.getSpecificMarker();\n\n\t\tmarker( this.assessor.getPaper(), [] );\n\t}\n\n\t/**\n\t * Renders out the individual ratings.\n\t * Here, this method is set to noop. In `post-scraper.js` and `term-scraper.js` where this method is called, it is overridden with noop as well.\n\t *\n\t * @returns {void}\n\t */\n\trenderIndividualRatings() {}\n\n\t/**\n\t * Renders out the overall rating.\n\t *\n\t * @returns {void}\n\t */\n\trenderOverallRating() {\n\t\tconst overallRating = this.getOverallRating( this.assessor.calculateOverallScore() );\n\t\tconst overallRatingElement = document.getElementById( this.overall );\n\n\t\tif ( ! overallRatingElement ) {\n\t\t\treturn;\n\t\t}\n\n\t\toverallRatingElement.className = \"overallScore \" + this.getIndicatorColorClass( overallRating.rating );\n\t}\n}\n\nexport default AssessorPresenter;\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,cAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,UAAA,GAAAD,sBAAA,CAAAF,OAAA;AAAqD,SAAAE,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAErD;AACA;AACA;AACA,MAAMG,iBAAiB,CAAC;EACvB;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACCC,WAAWA,CAAGC,IAAI,EAAG;IACpB,IAAI,CAACC,OAAO,GAAGD,IAAI,CAACC,OAAO;IAC3B,IAAI,CAACC,QAAQ,GAAGF,IAAI,CAACE,QAAQ;IAC7B,IAAI,CAACC,MAAM,GAAGH,IAAI,CAACI,OAAO,CAACD,MAAM;IACjC,IAAI,CAACE,OAAO,GAAGL,IAAI,CAACI,OAAO,CAACC,OAAO,IAAI,cAAc;IACrD,IAAI,CAACC,eAAe,GAAG,IAAAC,kBAAY,EAAC,CAAC;IAErC,IAAI,CAACC,qBAAqB,GAAG,KAAK;IAElC,IAAI,CAACC,aAAa,GAAG,KAAK;EAC3B;;EAEA;AACD;AACA;AACA;AACA;AACA;EACCC,UAAUA,CAAET,OAAO,EAAG;IACrB,IAAI,CAACA,OAAO,GAAGA,OAAO;EACvB;;EAEA;AACD;AACA;AACA;AACA;AACA;EACCU,iBAAiBA,CAAEC,QAAQ,EAAG;IAC7B,OAAO,IAAI,CAACN,eAAe,CAACO,cAAc,CAAED,QAAS,CAAC;EACvD;;EAEA;AACD;AACA;AACA;AACA;AACA;EACCE,YAAYA,CAAEC,MAAM,EAAG;IACtB,OAAO;MACNC,SAAS,EAAE,IAAI,CAACC,sBAAsB,CAAEF,MAAO,CAAC;MAChDG,gBAAgB,EAAE,IAAI,CAACC,4BAA4B,CAAEJ,MAAO,CAAC;MAC7DK,QAAQ,EAAE,IAAI,CAACC,oBAAoB,CAAEN,MAAO,CAAC;MAC7CO,2BAA2B,EAAE,IAAI,CAACC,uCAAuC,CAAER,MAAO;IACnF,CAAC;EACF;;EAEA;AACD;AACA;AACA;AACA;AACA;EACCE,sBAAsBA,CAAEF,MAAM,EAAG;IAChC,IAAK,CAAE,IAAI,CAACJ,iBAAiB,CAAEI,MAAO,CAAC,EAAG;MACzC,OAAO,EAAE;IACV;IAEA,OAAO,IAAI,CAACT,eAAe,CAAES,MAAM,CAAE,CAACC,SAAS;EAChD;;EAEA;AACD;AACA;AACA;AACA;AACA;EACCG,4BAA4BA,CAAEJ,MAAM,EAAG;IACtC,IAAK,CAAE,IAAI,CAACJ,iBAAiB,CAAEI,MAAO,CAAC,EAAG;MACzC,OAAO,EAAE;IACV;IAEA,OAAO,IAAI,CAACT,eAAe,CAAES,MAAM,CAAE,CAACG,gBAAgB;EACvD;;EAEA;AACD;AACA;AACA;AACA;AACA;EACCK,uCAAuCA,CAAER,MAAM,EAAG;IACjD,IAAK,CAAE,IAAI,CAACJ,iBAAiB,CAAEI,MAAO,CAAC,EAAG;MACzC,OAAO,EAAE;IACV;IAEA,OAAO,IAAI,CAACT,eAAe,CAAES,MAAM,CAAE,CAACO,2BAA2B;EAClE;;EAEA;AACD;AACA;AACA;AACA;AACA;EACCD,oBAAoBA,CAAEN,MAAM,EAAG;IAC9B,IAAK,CAAE,IAAI,CAACJ,iBAAiB,CAAEI,MAAO,CAAC,EAAG;MACzC,OAAO,EAAE;IACV;IAEA,OAAO,IAAI,CAACT,eAAe,CAAES,MAAM,CAAE,CAACK,QAAQ;EAC/C;;EAEA;AACD;AACA;AACA;AACA;AACA;EACCI,cAAcA,CAAEC,MAAM,EAAG;IACxB,IAAK,CAAE,IAAAC,gBAAQ,EAAED,MAAO,CAAC,EAAG;MAC3B,OAAO,EAAE;IACV;IAEAA,MAAM,CAACV,MAAM,GAAG,IAAAY,sBAAa,EAAEF,MAAM,CAACG,KAAM,CAAC;IAE7C,OAAOH,MAAM;EACd;;EAEA;AACD;AACA;AACA;AACA;EACCI,oBAAoBA,CAAA,EAAG;IACtB,MAAMC,OAAO,GAAG,CAAC,CAAC;IAClB,MAAMC,YAAY,GAAG,IAAI,CAACC,IAAI,CAAE,IAAI,CAAC9B,QAAQ,CAAC+B,eAAe,CAAC,CAAE,CAAC;IACjE,MAAMC,aAAa,GAAGH,YAAY,CAACI,GAAG,CAAE,IAAI,CAACX,cAAe,CAAC;IAE7D,IAAAY,eAAO,EAAEF,aAAa,EAAE,UAAUG,IAAI,EAAEC,GAAG,EAAG;MAC7CR,OAAO,CAAEQ,GAAG,CAAE,GAAG,IAAI,CAACC,SAAS,CAAEF,IAAK,CAAC;IACxC,CAAC,CAACG,IAAI,CAAE,IAAK,CAAE,CAAC;IAEhB,OAAOV,OAAO;EACf;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;EACCW,kBAAkBA,CAAEC,OAAO,EAAEC,OAAO,EAAG;IACtC,OAAO,IAAAC,kBAAU,EAAEF,OAAO,EAAEC,OAAQ,CAAC;EACtC;;EAEA;AACD;AACA;AACA;AACA;AACA;EACCX,IAAIA,CAAEU,OAAO,EAAG;IACf,MAAMG,YAAY,GAAG,IAAI,CAACC,kBAAkB,CAAEJ,OAAQ,CAAC;IACvD,MAAMK,SAAS,GAAG,IAAI,CAACN,kBAAkB,CAAEC,OAAO,EAAEG,YAAa,CAAC;IAElEE,SAAS,CAACf,IAAI,CAAE,UAAUgB,CAAC,EAAEC,CAAC,EAAG;MAChC,OAAOD,CAAC,CAACpB,KAAK,GAAGqB,CAAC,CAACrB,KAAK;IACzB,CAAE,CAAC;IAEH,OAAOiB,YAAY,CAACK,MAAM,CAAEH,SAAU,CAAC;EACxC;;EAEA;AACD;AACA;AACA;AACA;AACA;EACCD,kBAAkBA,CAAEJ,OAAO,EAAG;IAC7B,OAAOA,OAAO,CAACS,MAAM,CAAE,UAAU1B,MAAM,EAAG;MACzC,OAAO,IAAA2B,mBAAW,EAAE3B,MAAM,CAACG,KAAM,CAAC,IAAIH,MAAM,CAACG,KAAK,KAAK,CAAC;IACzD,CAAE,CAAC;EACJ;;EAEA;AACD;AACA;AACA;AACA;AACA;EACCW,SAASA,CAAEF,IAAI,EAAG;IACjB,MAAMgB,SAAS,GAAG,IAAI,CAACvC,YAAY,CAAEuB,IAAI,CAACtB,MAAO,CAAC;IAClDsC,SAAS,CAACC,IAAI,GAAGjB,IAAI,CAACiB,IAAI;IAC1BD,SAAS,CAACE,UAAU,GAAGlB,IAAI,CAACmB,aAAa,CAAC,CAAC;IAE3C,IAAKnB,IAAI,CAACoB,SAAS,CAAC,CAAC,EAAG;MACvBJ,SAAS,CAACK,MAAM,GAAGrB,IAAI,CAACsB,SAAS,CAAC,CAAC;IACpC;IAEA,OAAON,SAAS;EACjB;;EAEA;AACD;AACA;AACA;AACA;AACA;EACCO,gBAAgBA,CAAEC,YAAY,EAAG;IAChC,IAAI9C,MAAM,GAAG,CAAC;IAEd,IAAK,IAAI,CAACd,OAAO,KAAK,EAAE,EAAG;MAC1B,OAAO,IAAI,CAACuB,cAAc,CAAE;QAAEI,KAAK,EAAEb;MAAO,CAAE,CAAC;IAChD;IAEA,IAAK,IAAA+C,gBAAQ,EAAED,YAAa,CAAC,EAAG;MAC/B9C,MAAM,GAAK8C,YAAY,GAAG,EAAI;IAC/B;IAEA,OAAO,IAAI,CAACrC,cAAc,CAAE;MAAEI,KAAK,EAAEb;IAAO,CAAE,CAAC;EAChD;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;EACCgD,cAAcA,CAAER,UAAU,EAAEG,MAAM,EAAG;IACpC,IAAK,IAAI,CAACjD,aAAa,KAAK8C,UAAU,EAAG;MACxC,IAAI,CAACS,cAAc,CAAC,CAAC;MACrB,IAAI,CAACvD,aAAa,GAAG,KAAK;IAC3B,CAAC,MAAM;MACNiD,MAAM,CAAC,CAAC;MACR,IAAI,CAACjD,aAAa,GAAG8C,UAAU;IAChC;IAEA,IAAI,CAACU,MAAM,CAAC,CAAC;EACd;;EAEA;AACD;AACA;AACA;AACA;EACCC,aAAaA,CAAA,EAAG;IACf,IAAI,CAACzD,aAAa,GAAG,KAAK;IAC1B,IAAI,CAACwD,MAAM,CAAC,CAAC;EACd;;EAEA;AACD;AACA;AACA;AACA;EACCE,oBAAoBA,CAAA,EAAG;IACtB,IAAI,CAAC3D,qBAAqB,GAAG,IAAI;IACjC,IAAI,CAACyD,MAAM,CAAC,CAAC;EACd;;EAEA;AACD;AACA;AACA;AACA;EACCG,mBAAmBA,CAAA,EAAG;IACrB,IAAI,CAAC5D,qBAAqB,GAAG,KAAK;IAClC,IAAI,CAACyD,MAAM,CAAC,CAAC;EACd;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;EACCI,qBAAqBA,CAAEd,UAAU,EAAEG,MAAM,EAAG;IAC3C,MAAMY,SAAS,GAAGC,QAAQ,CAACC,cAAc,CAAE,IAAI,CAACrE,MAAO,CAAC;IACxD,MAAMsE,UAAU,GAAGH,SAAS,CAACI,sBAAsB,CAAE,8BAA8B,GAAGnB,UAAW,CAAC,CAAE,CAAC,CAAE;IAEvGkB,UAAU,CAACE,gBAAgB,CAAE,OAAO,EAAE,IAAI,CAACZ,cAAc,CAACvB,IAAI,CAAE,IAAI,EAAEe,UAAU,EAAEG,MAAO,CAAE,CAAC;EAC7F;;EAEA;AACD;AACA;AACA;AACA;EACCO,MAAMA,CAAA,EAAG;IACR,IAAI,CAACW,uBAAuB,CAAC,CAAC;IAC9B,IAAI,CAACC,mBAAmB,CAAC,CAAC;EAC3B;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;EACCC,eAAeA,CAAEC,MAAM,EAAG;IACzB;IACA,IAAA3C,eAAO,EAAE2C,MAAM,EAAE,UAAUnD,KAAK,EAAG;MAClC,IAAKA,KAAK,CAACf,cAAc,CAAE,QAAS,CAAC,EAAG;QACvC,IAAI,CAACwD,qBAAqB,CAAEzC,KAAK,CAAC2B,UAAU,EAAE3B,KAAK,CAAC8B,MAAO,CAAC;MAC7D;IACD,CAAC,CAAClB,IAAI,CAAE,IAAK,CAAE,CAAC;EACjB;;EAEA;AACD;AACA;AACA;AACA;EACCwB,cAAcA,CAAA,EAAG;IAChB,MAAMN,MAAM,GAAG,IAAI,CAACxD,QAAQ,CAAC8E,iBAAiB,CAAC,CAAC;IAEhDtB,MAAM,CAAE,IAAI,CAACxD,QAAQ,CAAC+E,QAAQ,CAAC,CAAC,EAAE,EAAG,CAAC;EACvC;;EAEA;AACD;AACA;AACA;AACA;AACA;EACCL,uBAAuBA,CAAA,EAAG,CAAC;;EAE3B;AACD;AACA;AACA;AACA;EACCC,mBAAmBA,CAAA,EAAG;IACrB,MAAMK,aAAa,GAAG,IAAI,CAACtB,gBAAgB,CAAE,IAAI,CAAC1D,QAAQ,CAACiF,qBAAqB,CAAC,CAAE,CAAC;IACpF,MAAMC,oBAAoB,GAAGb,QAAQ,CAACC,cAAc,CAAE,IAAI,CAACnE,OAAQ,CAAC;IAEpE,IAAK,CAAE+E,oBAAoB,EAAG;MAC7B;IACD;IAEAA,oBAAoB,CAACpE,SAAS,GAAG,eAAe,GAAG,IAAI,CAACC,sBAAsB,CAAEiE,aAAa,CAACnE,MAAO,CAAC;EACvG;AACD;AAAC,IAAAsE,QAAA,GAAAC,OAAA,CAAAzF,OAAA,GAEcC,iBAAiB","ignoreList":[]}

package/build/cjs/scoring/scoreAggregators/ReadabilityScoreAggregator.js

@@ -0,0 +1,203 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.READABILITY_SCORES = void 0;
+var _getLanguage = _interopRequireDefault(require("../../languageProcessing/helpers/language/getLanguage"));
+var _interpreters = require("../interpreters");
+var _ScoreAggregator = _interopRequireDefault(require("./ScoreAggregator"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/* Internal dependencies */
+
+/**
+ * Penalties that can be given on each assessment
+ * when all assessments are currently supported
+ * for the user's language.
+ *
+ * @type {{ok: number, bad: number, good: number}}
+ * @const
+ *
+ * @memberOf module:parsedPaper/assess
+ */
+const PENALTY_MAPPING_FULL_SUPPORT = {
+  bad: 3,
+  ok: 2,
+  good: 0
+};
+
+/**
+ * Penalties that can be given on each assessment
+ * when only a part of the assessments are currently supported
+ * for the user's language.
+ *
+ * @type {{ok: number, bad: number, good: number}}
+ * @const
+ *
+ * @memberOf module:parsedPaper/assess
+ */
+const PENALTY_MAPPING_PARTIAL_SUPPORT = {
+  bad: 4,
+  ok: 2,
+  good: 0
+};
+
+/**
+ * The scores that can be given on the readability analysis.
+ *
+ * @type {{GOOD: number, OKAY: number, NEEDS_IMPROVEMENT: number, NOT_AVAILABLE: number}}
+ * @const
+ *
+ * @memberOf module:parsedPaper/assess
+ */
+const READABILITY_SCORES = exports.READABILITY_SCORES = {
+  GOOD: 90,
+  OKAY: 60,
+  NEEDS_IMPROVEMENT: 30,
+  NOT_AVAILABLE: 0
+};
+
+/**
+ * A list of all the languages that have full support in the readability analysis.
+ *
+ * @type {string[]}
+ * @const
+ */
+const FULLY_SUPPORTED_LANGUAGES = ["en", "nl", "de", "it", "ru", "fr", "es"];
+
+/**
+ * Aggregates the results of the readability analysis into a single score.
+ *
+ * @memberOf module:parsedPaper/assess
+ */
+class ReadabilityScoreAggregator extends _ScoreAggregator.default {
+  /**
+   * Determines whether a language is fully supported.
+   *
+   * @param {string} locale The locale for which the content is written, e.g. `sv-SE` for Sweden.
+   *
+   * @returns {boolean} `true` if fully supported.
+   */
+  isFullySupported(locale) {
+    // Sanity check if this is actually a locale string.
+    if (locale && locale.includes("_")) {
+      const language = (0, _getLanguage.default)(locale);
+      return FULLY_SUPPORTED_LANGUAGES.includes(language);
+    }
+    // Default to not fully supported.
+    return false;
+  }
+
+  /**
+   * Calculates the overall score (GOOD, OKAY or NEEDS IMPROVEMENT)
+   * based on the penalty.
+   *
+   * @param {boolean} isFullySupported Whether this language is fully supported.
+   * @param {number}  penalty          The total penalty.
+   *
+   * @returns {number} The overall score.
+   */
+  calculateScore(isFullySupported, penalty) {
+    if (isFullySupported) {
+      /*
+       * If the language is fully supported, we are more lenient.
+       * A higher penalty is needed to get lower scores.
+       */
+      if (penalty > 6) {
+        return READABILITY_SCORES.NEEDS_IMPROVEMENT;
+      }
+      if (penalty > 4) {
+        /*
+         * A penalty between 4 and 6 means either:
+         *  - One "ok" and one "bad" result (5).
+         *  - Two "bad" results of 3 points each (6).
+         *  - Three "ok" results of 2 points each (6).
+         */
+        return READABILITY_SCORES.OKAY;
+      }
+    } else {
+      /*
+       * If the language is NOT fully supported, we are more stringent.
+       * The penalty threshold for getting lower scores is set lower.
+       */
+      if (penalty > 4) {
+        return READABILITY_SCORES.NEEDS_IMPROVEMENT;
+      }
+      if (penalty > 2) {
+        /*
+         * A penalty of 3 or 4 means:
+         *  - Two "ok" results of 2 points each (4).
+         *  - One "bad" result of 4 points (4).
+         */
+        return READABILITY_SCORES.OKAY;
+      }
+    }
+    return READABILITY_SCORES.GOOD;
+  }
+
+  /**
+   * Calculates the total penalty based on the given assessment results.
+   *
+   * @param {AssessmentResult[]} results The valid results from which to calculate the total penalty.
+   *
+   * @returns {number} The total penalty for the results.
+   */
+  calculatePenalty(results) {
+    return results.reduce((sum, result) => {
+      // Compute the rating ("error", "feedback", "bad", "ok" or "good").
+      const rating = (0, _interpreters.scoreToRating)(result.getScore());
+      const penalty = this.isFullySupported(this.locale) ? PENALTY_MAPPING_FULL_SUPPORT[rating] : PENALTY_MAPPING_PARTIAL_SUPPORT[rating];
+
+      // Add penalty when available.
+      return penalty ? sum + penalty : sum;
+    }, 0);
+  }
+
+  /**
+   * Returns the list of valid results.
+   * Valid results are all results that have a score and a text.
+   *
+   * @param {AssessmentResult[]} results The results to filter the valid results from.
+   *
+   * @returns {AssessmentResult[]} The list of valid results.
+   */
+  getValidResults(results) {
+    return results.filter(result => result.hasScore() && result.hasText());
+  }
+
+  /**
+   * Sets the locale of the content. We are more lenient on languages
+   * that are fully supported in the analysis.
+   *
+   * @param {string} locale The locale of the content.
+   *
+   * @returns {void}
+   */
+  setLocale(locale) {
+    this.locale = locale;
+  }
+
+  /**
+   * Aggregates the given assessment results into a single analysis score.
+   *
+   * @param {AssessmentResult[]} results The assessment results.
+   *
+   * @returns {number} The aggregated score.
+   */
+  aggregate(results) {
+    const validResults = this.getValidResults(results);
+
+    /*
+     * If you have no content, you have a gray indicator.
+     * (Assume that one result always means the 'no content' assessment result).
+     */
+    if (validResults.length <= 1) {
+      return READABILITY_SCORES.NOT_AVAILABLE;
+    }
+    const penalty = this.calculatePenalty(validResults);
+    const isFullySupported = this.isFullySupported(this.locale);
+    return this.calculateScore(isFullySupported, penalty);
+  }
+}
+var _default = exports.default = ReadabilityScoreAggregator;
+//# sourceMappingURL=ReadabilityScoreAggregator.js.map

package/build/cjs/scoring/scoreAggregators/ReadabilityScoreAggregator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadabilityScoreAggregator.js","names":["_getLanguage","_interopRequireDefault","require","_interpreters","_ScoreAggregator","e","__esModule","default","PENALTY_MAPPING_FULL_SUPPORT","bad","ok","good","PENALTY_MAPPING_PARTIAL_SUPPORT","READABILITY_SCORES","exports","GOOD","OKAY","NEEDS_IMPROVEMENT","NOT_AVAILABLE","FULLY_SUPPORTED_LANGUAGES","ReadabilityScoreAggregator","ScoreAggregator","isFullySupported","locale","includes","language","getLanguage","calculateScore","penalty","calculatePenalty","results","reduce","sum","result","rating","scoreToRating","getScore","getValidResults","filter","hasScore","hasText","setLocale","aggregate","validResults","length","_default"],"sources":["../../../../src/scoring/scoreAggregators/ReadabilityScoreAggregator.js"],"sourcesContent":["import getLanguage from \"../../languageProcessing/helpers/language/getLanguage\";\nimport { scoreToRating } from \"../interpreters\";\n\n/* Internal dependencies */\nimport ScoreAggregator from \"./ScoreAggregator\";\n\n/**\n * Penalties that can be given on each assessment\n * when all assessments are currently supported\n * for the user's language.\n *\n * @type {{ok: number, bad: number, good: number}}\n * @const\n *\n * @memberOf module:parsedPaper/assess\n */\nconst PENALTY_MAPPING_FULL_SUPPORT = {\n\tbad: 3,\n\tok: 2,\n\tgood: 0,\n};\n\n/**\n * Penalties that can be given on each assessment\n * when only a part of the assessments are currently supported\n * for the user's language.\n *\n * @type {{ok: number, bad: number, good: number}}\n * @const\n *\n * @memberOf module:parsedPaper/assess\n */\nconst PENALTY_MAPPING_PARTIAL_SUPPORT = {\n\tbad: 4,\n\tok: 2,\n\tgood: 0,\n};\n\n/**\n * The scores that can be given on the readability analysis.\n *\n * @type {{GOOD: number, OKAY: number, NEEDS_IMPROVEMENT: number, NOT_AVAILABLE: number}}\n * @const\n *\n * @memberOf module:parsedPaper/assess\n */\nexport const READABILITY_SCORES = {\n\tGOOD: 90,\n\tOKAY: 60,\n\tNEEDS_IMPROVEMENT: 30,\n\tNOT_AVAILABLE: 0,\n};\n\n/**\n * A list of all the languages that have full support in the readability analysis.\n *\n * @type {string[]}\n * @const\n */\nconst FULLY_SUPPORTED_LANGUAGES = [ \"en\", \"nl\", \"de\", \"it\", \"ru\", \"fr\", \"es\" ];\n\n/**\n * Aggregates the results of the readability analysis into a single score.\n *\n * @memberOf module:parsedPaper/assess\n */\nclass ReadabilityScoreAggregator extends ScoreAggregator {\n\t/**\n\t * Determines whether a language is fully supported.\n\t *\n\t * @param {string} locale The locale for which the content is written, e.g. `sv-SE` for Sweden.\n\t *\n\t * @returns {boolean} `true` if fully supported.\n\t */\n\tisFullySupported( locale ) {\n\t\t// Sanity check if this is actually a locale string.\n\t\tif ( locale && locale.includes( \"_\" ) ) {\n\t\t\tconst language = getLanguage( locale );\n\t\t\treturn FULLY_SUPPORTED_LANGUAGES.includes( language );\n\t\t}\n\t\t// Default to not fully supported.\n\t\treturn false;\n\t}\n\n\t/**\n\t * Calculates the overall score (GOOD, OKAY or NEEDS IMPROVEMENT)\n\t * based on the penalty.\n\t *\n\t * @param {boolean} isFullySupported Whether this language is fully supported.\n\t * @param {number}  penalty          The total penalty.\n\t *\n\t * @returns {number} The overall score.\n\t */\n\tcalculateScore( isFullySupported, penalty ) {\n\t\tif ( isFullySupported ) {\n\t\t\t/*\n\t\t\t * If the language is fully supported, we are more lenient.\n\t\t\t * A higher penalty is needed to get lower scores.\n\t\t\t */\n\t\t\tif ( penalty > 6 ) {\n\t\t\t\treturn READABILITY_SCORES.NEEDS_IMPROVEMENT;\n\t\t\t}\n\n\t\t\tif ( penalty > 4 ) {\n\t\t\t\t/*\n\t\t\t\t * A penalty between 4 and 6 means either:\n\t\t\t\t *  - One \"ok\" and one \"bad\" result (5).\n\t\t\t\t *  - Two \"bad\" results of 3 points each (6).\n\t\t\t\t *  - Three \"ok\" results of 2 points each (6).\n\t\t\t\t */\n\t\t\t\treturn READABILITY_SCORES.OKAY;\n\t\t\t}\n\t\t} else {\n\t\t\t/*\n\t\t\t * If the language is NOT fully supported, we are more stringent.\n\t\t\t * The penalty threshold for getting lower scores is set lower.\n\t\t\t */\n\t\t\tif ( penalty > 4 ) {\n\t\t\t\treturn READABILITY_SCORES.NEEDS_IMPROVEMENT;\n\t\t\t}\n\n\t\t\tif ( penalty > 2 ) {\n\t\t\t\t/*\n\t\t\t\t * A penalty of 3 or 4 means:\n\t\t\t\t *  - Two \"ok\" results of 2 points each (4).\n\t\t\t\t *  - One \"bad\" result of 4 points (4).\n\t\t\t\t */\n\t\t\t\treturn READABILITY_SCORES.OKAY;\n\t\t\t}\n\t\t}\n\t\treturn READABILITY_SCORES.GOOD;\n\t}\n\n\t/**\n\t * Calculates the total penalty based on the given assessment results.\n\t *\n\t * @param {AssessmentResult[]} results The valid results from which to calculate the total penalty.\n\t *\n\t * @returns {number} The total penalty for the results.\n\t */\n\tcalculatePenalty( results ) {\n\t\treturn results.reduce( ( sum, result ) => {\n\t\t\t// Compute the rating (\"error\", \"feedback\", \"bad\", \"ok\" or \"good\").\n\t\t\tconst rating = scoreToRating( result.getScore() );\n\n\t\t\tconst penalty = this.isFullySupported( this.locale )\n\t\t\t\t? PENALTY_MAPPING_FULL_SUPPORT[ rating ]\n\t\t\t\t: PENALTY_MAPPING_PARTIAL_SUPPORT[ rating ];\n\n\t\t\t// Add penalty when available.\n\t\t\treturn penalty ? sum + penalty : sum;\n\t\t}, 0 );\n\t}\n\n\t/**\n\t * Returns the list of valid results.\n\t * Valid results are all results that have a score and a text.\n\t *\n\t * @param {AssessmentResult[]} results The results to filter the valid results from.\n\t *\n\t * @returns {AssessmentResult[]} The list of valid results.\n\t */\n\tgetValidResults( results ) {\n\t\treturn results.filter( result => result.hasScore() && result.hasText() );\n\t}\n\n\t/**\n\t * Sets the locale of the content. We are more lenient on languages\n\t * that are fully supported in the analysis.\n\t *\n\t * @param {string} locale The locale of the content.\n\t *\n\t * @returns {void}\n\t */\n\tsetLocale( locale ) {\n\t\tthis.locale = locale;\n\t}\n\n\t/**\n\t * Aggregates the given assessment results into a single analysis score.\n\t *\n\t * @param {AssessmentResult[]} results The assessment results.\n\t *\n\t * @returns {number} The aggregated score.\n\t */\n\taggregate( results ) {\n\t\tconst validResults = this.getValidResults( results );\n\n\t\t/*\n\t\t * If you have no content, you have a gray indicator.\n\t\t * (Assume that one result always means the 'no content' assessment result).\n\t\t */\n\t\tif ( validResults.length <= 1 ) {\n\t\t\treturn READABILITY_SCORES.NOT_AVAILABLE;\n\t\t}\n\n\t\tconst penalty = this.calculatePenalty( validResults );\n\t\tconst isFullySupported = this.isFullySupported( this.locale );\n\t\treturn this.calculateScore( isFullySupported, penalty );\n\t}\n}\n\nexport default ReadabilityScoreAggregator;\n"],"mappings":";;;;;;AAAA,IAAAA,YAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAGA,IAAAE,gBAAA,GAAAH,sBAAA,CAAAC,OAAA;AAAgD,SAAAD,uBAAAI,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AADhD;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMG,4BAA4B,GAAG;EACpCC,GAAG,EAAE,CAAC;EACNC,EAAE,EAAE,CAAC;EACLC,IAAI,EAAE;AACP,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,+BAA+B,GAAG;EACvCH,GAAG,EAAE,CAAC;EACNC,EAAE,EAAE,CAAC;EACLC,IAAI,EAAE;AACP,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAME,kBAAkB,GAAAC,OAAA,CAAAD,kBAAA,GAAG;EACjCE,IAAI,EAAE,EAAE;EACRC,IAAI,EAAE,EAAE;EACRC,iBAAiB,EAAE,EAAE;EACrBC,aAAa,EAAE;AAChB,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,yBAAyB,GAAG,CAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAE;;AAE9E;AACA;AACA;AACA;AACA;AACA,MAAMC,0BAA0B,SAASC,wBAAe,CAAC;EACxD;AACD;AACA;AACA;AACA;AACA;AACA;EACCC,gBAAgBA,CAAEC,MAAM,EAAG;IAC1B;IACA,IAAKA,MAAM,IAAIA,MAAM,CAACC,QAAQ,CAAE,GAAI,CAAC,EAAG;MACvC,MAAMC,QAAQ,GAAG,IAAAC,oBAAW,EAAEH,MAAO,CAAC;MACtC,OAAOJ,yBAAyB,CAACK,QAAQ,CAAEC,QAAS,CAAC;IACtD;IACA;IACA,OAAO,KAAK;EACb;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACCE,cAAcA,CAAEL,gBAAgB,EAAEM,OAAO,EAAG;IAC3C,IAAKN,gBAAgB,EAAG;MACvB;AACH;AACA;AACA;MACG,IAAKM,OAAO,GAAG,CAAC,EAAG;QAClB,OAAOf,kBAAkB,CAACI,iBAAiB;MAC5C;MAEA,IAAKW,OAAO,GAAG,CAAC,EAAG;QAClB;AACJ;AACA;AACA;AACA;AACA;QACI,OAAOf,kBAAkB,CAACG,IAAI;MAC/B;IACD,CAAC,MAAM;MACN;AACH;AACA;AACA;MACG,IAAKY,OAAO,GAAG,CAAC,EAAG;QAClB,OAAOf,kBAAkB,CAACI,iBAAiB;MAC5C;MAEA,IAAKW,OAAO,GAAG,CAAC,EAAG;QAClB;AACJ;AACA;AACA;AACA;QACI,OAAOf,kBAAkB,CAACG,IAAI;MAC/B;IACD;IACA,OAAOH,kBAAkB,CAACE,IAAI;EAC/B;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;EACCc,gBAAgBA,CAAEC,OAAO,EAAG;IAC3B,OAAOA,OAAO,CAACC,MAAM,CAAE,CAAEC,GAAG,EAAEC,MAAM,KAAM;MACzC;MACA,MAAMC,MAAM,GAAG,IAAAC,2BAAa,EAAEF,MAAM,CAACG,QAAQ,CAAC,CAAE,CAAC;MAEjD,MAAMR,OAAO,GAAG,IAAI,CAACN,gBAAgB,CAAE,IAAI,CAACC,MAAO,CAAC,GACjDf,4BAA4B,CAAE0B,MAAM,CAAE,GACtCtB,+BAA+B,CAAEsB,MAAM,CAAE;;MAE5C;MACA,OAAON,OAAO,GAAGI,GAAG,GAAGJ,OAAO,GAAGI,GAAG;IACrC,CAAC,EAAE,CAAE,CAAC;EACP;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;AACA;EACCK,eAAeA,CAAEP,OAAO,EAAG;IAC1B,OAAOA,OAAO,CAACQ,MAAM,CAAEL,MAAM,IAAIA,MAAM,CAACM,QAAQ,CAAC,CAAC,IAAIN,MAAM,CAACO,OAAO,CAAC,CAAE,CAAC;EACzE;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;AACA;EACCC,SAASA,CAAElB,MAAM,EAAG;IACnB,IAAI,CAACA,MAAM,GAAGA,MAAM;EACrB;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;EACCmB,SAASA,CAAEZ,OAAO,EAAG;IACpB,MAAMa,YAAY,GAAG,IAAI,CAACN,eAAe,CAAEP,OAAQ,CAAC;;IAEpD;AACF;AACA;AACA;IACE,IAAKa,YAAY,CAACC,MAAM,IAAI,CAAC,EAAG;MAC/B,OAAO/B,kBAAkB,CAACK,aAAa;IACxC;IAEA,MAAMU,OAAO,GAAG,IAAI,CAACC,gBAAgB,CAAEc,YAAa,CAAC;IACrD,MAAMrB,gBAAgB,GAAG,IAAI,CAACA,gBAAgB,CAAE,IAAI,CAACC,MAAO,CAAC;IAC7D,OAAO,IAAI,CAACI,cAAc,CAAEL,gBAAgB,EAAEM,OAAQ,CAAC;EACxD;AACD;AAAC,IAAAiB,QAAA,GAAA/B,OAAA,CAAAP,OAAA,GAEca,0BAA0B","ignoreList":[]}

package/build/cjs/scoring/scoreAggregators/SEOScoreAggregator.js

@@ -0,0 +1,60 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _ScoreAggregator = _interopRequireDefault(require("./ScoreAggregator"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * The number to scale the score to.
+ *
+ * Individual scores are from 1 to 9.
+ * The total score should be multiplied by this number to scale up.
+ *
+ * @type {number}
+ * @const
+ *
+ * @memberOf module:parsedPaper/assess
+ */
+const ScoreScale = 100;
+
+/**
+ * The factor to multiply the amount of results with.
+ *
+ * Individual scores are from 1 to 9.
+ * The make the total score work in the 100 scale, the amount of results needs to get multiplied by this factor.
+ *
+ * @type {number}
+ * @const
+ *
+ * @memberOf module:parsedPaper/assess
+ */
+const ScoreFactor = 9;
+
+/**
+ * Aggregates SEO assessment results into a single score.
+ *
+ * @memberOf module:parsedPaper/assess
+ */
+class SEOScoreAggregator extends _ScoreAggregator.default {
+  /**
+   * Aggregates the given assessment results into a single score.
+   *
+   * @param {AssessmentResult[]} results The assessment results.
+   *
+   * @returns {number} The aggregated score.
+   */
+  aggregate(results) {
+    const score = results.reduce((sum, result) => sum + result.getScore(), 0);
+
+    /*
+     * Whenever the divide by part is 0 this can result in a `NaN` value. Then 0 should be returned as fallback.
+     * This seemed better than the if check `results.length === 0`,
+     * because it also protects against ScoreFactor being 0.
+     */
+    return Math.round(score * ScoreScale / (results.length * ScoreFactor)) || 0;
+  }
+}
+var _default = exports.default = SEOScoreAggregator;
+//# sourceMappingURL=SEOScoreAggregator.js.map

package/build/cjs/scoring/scoreAggregators/SEOScoreAggregator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SEOScoreAggregator.js","names":["_ScoreAggregator","_interopRequireDefault","require","e","__esModule","default","ScoreScale","ScoreFactor","SEOScoreAggregator","ScoreAggregator","aggregate","results","score","reduce","sum","result","getScore","Math","round","length","_default","exports"],"sources":["../../../../src/scoring/scoreAggregators/SEOScoreAggregator.js"],"sourcesContent":["import ScoreAggregator from \"./ScoreAggregator\";\n\n/**\n * The number to scale the score to.\n *\n * Individual scores are from 1 to 9.\n * The total score should be multiplied by this number to scale up.\n *\n * @type {number}\n * @const\n *\n * @memberOf module:parsedPaper/assess\n */\nconst ScoreScale = 100;\n\n/**\n * The factor to multiply the amount of results with.\n *\n * Individual scores are from 1 to 9.\n * The make the total score work in the 100 scale, the amount of results needs to get multiplied by this factor.\n *\n * @type {number}\n * @const\n *\n * @memberOf module:parsedPaper/assess\n */\nconst ScoreFactor = 9;\n\n/**\n * Aggregates SEO assessment results into a single score.\n *\n * @memberOf module:parsedPaper/assess\n */\nclass SEOScoreAggregator extends ScoreAggregator {\n\t/**\n\t * Aggregates the given assessment results into a single score.\n\t *\n\t * @param {AssessmentResult[]} results The assessment results.\n\t *\n\t * @returns {number} The aggregated score.\n\t */\n\taggregate( results ) {\n\t\tconst score = results.reduce( ( sum, result ) => sum + result.getScore(), 0 );\n\n\t\t/*\n\t\t * Whenever the divide by part is 0 this can result in a `NaN` value. Then 0 should be returned as fallback.\n\t\t * This seemed better than the if check `results.length === 0`,\n\t\t * because it also protects against ScoreFactor being 0.\n\t\t */\n\t\treturn Math.round( ( score * ScoreScale ) / ( results.length * ScoreFactor ) ) || 0;\n\t}\n}\n\nexport default SEOScoreAggregator;\n"],"mappings":";;;;;;AAAA,IAAAA,gBAAA,GAAAC,sBAAA,CAAAC,OAAA;AAAgD,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEhD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMG,UAAU,GAAG,GAAG;;AAEtB;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMC,WAAW,GAAG,CAAC;;AAErB;AACA;AACA;AACA;AACA;AACA,MAAMC,kBAAkB,SAASC,wBAAe,CAAC;EAChD;AACD;AACA;AACA;AACA;AACA;AACA;EACCC,SAASA,CAAEC,OAAO,EAAG;IACpB,MAAMC,KAAK,GAAGD,OAAO,CAACE,MAAM,CAAE,CAAEC,GAAG,EAAEC,MAAM,KAAMD,GAAG,GAAGC,MAAM,CAACC,QAAQ,CAAC,CAAC,EAAE,CAAE,CAAC;;IAE7E;AACF;AACA;AACA;AACA;IACE,OAAOC,IAAI,CAACC,KAAK,CAAIN,KAAK,GAAGN,UAAU,IAAOK,OAAO,CAACQ,MAAM,GAAGZ,WAAW,CAAG,CAAC,IAAI,CAAC;EACpF;AACD;AAAC,IAAAa,QAAA,GAAAC,OAAA,CAAAhB,OAAA,GAEcG,kBAAkB","ignoreList":[]}