Merge branch 'main' into copilot/add-reddit-messages-folder

Author: digitalnomad91

.github/copilot-instructions.md

@@ -0,0 +1,98 @@
+# Copilot Instructions for codebuilder-api
+
+## Project Overview
+
+This is **codebuilder-api**, a NestJS backend API built with TypeScript. It uses Prisma as the ORM (schema maintained in a Git submodule at `prisma/`), Redis for caching and queues, PostgreSQL for the database, and is deployed via Docker.
+
+## Tech Stack
+
+- **Runtime:** Node.js v22 with pnpm as the package manager
+- **Framework:** NestJS 11 with Express adapter
+- **Language:** TypeScript (ES2023 target, ESNext modules, bundler resolution)
+- **ORM:** Prisma with auto-generated DTOs via `@vegardit/prisma-generator-nestjs-dto`
+- **Build:** SWC compiler (configured in `nest-cli.json`)
+- **Testing:** Jest with ts-jest; E2E tests use Supertest
+- **Linting:** ESLint (flat config) with TypeScript-ESLint and Prettier integration
+- **Formatting:** Prettier (140 print width, single quotes, trailing commas ES5, 2-space indent)
+
+## Project Structure
+
+```
+src/
+├── auth/            # Authentication (JWT, Google OAuth)
+├── cloudflare-kv/   # Cloudflare KV integration
+├── common/          # Shared infrastructure
+│   ├── configs/     # Configuration service
+│   ├── database/    # Prisma database module
+│   ├── decorators/  # Custom decorators (@Api, @User, @Field)
+│   ├── filters/     # Exception filters
+│   ├── helpers/     # Utility functions
+│   ├── interceptors/# Response interceptors
+│   ├── logger/      # Logging service
+│   ├── models/      # Common response models
+│   ├── pagination/  # Pagination utilities
+│   ├── queue/       # BullMQ job queue
+│   ├── redis/       # Redis module and providers
+│   └── validation/  # Custom validators
+├── errors/          # Error reporting
+├── events/          # WebSocket events gateway
+├── generated/       # Auto-generated Prisma DTOs (do not edit)
+├── jobs/            # Job management
+├── location/        # Location services
+├── notifications/   # Push notifications (Firebase)
+├── users/           # User management
+└── wss/             # WebSocket support
+```
+
+## Coding Conventions
+
+### File Naming
+
+- Controllers: `{name}.controller.ts`
+- Services: `{name}.service.ts`
+- Modules: `{name}.module.ts`
+- DTOs: `{operation}-{entity}.dto.ts` (e.g., `create-job.dto.ts`)
+- Filters: `{name}.filter.ts`
+- Guards: `{name}.guard.ts`
+- Interceptors: `{name}.interceptor.ts`
+- Decorators: `{name}.decorator.ts`
+
+### Imports
+
+Use the `@/` path alias for imports from the `src/` directory:
+
+```typescript
+import { Api } from '@/common/decorators/api.decorator';
+import { NotificationsService } from '@/notifications/notifications.service';
+```
+
+### API Patterns
+
+- Use the custom `@Api()` decorator for controller methods to configure Swagger docs, response types, and the response envelope.
+- Endpoints using `@Api({ envelope: true })` return `{ "success": true, "data": <payload> }`.
+- Paginated endpoints use `paginatedResponseType` and return items with `pageInfo` metadata. Use `buildPaginatedResult()` in services.
+- DTO properties use `@Field({ inQuery: true })` or `@Field({ inPath: true })` for automatic Swagger parameter generation.
+- Throw standard NestJS `HttpException` subclasses for error handling.
+
+### Validation
+
+- Use `class-validator` and `class-transformer` decorators on DTOs for input validation.
+- The global `ValidationPipe` is configured with `whitelist: true` and `transform: true`.
+
+## Important Notes
+
+- **Do not edit files in `src/generated/`** — these are auto-generated from the Prisma schema using `npx prisma generate`.
+- **The Prisma schema is a Git submodule** at `prisma/`. Schema changes should be made in the `codebuilderinc/codebuilder-prisma` repository.
+- The project uses Prettier for formatting; run `pnpm format` to format code or `pnpm lint` to lint and auto-fix.
+
+## Common Commands
+
+```bash
+pnpm install          # Install dependencies
+pnpm build            # Build the project
+pnpm dev              # Start in development/watch mode (NODE_ENV=local)
+pnpm lint             # Lint and auto-fix
+pnpm format           # Format code with Prettier
+pnpm test             # Run unit tests
+pnpm test:e2e         # Run end-to-end tests
+```

src/auth/auth.service.ts

@@ -1,12 +1,6 @@
 import { PrismaService } from 'nestjs-prisma';
 import { Prisma, User } from '@prisma/client';
-import {
-  Injectable,
-  NotFoundException,
-  BadRequestException,
-  ConflictException,
-  UnauthorizedException,
-} from '@nestjs/common';
+import { Injectable, NotFoundException, BadRequestException, ConflictException, UnauthorizedException } from '@nestjs/common';
 import { JwtService } from '@nestjs/jwt';
 import { PasswordService } from './password.service';
 import { SignupInput } from './dto/signup.input';
@@ -202,8 +196,7 @@ export class AuthService {
   async googleAuth(idToken: string, buildType?: string): Promise<Token> {
     try {
       // Determine which client ID to use based on build type
-      const clientId =
-        buildType === 'development' ? process.env.GOOGLE_WEB_CLIENT_ID_DEV : process.env.GOOGLE_WEB_CLIENT_ID;
+      const clientId = buildType === 'development' ? process.env.GOOGLE_WEB_CLIENT_ID_DEV : process.env.GOOGLE_WEB_CLIENT_ID;
 
       if (!clientId) {
         console.error(`Missing Google OAuth client ID for build type: ${buildType}`);

src/common/database/database.service.ts

@@ -35,9 +35,7 @@ export class DatabaseService extends PrismaClient implements OnModuleInit, OnMod
       //   },
       // ]
     });
-    this.logger.info(
-      `Using Prisma v${Prisma.prismaVersion.client} ${configService.get('DATABASE_URL').replace(/:[^:]*@/, ':***@')}`
-    );
+    this.logger.info(`Using Prisma v${Prisma.prismaVersion.client} ${configService.get('DATABASE_URL').replace(/:[^:]*@/, ':***@')}`);
 
     /* this.meter = meterProvider.getMeter('example-exporter-collector');
 

src/common/decorators/api.decorator.ts

@@ -1,4 +1,4 @@
-import {applyDecorators, Type as NestType} from '@nestjs/common';
+import { applyDecorators, Type as NestType } from '@nestjs/common';
 import {
   ApiOperation,
   ApiUnauthorizedResponse,
@@ -241,7 +241,7 @@ export function Api(options: ApiOptions): MethodDecorator {
 
     // Add request body documentation if bodyType is specified
     if (options.bodyType) {
-      decorators.push(ApiBody({type: options.bodyType}));
+      decorators.push(ApiBody({ type: options.bodyType }));
     }
 
     // ============================================================================
@@ -348,22 +348,22 @@ export function Api(options: ApiOptions): MethodDecorator {
               schema: {
                 type: 'object',
                 properties: {
-                  success: {type: 'boolean', example: true},
-                  data: {$ref: getSchemaPath(options.responseType)},
+                  success: { type: 'boolean', example: true },
+                  data: { $ref: getSchemaPath(options.responseType) },
                 },
               },
             })
           );
         } else {
           // Direct response without envelope
-          decorators.push(ApiResponse({status: 200, description: 'Successful response', type: options.responseType}));
+          decorators.push(ApiResponse({ status: 200, description: 'Successful response', type: options.responseType }));
         }
       }
       // Array response
       else if (options.responseArrayType) {
         const arraySchema = {
           type: 'array',
-          items: {$ref: getSchemaPath(options.responseArrayType)},
+          items: { $ref: getSchemaPath(options.responseArrayType) },
         };
         if (options.envelope) {
           // Wrapped in envelope: { success: true, data: [...] }
@@ -374,7 +374,7 @@ export function Api(options: ApiOptions): MethodDecorator {
               schema: {
                 type: 'object',
                 properties: {
-                  success: {type: 'boolean', example: true},
+                  success: { type: 'boolean', example: true },
                   data: arraySchema,
                 },
               },
@@ -398,18 +398,18 @@ export function Api(options: ApiOptions): MethodDecorator {
           properties: {
             items: {
               type: 'array',
-              items: {$ref: getSchemaPath(options.paginatedResponseType)},
+              items: { $ref: getSchemaPath(options.paginatedResponseType) },
             },
             pageInfo: {
               type: 'object',
               properties: {
-                hasNextPage: {type: 'boolean'},
-                hasPreviousPage: {type: 'boolean'},
-                startCursor: {type: 'string', nullable: true},
-                endCursor: {type: 'string', nullable: true},
+                hasNextPage: { type: 'boolean' },
+                hasPreviousPage: { type: 'boolean' },
+                startCursor: { type: 'string', nullable: true },
+                endCursor: { type: 'string', nullable: true },
               },
             },
-            totalCount: {type: 'number'},
+            totalCount: { type: 'number' },
             meta: {
               type: 'object',
               additionalProperties: true,
@@ -427,7 +427,7 @@ export function Api(options: ApiOptions): MethodDecorator {
               schema: {
                 type: 'object',
                 properties: {
-                  success: {type: 'boolean', example: true},
+                  success: { type: 'boolean', example: true },
                   data: basePaginated,
                 },
               },
@@ -451,14 +451,14 @@ export function Api(options: ApiOptions): MethodDecorator {
     // ============================================================================
     // Add default error responses (401, 201, 403) if user hasn't provided custom responses
     if (addDefaultSet) {
-      decorators.push(ApiUnauthorizedResponse({description: 'Unauthorized'}));
-      decorators.push(ApiCreatedResponse({description: 'The record has been successfully created.'}));
-      decorators.push(ApiForbiddenResponse({description: 'Forbidden.'}));
+      decorators.push(ApiUnauthorizedResponse({ description: 'Unauthorized' }));
+      decorators.push(ApiCreatedResponse({ description: 'The record has been successfully created.' }));
+      decorators.push(ApiForbiddenResponse({ description: 'Forbidden.' }));
     } else {
       // If user provided custom responses, ensure 401 is still added for authenticated endpoints
       let has401 = userProvidedResponses.some((r) => r.status === 401);
       if (options.authenticationRequired && !has401) {
-        decorators.push(ApiUnauthorizedResponse({description: 'Unauthorized'}));
+        decorators.push(ApiUnauthorizedResponse({ description: 'Unauthorized' }));
         has401 = true;
       }
     }

src/common/decorators/field.decorator.ts

@@ -15,8 +15,8 @@ import {
   MaxLength,
   ValidationOptions,
 } from 'class-validator';
-import {pick} from './../../common/helpers/array.helper';
-import {ApiProperty, ApiPropertyOptional} from '@nestjs/swagger';
+import { pick } from './../../common/helpers/array.helper';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 import ValidatorJS from 'validator';
 
 type FieldOptions = {
@@ -29,16 +29,16 @@ type FieldOptions = {
   nullable?: boolean; // kept for backwards compat; implies optional
   minLength?: number;
   maxLength?: number;
-  isEnum?: {entity: object; validationOptions?: ValidationOptions};
+  isEnum?: { entity: object; validationOptions?: ValidationOptions };
   isString?: ValidationOptions;
   isEthereumAddress?: ValidationOptions;
-  isDecimal?: {options?: ValidatorJS.IsDecimalOptions; validationOptions: ValidationOptions};
+  isDecimal?: { options?: ValidatorJS.IsDecimalOptions; validationOptions: ValidationOptions };
   isBoolean?: ValidationOptions;
   isInt?: ValidationOptions;
-  isBigInt?: {message: string};
-  isHash?: {algorithm: string; validationOptions: ValidationOptions};
+  isBigInt?: { message: string };
+  isHash?: { algorithm: string; validationOptions: ValidationOptions };
   isUrl?: ValidationOptions;
-  pattern?: {regex: RegExp; message?: string};
+  pattern?: { regex: RegExp; message?: string };
   isArray?: boolean;
   inQuery?: boolean; // mark field as query parameter candidate
   inPath?: boolean; // mark field as path parameter candidate
@@ -68,11 +68,11 @@ export function Field(options: FieldOptions) {
     if (!required) {
       IsOptional()(target, propertyKey);
     } else {
-      IsNotEmpty({message: options.name + ': Value is required.'})(target, propertyKey);
+      IsNotEmpty({ message: options.name + ': Value is required.' })(target, propertyKey);
     }
 
     if (options.isEnum) {
-      IsEnum(options.isEnum.entity, options.isEnum.validationOptions || {message: options.name + ': Invalid enum value.'})(
+      IsEnum(options.isEnum.entity, options.isEnum.validationOptions || { message: options.name + ': Invalid enum value.' })(
         target,
         propertyKey
       );
@@ -84,10 +84,10 @@ export function Field(options: FieldOptions) {
     if (options.isDecimal) IsDecimal(options.isDecimal.options, options.isDecimal.validationOptions)(target, propertyKey);
     if (options.isBoolean) IsBoolean(options.isBoolean)(target, propertyKey);
     if (options.isInt) IsInt(options.isInt)(target, propertyKey);
-    if (options.isBigInt) IsInt({message: options.isBigInt.message})(target, propertyKey);
+    if (options.isBigInt) IsInt({ message: options.isBigInt.message })(target, propertyKey);
     if (options.isHash) IsHash(options.isHash.algorithm, options.isHash.validationOptions)(target, propertyKey);
     if (options.isUrl) IsUrl(undefined, options.isUrl)(target, propertyKey);
-    if (options.pattern) Matches(options.pattern.regex, {message: options.pattern.message})(target, propertyKey);
+    if (options.pattern) Matches(options.pattern.regex, { message: options.pattern.message })(target, propertyKey);
     if (options.isArray) IsArray()(target, propertyKey);
 
     // Persist metadata on the class constructor so @Api decorator can build params/queries automatically

src/common/helpers/array.helper.ts

@@ -23,7 +23,7 @@ export function reduceToObject<T>(array: T[], key: string): { [K: string]: T } {
 export function groupBy<T>(array: T[], key: string): { [key: string]: T[] } {
   return array.reduce(
     (acc, curr) => {
-      if (!acc.hasOwnProperty(curr[key])) {
+      if (!Object.prototype.hasOwnProperty.call(acc, curr[key])) {
         acc[curr[key]] = [];
       }
 

src/common/helpers/req.helper.ts

@@ -55,7 +55,7 @@ export function getOrigin(req: Request) {
   const origin = req.headers.origin;
 
   if (!origin || typeof origin === 'string') {
-    return origin as string;
+    return origin;
   }
 
   return origin[0];

src/common/validation/is-generic-type.decorator.ts

@@ -30,9 +30,7 @@ export const IsGenericType = (
       name: 'IS_GENERIC_TYPE',
       validator: {
         validate: (value: unknown) => {
-          return validators.some((item) =>
-            typeof item === 'function' ? item(value) : InnerTypesValidator[item]?.(value)
-          );
+          return validators.some((item) => (typeof item === 'function' ? item(value) : InnerTypesValidator[item]?.(value)));
         },
         defaultMessage: (validationArguments?: ValidationArguments) => {
           return `${validationArguments?.property}: Data type mismatch`;

src/common/validation/is-unique-constraint.decorator.ts

@@ -21,12 +21,7 @@ export class IsUniqueConstraint implements ValidatorConstraintInterface {
   async validate(value: string, args: ValidationArguments) {
     const [entity, column] = args.constraints;
 
-    let result = await this.prisma.$queryRawUnsafe(
-      `SELECT * FROM $1 WHERE $2 = $3 WHERE LIMIT 1`,
-      entity,
-      column,
-      value
-    );
+    const result = await this.prisma.$queryRawUnsafe(`SELECT * FROM $1 WHERE $2 = $3 WHERE LIMIT 1`, entity, column, value);
 
     if (result) {
       return false;
@@ -40,7 +35,7 @@ export class IsUniqueConstraint implements ValidatorConstraintInterface {
   }
 }
 
-export function IsUnique(entity: Function, column: string, validationOptions?: ValidationOptions) {
+export function IsUnique(entity: { new (): any }, column: string, validationOptions?: ValidationOptions) {
   return (object: object, propertyName: string) => {
     registerDecorator({
       target: object.constructor,

src/generated/nestjs-dto/company.entity.ts

@@ -1,10 +1,8 @@
-
-import {Job} from './job.entity'
-
+import { Job } from './job.entity';
 
 export class Company {
-  id: number ;
-name: string ;
-jobs?: Job[] ;
-createdAt: Date ;
+  id: number;
+  name: string;
+  jobs?: Job[];
+  createdAt: Date;
 }