@dakkitor/api-contracts 1.0.0

package/README.md

@@ -0,0 +1,57 @@
+# @dakkitor/api-contracts
+
+TypeScript API contracts using ts-rest and Zod.
+
+## Installation
+
+```bash
+npm install @dakkitor/api-contracts
+```
+
+## Usage
+
+### Backend (NestJS + ts-rest)
+
+```typescript
+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)
+
+```typescript
+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.0
+- `zod` ^3.22.0
+
+## License
+
+MIT