@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.
- package/.claude/settings.local.json +127 -0
- package/.cursorrules +426 -0
- package/.devin/wiki.json +143 -0
- package/.dockerignore +80 -0
- package/.env.example +159 -0
- package/.github/ISSUE_TEMPLATE/bug_report.md +49 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +29 -0
- package/.github/PULL_REQUEST_TEMPLATE.md +57 -0
- package/.github/workflows/ci.yml +185 -0
- package/.github/workflows/codeql.yml +57 -0
- package/.github/workflows/docker-build-push.yml +118 -0
- package/.github/workflows/helm-release.yml +113 -0
- package/CLAUDE.md +265 -0
- package/CODE_OF_CONDUCT.md +124 -0
- package/CONTRIBUTING.md +154 -0
- package/Dockerfile +73 -0
- package/LICENSE +21 -0
- package/README.md +614 -0
- package/SECURITY.md +107 -0
- package/artifacthub-repo.yml +4 -0
- package/bun.lock +1714 -0
- package/bunfig.toml +3 -0
- package/charts/libredb-studio/.helmignore +11 -0
- package/charts/libredb-studio/Chart.lock +6 -0
- package/charts/libredb-studio/Chart.yaml +50 -0
- package/charts/libredb-studio/README.md +206 -0
- package/charts/libredb-studio/templates/NOTES.txt +59 -0
- package/charts/libredb-studio/templates/_helpers.tpl +135 -0
- package/charts/libredb-studio/templates/configmap.yaml +37 -0
- package/charts/libredb-studio/templates/deployment.yaml +184 -0
- package/charts/libredb-studio/templates/hpa.yaml +32 -0
- package/charts/libredb-studio/templates/ingress.yaml +41 -0
- package/charts/libredb-studio/templates/networkpolicy.yaml +50 -0
- package/charts/libredb-studio/templates/pdb.yaml +18 -0
- package/charts/libredb-studio/templates/pvc.yaml +23 -0
- package/charts/libredb-studio/templates/secret.yaml +30 -0
- package/charts/libredb-studio/templates/seed-configmap.yaml +11 -0
- package/charts/libredb-studio/templates/service.yaml +22 -0
- package/charts/libredb-studio/templates/serviceaccount.yaml +13 -0
- package/charts/libredb-studio/values.schema.json +246 -0
- package/charts/libredb-studio/values.yaml +286 -0
- package/components.json +22 -0
- package/conductor/code_styleguides/typescript.md +43 -0
- package/conductor/product-guidelines.md +43 -0
- package/conductor/product.md +3 -0
- package/conductor/setup_state.json +1 -0
- package/conductor/tech-stack.md +39 -0
- package/conductor/tracks/enhance_postgres_monitoring_20251227/metadata.json +8 -0
- package/conductor/tracks/enhance_postgres_monitoring_20251227/plan.md +44 -0
- package/conductor/tracks/enhance_postgres_monitoring_20251227/spec.md +31 -0
- package/conductor/tracks.md +8 -0
- package/conductor/workflow.md +333 -0
- package/database-compose.yml +55 -0
- package/docker/postgres-init/01-extensions.sql +10 -0
- package/docker/postgres-init/02-sample-data.sql +585 -0
- package/docker/postgres.yml +68 -0
- package/docker-compose.yml +38 -0
- package/docs/AI_PLAN.md +74 -0
- package/docs/API_DOCS.md +875 -0
- package/docs/ARCHITECTURE.md +218 -0
- package/docs/DATABASE_PROVIDERS.md +358 -0
- package/docs/FEATURES.md +116 -0
- package/docs/HELM_CHART.md +252 -0
- package/docs/LOGIN_PAGE.md +178 -0
- package/docs/MONACO_EDITOR_PERFORMANCE.md +315 -0
- package/docs/OIDC_ARCH.md +681 -0
- package/docs/OIDC_SETUP.md +322 -0
- package/docs/POSTGRES_METRICS.md +516 -0
- package/docs/QUERY_OPTIMIZATION.md +370 -0
- package/docs/SEED_CONNECTIONS.md +468 -0
- package/docs/SQL_ALIAS_COMPLETION.md +190 -0
- package/docs/STORAGE_ARCHITECTURE.md +565 -0
- package/docs/STORAGE_QUICK_SETUP.md +419 -0
- package/docs/TECHNICAL_PLAN.md +36 -0
- package/docs/THEMING.md +345 -0
- package/docs/adding-a-new-database-provider.md +642 -0
- package/docs/backlogs/000-PLATFORM_DATA_SYNC_DATABASE.md +360 -0
- package/docs/backlogs/001-INLINE_DATA_EDITING.md +118 -0
- package/docs/backlogs/002-DATA_IMPORT.md +215 -0
- package/docs/backlogs/003-QUERY_TIME_MACHINE.md +183 -0
- package/docs/backlogs/004-AI_DATA_STORYTELLER.md +292 -0
- package/docs/backlogs/005-QUERY_PLAYGROUND.md +352 -0
- package/docs/backlogs/006-DATA_MASKING.md +418 -0
- package/docs/enterprise-features.md +718 -0
- package/docs/kubernetes-helm-chart-artifacthub-plan.md +803 -0
- package/docs/medium-koyeb-article-en.md +215 -0
- package/docs/plans/test-plans.md +445 -0
- package/docs/releases/RELEASE.V0.3.0.md +22 -0
- package/docs/releases/RELEASE.V0.4.0.md +154 -0
- package/docs/releases/RELEASE.V0.5.0.md +252 -0
- package/docs/releases/RELEASE_v0.5.6.md +145 -0
- package/docs/releases/RELEASE_v0.6.1.md +303 -0
- package/docs/releases/RELEASE_v0.6.7.md +292 -0
- package/docs/releases/RELEASE_v0.7.0.md +332 -0
- package/docs/releases/RELEASE_v0.8.0.md +521 -0
- package/docs/sampledb/titanic.sql +1379 -0
- package/docs/superpowers/plans/2026-03-25-seed-connections.md +1362 -0
- package/docs/superpowers/specs/2026-03-25-seed-connections-design.md +590 -0
- package/e2e/admin-dashboard.spec.ts +64 -0
- package/e2e/connection-management.spec.ts +58 -0
- package/e2e/export.spec.ts +34 -0
- package/e2e/login.spec.ts +85 -0
- package/e2e/query-execution.spec.ts +35 -0
- package/e2e/tab-management.spec.ts +64 -0
- package/eslint.config.mjs +28 -0
- package/fly.toml +43 -0
- package/next.config.ts +32 -0
- package/package.json +130 -0
- package/playwright.config.ts +34 -0
- package/postcss.config.mjs +7 -0
- package/public/favicon-32x32.png +0 -0
- package/public/favicon.ico +0 -0
- package/public/file.svg +1 -0
- package/public/globe.svg +1 -0
- package/public/logo.svg +32 -0
- package/public/next.svg +1 -0
- package/public/screenshots/code-generator.png +0 -0
- package/public/screenshots/connection-modal.png +0 -0
- package/public/screenshots/data-profiler.png +0 -0
- package/public/screenshots/erd-diagram.png +0 -0
- package/public/screenshots/hero-editor.png +0 -0
- package/public/screenshots/nl2sql.png +0 -0
- package/public/vercel.svg +1 -0
- package/public/window.svg +1 -0
- package/render.yaml +58 -0
- package/scripts/merge-lcov.mjs +239 -0
- package/sonar-project.properties +16 -0
- package/src/app/admin/error.tsx +46 -0
- package/src/app/admin/page.tsx +10 -0
- package/src/app/api/admin/audit/route.ts +52 -0
- package/src/app/api/admin/fleet-health/route.ts +81 -0
- package/src/app/api/ai/autopilot/route.ts +105 -0
- package/src/app/api/ai/chat/route.ts +132 -0
- package/src/app/api/ai/describe-schema/route.ts +52 -0
- package/src/app/api/ai/explain/route.ts +86 -0
- package/src/app/api/ai/impact/route.ts +97 -0
- package/src/app/api/ai/index-advisor/route.ts +98 -0
- package/src/app/api/ai/nl2sql/route.ts +87 -0
- package/src/app/api/ai/query-safety/route.ts +87 -0
- package/src/app/api/auth/login/route.ts +62 -0
- package/src/app/api/auth/logout/route.ts +25 -0
- package/src/app/api/auth/me/route.ts +10 -0
- package/src/app/api/auth/oidc/callback/route.ts +82 -0
- package/src/app/api/auth/oidc/login/route.ts +43 -0
- package/src/app/api/connections/managed/route.ts +35 -0
- package/src/app/api/db/cancel/route.ts +42 -0
- package/src/app/api/db/disconnect/route.ts +28 -0
- package/src/app/api/db/health/route.ts +49 -0
- package/src/app/api/db/maintenance/route.ts +72 -0
- package/src/app/api/db/monitoring/route.ts +62 -0
- package/src/app/api/db/multi-query/route.ts +116 -0
- package/src/app/api/db/pool-stats/route.ts +37 -0
- package/src/app/api/db/profile/route.ts +144 -0
- package/src/app/api/db/provider-meta/route.ts +49 -0
- package/src/app/api/db/query/route.ts +50 -0
- package/src/app/api/db/schema/route.ts +47 -0
- package/src/app/api/db/schema-snapshot/route.ts +42 -0
- package/src/app/api/db/test-connection/route.ts +55 -0
- package/src/app/api/db/transaction/route.ts +111 -0
- package/src/app/api/storage/[collection]/route.ts +67 -0
- package/src/app/api/storage/config/route.ts +17 -0
- package/src/app/api/storage/migrate/route.ts +45 -0
- package/src/app/api/storage/route.ts +32 -0
- package/src/app/error.tsx +49 -0
- package/src/app/global-error.tsx +55 -0
- package/src/app/globals.css +146 -0
- package/src/app/icon.svg +42 -0
- package/src/app/layout.tsx +34 -0
- package/src/app/login/login-form.tsx +301 -0
- package/src/app/login/page.tsx +11 -0
- package/src/app/monitoring/page.tsx +8 -0
- package/src/app/not-found.tsx +29 -0
- package/src/app/page.tsx +5 -0
- package/src/components/AIAutopilotPanel.tsx +238 -0
- package/src/components/CodeGenerator.tsx +271 -0
- package/src/components/CommandPalette.tsx +227 -0
- package/src/components/ConnectionModal.tsx +759 -0
- package/src/components/CreateTableModal.tsx +281 -0
- package/src/components/DataCharts.tsx +962 -0
- package/src/components/DataImportModal.tsx +582 -0
- package/src/components/DataProfiler.tsx +335 -0
- package/src/components/DatabaseDocs.tsx +251 -0
- package/src/components/MaskingSettings.tsx +414 -0
- package/src/components/MobileNav.tsx +50 -0
- package/src/components/NL2SQLPanel.tsx +281 -0
- package/src/components/PivotTable.tsx +257 -0
- package/src/components/QueryEditor.tsx +760 -0
- package/src/components/QueryHistory.tsx +344 -0
- package/src/components/QuerySafetyDialog.tsx +290 -0
- package/src/components/ResultsGrid.tsx +644 -0
- package/src/components/SaveQueryModal.tsx +104 -0
- package/src/components/SavedQueries.tsx +128 -0
- package/src/components/SchemaDiagram.tsx +473 -0
- package/src/components/SchemaDiff.tsx +473 -0
- package/src/components/SnapshotTimeline.tsx +116 -0
- package/src/components/Studio.tsx +639 -0
- package/src/components/TestDataGenerator.tsx +261 -0
- package/src/components/VisualExplain.tsx +820 -0
- package/src/components/admin/AdminDashboard.tsx +163 -0
- package/src/components/admin/tabs/AuditTab.tsx +531 -0
- package/src/components/admin/tabs/MonitoringEmbed.tsx +11 -0
- package/src/components/admin/tabs/OperationsTab.tsx +646 -0
- package/src/components/admin/tabs/OverviewTab.tsx +1328 -0
- package/src/components/admin/tabs/SecurityTab.tsx +284 -0
- package/src/components/community-section.tsx +92 -0
- package/src/components/icons/db-icons.tsx +84 -0
- package/src/components/libredb-logo.tsx +61 -0
- package/src/components/monitoring/MonitoringDashboard.tsx +345 -0
- package/src/components/monitoring/tabs/MetricChart.tsx +82 -0
- package/src/components/monitoring/tabs/OverviewTab.tsx +263 -0
- package/src/components/monitoring/tabs/PerformanceTab.tsx +254 -0
- package/src/components/monitoring/tabs/PoolTab.tsx +174 -0
- package/src/components/monitoring/tabs/QueriesTab.tsx +287 -0
- package/src/components/monitoring/tabs/SessionsTab.tsx +316 -0
- package/src/components/monitoring/tabs/StorageTab.tsx +335 -0
- package/src/components/monitoring/tabs/TablesTab.tsx +300 -0
- package/src/components/results-grid/ResultCard.tsx +111 -0
- package/src/components/results-grid/RowDetailSheet.tsx +178 -0
- package/src/components/results-grid/StatsBar.tsx +201 -0
- package/src/components/results-grid/index.ts +1 -0
- package/src/components/results-grid/utils.ts +23 -0
- package/src/components/schema-explorer/ColumnList.tsx +53 -0
- package/src/components/schema-explorer/SchemaExplorer.tsx +182 -0
- package/src/components/schema-explorer/TableItem.tsx +210 -0
- package/src/components/schema-explorer/index.ts +1 -0
- package/src/components/sidebar/ConnectionItem.tsx +105 -0
- package/src/components/sidebar/ConnectionsList.tsx +62 -0
- package/src/components/sidebar/Sidebar.tsx +130 -0
- package/src/components/sidebar/index.ts +2 -0
- package/src/components/studio/BottomPanel.tsx +286 -0
- package/src/components/studio/QueryToolbar.tsx +180 -0
- package/src/components/studio/StudioDesktopHeader.tsx +114 -0
- package/src/components/studio/StudioMobileHeader.tsx +340 -0
- package/src/components/studio/StudioTabBar.tsx +82 -0
- package/src/components/studio/index.ts +5 -0
- package/src/components/ui/accordion.tsx +66 -0
- package/src/components/ui/alert-dialog.tsx +157 -0
- package/src/components/ui/alert.tsx +66 -0
- package/src/components/ui/aspect-ratio.tsx +11 -0
- package/src/components/ui/avatar.tsx +53 -0
- package/src/components/ui/badge.tsx +46 -0
- package/src/components/ui/breadcrumb.tsx +109 -0
- package/src/components/ui/button-group.tsx +83 -0
- package/src/components/ui/button.tsx +60 -0
- package/src/components/ui/calendar.tsx +216 -0
- package/src/components/ui/card.tsx +92 -0
- package/src/components/ui/carousel.tsx +241 -0
- package/src/components/ui/chart.tsx +357 -0
- package/src/components/ui/checkbox.tsx +32 -0
- package/src/components/ui/collapsible.tsx +33 -0
- package/src/components/ui/command.tsx +184 -0
- package/src/components/ui/context-menu.tsx +252 -0
- package/src/components/ui/dialog.tsx +143 -0
- package/src/components/ui/drawer.tsx +135 -0
- package/src/components/ui/dropdown-menu.tsx +257 -0
- package/src/components/ui/empty.tsx +104 -0
- package/src/components/ui/field.tsx +248 -0
- package/src/components/ui/form.tsx +167 -0
- package/src/components/ui/hover-card.tsx +44 -0
- package/src/components/ui/input-group.tsx +170 -0
- package/src/components/ui/input-otp.tsx +77 -0
- package/src/components/ui/input.tsx +21 -0
- package/src/components/ui/item.tsx +193 -0
- package/src/components/ui/kbd.tsx +28 -0
- package/src/components/ui/label.tsx +24 -0
- package/src/components/ui/menubar.tsx +276 -0
- package/src/components/ui/navigation-menu.tsx +168 -0
- package/src/components/ui/pagination.tsx +127 -0
- package/src/components/ui/popover.tsx +48 -0
- package/src/components/ui/progress.tsx +31 -0
- package/src/components/ui/radio-group.tsx +45 -0
- package/src/components/ui/resizable.tsx +56 -0
- package/src/components/ui/scroll-area.tsx +58 -0
- package/src/components/ui/select.tsx +187 -0
- package/src/components/ui/separator.tsx +28 -0
- package/src/components/ui/sheet.tsx +139 -0
- package/src/components/ui/sidebar.tsx +726 -0
- package/src/components/ui/skeleton.tsx +13 -0
- package/src/components/ui/slider.tsx +63 -0
- package/src/components/ui/sonner.tsx +40 -0
- package/src/components/ui/spinner.tsx +16 -0
- package/src/components/ui/switch.tsx +31 -0
- package/src/components/ui/table.tsx +116 -0
- package/src/components/ui/tabs.tsx +66 -0
- package/src/components/ui/textarea.tsx +18 -0
- package/src/components/ui/toggle-group.tsx +83 -0
- package/src/components/ui/toggle.tsx +47 -0
- package/src/components/ui/tooltip.tsx +61 -0
- package/src/exports/components.ts +15 -0
- package/src/exports/index.ts +4 -0
- package/src/exports/providers.ts +4 -0
- package/src/exports/types.ts +26 -0
- package/src/hooks/use-ai-chat.ts +182 -0
- package/src/hooks/use-all-connections.ts +66 -0
- package/src/hooks/use-api-call.ts +71 -0
- package/src/hooks/use-auth.ts +51 -0
- package/src/hooks/use-connection-form.ts +349 -0
- package/src/hooks/use-connection-manager.ts +169 -0
- package/src/hooks/use-connection-payload.ts +15 -0
- package/src/hooks/use-inline-editing.ts +109 -0
- package/src/hooks/use-mobile.ts +20 -0
- package/src/hooks/use-monitoring-data.ts +270 -0
- package/src/hooks/use-provider-metadata.ts +62 -0
- package/src/hooks/use-query-execution.ts +478 -0
- package/src/hooks/use-storage-sync.ts +259 -0
- package/src/hooks/use-tab-manager.ts +231 -0
- package/src/hooks/use-toast.ts +20 -0
- package/src/hooks/use-transaction-control.ts +64 -0
- package/src/lib/api/error-codes.ts +30 -0
- package/src/lib/api/errors.ts +236 -0
- package/src/lib/api/with-error-handler.ts +41 -0
- package/src/lib/audit.ts +105 -0
- package/src/lib/auth.ts +87 -0
- package/src/lib/connection-string-parser.ts +172 -0
- package/src/lib/data-masking.ts +385 -0
- package/src/lib/db/base-provider.ts +325 -0
- package/src/lib/db/errors.ts +317 -0
- package/src/lib/db/factory.ts +324 -0
- package/src/lib/db/index.ts +123 -0
- package/src/lib/db/providers/document/index.ts +6 -0
- package/src/lib/db/providers/document/mongodb.ts +992 -0
- package/src/lib/db/providers/keyvalue/redis.ts +554 -0
- package/src/lib/db/providers/sql/index.ts +11 -0
- package/src/lib/db/providers/sql/mssql.ts +1065 -0
- package/src/lib/db/providers/sql/mysql.ts +978 -0
- package/src/lib/db/providers/sql/oracle.ts +1044 -0
- package/src/lib/db/providers/sql/postgres.ts +1179 -0
- package/src/lib/db/providers/sql/sql-base.ts +174 -0
- package/src/lib/db/providers/sql/sqlite.ts +721 -0
- package/src/lib/db/types.ts +437 -0
- package/src/lib/db/utils/pool-manager.ts +287 -0
- package/src/lib/db/utils/query-limiter.ts +239 -0
- package/src/lib/db-ui-config.ts +86 -0
- package/src/lib/editor/mongodb-completions.ts +172 -0
- package/src/lib/editor/sql-completions.ts +280 -0
- package/src/lib/llm/base-provider.ts +117 -0
- package/src/lib/llm/factory.ts +102 -0
- package/src/lib/llm/index.ts +90 -0
- package/src/lib/llm/providers/custom.ts +181 -0
- package/src/lib/llm/providers/gemini.ts +126 -0
- package/src/lib/llm/providers/ollama.ts +154 -0
- package/src/lib/llm/providers/openai.ts +146 -0
- package/src/lib/llm/types.ts +173 -0
- package/src/lib/llm/utils/config.ts +187 -0
- package/src/lib/llm/utils/retry.ts +119 -0
- package/src/lib/llm/utils/streaming.ts +202 -0
- package/src/lib/logger.ts +127 -0
- package/src/lib/monitoring-thresholds.ts +44 -0
- package/src/lib/oidc.ts +262 -0
- package/src/lib/query-generators.ts +61 -0
- package/src/lib/schema-diff/diff-engine.ts +273 -0
- package/src/lib/schema-diff/migration-generator.ts +208 -0
- package/src/lib/schema-diff/types.ts +55 -0
- package/src/lib/seed/config-loader.ts +79 -0
- package/src/lib/seed/connection-filter.ts +49 -0
- package/src/lib/seed/credential-resolver.ts +62 -0
- package/src/lib/seed/index.ts +40 -0
- package/src/lib/seed/resolve-connection.ts +57 -0
- package/src/lib/seed/types.ts +69 -0
- package/src/lib/sql/alias-extractor.ts +267 -0
- package/src/lib/sql/index.ts +8 -0
- package/src/lib/sql/statement-splitter.ts +167 -0
- package/src/lib/sql/types.ts +40 -0
- package/src/lib/ssh/tunnel.ts +142 -0
- package/src/lib/storage/factory.ts +84 -0
- package/src/lib/storage/index.ts +14 -0
- package/src/lib/storage/local-storage.ts +99 -0
- package/src/lib/storage/providers/postgres.ts +225 -0
- package/src/lib/storage/providers/sqlite.ts +153 -0
- package/src/lib/storage/storage-facade.ts +272 -0
- package/src/lib/storage/types.ts +75 -0
- package/src/lib/time-series-buffer.ts +58 -0
- package/src/lib/types.ts +173 -0
- package/src/lib/utils.ts +6 -0
- package/src/proxy.ts +104 -0
- package/src/types/db-drivers.d.ts +23 -0
- package/src/types/html2canvas.d.ts +9 -0
- package/tests/api/admin/audit.test.ts +178 -0
- package/tests/api/admin/fleet-health.test.ts +183 -0
- package/tests/api/ai/autopilot.test.ts +174 -0
- package/tests/api/ai/chat.test.ts +250 -0
- package/tests/api/ai/describe-schema.test.ts +266 -0
- package/tests/api/ai/explain.test.ts +199 -0
- package/tests/api/ai/impact.test.ts +168 -0
- package/tests/api/ai/index-advisor.test.ts +171 -0
- package/tests/api/ai/nl2sql.test.ts +202 -0
- package/tests/api/ai/query-safety.test.ts +196 -0
- package/tests/api/auth/login.test.ts +170 -0
- package/tests/api/auth/logout.test.ts +140 -0
- package/tests/api/auth/me.test.ts +73 -0
- package/tests/api/auth/oidc-callback.test.ts +215 -0
- package/tests/api/auth/oidc-login.test.ts +127 -0
- package/tests/api/db/cancel.test.ts +198 -0
- package/tests/api/db/disconnect.test.ts +124 -0
- package/tests/api/db/health.test.ts +222 -0
- package/tests/api/db/maintenance.test.ts +263 -0
- package/tests/api/db/monitoring.test.ts +221 -0
- package/tests/api/db/multi-query.test.ts +316 -0
- package/tests/api/db/pool-stats.test.ts +135 -0
- package/tests/api/db/profile.test.ts +330 -0
- package/tests/api/db/provider-meta.test.ts +193 -0
- package/tests/api/db/query.test.ts +314 -0
- package/tests/api/db/schema-snapshot.test.ts +170 -0
- package/tests/api/db/schema.test.ts +191 -0
- package/tests/api/db/test-connection.test.ts +185 -0
- package/tests/api/db/transaction.test.ts +314 -0
- package/tests/api/proxy.test.ts +191 -0
- package/tests/api/seed/managed-route.test.ts +113 -0
- package/tests/api/storage/config.test.ts +42 -0
- package/tests/api/storage/storage-routes.test.ts +309 -0
- package/tests/components/AIAutopilotPanel.test.tsx +756 -0
- package/tests/components/AdminPage.test.tsx +33 -0
- package/tests/components/CodeGenerator.test.tsx +182 -0
- package/tests/components/CommandPalette.test.tsx +428 -0
- package/tests/components/CommunitySection.test.tsx +91 -0
- package/tests/components/ConnectionModal.mobile.test.tsx +284 -0
- package/tests/components/ConnectionModal.test.tsx +570 -0
- package/tests/components/CreateTableModal.test.tsx +383 -0
- package/tests/components/DataCharts.test.tsx +739 -0
- package/tests/components/DataImportModal.test.tsx +751 -0
- package/tests/components/DataProfiler.test.tsx +589 -0
- package/tests/components/DatabaseDocs.test.tsx +353 -0
- package/tests/components/LoginPage.test.tsx +163 -0
- package/tests/components/LoginPageOIDC.test.tsx +92 -0
- package/tests/components/MaskingSettings.test.tsx +498 -0
- package/tests/components/MobileNav.test.tsx +30 -0
- package/tests/components/MonitoringPage.test.tsx +32 -0
- package/tests/components/NL2SQLPanel.test.tsx +621 -0
- package/tests/components/Page.test.tsx +33 -0
- package/tests/components/PivotTable.test.tsx +350 -0
- package/tests/components/QueryEditor.test.tsx +1730 -0
- package/tests/components/QueryHistory.test.tsx +572 -0
- package/tests/components/QuerySafetyDialog.test.tsx +586 -0
- package/tests/components/ResultsGrid.test.tsx +804 -0
- package/tests/components/RootLayout.test.tsx +83 -0
- package/tests/components/SaveQueryModal.test.tsx +25 -0
- package/tests/components/SavedQueries.test.tsx +43 -0
- package/tests/components/SchemaDiagram.test.tsx +1034 -0
- package/tests/components/SchemaDiff.test.tsx +906 -0
- package/tests/components/SnapshotTimeline.test.tsx +174 -0
- package/tests/components/Studio.test.tsx +1030 -0
- package/tests/components/TestDataGenerator.test.tsx +291 -0
- package/tests/components/VisualExplain.test.tsx +704 -0
- package/tests/components/admin/AdminDashboard.test.tsx +205 -0
- package/tests/components/admin/AuditTab.test.tsx +220 -0
- package/tests/components/admin/MonitoringEmbed.test.tsx +58 -0
- package/tests/components/admin/OperationsTab.test.tsx +975 -0
- package/tests/components/admin/OverviewTab.test.tsx +254 -0
- package/tests/components/admin/SecurityTab.test.tsx +467 -0
- package/tests/components/monitoring/MetricChart.test.tsx +111 -0
- package/tests/components/monitoring/MonitoringDashboard.test.tsx +259 -0
- package/tests/components/monitoring/OverviewTab.test.tsx +78 -0
- package/tests/components/monitoring/PerformanceTab.test.tsx +87 -0
- package/tests/components/monitoring/PoolTab.test.tsx +42 -0
- package/tests/components/monitoring/QueriesTab.test.tsx +80 -0
- package/tests/components/monitoring/SessionsTab.test.tsx +154 -0
- package/tests/components/monitoring/StorageTab.test.tsx +127 -0
- package/tests/components/monitoring/TablesTab.test.tsx +153 -0
- package/tests/components/results-grid/ResultCard.test.tsx +105 -0
- package/tests/components/results-grid/RowDetailSheet.test.tsx +308 -0
- package/tests/components/results-grid/StatsBar.test.tsx +162 -0
- package/tests/components/schema-explorer/ColumnList.test.tsx +151 -0
- package/tests/components/schema-explorer/SchemaExplorer.test.tsx +461 -0
- package/tests/components/schema-explorer/TableItem.test.tsx +415 -0
- package/tests/components/sidebar/ConnectionItem.test.tsx +201 -0
- package/tests/components/sidebar/ConnectionsList.test.tsx +176 -0
- package/tests/components/sidebar/Sidebar.test.tsx +187 -0
- package/tests/components/studio/BottomPanel.test.tsx +383 -0
- package/tests/components/studio/QueryToolbar.test.tsx +321 -0
- package/tests/components/studio/StudioDesktopHeader.test.tsx +377 -0
- package/tests/components/studio/StudioMobileHeader.test.tsx +198 -0
- package/tests/components/studio/StudioTabBar.test.tsx +331 -0
- package/tests/fixtures/connections.ts +96 -0
- package/tests/fixtures/masking-configs.ts +86 -0
- package/tests/fixtures/query-results.ts +71 -0
- package/tests/fixtures/schemas.ts +64 -0
- package/tests/fixtures/seed-connections/invalid-config.yaml +7 -0
- package/tests/fixtures/seed-connections/minimal-config.yaml +8 -0
- package/tests/fixtures/seed-connections/mixed-credentials.yaml +23 -0
- package/tests/fixtures/seed-connections/multi-role-config.yaml +30 -0
- package/tests/fixtures/seed-connections/valid-config.json +15 -0
- package/tests/fixtures/seed-connections/valid-config.yaml +51 -0
- package/tests/helpers/mock-fetch.ts +59 -0
- package/tests/helpers/mock-monaco.ts +112 -0
- package/tests/helpers/mock-navigation.ts +28 -0
- package/tests/helpers/mock-next.ts +80 -0
- package/tests/helpers/mock-provider.ts +133 -0
- package/tests/helpers/mock-sonner.ts +29 -0
- package/tests/helpers/render-with-providers.tsx +19 -0
- package/tests/hooks/use-ai-chat.test.ts +600 -0
- package/tests/hooks/use-auth.test.ts +371 -0
- package/tests/hooks/use-connection-form.test.ts +743 -0
- package/tests/hooks/use-connection-manager.test.ts +466 -0
- package/tests/hooks/use-inline-editing.test.ts +321 -0
- package/tests/hooks/use-mobile.test.ts +177 -0
- package/tests/hooks/use-monitoring-data.test.ts +819 -0
- package/tests/hooks/use-provider-metadata.test.ts +228 -0
- package/tests/hooks/use-query-execution.test.ts +1212 -0
- package/tests/hooks/use-tab-manager.test.ts +756 -0
- package/tests/hooks/use-toast.test.ts +74 -0
- package/tests/hooks/use-transaction-control.test.ts +211 -0
- package/tests/integration/db/mongodb-provider.test.ts +698 -0
- package/tests/integration/db/mssql-provider.test.ts +840 -0
- package/tests/integration/db/mysql-provider.test.ts +872 -0
- package/tests/integration/db/oracle-provider.test.ts +843 -0
- package/tests/integration/db/postgres-provider.test.ts +1382 -0
- package/tests/integration/db/redis-provider.test.ts +526 -0
- package/tests/integration/db/sqlite-provider.test.ts +480 -0
- package/tests/integration/seed/seed-pipeline.test.ts +102 -0
- package/tests/isolated/factory-singleton.test.ts +150 -0
- package/tests/isolated/use-storage-sync.test.ts +389 -0
- package/tests/run-components.sh +196 -0
- package/tests/setup-dom.ts +58 -0
- package/tests/setup.ts +40 -0
- package/tests/unit/api-errors.test.ts +210 -0
- package/tests/unit/code-generator-functions.test.ts +271 -0
- package/tests/unit/components/column-list.test.tsx +190 -0
- package/tests/unit/components/data-import-modal.test.tsx +441 -0
- package/tests/unit/components/studio-mobile-header.test.tsx +327 -0
- package/tests/unit/data-charts-functions.test.ts +496 -0
- package/tests/unit/data-import-functions.test.ts +320 -0
- package/tests/unit/data-import-utils.test.ts +125 -0
- package/tests/unit/db/base-provider.test.ts +517 -0
- package/tests/unit/db/errors.test.ts +403 -0
- package/tests/unit/db/factory.test.ts +436 -0
- package/tests/unit/db/pool-manager.test.ts +440 -0
- package/tests/unit/db/query-limiter.test.ts +387 -0
- package/tests/unit/db/sql-base.test.ts +438 -0
- package/tests/unit/lib/api/error-codes.test.ts +39 -0
- package/tests/unit/lib/audit.test.ts +326 -0
- package/tests/unit/lib/auth.test.ts +146 -0
- package/tests/unit/lib/connection-string-parser.test.ts +424 -0
- package/tests/unit/lib/data-masking.test.ts +583 -0
- package/tests/unit/lib/db-icons.test.tsx +41 -0
- package/tests/unit/lib/monitoring-thresholds.test.ts +133 -0
- package/tests/unit/lib/oidc.test.ts +509 -0
- package/tests/unit/lib/query-generators.test.ts +127 -0
- package/tests/unit/lib/storage/factory.test.ts +71 -0
- package/tests/unit/lib/storage/local-storage.test.ts +114 -0
- package/tests/unit/lib/storage/providers/postgres.test.ts +312 -0
- package/tests/unit/lib/storage/providers/sqlite.test.ts +232 -0
- package/tests/unit/lib/storage/storage-facade-extended.test.ts +331 -0
- package/tests/unit/lib/storage/storage-facade.test.ts +184 -0
- package/tests/unit/lib/storage.test.ts +317 -0
- package/tests/unit/lib/time-series-buffer.test.ts +212 -0
- package/tests/unit/lib/utils.test.ts +24 -0
- package/tests/unit/llm/base-provider.test.ts +238 -0
- package/tests/unit/llm/config.test.ts +262 -0
- package/tests/unit/llm/custom-provider.test.ts +281 -0
- package/tests/unit/llm/gemini-provider.test.ts +248 -0
- package/tests/unit/llm/llm-factory.test.ts +155 -0
- package/tests/unit/llm/ollama-provider.test.ts +288 -0
- package/tests/unit/llm/openai-provider.test.ts +324 -0
- package/tests/unit/llm/retry.test.ts +180 -0
- package/tests/unit/llm/streaming.test.ts +355 -0
- package/tests/unit/logger.test.ts +198 -0
- package/tests/unit/mongodb-completions.test.ts +516 -0
- package/tests/unit/pivot-table-functions.test.ts +76 -0
- package/tests/unit/query-cancelled-error.test.ts +81 -0
- package/tests/unit/schema-diff/diff-engine.test.ts +367 -0
- package/tests/unit/schema-diff/migration-generator.test.ts +513 -0
- package/tests/unit/seed/config-loader.test.ts +73 -0
- package/tests/unit/seed/connection-filter.test.ts +91 -0
- package/tests/unit/seed/credential-resolver.test.ts +85 -0
- package/tests/unit/seed/index.test.ts +72 -0
- package/tests/unit/seed/resolve-connection.test.ts +74 -0
- package/tests/unit/seed/types.test.ts +129 -0
- package/tests/unit/sql/alias-extractor.test.ts +444 -0
- package/tests/unit/sql/statement-splitter.test.ts +348 -0
- package/tests/unit/sql-completions.test.ts +463 -0
- package/tests/unit/ssh-tunnel.test.ts +465 -0
- package/tsconfig.json +42 -0
package/CLAUDE.md
ADDED
|
@@ -0,0 +1,265 @@
|
|
|
1
|
+
# CLAUDE.md
|
|
2
|
+
|
|
3
|
+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
4
|
+
|
|
5
|
+
## Project Overview
|
|
6
|
+
|
|
7
|
+
LibreDB Studio is a web-based SQL IDE for cloud-native teams. It supports PostgreSQL, MySQL, SQLite, Oracle, SQL Server, MongoDB, Redis with AI-powered query assistance.
|
|
8
|
+
|
|
9
|
+
## Github
|
|
10
|
+
* Repository: https://github.com/libredb/libredb-studio
|
|
11
|
+
* Container Registry: https://github.com/libredb/libredb-studio/pkgs/container/libredb-studio
|
|
12
|
+
* Docker Image: ghcr.io/libredb/libredb-studio:latest
|
|
13
|
+
* Helm Chart: https://artifacthub.io/packages/helm/libredb-studio/libredb-studio
|
|
14
|
+
* Helm Repo: https://libredb.org/libredb-studio/
|
|
15
|
+
* Helm OCI: oci://ghcr.io/libredb/charts/libredb-studio
|
|
16
|
+
|
|
17
|
+
## Development Commands
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
# Install dependencies (Bun preferred)
|
|
21
|
+
bun install
|
|
22
|
+
|
|
23
|
+
# Development server with Turbopack
|
|
24
|
+
bun dev
|
|
25
|
+
|
|
26
|
+
# Production build
|
|
27
|
+
bun run build
|
|
28
|
+
|
|
29
|
+
# Start production server
|
|
30
|
+
bun start
|
|
31
|
+
|
|
32
|
+
# Lint code
|
|
33
|
+
bun run lint
|
|
34
|
+
|
|
35
|
+
# Run all tests (unit + API + integration + hooks + components)
|
|
36
|
+
bun run test
|
|
37
|
+
|
|
38
|
+
# Run individual test layers
|
|
39
|
+
bun run test:unit
|
|
40
|
+
bun run test:api
|
|
41
|
+
bun run test:integration
|
|
42
|
+
bun run test:hooks
|
|
43
|
+
bun run test:components
|
|
44
|
+
|
|
45
|
+
# E2E tests (Playwright, requires build)
|
|
46
|
+
bun run test:e2e
|
|
47
|
+
|
|
48
|
+
# Coverage report
|
|
49
|
+
bun run test:coverage
|
|
50
|
+
|
|
51
|
+
# Docker development
|
|
52
|
+
docker-compose up -d
|
|
53
|
+
|
|
54
|
+
# Helm chart
|
|
55
|
+
helm lint charts/libredb-studio --strict
|
|
56
|
+
helm template test charts/libredb-studio --set secrets.jwtSecret=test-secret-32-chars-minimum-here --set secrets.adminPassword=test123 --set secrets.userPassword=test123
|
|
57
|
+
helm dependency build charts/libredb-studio
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
The project uses ESLint 9 for linting and `bun:test` for testing with `@testing-library/react` + `happy-dom` for component tests and Playwright for E2E tests.
|
|
61
|
+
|
|
62
|
+
> **Important**: Always use `bun run test` instead of bare `bun test`. Component tests require isolated execution groups (handled by `tests/run-components.sh`) to prevent `mock.module()` cross-contamination between test files.
|
|
63
|
+
|
|
64
|
+
## Architecture
|
|
65
|
+
|
|
66
|
+
### Tech Stack
|
|
67
|
+
- **Framework:** Next.js 16 (App Router) with React 19 and TypeScript
|
|
68
|
+
- **Styling:** Tailwind CSS 4 with Shadcn/UI components
|
|
69
|
+
- **SQL Editor:** Monaco Editor
|
|
70
|
+
- **Data Grid:** TanStack React Table with react-virtual for virtualization
|
|
71
|
+
- **AI:** Multi-model support (Gemini, OpenAI, Ollama, Custom)
|
|
72
|
+
- **Databases:** PostgreSQL (`pg`), MySQL (`mysql2`), SQLite (`better-sqlite3`), Oracle (`oracledb`), SQL Server (`mssql`), MongoDB (`mongodb`), Redis (`ioredis`)
|
|
73
|
+
- **Auth:** JWT-based with `jose` library + OIDC SSO with `openid-client` (Auth0, Keycloak, Okta, Azure AD)
|
|
74
|
+
- **Storage:** Pluggable storage layer — localStorage (default), SQLite (`better-sqlite3`), or PostgreSQL (`pg`)
|
|
75
|
+
|
|
76
|
+
### Directory Structure
|
|
77
|
+
|
|
78
|
+
```
|
|
79
|
+
src/
|
|
80
|
+
├── app/ # Next.js App Router
|
|
81
|
+
│ ├── api/
|
|
82
|
+
│ │ ├── auth/ # Login/logout/me endpoints
|
|
83
|
+
│ │ │ └── oidc/ # OIDC login + callback routes (PKCE, code exchange)
|
|
84
|
+
│ │ ├── ai/ # AI endpoints (chat, nl2sql, explain, safety)
|
|
85
|
+
│ │ ├── db/ # Query, schema, health, maintenance, transactions
|
|
86
|
+
│ │ ├── storage/ # Storage sync API (config, CRUD, migrate)
|
|
87
|
+
│ │ └── admin/ # Fleet health, audit endpoints
|
|
88
|
+
│ ├── admin/ # Admin dashboard (RBAC protected)
|
|
89
|
+
│ └── login/ # Login page
|
|
90
|
+
├── components/ # React components
|
|
91
|
+
│ ├── Studio.tsx # Main application shell
|
|
92
|
+
│ ├── QueryEditor.tsx # Monaco SQL editor wrapper
|
|
93
|
+
│ ├── ResultsGrid.tsx # Virtualized data grid
|
|
94
|
+
│ ├── sidebar/ # Sidebar, ConnectionsList, ConnectionItem
|
|
95
|
+
│ ├── studio/ # StudioTabBar, QueryToolbar, BottomPanel
|
|
96
|
+
│ ├── admin/ # AdminDashboard, tabs (Overview, Operations, etc.)
|
|
97
|
+
│ ├── schema-explorer/ # SchemaExplorer component
|
|
98
|
+
│ └── ui/ # Shadcn/UI primitives
|
|
99
|
+
├── hooks/ # Custom React hooks
|
|
100
|
+
└── lib/
|
|
101
|
+
├── storage/ # Storage abstraction layer
|
|
102
|
+
│ ├── index.ts # Barrel export
|
|
103
|
+
│ ├── types.ts # StorageData, ServerStorageProvider interfaces
|
|
104
|
+
│ ├── storage-facade.ts # Public sync API + CustomEvent dispatch
|
|
105
|
+
│ ├── local-storage.ts # Pure localStorage CRUD
|
|
106
|
+
│ ├── factory.ts # Env-based provider factory (singleton)
|
|
107
|
+
│ └── providers/
|
|
108
|
+
│ ├── sqlite.ts # better-sqlite3 backend
|
|
109
|
+
│ └── postgres.ts # pg backend
|
|
110
|
+
├── db/ # Database provider module (Strategy Pattern)
|
|
111
|
+
│ ├── providers/
|
|
112
|
+
│ │ ├── sql/ # SQL providers (postgres, mysql, sqlite, oracle, mssql)
|
|
113
|
+
│ │ ├── document/ # Document providers (mongodb)
|
|
114
|
+
│ │ ├── keyvalue/ # Key-value providers (redis)
|
|
115
|
+
│ ├── factory.ts # Provider factory
|
|
116
|
+
│ ├── types.ts # Database types
|
|
117
|
+
│ └── errors.ts # Custom error classes
|
|
118
|
+
├── llm/ # LLM provider module (Strategy Pattern)
|
|
119
|
+
├── schema-diff/ # Schema diff engine + migration SQL generator
|
|
120
|
+
├── sql/ # SQL statement splitter, alias extractor
|
|
121
|
+
├── types.ts # TypeScript type definitions
|
|
122
|
+
├── auth.ts # JWT auth utilities (login, logout, signJWT, verifyJWT)
|
|
123
|
+
├── oidc.ts # OIDC utilities (discovery, PKCE, token exchange, role mapping, logout)
|
|
124
|
+
└── storage.ts # LocalStorage management
|
|
125
|
+
|
|
126
|
+
tests/
|
|
127
|
+
├── setup.ts # Global test setup (env vars, localStorage mock)
|
|
128
|
+
├── setup-dom.ts # DOM environment setup (happy-dom)
|
|
129
|
+
├── run-components.sh # Component test isolation runner
|
|
130
|
+
├── fixtures/ # Mock data (connections, schemas, query results)
|
|
131
|
+
├── helpers/ # Test utilities (mock providers, mock Monaco, etc.)
|
|
132
|
+
├── unit/ # Pure function tests
|
|
133
|
+
├── api/ # API route handler tests
|
|
134
|
+
├── integration/ # Database provider tests (mocked drivers)
|
|
135
|
+
├── hooks/ # React hook tests
|
|
136
|
+
└── components/ # Component tests (happy-dom)
|
|
137
|
+
|
|
138
|
+
e2e/ # Playwright E2E tests (browser)
|
|
139
|
+
|
|
140
|
+
charts/
|
|
141
|
+
└── libredb-studio/ # Helm chart for Kubernetes deployment
|
|
142
|
+
├── Chart.yaml # Chart metadata + ArtifactHub annotations
|
|
143
|
+
├── values.yaml # Default configuration
|
|
144
|
+
├── values.schema.json # JSON Schema validation
|
|
145
|
+
└── templates/ # K8s manifests (deployment, service, ingress, etc.)
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Key Patterns
|
|
149
|
+
|
|
150
|
+
1. **Database Abstraction:** `src/lib/db/` module provides Strategy Pattern implementation for multiple database types:
|
|
151
|
+
- **SQL:** PostgreSQL, MySQL, SQLite, Oracle, SQL Server (extend `SQLBaseProvider`)
|
|
152
|
+
- **Document:** MongoDB (extends `BaseDatabaseProvider`)
|
|
153
|
+
- **Key-Value:** Redis (extends `BaseDatabaseProvider`)
|
|
154
|
+
|
|
155
|
+
2. **LLM Abstraction:** `src/lib/llm/` module provides Strategy Pattern for AI providers (Gemini, OpenAI, Ollama, Custom)
|
|
156
|
+
|
|
157
|
+
3. **Authentication Flow:** Supports two modes controlled by `NEXT_PUBLIC_AUTH_PROVIDER`:
|
|
158
|
+
- **Local** (default): Email/password login → JWT session cookie
|
|
159
|
+
- **OIDC**: SSO redirect → PKCE code exchange → local JWT session cookie (same as local)
|
|
160
|
+
|
|
161
|
+
JWT tokens stored in HTTP-only cookies. Proxy (`src/proxy.ts`) protects routes and enforces RBAC (admin vs user roles). OIDC module (`src/lib/oidc.ts`) handles discovery, PKCE, token exchange, role mapping, and provider logout.
|
|
162
|
+
|
|
163
|
+
4. **API Routes:** All backend logic in `src/app/api/`. Protected routes require valid JWT. Public routes: `/login`, `/api/auth`, `/api/db/health`
|
|
164
|
+
|
|
165
|
+
5. **Storage Abstraction:** `src/lib/storage/` module provides pluggable persistence:
|
|
166
|
+
- **Local** (default): Browser localStorage, zero config
|
|
167
|
+
- **SQLite**: `better-sqlite3` file DB for single-node persistent storage
|
|
168
|
+
- **PostgreSQL**: `pg` for multi-node enterprise storage
|
|
169
|
+
- Write-through cache: localStorage always serves reads; `useStorageSync` hook pushes mutations to server (debounced)
|
|
170
|
+
- Controlled by `STORAGE_PROVIDER` env var (server-side only, discovered at runtime via `/api/storage/config`)
|
|
171
|
+
|
|
172
|
+
6. **Multi-Tab Workspace:** Each query tab has independent state (query, results, execution status)
|
|
173
|
+
|
|
174
|
+
### Environment Variables
|
|
175
|
+
|
|
176
|
+
Required in `.env.local`:
|
|
177
|
+
```
|
|
178
|
+
# Authentication (local mode)
|
|
179
|
+
ADMIN_EMAIL=admin@libredb.org # Admin email
|
|
180
|
+
ADMIN_PASSWORD=<password> # Admin password
|
|
181
|
+
USER_EMAIL=user@libredb.org # User email
|
|
182
|
+
USER_PASSWORD=<password> # User password
|
|
183
|
+
JWT_SECRET=<32+ chars> # JWT signing secret
|
|
184
|
+
|
|
185
|
+
# Auth provider: "local" (default) or "oidc"
|
|
186
|
+
NEXT_PUBLIC_AUTH_PROVIDER=local
|
|
187
|
+
|
|
188
|
+
# OIDC config (required when provider=oidc)
|
|
189
|
+
OIDC_ISSUER=<issuer-url> # e.g. https://dev-xxx.auth0.com
|
|
190
|
+
OIDC_CLIENT_ID=<client-id>
|
|
191
|
+
OIDC_CLIENT_SECRET=<secret>
|
|
192
|
+
OIDC_SCOPE=openid profile email # Optional, defaults shown
|
|
193
|
+
OIDC_ROLE_CLAIM= # Claim path for role (e.g. realm_access.roles)
|
|
194
|
+
OIDC_ADMIN_ROLES=admin # Comma-separated admin role values
|
|
195
|
+
|
|
196
|
+
# Optional AI config
|
|
197
|
+
LLM_PROVIDER=gemini # gemini, openai, ollama, custom
|
|
198
|
+
LLM_API_KEY=<key>
|
|
199
|
+
LLM_MODEL=gemini-2.5-flash
|
|
200
|
+
LLM_API_URL=<url> # For ollama/custom providers
|
|
201
|
+
|
|
202
|
+
# Optional storage config (server-side only, not NEXT_PUBLIC_)
|
|
203
|
+
STORAGE_PROVIDER=local # local (default) | sqlite | postgres
|
|
204
|
+
STORAGE_SQLITE_PATH=./data/libredb-storage.db # SQLite file path
|
|
205
|
+
STORAGE_POSTGRES_URL=postgresql://... # PostgreSQL connection URL
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Path Aliases
|
|
209
|
+
|
|
210
|
+
TypeScript path alias `@/*` maps to `./src/*`. Use `@/components/...`, `@/lib/...`, etc.
|
|
211
|
+
|
|
212
|
+
## Pre-Commit Verification (MANDATORY)
|
|
213
|
+
|
|
214
|
+
**After every code change, you MUST run the CI pipeline checks locally before considering the task complete.** These match `.github/workflows/ci.yml` and `docker-build-push.yml`:
|
|
215
|
+
|
|
216
|
+
```bash
|
|
217
|
+
# 1. Lint (ESLint 9)
|
|
218
|
+
bun run lint
|
|
219
|
+
|
|
220
|
+
# 2. Type check (TypeScript strict)
|
|
221
|
+
bun run typecheck
|
|
222
|
+
|
|
223
|
+
# 3. Tests (unit + API + integration + hooks + components)
|
|
224
|
+
bun run test
|
|
225
|
+
|
|
226
|
+
# 4. Build (Next.js production build)
|
|
227
|
+
bun run build
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
**Do NOT skip any step.** If any step fails, fix the issue before proceeding. The GitHub Actions CI will run all four checks — a local pass on all four guarantees the CI will also pass.
|
|
231
|
+
|
|
232
|
+
## Docker Build
|
|
233
|
+
|
|
234
|
+
The Dockerfile uses multi-stage Bun build with standalone Next.js output. Build args: `JWT_SECRET_BUILD`, `ADMIN_PASSWORD_BUILD`, `USER_PASSWORD_BUILD`. Health check: `GET /api/db/health`.
|
|
235
|
+
|
|
236
|
+
## Database Connections
|
|
237
|
+
|
|
238
|
+
### SQL Databases (PostgreSQL, MySQL, SQLite)
|
|
239
|
+
```typescript
|
|
240
|
+
const connection = {
|
|
241
|
+
type: 'postgres', // or 'mysql', 'sqlite'
|
|
242
|
+
host: 'localhost',
|
|
243
|
+
port: 5432,
|
|
244
|
+
database: 'mydb',
|
|
245
|
+
user: 'admin',
|
|
246
|
+
password: 'secret',
|
|
247
|
+
};
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
### MongoDB
|
|
251
|
+
```typescript
|
|
252
|
+
const connection = {
|
|
253
|
+
type: 'mongodb',
|
|
254
|
+
connectionString: 'mongodb://localhost:27017/mydb',
|
|
255
|
+
// or host/port/database format
|
|
256
|
+
};
|
|
257
|
+
|
|
258
|
+
// Query format (JSON)
|
|
259
|
+
const query = JSON.stringify({
|
|
260
|
+
collection: 'users',
|
|
261
|
+
operation: 'find',
|
|
262
|
+
filter: { status: 'active' },
|
|
263
|
+
options: { limit: 50 }
|
|
264
|
+
});
|
|
265
|
+
```
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
+
identity and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
+
community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or advances of
|
|
31
|
+
any kind
|
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
* Public or private harassment
|
|
34
|
+
* Publishing others' private information, such as a physical or email address,
|
|
35
|
+
without their explicit permission
|
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official project e-mail
|
|
56
|
+
address, posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
cevheribozoglan@gmail.com.
|
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
+
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
68
|
+
|
|
69
|
+
## Enforcement Guidelines
|
|
70
|
+
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
+
|
|
74
|
+
### 1. Correction
|
|
75
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
76
|
+
unprofessional or unwelcome in the community.
|
|
77
|
+
|
|
78
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
79
|
+
clarity around the nature of the violation and an explanation of why the
|
|
80
|
+
behavior was inappropriate. A public apology may be requested.
|
|
81
|
+
|
|
82
|
+
### 2. Warning
|
|
83
|
+
**Community Impact**: A violation through a single incident or series of
|
|
84
|
+
actions.
|
|
85
|
+
|
|
86
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
87
|
+
interaction with the people involved, including unsolicited interaction with
|
|
88
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
89
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
90
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
91
|
+
ban.
|
|
92
|
+
|
|
93
|
+
### 3. Temporary Ban
|
|
94
|
+
**Community Impact**: A serious violation of community standards, including
|
|
95
|
+
sustained inappropriate behavior.
|
|
96
|
+
|
|
97
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
98
|
+
communication with the community for a specified period of time. No public or
|
|
99
|
+
private interaction with the people involved, including unsolicited interaction
|
|
100
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
101
|
+
Violating these terms may lead to a permanent ban.
|
|
102
|
+
|
|
103
|
+
### 4. Permanent Ban
|
|
104
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
105
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
106
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
107
|
+
|
|
108
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
109
|
+
community.
|
|
110
|
+
|
|
111
|
+
## Attribution
|
|
112
|
+
|
|
113
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
114
|
+
version 2.1, available at
|
|
115
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]
|
|
116
|
+
|
|
117
|
+
[homepage]: https://www.contributor-covenant.org
|
|
118
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
119
|
+
|
|
120
|
+
For answers to common questions about this code of conduct, see
|
|
121
|
+
[https://www.contributor-covenant.org/faq][faq]
|
|
122
|
+
|
|
123
|
+
[faq]: https://www.contributor-covenant.org/faq
|
|
124
|
+
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
# Contributing to LibreDB Studio
|
|
2
|
+
|
|
3
|
+
First off, thank you for considering contributing to LibreDB Studio! It's people like you that make LibreDB Studio such a great tool.
|
|
4
|
+
|
|
5
|
+
## Code of Conduct
|
|
6
|
+
|
|
7
|
+
This project and everyone participating in it is governed by our [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
|
|
8
|
+
|
|
9
|
+
## How Can I Contribute?
|
|
10
|
+
|
|
11
|
+
### Reporting Bugs
|
|
12
|
+
|
|
13
|
+
Before creating bug reports, please check the existing issues to avoid duplicates. When you create a bug report, include as many details as possible:
|
|
14
|
+
|
|
15
|
+
- **Use a clear and descriptive title**
|
|
16
|
+
- **Describe the exact steps to reproduce the problem**
|
|
17
|
+
- **Describe the behavior you observed and what you expected**
|
|
18
|
+
- **Include screenshots if possible**
|
|
19
|
+
- **Include your environment details** (OS, browser, Node.js version)
|
|
20
|
+
|
|
21
|
+
### Suggesting Features
|
|
22
|
+
|
|
23
|
+
Feature suggestions are welcome! Please provide:
|
|
24
|
+
|
|
25
|
+
- **A clear and descriptive title**
|
|
26
|
+
- **A detailed description of the proposed feature**
|
|
27
|
+
- **Explain why this feature would be useful**
|
|
28
|
+
- **Include mockups or examples if applicable**
|
|
29
|
+
|
|
30
|
+
### Pull Requests
|
|
31
|
+
|
|
32
|
+
1. **Fork the repository** and create your branch from `main`
|
|
33
|
+
2. **Follow the coding style** of the project
|
|
34
|
+
3. **Write clear commit messages**
|
|
35
|
+
4. **Update documentation** if needed
|
|
36
|
+
5. **Test your changes** thoroughly
|
|
37
|
+
|
|
38
|
+
## Development Setup
|
|
39
|
+
|
|
40
|
+
### Prerequisites
|
|
41
|
+
|
|
42
|
+
- [Bun](https://bun.sh/) (recommended) or Node.js 20+
|
|
43
|
+
- Git
|
|
44
|
+
|
|
45
|
+
### Getting Started
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
# Clone your fork
|
|
49
|
+
git clone https://github.com/YOUR_USERNAME/libredb-studio.git
|
|
50
|
+
cd libredb-studio
|
|
51
|
+
|
|
52
|
+
# Install dependencies
|
|
53
|
+
bun install
|
|
54
|
+
|
|
55
|
+
# Copy environment example
|
|
56
|
+
cp .env.example .env.local
|
|
57
|
+
|
|
58
|
+
# Start development server
|
|
59
|
+
bun dev
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Environment Variables
|
|
63
|
+
|
|
64
|
+
Required for development:
|
|
65
|
+
```env
|
|
66
|
+
ADMIN_PASSWORD=admin123
|
|
67
|
+
USER_PASSWORD=user123
|
|
68
|
+
JWT_SECRET=your_32_character_random_string_here
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Optional (for AI features):
|
|
72
|
+
```env
|
|
73
|
+
LLM_PROVIDER=gemini
|
|
74
|
+
LLM_API_KEY=your_api_key
|
|
75
|
+
LLM_MODEL=gemini-2.5-flash
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Development Database
|
|
79
|
+
|
|
80
|
+
We provide a ready-to-use PostgreSQL setup with sample data for testing:
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
# Start PostgreSQL with sample e-commerce data
|
|
84
|
+
docker compose -f docker/postgres.yml up -d
|
|
85
|
+
|
|
86
|
+
# Connect with:
|
|
87
|
+
# Host: localhost, Port: 5432, Database: libredb_dev
|
|
88
|
+
# User: postgres, Password: postgres
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
**Includes:**
|
|
92
|
+
- PostgreSQL 17 with `pg_stat_statements` enabled
|
|
93
|
+
- E-commerce sample schema (customers, products, orders)
|
|
94
|
+
- 100+ records across multiple tables
|
|
95
|
+
- Pre-built views for reporting
|
|
96
|
+
|
|
97
|
+
> This is especially useful for testing the **Monitoring Dashboard** features.
|
|
98
|
+
|
|
99
|
+
### Project Structure
|
|
100
|
+
|
|
101
|
+
```
|
|
102
|
+
src/
|
|
103
|
+
├── app/ # Next.js App Router
|
|
104
|
+
│ ├── api/ # API routes
|
|
105
|
+
│ ├── admin/ # Admin pages
|
|
106
|
+
│ └── login/ # Login page
|
|
107
|
+
├── components/ # React components
|
|
108
|
+
├── hooks/ # Custom React hooks
|
|
109
|
+
└── lib/
|
|
110
|
+
├── db/ # Database providers (Strategy Pattern)
|
|
111
|
+
├── llm/ # LLM providers (Strategy Pattern)
|
|
112
|
+
└── ... # Utilities
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Available Scripts
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
bun dev # Start development server
|
|
119
|
+
bun build # Build for production
|
|
120
|
+
bun start # Start production server
|
|
121
|
+
bun lint # Run ESLint
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## Coding Guidelines
|
|
125
|
+
|
|
126
|
+
### TypeScript
|
|
127
|
+
|
|
128
|
+
- Use TypeScript for all new code
|
|
129
|
+
- Define proper types/interfaces
|
|
130
|
+
- Avoid `any` type when possible
|
|
131
|
+
|
|
132
|
+
### React
|
|
133
|
+
|
|
134
|
+
- Use functional components with hooks
|
|
135
|
+
- Follow the existing component patterns
|
|
136
|
+
- Keep components focused and small
|
|
137
|
+
|
|
138
|
+
### Styling
|
|
139
|
+
|
|
140
|
+
- Use Tailwind CSS for styling
|
|
141
|
+
- Follow the existing design patterns
|
|
142
|
+
- Use Shadcn/UI components when applicable
|
|
143
|
+
|
|
144
|
+
### Commits
|
|
145
|
+
|
|
146
|
+
- Use clear, descriptive commit messages
|
|
147
|
+
- Reference issues in commits when applicable (e.g., `Fix #123`)
|
|
148
|
+
- Keep commits focused on a single change
|
|
149
|
+
|
|
150
|
+
## Questions?
|
|
151
|
+
|
|
152
|
+
Feel free to open an issue with your question or reach out to the maintainers.
|
|
153
|
+
|
|
154
|
+
Thank you for contributing!
|
package/Dockerfile
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# ==============================================================================
|
|
2
|
+
# LibreDB Studio - Production Dockerfile
|
|
3
|
+
# Optimized for Render, Railway, Fly.io, and Kubernetes
|
|
4
|
+
# ==============================================================================
|
|
5
|
+
|
|
6
|
+
# Bun for fast dependency installation, Node.js for build
|
|
7
|
+
# Bun's JIT compiler segfaults under QEMU emulation (ARM64 cross-build),
|
|
8
|
+
# so we use Node.js for the Next.js build step.
|
|
9
|
+
FROM oven/bun:1 AS deps
|
|
10
|
+
WORKDIR /usr/src/app
|
|
11
|
+
RUN apt-get update && apt-get install -y python3 make g++ --no-install-recommends && rm -rf /var/lib/apt/lists/*
|
|
12
|
+
COPY package.json bun.lock ./
|
|
13
|
+
RUN bun install --frozen-lockfile
|
|
14
|
+
|
|
15
|
+
# Build with Node.js to avoid Bun/QEMU segfaults on ARM64
|
|
16
|
+
FROM node:20-slim AS builder
|
|
17
|
+
WORKDIR /usr/src/app
|
|
18
|
+
COPY --from=deps /usr/src/app/node_modules ./node_modules
|
|
19
|
+
COPY . .
|
|
20
|
+
|
|
21
|
+
ENV NEXT_TELEMETRY_DISABLED=1
|
|
22
|
+
ENV DOCKER_BUILD=true
|
|
23
|
+
|
|
24
|
+
ARG JWT_SECRET_BUILD="build-time-placeholder-secret-32ch"
|
|
25
|
+
ARG ADMIN_PASSWORD_BUILD="build"
|
|
26
|
+
ARG USER_PASSWORD_BUILD="build"
|
|
27
|
+
ENV JWT_SECRET=$JWT_SECRET_BUILD
|
|
28
|
+
ENV ADMIN_PASSWORD=$ADMIN_PASSWORD_BUILD
|
|
29
|
+
ENV USER_PASSWORD=$USER_PASSWORD_BUILD
|
|
30
|
+
|
|
31
|
+
RUN npx next build
|
|
32
|
+
|
|
33
|
+
# Production image - use Node.js slim for lower memory footprint
|
|
34
|
+
FROM node:20-slim AS runner
|
|
35
|
+
WORKDIR /app
|
|
36
|
+
|
|
37
|
+
ENV NODE_ENV=production
|
|
38
|
+
ENV NEXT_TELEMETRY_DISABLED=1
|
|
39
|
+
|
|
40
|
+
# Memory optimization for low-memory environments (Render free tier)
|
|
41
|
+
# V8 heap limit to prevent OOM on 512MB instances
|
|
42
|
+
ENV NODE_OPTIONS="--max-old-space-size=384"
|
|
43
|
+
|
|
44
|
+
COPY --from=builder /usr/src/app/public ./public
|
|
45
|
+
|
|
46
|
+
# Set the correct permission for prerender cache and storage
|
|
47
|
+
RUN mkdir -p .next data
|
|
48
|
+
|
|
49
|
+
# Automatically leverage output traces to reduce image size
|
|
50
|
+
# https://nextjs.org/docs/advanced-features/output-file-tracing
|
|
51
|
+
COPY --from=builder /usr/src/app/.next/standalone ./
|
|
52
|
+
COPY --from=builder /usr/src/app/.next/static ./.next/static
|
|
53
|
+
|
|
54
|
+
# Copy better-sqlite3 native binding for server storage support
|
|
55
|
+
COPY --from=builder /usr/src/app/node_modules/better-sqlite3 ./node_modules/better-sqlite3
|
|
56
|
+
COPY --from=builder /usr/src/app/node_modules/bindings ./node_modules/bindings
|
|
57
|
+
COPY --from=builder /usr/src/app/node_modules/file-uri-to-path ./node_modules/file-uri-to-path
|
|
58
|
+
# prebuild-install is only needed at build time, not runtime
|
|
59
|
+
|
|
60
|
+
# Create non-root user for security
|
|
61
|
+
RUN addgroup --system --gid 1001 nodejs && \
|
|
62
|
+
adduser --system --uid 1001 nextjs && \
|
|
63
|
+
chown -R nextjs:nodejs /app
|
|
64
|
+
USER nextjs
|
|
65
|
+
|
|
66
|
+
# Render uses PORT env variable, default to 3000
|
|
67
|
+
EXPOSE 3000/tcp
|
|
68
|
+
ENV PORT=3000
|
|
69
|
+
ENV HOSTNAME="0.0.0.0"
|
|
70
|
+
|
|
71
|
+
# server.js is created by next build from the standalone output
|
|
72
|
+
# https://nextjs.org/docs/pages/api-reference/next-config-js/output
|
|
73
|
+
CMD ["node", "server.js"]
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 LibreDB
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|