@abedmurrar/objection 4.0.0-alpha.0 → 4.0.0-beta.0

package/lib/relations/Relation.js

@@ -1,401 +1,317 @@
 'use strict';
-
 const { withWhereScope } = require('../queryBuilder/whereScopes');
 const { RelationProperty } = require('./RelationProperty');
-
 const { RelationFindOperation } = require('./RelationFindOperation');
 const { RelationUpdateOperation } = require('./RelationUpdateOperation');
 const { RelationDeleteOperation } = require('./RelationDeleteOperation');
-
 const { resolveModel } = require('../utils/resolveModel');
 const { get, isFunction } = require('../utils/objectUtils');
 const { mapAfterAllReturn } = require('../utils/promiseUtils');
 const { createModifier } = require('../utils/createModifier');
-
 class Relation {
-  constructor(relationName, OwnerClass) {
-    this.name = relationName;
-    this.ownerModelClass = OwnerClass;
-    this.relatedModelClass = null;
-
-    this.ownerProp = null;
-    this.relatedProp = null;
-
-    this.joinTableModelClass = null;
-    this.joinTableOwnerProp = null;
-    this.joinTableRelatedProp = null;
-    this.joinTableBeforeInsert = null;
-    this.joinTableExtras = [];
-
-    this.modify = null;
-    this.beforeInsert = null;
-  }
-
-  setMapping(mapping) {
-    let ctx = {
-      name: this.name,
-      mapping,
-      ownerModelClass: this.ownerModelClass,
-      relatedModelClass: null,
-      relatedProp: null,
-      ownerProp: null,
-      modify: null,
-      beforeInsert: null,
-      forbiddenMappingProperties: this.forbiddenMappingProperties,
-      createError: (msg) => this.createError(msg),
-    };
-
-    ctx = checkForbiddenProperties(ctx);
-    ctx = checkOwnerModelClass(ctx);
-    ctx = checkRelatedModelClass(ctx);
-    ctx = resolveRelatedModelClass(ctx);
-    ctx = checkRelation(ctx);
-    ctx = createJoinProperties(ctx);
-    ctx = parseModify(ctx);
-    ctx = parseBeforeInsert(ctx);
-
-    this.relatedModelClass = ctx.relatedModelClass;
-    this.ownerProp = ctx.ownerProp;
-    this.relatedProp = ctx.relatedProp;
-    this.modify = ctx.modify;
-    this.beforeInsert = ctx.beforeInsert;
-  }
-
-  get forbiddenMappingProperties() {
-    return ['join.through'];
-  }
-
-  get joinTable() {
-    return this.joinTableModelClass ? this.joinTableModelClass.getTableName() : null;
-  }
-
-  get joinModelClass() {
-    return this.getJoinModelClass(this.ownerModelClass.knex());
-  }
-
-  getJoinModelClass(knex) {
-    return this.joinTableModelClass && knex !== this.joinTableModelClass.knex()
-      ? this.joinTableModelClass.bindKnex(knex)
-      : this.joinTableModelClass;
-  }
-
-  isOneToOne() {
-    return false;
-  }
-
-  clone() {
-    const relation = new this.constructor(this.name, this.ownerModelClass);
-
-    relation.relatedModelClass = this.relatedModelClass;
-    relation.ownerProp = this.ownerProp;
-    relation.relatedProp = this.relatedProp;
-    relation.modify = this.modify;
-    relation.beforeInsert = this.beforeInsert;
-
-    relation.joinTableModelClass = this.joinTableModelClass;
-    relation.joinTableOwnerProp = this.joinTableOwnerProp;
-    relation.joinTableRelatedProp = this.joinTableRelatedProp;
-    relation.joinTableBeforeInsert = this.joinTableBeforeInsert;
-    relation.joinTableExtras = this.joinTableExtras;
-
-    return relation;
-  }
-
-  bindKnex(knex) {
-    const bound = this.clone();
-
-    bound.relatedModelClass = this.relatedModelClass.bindKnex(knex);
-    bound.ownerModelClass = this.ownerModelClass.bindKnex(knex);
-
-    if (this.joinTableModelClass) {
-      bound.joinTableModelClass = this.joinTableModelClass.bindKnex(knex);
-    }
-
-    return bound;
-  }
-
-  findQuery(builder, owner) {
-    const relatedRefs = this.relatedProp.refs(builder);
-
-    withWhereScope(builder, () => {
-      owner.buildFindQuery(builder, this, relatedRefs);
-    });
-
-    return this.applyModify(builder);
-  }
-
-  applyModify(builder) {
-    try {
-      // The relation's `modify` gets its own scope so that an `orWhere`
-      // in it can't escape the owner condition.
-      return withWhereScope(builder, () => builder.modify(this.modify));
-    } catch (err) {
-      if (err instanceof this.relatedModelClass.ModifierNotFoundError) {
-        throw this.createError(err.message);
-      } else {
-        throw err;
-      }
-    }
-  }
-
-  join(
-    builder,
-    {
-      joinOperation = 'join',
-      relatedTableAlias = builder.tableRefFor(this.relatedModelClass),
-      relatedJoinSelectQuery = this.relatedModelClass.query().childQueryOf(builder),
-      relatedTable = builder.tableNameFor(this.relatedModelClass),
-      ownerTable = builder.tableRefFor(this.ownerModelClass),
-    } = {},
-  ) {
-    let relatedJoinSelect = this.applyModify(relatedJoinSelectQuery).as(relatedTableAlias);
-
-    if (relatedJoinSelect.isSelectAll()) {
-      // No need to join a subquery if the query is `select * from "RelatedTable"`.
-      relatedJoinSelect = aliasedTableName(relatedTable, relatedTableAlias);
-    }
-
-    return builder[joinOperation](relatedJoinSelect, (join) => {
-      const relatedProp = this.relatedProp;
-      const ownerProp = this.ownerProp;
-
-      relatedProp.forEach((i) => {
-        const relatedRef = relatedProp.ref(builder, i).table(relatedTableAlias);
-        const ownerRef = ownerProp.ref(builder, i).table(ownerTable);
-
-        join.on(relatedRef, ownerRef);
-      });
-    });
-  }
-
-  find(_, owner) {
-    return new RelationFindOperation('find', {
-      relation: this,
-      owner,
-    });
-  }
-
-  insert(_, owner) {
-    /* istanbul ignore next */
-    throw this.createError('not implemented');
-  }
-
-  update(_, owner) {
-    return new RelationUpdateOperation('update', {
-      relation: this,
-      owner,
-    });
-  }
-
-  patch(_, owner) {
-    return new RelationUpdateOperation('patch', {
-      relation: this,
-      owner,
-      modelOptions: { patch: true },
-    });
-  }
-
-  delete(_, owner) {
-    return new RelationDeleteOperation('delete', {
-      relation: this,
-      owner,
-    });
-  }
-
-  relate() {
-    /* istanbul ignore next */
-    throw this.createError('not implemented');
-  }
-
-  unrelate() {
-    /* istanbul ignore next */
-    throw this.createError('not implemented');
-  }
-
-  hasRelateProp(model) {
-    return model.$hasProps(this.relatedProp.props);
-  }
-
-  setRelateProp(model, values) {
-    this.relatedProp.forEach((i) => {
-      this.relatedProp.setProp(model, i, values[i]);
-    });
-  }
-
-  executeBeforeInsert(models, queryContext, result) {
-    return mapAfterAllReturn(models, (model) => this.beforeInsert(model, queryContext), result);
-  }
-
-  createError(message) {
-    if (this.ownerModelClass && this.ownerModelClass.name && this.name) {
-      return new Error(`${this.ownerModelClass.name}.relationMappings.${this.name}: ${message}`);
-    } else {
-      return new Error(`${this.constructor.name}: ${message}`);
-    }
-  }
+    constructor(relationName, OwnerClass) {
+        this.name = relationName;
+        this.ownerModelClass = OwnerClass;
+        this.relatedModelClass = null;
+        this.ownerProp = null;
+        this.relatedProp = null;
+        this.joinTableModelClass = null;
+        this.joinTableOwnerProp = null;
+        this.joinTableRelatedProp = null;
+        this.joinTableBeforeInsert = null;
+        this.joinTableExtras = [];
+        this.modify = null;
+        this.beforeInsert = null;
+    }
+    setMapping(mapping) {
+        let ctx = {
+            name: this.name,
+            mapping,
+            ownerModelClass: this.ownerModelClass,
+            relatedModelClass: null,
+            relatedProp: null,
+            ownerProp: null,
+            modify: null,
+            beforeInsert: null,
+            forbiddenMappingProperties: this.forbiddenMappingProperties,
+            createError: (msg) => this.createError(msg),
+        };
+        ctx = checkForbiddenProperties(ctx);
+        ctx = checkOwnerModelClass(ctx);
+        ctx = checkRelatedModelClass(ctx);
+        ctx = resolveRelatedModelClass(ctx);
+        ctx = checkRelation(ctx);
+        ctx = createJoinProperties(ctx);
+        ctx = parseModify(ctx);
+        ctx = parseBeforeInsert(ctx);
+        this.relatedModelClass = ctx.relatedModelClass;
+        this.ownerProp = ctx.ownerProp;
+        this.relatedProp = ctx.relatedProp;
+        this.modify = ctx.modify;
+        this.beforeInsert = ctx.beforeInsert;
+    }
+    get forbiddenMappingProperties() {
+        return ['join.through'];
+    }
+    get joinTable() {
+        return this.joinTableModelClass ? this.joinTableModelClass.getTableName() : null;
+    }
+    get joinModelClass() {
+        return this.getJoinModelClass(this.ownerModelClass.knex());
+    }
+    getJoinModelClass(knex) {
+        return this.joinTableModelClass && knex !== this.joinTableModelClass.knex()
+            ? this.joinTableModelClass.bindKnex(knex)
+            : this.joinTableModelClass;
+    }
+    isOneToOne() {
+        return false;
+    }
+    clone() {
+        const relation = new this.constructor(this.name, this.ownerModelClass);
+        relation.relatedModelClass = this.relatedModelClass;
+        relation.ownerProp = this.ownerProp;
+        relation.relatedProp = this.relatedProp;
+        relation.modify = this.modify;
+        relation.beforeInsert = this.beforeInsert;
+        relation.joinTableModelClass = this.joinTableModelClass;
+        relation.joinTableOwnerProp = this.joinTableOwnerProp;
+        relation.joinTableRelatedProp = this.joinTableRelatedProp;
+        relation.joinTableBeforeInsert = this.joinTableBeforeInsert;
+        relation.joinTableExtras = this.joinTableExtras;
+        return relation;
+    }
+    bindKnex(knex) {
+        const bound = this.clone();
+        bound.relatedModelClass = this.relatedModelClass.bindKnex(knex);
+        bound.ownerModelClass = this.ownerModelClass.bindKnex(knex);
+        if (this.joinTableModelClass) {
+            bound.joinTableModelClass = this.joinTableModelClass.bindKnex(knex);
+        }
+        return bound;
+    }
+    findQuery(builder, owner) {
+        const relatedRefs = this.relatedProp.refs(builder);
+        withWhereScope(builder, () => {
+            owner.buildFindQuery(builder, this, relatedRefs);
+        });
+        return this.applyModify(builder);
+    }
+    applyModify(builder) {
+        try {
+            // The relation's `modify` gets its own scope so that an `orWhere`
+            // in it can't escape the owner condition.
+            return withWhereScope(builder, () => builder.modify(this.modify));
+        }
+        catch (err) {
+            if (err instanceof this.relatedModelClass.ModifierNotFoundError) {
+                throw this.createError(err.message);
+            }
+            else {
+                throw err;
+            }
+        }
+    }
+    join(builder, { joinOperation = 'join', relatedTableAlias = builder.tableRefFor(this.relatedModelClass), relatedJoinSelectQuery = this.relatedModelClass.query().childQueryOf(builder), relatedTable = builder.tableNameFor(this.relatedModelClass), ownerTable = builder.tableRefFor(this.ownerModelClass), } = {}) {
+        let relatedJoinSelect = this.applyModify(relatedJoinSelectQuery).as(relatedTableAlias);
+        if (relatedJoinSelect.isSelectAll()) {
+            // No need to join a subquery if the query is `select * from "RelatedTable"`.
+            relatedJoinSelect = aliasedTableName(relatedTable, relatedTableAlias);
+        }
+        return builder[joinOperation](relatedJoinSelect, (join) => {
+            const relatedProp = this.relatedProp;
+            const ownerProp = this.ownerProp;
+            relatedProp.forEach((i) => {
+                const relatedRef = relatedProp.ref(builder, i).table(relatedTableAlias);
+                const ownerRef = ownerProp.ref(builder, i).table(ownerTable);
+                join.on(relatedRef, ownerRef);
+            });
+        });
+    }
+    find(_, owner) {
+        return new RelationFindOperation('find', {
+            relation: this,
+            owner,
+        });
+    }
+    insert(_, owner) {
+        /* istanbul ignore next */
+        throw this.createError('not implemented');
+    }
+    update(_, owner) {
+        return new RelationUpdateOperation('update', {
+            relation: this,
+            owner,
+        });
+    }
+    patch(_, owner) {
+        return new RelationUpdateOperation('patch', {
+            relation: this,
+            owner,
+            modelOptions: { patch: true },
+        });
+    }
+    delete(_, owner) {
+        return new RelationDeleteOperation('delete', {
+            relation: this,
+            owner,
+        });
+    }
+    relate() {
+        /* istanbul ignore next */
+        throw this.createError('not implemented');
+    }
+    unrelate() {
+        /* istanbul ignore next */
+        throw this.createError('not implemented');
+    }
+    hasRelateProp(model) {
+        return model.$hasProps(this.relatedProp.props);
+    }
+    setRelateProp(model, values) {
+        this.relatedProp.forEach((i) => {
+            this.relatedProp.setProp(model, i, values[i]);
+        });
+    }
+    executeBeforeInsert(models, queryContext, result) {
+        return mapAfterAllReturn(models, (model) => this.beforeInsert(model, queryContext), result);
+    }
+    createError(message) {
+        if (this.ownerModelClass && this.ownerModelClass.name && this.name) {
+            return new Error(`${this.ownerModelClass.name}.relationMappings.${this.name}: ${message}`);
+        }
+        else {
+            return new Error(`${this.constructor.name}: ${message}`);
+        }
+    }
 }
-
 Object.defineProperties(Relation, {
-  isObjectionRelationClass: {
-    enumerable: false,
-    writable: false,
-    value: true,
-  },
+    isObjectionRelationClass: {
+        enumerable: false,
+        writable: false,
+        value: true,
+    },
 });
-
 Object.defineProperties(Relation.prototype, {
-  isObjectionRelation: {
-    enumerable: false,
-    writable: false,
-    value: true,
-  },
+    isObjectionRelation: {
+        enumerable: false,
+        writable: false,
+        value: true,
+    },
 });
-
 function checkForbiddenProperties(ctx) {
-  ctx.forbiddenMappingProperties.forEach((prop) => {
-    if (get(ctx.mapping, prop.split('.')) !== undefined) {
-      throw ctx.createError(`Property ${prop} is not supported for this relation type.`);
-    }
-  });
-
-  return ctx;
+    ctx.forbiddenMappingProperties.forEach((prop) => {
+        if (get(ctx.mapping, prop.split('.')) !== undefined) {
+            throw ctx.createError(`Property ${prop} is not supported for this relation type.`);
+        }
+    });
+    return ctx;
 }
-
 function checkOwnerModelClass(ctx) {
-  if (!isFunction(ctx.ownerModelClass) || !ctx.ownerModelClass.isObjectionModelClass) {
-    throw ctx.createError(`Relation's owner is not a subclass of Model`);
-  }
-
-  return ctx;
+    if (!isFunction(ctx.ownerModelClass) || !ctx.ownerModelClass.isObjectionModelClass) {
+        throw ctx.createError(`Relation's owner is not a subclass of Model`);
+    }
+    return ctx;
 }
-
 function checkRelatedModelClass(ctx) {
-  if (!ctx.mapping.modelClass) {
-    throw ctx.createError('modelClass is not defined');
-  }
-
-  return ctx;
+    if (!ctx.mapping.modelClass) {
+        throw ctx.createError('modelClass is not defined');
+    }
+    return ctx;
 }
-
 function resolveRelatedModelClass(ctx) {
-  let relatedModelClass;
-
-  try {
-    relatedModelClass = resolveModel(
-      ctx.mapping.modelClass,
-      ctx.ownerModelClass.modelPaths,
-      'modelClass',
-    );
-  } catch (err) {
-    throw ctx.createError(err.message);
-  }
-
-  return Object.assign(ctx, { relatedModelClass });
+    let relatedModelClass;
+    try {
+        relatedModelClass = resolveModel(ctx.mapping.modelClass, ctx.ownerModelClass.modelPaths, 'modelClass');
+    }
+    catch (err) {
+        throw ctx.createError(err.message);
+    }
+    return Object.assign(ctx, { relatedModelClass });
 }
-
 function checkRelation(ctx) {
-  if (!ctx.mapping.relation) {
-    throw ctx.createError('relation is not defined');
-  }
-
-  if (!isFunction(ctx.mapping.relation) || !ctx.mapping.relation.isObjectionRelationClass) {
-    throw ctx.createError('relation is not a subclass of Relation');
-  }
-
-  return ctx;
+    if (!ctx.mapping.relation) {
+        throw ctx.createError('relation is not defined');
+    }
+    if (!isFunction(ctx.mapping.relation) || !ctx.mapping.relation.isObjectionRelationClass) {
+        throw ctx.createError('relation is not a subclass of Relation');
+    }
+    return ctx;
 }
-
 function createJoinProperties(ctx) {
-  const mapping = ctx.mapping;
-
-  if (!mapping.join || !mapping.join.from || !mapping.join.to) {
-    throw ctx.createError(
-      'join must be an object that maps the columns of the related models together. For example: {from: "SomeTable.id", to: "SomeOtherTable.someModelId"}',
-    );
-  }
-
-  const fromProp = createRelationProperty(ctx, mapping.join.from, 'join.from');
-  const toProp = createRelationProperty(ctx, mapping.join.to, 'join.to');
-
-  let ownerProp;
-  let relatedProp;
-
-  if (fromProp.modelClass.getTableName() === ctx.ownerModelClass.getTableName()) {
-    ownerProp = fromProp;
-    relatedProp = toProp;
-  } else if (toProp.modelClass.getTableName() === ctx.ownerModelClass.getTableName()) {
-    ownerProp = toProp;
-    relatedProp = fromProp;
-  } else {
-    throw ctx.createError('join: either `from` or `to` must point to the owner model table.');
-  }
-
-  if (ownerProp.props.some((it) => it === ctx.name)) {
-    throw ctx.createError(
-      `join: relation name and join property '${ctx.name}' cannot have the same name. If you cannot change one or the other, you can use $parseDatabaseJson and $formatDatabaseJson methods to convert the column name.`,
-    );
-  }
-
-  if (relatedProp.modelClass.getTableName() !== ctx.relatedModelClass.getTableName()) {
-    throw ctx.createError('join: either `from` or `to` must point to the related model table.');
-  }
-
-  return Object.assign(ctx, { ownerProp, relatedProp });
+    const mapping = ctx.mapping;
+    if (!mapping.join || !mapping.join.from || !mapping.join.to) {
+        throw ctx.createError('join must be an object that maps the columns of the related models together. For example: {from: "SomeTable.id", to: "SomeOtherTable.someModelId"}');
+    }
+    const fromProp = createRelationProperty(ctx, mapping.join.from, 'join.from');
+    const toProp = createRelationProperty(ctx, mapping.join.to, 'join.to');
+    let ownerProp;
+    let relatedProp;
+    if (fromProp.modelClass.getTableName() === ctx.ownerModelClass.getTableName()) {
+        ownerProp = fromProp;
+        relatedProp = toProp;
+    }
+    else if (toProp.modelClass.getTableName() === ctx.ownerModelClass.getTableName()) {
+        ownerProp = toProp;
+        relatedProp = fromProp;
+    }
+    else {
+        throw ctx.createError('join: either `from` or `to` must point to the owner model table.');
+    }
+    if (ownerProp.props.some((it) => it === ctx.name)) {
+        throw ctx.createError(`join: relation name and join property '${ctx.name}' cannot have the same name. If you cannot change one or the other, you can use $parseDatabaseJson and $formatDatabaseJson methods to convert the column name.`);
+    }
+    if (relatedProp.modelClass.getTableName() !== ctx.relatedModelClass.getTableName()) {
+        throw ctx.createError('join: either `from` or `to` must point to the related model table.');
+    }
+    return Object.assign(ctx, { ownerProp, relatedProp });
 }
-
 function createRelationProperty(ctx, refString, propName) {
-  try {
-    return new RelationProperty(refString, (table) => {
-      return [ctx.ownerModelClass, ctx.relatedModelClass].find((it) => it.getTableName() === table);
-    });
-  } catch (err) {
-    if (err instanceof RelationProperty.ModelNotFoundError) {
-      throw ctx.createError(
-        `join: either \`from\` or \`to\` must point to the owner model table and the other one to the related table. It might be that specified table '${err.tableName}' is not correct`,
-      );
-    } else if (err instanceof RelationProperty.InvalidReferenceError) {
-      throw ctx.createError(
-        `${propName} must have format TableName.columnName. For example "SomeTable.id" or in case of composite key ["SomeTable.a", "SomeTable.b"].`,
-      );
-    } else {
-      throw err;
-    }
-  }
+    try {
+        return new RelationProperty(refString, (table) => {
+            return [ctx.ownerModelClass, ctx.relatedModelClass].find((it) => it.getTableName() === table);
+        });
+    }
+    catch (err) {
+        if (err instanceof RelationProperty.ModelNotFoundError) {
+            throw ctx.createError(`join: either \`from\` or \`to\` must point to the owner model table and the other one to the related table. It might be that specified table '${err.tableName}' is not correct`);
+        }
+        else if (err instanceof RelationProperty.InvalidReferenceError) {
+            throw ctx.createError(`${propName} must have format TableName.columnName. For example "SomeTable.id" or in case of composite key ["SomeTable.a", "SomeTable.b"].`);
+        }
+        else {
+            throw err;
+        }
+    }
 }
-
 function parseModify(ctx) {
-  const mapping = ctx.mapping;
-  const modifier = mapping.modify || mapping.filter;
-  const modify =
-    modifier &&
-    createModifier({
-      modifier,
-      modelClass: ctx.relatedModelClass,
-    });
-
-  return Object.assign(ctx, { modify });
+    const mapping = ctx.mapping;
+    const modifier = mapping.modify || mapping.filter;
+    const modify = modifier &&
+        createModifier({
+            modifier,
+            modelClass: ctx.relatedModelClass,
+        });
+    return Object.assign(ctx, { modify });
 }
-
 function parseBeforeInsert(ctx) {
-  let beforeInsert;
-
-  if (isFunction(ctx.mapping.beforeInsert)) {
-    beforeInsert = ctx.mapping.beforeInsert;
-  } else {
-    beforeInsert = (model) => model;
-  }
-
-  return Object.assign(ctx, { beforeInsert });
+    let beforeInsert;
+    if (isFunction(ctx.mapping.beforeInsert)) {
+        beforeInsert = ctx.mapping.beforeInsert;
+    }
+    else {
+        beforeInsert = (model) => model;
+    }
+    return Object.assign(ctx, { beforeInsert });
 }
-
 function aliasedTableName(tableName, alias) {
-  if (tableName === alias) {
-    return tableName;
-  } else {
-    return `${tableName} as ${alias}`;
-  }
+    if (tableName === alias) {
+        return tableName;
+    }
+    else {
+        return `${tableName} as ${alias}`;
+    }
 }
-
 module.exports = {
-  Relation,
+    Relation,
 };