yoastseo/build/languageProcessing/helpers/word/indices.js

Yoast client-side content analysis

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.filterIndices = exports.default = void 0;
exports.getIndicesByWord = getIndicesByWord;
exports.sortIndices = exports.getIndicesByWordListSorted = exports.getIndicesByWordList = void 0;
var _lodash = require("lodash");
var _stripSpaces = _interopRequireDefault(require("../sanitize/stripSpaces.js"));
var _matchWordInSentence = require("./matchWordInSentence.js");
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
/**
 * Returns the indices of a string in a text. If it is found multiple times, it will return multiple indices.
 *
 * @param {string} word The word to find in the text.
 * @param {string} text The text to check for the given word.
 *
 * @returns {Array} All indices found.
 */
function getIndicesByWord(word, text) {
  let startIndex = 0;
  const searchStringLength = word.length;
  let index;
  const indices = [];
  while ((index = text.indexOf(word, startIndex)) > -1) {
    // Check if the previous and next character are word boundaries to determine if a complete word was detected
    const isPreviousCharacterWordBoundary = (0, _matchWordInSentence.characterInBoundary)(text[index - 1]) || index === 0;
    const isNextCharacterWordBoundary = (0, _matchWordInSentence.characterInBoundary)(text[index + searchStringLength]) || text.length === index + searchStringLength;
    if (isPreviousCharacterWordBoundary && isNextCharacterWordBoundary) {
      indices.push({
        index: index,
        match: word
      });
    }
    startIndex = index + searchStringLength;
  }
  return indices;
}

/**
 * Matches string with an array, returns the word and the index it was found on.
 *
 * @param {Array} words The array with strings to match.
 * @param {string} text The text to match the strings from the array to.
 *
 * @returns {Array} The array with words, containing the index of the match and the matched string.
 * Returns an empty array if none are found.
 */
const getIndicesByWordList = function (words, text) {
  let matchedWords = [];
  (0, _lodash.forEach)(words, function (word) {
    word = (0, _stripSpaces.default)(word);
    if (!(0, _matchWordInSentence.isWordInSentence)(word, text)) {
      return;
    }
    matchedWords = matchedWords.concat(getIndicesByWord(word, text));
  });
  return matchedWords;
};

/**
 * Sorts the array on the index property of each entry.
 *
 * @param {Array} indices The array with indices.
 *
 * @returns {Array} The sorted array with indices.
 */
exports.getIndicesByWordList = getIndicesByWordList;
const sortIndices = function (indices) {
  return indices.sort(function (a, b) {
    return a.index - b.index;
  });
};

/**
 * Filters duplicate entries if the indices overlap.
 *
 * @param {Array} indices The array with indices to be filtered.
 *
 * @returns {Array} The filtered array.
 */
exports.sortIndices = sortIndices;
const filterIndices = function (indices) {
  indices = sortIndices(indices);
  const filtered = [];
  for (let i = 0; i < indices.length; i++) {
    // If the next index is within the range of the current index and the length of the word, remove it
    // This makes sure we don't match combinations twice, like "even though" and "though".
    if (!(0, _lodash.isUndefined)(indices[i + 1]) && indices[i + 1].index < indices[i].index + indices[i].match.length) {
      filtered.push(indices[i]);

      // Adds 1 to i, so we skip the next index that is overlapping with the current index.
      i++;
      continue;
    }
    filtered.push(indices[i]);
  }
  return filtered;
};

/**
 * Matches string with an array, returns the word and the index it was found on, and sorts the match instances based on
 * the index property of the match.
 *
 * @param {Array} words The array with strings to match.
 * @param {string} text The text to match the strings from the array to.
 *
 * @returns {Array} The array with words, containing the index of the match and the matched string.
 * Returns an empty array if none are found.
 */
exports.filterIndices = filterIndices;
const getIndicesByWordListSorted = function (words, text) {
  let matchedWords = [];
  (0, _lodash.forEach)(words, function (word) {
    word = (0, _stripSpaces.default)(word);
    if (!(0, _matchWordInSentence.isWordInSentence)(word, text)) {
      return matchedWords;
    }
    matchedWords = matchedWords.concat(getIndicesByWord(word, text));
  });
  matchedWords = matchedWords.sort(function (a, b) {
    if (a.index < b.index) {
      return -1;
    }
    if (a.index > b.index) {
      return 1;
    }
    return 0;
  });
  return matchedWords;
};
exports.getIndicesByWordListSorted = getIndicesByWordListSorted;
var _default = exports.default = {
  getIndicesByWord,
  getIndicesByWordList,
  filterIndices,
  sortIndices,
  getIndicesByWordListSorted
};
//# sourceMappingURL=indices.js.map