@naturalcycles/backend-lib 5.9.1 → 5.11.0

package/dist/server/validation/validateMiddleware.d.ts

@@ -5,3 +5,4 @@ import { ReqValidationOptions } from './validateRequest';
 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;
+export declare function validateHeaders(schema: JsonSchema | JsonSchemaBuilder | AjvSchema, opt?: ReqValidationOptions<AjvValidationError>): BackendRequestHandler;

package/dist/server/validation/validateMiddleware.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateBody = validateBody;
 exports.validateParams = validateParams;
 exports.validateQuery = validateQuery;
+exports.validateHeaders = validateHeaders;
 const js_lib_1 = require("@naturalcycles/js-lib");
 const nodejs_lib_1 = require("@naturalcycles/nodejs-lib");
 const REDACTED = 'REDACTED';
@@ -15,6 +16,9 @@ function validateParams(schema, opt = {}) {
 function validateQuery(schema, opt = {}) {
     return validateObject('query', schema, opt);
 }
+function validateHeaders(schema, opt = {}) {
+    return validateObject('headers', schema, opt);
+}
 /**
  * Validates req property (body, params or query).
  * Supports Joi schema or AjvSchema (from nodejs-lib).
@@ -51,6 +55,6 @@ function redact(redactPaths, obj, error) {
         .map(path => (0, js_lib_1._get)(obj, path))
         .filter(Boolean)
         .forEach(secret => {
-        error.message = error.message.replace(secret, REDACTED);
+        error.message = error.message.replaceAll(secret, REDACTED);
     });
 }

package/dist/server/validation/validateRequest.d.ts

@@ -11,11 +11,25 @@ export interface ReqValidationOptions<ERR extends Error> {
      * If true - `genericErrorHandler` will report it to errorReporter (aka Sentry).
      */
     report?: boolean | ((err: ERR) => boolean);
+    /**
+     * When set to true, the validated object will not be replaced with the Joi-converted value.
+     */
+    keepOriginal?: boolean;
 }
 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;
+    /**
+     * Validates `req.headers` against the provided Joi schema.
+     *
+     * Note: as opposed to other methods, this method does not mutate `req.headers` in case of success,
+     * i.e. schemas that cast values will not have any effect.
+     *
+     * If you wish to mutate `req.headers` with the validated value, use `keepOriginal: false` option.
+     * Keep in mind that this will also remove all values that are not in the schema.
+     */
+    headers<T>(req: BackendRequest, schema: AnySchema<T>, opt?: ReqValidationOptions<JoiValidationError>): T;
     private validate;
 }
 export declare const validateRequest: ValidateRequest;

package/dist/server/validation/validateRequest.js

@@ -12,7 +12,7 @@ function redact(redactPaths, obj, error) {
         .map(path => (0, js_lib_1._get)(obj, path))
         .filter(Boolean)
         .forEach(secret => {
-        error.message = error.message.replace(secret, REDACTED);
+        error.message = error.message.replaceAll(secret, REDACTED);
     });
 }
 class ValidateRequest {
@@ -25,6 +25,22 @@ class ValidateRequest {
     params(req, schema, opt = {}) {
         return this.validate(req, 'params', schema, opt);
     }
+    /**
+     * Validates `req.headers` against the provided Joi schema.
+     *
+     * Note: as opposed to other methods, this method does not mutate `req.headers` in case of success,
+     * i.e. schemas that cast values will not have any effect.
+     *
+     * If you wish to mutate `req.headers` with the validated value, use `keepOriginal: false` option.
+     * Keep in mind that this will also remove all values that are not in the schema.
+     */
+    headers(req, schema, opt = {}) {
+        const options = {
+            keepOriginal: true,
+            ...opt,
+        };
+        return this.validate(req, 'headers', schema, options);
+    }
     validate(req, reqProperty, schema, opt = {}) {
         const { value, error } = (0, nodejs_lib_1.getValidationResult)(req[reqProperty], schema, `request ${reqProperty}`);
         if (error) {
@@ -47,7 +63,9 @@ class ValidateRequest {
             });
         }
         // mutate req to replace the property with the value, converted by Joi
-        req[reqProperty] = value;
+        if (!opt.keepOriginal) {
+            req[reqProperty] = value;
+        }
         return value;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "5.9.1",
+  "version": "5.11.0",
   "scripts": {
     "prepare": "husky",
     "build": "dev-lib build",

package/src/server/validation/validateMiddleware.ts

@@ -26,6 +26,13 @@ export function validateQuery(
   return validateObject('query', schema, opt)
 }
 
+export function validateHeaders(
+  schema: JsonSchema | JsonSchemaBuilder | AjvSchema,
+  opt: ReqValidationOptions<AjvValidationError> = {},
+): BackendRequestHandler {
+  return validateObject('headers', schema, opt)
+}
+
 /**
  * Validates req property (body, params or query).
  * Supports Joi schema or AjvSchema (from nodejs-lib).
@@ -33,7 +40,7 @@ export function validateQuery(
  * Throws http 400 on error.
  */
 function validateObject(
-  prop: 'body' | 'params' | 'query',
+  prop: 'body' | 'params' | 'query' | 'headers',
   schema: JsonSchema | JsonSchemaBuilder | AjvSchema,
   opt: ReqValidationOptions<AjvValidationError> = {},
 ): BackendRequestHandler {
@@ -75,6 +82,6 @@ function redact(redactPaths: string[], obj: any, error: Error): void {
     .map(path => _get(obj, path) as string)
     .filter(Boolean)
     .forEach(secret => {
-      error.message = error.message.replace(secret, REDACTED)
+      error.message = error.message.replaceAll(secret, REDACTED)
     })
 }

package/src/server/validation/validateRequest.ts

@@ -16,6 +16,11 @@ export interface ReqValidationOptions<ERR extends Error> {
    * If true - `genericErrorHandler` will report it to errorReporter (aka Sentry).
    */
   report?: boolean | ((err: ERR) => boolean)
+
+  /**
+   * When set to true, the validated object will not be replaced with the Joi-converted value.
+   */
+  keepOriginal?: boolean
 }
 
 /**
@@ -26,7 +31,7 @@ function redact(redactPaths: string[], obj: any, error: Error): void {
     .map(path => _get(obj, path) as string)
     .filter(Boolean)
     .forEach(secret => {
-      error.message = error.message.replace(secret, REDACTED)
+      error.message = error.message.replaceAll(secret, REDACTED)
     })
 }
 
@@ -55,9 +60,30 @@ class ValidateRequest {
     return this.validate(req, 'params', schema, opt)
   }
 
+  /**
+   * Validates `req.headers` against the provided Joi schema.
+   *
+   * Note: as opposed to other methods, this method does not mutate `req.headers` in case of success,
+   * i.e. schemas that cast values will not have any effect.
+   *
+   * If you wish to mutate `req.headers` with the validated value, use `keepOriginal: false` option.
+   * Keep in mind that this will also remove all values that are not in the schema.
+   */
+  headers<T>(
+    req: BackendRequest,
+    schema: AnySchema<T>,
+    opt: ReqValidationOptions<JoiValidationError> = {},
+  ): T {
+    const options: ReqValidationOptions<JoiValidationError> = {
+      keepOriginal: true,
+      ...opt,
+    }
+    return this.validate(req, 'headers', schema, options)
+  }
+
   private validate<T>(
     req: BackendRequest,
-    reqProperty: 'body' | 'params' | 'query',
+    reqProperty: 'body' | 'params' | 'query' | 'headers',
     schema: AnySchema<T>,
     opt: ReqValidationOptions<JoiValidationError> = {},
   ): T {
@@ -84,7 +110,10 @@ class ValidateRequest {
     }
 
     // mutate req to replace the property with the value, converted by Joi
-    req[reqProperty] = value
+    if (!opt.keepOriginal) {
+      req[reqProperty] = value
+    }
+
     return value
   }
 }