@dismissible/nestjs-validation 0.0.1

package/README.md

@@ -0,0 +1,206 @@
+# @dismissible/nestjs-validation
+
+A validation service for NestJS applications using class-validator and class-transformer.
+
+> **Part of the Dismissible API** - This library is part of the [Dismissible API](https://dismissible.io) ecosystem. Visit [dismissible.io](https://dismissible.io) for more information and documentation.
+
+## Overview
+
+This library provides a `ValidationService` that wraps `class-validator` and `class-transformer` to provide a consistent validation API for DTOs and class instances in NestJS applications.
+
+## Installation
+
+```bash
+npm install @dismissible/nestjs-validation
+```
+
+You'll also need to install the peer dependencies:
+
+```bash
+npm install class-validator class-transformer
+```
+
+## Getting Started
+
+### Basic Setup
+
+```typescript
+import { Module } from '@nestjs/common';
+import { ValidationModule } from '@dismissible/nestjs-validation';
+
+@Module({
+  imports: [ValidationModule],
+})
+export class AppModule {}
+```
+
+### Validating DTOs
+
+The `ValidationService` can validate plain objects against DTO classes:
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { ValidationService } from '@dismissible/nestjs-validation';
+import { IsString, IsEmail, IsOptional } from 'class-validator';
+
+class CreateUserDto {
+  @IsString()
+  name!: string;
+
+  @IsEmail()
+  email!: string;
+
+  @IsOptional()
+  @IsString()
+  phone?: string;
+}
+
+@Injectable()
+export class UserService {
+  constructor(private readonly validationService: ValidationService) {}
+
+  async createUser(data: unknown) {
+    // Validates and transforms the data, throws BadRequestException if invalid
+    const dto = await this.validationService.validateDto(CreateUserDto, data);
+
+    // dto is now a validated instance of CreateUserDto
+    // Use dto.name, dto.email, etc.
+  }
+}
+```
+
+### Validating Existing Instances
+
+You can also validate class instances that have already been created:
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { ValidationService } from '@dismissible/nestjs-validation';
+import { IsString, IsDate } from 'class-validator';
+
+class MyDto {
+  @IsString()
+  name!: string;
+
+  @IsDate()
+  createdAt!: Date;
+}
+
+@Injectable()
+export class MyService {
+  constructor(private readonly validationService: ValidationService) {}
+
+  async validateInstance(dto: MyDto) {
+    // Validates the instance, throws BadRequestException if invalid
+    await this.validationService.validateInstance(dto);
+  }
+}
+```
+
+### Error Handling
+
+The validation service throws `BadRequestException` with formatted error messages when validation fails:
+
+```typescript
+import { BadRequestException } from '@nestjs/common';
+import { ValidationService } from '@dismissible/nestjs-validation';
+
+@Injectable()
+export class MyService {
+  constructor(private readonly validationService: ValidationService) {}
+
+  async handleRequest(data: unknown) {
+    try {
+      const dto = await this.validationService.validateDto(MyDto, data);
+      // Process valid data
+    } catch (error) {
+      if (error instanceof BadRequestException) {
+        // Handle validation errors
+        console.error('Validation failed:', error.message);
+      }
+      throw error;
+    }
+  }
+}
+```
+
+## API Reference
+
+### ValidationService
+
+#### `validateDto<T>(dtoClass, data): Promise<T>`
+
+Validates and transforms plain data into a DTO instance.
+
+**Parameters:**
+
+- `dtoClass: ClassConstructor<T>` - The DTO class to validate against
+- `data: unknown` - The data to validate
+
+**Returns:** `Promise<T>` - A validated instance of the DTO class
+
+**Throws:** `BadRequestException` if validation fails
+
+#### `validateInstance<T>(instance): Promise<void>`
+
+Validates an existing class instance.
+
+**Parameters:**
+
+- `instance: T` - The instance to validate
+
+**Throws:** `BadRequestException` if validation fails
+
+### ValidationModule
+
+A NestJS module that provides `ValidationService` as a singleton.
+
+**Exports:**
+
+- `ValidationService` - The validation service
+
+## Features
+
+- Automatic transformation using `class-transformer`
+- Validation using `class-validator` decorators
+- Nested validation error extraction
+- Formatted error messages
+- Type-safe DTOs with TypeScript generics
+
+## Example: Using in a Controller
+
+```typescript
+import { Controller, Post, Body } from '@nestjs/common';
+import { ValidationService } from '@dismissible/nestjs-validation';
+import { IsString, IsEmail } from 'class-validator';
+
+class CreateUserDto {
+  @IsString()
+  name!: string;
+
+  @IsEmail()
+  email!: string;
+}
+
+@Controller('users')
+export class UserController {
+  constructor(private readonly validationService: ValidationService) {}
+
+  @Post()
+  async create(@Body() body: unknown) {
+    const dto = await this.validationService.validateDto(CreateUserDto, body);
+    // Use validated dto
+    return { message: `Creating user: ${dto.name}` };
+  }
+}
+```
+
+## Related Packages
+
+This validation service is used by:
+
+- `@dismissible/nestjs-dismissible` - Validates dismissible items
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@dismissible/nestjs-validation",
+  "version": "0.0.1",
+  "description": "Validation service module for NestJS applications using class-validator and class-transformer",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./src/index.mjs",
+      "require": "./src/index.js",
+      "types": "./src/index.d.ts"
+    }
+  },
+  "files": [
+    "src",
+    "README.md"
+  ],
+  "dependencies": {},
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.0",
+    "class-validator": "^0.14.0",
+    "class-transformer": "^0.5.0",
+    "reflect-metadata": "^0.2.2"
+  },
+  "peerDependenciesMeta": {
+    "@nestjs/common": {
+      "optional": false
+    },
+    "class-validator": {
+      "optional": false
+    },
+    "class-transformer": {
+      "optional": false
+    },
+    "reflect-metadata": {
+      "optional": false
+    }
+  },
+  "keywords": [
+    "nestjs",
+    "validation",
+    "class-validator",
+    "class-transformer",
+    "dto"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DismissibleIo/dismissible-api"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs"
+}

package/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from './validation.service';
+export * from './validation.module';
+export * from './transform-boolean.decorator';
+export * from './transform-comma-separated.decorator';

package/src/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./validation.service"), exports);
+tslib_1.__exportStar(require("./validation.module"), exports);
+tslib_1.__exportStar(require("./transform-boolean.decorator"), exports);
+tslib_1.__exportStar(require("./transform-comma-separated.decorator"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../libs/validation/src/index.ts"],"names":[],"mappings":";;;AAAA,+DAAqC;AACrC,8DAAoC;AACpC,wEAA8C;AAC9C,gFAAsD"}

package/src/transform-boolean.decorator.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Transforms string values to boolean, preserving existing boolean values.
+ * Useful for environment variable configuration where boolean values may be passed as strings.
+ *
+ * @param defaultValue - Optional default value to return if the value is not a boolean or string.
+ *                       If not provided, the original value is returned unchanged.
+ *
+ * @example
+ * ```typescript
+ * class Config {
+ *   @IsBoolean()
+ *   @TransformBoolean()
+ *   enabled!: boolean;
+ * }
+ * ```
+ */
+export declare function TransformBoolean(defaultValue?: boolean): PropertyDecorator;

package/src/transform-boolean.decorator.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransformBoolean = TransformBoolean;
+const class_transformer_1 = require("class-transformer");
+/**
+ * Transforms string values to boolean, preserving existing boolean values.
+ * Useful for environment variable configuration where boolean values may be passed as strings.
+ *
+ * @param defaultValue - Optional default value to return if the value is not a boolean or string.
+ *                       If not provided, the original value is returned unchanged.
+ *
+ * @example
+ * ```typescript
+ * class Config {
+ *   @IsBoolean()
+ *   @TransformBoolean()
+ *   enabled!: boolean;
+ * }
+ * ```
+ */
+function TransformBoolean(defaultValue) {
+    return (0, class_transformer_1.Transform)(({ value }) => {
+        if (typeof value === 'boolean') {
+            return value;
+        }
+        if (typeof value === 'string') {
+            return value.toLowerCase() === 'true';
+        }
+        return defaultValue !== undefined ? defaultValue : value;
+    });
+}
+//# sourceMappingURL=transform-boolean.decorator.js.map

package/src/transform-boolean.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform-boolean.decorator.js","sourceRoot":"","sources":["../../../../libs/validation/src/transform-boolean.decorator.ts"],"names":[],"mappings":";;AAkBA,4CAUC;AA5BD,yDAA8C;AAE9C;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,gBAAgB,CAAC,YAAsB;IACrD,OAAO,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QAC7B,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAC;QACf,CAAC;QACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;QACxC,CAAC;QACD,OAAO,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC;IAC3D,CAAC,CAAC,CAAC;AACL,CAAC"}

package/src/transform-comma-separated.decorator.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Transforms a comma-separated string into an array of trimmed strings.
+ * If the value is already an array, it is returned as-is.
+ *
+ * @example
+ * // Input: "GET,POST,DELETE" → Output: ["GET", "POST", "DELETE"]
+ * // Input: "a , b , c" → Output: ["a", "b", "c"]
+ * // Input: ["a", "b"] → Output: ["a", "b"]
+ */
+export declare function TransformCommaSeparated(): PropertyDecorator;

package/src/transform-comma-separated.decorator.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransformCommaSeparated = TransformCommaSeparated;
+const class_transformer_1 = require("class-transformer");
+/**
+ * Transforms a comma-separated string into an array of trimmed strings.
+ * If the value is already an array, it is returned as-is.
+ *
+ * @example
+ * // Input: "GET,POST,DELETE" → Output: ["GET", "POST", "DELETE"]
+ * // Input: "a , b , c" → Output: ["a", "b", "c"]
+ * // Input: ["a", "b"] → Output: ["a", "b"]
+ */
+function TransformCommaSeparated() {
+    return (0, class_transformer_1.Transform)(({ value }) => typeof value === 'string' ? value.split(',').map((s) => s.trim()) : value);
+}
+//# sourceMappingURL=transform-comma-separated.decorator.js.map

package/src/transform-comma-separated.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform-comma-separated.decorator.js","sourceRoot":"","sources":["../../../../libs/validation/src/transform-comma-separated.decorator.ts"],"names":[],"mappings":";;AAWA,0DAIC;AAfD,yDAA8C;AAE9C;;;;;;;;GAQG;AACH,SAAgB,uBAAuB;IACrC,OAAO,IAAA,6BAAS,EAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAC7B,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAC1E,CAAC;AACJ,CAAC"}

package/src/validation.module.d.ts

@@ -0,0 +1,2 @@
+export declare class ValidationModule {
+}

package/src/validation.module.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationModule = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const validation_service_1 = require("./validation.service");
+let ValidationModule = class ValidationModule {
+};
+exports.ValidationModule = ValidationModule;
+exports.ValidationModule = ValidationModule = tslib_1.__decorate([
+    (0, common_1.Module)({
+        providers: [validation_service_1.ValidationService],
+        exports: [validation_service_1.ValidationService],
+    })
+], ValidationModule);
+//# sourceMappingURL=validation.module.js.map

package/src/validation.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.module.js","sourceRoot":"","sources":["../../../../libs/validation/src/validation.module.ts"],"names":[],"mappings":";;;;AAAA,2CAAwC;AACxC,6DAAyD;AAMlD,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;CAAG,CAAA;AAAnB,4CAAgB;2BAAhB,gBAAgB;IAJ5B,IAAA,eAAM,EAAC;QACN,SAAS,EAAE,CAAC,sCAAiB,CAAC;QAC9B,OAAO,EAAE,CAAC,sCAAiB,CAAC;KAC7B,CAAC;GACW,gBAAgB,CAAG"}

package/src/validation.service.d.ts

@@ -0,0 +1,7 @@
+import { ClassConstructor } from 'class-transformer';
+export declare class ValidationService {
+    validateDto<T extends object>(dtoClass: ClassConstructor<T>, data: unknown): Promise<T>;
+    validateInstance<T extends object>(instance: T): Promise<void>;
+    private formatValidationErrors;
+    private extractErrorMessage;
+}

package/src/validation.service.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationService = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const class_validator_1 = require("class-validator");
+const class_transformer_1 = require("class-transformer");
+let ValidationService = class ValidationService {
+    async validateDto(dtoClass, data) {
+        if (data === null || data === undefined) {
+            throw new common_1.BadRequestException('Data cannot be null or undefined');
+        }
+        const dtoInstance = (0, class_transformer_1.plainToInstance)(dtoClass, data);
+        const validationErrors = await (0, class_validator_1.validate)(dtoInstance);
+        if (validationErrors.length > 0) {
+            const errorMessages = this.formatValidationErrors(validationErrors);
+            throw new common_1.BadRequestException(errorMessages);
+        }
+        return dtoInstance;
+    }
+    async validateInstance(instance) {
+        const validationErrors = await (0, class_validator_1.validate)(instance);
+        if (validationErrors.length > 0) {
+            const errorMessages = this.formatValidationErrors(validationErrors);
+            throw new common_1.BadRequestException(errorMessages);
+        }
+    }
+    formatValidationErrors(errors) {
+        return errors
+            .map((error) => this.extractErrorMessage(error))
+            .filter((message) => message.length > 0)
+            .join('; ');
+    }
+    extractErrorMessage(error) {
+        const messages = [];
+        if (error.constraints) {
+            messages.push(...Object.values(error.constraints));
+        }
+        if (error.children && error.children.length > 0) {
+            const childMessages = error.children
+                .map((child) => this.extractErrorMessage(child))
+                .filter((message) => message.length > 0);
+            messages.push(...childMessages);
+        }
+        return messages.join(', ');
+    }
+};
+exports.ValidationService = ValidationService;
+exports.ValidationService = ValidationService = tslib_1.__decorate([
+    (0, common_1.Injectable)()
+], ValidationService);
+//# sourceMappingURL=validation.service.js.map

package/src/validation.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.service.js","sourceRoot":"","sources":["../../../../libs/validation/src/validation.service.ts"],"names":[],"mappings":";;;;AAAA,2CAAiE;AACjE,qDAA4D;AAC5D,yDAAsE;AAG/D,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;IAC5B,KAAK,CAAC,WAAW,CAAmB,QAA6B,EAAE,IAAa;QAC9E,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACxC,MAAM,IAAI,4BAAmB,CAAC,kCAAkC,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,WAAW,GAAG,IAAA,mCAAe,EAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACpD,MAAM,gBAAgB,GAAG,MAAM,IAAA,0BAAQ,EAAC,WAAqB,CAAC,CAAC;QAE/D,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,MAAM,aAAa,GAAG,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;YACpE,MAAM,IAAI,4BAAmB,CAAC,aAAa,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAmB,QAAW;QAClD,MAAM,gBAAgB,GAAG,MAAM,IAAA,0BAAQ,EAAC,QAAkB,CAAC,CAAC;QAE5D,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,MAAM,aAAa,GAAG,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;YACpE,MAAM,IAAI,4BAAmB,CAAC,aAAa,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAEO,sBAAsB,CAAC,MAAyB;QACtD,OAAO,MAAM;aACV,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;aAC/C,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;aACvC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC;IAEO,mBAAmB,CAAC,KAAsB;QAChD,MAAM,QAAQ,GAAa,EAAE,CAAC;QAE9B,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;YACtB,QAAQ,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;QACrD,CAAC;QAED,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChD,MAAM,aAAa,GAAG,KAAK,CAAC,QAAQ;iBACjC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;iBAC/C,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAC3C,QAAQ,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAC;QAClC,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;CACF,CAAA;AAjDY,8CAAiB;4BAAjB,iBAAiB;IAD7B,IAAA,mBAAU,GAAE;GACA,iBAAiB,CAiD7B"}