feat(aurelia): add preliminary enhance api

This is based on the new view engine’s enhance api. This api probably
won’t change though the view engine’s api which is used by it may.

Author: EisenbergEffect

dist/amd/aurelia-framework.d.ts

@@ -101,10 +101,20 @@ declare module 'aurelia-framework' {
        */
     start(): Promise<Aurelia>;
 
+    /**
+       * Enhances the host's existing elements with behaviors and bindings.
+       *
+       * @method enhance
+       * @param {Object} bindingContext A binding context for the enhanced elements.
+       * @param {string|Object} applicationHost The DOM object that Aurelia will attach to.
+       * @return {Promise<Aurelia>} Returns the current Aurelia instance.
+       */
+    enhance(bindingContext?: Object, applicationHost?: any): Promise<Aurelia>;
+    
     /**
        * Instantiates the root view-model and view and add them to the DOM.
        *
-       * @method withSingleton
+       * @method setRoot
        * @param {Object} root The root view-model to load upon bootstrap.
        * @param {string|Object} applicationHost The DOM object that Aurelia will attach to.
        * @return {Promise<Aurelia>} Returns the current Aurelia instance.

dist/amd/aurelia-framework.js

@@ -219,25 +219,33 @@ define(['exports', 'core-js', 'aurelia-logging', 'aurelia-metadata', 'aurelia-de
       });
     };
 
-    Aurelia.prototype.setRoot = function setRoot() {
+    Aurelia.prototype.enhance = function enhance() {
       var _this3 = this;
 
+      var bindingContext = arguments[0] === undefined ? {} : arguments[0];
+      var applicationHost = arguments[1] === undefined ? null : arguments[1];
+
+      this._configureHost(applicationHost);
+
+      return new Promise(function (resolve) {
+        var viewEngine = _this3.container.get(_aureliaTemplating.ViewEngine);
+        _this3.root = viewEngine.enhance(_this3.container, _this3.host, _this3.resources, bindingContext);
+        _this3.root.attached();
+        _this3._onAureliaComposed();
+        return _this3;
+      });
+    };
+
+    Aurelia.prototype.setRoot = function setRoot() {
+      var _this4 = this;
+
       var root = arguments[0] === undefined ? 'app' : arguments[0];
       var applicationHost = arguments[1] === undefined ? null : arguments[1];
 
       var compositionEngine,
           instruction = {};
 
-      applicationHost = applicationHost || this.host;
-
-      if (!applicationHost || typeof applicationHost == 'string') {
-        this.host = document.getElementById(applicationHost || 'applicationHost') || document.body;
-      } else {
-        this.host = applicationHost;
-      }
-
-      this.host.aurelia = this;
-      this.container.registerInstance(_aureliaTemplating.DOMBoundary, this.host);
+      this._configureHost(applicationHost);
 
       compositionEngine = this.container.get(_aureliaTemplating.CompositionEngine);
       instruction.viewModel = root;
@@ -247,16 +255,33 @@ define(['exports', 'core-js', 'aurelia-logging', 'aurelia-metadata', 'aurelia-de
       instruction.host = this.host;
 
       return compositionEngine.compose(instruction).then(function (root) {
-        _this3.root = root;
+        _this4.root = root;
         instruction.viewSlot.attached();
-        var evt = new window.CustomEvent('aurelia-composed', { bubbles: true, cancelable: true });
-        setTimeout(function () {
-          return document.dispatchEvent(evt);
-        }, 1);
-        return _this3;
+        _this4._onAureliaComposed();
+        return _this4;
       });
     };
 
+    Aurelia.prototype._configureHost = function _configureHost(applicationHost) {
+      applicationHost = applicationHost || this.host;
+
+      if (!applicationHost || typeof applicationHost == 'string') {
+        this.host = document.getElementById(applicationHost || 'applicationHost') || document.body;
+      } else {
+        this.host = applicationHost;
+      }
+
+      this.host.aurelia = this;
+      this.container.registerInstance(_aureliaTemplating.DOMBoundary, this.host);
+    };
+
+    Aurelia.prototype._onAureliaComposed = function _onAureliaComposed() {
+      var evt = new window.CustomEvent('aurelia-composed', { bubbles: true, cancelable: true });
+      setTimeout(function () {
+        return document.dispatchEvent(evt);
+      }, 1);
+    };
+
     return Aurelia;
   })();
 

dist/aurelia-framework.d.ts

@@ -101,10 +101,20 @@ declare module 'aurelia-framework' {
        */
     start(): Promise<Aurelia>;
 
+    /**
+       * Enhances the host's existing elements with behaviors and bindings.
+       *
+       * @method enhance
+       * @param {Object} bindingContext A binding context for the enhanced elements.
+       * @param {string|Object} applicationHost The DOM object that Aurelia will attach to.
+       * @return {Promise<Aurelia>} Returns the current Aurelia instance.
+       */
+    enhance(bindingContext?: Object, applicationHost?: any): Promise<Aurelia>;
+    
     /**
        * Instantiates the root view-model and view and add them to the DOM.
        *
-       * @method withSingleton
+       * @method setRoot
        * @param {Object} root The root view-model to load upon bootstrap.
        * @param {string|Object} applicationHost The DOM object that Aurelia will attach to.
        * @return {Promise<Aurelia>} Returns the current Aurelia instance.

dist/aurelia-framework.js

@@ -271,27 +271,38 @@ export class Aurelia {
     });
   }
 
+  /**
+   * Enhances the host's existing elements with behaviors and bindings.
+   *
+   * @method enhance
+   * @param {Object} bindingContext A binding context for the enhanced elements.
+   * @param {string|Object} applicationHost The DOM object that Aurelia will attach to.
+   * @return {Promise<Aurelia>} Returns the current Aurelia instance.
+   */
+  enhance(bindingContext:Object={}, applicationHost=null):Promise<Aurelia>{
+    this._configureHost(applicationHost);
+
+    return new Promise((resolve) => {
+      let viewEngine = this.container.get(ViewEngine);
+      this.root = viewEngine.enhance(this.container, this.host, this.resources, bindingContext);
+      this.root.attached();
+      this._onAureliaComposed();
+      return this;
+    });
+  }
+
   /**
    * Instantiates the root view-model and view and add them to the DOM.
    *
-   * @method withSingleton
+   * @method setRoot
    * @param {Object} root The root view-model to load upon bootstrap.
    * @param {string|Object} applicationHost The DOM object that Aurelia will attach to.
    * @return {Promise<Aurelia>} Returns the current Aurelia instance.
    */
   setRoot(root:string='app', applicationHost=null):Promise<Aurelia>{
     var compositionEngine, instruction = {};
 
-    applicationHost = applicationHost || this.host;
-
-    if (!applicationHost || typeof applicationHost == 'string') {
-      this.host = document.getElementById(applicationHost || 'applicationHost') || document.body;
-    } else {
-      this.host = applicationHost;
-    }
-
-    this.host.aurelia = this;
-    this.container.registerInstance(DOMBoundary, this.host);
+    this._configureHost(applicationHost);
 
     compositionEngine = this.container.get(CompositionEngine);
     instruction.viewModel = root;
@@ -303,11 +314,28 @@ export class Aurelia {
     return compositionEngine.compose(instruction).then(root => {
       this.root = root;
       instruction.viewSlot.attached();
-      var evt = new window.CustomEvent('aurelia-composed', { bubbles: true, cancelable: true });
-      setTimeout(() => document.dispatchEvent(evt), 1);
+      this._onAureliaComposed();
       return this;
     });
   }
+
+  _configureHost(applicationHost){
+    applicationHost = applicationHost || this.host;
+
+    if (!applicationHost || typeof applicationHost == 'string') {
+      this.host = document.getElementById(applicationHost || 'applicationHost') || document.body;
+    } else {
+      this.host = applicationHost;
+    }
+
+    this.host.aurelia = this;
+    this.container.registerInstance(DOMBoundary, this.host);
+  }
+
+  _onAureliaComposed(){
+    var evt = new window.CustomEvent('aurelia-composed', { bubbles: true, cancelable: true });
+    setTimeout(() => document.dispatchEvent(evt), 1);
+  }
 }
 
 /**

dist/commonjs/aurelia-framework.d.ts

@@ -101,10 +101,20 @@ declare module 'aurelia-framework' {
        */
     start(): Promise<Aurelia>;
 
+    /**
+       * Enhances the host's existing elements with behaviors and bindings.
+       *
+       * @method enhance
+       * @param {Object} bindingContext A binding context for the enhanced elements.
+       * @param {string|Object} applicationHost The DOM object that Aurelia will attach to.
+       * @return {Promise<Aurelia>} Returns the current Aurelia instance.
+       */
+    enhance(bindingContext?: Object, applicationHost?: any): Promise<Aurelia>;
+    
     /**
        * Instantiates the root view-model and view and add them to the DOM.
        *
-       * @method withSingleton
+       * @method setRoot
        * @param {Object} root The root view-model to load upon bootstrap.
        * @param {string|Object} applicationHost The DOM object that Aurelia will attach to.
        * @return {Promise<Aurelia>} Returns the current Aurelia instance.

dist/commonjs/aurelia-framework.js

@@ -234,25 +234,33 @@ var Aurelia = (function () {
     });
   };
 
-  Aurelia.prototype.setRoot = function setRoot() {
+  Aurelia.prototype.enhance = function enhance() {
     var _this3 = this;
 
+    var bindingContext = arguments[0] === undefined ? {} : arguments[0];
+    var applicationHost = arguments[1] === undefined ? null : arguments[1];
+
+    this._configureHost(applicationHost);
+
+    return new Promise(function (resolve) {
+      var viewEngine = _this3.container.get(_aureliaTemplating.ViewEngine);
+      _this3.root = viewEngine.enhance(_this3.container, _this3.host, _this3.resources, bindingContext);
+      _this3.root.attached();
+      _this3._onAureliaComposed();
+      return _this3;
+    });
+  };
+
+  Aurelia.prototype.setRoot = function setRoot() {
+    var _this4 = this;
+
     var root = arguments[0] === undefined ? 'app' : arguments[0];
     var applicationHost = arguments[1] === undefined ? null : arguments[1];
 
     var compositionEngine,
         instruction = {};
 
-    applicationHost = applicationHost || this.host;
-
-    if (!applicationHost || typeof applicationHost == 'string') {
-      this.host = document.getElementById(applicationHost || 'applicationHost') || document.body;
-    } else {
-      this.host = applicationHost;
-    }
-
-    this.host.aurelia = this;
-    this.container.registerInstance(_aureliaTemplating.DOMBoundary, this.host);
+    this._configureHost(applicationHost);
 
     compositionEngine = this.container.get(_aureliaTemplating.CompositionEngine);
     instruction.viewModel = root;
@@ -262,16 +270,33 @@ var Aurelia = (function () {
     instruction.host = this.host;
 
     return compositionEngine.compose(instruction).then(function (root) {
-      _this3.root = root;
+      _this4.root = root;
       instruction.viewSlot.attached();
-      var evt = new window.CustomEvent('aurelia-composed', { bubbles: true, cancelable: true });
-      setTimeout(function () {
-        return document.dispatchEvent(evt);
-      }, 1);
-      return _this3;
+      _this4._onAureliaComposed();
+      return _this4;
     });
   };
 
+  Aurelia.prototype._configureHost = function _configureHost(applicationHost) {
+    applicationHost = applicationHost || this.host;
+
+    if (!applicationHost || typeof applicationHost == 'string') {
+      this.host = document.getElementById(applicationHost || 'applicationHost') || document.body;
+    } else {
+      this.host = applicationHost;
+    }
+
+    this.host.aurelia = this;
+    this.container.registerInstance(_aureliaTemplating.DOMBoundary, this.host);
+  };
+
+  Aurelia.prototype._onAureliaComposed = function _onAureliaComposed() {
+    var evt = new window.CustomEvent('aurelia-composed', { bubbles: true, cancelable: true });
+    setTimeout(function () {
+      return document.dispatchEvent(evt);
+    }, 1);
+  };
+
   return Aurelia;
 })();
 

dist/es6/aurelia-framework.d.ts

@@ -101,10 +101,20 @@ declare module 'aurelia-framework' {
        */
     start(): Promise<Aurelia>;
 
+    /**
+       * Enhances the host's existing elements with behaviors and bindings.
+       *
+       * @method enhance
+       * @param {Object} bindingContext A binding context for the enhanced elements.
+       * @param {string|Object} applicationHost The DOM object that Aurelia will attach to.
+       * @return {Promise<Aurelia>} Returns the current Aurelia instance.
+       */
+    enhance(bindingContext?: Object, applicationHost?: any): Promise<Aurelia>;
+    
     /**
        * Instantiates the root view-model and view and add them to the DOM.
        *
-       * @method withSingleton
+       * @method setRoot
        * @param {Object} root The root view-model to load upon bootstrap.
        * @param {string|Object} applicationHost The DOM object that Aurelia will attach to.
        * @return {Promise<Aurelia>} Returns the current Aurelia instance.