opinionated-machine/dist/lib/api-contracts/apiRouteBuilder.d.ts

Very opinionated DI framework for fastify, built on top of awilix

import { type ApiContract } from '@lokalise/api-contracts';
import type { RouteOptions } from 'fastify';
import type { ApiRouteOptions, InferApiHandler } from './apiHandlerTypes.ts';
/**
 * Build a Fastify `RouteOptions` object from an `ApiContract` + handler.
 *
 * The handler shape is inferred from the contract's response mode:
 * - `'non-sse'` — bare async function returning `{ status, body }`
 * - `'sse'`     — bare async function calling `sse.start(...)` / `sse.respond(...)`
 * - `'dual'`    — `{ nonSse, sse }` object branched by the `Accept` header
 *
 * The optional `options` argument carries:
 * - any Fastify route field (`preHandler`, `onRequest`, `config`, `bodyLimit`, …)
 *   minus the ones the contract provides (`method`, `url`, `schema`, `handler`, `sse`),
 * - SSE lifecycle hooks (`onConnect`, `onClose`, `onReconnect`, `serializer`,
 *   `heartbeatInterval`) — applied for `'sse'` and `'dual'` contracts only,
 * - `defaultMode` for `'dual'` contracts when the `Accept` header is ambiguous,
 * - `gatewayMetadata` — per-route gateway policy with header / query keys
 *   narrowed to the contract; equivalent to wrapping the result with
 *   `withGatewayMetadata`. See `ApiRouteOptions` for full details.
 *
 * @returns Fastify `RouteOptions` ready to pass to `app.route()`
 */
export declare function buildApiRoute<Contract extends ApiContract>(contract: Contract, handler: InferApiHandler<Contract>, options?: ApiRouteOptions<Contract>): RouteOptions;