@duet3d/objectmodel 3.4.0-b2 → 3.4.0-b22

package/dist/ModelCollection.d.ts

@@ -2,7 +2,7 @@ import { IModelObject } from "./ModelObject";
 /**
  * Class for storing model object items in an array
  */
-export default class ModelCollection<T extends IModelObject> extends Array<T> implements IModelObject {
+export declare class ModelCollection<T extends IModelObject | null> extends Array<T> implements IModelObject {
     private readonly itemConstructor;
     /**
      * Constructor of this class
@@ -23,3 +23,15 @@ export default 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,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.initCollection = exports.ModelCollection = void 0;
 const ModelObject_1 = require("./ModelObject");
 const index_1 = require("./index");
 /**
@@ -71,9 +72,33 @@ class ModelCollection extends Array {
         }
         // Add new items
         for (let i = this.length; i < jsonElement.length; i++) {
-            this.push(jsonElement[i]);
+            const itemToAdd = jsonElement[i];
+            if (itemToAdd === null) {
+                super.push(itemToAdd);
+            }
+            else {
+                const newItem = new this.itemConstructor();
+                super.push(newItem.update(itemToAdd));
+            }
         }
         return this;
     }
 }
+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

@@ -26,3 +26,16 @@ 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
@@ -66,3 +66,26 @@ 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

@@ -17,7 +17,7 @@ export declare function isModelObject(value: any): value is IModelObject;
 /**
  * Base class for object model classes
  */
-export default abstract class ModelObject implements IModelObject {
+export declare abstract class ModelObject implements IModelObject {
     /**
      * Update this instance from the given data
      * @param jsonElement JSON data to upgrade this instance from
@@ -33,3 +33,15 @@ export default abstract class ModelObject implements IModelObject {
         new (): T;
     }): void;
 }
+export default ModelObject;
+/**
+ * Initialize a model object from the given data
+ * @param itemType Model type to create
+ * @param data Data to assign
+ * @returns Initialized model instance
+ */
+export declare function initObject<T>(itemType: {
+    new (): T;
+}, data: {
+    [Property in keyof T]?: T[Property];
+}): T;

package/dist/ModelObject.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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
@@ -43,6 +43,9 @@ class ModelObject {
                                 console.warn(`Model object ${key} changed but it could not be set due to missing setter`);
                             }
                         }
+                        else if (process.env.NODE_ENV !== "production") {
+                            console.warn(`Model object ${key} changed but it lacks the property descriptor`);
+                        }
                     }
                 }
                 else if (prop instanceof Array) {
@@ -71,6 +74,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.
@@ -152,4 +174,42 @@ class ModelObject {
         });
     }
 }
+exports.ModelObject = ModelObject;
 exports.default = ModelObject;
+/**
+ * Initialize a model object from the given data
+ * @param itemType Model type to create
+ * @param data Data to assign
+ * @returns Initialized model instance
+ */
+function initObject(itemType, data) {
+    const result = new itemType();
+    for (let key in data) {
+        const resultKey = result[key];
+        if (isModelObject(resultKey)) {
+            const updatedObject = resultKey.update(data[key]);
+            if (resultKey !== updatedObject) {
+                const propDescriptor = Object.getOwnPropertyDescriptor(result, key);
+                if (propDescriptor !== undefined) {
+                    if (propDescriptor.writable) {
+                        result[key] = updatedObject;
+                    }
+                    else if (propDescriptor.set !== undefined) {
+                        propDescriptor.set(updatedObject);
+                    }
+                    else if (process.env.NODE_ENV !== "production") {
+                        console.warn(`Model object ${key} changed but it could not be set due to missing setter`);
+                    }
+                }
+                else if (process.env.NODE_ENV !== "production") {
+                    console.warn(`Model object ${key} changed but it lacks the property descriptor`);
+                }
+            }
+        }
+        else {
+            result[key] = data[key];
+        }
+    }
+    return result;
+}
+exports.initObject = initObject;

package/dist/ObjectModel.d.ts

@@ -0,0 +1,48 @@
+import ModelCollection from "./ModelCollection";
+import ModelDictionary from "./ModelDictionary";
+import ModelObject from "./ModelObject";
+import Board from "./boards";
+import Directories from "./directories";
+import Fan from "./fans";
+import Heat from "./heat";
+import HttpEndpoint from "./httpEndpoints";
+import InputChannel from "./inputs/InputChannel";
+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";
+import Spindle from "./spindles";
+import State from "./state";
+import Tool from "./tools";
+import UserSession from "./userSessions";
+import Volume from "./volumes";
+/**
+ * Refer to the DSF/RRF documentation for descriptions of the object model fields
+ */
+export declare class ObjectModel extends ModelObject {
+    readonly boards: ModelCollection<Board>;
+    readonly directories: Directories;
+    readonly fans: ModelCollection<Fan | null>;
+    readonly global: ModelDictionary<any>;
+    readonly heat: Heat;
+    readonly httpEndpoints: ModelCollection<HttpEndpoint>;
+    readonly inputs: ModelCollection<InputChannel | null>;
+    readonly job: Job;
+    readonly limits: Limits;
+    readonly messages: ModelCollection<Message>;
+    readonly move: Move;
+    readonly network: Network;
+    readonly plugins: ModelDictionary<Plugin>;
+    readonly scanner: Scanner;
+    readonly sensors: Sensors;
+    readonly spindles: ModelCollection<Spindle | null>;
+    readonly state: State;
+    readonly tools: ModelCollection<Tool | null>;
+    readonly userSessions: ModelCollection<UserSession>;
+    readonly volumes: ModelCollection<Volume>;
+}
+export default ObjectModel;

package/dist/ObjectModel.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObjectModel = void 0;
+const ModelCollection_1 = require("./ModelCollection");
+const ModelDictionary_1 = require("./ModelDictionary");
+const ModelObject_1 = require("./ModelObject");
+const boards_1 = require("./boards");
+const directories_1 = require("./directories");
+const fans_1 = require("./fans");
+const heat_1 = require("./heat");
+const httpEndpoints_1 = require("./httpEndpoints");
+const InputChannel_1 = require("./inputs/InputChannel");
+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");
+const spindles_1 = require("./spindles");
+const state_1 = require("./state");
+const tools_1 = require("./tools");
+const userSessions_1 = require("./userSessions");
+const volumes_1 = require("./volumes");
+/**
+ * Refer to the DSF/RRF documentation for descriptions of the object model fields
+ */
+class ObjectModel extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.boards = new ModelCollection_1.default(boards_1.default);
+        this.directories = new directories_1.default();
+        this.fans = new ModelCollection_1.default(fans_1.default);
+        this.global = new ModelDictionary_1.default(false);
+        this.heat = new heat_1.default();
+        this.httpEndpoints = new ModelCollection_1.default(httpEndpoints_1.default);
+        this.inputs = new ModelCollection_1.default(InputChannel_1.default);
+        this.job = new job_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();
+        this.spindles = new ModelCollection_1.default(spindles_1.default);
+        this.state = new state_1.default();
+        this.tools = new ModelCollection_1.default(tools_1.default);
+        this.userSessions = new ModelCollection_1.default(userSessions_1.default);
+        this.volumes = new ModelCollection_1.default(volumes_1.default);
+    }
+}
+exports.ObjectModel = ObjectModel;
+exports.default = ObjectModel;

package/dist/boards/index.d.ts

@@ -24,7 +24,7 @@ export declare class DirectDisplay extends ModelObject {
     spiFreq: number;
     typeName: string;
 }
-export default class Board extends ModelObject {
+export declare class Board extends ModelObject {
     constructor();
     accelerometer: Accelerometer | null;
     bootloaderFileName: string | null;
@@ -47,3 +47,4 @@ export default class Board extends ModelObject {
     v12: MinMaxCurrent | null;
     vIn: MinMaxCurrent | null;
 }
+export default Board;

package/dist/boards/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DirectDisplay = exports.MinMaxCurrent = exports.ClosedLoop = exports.BoardState = exports.Accelerometer = void 0;
+exports.Board = exports.DirectDisplay = exports.MinMaxCurrent = exports.ClosedLoop = exports.BoardState = exports.Accelerometer = void 0;
 const ModelObject_1 = require("../ModelObject");
 class Accelerometer extends ModelObject_1.default {
     constructor() {
@@ -49,7 +49,7 @@ class Board extends ModelObject_1.default {
         super();
         this.accelerometer = null;
         this.bootloaderFileName = null;
-        this.canAddress = 0;
+        this.canAddress = null;
         this.closedLoop = null;
         this.directDisplay = null;
         this.firmwareDate = "";
@@ -75,4 +75,5 @@ class Board extends ModelObject_1.default {
         this.wrapModelProperty("vIn", MinMaxCurrent);
     }
 }
+exports.Board = Board;
 exports.default = Board;

package/dist/directories/index.d.ts

@@ -1,5 +1,5 @@
 import ModelObject from "../ModelObject";
-export default class Directories extends ModelObject {
+export declare class Directories extends ModelObject {
     filaments: string;
     firmware: string;
     gCodes: string;
@@ -9,3 +9,4 @@ export default class Directories extends ModelObject {
     system: string;
     web: string;
 }
+export default Directories;

package/dist/directories/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Directories = void 0;
 const ModelObject_1 = require("../ModelObject");
 class Directories extends ModelObject_1.default {
     constructor() {
@@ -14,4 +15,5 @@ class Directories extends ModelObject_1.default {
         this.web = "0:/www";
     }
 }
+exports.Directories = Directories;
 exports.default = Directories;

package/dist/fans/index.d.ts

@@ -4,7 +4,7 @@ export declare class FanThermostaticControl extends ModelObject {
     highTemperature: number | null;
     lowTemperature: number | null;
 }
-export default class Fan extends ModelObject {
+export declare class Fan extends ModelObject {
     actualValue: number;
     blip: number;
     frequency: number;
@@ -15,3 +15,4 @@ export default class Fan extends ModelObject {
     rpm: number;
     readonly thermostatic: FanThermostaticControl;
 }
+export default Fan;

package/dist/fans/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FanThermostaticControl = void 0;
+exports.Fan = exports.FanThermostaticControl = void 0;
 const ModelObject_1 = require("../ModelObject");
 class FanThermostaticControl extends ModelObject_1.default {
     constructor() {
@@ -25,4 +25,5 @@ class Fan extends ModelObject_1.default {
         this.thermostatic = new FanThermostaticControl();
     }
 }
+exports.Fan = Fan;
 exports.default = Fan;

package/dist/heat/Heater.d.ts

@@ -10,7 +10,7 @@ export declare enum HeaterState {
     tuning = "tuning",
     offline = "offline"
 }
-export default class Heater extends ModelObject {
+export declare class Heater extends ModelObject {
     active: number;
     avgPwm: number;
     current: number;
@@ -22,3 +22,4 @@ export default class Heater extends ModelObject {
     standby: number;
     state: HeaterState;
 }
+export default Heater;

package/dist/heat/Heater.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HeaterState = void 0;
+exports.Heater = exports.HeaterState = void 0;
 const ModelCollection_1 = require("../ModelCollection");
 const HeaterModel_1 = require("./HeaterModel");
 const ModelObject_1 = require("../ModelObject");
@@ -29,4 +29,5 @@ class Heater extends ModelObject_1.default {
         this.state = HeaterState.off;
     }
 }
+exports.Heater = Heater;
 exports.default = Heater;

package/dist/heat/HeaterModel.d.ts

@@ -6,7 +6,7 @@ export declare class HeaterModelPID extends ModelObject {
     p: number;
     used: boolean;
 }
-export default class HeaterModel extends ModelObject {
+export declare class HeaterModel extends ModelObject {
     coolingExp: number;
     coolingRate: number;
     deadTime: number;
@@ -18,3 +18,4 @@ export default class HeaterModel extends ModelObject {
     readonly pid: HeaterModelPID;
     standardVoltage: number | null;
 }
+export default HeaterModel;

package/dist/heat/HeaterModel.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HeaterModelPID = void 0;
+exports.HeaterModel = exports.HeaterModelPID = void 0;
 const ModelObject_1 = require("../ModelObject");
 class HeaterModelPID extends ModelObject_1.default {
     constructor() {
@@ -28,4 +28,5 @@ class HeaterModel extends ModelObject_1.default {
         this.standardVoltage = null;
     }
 }
+exports.HeaterModel = HeaterModel;
 exports.default = HeaterModel;

package/dist/heat/HeaterMonitor.d.ts

@@ -10,8 +10,9 @@ export declare enum HeaterMonitorCondition {
     tooHigh = "tooHigh",
     tooLow = "tooLow"
 }
-export default class HeaterMonitor extends ModelObject {
+export declare class HeaterMonitor extends ModelObject {
     action: HeaterMonitorAction;
     condition: HeaterMonitorCondition;
     limit: number;
 }
+export default HeaterMonitor;

package/dist/heat/HeaterMonitor.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HeaterMonitorCondition = exports.HeaterMonitorAction = void 0;
+exports.HeaterMonitor = exports.HeaterMonitorCondition = exports.HeaterMonitorAction = void 0;
 const ModelObject_1 = require("../ModelObject");
 var HeaterMonitorAction;
 (function (HeaterMonitorAction) {
@@ -23,4 +23,5 @@ class HeaterMonitor extends ModelObject_1.default {
         this.limit = 2000;
     }
 }
+exports.HeaterMonitor = HeaterMonitor;
 exports.default = HeaterMonitor;

package/dist/heat/index.d.ts

@@ -1,10 +1,14 @@
 import ModelCollection from "../ModelCollection";
-import Heater from "./Heater";
 import ModelObject from "../ModelObject";
-export default class Heat extends ModelObject {
+import Heater from "./Heater";
+export declare class Heat extends ModelObject {
     bedHeaters: Array<number>;
     chamberHeaters: Array<number>;
     coldExtrudeTemperature: number;
     coldRetractTemperature: number;
-    readonly heaters: ModelCollection<Heater>;
+    readonly heaters: ModelCollection<Heater | null>;
 }
+export default Heat;
+export * from "./Heater";
+export * from "./HeaterModel";
+export * from "./HeaterMonitor";

package/dist/heat/index.js

@@ -1,8 +1,23 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Heat = void 0;
 const ModelCollection_1 = require("../ModelCollection");
-const Heater_1 = require("./Heater");
 const ModelObject_1 = require("../ModelObject");
+const Heater_1 = require("./Heater");
 class Heat extends ModelObject_1.default {
     constructor() {
         super(...arguments);
@@ -13,4 +28,8 @@ class Heat extends ModelObject_1.default {
         this.heaters = new ModelCollection_1.default(Heater_1.default);
     }
 }
+exports.Heat = Heat;
 exports.default = Heat;
+__exportStar(require("./Heater"), exports);
+__exportStar(require("./HeaterModel"), exports);
+__exportStar(require("./HeaterMonitor"), exports);

package/dist/httpEndpoints/index.d.ts

@@ -9,10 +9,11 @@ export declare enum HttpEndpointType {
     OPTIONS = "OPTIONS",
     WebSocket = "WebSocket"
 }
-export default class HttpEndpoint extends ModelObject {
+export declare class HttpEndpoint extends ModelObject {
     endpointType: HttpEndpointType;
     namespace: string;
     path: string;
     isUploadRequest: boolean;
     unixSocket: string;
 }
+export default HttpEndpoint;

package/dist/httpEndpoints/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpEndpointType = void 0;
+exports.HttpEndpoint = exports.HttpEndpointType = void 0;
 const ModelObject_1 = require("../ModelObject");
 var HttpEndpointType;
 (function (HttpEndpointType) {
@@ -23,4 +23,5 @@ class HttpEndpoint extends ModelObject_1.default {
         this.unixSocket = "";
     }
 }
+exports.HttpEndpoint = HttpEndpoint;
 exports.default = HttpEndpoint;