Undo and redo draft edits (#184)

AGENTS.md

@@ -35,7 +35,7 @@ This is a **Platform.Bible extension** for interlinear Bible text alignment. Pla
 
 [src/main.ts](src/main.ts) — called by Platform.Bible on activation. Exports two lifecycle functions:
 
-- `activate(context)` — stores the `ExecutionToken`, registers the `interlinearizer.mainWebView` WebView provider, command handlers, the `interlinearizer.continuousScroll` project settings validator, and the `onDidOpenWebView` / `onDidCloseWebView` subscriptions. All registrations are added to `context.registrations` so the platform disposes them on deactivation.
+- `activate(context)` — stores the `ExecutionToken`, registers the `interlinearizer.mainWebView` WebView provider, command handlers, the `interlinearizer.onUndoFromNotification` network event emitter, the `interlinearizer.continuousScroll` project settings validator, and the `onDidOpenWebView` / `onDidCloseWebView` subscriptions. All registrations are added to `context.registrations` so the platform disposes them on deactivation.
 - `deactivate()` — clears `openWebViewsByProject` and returns `true`.
 
 `openWebViewsByProject` (`Map<string, string>`) tracks one open WebView ID per project to prevent duplicates; reopening an already-open project brings that tab to front via the `existingId` option.

__mocks__/papi-backend.ts

@@ -17,6 +17,7 @@ const mockDeleteUserData = jest.fn();
 const mockNotificationsSend = jest.fn();
 const mockProjectDataProvidersGet = jest.fn();
 const mockGetLocalizedString = jest.fn();
+const mockCreateNetworkEventEmitterAsync = jest.fn();
 const mockLogger = {
   debug: jest.fn(),
   error: jest.fn(),
@@ -43,6 +44,9 @@ const papi = {
   localization: {
     getLocalizedString: mockGetLocalizedString,
   },
+  network: {
+    createNetworkEventEmitterAsync: mockCreateNetworkEventEmitterAsync,
+  },
   storage: {
     readUserData: mockReadUserData,
     writeUserData: mockWriteUserData,
@@ -79,6 +83,7 @@ const defaultExport = {
   __mockNotificationsSend: mockNotificationsSend,
   __mockProjectDataProvidersGet: mockProjectDataProvidersGet,
   __mockGetLocalizedString: mockGetLocalizedString,
+  __mockCreateNetworkEventEmitterAsync: mockCreateNetworkEventEmitterAsync,
   __mockLogger: mockLogger,
 };
 

__mocks__/papi-frontend.ts

@@ -12,6 +12,9 @@ const mockLogger = {
 
 const mockSendCommand = jest.fn();
 const mockNotificationsSend = jest.fn();
+const mockNotificationsDismiss = jest.fn();
+const mockGetLocalizedString = jest.fn();
+const mockGetNetworkEvent = jest.fn();
 const mockProjectDataProvidersGet = jest.fn();
 const mockNetworkObjectsGet = jest.fn();
 const mockWaitForNetworkObject = jest.fn();
@@ -22,6 +25,13 @@ const papi = {
   },
   notifications: {
     send: mockNotificationsSend,
+    dismiss: mockNotificationsDismiss,
+  },
+  localization: {
+    getLocalizedString: mockGetLocalizedString,
+  },
+  network: {
+    getNetworkEvent: mockGetNetworkEvent,
   },
   menuData: {
     dataProviderName: 'platform.menuDataServiceDataProvider',

__mocks__/platform-bible-react.tsx

@@ -116,6 +116,24 @@ export const MOCK_WIPE_MENU_ITEM: MenuItemContainingCommand = {
   localizeNotes: '',
 };
 
+/** Sentinel menu item passed by the mock toolbar when the undo button is clicked. */
+export const MOCK_UNDO_MENU_ITEM: MenuItemContainingCommand = {
+  label: '%interlinearizer_undo%',
+  command: 'interlinearizer.undo',
+  group: 'interlinearizer.editActions',
+  order: 1,
+  localizeNotes: '',
+};
+
+/** Sentinel menu item passed by the mock toolbar when the redo button is clicked. */
+export const MOCK_REDO_MENU_ITEM: MenuItemContainingCommand = {
+  label: '%interlinearizer_redo%',
+  command: 'interlinearizer.redo',
+  group: 'interlinearizer.editActions',
+  order: 2,
+  localizeNotes: '',
+};
+
 /** Sentinel menu item passed by the mock toolbar when the analysis-catalog button is clicked. */
 export const MOCK_OPEN_ANALYSIS_CATALOG_MENU_ITEM: MenuItemContainingCommand = {
   label: '%interlinearizer_openAnalysisCatalog%',
@@ -247,6 +265,24 @@ export function TabToolbar({
           Wipe
         </button>
       )}
+      {onSelectProjectMenuItem && (
+        <button
+          type="button"
+          data-testid="tab-toolbar-undo"
+          onClick={() => onSelectProjectMenuItem(MOCK_UNDO_MENU_ITEM)}
+        >
+          Undo
+        </button>
+      )}
+      {onSelectProjectMenuItem && (
+        <button
+          type="button"
+          data-testid="tab-toolbar-redo"
+          onClick={() => onSelectProjectMenuItem(MOCK_REDO_MENU_ITEM)}
+        >
+          Redo
+        </button>
+      )}
       {onSelectProjectMenuItem && (
         <button
           type="button"
@@ -485,6 +521,7 @@ export const Input = forwardRef<
     onKeyDown?: KeyboardEventHandler<HTMLInputElement>;
     'aria-label'?: string;
     'data-testid'?: string;
+    'data-draft-field'?: string;
   }>
 >(function InputImpl(
   {
@@ -500,12 +537,14 @@ export const Input = forwardRef<
     onKeyDown,
     'aria-label': ariaLabel,
     'data-testid': testId,
+    'data-draft-field': draftField,
   },
   ref,
 ) {
   return (
     <input
       ref={ref}
+      data-draft-field={draftField}
       id={id}
       type={type ?? 'text'}
       value={value}
@@ -694,6 +733,42 @@ export function BookChapterControl({
   );
 }
 
+/** Stub event hook; a test reads the handler it was given off its calls to fire an event. */
+export const useEvent = jest.fn();
+
+/** Localization keys of the undo and redo button tooltips, as the real component exports them. */
+export const UNDO_REDO_BUTTONS_STRING_KEYS = Object.freeze([
+  '%undoButton_tooltip%',
+  '%redoButton_tooltip%',
+] as const);
+
+/** Stub undo and redo buttons, each labeled by its tooltip key and disabled as the props say. */
+export function UndoRedoButtons({
+  onUndoClick,
+  onRedoClick,
+  canUndo = true,
+  canRedo = true,
+}: Readonly<{
+  onUndoClick: () => void;
+  onRedoClick?: () => void;
+  canUndo?: boolean;
+  canRedo?: boolean;
+  localizedStrings?: Record<string, string | undefined>;
+}>): ReactElement {
+  return (
+    <>
+      <button type="button" aria-label="%undoButton_tooltip%" disabled={!canUndo} onClick={onUndoClick}>
+        Undo
+      </button>
+      {onRedoClick && (
+        <button type="button" aria-label="%redoButton_tooltip%" disabled={!canRedo} onClick={onRedoClick}>
+          Redo
+        </button>
+      )}
+    </>
+  );
+}
+
 /**
  * Stub toggle switch rendered as a native checkbox so tests can read and change the checked state
  * without the real Radix UI implementation.

contributions/localizedStrings.json

@@ -17,6 +17,20 @@
       "%interlinearizer_openLexiconChooser%": "Connect a Lexicon…",
       "%interlinearizer_error_openLexiconChooser_failed%": "The lexicon chooser could not be opened.",
 
+      "%interlinearizer_menu_column_edit%": "Edit",
+      "%interlinearizer_undo%": "Undo",
+      "%interlinearizer_redo%": "Redo",
+      "%interlinearizer_undone_catalogEdit%": "Undid an edit to the analysis of {form}.",
+      "%interlinearizer_redone_catalogEdit%": "Redid an edit to the analysis of {form}.",
+      "%interlinearizer_undone_catalogMerge%": "Undid a merge into the analysis of {form}.",
+      "%interlinearizer_redone_catalogMerge%": "Redid a merge into the analysis of {form}.",
+      "%interlinearizer_undone_catalogDelete%": "Undid deleting the analysis of {form} ({count} uses).",
+      "%interlinearizer_redone_catalogDelete%": "Redid deleting the analysis of {form} ({count} uses).",
+      "%interlinearizer_undone_wipeBook%": "Undid wiping {book}.",
+      "%interlinearizer_redone_wipeBook%": "Redid wiping {book}.",
+      "%interlinearizer_undone_wipeAll%": "Undid wiping the whole draft.",
+      "%interlinearizer_redone_wipeAll%": "Redid wiping the whole draft.",
+
       "%interlinearizer_menu_column_view%": "View",
       "%interlinearizer_openAnalysisCatalog%": "Analysis Catalog",
       "%interlinearizer_openConcordance%": "Concordance",
@@ -113,16 +127,13 @@
       "%interlinearizer_analysisCatalog_mergedDismiss%": "Dismiss",
       "%interlinearizer_analysisCatalog_draftStranded%": "An edit elsewhere removed the analysis of {form}, discarding the breakdown you were typing for it.",
       "%interlinearizer_analysisCatalog_delete%": "Delete",
-      "%interlinearizer_analysisCatalog_deleteTitle%": "Delete the analysis of {form}?",
-      "%interlinearizer_analysisCatalog_deleteBlank%": "{count} uses will be left with no analysis.",
-      "%interlinearizer_analysisCatalog_deleteBlankNone%": "No token is analyzed as this, so nothing on screen changes.",
-      "%interlinearizer_analysisCatalog_deleteFallback%": "{count} uses will fall back to {gloss}.",
-      "%interlinearizer_analysisCatalog_deleteFallbackNoGloss%": "{count} uses will fall back to another analysis of the same form.",
-      "%interlinearizer_analysisCatalog_deleteFallbackUncertain%": "{count} uses will each fall back to another analysis or be left with none, depending on the use.",
-      "%interlinearizer_analysisCatalog_deleteUnapplied%": "{count} tokens also record this analysis without using it; those records are deleted too.",
-      "%interlinearizer_analysisCatalog_deleteUndoWarning%": "This cannot be undone.",
-      "%interlinearizer_analysisCatalog_deleteCancel%": "Cancel",
-      "%interlinearizer_analysisCatalog_deleteConfirm%": "Delete",
+      "%interlinearizer_analysisCatalog_deleted%": "Deleted the analysis of {form}.",
+      "%interlinearizer_analysisCatalog_deleteBlank%": "{count} uses are left with no analysis.",
+      "%interlinearizer_analysisCatalog_deleteBlankNone%": "No token was analyzed as this, so nothing on screen changed.",
+      "%interlinearizer_analysisCatalog_deleteFallback%": "{count} uses fall back to {gloss}.",
+      "%interlinearizer_analysisCatalog_deleteFallbackNoGloss%": "{count} uses fall back to another analysis of the same form.",
+      "%interlinearizer_analysisCatalog_deleteFallbackUncertain%": "{count} uses each fall back to another analysis or are left with none, depending on the use.",
+      "%interlinearizer_analysisCatalog_deleteUnapplied%": "{count} tokens also recorded this analysis without using it; those records were deleted too.",
       "%interlinearizer_analysisCatalog_closeConfirmTitle%": "Discard the unsaved breakdown?",
       "%interlinearizer_analysisCatalog_closeConfirmPrompt%": "You have typed a morpheme breakdown but not saved it. Closing the catalog discards it.",
       "%interlinearizer_analysisCatalog_closeConfirmCancel%": "Keep editing",

contributions/menus.json

@@ -22,10 +22,15 @@
             "localizeNotes": "Interlinearizer top menu column for project actions",
             "order": 1
           },
+          "interlinearizer.edit": {
+            "label": "%interlinearizer_menu_column_edit%",
+            "localizeNotes": "Interlinearizer top menu column for undoing and redoing edits",
+            "order": 2
+          },
           "interlinearizer.view": {
             "label": "%interlinearizer_menu_column_view%",
             "localizeNotes": "Interlinearizer top menu column for opening views of the analysis",
-            "order": 2
+            "order": 3
           }
         },
         "groups": {
@@ -45,6 +50,10 @@
             "column": "interlinearizer.project",
             "order": 4
           },
+          "interlinearizer.editActions": {
+            "column": "interlinearizer.edit",
+            "order": 1
+          },
           "interlinearizer.viewActions": {
             "column": "interlinearizer.view",
             "order": 1
@@ -100,6 +109,20 @@
             "order": 1,
             "command": "interlinearizer.openLexiconChooser"
           },
+          {
+            "label": "%interlinearizer_undo%",
+            "localizeNotes": "Interlinearizer top menu > Edit > Undo the latest edit to the draft",
+            "group": "interlinearizer.editActions",
+            "order": 1,
+            "command": "interlinearizer.undo"
+          },
+          {
+            "label": "%interlinearizer_redo%",
+            "localizeNotes": "Interlinearizer top menu > Edit > Redo the most recently undone edit",
+            "group": "interlinearizer.editActions",
+            "order": 2,
+            "command": "interlinearizer.redo"
+          },
           {
             "label": "%interlinearizer_openAnalysisCatalog%",
             "localizeNotes": "Interlinearizer top menu > Open the analysis catalog, listing every analysis recorded in the draft with its usage counts and locations",