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

package/lib/relations/RelationProperty.js

@@ -1,24 +1,22 @@
-'use strict';
-
-const { asArray, isObject, uniqBy, get, set } = require('../utils/objectUtils');
-const { ref: createRef } = require('../queryBuilder/ReferenceBuilder');
-const { propToStr, PROP_KEY_PREFIX } = require('../model/modelValues');
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelationProperty = void 0;
+const objectUtils_1 = require("../utils/objectUtils");
+const ReferenceBuilder_1 = require("../queryBuilder/ReferenceBuilder");
+const modelValues_1 = require("../model/modelValues");
 class ModelNotFoundError extends Error {
-  constructor(tableName) {
-    super();
-    this.name = this.constructor.name;
-    this.tableName = tableName;
-  }
+    constructor(tableName) {
+        super();
+        this.name = this.constructor.name;
+        this.tableName = tableName;
+    }
 }
-
 class InvalidReferenceError extends Error {
-  constructor() {
-    super();
-    this.name = this.constructor.name;
-  }
+    constructor() {
+        super();
+        this.name = this.constructor.name;
+    }
 }
-
 // A pair of these define how two tables are related to each other.
 // Both the owner and the related table have one of these.
 //
@@ -26,222 +24,187 @@ class InvalidReferenceError extends Error {
 // (composite key) a json column reference, an array of json column
 // references or any combination of the above.
 class RelationProperty {
-  // references must be a reference string like `Table.column:maybe.some.json[1].path`.
-  // or an array of such references (composite key).
-  //
-  // modelClassResolver must be a function that takes a table name
-  // and returns a model class.
-  constructor(references, modelClassResolver) {
-    const refs = createRefs(asArray(references));
-    const paths = createPaths(refs, modelClassResolver);
-    const modelClass = resolveModelClass(paths);
-
-    this._refs = refs.map((ref) => ref.model(modelClass));
-    this._modelClass = modelClass;
-    this._props = paths.map((it) => it.path[0]);
-    this._cols = refs.map((it) => it.column);
-    this._propGetters = paths.map((it) => createGetter(it.path));
-    this._propSetters = paths.map((it) => createSetter(it.path));
-    this._patchers = refs.map((it, i) => createPatcher(it, paths[i].path));
-  }
-
-  static get ModelNotFoundError() {
-    return ModelNotFoundError;
-  }
-
-  static get InvalidReferenceError() {
-    return InvalidReferenceError;
-  }
-
-  // The number of columns.
-  get size() {
-    return this._refs.length;
-  }
-
-  // The model class that owns the property.
-  get modelClass() {
-    return this._modelClass;
-  }
-
-  // An array of property names. Contains multiple values in case of composite key.
-  // This may be different from `cols` if the model class has some kind of conversion
-  // between database and "external" formats, for example a snake_case to camelCase
-  // conversion.
-  get props() {
-    return this._props;
-  }
-
-  // An array of column names. Contains multiple values in case of composite key.
-  // This may be different from `props` if the model class has some kind of conversion
-  // between database and "external" formats, for example a snake_case to camelCase
-  // conversion.
-  get cols() {
-    return this._cols;
-  }
-
-  forEach(callback) {
-    for (let i = 0, l = this.size; i < l; ++i) {
-      callback(i);
-    }
-  }
-
-  // Creates a concatenated string from the property values of the given object.
-  propKey(obj) {
-    const size = this.size;
-    let key = PROP_KEY_PREFIX;
-
-    for (let i = 0; i < size; ++i) {
-      key += propToStr(this.getProp(obj, i));
-
-      if (i !== size - 1) {
-        key += ',';
-      }
-    }
-
-    return key;
-  }
-
-  // Returns the property values of the given object as an array.
-  getProps(obj) {
-    const size = this.size;
-    const props = new Array(size);
-
-    for (let i = 0; i < size; ++i) {
-      props[i] = this.getProp(obj, i);
-    }
-
-    return props;
-  }
-
-  // Returns true if the given object has a non-null value in all properties.
-  hasProps(obj) {
-    const size = this.size;
-
-    for (let i = 0; i < size; ++i) {
-      const prop = this.getProp(obj, i);
-
-      if (prop === null || prop === undefined) {
-        return false;
-      }
-    }
-
-    return true;
-  }
-
-  // Returns the index:th property value of the given object.
-  getProp(obj, index) {
-    return this._propGetters[index](obj);
-  }
-
-  // Sets the index:th property value of the given object.
-  setProp(obj, index, value) {
-    return this._propSetters[index](obj, value);
-  }
-
-  // Returns an instance of ReferenceBuilder that points to the index:th
-  // value of a row.
-  ref(builder, index) {
-    const table = builder.tableRefFor(this.modelClass);
-
-    return this._refs[index].clone().table(table);
-  }
-
-  // Returns an array of reference builders. `ref(builder, i)` for each i.
-  refs(builder) {
-    const refs = new Array(this.size);
-
-    for (let i = 0, l = refs.length; i < l; ++i) {
-      refs[i] = this.ref(builder, i);
-    }
-
-    return refs;
-  }
-
-  // Appends an update operation for the index:th column into `patch` object.
-  patch(patch, index, value) {
-    return this._patchers[index](patch, value);
-  }
-
-  // String representation of this property's index:th column for logging.
-  propDescription(index) {
-    return this._refs[index].expression;
-  }
+    // references must be a reference string like `Table.column:maybe.some.json[1].path`.
+    // or an array of such references (composite key).
+    //
+    // modelClassResolver must be a function that takes a table name
+    // and returns a model class.
+    constructor(references, modelClassResolver) {
+        const refs = createRefs((0, objectUtils_1.asArray)(references));
+        const paths = createPaths(refs, modelClassResolver);
+        const modelClass = resolveModelClass(paths);
+        this._refs = refs.map((ref) => ref.model(modelClass));
+        this._modelClass = modelClass;
+        this._props = paths.map((it) => it.path[0]);
+        this._cols = refs.map((it) => it.column);
+        this._propGetters = paths.map((it) => createGetter(it.path));
+        this._propSetters = paths.map((it) => createSetter(it.path));
+        this._patchers = refs.map((it, i) => createPatcher(it, paths[i].path));
+    }
+    static get ModelNotFoundError() {
+        return ModelNotFoundError;
+    }
+    static get InvalidReferenceError() {
+        return InvalidReferenceError;
+    }
+    // The number of columns.
+    get size() {
+        return this._refs.length;
+    }
+    // The model class that owns the property.
+    get modelClass() {
+        return this._modelClass;
+    }
+    // An array of property names. Contains multiple values in case of composite key.
+    // This may be different from `cols` if the model class has some kind of conversion
+    // between database and "external" formats, for example a snake_case to camelCase
+    // conversion.
+    get props() {
+        return this._props;
+    }
+    // An array of column names. Contains multiple values in case of composite key.
+    // This may be different from `props` if the model class has some kind of conversion
+    // between database and "external" formats, for example a snake_case to camelCase
+    // conversion.
+    get cols() {
+        return this._cols;
+    }
+    forEach(callback) {
+        for (let i = 0, l = this.size; i < l; ++i) {
+            callback(i);
+        }
+    }
+    // Creates a concatenated string from the property values of the given object.
+    propKey(obj) {
+        const size = this.size;
+        let key = modelValues_1.PROP_KEY_PREFIX;
+        for (let i = 0; i < size; ++i) {
+            key += (0, modelValues_1.propToStr)(this.getProp(obj, i));
+            if (i !== size - 1) {
+                key += ',';
+            }
+        }
+        return key;
+    }
+    // Returns the property values of the given object as an array.
+    getProps(obj) {
+        const size = this.size;
+        const props = new Array(size);
+        for (let i = 0; i < size; ++i) {
+            props[i] = this.getProp(obj, i);
+        }
+        return props;
+    }
+    // Returns true if the given object has a non-null value in all properties.
+    hasProps(obj) {
+        const size = this.size;
+        for (let i = 0; i < size; ++i) {
+            const prop = this.getProp(obj, i);
+            if (prop === null || prop === undefined) {
+                return false;
+            }
+        }
+        return true;
+    }
+    // Returns the index:th property value of the given object.
+    getProp(obj, index) {
+        return this._propGetters[index](obj);
+    }
+    // Sets the index:th property value of the given object.
+    setProp(obj, index, value) {
+        return this._propSetters[index](obj, value);
+    }
+    // Returns an instance of ReferenceBuilder that points to the index:th
+    // value of a row.
+    ref(builder, index) {
+        const table = builder.tableRefFor(this.modelClass);
+        return this._refs[index].clone().table(table);
+    }
+    // Returns an array of reference builders. `ref(builder, i)` for each i.
+    refs(builder) {
+        const refs = new Array(this.size);
+        for (let i = 0, l = refs.length; i < l; ++i) {
+            refs[i] = this.ref(builder, i);
+        }
+        return refs;
+    }
+    // Appends an update operation for the index:th column into `patch` object.
+    patch(patch, index, value) {
+        return this._patchers[index](patch, value);
+    }
+    // String representation of this property's index:th column for logging.
+    propDescription(index) {
+        return this._refs[index].expression;
+    }
 }
-
+exports.RelationProperty = RelationProperty;
 function createRefs(refs) {
-  try {
-    return refs.map((it) => {
-      if (!isObject(it) || !it.isObjectionReferenceBuilder) {
-        return createRef(it);
-      } else {
-        return it;
-      }
-    });
-  } catch (err) {
-    throw new InvalidReferenceError();
-  }
+    try {
+        return refs.map((it) => {
+            if (!(0, objectUtils_1.isObject)(it) ||
+                !it.isObjectionReferenceBuilder) {
+                return (0, ReferenceBuilder_1.ref)(it);
+            }
+            else {
+                return it;
+            }
+        });
+    }
+    catch (err) {
+        throw new InvalidReferenceError();
+    }
 }
-
 function createPaths(refs, modelClassResolver) {
-  return refs.map((ref) => {
-    if (!ref.tableName) {
-      throw new InvalidReferenceError();
-    }
-
-    const modelClass = modelClassResolver(ref.tableName);
-
-    if (!modelClass) {
-      throw new ModelNotFoundError(ref.tableName);
-    }
-
-    const prop = modelClass.columnNameToPropertyName(ref.column);
-    const jsonPath = ref.parsedExpr.access.map((it) => it.ref);
-
-    return {
-      path: [prop].concat(jsonPath),
-      modelClass,
-    };
-  });
+    return refs.map((ref) => {
+        if (!ref.tableName) {
+            throw new InvalidReferenceError();
+        }
+        const modelClass = modelClassResolver(ref.tableName);
+        if (!modelClass) {
+            throw new ModelNotFoundError(ref.tableName);
+        }
+        const prop = modelClass.columnNameToPropertyName(ref.column);
+        // A ReferenceBuilder is only unparsed inside clone(), which copies the
+        // parsed expression right after.
+        const jsonPath = ref.parsedExpr.access.map((it) => it.ref);
+        return {
+            path: [prop].concat(jsonPath),
+            modelClass,
+        };
+    });
 }
-
 function resolveModelClass(paths) {
-  const modelClasses = paths.map((it) => it.modelClass);
-  const uniqueModelClasses = uniqBy(modelClasses);
-
-  if (uniqueModelClasses.length !== 1) {
-    throw new InvalidReferenceError();
-  }
-
-  return modelClasses[0];
+    const modelClasses = paths.map((it) => it.modelClass);
+    const uniqueModelClasses = (0, objectUtils_1.uniqBy)(modelClasses);
+    if (uniqueModelClasses.length !== 1) {
+        throw new InvalidReferenceError();
+    }
+    return modelClasses[0];
 }
-
 function createGetter(path) {
-  if (path.length === 1) {
-    const prop = path[0];
-    return (obj) => obj[prop];
-  } else {
-    return (obj) => get(obj, path);
-  }
+    if (path.length === 1) {
+        const prop = path[0];
+        return (obj) => obj[prop];
+    }
+    else {
+        return (obj) => (0, objectUtils_1.get)(obj, path);
+    }
 }
-
 function createSetter(path) {
-  if (path.length === 1) {
-    const prop = path[0];
-    return (obj, value) => (obj[prop] = value);
-  } else {
-    return (obj, value) => set(obj, path, value);
-  }
+    if (path.length === 1) {
+        const prop = path[0];
+        return (obj, value) => (obj[prop] = value);
+    }
+    else {
+        return (obj, value) => (0, objectUtils_1.set)(obj, path, value);
+    }
 }
-
 function createPatcher(ref, path) {
-  if (ref.isPlainColumnRef) {
-    return (patch, value) => (patch[path[0]] = value);
-  } else {
-    // Objection `patch`, `update` etc. methods understand field expressions.
-    return (patch, value) => (patch[ref.expression] = value);
-  }
+    if (ref.isPlainColumnRef) {
+        return (patch, value) => (patch[path[0]] = value);
+    }
+    else {
+        // Objection `patch`, `update` etc. methods understand field expressions.
+        return (patch, value) => (patch[ref.expression] = value);
+    }
 }
-
-module.exports = {
-  RelationProperty,
-};

package/lib/relations/RelationUpdateOperation.js

@@ -1,30 +1,24 @@
-'use strict';
-
-const { UpdateOperation } = require('../queryBuilder/operations/UpdateOperation');
-const { RelationFindOperation } = require('./RelationFindOperation');
-
-class RelationUpdateOperation extends UpdateOperation {
-  constructor(name, opt) {
-    super(name, opt);
-
-    this.relation = opt.relation;
-    this.owner = opt.owner;
-  }
-
-  onBuild(builder) {
-    super.onBuild(builder);
-
-    this.relation.findQuery(builder, this.owner);
-  }
-
-  toFindOperation() {
-    return new RelationFindOperation('find', {
-      relation: this.relation,
-      owner: this.owner,
-    });
-  }
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RelationUpdateOperation = void 0;
+const UpdateOperation_1 = require("../queryBuilder/operations/UpdateOperation");
+const RelationFindOperation_1 = require("./RelationFindOperation");
+class RelationUpdateOperation extends UpdateOperation_1.UpdateOperation {
+    constructor(name, opt) {
+        super(name, opt);
+        this.relation = opt.relation;
+        this.owner = opt.owner;
+    }
+    onBuild(builder) {
+        super.onBuild(builder);
+        this.relation.findQuery(builder, this.owner);
+    }
+    // @ts-expect-error The JavaScript base class's toFindOperation() is inferred to return null.
+    toFindOperation() {
+        return new RelationFindOperation_1.RelationFindOperation('find', {
+            relation: this.relation,
+            owner: this.owner,
+        });
+    }
 }
-
-module.exports = {
-  RelationUpdateOperation,
-};
+exports.RelationUpdateOperation = RelationUpdateOperation;

package/lib/relations/belongsToOne/BelongsToOneDeleteOperation.js

@@ -1,23 +1,18 @@
-'use strict';
-
-const { RelationDeleteOperation } = require('../RelationDeleteOperation');
-
-class BelongsToOneDeleteOperation extends RelationDeleteOperation {
-  onAfter1(_, result) {
-    if (this.owner.isModels) {
-      const ownerProp = this.relation.ownerProp;
-
-      for (const owner of this.owner.modelArray) {
-        ownerProp.forEach((i) => {
-          ownerProp.setProp(owner, i, null);
-        });
-      }
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BelongsToOneDeleteOperation = void 0;
+const RelationDeleteOperation_1 = require("../RelationDeleteOperation");
+class BelongsToOneDeleteOperation extends RelationDeleteOperation_1.RelationDeleteOperation {
+    onAfter1(_, result) {
+        if (this.owner.isModels) {
+            const ownerProp = this.relation.ownerProp;
+            for (const owner of this.owner.modelArray) {
+                ownerProp.forEach((i) => {
+                    ownerProp.setProp(owner, i, null);
+                });
+            }
+        }
+        return result;
     }
-
-    return result;
-  }
 }
-
-module.exports = {
-  BelongsToOneDeleteOperation,
-};
+exports.BelongsToOneDeleteOperation = BelongsToOneDeleteOperation;

package/lib/relations/belongsToOne/BelongsToOneInsertOperation.js

@@ -1,44 +1,33 @@
-'use strict';
-
-const { RelationInsertOperation } = require('../RelationInsertOperation');
-const { BelongsToOneRelateOperation } = require('./BelongsToOneRelateOperation');
-
-class BelongsToOneInsertOperation extends RelationInsertOperation {
-  onAdd(builder, args) {
-    const retVal = super.onAdd(builder, args);
-
-    if (this.models.length > 1) {
-      throw this.relation.createError('can only insert one model to a BelongsToOneRelation');
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BelongsToOneInsertOperation = void 0;
+const RelationInsertOperation_1 = require("../RelationInsertOperation");
+const BelongsToOneRelateOperation_1 = require("./BelongsToOneRelateOperation");
+class BelongsToOneInsertOperation extends RelationInsertOperation_1.RelationInsertOperation {
+    onAdd(builder, args) {
+        const retVal = super.onAdd(builder, args);
+        if (this.models.length > 1) {
+            throw this.relation.createError('can only insert one model to a BelongsToOneRelation');
+        }
+        return retVal;
     }
-
-    return retVal;
-  }
-
-  async onAfter1(builder, ret) {
-    const inserted = await super.onAfter1(builder, ret);
-
-    if (!builder.isExecutable()) {
-      return inserted;
+    async onAfter1(builder, ret) {
+        const inserted = await super.onAfter1(builder, ret);
+        if (!builder.isExecutable()) {
+            return inserted;
+        }
+        const relateOp = new BelongsToOneRelateOperation_1.BelongsToOneRelateOperation('relate', {
+            relation: this.relation,
+            owner: this.owner,
+        });
+        if (this.assignResultToOwner && this.owner.isModels) {
+            for (const owner of this.owner.modelArray) {
+                owner.$setRelated(this.relation, inserted);
+            }
+        }
+        relateOp.onAdd(builder, [inserted]);
+        await relateOp.queryExecutor(builder);
+        return inserted;
     }
-
-    const relateOp = new BelongsToOneRelateOperation('relate', {
-      relation: this.relation,
-      owner: this.owner,
-    });
-
-    if (this.assignResultToOwner && this.owner.isModels) {
-      for (const owner of this.owner.modelArray) {
-        owner.$setRelated(this.relation, inserted);
-      }
-    }
-
-    relateOp.onAdd(builder, [inserted]);
-    await relateOp.queryExecutor(builder);
-
-    return inserted;
-  }
 }
-
-module.exports = {
-  BelongsToOneInsertOperation,
-};
+exports.BelongsToOneInsertOperation = BelongsToOneInsertOperation;