api-machine 1.2.0 → 1.2.1

package/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
+		// ...
+	}
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "api-machine",
-	"version": "1.2.0",
+	"version": "1.2.1",
 	"description": "api-machine",
 	"typescript-template": {
 		"base": "1.0.1",

package/router/endpoints/health-check-endpoint.d.ts

@@ -1,4 +1,4 @@
-import { ObjectSanitizer } from 'valsan';
+import { ObjectValSan } from 'valsan';
 import { GetEndpoint } from './get-endpoint';
 export declare class HealthCheckEndpoint extends GetEndpoint {
     path: string;
@@ -8,7 +8,7 @@ export declare class HealthCheckEndpoint extends GetEndpoint {
         uptime: number;
         environment: string;
     };
-    response: ObjectSanitizer;
+    response: ObjectValSan;
     handle(): Promise<{
         status: string;
         timestamp: string;

package/router/endpoints/health-check-endpoint.js

@@ -11,11 +11,13 @@ class HealthCheckEndpoint extends get_endpoint_1.GetEndpoint {
         uptime: 12345,
         environment: 'development',
     };
-    response = new valsan_1.ObjectSanitizer({
-        status: new valsan_1.MinLengthValidator(),
-        timestamp: new valsan_1.Iso8601TimestampValSan(),
-        uptime: new valsan_1.StringToNumberValSan(),
-        environment: new valsan_1.MinLengthValidator(),
+    response = new valsan_1.ObjectValSan({
+        schema: {
+            status: new valsan_1.MinLengthValidator(),
+            timestamp: new valsan_1.Iso8601TimestampValSan(),
+            uptime: new valsan_1.StringToNumberValSan(),
+            environment: new valsan_1.MinLengthValidator(),
+        },
     });
     async handle() {
         return {

package/router/endpoints/health-check-endpoint.js.map

@@ -1 +1 @@
-{"version":3,"file":"health-check-endpoint.js","sourceRoot":"","sources":["../../../../src/router/endpoints/health-check-endpoint.ts"],"names":[],"mappings":";;;AAAA,mCAKgB;AAChB,iDAA6C;AAE7C,MAAa,mBAAoB,SAAQ,0BAAW;IAC1C,IAAI,GAAG,SAAS,CAAC;IAEjB,eAAe,GAAG;QAC1B,MAAM,EAAE,IAAI;QACZ,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,MAAM,EAAE,KAAK;QACb,WAAW,EAAE,aAAa;KAC1B,CAAC;IAEO,QAAQ,GAAG,IAAI,wBAAe,CAAC;QACvC,MAAM,EAAE,IAAI,2BAAkB,EAAE;QAChC,SAAS,EAAE,IAAI,+BAAsB,EAAE;QACvC,MAAM,EAAE,IAAI,6BAAoB,EAAE;QAClC,WAAW,EAAE,IAAI,2BAAkB,EAAE;KACrC,CAAC,CAAC;IAEH,KAAK,CAAC,MAAM;QACX,OAAO;YACN,MAAM,EAAE,MAAM,IAAI,CAAC,SAAS,EAAE;YAC9B,SAAS,EAAE,MAAM,IAAI,CAAC,YAAY,EAAE;YACpC,MAAM,EAAE,MAAM,IAAI,CAAC,SAAS,EAAE;YAC9B,WAAW,EAAE,MAAM,IAAI,CAAC,cAAc,EAAE;SACxC,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,SAAS;QACrB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,YAAY;QACxB,OAAO,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,SAAS;QACrB,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,cAAc;QAC1B,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,aAAa,CAAC;IACjD,CAAC;CACD;AAzCD,kDAyCC"}
+{"version":3,"file":"health-check-endpoint.js","sourceRoot":"","sources":["../../../../src/router/endpoints/health-check-endpoint.ts"],"names":[],"mappings":";;;AAAA,mCAKgB;AAChB,iDAA6C;AAE7C,MAAa,mBAAoB,SAAQ,0BAAW;IAC1C,IAAI,GAAG,SAAS,CAAC;IAEjB,eAAe,GAAG;QAC1B,MAAM,EAAE,IAAI;QACZ,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACnC,MAAM,EAAE,KAAK;QACb,WAAW,EAAE,aAAa;KAC1B,CAAC;IAEO,QAAQ,GAAG,IAAI,qBAAY,CAAC;QACpC,MAAM,EAAE;YACP,MAAM,EAAE,IAAI,2BAAkB,EAAE;YAChC,SAAS,EAAE,IAAI,+BAAsB,EAAE;YACvC,MAAM,EAAE,IAAI,6BAAoB,EAAE;YAClC,WAAW,EAAE,IAAI,2BAAkB,EAAE;SACrC;KACD,CAAC,CAAC;IAEH,KAAK,CAAC,MAAM;QACX,OAAO;YACN,MAAM,EAAE,MAAM,IAAI,CAAC,SAAS,EAAE;YAC9B,SAAS,EAAE,MAAM,IAAI,CAAC,YAAY,EAAE;YACpC,MAAM,EAAE,MAAM,IAAI,CAAC,SAAS,EAAE;YAC9B,WAAW,EAAE,MAAM,IAAI,CAAC,cAAc,EAAE;SACxC,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,SAAS;QACrB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,YAAY;QACxB,OAAO,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,SAAS;QACrB,OAAO,OAAO,CAAC,MAAM,EAAE,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,cAAc;QAC1B,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,aAAa,CAAC;IACjD,CAAC;CACD;AA3CD,kDA2CC"}

package/router/validation-middleware.d.ts

@@ -1,13 +1,13 @@
 import { ArrayValSan, ObjectSanitizer, ObjectValSan } from 'valsan';
 import { ApiRequest, BaseApiEndpoint } from './endpoint';
 /**
- * Runs a valsan ObjectSanitizer on a value,
+ * Runs a valsan ObjectValSan on a value,
  *  throws with error details if validation fails.
  */
 export declare function runSanitizer(sanitizer: ObjectSanitizer | ObjectValSan | ArrayValSan, value: any): Promise<Record<string, unknown> | unknown[] | undefined>;
 /**
  * Validates and sanitizes request parts
  *  (body, query, params, headers) if the
- *  endpoint defines a ObjectSanitizers
+ *  endpoint defines an ObjectValSan
  */
 export declare function validateRequest(endpoint: BaseApiEndpoint, request: ApiRequest): Promise<void>;

package/router/validation-middleware.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateRequest = exports.runSanitizer = void 0;
 const error_1 = require("../error");
 /**
- * Runs a valsan ObjectSanitizer on a value,
+ * Runs a valsan ObjectValSan on a value,
  *  throws with error details if validation fails.
  */
 async function runSanitizer(sanitizer, 
@@ -21,7 +21,7 @@ exports.runSanitizer = runSanitizer;
 /**
  * Validates and sanitizes request parts
  *  (body, query, params, headers) if the
- *  endpoint defines a ObjectSanitizers
+ *  endpoint defines an ObjectValSan
  */
 async function validateRequest(endpoint, request) {
     for (const part of ['body', 'query', 'params', 'headers']) {