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

package/dist/ModelObject.d.ts

@@ -22,11 +22,12 @@ export declare function isModelObject(value: any): value is IModelObject;
  */
 export declare abstract class ModelObject implements IModelObject {
     /**
-     * Reset the properties that may hold null and are missing from the given authoritative data.
-     * Overridden where an instance never receives a complete snapshot of itself
-     * @param jsonElement JSON data this instance is being updated from
+     * 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
      */
-    protected resetMissingProperties(jsonElement: any): void;
+    static readonly resetsMissingProperties: boolean;
     /**
      * Update this instance from the given data
      * @param jsonElement JSON data to upgrade this instance from

package/dist/ModelObject.js

@@ -40,18 +40,6 @@ export function isModelObject(value) {
  * Base class for object model classes
  */
 export class ModelObject {
-    /**
-     * Reset the properties that may hold null and are missing from the given authoritative data.
-     * Overridden where an instance never receives a complete snapshot of itself
-     * @param jsonElement JSON data this instance is being updated from
-     */
-    resetMissingProperties(jsonElement) {
-        for (const key of getNullableProperties(this)) {
-            if (!(key in jsonElement)) {
-                this[key] = null;
-            }
-        }
-    }
     /**
      * Update this instance from the given data
      * @param jsonElement JSON data to upgrade this instance from
@@ -62,8 +50,12 @@ export class ModelObject {
         if (jsonElement === null) {
             return null;
         }
-        if (authoritative) {
-            this.resetMissingProperties(jsonElement);
+        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) {
@@ -265,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

@@ -28,7 +28,7 @@ export declare class ObjectModel extends ModelObject {
      * 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
      */
-    protected resetMissingProperties(): void;
+    static readonly resetsMissingProperties: boolean;
     readonly boards: ModelCollection<Board>;
     readonly directories: Directories;
     readonly fans: ModelCollection<Fan | null>;

package/dist/ObjectModel.js

@@ -46,10 +46,10 @@ export class ObjectModel extends ModelObject {
         this.volumes = new ModelCollection(Volume);
         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
-     */
-    resetMissingProperties() { }
 }
+/**
+ * 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/package.json

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