style: format changed files with Prettier and exclude .vscode/settings.json from commit

Author: digitalnomad91

README.md

@@ -99,3 +99,61 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 ## License
 
 Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
+
+## API Conventions
+
+### Response Envelope
+
+Endpoints using the custom `@Api({ envelope: true })` decorator option return:
+
+```
+{ "success": true, "data": <payload> }
+```
+
+Errors are normalized by the global `HttpExceptionFilter` into:
+
+```
+{
+  "success": false,
+  "error": {
+    "statusCode": 400,
+    "message": "Validation failed",
+    "details": {},
+    "path": "/endpoint",
+    "timestamp": "2025-01-01T00:00:00.000Z"
+  }
+}
+```
+
+### Pagination Shape
+
+Paginated endpoints (with `paginatedResponseType`) return (inside the envelope when enabled):
+
+```
+{
+  "items": [ ... ],
+  "pageInfo": {
+    "hasNextPage": true,
+    "hasPreviousPage": false,
+    "startCursor": "0",
+    "endCursor": "25"
+  },
+  "totalCount": 1234,
+  "meta": { "company": { ... } }
+}
+```
+
+Use `buildPaginatedResult({ items, skip, take, totalCount, meta })` in services.
+
+### Automatic Swagger Params
+
+Annotate DTO properties with `@Field({ inQuery: true })` or `@Field({ inPath: true })`. Add those DTOs to `queriesFrom` / `pathParamsFrom` in `@Api()` and Swagger params are generated automatically.
+
+### Adding a New Paginated Endpoint
+1. Create / reuse DTOs + annotate filters & pagination args with `@Field`.
+2. Controller: `@Api({ paginatedResponseType: MyDto, envelope: true, queriesFrom: [PaginationArgs, FilterDto] })`.
+3. Service: return `buildPaginatedResult`.
+
+### Error Handling
+Throw standard Nest `HttpException` subclasses. The filter wraps them in the envelope. Custom non-Http errors can be mapped by extending the filter if needed.
+

package.json

@@ -9,7 +9,7 @@
     "build": "nest build",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
     "start": "nest start",
-    "start:dev": "nest start --watch",
+    "start:dev": "NODE_ENV=local nest start --watch",
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/main",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",

src/auth/auth.controller.ts

@@ -17,7 +17,7 @@ export class AuthController {
     summary: 'Google authentication',
     description: 'Authenticate a user using a Google ID token and optional buildType.',
     bodyType: GoogleAuthInput,
-  envelope: true,
+    envelope: true,
     responses: [
       { status: 200, description: 'Authenticated successfully.' },
       { status: 400, description: 'ID token missing or invalid.' },

src/jobs/job.controller.ts

@@ -94,8 +94,8 @@ export class JobController {
     summary: 'Get jobs by company',
     description: 'Retrieves all job listings for a specific company',
     pathParamsFrom: CompanyPathParamsDto,
-  paginatedResponseType: JobDto,
-  envelope: true,
+    paginatedResponseType: JobDto,
+    envelope: true,
     queriesFrom: [PaginationArgs],
   })
   async findByCompany(
@@ -125,8 +125,8 @@ export class JobController {
     summary: 'Get jobs by tag',
     description: 'Retrieves all job listings that have a specific tag',
     pathParamsFrom: TagPathParamsDto,
-  paginatedResponseType: JobDto,
-  envelope: true,
+    paginatedResponseType: JobDto,
+    envelope: true,
     queriesFrom: [PaginationArgs],
   })
   async findByTag(
@@ -176,8 +176,8 @@ export class JobController {
   @Api({
     summary: 'Get all job listings',
     description: 'Retrieves a paginated list of job listings with optional filtering',
-  paginatedResponseType: JobDto,
-  envelope: true,
+    paginatedResponseType: JobDto,
+    envelope: true,
     queriesFrom: [PaginationArgs, JobFilterQueryDto],
   })
   async findAll(

src/jobs/job.service.ts

@@ -332,7 +332,7 @@ export class JobService {
       console.log(`First job ID: ${jobs[0].id}, Last job ID: ${jobs[jobs.length - 1].id}`);
     }
 
-  return buildPaginatedResult({ items: jobs, skip, take, totalCount, meta: null });
+    return buildPaginatedResult({ items: jobs, skip, take, totalCount, meta: null });
   }
 
   /**
@@ -517,7 +517,7 @@ export class JobService {
       this.prisma.job.count({ where }),
     ]);
 
-  return buildPaginatedResult({ items: jobs, skip, take, totalCount, meta: { company } });
+    return buildPaginatedResult({ items: jobs, skip, take, totalCount, meta: { company } });
   }
 
   /**
@@ -569,7 +569,7 @@ export class JobService {
       this.prisma.job.count({ where }),
     ]);
 
-  return buildPaginatedResult({ items: jobs, skip, take, totalCount, meta: { tag } });
+    return buildPaginatedResult({ items: jobs, skip, take, totalCount, meta: { tag } });
   }
 
   /**

src/metadata.ts

@@ -14,7 +14,7 @@ export class NotificationsController {
   @Api({
     summary: 'Get VAPID public key',
     description: 'Returns the Web Push VAPID public key for browser clients.',
-  envelope: true,
+    envelope: true,
     responses: [{ status: 200, description: 'Public key returned.' }],
   })
   getPublicKey() {
@@ -27,7 +27,7 @@ export class NotificationsController {
     summary: 'Create or update push subscription',
     description: 'Stores (upserts) a Web Push or FCM subscription tied to the client.',
     bodyType: CreateSubscriptionDto,
-  envelope: true,
+    envelope: true,
     responses: [
       { status: 201, description: 'Subscription stored.' },
       { status: 400, description: 'Invalid subscription payload.' },
@@ -43,7 +43,7 @@ export class NotificationsController {
     summary: 'Send a mass notification',
     description: 'Sends a notification to all stored subscriptions.',
     bodyType: MassNotificationDto,
-  envelope: true,
+    envelope: true,
     responses: [
       { status: 200, description: 'Mass notification request accepted.' },
       { status: 400, description: 'Invalid notification payload.' },