@naturalcycles/backend-lib 5.1.0 → 5.2.0

package/dist/index.d.ts

@@ -20,11 +20,11 @@ export * from './server/notFoundMiddleware';
 export * from './server/okMiddleware';
 export * from './server/basicAuthMiddleware';
 export * from './server/requestTimeoutMiddleware';
-export * from './server/reqValidationMiddleware';
+export * from './server/validation/reqValidationMiddleware';
 export * from './server/simpleRequestLoggerMiddleware';
 export * from './server/serverStatusMiddleware';
-export * from './server/validateMiddleware';
-export * from './server/zodValidateMiddleware';
+export * from './server/validation/validateMiddleware';
+export * from './server/validation/zodValidateMiddleware';
 export * from './server/request.log.util';
 export * from './server/startServer';
 export * from './server/startServer.model';

package/dist/index.js

@@ -25,11 +25,11 @@ tslib_1.__exportStar(require("./server/notFoundMiddleware"), exports);
 tslib_1.__exportStar(require("./server/okMiddleware"), exports);
 tslib_1.__exportStar(require("./server/basicAuthMiddleware"), exports);
 tslib_1.__exportStar(require("./server/requestTimeoutMiddleware"), exports);
-tslib_1.__exportStar(require("./server/reqValidationMiddleware"), exports);
+tslib_1.__exportStar(require("./server/validation/reqValidationMiddleware"), exports);
 tslib_1.__exportStar(require("./server/simpleRequestLoggerMiddleware"), exports);
 tslib_1.__exportStar(require("./server/serverStatusMiddleware"), exports);
-tslib_1.__exportStar(require("./server/validateMiddleware"), exports);
-tslib_1.__exportStar(require("./server/zodValidateMiddleware"), exports);
+tslib_1.__exportStar(require("./server/validation/validateMiddleware"), exports);
+tslib_1.__exportStar(require("./server/validation/zodValidateMiddleware"), exports);
 tslib_1.__exportStar(require("./server/request.log.util"), exports);
 tslib_1.__exportStar(require("./server/startServer"), exports);
 tslib_1.__exportStar(require("./server/startServer.model"), exports);

package/dist/server/genericErrorMiddleware.js

@@ -57,7 +57,6 @@ function respondWithError(req, res, err) {
     // Otherwise, it breaks the _isHttpErrorResponse function check, and error get formatted/detected wrongly
     httpError.data['httpStatusCode'] = httpError.data.backendResponseStatusCode;
     httpError.data.headersSent = headersSent || undefined;
-    httpError.data.report ||= undefined; // set to undefined if false
     (0, js_lib_1._filterUndefinedValues)(httpError.data, true);
     formatError?.(httpError); // Mutates
     res.status(httpError.data.backendResponseStatusCode).json({

package/dist/server/server.model.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="cookie-parser" />
 /// <reference types="node" />
 import type { CommonLogFunction, Promisable } from '@naturalcycles/js-lib';
 import type { IRouter, Request, NextFunction, Response, Application } from 'express';

package/dist/server/{reqValidationMiddleware.d.ts → validation/reqValidationMiddleware.d.ts}

@@ -1,5 +1,5 @@
 import { AnySchema, JoiValidationError } from '@naturalcycles/nodejs-lib';
-import { BackendRequestHandler } from './server.model';
+import { BackendRequest, BackendRequestHandler } from '../server.model';
 export interface ReqValidationOptions<ERR extends Error> {
     /**
      * Pass a 'dot-paths' (e.g `pw`, or `input.pw`) that needs to be redacted from the output, in case of error.
@@ -13,3 +13,11 @@ export interface ReqValidationOptions<ERR extends Error> {
     report?: boolean | ((err: ERR) => boolean);
 }
 export declare function reqValidation(reqProperty: 'body' | 'params' | 'query', schema: AnySchema, opt?: ReqValidationOptions<JoiValidationError>): BackendRequestHandler;
+declare class ValidateRequest {
+    body<T>(req: BackendRequest, schema: AnySchema<T>, opt?: ReqValidationOptions<JoiValidationError>): T;
+    query<T>(req: BackendRequest, schema: AnySchema<T>, opt?: ReqValidationOptions<JoiValidationError>): T;
+    params<T>(req: BackendRequest, schema: AnySchema<T>, opt?: ReqValidationOptions<JoiValidationError>): T;
+    private validate;
+}
+export declare const validateRequest: ValidateRequest;
+export {};

package/dist/server/validation/reqValidationMiddleware.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateRequest = exports.reqValidation = void 0;
+const js_lib_1 = require("@naturalcycles/js-lib");
+const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
+const REDACTED = 'REDACTED';
+function reqValidation(reqProperty, schema, opt = {}) {
+    const reportPredicate = typeof opt.report === 'function' ? opt.report : () => opt.report;
+    return (req, res, next) => {
+        const { value, error } = (0, nodejs_lib_1.getValidationResult)(req[reqProperty], schema, `request ${reqProperty}`);
+        if (error) {
+            const report = reportPredicate(error);
+            if (opt.redactPaths) {
+                redact(opt.redactPaths, req[reqProperty], error);
+                error.data.joiValidationErrorItems.length = 0; // clears the array
+                delete error.data.annotation;
+            }
+            return next(new js_lib_1.AppError(error.message, {
+                backendResponseStatusCode: 400,
+                report,
+                ...error.data,
+            }));
+        }
+        // mutate req to replace the property with the value, converted by Joi
+        req[reqProperty] = value;
+        next();
+    };
+}
+exports.reqValidation = reqValidation;
+/**
+ * Mutates error
+ */
+function redact(redactPaths, obj, error) {
+    redactPaths
+        .map(path => (0, js_lib_1._get)(obj, path))
+        .filter(Boolean)
+        .forEach(secret => {
+        error.message = error.message.replace(secret, REDACTED);
+    });
+}
+class ValidateRequest {
+    body(req, schema, opt = {}) {
+        return this.validate(req, 'body', schema, opt);
+    }
+    query(req, schema, opt = {}) {
+        return this.validate(req, 'query', schema, opt);
+    }
+    params(req, schema, opt = {}) {
+        return this.validate(req, 'params', schema, opt);
+    }
+    validate(req, reqProperty, schema, opt = {}) {
+        const { value, error } = (0, nodejs_lib_1.getValidationResult)(req[reqProperty], schema, `request ${reqProperty}`);
+        if (error) {
+            let report;
+            if (typeof opt.report === 'boolean') {
+                report = opt.report;
+            }
+            else if (typeof opt.report === 'function') {
+                report = opt.report(error);
+            }
+            if (opt.redactPaths) {
+                redact(opt.redactPaths, req[reqProperty], error);
+                error.data.joiValidationErrorItems.length = 0; // clears the array
+                delete error.data.annotation;
+            }
+            throw new js_lib_1.AppError(error.message, {
+                backendResponseStatusCode: 400,
+                report,
+                ...error.data,
+            });
+        }
+        // mutate req to replace the property with the value, converted by Joi
+        req[reqProperty] = value;
+        return value;
+    }
+}
+exports.validateRequest = new ValidateRequest();

package/dist/server/{validateMiddleware.d.ts → validation/validateMiddleware.d.ts}

@@ -1,7 +1,7 @@
 import { JsonSchema, JsonSchemaBuilder } from '@naturalcycles/js-lib';
 import { AjvSchema, AjvValidationError } from '@naturalcycles/nodejs-lib';
+import { BackendRequestHandler } from '../server.model';
 import { ReqValidationOptions } from './reqValidationMiddleware';
-import { BackendRequestHandler } from './server.model';
 export declare function validateBody(schema: JsonSchema | JsonSchemaBuilder | AjvSchema, opt?: ReqValidationOptions<AjvValidationError>): BackendRequestHandler;
 export declare function validateParams(schema: JsonSchema | JsonSchemaBuilder | AjvSchema, opt?: ReqValidationOptions<AjvValidationError>): BackendRequestHandler;
 export declare function validateQuery(schema: JsonSchema | JsonSchemaBuilder | AjvSchema, opt?: ReqValidationOptions<AjvValidationError>): BackendRequestHandler;

package/dist/server/{validateMiddleware.js → validation/validateMiddleware.js}

@@ -26,7 +26,7 @@ function validateObject(prop, schema, opt = {}) {
     const ajvSchema = nodejs_lib_1.AjvSchema.create(schema, {
         objectName: `request ${prop}`,
     });
-    const reportPredicate = typeof opt.report === 'function' ? opt.report : () => !!opt.report;
+    const reportPredicate = typeof opt.report === 'function' ? opt.report : () => opt.report;
     return (req, res, next) => {
         const error = ajvSchema.getValidationError(req[prop]);
         if (error) {

package/dist/server/{zodValidateMiddleware.d.ts → validation/zodValidateMiddleware.d.ts}

@@ -1,6 +1,6 @@
 import { ZodSchema, ZodValidationError } from '@naturalcycles/js-lib';
+import { BackendRequestHandler } from '../server.model';
 import { ReqValidationOptions } from './reqValidationMiddleware';
-import { BackendRequestHandler } from './server.model';
 /**
  * Validates req property (body, params or query).
  * Supports Joi schema or AjvSchema (from nodejs-lib).

package/dist/server/{zodValidateMiddleware.js → validation/zodValidateMiddleware.js}

@@ -10,7 +10,7 @@ const REDACTED = 'REDACTED';
  * Throws http 400 on error.
  */
 function zodReqValidate(prop, schema, opt = {}) {
-    const reportPredicate = typeof opt.report === 'function' ? opt.report : () => !!opt.report;
+    const reportPredicate = typeof opt.report === 'function' ? opt.report : () => opt.report;
     return (req, res, next) => {
         const { error } = (0, js_lib_1.zSafeValidate)(req[prop], schema);
         if (!error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "scripts": {
     "prepare": "husky",
     "dev": "APP_ENV=dev nodemon",

package/src/index.ts

@@ -20,11 +20,11 @@ export * from './server/notFoundMiddleware'
 export * from './server/okMiddleware'
 export * from './server/basicAuthMiddleware'
 export * from './server/requestTimeoutMiddleware'
-export * from './server/reqValidationMiddleware'
+export * from './server/validation/reqValidationMiddleware'
 export * from './server/simpleRequestLoggerMiddleware'
 export * from './server/serverStatusMiddleware'
-export * from './server/validateMiddleware'
-export * from './server/zodValidateMiddleware'
+export * from './server/validation/validateMiddleware'
+export * from './server/validation/zodValidateMiddleware'
 export * from './server/request.log.util'
 export * from './server/startServer'
 export * from './server/startServer.model'

package/src/server/genericErrorMiddleware.ts

@@ -90,7 +90,6 @@ export function respondWithError(req: BackendRequest, res: BackendResponse, err:
   // Otherwise, it breaks the _isHttpErrorResponse function check, and error get formatted/detected wrongly
   httpError.data['httpStatusCode'] = httpError.data.backendResponseStatusCode
   httpError.data.headersSent = headersSent || undefined
-  httpError.data.report ||= undefined // set to undefined if false
   _filterUndefinedValues(httpError.data, true)
 
   formatError?.(httpError) // Mutates

package/src/server/{reqValidationMiddleware.ts → validation/reqValidationMiddleware.ts}

@@ -1,6 +1,6 @@
 import { _get, AppError } from '@naturalcycles/js-lib'
 import { AnySchema, getValidationResult, JoiValidationError } from '@naturalcycles/nodejs-lib'
-import { BackendRequestHandler } from './server.model'
+import { BackendRequest, BackendRequestHandler } from '../server.model'
 
 const REDACTED = 'REDACTED'
 
@@ -23,7 +23,8 @@ export function reqValidation(
   schema: AnySchema,
   opt: ReqValidationOptions<JoiValidationError> = {},
 ): BackendRequestHandler {
-  const reportPredicate = typeof opt.report === 'function' ? opt.report : () => !!opt.report
+  const reportPredicate =
+    typeof opt.report === 'function' ? opt.report : () => opt.report as boolean | undefined
 
   return (req, res, next) => {
     const { value, error } = getValidationResult(req[reqProperty], schema, `request ${reqProperty}`)
@@ -62,3 +63,64 @@ function redact(redactPaths: string[], obj: any, error: Error): void {
       error.message = error.message.replace(secret, REDACTED)
     })
 }
+
+class ValidateRequest {
+  body<T>(
+    req: BackendRequest,
+    schema: AnySchema<T>,
+    opt: ReqValidationOptions<JoiValidationError> = {},
+  ): T {
+    return this.validate(req, 'body', schema, opt)
+  }
+
+  query<T>(
+    req: BackendRequest,
+    schema: AnySchema<T>,
+    opt: ReqValidationOptions<JoiValidationError> = {},
+  ): T {
+    return this.validate(req, 'query', schema, opt)
+  }
+
+  params<T>(
+    req: BackendRequest,
+    schema: AnySchema<T>,
+    opt: ReqValidationOptions<JoiValidationError> = {},
+  ): T {
+    return this.validate(req, 'params', schema, opt)
+  }
+
+  private validate<T>(
+    req: BackendRequest,
+    reqProperty: 'body' | 'params' | 'query',
+    schema: AnySchema<T>,
+    opt: ReqValidationOptions<JoiValidationError> = {},
+  ): T {
+    const { value, error } = getValidationResult(req[reqProperty], schema, `request ${reqProperty}`)
+    if (error) {
+      let report: boolean | undefined
+      if (typeof opt.report === 'boolean') {
+        report = opt.report
+      } else if (typeof opt.report === 'function') {
+        report = opt.report(error)
+      }
+
+      if (opt.redactPaths) {
+        redact(opt.redactPaths, req[reqProperty], error)
+        error.data.joiValidationErrorItems.length = 0 // clears the array
+        delete error.data.annotation
+      }
+
+      throw new AppError(error.message, {
+        backendResponseStatusCode: 400,
+        report,
+        ...error.data,
+      })
+    }
+
+    // mutate req to replace the property with the value, converted by Joi
+    req[reqProperty] = value
+    return value
+  }
+}
+
+export const validateRequest = new ValidateRequest()

package/src/server/{validateMiddleware.ts → validation/validateMiddleware.ts}

@@ -1,7 +1,7 @@
 import { JsonSchema, JsonSchemaBuilder, _get, AppError } from '@naturalcycles/js-lib'
 import { AjvSchema, AjvValidationError } from '@naturalcycles/nodejs-lib'
+import { BackendRequestHandler } from '../server.model'
 import { ReqValidationOptions } from './reqValidationMiddleware'
-import { BackendRequestHandler } from './server.model'
 
 const REDACTED = 'REDACTED'
 
@@ -41,7 +41,8 @@ function validateObject(
     objectName: `request ${prop}`,
   })
 
-  const reportPredicate = typeof opt.report === 'function' ? opt.report : () => !!opt.report
+  const reportPredicate =
+    typeof opt.report === 'function' ? opt.report : () => opt.report as boolean | undefined
 
   return (req, res, next) => {
     const error = ajvSchema.getValidationError(req[prop])

package/src/server/{zodValidateMiddleware.ts → validation/zodValidateMiddleware.ts}

@@ -1,6 +1,6 @@
 import { _get, AppError, ZodSchema, ZodValidationError, zSafeValidate } from '@naturalcycles/js-lib'
+import { BackendRequestHandler } from '../server.model'
 import { ReqValidationOptions } from './reqValidationMiddleware'
-import { BackendRequestHandler } from './server.model'
 
 const REDACTED = 'REDACTED'
 
@@ -15,7 +15,8 @@ export function zodReqValidate(
   schema: ZodSchema,
   opt: ReqValidationOptions<ZodValidationError<any>> = {},
 ): BackendRequestHandler {
-  const reportPredicate = typeof opt.report === 'function' ? opt.report : () => !!opt.report
+  const reportPredicate =
+    typeof opt.report === 'function' ? opt.report : () => opt.report as boolean | undefined
 
   return (req, res, next) => {
     const { error } = zSafeValidate(req[prop], schema)

package/dist/server/reqValidationMiddleware.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.reqValidation = void 0;
-const js_lib_1 = require("@naturalcycles/js-lib");
-const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
-const REDACTED = 'REDACTED';
-function reqValidation(reqProperty, schema, opt = {}) {
-    const reportPredicate = typeof opt.report === 'function' ? opt.report : () => !!opt.report;
-    return (req, res, next) => {
-        const { value, error } = (0, nodejs_lib_1.getValidationResult)(req[reqProperty], schema, `request ${reqProperty}`);
-        if (error) {
-            const report = reportPredicate(error);
-            if (opt.redactPaths) {
-                redact(opt.redactPaths, req[reqProperty], error);
-                error.data.joiValidationErrorItems.length = 0; // clears the array
-                delete error.data.annotation;
-            }
-            return next(new js_lib_1.AppError(error.message, {
-                backendResponseStatusCode: 400,
-                report,
-                ...error.data,
-            }));
-        }
-        // mutate req to replace the property with the value, converted by Joi
-        req[reqProperty] = value;
-        next();
-    };
-}
-exports.reqValidation = reqValidation;
-/**
- * Mutates error
- */
-function redact(redactPaths, obj, error) {
-    redactPaths
-        .map(path => (0, js_lib_1._get)(obj, path))
-        .filter(Boolean)
-        .forEach(secret => {
-        error.message = error.message.replace(secret, REDACTED);
-    });
-}