axyseo 2.1.12 → 2.1.13

package/build/cjs/parsedPaper/structure/tree/nodes/StructuredNode.js

@@ -0,0 +1,60 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _Node = _interopRequireDefault(require("./Node"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Represents a piece of structure that is present in the original text, but is not relevant for the further analysis
+ * of the text.
+ *
+ * Talking about HTML, this would encompass thing like `<div>`, `<section>`, `<aside>`, `<fieldset>`
+ * and other HTML block elements.
+ *
+ * @extends module:parsedPaper/structure.Node
+ *
+ * @memberOf module:parsedPaper/structure
+ */
+class StructuredNode extends _Node.default {
+  /**
+   * Represents a piece of structure that is present in the original text, but is not relevant for the further
+   * analysis of the text.
+   *
+   * Talking about HTML, this would encompass thing like `<div>`, `<section>`, `<aside>`, `<fieldset>`
+   * and other HTML block elements.
+   *
+   * @param {string} tag                The tag used in the node.
+   * @param {?Object} sourceCodeLocation The parse5 formatted location of the element inside of the source code.
+   *
+   * @returns {void}
+   */
+  constructor(tag, sourceCodeLocation) {
+    super("StructuredNode", sourceCodeLocation);
+    /**
+     * Type of structured node (e.g. "div", "section" etc.).
+     * @type {string}
+     */
+    this.tag = tag;
+    /**
+     * This node's child nodes.
+     * @type {module:parsedPaper/structure.Node[]}
+     */
+    this.children = [];
+  }
+
+  /**
+   * Adds a child and sets its parent to this node.
+   *
+   * @param {module:parsedPaper/structure.Node} child The child to add.
+   *
+   * @returns {void}
+   */
+  addChild(child) {
+    child.parent = this;
+    this.children.push(child);
+  }
+}
+var _default = exports.default = StructuredNode;
+//# sourceMappingURL=StructuredNode.js.map

package/build/cjs/parsedPaper/structure/tree/nodes/StructuredNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StructuredNode.js","names":["_Node","_interopRequireDefault","require","e","__esModule","default","StructuredNode","Node","constructor","tag","sourceCodeLocation","children","addChild","child","parent","push","_default","exports"],"sources":["../../../../../../src/parsedPaper/structure/tree/nodes/StructuredNode.js"],"sourcesContent":["import Node from \"./Node\";\n/**\n * Represents a piece of structure that is present in the original text, but is not relevant for the further analysis\n * of the text.\n *\n * Talking about HTML, this would encompass thing like `<div>`, `<section>`, `<aside>`, `<fieldset>`\n * and other HTML block elements.\n *\n * @extends module:parsedPaper/structure.Node\n *\n * @memberOf module:parsedPaper/structure\n */\nclass StructuredNode extends Node {\n\t/**\n\t * Represents a piece of structure that is present in the original text, but is not relevant for the further\n\t * analysis of the text.\n\t *\n\t * Talking about HTML, this would encompass thing like `<div>`, `<section>`, `<aside>`, `<fieldset>`\n\t * and other HTML block elements.\n\t *\n\t * @param {string} tag                The tag used in the node.\n\t * @param {?Object} sourceCodeLocation The parse5 formatted location of the element inside of the source code.\n\t *\n\t * @returns {void}\n\t */\n\tconstructor( tag, sourceCodeLocation ) {\n\t\tsuper( \"StructuredNode\", sourceCodeLocation );\n\t\t/**\n\t\t * Type of structured node (e.g. \"div\", \"section\" etc.).\n\t\t * @type {string}\n\t\t */\n\t\tthis.tag = tag;\n\t\t/**\n\t\t * This node's child nodes.\n\t\t * @type {module:parsedPaper/structure.Node[]}\n\t\t */\n\t\tthis.children = [];\n\t}\n\n\t/**\n\t * Adds a child and sets its parent to this node.\n\t *\n\t * @param {module:parsedPaper/structure.Node} child The child to add.\n\t *\n\t * @returns {void}\n\t */\n\taddChild( child ) {\n\t\tchild.parent = this;\n\t\tthis.children.push( child );\n\t}\n}\nexport default StructuredNode;\n"],"mappings":";;;;;;AAAA,IAAAA,KAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA0B,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAC1B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMG,cAAc,SAASC,aAAI,CAAC;EACjC;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACCC,WAAWA,CAAEC,GAAG,EAAEC,kBAAkB,EAAG;IACtC,KAAK,CAAE,gBAAgB,EAAEA,kBAAmB,CAAC;IAC7C;AACF;AACA;AACA;IACE,IAAI,CAACD,GAAG,GAAGA,GAAG;IACd;AACF;AACA;AACA;IACE,IAAI,CAACE,QAAQ,GAAG,EAAE;EACnB;;EAEA;AACD;AACA;AACA;AACA;AACA;AACA;EACCC,QAAQA,CAAEC,KAAK,EAAG;IACjBA,KAAK,CAACC,MAAM,GAAG,IAAI;IACnB,IAAI,CAACH,QAAQ,CAACI,IAAI,CAAEF,KAAM,CAAC;EAC5B;AACD;AAAC,IAAAG,QAAA,GAAAC,OAAA,CAAAZ,OAAA,GACcC,cAAc","ignoreList":[]}

package/build/cjs/parsedPaper/structure/tree/nodes/index.js

@@ -0,0 +1,70 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "Heading", {
+  enumerable: true,
+  get: function () {
+    return _Heading.default;
+  }
+});
+Object.defineProperty(exports, "LeafNode", {
+  enumerable: true,
+  get: function () {
+    return _LeafNode.default;
+  }
+});
+Object.defineProperty(exports, "List", {
+  enumerable: true,
+  get: function () {
+    return _List.default;
+  }
+});
+Object.defineProperty(exports, "ListItem", {
+  enumerable: true,
+  get: function () {
+    return _ListItem.default;
+  }
+});
+Object.defineProperty(exports, "MetadataMiscellaneous", {
+  enumerable: true,
+  get: function () {
+    return _MetadataMiscellaneous.default;
+  }
+});
+Object.defineProperty(exports, "MetadataText", {
+  enumerable: true,
+  get: function () {
+    return _MetadataText.default;
+  }
+});
+Object.defineProperty(exports, "Node", {
+  enumerable: true,
+  get: function () {
+    return _Node.default;
+  }
+});
+Object.defineProperty(exports, "Paragraph", {
+  enumerable: true,
+  get: function () {
+    return _Paragraph.default;
+  }
+});
+Object.defineProperty(exports, "StructuredNode", {
+  enumerable: true,
+  get: function () {
+    return _StructuredNode.default;
+  }
+});
+var _Heading = _interopRequireDefault(require("./Heading"));
+var _LeafNode = _interopRequireDefault(require("./LeafNode"));
+var _List = _interopRequireDefault(require("./List"));
+var _ListItem = _interopRequireDefault(require("./ListItem"));
+var _MetadataMiscellaneous = _interopRequireDefault(require("./MetadataMiscellaneous"));
+var _MetadataText = _interopRequireDefault(require("./MetadataText"));
+var _Node = _interopRequireDefault(require("./Node"));
+var _Paragraph = _interopRequireDefault(require("./Paragraph"));
+var _StructuredNode = _interopRequireDefault(require("./StructuredNode"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+//# sourceMappingURL=index.js.map

package/build/cjs/parsedPaper/structure/tree/nodes/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_Heading","_interopRequireDefault","require","_LeafNode","_List","_ListItem","_MetadataMiscellaneous","_MetadataText","_Node","_Paragraph","_StructuredNode","e","__esModule","default"],"sources":["../../../../../../src/parsedPaper/structure/tree/nodes/index.js"],"sourcesContent":["import Heading from \"./Heading\";\nimport LeafNode from \"./LeafNode\";\nimport List from \"./List\";\nimport ListItem from \"./ListItem\";\nimport MetadataMiscellaneous from \"./MetadataMiscellaneous\";\nimport MetadataText from \"./MetadataText\";\nimport Node from \"./Node\";\nimport Paragraph from \"./Paragraph\";\nimport StructuredNode from \"./StructuredNode\";\n\nexport {\n\tHeading,\n\tLeafNode,\n\tList,\n\tListItem,\n\tMetadataText,\n\tMetadataMiscellaneous,\n\tNode,\n\tParagraph,\n\tStructuredNode,\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAAA,QAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,SAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,KAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,SAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,sBAAA,GAAAL,sBAAA,CAAAC,OAAA;AACA,IAAAK,aAAA,GAAAN,sBAAA,CAAAC,OAAA;AACA,IAAAM,KAAA,GAAAP,sBAAA,CAAAC,OAAA;AACA,IAAAO,UAAA,GAAAR,sBAAA,CAAAC,OAAA;AACA,IAAAQ,eAAA,GAAAT,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAU,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA","ignoreList":[]}

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"assessment.js","names":["_languageProcessing","require","_helpers","_analysis","Assessment","getResult","paper","researcher","i18n","isApplicable","hasEnoughContentForAssessment","contentNeededForAssessment","text","getText","removeHtmlBlocks","filterShortcodesFromHTML","_attributes","shortcodes","sanitizeString","length","checkCanSkip","getScore","priority","status","factor","POINT","priorityRate","statusRate","_default","exports","default"],"sources":["../../../../src/scoring/assessments/assessment.js"],"sourcesContent":["/* eslint-disable no-unused-vars */\nimport {sanitizeString} from '../../languageProcessing';\nimport {filterShortcodesFromHTML, removeHtmlBlocks} from '../../languageProcessing/helpers';\nimport {POINT, priorityRate, statusRate} from '../../const/analysis';\n\n/**\n * The base class for an Assessment.\n */\nclass Assessment {\n  /**\n   * Executes the assessment and return its result.\n   *\n   * @param {Paper}       paper       The paper to run this assessment on.\n   * @param {Researcher}  researcher  The researcher used for the assessment.\n   * @param i18n\n   * @returns {AssessmentResult} The result of the assessment.\n   */\n  getResult({paper, researcher, i18n}) {\n    throw 'The method getResult is not implemented';\n  }\n\n  /**\n   * Checks whether the assessment is applicable.\n   *\n   * @param {Paper}       paper       The paper to run this assessment on.\n   * @param {Researcher}  researcher  The researcher used for the assessment.\n   *\n   * @returns {boolean} Whether the assessment is applicable, defaults to `true`.\n   */\n  isApplicable(paper, researcher) {\n    return true;\n  }\n\n  /**\n   * Tests whether a `Paper` has enough content for assessments to be displayed.\n   *\n   * @param {Paper} paper            The paper to run this assessment on.\n   * @param {number} contentNeededForAssessment  The minimum length in characters a text must have for assessments to be displayed.\n   *\n   * @returns {boolean} `true` if the text is of the required length, `false` otherwise.\n   */\n  hasEnoughContentForAssessment(paper, contentNeededForAssessment = 50) {\n    let text = paper.getText();\n    text = removeHtmlBlocks(text);\n    text = filterShortcodesFromHTML(text, paper._attributes && paper._attributes.shortcodes);\n\n    return sanitizeString(text).length >= contentNeededForAssessment;\n  }\n\n  checkCanSkip(paper) {\n    return !this.hasEnoughContentForAssessment;\n  }\n\n  /**\n   *\n   * @param {*} priority\n   * @param {*} status\n   * @param {*} factor\n   * @returns\n   */\n  getScore(priority, status, factor = 1) {\n    return POINT * priorityRate[`${priority}`] * statusRate[`${status}`] * factor;\n  }\n}\n\n/* eslint-enable no-unused-vars */\n\nexport default Assessment;\n"],"mappings":";;;;;;AACA,IAAAA,mBAAA,GAAAC,OAAA;AACA,IAAAC,QAAA,GAAAD,OAAA;AACA,IAAAE,SAAA,GAAAF,OAAA;AAHA;;AAKA;AACA;AACA;AACA,MAAMG,UAAU,CAAC;EACf;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,SAASA,CAAC;IAACC,KAAK;IAAEC,UAAU;IAAEC;EAAI,CAAC,EAAE;IACnC,MAAM,yCAAyC;EACjD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,YAAYA,CAACH,KAAK,EAAEC,UAAU,EAAE;IAC9B,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEG,6BAA6BA,CAACJ,KAAK,EAAEK,0BAA0B,GAAG,EAAE,EAAE;IACpE,IAAIC,IAAI,GAAGN,KAAK,CAACO,OAAO,CAAC,CAAC;IAC1BD,IAAI,GAAG,IAAAE,yBAAgB,EAACF,IAAI,CAAC;IAC7BA,IAAI,GAAG,IAAAG,iCAAwB,EAACH,IAAI,EAAEN,KAAK,CAACU,WAAW,IAAIV,KAAK,CAACU,WAAW,CAACC,UAAU,CAAC;IAExF,OAAO,IAAAC,kCAAc,EAACN,IAAI,CAAC,CAACO,MAAM,IAAIR,0BAA0B;EAClE;EAEAS,YAAYA,CAACd,KAAK,EAAE;IAClB,OAAO,CAAC,IAAI,CAACI,6BAA6B;EAC5C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEW,QAAQA,CAACC,QAAQ,EAAEC,MAAM,EAAEC,MAAM,GAAG,CAAC,EAAE;IACrC,OAAOC,eAAK,GAAGC,sBAAY,CAAC,GAAGJ,QAAQ,EAAE,CAAC,GAAGK,oBAAU,CAAC,GAAGJ,MAAM,EAAE,CAAC,GAAGC,MAAM;EAC/E;AACF;;AAEA;AAAA,IAAAI,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAEe1B,UAAU","ignoreList":[]}

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

@@ -0,0 +1,68 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.seo = exports.readability = void 0;
+var _ParagraphTooLongAssessment = _interopRequireDefault(require("./readability/ParagraphTooLongAssessment"));
+var _SentenceBeginningsAssessment = _interopRequireDefault(require("./readability/SentenceBeginningsAssessment"));
+var _SentenceLengthInTextAssessment = _interopRequireDefault(require("./readability/SentenceLengthInTextAssessment"));
+var _TransitionWordsAssessment = _interopRequireDefault(require("./readability/TransitionWordsAssessment"));
+var _InternalLinksAssessment = _interopRequireDefault(require("./seo/InternalLinksAssessment"));
+var _IntroductionKeywordAssessment = _interopRequireDefault(require("./seo/IntroductionKeywordAssessment"));
+var _KeyphraseLengthAssessment = _interopRequireDefault(require("./seo/KeyphraseLengthAssessment"));
+var _KeywordDensityAssessment = _interopRequireDefault(require("./seo/KeywordDensityAssessment"));
+var _MetaDescriptionKeywordAssessment = _interopRequireDefault(require("./seo/MetaDescriptionKeywordAssessment"));
+var _MetaDescriptionLengthAssessment = _interopRequireDefault(require("./seo/MetaDescriptionLengthAssessment"));
+var _OutboundLinksAssessment = _interopRequireDefault(require("./seo/OutboundLinksAssessment"));
+var _PageTitleWidthAssessment = _interopRequireDefault(require("./seo/PageTitleWidthAssessment"));
+var _SingleH1Assessment = _interopRequireDefault(require("./seo/SingleH1Assessment"));
+var _SubHeadingsKeywordAssessment = _interopRequireDefault(require("./seo/SubHeadingsKeywordAssessment"));
+var _TextLengthAssessment = _interopRequireDefault(require("./seo/TextLengthAssessment"));
+var _UrlKeywordAssessment = _interopRequireDefault(require("./seo/UrlKeywordAssessment"));
+var _ImageCountAssessment = _interopRequireDefault(require("./seo/ImageCountAssessment"));
+var _KeyphraseAssessment = _interopRequireDefault(require("./seo/KeyphraseAssessment"));
+var _SingleTitleAssessment = _interopRequireDefault(require("./seo/SingleTitleAssessment"));
+var _UrlLengthAssessment = _interopRequireDefault(require("./seo/UrlLengthAssessment"));
+var _NumberInMetaTitleAssessment = _interopRequireDefault(require("./seo/NumberInMetaTitleAssessment"));
+var _TextImagesAssessment = _interopRequireDefault(require("./seo/TextImagesAssessment"));
+var _MetaTitleKeywordAssessment = _interopRequireDefault(require("./seo/MetaTitleKeywordAssessment"));
+var _SchemaAssessment = _interopRequireDefault(require("./seo/SchemaAssessment"));
+var _RelatedKeywordsAssessment = _interopRequireDefault(require("./readability/RelatedKeywordsAssessment"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// Readability assessments.
+
+// SEO assessments.
+
+const readability = exports.readability = {
+  ParagraphTooLongAssessment: _ParagraphTooLongAssessment.default,
+  SentenceBeginningsAssessment: _SentenceBeginningsAssessment.default,
+  SentenceLengthInTextAssessment: _SentenceLengthInTextAssessment.default,
+  TransitionWordsAssessment: _TransitionWordsAssessment.default
+};
+
+// We expose the deprecated assessments for backwards compatibility.
+const seo = exports.seo = {
+  ImageCountAssessment: _ImageCountAssessment.default,
+  NumberInMetaTitleAssessment: _NumberInMetaTitleAssessment.default,
+  InternalLinksAssessment: _InternalLinksAssessment.default,
+  TextImagesAssessment: _TextImagesAssessment.default,
+  MetaTitleKeywordAssessment: _MetaTitleKeywordAssessment.default,
+  IntroductionKeywordAssessment: _IntroductionKeywordAssessment.default,
+  SingleTitleAssessment: _SingleTitleAssessment.default,
+  KeyphraseLengthAssessment: _KeyphraseLengthAssessment.default,
+  UrlLengthAssessment: _UrlLengthAssessment.default,
+  KeyphraseDensityAssessment: _KeywordDensityAssessment.default,
+  MetaDescriptionKeywordAssessment: _MetaDescriptionKeywordAssessment.default,
+  MetaDescriptionLengthAssessment: _MetaDescriptionLengthAssessment.default,
+  OutboundLinksAssessment: _OutboundLinksAssessment.default,
+  PageTitleWidthAssessment: _PageTitleWidthAssessment.default,
+  SingleH1Assessment: _SingleH1Assessment.default,
+  SubheadingsKeywordAssessment: _SubHeadingsKeywordAssessment.default,
+  TextLengthAssessment: _TextLengthAssessment.default,
+  SlugKeywordAssessment: _UrlKeywordAssessment.default,
+  KeyphraseAssessment: _KeyphraseAssessment.default,
+  SchemaAssessment: _SchemaAssessment.default,
+  RelatedKeywordsAssessment: _RelatedKeywordsAssessment.default
+};
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_ParagraphTooLongAssessment","_interopRequireDefault","require","_SentenceBeginningsAssessment","_SentenceLengthInTextAssessment","_TransitionWordsAssessment","_InternalLinksAssessment","_IntroductionKeywordAssessment","_KeyphraseLengthAssessment","_KeywordDensityAssessment","_MetaDescriptionKeywordAssessment","_MetaDescriptionLengthAssessment","_OutboundLinksAssessment","_PageTitleWidthAssessment","_SingleH1Assessment","_SubHeadingsKeywordAssessment","_TextLengthAssessment","_UrlKeywordAssessment","_ImageCountAssessment","_KeyphraseAssessment","_SingleTitleAssessment","_UrlLengthAssessment","_NumberInMetaTitleAssessment","_TextImagesAssessment","_MetaTitleKeywordAssessment","_SchemaAssessment","_RelatedKeywordsAssessment","e","__esModule","default","readability","exports","ParagraphTooLongAssessment","SentenceBeginningsAssessment","SentenceLengthInTextAssessment","TransitionWordsAssessment","seo","ImageCountAssessment","NumberInMetaTitleAssessment","InternalLinksAssessment","TextImagesAssessment","MetaTitleKeywordAssessment","IntroductionKeywordAssessment","SingleTitleAssessment","KeyphraseLengthAssessment","UrlLengthAssessment","KeyphraseDensityAssessment","MetaDescriptionKeywordAssessment","MetaDescriptionLengthAssessment","OutboundLinksAssessment","PageTitleWidthAssessment","SingleH1Assessment","SubheadingsKeywordAssessment","TextLengthAssessment","SlugKeywordAssessment","KeyphraseAssessment","SchemaAssessment","RelatedKeywordsAssessment"],"sources":["../../../../src/scoring/assessments/index.js"],"sourcesContent":["// Readability assessments.\nimport ParagraphTooLongAssessment from './readability/ParagraphTooLongAssessment';\nimport SentenceBeginningsAssessment from './readability/SentenceBeginningsAssessment';\nimport SentenceLengthInTextAssessment from './readability/SentenceLengthInTextAssessment';\nimport TransitionWordsAssessment from './readability/TransitionWordsAssessment';\n\n// SEO assessments.\nimport InternalLinksAssessment from './seo/InternalLinksAssessment';\nimport IntroductionKeywordAssessment from './seo/IntroductionKeywordAssessment';\nimport KeyphraseLengthAssessment from './seo/KeyphraseLengthAssessment';\nimport KeyphraseDensityAssessment from './seo/KeywordDensityAssessment';\nimport MetaDescriptionKeywordAssessment from './seo/MetaDescriptionKeywordAssessment';\nimport MetaDescriptionLengthAssessment from './seo/MetaDescriptionLengthAssessment';\nimport OutboundLinksAssessment from './seo/OutboundLinksAssessment';\nimport PageTitleWidthAssessment from './seo/PageTitleWidthAssessment';\nimport SingleH1Assessment from './seo/SingleH1Assessment';\nimport SubheadingsKeywordAssessment from './seo/SubHeadingsKeywordAssessment';\nimport TextLengthAssessment from './seo/TextLengthAssessment';\nimport SlugKeywordAssessment from './seo/UrlKeywordAssessment';\nimport ImageCountAssessment from './seo/ImageCountAssessment';\nimport KeyphraseAssessment from './seo/KeyphraseAssessment';\nimport SingleTitleAssessment from './seo/SingleTitleAssessment';\nimport UrlLengthAssessment from './seo/UrlLengthAssessment';\nimport NumberInMetaTitleAssessment from './seo/NumberInMetaTitleAssessment';\nimport TextImagesAssessment from './seo/TextImagesAssessment';\nimport MetaTitleKeywordAssessment from './seo/MetaTitleKeywordAssessment';\nimport SchemaAssessment from './seo/SchemaAssessment';\nimport RelatedKeywordsAssessment from '@axyseo/scoring/assessments/readability/RelatedKeywordsAssessment';\n\nconst readability = {\n  ParagraphTooLongAssessment,\n  SentenceBeginningsAssessment,\n  SentenceLengthInTextAssessment,\n  TransitionWordsAssessment\n};\n\n// We expose the deprecated assessments for backwards compatibility.\nconst seo = {\n  ImageCountAssessment,\n  NumberInMetaTitleAssessment,\n  InternalLinksAssessment,\n  TextImagesAssessment,\n  MetaTitleKeywordAssessment,\n  IntroductionKeywordAssessment,\n  SingleTitleAssessment,\n  KeyphraseLengthAssessment,\n  UrlLengthAssessment,\n  KeyphraseDensityAssessment,\n  MetaDescriptionKeywordAssessment,\n  MetaDescriptionLengthAssessment,\n  OutboundLinksAssessment,\n  PageTitleWidthAssessment,\n  SingleH1Assessment,\n  SubheadingsKeywordAssessment,\n  TextLengthAssessment,\n  SlugKeywordAssessment,\n  KeyphraseAssessment,\n  SchemaAssessment,\n  RelatedKeywordsAssessment\n};\n\nexport {readability, seo};\n"],"mappings":";;;;;;AACA,IAAAA,2BAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,6BAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,+BAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,0BAAA,GAAAJ,sBAAA,CAAAC,OAAA;AAGA,IAAAI,wBAAA,GAAAL,sBAAA,CAAAC,OAAA;AACA,IAAAK,8BAAA,GAAAN,sBAAA,CAAAC,OAAA;AACA,IAAAM,0BAAA,GAAAP,sBAAA,CAAAC,OAAA;AACA,IAAAO,yBAAA,GAAAR,sBAAA,CAAAC,OAAA;AACA,IAAAQ,iCAAA,GAAAT,sBAAA,CAAAC,OAAA;AACA,IAAAS,gCAAA,GAAAV,sBAAA,CAAAC,OAAA;AACA,IAAAU,wBAAA,GAAAX,sBAAA,CAAAC,OAAA;AACA,IAAAW,yBAAA,GAAAZ,sBAAA,CAAAC,OAAA;AACA,IAAAY,mBAAA,GAAAb,sBAAA,CAAAC,OAAA;AACA,IAAAa,6BAAA,GAAAd,sBAAA,CAAAC,OAAA;AACA,IAAAc,qBAAA,GAAAf,sBAAA,CAAAC,OAAA;AACA,IAAAe,qBAAA,GAAAhB,sBAAA,CAAAC,OAAA;AACA,IAAAgB,qBAAA,GAAAjB,sBAAA,CAAAC,OAAA;AACA,IAAAiB,oBAAA,GAAAlB,sBAAA,CAAAC,OAAA;AACA,IAAAkB,sBAAA,GAAAnB,sBAAA,CAAAC,OAAA;AACA,IAAAmB,oBAAA,GAAApB,sBAAA,CAAAC,OAAA;AACA,IAAAoB,4BAAA,GAAArB,sBAAA,CAAAC,OAAA;AACA,IAAAqB,qBAAA,GAAAtB,sBAAA,CAAAC,OAAA;AACA,IAAAsB,2BAAA,GAAAvB,sBAAA,CAAAC,OAAA;AACA,IAAAuB,iBAAA,GAAAxB,sBAAA,CAAAC,OAAA;AACA,IAAAwB,0BAAA,GAAAzB,sBAAA,CAAAC,OAAA;AAA0G,SAAAD,uBAAA0B,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AA3B1G;;AAMA;;AAuBA,MAAMG,WAAW,GAAAC,OAAA,CAAAD,WAAA,GAAG;EAClBE,0BAA0B,EAA1BA,mCAA0B;EAC1BC,4BAA4B,EAA5BA,qCAA4B;EAC5BC,8BAA8B,EAA9BA,uCAA8B;EAC9BC,yBAAyB,EAAzBA;AACF,CAAC;;AAED;AACA,MAAMC,GAAG,GAAAL,OAAA,CAAAK,GAAA,GAAG;EACVC,oBAAoB,EAApBA,6BAAoB;EACpBC,2BAA2B,EAA3BA,oCAA2B;EAC3BC,uBAAuB,EAAvBA,gCAAuB;EACvBC,oBAAoB,EAApBA,6BAAoB;EACpBC,0BAA0B,EAA1BA,mCAA0B;EAC1BC,6BAA6B,EAA7BA,sCAA6B;EAC7BC,qBAAqB,EAArBA,8BAAqB;EACrBC,yBAAyB,EAAzBA,kCAAyB;EACzBC,mBAAmB,EAAnBA,4BAAmB;EACnBC,0BAA0B,EAA1BA,iCAA0B;EAC1BC,gCAAgC,EAAhCA,yCAAgC;EAChCC,+BAA+B,EAA/BA,wCAA+B;EAC/BC,uBAAuB,EAAvBA,gCAAuB;EACvBC,wBAAwB,EAAxBA,iCAAwB;EACxBC,kBAAkB,EAAlBA,2BAAkB;EAClBC,4BAA4B,EAA5BA,qCAA4B;EAC5BC,oBAAoB,EAApBA,6BAAoB;EACpBC,qBAAqB,EAArBA,6BAAqB;EACrBC,mBAAmB,EAAnBA,4BAAmB;EACnBC,gBAAgB,EAAhBA,yBAAgB;EAChBC,yBAAyB,EAAzBA;AACF,CAAC","ignoreList":[]}

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

@@ -0,0 +1,152 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _inRange = require("../../helpers/assessments/inRange");
+var _AssessmentResult = _interopRequireDefault(require("../../../values/AssessmentResult"));
+var _assessment = _interopRequireDefault(require("../assessment"));
+var _analysis = require("../../../const/analysis");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Represents the assessment that will look if the text has too long paragraphs.
+ */
+class ParagraphTooLongAssessment 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_PARAGRAPH_TOO_LONG_ID,
+      priority: 'high',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#paragraph-length',
+      fixPosition: 'longParagraph',
+      ctaType: 'fix',
+      parameters: {
+        recommendedLength: 150,
+        maximumRecommendedLength: 150
+      },
+      title: 'Paragraph length',
+      content: {
+        bad: 'Paragraph too long. Keep paragraph length less than 150 words for readability.',
+        improve: '',
+        good: 'Paragraph is optimized, with less than 150 words.'
+      }
+    };
+    this.identifier = _analysis.TEXT_PARAGRAPH_TOO_LONG_ID;
+    this._config = (0, _lodash.merge)(defaultConfig, config);
+  }
+
+  /**
+   * Check if there is language-specific config, and if so, overwrite the current config with it.
+   *
+   * @param {Researcher} researcher The researcher to use.
+   *
+   * @returns {Object} The config that should be used.
+   */
+  getConfig(researcher) {
+    const currentConfig = this._config;
+    const languageSpecificConfig = researcher.getConfig('paragraphLength');
+
+    /*
+     * If a language has a specific paragraph length config, check further if the assessment is run in product pages.
+     * If it's run in product pages, override the default config parameters with the language specific config for product pages,
+     * otherwise override it with the language specific config for default pages analysis.
+     */
+    if (languageSpecificConfig) {
+      currentConfig.parameters = this._isProduct ? languageSpecificConfig.productPageParams : languageSpecificConfig.defaultPageParams;
+    }
+    return currentConfig;
+  }
+
+  /**
+   *
+   * @param paragraphsLength
+   * @param config
+   * @returns {{score: number, status: string}}
+   */
+  calculateResult({
+    paragraphsLength,
+    config
+  }) {
+    let status = 'bad';
+    if (paragraphsLength.length === 0) {
+      status = 'good';
+    } else {
+      const longestParagraphLength = paragraphsLength[0].countLength;
+      if (longestParagraphLength <= config.parameters.recommendedLength) {
+        status = 'good';
+      }
+      if ((0, _inRange.inRangeEndInclusive)(longestParagraphLength, config.parameters.recommendedLength, config.parameters.maximumRecommendedLength)) {
+        status = 'good';
+      }
+      if (longestParagraphLength > config.parameters.maximumRecommendedLength) {
+        status = 'bad';
+      }
+    }
+    const score = this.getScore(this._config.priority, status);
+    return {
+      score,
+      status
+    };
+  }
+
+  /**
+   * Sort the paragraphs based on word count.
+   *
+   * @param {Array} paragraphs The array with paragraphs.
+   *
+   * @returns {Array} The array sorted on word counts.
+   */
+  sortParagraphs(paragraphs) {
+    return paragraphs.sort(function (a, b) {
+      return b.countLength - a.countLength;
+    });
+  }
+
+  /**
+   * Runs the getParagraphLength module, based on this returns an assessment result with score and text.
+   *
+   * @param {Paper} paper             The paper to use for the assessment.
+   * @param {Researcher} researcher   The researcher used for calling research.
+   * @returns {object} The assessment result.
+   */
+  getResult({
+    paper,
+    researcher
+  }) {
+    let paragraphsLength = researcher.getResearch('getParagraphLength');
+    paragraphsLength = this.sortParagraphs(paragraphsLength);
+    const config = this.getConfig(researcher);
+    const paragraphLengthResult = this.calculateResult({
+      paragraphsLength,
+      config
+    });
+    const assessmentResult = new _AssessmentResult.default({
+      config: this._config
+    });
+    assessmentResult.setScore(paragraphLengthResult.score);
+    assessmentResult.setStatus(paragraphLengthResult.status);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks if the paragraphTooLong assessment is applicable to the paper.
+   *
+   * @param {Paper} paper The paper to check.
+   *
+   * @returns {boolean} Returns true if the assessment is applicable to the paper.
+   */
+  isApplicable(paper) {
+    return this.hasEnoughContentForAssessment(paper);
+  }
+}
+exports.default = ParagraphTooLongAssessment;
+//# sourceMappingURL=ParagraphTooLongAssessment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ParagraphTooLongAssessment.js","names":["_lodash","require","_inRange","_AssessmentResult","_interopRequireDefault","_assessment","_analysis","e","__esModule","default","ParagraphTooLongAssessment","Assessment","constructor","config","defaultConfig","id","TEXT_PARAGRAPH_TOO_LONG_ID","priority","docUrl","fixPosition","ctaType","parameters","recommendedLength","maximumRecommendedLength","title","content","bad","improve","good","identifier","_config","merge","getConfig","researcher","currentConfig","languageSpecificConfig","_isProduct","productPageParams","defaultPageParams","calculateResult","paragraphsLength","status","length","longestParagraphLength","countLength","inRange","score","getScore","sortParagraphs","paragraphs","sort","a","b","getResult","paper","getResearch","paragraphLengthResult","assessmentResult","AssessmentResult","setScore","setStatus","isApplicable","hasEnoughContentForAssessment","exports"],"sources":["../../../../../src/scoring/assessments/readability/ParagraphTooLongAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport {inRangeEndInclusive as inRange} from '../../helpers/assessments/inRange';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\nimport {TEXT_PARAGRAPH_TOO_LONG_ID} from '@axyseo/const/analysis';\n\n/**\n * Represents the assessment that will look if the text has too long paragraphs.\n */\nexport default class ParagraphTooLongAssessment extends Assessment {\n  /**\n   * Sets the identifier and the config.\n   *\n   * @param {object} config       The configuration to use.\n   *\n   * @returns {void}\n   */\n  constructor(config = {}) {\n    super();\n\n    const defaultConfig = {\n      id: TEXT_PARAGRAPH_TOO_LONG_ID,\n      priority: 'high',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#paragraph-length',\n      fixPosition: 'longParagraph',\n      ctaType: 'fix',\n      parameters: {\n        recommendedLength: 150,\n        maximumRecommendedLength: 150\n      },\n      title: 'Paragraph length',\n      content: {\n        bad: 'Paragraph too long. Keep paragraph length less than 150 words for readability.',\n        improve: '',\n        good: 'Paragraph is optimized, with less than 150 words.'\n      }\n    };\n\n    this.identifier = TEXT_PARAGRAPH_TOO_LONG_ID;\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Check if there is language-specific config, and if so, overwrite the current config with it.\n   *\n   * @param {Researcher} researcher The researcher to use.\n   *\n   * @returns {Object} The config that should be used.\n   */\n  getConfig(researcher) {\n    const currentConfig = this._config;\n    const languageSpecificConfig = researcher.getConfig('paragraphLength');\n\n    /*\n     * If a language has a specific paragraph length config, check further if the assessment is run in product pages.\n     * If it's run in product pages, override the default config parameters with the language specific config for product pages,\n     * otherwise override it with the language specific config for default pages analysis.\n     */\n    if (languageSpecificConfig) {\n      currentConfig.parameters = this._isProduct\n        ? languageSpecificConfig.productPageParams\n        : languageSpecificConfig.defaultPageParams;\n    }\n\n    return currentConfig;\n  }\n\n  /**\n   *\n   * @param paragraphsLength\n   * @param config\n   * @returns {{score: number, status: string}}\n   */\n  calculateResult({paragraphsLength, config}) {\n    let status = 'bad';\n    if (paragraphsLength.length === 0) {\n      status = 'good';\n    } else {\n      const longestParagraphLength = paragraphsLength[0].countLength;\n\n      if (longestParagraphLength <= config.parameters.recommendedLength) {\n        status = 'good';\n      }\n\n      if (\n        inRange(\n          longestParagraphLength,\n          config.parameters.recommendedLength,\n          config.parameters.maximumRecommendedLength\n        )\n      ) {\n        status = 'good';\n      }\n\n      if (longestParagraphLength > config.parameters.maximumRecommendedLength) {\n        status = 'bad';\n      }\n    }\n\n    const score = this.getScore(this._config.priority, status);\n\n    return {\n      score,\n      status\n    };\n  }\n\n  /**\n   * Sort the paragraphs based on word count.\n   *\n   * @param {Array} paragraphs The array with paragraphs.\n   *\n   * @returns {Array} The array sorted on word counts.\n   */\n  sortParagraphs(paragraphs) {\n    return paragraphs.sort(function(a, b) {\n      return b.countLength - a.countLength;\n    });\n  }\n\n  /**\n   * Runs the getParagraphLength module, based on this returns an assessment result with score and text.\n   *\n   * @param {Paper} paper             The paper to use for the assessment.\n   * @param {Researcher} researcher   The researcher used for calling research.\n   * @returns {object} The assessment result.\n   */\n  getResult({paper, researcher}) {\n    let paragraphsLength = researcher.getResearch('getParagraphLength');\n\n    paragraphsLength = this.sortParagraphs(paragraphsLength);\n    const config = this.getConfig(researcher);\n\n    const paragraphLengthResult = this.calculateResult({\n      paragraphsLength,\n      config\n    });\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(paragraphLengthResult.score);\n    assessmentResult.setStatus(paragraphLengthResult.status);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks if the paragraphTooLong assessment is applicable to the paper.\n   *\n   * @param {Paper} paper The paper to check.\n   *\n   * @returns {boolean} Returns true if the assessment is applicable to the paper.\n   */\n  isApplicable(paper) {\n    return this.hasEnoughContentForAssessment(paper);\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,QAAA,GAAAD,OAAA;AACA,IAAAE,iBAAA,GAAAC,sBAAA,CAAAH,OAAA;AACA,IAAAI,WAAA,GAAAD,sBAAA,CAAAH,OAAA;AACA,IAAAK,SAAA,GAAAL,OAAA;AAAkE,SAAAG,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAElE;AACA;AACA;AACe,MAAMG,0BAA0B,SAASC,mBAAU,CAAC;EACjE;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,oCAA0B;MAC9BC,QAAQ,EAAE,MAAM;MAChBC,MAAM,EACJ,8FAA8F;MAChGC,WAAW,EAAE,eAAe;MAC5BC,OAAO,EAAE,KAAK;MACdC,UAAU,EAAE;QACVC,iBAAiB,EAAE,GAAG;QACtBC,wBAAwB,EAAE;MAC5B,CAAC;MACDC,KAAK,EAAE,kBAAkB;MACzBC,OAAO,EAAE;QACPC,GAAG,EAAE,gFAAgF;QACrFC,OAAO,EAAE,EAAE;QACXC,IAAI,EAAE;MACR;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGb,oCAA0B;IAC5C,IAAI,CAACc,OAAO,GAAG,IAAAC,aAAK,EAACjB,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEmB,SAASA,CAACC,UAAU,EAAE;IACpB,MAAMC,aAAa,GAAG,IAAI,CAACJ,OAAO;IAClC,MAAMK,sBAAsB,GAAGF,UAAU,CAACD,SAAS,CAAC,iBAAiB,CAAC;;IAEtE;AACJ;AACA;AACA;AACA;IACI,IAAIG,sBAAsB,EAAE;MAC1BD,aAAa,CAACb,UAAU,GAAG,IAAI,CAACe,UAAU,GACtCD,sBAAsB,CAACE,iBAAiB,GACxCF,sBAAsB,CAACG,iBAAiB;IAC9C;IAEA,OAAOJ,aAAa;EACtB;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEK,eAAeA,CAAC;IAACC,gBAAgB;IAAE3B;EAAM,CAAC,EAAE;IAC1C,IAAI4B,MAAM,GAAG,KAAK;IAClB,IAAID,gBAAgB,CAACE,MAAM,KAAK,CAAC,EAAE;MACjCD,MAAM,GAAG,MAAM;IACjB,CAAC,MAAM;MACL,MAAME,sBAAsB,GAAGH,gBAAgB,CAAC,CAAC,CAAC,CAACI,WAAW;MAE9D,IAAID,sBAAsB,IAAI9B,MAAM,CAACQ,UAAU,CAACC,iBAAiB,EAAE;QACjEmB,MAAM,GAAG,MAAM;MACjB;MAEA,IACE,IAAAI,4BAAO,EACLF,sBAAsB,EACtB9B,MAAM,CAACQ,UAAU,CAACC,iBAAiB,EACnCT,MAAM,CAACQ,UAAU,CAACE,wBACpB,CAAC,EACD;QACAkB,MAAM,GAAG,MAAM;MACjB;MAEA,IAAIE,sBAAsB,GAAG9B,MAAM,CAACQ,UAAU,CAACE,wBAAwB,EAAE;QACvEkB,MAAM,GAAG,KAAK;MAChB;IACF;IAEA,MAAMK,KAAK,GAAG,IAAI,CAACC,QAAQ,CAAC,IAAI,CAACjB,OAAO,CAACb,QAAQ,EAAEwB,MAAM,CAAC;IAE1D,OAAO;MACLK,KAAK;MACLL;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEO,cAAcA,CAACC,UAAU,EAAE;IACzB,OAAOA,UAAU,CAACC,IAAI,CAAC,UAASC,CAAC,EAAEC,CAAC,EAAE;MACpC,OAAOA,CAAC,CAACR,WAAW,GAAGO,CAAC,CAACP,WAAW;IACtC,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACES,SAASA,CAAC;IAACC,KAAK;IAAErB;EAAU,CAAC,EAAE;IAC7B,IAAIO,gBAAgB,GAAGP,UAAU,CAACsB,WAAW,CAAC,oBAAoB,CAAC;IAEnEf,gBAAgB,GAAG,IAAI,CAACQ,cAAc,CAACR,gBAAgB,CAAC;IACxD,MAAM3B,MAAM,GAAG,IAAI,CAACmB,SAAS,CAACC,UAAU,CAAC;IAEzC,MAAMuB,qBAAqB,GAAG,IAAI,CAACjB,eAAe,CAAC;MACjDC,gBAAgB;MAChB3B;IACF,CAAC,CAAC;IACF,MAAM4C,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAAC7C,MAAM,EAAE,IAAI,CAACiB;IAAO,CAAC,CAAC;IAErE2B,gBAAgB,CAACE,QAAQ,CAACH,qBAAqB,CAACV,KAAK,CAAC;IACtDW,gBAAgB,CAACG,SAAS,CAACJ,qBAAqB,CAACf,MAAM,CAAC;IAExD,OAAOgB,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEI,YAAYA,CAACP,KAAK,EAAE;IAClB,OAAO,IAAI,CAACQ,6BAA6B,CAACR,KAAK,CAAC;EAClD;AACF;AAACS,OAAA,CAAAtD,OAAA,GAAAC,0BAAA","ignoreList":[]}

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

@@ -0,0 +1,105 @@
+"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 _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 RelatedKeywordsAssessment 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.RELATED_KEYWORDS_ID,
+      fixPosition: 'description',
+      ctaType: 'fix',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#related-keywords',
+      priority: 'high',
+      title: 'Related keywords',
+      content: {
+        good: 'Related keyword density is optimized',
+        bad: 'Consider using at least a related keyword in your page to establish topical relevance.',
+        improve: 'Too high related keyword density. Keep related keyword density from 0.5% - 1%.'
+      }
+    };
+    this.identifier = _analysis.RELATED_KEYWORDS_ID;
+    this._config = (0, _lodash.merge)(defaultConfig, config);
+  }
+
+  /**
+   *
+   * @param data
+   * @param relatedKeywords
+   * @returns {{score: number, status: string, words}}
+   */
+  calculateResult(data, relatedKeywords) {
+    const {
+      totalWordUsed,
+      words,
+      isWordUsedExceeding
+    } = relatedKeywords;
+    let status = 'good';
+    if (!data?.related_keywords?.length || totalWordUsed <= 0) {
+      status = 'bad';
+    }
+    if (isWordUsedExceeding) {
+      status = 'improve';
+    }
+    const score = this.getScore(this._config.priority, status);
+    return {
+      score,
+      status,
+      words
+    };
+  }
+
+  /**
+   *
+   * @param paper
+   * @param researcher
+   * @returns {AssessmentResult}
+   */
+  getResult({
+    paper,
+    researcher
+  }) {
+    const relatedKeywords = researcher.getResearch('checkRelatedKeywords');
+    const data = paper.getData();
+    const result = this.calculateResult(data, relatedKeywords);
+    const assessmentResult = new _AssessmentResult.default({
+      config: this._config
+    });
+    assessmentResult.setScore(result.score);
+    assessmentResult.setStatus(result.status);
+    assessmentResult.setData(result.words);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks if the transition words assessment is applicable to the paper. Language-specific length requirements and methods of counting text length
+   * may apply (e.g. for Japanese, the text should be counted in characters instead of words, which also makes the minimum required length higher).
+   *
+   * @param {Paper}       paper       The paper to check.
+   * @param {Researcher}  researcher  The researcher object.
+   *
+   * @returns {boolean} Returns true if the language is available, the paper is not empty and the text is longer than the minimum required length.
+   */
+  isApplicable(paper, researcher) {
+    return paper.hasRelatedKeywords();
+  }
+}
+exports.default = RelatedKeywordsAssessment;
+//# sourceMappingURL=RelatedKeywordsAssessment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RelatedKeywordsAssessment.js","names":["_lodash","require","_AssessmentResult","_interopRequireDefault","_assessment","_analysis","e","__esModule","default","RelatedKeywordsAssessment","Assessment","constructor","config","defaultConfig","id","RELATED_KEYWORDS_ID","fixPosition","ctaType","docUrl","priority","title","content","good","bad","improve","identifier","_config","merge","calculateResult","data","relatedKeywords","totalWordUsed","words","isWordUsedExceeding","status","related_keywords","length","score","getScore","getResult","paper","researcher","getResearch","getData","result","assessmentResult","AssessmentResult","setScore","setStatus","setData","isApplicable","hasRelatedKeywords","exports"],"sources":["../../../../../src/scoring/assessments/readability/RelatedKeywordsAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport Assessment from '../assessment';\nimport {RELATED_KEYWORDS_ID} from '@axyseo/const/analysis';\n\n/**\n * Represents the assessment that checks whether there are enough transition words in the text.\n */\nexport default class RelatedKeywordsAssessment extends Assessment {\n  /**\n   * Sets the identifier and the config.\n   *\n   * @param {object} config The configuration to use.\n   *\n   * @returns {void}\n   */\n  constructor(config = {}) {\n    super();\n\n    const defaultConfig = {\n      id: RELATED_KEYWORDS_ID,\n      fixPosition: 'description',\n      ctaType: 'fix',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#related-keywords',\n      priority: 'high',\n      title: 'Related keywords',\n      content: {\n        good: 'Related keyword density is optimized',\n        bad:\n          'Consider using at least a related keyword in your page to establish topical relevance.',\n        improve: 'Too high related keyword density. Keep related keyword density from 0.5% - 1%.'\n      }\n    };\n\n    this.identifier = RELATED_KEYWORDS_ID;\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   *\n   * @param data\n   * @param relatedKeywords\n   * @returns {{score: number, status: string, words}}\n   */\n  calculateResult(data, relatedKeywords) {\n    const {totalWordUsed, words, isWordUsedExceeding} = relatedKeywords;\n    let status = 'good';\n    if (!data?.related_keywords?.length || totalWordUsed <= 0) {\n      status = 'bad';\n    }\n\n    if (isWordUsedExceeding) {\n      status = 'improve';\n    }\n\n    const score = this.getScore(this._config.priority, status);\n\n    return {\n      score,\n      status,\n      words\n    };\n  }\n\n  /**\n   *\n   * @param paper\n   * @param researcher\n   * @returns {AssessmentResult}\n   */\n  getResult({paper, researcher}) {\n    const relatedKeywords = researcher.getResearch('checkRelatedKeywords');\n    const data = paper.getData();\n\n    const result = this.calculateResult(data, relatedKeywords);\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    assessmentResult.setScore(result.score);\n    assessmentResult.setStatus(result.status);\n    assessmentResult.setData(result.words);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks if the transition words assessment is applicable to the paper. Language-specific length requirements and methods of counting text length\n   * may apply (e.g. for Japanese, the text should be counted in characters instead of words, which also makes the minimum required length higher).\n   *\n   * @param {Paper}       paper       The paper to check.\n   * @param {Researcher}  researcher  The researcher object.\n   *\n   * @returns {boolean} Returns true if the language is available, the paper is not empty and the text is longer than the minimum required length.\n   */\n  isApplicable(paper, researcher) {\n    return paper.hasRelatedKeywords();\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,iBAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,WAAA,GAAAD,sBAAA,CAAAF,OAAA;AACA,IAAAI,SAAA,GAAAJ,OAAA;AAA2D,SAAAE,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE3D;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,6BAAmB;MACvBC,WAAW,EAAE,aAAa;MAC1BC,OAAO,EAAE,KAAK;MACdC,MAAM,EACJ,8FAA8F;MAChGC,QAAQ,EAAE,MAAM;MAChBC,KAAK,EAAE,kBAAkB;MACzBC,OAAO,EAAE;QACPC,IAAI,EAAE,sCAAsC;QAC5CC,GAAG,EACD,wFAAwF;QAC1FC,OAAO,EAAE;MACX;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGV,6BAAmB;IACrC,IAAI,CAACW,OAAO,GAAG,IAAAC,aAAK,EAACd,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEgB,eAAeA,CAACC,IAAI,EAAEC,eAAe,EAAE;IACrC,MAAM;MAACC,aAAa;MAAEC,KAAK;MAAEC;IAAmB,CAAC,GAAGH,eAAe;IACnE,IAAII,MAAM,GAAG,MAAM;IACnB,IAAI,CAACL,IAAI,EAAEM,gBAAgB,EAAEC,MAAM,IAAIL,aAAa,IAAI,CAAC,EAAE;MACzDG,MAAM,GAAG,KAAK;IAChB;IAEA,IAAID,mBAAmB,EAAE;MACvBC,MAAM,GAAG,SAAS;IACpB;IAEA,MAAMG,KAAK,GAAG,IAAI,CAACC,QAAQ,CAAC,IAAI,CAACZ,OAAO,CAACP,QAAQ,EAAEe,MAAM,CAAC;IAE1D,OAAO;MACLG,KAAK;MACLH,MAAM;MACNF;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEO,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMX,eAAe,GAAGW,UAAU,CAACC,WAAW,CAAC,sBAAsB,CAAC;IACtE,MAAMb,IAAI,GAAGW,KAAK,CAACG,OAAO,CAAC,CAAC;IAE5B,MAAMC,MAAM,GAAG,IAAI,CAAChB,eAAe,CAACC,IAAI,EAAEC,eAAe,CAAC;IAC1D,MAAMe,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAAClC,MAAM,EAAE,IAAI,CAACc;IAAO,CAAC,CAAC;IAErEmB,gBAAgB,CAACE,QAAQ,CAACH,MAAM,CAACP,KAAK,CAAC;IACvCQ,gBAAgB,CAACG,SAAS,CAACJ,MAAM,CAACV,MAAM,CAAC;IACzCW,gBAAgB,CAACI,OAAO,CAACL,MAAM,CAACZ,KAAK,CAAC;IAEtC,OAAOa,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEK,YAAYA,CAACV,KAAK,EAAEC,UAAU,EAAE;IAC9B,OAAOD,KAAK,CAACW,kBAAkB,CAAC,CAAC;EACnC;AACF;AAACC,OAAA,CAAA5C,OAAA,GAAAC,yBAAA","ignoreList":[]}