@naturalcycles/nodejs-lib 14.6.0 → 14.7.0

package/dist/validation/ajv/ajvSchema.d.ts

@@ -1,19 +1,10 @@
-import type { CommonLogger, JsonSchema, JsonSchemaBuilder } from '@naturalcycles/js-lib';
+import type { JsonSchema, JsonSchemaBuilder } from '@naturalcycles/js-lib';
+import type { ZodJSONSchema } from '@naturalcycles/js-lib/zod';
 import type { Ajv } from 'ajv';
 import { AjvValidationError } from './ajvValidationError.js';
 export interface AjvValidationOptions {
     objectName?: string;
     objectId?: string;
-    /**
-     * @default to cfg.logErrors, which defaults to true
-     */
-    logErrors?: boolean;
-    /**
-     * Used to separate multiple validation errors.
-     *
-     * @default cfg.separator || '\n'
-     */
-    separator?: string;
 }
 export interface AjvSchemaCfg {
     /**
@@ -27,20 +18,6 @@ export interface AjvSchemaCfg {
      */
     schemas?: (JsonSchema | JsonSchemaBuilder | AjvSchema)[];
     objectName?: string;
-    /**
-     * Used to separate multiple validation errors.
-     *
-     * @default '\n'
-     */
-    separator: string;
-    /**
-     * @default true
-     */
-    logErrors: boolean;
-    /**
-     * Default to `console`
-     */
-    logger: CommonLogger;
     /**
      * Option of Ajv.
      * If set to true - will mutate your input objects!
@@ -68,7 +45,7 @@ export declare class AjvSchema<T = unknown> {
      * Implementation note: JsonSchemaBuilder goes first in the union type, otherwise TypeScript fails to infer <T> type
      * correctly for some reason.
      */
-    static create<T>(schema: JsonSchemaBuilder<T> | JsonSchema<T> | AjvSchema<T>, cfg?: Partial<AjvSchemaCfg>): AjvSchema<T>;
+    static create<T>(schema: JsonSchemaBuilder<T> | JsonSchema<T> | AjvSchema<T> | ZodJSONSchema, cfg?: Partial<AjvSchemaCfg>): AjvSchema<T>;
     /**
      * Create AjvSchema directly from a filePath of json schema.
      * Convenient method that just does fs.readFileSync for you.
@@ -85,6 +62,6 @@ export declare class AjvSchema<T = unknown> {
      * Returned object is always the same object (`===`) that was passed, so it is returned just for convenience.
      */
     validate(obj: T, opt?: AjvValidationOptions): T;
-    getValidationError(obj: T, opt?: AjvValidationOptions): AjvValidationError | undefined;
     isValid(obj: T): boolean;
+    getValidationError(obj: T, opt?: AjvValidationOptions): AjvValidationError | undefined;
 }

package/dist/validation/ajv/ajvSchema.js

@@ -14,9 +14,6 @@ export class AjvSchema {
     constructor(schema, cfg = {}) {
         this.schema = schema;
         this.cfg = {
-            logErrors: true,
-            logger: console,
-            separator: '\n',
             ...cfg,
             ajv: cfg.ajv ||
                 getAjv({
@@ -77,11 +74,14 @@ export class AjvSchema {
             throw err;
         return obj;
     }
+    isValid(obj) {
+        return this.validateFunction(obj);
+    }
     getValidationError(obj, opt = {}) {
         if (this.isValid(obj))
             return;
         const errors = this.validateFunction.errors;
-        const { objectId = _isObject(obj) ? obj['id'] : undefined, objectName = this.cfg.objectName, logErrors = this.cfg.logErrors, separator = this.cfg.separator, } = opt;
+        const { objectId = _isObject(obj) ? obj['id'] : undefined, objectName = this.cfg.objectName, } = opt;
         const name = [objectName || 'Object', objectId].filter(Boolean).join('.');
         let message = this.cfg.ajv.errorsText(errors, {
             dataVar: name,
@@ -89,17 +89,11 @@ export class AjvSchema {
         });
         const strValue = _inspect(obj, { maxLen: 1000 });
         message = [message, 'Input: ' + strValue].join(separator);
-        if (logErrors) {
-            this.cfg.logger.error(errors);
-        }
         return new AjvValidationError(message, _filterNullishValues({
             errors,
-            userFriendly: true,
             objectName,
             objectId,
         }));
     }
-    isValid(obj) {
-        return this.validateFunction(obj);
-    }
 }
+const separator = '\n';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/nodejs-lib",
   "type": "module",
-  "version": "14.6.0",
+  "version": "14.7.0",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@types/js-yaml": "^4",

package/src/validation/ajv/ajvSchema.ts

@@ -1,10 +1,11 @@
-import type { CommonLogger, JsonSchema, JsonSchemaBuilder } from '@naturalcycles/js-lib'
+import type { JsonSchema, JsonSchemaBuilder } from '@naturalcycles/js-lib'
 import {
   _filterNullishValues,
   _isObject,
   _substringBefore,
   JsonSchemaAnyBuilder,
 } from '@naturalcycles/js-lib'
+import type { ZodJSONSchema } from '@naturalcycles/js-lib/zod'
 import type { Ajv, ValidateFunction } from 'ajv'
 import { fs2 } from '../../fs/fs2.js'
 import { _inspect } from '../../string/inspect.js'
@@ -14,18 +15,6 @@ import { getAjv } from './getAjv.js'
 export interface AjvValidationOptions {
   objectName?: string
   objectId?: string
-
-  /**
-   * @default to cfg.logErrors, which defaults to true
-   */
-  logErrors?: boolean
-
-  /**
-   * Used to separate multiple validation errors.
-   *
-   * @default cfg.separator || '\n'
-   */
-  separator?: string
 }
 
 export interface AjvSchemaCfg {
@@ -43,23 +32,6 @@ export interface AjvSchemaCfg {
 
   objectName?: string
 
-  /**
-   * Used to separate multiple validation errors.
-   *
-   * @default '\n'
-   */
-  separator: string
-
-  /**
-   * @default true
-   */
-  logErrors: boolean
-
-  /**
-   * Default to `console`
-   */
-  logger: CommonLogger
-
   /**
    * Option of Ajv.
    * If set to true - will mutate your input objects!
@@ -82,9 +54,6 @@ export class AjvSchema<T = unknown> {
     cfg: Partial<AjvSchemaCfg> = {},
   ) {
     this.cfg = {
-      logErrors: true,
-      logger: console,
-      separator: '\n',
       ...cfg,
       ajv:
         cfg.ajv ||
@@ -114,7 +83,7 @@ export class AjvSchema<T = unknown> {
    * correctly for some reason.
    */
   static create<T>(
-    schema: JsonSchemaBuilder<T> | JsonSchema<T> | AjvSchema<T>,
+    schema: JsonSchemaBuilder<T> | JsonSchema<T> | AjvSchema<T> | ZodJSONSchema,
     cfg: Partial<AjvSchemaCfg> = {},
   ): AjvSchema<T> {
     if (schema instanceof AjvSchema) return schema
@@ -154,6 +123,10 @@ export class AjvSchema<T = unknown> {
     return obj
   }
 
+  isValid(obj: T): boolean {
+    return this.validateFunction(obj)
+  }
+
   getValidationError(obj: T, opt: AjvValidationOptions = {}): AjvValidationError | undefined {
     if (this.isValid(obj)) return
 
@@ -162,8 +135,6 @@ export class AjvSchema<T = unknown> {
     const {
       objectId = _isObject(obj) ? (obj['id' as keyof T] as any) : undefined,
       objectName = this.cfg.objectName,
-      logErrors = this.cfg.logErrors,
-      separator = this.cfg.separator,
     } = opt
     const name = [objectName || 'Object', objectId].filter(Boolean).join('.')
 
@@ -175,22 +146,15 @@ export class AjvSchema<T = unknown> {
     const strValue = _inspect(obj, { maxLen: 1000 })
     message = [message, 'Input: ' + strValue].join(separator)
 
-    if (logErrors) {
-      this.cfg.logger.error(errors)
-    }
-
     return new AjvValidationError(
       message,
       _filterNullishValues({
         errors,
-        userFriendly: true,
         objectName,
         objectId,
       }),
     )
   }
-
-  isValid(obj: T): boolean {
-    return this.validateFunction(obj)
-  }
 }
+
+const separator = '\n'