@dakkitor/api-contracts
v1.1.79
Published
TypeScript API contracts using ts-rest and Zod
Maintainers
Readme
@dakkitor/api-contracts
TypeScript API contracts using ts-rest and Zod.
Installation
npm install @dakkitor/api-contractsUsage
Backend (NestJS + ts-rest)
import { clientsContract } from '@dakkitor/api-contracts';
import { tsRestHandler } from '@ts-rest/nest';
@TsRestHandler(clientsContract.create)
async create() {
return tsRestHandler(clientsContract.create, async ({ body }) => {
// Your implementation
});
}Frontend (React/Next.js)
import { clientsContract } from '@dakkitor/api-contracts';
import { initClient } from '@ts-rest/core';
const client = initClient(clientsContract, {
baseUrl: 'https://api.example.com',
baseHeaders: {},
});
// Type-safe API calls
const result = await client.create({ body: { name: 'Acme Corp' } });What's Included
- Client Contracts: Full CRUD operations for clients module
- Error Schemas: Standardized error response types matching
IErrorResponse - Type Safety: Full TypeScript support with Zod validation
Requirements
This package has peer dependencies:
@ts-rest/core^3.30.0zod^3.22.0
License
MIT
