@naturalcycles/backend-lib 5.10.0 → 5.12.0

package/dist/server/serverStatusMiddleware.js

@@ -30,7 +30,6 @@ function getServerStatusData(projectDir = process.cwd(), extra) {
         // resourceUsage: process.resourceUsage?.(),
         versions,
         NODE_OPTIONS,
-        fetch: typeof globalThis.fetch === 'function',
         ...extra,
     });
 }

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

@@ -11,11 +11,26 @@ 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.
+     *
+     * The general default is `false`, with the excepction of `headers` validation, where the default is `true`.
+     */
+    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;
 }

package/dist/server/validation/validateRequest.js

@@ -25,8 +25,21 @@ 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 = {}) {
-        return this.validate(req, 'headers', 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}`);
@@ -50,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.10.0",
+  "version": "5.12.0",
   "scripts": {
     "prepare": "husky",
     "build": "dev-lib build",

package/src/server/serverStatusMiddleware.ts

@@ -34,7 +34,6 @@ export function getServerStatusData(
     // resourceUsage: process.resourceUsage?.(),
     versions,
     NODE_OPTIONS,
-    fetch: typeof globalThis.fetch === 'function',
     ...extra,
   })
 }

package/src/server/validation/validateRequest.ts

@@ -16,6 +16,13 @@ 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.
+   *
+   * The general default is `false`, with the excepction of `headers` validation, where the default is `true`.
+   */
+  keepOriginal?: boolean
 }
 
 /**
@@ -55,12 +62,25 @@ 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 {
-    return this.validate(req, 'headers', schema, opt)
+    const options: ReqValidationOptions<JoiValidationError> = {
+      keepOriginal: true,
+      ...opt,
+    }
+    return this.validate(req, 'headers', schema, options)
   }
 
   private validate<T>(
@@ -92,7 +112,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
   }
 }