@duet3d/objectmodel 3.4.0-b6 → 3.4.0-b9

package/dist/ModelCollection.d.ts

@@ -24,3 +24,14 @@ export declare class ModelCollection<T extends IModelObject> extends Array<T> im
     update(jsonElement: any): IModelObject | null;
 }
 export default ModelCollection;
+/**
+ * Initialize a model collection from the given data
+ * @param itemType Item type to create
+ * @param data Data to assign
+ * @returns Initialized model collection
+ */
+export declare function initCollection<T extends IModelObject>(itemType: {
+    new (): T;
+}, data: Array<{
+    [Property in keyof T]?: T[Property];
+}>): ModelCollection<T>;

package/dist/ModelCollection.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelCollection = void 0;
+exports.initCollection = exports.ModelCollection = void 0;
 const ModelObject_1 = require("./ModelObject");
 const index_1 = require("./index");
 /**
@@ -79,3 +79,19 @@ class ModelCollection extends Array {
 }
 exports.ModelCollection = ModelCollection;
 exports.default = ModelCollection;
+/**
+ * Initialize a model collection from the given data
+ * @param itemType Item type to create
+ * @param data Data to assign
+ * @returns Initialized model collection
+ */
+function initCollection(itemType, data) {
+    const result = new ModelCollection(itemType);
+    for (let presetItem of data) {
+        const item = new itemType();
+        item.update(presetItem);
+        result.push(item);
+    }
+    return result;
+}
+exports.initCollection = initCollection;

package/dist/ModelDictionary.d.ts

@@ -27,3 +27,15 @@ export declare class ModelDictionary<T> extends Map<string, T | null> implements
     update(jsonElement: any): IModelObject | null;
 }
 export default ModelDictionary;
+/**
+ * Initialize a model dictionary from the given data
+ * @param nullDeletesKeys Defines whether setting values to null deletes the corresponding key
+ * @param itemConstructor Item constructor
+ * @param data Data to assign
+ * @returns Initialized model dictionary
+ */
+export declare function initDictionary<T>(nullDeletesKeys: boolean, itemConstructor: {
+    new (): T;
+}, data: Record<string, {
+    [Property in keyof T]?: T[Property];
+}>): ModelDictionary<T>;

package/dist/ModelDictionary.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelDictionary = void 0;
+exports.initDictionary = exports.ModelDictionary = void 0;
 const ModelObject_1 = require("./ModelObject");
 /**
  * Dictionary class to map object model data
@@ -67,3 +67,25 @@ class ModelDictionary extends Map {
 }
 exports.ModelDictionary = ModelDictionary;
 exports.default = ModelDictionary;
+/**
+ * Initialize a model dictionary from the given data
+ * @param nullDeletesKeys Defines whether setting values to null deletes the corresponding key
+ * @param itemConstructor Item constructor
+ * @param data Data to assign
+ * @returns Initialized model dictionary
+ */
+function initDictionary(nullDeletesKeys, itemConstructor, data) {
+    const result = new ModelDictionary(nullDeletesKeys, itemConstructor);
+    for (let key in data) {
+        const item = new itemConstructor();
+        if ((0, ModelObject_1.isModelObject)(item)) {
+            item.update(data[key]);
+            result.set(key, item);
+        }
+        else {
+            result.set(key, data[key]);
+        }
+    }
+    return result;
+}
+exports.initDictionary = initDictionary;

package/dist/ModelObject.d.ts

@@ -33,15 +33,15 @@ export declare abstract class ModelObject implements IModelObject {
         new (): T;
     }): void;
 }
+export default ModelObject;
 /**
- * Initialize a class item from the given data
- * @param itemType Item type to create
+ * Initialize a model object from the given data
+ * @param itemType Model type to create
  * @param data Data to assign
- * @returns Initialized item instance
+ * @returns Initialized model instance
  */
-export declare function initItem<T>(itemType: {
+export declare function initObject<T>(itemType: {
     new (): T;
 }, data: {
     [Property in keyof T]?: T[Property];
 }): T;
-export default ModelObject;

package/dist/ModelObject.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initItem = exports.ModelObject = exports.isModelObject = void 0;
+exports.initObject = exports.ModelObject = exports.isModelObject = void 0;
 const index_1 = require("./index");
 /**
  * Check whether a given value provides model update functionality
@@ -71,6 +71,25 @@ class ModelObject {
                         console.warn(`Model array ${key} could not be changed because the target type ${typeof value} is invalid`);
                     }
                 }
+                else if (prop instanceof Set) {
+                    if (value instanceof Array || value instanceof Set) {
+                        // Remove deleted items
+                        for (let item of new Set(prop)) {
+                            if (!prop.has(item)) {
+                                prop.delete(item);
+                            }
+                        }
+                        // Add new items
+                        for (let item of value) {
+                            if (!prop.has(item)) {
+                                prop.add(item);
+                            }
+                        }
+                    }
+                    else if (process.env.NODE_ENV !== "production") {
+                        console.warn(`Model set ${key} could not be changed because the target type ${typeof value} is invalid`);
+                    }
+                }
                 else if (prop === null || value === null) {
                     // Unfortunately we cannot do type checks during runtime without excessive extra work and possibly
                     // third-party libraries, so skip them for null values until there is a better solution.
@@ -153,18 +172,24 @@ class ModelObject {
     }
 }
 exports.ModelObject = ModelObject;
+exports.default = ModelObject;
 /**
- * Initialize a class item from the given data
- * @param itemType Item type to create
+ * Initialize a model object from the given data
+ * @param itemType Model type to create
  * @param data Data to assign
- * @returns Initialized item instance
+ * @returns Initialized model instance
  */
-function initItem(itemType, data) {
+function initObject(itemType, data) {
     const result = new itemType();
     for (let key in data) {
-        result[key] = data[key];
+        const resultKey = result[key];
+        if (isModelObject(resultKey)) {
+            resultKey.update(data[key]);
+        }
+        else {
+            result[key] = data[key];
+        }
     }
     return result;
 }
-exports.initItem = initItem;
-exports.default = ModelObject;
+exports.initObject = initObject;

package/dist/ObjectModel.d.ts

@@ -12,6 +12,7 @@ import Job from "./job";
 import Limits from "./limits";
 import Message from "./messages";
 import Move from "./move";
+import Network from "./network";
 import Plugin from "./plugins";
 import Scanner from "./scanner";
 import Sensors from "./sensors";
@@ -33,6 +34,7 @@ export declare class ObjectModel extends ModelObject {
     readonly limits: Limits;
     readonly messages: ModelCollection<Message>;
     readonly move: Move;
+    readonly network: Network;
     readonly plugins: ModelDictionary<Plugin>;
     readonly scanner: Scanner;
     readonly sensors: Sensors;

package/dist/ObjectModel.js

@@ -15,6 +15,7 @@ const job_1 = require("./job");
 const limits_1 = require("./limits");
 const messages_1 = require("./messages");
 const move_1 = require("./move");
+const network_1 = require("./network");
 const plugins_1 = require("./plugins");
 const scanner_1 = require("./scanner");
 const sensors_1 = require("./sensors");
@@ -38,6 +39,7 @@ class ObjectModel extends ModelObject_1.default {
         this.limits = new limits_1.default();
         this.messages = new ModelCollection_1.default(messages_1.default); // must be manually cleared after updates
         this.move = new move_1.default();
+        this.network = new network_1.default();
         this.plugins = new ModelDictionary_1.default(true, plugins_1.default);
         this.scanner = new scanner_1.default();
         this.sensors = new sensors_1.default();

package/dist/move/DriverId.d.ts

@@ -1,7 +1,9 @@
 import ModelObject, { IModelObject } from "../ModelObject";
+export declare function isDriverId(value: any): value is DriverId;
 export declare class DriverId extends ModelObject {
     board: number;
     driver: number;
+    equals(value?: DriverId | null): boolean;
     update(jsonElement: any): IModelObject | null;
     toString(): string;
 }

package/dist/move/DriverId.js

@@ -1,14 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DriverId = void 0;
+exports.DriverId = exports.isDriverId = void 0;
 const ModelObject_1 = require("../ModelObject");
+function isDriverId(value) {
+    return (value instanceof Object) && (typeof value.board === "number") && (typeof value.driver === "number");
+}
+exports.isDriverId = isDriverId;
 class DriverId extends ModelObject_1.default {
     constructor() {
         super(...arguments);
         this.board = 0;
         this.driver = 0;
     }
+    equals(value) {
+        return isDriverId(value) && value.board === this.board && value.driver === this.driver;
+    }
     update(jsonElement) {
+        if (isDriverId(jsonElement)) {
+            this.board = jsonElement.board;
+            this.driver = jsonElement.driver;
+        }
         if (typeof jsonElement === "string") {
             const matches = /(\d+)\.(\d+)/.exec(jsonElement);
             if (matches !== null) {

package/dist/move/kinematics/DeltaKinematics.js

@@ -22,7 +22,7 @@ class DeltaKinematics extends KinematicsBase_1.default {
         this.deltaRadius = 0;
         this.homedHeight = 0;
         this.printRadius = 0;
-        this.towers = new ModelCollection_1.default(DeltaTower);
+        this.towers = (0, ModelCollection_1.initCollection)(DeltaTower, [{}, {}, {}]);
         this.xTilt = 0;
         this.yTilt = 0;
     }

package/package.json

@@ -1,30 +1,30 @@
-{
-  "name": "@duet3d/objectmodel",
-  "version": "3.4.0-b6",
-  "description": "TypeScript implementation of the Duet3D Object Model",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "test": "jest --config jestconfig.json",
-    "build": "tsc",
-    "prepare" : "npm run build",
-    "prepublishOnly" : "npm test"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Duet3D/ObjectModel.git"
-  },
-  "author": "Christian Hammacher",
-  "license": "LGPL-2.1",
-  "bugs": {
-    "url": "https://github.com/Duet3D/ObjectModel/issues"
-  },
-  "homepage": "https://github.com/Duet3D/ObjectModel#readme",
-  "devDependencies": {
-    "@types/jest": "^27.0.3",
-    "jest": "^27.4.5",
-    "ts-jest": "^27.1.2",
-    "typescript": "^4.5.2"
-  },
-  "files": ["/dist"]
-}
+{
+  "name": "@duet3d/objectmodel",
+  "version": "3.4.0-b9",
+  "description": "TypeScript implementation of the Duet3D Object Model",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "jest --config jestconfig.json",
+    "build": "tsc",
+    "prepare" : "npm run build",
+    "prepublishOnly" : "npm test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Duet3D/ObjectModel.git"
+  },
+  "author": "Christian Hammacher",
+  "license": "LGPL-2.1",
+  "bugs": {
+    "url": "https://github.com/Duet3D/ObjectModel/issues"
+  },
+  "homepage": "https://github.com/Duet3D/ObjectModel#readme",
+  "devDependencies": {
+    "@types/jest": "^27.0.3",
+    "jest": "^27.4.5",
+    "ts-jest": "^27.1.2",
+    "typescript": "^4.5.2"
+  },
+  "files": ["/dist"]
+}