retrieve-user.ts

import createHttpError from "http-errors";
import assert from "node:assert/strict";
import { z } from "zod";
import { defaultEndpointsFactory } from "express-zod-api";
import { methodProviderMiddleware } from "../middlewares.ts";

// Demonstrating circular schemas using z.object()
const feature = z.object({
  title: z.string(),
  get features() {
    return z.array(feature).optional();
  },
});

export const retrieveUserEndpoint = defaultEndpointsFactory
  .addMiddleware(methodProviderMiddleware)
  .build({
    tag: "users",
    shortDescription: "Retrieves the user.",
    description: "Example user retrieval endpoint.",
    input: z.object({
      id: z
        .string()
        .trim()
        .regex(/\d+/)
        .transform((id) => parseInt(id, 10))
        .describe("a numeric string containing the id of the user"),
    }),
    output: z.object({
      id: z.int().nonnegative(),
      name: z.string(),
      features: feature.array(), // @link https://github.com/colinhacks/zod/issues/4592
    }),
    handler: async ({ input: { id }, options: { method }, logger }) => {
      logger.debug(`Requested id: ${id}, method ${method}`);
      const name = "John Doe";
      assert(id <= 100, createHttpError(404, "User not found"));
      return {
        id,
        name,
        features: [
          { title: "Tall", features: [{ title: "Above 180cm" }] },
          { title: "Young" },
          {
            title: "Cute",
            features: [
              {
                title: "Tells funny jokes",
                features: [{ title: "About Typescript" }],
              },
            ],
          },
        ],
      };
    },
  });