@naturalcycles/nodejs-lib 15.34.0 → 15.35.0

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

@@ -1,8 +1,10 @@
 import { type ValidationFunction, type ValidationFunctionResult } from '@naturalcycles/js-lib';
 import type { JsonSchema, JsonSchemaBuilder } from '@naturalcycles/js-lib/json-schema';
+import type { AnyObject } from '@naturalcycles/js-lib/types';
 import { ZodType } from '@naturalcycles/js-lib/zod';
 import type { Ajv } from 'ajv';
 import { AjvValidationError } from './ajvValidationError.js';
+export type SchemaHandledByAjv<T> = JsonSchemaBuilder<T> | JsonSchema<T> | AjvSchema<T> | ZodType<T>;
 export interface AjvValidationOptions {
     /**
      * Defaults to true,
@@ -63,11 +65,15 @@ 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> | ZodType<T>, cfg?: Partial<AjvSchemaCfg>): AjvSchema<T>;
+    static create<T>(schema: SchemaHandledByAjv<T>, cfg?: Partial<AjvSchemaCfg>): AjvSchema<T>;
     /**
-     * @experimental
+     * @deprecated
+     *
+     * Use `AjvSchema.create`
      */
     static createFromZod<T>(zodSchema: ZodType<T>, cfg?: Partial<AjvSchemaCfg>): AjvSchema<T>;
+    static isJsonSchemaBuilder<T>(schema: unknown): schema is JsonSchemaBuilder<T>;
+    static isZodSchema<T>(schema: unknown): schema is ZodType<T>;
     readonly cfg: AjvSchemaCfg;
     /**
      * It returns the original object just for convenience.
@@ -81,12 +87,12 @@ export declare class AjvSchema<T = unknown> {
     isValid(input: T, opt?: AjvValidationOptions): boolean;
     getValidationResult(input: T, opt?: AjvValidationOptions): ValidationFunctionResult<T, AjvValidationError>;
     getValidationFunction(): ValidationFunction<T, AjvValidationError>;
-    static isZodSchemaWithAjvSchema<T>(schema: ZodType<T>): schema is ZodTypeWithAjvSchema<T>;
-    static cacheAjvSchemaInZodSchema<T>(zodSchema: ZodType<T>, ajvSchema: AjvSchema<T>): ZodTypeWithAjvSchema<T>;
-    static requireCachedAjvSchemaFromZodSchema<T>(zodSchema: ZodTypeWithAjvSchema<T>): AjvSchema<T>;
+    static isSchemaWithCachedAjvSchema<Base, T>(schema: Base): schema is WithCachedAjvSchema<Base, T>;
+    static cacheAjvSchema<Base extends AnyObject, T>(schema: Base, ajvSchema: AjvSchema<T>): WithCachedAjvSchema<Base, T>;
+    static requireCachedAjvSchema<Base, T>(schema: WithCachedAjvSchema<Base, T>): AjvSchema<T>;
     private getAJVValidateFunction;
 }
 export declare const HIDDEN_AJV_SCHEMA: unique symbol;
-export interface ZodTypeWithAjvSchema<T> extends ZodType<T> {
+export type WithCachedAjvSchema<Base, T> = Base & {
     [HIDDEN_AJV_SCHEMA]: AjvSchema<T>;
-}
+};

package/dist/validation/ajv/ajvSchema.js

@@ -46,24 +46,36 @@ export class AjvSchema {
     static create(schema, cfg) {
         if (schema instanceof AjvSchema)
             return schema;
-        if (schema instanceof JsonSchemaAnyBuilder) {
-            return new AjvSchema(schema.build(), cfg);
+        if (AjvSchema.isSchemaWithCachedAjvSchema(schema)) {
+            return AjvSchema.requireCachedAjvSchema(schema);
         }
-        if (schema instanceof ZodType)
-            return AjvSchema.createFromZod(schema);
-        return new AjvSchema(schema, cfg);
+        let jsonSchema;
+        if (AjvSchema.isJsonSchemaBuilder(schema)) {
+            jsonSchema = schema.build();
+        }
+        else if (AjvSchema.isZodSchema(schema)) {
+            jsonSchema = z.toJSONSchema(schema, { target: 'draft-7' });
+        }
+        else {
+            jsonSchema = schema;
+        }
+        const ajvSchema = new AjvSchema(jsonSchema, cfg);
+        AjvSchema.cacheAjvSchema(schema, ajvSchema);
+        return ajvSchema;
     }
     /**
-     * @experimental
+     * @deprecated
+     *
+     * Use `AjvSchema.create`
      */
     static createFromZod(zodSchema, cfg) {
-        if (AjvSchema.isZodSchemaWithAjvSchema(zodSchema)) {
-            return AjvSchema.requireCachedAjvSchemaFromZodSchema(zodSchema);
-        }
-        const jsonSchema = z.toJSONSchema(zodSchema, { target: 'draft-7' });
-        const ajvSchema = new AjvSchema(jsonSchema, cfg);
-        AjvSchema.cacheAjvSchemaInZodSchema(zodSchema, ajvSchema);
-        return ajvSchema;
+        return AjvSchema.create(zodSchema, cfg);
+    }
+    static isJsonSchemaBuilder(schema) {
+        return schema instanceof JsonSchemaAnyBuilder;
+    }
+    static isZodSchema(schema) {
+        return schema instanceof ZodType;
     }
     cfg;
     /**
@@ -121,14 +133,14 @@ export class AjvSchema {
             });
         };
     }
-    static isZodSchemaWithAjvSchema(schema) {
-        return !!schema[HIDDEN_AJV_SCHEMA];
+    static isSchemaWithCachedAjvSchema(schema) {
+        return !!schema?.[HIDDEN_AJV_SCHEMA];
     }
-    static cacheAjvSchemaInZodSchema(zodSchema, ajvSchema) {
-        return Object.assign(zodSchema, { [HIDDEN_AJV_SCHEMA]: ajvSchema });
+    static cacheAjvSchema(schema, ajvSchema) {
+        return Object.assign(schema, { [HIDDEN_AJV_SCHEMA]: ajvSchema });
     }
-    static requireCachedAjvSchemaFromZodSchema(zodSchema) {
-        return zodSchema[HIDDEN_AJV_SCHEMA];
+    static requireCachedAjvSchema(schema) {
+        return schema[HIDDEN_AJV_SCHEMA];
     }
     getAJVValidateFunction = _lazyValue(() => this.cfg.ajv.compile(this.schema));
 }

package/package.json

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

package/src/validation/ajv/ajvSchema.ts

@@ -8,12 +8,15 @@ import type { JsonSchema, JsonSchemaBuilder } from '@naturalcycles/js-lib/json-s
 import { JsonSchemaAnyBuilder } from '@naturalcycles/js-lib/json-schema'
 import { _deepCopy, _filterNullishValues } from '@naturalcycles/js-lib/object'
 import { _substringBefore } from '@naturalcycles/js-lib/string'
+import type { AnyObject } from '@naturalcycles/js-lib/types'
 import { z, ZodType } from '@naturalcycles/js-lib/zod'
 import type { Ajv } from 'ajv'
 import { _inspect } from '../../string/inspect.js'
 import { AjvValidationError } from './ajvValidationError.js'
 import { getAjv } from './getAjv.js'
 
+export type SchemaHandledByAjv<T> = JsonSchemaBuilder<T> | JsonSchema<T> | AjvSchema<T> | ZodType<T>
+
 export interface AjvValidationOptions {
   /**
    * Defaults to true,
@@ -104,32 +107,44 @@ export 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> | ZodType<T>,
-    cfg?: Partial<AjvSchemaCfg>,
-  ): AjvSchema<T> {
+  static create<T>(schema: SchemaHandledByAjv<T>, cfg?: Partial<AjvSchemaCfg>): AjvSchema<T> {
     if (schema instanceof AjvSchema) return schema
-    if (schema instanceof JsonSchemaAnyBuilder) {
-      return new AjvSchema<T>(schema.build(), cfg)
+
+    if (AjvSchema.isSchemaWithCachedAjvSchema<typeof schema, T>(schema)) {
+      return AjvSchema.requireCachedAjvSchema<typeof schema, T>(schema)
     }
-    if (schema instanceof ZodType) return AjvSchema.createFromZod(schema)
-    return new AjvSchema<T>(schema as JsonSchema<T>, cfg)
+
+    let jsonSchema: JsonSchema<T>
+
+    if (AjvSchema.isJsonSchemaBuilder(schema)) {
+      jsonSchema = schema.build()
+    } else if (AjvSchema.isZodSchema(schema)) {
+      jsonSchema = z.toJSONSchema(schema, { target: 'draft-7' }) as JsonSchema<T>
+    } else {
+      jsonSchema = schema
+    }
+
+    const ajvSchema = new AjvSchema<T>(jsonSchema, cfg)
+    AjvSchema.cacheAjvSchema(schema, ajvSchema)
+
+    return ajvSchema
   }
 
   /**
-   * @experimental
+   * @deprecated
+   *
+   * Use `AjvSchema.create`
    */
   static createFromZod<T>(zodSchema: ZodType<T>, cfg?: Partial<AjvSchemaCfg>): AjvSchema<T> {
-    if (AjvSchema.isZodSchemaWithAjvSchema(zodSchema)) {
-      return AjvSchema.requireCachedAjvSchemaFromZodSchema(zodSchema)
-    }
-
-    const jsonSchema = z.toJSONSchema(zodSchema, { target: 'draft-7' })
-    const ajvSchema = new AjvSchema<T>(jsonSchema as JsonSchema<T>, cfg)
+    return AjvSchema.create(zodSchema, cfg)
+  }
 
-    AjvSchema.cacheAjvSchemaInZodSchema(zodSchema, ajvSchema)
+  static isJsonSchemaBuilder<T>(schema: unknown): schema is JsonSchemaBuilder<T> {
+    return schema instanceof JsonSchemaAnyBuilder
+  }
 
-    return ajvSchema
+  static isZodSchema<T>(schema: unknown): schema is ZodType<T> {
+    return schema instanceof ZodType
   }
 
   readonly cfg: AjvSchemaCfg
@@ -208,19 +223,21 @@ export class AjvSchema<T = unknown> {
     }
   }
 
-  static isZodSchemaWithAjvSchema<T>(schema: ZodType<T>): schema is ZodTypeWithAjvSchema<T> {
-    return !!(schema as any)[HIDDEN_AJV_SCHEMA]
+  static isSchemaWithCachedAjvSchema<Base, T>(
+    schema: Base,
+  ): schema is WithCachedAjvSchema<Base, T> {
+    return !!(schema as any)?.[HIDDEN_AJV_SCHEMA]
   }
 
-  static cacheAjvSchemaInZodSchema<T>(
-    zodSchema: ZodType<T>,
+  static cacheAjvSchema<Base extends AnyObject, T>(
+    schema: Base,
     ajvSchema: AjvSchema<T>,
-  ): ZodTypeWithAjvSchema<T> {
-    return Object.assign(zodSchema, { [HIDDEN_AJV_SCHEMA]: ajvSchema })
+  ): WithCachedAjvSchema<Base, T> {
+    return Object.assign(schema, { [HIDDEN_AJV_SCHEMA]: ajvSchema })
   }
 
-  static requireCachedAjvSchemaFromZodSchema<T>(zodSchema: ZodTypeWithAjvSchema<T>): AjvSchema<T> {
-    return zodSchema[HIDDEN_AJV_SCHEMA]
+  static requireCachedAjvSchema<Base, T>(schema: WithCachedAjvSchema<Base, T>): AjvSchema<T> {
+    return schema[HIDDEN_AJV_SCHEMA]
   }
 
   private getAJVValidateFunction = _lazyValue(() => this.cfg.ajv.compile<T>(this.schema))
@@ -230,6 +247,6 @@ const separator = '\n'
 
 export const HIDDEN_AJV_SCHEMA = Symbol('HIDDEN_AJV_SCHEMA')
 
-export interface ZodTypeWithAjvSchema<T> extends ZodType<T> {
+export type WithCachedAjvSchema<Base, T> = Base & {
   [HIDDEN_AJV_SCHEMA]: AjvSchema<T>
 }