objection 2.2.17 → 3.0.0-alpha.5

package/lib/model/AjvValidator.js

@@ -16,12 +16,14 @@ class AjvValidator extends Validator {
   static init(self, conf) {
     super.init(self, conf);
 
-    self.ajvOptions = Object.assign({ errorDataPath: 'property' }, conf.options, {
+    self.ajvOptions = Object.assign({}, conf.options, {
       allErrors: true,
     });
 
+    const Ajv = getAjv();
+
     // Create a normal Ajv instance.
-    self.ajv = new getAjv()(
+    self.ajv = new Ajv(
       Object.assign(
         {
           useDefaults: true,
@@ -32,7 +34,7 @@ class AjvValidator extends Validator {
 
     // Create an instance that doesn't set default values. We need this one
     // to validate `patch` objects (objects that have a subset of properties).
-    self.ajvNoDefaults = new getAjv()(
+    self.ajvNoDefaults = new Ajv(
       Object.assign({}, self.ajvOptions, {
         useDefaults: false,
       })
@@ -151,8 +153,6 @@ function parseValidationError(errors, modelClass, options) {
   let numErrors = 0;
 
   for (const error of errors) {
-    const dataPath = `${options.dataPath || ''}${error.dataPath}`;
-
     // If additionalProperties = false, relations can pop up as additionalProperty
     // errors. Skip those.
     if (
@@ -163,10 +163,17 @@ function parseValidationError(errors, modelClass, options) {
       continue;
     }
 
-    // Unknown properties are reported in `['propertyName']` notation,
-    // so replace those with dot-notation, see:
-    // https://github.com/epoberezkin/ajv/issues/671
-    const key = dataPath.replace(/\['([^' ]*)'\]/g, '.$1').substring(1);
+    let path = error.instancePath.replace(/\//g, '.');
+
+    if (error.params) {
+      if (error.params.missingProperty) {
+        path += `.${error.params.missingProperty}`;
+      } else if (error.params.additionalProperty) {
+        path += `.${error.params.additionalProperty}`;
+      }
+    }
+
+    const key = `${options.dataPath || ''}${path}`.substring(1);
 
     // More than one error can occur for the same key in Ajv, merge them in the array:
     const array = errorHash[key] || (errorHash[key] = []);

package/lib/queryBuilder/QueryBuilderOperationSupport.js

@@ -6,7 +6,8 @@ const { QueryBuilderContextBase } = require('./QueryBuilderContextBase');
 const { QueryBuilderUserContext } = require('./QueryBuilderUserContext');
 
 const AllSelector = () => true;
-const SelectSelector = /^(select|columns|column|distinct|count|countDistinct|min|max|sum|sumDistinct|avg|avgDistinct)$/;
+const SelectSelector =
+  /^(select|columns|column|distinct|count|countDistinct|min|max|sum|sumDistinct|avg|avgDistinct)$/;
 const WhereSelector = /^(where|orWhere|andWhere|find\w+)/;
 const OnSelector = /^(on|orOn|andOn)/;
 const OrderBySelector = /orderBy/;

package/lib/queryBuilder/operations/UpdateOperation.js

@@ -113,12 +113,10 @@ function convertFieldExpressionsToRaw(builder, model, json) {
         val = JSON.stringify(val);
       }
 
-      convertedJson[
-        parsed.column
-      ] = knex.raw(`jsonb_set(??, '${jsonRefs}', ${valuePlaceholder}, true)`, [
-        convertedJson[parsed.column] || parsed.column,
-        val,
-      ]);
+      convertedJson[parsed.column] = knex.raw(
+        `jsonb_set(??, '${jsonRefs}', ${valuePlaceholder}, true)`,
+        [convertedJson[parsed.column] || parsed.column, val]
+      );
 
       delete model[key];
     } else {

package/lib/queryBuilder/operations/jsonApi/postgresJsonApi.js

@@ -157,7 +157,8 @@ function normalizeOperator(knex, operator) {
 module.exports = {
   parseFieldExpression: parseFieldExpression,
   whereJsonbRefOnLeftJsonbValOrRefOnRight: whereJsonbRefOnLeftJsonbValOrRefOnRight,
-  whereJsonbRefOnLeftJsonbValOrRefOnRightRawQueryParams: whereJsonbRefOnLeftJsonbValOrRefOnRightRawQueryParams,
+  whereJsonbRefOnLeftJsonbValOrRefOnRightRawQueryParams:
+    whereJsonbRefOnLeftJsonbValOrRefOnRightRawQueryParams,
   whereJsonFieldRightStringArrayOnLeftQuery: whereJsonFieldRightStringArrayOnLeftQuery,
   whereJsonFieldQuery: whereJsonFieldQuery,
 };

package/lib/utils/clone.js

@@ -81,36 +81,58 @@
 
   /** Used to identify `toStringTag` values of typed arrays. */
   var typedArrayTags = {};
-  typedArrayTags[float32Tag] = typedArrayTags[float64Tag] = typedArrayTags[
-    int8Tag
-  ] = typedArrayTags[int16Tag] = typedArrayTags[int32Tag] = typedArrayTags[
-    uint8Tag
-  ] = typedArrayTags[uint8ClampedTag] = typedArrayTags[uint16Tag] = typedArrayTags[
-    uint32Tag
-  ] = true;
-  typedArrayTags[argsTag] = typedArrayTags[arrayTag] = typedArrayTags[
-    arrayBufferTag
-  ] = typedArrayTags[boolTag] = typedArrayTags[dataViewTag] = typedArrayTags[
-    dateTag
-  ] = typedArrayTags[errorTag] = typedArrayTags[funcTag] = typedArrayTags[mapTag] = typedArrayTags[
-    numberTag
-  ] = typedArrayTags[objectTag] = typedArrayTags[regexpTag] = typedArrayTags[
-    setTag
-  ] = typedArrayTags[stringTag] = typedArrayTags[weakMapTag] = false;
+  typedArrayTags[float32Tag] =
+    typedArrayTags[float64Tag] =
+    typedArrayTags[int8Tag] =
+    typedArrayTags[int16Tag] =
+    typedArrayTags[int32Tag] =
+    typedArrayTags[uint8Tag] =
+    typedArrayTags[uint8ClampedTag] =
+    typedArrayTags[uint16Tag] =
+    typedArrayTags[uint32Tag] =
+      true;
+  typedArrayTags[argsTag] =
+    typedArrayTags[arrayTag] =
+    typedArrayTags[arrayBufferTag] =
+    typedArrayTags[boolTag] =
+    typedArrayTags[dataViewTag] =
+    typedArrayTags[dateTag] =
+    typedArrayTags[errorTag] =
+    typedArrayTags[funcTag] =
+    typedArrayTags[mapTag] =
+    typedArrayTags[numberTag] =
+    typedArrayTags[objectTag] =
+    typedArrayTags[regexpTag] =
+    typedArrayTags[setTag] =
+    typedArrayTags[stringTag] =
+    typedArrayTags[weakMapTag] =
+      false;
 
   /** Used to identify `toStringTag` values supported by `_.clone`. */
   var cloneableTags = {};
-  cloneableTags[argsTag] = cloneableTags[arrayTag] = cloneableTags[arrayBufferTag] = cloneableTags[
-    dataViewTag
-  ] = cloneableTags[boolTag] = cloneableTags[dateTag] = cloneableTags[float32Tag] = cloneableTags[
-    float64Tag
-  ] = cloneableTags[int8Tag] = cloneableTags[int16Tag] = cloneableTags[int32Tag] = cloneableTags[
-    mapTag
-  ] = cloneableTags[numberTag] = cloneableTags[objectTag] = cloneableTags[
-    regexpTag
-  ] = cloneableTags[setTag] = cloneableTags[stringTag] = cloneableTags[symbolTag] = cloneableTags[
-    uint8Tag
-  ] = cloneableTags[uint8ClampedTag] = cloneableTags[uint16Tag] = cloneableTags[uint32Tag] = true;
+  cloneableTags[argsTag] =
+    cloneableTags[arrayTag] =
+    cloneableTags[arrayBufferTag] =
+    cloneableTags[dataViewTag] =
+    cloneableTags[boolTag] =
+    cloneableTags[dateTag] =
+    cloneableTags[float32Tag] =
+    cloneableTags[float64Tag] =
+    cloneableTags[int8Tag] =
+    cloneableTags[int16Tag] =
+    cloneableTags[int32Tag] =
+    cloneableTags[mapTag] =
+    cloneableTags[numberTag] =
+    cloneableTags[objectTag] =
+    cloneableTags[regexpTag] =
+    cloneableTags[setTag] =
+    cloneableTags[stringTag] =
+    cloneableTags[symbolTag] =
+    cloneableTags[uint8Tag] =
+    cloneableTags[uint8ClampedTag] =
+    cloneableTags[uint16Tag] =
+    cloneableTags[uint32Tag] =
+      true;
   cloneableTags[errorTag] = cloneableTags[funcTag] = cloneableTags[weakMapTag] = false;
 
   /** Detect free variable `global` from Node.js. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "objection",
-  "version": "2.2.17",
+  "version": "3.0.0-alpha.5",
   "description": "An SQL-friendly ORM for Node.js",
   "main": "lib/objection.js",
   "license": "MIT",
@@ -41,7 +41,7 @@
     "url": "git://github.com/vincit/objection.js.git"
   },
   "engines": {
-    "node": ">=8.0.0"
+    "node": ">=12.0.0"
   },
   "keywords": [
     "orm",
@@ -61,34 +61,32 @@
   ],
   "types": "./typings/objection/index.d.ts",
   "dependencies": {
-    "ajv": "^6.12.6",
+    "ajv": "^8.6.2",
     "db-errors": "^0.2.3"
   },
   "peerDependencies": {
-    "knex": "<0.95.0"
+    "knex": ">=0.95.0"
   },
   "devDependencies": {
-    "@types/node": "^14.14.13",
-    "chai": "^4.2.0",
+    "@types/node": "^16.3.2",
+    "chai": "^4.3.4",
     "chai-subset": "^1.6.0",
-    "coveralls": "^3.1.0",
+    "coveralls": "^3.1.1",
     "cross-env": "^7.0.3",
-    "eslint": "^7.15.0",
-    "eslint-plugin-prettier": "^3.2.0",
+    "eslint": "^7.30.0",
+    "eslint-plugin-prettier": "^3.4.0",
     "expect.js": "^0.3.1",
-    "fs-extra": "^9.0.1",
-    "glob": "^7.1.6",
-    "husky": "^4.3.6",
-    "knex": "0.21.15",
-    "lint-staged": "^10.5.3",
-    "mocha": "^8.2.1",
+    "fs-extra": "^10.0.0",
+    "glob": "^7.1.7",
+    "knex": "0.95.7",
+    "mocha": "^9.0.2",
     "mysql": "^2.18.1",
     "nyc": "^15.1.0",
-    "pg": "^8.5.1",
-    "prettier": "2.2.1",
-    "sqlite3": "^5.0.0",
-    "typescript": "^4.1.3",
-    "vuepress": "1.7.1"
+    "pg": "^8.6.0",
+    "prettier": "2.3.2",
+    "sqlite3": "^5.0.2",
+    "typescript": "^4.3.5",
+    "vuepress": "1.8.2"
   },
   "nyc": {
     "description": "test coverage",
@@ -103,21 +101,5 @@
       "text"
     ],
     "report-dir": "./testCoverage"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
-  "lint-staged": {
-    "*.js": [
-      "prettier --write",
-      "eslint --fix",
-      "git add"
-    ],
-    "*.{yml,ts}": [
-      "prettier --write",
-      "git add"
-    ]
   }
 }

package/typings/objection/index.d.ts

@@ -12,9 +12,9 @@
 // * Karl Blomster <https://github.com/kblomster>
 // * And many others: See <https://github.com/Vincit/objection.js/blob/master/typings/objection/index.d.ts>
 
-import * as ajv from 'ajv';
+import Ajv, { Options as AjvOptions } from 'ajv';
 import * as dbErrors from 'db-errors';
-import * as Knex from 'knex';
+import { Knex } from 'knex';
 
 // Export the entire Objection namespace.
 export = Objection;
@@ -306,6 +306,11 @@ declare namespace Objection {
    */
   type SingleQueryBuilder<T extends { SingleQueryBuilderType: any }> = T['SingleQueryBuilderType'];
 
+  /**
+   * Gets the single or undefined item query builder type for a query builder.
+   */
+  type MaybeSingleQueryBuilder<QB extends AnyQueryBuilder> = QB['MaybeSingleQueryBuilderType'];
+
   /**
    * Gets the multi-item query builder type for a query builder.
    */
@@ -566,7 +571,7 @@ declare namespace Objection {
 
   interface FirstMethod {
     <QB extends AnyQueryBuilder>(this: QB): QB extends ArrayQueryBuilder<QB>
-      ? SingleQueryBuilder<QB>
+      ? MaybeSingleQueryBuilder<QB>
       : QB;
   }
 
@@ -589,10 +594,6 @@ declare namespace Objection {
     (arg: T): QB;
   }
 
-  interface OptionalOneArgMethod<T, QB extends AnyQueryBuilder> {
-    (arg?: T): QB;
-  }
-
   interface StringReturningMethod {
     (): string;
   }
@@ -754,7 +755,7 @@ declare namespace Objection {
   export interface GraphOptions {
     minimize?: boolean;
     separator?: string;
-    aliases?: {[key: string]: string};
+    aliases?: { [key: string]: string };
     joinOperation?: string;
     maxBatchSize?: number;
   }
@@ -798,7 +799,13 @@ declare namespace Objection {
     [key: string]: any;
   }
 
-  export class QueryBuilder<M extends Model, R = M[]> extends Promise<R> {
+  export interface CatchablePromiseLike<R> extends PromiseLike<R> {
+    catch<FR = never>(
+      onrejected?: ((reason: any) => FR | PromiseLike<FR>) | undefined | null
+    ): Promise<R | FR>;
+  }
+
+  export class QueryBuilder<M extends Model, R = M[]> implements CatchablePromiseLike<R> {
     static forClass: ForClassMethod;
 
     select: SelectMethod<this>;
@@ -969,9 +976,9 @@ declare namespace Objection {
     groupBy: GroupByMethod<this>;
     groupByRaw: RawInterface<this>;
 
-    findById(id: MaybeCompositeId): SingleQueryBuilder<this>;
+    findById(id: MaybeCompositeId): MaybeSingleQueryBuilder<this>;
     findByIds(ids: MaybeCompositeId[]): this;
-    findOne: WhereMethod<SingleQueryBuilder<this>>;
+    findOne: WhereMethod<MaybeSingleQueryBuilder<this>>;
 
     execute(): Promise<R>;
     castTo<MC extends Model>(modelClass: ModelConstructor<MC>): QueryBuilderType<MC>;
@@ -1047,7 +1054,10 @@ declare namespace Objection {
     // Deprecated
     allowUpsert: AllowGraphMethod<this>;
 
-    throwIfNotFound: OptionalOneArgMethod<object, this>;
+    throwIfNotFound: (
+      arg?: any
+    ) => R extends Model | undefined ? SingleQueryBuilder<QueryBuilder<M, M>> : this;
+
     returning: ReturningMethod;
     forUpdate: IdentityMethod<this>;
     forShare: IdentityMethod<this>;
@@ -1156,10 +1166,22 @@ declare namespace Objection {
 
     ArrayQueryBuilderType: QueryBuilder<M, M[]>;
     SingleQueryBuilderType: QueryBuilder<M, M>;
+    MaybeSingleQueryBuilderType: QueryBuilder<M, M | undefined>;
     NumberQueryBuilderType: QueryBuilder<M, number>;
     PageQueryBuilderType: QueryBuilder<M, Page<M>>;
+
+    then<R1 = R, R2 = never>(
+      onfulfilled?: ((value: R) => R1 | PromiseLike<R1>) | undefined | null,
+      onrejected?: ((reason: any) => R2 | PromiseLike<R2>) | undefined | null
+    ): Promise<R1 | R2>;
+
+    catch<FR = never>(
+      onrejected?: ((reason: any) => FR | PromiseLike<FR>) | undefined | null
+    ): Promise<R | FR>;
   }
 
+  type X<T> = Promise<T>;
+
   interface FetchGraphOptions {
     transaction?: TransactionOrKnex;
     skipFetched?: boolean;
@@ -1287,8 +1309,8 @@ declare namespace Objection {
   }
 
   export interface AjvConfig {
-    onCreateAjv(ajv: ajv.Ajv): void;
-    options?: ajv.Options;
+    onCreateAjv(ajv: Ajv): void;
+    options?: AjvOptions;
   }
 
   export class AjvValidator extends Validator {