@naturalcycles/nodejs-lib 15.10.1 → 15.12.0

package/dist/jwt/jwt.service.d.ts

@@ -1,8 +1,8 @@
 import type { ErrorData } from '@naturalcycles/js-lib/error';
 import type { AnyObject, JWTString } from '@naturalcycles/js-lib/types';
-import type { AnySchema } from 'joi';
 import type { Algorithm, JwtHeader, SignOptions, VerifyOptions } from 'jsonwebtoken';
 import jsonwebtoken from 'jsonwebtoken';
+import type { AjvSchema } from '../validation/ajv/ajvSchema.js';
 export { jsonwebtoken };
 export type { Algorithm, JwtHeader, SignOptions, VerifyOptions };
 export interface JWTServiceCfg {
@@ -50,9 +50,9 @@ export interface JWTServiceCfg {
 export declare class JWTService {
     cfg: JWTServiceCfg;
     constructor(cfg: JWTServiceCfg);
-    sign<T extends AnyObject>(payload: T, schema?: AnySchema<T>, opt?: SignOptions): JWTString;
-    verify<T extends AnyObject>(token: JWTString, schema?: AnySchema<T>, opt?: VerifyOptions, publicKey?: string): T;
-    decode<T extends AnyObject>(token: JWTString, schema?: AnySchema<T>): {
+    sign<T extends AnyObject>(payload: T, schema?: AjvSchema<T>, opt?: SignOptions): JWTString;
+    verify<T extends AnyObject>(token: JWTString, schema?: AjvSchema<T>, opt?: VerifyOptions, publicKey?: string): T;
+    decode<T extends AnyObject>(token: JWTString, schema?: AjvSchema<T>): {
         header: JwtHeader;
         payload: T;
         signature: string;

package/dist/jwt/jwt.service.js

@@ -1,8 +1,6 @@
 import { _assert } from '@naturalcycles/js-lib/error/assert.js';
 import { _errorDataAppend } from '@naturalcycles/js-lib/error/error.util.js';
 import jsonwebtoken from 'jsonwebtoken';
-import { anyObjectSchema } from '../validation/joi/joi.shared.schemas.js';
-import { validate } from '../validation/joi/joi.validation.util.js';
 export { jsonwebtoken };
 // todo: define JWTError and list possible options
 // jwt expired (TokenExpiredError)
@@ -26,9 +24,9 @@ export class JWTService {
     }
     sign(payload, schema, opt = {}) {
         _assert(this.cfg.privateKey, 'JWTService: privateKey is required to be able to verify, but not provided');
-        if (schema) {
-            validate(payload, schema);
-        }
+        schema?.validate(payload, {
+            mutateInput: true,
+        });
         return jsonwebtoken.sign(payload, this.cfg.privateKey, {
             algorithm: this.cfg.algorithm,
             noTimestamp: true,
@@ -44,9 +42,9 @@ export class JWTService {
                 ...this.cfg.verifyOptions,
                 ...opt,
             });
-            if (schema) {
-                validate(data, schema);
-            }
+            schema?.validate(data, {
+                mutateInput: true,
+            });
             return data;
         }
         catch (err) {
@@ -65,7 +63,9 @@ export class JWTService {
         _assert(data?.payload, 'invalid token, decoded value is empty', {
             ...this.cfg.errorData,
         });
-        validate(data.payload, schema || anyObjectSchema);
+        schema?.validate(data.payload, {
+            mutateInput: true,
+        });
         return data;
     }
 }

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

@@ -1,5 +1,6 @@
 import { type ValidationFunction, type ValidationFunctionResult } from '@naturalcycles/js-lib';
 import type { JsonSchema, JsonSchemaBuilder } from '@naturalcycles/js-lib/json-schema';
+import { type ZodType } from '@naturalcycles/js-lib/zod';
 import type { Ajv } from 'ajv';
 import { AjvValidationError } from './ajvValidationError.js';
 export interface AjvValidationOptions {
@@ -38,8 +39,6 @@ export interface AjvSchemaCfg {
 /**
  * On creation - compiles ajv validation function.
  * Provides convenient methods, error reporting, etc.
- *
- * @experimental
  */
 export declare class AjvSchema<T = unknown> {
     schema: JsonSchema<T>;
@@ -58,6 +57,7 @@ export declare class AjvSchema<T = unknown> {
      * correctly for some reason.
      */
     static create<T>(schema: JsonSchemaBuilder<T> | JsonSchema<T> | AjvSchema<T>, cfg?: Partial<AjvSchemaCfg>): AjvSchema<T>;
+    static createFromZod<T>(zodSchema: ZodType<T>, cfg?: Partial<AjvSchemaCfg>): AjvSchema<T>;
     readonly cfg: AjvSchemaCfg;
     /**
      * It returns the original object just for convenience.

package/dist/validation/ajv/ajvSchema.js

@@ -2,14 +2,13 @@ import { _isObject, _lazyValue, } from '@naturalcycles/js-lib';
 import { JsonSchemaAnyBuilder } from '@naturalcycles/js-lib/json-schema';
 import { _filterNullishValues } from '@naturalcycles/js-lib/object';
 import { _substringBefore } from '@naturalcycles/js-lib/string';
+import { z } from '@naturalcycles/js-lib/zod';
 import { _inspect } from '../../string/inspect.js';
 import { AjvValidationError } from './ajvValidationError.js';
 import { getAjv } from './getAjv.js';
 /**
  * On creation - compiles ajv validation function.
  * Provides convenient methods, error reporting, etc.
- *
- * @experimental
  */
 export class AjvSchema {
     schema;
@@ -29,7 +28,7 @@ export class AjvSchema {
     /**
      * Shortcut for AjvSchema.create(schema, { lazy: true })
      */
-    static createLazy(schema, cfg = {}) {
+    static createLazy(schema, cfg) {
         return AjvSchema.create(schema, {
             lazy: true,
             ...cfg,
@@ -44,7 +43,7 @@ export class AjvSchema {
      * Implementation note: JsonSchemaBuilder goes first in the union type, otherwise TypeScript fails to infer <T> type
      * correctly for some reason.
      */
-    static create(schema, cfg = {}) {
+    static create(schema, cfg) {
         if (schema instanceof AjvSchema)
             return schema;
         if (schema instanceof JsonSchemaAnyBuilder) {
@@ -52,6 +51,10 @@ export class AjvSchema {
         }
         return new AjvSchema(schema, cfg);
     }
+    static createFromZod(zodSchema, cfg) {
+        const jsonSchema = z.toJSONSchema(zodSchema, { target: 'draft-7' });
+        return new AjvSchema(jsonSchema, cfg);
+    }
     cfg;
     /**
      * It returns the original object just for convenience.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/nodejs-lib",
   "type": "module",
-  "version": "15.10.1",
+  "version": "15.12.0",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@types/js-yaml": "^4",
@@ -80,6 +80,7 @@
   "license": "MIT",
   "envByBranch": {
     "master": "master",
+    "main": "master",
     "*": "branch"
   },
   "scripts": {

package/src/jwt/jwt.service.ts

@@ -2,11 +2,9 @@ import type { ErrorData } from '@naturalcycles/js-lib/error'
 import { _assert } from '@naturalcycles/js-lib/error/assert.js'
 import { _errorDataAppend } from '@naturalcycles/js-lib/error/error.util.js'
 import type { AnyObject, JWTString } from '@naturalcycles/js-lib/types'
-import type { AnySchema } from 'joi'
 import type { Algorithm, JwtHeader, SignOptions, VerifyOptions } from 'jsonwebtoken'
 import jsonwebtoken from 'jsonwebtoken'
-import { anyObjectSchema } from '../validation/joi/joi.shared.schemas.js'
-import { validate } from '../validation/joi/joi.validation.util.js'
+import type { AjvSchema } from '../validation/ajv/ajvSchema.js'
 export { jsonwebtoken }
 export type { Algorithm, JwtHeader, SignOptions, VerifyOptions }
 
@@ -65,15 +63,15 @@ export interface JWTServiceCfg {
 export class JWTService {
   constructor(public cfg: JWTServiceCfg) {}
 
-  sign<T extends AnyObject>(payload: T, schema?: AnySchema<T>, opt: SignOptions = {}): JWTString {
+  sign<T extends AnyObject>(payload: T, schema?: AjvSchema<T>, opt: SignOptions = {}): JWTString {
     _assert(
       this.cfg.privateKey,
       'JWTService: privateKey is required to be able to verify, but not provided',
     )
 
-    if (schema) {
-      validate(payload, schema)
-    }
+    schema?.validate(payload, {
+      mutateInput: true,
+    })
 
     return jsonwebtoken.sign(payload, this.cfg.privateKey, {
       algorithm: this.cfg.algorithm,
@@ -85,7 +83,7 @@ export class JWTService {
 
   verify<T extends AnyObject>(
     token: JWTString,
-    schema?: AnySchema<T>,
+    schema?: AjvSchema<T>,
     opt: VerifyOptions = {},
     publicKey?: string, // allows to override public key
   ): T {
@@ -101,9 +99,9 @@ export class JWTService {
         ...opt,
       }) as T
 
-      if (schema) {
-        validate(data, schema)
-      }
+      schema?.validate(data, {
+        mutateInput: true,
+      })
 
       return data
     } catch (err) {
@@ -118,7 +116,7 @@ export class JWTService {
 
   decode<T extends AnyObject>(
     token: JWTString,
-    schema?: AnySchema<T>,
+    schema?: AjvSchema<T>,
   ): {
     header: JwtHeader
     payload: T
@@ -136,7 +134,9 @@ export class JWTService {
       ...this.cfg.errorData,
     })
 
-    validate(data.payload, schema || anyObjectSchema)
+    schema?.validate(data.payload, {
+      mutateInput: true,
+    })
 
     return data
   }

package/src/validation/ajv/ajvSchema.ts

@@ -8,6 +8,7 @@ import type { JsonSchema, JsonSchemaBuilder } from '@naturalcycles/js-lib/json-s
 import { JsonSchemaAnyBuilder } from '@naturalcycles/js-lib/json-schema'
 import { _filterNullishValues } from '@naturalcycles/js-lib/object'
 import { _substringBefore } from '@naturalcycles/js-lib/string'
+import { z, type ZodType } from '@naturalcycles/js-lib/zod'
 import type { Ajv } from 'ajv'
 import { _inspect } from '../../string/inspect.js'
 import { AjvValidationError } from './ajvValidationError.js'
@@ -55,8 +56,6 @@ export interface AjvSchemaCfg {
 /**
  * On creation - compiles ajv validation function.
  * Provides convenient methods, error reporting, etc.
- *
- * @experimental
  */
 export class AjvSchema<T = unknown> {
   private constructor(
@@ -81,7 +80,7 @@ export class AjvSchema<T = unknown> {
    */
   static createLazy<T>(
     schema: JsonSchemaBuilder<T> | JsonSchema<T> | AjvSchema<T>,
-    cfg: Partial<AjvSchemaCfg> = {},
+    cfg?: Partial<AjvSchemaCfg>,
   ): AjvSchema<T> {
     return AjvSchema.create(schema, {
       lazy: true,
@@ -100,7 +99,7 @@ export class AjvSchema<T = unknown> {
    */
   static create<T>(
     schema: JsonSchemaBuilder<T> | JsonSchema<T> | AjvSchema<T>,
-    cfg: Partial<AjvSchemaCfg> = {},
+    cfg?: Partial<AjvSchemaCfg>,
   ): AjvSchema<T> {
     if (schema instanceof AjvSchema) return schema
     if (schema instanceof JsonSchemaAnyBuilder) {
@@ -109,6 +108,11 @@ export class AjvSchema<T = unknown> {
     return new AjvSchema<T>(schema as JsonSchema<T>, cfg)
   }
 
+  static createFromZod<T>(zodSchema: ZodType<T>, cfg?: Partial<AjvSchemaCfg>): AjvSchema<T> {
+    const jsonSchema = z.toJSONSchema(zodSchema, { target: 'draft-7' })
+    return new AjvSchema<T>(jsonSchema as JsonSchema<T>, cfg)
+  }
+
   readonly cfg: AjvSchemaCfg
 
   /**