insforge 1.2.10 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (335) hide show
  1. package/.claude-plugin/marketplace.json +20 -20
  2. package/.dockerignore +60 -60
  3. package/.env.example +83 -77
  4. package/.github/ISSUE_TEMPLATE/bug_report.yml +36 -36
  5. package/.github/ISSUE_TEMPLATE/config.yml +11 -11
  6. package/.github/ISSUE_TEMPLATE/feature_request.yml +26 -26
  7. package/.github/PULL_REQUEST_TEMPLATE.md +7 -7
  8. package/.github/copilot-instructions.md +146 -146
  9. package/.github/workflows/build-image.yml +65 -65
  10. package/.github/workflows/ci-premerge-check.yml +23 -23
  11. package/.github/workflows/e2e.yml +63 -63
  12. package/.github/workflows/lint-and-format.yml +32 -32
  13. package/.prettierignore +64 -64
  14. package/CHANGELOG.md +44 -44
  15. package/CLAUDE_PLUGIN.md +104 -104
  16. package/CODE_OF_CONDUCT.md +128 -128
  17. package/CONTRIBUTING.md +125 -125
  18. package/Dockerfile +30 -30
  19. package/GITHUB_OAUTH_SETUP.md +49 -49
  20. package/GOOGLE_OAUTH_SETUP.md +148 -148
  21. package/LICENSE +201 -201
  22. package/README.md +182 -182
  23. package/assets/Dark.svg +23 -23
  24. package/auth/package.json +28 -28
  25. package/auth/src/lib/broadcastService.ts +117 -115
  26. package/auth/src/pages/SignInPage.tsx +60 -57
  27. package/auth/src/pages/SignUpPage.tsx +60 -57
  28. package/auth/tsconfig.json +32 -32
  29. package/auth/tsconfig.node.json +11 -11
  30. package/backend/package.json +78 -75
  31. package/backend/src/api/routes/ai/index.routes.ts +3 -3
  32. package/backend/src/api/routes/auth/index.routes.ts +667 -570
  33. package/backend/src/api/routes/auth/oauth.routes.ts +473 -448
  34. package/backend/src/api/routes/database/advance.routes.ts +37 -16
  35. package/backend/src/api/routes/database/index.routes.ts +78 -1
  36. package/backend/src/api/routes/database/records.routes.ts +10 -10
  37. package/backend/src/api/routes/database/tables.routes.ts +0 -14
  38. package/backend/src/api/routes/docs/index.routes.ts +75 -76
  39. package/backend/src/api/routes/email/index.routes.ts +35 -0
  40. package/backend/src/api/routes/functions/index.routes.ts +18 -12
  41. package/backend/src/api/routes/metadata/index.routes.ts +12 -0
  42. package/backend/src/api/routes/realtime/channels.routes.ts +81 -0
  43. package/backend/src/api/routes/realtime/index.routes.ts +12 -0
  44. package/backend/src/api/routes/realtime/messages.routes.ts +48 -0
  45. package/backend/src/api/routes/realtime/permissions.routes.ts +19 -0
  46. package/backend/src/api/routes/storage/index.routes.ts +18 -12
  47. package/backend/src/api/routes/usage/index.routes.ts +6 -4
  48. package/backend/src/infra/database/database.manager.ts +14 -1
  49. package/backend/src/infra/database/migrations/000_create-base-tables.sql +141 -141
  50. package/backend/src/infra/database/migrations/001_create-helper-functions.sql +40 -40
  51. package/backend/src/infra/database/migrations/002_rename-auth-tables.sql +29 -29
  52. package/backend/src/infra/database/migrations/003_create-users-table.sql +55 -55
  53. package/backend/src/infra/database/migrations/004_add-reload-postgrest-func.sql +23 -23
  54. package/backend/src/infra/database/migrations/005_enable-project-admin-modify-users.sql +29 -29
  55. package/backend/src/infra/database/migrations/006_modify-ai-usage-table.sql +24 -24
  56. package/backend/src/infra/database/migrations/007_drop-metadata-table.sql +1 -1
  57. package/backend/src/infra/database/migrations/008_add-system-tables.sql +76 -76
  58. package/backend/src/infra/database/migrations/009_add-function-secrets.sql +23 -23
  59. package/backend/src/infra/database/migrations/010_modify-ai-config-modalities.sql +93 -93
  60. package/backend/src/infra/database/migrations/011_refactor-secrets-table.sql +15 -15
  61. package/backend/src/infra/database/migrations/012_add-storage-uploaded-by.sql +7 -7
  62. package/backend/src/infra/database/migrations/013_create-auth-schema-functions.sql +44 -44
  63. package/backend/src/infra/database/migrations/014_add-updated-at-trigger-user-table.sql +7 -7
  64. package/backend/src/infra/database/migrations/015_create-auth-config-and-email-otp-tables.sql +59 -59
  65. package/backend/src/infra/database/migrations/016_update-auth-config-and-email-otp.sql +24 -24
  66. package/backend/src/infra/database/migrations/017_create-realtime-schema.sql +233 -0
  67. package/backend/src/infra/realtime/realtime.manager.ts +246 -0
  68. package/backend/src/infra/realtime/webhook-sender.ts +82 -0
  69. package/backend/src/infra/security/token.manager.ts +219 -125
  70. package/backend/src/infra/socket/socket.manager.ts +198 -64
  71. package/backend/src/providers/ai/openrouter.provider.ts +12 -9
  72. package/backend/src/providers/email/base.provider.ts +4 -7
  73. package/backend/src/providers/email/cloud.provider.ts +84 -0
  74. package/backend/src/providers/oauth/apple.provider.ts +266 -0
  75. package/backend/src/providers/oauth/index.ts +1 -0
  76. package/backend/src/server.ts +317 -284
  77. package/backend/src/services/ai/ai-model.service.ts +5 -5
  78. package/backend/src/services/ai/chat-completion.service.ts +4 -4
  79. package/backend/src/services/ai/image-generation.service.ts +3 -3
  80. package/backend/src/services/auth/auth.service.ts +14 -0
  81. package/backend/src/services/database/database-table.service.ts +0 -9
  82. package/backend/src/services/database/database.service.ts +127 -0
  83. package/backend/src/services/email/email.service.ts +5 -7
  84. package/backend/src/services/realtime/index.ts +3 -0
  85. package/backend/src/services/realtime/realtime-auth.service.ts +104 -0
  86. package/backend/src/services/realtime/realtime-channel.service.ts +237 -0
  87. package/backend/src/services/realtime/realtime-message.service.ts +260 -0
  88. package/backend/src/types/auth.ts +11 -0
  89. package/backend/src/types/realtime.ts +18 -0
  90. package/backend/src/types/socket.ts +7 -31
  91. package/backend/src/utils/cookies.ts +35 -0
  92. package/backend/src/utils/s3-config-loader.ts +64 -0
  93. package/backend/src/utils/seed.ts +301 -298
  94. package/backend/src/utils/sql-parser.ts +90 -0
  95. package/backend/tests/README.md +133 -133
  96. package/backend/tests/cleanup-all-test-data.sh +230 -230
  97. package/backend/tests/cloud/test-s3-multitenant.sh +131 -131
  98. package/backend/tests/local/comprehensive-curl-tests.sh +155 -155
  99. package/backend/tests/local/test-ai-config.sh +129 -129
  100. package/backend/tests/local/test-ai-usage.sh +80 -80
  101. package/backend/tests/local/test-auth-router.sh +143 -143
  102. package/backend/tests/local/test-database-router.sh +222 -222
  103. package/backend/tests/local/test-e2e.sh +240 -240
  104. package/backend/tests/local/test-fk-errors.sh +96 -96
  105. package/backend/tests/local/test-functions.sh +123 -123
  106. package/backend/tests/local/test-id-field.sh +200 -200
  107. package/backend/tests/local/test-logs.sh +132 -132
  108. package/backend/tests/local/test-public-bucket.sh +264 -264
  109. package/backend/tests/local/test-secrets.sh +249 -249
  110. package/backend/tests/local/test-serverless-functions.sh.disabled +325 -325
  111. package/backend/tests/local/test-traditional-rest.sh +208 -208
  112. package/backend/tests/manual/README.md +50 -50
  113. package/backend/tests/manual/create-large-table-simple.sql +10 -10
  114. package/backend/tests/manual/seed-large-table.sql +100 -100
  115. package/backend/tests/manual/setup-large-table-extras.sql +33 -33
  116. package/backend/tests/manual/test-bulk-upsert.sh +409 -409
  117. package/backend/tests/manual/test-database-advance.sh +296 -296
  118. package/backend/tests/manual/test-postgrest-stability.sh +191 -191
  119. package/backend/tests/manual/test-rawsql-export-import.sh +411 -411
  120. package/backend/tests/manual/test-rawsql-modes.sh +244 -244
  121. package/backend/tests/manual/test-universal-storage.sh +263 -263
  122. package/backend/tests/manual/test-users.sql +17 -17
  123. package/backend/tests/run-all-tests.sh +139 -139
  124. package/backend/tests/setup.ts +0 -0
  125. package/backend/tests/test-config.sh +338 -338
  126. package/backend/tests/unit/analyze-query.test.ts +697 -0
  127. package/backend/tsconfig.json +22 -22
  128. package/claude-plugin/.claude-plugin/plugin.json +24 -24
  129. package/claude-plugin/README.md +133 -133
  130. package/claude-plugin/skills/insforge-schema-patterns/SKILL.md +270 -270
  131. package/docker-compose.prod.yml +204 -200
  132. package/docker-compose.yml +232 -228
  133. package/docker-init/db/db-init.sql +97 -97
  134. package/docker-init/db/jwt.sql +5 -5
  135. package/docker-init/db/postgresql.conf +16 -16
  136. package/docker-init/logs/vector.yml +236 -236
  137. package/docs/README.md +44 -44
  138. package/docs/agent-docs/real-time.md +269 -0
  139. package/docs/changelog.mdx +119 -67
  140. package/docs/core-concepts/ai/architecture.mdx +372 -372
  141. package/docs/core-concepts/ai/sdk.mdx +213 -213
  142. package/docs/core-concepts/authentication/architecture.mdx +278 -278
  143. package/docs/core-concepts/authentication/sdk.mdx +414 -414
  144. package/docs/core-concepts/authentication/ui-components/customization.mdx +529 -529
  145. package/docs/core-concepts/authentication/ui-components/nextjs.mdx +221 -221
  146. package/docs/core-concepts/authentication/ui-components/react-router.mdx +184 -184
  147. package/docs/core-concepts/authentication/ui-components/react.mdx +129 -129
  148. package/docs/core-concepts/database/architecture.mdx +255 -255
  149. package/docs/core-concepts/database/sdk.mdx +382 -382
  150. package/docs/core-concepts/email/architecture.mdx +101 -0
  151. package/docs/core-concepts/email/sdk.mdx +53 -0
  152. package/docs/core-concepts/functions/architecture.mdx +105 -105
  153. package/docs/core-concepts/functions/sdk.mdx +184 -184
  154. package/docs/core-concepts/realtime/architecture.mdx +446 -0
  155. package/docs/core-concepts/realtime/sdk.mdx +409 -0
  156. package/docs/core-concepts/storage/architecture.mdx +243 -243
  157. package/docs/core-concepts/storage/sdk.mdx +253 -253
  158. package/docs/deployment/README.md +94 -94
  159. package/docs/deployment/deploy-to-aws-ec2.md +564 -564
  160. package/docs/deployment/deploy-to-azure-virtual-machines.md +312 -312
  161. package/docs/deployment/deploy-to-google-cloud-compute-engine.md +613 -613
  162. package/docs/deployment/deploy-to-render.md +441 -441
  163. package/docs/deprecated/insforge-auth-api.md +214 -214
  164. package/docs/deprecated/insforge-auth-sdk.md +99 -99
  165. package/docs/deprecated/insforge-db-api.md +358 -358
  166. package/docs/deprecated/insforge-db-sdk.md +139 -139
  167. package/docs/deprecated/insforge-debug-sdk.md +156 -156
  168. package/docs/deprecated/insforge-debug.md +64 -64
  169. package/docs/deprecated/insforge-instructions.md +123 -123
  170. package/docs/deprecated/insforge-project.md +117 -117
  171. package/docs/deprecated/insforge-storage-api.md +278 -278
  172. package/docs/deprecated/insforge-storage-sdk.md +158 -158
  173. package/docs/docs.json +232 -210
  174. package/docs/examples/framework-guides/nextjs.mdx +131 -131
  175. package/docs/examples/framework-guides/nuxt.mdx +165 -165
  176. package/docs/examples/framework-guides/react.mdx +165 -165
  177. package/docs/examples/framework-guides/svelte.mdx +153 -153
  178. package/docs/examples/framework-guides/vue.mdx +159 -159
  179. package/docs/examples/overview.mdx +67 -67
  180. package/docs/favicon.svg +19 -19
  181. package/docs/images/changelog/dec-2025/ai-integration.png +0 -0
  182. package/docs/images/changelog/dec-2025/ai-models.webp +0 -0
  183. package/docs/images/changelog/dec-2025/alipay-payment.webp +0 -0
  184. package/docs/images/changelog/dec-2025/apple-login.jpg +0 -0
  185. package/docs/images/changelog/dec-2025/mcp-installer.png +0 -0
  186. package/docs/images/changelog/dec-2025/realtime-module.jpg +0 -0
  187. package/docs/images/icons/ai.svg +4 -4
  188. package/docs/images/logos/nextjs.svg +4 -4
  189. package/docs/images/logos/nuxt.svg +4 -4
  190. package/docs/images/logos/react.svg +5 -5
  191. package/docs/images/logos/svelte.svg +4 -4
  192. package/docs/images/logos/vue.svg +5 -5
  193. package/docs/insforge-instructions-sdk.md +89 -88
  194. package/docs/introduction.mdx +45 -45
  195. package/docs/logo/dark.svg +22 -22
  196. package/docs/logo/light.svg +20 -20
  197. package/docs/partnership.mdx +651 -646
  198. package/docs/quickstart.mdx +82 -82
  199. package/docs/showcase.mdx +52 -52
  200. package/docs/snippets/sdk-installation.mdx +21 -21
  201. package/docs/snippets/service-icons.mdx +27 -27
  202. package/examples/oauth/frontend-oauth-example.html +250 -250
  203. package/examples/response-examples.md +443 -443
  204. package/frontend/components.json +17 -17
  205. package/frontend/package.json +69 -69
  206. package/frontend/src/assets/icons/checkbox_checked.svg +6 -6
  207. package/frontend/src/assets/icons/checkbox_undetermined.svg +6 -6
  208. package/frontend/src/assets/icons/checked.svg +3 -3
  209. package/frontend/src/assets/icons/connected.svg +3 -3
  210. package/frontend/src/assets/icons/error.svg +3 -3
  211. package/frontend/src/assets/icons/loader.svg +9 -9
  212. package/frontend/src/assets/icons/pencil.svg +4 -4
  213. package/frontend/src/assets/icons/refresh.svg +4 -4
  214. package/frontend/src/assets/icons/step_active.svg +3 -3
  215. package/frontend/src/assets/icons/step_inactive.svg +11 -11
  216. package/frontend/src/assets/icons/warning.svg +3 -3
  217. package/frontend/src/assets/logos/apple.svg +3 -3
  218. package/frontend/src/assets/logos/claude_code.svg +3 -3
  219. package/frontend/src/assets/logos/cline.svg +6 -6
  220. package/frontend/src/assets/logos/cursor.svg +20 -20
  221. package/frontend/src/assets/logos/discord.svg +8 -8
  222. package/frontend/src/assets/logos/facebook.svg +3 -3
  223. package/frontend/src/assets/logos/gemini.svg +19 -19
  224. package/frontend/src/assets/logos/github.svg +5 -5
  225. package/frontend/src/assets/logos/google.svg +13 -13
  226. package/frontend/src/assets/logos/grok.svg +10 -10
  227. package/frontend/src/assets/logos/insforge_dark.svg +15 -15
  228. package/frontend/src/assets/logos/insforge_light.svg +15 -15
  229. package/frontend/src/assets/logos/instagram.svg +1 -1
  230. package/frontend/src/assets/logos/linkedin.svg +3 -3
  231. package/frontend/src/assets/logos/openai.svg +10 -10
  232. package/frontend/src/assets/logos/roo_code.svg +9 -9
  233. package/frontend/src/assets/logos/spotify.svg +16 -16
  234. package/frontend/src/assets/logos/tiktok.svg +5 -5
  235. package/frontend/src/assets/logos/trae.svg +3 -3
  236. package/frontend/src/assets/logos/windsurf.svg +10 -10
  237. package/frontend/src/assets/logos/x.svg +3 -3
  238. package/frontend/src/components/layout/AppHeader.tsx +9 -10
  239. package/frontend/src/features/auth/components/OAuthConfigDialog.tsx +1 -0
  240. package/frontend/src/features/auth/components/UsersDataGrid.tsx +6 -0
  241. package/frontend/src/features/auth/helpers.tsx +8 -0
  242. package/frontend/src/features/auth/{page → pages}/UsersPage.tsx +0 -28
  243. package/frontend/src/features/database/components/SQLModal.tsx +75 -0
  244. package/frontend/src/features/database/components/TableForm.tsx +0 -4
  245. package/frontend/src/features/database/hooks/useDatabase.ts +66 -0
  246. package/frontend/src/features/database/hooks/useTables.ts +32 -28
  247. package/frontend/src/features/database/index.ts +1 -0
  248. package/frontend/src/features/database/{page → pages}/FunctionsPage.tsx +29 -37
  249. package/frontend/src/features/database/{page → pages}/IndexesPage.tsx +35 -47
  250. package/frontend/src/features/database/{page → pages}/PoliciesPage.tsx +43 -54
  251. package/frontend/src/features/database/{page → pages}/TablesPage.tsx +0 -42
  252. package/frontend/src/features/database/{page → pages}/TriggersPage.tsx +35 -47
  253. package/frontend/src/features/database/services/advance.service.ts +0 -26
  254. package/frontend/src/features/database/services/database.service.ts +55 -0
  255. package/frontend/src/features/database/services/table.service.ts +0 -6
  256. package/frontend/src/features/functions/{page → pages}/FunctionsPage.tsx +21 -44
  257. package/frontend/src/features/functions/{page → pages}/SecretsPage.tsx +11 -9
  258. package/frontend/src/features/logs/hooks/useMcpUsage.ts +13 -66
  259. package/frontend/src/features/realtime/components/ChannelRow.tsx +83 -0
  260. package/frontend/src/features/realtime/components/EditChannelModal.tsx +246 -0
  261. package/frontend/src/features/realtime/components/MessageRow.tsx +85 -0
  262. package/frontend/src/features/realtime/components/RealtimeEmptyState.tsx +30 -0
  263. package/frontend/src/features/realtime/hooks/useRealtime.ts +218 -0
  264. package/frontend/src/features/realtime/index.ts +11 -0
  265. package/frontend/src/features/realtime/pages/RealtimeChannelsPage.tsx +172 -0
  266. package/frontend/src/features/realtime/pages/RealtimeMessagesPage.tsx +211 -0
  267. package/frontend/src/features/realtime/pages/RealtimePermissionsPage.tsx +191 -0
  268. package/frontend/src/features/realtime/services/realtime.service.ts +107 -0
  269. package/frontend/src/features/storage/{page → pages}/StoragePage.tsx +1 -29
  270. package/frontend/src/features/visualizer/components/SchemaVisualizer.tsx +3 -3
  271. package/frontend/src/features/visualizer/{page → pages}/VisualizerPage.tsx +1 -35
  272. package/frontend/src/lib/contexts/SocketContext.tsx +119 -75
  273. package/frontend/src/lib/routing/AppRoutes.tsx +35 -20
  274. package/frontend/src/lib/utils/cloudMessaging.ts +1 -1
  275. package/frontend/src/lib/utils/menuItems.ts +24 -0
  276. package/frontend/src/lib/utils/utils.ts +14 -1
  277. package/frontend/tsconfig.json +25 -25
  278. package/frontend/tsconfig.node.json +9 -9
  279. package/functions/deno.json +24 -24
  280. package/functions/server.ts +315 -315
  281. package/i18n/README.ar.md +130 -130
  282. package/i18n/README.de.md +130 -130
  283. package/i18n/README.es.md +154 -154
  284. package/i18n/README.fr.md +134 -134
  285. package/i18n/README.hi.md +129 -129
  286. package/i18n/README.ja.md +174 -174
  287. package/i18n/README.ko.md +136 -136
  288. package/i18n/README.pt-BR.md +131 -131
  289. package/i18n/README.ru.md +129 -129
  290. package/i18n/README.zh-CN.md +133 -133
  291. package/openapi/ai.yaml +715 -715
  292. package/openapi/auth.yaml +1244 -1244
  293. package/openapi/email.yaml +158 -0
  294. package/openapi/functions.yaml +475 -475
  295. package/openapi/health.yaml +29 -29
  296. package/openapi/logs.yaml +223 -223
  297. package/openapi/metadata.yaml +177 -177
  298. package/openapi/realtime.yaml +699 -0
  299. package/openapi/records.yaml +381 -381
  300. package/openapi/secrets.yaml +370 -370
  301. package/openapi/storage.yaml +875 -875
  302. package/openapi/tables.yaml +463 -463
  303. package/package.json +97 -97
  304. package/shared-schemas/package.json +31 -31
  305. package/shared-schemas/src/ai.schema.ts +63 -59
  306. package/shared-schemas/src/auth-api.schema.ts +352 -339
  307. package/shared-schemas/src/auth.schema.ts +1 -1
  308. package/shared-schemas/src/database-api.schema.ts +32 -1
  309. package/shared-schemas/src/database.schema.ts +39 -0
  310. package/shared-schemas/src/docs.schema.ts +26 -0
  311. package/shared-schemas/src/email-api.schema.ts +30 -0
  312. package/shared-schemas/src/index.ts +4 -0
  313. package/shared-schemas/src/metadata.schema.ts +9 -0
  314. package/shared-schemas/src/realtime-api.schema.ts +111 -0
  315. package/shared-schemas/src/realtime.schema.ts +143 -0
  316. package/shared-schemas/tsconfig.json +21 -21
  317. package/tsconfig.json +7 -7
  318. package/zeabur/README.md +13 -13
  319. package/zeabur/template.yml +1032 -1032
  320. package/.cursor/rules/cursor-rules.mdc +0 -94
  321. package/frontend/src/features/database/hooks/useFullMetadata.ts +0 -18
  322. package/test-gemini.sh +0 -35
  323. package/test-usage-admin.sh +0 -57
  324. package/test-usage.sh +0 -50
  325. /package/frontend/src/features/ai/{page → pages}/AIPage.tsx +0 -0
  326. /package/frontend/src/features/auth/{page → pages}/AuthMethodsPage.tsx +0 -0
  327. /package/frontend/src/features/auth/{page → pages}/ConfigurationPage.tsx +0 -0
  328. /package/frontend/src/features/dashboard/{page → pages}/DashboardPage.tsx +0 -0
  329. /package/frontend/src/features/database/{page → pages}/SQLEditorPage.tsx +0 -0
  330. /package/frontend/src/features/database/{page → pages}/TemplatesPage.tsx +0 -0
  331. /package/frontend/src/features/login/{page → pages}/CloudLoginPage.tsx +0 -0
  332. /package/frontend/src/features/login/{page → pages}/LoginPage.tsx +0 -0
  333. /package/frontend/src/features/logs/{page → pages}/AuditsPage.tsx +0 -0
  334. /package/frontend/src/features/logs/{page → pages}/LogsPage.tsx +0 -0
  335. /package/frontend/src/features/logs/{page → pages}/MCPLogsPage.tsx +0 -0
@@ -1,529 +1,529 @@
1
- ---
2
- title: InsForge Auth Components
3
- description: Framework-agnostic authentication components guidance for customization
4
- ---
5
-
6
- ## Custom Authentication system
7
-
8
- Use this approach when you need custom authentication pages in your application instead of redirecting to hosted pages.
9
-
10
- ### Step-by-Step: Custom Auth Pages Setup
11
-
12
- #### Step 1: Setup Provider (Same as Quick Start)
13
-
14
- The provider setup is identical:
15
-
16
- ```tsx src/main.tsx
17
- import { StrictMode } from 'react';
18
- import { createRoot } from 'react-dom/client';
19
- import { InsforgeProvider } from '@insforge/react-router';
20
- import App from './App';
21
-
22
- createRoot(document.getElementById('root')!).render(
23
- <StrictMode>
24
- <InsforgeProvider
25
- baseUrl={
26
- import.meta.env.VITE_INSFORGE_BASE_URL || 'https://your-app.region.insforge.app' // Replace with your InsForge backend URL
27
- }
28
- afterSignInUrl="/dashboard"
29
- >
30
- <App />
31
- </InsforgeProvider>
32
- </StrictMode>
33
- );
34
- ```
35
-
36
- #### Step 2: Configure Router with Custom Pages
37
-
38
- Set `builtInAuth: false` and provide your page components:
39
-
40
- ```tsx src/App.tsx
41
- import { createBrowserRouter, RouterProvider } from 'react-router-dom';
42
- import { getInsforgeRoutes } from '@insforge/react-router/router';
43
- import Layout from './components/Layout';
44
- import Home from './pages/Home';
45
- import Dashboard from './pages/Dashboard';
46
- // Import your custom auth pages
47
- import SignInPage from './pages/auth/SignInPage';
48
- import SignUpPage from './pages/auth/SignUpPage';
49
- import ForgotPasswordPage from './pages/auth/ForgotPasswordPage';
50
-
51
- const router = createBrowserRouter([
52
- {
53
- path: '/',
54
- element: <Layout />,
55
- children: [
56
- { index: true, element: <Home /> },
57
- { path: 'dashboard', element: <Dashboard /> },
58
- ],
59
- },
60
-
61
- // Custom auth routes
62
- ...getInsforgeRoutes({
63
- baseUrl: import.meta.env.VITE_INSFORGE_BASE_URL || 'https://your-app.region.insforge.app', // Replace with your InsForge backend URL
64
- afterSignInUrl: '/dashboard',
65
- builtInAuth: false, // Render custom components instead of redirecting
66
- pages: {
67
- signIn: <SignInPage />,
68
- signUp: <SignUpPage />,
69
- forgotPassword: <ForgotPasswordPage />,
70
- },
71
- }),
72
- ]);
73
-
74
- export default function App() {
75
- return <RouterProvider router={router} />;
76
- }
77
- ```
78
-
79
- #### Step 3: Create Auth Page Components
80
-
81
- Use our complete authentication components directly. These components are **full-featured page-level components** with all business logic included:
82
-
83
- ```tsx src/pages/auth/SignInPage.tsx
84
- import { SignIn } from '@insforge/react-router';
85
-
86
- export default function SignInPage() {
87
- return (
88
- <div className="h-screen flex items-center justify-center">
89
- <SignIn
90
- title="Welcome Back"
91
- subtitle="Sign in to your account"
92
- onError={(error) => {
93
- console.error('Sign in error:', error);
94
- }}
95
- />
96
- </div>
97
- );
98
- }
99
- ```
100
-
101
- ```tsx src/pages/auth/SignUpPage.tsx
102
- import { SignUp } from '@insforge/react-router';
103
-
104
- export default function SignUpPage() {
105
- return (
106
- <div className="h-screen flex items-center justify-center">
107
- <SignUp
108
- title="Create Account"
109
- subtitle="Get started for free"
110
- onError={(error) => {
111
- console.error('Sign up error:', error);
112
- }}
113
- />
114
- </div>
115
- );
116
- }
117
- ```
118
-
119
- ```tsx src/pages/auth/ForgotPasswordPage.tsx
120
- import { ForgotPassword } from '@insforge/react-router';
121
-
122
- export default function ForgotPasswordPage() {
123
- return (
124
- <div className="h-screen flex items-center justify-center">
125
- <ForgotPassword
126
- onError={(error) => {
127
- console.error('Password reset error:', error);
128
- }}
129
- />
130
- </div>
131
- );
132
- }
133
- ```
134
-
135
- **That's it!** The `<SignIn>`, `<SignUp>`, and `<ForgotPassword>` components are complete page-level components that include:
136
-
137
- - Form UI with validation
138
- - OAuth provider buttons (auto-detected)
139
- - Error handling
140
- - Loading states
141
- - Password strength indicators (SignUp)
142
- - All authentication logic
143
-
144
- You only need to wrap them in your page components for layout/styling purposes.
145
-
146
- ### Key Difference from Built-in Auth
147
-
148
- **Built-in Auth:**
149
-
150
- - `/sign-in` → Redirects to `https://your-app.region.insforge.app/auth/sign-in`
151
- - Authentication happens on hosted page
152
- - Returns to your app with token
153
-
154
- **Custom Components:**
155
-
156
- - `/sign-in` → Renders your `<SignInPage>` component
157
- - Authentication happens in your app
158
- - SDK handles token management automatically
159
-
160
- ---
161
-
162
- ## Features
163
-
164
- - **Built-in Auth**: React Router integration with deployed auth pages
165
- - **Complete Components**: Pre-built `<SignIn>`, `<SignUp>`, `<UserButton>` with business logic
166
- - **OAuth Support**: Google, GitHub, Discord, Facebook, LinkedIn, Microsoft, Apple, X, Instagram, TikTok, Spotify
167
- - **React Hooks**: `useAuth()`, `useUser()`, `usePublicAuthConfig()`
168
- - **Control Components**: `<SignedIn>`, `<SignedOut>`, `<Protect>`
169
- - **Form Components**: Pure UI forms for custom logic
170
- - **TypeScript**: Full type safety
171
-
172
- ---
173
-
174
- ## How It Works
175
-
176
- ### Built-in Auth Flow
177
-
178
- ```
179
- 1. User clicks "Sign In" → Visits /sign-in route
180
-
181
- 2. getInsforgeRoutes() redirects → https://your-app.region.insforge.app/auth/sign-in?redirect=yourapp.com/you-defined-destination-after-sign-in
182
-
183
- 3. User signs in on deployed page → Backend processes authentication
184
-
185
- 4. Backend redirects → yourapp.com/you-defined-destination-after-sign-in?access_token=xxx&user_id=xxx
186
-
187
- 5. InsForge SDK will:
188
- - Extracts token from URL
189
- - Saves to localStorage
190
- - Verifies with getCurrentUser()
191
- - Updates Provider state
192
-
193
- 6. User sees the destination page (e.g /dashboard)
194
- ```
195
-
196
- ### Custom UI Flow
197
-
198
- ```
199
- 1. User visits /sign-in route → Renders <SignIn> component
200
-
201
- 2. User enters credentials → Component calls SDK methods
202
-
203
- 3. SDK communicates with backend → Returns auth token and user data
204
-
205
- 4. Component adds token to URL and redirects → SDK auto-detects token from URL
206
-
207
- 5. Provider automatically updates auth state → Components re-render
208
-
209
- 6. User sees authenticated UI at destination
210
- ```
211
-
212
- **Architecture:**
213
-
214
- - **InsforgeProvider**: Manages authentication state globally using React Context
215
- - **getInsforgeRoutes()**: Creates redirect routes for built-in auth
216
- - **SDK Integration**: All auth operations go through `@insforge/sdk`, which auto-detects tokens from URL
217
- - **React Context**: Provides auth state to all child components
218
- - **Hooks**: Easy access to auth methods and user data
219
-
220
- ---
221
-
222
- ## Complete Components (with Business Logic)
223
-
224
- These components include full authentication logic and work out of the box.
225
-
226
- ### `<SignIn />`
227
-
228
- Complete sign-in component with email/password and OAuth:
229
-
230
- ```tsx
231
- import { SignIn } from '@insforge/react-router';
232
-
233
- function SignInPage() {
234
- return (
235
- <SignIn
236
- title="Welcome Back"
237
- subtitle="Sign in to continue"
238
- onError={(error) => {
239
- console.error('Error:', error);
240
- }}
241
- />
242
- );
243
- }
244
- ```
245
-
246
- **Key Features:**
247
-
248
- - Email/password authentication
249
- - OAuth provider buttons (auto-detected from backend)
250
- - Password visibility toggle
251
- - Error handling
252
- - Loading states
253
- - Customizable text
254
-
255
- **Props:**
256
-
257
- - `onError` - Callback on error
258
- - `title` / `subtitle` - Custom heading text
259
-
260
- ### `<SignUp />`
261
-
262
- Complete sign-up component with password strength validation:
263
-
264
- ```tsx
265
- import { SignUp } from '@insforge/react-router';
266
-
267
- function SignUpPage() {
268
- return (
269
- <SignUp
270
- title="Create Account"
271
- subtitle="Get started with your free account"
272
- onError={(error) => {
273
- console.error('Error:', error);
274
- }}
275
- />
276
- );
277
- }
278
- ```
279
-
280
- **Key Features:**
281
-
282
- - Email/password registration
283
- - Real-time password strength indicator
284
- - OAuth provider buttons
285
- - Form validation
286
- - Customizable text
287
-
288
- **Props:** Same as `<SignIn>`.
289
-
290
- ### `<UserButton />`
291
-
292
- User profile dropdown with sign-out:
293
-
294
- ```tsx
295
- import { UserButton } from '@insforge/react-router';
296
-
297
- function Header() {
298
- return (
299
- <header>
300
- <nav>{/* Your navigation */}</nav>
301
- <UserButton afterSignOutUrl="/" mode="detailed" />
302
- </header>
303
- );
304
- }
305
- ```
306
-
307
- **Modes:**
308
-
309
- - `detailed` (default): Shows avatar + name + email
310
- - `simple`: Shows avatar only
311
-
312
- **Props:**
313
-
314
- - `mode` - Display mode: `"detailed"` or `"simple"`
315
- - `afterSignOutUrl` - Redirect URL after sign out
316
-
317
- ### `<ForgotPassword />`
318
-
319
- Complete password reset flow with automatic method detection:
320
-
321
- ```tsx
322
- import { ForgotPassword } from '@insforge/react-router';
323
-
324
- function ForgotPasswordPage() {
325
- return (
326
- <ForgotPassword
327
- onError={(error) => {
328
- console.error('Error:', error);
329
- }}
330
- />
331
- );
332
- }
333
- ```
334
-
335
- **Key Features:**
336
-
337
- - Auto-detects reset method (code or link) from backend config
338
- - **Link method**: Sends email with reset link
339
- - **Code method**: Three-step flow (email → verify code → reset password)
340
- - 60-second countdown timer for resend
341
- - Built-in form validation
342
- - Customizable text
343
-
344
- **Props:**
345
-
346
- - `onError` - Callback on error
347
-
348
- ### `<Protect />`
349
-
350
- Protected content with conditional rendering:
351
-
352
- ```tsx
353
- import { Protect } from '@insforge/react-router';
354
-
355
- function Dashboard() {
356
- return (
357
- <div>
358
- <h1>Dashboard</h1>
359
- {/* Simple protection */}
360
- <Protect redirectTo="/sign-in">
361
- <UserContent />
362
- </Protect>
363
- {/* Custom logic */}
364
- <Protect condition={(user) => user.subscription === 'premium'} fallback={<UpgradePrompt />}>
365
- <PremiumFeature />
366
- </Protect>
367
- </div>
368
- );
369
- }
370
- ```
371
-
372
- **Props:**
373
-
374
- - `redirectTo` - URL to redirect if not authorized
375
- - `condition` - Custom condition function `(user) => boolean`
376
- - `fallback` - React node to show if not authorized
377
-
378
- ### `<SignedIn>` / `<SignedOut>`
379
-
380
- Conditional rendering based on auth state:
381
-
382
- ```tsx
383
- import { SignedIn, SignedOut } from '@insforge/react-router';
384
-
385
- function NavBar() {
386
- return (
387
- <nav>
388
- <SignedOut>
389
- <a href="/sign-in">Sign In</a>
390
- <a href="/sign-up">Sign Up</a>
391
- </SignedOut>
392
-
393
- <SignedIn>
394
- <a href="/dashboard">Dashboard</a>
395
- <UserButton />
396
- </SignedIn>
397
- </nav>
398
- );
399
- }
400
- ```
401
-
402
- ---
403
-
404
- ## Hooks
405
-
406
- ### `useAuth()`
407
-
408
- Access authentication methods and state:
409
-
410
- ```tsx
411
- import { useAuth } from '@insforge/react-router';
412
-
413
- function LoginButton() {
414
- const { signIn, signUp, signOut, isSignedIn, isLoaded } = useAuth();
415
-
416
- const handleSignIn = async () => {
417
- try {
418
- await signIn('user@example.com', 'password');
419
- } catch (error) {
420
- console.error('Sign in failed:', error);
421
- }
422
- };
423
-
424
- if (!isLoaded) return <div>Loading...</div>;
425
-
426
- return (
427
- <button onClick={isSignedIn ? signOut : handleSignIn}>
428
- {isSignedIn ? 'Sign Out' : 'Sign In'}
429
- </button>
430
- );
431
- }
432
- ```
433
-
434
- **Returns:**
435
-
436
- - `signIn(email, password)` - Sign in with email/password
437
- - `signUp(email, password)` - Sign up new user
438
- - `signOut()` - Sign out current user
439
- - `isSignedIn` - Boolean auth state
440
- - `isLoaded` - Boolean loading state
441
-
442
- ### `useUser()`
443
-
444
- Access current user data:
445
-
446
- ```tsx
447
- import { useUser } from '@insforge/react-router';
448
-
449
- function UserProfile() {
450
- const { user, isLoaded, updateUser } = useUser();
451
-
452
- if (!isLoaded) return <div>Loading...</div>;
453
- if (!user) return <div>Not signed in</div>;
454
-
455
- const handleUpdate = async () => {
456
- await updateUser({ name: 'New Name' });
457
- };
458
-
459
- return (
460
- <div>
461
- <p>Email: {user.email}</p>
462
- <p>Name: {user.name}</p>
463
- <img src={user.avatarUrl} alt="Avatar" />
464
- <button onClick={handleUpdate}>Update Name</button>
465
- </div>
466
- );
467
- }
468
- ```
469
-
470
- **Returns:**
471
-
472
- - `user` - User object with id, email, name, avatarUrl
473
- - `isLoaded` - Boolean loading state
474
- - `updateUser(data)` - Update user profile
475
-
476
- ### `usePublicAuthConfig()`
477
-
478
- Get your authentication config in InsForge:
479
-
480
- ```tsx
481
- import { usePublicAuthConfig } from '@insforge/react-router';
482
-
483
- function SignInPage() {
484
- const { authConfig, isLoaded } = usePublicAuthConfig();
485
-
486
- if (!isLoaded) return <div>Loading...</div>;
487
-
488
- return (
489
- <div>
490
- <p>Available OAuth: {authConfig.oAuthProviders.join(', ')}</p>
491
- <p>Password min length: {authConfig?.passwordMinLength}</p>
492
- </div>
493
- );
494
- }
495
- ```
496
-
497
- **Returns:**
498
-
499
- - `authConfig` - Authentication Configuration you set in InsForge dashboard.
500
- - `isLoaded` - Boolean loading state
501
-
502
- <Warning>
503
- **Performance**: Only use this hook in SignIn/SignUp components to avoid unnecessary API calls.
504
- </Warning>
505
-
506
- ---
507
-
508
- ## Advanced Features
509
-
510
- ### Auth Change Callback
511
-
512
- Track authentication state changes:
513
-
514
- ```tsx
515
- <InsforgeProvider
516
- baseUrl={baseUrl}
517
- onAuthChange={(user) => {
518
- if (user) {
519
- console.log('User signed in:', user.email);
520
- analytics.identify(user.id);
521
- } else {
522
- console.log('User signed out');
523
- analytics.reset();
524
- }
525
- }}
526
- >
527
- {children}
528
- </InsforgeProvider>
529
- ```
1
+ ---
2
+ title: InsForge Auth Components
3
+ description: Framework-agnostic authentication components guidance for customization
4
+ ---
5
+
6
+ ## Custom Authentication system
7
+
8
+ Use this approach when you need custom authentication pages in your application instead of redirecting to hosted pages.
9
+
10
+ ### Step-by-Step: Custom Auth Pages Setup
11
+
12
+ #### Step 1: Setup Provider (Same as Quick Start)
13
+
14
+ The provider setup is identical:
15
+
16
+ ```tsx src/main.tsx
17
+ import { StrictMode } from 'react';
18
+ import { createRoot } from 'react-dom/client';
19
+ import { InsforgeProvider } from '@insforge/react-router';
20
+ import App from './App';
21
+
22
+ createRoot(document.getElementById('root')!).render(
23
+ <StrictMode>
24
+ <InsforgeProvider
25
+ baseUrl={
26
+ import.meta.env.VITE_INSFORGE_BASE_URL || 'https://your-app.region.insforge.app' // Replace with your InsForge backend URL
27
+ }
28
+ afterSignInUrl="/dashboard"
29
+ >
30
+ <App />
31
+ </InsforgeProvider>
32
+ </StrictMode>
33
+ );
34
+ ```
35
+
36
+ #### Step 2: Configure Router with Custom Pages
37
+
38
+ Set `builtInAuth: false` and provide your page components:
39
+
40
+ ```tsx src/App.tsx
41
+ import { createBrowserRouter, RouterProvider } from 'react-router-dom';
42
+ import { getInsforgeRoutes } from '@insforge/react-router/router';
43
+ import Layout from './components/Layout';
44
+ import Home from './pages/Home';
45
+ import Dashboard from './pages/Dashboard';
46
+ // Import your custom auth pages
47
+ import SignInPage from './pages/auth/SignInPage';
48
+ import SignUpPage from './pages/auth/SignUpPage';
49
+ import ForgotPasswordPage from './pages/auth/ForgotPasswordPage';
50
+
51
+ const router = createBrowserRouter([
52
+ {
53
+ path: '/',
54
+ element: <Layout />,
55
+ children: [
56
+ { index: true, element: <Home /> },
57
+ { path: 'dashboard', element: <Dashboard /> },
58
+ ],
59
+ },
60
+
61
+ // Custom auth routes
62
+ ...getInsforgeRoutes({
63
+ baseUrl: import.meta.env.VITE_INSFORGE_BASE_URL || 'https://your-app.region.insforge.app', // Replace with your InsForge backend URL
64
+ afterSignInUrl: '/dashboard',
65
+ builtInAuth: false, // Render custom components instead of redirecting
66
+ pages: {
67
+ signIn: <SignInPage />,
68
+ signUp: <SignUpPage />,
69
+ forgotPassword: <ForgotPasswordPage />,
70
+ },
71
+ }),
72
+ ]);
73
+
74
+ export default function App() {
75
+ return <RouterProvider router={router} />;
76
+ }
77
+ ```
78
+
79
+ #### Step 3: Create Auth Page Components
80
+
81
+ Use our complete authentication components directly. These components are **full-featured page-level components** with all business logic included:
82
+
83
+ ```tsx src/pages/auth/SignInPage.tsx
84
+ import { SignIn } from '@insforge/react-router';
85
+
86
+ export default function SignInPage() {
87
+ return (
88
+ <div className="h-screen flex items-center justify-center">
89
+ <SignIn
90
+ title="Welcome Back"
91
+ subtitle="Sign in to your account"
92
+ onError={(error) => {
93
+ console.error('Sign in error:', error);
94
+ }}
95
+ />
96
+ </div>
97
+ );
98
+ }
99
+ ```
100
+
101
+ ```tsx src/pages/auth/SignUpPage.tsx
102
+ import { SignUp } from '@insforge/react-router';
103
+
104
+ export default function SignUpPage() {
105
+ return (
106
+ <div className="h-screen flex items-center justify-center">
107
+ <SignUp
108
+ title="Create Account"
109
+ subtitle="Get started for free"
110
+ onError={(error) => {
111
+ console.error('Sign up error:', error);
112
+ }}
113
+ />
114
+ </div>
115
+ );
116
+ }
117
+ ```
118
+
119
+ ```tsx src/pages/auth/ForgotPasswordPage.tsx
120
+ import { ForgotPassword } from '@insforge/react-router';
121
+
122
+ export default function ForgotPasswordPage() {
123
+ return (
124
+ <div className="h-screen flex items-center justify-center">
125
+ <ForgotPassword
126
+ onError={(error) => {
127
+ console.error('Password reset error:', error);
128
+ }}
129
+ />
130
+ </div>
131
+ );
132
+ }
133
+ ```
134
+
135
+ **That's it!** The `<SignIn>`, `<SignUp>`, and `<ForgotPassword>` components are complete page-level components that include:
136
+
137
+ - Form UI with validation
138
+ - OAuth provider buttons (auto-detected)
139
+ - Error handling
140
+ - Loading states
141
+ - Password strength indicators (SignUp)
142
+ - All authentication logic
143
+
144
+ You only need to wrap them in your page components for layout/styling purposes.
145
+
146
+ ### Key Difference from Built-in Auth
147
+
148
+ **Built-in Auth:**
149
+
150
+ - `/sign-in` → Redirects to `https://your-app.region.insforge.app/auth/sign-in`
151
+ - Authentication happens on hosted page
152
+ - Returns to your app with token
153
+
154
+ **Custom Components:**
155
+
156
+ - `/sign-in` → Renders your `<SignInPage>` component
157
+ - Authentication happens in your app
158
+ - SDK handles token management automatically
159
+
160
+ ---
161
+
162
+ ## Features
163
+
164
+ - **Built-in Auth**: React Router integration with deployed auth pages
165
+ - **Complete Components**: Pre-built `<SignIn>`, `<SignUp>`, `<UserButton>` with business logic
166
+ - **OAuth Support**: Google, GitHub, Discord, Facebook, LinkedIn, Microsoft, Apple, X, Instagram, TikTok, Spotify
167
+ - **React Hooks**: `useAuth()`, `useUser()`, `usePublicAuthConfig()`
168
+ - **Control Components**: `<SignedIn>`, `<SignedOut>`, `<Protect>`
169
+ - **Form Components**: Pure UI forms for custom logic
170
+ - **TypeScript**: Full type safety
171
+
172
+ ---
173
+
174
+ ## How It Works
175
+
176
+ ### Built-in Auth Flow
177
+
178
+ ```
179
+ 1. User clicks "Sign In" → Visits /sign-in route
180
+
181
+ 2. getInsforgeRoutes() redirects → https://your-app.region.insforge.app/auth/sign-in?redirect=yourapp.com/you-defined-destination-after-sign-in
182
+
183
+ 3. User signs in on deployed page → Backend processes authentication
184
+
185
+ 4. Backend redirects → yourapp.com/you-defined-destination-after-sign-in?access_token=xxx&user_id=xxx
186
+
187
+ 5. InsForge SDK will:
188
+ - Extracts token from URL
189
+ - Saves to localStorage
190
+ - Verifies with getCurrentUser()
191
+ - Updates Provider state
192
+
193
+ 6. User sees the destination page (e.g /dashboard)
194
+ ```
195
+
196
+ ### Custom UI Flow
197
+
198
+ ```
199
+ 1. User visits /sign-in route → Renders <SignIn> component
200
+
201
+ 2. User enters credentials → Component calls SDK methods
202
+
203
+ 3. SDK communicates with backend → Returns auth token and user data
204
+
205
+ 4. Component adds token to URL and redirects → SDK auto-detects token from URL
206
+
207
+ 5. Provider automatically updates auth state → Components re-render
208
+
209
+ 6. User sees authenticated UI at destination
210
+ ```
211
+
212
+ **Architecture:**
213
+
214
+ - **InsforgeProvider**: Manages authentication state globally using React Context
215
+ - **getInsforgeRoutes()**: Creates redirect routes for built-in auth
216
+ - **SDK Integration**: All auth operations go through `@insforge/sdk`, which auto-detects tokens from URL
217
+ - **React Context**: Provides auth state to all child components
218
+ - **Hooks**: Easy access to auth methods and user data
219
+
220
+ ---
221
+
222
+ ## Complete Components (with Business Logic)
223
+
224
+ These components include full authentication logic and work out of the box.
225
+
226
+ ### `<SignIn />`
227
+
228
+ Complete sign-in component with email/password and OAuth:
229
+
230
+ ```tsx
231
+ import { SignIn } from '@insforge/react-router';
232
+
233
+ function SignInPage() {
234
+ return (
235
+ <SignIn
236
+ title="Welcome Back"
237
+ subtitle="Sign in to continue"
238
+ onError={(error) => {
239
+ console.error('Error:', error);
240
+ }}
241
+ />
242
+ );
243
+ }
244
+ ```
245
+
246
+ **Key Features:**
247
+
248
+ - Email/password authentication
249
+ - OAuth provider buttons (auto-detected from backend)
250
+ - Password visibility toggle
251
+ - Error handling
252
+ - Loading states
253
+ - Customizable text
254
+
255
+ **Props:**
256
+
257
+ - `onError` - Callback on error
258
+ - `title` / `subtitle` - Custom heading text
259
+
260
+ ### `<SignUp />`
261
+
262
+ Complete sign-up component with password strength validation:
263
+
264
+ ```tsx
265
+ import { SignUp } from '@insforge/react-router';
266
+
267
+ function SignUpPage() {
268
+ return (
269
+ <SignUp
270
+ title="Create Account"
271
+ subtitle="Get started with your free account"
272
+ onError={(error) => {
273
+ console.error('Error:', error);
274
+ }}
275
+ />
276
+ );
277
+ }
278
+ ```
279
+
280
+ **Key Features:**
281
+
282
+ - Email/password registration
283
+ - Real-time password strength indicator
284
+ - OAuth provider buttons
285
+ - Form validation
286
+ - Customizable text
287
+
288
+ **Props:** Same as `<SignIn>`.
289
+
290
+ ### `<UserButton />`
291
+
292
+ User profile dropdown with sign-out:
293
+
294
+ ```tsx
295
+ import { UserButton } from '@insforge/react-router';
296
+
297
+ function Header() {
298
+ return (
299
+ <header>
300
+ <nav>{/* Your navigation */}</nav>
301
+ <UserButton afterSignOutUrl="/" mode="detailed" />
302
+ </header>
303
+ );
304
+ }
305
+ ```
306
+
307
+ **Modes:**
308
+
309
+ - `detailed` (default): Shows avatar + name + email
310
+ - `simple`: Shows avatar only
311
+
312
+ **Props:**
313
+
314
+ - `mode` - Display mode: `"detailed"` or `"simple"`
315
+ - `afterSignOutUrl` - Redirect URL after sign out
316
+
317
+ ### `<ForgotPassword />`
318
+
319
+ Complete password reset flow with automatic method detection:
320
+
321
+ ```tsx
322
+ import { ForgotPassword } from '@insforge/react-router';
323
+
324
+ function ForgotPasswordPage() {
325
+ return (
326
+ <ForgotPassword
327
+ onError={(error) => {
328
+ console.error('Error:', error);
329
+ }}
330
+ />
331
+ );
332
+ }
333
+ ```
334
+
335
+ **Key Features:**
336
+
337
+ - Auto-detects reset method (code or link) from backend config
338
+ - **Link method**: Sends email with reset link
339
+ - **Code method**: Three-step flow (email → verify code → reset password)
340
+ - 60-second countdown timer for resend
341
+ - Built-in form validation
342
+ - Customizable text
343
+
344
+ **Props:**
345
+
346
+ - `onError` - Callback on error
347
+
348
+ ### `<Protect />`
349
+
350
+ Protected content with conditional rendering:
351
+
352
+ ```tsx
353
+ import { Protect } from '@insforge/react-router';
354
+
355
+ function Dashboard() {
356
+ return (
357
+ <div>
358
+ <h1>Dashboard</h1>
359
+ {/* Simple protection */}
360
+ <Protect redirectTo="/sign-in">
361
+ <UserContent />
362
+ </Protect>
363
+ {/* Custom logic */}
364
+ <Protect condition={(user) => user.subscription === 'premium'} fallback={<UpgradePrompt />}>
365
+ <PremiumFeature />
366
+ </Protect>
367
+ </div>
368
+ );
369
+ }
370
+ ```
371
+
372
+ **Props:**
373
+
374
+ - `redirectTo` - URL to redirect if not authorized
375
+ - `condition` - Custom condition function `(user) => boolean`
376
+ - `fallback` - React node to show if not authorized
377
+
378
+ ### `<SignedIn>` / `<SignedOut>`
379
+
380
+ Conditional rendering based on auth state:
381
+
382
+ ```tsx
383
+ import { SignedIn, SignedOut } from '@insforge/react-router';
384
+
385
+ function NavBar() {
386
+ return (
387
+ <nav>
388
+ <SignedOut>
389
+ <a href="/sign-in">Sign In</a>
390
+ <a href="/sign-up">Sign Up</a>
391
+ </SignedOut>
392
+
393
+ <SignedIn>
394
+ <a href="/dashboard">Dashboard</a>
395
+ <UserButton />
396
+ </SignedIn>
397
+ </nav>
398
+ );
399
+ }
400
+ ```
401
+
402
+ ---
403
+
404
+ ## Hooks
405
+
406
+ ### `useAuth()`
407
+
408
+ Access authentication methods and state:
409
+
410
+ ```tsx
411
+ import { useAuth } from '@insforge/react-router';
412
+
413
+ function LoginButton() {
414
+ const { signIn, signUp, signOut, isSignedIn, isLoaded } = useAuth();
415
+
416
+ const handleSignIn = async () => {
417
+ try {
418
+ await signIn('user@example.com', 'password');
419
+ } catch (error) {
420
+ console.error('Sign in failed:', error);
421
+ }
422
+ };
423
+
424
+ if (!isLoaded) return <div>Loading...</div>;
425
+
426
+ return (
427
+ <button onClick={isSignedIn ? signOut : handleSignIn}>
428
+ {isSignedIn ? 'Sign Out' : 'Sign In'}
429
+ </button>
430
+ );
431
+ }
432
+ ```
433
+
434
+ **Returns:**
435
+
436
+ - `signIn(email, password)` - Sign in with email/password
437
+ - `signUp(email, password)` - Sign up new user
438
+ - `signOut()` - Sign out current user
439
+ - `isSignedIn` - Boolean auth state
440
+ - `isLoaded` - Boolean loading state
441
+
442
+ ### `useUser()`
443
+
444
+ Access current user data:
445
+
446
+ ```tsx
447
+ import { useUser } from '@insforge/react-router';
448
+
449
+ function UserProfile() {
450
+ const { user, isLoaded, updateUser } = useUser();
451
+
452
+ if (!isLoaded) return <div>Loading...</div>;
453
+ if (!user) return <div>Not signed in</div>;
454
+
455
+ const handleUpdate = async () => {
456
+ await updateUser({ name: 'New Name' });
457
+ };
458
+
459
+ return (
460
+ <div>
461
+ <p>Email: {user.email}</p>
462
+ <p>Name: {user.name}</p>
463
+ <img src={user.avatarUrl} alt="Avatar" />
464
+ <button onClick={handleUpdate}>Update Name</button>
465
+ </div>
466
+ );
467
+ }
468
+ ```
469
+
470
+ **Returns:**
471
+
472
+ - `user` - User object with id, email, name, avatarUrl
473
+ - `isLoaded` - Boolean loading state
474
+ - `updateUser(data)` - Update user profile
475
+
476
+ ### `usePublicAuthConfig()`
477
+
478
+ Get your authentication config in InsForge:
479
+
480
+ ```tsx
481
+ import { usePublicAuthConfig } from '@insforge/react-router';
482
+
483
+ function SignInPage() {
484
+ const { authConfig, isLoaded } = usePublicAuthConfig();
485
+
486
+ if (!isLoaded) return <div>Loading...</div>;
487
+
488
+ return (
489
+ <div>
490
+ <p>Available OAuth: {authConfig.oAuthProviders.join(', ')}</p>
491
+ <p>Password min length: {authConfig?.passwordMinLength}</p>
492
+ </div>
493
+ );
494
+ }
495
+ ```
496
+
497
+ **Returns:**
498
+
499
+ - `authConfig` - Authentication Configuration you set in InsForge dashboard.
500
+ - `isLoaded` - Boolean loading state
501
+
502
+ <Warning>
503
+ **Performance**: Only use this hook in SignIn/SignUp components to avoid unnecessary API calls.
504
+ </Warning>
505
+
506
+ ---
507
+
508
+ ## Advanced Features
509
+
510
+ ### Auth Change Callback
511
+
512
+ Track authentication state changes:
513
+
514
+ ```tsx
515
+ <InsforgeProvider
516
+ baseUrl={baseUrl}
517
+ onAuthChange={(user) => {
518
+ if (user) {
519
+ console.log('User signed in:', user.email);
520
+ analytics.identify(user.id);
521
+ } else {
522
+ console.log('User signed out');
523
+ analytics.reset();
524
+ }
525
+ }}
526
+ >
527
+ {children}
528
+ </InsforgeProvider>
529
+ ```