Function defineRoute

packages/server/src/middleware/defineRoute.ts:233–314

(
  options: DefineRouteOptions<TBody, TParams, TQuery, TSuccessData>,
  handler: RouteDefinition<TBody, TParams, TQuery>['handler'],
)

 * app verb, e.g. `app.post(route.path, route.options, route.handler)`.
 */
export function defineRoute<
  TBody extends z.ZodTypeAny | undefined,
  TParams extends z.ZodTypeAny | undefined,
  TQuery extends z.ZodTypeAny | undefined,
  TSuccessData extends z.ZodTypeAny | undefined,
>(
  options: DefineRouteOptions<TBody, TParams, TQuery, TSuccessData>,
  handler: RouteDefinition<TBody, TParams, TQuery>['handler'],
): RouteDefinition<TBody, TParams, TQuery> {
  // -- runtime validators ----------------------------------------------------
  const preHandler: unknown[] = [];

  if (options.params) {
    preHandler.push(validateParams(options.params));
  }
  if (options.body) {
    preHandler.push(validateBody(options.body));
  }
  if (options.querystring) {
    preHandler.push(validateQuery(options.querystring));
  }

  // -- swagger schema --------------------------------------------------------
  const schema: Record<string, unknown> = {};

  if (options.body) {
    schema['body'] = jsonSchema(options.body);
  }
  if (options.params) {
    schema['params'] = jsonSchema(options.params);
  }
  if (options.querystring) {
    schema['querystring'] = jsonSchema(options.querystring);
  }

  const hasResponse =
    options.success !== undefined ||
    (options.errors !== undefined && Object.keys(options.errors).length > 0) ||
    options.rawResponse !== undefined;

  if (hasResponse) {
    const responses: Record<string, unknown> = {};

    if (options.success || options.errors) {
      responses['200'] = buildUnifiedResponseSchema(
        options.success?.data ?? z.null(),
        options.errors ?? {},
      );
    }

    if (options.rawResponse) {
      for (const [code, rawSchema] of Object.entries(options.rawResponse)) {
        responses[String(code)] = rawSchema;
      }
    }

    schema['response'] = responses;
  }