Merge pull request #18 from rhyek/use-nestjs-zod-fork

use nestjs zod fork

Author: rhyek

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 1.3.1 (2025-05-26)
+
+### Bugfixes
+
+- Support OPTIONS HTTP method
+- Use my fork of @nestjs/zod until this is merged: https://github.com/BenLorantfy/nestjs-zod/pull/151
+
 ## 1.3.0 (2025-04-12)
 
 ### Features

README.md

@@ -52,12 +52,72 @@ const { data: greeting, error, status } = useHelloWorld();
 npm install nestjs-endpoints @nestjs/swagger zod
 ```
 
-## Usage
+## Setup
 
 You can opt for either an automatic setup with endpoint scanning + file-based routing or a traditional one with manual imports and HTTP paths. You can also mix both in a single project.
 
 ### Option 1. Automatic setup
 
+This is the preferred way of setting up nestjs-endpoints using file-based routing.
+
+`src/app.module.ts`
+
+```typescript
+import { EndpointsRouterModule } from 'nestjs-endpoints';
+
+@Module({
+  imports: [
+    EndpointsRouterModule.register({
+      rootDirectory: './endpoints',
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+`src/endpoints/status/health.ts`
+
+```typescript
+import { endpoint } from 'nestjs-endpoints';
+
+export default endpoint({
+  handler: () => 'ok',
+});
+```
+
+Endpoint available at `/status/health`.
+
+### Option 2. Traditional imports and paths
+
+You can import endpoints like regular NestJS controllers. No need for `EndpointsRouterModule` in this case.
+
+`src/app.module.ts`
+
+```typescript
+import { Module } from '@nestjs/common';
+import { healthCheck } from './health-check';
+
+@Module({
+  controllers: [healthCheck],
+})
+class AppModule {}
+```
+
+`src/health-check.ts`
+
+```typescript
+import { endpoint } from 'nestjs-endpoints';
+
+export const healthCheck = endpoint({
+  path: '/status/health',
+  handler: () => 'ok',
+});
+```
+
+Endpoint available at `/status/health`.
+
+## Usage
+
 `src/app.module.ts`
 
 ```typescript
@@ -181,33 +241,6 @@ Examples (assume `rootDirectory` is `./endpoints`):
 
 > _**Note:**_ Bundled projects via Webpack or similar are not supported.
 
-### Option 2. Traditional imports and paths
-
-You can import endpoints like regular NestJS controllers. No need for `EndpointsRouterModule` in this case.
-
-`src/app.module.ts`
-
-```typescript
-import { Module } from '@nestjs/common';
-import { healthCheck } from './health-check';
-
-@Module({
-  controllers: [healthCheck],
-})
-class AppModule {}
-```
-
-`src/health-check.ts`
-
-```typescript
-import { endpoint } from 'nestjs-endpoints';
-
-export const healthCheck = endpoint({
-  path: '/status/health',
-  handler: () => 'ok',
-});
-```
-
 ## Codegen (optional)
 
 You can automatically generate a client SDK for your API that can be used in other backend or frontend projects with the benefit of end-to-end type safety. It uses [orval](https://orval.dev/) internally and works with both scanned and manually imported endpoints.

packages/nestjs-endpoints/package.json

@@ -45,7 +45,7 @@
   "dependencies": {
     "@orval/query": "~7.8.0",
     "callsites": "^3.1.0",
-    "nestjs-zod": "^4.2.0",
+    "nestjs-zod": "npm:@rhyek/[email protected].0",
     "orval": "~7.8.0"
   },
   "peerDependencies": {

packages/nestjs-endpoints/src/endpoint-fn.ts

@@ -6,6 +6,7 @@ import {
   Get,
   Head,
   Inject,
+  Options,
   Patch,
   Post,
   Put,
@@ -30,14 +31,22 @@ import {
   moduleAls,
 } from './helpers';
 
-type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head';
+type HttpMethod =
+  | 'get'
+  | 'post'
+  | 'put'
+  | 'delete'
+  | 'patch'
+  | 'head'
+  | 'options';
 const httpMethodDecorators = {
   get: Get,
   post: Post,
   put: Put,
   delete: Delete,
   patch: Patch,
   head: Head,
+  options: Options,
 } satisfies Record<HttpMethod, () => MethodDecorator>;
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars