objection 3.1.1 → 3.1.3

package/README.md

@@ -44,10 +44,10 @@ Check out [this issue](https://github.com/Vincit/objection.js/issues/1069) to se
 
 Shortcuts:
 
-- [Who uses objection.js](https://github.com/Vincit/objection.js/issues/1069)
+- [Who uses objection.js](https://github.com/Vincit/objection.js/discussions/2464)
 - [API reference](https://vincit.github.io/objection.js/api/query-builder/)
 - [Example projects](https://github.com/Vincit/objection.js/tree/main/examples)
 - [Changelog](https://vincit.github.io/objection.js/release-notes/changelog.html)
-- [v1 -> v2 migration guide](https://vincit.github.io/objection.js/release-notes/migration.html)
+- [v1 -> v2 -> v3 migration guide](https://vincit.github.io/objection.js/release-notes/migration.html)
 - [Contribution guide](https://vincit.github.io/objection.js/guide/contributing.html)
 - [Plugins](https://vincit.github.io/objection.js/guide/plugins.html)

package/lib/model/AjvValidator.js

@@ -20,8 +20,8 @@ class AjvValidator extends Validator {
         {
           useDefaults: true,
         },
-        self.ajvOptions
-      )
+        self.ajvOptions,
+      ),
     );
 
     // Create an instance that doesn't set default values. We need this one
@@ -29,7 +29,7 @@ class AjvValidator extends Validator {
     self.ajvNoDefaults = new Ajv(
       Object.assign({}, self.ajvOptions, {
         useDefaults: false,
-      })
+      }),
     );
 
     // A cache for the compiled validator functions.
@@ -252,7 +252,7 @@ function objectHasDefaults(obj) {
 }
 
 function jsonSchemaWithoutRequired(jsonSchema) {
-  const subSchemaProps = ['anyOf', 'oneOf', 'allOf', 'not', 'then', 'else'];
+  const subSchemaProps = ['anyOf', 'oneOf', 'allOf', 'not', 'then', 'else', 'properties'];
   return Object.assign(
     omit(jsonSchema, ['required', ...subSchemaProps]),
     ...subSchemaProps.map((prop) => subSchemaWithoutRequired(jsonSchema, prop)),
@@ -261,13 +261,13 @@ function jsonSchemaWithoutRequired(jsonSchema) {
           definitions: Object.assign(
             ...Object.keys(jsonSchema.definitions).map((prop) => ({
               [prop]: jsonSchemaWithoutRequired(jsonSchema.definitions[prop]),
-            }))
+            })),
           ),
         }
       : {},
     jsonSchema.discriminator && jsonSchema.discriminator.propertyName
       ? { required: [jsonSchema.discriminator.propertyName] }
-      : {}
+      : {},
   );
 }
 
@@ -283,6 +283,15 @@ function subSchemaWithoutRequired(jsonSchema, prop) {
       } else {
         return {};
       }
+    } else if (jsonSchema.type === 'object' && prop === 'properties') {
+      return {
+        [prop]: Object.fromEntries(
+          Object.entries(jsonSchema[prop]).map(([key, schema]) => [
+            key,
+            jsonSchemaWithoutRequired(schema),
+          ]),
+        ),
+      };
     } else {
       return {
         [prop]: jsonSchemaWithoutRequired(jsonSchema[prop]),

package/lib/model/Model.js

@@ -844,7 +844,7 @@ function getIdRelationProperty(modelClass) {
 
   return new RelationProperty(
     idColumn.map((idCol) => `${modelClass.getTableName()}.${idCol}`),
-    () => modelClass
+    () => modelClass,
   );
 }
 

package/lib/model/graph/ModelGraphBuilder.js

@@ -56,7 +56,7 @@ class ModelGraphBuilder {
         parentNode,
         node,
         relation,
-        index
+        index,
       );
 
       node.parentEdge = edge;
@@ -223,7 +223,7 @@ function createReferenceNotFoundError(ref) {
       `this may be due to a limitation that a subgraph under a related item`,
       `cannot reference an item in a subgraph under another related item.`,
       `If you run into this limitation, please open an issue in objection github.`,
-    ].join(' ')
+    ].join(' '),
   );
 }
 

package/lib/model/inheritModel.js

@@ -19,7 +19,7 @@ function createClassInheritor(className) {
     `
     'use strict';
     return class ${className} extends BaseClass {}
-  `
+  `,
   );
 }
 

package/lib/model/modelQueryProps.js

@@ -130,7 +130,7 @@ function buildObjectionQueryBuilder(builder, parentBuilder) {
 function buildKnexRawConvertable(convertable, builder) {
   if (!builder) {
     throw new Error(
-      'toDatabaseJson called without a query builder instance for a model with query properties'
+      'toDatabaseJson called without a query builder instance for a model with query properties',
     );
   }
 

package/lib/model/modelSet.js

@@ -13,7 +13,7 @@ function setJson(model, json, options) {
     throw new Error(
       'You should only pass objects to $setJson method. ' +
         '$setJson method was given an invalid value ' +
-        json
+        json,
     );
   }
 

package/lib/model/modelTableMetadata.js

@@ -7,7 +7,7 @@ const TABLE_METADATA = '$$tableMetadata';
 
 function fetchTableMetadata(
   modelClass,
-  { parentBuilder = null, knex = null, force = false, table = null } = {}
+  { parentBuilder = null, knex = null, force = false, table = null } = {},
 ) {
   // The table isn't necessarily same as `modelClass.getTableName()` for example if
   // a view is queried instead.

package/lib/queryBuilder/QueryBuilder.js

@@ -211,7 +211,7 @@ class QueryBuilder extends QueryBuilderBase {
     const currentExpr = this._allowedGraphExpression || RelationExpression.create();
 
     this._allowedGraphExpression = currentExpr.merge(
-      parseRelationExpression(this.modelClass(), exp)
+      parseRelationExpression(this.modelClass(), exp),
     );
 
     checkEager(this);
@@ -746,7 +746,7 @@ class QueryBuilder extends QueryBuilderBase {
     return writeOperation(this, () => {
       if (args.length) {
         throw new Error(
-          `Don't pass arguments to delete(). You should use it like this: delete().where('foo', 'bar').andWhere(...)`
+          `Don't pass arguments to delete(). You should use it like this: delete().where('foo', 'bar').andWhere(...)`,
         );
       }
 
@@ -771,7 +771,7 @@ class QueryBuilder extends QueryBuilderBase {
     return writeOperation(this, () => {
       if (args.length) {
         throw new Error(
-          `Don't pass arguments to unrelate(). You should use it like this: unrelate().where('foo', 'bar').andWhere(...)`
+          `Don't pass arguments to unrelate(). You should use it like this: unrelate().where('foo', 'bar').andWhere(...)`,
         );
       }
 
@@ -982,7 +982,7 @@ function ensureEagerOperation(builder, algorithm = null) {
     } else {
       const EagerOperationClass = getOperationClassForEagerAlgorithm(
         builder,
-        getWhereInEagerAlgorithm(builder)
+        getWhereInEagerAlgorithm(builder),
       );
 
       const newEagerOp = new EagerOperationClass('eager', {
@@ -1053,7 +1053,7 @@ function checkEager(builder) {
       modelClass.createValidationError({
         type: ValidationErrorType.UnallowedRelation,
         message: 'eager expression not allowed',
-      })
+      }),
     );
   }
 }
@@ -1125,7 +1125,7 @@ function handleExecuteError(builder, err) {
   builder.forEachOperation(true, (op) => {
     if (op.hasOnError()) {
       promise = promise.catch((err) =>
-        builder.callAsyncOperationMethod(op, 'onError', [builder, err])
+        builder.callAsyncOperationMethod(op, 'onError', [builder, err]),
       );
     }
   });
@@ -1140,7 +1140,7 @@ function chainOperationHooks(promise, builder, hookName) {
     builder.forEachOperation(true, (op) => {
       if (op.hasHook(hookName)) {
         promise = promise.then((result) =>
-          builder.callAsyncOperationMethod(op, hookName, [builder, result])
+          builder.callAsyncOperationMethod(op, hookName, [builder, result]),
         );
       }
     });
@@ -1308,8 +1308,8 @@ function writeOperation(builder, cb) {
         'Double call to a write method. ' +
           'You can only call one of the write methods ' +
           '(insert, update, patch, delete, relate, unrelate, increment, decrement) ' +
-          'and only once per query builder.'
-      )
+          'and only once per query builder.',
+      ),
     );
   }
 

package/lib/queryBuilder/QueryBuilderBase.js

@@ -619,7 +619,7 @@ class QueryBuilderBase extends QueryBuilderOperationSupport {
   whereJsonSupersetOf(...args) {
     return this.addOperation(
       new WhereJsonPostgresOperation('whereJsonSupersetOf', { operator: '@>', bool: 'and' }),
-      args
+      args,
     );
   }
 
@@ -630,7 +630,7 @@ class QueryBuilderBase extends QueryBuilderOperationSupport {
   orWhereJsonSupersetOf(...args) {
     return this.addOperation(
       new WhereJsonPostgresOperation('orWhereJsonSupersetOf', { operator: '@>', bool: 'or' }),
-      args
+      args,
     );
   }
 
@@ -641,7 +641,7 @@ class QueryBuilderBase extends QueryBuilderOperationSupport {
         bool: 'and',
         prefix: 'not',
       }),
-      args
+      args,
     );
   }
 
@@ -656,14 +656,14 @@ class QueryBuilderBase extends QueryBuilderOperationSupport {
         bool: 'or',
         prefix: 'not',
       }),
-      args
+      args,
     );
   }
 
   whereJsonSubsetOf(...args) {
     return this.addOperation(
       new WhereJsonPostgresOperation('whereJsonSubsetOf', { operator: '<@', bool: 'and' }),
-      args
+      args,
     );
   }
 
@@ -674,7 +674,7 @@ class QueryBuilderBase extends QueryBuilderOperationSupport {
   orWhereJsonSubsetOf(...args) {
     return this.addOperation(
       new WhereJsonPostgresOperation('orWhereJsonSubsetOf', { operator: '<@', bool: 'or' }),
-      args
+      args,
     );
   }
 
@@ -685,7 +685,7 @@ class QueryBuilderBase extends QueryBuilderOperationSupport {
         bool: 'and',
         prefix: 'not',
       }),
-      args
+      args,
     );
   }
 
@@ -700,7 +700,7 @@ class QueryBuilderBase extends QueryBuilderOperationSupport {
         bool: 'or',
         prefix: 'not',
       }),
-      args
+      args,
     );
   }
 
@@ -710,7 +710,7 @@ class QueryBuilderBase extends QueryBuilderOperationSupport {
         bool: 'and',
         compareValue: [],
       }),
-      args
+      args,
     );
   }
 
@@ -720,7 +720,7 @@ class QueryBuilderBase extends QueryBuilderOperationSupport {
         bool: 'or',
         compareValue: [],
       }),
-      args
+      args,
     );
   }
 
@@ -730,7 +730,7 @@ class QueryBuilderBase extends QueryBuilderOperationSupport {
         bool: 'and',
         compareValue: {},
       }),
-      args
+      args,
     );
   }
 
@@ -740,35 +740,35 @@ class QueryBuilderBase extends QueryBuilderOperationSupport {
         bool: 'or',
         compareValue: {},
       }),
-      args
+      args,
     );
   }
 
   whereJsonHasAny(...args) {
     return this.addOperation(
       new WhereJsonHasPostgresOperation('whereJsonHasAny', { bool: 'and', operator: '?|' }),
-      args
+      args,
     );
   }
 
   orWhereJsonHasAny(...args) {
     return this.addOperation(
       new WhereJsonHasPostgresOperation('orWhereJsonHasAny', { bool: 'or', operator: '?|' }),
-      args
+      args,
     );
   }
 
   whereJsonHasAll(...args) {
     return this.addOperation(
       new WhereJsonHasPostgresOperation('whereJsonHasAll', { bool: 'and', operator: '?&' }),
-      args
+      args,
     );
   }
 
   orWhereJsonHasAll(...args) {
     return this.addOperation(
       new WhereJsonHasPostgresOperation('orWhereJsonHasAll', { bool: 'or', operator: '?&' }),
-      args
+      args,
     );
   }
 

package/lib/queryBuilder/QueryBuilderOperationSupport.js

@@ -207,7 +207,7 @@ class QueryBuilderOperationSupport {
 
       if (!knex) {
         throw new Error(
-          `no database connection available for a query. You need to bind the model class or the query to a knex instance.`
+          `no database connection available for a query. You need to bind the model class or the query to a knex instance.`,
         );
       }
 
@@ -255,7 +255,7 @@ class QueryBuilderOperationSupport {
         } else {
           operationsToReplace.push({ op, findOp });
         }
-      }
+      },
     );
 
     for (const op of operationsToRemove) {
@@ -364,7 +364,7 @@ class QueryBuilderOperationSupport {
         every = false;
         return false;
       },
-      false
+      false,
     );
 
     return every;

package/lib/queryBuilder/ReferenceBuilder.js

@@ -76,8 +76,8 @@ class ReferenceBuilder {
     const table = this.tableName
       ? this.tableName
       : this.modelClass
-      ? builder.tableRefFor(this.modelClass)
-      : null;
+        ? builder.tableRefFor(this.modelClass)
+        : null;
 
     if (table) {
       return `${table}.${this.column}`;

package/lib/queryBuilder/graph/GraphNodeDbExistence.js

@@ -155,7 +155,7 @@ function createExistenceCheckQueries({ builder, mayNotExist }) {
         .query()
         .childQueryOf(builder, childQueryOptions())
         .findByIds(ids)
-        .select(modelClass.getIdColumnArray())
+        .select(modelClass.getIdColumnArray()),
     );
   }
 

package/lib/queryBuilder/graph/GraphOptions.js

@@ -179,7 +179,7 @@ class GraphOptions {
       return false;
     } else {
       throw new Error(
-        `expected ${optionName} option value "${option}" to be an instance of boolean or array of strings`
+        `expected ${optionName} option value "${option}" to be an instance of boolean or array of strings`,
       );
     }
   }

package/lib/queryBuilder/graph/GraphUpsert.js

@@ -152,7 +152,7 @@ function findRoots(nodes) {
       }
 
       return true;
-    })
+    }),
   );
 }
 
@@ -160,8 +160,8 @@ function removeBranchesFromGraph(branchRoots, graph) {
   const nodesToRemove = new Set(
     branchRoots.reduce(
       (nodesToRemove, node) => [...nodesToRemove, ...node.descendantRelationNodes],
-      []
-    )
+      [],
+    ),
   );
 
   removeNodesFromGraph(nodesToRemove, graph);
@@ -268,7 +268,7 @@ function checkForHasManyRelateErrors(graphData) {
       node.parentEdge.relation.isObjectionHasManyRelation
     ) {
       throw new Error(
-        'You cannot relate HasManyRelation or HasOneRelation using insertGraph, because those require update operations. Consider using upsertGraph instead.'
+        'You cannot relate HasManyRelation or HasOneRelation using insertGraph, because those require update operations. Consider using upsertGraph instead.',
       );
     }
   }
@@ -292,7 +292,7 @@ function executeOperations(builder) {
 function executeActions(builder, actions) {
   return actions.reduce(
     (promise, action) => promise.then(() => action.run(builder)),
-    Promise.resolve()
+    Promise.resolve(),
   );
 }
 

package/lib/queryBuilder/graph/delete/GraphDelete.js

@@ -8,7 +8,7 @@ class GraphDelete extends GraphOperation {
     return [
       new GraphDeleteAction(this.graphData, {
         nodes: this.currentGraph.nodes.filter((currentNode) =>
-          this.graphOptions.shouldDeleteOrUnrelate(currentNode, this.graphData)
+          this.graphOptions.shouldDeleteOrUnrelate(currentNode, this.graphData),
         ),
       }),
     ];

package/lib/queryBuilder/graph/insert/GraphInsert.js

@@ -77,7 +77,7 @@ class GraphInsert extends GraphOperation {
         new GraphInsertAction(this.graphData, {
           nodes: nodesToInsert,
           dependencies: this.dependencies,
-        })
+        }),
       );
 
       for (const node of nodesToInsert) {

package/lib/queryBuilder/graph/insert/GraphInsertAction.js

@@ -203,7 +203,7 @@ class GraphInsertAction extends GraphAction {
         } else {
           return null;
         }
-      })
+      }),
     );
   }
 

package/lib/queryBuilder/graph/insert/JoinRowGraphInsertAction.js

@@ -50,7 +50,7 @@ class JoinRowGraphInsertAction extends GraphAction {
     this._resolveReferences(node);
 
     return joinTableModelClass.fromJson(
-      relation.createJoinModel(relation.ownerProp.getProps(parentNode.obj), node.obj)
+      relation.createJoinModel(relation.ownerProp.getProps(parentNode.obj), node.obj),
     );
   }
 
@@ -64,12 +64,12 @@ class JoinRowGraphInsertAction extends GraphAction {
         if (node.parentEdge) {
           return node.parentEdge.relation.joinTableBeforeInsert(
             joinTableObj,
-            parentBuilder.context()
+            parentBuilder.context(),
           );
         } else {
           return null;
         }
-      })
+      }),
     );
   }
 

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

@@ -8,7 +8,7 @@ class GraphPatch extends GraphOperation {
     return [
       new GraphPatchAction(this.graphData, {
         nodes: this.graph.nodes.filter((node) =>
-          this.graphOptions.shouldPatchOrUpdateIgnoreDisable(node, this.graphData)
+          this.graphOptions.shouldPatchOrUpdateIgnoreDisable(node, this.graphData),
         ),
       }),
     ];

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

@@ -42,7 +42,7 @@ class GraphPatchAction extends GraphAction {
 
         // Remove id properties from the props to update. With upsertGraph
         // it never makes sense to change the id.
-        node.modelClass.getIdPropertyArray()
+        node.modelClass.getIdPropertyArray(),
       );
 
       const update = propsToUpdate.length > 0;

package/lib/queryBuilder/graph/recursiveUpsert/GraphRecursiveUpsertAction.js

@@ -40,8 +40,8 @@ class GraphRecursiveUpsertAction extends GraphAction {
             .copyFrom(parentBuilder, GraphAction.ReturningAllSelector)
             .upsertGraph(
               nodes.map((node) => node.obj),
-              this.graphOptions.rebasedOptions(nodes[0])
-            )
+              this.graphOptions.rebasedOptions(nodes[0]),
+            ),
         );
       });
     });

package/lib/queryBuilder/join/JoinResultParser.js

@@ -95,7 +95,7 @@ class JoinResultParser {
 
   _createColumns(row) {
     const columns = Object.keys(row).map((columnAlias) =>
-      JoinResultColumn.create({ tableTree: this.tableTree, columnAlias })
+      JoinResultColumn.create({ tableTree: this.tableTree, columnAlias }),
     );
 
     return groupBy(columns, getTableNode);

package/lib/queryBuilder/join/RelationJoiner.js

@@ -64,7 +64,7 @@ class RelationJoiner {
       (modelClass) => modelClass.fetchTableMetadata({ parentBuilder: builder }),
       {
         concurrency: this.rootModelClass.getConcurrency(builder.unsafeKnex()),
-      }
+      },
     );
   }
 
@@ -204,7 +204,7 @@ function ensureIdAndRelationPropsAreSelected({ builder, tableNode }) {
     ...tableNode.relation.relatedProp.cols,
     ...tableNode.childNodes.reduce(
       (cols, childNode) => [...cols, ...childNode.relation.ownerProp.cols],
-      []
+      [],
     ),
   ];
 
@@ -264,7 +264,7 @@ function mapUserSelectionsFromSubqueryToMainQuery({ userSelections, tableNode })
     return new Selection(
       tableNode.alias,
       selection.name,
-      tableNode.getColumnAliasForColumn(selection.name)
+      tableNode.getColumnAliasForColumn(selection.name),
     );
   });
 }
@@ -274,7 +274,7 @@ function getJoinTableExtraSelectionsForNode({ builder, tableNode }) {
     return new Selection(
       tableNode.getJoinTableAlias(builder),
       extra.joinTableCol,
-      tableNode.getColumnAliasForColumn(extra.aliasCol)
+      tableNode.getColumnAliasForColumn(extra.aliasCol),
     );
   });
 }
@@ -285,7 +285,7 @@ function getAllColumnSelectionsForNode({ builder, tableNode }) {
 
   if (!tableMeta) {
     throw new Error(
-      `table metadata has not been fetched for table '${table}'. Are you trying to call toKnexQuery() for a withGraphJoined query? To make sure the table metadata is fetched see the objection.initialize function.`
+      `table metadata has not been fetched for table '${table}'. Are you trying to call toKnexQuery() for a withGraphJoined query? To make sure the table metadata is fetched see the objection.initialize function.`,
     );
   }
 
@@ -293,7 +293,7 @@ function getAllColumnSelectionsForNode({ builder, tableNode }) {
     return new Selection(
       tableNode.alias,
       columnName,
-      tableNode.getColumnAliasForColumn(columnName)
+      tableNode.getColumnAliasForColumn(columnName),
     );
   });
 }
@@ -303,7 +303,7 @@ function getIdSelectionsForNode({ tableNode }) {
     return new Selection(
       tableNode.alias,
       columnName,
-      tableNode.getColumnAliasForColumn(columnName)
+      tableNode.getColumnAliasForColumn(columnName),
     );
   });
 }

package/lib/queryBuilder/operations/FromOperation.js

@@ -92,7 +92,7 @@ function parseTableAndAliasFromObject(arg, builder) {
   }
 
   throw new Error(
-    `one of the tables in ${JSON.stringify(arg)} must be the query's model class's table.`
+    `one of the tables in ${JSON.stringify(arg)} must be the query's model class's table.`,
   );
 }
 

package/lib/queryBuilder/operations/ObjectionToKnexConvertingOperation.js

@@ -42,7 +42,7 @@ function shouldBeAdded(opName, builder, args) {
         return false;
       } else {
         throw new Error(
-          `undefined passed as argument #${i} for '${opName}' operation. Call skipUndefined() method to ignore the undefined values.`
+          `undefined passed as argument #${i} for '${opName}' operation. Call skipUndefined() method to ignore the undefined values.`,
         );
       }
     }
@@ -103,7 +103,7 @@ function convertArray(arr, builder, i, opName, skipUndefined) {
     if (item === undefined) {
       if (!skipUndefined) {
         throw new Error(
-          `undefined passed as an item in argument #${i} for '${opName}' operation. Call skipUndefined() method to ignore the undefined values.`
+          `undefined passed as an item in argument #${i} for '${opName}' operation. Call skipUndefined() method to ignore the undefined values.`,
         );
       }
     } else if (hasToKnexRawMethod(item)) {
@@ -162,7 +162,7 @@ function convertPlainObject(obj, builder, i, opName, skipUndefined) {
     if (item === undefined) {
       if (!skipUndefined) {
         throw new Error(
-          `undefined passed as a property in argument #${i} for '${opName}' operation. Call skipUndefined() method to ignore the undefined values.`
+          `undefined passed as a property in argument #${i} for '${opName}' operation. Call skipUndefined() method to ignore the undefined values.`,
         );
       }
     } else if (hasToKnexRawMethod(item)) {

package/lib/queryBuilder/operations/UpdateOperation.js

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