@naturalcycles/db-lib 10.12.0 → 10.14.0

package/dist/commondao/common.dao.js

@@ -952,9 +952,9 @@ export class CommonDao {
         }
         const inputName = opt.table || this.cfg.table;
         const [error, convertedValue] = this.cfg.validateBM(input, {
-            // 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
+            // Passing `mutateInput` through allows to opt-out of mutation
+            // for individual operations, e.g `someDao.save(myObj, { mutateInput: false })`
+            // Default is undefined (the validation function decides whether to mutate or not).
             mutateInput: opt.mutateInput,
             inputName,
         });

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

@@ -186,7 +186,11 @@ export interface CommonDaoOptions extends CommonDBOptions {
      */
     skipValidation?: boolean;
     /**
-     * Default to false.
+     * Defaults to undefined.
+     *
+     * Undefined means that it's up for the underlying validation library (implementation)
+     * to mutate or not.
+     * E.g joi and zod would deep-clone, while ajv would MUTATE.
      *
      * False ensures that the input is not mutated by the Validation function (`validateBM`).
      *

package/dist/testing/test.model.js

@@ -1,5 +1,5 @@
 import { _range } from '@naturalcycles/js-lib/array/range.js';
-import { jsonSchema } from '@naturalcycles/js-lib/json-schema';
+import { j } from '@naturalcycles/js-lib/json-schema';
 import { baseDBEntitySchema, binarySchema, booleanSchema, numberSchema, objectSchema, stringSchema, } from '@naturalcycles/nodejs-lib/joi';
 const MOCK_TS_2018_06_21 = 1529539200;
 export const TEST_TABLE = 'TEST_TABLE';
@@ -17,17 +17,17 @@ export const testItemTMSchema = objectSchema({
     k1: stringSchema,
     even: booleanSchema.optional(),
 });
-export const testItemBMJsonSchema = jsonSchema
+export const testItemBMJsonSchema = j
     .rootObject({
     // todo: figure out how to not copy-paste these 3 fields
-    id: jsonSchema.string(), // todo: not strictly needed here
-    created: jsonSchema.unixTimestamp(),
-    updated: jsonSchema.unixTimestamp(),
-    k1: jsonSchema.string(),
-    k2: jsonSchema.oneOf([jsonSchema.string(), jsonSchema.null()]).optional(),
-    k3: jsonSchema.number().optional(),
-    even: jsonSchema.boolean().optional(),
-    b1: jsonSchema.buffer().optional(),
+    id: j.string(), // todo: not strictly needed here
+    created: j.unixTimestamp(),
+    updated: j.unixTimestamp(),
+    k1: j.string(),
+    k2: j.oneOf([j.string(), j.null()]).optional(),
+    k3: j.number().optional(),
+    even: j.boolean().optional(),
+    b1: j.buffer().optional(),
 })
     .baseDBEntity()
     .build();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/db-lib",
   "type": "module",
-  "version": "10.12.0",
+  "version": "10.14.0",
   "dependencies": {
     "@naturalcycles/js-lib": "^15",
     "@naturalcycles/nodejs-lib": "^15"

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

@@ -227,7 +227,11 @@ export interface CommonDaoOptions extends CommonDBOptions {
   skipValidation?: boolean
 
   /**
-   * Default to false.
+   * Defaults to undefined.
+   *
+   * Undefined means that it's up for the underlying validation library (implementation)
+   * to mutate or not.
+   * E.g joi and zod would deep-clone, while ajv would MUTATE.
    *
    * False ensures that the input is not mutated by the Validation function (`validateBM`).
    *

package/src/commondao/common.dao.ts

@@ -1222,9 +1222,9 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM, I
     const inputName = opt.table || this.cfg.table
 
     const [error, convertedValue] = this.cfg.validateBM(input as BM, {
-      // 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
+      // Passing `mutateInput` through allows to opt-out of mutation
+      // for individual operations, e.g `someDao.save(myObj, { mutateInput: false })`
+      // Default is undefined (the validation function decides whether to mutate or not).
       mutateInput: opt.mutateInput,
       inputName,
     })

package/src/testing/test.model.ts

@@ -1,6 +1,6 @@
 import { _range } from '@naturalcycles/js-lib/array/range.js'
 import type { JsonSchemaObject } from '@naturalcycles/js-lib/json-schema'
-import { jsonSchema } from '@naturalcycles/js-lib/json-schema'
+import { j } from '@naturalcycles/js-lib/json-schema'
 import type { BaseDBEntity, UnixTimestamp } from '@naturalcycles/js-lib/types'
 import {
   baseDBEntitySchema,
@@ -50,17 +50,17 @@ export const testItemTMSchema: ObjectSchema<TestItemTM> = objectSchema<TestItemT
   even: booleanSchema.optional(),
 })
 
-export const testItemBMJsonSchema: JsonSchemaObject<TestItemBM> = jsonSchema
+export const testItemBMJsonSchema: JsonSchemaObject<TestItemBM> = j
   .rootObject<TestItemBM>({
     // todo: figure out how to not copy-paste these 3 fields
-    id: jsonSchema.string(), // todo: not strictly needed here
-    created: jsonSchema.unixTimestamp(),
-    updated: jsonSchema.unixTimestamp(),
-    k1: jsonSchema.string(),
-    k2: jsonSchema.oneOf<string | null>([jsonSchema.string(), jsonSchema.null()]).optional(),
-    k3: jsonSchema.number().optional(),
-    even: jsonSchema.boolean().optional(),
-    b1: jsonSchema.buffer().optional(),
+    id: j.string(), // todo: not strictly needed here
+    created: j.unixTimestamp(),
+    updated: j.unixTimestamp(),
+    k1: j.string(),
+    k2: j.oneOf<string | null>([j.string(), j.null()]).optional(),
+    k3: j.number().optional(),
+    even: j.boolean().optional(),
+    b1: j.buffer().optional(),
   })
   .baseDBEntity()
   .build()