insforge 0.3.1
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/.dockerignore +58 -0
- package/.env.example +49 -0
- package/.github/ISSUE_TEMPLATE/bug_report.yml +83 -0
- package/.github/ISSUE_TEMPLATE/config.yml +11 -0
- package/.github/ISSUE_TEMPLATE/feature_request.yml +79 -0
- package/.github/copilot-instructions.md +147 -0
- package/.github/workflows/build-image.yml +65 -0
- package/.github/workflows/ci-premerge-check.yml +24 -0
- package/.github/workflows/deploy-aws.yml +130 -0
- package/.github/workflows/lint-and-format.yml +33 -0
- package/.prettierignore +65 -0
- package/.prettierrc +9 -0
- package/CHANGELOG.md +3 -0
- package/CONTRIBUTING.md +126 -0
- package/Dockerfile +27 -0
- package/GITHUB_OAUTH_SETUP.md +49 -0
- package/GOOGLE_OAUTH_SETUP.md +148 -0
- package/LICENSE +201 -0
- package/README.md +134 -0
- package/assets/Dark.svg +23 -0
- package/assets/archDiagram.png +0 -0
- package/assets/banner.png +0 -0
- package/assets/mcpInstallv2.png +0 -0
- package/assets/sampleResponse.png +0 -0
- package/assets/signin.png +0 -0
- package/assets/userflow.png +0 -0
- package/backend/migrations/000_create-base-tables.sql +142 -0
- package/backend/migrations/001_create-helper-functions.sql +41 -0
- package/backend/migrations/002_rename-auth-tables.sql +30 -0
- package/backend/migrations/003_create-users-table.sql +56 -0
- package/backend/migrations/004_add-reload-postgrest-func.sql +24 -0
- package/backend/migrations/005_enable-project-admin-modify-users.sql +30 -0
- package/backend/migrations/006_modify-ai-usage-table.sql +25 -0
- package/backend/migrations/007_drop-metadata-table.sql +2 -0
- package/backend/migrations/008_add-system-tables.sql +77 -0
- package/backend/migrations/009_add-function-secrets.sql +24 -0
- package/backend/migrations/010_modify-ai-config-modalities.sql +93 -0
- package/backend/migrations/011_refactor-secrets-table.sql +15 -0
- package/backend/migrations/012_add-storage-uploaded-by.sql +8 -0
- package/backend/package.json +75 -0
- package/backend/src/api/middleware/auth.ts +240 -0
- package/backend/src/api/middleware/error.ts +231 -0
- package/backend/src/api/middleware/upload.ts +59 -0
- package/backend/src/api/routes/agent.ts +29 -0
- package/backend/src/api/routes/ai.ts +472 -0
- package/backend/src/api/routes/auth.oauth.ts +482 -0
- package/backend/src/api/routes/auth.ts +386 -0
- package/backend/src/api/routes/database.advance.ts +275 -0
- package/backend/src/api/routes/database.records.ts +246 -0
- package/backend/src/api/routes/database.tables.ts +161 -0
- package/backend/src/api/routes/docs.ts +66 -0
- package/backend/src/api/routes/functions.ts +183 -0
- package/backend/src/api/routes/logs.ts +150 -0
- package/backend/src/api/routes/metadata.ts +160 -0
- package/backend/src/api/routes/openapi.ts +82 -0
- package/backend/src/api/routes/secrets.ts +199 -0
- package/backend/src/api/routes/storage.ts +547 -0
- package/backend/src/api/routes/usage.ts +96 -0
- package/backend/src/core/ai/chat.ts +207 -0
- package/backend/src/core/ai/client.ts +242 -0
- package/backend/src/core/ai/config.ts +187 -0
- package/backend/src/core/ai/image.ts +156 -0
- package/backend/src/core/ai/model.ts +117 -0
- package/backend/src/core/ai/usage.ts +290 -0
- package/backend/src/core/auth/auth.ts +781 -0
- package/backend/src/core/auth/oauth.ts +398 -0
- package/backend/src/core/database/advance.ts +1074 -0
- package/backend/src/core/database/manager.ts +178 -0
- package/backend/src/core/database/table.ts +772 -0
- package/backend/src/core/documentation/agent.ts +689 -0
- package/backend/src/core/documentation/openapi.ts +856 -0
- package/backend/src/core/functions/functions.ts +310 -0
- package/backend/src/core/logs/analytics.ts +76 -0
- package/backend/src/core/logs/audit.ts +255 -0
- package/backend/src/core/logs/providers/base.provider.ts +83 -0
- package/backend/src/core/logs/providers/cloudwatch.provider.ts +510 -0
- package/backend/src/core/logs/providers/localdb.provider.ts +246 -0
- package/backend/src/core/secrets/encryption.ts +58 -0
- package/backend/src/core/secrets/secrets.ts +410 -0
- package/backend/src/core/socket/socket.ts +388 -0
- package/backend/src/core/socket/types.ts +79 -0
- package/backend/src/core/storage/storage.ts +923 -0
- package/backend/src/server.ts +288 -0
- package/backend/src/types/ai.ts +46 -0
- package/backend/src/types/auth.ts +90 -0
- package/backend/src/types/database.ts +136 -0
- package/backend/src/types/error-constants.ts +86 -0
- package/backend/src/types/logs.ts +47 -0
- package/backend/src/types/profile.ts +55 -0
- package/backend/src/types/storage.ts +23 -0
- package/backend/src/utils/cloud-token.ts +39 -0
- package/backend/src/utils/constants.ts +1 -0
- package/backend/src/utils/environment.ts +35 -0
- package/backend/src/utils/helpers.ts +49 -0
- package/backend/src/utils/logger.ts +13 -0
- package/backend/src/utils/response.ts +62 -0
- package/backend/src/utils/seed.ts +205 -0
- package/backend/src/utils/sql-parser.ts +63 -0
- package/backend/src/utils/uuid.ts +9 -0
- package/backend/src/utils/validations.ts +129 -0
- package/backend/tests/README.md +134 -0
- package/backend/tests/cleanup-all-test-data.sh +231 -0
- package/backend/tests/cloud/test-s3-multitenant.sh +132 -0
- package/backend/tests/local/comprehensive-curl-tests.sh +156 -0
- package/backend/tests/local/test-auth-router.sh +144 -0
- package/backend/tests/local/test-database-router.sh +222 -0
- package/backend/tests/local/test-e2e.sh +241 -0
- package/backend/tests/local/test-fk-errors.sh +97 -0
- package/backend/tests/local/test-id-field.sh +201 -0
- package/backend/tests/local/test-public-bucket.sh +265 -0
- package/backend/tests/local/test-secrets.sh +248 -0
- package/backend/tests/local/test-serverless-functions.sh.disabled +325 -0
- package/backend/tests/local/test-traditional-rest.sh +209 -0
- package/backend/tests/manual/README.md +51 -0
- package/backend/tests/manual/create-large-table-simple.sql +11 -0
- package/backend/tests/manual/seed-large-table.sql +101 -0
- package/backend/tests/manual/setup-large-table-extras.sql +34 -0
- package/backend/tests/manual/test-better-auth.sh +303 -0
- package/backend/tests/manual/test-bulk-upsert.sh +410 -0
- package/backend/tests/manual/test-database-advance.sh +297 -0
- package/backend/tests/manual/test-postgrest-stability.sh +192 -0
- package/backend/tests/manual/test-rawsql-export-import.sh +412 -0
- package/backend/tests/manual/test-universal-storage.sh +264 -0
- package/backend/tests/manual/test-users.sql +18 -0
- package/backend/tests/run-all-tests.sh +140 -0
- package/backend/tests/setup.ts +22 -0
- package/backend/tests/test-config.sh +303 -0
- package/backend/tsconfig.json +23 -0
- package/backend/tsup.config.ts +18 -0
- package/backend/vitest.config.ts +22 -0
- package/docker-compose.prod.yml +145 -0
- package/docker-compose.yml +167 -0
- package/docker-init/db/db-init.sql +125 -0
- package/docker-init/db/jwt.sql +5 -0
- package/docker-init/db/logs.sql +9 -0
- package/docker-init/db/postgresql.conf +17 -0
- package/docs/deprecated/insforge-auth-api.md +215 -0
- package/docs/deprecated/insforge-auth-sdk.md +100 -0
- package/docs/deprecated/insforge-db-api.md +359 -0
- package/docs/deprecated/insforge-db-sdk.md +140 -0
- package/docs/deprecated/insforge-debug-sdk.md +157 -0
- package/docs/deprecated/insforge-debug.md +65 -0
- package/docs/deprecated/insforge-instructions.md +124 -0
- package/docs/deprecated/insforge-project.md +118 -0
- package/docs/deprecated/insforge-storage-api.md +279 -0
- package/docs/deprecated/insforge-storage-sdk.md +159 -0
- package/docs/insforge-instructions-sdk.md +407 -0
- package/eslint.config.js +317 -0
- package/examples/oauth/frontend-oauth-example.html +251 -0
- package/examples/response-examples.md +444 -0
- package/frontend/README.md +112 -0
- package/frontend/components.json +17 -0
- package/frontend/index.html +13 -0
- package/frontend/package.json +63 -0
- package/frontend/public/favicon.ico +0 -0
- package/frontend/src/App.tsx +106 -0
- package/frontend/src/assets/icons/checkbox_checked.svg +6 -0
- package/frontend/src/assets/icons/checkbox_undetermined.svg +6 -0
- package/frontend/src/assets/icons/checked.svg +3 -0
- package/frontend/src/assets/icons/error.svg +3 -0
- package/frontend/src/assets/icons/pencil.svg +4 -0
- package/frontend/src/assets/icons/refresh.svg +4 -0
- package/frontend/src/assets/icons/step_active.svg +3 -0
- package/frontend/src/assets/icons/step_inactive.svg +11 -0
- package/frontend/src/assets/icons/warning.svg +3 -0
- package/frontend/src/assets/logos/amazon.svg +1 -0
- package/frontend/src/assets/logos/claude_code.svg +3 -0
- package/frontend/src/assets/logos/cline.svg +6 -0
- package/frontend/src/assets/logos/cursor.svg +20 -0
- package/frontend/src/assets/logos/discord.svg +9 -0
- package/frontend/src/assets/logos/gemini.svg +19 -0
- package/frontend/src/assets/logos/github.svg +5 -0
- package/frontend/src/assets/logos/google.svg +13 -0
- package/frontend/src/assets/logos/grok.svg +10 -0
- package/frontend/src/assets/logos/insforge_dark.svg +15 -0
- package/frontend/src/assets/logos/insforge_light.svg +15 -0
- package/frontend/src/assets/logos/openai.svg +10 -0
- package/frontend/src/assets/logos/roo_code.svg +9 -0
- package/frontend/src/assets/logos/trae.svg +3 -0
- package/frontend/src/assets/logos/windsurf.svg +10 -0
- package/frontend/src/components/ButtonWithLoading.tsx +27 -0
- package/frontend/src/components/Checkbox.tsx +61 -0
- package/frontend/src/components/CodeBlock.tsx +32 -0
- package/frontend/src/components/ConfirmDialog.tsx +96 -0
- package/frontend/src/components/CopyButton.tsx +69 -0
- package/frontend/src/components/DeleteActionButton.tsx +42 -0
- package/frontend/src/components/EmptyState.tsx +41 -0
- package/frontend/src/components/ErrorState.tsx +35 -0
- package/frontend/src/components/FeatureSidebar.tsx +126 -0
- package/frontend/src/components/FeatureSidebarItem.tsx +101 -0
- package/frontend/src/components/JsonHighlight.tsx +61 -0
- package/frontend/src/components/LoadingState.tsx +16 -0
- package/frontend/src/components/PaginationControls.tsx +54 -0
- package/frontend/src/components/PromptDialog.tsx +68 -0
- package/frontend/src/components/SearchInput.tsx +90 -0
- package/frontend/src/components/SelectionClearButton.tsx +26 -0
- package/frontend/src/components/Stepper.tsx +139 -0
- package/frontend/src/components/ThemeToggle.tsx +58 -0
- package/frontend/src/components/TypeBadge.tsx +20 -0
- package/frontend/src/components/datagrid/DataGrid.tsx +264 -0
- package/frontend/src/components/datagrid/DefaultCellRenderer.tsx +114 -0
- package/frontend/src/components/datagrid/IdCell.tsx +44 -0
- package/frontend/src/components/datagrid/SortableHeader.tsx +74 -0
- package/frontend/src/components/datagrid/cell-editors/BooleanCellEditor.tsx +54 -0
- package/frontend/src/components/datagrid/cell-editors/DateCellEditor.tsx +483 -0
- package/frontend/src/components/datagrid/cell-editors/JsonCellEditor.tsx +362 -0
- package/frontend/src/components/datagrid/cell-editors/TextCellEditor.tsx +38 -0
- package/frontend/src/components/datagrid/cell-editors/index.ts +14 -0
- package/frontend/src/components/datagrid/cell-editors/types.ts +43 -0
- package/frontend/src/components/datagrid/datagridTypes.tsx +72 -0
- package/frontend/src/components/datagrid/index.tsx +20 -0
- package/frontend/src/components/index.ts +39 -0
- package/frontend/src/components/layout/AppHeader.tsx +146 -0
- package/frontend/src/components/layout/AppSidebar.tsx +190 -0
- package/frontend/src/components/layout/CloudLayout.tsx +95 -0
- package/frontend/src/components/layout/Layout.tsx +43 -0
- package/frontend/src/components/radix/Alert.tsx +45 -0
- package/frontend/src/components/radix/AlertDialog.tsx +115 -0
- package/frontend/src/components/radix/Avatar.tsx +45 -0
- package/frontend/src/components/radix/Badge.tsx +33 -0
- package/frontend/src/components/radix/Button.tsx +50 -0
- package/frontend/src/components/radix/Card.tsx +58 -0
- package/frontend/src/components/radix/Dialog.tsx +98 -0
- package/frontend/src/components/radix/DropdownMenu.tsx +185 -0
- package/frontend/src/components/radix/Form.tsx +167 -0
- package/frontend/src/components/radix/Input.tsx +22 -0
- package/frontend/src/components/radix/Label.tsx +19 -0
- package/frontend/src/components/radix/Popover.tsx +29 -0
- package/frontend/src/components/radix/ScrollArea.tsx +44 -0
- package/frontend/src/components/radix/Select.tsx +151 -0
- package/frontend/src/components/radix/Separator.tsx +26 -0
- package/frontend/src/components/radix/Sheet.tsx +119 -0
- package/frontend/src/components/radix/Skeleton.tsx +7 -0
- package/frontend/src/components/radix/Switch.tsx +29 -0
- package/frontend/src/components/radix/Tabs.tsx +50 -0
- package/frontend/src/components/radix/Textarea.tsx +21 -0
- package/frontend/src/components/radix/Tooltip.tsx +28 -0
- package/frontend/src/features/ai/components/AIConfigCard.tsx +154 -0
- package/frontend/src/features/ai/components/AIConfigDialog.tsx +76 -0
- package/frontend/src/features/ai/components/AIConfigForm.tsx +222 -0
- package/frontend/src/features/ai/components/AIEmptyState.tsx +18 -0
- package/frontend/src/features/ai/components/fields/ModalityField.tsx +87 -0
- package/frontend/src/features/ai/components/fields/ModelSelectionField.tsx +134 -0
- package/frontend/src/features/ai/components/fields/SystemPromptField.tsx +33 -0
- package/frontend/src/features/ai/helpers.ts +155 -0
- package/frontend/src/features/ai/hooks/useAIConfigs.ts +221 -0
- package/frontend/src/features/ai/hooks/useAIUsage.ts +77 -0
- package/frontend/src/features/ai/page/AIPage.tsx +178 -0
- package/frontend/src/features/ai/services/ai.service.ts +148 -0
- package/frontend/src/features/auth/components/AddOAuthDialog.tsx +106 -0
- package/frontend/src/features/auth/components/AuthMethodTab.tsx +238 -0
- package/frontend/src/features/auth/components/OAuthConfigDialog.tsx +303 -0
- package/frontend/src/features/auth/components/OAuthEmptyState.tsx +15 -0
- package/frontend/src/features/auth/components/UserFormDialog.tsx +248 -0
- package/frontend/src/features/auth/components/UsersDataGrid.tsx +183 -0
- package/frontend/src/features/auth/components/UsersTab.tsx +114 -0
- package/frontend/src/features/auth/hooks/useOAuthConfig.ts +129 -0
- package/frontend/src/features/auth/hooks/useUsers.ts +57 -0
- package/frontend/src/features/auth/index.ts +9 -0
- package/frontend/src/features/auth/page/AuthenticationPage.tsx +169 -0
- package/frontend/src/features/auth/services/auth.service.ts +112 -0
- package/frontend/src/features/auth/services/oauth.service.ts +49 -0
- package/frontend/src/features/dashboard/page/DashboardPage.tsx +194 -0
- package/frontend/src/features/database/components/ColumnTypeSelect.tsx +64 -0
- package/frontend/src/features/database/components/DatabaseDataGrid.tsx +282 -0
- package/frontend/src/features/database/components/ForeignKeyCell.tsx +187 -0
- package/frontend/src/features/database/components/ForeignKeyPopover.tsx +378 -0
- package/frontend/src/features/database/components/LinkRecordModal.tsx +288 -0
- package/frontend/src/features/database/components/RecordFormDialog.tsx +164 -0
- package/frontend/src/features/database/components/RecordFormField.tsx +568 -0
- package/frontend/src/features/database/components/TableEmptyState.tsx +21 -0
- package/frontend/src/features/database/components/TableForm.tsx +656 -0
- package/frontend/src/features/database/components/TableFormColumn.tsx +137 -0
- package/frontend/src/features/database/components/TableListSkeleton.tsx +9 -0
- package/frontend/src/features/database/components/TableSidebar.tsx +47 -0
- package/frontend/src/features/database/constants.ts +26 -0
- package/frontend/src/features/database/helpers.ts +125 -0
- package/frontend/src/features/database/hooks/UseLinkModal.tsx +78 -0
- package/frontend/src/features/database/index.ts +12 -0
- package/frontend/src/features/database/page/DatabasePage.tsx +626 -0
- package/frontend/src/features/database/schema.ts +25 -0
- package/frontend/src/features/database/services/database.service.ts +216 -0
- package/frontend/src/features/functions/components/FunctionEmptyState.tsx +15 -0
- package/frontend/src/features/functions/components/FunctionRow.tsx +71 -0
- package/frontend/src/features/functions/components/FunctionViewer.tsx +46 -0
- package/frontend/src/features/functions/components/FunctionsContent.tsx +88 -0
- package/frontend/src/features/functions/components/FunctionsSidebar.tsx +56 -0
- package/frontend/src/features/functions/components/SecretEmptyState.tsx +23 -0
- package/frontend/src/features/functions/components/SecretRow.tsx +68 -0
- package/frontend/src/features/functions/components/SecretsContent.tsx +120 -0
- package/frontend/src/features/functions/hooks/useFunctions.ts +106 -0
- package/frontend/src/features/functions/page/FunctionsPage.tsx +28 -0
- package/frontend/src/features/functions/services/functions.service.ts +48 -0
- package/frontend/src/features/login/components/AuthErrorBoundary.tsx +87 -0
- package/frontend/src/features/login/components/PrivateRoute.tsx +24 -0
- package/frontend/src/features/login/page/CloudLoginPage.tsx +93 -0
- package/frontend/src/features/login/page/LoginPage.tsx +174 -0
- package/frontend/src/features/logs/components/AnalyticsLogsTable.tsx +313 -0
- package/frontend/src/features/logs/components/LogsTable.tsx +199 -0
- package/frontend/src/features/logs/hooks/useAuditLogs.ts +39 -0
- package/frontend/src/features/logs/index.ts +5 -0
- package/frontend/src/features/logs/page/AnalyticsLogsPage.tsx +530 -0
- package/frontend/src/features/logs/page/AuditsPage.tsx +192 -0
- package/frontend/src/features/logs/services/log.service.ts +171 -0
- package/frontend/src/features/metadata/hooks/useMetadata.ts +53 -0
- package/frontend/src/features/metadata/index.ts +0 -0
- package/frontend/src/features/metadata/page/MetadataPage.tsx +136 -0
- package/frontend/src/features/metadata/services/metadata.service.ts +17 -0
- package/frontend/src/features/onboard/components/CompletionCard.tsx +41 -0
- package/frontend/src/features/onboard/components/OnboardButton.tsx +84 -0
- package/frontend/src/features/onboard/components/StepContent.tsx +91 -0
- package/frontend/src/features/onboard/components/TestConnectionStep.tsx +53 -0
- package/frontend/src/features/onboard/components/mcp/CursorDeeplinkGenerator.tsx +35 -0
- package/frontend/src/features/onboard/components/mcp/McpInstallation.tsx +144 -0
- package/frontend/src/features/onboard/components/mcp/index.ts +4 -0
- package/frontend/src/features/onboard/components/mcp/mcp-helper.tsx +98 -0
- package/frontend/src/features/onboard/index.ts +3 -0
- package/frontend/src/features/onboard/page/OnBoardPage.tsx +104 -0
- package/frontend/src/features/onboard/types.ts +8 -0
- package/frontend/src/features/secrets/hooks/useSecrets.ts +139 -0
- package/frontend/src/features/secrets/services/secrets.service.ts +57 -0
- package/frontend/src/features/storage/components/BucketEmptyState.tsx +19 -0
- package/frontend/src/features/storage/components/BucketFormDialog.tsx +194 -0
- package/frontend/src/features/storage/components/BucketListSkeleton.tsx +17 -0
- package/frontend/src/features/storage/components/FilePreviewDialog.tsx +287 -0
- package/frontend/src/features/storage/components/StorageDataGrid.tsx +239 -0
- package/frontend/src/features/storage/components/StorageManager.tsx +236 -0
- package/frontend/src/features/storage/components/StorageSidebar.tsx +44 -0
- package/frontend/src/features/storage/components/UploadToast.tsx +46 -0
- package/frontend/src/features/storage/index.ts +3 -0
- package/frontend/src/features/storage/page/StoragePage.tsx +553 -0
- package/frontend/src/features/storage/services/storage.service.ts +144 -0
- package/frontend/src/features/visualizer/components/AuthNode.tsx +107 -0
- package/frontend/src/features/visualizer/components/BucketNode.tsx +34 -0
- package/frontend/src/features/visualizer/components/SchemaVisualizer.tsx +359 -0
- package/frontend/src/features/visualizer/components/TableNode.tsx +152 -0
- package/frontend/src/features/visualizer/components/VisualizerSkeleton.tsx +24 -0
- package/frontend/src/features/visualizer/components/index.ts +5 -0
- package/frontend/src/features/visualizer/page/VisualizerPage.tsx +127 -0
- package/frontend/src/index.css +248 -0
- package/frontend/src/lib/api/client.ts +163 -0
- package/frontend/src/lib/contexts/AuthContext.tsx +157 -0
- package/frontend/src/lib/contexts/OnboardStepContext.tsx +68 -0
- package/frontend/src/lib/contexts/SocketContext.tsx +303 -0
- package/frontend/src/lib/contexts/ThemeContext.tsx +125 -0
- package/frontend/src/lib/hooks/useAuth.ts +4 -0
- package/frontend/src/lib/hooks/useConfirm.ts +55 -0
- package/frontend/src/lib/hooks/useInterval.ts +27 -0
- package/frontend/src/lib/hooks/useMediaQuery.ts +59 -0
- package/frontend/src/lib/hooks/useOnboardingCompletion.ts +29 -0
- package/frontend/src/lib/hooks/usePagination.ts +27 -0
- package/frontend/src/lib/hooks/useTimeout.ts +27 -0
- package/frontend/src/lib/hooks/useToast.tsx +229 -0
- package/frontend/src/lib/utils/constants.ts +38 -0
- package/frontend/src/lib/utils/utils.ts +165 -0
- package/frontend/src/lib/utils/validation-schemas.ts +126 -0
- package/frontend/src/main.tsx +16 -0
- package/frontend/src/rdg.css +194 -0
- package/frontend/src/vite-env.d.ts +12 -0
- package/frontend/tailwind.config.js +97 -0
- package/frontend/tsconfig.json +26 -0
- package/frontend/tsconfig.node.json +10 -0
- package/frontend/vite.config.ts +37 -0
- package/frontend/vitest.config.ts +36 -0
- package/functions/deno.json +25 -0
- package/functions/server.ts +290 -0
- package/functions/worker-template.js +126 -0
- package/openapi/ai.yaml +689 -0
- package/openapi/auth.yaml +563 -0
- package/openapi/functions.yaml +476 -0
- package/openapi/health.yaml +30 -0
- package/openapi/logs.yaml +224 -0
- package/openapi/metadata.yaml +178 -0
- package/openapi/records.yaml +382 -0
- package/openapi/secrets.yaml +371 -0
- package/openapi/storage.yaml +876 -0
- package/openapi/tables.yaml +464 -0
- package/package.json +88 -0
- package/shared-schemas/package.json +31 -0
- package/shared-schemas/src/ai-api.schema.ts +167 -0
- package/shared-schemas/src/ai.schema.ts +54 -0
- package/shared-schemas/src/auth-api.schema.ts +193 -0
- package/shared-schemas/src/auth.schema.ts +94 -0
- package/shared-schemas/src/database-api.schema.ts +259 -0
- package/shared-schemas/src/database.schema.ts +69 -0
- package/shared-schemas/src/functions-api.schema.ts +25 -0
- package/shared-schemas/src/functions.schema.ts +16 -0
- package/shared-schemas/src/index.ts +13 -0
- package/shared-schemas/src/logs-api.schema.ts +49 -0
- package/shared-schemas/src/logs.schema.ts +14 -0
- package/shared-schemas/src/metadata.schema.ts +56 -0
- package/shared-schemas/src/storage-api.schema.ts +65 -0
- package/shared-schemas/src/storage.schema.ts +19 -0
- package/shared-schemas/tsconfig.json +21 -0
- package/tsconfig.json +8 -0
|
@@ -0,0 +1,359 @@
|
|
|
1
|
+
# Insforge OSS Database API Documentation
|
|
2
|
+
|
|
3
|
+
## API Basics
|
|
4
|
+
|
|
5
|
+
**Base URL:** `http://localhost:7130`
|
|
6
|
+
|
|
7
|
+
**Note:** Avoid special characters (!,$,`,\) in curl command data - they can cause bash interpretation issues. Use simple text for testing.
|
|
8
|
+
|
|
9
|
+
**Authentication Requirements:**
|
|
10
|
+
- **READ operations (GET):** No authentication required - public access by default
|
|
11
|
+
- **WRITE operations (POST/PATCH/DELETE):** Requires `Authorization: Bearer <token>` header (JWT token or API key for MCP testing)
|
|
12
|
+
|
|
13
|
+
**Important: How Authentication Works**
|
|
14
|
+
1. Login returns a **JWT access token** - e.g., `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`
|
|
15
|
+
2. Just use: `Authorization: Bearer <token>` in your requests
|
|
16
|
+
3. API keys (starting with `ik_`) can also be used as Bearer tokens for testing
|
|
17
|
+
**Critical:** Always call `get-backend-metadata` first to understand current database structure
|
|
18
|
+
**Critical:** POST body must be arrays `[{...}]`, query filters `?field=eq.value`, add header `Prefer: return=representation` to return created data - follows PostgREST design (not traditional REST)
|
|
19
|
+
|
|
20
|
+
## Table Operations (Use MCP Tools)
|
|
21
|
+
|
|
22
|
+
### Available MCP Tools
|
|
23
|
+
|
|
24
|
+
1. **get-backend-metadata** - Get current database structure (always start here)
|
|
25
|
+
2. **create-table** - Create new table with explicit schema
|
|
26
|
+
3. **update-table-schema** - Alter existing table schema
|
|
27
|
+
4. **delete-table** - Remove table completely
|
|
28
|
+
5. **get-table-schema** - Get specific table structure
|
|
29
|
+
|
|
30
|
+
### Column Types
|
|
31
|
+
- `string` - Text data
|
|
32
|
+
- `integer` - Whole numbers
|
|
33
|
+
- `float` - Decimal numbers
|
|
34
|
+
- `boolean` - True/false values
|
|
35
|
+
- `datetime` - Date and time
|
|
36
|
+
- `json` - JSON objects
|
|
37
|
+
- `uuid` - Unique identifiers
|
|
38
|
+
|
|
39
|
+
## Record Operations (Use REST API)
|
|
40
|
+
|
|
41
|
+
### Base URL
|
|
42
|
+
`/api/database/records/:tableName`
|
|
43
|
+
|
|
44
|
+
### Query Records
|
|
45
|
+
**GET** `/api/database/records/:tableName`
|
|
46
|
+
|
|
47
|
+
Query parameters:
|
|
48
|
+
- `limit` - Maximum records (default: 100)
|
|
49
|
+
- `offset` - Skip records for pagination
|
|
50
|
+
- `order` - Sort by field (e.g., `createdAt.desc`)
|
|
51
|
+
- PostgREST filters: `field=eq.value`, `field=gt.value`, etc.
|
|
52
|
+
|
|
53
|
+
Response: Array of records with auto-generated `id`, `created_at`, `updated_at` fields
|
|
54
|
+
|
|
55
|
+
Example:
|
|
56
|
+
```bash
|
|
57
|
+
# Windows PowerShell: use curl.exe
|
|
58
|
+
curl -X GET "http://localhost:7130/api/database/records/posts?limit=10"
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Create Records
|
|
62
|
+
**POST** `/api/database/records/:tableName`
|
|
63
|
+
|
|
64
|
+
**AUTHENTICATION REQUIRED** - Must include `Authorization: Bearer <token>`
|
|
65
|
+
|
|
66
|
+
**CRITICAL**: Request body MUST be an array, even for single records!
|
|
67
|
+
|
|
68
|
+
**⚠️ IMPORTANT: Default Response Behavior**
|
|
69
|
+
- **By default, POST requests return an empty array `[]`**
|
|
70
|
+
- **To get the created records in the response, you MUST include the header:**
|
|
71
|
+
```
|
|
72
|
+
Prefer: return=representation
|
|
73
|
+
```
|
|
74
|
+
- **Without this header, you get no data back, just an empty array!**
|
|
75
|
+
|
|
76
|
+
Send array of records:
|
|
77
|
+
```json
|
|
78
|
+
[
|
|
79
|
+
{
|
|
80
|
+
"field1": "value1",
|
|
81
|
+
"field2": "value2"
|
|
82
|
+
}
|
|
83
|
+
]
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
For a single record, still wrap in array:
|
|
87
|
+
```json
|
|
88
|
+
[
|
|
89
|
+
{
|
|
90
|
+
"name": "John Doe",
|
|
91
|
+
"email": "john@example.com"
|
|
92
|
+
}
|
|
93
|
+
]
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Response format (WITHOUT `Prefer` header - default):
|
|
97
|
+
```json
|
|
98
|
+
[]
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Response format (WITH `Prefer: return=representation` header):
|
|
102
|
+
```json
|
|
103
|
+
[
|
|
104
|
+
{
|
|
105
|
+
"id": "248373e1-0aea-45ce-8844-5ef259203749",
|
|
106
|
+
"name": "John Doe",
|
|
107
|
+
"email": "john@example.com",
|
|
108
|
+
"createdAt": "2025-07-18T05:37:24.338Z",
|
|
109
|
+
"updatedAt": "2025-07-18T05:37:24.338Z"
|
|
110
|
+
}
|
|
111
|
+
]
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Example:
|
|
115
|
+
```bash
|
|
116
|
+
# Mac/Linux
|
|
117
|
+
curl -X POST http://localhost:7130/api/database/records/comments \
|
|
118
|
+
-H 'Authorization: Bearer <token>' \
|
|
119
|
+
-H 'Content-Type: application/json' \
|
|
120
|
+
-H 'Prefer: return=representation' \
|
|
121
|
+
-d '[{"user_id": "from-localStorage", "post_id": "post-uuid", "content": "Great"}]'
|
|
122
|
+
|
|
123
|
+
# Windows PowerShell (use curl.exe) - different quotes needed for nested JSON
|
|
124
|
+
curl.exe -X POST http://localhost:7130/api/database/records/comments \
|
|
125
|
+
-H "Authorization: Bearer <token>" \
|
|
126
|
+
-H "Content-Type: application/json" \
|
|
127
|
+
-H "Prefer: return=representation" \
|
|
128
|
+
-d '[{\"user_id\": \"from-localStorage\", \"post_id\": \"post-uuid\", \"content\": \"Great\"}]'
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### Update Record
|
|
132
|
+
**PATCH** `/api/database/records/:tableName?id=eq.uuid`
|
|
133
|
+
|
|
134
|
+
**AUTHENTICATION REQUIRED**
|
|
135
|
+
|
|
136
|
+
**⚠️ IMPORTANT: PATCH Limitations**
|
|
137
|
+
- **PostgREST does NOT support SQL expressions** like `count + 1`
|
|
138
|
+
- You must fetch the current value and calculate in your code:
|
|
139
|
+
|
|
140
|
+
```javascript
|
|
141
|
+
// ❌ WRONG - This will NOT work
|
|
142
|
+
await api.patch(`/api/database/records/posts?id=eq.${postId}`, {
|
|
143
|
+
comments_count: 'comments_count + 1' // PostgREST doesn't evaluate expressions!
|
|
144
|
+
});
|
|
145
|
+
|
|
146
|
+
// ✅ CORRECT - Fetch and calculate
|
|
147
|
+
const post = await api.get(`/api/database/records/posts?id=eq.${postId}`);
|
|
148
|
+
await api.patch(`/api/database/records/posts?id=eq.${postId}`, {
|
|
149
|
+
comments_count: post.data[0].comments_count + 1
|
|
150
|
+
});
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
**Default Response Behavior**
|
|
154
|
+
- **By default, PATCH requests return an empty array `[]`**
|
|
155
|
+
- **To get the updated record in the response, you MUST include the header:**
|
|
156
|
+
```
|
|
157
|
+
Prefer: return=representation
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
Send fields to update:
|
|
161
|
+
```json
|
|
162
|
+
{
|
|
163
|
+
"field1": "new_value"
|
|
164
|
+
}
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
Response format (WITHOUT `Prefer: return=representation` header - default):
|
|
168
|
+
```json
|
|
169
|
+
""
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
Response format (WITH `Prefer: return=representation` header):
|
|
173
|
+
```json
|
|
174
|
+
[
|
|
175
|
+
{
|
|
176
|
+
"id": "123e4567-e89b-12d3-a456-426614174000",
|
|
177
|
+
"field1": "new_value",
|
|
178
|
+
"createdAt": "2025-01-01T00:00:00Z",
|
|
179
|
+
"updatedAt": "2025-01-21T11:00:00Z"
|
|
180
|
+
}
|
|
181
|
+
]
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### Delete Record
|
|
185
|
+
**DELETE** `/api/database/records/:tableName?id=eq.uuid`
|
|
186
|
+
|
|
187
|
+
**AUTHENTICATION REQUIRED**
|
|
188
|
+
|
|
189
|
+
**⚠️ IMPORTANT: Delete Behavior**
|
|
190
|
+
- **Without `Prefer: return=representation`**: Returns `204 No Content` (no body)
|
|
191
|
+
- **With `Prefer: return=representation`**: Returns `200 OK` with:
|
|
192
|
+
- `[{...}]` - Array containing deleted record(s) if found
|
|
193
|
+
- `[]` - Empty array if record didn't exist
|
|
194
|
+
- **DELETE is idempotent**: No error if record doesn't exist
|
|
195
|
+
|
|
196
|
+
Response format (WITHOUT `Prefer` header - default):
|
|
197
|
+
```
|
|
198
|
+
204 No Content (no body)
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
Response format (WITH `Prefer: return=representation` header):
|
|
202
|
+
```json
|
|
203
|
+
// If record existed and was deleted:
|
|
204
|
+
[
|
|
205
|
+
{
|
|
206
|
+
"id": "123e4567-e89b-12d3-a456-426614174000",
|
|
207
|
+
"name": "Deleted User",
|
|
208
|
+
"createdAt": "2025-01-01T00:00:00Z",
|
|
209
|
+
"updatedAt": "2025-01-21T11:00:00Z"
|
|
210
|
+
}
|
|
211
|
+
]
|
|
212
|
+
|
|
213
|
+
// If record didn't exist (already deleted or never existed):
|
|
214
|
+
[]
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
## Error Response Format
|
|
218
|
+
|
|
219
|
+
All error responses follow this format:
|
|
220
|
+
```json
|
|
221
|
+
{
|
|
222
|
+
"error": "ERROR_CODE",
|
|
223
|
+
"message": "Human-readable error message",
|
|
224
|
+
"statusCode": 400,
|
|
225
|
+
"nextActions": "Suggested action to resolve the error"
|
|
226
|
+
}
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
Example error:
|
|
230
|
+
```json
|
|
231
|
+
{
|
|
232
|
+
"error": "TABLE_NOT_FOUND",
|
|
233
|
+
"message": "Table 'nonexistent' does not exist",
|
|
234
|
+
"statusCode": 404,
|
|
235
|
+
"nextActions": "Check table name and try again"
|
|
236
|
+
}
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
## Pagination
|
|
240
|
+
|
|
241
|
+
For paginated results, use the `Range` header:
|
|
242
|
+
```bash
|
|
243
|
+
# Windows PowerShell: use curl.exe
|
|
244
|
+
curl "http://localhost:7130/api/database/records/posts" \
|
|
245
|
+
-H "Range: 0-9" \
|
|
246
|
+
-H "Prefer: count=exact"
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
Response includes `Content-Range` header:
|
|
250
|
+
```
|
|
251
|
+
Content-Range: 0-9/100 # Shows items 0-9 out of 100 total
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
Without `Prefer: count=exact`, you get: `Content-Range: 0-9/*` (no total count)
|
|
255
|
+
|
|
256
|
+
## 🚨 Working with User Data
|
|
257
|
+
|
|
258
|
+
**The `users` table stores user profiles:**
|
|
259
|
+
- **✅ READ**: `GET /api/database/records/users` - Get user profiles
|
|
260
|
+
- **✅ WRITE**: `PATCH /api/database/records/users?id=eq.<user_id>` - Update profiles
|
|
261
|
+
|
|
262
|
+
**Schema:**
|
|
263
|
+
- `id` - User ID (UUID, references auth system)
|
|
264
|
+
- `nickname` - Display name (text, nullable)
|
|
265
|
+
- `avatar_url` - Profile picture URL (text, nullable)
|
|
266
|
+
- `bio` - User biography (text, nullable)
|
|
267
|
+
- `birthday` - Birth date (date, nullable)
|
|
268
|
+
- `created_at` - Profile creation timestamp
|
|
269
|
+
- `updated_at` - Last update timestamp
|
|
270
|
+
|
|
271
|
+
**Important:**
|
|
272
|
+
- User accounts (email, password) are managed via Auth API only
|
|
273
|
+
- The `users` table is automatically created when a user registers
|
|
274
|
+
- Use `users.id` for foreign key references in your tables
|
|
275
|
+
|
|
276
|
+
**Creating tables with user references:**
|
|
277
|
+
```json
|
|
278
|
+
{
|
|
279
|
+
"table_name": "posts",
|
|
280
|
+
"columns": [
|
|
281
|
+
{"name": "user_id", "type": "string", "nullable": false,
|
|
282
|
+
"foreign_key": {"reference_table": "users", "reference_column": "id",
|
|
283
|
+
"on_delete": "CASCADE", "on_update": "CASCADE"}},
|
|
284
|
+
{"name": "content", "type": "string", "nullable": false}
|
|
285
|
+
]
|
|
286
|
+
}
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
## 🚨 Critical: Always Include user_id
|
|
290
|
+
|
|
291
|
+
**Every user-related table MUST include user_id field from localStorage:**
|
|
292
|
+
|
|
293
|
+
```javascript
|
|
294
|
+
// Frontend: Get user_id from localStorage after login
|
|
295
|
+
const userId = localStorage.getItem('user_id');
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
```bash
|
|
299
|
+
# ❌ WRONG - Missing user_id
|
|
300
|
+
curl -X POST http://localhost:7130/api/database/records/comments \
|
|
301
|
+
-H "Authorization: Bearer TOKEN" \
|
|
302
|
+
-d '[{"content": "Great post"}]'
|
|
303
|
+
|
|
304
|
+
# ✅ CORRECT - Includes user_id
|
|
305
|
+
# Mac/Linux
|
|
306
|
+
curl -X POST http://localhost:7130/api/database/records/comments \
|
|
307
|
+
-H 'Authorization: Bearer TOKEN' \
|
|
308
|
+
-H 'Prefer: return=representation' \
|
|
309
|
+
-d '[{"content": "Great post", "user_id": "user-uuid-from-localStorage"}]'
|
|
310
|
+
|
|
311
|
+
# Windows PowerShell (use curl.exe) - different quotes needed for nested JSON
|
|
312
|
+
curl.exe -X POST http://localhost:7130/api/database/records/comments \
|
|
313
|
+
-H "Authorization: Bearer TOKEN" \
|
|
314
|
+
-H "Prefer: return=representation" \
|
|
315
|
+
-d '[{\"content\": \"Great post\", \"user_id\": \"user-uuid-from-localStorage\"}]'
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
**Required for all user-related operations:**
|
|
319
|
+
- Creating posts, comments, likes, follows
|
|
320
|
+
- Any table with a `user_id` foreign key
|
|
321
|
+
- Without it, your INSERT will fail with missing field error
|
|
322
|
+
|
|
323
|
+
## Important Rules
|
|
324
|
+
|
|
325
|
+
1. **Authentication Summary**:
|
|
326
|
+
| Operation | Auth Required | Header |
|
|
327
|
+
|-----------|--------------|--------|
|
|
328
|
+
| GET (read) | ❌ No | None needed |
|
|
329
|
+
| POST (create) | ✅ Yes | `Authorization: Bearer <token>` |
|
|
330
|
+
| PATCH (update) | ✅ Yes | `Authorization: Bearer <token>` |
|
|
331
|
+
| DELETE | ✅ Yes | `Authorization: Bearer <token>` |
|
|
332
|
+
|
|
333
|
+
2. **Auto-Generated Fields**
|
|
334
|
+
- `id` - UUID primary key (auto-generated)
|
|
335
|
+
- `createdAt` - Timestamp (auto-set)
|
|
336
|
+
- `updatedAt` - Timestamp (auto-updated)
|
|
337
|
+
|
|
338
|
+
2. **System Tables**
|
|
339
|
+
- Tables prefixed with `_` are system tables (protected)
|
|
340
|
+
- User profiles stored in `users` table (read/write allowed)
|
|
341
|
+
- Account management only through Auth API (register/login)
|
|
342
|
+
|
|
343
|
+
3. **Common PostgREST Errors**:
|
|
344
|
+
```json
|
|
345
|
+
{"code": "42501", "message": "permission denied for table comments"}
|
|
346
|
+
// Means: User not authenticated for write operation
|
|
347
|
+
|
|
348
|
+
{"code": "PGRST301", "message": "JWSError (CompactDecodeError Invalid number of parts: Expected 3 parts; got 1)"}
|
|
349
|
+
// Means: Invalid or expired token - user needs to login again
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
4. **Remember**
|
|
353
|
+
- READ operations are public (no auth needed)
|
|
354
|
+
- WRITE operations require token from login
|
|
355
|
+
- POST needs array `[{...}]` even for single record
|
|
356
|
+
- Add `Prefer: return=representation` to see created/updated data
|
|
357
|
+
- PATCH cannot use SQL expressions - calculate in JavaScript
|
|
358
|
+
- Tokens from login work directly as Bearer tokens
|
|
359
|
+
- Always include `user_id` in user-related tables
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# InsForge Database SDK
|
|
2
|
+
|
|
3
|
+
## Setup
|
|
4
|
+
```javascript
|
|
5
|
+
import { createClient } from '@insforge/sdk';
|
|
6
|
+
const client = createClient({ baseUrl: 'http://localhost:7130' });
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Query Builder
|
|
10
|
+
|
|
11
|
+
### from(table)
|
|
12
|
+
```javascript
|
|
13
|
+
client.database.from('posts') // Returns QueryBuilder
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Operations
|
|
17
|
+
|
|
18
|
+
### select
|
|
19
|
+
```javascript
|
|
20
|
+
.select() // All columns
|
|
21
|
+
.select('id, title') // Specific columns
|
|
22
|
+
.select('*, user:user_id(name, email)') // Foreign key expansion
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### insert
|
|
26
|
+
```javascript
|
|
27
|
+
.insert({ title: 'Hello' }).select() // Single record with data returned
|
|
28
|
+
.insert([{...}, {...}]).select() // Multiple records with data returned
|
|
29
|
+
// Note: Always sends array to API
|
|
30
|
+
// Without .select(), returns null data
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### update
|
|
34
|
+
```javascript
|
|
35
|
+
.update({ title: 'Updated' }).eq('id', '123').select()
|
|
36
|
+
// Must chain with filter and .select() to return data
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### delete
|
|
40
|
+
```javascript
|
|
41
|
+
.delete().eq('id', '123').select()
|
|
42
|
+
// Must chain with filter and .select() to return data
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### upsert
|
|
46
|
+
```javascript
|
|
47
|
+
.upsert({ id: '123', title: 'New or Update' }).select()
|
|
48
|
+
// Updates if exists, inserts if not
|
|
49
|
+
// Use .select() to return data
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Filters
|
|
53
|
+
|
|
54
|
+
```javascript
|
|
55
|
+
.eq('col', value) // column = value
|
|
56
|
+
.neq('col', value) // column != value
|
|
57
|
+
.gt('col', value) // column > value
|
|
58
|
+
.gte('col', value) // column >= value
|
|
59
|
+
.lt('col', value) // column < value
|
|
60
|
+
.lte('col', value) // column <= value
|
|
61
|
+
.like('col', '%pat%') // LIKE pattern
|
|
62
|
+
.ilike('col', '%pat%') // ILIKE pattern
|
|
63
|
+
.is('col', null) // IS NULL
|
|
64
|
+
.in('col', [1,2,3]) // IN array
|
|
65
|
+
|
|
66
|
+
.or('status.eq.active,status.eq.pending') // OR condition
|
|
67
|
+
.and('price.gte.100,price.lte.500') // Explicit AND
|
|
68
|
+
.not('deleted', 'is.true') // NOT condition
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### OR Examples
|
|
72
|
+
```javascript
|
|
73
|
+
// Simple OR
|
|
74
|
+
.or('status.eq.active,status.eq.pending')
|
|
75
|
+
// WHERE status = 'active' OR status = 'pending'
|
|
76
|
+
|
|
77
|
+
// OR with other filters (implicit AND)
|
|
78
|
+
.eq('user_id', '123')
|
|
79
|
+
.or('status.eq.draft,status.eq.published')
|
|
80
|
+
// WHERE user_id = '123' AND (status = 'draft' OR status = 'published')
|
|
81
|
+
|
|
82
|
+
// Complex OR with NOT
|
|
83
|
+
.or('age.lt.18,age.gt.65,not.is_active.is.true')
|
|
84
|
+
// WHERE age < 18 OR age > 65 OR NOT is_active
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Modifiers
|
|
88
|
+
|
|
89
|
+
```javascript
|
|
90
|
+
.order('col') // ASC
|
|
91
|
+
.order('col', { ascending: false }) // DESC
|
|
92
|
+
.limit(10)
|
|
93
|
+
.offset(20)
|
|
94
|
+
.range(0, 9) // Headers: Range: 0-9
|
|
95
|
+
.single() // Return object not array
|
|
96
|
+
.count('exact') // Include total count
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## Execute
|
|
100
|
+
|
|
101
|
+
```javascript
|
|
102
|
+
// Methods are thenable
|
|
103
|
+
const { data, error } = await client.database
|
|
104
|
+
.from('posts')
|
|
105
|
+
.select()
|
|
106
|
+
.eq('user_id', '123')
|
|
107
|
+
.limit(10);
|
|
108
|
+
|
|
109
|
+
// data: array or null
|
|
110
|
+
// error: { message, statusCode, code } or null
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
## Foreign Key Expansion
|
|
114
|
+
|
|
115
|
+
```javascript
|
|
116
|
+
// PostgREST syntax
|
|
117
|
+
.select('*, user:user_id(name, email)')
|
|
118
|
+
|
|
119
|
+
// Response:
|
|
120
|
+
{
|
|
121
|
+
id: '123',
|
|
122
|
+
title: 'Post',
|
|
123
|
+
user_id: '456',
|
|
124
|
+
user: { name: 'John', email: 'john@example.com' }
|
|
125
|
+
}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## Users Table
|
|
129
|
+
|
|
130
|
+
```javascript
|
|
131
|
+
// Profile data (not auth)
|
|
132
|
+
await client.database.from('users').select().eq('id', userId).single()
|
|
133
|
+
await client.database.from('users').update({ nickname, avatar_url }).eq('id', userId).select()
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## Notes
|
|
137
|
+
- Uses PostgREST under the hood
|
|
138
|
+
- POST requires array format `[{...}]`
|
|
139
|
+
- All methods return QueryBuilder for chaining
|
|
140
|
+
- Execute returns `{ data, error }`
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
# InsForge Debug SDK
|
|
2
|
+
|
|
3
|
+
## Common SDK Errors
|
|
4
|
+
|
|
5
|
+
### Auth Errors
|
|
6
|
+
```javascript
|
|
7
|
+
// Token not stored
|
|
8
|
+
{ code: 'MISSING_AUTHORIZATION_HEADER' }
|
|
9
|
+
// Fix: User needs to login
|
|
10
|
+
|
|
11
|
+
// Token expired
|
|
12
|
+
{ code: 'INVALID_TOKEN' }
|
|
13
|
+
// Fix: client.auth.signInWithPassword()
|
|
14
|
+
|
|
15
|
+
// Invalid credentials
|
|
16
|
+
{ code: 'INVALID_CREDENTIALS' }
|
|
17
|
+
// Fix: Check email/password
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### Database Errors
|
|
21
|
+
```javascript
|
|
22
|
+
// Table doesn't exist
|
|
23
|
+
{ statusCode: 404, message: 'Table not found' }
|
|
24
|
+
// Fix: Use MCP tool to create table
|
|
25
|
+
|
|
26
|
+
// Missing required field
|
|
27
|
+
{ code: '23502', message: 'null value in column "user_id"' }
|
|
28
|
+
// Fix: Include all required fields
|
|
29
|
+
|
|
30
|
+
// Foreign key violation
|
|
31
|
+
{ code: '23503', message: 'violates foreign key constraint' }
|
|
32
|
+
// Fix: Referenced record must exist
|
|
33
|
+
|
|
34
|
+
// Permission denied
|
|
35
|
+
{ code: '42501', message: 'permission denied for table' }
|
|
36
|
+
// Fix: User must be authenticated
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Debug Techniques
|
|
40
|
+
|
|
41
|
+
### 1. Check Authentication
|
|
42
|
+
```javascript
|
|
43
|
+
const { data, error } = await client.auth.getCurrentUser();
|
|
44
|
+
if (error) {
|
|
45
|
+
console.log('Not authenticated:', error.message);
|
|
46
|
+
// Need to login first
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### 2. Verify Token Storage
|
|
51
|
+
```javascript
|
|
52
|
+
const { data } = await client.auth.getCurrentSession();
|
|
53
|
+
console.log('Stored token:', data?.session?.accessToken ? 'Present' : 'Missing');
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### 3. Test Database Connection
|
|
57
|
+
```javascript
|
|
58
|
+
// Simple query to test connection
|
|
59
|
+
const { error } = await client.database.from('users').select().limit(1);
|
|
60
|
+
if (error) {
|
|
61
|
+
console.log('Database issue:', error);
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### 4. Enable Network Inspection
|
|
66
|
+
```javascript
|
|
67
|
+
// Browser: Open DevTools > Network tab
|
|
68
|
+
// Check request headers for Authorization: Bearer token
|
|
69
|
+
// Check response for error details
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### 5. Test With Raw HTTP
|
|
73
|
+
```javascript
|
|
74
|
+
// When SDK fails, test endpoint directly
|
|
75
|
+
const response = await fetch('http://localhost:7130/api/database/records/posts', {
|
|
76
|
+
headers: {
|
|
77
|
+
'Authorization': 'Bearer ' + token
|
|
78
|
+
}
|
|
79
|
+
});
|
|
80
|
+
const data = await response.json();
|
|
81
|
+
console.log('Raw response:', data);
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Common Issues
|
|
85
|
+
|
|
86
|
+
### Empty Response
|
|
87
|
+
```javascript
|
|
88
|
+
// INSERT/UPDATE/DELETE return empty without Prefer header
|
|
89
|
+
// SDK handles this automatically, but check if using raw API
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Array Format
|
|
93
|
+
```javascript
|
|
94
|
+
// POST requires array
|
|
95
|
+
// ❌ Wrong: { title: 'Test' }
|
|
96
|
+
// ✅ Right: [{ title: 'Test' }]
|
|
97
|
+
// SDK handles this automatically
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Token Not Persisting
|
|
101
|
+
```javascript
|
|
102
|
+
// Check storage adapter
|
|
103
|
+
const client = createClient({
|
|
104
|
+
baseUrl: 'http://localhost:7130',
|
|
105
|
+
});
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### CORS Issues
|
|
109
|
+
```javascript
|
|
110
|
+
// Backend allows all origins by default
|
|
111
|
+
// If modified, check backend CORS settings
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## Test Utilities
|
|
115
|
+
|
|
116
|
+
### Full Test Suite
|
|
117
|
+
```javascript
|
|
118
|
+
async function testSDK() {
|
|
119
|
+
const email = `test-${Date.now()}@example.com`;
|
|
120
|
+
|
|
121
|
+
// Test auth
|
|
122
|
+
console.log('Testing auth...');
|
|
123
|
+
const { error: signUpError } = await client.auth.signUp({ email, password: 'test123' });
|
|
124
|
+
if (signUpError) return console.error('SignUp failed:', signUpError);
|
|
125
|
+
|
|
126
|
+
// Test current user
|
|
127
|
+
const { data: user, error: userError } = await client.auth.getCurrentUser();
|
|
128
|
+
if (userError) return console.error('GetUser failed:', userError);
|
|
129
|
+
console.log('✅ Auth working, user:', user.user.id);
|
|
130
|
+
|
|
131
|
+
// Test database
|
|
132
|
+
console.log('Testing database...');
|
|
133
|
+
const { data: posts, error: dbError } = await client.database.from('posts').select().limit(1);
|
|
134
|
+
if (dbError) return console.error('Database failed:', dbError);
|
|
135
|
+
console.log('✅ Database working, posts:', posts.length);
|
|
136
|
+
|
|
137
|
+
// Test insert
|
|
138
|
+
const { error: insertError } = await client.database
|
|
139
|
+
.from('posts')
|
|
140
|
+
.insert({ title: 'Test', user_id: user.user.id })
|
|
141
|
+
.select();
|
|
142
|
+
if (insertError) return console.error('Insert failed:', insertError);
|
|
143
|
+
console.log('✅ Insert working');
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
testSDK().catch(console.error);
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
## Backend Verification
|
|
150
|
+
|
|
151
|
+
```javascript
|
|
152
|
+
// Check backend is running
|
|
153
|
+
fetch('http://localhost:7130/api/health')
|
|
154
|
+
.then(r => r.json())
|
|
155
|
+
.then(d => console.log('Backend:', d))
|
|
156
|
+
.catch(e => console.error('Backend not running'));
|
|
157
|
+
```
|