Model

Type for defining validation schemas on routes. All fields are optional — include only what you need to validate.

import { C } from "@ozanarslan/corpus";
import { z } from "zod";

const UserModel = {
	body: z.object({ name: z.string(), email: z.string().email() }),
	params: z.object({ id: z.coerce.number() }),
	response: z.object({ id: z.number(), name: z.string() }),
};

new C.Route(
	{ method: C.Method.POST, path: "/users/:id" },
	(c) => {
		// c.body is typed as { name: string; email: string }
		// c.params is typed as { id: number }
		return { id: c.params.id, name: c.body.name };
	},
	UserModel,
);

See Standard Schema for supported validation libraries (Zod, Valibot, ArkType, etc.).

Base interface extending Standard Schema v1. Any library implementing this spec can be used with Corpus.

interface Schema<T = unknown> extends StandardSchemaV1<unknown, T> {}

Popular compatible libraries include Zod, Valibot, and ArkType.

Helper type to extract the output type from a Schema.

type InferSchema<T extends Schema> = StandardSchemaV1.InferOutput<T>;

// Usage
const UserSchema = z.object({ name: z.string() });
type User = InferSchema<typeof UserSchema>; // { name: string }

Part of the Extra (X) module.

Helper type for inferring all schemas from a single object containing multiple RouteModels. Useful when you prefer to colocate all your route schemas in one place.

import { C, X } from "@ozanarslan/corpus";

class UserModel {
	static entity = z.object({
		id: z.number(),
		name: z.string(),
	});

	static create = {
		body: z.object({ name: z.string() }),
		response: this.entity,
	};

	static single = {
		params: z.object({ id: z.coerce.number() }),
		response: this.entity,
	};
}

type M = X.InferModel<typeof UserModel>;
// M["create"] = { body: { name: string }, response: { id: number, name: string } }
// M["single"] = { params: { id: number }, response: { id: number, name: string } }