@naturalcycles/db-lib 8.50.3 → 8.51.0

package/dist/commondao/common.dao.d.ts

@@ -1,4 +1,4 @@
-import { AnyObject, AsyncMapper, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId, Saved, Unsaved } from '@naturalcycles/js-lib';
+import { AnyObject, AsyncMapper, JsonSchemaObject, JsonSchemaRootObject, ObjectWithId, Saved, Unsaved, ZodSchema } from '@naturalcycles/js-lib';
 import { AjvSchema, ObjectSchemaTyped, ReadableTyped } from '@naturalcycles/nodejs-lib';
 import { DBDeleteByIdsOperation, DBModelType, DBOperation, DBPatch, DBSaveBatchOperation, RunQueryResult } from '../db.model';
 import { DBQuery, RunnableDBQuery } from '../query/dbQuery';
@@ -148,7 +148,7 @@ export declare class CommonDao<BM extends Partial<ObjectWithId<ID>>, DBM extends
      *
      * Does NOT mutate the object.
      */
-    validateAndConvert<IN, OUT = IN>(obj: Partial<IN>, schema: ObjectSchemaTyped<IN> | AjvSchema<IN> | undefined, modelType: DBModelType, opt?: CommonDaoOptions): OUT;
+    validateAndConvert<IN, OUT = IN>(obj: Partial<IN>, schema: ObjectSchemaTyped<IN> | AjvSchema<IN> | ZodSchema<IN> | undefined, modelType: DBModelType, opt?: CommonDaoOptions): OUT;
     getTableSchema(): Promise<JsonSchemaRootObject<DBM>>;
     createTable(schema: JsonSchemaObject<DBM>, opt?: CommonDaoCreateOptions): Promise<void>;
     /**

package/dist/commondao/common.dao.js

@@ -838,7 +838,13 @@ class CommonDao {
         const objectName = table + (modelType || '');
         let error;
         let convertedValue;
-        if (schema instanceof nodejs_lib_1.AjvSchema) {
+        if (schema instanceof js_lib_1.ZodSchema) {
+            // Zod schema
+            const vr = (0, js_lib_1.zSafeValidate)(obj, schema);
+            error = vr.error;
+            convertedValue = vr.data;
+        }
+        else if (schema instanceof nodejs_lib_1.AjvSchema) {
             // Ajv schema
             convertedValue = obj; // because Ajv mutates original object
             error = schema.getValidationError(obj, {

package/dist/commondao/common.dao.model.d.ts

@@ -1,4 +1,4 @@
-import { CommonLogger, ErrorMode, ObjectWithId, Saved } from '@naturalcycles/js-lib';
+import { CommonLogger, ErrorMode, ObjectWithId, Saved, ZodError, ZodSchema } from '@naturalcycles/js-lib';
 import { AjvSchema, AjvValidationError, JoiValidationError, ObjectSchemaTyped, TransformLogProgressOptions, TransformMapOptions } from '@naturalcycles/nodejs-lib';
 import { CommonDB } from '../common.db';
 import { CommonDBCreateOptions, CommonDBOptions, CommonDBSaveOptions } from '../db.model';
@@ -23,7 +23,7 @@ export interface CommonDaoHooks<BM extends Partial<ObjectWithId<ID>>, DBM extend
      * Return original `err` to pass the error through (will be thrown in CommonDao).
      * Return modified/new `Error` if needed.
      */
-    onValidationError: (err: JoiValidationError | AjvValidationError) => Error | false;
+    onValidationError: (err: JoiValidationError | AjvValidationError | ZodError) => Error | false;
 }
 export declare enum CommonDaoLogLevel {
     /**
@@ -47,11 +47,11 @@ export interface CommonDaoCfg<BM extends Partial<ObjectWithId<ID>>, DBM extends
     db: CommonDB;
     table: string;
     /**
-     * Joi or AjvSchema are supported.
+     * Joi, AjvSchema or ZodSchema is supported.
      */
-    dbmSchema?: ObjectSchemaTyped<DBM> | AjvSchema<DBM>;
-    bmSchema?: ObjectSchemaTyped<BM> | AjvSchema<BM>;
-    tmSchema?: ObjectSchemaTyped<TM> | AjvSchema<TM>;
+    dbmSchema?: ObjectSchemaTyped<DBM> | AjvSchema<DBM> | ZodSchema<DBM>;
+    bmSchema?: ObjectSchemaTyped<BM> | AjvSchema<BM> | ZodSchema<BM>;
+    tmSchema?: ObjectSchemaTyped<TM> | AjvSchema<TM> | ZodSchema<TM>;
     excludeFromIndexes?: (keyof DBM)[];
     /**
      * Defaults to false.

package/package.json

@@ -41,7 +41,7 @@
   "engines": {
     "node": ">=14.15"
   },
-  "version": "8.50.3",
+  "version": "8.51.0",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

package/src/commondao/common.dao.model.ts

@@ -1,4 +1,11 @@
-import { CommonLogger, ErrorMode, ObjectWithId, Saved } from '@naturalcycles/js-lib'
+import {
+  CommonLogger,
+  ErrorMode,
+  ObjectWithId,
+  Saved,
+  ZodError,
+  ZodSchema,
+} from '@naturalcycles/js-lib'
 import {
   AjvSchema,
   AjvValidationError,
@@ -37,7 +44,7 @@ export interface CommonDaoHooks<
    * Return original `err` to pass the error through (will be thrown in CommonDao).
    * Return modified/new `Error` if needed.
    */
-  onValidationError: (err: JoiValidationError | AjvValidationError) => Error | false
+  onValidationError: (err: JoiValidationError | AjvValidationError | ZodError) => Error | false
 }
 
 export enum CommonDaoLogLevel {
@@ -69,11 +76,11 @@ export interface CommonDaoCfg<
   table: string
 
   /**
-   * Joi or AjvSchema are supported.
+   * Joi, AjvSchema or ZodSchema is supported.
    */
-  dbmSchema?: ObjectSchemaTyped<DBM> | AjvSchema<DBM>
-  bmSchema?: ObjectSchemaTyped<BM> | AjvSchema<BM>
-  tmSchema?: ObjectSchemaTyped<TM> | AjvSchema<TM>
+  dbmSchema?: ObjectSchemaTyped<DBM> | AjvSchema<DBM> | ZodSchema<DBM>
+  bmSchema?: ObjectSchemaTyped<BM> | AjvSchema<BM> | ZodSchema<BM>
+  tmSchema?: ObjectSchemaTyped<TM> | AjvSchema<TM> | ZodSchema<TM>
 
   excludeFromIndexes?: (keyof DBM)[]
 

package/src/commondao/common.dao.ts

@@ -16,6 +16,9 @@ import {
   pMap,
   Saved,
   Unsaved,
+  ZodSchema,
+  ZodValidationError,
+  zSafeValidate,
 } from '@naturalcycles/js-lib'
 import {
   _pipeline,
@@ -1077,7 +1080,7 @@ export class CommonDao<
    */
   validateAndConvert<IN, OUT = IN>(
     obj: Partial<IN>,
-    schema: ObjectSchemaTyped<IN> | AjvSchema<IN> | undefined,
+    schema: ObjectSchemaTyped<IN> | AjvSchema<IN> | ZodSchema<IN> | undefined,
     modelType: DBModelType,
     opt: CommonDaoOptions = {},
   ): OUT {
@@ -1113,10 +1116,15 @@ export class CommonDao<
     const table = opt.table || this.cfg.table
     const objectName = table + (modelType || '')
 
-    let error: JoiValidationError | AjvValidationError | undefined
+    let error: JoiValidationError | AjvValidationError | ZodValidationError<IN> | undefined
     let convertedValue: any
 
-    if (schema instanceof AjvSchema) {
+    if (schema instanceof ZodSchema) {
+      // Zod schema
+      const vr = zSafeValidate(obj as IN, schema)
+      error = vr.error
+      convertedValue = vr.data
+    } else if (schema instanceof AjvSchema) {
       // Ajv schema
       convertedValue = obj // because Ajv mutates original object