@naturalcycles/backend-lib 9.9.0 → 9.10.0

package/dist/index.d.ts

@@ -28,8 +28,8 @@ export * from './server/serverStatusMiddleware.js';
 export * from './server/simpleRequestLoggerMiddleware.js';
 export * from './server/startServer.js';
 export * from './server/startServer.model.js';
-export * from './server/validation/validateMiddleware.js';
+export * from './server/validation/ajvValidateRequest.js';
 export * from './server/validation/validateRequest.js';
-export * from './server/validation/zodValidateMiddleware.js';
+export * from './server/validation/zodValidateRequest.js';
 export * from './util.js';
 export { onFinished };

package/dist/index.js

@@ -28,8 +28,8 @@ export * from './server/serverStatusMiddleware.js';
 export * from './server/simpleRequestLoggerMiddleware.js';
 export * from './server/startServer.js';
 export * from './server/startServer.model.js';
-export * from './server/validation/validateMiddleware.js';
+export * from './server/validation/ajvValidateRequest.js';
 export * from './server/validation/validateRequest.js';
-export * from './server/validation/zodValidateMiddleware.js';
+export * from './server/validation/zodValidateRequest.js';
 export * from './util.js';
 export { onFinished };

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

@@ -0,0 +1,21 @@
+import type { AjvSchema, AjvValidationError } from '@naturalcycles/nodejs-lib';
+import type { BackendRequest } from '../server.model.js';
+import type { ReqValidationOptions } from './validateRequest.js';
+declare class AjvValidateRequest {
+    body<T>(req: BackendRequest, schema: AjvSchema<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
+    query<T>(req: BackendRequest, schema: AjvSchema<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
+    params<T>(req: BackendRequest, schema: AjvSchema<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
+    /**
+     * Validates `req.headers` against the provided 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: AjvSchema<T>, opt?: ReqValidationOptions<AjvValidationError>): T;
+    private validate;
+}
+export declare const ajvValidateRequest: AjvValidateRequest;
+export {};

package/dist/server/validation/ajvValidateRequest.js

@@ -0,0 +1,71 @@
+import { _get, AppError } from '@naturalcycles/js-lib';
+class AjvValidateRequest {
+    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);
+    }
+    /**
+     * Validates `req.headers` against the provided 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 = { ...req[reqProperty] }; // destructure to avoid being mutated by Ajv
+        // It will mutate the `value`, but not the original object
+        const error = schema.getValidationError(value, {
+            objectName: `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);
+            }
+            throw new AppError(error.message, {
+                backendResponseStatusCode: 400,
+                report,
+                ...error.data,
+            });
+        }
+        // mutate req to replace the property with the value, converted by Joi
+        if (!opt.keepOriginal && reqProperty !== 'query') {
+            // query is read-only in Express 5
+            req[reqProperty] = value;
+        }
+        return value;
+    }
+}
+export const ajvValidateRequest = new AjvValidateRequest();
+const REDACTED = 'REDACTED';
+/**
+ * Mutates error
+ */
+function redact(redactPaths, obj, error) {
+    redactPaths
+        .map(path => _get(obj, path))
+        .filter(Boolean)
+        .forEach(secret => {
+        error.message = error.message.replaceAll(secret, REDACTED);
+    });
+}

package/dist/server/validation/validateRequest.js

@@ -1,17 +1,5 @@
 import { _get, AppError } from '@naturalcycles/js-lib';
 import { getValidationResult } from '@naturalcycles/nodejs-lib';
-const REDACTED = 'REDACTED';
-/**
- * Mutates error
- */
-function redact(redactPaths, obj, error) {
-    redactPaths
-        .map(path => _get(obj, path))
-        .filter(Boolean)
-        .forEach(secret => {
-        error.message = error.message.replaceAll(secret, REDACTED);
-    });
-}
 class ValidateRequest {
     body(req, schema, opt = {}) {
         return this.validate(req, 'body', schema, opt);
@@ -68,3 +56,15 @@ class ValidateRequest {
     }
 }
 export const validateRequest = new ValidateRequest();
+const REDACTED = 'REDACTED';
+/**
+ * Mutates error
+ */
+function redact(redactPaths, obj, error) {
+    redactPaths
+        .map(path => _get(obj, path))
+        .filter(Boolean)
+        .forEach(secret => {
+        error.message = error.message.replaceAll(secret, REDACTED);
+    });
+}

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

@@ -0,0 +1,21 @@
+import { type ZodType, type ZodValidationError } from '@naturalcycles/js-lib/zod';
+import type { BackendRequest } from '../server.model.js';
+import type { ReqValidationOptions } from './validateRequest.js';
+declare class ZodValidateRequest {
+    body<T>(req: BackendRequest, schema: ZodType<T>, opt?: ReqValidationOptions<ZodValidationError>): T;
+    query<T>(req: BackendRequest, schema: ZodType<T>, opt?: ReqValidationOptions<ZodValidationError>): T;
+    params<T>(req: BackendRequest, schema: ZodType<T>, opt?: ReqValidationOptions<ZodValidationError>): T;
+    /**
+     * Validates `req.headers` against the provided 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: ZodType<T>, opt?: ReqValidationOptions<ZodValidationError>): T;
+    private validate;
+}
+export declare const zodValidateRequest: ZodValidateRequest;
+export {};

package/dist/server/validation/zodValidateRequest.js

@@ -0,0 +1,68 @@
+import { _get, AppError } from '@naturalcycles/js-lib';
+import { zSafeValidate } from '@naturalcycles/js-lib/zod';
+class ZodValidateRequest {
+    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);
+    }
+    /**
+     * Validates `req.headers` against the provided 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 { data, error } = zSafeValidate(req[reqProperty] || {}, schema);
+        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);
+            }
+            throw new AppError(error.message, {
+                backendResponseStatusCode: 400,
+                report,
+                ...error.data,
+            });
+        }
+        // mutate req to replace the property with the value, converted by Joi
+        if (!opt.keepOriginal && reqProperty !== 'query') {
+            // query is read-only in Express 5
+            req[reqProperty] = data;
+        }
+        return data;
+    }
+}
+export const zodValidateRequest = new ZodValidateRequest();
+const REDACTED = 'REDACTED';
+/**
+ * Mutates error
+ */
+function redact(redactPaths, obj, error) {
+    redactPaths
+        .map(path => _get(obj, path))
+        .filter(Boolean)
+        .forEach(secret => {
+        error.message = error.message.replaceAll(secret, REDACTED);
+    });
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/backend-lib",
   "type": "module",
-  "version": "9.9.0",
+  "version": "9.10.0",
   "peerDependencies": {
     "@sentry/node": "^9"
   },

package/src/index.ts

@@ -28,9 +28,9 @@ export * from './server/serverStatusMiddleware.js'
 export * from './server/simpleRequestLoggerMiddleware.js'
 export * from './server/startServer.js'
 export * from './server/startServer.model.js'
-export * from './server/validation/validateMiddleware.js'
+export * from './server/validation/ajvValidateRequest.js'
 export * from './server/validation/validateRequest.js'
-export * from './server/validation/zodValidateMiddleware.js'
+export * from './server/validation/zodValidateRequest.js'
 export * from './util.js'
 
 export { onFinished }

package/src/server/validation/ajvValidateRequest.ts

@@ -0,0 +1,107 @@
+import { _get, AppError } from '@naturalcycles/js-lib'
+import type { AjvSchema, AjvValidationError } from '@naturalcycles/nodejs-lib'
+import type { BackendRequest } from '../server.model.js'
+import type { ReqValidationOptions } from './validateRequest.js'
+
+class AjvValidateRequest {
+  body<T>(
+    req: BackendRequest,
+    schema: AjvSchema<T>,
+    opt: ReqValidationOptions<AjvValidationError> = {},
+  ): T {
+    return this.validate(req, 'body', schema, opt)
+  }
+
+  query<T>(
+    req: BackendRequest,
+    schema: AjvSchema<T>,
+    opt: ReqValidationOptions<AjvValidationError> = {},
+  ): T {
+    return this.validate(req, 'query', schema, opt)
+  }
+
+  params<T>(
+    req: BackendRequest,
+    schema: AjvSchema<T>,
+    opt: ReqValidationOptions<AjvValidationError> = {},
+  ): T {
+    return this.validate(req, 'params', schema, opt)
+  }
+
+  /**
+   * Validates `req.headers` against the provided 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: AjvSchema<T>,
+    opt: ReqValidationOptions<AjvValidationError> = {},
+  ): T {
+    const options: ReqValidationOptions<AjvValidationError> = {
+      keepOriginal: true,
+      ...opt,
+    }
+    return this.validate(req, 'headers', schema, options)
+  }
+
+  private validate<T>(
+    req: BackendRequest,
+    reqProperty: 'body' | 'params' | 'query' | 'headers',
+    schema: AjvSchema<T>,
+    opt: ReqValidationOptions<AjvValidationError> = {},
+  ): T {
+    const value: T = { ...req[reqProperty] } // destructure to avoid being mutated by Ajv
+    // It will mutate the `value`, but not the original object
+    const error = schema.getValidationError(value, {
+      objectName: `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)
+      }
+
+      throw new AppError(error.message, {
+        backendResponseStatusCode: 400,
+        report,
+        ...error.data,
+      })
+    }
+
+    // mutate req to replace the property with the value, converted by Joi
+    if (!opt.keepOriginal && reqProperty !== 'query') {
+      // query is read-only in Express 5
+      req[reqProperty] = value
+    }
+
+    return value
+  }
+}
+
+export const ajvValidateRequest = new AjvValidateRequest()
+
+const REDACTED = 'REDACTED'
+
+/**
+ * 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.replaceAll(secret, REDACTED)
+    })
+}

package/src/server/validation/validateRequest.ts

@@ -3,8 +3,6 @@ import type { AnySchema, JoiValidationError } from '@naturalcycles/nodejs-lib'
 import { getValidationResult } from '@naturalcycles/nodejs-lib'
 import type { BackendRequest } from '../server.model.js'
 
-const REDACTED = 'REDACTED'
-
 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.
@@ -26,18 +24,6 @@ export interface ReqValidationOptions<ERR extends Error> {
   keepOriginal?: boolean
 }
 
-/**
- * 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.replaceAll(secret, REDACTED)
-    })
-}
-
 class ValidateRequest {
   body<T>(
     req: BackendRequest,
@@ -127,3 +113,17 @@ class ValidateRequest {
 }
 
 export const validateRequest = new ValidateRequest()
+
+const REDACTED = 'REDACTED'
+
+/**
+ * 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.replaceAll(secret, REDACTED)
+    })
+}

package/src/server/validation/zodValidateRequest.ts

@@ -0,0 +1,107 @@
+import { _get, AppError } from '@naturalcycles/js-lib'
+import { type ZodType, type ZodValidationError, zSafeValidate } from '@naturalcycles/js-lib/zod'
+import type { BackendRequest } from '../server.model.js'
+import type { ReqValidationOptions } from './validateRequest.js'
+
+class ZodValidateRequest {
+  body<T>(
+    req: BackendRequest,
+    schema: ZodType<T>,
+    opt: ReqValidationOptions<ZodValidationError> = {},
+  ): T {
+    return this.validate(req, 'body', schema, opt)
+  }
+
+  query<T>(
+    req: BackendRequest,
+    schema: ZodType<T>,
+    opt: ReqValidationOptions<ZodValidationError> = {},
+  ): T {
+    return this.validate(req, 'query', schema, opt)
+  }
+
+  params<T>(
+    req: BackendRequest,
+    schema: ZodType<T>,
+    opt: ReqValidationOptions<ZodValidationError> = {},
+  ): T {
+    return this.validate(req, 'params', schema, opt)
+  }
+
+  /**
+   * Validates `req.headers` against the provided 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: ZodType<T>,
+    opt: ReqValidationOptions<ZodValidationError> = {},
+  ): T {
+    const options: ReqValidationOptions<ZodValidationError> = {
+      keepOriginal: true,
+      ...opt,
+    }
+    return this.validate(req, 'headers', schema, options)
+  }
+
+  private validate<T>(
+    req: BackendRequest,
+    reqProperty: 'body' | 'params' | 'query' | 'headers',
+    schema: ZodType<T>,
+    opt: ReqValidationOptions<ZodValidationError> = {},
+  ): T {
+    const { data, error } = zSafeValidate(
+      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)
+      }
+
+      throw new AppError(error.message, {
+        backendResponseStatusCode: 400,
+        report,
+        ...error.data,
+      })
+    }
+
+    // mutate req to replace the property with the value, converted by Joi
+    if (!opt.keepOriginal && reqProperty !== 'query') {
+      // query is read-only in Express 5
+      req[reqProperty] = data
+    }
+
+    return data
+  }
+}
+
+export const zodValidateRequest = new ZodValidateRequest()
+
+const REDACTED = 'REDACTED'
+
+/**
+ * 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.replaceAll(secret, REDACTED)
+    })
+}

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

@@ -1,9 +0,0 @@
-import type { JsonSchema, JsonSchemaBuilder } from '@naturalcycles/js-lib';
-import type { AjvValidationError } from '@naturalcycles/nodejs-lib';
-import { AjvSchema } from '@naturalcycles/nodejs-lib';
-import type { BackendRequestHandler } from '../server.model.js';
-import type { ReqValidationOptions } from './validateRequest.js';
-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

@@ -1,54 +0,0 @@
-import { _get, AppError } from '@naturalcycles/js-lib';
-import { AjvSchema } from '@naturalcycles/nodejs-lib';
-const REDACTED = 'REDACTED';
-export function validateBody(schema, opt = {}) {
-    return validateObject('body', schema, opt);
-}
-export function validateParams(schema, opt = {}) {
-    return validateObject('params', schema, opt);
-}
-export function validateQuery(schema, opt = {}) {
-    return validateObject('query', schema, opt);
-}
-export function validateHeaders(schema, opt = {}) {
-    return validateObject('headers', schema, opt);
-}
-/**
- * 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 validateObject(prop, schema, opt = {}) {
-    const ajvSchema = AjvSchema.create(schema, {
-        objectName: `request ${prop}`,
-    });
-    const reportPredicate = typeof opt.report === 'function' ? opt.report : () => opt.report;
-    return (req, _res, next) => {
-        const error = ajvSchema.getValidationError(req[prop] || {});
-        if (error) {
-            const report = reportPredicate(error);
-            if (opt.redactPaths) {
-                redact(opt.redactPaths, req[prop], error);
-                error.data.errors.length = 0; // clears the array
-            }
-            return next(new AppError(error.message, {
-                backendResponseStatusCode: 400,
-                report,
-                ...error.data,
-            }));
-        }
-        next();
-    };
-}
-/**
- * Mutates error
- */
-function redact(redactPaths, obj, error) {
-    redactPaths
-        .map(path => _get(obj, path))
-        .filter(Boolean)
-        .forEach(secret => {
-        error.message = error.message.replaceAll(secret, REDACTED);
-    });
-}

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

@@ -1,10 +0,0 @@
-import type { ZodType, ZodValidationError } from '@naturalcycles/js-lib/zod';
-import type { BackendRequestHandler } from '../server.model.js';
-import type { ReqValidationOptions } from './validateRequest.js';
-/**
- * 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: ZodType, opt?: ReqValidationOptions<ZodValidationError>): BackendRequestHandler;

package/dist/server/validation/zodValidateMiddleware.js

@@ -1,37 +0,0 @@
-import { _get, AppError } from '@naturalcycles/js-lib';
-import { zSafeValidate } from '@naturalcycles/js-lib/zod';
-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, schema, opt = {}) {
-    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 AppError(error.message, {
-            backendResponseStatusCode: 400,
-            report,
-        }));
-    };
-}
-/**
- * Mutates error
- */
-function redact(redactPaths, obj, error) {
-    redactPaths
-        .map(path => _get(obj, path))
-        .filter(Boolean)
-        .forEach(secret => {
-        error.message = error.message.replace(secret, REDACTED);
-    });
-}

package/src/server/validation/validateMiddleware.ts

@@ -1,89 +0,0 @@
-import type { JsonSchema, JsonSchemaBuilder } from '@naturalcycles/js-lib'
-import { _get, AppError } from '@naturalcycles/js-lib'
-import type { AjvValidationError } from '@naturalcycles/nodejs-lib'
-import { AjvSchema } from '@naturalcycles/nodejs-lib'
-import type { BackendRequestHandler } from '../server.model.js'
-import type { ReqValidationOptions } from './validateRequest.js'
-
-const REDACTED = 'REDACTED'
-
-export function validateBody(
-  schema: JsonSchema | JsonSchemaBuilder | AjvSchema,
-  opt: ReqValidationOptions<AjvValidationError> = {},
-): BackendRequestHandler {
-  return validateObject('body', schema, opt)
-}
-
-export function validateParams(
-  schema: JsonSchema | JsonSchemaBuilder | AjvSchema,
-  opt: ReqValidationOptions<AjvValidationError> = {},
-): BackendRequestHandler {
-  return validateObject('params', schema, opt)
-}
-
-export function validateQuery(
-  schema: JsonSchema | JsonSchemaBuilder | AjvSchema,
-  opt: ReqValidationOptions<AjvValidationError> = {},
-): BackendRequestHandler {
-  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).
- * Able to redact sensitive data from the error message.
- * Throws http 400 on error.
- */
-function validateObject(
-  prop: 'body' | 'params' | 'query' | 'headers',
-  schema: JsonSchema | JsonSchemaBuilder | AjvSchema,
-  opt: ReqValidationOptions<AjvValidationError> = {},
-): BackendRequestHandler {
-  const ajvSchema = AjvSchema.create(schema, {
-    objectName: `request ${prop}`,
-  })
-
-  const reportPredicate =
-    typeof opt.report === 'function' ? opt.report : () => opt.report as boolean | undefined
-
-  return (req, _res, next) => {
-    const error = ajvSchema.getValidationError(req[prop] || {})
-    if (error) {
-      const report = reportPredicate(error)
-
-      if (opt.redactPaths) {
-        redact(opt.redactPaths, req[prop], error)
-        error.data.errors.length = 0 // clears the array
-      }
-
-      return next(
-        new AppError(error.message, {
-          backendResponseStatusCode: 400,
-          report,
-          ...error.data,
-        }),
-      )
-    }
-
-    next()
-  }
-}
-
-/**
- * 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.replaceAll(secret, REDACTED)
-    })
-}

package/src/server/validation/zodValidateMiddleware.ts

@@ -1,54 +0,0 @@
-import { _get, AppError } from '@naturalcycles/js-lib'
-import type { ZodType, ZodValidationError } from '@naturalcycles/js-lib/zod'
-import { zSafeValidate } from '@naturalcycles/js-lib/zod'
-import type { BackendRequestHandler } from '../server.model.js'
-import type { ReqValidationOptions } from './validateRequest.js'
-
-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: ZodType,
-  opt: ReqValidationOptions<ZodValidationError> = {},
-): BackendRequestHandler {
-  const reportPredicate =
-    typeof opt.report === 'function' ? opt.report : () => opt.report as boolean | undefined
-
-  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 AppError(error.message, {
-        backendResponseStatusCode: 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)
-    })
-}