feat(transcription): swap plain textarea for PersonMentionEditor and thread mentionedPersons through autosave
- TranscriptionBlockData now carries mentionedPersons (matches backend schema added in PR-A). - useBlockAutoSave.saveFn signature widens to (blockId, text, mentions); pendingMentions is tracked alongside pendingTexts and is preserved on failure so a retry resends the in-flight payload (B12). - TranscriptionBlock.svelte renders <PersonMentionEditor>, exposing the textarea node back through a captureTextarea callback so the existing quote-selection feature still works. - saveBlock in routes/documents/[id]/+page.svelte forwards mentions on PUT. - flushOnUnload sends mentions in the keepalive payload too. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -16,6 +16,10 @@ type Props = {
|
|||||||
disabled?: boolean;
|
disabled?: boolean;
|
||||||
onfocus?: () => void;
|
onfocus?: () => void;
|
||||||
onblur?: () => void;
|
onblur?: () => void;
|
||||||
|
// Optional escape hatch: lets the parent observe the underlying textarea node
|
||||||
|
// (e.g. to read selection bounds for quote-selection features). Returning a
|
||||||
|
// cleanup function from the parent is not required.
|
||||||
|
captureTextarea?: (node: HTMLTextAreaElement) => void | (() => void);
|
||||||
};
|
};
|
||||||
|
|
||||||
let {
|
let {
|
||||||
@@ -25,7 +29,8 @@ let {
|
|||||||
rows = 1,
|
rows = 1,
|
||||||
disabled = false,
|
disabled = false,
|
||||||
onfocus,
|
onfocus,
|
||||||
onblur
|
onblur,
|
||||||
|
captureTextarea
|
||||||
}: Props = $props();
|
}: Props = $props();
|
||||||
|
|
||||||
let query: string | null = $state(null);
|
let query: string | null = $state(null);
|
||||||
@@ -38,7 +43,9 @@ let debounceTimer: ReturnType<typeof setTimeout> | undefined;
|
|||||||
|
|
||||||
function attachTextarea(node: HTMLTextAreaElement) {
|
function attachTextarea(node: HTMLTextAreaElement) {
|
||||||
textarea = node;
|
textarea = node;
|
||||||
|
const parentCleanup = captureTextarea?.(node);
|
||||||
return () => {
|
return () => {
|
||||||
|
parentCleanup?.();
|
||||||
textarea = null;
|
textarea = null;
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,6 +2,8 @@
|
|||||||
import { m } from '$lib/paraglide/messages.js';
|
import { m } from '$lib/paraglide/messages.js';
|
||||||
import { getConfirmService } from '$lib/services/confirm.svelte.js';
|
import { getConfirmService } from '$lib/services/confirm.svelte.js';
|
||||||
import CommentThread from './CommentThread.svelte';
|
import CommentThread from './CommentThread.svelte';
|
||||||
|
import PersonMentionEditor from './PersonMentionEditor.svelte';
|
||||||
|
import type { PersonMention } from '$lib/types';
|
||||||
|
|
||||||
const { confirm } = getConfirmService();
|
const { confirm } = getConfirmService();
|
||||||
|
|
||||||
@@ -12,13 +14,14 @@ type Props = {
|
|||||||
documentId: string;
|
documentId: string;
|
||||||
blockNumber: number;
|
blockNumber: number;
|
||||||
text: string;
|
text: string;
|
||||||
|
mentionedPersons: PersonMention[];
|
||||||
label: string | null;
|
label: string | null;
|
||||||
active: boolean;
|
active: boolean;
|
||||||
reviewed: boolean;
|
reviewed: boolean;
|
||||||
saveState: SaveState;
|
saveState: SaveState;
|
||||||
canComment: boolean;
|
canComment: boolean;
|
||||||
currentUserId: string | null;
|
currentUserId: string | null;
|
||||||
onTextChange: (text: string) => void;
|
onTextChange: (text: string, mentionedPersons: PersonMention[]) => void;
|
||||||
onFocus: () => void;
|
onFocus: () => void;
|
||||||
onDeleteClick: () => void;
|
onDeleteClick: () => void;
|
||||||
onRetry: () => void;
|
onRetry: () => void;
|
||||||
@@ -35,6 +38,7 @@ let {
|
|||||||
documentId,
|
documentId,
|
||||||
blockNumber,
|
blockNumber,
|
||||||
text,
|
text,
|
||||||
|
mentionedPersons,
|
||||||
label = null,
|
label = null,
|
||||||
active,
|
active,
|
||||||
reviewed,
|
reviewed,
|
||||||
@@ -54,10 +58,10 @@ let {
|
|||||||
}: Props = $props();
|
}: Props = $props();
|
||||||
|
|
||||||
let localText = $state(text);
|
let localText = $state(text);
|
||||||
|
let localMentions = $state<PersonMention[]>([...mentionedPersons]);
|
||||||
let commentOpen = $state(false);
|
let commentOpen = $state(false);
|
||||||
let commentCount = $state(0);
|
let commentCount = $state(0);
|
||||||
let selectedQuote = $state<string | null>(null);
|
let selectedQuote = $state<string | null>(null);
|
||||||
let textareaEl = $state<HTMLTextAreaElement | null>(null);
|
|
||||||
|
|
||||||
const hasComments = $derived(commentCount > 0);
|
const hasComments = $derived(commentCount > 0);
|
||||||
|
|
||||||
@@ -66,6 +70,7 @@ let prevBlockId = $state(blockId);
|
|||||||
$effect(() => {
|
$effect(() => {
|
||||||
if (blockId !== prevBlockId) {
|
if (blockId !== prevBlockId) {
|
||||||
localText = text;
|
localText = text;
|
||||||
|
localMentions = [...mentionedPersons];
|
||||||
prevBlockId = blockId;
|
prevBlockId = blockId;
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -74,29 +79,32 @@ let leftBorderClass = $derived(
|
|||||||
saveState === 'error' ? 'border-l-2 border-error' : active ? 'border-l-2 border-turquoise' : ''
|
saveState === 'error' ? 'border-l-2 border-error' : active ? 'border-l-2 border-turquoise' : ''
|
||||||
);
|
);
|
||||||
|
|
||||||
function autoresize(node: HTMLTextAreaElement) {
|
// Single source of truth for the editor's textarea — stored on attach so
|
||||||
|
// we can read selection bounds for quote selection without re-querying the DOM.
|
||||||
|
let textareaEl: HTMLTextAreaElement | null = null;
|
||||||
|
|
||||||
|
function captureTextarea(node: HTMLTextAreaElement) {
|
||||||
textareaEl = node;
|
textareaEl = node;
|
||||||
function resize() {
|
resizeTextarea();
|
||||||
node.style.height = 'auto';
|
return () => {
|
||||||
node.style.height = `${node.scrollHeight}px`;
|
textareaEl = null;
|
||||||
}
|
|
||||||
|
|
||||||
resize();
|
|
||||||
|
|
||||||
return {
|
|
||||||
update() {
|
|
||||||
resize();
|
|
||||||
},
|
|
||||||
destroy() {
|
|
||||||
textareaEl = null;
|
|
||||||
}
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
function handleInput(event: Event) {
|
function resizeTextarea() {
|
||||||
const target = event.target as HTMLTextAreaElement;
|
if (!textareaEl) return;
|
||||||
localText = target.value;
|
textareaEl.style.height = 'auto';
|
||||||
onTextChange(target.value);
|
textareaEl.style.height = `${textareaEl.scrollHeight}px`;
|
||||||
|
}
|
||||||
|
|
||||||
|
$effect(() => {
|
||||||
|
// Re-run autoresize whenever the bound text changes.
|
||||||
|
void localText;
|
||||||
|
resizeTextarea();
|
||||||
|
});
|
||||||
|
|
||||||
|
function emitChange() {
|
||||||
|
onTextChange(localText, localMentions);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function handleDelete() {
|
async function handleDelete() {
|
||||||
@@ -181,17 +189,24 @@ function handleTextareaMouseUp() {
|
|||||||
{/if}
|
{/if}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<!-- Textarea -->
|
<!-- Textarea (now powered by PersonMentionEditor for @-mention typeahead) -->
|
||||||
<textarea
|
<div onmouseup={handleTextareaMouseUp} role="presentation">
|
||||||
use:autoresize={localText}
|
<PersonMentionEditor
|
||||||
class="w-full resize-none border-none bg-transparent font-serif text-base leading-relaxed text-ink outline-none placeholder:text-ink-3"
|
bind:value={() => localText,
|
||||||
placeholder={m.transcription_block_placeholder()}
|
(v) => {
|
||||||
rows={1}
|
localText = v;
|
||||||
value={localText}
|
emitChange();
|
||||||
oninput={handleInput}
|
}}
|
||||||
onfocus={onFocus}
|
bind:mentionedPersons={() => localMentions,
|
||||||
onmouseup={handleTextareaMouseUp}
|
(m) => {
|
||||||
></textarea>
|
localMentions = m;
|
||||||
|
emitChange();
|
||||||
|
}}
|
||||||
|
placeholder={m.transcription_block_placeholder()}
|
||||||
|
onfocus={onFocus}
|
||||||
|
captureTextarea={captureTextarea}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
|
||||||
{#if selectedQuote}
|
{#if selectedQuote}
|
||||||
<p class="mt-1 text-xs text-ink-3">{m.transcription_block_quote_hint()}</p>
|
<p class="mt-1 text-xs text-ink-3">{m.transcription_block_quote_hint()}</p>
|
||||||
|
|||||||
@@ -1,21 +1,24 @@
|
|||||||
<script lang="ts">
|
<script lang="ts">
|
||||||
import { provideConfirmService, type ConfirmService } from '$lib/services/confirm.svelte.js';
|
import { provideConfirmService, type ConfirmService } from '$lib/services/confirm.svelte.js';
|
||||||
import TranscriptionBlock from './TranscriptionBlock.svelte';
|
import TranscriptionBlock from './TranscriptionBlock.svelte';
|
||||||
|
import type { PersonMention } from '$lib/types';
|
||||||
|
|
||||||
type BlockProps = {
|
type BlockProps = {
|
||||||
blockId: string;
|
blockId: string;
|
||||||
documentId: string;
|
documentId: string;
|
||||||
blockNumber: number;
|
blockNumber: number;
|
||||||
text: string;
|
text: string;
|
||||||
|
mentionedPersons?: PersonMention[];
|
||||||
label: string | null;
|
label: string | null;
|
||||||
active: boolean;
|
active: boolean;
|
||||||
saveState: 'idle' | 'saving' | 'saved' | 'fading' | 'error';
|
saveState: 'idle' | 'saving' | 'saved' | 'fading' | 'error';
|
||||||
canComment: boolean;
|
canComment: boolean;
|
||||||
currentUserId: string | null;
|
currentUserId: string | null;
|
||||||
onTextChange: (text: string) => void;
|
onTextChange: (text: string, mentionedPersons: PersonMention[]) => void;
|
||||||
onFocus: () => void;
|
onFocus: () => void;
|
||||||
onDeleteClick: () => void;
|
onDeleteClick: () => void;
|
||||||
onRetry: () => void;
|
onRetry: () => void;
|
||||||
|
onReviewToggle?: () => void;
|
||||||
onMoveUp?: () => void;
|
onMoveUp?: () => void;
|
||||||
onMoveDown?: () => void;
|
onMoveDown?: () => void;
|
||||||
isFirst?: boolean;
|
isFirst?: boolean;
|
||||||
@@ -24,13 +27,22 @@ type BlockProps = {
|
|||||||
|
|
||||||
let {
|
let {
|
||||||
onServiceReady,
|
onServiceReady,
|
||||||
|
mentionedPersons = [],
|
||||||
|
reviewed = false,
|
||||||
|
onReviewToggle = () => {},
|
||||||
...blockProps
|
...blockProps
|
||||||
}: BlockProps & {
|
}: BlockProps & {
|
||||||
onServiceReady: (s: ConfirmService) => void;
|
onServiceReady: (s: ConfirmService) => void;
|
||||||
|
reviewed?: boolean;
|
||||||
} = $props();
|
} = $props();
|
||||||
|
|
||||||
const service = provideConfirmService();
|
const service = provideConfirmService();
|
||||||
onServiceReady(service);
|
onServiceReady(service);
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<TranscriptionBlock {...blockProps} />
|
<TranscriptionBlock
|
||||||
|
{...blockProps}
|
||||||
|
mentionedPersons={mentionedPersons}
|
||||||
|
reviewed={reviewed}
|
||||||
|
onReviewToggle={onReviewToggle}
|
||||||
|
/>
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import { m } from '$lib/paraglide/messages.js';
|
|||||||
import TranscriptionBlock from './TranscriptionBlock.svelte';
|
import TranscriptionBlock from './TranscriptionBlock.svelte';
|
||||||
import OcrTrigger from './OcrTrigger.svelte';
|
import OcrTrigger from './OcrTrigger.svelte';
|
||||||
import TranscribeCoachEmptyState from './TranscribeCoachEmptyState.svelte';
|
import TranscribeCoachEmptyState from './TranscribeCoachEmptyState.svelte';
|
||||||
import type { TranscriptionBlockData } from '$lib/types';
|
import type { PersonMention, TranscriptionBlockData } from '$lib/types';
|
||||||
import { createBlockAutoSave } from '$lib/hooks/useBlockAutoSave.svelte';
|
import { createBlockAutoSave } from '$lib/hooks/useBlockAutoSave.svelte';
|
||||||
import { createBlockDragDrop } from '$lib/hooks/useBlockDragDrop.svelte';
|
import { createBlockDragDrop } from '$lib/hooks/useBlockDragDrop.svelte';
|
||||||
|
|
||||||
@@ -16,7 +16,7 @@ type Props = {
|
|||||||
storedScriptType?: string;
|
storedScriptType?: string;
|
||||||
canRunOcr?: boolean;
|
canRunOcr?: boolean;
|
||||||
onBlockFocus: (blockId: string) => void;
|
onBlockFocus: (blockId: string) => void;
|
||||||
onSaveBlock: (blockId: string, text: string) => Promise<void>;
|
onSaveBlock: (blockId: string, text: string, mentionedPersons: PersonMention[]) => Promise<void>;
|
||||||
onDeleteBlock: (blockId: string) => Promise<void>;
|
onDeleteBlock: (blockId: string) => Promise<void>;
|
||||||
onReviewToggle: (blockId: string) => Promise<void>;
|
onReviewToggle: (blockId: string) => Promise<void>;
|
||||||
onMarkAllReviewed?: () => Promise<void>;
|
onMarkAllReviewed?: () => Promise<void>;
|
||||||
@@ -245,16 +245,19 @@ async function handleLabelToggle(label: string) {
|
|||||||
documentId={documentId}
|
documentId={documentId}
|
||||||
blockNumber={i + 1}
|
blockNumber={i + 1}
|
||||||
text={block.text}
|
text={block.text}
|
||||||
|
mentionedPersons={block.mentionedPersons ?? []}
|
||||||
label={block.label}
|
label={block.label}
|
||||||
active={activeBlockId === block.id}
|
active={activeBlockId === block.id}
|
||||||
reviewed={block.reviewed ?? false}
|
reviewed={block.reviewed ?? false}
|
||||||
saveState={autoSave.getSaveState(block.id)}
|
saveState={autoSave.getSaveState(block.id)}
|
||||||
canComment={canComment}
|
canComment={canComment}
|
||||||
currentUserId={currentUserId}
|
currentUserId={currentUserId}
|
||||||
onTextChange={(text) => autoSave.handleTextChange(block.id, text)}
|
onTextChange={(text, mentions) =>
|
||||||
|
autoSave.handleTextChange(block.id, text, mentions)}
|
||||||
onFocus={() => handleFocus(block.id)}
|
onFocus={() => handleFocus(block.id)}
|
||||||
onDeleteClick={() => handleDelete(block.id)}
|
onDeleteClick={() => handleDelete(block.id)}
|
||||||
onRetry={() => autoSave.handleRetry(block.id, block.text)}
|
onRetry={() =>
|
||||||
|
autoSave.handleRetry(block.id, block.text, block.mentionedPersons ?? [])}
|
||||||
onReviewToggle={() => onReviewToggle(block.id)}
|
onReviewToggle={() => onReviewToggle(block.id)}
|
||||||
onMoveUp={() => handleMoveUp(block.id)}
|
onMoveUp={() => handleMoveUp(block.id)}
|
||||||
onMoveDown={() => handleMoveDown(block.id)}
|
onMoveDown={() => handleMoveDown(block.id)}
|
||||||
|
|||||||
@@ -15,7 +15,8 @@ const block1 = {
|
|||||||
sortOrder: 0,
|
sortOrder: 0,
|
||||||
version: 0,
|
version: 0,
|
||||||
source: 'MANUAL' as const,
|
source: 'MANUAL' as const,
|
||||||
reviewed: false
|
reviewed: false,
|
||||||
|
mentionedPersons: []
|
||||||
};
|
};
|
||||||
const block2 = {
|
const block2 = {
|
||||||
id: 'b2',
|
id: 'b2',
|
||||||
@@ -26,7 +27,8 @@ const block2 = {
|
|||||||
sortOrder: 1,
|
sortOrder: 1,
|
||||||
version: 0,
|
version: 0,
|
||||||
source: 'OCR' as const,
|
source: 'OCR' as const,
|
||||||
reviewed: true
|
reviewed: true,
|
||||||
|
mentionedPersons: []
|
||||||
};
|
};
|
||||||
|
|
||||||
function renderView(overrides: Record<string, unknown> = {}, service = createConfirmService()) {
|
function renderView(overrides: Record<string, unknown> = {}, service = createConfirmService()) {
|
||||||
@@ -141,7 +143,28 @@ describe('TranscriptionEditView — auto-save debounce', () => {
|
|||||||
vi.advanceTimersByTime(1500);
|
vi.advanceTimersByTime(1500);
|
||||||
await vi.runAllTimersAsync();
|
await vi.runAllTimersAsync();
|
||||||
|
|
||||||
expect(onSaveBlock).toHaveBeenCalledWith('b1', 'Neue Zeile');
|
expect(onSaveBlock).toHaveBeenCalledWith('b1', 'Neue Zeile', []);
|
||||||
|
vi.useRealTimers();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('passes the block mentionedPersons array as the 3rd save argument', async () => {
|
||||||
|
vi.useFakeTimers();
|
||||||
|
const onSaveBlock = vi.fn().mockResolvedValue(undefined);
|
||||||
|
const blockWithMention = {
|
||||||
|
...block1,
|
||||||
|
mentionedPersons: [{ personId: 'p-aug', displayName: 'Auguste Raddatz' }]
|
||||||
|
};
|
||||||
|
renderView({ blocks: [blockWithMention], onSaveBlock });
|
||||||
|
|
||||||
|
const textarea = page.getByRole('textbox').first();
|
||||||
|
await textarea.fill('Hallo @Auguste Raddatz');
|
||||||
|
|
||||||
|
vi.advanceTimersByTime(1500);
|
||||||
|
await vi.runAllTimersAsync();
|
||||||
|
|
||||||
|
expect(onSaveBlock).toHaveBeenCalledWith('b1', 'Hallo @Auguste Raddatz', [
|
||||||
|
{ personId: 'p-aug', displayName: 'Auguste Raddatz' }
|
||||||
|
]);
|
||||||
vi.useRealTimers();
|
vi.useRealTimers();
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -165,7 +188,7 @@ describe('TranscriptionEditView — auto-save debounce', () => {
|
|||||||
|
|
||||||
// Only one save with the final value
|
// Only one save with the final value
|
||||||
expect(onSaveBlock).toHaveBeenCalledTimes(1);
|
expect(onSaveBlock).toHaveBeenCalledTimes(1);
|
||||||
expect(onSaveBlock).toHaveBeenCalledWith('b1', 'Second');
|
expect(onSaveBlock).toHaveBeenCalledWith('b1', 'Second', []);
|
||||||
vi.useRealTimers();
|
vi.useRealTimers();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@@ -220,7 +243,7 @@ describe('TranscriptionEditView — flush on blur', () => {
|
|||||||
el.dispatchEvent(new FocusEvent('blur', { bubbles: true }));
|
el.dispatchEvent(new FocusEvent('blur', { bubbles: true }));
|
||||||
|
|
||||||
await vi.runAllTimersAsync();
|
await vi.runAllTimersAsync();
|
||||||
expect(onSaveBlock).toHaveBeenCalledWith('b1', 'Blur text');
|
expect(onSaveBlock).toHaveBeenCalledWith('b1', 'Blur text', []);
|
||||||
vi.useRealTimers();
|
vi.useRealTimers();
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -12,7 +12,10 @@ const blocks: TranscriptionBlockData[] = [
|
|||||||
text: 'First paragraph text.',
|
text: 'First paragraph text.',
|
||||||
label: null,
|
label: null,
|
||||||
sortOrder: 1,
|
sortOrder: 1,
|
||||||
version: 1
|
version: 1,
|
||||||
|
source: 'MANUAL',
|
||||||
|
reviewed: false,
|
||||||
|
mentionedPersons: []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
id: 'b2',
|
id: 'b2',
|
||||||
@@ -49,7 +52,10 @@ describe('TranscriptionReadView', () => {
|
|||||||
text: 'Text before [unleserlich] text after',
|
text: 'Text before [unleserlich] text after',
|
||||||
label: null,
|
label: null,
|
||||||
sortOrder: 1,
|
sortOrder: 1,
|
||||||
version: 1
|
version: 1,
|
||||||
|
source: 'MANUAL',
|
||||||
|
reviewed: false,
|
||||||
|
mentionedPersons: []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
onParagraphClick: () => {}
|
onParagraphClick: () => {}
|
||||||
@@ -71,7 +77,10 @@ describe('TranscriptionReadView', () => {
|
|||||||
text: 'Some [...] text',
|
text: 'Some [...] text',
|
||||||
label: null,
|
label: null,
|
||||||
sortOrder: 1,
|
sortOrder: 1,
|
||||||
version: 1
|
version: 1,
|
||||||
|
source: 'MANUAL',
|
||||||
|
reviewed: false,
|
||||||
|
mentionedPersons: []
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
onParagraphClick: () => {}
|
onParagraphClick: () => {}
|
||||||
|
|||||||
@@ -1,6 +1,10 @@
|
|||||||
import { describe, it, expect, vi, beforeEach, afterEach, type Mock } from 'vitest';
|
import { describe, it, expect, vi, beforeEach, afterEach, type Mock } from 'vitest';
|
||||||
|
import type { PersonMention } from '$lib/types';
|
||||||
|
|
||||||
const mockSaveFn = vi.fn<(blockId: string, text: string) => Promise<void>>();
|
const mockSaveFn =
|
||||||
|
vi.fn<(blockId: string, text: string, mentionedPersons: PersonMention[]) => Promise<void>>();
|
||||||
|
|
||||||
|
const NO_MENTIONS: PersonMention[] = [];
|
||||||
|
|
||||||
const { createBlockAutoSave } = await import('../useBlockAutoSave.svelte');
|
const { createBlockAutoSave } = await import('../useBlockAutoSave.svelte');
|
||||||
|
|
||||||
@@ -22,25 +26,25 @@ describe('createBlockAutoSave', () => {
|
|||||||
|
|
||||||
it('debounce coalesces multiple changes — saves once after 1500ms', async () => {
|
it('debounce coalesces multiple changes — saves once after 1500ms', async () => {
|
||||||
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
||||||
as.handleTextChange('block-1', 'text 1');
|
as.handleTextChange('block-1', 'text 1', NO_MENTIONS);
|
||||||
as.handleTextChange('block-1', 'text 2');
|
as.handleTextChange('block-1', 'text 2', NO_MENTIONS);
|
||||||
as.handleTextChange('block-1', 'text 3');
|
as.handleTextChange('block-1', 'text 3', NO_MENTIONS);
|
||||||
await vi.advanceTimersByTimeAsync(1500);
|
await vi.advanceTimersByTimeAsync(1500);
|
||||||
expect(mockSaveFn).toHaveBeenCalledTimes(1);
|
expect(mockSaveFn).toHaveBeenCalledTimes(1);
|
||||||
expect(mockSaveFn).toHaveBeenCalledWith('block-1', 'text 3');
|
expect(mockSaveFn).toHaveBeenCalledWith('block-1', 'text 3', NO_MENTIONS);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('handles concurrent blocks independently', async () => {
|
it('handles concurrent blocks independently', async () => {
|
||||||
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
||||||
as.handleTextChange('block-1', 'hello');
|
as.handleTextChange('block-1', 'hello', NO_MENTIONS);
|
||||||
as.handleTextChange('block-2', 'world');
|
as.handleTextChange('block-2', 'world', NO_MENTIONS);
|
||||||
await vi.advanceTimersByTimeAsync(1500);
|
await vi.advanceTimersByTimeAsync(1500);
|
||||||
expect(mockSaveFn).toHaveBeenCalledTimes(2);
|
expect(mockSaveFn).toHaveBeenCalledTimes(2);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('sets save state to saving then saved on success', async () => {
|
it('sets save state to saving then saved on success', async () => {
|
||||||
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
||||||
as.handleTextChange('block-1', 'text');
|
as.handleTextChange('block-1', 'text', NO_MENTIONS);
|
||||||
vi.advanceTimersByTime(1500);
|
vi.advanceTimersByTime(1500);
|
||||||
expect(as.getSaveState('block-1')).toBe('saving');
|
expect(as.getSaveState('block-1')).toBe('saving');
|
||||||
await Promise.resolve();
|
await Promise.resolve();
|
||||||
@@ -50,7 +54,7 @@ describe('createBlockAutoSave', () => {
|
|||||||
it('sets save state to error on save failure', async () => {
|
it('sets save state to error on save failure', async () => {
|
||||||
mockSaveFn.mockRejectedValue(new Error('save failed'));
|
mockSaveFn.mockRejectedValue(new Error('save failed'));
|
||||||
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
||||||
as.handleTextChange('block-1', 'text');
|
as.handleTextChange('block-1', 'text', NO_MENTIONS);
|
||||||
await vi.advanceTimersByTimeAsync(1500);
|
await vi.advanceTimersByTimeAsync(1500);
|
||||||
expect(as.getSaveState('block-1')).toBe('error');
|
expect(as.getSaveState('block-1')).toBe('error');
|
||||||
});
|
});
|
||||||
@@ -59,24 +63,24 @@ describe('createBlockAutoSave', () => {
|
|||||||
mockSaveFn.mockRejectedValueOnce(new Error('first fails'));
|
mockSaveFn.mockRejectedValueOnce(new Error('first fails'));
|
||||||
mockSaveFn.mockResolvedValueOnce(undefined);
|
mockSaveFn.mockResolvedValueOnce(undefined);
|
||||||
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
||||||
as.handleTextChange('block-1', 'original');
|
as.handleTextChange('block-1', 'original', NO_MENTIONS);
|
||||||
await vi.advanceTimersByTimeAsync(1500);
|
await vi.advanceTimersByTimeAsync(1500);
|
||||||
expect(as.getSaveState('block-1')).toBe('error');
|
expect(as.getSaveState('block-1')).toBe('error');
|
||||||
await as.handleRetry('block-1', 'original');
|
await as.handleRetry('block-1', 'original', NO_MENTIONS);
|
||||||
expect(mockSaveFn).toHaveBeenCalledTimes(2);
|
expect(mockSaveFn).toHaveBeenCalledTimes(2);
|
||||||
expect(as.getSaveState('block-1')).toBe('saved');
|
expect(as.getSaveState('block-1')).toBe('saved');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('clearBlock removes all state for a block', () => {
|
it('clearBlock removes all state for a block', () => {
|
||||||
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
||||||
as.handleTextChange('block-1', 'text');
|
as.handleTextChange('block-1', 'text', NO_MENTIONS);
|
||||||
as.clearBlock('block-1');
|
as.clearBlock('block-1');
|
||||||
expect(as.getSaveState('block-1')).toBe('idle');
|
expect(as.getSaveState('block-1')).toBe('idle');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('destroy clears all pending timers so no save occurs', async () => {
|
it('destroy clears all pending timers so no save occurs', async () => {
|
||||||
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
||||||
as.handleTextChange('block-1', 'text');
|
as.handleTextChange('block-1', 'text', NO_MENTIONS);
|
||||||
as.destroy();
|
as.destroy();
|
||||||
await vi.advanceTimersByTimeAsync(2000);
|
await vi.advanceTimersByTimeAsync(2000);
|
||||||
expect(mockSaveFn).not.toHaveBeenCalled();
|
expect(mockSaveFn).not.toHaveBeenCalled();
|
||||||
@@ -101,8 +105,8 @@ describe('flushOnUnload', () => {
|
|||||||
|
|
||||||
it('sends a PUT request with keepalive:true for each pending block', () => {
|
it('sends a PUT request with keepalive:true for each pending block', () => {
|
||||||
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
||||||
as.handleTextChange('block-1', 'hello');
|
as.handleTextChange('block-1', 'hello', NO_MENTIONS);
|
||||||
as.handleTextChange('block-2', 'world');
|
as.handleTextChange('block-2', 'world', NO_MENTIONS);
|
||||||
as.flushOnUnload();
|
as.flushOnUnload();
|
||||||
|
|
||||||
expect(mockFetch).toHaveBeenCalledTimes(2);
|
expect(mockFetch).toHaveBeenCalledTimes(2);
|
||||||
@@ -111,7 +115,7 @@ describe('flushOnUnload', () => {
|
|||||||
expect.objectContaining({
|
expect.objectContaining({
|
||||||
method: 'PUT',
|
method: 'PUT',
|
||||||
keepalive: true,
|
keepalive: true,
|
||||||
body: JSON.stringify({ text: 'hello' })
|
body: JSON.stringify({ text: 'hello', mentionedPersons: [] })
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
expect(mockFetch).toHaveBeenCalledWith(
|
expect(mockFetch).toHaveBeenCalledWith(
|
||||||
@@ -119,7 +123,7 @@ describe('flushOnUnload', () => {
|
|||||||
expect.objectContaining({
|
expect.objectContaining({
|
||||||
method: 'PUT',
|
method: 'PUT',
|
||||||
keepalive: true,
|
keepalive: true,
|
||||||
body: JSON.stringify({ text: 'world' })
|
body: JSON.stringify({ text: 'world', mentionedPersons: [] })
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
@@ -127,7 +131,7 @@ describe('flushOnUnload', () => {
|
|||||||
it('does not call navigator.sendBeacon', () => {
|
it('does not call navigator.sendBeacon', () => {
|
||||||
const sendBeaconSpy = vi.spyOn(navigator, 'sendBeacon').mockReturnValue(true);
|
const sendBeaconSpy = vi.spyOn(navigator, 'sendBeacon').mockReturnValue(true);
|
||||||
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
||||||
as.handleTextChange('block-1', 'text');
|
as.handleTextChange('block-1', 'text', NO_MENTIONS);
|
||||||
as.flushOnUnload();
|
as.flushOnUnload();
|
||||||
|
|
||||||
expect(sendBeaconSpy).not.toHaveBeenCalled();
|
expect(sendBeaconSpy).not.toHaveBeenCalled();
|
||||||
@@ -142,7 +146,7 @@ describe('flushOnUnload', () => {
|
|||||||
|
|
||||||
it('cancels the debounce timer so saveFn is not also called', async () => {
|
it('cancels the debounce timer so saveFn is not also called', async () => {
|
||||||
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
||||||
as.handleTextChange('block-1', 'text');
|
as.handleTextChange('block-1', 'text', NO_MENTIONS);
|
||||||
as.flushOnUnload();
|
as.flushOnUnload();
|
||||||
|
|
||||||
await vi.advanceTimersByTimeAsync(2000);
|
await vi.advanceTimersByTimeAsync(2000);
|
||||||
@@ -151,13 +155,26 @@ describe('flushOnUnload', () => {
|
|||||||
|
|
||||||
it('does not send fetch if debounce already fired and pendingTexts is empty', async () => {
|
it('does not send fetch if debounce already fired and pendingTexts is empty', async () => {
|
||||||
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
||||||
as.handleTextChange('block-1', 'text');
|
as.handleTextChange('block-1', 'text', NO_MENTIONS);
|
||||||
await vi.advanceTimersByTimeAsync(1500);
|
await vi.advanceTimersByTimeAsync(1500);
|
||||||
// debounce has fired; pendingTexts should be empty now
|
|
||||||
mockFetch.mockClear();
|
mockFetch.mockClear();
|
||||||
|
|
||||||
as.flushOnUnload();
|
as.flushOnUnload();
|
||||||
|
|
||||||
expect(mockFetch).not.toHaveBeenCalled();
|
expect(mockFetch).not.toHaveBeenCalled();
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('flushes the pending mentionedPersons sidecar alongside text', () => {
|
||||||
|
const as = createBlockAutoSave({ saveFn: mockSaveFn, documentId: 'doc-1' });
|
||||||
|
const mentions: PersonMention[] = [{ personId: 'p-1', displayName: 'Auguste Raddatz' }];
|
||||||
|
as.handleTextChange('block-1', '@Auguste Raddatz', mentions);
|
||||||
|
as.flushOnUnload();
|
||||||
|
|
||||||
|
expect(mockFetch).toHaveBeenCalledWith(
|
||||||
|
'/api/documents/doc-1/transcription-blocks/block-1',
|
||||||
|
expect.objectContaining({
|
||||||
|
body: JSON.stringify({ text: '@Auguste Raddatz', mentionedPersons: mentions })
|
||||||
|
})
|
||||||
|
);
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -12,7 +12,8 @@ function makeBlock(id: string, sortOrder: number): TranscriptionBlockData {
|
|||||||
sortOrder,
|
sortOrder,
|
||||||
version: 1,
|
version: 1,
|
||||||
source: 'MANUAL',
|
source: 'MANUAL',
|
||||||
reviewed: false
|
reviewed: false,
|
||||||
|
mentionedPersons: []
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -1,9 +1,10 @@
|
|||||||
import { SvelteMap } from 'svelte/reactivity';
|
import { SvelteMap } from 'svelte/reactivity';
|
||||||
|
import type { PersonMention } from '$lib/types';
|
||||||
|
|
||||||
export type SaveState = 'idle' | 'saving' | 'saved' | 'fading' | 'error';
|
export type SaveState = 'idle' | 'saving' | 'saved' | 'fading' | 'error';
|
||||||
|
|
||||||
type Options = {
|
type Options = {
|
||||||
saveFn: (blockId: string, text: string) => Promise<void>;
|
saveFn: (blockId: string, text: string, mentionedPersons: PersonMention[]) => Promise<void>;
|
||||||
documentId: string;
|
documentId: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -11,6 +12,7 @@ export function createBlockAutoSave({ saveFn, documentId }: Options) {
|
|||||||
const saveStates = new SvelteMap<string, SaveState>();
|
const saveStates = new SvelteMap<string, SaveState>();
|
||||||
const debounceTimers = new SvelteMap<string, ReturnType<typeof setTimeout>>();
|
const debounceTimers = new SvelteMap<string, ReturnType<typeof setTimeout>>();
|
||||||
const pendingTexts = new SvelteMap<string, string>();
|
const pendingTexts = new SvelteMap<string, string>();
|
||||||
|
const pendingMentions = new SvelteMap<string, PersonMention[]>();
|
||||||
const fadeTimers: ReturnType<typeof setTimeout>[] = [];
|
const fadeTimers: ReturnType<typeof setTimeout>[] = [];
|
||||||
|
|
||||||
function getSaveState(blockId: string): SaveState {
|
function getSaveState(blockId: string): SaveState {
|
||||||
@@ -21,18 +23,27 @@ export function createBlockAutoSave({ saveFn, documentId }: Options) {
|
|||||||
saveStates.set(blockId, state);
|
saveStates.set(blockId, state);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function getPendingMentions(blockId: string, fallback: PersonMention[]): PersonMention[] {
|
||||||
|
return pendingMentions.get(blockId) ?? fallback;
|
||||||
|
}
|
||||||
|
|
||||||
async function executeSave(blockId: string): Promise<void> {
|
async function executeSave(blockId: string): Promise<void> {
|
||||||
const text = pendingTexts.get(blockId);
|
const text = pendingTexts.get(blockId);
|
||||||
if (text === undefined) return;
|
if (text === undefined) return;
|
||||||
|
|
||||||
|
const mentions = pendingMentions.get(blockId) ?? [];
|
||||||
pendingTexts.delete(blockId);
|
pendingTexts.delete(blockId);
|
||||||
|
pendingMentions.delete(blockId);
|
||||||
setSaveState(blockId, 'saving');
|
setSaveState(blockId, 'saving');
|
||||||
|
|
||||||
try {
|
try {
|
||||||
await saveFn(blockId, text);
|
await saveFn(blockId, text, mentions);
|
||||||
setSaveState(blockId, 'saved');
|
setSaveState(blockId, 'saved');
|
||||||
scheduleSavedFade(blockId);
|
scheduleSavedFade(blockId);
|
||||||
} catch {
|
} catch {
|
||||||
|
// Preserve in-flight payload so the user can retry without re-typing.
|
||||||
|
pendingTexts.set(blockId, text);
|
||||||
|
pendingMentions.set(blockId, mentions);
|
||||||
setSaveState(blockId, 'error');
|
setSaveState(blockId, 'error');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -69,11 +80,22 @@ export function createBlockAutoSave({ saveFn, documentId }: Options) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function handleTextChange(blockId: string, text: string): void {
|
function handleTextChange(
|
||||||
|
blockId: string,
|
||||||
|
text: string,
|
||||||
|
mentionedPersons: PersonMention[]
|
||||||
|
): void {
|
||||||
pendingTexts.set(blockId, text);
|
pendingTexts.set(blockId, text);
|
||||||
|
pendingMentions.set(blockId, mentionedPersons);
|
||||||
scheduleDebounce(blockId);
|
scheduleDebounce(blockId);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function handleMentionsChange(blockId: string, mentionedPersons: PersonMention[]): void {
|
||||||
|
pendingMentions.set(blockId, mentionedPersons);
|
||||||
|
// Mentions changes always accompany text changes from the editor, so the
|
||||||
|
// text-debounce timer covers them too.
|
||||||
|
}
|
||||||
|
|
||||||
function handleBlur(): void {
|
function handleBlur(): void {
|
||||||
for (const [blockId] of [...debounceTimers]) {
|
for (const [blockId] of [...debounceTimers]) {
|
||||||
clearDebounce(blockId);
|
clearDebounce(blockId);
|
||||||
@@ -81,29 +103,37 @@ export function createBlockAutoSave({ saveFn, documentId }: Options) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async function handleRetry(blockId: string, currentText: string): Promise<void> {
|
async function handleRetry(
|
||||||
const pending = pendingTexts.get(blockId);
|
blockId: string,
|
||||||
const text = pending ?? currentText;
|
currentText: string,
|
||||||
|
currentMentions: PersonMention[]
|
||||||
|
): Promise<void> {
|
||||||
|
const text = pendingTexts.get(blockId) ?? currentText;
|
||||||
|
const mentions = pendingMentions.get(blockId) ?? currentMentions;
|
||||||
pendingTexts.set(blockId, text);
|
pendingTexts.set(blockId, text);
|
||||||
|
pendingMentions.set(blockId, mentions);
|
||||||
await executeSave(blockId);
|
await executeSave(blockId);
|
||||||
}
|
}
|
||||||
|
|
||||||
function clearBlock(blockId: string): void {
|
function clearBlock(blockId: string): void {
|
||||||
clearDebounce(blockId);
|
clearDebounce(blockId);
|
||||||
pendingTexts.delete(blockId);
|
pendingTexts.delete(blockId);
|
||||||
|
pendingMentions.delete(blockId);
|
||||||
saveStates.delete(blockId);
|
saveStates.delete(blockId);
|
||||||
}
|
}
|
||||||
|
|
||||||
function flushOnUnload(): void {
|
function flushOnUnload(): void {
|
||||||
for (const [blockId, text] of pendingTexts) {
|
for (const [blockId, text] of pendingTexts) {
|
||||||
|
const mentions = pendingMentions.get(blockId) ?? [];
|
||||||
clearDebounce(blockId);
|
clearDebounce(blockId);
|
||||||
void fetch(`/api/documents/${documentId}/transcription-blocks/${blockId}`, {
|
void fetch(`/api/documents/${documentId}/transcription-blocks/${blockId}`, {
|
||||||
method: 'PUT',
|
method: 'PUT',
|
||||||
headers: { 'Content-Type': 'application/json' },
|
headers: { 'Content-Type': 'application/json' },
|
||||||
body: JSON.stringify({ text }),
|
body: JSON.stringify({ text, mentionedPersons: mentions }),
|
||||||
keepalive: true
|
keepalive: true
|
||||||
});
|
});
|
||||||
pendingTexts.delete(blockId);
|
pendingTexts.delete(blockId);
|
||||||
|
pendingMentions.delete(blockId);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -120,7 +150,9 @@ export function createBlockAutoSave({ saveFn, documentId }: Options) {
|
|||||||
|
|
||||||
return {
|
return {
|
||||||
getSaveState,
|
getSaveState,
|
||||||
|
getPendingMentions,
|
||||||
handleTextChange,
|
handleTextChange,
|
||||||
|
handleMentionsChange,
|
||||||
handleBlur,
|
handleBlur,
|
||||||
handleRetry,
|
handleRetry,
|
||||||
clearBlock,
|
clearBlock,
|
||||||
|
|||||||
@@ -37,6 +37,11 @@ export type Comment = {
|
|||||||
|
|
||||||
export type DocumentPanelTab = 'metadata' | 'transcription' | 'discussion' | 'history';
|
export type DocumentPanelTab = 'metadata' | 'transcription' | 'discussion' | 'history';
|
||||||
|
|
||||||
|
export type PersonMention = {
|
||||||
|
personId: string;
|
||||||
|
displayName: string;
|
||||||
|
};
|
||||||
|
|
||||||
export type TranscriptionBlockData = {
|
export type TranscriptionBlockData = {
|
||||||
id: string;
|
id: string;
|
||||||
annotationId: string;
|
annotationId: string;
|
||||||
@@ -47,6 +52,7 @@ export type TranscriptionBlockData = {
|
|||||||
version: number;
|
version: number;
|
||||||
source: 'MANUAL' | 'OCR';
|
source: 'MANUAL' | 'OCR';
|
||||||
reviewed: boolean;
|
reviewed: boolean;
|
||||||
|
mentionedPersons: PersonMention[];
|
||||||
updatedAt?: string | null;
|
updatedAt?: string | null;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -88,11 +88,15 @@ async function loadTranscriptionBlocks() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async function saveBlock(blockId: string, text: string) {
|
async function saveBlock(
|
||||||
|
blockId: string,
|
||||||
|
text: string,
|
||||||
|
mentionedPersons: import('$lib/types').PersonMention[]
|
||||||
|
) {
|
||||||
const res = await fetch(`/api/documents/${doc.id}/transcription-blocks/${blockId}`, {
|
const res = await fetch(`/api/documents/${doc.id}/transcription-blocks/${blockId}`, {
|
||||||
method: 'PUT',
|
method: 'PUT',
|
||||||
headers: { 'Content-Type': 'application/json' },
|
headers: { 'Content-Type': 'application/json' },
|
||||||
body: JSON.stringify({ text })
|
body: JSON.stringify({ text, mentionedPersons })
|
||||||
});
|
});
|
||||||
if (!res.ok) throw new Error('Save failed');
|
if (!res.ok) throw new Error('Save failed');
|
||||||
const updated = await res.json();
|
const updated = await res.json();
|
||||||
|
|||||||
Reference in New Issue
Block a user