@naturalcycles/backend-lib 9.49.2 → 9.51.0

package/dist/db/httpDBRequestHandler.js

@@ -3,7 +3,7 @@ import { InMemoryDB } from '@naturalcycles/db-lib/inmemory';
 import { commonDBOptionsSchema, commonDBSaveOptionsSchema, dbQuerySchema, } from '@naturalcycles/db-lib/validation';
 import { j } from '@naturalcycles/nodejs-lib/ajv';
 import { getDefaultRouter } from '../express/getDefaultRouter.js';
-import { ajvValidateRequest } from '../validation/ajv/ajvValidateRequest.js';
+import { validateRequest } from '../validation/ajv/validateRequest.js';
 const getByIdsInputSchema = j.object({
     table: j.string(),
     ids: j.array(j.string()),
@@ -49,24 +49,24 @@ export function httpDBRequestHandler(db) {
     // })
     // getByIds
     router.put('/getByIds', async (req, res) => {
-        const { table, ids, opt } = ajvValidateRequest.body(req, getByIdsInputSchema);
+        const { table, ids, opt } = validateRequest.body(req, getByIdsInputSchema);
         res.json(await db.getByIds(table, ids, opt));
     });
     // runQuery
     router.put('/runQuery', async (req, res) => {
-        const { query, opt } = ajvValidateRequest.body(req, runQueryInputSchema);
+        const { query, opt } = validateRequest.body(req, runQueryInputSchema);
         const q = DBQuery.fromPlainObject(query);
         res.json(await db.runQuery(q, opt));
     });
     // runQueryCount
     router.put('/runQueryCount', async (req, res) => {
-        const { query, opt } = ajvValidateRequest.body(req, runQueryInputSchema);
+        const { query, opt } = validateRequest.body(req, runQueryInputSchema);
         const q = DBQuery.fromPlainObject(query);
         res.json(await db.runQueryCount(q, opt));
     });
     // saveBatch
     router.put('/saveBatch', async (req, res) => {
-        const { table, rows, opt } = ajvValidateRequest.body(req, saveBatchInputSchema);
+        const { table, rows, opt } = validateRequest.body(req, saveBatchInputSchema);
         await db.saveBatch(table, rows, opt);
         res.end();
     });
@@ -77,7 +77,7 @@ export function httpDBRequestHandler(db) {
     // })
     // deleteByQuery
     router.put('/deleteByQuery', async (req, res) => {
-        const { query, opt } = ajvValidateRequest.body(req, runQueryInputSchema);
+        const { query, opt } = validateRequest.body(req, runQueryInputSchema);
         const q = DBQuery.fromPlainObject(query);
         res.json(await db.deleteByQuery(q, opt));
     });

package/dist/validation/ajv/{ajvValidateRequest.d.ts → validateRequest.d.ts}

@@ -28,5 +28,5 @@ declare class AjvValidateRequest {
     headers<IN, OUT>(req: BackendRequest, schema: SchemaHandledByAjv<IN, OUT>, opt?: ReqValidationOptions<AjvValidationError>): OUT;
     private validate;
 }
-export declare const ajvValidateRequest: AjvValidateRequest;
+export declare const validateRequest: AjvValidateRequest;
 export {};

package/dist/validation/ajv/{ajvValidateRequest.js → validateRequest.js}

@@ -60,4 +60,4 @@ class AjvValidateRequest {
         return output;
     }
 }
-export const ajvValidateRequest = new AjvValidateRequest();
+export const validateRequest = new AjvValidateRequest();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/backend-lib",
   "type": "module",
-  "version": "9.49.2",
+  "version": "9.51.0",
   "peerDependencies": {
     "@sentry/node": "^10"
   },
@@ -45,8 +45,7 @@
     "./deploy": "./dist/deploy/index.js",
     "./deploy/*.js": "./dist/deploy/*.js",
     "./express/*.js": "./dist/express/*.js",
-    "./ajvValidateRequest": "./dist/validation/ajv/ajvValidateRequest.js",
-    "./joiValidateRequest": "./dist/validation/joi/joiValidateRequest.js",
+    "./ajvValidateRequest": "./dist/validation/ajv/validateRequest.js",
     "./zodValidateRequest": "./dist/validation/zod/zodValidateRequest.js",
     "./onFinished": "./dist/onFinished.js",
     "./testing": "./dist/testing/index.js"

package/src/db/httpDBRequestHandler.ts

@@ -10,7 +10,7 @@ import type { ObjectWithId } from '@naturalcycles/js-lib/types'
 import { j } from '@naturalcycles/nodejs-lib/ajv'
 import { getDefaultRouter } from '../express/getDefaultRouter.js'
 import type { BackendRouter } from '../server/server.model.js'
-import { ajvValidateRequest } from '../validation/ajv/ajvValidateRequest.js'
+import { validateRequest } from '../validation/ajv/validateRequest.js'
 
 export interface GetByIdsInput {
   table: string
@@ -83,27 +83,27 @@ export function httpDBRequestHandler(db: CommonDB): BackendRouter {
 
   // getByIds
   router.put('/getByIds', async (req, res) => {
-    const { table, ids, opt } = ajvValidateRequest.body(req, getByIdsInputSchema)
+    const { table, ids, opt } = validateRequest.body(req, getByIdsInputSchema)
     res.json(await db.getByIds(table, ids, opt))
   })
 
   // runQuery
   router.put('/runQuery', async (req, res) => {
-    const { query, opt } = ajvValidateRequest.body(req, runQueryInputSchema)
+    const { query, opt } = validateRequest.body(req, runQueryInputSchema)
     const q = DBQuery.fromPlainObject(query)
     res.json(await db.runQuery(q, opt))
   })
 
   // runQueryCount
   router.put('/runQueryCount', async (req, res) => {
-    const { query, opt } = ajvValidateRequest.body(req, runQueryInputSchema)
+    const { query, opt } = validateRequest.body(req, runQueryInputSchema)
     const q = DBQuery.fromPlainObject(query)
     res.json(await db.runQueryCount(q, opt))
   })
 
   // saveBatch
   router.put('/saveBatch', async (req, res) => {
-    const { table, rows, opt } = ajvValidateRequest.body(req, saveBatchInputSchema)
+    const { table, rows, opt } = validateRequest.body(req, saveBatchInputSchema)
     await db.saveBatch(table, rows, opt)
     res.end()
   })
@@ -116,7 +116,7 @@ export function httpDBRequestHandler(db: CommonDB): BackendRouter {
 
   // deleteByQuery
   router.put('/deleteByQuery', async (req, res) => {
-    const { query, opt } = ajvValidateRequest.body(req, runQueryInputSchema)
+    const { query, opt } = validateRequest.body(req, runQueryInputSchema)
     const q = DBQuery.fromPlainObject(query)
     res.json(await db.deleteByQuery(q, opt))
   })

package/src/validation/ajv/{ajvValidateRequest.ts → validateRequest.ts}

@@ -104,4 +104,4 @@ class AjvValidateRequest {
   }
 }
 
-export const ajvValidateRequest = new AjvValidateRequest()
+export const validateRequest = new AjvValidateRequest()

package/dist/validation/joi/joiValidateRequest.d.ts

@@ -1,21 +0,0 @@
-import type { AnySchema, JoiValidationError } from '@naturalcycles/nodejs-lib/joi';
-import type { BackendRequest } from '../../server/server.model.js';
-import { type ReqValidationOptions } from '../validateRequest.util.js';
-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;
-export {};

package/dist/validation/joi/joiValidateRequest.js

@@ -1,41 +0,0 @@
-import { getValidationResult } from '@naturalcycles/nodejs-lib/joi';
-import { handleValidationError } from '../validateRequest.util.js';
-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);
-    }
-    /**
-     * 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);
-    }
-    validate(req, reqProperty, schema, opt = {}) {
-        const originalProperty = (req[reqProperty] || {});
-        // Joi does not mutate the input
-        const [error, value] = getValidationResult(originalProperty, schema, `request.${reqProperty}`);
-        if (error) {
-            if (opt.redactPaths) {
-                error.data.joiValidationErrorItems.length = 0; // clears the array
-                delete error.data.annotation;
-            }
-            handleValidationError(error, originalProperty, opt);
-        }
-        // Kirill: decide to not do it, let's see
-        // req[reqProperty] = value
-        return value;
-    }
-}
-export const validateRequest = new ValidateRequest();

package/src/validation/joi/joiValidateRequest.ts

@@ -1,75 +0,0 @@
-import type { AnySchema, JoiValidationError } from '@naturalcycles/nodejs-lib/joi'
-import { getValidationResult } from '@naturalcycles/nodejs-lib/joi'
-import type { BackendRequest } from '../../server/server.model.js'
-import { handleValidationError, type ReqValidationOptions } from '../validateRequest.util.js'
-
-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)
-  }
-
-  /**
-   * 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)
-  }
-
-  private validate<T>(
-    req: BackendRequest,
-    reqProperty: 'body' | 'params' | 'query' | 'headers',
-    schema: AnySchema<T>,
-    opt: ReqValidationOptions<JoiValidationError> = {},
-  ): T {
-    const originalProperty = (req[reqProperty] || {}) as T
-
-    // Joi does not mutate the input
-    const [error, value] = getValidationResult(originalProperty, schema, `request.${reqProperty}`)
-
-    if (error) {
-      if (opt.redactPaths) {
-        error.data.joiValidationErrorItems.length = 0 // clears the array
-        delete error.data.annotation
-      }
-
-      handleValidationError(error, originalProperty, opt)
-    }
-
-    // Kirill: decide to not do it, let's see
-    // req[reqProperty] = value
-
-    return value
-  }
-}
-
-export const validateRequest = new ValidateRequest()