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

package/lib/model/modelTableMetadata.js

@@ -1,83 +1,71 @@
 'use strict';
-
 const { defineNonEnumerableProperty } = require('./modelUtils');
 const { isPromise } = require('../utils/promiseUtils');
-
 const TABLE_METADATA = '$$tableMetadata';
-
-function fetchTableMetadata(
-  modelClass,
-  { 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.
-  if (!table) {
-    if (parentBuilder) {
-      table = parentBuilder.tableNameFor(modelClass);
-    } else {
-      table = modelClass.getTableName();
+function fetchTableMetadata(modelClass, { 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.
+    if (!table) {
+        if (parentBuilder) {
+            table = parentBuilder.tableNameFor(modelClass);
+        }
+        else {
+            table = modelClass.getTableName();
+        }
+    }
+    // Call tableMetadata first instead of accessing the cache directly beause
+    // tableMetadata may have been overriden.
+    let metadata = modelClass.tableMetadata({ table });
+    if (!force && metadata) {
+        return Promise.resolve(metadata);
+    }
+    // Memoize metadata but only for modelClass. The hasOwnProperty check
+    // will fail for subclasses and the value gets recreated.
+    if (!Object.hasOwn(modelClass, TABLE_METADATA)) {
+        defineNonEnumerableProperty(modelClass, TABLE_METADATA, new Map());
+    }
+    // The cache needs to be checked in addition to calling tableMetadata
+    // because the cache may contain a temporary promise in which case
+    // tableMetadata returns null.
+    metadata = modelClass[TABLE_METADATA].get(table);
+    if (!force && metadata) {
+        return Promise.resolve(metadata);
+    }
+    else {
+        const promise = modelClass
+            .query(knex)
+            .childQueryOf(parentBuilder)
+            .columnInfo({ table })
+            .then((columnInfo) => {
+            const metadata = {
+                columns: Object.keys(columnInfo),
+            };
+            modelClass[TABLE_METADATA].set(table, metadata);
+            return metadata;
+        })
+            .catch((err) => {
+            modelClass[TABLE_METADATA].delete(table);
+            throw err;
+        });
+        modelClass[TABLE_METADATA].set(table, promise);
+        return promise;
     }
-  }
-
-  // Call tableMetadata first instead of accessing the cache directly beause
-  // tableMetadata may have been overriden.
-  let metadata = modelClass.tableMetadata({ table });
-
-  if (!force && metadata) {
-    return Promise.resolve(metadata);
-  }
-
-  // Memoize metadata but only for modelClass. The hasOwnProperty check
-  // will fail for subclasses and the value gets recreated.
-  if (!modelClass.hasOwnProperty(TABLE_METADATA)) {
-    defineNonEnumerableProperty(modelClass, TABLE_METADATA, new Map());
-  }
-
-  // The cache needs to be checked in addition to calling tableMetadata
-  // because the cache may contain a temporary promise in which case
-  // tableMetadata returns null.
-  metadata = modelClass[TABLE_METADATA].get(table);
-
-  if (!force && metadata) {
-    return Promise.resolve(metadata);
-  } else {
-    const promise = modelClass
-      .query(knex)
-      .childQueryOf(parentBuilder)
-      .columnInfo({ table })
-      .then((columnInfo) => {
-        const metadata = {
-          columns: Object.keys(columnInfo),
-        };
-
-        modelClass[TABLE_METADATA].set(table, metadata);
-        return metadata;
-      })
-      .catch((err) => {
-        modelClass[TABLE_METADATA].delete(table);
-        throw err;
-      });
-
-    modelClass[TABLE_METADATA].set(table, promise);
-    return promise;
-  }
 }
-
 function tableMetadata(modelClass, { table } = {}) {
-  if (modelClass.hasOwnProperty(TABLE_METADATA)) {
-    const metadata = modelClass[TABLE_METADATA].get(table || modelClass.getTableName());
-
-    if (isPromise(metadata)) {
-      return null;
-    } else {
-      return metadata;
+    if (Object.hasOwn(modelClass, TABLE_METADATA)) {
+        const metadata = modelClass[TABLE_METADATA].get(table || modelClass.getTableName());
+        if (isPromise(metadata)) {
+            return null;
+        }
+        else {
+            return metadata;
+        }
+    }
+    else {
+        return null;
     }
-  } else {
-    return null;
-  }
 }
-
 module.exports = {
-  fetchTableMetadata,
-  tableMetadata,
+    fetchTableMetadata,
+    tableMetadata,
 };

package/lib/model/modelToJson.js

@@ -1,187 +1,157 @@
 'use strict';
-
 const { isInternalProp } = require('../utils/internalPropUtils');
 const { mergeQueryProps } = require('./modelQueryProps');
 const { isObject, cloneDeep, isFunction } = require('../utils/objectUtils');
 const EMPTY_ARRAY = [];
-
 function toJson(model, optIn) {
-  const modelClass = model.constructor;
-
-  const opt = {
-    virtuals: getVirtuals(optIn),
-    shallow: isShallow(optIn),
-    omit: getOmit(optIn, modelClass),
-    pick: null,
-    omitFromJson: model.$omitFromJson() || null,
-    cloneObjects: modelClass.cloneObjectAttributes,
-  };
-
-  let json = toExternalJsonImpl(model, opt);
-  json = model.$formatJson(json);
-
-  return json;
+    const modelClass = model.constructor;
+    const opt = {
+        virtuals: getVirtuals(optIn),
+        shallow: isShallow(optIn),
+        omit: getOmit(optIn, modelClass),
+        pick: null,
+        omitFromJson: model.$omitFromJson() || null,
+        cloneObjects: modelClass.cloneObjectAttributes,
+    };
+    let json = toExternalJsonImpl(model, opt);
+    json = model.$formatJson(json);
+    return json;
 }
-
 function toDatabaseJson(model, builder) {
-  const modelClass = model.constructor;
-
-  const opt = {
-    virtuals: false,
-    shallow: true,
-    omit: modelClass.getRelationNames(),
-    pick: getPick(modelClass),
-    omitFromJson: model.$omitFromDatabaseJson() || null,
-    cloneObjects: modelClass.cloneObjectAttributes,
-  };
-
-  let json = toDatabaseJsonImpl(model, opt);
-  json = model.$formatDatabaseJson(json);
-
-  return mergeQueryProps(model, json, opt.omitFromJson, builder);
+    const modelClass = model.constructor;
+    const opt = {
+        virtuals: false,
+        shallow: true,
+        omit: modelClass.getRelationNames(),
+        pick: getPick(modelClass),
+        omitFromJson: model.$omitFromDatabaseJson() || null,
+        cloneObjects: modelClass.cloneObjectAttributes,
+    };
+    let json = toDatabaseJsonImpl(model, opt);
+    json = model.$formatDatabaseJson(json);
+    return mergeQueryProps(model, json, opt.omitFromJson, builder);
 }
-
 function getVirtuals(opt) {
-  if (!opt) {
-    return true;
-  } else if (Array.isArray(opt.virtuals)) {
-    return opt.virtuals;
-  } else {
-    return opt.virtuals !== false;
-  }
+    if (!opt) {
+        return true;
+    }
+    else if (Array.isArray(opt.virtuals)) {
+        return opt.virtuals;
+    }
+    else {
+        return opt.virtuals !== false;
+    }
 }
-
 function isShallow(opt) {
-  return !!opt && !!opt.shallow;
+    return !!opt && !!opt.shallow;
 }
-
 function getOmit(opt, modelClass) {
-  return isShallow(opt) ? modelClass.getRelationNames() : null;
+    return isShallow(opt) ? modelClass.getRelationNames() : null;
 }
-
 function getPick(modelClass) {
-  const jsonSchema = modelClass.getJsonSchema();
-  return (jsonSchema && modelClass.pickJsonSchemaProperties && jsonSchema.properties) || null;
+    const jsonSchema = modelClass.getJsonSchema();
+    return (jsonSchema && modelClass.pickJsonSchemaProperties && jsonSchema.properties) || null;
 }
-
 function toExternalJsonImpl(model, opt) {
-  const json = {};
-  const keys = Object.keys(model);
-  const vAttr = getVirtualAttributes(model, opt);
-
-  for (let i = 0, l = keys.length; i < l; ++i) {
-    const key = keys[i];
-    const value = model[key];
-
-    assignJsonValue(json, key, value, opt);
-  }
-
-  if (vAttr.length !== 0) {
-    assignVirtualAttributes(json, model, vAttr, opt);
-  }
-
-  return json;
+    const json = {};
+    const keys = Object.keys(model);
+    const vAttr = getVirtualAttributes(model, opt);
+    for (let i = 0, l = keys.length; i < l; ++i) {
+        const key = keys[i];
+        const value = model[key];
+        assignJsonValue(json, key, value, opt);
+    }
+    if (vAttr.length !== 0) {
+        assignVirtualAttributes(json, model, vAttr, opt);
+    }
+    return json;
 }
-
 function getVirtualAttributes(model, opt) {
-  if (Array.isArray(opt.virtuals)) {
-    return opt.virtuals;
-  } else if (opt.virtuals === true) {
-    return model.constructor.getVirtualAttributes();
-  } else {
-    return EMPTY_ARRAY;
-  }
+    if (Array.isArray(opt.virtuals)) {
+        return opt.virtuals;
+    }
+    else if (opt.virtuals === true) {
+        return model.constructor.getVirtualAttributes();
+    }
+    else {
+        return EMPTY_ARRAY;
+    }
 }
-
 function toDatabaseJsonImpl(model, opt) {
-  const json = {};
-  const keys = Object.keys(model);
-
-  for (let i = 0, l = keys.length; i < l; ++i) {
-    const key = keys[i];
-    const value = model[key];
-
-    assignJsonValue(json, key, value, opt);
-  }
-
-  return json;
+    const json = {};
+    const keys = Object.keys(model);
+    for (let i = 0, l = keys.length; i < l; ++i) {
+        const key = keys[i];
+        const value = model[key];
+        assignJsonValue(json, key, value, opt);
+    }
+    return json;
 }
-
 function assignJsonValue(json, key, value, opt) {
-  const type = typeof value;
-
-  if (
-    type !== 'function' &&
-    type !== 'undefined' &&
-    !isInternalProp(key) &&
-    !shouldOmit(opt, key) &&
-    shouldPick(opt, key)
-  ) {
-    if (isObject(value)) {
-      json[key] = toJsonObject(value, opt);
-    } else {
-      json[key] = value;
-    }
-  }
+    const type = typeof value;
+    if (type !== 'function' &&
+        type !== 'undefined' &&
+        !isInternalProp(key) &&
+        !shouldOmit(opt, key) &&
+        shouldPick(opt, key)) {
+        if (isObject(value)) {
+            json[key] = toJsonObject(value, opt);
+        }
+        else {
+            json[key] = value;
+        }
+    }
 }
-
 function shouldOmit(opt, key) {
-  return (
-    (opt.omit !== null && opt.omit.includes(key)) ||
-    (opt.omitFromJson !== null && opt.omitFromJson.includes(key))
-  );
+    return ((opt.omit !== null && opt.omit.includes(key)) ||
+        (opt.omitFromJson !== null && opt.omitFromJson.includes(key)));
 }
-
 function shouldPick(opt, key) {
-  return opt.pick === null || key in opt.pick;
+    return opt.pick === null || key in opt.pick;
 }
-
 function assignVirtualAttributes(json, model, vAttr, opt) {
-  for (let i = 0, l = vAttr.length; i < l; ++i) {
-    const key = vAttr[i];
-    let value = model[key];
-
-    if (isFunction(value)) {
-      value = value.call(model);
-    }
-
-    assignJsonValue(json, key, value, opt);
-  }
+    for (let i = 0, l = vAttr.length; i < l; ++i) {
+        const key = vAttr[i];
+        let value = model[key];
+        if (isFunction(value)) {
+            value = value.call(model);
+        }
+        assignJsonValue(json, key, value, opt);
+    }
 }
-
 function toJsonObject(value, opt) {
-  if (Array.isArray(value)) {
-    return toJsonArray(value, opt);
-  } else if (value.$isObjectionModel) {
-    // No branch for $toDatabaseJson here since there is never a need
-    // to have nested models in database rows.
-    return value.$toJson(opt);
-  } else if (Buffer.isBuffer(value)) {
-    return value;
-  } else if (opt.cloneObjects) {
-    return cloneDeep(value);
-  } else {
-    return value;
-  }
+    if (Array.isArray(value)) {
+        return toJsonArray(value, opt);
+    }
+    else if (value.$isObjectionModel) {
+        // No branch for $toDatabaseJson here since there is never a need
+        // to have nested models in database rows.
+        return value.$toJson(opt);
+    }
+    else if (Buffer.isBuffer(value)) {
+        return value;
+    }
+    else if (opt.cloneObjects) {
+        return cloneDeep(value);
+    }
+    else {
+        return value;
+    }
 }
-
 function toJsonArray(value, opt) {
-  const ret = new Array(value.length);
-
-  for (let i = 0, l = ret.length; i < l; ++i) {
-    const item = value[i];
-
-    if (isObject(item)) {
-      ret[i] = toJsonObject(item, opt);
-    } else {
-      ret[i] = item;
-    }
-  }
-
-  return ret;
+    const ret = new Array(value.length);
+    for (let i = 0, l = ret.length; i < l; ++i) {
+        const item = value[i];
+        if (isObject(item)) {
+            ret[i] = toJsonObject(item, opt);
+        }
+        else {
+            ret[i] = item;
+        }
+    }
+    return ret;
 }
-
 module.exports = {
-  toJson,
-  toDatabaseJson,
+    toJson,
+    toDatabaseJson,
 };

package/lib/model/modelUtils.js

@@ -1,47 +1,40 @@
 'use strict';
-
 const hiddenProps = ['$$queryProps'];
-
 const staticHiddenProps = [
-  '$$knex',
-  '$$validator',
-  '$$jsonSchema',
-  '$$colToProp',
-  '$$propToCol',
-  '$$relationMappings',
-  '$$relations',
-  '$$relationNames',
-  '$$jsonAttributes',
-  '$$columnNameMappers',
-  '$$tableMetadata',
-  '$$readOnlyAttributes',
-  '$$idRelationProperty',
-  '$$virtualAttributes',
+    '$$knex',
+    '$$validator',
+    '$$jsonSchema',
+    '$$colToProp',
+    '$$propToCol',
+    '$$relationMappings',
+    '$$relations',
+    '$$relationNames',
+    '$$jsonAttributes',
+    '$$columnNameMappers',
+    '$$tableMetadata',
+    '$$readOnlyAttributes',
+    '$$idRelationProperty',
+    '$$virtualAttributes',
 ];
-
 function defineNonEnumerableProperty(obj, prop, value) {
-  Object.defineProperty(obj, prop, {
-    enumerable: false,
-    writable: true,
-    configurable: true,
-    value,
-  });
+    Object.defineProperty(obj, prop, {
+        enumerable: false,
+        writable: true,
+        configurable: true,
+        value,
+    });
 }
-
 function keyByProps(models, props) {
-  const map = new Map();
-
-  for (let i = 0, l = models.length; i < l; ++i) {
-    const model = models[i];
-    map.set(model.$propKey(props), model);
-  }
-
-  return map;
+    const map = new Map();
+    for (let i = 0, l = models.length; i < l; ++i) {
+        const model = models[i];
+        map.set(model.$propKey(props), model);
+    }
+    return map;
 }
-
 module.exports = {
-  hiddenProps,
-  staticHiddenProps,
-  defineNonEnumerableProperty,
-  keyByProps,
+    hiddenProps,
+    staticHiddenProps,
+    defineNonEnumerableProperty,
+    keyByProps,
 };

package/lib/model/modelValidate.js

@@ -1,48 +1,40 @@
 'use strict';
-
 const { clone } = require('./modelClone');
-
 function validate(model, json, options = {}) {
-  json = json || model;
-
-  const inputJson = json;
-  const validatingModelInstance = inputJson && inputJson.$isObjectionModel;
-
-  if (options.skipValidation) {
-    return json;
-  }
-
-  if (validatingModelInstance) {
-    // Strip away relations and other internal stuff.
-    // TODO 1: This should use `json.$toJson()` since we always validate the input representation!
-    // TODO 2: This should also keep the relations in the object because some validators may
-    //         depend on the relations.
-    json = clone(json, true, true);
-    // We can mutate `json` now that we took a copy of it.
-    options = Object.assign({}, options, { mutable: true });
-  }
-
-  const modelClass = model.constructor;
-  const validator = modelClass.getValidator();
-  const args = {
-    options,
-    model,
-    json,
-    ctx: Object.create(null),
-  };
-
-  validator.beforeValidate(args);
-  json = validator.validate(args);
-  validator.afterValidate(args);
-
-  if (validatingModelInstance) {
-    // If we cloned `json`, we need to copy the possible default values.
-    return inputJson.$set(json);
-  } else {
-    return json;
-  }
+    json = json || model;
+    const inputJson = json;
+    const validatingModelInstance = inputJson && inputJson.$isObjectionModel;
+    if (options.skipValidation) {
+        return json;
+    }
+    if (validatingModelInstance) {
+        // Strip away relations and other internal stuff.
+        // TODO 1: This should use `json.$toJson()` since we always validate the input representation!
+        // TODO 2: This should also keep the relations in the object because some validators may
+        //         depend on the relations.
+        json = clone(json, true, true);
+        // We can mutate `json` now that we took a copy of it.
+        options = Object.assign({}, options, { mutable: true });
+    }
+    const modelClass = model.constructor;
+    const validator = modelClass.getValidator();
+    const args = {
+        options,
+        model,
+        json,
+        ctx: Object.create(null),
+    };
+    validator.beforeValidate(args);
+    json = validator.validate(args);
+    validator.afterValidate(args);
+    if (validatingModelInstance) {
+        // If we cloned `json`, we need to copy the possible default values.
+        return inputJson.$set(json);
+    }
+    else {
+        return json;
+    }
 }
-
 module.exports = {
-  validate,
+    validate,
 };