@furystack/rest-service/src/schema-validator/schema-validator.ts

Repository implementation for FuryStack

import type { ErrorObject, Options } from 'ajv'
import Ajv from 'ajv'
import useFormats from 'ajv-formats'
import { SchemaValidationError } from './schema-validation-error.js'

export class SchemaValidator<TSchema extends { definitions: object }> {
  private readonly ajv: Ajv.default
  constructor(
    private readonly schema: TSchema,
    ajvOptions?: Options,
  ) {
    this.ajv = new Ajv.default({
      allErrors: true,
      ...ajvOptions,
    })
    useFormats.default(this.ajv)
  }

  /**
   * @param data The object to validate
   * @param options Options for the schema validation
   * @param options.schemaName The name of the type in the Schema Definitions
   * @throws SchemaValidationError when the validation has been failed
   * @returns true in case of validation success
   */
  public isValid<T>(data: any, options: { schemaName: keyof TSchema['definitions'] }): data is T {
    const schema = { ...this.schema, $ref: `#/definitions/${options.schemaName as string}` }
    const validatorFn = this.ajv.compile(schema)
    const isValid = validatorFn(data)
    if (!isValid) {
      throw new SchemaValidationError(validatorFn.errors as ErrorObject[])
    }

    return true
  }
}