Updated to 0.0.11

Author: djthorpe

.github/workflows/publish.yaml

@@ -13,7 +13,7 @@ jobs:
         registry-url: 'https://npm.pkg.github.com'
         scope: '@djthorpe'
     - run: npm install
-    - run: npm run build
+    - run: npm run all
     - run: npm publish
       env:
         NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

config/jsdoc.config.json

@@ -0,0 +1,23 @@
+{
+  "source": {
+    "include": [
+      "js"
+    ],
+    "exclude": [
+      "node_modules"
+    ]
+  },
+  "opts": {
+    "encoding": "utf8",
+    "readme": "./README.md",
+    "destination": "./dist/doc",
+    "recurse": true,
+    "template": "./node_modules/clean-jsdoc-theme",
+    "theme_opts": {
+        "theme": "light"
+    }    
+  },
+  "plugins": [
+    "./node_modules/@ckeditor/jsdoc-plugins/lib/export-fixer/export-fixer.js"
+  ]
+}

config/webpack.config.js

@@ -21,6 +21,9 @@ module.exports = {
       {
         test: /\.(woff|woff2|eot|ttf|otf)$/i,
         type: 'asset/resource',
+        generator: {
+          filename: 'assets/fonts/[name][ext][query]',
+        },
       },
     ],
   },

js/controller.js

@@ -22,8 +22,8 @@ export default class Controller {
       copypaste.addEventListener('mvc.copypaste.click', (sender, target) => {
         copypaste.clipboard = target.innerText;
       });
-      copypaste.addEventListener('mvc.copypaste.change', (sender) => {
-        console.log('copied');
+      copypaste.addEventListener('mvc.copypaste.change', () => {
+        console.log('TODO: copied');
       });
     });
   }

js/emitter.js

@@ -0,0 +1,44 @@
+/**
+ * Class to emit events to listener callbacks
+ * @class
+*/
+export default class Emitter {
+  /**
+  * Create an Emitter.
+  */
+  constructor() {
+    this.$listeners = new Map();
+  }
+
+  /**
+  * Add a listener for emitted events.
+  * @param {string[]} types - An array or string of the events to listen for.
+  * @param {function} fn - The callback when an event is emitted.
+  */
+  addEventListener(types, fn) {
+    if (Array.isArray(types)) {
+      types.forEach((type) => {
+        this.addEventListener(type, fn);
+      });
+    } else {
+      if (!this.$listeners.has(types)) {
+        this.$listeners.set(types, []);
+      }
+      this.$listeners.get(types).push(fn);
+    }
+  }
+
+  /**
+  * Dispatch an event to listeners with arguments.
+  * @param {string} type - The type of event to dispatch.
+  * @param {...*} args - The arguments to pass to the listener callback.
+  */
+  dispatchEvent(type, ...args) {
+    const listeners = this.$listeners.get(type);
+    if (listeners) {
+      listeners.forEach((fn) => {
+        fn(...args);
+      });
+    }
+  }
+}

js/events.js

@@ -15,7 +15,7 @@ import Form from './form';
 
 // Utils
 import Error from './error';
-import Emitter from './events';
+import Emitter from './emitter';
 import './string';
 
 // CSS and Fonts

js/index.js

@@ -32,24 +32,23 @@ export default class Model {
     this.$setall(data);
   }
 
-  static define(classConstructor, classProps) {
+  static define(classConstructor, classProps, className) {
     if (typeof classConstructor !== 'function') {
       throw new Error('Called define without a class constructor');
     }
-    const className = classConstructor.name;
-    if (Model.constructors[className]) {
-      throw new Error(`Class already defined ${className}`);
+    const classKey = className || classConstructor.name;
+    if (Model.constructors[classKey]) {
+      throw new Error(`Class already defined ${classKey}`);
     }
-    const proto = Model.$newproto(classConstructor, classProps);
+    const proto = Model.$newproto(classKey, classProps);
     if (!proto) {
-      throw new Error(`No prototype for ${className}`);
+      throw new Error(`No prototype for ${classKey}`);
     }
-    Model.constructors[className] = classConstructor;
-    Model.models[className] = proto;
+    Model.constructors[classKey] = classConstructor;
+    Model.models[classKey] = proto;
   }
 
-  static $newproto(classConstructor, classProps) {
-    const className = classConstructor.name;
+  static $newproto(className, classProps) {
     const proto = {};
 
     // $className property

js/model.js

@@ -1,7 +1,7 @@
 // Provider class to be subclassed by an actual provider
 
 import Error from './error';
-import Emitter from './events';
+import Emitter from './emitter';
 
 // ////////////////////////////////////////////////////////////////////////////
 // CONSTANTS
@@ -71,8 +71,11 @@ export default class Provider extends Emitter {
           if (this.$array(data)) {
             changed = true;
           }
-        } else if (this.$object(data)) {
-          changed = true;
+        } else {
+          const result = this.$object(data);
+          if (result[1]) {
+            changed = true;
+          }
         }
       })
       .then(() => {
@@ -87,44 +90,65 @@ export default class Provider extends Emitter {
       });
   }
 
+  static $key(obj) {
+    return typeof obj === 'object' ? obj.key : null;
+  }
+
+  static $equals(a, b) {
+    return a.$equals ? a.$equals(b) : a === b;
+  }
+
   $object(data) {
     const obj = new this.$constructor(data);
-    const key = typeof obj === 'object' ? obj.key : null;
-    if (key) {
-      if (this.$objs.has(key)) {
-        const existing = this.$objs.get(key);
-        this.$objs.set(key, obj);
-        if (obj.$equals && obj.$equals(existing) === false) {
-          this.dispatchEvent(EVENT_CHANGED, this, obj, existing);
-        }
+    const key = this.constructor.$key(obj);
+    let changed = true;
+    if (key && this.$objs.has(key)) {
+      const existing = this.$objs.get(key);
+      this.$objs.set(key, obj);
+      if (this.constructor.$equals(obj, existing) === false) {
+        this.dispatchEvent(EVENT_CHANGED, this, obj, existing);
       } else {
-        this.$objs.set(key, obj);
-        this.dispatchEvent(EVENT_ADDED, this, obj);
+        changed = false;
       }
     } else {
+      if (key) {
+        this.$objs.set(key, obj);
+      }
       this.dispatchEvent(EVENT_ADDED, this, obj);
     }
-    return key;
+    return [key, changed];
   }
 
   $array(data) {
-    const changed = false;
+    let changed = false;
     const mark = new Map();
+
+    // Mark existing objects
     this.$objs.forEach((_, key) => {
       mark.set(key, true);
     });
+
+    // Add and change objects
     data.forEach((elem) => {
-      const key = this.$object(elem);
-      if (key) {
-        mark.delete(key);
+      const result = this.$object(elem);
+      if (result[0]) {
+        mark.delete(result[0]);
+      }
+      if (result[1]) {
+        changed = true;
       }
     });
+
+    // Delete objects which are still marked
     this.$objs.forEach((elem, key) => {
       if (mark.get(key)) {
+        changed = true;
         this.dispatchEvent(EVENT_DELETED, this, elem);
         this.$objs.delete(key);
       }
     });
+
+    // Return true if the items were changed
     return changed;
   }
 
@@ -143,8 +167,8 @@ export default class Provider extends Emitter {
     return this.$objs.get(key);
   }
 
-  // removeAll resets the provider
-  removeAll() {
+  // clear removes all objects from the provider
+  clear() {
     this.$objs.clear();
   }
 }

js/provider.js

@@ -1,6 +1,6 @@
 // View class to be subclassed by an actual view
 
-import Emitter from './events';
+import Emitter from './emitter';
 import Error from './error';
 
 /* eslint no-param-reassign: ["error", { "props": false }] */