Align stub with actual implementation, send notification when save/submission fails, docs adjustments

Author: alex-rawlings-yyc

src/__tests__/components/CreateProjectModal.test.tsx

@@ -210,7 +210,7 @@ describe('CreateProjectModal', () => {
     expect(onClose).not.toHaveBeenCalled();
   });
 
-  it('does not call onProjectCreated, onClose, or send a notification when sendCommand returns undefined', async () => {
+  it('does not call onProjectCreated or onClose when sendCommand returns undefined', async () => {
     jest.mocked(papi.commands.sendCommand).mockResolvedValue(undefined);
     const onProjectCreated = jest.fn();
     const onClose = jest.fn();
@@ -227,7 +227,20 @@ describe('CreateProjectModal', () => {
     await waitFor(() => expect(papi.commands.sendCommand).toHaveBeenCalled());
     expect(onProjectCreated).not.toHaveBeenCalled();
     expect(onClose).not.toHaveBeenCalled();
-    expect(papi.notifications.send).not.toHaveBeenCalled();
+  });
+
+  it('sends an error notification when sendCommand returns undefined', async () => {
+    jest.mocked(papi.commands.sendCommand).mockResolvedValue(undefined);
+    render(<CreateProjectModal projectId={testProjectId} onClose={jest.fn()} />);
+
+    await userEvent.click(screen.getByRole('button', { name: /^create$/i }));
+
+    await waitFor(() =>
+      expect(papi.notifications.send).toHaveBeenCalledWith({
+        message: '%interlinearizer_error_create_project_failed%',
+        severity: 'error',
+      }),
+    );
   });
 
   it('defaults analysis language to ["und"] when the language input contains only whitespace', async () => {

src/__tests__/components/InterlinearizerLoader.test.tsx

@@ -140,7 +140,7 @@ jest.mock('../../components/ProjectModals', () => ({
               data-testid="create-modal-created"
               onClick={() => {
                 setActiveProject(STUB_ACTIVE_PROJECT);
-                setModal('select');
+                setModal('none');
               }}
             >
               Created
@@ -624,7 +624,7 @@ describe('InterlinearizerLoader', () => {
       expect(screen.queryByTestId('create-modal')).not.toBeInTheDocument();
     });
 
-    it('returns to the select modal after a project is created from the select modal', async () => {
+    it('closes all modals after a project is created from the select modal', async () => {
       render(
         <InterlinearizerLoader
           projectId={testProjectId}
@@ -638,7 +638,7 @@ describe('InterlinearizerLoader', () => {
       await userEvent.click(screen.getByTestId('create-modal-created'));
 
       expect(screen.queryByTestId('create-modal')).not.toBeInTheDocument();
-      expect(screen.getByTestId('select-modal')).toBeInTheDocument();
+      expect(screen.queryByTestId('select-modal')).not.toBeInTheDocument();
     });
 
     it('sets the active project and closes the select modal when a project is selected', async () => {

src/__tests__/components/ProjectMetadataModal.test.tsx

@@ -219,7 +219,7 @@ describe('ProjectMetadataModal', () => {
     );
   });
 
-  it('does not call onProjectSaved, onClose, or send a notification when save sendCommand resolves with a falsy value', async () => {
+  it('does not call onProjectSaved or onClose when save sendCommand resolves with a falsy value', async () => {
     mockSendCommand.mockResolvedValue(undefined);
     const onProjectSaved = jest.fn();
     const onClose = jest.fn();
@@ -232,7 +232,20 @@ describe('ProjectMetadataModal', () => {
     await waitFor(() => expect(mockSendCommand).toHaveBeenCalled());
     expect(onProjectSaved).not.toHaveBeenCalled();
     expect(onClose).not.toHaveBeenCalled();
-    expect(papi.notifications.send).not.toHaveBeenCalled();
+  });
+
+  it('sends an error notification when save sendCommand resolves with a falsy value', async () => {
+    mockSendCommand.mockResolvedValue(undefined);
+    render(<ProjectMetadataModal {...testProps} />);
+
+    await userEvent.click(screen.getByRole('button', { name: /^save$/i }));
+
+    await waitFor(() =>
+      expect(papi.notifications.send).toHaveBeenCalledWith({
+        message: '%interlinearizer_error_save_metadata_failed%',
+        severity: 'error',
+      }),
+    );
   });
 
   it('does not call onProjectSaved, onClose, or send a notification when save sendCommand rejects', async () => {

src/__tests__/components/ProjectModals.test.tsx

@@ -81,7 +81,10 @@ jest.mock('../../components/CreateProjectModal', () => ({
       <button
         type="button"
         data-testid="create-created"
-        onClick={() => onProjectCreated(MOCK_PROJECT)}
+        onClick={() => {
+          onProjectCreated(MOCK_PROJECT);
+          onClose();
+        }}
       >
         Created
       </button>

src/components/CreateProjectModal.tsx

@@ -80,7 +80,13 @@ export function CreateProjectModal({
         name.trim() || undefined,
         description.trim() || undefined,
       );
-      if (!projectJson) return;
+      if (!projectJson) {
+        await papi.notifications.send({
+          message: '%interlinearizer_error_create_project_failed%',
+          severity: 'error',
+        });
+        return;
+      }
       const parsed: unknown = JSON.parse(projectJson);
       if (!isInterlinearProjectSummary(parsed)) {
         await papi.notifications.send({

src/components/ProjectMetadataModal.tsx

@@ -117,7 +117,13 @@ export function ProjectMetadataModal({
         newLanguages,
         targetProjectId,
       );
-      if (!updatedProjectJson) return;
+      if (!updatedProjectJson) {
+        await papi.notifications.send({
+          message: '%interlinearizer_error_save_metadata_failed%',
+          severity: 'error',
+        });
+        return;
+      }
       onProjectSaved?.({
         name: newName,
         description: newDescription,

src/types/interlinearizer.d.ts

@@ -53,7 +53,7 @@ declare module 'papi-shared-types' {
      * and to decide whether to show "create new" vs "select existing" on first open.
      *
      * @param sourceProjectId Platform.Bible project ID of the source text to query.
-     * @returns A JSON string containing an `InterlinearProjectSummary[]`; `"[]"` when none exist.
+     * @returns A JSON string containing an `InterlinearProject[]`; `"[]"` when none exist.
      */
     'interlinearizer.getProjectsForSource': (sourceProjectId: string) => Promise<string>;
 
@@ -574,7 +574,7 @@ declare module 'interlinearizer' {
     /** The `Analysis.id` for the linked analysis payload record. */
     analysisId: string;
 
-    /** Required review status. */
+    /** Review status of this analysis assignment. */
     status: AssignmentStatus;
 
     /** How much to trust this analysis assignment. */
@@ -792,8 +792,8 @@ declare module 'interlinearizer' {
 
   /** Links one `PhraseAnalysis` payload record to one or more token snapshots. */
   export interface PhraseAnalysisLink extends AnalysisLink {
-    /** Ordered snapshots of tokens that compose this phrase. */
-    tokens: [TokenSnapshot, ...TokenSnapshot[]];
+    /** Ordered snapshots of tokens that compose this phrase (one or more). */
+    tokens: TokenSnapshot[];
   }
 
   /**