leoric 2.0.1 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "leoric",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "JavaScript Object-relational mapping alchemy",
   "main": "index.js",
   "types": "types/index.d.ts",

package/src/adapters/sequelize.js

@@ -238,9 +238,6 @@ module.exports = Bone => {
     }
 
     static build(values, options = {}) {
-      if (options.validate !== false) {
-        this._validateAttributes(values);
-      }
       const { raw } = Object.assign({ raw: false, isNewRecord: true }, options);
       const { attributes } = this;
 
@@ -256,9 +253,21 @@ module.exports = Bone => {
       } else {
         instance = new this(values, options);
       }
+
       return instance;
     }
 
+    /**
+     * see https://github.com/sequelize/sequelize/blob/a729c4df41fa3a58fbecaf879265d2fb73d80e5f/src/model.js#L2299
+     * @param {Array<Object>} valueSets 
+     * @param {Object} options 
+     * @returns 
+     */
+    static bulkBuild(valueSets, options = {}) {
+      if (!valueSets.length) return [];
+      return valueSets.map(value => this.build(value, options));
+    }
+
     // EXISTS
     // static bulkCreate() {}
 
@@ -310,7 +319,9 @@ module.exports = Bone => {
     // proxy to class.destroy({ individualHooks=false }) see https://github.com/sequelize/sequelize/blob/4063c2ab627ad57919d5b45cc7755f077a69fa5e/lib/model.js#L2895  before(after)BulkDestroy
     static async bulkDestroy(options = {}) {
       const { where, force } = options;
-      return await this.remove(where || {}, force, { ...options });
+      const spell = this._remove(where || {}, force, { ...options });
+      translateOptions(spell, options);
+      return spell;
     }
 
     // EXISTS
@@ -469,6 +480,7 @@ module.exports = Bone => {
       const { where, paranoid, individualHooks } = options;
       if (individualHooks) {
         let findSpell = this._find(where, options);
+        translateOptions(findSpell, options);
         if (paranoid === false) findSpell = findSpell.unparanoid;
         const instances = await findSpell;
         if (instances.length) {
@@ -484,6 +496,7 @@ module.exports = Bone => {
       const { where, paranoid = false, validate } = options;
       const whereConditions = where || {};
       const spell = super.update(whereConditions, values, { validate, hooks: false, ...options });
+      translateOptions(spell, options);
       if (!paranoid) return spell.unparanoid;
       return spell;
     }

package/src/bone.js

@@ -15,6 +15,7 @@ const Raw = require('./raw');
 const { capitalize, camelCase, snakeCase } = require('./utils/string');
 const { hookNames, setupSingleHook } = require('./setup_hooks');
 const { logger } = require('./utils/index');
+const { TIMESTAMP_NAMES, LEGACY_TIMESTAMP_COLUMN_MAP } = require('./constants');
 
 function looseReadonly(props) {
   return Object.keys(props).reduce((result, name) => {
@@ -76,6 +77,23 @@ function copyValues(values) {
   return copyValue;
 }
 
+function valuesValidate(values, attributes, ctx) {
+  for (const valueKey in values) {
+    const attribute = attributes[valueKey];
+    if (!attribute) continue;
+    const { validate = {}, name, allowNull, defaultValue } = attribute;
+    const value = values[valueKey];
+    if (value == null && defaultValue == null) {
+      if (allowNull === false) throw new LeoricValidateError('notNull', name);
+      if ((allowNull === true || allowNull === undefined) && validate.notNull === undefined ) continue;
+    }
+    if (!validate) continue;
+    for (const key in validate) {
+      if (validate.hasOwnProperty(key)) executeValidator(ctx, key, attribute, value);
+    }
+  }
+}
+
 /**
  * The base class that provides Object-relational mapping. This class is never intended to be used directly. We need to create models that extends from Bone. Most of the query features of Bone is implemented by {@link Spell} such as {@link Spell#$group} and {@link Spell#$join}. With Bone, you can create models like this:
  *
@@ -134,7 +152,6 @@ class Bone {
     }
   }
 
-
   /**
    * Get or set attribute value by name. This method is quite similiar to `jQuery.attr()`. If the attribute isn't selected when queried from database, an error will be thrown when accessing it.
    *
@@ -280,21 +297,7 @@ class Bone {
 
     // merge all changed values
     changedValues = Object.assign(changedValues, values);
-
-    for (const valueKey in changedValues) {
-      const attribute = attributes[valueKey];
-      if (!attribute) continue;
-      const { validate = {}, name, allowNull, defaultValue } = attribute;
-      const value = changedValues[valueKey];
-      if (value == null && defaultValue == null) {
-        if (allowNull === false) throw new LeoricValidateError('notNull', name);
-        if ((allowNull === true || allowNull === undefined) && validate.notNull === undefined ) return;
-      }
-      if (!validate) return;
-      for (const key in validate) {
-        if (validate.hasOwnProperty(key)) executeValidator(this, key, attribute, value);
-      }
-    }
+    valuesValidate(changedValues, attributes, this);
   }
 
   /**
@@ -306,22 +309,7 @@ class Bone {
    */
   static _validateAttributes(values = {}) {
     const { attributes } = this;
-    for (const valueKey in values) {
-      const attribute = attributes[valueKey];
-      // If valueKey is not an attribute of the Model, go to the next loop instead of throw 'No Such Attribute' Error,
-      // in case it is a custom property of the Model which defined by custom setters/getters.
-      if (!attribute) return;
-      const { validate = {}, name, allowNull, defaultValue } = attribute;
-      const value = values[valueKey];
-      if (value == null && defaultValue == null) {
-        if (allowNull === false) throw new LeoricValidateError('notNull', name);
-        if ((allowNull === true || allowNull === undefined) && validate.notNull === undefined) return;
-      }
-      if (!validate) return;
-      for (const key in validate) {
-        if (validate.hasOwnProperty(key)) executeValidator(this, key, attribute, value);
-      }
-    }
+    valuesValidate(values, attributes, this);
   }
 
   /**
@@ -722,9 +710,10 @@ class Bone {
     }
 
     if (attributes[updatedAt] && !this[updatedAt]) {
-      this[updatedAt] = this[createdAt];
+      this[updatedAt] = this[createdAt] || new Date();
     }
 
+    const validateValues = {};
     for (const name in attributes) {
       const value = this.attribute(name);
       const { defaultValue } = attributes[name];
@@ -733,10 +722,12 @@ class Bone {
       } else if (value === undefined && defaultValue != null) {
         data[name] = defaultValue;
       }
+      if (attributes[name].primaryKey) continue;
+      validateValues[name] = data[name];
     }
 
     if (opts.validate !== false) {
-      this._validateAttributes();
+      this._validateAttributes(validateValues);
     }
 
     const spell = new Spell(Model, opts).$insert(data);
@@ -798,7 +789,7 @@ class Bone {
       }, opts);
       return result;
     }
-    return await Model.remove(condition, forceDelete, { hooks: false, ...opts });
+    return await Model._remove(condition, forceDelete, opts);
   }
 
   /**
@@ -822,10 +813,10 @@ class Bone {
 
     const conditions = {
       [primaryKey]: this[primaryKey],
-      deletedAt: { $ne: null },
+      [deletedAt]: { $ne: null },
     };
     if (shardingKey) conditions[shardingKey] = this[shardingKey];
-    await this.update({ deletedAt: null }, { ...opts, paranoid: false });
+    await this.update({ [deletedAt]: null }, { ...opts, paranoid: false });
     return this;
   }
 
@@ -840,7 +831,7 @@ class Bone {
     if (deletedAt == null) {
       throw new Error('Model is not paranoid');
     }
-    return Bone.update.call(this, conditions, { deletedAt: null }, { ...opts, paranoid: false });
+    return Bone.update.call(this, conditions, { [deletedAt]: null }, { ...opts, paranoid: false });
   }
 
   /**
@@ -855,9 +846,13 @@ class Bone {
     const data = {};
     const Model = this;
     const { attributes } = Model;
-    for (const name in values) {
-      if (this.hasAttribute(name)) {
-        data[name] = values[name];
+    for (const key in attributes) {
+      const attribute = attributes[key];
+      if (attribute.primaryKey) continue;
+      if (values[key] == null && attribute.defaultValue != null) {
+        data[key] = attribute.defaultValue;
+      } else if (values[key] !== undefined){
+        data[key] = values[key];
       }
     }
 
@@ -940,6 +935,15 @@ class Bone {
       const attribute = new Attribute(name, attributes[name], options.define);
       attributeMap[attribute.columnName] = attribute;
       attributes[name] = attribute;
+      if (TIMESTAMP_NAMES.includes(name)) {
+        const { columnName } = attribute;
+        const legacyColumnName = LEGACY_TIMESTAMP_COLUMN_MAP[columnName];
+        if (!columnMap[columnName] && legacyColumnName && columnMap[legacyColumnName]) {
+          // correct columname
+          attribute.columnName = legacyColumnName;
+          attributeMap[attribute.columnName] = attribute;
+        }
+      }
       const columnInfo = columnMap[attribute.columnName];
       // if datetime or timestamp precision not defined, default to column info
       if (columnInfo && attribute.type instanceof DataTypes.DATE && attribute.type.precision == null) {
@@ -949,7 +953,7 @@ class Bone {
 
     const primaryKey = Object.keys(attributes).find(key => attributes[key].primaryKey);
     const timestamps = {};
-    for (const key of [ 'createdAt', 'updatedAt', 'deletedAt' ]) {
+    for (const key of TIMESTAMP_NAMES) {
       const name = attributes.hasOwnProperty(key) ? key : snakeCase(key);
       const attribute = attributes[name];
 
@@ -1318,13 +1322,9 @@ class Bone {
   static create(values, opts = {}) {
     const data = Object.assign({}, values);
     const instance = new this(data);
-    if (opts.validate !== false) {
-      instance._validateAttributes(data); // call instance._validateAttributes manually to validate the raw value
-    }
     // static create proxy to instance.create
     return instance.create({
       ...opts,
-      validate: false, // should not validate again
     });
   }
 
@@ -1454,6 +1454,24 @@ class Bone {
    * @return {Spell}
    */
   static remove(conditions, forceDelete = false, options) {
+    return this._remove(conditions, forceDelete, options);
+  }
+
+  /**
+   * private method for internal calling
+   * Remove any record that matches `conditions`.
+   * - If `forceDelete` is true, `DELETE` records from database permanently.
+   * - If not, update `deletedAt` attribute with current date.
+   * - If `forceDelete` isn't true and `deleteAt` isn't around, throw an Error.
+   * @example
+   * Post.remove({ title: 'Leah' })         // mark Post { title: 'Leah' } as deleted
+   * Post.remove({ title: 'Leah' }, true)   // delete Post { title: 'Leah' }
+   * Post.remove({}, true)                  // delete all data of posts
+   * @param {Object}  conditions
+   * @param {boolean} forceDelete
+   * @return {Spell}
+   */
+  static _remove(conditions, forceDelete = false, options) {
     const { deletedAt } = this.timestamps;
     if (forceDelete !== true && this.attributes[deletedAt]) {
       return Bone.update.call(this, conditions, { [deletedAt]: new Date() }, {

package/src/collection.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { AGGREGATOR_MAP } = require('./contants');
+const { AGGREGATOR_MAP } = require('./constants');
 
 const AGGREGATORS = Object.values(AGGREGATOR_MAP);
 /**

package/src/constants.js

@@ -0,0 +1,30 @@
+'use strict';
+
+const AGGREGATOR_MAP = {
+  count: 'count',
+  average: 'avg',
+  minimum: 'min',
+  maximum: 'max',
+  sum: 'sum'
+};
+
+const LEGACY_TIMESTAMP_MAP = {
+  gmtCreate: 'createdAt',
+  gmtModified: 'updatedAt',
+  gmtDeleted: 'deletedAt',
+};
+
+const LEGACY_TIMESTAMP_COLUMN_MAP = {
+  created_at: 'gmt_create',
+  updated_at: 'gmt_modified',
+  deleted_at: 'gmt_deleted',
+};
+
+const TIMESTAMP_NAMES = [ 'createdAt', 'updatedAt', 'deletedAt' ];
+
+module.exports = {
+  AGGREGATOR_MAP,
+  LEGACY_TIMESTAMP_MAP,
+  TIMESTAMP_NAMES,
+  LEGACY_TIMESTAMP_COLUMN_MAP
+};

package/src/data_types.js

@@ -2,6 +2,7 @@
 
 const util = require('util');
 const invokable = require('./utils/invokable');
+const Raw = require('./raw');
 
 /**
  * @example
@@ -114,7 +115,7 @@ class STRING extends DataType {
   }
 
   uncast(value) {
-    if (value == null) return value;
+    if (value == null || value instanceof Raw) return value;
     return '' + value;
   }
 }
@@ -186,15 +187,18 @@ class INTEGER extends DataType {
   }
 
   cast(value) {
-    if (value == null) return value;
+    if (value == null || isNaN(value)) return value;
     return Number(value);
   }
 
-  uncast(value) {
+  uncast(value, strict = true) {
     const originValue = value;
-    if (value == null) return value;
+    if (value == null || value instanceof Raw) return value;
     if (typeof value === 'string') value = parseInt(value, 10);
-    if (isNaN(value)) throw new Error(util.format('invalid integer: %s', originValue));
+    if (isNaN(value)) {
+      if (strict) throw new Error(util.format('invalid integer: %s', originValue));
+      return originValue;
+    }
     return value;
   }
 }
@@ -243,15 +247,17 @@ class DATE extends DataType {
   }
 
   cast(value) {
+    const original = value;
     if (value == null) return value;
     if (!(value instanceof Date)) value = new Date(value);
+    if (isNaN(value.getTime())) return original;
     return this._round(value);
   }
 
   uncast(value) {
     const originValue = value;
 
-    if (value == null) return value;
+    if (value == null || value instanceof Raw) return value;
     if (typeof value.toDate === 'function') {
       value = value.toDate();
     }
@@ -289,15 +295,17 @@ class DATEONLY extends DataType {
   }
 
   cast(value) {
+    const original = value;
     if (value == null) return value;
     if (!(value instanceof Date)) value = new Date(value);
+    if (isNaN(value.getTime())) return original;
     return this._round(value);
   }
 
   uncast(value) {
     const originValue = value;
 
-    if (value == null) return value;
+    if (value == null || value instanceof Raw) return value;
     if (typeof value.toDate === 'function') {
       value = value.toDate();
     }
@@ -309,7 +317,7 @@ class DATEONLY extends DataType {
     }
 
     if (!(value instanceof Date)) value = new Date(value);
-    if (isNaN(value)) throw new Error(util.format('invalid date: %s', originValue));;
+    if (isNaN(value)) throw new Error(util.format('invalid date: %s', originValue));
 
     return this._round(value);
   }
@@ -393,7 +401,7 @@ class JSON extends DataType {
   }
 
   uncast(value) {
-    if (value == null) return value;
+    if (value == null || value instanceof Raw) return value;
     return global.JSON.stringify(value);
   }
 }

package/src/drivers/abstract/attribute.js

@@ -126,11 +126,11 @@ class Attribute {
     return this.type.cast(value);
   }
 
-  uncast(value) {
+  uncast(value, strict = true) {
     if (Array.isArray(value) && this.jsType !== JSON) {
-      return value.map(entry => this.type.uncast(entry));
+      return value.map(entry => this.type.uncast(entry, strict));
     }
-    return this.type.uncast(value);
+    return this.type.uncast(value, strict);
   }
 }
 

package/src/drivers/abstract/spellbook.js

@@ -129,7 +129,7 @@ function createSubspell(spell) {
   subspell.orders = [];
   for (const order of orders) {
     const [token, direction] = order;
-    const { type, qualifiers, value } = token;
+    const { type, qualifiers = [], value } = token;
     if (type == 'id' && qualifiers[0] == baseName) {
       subspell.orders.push([{ type, value }, direction]);
     }
@@ -220,7 +220,7 @@ function formatSelectWithJoin(spell) {
 
   let hoistable = skip > 0 || rowCount > 0;
   if (hoistable) {
-    function checkQualifier({ type, qualifiers }) {
+    function checkQualifier({ type, qualifiers = [] }) {
       if (type === 'id' && qualifiers.length> 0 && !qualifiers.includes(baseName)) {
         hoistable = false;
       }
@@ -476,6 +476,7 @@ function formatUpdate(spell) {
     for (const condition of whereConditions) collectLiteral(spell, condition, values);
     chunks.push(`WHERE ${formatConditions(spell, whereConditions)}`);
   }
+
   return {
     sql: chunks.join(' '),
     values,
@@ -606,4 +607,5 @@ module.exports = {
   formatSelectWithoutJoin,
   formatUpdateOnDuplicate,
   formatReturning,
+  formatOrders
 };

package/src/drivers/mysql/spellbook.js

@@ -58,4 +58,36 @@ module.exports = {
   formatReturning() {
     return '';
   },
+
+  /**
+   * UPDATE ... ORDER BY ... LIMIT ${rowCount}
+   * - https://dev.mysql.com/doc/refman/8.0/en/update.html
+   * @param {Spell} spell
+   */
+  formatUpdate(spell) {
+    const result = spellbook.formatUpdate.call(this, spell);
+    const { rowCount, orders } = spell;
+    const chunks = [];
+
+    if (orders.length > 0) chunks.push(`ORDER BY ${this.formatOrders(spell, orders).join(', ')}`);
+    if (rowCount > 0) chunks.push(`LIMIT ${rowCount}`);
+    if (chunks.length > 0) result.sql += ` ${chunks.join(' ')}`;
+
+    return result;
+  },
+  /**
+   * DELETE ... ORDER BY ...LIMIT
+   * @param {Spell} spell 
+   */
+  formatDelete(spell) {
+    const result = spellbook.formatDelete.call(this, spell);
+    const { rowCount, orders } = spell;
+    const chunks = [];
+
+    if (orders.length > 0) chunks.push(`ORDER BY ${this.formatOrders(spell, orders).join(', ')}`);
+    if (rowCount > 0) chunks.push(`LIMIT ${rowCount}`);
+    if (chunks.length > 0) result.sql += ` ${chunks.join(' ')}`;
+
+    return result;
+  }
 };

package/src/drivers/postgres/data_types.js

@@ -1,6 +1,9 @@
 'use strict';
 
 const DataTypes = require('../../data_types');
+const util = require('util');
+const Raw = require('../../raw');
+
 
 class Postgres_DATE extends DataTypes.DATE {
   constructor(precision, timezone = true) {
@@ -37,12 +40,35 @@ class Postgres_BINARY extends DataTypes {
   }
 }
 
+class Postgres_INTEGER extends DataTypes.INTEGER {
+  constructor(length) {
+    super(length);
+  }
+
+  uncast(value) {
+    const originValue = value;
+    if (value == null || value instanceof Raw) return value;
+    if (typeof value === 'string') value = parseInt(value, 10);
+    if (isNaN(value)) throw new Error(util.format('invalid integer: %s', originValue));
+    return value;
+  }
+}
+
+class Postgres_BIGINT extends Postgres_INTEGER {
+  constructor() {
+    super();
+    this.dataType = 'bigint';
+  }
+}
+
 class Postgres_DataTypes extends DataTypes {
   static DATE = Postgres_DATE;
   static JSONB = Postgres_JSONB;
   static BINARY = Postgres_BINARY;
   static VARBINARY = Postgres_BINARY;
   static BLOB = Postgres_BINARY;
+  static INTEGER = Postgres_INTEGER;
+  static BIGINT =  Postgres_BIGINT;
 }
 
 module.exports = Postgres_DataTypes;

package/src/drivers/postgres/schema.js

@@ -57,13 +57,18 @@ module.exports = {
 
       if (dataType === 'character varying') dataType = 'varchar';
       if (dataType === 'timestamp without time zone') dataType = 'timestamp';
+
+      let columnDefault = row.column_default;
+      if (/^NULL::/i.test(columnDefault)) columnDefault = null;
+      if (dataType === 'boolean') columnDefault = columnDefault === 'true';
+
       const primaryKey = row.constraint_type === 'PRIMARY KEY';
       const precision = row.datetime_precision;
 
       columns.push({
         columnName: row.column_name,
         columnType: length > 0 ? `${dataType}(${length})` : dataType,
-        defaultValue: primaryKey ? null : row.column_default,
+        defaultValue: primaryKey ? null : columnDefault,
         dataType,
         allowNull: row.is_nullable !== 'NO',
         // https://www.postgresql.org/docs/9.5/infoschema-table-constraints.html

package/src/drivers/sqlite/data_types.js

@@ -7,8 +7,42 @@ class Sqlite_DATE extends DataTypes.DATE {
     super(precision, timezone);
     this.dataType = 'datetime';
   }
+
+  uncast(value) {
+    try {
+      return super.uncast(value);
+    } catch (error) {
+      console.error(new Error(`unable to cast ${value} to DATE`));
+      return value;
+    }
+  }
+}
+
+class Sqlite_DATEONLY extends DataTypes.DATEONLY {
+  constructor() {
+    super();
+  }
+
+  uncast(value) {
+    try {
+      return super.uncast(value);
+    } catch (error) {
+      console.error(new Error(`unable to cast ${value} to DATEONLY`));
+      return value;
+    }
+  }
 }
 
+class Sqlite_INTEGER extends DataTypes.INTEGER {
+  constructor(length) {
+    super(length);
+  }
+
+  uncast(value) {
+    return super.uncast(value, false);
+  }
+
+}
 class Sqlite_BIGINT extends DataTypes.BIGINT {
   constructor() {
     super();
@@ -58,6 +92,14 @@ class Sqlite_DataTypes extends DataTypes {
   static get VARBINARY() {
     return Sqlite_VARBINARY;
   }
+
+  static get DATEONLY() {
+    return Sqlite_DATEONLY;
+  }
+
+  static get INTEGER() {
+    return Sqlite_INTEGER;
+  }
 }
 
 module.exports = Sqlite_DataTypes;

package/src/drivers/sqlite/schema.js

@@ -75,8 +75,9 @@ async function alterTableWithChangeColumn(driver, table, changes) {
 }
 
 // eslint-disable-next-line no-unused-vars
-function parseDefaultValue(text) {
+function parseDefaultValue(text, type) {
   if (typeof text !== 'string') return text;
+  if (type === 'boolean') return text === 'true';
 
   try {
     const ast = parseExpr(text);
@@ -84,7 +85,7 @@ function parseDefaultValue(text) {
       return ast.value;
     }
   } catch (err) {
-    debug('[parseDefaultValue] [%s] %s', text, err.stack);
+    debug('[parseDefaultValue] [%s] %s', text, err);
   }
 
   return text;
@@ -111,10 +112,11 @@ module.exports = {
         const columnType = type.toLowerCase();
         const [, dataType, precision ] = columnType.match(rColumnType);
         const primaryKey = pk === 1;
+
         const result = {
           columnName: name,
           columnType,
-          defaultValue: parseDefaultValue(dflt_value),
+          defaultValue: parseDefaultValue(dflt_value, type),
           dataType: dataType,
           allowNull: primaryKey ? false : notnull == 0,
           primaryKey,

package/src/expr_formatter.js

@@ -208,7 +208,7 @@ function coerceLiteral(spell, ast) {
     if (arg.type === 'literal') {
       // { params: { $like: '%foo%' } }
       if (attribute.jsType === JSON && typeof arg.value === 'string') continue;
-      arg.value = attribute.uncast(arg.value);
+      arg.value = attribute.uncast(arg.value, false);
     }
   }
 }

package/src/realm.js

@@ -8,6 +8,7 @@ const { findDriver } = require('./drivers');
 const { camelCase } = require('./utils/string');
 const sequelize = require('./adapters/sequelize');
 const Raw = require('./raw');
+const { LEGACY_TIMESTAMP_MAP } = require('./constants');
 
 /**
  *
@@ -39,12 +40,6 @@ async function findModels(dir) {
   return models;
 }
 
-const LEGACY_TIMESTAMP_MAP = {
-  gmtCreate: 'createdAt',
-  gmtModified: 'updatedAt',
-  gmtDeleted: 'deletedAt',
-};
-
 /**
  * construct model attributes entirely from column definitions
  * @param {Bone} model
@@ -54,9 +49,8 @@ function initAttributes(model, columns) {
   const attributes = {};
 
   for (const columnInfo of columns) {
-    const { columnName, columnType, defaultValue, ...restInfo } = columnInfo;
+    const { columnName, columnType, ...restInfo } = columnInfo;
     const name = columnName === '_id' ? columnName : camelCase(columnName);
-    // leave out defaultValue to let database take over the default
     attributes[name] = {
       ...restInfo,
       columnName,

package/src/spell.js

@@ -11,7 +11,7 @@ const { isPlainObject } = require('./utils');
 const { IndexHint, INDEX_HINT_TYPE, Hint } = require('./hint');
 const { parseObject } = require('./query_object');
 const Raw = require('./raw');
-const { AGGREGATOR_MAP } = require('./contants');
+const { AGGREGATOR_MAP } = require('./constants');
 
 /**
  * Parse condition expressions

package/History.md

@@ -1,550 +0,0 @@
-2.0.1 / 2022-01-05
-==================
-
-## What's Changed
-* fix: format numeric result by @JimmyDaddy in https://github.com/cyjake/leoric/pull/253
-* fix: should still return number if value is '0.000' by @cyjake in https://github.com/cyjake/leoric/pull/254
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.15.1...v2.0.1
-
-2.0.0 / 2021-12-28
-==================
-
-## What's Changed
-* breaking: model.sync add force/alter option by @SmartOrange in https://github.com/cyjake/leoric/pull/224
-* breaking: logQueryError(err, sql, duration, options) by @cyjake in https://github.com/cyjake/leoric/pull/237
-* test: add utf8mb4 test cases by @fengmk2 in https://github.com/cyjake/leoric/pull/239
-* Merge 1.x changes by @cyjake in https://github.com/cyjake/leoric/pull/249
-
-## New Contributors
-* @SmartOrange made their first contribution in https://github.com/cyjake/leoric/pull/222
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.15.1...v2.0.0
-
-1.15.1 / 2021-12-28
-===================
-
-## What's Changed
-* fix: fix #242 date string format by @JimmyDaddy in https://github.com/cyjake/leoric/pull/243
-* fix: update with empty conditions by @JimmyDaddy in https://github.com/cyjake/leoric/pull/241
-* fix: silent option's priority should be lower than valueSet by @JimmyDaddy in https://github.com/cyjake/leoric/pull/244
-* fix: information_schema.columns.datetime_precision by @cyjake in https://github.com/cyjake/leoric/pull/246
-* fix: should not hoist subquery if query is ordered by external columns by @cyjake in https://github.com/cyjake/leoric/pull/247
-
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.15.0...v1.15.1
-
-1.15.0 / 2021-11-22
-===================
-
-## What's Changed
-* feat: make duration in precise milliseconds by @fengmk2 in https://github.com/cyjake/leoric/pull/236
-* fix: spell.increment() & spell.decrement() @cyjake https://github.com/cyjake/leoric/pull/234
-* fix: bulkCreate should adapte empty data @JimmyDaddy  https://github.com/cyjake/leoric/pull/232
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.14.4...v1.14.5
-
-1.14.4 / 2021-11-15
-===================
-
-## What's Changed
-
-* test: PostgreSQL v14 test case compatibility by @cyjake https://github.com/cyjake/leoric/pull/230
-* fix: turn off subquery optimization if query criteria contains other column by @cyjake https://github.com/cyjake/leoric/pull/229
-* fix: bone.changed() return `false | string[]` type by @fengmk2 https://github.com/cyjake/leoric/pull/231
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.14.3...v1.14.4
-
-1.14.3 / 2021-11-12
-===================
-
-## What's Changed
-* fix: logger.logQuery should be guarded in case of error by @SmartOrange in https://github.com/cyjake/leoric/pull/222
-* fix: findOne without result should return null by @JimmyDaddy in https://github.com/cyjake/leoric/pull/225
-* fix: Literal should support bigint type by @fengmk2 in https://github.com/cyjake/leoric/pull/226
-* fix: select((name: string) => boolean) by @cyjake in https://github.com/cyjake/leoric/pull/227
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.14.2...v1.14.3
-
-1.14.2 / 2021-11-01
-===================
-
-## What's Changed
-* fix: accept timestamps in snake case by @cyjake in https://github.com/cyjake/leoric/pull/221
-
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.14.1...v1.14.2
-
-1.14.1 / 2021-11-01
-===================
-
-## What's Changed
-* docs: export { Collection } by @cyjake in https://github.com/cyjake/leoric/pull/220
-
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.14.0...v1.14.1
-
-1.14.0 / 2021-11-01
-===================
-
-Two options regarding `Model.init()` were added in this release:
-
-```js
-class User extends Bone {}
-User.init({ name: STRING }, {
-  timestamps: true,  // which is the default
-  paranoid: true,    // which default to `false`
-});
-assert.deepEqual(Object.keys(User.attributes), [
-  'id',
-  'name',
-  'createdAt',
-  'updatedAt',
-  'deletedAt',
-]);
-```
-
-## What's Changed
-* docs: update 'primayKey' typos by @freshgum-bubbles in https://github.com/cyjake/leoric/pull/211
-* docs: DataTypes definitions in d.ts by @cyjake in https://github.com/cyjake/leoric/pull/210
-* fix: fix#209 sequelize mode should update all changed fields in instance update method by @JimmyDaddy in https://github.com/cyjake/leoric/pull/212
-* fix: fix #213 findAndCountAll should ignore attributes by @JimmyDaddy in https://github.com/cyjake/leoric/pull/214
-* fix: opts.connectTimeout by @cyjake in https://github.com/cyjake/leoric/pull/216
-* fix: reload instance with sharding key should not throw by @cyjake in https://github.com/cyjake/leoric/pull/217
-* feat: timestamps should be defined by default by @cyjake in https://github.com/cyjake/leoric/pull/218
-* fix: instance.reload() should not rely on `static findOne()` by @cyjake in https://github.com/cyjake/leoric/pull/219
-
-## New Contributors
-* @freshgum-bubbles made their first contribution in https://github.com/cyjake/leoric/pull/211
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.13.5...v1.14.0
-
-1.13.5 / 2021-10-26
-===================
-
-## What's Changed
-* docs: enhance aggregation query types & fix raw query result type by @cyjake in https://github.com/cyjake/leoric/pull/208
-
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.13.4...v1.13.5
-
-1.13.4 / 2021-10-25
-===================
-
-## What's Changed
-* docs: spell & model methods should be generic  by @cyjake in https://github.com/cyjake/leoric/pull/206
-* docs: enhance query options, instance type, and toJSON() result type by @cyjake in https://github.com/cyjake/leoric/pull/207
-
-This version brings correct (and hopefully better) typescript definitions, with the dts checked continuously at test/types tests. With this version, users that have model types correctly pinned at Bone will get code completion including class fields. Such as:
-
-![image](https://user-images.githubusercontent.com/252317/138683240-98ee9e79-4b3e-449c-bc95-a449d457d64f.png)
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.13.3...v1.13.4
-
-1.13.3 / 2021-10-21
-===================
-
-## What's Changed
-* refactor: persist edge cases of type casting in integration tests by @cyjake in https://github.com/cyjake/leoric/pull/202
-* docs: renaming attributes by @cyjake in https://github.com/cyjake/leoric/pull/203
-* fix: JSON.uncast(string) should not serialize twice by @cyjake in https://github.com/cyjake/leoric/pull/205
-
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.13.2...v1.13.3
-
-1.13.2 / 2021-10-18
-===================
-
-## What's Changed
-* fix: attribute.uncast([]) and realm.connect with synchronized models by @cyjake in https://github.com/cyjake/leoric/pull/201
-
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.13.1...v1.13.2
-
-1.13.1 / 2021-10-18
-===================
-
-## What's Changed
-* fix: skip connecting if models are synchronized already by @cyjake in https://github.com/cyjake/leoric/pull/200
-
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.13.0...v1.13.1
-
-1.13.0 / 2021-10-18
-===================
-
-## What's Changed
-* docs: monthly updates of 2021.09; support dark mode by @cyjake in https://github.com/cyjake/leoric/pull/196
-* feat: coerce literal values into accurate attribute type by @cyjake in https://github.com/cyjake/leoric/pull/197
-* fix: dispatched result should be in attribute names by @cyjake in https://github.com/cyjake/leoric/pull/198
-
-
-**Full Changelog**: https://github.com/cyjake/leoric/compare/v1.12.0...v1.13.0
-
-1.12.0 / 2021-10-12
-===================
-
-  * feat: support custom fields query and sequelize mode export rawAttributes (#192)
-  * refactor: collection format query result (#194)
-  * refactor: object condition parsing and expression formatting (#191)
-
-1.11.1 / 2021-09-28
-===================
-
-This version fixes lots of issues regarding logical operator in object conditions.
-
-  * fix: logical operator with multiple conditions such as (#190)
-  * fix: sequelize mode support HAVING, and select fields raw sql support (#187)
-  * fix: support len validator (#188)
-  * fix: normalize logical operator conditions before formatting with spellbook (#186)
-
-1.11.0 / 2021-09-24
-===================
-
-  * feat: support BINARY(length), VARBINARY(length), and BLOB (#169)
-  * fix: logic operate should adapt one argument (#183)
-  * fix: Bone.load() should be idempotent, make sure associations is intact (#184)
-  * fix: selected instance isNewRecord is false (#182)
-  * fix: set options.busyTimeout to mitigate SQLITE_BUSY (#176)
-  * fix: turn on long stack trace of sqlite driver (#175)
-  * docs: how to contribute (#180)
-
-1.10.0 / 2021-09-14
-===================
-
-  * feat: SQLite driver should emit "connection" event when new connection is created (#168)
-  * fix: bulkCreate(...records) should recognize custom setters (#168)
-  * fix: attribute.equals() check should ignore defaultValue (#172)
-
-1.9.0 / 2021-09-04
-==================
-
-> should've been a major release but since existing users have all migrated to the new api...
-
-  * breaking: drop the deprecated `Model.describe()` (#167)
-
-1.8.0 / 2021-08-30
-==================
-
-  * feat: silent option fix #164 (#165)
-  * feat: binary type (#166)
-
-1.7.1 / 2021-08-17
-==================
-
-  * revert: drop Driver#recycleConnections due to poor interoperability (#162)
-  * fix: validator call array arguments (#160)
-
-1.7.0 / 2021-08-17
-=================
-
-  * feat: close connections that exceeds opts.idleTimeout (#159)
-  * feat: `opts.connectionLimit` support for SQLite (#159)
-  * feat: raw query relpacements, closes #149 (#155)
-  * fix: upsert created_at default (#154)
-  * test: validator unit test (#157)
-  * test: setup_hooks unit test (#158)
-
-1.6.7 / 2021-08-05
-==================
-
-  * fix: prevent from calling Date.prototype.toJSON (#153)
-
-1.6.6 / 2021-07-22
-==================
-
-  * fix: subclassing data type in dialects (#145)
-  * fix: where('width / height >= 16 / 9') (#144)
-  * docs: logging and sequelzie adapter (zh) (#142)
-  * test: include test/unit/utils (#143)
-  * test: more tests cases about sequelize adapter (#141)
-
-1.6.5 / 2021-07-16
-==================
-
-  * fix: define assign Bone.models #140
-
-1.6.4 / 2021-07-16
-==================
-
-  * refactor: connect({ Bone }) still necessary (#139)
-  * fix: formatting select join with subqueries should not tamper the subquery itself (#138)
-  * fix: describe table with more compatible syntax (#137)
-
-1.6.3 / 2021-07-14
-==================
-
-  * fix: transaction option passing in sequelize adapter (#136)
-  * fix: this.Model and proper Model.describe() (#135)
-
-1.6.2 / 2021-07-09
-==================
-
-  * fix: convert datetime in seconds/milliseconds back to Date (#134)
-  * fix: renamed attribute should remain enumerable (#133)
-
-1.6.1 / 2021-07-07
-==================
-
-  * fix: collection convert should handle tddl results as well (#132)
-
-1.6.0 / 2021-07-06
-==================
-
-  * feat: support class static attributes and hooks (#131)
-  * fix: names defined in Bone.attributes should always be enumerable (#128)
-  * chore: add quality badge to readme (#129)
-
-1.5.2 / 2021-07-02
-==================
-
-  * fix: leave the getter properties defined in class syntax as is (#127)
-
-1.5.1 / 2021-06-30
-==================
-
-  * fix: export Logger and Spell to let users intercept lower level api calls (#126)
-
-1.5.0 / 2021-06-30
-==================
-
-  * feat: provide Bone.pool to be backward compatible with v0.x (#124)
-  * feat: complete bone/spine.restore and Bone API type definitions (#125)
-  * feat: support more data types (mediumtext, mediumint, char, date...) (#123)
-
-1.4.1 / 2021-06-25
-==================
-
-  * refactor: simplify legacy timestamps support (#120)
-  * refactor: do not subclass Bone unless asked specifically (#120)
-
-1.4.0 / 2021-06-24
-==================
-
-  * feat: `realm.raw('SELECT ...')` and `Model.raw('SELECT ...')` (#94)
-  * feat: support multiple order rules in one single string or one-dimensional array (#92)
-  * feat: `Model.truncate()` now uses TRUNCATE if possible
-  * feat: `Model.find().optimizerHints('SET_VAR(foreign_key_checks=OFF)')`
-  * fix: Bone.bulkCreate() should not throw when called with non attribute (#117)
-  * fix: batch upsert (#108)
-  * fix: make sure connection is passed around in all queries carried out within transaction (#105)
-  * fix: update, sequelize mode get API, destroy compitable (#104)
-  * fix: `setDataValue` in sequelize adapter should not check prop name strictly
-  * refactor: spell_insert (#118)
-  * docs: about egg-orm & migrations (#119)
-  * docs: revise instructions for installing Jekyll (#111)
-  * docs: migrations, validations, hooks, and sequelize adapter (#103)
-  * docs: contributing guides
-
-1.3.0 / 2021-03-01
-==================
-
-  * feat: hook support
-  * feat: dirty check (`changes()` & `previousChanges()`)
-  * feat: compatible with mysql longtext conversion
-  * feat: NOT condition
-
-1.2.0 / 2020-12-10
-==================
-
-  * feat: `Realm.prototype.transaction()` with async function support
-  * feat: `Realm.prototype.query()` for raw queries
-  * feat: `logger.logQuery(sql, duration, { Model, command })`
-  * feat: `logger.logQueryError(sql, err, duration, { Model, command })`
-
-1.1.0 / 2020-11-23
-==================
-
-  * feat: JSON and JSONB data types
-  * feat: support `stringifyObjects` option for mysql client
-  * feat: aggregate functions for sequelize adapter
-  * feat: `Spell.prototype.nodeify()`
-
-1.0.3 / 2020-03-16
-==================
-
-  * fix: replace `deep-equal` (which is bloated) with `util.isDeepStrictEqual`
-
-1.0.2 / 2020-03-04
-==================
-
-  * fix: driver.alterTable() with multiple columns to add in SQLite
-
-1.0.1 / 2020-02-25
-==================
-
-  * fix: bulkCreate in sequelize shim
-
-1.0.0 / 2020-02-24
-==================
-
-First major release. Let's get serious with semver.
-
-  * feat: logger.logQuery(sql, duration) & logger.logQueryError(sql, err)
-
-0.5.3 / 2020-02-22
-==================
-
-  * fix: `connect({ sequelize, dialect, client })` to allow mandatory sqlite client
-  * fix: prevent queries being performed unless model is correctly connected
-
-0.5.2 / 2020-02-21
-==================
-
-  * fix: drop the default and unused `require('sqlite3')`
-
-0.5.1 / 2020-02-21
-==================
-
-  * fix: `connect({ client: '@journeyapps/sqlcipher' })`
-
-0.5.0 / 2020-02-19
-==================
-
-  * feat: `Bone.sync()` to synchronize model with database
-  * feat: `Bone.createMigrationFile()` to create migration file
-  * feat: `Bone.migrate()` to run migrations
-  * feat: `Bone.bulkCreate()` to bulk insert records
-  * feat: `require('leoric')` now exports `Realm` to connect with multiple databases
-  * feat: `realm.define()` to define models in an old fashioned way
-  * feat: `realm.connect()` to connect with database
-  * feat: SQLite support without hacking node-sqlite3
-  * feat: `Bone.DataTypes` for type references
-  * feat: `Bone.init()` to initialize models
-  * feat: an adaptor to use Leoric in (partially) Sequelize complaint API
-  * refactor: a complete re-write of JOIN queries
-  * refactor: added `Bone.driver` to better encapsulate and planish database nuances
-
-0.4.5 / 2019-12-14
-==================
-
-  * fix: prevent primary key from being overridden with incorrect `LAST_INSERT_ID()`
-
-0.4.4 / 2019-07-15
-==================
-
-  * fix: append default scope when declaring relations, fixes #10
-
-0.4.3 / 2019-05-09
-==================
-
-  * fix: prevent Bone.dispatch from creating duplicated records of main table
-
-0.4.2 / 2019-04-26
-==================
-
-  * feat: `Spell#orWhere()` and `Spell#orHaving()`
-  * feat: arithmetic operators
-  * feat: unary operators such as unary minus `-` and bit invertion `~`
-  * fix: unset attribute should be overwritable
-  * fix: `attributeChanged()` should be false if attribute is unset and not overwritten
-  * fix: subclass with incomplete getter/setter should be complemented
-  * fix: sharding key validation on `Bone.update()` and `Bone.save()`
-  * fix: sharding key should be along with primary key on `bone.remove()`
-  * fix: `Bone.cast()` should leave `null` as is
-  * fix: `INSERT ... UPDATE` with `id = LAST_INSERT_ID(id)` in MySQL
-  * fix: `Model.find({ name: { $op1, $op2 } })` object conditions with multiple operators
-  * fix: prefixing result set with qualifiers if query contains join relations and is not dispatchable
-  * fix: `Spell#$get(index)` with LIMIT
-  * doc: `Model.transaction()`
-  * doc: definition types with `index.d.ts`
-
-0.4.1 / 2019-03-21
-==================
-
-  * feat: premature sharding key validation
-  * fix: output complete SQL instead of parameterized query with values.
-  * fix: both `connect({ model })` and `connect({ models })` are allowed.
-  * doc: no more `.findOrCreate()`, just `.upsert()`
-  * doc: table of contents with kramdown's `{:toc}`
-  * chore: droped experimental sqlite3 support
-
-0.4.0 / 2018-11-05
-==================
-
-  * feat: PostgreSQL support
-  * feat: Transaction support
-  * upgrade: (forked) SQLite client updated to SQLite 3.24
-
-
-0.3.0 / 2018-10-31
-==================
-
- * feat: SQLite support with a [forked sqlite3](https://github.com/cyjake/node-sqlite3)
- * feat: mysql2 support (which is trivial since both mysql and mysql2 share the same API)
- * refactor: Spell now formats SQL with the literals separated, which gets escaped by the corresponding client itself later on.
-
-0.2.0 / 2018-01-03
-==================
-
- * breaking: renaming
-
-0.1.8 / 2017-12-31
-==================
-
- * fix: implement `query.batch()` as async iterator
- * fix: `NOT (expr)`
- * fix: `IFNULL(foo, default)`
- * fix: support `.select(name[])`, `.select(name => {})`, and `.select("...name")`
- * doc: `Model => className` in association options
- * doc: use [jsdoc](http://usejsdoc.org) to generate docs/api
- * doc: `.include()`
-
-0.1.7 / 2017-12-22
-==================
-
- * refactor: `{ type: 'op', name: 'as' }` renamed to `{ type: 'alias' }`
- * feat: `{ type: 'mod' }` for modifier, currently only `DISTINCT` is recognized
- * feat: unary operators like `!` and `NOT`
- * feat: `IS` and `IS NOT`
- * fix: logic operator precendences
- * fix: polymorphic hasMany({ through }) relations
- * fix: dispatching multiple results with joins correctly
-
-0.1.6 / 2017-12-21
-==================
-
- * feat: proper `.first`, `.last`, `.all`, and `.get(index)`
- * fix: accept `Date`, `boolean`, and `Set` values
- * fix: `Model.unscoped`
- * fix: `Model.remove({}, true)` should be unscoped
-
-0.1.5 / 2017-12-20
-==================
-
- * refactor: encapsulate column names. Keep them from the users even if the query results can not be dispatched.
- * fix: complicated groups with joins should discard the use of subquery.
- * fix: camelCase should replace globally
- * fix: avoid missing attribtue exception when toJSON/toObject
-
-0.1.4 / 2017-12-18
-==================
-
- * fix: should format condition arrays by hand instead of hand it over to formatExpr
- * fix: whereConditions of subquery should retain the order of the whereConditions in major query
- * fix: calculated columns should be kept in the final columns when sorting out the attributes
- * fix: doesn't depend on co anymore
-
-0.1.3 / 2017-12-17
-==================
-
- * fix: `select distict foo from table`;
- * fix: `where (a = 1 or a = 2) and b = 3`;
- * doc: a syntax table to provide a better glance over the querying ability.
-
-0.1.2 / 2017-12-14
-==================
-
- * fix: copy left table's orders into subquery to make order/limit work when combined.
- * fix: errors should be thrown when accessing attributes that weren't selected at the first place.
-
-0.1.1 / 2017-12-13
-==================
-
- * refactor: automatic versioning on spells. When client calls query methods with chaining, new versions of spell gets duplicated. Makes reuse of spells possible.
- * doc: english verion is almost complete <http://cyj.me/leoric>.
-
-0.1.0 / 2017-12-09
-==================
-
- * Initial version, covers basic usage such as model authoring, database connection, query interface, and association.

package/src/contants.js

@@ -1,13 +0,0 @@
-'use strict';
-
-const AGGREGATOR_MAP = {
-  count: 'count',
-  average: 'avg',
-  minimum: 'min',
-  maximum: 'max',
-  sum: 'sum'
-};
-
-module.exports = {
-  AGGREGATOR_MAP
-};