import { MeshInstance } from 'meshql-core';
import { RequestHandler, Router } from 'express';

/**
 * Express router and middleware helpers for MeshQL.
 *
 * @module
 *
 * @example
 * ```ts
 * import express from "express";
 * import { createMesh } from "meshql-core";
 * import { meshExpressRouter } from "meshql-http/express";
 *
 * const app = express();
 * app.use(meshExpressRouter(createMesh({ entities: {} }), "/mesh"));
 * ```
 */

/** Options for Express MeshQL routes. */
interface MeshExpressOptions {
    /** Max multipart upload size in bytes. Default 25 MiB. */
    maxUploadBytes?: number;
}
/** Mount MeshQL routes on an Express router. */
declare function meshExpressRouter(mesh: MeshInstance, basePath?: string, options?: MeshExpressOptions): Router;
/** Express middleware that handles MeshQL routes under a base path. */
declare function meshExpressMiddleware(mesh: MeshInstance, basePath?: string, options?: MeshExpressOptions): RequestHandler;

export { type MeshExpressOptions, meshExpressMiddleware, meshExpressRouter };