generated from coulomb/repo-seed
tegwick
779ae0d317
Turn the MVP into a self-contained demo. Users now:
1. Land on an empty-state and create a named session.
2. Drag-drop or pick arbitrary PDFs into that session.
3. Annotate, build evidence, link to form fields — all session-scoped.
4. Export the whole session as a single .zip archive (manifest +
per-document PDFs).
5. Import a .zip back — into a new session, or merged into an
existing one (documents deduped by SHA-256 fingerprint;
annotations/evidence/links added additively).
Architecture:
- New shared types: SessionId, Session, SessionArchiveManifest +
parseSessionArchiveManifest with schema-version validation.
- SessionService (engine/services/sessions.ts) handles lifecycle
(create/rename/delete/setActive) + emits 4 new events through its
own bus; SharedContracts.md §4 lists the additions.
- SessionProvider (work/SessionContext.tsx) owns the cross-session
state: service, per-session PdfByteStore registry, per-session
version counter that drives EngineProvider remounts after imports.
- EngineProvider becomes session-aware (sessionId prop drives per-
session localStorage keys). Bumping engineRevision after
restoreFromStorage forces consumers to re-render so restored repos
show up immediately.
- PdfByteStore (source/pdf/byte-store.ts) holds Uint8Array bytes per
document and mints blob URLs; ingestPdfFromFile is the upload
entry-point that wraps the existing ingestPdf pipeline.
- ADR-0008 locks the ZIP layout (manifest.json + documents/<id>.pdf),
the manifest schema (schemaVersion 1), and the merge-on-collision
policy. JSZip is the only new dependency.
- App.tsx restructured: SessionProvider at the root, EngineProvider
keyed by ${sessionId}:${version}, hash routing #/s/<id>[/forms/demo],
SessionMenu top-bar, CreateFirstSession empty state.
- New DocumentRemoved event for per-document delete cleanup in
CollectionList; engine.documents.remove() is the new service method.
Tests:
- Unit: 16 SessionService lifecycle + persistence tests;
per-session snapshot round-trip; PdfByteStore + ingestPdfFromFile;
SessionArchive parser; exportSessionZip + importSessionZip with
create + merge + corrupt-archive paths.
- DOM: UploadDropzone, session-scoped CollectionList delete,
SessionMenu create/switch/rename, routing parser.
- E2E: tests/integration/session-export-reimport.dom.test.tsx walks
the full create → annotate → export → reimport flow and asserts
the additive merge (deduped doc + doubled evidence rows).
- Legacy E2Es updated to use a seed-session helper instead of the
removed fixture-button flow.
Known limitation (documented in ADR-0008): re-importing your own
freshly-exported ZIP creates duplicate annotations. Forward pointer
left for an importBundleId follow-up.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
59 lines
1.9 KiB
TypeScript
59 lines
1.9 KiB
TypeScript
/**
|
|
* Branded ID types and the `newId(kind)` factory.
|
|
*
|
|
* Implements the identifier portion of `wiki/SharedContracts.md` §1 and
|
|
* `wiki/ArchitectureOverview.md` §3.2. Each branded type is structurally a
|
|
* `string` but nominally distinct, so passing an `AnnotationId` where a
|
|
* `DocumentId` is required is a compile-time error.
|
|
*/
|
|
|
|
declare const __brand: unique symbol;
|
|
|
|
type Brand<K, T extends string> = K & { readonly [__brand]: T };
|
|
|
|
export type DocumentId = Brand<string, "DocumentId">;
|
|
export type RepresentationId = Brand<string, "RepresentationId">;
|
|
export type AnnotationId = Brand<string, "AnnotationId">;
|
|
export type EvidenceItemId = Brand<string, "EvidenceItemId">;
|
|
export type EvidenceSetId = Brand<string, "EvidenceSetId">;
|
|
export type EvidenceLinkId = Brand<string, "EvidenceLinkId">;
|
|
export type CitationCardId = Brand<string, "CitationCardId">;
|
|
export type CitationRecoveryAttemptId = Brand<string, "CitationRecoveryAttemptId">;
|
|
export type SessionId = Brand<string, "SessionId">;
|
|
|
|
export type IdKindMap = {
|
|
document: DocumentId;
|
|
representation: RepresentationId;
|
|
annotation: AnnotationId;
|
|
evidence: EvidenceItemId;
|
|
"evidence-set": EvidenceSetId;
|
|
"evidence-link": EvidenceLinkId;
|
|
"citation-card": CitationCardId;
|
|
"citation-recovery": CitationRecoveryAttemptId;
|
|
session: SessionId;
|
|
};
|
|
|
|
export type IdKind = keyof IdKindMap;
|
|
|
|
const PREFIXES: Record<IdKind, string> = {
|
|
document: "doc",
|
|
representation: "rep",
|
|
annotation: "ann",
|
|
evidence: "ev",
|
|
"evidence-set": "evset",
|
|
"evidence-link": "evlink",
|
|
"citation-card": "card",
|
|
"citation-recovery": "crec",
|
|
session: "sess",
|
|
};
|
|
|
|
/**
|
|
* Mint a new branded identifier of the requested kind.
|
|
*
|
|
* IDs use the shape `<prefix>_<uuid>` so they are human-recognizable when
|
|
* they show up in logs, URLs, or stored JSON.
|
|
*/
|
|
export function newId<K extends IdKind>(kind: K): IdKindMap[K] {
|
|
return `${PREFIXES[kind]}_${crypto.randomUUID()}` as IdKindMap[K];
|
|
}
|