[fix] enumerable app, and generics

Author: scott-wyatt

lib/Fabrix.ts

@@ -18,6 +18,7 @@ import { DatastoreSpool } from './common/spools/datastore'
 import { SystemSpool } from './common/spools/system'
 import { ToolSpool } from './common/spools/tool'
 import { MiscSpool } from './common/spools/misc'
+import { enumerable } from './common/decorators/enumerable'
 
 // inject Error and Resource types into the global namespace
 Core.assignGlobals()
@@ -30,7 +31,6 @@ export interface FabrixApp {
   [key: string]: any
 }
 export class FabrixApp extends EventEmitter {
-
   private _logger: LoggerProxy
   private _env: IEnv
   private _pkg: any // IPkg
@@ -137,43 +137,51 @@ export class FabrixApp extends EventEmitter {
     this.emit('fabrix:constructed')
   }
 
+  // @enumerable(false)
   get logger () {
     return this._logger
   }
 
+  // @enumerable(false)
   get env () {
     return this._env
   }
 
+  // @enumerable(false)
   get pkg () {
     return this._pkg
   }
 
+  // @enumerable(false)
   get versions () {
     return this._versions
   }
 
+  // @enumerable(false)
   get config () {
     return this._config
   }
 
   /**
    * Gets the package.json of the Fabrix module
    */
+  // @enumerable(false)
   get fabrix () {
     return this._fabrix
   }
 
   /**
    * Gets the Spools that have been installed
    */
+  // @enumerable(false)
   get spools () {
     return this._spools
   }
 
   /**
    *   Gets the api
    */
+  // @enumerable(false)
   get api () {
     return this._api
   }
@@ -182,6 +190,7 @@ export class FabrixApp extends EventEmitter {
    * Return the Fabrix logger
    * fires fabrix:log:* log events
    */
+  // @enumerable(false)
   get log () {
     return this.logger
   }
@@ -199,6 +208,7 @@ export class FabrixApp extends EventEmitter {
   /**
    * Gets the Api resources that have been set
    */
+  // @enumerable(false)
   get resources() {
     return this._resources
   }

lib/LoggerProxy.ts

@@ -38,17 +38,23 @@ import { FabrixApp } from './'
 // }
 
 export class LoggerProxy {
-  app: FabrixApp
-  warn
-  debug
-  info
-  error
-  silly
+  public app: FabrixApp
+  public warn
+  public debug
+  public info
+  public error
+  public silly
   /**
    * Instantiate Proxy; bind log events to default console.log
    */
   constructor (app: FabrixApp) {
-    this.app = app
+    Object.defineProperties(this, {
+      app: {
+        value: app,
+        writable: false,
+        enumerable: false
+      }
+    })
 
     this.app.on('fabrix:log', (level: string, msg: any[] = [ ]) => (
       console[level] || console.log)(level, ...msg)

lib/common/Controller.ts

@@ -2,18 +2,19 @@
 
 import { FabrixApp } from '../index'
 import { EventEmitter } from 'events'
+import { FabrixGeneric } from './Generic'
 
 /**
  * Fabrix Controller Class.
  */
-export class FabrixController {
-  private _app: FabrixApp
+export class FabrixController extends FabrixGeneric {
+  public app: FabrixApp
 
   constructor (app: FabrixApp) {
     if (!(app instanceof EventEmitter)) {
       throw new Error('The "app" argument must be of type EventEmitter')
     }
-    this._app = app
+    super(app)
     this.app.emit(`controller:${this.id}:constructed`, this)
   }
 
@@ -26,12 +27,6 @@ export class FabrixController {
     }
   }
 
-  // @enumerable(false)
-  // @writable(false)
-  get app(): FabrixApp {
-    return this._app
-  }
-
   /**
    * Return the id of this controller
    */

lib/common/Generic.ts

@@ -3,6 +3,15 @@ import { FabrixApp } from '../index'
  * Fabrix Generic Class.
  */
 export class FabrixGeneric {
+  public app: FabrixApp
   public methods: string[] = []
-  constructor (app: FabrixApp) {}
+  constructor (app: FabrixApp) {
+    Object.defineProperties(this, {
+      app: {
+        value: app,
+        writable: false,
+        enumerable: false
+      }
+    })
+  }
 }

lib/common/Model.ts

@@ -4,12 +4,25 @@ import { FabrixResolver } from './'
 import { IllegalAccessError } from '../errors'
 import { FabrixGeneric } from './Generic'
 
+// export interface FabrixModel {
+//   new(): FabrixModel
+//   config(app: FabrixApp, datastore?): {
+//     [key: string]: any,
+//     tableName?: string,
+//     store?: any,
+//     migrate?: string
+//   }
+//   schema(app: FabrixApp, datastore?): {
+//     [key: string]: any
+//   }
+//   resolver(): any
+// }
 
 /**
  * Fabrix Model Class.
  */
 export class FabrixModel extends FabrixGeneric {
-  private _app: FabrixApp
+  public app: FabrixApp
   private _datastore: any
   private _instance: any
   private _config: {[key: string]: any}
@@ -22,7 +35,7 @@ export class FabrixModel extends FabrixGeneric {
   /**
    * Model configuration
    */
-  public static config (app: FabrixApp, datastore?): {[key: string]: any} {
+  public static config (app: FabrixApp, datastore?) {
     return {
       tableName: null,
       store: null,
@@ -64,18 +77,13 @@ export class FabrixModel extends FabrixGeneric {
     if (!(app instanceof EventEmitter)) {
       throw new Error('The "app" argument must be of type EventEmitter')
     }
-    this._app = app
 
     this._datastore = datastore
 
     this.resolver = new (<typeof FabrixModel>this.constructor).resolver(this, datastore)
     this.app.emit(`model:${this.name}:constructed`, this)
   }
 
-  get app(): FabrixApp {
-    return this._app
-  }
-
   get datastore() {
     if (!this._datastore) {
       // This will throw an error if the logger is not set yet

lib/common/Policy.ts

@@ -9,7 +9,7 @@ import { FabrixGeneric } from './Generic'
  * Fabrix Policy Class.
  */
 export class FabrixPolicy extends FabrixGeneric {
-  private _app: FabrixApp
+  public app: FabrixApp
 
 
   /**
@@ -24,7 +24,6 @@ export class FabrixPolicy extends FabrixGeneric {
     if (!(app instanceof EventEmitter)) {
       throw new Error('The "app" argument must be of type EventEmitter')
     }
-    this._app = app
     this.app.emit(`policy:${this.id}:constructed`, this)
   }
 
@@ -37,12 +36,6 @@ export class FabrixPolicy extends FabrixGeneric {
     }
   }
 
-  // @enumerable(false)
-  // @writable(false)
-  get app(): FabrixApp {
-    return this._app
-  }
-
   /**
    * Return the id of this policy
    */

lib/common/Service.ts

@@ -9,15 +9,13 @@ import { FabrixGeneric } from './Generic'
  * Fabrix Service Class.
  */
 export class FabrixService extends FabrixGeneric {
-  private _app: FabrixApp
 
   constructor (app: FabrixApp) {
     super(app)
 
     if (!(app instanceof EventEmitter)) {
       throw new Error('The "app" argument must be of type EventEmitter')
     }
-    this._app = app
     this.app.emit(`service:${this.id}:constructed`, this)
   }
 
@@ -30,12 +28,6 @@ export class FabrixService extends FabrixGeneric {
     }
   }
 
-  // @enumerable(false)
-  // @writable(false)
-  get app(): FabrixApp {
-    return this._app
-  }
-
   /**
    * Return the id of this controller
    */

lib/common/Spool.ts

@@ -4,6 +4,7 @@ import { EventEmitter } from 'events'
 import { defaultsDeep, omit } from 'lodash'
 import { IApi, IPkg, ISpoolConfig, ILifecycle } from './index'
 import { FabrixApp } from '../index'
+import { FabrixGeneric } from './Generic'
 
 /**
  * @class Spool
@@ -12,9 +13,9 @@ import { FabrixApp } from '../index'
 export interface Spool {
   [key: string]: any
 }
-export class Spool {
+export class Spool extends FabrixGeneric {
+  public app: FabrixApp
   private _stage = 'pre'
-  private _app: FabrixApp
   private _config: ISpoolConfig
   private _pkg: any // IPkg
   private _api: IApi
@@ -93,14 +94,14 @@ export class Spool {
       api = { }
     }: { pkg?: any, config?: ISpoolConfig, api?: IApi }
   ) {
+    super(app)
     if (!(app instanceof EventEmitter)) {
       throw new Error('The "app" argument must be of type EventEmitter')
     }
     if (!pkg) {
       throw new Error('Spool is missing package definition ("spool.pkg")')
     }
 
-    this._app = app
     this._pkg = Object.freeze(pkg)
     this._api = api
 
@@ -124,10 +125,6 @@ export class Spool {
     return this._stage
   }
 
-  get app (): FabrixApp {
-    return this._app
-  }
-
   get api () {
     return this._api
   }