fix: export Logger and Spell (#126)

... to let users intercept lower level api calls

History.md

@@ -1,3 +1,8 @@
+1.5.1 / 2021-06-30
+==================
+
+  * fix: export Logger and Spell to let users intercept lower level api calls
+
 1.5.0 / 2021-06-30
 ==================
 

index.js

@@ -3,6 +3,8 @@
 const fs = require('fs').promises;
 const path = require('path');
 
+const Logger = require('./src/drivers/abstract/logger');
+const Spell = require('./src/spell');
 const Bone = require('./src/bone');
 const Collection = require('./src/collection');
 const DataTypes = require('./src/data_types');
@@ -242,6 +244,15 @@ const connect = async function connect(opts = {}) {
 };
 
 Object.assign(Realm.prototype, migrations, { DataTypes });
-Object.assign(Realm, { connect, Bone, Collection, DataTypes, sequelize, ...Hint });
+Object.assign(Realm, {
+  connect,
+  Bone,
+  Collection,
+  DataTypes,
+  Logger,
+  Spell,
+  sequelize,
+  ...Hint,
+});
 
 module.exports = Realm;

src/drivers/abstract/index.js

@@ -10,7 +10,8 @@ const Logger = require('./logger');
 
 module.exports = class AbstractDriver {
   constructor(opts = {}) {
-    this.logger = new Logger(opts.logger);
+    const { logger } = opts;
+    this.logger = logger instanceof Logger ? logger : new Logger(logger);
   }
 
   /**

src/drivers/mysql/spellbook.js

@@ -54,5 +54,8 @@ module.exports = {
 
     return `ON DUPLICATE KEY UPDATE ${sets.join(', ')}`;
   },
-  formatReturning() { return ''; },
+
+  formatReturning() {
+    return '';
+  },
 };

src/spell.js

@@ -200,7 +200,7 @@ function parseLogicalObjectCondition(name, value) {
 }
 
 /**
- * parse conditions in MongoDB style, which is quite polular in ORMs for JavaScript. See {@link module:lib/spell~OPERATOR_MAP} for supported `$op`s.
+ * parse conditions in MongoDB style, which is quite polular in ORMs for JavaScript. See {@link module:src/spell~OPERATOR_MAP} for supported `$op`s.
  * @example
  * { foo: null }
  * { foo: { $gt: new Date(2012, 4, 15) } }
@@ -280,10 +280,10 @@ function parseSelect(spell, ...names) {
 
 /**
  * Translate key-value pairs of attributes into key-value pairs of columns. Get ready for the SET part when generating SQL.
- * @param {Spell} spell 
+ * @param {Spell} spell
  * @param {Object} obj - key-value pairs of attributes
  * @param {boolean} strict - check attribute exist or not
- * @returns 
+ * @returns
  */
 function formatValueSet(spell, obj, strict = true) {
   const { Model } = spell;
@@ -296,7 +296,7 @@ function formatValueSet(spell, obj, strict = true) {
         continue;
       }
     }
-    
+
     // raw sql don't need to uncast
     if (obj[name] && obj[name].__raw) {
       sets[name] = obj[name];

test/unit/drivers/abstract/index.test.js

@@ -2,6 +2,7 @@
 
 const assert = require('assert').strict;
 const dayjs = require('dayjs');
+const { Logger } = require('../../../..');
 const AbstractDriver = require('../../../../src/drivers/abstract');
 
 describe('=> AbstractDriver', function() {
@@ -33,3 +34,18 @@ describe('=> AbstractDriver', function() {
     assert.ok(date instanceof Date);
   });
 });
+
+describe('=> AbstractDriver#logger', function() {
+  it('should create logger by default', async function() {
+    const driver = new AbstractDriver();
+    assert.ok(driver.logger);
+    assert.ok(driver.logger instanceof Logger);
+  });
+
+  it('should accept custom logger', async function() {
+    class CustomLogger extends Logger {};
+    const driver = new AbstractDriver({ logger: new CustomLogger });
+    assert.ok(driver.logger);
+    assert.ok(driver.logger instanceof CustomLogger);
+  });
+});

test/unit/realm.test.js

@@ -2,7 +2,7 @@
 
 const assert = require('assert').strict;
 const Realm = require('../..');
-const { connect, Bone, DataTypes } = Realm;
+const { connect, Bone, DataTypes, Logger, Spell } = Realm;
 
 const attributes = {
   id: DataTypes.BIGINT,
@@ -35,6 +35,8 @@ describe('=> Realm', () => {
     assert.ok(connect);
     assert.ok(Bone);
     assert.ok(DataTypes);
+    assert.ok(Logger);
+    assert.ok(Spell);
   });
 
   it('should not subclass Bone unless asked specifically', async () => {
@@ -242,7 +244,7 @@ describe('=> Realm', () => {
     });
   });
 
-  describe('transaction', () => {
+  describe('realm.transaction', () => {
     it('realm.transaction generator callback should work', async () => {
       const queries = [];
       const email = 'lighting@valhalla.ne';