Cursor rule

1---
2description: Fix ApiProperty/ApiPropertyOptional optionality mismatches in DTO files; use for scheduled batch fixes or DTO edits
3globs: apps/api/**/*.dto.ts, libs/application-generic/**/*.dto.ts
4alwaysApply: false
5---
6 
7## ApiProperty optionality hygiene
8 
9Align `@ApiProperty` / `@ApiPropertyOptional` with TypeScript `?` on DTO properties. Detection script: `apps/api/scripts/check-api-property-optionality.ts`.
10 
11### Report
12 
13Read `.cursor/api-property-optionality-report.json` — only the first ~20 entries to select a batch. If the file is missing or stale, regenerate:
14 
15```bash
16pnpm --filter @novu/api-service run check:api-property-optionality -- \
17  --format json --write-report .cursor/api-property-optionality-report.json
18```
19 
20Branch on `kind`, not `message` text:
21 
22| `kind` | Fix |
23|--------|-----|
24| `ts_optional_openapi_required` | Change to `@ApiPropertyOptional` (or add `required: false` to existing options) |
25| `ts_required_openapi_optional` | Change to `@ApiProperty` (or add `required: true` to existing options) |
26 
27Merge into the existing options object — preserve `description`, `example`, `type`, `enum`, etc.
28 
29Example — `ts_optional_openapi_required`:
30 
31```ts
32// Before
33@ApiProperty({ description: 'User email' })
34email?: string;
35 
36// After
37@ApiPropertyOptional({ description: 'User email' })
38email?: string;
39```
40 
41### Workflow
42 
431. Fix all issues in the next **1–2 files** from the report (cap ~8 issues). Edit each file once. Skip ambiguous cases (multiple optionality decorators on one property); note skips in the commit message.
442. Verify changed files: `pnpm check:api-property-optionality` exits 0.
453. Regenerate SDK: `pnpm --filter @novu/api-service build:generate`
464. Run e2e: `pnpm --filter @novu/api-service test:e2e:novu-v2`
475. If step 3 or 4 fails, fix the root cause (do not revert the decorator changes - address the downstream breakage). Re-run the failing step before committing.
48 
49 
50Batch is complete when steps 3 and 4 succeed. When `issueCount` reaches 0, the task is done — no further commits needed.
51