axyseo 2.0.0-alpha.0.0.2 → 2.0.0-alpha.0.0.21

package/build/scoring/assessments/readability/SentenceLengthInTextAssessment.js

@@ -0,0 +1,177 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _react = _interopRequireDefault(require("react"));
+var _polaris = require("@shopify/polaris");
+var _assessment = _interopRequireDefault(require("../assessment"));
+var _checkForTooLongSentences = _interopRequireDefault(require("../../helpers/assessments/checkForTooLongSentences"));
+var _formatNumber = _interopRequireDefault(require("../../../helpers/formatNumber"));
+var _inRange = require("../../helpers/assessments/inRange");
+var _AssessmentResult = _interopRequireDefault(require("../../../values/AssessmentResult"));
+var _polarisIcons = require("@shopify/polaris-icons");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Represents the assessment that will calculate the length of sentences in the text.
+ */
+class SentenceLengthInTextAssessment extends _assessment.default {
+  /**
+  * Sets the identifier and the config.
+  *
+  * @param {object} config			The scoring configuration that should be used.
+  * @param {boolean} isCornerstone	Whether cornerstone configuration should be used.
+  * @param {boolean} isProduct		Whether product configuration should be used.
+   * @returns {void}
+  */
+  constructor(config = {}, isCornerstone = false, isProduct = false) {
+    super();
+    const defaultConfig = {
+      id: 'textSentenceLength',
+      priority: 'high',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#sentence-length',
+      ctaType: 'fix',
+      fixPosition: 'sentenceLength',
+      icon: _polarisIcons.TextBlockIcon,
+      recommendedLength: 20,
+      slightlyTooMany: 25,
+      farTooMany: 30,
+      title: 'Text Sentence Length',
+      content: {
+        improve: '',
+        bad: 'Sentence too long. Keep sentence length less than 20 words to improve readability and flow.',
+        good: 'Sentence length is optimized for readability, less than 20 words.'
+      }
+    };
+    this._config = (0, _lodash.merge)(defaultConfig, config);
+    this.identifier = 'textSentenceLength';
+  }
+
+  /**
+   * Scores the percentage of sentences including more than the recommended number of words.
+   *
+   * @param {Paper} paper The paper to use for the assessment.
+   * @param {Researcher} researcher The researcher used for calling research.
+   *
+   * @param i18n
+   * @returns {AssessmentResult} The Assessment result.
+   */
+  getResult({
+    paper,
+    researcher,
+    i18n
+  }) {
+    const sentences = researcher.getResearch('countSentencesFromText');
+    if (researcher.getConfig('sentenceLength')) {
+      this._config = this.getLanguageSpecificConfig(researcher);
+    }
+    const percentage = this.calculatePercentage(sentences);
+    const result = this.calculateResult(percentage, i18n);
+    const assessmentResult = new _AssessmentResult.default({
+      config: this._config
+    });
+    assessmentResult.setScore(result.score);
+    assessmentResult.setStatus(result.status);
+    assessmentResult.setBody(result.body);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks whether the paper has text.
+   *
+   * @param {Paper} paper The paper to use for the assessment.
+   *
+   * @returns {boolean} True when there is text.
+   */
+  isApplicable(paper) {
+    return this.hasEnoughContentForAssessment(paper);
+  }
+
+  /**
+   * Check if there is language-specific config, and if so, overwrite the current config with it.
+   *
+   * @param {Researcher} researcher The researcher to use.
+   *
+   * @returns {Object} The config that should be used.
+   */
+  getLanguageSpecificConfig(researcher) {
+    const currentConfig = this._config;
+    const languageSpecificConfig = researcher.getConfig('sentenceLength');
+    if (languageSpecificConfig.hasOwnProperty('recommendedLength')) {
+      currentConfig.recommendedLength = languageSpecificConfig.recommendedLength;
+    }
+    return currentConfig;
+  }
+
+  /**
+   * Calculates the percentage of sentences that are too long.
+   *
+   * @param {Array} sentences The sentences to calculate the percentage for.
+   * @returns {number} The calculates percentage of too long sentences.
+   */
+  calculatePercentage(sentences) {
+    let percentage = 0;
+    if (sentences.length !== 0) {
+      const tooLongTotal = this.countTooLongSentences(sentences);
+      percentage = (0, _formatNumber.default)(tooLongTotal / sentences.length * 100);
+    }
+    return percentage;
+  }
+
+  /**
+   *
+   * @param percentage
+   * @param i18n
+   * @returns {{score: number, body: React.JSX.Element, status: string}}
+   */
+  calculateResult(percentage, i18n) {
+    let status = '';
+    if (percentage <= this._config.recommendedLength) {
+      status = 'good';
+    }
+    if (percentage > this._config.recommendedLength) {
+      status = 'bad';
+    }
+    const score = this.getScore(this._config.priority, status);
+    this._config.content = {
+      improve: '',
+      bad: `Sentence too long. Keep sentence length less than ${this._config.recommendedLength} words to improve readability and flow.`,
+      good: `Sentence length is optimized for readability, less than ${this._config.recommendedLength} words.`
+    };
+    return {
+      score,
+      status,
+      body: /*#__PURE__*/_react.default.createElement(_polaris.Text, {
+        as: 'span'
+      }, this._config.content[status], ' ', this._config.docUrl && /*#__PURE__*/_react.default.createElement("a", {
+        href: this._config.docUrl,
+        target: "_blank",
+        rel: "noreferrer"
+      }, "Learn more"))
+    };
+  }
+
+  /**
+   * Gets the sentences that are qualified as being too long.
+   *
+   * @param {array} sentences The sentences to filter through.
+   * @returns {array} Array with all the sentences considered to be too long.
+   */
+  getTooLongSentences(sentences) {
+    return (0, _checkForTooLongSentences.default)(sentences, this._config.recommendedLength);
+  }
+
+  /**
+   * Get the total amount of sentences that are qualified as being too long.
+   *
+   * @param {Array} sentences The sentences to filter through.
+   * @returns {Number} The amount of sentences that are considered too long.
+   */
+  countTooLongSentences(sentences) {
+    return this.getTooLongSentences(sentences).length;
+  }
+}
+var _default = exports.default = SentenceLengthInTextAssessment;
+//# sourceMappingURL=SentenceLengthInTextAssessment.js.map

package/build/scoring/assessments/readability/SentenceLengthInTextAssessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SentenceLengthInTextAssessment.js","names":["_lodash","require","_react","_interopRequireDefault","_polaris","_assessment","_checkForTooLongSentences","_formatNumber","_inRange","_AssessmentResult","_polarisIcons","e","__esModule","default","SentenceLengthInTextAssessment","Assessment","constructor","config","isCornerstone","isProduct","defaultConfig","id","priority","docUrl","ctaType","fixPosition","icon","TextBlockIcon","recommendedLength","slightlyTooMany","farTooMany","title","content","improve","bad","good","_config","merge","identifier","getResult","paper","researcher","i18n","sentences","getResearch","getConfig","getLanguageSpecificConfig","percentage","calculatePercentage","result","calculateResult","assessmentResult","AssessmentResult","setScore","score","setStatus","status","setBody","body","isApplicable","hasEnoughContentForAssessment","currentConfig","languageSpecificConfig","hasOwnProperty","length","tooLongTotal","countTooLongSentences","formatNumber","getScore","createElement","Text","as","href","target","rel","getTooLongSentences","_default","exports"],"sources":["../../../../src/scoring/assessments/readability/SentenceLengthInTextAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport React from 'react';\nimport {Text} from '@shopify/polaris';\nimport Assessment from '../assessment';\nimport getTooLongSentences from '../../helpers/assessments/checkForTooLongSentences';\nimport formatNumber from '../../../helpers/formatNumber';\nimport {inRangeEndInclusive as inRange} from '../../helpers/assessments/inRange';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {TextBlockIcon} from '@shopify/polaris-icons';\n\n/**\n * Represents the assessment that will calculate the length of sentences in the text.\n */\nclass SentenceLengthInTextAssessment extends Assessment {\n  /**\n\t * Sets the identifier and the config.\n\t *\n\t * @param {object} config\t\t\tThe scoring configuration that should be used.\n\t * @param {boolean} isCornerstone\tWhether cornerstone configuration should be used.\n\t * @param {boolean} isProduct\t\tWhether product configuration should be used.\n\n\t * @returns {void}\n\t */\n  constructor(config = {}, isCornerstone = false, isProduct = false) {\n    super();\n\n    const defaultConfig = {\n      id: 'textSentenceLength',\n      priority: 'high',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#sentence-length',\n      ctaType: 'fix',\n      fixPosition: 'sentenceLength',\n      icon: TextBlockIcon,\n      recommendedLength: 20,\n      slightlyTooMany: 25,\n      farTooMany: 30,\n      title: 'Text Sentence Length',\n      content: {\n        improve: '',\n        bad:\n          'Sentence too long. Keep sentence length less than 20 words to improve readability and flow.',\n        good: 'Sentence length is optimized for readability, less than 20 words.'\n      }\n    };\n\n    this._config = merge(defaultConfig, config);\n    this.identifier = 'textSentenceLength';\n  }\n\n  /**\n   * Scores the percentage of sentences including more than the recommended number of words.\n   *\n   * @param {Paper} paper The paper to use for the assessment.\n   * @param {Researcher} researcher The researcher used for calling research.\n   *\n   * @param i18n\n   * @returns {AssessmentResult} The Assessment result.\n   */\n  getResult({paper, researcher, i18n}) {\n    const sentences = researcher.getResearch('countSentencesFromText');\n    if (researcher.getConfig('sentenceLength')) {\n      this._config = this.getLanguageSpecificConfig(researcher);\n    }\n\n    const percentage = this.calculatePercentage(sentences);\n    const result = this.calculateResult(percentage, i18n);\n\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(result.score);\n    assessmentResult.setStatus(result.status);\n    assessmentResult.setBody(result.body);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks whether the paper has text.\n   *\n   * @param {Paper} paper The paper to use for the assessment.\n   *\n   * @returns {boolean} True when there is text.\n   */\n  isApplicable(paper) {\n    return this.hasEnoughContentForAssessment(paper);\n  }\n\n  /**\n   * Check if there is language-specific config, and if so, overwrite the current config with it.\n   *\n   * @param {Researcher} researcher The researcher to use.\n   *\n   * @returns {Object} The config that should be used.\n   */\n  getLanguageSpecificConfig(researcher) {\n    const currentConfig = this._config;\n    const languageSpecificConfig = researcher.getConfig('sentenceLength');\n\n    if (languageSpecificConfig.hasOwnProperty('recommendedLength')) {\n      currentConfig.recommendedLength = languageSpecificConfig.recommendedLength;\n    }\n\n    return currentConfig;\n  }\n\n  /**\n   * Calculates the percentage of sentences that are too long.\n   *\n   * @param {Array} sentences The sentences to calculate the percentage for.\n   * @returns {number} The calculates percentage of too long sentences.\n   */\n  calculatePercentage(sentences) {\n    let percentage = 0;\n\n    if (sentences.length !== 0) {\n      const tooLongTotal = this.countTooLongSentences(sentences);\n\n      percentage = formatNumber((tooLongTotal / sentences.length) * 100);\n    }\n\n    return percentage;\n  }\n\n  /**\n   *\n   * @param percentage\n   * @param i18n\n   * @returns {{score: number, body: React.JSX.Element, status: string}}\n   */\n  calculateResult(percentage, i18n) {\n    let status = '';\n    if (percentage <= this._config.recommendedLength) {\n      status = 'good';\n    }\n\n    if (percentage > this._config.recommendedLength) {\n      status = 'bad';\n    }\n\n    const score = this.getScore(this._config.priority, status);\n\n    this._config.content = {\n      improve: '',\n      bad: `Sentence too long. Keep sentence length less than ${this._config.recommendedLength} words to improve readability and flow.`,\n      good: `Sentence length is optimized for readability, less than ${this._config.recommendedLength} words.`\n    };\n\n    return {\n      score,\n      status,\n      body: (\n        <Text as={'span'}>\n          {this._config.content[status]}{' '}\n          {this._config.docUrl && (\n            <a href={this._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n              Learn more\n            </a>\n          )}\n        </Text>\n      )\n    };\n  }\n\n  /**\n   * Gets the sentences that are qualified as being too long.\n   *\n   * @param {array} sentences The sentences to filter through.\n   * @returns {array} Array with all the sentences considered to be too long.\n   */\n  getTooLongSentences(sentences) {\n    return getTooLongSentences(sentences, this._config.recommendedLength);\n  }\n\n  /**\n   * Get the total amount of sentences that are qualified as being too long.\n   *\n   * @param {Array} sentences The sentences to filter through.\n   * @returns {Number} The amount of sentences that are considered too long.\n   */\n  countTooLongSentences(sentences) {\n    return this.getTooLongSentences(sentences).length;\n  }\n}\n\nexport default SentenceLengthInTextAssessment;\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,MAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,QAAA,GAAAH,OAAA;AACA,IAAAI,WAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,yBAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,aAAA,GAAAJ,sBAAA,CAAAF,OAAA;AACA,IAAAO,QAAA,GAAAP,OAAA;AACA,IAAAQ,iBAAA,GAAAN,sBAAA,CAAAF,OAAA;AACA,IAAAS,aAAA,GAAAT,OAAA;AAAqD,SAAAE,uBAAAQ,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAErD;AACA;AACA;AACA,MAAMG,8BAA8B,SAASC,mBAAU,CAAC;EACtD;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAEEC,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAEC,aAAa,GAAG,KAAK,EAAEC,SAAS,GAAG,KAAK,EAAE;IACjE,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAE,oBAAoB;MACxBC,QAAQ,EAAE,MAAM;MAChBC,MAAM,EACJ,6FAA6F;MAC/FC,OAAO,EAAE,KAAK;MACdC,WAAW,EAAE,gBAAgB;MAC7BC,IAAI,EAAEC,2BAAa;MACnBC,iBAAiB,EAAE,EAAE;MACrBC,eAAe,EAAE,EAAE;MACnBC,UAAU,EAAE,EAAE;MACdC,KAAK,EAAE,sBAAsB;MAC7BC,OAAO,EAAE;QACPC,OAAO,EAAE,EAAE;QACXC,GAAG,EACD,6FAA6F;QAC/FC,IAAI,EAAE;MACR;IACF,CAAC;IAED,IAAI,CAACC,OAAO,GAAG,IAAAC,aAAK,EAACjB,aAAa,EAAEH,MAAM,CAAC;IAC3C,IAAI,CAACqB,UAAU,GAAG,oBAAoB;EACxC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,SAASA,CAAC;IAACC,KAAK;IAAEC,UAAU;IAAEC;EAAI,CAAC,EAAE;IACnC,MAAMC,SAAS,GAAGF,UAAU,CAACG,WAAW,CAAC,wBAAwB,CAAC;IAClE,IAAIH,UAAU,CAACI,SAAS,CAAC,gBAAgB,CAAC,EAAE;MAC1C,IAAI,CAACT,OAAO,GAAG,IAAI,CAACU,yBAAyB,CAACL,UAAU,CAAC;IAC3D;IAEA,MAAMM,UAAU,GAAG,IAAI,CAACC,mBAAmB,CAACL,SAAS,CAAC;IACtD,MAAMM,MAAM,GAAG,IAAI,CAACC,eAAe,CAACH,UAAU,EAAEL,IAAI,CAAC;IAErD,MAAMS,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAACnC,MAAM,EAAE,IAAI,CAACmB;IAAO,CAAC,CAAC;IAErEe,gBAAgB,CAACE,QAAQ,CAACJ,MAAM,CAACK,KAAK,CAAC;IACvCH,gBAAgB,CAACI,SAAS,CAACN,MAAM,CAACO,MAAM,CAAC;IACzCL,gBAAgB,CAACM,OAAO,CAACR,MAAM,CAACS,IAAI,CAAC;IAErC,OAAOP,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEQ,YAAYA,CAACnB,KAAK,EAAE;IAClB,OAAO,IAAI,CAACoB,6BAA6B,CAACpB,KAAK,CAAC;EAClD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEM,yBAAyBA,CAACL,UAAU,EAAE;IACpC,MAAMoB,aAAa,GAAG,IAAI,CAACzB,OAAO;IAClC,MAAM0B,sBAAsB,GAAGrB,UAAU,CAACI,SAAS,CAAC,gBAAgB,CAAC;IAErE,IAAIiB,sBAAsB,CAACC,cAAc,CAAC,mBAAmB,CAAC,EAAE;MAC9DF,aAAa,CAACjC,iBAAiB,GAAGkC,sBAAsB,CAAClC,iBAAiB;IAC5E;IAEA,OAAOiC,aAAa;EACtB;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEb,mBAAmBA,CAACL,SAAS,EAAE;IAC7B,IAAII,UAAU,GAAG,CAAC;IAElB,IAAIJ,SAAS,CAACqB,MAAM,KAAK,CAAC,EAAE;MAC1B,MAAMC,YAAY,GAAG,IAAI,CAACC,qBAAqB,CAACvB,SAAS,CAAC;MAE1DI,UAAU,GAAG,IAAAoB,qBAAY,EAAEF,YAAY,GAAGtB,SAAS,CAACqB,MAAM,GAAI,GAAG,CAAC;IACpE;IAEA,OAAOjB,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEG,eAAeA,CAACH,UAAU,EAAEL,IAAI,EAAE;IAChC,IAAIc,MAAM,GAAG,EAAE;IACf,IAAIT,UAAU,IAAI,IAAI,CAACX,OAAO,CAACR,iBAAiB,EAAE;MAChD4B,MAAM,GAAG,MAAM;IACjB;IAEA,IAAIT,UAAU,GAAG,IAAI,CAACX,OAAO,CAACR,iBAAiB,EAAE;MAC/C4B,MAAM,GAAG,KAAK;IAChB;IAEA,MAAMF,KAAK,GAAG,IAAI,CAACc,QAAQ,CAAC,IAAI,CAAChC,OAAO,CAACd,QAAQ,EAAEkC,MAAM,CAAC;IAE1D,IAAI,CAACpB,OAAO,CAACJ,OAAO,GAAG;MACrBC,OAAO,EAAE,EAAE;MACXC,GAAG,EAAE,qDAAqD,IAAI,CAACE,OAAO,CAACR,iBAAiB,yCAAyC;MACjIO,IAAI,EAAE,2DAA2D,IAAI,CAACC,OAAO,CAACR,iBAAiB;IACjG,CAAC;IAED,OAAO;MACL0B,KAAK;MACLE,MAAM;MACNE,IAAI,eACFxD,MAAA,CAAAW,OAAA,CAAAwD,aAAA,CAACjE,QAAA,CAAAkE,IAAI;QAACC,EAAE,EAAE;MAAO,GACd,IAAI,CAACnC,OAAO,CAACJ,OAAO,CAACwB,MAAM,CAAC,EAAE,GAAG,EACjC,IAAI,CAACpB,OAAO,CAACb,MAAM,iBAClBrB,MAAA,CAAAW,OAAA,CAAAwD,aAAA;QAAGG,IAAI,EAAE,IAAI,CAACpC,OAAO,CAACb,MAAO;QAACkD,MAAM,EAAC,QAAQ;QAACC,GAAG,EAAC;MAAY,GAAC,YAE5D,CAED;IAEV,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,mBAAmBA,CAAChC,SAAS,EAAE;IAC7B,OAAO,IAAAgC,iCAAmB,EAAChC,SAAS,EAAE,IAAI,CAACP,OAAO,CAACR,iBAAiB,CAAC;EACvE;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEsC,qBAAqBA,CAACvB,SAAS,EAAE;IAC/B,OAAO,IAAI,CAACgC,mBAAmB,CAAChC,SAAS,CAAC,CAACqB,MAAM;EACnD;AACF;AAAC,IAAAY,QAAA,GAAAC,OAAA,CAAAhE,OAAA,GAEcC,8BAA8B","ignoreList":[]}

package/build/scoring/assessments/readability/TransitionWordsAssessment.js

@@ -0,0 +1,163 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _react = _interopRequireDefault(require("react"));
+var _polaris = require("@shopify/polaris");
+var _formatNumber = _interopRequireDefault(require("../../../helpers/formatNumber"));
+var _inRange = require("../../helpers/assessments/inRange");
+var _AssessmentResult = _interopRequireDefault(require("../../../values/AssessmentResult"));
+var _assessment = _interopRequireDefault(require("../assessment"));
+var _htmlParser = _interopRequireDefault(require("../../../languageProcessing/helpers/html/htmlParser"));
+var _getWords = _interopRequireDefault(require("../../../languageProcessing/helpers/word/getWords"));
+var _helpers = require("../../../languageProcessing/helpers");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Represents the assessment that checks whether there are enough transition words in the text.
+ */
+class TransitionWordsAssessment extends _assessment.default {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {object} config The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: 'textTransitionWords',
+      fixPosition: 'longestParagraph',
+      ctaType: 'fix',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#use-of-transition-words',
+      priority: 'low',
+      applicableIfTextLongerThan: 200,
+      title: 'Use of transition words',
+      content: {
+        good: 'Transition words are used effectively.',
+        bad: 'Lack of transition words. Improve readability and flow by adding words like "however," "also," etc.',
+        improve: ''
+      }
+    };
+    this.identifier = 'textTransitionWords';
+    this._config = (0, _lodash.merge)(defaultConfig, config);
+  }
+
+  /**
+   * Calculates the actual percentage of transition words in the sentences.
+   *
+   * @param {object} sentences The object containing the total number of sentences and the number of sentences containing
+   * a transition word.
+   *
+   * @returns {number} The percentage of sentences containing a transition word.
+   */
+  calculateTransitionWordPercentage(sentences) {
+    if (sentences.transitionWordSentences === 0 || sentences.totalSentences === 0) {
+      return 0;
+    }
+    return (0, _formatNumber.default)(sentences.transitionWordSentences / sentences.totalSentences * 100);
+  }
+
+  /**
+   * Calculates the score for the assessment based on the percentage of sentences containing transition words.
+   *
+   * @param {number} percentage The percentage of sentences containing transition words.
+   *
+   * @returns {number} The score.
+   */
+  calculateScoreFromPercentage(percentage) {
+    if (percentage < 20) {
+      // Red indicator.
+      return 3;
+    }
+    if ((0, _inRange.inRangeStartInclusive)(percentage, 20, 30)) {
+      // Orange indicator.
+      return 6;
+    }
+
+    // Green indicator.
+    return 9;
+  }
+
+  /**
+   *
+   * @param transitionWordSentences
+   * @param i18n
+   * @returns {{score: number, body: React.JSX.Element, status: string}}
+   */
+  calculateTransitionWordResult(transitionWordSentences, i18n) {
+    const percentage = this.calculateTransitionWordPercentage(transitionWordSentences);
+    const score = this.calculateScoreFromPercentage(percentage);
+    let status = 'good';
+    if (score < 7 && percentage === 0) {
+      status = 'bad';
+    }
+    if (score < 7) {
+      status = 'bad';
+    }
+    const customScore = this.getScore(this._config.priority, status);
+    return {
+      score: customScore,
+      status,
+      body: /*#__PURE__*/_react.default.createElement(_polaris.Text, {
+        as: 'span'
+      }, this._config.content[status], ' ', this._config.docUrl && /*#__PURE__*/_react.default.createElement("a", {
+        href: this._config.docUrl,
+        target: "_blank",
+        rel: "noreferrer"
+      }, "Learn more"))
+    };
+  }
+
+  /**
+   *
+   * @param paper
+   * @param researcher
+   * @param i18n
+   * @returns {AssessmentResult}
+   */
+  getResult({
+    paper,
+    researcher,
+    i18n
+  }) {
+    const transitionWordSentences = researcher.getResearch('findTransitionWords');
+    const transitionWordResult = this.calculateTransitionWordResult(transitionWordSentences, i18n);
+    const assessmentResult = new _AssessmentResult.default({
+      config: this._config
+    });
+    assessmentResult.setScore(transitionWordResult.score);
+    assessmentResult.setStatus(transitionWordResult.status);
+    assessmentResult.setBody(transitionWordResult.body);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks if the transition words assessment is applicable to the paper. Language-specific length requirements and methods of counting text length
+   * may apply (e.g. for Japanese, the text should be counted in characters instead of words, which also makes the minimum required length higher).
+   *
+   * @param {Paper}       paper       The paper to check.
+   * @param {Researcher}  researcher  The researcher object.
+   *
+   * @returns {boolean} Returns true if the language is available, the paper is not empty and the text is longer than the minimum required length.
+   */
+  isApplicable(paper, researcher) {
+    const customCountLength = researcher.getHelper('customCountLength');
+    const customApplicabilityConfig = researcher.getConfig('assessmentApplicability').transitionWords;
+    if (customApplicabilityConfig) {
+      this._config.applicableIfTextLongerThan = customApplicabilityConfig;
+    }
+    let text = paper.getText();
+    text = (0, _htmlParser.default)(text);
+    text = (0, _helpers.filterShortcodesFromHTML)(text, paper._attributes && paper._attributes.shortcodes);
+    const textLength = customCountLength ? customCountLength(text) : (0, _getWords.default)(text).length;
+
+    // Do not use hasEnoughContent in this assessment as it is mostly redundant with `textLength >= this._config.applicableIfTextLongerThan`
+    return textLength >= this._config.applicableIfTextLongerThan && researcher.hasResearch('findTransitionWords');
+  }
+}
+exports.default = TransitionWordsAssessment;
+//# sourceMappingURL=TransitionWordsAssessment.js.map

package/build/scoring/assessments/readability/TransitionWordsAssessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransitionWordsAssessment.js","names":["_lodash","require","_react","_interopRequireDefault","_polaris","_formatNumber","_inRange","_AssessmentResult","_assessment","_htmlParser","_getWords","_helpers","e","__esModule","default","TransitionWordsAssessment","Assessment","constructor","config","defaultConfig","id","fixPosition","ctaType","docUrl","priority","applicableIfTextLongerThan","title","content","good","bad","improve","identifier","_config","merge","calculateTransitionWordPercentage","sentences","transitionWordSentences","totalSentences","formatNumber","calculateScoreFromPercentage","percentage","inRange","calculateTransitionWordResult","i18n","score","status","customScore","getScore","body","createElement","Text","as","href","target","rel","getResult","paper","researcher","getResearch","transitionWordResult","assessmentResult","AssessmentResult","setScore","setStatus","setBody","isApplicable","customCountLength","getHelper","customApplicabilityConfig","getConfig","transitionWords","text","getText","removeHtmlBlocks","filterShortcodesFromHTML","_attributes","shortcodes","textLength","getWords","length","hasResearch","exports"],"sources":["../../../../src/scoring/assessments/readability/TransitionWordsAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport React from 'react';\nimport {Text} from '@shopify/polaris';\n\nimport formatNumber from '../../../helpers/formatNumber';\nimport {inRangeStartInclusive as inRange} from '../../helpers/assessments/inRange';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\nimport removeHtmlBlocks from '@axyseo/languageProcessing/helpers/html/htmlParser';\nimport getWords from '@axyseo/languageProcessing/helpers/word/getWords';\nimport {filterShortcodesFromHTML} from '@axyseo/languageProcessing/helpers';\n\n/**\n * Represents the assessment that checks whether there are enough transition words in the text.\n */\nexport default class TransitionWordsAssessment extends Assessment {\n  /**\n   * Sets the identifier and the config.\n   *\n   * @param {object} config The configuration to use.\n   *\n   * @returns {void}\n   */\n  constructor(config = {}) {\n    super();\n\n    const defaultConfig = {\n      id: 'textTransitionWords',\n      fixPosition: 'longestParagraph',\n      ctaType: 'fix',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#use-of-transition-words',\n      priority: 'low',\n      applicableIfTextLongerThan: 200,\n      title: 'Use of transition words',\n      content: {\n        good: 'Transition words are used effectively.',\n        bad:\n          'Lack of transition words. Improve readability and flow by adding words like \"however,\" \"also,\" etc.',\n        improve: ''\n      }\n    };\n\n    this.identifier = 'textTransitionWords';\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Calculates the actual percentage of transition words in the sentences.\n   *\n   * @param {object} sentences The object containing the total number of sentences and the number of sentences containing\n   * a transition word.\n   *\n   * @returns {number} The percentage of sentences containing a transition word.\n   */\n  calculateTransitionWordPercentage(sentences) {\n    if (sentences.transitionWordSentences === 0 || sentences.totalSentences === 0) {\n      return 0;\n    }\n\n    return formatNumber((sentences.transitionWordSentences / sentences.totalSentences) * 100);\n  }\n\n  /**\n   * Calculates the score for the assessment based on the percentage of sentences containing transition words.\n   *\n   * @param {number} percentage The percentage of sentences containing transition words.\n   *\n   * @returns {number} The score.\n   */\n  calculateScoreFromPercentage(percentage) {\n    if (percentage < 20) {\n      // Red indicator.\n      return 3;\n    }\n\n    if (inRange(percentage, 20, 30)) {\n      // Orange indicator.\n      return 6;\n    }\n\n    // Green indicator.\n    return 9;\n  }\n\n  /**\n   *\n   * @param transitionWordSentences\n   * @param i18n\n   * @returns {{score: number, body: React.JSX.Element, status: string}}\n   */\n  calculateTransitionWordResult(transitionWordSentences, i18n) {\n    const percentage = this.calculateTransitionWordPercentage(transitionWordSentences);\n    const score = this.calculateScoreFromPercentage(percentage);\n\n    let status = 'good';\n    if (score < 7 && percentage === 0) {\n      status = 'bad';\n    }\n\n    if (score < 7) {\n      status = 'bad';\n    }\n    const customScore = this.getScore(this._config.priority, status);\n\n    return {\n      score: customScore,\n      status,\n      body: (\n        <Text as={'span'}>\n          {this._config.content[status]}{' '}\n          {this._config.docUrl && (\n            <a href={this._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n              Learn more\n            </a>\n          )}\n        </Text>\n      )\n    };\n  }\n\n  /**\n   *\n   * @param paper\n   * @param researcher\n   * @param i18n\n   * @returns {AssessmentResult}\n   */\n  getResult({paper, researcher, i18n}) {\n    const transitionWordSentences = researcher.getResearch('findTransitionWords');\n    const transitionWordResult = this.calculateTransitionWordResult(transitionWordSentences, i18n);\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(transitionWordResult.score);\n    assessmentResult.setStatus(transitionWordResult.status);\n    assessmentResult.setBody(transitionWordResult.body);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks if the transition words assessment is applicable to the paper. Language-specific length requirements and methods of counting text length\n   * may apply (e.g. for Japanese, the text should be counted in characters instead of words, which also makes the minimum required length higher).\n   *\n   * @param {Paper}       paper       The paper to check.\n   * @param {Researcher}  researcher  The researcher object.\n   *\n   * @returns {boolean} Returns true if the language is available, the paper is not empty and the text is longer than the minimum required length.\n   */\n  isApplicable(paper, researcher) {\n    const customCountLength = researcher.getHelper('customCountLength');\n    const customApplicabilityConfig = researcher.getConfig('assessmentApplicability')\n      .transitionWords;\n    if (customApplicabilityConfig) {\n      this._config.applicableIfTextLongerThan = customApplicabilityConfig;\n    }\n    let text = paper.getText();\n    text = removeHtmlBlocks(text);\n    text = filterShortcodesFromHTML(text, paper._attributes && paper._attributes.shortcodes);\n    const textLength = customCountLength ? customCountLength(text) : getWords(text).length;\n\n    // Do not use hasEnoughContent in this assessment as it is mostly redundant with `textLength >= this._config.applicableIfTextLongerThan`\n    return (\n      textLength >= this._config.applicableIfTextLongerThan &&\n      researcher.hasResearch('findTransitionWords')\n    );\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,MAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,QAAA,GAAAH,OAAA;AAEA,IAAAI,aAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,QAAA,GAAAL,OAAA;AACA,IAAAM,iBAAA,GAAAJ,sBAAA,CAAAF,OAAA;AACA,IAAAO,WAAA,GAAAL,sBAAA,CAAAF,OAAA;AACA,IAAAQ,WAAA,GAAAN,sBAAA,CAAAF,OAAA;AACA,IAAAS,SAAA,GAAAP,sBAAA,CAAAF,OAAA;AACA,IAAAU,QAAA,GAAAV,OAAA;AAA4E,SAAAE,uBAAAS,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE5E;AACA;AACA;AACe,MAAMG,yBAAyB,SAASC,mBAAU,CAAC;EAChE;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAE,qBAAqB;MACzBC,WAAW,EAAE,kBAAkB;MAC/BC,OAAO,EAAE,KAAK;MACdC,MAAM,EACJ,qGAAqG;MACvGC,QAAQ,EAAE,KAAK;MACfC,0BAA0B,EAAE,GAAG;MAC/BC,KAAK,EAAE,yBAAyB;MAChCC,OAAO,EAAE;QACPC,IAAI,EAAE,wCAAwC;QAC9CC,GAAG,EACD,qGAAqG;QACvGC,OAAO,EAAE;MACX;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAG,qBAAqB;IACvC,IAAI,CAACC,OAAO,GAAG,IAAAC,aAAK,EAACd,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEgB,iCAAiCA,CAACC,SAAS,EAAE;IAC3C,IAAIA,SAAS,CAACC,uBAAuB,KAAK,CAAC,IAAID,SAAS,CAACE,cAAc,KAAK,CAAC,EAAE;MAC7E,OAAO,CAAC;IACV;IAEA,OAAO,IAAAC,qBAAY,EAAEH,SAAS,CAACC,uBAAuB,GAAGD,SAAS,CAACE,cAAc,GAAI,GAAG,CAAC;EAC3F;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEE,4BAA4BA,CAACC,UAAU,EAAE;IACvC,IAAIA,UAAU,GAAG,EAAE,EAAE;MACnB;MACA,OAAO,CAAC;IACV;IAEA,IAAI,IAAAC,8BAAO,EAACD,UAAU,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE;MAC/B;MACA,OAAO,CAAC;IACV;;IAEA;IACA,OAAO,CAAC;EACV;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEE,6BAA6BA,CAACN,uBAAuB,EAAEO,IAAI,EAAE;IAC3D,MAAMH,UAAU,GAAG,IAAI,CAACN,iCAAiC,CAACE,uBAAuB,CAAC;IAClF,MAAMQ,KAAK,GAAG,IAAI,CAACL,4BAA4B,CAACC,UAAU,CAAC;IAE3D,IAAIK,MAAM,GAAG,MAAM;IACnB,IAAID,KAAK,GAAG,CAAC,IAAIJ,UAAU,KAAK,CAAC,EAAE;MACjCK,MAAM,GAAG,KAAK;IAChB;IAEA,IAAID,KAAK,GAAG,CAAC,EAAE;MACbC,MAAM,GAAG,KAAK;IAChB;IACA,MAAMC,WAAW,GAAG,IAAI,CAACC,QAAQ,CAAC,IAAI,CAACf,OAAO,CAACR,QAAQ,EAAEqB,MAAM,CAAC;IAEhE,OAAO;MACLD,KAAK,EAAEE,WAAW;MAClBD,MAAM;MACNG,IAAI,eACF9C,MAAA,CAAAY,OAAA,CAAAmC,aAAA,CAAC7C,QAAA,CAAA8C,IAAI;QAACC,EAAE,EAAE;MAAO,GACd,IAAI,CAACnB,OAAO,CAACL,OAAO,CAACkB,MAAM,CAAC,EAAE,GAAG,EACjC,IAAI,CAACb,OAAO,CAACT,MAAM,iBAClBrB,MAAA,CAAAY,OAAA,CAAAmC,aAAA;QAAGG,IAAI,EAAE,IAAI,CAACpB,OAAO,CAACT,MAAO;QAAC8B,MAAM,EAAC,QAAQ;QAACC,GAAG,EAAC;MAAY,GAAC,YAE5D,CAED;IAEV,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,SAASA,CAAC;IAACC,KAAK;IAAEC,UAAU;IAAEd;EAAI,CAAC,EAAE;IACnC,MAAMP,uBAAuB,GAAGqB,UAAU,CAACC,WAAW,CAAC,qBAAqB,CAAC;IAC7E,MAAMC,oBAAoB,GAAG,IAAI,CAACjB,6BAA6B,CAACN,uBAAuB,EAAEO,IAAI,CAAC;IAC9F,MAAMiB,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAAC3C,MAAM,EAAE,IAAI,CAACc;IAAO,CAAC,CAAC;IAErE4B,gBAAgB,CAACE,QAAQ,CAACH,oBAAoB,CAACf,KAAK,CAAC;IACrDgB,gBAAgB,CAACG,SAAS,CAACJ,oBAAoB,CAACd,MAAM,CAAC;IACvDe,gBAAgB,CAACI,OAAO,CAACL,oBAAoB,CAACX,IAAI,CAAC;IAEnD,OAAOY,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEK,YAAYA,CAACT,KAAK,EAAEC,UAAU,EAAE;IAC9B,MAAMS,iBAAiB,GAAGT,UAAU,CAACU,SAAS,CAAC,mBAAmB,CAAC;IACnE,MAAMC,yBAAyB,GAAGX,UAAU,CAACY,SAAS,CAAC,yBAAyB,CAAC,CAC9EC,eAAe;IAClB,IAAIF,yBAAyB,EAAE;MAC7B,IAAI,CAACpC,OAAO,CAACP,0BAA0B,GAAG2C,yBAAyB;IACrE;IACA,IAAIG,IAAI,GAAGf,KAAK,CAACgB,OAAO,CAAC,CAAC;IAC1BD,IAAI,GAAG,IAAAE,mBAAgB,EAACF,IAAI,CAAC;IAC7BA,IAAI,GAAG,IAAAG,iCAAwB,EAACH,IAAI,EAAEf,KAAK,CAACmB,WAAW,IAAInB,KAAK,CAACmB,WAAW,CAACC,UAAU,CAAC;IACxF,MAAMC,UAAU,GAAGX,iBAAiB,GAAGA,iBAAiB,CAACK,IAAI,CAAC,GAAG,IAAAO,iBAAQ,EAACP,IAAI,CAAC,CAACQ,MAAM;;IAEtF;IACA,OACEF,UAAU,IAAI,IAAI,CAAC7C,OAAO,CAACP,0BAA0B,IACrDgC,UAAU,CAACuB,WAAW,CAAC,qBAAqB,CAAC;EAEjD;AACF;AAACC,OAAA,CAAAnE,OAAA,GAAAC,yBAAA","ignoreList":[]}

package/build/scoring/assessments/seo/ImageCountAssessment.js

@@ -0,0 +1,111 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _polaris = require("@shopify/polaris");
+var _lodash = require("lodash");
+var _assessment = _interopRequireDefault(require("../assessment"));
+var _AssessmentResult = _interopRequireDefault(require("../../../values/AssessmentResult"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Represents the assessment that checks if the text has any images present, including videos in product pages.
+ */
+class TextImagesAssessment extends _assessment.default {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {object}  config      The configuration to use.
+   * @param {boolean} countVideos Whether videos are also included in the assessment or not.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}, countVideos = true) {
+    super();
+    const defaultConfig = {
+      id: 'images',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#images-and-videos',
+      priority: 'high',
+      fixPosition: 'description',
+      title: 'Media',
+      content: {
+        good: 'Media are used effectively.',
+        improve: '',
+        bad: 'No media found. Add visual content to enhance engagement.'
+      }
+    };
+    this.identifier = 'images';
+    this._config = (0, _lodash.merge)(defaultConfig, config);
+    this._countVideos = countVideos;
+  }
+
+  /**
+   * Execute the Assessment and return a result.
+   *
+   * @param {Paper}       paper       The Paper object to assess.
+   * @param {Researcher}  researcher  The Researcher object containing all available researches.
+   *
+   * @param i18n
+   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.
+   */
+  getResult({
+    paper,
+    researcher,
+    i18n
+  }) {
+    this.imageCount = researcher.getResearch('imageCount');
+    this.videoCount = researcher.getResearch('videoCount');
+    const assessmentResult = new _AssessmentResult.default({
+      config: this._config
+    });
+    const calculatedResult = this.calculateResult(i18n);
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setBody(calculatedResult.body);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks whether the paper has text.
+   *
+   * @param {Paper}       paper       The paper to use for the assessment.
+   *
+   * @returns {boolean} True when there is text.
+   */
+  isApplicable(paper) {
+    return paper.hasText();
+  }
+
+  /**
+   * Calculate the result based on the availability of images in the text, including videos in product pages.
+   *
+   * @returns {Object} The calculated result.
+   */
+  calculateResult(i18n) {
+    // If "countVideos" is on, we include videos in the assessment
+    const mediaCount = this._countVideos ? this.imageCount + this.videoCount : this.imageCount;
+    let status = '';
+    // No images.
+    if (mediaCount === 0) {
+      status = 'bad';
+    } else {
+      status = 'good';
+    }
+    const score = this.getScore(this._config.priority, status);
+    return {
+      score,
+      status,
+      body: /*#__PURE__*/_react.default.createElement(_polaris.Text, {
+        as: 'span'
+      }, this._config.content[status], ' ', this._config.docUrl && /*#__PURE__*/_react.default.createElement("a", {
+        href: this._config.docUrl,
+        target: "_blank",
+        rel: "noreferrer"
+      }, "Learn more"))
+    };
+  }
+}
+exports.default = TextImagesAssessment;
+//# sourceMappingURL=ImageCountAssessment.js.map

package/build/scoring/assessments/seo/ImageCountAssessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ImageCountAssessment.js","names":["_react","_interopRequireDefault","require","_polaris","_lodash","_assessment","_AssessmentResult","e","__esModule","default","TextImagesAssessment","Assessment","constructor","config","countVideos","defaultConfig","id","docUrl","priority","fixPosition","title","content","good","improve","bad","identifier","_config","merge","_countVideos","getResult","paper","researcher","i18n","imageCount","getResearch","videoCount","assessmentResult","AssessmentResult","calculatedResult","calculateResult","setScore","score","setStatus","status","setBody","body","isApplicable","hasText","mediaCount","getScore","createElement","Text","as","href","target","rel","exports"],"sources":["../../../../src/scoring/assessments/seo/ImageCountAssessment.js"],"sourcesContent":["import React from 'react';\nimport {Text} from '@shopify/polaris';\n\nimport {merge} from 'lodash';\n\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\n\n/**\n * Represents the assessment that checks if the text has any images present, including videos in product pages.\n */\nexport default class TextImagesAssessment extends Assessment {\n  /**\n   * Sets the identifier and the config.\n   *\n   * @param {object}  config      The configuration to use.\n   * @param {boolean} countVideos Whether videos are also included in the assessment or not.\n   *\n   * @returns {void}\n   */\n  constructor(config = {}, countVideos = true) {\n    super();\n\n    const defaultConfig = {\n      id: 'images',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#images-and-videos',\n      priority: 'high',\n      fixPosition: 'description',\n      title: 'Media',\n      content: {\n        good: 'Media are used effectively.',\n        improve: '',\n        bad: 'No media found. Add visual content to enhance engagement.'\n      }\n    };\n\n    this.identifier = 'images';\n    this._config = merge(defaultConfig, config);\n    this._countVideos = countVideos;\n  }\n\n  /**\n   * Execute the Assessment and return a result.\n   *\n   * @param {Paper}       paper       The Paper object to assess.\n   * @param {Researcher}  researcher  The Researcher object containing all available researches.\n   *\n   * @param i18n\n   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.\n   */\n  getResult({paper, researcher, i18n}) {\n    this.imageCount = researcher.getResearch('imageCount');\n    this.videoCount = researcher.getResearch('videoCount');\n\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    const calculatedResult = this.calculateResult(i18n);\n\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n    assessmentResult.setBody(calculatedResult.body);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks whether the paper has text.\n   *\n   * @param {Paper}       paper       The paper to use for the assessment.\n   *\n   * @returns {boolean} True when there is text.\n   */\n  isApplicable(paper) {\n    return paper.hasText();\n  }\n\n  /**\n   * Calculate the result based on the availability of images in the text, including videos in product pages.\n   *\n   * @returns {Object} The calculated result.\n   */\n  calculateResult(i18n) {\n    // If \"countVideos\" is on, we include videos in the assessment\n    const mediaCount = this._countVideos ? this.imageCount + this.videoCount : this.imageCount;\n\n    let status = '';\n    // No images.\n    if (mediaCount === 0) {\n      status = 'bad';\n    } else {\n      status = 'good';\n    }\n\n    const score = this.getScore(this._config.priority, status);\n\n    return {\n      score,\n      status,\n      body: (\n        <Text as={'span'}>\n          {this._config.content[status]}{' '}\n          {this._config.docUrl && (\n            <a href={this._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n              Learn more\n            </a>\n          )}\n        </Text>\n      )\n    };\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,QAAA,GAAAD,OAAA;AAEA,IAAAE,OAAA,GAAAF,OAAA;AAEA,IAAAG,WAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,iBAAA,GAAAL,sBAAA,CAAAC,OAAA;AAAgE,SAAAD,uBAAAM,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEhE;AACA;AACA;AACe,MAAMG,oBAAoB,SAASC,mBAAU,CAAC;EAC3D;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAEC,WAAW,GAAG,IAAI,EAAE;IAC3C,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAE,QAAQ;MACZC,MAAM,EACJ,+FAA+F;MACjGC,QAAQ,EAAE,MAAM;MAChBC,WAAW,EAAE,aAAa;MAC1BC,KAAK,EAAE,OAAO;MACdC,OAAO,EAAE;QACPC,IAAI,EAAE,6BAA6B;QACnCC,OAAO,EAAE,EAAE;QACXC,GAAG,EAAE;MACP;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAG,QAAQ;IAC1B,IAAI,CAACC,OAAO,GAAG,IAAAC,aAAK,EAACZ,aAAa,EAAEF,MAAM,CAAC;IAC3C,IAAI,CAACe,YAAY,GAAGd,WAAW;EACjC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEe,SAASA,CAAC;IAACC,KAAK;IAAEC,UAAU;IAAEC;EAAI,CAAC,EAAE;IACnC,IAAI,CAACC,UAAU,GAAGF,UAAU,CAACG,WAAW,CAAC,YAAY,CAAC;IACtD,IAAI,CAACC,UAAU,GAAGJ,UAAU,CAACG,WAAW,CAAC,YAAY,CAAC;IAEtD,MAAME,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAACxB,MAAM,EAAE,IAAI,CAACa;IAAO,CAAC,CAAC;IAErE,MAAMY,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACP,IAAI,CAAC;IAEnDI,gBAAgB,CAACI,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDL,gBAAgB,CAACM,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IACnDP,gBAAgB,CAACQ,OAAO,CAACN,gBAAgB,CAACO,IAAI,CAAC;IAE/C,OAAOT,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEU,YAAYA,CAAChB,KAAK,EAAE;IAClB,OAAOA,KAAK,CAACiB,OAAO,CAAC,CAAC;EACxB;;EAEA;AACF;AACA;AACA;AACA;EACER,eAAeA,CAACP,IAAI,EAAE;IACpB;IACA,MAAMgB,UAAU,GAAG,IAAI,CAACpB,YAAY,GAAG,IAAI,CAACK,UAAU,GAAG,IAAI,CAACE,UAAU,GAAG,IAAI,CAACF,UAAU;IAE1F,IAAIU,MAAM,GAAG,EAAE;IACf;IACA,IAAIK,UAAU,KAAK,CAAC,EAAE;MACpBL,MAAM,GAAG,KAAK;IAChB,CAAC,MAAM;MACLA,MAAM,GAAG,MAAM;IACjB;IAEA,MAAMF,KAAK,GAAG,IAAI,CAACQ,QAAQ,CAAC,IAAI,CAACvB,OAAO,CAACR,QAAQ,EAAEyB,MAAM,CAAC;IAE1D,OAAO;MACLF,KAAK;MACLE,MAAM;MACNE,IAAI,eACF7C,MAAA,CAAAS,OAAA,CAAAyC,aAAA,CAAC/C,QAAA,CAAAgD,IAAI;QAACC,EAAE,EAAE;MAAO,GACd,IAAI,CAAC1B,OAAO,CAACL,OAAO,CAACsB,MAAM,CAAC,EAAE,GAAG,EACjC,IAAI,CAACjB,OAAO,CAACT,MAAM,iBAClBjB,MAAA,CAAAS,OAAA,CAAAyC,aAAA;QAAGG,IAAI,EAAE,IAAI,CAAC3B,OAAO,CAACT,MAAO;QAACqC,MAAM,EAAC,QAAQ;QAACC,GAAG,EAAC;MAAY,GAAC,YAE5D,CAED;IAEV,CAAC;EACH;AACF;AAACC,OAAA,CAAA/C,OAAA,GAAAC,oBAAA","ignoreList":[]}

package/build/scoring/assessments/seo/InternalLinksAssessment.js

@@ -0,0 +1,112 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _react = _interopRequireDefault(require("react"));
+var _polaris = require("@shopify/polaris");
+var _assessment = _interopRequireDefault(require("../assessment"));
+var _AssessmentResult = _interopRequireDefault(require("../../../values/AssessmentResult"));
+var _polarisIcons = require("@shopify/polaris-icons");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Assessment to check whether the text has internal links and whether they are followed or no-followed.
+ */
+class InternalLinksAssessment extends _assessment.default {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} [config] The configuration to use.
+   * @param {number} [config.parameters.recommendedMinimum] The recommended minimum number of internal links in the text.
+   * @param {number} [config.scores.allInternalFollow] The score to return if all internal links are do-follow.
+   * @param {number} [config.scores.someInternalFollow] The score to return if some but not all internal links are do-follow.
+   * @param {number} [config.scores.noneInternalFollow] The score to return if all internal links are no-follow.
+   * @param {number} [config.scores.noInternal] The score to return if there are no internal links.
+   * @param {string} [config.url] The URL to the relevant KB article.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: 'internalLinks',
+      fixPosition: '',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#internal-links-outbound-links',
+      icon: _polarisIcons.LinkIcon,
+      priority: 'high',
+      title: 'Internal links',
+      content: {
+        good: 'Internal links are used effectively.',
+        improve: '',
+        bad: 'No internal links found. Add links to other relevant pages on your website.'
+      }
+    };
+    this.identifier = 'internalLinks';
+    this._config = (0, _lodash.merge)(defaultConfig, config);
+  }
+
+  /**
+   * Runs the getLinkStatistics module, based on this returns an assessment result with score.
+   *
+   * @param {Paper} paper The paper to use for the assessment.
+   * @param {Researcher} researcher The researcher used for calling research.
+   * @param i18n
+   * @returns {AssessmentResult} The result of the assessment.
+   */
+  getResult({
+    paper,
+    researcher,
+    i18n
+  }) {
+    this.linkStatistics = researcher.getResearch('getLinkStatistics');
+    const assessmentResult = new _AssessmentResult.default({
+      config: this._config
+    });
+    const calculatedResult = this.calculateResult(i18n);
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setBody(calculatedResult.body);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks if assessment is applicable to the paper.
+   *
+   * @param {Paper} paper The paper to be analyzed.
+   *
+   * @returns {boolean} Whether the paper has text.
+   */
+  isApplicable(paper) {
+    return paper.hasText();
+  }
+
+  /**
+   * Returns a score and text based on the linkStatistics object.
+   *
+   * @returns {Object} ResultObject with score and text
+   */
+  calculateResult(i18n) {
+    let status = '';
+    if (this.linkStatistics.internalTotal === 0 || this.linkStatistics.internalNofollow === this.linkStatistics.internalTotal) {
+      status = 'bad';
+    } else {
+      status = 'good';
+    }
+    const score = this.getScore(this._config.priority, status);
+    return {
+      score,
+      status,
+      body: /*#__PURE__*/_react.default.createElement(_polaris.Text, {
+        as: 'span'
+      }, this._config.content[status], ' ', this._config.docUrl && /*#__PURE__*/_react.default.createElement("a", {
+        href: this._config.docUrl,
+        target: "_blank",
+        rel: "noreferrer"
+      }, "Learn more"))
+    };
+  }
+}
+var _default = exports.default = InternalLinksAssessment;
+//# sourceMappingURL=InternalLinksAssessment.js.map

package/build/scoring/assessments/seo/InternalLinksAssessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InternalLinksAssessment.js","names":["_lodash","require","_react","_interopRequireDefault","_polaris","_assessment","_AssessmentResult","_polarisIcons","e","__esModule","default","InternalLinksAssessment","Assessment","constructor","config","defaultConfig","id","fixPosition","docUrl","icon","LinkIcon","priority","title","content","good","improve","bad","identifier","_config","merge","getResult","paper","researcher","i18n","linkStatistics","getResearch","assessmentResult","AssessmentResult","calculatedResult","calculateResult","setScore","score","setStatus","status","setBody","body","isApplicable","hasText","internalTotal","internalNofollow","getScore","createElement","Text","as","href","target","rel","_default","exports"],"sources":["../../../../src/scoring/assessments/seo/InternalLinksAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport React from 'react';\nimport {Text} from '@shopify/polaris';\n\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {LinkIcon} from '@shopify/polaris-icons';\n\n/**\n * Assessment to check whether the text has internal links and whether they are followed or no-followed.\n */\nclass InternalLinksAssessment extends Assessment {\n  /**\n   * Sets the identifier and the config.\n   *\n   * @param {Object} [config] The configuration to use.\n   * @param {number} [config.parameters.recommendedMinimum] The recommended minimum number of internal links in the text.\n   * @param {number} [config.scores.allInternalFollow] The score to return if all internal links are do-follow.\n   * @param {number} [config.scores.someInternalFollow] The score to return if some but not all internal links are do-follow.\n   * @param {number} [config.scores.noneInternalFollow] The score to return if all internal links are no-follow.\n   * @param {number} [config.scores.noInternal] The score to return if there are no internal links.\n   * @param {string} [config.url] The URL to the relevant KB article.\n   *\n   * @returns {void}\n   */\n  constructor(config = {}) {\n    super();\n\n    const defaultConfig = {\n      id: 'internalLinks',\n      fixPosition: '',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#internal-links-outbound-links',\n      icon: LinkIcon,\n      priority: 'high',\n      title: 'Internal links',\n      content: {\n        good: 'Internal links are used effectively.',\n        improve: '',\n        bad: 'No internal links found. Add links to other relevant pages on your website.'\n      }\n    };\n\n    this.identifier = 'internalLinks';\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Runs the getLinkStatistics module, based on this returns an assessment result with score.\n   *\n   * @param {Paper} paper The paper to use for the assessment.\n   * @param {Researcher} researcher The researcher used for calling research.\n   * @param i18n\n   * @returns {AssessmentResult} The result of the assessment.\n   */\n  getResult({paper, researcher, i18n}) {\n    this.linkStatistics = researcher.getResearch('getLinkStatistics');\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    const calculatedResult = this.calculateResult(i18n);\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n    assessmentResult.setBody(calculatedResult.body);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks if assessment is applicable to the paper.\n   *\n   * @param {Paper} paper The paper to be analyzed.\n   *\n   * @returns {boolean} Whether the paper has text.\n   */\n  isApplicable(paper) {\n    return paper.hasText();\n  }\n\n  /**\n   * Returns a score and text based on the linkStatistics object.\n   *\n   * @returns {Object} ResultObject with score and text\n   */\n  calculateResult(i18n) {\n    let status = '';\n    if (\n      this.linkStatistics.internalTotal === 0 ||\n      this.linkStatistics.internalNofollow === this.linkStatistics.internalTotal\n    ) {\n      status = 'bad';\n    } else {\n      status = 'good';\n    }\n\n    const score = this.getScore(this._config.priority, status);\n\n    return {\n      score,\n      status,\n      body: (\n        <Text as={'span'}>\n          {this._config.content[status]}{' '}\n          {this._config.docUrl && (\n            <a href={this._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n              Learn more\n            </a>\n          )}\n        </Text>\n      )\n    };\n  }\n}\n\nexport default InternalLinksAssessment;\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,MAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,QAAA,GAAAH,OAAA;AAEA,IAAAI,WAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,iBAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,aAAA,GAAAN,OAAA;AAAgD,SAAAE,uBAAAK,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEhD;AACA;AACA;AACA,MAAMG,uBAAuB,SAASC,mBAAU,CAAC;EAC/C;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAE,eAAe;MACnBC,WAAW,EAAE,EAAE;MACfC,MAAM,EACJ,2GAA2G;MAC7GC,IAAI,EAAEC,sBAAQ;MACdC,QAAQ,EAAE,MAAM;MAChBC,KAAK,EAAE,gBAAgB;MACvBC,OAAO,EAAE;QACPC,IAAI,EAAE,sCAAsC;QAC5CC,OAAO,EAAE,EAAE;QACXC,GAAG,EAAE;MACP;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAG,eAAe;IACjC,IAAI,CAACC,OAAO,GAAG,IAAAC,aAAK,EAACd,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEgB,SAASA,CAAC;IAACC,KAAK;IAAEC,UAAU;IAAEC;EAAI,CAAC,EAAE;IACnC,IAAI,CAACC,cAAc,GAAGF,UAAU,CAACG,WAAW,CAAC,mBAAmB,CAAC;IACjE,MAAMC,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAACvB,MAAM,EAAE,IAAI,CAACc;IAAO,CAAC,CAAC;IAErE,MAAMU,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACN,IAAI,CAAC;IACnDG,gBAAgB,CAACI,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDL,gBAAgB,CAACM,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IACnDP,gBAAgB,CAACQ,OAAO,CAACN,gBAAgB,CAACO,IAAI,CAAC;IAE/C,OAAOT,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEU,YAAYA,CAACf,KAAK,EAAE;IAClB,OAAOA,KAAK,CAACgB,OAAO,CAAC,CAAC;EACxB;;EAEA;AACF;AACA;AACA;AACA;EACER,eAAeA,CAACN,IAAI,EAAE;IACpB,IAAIU,MAAM,GAAG,EAAE;IACf,IACE,IAAI,CAACT,cAAc,CAACc,aAAa,KAAK,CAAC,IACvC,IAAI,CAACd,cAAc,CAACe,gBAAgB,KAAK,IAAI,CAACf,cAAc,CAACc,aAAa,EAC1E;MACAL,MAAM,GAAG,KAAK;IAChB,CAAC,MAAM;MACLA,MAAM,GAAG,MAAM;IACjB;IAEA,MAAMF,KAAK,GAAG,IAAI,CAACS,QAAQ,CAAC,IAAI,CAACtB,OAAO,CAACP,QAAQ,EAAEsB,MAAM,CAAC;IAE1D,OAAO;MACLF,KAAK;MACLE,MAAM;MACNE,IAAI,eACF3C,MAAA,CAAAQ,OAAA,CAAAyC,aAAA,CAAC/C,QAAA,CAAAgD,IAAI;QAACC,EAAE,EAAE;MAAO,GACd,IAAI,CAACzB,OAAO,CAACL,OAAO,CAACoB,MAAM,CAAC,EAAE,GAAG,EACjC,IAAI,CAACf,OAAO,CAACV,MAAM,iBAClBhB,MAAA,CAAAQ,OAAA,CAAAyC,aAAA;QAAGG,IAAI,EAAE,IAAI,CAAC1B,OAAO,CAACV,MAAO;QAACqC,MAAM,EAAC,QAAQ;QAACC,GAAG,EAAC;MAAY,GAAC,YAE5D,CAED;IAEV,CAAC;EACH;AACF;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAhD,OAAA,GAEcC,uBAAuB","ignoreList":[]}