feat($imports): disallow default imports

jsdevtom · jsdevtom · commit 9442dab2e4c8 · 2018-05-16T10:30:49.000+02:00
BREAKING CHANGE: imports
diff --git a/src/almanac.ts b/src/almanac.ts
@@ -1,8 +1,8 @@
-import Fact from './fact'
+import {Fact} from './fact'
 import { UndefinedFactError } from './errors'
 
-import selectn from 'selectn'
-import debug0 from 'debug'
+const selectn = require('selectn')
+import * as debug0 from 'debug'
 
 let debug = debug0('json-rules-engine')
 let verbose = debug0('json-rules-engine-verbose')
@@ -16,7 +16,7 @@ export type FactMap = Map<string, Fact>
  * Triggers fact computations and saves the results
  * A new almanac is used for every engine run()
  */
-export default class Almanac {
+export class Almanac {
     factResultsCache: Map<string, any>
     factMap: FactMap
 
@@ -83,7 +83,7 @@ export default class Almanac {
         if (path) {
             return factValuePromise.then(factValue => {
                 if (factValue && isObjectLike(factValue)) {
-                    let pathValue = selectn<Function>(path)!(factValue)
+                    let pathValue = selectn(path)(factValue)
                     debug(
                         `condition::evaluate extracting object property ${path}, received: ${pathValue}`,
                     )
diff --git a/src/condition.ts b/src/condition.ts
@@ -1,9 +1,9 @@
-import debug0 from 'debug'
+import * as debug0 from 'debug'
 
 const debug = debug0('json-rules-engine')
-import isObjectLike from 'lodash.isobjectlike'
-import Almanac from './almanac'
-import Operator from './operator'
+const isObjectLike = require('lodash.isobjectlike')
+import {Almanac}from './almanac'
+import {Operator} from './operator'
 import {ToJsonAble} from './to-json-able.interface'
 
 export interface ICouldHavePriority {
@@ -29,7 +29,7 @@ export interface BaseCondition extends ICouldHavePriority {
     all?: BaseCondition[]
 }
 
-export default class Condition implements ICouldHavePriority, ToJsonAble {
+export class Condition implements ICouldHavePriority, ToJsonAble {
 
     priority?: number | string
     value: any
diff --git a/src/engine-default-operators.ts b/src/engine-default-operators.ts
@@ -1,15 +1,15 @@
-import Operator from './operator'
+import {Operator} from './operator'
 
-let Operators: Operator[] = []
-Operators.push(new Operator('equal', (a: any, b: any) => a === b))
-Operators.push(new Operator('notEqual', (a: any, b: any) => a !== b))
-Operators.push(new Operator('in', (a: any, b: any) => b.indexOf(a) > -1))
-Operators.push(new Operator('notIn', (a: any, b: any) => b.indexOf(a) === -1))
+export const defaultOperators: Operator[] = []
+defaultOperators.push(new Operator('equal', (a: any, b: any) => a === b))
+defaultOperators.push(new Operator('notEqual', (a: any, b: any) => a !== b))
+defaultOperators.push(new Operator('in', (a: any, b: any) => b.indexOf(a) > -1))
+defaultOperators.push(new Operator('notIn', (a: any, b: any) => b.indexOf(a) === -1))
 
-Operators.push(
+defaultOperators.push(
   new Operator('contains', (a: any, b: any) => a.indexOf(b) > -1, Array.isArray),
 )
-Operators.push(
+defaultOperators.push(
   new Operator(
     'doesNotContain',
     (a: any, b: any) => a.indexOf(b) === -1,
@@ -20,21 +20,19 @@ Operators.push(
 function numberValidator (factValue: string) {
     return Number.parseFloat(factValue).toString() !== 'NaN'
 }
-Operators.push(
+defaultOperators.push(
   new Operator('lessThan', (a: any, b: any) => a < b, numberValidator),
 )
-Operators.push(
+defaultOperators.push(
   new Operator('lessThanInclusive', (a: any, b: any) => a <= b, numberValidator),
 )
-Operators.push(
+defaultOperators.push(
   new Operator('greaterThan', (a: any, b: any) => a > b, numberValidator),
 )
-Operators.push(
+defaultOperators.push(
   new Operator(
     'greaterThanInclusive',
     (a: any, b: any) => a >= b,
     numberValidator,
   ),
 )
-
-export default Operators
diff --git a/src/engine.ts b/src/engine.ts
@@ -1,10 +1,10 @@
-import Fact, {FactOptions} from './fact'
-import Rule, {RuleConstructorOptions} from './rule'
-import Operator from './operator'
-import Almanac from './almanac'
+import {Fact, FactOptions} from './fact'
+import {Rule} from './rule'
+import {Operator} from './operator'
+import {Almanac} from './almanac'
 import { EventEmitter } from 'events'
 import { SuccessEventFact } from './engine-facts'
-import defaultOperators from './engine-default-operators'
+import {defaultOperators} from './engine-default-operators'
 
 let debug = require('debug')('json-rules-engine')
 
@@ -17,7 +17,7 @@ export enum EngineStatus {
     FINISHED = 'FINISHED',
 }
 
-class Engine extends EventEmitter {
+export class Engine extends EventEmitter {
     rules: Rule[]
     allowUndefinedFacts: boolean
     operators: Map<string, Operator>
@@ -281,5 +281,3 @@ class Engine extends EventEmitter {
         })
     }
 }
-
-export default Engine
diff --git a/src/fact.ts b/src/fact.ts
@@ -1,16 +1,16 @@
-import hash from 'object-hash'
-import debug from 'debug'
-import deepClone from 'clone'
+import * as hash from 'object-hash'
+import * as debug from 'debug'
+import * as deepClone from 'clone'
 
-import Almanac from './almanac'
+import {Almanac} from './almanac'
 let verbose = debug('json-rules-engine-verbose')
 
 export interface FactOptions {
     cache?: boolean
     priority?: number
 }
 
-class Fact {
+export class Fact {
     static CONSTANT = 'CONSTANT'
     static DYNAMIC = 'DYNAMIC'
 
@@ -129,5 +129,3 @@ class Fact {
         }
     }
 }
-
-export default Fact
diff --git a/src/index.ts b/src/index.ts
@@ -1,9 +1 @@
-import json_rules_engine, {
-  Fact,
-  Rule,
-  Operator,
-  Engine,
-} from './truegin'
-
-export default json_rules_engine
-export { Fact, Rule, Operator, Engine }
+export * from './'
diff --git a/src/operator.ts b/src/operator.ts
@@ -14,7 +14,7 @@ export interface CustomOperator {
     evaluate (factValue: any, jsonValue: any): boolean
 }
 
-export default class Operator implements CustomOperator {
+export class Operator implements CustomOperator {
     cb: (factValue: any, jsonvalue: any) => boolean
     name: string
     factValueValidator: FactValueValidator
diff --git a/src/rule-result.ts b/src/rule-result.ts
@@ -1,9 +1,9 @@
-import deepClone from 'clone'
-import Condition, {BaseCondition} from './condition'
+import * as deepClone from 'clone'
+import {Condition} from './condition'
 import {Action} from './action.interface'
 import {ToJsonAble} from './to-json-able.interface'
 
-export default class RuleResult implements ToJsonAble {
+export class RuleResult implements ToJsonAble {
     conditions: Condition
     event?: Action
     priority?: string | number | null
diff --git a/src/rule.ts b/src/rule.ts
@@ -1,9 +1,9 @@
-import Condition, {ConditionConstructorOptions, ICouldHavePriority} from './condition'
-import RuleResult from './rule-result'
-import { EventEmitter } from 'events'
+import {Condition, ConditionConstructorOptions, ICouldHavePriority} from './condition'
+import {RuleResult} from './rule-result'
+import {EventEmitter} from 'events'
 import {Action} from './action.interface'
-import Engine from './engine'
-import Almanac from './almanac'
+import {Engine} from './engine'
+import {Almanac} from './almanac'
 
 let debug = require('debug')('json-rules-engine')
 
@@ -13,7 +13,7 @@ export interface RuleConstructorOptions {
     priority?: number | string,
 }
 
-class Rule extends EventEmitter implements ICouldHavePriority {
+export class Rule extends EventEmitter implements ICouldHavePriority {
 
     priority?: number
     conditions?: Condition
@@ -307,5 +307,3 @@ class Rule extends EventEmitter implements ICouldHavePriority {
         }
     }
 }
-
-export default Rule
diff --git a/src/truegin.ts b/src/truegin.ts
@@ -1,9 +1,9 @@
-import Engine, {EngineOptions} from './engine'
-import Fact from './fact'
-import Rule from './rule'
-import Operator from './operator'
+import {Engine, EngineOptions} from './engine'
+import {Fact} from './fact'
+import {Rule} from './rule'
+import {Operator} from './operator'
 
 export { Fact, Rule, Operator, Engine }
-export default function (rules?: Rule[], options?: EngineOptions) {
+export function engineFactory (rules?: Rule[], options?: EngineOptions) {
     return new Engine(rules, options)
 }
diff --git a/test/almanac.test.ts b/test/almanac.test.ts
@@ -1,5 +1,5 @@
-import { Fact } from '../src/index'
-import Almanac from '../src/almanac'
+import {Fact} from '../src/fact'
+import {Almanac} from '../src/almanac'
 
 describe('Almanac', () => {
     let almanac: Almanac
@@ -12,20 +12,20 @@ describe('Almanac', () => {
         })
 
         test('adds runtime facts', () => {
-            almanac = new Almanac(new Map(), { modelId: 'XYZ' })
+            almanac = new Almanac(new Map(), {modelId: 'XYZ'})
             expect(almanac.factMap.get('modelId')!.value).toBe('XYZ')
         })
     })
 
     describe('constructor', () => {
         test('supports runtime facts as key => values', async () => {
-            almanac = new Almanac(new Map(), { fact1: 3 })
+            almanac = new Almanac(new Map(), {fact1: 3})
             expect(await almanac.factValue('fact1')).toBe(3)
         })
 
         test('supports runtime fact instances', async () => {
             let fact = new Fact('fact1', 3)
-            almanac = new Almanac(new Map(), { fact1: fact })
+            almanac = new Almanac(new Map(), {fact1: fact})
             expect(await almanac.factValue('fact1')).toBe(fact.value)
         })
     })
@@ -46,7 +46,7 @@ describe('Almanac', () => {
         })
 
         test('allows parameters to be passed to the fact', async () => {
-            expect(await almanac.factValue('foo', { userId: 1 })).toBe(1)
+            expect(await almanac.factValue('foo', {userId: 1})).toBe(1)
         })
 
         test('throws an exception if it encounters an undefined fact', async () => {
@@ -95,6 +95,7 @@ describe('Almanac', () => {
             facts.set(fact.id, fact)
             almanac = new Almanac(facts)
         }
+
         let fact: any
         const FACT_VALUE = 2
 
@@ -105,7 +106,7 @@ describe('Almanac', () => {
         })
 
         test('honors facts with caching disabled', (done) => {
-            setup(new Fact('id', 1, { cache: false }))
+            setup(new Fact('id', 1, {cache: false}))
             let promise = almanac._setFactValue(fact, {}, FACT_VALUE)
             expect(almanac.factResultsCache.values().next().value).toBeUndefined()
             promise.then(value => expect(value).toBe(FACT_VALUE)).then(_ => done()).catch(done)
@@ -125,15 +126,15 @@ describe('Almanac', () => {
         }
 
         test('evaluates the fact every time when fact caching is off', () => {
-            setup({ cache: false })
+            setup({cache: false})
             almanac.factValue('foo')
             almanac.factValue('foo')
             almanac.factValue('foo')
             expect(factSpy).toHaveBeenCalledTimes(3)
         })
 
         test('evaluates the fact once when fact caching is on', () => {
-            setup({ cache: true })
+            setup({cache: true})
             almanac.factValue('foo')
             almanac.factValue('foo')
             almanac.factValue('foo')
diff --git a/test/condition.test.ts b/test/condition.test.ts
@@ -1,7 +1,7 @@
-import Condition from '../src/condition'
-import defaultOperators from '../src/engine-default-operators'
-import Almanac from '../src/almanac'
-import Fact from '../src/fact'
+import {Condition} from '../src/condition'
+import {defaultOperators} from '../src/engine-default-operators'
+import {Almanac} from '../src/almanac'
+import {Fact} from '../src/fact'
 import { conditionFactory } from './support/condition-factory'
 
 let operators = new Map()
diff --git a/test/engine-all.test.ts b/test/engine-all.test.ts
@@ -1,6 +1,6 @@
-import engineFactory from '../src/index'
 import { ruleFactory } from './support/rule-factory'
-import Engine from '../src/engine'
+import {Engine} from '../src/engine'
+import {engineFactory} from '../src/truegin'
 
 async function factSenior () {
     return 65
diff --git a/test/engine-any.test.ts b/test/engine-any.test.ts
@@ -1,6 +1,6 @@
-import engineFactory from '../src/index'
 import { ruleFactory } from './support/rule-factory'
-import Engine from '../src/engine'
+import {Engine} from '../src/engine'
+import {engineFactory} from '../src/truegin'
 
 describe('Engine: "any" conditions', () => {
     let engine: Engine
diff --git a/test/engine-cache.test.ts b/test/engine-cache.test.ts
@@ -1,6 +1,6 @@
 import engineFactory from '../src/index'
 import { ruleFactory } from './support/rule-factory'
-import Engine from '../src/engine'
+import {Engine} from '../src/engine'
 import {FactOptions} from '../src/fact'
 
 describe('Engine: cache', () => {
diff --git a/test/engine-event.test.ts b/test/engine-event.test.ts
@@ -1,8 +1,8 @@
-import engineFactory from '../src/index'
-import Almanac from '../src/almanac'
+import {Almanac} from '../src/almanac'
 
-import { ruleFactory } from './support/rule-factory'
-import Engine from '../src/engine'
+import {ruleFactory} from './support/rule-factory'
+import {Engine} from '../src/engine'
+import {engineFactory} from '../src/truegin'
 
 describe('Engine: event', () => {
     let engine: Engine
diff --git a/test/engine.test.ts b/test/engine.test.ts
@@ -1,6 +1,9 @@
-import engineFactory, { Fact, Rule, Operator } from '../src/index'
 import { ruleFactory } from './support/rule-factory'
-import Engine from '../src/engine'
+import {Engine} from '../src/engine'
+import {Rule} from '../src/rule'
+import {Fact} from '../src/fact'
+import {Operator} from '../src/operator'
+import {engineFactory} from '../src/truegin'
 
 describe('Engine', () => {
     let engine: Engine
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/tslint.json b/tslint.json

Original file line number	Diff line number	Diff line change
`@@ -1,16 +1,16 @@`
`1`		`-import hash from 'object-hash'`
`2`		`-import debug from 'debug'`
`3`		`-import deepClone from 'clone'`
	`1`	`+import * as hash from 'object-hash'`
	`2`	`+import * as debug from 'debug'`
	`3`	`+import * as deepClone from 'clone'`
`4`	`4`
`5`		`-import Almanac from './almanac'`
	`5`	`+import {Almanac} from './almanac'`
`6`	`6`	`let verbose = debug('json-rules-engine-verbose')`
`7`	`7`
`8`	`8`	`export interface FactOptions {`
`9`	`9`	`cache?: boolean`
`10`	`10`	`priority?: number`
`11`	`11`	`}`
`12`	`12`
`13`		`-class Fact {`
	`13`	`+export class Fact {`
`14`	`14`	`static CONSTANT = 'CONSTANT'`
`15`	`15`	`static DYNAMIC = 'DYNAMIC'`
`16`	`16`
`@@ -129,5 +129,3 @@ class Fact {`
`129`	`129`	`}`
`130`	`130`	`}`
`131`	`131`	`}`
`132`		`-`
`133`		`-export default Fact`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ export interface CustomOperator {`
`14`	`14`	`evaluate (factValue: any, jsonValue: any): boolean`
`15`	`15`	`}`
`16`	`16`
`17`		`-export default class Operator implements CustomOperator {`
	`17`	`+export class Operator implements CustomOperator {`
`18`	`18`	`cb: (factValue: any, jsonvalue: any) => boolean`
`19`	`19`	`name: string`
`20`	`20`	`factValueValidator: FactValueValidator`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`		`-import Condition, {ConditionConstructorOptions, ICouldHavePriority} from './condition'`
`2`		`-import RuleResult from './rule-result'`
`3`		`-import { EventEmitter } from 'events'`
	`1`	`+import {Condition, ConditionConstructorOptions, ICouldHavePriority} from './condition'`
	`2`	`+import {RuleResult} from './rule-result'`
	`3`	`+import {EventEmitter} from 'events'`
`4`	`4`	`import {Action} from './action.interface'`
`5`		`-import Engine from './engine'`
`6`		`-import Almanac from './almanac'`
	`5`	`+import {Engine} from './engine'`
	`6`	`+import {Almanac} from './almanac'`
`7`	`7`
`8`	`8`	`let debug = require('debug')('json-rules-engine')`
`9`	`9`
`@@ -13,7 +13,7 @@ export interface RuleConstructorOptions {`
`13`	`13`	`priority?: number \| string,`
`14`	`14`	`}`
`15`	`15`
`16`		`-class Rule extends EventEmitter implements ICouldHavePriority {`
	`16`	`+export class Rule extends EventEmitter implements ICouldHavePriority {`
`17`	`17`
`18`	`18`	`priority?: number`
`19`	`19`	`conditions?: Condition`
`@@ -307,5 +307,3 @@ class Rule extends EventEmitter implements ICouldHavePriority {`
`307`	`307`	`}`
`308`	`308`	`}`
`309`	`309`	`}`
`310`		`-`
`311`		`-export default Rule`