import type openapi from "openapi3-ts";
import type { FunctionRuntimeProps } from "../function-props.js";
import type { HttpMethod } from "../http-method.js";
import type { SourceLocation } from "../internal/service-spec.js";
import { Command, CommandContext, CommandHandler, CommandOptions, CommandOutputOptions } from "./command.js";
import type { MiddlewareInput, MiddlewareOutput } from "./middleware.js";
import type { HttpRequest, HttpResponse } from "./request-response.js";
/**
 * This Proxy intercepts the method  being called, e.g. `get`, `post`, etc.
 * and includes that information in the created {@link HttpRoute} object. This
 * information is then picked up during infer so we know the HTTP method
 * for each route.
 *
 * It also includes `sourceLocation` (injected by the compiler), `path`, and
 * any `runtimeProps` passed in by the user.
 *
 * @see HttpRoute for all the metadata associated with each route
 */
export declare const api: HttpRouter<CommandContext>;
export type RouteRuntimeProps = FunctionRuntimeProps;
export interface ApiRouteProps extends RouteRuntimeProps {
    /**
     * Description of the route.
     *
     * Used to generate the {@link ApiSpecification}.
     */
    description?: string;
    /**
     * Outputs of the route.
     *
     * Used to generate the {@link ApiSpecification}.
     */
    outputs?: CommandOutputOptions<any>[];
}
export type HttpHandler<Context extends CommandContext = CommandContext> = (request: HttpRequest, context: Context) => HttpResponse | Promise<HttpResponse>;
export interface HttpRoute {
    path: string;
    handlers: HttpHandler<any>[];
    method: HttpMethod;
    props?: ApiRouteProps;
    /**
     * Only available during eventual-infer
     */
    sourceLocation?: SourceLocation;
}
export interface HttpRouteFactory<Context extends CommandContext> {
    (path: string, props: ApiRouteProps, handlers: HttpHandler<Context>): HttpRouter<Context>;
    (path: string, handlers: HttpHandler<Context>): HttpRouter<Context>;
}
export interface HttpRouter<Context extends CommandContext> {
    handle: (request: HttpRequest, ...extra: any) => Promise<HttpResponse>;
    routes: HttpRouteEntry[];
    all: HttpRouteFactory<Context>;
    get: HttpRouteFactory<Context>;
    head: HttpRouteFactory<Context>;
    post: HttpRouteFactory<Context>;
    put: HttpRouteFactory<Context>;
    delete: HttpRouteFactory<Context>;
    connect: HttpRouteFactory<Context>;
    options: HttpRouteFactory<Context>;
    trace: HttpRouteFactory<Context>;
    patch: HttpRouteFactory<Context>;
    use<NextContext extends CommandContext>(middleware: (input: MiddlewareInput<Context>) => Promise<MiddlewareOutput<NextContext>> | MiddlewareOutput<NextContext>): HttpRouter<NextContext>;
    command<Name extends string, Input = undefined, Output = void>(name: Name, handler: CommandHandler<Input, Output, Context>): Command<Name, Input, Output, Context, undefined, undefined>;
    command<Name extends string, Input, Output, Path extends string | undefined, Method extends HttpMethod | undefined>(name: Name, options: CommandOptions<Input, Output, Path, Method>, handler: CommandHandler<Input, Output, Context>): Command<Name, Input, Output, Context, Path, Method>;
}
export type HttpRouteEntry = [string, RegExp, HttpHandler];
export interface ApiSpecification {
    generate: (options?: {
        includeRpcPaths?: boolean;
    }) => openapi.OpenAPIObject;
}
export declare const ApiSpecification: ApiSpecification;
//# sourceMappingURL=api.d.ts.map