trakked 2.1.0 → 2.2.0

package/README.md

@@ -428,7 +428,7 @@ const invoice = tracker.construct(() => new InvoiceModel(tracker));
 | `state` | `ObjectState` | Computed DB operation required at save time |
 | `_committedState` | `ObjectState` | The persisted state. Defaults to `Unchanged`. Pass `initialState` to the constructor to override |
 | `destroy()` | `void` | Removes this model from the tracker |
-| `onCommitted()` | `void` | Called automatically by `tracker.onCommit()` — resets `dirtyCounter` to `0` |
+| `onCommitted()` | `void` | Called automatically by `tracker.onCommit()` — transitions `_committedState` and records the inverse in the undo stack so that undoing a commit restores the correct state |
 
 ---
 
@@ -449,6 +449,16 @@ import { ObjectState } from 'trakked';
 
 `Edited` is **derived**: when `_committedState === Unchanged` and the object has unsaved property changes (`isDirty === true`), `state` returns `Edited`. It is never stored directly.
 
+**Undo of a committed save:**
+
+`tracker.onCommit()` records the state transition in the undo stack. Undoing past a commit reverses the server operation:
+
+| Committed operation | State after undo | Required server operation |
+|---|---|---|
+| INSERT (`New`) | `Deleted` | DELETE |
+| UPDATE (`Edited`) | `Edited` (with pre-edit values) | UPDATE |
+| DELETE (`Deleted`) | `New` | INSERT |
+
 **Loading from DB:**
 
 Objects default to `Unchanged`, so no extra setup is needed. Property values set inside the constructor are suppressed by `tracker.construct()`:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trakked",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Operation tracking, undo/redo, dirty state, and validation for TypeScript",
   "type": "module",
   "main": "./dist/prod/index.cjs",