objection 3.1.3 → 3.1.5

package/lib/model/AjvValidator.js

@@ -36,8 +36,10 @@ class AjvValidator extends Validator {
     self.cache = new Map();
 
     const setupAjv = (ajv) => {
-      conf.onCreateAjv(ajv);
-      // Only add AJV formats if they weren't added in user-space already
+      if (conf.onCreateAjv) {
+        conf.onCreateAjv(ajv);
+      }
+      // Only add Ajv formats if they weren't added in user-space already
       if (!ajv.formats['date-time']) {
         addFormats(ajv);
       }
@@ -77,7 +79,7 @@ class AjvValidator extends Validator {
     }
 
     validator.call(model, json);
-    const error = parseValidationError(validator.errors, modelClass, options);
+    const error = parseValidationError(validator.errors, modelClass, options, this.ajvOptions);
 
     if (error) {
       throw error;
@@ -87,7 +89,7 @@ class AjvValidator extends Validator {
   }
 
   getValidator(modelClass, jsonSchema, isPatchObject) {
-    // Use the AJV custom serializer if provided.
+    // Use the Ajv custom serializer if provided.
     const createCacheKey = this.ajvOptions.serialize || JSON.stringify;
 
     // Optimization for the common case where jsonSchema is never modified.
@@ -103,7 +105,7 @@ class AjvValidator extends Validator {
     if (!validators) {
       validators = {
         // Validator created for the schema object without `required` properties
-        // using the AJV instance that doesn't set default values.
+        // using the Ajv instance that doesn't set default values.
         patchValidator: null,
 
         // Validator created for the unmodified schema.
@@ -143,7 +145,7 @@ class AjvValidator extends Validator {
   }
 }
 
-function parseValidationError(errors, modelClass, options) {
+function parseValidationError(errors, modelClass, options, ajvOptions) {
   if (!errors) {
     return null;
   }
@@ -178,13 +180,21 @@ function parseValidationError(errors, modelClass, options) {
     // More than one error can occur for the same key in Ajv, merge them in the array:
     const array = errorHash[key] || (errorHash[key] = []);
 
-    // Use unshift instead of push so that the last error ends up at [0],
-    // preserving previous behavior where only the last error was stored.
-    array.unshift({
+    // Prepare error object
+    const errorObj = {
       message: error.message,
       keyword: error.keyword,
       params: error.params,
-    });
+    };
+
+    // Add data if verbose enabled
+    if (ajvOptions.verbose) {
+      errorObj.data = error.data;
+    }
+
+    // Use unshift instead of push so that the last error ends up at [0],
+    // preserving previous behavior where only the last error was stored.
+    array.unshift(errorObj);
 
     ++numErrors;
   }

package/lib/model/Model.js

@@ -219,27 +219,27 @@ class Model {
     return this.constructor.traverseAsync(filterConstructor, this, callback);
   }
 
-  $omitFromJson(props) {
+  $omitFromJson(...props) {
     if (arguments.length === 0) {
       return this.$$omitFromJson;
     } else {
       if (!this.hasOwnProperty('$$omitFromJson')) {
-        defineNonEnumerableProperty(this, '$$omitFromJson', props);
-      } else {
-        this.$$omitFromJson = this.$$omitFromJson.concat(props);
+        defineNonEnumerableProperty(this, '$$omitFromJson', []);
       }
+      this.$$omitFromJson = this.$$omitFromJson.concat(asPropsArray(props));
+      return this;
     }
   }
 
-  $omitFromDatabaseJson(props) {
+  $omitFromDatabaseJson(...props) {
     if (arguments.length === 0) {
       return this.$$omitFromDatabaseJson;
     } else {
       if (!this.hasOwnProperty('$$omitFromDatabaseJson')) {
-        defineNonEnumerableProperty(this, '$$omitFromDatabaseJson', props);
-      } else {
-        this.$$omitFromDatabaseJson = this.$$omitFromDatabaseJson.concat(props);
+        defineNonEnumerableProperty(this, '$$omitFromDatabaseJson', []);
       }
+      this.$$omitFromDatabaseJson = this.$$omitFromDatabaseJson.concat(asPropsArray(props));
+      return this;
     }
   }
 
@@ -317,9 +317,6 @@ class Model {
 
   static createValidator() {
     return new AjvValidator({
-      onCreateAjv: (ajv) => {
-        /* Do Nothing by default */
-      },
       options: {
         allErrors: true,
         validateSchema: false,
@@ -907,6 +904,20 @@ function getTraverseArgs(filterConstructor, models, traverser) {
   };
 }
 
+function asPropsArray(props) {
+  if (props.length === 1) {
+    const arg = props[0];
+    if (Array.isArray(arg)) {
+      return arg;
+    } else if (arg && typeof arg === 'object') {
+      return Object.entries(arg)
+        .filter(([, value]) => value)
+        .map(([key]) => key);
+    }
+  }
+  return props;
+}
+
 module.exports = {
   Model,
 };

package/lib/queryBuilder/InternalOptions.js

@@ -4,6 +4,7 @@ class InternalOptions {
   constructor() {
     this.skipUndefined = false;
     this.keepImplicitJoinProps = false;
+    this.returnImmediatelyValue = undefined;
     this.isInternalQuery = false;
     this.debug = false;
     this.schema = undefined;
@@ -14,6 +15,7 @@ class InternalOptions {
 
     copy.skipUndefined = this.skipUndefined;
     copy.keepImplicitJoinProps = this.keepImplicitJoinProps;
+    copy.returnImmediatelyValue = this.returnImmediatelyValue;
     copy.isInternalQuery = this.isInternalQuery;
     copy.debug = this.debug;
     copy.schema = this.schema;

package/lib/queryBuilder/QueryBuilder.js

@@ -1119,7 +1119,24 @@ function afterExecute(builder, result) {
   return promise;
 }
 
+class ReturnImmediatelyException {
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+function handleReturnImmediatelyValue(builder) {
+  const { returnImmediatelyValue } = builder.internalOptions();
+  if (returnImmediatelyValue !== undefined) {
+    throw new ReturnImmediatelyException(returnImmediatelyValue);
+  }
+}
+
 function handleExecuteError(builder, err) {
+  if (err instanceof ReturnImmediatelyException) {
+    return Promise.resolve(err.value);
+  }
+
   let promise = Promise.reject(wrapError(err));
 
   builder.forEachOperation(true, (op) => {
@@ -1139,9 +1156,11 @@ function chainOperationHooks(promise, builder, hookName) {
 
     builder.forEachOperation(true, (op) => {
       if (op.hasHook(hookName)) {
-        promise = promise.then((result) =>
-          builder.callAsyncOperationMethod(op, hookName, [builder, result]),
-        );
+        promise = promise.then((result) => {
+          const res = builder.callAsyncOperationMethod(op, hookName, [builder, result]);
+          handleReturnImmediatelyValue(builder);
+          return res;
+        });
       }
     });
 
@@ -1261,7 +1280,11 @@ async function chainHooks(promise, builder, func) {
     let promise = Promise.resolve(result);
 
     if (isFunction(func)) {
-      promise = promise.then((result) => func.call(builder, result, builder));
+      promise = promise.then((result) => {
+        const res = func.call(builder, result, builder);
+        handleReturnImmediatelyValue(builder);
+        return res;
+      });
     } else if (Array.isArray(func)) {
       func.forEach((func) => {
         promise = chainHooks(promise, builder, func);

package/lib/queryBuilder/QueryBuilderOperationSupport.js

@@ -12,7 +12,7 @@ const WhereSelector = /^(where|orWhere|andWhere|find\w+)/;
 const OnSelector = /^(on|orOn|andOn)/;
 const OrderBySelector = /orderBy/;
 const JoinSelector = /(join|joinRaw|joinRelated)$/i;
-const FromSelector = /^(from|into|table)$/;
+const FromSelector = /^(from|fromRaw|into|table)$/;
 
 class QueryBuilderOperationSupport {
   constructor(...args) {

package/lib/queryBuilder/graph/patch/GraphPatchAction.js

@@ -3,7 +3,7 @@
 const { getModel } = require('../../../model/getModel');
 const { GraphAction } = require('../GraphAction');
 const { isInternalProp } = require('../../../utils/internalPropUtils');
-const { union, difference, isObject, jsonEquals } = require('../../../utils/objectUtils');
+const { difference, isObject, jsonEquals } = require('../../../utils/objectUtils');
 const promiseUtils = require('../../../utils/promiseUtils');
 
 class GraphPatchAction extends GraphAction {
@@ -33,7 +33,7 @@ class GraphPatchAction extends GraphAction {
 
     const handleUpdate = () => {
       const { changedProps, unchangedProps } = this._findChanges(node);
-      const allProps = union(changedProps, unchangedProps);
+      const allProps = [...changedProps, ...unchangedProps];
 
       const propsToUpdate = difference(
         shouldPatch || shouldUpdate
@@ -59,12 +59,16 @@ class GraphPatchAction extends GraphAction {
     // See if the model defines a beforeUpdate or $beforeUpdate hook. If it does
     // not, we can check for updated properties now and drop out immediately if
     // there is nothing to update. Otherwise, we need to wait for the hook to be
-    // called before calling handleUpdate. See issue #2233.
+    // called before calling handleUpdate, but only if the node contains changes
+    // that aren't id properties (relates). See issues #2233, #2605.
     const hasBeforeUpdate =
       node.obj.constructor.beforeUpdate !== Model.beforeUpdate ||
       node.obj.$beforeUpdate !== Model.prototype.$beforeUpdate;
 
-    if (!hasBeforeUpdate && !handleUpdate()) {
+    if (
+      (hasBeforeUpdate && !this._hasNonIdPropertyChanges(node)) ||
+      (!hasBeforeUpdate && !handleUpdate())
+    ) {
       return null;
     }
 
@@ -82,24 +86,15 @@ class GraphPatchAction extends GraphAction {
       .copyFrom(builder, GraphAction.ReturningAllSelector);
 
     if (hasBeforeUpdate) {
-      updateBuilder
-        .context({
-          runBefore: () => {
-            // Call handleUpdate in the runBefore hook which runs after the
-            // $beforeUpdate hook, allowing it to modify the object before the
-            // updated properties are determined. See issue #2233.
-            if (hasBeforeUpdate && !handleUpdate()) {
-              throw new ReturnNullException();
-            }
-          },
-        })
-        .onError((error) => {
-          if (error instanceof ReturnNullException) {
-            return null;
-          } else {
-            return Promise.reject(error);
-          }
-        });
+      updateBuilder.internalContext().runBefore.push((result, builder) => {
+        // Call handleUpdate in the runBefore hook which runs after the
+        // $beforeUpdate hook, allowing it to modify the object before the
+        // updated properties are determined. See issue #2233.
+        if (hasBeforeUpdate && !handleUpdate()) {
+          builder.internalOptions().returnImmediatelyValue = null;
+        }
+        return result;
+      });
     }
 
     if (shouldPatch) {
@@ -216,6 +211,11 @@ class GraphPatchAction extends GraphAction {
     };
   }
 
+  _hasNonIdPropertyChanges(node) {
+    const idProps = node.modelClass.getIdPropertyArray();
+    return this._findChanges(node).changedProps.some((prop) => !idProps.includes(prop));
+  }
+
   _createBuilder(node) {
     if (node.parentEdge && !node.parentEdge.relation.isObjectionHasManyRelation) {
       return this._createRelatedBuilder(node);
@@ -235,8 +235,6 @@ class GraphPatchAction extends GraphAction {
   }
 }
 
-class ReturnNullException {}
-
 function childQueryOptions() {
   return {
     fork: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "objection",
-  "version": "3.1.3",
+  "version": "3.1.5",
   "description": "An SQL-friendly ORM for Node.js",
   "main": "lib/objection.js",
   "license": "MIT",
@@ -53,7 +53,7 @@
   ],
   "types": "./typings/objection/index.d.ts",
   "dependencies": {
-    "ajv": "^8.12.0",
+    "ajv": "^8.17.1",
     "ajv-formats": "^2.1.1",
     "db-errors": "^0.2.3"
   },
@@ -61,20 +61,20 @@
     "knex": ">=1.0.1"
   },
   "devDependencies": {
-    "@types/node": "^20.10.0",
+    "@types/node": "^22.7.0",
     "chai": "^4.3.10",
     "chai-subset": "^1.6.0",
     "eslint": "^8.54.0",
     "eslint-formatter-codeframe": "^7.32.1",
-    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-prettier": "^5.2.1",
     "expect.js": "^0.3.1",
-    "knex": "^3.0.1",
-    "mocha": "^10.2.0",
+    "knex": "^3.1.0",
+    "mocha": "^10.7.3",
     "mysql": "^2.18.1",
-    "pg": "^8.11.3",
-    "prettier": "3.1.0",
-    "sqlite3": "^5.1.6",
-    "typescript": ">=5.3.2",
+    "pg": "^8.13.0",
+    "prettier": "3.3.3",
+    "sqlite3": "^5.1.7",
+    "typescript": ">=5.6.2",
     "vuepress": "1.9.10"
   }
 }

package/typings/objection/index.d.ts

@@ -229,13 +229,14 @@ declare namespace Objection {
       }
     : never;
 
-  type PartialModelGraphField<F> = Defined<F> extends Model
-    ? PartialModelGraph<Defined<F>>
-    : Defined<F> extends Array<infer I>
-      ? I extends Model
-        ? PartialModelGraph<I>[]
-        : Expression<F>
-      : Expression<F>;
+  type PartialModelGraphField<F> =
+    Defined<F> extends Model
+      ? PartialModelGraph<Defined<F>>
+      : Defined<F> extends Array<infer I>
+        ? I extends Model
+          ? PartialModelGraph<I>[]
+          : Expression<F>
+        : Expression<F>;
 
   /**
    * Extracts the property names (excluding relations) of a model class.
@@ -1069,7 +1070,7 @@ declare namespace Objection {
     insert(insert: PartialModelObject<M>[]): ArrayQueryBuilder<this>;
     insert(): SingleQueryBuilder<this>;
 
-    onConflict(column?: string | string[] | true): this;
+    onConflict(column?: ColumnRef | ColumnRef[] | true): this;
     ignore(): this;
     merge(merge?: PartialModelObject<M> | string[]): this;
 
@@ -1422,6 +1423,19 @@ declare namespace Objection {
     new (): T;
   }
 
+  interface PrototypeType<T> extends Function {
+    prototype: T;
+  }
+  
+  interface ConstructorFunctionType<T = any> extends PrototypeType<T> {
+    new (...args: any[]): T;
+  }
+  
+  // for internal use on generic static this deduction, copied from https://github.com/microsoft/TypeScript/issues/5863#issuecomment-1483978415
+  type ConstructorType<T = unknown, Static extends Record<string, any> = PrototypeType<T>> = (ConstructorFunctionType<T> | PrototypeType<T>) & {
+    [Key in keyof Static]: Static[Key];
+  };  
+
   export interface ModelConstructor<M extends Model> extends Constructor<M> {}
 
   export interface ModelClass<M extends Model> extends ModelConstructor<M> {
@@ -1472,6 +1486,9 @@ declare namespace Objection {
     fromJson(json: object, opt?: ModelOptions): M;
     fromDatabaseJson(json: object): M;
 
+    columnNameToPropertyName(columnName: string): string;
+    propertyNameToColumnName(propertyName: string): string;
+
     createValidator(): Validator;
     createValidationError(args: CreateValidationErrorArgs): Error;
     createNotFoundError(queryContext: QueryContext, args: CreateNotFoundErrorArgs): Error;
@@ -1569,7 +1586,7 @@ declare namespace Objection {
     ): QueryBuilderType<M>;
 
     static relatedQuery<M extends Model, K extends keyof M>(
-      this: Constructor<M>,
+      this: ConstructorType<M>,
       relationName: K,
       trxOrKnex?: TransactionOrKnex,
     ): ArrayRelatedQueryBuilder<M[K]>;
@@ -1582,6 +1599,9 @@ declare namespace Objection {
     static fromJson<M extends Model>(this: Constructor<M>, json: object, opt?: ModelOptions): M;
     static fromDatabaseJson<M extends Model>(this: Constructor<M>, json: object): M;
 
+    static columnNameToPropertyName(columnName: string): string;
+    static propertyNameToColumnName(propertyName: string): string;
+
     static createValidator(): Validator;
     static createValidationError(args: CreateValidationErrorArgs): Error;
     static createNotFoundError(queryContext: QueryContext, args: CreateNotFoundErrorArgs): Error;
@@ -1595,7 +1615,7 @@ declare namespace Objection {
 
     static transaction<T>(callback: (trx: Transaction) => Promise<T>): Promise<T>;
     static transaction<T>(
-      trxOrKnex: TransactionOrKnex,
+      trxOrKnex: TransactionOrKnex | undefined,
       callback: (trx: Transaction) => Promise<T>,
     ): Promise<T>;
 
@@ -1699,13 +1719,13 @@ declare namespace Objection {
     ): this;
 
     $set(obj: Pojo): this;
-    $omit(keys: string | string[] | { [key: string]: boolean }): this;
-    $pick(keys: string | string[] | { [key: string]: boolean }): this;
     $clone(opt?: CloneOptions): this;
     $traverse(filterConstructor: typeof Model, traverser: TraverserFunction): this;
     $traverse(traverser: TraverserFunction): this;
     $traverseAsync(filterConstructor: typeof Model, traverser: TraverserFunction): Promise<this>;
     $traverseAsync(traverser: TraverserFunction): Promise<this>;
+    $omitFromJson(keys: string | string[] | { [key: string]: boolean }): this;
+    $omitFromDatabaseJson(keys: string | string[] | { [key: string]: boolean }): this;
 
     $knex(): Knex;
     $transaction(): Knex;