Merge pull request #5 from StatelessStudio/v1.2.1

V1.2.1

Author: DrewImm

README.md

@@ -212,24 +212,26 @@ For the complete list of error classes, usage examples, and custom error creatio
 
 ## Validation & Sanitization
 
-api-machine supports request validation and sanitization using [valsan](https://www.npmjs.com/package/valsan). You can declare ObjectSanitizer members on your endpoint classes for `body`, `query`, `params`, or `headers`:
+api-machine supports request validation and sanitization using [valsan](https://www.npmjs.com/package/valsan). You can declare ObjectValSan members on your endpoint classes for `body`, `query`, `params`, or `headers`:
 
 ```typescript
-import { ObjectSanitizer, EmailValidator } from 'valsan';
+import { ObjectValSan, EmailValidator } from 'valsan';
 import { NameValSan } from './examples/complete-example/users/name-valsan';
 
 class CreateUserEndpoint extends PostEndpoint {
-  override path = '/users';
+	override path = '/users';
 
-  override body = new ObjectSanitizer({
-    name: new NameValSan(),
-    email: new EmailValidator(),
-  });
+	override body = new ObjectValSan({
+		schema: {
+			name: new NameValSan(),
+			email: new EmailValidator(),
+		}
+	});
 
-  async handle(request, response) {
-    // request.body is validated & sanitized
-    // ...
-  }
+	async handle(request, response) {
+		// request.body is validated & sanitized
+		// ...
+	}
 }
 ```
 

examples/complete-example/users/create-user-endpoint.ts

@@ -1,6 +1,6 @@
 import { ApiRequest, ApiResponse, PostEndpoint } from '../../../src/index';
 import { usersRepo, User } from './users-repository';
-import { ObjectSanitizer, EmailValidator, IntegerValidator } from 'valsan';
+import { ObjectValSan, EmailValidator, IntegerValidator } from 'valsan';
 import { NameValSan } from './name-valsan';
 
 /**
@@ -16,9 +16,11 @@ export class CreateUserEndpoint extends PostEndpoint {
 		email: 'john@example.com',
 	};
 
-	override body = new ObjectSanitizer({
-		name: new NameValSan(),
-		email: new EmailValidator(),
+	override body = new ObjectValSan({
+		schema: {
+			name: new NameValSan(),
+			email: new EmailValidator(),
+		},
 	});
 
 	override responseExample = {
@@ -28,10 +30,12 @@ export class CreateUserEndpoint extends PostEndpoint {
 		created: new Date(),
 	};
 
-	override response = new ObjectSanitizer({
-		id: new IntegerValidator(),
-		name: new NameValSan(),
-		email: new EmailValidator(),
+	override response = new ObjectValSan({
+		schema: {
+			id: new IntegerValidator(),
+			name: new NameValSan(),
+			email: new EmailValidator(),
+		},
 	});
 
 	async handle(request: ApiRequest, response: ApiResponse) {

examples/complete-example/users/get-user-endpoint.ts

@@ -1,7 +1,7 @@
 import { ApiRequest, ApiResponse, GetEndpoint } from '../../../src/index';
 import { NotFoundError } from '../../../src/error';
 import { usersRepo } from './users-repository';
-import { ObjectSanitizer, IntegerValidator, EmailValidator } from 'valsan';
+import { IntegerValidator, EmailValidator, ObjectValSan } from 'valsan';
 import { NameValSan } from './name-valsan';
 
 /**
@@ -20,10 +20,12 @@ export class GetUserEndpoint extends GetEndpoint {
 		created: new Date('2023-01-01'),
 	};
 
-	override response = new ObjectSanitizer({
-		id: new IntegerValidator(),
-		name: new NameValSan(),
-		email: new EmailValidator(),
+	override response = new ObjectValSan({
+		schema: {
+			id: new IntegerValidator(),
+			name: new NameValSan(),
+			email: new EmailValidator(),
+		},
 	});
 
 	async handle(request: ApiRequest, response: ApiResponse) {

examples/complete-example/users/list-users-endpoint.ts

@@ -1,7 +1,7 @@
 import {
 	ComposedValSan,
 	LengthValidator,
-	ObjectSanitizer,
+	ObjectValSan,
 	TrimSanitizer,
 } from 'valsan';
 import { ApiRequest, ApiResponse, GetEndpoint } from '../../../src/index';
@@ -16,15 +16,17 @@ import { usersRepo } from './users-repository';
 export class ListUsersEndpoint extends GetEndpoint {
 	override path = '/';
 
-	override params = new ObjectSanitizer({
-		name: new ComposedValSan(
-			[new TrimSanitizer(), new LengthValidator({ minLength: 3 })],
-			{ isOptional: true }
-		),
-		email: new ComposedValSan(
-			[new TrimSanitizer(), new LengthValidator({ minLength: 5 })],
-			{ isOptional: true }
-		),
+	override params = new ObjectValSan({
+		schema: {
+			name: new ComposedValSan(
+				[new TrimSanitizer(), new LengthValidator({ minLength: 3 })],
+				{ isOptional: true }
+			),
+			email: new ComposedValSan(
+				[new TrimSanitizer(), new LengthValidator({ minLength: 5 })],
+				{ isOptional: true }
+			),
+		},
 	});
 
 	async handle(request: ApiRequest, response: ApiResponse) {