axyseo 2.0.0-alpha.0.0.37 → 2.0.0-alpha.0.0.39

package/build/scoring/assessments/assessment.js

@@ -0,0 +1,70 @@
+/* eslint-disable no-unused-vars */
+import { sanitizeString } from "../../languageProcessing";
+import { filterShortcodesFromHTML, removeHtmlBlocks } from "../../languageProcessing/helpers";
+import { POINT, priorityRate, statusRate } from "../../const/analysis";
+
+/**
+ * The base class for an Assessment.
+ */
+class Assessment {
+  /**
+   * Executes the assessment and return its result.
+   *
+   * @param {Paper}       paper       The paper to run this assessment on.
+   * @param {Researcher}  researcher  The researcher used for the assessment.
+   * @param i18n
+   * @returns {AssessmentResult} The result of the assessment.
+   */
+  getResult({
+    paper,
+    researcher,
+    i18n
+  }) {
+    throw 'The method getResult is not implemented';
+  }
+
+  /**
+   * Checks whether the assessment is applicable.
+   *
+   * @param {Paper}       paper       The paper to run this assessment on.
+   * @param {Researcher}  researcher  The researcher used for the assessment.
+   *
+   * @returns {boolean} Whether the assessment is applicable, defaults to `true`.
+   */
+  isApplicable(paper, researcher) {
+    return true;
+  }
+
+  /**
+   * Tests whether a `Paper` has enough content for assessments to be displayed.
+   *
+   * @param {Paper} paper            The paper to run this assessment on.
+   * @param {number} contentNeededForAssessment  The minimum length in characters a text must have for assessments to be displayed.
+   *
+   * @returns {boolean} `true` if the text is of the required length, `false` otherwise.
+   */
+  hasEnoughContentForAssessment(paper, contentNeededForAssessment = 50) {
+    let text = paper.getText();
+    text = removeHtmlBlocks(text);
+    text = filterShortcodesFromHTML(text, paper._attributes && paper._attributes.shortcodes);
+    return sanitizeString(text).length >= contentNeededForAssessment;
+  }
+  checkCanSkip(paper) {
+    return !this.hasEnoughContentForAssessment;
+  }
+
+  /**
+   *
+   * @param priority
+   * @param status
+   * @returns {number}
+   */
+  getScore(priority, status) {
+    return POINT * priorityRate[`${priority}`] * statusRate[`${status}`];
+  }
+}
+
+/* eslint-enable no-unused-vars */
+
+export default Assessment;
+//# sourceMappingURL=assessment.js.map

package/build/scoring/assessments/assessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assessment.js","names":["sanitizeString","filterShortcodesFromHTML","removeHtmlBlocks","POINT","priorityRate","statusRate","Assessment","getResult","paper","researcher","i18n","isApplicable","hasEnoughContentForAssessment","contentNeededForAssessment","text","getText","_attributes","shortcodes","length","checkCanSkip","getScore","priority","status"],"sources":["../../../src/scoring/assessments/assessment.js"],"sourcesContent":["/* eslint-disable no-unused-vars */\nimport {sanitizeString} from '../../languageProcessing';\nimport {filterShortcodesFromHTML, removeHtmlBlocks} from '../../languageProcessing/helpers';\nimport {POINT, priorityRate, statusRate} from '../../const/analysis';\n\n/**\n * The base class for an Assessment.\n */\nclass Assessment {\n  /**\n   * Executes the assessment and return its result.\n   *\n   * @param {Paper}       paper       The paper to run this assessment on.\n   * @param {Researcher}  researcher  The researcher used for the assessment.\n   * @param i18n\n   * @returns {AssessmentResult} The result of the assessment.\n   */\n  getResult({paper, researcher, i18n}) {\n    throw 'The method getResult is not implemented';\n  }\n\n  /**\n   * Checks whether the assessment is applicable.\n   *\n   * @param {Paper}       paper       The paper to run this assessment on.\n   * @param {Researcher}  researcher  The researcher used for the assessment.\n   *\n   * @returns {boolean} Whether the assessment is applicable, defaults to `true`.\n   */\n  isApplicable(paper, researcher) {\n    return true;\n  }\n\n  /**\n   * Tests whether a `Paper` has enough content for assessments to be displayed.\n   *\n   * @param {Paper} paper            The paper to run this assessment on.\n   * @param {number} contentNeededForAssessment  The minimum length in characters a text must have for assessments to be displayed.\n   *\n   * @returns {boolean} `true` if the text is of the required length, `false` otherwise.\n   */\n  hasEnoughContentForAssessment(paper, contentNeededForAssessment = 50) {\n    let text = paper.getText();\n    text = removeHtmlBlocks(text);\n    text = filterShortcodesFromHTML(text, paper._attributes && paper._attributes.shortcodes);\n\n    return sanitizeString(text).length >= contentNeededForAssessment;\n  }\n\n  checkCanSkip(paper) {\n    return !this.hasEnoughContentForAssessment;\n  }\n\n  /**\n   *\n   * @param priority\n   * @param status\n   * @returns {number}\n   */\n  getScore(priority, status) {\n    return POINT * priorityRate[`${priority}`] * statusRate[`${status}`];\n  }\n}\n\n/* eslint-enable no-unused-vars */\n\nexport default Assessment;\n"],"mappings":"AAAA;AACA,SAAQA,cAAc;AACtB,SAAQC,wBAAwB,EAAEC,gBAAgB;AAClD,SAAQC,KAAK,EAAEC,YAAY,EAAEC,UAAU;;AAEvC;AACA;AACA;AACA,MAAMC,UAAU,CAAC;EACf;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,SAASA,CAAC;IAACC,KAAK;IAAEC,UAAU;IAAEC;EAAI,CAAC,EAAE;IACnC,MAAM,yCAAyC;EACjD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,YAAYA,CAACH,KAAK,EAAEC,UAAU,EAAE;IAC9B,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEG,6BAA6BA,CAACJ,KAAK,EAAEK,0BAA0B,GAAG,EAAE,EAAE;IACpE,IAAIC,IAAI,GAAGN,KAAK,CAACO,OAAO,CAAC,CAAC;IAC1BD,IAAI,GAAGZ,gBAAgB,CAACY,IAAI,CAAC;IAC7BA,IAAI,GAAGb,wBAAwB,CAACa,IAAI,EAAEN,KAAK,CAACQ,WAAW,IAAIR,KAAK,CAACQ,WAAW,CAACC,UAAU,CAAC;IAExF,OAAOjB,cAAc,CAACc,IAAI,CAAC,CAACI,MAAM,IAAIL,0BAA0B;EAClE;EAEAM,YAAYA,CAACX,KAAK,EAAE;IAClB,OAAO,CAAC,IAAI,CAACI,6BAA6B;EAC5C;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEQ,QAAQA,CAACC,QAAQ,EAAEC,MAAM,EAAE;IACzB,OAAOnB,KAAK,GAAGC,YAAY,CAAC,GAAGiB,QAAQ,EAAE,CAAC,GAAGhB,UAAU,CAAC,GAAGiB,MAAM,EAAE,CAAC;EACtE;AACF;;AAEA;;AAEA,eAAehB,UAAU","ignoreList":[]}

package/build/scoring/assessments/index.js

@@ -0,0 +1,61 @@
+// Readability assessments.
+import ParagraphTooLongAssessment from "./readability/ParagraphTooLongAssessment";
+import SentenceBeginningsAssessment from "./readability/SentenceBeginningsAssessment";
+import SentenceLengthInTextAssessment from "./readability/SentenceLengthInTextAssessment";
+import TransitionWordsAssessment from "./readability/TransitionWordsAssessment";
+
+// 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";
+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 KeyphraseAssessment from "./seo/KeyphraseAssessment";
+import SingleTitleAssessment from "./seo/SingleTitleAssessment";
+import UrlLengthAssessment from "./seo/UrlLengthAssessment";
+import NumberInMetaTitleAssessment from "./seo/NumberInMetaTitleAssessment";
+import TextImagesAssessment from "./seo/TextImagesAssessment";
+import MetaTitleKeywordAssessment from "./seo/MetaTitleKeywordAssessment";
+import SchemaAssessment from "./seo/SchemaAssessment";
+import RelatedKeywordsAssessment from "./readability/RelatedKeywordsAssessment";
+const readability = {
+  ParagraphTooLongAssessment,
+  SentenceBeginningsAssessment,
+  SentenceLengthInTextAssessment,
+  TransitionWordsAssessment
+};
+
+// We expose the deprecated assessments for backwards compatibility.
+const seo = {
+  ImageCountAssessment,
+  NumberInMetaTitleAssessment,
+  InternalLinksAssessment,
+  TextImagesAssessment,
+  MetaTitleKeywordAssessment,
+  IntroductionKeywordAssessment,
+  SingleTitleAssessment,
+  KeyphraseLengthAssessment,
+  UrlLengthAssessment,
+  KeyphraseDensityAssessment,
+  MetaDescriptionKeywordAssessment,
+  MetaDescriptionLengthAssessment,
+  OutboundLinksAssessment,
+  PageTitleWidthAssessment,
+  SingleH1Assessment,
+  SubheadingsKeywordAssessment,
+  TextLengthAssessment,
+  SlugKeywordAssessment,
+  KeyphraseAssessment,
+  SchemaAssessment,
+  RelatedKeywordsAssessment
+};
+export { readability, seo };
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["ParagraphTooLongAssessment","SentenceBeginningsAssessment","SentenceLengthInTextAssessment","TransitionWordsAssessment","InternalLinksAssessment","IntroductionKeywordAssessment","KeyphraseLengthAssessment","KeyphraseDensityAssessment","MetaDescriptionKeywordAssessment","MetaDescriptionLengthAssessment","OutboundLinksAssessment","PageTitleWidthAssessment","SingleH1Assessment","SubheadingsKeywordAssessment","TextLengthAssessment","SlugKeywordAssessment","ImageCountAssessment","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 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  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,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;EAClBzB,0BAA0B;EAC1BC,4BAA4B;EAC5BC,8BAA8B;EAC9BC;AACF,CAAC;;AAED;AACA,MAAMuB,GAAG,GAAG;EACVV,oBAAoB;EACpBI,2BAA2B;EAC3BhB,uBAAuB;EACvBiB,oBAAoB;EACpBC,0BAA0B;EAC1BjB,6BAA6B;EAC7Ba,qBAAqB;EACrBZ,yBAAyB;EACzBa,mBAAmB;EACnBZ,0BAA0B;EAC1BC,gCAAgC;EAChCC,+BAA+B;EAC/BC,uBAAuB;EACvBC,wBAAwB;EACxBC,kBAAkB;EAClBC,4BAA4B;EAC5BC,oBAAoB;EACpBC,qBAAqB;EACrBE,mBAAmB;EACnBM,gBAAgB;EAChBC;AACF,CAAC;AAED,SAAQC,WAAW,EAAEC,GAAG","ignoreList":[]}

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

@@ -0,0 +1,159 @@
+import { merge } from 'lodash';
+import React from 'react';
+import { Text } from '@shopify/polaris';
+import { inRangeEndInclusive as inRange } from "../../helpers/assessments/inRange";
+import AssessmentResult from "../../../values/AssessmentResult";
+import Assessment from "../assessment";
+
+/**
+ * Represents the assessment that will look if the text has too long paragraphs.
+ */
+export default class ParagraphTooLongAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {object} config       The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: 'textParagraphTooLong',
+      priority: 'high',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#paragraph-length',
+      fixPosition: 'longParagraph',
+      ctaType: 'fix',
+      parameters: {
+        recommendedLength: 150,
+        maximumRecommendedLength: 150
+      },
+      title: 'Paragraph length',
+      content: {
+        bad: 'Paragraph too long. Keep paragraph length less than 150 words for readability.',
+        improve: '',
+        good: 'Paragraph is optimized, with less than 150 words.'
+      }
+    };
+    this.identifier = 'textParagraphTooLong';
+    this._config = merge(defaultConfig, config);
+  }
+
+  /**
+   * Check if there is language-specific config, and if so, overwrite the current config with it.
+   *
+   * @param {Researcher} researcher The researcher to use.
+   *
+   * @returns {Object} The config that should be used.
+   */
+  getConfig(researcher) {
+    const currentConfig = this._config;
+    const languageSpecificConfig = researcher.getConfig('paragraphLength');
+
+    /*
+     * If a language has a specific paragraph length config, check further if the assessment is run in product pages.
+     * If it's run in product pages, override the default config parameters with the language specific config for product pages,
+     * otherwise override it with the language specific config for default pages analysis.
+     */
+    if (languageSpecificConfig) {
+      currentConfig.parameters = this._isProduct ? languageSpecificConfig.productPageParams : languageSpecificConfig.defaultPageParams;
+    }
+    return currentConfig;
+  }
+
+  /**
+   *
+   * @param paragraphsLength
+   * @param tooLongParagraphs
+   * @param config
+   * @param i18n
+   * @returns {{score: number, body: React.JSX.Element, status: string}}
+   */
+  calculateResult({
+    paragraphsLength,
+    config,
+    i18n
+  }) {
+    let status = '';
+    if (paragraphsLength.length === 0) {
+      status = 'good';
+    }
+    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(this._config.priority, status);
+    return {
+      score,
+      status,
+      body: /*#__PURE__*/React.createElement(Text, {
+        as: 'span'
+      }, this._config.content[status], ' ', this._config.docUrl && /*#__PURE__*/React.createElement("a", {
+        href: this._config.docUrl,
+        target: "_blank",
+        rel: "noreferrer"
+      }, i18n ? i18n.translate(`Axyseo.Button.learnMore`) : 'Learn more'))
+    };
+  }
+
+  /**
+   * Sort the paragraphs based on word count.
+   *
+   * @param {Array} paragraphs The array with paragraphs.
+   *
+   * @returns {Array} The array sorted on word counts.
+   */
+  sortParagraphs(paragraphs) {
+    return paragraphs.sort(function (a, b) {
+      return b.countLength - a.countLength;
+    });
+  }
+
+  /**
+   * Runs the getParagraphLength module, based on this returns an assessment result with score and text.
+   *
+   * @param {Paper} paper             The paper to use for the assessment.
+   * @param {Researcher} researcher   The researcher used for calling research.
+   * @param i18n
+   * @returns {object} The assessment result.
+   */
+  getResult({
+    paper,
+    researcher,
+    i18n
+  }) {
+    let paragraphsLength = researcher.getResearch('getParagraphLength');
+    paragraphsLength = this.sortParagraphs(paragraphsLength);
+    const config = this.getConfig(researcher);
+    const paragraphLengthResult = this.calculateResult({
+      paragraphsLength,
+      config,
+      i18n
+    });
+    const assessmentResult = new AssessmentResult({
+      config: this._config
+    });
+    assessmentResult.setScore(paragraphLengthResult.score);
+    assessmentResult.setStatus(paragraphLengthResult.status);
+    assessmentResult.setBody(paragraphLengthResult.body);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks if the paragraphTooLong assessment is applicable to the paper.
+   *
+   * @param {Paper} paper The paper to check.
+   *
+   * @returns {boolean} Returns true if the assessment is applicable to the paper.
+   */
+  isApplicable(paper) {
+    return this.hasEnoughContentForAssessment(paper);
+  }
+}
+//# sourceMappingURL=ParagraphTooLongAssessment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ParagraphTooLongAssessment.js","names":["merge","React","Text","inRangeEndInclusive","inRange","AssessmentResult","Assessment","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","i18n","status","length","longestParagraphLength","countLength","score","getScore","body","createElement","as","href","target","rel","translate","sortParagraphs","paragraphs","sort","a","b","getResult","paper","getResearch","paragraphLengthResult","assessmentResult","setScore","setStatus","setBody","isApplicable","hasEnoughContentForAssessment"],"sources":["../../../../src/scoring/assessments/readability/ParagraphTooLongAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport React from 'react';\nimport {Text} from '@shopify/polaris';\nimport {inRangeEndInclusive as inRange} from '../../helpers/assessments/inRange';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\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: 'textParagraphTooLong',\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 = 'textParagraphTooLong';\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 tooLongParagraphs\n   * @param config\n   * @param i18n\n   * @returns {{score: number, body: React.JSX.Element, status: string}}\n   */\n  calculateResult({paragraphsLength, config, i18n}) {\n    let status = '';\n    if (paragraphsLength.length === 0) {\n      status = 'good';\n    }\n\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    const score = this.getScore(this._config.priority, status);\n\n    return {\n      score,\n      status,\n      body: (\n        <Text as={'span'}>\n          {this._config.content[status]}{' '}\n          {this._config.docUrl && (\n            <a href={this._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n              {i18n ? i18n.translate(`Axyseo.Button.learnMore`) : 'Learn more'}\n            </a>\n          )}\n        </Text>\n      )\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   * @param i18n\n   * @returns {object} The assessment result.\n   */\n  getResult({paper, researcher, i18n}) {\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      i18n\n    });\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(paragraphLengthResult.score);\n    assessmentResult.setStatus(paragraphLengthResult.status);\n    assessmentResult.setBody(paragraphLengthResult.body);\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,OAAOC,KAAK,MAAM,OAAO;AACzB,SAAQC,IAAI,QAAO,kBAAkB;AACrC,SAAQC,mBAAmB,IAAIC,OAAO;AACtC,OAAOC,gBAAgB;AACvB,OAAOC,UAAU;;AAEjB;AACA;AACA;AACA,eAAe,MAAMC,0BAA0B,SAASD,UAAU,CAAC;EACjE;AACF;AACA;AACA;AACA;AACA;AACA;EACEE,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAE,sBAAsB;MAC1BC,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,GAAG,sBAAsB;IACxC,IAAI,CAACC,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;AACA;EACEK,eAAeA,CAAC;IAACC,gBAAgB;IAAEzB,MAAM;IAAE0B;EAAI,CAAC,EAAE;IAChD,IAAIC,MAAM,GAAG,EAAE;IACf,IAAIF,gBAAgB,CAACG,MAAM,KAAK,CAAC,EAAE;MACjCD,MAAM,GAAG,MAAM;IACjB;IAEA,MAAME,sBAAsB,GAAGJ,gBAAgB,CAAC,CAAC,CAAC,CAACK,WAAW;IAE9D,IAAID,sBAAsB,IAAI7B,MAAM,CAACO,UAAU,CAACC,iBAAiB,EAAE;MACjEmB,MAAM,GAAG,MAAM;IACjB;IAEA,IACEhC,OAAO,CACLkC,sBAAsB,EACtB7B,MAAM,CAACO,UAAU,CAACC,iBAAiB,EACnCR,MAAM,CAACO,UAAU,CAACE,wBACpB,CAAC,EACD;MACAkB,MAAM,GAAG,MAAM;IACjB;IAEA,IAAIE,sBAAsB,GAAG7B,MAAM,CAACO,UAAU,CAACE,wBAAwB,EAAE;MACvEkB,MAAM,GAAG,KAAK;IAChB;IAEA,MAAMI,KAAK,GAAG,IAAI,CAACC,QAAQ,CAAC,IAAI,CAAChB,OAAO,CAACb,QAAQ,EAAEwB,MAAM,CAAC;IAE1D,OAAO;MACLI,KAAK;MACLJ,MAAM;MACNM,IAAI,eACFzC,KAAA,CAAA0C,aAAA,CAACzC,IAAI;QAAC0C,EAAE,EAAE;MAAO,GACd,IAAI,CAACnB,OAAO,CAACL,OAAO,CAACgB,MAAM,CAAC,EAAE,GAAG,EACjC,IAAI,CAACX,OAAO,CAACZ,MAAM,iBAClBZ,KAAA,CAAA0C,aAAA;QAAGE,IAAI,EAAE,IAAI,CAACpB,OAAO,CAACZ,MAAO;QAACiC,MAAM,EAAC,QAAQ;QAACC,GAAG,EAAC;MAAY,GAC3DZ,IAAI,GAAGA,IAAI,CAACa,SAAS,CAAC,yBAAyB,CAAC,GAAG,YACnD,CAED;IAEV,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,cAAcA,CAACC,UAAU,EAAE;IACzB,OAAOA,UAAU,CAACC,IAAI,CAAC,UAASC,CAAC,EAAEC,CAAC,EAAE;MACpC,OAAOA,CAAC,CAACd,WAAW,GAAGa,CAAC,CAACb,WAAW;IACtC,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEe,SAASA,CAAC;IAACC,KAAK;IAAE5B,UAAU;IAAEQ;EAAI,CAAC,EAAE;IACnC,IAAID,gBAAgB,GAAGP,UAAU,CAAC6B,WAAW,CAAC,oBAAoB,CAAC;IAEnEtB,gBAAgB,GAAG,IAAI,CAACe,cAAc,CAACf,gBAAgB,CAAC;IACxD,MAAMzB,MAAM,GAAG,IAAI,CAACiB,SAAS,CAACC,UAAU,CAAC;IAEzC,MAAM8B,qBAAqB,GAAG,IAAI,CAACxB,eAAe,CAAC;MACjDC,gBAAgB;MAChBzB,MAAM;MACN0B;IACF,CAAC,CAAC;IACF,MAAMuB,gBAAgB,GAAG,IAAIrD,gBAAgB,CAAC;MAACI,MAAM,EAAE,IAAI,CAACgB;IAAO,CAAC,CAAC;IAErEiC,gBAAgB,CAACC,QAAQ,CAACF,qBAAqB,CAACjB,KAAK,CAAC;IACtDkB,gBAAgB,CAACE,SAAS,CAACH,qBAAqB,CAACrB,MAAM,CAAC;IACxDsB,gBAAgB,CAACG,OAAO,CAACJ,qBAAqB,CAACf,IAAI,CAAC;IAEpD,OAAOgB,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEI,YAAYA,CAACP,KAAK,EAAE;IAClB,OAAO,IAAI,CAACQ,6BAA6B,CAACR,KAAK,CAAC;EAClD;AACF","ignoreList":[]}

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

@@ -0,0 +1,114 @@
+import { merge } from 'lodash';
+import React from 'react';
+import AssessmentResult from "../../../values/AssessmentResult";
+import Assessment from "../assessment";
+import RelatedKeywordsDescription from "../../../components/RelatedKeywordsDescription";
+import { BlockStack, Text } from '@shopify/polaris';
+
+/**
+ * Represents the assessment that checks whether there are enough transition words in the text.
+ */
+export default class RelatedKeywordsAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {object} config The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: 'relatedKeywords',
+      fixPosition: 'description',
+      ctaType: 'fix',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#duplicate-title',
+      priority: 'high',
+      title: 'Related keywords',
+      content: {
+        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 = 'relatedKeywords';
+    this._config = merge(defaultConfig, config);
+  }
+
+  /**
+   *
+   * @param data
+   * @param relatedKeywords
+   * @param i18n
+   * @returns {{score: number, body: React.JSX.Element, status: string}}
+   */
+  calculateResult(data, relatedKeywords, i18n) {
+    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,
+      body: /*#__PURE__*/React.createElement(BlockStack, {
+        gap: 200
+      }, /*#__PURE__*/React.createElement(Text, {
+        as: 'span'
+      }, this._config.content[status], ' ', this._config.docUrl && /*#__PURE__*/React.createElement("a", {
+        href: this._config.docUrl,
+        target: "_blank",
+        rel: "noreferrer"
+      }, i18n ? i18n.translate(`Axyseo.Button.learnMore`) : 'Learn more')), /*#__PURE__*/React.createElement(RelatedKeywordsDescription, {
+        words,
+        i18n
+      }))
+    };
+  }
+
+  /**
+   *
+   * @param paper
+   * @param researcher
+   * @param i18n
+   * @returns {AssessmentResult}
+   */
+  getResult({
+    paper,
+    researcher,
+    i18n
+  }) {
+    const relatedKeywords = researcher.getResearch('checkRelatedKeywords');
+    const data = paper.getData();
+    const result = this.calculateResult(data, relatedKeywords, i18n);
+    const assessmentResult = new AssessmentResult({
+      config: this._config
+    });
+    assessmentResult.setScore(result.score);
+    assessmentResult.setStatus(result.status);
+    assessmentResult.setBody(result.body);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks if the transition words assessment is applicable to the paper. Language-specific length requirements and methods of counting text length
+   * may apply (e.g. for Japanese, the text should be counted in characters instead of words, which also makes the minimum required length higher).
+   *
+   * @param {Paper}       paper       The paper to check.
+   * @param {Researcher}  researcher  The researcher object.
+   *
+   * @returns {boolean} Returns true if the language is available, the paper is not empty and the text is longer than the minimum required length.
+   */
+  isApplicable(paper, researcher) {
+    return paper.hasRelatedKeywords();
+  }
+}
+//# sourceMappingURL=RelatedKeywordsAssessment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RelatedKeywordsAssessment.js","names":["merge","React","AssessmentResult","Assessment","RelatedKeywordsDescription","BlockStack","Text","RelatedKeywordsAssessment","constructor","config","defaultConfig","id","fixPosition","ctaType","docUrl","priority","title","content","good","bad","improve","identifier","_config","calculateResult","data","relatedKeywords","i18n","totalWordUsed","words","isWordUsedExceeding","status","related_keywords","length","score","getScore","body","createElement","gap","as","href","target","rel","translate","getResult","paper","researcher","getResearch","getData","result","assessmentResult","setScore","setStatus","setBody","isApplicable","hasRelatedKeywords"],"sources":["../../../../src/scoring/assessments/readability/RelatedKeywordsAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport React from 'react';\n\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\n\nimport RelatedKeywordsDescription from '@axyseo/components/RelatedKeywordsDescription';\nimport {BlockStack, Text} from '@shopify/polaris';\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: 'relatedKeywords',\n      fixPosition: 'description',\n      ctaType: 'fix',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#duplicate-title',\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 = 'relatedKeywords';\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   *\n   * @param data\n   * @param relatedKeywords\n   * @param i18n\n   * @returns {{score: number, body: React.JSX.Element, status: string}}\n   */\n  calculateResult(data, relatedKeywords, i18n) {\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      body: (\n        <BlockStack gap={200}>\n          <Text as={'span'}>\n            {this._config.content[status]}{' '}\n            {this._config.docUrl && (\n              <a href={this._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n                {i18n ? i18n.translate(`Axyseo.Button.learnMore`) : 'Learn more'}\n              </a>\n            )}\n          </Text>\n          <RelatedKeywordsDescription {...{words, i18n}} />\n        </BlockStack>\n      )\n    };\n  }\n\n  /**\n   *\n   * @param paper\n   * @param researcher\n   * @param i18n\n   * @returns {AssessmentResult}\n   */\n  getResult({paper, researcher, i18n}) {\n    const relatedKeywords = researcher.getResearch('checkRelatedKeywords');\n    const data = paper.getData();\n\n    const result = this.calculateResult(data, relatedKeywords, i18n);\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(result.score);\n    assessmentResult.setStatus(result.status);\n    assessmentResult.setBody(result.body);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks 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,KAAK,MAAM,OAAO;AAEzB,OAAOC,gBAAgB;AACvB,OAAOC,UAAU;AAEjB,OAAOC,0BAA0B;AACjC,SAAQC,UAAU,EAAEC,IAAI,QAAO,kBAAkB;;AAEjD;AACA;AACA;AACA,eAAe,MAAMC,yBAAyB,SAASJ,UAAU,CAAC;EAChE;AACF;AACA;AACA;AACA;AACA;AACA;EACEK,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAE,iBAAiB;MACrBC,WAAW,EAAE,aAAa;MAC1BC,OAAO,EAAE,KAAK;MACdC,MAAM,EACJ,6FAA6F;MAC/FC,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,GAAG,iBAAiB;IACnC,IAAI,CAACC,OAAO,GAAGtB,KAAK,CAACU,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEc,eAAeA,CAACC,IAAI,EAAEC,eAAe,EAAEC,IAAI,EAAE;IAC3C,MAAM;MAACC,aAAa;MAAEC,KAAK;MAAEC;IAAmB,CAAC,GAAGJ,eAAe;IACnE,IAAIK,MAAM,GAAG,MAAM;IACnB,IAAI,CAACN,IAAI,EAAEO,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,CAACZ,OAAO,CAACP,QAAQ,EAAEe,MAAM,CAAC;IAE1D,OAAO;MACLG,KAAK;MACLH,MAAM;MACNK,IAAI,eACFlC,KAAA,CAAAmC,aAAA,CAAC/B,UAAU;QAACgC,GAAG,EAAE;MAAI,gBACnBpC,KAAA,CAAAmC,aAAA,CAAC9B,IAAI;QAACgC,EAAE,EAAE;MAAO,GACd,IAAI,CAAChB,OAAO,CAACL,OAAO,CAACa,MAAM,CAAC,EAAE,GAAG,EACjC,IAAI,CAACR,OAAO,CAACR,MAAM,iBAClBb,KAAA,CAAAmC,aAAA;QAAGG,IAAI,EAAE,IAAI,CAACjB,OAAO,CAACR,MAAO;QAAC0B,MAAM,EAAC,QAAQ;QAACC,GAAG,EAAC;MAAY,GAC3Df,IAAI,GAAGA,IAAI,CAACgB,SAAS,CAAC,yBAAyB,CAAC,GAAG,YACnD,CAED,CAAC,eACPzC,KAAA,CAAAmC,aAAA,CAAChC,0BAA0B;QAAMwB,KAAK;QAAEF;MAAI,CAAI,CACtC;IAEhB,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEiB,SAASA,CAAC;IAACC,KAAK;IAAEC,UAAU;IAAEnB;EAAI,CAAC,EAAE;IACnC,MAAMD,eAAe,GAAGoB,UAAU,CAACC,WAAW,CAAC,sBAAsB,CAAC;IACtE,MAAMtB,IAAI,GAAGoB,KAAK,CAACG,OAAO,CAAC,CAAC;IAE5B,MAAMC,MAAM,GAAG,IAAI,CAACzB,eAAe,CAACC,IAAI,EAAEC,eAAe,EAAEC,IAAI,CAAC;IAChE,MAAMuB,gBAAgB,GAAG,IAAI/C,gBAAgB,CAAC;MAACO,MAAM,EAAE,IAAI,CAACa;IAAO,CAAC,CAAC;IAErE2B,gBAAgB,CAACC,QAAQ,CAACF,MAAM,CAACf,KAAK,CAAC;IACvCgB,gBAAgB,CAACE,SAAS,CAACH,MAAM,CAAClB,MAAM,CAAC;IACzCmB,gBAAgB,CAACG,OAAO,CAACJ,MAAM,CAACb,IAAI,CAAC;IAErC,OAAOc,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/scoring/assessments/readability/SentenceBeginningsAssessment.js

@@ -0,0 +1,128 @@
+import { merge, partition, sortBy } from 'lodash';
+import React from 'react';
+import { Text } from '@shopify/polaris';
+import AssessmentResult from "../../../values/AssessmentResult";
+import Assessment from "../assessment";
+import { TextBlockIcon } from '@shopify/polaris-icons';
+const maximumConsecutiveDuplicates = 2;
+
+/**
+ * Represents the assessment that checks whether there are three or more consecutive sentences beginning with the same word.
+ */
+export default class SentenceBeginningsAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {object} config The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: 'sentenceBeginnings',
+      priority: 'medium',
+      ctaType: 'fix',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#sentence-beginnings',
+      fixPosition: 'description',
+      icon: TextBlockIcon,
+      title: 'Sentence beginnings',
+      content: {
+        improve: '',
+        bad: 'Found sentences with repetitive beginnings. Change the wording for more engaging content.',
+        good: 'No sentences with repetitive beginnings found.'
+      }
+    };
+    this.identifier = 'sentenceBeginnings';
+    this._config = merge(defaultConfig, config);
+  }
+
+  /**
+   * Counts and groups the number too often used sentence beginnings and determines the lowest count within that group.
+   *
+   * @param {array} sentenceBeginnings The array containing the objects containing the beginning words and counts.
+   *
+   * @returns {object} The object containing the total number of too often used beginnings and the lowest count within those.
+   */
+  groupSentenceBeginnings(sentenceBeginnings) {
+    const tooOften = partition(sentenceBeginnings, function (word) {
+      return word.count > maximumConsecutiveDuplicates;
+    });
+    if (tooOften[0].length === 0) {
+      return {
+        total: 0
+      };
+    }
+    const sortedCounts = sortBy(tooOften[0], function (word) {
+      return word.count;
+    });
+    return {
+      total: tooOften[0].length,
+      lowestCount: sortedCounts[0].count
+    };
+  }
+
+  /**
+   *
+   * @param groupedSentenceBeginnings
+   * @param i18n
+   * @returns {{score: number, body: React.JSX.Element, status: string}}
+   */
+  calculateSentenceBeginningsResult(groupedSentenceBeginnings, i18n) {
+    let status = '';
+    if (groupedSentenceBeginnings.total > 0) {
+      status = 'bad';
+    } else {
+      status = 'good';
+    }
+    const score = this.getScore(this._config.priority, status);
+    return {
+      score,
+      status,
+      body: /*#__PURE__*/React.createElement(Text, {
+        as: 'span'
+      }, this._config.content[status], ' ', this._config.docUrl && /*#__PURE__*/React.createElement("a", {
+        href: this._config.docUrl,
+        target: "_blank",
+        rel: "noreferrer"
+      }, i18n ? i18n.translate(`Axyseo.Button.learnMore`) : 'Learn more'))
+    };
+  }
+
+  /**
+   *
+   * @param paper
+   * @param researcher
+   * @param i18n
+   * @returns {AssessmentResult}
+   */
+  getResult({
+    paper,
+    researcher,
+    i18n
+  }) {
+    const sentenceBeginnings = researcher.getResearch('getSentenceBeginnings');
+    const groupedSentenceBeginnings = this.groupSentenceBeginnings(sentenceBeginnings);
+    const calculatedResult = this.calculateSentenceBeginningsResult(groupedSentenceBeginnings, i18n);
+    const assessmentResult = new AssessmentResult({
+      config: this._config
+    });
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setBody(calculatedResult.body);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks if the sentence beginnings assessment is applicable to the paper.
+   *
+   * @param {Object}      paper       The paper to check.
+   * @param {Researcher}  researcher  The researcher object.
+   *
+   * @returns {boolean} Returns true if the language is available and the paper is not empty.
+   */
+  isApplicable(paper, researcher) {
+    return this.hasEnoughContentForAssessment(paper) && researcher.hasResearch('getSentenceBeginnings');
+  }
+}
+//# sourceMappingURL=SentenceBeginningsAssessment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SentenceBeginningsAssessment.js","names":["merge","partition","sortBy","React","Text","AssessmentResult","Assessment","TextBlockIcon","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","i18n","status","score","getScore","body","createElement","as","href","target","rel","translate","getResult","paper","researcher","getResearch","calculatedResult","assessmentResult","setScore","setStatus","setBody","isApplicable","hasEnoughContentForAssessment","hasResearch"],"sources":["../../../../src/scoring/assessments/readability/SentenceBeginningsAssessment.js"],"sourcesContent":["import {merge, partition, sortBy} from 'lodash';\nimport React from 'react';\nimport {Text} from '@shopify/polaris';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\nimport {TextBlockIcon} from '@shopify/polaris-icons';\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: 'sentenceBeginnings',\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 = 'sentenceBeginnings';\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   * @param i18n\n   * @returns {{score: number, body: React.JSX.Element, status: string}}\n   */\n  calculateSentenceBeginningsResult(groupedSentenceBeginnings, i18n) {\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      body: (\n        <Text as={'span'}>\n          {this._config.content[status]}{' '}\n          {this._config.docUrl && (\n            <a href={this._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n              {i18n ? i18n.translate(`Axyseo.Button.learnMore`) : 'Learn more'}\n            </a>\n          )}\n        </Text>\n      )\n    };\n  }\n\n  /**\n   *\n   * @param paper\n   * @param researcher\n   * @param i18n\n   * @returns {AssessmentResult}\n   */\n  getResult({paper, researcher, i18n}) {\n    const sentenceBeginnings = researcher.getResearch('getSentenceBeginnings');\n    const groupedSentenceBeginnings = this.groupSentenceBeginnings(sentenceBeginnings);\n    const calculatedResult = this.calculateSentenceBeginningsResult(\n      groupedSentenceBeginnings,\n      i18n\n    );\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n    assessmentResult.setBody(calculatedResult.body);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks 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,KAAK,MAAM,OAAO;AACzB,SAAQC,IAAI,QAAO,kBAAkB;AACrC,OAAOC,gBAAgB;AACvB,OAAOC,UAAU;AACjB,SAAQC,aAAa,QAAO,wBAAwB;AAEpD,MAAMC,4BAA4B,GAAG,CAAC;;AAEtC;AACA;AACA;AACA,eAAe,MAAMC,4BAA4B,SAASH,UAAU,CAAC;EACnE;AACF;AACA;AACA;AACA;AACA;AACA;EACEI,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAE,oBAAoB;MACxBC,QAAQ,EAAE,QAAQ;MAClBC,OAAO,EAAE,KAAK;MACdC,MAAM,EACJ,iGAAiG;MACnGC,WAAW,EAAE,aAAa;MAC1BC,IAAI,EAAEX,aAAa;MACnBY,KAAK,EAAE,qBAAqB;MAC5BC,OAAO,EAAE;QACPC,OAAO,EAAE,EAAE;QACXC,GAAG,EACD,2FAA2F;QAC7FC,IAAI,EAAE;MACR;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAG,oBAAoB;IACtC,IAAI,CAACC,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;AACA;EACEK,iCAAiCA,CAACC,yBAAyB,EAAEC,IAAI,EAAE;IACjE,IAAIC,MAAM,GAAG,EAAE;IACf,IAAIF,yBAAyB,CAACJ,KAAK,GAAG,CAAC,EAAE;MACvCM,MAAM,GAAG,KAAK;IAChB,CAAC,MAAM;MACLA,MAAM,GAAG,MAAM;IACjB;IAEA,MAAMC,KAAK,GAAG,IAAI,CAACC,QAAQ,CAAC,IAAI,CAACf,OAAO,CAACX,QAAQ,EAAEwB,MAAM,CAAC;IAE1D,OAAO;MACLC,KAAK;MACLD,MAAM;MACNG,IAAI,eACFtC,KAAA,CAAAuC,aAAA,CAACtC,IAAI;QAACuC,EAAE,EAAE;MAAO,GACd,IAAI,CAAClB,OAAO,CAACL,OAAO,CAACkB,MAAM,CAAC,EAAE,GAAG,EACjC,IAAI,CAACb,OAAO,CAACT,MAAM,iBAClBb,KAAA,CAAAuC,aAAA;QAAGE,IAAI,EAAE,IAAI,CAACnB,OAAO,CAACT,MAAO;QAAC6B,MAAM,EAAC,QAAQ;QAACC,GAAG,EAAC;MAAY,GAC3DT,IAAI,GAAGA,IAAI,CAACU,SAAS,CAAC,yBAAyB,CAAC,GAAG,YACnD,CAED;IAEV,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,SAASA,CAAC;IAACC,KAAK;IAAEC,UAAU;IAAEb;EAAI,CAAC,EAAE;IACnC,MAAMV,kBAAkB,GAAGuB,UAAU,CAACC,WAAW,CAAC,uBAAuB,CAAC;IAC1E,MAAMf,yBAAyB,GAAG,IAAI,CAACV,uBAAuB,CAACC,kBAAkB,CAAC;IAClF,MAAMyB,gBAAgB,GAAG,IAAI,CAACjB,iCAAiC,CAC7DC,yBAAyB,EACzBC,IACF,CAAC;IACD,MAAMgB,gBAAgB,GAAG,IAAIhD,gBAAgB,CAAC;MAACM,MAAM,EAAE,IAAI,CAACc;IAAO,CAAC,CAAC;IAErE4B,gBAAgB,CAACC,QAAQ,CAACF,gBAAgB,CAACb,KAAK,CAAC;IACjDc,gBAAgB,CAACE,SAAS,CAACH,gBAAgB,CAACd,MAAM,CAAC;IACnDe,gBAAgB,CAACG,OAAO,CAACJ,gBAAgB,CAACX,IAAI,CAAC;IAE/C,OAAOY,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEI,YAAYA,CAACR,KAAK,EAAEC,UAAU,EAAE;IAC9B,OACE,IAAI,CAACQ,6BAA6B,CAACT,KAAK,CAAC,IAAIC,UAAU,CAACS,WAAW,CAAC,uBAAuB,CAAC;EAEhG;AACF","ignoreList":[]}