index.ts

export type ResultKind = 'success' | 'failure' | 'informational' | 'warning' | 'error'

export interface IResult {
  description: string
  status: ResultKind
}

class ErrorResult implements IResult {
  public description: string;
  public status: ResultKind;
  public details: string | Error

  public constructor(description: string, details: string | Error) {
    this.status = 'error'
    this.description = description
    this.details = details
  }
}

type FailureKind = 'failed' | 'inconclusive'

class Failure implements IResult {
  public details: string | Error
  public description: string;
  public status: ResultKind;

  public constructor(kind: FailureKind, description: string, details: string | Error = '') {
    this.description = description
    this.status = 'failure'
    this.details = details
  }
}

export class Result implements IResult {
  public description: string
  public status: ResultKind
  public details?: string

  protected constructor(descrition: string, status: ResultKind, details?: string) {
    this.description = descrition
    this.status = status
    this.details = details
  }

  public static Success(description = '', details?: string) {
    return new Result(description, 'success', details)
  }

  public static Failure(reason: string, details?: string | Error): IResult {
    return new Failure('failed', reason, details)
  }

  public static Warning(description: string, details?: string) {
    return new Result(description, 'warning', details)
  }

  public static Informational(description: string, details?: string) {
    return new Result(description, 'informational', details)
  }

  public static Error(description: string, details: string | Error = ''): IResult {
    return new ErrorResult(description, details)
  }
}

export interface Context {
  [s: string]: any
}

/**
 * Return type of check functions. Either results, or result will be reported
 */
export interface CheckResult<T extends Context = Context> {
  /**
     * Results to be reported
     */
  result?: IResult
  /**
     * Results to be reported
     */
  results?: IResult[]
  /**
     * Checks to add to queue
     */
  // eslint-disable-next-line no-use-before-define
  nextChecks?: checkChain<T>[]
  /**
     * If true, does not nest nextChecks
     */
  sameLevel?: boolean
}

/**
 * Function delegate which runs actual check. It can be asynchronous
 */
export type checkChain<T extends Context = Context> = (this: T) => Promise<CheckResult<T>> | CheckResult<T>