axyseo 2.1.12 → 2.1.19

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

@@ -0,0 +1,93 @@
+import { merge } from 'lodash';
+import Assessment from "../assessment";
+import AssessmentResult from "../../../values/AssessmentResult";
+import { KeyIcon } from '@shopify/polaris-icons';
+import { INTRODUCTION_KEYWORD_ID, MAIN_CONTENT_POINTS } from "../../../const/analysis";
+import { enhanceResearcherForChinese } from "../../../languageProcessing/helpers/language/chineseHelperFactory.js";
+
+/**
+ * Assessment to check whether the keyphrase or synonyms are encountered in the first paragraph of the article.
+ */
+class IntroductionKeywordAssessment extends Assessment {
+  /**
+   * 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: INTRODUCTION_KEYWORD_ID,
+      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: 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 = INTRODUCTION_KEYWORD_ID;
+    this._config = 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.
+   *
+   * @returns {AssessmentResult} The result of this assessment.
+   */
+  getResult({
+    paper,
+    researcher
+  }) {
+    const assessmentResult = new AssessmentResult({
+      config: this._config
+    });
+
+    // Enhance researcher for Chinese if needed
+    const enhancedResearcher = enhanceResearcherForChinese(researcher, paper.getText(), paper.getKeyword());
+    this._firstParagraphMatches = enhancedResearcher.getResearch('findKeywordInFirstParagraph');
+    const calculatedResult = this.calculateResult();
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    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 true;
+  }
+
+  /**
+   *
+   * @returns {{score: number, status: string}}
+   */
+  calculateResult() {
+    let status = 'bad';
+    if (this._firstParagraphMatches.foundInOneSentence || this._firstParagraphMatches.foundInParagraph) {
+      status = 'good';
+    }
+    const score = this.getScore(MAIN_CONTENT_POINTS, status);
+    return {
+      score,
+      status
+    };
+  }
+}
+export default IntroductionKeywordAssessment;
+//# sourceMappingURL=IntroductionKeywordAssessment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IntroductionKeywordAssessment.js","names":["merge","Assessment","AssessmentResult","KeyIcon","INTRODUCTION_KEYWORD_ID","MAIN_CONTENT_POINTS","enhanceResearcherForChinese","IntroductionKeywordAssessment","constructor","config","defaultConfig","id","ctaType","priority","docUrl","fixPosition","icon","title","content","improve","bad","good","identifier","_config","getResult","paper","researcher","assessmentResult","enhancedResearcher","getText","getKeyword","_firstParagraphMatches","getResearch","calculatedResult","calculateResult","setScore","score","setStatus","status","isApplicable","foundInOneSentence","foundInParagraph","getScore"],"sources":["../../../../../src/scoring/assessments/seo/IntroductionKeywordAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {KeyIcon} from '@shopify/polaris-icons';\nimport {INTRODUCTION_KEYWORD_ID, MAIN_CONTENT_POINTS} from '@axyseo/const/analysis';\nimport {enhanceResearcherForChinese} from '../../../languageProcessing/helpers/language/chineseHelperFactory.js';\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: INTRODUCTION_KEYWORD_ID,\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 = INTRODUCTION_KEYWORD_ID;\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   * @returns {AssessmentResult} The result of this assessment.\n   */\n  getResult({paper, researcher}) {\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    // Enhance researcher for Chinese if needed\n    const enhancedResearcher = enhanceResearcherForChinese(\n      researcher,\n      paper.getText(),\n      paper.getKeyword()\n    );\n\n    this._firstParagraphMatches = enhancedResearcher.getResearch('findKeywordInFirstParagraph');\n    const calculatedResult = this.calculateResult();\n\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Checks 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 true;\n  }\n\n  /**\n   *\n   * @returns {{score: number, status: string}}\n   */\n  calculateResult() {\n    let status = 'bad';\n\n    if (\n      this._firstParagraphMatches.foundInOneSentence ||\n      this._firstParagraphMatches.foundInParagraph\n    ) {\n      status = 'good';\n    }\n\n    const score = this.getScore(MAIN_CONTENT_POINTS, status);\n\n    return {\n      score,\n      status\n    };\n  }\n}\n\nexport default IntroductionKeywordAssessment;\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,QAAQ;AAC5B,OAAOC,UAAU;AACjB,OAAOC,gBAAgB;AACvB,SAAQC,OAAO,QAAO,wBAAwB;AAC9C,SAAQC,uBAAuB,EAAEC,mBAAmB;AACpD,SAAQC,2BAA2B;;AAEnC;AACA;AACA;AACA,MAAMC,6BAA6B,SAASN,UAAU,CAAC;EACrD;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEO,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEP,uBAAuB;MAC3BQ,OAAO,EAAE,KAAK;MACdC,QAAQ,EAAE,KAAK;MACfC,MAAM,EACJ,qGAAqG;MACvGC,WAAW,EAAE,yBAAyB;MACtCC,IAAI,EAAEb,OAAO;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,GAAGlB,uBAAuB;IACzC,IAAI,CAACmB,OAAO,GAAGvB,KAAK,CAACU,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEe,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMC,gBAAgB,GAAG,IAAIzB,gBAAgB,CAAC;MAACO,MAAM,EAAE,IAAI,CAACc;IAAO,CAAC,CAAC;;IAErE;IACA,MAAMK,kBAAkB,GAAGtB,2BAA2B,CACpDoB,UAAU,EACVD,KAAK,CAACI,OAAO,CAAC,CAAC,EACfJ,KAAK,CAACK,UAAU,CAAC,CACnB,CAAC;IAED,IAAI,CAACC,sBAAsB,GAAGH,kBAAkB,CAACI,WAAW,CAAC,6BAA6B,CAAC;IAC3F,MAAMC,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAAC,CAAC;IAE/CP,gBAAgB,CAACQ,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDT,gBAAgB,CAACU,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IAEnD,OAAOX,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEY,YAAYA,CAACd,KAAK,EAAE;IAClB,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;EACES,eAAeA,CAAA,EAAG;IAChB,IAAII,MAAM,GAAG,KAAK;IAElB,IACE,IAAI,CAACP,sBAAsB,CAACS,kBAAkB,IAC9C,IAAI,CAACT,sBAAsB,CAACU,gBAAgB,EAC5C;MACAH,MAAM,GAAG,MAAM;IACjB;IAEA,MAAMF,KAAK,GAAG,IAAI,CAACM,QAAQ,CAACrC,mBAAmB,EAAEiC,MAAM,CAAC;IAExD,OAAO;MACLF,KAAK;MACLE;IACF,CAAC;EACH;AACF;AAEA,eAAe/B,6BAA6B","ignoreList":[]}

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

@@ -0,0 +1,87 @@
+import { merge } from 'lodash';
+import Assessment from "../assessment";
+import AssessmentResult from "../../../values/AssessmentResult";
+import { CHARACTERS_URL, URLS_POINTS } from "../../../const/analysis";
+import { enhanceResearcherForChinese } from "../../../languageProcessing/helpers/language/chineseHelperFactory";
+
+/**
+ * Represents the Slug keyword assessment. This assessment checks if the keyword is present in the slug.
+ */
+class InvalidCharactersInUrl extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} config   The configuration to use.
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: CHARACTERS_URL,
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#keyword-in-url',
+      fixPosition: 'url handle',
+      ctaType: 'fix',
+      priority: 'medium',
+      title: 'Invalid characters in URL',
+      content: {
+        good: 'URL characters valid',
+        improve: '',
+        bad: 'Use only lowercase letters, numbers, and hyphens.'
+      }
+    };
+    this.identifier = CHARACTERS_URL;
+    this._config = merge(defaultConfig, config);
+  }
+
+  /**
+   * Executes the Assessment and returns a result.
+   *
+   * @param {Paper}       paper       The Paper object to assess.
+   * @param {Researcher}  researcher  The Researcher object containing all available researches.
+   *
+   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.
+   */
+  getResult({
+    paper,
+    researcher
+  }) {
+    // Enhance researcher for Chinese if needed - specifically for URL context
+    const enhancedResearcher = enhanceResearcherForChinese(researcher, paper.getSlug(), paper.getKeyword(), true // isUrlContext = true for enhanced Chinese URL matching
+    );
+    this._charactersInUrl = enhancedResearcher.getResearch('charactersInUrl');
+    const assessmentResult = new AssessmentResult({
+      config: this._config
+    });
+    const calculatedResult = this.calculateResult();
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    return assessmentResult;
+  }
+
+  /**
+   * Checks whether the paper has 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;
+  }
+
+  /**
+   *
+   * @returns {{score: number, status: (string)}}
+   */
+  calculateResult() {
+    const status = this._charactersInUrl.isInvalidCharacters ? 'bad' : 'good';
+    const score = this.getScore(URLS_POINTS, status);
+    return {
+      score,
+      status
+    };
+  }
+}
+export default InvalidCharactersInUrl;
+//# sourceMappingURL=InvalidCharactersInUrl.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"InvalidCharactersInUrl.js","names":["merge","Assessment","AssessmentResult","CHARACTERS_URL","URLS_POINTS","enhanceResearcherForChinese","InvalidCharactersInUrl","constructor","config","defaultConfig","id","docUrl","fixPosition","ctaType","priority","title","content","good","improve","bad","identifier","_config","getResult","paper","researcher","enhancedResearcher","getSlug","getKeyword","_charactersInUrl","getResearch","assessmentResult","calculatedResult","calculateResult","setScore","score","setStatus","status","isApplicable","isInvalidCharacters","getScore"],"sources":["../../../../../src/scoring/assessments/seo/InvalidCharactersInUrl.js"],"sourcesContent":["import {merge} from 'lodash';\n\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {CHARACTERS_URL, URLS_POINTS} from '@axyseo/const/analysis';\nimport {enhanceResearcherForChinese} from '@axyseo/languageProcessing/helpers/language/chineseHelperFactory';\n\n/**\n * Represents the Slug keyword assessment. This assessment checks if the keyword is present in the slug.\n */\nclass InvalidCharactersInUrl 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: CHARACTERS_URL,\n      docUrl:\n        'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#keyword-in-url',\n      fixPosition: 'url handle',\n      ctaType: 'fix',\n      priority: 'medium',\n      title: 'Invalid characters in URL',\n      content: {\n        good: 'URL characters valid',\n        improve: '',\n        bad: 'Use only lowercase letters, numbers, and hyphens.'\n      }\n    };\n\n    this.identifier = CHARACTERS_URL;\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Executes the Assessment and returns a result.\n   *\n   * @param {Paper}       paper       The Paper object to assess.\n   * @param {Researcher}  researcher  The Researcher object containing all available researches.\n   *\n   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.\n   */\n  getResult({paper, researcher}) {\n    // Enhance researcher for Chinese if needed - specifically for URL context\n    const enhancedResearcher = enhanceResearcherForChinese(\n      researcher,\n      paper.getSlug(),\n      paper.getKeyword(),\n      true // isUrlContext = true for enhanced Chinese URL matching\n    );\n\n    this._charactersInUrl = enhancedResearcher.getResearch('charactersInUrl');\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    const calculatedResult = this.calculateResult();\n\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n    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   * @returns {{score: number, status: (string)}}\n   */\n  calculateResult() {\n    const status = this._charactersInUrl.isInvalidCharacters ? 'bad' : 'good'\n    const score = this.getScore(URLS_POINTS , status);\n\n    return {\n      score,\n      status\n    };\n  }\n}\n\nexport default InvalidCharactersInUrl;\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,QAAQ;AAE5B,OAAOC,UAAU;AACjB,OAAOC,gBAAgB;AACvB,SAAQC,cAAc,EAAEC,WAAW;AACnC,SAAQC,2BAA2B;;AAEnC;AACA;AACA;AACA,MAAMC,sBAAsB,SAASL,UAAU,CAAC;EAC9C;AACF;AACA;AACA;AACA;AACA;EACEM,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEP,cAAc;MAClBQ,MAAM,EACJ,4FAA4F;MAC9FC,WAAW,EAAE,YAAY;MACzBC,OAAO,EAAE,KAAK;MACdC,QAAQ,EAAE,QAAQ;MAClBC,KAAK,EAAE,2BAA2B;MAClCC,OAAO,EAAE;QACPC,IAAI,EAAE,sBAAsB;QAC5BC,OAAO,EAAE,EAAE;QACXC,GAAG,EAAE;MACP;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGjB,cAAc;IAChC,IAAI,CAACkB,OAAO,GAAGrB,KAAK,CAACS,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEc,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B;IACA,MAAMC,kBAAkB,GAAGpB,2BAA2B,CACpDmB,UAAU,EACVD,KAAK,CAACG,OAAO,CAAC,CAAC,EACfH,KAAK,CAACI,UAAU,CAAC,CAAC,EAClB,IAAI,CAAC;IACP,CAAC;IAED,IAAI,CAACC,gBAAgB,GAAGH,kBAAkB,CAACI,WAAW,CAAC,iBAAiB,CAAC;IACzE,MAAMC,gBAAgB,GAAG,IAAI5B,gBAAgB,CAAC;MAACM,MAAM,EAAE,IAAI,CAACa;IAAO,CAAC,CAAC;IAErE,MAAMU,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAAC,CAAC;IAE/CF,gBAAgB,CAACG,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDJ,gBAAgB,CAACK,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IACnD,OAAON,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEO,YAAYA,CAACd,KAAK,EAAEC,UAAU,EAAE;IAC9B,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;EACEQ,eAAeA,CAAA,EAAG;IAChB,MAAMI,MAAM,GAAG,IAAI,CAACR,gBAAgB,CAACU,mBAAmB,GAAG,KAAK,GAAG,MAAM;IACzE,MAAMJ,KAAK,GAAG,IAAI,CAACK,QAAQ,CAACnC,WAAW,EAAGgC,MAAM,CAAC;IAEjD,OAAO;MACLF,KAAK;MACLE;IACF,CAAC;EACH;AACF;AAEA,eAAe9B,sBAAsB","ignoreList":[]}

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

@@ -0,0 +1,86 @@
+import { merge } from 'lodash';
+import Assessment from "../assessment";
+import AssessmentResult from "../../../values/AssessmentResult";
+import { KEYPHRASE_ID, KEYWORD_POINTS } from "../../../const/analysis";
+
+/**
+ * Represents the Slug keyword assessment. This assessment checks if the keyword is present in the slug.
+ */
+class KeyphraseAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} config   The configuration to use.
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: KEYPHRASE_ID,
+      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: 'Missing main keyword',
+      content: {
+        improve: '',
+        bad: 'Main keyword field is empty. Add a 2-5 word primary keyword.',
+        good: 'Main keyword set'
+      }
+    };
+    this.identifier = KEYPHRASE_ID;
+    this._config = merge(defaultConfig, config);
+  }
+
+  /**
+   * Executes the Assessment and returns a result.
+   *
+   * @param {Paper}       paper       The Paper object to assess.
+   * @param {Researcher}  researcher  The Researcher object containing all available researches.
+   *
+   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.
+   */
+  getResult({
+    paper,
+    researcher
+  }) {
+    const assessmentResult = new AssessmentResult({
+      config: this._config
+    });
+    const calculatedResult = this.calculateResult(paper);
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    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
+   * @returns {{score: number, status: (string)}}
+   */
+  calculateResult(paper) {
+    const status = (() => {
+      const hasKeyphrase = paper.hasKeyword();
+      return hasKeyphrase ? 'good' : 'bad';
+    })();
+    const score = this.getScore(KEYWORD_POINTS, status);
+    return {
+      score,
+      status
+    };
+  }
+}
+export default KeyphraseAssessment;
+//# sourceMappingURL=KeyphraseAssessment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"KeyphraseAssessment.js","names":["merge","Assessment","AssessmentResult","KEYPHRASE_ID","KEYWORD_POINTS","KeyphraseAssessment","constructor","config","defaultConfig","id","docUrl","ctaType","fixPosition","priority","title","content","improve","bad","good","identifier","_config","getResult","paper","researcher","assessmentResult","calculatedResult","calculateResult","setScore","score","setStatus","status","isApplicable","hasKeyphrase","hasKeyword","getScore"],"sources":["../../../../../src/scoring/assessments/seo/KeyphraseAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\n\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {KEYPHRASE_ID, KEYWORD_POINTS} from '@axyseo/const/analysis';\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_ID,\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: 'Missing main keyword',\n      content: {\n        improve: '',\n        bad: 'Main keyword field is empty. Add a 2-5 word primary keyword.',\n        good: 'Main keyword set'\n      }\n    };\n\n    this.identifier = KEYPHRASE_ID;\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Executes the Assessment and returns a result.\n   *\n   * @param {Paper}       paper       The Paper object to assess.\n   * @param {Researcher}  researcher  The Researcher object containing all available researches.\n   *\n   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.\n   */\n  getResult({paper, researcher}) {\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    const calculatedResult = this.calculateResult(paper);\n\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\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   * @returns {{score: number, status: (string)}}\n   */\n  calculateResult(paper) {\n    const status = (() => {\n      const hasKeyphrase = paper.hasKeyword();\n\n      return hasKeyphrase ? 'good' : 'bad';\n    })();\n\n    const score = this.getScore(KEYWORD_POINTS, status);\n\n    return {\n      score,\n      status\n    };\n  }\n}\n\nexport default KeyphraseAssessment;\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,QAAQ;AAE5B,OAAOC,UAAU;AACjB,OAAOC,gBAAgB;AACvB,SAAQC,YAAY,EAAEC,cAAc;;AAEpC;AACA;AACA;AACA,MAAMC,mBAAmB,SAASJ,UAAU,CAAC;EAC3C;AACF;AACA;AACA;AACA;AACA;EACEK,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEN,YAAY;MAChBO,MAAM,EACJ,iGAAiG;MACnGC,OAAO,EAAE,KAAK;MACdC,WAAW,EAAE,gBAAgB;MAC7BC,QAAQ,EAAE,MAAM;MAChBC,KAAK,EAAE,sBAAsB;MAC7BC,OAAO,EAAE;QACPC,OAAO,EAAE,EAAE;QACXC,GAAG,EAAE,8DAA8D;QACnEC,IAAI,EAAE;MACR;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGhB,YAAY;IAC9B,IAAI,CAACiB,OAAO,GAAGpB,KAAK,CAACQ,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEc,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMC,gBAAgB,GAAG,IAAItB,gBAAgB,CAAC;MAACK,MAAM,EAAE,IAAI,CAACa;IAAO,CAAC,CAAC;IAErE,MAAMK,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACJ,KAAK,CAAC;IAEpDE,gBAAgB,CAACG,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDJ,gBAAgB,CAACK,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IACnD,OAAON,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEO,YAAYA,CAACT,KAAK,EAAEC,UAAU,EAAE;IAC9B,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;EACEG,eAAeA,CAACJ,KAAK,EAAE;IACrB,MAAMQ,MAAM,GAAG,CAAC,MAAM;MACpB,MAAME,YAAY,GAAGV,KAAK,CAACW,UAAU,CAAC,CAAC;MAEvC,OAAOD,YAAY,GAAG,MAAM,GAAG,KAAK;IACtC,CAAC,EAAE,CAAC;IAEJ,MAAMJ,KAAK,GAAG,IAAI,CAACM,QAAQ,CAAC9B,cAAc,EAAE0B,MAAM,CAAC;IAEnD,OAAO;MACLF,KAAK;MACLE;IACF,CAAC;EACH;AACF;AAEA,eAAezB,mBAAmB","ignoreList":[]}

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

@@ -0,0 +1,90 @@
+import { merge } from 'lodash';
+import Assessment from "../assessment";
+import AssessmentResult from "../../../values/AssessmentResult";
+import { KeyIcon } from '@shopify/polaris-icons';
+import { countWords } from "../../../helpers";
+import { KEYPHRASE_LENGTH_ID, MAIN_CONTENT_POINTS } from "../../../const/analysis";
+
+/**
+ * Assessment to check whether the keyphrase has a good length.
+ */
+class KeyphraseLengthAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} [config] The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config) {
+    super();
+    this.defaultConfig = {
+      id: KEYPHRASE_LENGTH_ID,
+      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: 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 = KEYPHRASE_LENGTH_ID;
+    this._config = 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.
+   *
+   * @returns {AssessmentResult} The result of this assessment.
+   */
+  getResult({
+    paper,
+    researcher
+  }) {
+    const assessmentResult = new AssessmentResult({
+      config: this._config
+    });
+    const calculatedResult = this.calculateResult(paper);
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    return assessmentResult;
+  }
+
+  /**
+   * Calculates the result based on the keyphraseLength research.
+   *
+   * @returns {Object} Object with score and text.
+   */
+  calculateResult(paper) {
+    const keywordLength = countWords(paper.getKeyword());
+    let status = 'bad';
+    if (keywordLength <= 4) {
+      status = 'good';
+    }
+    const score = this.getScore(MAIN_CONTENT_POINTS, status);
+    return {
+      score,
+      status
+    };
+  }
+
+  /**
+   * 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 true;
+  }
+}
+export default KeyphraseLengthAssessment;
+//# sourceMappingURL=KeyphraseLengthAssessment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"KeyphraseLengthAssessment.js","names":["merge","Assessment","AssessmentResult","KeyIcon","countWords","KEYPHRASE_LENGTH_ID","MAIN_CONTENT_POINTS","KeyphraseLengthAssessment","constructor","config","defaultConfig","id","ctaType","priority","docUrl","fixPosition","icon","title","content","improve","bad","good","identifier","_config","getResult","paper","researcher","assessmentResult","calculatedResult","calculateResult","setScore","score","setStatus","status","keywordLength","getKeyword","getScore","isApplicable"],"sources":["../../../../../src/scoring/assessments/seo/KeyphraseLengthAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {KeyIcon} from '@shopify/polaris-icons';\nimport {countWords} from '@axyseo/helpers';\nimport {KEYPHRASE_LENGTH_ID, MAIN_CONTENT_POINTS} from '@axyseo/const/analysis';\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: KEYPHRASE_LENGTH_ID,\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 = KEYPHRASE_LENGTH_ID;\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   * @returns {AssessmentResult} The result of this assessment.\n   */\n  getResult({paper, researcher}) {\n    const assessmentResult = new AssessmentResult({config: this._config});\n\n    const calculatedResult = this.calculateResult(paper);\n\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\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) {\n    const keywordLength = countWords(paper.getKeyword());\n\n    let status = 'bad';\n    if (keywordLength <= 4) {\n      status = 'good';\n    }\n\n    const score = this.getScore(MAIN_CONTENT_POINTS, status);\n\n    return {\n      score,\n      status\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 true;\n  }\n}\n\nexport default KeyphraseLengthAssessment;\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,QAAQ;AAC5B,OAAOC,UAAU;AACjB,OAAOC,gBAAgB;AACvB,SAAQC,OAAO,QAAO,wBAAwB;AAC9C,SAAQC,UAAU;AAClB,SAAQC,mBAAmB,EAAEC,mBAAmB;;AAEhD;AACA;AACA;AACA,MAAMC,yBAAyB,SAASN,UAAU,CAAC;EACjD;AACF;AACA;AACA;AACA;AACA;AACA;EACEO,WAAWA,CAACC,MAAM,EAAE;IAClB,KAAK,CAAC,CAAC;IAEP,IAAI,CAACC,aAAa,GAAG;MACnBC,EAAE,EAAEN,mBAAmB;MACvBO,OAAO,EAAE,KAAK;MACdC,QAAQ,EAAE,KAAK;MACfC,MAAM,EACJ,4FAA4F;MAC9FC,WAAW,EAAE,gBAAgB;MAC7BC,IAAI,EAAEb,OAAO;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,GAAGjB,mBAAmB;IACrC,IAAI,CAACkB,OAAO,GAAGvB,KAAK,CAAC,IAAI,CAACU,aAAa,EAAED,MAAM,CAAC;EAClD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEe,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMC,gBAAgB,GAAG,IAAIzB,gBAAgB,CAAC;MAACO,MAAM,EAAE,IAAI,CAACc;IAAO,CAAC,CAAC;IAErE,MAAMK,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACJ,KAAK,CAAC;IAEpDE,gBAAgB,CAACG,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDJ,gBAAgB,CAACK,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IAEnD,OAAON,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;EACEE,eAAeA,CAACJ,KAAK,EAAE;IACrB,MAAMS,aAAa,GAAG9B,UAAU,CAACqB,KAAK,CAACU,UAAU,CAAC,CAAC,CAAC;IAEpD,IAAIF,MAAM,GAAG,KAAK;IAClB,IAAIC,aAAa,IAAI,CAAC,EAAE;MACtBD,MAAM,GAAG,MAAM;IACjB;IAEA,MAAMF,KAAK,GAAG,IAAI,CAACK,QAAQ,CAAC9B,mBAAmB,EAAE2B,MAAM,CAAC;IAExD,OAAO;MACLF,KAAK;MACLE;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEI,YAAYA,CAACZ,KAAK,EAAE;IAClB,OAAO,IAAI;EACb;AACF;AAEA,eAAelB,yBAAyB","ignoreList":[]}

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

@@ -0,0 +1,95 @@
+import { merge } from 'lodash';
+import Assessment from "../assessment";
+import AssessmentResult from "../../../values/AssessmentResult";
+import keyphraseLengthFactor from "../../../scoring/helpers/assessments/keyphraseLengthFactor";
+import { KEYPHRASE_DENSITY_ID, MAIN_CONTENT_POINTS } from "../../../const/analysis";
+
+/**
+ * Represents the assessment that will look if the keyphrase density is within the recommended range.
+ */
+class KeyphraseDensityAssessment extends Assessment {
+  /**
+   *
+   * @param config
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: KEYPHRASE_DENSITY_ID,
+      fixPosition: 'highlightKeyword',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/checklist#main-keyword-density',
+      ctaType: 'fix',
+      priority: 'high',
+      title: 'Main keyword density',
+      content: {
+        good: 'Keyword density is optimized, between 1 - 1.5%.',
+        bad: 'Keep keyword density from 1% - 1.5%.',
+        improve: ''
+      }
+    };
+    this.identifier = KEYPHRASE_DENSITY_ID;
+    this._config = 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.
+   *
+   * @returns {AssessmentResult} The result of the assessment.
+   */
+  getResult({
+    paper,
+    researcher
+  }) {
+    this._keyphraseCount = researcher.getResearch('getKeyphraseCount');
+    const keyphraseLength = this._keyphraseCount.keyphraseLength;
+    this._keyphraseDensity = researcher.getResearch('getKeyphraseDensity');
+    this._keyphraseDensity = this._keyphraseDensity * keyphraseLengthFactor(keyphraseLength);
+    const assessmentResult = new AssessmentResult({
+      config: this._config
+    });
+    const calculatedResult = this.calculateResult(paper);
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    assessmentResult.setTitle(calculatedResult.title);
+    return assessmentResult;
+  }
+
+  /**
+   *
+   * @returns {{title: string, score: number, status: string}}
+   */
+  calculateResult() {
+    const density = this._keyphraseDensity;
+    const roundedDensity = parseFloat(density.toFixed(2));
+    let status = 'bad';
+    if (roundedDensity >= 1 && roundedDensity <= 1.5) {
+      status = 'good';
+    }
+    const score = this.getScore(MAIN_CONTENT_POINTS, status);
+    return {
+      title: (this._config.title || 'Main keyword density') + ': ' + roundedDensity + '%',
+      score,
+      status
+    };
+  }
+
+  /**
+   * 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 true;
+  }
+}
+export default KeyphraseDensityAssessment;
+//# sourceMappingURL=KeywordDensityAssessment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"KeywordDensityAssessment.js","names":["merge","Assessment","AssessmentResult","keyphraseLengthFactor","KEYPHRASE_DENSITY_ID","MAIN_CONTENT_POINTS","KeyphraseDensityAssessment","constructor","config","defaultConfig","id","fixPosition","docUrl","ctaType","priority","title","content","good","bad","improve","identifier","_config","getResult","paper","researcher","_keyphraseCount","getResearch","keyphraseLength","_keyphraseDensity","assessmentResult","calculatedResult","calculateResult","setScore","score","setStatus","status","setTitle","density","roundedDensity","parseFloat","toFixed","getScore","isApplicable"],"sources":["../../../../../src/scoring/assessments/seo/KeywordDensityAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\n\nimport keyphraseLengthFactor from '../../../scoring/helpers/assessments/keyphraseLengthFactor';\nimport {KEYPHRASE_DENSITY_ID, MAIN_CONTENT_POINTS} from '@axyseo/const/analysis';\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: KEYPHRASE_DENSITY_ID,\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      title: 'Main keyword density',\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 = KEYPHRASE_DENSITY_ID;\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   * @returns {AssessmentResult} The result of the assessment.\n   */\n  getResult({paper, researcher}) {\n\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);\n\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n    assessmentResult.setTitle(calculatedResult.title);\n    return assessmentResult;\n  }\n\n  /**\n   *\n   * @returns {{title: string, score: number, status: string}}\n   */\n  calculateResult() {\n    const density = this._keyphraseDensity;\n    const roundedDensity = parseFloat(density.toFixed(2));\n\n    let status = 'bad';\n    if (roundedDensity >= 1 && roundedDensity <= 1.5) {\n      status = 'good';\n    }\n\n    const score = this.getScore(MAIN_CONTENT_POINTS, status);\n\n    return {\n      title: (this._config.title || 'Main keyword density') + ': ' + roundedDensity + '%',\n      score,\n      status\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 true;\n  }\n}\n\nexport default KeyphraseDensityAssessment;\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,QAAQ;AAC5B,OAAOC,UAAU;AACjB,OAAOC,gBAAgB;AAEvB,OAAOC,qBAAqB;AAC5B,SAAQC,oBAAoB,EAAEC,mBAAmB;;AAEjD;AACA;AACA;AACA,MAAMC,0BAA0B,SAASL,UAAU,CAAC;EAClD;AACF;AACA;AACA;EACEM,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEN,oBAAoB;MACxBO,WAAW,EAAE,kBAAkB;MAC/BC,MAAM,EACJ,kGAAkG;MACpGC,OAAO,EAAE,KAAK;MACdC,QAAQ,EAAE,MAAM;MAChBC,KAAK,EAAE,sBAAsB;MAC7BC,OAAO,EAAE;QACPC,IAAI,EAAE,iDAAiD;QACvDC,GAAG,EAAE,sCAAsC;QAC3CC,OAAO,EAAE;MACX;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGhB,oBAAoB;IACtC,IAAI,CAACiB,OAAO,GAAGrB,KAAK,CAACS,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEc,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAE7B,IAAI,CAACC,eAAe,GAAGD,UAAU,CAACE,WAAW,CAAC,mBAAmB,CAAC;IAClE,MAAMC,eAAe,GAAG,IAAI,CAACF,eAAe,CAACE,eAAe;IAE5D,IAAI,CAACC,iBAAiB,GAAGJ,UAAU,CAACE,WAAW,CAAC,qBAAqB,CAAC;IACtE,IAAI,CAACE,iBAAiB,GAAG,IAAI,CAACA,iBAAiB,GAAGzB,qBAAqB,CAACwB,eAAe,CAAC;IAExF,MAAME,gBAAgB,GAAG,IAAI3B,gBAAgB,CAAC;MAACM,MAAM,EAAE,IAAI,CAACa;IAAO,CAAC,CAAC;IAErE,MAAMS,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACR,KAAK,CAAC;IAEpDM,gBAAgB,CAACG,QAAQ,CAACF,gBAAgB,CAACG,KAAK,CAAC;IACjDJ,gBAAgB,CAACK,SAAS,CAACJ,gBAAgB,CAACK,MAAM,CAAC;IACnDN,gBAAgB,CAACO,QAAQ,CAACN,gBAAgB,CAACf,KAAK,CAAC;IACjD,OAAOc,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;EACEE,eAAeA,CAAA,EAAG;IAChB,MAAMM,OAAO,GAAG,IAAI,CAACT,iBAAiB;IACtC,MAAMU,cAAc,GAAGC,UAAU,CAACF,OAAO,CAACG,OAAO,CAAC,CAAC,CAAC,CAAC;IAErD,IAAIL,MAAM,GAAG,KAAK;IAClB,IAAIG,cAAc,IAAI,CAAC,IAAIA,cAAc,IAAI,GAAG,EAAE;MAChDH,MAAM,GAAG,MAAM;IACjB;IAEA,MAAMF,KAAK,GAAG,IAAI,CAACQ,QAAQ,CAACpC,mBAAmB,EAAE8B,MAAM,CAAC;IAExD,OAAO;MACLpB,KAAK,EAAE,CAAC,IAAI,CAACM,OAAO,CAACN,KAAK,IAAI,sBAAsB,IAAI,IAAI,GAAGuB,cAAc,GAAG,GAAG;MACnFL,KAAK;MACLE;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEO,YAAYA,CAACnB,KAAK,EAAEC,UAAU,EAAE;IAC9B,OAAO,IAAI;EACb;AACF;AAEA,eAAelB,0BAA0B","ignoreList":[]}

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

@@ -0,0 +1,104 @@
+import { merge } from 'lodash';
+import Assessment from "../assessment";
+import AssessmentResult from "../../../values/AssessmentResult";
+import { FAQS_POINTS, KEYWORD_FAQs_ASSESSMENT_ID } from "../../../const/analysis";
+
+/**
+ * Represents an assessment that checks if keywords exist in FAQs.
+ */
+export default class KeywordFAQsAssessment extends Assessment {
+  /**
+   * Sets the identifier and the config.
+   *
+   * @param {Object} [config] The configuration to use.
+   *
+   * @returns {void}
+   */
+  constructor(config = {}) {
+    super();
+    const defaultConfig = {
+      id: KEYWORD_FAQs_ASSESSMENT_ID,
+      ctaType: 'fix',
+      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/faqs-builder',
+      priority: 'high',
+      fixPosition: 'faqs',
+      title: 'Keyword in FAQs',
+      content: {
+        good: 'Keywords are found in FAQs.',
+        improve: '',
+        bad: 'No keywords found in FAQs.'
+      }
+    };
+    this.identifier = KEYWORD_FAQs_ASSESSMENT_ID;
+    this._config = merge(defaultConfig, config);
+  }
+
+  /**
+   * Executes the Assessment and returns a result.
+   *
+   * @param {Paper}       paper       The Paper object to assess.
+   * @param {Researcher}  researcher  The Researcher object containing all available researches.
+   *
+   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.
+   */
+  getResult({
+    paper,
+    researcher
+  }) {
+    const calculatedResult = this.calculateResult(paper);
+    const assessmentResult = new AssessmentResult({
+      config: this._config
+    });
+    assessmentResult.setScore(calculatedResult.score);
+    assessmentResult.setStatus(calculatedResult.status);
+    return assessmentResult;
+  }
+
+  /**
+   * Calculates the result of the assessment based on keyword presence in FAQs.
+   *
+   * @param {Paper} paper The paper to use for the assessment.
+   * @returns {Object} The calculated result.
+   */
+  calculateResult(paper) {
+    const faqs = paper.getFAQs()?.questions || [];
+    const keyword = paper.getKeyword();
+    const relatedKeywords = paper.getRelatedKeywords();
+    const hasKeywords = this.checkKeywordsInFAQs(faqs, [...relatedKeywords, keyword]);
+    const status = hasKeywords ? 'good' : 'bad';
+    const score = this.getScore(FAQS_POINTS, status);
+    return {
+      status,
+      score
+    };
+  }
+
+  /**
+   * Checks if keywords exist in FAQs
+   * @param {Array} faqs
+   * @param {Array} keywords
+   * @returns {boolean}
+   */
+  checkKeywordsInFAQs(faqs, keywords) {
+    return faqs.some(faq => {
+      const question = faq.question.toLowerCase();
+      const answer = faq.answer.toLowerCase();
+      return keywords.some(keyword => {
+        const keywordLower = keyword.toLowerCase();
+        return question.includes(keywordLower) || answer.includes(keywordLower);
+      });
+    });
+  }
+
+  /**
+   * Checks whether the paper has text.
+   *
+   * @param {Paper}       paper       The paper to use for the assessment.
+   *
+   * @returns {boolean} True when there is text.
+   */
+  isApplicable(paper) {
+    return true;
+  }
+}
+//# sourceMappingURL=KeywordFAQsAssessment.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"KeywordFAQsAssessment.js","names":["merge","Assessment","AssessmentResult","FAQS_POINTS","KEYWORD_FAQs_ASSESSMENT_ID","KeywordFAQsAssessment","constructor","config","defaultConfig","id","ctaType","docUrl","priority","fixPosition","title","content","good","improve","bad","identifier","_config","getResult","paper","researcher","calculatedResult","calculateResult","assessmentResult","setScore","score","setStatus","status","faqs","getFAQs","questions","keyword","getKeyword","relatedKeywords","getRelatedKeywords","hasKeywords","checkKeywordsInFAQs","getScore","keywords","some","faq","question","toLowerCase","answer","keywordLower","includes","isApplicable"],"sources":["../../../../../src/scoring/assessments/seo/KeywordFAQsAssessment.js"],"sourcesContent":["import {merge} from 'lodash';\nimport Assessment from '../assessment';\nimport AssessmentResult from '../../../values/AssessmentResult';\nimport {FAQS_POINTS, KEYWORD_FAQs_ASSESSMENT_ID} from '@axyseo/const/analysis';\n\n/**\n * Represents an assessment that checks if keywords exist in FAQs.\n */\nexport default class KeywordFAQsAssessment 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: KEYWORD_FAQs_ASSESSMENT_ID,\n      ctaType: 'fix',\n      docUrl: 'https://docs.avada.io/seo-suite-help-center/seo-audit/on-page-seo/faqs-builder',\n      priority: 'high',\n      fixPosition: 'faqs',\n      title: 'Keyword in FAQs',\n      content: {\n        good: 'Keywords are found in FAQs.',\n        improve: '',\n        bad: 'No keywords found in FAQs.'\n      }\n    };\n\n    this.identifier = KEYWORD_FAQs_ASSESSMENT_ID;\n    this._config = merge(defaultConfig, config);\n  }\n\n  /**\n   * Executes the Assessment and returns a result.\n   *\n   * @param {Paper}       paper       The Paper object to assess.\n   * @param {Researcher}  researcher  The Researcher object containing all available researches.\n   *\n   * @returns {AssessmentResult} The result of the assessment, containing both a score and a descriptive text.\n   */\n  getResult({paper, researcher}) {\n    const calculatedResult = this.calculateResult(paper);\n\n    const assessmentResult = new AssessmentResult({config: this._config});\n    assessmentResult.setScore(calculatedResult.score);\n    assessmentResult.setStatus(calculatedResult.status);\n\n    return assessmentResult;\n  }\n\n  /**\n   * Calculates the result of the assessment based on keyword presence in FAQs.\n   *\n   * @param {Paper} paper The paper to use for the assessment.\n   * @returns {Object} The calculated result.\n   */\n  calculateResult(paper) {\n    const faqs = paper.getFAQs()?.questions || [];\n    const keyword = paper.getKeyword();\n    const relatedKeywords = paper.getRelatedKeywords();\n\n    const hasKeywords = this.checkKeywordsInFAQs(faqs, [...relatedKeywords, keyword]);\n    const status = hasKeywords ? 'good' : 'bad';\n    const score = this.getScore(FAQS_POINTS, status);\n\n    return {\n      status,\n      score\n    };\n  }\n\n  /**\n   * Checks if keywords exist in FAQs\n   * @param {Array} faqs\n   * @param {Array} keywords\n   * @returns {boolean}\n   */\n  checkKeywordsInFAQs(faqs, keywords) {\n    return faqs.some(faq => {\n      const question = faq.question.toLowerCase();\n      const answer = faq.answer.toLowerCase();\n      return keywords.some(keyword => {\n        const keywordLower = keyword.toLowerCase();\n        return question.includes(keywordLower) || answer.includes(keywordLower);\n      });\n    });\n  }\n\n  /**\n   * Checks whether the paper has text.\n   *\n   * @param {Paper}       paper       The paper to use for the assessment.\n   *\n   * @returns {boolean} True when there is text.\n   */\n  isApplicable(paper) {\n    return true;\n  }\n}\n"],"mappings":"AAAA,SAAQA,KAAK,QAAO,QAAQ;AAC5B,OAAOC,UAAU;AACjB,OAAOC,gBAAgB;AACvB,SAAQC,WAAW,EAAEC,0BAA0B;;AAE/C;AACA;AACA;AACA,eAAe,MAAMC,qBAAqB,SAASJ,UAAU,CAAC;EAC5D;AACF;AACA;AACA;AACA;AACA;AACA;EACEK,WAAWA,CAACC,MAAM,GAAG,CAAC,CAAC,EAAE;IACvB,KAAK,CAAC,CAAC;IAEP,MAAMC,aAAa,GAAG;MACpBC,EAAE,EAAEL,0BAA0B;MAC9BM,OAAO,EAAE,KAAK;MACdC,MAAM,EAAE,gFAAgF;MACxFC,QAAQ,EAAE,MAAM;MAChBC,WAAW,EAAE,MAAM;MACnBC,KAAK,EAAE,iBAAiB;MACxBC,OAAO,EAAE;QACPC,IAAI,EAAE,6BAA6B;QACnCC,OAAO,EAAE,EAAE;QACXC,GAAG,EAAE;MACP;IACF,CAAC;IAED,IAAI,CAACC,UAAU,GAAGf,0BAA0B;IAC5C,IAAI,CAACgB,OAAO,GAAGpB,KAAK,CAACQ,aAAa,EAAED,MAAM,CAAC;EAC7C;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEc,SAASA,CAAC;IAACC,KAAK;IAAEC;EAAU,CAAC,EAAE;IAC7B,MAAMC,gBAAgB,GAAG,IAAI,CAACC,eAAe,CAACH,KAAK,CAAC;IAEpD,MAAMI,gBAAgB,GAAG,IAAIxB,gBAAgB,CAAC;MAACK,MAAM,EAAE,IAAI,CAACa;IAAO,CAAC,CAAC;IACrEM,gBAAgB,CAACC,QAAQ,CAACH,gBAAgB,CAACI,KAAK,CAAC;IACjDF,gBAAgB,CAACG,SAAS,CAACL,gBAAgB,CAACM,MAAM,CAAC;IAEnD,OAAOJ,gBAAgB;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;EACED,eAAeA,CAACH,KAAK,EAAE;IACrB,MAAMS,IAAI,GAAGT,KAAK,CAACU,OAAO,CAAC,CAAC,EAAEC,SAAS,IAAI,EAAE;IAC7C,MAAMC,OAAO,GAAGZ,KAAK,CAACa,UAAU,CAAC,CAAC;IAClC,MAAMC,eAAe,GAAGd,KAAK,CAACe,kBAAkB,CAAC,CAAC;IAElD,MAAMC,WAAW,GAAG,IAAI,CAACC,mBAAmB,CAACR,IAAI,EAAE,CAAC,GAAGK,eAAe,EAAEF,OAAO,CAAC,CAAC;IACjF,MAAMJ,MAAM,GAAGQ,WAAW,GAAG,MAAM,GAAG,KAAK;IAC3C,MAAMV,KAAK,GAAG,IAAI,CAACY,QAAQ,CAACrC,WAAW,EAAE2B,MAAM,CAAC;IAEhD,OAAO;MACLA,MAAM;MACNF;IACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEW,mBAAmBA,CAACR,IAAI,EAAEU,QAAQ,EAAE;IAClC,OAAOV,IAAI,CAACW,IAAI,CAACC,GAAG,IAAI;MACtB,MAAMC,QAAQ,GAAGD,GAAG,CAACC,QAAQ,CAACC,WAAW,CAAC,CAAC;MAC3C,MAAMC,MAAM,GAAGH,GAAG,CAACG,MAAM,CAACD,WAAW,CAAC,CAAC;MACvC,OAAOJ,QAAQ,CAACC,IAAI,CAACR,OAAO,IAAI;QAC9B,MAAMa,YAAY,GAAGb,OAAO,CAACW,WAAW,CAAC,CAAC;QAC1C,OAAOD,QAAQ,CAACI,QAAQ,CAACD,YAAY,CAAC,IAAID,MAAM,CAACE,QAAQ,CAACD,YAAY,CAAC;MACzE,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEE,YAAYA,CAAC3B,KAAK,EAAE;IAClB,OAAO,IAAI;EACb;AACF","ignoreList":[]}