leoric 2.4.1 → 2.5.0

package/History.md

@@ -1,3 +1,12 @@
+2.5.0 / 2022-05-13
+==================
+
+## What's Changed
+* feat: support disconnect and fix timestamps init by @JimmyDaddy in https://github.com/cyjake/leoric/pull/313
+
+
+**Full Changelog**: https://github.com/cyjake/leoric/compare/v2.4.1...v2.5.0
+
 2.4.1 / 2022-04-27
 ==================
 

package/index.js

@@ -39,10 +39,17 @@ const connect = async function connect(opts) {
   return realm;
 };
 
+const disconnect = async function disconnect(realm, ...args) {
+  if (realm instanceof Realm && realm.connected) {
+    return await realm.disconnect(...args);
+  }
+};
+
 Object.assign(Realm.prototype, migrations, { DataTypes });
 Object.assign(Realm, {
   default: Realm,
   connect,
+  disconnect,
   Bone,
   Collection,
   DataTypes,

package/package.json

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

package/src/bone.js

@@ -20,6 +20,7 @@ const {
   TIMESTAMP_NAMES,
   LEGACY_TIMESTAMP_COLUMN_MAP,
   ASSOCIATE_METADATA_MAP,
+  TIMESTAMP_ATTRIBUTE_NAMES,
 } = require('./constants');
 
 const columnAttributesKey = Symbol('leoric#columns');
@@ -999,7 +1000,7 @@ class Bone {
       const attribute = new Attribute(name, attributes[name], options.define);
       attributeMap[attribute.columnName] = attribute;
       attributes[name] = attribute;
-      if (TIMESTAMP_NAMES.includes(name)) {
+      if (TIMESTAMP_ATTRIBUTE_NAMES.includes(name)) {
         const { columnName } = attribute;
         const legacyColumnName = LEGACY_TIMESTAMP_COLUMN_MAP[columnName];
         if (!columnMap[columnName] && legacyColumnName && columnMap[legacyColumnName]) {

package/src/constants.js

@@ -20,6 +20,12 @@ const LEGACY_TIMESTAMP_COLUMN_MAP = {
   deleted_at: 'gmt_deleted',
 };
 
+const TIMESTAMP_ATTRIBUTE_NAMES = [ 
+  'createdAt', 'updatedAt', 'deletedAt',
+  'gmtCreate', 'gmtModified', 'gmtDeleted',
+  'created_at', 'updated_at', 'deleted_at',
+  'gmt_create', 'gmt_modified', 'gmt_deleted',
+];
 const TIMESTAMP_NAMES = [ 'createdAt', 'updatedAt', 'deletedAt' ];
 
 const ASSOCIATE_METADATA_MAP = {
@@ -33,5 +39,6 @@ module.exports = {
   LEGACY_TIMESTAMP_MAP,
   TIMESTAMP_NAMES,
   LEGACY_TIMESTAMP_COLUMN_MAP,
-  ASSOCIATE_METADATA_MAP
+  ASSOCIATE_METADATA_MAP,
+  TIMESTAMP_ATTRIBUTE_NAMES
 };

package/src/drivers/abstract/index.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const SqlString = require('sqlstring');
+const debug = require('debug')('leoric');
 
 const Logger = require('./logger');
 const Attribute = require('./attribute');
@@ -54,6 +55,14 @@ class AbstractDriver {
     throw new Error('unimplemented!');
   }
 
+  /**
+   * disconnect manually
+   * @param {Function} callback 
+   */
+  async disconnect(callback) {
+    debug('[disconnect] called');
+  }
+
   get dialect() {
     return camelCase(this.constructor.name.replace('Driver', ''));
   }

package/src/realm.js

@@ -160,6 +160,12 @@ class Realm {
     return this.Bone;
   }
 
+  async disconnect(callback) {
+    if (this.connected && this.driver) {
+      return await this.driver.disconnect(callback);
+    }
+  }
+
   async sync(options) {
     if (!this.connected) await this.connect();
     const { models } = this;

package/types/index.d.ts

@@ -17,6 +17,8 @@ type DataTypes<T> = {
   [Property in keyof T as Exclude<Property, "toSqlString">]: T[Property]
 }
 
+type RawQueryResult = typeof Bone | ResultSet | boolean | number;
+
 interface ExprIdentifier {
   type: 'id';
   value: string;
@@ -314,6 +316,12 @@ declare class AbstractDriver {
    * Grab a connection and query the database
    */
   query(sql: string | { sql: string, nestTables?: boolean}, values?: Array<Literal | Literal[]>, opts?: SpellMeta): Promise<QueryResult>;
+
+  /**
+   * disconnect manually
+   * @param callback
+   */
+  disconnect(callback?: Function): Promise<boolean | void>;
   
   /**
    * query with spell
@@ -686,8 +694,8 @@ export class Bone {
    *   yield Muscle.create({ boneId: bone.id, bar: 1 })
    * });
    */
-  static transaction(callback: GeneratorFunction): Promise<void>;
-  static transaction(callback: (connection: Connection) => Promise<void>): Promise<void>;
+  static transaction(callback: GeneratorFunction): Promise<RawQueryResult>;
+  static transaction(callback: (connection: Connection) => Promise<RawQueryResult>): Promise<RawQueryResult>;
 
   /**
    * DROP the table
@@ -884,10 +892,10 @@ export default class Realm {
 
   escape(value: Literal): string;
 
-  query(sql: string, values?: Array<Literal>, options?: RawQueryOptions): ResultSet;
+  query(sql: string, values?: Array<Literal>, options?: RawQueryOptions): RawQueryResult;
 
-  transaction(callback: GeneratorFunction): Promise<void>;
-  transaction(callback: (connection: Connection) => Promise<void>): Promise<void>;
+  transaction(callback: GeneratorFunction): Promise<RawQueryResult>;
+  transaction(callback: (connection: Connection) => Promise<RawQueryResult>): Promise<RawQueryResult>;
 
   sync(options?: SyncOptions): Promise<void>;
 }
@@ -903,7 +911,7 @@ export default class Realm {
  * })
  */
 export function connect(opts: ConnectOptions): Promise<Realm>;
-
+export function disconnect(realm: Realm, callback?: Function): Promise<boolean | void>;
 export {
   Hint,
   IndexHint,