types.ts · Source

types.tspackages/database-engine/src/values/types.tsraw ← values2,483 B← Back to the app
1/**
2 * @factory/database-engine/values — shared codec types + record shapes.
3 *
4 * The codec contract (TASK-0064): one codec per PropertyType with
5 * `fromWire`/`toWire` (JSON round-trip), `display`, `compare`, and
6 * `canConvert`. Values are plain JSON primitives/arrays — never host objects.
7 */
8 
9import type { PropertyType } from "@factory/shared/dto";
10 
11/** All possible property values (JSON-serializable). */
12export type PropertyValue =
13  | string
14  | number
15  | boolean
16  | null
17  | undefined
18  | PropertyValue[]
19  | { start: string; end: string }
20  | { id: string; name: string; url?: string; size?: number }[];
21 
22/** Normalized date value (ISO 8601 UTC, `YYYY-MM-DD` or full timestamp). */
23export type DateValue = string;
24 
25/** A date range value (ISO 8601 UTC). */
26export interface DateRangeValue {
27  start: string;
28  end: string;
29}
30 
31/** A file attachment value (one entry in a `files` property). */
32export interface FileValue {
33  id: string;
34  name: string;
35  url?: string;
36  size?: number;
37}
38 
39/** A record as the engine sees it (values keyed by property id). */
40export interface RecordRow {
41  id: string;
42  pageId: string;
43  position: string;
44  title?: string;
45  values: Record<string, PropertyValue | undefined>;
46  icon?: string;
47  coverUrl?: string;
48  archivedAt?: number;
49  createdTime: number;
50  lastEditedTime: number;
51}
52 
53/** Minimal property description the engine needs (the db's property set). */
54export interface PropertyInfo {
55  id: string;
56  name: string;
57  type: PropertyType;
58  config: Record<string, unknown>;
59}
60 
61export interface EvalContext {
62  now: number;
63  // `| undefined` (not just `?`): `exactOptionalPropertyTypes` — the query
64  // pipeline assigns a `string | undefined` field here.
65  actorUserId?: string | undefined;
66  userTimezone: string;
67}
68 
69/** The value codec contract (Phase-6 computed codecs follow the same shape). */
70export interface ValueCodec {
71  type: PropertyType;
72  /** Validate + normalize a raw JSON wire value → PropertyValue (throws on bad). */
73  fromWire(json: unknown): PropertyValue;
74  /** Serialize a PropertyValue for storage/transport (JSON-safe). */
75  toWire(value: PropertyValue): unknown;
76  /** Human display (cells, chips, group labels). Missing config → plain value. */
77  display(value: PropertyValue, config: Record<string, unknown>, locale?: string): string;
78  /** Sort comparator (nulls handled by sort, not here). */
79  compare(a: PropertyValue, b: PropertyValue, config: Record<string, unknown>): number;
80}
81