New isDirty aliases. (#3915)

CHANGELOG.md

@@ -11,6 +11,8 @@
 * Introduced a new "JSON Search" feature to the Hoist Admin Console, accessible from the Config,
   User Preference, and JSON Blob tabs. Supports searching JSON values stored within these objects
   to filter and match data using JSON Path expressions.
+* New aliases `StoreRecord.isDirty`, `Store.dirtyRecords`, and `Store.isDirty` provide a more
+ consistent API in the data package.
 
 ### 🐞 Bug Fixes
 

admin/tabs/userData/roles/editor/form/RoleFormModel.ts

@@ -46,9 +46,9 @@ export class RoleFormModel extends HoistModel {
     @computed
     get hasDirtyMembers(): boolean {
         return (
-            this.usersGridModel.store.isModified ||
-            this.directoryGroupsGridModel.store.isModified ||
-            this.rolesGridModel.store.isModified
+            this.usersGridModel.store.isDirty ||
+            this.directoryGroupsGridModel.store.isDirty ||
+            this.rolesGridModel.store.isDirty
         );
     }
 

data/Store.ts

@@ -435,7 +435,7 @@ export class Store extends HoistBase {
             // sourced from the server / source of record and are coming in as committed.
             this._committed = this._committed.withTransaction(rsTransaction);
 
-            if (this.isModified) {
+            if (this.isDirty) {
                 // If this store had pre-existing local modifications, apply the updates over that
                 // local state. This might (or might not) effectively overwrite those local changes,
                 // so we normalize against the newly updated committed state to verify if any local
@@ -662,8 +662,13 @@ export class Store extends HoistBase {
     }
 
     /** Records modified locally since they were last loaded. */
+    get dirtyRecords(): StoreRecord[] {
+        return this.allRecords.filter(it => it.isDirty);
+    }
+
+    /** Alias for {@link Store.dirtyRecords} */
     get modifiedRecords(): StoreRecord[] {
-        return this.allRecords.filter(it => it.isModified);
+        return this.dirtyRecords;
     }
 
     /**
@@ -696,10 +701,15 @@ export class Store extends HoistBase {
 
     /** True if the store has changes which need to be committed. */
     @computed
-    get isModified(): boolean {
+    get isDirty(): boolean {
         return this._current !== this._committed;
     }
 
+    /** Alias for {@link Store.isDirty} */
+    get isModified(): boolean {
+        return this.isDirty;
+    }
+
     /**
      * Set a filter on this store.
      *

data/StoreRecord.ts

@@ -71,10 +71,15 @@ export class StoreRecord {
     }
 
     /** True if the StoreRecord has been modified since it was last committed. */
-    get isModified(): boolean {
+    get isDirty(): boolean {
         return this.committedData && this.committedData !== this.data;
     }
 
+    /** Alias for {@link StoreRecord.isDirty} */
+    get isModified(): boolean {
+        return this.isDirty;
+    }
+
     /** False if the StoreRecord has been added or modified. */
     get isCommitted(): boolean {
         return this.committedData === this.data;