Updated documentation

Author: djthorpe

README.md

@@ -11,37 +11,38 @@ implementation which provides the following classes:
 It uses [Bootstrap](https://getbootstrap.com/) to implement the underlying user 
 interface, adding a few components.
 
-## Clone, Build, Release
+## Use
 
-You'll need to use `npm` to install as a dependency in your module. Here is what
-I do on my Mac which has homebrew installed:
+Add the framework as a dependency in your project:
 
 ```bash
-[bash] brew install npm
-[bash] cd $PROJECTS
-[bash] git clone git@github.com:djthorpe/js-framework.git
-[bash] cd js-framework
-[bash] npm install
-[bash] npm build
+[bash] echo "@djthorpe:registry=https://npm.pkg.github.com" >> .npmrc
+[bash] npm install @djthorpe/js-framework
 ```
 
-This will place the files in the `dist` folder. There is a github action which
-runs on a new release to publish the package.
+Import assets and create a controller in your JavaScript:
 
-## Use
+```javascript
+import '@djthorpe/js-framework/dist/assets/fonts/bootstrap-icons.woff';
+import '@djthorpe/js-framework/dist/assets/fonts/bootstrap-icons.woff2';
 
-Use the framework as follows:
+// Controllers
+import { Controller } from '@djthorpe/js-framework';
 
-```bash
-[bash] brew install npm
-[bash] cd $PROJECTS
-[bash] git clone git@github.com:@owner/js-project.git
-[bash] cd js-project
-[bash] npm init
-[bash] echo "@djthorpe:registry=https://npm.pkg.github.com" >> .npmrc
-[bash] npm install @djthorpe/js-framework
+// Run application
+window.addEventListener('DOMContentLoaded', () => {
+  const jsframework = require('@djthorpe/js-framework');
+  const app = jsframework.Controller.New(Controller);
+  app.main();
+});
 ```
 
-## Class Reference
+In reality, you would subclass the `Controller` class, and create models, views
+and providers within the controller, then use `addEventListener` for each view
+and provider to react to events. More informaton is provided in the documentation.
+
+## Reference
+
+The reference is provided in the `dist/doc` folder in the published package, or at
+https://djthorpe.github.io/js-framework/
 
-The class reference is included in the `dist` folder of the module, and uses `jsdoc` in order to create from the Javascript source.

config/jsdoc.config.json

@@ -11,11 +11,7 @@
     "encoding": "utf8",
     "readme": "./README.md",
     "destination": "./dist/doc",
-    "recurse": true,
-    "template": "./node_modules/clean-jsdoc-theme",
-    "theme_opts": {
-        "theme": "light"
-    }    
+    "recurse": true
   },
   "plugins": [
     "./node_modules/@ckeditor/jsdoc-plugins/lib/export-fixer/export-fixer.js"

js/provider.js

@@ -4,7 +4,7 @@ import Error from './error';
 import Emitter from './emitter';
 
 // ////////////////////////////////////////////////////////////////////////////
-// CONSTANTS
+// EVENTS
 
 const EVENT_ROOT = 'mvc.provider';
 const EVENT_STARTED = `${EVENT_ROOT}.started`;
@@ -14,6 +14,59 @@ const EVENT_ADDED = `${EVENT_ROOT}.added`;
 const EVENT_CHANGED = `${EVENT_ROOT}.changed`;
 const EVENT_DELETED = `${EVENT_ROOT}.deleted`;
 
+/**
+ * Request start event, which is emitted when a request is initiated.
+ *
+ * @event mvc.provider.started
+ * @property {Provider} sender - The provider that emitted the event.
+ * @property {string} url - The url of the endpoint.
+ */
+
+/**
+ * Request completed event, which is emitted when a request is successfully completed.
+ *
+ * @event mvc.provider.completed
+ * @property {Provider} sender - The provider that emitted the event.
+ * @property {boolean} changed - When true, indicates that the request resulted in a change
+ *   to the objects stored in the provider.
+ */
+
+/**
+ * Request error event, which is emitted when a request is not completed successfully.
+ *
+ * @event mvc.provider.completed
+ * @property {Provider} sender - The provider that emitted the event.
+ * @property {Error} error - Provides the reason for the request not completing
+ *   successfully.
+ */
+
+/**
+ * Object added event, which is emitted when a request adds a new object to the provider.
+ *
+ * @event mvc.provider.added
+ * @property {Provider} sender - The provider that emitted the event.
+ * @property {Model} object - Provides the reason for the request not completing
+ *   successfully.
+ */
+
+/**
+ * Object changed event, which is emitted when a request replaces an existing object.
+ *
+ * @event mvc.provider.changed
+ * @property {Provider} sender - The provider that emitted the event.
+ * @property {Model} object - The object which has been added to the provider.
+ * @property {Model} existing - The object which has been replaced in the provider.
+*/
+
+/**
+ * Object deleted event, which is emitted when a request removes an object from
+ * the provider.
+ *
+ * @event mvc.provider.deleted
+ * @property {Provider} sender - The provider that emitted the event.
+ * @property {Model} object - The object which has been deleted from the provider.
+*/
+
 // ////////////////////////////////////////////////////////////////////////////
 // PROVIDER CLASS
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@djthorpe/js-framework",
-  "version": "0.0.19",
+  "version": "0.0.20",
   "description": "Javascript Framework",
   "main": "dist/js/index.js",
   "scripts": {
@@ -24,7 +24,6 @@
   "homepage": "https://github.com/djthorpe/js-framework#readme",
   "devDependencies": {
     "@ckeditor/jsdoc-plugins": "^24.4.2",
-    "clean-jsdoc-theme": "^3.2.4",
     "css-loader": "^5.2.2",
     "eslint": "^7.24.0",
     "eslint-config-airbnb-base": "^14.2.1",