@libredb/studio 0.9.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (572) hide show
  1. package/.claude/settings.local.json +127 -0
  2. package/.cursorrules +426 -0
  3. package/.devin/wiki.json +143 -0
  4. package/.dockerignore +80 -0
  5. package/.env.example +159 -0
  6. package/.github/ISSUE_TEMPLATE/bug_report.md +49 -0
  7. package/.github/ISSUE_TEMPLATE/feature_request.md +29 -0
  8. package/.github/PULL_REQUEST_TEMPLATE.md +57 -0
  9. package/.github/workflows/ci.yml +185 -0
  10. package/.github/workflows/codeql.yml +57 -0
  11. package/.github/workflows/docker-build-push.yml +118 -0
  12. package/.github/workflows/helm-release.yml +113 -0
  13. package/CLAUDE.md +265 -0
  14. package/CODE_OF_CONDUCT.md +124 -0
  15. package/CONTRIBUTING.md +154 -0
  16. package/Dockerfile +73 -0
  17. package/LICENSE +21 -0
  18. package/README.md +614 -0
  19. package/SECURITY.md +107 -0
  20. package/artifacthub-repo.yml +4 -0
  21. package/bun.lock +1714 -0
  22. package/bunfig.toml +3 -0
  23. package/charts/libredb-studio/.helmignore +11 -0
  24. package/charts/libredb-studio/Chart.lock +6 -0
  25. package/charts/libredb-studio/Chart.yaml +50 -0
  26. package/charts/libredb-studio/README.md +206 -0
  27. package/charts/libredb-studio/templates/NOTES.txt +59 -0
  28. package/charts/libredb-studio/templates/_helpers.tpl +135 -0
  29. package/charts/libredb-studio/templates/configmap.yaml +37 -0
  30. package/charts/libredb-studio/templates/deployment.yaml +184 -0
  31. package/charts/libredb-studio/templates/hpa.yaml +32 -0
  32. package/charts/libredb-studio/templates/ingress.yaml +41 -0
  33. package/charts/libredb-studio/templates/networkpolicy.yaml +50 -0
  34. package/charts/libredb-studio/templates/pdb.yaml +18 -0
  35. package/charts/libredb-studio/templates/pvc.yaml +23 -0
  36. package/charts/libredb-studio/templates/secret.yaml +30 -0
  37. package/charts/libredb-studio/templates/seed-configmap.yaml +11 -0
  38. package/charts/libredb-studio/templates/service.yaml +22 -0
  39. package/charts/libredb-studio/templates/serviceaccount.yaml +13 -0
  40. package/charts/libredb-studio/values.schema.json +246 -0
  41. package/charts/libredb-studio/values.yaml +286 -0
  42. package/components.json +22 -0
  43. package/conductor/code_styleguides/typescript.md +43 -0
  44. package/conductor/product-guidelines.md +43 -0
  45. package/conductor/product.md +3 -0
  46. package/conductor/setup_state.json +1 -0
  47. package/conductor/tech-stack.md +39 -0
  48. package/conductor/tracks/enhance_postgres_monitoring_20251227/metadata.json +8 -0
  49. package/conductor/tracks/enhance_postgres_monitoring_20251227/plan.md +44 -0
  50. package/conductor/tracks/enhance_postgres_monitoring_20251227/spec.md +31 -0
  51. package/conductor/tracks.md +8 -0
  52. package/conductor/workflow.md +333 -0
  53. package/database-compose.yml +55 -0
  54. package/docker/postgres-init/01-extensions.sql +10 -0
  55. package/docker/postgres-init/02-sample-data.sql +585 -0
  56. package/docker/postgres.yml +68 -0
  57. package/docker-compose.yml +38 -0
  58. package/docs/AI_PLAN.md +74 -0
  59. package/docs/API_DOCS.md +875 -0
  60. package/docs/ARCHITECTURE.md +218 -0
  61. package/docs/DATABASE_PROVIDERS.md +358 -0
  62. package/docs/FEATURES.md +116 -0
  63. package/docs/HELM_CHART.md +252 -0
  64. package/docs/LOGIN_PAGE.md +178 -0
  65. package/docs/MONACO_EDITOR_PERFORMANCE.md +315 -0
  66. package/docs/OIDC_ARCH.md +681 -0
  67. package/docs/OIDC_SETUP.md +322 -0
  68. package/docs/POSTGRES_METRICS.md +516 -0
  69. package/docs/QUERY_OPTIMIZATION.md +370 -0
  70. package/docs/SEED_CONNECTIONS.md +468 -0
  71. package/docs/SQL_ALIAS_COMPLETION.md +190 -0
  72. package/docs/STORAGE_ARCHITECTURE.md +565 -0
  73. package/docs/STORAGE_QUICK_SETUP.md +419 -0
  74. package/docs/TECHNICAL_PLAN.md +36 -0
  75. package/docs/THEMING.md +345 -0
  76. package/docs/adding-a-new-database-provider.md +642 -0
  77. package/docs/backlogs/000-PLATFORM_DATA_SYNC_DATABASE.md +360 -0
  78. package/docs/backlogs/001-INLINE_DATA_EDITING.md +118 -0
  79. package/docs/backlogs/002-DATA_IMPORT.md +215 -0
  80. package/docs/backlogs/003-QUERY_TIME_MACHINE.md +183 -0
  81. package/docs/backlogs/004-AI_DATA_STORYTELLER.md +292 -0
  82. package/docs/backlogs/005-QUERY_PLAYGROUND.md +352 -0
  83. package/docs/backlogs/006-DATA_MASKING.md +418 -0
  84. package/docs/enterprise-features.md +718 -0
  85. package/docs/kubernetes-helm-chart-artifacthub-plan.md +803 -0
  86. package/docs/medium-koyeb-article-en.md +215 -0
  87. package/docs/plans/test-plans.md +445 -0
  88. package/docs/releases/RELEASE.V0.3.0.md +22 -0
  89. package/docs/releases/RELEASE.V0.4.0.md +154 -0
  90. package/docs/releases/RELEASE.V0.5.0.md +252 -0
  91. package/docs/releases/RELEASE_v0.5.6.md +145 -0
  92. package/docs/releases/RELEASE_v0.6.1.md +303 -0
  93. package/docs/releases/RELEASE_v0.6.7.md +292 -0
  94. package/docs/releases/RELEASE_v0.7.0.md +332 -0
  95. package/docs/releases/RELEASE_v0.8.0.md +521 -0
  96. package/docs/sampledb/titanic.sql +1379 -0
  97. package/docs/superpowers/plans/2026-03-25-seed-connections.md +1362 -0
  98. package/docs/superpowers/specs/2026-03-25-seed-connections-design.md +590 -0
  99. package/e2e/admin-dashboard.spec.ts +64 -0
  100. package/e2e/connection-management.spec.ts +58 -0
  101. package/e2e/export.spec.ts +34 -0
  102. package/e2e/login.spec.ts +85 -0
  103. package/e2e/query-execution.spec.ts +35 -0
  104. package/e2e/tab-management.spec.ts +64 -0
  105. package/eslint.config.mjs +28 -0
  106. package/fly.toml +43 -0
  107. package/next.config.ts +32 -0
  108. package/package.json +130 -0
  109. package/playwright.config.ts +34 -0
  110. package/postcss.config.mjs +7 -0
  111. package/public/favicon-32x32.png +0 -0
  112. package/public/favicon.ico +0 -0
  113. package/public/file.svg +1 -0
  114. package/public/globe.svg +1 -0
  115. package/public/logo.svg +32 -0
  116. package/public/next.svg +1 -0
  117. package/public/screenshots/code-generator.png +0 -0
  118. package/public/screenshots/connection-modal.png +0 -0
  119. package/public/screenshots/data-profiler.png +0 -0
  120. package/public/screenshots/erd-diagram.png +0 -0
  121. package/public/screenshots/hero-editor.png +0 -0
  122. package/public/screenshots/nl2sql.png +0 -0
  123. package/public/vercel.svg +1 -0
  124. package/public/window.svg +1 -0
  125. package/render.yaml +58 -0
  126. package/scripts/merge-lcov.mjs +239 -0
  127. package/sonar-project.properties +16 -0
  128. package/src/app/admin/error.tsx +46 -0
  129. package/src/app/admin/page.tsx +10 -0
  130. package/src/app/api/admin/audit/route.ts +52 -0
  131. package/src/app/api/admin/fleet-health/route.ts +81 -0
  132. package/src/app/api/ai/autopilot/route.ts +105 -0
  133. package/src/app/api/ai/chat/route.ts +132 -0
  134. package/src/app/api/ai/describe-schema/route.ts +52 -0
  135. package/src/app/api/ai/explain/route.ts +86 -0
  136. package/src/app/api/ai/impact/route.ts +97 -0
  137. package/src/app/api/ai/index-advisor/route.ts +98 -0
  138. package/src/app/api/ai/nl2sql/route.ts +87 -0
  139. package/src/app/api/ai/query-safety/route.ts +87 -0
  140. package/src/app/api/auth/login/route.ts +62 -0
  141. package/src/app/api/auth/logout/route.ts +25 -0
  142. package/src/app/api/auth/me/route.ts +10 -0
  143. package/src/app/api/auth/oidc/callback/route.ts +82 -0
  144. package/src/app/api/auth/oidc/login/route.ts +43 -0
  145. package/src/app/api/connections/managed/route.ts +35 -0
  146. package/src/app/api/db/cancel/route.ts +42 -0
  147. package/src/app/api/db/disconnect/route.ts +28 -0
  148. package/src/app/api/db/health/route.ts +49 -0
  149. package/src/app/api/db/maintenance/route.ts +72 -0
  150. package/src/app/api/db/monitoring/route.ts +62 -0
  151. package/src/app/api/db/multi-query/route.ts +116 -0
  152. package/src/app/api/db/pool-stats/route.ts +37 -0
  153. package/src/app/api/db/profile/route.ts +144 -0
  154. package/src/app/api/db/provider-meta/route.ts +49 -0
  155. package/src/app/api/db/query/route.ts +50 -0
  156. package/src/app/api/db/schema/route.ts +47 -0
  157. package/src/app/api/db/schema-snapshot/route.ts +42 -0
  158. package/src/app/api/db/test-connection/route.ts +55 -0
  159. package/src/app/api/db/transaction/route.ts +111 -0
  160. package/src/app/api/storage/[collection]/route.ts +67 -0
  161. package/src/app/api/storage/config/route.ts +17 -0
  162. package/src/app/api/storage/migrate/route.ts +45 -0
  163. package/src/app/api/storage/route.ts +32 -0
  164. package/src/app/error.tsx +49 -0
  165. package/src/app/global-error.tsx +55 -0
  166. package/src/app/globals.css +146 -0
  167. package/src/app/icon.svg +42 -0
  168. package/src/app/layout.tsx +34 -0
  169. package/src/app/login/login-form.tsx +301 -0
  170. package/src/app/login/page.tsx +11 -0
  171. package/src/app/monitoring/page.tsx +8 -0
  172. package/src/app/not-found.tsx +29 -0
  173. package/src/app/page.tsx +5 -0
  174. package/src/components/AIAutopilotPanel.tsx +238 -0
  175. package/src/components/CodeGenerator.tsx +271 -0
  176. package/src/components/CommandPalette.tsx +227 -0
  177. package/src/components/ConnectionModal.tsx +759 -0
  178. package/src/components/CreateTableModal.tsx +281 -0
  179. package/src/components/DataCharts.tsx +962 -0
  180. package/src/components/DataImportModal.tsx +582 -0
  181. package/src/components/DataProfiler.tsx +335 -0
  182. package/src/components/DatabaseDocs.tsx +251 -0
  183. package/src/components/MaskingSettings.tsx +414 -0
  184. package/src/components/MobileNav.tsx +50 -0
  185. package/src/components/NL2SQLPanel.tsx +281 -0
  186. package/src/components/PivotTable.tsx +257 -0
  187. package/src/components/QueryEditor.tsx +760 -0
  188. package/src/components/QueryHistory.tsx +344 -0
  189. package/src/components/QuerySafetyDialog.tsx +290 -0
  190. package/src/components/ResultsGrid.tsx +644 -0
  191. package/src/components/SaveQueryModal.tsx +104 -0
  192. package/src/components/SavedQueries.tsx +128 -0
  193. package/src/components/SchemaDiagram.tsx +473 -0
  194. package/src/components/SchemaDiff.tsx +473 -0
  195. package/src/components/SnapshotTimeline.tsx +116 -0
  196. package/src/components/Studio.tsx +639 -0
  197. package/src/components/TestDataGenerator.tsx +261 -0
  198. package/src/components/VisualExplain.tsx +820 -0
  199. package/src/components/admin/AdminDashboard.tsx +163 -0
  200. package/src/components/admin/tabs/AuditTab.tsx +531 -0
  201. package/src/components/admin/tabs/MonitoringEmbed.tsx +11 -0
  202. package/src/components/admin/tabs/OperationsTab.tsx +646 -0
  203. package/src/components/admin/tabs/OverviewTab.tsx +1328 -0
  204. package/src/components/admin/tabs/SecurityTab.tsx +284 -0
  205. package/src/components/community-section.tsx +92 -0
  206. package/src/components/icons/db-icons.tsx +84 -0
  207. package/src/components/libredb-logo.tsx +61 -0
  208. package/src/components/monitoring/MonitoringDashboard.tsx +345 -0
  209. package/src/components/monitoring/tabs/MetricChart.tsx +82 -0
  210. package/src/components/monitoring/tabs/OverviewTab.tsx +263 -0
  211. package/src/components/monitoring/tabs/PerformanceTab.tsx +254 -0
  212. package/src/components/monitoring/tabs/PoolTab.tsx +174 -0
  213. package/src/components/monitoring/tabs/QueriesTab.tsx +287 -0
  214. package/src/components/monitoring/tabs/SessionsTab.tsx +316 -0
  215. package/src/components/monitoring/tabs/StorageTab.tsx +335 -0
  216. package/src/components/monitoring/tabs/TablesTab.tsx +300 -0
  217. package/src/components/results-grid/ResultCard.tsx +111 -0
  218. package/src/components/results-grid/RowDetailSheet.tsx +178 -0
  219. package/src/components/results-grid/StatsBar.tsx +201 -0
  220. package/src/components/results-grid/index.ts +1 -0
  221. package/src/components/results-grid/utils.ts +23 -0
  222. package/src/components/schema-explorer/ColumnList.tsx +53 -0
  223. package/src/components/schema-explorer/SchemaExplorer.tsx +182 -0
  224. package/src/components/schema-explorer/TableItem.tsx +210 -0
  225. package/src/components/schema-explorer/index.ts +1 -0
  226. package/src/components/sidebar/ConnectionItem.tsx +105 -0
  227. package/src/components/sidebar/ConnectionsList.tsx +62 -0
  228. package/src/components/sidebar/Sidebar.tsx +130 -0
  229. package/src/components/sidebar/index.ts +2 -0
  230. package/src/components/studio/BottomPanel.tsx +286 -0
  231. package/src/components/studio/QueryToolbar.tsx +180 -0
  232. package/src/components/studio/StudioDesktopHeader.tsx +114 -0
  233. package/src/components/studio/StudioMobileHeader.tsx +340 -0
  234. package/src/components/studio/StudioTabBar.tsx +82 -0
  235. package/src/components/studio/index.ts +5 -0
  236. package/src/components/ui/accordion.tsx +66 -0
  237. package/src/components/ui/alert-dialog.tsx +157 -0
  238. package/src/components/ui/alert.tsx +66 -0
  239. package/src/components/ui/aspect-ratio.tsx +11 -0
  240. package/src/components/ui/avatar.tsx +53 -0
  241. package/src/components/ui/badge.tsx +46 -0
  242. package/src/components/ui/breadcrumb.tsx +109 -0
  243. package/src/components/ui/button-group.tsx +83 -0
  244. package/src/components/ui/button.tsx +60 -0
  245. package/src/components/ui/calendar.tsx +216 -0
  246. package/src/components/ui/card.tsx +92 -0
  247. package/src/components/ui/carousel.tsx +241 -0
  248. package/src/components/ui/chart.tsx +357 -0
  249. package/src/components/ui/checkbox.tsx +32 -0
  250. package/src/components/ui/collapsible.tsx +33 -0
  251. package/src/components/ui/command.tsx +184 -0
  252. package/src/components/ui/context-menu.tsx +252 -0
  253. package/src/components/ui/dialog.tsx +143 -0
  254. package/src/components/ui/drawer.tsx +135 -0
  255. package/src/components/ui/dropdown-menu.tsx +257 -0
  256. package/src/components/ui/empty.tsx +104 -0
  257. package/src/components/ui/field.tsx +248 -0
  258. package/src/components/ui/form.tsx +167 -0
  259. package/src/components/ui/hover-card.tsx +44 -0
  260. package/src/components/ui/input-group.tsx +170 -0
  261. package/src/components/ui/input-otp.tsx +77 -0
  262. package/src/components/ui/input.tsx +21 -0
  263. package/src/components/ui/item.tsx +193 -0
  264. package/src/components/ui/kbd.tsx +28 -0
  265. package/src/components/ui/label.tsx +24 -0
  266. package/src/components/ui/menubar.tsx +276 -0
  267. package/src/components/ui/navigation-menu.tsx +168 -0
  268. package/src/components/ui/pagination.tsx +127 -0
  269. package/src/components/ui/popover.tsx +48 -0
  270. package/src/components/ui/progress.tsx +31 -0
  271. package/src/components/ui/radio-group.tsx +45 -0
  272. package/src/components/ui/resizable.tsx +56 -0
  273. package/src/components/ui/scroll-area.tsx +58 -0
  274. package/src/components/ui/select.tsx +187 -0
  275. package/src/components/ui/separator.tsx +28 -0
  276. package/src/components/ui/sheet.tsx +139 -0
  277. package/src/components/ui/sidebar.tsx +726 -0
  278. package/src/components/ui/skeleton.tsx +13 -0
  279. package/src/components/ui/slider.tsx +63 -0
  280. package/src/components/ui/sonner.tsx +40 -0
  281. package/src/components/ui/spinner.tsx +16 -0
  282. package/src/components/ui/switch.tsx +31 -0
  283. package/src/components/ui/table.tsx +116 -0
  284. package/src/components/ui/tabs.tsx +66 -0
  285. package/src/components/ui/textarea.tsx +18 -0
  286. package/src/components/ui/toggle-group.tsx +83 -0
  287. package/src/components/ui/toggle.tsx +47 -0
  288. package/src/components/ui/tooltip.tsx +61 -0
  289. package/src/exports/components.ts +15 -0
  290. package/src/exports/index.ts +4 -0
  291. package/src/exports/providers.ts +4 -0
  292. package/src/exports/types.ts +26 -0
  293. package/src/hooks/use-ai-chat.ts +182 -0
  294. package/src/hooks/use-all-connections.ts +66 -0
  295. package/src/hooks/use-api-call.ts +71 -0
  296. package/src/hooks/use-auth.ts +51 -0
  297. package/src/hooks/use-connection-form.ts +349 -0
  298. package/src/hooks/use-connection-manager.ts +169 -0
  299. package/src/hooks/use-connection-payload.ts +15 -0
  300. package/src/hooks/use-inline-editing.ts +109 -0
  301. package/src/hooks/use-mobile.ts +20 -0
  302. package/src/hooks/use-monitoring-data.ts +270 -0
  303. package/src/hooks/use-provider-metadata.ts +62 -0
  304. package/src/hooks/use-query-execution.ts +478 -0
  305. package/src/hooks/use-storage-sync.ts +259 -0
  306. package/src/hooks/use-tab-manager.ts +231 -0
  307. package/src/hooks/use-toast.ts +20 -0
  308. package/src/hooks/use-transaction-control.ts +64 -0
  309. package/src/lib/api/error-codes.ts +30 -0
  310. package/src/lib/api/errors.ts +236 -0
  311. package/src/lib/api/with-error-handler.ts +41 -0
  312. package/src/lib/audit.ts +105 -0
  313. package/src/lib/auth.ts +87 -0
  314. package/src/lib/connection-string-parser.ts +172 -0
  315. package/src/lib/data-masking.ts +385 -0
  316. package/src/lib/db/base-provider.ts +325 -0
  317. package/src/lib/db/errors.ts +317 -0
  318. package/src/lib/db/factory.ts +324 -0
  319. package/src/lib/db/index.ts +123 -0
  320. package/src/lib/db/providers/document/index.ts +6 -0
  321. package/src/lib/db/providers/document/mongodb.ts +992 -0
  322. package/src/lib/db/providers/keyvalue/redis.ts +554 -0
  323. package/src/lib/db/providers/sql/index.ts +11 -0
  324. package/src/lib/db/providers/sql/mssql.ts +1065 -0
  325. package/src/lib/db/providers/sql/mysql.ts +978 -0
  326. package/src/lib/db/providers/sql/oracle.ts +1044 -0
  327. package/src/lib/db/providers/sql/postgres.ts +1179 -0
  328. package/src/lib/db/providers/sql/sql-base.ts +174 -0
  329. package/src/lib/db/providers/sql/sqlite.ts +721 -0
  330. package/src/lib/db/types.ts +437 -0
  331. package/src/lib/db/utils/pool-manager.ts +287 -0
  332. package/src/lib/db/utils/query-limiter.ts +239 -0
  333. package/src/lib/db-ui-config.ts +86 -0
  334. package/src/lib/editor/mongodb-completions.ts +172 -0
  335. package/src/lib/editor/sql-completions.ts +280 -0
  336. package/src/lib/llm/base-provider.ts +117 -0
  337. package/src/lib/llm/factory.ts +102 -0
  338. package/src/lib/llm/index.ts +90 -0
  339. package/src/lib/llm/providers/custom.ts +181 -0
  340. package/src/lib/llm/providers/gemini.ts +126 -0
  341. package/src/lib/llm/providers/ollama.ts +154 -0
  342. package/src/lib/llm/providers/openai.ts +146 -0
  343. package/src/lib/llm/types.ts +173 -0
  344. package/src/lib/llm/utils/config.ts +187 -0
  345. package/src/lib/llm/utils/retry.ts +119 -0
  346. package/src/lib/llm/utils/streaming.ts +202 -0
  347. package/src/lib/logger.ts +127 -0
  348. package/src/lib/monitoring-thresholds.ts +44 -0
  349. package/src/lib/oidc.ts +262 -0
  350. package/src/lib/query-generators.ts +61 -0
  351. package/src/lib/schema-diff/diff-engine.ts +273 -0
  352. package/src/lib/schema-diff/migration-generator.ts +208 -0
  353. package/src/lib/schema-diff/types.ts +55 -0
  354. package/src/lib/seed/config-loader.ts +79 -0
  355. package/src/lib/seed/connection-filter.ts +49 -0
  356. package/src/lib/seed/credential-resolver.ts +62 -0
  357. package/src/lib/seed/index.ts +40 -0
  358. package/src/lib/seed/resolve-connection.ts +57 -0
  359. package/src/lib/seed/types.ts +69 -0
  360. package/src/lib/sql/alias-extractor.ts +267 -0
  361. package/src/lib/sql/index.ts +8 -0
  362. package/src/lib/sql/statement-splitter.ts +167 -0
  363. package/src/lib/sql/types.ts +40 -0
  364. package/src/lib/ssh/tunnel.ts +142 -0
  365. package/src/lib/storage/factory.ts +84 -0
  366. package/src/lib/storage/index.ts +14 -0
  367. package/src/lib/storage/local-storage.ts +99 -0
  368. package/src/lib/storage/providers/postgres.ts +225 -0
  369. package/src/lib/storage/providers/sqlite.ts +153 -0
  370. package/src/lib/storage/storage-facade.ts +272 -0
  371. package/src/lib/storage/types.ts +75 -0
  372. package/src/lib/time-series-buffer.ts +58 -0
  373. package/src/lib/types.ts +173 -0
  374. package/src/lib/utils.ts +6 -0
  375. package/src/proxy.ts +104 -0
  376. package/src/types/db-drivers.d.ts +23 -0
  377. package/src/types/html2canvas.d.ts +9 -0
  378. package/tests/api/admin/audit.test.ts +178 -0
  379. package/tests/api/admin/fleet-health.test.ts +183 -0
  380. package/tests/api/ai/autopilot.test.ts +174 -0
  381. package/tests/api/ai/chat.test.ts +250 -0
  382. package/tests/api/ai/describe-schema.test.ts +266 -0
  383. package/tests/api/ai/explain.test.ts +199 -0
  384. package/tests/api/ai/impact.test.ts +168 -0
  385. package/tests/api/ai/index-advisor.test.ts +171 -0
  386. package/tests/api/ai/nl2sql.test.ts +202 -0
  387. package/tests/api/ai/query-safety.test.ts +196 -0
  388. package/tests/api/auth/login.test.ts +170 -0
  389. package/tests/api/auth/logout.test.ts +140 -0
  390. package/tests/api/auth/me.test.ts +73 -0
  391. package/tests/api/auth/oidc-callback.test.ts +215 -0
  392. package/tests/api/auth/oidc-login.test.ts +127 -0
  393. package/tests/api/db/cancel.test.ts +198 -0
  394. package/tests/api/db/disconnect.test.ts +124 -0
  395. package/tests/api/db/health.test.ts +222 -0
  396. package/tests/api/db/maintenance.test.ts +263 -0
  397. package/tests/api/db/monitoring.test.ts +221 -0
  398. package/tests/api/db/multi-query.test.ts +316 -0
  399. package/tests/api/db/pool-stats.test.ts +135 -0
  400. package/tests/api/db/profile.test.ts +330 -0
  401. package/tests/api/db/provider-meta.test.ts +193 -0
  402. package/tests/api/db/query.test.ts +314 -0
  403. package/tests/api/db/schema-snapshot.test.ts +170 -0
  404. package/tests/api/db/schema.test.ts +191 -0
  405. package/tests/api/db/test-connection.test.ts +185 -0
  406. package/tests/api/db/transaction.test.ts +314 -0
  407. package/tests/api/proxy.test.ts +191 -0
  408. package/tests/api/seed/managed-route.test.ts +113 -0
  409. package/tests/api/storage/config.test.ts +42 -0
  410. package/tests/api/storage/storage-routes.test.ts +309 -0
  411. package/tests/components/AIAutopilotPanel.test.tsx +756 -0
  412. package/tests/components/AdminPage.test.tsx +33 -0
  413. package/tests/components/CodeGenerator.test.tsx +182 -0
  414. package/tests/components/CommandPalette.test.tsx +428 -0
  415. package/tests/components/CommunitySection.test.tsx +91 -0
  416. package/tests/components/ConnectionModal.mobile.test.tsx +284 -0
  417. package/tests/components/ConnectionModal.test.tsx +570 -0
  418. package/tests/components/CreateTableModal.test.tsx +383 -0
  419. package/tests/components/DataCharts.test.tsx +739 -0
  420. package/tests/components/DataImportModal.test.tsx +751 -0
  421. package/tests/components/DataProfiler.test.tsx +589 -0
  422. package/tests/components/DatabaseDocs.test.tsx +353 -0
  423. package/tests/components/LoginPage.test.tsx +163 -0
  424. package/tests/components/LoginPageOIDC.test.tsx +92 -0
  425. package/tests/components/MaskingSettings.test.tsx +498 -0
  426. package/tests/components/MobileNav.test.tsx +30 -0
  427. package/tests/components/MonitoringPage.test.tsx +32 -0
  428. package/tests/components/NL2SQLPanel.test.tsx +621 -0
  429. package/tests/components/Page.test.tsx +33 -0
  430. package/tests/components/PivotTable.test.tsx +350 -0
  431. package/tests/components/QueryEditor.test.tsx +1730 -0
  432. package/tests/components/QueryHistory.test.tsx +572 -0
  433. package/tests/components/QuerySafetyDialog.test.tsx +586 -0
  434. package/tests/components/ResultsGrid.test.tsx +804 -0
  435. package/tests/components/RootLayout.test.tsx +83 -0
  436. package/tests/components/SaveQueryModal.test.tsx +25 -0
  437. package/tests/components/SavedQueries.test.tsx +43 -0
  438. package/tests/components/SchemaDiagram.test.tsx +1034 -0
  439. package/tests/components/SchemaDiff.test.tsx +906 -0
  440. package/tests/components/SnapshotTimeline.test.tsx +174 -0
  441. package/tests/components/Studio.test.tsx +1030 -0
  442. package/tests/components/TestDataGenerator.test.tsx +291 -0
  443. package/tests/components/VisualExplain.test.tsx +704 -0
  444. package/tests/components/admin/AdminDashboard.test.tsx +205 -0
  445. package/tests/components/admin/AuditTab.test.tsx +220 -0
  446. package/tests/components/admin/MonitoringEmbed.test.tsx +58 -0
  447. package/tests/components/admin/OperationsTab.test.tsx +975 -0
  448. package/tests/components/admin/OverviewTab.test.tsx +254 -0
  449. package/tests/components/admin/SecurityTab.test.tsx +467 -0
  450. package/tests/components/monitoring/MetricChart.test.tsx +111 -0
  451. package/tests/components/monitoring/MonitoringDashboard.test.tsx +259 -0
  452. package/tests/components/monitoring/OverviewTab.test.tsx +78 -0
  453. package/tests/components/monitoring/PerformanceTab.test.tsx +87 -0
  454. package/tests/components/monitoring/PoolTab.test.tsx +42 -0
  455. package/tests/components/monitoring/QueriesTab.test.tsx +80 -0
  456. package/tests/components/monitoring/SessionsTab.test.tsx +154 -0
  457. package/tests/components/monitoring/StorageTab.test.tsx +127 -0
  458. package/tests/components/monitoring/TablesTab.test.tsx +153 -0
  459. package/tests/components/results-grid/ResultCard.test.tsx +105 -0
  460. package/tests/components/results-grid/RowDetailSheet.test.tsx +308 -0
  461. package/tests/components/results-grid/StatsBar.test.tsx +162 -0
  462. package/tests/components/schema-explorer/ColumnList.test.tsx +151 -0
  463. package/tests/components/schema-explorer/SchemaExplorer.test.tsx +461 -0
  464. package/tests/components/schema-explorer/TableItem.test.tsx +415 -0
  465. package/tests/components/sidebar/ConnectionItem.test.tsx +201 -0
  466. package/tests/components/sidebar/ConnectionsList.test.tsx +176 -0
  467. package/tests/components/sidebar/Sidebar.test.tsx +187 -0
  468. package/tests/components/studio/BottomPanel.test.tsx +383 -0
  469. package/tests/components/studio/QueryToolbar.test.tsx +321 -0
  470. package/tests/components/studio/StudioDesktopHeader.test.tsx +377 -0
  471. package/tests/components/studio/StudioMobileHeader.test.tsx +198 -0
  472. package/tests/components/studio/StudioTabBar.test.tsx +331 -0
  473. package/tests/fixtures/connections.ts +96 -0
  474. package/tests/fixtures/masking-configs.ts +86 -0
  475. package/tests/fixtures/query-results.ts +71 -0
  476. package/tests/fixtures/schemas.ts +64 -0
  477. package/tests/fixtures/seed-connections/invalid-config.yaml +7 -0
  478. package/tests/fixtures/seed-connections/minimal-config.yaml +8 -0
  479. package/tests/fixtures/seed-connections/mixed-credentials.yaml +23 -0
  480. package/tests/fixtures/seed-connections/multi-role-config.yaml +30 -0
  481. package/tests/fixtures/seed-connections/valid-config.json +15 -0
  482. package/tests/fixtures/seed-connections/valid-config.yaml +51 -0
  483. package/tests/helpers/mock-fetch.ts +59 -0
  484. package/tests/helpers/mock-monaco.ts +112 -0
  485. package/tests/helpers/mock-navigation.ts +28 -0
  486. package/tests/helpers/mock-next.ts +80 -0
  487. package/tests/helpers/mock-provider.ts +133 -0
  488. package/tests/helpers/mock-sonner.ts +29 -0
  489. package/tests/helpers/render-with-providers.tsx +19 -0
  490. package/tests/hooks/use-ai-chat.test.ts +600 -0
  491. package/tests/hooks/use-auth.test.ts +371 -0
  492. package/tests/hooks/use-connection-form.test.ts +743 -0
  493. package/tests/hooks/use-connection-manager.test.ts +466 -0
  494. package/tests/hooks/use-inline-editing.test.ts +321 -0
  495. package/tests/hooks/use-mobile.test.ts +177 -0
  496. package/tests/hooks/use-monitoring-data.test.ts +819 -0
  497. package/tests/hooks/use-provider-metadata.test.ts +228 -0
  498. package/tests/hooks/use-query-execution.test.ts +1212 -0
  499. package/tests/hooks/use-tab-manager.test.ts +756 -0
  500. package/tests/hooks/use-toast.test.ts +74 -0
  501. package/tests/hooks/use-transaction-control.test.ts +211 -0
  502. package/tests/integration/db/mongodb-provider.test.ts +698 -0
  503. package/tests/integration/db/mssql-provider.test.ts +840 -0
  504. package/tests/integration/db/mysql-provider.test.ts +872 -0
  505. package/tests/integration/db/oracle-provider.test.ts +843 -0
  506. package/tests/integration/db/postgres-provider.test.ts +1382 -0
  507. package/tests/integration/db/redis-provider.test.ts +526 -0
  508. package/tests/integration/db/sqlite-provider.test.ts +480 -0
  509. package/tests/integration/seed/seed-pipeline.test.ts +102 -0
  510. package/tests/isolated/factory-singleton.test.ts +150 -0
  511. package/tests/isolated/use-storage-sync.test.ts +389 -0
  512. package/tests/run-components.sh +196 -0
  513. package/tests/setup-dom.ts +58 -0
  514. package/tests/setup.ts +40 -0
  515. package/tests/unit/api-errors.test.ts +210 -0
  516. package/tests/unit/code-generator-functions.test.ts +271 -0
  517. package/tests/unit/components/column-list.test.tsx +190 -0
  518. package/tests/unit/components/data-import-modal.test.tsx +441 -0
  519. package/tests/unit/components/studio-mobile-header.test.tsx +327 -0
  520. package/tests/unit/data-charts-functions.test.ts +496 -0
  521. package/tests/unit/data-import-functions.test.ts +320 -0
  522. package/tests/unit/data-import-utils.test.ts +125 -0
  523. package/tests/unit/db/base-provider.test.ts +517 -0
  524. package/tests/unit/db/errors.test.ts +403 -0
  525. package/tests/unit/db/factory.test.ts +436 -0
  526. package/tests/unit/db/pool-manager.test.ts +440 -0
  527. package/tests/unit/db/query-limiter.test.ts +387 -0
  528. package/tests/unit/db/sql-base.test.ts +438 -0
  529. package/tests/unit/lib/api/error-codes.test.ts +39 -0
  530. package/tests/unit/lib/audit.test.ts +326 -0
  531. package/tests/unit/lib/auth.test.ts +146 -0
  532. package/tests/unit/lib/connection-string-parser.test.ts +424 -0
  533. package/tests/unit/lib/data-masking.test.ts +583 -0
  534. package/tests/unit/lib/db-icons.test.tsx +41 -0
  535. package/tests/unit/lib/monitoring-thresholds.test.ts +133 -0
  536. package/tests/unit/lib/oidc.test.ts +509 -0
  537. package/tests/unit/lib/query-generators.test.ts +127 -0
  538. package/tests/unit/lib/storage/factory.test.ts +71 -0
  539. package/tests/unit/lib/storage/local-storage.test.ts +114 -0
  540. package/tests/unit/lib/storage/providers/postgres.test.ts +312 -0
  541. package/tests/unit/lib/storage/providers/sqlite.test.ts +232 -0
  542. package/tests/unit/lib/storage/storage-facade-extended.test.ts +331 -0
  543. package/tests/unit/lib/storage/storage-facade.test.ts +184 -0
  544. package/tests/unit/lib/storage.test.ts +317 -0
  545. package/tests/unit/lib/time-series-buffer.test.ts +212 -0
  546. package/tests/unit/lib/utils.test.ts +24 -0
  547. package/tests/unit/llm/base-provider.test.ts +238 -0
  548. package/tests/unit/llm/config.test.ts +262 -0
  549. package/tests/unit/llm/custom-provider.test.ts +281 -0
  550. package/tests/unit/llm/gemini-provider.test.ts +248 -0
  551. package/tests/unit/llm/llm-factory.test.ts +155 -0
  552. package/tests/unit/llm/ollama-provider.test.ts +288 -0
  553. package/tests/unit/llm/openai-provider.test.ts +324 -0
  554. package/tests/unit/llm/retry.test.ts +180 -0
  555. package/tests/unit/llm/streaming.test.ts +355 -0
  556. package/tests/unit/logger.test.ts +198 -0
  557. package/tests/unit/mongodb-completions.test.ts +516 -0
  558. package/tests/unit/pivot-table-functions.test.ts +76 -0
  559. package/tests/unit/query-cancelled-error.test.ts +81 -0
  560. package/tests/unit/schema-diff/diff-engine.test.ts +367 -0
  561. package/tests/unit/schema-diff/migration-generator.test.ts +513 -0
  562. package/tests/unit/seed/config-loader.test.ts +73 -0
  563. package/tests/unit/seed/connection-filter.test.ts +91 -0
  564. package/tests/unit/seed/credential-resolver.test.ts +85 -0
  565. package/tests/unit/seed/index.test.ts +72 -0
  566. package/tests/unit/seed/resolve-connection.test.ts +74 -0
  567. package/tests/unit/seed/types.test.ts +129 -0
  568. package/tests/unit/sql/alias-extractor.test.ts +444 -0
  569. package/tests/unit/sql/statement-splitter.test.ts +348 -0
  570. package/tests/unit/sql-completions.test.ts +463 -0
  571. package/tests/unit/ssh-tunnel.test.ts +465 -0
  572. package/tsconfig.json +42 -0
@@ -0,0 +1,681 @@
1
+ # OIDC Architecture
2
+
3
+ > Developer reference for the OIDC authentication subsystem in LibreDB Studio.
4
+ > For user-facing setup instructions, see [OIDC_SETUP.md](./OIDC_SETUP.md).
5
+
6
+ ---
7
+
8
+ ## Table of Contents
9
+
10
+ - [Design Philosophy](#design-philosophy)
11
+ - [Module Map](#module-map)
12
+ - [Authentication Flows](#authentication-flows)
13
+ - [Module Deep Dive](#module-deep-dive)
14
+ - [State Management](#state-management)
15
+ - [Security Model](#security-model)
16
+ - [Role Mapping Engine](#role-mapping-engine)
17
+ - [Provider Logout Strategy](#provider-logout-strategy)
18
+ - [Error Handling](#error-handling)
19
+ - [Testing Architecture](#testing-architecture)
20
+ - [Extension Points](#extension-points)
21
+ - [Decision Log](#decision-log)
22
+
23
+ ---
24
+
25
+ ## Design Philosophy
26
+
27
+ The OIDC subsystem follows three core principles:
28
+
29
+ 1. **Local JWT Session After OIDC** — After OIDC authentication, a standard `auth-token` JWT cookie is created (identical to local login). This means the proxy, `useAuth` hook, RBAC, and all protected routes are completely unaware of OIDC. Zero coupling.
30
+
31
+ 2. **Vendor-Agnostic** — No provider-specific SDK (no `@auth0/nextjs-auth0`, no Keycloak adapter). Uses `openid-client` v6 which implements the OIDC spec generically. Provider differences are handled only in two places: role claim path and logout URL format.
32
+
33
+ 3. **Single Switch** — `NEXT_PUBLIC_AUTH_PROVIDER=local|oidc` is the only toggle. The login page conditionally renders, the logout route conditionally returns a redirect URL, and everything else stays the same.
34
+
35
+ ---
36
+
37
+ ## Module Map
38
+
39
+ ```
40
+ ┌─────────────────────────────────────────────────────────────────┐
41
+ │ Browser (Client) │
42
+ │ │
43
+ │ ┌──────────────┐ ┌──────────────┐ ┌────────────────────┐ │
44
+ │ │ login/page │ │ use-auth.ts │ │ proxy.ts │ │
45
+ │ │ (LoginForm) │ │ (hook) │ │ (middleware) │ │
46
+ │ └──────┬───────┘ └──────┬───────┘ └────────┬───────────┘ │
47
+ │ │ │ │ │
48
+ └─────────┼──────────────────┼─────────────────────┼──────────────┘
49
+ │ │ │
50
+ ▼ ▼ ▼
51
+ ┌─────────────────────────────────────────────────────────────────┐
52
+ │ Next.js API Routes │
53
+ │ │
54
+ │ ┌──────────────────┐ ┌───────────────────┐ ┌─────────────┐ │
55
+ │ │ /api/auth/oidc/ │ │ /api/auth/oidc/ │ │ /api/auth/ │ │
56
+ │ │ login/route.ts │ │ callback/route.ts │ │ logout/ │ │
57
+ │ │ (GET → redirect) │ │ (GET → exchange) │ │ route.ts │ │
58
+ │ └────────┬─────────┘ └────────┬──────────┘ └──────┬──────┘ │
59
+ │ │ │ │ │
60
+ │ └─────────┬───────────┘ │ │
61
+ │ ▼ ▼ │
62
+ │ ┌─────────────────┐ ┌──────────────────┐ │
63
+ │ │ src/lib/oidc.ts│ │ src/lib/auth.ts │ │
64
+ │ │ (OIDC module) │──────────────│ (JWT sessions) │ │
65
+ │ └────────┬────────┘ └──────────────────┘ │
66
+ │ │ │
67
+ └────────────────────┼────────────────────────────────────────────┘
68
+
69
+
70
+ ┌─────────────────┐
71
+ │ OIDC Provider │
72
+ │ (Auth0, etc.) │
73
+ └─────────────────┘
74
+ ```
75
+
76
+ ### File Responsibilities
77
+
78
+ | File | Lines | Responsibility |
79
+ |------|-------|----------------|
80
+ | `src/lib/oidc.ts` | ~230 | Pure OIDC logic: config, discovery, PKCE, token exchange, role mapping, state crypto, logout URL |
81
+ | `src/lib/auth.ts` | ~72 | JWT session: `signJWT`, `verifyJWT`, `login`, `logout`, `getSession` — shared by both auth modes |
82
+ | `src/app/api/auth/oidc/login/route.ts` | ~43 | Login initiation: generate auth URL, set state cookie, redirect |
83
+ | `src/app/api/auth/oidc/callback/route.ts` | ~80 | Callback handler: validate state, exchange code, map role, create session |
84
+ | `src/app/api/auth/logout/route.ts` | ~21 | Logout: clear JWT cookie, optionally return OIDC provider logout URL |
85
+ | `src/app/login/page.tsx` | ~200 | Login UI: conditional SSO button vs email/password form |
86
+ | `src/hooks/use-auth.ts` | ~52 | Client hook: user state, `handleLogout` with OIDC redirect support |
87
+ | `src/proxy.ts` | ~92 | Middleware: JWT verification, RBAC, route protection (auth-mode agnostic) |
88
+
89
+ ---
90
+
91
+ ## Authentication Flows
92
+
93
+ ### OIDC Login Flow (Authorization Code + PKCE)
94
+
95
+ ```
96
+ Browser Next.js Server OIDC Provider
97
+ │ │ │
98
+ │ 1. Click "Login with SSO" │ │
99
+ │──────────────────────────► │ │
100
+ │ │ │
101
+ │ 2. GET /api/auth/oidc/login │
102
+ │ │ 3. discoverProvider() │
103
+ │ │──────────────────────────────────►│
104
+ │ │◄─ /.well-known/openid-config ───│
105
+ │ │ │
106
+ │ │ 4. generateAuthUrl() │
107
+ │ │ ├─ code_verifier (random) │
108
+ │ │ ├─ code_challenge (S256 hash) │
109
+ │ │ ├─ state (random) │
110
+ │ │ └─ nonce (random) │
111
+ │ │ │
112
+ │ │ 5. encryptState({ │
113
+ │ │ code_verifier, state, nonce │
114
+ │ │ }) → signed JWT cookie │
115
+ │ │ │
116
+ │ 6. Set-Cookie: oidc-state │ │
117
+ │◄── 302 → authorize_endpoint│ │
118
+ │ ?client_id=xxx │ │
119
+ │ &redirect_uri=callback │ │
120
+ │ &code_challenge=xxx │ │
121
+ │ &state=xxx │ │
122
+ │ &nonce=xxx │ │
123
+ │ &prompt=login │ │
124
+ │ │ │
125
+ │ 7. User authenticates │ │
126
+ │────────────────────────────────────────────────────────────► │
127
+ │◄─── 302 /api/auth/oidc/callback?code=xxx&state=xxx ─────────── │
128
+ │ │ │
129
+ │ 8. GET /api/auth/oidc/callback │
130
+ │──────────────────────────► │ │
131
+ │ │ 9. decryptState(cookie) │
132
+ │ │ └─ extract code_verifier, │
133
+ │ │ state, nonce │
134
+ │ │ │
135
+ │ │ 10. Validate state matches │
136
+ │ │ │
137
+ │ │ 11. exchangeCode() │
138
+ │ │─────────────────────────────────► │
139
+ │ │◄── id_token + access_token ───── │
140
+ │ │ │
141
+ │ │ 12. Extract claims from id_token │
142
+ │ │ 13. mapOIDCRole(claims) │
143
+ │ │ └─ admin or user │
144
+ │ │ │
145
+ │ │ 14. login(role, email) │
146
+ │ │ └─ signJWT → auth-token cookie│
147
+ │ │ │
148
+ │ │ 15. Delete oidc-state cookie │
149
+ │ │ │
150
+ │ 16. Set-Cookie: auth-token│ │
151
+ │◄── 302 → / or /admin ─────│ │
152
+ │ │ │
153
+ ╞════════════════════════════════════════════════════════════════╡
154
+ │ From here: identical to local password login │
155
+ │ proxy.ts reads auth-token, useAuth reads /api/auth/me │
156
+ ╘════════════════════════════════════════════════════════════════╛
157
+ ```
158
+
159
+ ### OIDC Logout Flow
160
+
161
+ ```
162
+ Browser Next.js Server OIDC Provider
163
+ │ │ │
164
+ │ 1. handleLogout() │ │
165
+ │ POST /api/auth/logout │ │
166
+ │──────────────────────────► │ │
167
+ │ │ 2. logout() │
168
+ │ │ └─ delete auth-token │
169
+ │ │ │
170
+ │ │ 3. if OIDC mode: │
171
+ │ │ buildLogoutUrl(returnTo)│
172
+ │ │ │
173
+ │ 4. { success, redirectUrl }│ │
174
+ │◄───────────────────────────│ │
175
+ │ │ │
176
+ │ 5. window.location.href │ │
177
+ │ = redirectUrl │ │
178
+ │─────────────────────────────────────────────────────► │
179
+ │ │ │
180
+ │◄─── 302 → /login (returnTo) ─────────────────────────│
181
+ │ │ │
182
+ ```
183
+
184
+ ### Local Login Flow (for comparison)
185
+
186
+ ```
187
+ Browser Next.js Server
188
+ │ │
189
+ │ POST /api/auth/login │
190
+ │ { email, password } │
191
+ │──────────────────────────► │
192
+ │ │ validate credentials
193
+ │ │ login(role, email)
194
+ │ │ └─ signJWT → auth-token
195
+ │ { success, role } │
196
+ │◄───────────────────────────│
197
+ │ │
198
+ │ router.push(/ or /admin) │
199
+ ```
200
+
201
+ ---
202
+
203
+ ## Module Deep Dive
204
+
205
+ ### `src/lib/oidc.ts`
206
+
207
+ The OIDC module is a pure utility library with no side effects. All functions are stateless except for the discovery cache.
208
+
209
+ #### Types
210
+
211
+ ```typescript
212
+ interface OIDCConfig {
213
+ issuer: string; // e.g. "https://dev-xxx.auth0.com"
214
+ clientId: string;
215
+ clientSecret: string;
216
+ scope: string; // Default: "openid profile email"
217
+ roleClaim: string; // e.g. "realm_access.roles"
218
+ adminRoles: string[]; // e.g. ["admin"]
219
+ }
220
+
221
+ interface OIDCState {
222
+ code_verifier: string; // PKCE random bytes (base64url)
223
+ state: string; // CSRF protection random
224
+ nonce: string; // Replay protection random
225
+ }
226
+
227
+ interface OIDCClaims {
228
+ sub: string; // Subject identifier
229
+ email?: string;
230
+ name?: string;
231
+ [key: string]: unknown; // Provider-specific claims
232
+ }
233
+ ```
234
+
235
+ #### Function Dependency Graph
236
+
237
+ ```
238
+ getOIDCConfig() ← reads env vars
239
+
240
+
241
+ discoverProvider(config?) ← openid-client discovery + 5-min cache
242
+
243
+ ├──► generateAuthUrl(config, redirectUri, scope)
244
+ │ └─ returns { url, state: OIDCState }
245
+
246
+ └──► exchangeCode(config, callbackUrl, codeVerifier, state, nonce)
247
+ └─ returns OIDCClaims | null
248
+
249
+ mapOIDCRole(claims, roleClaim, adminRoles) ← pure function, no deps
250
+
251
+ encryptState(data) / decryptState(token) ← jose JWT sign/verify
252
+
253
+ buildLogoutUrl(returnTo) ← reads getOIDCConfig()
254
+ ```
255
+
256
+ #### Discovery Cache
257
+
258
+ ```typescript
259
+ // In-memory, module-level singleton
260
+ let cachedConfig: client.Configuration | null = null;
261
+ let cacheTimestamp = 0;
262
+ const CACHE_TTL = 5 * 60 * 1000; // 5 minutes
263
+
264
+ // discoverProvider() checks:
265
+ if (cachedConfig && Date.now() - cacheTimestamp < CACHE_TTL) {
266
+ return cachedConfig; // Cache hit
267
+ }
268
+ // Otherwise: fetch /.well-known/openid-configuration
269
+
270
+ // resetDiscoveryCache() — exposed for testing
271
+ ```
272
+
273
+ The cache prevents hitting the provider's discovery endpoint on every login. 5-minute TTL balances freshness with performance. The cache is process-level (shared across all requests in the same Next.js server instance).
274
+
275
+ ### `src/lib/auth.ts`
276
+
277
+ The JWT session layer is completely auth-mode agnostic:
278
+
279
+ ```typescript
280
+ // Same function called by both local login route and OIDC callback:
281
+ export async function login(role: Role, username?: string) {
282
+ const token = await signJWT({ role, username: username || role });
283
+ const cookieStore = await cookies();
284
+ cookieStore.set('auth-token', token, {
285
+ httpOnly: true,
286
+ secure: process.env.NODE_ENV === 'production',
287
+ sameSite: 'lax',
288
+ maxAge: 86400, // 24 hours
289
+ path: '/',
290
+ });
291
+ }
292
+ ```
293
+
294
+ The optional `username` parameter was added for OIDC — local login passes the email, OIDC callback passes `claims.email || claims.sub`.
295
+
296
+ ### `src/proxy.ts`
297
+
298
+ The proxy (Next.js 16 middleware) has zero OIDC awareness:
299
+
300
+ ```typescript
301
+ // Public routes — includes /api/auth/* which covers OIDC routes
302
+ const publicPaths = ['/api/auth', '/_next', '/favicon.ico', '/api/db/health'];
303
+
304
+ // All auth checks use the same auth-token JWT
305
+ const token = request.cookies.get('auth-token')?.value;
306
+ const payload = token ? await verifyJWT(token) : null;
307
+ ```
308
+
309
+ OIDC routes (`/api/auth/oidc/login`, `/api/auth/oidc/callback`) are automatically public because they match the `/api/auth` prefix.
310
+
311
+ ---
312
+
313
+ ## State Management
314
+
315
+ ### PKCE State Cookie
316
+
317
+ The OIDC login flow requires carrying three values from the login route to the callback route: `code_verifier`, `state`, and `nonce`. These are stored in a signed JWT cookie:
318
+
319
+ ```
320
+ ┌─────────────────────────────────────────────┐
321
+ │ Cookie: oidc-state │
322
+ │ Value: JWT (HS256 signed with JWT_SECRET) │
323
+ │ │
324
+ │ Payload: { │
325
+ │ code_verifier: "dBjftJeZ4CVP...", │
326
+ │ state: "xyz123", │
327
+ │ nonce: "abc789", │
328
+ │ exp: <now + 5 minutes> │
329
+ │ } │
330
+ │ │
331
+ │ Cookie flags: │
332
+ │ httpOnly: true │
333
+ │ secure: true (production) │
334
+ │ sameSite: lax │
335
+ │ maxAge: 300 (5 minutes) │
336
+ │ path: / │
337
+ └─────────────────────────────────────────────┘
338
+ ```
339
+
340
+ **Why JWT and not a plain cookie?**
341
+ - The state must be tamper-proof — an attacker shouldn't be able to forge a state cookie
342
+ - JWT signing with `JWT_SECRET` provides integrity verification without needing server-side storage
343
+ - The 5-minute expiry prevents stale state cookies from accumulating
344
+
345
+ **Lifecycle:**
346
+ 1. Created in `/api/auth/oidc/login` via `encryptState()`
347
+ 2. Read in `/api/auth/oidc/callback` via `decryptState()`
348
+ 3. Deleted in callback after successful exchange (set maxAge: 0)
349
+
350
+ ### Session Cookie
351
+
352
+ After OIDC (or local) authentication:
353
+
354
+ ```
355
+ ┌─────────────────────────────────────────────┐
356
+ │ Cookie: auth-token │
357
+ │ Value: JWT (HS256 signed with JWT_SECRET) │
358
+ │ │
359
+ │ Payload: { │
360
+ │ role: "admin" | "user", │
361
+ │ username: "user@example.com", │
362
+ │ exp: <now + 24 hours> │
363
+ │ } │
364
+ │ │
365
+ │ Cookie flags: │
366
+ │ httpOnly: true │
367
+ │ secure: true (production) │
368
+ │ sameSite: lax │
369
+ │ maxAge: 86400 (24 hours) │
370
+ │ path: / │
371
+ └─────────────────────────────────────────────┘
372
+ ```
373
+
374
+ ---
375
+
376
+ ## Security Model
377
+
378
+ ### PKCE (Proof Key for Code Exchange)
379
+
380
+ Prevents authorization code interception attacks in the callback redirect:
381
+
382
+ ```
383
+ Login route:
384
+ code_verifier = random(32 bytes, base64url)
385
+ code_challenge = base64url(SHA256(code_verifier))
386
+
387
+ → Send code_challenge to provider
388
+ → Store code_verifier in signed cookie
389
+
390
+ Callback route:
391
+ → Send code_verifier to provider's token endpoint
392
+ → Provider verifies: SHA256(code_verifier) === code_challenge
393
+ ```
394
+
395
+ Even if an attacker intercepts the authorization code in the redirect URL, they cannot exchange it without the `code_verifier` (stored in an httpOnly cookie on the user's browser).
396
+
397
+ ### State Parameter (CSRF Protection)
398
+
399
+ ```
400
+ Login route:
401
+ state = random(32 bytes, base64url)
402
+ → Send state to provider in auth URL
403
+ → Store state in signed cookie
404
+
405
+ Callback route:
406
+ → Verify: URL query state === cookie state
407
+ ```
408
+
409
+ Prevents CSRF attacks where an attacker tricks a user into completing an OAuth flow initiated by the attacker.
410
+
411
+ ### Nonce (Replay Protection)
412
+
413
+ ```
414
+ Login route:
415
+ nonce = random(32 bytes, base64url)
416
+ → Send nonce to provider in auth URL
417
+ → Store nonce in signed cookie
418
+
419
+ Callback route:
420
+ → openid-client validates: id_token.nonce === expected nonce
421
+ ```
422
+
423
+ Prevents replay attacks where an intercepted ID token is reused.
424
+
425
+ ### `prompt=login`
426
+
427
+ ```typescript
428
+ // In generateAuthUrl():
429
+ parameters.set('prompt', 'login');
430
+ ```
431
+
432
+ Forces the OIDC provider to show the login screen on every SSO click, even if the user has an active session at the provider. This prevents:
433
+ - Session fixation (user A clicks SSO but gets user B's session)
434
+ - Unintended auto-login (user logs out of LibreDB but still has a provider session)
435
+
436
+ ### Cookie Security Summary
437
+
438
+ | Cookie | HttpOnly | Secure | SameSite | MaxAge | Signed |
439
+ |--------|----------|--------|----------|--------|--------|
440
+ | `oidc-state` | Yes | Yes (prod) | Lax | 5 min | JWT (HS256) |
441
+ | `auth-token` | Yes | Yes (prod) | Lax | 24 hours | JWT (HS256) |
442
+
443
+ ---
444
+
445
+ ## Role Mapping Engine
446
+
447
+ The role mapping system converts provider-specific claims into LibreDB's binary role model (`admin` | `user`).
448
+
449
+ ### Algorithm (`mapOIDCRole`)
450
+
451
+ ```
452
+ Input: claims object, roleClaim path, adminRoles list
453
+
454
+ 1. If roleClaim is empty → return "user"
455
+
456
+ 2. Navigate claim path (dot-notation):
457
+ "realm_access.roles" → claims["realm_access"]["roles"]
458
+
459
+ 3. Get claim value:
460
+ a. If Array → check if ANY element matches adminRoles (case-insensitive)
461
+ b. If String → check if it matches any adminRole (case-insensitive)
462
+ c. Otherwise → return "user"
463
+
464
+ 4. Match found → "admin", no match → "user"
465
+ ```
466
+
467
+ ### Examples
468
+
469
+ ```
470
+ Provider: Auth0
471
+ Claims: { "https://libredb.org/roles": ["admin", "viewer"] }
472
+ Config: OIDC_ROLE_CLAIM=https://libredb.org/roles
473
+ OIDC_ADMIN_ROLES=admin
474
+ Result: "admin" ✓ (array contains "admin")
475
+
476
+ Provider: Keycloak
477
+ Claims: { "realm_access": { "roles": ["offline_access", "uma_authorization", "admin"] } }
478
+ Config: OIDC_ROLE_CLAIM=realm_access.roles
479
+ OIDC_ADMIN_ROLES=admin
480
+ Result: "admin" ✓ (dot-notation navigates nested object)
481
+
482
+ Provider: Okta
483
+ Claims: { "groups": ["Everyone", "Engineering"] }
484
+ Config: OIDC_ROLE_CLAIM=groups
485
+ OIDC_ADMIN_ROLES=admin,Admin
486
+ Result: "user" ✗ (no match in groups array)
487
+
488
+ Provider: Google
489
+ Claims: { "sub": "123", "email": "user@gmail.com" }
490
+ Config: OIDC_ROLE_CLAIM= (empty)
491
+ Result: "user" (no claim configured, default)
492
+ ```
493
+
494
+ ---
495
+
496
+ ## Provider Logout Strategy
497
+
498
+ Different OIDC providers have different logout endpoint conventions. `buildLogoutUrl()` handles this:
499
+
500
+ ```typescript
501
+ function buildLogoutUrl(returnTo: string): string | null {
502
+ const config = getOIDCConfig();
503
+ const issuerUrl = new URL(config.issuer);
504
+
505
+ if (issuerUrl.hostname.includes('auth0.com')) {
506
+ // Auth0: /v2/logout?client_id=xxx&returnTo=xxx
507
+ return new URL('/v2/logout', config.issuer) + params;
508
+ }
509
+
510
+ // Generic OIDC (Keycloak, etc.):
511
+ // /protocol/openid-connect/logout?client_id=xxx&post_logout_redirect_uri=xxx
512
+ return new URL('/protocol/openid-connect/logout', config.issuer) + params;
513
+ }
514
+ ```
515
+
516
+ ### Provider Logout Endpoints
517
+
518
+ | Provider | Endpoint | Return Param |
519
+ |----------|----------|--------------|
520
+ | **Auth0** | `{issuer}/v2/logout` | `returnTo` |
521
+ | **Keycloak** | `{issuer}/protocol/openid-connect/logout` | `post_logout_redirect_uri` |
522
+ | **Okta** | RP-Initiated Logout (via discovery) | `post_logout_redirect_uri` |
523
+ | **Azure AD** | `{issuer}/oauth2/v2.0/logout` | `post_logout_redirect_uri` |
524
+
525
+ ### Extension Point
526
+
527
+ To add a new provider's logout format, extend `buildLogoutUrl()` with a new hostname check:
528
+
529
+ ```typescript
530
+ if (issuerUrl.hostname.includes('okta.com')) {
531
+ const logoutUrl = new URL('/oauth2/v1/logout', config.issuer);
532
+ logoutUrl.searchParams.set('id_token_hint', idToken);
533
+ logoutUrl.searchParams.set('post_logout_redirect_uri', returnTo);
534
+ return logoutUrl.toString();
535
+ }
536
+ ```
537
+
538
+ ---
539
+
540
+ ## Error Handling
541
+
542
+ ### Callback Error Codes
543
+
544
+ The callback route redirects to `/login?error=<code>` on failure:
545
+
546
+ | Error Code | Cause | When |
547
+ |------------|-------|------|
548
+ | `oidc_state_missing` | `oidc-state` cookie not found | Cookie expired (>5 min) or blocked by browser |
549
+ | `oidc_state_invalid` | State decryption failed or state mismatch | Tampered cookie, wrong JWT_SECRET, or CSRF attempt |
550
+ | `oidc_no_claims` | Token exchange returned no claims | Provider returned invalid/empty ID token |
551
+ | `oidc_failed` | Generic catch-all error | Network error, invalid client credentials, etc. |
552
+ | `oidc_config` | OIDC configuration invalid | Missing env vars, unreachable discovery endpoint |
553
+
554
+ ### Login Page Error Display
555
+
556
+ ```tsx
557
+ // login/page.tsx reads ?error= param
558
+ const oidcError = searchParams.get('error');
559
+
560
+ {oidcError && (
561
+ <div className="border-destructive/50 bg-destructive/10 text-destructive">
562
+ Authentication failed. Please try again.
563
+ </div>
564
+ )}
565
+ ```
566
+
567
+ ### Server-Side Error Logging
568
+
569
+ All routes log errors to `console.error` before redirecting. In production, these should be captured by your logging infrastructure (e.g., Datadog, Sentry).
570
+
571
+ ---
572
+
573
+ ## Testing Architecture
574
+
575
+ ### Test Strategy
576
+
577
+ The OIDC module is tested at three layers:
578
+
579
+ ```
580
+ ┌──────────────────────────────────────────────┐
581
+ │ Unit Tests (tests/unit/lib/oidc.test.ts) │
582
+ │ Pure functions: mapOIDCRole, getOIDCConfig, │
583
+ │ encryptState, decryptState, buildLogoutUrl, │
584
+ │ discoverProvider, generateAuthUrl, │
585
+ │ exchangeCode, resetDiscoveryCache │
586
+ ├──────────────────────────────────────────────┤
587
+ │ API Tests (tests/api/auth/) │
588
+ │ Route handlers: oidc-login, oidc-callback, │
589
+ │ logout (OIDC mode), login (email/password) │
590
+ ├──────────────────────────────────────────────┤
591
+ │ Hook + Component Tests │
592
+ │ use-auth (OIDC redirect), LoginPageOIDC │
593
+ ├──────────────────────────────────────────────┤
594
+ │ E2E Tests (e2e/) │
595
+ │ Full browser login flow (local mode only, │
596
+ │ OIDC requires real provider) │
597
+ └──────────────────────────────────────────────┘
598
+ ```
599
+
600
+ ### Mock Strategy
601
+
602
+ Since `openid-client` performs real HTTP requests, it must be mocked in tests:
603
+
604
+ ```typescript
605
+ // tests/unit/lib/oidc.test.ts
606
+ const mockDiscoveryFn = mock(async () => 'mock-config');
607
+
608
+ mock.module('openid-client', () => ({
609
+ discovery: mockDiscoveryFn,
610
+ fetchUserInfo: mock(async () => ({})),
611
+ buildEndSessionUrl: mock(() => new URL('https://example.com')),
612
+ authorizationCodeGrant: mock(async () => ({ claims: () => mockClaims })),
613
+ // ...
614
+ }));
615
+
616
+ // Dynamic import AFTER mocking:
617
+ const { discoverProvider, generateAuthUrl, exchangeCode } = await import('@/lib/oidc');
618
+ ```
619
+
620
+ Key testing patterns:
621
+ - **`mock.module()` before dynamic `import()`** — ensures the mock is in place when the module loads
622
+ - **Process env manipulation** — `process.env.OIDC_ISSUER = 'https://...'` in `beforeEach`, restore in `afterEach`
623
+ - **Module-level env reads moved to function body** — `const authProvider = process.env.NEXT_PUBLIC_AUTH_PROVIDER` inside the route handler, not at module scope (for testability)
624
+
625
+ ### Test File Map
626
+
627
+ | File | Tests | Coverage Target |
628
+ |------|-------|-----------------|
629
+ | `tests/unit/lib/oidc.test.ts` | ~30 | All `oidc.ts` functions |
630
+ | `tests/api/auth/oidc-login.test.ts` | ~4 | Login route redirect, PKCE state |
631
+ | `tests/api/auth/oidc-callback.test.ts` | ~9 | Code exchange, role mapping, errors |
632
+ | `tests/api/auth/logout.test.ts` | ~8 | Local + OIDC logout modes |
633
+ | `tests/hooks/use-auth.test.ts` | ~12 | Including OIDC redirect test |
634
+ | `tests/components/LoginPageOIDC.test.tsx` | ~7 | SSO button, error display |
635
+
636
+ ---
637
+
638
+ ## Extension Points
639
+
640
+ ### Adding a New OIDC Provider
641
+
642
+ No code changes needed if the provider is OIDC-compliant. Just set the env vars. If the provider has a non-standard logout endpoint, add a case in `buildLogoutUrl()`.
643
+
644
+ ### Adding SAML 2.0
645
+
646
+ Future SAML support would follow the same pattern:
647
+ 1. Create `src/lib/saml.ts` (config, assertion parsing, attribute mapping)
648
+ 2. Create `/api/auth/saml/login/route.ts` and `/api/auth/saml/callback/route.ts`
649
+ 3. Call `login(role, email)` at the end — same JWT session
650
+ 4. Add `NEXT_PUBLIC_AUTH_PROVIDER=saml` as a third option
651
+ 5. No changes to proxy, hooks, or protected routes
652
+
653
+ ### Adding Refresh Token Support
654
+
655
+ Currently, the local JWT session has a fixed 24-hour expiry. To add OIDC refresh tokens:
656
+ 1. Store `refresh_token` in an encrypted httpOnly cookie during callback
657
+ 2. Create `/api/auth/refresh/route.ts` that uses `openid-client` to refresh
658
+ 3. Update `proxy.ts` to check token expiry and trigger refresh
659
+ 4. No changes to the OIDC login/callback flow
660
+
661
+ ### Adding User Profile Display
662
+
663
+ The OIDC claims contain `name`, `email`, `picture` etc. To display these:
664
+ 1. Extend `UserPayload` in `auth.ts` with optional profile fields
665
+ 2. Include claim values in `signJWT()` call during callback
666
+ 3. The existing `/api/auth/me` endpoint and `useAuth` hook will automatically carry the new fields
667
+
668
+ ---
669
+
670
+ ## Decision Log
671
+
672
+ | Decision | Rationale | Alternatives Considered |
673
+ |----------|-----------|------------------------|
674
+ | **`openid-client` v6 over `@auth0/nextjs-auth0`** | Vendor-agnostic, same author as `jose` (already in project), zero extra deps | Auth0 SDK locks to one provider; `next-auth` adds 15+ deps and complexity |
675
+ | **Local JWT after OIDC** | Zero coupling — proxy, hooks, and routes don't know about OIDC | Forwarding provider tokens requires token refresh logic in middleware |
676
+ | **PKCE state in JWT cookie** | Stateless — no server-side session store needed | Redis/DB session store adds infrastructure dependency |
677
+ | **5-minute state cookie TTL** | Long enough for slow providers, short enough to limit replay window | Shorter: may fail on slow networks. Longer: increases attack window |
678
+ | **`prompt=login` always** | Prevents confusing auto-login behavior; user expects to choose account | `prompt=consent`: too aggressive. No prompt: users get stuck with one account |
679
+ | **Provider-specific logout detection via hostname** | Simple, works for 90% of cases | OIDC Discovery `end_session_endpoint`: not all providers support it; would require async call |
680
+ | **Module-level discovery cache** | Fast (avoids HTTP on every login), simple, process-scoped | Redis cache: overkill for single-instance deployments. No cache: 200-500ms per login |
681
+ | **Binary role model (admin/user)** | Matches existing RBAC, simple to map from any claim format | Fine-grained roles: would require schema changes in JWT, proxy, and all components |