constants.ts · Source

constants.tsapps/api/src/constants.tsraw ← src7,789 B← Back to the app
1/**
2 * Platform constants for the API. Values mirror the Prisma schema enums so
3 * the runtime can validate incoming values before they hit the database.
4 */
5 
6export const WORKSPACE_ROLES = ["OWNER", "ADMIN", "MEMBER", "GUEST"] as const;
7export type WorkspaceRole = (typeof WORKSPACE_ROLES)[number];
8 
9// T-136: space types (Confluence expansion). Legacy workspaces read as "team".
10export const WORKSPACE_TYPES = ["team", "project", "kb", "custom"] as const;
11export type WorkspaceType = (typeof WORKSPACE_TYPES)[number];
12 
13export const PERMISSION_LEVELS = ["NONE", "VIEW", "COMMENT", "EDIT", "FULL_ACCESS"] as const;
14export type PermissionLevel = (typeof PERMISSION_LEVELS)[number];
15 
16/** 32 block types (see prisma schema `BlockType`). */
17export const BLOCK_TYPES = [
18  "PARAGRAPH", "HEADING_1", "HEADING_2", "HEADING_3", "QUOTE", "CALLOUT",
19  "BULLETED_LIST", "NUMBERED_LIST", "TODO", "TOGGLE", "IMAGE", "VIDEO",
20  "AUDIO", "FILE", "BOOKMARK", "EMBED", "CODE", "EQUATION", "COLUMN",
21  "COLUMN_LIST", "DIVIDER", "SPACER", "DATABASE", "LINKED_DATABASE", "TABLE",
22  "CHART", "FORM", "SYNCED_BLOCK", "CHILD_PAGE", "CHILD_DATABASE", "TOC"
23] as const;
24export type BlockType = (typeof BLOCK_TYPES)[number];
25 
26/** 24 property types (see prisma schema `PropertyType`). */
27export const PROPERTY_TYPES = [
28  "TITLE", "TEXT", "RICH_TEXT", "NUMBER", "SELECT", "MULTI_SELECT", "STATUS",
29  "DATE", "DATE_RANGE", "PERSON", "EMAIL", "PHONE", "URL", "CHECKBOX", "FILES",
30  "CREATED_TIME", "CREATED_BY", "LAST_EDITED_TIME", "LAST_EDITED_BY", "RELATION",
31  "ROLLUP", "FORMULA", "BUTTON", "UNIQUE_ID"
32] as const;
33export type PropertyType = (typeof PROPERTY_TYPES)[number];
34 
35export const VIEW_TYPES = [
36  "TABLE", "LIST", "BOARD", "GALLERY", "CALENDAR", "TIMELINE", "CHART", "DASHBOARD", "FORM"
37] as const;
38export type ViewType = (typeof VIEW_TYPES)[number];
39 
40export const RELATION_CARDINALITIES = ["ONE_TO_ONE", "ONE_TO_MANY", "MANY_TO_MANY"] as const;
41export type RelationCardinality = (typeof RELATION_CARDINALITIES)[number];
42 
43export const ROLLUP_AGGREGATES = ["COUNT", "SUM", "AVERAGE", "MIN", "MAX", "PERCENT", "UNIQUE"] as const;
44export type RollupAggregate = (typeof ROLLUP_AGGREGATES)[number];
45 
46export const AUTOMATION_TRIGGER_TYPES = [
47  "RECORD_CREATED", "RECORD_UPDATED", "PROPERTY_CHANGED", "PAGE_CREATED",
48  "FORM_SUBMITTED", "SCHEDULE", "WEBHOOK", "MANUAL"
49] as const;
50export type AutomationTriggerType = (typeof AUTOMATION_TRIGGER_TYPES)[number];
51 
52export const AUTOMATION_ACTION_TYPES = [
53  "UPDATE_RECORD", "CREATE_PAGE", "SEND_EMAIL", "SEND_WEBHOOK",
54  "CREATE_NOTIFICATION", "ASSIGN_USER", "CHANGE_STATUS", "CALL_INTEGRATION", "RUN_AI_ACTION"
55] as const;
56export type AutomationActionType = (typeof AUTOMATION_ACTION_TYPES)[number];
57 
58export const AUTOMATION_STATUSES = ["DRAFT", "ACTIVE", "PAUSED", "ARCHIVED"] as const;
59export type AutomationStatus = (typeof AUTOMATION_STATUSES)[number];
60 
61export const FORM_QUESTION_TYPES = [
62  "SHORT_TEXT", "LONG_TEXT", "NUMBER", "EMAIL", "DATE", "CHECKBOX",
63  "SINGLE_SELECT", "MULTI_SELECT", "RATING", "FILE"
64] as const;
65export type FormQuestionType = (typeof FORM_QUESTION_TYPES)[number];
66 
67export const FORM_STATUSES = ["DRAFT", "PUBLISHED", "CLOSED"] as const;
68export type FormStatus = (typeof FORM_STATUSES)[number];
69 
70export const API_KEY_SCOPES = ["READ", "WRITE", "ADMIN"] as const;
71export type ApiKeyScope = (typeof API_KEY_SCOPES)[number];
72 
73export const SHARE_SCOPES = ["PRIVATE", "WORKSPACE", "TEAM", "USERS", "PUBLIC"] as const;
74export type ShareScope = (typeof SHARE_SCOPES)[number];
75 
76export const FILE_STATUSES = ["UPLOADING", "SCANNING", "READY", "VIRUS_DETECTED", "FAILED"] as const;
77export type FileStatus = (typeof FILE_STATUSES)[number];
78 
79/**
80 * Filter operators supported by the record query engine. The JS pass
81 * (`leafMatches` in query.service.ts) is the exact evaluator and
82 * understands all of these; `lib/filter-builder.ts` uses the same set to
83 * validate (op, type) triples and emits a SQL pre-filter only for the small
84 * subset Prisma can express (CHECKBOX eq/neq on the raw-scalar column).
85 *
86 * The docs §5.3 names (eq/neq/contains/…) and the web filter-builder's
87 * names (is/equals/is_empty/starts_with/…) are reconciled via OP_ALIASES
88 * (query.service.ts) before reaching here.
89 */
90export const FILTER_OPS = [
91  "eq", "neq", "contains", "ncontains", "startsWith", "endsWith",
92  "isEmpty", "isNotEmpty",
93  "gt", "gte", "lt", "lte", "before", "after", "between",
94  "isThisWeek", "isThisMonth", "withinNextDays", "isPast", "isFuture",
95  "contains_any", "contains_all", "isCurrentUser"
96] as const;
97export type FilterOp = (typeof FILTER_OPS)[number];
98 
99export const APP_VERSION = "0.1.0";
100export const API_PREFIX = "api/v1";
101export const REFRESH_COOKIE = "factory_refresh";
102export const EVENTS_STREAM = "factory:events";
103export const EVENTS_STREAM_MAXLEN = 10000;
104export const MAX_FILE_SIZE_DEFAULT = 50 * 1024 * 1024; // 50 MB
105export const MAX_BLOCK_BATCH = 200;
106export const MAX_BULK_RECORDS = 500;
107export const MAX_EXPORT_ROWS = 50_000;
108export const MAX_BLOCK_TREE = 5000;
109// T-165 CSV import caps (tracked): the JSON body is buffered by a
110// route-scoped parser at MAX_CSV_IMPORT_BODY_BYTES (the global 256 KB limit
111// would 413 a valid 10k-row file), and the parsed table is capped at
112// MAX_CSV_IMPORT_ROWS.
113export const MAX_CSV_IMPORT_ROWS = 10_000;
114export const MAX_CSV_IMPORT_BODY_BYTES = 2 * 1024 * 1024; // 2 MB
115// T-167 whiteboard canvas cap: a single canvas save is one JSON document. The
116// global 256 KB JSON ceiling would 413 a legitimate large canvas, so the save
117// route buffers up to this cap via a route-scoped parser (see
118// common/whiteboard-body.ts). Sized for the 2,000-object render/perf gate.
119export const MAX_WHITEBOARD_BODY_BYTES = 2 * 1024 * 1024; // 2 MB
120 
121/** Default database seed for new databases. */
122export const DEFAULT_DB_PROPERTIES = [
123  { name: "Title", type: "TITLE", isTitle: true },
124  {
125    name: "Status",
126    type: "SELECT",
127    config: {
128      options: [
129        { name: "To Do", color: "gray" },
130        { name: "In Progress", color: "blue" },
131        { name: "Done", color: "green" }
132      ]
133    }
134  }
135] as const;
136 
137/** Domain events published on the Redis stream `factory:events`. */
138export const EVENTS = {
139  PAGE_CREATED: "page.created",
140  PAGE_UPDATED: "page.updated",
141  PAGE_DELETED: "page.deleted",
142  PAGE_SHARED: "page.shared",
143  DATABASE_CREATED: "database.created",
144  DATABASE_UPDATED: "database.updated",
145  RECORD_CREATED: "record.created",
146  RECORD_UPDATED: "record.updated",
147  COMMENT_CREATED: "comment.created",
148  // TASK-0094 — the comment fan-out events (stream-internal, NOT in the
149  // public webhook catalog — the realtime app maps each to a `comment.event`
150  // frame kind; the mapping lives in @factory/shared/realtime/comment-events.
151  // `comment.created` doubles as the reply event (its payload carries
152  // `replyId`). All five are additive — the catalog row `comment.created`
153  // (Phase 1) and `comment.resolved` stay for Phase-13 webhooks.
154  COMMENT_RESOLVED: "comment.resolved",
155  COMMENT_REOPENED: "comment.reopened",
156  COMMENT_REACTION: "comment.reaction",
157  COMMENT_DELETED: "comment.deleted",
158  // TASK-0094 R7 — a Notification row was created; the worker's email
159  // decision (R6) + the realtime `notification.push` fan-out both consume it.
160  NOTIFICATION_CREATED: "notification.created",
161  FORM_SUBMITTED: "form.submitted",
162  AUTOMATION_EXECUTED: "automation.executed",
163  AUTOMATION_MANUAL: "automation.manual",
164  FILE_UPLOADED: "file.uploaded",
165  API_KEY_CREATED: "api_key.created",
166  USER_LOGIN: "user.login",
167  USER_LOGOUT: "user.logout",
168  USER_REGISTER: "user.register",
169  PERMISSION_CHANGED: "permission.changed",
170  WORKSPACE_CREATED: "workspace.created"
171} as const;
172export type EventName = (typeof EVENTS)[keyof typeof EVENTS];
173