ao-lib/semantics.ts

const defaultSemantics = {
  glossary: {
    card: 'card',
    user: 'member',
    username: 'hackername',
    proposal: 'proposition',
    avatar: 'avatar',
  },
  levels: {
    0: 'guest',
    1: 'member',
    2: 'elite member',
  },
}

let loadedGlossary = {}
/* Too complex for .env, need a new solution, maybe use fs here to import custom JSON or YAML file
if (config.semantics && config.semantics.glossary) {
  loadedGlossary = config.semantics.glossary
}*/
const serverGlossary = { ...defaultSemantics.glossary, ...loadedGlossary }

function pluralize(word) {
  let plural = word
  if (Array.isArray(plural)) {
    plural = plural[1]
  } else {
    if (plural[plural.length - 1] === 's') {
      plural = plural + 'es'
    } else {
      plural = plural + 's'
    }
  }
  return plural
}

export function capitalize(word) {
  if (word.length < 1) {
    return ''
  }
  return word[0].toUpperCase() + word.substring(1)
}

// Returns the given word or string, with all instances of words in the glossary in configuration.js replaced with their gloss.
// In a multi-word string, it will correctly distinguish between all-lowercase keywords and those
// with their first letter capitalized, and replace them correctly. Original hardcoded keywords must be typed (in this codebase)
// in either all lowercase or with the first letter capitalized to be caught be the word replacement.
export function gloss(wordOrSentence, plural = false) {
  let result
  if (wordOrSentence.indexOf(' ') < 0) {
    const word = wordOrSentence

    result = word
    const lowercase = word.toLowerCase()
    const pluralEntry = Object.entries(serverGlossary).find(
      ([keyword, synonym]) => {
        return (
          (Array.isArray(keyword) && keyword[1] === lowercase) ||
          pluralize(keyword) === lowercase
        )
      }
    )
    const singularEntry = Object.entries(serverGlossary).find(
      ([keyword, synonym]) =>
        (Array.isArray(keyword) && keyword[0] === lowercase) ||
        keyword === lowercase
    )
    if (pluralEntry || singularEntry) {
      result = pluralEntry ? pluralize(pluralEntry[1]) : singularEntry[1]
      if (Array.isArray(result)) {
        result = result[0]
      }
      if (word[0].toLowerCase() !== word[0]) {
        result = result[0].toUpperCase() + result.substring(1)
      }
    }
  } else {
    result = wordOrSentence

    Object.entries(serverGlossary).forEach(([keyword, synonym]) => {
      // replace lowercase plural version of the keyword
      const pluralKeyword = pluralize(keyword)
      const pluralSynonym = pluralize(synonym)
      let regexp = new RegExp('\\b' + pluralKeyword + '\\b', 'g')
      result = result.replace(regexp, pluralSynonym)

      // replace capitalized plural version of the keyword
      const pluralKeywordUppercase = capitalize(pluralKeyword)
      const pluralSynonymUppercase = capitalize(pluralSynonym)
      regexp = new RegExp('\\b' + pluralKeywordUppercase + '\\b', 'g')
      result = result.replace(regexp, pluralSynonymUppercase)

      // replace lowercase singular version of the keyword
      regexp = new RegExp('\\b' + keyword + '\\b', 'g')
      const singularSynonym = Array.isArray(synonym) ? synonym[0] : synonym
      result = result.replace(regexp, singularSynonym)

      // replace capitalized singular version of the keyword
      const singularKeywordUppercase = capitalize(keyword)
      const singularSynonymUppercase = capitalize(singularSynonym)
      regexp = new RegExp('\\b' + singularKeywordUppercase + '\\b', 'g')
      result = result.replace(regexp, singularSynonymUppercase)
    })
  }
  return result
}

let loadedLevels = {}
/*if (config.semantics && config.semantics.levels) {
  loadedLevels = config.semantics.levels
}*/
const serverLevels = { ...defaultSemantics.levels, ...loadedLevels }

export function glossLevel(level) {
  if (level < 0) {
    return null
  }
  let highestMatchingWord
  Object.entries(serverLevels).some(([index, word]) => {
    if (index <= level) {
      highestMatchingWord = word
    }
    if (index >= level) {
      return true
    }
  })
  return highestMatchingWord || 'member'
}

export function getSemantics() {
  return { glossary: serverGlossary, levels: serverLevels }
}