leoric 2.0.4 → 2.2.0

package/History.md

@@ -1,3 +1,37 @@
+2.2.0 / 2022-02-24
+==================
+
+## What's Changed
+* fix: add missing `password` field for `ConnectOptions` by @luckydrq in https://github.com/cyjake/leoric/pull/280
+* feat: integer types (mostly mysql specific) by @cyjake in https://github.com/cyjake/leoric/pull/281
+
+
+**Full Changelog**: https://github.com/cyjake/leoric/compare/v2.1.1...v2.2.0
+
+2.1.1 / 2022-02-23
+==================
+
+## What's Changed
+* fix: fix #274 update with fields option by @JimmyDaddy in https://github.com/cyjake/leoric/pull/275
+* fix:  upsert should set createdAt  by default while createdAt  not set  by @JimmyDaddy in https://github.com/cyjake/leoric/pull/277
+* fix: previousChanges should check instance is new record or not while specific attributes' values were undefined by @JimmyDaddy in https://github.com/cyjake/leoric/pull/276
+* docs: add types for realm by @luckydrq in https://github.com/cyjake/leoric/pull/278
+
+## New Contributors
+* @luckydrq made their first contribution in https://github.com/cyjake/leoric/pull/278
+
+**Full Changelog**: https://github.com/cyjake/leoric/compare/v2.1.0...v2.1.1
+
+2.1.0 / 2022-02-17
+==================
+
+## What's Changed
+* feat: fix #270 sequelize mode bulkBuild by @JimmyDaddy in https://github.com/cyjake/leoric/pull/273
+* fix:  mysql delete/remove/destroy with limit and orders by @JimmyDaddy in https://github.com/cyjake/leoric/pull/272
+
+
+**Full Changelog**: https://github.com/cyjake/leoric/compare/v2.0.4...v2.1.0
+
 2.0.4 / 2022-02-16
 ==================
 

package/index.js

@@ -36,7 +36,7 @@ const connect = async function connect(opts) {
   return realm;
 };
 
-Object.assign(Realm.prototype, migrations, { DataTypes });
+Object.assign(Realm.prototype, migrations);
 Object.assign(Realm, {
   connect,
   Bone,

package/package.json

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

package/src/adapters/sequelize.js

@@ -257,6 +257,17 @@ module.exports = Bone => {
       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() {}
 
@@ -308,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
@@ -495,11 +508,11 @@ module.exports = Bone => {
     // get isNewRecord() {}
 
     async update(values = {}, options = {}) {
-      const { fields } = options;
+      const { fields = [] } = options;
       const changeValues = {};
       const originalValues = Object.assign({}, this.getRaw());
       for (const name in values) {
-        if (values[name] !== undefined && this.hasAttribute(name)) {
+        if (values[name] !== undefined && this.hasAttribute(name) && (!fields.length || fields.includes(name))) {
           // exec custom setters in case it exist
           this[name] = values[name];
           changeValues[name] = this.attribute(name);

package/src/bone.js

@@ -183,7 +183,6 @@ class Bone {
     }
 
     if (args.length > 1) {
-      // execute validators
       this.#raw[name] = value instanceof Raw ? value : attribute.cast(value);
       this.#rawUnset.delete(name);
       return this;
@@ -619,9 +618,10 @@ class Bone {
   async update(values, options = {}) {
     const changes = {};
     const originalValues = Object.assign({}, this.#raw);
+    const { fields = [] } = options;
     if (typeof values === 'object') {
       for (const name in values) {
-        if (values[name] !== undefined && this.hasAttribute(name)) {
+        if (values[name] !== undefined && this.hasAttribute(name) && (!fields.length || fields.includes(name))) {
           // exec custom setters in case it exist
           this[name] = values[name];
           changes[name] = this.attribute(name);
@@ -789,7 +789,7 @@ class Bone {
       }, opts);
       return result;
     }
-    return await Model.remove(condition, forceDelete, { hooks: false, ...opts });
+    return await Model._remove(condition, forceDelete, opts);
   }
 
   /**
@@ -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/data_types.js

@@ -14,7 +14,13 @@ const Raw = require('./raw');
 
 class DataType {
   static findType(columnType) {
-    const { STRING, TEXT, DATE, DATEONLY, INTEGER, BIGINT, BOOLEAN, BINARY, VARBINARY, BLOB } = this;
+    const {
+      STRING, TEXT,
+      DATE, DATEONLY,
+      TINYINT, SMALLINT, MEDIUMINT, INTEGER, BIGINT,
+      BOOLEAN,
+      BINARY, VARBINARY, BLOB,
+    } = this;
     const [ , dataType, appendix ] = columnType.match(/(\w+)(?:\((\d+)\))?/);
     const length = appendix && parseInt(appendix, 10);
 
@@ -39,10 +45,13 @@ class DataType {
       case 'int':
       case 'integer':
       case 'numeric':
+        return new INTEGER(length);
       case 'mediumint':
+        return new MEDIUMINT(length);
       case 'smallint':
+        return new SMALLINT(length);
       case 'tinyint':
-        return new INTEGER(length);
+        return new TINYINT(length);
       case 'bigint':
         return new BIGINT(length);
       case 'boolean':
@@ -203,12 +212,58 @@ class INTEGER extends DataType {
   }
 }
 
+/**
+ * 8 bit integer
+ * @example
+ * TINYINT
+ * TINYINT.UNSIGNED
+ * TINYINT(1)
+ * @param {number} length
+ */
+class TINYINT extends INTEGER {
+  constructor(length) {
+    super(length);
+    this.dataType = 'tinyint';
+  }
+}
+
+/**
+ * 16 bit integer
+ * @example
+ * SMALLINT
+ * SMALLINT.UNSIGNED
+ * SMALLINT(2)
+ * @param {number} length
+ */
+class SMALLINT extends INTEGER {
+  constructor(length) {
+    super(length);
+    this.dataType = 'smallint';
+  }
+}
+
+/**
+ * 24 bit integer
+ * @example
+ * MEDIUMINT
+ * MEDIUMINT.UNSIGNED
+ * MEDIUMINT(3)
+ * @param {number} length
+ */
+class MEDIUMINT extends INTEGER {
+  constructor(length) {
+    super(length);
+    this.dataType = 'mediumint';
+  }
+}
+
+
 /**
  * 64 bit integer
  * @example
  * BIGINT
  * BIGINT.UNSIGNED
- * BIGINT(10)
+ * BIGINT(8)
  * @param {number} length
  */
 class BIGINT extends INTEGER {
@@ -422,6 +477,9 @@ class JSONB extends JSON {
 
 const DataTypes = {
   STRING,
+  TINYINT,
+  SMALLINT,
+  MEDIUMINT,
   INTEGER,
   BIGINT,
   DATE,

package/src/drivers/abstract/attribute.js

@@ -65,6 +65,14 @@ function createType(DataTypes, params) {
   switch (type.constructor.name) {
     case 'DATE':
       return new DataType(type.precision, type.timezone);
+    case 'TINYINT':
+    case 'SMALLINT':
+    case 'MEDIUMINT':
+    case 'INTEGER':
+    case 'BIGINT':
+    case 'BINARY':
+    case 'VARBINARY':
+      return new DataType(type.length);
     default:
       return new DataType();
   }
@@ -123,7 +131,8 @@ class Attribute {
   }
 
   cast(value) {
-    return this.type.cast(value);
+    const castedValue = this.type.cast(value);
+    return castedValue == null? null : castedValue;
   }
 
   uncast(value, strict = true) {

package/src/drivers/abstract/spellbook.js

@@ -356,15 +356,14 @@ function formatInsert(spell) {
       }
     } else {
       for (const name in involved) {
-        // upsert should not update createdAt
-        if (updateOnDuplicate && createdAt && name === createdAt) continue;
         attributes.push(Model.attributes[name]);
       }
     }
 
     for (const entry of attributes) {
       columns.push(entry.columnName);
-      if (updateOnDuplicate && createdAt && entry.name === createdAt) continue;
+      if (updateOnDuplicate && createdAt && entry.name === createdAt 
+        && !(Array.isArray(updateOnDuplicate) && updateOnDuplicate.includes(createdAt))) continue;
       updateOnDuplicateColumns.push(entry.columnName);
     }
 
@@ -385,7 +384,6 @@ function formatInsert(spell) {
     }
     for (const name in sets) {
       const value = sets[name];
-      // upsert should not update createdAt
       columns.push(Model.unalias(name));
       if (value instanceof Raw) {
         values.push(SqlString.raw(value.value));

package/src/drivers/mysql/spellbook.js

@@ -49,7 +49,10 @@ module.exports = {
     const sets = [];
     // Make sure the correct LAST_INSERT_ID is returned.
     // - https://stackoverflow.com/questions/778534/mysql-on-duplicate-key-last-insert-id
-    sets.push(`${escapeId(primaryColumn)} = LAST_INSERT_ID(${escapeId(primaryColumn)})`);
+    // if insert attributes include primary column, `primaryKey = LAST_INSERT_ID(primaryKey)` is not need any more
+    if (!columns.includes(primaryColumn)) {
+      sets.push(`${escapeId(primaryColumn)} = LAST_INSERT_ID(${escapeId(primaryColumn)})`);
+    }
     sets.push(...columns.map(column => `${escapeId(column)}=VALUES(${escapeId(column)})`));
 
     return `ON DUPLICATE KEY UPDATE ${sets.join(', ')}`;
@@ -75,4 +78,19 @@ module.exports = {
 
     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

@@ -61,12 +61,22 @@ class Postgres_BIGINT extends Postgres_INTEGER {
   }
 }
 
+class Postgres_SMALLINT extends Postgres_INTEGER {
+  constructor() {
+    super();
+    this.dataType = 'smallint';
+  }
+}
+
 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 TINYINT = Postgres_SMALLINT;
+  static SMALLINT = Postgres_SMALLINT;
+  static MEDIUMINT = Postgres_INTEGER;
   static INTEGER = Postgres_INTEGER;
   static BIGINT =  Postgres_BIGINT;
 }

package/src/realm.js

@@ -129,6 +129,11 @@ class Realm {
     this.options = Spine.options = options;
   }
 
+  get DataTypes() {
+    if (!this.driver) throw new Error('database not connected yet');
+    return this.driver.DataTypes;
+  }
+
   define(name, attributes, opts = {}, descriptors = {}) {
     const Model = class extends this.Bone {
       static name = name;

package/types/index.d.ts

@@ -593,13 +593,16 @@ export class Bone {
   toObject(): InstanceValues<this>;
 }
 
-interface ConnectOptions {
+export interface ConnectOptions {
   client?: 'mysql' | 'mysql2' | 'pg' | 'sqlite3' | '@journeyapps/sqlcipher';
   dialect?: 'mysql' | 'postgres' | 'sqlite';
   host?: string;
+  port?: number | string;
   user?: string;
+  password?: string;
   database: string;
   models?: string | (typeof Bone)[];
+  subclass?: boolean;
 }
 
 interface InitOptions {
@@ -612,6 +615,11 @@ interface InitOptions {
   };
 }
 
+interface SyncOptions {
+  force?: boolean;
+  alter?: boolean;
+}
+
 type RawSql = {
   __raw: true,
   value: string,
@@ -626,6 +634,7 @@ interface RawQueryOptions {
 
 export default class Realm {
   Bone: typeof Bone;
+  DataTypes: typeof DataType;
   driver: Driver;
   models: Record<string, Bone>;
 
@@ -633,10 +642,10 @@ export default class Realm {
 
   define(
     name: string,
-    attributes: Record<string, AttributeMeta>,
-    options: InitOptions,
-    descriptors: Record<string, Function>,
-  ): Bone;
+    attributes: Record<string, DataTypes<DataType> | AttributeMeta>,
+    options?: InitOptions,
+    descriptors?: Record<string, Function>,
+  ): typeof Bone;
 
   raw(sql: string): RawSql;
 
@@ -646,6 +655,8 @@ export default class Realm {
 
   transaction(callback: GeneratorFunction): Promise<void>;
   transaction(callback: (connection: Connection) => Promise<void>): Promise<void>;
+
+  sync(options?: SyncOptions): Promise<void>;
 }
 
 /**