Renamed Add to define and added dispatch started event for provider

Author: djthorpe

js/controller.js

@@ -5,6 +5,13 @@ import View from './view';
 import Provider from './provider';
 import CopyPaste from './copypaste';
 
+/**
+ * Controller which acts as business logic between models, views and
+ * providers. In general, create a new controller using the New
+ * static method and then define properties of the controller. Call
+ * main to run the application.
+ * @class
+*/
 export default class Controller {
   constructor() {
     this.$providers = new Map();
@@ -28,7 +35,13 @@ export default class Controller {
     });
   }
 
-  Add(key, object) {
+  /**
+  * Define a view or provider for the controller. The object is then
+  * accessible as a property of the controller.
+  * @param {string} key - The name of the property
+  * @param {Provider|View} object - The object
+  */
+  define(key, object) {
     if (!key || this.$providers.has(key) || this.$views.has(key)) {
       throw Error(`Controller: Duplicate or invalid key ${key}`);
     }
@@ -47,6 +60,10 @@ export default class Controller {
     });
   }
 
+  /**
+  * Create and return a new controller
+  * @param {Controller} constructor - The constructor for the controller
+  */
   static New(constructor) {
     const C = constructor || Controller;
     if (C.prototype instanceof Controller) {

js/provider.js

@@ -7,6 +7,7 @@ import Emitter from './emitter';
 // CONSTANTS
 
 const EVENT_ROOT = 'mvc.provider';
+const EVENT_STARTED = `${EVENT_ROOT}.started`;
 const EVENT_COMPLETED = `${EVENT_ROOT}.completed`;
 const EVENT_ERROR = `${EVENT_ROOT}.error`;
 const EVENT_ADDED = `${EVENT_ROOT}.added`;
@@ -16,6 +17,10 @@ const EVENT_DELETED = `${EVENT_ROOT}.deleted`;
 // ////////////////////////////////////////////////////////////////////////////
 // PROVIDER CLASS
 
+/**
+ * Provider requests data from a remote endpoint.
+ * @class
+*/
 export default class Provider extends Emitter {
   constructor(constructor, origin) {
     super();
@@ -45,6 +50,7 @@ export default class Provider extends Emitter {
   $fetch(url, req) {
     let status;
     let changed = false;
+    this.dispatchEvent(EVENT_STARTED, this, this.$origin + url);
     fetch(this.$origin + url, req)
       .then((response) => {
         status = response;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@djthorpe/js-framework",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "Javascript UI Framework",
   "main": "dist/js/index.js",
   "scripts": {
@@ -17,7 +17,7 @@
     "registry": "https://npm.pkg.github.com"
   },
   "author": "David Thorpe",
-  "license": "ISC",
+  "license": "Apache",
   "bugs": {
     "url": "https://github.com/djthorpe/js-framework/issues"
   },