pi-rewind-hook 1.8.3 → 1.8.4

package/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [1.8.4] - 2026-04-25
+
+### Added
+- Added `pi-custom-compaction` compatibility: custom message nodes can now receive exact Rewind checkpoints via the `rewind:checkpoint-entry` extension event.
+
+### Documentation
+- Documented seamless `pi-custom-compaction` compatibility and the `pi install npm:pi-custom-compaction` install command.
+
 ## [1.8.3] - 2026-04-16
 
 ### Fixed

package/README.md

@@ -29,6 +29,18 @@ This will:
 4. Remove legacy hooks/explicit rewind extension entries from `settings.json` if present
 5. Clean up old `hooks/rewind` directory (if present)
 
+## Works with pi-custom-compaction
+
+Rewind works seamlessly with [`pi-custom-compaction`](https://github.com/nicobailon/pi-custom-compaction). When `pi-custom-compaction` writes visible background-summary markers, it can ask Rewind to bind an exact file checkpoint to that marker’s own session-tree node. That means `/tree` can offer the normal `Restore files to that point` option directly on the custom compaction marker instead of falling back to a nearby parent node.
+
+Install the companion extension with:
+
+```bash
+pi install npm:pi-custom-compaction
+```
+
+This is optional. Pi’s default compaction and Rewind’s native compaction checkpoints continue to work without `pi-custom-compaction`.
+
 ## Configuration
 
 Optionally add settings to `~/.pi/agent/settings.json`.  For example:

package/index.test.ts

@@ -438,6 +438,81 @@ test("session_before_tree gracefully cancels when restore fails", async () => {
   }
 });
 
+test("session_before_tree restores directly from a custom message with a checkpoint", async () => {
+  const harness = await createHarness({
+    settings: { rewind: { silentCheckpoints: true } },
+  });
+
+  try {
+    await harness.writeRepoFile("notes.txt", "target state\n");
+    const targetCommit = await harness.captureSnapshot();
+    await harness.writeRepoFile("notes.txt", "current state\n");
+
+    harness.currentSession.replaceEntries([
+      {
+        type: "custom_message",
+        id: "marker-1",
+        parentId: null,
+        timestamp: new Date().toISOString(),
+        customType: "pi-custom-compaction.virtual-summary-marker",
+        content: "Older context was summarized in the background.",
+        display: true,
+      },
+      {
+        type: "custom",
+        id: "rewind-op-1",
+        parentId: "marker-1",
+        timestamp: new Date().toISOString(),
+        customType: "rewind-op",
+        data: { v: 2, snapshots: [targetCommit], bindings: [["marker-1", 0]] },
+      },
+    ]);
+
+    await harness.invoke("session_start", {});
+    harness.enqueueSelection("Restore files to that point");
+
+    const result = await harness.invoke("session_before_tree", { preparation: { targetId: "marker-1" } });
+    assert.equal(result, undefined);
+    assert.equal(harness.readRepoFile("notes.txt"), "target state\n");
+    assert.deepEqual(harness.selectCalls[0]?.options, ["Keep current files", "Restore files to that point", "Cancel navigation"]);
+  } finally {
+    await harness.cleanup();
+  }
+});
+
+test("rewind:checkpoint-entry binds the current tree to a custom message", async () => {
+  const harness = await createHarness({
+    settings: { rewind: { silentCheckpoints: true } },
+  });
+
+  try {
+    await harness.writeRepoFile("notes.txt", "target state\n");
+    harness.currentSession.replaceEntries([
+      {
+        type: "custom_message",
+        id: "marker-1",
+        parentId: null,
+        timestamp: new Date().toISOString(),
+        customType: "pi-custom-compaction.virtual-summary-marker",
+        content: "Older context was summarized in the background.",
+        display: true,
+      },
+    ]);
+
+    await harness.invoke("session_start", {});
+    harness.eventHandlers.get("rewind:checkpoint-entry")?.({ source: "pi-custom-compaction", entryId: "marker-1" });
+    await new Promise((resolve) => setTimeout(resolve, 50));
+    await harness.writeRepoFile("notes.txt", "current state\n");
+
+    harness.enqueueSelection("Restore files to that point");
+    const result = await harness.invoke("session_before_tree", { preparation: { targetId: "marker-1" } });
+    assert.equal(result, undefined);
+    assert.equal(harness.readRepoFile("notes.txt"), "target state\n");
+  } finally {
+    await harness.cleanup();
+  }
+});
+
 test("session_before_tree auto-keeps current files during boomerang collapse", async () => {
   const harness = await createHarness({
     settings: { rewind: { silentCheckpoints: true } },

package/index.ts

@@ -11,6 +11,7 @@ const execAsync = promisify(execCb);
 const STORE_REF = "refs/pi-rewind/store";
 const STATUS_KEY = "rewind";
 const FORK_PREFERENCE_SOURCE_ALLOWLIST = new Set(["fork-from-first"]);
+const CHECKPOINT_SOURCE_ALLOWLIST = new Set(["pi-custom-compaction"]);
 const LEGACY_ZERO_SHA = "0000000000000000000000000000000000000000";
 const RETENTION_SWEEP_THRESHOLD = 50;
 const RETENTION_VERSION = 2;
@@ -316,7 +317,7 @@ function isRestorableTreeEntry(entry: SessionLikeEntry | undefined): boolean {
   if (entry.type === "message") {
     return entry.message.role === "user" || entry.message.role === "assistant";
   }
-  return entry.type === "branch_summary" || entry.type === "compaction";
+  return entry.type === "branch_summary" || entry.type === "compaction" || entry.type === "custom_message";
 }
 
 function isAssistantMessageEntry(entry: SessionLikeEntry): entry is SessionLikeMessageEntry {
@@ -1088,7 +1089,27 @@ export default function rewindExtension(pi: ExtensionAPI) {
     updateStatus(ctx);
   }
 
+  let activeContext: ExtensionContext | undefined;
+
+  async function checkpointEntry(ctx: ExtensionContext, entryId: string) {
+    syncSessionIdentity(ctx);
+    if (!isGitRepo) return;
+    const entry = ctx.sessionManager.getEntry(entryId) as SessionLikeEntry | undefined;
+    if (!isRestorableTreeEntry(entry)) return;
+    if (entryToCommit.has(entryId)) return;
+
+    const currentCommitSha = await ensureSnapshotForCurrentWorktree();
+    appendRewindOp(ctx, {
+      v: RETENTION_VERSION,
+      snapshots: [currentCommitSha],
+      bindings: [[entryId, 0]],
+    });
+    await reconstructState(ctx);
+    updateStatus(ctx);
+  }
+
   async function initializeForSession(ctx: ExtensionContext) {
+    activeContext = ctx;
     resetState();
     syncSessionIdentity(ctx);
 
@@ -1122,6 +1143,19 @@ export default function rewindExtension(pi: ExtensionAPI) {
     forceConversationOnlySource = data.source;
   });
 
+  pi.events.on("rewind:checkpoint-entry", (data) => {
+    if (!data || typeof data !== "object") return;
+    if (!("source" in data) || typeof data.source !== "string") return;
+    if (!CHECKPOINT_SOURCE_ALLOWLIST.has(data.source)) return;
+    if (!("entryId" in data) || typeof data.entryId !== "string") return;
+    const ctx = activeContext;
+    if (!ctx) return;
+
+    checkpointEntry(ctx, data.entryId).catch((error) => {
+      notify(ctx, `Rewind: failed to checkpoint ${data.entryId} (${error instanceof Error ? error.message : String(error)})`, "warning");
+    });
+  });
+
   pi.on("before_agent_start", async (event) => {
     activePromptText = event.prompt;
   });
@@ -1392,7 +1426,7 @@ export default function rewindExtension(pi: ExtensionAPI) {
       }
 
       if (!targetCommitSha) {
-        notify(ctx, "Exact file rewind is only available for user, assistant, compaction, and summary nodes", "error");
+        notify(ctx, "Exact file rewind is only available for user, assistant, custom message, compaction, and summary nodes", "error");
         return { cancel: true };
       }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-rewind-hook",
-  "version": "1.8.3",
+  "version": "1.8.4",
   "description": "Rewind extension for Pi agent - automatic git checkpoints with file/conversation restore",
   "repository": {
     "type": "git",