@naturalcycles/db-lib 10.10.0 → 10.11.0

package/dist/commondao/common.dao.js

@@ -954,20 +954,22 @@ export class CommonDao {
         // and they can be annoying with snapshot tests
         obj = _filterUndefinedValues(obj);
         // Return as is if no schema is passed or if `skipConversion` is set
-        if (!schema ||
+        if ((!schema && !this.cfg.validateBM) ||
             opt.skipValidation ||
             (op === 'load' && !this.cfg.validateOnLoad) ||
             (op === 'save' && !this.cfg.validateOnSave)) {
             return obj;
         }
-        // This will Convert and Validate
-        const table = opt.table || this.cfg.table;
-        const objectName = table;
+        const inputName = opt.table || this.cfg.table;
         let error;
         let convertedValue;
         if (this.cfg.validateBM) {
             const [err, value] = this.cfg.validateBM(obj, {
-                inputName: table,
+                // Passing `mutateInput` through allows to do opt-in mutation
+                // for individual operations, e.g `someDao.save(myObj, { mutateInput: true })`,
+                // while still keeping safe non-mutating behavior by default
+                mutateInput: opt.mutateInput,
+                inputName,
             });
             error = err;
             convertedValue = value;
@@ -981,14 +983,14 @@ export class CommonDao {
         else if (schema instanceof AjvSchema) {
             // Ajv schema
             const [err, value] = schema.getValidationResult(obj, {
-                objectName,
+                inputName,
             });
             error = err;
             convertedValue = value;
         }
         else {
             // Joi
-            const [err, value] = getValidationResult(obj, schema, objectName);
+            const [err, value] = getValidationResult(obj, schema, inputName);
             error = err;
             convertedValue = value;
         }

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

@@ -104,6 +104,8 @@ export interface CommonDaoCfg<BM extends BaseDBEntity, DBM extends BaseDBEntity
     table: string;
     /**
      * Joi, AjvSchema or ZodSchema is supported.
+     *
+     * @deprecated - use `validateBM` instead.
      */
     bmSchema?: ObjectSchema<BM> | AjvSchema<BM> | ZodType<BM>;
     /**
@@ -190,10 +192,22 @@ export interface CommonDaoOptions extends CommonDBOptions {
     /**
      * Defaults to false.
      *
-     * If set to true - will disable validation (and conversion).
-     * One possible use case of doing this is - performance (as validation/conversion takes time, especially with Joi).
+     * If set to true - will disable validation.
+     * One possible use case of doing this is - performance (as validation/transformation takes time, especially with Joi).
      */
     skipValidation?: boolean;
+    /**
+     * Default to false.
+     *
+     * False ensures that the input is not mutated by the Validation function (`validateBM`).
+     *
+     * True ensures the opposite - that the Validation function will mutate the input object
+     * if it needs to apply transformations, such as:
+     * - stripping unknown properties
+     * - converting types (e.g. string to number)
+     * - applying transformations (which as string trim, toLowerCase, etc)
+     */
+    mutateInput?: boolean;
     /**
      * @default false
      */

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@naturalcycles/db-lib",
   "type": "module",
-  "version": "10.10.0",
+  "version": "10.11.0",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@naturalcycles/nodejs-lib": "^15"
   },
   "devDependencies": {
-    "@naturalcycles/dev-lib": "19.14.0"
+    "@naturalcycles/dev-lib": "19.22.0"
   },
   "files": [
     "dist",

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

@@ -130,6 +130,8 @@ export interface CommonDaoCfg<
 
   /**
    * Joi, AjvSchema or ZodSchema is supported.
+   *
+   * @deprecated - use `validateBM` instead.
    */
   bmSchema?: ObjectSchema<BM> | AjvSchema<BM> | ZodType<BM>
 
@@ -233,11 +235,24 @@ export interface CommonDaoOptions extends CommonDBOptions {
   /**
    * Defaults to false.
    *
-   * If set to true - will disable validation (and conversion).
-   * One possible use case of doing this is - performance (as validation/conversion takes time, especially with Joi).
+   * If set to true - will disable validation.
+   * One possible use case of doing this is - performance (as validation/transformation takes time, especially with Joi).
    */
   skipValidation?: boolean
 
+  /**
+   * Default to false.
+   *
+   * False ensures that the input is not mutated by the Validation function (`validateBM`).
+   *
+   * True ensures the opposite - that the Validation function will mutate the input object
+   * if it needs to apply transformations, such as:
+   * - stripping unknown properties
+   * - converting types (e.g. string to number)
+   * - applying transformations (which as string trim, toLowerCase, etc)
+   */
+  mutateInput?: boolean
+
   /**
    * @default false
    */

package/src/commondao/common.dao.ts

@@ -1227,7 +1227,7 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM, I
 
     // Return as is if no schema is passed or if `skipConversion` is set
     if (
-      !schema ||
+      (!schema && !this.cfg.validateBM) ||
       opt.skipValidation ||
       (op === 'load' && !this.cfg.validateOnLoad) ||
       (op === 'save' && !this.cfg.validateOnSave)
@@ -1235,16 +1235,17 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM, I
       return obj
     }
 
-    // This will Convert and Validate
-    const table = opt.table || this.cfg.table
-    const objectName = table
-
+    const inputName = opt.table || this.cfg.table
     let error: JoiValidationError | AjvValidationError | ZodValidationError | null | undefined
     let convertedValue: any
 
     if (this.cfg.validateBM) {
       const [err, value] = this.cfg.validateBM(obj as any as BM, {
-        inputName: table,
+        // Passing `mutateInput` through allows to do opt-in mutation
+        // for individual operations, e.g `someDao.save(myObj, { mutateInput: true })`,
+        // while still keeping safe non-mutating behavior by default
+        mutateInput: opt.mutateInput,
+        inputName,
       })
       error = err
       convertedValue = value
@@ -1256,13 +1257,13 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM, I
     } else if (schema instanceof AjvSchema) {
       // Ajv schema
       const [err, value] = schema.getValidationResult(obj as T, {
-        objectName,
+        inputName,
       })
       error = err
       convertedValue = value
     } else {
       // Joi
-      const [err, value] = getValidationResult(obj, schema, objectName)
+      const [err, value] = getValidationResult(obj, schema, inputName)
       error = err
       convertedValue = value
     }