joi-router.d.ts

// Inspired from: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/koa-joi-router
/// <reference types="node" />

import * as Koa from "koa";
import * as Joi from "joi";
import * as KoaRouter from "@koa/router";
import * as CoBody from "co-body";
import { BusboyConfig } from "@fastify/busboy";

declare module "Koa" {
  interface Request {
    body?: any;
    params: { [key: string]: string };
  }
}

interface KoaJoiRouter {
  new (): KoaJoiRouter.Router;
  Joi: typeof Joi;
}

declare namespace KoaJoiRouter {
  type FullHandler = (ctx: Koa.Context, next: Koa.Next) => any;
  interface NestedHandler extends ReadonlyArray<Handler> {}
  type Handler = FullHandler | NestedHandler;

  type Method = (
    path: string | RegExp,
    handlerOrConfig: Handler | Config,
    ...handlers: Handler[]
  ) => Router;

  type OutputValidation =
    | { body: Joi.SchemaLike }
    | { headers: Joi.SchemaLike };

  interface Config {
    pre?: Handler | undefined;
    validate?:
      | {
          header?: Joi.SchemaLike | undefined;
          query?: Joi.SchemaLike | undefined;
          params?: Joi.SchemaLike | undefined;
          body?: Joi.SchemaLike | undefined;
          maxBody?: number | string | undefined;
          failure?: number | undefined;
          type?: "form" | "json" | "multipart" | undefined;
          formOptions?: CoBody.Options | undefined;
          jsonOptions?: CoBody.Options | undefined;
          multipartOptions?: BusboyConfig | undefined;
          output?: { [status: string]: OutputValidation } | undefined;
          continueOnError?: boolean | undefined;
          validateOptions?: Joi.ValidationOptions | undefined;
        }
      | undefined;
    meta?: any;
  }

  interface Spec extends Config {
    method: string | string[];
    path: string | RegExp;
    handler: Handler;
  }

  interface Router {
    routes: Spec[];
    route(spec: Spec | Spec[]): Router;
    router: KoaRouter;
    middleware(): Koa.Middleware;

    prefix: KoaRouter["prefix"];
    use: KoaRouter["use"];
    param: KoaRouter["param"];

    head: Method;
    options: Method;
    get: Method;
    post: Method;
    put: Method;
    patch: Method;
    delete: Method;
  }
}

declare var KoaJoiRouter: KoaJoiRouter;

export = KoaJoiRouter;