axyseo 2.1.11 → 2.1.13

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

@@ -0,0 +1,126 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _AssessmentResult = _interopRequireDefault(require("../../../values/AssessmentResult"));
+var _assessment = _interopRequireDefault(require("../assessment"));
+var _polarisIcons = require("@shopify/polaris-icons");
+var _analysis = require("../../../const/analysis");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const maximumConsecutiveDuplicates = 2;
+
+/**
+ * Represents the assessment that checks whether there are three or more consecutive sentences beginning with the same word.
+ */
+class SentenceBeginningsAssessment extends _assessment.default {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {object} config The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: _analysis.SENTENCE_BEGINNINGS_ID,
+      priority: 'medium',
+      ctaType: 'fix',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#sentence-beginnings',
+      fixPosition: 'description',
+      icon: _polarisIcons.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 = _analysis.SENTENCE_BEGINNINGS_ID;
+    this._config = (0, _lodash.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 = (0, _lodash.partition)(sentenceBeginnings, function (word) {
+      return word.count > maximumConsecutiveDuplicates;
+    });
+    if (tooOften[0].length === 0) {
+      return {
+        total: 0
+      };
+    }
+    const sortedCounts = (0, _lodash.sortBy)(tooOften[0], function (word) {
+      return word.count;
+    });
+    return {
+      total: tooOften[0].length,
+      lowestCount: sortedCounts[0].count
+    };
+  }
+
+  /**
+   *
+   * @param groupedSentenceBeginnings
+   * @returns {{score: number, status: string}}
+   */
+  calculateSentenceBeginningsResult(groupedSentenceBeginnings) {
+    let status = '';
+    if (groupedSentenceBeginnings.total > 0) {
+      status = 'bad';
+    } else {
+      status = 'good';
+    }
+    const score = this.getScore(this._config.priority, status);
+    return {
+      score,
+      status
+    };
+  }
+
+  /**
+   *
+   * @param paper
+   * @param researcher
+   * @returns {AssessmentResult}
+   */
+  getResult({
+    paper,
+    researcher
+  }) {
+    const sentenceBeginnings = researcher.getResearch('getSentenceBeginnings');
+    const sentenceBeginningsErrors = sentenceBeginnings.filter(sentenceBeginning => sentenceBeginning.count > maximumConsecutiveDuplicates);
+    const groupedSentenceBeginnings = this.groupSentenceBeginnings(sentenceBeginnings);
+    const calculatedResult = this.calculateSentenceBeginningsResult(groupedSentenceBeginnings);
+    const assessmentResult = new _AssessmentResult.default({
+      config: this._config
+    });
+    assessmentResult.setData(sentenceBeginningsErrors);
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    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');
+  }
+}
+exports.default = SentenceBeginningsAssessment;
+//# sourceMappingURL=SentenceBeginningsAssessment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SentenceBeginningsAssessment.js","names":["_lodash","require","_AssessmentResult","_interopRequireDefault","_assessment","_polarisIcons","_analysis","e","__esModule","default","maximumConsecutiveDuplicates","SentenceBeginningsAssessment","Assessment","constructor","config","defaultConfig","id","SENTENCE_BEGINNINGS_ID","priority","ctaType","docUrl","fixPosition","icon","TextBlockIcon","title","content","improve","bad","good","identifier","_config","merge","groupSentenceBeginnings","sentenceBeginnings","tooOften","partition","word","count","length","total","sortedCounts","sortBy","lowestCount","calculateSentenceBeginningsResult","groupedSentenceBeginnings","status","score","getScore","getResult","paper","researcher","getResearch","sentenceBeginningsErrors","filter","sentenceBeginning","calculatedResult","assessmentResult","AssessmentResult","setData","setScore","setStatus","isApplicable","hasEnoughContentForAssessment","hasResearch","exports"],"sources":["../../../../../src/scoring/assessments/readability/SentenceBeginningsAssessment.js"],"sourcesContent":["import {merge, partition, sortBy} from 'lodash';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\nimport {TextBlockIcon} from '@shopify/polaris-icons';\nimport {SENTENCE_BEGINNINGS_ID} from '@axyseo/const/analysis';\n\nconst maximumConsecutiveDuplicates = 2;\n\n/**\n * Represents the assessment that checks whether there are three or more consecutive sentences beginning with the same word.\n */\nexport default class SentenceBeginningsAssessment extends Assessment {\n  /**\n   * Sets the identifier and the config.\n   *\n   * @param {object} config The configuration to use.\n   *\n   * @returns {void}\n   */\n  constructor(config = {}) {\n    super();\n\n    const defaultConfig = {\n      id: SENTENCE_BEGINNINGS_ID,\n      priority: 'medium',\n      ctaType: 'fix',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#sentence-beginnings',\n      fixPosition: 'description',\n      icon: TextBlockIcon,\n      title: 'Sentence beginnings',\n      content: {\n        improve: '',\n        bad:\n          'Found sentences with repetitive beginnings. Change the wording for more engaging content.',\n        good: 'No sentences with repetitive beginnings found.'\n      }\n    };\n\n    this.identifier = SENTENCE_BEGINNINGS_ID;\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Counts and groups the number too often used sentence beginnings and determines the lowest count within that group.\n   *\n   * @param {array} sentenceBeginnings The array containing the objects containing the beginning words and counts.\n   *\n   * @returns {object} The object containing the total number of too often used beginnings and the lowest count within those.\n   */\n  groupSentenceBeginnings(sentenceBeginnings) {\n    const tooOften = partition(sentenceBeginnings, function(word) {\n      return word.count > maximumConsecutiveDuplicates;\n    });\n\n    if (tooOften[0].length === 0) {\n      return {total: 0};\n    }\n\n    const sortedCounts = sortBy(tooOften[0], function(word) {\n      return word.count;\n    });\n\n    return {total: tooOften[0].length, lowestCount: sortedCounts[0].count};\n  }\n\n  /**\n   *\n   * @param groupedSentenceBeginnings\n   * @returns {{score: number, status: string}}\n   */\n  calculateSentenceBeginningsResult(groupedSentenceBeginnings) {\n    let status = '';\n    if (groupedSentenceBeginnings.total > 0) {\n      status = 'bad';\n    } else {\n      status = 'good';\n    }\n\n    const score = this.getScore(this._config.priority, status);\n\n    return {\n      score,\n      status\n    };\n  }\n\n  /**\n   *\n   * @param paper\n   * @param researcher\n   * @returns {AssessmentResult}\n   */\n  getResult({paper, researcher}) {\n    const sentenceBeginnings = researcher.getResearch('getSentenceBeginnings');\n    const sentenceBeginningsErrors = sentenceBeginnings.filter(\n      sentenceBeginning => sentenceBeginning.count > maximumConsecutiveDuplicates\n    );\n\n    const groupedSentenceBeginnings = this.groupSentenceBeginnings(sentenceBeginnings);\n    const calculatedResult = this.calculateSentenceBeginningsResult(groupedSentenceBeginnings);\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setData(sentenceBeginningsErrors);\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks if the sentence beginnings assessment is applicable to the paper.\n   *\n   * @param {Object}      paper       The paper to check.\n   * @param {Researcher}  researcher  The researcher object.\n   *\n   * @returns {boolean} Returns true if the language is available and the paper is not empty.\n   */\n  isApplicable(paper, researcher) {\n    return (\n      this.hasEnoughContentForAssessment(paper) && researcher.hasResearch('getSentenceBeginnings')\n    );\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,iBAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,WAAA,GAAAD,sBAAA,CAAAF,OAAA;AACA,IAAAI,aAAA,GAAAJ,OAAA;AACA,IAAAK,SAAA,GAAAL,OAAA;AAA8D,SAAAE,uBAAAI,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9D,MAAMG,4BAA4B,GAAG,CAAC;;AAEtC;AACA;AACA;AACe,MAAMC,4BAA4B,SAASC,mBAAU,CAAC;EACnE;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEC,gCAAsB;MAC1BC,QAAQ,EAAE,QAAQ;MAClBC,OAAO,EAAE,KAAK;MACdC,MAAM,EACJ,iGAAiG;MACnGC,WAAW,EAAE,aAAa;MAC1BC,IAAI,EAAEC,2BAAa;MACnBC,KAAK,EAAE,qBAAqB;MAC5BC,OAAO,EAAE;QACPC,OAAO,EAAE,EAAE;QACXC,GAAG,EACD,2FAA2F;QAC7FC,IAAI,EAAE;MACR;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGZ,gCAAsB;IACxC,IAAI,CAACa,OAAO,GAAG,IAAAC,aAAK,EAAChB,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEkB,uBAAuBA,CAACC,kBAAkB,EAAE;IAC1C,MAAMC,QAAQ,GAAG,IAAAC,iBAAS,EAACF,kBAAkB,EAAE,UAASG,IAAI,EAAE;MAC5D,OAAOA,IAAI,CAACC,KAAK,GAAG3B,4BAA4B;IAClD,CAAC,CAAC;IAEF,IAAIwB,QAAQ,CAAC,CAAC,CAAC,CAACI,MAAM,KAAK,CAAC,EAAE;MAC5B,OAAO;QAACC,KAAK,EAAE;MAAC,CAAC;IACnB;IAEA,MAAMC,YAAY,GAAG,IAAAC,cAAM,EAACP,QAAQ,CAAC,CAAC,CAAC,EAAE,UAASE,IAAI,EAAE;MACtD,OAAOA,IAAI,CAACC,KAAK;IACnB,CAAC,CAAC;IAEF,OAAO;MAACE,KAAK,EAAEL,QAAQ,CAAC,CAAC,CAAC,CAACI,MAAM;MAAEI,WAAW,EAAEF,YAAY,CAAC,CAAC,CAAC,CAACH;IAAK,CAAC;EACxE;;EAEA;AACF;AACA;AACA;AACA;EACEM,iCAAiCA,CAACC,yBAAyB,EAAE;IAC3D,IAAIC,MAAM,GAAG,EAAE;IACf,IAAID,yBAAyB,CAACL,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,CAACjB,OAAO,CAACZ,QAAQ,EAAE2B,MAAM,CAAC;IAE1D,OAAO;MACLC,KAAK;MACLD;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEG,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMjB,kBAAkB,GAAGiB,UAAU,CAACC,WAAW,CAAC,uBAAuB,CAAC;IAC1E,MAAMC,wBAAwB,GAAGnB,kBAAkB,CAACoB,MAAM,CACxDC,iBAAiB,IAAIA,iBAAiB,CAACjB,KAAK,GAAG3B,4BACjD,CAAC;IAED,MAAMkC,yBAAyB,GAAG,IAAI,CAACZ,uBAAuB,CAACC,kBAAkB,CAAC;IAClF,MAAMsB,gBAAgB,GAAG,IAAI,CAACZ,iCAAiC,CAACC,yBAAyB,CAAC;IAC1F,MAAMY,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAAC3C,MAAM,EAAE,IAAI,CAACgB;IAAO,CAAC,CAAC;IAErE0B,gBAAgB,CAACE,OAAO,CAACN,wBAAwB,CAAC;IAClDI,gBAAgB,CAACG,QAAQ,CAACJ,gBAAgB,CAACT,KAAK,CAAC;IACjDU,gBAAgB,CAACI,SAAS,CAACL,gBAAgB,CAACV,MAAM,CAAC;IAEnD,OAAOW,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEK,YAAYA,CAACZ,KAAK,EAAEC,UAAU,EAAE;IAC9B,OACE,IAAI,CAACY,6BAA6B,CAACb,KAAK,CAAC,IAAIC,UAAU,CAACa,WAAW,CAAC,uBAAuB,CAAC;EAEhG;AACF;AAACC,OAAA,CAAAvD,OAAA,GAAAE,4BAAA","ignoreList":[]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"SentenceLengthInTextAssessment.js","names":["_lodash","require","_assessment","_interopRequireDefault","_checkForTooLongSentences","_formatNumber","_AssessmentResult","_polarisIcons","_analysis","e","__esModule","default","SentenceLengthInTextAssessment","Assessment","constructor","config","isCornerstone","isProduct","defaultConfig","id","TEXT_SENTENCE_LENGTH_ID","priority","docUrl","ctaType","fixPosition","icon","TextBlockIcon","recommendedLength","slightlyTooMany","farTooMany","title","content","improve","bad","good","_config","merge","identifier","getResult","paper","researcher","sentences","getResearch","getConfig","getLanguageSpecificConfig","percentage","calculatePercentage","result","calculateResult","assessmentResult","AssessmentResult","setScore","score","setStatus","status","isApplicable","hasEnoughContentForAssessment","currentConfig","languageSpecificConfig","hasOwnProperty","length","tooLongTotal","countTooLongSentences","formatNumber","getScore","getTooLongSentences","_default","exports"],"sources":["../../../../../src/scoring/assessments/readability/SentenceLengthInTextAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport Assessment from '../assessment';\nimport getTooLongSentences from '../../helpers/assessments/checkForTooLongSentences';\nimport formatNumber from '../../../helpers/formatNumber';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {TextBlockIcon} from '@shopify/polaris-icons';\nimport {TEXT_SENTENCE_LENGTH_ID} from '@axyseo/const/analysis';\n\n/**\n * Represents the assessment that will calculate the length of sentences in the text.\n */\nclass SentenceLengthInTextAssessment extends Assessment {\n  /**\n\t * Sets the identifier and the config.\n\t *\n\t * @param {object} config\t\t\tThe scoring configuration that should be used.\n\t * @param {boolean} isCornerstone\tWhether cornerstone configuration should be used.\n\t * @param {boolean} isProduct\t\tWhether product configuration should be used.\n\n\t * @returns {void}\n\t */\n  constructor(config = {}, isCornerstone = false, isProduct = false) {\n    super();\n\n    const defaultConfig = {\n      id: TEXT_SENTENCE_LENGTH_ID,\n      priority: 'high',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#sentence-length',\n      ctaType: 'fix',\n      fixPosition: 'sentenceLength',\n      icon: TextBlockIcon,\n      recommendedLength: 20,\n      slightlyTooMany: 25,\n      farTooMany: 30,\n      title: 'Text Sentence Length',\n      content: {\n        improve: '',\n        bad:\n          'Sentence too long. Keep sentence length less than 20 words to improve readability and flow.',\n        good: 'Sentence length is optimized for readability, less than 20 words.'\n      }\n    };\n\n    this._config = merge(defaultConfig, config);\n    this.identifier = TEXT_SENTENCE_LENGTH_ID;\n  }\n\n  /**\n   * Scores the percentage of sentences including more than the recommended number of words.\n   *\n   * @param {Paper} paper The paper to use for the assessment.\n   * @param {Researcher} researcher The researcher used for calling research.\n   *\n   * @returns {AssessmentResult} The Assessment result.\n   */\n  getResult({paper, researcher}) {\n    const sentences = researcher.getResearch('countSentencesFromText');\n    if (researcher.getConfig('sentenceLength')) {\n      this._config = this.getLanguageSpecificConfig(researcher);\n    }\n\n    const percentage = this.calculatePercentage(sentences);\n    const result = this.calculateResult(percentage);\n\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(result.score);\n    assessmentResult.setStatus(result.status);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks whether the paper has text.\n   *\n   * @param {Paper} paper The paper to use for the assessment.\n   *\n   * @returns {boolean} True when there is text.\n   */\n  isApplicable(paper) {\n    return this.hasEnoughContentForAssessment(paper);\n  }\n\n  /**\n   * Check if there is language-specific config, and if so, overwrite the current config with it.\n   *\n   * @param {Researcher} researcher The researcher to use.\n   *\n   * @returns {Object} The config that should be used.\n   */\n  getLanguageSpecificConfig(researcher) {\n    const currentConfig = this._config;\n    const languageSpecificConfig = researcher.getConfig('sentenceLength');\n\n    if (languageSpecificConfig.hasOwnProperty('recommendedLength')) {\n      currentConfig.recommendedLength = languageSpecificConfig.recommendedLength;\n    }\n\n    return currentConfig;\n  }\n\n  /**\n   * Calculates the percentage of sentences that are too long.\n   *\n   * @param {Array} sentences The sentences to calculate the percentage for.\n   * @returns {number} The calculates percentage of too long sentences.\n   */\n  calculatePercentage(sentences) {\n    let percentage = 0;\n\n    if (sentences.length !== 0) {\n      const tooLongTotal = this.countTooLongSentences(sentences);\n\n      percentage = formatNumber((tooLongTotal / sentences.length) * 100);\n    }\n\n    return percentage;\n  }\n\n  /**\n   *\n   * @param percentage\n   * @returns {{score: number, status: string}}\n   */\n  calculateResult(percentage) {\n    let status = '';\n    if (percentage <= this._config.recommendedLength) {\n      status = 'good';\n    }\n\n    if (percentage > this._config.recommendedLength) {\n      status = 'bad';\n    }\n\n    const score = this.getScore(this._config.priority, status);\n\n    this._config.content = {\n      improve: '',\n      bad: `Sentence too long. Keep sentence length less than ${this._config.recommendedLength} words to improve readability and flow.`,\n      good: `Sentence length is optimized for readability, less than ${this._config.recommendedLength} words.`\n    };\n\n    return {\n      score,\n      status\n    };\n  }\n\n  /**\n   * Gets the sentences that are qualified as being too long.\n   *\n   * @param {array} sentences The sentences to filter through.\n   * @returns {array} Array with all the sentences considered to be too long.\n   */\n  getTooLongSentences(sentences) {\n    return getTooLongSentences(sentences, this._config.recommendedLength);\n  }\n\n  /**\n   * Get the total amount of sentences that are qualified as being too long.\n   *\n   * @param {Array} sentences The sentences to filter through.\n   * @returns {Number} The amount of sentences that are considered too long.\n   */\n  countTooLongSentences(sentences) {\n    return this.getTooLongSentences(sentences).length;\n  }\n}\n\nexport default SentenceLengthInTextAssessment;\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,WAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,yBAAA,GAAAD,sBAAA,CAAAF,OAAA;AACA,IAAAI,aAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,iBAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,aAAA,GAAAN,OAAA;AACA,IAAAO,SAAA,GAAAP,OAAA;AAA+D,SAAAE,uBAAAM,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE/D;AACA;AACA;AACA,MAAMG,8BAA8B,SAASC,mBAAU,CAAC;EACtD;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAEEC,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAEC,aAAa,GAAG,KAAK,EAAEC,SAAS,GAAG,KAAK,EAAE;IACjE,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEC,iCAAuB;MAC3BC,QAAQ,EAAE,MAAM;MAChBC,MAAM,EACJ,6FAA6F;MAC/FC,OAAO,EAAE,KAAK;MACdC,WAAW,EAAE,gBAAgB;MAC7BC,IAAI,EAAEC,2BAAa;MACnBC,iBAAiB,EAAE,EAAE;MACrBC,eAAe,EAAE,EAAE;MACnBC,UAAU,EAAE,EAAE;MACdC,KAAK,EAAE,sBAAsB;MAC7BC,OAAO,EAAE;QACPC,OAAO,EAAE,EAAE;QACXC,GAAG,EACD,6FAA6F;QAC/FC,IAAI,EAAE;MACR;IACF,CAAC;IAED,IAAI,CAACC,OAAO,GAAG,IAAAC,aAAK,EAAClB,aAAa,EAAEH,MAAM,CAAC;IAC3C,IAAI,CAACsB,UAAU,GAAGjB,iCAAuB;EAC3C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEkB,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMC,SAAS,GAAGD,UAAU,CAACE,WAAW,CAAC,wBAAwB,CAAC;IAClE,IAAIF,UAAU,CAACG,SAAS,CAAC,gBAAgB,CAAC,EAAE;MAC1C,IAAI,CAACR,OAAO,GAAG,IAAI,CAACS,yBAAyB,CAACJ,UAAU,CAAC;IAC3D;IAEA,MAAMK,UAAU,GAAG,IAAI,CAACC,mBAAmB,CAACL,SAAS,CAAC;IACtD,MAAMM,MAAM,GAAG,IAAI,CAACC,eAAe,CAACH,UAAU,CAAC;IAE/C,MAAMI,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAACnC,MAAM,EAAE,IAAI,CAACoB;IAAO,CAAC,CAAC;IAErEc,gBAAgB,CAACE,QAAQ,CAACJ,MAAM,CAACK,KAAK,CAAC;IACvCH,gBAAgB,CAACI,SAAS,CAACN,MAAM,CAACO,MAAM,CAAC;IAEzC,OAAOL,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEM,YAAYA,CAAChB,KAAK,EAAE;IAClB,OAAO,IAAI,CAACiB,6BAA6B,CAACjB,KAAK,CAAC;EAClD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEK,yBAAyBA,CAACJ,UAAU,EAAE;IACpC,MAAMiB,aAAa,GAAG,IAAI,CAACtB,OAAO;IAClC,MAAMuB,sBAAsB,GAAGlB,UAAU,CAACG,SAAS,CAAC,gBAAgB,CAAC;IAErE,IAAIe,sBAAsB,CAACC,cAAc,CAAC,mBAAmB,CAAC,EAAE;MAC9DF,aAAa,CAAC9B,iBAAiB,GAAG+B,sBAAsB,CAAC/B,iBAAiB;IAC5E;IAEA,OAAO8B,aAAa;EACtB;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEX,mBAAmBA,CAACL,SAAS,EAAE;IAC7B,IAAII,UAAU,GAAG,CAAC;IAElB,IAAIJ,SAAS,CAACmB,MAAM,KAAK,CAAC,EAAE;MAC1B,MAAMC,YAAY,GAAG,IAAI,CAACC,qBAAqB,CAACrB,SAAS,CAAC;MAE1DI,UAAU,GAAG,IAAAkB,qBAAY,EAAEF,YAAY,GAAGpB,SAAS,CAACmB,MAAM,GAAI,GAAG,CAAC;IACpE;IAEA,OAAOf,UAAU;EACnB;;EAEA;AACF;AACA;AACA;AACA;EACEG,eAAeA,CAACH,UAAU,EAAE;IAC1B,IAAIS,MAAM,GAAG,EAAE;IACf,IAAIT,UAAU,IAAI,IAAI,CAACV,OAAO,CAACR,iBAAiB,EAAE;MAChD2B,MAAM,GAAG,MAAM;IACjB;IAEA,IAAIT,UAAU,GAAG,IAAI,CAACV,OAAO,CAACR,iBAAiB,EAAE;MAC/C2B,MAAM,GAAG,KAAK;IAChB;IAEA,MAAMF,KAAK,GAAG,IAAI,CAACY,QAAQ,CAAC,IAAI,CAAC7B,OAAO,CAACd,QAAQ,EAAEiC,MAAM,CAAC;IAE1D,IAAI,CAACnB,OAAO,CAACJ,OAAO,GAAG;MACrBC,OAAO,EAAE,EAAE;MACXC,GAAG,EAAE,qDAAqD,IAAI,CAACE,OAAO,CAACR,iBAAiB,yCAAyC;MACjIO,IAAI,EAAE,2DAA2D,IAAI,CAACC,OAAO,CAACR,iBAAiB;IACjG,CAAC;IAED,OAAO;MACLyB,KAAK;MACLE;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEW,mBAAmBA,CAACxB,SAAS,EAAE;IAC7B,OAAO,IAAAwB,iCAAmB,EAACxB,SAAS,EAAE,IAAI,CAACN,OAAO,CAACR,iBAAiB,CAAC;EACvE;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEmC,qBAAqBA,CAACrB,SAAS,EAAE;IAC/B,OAAO,IAAI,CAACwB,mBAAmB,CAACxB,SAAS,CAAC,CAACmB,MAAM;EACnD;AACF;AAAC,IAAAM,QAAA,GAAAC,OAAA,CAAAxD,OAAA,GAEcC,8BAA8B","ignoreList":[]}

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

@@ -0,0 +1,148 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _formatNumber = _interopRequireDefault(require("../../../helpers/formatNumber"));
+var _inRange = require("../../helpers/assessments/inRange");
+var _AssessmentResult = _interopRequireDefault(require("../../../values/AssessmentResult"));
+var _assessment = _interopRequireDefault(require("../assessment"));
+var _htmlParser = _interopRequireDefault(require("../../../languageProcessing/helpers/html/htmlParser"));
+var _getWords = _interopRequireDefault(require("../../../languageProcessing/helpers/word/getWords"));
+var _helpers = require("../../../languageProcessing/helpers");
+var _analysis = require("../../../const/analysis");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Represents the assessment that checks whether there are enough transition words in the text.
+ */
+class TransitionWordsAssessment extends _assessment.default {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {object} config The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: _analysis.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 = _analysis.TEXT_TRANSITION_WORDS_ID;
+    this._config = (0, _lodash.merge)(defaultConfig, config);
+  }
+
+  /**
+   * Calculates the actual percentage of transition words in the sentences.
+   *
+   * @param {object} sentences The object containing the total number of sentences and the number of sentences containing
+   * a transition word.
+   *
+   * @returns {number} The percentage of sentences containing a transition word.
+   */
+  calculateTransitionWordPercentage(sentences) {
+    if (sentences.transitionWordSentences === 0 || sentences.totalSentences === 0) {
+      return 0;
+    }
+    return (0, _formatNumber.default)(sentences.transitionWordSentences / sentences.totalSentences * 100);
+  }
+
+  /**
+   * Calculates the score for the assessment based on the percentage of sentences containing transition words.
+   *
+   * @param {number} percentage The percentage of sentences containing transition words.
+   *
+   * @returns {number} The score.
+   */
+  calculateScoreFromPercentage(percentage) {
+    if (percentage < 10) {
+      // Red indicator.
+      return 3;
+    }
+    if ((0, _inRange.inRangeStartInclusive)(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(this._config.priority, 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.default({
+      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 = (0, _htmlParser.default)(text);
+    text = (0, _helpers.filterShortcodesFromHTML)(text, paper._attributes && paper._attributes.shortcodes);
+    const textLength = customCountLength ? customCountLength(text) : (0, _getWords.default)(text).length;
+
+    // Do not use hasEnoughContent in this assessment as it is mostly redundant with `textLength >= this._config.applicableIfTextLongerThan`
+    return textLength >= this._config.applicableIfTextLongerThan && researcher.hasResearch('findTransitionWords');
+  }
+}
+exports.default = TransitionWordsAssessment;
+//# sourceMappingURL=TransitionWordsAssessment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TransitionWordsAssessment.js","names":["_lodash","require","_formatNumber","_interopRequireDefault","_inRange","_AssessmentResult","_assessment","_htmlParser","_getWords","_helpers","_analysis","e","__esModule","default","TransitionWordsAssessment","Assessment","constructor","config","defaultConfig","id","TEXT_TRANSITION_WORDS_ID","fixPosition","ctaType","docUrl","priority","applicableIfTextLongerThan","title","content","good","bad","improve","identifier","_config","merge","calculateTransitionWordPercentage","sentences","transitionWordSentences","totalSentences","formatNumber","calculateScoreFromPercentage","percentage","inRange","calculateTransitionWordResult","score","status","customScore","getScore","getResult","paper","researcher","getResearch","transitionWordResult","assessmentResult","AssessmentResult","setScore","setStatus","isApplicable","customCountLength","getHelper","customApplicabilityConfig","getConfig","transitionWords","text","getText","removeHtmlBlocks","filterShortcodesFromHTML","_attributes","shortcodes","textLength","getWords","length","hasResearch","exports"],"sources":["../../../../../src/scoring/assessments/readability/TransitionWordsAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport formatNumber from '../../../helpers/formatNumber';\nimport {inRangeStartInclusive as inRange} from '../../helpers/assessments/inRange';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\nimport removeHtmlBlocks from '@axyseo/languageProcessing/helpers/html/htmlParser';\nimport getWords from '@axyseo/languageProcessing/helpers/word/getWords';\nimport {filterShortcodesFromHTML} from '@axyseo/languageProcessing/helpers';\nimport {TEXT_TRANSITION_WORDS_ID} from '@axyseo/const/analysis';\n\n/**\n * Represents the assessment that checks whether there are enough transition words in the text.\n */\nexport default class TransitionWordsAssessment extends Assessment {\n  /**\n   * Sets the identifier and the config.\n   *\n   * @param {object} config The configuration to use.\n   *\n   * @returns {void}\n   */\n  constructor(config = {}) {\n    super();\n\n    const defaultConfig = {\n      id: TEXT_TRANSITION_WORDS_ID,\n      fixPosition: 'longestParagraph',\n      ctaType: 'fix',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#use-of-transition-words',\n      priority: 'low',\n      applicableIfTextLongerThan: 200,\n      title: 'Use of transition words',\n      content: {\n        good: 'Transition words are used effectively.',\n        bad:\n          'Lack of transition words. Improve readability and flow by adding words like \"however,\" \"also,\" etc.',\n        improve: ''\n      }\n    };\n\n    this.identifier = TEXT_TRANSITION_WORDS_ID;\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Calculates the actual percentage of transition words in the sentences.\n   *\n   * @param {object} sentences The object containing the total number of sentences and the number of sentences containing\n   * a transition word.\n   *\n   * @returns {number} The percentage of sentences containing a transition word.\n   */\n  calculateTransitionWordPercentage(sentences) {\n    if (sentences.transitionWordSentences === 0 || sentences.totalSentences === 0) {\n      return 0;\n    }\n\n    return formatNumber((sentences.transitionWordSentences / sentences.totalSentences) * 100);\n  }\n\n  /**\n   * Calculates the score for the assessment based on the percentage of sentences containing transition words.\n   *\n   * @param {number} percentage The percentage of sentences containing transition words.\n   *\n   * @returns {number} The score.\n   */\n  calculateScoreFromPercentage(percentage) {\n    if (percentage < 10) {\n      // Red indicator.\n      return 3;\n    }\n\n    if (inRange(percentage, 10, 20)) {\n      // Orange indicator.\n      return 6;\n    }\n\n    // Green indicator.\n    return 9;\n  }\n\n  /**\n   *\n   * @param transitionWordSentences\n   * @returns {{score: number, status: string}}\n   */\n  calculateTransitionWordResult(transitionWordSentences) {\n    const percentage = this.calculateTransitionWordPercentage(transitionWordSentences);\n    const score = this.calculateScoreFromPercentage(percentage);\n\n    let status = 'good';\n    if (score < 6 || percentage === 0) {\n      status = 'bad';\n    }\n\n    const customScore = this.getScore(this._config.priority, status);\n\n    return {\n      score: customScore,\n      status\n    };\n  }\n\n  /**\n   *\n   * @param paper\n   * @param researcher\n   * @returns {AssessmentResult}\n   */\n  getResult({paper, researcher}) {\n    const transitionWordSentences = researcher.getResearch('findTransitionWords');\n    const transitionWordResult = this.calculateTransitionWordResult(transitionWordSentences);\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(transitionWordResult.score);\n    assessmentResult.setStatus(transitionWordResult.status);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks if the transition words assessment is applicable to the paper. Language-specific length requirements and methods of counting text length\n   * may apply (e.g. for Japanese, the text should be counted in characters instead of words, which also makes the minimum required length higher).\n   *\n   * @param {Paper}       paper       The paper to check.\n   * @param {Researcher}  researcher  The researcher object.\n   *\n   * @returns {boolean} Returns true if the language is available, the paper is not empty and the text is longer than the minimum required length.\n   */\n  isApplicable(paper, researcher) {\n    const customCountLength = researcher.getHelper('customCountLength');\n    const customApplicabilityConfig = researcher.getConfig('assessmentApplicability')\n      .transitionWords;\n    if (customApplicabilityConfig) {\n      this._config.applicableIfTextLongerThan = customApplicabilityConfig;\n    }\n    let text = paper.getText();\n    text = removeHtmlBlocks(text);\n    text = filterShortcodesFromHTML(text, paper._attributes && paper._attributes.shortcodes);\n    const textLength = customCountLength ? customCountLength(text) : getWords(text).length;\n\n    // Do not use hasEnoughContent in this assessment as it is mostly redundant with `textLength >= this._config.applicableIfTextLongerThan`\n    return (\n      textLength >= this._config.applicableIfTextLongerThan &&\n      researcher.hasResearch('findTransitionWords')\n    );\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,QAAA,GAAAH,OAAA;AACA,IAAAI,iBAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,WAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,WAAA,GAAAJ,sBAAA,CAAAF,OAAA;AACA,IAAAO,SAAA,GAAAL,sBAAA,CAAAF,OAAA;AACA,IAAAQ,QAAA,GAAAR,OAAA;AACA,IAAAS,SAAA,GAAAT,OAAA;AAAgE,SAAAE,uBAAAQ,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEhE;AACA;AACA;AACe,MAAMG,yBAAyB,SAASC,mBAAU,CAAC;EAChE;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEC,kCAAwB;MAC5BC,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,GAAGX,kCAAwB;IAC1C,IAAI,CAACY,OAAO,GAAG,IAAAC,aAAK,EAACf,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEiB,iCAAiCA,CAACC,SAAS,EAAE;IAC3C,IAAIA,SAAS,CAACC,uBAAuB,KAAK,CAAC,IAAID,SAAS,CAACE,cAAc,KAAK,CAAC,EAAE;MAC7E,OAAO,CAAC;IACV;IAEA,OAAO,IAAAC,qBAAY,EAAEH,SAAS,CAACC,uBAAuB,GAAGD,SAAS,CAACE,cAAc,GAAI,GAAG,CAAC;EAC3F;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEE,4BAA4BA,CAACC,UAAU,EAAE;IACvC,IAAIA,UAAU,GAAG,EAAE,EAAE;MACnB;MACA,OAAO,CAAC;IACV;IAEA,IAAI,IAAAC,8BAAO,EAACD,UAAU,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE;MAC/B;MACA,OAAO,CAAC;IACV;;IAEA;IACA,OAAO,CAAC;EACV;;EAEA;AACF;AACA;AACA;AACA;EACEE,6BAA6BA,CAACN,uBAAuB,EAAE;IACrD,MAAMI,UAAU,GAAG,IAAI,CAACN,iCAAiC,CAACE,uBAAuB,CAAC;IAClF,MAAMO,KAAK,GAAG,IAAI,CAACJ,4BAA4B,CAACC,UAAU,CAAC;IAE3D,IAAII,MAAM,GAAG,MAAM;IACnB,IAAID,KAAK,GAAG,CAAC,IAAIH,UAAU,KAAK,CAAC,EAAE;MACjCI,MAAM,GAAG,KAAK;IAChB;IAEA,MAAMC,WAAW,GAAG,IAAI,CAACC,QAAQ,CAAC,IAAI,CAACd,OAAO,CAACR,QAAQ,EAAEoB,MAAM,CAAC;IAEhE,OAAO;MACLD,KAAK,EAAEE,WAAW;MAClBD;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEG,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMb,uBAAuB,GAAGa,UAAU,CAACC,WAAW,CAAC,qBAAqB,CAAC;IAC7E,MAAMC,oBAAoB,GAAG,IAAI,CAACT,6BAA6B,CAACN,uBAAuB,CAAC;IACxF,MAAMgB,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAACpC,MAAM,EAAE,IAAI,CAACe;IAAO,CAAC,CAAC;IAErEoB,gBAAgB,CAACE,QAAQ,CAACH,oBAAoB,CAACR,KAAK,CAAC;IACrDS,gBAAgB,CAACG,SAAS,CAACJ,oBAAoB,CAACP,MAAM,CAAC;IAEvD,OAAOQ,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEI,YAAYA,CAACR,KAAK,EAAEC,UAAU,EAAE;IAC9B,MAAMQ,iBAAiB,GAAGR,UAAU,CAACS,SAAS,CAAC,mBAAmB,CAAC;IACnE,MAAMC,yBAAyB,GAAGV,UAAU,CAACW,SAAS,CAAC,yBAAyB,CAAC,CAC9EC,eAAe;IAClB,IAAIF,yBAAyB,EAAE;MAC7B,IAAI,CAAC3B,OAAO,CAACP,0BAA0B,GAAGkC,yBAAyB;IACrE;IACA,IAAIG,IAAI,GAAGd,KAAK,CAACe,OAAO,CAAC,CAAC;IAC1BD,IAAI,GAAG,IAAAE,mBAAgB,EAACF,IAAI,CAAC;IAC7BA,IAAI,GAAG,IAAAG,iCAAwB,EAACH,IAAI,EAAEd,KAAK,CAACkB,WAAW,IAAIlB,KAAK,CAACkB,WAAW,CAACC,UAAU,CAAC;IACxF,MAAMC,UAAU,GAAGX,iBAAiB,GAAGA,iBAAiB,CAACK,IAAI,CAAC,GAAG,IAAAO,iBAAQ,EAACP,IAAI,CAAC,CAACQ,MAAM;;IAEtF;IACA,OACEF,UAAU,IAAI,IAAI,CAACpC,OAAO,CAACP,0BAA0B,IACrDwB,UAAU,CAACsB,WAAW,CAAC,qBAAqB,CAAC;EAEjD;AACF;AAACC,OAAA,CAAA3D,OAAA,GAAAC,yBAAA","ignoreList":[]}

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

@@ -0,0 +1,162 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _assessment = _interopRequireDefault(require("../assessment"));
+var _AssessmentResult = _interopRequireDefault(require("../../../values/AssessmentResult"));
+var _analysis = require("../../../const/analysis");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Represents an assessment that checks FAQs content and structure for SGE optimization.
+ */
+class FAQsAssessment extends _assessment.default {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} [config] The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: _analysis.FAQs_ASSESSMENT_ID,
+      ctaType: 'fix',
+      docUrl: 'https://blog.google/products/search/generative-ai-search/',
+      priority: 'high',
+      fixPosition: 'faqs',
+      factor: 2,
+      title: 'FAQs Optimization',
+      content: {
+        good: 'FAQs are well-structured and optimized for Google SGE.',
+        improve: 'FAQs could be improved to better match Google SGE requirements.',
+        bad: 'FAQs need significant improvement to meet Google SGE standards.',
+        details: {
+          hasSchema: 'Missing FAQ schema markup',
+          hasProperStructure: 'Empty questions or answers',
+          hasMinimumFAQs: 'Less than 3 FAQs'
+        }
+      }
+    };
+    this.identifier = _analysis.FAQs_ASSESSMENT_ID;
+    this._config = (0, _lodash.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.default({
+      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();
+    let status = 'bad';
+    let score = 0;
+    if (!faqs || faqs.length === 0) {
+      return {
+        score: 0,
+        status: 'bad',
+        data: {
+          hasFAQs: false
+        }
+      };
+    }
+
+    // Check FAQ structure and content
+    const hasSchema = paper.hasFAQsSchema();
+    const hasProperStructure = this.checkFAQStructure(faqs);
+    const hasMinimumFAQs = this.checkMinimumFAQs(faqs);
+
+    // Calculate score based on criteria
+    const criteriaMet = [hasSchema, hasProperStructure, hasMinimumFAQs].filter(Boolean).length;
+    if (criteriaMet === 3) {
+      status = 'good';
+    } else if (criteriaMet === 2) {
+      status = 'improve';
+    } else {
+      status = 'bad';
+    }
+    score = this.getScore(this._config.priority, status, this._config.factor);
+    return {
+      score,
+      status,
+      data: {
+        hasSchema,
+        hasProperStructure,
+        hasMinimumFAQs
+      }
+    };
+  }
+
+  /**
+   * Checks if FAQs have proper structure
+   * @param {Array} faqs
+   * @returns {boolean}
+   */
+  checkFAQStructure(faqs) {
+    return faqs.every(faq => {
+      return faq.question && faq.answer && typeof faq.question === 'string' && typeof faq.answer === 'string' && faq.question.length > 0 && faq.answer.length > 0;
+    });
+  }
+
+  /**
+   * Checks if FAQs are relevant to the main content
+   * @param {Array} faqs
+   * @param {Array} keywords
+   * @returns {boolean}
+   */
+  checkRelevance(faqs, keywords) {
+    if (!keywords || keywords.length === 0) return true;
+    return faqs.some(faq => {
+      const question = faq.question.toLowerCase();
+      return keywords.some(keyword => question.includes(keyword.toLowerCase()));
+    });
+  }
+
+  /**
+   * 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) {
+    const data = paper.getData();
+    return 'faqs' in data;
+  }
+}
+exports.default = FAQsAssessment;
+//# sourceMappingURL=FAQsAssessment.js.map