axyseo 2.1.22 → 2025.1.0

package/build/esm/scoring/assessments/index.js

@@ -1,16 +1,13 @@
-// SEO assessments - import TextLengthAssessment first to avoid initialization errors.
-import TextLengthAssessment from "./seo/TextLengthAssessment";
-
 // Readability assessments.
 import ParagraphTooLongAssessment from "./readability/ParagraphTooLongAssessment";
 import SentenceBeginningsAssessment from "./readability/SentenceBeginningsAssessment";
 import SentenceLengthInTextAssessment from "./readability/SentenceLengthInTextAssessment";
 import TransitionWordsAssessment from "./readability/TransitionWordsAssessment";
-import RelatedKeywordsAssessment from "./readability/RelatedKeywordsAssessment";
 
 // SEO assessments.
 import InternalLinksAssessment from "./seo/InternalLinksAssessment";
 import IntroductionKeywordAssessment from "./seo/IntroductionKeywordAssessment";
+import KeyphraseLengthAssessment from "./seo/KeyphraseLengthAssessment";
 import KeyphraseDensityAssessment from "./seo/KeywordDensityAssessment";
 import MetaDescriptionKeywordAssessment from "./seo/MetaDescriptionKeywordAssessment";
 import MetaDescriptionLengthAssessment from "./seo/MetaDescriptionLengthAssessment";
@@ -18,8 +15,10 @@ import OutboundLinksAssessment from "./seo/OutboundLinksAssessment";
 import PageTitleWidthAssessment from "./seo/PageTitleWidthAssessment";
 import SingleH1Assessment from "./seo/SingleH1Assessment";
 import SubheadingsKeywordAssessment from "./seo/SubHeadingsKeywordAssessment";
+import TextLengthAssessment from "./seo/TextLengthAssessment";
 import SlugKeywordAssessment from "./seo/UrlKeywordAssessment";
 import ImageCountAssessment from "./seo/ImageCountAssessment";
+import ImagesInContentAssessment from "./seo/ImagesInContentAssessment";
 import KeyphraseAssessment from "./seo/KeyphraseAssessment";
 import SingleTitleAssessment from "./seo/SingleTitleAssessment";
 import UrlLengthAssessment from "./seo/UrlLengthAssessment";
@@ -27,26 +26,25 @@ import NumberInMetaTitleAssessment from "./seo/NumberInMetaTitleAssessment";
 import TextImagesAssessment from "./seo/TextImagesAssessment";
 import MetaTitleKeywordAssessment from "./seo/MetaTitleKeywordAssessment";
 import SchemaAssessment from "./seo/SchemaAssessment";
-import RelatedKeywordsDensityAssessment from "./seo/RelatedKeywordsDensityAssessment";
-import InvalidCharactersInUrl from "./seo/InvalidCharactersInUrl";
-import FAQsStructureDataAssessment from "./seo/FAQsStructureDataAssessment";
+import RelatedKeywordsAssessment from "./readability/RelatedKeywordsAssessment";
 const readability = {
   ParagraphTooLongAssessment,
   SentenceBeginningsAssessment,
   SentenceLengthInTextAssessment,
-  TransitionWordsAssessment,
-  RelatedKeywordsAssessment
+  TransitionWordsAssessment
 };
 
 // We expose the deprecated assessments for backwards compatibility.
 const seo = {
   ImageCountAssessment,
+  ImagesInContentAssessment,
   NumberInMetaTitleAssessment,
   InternalLinksAssessment,
   TextImagesAssessment,
   MetaTitleKeywordAssessment,
   IntroductionKeywordAssessment,
   SingleTitleAssessment,
+  KeyphraseLengthAssessment,
   UrlLengthAssessment,
   KeyphraseDensityAssessment,
   MetaDescriptionKeywordAssessment,
@@ -59,9 +57,7 @@ const seo = {
   SlugKeywordAssessment,
   KeyphraseAssessment,
   SchemaAssessment,
-  RelatedKeywordsDensityAssessment,
-  InvalidCharactersInUrl,
-  FAQsStructureDataAssessment
+  RelatedKeywordsAssessment
 };
 export { readability, seo };
 //# sourceMappingURL=index.js.map

package/build/esm/scoring/assessments/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["TextLengthAssessment","ParagraphTooLongAssessment","SentenceBeginningsAssessment","SentenceLengthInTextAssessment","TransitionWordsAssessment","RelatedKeywordsAssessment","InternalLinksAssessment","IntroductionKeywordAssessment","KeyphraseDensityAssessment","MetaDescriptionKeywordAssessment","MetaDescriptionLengthAssessment","OutboundLinksAssessment","PageTitleWidthAssessment","SingleH1Assessment","SubheadingsKeywordAssessment","SlugKeywordAssessment","ImageCountAssessment","KeyphraseAssessment","SingleTitleAssessment","UrlLengthAssessment","NumberInMetaTitleAssessment","TextImagesAssessment","MetaTitleKeywordAssessment","SchemaAssessment","RelatedKeywordsDensityAssessment","InvalidCharactersInUrl","FAQsStructureDataAssessment","readability","seo"],"sources":["../../../../src/scoring/assessments/index.js"],"sourcesContent":["// SEO assessments - import TextLengthAssessment first to avoid initialization errors.\nimport TextLengthAssessment from './seo/TextLengthAssessment';\n\n// Readability assessments.\nimport ParagraphTooLongAssessment from './readability/ParagraphTooLongAssessment';\nimport SentenceBeginningsAssessment from './readability/SentenceBeginningsAssessment';\nimport SentenceLengthInTextAssessment from './readability/SentenceLengthInTextAssessment';\nimport TransitionWordsAssessment from './readability/TransitionWordsAssessment';\nimport RelatedKeywordsAssessment from './readability/RelatedKeywordsAssessment';\n\n// SEO assessments.\nimport InternalLinksAssessment from './seo/InternalLinksAssessment';\nimport IntroductionKeywordAssessment from './seo/IntroductionKeywordAssessment';\nimport KeyphraseDensityAssessment from './seo/KeywordDensityAssessment';\nimport MetaDescriptionKeywordAssessment from './seo/MetaDescriptionKeywordAssessment';\nimport MetaDescriptionLengthAssessment from './seo/MetaDescriptionLengthAssessment';\nimport OutboundLinksAssessment from './seo/OutboundLinksAssessment';\nimport PageTitleWidthAssessment from './seo/PageTitleWidthAssessment';\nimport SingleH1Assessment from './seo/SingleH1Assessment';\nimport SubheadingsKeywordAssessment from './seo/SubHeadingsKeywordAssessment';\nimport SlugKeywordAssessment from './seo/UrlKeywordAssessment';\nimport ImageCountAssessment from './seo/ImageCountAssessment';\nimport KeyphraseAssessment from './seo/KeyphraseAssessment';\nimport SingleTitleAssessment from './seo/SingleTitleAssessment';\nimport UrlLengthAssessment from './seo/UrlLengthAssessment';\nimport NumberInMetaTitleAssessment from './seo/NumberInMetaTitleAssessment';\nimport TextImagesAssessment from './seo/TextImagesAssessment';\nimport MetaTitleKeywordAssessment from './seo/MetaTitleKeywordAssessment';\nimport SchemaAssessment from './seo/SchemaAssessment';\nimport RelatedKeywordsDensityAssessment from './seo/RelatedKeywordsDensityAssessment';\nimport InvalidCharactersInUrl from './seo/InvalidCharactersInUrl';\nimport FAQsStructureDataAssessment from './seo/FAQsStructureDataAssessment';\n\nconst readability = {\n  ParagraphTooLongAssessment,\n  SentenceBeginningsAssessment,\n  SentenceLengthInTextAssessment,\n  TransitionWordsAssessment,\n  RelatedKeywordsAssessment\n};\n\n// We expose the deprecated assessments for backwards compatibility.\nconst seo = {\n  ImageCountAssessment,\n  NumberInMetaTitleAssessment,\n  InternalLinksAssessment,\n  TextImagesAssessment,\n  MetaTitleKeywordAssessment,\n  IntroductionKeywordAssessment,\n  SingleTitleAssessment,\n  UrlLengthAssessment,\n  KeyphraseDensityAssessment,\n  MetaDescriptionKeywordAssessment,\n  MetaDescriptionLengthAssessment,\n  OutboundLinksAssessment,\n  PageTitleWidthAssessment,\n  SingleH1Assessment,\n  SubheadingsKeywordAssessment,\n  TextLengthAssessment,\n  SlugKeywordAssessment,\n  KeyphraseAssessment,\n  SchemaAssessment,\n  RelatedKeywordsDensityAssessment,\n  InvalidCharactersInUrl,\n  FAQsStructureDataAssessment\n};\n\nexport {readability, seo};\n"],"mappings":"AAAA;AACA,OAAOA,oBAAoB;;AAE3B;AACA,OAAOC,0BAA0B;AACjC,OAAOC,4BAA4B;AACnC,OAAOC,8BAA8B;AACrC,OAAOC,yBAAyB;AAChC,OAAOC,yBAAyB;;AAEhC;AACA,OAAOC,uBAAuB;AAC9B,OAAOC,6BAA6B;AACpC,OAAOC,0BAA0B;AACjC,OAAOC,gCAAgC;AACvC,OAAOC,+BAA+B;AACtC,OAAOC,uBAAuB;AAC9B,OAAOC,wBAAwB;AAC/B,OAAOC,kBAAkB;AACzB,OAAOC,4BAA4B;AACnC,OAAOC,qBAAqB;AAC5B,OAAOC,oBAAoB;AAC3B,OAAOC,mBAAmB;AAC1B,OAAOC,qBAAqB;AAC5B,OAAOC,mBAAmB;AAC1B,OAAOC,2BAA2B;AAClC,OAAOC,oBAAoB;AAC3B,OAAOC,0BAA0B;AACjC,OAAOC,gBAAgB;AACvB,OAAOC,gCAAgC;AACvC,OAAOC,sBAAsB;AAC7B,OAAOC,2BAA2B;AAElC,MAAMC,WAAW,GAAG;EAClB1B,0BAA0B;EAC1BC,4BAA4B;EAC5BC,8BAA8B;EAC9BC,yBAAyB;EACzBC;AACF,CAAC;;AAED;AACA,MAAMuB,GAAG,GAAG;EACVZ,oBAAoB;EACpBI,2BAA2B;EAC3Bd,uBAAuB;EACvBe,oBAAoB;EACpBC,0BAA0B;EAC1Bf,6BAA6B;EAC7BW,qBAAqB;EACrBC,mBAAmB;EACnBX,0BAA0B;EAC1BC,gCAAgC;EAChCC,+BAA+B;EAC/BC,uBAAuB;EACvBC,wBAAwB;EACxBC,kBAAkB;EAClBC,4BAA4B;EAC5Bd,oBAAoB;EACpBe,qBAAqB;EACrBE,mBAAmB;EACnBM,gBAAgB;EAChBC,gCAAgC;EAChCC,sBAAsB;EACtBC;AACF,CAAC;AAED,SAAQC,WAAW,EAAEC,GAAG","ignoreList":[]}
+{"version":3,"file":"index.js","names":["ParagraphTooLongAssessment","SentenceBeginningsAssessment","SentenceLengthInTextAssessment","TransitionWordsAssessment","InternalLinksAssessment","IntroductionKeywordAssessment","KeyphraseLengthAssessment","KeyphraseDensityAssessment","MetaDescriptionKeywordAssessment","MetaDescriptionLengthAssessment","OutboundLinksAssessment","PageTitleWidthAssessment","SingleH1Assessment","SubheadingsKeywordAssessment","TextLengthAssessment","SlugKeywordAssessment","ImageCountAssessment","ImagesInContentAssessment","KeyphraseAssessment","SingleTitleAssessment","UrlLengthAssessment","NumberInMetaTitleAssessment","TextImagesAssessment","MetaTitleKeywordAssessment","SchemaAssessment","RelatedKeywordsAssessment","readability","seo"],"sources":["../../../../src/scoring/assessments/index.js"],"sourcesContent":["// Readability assessments.\nimport ParagraphTooLongAssessment from './readability/ParagraphTooLongAssessment';\nimport SentenceBeginningsAssessment from './readability/SentenceBeginningsAssessment';\nimport SentenceLengthInTextAssessment from './readability/SentenceLengthInTextAssessment';\nimport TransitionWordsAssessment from './readability/TransitionWordsAssessment';\n\n// SEO assessments.\nimport InternalLinksAssessment from './seo/InternalLinksAssessment';\nimport IntroductionKeywordAssessment from './seo/IntroductionKeywordAssessment';\nimport KeyphraseLengthAssessment from './seo/KeyphraseLengthAssessment';\nimport KeyphraseDensityAssessment from './seo/KeywordDensityAssessment';\nimport MetaDescriptionKeywordAssessment from './seo/MetaDescriptionKeywordAssessment';\nimport MetaDescriptionLengthAssessment from './seo/MetaDescriptionLengthAssessment';\nimport OutboundLinksAssessment from './seo/OutboundLinksAssessment';\nimport PageTitleWidthAssessment from './seo/PageTitleWidthAssessment';\nimport SingleH1Assessment from './seo/SingleH1Assessment';\nimport SubheadingsKeywordAssessment from './seo/SubHeadingsKeywordAssessment';\nimport TextLengthAssessment from './seo/TextLengthAssessment';\nimport SlugKeywordAssessment from './seo/UrlKeywordAssessment';\nimport ImageCountAssessment from './seo/ImageCountAssessment';\nimport ImagesInContentAssessment from './seo/ImagesInContentAssessment';\nimport KeyphraseAssessment from './seo/KeyphraseAssessment';\nimport SingleTitleAssessment from './seo/SingleTitleAssessment';\nimport UrlLengthAssessment from './seo/UrlLengthAssessment';\nimport NumberInMetaTitleAssessment from './seo/NumberInMetaTitleAssessment';\nimport TextImagesAssessment from './seo/TextImagesAssessment';\nimport MetaTitleKeywordAssessment from './seo/MetaTitleKeywordAssessment';\nimport SchemaAssessment from './seo/SchemaAssessment';\nimport RelatedKeywordsAssessment from '@axyseo/scoring/assessments/readability/RelatedKeywordsAssessment';\n\nconst readability = {\n  ParagraphTooLongAssessment,\n  SentenceBeginningsAssessment,\n  SentenceLengthInTextAssessment,\n  TransitionWordsAssessment\n};\n\n// We expose the deprecated assessments for backwards compatibility.\nconst seo = {\n  ImageCountAssessment,\n  ImagesInContentAssessment,\n  NumberInMetaTitleAssessment,\n  InternalLinksAssessment,\n  TextImagesAssessment,\n  MetaTitleKeywordAssessment,\n  IntroductionKeywordAssessment,\n  SingleTitleAssessment,\n  KeyphraseLengthAssessment,\n  UrlLengthAssessment,\n  KeyphraseDensityAssessment,\n  MetaDescriptionKeywordAssessment,\n  MetaDescriptionLengthAssessment,\n  OutboundLinksAssessment,\n  PageTitleWidthAssessment,\n  SingleH1Assessment,\n  SubheadingsKeywordAssessment,\n  TextLengthAssessment,\n  SlugKeywordAssessment,\n  KeyphraseAssessment,\n  SchemaAssessment,\n  RelatedKeywordsAssessment\n};\n\nexport {readability, seo};\n"],"mappings":"AAAA;AACA,OAAOA,0BAA0B;AACjC,OAAOC,4BAA4B;AACnC,OAAOC,8BAA8B;AACrC,OAAOC,yBAAyB;;AAEhC;AACA,OAAOC,uBAAuB;AAC9B,OAAOC,6BAA6B;AACpC,OAAOC,yBAAyB;AAChC,OAAOC,0BAA0B;AACjC,OAAOC,gCAAgC;AACvC,OAAOC,+BAA+B;AACtC,OAAOC,uBAAuB;AAC9B,OAAOC,wBAAwB;AAC/B,OAAOC,kBAAkB;AACzB,OAAOC,4BAA4B;AACnC,OAAOC,oBAAoB;AAC3B,OAAOC,qBAAqB;AAC5B,OAAOC,oBAAoB;AAC3B,OAAOC,yBAAyB;AAChC,OAAOC,mBAAmB;AAC1B,OAAOC,qBAAqB;AAC5B,OAAOC,mBAAmB;AAC1B,OAAOC,2BAA2B;AAClC,OAAOC,oBAAoB;AAC3B,OAAOC,0BAA0B;AACjC,OAAOC,gBAAgB;AACvB,OAAOC,yBAAyB;AAEhC,MAAMC,WAAW,GAAG;EAClB1B,0BAA0B;EAC1BC,4BAA4B;EAC5BC,8BAA8B;EAC9BC;AACF,CAAC;;AAED;AACA,MAAMwB,GAAG,GAAG;EACVX,oBAAoB;EACpBC,yBAAyB;EACzBI,2BAA2B;EAC3BjB,uBAAuB;EACvBkB,oBAAoB;EACpBC,0BAA0B;EAC1BlB,6BAA6B;EAC7Bc,qBAAqB;EACrBb,yBAAyB;EACzBc,mBAAmB;EACnBb,0BAA0B;EAC1BC,gCAAgC;EAChCC,+BAA+B;EAC/BC,uBAAuB;EACvBC,wBAAwB;EACxBC,kBAAkB;EAClBC,4BAA4B;EAC5BC,oBAAoB;EACpBC,qBAAqB;EACrBG,mBAAmB;EACnBM,gBAAgB;EAChBC;AACF,CAAC;AAED,SAAQC,WAAW,EAAEC,GAAG","ignoreList":[]}

package/build/esm/scoring/assessments/readability/ParagraphTooLongAssessment.js

@@ -2,7 +2,7 @@ import { merge } from 'lodash';
 import { inRangeEndInclusive as inRange } from "../../helpers/assessments/inRange";
 import AssessmentResult from "../../../values/AssessmentResult";
 import Assessment from "../assessment";
-import { MAIN_CONTENT_POINTS, TEXT_PARAGRAPH_TOO_LONG_ID } from "../../../const/analysis";
+import { TEXT_PARAGRAPH_TOO_LONG_ID } from "../../../const/analysis";
 
 /**
  * Represents the assessment that will look if the text has too long paragraphs.
@@ -64,27 +64,28 @@ export default class ParagraphTooLongAssessment extends Assessment {
    *
    * @param paragraphsLength
    * @param config
-   * @param hasDescription
-   * @returns {{score: number, status: (string)}}
+   * @returns {{score: number, status: string}}
    */
   calculateResult({
     paragraphsLength,
-    config,
-    hasDescription
+    config
   }) {
     let status = 'bad';
-    if (paragraphsLength.length === 0 || !hasDescription) {
-      status = 'bad';
+    if (paragraphsLength.length === 0) {
+      status = 'good';
     } else {
-      const {
-        recommendedLength,
-        maximumRecommendedLength
-      } = config.parameters;
-      const length = paragraphsLength[0].countLength;
-      const isGood = length <= recommendedLength || inRange(length, recommendedLength, maximumRecommendedLength);
-      status = isGood ? 'good' : 'bad';
+      const longestParagraphLength = paragraphsLength[0].countLength;
+      if (longestParagraphLength <= config.parameters.recommendedLength) {
+        status = 'good';
+      }
+      if (inRange(longestParagraphLength, config.parameters.recommendedLength, config.parameters.maximumRecommendedLength)) {
+        status = 'good';
+      }
+      if (longestParagraphLength > config.parameters.maximumRecommendedLength) {
+        status = 'bad';
+      }
     }
-    const score = this.getScore(MAIN_CONTENT_POINTS, status);
+    const score = this.getScore(this._config.priority, status);
     return {
       score,
       status
@@ -118,11 +119,9 @@ export default class ParagraphTooLongAssessment extends Assessment {
     let paragraphsLength = researcher.getResearch('getParagraphLength');
     paragraphsLength = this.sortParagraphs(paragraphsLength);
     const config = this.getConfig(researcher);
-    const hasDescription = paper.hasDescription();
     const paragraphLengthResult = this.calculateResult({
       paragraphsLength,
-      config,
-      hasDescription
+      config
     });
     const assessmentResult = new AssessmentResult({
       config: this._config
@@ -140,7 +139,7 @@ export default class ParagraphTooLongAssessment extends Assessment {
    * @returns {boolean} Returns true if the assessment is applicable to the paper.
    */
   isApplicable(paper) {
-    return true;
+    return this.hasEnoughContentForAssessment(paper);
   }
 }
 //# sourceMappingURL=ParagraphTooLongAssessment.js.map

package/build/esm/scoring/assessments/readability/ParagraphTooLongAssessment.js.map

@@ -1 +1 @@
-{"version":3,"file":"ParagraphTooLongAssessment.js","names":["merge","inRangeEndInclusive","inRange","AssessmentResult","Assessment","MAIN_CONTENT_POINTS","TEXT_PARAGRAPH_TOO_LONG_ID","ParagraphTooLongAssessment","constructor","config","defaultConfig","id","priority","docUrl","fixPosition","ctaType","parameters","recommendedLength","maximumRecommendedLength","title","content","bad","improve","good","identifier","_config","getConfig","researcher","currentConfig","languageSpecificConfig","_isProduct","productPageParams","defaultPageParams","calculateResult","paragraphsLength","hasDescription","status","length","countLength","isGood","score","getScore","sortParagraphs","paragraphs","sort","a","b","getResult","paper","getResearch","paragraphLengthResult","assessmentResult","setScore","setStatus","isApplicable"],"sources":["../../../../../src/scoring/assessments/readability/ParagraphTooLongAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport {inRangeEndInclusive as inRange} from '../../helpers/assessments/inRange';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\nimport {MAIN_CONTENT_POINTS, TEXT_PARAGRAPH_TOO_LONG_ID} from '@axyseo/const/analysis';\n\n/**\n * Represents the assessment that will look if the text has too long paragraphs.\n */\nexport default class ParagraphTooLongAssessment 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: TEXT_PARAGRAPH_TOO_LONG_ID,\n      priority: 'high',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#paragraph-length',\n      fixPosition: 'longParagraph',\n      ctaType: 'fix',\n      parameters: {\n        recommendedLength: 150,\n        maximumRecommendedLength: 150\n      },\n      title: 'Paragraph length',\n      content: {\n        bad: 'Paragraph too long. Keep paragraph length less than 150 words for readability.',\n        improve: '',\n        good: 'Paragraph is optimized, with less than 150 words.'\n      }\n    };\n\n    this.identifier = TEXT_PARAGRAPH_TOO_LONG_ID;\n    this._config = merge(defaultConfig, config);\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  getConfig(researcher) {\n    const currentConfig = this._config;\n    const languageSpecificConfig = researcher.getConfig('paragraphLength');\n\n    /*\n     * If a language has a specific paragraph length config, check further if the assessment is run in product pages.\n     * If it's run in product pages, override the default config parameters with the language specific config for product pages,\n     * otherwise override it with the language specific config for default pages analysis.\n     */\n    if (languageSpecificConfig) {\n      currentConfig.parameters = this._isProduct\n        ? languageSpecificConfig.productPageParams\n        : languageSpecificConfig.defaultPageParams;\n    }\n\n    return currentConfig;\n  }\n\n  /**\n   *\n   * @param paragraphsLength\n   * @param config\n   * @param hasDescription\n   * @returns {{score: number, status: (string)}}\n   */\n  calculateResult({paragraphsLength, config, hasDescription}) {\n    let status = 'bad';\n    if (paragraphsLength.length === 0 || !hasDescription) {\n      status = 'bad';\n    } else {\n      const { recommendedLength, maximumRecommendedLength } = config.parameters;\n      const length = paragraphsLength[0].countLength;\n\n      const isGood =\n        length <= recommendedLength ||\n        inRange(length, recommendedLength, maximumRecommendedLength);\n\n      status = isGood ? 'good' : 'bad';\n    }\n    const score = this.getScore(MAIN_CONTENT_POINTS, status);\n\n    return {\n      score,\n      status\n    };\n  }\n\n  /**\n   * Sort the paragraphs based on word count.\n   *\n   * @param {Array} paragraphs The array with paragraphs.\n   *\n   * @returns {Array} The array sorted on word counts.\n   */\n  sortParagraphs(paragraphs) {\n    return paragraphs.sort(function(a, b) {\n      return b.countLength - a.countLength;\n    });\n  }\n\n  /**\n   * Runs the getParagraphLength module, based on this returns an assessment result with score and text.\n   *\n   * @param {Paper} paper             The paper to use for the assessment.\n   * @param {Researcher} researcher   The researcher used for calling research.\n   * @returns {object} The assessment result.\n   */\n  getResult({paper, researcher}) {\n    let paragraphsLength = researcher.getResearch('getParagraphLength');\n\n    paragraphsLength = this.sortParagraphs(paragraphsLength);\n    const config = this.getConfig(researcher);\n    const hasDescription = paper.hasDescription();\n    const paragraphLengthResult = this.calculateResult({\n      paragraphsLength,\n      config,\n      hasDescription\n    });\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(paragraphLengthResult.score);\n    assessmentResult.setStatus(paragraphLengthResult.status);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks if the paragraphTooLong assessment is applicable to the paper.\n   *\n   * @param {Paper} paper The paper to check.\n   *\n   * @returns {boolean} Returns true if the assessment is applicable to the paper.\n   */\n  isApplicable(paper) {\n    return true;\n  }\n}\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,QAAQ;AAC5B,SAAQC,mBAAmB,IAAIC,OAAO;AACtC,OAAOC,gBAAgB;AACvB,OAAOC,UAAU;AACjB,SAAQC,mBAAmB,EAAEC,0BAA0B;;AAEvD;AACA;AACA;AACA,eAAe,MAAMC,0BAA0B,SAASH,UAAU,CAAC;EACjE;AACF;AACA;AACA;AACA;AACA;AACA;EACEI,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEL,0BAA0B;MAC9BM,QAAQ,EAAE,MAAM;MAChBC,MAAM,EACJ,8FAA8F;MAChGC,WAAW,EAAE,eAAe;MAC5BC,OAAO,EAAE,KAAK;MACdC,UAAU,EAAE;QACVC,iBAAiB,EAAE,GAAG;QACtBC,wBAAwB,EAAE;MAC5B,CAAC;MACDC,KAAK,EAAE,kBAAkB;MACzBC,OAAO,EAAE;QACPC,GAAG,EAAE,gFAAgF;QACrFC,OAAO,EAAE,EAAE;QACXC,IAAI,EAAE;MACR;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGlB,0BAA0B;IAC5C,IAAI,CAACmB,OAAO,GAAGzB,KAAK,CAACU,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEiB,SAASA,CAACC,UAAU,EAAE;IACpB,MAAMC,aAAa,GAAG,IAAI,CAACH,OAAO;IAClC,MAAMI,sBAAsB,GAAGF,UAAU,CAACD,SAAS,CAAC,iBAAiB,CAAC;;IAEtE;AACJ;AACA;AACA;AACA;IACI,IAAIG,sBAAsB,EAAE;MAC1BD,aAAa,CAACZ,UAAU,GAAG,IAAI,CAACc,UAAU,GACtCD,sBAAsB,CAACE,iBAAiB,GACxCF,sBAAsB,CAACG,iBAAiB;IAC9C;IAEA,OAAOJ,aAAa;EACtB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEK,eAAeA,CAAC;IAACC,gBAAgB;IAAEzB,MAAM;IAAE0B;EAAc,CAAC,EAAE;IAC1D,IAAIC,MAAM,GAAG,KAAK;IAClB,IAAIF,gBAAgB,CAACG,MAAM,KAAK,CAAC,IAAI,CAACF,cAAc,EAAE;MACpDC,MAAM,GAAG,KAAK;IAChB,CAAC,MAAM;MACL,MAAM;QAAEnB,iBAAiB;QAAEC;MAAyB,CAAC,GAAGT,MAAM,CAACO,UAAU;MACzE,MAAMqB,MAAM,GAAGH,gBAAgB,CAAC,CAAC,CAAC,CAACI,WAAW;MAE9C,MAAMC,MAAM,GACVF,MAAM,IAAIpB,iBAAiB,IAC3Bf,OAAO,CAACmC,MAAM,EAAEpB,iBAAiB,EAAEC,wBAAwB,CAAC;MAE9DkB,MAAM,GAAGG,MAAM,GAAG,MAAM,GAAG,KAAK;IAClC;IACA,MAAMC,KAAK,GAAG,IAAI,CAACC,QAAQ,CAACpC,mBAAmB,EAAE+B,MAAM,CAAC;IAExD,OAAO;MACLI,KAAK;MACLJ;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEM,cAAcA,CAACC,UAAU,EAAE;IACzB,OAAOA,UAAU,CAACC,IAAI,CAAC,UAASC,CAAC,EAAEC,CAAC,EAAE;MACpC,OAAOA,CAAC,CAACR,WAAW,GAAGO,CAAC,CAACP,WAAW;IACtC,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACES,SAASA,CAAC;IAACC,KAAK;IAAErB;EAAU,CAAC,EAAE;IAC7B,IAAIO,gBAAgB,GAAGP,UAAU,CAACsB,WAAW,CAAC,oBAAoB,CAAC;IAEnEf,gBAAgB,GAAG,IAAI,CAACQ,cAAc,CAACR,gBAAgB,CAAC;IACxD,MAAMzB,MAAM,GAAG,IAAI,CAACiB,SAAS,CAACC,UAAU,CAAC;IACzC,MAAMQ,cAAc,GAAGa,KAAK,CAACb,cAAc,CAAC,CAAC;IAC7C,MAAMe,qBAAqB,GAAG,IAAI,CAACjB,eAAe,CAAC;MACjDC,gBAAgB;MAChBzB,MAAM;MACN0B;IACF,CAAC,CAAC;IACF,MAAMgB,gBAAgB,GAAG,IAAIhD,gBAAgB,CAAC;MAACM,MAAM,EAAE,IAAI,CAACgB;IAAO,CAAC,CAAC;IAErE0B,gBAAgB,CAACC,QAAQ,CAACF,qBAAqB,CAACV,KAAK,CAAC;IACtDW,gBAAgB,CAACE,SAAS,CAACH,qBAAqB,CAACd,MAAM,CAAC;IAExD,OAAOe,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEG,YAAYA,CAACN,KAAK,EAAE;IAClB,OAAO,IAAI;EACb;AACF","ignoreList":[]}
+{"version":3,"file":"ParagraphTooLongAssessment.js","names":["merge","inRangeEndInclusive","inRange","AssessmentResult","Assessment","TEXT_PARAGRAPH_TOO_LONG_ID","ParagraphTooLongAssessment","constructor","config","defaultConfig","id","priority","docUrl","fixPosition","ctaType","parameters","recommendedLength","maximumRecommendedLength","title","content","bad","improve","good","identifier","_config","getConfig","researcher","currentConfig","languageSpecificConfig","_isProduct","productPageParams","defaultPageParams","calculateResult","paragraphsLength","status","length","longestParagraphLength","countLength","score","getScore","sortParagraphs","paragraphs","sort","a","b","getResult","paper","getResearch","paragraphLengthResult","assessmentResult","setScore","setStatus","isApplicable","hasEnoughContentForAssessment"],"sources":["../../../../../src/scoring/assessments/readability/ParagraphTooLongAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport {inRangeEndInclusive as inRange} from '../../helpers/assessments/inRange';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\nimport {TEXT_PARAGRAPH_TOO_LONG_ID} from '@axyseo/const/analysis';\n\n/**\n * Represents the assessment that will look if the text has too long paragraphs.\n */\nexport default class ParagraphTooLongAssessment 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: TEXT_PARAGRAPH_TOO_LONG_ID,\n      priority: 'high',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#paragraph-length',\n      fixPosition: 'longParagraph',\n      ctaType: 'fix',\n      parameters: {\n        recommendedLength: 150,\n        maximumRecommendedLength: 150\n      },\n      title: 'Paragraph length',\n      content: {\n        bad: 'Paragraph too long. Keep paragraph length less than 150 words for readability.',\n        improve: '',\n        good: 'Paragraph is optimized, with less than 150 words.'\n      }\n    };\n\n    this.identifier = TEXT_PARAGRAPH_TOO_LONG_ID;\n    this._config = merge(defaultConfig, config);\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  getConfig(researcher) {\n    const currentConfig = this._config;\n    const languageSpecificConfig = researcher.getConfig('paragraphLength');\n\n    /*\n     * If a language has a specific paragraph length config, check further if the assessment is run in product pages.\n     * If it's run in product pages, override the default config parameters with the language specific config for product pages,\n     * otherwise override it with the language specific config for default pages analysis.\n     */\n    if (languageSpecificConfig) {\n      currentConfig.parameters = this._isProduct\n        ? languageSpecificConfig.productPageParams\n        : languageSpecificConfig.defaultPageParams;\n    }\n\n    return currentConfig;\n  }\n\n  /**\n   *\n   * @param paragraphsLength\n   * @param config\n   * @returns {{score: number, status: string}}\n   */\n  calculateResult({paragraphsLength, config}) {\n    let status = 'bad';\n    if (paragraphsLength.length === 0) {\n      status = 'good';\n    } else {\n      const longestParagraphLength = paragraphsLength[0].countLength;\n\n      if (longestParagraphLength <= config.parameters.recommendedLength) {\n        status = 'good';\n      }\n\n      if (\n        inRange(\n          longestParagraphLength,\n          config.parameters.recommendedLength,\n          config.parameters.maximumRecommendedLength\n        )\n      ) {\n        status = 'good';\n      }\n\n      if (longestParagraphLength > config.parameters.maximumRecommendedLength) {\n        status = 'bad';\n      }\n    }\n\n    const score = this.getScore(this._config.priority, status);\n\n    return {\n      score,\n      status\n    };\n  }\n\n  /**\n   * Sort the paragraphs based on word count.\n   *\n   * @param {Array} paragraphs The array with paragraphs.\n   *\n   * @returns {Array} The array sorted on word counts.\n   */\n  sortParagraphs(paragraphs) {\n    return paragraphs.sort(function(a, b) {\n      return b.countLength - a.countLength;\n    });\n  }\n\n  /**\n   * Runs the getParagraphLength module, based on this returns an assessment result with score and text.\n   *\n   * @param {Paper} paper             The paper to use for the assessment.\n   * @param {Researcher} researcher   The researcher used for calling research.\n   * @returns {object} The assessment result.\n   */\n  getResult({paper, researcher}) {\n    let paragraphsLength = researcher.getResearch('getParagraphLength');\n\n    paragraphsLength = this.sortParagraphs(paragraphsLength);\n    const config = this.getConfig(researcher);\n\n    const paragraphLengthResult = this.calculateResult({\n      paragraphsLength,\n      config\n    });\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(paragraphLengthResult.score);\n    assessmentResult.setStatus(paragraphLengthResult.status);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks if the paragraphTooLong assessment is applicable to the paper.\n   *\n   * @param {Paper} paper The paper to check.\n   *\n   * @returns {boolean} Returns true if the assessment is applicable to the paper.\n   */\n  isApplicable(paper) {\n    return this.hasEnoughContentForAssessment(paper);\n  }\n}\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,QAAQ;AAC5B,SAAQC,mBAAmB,IAAIC,OAAO;AACtC,OAAOC,gBAAgB;AACvB,OAAOC,UAAU;AACjB,SAAQC,0BAA0B;;AAElC;AACA;AACA;AACA,eAAe,MAAMC,0BAA0B,SAASF,UAAU,CAAC;EACjE;AACF;AACA;AACA;AACA;AACA;AACA;EACEG,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEL,0BAA0B;MAC9BM,QAAQ,EAAE,MAAM;MAChBC,MAAM,EACJ,8FAA8F;MAChGC,WAAW,EAAE,eAAe;MAC5BC,OAAO,EAAE,KAAK;MACdC,UAAU,EAAE;QACVC,iBAAiB,EAAE,GAAG;QACtBC,wBAAwB,EAAE;MAC5B,CAAC;MACDC,KAAK,EAAE,kBAAkB;MACzBC,OAAO,EAAE;QACPC,GAAG,EAAE,gFAAgF;QACrFC,OAAO,EAAE,EAAE;QACXC,IAAI,EAAE;MACR;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGlB,0BAA0B;IAC5C,IAAI,CAACmB,OAAO,GAAGxB,KAAK,CAACS,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEiB,SAASA,CAACC,UAAU,EAAE;IACpB,MAAMC,aAAa,GAAG,IAAI,CAACH,OAAO;IAClC,MAAMI,sBAAsB,GAAGF,UAAU,CAACD,SAAS,CAAC,iBAAiB,CAAC;;IAEtE;AACJ;AACA;AACA;AACA;IACI,IAAIG,sBAAsB,EAAE;MAC1BD,aAAa,CAACZ,UAAU,GAAG,IAAI,CAACc,UAAU,GACtCD,sBAAsB,CAACE,iBAAiB,GACxCF,sBAAsB,CAACG,iBAAiB;IAC9C;IAEA,OAAOJ,aAAa;EACtB;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEK,eAAeA,CAAC;IAACC,gBAAgB;IAAEzB;EAAM,CAAC,EAAE;IAC1C,IAAI0B,MAAM,GAAG,KAAK;IAClB,IAAID,gBAAgB,CAACE,MAAM,KAAK,CAAC,EAAE;MACjCD,MAAM,GAAG,MAAM;IACjB,CAAC,MAAM;MACL,MAAME,sBAAsB,GAAGH,gBAAgB,CAAC,CAAC,CAAC,CAACI,WAAW;MAE9D,IAAID,sBAAsB,IAAI5B,MAAM,CAACO,UAAU,CAACC,iBAAiB,EAAE;QACjEkB,MAAM,GAAG,MAAM;MACjB;MAEA,IACEhC,OAAO,CACLkC,sBAAsB,EACtB5B,MAAM,CAACO,UAAU,CAACC,iBAAiB,EACnCR,MAAM,CAACO,UAAU,CAACE,wBACpB,CAAC,EACD;QACAiB,MAAM,GAAG,MAAM;MACjB;MAEA,IAAIE,sBAAsB,GAAG5B,MAAM,CAACO,UAAU,CAACE,wBAAwB,EAAE;QACvEiB,MAAM,GAAG,KAAK;MAChB;IACF;IAEA,MAAMI,KAAK,GAAG,IAAI,CAACC,QAAQ,CAAC,IAAI,CAACf,OAAO,CAACb,QAAQ,EAAEuB,MAAM,CAAC;IAE1D,OAAO;MACLI,KAAK;MACLJ;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEM,cAAcA,CAACC,UAAU,EAAE;IACzB,OAAOA,UAAU,CAACC,IAAI,CAAC,UAASC,CAAC,EAAEC,CAAC,EAAE;MACpC,OAAOA,CAAC,CAACP,WAAW,GAAGM,CAAC,CAACN,WAAW;IACtC,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEQ,SAASA,CAAC;IAACC,KAAK;IAAEpB;EAAU,CAAC,EAAE;IAC7B,IAAIO,gBAAgB,GAAGP,UAAU,CAACqB,WAAW,CAAC,oBAAoB,CAAC;IAEnEd,gBAAgB,GAAG,IAAI,CAACO,cAAc,CAACP,gBAAgB,CAAC;IACxD,MAAMzB,MAAM,GAAG,IAAI,CAACiB,SAAS,CAACC,UAAU,CAAC;IAEzC,MAAMsB,qBAAqB,GAAG,IAAI,CAAChB,eAAe,CAAC;MACjDC,gBAAgB;MAChBzB;IACF,CAAC,CAAC;IACF,MAAMyC,gBAAgB,GAAG,IAAI9C,gBAAgB,CAAC;MAACK,MAAM,EAAE,IAAI,CAACgB;IAAO,CAAC,CAAC;IAErEyB,gBAAgB,CAACC,QAAQ,CAACF,qBAAqB,CAACV,KAAK,CAAC;IACtDW,gBAAgB,CAACE,SAAS,CAACH,qBAAqB,CAACd,MAAM,CAAC;IAExD,OAAOe,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEG,YAAYA,CAACN,KAAK,EAAE;IAClB,OAAO,IAAI,CAACO,6BAA6B,CAACP,KAAK,CAAC;EAClD;AACF","ignoreList":[]}

package/build/esm/scoring/assessments/readability/RelatedKeywordsAssessment.js

@@ -1,7 +1,7 @@
 import { merge } from 'lodash';
 import AssessmentResult from "../../../values/AssessmentResult";
 import Assessment from "../assessment";
-import { KEYWORD_POINTS, RELATED_KEYWORDS_ID } from "../../../const/analysis";
+import { RELATED_KEYWORDS_ID } from "../../../const/analysis";
 
 /**
  * Represents the assessment that checks whether there are enough transition words in the text.
@@ -24,9 +24,9 @@ export default class RelatedKeywordsAssessment extends Assessment {
       priority: 'high',
       title: 'Related keywords',
       content: {
-        good: 'Related keywords set',
-        bad: 'Related keywords field is empty. Add a few relevant phrases.',
-        improve: ''
+        good: 'Related keyword density is optimized',
+        bad: 'Consider using at least a related keyword in your page to establish topical relevance.',
+        improve: 'Too high related keyword density. Keep related keyword density from 0.5% - 1%.'
       }
     };
     this.identifier = RELATED_KEYWORDS_ID;
@@ -35,16 +35,28 @@ export default class RelatedKeywordsAssessment extends Assessment {
 
   /**
    *
+   * @param data
    * @param relatedKeywords
    * @returns {{score: number, status: string, words}}
    */
-  calculateResult(relatedKeywords) {
-    const isHasRelatedKeywords = relatedKeywords && relatedKeywords?.length > 0;
-    const status = isHasRelatedKeywords ? 'good' : 'bad';
-    const score = this.getScore(KEYWORD_POINTS, status);
+  calculateResult(data, relatedKeywords) {
+    const {
+      totalWordUsed,
+      words,
+      isWordUsedExceeding
+    } = relatedKeywords;
+    let status = 'good';
+    if (!data?.related_keywords?.length || totalWordUsed <= 0) {
+      status = 'bad';
+    }
+    if (isWordUsedExceeding) {
+      status = 'improve';
+    }
+    const score = this.getScore(this._config.priority, status);
     return {
       score,
-      status
+      status,
+      words
     };
   }
 
@@ -58,13 +70,15 @@ export default class RelatedKeywordsAssessment extends Assessment {
     paper,
     researcher
   }) {
-    const relatedKeywords = paper.getRelatedKeywords();
-    const result = this.calculateResult(relatedKeywords);
+    const relatedKeywords = researcher.getResearch('checkRelatedKeywords');
+    const data = paper.getData();
+    const result = this.calculateResult(data, relatedKeywords);
     const assessmentResult = new AssessmentResult({
       config: this._config
     });
     assessmentResult.setScore(result.score);
     assessmentResult.setStatus(result.status);
+    assessmentResult.setData(result.words);
     return assessmentResult;
   }
 
@@ -78,7 +92,7 @@ export default class RelatedKeywordsAssessment extends Assessment {
    * @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) {
-    return true;
+    return paper.hasRelatedKeywords();
   }
 }
 //# sourceMappingURL=RelatedKeywordsAssessment.js.map

package/build/esm/scoring/assessments/readability/RelatedKeywordsAssessment.js.map

@@ -1 +1 @@
-{"version":3,"file":"RelatedKeywordsAssessment.js","names":["merge","AssessmentResult","Assessment","KEYWORD_POINTS","RELATED_KEYWORDS_ID","RelatedKeywordsAssessment","constructor","config","defaultConfig","id","fixPosition","ctaType","docUrl","priority","title","content","good","bad","improve","identifier","_config","calculateResult","relatedKeywords","isHasRelatedKeywords","length","status","score","getScore","getResult","paper","researcher","getRelatedKeywords","result","assessmentResult","setScore","setStatus","isApplicable"],"sources":["../../../../../src/scoring/assessments/readability/RelatedKeywordsAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\nimport {KEYWORD_POINTS, RELATED_KEYWORDS_ID} from '@axyseo/const/analysis';\n\n/**\n * Represents the assessment that checks whether there are enough transition words in the text.\n */\nexport default class RelatedKeywordsAssessment 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: RELATED_KEYWORDS_ID,\n      fixPosition: 'description',\n      ctaType: 'fix',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#related-keywords',\n      priority: 'high',\n      title: 'Related keywords',\n      content: {\n        good: 'Related keywords set',\n        bad:\n          'Related keywords field is empty. Add a few relevant phrases.',\n        improve: ''\n      }\n    };\n\n    this.identifier = RELATED_KEYWORDS_ID;\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   *\n   * @param relatedKeywords\n   * @returns {{score: number, status: string, words}}\n   */\n  calculateResult(relatedKeywords) {\n    const isHasRelatedKeywords = relatedKeywords && relatedKeywords?.length > 0;\n    const status = isHasRelatedKeywords ? 'good' : 'bad';\n    const score = this.getScore(KEYWORD_POINTS, status);\n\n    return {\n      score,\n      status\n    };\n  }\n\n  /**\n   *\n   * @param paper\n   * @param researcher\n   * @returns {AssessmentResult}\n   */\n  getResult({paper, researcher}) {\n    const relatedKeywords = paper.getRelatedKeywords()\n    const result = this.calculateResult( relatedKeywords);\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(result.score);\n    assessmentResult.setStatus(result.status);\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    return true;\n  }\n}\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,QAAQ;AAC5B,OAAOC,gBAAgB;AACvB,OAAOC,UAAU;AACjB,SAAQC,cAAc,EAAEC,mBAAmB;;AAE3C;AACA;AACA;AACA,eAAe,MAAMC,yBAAyB,SAASH,UAAU,CAAC;EAChE;AACF;AACA;AACA;AACA;AACA;AACA;EACEI,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEL,mBAAmB;MACvBM,WAAW,EAAE,aAAa;MAC1BC,OAAO,EAAE,KAAK;MACdC,MAAM,EACJ,8FAA8F;MAChGC,QAAQ,EAAE,MAAM;MAChBC,KAAK,EAAE,kBAAkB;MACzBC,OAAO,EAAE;QACPC,IAAI,EAAE,sBAAsB;QAC5BC,GAAG,EACD,8DAA8D;QAChEC,OAAO,EAAE;MACX;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGf,mBAAmB;IACrC,IAAI,CAACgB,OAAO,GAAGpB,KAAK,CAACQ,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;EACEc,eAAeA,CAACC,eAAe,EAAE;IAC/B,MAAMC,oBAAoB,GAAGD,eAAe,IAAIA,eAAe,EAAEE,MAAM,GAAG,CAAC;IAC3E,MAAMC,MAAM,GAAGF,oBAAoB,GAAG,MAAM,GAAG,KAAK;IACpD,MAAMG,KAAK,GAAG,IAAI,CAACC,QAAQ,CAACxB,cAAc,EAAEsB,MAAM,CAAC;IAEnD,OAAO;MACLC,KAAK;MACLD;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEG,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMR,eAAe,GAAGO,KAAK,CAACE,kBAAkB,CAAC,CAAC;IAClD,MAAMC,MAAM,GAAG,IAAI,CAACX,eAAe,CAAEC,eAAe,CAAC;IACrD,MAAMW,gBAAgB,GAAG,IAAIhC,gBAAgB,CAAC;MAACM,MAAM,EAAE,IAAI,CAACa;IAAO,CAAC,CAAC;IAErEa,gBAAgB,CAACC,QAAQ,CAACF,MAAM,CAACN,KAAK,CAAC;IACvCO,gBAAgB,CAACE,SAAS,CAACH,MAAM,CAACP,MAAM,CAAC;IAEzC,OAAOQ,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEG,YAAYA,CAACP,KAAK,EAAEC,UAAU,EAAE;IAC9B,OAAO,IAAI;EACb;AACF","ignoreList":[]}
+{"version":3,"file":"RelatedKeywordsAssessment.js","names":["merge","AssessmentResult","Assessment","RELATED_KEYWORDS_ID","RelatedKeywordsAssessment","constructor","config","defaultConfig","id","fixPosition","ctaType","docUrl","priority","title","content","good","bad","improve","identifier","_config","calculateResult","data","relatedKeywords","totalWordUsed","words","isWordUsedExceeding","status","related_keywords","length","score","getScore","getResult","paper","researcher","getResearch","getData","result","assessmentResult","setScore","setStatus","setData","isApplicable","hasRelatedKeywords"],"sources":["../../../../../src/scoring/assessments/readability/RelatedKeywordsAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\nimport {RELATED_KEYWORDS_ID} from '@axyseo/const/analysis';\n\n/**\n * Represents the assessment that checks whether there are enough transition words in the text.\n */\nexport default class RelatedKeywordsAssessment 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: RELATED_KEYWORDS_ID,\n      fixPosition: 'description',\n      ctaType: 'fix',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#related-keywords',\n      priority: 'high',\n      title: 'Related keywords',\n      content: {\n        good: 'Related keyword density is optimized',\n        bad:\n          'Consider using at least a related keyword in your page to establish topical relevance.',\n        improve: 'Too high related keyword density. Keep related keyword density from 0.5% - 1%.'\n      }\n    };\n\n    this.identifier = RELATED_KEYWORDS_ID;\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   *\n   * @param data\n   * @param relatedKeywords\n   * @returns {{score: number, status: string, words}}\n   */\n  calculateResult(data, relatedKeywords) {\n    const {totalWordUsed, words, isWordUsedExceeding} = relatedKeywords;\n    let status = 'good';\n    if (!data?.related_keywords?.length || totalWordUsed <= 0) {\n      status = 'bad';\n    }\n\n    if (isWordUsedExceeding) {\n      status = 'improve';\n    }\n\n    const score = this.getScore(this._config.priority, status);\n\n    return {\n      score,\n      status,\n      words\n    };\n  }\n\n  /**\n   *\n   * @param paper\n   * @param researcher\n   * @returns {AssessmentResult}\n   */\n  getResult({paper, researcher}) {\n    const relatedKeywords = researcher.getResearch('checkRelatedKeywords');\n    const data = paper.getData();\n\n    const result = this.calculateResult(data, relatedKeywords);\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(result.score);\n    assessmentResult.setStatus(result.status);\n    assessmentResult.setData(result.words);\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    return paper.hasRelatedKeywords();\n  }\n}\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,QAAQ;AAC5B,OAAOC,gBAAgB;AACvB,OAAOC,UAAU;AACjB,SAAQC,mBAAmB;;AAE3B;AACA;AACA;AACA,eAAe,MAAMC,yBAAyB,SAASF,UAAU,CAAC;EAChE;AACF;AACA;AACA;AACA;AACA;AACA;EACEG,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEL,mBAAmB;MACvBM,WAAW,EAAE,aAAa;MAC1BC,OAAO,EAAE,KAAK;MACdC,MAAM,EACJ,8FAA8F;MAChGC,QAAQ,EAAE,MAAM;MAChBC,KAAK,EAAE,kBAAkB;MACzBC,OAAO,EAAE;QACPC,IAAI,EAAE,sCAAsC;QAC5CC,GAAG,EACD,wFAAwF;QAC1FC,OAAO,EAAE;MACX;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGf,mBAAmB;IACrC,IAAI,CAACgB,OAAO,GAAGnB,KAAK,CAACO,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEc,eAAeA,CAACC,IAAI,EAAEC,eAAe,EAAE;IACrC,MAAM;MAACC,aAAa;MAAEC,KAAK;MAAEC;IAAmB,CAAC,GAAGH,eAAe;IACnE,IAAII,MAAM,GAAG,MAAM;IACnB,IAAI,CAACL,IAAI,EAAEM,gBAAgB,EAAEC,MAAM,IAAIL,aAAa,IAAI,CAAC,EAAE;MACzDG,MAAM,GAAG,KAAK;IAChB;IAEA,IAAID,mBAAmB,EAAE;MACvBC,MAAM,GAAG,SAAS;IACpB;IAEA,MAAMG,KAAK,GAAG,IAAI,CAACC,QAAQ,CAAC,IAAI,CAACX,OAAO,CAACP,QAAQ,EAAEc,MAAM,CAAC;IAE1D,OAAO;MACLG,KAAK;MACLH,MAAM;MACNF;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEO,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMX,eAAe,GAAGW,UAAU,CAACC,WAAW,CAAC,sBAAsB,CAAC;IACtE,MAAMb,IAAI,GAAGW,KAAK,CAACG,OAAO,CAAC,CAAC;IAE5B,MAAMC,MAAM,GAAG,IAAI,CAAChB,eAAe,CAACC,IAAI,EAAEC,eAAe,CAAC;IAC1D,MAAMe,gBAAgB,GAAG,IAAIpC,gBAAgB,CAAC;MAACK,MAAM,EAAE,IAAI,CAACa;IAAO,CAAC,CAAC;IAErEkB,gBAAgB,CAACC,QAAQ,CAACF,MAAM,CAACP,KAAK,CAAC;IACvCQ,gBAAgB,CAACE,SAAS,CAACH,MAAM,CAACV,MAAM,CAAC;IACzCW,gBAAgB,CAACG,OAAO,CAACJ,MAAM,CAACZ,KAAK,CAAC;IAEtC,OAAOa,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEI,YAAYA,CAACT,KAAK,EAAEC,UAAU,EAAE;IAC9B,OAAOD,KAAK,CAACU,kBAAkB,CAAC,CAAC;EACnC;AACF","ignoreList":[]}

package/build/esm/scoring/assessments/readability/SentenceBeginningsAssessment.js

@@ -2,7 +2,7 @@ import { merge, partition, sortBy } from 'lodash';
 import AssessmentResult from "../../../values/AssessmentResult";
 import Assessment from "../assessment";
 import { TextBlockIcon } from '@shopify/polaris-icons';
-import { MAIN_CONTENT_POINTS, SENTENCE_BEGINNINGS_ID } from "../../../const/analysis";
+import { SENTENCE_BEGINNINGS_ID } from "../../../const/analysis";
 const maximumConsecutiveDuplicates = 2;
 
 /**
@@ -73,7 +73,7 @@ export default class SentenceBeginningsAssessment extends Assessment {
     } else {
       status = 'good';
     }
-    const score = this.getScore(MAIN_CONTENT_POINTS, status);
+    const score = this.getScore(this._config.priority, status);
     return {
       score,
       status

package/build/esm/scoring/assessments/readability/SentenceBeginningsAssessment.js.map

@@ -1 +1 @@
-{"version":3,"file":"SentenceBeginningsAssessment.js","names":["merge","partition","sortBy","AssessmentResult","Assessment","TextBlockIcon","MAIN_CONTENT_POINTS","SENTENCE_BEGINNINGS_ID","maximumConsecutiveDuplicates","SentenceBeginningsAssessment","constructor","config","defaultConfig","id","priority","ctaType","docUrl","fixPosition","icon","title","content","improve","bad","good","identifier","_config","groupSentenceBeginnings","sentenceBeginnings","tooOften","word","count","length","total","sortedCounts","lowestCount","calculateSentenceBeginningsResult","groupedSentenceBeginnings","status","score","getScore","getResult","paper","researcher","getResearch","sentenceBeginningsErrors","filter","sentenceBeginning","calculatedResult","assessmentResult","setData","setScore","setStatus","isApplicable","hasEnoughContentForAssessment","hasResearch"],"sources":["../../../../../src/scoring/assessments/readability/SentenceBeginningsAssessment.js"],"sourcesContent":["import {merge, partition, sortBy} from 'lodash';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\nimport {TextBlockIcon} from '@shopify/polaris-icons';\nimport {MAIN_CONTENT_POINTS, SENTENCE_BEGINNINGS_ID} from '@axyseo/const/analysis';\n\nconst maximumConsecutiveDuplicates = 2;\n\n/**\n * Represents the assessment that checks whether there are three or more consecutive sentences beginning with the same word.\n */\nexport default class SentenceBeginningsAssessment 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: SENTENCE_BEGINNINGS_ID,\n      priority: 'medium',\n      ctaType: 'fix',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#sentence-beginnings',\n      fixPosition: 'description',\n      icon: TextBlockIcon,\n      title: 'Sentence beginnings',\n      content: {\n        improve: '',\n        bad:\n          'Found sentences with repetitive beginnings. Change the wording for more engaging content.',\n        good: 'No sentences with repetitive beginnings found.'\n      }\n    };\n\n    this.identifier = SENTENCE_BEGINNINGS_ID;\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Counts and groups the number too often used sentence beginnings and determines the lowest count within that group.\n   *\n   * @param {array} sentenceBeginnings The array containing the objects containing the beginning words and counts.\n   *\n   * @returns {object} The object containing the total number of too often used beginnings and the lowest count within those.\n   */\n  groupSentenceBeginnings(sentenceBeginnings) {\n    const tooOften = partition(sentenceBeginnings, function(word) {\n      return word.count > maximumConsecutiveDuplicates;\n    });\n\n    if (tooOften[0].length === 0) {\n      return {total: 0};\n    }\n\n    const sortedCounts = sortBy(tooOften[0], function(word) {\n      return word.count;\n    });\n\n    return {total: tooOften[0].length, lowestCount: sortedCounts[0].count};\n  }\n\n  /**\n   *\n   * @param groupedSentenceBeginnings\n   * @returns {{score: number, status: string}}\n   */\n  calculateSentenceBeginningsResult(groupedSentenceBeginnings) {\n    let status = '';\n    if (groupedSentenceBeginnings.total > 0) {\n      status = 'bad';\n    } else {\n      status = 'good';\n    }\n\n    const score = this.getScore(MAIN_CONTENT_POINTS, status);\n\n    return {\n      score,\n      status\n    };\n  }\n\n  /**\n   *\n   * @param paper\n   * @param researcher\n   * @returns {AssessmentResult}\n   */\n  getResult({paper, researcher}) {\n    const sentenceBeginnings = researcher.getResearch('getSentenceBeginnings');\n    const sentenceBeginningsErrors = sentenceBeginnings.filter(\n      sentenceBeginning => sentenceBeginning.count > maximumConsecutiveDuplicates\n    );\n\n    const groupedSentenceBeginnings = this.groupSentenceBeginnings(sentenceBeginnings);\n    const calculatedResult = this.calculateSentenceBeginningsResult(groupedSentenceBeginnings);\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setData(sentenceBeginningsErrors);\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks if the sentence beginnings assessment is applicable to the paper.\n   *\n   * @param {Object}      paper       The paper to check.\n   * @param {Researcher}  researcher  The researcher object.\n   *\n   * @returns {boolean} Returns true if the language is available and the paper is not empty.\n   */\n  isApplicable(paper, researcher) {\n    return (\n      this.hasEnoughContentForAssessment(paper) && researcher.hasResearch('getSentenceBeginnings')\n    );\n  }\n}\n"],"mappings":"AAAA,SAAQA,KAAK,EAAEC,SAAS,EAAEC,MAAM,QAAO,QAAQ;AAC/C,OAAOC,gBAAgB;AACvB,OAAOC,UAAU;AACjB,SAAQC,aAAa,QAAO,wBAAwB;AACpD,SAAQC,mBAAmB,EAAEC,sBAAsB;AAEnD,MAAMC,4BAA4B,GAAG,CAAC;;AAEtC;AACA;AACA;AACA,eAAe,MAAMC,4BAA4B,SAASL,UAAU,CAAC;EACnE;AACF;AACA;AACA;AACA;AACA;AACA;EACEM,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEN,sBAAsB;MAC1BO,QAAQ,EAAE,QAAQ;MAClBC,OAAO,EAAE,KAAK;MACdC,MAAM,EACJ,iGAAiG;MACnGC,WAAW,EAAE,aAAa;MAC1BC,IAAI,EAAEb,aAAa;MACnBc,KAAK,EAAE,qBAAqB;MAC5BC,OAAO,EAAE;QACPC,OAAO,EAAE,EAAE;QACXC,GAAG,EACD,2FAA2F;QAC7FC,IAAI,EAAE;MACR;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGjB,sBAAsB;IACxC,IAAI,CAACkB,OAAO,GAAGzB,KAAK,CAACY,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEe,uBAAuBA,CAACC,kBAAkB,EAAE;IAC1C,MAAMC,QAAQ,GAAG3B,SAAS,CAAC0B,kBAAkB,EAAE,UAASE,IAAI,EAAE;MAC5D,OAAOA,IAAI,CAACC,KAAK,GAAGtB,4BAA4B;IAClD,CAAC,CAAC;IAEF,IAAIoB,QAAQ,CAAC,CAAC,CAAC,CAACG,MAAM,KAAK,CAAC,EAAE;MAC5B,OAAO;QAACC,KAAK,EAAE;MAAC,CAAC;IACnB;IAEA,MAAMC,YAAY,GAAG/B,MAAM,CAAC0B,QAAQ,CAAC,CAAC,CAAC,EAAE,UAASC,IAAI,EAAE;MACtD,OAAOA,IAAI,CAACC,KAAK;IACnB,CAAC,CAAC;IAEF,OAAO;MAACE,KAAK,EAAEJ,QAAQ,CAAC,CAAC,CAAC,CAACG,MAAM;MAAEG,WAAW,EAAED,YAAY,CAAC,CAAC,CAAC,CAACH;IAAK,CAAC;EACxE;;EAEA;AACF;AACA;AACA;AACA;EACEK,iCAAiCA,CAACC,yBAAyB,EAAE;IAC3D,IAAIC,MAAM,GAAG,EAAE;IACf,IAAID,yBAAyB,CAACJ,KAAK,GAAG,CAAC,EAAE;MACvCK,MAAM,GAAG,KAAK;IAChB,CAAC,MAAM;MACLA,MAAM,GAAG,MAAM;IACjB;IAEA,MAAMC,KAAK,GAAG,IAAI,CAACC,QAAQ,CAACjC,mBAAmB,EAAE+B,MAAM,CAAC;IAExD,OAAO;MACLC,KAAK;MACLD;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEG,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMf,kBAAkB,GAAGe,UAAU,CAACC,WAAW,CAAC,uBAAuB,CAAC;IAC1E,MAAMC,wBAAwB,GAAGjB,kBAAkB,CAACkB,MAAM,CACxDC,iBAAiB,IAAIA,iBAAiB,CAAChB,KAAK,GAAGtB,4BACjD,CAAC;IAED,MAAM4B,yBAAyB,GAAG,IAAI,CAACV,uBAAuB,CAACC,kBAAkB,CAAC;IAClF,MAAMoB,gBAAgB,GAAG,IAAI,CAACZ,iCAAiC,CAACC,yBAAyB,CAAC;IAC1F,MAAMY,gBAAgB,GAAG,IAAI7C,gBAAgB,CAAC;MAACQ,MAAM,EAAE,IAAI,CAACc;IAAO,CAAC,CAAC;IAErEuB,gBAAgB,CAACC,OAAO,CAACL,wBAAwB,CAAC;IAClDI,gBAAgB,CAACE,QAAQ,CAACH,gBAAgB,CAACT,KAAK,CAAC;IACjDU,gBAAgB,CAACG,SAAS,CAACJ,gBAAgB,CAACV,MAAM,CAAC;IAEnD,OAAOW,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEI,YAAYA,CAACX,KAAK,EAAEC,UAAU,EAAE;IAC9B,OACE,IAAI,CAACW,6BAA6B,CAACZ,KAAK,CAAC,IAAIC,UAAU,CAACY,WAAW,CAAC,uBAAuB,CAAC;EAEhG;AACF","ignoreList":[]}
+{"version":3,"file":"SentenceBeginningsAssessment.js","names":["merge","partition","sortBy","AssessmentResult","Assessment","TextBlockIcon","SENTENCE_BEGINNINGS_ID","maximumConsecutiveDuplicates","SentenceBeginningsAssessment","constructor","config","defaultConfig","id","priority","ctaType","docUrl","fixPosition","icon","title","content","improve","bad","good","identifier","_config","groupSentenceBeginnings","sentenceBeginnings","tooOften","word","count","length","total","sortedCounts","lowestCount","calculateSentenceBeginningsResult","groupedSentenceBeginnings","status","score","getScore","getResult","paper","researcher","getResearch","sentenceBeginningsErrors","filter","sentenceBeginning","calculatedResult","assessmentResult","setData","setScore","setStatus","isApplicable","hasEnoughContentForAssessment","hasResearch"],"sources":["../../../../../src/scoring/assessments/readability/SentenceBeginningsAssessment.js"],"sourcesContent":["import {merge, partition, sortBy} from 'lodash';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\nimport {TextBlockIcon} from '@shopify/polaris-icons';\nimport {SENTENCE_BEGINNINGS_ID} from '@axyseo/const/analysis';\n\nconst maximumConsecutiveDuplicates = 2;\n\n/**\n * Represents the assessment that checks whether there are three or more consecutive sentences beginning with the same word.\n */\nexport default class SentenceBeginningsAssessment 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: SENTENCE_BEGINNINGS_ID,\n      priority: 'medium',\n      ctaType: 'fix',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#sentence-beginnings',\n      fixPosition: 'description',\n      icon: TextBlockIcon,\n      title: 'Sentence beginnings',\n      content: {\n        improve: '',\n        bad:\n          'Found sentences with repetitive beginnings. Change the wording for more engaging content.',\n        good: 'No sentences with repetitive beginnings found.'\n      }\n    };\n\n    this.identifier = SENTENCE_BEGINNINGS_ID;\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Counts and groups the number too often used sentence beginnings and determines the lowest count within that group.\n   *\n   * @param {array} sentenceBeginnings The array containing the objects containing the beginning words and counts.\n   *\n   * @returns {object} The object containing the total number of too often used beginnings and the lowest count within those.\n   */\n  groupSentenceBeginnings(sentenceBeginnings) {\n    const tooOften = partition(sentenceBeginnings, function(word) {\n      return word.count > maximumConsecutiveDuplicates;\n    });\n\n    if (tooOften[0].length === 0) {\n      return {total: 0};\n    }\n\n    const sortedCounts = sortBy(tooOften[0], function(word) {\n      return word.count;\n    });\n\n    return {total: tooOften[0].length, lowestCount: sortedCounts[0].count};\n  }\n\n  /**\n   *\n   * @param groupedSentenceBeginnings\n   * @returns {{score: number, status: string}}\n   */\n  calculateSentenceBeginningsResult(groupedSentenceBeginnings) {\n    let status = '';\n    if (groupedSentenceBeginnings.total > 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    };\n  }\n\n  /**\n   *\n   * @param paper\n   * @param researcher\n   * @returns {AssessmentResult}\n   */\n  getResult({paper, researcher}) {\n    const sentenceBeginnings = researcher.getResearch('getSentenceBeginnings');\n    const sentenceBeginningsErrors = sentenceBeginnings.filter(\n      sentenceBeginning => sentenceBeginning.count > maximumConsecutiveDuplicates\n    );\n\n    const groupedSentenceBeginnings = this.groupSentenceBeginnings(sentenceBeginnings);\n    const calculatedResult = this.calculateSentenceBeginningsResult(groupedSentenceBeginnings);\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setData(sentenceBeginningsErrors);\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks if the sentence beginnings assessment is applicable to the paper.\n   *\n   * @param {Object}      paper       The paper to check.\n   * @param {Researcher}  researcher  The researcher object.\n   *\n   * @returns {boolean} Returns true if the language is available and the paper is not empty.\n   */\n  isApplicable(paper, researcher) {\n    return (\n      this.hasEnoughContentForAssessment(paper) && researcher.hasResearch('getSentenceBeginnings')\n    );\n  }\n}\n"],"mappings":"AAAA,SAAQA,KAAK,EAAEC,SAAS,EAAEC,MAAM,QAAO,QAAQ;AAC/C,OAAOC,gBAAgB;AACvB,OAAOC,UAAU;AACjB,SAAQC,aAAa,QAAO,wBAAwB;AACpD,SAAQC,sBAAsB;AAE9B,MAAMC,4BAA4B,GAAG,CAAC;;AAEtC;AACA;AACA;AACA,eAAe,MAAMC,4BAA4B,SAASJ,UAAU,CAAC;EACnE;AACF;AACA;AACA;AACA;AACA;AACA;EACEK,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEN,sBAAsB;MAC1BO,QAAQ,EAAE,QAAQ;MAClBC,OAAO,EAAE,KAAK;MACdC,MAAM,EACJ,iGAAiG;MACnGC,WAAW,EAAE,aAAa;MAC1BC,IAAI,EAAEZ,aAAa;MACnBa,KAAK,EAAE,qBAAqB;MAC5BC,OAAO,EAAE;QACPC,OAAO,EAAE,EAAE;QACXC,GAAG,EACD,2FAA2F;QAC7FC,IAAI,EAAE;MACR;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGjB,sBAAsB;IACxC,IAAI,CAACkB,OAAO,GAAGxB,KAAK,CAACW,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEe,uBAAuBA,CAACC,kBAAkB,EAAE;IAC1C,MAAMC,QAAQ,GAAG1B,SAAS,CAACyB,kBAAkB,EAAE,UAASE,IAAI,EAAE;MAC5D,OAAOA,IAAI,CAACC,KAAK,GAAGtB,4BAA4B;IAClD,CAAC,CAAC;IAEF,IAAIoB,QAAQ,CAAC,CAAC,CAAC,CAACG,MAAM,KAAK,CAAC,EAAE;MAC5B,OAAO;QAACC,KAAK,EAAE;MAAC,CAAC;IACnB;IAEA,MAAMC,YAAY,GAAG9B,MAAM,CAACyB,QAAQ,CAAC,CAAC,CAAC,EAAE,UAASC,IAAI,EAAE;MACtD,OAAOA,IAAI,CAACC,KAAK;IACnB,CAAC,CAAC;IAEF,OAAO;MAACE,KAAK,EAAEJ,QAAQ,CAAC,CAAC,CAAC,CAACG,MAAM;MAAEG,WAAW,EAAED,YAAY,CAAC,CAAC,CAAC,CAACH;IAAK,CAAC;EACxE;;EAEA;AACF;AACA;AACA;AACA;EACEK,iCAAiCA,CAACC,yBAAyB,EAAE;IAC3D,IAAIC,MAAM,GAAG,EAAE;IACf,IAAID,yBAAyB,CAACJ,KAAK,GAAG,CAAC,EAAE;MACvCK,MAAM,GAAG,KAAK;IAChB,CAAC,MAAM;MACLA,MAAM,GAAG,MAAM;IACjB;IAEA,MAAMC,KAAK,GAAG,IAAI,CAACC,QAAQ,CAAC,IAAI,CAACd,OAAO,CAACX,QAAQ,EAAEuB,MAAM,CAAC;IAE1D,OAAO;MACLC,KAAK;MACLD;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEG,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMf,kBAAkB,GAAGe,UAAU,CAACC,WAAW,CAAC,uBAAuB,CAAC;IAC1E,MAAMC,wBAAwB,GAAGjB,kBAAkB,CAACkB,MAAM,CACxDC,iBAAiB,IAAIA,iBAAiB,CAAChB,KAAK,GAAGtB,4BACjD,CAAC;IAED,MAAM4B,yBAAyB,GAAG,IAAI,CAACV,uBAAuB,CAACC,kBAAkB,CAAC;IAClF,MAAMoB,gBAAgB,GAAG,IAAI,CAACZ,iCAAiC,CAACC,yBAAyB,CAAC;IAC1F,MAAMY,gBAAgB,GAAG,IAAI5C,gBAAgB,CAAC;MAACO,MAAM,EAAE,IAAI,CAACc;IAAO,CAAC,CAAC;IAErEuB,gBAAgB,CAACC,OAAO,CAACL,wBAAwB,CAAC;IAClDI,gBAAgB,CAACE,QAAQ,CAACH,gBAAgB,CAACT,KAAK,CAAC;IACjDU,gBAAgB,CAACG,SAAS,CAACJ,gBAAgB,CAACV,MAAM,CAAC;IAEnD,OAAOW,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEI,YAAYA,CAACX,KAAK,EAAEC,UAAU,EAAE;IAC9B,OACE,IAAI,CAACW,6BAA6B,CAACZ,KAAK,CAAC,IAAIC,UAAU,CAACY,WAAW,CAAC,uBAAuB,CAAC;EAEhG;AACF","ignoreList":[]}

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

@@ -4,7 +4,7 @@ import getTooLongSentences from "../../helpers/assessments/checkForTooLongSenten
 import formatNumber from "../../../helpers/formatNumber";
 import AssessmentResult from "../../../values/AssessmentResult";
 import { TextBlockIcon } from '@shopify/polaris-icons';
-import { MAIN_CONTENT_POINTS, TEXT_SENTENCE_LENGTH_ID } from "../../../const/analysis";
+import { TEXT_SENTENCE_LENGTH_ID } from "../../../const/analysis";
 
 /**
  * Represents the assessment that will calculate the length of sentences in the text.
@@ -54,13 +54,11 @@ class SentenceLengthInTextAssessment extends Assessment {
     researcher
   }) {
     const sentences = researcher.getResearch('countSentencesFromText');
-    const hasDescription = paper.hasDescription();
     if (researcher.getConfig('sentenceLength')) {
       this._config = this.getLanguageSpecificConfig(researcher);
     }
-    console.log('sentences', sentences);
     const percentage = this.calculatePercentage(sentences);
-    const result = this.calculateResult(percentage, hasDescription);
+    const result = this.calculateResult(percentage);
     const assessmentResult = new AssessmentResult({
       config: this._config
     });
@@ -77,7 +75,7 @@ class SentenceLengthInTextAssessment extends Assessment {
    * @returns {boolean} True when there is text.
    */
   isApplicable(paper) {
-    return true;
+    return this.hasEnoughContentForAssessment(paper);
   }
 
   /**
@@ -106,7 +104,6 @@ class SentenceLengthInTextAssessment extends Assessment {
     let percentage = 0;
     if (sentences.length !== 0) {
       const tooLongTotal = this.countTooLongSentences(sentences);
-      console.log('tooLongTotal', tooLongTotal);
       percentage = formatNumber(tooLongTotal / sentences.length * 100);
     }
     return percentage;
@@ -115,19 +112,21 @@ class SentenceLengthInTextAssessment extends Assessment {
   /**
    *
    * @param percentage
-   * @param hasDescription
    * @returns {{score: number, status: string}}
    */
-  calculateResult(percentage, hasDescription) {
-    let status = 'bad';
-    if (percentage <= 0 && hasDescription && percentage <= this._config.recommendedLength) {
+  calculateResult(percentage) {
+    let status = '';
+    if (percentage <= this._config.recommendedLength) {
       status = 'good';
     }
-    const score = this.getScore(MAIN_CONTENT_POINTS, status);
+    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: `Sentences optimized`
+      good: `Sentence length is optimized for readability, less than ${this._config.recommendedLength} words.`
     };
     return {
       score,

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

@@ -1 +1 @@
-{"version":3,"file":"SentenceLengthInTextAssessment.js","names":["merge","Assessment","getTooLongSentences","formatNumber","AssessmentResult","TextBlockIcon","MAIN_CONTENT_POINTS","TEXT_SENTENCE_LENGTH_ID","SentenceLengthInTextAssessment","constructor","config","isCornerstone","isProduct","defaultConfig","id","priority","docUrl","ctaType","fixPosition","icon","recommendedLength","slightlyTooMany","farTooMany","title","content","improve","bad","good","_config","identifier","getResult","paper","researcher","sentences","getResearch","hasDescription","getConfig","getLanguageSpecificConfig","console","log","percentage","calculatePercentage","result","calculateResult","assessmentResult","setScore","score","setStatus","status","isApplicable","currentConfig","languageSpecificConfig","hasOwnProperty","length","tooLongTotal","countTooLongSentences","getScore"],"sources":["../../../../../src/scoring/assessments/readability/SentenceLengthInTextAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport Assessment from '../assessment';\nimport getTooLongSentences from '../../helpers/assessments/checkForTooLongSentences';\nimport formatNumber from '../../../helpers/formatNumber';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {TextBlockIcon} from '@shopify/polaris-icons';\nimport {MAIN_CONTENT_POINTS, TEXT_SENTENCE_LENGTH_ID} from '@axyseo/const/analysis';\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: TEXT_SENTENCE_LENGTH_ID,\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 = TEXT_SENTENCE_LENGTH_ID;\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   * @returns {AssessmentResult} The Assessment result.\n   */\n  getResult({paper, researcher}) {\n    const sentences = researcher.getResearch('countSentencesFromText');\n    const hasDescription = paper.hasDescription();\n    if (researcher.getConfig('sentenceLength')) {\n      this._config = this.getLanguageSpecificConfig(researcher);\n    }\n    console.log('sentences', sentences);\n    const percentage = this.calculatePercentage(sentences);\n    const result = this.calculateResult(percentage, hasDescription);\n\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(result.score);\n    assessmentResult.setStatus(result.status);\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 true;\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      console.log('tooLongTotal', tooLongTotal);\n      percentage = formatNumber((tooLongTotal / sentences.length) * 100);\n    }\n\n    return percentage;\n  }\n\n  /**\n   *\n   * @param percentage\n   * @param hasDescription\n   * @returns {{score: number, status: string}}\n   */\n  calculateResult(percentage, hasDescription) {\n    let status = 'bad';\n    if (percentage <= 0 && hasDescription && percentage <= this._config.recommendedLength) {\n      status = 'good';\n    }\n    const score = this.getScore(MAIN_CONTENT_POINTS, 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: `Sentences optimized`\n    };\n\n    return {\n      score,\n      status\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,SAAQA,KAAK,QAAO,QAAQ;AAC5B,OAAOC,UAAU;AACjB,OAAOC,mBAAmB;AAC1B,OAAOC,YAAY;AACnB,OAAOC,gBAAgB;AACvB,SAAQC,aAAa,QAAO,wBAAwB;AACpD,SAAQC,mBAAmB,EAAEC,uBAAuB;;AAEpD;AACA;AACA;AACA,MAAMC,8BAA8B,SAASP,UAAU,CAAC;EACtD;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAEEQ,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,EAAEP,uBAAuB;MAC3BQ,QAAQ,EAAE,MAAM;MAChBC,MAAM,EACJ,6FAA6F;MAC/FC,OAAO,EAAE,KAAK;MACdC,WAAW,EAAE,gBAAgB;MAC7BC,IAAI,EAAEd,aAAa;MACnBe,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,GAAG5B,KAAK,CAACa,aAAa,EAAEH,MAAM,CAAC;IAC3C,IAAI,CAACmB,UAAU,GAAGtB,uBAAuB;EAC3C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEuB,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMC,SAAS,GAAGD,UAAU,CAACE,WAAW,CAAC,wBAAwB,CAAC;IAClE,MAAMC,cAAc,GAAGJ,KAAK,CAACI,cAAc,CAAC,CAAC;IAC7C,IAAIH,UAAU,CAACI,SAAS,CAAC,gBAAgB,CAAC,EAAE;MAC1C,IAAI,CAACR,OAAO,GAAG,IAAI,CAACS,yBAAyB,CAACL,UAAU,CAAC;IAC3D;IACAM,OAAO,CAACC,GAAG,CAAC,WAAW,EAAEN,SAAS,CAAC;IACnC,MAAMO,UAAU,GAAG,IAAI,CAACC,mBAAmB,CAACR,SAAS,CAAC;IACtD,MAAMS,MAAM,GAAG,IAAI,CAACC,eAAe,CAACH,UAAU,EAAEL,cAAc,CAAC;IAE/D,MAAMS,gBAAgB,GAAG,IAAIxC,gBAAgB,CAAC;MAACM,MAAM,EAAE,IAAI,CAACkB;IAAO,CAAC,CAAC;IAErEgB,gBAAgB,CAACC,QAAQ,CAACH,MAAM,CAACI,KAAK,CAAC;IACvCF,gBAAgB,CAACG,SAAS,CAACL,MAAM,CAACM,MAAM,CAAC;IAEzC,OAAOJ,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEK,YAAYA,CAAClB,KAAK,EAAE;IAClB,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEM,yBAAyBA,CAACL,UAAU,EAAE;IACpC,MAAMkB,aAAa,GAAG,IAAI,CAACtB,OAAO;IAClC,MAAMuB,sBAAsB,GAAGnB,UAAU,CAACI,SAAS,CAAC,gBAAgB,CAAC;IAErE,IAAIe,sBAAsB,CAACC,cAAc,CAAC,mBAAmB,CAAC,EAAE;MAC9DF,aAAa,CAAC9B,iBAAiB,GAAG+B,sBAAsB,CAAC/B,iBAAiB;IAC5E;IAEA,OAAO8B,aAAa;EACtB;;EAEA;AACF;AACA;AACA;AACA;AACA;EACET,mBAAmBA,CAACR,SAAS,EAAE;IAC7B,IAAIO,UAAU,GAAG,CAAC;IAElB,IAAIP,SAAS,CAACoB,MAAM,KAAK,CAAC,EAAE;MAC1B,MAAMC,YAAY,GAAG,IAAI,CAACC,qBAAqB,CAACtB,SAAS,CAAC;MAC1DK,OAAO,CAACC,GAAG,CAAC,cAAc,EAAEe,YAAY,CAAC;MACzCd,UAAU,GAAGrC,YAAY,CAAEmD,YAAY,GAAGrB,SAAS,CAACoB,MAAM,GAAI,GAAG,CAAC;IACpE;IAEA,OAAOb,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEG,eAAeA,CAACH,UAAU,EAAEL,cAAc,EAAE;IAC1C,IAAIa,MAAM,GAAG,KAAK;IAClB,IAAIR,UAAU,IAAI,CAAC,IAAIL,cAAc,IAAIK,UAAU,IAAI,IAAI,CAACZ,OAAO,CAACR,iBAAiB,EAAE;MACrF4B,MAAM,GAAG,MAAM;IACjB;IACA,MAAMF,KAAK,GAAG,IAAI,CAACU,QAAQ,CAAClD,mBAAmB,EAAE0C,MAAM,CAAC;IAExD,IAAI,CAACpB,OAAO,CAACJ,OAAO,GAAG;MACrBC,OAAO,EAAE,EAAE;MACXC,GAAG,EAAE,qDAAqD,IAAI,CAACE,OAAO,CAACR,iBAAiB,yCAAyC;MACjIO,IAAI,EAAE;IACR,CAAC;IAED,OAAO;MACLmB,KAAK;MACLE;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE9C,mBAAmBA,CAAC+B,SAAS,EAAE;IAC7B,OAAO/B,mBAAmB,CAAC+B,SAAS,EAAE,IAAI,CAACL,OAAO,CAACR,iBAAiB,CAAC;EACvE;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEmC,qBAAqBA,CAACtB,SAAS,EAAE;IAC/B,OAAO,IAAI,CAAC/B,mBAAmB,CAAC+B,SAAS,CAAC,CAACoB,MAAM;EACnD;AACF;AAEA,eAAe7C,8BAA8B","ignoreList":[]}
+{"version":3,"file":"SentenceLengthInTextAssessment.js","names":["merge","Assessment","getTooLongSentences","formatNumber","AssessmentResult","TextBlockIcon","TEXT_SENTENCE_LENGTH_ID","SentenceLengthInTextAssessment","constructor","config","isCornerstone","isProduct","defaultConfig","id","priority","docUrl","ctaType","fixPosition","icon","recommendedLength","slightlyTooMany","farTooMany","title","content","improve","bad","good","_config","identifier","getResult","paper","researcher","sentences","getResearch","getConfig","getLanguageSpecificConfig","percentage","calculatePercentage","result","calculateResult","assessmentResult","setScore","score","setStatus","status","isApplicable","hasEnoughContentForAssessment","currentConfig","languageSpecificConfig","hasOwnProperty","length","tooLongTotal","countTooLongSentences","getScore"],"sources":["../../../../../src/scoring/assessments/readability/SentenceLengthInTextAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport Assessment from '../assessment';\nimport getTooLongSentences from '../../helpers/assessments/checkForTooLongSentences';\nimport formatNumber from '../../../helpers/formatNumber';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {TextBlockIcon} from '@shopify/polaris-icons';\nimport {TEXT_SENTENCE_LENGTH_ID} from '@axyseo/const/analysis';\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: TEXT_SENTENCE_LENGTH_ID,\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 = TEXT_SENTENCE_LENGTH_ID;\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   * @returns {AssessmentResult} The Assessment result.\n   */\n  getResult({paper, researcher}) {\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);\n\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(result.score);\n    assessmentResult.setStatus(result.status);\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   * @returns {{score: number, status: string}}\n   */\n  calculateResult(percentage) {\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    };\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,SAAQA,KAAK,QAAO,QAAQ;AAC5B,OAAOC,UAAU;AACjB,OAAOC,mBAAmB;AAC1B,OAAOC,YAAY;AACnB,OAAOC,gBAAgB;AACvB,SAAQC,aAAa,QAAO,wBAAwB;AACpD,SAAQC,uBAAuB;;AAE/B;AACA;AACA;AACA,MAAMC,8BAA8B,SAASN,UAAU,CAAC;EACtD;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAEEO,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,EAAEP,uBAAuB;MAC3BQ,QAAQ,EAAE,MAAM;MAChBC,MAAM,EACJ,6FAA6F;MAC/FC,OAAO,EAAE,KAAK;MACdC,WAAW,EAAE,gBAAgB;MAC7BC,IAAI,EAAEb,aAAa;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,GAAG3B,KAAK,CAACY,aAAa,EAAEH,MAAM,CAAC;IAC3C,IAAI,CAACmB,UAAU,GAAGtB,uBAAuB;EAC3C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEuB,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMC,SAAS,GAAGD,UAAU,CAACE,WAAW,CAAC,wBAAwB,CAAC;IAClE,IAAIF,UAAU,CAACG,SAAS,CAAC,gBAAgB,CAAC,EAAE;MAC1C,IAAI,CAACP,OAAO,GAAG,IAAI,CAACQ,yBAAyB,CAACJ,UAAU,CAAC;IAC3D;IAEA,MAAMK,UAAU,GAAG,IAAI,CAACC,mBAAmB,CAACL,SAAS,CAAC;IACtD,MAAMM,MAAM,GAAG,IAAI,CAACC,eAAe,CAACH,UAAU,CAAC;IAE/C,MAAMI,gBAAgB,GAAG,IAAIpC,gBAAgB,CAAC;MAACK,MAAM,EAAE,IAAI,CAACkB;IAAO,CAAC,CAAC;IAErEa,gBAAgB,CAACC,QAAQ,CAACH,MAAM,CAACI,KAAK,CAAC;IACvCF,gBAAgB,CAACG,SAAS,CAACL,MAAM,CAACM,MAAM,CAAC;IAEzC,OAAOJ,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEK,YAAYA,CAACf,KAAK,EAAE;IAClB,OAAO,IAAI,CAACgB,6BAA6B,CAAChB,KAAK,CAAC;EAClD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEK,yBAAyBA,CAACJ,UAAU,EAAE;IACpC,MAAMgB,aAAa,GAAG,IAAI,CAACpB,OAAO;IAClC,MAAMqB,sBAAsB,GAAGjB,UAAU,CAACG,SAAS,CAAC,gBAAgB,CAAC;IAErE,IAAIc,sBAAsB,CAACC,cAAc,CAAC,mBAAmB,CAAC,EAAE;MAC9DF,aAAa,CAAC5B,iBAAiB,GAAG6B,sBAAsB,CAAC7B,iBAAiB;IAC5E;IAEA,OAAO4B,aAAa;EACtB;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEV,mBAAmBA,CAACL,SAAS,EAAE;IAC7B,IAAII,UAAU,GAAG,CAAC;IAElB,IAAIJ,SAAS,CAACkB,MAAM,KAAK,CAAC,EAAE;MAC1B,MAAMC,YAAY,GAAG,IAAI,CAACC,qBAAqB,CAACpB,SAAS,CAAC;MAE1DI,UAAU,GAAGjC,YAAY,CAAEgD,YAAY,GAAGnB,SAAS,CAACkB,MAAM,GAAI,GAAG,CAAC;IACpE;IAEA,OAAOd,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACEG,eAAeA,CAACH,UAAU,EAAE;IAC1B,IAAIQ,MAAM,GAAG,EAAE;IACf,IAAIR,UAAU,IAAI,IAAI,CAACT,OAAO,CAACR,iBAAiB,EAAE;MAChDyB,MAAM,GAAG,MAAM;IACjB;IAEA,IAAIR,UAAU,GAAG,IAAI,CAACT,OAAO,CAACR,iBAAiB,EAAE;MAC/CyB,MAAM,GAAG,KAAK;IAChB;IAEA,MAAMF,KAAK,GAAG,IAAI,CAACW,QAAQ,CAAC,IAAI,CAAC1B,OAAO,CAACb,QAAQ,EAAE8B,MAAM,CAAC;IAE1D,IAAI,CAACjB,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;MACLuB,KAAK;MACLE;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE1C,mBAAmBA,CAAC8B,SAAS,EAAE;IAC7B,OAAO9B,mBAAmB,CAAC8B,SAAS,EAAE,IAAI,CAACL,OAAO,CAACR,iBAAiB,CAAC;EACvE;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEiC,qBAAqBA,CAACpB,SAAS,EAAE;IAC/B,OAAO,IAAI,CAAC9B,mBAAmB,CAAC8B,SAAS,CAAC,CAACkB,MAAM;EACnD;AACF;AAEA,eAAe3C,8BAA8B","ignoreList":[]}

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

@@ -6,7 +6,7 @@ import Assessment from "../assessment";
 import removeHtmlBlocks from "../../../languageProcessing/helpers/html/htmlParser";
 import getWords from "../../../languageProcessing/helpers/word/getWords";
 import { filterShortcodesFromHTML } from "../../../languageProcessing/helpers";
-import { MAIN_CONTENT_POINTS, TEXT_TRANSITION_WORDS_ID } from "../../../const/analysis";
+import { TEXT_TRANSITION_WORDS_ID } from "../../../const/analysis";
 
 /**
  * Represents the assessment that checks whether there are enough transition words in the text.
@@ -87,7 +87,7 @@ export default class TransitionWordsAssessment extends Assessment {
     if (score < 6 || percentage === 0) {
       status = 'bad';
     }
-    const customScore = this.getScore(MAIN_CONTENT_POINTS, status);
+    const customScore = this.getScore(this._config.priority, status);
     return {
       score: customScore,
       status

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

@@ -1 +1 @@
-{"version":3,"file":"TransitionWordsAssessment.js","names":["merge","formatNumber","inRangeStartInclusive","inRange","AssessmentResult","Assessment","removeHtmlBlocks","getWords","filterShortcodesFromHTML","MAIN_CONTENT_POINTS","TEXT_TRANSITION_WORDS_ID","TransitionWordsAssessment","constructor","config","defaultConfig","id","fixPosition","ctaType","docUrl","priority","applicableIfTextLongerThan","title","content","good","bad","improve","identifier","_config","calculateTransitionWordPercentage","sentences","transitionWordSentences","totalSentences","calculateScoreFromPercentage","percentage","calculateTransitionWordResult","score","status","customScore","getScore","getResult","paper","researcher","getResearch","transitionWordResult","assessmentResult","setScore","setStatus","isApplicable","customCountLength","getHelper","customApplicabilityConfig","getConfig","transitionWords","text","getText","_attributes","shortcodes","textLength","length","hasResearch"],"sources":["../../../../../src/scoring/assessments/readability/TransitionWordsAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\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';\nimport {MAIN_CONTENT_POINTS, TEXT_TRANSITION_WORDS_ID} from '@axyseo/const/analysis';\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: TEXT_TRANSITION_WORDS_ID,\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 = TEXT_TRANSITION_WORDS_ID;\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 < 10) {\n      // Red indicator.\n      return 3;\n    }\n\n    if (inRange(percentage, 10, 20)) {\n      // Orange indicator.\n      return 6;\n    }\n\n    // Green indicator.\n    return 9;\n  }\n\n  /**\n   *\n   * @param transitionWordSentences\n   * @returns {{score: number, status: string}}\n   */\n  calculateTransitionWordResult(transitionWordSentences) {\n    const percentage = this.calculateTransitionWordPercentage(transitionWordSentences);\n    const score = this.calculateScoreFromPercentage(percentage);\n\n    let status = 'good';\n    if (score < 6 || percentage === 0) {\n      status = 'bad';\n    }\n\n    const customScore = this.getScore(MAIN_CONTENT_POINTS, status);\n\n    return {\n      score: customScore,\n      status\n    };\n  }\n\n  /**\n   *\n   * @param paper\n   * @param researcher\n   * @returns {AssessmentResult}\n   */\n  getResult({paper, researcher}) {\n    const transitionWordSentences = researcher.getResearch('findTransitionWords');\n    const transitionWordResult = this.calculateTransitionWordResult(transitionWordSentences);\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(transitionWordResult.score);\n    assessmentResult.setStatus(transitionWordResult.status);\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,SAAQA,KAAK,QAAO,QAAQ;AAC5B,OAAOC,YAAY;AACnB,SAAQC,qBAAqB,IAAIC,OAAO;AACxC,OAAOC,gBAAgB;AACvB,OAAOC,UAAU;AACjB,OAAOC,gBAAgB;AACvB,OAAOC,QAAQ;AACf,SAAQC,wBAAwB;AAChC,SAAQC,mBAAmB,EAAEC,wBAAwB;;AAErD;AACA;AACA;AACA,eAAe,MAAMC,yBAAyB,SAASN,UAAU,CAAC;EAChE;AACF;AACA;AACA;AACA;AACA;AACA;EACEO,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEL,wBAAwB;MAC5BM,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,GAAGhB,wBAAwB;IAC1C,IAAI,CAACiB,OAAO,GAAG3B,KAAK,CAACc,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEe,iCAAiCA,CAACC,SAAS,EAAE;IAC3C,IAAIA,SAAS,CAACC,uBAAuB,KAAK,CAAC,IAAID,SAAS,CAACE,cAAc,KAAK,CAAC,EAAE;MAC7E,OAAO,CAAC;IACV;IAEA,OAAO9B,YAAY,CAAE4B,SAAS,CAACC,uBAAuB,GAAGD,SAAS,CAACE,cAAc,GAAI,GAAG,CAAC;EAC3F;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,4BAA4BA,CAACC,UAAU,EAAE;IACvC,IAAIA,UAAU,GAAG,EAAE,EAAE;MACnB;MACA,OAAO,CAAC;IACV;IAEA,IAAI9B,OAAO,CAAC8B,UAAU,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE;MAC/B;MACA,OAAO,CAAC;IACV;;IAEA;IACA,OAAO,CAAC;EACV;;EAEA;AACF;AACA;AACA;AACA;EACEC,6BAA6BA,CAACJ,uBAAuB,EAAE;IACrD,MAAMG,UAAU,GAAG,IAAI,CAACL,iCAAiC,CAACE,uBAAuB,CAAC;IAClF,MAAMK,KAAK,GAAG,IAAI,CAACH,4BAA4B,CAACC,UAAU,CAAC;IAE3D,IAAIG,MAAM,GAAG,MAAM;IACnB,IAAID,KAAK,GAAG,CAAC,IAAIF,UAAU,KAAK,CAAC,EAAE;MACjCG,MAAM,GAAG,KAAK;IAChB;IAEA,MAAMC,WAAW,GAAG,IAAI,CAACC,QAAQ,CAAC7B,mBAAmB,EAAE2B,MAAM,CAAC;IAE9D,OAAO;MACLD,KAAK,EAAEE,WAAW;MAClBD;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEG,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMX,uBAAuB,GAAGW,UAAU,CAACC,WAAW,CAAC,qBAAqB,CAAC;IAC7E,MAAMC,oBAAoB,GAAG,IAAI,CAACT,6BAA6B,CAACJ,uBAAuB,CAAC;IACxF,MAAMc,gBAAgB,GAAG,IAAIxC,gBAAgB,CAAC;MAACS,MAAM,EAAE,IAAI,CAACc;IAAO,CAAC,CAAC;IAErEiB,gBAAgB,CAACC,QAAQ,CAACF,oBAAoB,CAACR,KAAK,CAAC;IACrDS,gBAAgB,CAACE,SAAS,CAACH,oBAAoB,CAACP,MAAM,CAAC;IAEvD,OAAOQ,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEG,YAAYA,CAACP,KAAK,EAAEC,UAAU,EAAE;IAC9B,MAAMO,iBAAiB,GAAGP,UAAU,CAACQ,SAAS,CAAC,mBAAmB,CAAC;IACnE,MAAMC,yBAAyB,GAAGT,UAAU,CAACU,SAAS,CAAC,yBAAyB,CAAC,CAC9EC,eAAe;IAClB,IAAIF,yBAAyB,EAAE;MAC7B,IAAI,CAACvB,OAAO,CAACP,0BAA0B,GAAG8B,yBAAyB;IACrE;IACA,IAAIG,IAAI,GAAGb,KAAK,CAACc,OAAO,CAAC,CAAC;IAC1BD,IAAI,GAAG/C,gBAAgB,CAAC+C,IAAI,CAAC;IAC7BA,IAAI,GAAG7C,wBAAwB,CAAC6C,IAAI,EAAEb,KAAK,CAACe,WAAW,IAAIf,KAAK,CAACe,WAAW,CAACC,UAAU,CAAC;IACxF,MAAMC,UAAU,GAAGT,iBAAiB,GAAGA,iBAAiB,CAACK,IAAI,CAAC,GAAG9C,QAAQ,CAAC8C,IAAI,CAAC,CAACK,MAAM;;IAEtF;IACA,OACED,UAAU,IAAI,IAAI,CAAC9B,OAAO,CAACP,0BAA0B,IACrDqB,UAAU,CAACkB,WAAW,CAAC,qBAAqB,CAAC;EAEjD;AACF","ignoreList":[]}
+{"version":3,"file":"TransitionWordsAssessment.js","names":["merge","formatNumber","inRangeStartInclusive","inRange","AssessmentResult","Assessment","removeHtmlBlocks","getWords","filterShortcodesFromHTML","TEXT_TRANSITION_WORDS_ID","TransitionWordsAssessment","constructor","config","defaultConfig","id","fixPosition","ctaType","docUrl","priority","applicableIfTextLongerThan","title","content","good","bad","improve","identifier","_config","calculateTransitionWordPercentage","sentences","transitionWordSentences","totalSentences","calculateScoreFromPercentage","percentage","calculateTransitionWordResult","score","status","customScore","getScore","getResult","paper","researcher","getResearch","transitionWordResult","assessmentResult","setScore","setStatus","isApplicable","customCountLength","getHelper","customApplicabilityConfig","getConfig","transitionWords","text","getText","_attributes","shortcodes","textLength","length","hasResearch"],"sources":["../../../../../src/scoring/assessments/readability/TransitionWordsAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\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';\nimport {TEXT_TRANSITION_WORDS_ID} from '@axyseo/const/analysis';\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: TEXT_TRANSITION_WORDS_ID,\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 = TEXT_TRANSITION_WORDS_ID;\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 < 10) {\n      // Red indicator.\n      return 3;\n    }\n\n    if (inRange(percentage, 10, 20)) {\n      // Orange indicator.\n      return 6;\n    }\n\n    // Green indicator.\n    return 9;\n  }\n\n  /**\n   *\n   * @param transitionWordSentences\n   * @returns {{score: number, status: string}}\n   */\n  calculateTransitionWordResult(transitionWordSentences) {\n    const percentage = this.calculateTransitionWordPercentage(transitionWordSentences);\n    const score = this.calculateScoreFromPercentage(percentage);\n\n    let status = 'good';\n    if (score < 6 || percentage === 0) {\n      status = 'bad';\n    }\n\n    const customScore = this.getScore(this._config.priority, status);\n\n    return {\n      score: customScore,\n      status\n    };\n  }\n\n  /**\n   *\n   * @param paper\n   * @param researcher\n   * @returns {AssessmentResult}\n   */\n  getResult({paper, researcher}) {\n    const transitionWordSentences = researcher.getResearch('findTransitionWords');\n    const transitionWordResult = this.calculateTransitionWordResult(transitionWordSentences);\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(transitionWordResult.score);\n    assessmentResult.setStatus(transitionWordResult.status);\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,SAAQA,KAAK,QAAO,QAAQ;AAC5B,OAAOC,YAAY;AACnB,SAAQC,qBAAqB,IAAIC,OAAO;AACxC,OAAOC,gBAAgB;AACvB,OAAOC,UAAU;AACjB,OAAOC,gBAAgB;AACvB,OAAOC,QAAQ;AACf,SAAQC,wBAAwB;AAChC,SAAQC,wBAAwB;;AAEhC;AACA;AACA;AACA,eAAe,MAAMC,yBAAyB,SAASL,UAAU,CAAC;EAChE;AACF;AACA;AACA;AACA;AACA;AACA;EACEM,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEL,wBAAwB;MAC5BM,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,GAAGhB,wBAAwB;IAC1C,IAAI,CAACiB,OAAO,GAAG1B,KAAK,CAACa,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEe,iCAAiCA,CAACC,SAAS,EAAE;IAC3C,IAAIA,SAAS,CAACC,uBAAuB,KAAK,CAAC,IAAID,SAAS,CAACE,cAAc,KAAK,CAAC,EAAE;MAC7E,OAAO,CAAC;IACV;IAEA,OAAO7B,YAAY,CAAE2B,SAAS,CAACC,uBAAuB,GAAGD,SAAS,CAACE,cAAc,GAAI,GAAG,CAAC;EAC3F;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,4BAA4BA,CAACC,UAAU,EAAE;IACvC,IAAIA,UAAU,GAAG,EAAE,EAAE;MACnB;MACA,OAAO,CAAC;IACV;IAEA,IAAI7B,OAAO,CAAC6B,UAAU,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE;MAC/B;MACA,OAAO,CAAC;IACV;;IAEA;IACA,OAAO,CAAC;EACV;;EAEA;AACF;AACA;AACA;AACA;EACEC,6BAA6BA,CAACJ,uBAAuB,EAAE;IACrD,MAAMG,UAAU,GAAG,IAAI,CAACL,iCAAiC,CAACE,uBAAuB,CAAC;IAClF,MAAMK,KAAK,GAAG,IAAI,CAACH,4BAA4B,CAACC,UAAU,CAAC;IAE3D,IAAIG,MAAM,GAAG,MAAM;IACnB,IAAID,KAAK,GAAG,CAAC,IAAIF,UAAU,KAAK,CAAC,EAAE;MACjCG,MAAM,GAAG,KAAK;IAChB;IAEA,MAAMC,WAAW,GAAG,IAAI,CAACC,QAAQ,CAAC,IAAI,CAACX,OAAO,CAACR,QAAQ,EAAEiB,MAAM,CAAC;IAEhE,OAAO;MACLD,KAAK,EAAEE,WAAW;MAClBD;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEG,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMX,uBAAuB,GAAGW,UAAU,CAACC,WAAW,CAAC,qBAAqB,CAAC;IAC7E,MAAMC,oBAAoB,GAAG,IAAI,CAACT,6BAA6B,CAACJ,uBAAuB,CAAC;IACxF,MAAMc,gBAAgB,GAAG,IAAIvC,gBAAgB,CAAC;MAACQ,MAAM,EAAE,IAAI,CAACc;IAAO,CAAC,CAAC;IAErEiB,gBAAgB,CAACC,QAAQ,CAACF,oBAAoB,CAACR,KAAK,CAAC;IACrDS,gBAAgB,CAACE,SAAS,CAACH,oBAAoB,CAACP,MAAM,CAAC;IAEvD,OAAOQ,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEG,YAAYA,CAACP,KAAK,EAAEC,UAAU,EAAE;IAC9B,MAAMO,iBAAiB,GAAGP,UAAU,CAACQ,SAAS,CAAC,mBAAmB,CAAC;IACnE,MAAMC,yBAAyB,GAAGT,UAAU,CAACU,SAAS,CAAC,yBAAyB,CAAC,CAC9EC,eAAe;IAClB,IAAIF,yBAAyB,EAAE;MAC7B,IAAI,CAACvB,OAAO,CAACP,0BAA0B,GAAG8B,yBAAyB;IACrE;IACA,IAAIG,IAAI,GAAGb,KAAK,CAACc,OAAO,CAAC,CAAC;IAC1BD,IAAI,GAAG9C,gBAAgB,CAAC8C,IAAI,CAAC;IAC7BA,IAAI,GAAG5C,wBAAwB,CAAC4C,IAAI,EAAEb,KAAK,CAACe,WAAW,IAAIf,KAAK,CAACe,WAAW,CAACC,UAAU,CAAC;IACxF,MAAMC,UAAU,GAAGT,iBAAiB,GAAGA,iBAAiB,CAACK,IAAI,CAAC,GAAG7C,QAAQ,CAAC6C,IAAI,CAAC,CAACK,MAAM;;IAEtF;IACA,OACED,UAAU,IAAI,IAAI,CAAC9B,OAAO,CAACP,0BAA0B,IACrDqB,UAAU,CAACkB,WAAW,CAAC,qBAAqB,CAAC;EAEjD;AACF","ignoreList":[]}