create-fullstack-scaffold 0.1.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 (530) hide show
  1. package/README.md +154 -0
  2. package/dist/cli/index.d.ts +2 -0
  3. package/dist/cli/index.js +439 -0
  4. package/dist/cli/index.js.map +1 -0
  5. package/package.json +171 -0
  6. package/template/.agents/skills/writing-hookify-rules/SKILL.md +408 -0
  7. package/template/.ai-context.md +368 -0
  8. package/template/.claude/hookify.block-dangerous-commands.local.md +41 -0
  9. package/template/.claude/hookify.check-api-types.local.md +111 -0
  10. package/template/.claude/hookify.check-duplicate-types.local.md +287 -0
  11. package/template/.claude/hookify.check-test-assertions.local.md +93 -0
  12. package/template/.claude/hookify.remind-add-tests.local.md +209 -0
  13. package/template/.claude/hookify.remind-db-migration.local.md +58 -0
  14. package/template/.claude/hookify.remind-run-tests.local.md +52 -0
  15. package/template/.claude/hookify.warn-any-type.local.md +203 -0
  16. package/template/.claude/hookify.warn-console-log.local.md +73 -0
  17. package/template/.claude/rules/00-project-config.md +147 -0
  18. package/template/.claude/rules/01-file-types.md +127 -0
  19. package/template/.claude/rules/02-git-workflow.md +167 -0
  20. package/template/.claude/rules/10-api-type-inference.md +555 -0
  21. package/template/.claude/rules/20-server-api.md +349 -0
  22. package/template/.claude/rules/21-server-entrypoint.md +257 -0
  23. package/template/.claude/rules/30-client-components.md +314 -0
  24. package/template/.claude/rules/31-client-services.md +768 -0
  25. package/template/.claude/rules/32-client-state-zustand.md +324 -0
  26. package/template/.claude/rules/33-client-app-entry.md +276 -0
  27. package/template/.claude/rules/34-client-admin-module.md +445 -0
  28. package/template/.claude/rules/35-cli-module.md +259 -0
  29. package/template/.claude/rules/40-admin-module.md +495 -0
  30. package/template/.claude/rules/40-shared-types.md +450 -0
  31. package/template/.claude/rules/50-websocket.md +245 -0
  32. package/template/.claude/rules/51-sse.md +372 -0
  33. package/template/.claude/rules/52-cloudflare-realtime.md +384 -0
  34. package/template/.claude/rules/60-testing-standards.md +245 -0
  35. package/template/.claude/rules/61-hono-testing.md +200 -0
  36. package/template/.claude/scripts/README.md +187 -0
  37. package/template/.claude/scripts/check-duplicate-types.ts +188 -0
  38. package/template/.claude/scripts/post-edit-check-incremental.sh +61 -0
  39. package/template/.claude/scripts/post-edit-check.sh +22 -0
  40. package/template/.claude/scripts/pre-tool-use-check.sh +86 -0
  41. package/template/.claude/scripts/test-pre-tool-use.sh +73 -0
  42. package/template/.claude/scripts/validate-git-changes.sh +38 -0
  43. package/template/.claude/settings.json +32 -0
  44. package/template/.claude/skills/writing-hookify-rules/SKILL.md +408 -0
  45. package/template/.dev-context-compact.md +54 -0
  46. package/template/.dev-context.md +621 -0
  47. package/template/.dev-guide.md +243 -0
  48. package/template/.env.example +60 -0
  49. package/template/.eslintrc.routes.json +39 -0
  50. package/template/.husky/_/husky.sh +27 -0
  51. package/template/.husky/commit-msg +4 -0
  52. package/template/.husky/post-commit +4 -0
  53. package/template/.husky/pre-commit +19 -0
  54. package/template/.husky/pre-push +12 -0
  55. package/template/.prettierignore +22 -0
  56. package/template/.prettierrc +8 -0
  57. package/template/.sessions/3/2026-03-26T05-41-09-154Z_03bb597f-3898-4a2e-8c08-5746bbe8d95e.jsonl +18 -0
  58. package/template/.sessions/3/2026-03-26T05-48-30-052Z_12de4774-9cb3-494c-9852-bd1e6b0003c3.jsonl +6 -0
  59. package/template/.vscode/extensions.json +8 -0
  60. package/template/.vscode/settings.json +4 -0
  61. package/template/.workspaces/3/hello.py +1 -0
  62. package/template/.wrangler/state/v3/d1/miniflare-D1DatabaseObject/803c2e37182b913f8857edf6d8776515cef4af6d48fcb25913e457f4b14ffa97.sqlite +0 -0
  63. package/template/.wrangler/state/v3/d1/miniflare-D1DatabaseObject/803c2e37182b913f8857edf6d8776515cef4af6d48fcb25913e457f4b14ffa97.sqlite-shm +0 -0
  64. package/template/.wrangler/state/v3/d1/miniflare-D1DatabaseObject/803c2e37182b913f8857edf6d8776515cef4af6d48fcb25913e457f4b14ffa97.sqlite-wal +0 -0
  65. package/template/CLAUDE.md +296 -0
  66. package/template/DESIGN.md +260 -0
  67. package/template/DEV_CONTEXT_GUIDE.md +366 -0
  68. package/template/DEV_TOOLS_README.md +396 -0
  69. package/template/FRAMEWORK_HISTORY.md +34 -0
  70. package/template/PROJECT_SUMMARY.md +325 -0
  71. package/template/QUICKSTART.md +305 -0
  72. package/template/README.md +154 -0
  73. package/template/STRUCTURE.txt +81 -0
  74. package/template/admin.html +13 -0
  75. package/template/auth-inject.html +33 -0
  76. package/template/commitlint.config.js +12 -0
  77. package/template/docs/PERMISSION_ARCHITECTURE.md +279 -0
  78. package/template/docs/PERMISSION_EXAMPLES.md +230 -0
  79. package/template/docs/PERMISSION_SYSTEM.md +301 -0
  80. package/template/docs/SMART_TEST.md +171 -0
  81. package/template/docs/runtime-abstract.md +253 -0
  82. package/template/drizzle/0000_rainy_boomer.sql +101 -0
  83. package/template/drizzle/0001_add_todo_attachments.sql +12 -0
  84. package/template/drizzle/0002_chilly_magneto.sql +89 -0
  85. package/template/drizzle/meta/0000_snapshot.json +652 -0
  86. package/template/drizzle/meta/0001_snapshot.json +735 -0
  87. package/template/drizzle/meta/0002_snapshot.json +1198 -0
  88. package/template/drizzle/meta/_journal.json +27 -0
  89. package/template/drizzle.config.ts +13 -0
  90. package/template/eslint-rules/README-no-middleware-in-routes.md +154 -0
  91. package/template/eslint-rules/__tests__/enforce-valid-method.test.ts +251 -0
  92. package/template/eslint-rules/__tests__/layer-boundary.test.ts +102 -0
  93. package/template/eslint-rules/__tests__/module-boundary.test.ts +77 -0
  94. package/template/eslint-rules/__tests__/no-direct-zod-import-in-file-routes.test.ts +45 -0
  95. package/template/eslint-rules/__tests__/no-new-old-service-naming.test.ts +76 -0
  96. package/template/eslint-rules/e2e-test-location.js +153 -0
  97. package/template/eslint-rules/enforce-valid-method.js +217 -0
  98. package/template/eslint-rules/flat-routes-services.js +69 -0
  99. package/template/eslint-rules/framework-protect.js +186 -0
  100. package/template/eslint-rules/layer-boundary.js +164 -0
  101. package/template/eslint-rules/limit-type-complexity.js +130 -0
  102. package/template/eslint-rules/middleware-location.js +162 -0
  103. package/template/eslint-rules/module-boundary.js +125 -0
  104. package/template/eslint-rules/no-ambiguous-file-paths.js +64 -0
  105. package/template/eslint-rules/no-any-on-apiclient.js +173 -0
  106. package/template/eslint-rules/no-boolean-success.js +43 -0
  107. package/template/eslint-rules/no-deep-relative-imports.js +69 -0
  108. package/template/eslint-rules/no-direct-fetch.js +122 -0
  109. package/template/eslint-rules/no-direct-ws-sse.js +57 -0
  110. package/template/eslint-rules/no-direct-zod-import-in-file-routes.js +54 -0
  111. package/template/eslint-rules/no-disable-direct-fetch.js +57 -0
  112. package/template/eslint-rules/no-disable-type-safe-client.js +58 -0
  113. package/template/eslint-rules/no-inline-schema.js +220 -0
  114. package/template/eslint-rules/no-middleware-in-routes.js +81 -0
  115. package/template/eslint-rules/no-new-old-service-naming.js +123 -0
  116. package/template/eslint-rules/no-type-assertion-in-rpc.js +99 -0
  117. package/template/eslint-rules/no-type-assertion-on-shared-types.js +109 -0
  118. package/template/eslint-rules/no-util-functions-in-service.js +128 -0
  119. package/template/eslint-rules/prefer-shared-types.js +352 -0
  120. package/template/eslint-rules/protect-ws-sse-interface.js +66 -0
  121. package/template/eslint-rules/require-antd-generic-types.js +73 -0
  122. package/template/eslint-rules/require-file-openapi-props.js +114 -0
  123. package/template/eslint-rules/require-hono-chain-syntax.js +129 -0
  124. package/template/eslint-rules/require-nullable-for-optional.js +99 -0
  125. package/template/eslint-rules/require-response-helpers.js +140 -0
  126. package/template/eslint-rules/require-type-safe-test-client.js +106 -0
  127. package/template/eslint-rules/route-location.js +72 -0
  128. package/template/eslint.config.js +231 -0
  129. package/template/index.html +17 -0
  130. package/template/lint-scripts/DIRECTORY_RULES.md +335 -0
  131. package/template/lint-scripts/README.md +299 -0
  132. package/template/lint-scripts/TESTING.md +273 -0
  133. package/template/lint-scripts/ai-context-generator.ts +159 -0
  134. package/template/lint-scripts/check-framework-modify.sh +8 -0
  135. package/template/lint-scripts/check-menu-permissions.js +242 -0
  136. package/template/lint-scripts/check-refs.ts +165 -0
  137. package/template/lint-scripts/check-route-auth-complete.js +260 -0
  138. package/template/lint-scripts/check-route-auth.js +212 -0
  139. package/template/lint-scripts/check-route-permissions.js +210 -0
  140. package/template/lint-scripts/config/project.config.ts +358 -0
  141. package/template/lint-scripts/dev-context-analyzer.ts +707 -0
  142. package/template/lint-scripts/dev-guide-generator.ts +830 -0
  143. package/template/lint-scripts/dev-server.ts +58 -0
  144. package/template/lint-scripts/eslint-route-auth.js +158 -0
  145. package/template/lint-scripts/eslint-routes-permission.js +147 -0
  146. package/template/lint-scripts/fix-route-auth.js +245 -0
  147. package/template/lint-scripts/framework/check-modify.ts +152 -0
  148. package/template/lint-scripts/framework/hash-utils.ts +180 -0
  149. package/template/lint-scripts/framework/init-baseline.ts +84 -0
  150. package/template/lint-scripts/framework/update-baseline.ts +148 -0
  151. package/template/lint-scripts/post-commit-track.ts +66 -0
  152. package/template/lint-scripts/quick-test.sh +27 -0
  153. package/template/lint-scripts/smart-test.ts +268 -0
  154. package/template/lint-scripts/test-history.ts +360 -0
  155. package/template/lint-scripts/test-tracker.ts +350 -0
  156. package/template/lint-scripts/validate-all.ts +250 -0
  157. package/template/lint-scripts/validators/api-coverage.validator.ts +355 -0
  158. package/template/lint-scripts/validators/client-rpc.validator.ts +190 -0
  159. package/template/lint-scripts/validators/client-tests.validator.ts +155 -0
  160. package/template/lint-scripts/validators/console-log.validator.ts +122 -0
  161. package/template/lint-scripts/validators/directory-structure.validator.ts +181 -0
  162. package/template/lint-scripts/validators/imports.validator.ts +180 -0
  163. package/template/lint-scripts/validators/index.ts +271 -0
  164. package/template/lint-scripts/validators/md-refs.validator.ts +165 -0
  165. package/template/lint-scripts/validators/module-tests.validator.ts +112 -0
  166. package/template/lint-scripts/validators/sensitive.validator.ts +185 -0
  167. package/template/lint-scripts/validators/server-rpc.validator.ts +141 -0
  168. package/template/lint-scripts/validators/test-quality.validator.ts +257 -0
  169. package/template/lint-scripts/validators/todos.validator.ts +126 -0
  170. package/template/lint-scripts/watch-validator.ts +131 -0
  171. package/template/modules.config.ts +71 -0
  172. package/template/package-lock.json +14554 -0
  173. package/template/package.json +158 -0
  174. package/template/patches/@hono+zod-openapi+1.2.2.patch +67 -0
  175. package/template/patches/@hono+zod-validator+0.7.6.patch +13 -0
  176. package/template/patches/hono+4.12.16.patch +246 -0
  177. package/template/patches/typescript+5.8.3.patch +26 -0
  178. package/template/playwright.config.ts +60 -0
  179. package/template/pnpm-lock.yaml +7137 -0
  180. package/template/postcss.config.js +6 -0
  181. package/template/scripts/create-template.ts +1724 -0
  182. package/template/src/admin/App.tsx +59 -0
  183. package/template/src/admin/components/AccountSwitcher.tsx +104 -0
  184. package/template/src/admin/components/CaptchaModal.tsx +150 -0
  185. package/template/src/admin/components/NotificationDrawer.tsx +213 -0
  186. package/template/src/admin/components/PageHeader.tsx +45 -0
  187. package/template/src/admin/components/PermissionConfigEditor.tsx +237 -0
  188. package/template/src/admin/components/PermissionGuard.tsx +108 -0
  189. package/template/src/admin/components/PermissionTree.tsx +193 -0
  190. package/template/src/admin/components/ProtectedRoute.tsx +33 -0
  191. package/template/src/admin/components/StatsCard.tsx +44 -0
  192. package/template/src/admin/components/UserFormModal.tsx +67 -0
  193. package/template/src/admin/components/UserTable.tsx +72 -0
  194. package/template/src/admin/components/__tests__/PageHeader.test.tsx +48 -0
  195. package/template/src/admin/components/__tests__/PermissionConfigEditor.test.tsx +147 -0
  196. package/template/src/admin/components/__tests__/PermissionGuard.test.tsx +221 -0
  197. package/template/src/admin/components/__tests__/PermissionTree.test.tsx +187 -0
  198. package/template/src/admin/components/__tests__/ProtectedRoute.test.tsx +129 -0
  199. package/template/src/admin/components/__tests__/StatsCard.test.tsx +44 -0
  200. package/template/src/admin/components/__tests__/UserFormModal.test.tsx +125 -0
  201. package/template/src/admin/components/__tests__/UserTable.test.tsx +89 -0
  202. package/template/src/admin/components/index.ts +7 -0
  203. package/template/src/admin/hooks/__tests__/useAuditLogs.test.ts +109 -0
  204. package/template/src/admin/hooks/__tests__/usePermissions.test.tsx +327 -0
  205. package/template/src/admin/hooks/__tests__/usePermissionsBranches.test.ts +198 -0
  206. package/template/src/admin/hooks/__tests__/useRoles.test.ts +261 -0
  207. package/template/src/admin/hooks/useAdminNotifications.ts +156 -0
  208. package/template/src/admin/hooks/useAuditLogs.ts +44 -0
  209. package/template/src/admin/hooks/useConfig.ts +168 -0
  210. package/template/src/admin/hooks/usePermissions.ts +156 -0
  211. package/template/src/admin/hooks/useRoles.ts +120 -0
  212. package/template/src/admin/layouts/Header.tsx +93 -0
  213. package/template/src/admin/layouts/Layout.tsx +23 -0
  214. package/template/src/admin/layouts/Sidebar.tsx +120 -0
  215. package/template/src/admin/main.tsx +18 -0
  216. package/template/src/admin/pages/ContentPage.tsx +252 -0
  217. package/template/src/admin/pages/DashboardPage.tsx +141 -0
  218. package/template/src/admin/pages/DisputesPage.tsx +261 -0
  219. package/template/src/admin/pages/LoginPage.tsx +121 -0
  220. package/template/src/admin/pages/MediaTestPage.tsx +524 -0
  221. package/template/src/admin/pages/OrdersPage.tsx +302 -0
  222. package/template/src/admin/pages/PermissionsPage.tsx +95 -0
  223. package/template/src/admin/pages/RegisterPage.tsx +103 -0
  224. package/template/src/admin/pages/RolesPage.tsx +330 -0
  225. package/template/src/admin/pages/SettingsPage.tsx +73 -0
  226. package/template/src/admin/pages/SystemLogsPage.tsx +218 -0
  227. package/template/src/admin/pages/TestCaptchaPage.tsx +120 -0
  228. package/template/src/admin/pages/TicketsPage.tsx +292 -0
  229. package/template/src/admin/pages/UsersPage.tsx +282 -0
  230. package/template/src/admin/pages/__tests__/ContentPage.test.tsx +213 -0
  231. package/template/src/admin/pages/__tests__/DashboardPage.test.tsx +153 -0
  232. package/template/src/admin/pages/__tests__/DisputesPage.test.tsx +196 -0
  233. package/template/src/admin/pages/__tests__/LoginPage.test.tsx +112 -0
  234. package/template/src/admin/pages/__tests__/OrdersPage.test.tsx +217 -0
  235. package/template/src/admin/pages/__tests__/PermissionsPage.test.tsx +119 -0
  236. package/template/src/admin/pages/__tests__/RegisterPage.test.tsx +179 -0
  237. package/template/src/admin/pages/__tests__/RolesPage.test.tsx +256 -0
  238. package/template/src/admin/pages/__tests__/SettingsPage.test.tsx +66 -0
  239. package/template/src/admin/pages/__tests__/SystemLogsPage.test.tsx +125 -0
  240. package/template/src/admin/pages/__tests__/TicketsPage.test.tsx +202 -0
  241. package/template/src/admin/pages/__tests__/UsersPage.test.tsx +229 -0
  242. package/template/src/admin/services/README.md +263 -0
  243. package/template/src/admin/services/TESTING.md +323 -0
  244. package/template/src/admin/services/__tests__/skipLoading.test.ts +146 -0
  245. package/template/src/admin/services/apiClient.ts +66 -0
  246. package/template/src/admin/services/requestInterceptor.ts +127 -0
  247. package/template/src/admin/services/types.ts +5 -0
  248. package/template/src/admin/stores/__tests__/adminStore.test.ts +184 -0
  249. package/template/src/admin/stores/__tests__/adminStoreBranches.test.ts +148 -0
  250. package/template/src/admin/stores/__tests__/captchaStore.test.ts +75 -0
  251. package/template/src/admin/stores/__tests__/captchaStoreBranches.test.ts +37 -0
  252. package/template/src/admin/stores/__tests__/loadingStore.test.ts +68 -0
  253. package/template/src/admin/stores/adminStore.ts +88 -0
  254. package/template/src/admin/stores/captchaStore.ts +47 -0
  255. package/template/src/admin/stores/loadingStore.ts +27 -0
  256. package/template/src/cli/index.ts +22 -0
  257. package/template/src/cli/modules/config/index.ts +132 -0
  258. package/template/src/cli/modules/index.ts +12 -0
  259. package/template/src/cli/modules/notification/index.ts +86 -0
  260. package/template/src/cli/modules/todo/index.ts +60 -0
  261. package/template/src/cli/rpc/client.ts +23 -0
  262. package/template/src/cli/rpc/index.ts +1 -0
  263. package/template/src/cli/utils/api.ts +17 -0
  264. package/template/src/cli/utils/auto-command.ts +229 -0
  265. package/template/src/cli/utils/index.ts +8 -0
  266. package/template/src/cli/utils/logger.ts +79 -0
  267. package/template/src/client/App.tsx +24 -0
  268. package/template/src/client/Layout.tsx +27 -0
  269. package/template/src/client/components/AuthButton.tsx +41 -0
  270. package/template/src/client/components/ConnectionStatus.tsx +75 -0
  271. package/template/src/client/components/EmptyState.tsx +26 -0
  272. package/template/src/client/components/Footer.tsx +17 -0
  273. package/template/src/client/components/LoadingSpinner.tsx +26 -0
  274. package/template/src/client/components/MessageCard.tsx +61 -0
  275. package/template/src/client/components/Navigation.tsx +65 -0
  276. package/template/src/client/components/StatusBadge.tsx +50 -0
  277. package/template/src/client/components/__tests__/App.test.tsx +79 -0
  278. package/template/src/client/components/__tests__/AuthButton.test.tsx +119 -0
  279. package/template/src/client/components/__tests__/ConnectionStatus.test.tsx +188 -0
  280. package/template/src/client/components/__tests__/EmptyState.test.tsx +70 -0
  281. package/template/src/client/components/__tests__/Footer.test.tsx +22 -0
  282. package/template/src/client/components/__tests__/LoadingSpinner.test.tsx +75 -0
  283. package/template/src/client/components/__tests__/MessageCard.test.tsx +142 -0
  284. package/template/src/client/components/__tests__/Navigation.test.tsx +40 -0
  285. package/template/src/client/components/__tests__/StatusBadge.test.tsx +107 -0
  286. package/template/src/client/components/index.ts +6 -0
  287. package/template/src/client/index.css +27 -0
  288. package/template/src/client/main.tsx +25 -0
  289. package/template/src/client/pages/ContentDetailPage.tsx +142 -0
  290. package/template/src/client/pages/ContentListPage.tsx +169 -0
  291. package/template/src/client/pages/NotificationPage.tsx +288 -0
  292. package/template/src/client/pages/TodoPage.tsx +389 -0
  293. package/template/src/client/pages/WebSocketPage.tsx +239 -0
  294. package/template/src/client/pages/__tests__/ContentDetailPage.test.tsx +176 -0
  295. package/template/src/client/pages/__tests__/ContentListPage.test.tsx +202 -0
  296. package/template/src/client/pages/__tests__/NotificationPage.test.tsx +246 -0
  297. package/template/src/client/pages/__tests__/TodoPage.test.tsx +433 -0
  298. package/template/src/client/pages/__tests__/WebSocketPage.test.tsx +378 -0
  299. package/template/src/client/services/apiClient.ts +66 -0
  300. package/template/src/client/stores/__tests__/authStore.test.ts +139 -0
  301. package/template/src/client/stores/__tests__/chatWSStore.test.ts +416 -0
  302. package/template/src/client/stores/__tests__/notificationStore.test.ts +453 -0
  303. package/template/src/client/stores/__tests__/todoStore.test.ts +509 -0
  304. package/template/src/client/stores/authStore.ts +51 -0
  305. package/template/src/client/stores/chatWSStore.ts +122 -0
  306. package/template/src/client/stores/notificationStore.ts +199 -0
  307. package/template/src/client/stores/todoStore.ts +207 -0
  308. package/template/src/server/__tests__/integration/todos-api.test.ts +138 -0
  309. package/template/src/server/app.ts +105 -0
  310. package/template/src/server/config.ts +86 -0
  311. package/template/src/server/core/__tests__/realtime-core.test.ts +329 -0
  312. package/template/src/server/core/__tests__/realtime-scanner.test.ts +210 -0
  313. package/template/src/server/core/__tests__/runtime-node.test.ts +330 -0
  314. package/template/src/server/core/__tests__/runtime.test.ts +219 -0
  315. package/template/src/server/core/__tests__/typed-runtime.test.ts +178 -0
  316. package/template/src/server/core/durable-objects/RealtimeDO.ts +206 -0
  317. package/template/src/server/core/index.ts +83 -0
  318. package/template/src/server/core/module-loader.ts +281 -0
  319. package/template/src/server/core/realtime-core.ts +152 -0
  320. package/template/src/server/core/realtime-scanner.ts +99 -0
  321. package/template/src/server/core/runtime-cloudflare.ts +207 -0
  322. package/template/src/server/core/runtime-node.ts +170 -0
  323. package/template/src/server/core/runtime.ts +129 -0
  324. package/template/src/server/core/typed-runtime.ts +80 -0
  325. package/template/src/server/db/__tests__/driver.test.ts +203 -0
  326. package/template/src/server/db/config.ts +1 -0
  327. package/template/src/server/db/driver-cloudflare.ts +50 -0
  328. package/template/src/server/db/driver.ts +116 -0
  329. package/template/src/server/db/index.ts +3 -0
  330. package/template/src/server/db/init.ts +412 -0
  331. package/template/src/server/db/schema/api-endpoints.ts +23 -0
  332. package/template/src/server/db/schema/contents.ts +31 -0
  333. package/template/src/server/db/schema/disputes.ts +39 -0
  334. package/template/src/server/db/schema/index.ts +14 -0
  335. package/template/src/server/db/schema/notifications.ts +16 -0
  336. package/template/src/server/db/schema/orders.ts +30 -0
  337. package/template/src/server/db/schema/permission-audit-logs.ts +17 -0
  338. package/template/src/server/db/schema/permission-route-mappings.ts +22 -0
  339. package/template/src/server/db/schema/permissions.ts +17 -0
  340. package/template/src/server/db/schema/role-permissions.ts +22 -0
  341. package/template/src/server/db/schema/roles.ts +17 -0
  342. package/template/src/server/db/schema/tickets.ts +62 -0
  343. package/template/src/server/db/schema/todo-attachments.ts +22 -0
  344. package/template/src/server/db/schema/todos.ts +21 -0
  345. package/template/src/server/db/schema/user-roles.ts +17 -0
  346. package/template/src/server/db/seeds/index.ts +1 -0
  347. package/template/src/server/db/seeds/permission-data.ts +354 -0
  348. package/template/src/server/db/test-setup.ts +647 -0
  349. package/template/src/server/entries/cloudflare.ts +71 -0
  350. package/template/src/server/entries/node.ts +190 -0
  351. package/template/src/server/index.ts +62 -0
  352. package/template/src/server/middleware/__tests__/auth-simple.test.ts +147 -0
  353. package/template/src/server/middleware/__tests__/auth.test.ts +276 -0
  354. package/template/src/server/middleware/__tests__/captcha.test.ts +258 -0
  355. package/template/src/server/middleware/__tests__/error-handler.test.ts +364 -0
  356. package/template/src/server/middleware/__tests__/error-response-format.test.ts +80 -0
  357. package/template/src/server/middleware/__tests__/permission.test.ts +312 -0
  358. package/template/src/server/middleware/audit-log.ts +101 -0
  359. package/template/src/server/middleware/auth.ts +235 -0
  360. package/template/src/server/middleware/captcha.ts +166 -0
  361. package/template/src/server/middleware/cors.ts +30 -0
  362. package/template/src/server/middleware/error-handler.ts +135 -0
  363. package/template/src/server/middleware/index.ts +24 -0
  364. package/template/src/server/middleware/logger.ts +73 -0
  365. package/template/src/server/middleware/permission.ts +127 -0
  366. package/template/src/server/middleware/rate-limit.ts +69 -0
  367. package/template/src/server/middleware/realtime-env.ts +12 -0
  368. package/template/src/server/module-admin/__tests__/admin-routes.test.ts +360 -0
  369. package/template/src/server/module-admin/__tests__/admin-service.test.ts +222 -0
  370. package/template/src/server/module-admin/__tests__/audit-log-routes.test.ts +261 -0
  371. package/template/src/server/module-admin/__tests__/export-routes.test.ts +160 -0
  372. package/template/src/server/module-admin/__tests__/media-routes.test.ts +122 -0
  373. package/template/src/server/module-admin/module.ts +40 -0
  374. package/template/src/server/module-admin/routes/admin-notification-routes.ts +197 -0
  375. package/template/src/server/module-admin/routes/admin-routes.ts +20 -0
  376. package/template/src/server/module-admin/routes/auth-routes.ts +86 -0
  377. package/template/src/server/module-admin/routes/export-routes.ts +207 -0
  378. package/template/src/server/module-admin/routes/media-routes.ts +78 -0
  379. package/template/src/server/module-admin/routes/system-routes.ts +89 -0
  380. package/template/src/server/module-admin/routes/user-management-routes.ts +143 -0
  381. package/template/src/server/module-admin/services/admin-service.ts +268 -0
  382. package/template/src/server/module-captcha/__tests__/captcha-route.test.ts +35 -0
  383. package/template/src/server/module-captcha/__tests__/captcha-service.test.ts +53 -0
  384. package/template/src/server/module-captcha/module.ts +35 -0
  385. package/template/src/server/module-captcha/routes/captcha-routes.ts +68 -0
  386. package/template/src/server/module-captcha/services/captcha-service.ts +3 -0
  387. package/template/src/server/module-chat/__tests__/chat-routes.test.ts +39 -0
  388. package/template/src/server/module-chat/__tests__/chat-rpc.test.ts +185 -0
  389. package/template/src/server/module-chat/__tests__/chat-service.test.ts +64 -0
  390. package/template/src/server/module-chat/module.ts +27 -0
  391. package/template/src/server/module-chat/routes/chat-routes.ts +46 -0
  392. package/template/src/server/module-chat/services/chat-service.ts +38 -0
  393. package/template/src/server/module-content/__tests__/content-route.test.ts +40 -0
  394. package/template/src/server/module-content/__tests__/content-service.test.ts +107 -0
  395. package/template/src/server/module-content/module.ts +39 -0
  396. package/template/src/server/module-content/routes/content-routes.ts +182 -0
  397. package/template/src/server/module-content/routes/public-content-routes.ts +58 -0
  398. package/template/src/server/module-content/services/content-service.ts +224 -0
  399. package/template/src/server/module-dispute/__tests__/dispute-route.test.ts +43 -0
  400. package/template/src/server/module-dispute/__tests__/dispute-service.test.ts +135 -0
  401. package/template/src/server/module-dispute/module.ts +30 -0
  402. package/template/src/server/module-dispute/routes/dispute-routes.ts +153 -0
  403. package/template/src/server/module-dispute/services/dispute-service.ts +255 -0
  404. package/template/src/server/module-file/__tests__/file-routes.test.ts +284 -0
  405. package/template/src/server/module-file/__tests__/file-storage-service.test.ts +323 -0
  406. package/template/src/server/module-file/module.ts +28 -0
  407. package/template/src/server/module-file/routes/file-routes.ts +288 -0
  408. package/template/src/server/module-notifications/__tests__/notification-route-rpc.test.ts +375 -0
  409. package/template/src/server/module-notifications/__tests__/notification-service.test.ts +241 -0
  410. package/template/src/server/module-notifications/__tests__/sse-rpc.test.ts +289 -0
  411. package/template/src/server/module-notifications/module.ts +32 -0
  412. package/template/src/server/module-notifications/routes/notification-routes.ts +190 -0
  413. package/template/src/server/module-notifications/services/notification-service.ts +104 -0
  414. package/template/src/server/module-order/__tests__/order-route.test.ts +258 -0
  415. package/template/src/server/module-order/__tests__/order-service.test.ts +222 -0
  416. package/template/src/server/module-order/module.ts +30 -0
  417. package/template/src/server/module-order/routes/order-routes.ts +202 -0
  418. package/template/src/server/module-order/services/order-service.ts +268 -0
  419. package/template/src/server/module-permission/__tests__/permission-middleware.test.ts +90 -0
  420. package/template/src/server/module-permission/__tests__/permission-routes.test.ts +330 -0
  421. package/template/src/server/module-permission/__tests__/permission-service-impl.test.ts +388 -0
  422. package/template/src/server/module-permission/__tests__/permission-service.test.ts +190 -0
  423. package/template/src/server/module-permission/__tests__/role-routes.test.ts +215 -0
  424. package/template/src/server/module-permission/module.ts +68 -0
  425. package/template/src/server/module-permission/routes/audit-log-routes.ts +76 -0
  426. package/template/src/server/module-permission/routes/permission-routes.ts +184 -0
  427. package/template/src/server/module-permission/routes/role-routes.ts +263 -0
  428. package/template/src/server/module-permission/services/audit-log-service.ts +108 -0
  429. package/template/src/server/module-permission/services/permission-service-impl.ts +233 -0
  430. package/template/src/server/module-permission/services/permission-service.ts +256 -0
  431. package/template/src/server/module-permission/services/role-service.ts +122 -0
  432. package/template/src/server/module-ticket/__tests__/ticket-route.test.ts +173 -0
  433. package/template/src/server/module-ticket/__tests__/ticket-service.test.ts +201 -0
  434. package/template/src/server/module-ticket/module.ts +30 -0
  435. package/template/src/server/module-ticket/routes/ticket-routes.ts +210 -0
  436. package/template/src/server/module-ticket/services/ticket-service.ts +297 -0
  437. package/template/src/server/module-todos/__tests__/todo-service.test.ts +196 -0
  438. package/template/src/server/module-todos/__tests__/todos-file-upload.test.ts +439 -0
  439. package/template/src/server/module-todos/__tests__/todos-route-rpc.test.ts +575 -0
  440. package/template/src/server/module-todos/module.ts +30 -0
  441. package/template/src/server/module-todos/routes/todos-routes.ts +260 -0
  442. package/template/src/server/module-todos/services/todo-service.ts +202 -0
  443. package/template/src/server/route-registry.ts +47 -0
  444. package/template/src/server/test-utils/test-client.ts +66 -0
  445. package/template/src/server/test-utils/test-server.ts +131 -0
  446. package/template/src/server/types/bindings.ts +10 -0
  447. package/template/src/server/utils/__tests__/app-error.test.ts +374 -0
  448. package/template/src/server/utils/__tests__/auth.test.ts +76 -0
  449. package/template/src/server/utils/__tests__/captcha.test.ts +80 -0
  450. package/template/src/server/utils/__tests__/file-storage.test.ts +472 -0
  451. package/template/src/server/utils/__tests__/logger.test.ts +221 -0
  452. package/template/src/server/utils/__tests__/route-helpers.test.ts +264 -0
  453. package/template/src/server/utils/app-error.ts +355 -0
  454. package/template/src/server/utils/auth.ts +65 -0
  455. package/template/src/server/utils/captcha.ts +119 -0
  456. package/template/src/server/utils/date.ts +50 -0
  457. package/template/src/server/utils/env.ts +4 -0
  458. package/template/src/server/utils/file-storage.ts +462 -0
  459. package/template/src/server/utils/generate.ts +26 -0
  460. package/template/src/server/utils/id-helpers.ts +5 -0
  461. package/template/src/server/utils/logger.ts +139 -0
  462. package/template/src/server/utils/permission-utils.ts +6 -0
  463. package/template/src/server/utils/response.ts +40 -0
  464. package/template/src/server/utils/route-helpers.ts +200 -0
  465. package/template/src/server/utils/uuid.ts +8 -0
  466. package/template/src/server/utils/ws-helper.ts +30 -0
  467. package/template/src/shared/constants/index.ts +1 -0
  468. package/template/src/shared/constants/resource-types.ts +72 -0
  469. package/template/src/shared/core/__tests__/sse-client.test.ts +376 -0
  470. package/template/src/shared/core/__tests__/ws-client.test.ts +468 -0
  471. package/template/src/shared/core/api-request.ts +192 -0
  472. package/template/src/shared/core/api-schemas.ts +41 -0
  473. package/template/src/shared/core/index.ts +37 -0
  474. package/template/src/shared/core/module-manifest.ts +120 -0
  475. package/template/src/shared/core/protocol-types.ts +26 -0
  476. package/template/src/shared/core/sse-client.ts +185 -0
  477. package/template/src/shared/core/ws-client.ts +236 -0
  478. package/template/src/shared/hooks/index.ts +2 -0
  479. package/template/src/shared/hooks/useSSE.ts +57 -0
  480. package/template/src/shared/hooks/useWebSocket.ts +66 -0
  481. package/template/src/shared/index.ts +5 -0
  482. package/template/src/shared/modules/admin/index.ts +1 -0
  483. package/template/src/shared/modules/admin/schemas.ts +100 -0
  484. package/template/src/shared/modules/audit/index.ts +1 -0
  485. package/template/src/shared/modules/audit/schemas.ts +24 -0
  486. package/template/src/shared/modules/captcha/index.ts +1 -0
  487. package/template/src/shared/modules/captcha/schemas.ts +19 -0
  488. package/template/src/shared/modules/chat/index.ts +38 -0
  489. package/template/src/shared/modules/content/index.ts +1 -0
  490. package/template/src/shared/modules/content/schemas.ts +53 -0
  491. package/template/src/shared/modules/dispute/index.ts +1 -0
  492. package/template/src/shared/modules/dispute/schemas.ts +62 -0
  493. package/template/src/shared/modules/files/index.ts +11 -0
  494. package/template/src/shared/modules/files/schemas.ts +44 -0
  495. package/template/src/shared/modules/index.ts +70 -0
  496. package/template/src/shared/modules/notifications/index.ts +26 -0
  497. package/template/src/shared/modules/notifications/schemas.ts +73 -0
  498. package/template/src/shared/modules/order/index.ts +1 -0
  499. package/template/src/shared/modules/order/schemas.ts +63 -0
  500. package/template/src/shared/modules/permission/index.ts +42 -0
  501. package/template/src/shared/modules/permission/permission-dependencies.ts +50 -0
  502. package/template/src/shared/modules/permission/permissions.ts +275 -0
  503. package/template/src/shared/modules/permission/schemas.ts +92 -0
  504. package/template/src/shared/modules/permission/types.ts +23 -0
  505. package/template/src/shared/modules/role/index.ts +1 -0
  506. package/template/src/shared/modules/role/schemas.ts +46 -0
  507. package/template/src/shared/modules/ticket/index.ts +1 -0
  508. package/template/src/shared/modules/ticket/schemas.ts +77 -0
  509. package/template/src/shared/modules/todos/index.ts +20 -0
  510. package/template/src/shared/modules/todos/schemas.ts +65 -0
  511. package/template/src/shared/schemas/index.ts +79 -0
  512. package/template/src/types/global.d.ts +14 -0
  513. package/template/src/vite-env.d.ts +21 -0
  514. package/template/tailwind.config.js +11 -0
  515. package/template/tests/e2e/admin-crud.spec.ts +81 -0
  516. package/template/tests/e2e/case-o1.spec.ts +108 -0
  517. package/template/tests/e2e/global-setup.ts +73 -0
  518. package/template/tests/e2e/global-teardown.ts +28 -0
  519. package/template/tests/e2e/notification.spec.ts +458 -0
  520. package/template/tests/e2e/todo.spec.ts +623 -0
  521. package/template/tests/e2e/websocket.spec.ts +254 -0
  522. package/template/tsconfig.json +35 -0
  523. package/template/tsup.config.ts +95 -0
  524. package/template/vite-plugins.ts +113 -0
  525. package/template/vite.config.ts +96 -0
  526. package/template/vitest.config.ts +53 -0
  527. package/template/vitest.integration.config.ts +24 -0
  528. package/template/vitest.integration.setup.ts +22 -0
  529. package/template/vitest.setup.ts +74 -0
  530. package/template/wrangler.toml +33 -0
@@ -0,0 +1,445 @@
1
+ ---
2
+ paths: src/admin/**/*.tsx, src/admin/**/*.ts
3
+ ---
4
+
5
+ # Admin 模块开发规范
6
+
7
+ ## 🎯 核心原则
8
+
9
+ Admin 模块是一个**独立的管理后台**,与主应用完全分离,有自己的入口、布局和路由。
10
+
11
+ **重要**: Admin 模块位于 `src/admin/`,与 `src/client/`(用户前台)平级,实现用户端与管理端的完全隔离。
12
+
13
+ **技术栈**: Admin 模块使用 **Ant Design** 作为 UI 组件库。
14
+
15
+ ## 📁 目录结构
16
+
17
+ ```
18
+ src/admin/
19
+ ├── components/ # Admin 专用组件
20
+ │ └── ... # 业务组件
21
+
22
+ ├── layouts/ # 布局组件
23
+ │ ├── AdminLayout.tsx # 主布局
24
+ │ ├── AdminSidebar.tsx # 侧边栏
25
+ │ └── AdminHeader.tsx # 顶部导航
26
+
27
+ ├── pages/ # Admin 页面
28
+ │ ├── DashboardPage.tsx # 仪表盘(首页)
29
+ │ ├── LoginPage.tsx # 登录页
30
+ │ ├── RegisterPage.tsx # 注册页
31
+ │ ├── SettingsPage.tsx # 系统设置
32
+ │ └── ... # 其他页面
33
+
34
+ ├── stores/ # Admin 状态管理
35
+ │ └── adminStore.ts # Admin 状态
36
+
37
+ ├── AdminApp.tsx # Admin 入口(路由配置)
38
+ └── main.tsx # Admin 启动文件
39
+ ```
40
+
41
+ ## 🏗️ 多入口架构
42
+
43
+ ### 入口文件
44
+
45
+ 项目支持**两个独立入口**:
46
+
47
+ | 入口 | 文件 | HTML | 访问路径 | 用途 |
48
+ | -------- | --------------------- | ------------ | ---------- | -------- |
49
+ | 用户前台 | `src/client/main.tsx` | `index.html` | `/` | 用户前台 |
50
+ | 管理后台 | `src/admin/main.tsx` | `admin.html` | `/admin/*` | 管理后台 |
51
+
52
+ ### Vite 配置
53
+
54
+ ```typescript
55
+ // vite.config.ts
56
+ export default defineConfig({
57
+ build: {
58
+ rollupOptions: {
59
+ input: {
60
+ main: path.resolve(__dirname, 'index.html'),
61
+ admin: path.resolve(__dirname, 'admin.html'),
62
+ },
63
+ },
64
+ },
65
+ resolve: {
66
+ alias: {
67
+ '@shared': path.resolve(__dirname, 'src/shared'),
68
+ '@client': path.resolve(__dirname, 'src/client'),
69
+ '@server': path.resolve(__dirname, 'src/server'),
70
+ '@admin': path.resolve(__dirname, 'src/admin'),
71
+ },
72
+ },
73
+ })
74
+ ```
75
+
76
+ ## 🎨 UI 组件库
77
+
78
+ ### Ant Design
79
+
80
+ Admin 模块使用 **Ant Design** 作为 UI 组件库。
81
+
82
+ **依赖**: `"antd": "^5.24.0"`
83
+
84
+ ### 全局配置
85
+
86
+ ```typescript
87
+ // src/admin/AdminApp.tsx
88
+ import { ConfigProvider } from 'antd'
89
+
90
+ export const AdminApp: React.FC = () => {
91
+ return (
92
+ <ConfigProvider
93
+ theme={{
94
+ token: {
95
+ colorPrimary: '#1890ff',
96
+ },
97
+ }}
98
+ >
99
+ {/* ... */}
100
+ </ConfigProvider>
101
+ )
102
+ }
103
+ ```
104
+
105
+ ### 常用组件
106
+
107
+ | 组件 | 用途 |
108
+ | --------- | -------- |
109
+ | `Layout` | 页面布局 |
110
+ | `Menu` | 导航菜单 |
111
+ | `Form` | 表单 |
112
+ | `Table` | 数据表格 |
113
+ | `Card` | 卡片容器 |
114
+ | `Button` | 按钮 |
115
+ | `Input` | 输入框 |
116
+ | `Modal` | 弹窗 |
117
+ | `message` | 全局提示 |
118
+
119
+ ## 🔧 Admin 入口配置
120
+
121
+ ### AdminApp.tsx
122
+
123
+ ```typescript
124
+ // src/admin/AdminApp.tsx
125
+ import { BrowserRouter, Routes, Route, Navigate } from 'react-router-dom'
126
+ import { ConfigProvider } from 'antd'
127
+ import { AdminLayout } from './layouts/AdminLayout'
128
+ import { DashboardPage } from './pages/DashboardPage'
129
+ import { LoginPage } from './pages/LoginPage'
130
+ import { RegisterPage } from './pages/RegisterPage'
131
+ import { SettingsPage } from './pages/SettingsPage'
132
+
133
+ export const AdminApp: React.FC = () => {
134
+ return (
135
+ <ConfigProvider theme={{ token: { colorPrimary: '#1890ff' } }}>
136
+ <BrowserRouter basename="/admin">
137
+ <Routes>
138
+ <Route path="/login" element={<LoginPage />} />
139
+ <Route path="/register" element={<RegisterPage />} />
140
+ <Route
141
+ path="/*"
142
+ element={
143
+ <AdminLayout>
144
+ <Routes>
145
+ <Route path="/" element={<Navigate to="/dashboard" replace />} />
146
+ <Route path="/dashboard" element={<DashboardPage />} />
147
+ <Route path="/settings" element={<SettingsPage />} />
148
+ </Routes>
149
+ </AdminLayout>
150
+ }
151
+ />
152
+ </Routes>
153
+ </BrowserRouter>
154
+ </ConfigProvider>
155
+ )
156
+ }
157
+ ```
158
+
159
+ ### main.tsx
160
+
161
+ ```typescript
162
+ // src/admin/main.tsx
163
+ import React from 'react'
164
+ import ReactDOM from 'react-dom/client'
165
+ import { AdminApp } from './AdminApp'
166
+ import '../client/index.css'
167
+
168
+ ReactDOM.createRoot(document.getElementById('root')!).render(
169
+ <React.StrictMode>
170
+ <AdminApp />
171
+ </React.StrictMode>
172
+ )
173
+ ```
174
+
175
+ ## 📦 布局组件规范
176
+
177
+ ### 目录结构
178
+
179
+ ```
180
+ layouts/
181
+ ├── AdminLayout.tsx # 主布局(包含侧边栏和顶部导航)
182
+ ├── AdminSidebar.tsx # 侧边栏组件
183
+ └── AdminHeader.tsx # 顶部导航组件
184
+ ```
185
+
186
+ ### AdminLayout.tsx
187
+
188
+ ```typescript
189
+ // src/admin/layouts/AdminLayout.tsx
190
+ import { ReactNode, useState } from 'react'
191
+ import { AdminSidebar } from './AdminSidebar'
192
+ import { AdminHeader } from './AdminHeader'
193
+
194
+ interface AdminLayoutProps {
195
+ children: ReactNode
196
+ }
197
+
198
+ export const AdminLayout: React.FC<AdminLayoutProps> = ({ children }) => {
199
+ const [sidebarOpen, setSidebarOpen] = useState(true)
200
+
201
+ return (
202
+ <div className="flex h-screen bg-gray-100">
203
+ <AdminSidebar isOpen={sidebarOpen} />
204
+ <div className="flex-1 flex flex-col overflow-hidden">
205
+ <AdminHeader onToggleSidebar={() => setSidebarOpen(!sidebarOpen)} />
206
+ <main className="flex-1 overflow-y-auto p-6">
207
+ {children}
208
+ </main>
209
+ </div>
210
+ </div>
211
+ )
212
+ }
213
+ ```
214
+
215
+ ## 📄 页面规范
216
+
217
+ ### 页面类型
218
+
219
+ | 页面 | 路径 | 文件 | 说明 |
220
+ | ---- | ------------ | ------------------- | ---------- |
221
+ | 登录 | `/login` | `LoginPage.tsx` | 管理员登录 |
222
+ | 注册 | `/register` | `RegisterPage.tsx` | 管理员注册 |
223
+ | 首页 | `/dashboard` | `DashboardPage.tsx` | 仪表盘 |
224
+ | 设置 | `/settings` | `SettingsPage.tsx` | 系统设置 |
225
+
226
+ ### 登录页面示例
227
+
228
+ ```typescript
229
+ // src/admin/pages/LoginPage.tsx
230
+ import { Form, Input, Button, Card, message } from 'antd'
231
+ import { UserOutlined, LockOutlined } from '@ant-design/icons'
232
+ import { useNavigate } from 'react-router-dom'
233
+
234
+ export const LoginPage: React.FC = () => {
235
+ const navigate = useNavigate()
236
+ const [form] = Form.useForm()
237
+
238
+ const handleSubmit = async (values: any) => {
239
+ try {
240
+ console.log('Login:', values)
241
+ message.success('Login successful!')
242
+ navigate('/dashboard')
243
+ } catch (error) {
244
+ message.error('Login failed!')
245
+ }
246
+ }
247
+
248
+ return (
249
+ <div className="min-h-screen flex items-center justify-center bg-gray-100">
250
+ <Card className="w-full max-w-md" title="Admin Login">
251
+ <Form form={form} onFinish={handleSubmit} layout="vertical">
252
+ <Form.Item name="username" rules={[{ required: true }]}>
253
+ <Input prefix={<UserOutlined />} placeholder="Username" size="large" />
254
+ </Form.Item>
255
+ <Form.Item name="password" rules={[{ required: true }]}>
256
+ <Input.Password prefix={<LockOutlined />} placeholder="Password" size="large" />
257
+ </Form.Item>
258
+ <Form.Item>
259
+ <Button type="primary" htmlType="submit" size="large" block>
260
+ Login
261
+ </Button>
262
+ </Form.Item>
263
+ </Form>
264
+ </Card>
265
+ </div>
266
+ )
267
+ }
268
+ ```
269
+
270
+ ## 🔐 权限控制
271
+
272
+ ### 路由守卫
273
+
274
+ ```typescript
275
+ // src/admin/components/AuthGuard.tsx
276
+ import { Navigate } from 'react-router-dom'
277
+ import { useAdminStore } from '../stores/adminStore'
278
+
279
+ interface AuthGuardProps {
280
+ children: React.ReactNode
281
+ }
282
+
283
+ export const AuthGuard: React.FC<AuthGuardProps> = ({ children }) => {
284
+ const { isAuthenticated, user } = useAdminStore()
285
+
286
+ if (!isAuthenticated) {
287
+ return <Navigate to="/admin/login" replace />
288
+ }
289
+
290
+ if (user?.role !== 'admin') {
291
+ return <Navigate to="/admin/unauthorized" replace />
292
+ }
293
+
294
+ return <>{children}</>
295
+ }
296
+ ```
297
+
298
+ ### 使用守卫
299
+
300
+ ```typescript
301
+ // src/admin/AdminApp.tsx
302
+ export const AdminApp: React.FC = () => {
303
+ return (
304
+ <BrowserRouter basename="/admin">
305
+ <Routes>
306
+ <Route path="/login" element={<LoginPage />} />
307
+ <Route
308
+ path="/*"
309
+ element={
310
+ <AuthGuard>
311
+ <AdminLayout>
312
+ <Routes>...</Routes>
313
+ </AdminLayout>
314
+ </AuthGuard>
315
+ }
316
+ />
317
+ </Routes>
318
+ </BrowserRouter>
319
+ )
320
+ }
321
+ ```
322
+
323
+ ## 📊 API 调用
324
+
325
+ ### 使用 admin API
326
+
327
+ ```typescript
328
+ // src/admin/stores/adminStore.ts
329
+ import { create } from 'zustand'
330
+ import { apiClient } from '@client/services/apiClient'
331
+ import type { SystemStats } from '@shared/schemas'
332
+
333
+ interface AdminState {
334
+ stats: SystemStats | null
335
+ fetchStats: () => Promise<void>
336
+ }
337
+
338
+ export const useAdminStore = create<AdminState>(set => ({
339
+ stats: null,
340
+
341
+ fetchStats: async () => {
342
+ const response = await apiClient.api.admin.stats.$get()
343
+ const result = await response.json()
344
+ if (result.success) {
345
+ set({ stats: result.data })
346
+ }
347
+ },
348
+ }))
349
+ ```
350
+
351
+ ## 🚫 禁止事项
352
+
353
+ ### 1. 禁止混用用户前台组件
354
+
355
+ ```typescript
356
+ // ❌ 错误 - Admin 使用用户前台组件
357
+ import { Navigation } from '@client/components/Navigation'
358
+
359
+ // ✅ 正确 - Admin 使用自己的组件
360
+ import { AdminSidebar } from './layouts/AdminSidebar'
361
+ ```
362
+
363
+ ### 2. 禁止共享状态
364
+
365
+ ```typescript
366
+ // ❌ 错误 - Admin 使用用户前台 Store
367
+ import { useTodoStore } from '@client/stores/todoStore'
368
+
369
+ // ✅ 正确 - Admin 使用自己的 Store
370
+ import { useAdminStore } from './stores/adminStore'
371
+ ```
372
+
373
+ ### 3. 禁止在 AdminApp 中定义布局
374
+
375
+ ```typescript
376
+ // ❌ 错误 - AdminApp 包含布局逻辑
377
+ export const AdminApp: React.FC = () => {
378
+ return (
379
+ <BrowserRouter>
380
+ <div className="flex h-screen">
381
+ <AdminSidebar />
382
+ <main>
383
+ <Routes>...</Routes>
384
+ </main>
385
+ </div>
386
+ </BrowserRouter>
387
+ )
388
+ }
389
+
390
+ // ✅ 正确 - AdminApp 只负责路由
391
+ export const AdminApp: React.FC = () => {
392
+ return (
393
+ <BrowserRouter basename="/admin">
394
+ <AdminLayout>
395
+ <Routes>...</Routes>
396
+ </AdminLayout>
397
+ </BrowserRouter>
398
+ )
399
+ }
400
+ ```
401
+
402
+ ## 📝 HTML 入口文件
403
+
404
+ ### admin.html
405
+
406
+ ```html
407
+ <!DOCTYPE html>
408
+ <html lang="en">
409
+ <head>
410
+ <meta charset="UTF-8" />
411
+ <link rel="icon" type="image/svg+xml" href="/vite.svg" />
412
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
413
+ <title>Admin Dashboard</title>
414
+ </head>
415
+ <body>
416
+ <div id="root"></div>
417
+ <script type="module" src="/src/admin/main.tsx"></script>
418
+ </body>
419
+ </html>
420
+ ```
421
+
422
+ ## 🎨 样式规范
423
+
424
+ Admin 模块可以共享用户前台的样式:
425
+
426
+ ```typescript
427
+ // src/admin/main.tsx
428
+ import '../client/index.css' // 共享样式
429
+ ```
430
+
431
+ 也可以使用独立的样式:
432
+
433
+ ```typescript
434
+ // src/admin/styles/admin.css
435
+ .admin-sidebar {
436
+ width: 250px;
437
+ background: #1f2937;
438
+ }
439
+ ```
440
+
441
+ ## 📚 相关文档
442
+
443
+ - [App 入口规范](./33-client-app-entry.md) - 用户前台入口规范
444
+ - [Client 组件规范](./30-client-components.md) - 用户前台组件规范
445
+ - [Server Admin API](./20-server-api.md) - 服务端 Admin API
@@ -0,0 +1,259 @@
1
+ ---
2
+ paths: src/cli/**/*
3
+ ---
4
+
5
+ # CLI 模块规范
6
+
7
+ ## 📋 原则
8
+
9
+ **CLI 是服务端的 RPC 客户端,通过命令行方式调用服务端 API。**
10
+
11
+ ## 📂 目录结构
12
+
13
+ ```
14
+ src/cli/
15
+ ├── modules/ # 业务模块(约定:一个模块一个目录)
16
+ │ ├── todo/
17
+ │ │ └── index.ts # todo list/get/create/update/delete
18
+ │ ├── notification/
19
+ │ │ └── index.ts # notification list/create/mark-read/delete
20
+ │ ├── config/
21
+ │ │ └── index.ts # 配置管理
22
+ │ └── index.ts # 模块注册入口
23
+ ├── utils/
24
+ │ ├── api.ts # baseUrl 管理 + getClient
25
+ │ ├── logger.ts # 日志模块(支持 verbose)
26
+ │ ├── auto-command.ts # 自动命令生成器
27
+ │ └── index.ts
28
+ ├── rpc/
29
+ │ ├── client.ts # hc RPC 客户端
30
+ │ └── index.ts
31
+ └── index.ts # CLI 入口
32
+ ```
33
+
34
+ ## ✅ 命令结构
35
+
36
+ ### 嵌套命令格式
37
+
38
+ ```bash
39
+ biomimic --help # 查看所有模块
40
+ biomimic todo --help # 查看 todo 模块命令
41
+ biomimic todo create --help # 查看 create 命令详情
42
+ biomimic todo create --title "x" # 执行命令
43
+ ```
44
+
45
+ ### 模块注册
46
+
47
+ ```typescript
48
+ // src/cli/modules/todo/index.ts
49
+ import { Command } from 'commander'
50
+ import { registerAutoCommand, type RouteConfig } from '../../utils/auto-command'
51
+ import { z } from '@hono/zod-openapi'
52
+
53
+ const todoRoutes: RouteConfig[] = [
54
+ {
55
+ method: 'get',
56
+ path: '/todos',
57
+ command: 'list',
58
+ description: 'List all todos',
59
+ },
60
+ {
61
+ method: 'post',
62
+ path: '/todos',
63
+ command: 'create',
64
+ description: 'Create a new todo',
65
+ body: z.object({
66
+ title: z.string().min(1),
67
+ description: z.string().optional(),
68
+ }),
69
+ },
70
+ ]
71
+
72
+ export function registerTodoCommands(program: Command) {
73
+ const todo = program.command('todo').description('Todo management commands')
74
+ for (const route of todoRoutes) {
75
+ registerAutoCommand(todo, route)
76
+ }
77
+ }
78
+ ```
79
+
80
+ ## 🔧 RPC 客户端
81
+
82
+ ### 使用 hc 客户端
83
+
84
+ ```typescript
85
+ // src/cli/rpc/client.ts
86
+ import { hc } from 'hono/client'
87
+ import type { AppType } from '@server/index'
88
+ import { WSClientImpl } from '@shared/core/ws-client'
89
+ import { SSEClientImpl } from '@shared/core/sse-client'
90
+
91
+ export function createRPCClient(baseUrl: string) {
92
+ return hc<AppType>(baseUrl, {
93
+ webSocket: url => new WSClientImpl(url),
94
+ sse: url => new SSEClientImpl(url),
95
+ })
96
+ }
97
+ ```
98
+
99
+ ### 调用 API
100
+
101
+ ```typescript
102
+ // ✅ 正确:直接使用 hc 客户端
103
+ const client = getClient()
104
+ const res = await client.api.todos.$get()
105
+ const data = await res.json()
106
+
107
+ // ❌ 错误:不要使用 fetch
108
+ const res = await fetch('http://localhost:3000/api/todos')
109
+ ```
110
+
111
+ ## 📝 自动命令生成
112
+
113
+ ### RouteConfig 定义
114
+
115
+ ```typescript
116
+ type RouteConfig = {
117
+ method: 'get' | 'post' | 'put' | 'delete' | 'patch'
118
+ path: string
119
+ command: string
120
+ description: string
121
+ params?: ZodObject<Record<string, ZodType>> // 路径参数 -> arguments
122
+ body?: ZodType // 请求体 -> options
123
+ query?: ZodObject<Record<string, ZodType>> // 查询参数 -> options
124
+ }
125
+ ```
126
+
127
+ ### 自动生成效果
128
+
129
+ ```bash
130
+ $ biomimic todo create --help
131
+ Usage: biomimic todo create [options]
132
+
133
+ Create a new todo
134
+
135
+ Options:
136
+ --title <value> string (required)
137
+ --description <value> string
138
+ -h, --help display help for command
139
+ ```
140
+
141
+ ## 📊 日志规范
142
+
143
+ ```typescript
144
+ import { getLogger } from '../utils/logger'
145
+
146
+ const logger = getLogger()
147
+
148
+ logger.info('普通信息') // 总是显示
149
+ logger.debug('调试信息') // 需要 --verbose
150
+ logger.warn('警告信息') // 总是显示
151
+ logger.error('错误信息') // 总是显示
152
+ logger.success('操作成功') // 带 ✓ 前缀
153
+ ```
154
+
155
+ ### 开启详细日志
156
+
157
+ ```bash
158
+ # 通过 --verbose
159
+ biomimic --verbose todo list
160
+
161
+ # 通过环境变量
162
+ BIOMIMIC_VERBOSE=true biomimic todo list
163
+ ```
164
+
165
+ ## ⚙️ 配置管理
166
+
167
+ ### 配置文件路径
168
+
169
+ ```
170
+ ~/.biomimic/config.json
171
+ ```
172
+
173
+ ### 配置结构
174
+
175
+ ```json
176
+ {
177
+ "baseUrl": "http://localhost:3000",
178
+ "stats": {
179
+ "totalCalls": 10,
180
+ "lastCallAt": "2024-01-01T00:00:00Z",
181
+ "commands": {
182
+ "todo:list": 5,
183
+ "notification:create": 3
184
+ }
185
+ }
186
+ }
187
+ ```
188
+
189
+ ### 配置命令
190
+
191
+ ```bash
192
+ biomimic config get # 查看配置
193
+ biomimic config url # 查看当前 URL
194
+ biomimic config url http://... # 设置 URL
195
+ biomimic config status # 检查服务状态
196
+ biomimic config path # 查看配置文件路径
197
+ ```
198
+
199
+ ## 🚫 禁止事项
200
+
201
+ | 禁止 | 原因 | 替代方案 |
202
+ | ---------------- | ------------ | ---------------- |
203
+ | 使用 fetch | 不走类型安全 | 使用 hc 客户端 |
204
+ | 直接导入 Service | 绕过 RPC | 通过 API 调用 |
205
+ | 硬编码 URL | 不可配置 | 使用 config 模块 |
206
+ | 使用 console.log | 无法控制 | 使用 logger |
207
+
208
+ ## 📝 新增模块步骤
209
+
210
+ 1. 在 `src/cli/modules/` 下创建目录
211
+ 2. 定义 `RouteConfig[]` 数组
212
+ 3. 实现 `registerXxxCommands(program: Command)` 函数
213
+ 4. 在 `modules/index.ts` 中注册
214
+
215
+ ## 🎯 最佳实践
216
+
217
+ ### 命令命名
218
+
219
+ ```typescript
220
+ // ✅ 正确:动词作为子命令
221
+ todo list, todo create, todo update, todo delete
222
+
223
+ // ❌ 错误:名词作为子命令
224
+ todo list-todo, create-todo
225
+ ```
226
+
227
+ ### 参数设计
228
+
229
+ ```typescript
230
+ // ✅ 正确:必填参数用 argument
231
+ .argument('<id>', 'Todo ID')
232
+
233
+ // ✅ 正确:可选参数用 option
234
+ .option('--title <value>', 'Todo title')
235
+
236
+ // ✅ 正确:必填选项用 requiredOption
237
+ .requiredOption('--title <value>', 'Todo title')
238
+ ```
239
+
240
+ ### 错误处理
241
+
242
+ ```typescript
243
+ // ✅ 正确:使用 logger 并退出
244
+ if (!id) {
245
+ logger.error('Error: --id is required')
246
+ process.exit(1)
247
+ }
248
+
249
+ // ❌ 错误:抛出异常
250
+ if (!id) {
251
+ throw new Error('--id is required')
252
+ }
253
+ ```
254
+
255
+ ## 🔗 相关文档
256
+
257
+ - [20-server-api.md](./20-server-api.md) - 服务端 API 规范
258
+ - [40-shared-types.md](./40-shared-types.md) - 共享类型规范
259
+ - [10-api-type-inference.md](./10-api-type-inference.md) - API 类型推断