@duet3d/objectmodel 3.7.0-beta.6 → 3.7.0-beta.8

package/dist/ModelCollection.d.ts

@@ -18,9 +18,10 @@ export declare class ModelCollection<T extends IModelObject | null> extends Arra
     /**
      * Update this instance from the given data
      * @param jsonElement JSON data to upgrade this instance from
+     * @param authoritative Whether the given data is a complete snapshot of the items and everything below them
      * @returns Updated instance
      */
-    update(jsonElement: any): IModelObject | null;
+    update(jsonElement: any, authoritative?: boolean): IModelObject | null;
 }
 export default ModelCollection;
 /**

package/dist/ModelCollection.js

@@ -33,9 +33,10 @@ export class ModelCollection extends Array {
     /**
      * Update this instance from the given data
      * @param jsonElement JSON data to upgrade this instance from
+     * @param authoritative Whether the given data is a complete snapshot of the items and everything below them
      * @returns Updated instance
      */
-    update(jsonElement) {
+    update(jsonElement, authoritative = false) {
         if (jsonElement === null) {
             return null;
         }
@@ -55,11 +56,11 @@ export class ModelCollection extends Array {
                 }
                 else {
                     const refItem = new that.$itemConstructor();
-                    this[i] = refItem.update(newItem);
+                    this[i] = refItem.update(newItem, authoritative);
                 }
             }
             else if (isModelObject(currentItem)) {
-                const newItem = currentItem.update(jsonElement[i]);
+                const newItem = currentItem.update(jsonElement[i], authoritative);
                 if (currentItem !== newItem) {
                     this[i] = newItem;
                 }
@@ -79,7 +80,7 @@ export class ModelCollection extends Array {
             }
             else {
                 const newItem = new that.$itemConstructor();
-                super.push(newItem.update(itemToAdd));
+                super.push(newItem.update(itemToAdd, authoritative));
             }
         }
         return this;

package/dist/ModelDictionary.d.ts

@@ -15,14 +15,16 @@ export declare class ModelDictionary<T> extends Map<string, T | null> implements
      * Overridden set method to perform type-checks and update
      * @param key Key to set
      * @param value Value to set
+     * @param authoritative Whether the given value is a complete snapshot of the item and everything below it
      */
-    set(key: string, value: T | null): this;
+    set(key: string, value: T | null, authoritative?: boolean): this;
     /**
      * Update this instance from the given data
      * @param jsonElement JSON data to upgrade this instance from
+     * @param authoritative Whether the given data is a complete snapshot of the items and everything below them
      * @returns Updated instance
      */
-    update(jsonElement: any): IModelObject | null;
+    update(jsonElement: any, authoritative?: boolean): IModelObject | null;
     /**
      * Convert this object to JSON
      * @returns JSON object

package/dist/ModelDictionary.js

@@ -18,8 +18,9 @@ export class ModelDictionary extends Map {
      * Overridden set method to perform type-checks and update
      * @param key Key to set
      * @param value Value to set
+     * @param authoritative Whether the given value is a complete snapshot of the item and everything below it
      */
-    set(key, value) {
+    set(key, value, authoritative = false) {
         const that = this;
         if (value === null) {
             if (that.$nullDeletesKeys) {
@@ -33,13 +34,13 @@ export class ModelDictionary extends Map {
             if (that.$itemConstructor !== null && !(value instanceof that.$itemConstructor)) {
                 const newItem = new that.$itemConstructor();
                 if (isModelObject(newItem)) {
-                    const updatedItem = newItem.update(value);
+                    const updatedItem = newItem.update(value, authoritative);
                     return super.set(key, updatedItem);
                 }
             }
         }
         else if (isModelObject(currentItem)) {
-            const newItem = currentItem.update(value);
+            const newItem = currentItem.update(value, authoritative);
             if (currentItem !== newItem) {
                 return super.set(key, value);
             }
@@ -50,20 +51,21 @@ export class ModelDictionary extends Map {
     /**
      * Update this instance from the given data
      * @param jsonElement JSON data to upgrade this instance from
+     * @param authoritative Whether the given data is a complete snapshot of the items and everything below them
      * @returns Updated instance
      */
-    update(jsonElement) {
+    update(jsonElement, authoritative = false) {
         if (jsonElement === null) {
             this.clear();
         }
         else if (jsonElement instanceof Map) {
             for (const [key, value] of jsonElement.entries()) {
-                this.set(key, value);
+                this.set(key, value, authoritative);
             }
         }
         else {
             for (const [key, value] of Object.entries(jsonElement)) {
-                this.set(key, value);
+                this.set(key, value, authoritative);
             }
         }
         return this;

package/dist/ModelObject.d.ts

@@ -5,9 +5,12 @@ export interface IModelObject {
     /**
      * Update this instance from the given data
      * @param jsonElement JSON data to upgrade this instance from
+     * @param authoritative Whether the given data is a complete snapshot of this instance and everything below it,
+     * so that properties missing from it are known to be null. Set this only for responses that were not filtered
+     * by the sender, i.e. full object model key queries but never live/patch updates
      * @returns Updated instance (may not equal the original instance)
      */
-    update(jsonElement: any): IModelObject | null;
+    update(jsonElement: any, authoritative?: boolean): IModelObject | null;
 }
 /**
  * Check whether a given value provides model update functionality
@@ -18,12 +21,20 @@ export declare function isModelObject(value: any): value is IModelObject;
  * Base class for object model classes
  */
 export declare abstract class ModelObject implements IModelObject {
+    /**
+     * Whether an authoritative update may reset the properties of this class that are missing from it.
+     * Set to false where an instance never receives a complete snapshot of itself. Deliberately static
+     * because an instance member would become part of the structural type and break consumers that hold
+     * a mapped version of the model, such as a Pinia store
+     */
+    static readonly resetsMissingProperties: boolean;
     /**
      * Update this instance from the given data
      * @param jsonElement JSON data to upgrade this instance from
+     * @param authoritative Whether the given data is a complete snapshot of this instance and everything below it
      * @returns Updated instance (may not equal the original instance)
      */
-    update(jsonElement: any): IModelObject | null;
+    update(jsonElement: any, authoritative?: boolean): IModelObject | null;
     /**
      * Wrap a nullable model object property so that type checks can be performed
      * @param key Property key of the derived class

package/dist/ModelObject.js

@@ -1,4 +1,34 @@
 import { ModelCollection } from "./index";
+/**
+ * Names of the properties that default to null, per model object class. Queried from a pristine instance because
+ * TS types are gone at runtime, so a null default is the only remaining evidence that a property may hold null
+ */
+const nullableProperties = new WeakMap();
+/**
+ * Get the names of the properties of the given instance's class that may hold null
+ * @param instance Instance to inspect the class of
+ */
+function getNullableProperties(instance) {
+    let result = nullableProperties.get(instance.constructor);
+    if (result === undefined) {
+        result = new Set();
+        try {
+            for (const [key, value] of Object.entries(new instance.constructor())) {
+                if (value === null) {
+                    result.add(key);
+                }
+            }
+        }
+        catch (e) {
+            // A class that cannot be constructed without arguments simply opts out of null reconstruction
+            if (process.env.NODE_ENV !== "production") {
+                console.warn(`Failed to determine nullable properties of ${instance.constructor.name}`, e);
+            }
+        }
+        nullableProperties.set(instance.constructor, result);
+    }
+    return result;
+}
 /**
  * Check whether a given value provides model update functionality
  * @param value Value to check
@@ -13,19 +43,27 @@ export class ModelObject {
     /**
      * Update this instance from the given data
      * @param jsonElement JSON data to upgrade this instance from
+     * @param authoritative Whether the given data is a complete snapshot of this instance and everything below it
      * @returns Updated instance (may not equal the original instance)
      */
-    update(jsonElement) {
+    update(jsonElement, authoritative = false) {
         if (jsonElement === null) {
             return null;
         }
+        if (authoritative && this.constructor.resetsMissingProperties) {
+            for (const key of getNullableProperties(this)) {
+                if (!(key in jsonElement)) {
+                    this[key] = null;
+                }
+            }
+        }
         for (const [key, value] of Object.entries(jsonElement)) {
             if (key in this) {
                 const ownKey = key;
                 const prop = this[ownKey];
                 if (isModelObject(prop)) {
                     // Update model objects
-                    const updatedObject = prop.update(value);
+                    const updatedObject = prop.update(value, authoritative);
                     if (prop !== updatedObject) {
                         const propDescriptor = Object.getOwnPropertyDescriptor(this, key);
                         if (propDescriptor !== undefined) {
@@ -219,6 +257,13 @@ export class ModelObject {
         });
     }
 }
+/**
+ * Whether an authoritative update may reset the properties of this class that are missing from it.
+ * Set to false where an instance never receives a complete snapshot of itself. Deliberately static
+ * because an instance member would become part of the structural type and break consumers that hold
+ * a mapped version of the model, such as a Pinia store
+ */
+ModelObject.resetsMissingProperties = true;
 export default ModelObject;
 /**
  * Initialize a model object from the given data

package/dist/ObjectModel.d.ts

@@ -24,6 +24,11 @@ import LedStrip from "./ledStrips";
  */
 export declare class ObjectModel extends ModelObject {
     constructor();
+    /**
+     * A payload handed to the root always covers a subset of the top-level keys rather than the whole model,
+     * so authoritative reconstruction has to start one level below it
+     */
+    static readonly resetsMissingProperties: boolean;
     readonly boards: ModelCollection<Board>;
     readonly directories: Directories;
     readonly fans: ModelCollection<Fan | null>;

package/dist/ObjectModel.js

@@ -47,4 +47,9 @@ export class ObjectModel extends ModelObject {
         ModelObject.wrapModelProperty(this, "sbc", SBC);
     }
 }
+/**
+ * A payload handed to the root always covers a subset of the top-level keys rather than the whole model,
+ * so authoritative reconstruction has to start one level below it
+ */
+ObjectModel.resetsMissingProperties = false;
 export default ObjectModel;

package/dist/sensors/FilamentMonitors/RotatingMagnetFilamentMonitor.d.ts

@@ -16,6 +16,7 @@ export declare class RotatingMagnetFilamentMonitorConfigured extends ModelObject
 }
 export declare class RotatingMagnetFilamentMonitor extends Duet3DFilamentMonitor {
     constructor();
+    agc: number | null;
     calibrated: RotatingMagnetFilamentMonitorCalibrated | null;
     readonly configured: RotatingMagnetFilamentMonitorConfigured;
     update(jsonElement: any): IModelObject | null;

package/dist/sensors/FilamentMonitors/RotatingMagnetFilamentMonitor.js

@@ -24,6 +24,7 @@ export class RotatingMagnetFilamentMonitorConfigured extends ModelObject {
 export class RotatingMagnetFilamentMonitor extends Duet3DFilamentMonitor {
     constructor() {
         super(FilamentMonitorType.rotatingMagnet);
+        this.agc = null;
         this.calibrated = new RotatingMagnetFilamentMonitorCalibrated();
         this.configured = new RotatingMagnetFilamentMonitorConfigured();
         ModelObject.wrapModelProperty(this, "calibrated", RotatingMagnetFilamentMonitorCalibrated);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duet3d/objectmodel",
-  "version": "3.7.0-beta.6",
+  "version": "3.7.0-beta.8",
   "description": "TypeScript implementation of the Duet3D Object Model",
   "type": "module",
   "main": "dist/index.js",