docschema/lib/parse-check-types/check.js

Schema declaration and validation library using JsDoc comments

import { checkResult } from '../checkResult.js'
import { check as checkFilters } from '../parse-check-filters/check.js'
import { checkers } from './checkers.js'

/**
 * @type {TypesChecker}
 * @throws {SyntaxError}
 * If missing checker function (should never happen)
 */
export function check(
  parsedTypes, value, key, ast, filters, validator, throwOnError, forceStrict
) {
  /**
   * Used to prevent pushing the same key more than once,
   * which can happen when we are checking multiple types (union)
   *
   * @type {boolean}
   */
  let valuePathAddedInLoop = false

  for (const parsedType of parsedTypes) {
    const { typeName } = parsedType
    const checkerFunc = checkers.simple[typeName] ?? checkers.complex[typeName]

    if (!(checkerFunc instanceof Function)) {
      // Just in case, we should not end up here
      throw new SyntaxError(`Wrong typeName ${typeName}`)
    }

    if (!valuePathAddedInLoop) {
      if (
        typeName.startsWith('object')
        || typeName.startsWith('array')
      ) {
        if (key !== '') {
          checkResult.valuePath.push(key.toString())
          valuePathAddedInLoop = true
        }
      }
      else if (key !== '') {
        checkResult.valuePath.push(key.toString())
        valuePathAddedInLoop = true
      }
    }

    checkResult.kind = 'type'
    checkResult.expectedType = parsedType.typeExpression
    checkResult.value = value

    const result = checkerFunc(
      parsedType,
      value,
      key,
      ast,
      filters,
      validator,
      check,
      throwOnError,
      forceStrict
    )

    if (result) {
      const resultFilters = checkFilters(filters, value)

      if (resultFilters) {
        checkResult.expectedType = ''
        checkResult.kind = ''
        checkResult.pass = true
        checkResult.value = undefined
        // No error for the last part of the path => delete it
        checkResult.valuePath.pop()

        return true
      }
    }
  }

  checkResult.pass = false
  checkResult.kind = checkResult.kind || ''

  return false
}