briefings.ts

apps/dashboard/src/briefings.ts

1. /**
2. * The shape of the model-written briefings. Type only, runtime-neutral.
3. *
4. * Split from briefings-file.ts because the Cloudflare Worker imports the
5. * renderer, the renderer needs this type, and a file containing a static
6. * `node:fs` import fails the Worker typecheck even when only its type is
7. * imported (rule 7). See also history-file.ts.
8. */
10. /**
11. * Two `generatedAt` fields, on types one letter apart, with opposite
12. * requirements:
13. *
14. * Briefings.generatedAt (here) a raw UTC ISO string, written by
15. * analysis/brief.py. Must be formatted before
16. * a reader sees it.
17. * Briefing.generatedAt (view-model.ts) already formatted in MERIDIAN_TZ.
18. * Rendering it again would be wrong.
19. *
20. * Slicing this one raw shows a Chicago reader a UTC clock time. Anything
21. * reading this field goes through localStamp/localClock; anything reading the
22. * view-model's does not.
23. */
24. export interface Briefings {
25. generatedAt: string
26. day: string | null
27. model: string
28. /** The sync these were written from. Used to detect a stale pairing. */
29. payloadGeneratedAt: string | null
30. mode: 'live' | 'fixtures' | null
31. /**
32. * Keyed by 'company', 'exec', or a person's roster name. Absent keys simply
33. * mean that briefing has not been generated today.
34. */
35. briefings: Record<string, string>
36. /**
37. * Which of the above were cut off at the model's output limit.
38. *
39. * The page needs to know: a truncated briefing is still worth reading (it is
40. * most of a briefing), but rendered unlabelled it is indistinguishable from a
41. * finished one. Same rule as everywhere else here: broken must not look like
42. * fine.
43. *
44. * Optional because an older briefings.json has no such list, and an absent list means "nothing known to be truncated", not
45. * that the question was never asked.
46. */
47. truncated?: string[]
48. }