axyseo 2.0.0-alpha.1

package/build/scoring/assessments/seo/IntroductionKeywordAssessment.js

@@ -0,0 +1,105 @@
+"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 _polarisIcons = require("@shopify/polaris-icons");
+var _react = _interopRequireDefault(require("react"));
+var _polaris = require("@shopify/polaris");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Assessment to check whether the keyphrase or synonyms are encountered in the first paragraph of the article.
+ */
+class IntroductionKeywordAssessment extends _assessment.default {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} [config] The configuration to use.
+   * @param {string} [config.url] The URL to the relevant article on Yoast.com.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: 'introductionKeyword',
+      ctaType: 'fix',
+      priority: 'low',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#keyword-in-introduction',
+      fixPosition: 'highlightFirstParagraph',
+      icon: _polarisIcons.KeyIcon,
+      title: 'Introduction Keyword',
+      content: {
+        improve: '',
+        bad: 'No keywords found in the first sentence. Add one to improve keyword rank.',
+        good: 'Keyword is included in the first sentence.'
+      }
+    };
+    this.identifier = 'introductionKeyword';
+    this._config = (0, _lodash.merge)(defaultConfig, config);
+  }
+
+  /**
+   * Assesses the presence of keyphrase or synonyms in the first paragraph.
+   *
+   * @param {Paper} paper The paper to use for the assessment.
+   * @param {Researcher} researcher The researcher used for calling research.
+   *
+   * @param i18n
+   * @returns {AssessmentResult} The result of this assessment.
+   */
+  getResult(paper, researcher, i18n) {
+    const assessmentResult = new _AssessmentResult.default({
+      config: this._config
+    });
+    this._firstParagraphMatches = researcher.getResearch('findKeywordInFirstParagraph');
+    const calculatedResult = this.calculateResult();
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setBody(calculatedResult.body);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks if the paper has both keyword and text.
+   *
+   * @param {Paper} paper The paper to be analyzed.
+   *
+   * @returns {boolean} Whether the assessment is applicable or not.
+   */
+  isApplicable(paper) {
+    return paper.hasKeyword() && paper.hasText();
+  }
+
+  /**
+   * Returns a result based on the number of occurrences of keyphrase in the first paragraph.
+   *
+   * @returns {Object} result object with a score and translation text.
+   */
+  calculateResult() {
+    let status = '';
+    if (this._firstParagraphMatches.foundInOneSentence) {
+      status = 'good';
+    } else {
+      status = 'bad';
+    }
+    const score = this.getScore(this._config.priority, status);
+    return {
+      score,
+      status,
+      body: /*#__PURE__*/_react.default.createElement(_polaris.Text, {
+        as: 'span'
+      }, this._config.content[status], ' ', this._config.docUrl && /*#__PURE__*/_react.default.createElement("a", {
+        href: this._config.docUrl,
+        target: "_blank",
+        rel: "noreferrer"
+      }, "Learn more"))
+    };
+  }
+}
+var _default = exports.default = IntroductionKeywordAssessment;
+//# sourceMappingURL=IntroductionKeywordAssessment.js.map

package/build/scoring/assessments/seo/IntroductionKeywordAssessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntroductionKeywordAssessment.js","names":["_lodash","require","_assessment","_interopRequireDefault","_AssessmentResult","_polarisIcons","_react","_polaris","e","__esModule","default","IntroductionKeywordAssessment","Assessment","constructor","config","defaultConfig","id","ctaType","priority","docUrl","fixPosition","icon","KeyIcon","title","content","improve","bad","good","identifier","_config","merge","getResult","paper","researcher","i18n","assessmentResult","AssessmentResult","_firstParagraphMatches","getResearch","calculatedResult","calculateResult","setScore","score","setStatus","status","setBody","body","isApplicable","hasKeyword","hasText","foundInOneSentence","getScore","createElement","Text","as","href","target","rel","_default","exports"],"sources":["../../../../src/scoring/assessments/seo/IntroductionKeywordAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\n\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {KeyIcon} from '@shopify/polaris-icons';\nimport React from 'react';\nimport {Text} from '@shopify/polaris';\n\n/**\n * Assessment to check whether the keyphrase or synonyms are encountered in the first paragraph of the article.\n */\nclass IntroductionKeywordAssessment extends Assessment {\n  /**\n   * Sets the identifier and the config.\n   *\n   * @param {Object} [config] The configuration to use.\n   * @param {string} [config.url] The URL to the relevant article on Yoast.com.\n   *\n   * @returns {void}\n   */\n  constructor(config = {}) {\n    super();\n\n    const defaultConfig = {\n      id: 'introductionKeyword',\n      ctaType: 'fix',\n      priority: 'low',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#keyword-in-introduction',\n      fixPosition: 'highlightFirstParagraph',\n      icon: KeyIcon,\n      title: 'Introduction Keyword',\n      content: {\n        improve: '',\n        bad: 'No keywords found in the first sentence. Add one to improve keyword rank.',\n        good: 'Keyword is included in the first sentence.'\n      }\n    };\n\n    this.identifier = 'introductionKeyword';\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Assesses the presence of keyphrase or synonyms in the first paragraph.\n   *\n   * @param {Paper} paper The paper to use for the assessment.\n   * @param {Researcher} researcher The researcher used for calling research.\n   *\n   * @param i18n\n   * @returns {AssessmentResult} The result of this assessment.\n   */\n  getResult(paper, researcher, i18n) {\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    this._firstParagraphMatches = researcher.getResearch('findKeywordInFirstParagraph');\n    const calculatedResult = this.calculateResult();\n\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n    assessmentResult.setBody(calculatedResult.body);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks if the paper has both keyword and text.\n   *\n   * @param {Paper} paper The paper to be analyzed.\n   *\n   * @returns {boolean} Whether the assessment is applicable or not.\n   */\n  isApplicable(paper) {\n    return paper.hasKeyword() && paper.hasText();\n  }\n\n  /**\n   * Returns a result based on the number of occurrences of keyphrase in the first paragraph.\n   *\n   * @returns {Object} result object with a score and translation text.\n   */\n  calculateResult() {\n    let status = '';\n\n    if (this._firstParagraphMatches.foundInOneSentence) {\n      status = 'good';\n    } else {\n      status = 'bad';\n    }\n\n    const score = this.getScore(this._config.priority, status);\n\n    return {\n      score,\n      status,\n      body: (\n        <Text as={'span'}>\n          {this._config.content[status]}{' '}\n          {this._config.docUrl && (\n            <a href={this._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n              Learn more\n            </a>\n          )}\n        </Text>\n      )\n    };\n  }\n}\n\nexport default IntroductionKeywordAssessment;\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAEA,IAAAC,WAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,iBAAA,GAAAD,sBAAA,CAAAF,OAAA;AACA,IAAAI,aAAA,GAAAJ,OAAA;AACA,IAAAK,MAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,QAAA,GAAAN,OAAA;AAAsC,SAAAE,uBAAAK,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEtC;AACA;AACA;AACA,MAAMG,6BAA6B,SAASC,mBAAU,CAAC;EACrD;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAE,qBAAqB;MACzBC,OAAO,EAAE,KAAK;MACdC,QAAQ,EAAE,KAAK;MACfC,MAAM,EACJ,qGAAqG;MACvGC,WAAW,EAAE,yBAAyB;MACtCC,IAAI,EAAEC,qBAAO;MACbC,KAAK,EAAE,sBAAsB;MAC7BC,OAAO,EAAE;QACPC,OAAO,EAAE,EAAE;QACXC,GAAG,EAAE,2EAA2E;QAChFC,IAAI,EAAE;MACR;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAG,qBAAqB;IACvC,IAAI,CAACC,OAAO,GAAG,IAAAC,aAAK,EAACf,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEiB,SAASA,CAACC,KAAK,EAAEC,UAAU,EAAEC,IAAI,EAAE;IACjC,MAAMC,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAACtB,MAAM,EAAE,IAAI,CAACe;IAAO,CAAC,CAAC;IAErE,IAAI,CAACQ,sBAAsB,GAAGJ,UAAU,CAACK,WAAW,CAAC,6BAA6B,CAAC;IACnF,MAAMC,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAAC,CAAC;IAE/CL,gBAAgB,CAACM,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDP,gBAAgB,CAACQ,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IACnDT,gBAAgB,CAACU,OAAO,CAACN,gBAAgB,CAACO,IAAI,CAAC;IAE/C,OAAOX,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEY,YAAYA,CAACf,KAAK,EAAE;IAClB,OAAOA,KAAK,CAACgB,UAAU,CAAC,CAAC,IAAIhB,KAAK,CAACiB,OAAO,CAAC,CAAC;EAC9C;;EAEA;AACF;AACA;AACA;AACA;EACET,eAAeA,CAAA,EAAG;IAChB,IAAII,MAAM,GAAG,EAAE;IAEf,IAAI,IAAI,CAACP,sBAAsB,CAACa,kBAAkB,EAAE;MAClDN,MAAM,GAAG,MAAM;IACjB,CAAC,MAAM;MACLA,MAAM,GAAG,KAAK;IAChB;IAEA,MAAMF,KAAK,GAAG,IAAI,CAACS,QAAQ,CAAC,IAAI,CAACtB,OAAO,CAACX,QAAQ,EAAE0B,MAAM,CAAC;IAE1D,OAAO;MACLF,KAAK;MACLE,MAAM;MACNE,IAAI,eACFxC,MAAA,CAAAI,OAAA,CAAA0C,aAAA,CAAC7C,QAAA,CAAA8C,IAAI;QAACC,EAAE,EAAE;MAAO,GACd,IAAI,CAACzB,OAAO,CAACL,OAAO,CAACoB,MAAM,CAAC,EAAE,GAAG,EACjC,IAAI,CAACf,OAAO,CAACV,MAAM,iBAClBb,MAAA,CAAAI,OAAA,CAAA0C,aAAA;QAAGG,IAAI,EAAE,IAAI,CAAC1B,OAAO,CAACV,MAAO;QAACqC,MAAM,EAAC,QAAQ;QAACC,GAAG,EAAC;MAAY,GAAC,YAE5D,CAED;IAEV,CAAC;EACH;AACF;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAjD,OAAA,GAEcC,6BAA6B","ignoreList":[]}

package/build/scoring/assessments/seo/KeyphraseAssessment.js

@@ -0,0 +1,100 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _polaris = require("@shopify/polaris");
+var _lodash = require("lodash");
+var _assessment = _interopRequireDefault(require("../assessment"));
+var _AssessmentResult = _interopRequireDefault(require("../../../values/AssessmentResult"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Represents the Slug keyword assessment. This assessment checks if the keyword is present in the slug.
+ */
+class KeyphraseAssessment extends _assessment.default {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} config   The configuration to use.
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: 'keyphrase',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#use-of-main-keyword',
+      ctaType: 'fix',
+      fixPosition: 'keyword search',
+      priority: 'high',
+      title: 'Use of main keyword',
+      content: {
+        improve: '',
+        bad: 'No keywords found. Include keywords throughout the text.',
+        good: 'Main keyword is used effectively.'
+      }
+    };
+    this.identifier = 'keyphrase';
+    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.
+   *
+   * @param i18n
+   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.
+   */
+  getResult(paper, researcher, i18n) {
+    const assessmentResult = new _AssessmentResult.default({
+      config: this._config
+    });
+    const calculatedResult = this.calculateResult(paper, i18n);
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setBody(calculatedResult.body);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks whether the paper has a keyword and a slug.
+   *
+   * @param {Paper}       paper       The paper to use for the assessment.
+   * @param {Researcher}  researcher  The researcher object.
+   *
+   * @returns {boolean} True if the paper contains a keyword and a slug, and if the keywordCountInSlug research is available on the researcher.
+   */
+  isApplicable(paper, researcher) {
+    return true;
+  }
+
+  /**
+   *
+   * @param paper
+   * @param i18n
+   * @returns {{score: number, body: React.JSX.Element, status: string}}
+   */
+  calculateResult(paper, i18n) {
+    const status = (() => {
+      const hasKeyphrase = paper.hasKeyword();
+      return hasKeyphrase ? 'good' : 'bad';
+    })();
+    const score = this.getScore(this._config.priority, status);
+    return {
+      score,
+      status,
+      body: /*#__PURE__*/_react.default.createElement(_polaris.Text, {
+        as: 'span'
+      }, this._config.content[status], ' ', this._config.docUrl && /*#__PURE__*/_react.default.createElement("a", {
+        href: this._config.docUrl,
+        target: "_blank",
+        rel: "noreferrer"
+      }, "Learn more"))
+    };
+  }
+}
+var _default = exports.default = KeyphraseAssessment;
+//# sourceMappingURL=KeyphraseAssessment.js.map

package/build/scoring/assessments/seo/KeyphraseAssessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyphraseAssessment.js","names":["_react","_interopRequireDefault","require","_polaris","_lodash","_assessment","_AssessmentResult","e","__esModule","default","KeyphraseAssessment","Assessment","constructor","config","defaultConfig","id","docUrl","ctaType","fixPosition","priority","title","content","improve","bad","good","identifier","_config","merge","getResult","paper","researcher","i18n","assessmentResult","AssessmentResult","calculatedResult","calculateResult","setScore","score","setStatus","status","setBody","body","isApplicable","hasKeyphrase","hasKeyword","getScore","createElement","Text","as","href","target","rel","_default","exports"],"sources":["../../../../src/scoring/assessments/seo/KeyphraseAssessment.js"],"sourcesContent":["import React from 'react';\nimport {Text} from '@shopify/polaris';\nimport {merge} from 'lodash';\n\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\n\n/**\n * Represents the Slug keyword assessment. This assessment checks if the keyword is present in the slug.\n */\nclass KeyphraseAssessment extends Assessment {\n  /**\n   * Sets the identifier and the config.\n   *\n   * @param {Object} config   The configuration to use.\n   * @returns {void}\n   */\n  constructor(config = {}) {\n    super();\n\n    const defaultConfig = {\n      id: 'keyphrase',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#use-of-main-keyword',\n      ctaType: 'fix',\n      fixPosition: 'keyword search',\n      priority: 'high',\n      title: 'Use of main keyword',\n      content: {\n        improve: '',\n        bad: 'No keywords found. Include keywords throughout the text.',\n        good: 'Main keyword is used effectively.'\n      }\n    };\n\n    this.identifier = 'keyphrase';\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Executes the Assessment and returns a result.\n   *\n   * @param {Paper}       paper       The Paper object to assess.\n   * @param {Researcher}  researcher  The Researcher object containing all available researches.\n   *\n   * @param i18n\n   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.\n   */\n  getResult(paper, researcher, i18n) {\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    const calculatedResult = this.calculateResult(paper, i18n);\n\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n    assessmentResult.setBody(calculatedResult.body);\n    return assessmentResult;\n  }\n\n  /**\n   * Checks whether the paper has a keyword and a slug.\n   *\n   * @param {Paper}       paper       The paper to use for the assessment.\n   * @param {Researcher}  researcher  The researcher object.\n   *\n   * @returns {boolean} True if the paper contains a keyword and a slug, and if the keywordCountInSlug research is available on the researcher.\n   */\n  isApplicable(paper, researcher) {\n    return true;\n  }\n\n  /**\n   *\n   * @param paper\n   * @param i18n\n   * @returns {{score: number, body: React.JSX.Element, status: string}}\n   */\n  calculateResult(paper, i18n) {\n    const status = (() => {\n      const hasKeyphrase = paper.hasKeyword();\n\n      return hasKeyphrase ? 'good' : 'bad';\n    })();\n\n    const score = this.getScore(this._config.priority, status);\n\n    return {\n      score,\n      status,\n      body: (\n        <Text as={'span'}>\n          {this._config.content[status]}{' '}\n          {this._config.docUrl && (\n            <a href={this._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n              Learn more\n            </a>\n          )}\n        </Text>\n      )\n    };\n  }\n}\n\nexport default KeyphraseAssessment;\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,QAAA,GAAAD,OAAA;AACA,IAAAE,OAAA,GAAAF,OAAA;AAEA,IAAAG,WAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,iBAAA,GAAAL,sBAAA,CAAAC,OAAA;AAAgE,SAAAD,uBAAAM,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEhE;AACA;AACA;AACA,MAAMG,mBAAmB,SAASC,mBAAU,CAAC;EAC3C;AACF;AACA;AACA;AACA;AACA;EACEC,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAE,WAAW;MACfC,MAAM,EACJ,iGAAiG;MACnGC,OAAO,EAAE,KAAK;MACdC,WAAW,EAAE,gBAAgB;MAC7BC,QAAQ,EAAE,MAAM;MAChBC,KAAK,EAAE,qBAAqB;MAC5BC,OAAO,EAAE;QACPC,OAAO,EAAE,EAAE;QACXC,GAAG,EAAE,0DAA0D;QAC/DC,IAAI,EAAE;MACR;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAG,WAAW;IAC7B,IAAI,CAACC,OAAO,GAAG,IAAAC,aAAK,EAACb,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEe,SAASA,CAACC,KAAK,EAAEC,UAAU,EAAEC,IAAI,EAAE;IACjC,MAAMC,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAACpB,MAAM,EAAE,IAAI,CAACa;IAAO,CAAC,CAAC;IAErE,MAAMQ,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACN,KAAK,EAAEE,IAAI,CAAC;IAE1DC,gBAAgB,CAACI,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDL,gBAAgB,CAACM,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IACnDP,gBAAgB,CAACQ,OAAO,CAACN,gBAAgB,CAACO,IAAI,CAAC;IAC/C,OAAOT,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEU,YAAYA,CAACb,KAAK,EAAEC,UAAU,EAAE;IAC9B,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEK,eAAeA,CAACN,KAAK,EAAEE,IAAI,EAAE;IAC3B,MAAMQ,MAAM,GAAG,CAAC,MAAM;MACpB,MAAMI,YAAY,GAAGd,KAAK,CAACe,UAAU,CAAC,CAAC;MAEvC,OAAOD,YAAY,GAAG,MAAM,GAAG,KAAK;IACtC,CAAC,EAAE,CAAC;IAEJ,MAAMN,KAAK,GAAG,IAAI,CAACQ,QAAQ,CAAC,IAAI,CAACnB,OAAO,CAACP,QAAQ,EAAEoB,MAAM,CAAC;IAE1D,OAAO;MACLF,KAAK;MACLE,MAAM;MACNE,IAAI,eACFzC,MAAA,CAAAS,OAAA,CAAAqC,aAAA,CAAC3C,QAAA,CAAA4C,IAAI;QAACC,EAAE,EAAE;MAAO,GACd,IAAI,CAACtB,OAAO,CAACL,OAAO,CAACkB,MAAM,CAAC,EAAE,GAAG,EACjC,IAAI,CAACb,OAAO,CAACV,MAAM,iBAClBhB,MAAA,CAAAS,OAAA,CAAAqC,aAAA;QAAGG,IAAI,EAAE,IAAI,CAACvB,OAAO,CAACV,MAAO;QAACkC,MAAM,EAAC,QAAQ;QAACC,GAAG,EAAC;MAAY,GAAC,YAE5D,CAED;IAEV,CAAC;EACH;AACF;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAA5C,OAAA,GAEcC,mBAAmB","ignoreList":[]}

package/build/scoring/assessments/seo/KeyphraseLengthAssessment.js

@@ -0,0 +1,105 @@
+"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 _polarisIcons = require("@shopify/polaris-icons");
+var _helpers = require("../../../helpers");
+var _react = _interopRequireDefault(require("react"));
+var _polaris = require("@shopify/polaris");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Assessment to check whether the keyphrase has a good length.
+ */
+class KeyphraseLengthAssessment extends _assessment.default {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} [config] The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config) {
+    super();
+    this.defaultConfig = {
+      id: 'keyphraseLength',
+      ctaType: 'fix',
+      priority: 'low',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#keyword-length',
+      fixPosition: 'keyword search',
+      icon: _polarisIcons.KeyIcon,
+      title: 'Keyword length',
+      content: {
+        improve: '',
+        bad: 'Keyword too long. Keep keyword length less than 4 words for readability.',
+        good: 'Keyword length is optimized, less than 4 words.'
+      }
+    };
+    this.identifier = 'keyphraseLength';
+    this._config = (0, _lodash.merge)(this.defaultConfig, config);
+  }
+
+  /**
+   * Assesses the keyphrase presence and length.
+   *
+   * @param {Paper} paper The paper to use for the assessment.
+   * @param {Researcher} researcher The researcher used for calling research.
+   *
+   * @param i18n
+   * @returns {AssessmentResult} The result of this assessment.
+   */
+  getResult(paper, researcher, i18n) {
+    const assessmentResult = new _AssessmentResult.default({
+      config: this._config
+    });
+    const calculatedResult = this.calculateResult(paper, i18n);
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setBody(calculatedResult.body);
+    return assessmentResult;
+  }
+
+  /**
+   * Calculates the result based on the keyphraseLength research.
+   *
+   * @returns {Object} Object with score and text.
+   */
+  calculateResult(paper, i18n) {
+    const keywordLength = (0, _helpers.countWords)(paper.getKeyword());
+    let status = '';
+    if (keywordLength <= 4) {
+      status = 'good';
+    } else {
+      status = 'bad';
+    }
+    const score = this.getScore(this._config.priority, status);
+    return {
+      score,
+      status,
+      body: /*#__PURE__*/_react.default.createElement(_polaris.Text, {
+        as: 'span'
+      }, this._config.content[status], ' ', this._config.docUrl && /*#__PURE__*/_react.default.createElement("a", {
+        href: this._config.docUrl,
+        target: "_blank",
+        rel: "noreferrer"
+      }, "Learn more"))
+    };
+  }
+
+  /**
+   * Checks whether the paper has a text.
+   *
+   * @param {Paper}       paper       The paper to use for the assessment.
+   *
+   * @returns {boolean} True when there is text.
+   */
+  isApplicable(paper) {
+    return paper.hasKeyword();
+  }
+}
+var _default = exports.default = KeyphraseLengthAssessment;
+//# sourceMappingURL=KeyphraseLengthAssessment.js.map

package/build/scoring/assessments/seo/KeyphraseLengthAssessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyphraseLengthAssessment.js","names":["_lodash","require","_assessment","_interopRequireDefault","_AssessmentResult","_polarisIcons","_helpers","_react","_polaris","e","__esModule","default","KeyphraseLengthAssessment","Assessment","constructor","config","defaultConfig","id","ctaType","priority","docUrl","fixPosition","icon","KeyIcon","title","content","improve","bad","good","identifier","_config","merge","getResult","paper","researcher","i18n","assessmentResult","AssessmentResult","calculatedResult","calculateResult","setScore","score","setStatus","status","setBody","body","keywordLength","countWords","getKeyword","getScore","createElement","Text","as","href","target","rel","isApplicable","hasKeyword","_default","exports"],"sources":["../../../../src/scoring/assessments/seo/KeyphraseLengthAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\n\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {KeyIcon} from '@shopify/polaris-icons';\nimport {countWords} from '../../../helpers';\nimport React from 'react';\nimport {Text} from '@shopify/polaris';\n\n/**\n * Assessment to check whether the keyphrase has a good length.\n */\nclass KeyphraseLengthAssessment 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    this.defaultConfig = {\n      id: 'keyphraseLength',\n      ctaType: 'fix',\n      priority: 'low',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#keyword-length',\n      fixPosition: 'keyword search',\n      icon: KeyIcon,\n      title: 'Keyword length',\n      content: {\n        improve: '',\n        bad: 'Keyword too long. Keep keyword length less than 4 words for readability.',\n        good: 'Keyword length is optimized, less than 4 words.'\n      }\n    };\n\n    this.identifier = 'keyphraseLength';\n    this._config = merge(this.defaultConfig, config);\n  }\n\n  /**\n   * Assesses the keyphrase presence and length.\n   *\n   * @param {Paper} paper The paper to use for the assessment.\n   * @param {Researcher} researcher The researcher used for calling research.\n   *\n   * @param i18n\n   * @returns {AssessmentResult} The result of this assessment.\n   */\n  getResult(paper, researcher, i18n) {\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    const calculatedResult = this.calculateResult(paper, i18n);\n\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n    assessmentResult.setBody(calculatedResult.body);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Calculates the result based on the keyphraseLength research.\n   *\n   * @returns {Object} Object with score and text.\n   */\n  calculateResult(paper, i18n) {\n    const keywordLength = countWords(paper.getKeyword());\n\n    let status = '';\n    if (keywordLength <= 4) {\n      status = 'good';\n    } else {\n      status = 'bad';\n    }\n\n    const score = this.getScore(this._config.priority, status);\n\n    return {\n      score,\n      status,\n      body: (\n        <Text as={'span'}>\n          {this._config.content[status]}{' '}\n          {this._config.docUrl && (\n            <a href={this._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n              Learn more\n            </a>\n          )}\n        </Text>\n      )\n    };\n  }\n\n  /**\n   * Checks whether the paper has a 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 paper.hasKeyword();\n  }\n}\n\nexport default KeyphraseLengthAssessment;\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAEA,IAAAC,WAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,iBAAA,GAAAD,sBAAA,CAAAF,OAAA;AACA,IAAAI,aAAA,GAAAJ,OAAA;AACA,IAAAK,QAAA,GAAAL,OAAA;AACA,IAAAM,MAAA,GAAAJ,sBAAA,CAAAF,OAAA;AACA,IAAAO,QAAA,GAAAP,OAAA;AAAsC,SAAAE,uBAAAM,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEtC;AACA;AACA;AACA,MAAMG,yBAAyB,SAASC,mBAAU,CAAC;EACjD;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,WAAWA,CAACC,MAAM,EAAE;IAClB,KAAK,CAAC,CAAC;IAEP,IAAI,CAACC,aAAa,GAAG;MACnBC,EAAE,EAAE,iBAAiB;MACrBC,OAAO,EAAE,KAAK;MACdC,QAAQ,EAAE,KAAK;MACfC,MAAM,EACJ,4FAA4F;MAC9FC,WAAW,EAAE,gBAAgB;MAC7BC,IAAI,EAAEC,qBAAO;MACbC,KAAK,EAAE,gBAAgB;MACvBC,OAAO,EAAE;QACPC,OAAO,EAAE,EAAE;QACXC,GAAG,EAAE,0EAA0E;QAC/EC,IAAI,EAAE;MACR;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAG,iBAAiB;IACnC,IAAI,CAACC,OAAO,GAAG,IAAAC,aAAK,EAAC,IAAI,CAACf,aAAa,EAAED,MAAM,CAAC;EAClD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEiB,SAASA,CAACC,KAAK,EAAEC,UAAU,EAAEC,IAAI,EAAE;IACjC,MAAMC,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAACtB,MAAM,EAAE,IAAI,CAACe;IAAO,CAAC,CAAC;IAErE,MAAMQ,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACN,KAAK,EAAEE,IAAI,CAAC;IAE1DC,gBAAgB,CAACI,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDL,gBAAgB,CAACM,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IACnDP,gBAAgB,CAACQ,OAAO,CAACN,gBAAgB,CAACO,IAAI,CAAC;IAE/C,OAAOT,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;EACEG,eAAeA,CAACN,KAAK,EAAEE,IAAI,EAAE;IAC3B,MAAMW,aAAa,GAAG,IAAAC,mBAAU,EAACd,KAAK,CAACe,UAAU,CAAC,CAAC,CAAC;IAEpD,IAAIL,MAAM,GAAG,EAAE;IACf,IAAIG,aAAa,IAAI,CAAC,EAAE;MACtBH,MAAM,GAAG,MAAM;IACjB,CAAC,MAAM;MACLA,MAAM,GAAG,KAAK;IAChB;IAEA,MAAMF,KAAK,GAAG,IAAI,CAACQ,QAAQ,CAAC,IAAI,CAACnB,OAAO,CAACX,QAAQ,EAAEwB,MAAM,CAAC;IAE1D,OAAO;MACLF,KAAK;MACLE,MAAM;MACNE,IAAI,eACFtC,MAAA,CAAAI,OAAA,CAAAuC,aAAA,CAAC1C,QAAA,CAAA2C,IAAI;QAACC,EAAE,EAAE;MAAO,GACd,IAAI,CAACtB,OAAO,CAACL,OAAO,CAACkB,MAAM,CAAC,EAAE,GAAG,EACjC,IAAI,CAACb,OAAO,CAACV,MAAM,iBAClBb,MAAA,CAAAI,OAAA,CAAAuC,aAAA;QAAGG,IAAI,EAAE,IAAI,CAACvB,OAAO,CAACV,MAAO;QAACkC,MAAM,EAAC,QAAQ;QAACC,GAAG,EAAC;MAAY,GAAC,YAE5D,CAED;IAEV,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,YAAYA,CAACvB,KAAK,EAAE;IAClB,OAAOA,KAAK,CAACwB,UAAU,CAAC,CAAC;EAC3B;AACF;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAhD,OAAA,GAEcC,yBAAyB","ignoreList":[]}

package/build/scoring/assessments/seo/KeywordDensityAssessment.js

@@ -0,0 +1,111 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _react = _interopRequireDefault(require("react"));
+var _polaris = require("@shopify/polaris");
+var _assessment = _interopRequireDefault(require("../assessment"));
+var _AssessmentResult = _interopRequireDefault(require("../../../values/AssessmentResult"));
+var _helpers = require("../../../helpers");
+var _keyphraseLengthFactor = _interopRequireDefault(require("../../../scoring/helpers/assessments/keyphraseLengthFactor"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Represents the assessment that will look if the keyphrase density is within the recommended range.
+ */
+class KeyphraseDensityAssessment extends _assessment.default {
+  /**
+   *
+   * @param config
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: 'keyphraseDensity',
+      fixPosition: 'highlightKeyword',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#main-keyword-density',
+      ctaType: 'fix',
+      priority: 'high',
+      content: {
+        good: 'Keyword density is optimized, between 1 - 1.5%.',
+        bad: 'Keep keyword density from 1% - 1.5%.',
+        improve: ''
+      }
+    };
+    this.identifier = 'keyphraseDensity';
+    this._config = (0, _lodash.merge)(defaultConfig, config);
+  }
+
+  /**
+   * Runs the keyphrase density module, based on this returns an assessment
+   * result with score.
+   *
+   * @param {Paper} paper The paper to use for the assessment.
+   * @param {Researcher} researcher The researcher used for calling the research.
+   *
+   * @param i18n
+   * @returns {AssessmentResult} The result of the assessment.
+   */
+  getResult(paper, researcher, i18n) {
+    this._keyphraseCount = researcher.getResearch('getKeyphraseCount');
+    const keyphraseLength = this._keyphraseCount.keyphraseLength;
+    this._keyphraseDensity = researcher.getResearch('getKeyphraseDensity');
+    this._keyphraseDensity = this._keyphraseDensity * (0, _keyphraseLengthFactor.default)(keyphraseLength);
+    const assessmentResult = new _AssessmentResult.default({
+      config: this._config
+    });
+    const calculatedResult = this.calculateResult(paper, i18n);
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setBody(calculatedResult.body);
+    assessmentResult.setTitle(calculatedResult.title);
+    return assessmentResult;
+  }
+
+  /**
+   * Returns the score for the keyphrase density.
+   *
+   * @returns {Object} The object with calculated score and resultText.
+   */
+  calculateResult(paper, i18n) {
+    const density = this._keyphraseDensity;
+    let status = '';
+    if (density < 1 || density > 1.5) {
+      status = 'bad';
+    }
+    if (density >= 1 && density <= 1.5) {
+      status = 'good';
+    }
+    const score = this.getScore(this._config.priority, status);
+    return {
+      title: 'Main keyword density' + ': ' + density.toFixed(2) + '%',
+      score,
+      status,
+      body: /*#__PURE__*/_react.default.createElement(_polaris.Text, {
+        as: 'span'
+      }, this._config.content[status], ' ', this._config.docUrl && /*#__PURE__*/_react.default.createElement("a", {
+        href: this._config.docUrl,
+        target: "_blank",
+        rel: "noreferrer"
+      }, "Learn more"))
+    };
+  }
+
+  /**
+   * Checks whether the paper has a text of the minimum required length and a keyphrase is set. 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 use for the assessment.
+   * @param {Researcher}  researcher  The paper to use for the assessment.
+   *
+   * @returns {boolean} True if applicable.
+   */
+  isApplicable(paper, researcher) {
+    return paper.hasText() && paper.hasKeyword();
+  }
+}
+var _default = exports.default = KeyphraseDensityAssessment;
+//# sourceMappingURL=KeywordDensityAssessment.js.map

package/build/scoring/assessments/seo/KeywordDensityAssessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeywordDensityAssessment.js","names":["_lodash","require","_react","_interopRequireDefault","_polaris","_assessment","_AssessmentResult","_helpers","_keyphraseLengthFactor","e","__esModule","default","KeyphraseDensityAssessment","Assessment","constructor","config","defaultConfig","id","fixPosition","docUrl","ctaType","priority","content","good","bad","improve","identifier","_config","merge","getResult","paper","researcher","i18n","_keyphraseCount","getResearch","keyphraseLength","_keyphraseDensity","keyphraseLengthFactor","assessmentResult","AssessmentResult","calculatedResult","calculateResult","setScore","score","setStatus","status","setBody","body","setTitle","title","density","getScore","toFixed","createElement","Text","as","href","target","rel","isApplicable","hasText","hasKeyword","_default","exports"],"sources":["../../../../src/scoring/assessments/seo/KeywordDensityAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport React from 'react';\nimport {Text} from '@shopify/polaris';\n\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\n\nimport {calculateKeywordDensity} from '../../../helpers';\nimport keyphraseLengthFactor from '../../../scoring/helpers/assessments/keyphraseLengthFactor';\n\n/**\n * Represents the assessment that will look if the keyphrase density is within the recommended range.\n */\nclass KeyphraseDensityAssessment extends Assessment {\n  /**\n   *\n   * @param config\n   */\n  constructor(config = {}) {\n    super();\n\n    const defaultConfig = {\n      id: 'keyphraseDensity',\n      fixPosition: 'highlightKeyword',\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#main-keyword-density',\n      ctaType: 'fix',\n      priority: 'high',\n      content: {\n        good: 'Keyword density is optimized, between 1 - 1.5%.',\n        bad: 'Keep keyword density from 1% - 1.5%.',\n        improve: ''\n      }\n    };\n\n    this.identifier = 'keyphraseDensity';\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Runs the keyphrase density module, based on this returns an assessment\n   * result with score.\n   *\n   * @param {Paper} paper The paper to use for the assessment.\n   * @param {Researcher} researcher The researcher used for calling the research.\n   *\n   * @param i18n\n   * @returns {AssessmentResult} The result of the assessment.\n   */\n  getResult(paper, researcher, i18n) {\n    this._keyphraseCount = researcher.getResearch('getKeyphraseCount');\n    const keyphraseLength = this._keyphraseCount.keyphraseLength;\n\n    this._keyphraseDensity = researcher.getResearch('getKeyphraseDensity');\n    this._keyphraseDensity = this._keyphraseDensity * keyphraseLengthFactor(keyphraseLength);\n\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    const calculatedResult = this.calculateResult(paper, i18n);\n\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n    assessmentResult.setBody(calculatedResult.body);\n    assessmentResult.setTitle(calculatedResult.title);\n    return assessmentResult;\n  }\n\n  /**\n   * Returns the score for the keyphrase density.\n   *\n   * @returns {Object} The object with calculated score and resultText.\n   */\n  calculateResult(paper, i18n) {\n    const density = this._keyphraseDensity;\n    let status = '';\n    if (density < 1 || density > 1.5) {\n      status = 'bad';\n    }\n    if (density >= 1 && density <= 1.5) {\n      status = 'good';\n    }\n    const score = this.getScore(this._config.priority, status);\n\n    return {\n      title: 'Main keyword density' + ': ' + density.toFixed(2) + '%',\n      score,\n      status,\n      body: (\n        <Text as={'span'}>\n          {this._config.content[status]}{' '}\n          {this._config.docUrl && (\n            <a href={this._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n              Learn more\n            </a>\n          )}\n        </Text>\n      )\n    };\n  }\n\n  /**\n   * Checks whether the paper has a text of the minimum required length and a keyphrase is set. Language-specific length requirements and methods\n   * 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\n   * required length higher).\n   *\n   * @param {Paper} \t\tpaper \t\tThe paper to use for the assessment.\n   * @param {Researcher}  researcher  The paper to use for the assessment.\n   *\n   * @returns {boolean} True if applicable.\n   */\n  isApplicable(paper, researcher) {\n    return paper.hasText() && paper.hasKeyword();\n  }\n}\n\nexport default KeyphraseDensityAssessment;\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,MAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,QAAA,GAAAH,OAAA;AAEA,IAAAI,WAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,iBAAA,GAAAH,sBAAA,CAAAF,OAAA;AAEA,IAAAM,QAAA,GAAAN,OAAA;AACA,IAAAO,sBAAA,GAAAL,sBAAA,CAAAF,OAAA;AAA+F,SAAAE,uBAAAM,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE/F;AACA;AACA;AACA,MAAMG,0BAA0B,SAASC,mBAAU,CAAC;EAClD;AACF;AACA;AACA;EACEC,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAE,kBAAkB;MACtBC,WAAW,EAAE,kBAAkB;MAC/BC,MAAM,EACJ,kGAAkG;MACpGC,OAAO,EAAE,KAAK;MACdC,QAAQ,EAAE,MAAM;MAChBC,OAAO,EAAE;QACPC,IAAI,EAAE,iDAAiD;QACvDC,GAAG,EAAE,sCAAsC;QAC3CC,OAAO,EAAE;MACX;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAG,kBAAkB;IACpC,IAAI,CAACC,OAAO,GAAG,IAAAC,aAAK,EAACZ,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEc,SAASA,CAACC,KAAK,EAAEC,UAAU,EAAEC,IAAI,EAAE;IACjC,IAAI,CAACC,eAAe,GAAGF,UAAU,CAACG,WAAW,CAAC,mBAAmB,CAAC;IAClE,MAAMC,eAAe,GAAG,IAAI,CAACF,eAAe,CAACE,eAAe;IAE5D,IAAI,CAACC,iBAAiB,GAAGL,UAAU,CAACG,WAAW,CAAC,qBAAqB,CAAC;IACtE,IAAI,CAACE,iBAAiB,GAAG,IAAI,CAACA,iBAAiB,GAAG,IAAAC,8BAAqB,EAACF,eAAe,CAAC;IAExF,MAAMG,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAACxB,MAAM,EAAE,IAAI,CAACY;IAAO,CAAC,CAAC;IAErE,MAAMa,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACX,KAAK,EAAEE,IAAI,CAAC;IAE1DM,gBAAgB,CAACI,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDL,gBAAgB,CAACM,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IACnDP,gBAAgB,CAACQ,OAAO,CAACN,gBAAgB,CAACO,IAAI,CAAC;IAC/CT,gBAAgB,CAACU,QAAQ,CAACR,gBAAgB,CAACS,KAAK,CAAC;IACjD,OAAOX,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;EACEG,eAAeA,CAACX,KAAK,EAAEE,IAAI,EAAE;IAC3B,MAAMkB,OAAO,GAAG,IAAI,CAACd,iBAAiB;IACtC,IAAIS,MAAM,GAAG,EAAE;IACf,IAAIK,OAAO,GAAG,CAAC,IAAIA,OAAO,GAAG,GAAG,EAAE;MAChCL,MAAM,GAAG,KAAK;IAChB;IACA,IAAIK,OAAO,IAAI,CAAC,IAAIA,OAAO,IAAI,GAAG,EAAE;MAClCL,MAAM,GAAG,MAAM;IACjB;IACA,MAAMF,KAAK,GAAG,IAAI,CAACQ,QAAQ,CAAC,IAAI,CAACxB,OAAO,CAACN,QAAQ,EAAEwB,MAAM,CAAC;IAE1D,OAAO;MACLI,KAAK,EAAE,sBAAsB,GAAG,IAAI,GAAGC,OAAO,CAACE,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG;MAC/DT,KAAK;MACLE,MAAM;MACNE,IAAI,eACF7C,MAAA,CAAAS,OAAA,CAAA0C,aAAA,CAACjD,QAAA,CAAAkD,IAAI;QAACC,EAAE,EAAE;MAAO,GACd,IAAI,CAAC5B,OAAO,CAACL,OAAO,CAACuB,MAAM,CAAC,EAAE,GAAG,EACjC,IAAI,CAAClB,OAAO,CAACR,MAAM,iBAClBjB,MAAA,CAAAS,OAAA,CAAA0C,aAAA;QAAGG,IAAI,EAAE,IAAI,CAAC7B,OAAO,CAACR,MAAO;QAACsC,MAAM,EAAC,QAAQ;QAACC,GAAG,EAAC;MAAY,GAAC,YAE5D,CAED;IAEV,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,YAAYA,CAAC7B,KAAK,EAAEC,UAAU,EAAE;IAC9B,OAAOD,KAAK,CAAC8B,OAAO,CAAC,CAAC,IAAI9B,KAAK,CAAC+B,UAAU,CAAC,CAAC;EAC9C;AACF;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAApD,OAAA,GAEcC,0BAA0B","ignoreList":[]}

package/build/scoring/assessments/seo/MetaDescriptionKeywordAssessment.js

@@ -0,0 +1,114 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _polaris = require("@shopify/polaris");
+var _lodash = require("lodash");
+var _assessment = _interopRequireDefault(require("../assessment"));
+var _AssessmentResult = _interopRequireDefault(require("../../../values/AssessmentResult"));
+var _polarisIcons = require("@shopify/polaris-icons");
+var _helpers = require("../../../helpers");
+var _matchTextWithWord = _interopRequireDefault(require("../../../languageProcessing/helpers/match/matchTextWithWord"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Assessment for checking the keyword matches in the meta description.
+ */
+class MetaDescriptionKeywordAssessment extends _assessment.default {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} [config] The configuration to use.
+   * @param {number} [config.parameters.recommendedMinimum] The recommended minimum of keyword occurrences in the meta description.
+   * @param {number} [config.scores.good] The score to return if there are enough keyword occurrences in the meta description.
+   * @param {number} [config.scores.bad] The score to return if there aren't enough keyword occurrences in the meta description.
+   * @param {string} [config.url] The URL to the relevant article on Yoast.com.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: 'metaDescriptionKeyword',
+      priority: 'high',
+      fixPosition: 'meta description',
+      ctaType: 'fix',
+      docUrl: 'https://help.seoon.io/seo/seo-checklist',
+      icon: _polarisIcons.KeyIcon,
+      title: 'Meta description keyword',
+      content: {
+        bad: 'No keywords found in meta description. Add at least one to improve keyword rank.',
+        good: 'Keywords are included meta description.',
+        improve: ''
+      }
+    };
+    this.identifier = 'metaDescriptionKeyword';
+    this._config = (0, _lodash.merge)(defaultConfig, config);
+  }
+
+  /**
+   * Runs the metaDescriptionKeyword researcher and based on this, returns an assessment result with score.
+   *
+   * @param {Paper}      paper      The paper to use for the assessment.
+   * @param {Researcher} researcher The researcher used for calling research.
+   *
+   * @param i18n
+   * @returns {AssessmentResult} The assessment result.
+   */
+  getResult(paper, researcher, i18n) {
+    const assessmentResult = new _AssessmentResult.default({
+      config: this._config
+    });
+    const calculatedResult = this.calculateResult(paper, i18n);
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setBody(calculatedResult.body);
+    return assessmentResult;
+  }
+
+  /**
+   * Returns the result object based on the number of keyword matches in the meta description.
+   *
+   * @returns {Object} Result object with score and text.
+   */
+  calculateResult(paper, i18n) {
+    const keyword = paper.getKeyword();
+    const description = paper.getDescription();
+    const {
+      count
+    } = (0, _matchTextWithWord.default)(description, keyword, paper.getLocale(), null);
+    let status = '';
+    if ((0, _lodash.isNumber)(count) && count > 0) {
+      status = 'good';
+    } else {
+      status = 'bad';
+    }
+    const score = this.getScore(this._config.priority, status);
+    return {
+      score,
+      status,
+      body: /*#__PURE__*/_react.default.createElement(_polaris.Text, {
+        as: 'span'
+      }, this._config.content[status], ' ', this._config.docUrl && /*#__PURE__*/_react.default.createElement("a", {
+        href: this._config.docUrl,
+        target: "_blank",
+        rel: "noreferrer"
+      }, "Learn more"))
+    };
+  }
+
+  /**
+   * Checks whether the paper has a keyword and a meta description.
+   *
+   * @param {Paper} paper The paper to use for the assessment.
+   *
+   * @returns {boolean} True if the paper has a keyword and a meta description.
+   */
+  isApplicable(paper) {
+    return paper.hasKeyword() && paper.hasDescription();
+  }
+}
+var _default = exports.default = MetaDescriptionKeywordAssessment;
+//# sourceMappingURL=MetaDescriptionKeywordAssessment.js.map

package/build/scoring/assessments/seo/MetaDescriptionKeywordAssessment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetaDescriptionKeywordAssessment.js","names":["_react","_interopRequireDefault","require","_polaris","_lodash","_assessment","_AssessmentResult","_polarisIcons","_helpers","_matchTextWithWord","e","__esModule","default","MetaDescriptionKeywordAssessment","Assessment","constructor","config","defaultConfig","id","priority","fixPosition","ctaType","docUrl","icon","KeyIcon","title","content","bad","good","improve","identifier","_config","merge","getResult","paper","researcher","i18n","assessmentResult","AssessmentResult","calculatedResult","calculateResult","setScore","score","setStatus","status","setBody","body","keyword","getKeyword","description","getDescription","count","matchTextWithWord","getLocale","isNumber","getScore","createElement","Text","as","href","target","rel","isApplicable","hasKeyword","hasDescription","_default","exports"],"sources":["../../../../src/scoring/assessments/seo/MetaDescriptionKeywordAssessment.js"],"sourcesContent":["import React from 'react';\nimport {Text} from '@shopify/polaris';\n\nimport {isNumber, merge} from 'lodash';\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {KeyIcon} from '@shopify/polaris-icons';\nimport {isIncludes} from '../../../helpers';\nimport matchTextWithWord from '../../../languageProcessing/helpers/match/matchTextWithWord';\n\n/**\n * Assessment for checking the keyword matches in the meta description.\n */\nclass MetaDescriptionKeywordAssessment extends Assessment {\n  /**\n   * Sets the identifier and the config.\n   *\n   * @param {Object} [config] The configuration to use.\n   * @param {number} [config.parameters.recommendedMinimum] The recommended minimum of keyword occurrences in the meta description.\n   * @param {number} [config.scores.good] The score to return if there are enough keyword occurrences in the meta description.\n   * @param {number} [config.scores.bad] The score to return if there aren't enough keyword occurrences in the meta description.\n   * @param {string} [config.url] The URL to the relevant article on Yoast.com.\n   *\n   * @returns {void}\n   */\n  constructor(config = {}) {\n    super();\n\n    const defaultConfig = {\n      id: 'metaDescriptionKeyword',\n      priority: 'high',\n      fixPosition: 'meta description',\n      ctaType: 'fix',\n      docUrl: 'https://help.seoon.io/seo/seo-checklist',\n      icon: KeyIcon,\n      title: 'Meta description keyword',\n      content: {\n        bad: 'No keywords found in meta description. Add at least one to improve keyword rank.',\n        good: 'Keywords are included meta description.',\n        improve: ''\n      }\n    };\n\n    this.identifier = 'metaDescriptionKeyword';\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Runs the metaDescriptionKeyword researcher and based on this, returns an assessment result with score.\n   *\n   * @param {Paper}      paper      The paper to use for the assessment.\n   * @param {Researcher} researcher The researcher used for calling research.\n   *\n   * @param i18n\n   * @returns {AssessmentResult} The assessment result.\n   */\n  getResult(paper, researcher, i18n) {\n    const assessmentResult = new AssessmentResult({config: this._config});\n    const calculatedResult = this.calculateResult(paper, i18n);\n\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n    assessmentResult.setBody(calculatedResult.body);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Returns the result object based on the number of keyword matches in the meta description.\n   *\n   * @returns {Object} Result object with score and text.\n   */\n  calculateResult(paper, i18n) {\n    const keyword = paper.getKeyword();\n    const description = paper.getDescription();\n    const {count} = matchTextWithWord(description, keyword, paper.getLocale(), null);\n\n    let status = '';\n    if (isNumber(count) && count > 0) {\n      status = 'good';\n    } else {\n      status = 'bad';\n    }\n    const score = this.getScore(this._config.priority, status);\n\n    return {\n      score,\n      status,\n      body: (\n        <Text as={'span'}>\n          {this._config.content[status]}{' '}\n          {this._config.docUrl && (\n            <a href={this._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n              Learn more\n            </a>\n          )}\n        </Text>\n      )\n    };\n  }\n\n  /**\n   * Checks whether the paper has a keyword and a meta description.\n   *\n   * @param {Paper} paper The paper to use for the assessment.\n   *\n   * @returns {boolean} True if the paper has a keyword and a meta description.\n   */\n  isApplicable(paper) {\n    return paper.hasKeyword() && paper.hasDescription();\n  }\n}\n\nexport default MetaDescriptionKeywordAssessment;\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,QAAA,GAAAD,OAAA;AAEA,IAAAE,OAAA,GAAAF,OAAA;AACA,IAAAG,WAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,iBAAA,GAAAL,sBAAA,CAAAC,OAAA;AACA,IAAAK,aAAA,GAAAL,OAAA;AACA,IAAAM,QAAA,GAAAN,OAAA;AACA,IAAAO,kBAAA,GAAAR,sBAAA,CAAAC,OAAA;AAA4F,SAAAD,uBAAAS,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE5F;AACA;AACA;AACA,MAAMG,gCAAgC,SAASC,mBAAU,CAAC;EACxD;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAE,wBAAwB;MAC5BC,QAAQ,EAAE,MAAM;MAChBC,WAAW,EAAE,kBAAkB;MAC/BC,OAAO,EAAE,KAAK;MACdC,MAAM,EAAE,yCAAyC;MACjDC,IAAI,EAAEC,qBAAO;MACbC,KAAK,EAAE,0BAA0B;MACjCC,OAAO,EAAE;QACPC,GAAG,EAAE,kFAAkF;QACvFC,IAAI,EAAE,yCAAyC;QAC/CC,OAAO,EAAE;MACX;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAG,wBAAwB;IAC1C,IAAI,CAACC,OAAO,GAAG,IAAAC,aAAK,EAACf,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEiB,SAASA,CAACC,KAAK,EAAEC,UAAU,EAAEC,IAAI,EAAE;IACjC,MAAMC,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;MAACtB,MAAM,EAAE,IAAI,CAACe;IAAO,CAAC,CAAC;IACrE,MAAMQ,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACN,KAAK,EAAEE,IAAI,CAAC;IAE1DC,gBAAgB,CAACI,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDL,gBAAgB,CAACM,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IACnDP,gBAAgB,CAACQ,OAAO,CAACN,gBAAgB,CAACO,IAAI,CAAC;IAE/C,OAAOT,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;EACEG,eAAeA,CAACN,KAAK,EAAEE,IAAI,EAAE;IAC3B,MAAMW,OAAO,GAAGb,KAAK,CAACc,UAAU,CAAC,CAAC;IAClC,MAAMC,WAAW,GAAGf,KAAK,CAACgB,cAAc,CAAC,CAAC;IAC1C,MAAM;MAACC;IAAK,CAAC,GAAG,IAAAC,0BAAiB,EAACH,WAAW,EAAEF,OAAO,EAAEb,KAAK,CAACmB,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC;IAEhF,IAAIT,MAAM,GAAG,EAAE;IACf,IAAI,IAAAU,gBAAQ,EAACH,KAAK,CAAC,IAAIA,KAAK,GAAG,CAAC,EAAE;MAChCP,MAAM,GAAG,MAAM;IACjB,CAAC,MAAM;MACLA,MAAM,GAAG,KAAK;IAChB;IACA,MAAMF,KAAK,GAAG,IAAI,CAACa,QAAQ,CAAC,IAAI,CAACxB,OAAO,CAACZ,QAAQ,EAAEyB,MAAM,CAAC;IAE1D,OAAO;MACLF,KAAK;MACLE,MAAM;MACNE,IAAI,eACF9C,MAAA,CAAAY,OAAA,CAAA4C,aAAA,CAACrD,QAAA,CAAAsD,IAAI;QAACC,EAAE,EAAE;MAAO,GACd,IAAI,CAAC3B,OAAO,CAACL,OAAO,CAACkB,MAAM,CAAC,EAAE,GAAG,EACjC,IAAI,CAACb,OAAO,CAACT,MAAM,iBAClBtB,MAAA,CAAAY,OAAA,CAAA4C,aAAA;QAAGG,IAAI,EAAE,IAAI,CAAC5B,OAAO,CAACT,MAAO;QAACsC,MAAM,EAAC,QAAQ;QAACC,GAAG,EAAC;MAAY,GAAC,YAE5D,CAED;IAEV,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,YAAYA,CAAC5B,KAAK,EAAE;IAClB,OAAOA,KAAK,CAAC6B,UAAU,CAAC,CAAC,IAAI7B,KAAK,CAAC8B,cAAc,CAAC,CAAC;EACrD;AACF;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAtD,OAAA,GAEcC,gCAAgC","ignoreList":[]}