axyseo 2.0.0-alpha.0.0.37 → 2.0.0-alpha.0.0.38

package/build/scoring/assessors/assessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"assessor.js","names":["_lodash","require","_AssessmentResult","_interopRequireDefault","_build","_LanguageProcessor","_missingArgument","_errors","_polaris","_react","e","__esModule","default","ScoreRating","Assessor","constructor","researcher","config","type","setResearcher","_assessments","isUndefined","MissingArgument","_researcher","getAvailableAssessments","isApplicable","assessment","paper","ignoreAssessments","getIgnoredAssessments","includes","_config","id","hasOwnProperty","hasMarker","isFunction","marker","getMarks","getSpecificMarker","getPaper","_lastPaper","assess","i18n","setPaper","languageProcessor","LanguageProcessor","shortcodes","_attributes","setTree","build","assessments","results","filter","bind","map","executeAssessment","result","title","translate","content","good","improve","bad","skippedAssessments","getSkippedAssessments","assessmentResult","AssessmentResult","score","getScore","priority","setScore","setStatus","setTitle","setBody","createElement","Text","as","docUrl","href","target","rel","getResult","setIdentifier","assessmentError","showTrace","getValidResults","isValidResult","hasScore","hasText","calculateOverallScore","totalScore","reduce","total","Math","round","length","addAssessment","name","identifier","getAssessment","removeAssessment","push","toDelete","findIndex","splice","find","getApplicableAssessments","availableAssessments","availableAssessment","_default","exports"],"sources":["../../../src/scoring/assessors/assessor.js"],"sourcesContent":["// External dependencies.\nimport {filter, find, findIndex, isFunction, isUndefined, map} from 'lodash';\n\n// Internal dependencies.\nimport AssessmentResult from '../../values/AssessmentResult.js';\nimport {build} from '../../parse/build';\nimport LanguageProcessor from '../../parse/language/LanguageProcessor.js';\nimport MissingArgument from '../../errors/missingArgument.js';\nimport {showTrace} from '../../helpers/errors.js';\nimport {Text} from '@shopify/polaris';\nimport React from 'react';\n\n// The maximum score of individual assessment is 9. This is why we set the \"score rating\" here to 9.\nconst ScoreRating = 9;\n\n/**\n * The Assessor is a base class for all assessors.\n */\nclass Assessor {\n  /**\n   * Creates a new Assessor instance.\n   * @param {Researcher}\tresearcher\tThe researcher to use.\n   * @param {Object}\t\t[config]\tThe assessor config.\n   */\n  constructor(researcher, config) {\n    this.type = 'assessor';\n    this.setResearcher(researcher);\n    this._assessments = [];\n  }\n\n  /**\n   * Checks if the researcher is defined and sets it.\n   *\n   * @param   {Researcher} researcher The researcher to use in the assessor.\n   *\n   * @throws  {MissingArgument} Parameter needs to be a valid researcher object.\n   * @returns {void}\n   */\n  setResearcher(researcher) {\n    if (isUndefined(researcher)) {\n      throw new MissingArgument('The assessor requires a researcher.');\n    }\n    this._researcher = researcher;\n  }\n\n  /**\n   * Gets all available assessments.\n   * @returns {Assessment[]} assessment\n   */\n  getAvailableAssessments() {\n    return this._assessments;\n  }\n\n  /**\n   * Checks whether the Assessment is applicable.\n   *\n   * @param {Assessment} assessment The Assessment object that needs to be checked.\n   * @param {Paper} paper The Paper object to check against.\n   * @param {Researcher} [researcher] The Researcher object containing additional information.\n   * @returns {boolean} Whether or not the Assessment is applicable.\n   */\n  isApplicable(assessment, paper, researcher) {\n    const ignoreAssessments = paper.getIgnoredAssessments();\n\n    if (ignoreAssessments.includes(assessment._config.id)) {\n      return false;\n    }\n\n    if (\n      assessment.hasOwnProperty('isApplicable') ||\n      typeof assessment.isApplicable === 'function'\n    ) {\n      return assessment.isApplicable(paper, researcher);\n    }\n\n    return true;\n  }\n\n  /**\n   * Determines whether an assessment has a marker.\n   *\n   * @param {Assessment} assessment The assessment to check for.\n   * @returns {boolean} Whether or not the assessment has a marker.\n   */\n  hasMarker(assessment) {\n    return (\n      isFunction(this._config.marker) &&\n      (assessment.hasOwnProperty('getMarks') || typeof assessment.getMarks === 'function')\n    );\n  }\n\n  /**\n   * Returns the specific marker for this assessor.\n   *\n   * @returns {Function} The specific marker for this assessor.\n   */\n  getSpecificMarker() {\n    return this._config.marker;\n  }\n\n  /**\n   * Returns the paper that was most recently assessed.\n   *\n   * @returns {Paper} The paper that was most recently assessed.\n   */\n  getPaper() {\n    return this._lastPaper;\n  }\n\n  /**\n   * Runs the researches defined in the task list or the default researches.\n   *\n   * @param {Paper} paper The paper to run assessments on.\n   * @param i18n\n   * @returns {void}\n   */\n  assess(paper, i18n) {\n    this._researcher.setPaper(paper);\n\n    const languageProcessor = new LanguageProcessor(this._researcher);\n    const shortcodes = paper._attributes && paper._attributes.shortcodes;\n    paper.setTree(build(paper, languageProcessor, shortcodes));\n\n    let assessments = this.getAvailableAssessments();\n    this.results = [];\n\n    assessments = filter(\n      assessments,\n      function(assessment) {\n        return this.isApplicable(assessment, paper, this._researcher);\n      }.bind(this)\n    );\n\n    this.results = map(assessments, assessment =>\n      this.executeAssessment({\n        paper,\n        researcher: this._researcher,\n        assessment,\n        i18n\n      })\n    );\n    this._lastPaper = paper;\n  }\n\n  /**\n   * Executes an assessment and returns the AssessmentResult.\n   *\n   * @param {Paper} paper The paper to pass to the assessment.\n   * @param {Researcher} researcher The researcher to pass to the assessment.\n   * @param {Assessment} assessment The assessment to execute.\n   * @param i18n\n   * @returns {AssessmentResult} The result of the assessment.\n   */\n  executeAssessment({paper, researcher, assessment, i18n}) {\n    let result;\n\n    try {\n      if (i18n) {\n        assessment._config.title = i18n.translate(`Axyseo.${assessment._config.id}.title`);\n        assessment._config.content = {\n          good: i18n.translate(`Axyseo.${assessment._config.id}.good`),\n          improve: i18n.translate(`Axyseo.${assessment._config.id}.improve`),\n          bad: i18n.translate(`Axyseo.${assessment._config.id}.bad`)\n        };\n      }\n\n      const skippedAssessments = paper.getSkippedAssessments();\n\n      if (skippedAssessments.includes(assessment._config.id)) {\n        const assessmentResult = new AssessmentResult({config: assessment._config});\n\n        const score = assessment.getScore(assessment._config.priority, 'good');\n\n        assessmentResult.setScore(score);\n        assessmentResult.setStatus('good');\n        assessmentResult.setTitle(assessment._config.title);\n        assessmentResult.setBody(\n          <Text as={'span'}>\n            {assessment._config.content.good}{' '}\n            {assessment._config.docUrl && (\n              <a href={assessment._config.docUrl} target=\"_blank\" rel=\"noreferrer\">\n                {i18n ? i18n.translate(`Axyseo.Button.learnMore`) : 'Learn more'}\n              </a>\n            )}\n          </Text>\n        );\n\n        result = assessmentResult;\n      } else {\n        result = assessment.getResult({paper, researcher, i18n});\n      }\n      result.setIdentifier(assessment._config.id);\n    } catch (assessmentError) {\n      showTrace(assessmentError);\n\n      result = new AssessmentResult();\n\n      result.setScore(-1);\n    }\n    return result;\n  }\n\n  /**\n   * Filters out all assessment results that have no score and no text.\n   *\n   * @returns {AssessmentResult[]} The array with all the valid assessments.\n   */\n  getValidResults() {\n    return filter(\n      this.results,\n      function(result) {\n        return this.isValidResult(result);\n      }.bind(this)\n    );\n  }\n\n  /**\n   * Returns if an assessmentResult is valid.\n   *\n   * @param {AssessmentResult} assessmentResult The assessmentResult to validate.\n   * @returns {boolean} whether or not the result is valid.\n   */\n  isValidResult(assessmentResult) {\n    return assessmentResult.hasScore() && assessmentResult.hasText();\n  }\n\n  /**\n   * Returns the overall score. Calculates the total score by adding all scores and dividing these\n   * by the number of results times the ScoreRating.\n   *\n   * @returns {number} The overall score.\n   */\n  calculateOverallScore() {\n    const results = this.getValidResults();\n\n    const totalScore = results.reduce(\n      (total, assessmentResult) => total + assessmentResult.getScore(),\n      0\n    );\n\n    return Math.round((totalScore / (results.length * ScoreRating)) * 100) || 0;\n  }\n\n  /**\n   * Registers an assessment and adds it to the internal assessments object.\n   *\n   * @param {string} name The name of the assessment.\n   * @param {Assessment} assessment The object containing function to run as an assessment and it's requirements.\n   * @returns {boolean} Whether registering the assessment was successful.\n   */\n  addAssessment(name, assessment) {\n    if (!assessment.hasOwnProperty('identifier')) {\n      assessment.identifier = name;\n    }\n    // If the assessor already has the same assessment, remove it and replace it with the new assessment with the same identifier.\n    if (this.getAssessment(assessment.identifier)) {\n      this.removeAssessment(assessment.identifier);\n    }\n\n    this._assessments.push(assessment);\n    return true;\n  }\n\n  /**\n   * Removes a specific Assessment from the list of Assessments.\n   *\n   * @param {string} name The Assessment to remove from the list of assessments.\n   * @returns {void}\n   */\n  removeAssessment(name) {\n    const toDelete = findIndex(this._assessments, function(assessment) {\n      return assessment.hasOwnProperty('identifier') && name === assessment.identifier;\n    });\n\n    if (-1 !== toDelete) {\n      this._assessments.splice(toDelete, 1);\n    }\n  }\n\n  /**\n   * Returns an assessment by identifier\n   *\n   * @param {string} identifier The identifier of the assessment.\n   * @returns {undefined|Assessment} The object if found, otherwise undefined.\n   */\n  getAssessment(identifier) {\n    return find(this._assessments, function(assessment) {\n      return assessment.hasOwnProperty('identifier') && identifier === assessment.identifier;\n    });\n  }\n\n  /**\n   * Checks which of the available assessments are applicable and returns an array with applicable assessments.\n   *\n   * @returns {Assessment[]} The array with applicable assessments.\n   */\n  getApplicableAssessments() {\n    const availableAssessments = this.getAvailableAssessments();\n    return filter(\n      availableAssessments,\n      function(availableAssessment) {\n        return this.isApplicable(availableAssessment, this.getPaper(), this._researcher);\n      }.bind(this)\n    );\n  }\n}\n\nexport default Assessor;\n"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AAGA,IAAAC,iBAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,MAAA,GAAAH,OAAA;AACA,IAAAI,kBAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,gBAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,OAAA,GAAAN,OAAA;AACA,IAAAO,QAAA,GAAAP,OAAA;AACA,IAAAQ,MAAA,GAAAN,sBAAA,CAAAF,OAAA;AAA0B,SAAAE,uBAAAO,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAV1B;;AAGA;;AASA;AACA,MAAMG,WAAW,GAAG,CAAC;;AAErB;AACA;AACA;AACA,MAAMC,QAAQ,CAAC;EACb;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,MAAM,EAAE;IAC9B,IAAI,CAACC,IAAI,GAAG,UAAU;IACtB,IAAI,CAACC,aAAa,CAACH,UAAU,CAAC;IAC9B,IAAI,CAACI,YAAY,GAAG,EAAE;EACxB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACED,aAAaA,CAACH,UAAU,EAAE;IACxB,IAAI,IAAAK,mBAAW,EAACL,UAAU,CAAC,EAAE;MAC3B,MAAM,IAAIM,wBAAe,CAAC,qCAAqC,CAAC;IAClE;IACA,IAAI,CAACC,WAAW,GAAGP,UAAU;EAC/B;;EAEA;AACF;AACA;AACA;EACEQ,uBAAuBA,CAAA,EAAG;IACxB,OAAO,IAAI,CAACJ,YAAY;EAC1B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEK,YAAYA,CAACC,UAAU,EAAEC,KAAK,EAAEX,UAAU,EAAE;IAC1C,MAAMY,iBAAiB,GAAGD,KAAK,CAACE,qBAAqB,CAAC,CAAC;IAEvD,IAAID,iBAAiB,CAACE,QAAQ,CAACJ,UAAU,CAACK,OAAO,CAACC,EAAE,CAAC,EAAE;MACrD,OAAO,KAAK;IACd;IAEA,IACEN,UAAU,CAACO,cAAc,CAAC,cAAc,CAAC,IACzC,OAAOP,UAAU,CAACD,YAAY,KAAK,UAAU,EAC7C;MACA,OAAOC,UAAU,CAACD,YAAY,CAACE,KAAK,EAAEX,UAAU,CAAC;IACnD;IAEA,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEkB,SAASA,CAACR,UAAU,EAAE;IACpB,OACE,IAAAS,kBAAU,EAAC,IAAI,CAACJ,OAAO,CAACK,MAAM,CAAC,KAC9BV,UAAU,CAACO,cAAc,CAAC,UAAU,CAAC,IAAI,OAAOP,UAAU,CAACW,QAAQ,KAAK,UAAU,CAAC;EAExF;;EAEA;AACF;AACA;AACA;AACA;EACEC,iBAAiBA,CAAA,EAAG;IAClB,OAAO,IAAI,CAACP,OAAO,CAACK,MAAM;EAC5B;;EAEA;AACF;AACA;AACA;AACA;EACEG,QAAQA,CAAA,EAAG;IACT,OAAO,IAAI,CAACC,UAAU;EACxB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEC,MAAMA,CAACd,KAAK,EAAEe,IAAI,EAAE;IAClB,IAAI,CAACnB,WAAW,CAACoB,QAAQ,CAAChB,KAAK,CAAC;IAEhC,MAAMiB,iBAAiB,GAAG,IAAIC,0BAAiB,CAAC,IAAI,CAACtB,WAAW,CAAC;IACjE,MAAMuB,UAAU,GAAGnB,KAAK,CAACoB,WAAW,IAAIpB,KAAK,CAACoB,WAAW,CAACD,UAAU;IACpEnB,KAAK,CAACqB,OAAO,CAAC,IAAAC,YAAK,EAACtB,KAAK,EAAEiB,iBAAiB,EAAEE,UAAU,CAAC,CAAC;IAE1D,IAAII,WAAW,GAAG,IAAI,CAAC1B,uBAAuB,CAAC,CAAC;IAChD,IAAI,CAAC2B,OAAO,GAAG,EAAE;IAEjBD,WAAW,GAAG,IAAAE,cAAM,EAClBF,WAAW,EACX,UAASxB,UAAU,EAAE;MACnB,OAAO,IAAI,CAACD,YAAY,CAACC,UAAU,EAAEC,KAAK,EAAE,IAAI,CAACJ,WAAW,CAAC;IAC/D,CAAC,CAAC8B,IAAI,CAAC,IAAI,CACb,CAAC;IAED,IAAI,CAACF,OAAO,GAAG,IAAAG,WAAG,EAACJ,WAAW,EAAExB,UAAU,IACxC,IAAI,CAAC6B,iBAAiB,CAAC;MACrB5B,KAAK;MACLX,UAAU,EAAE,IAAI,CAACO,WAAW;MAC5BG,UAAU;MACVgB;IACF,CAAC,CACH,CAAC;IACD,IAAI,CAACF,UAAU,GAAGb,KAAK;EACzB;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE4B,iBAAiBA,CAAC;IAAC5B,KAAK;IAAEX,UAAU;IAAEU,UAAU;IAAEgB;EAAI,CAAC,EAAE;IACvD,IAAIc,MAAM;IAEV,IAAI;MACF,IAAId,IAAI,EAAE;QACRhB,UAAU,CAACK,OAAO,CAAC0B,KAAK,GAAGf,IAAI,CAACgB,SAAS,CAAC,UAAUhC,UAAU,CAACK,OAAO,CAACC,EAAE,QAAQ,CAAC;QAClFN,UAAU,CAACK,OAAO,CAAC4B,OAAO,GAAG;UAC3BC,IAAI,EAAElB,IAAI,CAACgB,SAAS,CAAC,UAAUhC,UAAU,CAACK,OAAO,CAACC,EAAE,OAAO,CAAC;UAC5D6B,OAAO,EAAEnB,IAAI,CAACgB,SAAS,CAAC,UAAUhC,UAAU,CAACK,OAAO,CAACC,EAAE,UAAU,CAAC;UAClE8B,GAAG,EAAEpB,IAAI,CAACgB,SAAS,CAAC,UAAUhC,UAAU,CAACK,OAAO,CAACC,EAAE,MAAM;QAC3D,CAAC;MACH;MAEA,MAAM+B,kBAAkB,GAAGpC,KAAK,CAACqC,qBAAqB,CAAC,CAAC;MAExD,IAAID,kBAAkB,CAACjC,QAAQ,CAACJ,UAAU,CAACK,OAAO,CAACC,EAAE,CAAC,EAAE;QACtD,MAAMiC,gBAAgB,GAAG,IAAIC,yBAAgB,CAAC;UAACjD,MAAM,EAAES,UAAU,CAACK;QAAO,CAAC,CAAC;QAE3E,MAAMoC,KAAK,GAAGzC,UAAU,CAAC0C,QAAQ,CAAC1C,UAAU,CAACK,OAAO,CAACsC,QAAQ,EAAE,MAAM,CAAC;QAEtEJ,gBAAgB,CAACK,QAAQ,CAACH,KAAK,CAAC;QAChCF,gBAAgB,CAACM,SAAS,CAAC,MAAM,CAAC;QAClCN,gBAAgB,CAACO,QAAQ,CAAC9C,UAAU,CAACK,OAAO,CAAC0B,KAAK,CAAC;QACnDQ,gBAAgB,CAACQ,OAAO,cACtBhE,MAAA,CAAAG,OAAA,CAAA8D,aAAA,CAAClE,QAAA,CAAAmE,IAAI;UAACC,EAAE,EAAE;QAAO,GACdlD,UAAU,CAACK,OAAO,CAAC4B,OAAO,CAACC,IAAI,EAAE,GAAG,EACpClC,UAAU,CAACK,OAAO,CAAC8C,MAAM,iBACxBpE,MAAA,CAAAG,OAAA,CAAA8D,aAAA;UAAGI,IAAI,EAAEpD,UAAU,CAACK,OAAO,CAAC8C,MAAO;UAACE,MAAM,EAAC,QAAQ;UAACC,GAAG,EAAC;QAAY,GACjEtC,IAAI,GAAGA,IAAI,CAACgB,SAAS,CAAC,yBAAyB,CAAC,GAAG,YACnD,CAED,CACR,CAAC;QAEDF,MAAM,GAAGS,gBAAgB;MAC3B,CAAC,MAAM;QACLT,MAAM,GAAG9B,UAAU,CAACuD,SAAS,CAAC;UAACtD,KAAK;UAAEX,UAAU;UAAE0B;QAAI,CAAC,CAAC;MAC1D;MACAc,MAAM,CAAC0B,aAAa,CAACxD,UAAU,CAACK,OAAO,CAACC,EAAE,CAAC;IAC7C,CAAC,CAAC,OAAOmD,eAAe,EAAE;MACxB,IAAAC,iBAAS,EAACD,eAAe,CAAC;MAE1B3B,MAAM,GAAG,IAAIU,yBAAgB,CAAC,CAAC;MAE/BV,MAAM,CAACc,QAAQ,CAAC,CAAC,CAAC,CAAC;IACrB;IACA,OAAOd,MAAM;EACf;;EAEA;AACF;AACA;AACA;AACA;EACE6B,eAAeA,CAAA,EAAG;IAChB,OAAO,IAAAjC,cAAM,EACX,IAAI,CAACD,OAAO,EACZ,UAASK,MAAM,EAAE;MACf,OAAO,IAAI,CAAC8B,aAAa,CAAC9B,MAAM,CAAC;IACnC,CAAC,CAACH,IAAI,CAAC,IAAI,CACb,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEiC,aAAaA,CAACrB,gBAAgB,EAAE;IAC9B,OAAOA,gBAAgB,CAACsB,QAAQ,CAAC,CAAC,IAAItB,gBAAgB,CAACuB,OAAO,CAAC,CAAC;EAClE;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,qBAAqBA,CAAA,EAAG;IACtB,MAAMtC,OAAO,GAAG,IAAI,CAACkC,eAAe,CAAC,CAAC;IAEtC,MAAMK,UAAU,GAAGvC,OAAO,CAACwC,MAAM,CAC/B,CAACC,KAAK,EAAE3B,gBAAgB,KAAK2B,KAAK,GAAG3B,gBAAgB,CAACG,QAAQ,CAAC,CAAC,EAChE,CACF,CAAC;IAED,OAAOyB,IAAI,CAACC,KAAK,CAAEJ,UAAU,IAAIvC,OAAO,CAAC4C,MAAM,GAAGlF,WAAW,CAAC,GAAI,GAAG,CAAC,IAAI,CAAC;EAC7E;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;EACEmF,aAAaA,CAACC,IAAI,EAAEvE,UAAU,EAAE;IAC9B,IAAI,CAACA,UAAU,CAACO,cAAc,CAAC,YAAY,CAAC,EAAE;MAC5CP,UAAU,CAACwE,UAAU,GAAGD,IAAI;IAC9B;IACA;IACA,IAAI,IAAI,CAACE,aAAa,CAACzE,UAAU,CAACwE,UAAU,CAAC,EAAE;MAC7C,IAAI,CAACE,gBAAgB,CAAC1E,UAAU,CAACwE,UAAU,CAAC;IAC9C;IAEA,IAAI,CAAC9E,YAAY,CAACiF,IAAI,CAAC3E,UAAU,CAAC;IAClC,OAAO,IAAI;EACb;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE0E,gBAAgBA,CAACH,IAAI,EAAE;IACrB,MAAMK,QAAQ,GAAG,IAAAC,iBAAS,EAAC,IAAI,CAACnF,YAAY,EAAE,UAASM,UAAU,EAAE;MACjE,OAAOA,UAAU,CAACO,cAAc,CAAC,YAAY,CAAC,IAAIgE,IAAI,KAAKvE,UAAU,CAACwE,UAAU;IAClF,CAAC,CAAC;IAEF,IAAI,CAAC,CAAC,KAAKI,QAAQ,EAAE;MACnB,IAAI,CAAClF,YAAY,CAACoF,MAAM,CAACF,QAAQ,EAAE,CAAC,CAAC;IACvC;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEH,aAAaA,CAACD,UAAU,EAAE;IACxB,OAAO,IAAAO,YAAI,EAAC,IAAI,CAACrF,YAAY,EAAE,UAASM,UAAU,EAAE;MAClD,OAAOA,UAAU,CAACO,cAAc,CAAC,YAAY,CAAC,IAAIiE,UAAU,KAAKxE,UAAU,CAACwE,UAAU;IACxF,CAAC,CAAC;EACJ;;EAEA;AACF;AACA;AACA;AACA;EACEQ,wBAAwBA,CAAA,EAAG;IACzB,MAAMC,oBAAoB,GAAG,IAAI,CAACnF,uBAAuB,CAAC,CAAC;IAC3D,OAAO,IAAA4B,cAAM,EACXuD,oBAAoB,EACpB,UAASC,mBAAmB,EAAE;MAC5B,OAAO,IAAI,CAACnF,YAAY,CAACmF,mBAAmB,EAAE,IAAI,CAACrE,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAChB,WAAW,CAAC;IAClF,CAAC,CAAC8B,IAAI,CAAC,IAAI,CACb,CAAC;EACH;AACF;AAAC,IAAAwD,QAAA,GAAAC,OAAA,CAAAlG,OAAA,GAEcE,QAAQ","ignoreList":[]}

package/build/scoring/assessors/avadaAssessor.js

@@ -0,0 +1,91 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _index = require("./index");
+var _helpers = require("../helpers");
+/**
+ * The AvadaAssessor class is used for the general SEO analysis.
+ */
+class AvadaAssessor {
+  /**
+   * Creates a new AvadaAssessor instance.
+   * @param {Researcher}  researcher  The researcher to use.
+   * @param {Object}    [config]  The assessor config.
+   * @param {Object}  [config.textParagraphTooLong]
+   * @param {Object}  [config.textSentenceLength]
+   * @param {Object}  [config.textTransitionWords]
+   * @param {Object}  [config.sentenceBeginnings]
+   * @param {Object}  [config.relatedKeywords]
+   * @param {Object}  [config.titleKeyword]
+   * @param {Object}  [config.textImages]
+   * @param {Object}  [config.numberTitle]
+   * @param {Object}  [config.introductionKeyword]
+   * @param {Object}  [config.keyphraseLength]
+   * @param {Object}  [config.metaDescriptionKeyword]
+   * @param {Object}  [config.metaDescriptionLength]
+   * @param {Object}  [config.subheadingsKeyword]
+   * @param {Object}  [config.externalLinks]
+   * @param {Object}  [config.keyphraseDensity]
+   * @param {Object}  [config.media]
+   * @param {Object}  [config.urlLength]
+   * @param {Object}  [config.textLength]
+   * @param {Object}  [config.singleTitle]
+   * @param {Object}  [config.keyphrase]
+   * @param {Object}  [config.internalLinks]
+   * @param {Object}  [config.titleWidth]
+   * @param {Object}  [config.slugKeyword]
+   * @param {Object}  [config.singleH1]
+   * @param {Object}  [config.schema]
+   */
+  constructor(researcher, config = {}) {
+    const seoAssessor = new _index.SEOAssessor(researcher, config);
+    const contentAssessor = new _index.ContentAssessor(researcher, config);
+    this.seoAssessor = seoAssessor;
+    this.contentAssessor = contentAssessor;
+    this.researcher = researcher;
+    this.config = config;
+  }
+  assess(paper, i18n) {
+    this.seoAssessor.assess(paper, i18n);
+    this.contentAssessor.assess(paper, i18n);
+    let assessments = [...this.seoAssessor.results, ...this.contentAssessor.results];
+    assessments = assessments.map(assessment => ({
+      ...assessment.config,
+      body: assessment.body,
+      status: assessment.status,
+      score: assessment.score,
+      title: assessment.title || assessment.config.title
+    }));
+    this.assessments = assessments;
+  }
+  getResult(groupBy = 'category', getScore = true) {
+    let assessments = [];
+    switch (groupBy) {
+      case 'category':
+        assessments = (0, _helpers.groupAssessmentsByCategory)(this.assessments);
+        break;
+      case 'status':
+        assessments = (0, _helpers.groupAssessmentsByStatus)(this.assessments);
+        break;
+    }
+    return {
+      assessments,
+      ...(getScore ? {
+        score: this.getScore()
+      } : {})
+    };
+  }
+  getScore() {
+    let point = 0;
+    this.assessments.forEach(assessment => {
+      point += assessment.score;
+    });
+    const maxPoint = (0, _helpers.getMaxPoint)(this.assessments);
+    return Math.round(point * 100 / maxPoint);
+  }
+}
+exports.default = AvadaAssessor;
+//# sourceMappingURL=avadaAssessor.js.map

package/build/scoring/assessors/avadaAssessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"avadaAssessor.js","names":["_index","require","_helpers","AvadaAssessor","constructor","researcher","config","seoAssessor","SEOAssessor","contentAssessor","ContentAssessor","assess","paper","i18n","assessments","results","map","assessment","body","status","score","title","getResult","groupBy","getScore","groupAssessmentsByCategory","groupAssessmentsByStatus","point","forEach","maxPoint","getMaxPoint","Math","round","exports","default"],"sources":["../../../src/scoring/assessors/avadaAssessor.js"],"sourcesContent":["import {ContentAssessor, SEOAssessor} from '@axyseo/scoring/assessors/index';\nimport {getMaxPoint, groupAssessmentsByCategory, groupAssessmentsByStatus} from '../helpers';\n\n/**\n * The AvadaAssessor class is used for the general SEO analysis.\n */\nexport default class AvadaAssessor {\n  /**\n   * Creates a new AvadaAssessor instance.\n   * @param {Researcher}  researcher  The researcher to use.\n   * @param {Object}    [config]  The assessor config.\n   * @param {Object}  [config.textParagraphTooLong]\n   * @param {Object}  [config.textSentenceLength]\n   * @param {Object}  [config.textTransitionWords]\n   * @param {Object}  [config.sentenceBeginnings]\n   * @param {Object}  [config.relatedKeywords]\n   * @param {Object}  [config.titleKeyword]\n   * @param {Object}  [config.textImages]\n   * @param {Object}  [config.numberTitle]\n   * @param {Object}  [config.introductionKeyword]\n   * @param {Object}  [config.keyphraseLength]\n   * @param {Object}  [config.metaDescriptionKeyword]\n   * @param {Object}  [config.metaDescriptionLength]\n   * @param {Object}  [config.subheadingsKeyword]\n   * @param {Object}  [config.externalLinks]\n   * @param {Object}  [config.keyphraseDensity]\n   * @param {Object}  [config.media]\n   * @param {Object}  [config.urlLength]\n   * @param {Object}  [config.textLength]\n   * @param {Object}  [config.singleTitle]\n   * @param {Object}  [config.keyphrase]\n   * @param {Object}  [config.internalLinks]\n   * @param {Object}  [config.titleWidth]\n   * @param {Object}  [config.slugKeyword]\n   * @param {Object}  [config.singleH1]\n   * @param {Object}  [config.schema]\n   */\n  constructor(researcher, config = {}) {\n    const seoAssessor = new SEOAssessor(researcher, config);\n    const contentAssessor = new ContentAssessor(researcher, config);\n    this.seoAssessor = seoAssessor;\n    this.contentAssessor = contentAssessor;\n    this.researcher = researcher;\n    this.config = config;\n  }\n\n  assess(paper, i18n) {\n    this.seoAssessor.assess(paper, i18n);\n    this.contentAssessor.assess(paper, i18n);\n\n    let assessments = [...this.seoAssessor.results, ...this.contentAssessor.results];\n    assessments = assessments.map(assessment => ({\n      ...assessment.config,\n      body: assessment.body,\n      status: assessment.status,\n      score: assessment.score,\n      title: assessment.title || assessment.config.title\n    }));\n    this.assessments = assessments;\n  }\n\n  getResult(groupBy = 'category', getScore = true) {\n    let assessments = [];\n    switch (groupBy) {\n      case 'category':\n        assessments = groupAssessmentsByCategory(this.assessments);\n        break;\n      case 'status':\n        assessments = groupAssessmentsByStatus(this.assessments);\n        break;\n    }\n\n    return {\n      assessments,\n      ...(getScore ? {score: this.getScore()} : {})\n    };\n  }\n\n  getScore() {\n    let point = 0;\n\n    this.assessments.forEach(assessment => {\n      point += assessment.score;\n    });\n\n    const maxPoint = getMaxPoint(this.assessments);\n    return Math.round((point * 100) / maxPoint);\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,QAAA,GAAAD,OAAA;AAEA;AACA;AACA;AACe,MAAME,aAAa,CAAC;EACjC;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,MAAM,GAAG,CAAC,CAAC,EAAE;IACnC,MAAMC,WAAW,GAAG,IAAIC,kBAAW,CAACH,UAAU,EAAEC,MAAM,CAAC;IACvD,MAAMG,eAAe,GAAG,IAAIC,sBAAe,CAACL,UAAU,EAAEC,MAAM,CAAC;IAC/D,IAAI,CAACC,WAAW,GAAGA,WAAW;IAC9B,IAAI,CAACE,eAAe,GAAGA,eAAe;IACtC,IAAI,CAACJ,UAAU,GAAGA,UAAU;IAC5B,IAAI,CAACC,MAAM,GAAGA,MAAM;EACtB;EAEAK,MAAMA,CAACC,KAAK,EAAEC,IAAI,EAAE;IAClB,IAAI,CAACN,WAAW,CAACI,MAAM,CAACC,KAAK,EAAEC,IAAI,CAAC;IACpC,IAAI,CAACJ,eAAe,CAACE,MAAM,CAACC,KAAK,EAAEC,IAAI,CAAC;IAExC,IAAIC,WAAW,GAAG,CAAC,GAAG,IAAI,CAACP,WAAW,CAACQ,OAAO,EAAE,GAAG,IAAI,CAACN,eAAe,CAACM,OAAO,CAAC;IAChFD,WAAW,GAAGA,WAAW,CAACE,GAAG,CAACC,UAAU,KAAK;MAC3C,GAAGA,UAAU,CAACX,MAAM;MACpBY,IAAI,EAAED,UAAU,CAACC,IAAI;MACrBC,MAAM,EAAEF,UAAU,CAACE,MAAM;MACzBC,KAAK,EAAEH,UAAU,CAACG,KAAK;MACvBC,KAAK,EAAEJ,UAAU,CAACI,KAAK,IAAIJ,UAAU,CAACX,MAAM,CAACe;IAC/C,CAAC,CAAC,CAAC;IACH,IAAI,CAACP,WAAW,GAAGA,WAAW;EAChC;EAEAQ,SAASA,CAACC,OAAO,GAAG,UAAU,EAAEC,QAAQ,GAAG,IAAI,EAAE;IAC/C,IAAIV,WAAW,GAAG,EAAE;IACpB,QAAQS,OAAO;MACb,KAAK,UAAU;QACbT,WAAW,GAAG,IAAAW,mCAA0B,EAAC,IAAI,CAACX,WAAW,CAAC;QAC1D;MACF,KAAK,QAAQ;QACXA,WAAW,GAAG,IAAAY,iCAAwB,EAAC,IAAI,CAACZ,WAAW,CAAC;QACxD;IACJ;IAEA,OAAO;MACLA,WAAW;MACX,IAAIU,QAAQ,GAAG;QAACJ,KAAK,EAAE,IAAI,CAACI,QAAQ,CAAC;MAAC,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;EACH;EAEAA,QAAQA,CAAA,EAAG;IACT,IAAIG,KAAK,GAAG,CAAC;IAEb,IAAI,CAACb,WAAW,CAACc,OAAO,CAACX,UAAU,IAAI;MACrCU,KAAK,IAAIV,UAAU,CAACG,KAAK;IAC3B,CAAC,CAAC;IAEF,MAAMS,QAAQ,GAAG,IAAAC,oBAAW,EAAC,IAAI,CAAChB,WAAW,CAAC;IAC9C,OAAOiB,IAAI,CAACC,KAAK,CAAEL,KAAK,GAAG,GAAG,GAAIE,QAAQ,CAAC;EAC7C;AACF;AAACI,OAAA,CAAAC,OAAA,GAAA/B,aAAA","ignoreList":[]}

package/build/scoring/assessors/contentAssessor.js

@@ -0,0 +1,150 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _lodash = require("lodash");
+var _assessor = _interopRequireDefault(require("./assessor.js"));
+var _ParagraphTooLongAssessment = _interopRequireDefault(require("../assessments/readability/ParagraphTooLongAssessment.js"));
+var _SentenceLengthInTextAssessment = _interopRequireDefault(require("../assessments/readability/SentenceLengthInTextAssessment.js"));
+var _SentenceBeginningsAssessment = _interopRequireDefault(require("../assessments/readability/SentenceBeginningsAssessment.js"));
+var _TransitionWordsAssessment = _interopRequireDefault(require("../assessments/readability/TransitionWordsAssessment.js"));
+var _scoreToRating = _interopRequireDefault(require("../interpreters/scoreToRating.js"));
+var _RelatedKeywordsAssessment = _interopRequireDefault(require("../assessments/readability/RelatedKeywordsAssessment"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * The ContentAssessor class is used for the readability analysis.
+ */
+class ContentAssessor extends _assessor.default {
+  /**
+   * Creates a new ContentAssessor instance.
+   * @param {Researcher}	researcher	The researcher to use.
+   * @param {Object}		[config]	The assessor config.
+   */
+  constructor(researcher, config) {
+    super(researcher, config);
+    this.type = 'contentAssessor';
+    this._assessments = [new _ParagraphTooLongAssessment.default(config?.textParagraphTooLong), new _SentenceLengthInTextAssessment.default(config?.textSentenceLength), new _TransitionWordsAssessment.default(config?.textTransitionWords), new _SentenceBeginningsAssessment.default(config?.sentenceBeginnings), new _RelatedKeywordsAssessment.default(config?.relatedKeywords)];
+  }
+
+  /**
+   * Calculates the weighted rating for languages that have all assessments based on a given rating.
+   *
+   * @param {string} rating The rating to be weighted.
+   * @returns {number} The weighted rating.
+   */
+  calculatePenaltyPointsFullSupport(rating) {
+    switch (rating) {
+      case 'bad':
+        return 3;
+      case 'ok':
+        return 2;
+      default:
+      case 'good':
+        return 0;
+    }
+  }
+
+  /**
+   * Calculates the weighted rating for languages that don't have all assessments based on a given rating.
+   *
+   * @param {string} rating The rating to be weighted.
+   * @returns {number} The weighted rating.
+   */
+  calculatePenaltyPointsPartialSupport(rating) {
+    switch (rating) {
+      case 'bad':
+        return 4;
+      case 'ok':
+        return 2;
+      default:
+      case 'good':
+        return 0;
+    }
+  }
+
+  /**
+   * Determines whether a language is fully supported. If a language supports 7 content assessments,
+   * it is fully supported
+   *
+   * @returns {boolean} True if fully supported.
+   */
+  _allAssessmentsSupported() {
+    const numberOfAssessments = this._assessments.length;
+    const applicableAssessments = this.getApplicableAssessments();
+    return applicableAssessments.length === numberOfAssessments;
+  }
+
+  /**
+   * Calculates the penalty points based on the assessment results.
+   *
+   * @returns {number} The total penalty points for the results.
+   */
+  calculatePenaltyPoints() {
+    const results = this.getValidResults();
+    const penaltyPoints = (0, _lodash.map)(results, function (result) {
+      const rating = (0, _scoreToRating.default)(result.getScore());
+      if (this._allAssessmentsSupported()) {
+        return this.calculatePenaltyPointsFullSupport(rating);
+      }
+      return this.calculatePenaltyPointsPartialSupport(rating);
+    }.bind(this));
+    return (0, _lodash.sum)(penaltyPoints);
+  }
+
+  /**
+   * Rates the penalty points
+   *
+   * @param {number} totalPenaltyPoints The amount of penalty points.
+   * @returns {number} The score based on the amount of penalty points.
+   *
+   * @private
+   */
+  _ratePenaltyPoints(totalPenaltyPoints) {
+    if (this.getValidResults().length === 1) {
+      // If we have only 1 result, we only have a "no content" result
+      return 30;
+    }
+    if (this._allAssessmentsSupported()) {
+      // Determine the total score based on the total penalty points.
+      if (totalPenaltyPoints > 6) {
+        // A red indicator.
+        return 30;
+      }
+      if (totalPenaltyPoints > 4) {
+        // An orange indicator.
+        return 60;
+      }
+    } else {
+      if (totalPenaltyPoints > 4) {
+        // A red indicator.
+        return 30;
+      }
+      if (totalPenaltyPoints > 2) {
+        // An orange indicator.
+        return 60;
+      }
+    }
+    // A green indicator.
+    return 90;
+  }
+
+  /**
+   * Calculates the overall score based on the assessment results.
+   *
+   * @returns {number} The overall score.
+   */
+  calculateOverallScore() {
+    const results = this.getValidResults();
+
+    // If you have no content, you have a red indicator.
+    if (results.length === 0) {
+      return 30;
+    }
+    const totalPenaltyPoints = this.calculatePenaltyPoints();
+    return this._ratePenaltyPoints(totalPenaltyPoints);
+  }
+}
+exports.default = ContentAssessor;
+//# sourceMappingURL=contentAssessor.js.map

package/build/scoring/assessors/contentAssessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentAssessor.js","names":["_lodash","require","_assessor","_interopRequireDefault","_ParagraphTooLongAssessment","_SentenceLengthInTextAssessment","_SentenceBeginningsAssessment","_TransitionWordsAssessment","_scoreToRating","_RelatedKeywordsAssessment","e","__esModule","default","ContentAssessor","Assessor","constructor","researcher","config","type","_assessments","ParagraphTooLong","textParagraphTooLong","SentenceLengthInText","textSentenceLength","TransitionWords","textTransitionWords","SentenceBeginnings","sentenceBeginnings","RelatedKeywordsAssessment","relatedKeywords","calculatePenaltyPointsFullSupport","rating","calculatePenaltyPointsPartialSupport","_allAssessmentsSupported","numberOfAssessments","length","applicableAssessments","getApplicableAssessments","calculatePenaltyPoints","results","getValidResults","penaltyPoints","map","result","scoreToRating","getScore","bind","sum","_ratePenaltyPoints","totalPenaltyPoints","calculateOverallScore","exports"],"sources":["../../../src/scoring/assessors/contentAssessor.js"],"sourcesContent":["import {map, sum} from 'lodash';\nimport Assessor from './assessor.js';\nimport ParagraphTooLong from '../assessments/readability/ParagraphTooLongAssessment.js';\nimport SentenceLengthInText from '../assessments/readability/SentenceLengthInTextAssessment.js';\nimport SentenceBeginnings from '../assessments/readability/SentenceBeginningsAssessment.js';\nimport TransitionWords from '../assessments/readability/TransitionWordsAssessment.js';\nimport scoreToRating from '../interpreters/scoreToRating.js';\nimport RelatedKeywordsAssessment from '../assessments/readability/RelatedKeywordsAssessment';\n\n/**\n * The ContentAssessor class is used for the readability analysis.\n */\nexport default class ContentAssessor extends Assessor {\n  /**\n   * Creates a new ContentAssessor instance.\n   * @param {Researcher}\tresearcher\tThe researcher to use.\n   * @param {Object}\t\t[config]\tThe assessor config.\n   */\n  constructor(researcher, config) {\n    super(researcher, config);\n    this.type = 'contentAssessor';\n\n    this._assessments = [\n      new ParagraphTooLong(config?.textParagraphTooLong),\n      new SentenceLengthInText(config?.textSentenceLength),\n      new TransitionWords(config?.textTransitionWords),\n      new SentenceBeginnings(config?.sentenceBeginnings),\n      new RelatedKeywordsAssessment(config?.relatedKeywords)\n    ];\n  }\n\n  /**\n   * Calculates the weighted rating for languages that have all assessments based on a given rating.\n   *\n   * @param {string} rating The rating to be weighted.\n   * @returns {number} The weighted rating.\n   */\n  calculatePenaltyPointsFullSupport(rating) {\n    switch (rating) {\n      case 'bad':\n        return 3;\n      case 'ok':\n        return 2;\n      default:\n      case 'good':\n        return 0;\n    }\n  }\n\n  /**\n   * Calculates the weighted rating for languages that don't have all assessments based on a given rating.\n   *\n   * @param {string} rating The rating to be weighted.\n   * @returns {number} The weighted rating.\n   */\n  calculatePenaltyPointsPartialSupport(rating) {\n    switch (rating) {\n      case 'bad':\n        return 4;\n      case 'ok':\n        return 2;\n      default:\n      case 'good':\n        return 0;\n    }\n  }\n\n  /**\n   * Determines whether a language is fully supported. If a language supports 7 content assessments,\n   * it is fully supported\n   *\n   * @returns {boolean} True if fully supported.\n   */\n  _allAssessmentsSupported() {\n    const numberOfAssessments = this._assessments.length;\n    const applicableAssessments = this.getApplicableAssessments();\n    return applicableAssessments.length === numberOfAssessments;\n  }\n\n  /**\n   * Calculates the penalty points based on the assessment results.\n   *\n   * @returns {number} The total penalty points for the results.\n   */\n  calculatePenaltyPoints() {\n    const results = this.getValidResults();\n\n    const penaltyPoints = map(\n      results,\n      function(result) {\n        const rating = scoreToRating(result.getScore());\n\n        if (this._allAssessmentsSupported()) {\n          return this.calculatePenaltyPointsFullSupport(rating);\n        }\n\n        return this.calculatePenaltyPointsPartialSupport(rating);\n      }.bind(this)\n    );\n\n    return sum(penaltyPoints);\n  }\n\n  /**\n   * Rates the penalty points\n   *\n   * @param {number} totalPenaltyPoints The amount of penalty points.\n   * @returns {number} The score based on the amount of penalty points.\n   *\n   * @private\n   */\n  _ratePenaltyPoints(totalPenaltyPoints) {\n    if (this.getValidResults().length === 1) {\n      // If we have only 1 result, we only have a \"no content\" result\n      return 30;\n    }\n\n    if (this._allAssessmentsSupported()) {\n      // Determine the total score based on the total penalty points.\n      if (totalPenaltyPoints > 6) {\n        // A red indicator.\n        return 30;\n      }\n\n      if (totalPenaltyPoints > 4) {\n        // An orange indicator.\n        return 60;\n      }\n    } else {\n      if (totalPenaltyPoints > 4) {\n        // A red indicator.\n        return 30;\n      }\n\n      if (totalPenaltyPoints > 2) {\n        // An orange indicator.\n        return 60;\n      }\n    }\n    // A green indicator.\n    return 90;\n  }\n\n  /**\n   * Calculates the overall score based on the assessment results.\n   *\n   * @returns {number} The overall score.\n   */\n  calculateOverallScore() {\n    const results = this.getValidResults();\n\n    // If you have no content, you have a red indicator.\n    if (results.length === 0) {\n      return 30;\n    }\n\n    const totalPenaltyPoints = this.calculatePenaltyPoints();\n\n    return this._ratePenaltyPoints(totalPenaltyPoints);\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,SAAA,GAAAC,sBAAA,CAAAF,OAAA;AACA,IAAAG,2BAAA,GAAAD,sBAAA,CAAAF,OAAA;AACA,IAAAI,+BAAA,GAAAF,sBAAA,CAAAF,OAAA;AACA,IAAAK,6BAAA,GAAAH,sBAAA,CAAAF,OAAA;AACA,IAAAM,0BAAA,GAAAJ,sBAAA,CAAAF,OAAA;AACA,IAAAO,cAAA,GAAAL,sBAAA,CAAAF,OAAA;AACA,IAAAQ,0BAAA,GAAAN,sBAAA,CAAAF,OAAA;AAA6F,SAAAE,uBAAAO,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE7F;AACA;AACA;AACe,MAAMG,eAAe,SAASC,iBAAQ,CAAC;EACpD;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,MAAM,EAAE;IAC9B,KAAK,CAACD,UAAU,EAAEC,MAAM,CAAC;IACzB,IAAI,CAACC,IAAI,GAAG,iBAAiB;IAE7B,IAAI,CAACC,YAAY,GAAG,CAClB,IAAIC,mCAAgB,CAACH,MAAM,EAAEI,oBAAoB,CAAC,EAClD,IAAIC,uCAAoB,CAACL,MAAM,EAAEM,kBAAkB,CAAC,EACpD,IAAIC,kCAAe,CAACP,MAAM,EAAEQ,mBAAmB,CAAC,EAChD,IAAIC,qCAAkB,CAACT,MAAM,EAAEU,kBAAkB,CAAC,EAClD,IAAIC,kCAAyB,CAACX,MAAM,EAAEY,eAAe,CAAC,CACvD;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,iCAAiCA,CAACC,MAAM,EAAE;IACxC,QAAQA,MAAM;MACZ,KAAK,KAAK;QACR,OAAO,CAAC;MACV,KAAK,IAAI;QACP,OAAO,CAAC;MACV;MACA,KAAK,MAAM;QACT,OAAO,CAAC;IACZ;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEC,oCAAoCA,CAACD,MAAM,EAAE;IAC3C,QAAQA,MAAM;MACZ,KAAK,KAAK;QACR,OAAO,CAAC;MACV,KAAK,IAAI;QACP,OAAO,CAAC;MACV;MACA,KAAK,MAAM;QACT,OAAO,CAAC;IACZ;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACEE,wBAAwBA,CAAA,EAAG;IACzB,MAAMC,mBAAmB,GAAG,IAAI,CAACf,YAAY,CAACgB,MAAM;IACpD,MAAMC,qBAAqB,GAAG,IAAI,CAACC,wBAAwB,CAAC,CAAC;IAC7D,OAAOD,qBAAqB,CAACD,MAAM,KAAKD,mBAAmB;EAC7D;;EAEA;AACF;AACA;AACA;AACA;EACEI,sBAAsBA,CAAA,EAAG;IACvB,MAAMC,OAAO,GAAG,IAAI,CAACC,eAAe,CAAC,CAAC;IAEtC,MAAMC,aAAa,GAAG,IAAAC,WAAG,EACvBH,OAAO,EACP,UAASI,MAAM,EAAE;MACf,MAAMZ,MAAM,GAAG,IAAAa,sBAAa,EAACD,MAAM,CAACE,QAAQ,CAAC,CAAC,CAAC;MAE/C,IAAI,IAAI,CAACZ,wBAAwB,CAAC,CAAC,EAAE;QACnC,OAAO,IAAI,CAACH,iCAAiC,CAACC,MAAM,CAAC;MACvD;MAEA,OAAO,IAAI,CAACC,oCAAoC,CAACD,MAAM,CAAC;IAC1D,CAAC,CAACe,IAAI,CAAC,IAAI,CACb,CAAC;IAED,OAAO,IAAAC,WAAG,EAACN,aAAa,CAAC;EAC3B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACEO,kBAAkBA,CAACC,kBAAkB,EAAE;IACrC,IAAI,IAAI,CAACT,eAAe,CAAC,CAAC,CAACL,MAAM,KAAK,CAAC,EAAE;MACvC;MACA,OAAO,EAAE;IACX;IAEA,IAAI,IAAI,CAACF,wBAAwB,CAAC,CAAC,EAAE;MACnC;MACA,IAAIgB,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;MAEA,IAAIA,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;IACF,CAAC,MAAM;MACL,IAAIA,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;MAEA,IAAIA,kBAAkB,GAAG,CAAC,EAAE;QAC1B;QACA,OAAO,EAAE;MACX;IACF;IACA;IACA,OAAO,EAAE;EACX;;EAEA;AACF;AACA;AACA;AACA;EACEC,qBAAqBA,CAAA,EAAG;IACtB,MAAMX,OAAO,GAAG,IAAI,CAACC,eAAe,CAAC,CAAC;;IAEtC;IACA,IAAID,OAAO,CAACJ,MAAM,KAAK,CAAC,EAAE;MACxB,OAAO,EAAE;IACX;IAEA,MAAMc,kBAAkB,GAAG,IAAI,CAACX,sBAAsB,CAAC,CAAC;IAExD,OAAO,IAAI,CAACU,kBAAkB,CAACC,kBAAkB,CAAC;EACpD;AACF;AAACE,OAAA,CAAAvC,OAAA,GAAAC,eAAA","ignoreList":[]}

package/build/scoring/assessors/index.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "Assessor", {
+  enumerable: true,
+  get: function () {
+    return _assessor.default;
+  }
+});
+Object.defineProperty(exports, "AvadaAssessor", {
+  enumerable: true,
+  get: function () {
+    return _avadaAssessor.default;
+  }
+});
+Object.defineProperty(exports, "ContentAssessor", {
+  enumerable: true,
+  get: function () {
+    return _contentAssessor.default;
+  }
+});
+Object.defineProperty(exports, "SEOAssessor", {
+  enumerable: true,
+  get: function () {
+    return _seoAssessor.default;
+  }
+});
+var _assessor = _interopRequireDefault(require("./assessor.js"));
+var _contentAssessor = _interopRequireDefault(require("./contentAssessor.js"));
+var _seoAssessor = _interopRequireDefault(require("./seoAssessor.js"));
+var _avadaAssessor = _interopRequireDefault(require("./avadaAssessor.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+//# sourceMappingURL=index.js.map

package/build/scoring/assessors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_assessor","_interopRequireDefault","require","_contentAssessor","_seoAssessor","_avadaAssessor","e","__esModule","default"],"sources":["../../../src/scoring/assessors/index.js"],"sourcesContent":["export {default as Assessor} from './assessor.js';\nexport {default as ContentAssessor} from './contentAssessor.js';\nexport {default as SEOAssessor} from './seoAssessor.js';\nexport {default as AvadaAssessor} from './avadaAssessor.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAAA,SAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,gBAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,YAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,cAAA,GAAAJ,sBAAA,CAAAC,OAAA;AAA4D,SAAAD,uBAAAK,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA","ignoreList":[]}

package/build/scoring/assessors/seoAssessor.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _assessor = _interopRequireDefault(require("./assessor"));
+var _IntroductionKeywordAssessment = _interopRequireDefault(require("../assessments/seo/IntroductionKeywordAssessment"));
+var _KeyphraseLengthAssessment = _interopRequireDefault(require("../assessments/seo/KeyphraseLengthAssessment"));
+var _MetaDescriptionKeywordAssessment = _interopRequireDefault(require("../assessments/seo/MetaDescriptionKeywordAssessment"));
+var _MetaDescriptionLengthAssessment = _interopRequireDefault(require("../assessments/seo/MetaDescriptionLengthAssessment"));
+var _SubHeadingsKeywordAssessment = _interopRequireDefault(require("../assessments/seo/SubHeadingsKeywordAssessment"));
+var _OutboundLinksAssessment = _interopRequireDefault(require("../assessments/seo/OutboundLinksAssessment"));
+var _KeywordDensityAssessment = _interopRequireDefault(require("../assessments/seo/KeywordDensityAssessment"));
+var _InternalLinksAssessment = _interopRequireDefault(require("../assessments/seo/InternalLinksAssessment"));
+var _UrlKeywordAssessment = _interopRequireDefault(require("../assessments/seo/UrlKeywordAssessment"));
+var _ImageCountAssessment = _interopRequireDefault(require("../assessments/seo/ImageCountAssessment"));
+var _TextLengthAssessment = _interopRequireDefault(require("../assessments/seo/TextLengthAssessment"));
+var _PageTitleWidthAssessment = _interopRequireDefault(require("../assessments/seo/PageTitleWidthAssessment"));
+var _SingleH1Assessment = _interopRequireDefault(require("../assessments/seo/SingleH1Assessment"));
+var _KeyphraseAssessment = _interopRequireDefault(require("../assessments/seo/KeyphraseAssessment"));
+var _SingleTitleAssessment = _interopRequireDefault(require("../assessments/seo/SingleTitleAssessment"));
+var _UrlLengthAssessment = _interopRequireDefault(require("../assessments/seo/UrlLengthAssessment"));
+var _NumberInMetaTitleAssessment = _interopRequireDefault(require("../assessments/seo/NumberInMetaTitleAssessment"));
+var _TextImagesAssessment = _interopRequireDefault(require("../assessments/seo/TextImagesAssessment"));
+var _MetaTitleKeywordAssessment = _interopRequireDefault(require("../assessments/seo/MetaTitleKeywordAssessment"));
+var _SchemaAssessment = _interopRequireDefault(require("../assessments/seo/SchemaAssessment"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * The SEOAssessor class is used for the general SEO analysis.
+ */
+class SEOAssessor extends _assessor.default {
+  /**
+   * Creates a new SEOAssessor instance.
+   * @param {Researcher}	researcher	The researcher to use.
+   * @param {Object}		[config]	The assessor config.
+   */
+  constructor(researcher, config) {
+    super(researcher, config);
+    this.type = 'SEOAssessor';
+    this._assessments = [new _MetaTitleKeywordAssessment.default(config?.titleKeyword), new _TextImagesAssessment.default(config?.textImages), new _NumberInMetaTitleAssessment.default(config?.numberTitle), new _IntroductionKeywordAssessment.default(config?.introductionKeyword), new _KeyphraseLengthAssessment.default(config?.keyphraseLength), new _MetaDescriptionKeywordAssessment.default(config?.metaDescriptionKeyword), new _MetaDescriptionLengthAssessment.default(config?.metaDescriptionLength), new _SubHeadingsKeywordAssessment.default(config?.subheadingsKeyword), new _OutboundLinksAssessment.default(config?.externalLinks), new _KeywordDensityAssessment.default(config?.keyphraseDensity), new _ImageCountAssessment.default(config?.media), new _UrlLengthAssessment.default(config?.urlLength), new _TextLengthAssessment.default(config?.textLength), new _SingleTitleAssessment.default(config?.singleTitle), new _KeyphraseAssessment.default(config?.keyphrase), new _InternalLinksAssessment.default(config?.internalLinks), new _PageTitleWidthAssessment.default(config?.titleWidth), new _UrlKeywordAssessment.default(config?.slugKeyword), new _SingleH1Assessment.default(config?.singleH1), new _SchemaAssessment.default(config?.schema)];
+  }
+}
+exports.default = SEOAssessor;
+//# sourceMappingURL=seoAssessor.js.map

package/build/scoring/assessors/seoAssessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seoAssessor.js","names":["_assessor","_interopRequireDefault","require","_IntroductionKeywordAssessment","_KeyphraseLengthAssessment","_MetaDescriptionKeywordAssessment","_MetaDescriptionLengthAssessment","_SubHeadingsKeywordAssessment","_OutboundLinksAssessment","_KeywordDensityAssessment","_InternalLinksAssessment","_UrlKeywordAssessment","_ImageCountAssessment","_TextLengthAssessment","_PageTitleWidthAssessment","_SingleH1Assessment","_KeyphraseAssessment","_SingleTitleAssessment","_UrlLengthAssessment","_NumberInMetaTitleAssessment","_TextImagesAssessment","_MetaTitleKeywordAssessment","_SchemaAssessment","e","__esModule","default","SEOAssessor","Assessor","constructor","researcher","config","type","_assessments","MetaTitleKeywordAssessment","titleKeyword","TextImagesAssessment","textImages","NumberInMetaTitleAssessment","numberTitle","IntroductionKeywordAssessment","introductionKeyword","KeyphraseLengthAssessment","keyphraseLength","MetaDescriptionKeywordAssessment","metaDescriptionKeyword","MetaDescriptionLength","metaDescriptionLength","SubheadingsKeyword","subheadingsKeyword","OutboundLinks","externalLinks","KeyphraseDensityAssessment","keyphraseDensity","ImageCount","media","UrlLengthAssessment","urlLength","TextLength","textLength","SingleTitleAssessment","singleTitle","KeyphraseAssessment","keyphrase","InternalLinksAssessment","internalLinks","TitleWidth","titleWidth","SlugKeywordAssessment","slugKeyword","SingleH1Assessment","singleH1","SchemaAssessment","schema","exports"],"sources":["../../../src/scoring/assessors/seoAssessor.js"],"sourcesContent":["import Assessor from './assessor';\nimport IntroductionKeywordAssessment from '../assessments/seo/IntroductionKeywordAssessment';\nimport KeyphraseLengthAssessment from '../assessments/seo/KeyphraseLengthAssessment';\nimport MetaDescriptionKeywordAssessment from '../assessments/seo/MetaDescriptionKeywordAssessment';\nimport MetaDescriptionLength from '../assessments/seo/MetaDescriptionLengthAssessment';\nimport SubheadingsKeyword from '../assessments/seo/SubHeadingsKeywordAssessment';\nimport OutboundLinks from '../assessments/seo/OutboundLinksAssessment';\nimport KeyphraseDensityAssessment from '../assessments/seo/KeywordDensityAssessment';\nimport InternalLinksAssessment from '../assessments/seo/InternalLinksAssessment';\nimport SlugKeywordAssessment from '../assessments/seo/UrlKeywordAssessment';\nimport ImageCount from '../assessments/seo/ImageCountAssessment';\nimport TextLength from '../assessments/seo/TextLengthAssessment';\nimport TitleWidth from '../assessments/seo/PageTitleWidthAssessment';\nimport SingleH1Assessment from '../assessments/seo/SingleH1Assessment';\nimport KeyphraseAssessment from '../assessments/seo/KeyphraseAssessment';\nimport SingleTitleAssessment from '../assessments/seo/SingleTitleAssessment';\nimport UrlLengthAssessment from '../assessments/seo/UrlLengthAssessment';\nimport NumberInMetaTitleAssessment from '../assessments/seo/NumberInMetaTitleAssessment';\nimport TextImagesAssessment from '../assessments/seo/TextImagesAssessment';\nimport MetaTitleKeywordAssessment from '../assessments/seo/MetaTitleKeywordAssessment';\nimport SchemaAssessment from '@axyseo/scoring/assessments/seo/SchemaAssessment';\n\n/**\n * The SEOAssessor class is used for the general SEO analysis.\n */\nexport default class SEOAssessor extends Assessor {\n  /**\n   * Creates a new SEOAssessor instance.\n   * @param {Researcher}\tresearcher\tThe researcher to use.\n   * @param {Object}\t\t[config]\tThe assessor config.\n   */\n  constructor(researcher, config) {\n    super(researcher, config);\n    this.type = 'SEOAssessor';\n\n    this._assessments = [\n      new MetaTitleKeywordAssessment(config?.titleKeyword),\n      new TextImagesAssessment(config?.textImages),\n      new NumberInMetaTitleAssessment(config?.numberTitle),\n      new IntroductionKeywordAssessment(config?.introductionKeyword),\n      new KeyphraseLengthAssessment(config?.keyphraseLength),\n      new MetaDescriptionKeywordAssessment(config?.metaDescriptionKeyword),\n      new MetaDescriptionLength(config?.metaDescriptionLength),\n      new SubheadingsKeyword(config?.subheadingsKeyword),\n      new OutboundLinks(config?.externalLinks),\n      new KeyphraseDensityAssessment(config?.keyphraseDensity),\n      new ImageCount(config?.media),\n      new UrlLengthAssessment(config?.urlLength),\n      new TextLength(config?.textLength),\n      new SingleTitleAssessment(config?.singleTitle),\n      new KeyphraseAssessment(config?.keyphrase),\n      new InternalLinksAssessment(config?.internalLinks),\n      new TitleWidth(config?.titleWidth),\n      new SlugKeywordAssessment(config?.slugKeyword),\n      new SingleH1Assessment(config?.singleH1),\n      new SchemaAssessment(config?.schema)\n    ];\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,SAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,8BAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,0BAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,iCAAA,GAAAJ,sBAAA,CAAAC,OAAA;AACA,IAAAI,gCAAA,GAAAL,sBAAA,CAAAC,OAAA;AACA,IAAAK,6BAAA,GAAAN,sBAAA,CAAAC,OAAA;AACA,IAAAM,wBAAA,GAAAP,sBAAA,CAAAC,OAAA;AACA,IAAAO,yBAAA,GAAAR,sBAAA,CAAAC,OAAA;AACA,IAAAQ,wBAAA,GAAAT,sBAAA,CAAAC,OAAA;AACA,IAAAS,qBAAA,GAAAV,sBAAA,CAAAC,OAAA;AACA,IAAAU,qBAAA,GAAAX,sBAAA,CAAAC,OAAA;AACA,IAAAW,qBAAA,GAAAZ,sBAAA,CAAAC,OAAA;AACA,IAAAY,yBAAA,GAAAb,sBAAA,CAAAC,OAAA;AACA,IAAAa,mBAAA,GAAAd,sBAAA,CAAAC,OAAA;AACA,IAAAc,oBAAA,GAAAf,sBAAA,CAAAC,OAAA;AACA,IAAAe,sBAAA,GAAAhB,sBAAA,CAAAC,OAAA;AACA,IAAAgB,oBAAA,GAAAjB,sBAAA,CAAAC,OAAA;AACA,IAAAiB,4BAAA,GAAAlB,sBAAA,CAAAC,OAAA;AACA,IAAAkB,qBAAA,GAAAnB,sBAAA,CAAAC,OAAA;AACA,IAAAmB,2BAAA,GAAApB,sBAAA,CAAAC,OAAA;AACA,IAAAoB,iBAAA,GAAArB,sBAAA,CAAAC,OAAA;AAAgF,SAAAD,uBAAAsB,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAEhF;AACA;AACA;AACe,MAAMG,WAAW,SAASC,iBAAQ,CAAC;EAChD;AACF;AACA;AACA;AACA;EACEC,WAAWA,CAACC,UAAU,EAAEC,MAAM,EAAE;IAC9B,KAAK,CAACD,UAAU,EAAEC,MAAM,CAAC;IACzB,IAAI,CAACC,IAAI,GAAG,aAAa;IAEzB,IAAI,CAACC,YAAY,GAAG,CAClB,IAAIC,mCAA0B,CAACH,MAAM,EAAEI,YAAY,CAAC,EACpD,IAAIC,6BAAoB,CAACL,MAAM,EAAEM,UAAU,CAAC,EAC5C,IAAIC,oCAA2B,CAACP,MAAM,EAAEQ,WAAW,CAAC,EACpD,IAAIC,sCAA6B,CAACT,MAAM,EAAEU,mBAAmB,CAAC,EAC9D,IAAIC,kCAAyB,CAACX,MAAM,EAAEY,eAAe,CAAC,EACtD,IAAIC,yCAAgC,CAACb,MAAM,EAAEc,sBAAsB,CAAC,EACpE,IAAIC,wCAAqB,CAACf,MAAM,EAAEgB,qBAAqB,CAAC,EACxD,IAAIC,qCAAkB,CAACjB,MAAM,EAAEkB,kBAAkB,CAAC,EAClD,IAAIC,gCAAa,CAACnB,MAAM,EAAEoB,aAAa,CAAC,EACxC,IAAIC,iCAA0B,CAACrB,MAAM,EAAEsB,gBAAgB,CAAC,EACxD,IAAIC,6BAAU,CAACvB,MAAM,EAAEwB,KAAK,CAAC,EAC7B,IAAIC,4BAAmB,CAACzB,MAAM,EAAE0B,SAAS,CAAC,EAC1C,IAAIC,6BAAU,CAAC3B,MAAM,EAAE4B,UAAU,CAAC,EAClC,IAAIC,8BAAqB,CAAC7B,MAAM,EAAE8B,WAAW,CAAC,EAC9C,IAAIC,4BAAmB,CAAC/B,MAAM,EAAEgC,SAAS,CAAC,EAC1C,IAAIC,gCAAuB,CAACjC,MAAM,EAAEkC,aAAa,CAAC,EAClD,IAAIC,iCAAU,CAACnC,MAAM,EAAEoC,UAAU,CAAC,EAClC,IAAIC,6BAAqB,CAACrC,MAAM,EAAEsC,WAAW,CAAC,EAC9C,IAAIC,2BAAkB,CAACvC,MAAM,EAAEwC,QAAQ,CAAC,EACxC,IAAIC,yBAAgB,CAACzC,MAAM,EAAE0C,MAAM,CAAC,CACrC;EACH;AACF;AAACC,OAAA,CAAAhD,OAAA,GAAAC,WAAA","ignoreList":[]}

package/build/scoring/helpers/assessments/checkForTooLongSentences.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = _default;
+var _lodash = require("lodash");
+/**
+ * Checks for too long sentences.
+ * @param {array} sentences The array with objects containing sentences and their lengths.
+ * @param {number} recommendedValue The recommended maximum length of sentence.
+ * @returns {array} The array with objects containing too long sentences and their lengths.
+ */
+function _default(sentences, recommendedValue) {
+  return (0, _lodash.filter)(sentences, function (sentence) {
+    return sentence.sentenceLength > recommendedValue;
+  });
+}
+//# sourceMappingURL=checkForTooLongSentences.js.map

package/build/scoring/helpers/assessments/checkForTooLongSentences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkForTooLongSentences.js","names":["_lodash","require","_default","sentences","recommendedValue","filter","sentence","sentenceLength"],"sources":["../../../../src/scoring/helpers/assessments/checkForTooLongSentences.js"],"sourcesContent":["import { filter } from \"lodash\";\n\n/**\n * Checks for too long sentences.\n * @param {array} sentences The array with objects containing sentences and their lengths.\n * @param {number} recommendedValue The recommended maximum length of sentence.\n * @returns {array} The array with objects containing too long sentences and their lengths.\n */\nexport default function( sentences, recommendedValue ) {\n\treturn filter( sentences, function( sentence ) {\n\t\treturn sentence.sentenceLength > recommendedValue;\n\t} );\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAEA;AACA;AACA;AACA;AACA;AACA;AACe,SAAAC,SAAUC,SAAS,EAAEC,gBAAgB,EAAG;EACtD,OAAO,IAAAC,cAAM,EAAEF,SAAS,EAAE,UAAUG,QAAQ,EAAG;IAC9C,OAAOA,QAAQ,CAACC,cAAc,GAAGH,gBAAgB;EAClD,CAAE,CAAC;AACJ","ignoreList":[]}

package/build/scoring/helpers/assessments/inRange.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.inRangeEndInclusive = exports.inRange = inRangeEndInclusive;
+exports.inRangeStartEndInclusive = inRangeStartEndInclusive;
+exports.inRangeStartInclusive = inRangeStartInclusive;
+/**
+ * Checks if `n` is between `start` and `end` but not including `start`.
+ *
+ * @param {number} number The number to check.
+ * @param {number} start The start of the range.
+ * @param {number} end The end of the range.
+ * @returns {boolean} Returns `true` if `number` is in the range, else `false`.
+ */
+function inRangeEndInclusive(number, start, end) {
+  return number > start && number <= end;
+}
+
+/**
+ * Checks if `n` is between `start` and up to, but not including, `end`.
+ *
+ * @param {number} number The number to check.
+ * @param {number} start The start of the range.
+ * @param {number} end The end of the range.
+ * @returns {boolean} Returns `true` if `number` is in the range, else `false`.
+ */
+function inRangeStartInclusive(number, start, end) {
+  return number >= start && number < end;
+}
+
+/**
+ * Checks if `n` is between `start` and `end`, including both.
+ *
+ * @param {number} number The number to check.
+ * @param {number} start The start of the range.
+ * @param {number} end The end of the range.
+ * @returns {boolean} Returns `true` if `number` is in the range, else `false`.
+ */
+function inRangeStartEndInclusive(number, start, end) {
+  return number >= start && number <= end;
+}
+var _default = exports.default = {
+  inRange: inRangeEndInclusive,
+  inRangeStartInclusive: inRangeStartInclusive,
+  inRangeEndInclusive: inRangeEndInclusive,
+  inRangeStartEndInclusive: inRangeStartEndInclusive
+};
+//# sourceMappingURL=inRange.js.map

package/build/scoring/helpers/assessments/inRange.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inRange.js","names":["inRangeEndInclusive","number","start","end","inRangeStartInclusive","inRangeStartEndInclusive","_default","exports","default","inRange"],"sources":["../../../../src/scoring/helpers/assessments/inRange.js"],"sourcesContent":["/**\n * Checks if `n` is between `start` and `end` but not including `start`.\n *\n * @param {number} number The number to check.\n * @param {number} start The start of the range.\n * @param {number} end The end of the range.\n * @returns {boolean} Returns `true` if `number` is in the range, else `false`.\n */\nfunction inRangeEndInclusive( number, start, end ) {\n\treturn number > start && number <= end;\n}\n\n/**\n * Checks if `n` is between `start` and up to, but not including, `end`.\n *\n * @param {number} number The number to check.\n * @param {number} start The start of the range.\n * @param {number} end The end of the range.\n * @returns {boolean} Returns `true` if `number` is in the range, else `false`.\n */\nfunction inRangeStartInclusive( number, start, end ) {\n\treturn number >= start && number < end;\n}\n\n/**\n * Checks if `n` is between `start` and `end`, including both.\n *\n * @param {number} number The number to check.\n * @param {number} start The start of the range.\n * @param {number} end The end of the range.\n * @returns {boolean} Returns `true` if `number` is in the range, else `false`.\n */\nfunction inRangeStartEndInclusive( number, start, end ) {\n\treturn number >= start && number <= end;\n}\n\nexport {\n\tinRangeEndInclusive as inRange,\n\tinRangeStartInclusive,\n\tinRangeEndInclusive,\n\tinRangeStartEndInclusive,\n};\n\nexport default {\n\tinRange: inRangeEndInclusive,\n\tinRangeStartInclusive: inRangeStartInclusive,\n\tinRangeEndInclusive: inRangeEndInclusive,\n\tinRangeStartEndInclusive: inRangeStartEndInclusive,\n};\n"],"mappings":";;;;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,mBAAmBA,CAAEC,MAAM,EAAEC,KAAK,EAAEC,GAAG,EAAG;EAClD,OAAOF,MAAM,GAAGC,KAAK,IAAID,MAAM,IAAIE,GAAG;AACvC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASC,qBAAqBA,CAAEH,MAAM,EAAEC,KAAK,EAAEC,GAAG,EAAG;EACpD,OAAOF,MAAM,IAAIC,KAAK,IAAID,MAAM,GAAGE,GAAG;AACvC;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASE,wBAAwBA,CAAEJ,MAAM,EAAEC,KAAK,EAAEC,GAAG,EAAG;EACvD,OAAOF,MAAM,IAAIC,KAAK,IAAID,MAAM,IAAIE,GAAG;AACxC;AAAC,IAAAG,QAAA,GAAAC,OAAA,CAAAC,OAAA,GASc;EACdC,OAAO,EAAET,mBAAmB;EAC5BI,qBAAqB,EAAEA,qBAAqB;EAC5CJ,mBAAmB,EAAEA,mBAAmB;EACxCK,wBAAwB,EAAEA;AAC3B,CAAC","ignoreList":[]}

package/build/scoring/helpers/assessments/keyphraseLengthFactor.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = _default;
+/**
+ * Calculates the keyphrase length weighting factor used to calculate the keyword density and the recommended keyword count.
+ * Keyphrase length gets a base weight of 0.7, plus a specific weight for the keyphrase length (keyphraseLength / 3).
+ *
+ * @param {number} keyphraseLength The length of the keyphrase in words.
+ * @returns {number} The keyphrase length weighting factor.
+ */
+function _default(keyphraseLength) {
+  return 0.7 + keyphraseLength / 3;
+}
+//# sourceMappingURL=keyphraseLengthFactor.js.map

package/build/scoring/helpers/assessments/keyphraseLengthFactor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyphraseLengthFactor.js","names":["_default","keyphraseLength"],"sources":["../../../../src/scoring/helpers/assessments/keyphraseLengthFactor.js"],"sourcesContent":["/**\n * Calculates the keyphrase length weighting factor used to calculate the keyword density and the recommended keyword count.\n * Keyphrase length gets a base weight of 0.7, plus a specific weight for the keyphrase length (keyphraseLength / 3).\n *\n * @param {number} keyphraseLength The length of the keyphrase in words.\n * @returns {number} The keyphrase length weighting factor.\n */\nexport default function( keyphraseLength ) {\n\treturn ( 0.7 + keyphraseLength / 3 );\n}\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAAAA,SAAUC,eAAe,EAAG;EAC1C,OAAS,GAAG,GAAGA,eAAe,GAAG,CAAC;AACnC","ignoreList":[]}

package/build/scoring/helpers/assessments/recommendedKeywordCount.js

@@ -0,0 +1,47 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = _default;
+var _getAllWordsFromTree = _interopRequireDefault(require("../../../languageProcessing/helpers/word/getAllWordsFromTree"));
+var _keyphraseLengthFactor = _interopRequireDefault(require("./keyphraseLengthFactor.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/**
+ * Calculates a recommended keyphrase count for a paper's text. The formula to calculate this number is based on the
+ * keyphrase density formula.
+ *
+ * @param {Paper}	paper						The paper to analyze.
+ * @param {number}	keyphraseLength				The length of the focus keyphrase in words.
+ * @param {number}	recommendedKeyphraseDensity	The recommended keyphrase density (either maximum or minimum).
+ * @param {string}	maxOrMin					Whether it's a maximum or minimum recommended keyphrase density.
+ * @param {function} customGetWords				A helper to get words from the text for languages that don't use the default approach.
+ *
+ * @returns {number} The recommended keyphrase count.
+ */
+function _default(paper, keyphraseLength, recommendedKeyphraseDensity, maxOrMin, customGetWords) {
+  const wordCount = customGetWords ? customGetWords(paper.getText()).length : (0, _getAllWordsFromTree.default)(paper).length;
+  if (wordCount === 0) {
+    return 0;
+  }
+  const lengthKeyphraseFactor = (0, _keyphraseLengthFactor.default)(keyphraseLength);
+  const recommendedKeyphraseCount = recommendedKeyphraseDensity * wordCount / (100 * lengthKeyphraseFactor);
+
+  /*
+   * The recommended keyphrase count should always be at least 2,
+   * regardless of the keyphrase density, the word count, or the keyphrase length.
+   */
+  if (recommendedKeyphraseCount < 2) {
+    return 2;
+  }
+  switch (maxOrMin) {
+    case "min":
+      // Round up for the recommended minimum count.
+      return Math.ceil(recommendedKeyphraseCount);
+    default:
+    case "max":
+      // Round down for the recommended maximum count.
+      return Math.floor(recommendedKeyphraseCount);
+  }
+}
+//# sourceMappingURL=recommendedKeywordCount.js.map

package/build/scoring/helpers/assessments/recommendedKeywordCount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendedKeywordCount.js","names":["_getAllWordsFromTree","_interopRequireDefault","require","_keyphraseLengthFactor","e","__esModule","default","_default","paper","keyphraseLength","recommendedKeyphraseDensity","maxOrMin","customGetWords","wordCount","getText","length","getAllWordsFromTree","lengthKeyphraseFactor","keyphraseLengthFactor","recommendedKeyphraseCount","Math","ceil","floor"],"sources":["../../../../src/scoring/helpers/assessments/recommendedKeywordCount.js"],"sourcesContent":["import getAllWordsFromTree from \"@axyseo/languageProcessing/helpers/word/getAllWordsFromTree\";\nimport keyphraseLengthFactor from \"./keyphraseLengthFactor.js\";\n\n/**\n * Calculates a recommended keyphrase count for a paper's text. The formula to calculate this number is based on the\n * keyphrase density formula.\n *\n * @param {Paper}\tpaper\t\t\t\t\t\tThe paper to analyze.\n * @param {number}\tkeyphraseLength\t\t\t\tThe length of the focus keyphrase in words.\n * @param {number}\trecommendedKeyphraseDensity\tThe recommended keyphrase density (either maximum or minimum).\n * @param {string}\tmaxOrMin\t\t\t\t\tWhether it's a maximum or minimum recommended keyphrase density.\n * @param {function} customGetWords\t\t\t\tA helper to get words from the text for languages that don't use the default approach.\n *\n * @returns {number} The recommended keyphrase count.\n */\nexport default function( paper, keyphraseLength, recommendedKeyphraseDensity, maxOrMin, customGetWords ) {\n\tconst wordCount = customGetWords ? customGetWords( paper.getText() ).length : getAllWordsFromTree( paper ).length;\n\n\tif ( wordCount === 0 ) {\n\t\treturn 0;\n\t}\n\n\tconst lengthKeyphraseFactor = keyphraseLengthFactor( keyphraseLength );\n\tconst recommendedKeyphraseCount = ( recommendedKeyphraseDensity * wordCount ) / ( 100 * lengthKeyphraseFactor );\n\n\t/*\n\t * The recommended keyphrase count should always be at least 2,\n\t * regardless of the keyphrase density, the word count, or the keyphrase length.\n\t */\n\tif ( recommendedKeyphraseCount < 2 ) {\n\t\treturn 2;\n\t}\n\n\tswitch ( maxOrMin ) {\n\t\tcase \"min\":\n\t\t\t// Round up for the recommended minimum count.\n\t\t\treturn Math.ceil( recommendedKeyphraseCount );\n\t\tdefault:\n\t\tcase \"max\":\n\t\t\t// Round down for the recommended maximum count.\n\t\t\treturn Math.floor( recommendedKeyphraseCount );\n\t}\n}\n"],"mappings":";;;;;;AAAA,IAAAA,oBAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,sBAAA,GAAAF,sBAAA,CAAAC,OAAA;AAA+D,SAAAD,uBAAAG,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE/D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACe,SAAAG,SAAUC,KAAK,EAAEC,eAAe,EAAEC,2BAA2B,EAAEC,QAAQ,EAAEC,cAAc,EAAG;EACxG,MAAMC,SAAS,GAAGD,cAAc,GAAGA,cAAc,CAAEJ,KAAK,CAACM,OAAO,CAAC,CAAE,CAAC,CAACC,MAAM,GAAG,IAAAC,4BAAmB,EAAER,KAAM,CAAC,CAACO,MAAM;EAEjH,IAAKF,SAAS,KAAK,CAAC,EAAG;IACtB,OAAO,CAAC;EACT;EAEA,MAAMI,qBAAqB,GAAG,IAAAC,8BAAqB,EAAET,eAAgB,CAAC;EACtE,MAAMU,yBAAyB,GAAKT,2BAA2B,GAAGG,SAAS,IAAO,GAAG,GAAGI,qBAAqB,CAAE;;EAE/G;AACD;AACA;AACA;EACC,IAAKE,yBAAyB,GAAG,CAAC,EAAG;IACpC,OAAO,CAAC;EACT;EAEA,QAASR,QAAQ;IAChB,KAAK,KAAK;MACT;MACA,OAAOS,IAAI,CAACC,IAAI,CAAEF,yBAA0B,CAAC;IAC9C;IACA,KAAK,KAAK;MACT;MACA,OAAOC,IAAI,CAACE,KAAK,CAAEH,yBAA0B,CAAC;EAChD;AACD","ignoreList":[]}