Files
faunosteo/apps/app/src/sheets/provider.ts
T

92 lines
2.7 KiB
TypeScript

import {
AnatomicalSheetDocumentSchema,
ReportMigrationMapSchema,
type AnatomicalSheetDocument,
type ReportMigrationMap,
type SheetRef,
} from '@faunosteo/domain'
/**
* Where the application gets the anatomical sheet it works on. Step 5 ships
* one implementation, the sheet bundled at build time (virtual module, see
* vite/sheet-bundle.ts); the Supabase implementation of Step 13 sits behind
* the same interface. A loaded sheet is immutable for the session.
*/
export type SheetStatus = 'draft' | 'published'
/** Raw payload of the virtual module, validated here before use. */
export interface BundledSheetData {
status: SheetStatus
ref: {
sheet_id: string
version_id: string | null
document_sha256: string
schema_version: number
species_id: string
}
document: unknown
migrationMap: unknown
assets: Record<string, string>
/** sha256 by `svg_asset_id`, from the seed manifest. */
assetHashes: Record<string, string>
}
export interface LoadedSheet {
status: SheetStatus
ref: SheetRef
speciesId: string
/** Document schema version of the sheet (`ref.schema_version`). */
schemaVersion: number
document: AnatomicalSheetDocument
/** SVG text by `svg_asset_id`. */
assets: Readonly<Record<string, string>>
/** sha256 by `svg_asset_id`; carried into a report archive as provenance. */
assetHashes: Readonly<Record<string, string>>
migrationMap: ReportMigrationMap
}
export interface SheetProvider {
/** The reference sheet of a species, or null when none is available. */
getReferenceSheet(speciesId: string): Promise<LoadedSheet | null>
}
export function parseBundledSheet(data: BundledSheetData): LoadedSheet {
const document = AnatomicalSheetDocumentSchema.parse(data.document)
const migrationMap = ReportMigrationMapSchema.parse(data.migrationMap)
return {
status: data.status,
ref: {
sheetId: data.ref.sheet_id,
versionId: data.ref.version_id,
documentSha256: data.ref.document_sha256,
},
speciesId: data.ref.species_id,
schemaVersion: data.ref.schema_version,
document,
assets: data.assets,
assetHashes: data.assetHashes,
migrationMap,
}
}
let cached: Promise<LoadedSheet | null> | null = null
async function loadBundled(): Promise<LoadedSheet | null> {
const mod = await import('virtual:faunosteo-sheet')
return mod.bundledSheet ? parseBundledSheet(mod.bundledSheet) : null
}
export const bundledSheetProvider: SheetProvider = {
async getReferenceSheet(speciesId) {
cached ??= loadBundled()
const sheet = await cached
return sheet && sheet.speciesId === speciesId ? sheet : null
},
}
/** Test seam: forget the memoised bundle. */
export function resetBundledSheetCache(): void {
cached = null
}