raman-nbg/inversify-koa-utils

import * as Koa from "koa";
import { RouterContext } from "koa-router";
import { interfaces as inversifyInterfaces } from "inversify";
import { PARAMETER_TYPE } from "./constants";

namespace interfaces {

    export type Middleware = (inversifyInterfaces.ServiceIdentifier<any> | KoaRequestHandler);

    export interface ControllerMetadata {
        path: string;
        middleware: Middleware[];
        target: any;
    }

    export interface ControllerMethodMetadata extends ControllerMetadata {
        method: string;
        key: string;
    }

    export interface ControllerParameterMetadata {
        [methodName: string]: ParameterMetadata[];
    }

    export interface ParameterMetadata {
        parameterName: string;
        index: number;
        type: PARAMETER_TYPE;
    }

    export interface AuthorizeAllMetadata {
        requiredRoles: string[];
        target: any;
    }

    export interface AuthorizeMetadata extends AuthorizeAllMetadata {
        key: string;
    }

    export interface Controller {}

    export interface HandlerDecorator {
        (target: any, key: string, value: any): void;
    }

    export interface ConfigFunction {
        (app: Koa): void;
    }

    export interface RoutingConfig {
        rootPath: string;
    }

    export interface KoaRequestHandler {
        (ctx: RouterContext, next: () => Promise<any>): any;
    }

    export interface Principal {
        details: any;
        isAuthenticated(): Promise<boolean>;
        // Allows content-based auth
        isResourceOwner(resourceId: any): Promise<boolean>;
        // Allows role-based auth
        isInRole(role: string): Promise<boolean>;
    }

    export interface AuthProvider {
        getPrincipal(ctx: RouterContext): Promise<Principal>;
    }

}

export { interfaces };