@amplitude/wizard 1.0.0-beta.2 → 1.0.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 (391) hide show
  1. package/README.md +171 -74
  2. package/dist/bin.js +338 -222
  3. package/dist/src/lib/agent-interface.js +64 -9
  4. package/dist/src/lib/agent-runner.js +1 -10
  5. package/dist/src/lib/api.d.ts +22 -4
  6. package/dist/src/lib/api.js +114 -12
  7. package/dist/src/lib/commandments.js +14 -1
  8. package/dist/src/lib/constants.d.ts +6 -5
  9. package/dist/src/lib/constants.js +13 -13
  10. package/dist/src/lib/credential-resolution.d.ts +45 -0
  11. package/dist/src/lib/credential-resolution.js +311 -0
  12. package/dist/src/lib/exit-codes.d.ts +10 -0
  13. package/dist/src/lib/exit-codes.js +12 -0
  14. package/dist/src/lib/health-checks/statuspage.d.ts +1 -0
  15. package/dist/src/lib/health-checks/statuspage.js +5 -1
  16. package/dist/src/lib/mode-config.d.ts +14 -0
  17. package/dist/src/lib/mode-config.js +14 -0
  18. package/dist/src/lib/session-checkpoint.d.ts +27 -0
  19. package/dist/src/lib/session-checkpoint.js +134 -0
  20. package/dist/src/lib/wizard-session.d.ts +44 -1
  21. package/dist/src/lib/wizard-session.js +70 -14
  22. package/dist/src/lib/wizard-tools.js +19 -4
  23. package/dist/src/steps/add-mcp-server-to-clients/clients/claude.d.ts +3 -0
  24. package/dist/src/steps/add-mcp-server-to-clients/clients/claude.js +6 -0
  25. package/dist/src/steps/add-mcp-server-to-clients/clients/cursor.js +3 -1
  26. package/dist/src/ui/agent-ui.d.ts +91 -0
  27. package/dist/src/ui/agent-ui.js +277 -0
  28. package/dist/src/ui/logging-ui.js +1 -1
  29. package/dist/src/ui/tui/App.d.ts +12 -0
  30. package/dist/src/ui/tui/App.js +29 -18
  31. package/dist/src/ui/tui/components/AmplitudeLogo.js +16 -17
  32. package/dist/src/ui/tui/components/AmplitudeTextLogo.d.ts +0 -2
  33. package/dist/src/ui/tui/components/AmplitudeTextLogo.js +53 -18
  34. package/dist/src/ui/tui/components/BrailleSpinner.d.ts +8 -0
  35. package/dist/src/ui/tui/components/BrailleSpinner.js +15 -0
  36. package/dist/src/ui/tui/components/ConsoleView.d.ts +8 -11
  37. package/dist/src/ui/tui/components/ConsoleView.js +51 -34
  38. package/dist/src/ui/tui/components/HeaderBar.d.ts +12 -0
  39. package/dist/src/ui/tui/components/HeaderBar.js +17 -0
  40. package/dist/src/ui/tui/components/JourneyStepper.d.ts +16 -0
  41. package/dist/src/ui/tui/components/JourneyStepper.js +83 -0
  42. package/dist/src/ui/tui/components/KeyHintBar.d.ts +19 -0
  43. package/dist/src/ui/tui/components/KeyHintBar.js +20 -0
  44. package/dist/src/ui/tui/console-commands.d.ts +1 -2
  45. package/dist/src/ui/tui/console-commands.js +48 -7
  46. package/dist/src/ui/tui/flows.d.ts +1 -1
  47. package/dist/src/ui/tui/flows.js +1 -1
  48. package/dist/src/ui/tui/hooks/useAsyncEffect.d.ts +15 -0
  49. package/dist/src/ui/tui/hooks/useAsyncEffect.js +35 -0
  50. package/dist/src/ui/tui/hooks/useWizardStore.d.ts +9 -0
  51. package/dist/src/ui/tui/hooks/useWizardStore.js +11 -0
  52. package/dist/src/ui/tui/ink-ui.js +1 -1
  53. package/dist/src/ui/tui/primitives/DissolveTransition.js +4 -5
  54. package/dist/src/ui/tui/primitives/EventPlanViewer.d.ts +3 -1
  55. package/dist/src/ui/tui/primitives/EventPlanViewer.js +8 -3
  56. package/dist/src/ui/tui/primitives/ProgressList.js +1 -1
  57. package/dist/src/ui/tui/primitives/SlashCommandInput.js +19 -4
  58. package/dist/src/ui/tui/primitives/SplitView.d.ts +2 -1
  59. package/dist/src/ui/tui/primitives/SplitView.js +10 -2
  60. package/dist/src/ui/tui/primitives/TabContainer.js +10 -2
  61. package/dist/src/ui/tui/primitives/index.d.ts +0 -1
  62. package/dist/src/ui/tui/primitives/index.js +0 -1
  63. package/dist/src/ui/tui/router.js +1 -1
  64. package/dist/src/ui/tui/screen-registry.d.ts +0 -7
  65. package/dist/src/ui/tui/screen-registry.js +13 -4
  66. package/dist/src/ui/tui/screens/ActivationOptionsScreen.d.ts +2 -2
  67. package/dist/src/ui/tui/screens/ActivationOptionsScreen.js +8 -8
  68. package/dist/src/ui/tui/screens/AuthScreen.js +57 -27
  69. package/dist/src/ui/tui/screens/ChecklistScreen.d.ts +2 -12
  70. package/dist/src/ui/tui/screens/ChecklistScreen.js +22 -33
  71. package/dist/src/ui/tui/screens/DataIngestionCheckScreen.d.ts +3 -12
  72. package/dist/src/ui/tui/screens/DataIngestionCheckScreen.js +109 -39
  73. package/dist/src/ui/tui/screens/DataSetupScreen.d.ts +3 -3
  74. package/dist/src/ui/tui/screens/DataSetupScreen.js +17 -10
  75. package/dist/src/ui/tui/screens/IntroScreen.d.ts +5 -3
  76. package/dist/src/ui/tui/screens/IntroScreen.js +132 -41
  77. package/dist/src/ui/tui/screens/LoginScreen.d.ts +1 -1
  78. package/dist/src/ui/tui/screens/LoginScreen.js +4 -4
  79. package/dist/src/ui/tui/screens/LogoutScreen.d.ts +4 -2
  80. package/dist/src/ui/tui/screens/LogoutScreen.js +17 -5
  81. package/dist/src/ui/tui/screens/McpScreen.d.ts +4 -4
  82. package/dist/src/ui/tui/screens/McpScreen.js +25 -17
  83. package/dist/src/ui/tui/screens/OutageScreen.d.ts +1 -1
  84. package/dist/src/ui/tui/screens/OutageScreen.js +5 -5
  85. package/dist/src/ui/tui/screens/OutroScreen.d.ts +5 -0
  86. package/dist/src/ui/tui/screens/OutroScreen.js +21 -14
  87. package/dist/src/ui/tui/screens/RegionSelectScreen.js +15 -13
  88. package/dist/src/ui/tui/screens/RunScreen.d.ts +7 -5
  89. package/dist/src/ui/tui/screens/RunScreen.js +102 -157
  90. package/dist/src/ui/tui/screens/SettingsOverrideScreen.d.ts +1 -1
  91. package/dist/src/ui/tui/screens/SettingsOverrideScreen.js +6 -5
  92. package/dist/src/ui/tui/screens/SetupScreen.d.ts +1 -1
  93. package/dist/src/ui/tui/screens/SetupScreen.js +7 -7
  94. package/dist/src/ui/tui/screens/SlackScreen.d.ts +2 -2
  95. package/dist/src/ui/tui/screens/SlackScreen.js +60 -35
  96. package/dist/src/ui/tui/session-constants.d.ts +41 -0
  97. package/dist/src/ui/tui/session-constants.js +38 -0
  98. package/dist/src/ui/tui/start-tui.d.ts +3 -1
  99. package/dist/src/ui/tui/start-tui.js +14 -10
  100. package/dist/src/ui/tui/store.d.ts +2 -1
  101. package/dist/src/ui/tui/store.js +33 -7
  102. package/dist/src/ui/tui/styles.d.ts +75 -19
  103. package/dist/src/ui/tui/styles.js +101 -19
  104. package/dist/src/ui/tui/utils/classify-error.d.ts +14 -0
  105. package/dist/src/ui/tui/utils/classify-error.js +90 -0
  106. package/dist/src/ui/tui/utils/diagnostics.d.ts +21 -0
  107. package/dist/src/ui/tui/utils/diagnostics.js +72 -0
  108. package/dist/src/ui/tui/utils/with-retry.d.ts +12 -0
  109. package/dist/src/ui/tui/utils/with-retry.js +32 -0
  110. package/dist/src/ui/tui/utils/with-timeout.d.ts +10 -0
  111. package/dist/src/ui/tui/utils/with-timeout.js +24 -0
  112. package/dist/src/utils/ampli-settings.d.ts +1 -1
  113. package/dist/src/utils/ampli-settings.js +15 -5
  114. package/dist/src/utils/api-key-store.js +5 -5
  115. package/dist/src/utils/atomic-write.d.ts +15 -0
  116. package/dist/src/utils/atomic-write.js +34 -0
  117. package/dist/src/utils/setup-utils.js +2 -2
  118. package/dist/src/utils/token-refresh.d.ts +22 -0
  119. package/dist/src/utils/token-refresh.js +79 -0
  120. package/dist/src/utils/wizard-abort.js +6 -1
  121. package/package.json +6 -6
  122. package/skills/instrumentation/add-analytics-instrumentation/SKILL.md +142 -0
  123. package/skills/instrumentation/diff-intake/SKILL.md +128 -0
  124. package/skills/instrumentation/discover-analytics-patterns/SKILL.md +185 -0
  125. package/skills/instrumentation/discover-event-surfaces/SKILL.md +322 -0
  126. package/skills/instrumentation/discover-event-surfaces/references/best-practices.md +563 -0
  127. package/skills/instrumentation/instrument-events/SKILL.md +169 -0
  128. package/skills/instrumentation/instrument-events/references/best-practices.md +563 -0
  129. package/skills/integration/integration-android/SKILL.md +49 -0
  130. package/skills/integration/integration-android/references/EXAMPLE.md +1977 -0
  131. package/skills/integration/integration-android/references/amplitude-quickstart.md +1845 -0
  132. package/skills/integration/integration-android/references/analytics.md +1778 -0
  133. package/skills/integration/integration-android/references/basic-integration-1.0-begin.md +43 -0
  134. package/skills/integration/integration-android/references/basic-integration-1.1-edit.md +35 -0
  135. package/skills/integration/integration-android/references/basic-integration-1.2-revise.md +23 -0
  136. package/skills/integration/integration-android/references/basic-integration-1.3-conclude.md +57 -0
  137. package/skills/integration/integration-angular/SKILL.md +49 -0
  138. package/skills/integration/integration-angular/references/EXAMPLE.md +899 -0
  139. package/skills/integration/integration-angular/references/amplitude-quickstart.md +1845 -0
  140. package/skills/integration/integration-angular/references/basic-integration-1.0-begin.md +43 -0
  141. package/skills/integration/integration-angular/references/basic-integration-1.1-edit.md +35 -0
  142. package/skills/integration/integration-angular/references/basic-integration-1.2-revise.md +23 -0
  143. package/skills/integration/integration-angular/references/basic-integration-1.3-conclude.md +57 -0
  144. package/skills/integration/integration-angular/references/browser-sdk-2.md +4680 -0
  145. package/skills/integration/integration-astro-hybrid/SKILL.md +56 -0
  146. package/skills/integration/integration-astro-hybrid/references/EXAMPLE.md +1095 -0
  147. package/skills/integration/integration-astro-hybrid/references/amplitude-quickstart.md +1845 -0
  148. package/skills/integration/integration-astro-hybrid/references/basic-integration-1.0-begin.md +43 -0
  149. package/skills/integration/integration-astro-hybrid/references/basic-integration-1.1-edit.md +35 -0
  150. package/skills/integration/integration-astro-hybrid/references/basic-integration-1.2-revise.md +23 -0
  151. package/skills/integration/integration-astro-hybrid/references/basic-integration-1.3-conclude.md +57 -0
  152. package/skills/integration/integration-astro-hybrid/references/browser-sdk-2.md +4680 -0
  153. package/skills/integration/integration-astro-ssr/SKILL.md +52 -0
  154. package/skills/integration/integration-astro-ssr/references/EXAMPLE.md +1106 -0
  155. package/skills/integration/integration-astro-ssr/references/amplitude-quickstart.md +1845 -0
  156. package/skills/integration/integration-astro-ssr/references/basic-integration-1.0-begin.md +43 -0
  157. package/skills/integration/integration-astro-ssr/references/basic-integration-1.1-edit.md +35 -0
  158. package/skills/integration/integration-astro-ssr/references/basic-integration-1.2-revise.md +23 -0
  159. package/skills/integration/integration-astro-ssr/references/basic-integration-1.3-conclude.md +57 -0
  160. package/skills/integration/integration-astro-ssr/references/browser-sdk-2.md +4680 -0
  161. package/skills/integration/integration-astro-static/SKILL.md +49 -0
  162. package/skills/integration/integration-astro-static/references/EXAMPLE.md +910 -0
  163. package/skills/integration/integration-astro-static/references/amplitude-quickstart.md +1845 -0
  164. package/skills/integration/integration-astro-static/references/basic-integration-1.0-begin.md +43 -0
  165. package/skills/integration/integration-astro-static/references/basic-integration-1.1-edit.md +35 -0
  166. package/skills/integration/integration-astro-static/references/basic-integration-1.2-revise.md +23 -0
  167. package/skills/integration/integration-astro-static/references/basic-integration-1.3-conclude.md +57 -0
  168. package/skills/integration/integration-astro-static/references/browser-sdk-2.md +4680 -0
  169. package/skills/integration/integration-astro-view-transitions/SKILL.md +51 -0
  170. package/skills/integration/integration-astro-view-transitions/references/EXAMPLE.md +979 -0
  171. package/skills/integration/integration-astro-view-transitions/references/amplitude-quickstart.md +1845 -0
  172. package/skills/integration/integration-astro-view-transitions/references/basic-integration-1.0-begin.md +43 -0
  173. package/skills/integration/integration-astro-view-transitions/references/basic-integration-1.1-edit.md +35 -0
  174. package/skills/integration/integration-astro-view-transitions/references/basic-integration-1.2-revise.md +23 -0
  175. package/skills/integration/integration-astro-view-transitions/references/basic-integration-1.3-conclude.md +57 -0
  176. package/skills/integration/integration-astro-view-transitions/references/browser-sdk-2.md +4680 -0
  177. package/skills/integration/integration-django/SKILL.md +57 -0
  178. package/skills/integration/integration-django/references/EXAMPLE.md +1005 -0
  179. package/skills/integration/integration-django/references/amplitude-quickstart.md +1845 -0
  180. package/skills/integration/integration-django/references/basic-integration-1.0-begin.md +43 -0
  181. package/skills/integration/integration-django/references/basic-integration-1.1-edit.md +35 -0
  182. package/skills/integration/integration-django/references/basic-integration-1.2-revise.md +23 -0
  183. package/skills/integration/integration-django/references/basic-integration-1.3-conclude.md +57 -0
  184. package/skills/integration/integration-django/references/python.md +1424 -0
  185. package/skills/integration/integration-expo/SKILL.md +53 -0
  186. package/skills/integration/integration-expo/references/EXAMPLE.md +1291 -0
  187. package/skills/integration/integration-expo/references/amplitude-quickstart.md +1845 -0
  188. package/skills/integration/integration-expo/references/basic-integration-1.0-begin.md +43 -0
  189. package/skills/integration/integration-expo/references/basic-integration-1.1-edit.md +35 -0
  190. package/skills/integration/integration-expo/references/basic-integration-1.2-revise.md +23 -0
  191. package/skills/integration/integration-expo/references/basic-integration-1.3-conclude.md +57 -0
  192. package/skills/integration/integration-expo/references/react-native-sdk.md +2819 -0
  193. package/skills/integration/integration-fastapi/SKILL.md +57 -0
  194. package/skills/integration/integration-fastapi/references/EXAMPLE.md +1389 -0
  195. package/skills/integration/integration-fastapi/references/amplitude-quickstart.md +1845 -0
  196. package/skills/integration/integration-fastapi/references/basic-integration-1.0-begin.md +43 -0
  197. package/skills/integration/integration-fastapi/references/basic-integration-1.1-edit.md +35 -0
  198. package/skills/integration/integration-fastapi/references/basic-integration-1.2-revise.md +23 -0
  199. package/skills/integration/integration-fastapi/references/basic-integration-1.3-conclude.md +57 -0
  200. package/skills/integration/integration-fastapi/references/python.md +1424 -0
  201. package/skills/integration/integration-flask/SKILL.md +56 -0
  202. package/skills/integration/integration-flask/references/EXAMPLE.md +1130 -0
  203. package/skills/integration/integration-flask/references/amplitude-quickstart.md +1845 -0
  204. package/skills/integration/integration-flask/references/basic-integration-1.0-begin.md +43 -0
  205. package/skills/integration/integration-flask/references/basic-integration-1.1-edit.md +35 -0
  206. package/skills/integration/integration-flask/references/basic-integration-1.2-revise.md +23 -0
  207. package/skills/integration/integration-flask/references/basic-integration-1.3-conclude.md +57 -0
  208. package/skills/integration/integration-flask/references/python.md +1424 -0
  209. package/skills/integration/integration-javascript_node/SKILL.md +54 -0
  210. package/skills/integration/integration-javascript_node/references/EXAMPLE.md +365 -0
  211. package/skills/integration/integration-javascript_node/references/amplitude-quickstart.md +1845 -0
  212. package/skills/integration/integration-javascript_node/references/analytics.md +1778 -0
  213. package/skills/integration/integration-javascript_node/references/basic-integration-1.0-begin.md +43 -0
  214. package/skills/integration/integration-javascript_node/references/basic-integration-1.1-edit.md +35 -0
  215. package/skills/integration/integration-javascript_node/references/basic-integration-1.2-revise.md +23 -0
  216. package/skills/integration/integration-javascript_node/references/basic-integration-1.3-conclude.md +57 -0
  217. package/skills/integration/integration-javascript_web/SKILL.md +58 -0
  218. package/skills/integration/integration-javascript_web/references/EXAMPLE.md +451 -0
  219. package/skills/integration/integration-javascript_web/references/amplitude-quickstart.md +1845 -0
  220. package/skills/integration/integration-javascript_web/references/basic-integration-1.0-begin.md +43 -0
  221. package/skills/integration/integration-javascript_web/references/basic-integration-1.1-edit.md +35 -0
  222. package/skills/integration/integration-javascript_web/references/basic-integration-1.2-revise.md +23 -0
  223. package/skills/integration/integration-javascript_web/references/basic-integration-1.3-conclude.md +57 -0
  224. package/skills/integration/integration-javascript_web/references/browser-sdk-2.md +4680 -0
  225. package/skills/integration/integration-laravel/SKILL.md +52 -0
  226. package/skills/integration/integration-laravel/references/EXAMPLE.md +2039 -0
  227. package/skills/integration/integration-laravel/references/amplitude-quickstart.md +1845 -0
  228. package/skills/integration/integration-laravel/references/analytics.md +1778 -0
  229. package/skills/integration/integration-laravel/references/basic-integration-1.0-begin.md +43 -0
  230. package/skills/integration/integration-laravel/references/basic-integration-1.1-edit.md +35 -0
  231. package/skills/integration/integration-laravel/references/basic-integration-1.2-revise.md +23 -0
  232. package/skills/integration/integration-laravel/references/basic-integration-1.3-conclude.md +57 -0
  233. package/skills/integration/integration-nextjs-app-router/SKILL.md +54 -0
  234. package/skills/integration/integration-nextjs-app-router/references/EXAMPLE.md +673 -0
  235. package/skills/integration/integration-nextjs-app-router/references/amplitude-quickstart.md +1845 -0
  236. package/skills/integration/integration-nextjs-app-router/references/basic-integration-1.0-begin.md +43 -0
  237. package/skills/integration/integration-nextjs-app-router/references/basic-integration-1.1-edit.md +35 -0
  238. package/skills/integration/integration-nextjs-app-router/references/basic-integration-1.2-revise.md +23 -0
  239. package/skills/integration/integration-nextjs-app-router/references/basic-integration-1.3-conclude.md +57 -0
  240. package/skills/integration/integration-nextjs-app-router/references/browser-sdk-2.md +4680 -0
  241. package/skills/integration/integration-nextjs-pages-router/SKILL.md +54 -0
  242. package/skills/integration/integration-nextjs-pages-router/references/EXAMPLE.md +735 -0
  243. package/skills/integration/integration-nextjs-pages-router/references/amplitude-quickstart.md +1845 -0
  244. package/skills/integration/integration-nextjs-pages-router/references/basic-integration-1.0-begin.md +43 -0
  245. package/skills/integration/integration-nextjs-pages-router/references/basic-integration-1.1-edit.md +35 -0
  246. package/skills/integration/integration-nextjs-pages-router/references/basic-integration-1.2-revise.md +23 -0
  247. package/skills/integration/integration-nextjs-pages-router/references/basic-integration-1.3-conclude.md +57 -0
  248. package/skills/integration/integration-nextjs-pages-router/references/browser-sdk-2.md +4680 -0
  249. package/skills/integration/integration-nuxt-3.6/SKILL.md +46 -0
  250. package/skills/integration/integration-nuxt-3.6/references/EXAMPLE.md +8422 -0
  251. package/skills/integration/integration-nuxt-3.6/references/amplitude-quickstart.md +1845 -0
  252. package/skills/integration/integration-nuxt-3.6/references/basic-integration-1.0-begin.md +43 -0
  253. package/skills/integration/integration-nuxt-3.6/references/basic-integration-1.1-edit.md +35 -0
  254. package/skills/integration/integration-nuxt-3.6/references/basic-integration-1.2-revise.md +23 -0
  255. package/skills/integration/integration-nuxt-3.6/references/basic-integration-1.3-conclude.md +57 -0
  256. package/skills/integration/integration-nuxt-3.6/references/browser-sdk-2.md +4680 -0
  257. package/skills/integration/integration-nuxt-4/SKILL.md +46 -0
  258. package/skills/integration/integration-nuxt-4/references/EXAMPLE.md +8670 -0
  259. package/skills/integration/integration-nuxt-4/references/amplitude-quickstart.md +1845 -0
  260. package/skills/integration/integration-nuxt-4/references/basic-integration-1.0-begin.md +43 -0
  261. package/skills/integration/integration-nuxt-4/references/basic-integration-1.1-edit.md +35 -0
  262. package/skills/integration/integration-nuxt-4/references/basic-integration-1.2-revise.md +23 -0
  263. package/skills/integration/integration-nuxt-4/references/basic-integration-1.3-conclude.md +57 -0
  264. package/skills/integration/integration-nuxt-4/references/browser-sdk-2.md +4680 -0
  265. package/skills/integration/integration-python/SKILL.md +53 -0
  266. package/skills/integration/integration-python/references/EXAMPLE.md +445 -0
  267. package/skills/integration/integration-python/references/amplitude-quickstart.md +1845 -0
  268. package/skills/integration/integration-python/references/basic-integration-1.0-begin.md +43 -0
  269. package/skills/integration/integration-python/references/basic-integration-1.1-edit.md +35 -0
  270. package/skills/integration/integration-python/references/basic-integration-1.2-revise.md +23 -0
  271. package/skills/integration/integration-python/references/basic-integration-1.3-conclude.md +57 -0
  272. package/skills/integration/integration-python/references/python.md +1424 -0
  273. package/skills/integration/integration-react-native/SKILL.md +49 -0
  274. package/skills/integration/integration-react-native/references/EXAMPLE.md +2253 -0
  275. package/skills/integration/integration-react-native/references/amplitude-quickstart.md +1845 -0
  276. package/skills/integration/integration-react-native/references/basic-integration-1.0-begin.md +43 -0
  277. package/skills/integration/integration-react-native/references/basic-integration-1.1-edit.md +35 -0
  278. package/skills/integration/integration-react-native/references/basic-integration-1.2-revise.md +23 -0
  279. package/skills/integration/integration-react-native/references/basic-integration-1.3-conclude.md +57 -0
  280. package/skills/integration/integration-react-native/references/react-native-sdk.md +2819 -0
  281. package/skills/integration/integration-react-react-router-6/SKILL.md +53 -0
  282. package/skills/integration/integration-react-react-router-6/references/EXAMPLE.md +570 -0
  283. package/skills/integration/integration-react-react-router-6/references/amplitude-quickstart.md +1845 -0
  284. package/skills/integration/integration-react-react-router-6/references/basic-integration-1.0-begin.md +43 -0
  285. package/skills/integration/integration-react-react-router-6/references/basic-integration-1.1-edit.md +35 -0
  286. package/skills/integration/integration-react-react-router-6/references/basic-integration-1.2-revise.md +23 -0
  287. package/skills/integration/integration-react-react-router-6/references/basic-integration-1.3-conclude.md +57 -0
  288. package/skills/integration/integration-react-react-router-6/references/browser-sdk-2.md +4680 -0
  289. package/skills/integration/integration-react-react-router-7-data/SKILL.md +53 -0
  290. package/skills/integration/integration-react-react-router-7-data/references/EXAMPLE.md +830 -0
  291. package/skills/integration/integration-react-react-router-7-data/references/amplitude-quickstart.md +1845 -0
  292. package/skills/integration/integration-react-react-router-7-data/references/basic-integration-1.0-begin.md +43 -0
  293. package/skills/integration/integration-react-react-router-7-data/references/basic-integration-1.1-edit.md +35 -0
  294. package/skills/integration/integration-react-react-router-7-data/references/basic-integration-1.2-revise.md +23 -0
  295. package/skills/integration/integration-react-react-router-7-data/references/basic-integration-1.3-conclude.md +57 -0
  296. package/skills/integration/integration-react-react-router-7-data/references/browser-sdk-2.md +4680 -0
  297. package/skills/integration/integration-react-react-router-7-declarative/SKILL.md +53 -0
  298. package/skills/integration/integration-react-react-router-7-declarative/references/EXAMPLE.md +609 -0
  299. package/skills/integration/integration-react-react-router-7-declarative/references/amplitude-quickstart.md +1845 -0
  300. package/skills/integration/integration-react-react-router-7-declarative/references/basic-integration-1.0-begin.md +43 -0
  301. package/skills/integration/integration-react-react-router-7-declarative/references/basic-integration-1.1-edit.md +35 -0
  302. package/skills/integration/integration-react-react-router-7-declarative/references/basic-integration-1.2-revise.md +23 -0
  303. package/skills/integration/integration-react-react-router-7-declarative/references/basic-integration-1.3-conclude.md +57 -0
  304. package/skills/integration/integration-react-react-router-7-declarative/references/browser-sdk-2.md +4680 -0
  305. package/skills/integration/integration-react-react-router-7-framework/SKILL.md +53 -0
  306. package/skills/integration/integration-react-react-router-7-framework/references/EXAMPLE.md +1081 -0
  307. package/skills/integration/integration-react-react-router-7-framework/references/amplitude-quickstart.md +1845 -0
  308. package/skills/integration/integration-react-react-router-7-framework/references/basic-integration-1.0-begin.md +43 -0
  309. package/skills/integration/integration-react-react-router-7-framework/references/basic-integration-1.1-edit.md +35 -0
  310. package/skills/integration/integration-react-react-router-7-framework/references/basic-integration-1.2-revise.md +23 -0
  311. package/skills/integration/integration-react-react-router-7-framework/references/basic-integration-1.3-conclude.md +57 -0
  312. package/skills/integration/integration-react-react-router-7-framework/references/browser-sdk-2.md +4680 -0
  313. package/skills/integration/integration-react-tanstack-router-code-based/SKILL.md +57 -0
  314. package/skills/integration/integration-react-tanstack-router-code-based/references/EXAMPLE.md +659 -0
  315. package/skills/integration/integration-react-tanstack-router-code-based/references/amplitude-quickstart.md +1845 -0
  316. package/skills/integration/integration-react-tanstack-router-code-based/references/basic-integration-1.0-begin.md +43 -0
  317. package/skills/integration/integration-react-tanstack-router-code-based/references/basic-integration-1.1-edit.md +35 -0
  318. package/skills/integration/integration-react-tanstack-router-code-based/references/basic-integration-1.2-revise.md +23 -0
  319. package/skills/integration/integration-react-tanstack-router-code-based/references/basic-integration-1.3-conclude.md +57 -0
  320. package/skills/integration/integration-react-tanstack-router-code-based/references/browser-sdk-2.md +4680 -0
  321. package/skills/integration/integration-react-tanstack-router-file-based/SKILL.md +57 -0
  322. package/skills/integration/integration-react-tanstack-router-file-based/references/EXAMPLE.md +777 -0
  323. package/skills/integration/integration-react-tanstack-router-file-based/references/amplitude-quickstart.md +1845 -0
  324. package/skills/integration/integration-react-tanstack-router-file-based/references/basic-integration-1.0-begin.md +43 -0
  325. package/skills/integration/integration-react-tanstack-router-file-based/references/basic-integration-1.1-edit.md +35 -0
  326. package/skills/integration/integration-react-tanstack-router-file-based/references/basic-integration-1.2-revise.md +23 -0
  327. package/skills/integration/integration-react-tanstack-router-file-based/references/basic-integration-1.3-conclude.md +57 -0
  328. package/skills/integration/integration-react-tanstack-router-file-based/references/browser-sdk-2.md +4680 -0
  329. package/skills/integration/integration-react-vite/SKILL.md +53 -0
  330. package/skills/integration/integration-react-vite/references/EXAMPLE.md +542 -0
  331. package/skills/integration/integration-react-vite/references/amplitude-quickstart.md +1845 -0
  332. package/skills/integration/integration-react-vite/references/basic-integration-1.0-begin.md +43 -0
  333. package/skills/integration/integration-react-vite/references/basic-integration-1.1-edit.md +35 -0
  334. package/skills/integration/integration-react-vite/references/basic-integration-1.2-revise.md +23 -0
  335. package/skills/integration/integration-react-vite/references/basic-integration-1.3-conclude.md +57 -0
  336. package/skills/integration/integration-react-vite/references/browser-sdk-2.md +4680 -0
  337. package/skills/integration/integration-ruby/SKILL.md +50 -0
  338. package/skills/integration/integration-ruby/references/EXAMPLE.md +420 -0
  339. package/skills/integration/integration-ruby/references/amplitude-quickstart.md +1845 -0
  340. package/skills/integration/integration-ruby/references/analytics.md +1778 -0
  341. package/skills/integration/integration-ruby/references/basic-integration-1.0-begin.md +43 -0
  342. package/skills/integration/integration-ruby/references/basic-integration-1.1-edit.md +35 -0
  343. package/skills/integration/integration-ruby/references/basic-integration-1.2-revise.md +23 -0
  344. package/skills/integration/integration-ruby/references/basic-integration-1.3-conclude.md +57 -0
  345. package/skills/integration/integration-ruby-on-rails/SKILL.md +55 -0
  346. package/skills/integration/integration-ruby-on-rails/references/EXAMPLE.md +1013 -0
  347. package/skills/integration/integration-ruby-on-rails/references/amplitude-quickstart.md +1845 -0
  348. package/skills/integration/integration-ruby-on-rails/references/analytics.md +1778 -0
  349. package/skills/integration/integration-ruby-on-rails/references/basic-integration-1.0-begin.md +43 -0
  350. package/skills/integration/integration-ruby-on-rails/references/basic-integration-1.1-edit.md +35 -0
  351. package/skills/integration/integration-ruby-on-rails/references/basic-integration-1.2-revise.md +23 -0
  352. package/skills/integration/integration-ruby-on-rails/references/basic-integration-1.3-conclude.md +57 -0
  353. package/skills/integration/integration-sveltekit/SKILL.md +47 -0
  354. package/skills/integration/integration-sveltekit/references/EXAMPLE.md +14121 -0
  355. package/skills/integration/integration-sveltekit/references/amplitude-quickstart.md +1845 -0
  356. package/skills/integration/integration-sveltekit/references/basic-integration-1.0-begin.md +43 -0
  357. package/skills/integration/integration-sveltekit/references/basic-integration-1.1-edit.md +35 -0
  358. package/skills/integration/integration-sveltekit/references/basic-integration-1.2-revise.md +23 -0
  359. package/skills/integration/integration-sveltekit/references/basic-integration-1.3-conclude.md +57 -0
  360. package/skills/integration/integration-sveltekit/references/browser-sdk-2.md +4680 -0
  361. package/skills/integration/integration-swift/SKILL.md +49 -0
  362. package/skills/integration/integration-swift/references/EXAMPLE.md +660 -0
  363. package/skills/integration/integration-swift/references/amplitude-quickstart.md +1845 -0
  364. package/skills/integration/integration-swift/references/analytics.md +1778 -0
  365. package/skills/integration/integration-swift/references/basic-integration-1.0-begin.md +43 -0
  366. package/skills/integration/integration-swift/references/basic-integration-1.1-edit.md +35 -0
  367. package/skills/integration/integration-swift/references/basic-integration-1.2-revise.md +23 -0
  368. package/skills/integration/integration-swift/references/basic-integration-1.3-conclude.md +57 -0
  369. package/skills/integration/integration-tanstack-start/SKILL.md +58 -0
  370. package/skills/integration/integration-tanstack-start/references/EXAMPLE.md +998 -0
  371. package/skills/integration/integration-tanstack-start/references/amplitude-quickstart.md +1845 -0
  372. package/skills/integration/integration-tanstack-start/references/basic-integration-1.0-begin.md +43 -0
  373. package/skills/integration/integration-tanstack-start/references/basic-integration-1.1-edit.md +35 -0
  374. package/skills/integration/integration-tanstack-start/references/basic-integration-1.2-revise.md +23 -0
  375. package/skills/integration/integration-tanstack-start/references/basic-integration-1.3-conclude.md +57 -0
  376. package/skills/integration/integration-tanstack-start/references/browser-sdk-2.md +4680 -0
  377. package/skills/integration/integration-vue-3/SKILL.md +46 -0
  378. package/skills/integration/integration-vue-3/references/EXAMPLE.md +846 -0
  379. package/skills/integration/integration-vue-3/references/amplitude-quickstart.md +1845 -0
  380. package/skills/integration/integration-vue-3/references/basic-integration-1.0-begin.md +43 -0
  381. package/skills/integration/integration-vue-3/references/basic-integration-1.1-edit.md +35 -0
  382. package/skills/integration/integration-vue-3/references/basic-integration-1.2-revise.md +23 -0
  383. package/skills/integration/integration-vue-3/references/basic-integration-1.3-conclude.md +57 -0
  384. package/skills/integration/integration-vue-3/references/browser-sdk-2.md +4680 -0
  385. package/skills/taxonomy/amplitude-quickstart-taxonomy-agent/SKILL.md +228 -0
  386. package/dist/src/ui/tui/components/TitleBar.d.ts +0 -8
  387. package/dist/src/ui/tui/components/TitleBar.js +0 -27
  388. package/dist/src/ui/tui/primitives/KagiSmallWebViewer.d.ts +0 -7
  389. package/dist/src/ui/tui/primitives/KagiSmallWebViewer.js +0 -101
  390. package/dist/src/utils/anthropic-status.d.ts +0 -17
  391. package/dist/src/utils/anthropic-status.js +0 -51
@@ -0,0 +1,1081 @@
1
+ # Amplitude React Router v7 - Framework mode Example Project
2
+
3
+ Repository: https://github.com/amplitude/context-hub
4
+ Path: basics/react-react-router-7-framework
5
+
6
+ ---
7
+
8
+ ## README.md
9
+
10
+ # Amplitude React Router 7 Framework example
11
+
12
+ This is a [React Router 7](https://reactrouter.com) Framework example demonstrating Amplitude integration with product analytics and event tracking.
13
+
14
+ ### Amplitude SDKs
15
+
16
+ The browser uses the [Browser Unified SDK (npm)](https://amplitude.com/docs/sdks/analytics/browser/browser-unified-sdk#unified-sdk-npm): [`@amplitude/unified`](https://www.npmjs.com/package/@amplitude/unified) with `initAll` in `entry.client.tsx`. [Initialize the Unified SDK](https://amplitude.com/docs/sdks/analytics/browser/browser-unified-sdk#initialize-the-unified-sdk) documents `initAll` as initializing every product bundled with Unified npm. [Unified SDK configuration](https://amplitude.com/docs/sdks/analytics/browser/browser-unified-sdk#configuration) covers `analytics`, `sessionReplay`, `experiment`, and `engagement`. The `experiment` block is **Feature Experiment** (`@amplitude/experiment-js-client`). Amplitude’s [product support table](https://amplitude.com/docs/sdks/analytics/browser/browser-unified-sdk#product-support-by-installation-method) lists **Web Experiment** (`@amplitude/experiment-tag`, including the visual editor) for the Unified **CDN** script, not Unified **npm**.
17
+
18
+ Middleware and API-style routes use [`@amplitude/analytics-node`](https://www.npmjs.com/package/@amplitude/analytics-node).
19
+
20
+ ## Features
21
+
22
+ - **Product Analytics**: Track user events and behaviors
23
+ - **User Authentication**: Demo login system with Amplitude user identification
24
+ - **Server-side & Client-side Tracking**: Examples of both tracking methods
25
+
26
+ ## Getting Started
27
+
28
+ ### 1. Install Dependencies
29
+
30
+ ```bash
31
+ npm install
32
+ # or
33
+ pnpm install
34
+ ```
35
+
36
+ ### 2. Configure Environment Variables
37
+
38
+ Create a `.env` file in the root directory:
39
+
40
+ ```bash
41
+ VITE_PUBLIC_AMPLITUDE_API_KEY=your_amplitude_api_key
42
+ ```
43
+
44
+ Get your Amplitude API key from your [Amplitude project settings](https://app.amplitude.com).
45
+
46
+ ### 3. Run the Development Server
47
+
48
+ ```bash
49
+ npm run dev
50
+ # or
51
+ pnpm dev
52
+ ```
53
+
54
+ Open [http://localhost:5173](http://localhost:5173) with your browser to see the app.
55
+
56
+ ## Project Structure
57
+
58
+ ```
59
+ app/
60
+ ├── components/
61
+ │ └── Header.tsx # Navigation header with auth state
62
+ ├── contexts/
63
+ │ └── AuthContext.tsx # Authentication context
64
+ ├── lib/
65
+ │ ├── amplitude-middleware.ts # Server-side Amplitude middleware
66
+ │ └── db.ts # SQLite database utilities
67
+ ├── routes/
68
+ │ ├── home.tsx # Home/Login page
69
+ │ ├── burrito.tsx # Demo feature page with event tracking
70
+ │ ├── profile.tsx # User profile page
71
+ │ ├── api.auth.login.ts # Login API with server-side tracking
72
+ │ └── api.burrito.consider.ts # Burrito API with server-side tracking
73
+ ├── entry.client.tsx # Client entry with Amplitude init
74
+ └── root.tsx # Root layout with middleware
75
+ ```
76
+
77
+ ## Key Integration Points
78
+
79
+ ### Client-side initialization (app/entry.client.tsx)
80
+
81
+ ```typescript
82
+ import * as amplitude from '@amplitude/unified';
83
+
84
+ void amplitude.initAll(import.meta.env.VITE_PUBLIC_AMPLITUDE_API_KEY);
85
+ ```
86
+
87
+ ### User identification (app/routes/home.tsx)
88
+
89
+ ```typescript
90
+ import * as amplitude from '@amplitude/unified';
91
+ import { Identify } from '@amplitude/unified';
92
+
93
+ amplitude.setUserId(username);
94
+ const identifyObj = new Identify();
95
+ identifyObj.set('username', username);
96
+ amplitude.identify(identifyObj);
97
+ amplitude.track('User Logged In', { username });
98
+ ```
99
+
100
+ ### Server-side tracking (app/routes/api.auth.login.ts)
101
+
102
+ ```typescript
103
+ import { getServerAmplitude } from "../lib/amplitude-middleware";
104
+
105
+ const amplitude = getServerAmplitude(apiKey);
106
+ if (amplitude) {
107
+ amplitude.track('Server Login Completed', { username }, { user_id: username });
108
+ await amplitude.flush();
109
+ }
110
+ ```
111
+
112
+ ## Learn More
113
+
114
+ - [Amplitude Documentation](https://amplitude.com/docs)
115
+ - [React Router 7 Documentation](https://reactrouter.com/home)
116
+ - [Amplitude Browser SDK](https://amplitude.com/docs/sdks/analytics/browser/browser-sdk-2)
117
+ - [Amplitude Node.js SDK](https://amplitude.com/docs/sdks/analytics/node)
118
+
119
+ ---
120
+
121
+ ## .env.example
122
+
123
+ ```example
124
+ VITE_PUBLIC_AMPLITUDE_API_KEY=
125
+
126
+ ```
127
+
128
+ ---
129
+
130
+ ## app/components/Header.tsx
131
+
132
+ ```tsx
133
+ import { Link } from 'react-router';
134
+ import { useAuth } from '../contexts/AuthContext';
135
+ import * as amplitude from '@amplitude/unified';
136
+
137
+ export default function Header() {
138
+ const { user, logout } = useAuth();
139
+
140
+ const handleLogout = () => {
141
+ amplitude.track('User Logged Out');
142
+ amplitude.reset();
143
+ logout();
144
+ };
145
+
146
+ return (
147
+ <header className="header">
148
+ <div className="header-container">
149
+ <nav>
150
+ <Link to="/">Home</Link>
151
+ {user && (
152
+ <>
153
+ <Link to="/burrito">Burrito Consideration</Link>
154
+ <Link to="/profile">Profile</Link>
155
+ </>
156
+ )}
157
+ </nav>
158
+ <div className="user-section">
159
+ {user ? (
160
+ <>
161
+ <span>Welcome, {user.username}!</span>
162
+ <button onClick={handleLogout} className="btn-logout">
163
+ Logout
164
+ </button>
165
+ </>
166
+ ) : (
167
+ <span>Not logged in</span>
168
+ )}
169
+ </div>
170
+ </div>
171
+ </header>
172
+ );
173
+ }
174
+
175
+ ```
176
+
177
+ ---
178
+
179
+ ## app/contexts/AuthContext.tsx
180
+
181
+ ```tsx
182
+ import { createContext, useContext, useState, type ReactNode } from 'react';
183
+
184
+ interface User {
185
+ username: string;
186
+ burritoConsiderations: number;
187
+ }
188
+
189
+ interface AuthContextType {
190
+ user: User | null;
191
+ login: (username: string, password: string) => Promise<boolean>;
192
+ logout: () => void;
193
+ incrementBurritoConsiderations: () => void;
194
+ setUser: (user: User) => void;
195
+ }
196
+
197
+ const AuthContext = createContext<AuthContextType | undefined>(undefined);
198
+
199
+ const users: Map<string, User> = new Map();
200
+
201
+ export function AuthProvider({ children }: { children: ReactNode }) {
202
+ const [user, setUser] = useState<User | null>(() => {
203
+ if (typeof window === 'undefined') return null;
204
+
205
+ const storedUsername = localStorage.getItem('currentUser');
206
+ if (storedUsername) {
207
+ const existingUser = users.get(storedUsername);
208
+ if (existingUser) {
209
+ return existingUser;
210
+ }
211
+ }
212
+ return null;
213
+ });
214
+
215
+ const login = async (username: string, password: string): Promise<boolean> => {
216
+ try {
217
+ const response = await fetch('/api/auth/login', {
218
+ method: 'POST',
219
+ headers: { 'Content-Type': 'application/json' },
220
+ body: JSON.stringify({ username, password }),
221
+ });
222
+
223
+ if (response.ok) {
224
+ const { user: userData } = await response.json();
225
+
226
+ let localUser = users.get(username);
227
+ if (!localUser) {
228
+ localUser = userData as User;
229
+ users.set(username, localUser);
230
+ }
231
+
232
+ setUser(localUser);
233
+ localStorage.setItem('currentUser', username);
234
+
235
+ return true;
236
+ }
237
+ return false;
238
+ } catch (error) {
239
+ console.error('Login error:', error);
240
+ return false;
241
+ }
242
+ };
243
+
244
+ const logout = () => {
245
+ setUser(null);
246
+ localStorage.removeItem('currentUser');
247
+ };
248
+
249
+ const incrementBurritoConsiderations = () => {
250
+ if (user) {
251
+ user.burritoConsiderations++;
252
+ users.set(user.username, user);
253
+ setUser({ ...user });
254
+ }
255
+ };
256
+
257
+ const setUserState = (newUser: User) => {
258
+ setUser(newUser);
259
+ users.set(newUser.username, newUser);
260
+ };
261
+
262
+ return (
263
+ <AuthContext.Provider value={{ user, login, logout, incrementBurritoConsiderations, setUser: setUserState }}>
264
+ {children}
265
+ </AuthContext.Provider>
266
+ );
267
+ }
268
+
269
+ export function useAuth() {
270
+ const context = useContext(AuthContext);
271
+ if (context === undefined) {
272
+ throw new Error('useAuth must be used within an AuthProvider');
273
+ }
274
+ return context;
275
+ }
276
+
277
+
278
+ ```
279
+
280
+ ---
281
+
282
+ ## app/entry.client.tsx
283
+
284
+ ```tsx
285
+ import { startTransition, StrictMode } from "react";
286
+ import { hydrateRoot } from "react-dom/client";
287
+ import { HydratedRouter } from "react-router/dom";
288
+
289
+ import * as amplitude from '@amplitude/unified';
290
+
291
+ void amplitude.initAll(import.meta.env.VITE_PUBLIC_AMPLITUDE_API_KEY);
292
+
293
+ startTransition(() => {
294
+ hydrateRoot(
295
+ document,
296
+ <StrictMode>
297
+ <HydratedRouter />
298
+ </StrictMode>,
299
+ );
300
+ });
301
+
302
+ ```
303
+
304
+ ---
305
+
306
+ ## app/entry.server.tsx
307
+
308
+ ```tsx
309
+ import { PassThrough } from "node:stream";
310
+
311
+ import type { EntryContext, RouterContextProvider } from "react-router";
312
+ import { createReadableStreamFromReadable } from "@react-router/node";
313
+ import { ServerRouter } from "react-router";
314
+ import { isbot } from "isbot";
315
+ import type { RenderToPipeableStreamOptions } from "react-dom/server";
316
+ import { renderToPipeableStream } from "react-dom/server";
317
+
318
+ export const streamTimeout = 5_000;
319
+
320
+ export default function handleRequest(
321
+ request: Request,
322
+ responseStatusCode: number,
323
+ responseHeaders: Headers,
324
+ routerContext: EntryContext,
325
+ loadContext: RouterContextProvider,
326
+ ) {
327
+ // https://httpwg.org/specs/rfc9110.html#HEAD
328
+ if (request.method.toUpperCase() === "HEAD") {
329
+ return new Response(null, {
330
+ status: responseStatusCode,
331
+ headers: responseHeaders,
332
+ });
333
+ }
334
+
335
+ return new Promise((resolve, reject) => {
336
+ let shellRendered = false;
337
+ let userAgent = request.headers.get("user-agent");
338
+
339
+ // Ensure requests from bots and SPA Mode renders wait for all content to load before responding
340
+ // https://react.dev/reference/react-dom/server/renderToPipeableStream#waiting-for-all-content-to-load-for-crawlers-and-static-generation
341
+ let readyOption: keyof RenderToPipeableStreamOptions =
342
+ (userAgent && isbot(userAgent)) || routerContext.isSpaMode
343
+ ? "onAllReady"
344
+ : "onShellReady";
345
+
346
+ // Abort the rendering stream after the `streamTimeout` so it has time to
347
+ // flush down the rejected boundaries
348
+ let timeoutId: ReturnType<typeof setTimeout> | undefined = setTimeout(
349
+ () => abort(),
350
+ streamTimeout + 1000,
351
+ );
352
+
353
+ const { pipe, abort } = renderToPipeableStream(
354
+ <ServerRouter context={routerContext} url={request.url} />,
355
+ {
356
+ [readyOption]() {
357
+ shellRendered = true;
358
+ const body = new PassThrough({
359
+ final(callback) {
360
+ // Clear the timeout to prevent retaining the closure and memory leak
361
+ clearTimeout(timeoutId);
362
+ timeoutId = undefined;
363
+ callback();
364
+ },
365
+ });
366
+ const stream = createReadableStreamFromReadable(body);
367
+
368
+ responseHeaders.set("Content-Type", "text/html");
369
+
370
+ pipe(body);
371
+
372
+ resolve(
373
+ new Response(stream, {
374
+ headers: responseHeaders,
375
+ status: responseStatusCode,
376
+ }),
377
+ );
378
+ },
379
+ onShellError(error: unknown) {
380
+ reject(error);
381
+ },
382
+ onError(error: unknown) {
383
+ responseStatusCode = 500;
384
+ // Log streaming rendering errors from inside the shell. Don't log
385
+ // errors encountered during initial shell rendering since they'll
386
+ // reject and get logged in handleDocumentRequest.
387
+ if (shellRendered) {
388
+ console.error(error);
389
+ }
390
+ },
391
+ },
392
+ );
393
+ });
394
+ }
395
+
396
+ ```
397
+
398
+ ---
399
+
400
+ ## app/lib/amplitude-middleware.ts
401
+
402
+ ```ts
403
+ import { createInstance } from "@amplitude/analytics-node";
404
+ import type { RouterContextProvider } from "react-router";
405
+ import type { Route } from "../+types/root";
406
+
407
+ export interface AmplitudeContext extends RouterContextProvider {
408
+ amplitudeApiKey?: string;
409
+ }
410
+
411
+ export const amplitudeMiddleware: Route.MiddlewareFunction = async ({ context }, next) => {
412
+ const apiKey = process.env.VITE_PUBLIC_AMPLITUDE_API_KEY;
413
+ (context as AmplitudeContext).amplitudeApiKey = apiKey;
414
+ return await next();
415
+ };
416
+
417
+ export function getServerAmplitude(apiKey: string | undefined) {
418
+ if (!apiKey) return null;
419
+ const client = createInstance();
420
+ client.init(apiKey);
421
+ return client;
422
+ }
423
+
424
+ ```
425
+
426
+ ---
427
+
428
+ ## app/lib/db.ts
429
+
430
+ ```ts
431
+ import sqlite3 from "sqlite3";
432
+ import { join } from "node:path";
433
+ import { promisify } from "node:util";
434
+
435
+ const dbPath = join(process.cwd(), "burrito-considerations.db");
436
+
437
+ const db = new sqlite3.Database(dbPath);
438
+
439
+ // Initialize schema
440
+ db.serialize(() => {
441
+ db.run(`
442
+ CREATE TABLE IF NOT EXISTS burrito_considerations (
443
+ username TEXT PRIMARY KEY,
444
+ count INTEGER NOT NULL DEFAULT 0
445
+ )
446
+ `);
447
+ });
448
+
449
+ const dbGet = promisify(db.get.bind(db));
450
+ const dbRun = promisify(db.run.bind(db));
451
+
452
+ export function getBurritoConsiderations(username: string): Promise<number> {
453
+ return dbGet("SELECT count FROM burrito_considerations WHERE username = ?", [username])
454
+ .then((row: any) => row?.count ?? 0);
455
+ }
456
+
457
+ export function incrementBurritoConsiderations(username: string): Promise<number> {
458
+ return dbRun(`
459
+ INSERT INTO burrito_considerations (username, count)
460
+ VALUES (?, 1)
461
+ ON CONFLICT(username) DO UPDATE SET count = count + 1
462
+ `, [username])
463
+ .then(() => {
464
+ return dbGet("SELECT count FROM burrito_considerations WHERE username = ?", [username]);
465
+ })
466
+ .then((row: any) => row.count);
467
+ }
468
+
469
+ ```
470
+
471
+ ---
472
+
473
+ ## app/root.tsx
474
+
475
+ ```tsx
476
+ import {
477
+ isRouteErrorResponse,
478
+ Links,
479
+ Meta,
480
+ Outlet,
481
+ Scripts,
482
+ ScrollRestoration,
483
+ } from "react-router";
484
+
485
+ import type { Route } from "./+types/root";
486
+ import "./app.css";
487
+ import "./globals.css";
488
+ import Header from "./components/Header";
489
+ import { AuthProvider } from "./contexts/AuthContext";
490
+ import { amplitudeMiddleware } from "./lib/amplitude-middleware";
491
+
492
+ export const middleware: Route.MiddlewareFunction[] = [
493
+ amplitudeMiddleware,
494
+ ];
495
+
496
+ export const links: Route.LinksFunction = () => [
497
+ { rel: "preconnect", href: "https://fonts.googleapis.com" },
498
+ {
499
+ rel: "preconnect",
500
+ href: "https://fonts.gstatic.com",
501
+ crossOrigin: "anonymous",
502
+ },
503
+ {
504
+ rel: "stylesheet",
505
+ href: "https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&display=swap",
506
+ },
507
+ ];
508
+
509
+ export function Layout({ children }: { children: React.ReactNode }) {
510
+ return (
511
+ <html lang="en">
512
+ <head>
513
+ <meta charSet="utf-8" />
514
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
515
+ <Meta />
516
+ <Links />
517
+ </head>
518
+ <body>
519
+ {children}
520
+ <ScrollRestoration />
521
+ <Scripts />
522
+ </body>
523
+ </html>
524
+ );
525
+ }
526
+
527
+ export default function App() {
528
+ return (
529
+ <AuthProvider>
530
+ <Header />
531
+ <main>
532
+ <Outlet />
533
+ </main>
534
+ </AuthProvider>
535
+ );
536
+ }
537
+
538
+ export function ErrorBoundary({ error }: Route.ErrorBoundaryProps) {
539
+ let message = "Oops!";
540
+ let details = "An unexpected error occurred.";
541
+ let stack: string | undefined;
542
+
543
+ if (isRouteErrorResponse(error)) {
544
+ message = error.status === 404 ? "404" : "Error";
545
+ details =
546
+ error.status === 404
547
+ ? "The requested page could not be found."
548
+ : error.statusText || details;
549
+ } else if (import.meta.env.DEV && error && error instanceof Error) {
550
+ details = error.message;
551
+ stack = error.stack;
552
+ }
553
+
554
+ return (
555
+ <main className="pt-16 p-4 container mx-auto">
556
+ <h1>{message}</h1>
557
+ <p>{details}</p>
558
+ {stack && (
559
+ <pre className="w-full p-4 overflow-x-auto">
560
+ <code>{stack}</code>
561
+ </pre>
562
+ )}
563
+ </main>
564
+ );
565
+ }
566
+
567
+ ```
568
+
569
+ ---
570
+
571
+ ## app/routes.ts
572
+
573
+ ```ts
574
+ import { type RouteConfig, index, route } from "@react-router/dev/routes";
575
+
576
+ export default [
577
+ index("routes/home.tsx"),
578
+ route("burrito", "routes/burrito.tsx"),
579
+ route("profile", "routes/profile.tsx"),
580
+ route("error", "routes/error.tsx"),
581
+ route("api/auth/login", "routes/api.auth.login.ts"),
582
+ route("api/burrito/consider", "routes/api.burrito.consider.ts"),
583
+ ] satisfies RouteConfig;
584
+
585
+ ```
586
+
587
+ ---
588
+
589
+ ## app/routes/api.auth.login.ts
590
+
591
+ ```ts
592
+ import type { Route } from "./+types/api.auth.login";
593
+ import { getBurritoConsiderations } from "../lib/db";
594
+ import { type AmplitudeContext, getServerAmplitude } from "../lib/amplitude-middleware";
595
+
596
+ const users = new Map<string, { username: string }>();
597
+
598
+ export { users };
599
+
600
+ export async function action({ request, context }: Route.ActionArgs) {
601
+ const body = await request.json();
602
+ const { username, password } = body;
603
+
604
+ if (!username || !password) {
605
+ return Response.json({ error: 'Username and password required' }, { status: 400 });
606
+ }
607
+
608
+ let user = users.get(username);
609
+
610
+ if (!user) {
611
+ user = { username };
612
+ users.set(username, user);
613
+ }
614
+
615
+ const apiKey = (context as AmplitudeContext).amplitudeApiKey;
616
+ const amplitude = getServerAmplitude(apiKey);
617
+ if (amplitude) {
618
+ amplitude.track('Server Login Completed', { username }, { user_id: username });
619
+ await amplitude.flush();
620
+ }
621
+
622
+ const burritoConsiderations = await getBurritoConsiderations(username);
623
+
624
+ return Response.json({
625
+ success: true,
626
+ user: { ...user, burritoConsiderations }
627
+ });
628
+ }
629
+
630
+ ```
631
+
632
+ ---
633
+
634
+ ## app/routes/api.burrito.consider.ts
635
+
636
+ ```ts
637
+ import type { Route } from "./+types/api.burrito.consider";
638
+ import { users } from "./api.auth.login";
639
+ import { incrementBurritoConsiderations } from "../lib/db";
640
+ import { type AmplitudeContext, getServerAmplitude } from "../lib/amplitude-middleware";
641
+
642
+ export async function action({ request, context }: Route.ActionArgs) {
643
+ const body = await request.json();
644
+ const { username } = body;
645
+
646
+ if (!username) {
647
+ return Response.json({ error: 'Username required' }, { status: 400 });
648
+ }
649
+
650
+ const user = users.get(username);
651
+
652
+ if (!user) {
653
+ return Response.json({ error: 'User not found' }, { status: 404 });
654
+ }
655
+
656
+ const burritoConsiderations = await incrementBurritoConsiderations(username);
657
+
658
+ const apiKey = (context as AmplitudeContext).amplitudeApiKey;
659
+ const amplitude = getServerAmplitude(apiKey);
660
+ if (amplitude) {
661
+ amplitude.track('Burrito Considered', {
662
+ username,
663
+ total_considerations: burritoConsiderations,
664
+ }, { user_id: username });
665
+ await amplitude.flush();
666
+ }
667
+
668
+ return Response.json({
669
+ success: true,
670
+ user: { ...user, burritoConsiderations }
671
+ });
672
+ }
673
+
674
+ ```
675
+
676
+ ---
677
+
678
+ ## app/routes/burrito.tsx
679
+
680
+ ```tsx
681
+ import { useState, useEffect } from 'react';
682
+ import { useNavigate } from 'react-router';
683
+ import type { Route } from "./+types/burrito";
684
+ import { useAuth } from '../contexts/AuthContext';
685
+
686
+ export function meta({}: Route.MetaArgs) {
687
+ return [
688
+ { title: "Burrito Consideration - Burrito Consideration App" },
689
+ { name: "description", content: "Consider the potential of burritos" },
690
+ ];
691
+ }
692
+
693
+ export default function BurritoPage() {
694
+ const { user, setUser } = useAuth();
695
+ const navigate = useNavigate();
696
+ const [hasConsidered, setHasConsidered] = useState(false);
697
+
698
+ useEffect(() => {
699
+ if (!user) {
700
+ navigate('/');
701
+ }
702
+ }, [user, navigate]);
703
+
704
+ if (!user) {
705
+ return null;
706
+ }
707
+
708
+ const handleConsideration = async () => {
709
+ try {
710
+ const response = await fetch('/api/burrito/consider', {
711
+ method: 'POST',
712
+ headers: { 'Content-Type': 'application/json' },
713
+ body: JSON.stringify({ username: user.username }),
714
+ });
715
+
716
+ if (response.ok) {
717
+ const { user: updatedUser } = await response.json();
718
+ setUser(updatedUser);
719
+ setHasConsidered(true);
720
+ setTimeout(() => setHasConsidered(false), 2000);
721
+ } else {
722
+ console.error('Failed to increment burrito considerations');
723
+ }
724
+ } catch (err) {
725
+ console.error('Error considering burrito:', err);
726
+ }
727
+ };
728
+
729
+ return (
730
+ <div className="container">
731
+ <h1>Burrito consideration zone</h1>
732
+ <p>Take a moment to truly consider the potential of burritos.</p>
733
+
734
+ <div style={{ textAlign: 'center' }}>
735
+ <button
736
+ onClick={handleConsideration}
737
+ className="btn-burrito"
738
+ >
739
+ I have considered the burrito potential
740
+ </button>
741
+
742
+ {hasConsidered && (
743
+ <p className="success">
744
+ Thank you for your consideration! Count: {user.burritoConsiderations}
745
+ </p>
746
+ )}
747
+ </div>
748
+
749
+ <div className="stats">
750
+ <h3>Consideration stats</h3>
751
+ <p>Total considerations: {user.burritoConsiderations}</p>
752
+ </div>
753
+ </div>
754
+ );
755
+ }
756
+
757
+
758
+ ```
759
+
760
+ ---
761
+
762
+ ## app/routes/error.tsx
763
+
764
+ ```tsx
765
+ import type { Route } from "./+types/error";
766
+
767
+ export function meta({}: Route.MetaArgs) {
768
+ return [
769
+ { title: "Error Test - Burrito Consideration App" },
770
+ { name: "description", content: "Test error boundary" },
771
+ ];
772
+ }
773
+
774
+ export default function ErrorPage() {
775
+ // This will throw an error during render, which will be caught by ErrorBoundary
776
+ throw new Error('Test error for ErrorBoundary - this is a render-time error');
777
+ }
778
+
779
+
780
+ ```
781
+
782
+ ---
783
+
784
+ ## app/routes/home.tsx
785
+
786
+ ```tsx
787
+ import { useState } from 'react';
788
+ import type { Route } from "./+types/home";
789
+ import { useAuth } from '../contexts/AuthContext';
790
+ import * as amplitude from '@amplitude/unified';
791
+ import { Identify } from '@amplitude/unified';
792
+
793
+ export function meta({}: Route.MetaArgs) {
794
+ return [
795
+ { title: "Burrito Consideration App" },
796
+ { name: "description", content: "Consider the potential of burritos" },
797
+ ];
798
+ }
799
+
800
+ export default function Home() {
801
+ const { user, login } = useAuth();
802
+ const [username, setUsername] = useState('');
803
+ const [password, setPassword] = useState('');
804
+ const [error, setError] = useState('');
805
+
806
+ const handleSubmit = async (e: React.FormEvent) => {
807
+ e.preventDefault();
808
+ setError('');
809
+
810
+ try {
811
+ const success = await login(username, password);
812
+ if (success) {
813
+ // Identify user in Amplitude using username as user ID
814
+ amplitude.setUserId(username);
815
+ const identifyObj = new Identify();
816
+ identifyObj.set('username', username);
817
+ amplitude.identify(identifyObj);
818
+
819
+ // Capture login event
820
+ amplitude.track('User Logged In', { username });
821
+
822
+ setUsername('');
823
+ setPassword('');
824
+ } else {
825
+ setError('Please provide both username and password');
826
+ }
827
+ } catch (err) {
828
+ console.error('Login failed:', err);
829
+ setError('An error occurred during login');
830
+ }
831
+ };
832
+
833
+ if (user) {
834
+ return (
835
+ <div className="container">
836
+ <h1>Welcome back, {user.username}!</h1>
837
+ <p>You are now logged in. Feel free to explore:</p>
838
+ <ul>
839
+ <li>Consider the potential of burritos</li>
840
+ <li>View your profile and statistics</li>
841
+ </ul>
842
+ </div>
843
+ );
844
+ }
845
+
846
+ return (
847
+ <div className="container">
848
+ <h1>Welcome to Burrito Consideration App</h1>
849
+ <p>Please sign in to begin your burrito journey</p>
850
+
851
+ <form onSubmit={handleSubmit} className="form">
852
+ <div className="form-group">
853
+ <label htmlFor="username">Username:</label>
854
+ <input
855
+ type="text"
856
+ id="username"
857
+ value={username}
858
+ onChange={(e) => setUsername(e.target.value)}
859
+ placeholder="Enter any username"
860
+ />
861
+ </div>
862
+
863
+ <div className="form-group">
864
+ <label htmlFor="password">Password:</label>
865
+ <input
866
+ type="password"
867
+ id="password"
868
+ value={password}
869
+ onChange={(e) => setPassword(e.target.value)}
870
+ placeholder="Enter any password"
871
+ />
872
+ </div>
873
+
874
+ {error && <p className="error">{error}</p>}
875
+
876
+ <button type="submit" className="btn-primary">Sign In</button>
877
+ </form>
878
+
879
+ <p className="note">
880
+ Note: This is a demo app. Use any username and password to sign in.
881
+ </p>
882
+ </div>
883
+ );
884
+ }
885
+
886
+ ```
887
+
888
+ ---
889
+
890
+ ## app/routes/profile.tsx
891
+
892
+ ```tsx
893
+ import { useEffect } from 'react';
894
+ import { useNavigate } from 'react-router';
895
+ import type { Route } from "./+types/profile";
896
+ import { useAuth } from '../contexts/AuthContext';
897
+
898
+ export function meta({}: Route.MetaArgs) {
899
+ return [
900
+ { title: "User Profile - Burrito Consideration App" },
901
+ { name: "description", content: "View your profile and burrito consideration stats" },
902
+ ];
903
+ }
904
+
905
+ export default function ProfilePage() {
906
+ const { user } = useAuth();
907
+ const navigate = useNavigate();
908
+
909
+ useEffect(() => {
910
+ if (!user) {
911
+ navigate('/');
912
+ }
913
+ }, [user, navigate]);
914
+
915
+ if (!user) {
916
+ return null;
917
+ }
918
+
919
+ return (
920
+ <div className="container">
921
+ <h1>User Profile</h1>
922
+
923
+ <div className="stats">
924
+ <h2>Your Information</h2>
925
+ <p><strong>Username:</strong> {user.username}</p>
926
+ <p><strong>Burrito Considerations:</strong> {user.burritoConsiderations}</p>
927
+ </div>
928
+
929
+ <div style={{ marginTop: '2rem' }}>
930
+ <h3>Your Burrito Journey</h3>
931
+ {user.burritoConsiderations === 0 ? (
932
+ <p>You haven&apos;t considered any burritos yet. Visit the Burrito Consideration page to start!</p>
933
+ ) : user.burritoConsiderations === 1 ? (
934
+ <p>You&apos;ve considered the burrito potential once. Keep going!</p>
935
+ ) : user.burritoConsiderations < 5 ? (
936
+ <p>You&apos;re getting the hang of burrito consideration!</p>
937
+ ) : user.burritoConsiderations < 10 ? (
938
+ <p>You&apos;re becoming a burrito consideration expert!</p>
939
+ ) : (
940
+ <p>You are a true burrito consideration master! 🌯</p>
941
+ )}
942
+ </div>
943
+ </div>
944
+ );
945
+ }
946
+
947
+ ```
948
+
949
+ ---
950
+
951
+ ## app/welcome/welcome.tsx
952
+
953
+ ```tsx
954
+ import logoDark from "./logo-dark.svg";
955
+ import logoLight from "./logo-light.svg";
956
+
957
+ export function Welcome() {
958
+ return (
959
+ <main className="flex items-center justify-center pt-16 pb-4">
960
+ <div className="flex-1 flex flex-col items-center gap-16 min-h-0">
961
+ <header className="flex flex-col items-center gap-9">
962
+ <div className="w-[500px] max-w-[100vw] p-4">
963
+ <img
964
+ src={logoLight}
965
+ alt="React Router"
966
+ className="block w-full dark:hidden"
967
+ />
968
+ <img
969
+ src={logoDark}
970
+ alt="React Router"
971
+ className="hidden w-full dark:block"
972
+ />
973
+ </div>
974
+ </header>
975
+ <div className="max-w-[300px] w-full space-y-6 px-4">
976
+ <nav className="rounded-3xl border border-gray-200 p-6 dark:border-gray-700 space-y-4">
977
+ <p className="leading-6 text-gray-700 dark:text-gray-200 text-center">
978
+ What&apos;s next?
979
+ </p>
980
+ <ul>
981
+ {resources.map(({ href, text, icon }) => (
982
+ <li key={href}>
983
+ <a
984
+ className="group flex items-center gap-3 self-stretch p-3 leading-normal text-blue-700 hover:underline dark:text-blue-500"
985
+ href={href}
986
+ target="_blank"
987
+ rel="noreferrer"
988
+ >
989
+ {icon}
990
+ {text}
991
+ </a>
992
+ </li>
993
+ ))}
994
+ </ul>
995
+ </nav>
996
+ </div>
997
+ </div>
998
+ </main>
999
+ );
1000
+ }
1001
+
1002
+ const resources = [
1003
+ {
1004
+ href: "https://reactrouter.com/docs",
1005
+ text: "React Router Docs",
1006
+ icon: (
1007
+ <svg
1008
+ xmlns="http://www.w3.org/2000/svg"
1009
+ width="24"
1010
+ height="20"
1011
+ viewBox="0 0 20 20"
1012
+ fill="none"
1013
+ className="stroke-gray-600 group-hover:stroke-current dark:stroke-gray-300"
1014
+ >
1015
+ <path
1016
+ d="M9.99981 10.0751V9.99992M17.4688 17.4688C15.889 19.0485 11.2645 16.9853 7.13958 12.8604C3.01467 8.73546 0.951405 4.11091 2.53116 2.53116C4.11091 0.951405 8.73546 3.01467 12.8604 7.13958C16.9853 11.2645 19.0485 15.889 17.4688 17.4688ZM2.53132 17.4688C0.951566 15.8891 3.01483 11.2645 7.13974 7.13963C11.2647 3.01471 15.8892 0.951453 17.469 2.53121C19.0487 4.11096 16.9854 8.73551 12.8605 12.8604C8.73562 16.9853 4.11107 19.0486 2.53132 17.4688Z"
1017
+ strokeWidth="1.5"
1018
+ strokeLinecap="round"
1019
+ />
1020
+ </svg>
1021
+ ),
1022
+ },
1023
+ {
1024
+ href: "https://rmx.as/discord",
1025
+ text: "Join Discord",
1026
+ icon: (
1027
+ <svg
1028
+ xmlns="http://www.w3.org/2000/svg"
1029
+ width="24"
1030
+ height="20"
1031
+ viewBox="0 0 24 20"
1032
+ fill="none"
1033
+ className="stroke-gray-600 group-hover:stroke-current dark:stroke-gray-300"
1034
+ >
1035
+ <path
1036
+ d="M15.0686 1.25995L14.5477 1.17423L14.2913 1.63578C14.1754 1.84439 14.0545 2.08275 13.9422 2.31963C12.6461 2.16488 11.3406 2.16505 10.0445 2.32014C9.92822 2.08178 9.80478 1.84975 9.67412 1.62413L9.41449 1.17584L8.90333 1.25995C7.33547 1.51794 5.80717 1.99419 4.37748 2.66939L4.19 2.75793L4.07461 2.93019C1.23864 7.16437 0.46302 11.3053 0.838165 15.3924L0.868838 15.7266L1.13844 15.9264C2.81818 17.1714 4.68053 18.1233 6.68582 18.719L7.18892 18.8684L7.50166 18.4469C7.96179 17.8268 8.36504 17.1824 8.709 16.4944L8.71099 16.4904C10.8645 17.0471 13.128 17.0485 15.2821 16.4947C15.6261 17.1826 16.0293 17.8269 16.4892 18.4469L16.805 18.8725L17.3116 18.717C19.3056 18.105 21.1876 17.1751 22.8559 15.9238L23.1224 15.724L23.1528 15.3923C23.5873 10.6524 22.3579 6.53306 19.8947 2.90714L19.7759 2.73227L19.5833 2.64518C18.1437 1.99439 16.6386 1.51826 15.0686 1.25995ZM16.6074 10.7755L16.6074 10.7756C16.5934 11.6409 16.0212 12.1444 15.4783 12.1444C14.9297 12.1444 14.3493 11.6173 14.3493 10.7877C14.3493 9.94885 14.9378 9.41192 15.4783 9.41192C16.0471 9.41192 16.6209 9.93851 16.6074 10.7755ZM8.49373 12.1444C7.94513 12.1444 7.36471 11.6173 7.36471 10.7877C7.36471 9.94885 7.95323 9.41192 8.49373 9.41192C9.06038 9.41192 9.63892 9.93712 9.6417 10.7815C9.62517 11.6239 9.05462 12.1444 8.49373 12.1444Z"
1037
+ strokeWidth="1.5"
1038
+ />
1039
+ </svg>
1040
+ ),
1041
+ },
1042
+ ];
1043
+
1044
+ ```
1045
+
1046
+ ---
1047
+
1048
+ ## react-router.config.ts
1049
+
1050
+ ```ts
1051
+ import type { Config } from "@react-router/dev/config";
1052
+
1053
+ export default {
1054
+ // Config options...
1055
+ // Server-side render by default, to enable SPA mode set this to `false`
1056
+ ssr: true,
1057
+ future: {
1058
+ v8_middleware: true,
1059
+ },
1060
+ } satisfies Config;
1061
+
1062
+ ```
1063
+
1064
+ ---
1065
+
1066
+ ## vite.config.ts
1067
+
1068
+ ```ts
1069
+ import { reactRouter } from "@react-router/dev/vite";
1070
+ import tailwindcss from "@tailwindcss/vite";
1071
+ import { defineConfig } from "vite";
1072
+ import tsconfigPaths from "vite-tsconfig-paths";
1073
+
1074
+ export default defineConfig({
1075
+ plugins: [tailwindcss(), reactRouter(), tsconfigPaths()],
1076
+ });
1077
+
1078
+ ```
1079
+
1080
+ ---
1081
+