@naturalcycles/db-lib 9.8.0 → 9.9.0

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

@@ -149,7 +149,8 @@ export declare class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity
      * Does NOT mutate the object.
      * Validates (unless `skipValidation=true` passed).
      */
-    validateAndConvert<T>(obj: Partial<T>, schema: ObjectSchema<T> | AjvSchema<T> | ZodSchema<T> | undefined, opt?: CommonDaoOptions): any;
+    validateAndConvert<T>(obj: Partial<T>, schema: ObjectSchema<T> | AjvSchema<T> | ZodSchema<T> | undefined, op?: 'load' | 'save', // this is to skip validation if validateOnLoad/Save is false
+    opt?: CommonDaoOptions): any;
     getTableSchema(): Promise<JsonSchemaRootObject<DBM>>;
     createTable(schema: JsonSchemaObject<DBM>, opt?: CommonDaoCreateOptions): Promise<void>;
     /**

package/dist/commondao/common.dao.js

@@ -27,6 +27,8 @@ class CommonDao {
             assignGeneratedIds: false,
             useCreatedProperty: true,
             useUpdatedProperty: true,
+            validateOnLoad: true,
+            validateOnSave: true,
             logger: console,
             ...cfg,
             hooks: {
@@ -49,7 +51,7 @@ class CommonDao {
         const bm = this.cfg.hooks.beforeCreate(part);
         // First assignIdCreatedUpdated, then validate!
         this.assignIdCreatedUpdated(bm, opt);
-        return this.validateAndConvert(bm, this.cfg.bmSchema, opt);
+        return this.validateAndConvert(bm, this.cfg.bmSchema, undefined, opt);
     }
     async getById(id, opt = {}) {
         if (!id)
@@ -245,7 +247,6 @@ class CommonDao {
     async streamQueryForEach(q, mapper, opt = {}) {
         q.table = opt.table || q.table;
         opt.skipValidation = opt.skipValidation !== false; // default true
-        opt.skipConversion = opt.skipConversion !== false; // default true
         opt.errorMode ||= js_lib_1.ErrorMode.SUPPRESS;
         const partialQuery = !!q._selectedFieldNames;
         const op = `streamQueryForEach(${q.pretty()})`;
@@ -284,7 +285,6 @@ class CommonDao {
     async streamQueryAsDBMForEach(q, mapper, opt = {}) {
         q.table = opt.table || q.table;
         opt.skipValidation = opt.skipValidation !== false; // default true
-        opt.skipConversion = opt.skipConversion !== false; // default true
         opt.errorMode ||= js_lib_1.ErrorMode.SUPPRESS;
         const partialQuery = !!q._selectedFieldNames;
         const op = `streamQueryAsDBMForEach(${q.pretty()})`;
@@ -326,7 +326,6 @@ class CommonDao {
     streamQueryAsDBM(q, opt = {}) {
         q.table = opt.table || q.table;
         opt.skipValidation = opt.skipValidation !== false; // default true
-        opt.skipConversion = opt.skipConversion !== false; // default true
         opt.errorMode ||= js_lib_1.ErrorMode.SUPPRESS;
         const partialQuery = !!q._selectedFieldNames;
         const stream = this.cfg.db.streamQuery(q, opt);
@@ -357,7 +356,6 @@ class CommonDao {
     streamQuery(q, opt = {}) {
         q.table = opt.table || q.table;
         opt.skipValidation = opt.skipValidation !== false; // default true
-        opt.skipConversion = opt.skipConversion !== false; // default true
         opt.errorMode ||= js_lib_1.ErrorMode.SUPPRESS;
         const stream = this.cfg.db.streamQuery(q, opt);
         const partialQuery = !!q._selectedFieldNames;
@@ -537,7 +535,7 @@ class CommonDao {
             // We compare with convertedBM, to account for cases when some extra property is assigned to bm,
             // which should be removed post-validation, but it breaks the "equality check"
             // Post-validation the equality check should work as intended
-            const convertedBM = this.validateAndConvert(bm, this.cfg.bmSchema, opt);
+            const convertedBM = this.validateAndConvert(bm, this.cfg.bmSchema, 'save', opt);
             if ((0, js_lib_1._deepJsonEquals)(convertedBM, opt.skipIfEquals)) {
                 // Skipping the save operation
                 return bm;
@@ -682,7 +680,6 @@ class CommonDao {
         this.requireWriteAccess();
         const table = opt.table || this.cfg.table;
         opt.skipValidation ??= true;
-        opt.skipConversion ??= true;
         opt.errorMode ||= js_lib_1.ErrorMode.SUPPRESS;
         if (this.cfg.immutable && !opt.allowMutability && !opt.saveMethod) {
             opt = { ...opt, saveMethod: 'insert' };
@@ -817,7 +814,7 @@ class CommonDao {
         // DBM > BM
         const bm = ((await this.cfg.hooks.beforeDBMToBM?.(dbm)) || dbm);
         // Validate/convert BM
-        return this.validateAndConvert(bm, this.cfg.bmSchema, opt);
+        return this.validateAndConvert(bm, this.cfg.bmSchema, 'load', opt);
     }
     async dbmsToBM(dbms, opt = {}) {
         return await (0, js_lib_1.pMap)(dbms, async (dbm) => await this.dbmToBM(dbm, opt));
@@ -826,7 +823,7 @@ class CommonDao {
         if (bm === undefined)
             return;
         // bm gets assigned to the new reference
-        bm = this.validateAndConvert(bm, this.cfg.bmSchema, opt);
+        bm = this.validateAndConvert(bm, this.cfg.bmSchema, 'save', opt);
         // BM > DBM
         return ((await this.cfg.hooks.beforeBMToDBM?.(bm)) || bm);
     }
@@ -857,7 +854,8 @@ class CommonDao {
      * Does NOT mutate the object.
      * Validates (unless `skipValidation=true` passed).
      */
-    validateAndConvert(obj, schema, opt = {}) {
+    validateAndConvert(obj, schema, op, // this is to skip validation if validateOnLoad/Save is false
+    opt = {}) {
         // Kirill 2021-10-18: I realized that there's little reason to keep removing null values
         // So, from now on we'll preserve them
         // "undefined" values, I believe, are/were not saved to/from DB anyway (due to e.g JSON.stringify removing them)
@@ -869,7 +867,10 @@ class CommonDao {
         // and they can be annoying with snapshot tests
         obj = (0, js_lib_1._filterUndefinedValues)(obj);
         // Return as is if no schema is passed or if `skipConversion` is set
-        if (!schema || opt.skipConversion) {
+        if (!schema ||
+            opt.skipValidation ||
+            (op === 'load' && !this.cfg.validateOnLoad) ||
+            (op === 'save' && !this.cfg.validateOnSave)) {
             return obj;
         }
         // This will Convert and Validate
@@ -897,7 +898,7 @@ class CommonDao {
             convertedValue = vr.value;
         }
         // If we care about validation and there's an error
-        if (error && !opt.skipValidation) {
+        if (error) {
             const processedError = this.cfg.hooks.onValidationError(error);
             if (processedError)
                 throw processedError;

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

@@ -101,6 +101,16 @@ export interface CommonDaoCfg<BM extends BaseDBEntity, DBM extends BaseDBEntity
      */
     bmSchema?: ObjectSchema<BM> | AjvSchema<BM> | ZodSchema<BM>;
     excludeFromIndexes?: (keyof DBM)[];
+    /**
+     * Defaults to true.
+     * If set to false - load (read) operations will skip validation (and conversion).
+     */
+    validateOnLoad?: boolean;
+    /**
+     * Defaults to true.
+     * If set to false - save (write) operations will skip validation (and conversion).
+     */
+    validateOnSave?: boolean;
     /**
      * Defaults to false.
      * Setting it to true will set saveMethod to `insert` for save/saveBatch, which will
@@ -163,20 +173,12 @@ export interface CommonDaoCfg<BM extends BaseDBEntity, DBM extends BaseDBEntity
  */
 export interface CommonDaoOptions extends CommonDBOptions {
     /**
-     * If true - will ignore the validation result, but will STILL DO the validation step, which will DO conversion
-     * (according to Joi schema).
-     *
-     * Set skipConversion=true (or raw=true) to bypass conversion step as well (e.g for performance reasons).
+     * Defaults to false.
      *
-     * @default 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).
      */
     skipValidation?: boolean;
-    /**
-     * If true - will SKIP the joi validation AND conversion steps alltogether. To improve performance of DAO.
-     *
-     * @default false
-     */
-    skipConversion?: boolean;
     /**
      * @default false
      */
@@ -241,10 +243,6 @@ export interface CommonDaoStreamOptions<IN> extends CommonDaoOptions, TransformL
      * @default true (for streams)
      */
     skipValidation?: boolean;
-    /**
-     * @default true (for streams)
-     */
-    skipConversion?: boolean;
     /**
      * @default ErrorMode.SUPPRESS for returning ReadableStream, because .pipe() has no concept of "error propagation"
      * @default ErrorMode.SUPPRESS for .forEach() streams as well, but overridable

package/package.json

@@ -40,7 +40,7 @@
   "engines": {
     "node": ">=18.12"
   },
-  "version": "9.8.0",
+  "version": "9.9.0",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

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

@@ -129,6 +129,18 @@ export interface CommonDaoCfg<BM extends BaseDBEntity, DBM extends BaseDBEntity
 
   excludeFromIndexes?: (keyof DBM)[]
 
+  /**
+   * Defaults to true.
+   * If set to false - load (read) operations will skip validation (and conversion).
+   */
+  validateOnLoad?: boolean
+
+  /**
+   * Defaults to true.
+   * If set to false - save (write) operations will skip validation (and conversion).
+   */
+  validateOnSave?: boolean
+
   /**
    * Defaults to false.
    * Setting it to true will set saveMethod to `insert` for save/saveBatch, which will
@@ -203,22 +215,13 @@ export interface CommonDaoCfg<BM extends BaseDBEntity, DBM extends BaseDBEntity
  */
 export interface CommonDaoOptions extends CommonDBOptions {
   /**
-   * If true - will ignore the validation result, but will STILL DO the validation step, which will DO conversion
-   * (according to Joi schema).
-   *
-   * Set skipConversion=true (or raw=true) to bypass conversion step as well (e.g for performance reasons).
+   * Defaults to false.
    *
-   * @default 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).
    */
   skipValidation?: boolean
 
-  /**
-   * If true - will SKIP the joi validation AND conversion steps alltogether. To improve performance of DAO.
-   *
-   * @default false
-   */
-  skipConversion?: boolean
-
   /**
    * @default false
    */
@@ -302,11 +305,6 @@ export interface CommonDaoStreamOptions<IN>
    */
   skipValidation?: boolean
 
-  /**
-   * @default true (for streams)
-   */
-  skipConversion?: boolean
-
   /**
    * @default ErrorMode.SUPPRESS for returning ReadableStream, because .pipe() has no concept of "error propagation"
    * @default ErrorMode.SUPPRESS for .forEach() streams as well, but overridable

package/src/commondao/common.dao.ts

@@ -81,6 +81,8 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
       assignGeneratedIds: false,
       useCreatedProperty: true,
       useUpdatedProperty: true,
+      validateOnLoad: true,
+      validateOnSave: true,
       logger: console,
       ...cfg,
       hooks: {
@@ -104,7 +106,7 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
     const bm = this.cfg.hooks!.beforeCreate!(part)
     // First assignIdCreatedUpdated, then validate!
     this.assignIdCreatedUpdated(bm, opt)
-    return this.validateAndConvert(bm, this.cfg.bmSchema, opt)
+    return this.validateAndConvert(bm, this.cfg.bmSchema, undefined, opt)
   }
 
   // GET
@@ -353,7 +355,6 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
   ): Promise<void> {
     q.table = opt.table || q.table
     opt.skipValidation = opt.skipValidation !== false // default true
-    opt.skipConversion = opt.skipConversion !== false // default true
     opt.errorMode ||= ErrorMode.SUPPRESS
 
     const partialQuery = !!q._selectedFieldNames
@@ -403,7 +404,6 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
   ): Promise<void> {
     q.table = opt.table || q.table
     opt.skipValidation = opt.skipValidation !== false // default true
-    opt.skipConversion = opt.skipConversion !== false // default true
     opt.errorMode ||= ErrorMode.SUPPRESS
 
     const partialQuery = !!q._selectedFieldNames
@@ -452,7 +452,6 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
   streamQueryAsDBM(q: DBQuery<DBM>, opt: CommonDaoStreamOptions<DBM> = {}): ReadableTyped<DBM> {
     q.table = opt.table || q.table
     opt.skipValidation = opt.skipValidation !== false // default true
-    opt.skipConversion = opt.skipConversion !== false // default true
     opt.errorMode ||= ErrorMode.SUPPRESS
 
     const partialQuery = !!q._selectedFieldNames
@@ -491,7 +490,6 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
   streamQuery(q: DBQuery<DBM>, opt: CommonDaoStreamOptions<BM> = {}): ReadableTyped<BM> {
     q.table = opt.table || q.table
     opt.skipValidation = opt.skipValidation !== false // default true
-    opt.skipConversion = opt.skipConversion !== false // default true
     opt.errorMode ||= ErrorMode.SUPPRESS
 
     const stream = this.cfg.db.streamQuery<DBM>(q, opt)
@@ -721,7 +719,7 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
       // We compare with convertedBM, to account for cases when some extra property is assigned to bm,
       // which should be removed post-validation, but it breaks the "equality check"
       // Post-validation the equality check should work as intended
-      const convertedBM = this.validateAndConvert(bm as Partial<BM>, this.cfg.bmSchema, opt)
+      const convertedBM = this.validateAndConvert(bm as Partial<BM>, this.cfg.bmSchema, 'save', opt)
       if (_deepJsonEquals(convertedBM, opt.skipIfEquals)) {
         // Skipping the save operation
         return bm as BM
@@ -900,7 +898,6 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
 
     const table = opt.table || this.cfg.table
     opt.skipValidation ??= true
-    opt.skipConversion ??= true
     opt.errorMode ||= ErrorMode.SUPPRESS
 
     if (this.cfg.immutable && !opt.allowMutability && !opt.saveMethod) {
@@ -1077,7 +1074,7 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
     const bm = ((await this.cfg.hooks!.beforeDBMToBM?.(dbm)) || dbm) as Partial<BM>
 
     // Validate/convert BM
-    return this.validateAndConvert(bm, this.cfg.bmSchema, opt)
+    return this.validateAndConvert(bm, this.cfg.bmSchema, 'load', opt)
   }
 
   async dbmsToBM(dbms: DBM[], opt: CommonDaoOptions = {}): Promise<BM[]> {
@@ -1094,7 +1091,7 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
     if (bm === undefined) return
 
     // bm gets assigned to the new reference
-    bm = this.validateAndConvert(bm, this.cfg.bmSchema, opt)
+    bm = this.validateAndConvert(bm, this.cfg.bmSchema, 'save', opt)
 
     // BM > DBM
     return ((await this.cfg.hooks!.beforeBMToDBM?.(bm!)) || bm) as DBM
@@ -1138,6 +1135,7 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
   validateAndConvert<T>(
     obj: Partial<T>,
     schema: ObjectSchema<T> | AjvSchema<T> | ZodSchema<T> | undefined,
+    op?: 'load' | 'save', // this is to skip validation if validateOnLoad/Save is false
     opt: CommonDaoOptions = {},
   ): any {
     // Kirill 2021-10-18: I realized that there's little reason to keep removing null values
@@ -1152,7 +1150,12 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
     obj = _filterUndefinedValues(obj)
 
     // Return as is if no schema is passed or if `skipConversion` is set
-    if (!schema || opt.skipConversion) {
+    if (
+      !schema ||
+      opt.skipValidation ||
+      (op === 'load' && !this.cfg.validateOnLoad) ||
+      (op === 'save' && !this.cfg.validateOnSave)
+    ) {
       return obj
     }
 
@@ -1183,7 +1186,7 @@ export class CommonDao<BM extends BaseDBEntity, DBM extends BaseDBEntity = BM> {
     }
 
     // If we care about validation and there's an error
-    if (error && !opt.skipValidation) {
+    if (error) {
       const processedError = this.cfg.hooks!.onValidationError!(error)
 
       if (processedError) throw processedError