@naturalcycles/backend-lib 4.12.0 → 4.13.0

package/dist/index.d.ts

@@ -23,6 +23,7 @@ export * from './server/reqValidationMiddleware';
 export * from './server/simpleRequestLoggerMiddleware';
 export * from './server/serverStatusMiddleware';
 export * from './server/validateMiddleware';
+export * from './server/zodValidateMiddleware';
 export * from './server/request.log.util';
 export * from './server/startServer';
 export * from './server/startServer.model';

package/dist/index.js

@@ -28,6 +28,7 @@ tslib_1.__exportStar(require("./server/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/request.log.util"), exports);
 tslib_1.__exportStar(require("./server/startServer"), exports);
 tslib_1.__exportStar(require("./server/startServer.model"), exports);

package/dist/server/zodValidateMiddleware.d.ts

@@ -0,0 +1,10 @@
+import { ZodSchema, ZodValidationError } from '@naturalcycles/js-lib';
+import { BackendRequestHandler } from './server.model';
+import { ReqValidationOptions } from './reqValidationMiddleware';
+/**
+ * Validates req property (body, params or query).
+ * Supports Joi schema or AjvSchema (from nodejs-lib).
+ * Able to redact sensitive data from the error message.
+ * Throws http 400 on error.
+ */
+export declare function zodReqValidate(prop: 'body' | 'params' | 'query', schema: ZodSchema, opt?: ReqValidationOptions<ZodValidationError<any>>): BackendRequestHandler;

package/dist/server/zodValidateMiddleware.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zodReqValidate = void 0;
+const js_lib_1 = require("@naturalcycles/js-lib");
+const REDACTED = 'REDACTED';
+/**
+ * Validates req property (body, params or query).
+ * Supports Joi schema or AjvSchema (from nodejs-lib).
+ * Able to redact sensitive data from the error message.
+ * Throws http 400 on error.
+ */
+function zodReqValidate(prop, schema, opt = {}) {
+    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) {
+            return next();
+        }
+        const report = reportPredicate(error);
+        if (opt.redactPaths) {
+            redact(opt.redactPaths, req[prop], error);
+        }
+        return next(new js_lib_1.HttpError(error.message, {
+            httpStatusCode: 400,
+            report,
+        }));
+    };
+}
+exports.zodReqValidate = zodReqValidate;
+/**
+ * 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);
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/backend-lib",
-  "version": "4.12.0",
+  "version": "4.13.0",
   "scripts": {
     "prepare": "husky install && patch-package",
     "serve": "APP_ENV=dev nodemon",

package/src/index.ts

@@ -23,6 +23,7 @@ export * from './server/reqValidationMiddleware'
 export * from './server/simpleRequestLoggerMiddleware'
 export * from './server/serverStatusMiddleware'
 export * from './server/validateMiddleware'
+export * from './server/zodValidateMiddleware'
 export * from './server/request.log.util'
 export * from './server/startServer'
 export * from './server/startServer.model'

package/src/server/zodValidateMiddleware.ts

@@ -0,0 +1,57 @@
+import {
+  HttpError,
+  _get,
+  ZodSchema,
+  ZodValidationError,
+  zSafeValidate,
+} from '@naturalcycles/js-lib'
+import { BackendRequestHandler } from './server.model'
+import { ReqValidationOptions } from './reqValidationMiddleware'
+
+const REDACTED = 'REDACTED'
+
+/**
+ * Validates req property (body, params or query).
+ * Supports Joi schema or AjvSchema (from nodejs-lib).
+ * Able to redact sensitive data from the error message.
+ * Throws http 400 on error.
+ */
+export function zodReqValidate(
+  prop: 'body' | 'params' | 'query',
+  schema: ZodSchema,
+  opt: ReqValidationOptions<ZodValidationError<any>> = {},
+): BackendRequestHandler {
+  const reportPredicate = typeof opt.report === 'function' ? opt.report : () => !!opt.report
+
+  return (req, res, next) => {
+    const { error } = zSafeValidate(req[prop], schema)
+    if (!error) {
+      return next()
+    }
+
+    const report = reportPredicate(error)
+
+    if (opt.redactPaths) {
+      redact(opt.redactPaths, req[prop], error)
+    }
+
+    return next(
+      new HttpError(error.message, {
+        httpStatusCode: 400,
+        report,
+      }),
+    )
+  }
+}
+
+/**
+ * Mutates error
+ */
+function redact(redactPaths: string[], obj: any, error: Error): void {
+  redactPaths
+    .map(path => _get(obj, path) as string)
+    .filter(Boolean)
+    .forEach(secret => {
+      error.message = error.message.replace(secret, REDACTED)
+    })
+}