@ismael1361/router 1.2.92 → 2.0.1

package/dist/2.0/type.d.ts

@@ -0,0 +1,661 @@
+import type * as core from "express-serve-static-core";
+import type { NextFunction } from "express";
+import type swaggerJSDoc from "swagger-jsdoc";
+import type { Readable } from "stream";
+type IsBad<T> = 0 extends 1 & T ? true : [T] extends [never] ? true : unknown extends T ? true : "" extends T ? true : string extends T ? true : false;
+type Join<A, B> = IsBad<A> extends true ? B : IsBad<B> extends true ? A : A & B;
+export type ExtractRouteParameters<Path extends string> = Extract<keyof core.RouteParameters<Path>, string>;
+export type ParamsDictionary<P extends string = string> = {
+    [key in P]: string;
+};
+export interface Request<P extends string = string, ReqBody = {}, ReqQuery = core.Query, ResBody = any> extends core.Request<ParamsDictionary<P>, ResBody, ReqBody, ReqQuery, Record<string, any>> {
+    __executedMiddlewares__?: Set<any>;
+    clientIp?: string;
+    /**
+     * Controla a execução do middleware para a requisição atual.
+     * Útil para garantir que um middleware seja executado apenas uma vez, mesmo que seja
+     * aplicado em múltiplos níveis de rotas.
+     *
+     * @param {boolean} [isOnce=true] - Se `true`, o middleware não será executado novamente para a mesma requisição. Se `false`, permite que o middleware seja executado novamente.
+     *
+     * @example
+     * // Middleware que executa uma lógica apenas uma vez por requisição.
+     * const myMiddleware: MiddlewareFC = (req, res, next) => {
+     *   // Garante que este bloco de código execute apenas uma vez.
+     *   req.executeOnce?.();
+     *
+     *   console.log("Este middleware só roda uma vez!");
+     *   next();
+     * };
+     */
+    executeOnce?: (isOnce?: boolean) => void;
+}
+export type JoinRequest<A extends Request, B extends Request> = A extends Request<infer AP, infer AReqBody, infer AReqQuery, infer AResBody> & infer AReq ? B extends Request<infer BP, infer BReqBody, infer BReqQuery, infer BResBody> & infer BReq ? Request<Join<AP, BP>, Join<AReqBody, BReqBody>, Join<AReqQuery, BReqQuery>, Join<AResBody, BResBody>> & (AReq & BReq) : never : never;
+export interface Response<ResBody = any> extends core.Response<ResBody, Record<string, any>> {
+}
+export type JoinResponse<A extends Response, B extends Response> = A extends Response<infer AResBody> ? (B extends Response<infer BResBody> ? Response<AResBody & BResBody> : never) : never;
+export interface RequestHandler<Req extends Request = Request, Res extends Response = Response> {
+    (req: Req, res: Res, next: NextFunction): unknown;
+}
+export type { NextFunction };
+export type TDocComponents = swaggerJSDoc.Components;
+export type TDocOperation = (swaggerJSDoc.Operation & {
+    components?: TDocComponents;
+}) | swaggerJSDoc.Operation;
+export interface IDoc<R = TDocOperation> {
+    (operation: TDocOperation, components?: TDocComponents): R;
+}
+export interface IHandler<Rq extends Request = Request, Rs extends Response = Response> extends RequestHandler<Rq, Rs> {
+    /**
+     * Adiciona um middleware ou handler à cadeia de execução, mesclando os tipos
+     * genéricos de request e response com os já acumulados.
+     *
+     * @typeParam Req - Tipo de request do handler sendo adicionado.
+     * @typeParam Res - Tipo de response do handler sendo adicionado.
+     * @param fn - Função handler ou instância de {@link IHandler} a ser encadeada.
+     * @returns Nova instância de {@link IHandler} com os tipos mesclados.
+     *
+     * @example
+     * app.get("/profile/:id")
+     *   .handler((req, res, next) => {
+     *     // middleware intermediário
+     *     console.log(`Acessando perfil ${req.params.id}`);
+     *     next();
+     *   })
+     *   .handler((req, res) => {
+     *     res.json({ id: req.params.id });
+     *   });
+     */
+    handler<Req extends Request = Request, Res extends Response = Response>(fn: RequestHandler<Req & Rq, Res & Rs> | IHandler<Req & Rq, Res & Rs>): IHandler<JoinRequest<Rq, Req>, JoinResponse<Rs, Res>>;
+    /**
+     * Anexa documentação OpenAPI/Swagger ao handler atual sem alterar o fluxo de execução.
+     * A documentação é mesclada na árvore interna e utilizada na geração do spec OpenAPI.
+     *
+     * @param operation - Objeto de operação OpenAPI (tags, summary, parameters, requestBody, etc.).
+     * @param components - Componentes OpenAPI adicionais (schemas, securitySchemes, etc.).
+     * @returns A mesma instância de {@link IHandler}, permitindo encadeamento contínuo.
+     *
+     * @example
+     * app.get("/users/:userId")
+     *   .handler(authMiddleware)
+     *   .doc({
+     *     tags: ["Users"],
+     *     summary: "Buscar usuário por ID",
+     *     parameters: [
+     *       { name: "userId", in: "path", required: true, schema: { type: "string" } },
+     *     ],
+     *   })
+     *   .handler((req, res) => {
+     *     res.json({ userId: req.params.userId });
+     *   });
+     *
+     * @example
+     * // Documentação com componentes de segurança
+     * app.delete("/users/:id")
+     *   .handler(authMiddleware)
+     *   .doc(
+     *     {
+     *       tags: ["Users"],
+     *       summary: "Remover usuário",
+     *       security: [{ bearerAuth: [] }],
+     *     },
+     *     {
+     *       securitySchemes: {
+     *         bearerAuth: { type: "http", scheme: "bearer" },
+     *       },
+     *     },
+     *   )
+     *   .handler((req, res) => {
+     *     res.sendStatus(204);
+     *   });
+     */
+    doc: IDoc<IHandler<Rq, Rs>>;
+}
+export interface IMiddleware<Rq extends Request = Request, Rs extends Response = Response> extends RequestHandler<Rq, Rs> {
+    /**
+     * Anexa documentação OpenAPI/Swagger ao middleware sem alterar o fluxo de execução.
+     * A documentação é mesclada na árvore interna quando o middleware é encadeado via
+     * `.handler()` em um {@link IHandler}.
+     *
+     * @param operation - Objeto de operação OpenAPI (security, parameters, requestBody, etc.).
+     * @param components - Componentes OpenAPI adicionais (schemas, securitySchemes, etc.).
+     * @returns A mesma instância de {@link IMiddleware}, permitindo encadeamento de `.doc()`.
+     *
+     * @example
+     * const authMiddleware = middleware((req: AuthRequest, res, next) => {
+     *   next();
+     * }).doc({
+     *   security: [{ bearerAuth: [] }],
+     *   components: {
+     *     securitySchemes: {
+     *       bearerAuth: { type: "http", scheme: "bearer" },
+     *     },
+     *   },
+     * });
+     *
+     * @example
+     * // Documentação com parâmetros de header
+     * const apiKeyMiddleware = middleware((req, res, next) => {
+     *   if (!req.headers["x-api-key"]) {
+     *     res.status(401).json({ error: "API key required" });
+     *     return;
+     *   }
+     *   next();
+     * }).doc({
+     *   parameters: [
+     *     { name: "x-api-key", in: "header", required: true, schema: { type: "string" } },
+     *   ],
+     * });
+     */
+    doc: IDoc<IMiddleware<Rq, Rs>>;
+}
+export type Methods = "all" | "get" | "post" | "put" | "delete" | "patch" | "options" | "head";
+export type PathParams = string | RegExp | Array<string | RegExp>;
+/**
+ * Interface que define a assinatura de um método HTTP no router (ex.: `.get()`, `.post()`, `.delete()`).
+ * Ao ser chamado com um caminho de rota, retorna um {@link IHandler} tipado com os parâmetros
+ * extraídos automaticamente da string de rota.
+ *
+ * @typeParam Method - O método HTTP associado (ex.: `"get"`, `"post"`, `"all"`).
+ *
+ * @example
+ * // Parâmetros de rota são inferidos automaticamente
+ * app.get("/users/:userId/posts/:postId")
+ *   .handler((req, res) => {
+ *     // req.params.userId e req.params.postId são inferidos como string
+ *     res.json({ userId: req.params.userId, postId: req.params.postId });
+ *   });
+ *
+ * @example
+ * // Com documentação OpenAPI inline
+ * app.post("/items", { tags: ["Items"], summary: "Criar item" })
+ *   .handler((req, res) => {
+ *     res.status(201).json({ id: 1 });
+ *   });
+ */
+export interface IRouterMatcher<Method extends Methods = any> {
+    /**
+     * Registra um handler para o método HTTP associado neste caminho de rota, retornando um {@link IHandler} com os tipos de parâmetros extraídos.
+     *
+     * @param path - Caminho de rota, que pode conter parâmetros nomeados (ex.: `"/users/:id"`).
+     * @param doc - Documentação OpenAPI/Swagger para a rota.
+     * @returns Instância de {@link IHandler} com os tipos de request e response adequados.
+     *
+     * @example
+     * app.get("/users/:userId")
+     *  .handler((req, res) => {
+     *    // req.params.userId é inferido como string
+     *    res.json({ userId: req.params.userId });
+     *  });
+     *
+     * @example
+     * // Com documentação OpenAPI inline
+     * app.post("/items", { tags: ["Items"], summary: "Criar item" })
+     *   .handler((req, res) => {
+     *     res.status(201).json({ id: 1 });
+     *   });
+     */
+    <Path extends string, P extends string = ExtractRouteParameters<Path>>(path: Path, doc?: TDocOperation): IHandler<Request<P>>;
+    /**
+     * Registra um handler para o método HTTP associado neste caminho de rota, retornando um {@link IHandler} com os tipos de parâmetros extraídos.
+     *
+     * @param path - Caminho de rota, que pode conter parâmetros nomeados (ex.: `"/users/:id"`).
+     * @param doc - Documentação OpenAPI/Swagger para a rota.
+     * @returns Instância de {@link IHandler} com os tipos de request e response adequados.
+     *
+     * @example
+     * app.get("/users/:userId", { tags: ["Users"], summary: "Buscar usuário por ID" })
+     *  .handler((req, res) => {
+     *    res.json({ userId: req.params.userId });
+     *  });
+     *
+     * @example
+     * // Documentação com componentes de segurança
+     * app.delete("/users/:id", { security: [{ bearerAuth: [] }] }, {
+     *   securitySchemes: {
+     *     bearerAuth: { type: "http", scheme: "bearer" },
+     *   },
+     * })
+     * .handler((req, res) => {
+     *   res.sendStatus(204);
+     * });
+     */
+    (path: PathParams, doc?: TDocOperation): IHandler;
+}
+/**
+ * Interface principal do router, que estende {@link RequestHandler} e expõe métodos HTTP,
+ * sub-rotas, middlewares e configuração de documentação OpenAPI/Swagger.
+ *
+ * Pode ser criado via `router()` e aninhado em outros routers ou em uma aplicação via `.route()` ou `.use()`.
+ *
+ * @example
+ * // Criar um router e definir rotas
+ * import { router } from "./2.0";
+ *
+ * const api = router();
+ *
+ * api.get("/users")
+ *   .handler((req, res) => {
+ *     res.json([{ name: "Alice" }]);
+ *   })
+ *   .doc({ tags: ["Users"], summary: "Listar usuários" });
+ *
+ * api.post("/users")
+ *   .handler((req, res) => {
+ *     res.status(201).json({ id: 1 });
+ *   })
+ *   .doc({ tags: ["Users"], summary: "Criar usuário" });
+ *
+ * @example
+ * // Aninhar routers com prefixo
+ * const v1 = router();
+ *
+ * v1.get("/test/route")
+ *   .handler((req, res) => {
+ *     res.send("Hello from v1!");
+ *   })
+ *   .doc({ tags: ["V1"], summary: "Rota de teste v1" });
+ *
+ * app.route("/v1", v1, {
+ *   security: [{ bearerAuth: [] }],
+ *   responses: {
+ *     "400": { description: "Dados inválidos" },
+ *     "404": { description: "Não encontrado" },
+ *   },
+ * });
+ *
+ * @example
+ * // Configurar documentação Swagger
+ * app.defineSwagger({
+ *   openapi: "3.0.0",
+ *   info: { title: "My API", version: "1.0.0" },
+ *   defaultResponses: {
+ *     400: { description: "Dados inválidos" },
+ *     401: { description: "Falha na autenticação" },
+ *     500: { description: "Erro interno do servidor" },
+ *   },
+ * });
+ */
+export interface IRouter extends RequestHandler {
+    /** Mapeia um callback para parâmetros de rota nomeados, equivalente a `app.param()` do Express. */
+    "param": core.Application["param"];
+    /** Registra um handler para todos os métodos HTTP no caminho especificado. */
+    "all": IRouterMatcher<"all">;
+    /** Registra um handler para requisições GET. */
+    "get": IRouterMatcher<"get">;
+    /** Registra um handler para requisições POST. */
+    "post": IRouterMatcher<"post">;
+    /** Registra um handler para requisições PUT. */
+    "put": IRouterMatcher<"put">;
+    /** Registra um handler para requisições DELETE. */
+    "delete": IRouterMatcher<"delete">;
+    /** Registra um handler para requisições PATCH. */
+    "patch": IRouterMatcher<"patch">;
+    /** Registra um handler para requisições OPTIONS. */
+    "options": IRouterMatcher<"options">;
+    /** Registra um handler para requisições HEAD. */
+    "head": IRouterMatcher<"head">;
+    "checkout": IRouterMatcher;
+    "copy": IRouterMatcher;
+    "lock": IRouterMatcher;
+    "merge": IRouterMatcher;
+    "mkactivity": IRouterMatcher;
+    "mkcol": IRouterMatcher;
+    "move": IRouterMatcher;
+    "m-search": IRouterMatcher;
+    "notify": IRouterMatcher;
+    "purge": IRouterMatcher;
+    "report": IRouterMatcher;
+    "search": IRouterMatcher;
+    "subscribe": IRouterMatcher;
+    "trace": IRouterMatcher;
+    "unlock": IRouterMatcher;
+    "unsubscribe": IRouterMatcher;
+    /** Router pai ao qual este router está aninhado, ou `null` se for o router raiz. */
+    "parent": IRouter | null;
+    /** Caminho de prefixo deste router dentro do router pai. */
+    "path": string;
+    /**
+     * Cria ou anexa um sub-router em um prefixo de rota, permitindo modularizar a aplicação.
+     *
+     * @param prefix - Prefixo de caminho para o sub-router.
+     * @param router - Instância de {@link IRouter} a ser aninhada (opcional).
+     * @param doc - Documentação OpenAPI aplicada a todas as rotas do sub-router.
+     * @returns O sub-router criado ou anexado.
+     *
+     * @example
+     * // Criar sub-router inline
+     * const usersRoute = app.route("/users");
+     * usersRoute.get("/").handler((req, res) => res.json([]));
+     *
+     * @example
+     * // Anexar router existente com documentação
+     * const v1 = router();
+     * v1.get("/items").handler((req, res) => res.json([]));
+     *
+     * app.route("/v1", v1, {
+     *   security: [{ bearerAuth: [] }],
+     * });
+     */
+    route<T extends string>(prefix: T, doc?: TDocOperation): IRouter;
+    route<T extends string>(prefix: T, router: IRouter, doc?: TDocOperation): IRouter;
+    route(router: IRouter, doc?: TDocOperation): IRouter;
+    /**
+     * Registra um middleware, handler ou sub-router no caminho especificado.
+     * Quando chamado apenas com prefixo e sem handler, retorna um {@link IHandler} encadeável.
+     *
+     * @param prefix - Prefixo de caminho (opcional).
+     * @param handler - Instância de {@link IRouter}, {@link RequestHandler} ou middleware.
+     * @param doc - Documentação OpenAPI para o middleware.
+     *
+     * @example
+     * // Middleware global sem prefixo
+     * app.use((req, res, next) => {
+     *   console.log(`${req.method} ${req.url}`);
+     *   next();
+     * });
+     *
+     * @example
+     * // Sub-router com prefixo
+     * const apiRouter = router();
+     * app.use("/api", apiRouter);
+     *
+     * @example
+     * // Handler encadeável com prefixo
+     * app.use("/health")
+     *   .handler((req, res) => {
+     *     res.json({ status: "ok" });
+     *   });
+     */
+    use<T extends string, P extends string = ExtractRouteParameters<T>>(prefix: T, doc?: TDocOperation): IHandler<Request<P>>;
+    use<T extends string, P extends string = ExtractRouteParameters<T>>(prefix: T, handler: IRouter | RequestHandler, doc?: TDocOperation): void;
+    use(handler: IRouter | RequestHandler, doc?: TDocOperation): void;
+    /**
+     * Define as opções de documentação Swagger/OpenAPI para este router.
+     * Habilita a geração automática de spec OpenAPI e endpoints de documentação
+     * (Swagger UI, Markdown, etc.).
+     *
+     * @param options - Configuração OpenAPI 3.0 com opções adicionais como
+     *                  `defaultResponses`, `path` e `targets` para snippets.
+     *
+     * @example
+     * app.defineSwagger({
+     *   openapi: "3.0.0",
+     *   info: { title: "My API", version: "1.0.0" },
+     *   path: "/doc",
+     *   defaultResponses: {
+     *     400: { description: "Dados inválidos" },
+     *     401: { description: "Falha na autenticação" },
+     *     500: { description: "Erro interno do servidor" },
+     *   },
+     *   targets: ["shell_curl", "javascript_xhr", "node_native"],
+     * });
+     */
+    defineSwagger(options: SwaggerOptions): void;
+    /**
+     * Retorna a especificação Swagger/OpenAPI gerada a partir de todas as rotas,
+     * handlers e documentações registradas neste router.
+     *
+     * @returns Objeto de opções compatível com `swagger-jsdoc`.
+     *
+     * @example
+     * const spec = app.getSwagger();
+     * console.log(JSON.stringify(spec, null, 2));
+     */
+    getSwagger(): swaggerJSDoc.Options;
+}
+/**
+ * Define a estrutura da documentação Swagger/OpenAPI que pode ser anexada a um middleware.
+ * Permite que middlewares contribuam com definições de segurança, parâmetros, etc., que são
+ * mescladas com a documentação da rota final.
+ *
+ * @see MiddlewareFC
+ * @example
+ * const authMiddleware: MiddlewareFC = (req, res, next) => { next(); };
+ * authMiddleware.doc = {
+ *   security: [{ BearerAuth: [] }],
+ *   components: {
+ *     securitySchemes: { BearerAuth: { type: "http", scheme: "bearer" } }
+ *   }
+ * };
+ */
+export type MiddlewareFCDoc = swaggerJSDoc.Operation & {
+    components?: swaggerJSDoc.Components;
+};
+export type SnippetTargets = "c_libcurl" | "csharp_restsharp" | "csharp_httpclient" | "go_native" | "java_okhttp" | "java_unirest" | "javascript_jquery" | "javascript_xhr" | "node_native" | "node_request" | "node_unirest" | "objc_nsurlsession" | "ocaml_cohttp" | "php_curl" | "php_http1" | "php_http2" | "python_python3" | "python_requests" | "ruby_native" | "shell_curl" | "shell_httpie" | "shell_wget" | "swift_nsurlsession";
+export interface SwaggerOptions extends swaggerJSDoc.OAS3Definition {
+    path?: string;
+    defaultResponses?: swaggerJSDoc.Responses;
+    targets?: SnippetTargets[];
+}
+export interface IStackFrame {
+    functionName: string;
+    filePath: string;
+    dir: string;
+    lineNumber: number;
+    columnNumber: number;
+}
+export interface IChildrenDoc {
+    stackFrame: IStackFrame;
+    operation: swaggerJSDoc.Operation;
+    components: swaggerJSDoc.Components;
+}
+export interface IParentDoc extends IChildrenDoc {
+}
+export interface ITreeDoc {
+    method?: Methods;
+    path?: string;
+    parent: IParentDoc | SwaggerOptions | null;
+    children: (IChildrenDoc | ITreeDoc)[];
+}
+export interface IStackLog {
+    time: Date;
+    level: "ERROR" | "WARN" | "INFO" | "DEBUG";
+    name: string;
+    message: string;
+    source?: string;
+    statusCode: number;
+    duration: number;
+    meta?: string;
+}
+export interface IStacksOptions {
+    /** Caminho de rota de empilhamento dos logs */
+    path?: string;
+    /** Limite máximo de logs a serem empilhadas */
+    limit?: number;
+    /** Caminho base para o arquivo dos logs empilhados */
+    filePath?: string;
+    beforeStack?(...stacks: IStackLog[]): Array<IStackLog | string | Error>;
+}
+/**
+ * Interface principal da aplicação, estende {@link IRouter} com capacidades de servidor HTTP,
+ * configuração do Express e sistema de logging por pilha de stacks.
+ *
+ * Criada pela função `create()` exportada em `create.ts`, que encapsula uma instância Express
+ * com roteamento tipado, documentação OpenAPI e rastreamento de requisições.
+ *
+ * @example
+ * // Criar aplicação e iniciar servidor
+ * import { create } from "./2.0";
+ *
+ * const app = create();
+ *
+ * app.get("/hello/:name")
+ *   .handler((req, res) => {
+ *     res.send(`Hello, ${req.params.name}!`);
+ *   });
+ *
+ * app.listen(3000, () => {
+ *   console.log("Server is running on http://localhost:3000");
+ * });
+ *
+ * @example
+ * // Aplicação completa com sub-routers, Swagger e stacks
+ * const app = create();
+ *
+ * const v1 = router();
+ * v1.get("/users")
+ *   .handler((req, res) => res.json([]))
+ *   .doc({ tags: ["Users"], summary: "Listar usuários" });
+ *
+ * app.route("/v1", v1);
+ *
+ * app.defineSwagger({
+ *   openapi: "3.0.0",
+ *   info: { title: "My API", version: "1.0.0" },
+ * });
+ *
+ * app.defineStacks({
+ *   path: "/stacks",
+ *   limit: 200,
+ *   filePath: "./logs/stacks.log",
+ * });
+ *
+ * app.listen(8080);
+ */
+export interface IApplication extends IRouter {
+    /**
+     * Inicia o servidor HTTP escutando na porta especificada, equivalente a `app.listen()` do Express.
+     *
+     * @example
+     * app.listen(3000, () => {
+     *   console.log("Server is running on http://localhost:3000");
+     * });
+     *
+     * @example
+     * // Com host específico
+     * app.listen(8080, "0.0.0.0", () => {
+     *   console.log("Server is running on http://0.0.0.0:8080");
+     * });
+     */
+    listen: core.Application["listen"];
+    /**
+     * Desabilita a configuração `setting`. Equivalente a `app.set(setting, false)`.
+     *
+     * @example
+     * app.disable("x-powered-by");
+     */
+    disable: core.Application["disable"];
+    /**
+     * Habilita a configuração `setting`. Equivalente a `app.set(setting, true)`.
+     *
+     * @example
+     * app.enable("trust proxy");
+     */
+    enable: core.Application["enable"];
+    /**
+     * Retorna `true` se a configuração `setting` está desabilitada.
+     *
+     * @example
+     * if (app.disabled("x-powered-by")) {
+     *   console.log("x-powered-by está desabilitado");
+     * }
+     */
+    disabled: core.Application["disabled"];
+    /**
+     * Retorna `true` se a configuração `setting` está habilitada.
+     *
+     * @example
+     * if (app.enabled("trust proxy")) {
+     *   console.log("trust proxy está habilitado");
+     * }
+     */
+    enabled: core.Application["enabled"];
+    /**
+     * Registra uma engine de template para a extensão de arquivo especificada.
+     *
+     * @example
+     * app.engine("html", require("ejs").renderFile);
+     */
+    engine: core.Application["engine"];
+    /**
+     * Mapeia um callback para parâmetros de rota nomeados.
+     *
+     * @example
+     * app.param("userId", (req, res, next, id) => {
+     *   console.log(`Parâmetro userId: ${id}`);
+     *   next();
+     * });
+     */
+    param: core.Application["param"];
+    /**
+     * Renderiza uma view e envia a string HTML resultante ao cliente.
+     *
+     * @example
+     * app.render("index", { title: "Home" }, (err, html) => {
+     *   if (err) console.error(err);
+     *   console.log(html);
+     * });
+     */
+    render: core.Application["render"];
+    /**
+     * Retorna todos os logs de stack registrados, lidos a partir do arquivo de log configurado.
+     *
+     * @returns Array de {@link IStackLog} com os registros de requisições.
+     *
+     * @example
+     * const stacks = app.getStacks();
+     * console.log(`Total de logs: ${stacks.length}`);
+     * stacks.forEach((log) => {
+     *   console.log(`[${log.level}] ${log.name} - ${log.message} (${log.duration}ms)`);
+     * });
+     */
+    getStacks(): IStackLog[];
+    /**
+     * Configura o sistema de logging por pilha de stacks, que registra informações
+     * sobre cada requisição (tempo, status, duração, etc.) em um arquivo de log.
+     *
+     * @param options - Opções de configuração do sistema de stacks.
+     * @returns Objeto com o caminho da rota de visualização dos stacks.
+     *
+     * @example
+     * const { stacksPath } = app.defineStacks({
+     *   path: "/stacks",
+     *   limit: 100,
+     *   filePath: "./logs/stacks.log",
+     *   beforeStack(...stacks) {
+     *     // Filtrar logs antes de salvar
+     *     return stacks.filter((s) => typeof s !== "string" && s.level === "ERROR");
+     *   },
+     * });
+     *
+     * console.log(`Stacks disponíveis em: ${stacksPath}`);
+     */
+    defineStacks(options?: IStacksOptions): {
+        stacksPath: string;
+    };
+}
+export interface FileInfo {
+    /** Name of the form field associated with this file. */
+    fieldname: string;
+    /** Name of the file on the uploader's computer. */
+    originalname: string;
+    /**
+     * Value of the `Content-Transfer-Encoding` header for this file.
+     * @deprecated since July 2015
+     * @see RFC 7578, Section 4.7
+     */
+    encoding: string;
+    /** Value of the `Content-Type` header for this file. */
+    mimetype: string;
+    /** Size of the file in bytes. */
+    size: number;
+    /**
+     * A readable stream of this file. Only available to the `_handleFile`
+     * callback for custom `StorageEngine`s.
+     */
+    stream: Readable;
+    /** `DiskStorage` only: Directory to which this file has been uploaded. */
+    destination: string;
+    /** `DiskStorage` only: Name of this file within `destination`. */
+    filename: string;
+    /** `DiskStorage` only: Full path to the uploaded file. */
+    path: string;
+    /** `MemoryStorage` only: A Buffer containing the entire file. */
+    buffer: Buffer;
+}
+export interface FilesRequest extends Request {
+    file: FileInfo;
+    files: FileInfo[];
+}
+//# sourceMappingURL=type.d.ts.map

package/dist/2.0/type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["../../src/2.0/type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,IAAI,MAAM,2BAA2B,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,KAAK,YAAY,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAGvC,KAAK,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAC5B,IAAI,GACJ,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAClB,IAAI,GACJ,OAAO,SAAS,CAAC,GAChB,IAAI,GACJ,EAAE,SAAS,CAAC,GACX,IAAI,GACJ,MAAM,SAAS,CAAC,GACf,IAAI,GACJ,KAAK,CAAC;AAEb,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAMhF,MAAM,MAAM,sBAAsB,CAAC,IAAI,SAAS,MAAM,IAAI,OAAO,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;AAE5G,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;KACxD,GAAG,IAAI,CAAC,GAAG,MAAM;CAClB,CAAC;AAEF,MAAM,WAAW,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,OAAO,GAAG,EAAE,EAAE,QAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,OAAO,GAAG,GAAG,CAAE,SAAQ,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjM,uBAAuB,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;CACzC;AAED,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,SAAS,OAAO,IAAI,CAAC,SAAS,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,QAAQ,EAAE,MAAM,SAAS,EAAE,MAAM,QAAQ,CAAC,GAAG,MAAM,IAAI,GACtJ,CAAC,SAAS,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,QAAQ,EAAE,MAAM,SAAS,EAAE,MAAM,QAAQ,CAAC,GAAG,MAAM,IAAI,GACxF,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,GACrH,KAAK,GACN,KAAK,CAAC;AAET,MAAM,WAAW,QAAQ,CAAC,OAAO,GAAG,GAAG,CAAE,SAAQ,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAAG;AAE/F,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,SAAS,QAAQ,IAAI,CAAC,SAAS,QAAQ,CAAC,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,QAAQ,CAAC,GAAG,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC;AAE7L,MAAM,WAAW,cAAc,CAAC,GAAG,SAAS,OAAO,GAAG,OAAO,EAAE,GAAG,SAAS,QAAQ,GAAG,QAAQ;IAC7F,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC;CAClD;AAED,YAAY,EAAE,YAAY,EAAE,CAAC;AAE7B,MAAM,MAAM,cAAc,GAAG,YAAY,CAAC,UAAU,CAAC;AAErD,MAAM,MAAM,aAAa,GACtB,CAAC,YAAY,CAAC,SAAS,GAAG;IAC1B,UAAU,CAAC,EAAE,cAAc,CAAC;CAC3B,CAAC,GACF,YAAY,CAAC,SAAS,CAAC;AAE1B,MAAM,WAAW,IAAI,CAAC,CAAC,GAAG,aAAa;IACtC,CAAC,SAAS,EAAE,aAAa,EAAE,UAAU,CAAC,EAAE,cAAc,GAAG,CAAC,CAAC;CAC3D;AAED,MAAM,WAAW,QAAQ,CAAC,EAAE,SAAS,OAAO,GAAG,OAAO,EAAE,EAAE,SAAS,QAAQ,GAAG,QAAQ,CAAE,SAAQ,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC;IACrH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CAAC,GAAG,SAAS,OAAO,GAAG,OAAO,EAAE,GAAG,SAAS,QAAQ,GAAG,QAAQ,EACrE,EAAE,EAAE,cAAc,CAAC,GAAG,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,CAAC,GAAG,QAAQ,CAAC,GAAG,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,CAAC,GACnE,QAAQ,CAAC,WAAW,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,YAAY,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;IAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyCG;IACH,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,WAAW,CAAC,EAAE,SAAS,OAAO,GAAG,OAAO,EAAE,EAAE,SAAS,QAAQ,GAAG,QAAQ,CAAE,SAAQ,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC;IACxH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;CAC/B;AAED,MAAM,MAAM,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;AAE/F,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,cAAc,CAAC,MAAM,SAAS,OAAO,GAAG,GAAG;IAC3D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,CAAC,IAAI,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,sBAAsB,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAE9H;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,CAAC,IAAI,EAAE,UAAU,EAAE,GAAG,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;CAClD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACH,MAAM,WAAW,OAAQ,SAAQ,cAAc;IAC9C,mGAAmG;IACnG,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAInC,8EAA8E;IAC9E,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;IAC7B,gDAAgD;IAChD,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;IAC7B,iDAAiD;IACjD,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IAC/B,gDAAgD;IAChD,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;IAC7B,mDAAmD;IACnD,QAAQ,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;IACnC,kDAAkD;IAClD,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IACjC,oDAAoD;IACpD,SAAS,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;IACrC,iDAAiD;IACjD,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IAE/B,UAAU,EAAE,cAAc,CAAC;IAC3B,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,EAAE,cAAc,CAAC;IACvB,OAAO,EAAE,cAAc,CAAC;IACxB,YAAY,EAAE,cAAc,CAAC;IAC7B,OAAO,EAAE,cAAc,CAAC;IACxB,MAAM,EAAE,cAAc,CAAC;IACvB,UAAU,EAAE,cAAc,CAAC;IAC3B,QAAQ,EAAE,cAAc,CAAC;IACzB,OAAO,EAAE,cAAc,CAAC;IACxB,QAAQ,EAAE,cAAc,CAAC;IACzB,QAAQ,EAAE,cAAc,CAAC;IACzB,WAAW,EAAE,cAAc,CAAC;IAC5B,OAAO,EAAE,cAAc,CAAC;IACxB,QAAQ,EAAE,cAAc,CAAC;IACzB,aAAa,EAAE,cAAc,CAAC;IAE9B,oFAAoF;IACpF,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;IAEzB,4DAA4D;IAC5D,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC;IACjE,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC;IAClF,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC;IAGrD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,sBAAsB,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAE1H,GAAG,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,GAAG,sBAAsB,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,GAAG,cAAc,EAAE,GAAG,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAE7I,GAAG,CAAC,OAAO,EAAE,OAAO,GAAG,cAAc,EAAE,GAAG,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IAE7C;;;;;;;;;OASG;IACH,UAAU,IAAI,YAAY,CAAC,OAAO,CAAC;CACnC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,eAAe,GAAG,YAAY,CAAC,SAAS,GAAG;IACtD,UAAU,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,cAAc,GACvB,WAAW,GACX,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,aAAa,GACb,cAAc,GACd,mBAAmB,GACnB,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,cAAc,GACd,mBAAmB,GACnB,cAAc,GACd,UAAU,GACV,WAAW,GACX,WAAW,GACX,gBAAgB,GAChB,iBAAiB,GACjB,aAAa,GACb,YAAY,GACZ,cAAc,GACd,YAAY,GACZ,oBAAoB,CAAC;AAExB,MAAM,WAAW,cAAe,SAAQ,YAAY,CAAC,cAAc;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gBAAgB,CAAC,EAAE,YAAY,CAAC,SAAS,CAAC;IAC1C,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,WAAW;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC5B,UAAU,EAAE,WAAW,CAAC;IACxB,SAAS,EAAE,YAAY,CAAC,SAAS,CAAC;IAClC,UAAU,EAAE,YAAY,CAAC,UAAU,CAAC;CACpC;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY;CAAG;AAEnD,MAAM,WAAW,QAAQ;IACxB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,UAAU,GAAG,cAAc,GAAG,IAAI,CAAC;IAC3C,QAAQ,EAAE,CAAC,YAAY,GAAG,QAAQ,CAAC,EAAE,CAAC;CACtC;AAED,MAAM,WAAW,SAAS;IACzB,IAAI,EAAE,IAAI,CAAC;IACX,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC9B,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,WAAW,CAAC,CAAC,GAAG,MAAM,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,SAAS,GAAG,MAAM,GAAG,KAAK,CAAC,CAAC;CACxE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,WAAW,YAAa,SAAQ,OAAO;IAC5C;;;;;;;;;;;;;OAaG;IACH,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAEnC;;;;;OAKG;IACH,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAErC;;;;;OAKG;IACH,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAEnC;;;;;;;OAOG;IACH,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAEvC;;;;;;;OAOG;IACH,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IAErC;;;;;OAKG;IACH,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAEnC;;;;;;;;OAQG;IACH,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAEjC;;;;;;;;OAQG;IACH,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAEnC;;;;;;;;;;;OAWG;IACH,SAAS,IAAI,SAAS,EAAE,CAAC;IAEzB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAY,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG;QACvC,UAAU,EAAE,MAAM,CAAC;KACnB,CAAC;CACF;AAED,MAAM,WAAW,QAAQ;IACxB,wDAAwD;IACxD,SAAS,EAAE,MAAM,CAAC;IAClB,mDAAmD;IACnD,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC;IACjB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,MAAM,EAAE,QAAQ,CAAC;IACjB,0EAA0E;IAC1E,WAAW,EAAE,MAAM,CAAC;IACpB,kEAAkE;IAClE,QAAQ,EAAE,MAAM,CAAC;IACjB,0DAA0D;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,iEAAiE;IACjE,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAa,SAAQ,OAAO;IAC5C,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,QAAQ,EAAE,CAAC;CAClB"}