policy.schema.ts

policy.schema.tsapps/api/src/modules/org/policy.schema.tsraw ← org3,124 B← Back to the app
1/**
2 * TASK-0133 — Org policy schema (the six enforced security settings).
3 *
4 * Stored on `Organization.policy` (Json, default `{}`). Every field is
5 * OPTIONAL with a default — the DEFAULT policy (an empty object) is the
6 * permissive baseline, so an org that never edits its policy behaves
7 * exactly as it always did (backward compatibility, AGENTS rule 6).
8 *
9 * The PLAN CAP on `maxFileSizeMB` is applied SERVER-SIDE in
10 * `org-policy.service.ts` (effective policy = org policy ∩ plan limits),
11 * NOT here — the schema stores what the admin SET, the service computes
12 * what actually applies (the editor shows both).
13 */
14import { z } from "zod";
15 
16export const OrgPolicySchema = z
17  .object({
18    /** Require 2FA (TOTP) at login for users in ANY of the user's orgs. */
19    require2FA: z.boolean().default(false),
20    /** Force SSO sign-in (password login → 403 sso_required). Mirrored to
21     *  `SsoProvider.enforce` by the admin UI (TASK-0131). */
22    ssoEnforced: z.boolean().default(false),
23    /** Block creating guest (anyone-with-link) public shares. */
24    disableGuestPublicShare: z.boolean().default(false),
25    /** Max single-file upload size (MB). Plan-capped (free 50 / paid 500). */
26    maxFileSizeMB: z.number().int().min(1).max(10240).optional(),
27    /** Session lifetime in hours (sliding window). Default 24h… actually the
28     *  platform default is the refresh TTL; a SET value clamps it. */
29    sessionLifetimeHours: z.number().int().min(1).max(720).optional(),
30    /** Allow external embed/video/link-preview fetching. Default true. */
31    allowExternalEmbeds: z.boolean().default(true)
32  })
33  .default({});
34 
35export type OrgPolicy = z.infer<typeof OrgPolicySchema>;
36 
37/** Partial update (PATCH admin/policy) — any subset of the six fields. */
38export const OrgPolicyUpdateSchema = z
39  .object({
40    require2FA: z.boolean().optional(),
41    ssoEnforced: z.boolean().optional(),
42    disableGuestPublicShare: z.boolean().optional(),
43    maxFileSizeMB: z.number().int().min(1).max(10240).nullable().optional(),
44    sessionLifetimeHours: z.number().int().min(1).max(720).nullable().optional(),
45    allowExternalEmbeds: z.boolean().optional()
46  })
47  .refine((v) => Object.keys(v).length > 0, { message: "No policy fields provided" });
48 
49export type OrgPolicyUpdate = z.infer<typeof OrgPolicyUpdateSchema>;
50 
51/** A stored policy is a loose Json object — parse it, tolerating unknown
52 *  keys (forward-compat: a newer field written by another release) and a
53 *  null/absent column (the @default("{}") only applies to new rows). */
54export function parseStoredPolicy(raw: unknown): OrgPolicy {
55  if (raw === null || raw === undefined) return OrgPolicySchema.parse({});
56  if (typeof raw !== "object") return OrgPolicySchema.parse({});
57  // Drop unknown keys so the schema's `.default()` fills the rest.
58  const known = Object.fromEntries(
59    Object.entries(raw as Record<string, unknown>).filter(([k]) =>
60      ["require2FA", "ssoEnforced", "disableGuestPublicShare", "maxFileSizeMB", "sessionLifetimeHours", "allowExternalEmbeds"].includes(k)
61    )
62  );
63  return OrgPolicySchema.parse(known);
64}
65