@naturalcycles/backend-lib 9.53.0 → 9.55.0

package/dist/deploy/backend.cfg.util.js

@@ -1,11 +1,11 @@
 import { _lazyValue } from '@naturalcycles/js-lib';
-import { AjvSchema } from '@naturalcycles/nodejs-lib/ajv';
+import { JSchema } from '@naturalcycles/nodejs-lib/ajv';
 import { fs2 } from '@naturalcycles/nodejs-lib/fs2';
 import { yaml2 } from '@naturalcycles/nodejs-lib/yaml2';
 import { resourcesDir } from '../paths.cnst.js';
 const getBackendCfgSchema = _lazyValue(() => {
     const schemaJson = fs2.readJson(`${resourcesDir}/backendCfg.schema.json`);
-    return AjvSchema.create(schemaJson, { inputName: 'backend.cfg.yaml' });
+    return new JSchema(schemaJson, { inputName: 'backend.cfg.yaml' });
 });
 export function getBackendCfg(projectDir = '.') {
     const backendCfgYamlPath = `${projectDir}/backend.cfg.yaml`;

package/dist/validation/ajv/validateRequest.js

@@ -1,4 +1,4 @@
-import { AjvSchema, getCoercingAjv } from '@naturalcycles/nodejs-lib/ajv';
+import { AjvSchema, getCoercingAjv, JSchema } from '@naturalcycles/nodejs-lib/ajv';
 import { handleValidationError } from '../validateRequest.util.js';
 class AjvValidateRequest {
     body(req, schema, opt = {}) {
@@ -48,8 +48,11 @@ class AjvValidateRequest {
         const input = req[reqProperty] || {};
         const { coerceTypes, mutateInput } = opt;
         const ajv = coerceTypes ? getCoercingAjv() : undefined;
-        const ajvSchema = AjvSchema.create(schema, { ajv });
-        const [error, output] = ajvSchema.getValidationResult(input, {
+        const validatable = schema instanceof JSchema || schema instanceof AjvSchema
+            ? schema
+            : new JSchema(schema);
+        const [error, output] = validatable.getValidationResult(input, {
+            ajv,
             inputName: `request.${reqProperty}`,
             getOriginalInput,
             mutateInput,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/backend-lib",
   "type": "module",
-  "version": "9.53.0",
+  "version": "9.55.0",
   "peerDependencies": {
     "@sentry/node-core": "^10"
   },
@@ -46,7 +46,6 @@
     "./deploy/*.js": "./dist/deploy/*.js",
     "./express/*.js": "./dist/express/*.js",
     "./validateRequest": "./dist/validation/ajv/validateRequest.js",
-    "./zodValidateRequest": "./dist/validation/zod/zodValidateRequest.js",
     "./onFinished": "./dist/onFinished.js",
     "./testing": "./dist/testing/index.js"
   },

package/src/deploy/backend.cfg.util.ts

@@ -1,6 +1,6 @@
 import { _lazyValue } from '@naturalcycles/js-lib'
 import type { StringMap } from '@naturalcycles/js-lib/types'
-import { AjvSchema } from '@naturalcycles/nodejs-lib/ajv'
+import { JSchema } from '@naturalcycles/nodejs-lib/ajv'
 import type { JsonSchema } from '@naturalcycles/nodejs-lib/ajv'
 import { fs2 } from '@naturalcycles/nodejs-lib/fs2'
 import { yaml2 } from '@naturalcycles/nodejs-lib/yaml2'
@@ -42,7 +42,7 @@ export interface BackendCfg {
 
 const getBackendCfgSchema = _lazyValue(() => {
   const schemaJson = fs2.readJson<JsonSchema<BackendCfg>>(`${resourcesDir}/backendCfg.schema.json`)
-  return AjvSchema.create(schemaJson, { inputName: 'backend.cfg.yaml' })
+  return new JSchema<BackendCfg, false>(schemaJson, { inputName: 'backend.cfg.yaml' })
 })
 
 export function getBackendCfg(projectDir = '.'): BackendCfg {

package/src/validation/ajv/validateRequest.ts

@@ -1,4 +1,4 @@
-import { AjvSchema, getCoercingAjv } from '@naturalcycles/nodejs-lib/ajv'
+import { AjvSchema, getCoercingAjv, JSchema } from '@naturalcycles/nodejs-lib/ajv'
 import type { AjvValidationError, SchemaHandledByAjv } from '@naturalcycles/nodejs-lib/ajv'
 import type { BackendRequest } from '../../server/server.model.js'
 import { handleValidationError } from '../validateRequest.util.js'
@@ -85,9 +85,14 @@ class AjvValidateRequest {
 
     const { coerceTypes, mutateInput } = opt
     const ajv = coerceTypes ? getCoercingAjv() : undefined
-    const ajvSchema = AjvSchema.create(schema, { ajv })
 
-    const [error, output] = ajvSchema.getValidationResult(input, {
+    const validatable =
+      schema instanceof JSchema || schema instanceof AjvSchema
+        ? schema
+        : new JSchema<OUT, false>(schema)
+
+    const [error, output] = validatable.getValidationResult(input, {
+      ajv,
       inputName: `request.${reqProperty}`,
       getOriginalInput,
       mutateInput,

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

@@ -1,21 +0,0 @@
-import type { ZodType, ZodValidationError } from '@naturalcycles/js-lib/zod';
-import type { BackendRequest } from '../../server/server.model.js';
-import type { ReqValidationOptions } from '../validateRequest.util.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/validation/zod/zodValidateRequest.js

@@ -1,39 +0,0 @@
-import { zSafeValidate } from '@naturalcycles/js-lib/zod';
-import { handleValidationError } from '../validateRequest.util.js';
-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 = {}) {
-        return this.validate(req, 'headers', schema, opt);
-    }
-    validate(req, reqProperty, schema, opt = {}) {
-        const originalProperty = (req[reqProperty] || {});
-        // Zod does not mutate the input
-        const [error, data] = zSafeValidate(originalProperty, schema
-        // opt2?.itemName,
-        );
-        if (error) {
-            handleValidationError(error, originalProperty, opt);
-        }
-        // Kirill: decide to not do it, let's see
-        // req[reqProperty] = data
-        return data;
-    }
-}
-export const zodValidateRequest = new ZodValidateRequest();

package/src/validation/zod/zodValidateRequest.ts

@@ -1,75 +0,0 @@
-import { zSafeValidate } from '@naturalcycles/js-lib/zod'
-import type { ZodType, ZodValidationError } from '@naturalcycles/js-lib/zod'
-import type { BackendRequest } from '../../server/server.model.js'
-import { handleValidationError } from '../validateRequest.util.js'
-import type { ReqValidationOptions } from '../validateRequest.util.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 {
-    return this.validate(req, 'headers', schema, opt)
-  }
-
-  private validate<T>(
-    req: BackendRequest,
-    reqProperty: 'body' | 'params' | 'query' | 'headers',
-    schema: ZodType<T>,
-    opt: ReqValidationOptions<ZodValidationError> = {},
-  ): T {
-    const originalProperty = (req[reqProperty] || {}) as T
-
-    // Zod does not mutate the input
-    const [error, data] = zSafeValidate(
-      originalProperty,
-      schema,
-      // opt2?.itemName,
-    )
-
-    if (error) {
-      handleValidationError(error, originalProperty, opt)
-    }
-
-    // Kirill: decide to not do it, let's see
-    // req[reqProperty] = data
-
-    return data
-  }
-}
-
-export const zodValidateRequest = new ZodValidateRequest()