import type { ZodSchema, z } from 'zod/v4'; import type { HttpStatusCode } from './HttpStatusCodes.ts'; export type InferSchemaInput = T extends ZodSchema ? z.input : T extends undefined ? undefined : never; export type InferSchemaOutput = T extends ZodSchema ? z.infer : T extends undefined ? undefined : never; export type RoutePathResolver = (pathParams: PathParams) => string; export interface CommonRouteDefinitionMetadata extends Record { } export type CommonRouteDefinition> | undefined = undefined> = { isNonJSONResponseExpected?: IsNonJSONResponseExpected; isEmptyResponseExpected?: IsEmptyResponseExpected; successResponseBodySchema: ResponseBodySchema; requestPathParamsSchema?: PathParamsSchema; requestQuerySchema?: RequestQuerySchema; /** * Schema for validating request headers. * Used to define and validate headers that the client must send with the request. * * @example * ```ts * requestHeaderSchema: z.object({ * 'authorization': z.string(), * 'x-api-key': z.string() * }) * ``` */ requestHeaderSchema?: RequestHeaderSchema; /** * Schema for validating response headers. * Used to define and validate headers that the server will send in the response. * This is useful for documenting expected response headers (e.g., rate limit headers, * pagination headers, cache control headers) and can be used by clients to validate * the response they receive. * * @example * ```ts * responseHeaderSchema: z.object({ * 'x-ratelimit-limit': z.string(), * 'x-ratelimit-remaining': z.string(), * 'x-ratelimit-reset': z.string() * }) * ``` */ responseHeaderSchema?: ResponseHeaderSchema; pathResolver: RoutePathResolver>; responseSchemasByStatusCode?: ResponseSchemasByStatusCode; metadata?: CommonRouteDefinitionMetadata; description?: string; summary?: string; tags?: readonly string[]; }; export type PayloadRouteDefinition> | undefined = undefined> = CommonRouteDefinition & { method: 'post' | 'put' | 'patch'; requestBodySchema: RequestBodySchema; }; export type GetRouteDefinition> | undefined = undefined> = CommonRouteDefinition & { method: 'get'; }; export type DeleteRouteDefinition> | undefined = undefined> = CommonRouteDefinition & { method: 'delete'; }; /** * @deprecated Use `defineApiContract` instead. This function will be removed in a future version. * @example * ```typescript * // Before (deprecated): * const route = buildPayloadRoute({ * method: 'post', * requestBodySchema: bodySchema, * successResponseBodySchema: responseSchema, * pathResolver: () => '/api/users', * }) * * // After (recommended): * const route = defineApiContract({ * method: 'post', * requestBodySchema: bodySchema, * pathResolver: () => '/api/users', * responsesByStatusCode: { 201: responseSchema }, * }) * ``` */ export declare function buildPayloadRoute> | undefined = undefined>(params: PayloadRouteDefinition): PayloadRouteDefinition; /** * @deprecated Use `defineApiContract` instead. This function will be removed in a future version. * @example * ```typescript * // Before (deprecated): * const route = buildGetRoute({ * successResponseBodySchema: responseSchema, * pathResolver: () => '/api/users', * }) * * // After (recommended): * const route = defineApiContract({ * method: 'get', * pathResolver: () => '/api/users', * responsesByStatusCode: { 200: responseSchema }, * }) * ``` */ export declare function buildGetRoute> | undefined = undefined>(params: Omit, 'method'>): GetRouteDefinition; /** * @deprecated Use `defineApiContract` instead. This function will be removed in a future version. * @example * ```typescript * // Before (deprecated): * const route = buildDeleteRoute({ * requestPathParamsSchema: z.object({ userId: z.string() }), * pathResolver: (params) => `/api/users/${params.userId}`, * }) * * // After (recommended): * const route = defineApiContract({ * method: 'delete', * requestPathParamsSchema: z.object({ userId: z.string() }), * pathResolver: ({ userId }) => `/api/users/${userId}`, * responsesByStatusCode: { 204: ContractNoBody }, * }) * ``` */ export declare function buildDeleteRoute> | undefined = undefined>(params: Omit, 'method'>): DeleteRouteDefinition; /** * @deprecated Use `mapApiContractToPath` instead. * Maps a route definition to a path string of the format '/static-path-part/:path-param-value'. */ export declare function mapRouteToPath(routeDefinition: CommonRouteDefinition): string; /** * @deprecated Use `describeApiContract` instead. */ export declare function describeContract(contract: PayloadRouteDefinition | GetRouteDefinition | DeleteRouteDefinition): string;