notification-policy.ts

notification-policy.tspackages/shared/src/realtime/notification-policy.tsraw ← realtime3,195 B← Back to the app
1/**
2 * @factory/shared/realtime/notification-policy — the per-type notification
3 * push/toast policy + the `notification.push` frame-kind mapping
4 * (TASK-0094 R5/R7).
5 *
6 * The Prisma `NotificationType` enum is the single source of truth for the
7 * types this module mirrors (recorded: shared cannot import `@prisma/client`
8 * — the worker declares its own event catalog for the same reason,
9 * `apps/worker/src/events.ts`); keep the two in lockstep.
10 *
11 * Policy (recorded in the task file, R5):
12 *   - MENTION / ASSIGNMENT → toast + count bump;
13 *   - COMMENT / everything else → count bump only (no toast).
14 * The in-app count is ALWAYS updated on a `notification.push` frame (the
15 * row is the durable state — the push is the < 1 s fast path, R7).
16 */
17 
18/** The Prisma `NotificationType` enum values (lockstep mirror). */
19export const NOTIFICATION_TYPES = [
20  "MENTION",
21  "COMMENT",
22  "ASSIGNMENT",
23  "PAGE_SHARED",
24  "TASK_ASSIGNED",
25  "DATABASE_CHANGE",
26  "AUTOMATION",
27  "INTEGRATION",
28  "FORM_SUBMITTED", // Phase 10 (TASK-0108) — owner notified on each accepted submission
29  // Confluence expansion (T-157/T-163/T-160) — mirrors the Prisma NotificationType enum.
30  "REVIEW_REQUESTED",
31  "APPROVAL_DECISION",
32  "WATCH_UPDATE",
33  "TASK_DUE"
34] as const;
35export type NotificationTypeValue = (typeof NOTIFICATION_TYPES)[number];
36 
37/** One type's push policy. */
38export interface NotificationPolicy {
39  /** Whether a toast should fire in the web client (R5). */
40  readonly toast: boolean;
41  /** The `notification.push` frame's `kind` (the type, snake_case). */
42  readonly kind: string;
43}
44 
45/** The full policy table (R5: only MENTION / ASSIGNMENT toast). */
46export const NOTIFICATION_POLICY: Readonly<Record<NotificationTypeValue, NotificationPolicy>> = {
47  MENTION: { toast: true, kind: "mention" },
48  ASSIGNMENT: { toast: true, kind: "assignment" },
49  COMMENT: { toast: false, kind: "comment" },
50  PAGE_SHARED: { toast: false, kind: "page_shared" },
51  TASK_ASSIGNED: { toast: false, kind: "task_assigned" },
52  DATABASE_CHANGE: { toast: false, kind: "database_change" },
53  AUTOMATION: { toast: false, kind: "automation" },
54  INTEGRATION: { toast: false, kind: "integration" },
55  FORM_SUBMITTED: { toast: false, kind: "form_submitted" }, // count bump only (R5)
56  REVIEW_REQUESTED: { toast: true, kind: "review_requested" },
57  APPROVAL_DECISION: { toast: false, kind: "approval_decision" },
58  WATCH_UPDATE: { toast: false, kind: "watch_update" },
59  TASK_DUE: { toast: false, kind: "task_due" }
60};
61 
62/**
63 * Look up a type's policy. An UNKNOWN type (a future enum value the web
64 * has not shipped yet) gets the conservative policy: no toast, kind = the
65 * lower-cased type (never a crash — the count still updates, R7).
66 */
67export function notificationPolicy(type: string): NotificationPolicy {
68  const known = (NOTIFICATION_TYPES as readonly string[]).includes(type);
69  if (known) return NOTIFICATION_POLICY[type as NotificationTypeValue];
70  return { toast: false, kind: type.toLowerCase().replace(/_/g, "_") };
71}
72 
73/** True for the types that toast in the web client (R5). */
74export function notificationToasts(type: string): boolean {
75  return notificationPolicy(type).toast;
76}
77