axyseo 2.1.12 → 2.1.19

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

@@ -0,0 +1,141 @@
+import { merge } from 'lodash';
+import formatNumber from "../../../helpers/formatNumber";
+import { inRangeStartInclusive as inRange } from "../../helpers/assessments/inRange";
+import AssessmentResult from "../../../values/AssessmentResult";
+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";
+
+/**
+ * Represents the assessment that checks whether there are enough transition words in the text.
+ */
+export default class TransitionWordsAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {object} config The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: TEXT_TRANSITION_WORDS_ID,
+      fixPosition: 'longestParagraph',
+      ctaType: 'fix',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#use-of-transition-words',
+      priority: 'low',
+      applicableIfTextLongerThan: 200,
+      title: 'Use of transition words',
+      content: {
+        good: 'Transition words are used effectively.',
+        bad: 'Lack of transition words. Improve readability and flow by adding words like "however," "also," etc.',
+        improve: ''
+      }
+    };
+    this.identifier = TEXT_TRANSITION_WORDS_ID;
+    this._config = merge(defaultConfig, config);
+  }
+
+  /**
+   * Calculates the actual percentage of transition words in the sentences.
+   *
+   * @param {object} sentences The object containing the total number of sentences and the number of sentences containing
+   * a transition word.
+   *
+   * @returns {number} The percentage of sentences containing a transition word.
+   */
+  calculateTransitionWordPercentage(sentences) {
+    if (sentences.transitionWordSentences === 0 || sentences.totalSentences === 0) {
+      return 0;
+    }
+    return formatNumber(sentences.transitionWordSentences / sentences.totalSentences * 100);
+  }
+
+  /**
+   * Calculates the score for the assessment based on the percentage of sentences containing transition words.
+   *
+   * @param {number} percentage The percentage of sentences containing transition words.
+   *
+   * @returns {number} The score.
+   */
+  calculateScoreFromPercentage(percentage) {
+    if (percentage < 10) {
+      // Red indicator.
+      return 3;
+    }
+    if (inRange(percentage, 10, 20)) {
+      // Orange indicator.
+      return 6;
+    }
+
+    // Green indicator.
+    return 9;
+  }
+
+  /**
+   *
+   * @param transitionWordSentences
+   * @returns {{score: number, status: string}}
+   */
+  calculateTransitionWordResult(transitionWordSentences) {
+    const percentage = this.calculateTransitionWordPercentage(transitionWordSentences);
+    const score = this.calculateScoreFromPercentage(percentage);
+    let status = 'good';
+    if (score < 6 || percentage === 0) {
+      status = 'bad';
+    }
+    const customScore = this.getScore(MAIN_CONTENT_POINTS, status);
+    return {
+      score: customScore,
+      status
+    };
+  }
+
+  /**
+   *
+   * @param paper
+   * @param researcher
+   * @returns {AssessmentResult}
+   */
+  getResult({
+    paper,
+    researcher
+  }) {
+    const transitionWordSentences = researcher.getResearch('findTransitionWords');
+    const transitionWordResult = this.calculateTransitionWordResult(transitionWordSentences);
+    const assessmentResult = new AssessmentResult({
+      config: this._config
+    });
+    assessmentResult.setScore(transitionWordResult.score);
+    assessmentResult.setStatus(transitionWordResult.status);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks if the transition words assessment is applicable to the paper. Language-specific length requirements and methods of counting text length
+   * may apply (e.g. for Japanese, the text should be counted in characters instead of words, which also makes the minimum required length higher).
+   *
+   * @param {Paper}       paper       The paper to check.
+   * @param {Researcher}  researcher  The researcher object.
+   *
+   * @returns {boolean} Returns true if the language is available, the paper is not empty and the text is longer than the minimum required length.
+   */
+  isApplicable(paper, researcher) {
+    const customCountLength = researcher.getHelper('customCountLength');
+    const customApplicabilityConfig = researcher.getConfig('assessmentApplicability').transitionWords;
+    if (customApplicabilityConfig) {
+      this._config.applicableIfTextLongerThan = customApplicabilityConfig;
+    }
+    let text = paper.getText();
+    text = removeHtmlBlocks(text);
+    text = filterShortcodesFromHTML(text, paper._attributes && paper._attributes.shortcodes);
+    const textLength = customCountLength ? customCountLength(text) : getWords(text).length;
+
+    // Do not use hasEnoughContent in this assessment as it is mostly redundant with `textLength >= this._config.applicableIfTextLongerThan`
+    return textLength >= this._config.applicableIfTextLongerThan && researcher.hasResearch('findTransitionWords');
+  }
+}
+//# sourceMappingURL=TransitionWordsAssessment.js.map

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

@@ -0,0 +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":[]}

package/build/esm/scoring/assessments/seo/FAQsAssessment.js

@@ -0,0 +1,110 @@
+import { merge } from 'lodash';
+import Assessment from "../assessment";
+import AssessmentResult from "../../../values/AssessmentResult";
+import { FAQs_ASSESSMENT_ID, FAQS_POINTS } from "../../../const/analysis";
+
+/**
+ * Represents an assessment that checks FAQs content and structure for SGE optimization.
+ */
+export default class FAQsAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} [config] The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: FAQs_ASSESSMENT_ID,
+      ctaType: 'fix',
+      docUrl: 'https://blog.google/products/search/generative-ai-search/',
+      priority: 'high',
+      fixPosition: 'faqs',
+      title: 'FAQs Optimization',
+      content: {
+        good: 'FAQs are well-structured and optimized for Google SGE.',
+        improve: '',
+        bad: 'FAQs need significant improvement to meet Google SGE standards.',
+        details: {
+          hasProperStructure: 'Empty questions or answers',
+          hasMinimumFAQs: 'Less than 3 FAQs'
+        }
+      }
+    };
+    this.identifier = FAQs_ASSESSMENT_ID;
+    this._config = merge(defaultConfig, config);
+  }
+
+  /**
+   * Executes the Assessment and returns a result.
+   *
+   * @param {Paper}       paper       The Paper object to assess.
+   * @param {Researcher}  researcher  The Researcher object containing all available researches.
+   *
+   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.
+   */
+  getResult({
+    paper,
+    researcher
+  }) {
+    const calculatedResult = this.calculateResult(paper);
+    const assessmentResult = new AssessmentResult({
+      config: this._config
+    });
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setData(calculatedResult.data);
+    return assessmentResult;
+  }
+
+  /**
+   *
+   * @param paper
+   * @returns {{score: number, status: string, data: {hasSchema: ((function(): *)|boolean), hasProperStructure: boolean, hasMinimumFAQs: boolean}}|{score: number, status: string, data: {hasFAQs: boolean}}}
+   */
+  calculateResult(paper) {
+    const faqs = paper.getFAQs()?.questions || [];
+    let status = 'bad';
+    let score = 0;
+    if (!faqs || faqs.length === 0) {
+      return {
+        score: 0,
+        status: 'bad',
+        data: {
+          hasFAQs: false
+        }
+      };
+    }
+    const isEnableFaqs = paper.getFAQs()?.status;
+    const hasMinimumFAQs = this.checkMinimumFAQs(faqs);
+    status = hasMinimumFAQs && isEnableFaqs ? 'good' : 'bad';
+    score = this.getScore(FAQS_POINTS, status);
+    return {
+      score,
+      status
+    };
+  }
+
+  /**
+   * Checks if there are at least 3 FAQs
+   * @param {Array} faqs
+   * @returns {boolean}
+   */
+  checkMinimumFAQs(faqs) {
+    return faqs.length >= 3;
+  }
+
+  /**
+   * Checks whether the paper has text.
+   *
+   * @param {Paper}       paper       The paper to use for the assessment.
+   *
+   * @returns {boolean} True when there is text.
+   */
+  isApplicable(paper) {
+    return true;
+  }
+}
+//# sourceMappingURL=FAQsAssessment.js.map

package/build/esm/scoring/assessments/seo/FAQsAssessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FAQsAssessment.js","names":["merge","Assessment","AssessmentResult","FAQs_ASSESSMENT_ID","FAQS_POINTS","FAQsAssessment","constructor","config","defaultConfig","id","ctaType","docUrl","priority","fixPosition","title","content","good","improve","bad","details","hasProperStructure","hasMinimumFAQs","identifier","_config","getResult","paper","researcher","calculatedResult","calculateResult","assessmentResult","setScore","score","setStatus","status","setData","data","faqs","getFAQs","questions","length","hasFAQs","isEnableFaqs","checkMinimumFAQs","getScore","isApplicable"],"sources":["../../../../../src/scoring/assessments/seo/FAQsAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {FAQs_ASSESSMENT_ID, FAQS_POINTS} from '@axyseo/const/analysis';\n\n/**\n * Represents an assessment that checks FAQs content and structure for SGE optimization.\n */\nexport default class FAQsAssessment 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: FAQs_ASSESSMENT_ID,\n      ctaType: 'fix',\n      docUrl: 'https://blog.google/products/search/generative-ai-search/',\n      priority: 'high',\n      fixPosition: 'faqs',\n      title: 'FAQs Optimization',\n      content: {\n        good: 'FAQs are well-structured and optimized for Google SGE.',\n        improve: '',\n        bad: 'FAQs need significant improvement to meet Google SGE standards.',\n        details: {\n          hasProperStructure: 'Empty questions or answers',\n          hasMinimumFAQs: 'Less than 3 FAQs'\n        }\n      }\n    };\n\n    this.identifier = FAQs_ASSESSMENT_ID;\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Executes the Assessment and returns a result.\n   *\n   * @param {Paper}       paper       The Paper object to assess.\n   * @param {Researcher}  researcher  The Researcher object containing all available researches.\n   *\n   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.\n   */\n  getResult({paper, researcher}) {\n    const calculatedResult = this.calculateResult(paper);\n\n    const assessmentResult = new AssessmentResult({config: this._config});\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n    assessmentResult.setData(calculatedResult.data);\n\n    return assessmentResult;\n  }\n\n  /**\n   *\n   * @param paper\n   * @returns {{score: number, status: string, data: {hasSchema: ((function(): *)|boolean), hasProperStructure: boolean, hasMinimumFAQs: boolean}}|{score: number, status: string, data: {hasFAQs: boolean}}}\n   */\n  calculateResult(paper) {\n    const faqs = paper.getFAQs()?.questions || [];\n    let status = 'bad';\n    let score = 0;\n\n    if (!faqs || faqs.length === 0) {\n      return {score: 0, status: 'bad', data: {hasFAQs: false}};\n    }\n    const isEnableFaqs = paper.getFAQs()?.status;\n    const hasMinimumFAQs = this.checkMinimumFAQs(faqs);\n    status = hasMinimumFAQs && isEnableFaqs ? 'good' : 'bad';\n    score = this.getScore(FAQS_POINTS, status);\n\n    return {\n      score,\n      status\n    };\n  }\n\n\n\n  /**\n   * Checks if there are at least 3 FAQs\n   * @param {Array} faqs\n   * @returns {boolean}\n   */\n  checkMinimumFAQs(faqs) {\n    return faqs.length >= 3;\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"],"mappings":"AAAA,SAAQA,KAAK,QAAO,QAAQ;AAC5B,OAAOC,UAAU;AACjB,OAAOC,gBAAgB;AACvB,SAAQC,kBAAkB,EAAEC,WAAW;;AAEvC;AACA;AACA;AACA,eAAe,MAAMC,cAAc,SAASJ,UAAU,CAAC;EACrD;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,kBAAkB;MACtBO,OAAO,EAAE,KAAK;MACdC,MAAM,EAAE,2DAA2D;MACnEC,QAAQ,EAAE,MAAM;MAChBC,WAAW,EAAE,MAAM;MACnBC,KAAK,EAAE,mBAAmB;MAC1BC,OAAO,EAAE;QACPC,IAAI,EAAE,wDAAwD;QAC9DC,OAAO,EAAE,EAAE;QACXC,GAAG,EAAE,iEAAiE;QACtEC,OAAO,EAAE;UACPC,kBAAkB,EAAE,4BAA4B;UAChDC,cAAc,EAAE;QAClB;MACF;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGnB,kBAAkB;IACpC,IAAI,CAACoB,OAAO,GAAGvB,KAAK,CAACQ,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEiB,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMC,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACH,KAAK,CAAC;IAEpD,MAAMI,gBAAgB,GAAG,IAAI3B,gBAAgB,CAAC;MAACK,MAAM,EAAE,IAAI,CAACgB;IAAO,CAAC,CAAC;IACrEM,gBAAgB,CAACC,QAAQ,CAACH,gBAAgB,CAACI,KAAK,CAAC;IACjDF,gBAAgB,CAACG,SAAS,CAACL,gBAAgB,CAACM,MAAM,CAAC;IACnDJ,gBAAgB,CAACK,OAAO,CAACP,gBAAgB,CAACQ,IAAI,CAAC;IAE/C,OAAON,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;EACED,eAAeA,CAACH,KAAK,EAAE;IACrB,MAAMW,IAAI,GAAGX,KAAK,CAACY,OAAO,CAAC,CAAC,EAAEC,SAAS,IAAI,EAAE;IAC7C,IAAIL,MAAM,GAAG,KAAK;IAClB,IAAIF,KAAK,GAAG,CAAC;IAEb,IAAI,CAACK,IAAI,IAAIA,IAAI,CAACG,MAAM,KAAK,CAAC,EAAE;MAC9B,OAAO;QAACR,KAAK,EAAE,CAAC;QAAEE,MAAM,EAAE,KAAK;QAAEE,IAAI,EAAE;UAACK,OAAO,EAAE;QAAK;MAAC,CAAC;IAC1D;IACA,MAAMC,YAAY,GAAGhB,KAAK,CAACY,OAAO,CAAC,CAAC,EAAEJ,MAAM;IAC5C,MAAMZ,cAAc,GAAG,IAAI,CAACqB,gBAAgB,CAACN,IAAI,CAAC;IAClDH,MAAM,GAAGZ,cAAc,IAAIoB,YAAY,GAAG,MAAM,GAAG,KAAK;IACxDV,KAAK,GAAG,IAAI,CAACY,QAAQ,CAACvC,WAAW,EAAE6B,MAAM,CAAC;IAE1C,OAAO;MACLF,KAAK;MACLE;IACF,CAAC;EACH;;EAIA;AACF;AACA;AACA;AACA;EACES,gBAAgBA,CAACN,IAAI,EAAE;IACrB,OAAOA,IAAI,CAACG,MAAM,IAAI,CAAC;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEK,YAAYA,CAACnB,KAAK,EAAE;IAClB,OAAO,IAAI;EACb;AACF","ignoreList":[]}

package/build/esm/scoring/assessments/seo/FAQsStructureDataAssessment.js

@@ -0,0 +1,76 @@
+import { merge } from 'lodash';
+import Assessment from "../assessment";
+import AssessmentResult from "../../../values/AssessmentResult";
+import { FAQS_POINTS, FAQs_STRUCTURE_DATA_ID } from "../../../const/analysis";
+
+/**
+ * Represents an assessment that checks FAQs content and structure for SGE optimization.
+ */
+export default class FAQsStructureDataAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} [config] The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: FAQs_STRUCTURE_DATA_ID,
+      ctaType: 'fix',
+      docUrl: 'https://blog.google/products/search/generative-ai-search/',
+      priority: 'high',
+      fixPosition: 'faqs',
+      title: 'FAQs structured data',
+      content: {
+        good: 'FAQ structured data added',
+        improve: '',
+        bad: 'Add FAQs structured data for Google rich results eligibility.'
+      }
+    };
+    this.identifier = FAQs_STRUCTURE_DATA_ID;
+    this._config = merge(defaultConfig, config);
+  }
+
+  /**
+   * Executes the Assessment and returns a result.
+   *
+   * @param {Paper}       paper       The Paper object to assess.
+   * @param {Researcher}  researcher  The Researcher object containing all available researches.
+   *
+   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.
+   */
+  getResult({
+    paper,
+    researcher
+  }) {
+    const calculatedResult = this.calculateResult(paper);
+    const assessmentResult = new AssessmentResult({
+      config: this._config
+    });
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    return assessmentResult;
+  }
+
+  /**
+   *
+   * @param paper
+   * @returns {{score: number, status: string, data: {hasSchema: ((function(): *)|boolean), hasProperStructure: boolean, hasMinimumFAQs: boolean}}|{score: number, status: string, data: {hasFAQs: boolean}}}
+   */
+  calculateResult(paper) {
+    // Check FAQ structure and content
+    const hasSchema = paper.hasFAQsSchema();
+    const status = hasSchema ? 'good' : 'bad';
+    const score = this.getScore(FAQS_POINTS, status);
+    return {
+      score,
+      status
+    };
+  }
+  isApplicable(paper) {
+    return true;
+  }
+}
+//# sourceMappingURL=FAQsStructureDataAssessment.js.map

package/build/esm/scoring/assessments/seo/FAQsStructureDataAssessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FAQsStructureDataAssessment.js","names":["merge","Assessment","AssessmentResult","FAQS_POINTS","FAQs_STRUCTURE_DATA_ID","FAQsStructureDataAssessment","constructor","config","defaultConfig","id","ctaType","docUrl","priority","fixPosition","title","content","good","improve","bad","identifier","_config","getResult","paper","researcher","calculatedResult","calculateResult","assessmentResult","setScore","score","setStatus","status","hasSchema","hasFAQsSchema","getScore","isApplicable"],"sources":["../../../../../src/scoring/assessments/seo/FAQsStructureDataAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {FAQS_POINTS, FAQs_STRUCTURE_DATA_ID} from '@axyseo/const/analysis';\n\n/**\n * Represents an assessment that checks FAQs content and structure for SGE optimization.\n */\nexport default class FAQsStructureDataAssessment 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: FAQs_STRUCTURE_DATA_ID,\n      ctaType: 'fix',\n      docUrl: 'https://blog.google/products/search/generative-ai-search/',\n      priority: 'high',\n      fixPosition: 'faqs',\n      title: 'FAQs structured data',\n      content: {\n        good: 'FAQ structured data added',\n        improve: '',\n        bad: 'Add FAQs structured data for Google rich results eligibility.',\n      }\n    };\n\n    this.identifier = FAQs_STRUCTURE_DATA_ID;\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Executes the Assessment and returns a result.\n   *\n   * @param {Paper}       paper       The Paper object to assess.\n   * @param {Researcher}  researcher  The Researcher object containing all available researches.\n   *\n   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.\n   */\n  getResult({paper, researcher}) {\n    const calculatedResult = this.calculateResult(paper);\n    const assessmentResult = new AssessmentResult({config: this._config});\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n    return assessmentResult;\n  }\n\n  /**\n   *\n   * @param paper\n   * @returns {{score: number, status: string, data: {hasSchema: ((function(): *)|boolean), hasProperStructure: boolean, hasMinimumFAQs: boolean}}|{score: number, status: string, data: {hasFAQs: boolean}}}\n   */\n  calculateResult(paper) {\n    // Check FAQ structure and content\n    const hasSchema = paper.hasFAQsSchema();\n    const status = hasSchema ? 'good' : 'bad';\n   const score = this.getScore(FAQS_POINTS, status);\n    return {\n      score,\n      status\n    };\n  }\n\n\n\n\n  isApplicable(paper) {\n    return true;\n  }\n}\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,QAAQ;AAC5B,OAAOC,UAAU;AACjB,OAAOC,gBAAgB;AACvB,SAAQC,WAAW,EAAEC,sBAAsB;;AAE3C;AACA;AACA;AACA,eAAe,MAAMC,2BAA2B,SAASJ,UAAU,CAAC;EAClE;AACF;AACA;AACA;AACA;AACA;AACA;EACEK,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEL,sBAAsB;MAC1BM,OAAO,EAAE,KAAK;MACdC,MAAM,EAAE,2DAA2D;MACnEC,QAAQ,EAAE,MAAM;MAChBC,WAAW,EAAE,MAAM;MACnBC,KAAK,EAAE,sBAAsB;MAC7BC,OAAO,EAAE;QACPC,IAAI,EAAE,2BAA2B;QACjCC,OAAO,EAAE,EAAE;QACXC,GAAG,EAAE;MACP;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGf,sBAAsB;IACxC,IAAI,CAACgB,OAAO,GAAGpB,KAAK,CAACQ,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEc,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMC,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACH,KAAK,CAAC;IACpD,MAAMI,gBAAgB,GAAG,IAAIxB,gBAAgB,CAAC;MAACK,MAAM,EAAE,IAAI,CAACa;IAAO,CAAC,CAAC;IACrEM,gBAAgB,CAACC,QAAQ,CAACH,gBAAgB,CAACI,KAAK,CAAC;IACjDF,gBAAgB,CAACG,SAAS,CAACL,gBAAgB,CAACM,MAAM,CAAC;IACnD,OAAOJ,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;EACED,eAAeA,CAACH,KAAK,EAAE;IACrB;IACA,MAAMS,SAAS,GAAGT,KAAK,CAACU,aAAa,CAAC,CAAC;IACvC,MAAMF,MAAM,GAAGC,SAAS,GAAG,MAAM,GAAG,KAAK;IAC1C,MAAMH,KAAK,GAAG,IAAI,CAACK,QAAQ,CAAC9B,WAAW,EAAE2B,MAAM,CAAC;IAC/C,OAAO;MACLF,KAAK;MACLE;IACF,CAAC;EACH;EAKAI,YAAYA,CAACZ,KAAK,EAAE;IAClB,OAAO,IAAI;EACb;AACF","ignoreList":[]}

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

@@ -0,0 +1,91 @@
+import { merge } from 'lodash';
+import Assessment from "../assessment";
+import AssessmentResult from "../../../values/AssessmentResult";
+import { FAQS_POINTS, MEDIA_ID } from "../../../const/analysis";
+
+/**
+ * Represents the assessment that checks if the text has any images present, including videos in product pages.
+ */
+export default class TextImagesAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {object}  config      The configuration to use.
+   * @param {boolean} countVideos Whether videos are also included in the assessment or not.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}, countVideos = true) {
+    super();
+    const defaultConfig = {
+      id: MEDIA_ID,
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#images-and-videos',
+      priority: 'high',
+      fixPosition: 'description',
+      title: 'Media',
+      content: {
+        good: 'Media are used effectively.',
+        improve: '',
+        bad: 'No media found. Add visual content to enhance engagement.'
+      }
+    };
+    this.identifier = MEDIA_ID;
+    this._config = merge(defaultConfig, config);
+    this._countVideos = countVideos;
+  }
+
+  /**
+   * Execute the Assessment and return a result.
+   *
+   * @param {Paper}       paper       The Paper object to assess.
+   * @param {Researcher}  researcher  The Researcher object containing all available researches.
+   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.
+   */
+  getResult({
+    paper,
+    researcher
+  }) {
+    this.imageCount = researcher.getResearch('imageCount');
+    this.videoCount = researcher.getResearch('videoCount');
+    const assessmentResult = new AssessmentResult({
+      config: this._config
+    });
+    const calculatedResult = this.calculateResult();
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks whether the paper has text.
+   *
+   * @param {Paper}       paper       The paper to use for the assessment.
+   *
+   * @returns {boolean} True when there is text.
+   */
+  isApplicable(paper) {
+    return true;
+  }
+
+  /**
+   *
+   * @returns {{score: number, status: string}}
+   */
+  calculateResult() {
+    // If "countVideos" is on, we include videos in the assessment
+    const mediaCount = this._countVideos ? this.imageCount + this.videoCount : this.imageCount;
+    let status = '';
+    // No images.
+    if (mediaCount === 0) {
+      status = 'bad';
+    } else {
+      status = 'good';
+    }
+    const score = this.getScore(FAQS_POINTS, status);
+    return {
+      score,
+      status
+    };
+  }
+}
+//# sourceMappingURL=ImageCountAssessment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ImageCountAssessment.js","names":["merge","Assessment","AssessmentResult","FAQS_POINTS","MEDIA_ID","TextImagesAssessment","constructor","config","countVideos","defaultConfig","id","docUrl","priority","fixPosition","title","content","good","improve","bad","identifier","_config","_countVideos","getResult","paper","researcher","imageCount","getResearch","videoCount","assessmentResult","calculatedResult","calculateResult","setScore","score","setStatus","status","isApplicable","mediaCount","getScore"],"sources":["../../../../../src/scoring/assessments/seo/ImageCountAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {FAQS_POINTS, MEDIA_ID} from '@axyseo/const/analysis';\n\n/**\n * Represents the assessment that checks if the text has any images present, including videos in product pages.\n */\nexport default class TextImagesAssessment extends Assessment {\n  /**\n   * Sets the identifier and the config.\n   *\n   * @param {object}  config      The configuration to use.\n   * @param {boolean} countVideos Whether videos are also included in the assessment or not.\n   *\n   * @returns {void}\n   */\n  constructor(config = {}, countVideos = true) {\n    super();\n\n    const defaultConfig = {\n      id: MEDIA_ID,\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#images-and-videos',\n      priority: 'high',\n      fixPosition: 'description',\n      title: 'Media',\n      content: {\n        good: 'Media are used effectively.',\n        improve: '',\n        bad: 'No media found. Add visual content to enhance engagement.'\n      }\n    };\n\n    this.identifier = MEDIA_ID;\n    this._config = merge(defaultConfig, config);\n    this._countVideos = countVideos;\n  }\n\n  /**\n   * Execute the Assessment and return a result.\n   *\n   * @param {Paper}       paper       The Paper object to assess.\n   * @param {Researcher}  researcher  The Researcher object containing all available researches.\n   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.\n   */\n  getResult({paper, researcher}) {\n    this.imageCount = researcher.getResearch('imageCount');\n    this.videoCount = researcher.getResearch('videoCount');\n\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    const calculatedResult = this.calculateResult();\n\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.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   *\n   * @returns {{score: number, status: string}}\n   */\n  calculateResult() {\n    // If \"countVideos\" is on, we include videos in the assessment\n    const mediaCount = this._countVideos ? this.imageCount + this.videoCount : this.imageCount;\n\n    let status = '';\n    // No images.\n    if (mediaCount === 0) {\n      status = 'bad';\n    } else {\n      status = 'good';\n    }\n\n    const score = this.getScore(FAQS_POINTS, status);\n\n    return {\n      score,\n      status\n    };\n  }\n}\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,QAAQ;AAC5B,OAAOC,UAAU;AACjB,OAAOC,gBAAgB;AACvB,SAAQC,WAAW,EAAEC,QAAQ;;AAE7B;AACA;AACA;AACA,eAAe,MAAMC,oBAAoB,SAASJ,UAAU,CAAC;EAC3D;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEK,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAEC,WAAW,GAAG,IAAI,EAAE;IAC3C,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEN,QAAQ;MACZO,MAAM,EACJ,+FAA+F;MACjGC,QAAQ,EAAE,MAAM;MAChBC,WAAW,EAAE,aAAa;MAC1BC,KAAK,EAAE,OAAO;MACdC,OAAO,EAAE;QACPC,IAAI,EAAE,6BAA6B;QACnCC,OAAO,EAAE,EAAE;QACXC,GAAG,EAAE;MACP;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGf,QAAQ;IAC1B,IAAI,CAACgB,OAAO,GAAGpB,KAAK,CAACS,aAAa,EAAEF,MAAM,CAAC;IAC3C,IAAI,CAACc,YAAY,GAAGb,WAAW;EACjC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEc,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,IAAI,CAACC,UAAU,GAAGD,UAAU,CAACE,WAAW,CAAC,YAAY,CAAC;IACtD,IAAI,CAACC,UAAU,GAAGH,UAAU,CAACE,WAAW,CAAC,YAAY,CAAC;IAEtD,MAAME,gBAAgB,GAAG,IAAI1B,gBAAgB,CAAC;MAACK,MAAM,EAAE,IAAI,CAACa;IAAO,CAAC,CAAC;IAErE,MAAMS,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAAC,CAAC;IAE/CF,gBAAgB,CAACG,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDJ,gBAAgB,CAACK,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IAEnD,OAAON,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEO,YAAYA,CAACZ,KAAK,EAAE;IAClB,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;EACEO,eAAeA,CAAA,EAAG;IAChB;IACA,MAAMM,UAAU,GAAG,IAAI,CAACf,YAAY,GAAG,IAAI,CAACI,UAAU,GAAG,IAAI,CAACE,UAAU,GAAG,IAAI,CAACF,UAAU;IAE1F,IAAIS,MAAM,GAAG,EAAE;IACf;IACA,IAAIE,UAAU,KAAK,CAAC,EAAE;MACpBF,MAAM,GAAG,KAAK;IAChB,CAAC,MAAM;MACLA,MAAM,GAAG,MAAM;IACjB;IAEA,MAAMF,KAAK,GAAG,IAAI,CAACK,QAAQ,CAAClC,WAAW,EAAE+B,MAAM,CAAC;IAEhD,OAAO;MACLF,KAAK;MACLE;IACF,CAAC;EACH;AACF","ignoreList":[]}

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

@@ -0,0 +1,92 @@
+import { merge } from 'lodash';
+import Assessment from "../assessment";
+import AssessmentResult from "../../../values/AssessmentResult";
+import { LinkIcon } from '@shopify/polaris-icons';
+import { INTERNAL_LINKS_ID, LINK_RECOMMEND_POINTS } from "../../../const/analysis";
+
+/**
+ * Assessment to check whether the text has internal links and whether they are followed or no-followed.
+ */
+class InternalLinksAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} [config] The configuration to use.
+   * @param {number} [config.parameters.recommendedMinimum] The recommended minimum number of internal links in the text.
+   * @param {number} [config.scores.allInternalFollow] The score to return if all internal links are do-follow.
+   * @param {number} [config.scores.someInternalFollow] The score to return if some but not all internal links are do-follow.
+   * @param {number} [config.scores.noneInternalFollow] The score to return if all internal links are no-follow.
+   * @param {number} [config.scores.noInternal] The score to return if there are no internal links.
+   * @param {string} [config.url] The URL to the relevant KB article.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: INTERNAL_LINKS_ID,
+      fixPosition: '',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#internal-links-outbound-links',
+      icon: LinkIcon,
+      priority: 'high',
+      title: 'Internal links',
+      content: {
+        good: 'Internal links are used effectively.',
+        improve: '',
+        bad: 'No internal links found. Add links to other relevant pages on your website.'
+      }
+    };
+    this.identifier = INTERNAL_LINKS_ID;
+    this._config = merge(defaultConfig, config);
+  }
+
+  /**
+   * Runs the getLinkStatistics module, based on this returns an assessment result with score.
+   *
+   * @param {Paper} paper The paper to use for the assessment.
+   * @param {Researcher} researcher The researcher used for calling research.
+   * @returns {AssessmentResult} The result of the assessment.
+   */
+  getResult({
+    paper,
+    researcher
+  }) {
+    this.linkStatistics = researcher.getResearch('getLinkStatistics');
+    const assessmentResult = new AssessmentResult({
+      config: this._config
+    });
+    const calculatedResult = this.calculateResult();
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks if assessment is applicable to the paper.
+   *
+   * @param {Paper} paper The paper to be analyzed.
+   *
+   * @returns {boolean} Whether the paper has text.
+   */
+  isApplicable(paper) {
+    return true;
+  }
+
+  /**
+   *
+   * @returns {{score: number, status: string}}
+   */
+  calculateResult() {
+    let status = 'good';
+    if (this.linkStatistics.internalTotal === 0) {
+      status = 'bad';
+    }
+    const score = this.getScore(LINK_RECOMMEND_POINTS, status);
+    return {
+      score,
+      status
+    };
+  }
+}
+export default InternalLinksAssessment;
+//# sourceMappingURL=InternalLinksAssessment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"InternalLinksAssessment.js","names":["merge","Assessment","AssessmentResult","LinkIcon","INTERNAL_LINKS_ID","LINK_RECOMMEND_POINTS","InternalLinksAssessment","constructor","config","defaultConfig","id","fixPosition","docUrl","icon","priority","title","content","good","improve","bad","identifier","_config","getResult","paper","researcher","linkStatistics","getResearch","assessmentResult","calculatedResult","calculateResult","setScore","score","setStatus","status","isApplicable","internalTotal","getScore"],"sources":["../../../../../src/scoring/assessments/seo/InternalLinksAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {LinkIcon} from '@shopify/polaris-icons';\nimport {INTERNAL_LINKS_ID, LINK_RECOMMEND_POINTS} from '@axyseo/const/analysis';\n\n/**\n * Assessment to check whether the text has internal links and whether they are followed or no-followed.\n */\nclass InternalLinksAssessment extends Assessment {\n  /**\n   * Sets the identifier and the config.\n   *\n   * @param {Object} [config] The configuration to use.\n   * @param {number} [config.parameters.recommendedMinimum] The recommended minimum number of internal links in the text.\n   * @param {number} [config.scores.allInternalFollow] The score to return if all internal links are do-follow.\n   * @param {number} [config.scores.someInternalFollow] The score to return if some but not all internal links are do-follow.\n   * @param {number} [config.scores.noneInternalFollow] The score to return if all internal links are no-follow.\n   * @param {number} [config.scores.noInternal] The score to return if there are no internal links.\n   * @param {string} [config.url] The URL to the relevant KB article.\n   *\n   * @returns {void}\n   */\n  constructor(config = {}) {\n    super();\n\n    const defaultConfig = {\n      id: INTERNAL_LINKS_ID,\n      fixPosition: '',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#internal-links-outbound-links',\n      icon: LinkIcon,\n      priority: 'high',\n      title: 'Internal links',\n      content: {\n        good: 'Internal links are used effectively.',\n        improve: '',\n        bad: 'No internal links found. Add links to other relevant pages on your website.'\n      }\n    };\n\n    this.identifier = INTERNAL_LINKS_ID;\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Runs the getLinkStatistics module, based on this returns an assessment result with score.\n   *\n   * @param {Paper} paper The paper to use for the assessment.\n   * @param {Researcher} researcher The researcher used for calling research.\n   * @returns {AssessmentResult} The result of the assessment.\n   */\n  getResult({paper, researcher}) {\n    this.linkStatistics = researcher.getResearch('getLinkStatistics');\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    const calculatedResult = this.calculateResult();\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks if assessment is applicable to the paper.\n   *\n   * @param {Paper} paper The paper to be analyzed.\n   *\n   * @returns {boolean} Whether the paper has text.\n   */\n  isApplicable(paper) {\n    return true;\n  }\n\n  /**\n   *\n   * @returns {{score: number, status: string}}\n   */\n  calculateResult() {\n    let status = 'good';\n    if (this.linkStatistics.internalTotal === 0) {\n      status = 'bad';\n    }\n\n    const score = this.getScore(LINK_RECOMMEND_POINTS, status);\n\n    return {\n      score,\n      status\n    };\n  }\n}\n\nexport default InternalLinksAssessment;\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,QAAQ;AAC5B,OAAOC,UAAU;AACjB,OAAOC,gBAAgB;AACvB,SAAQC,QAAQ,QAAO,wBAAwB;AAC/C,SAAQC,iBAAiB,EAAEC,qBAAqB;;AAEhD;AACA;AACA;AACA,MAAMC,uBAAuB,SAASL,UAAU,CAAC;EAC/C;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEM,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEN,iBAAiB;MACrBO,WAAW,EAAE,EAAE;MACfC,MAAM,EACJ,2GAA2G;MAC7GC,IAAI,EAAEV,QAAQ;MACdW,QAAQ,EAAE,MAAM;MAChBC,KAAK,EAAE,gBAAgB;MACvBC,OAAO,EAAE;QACPC,IAAI,EAAE,sCAAsC;QAC5CC,OAAO,EAAE,EAAE;QACXC,GAAG,EAAE;MACP;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGhB,iBAAiB;IACnC,IAAI,CAACiB,OAAO,GAAGrB,KAAK,CAACS,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEc,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,IAAI,CAACC,cAAc,GAAGD,UAAU,CAACE,WAAW,CAAC,mBAAmB,CAAC;IACjE,MAAMC,gBAAgB,GAAG,IAAIzB,gBAAgB,CAAC;MAACM,MAAM,EAAE,IAAI,CAACa;IAAO,CAAC,CAAC;IAErE,MAAMO,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAAC,CAAC;IAC/CF,gBAAgB,CAACG,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDJ,gBAAgB,CAACK,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IAEnD,OAAON,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEO,YAAYA,CAACX,KAAK,EAAE;IAClB,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;EACEM,eAAeA,CAAA,EAAG;IAChB,IAAII,MAAM,GAAG,MAAM;IACnB,IAAI,IAAI,CAACR,cAAc,CAACU,aAAa,KAAK,CAAC,EAAE;MAC3CF,MAAM,GAAG,KAAK;IAChB;IAEA,MAAMF,KAAK,GAAG,IAAI,CAACK,QAAQ,CAAC/B,qBAAqB,EAAE4B,MAAM,CAAC;IAE1D,OAAO;MACLF,KAAK;MACLE;IACF,CAAC;EACH;AACF;AAEA,eAAe3B,uBAAuB","ignoreList":[]}