@ai-partner-x/aiko-boot-cli 0.1.4

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 (389) hide show
  1. package/README.md +187 -0
  2. package/dist/cli.d.ts +2 -0
  3. package/dist/cli.js +30 -0
  4. package/dist/commands/add-api.d.ts +5 -0
  5. package/dist/commands/add-api.js +34 -0
  6. package/dist/commands/add-app.d.ts +5 -0
  7. package/dist/commands/add-app.js +34 -0
  8. package/dist/commands/add-feature.d.ts +5 -0
  9. package/dist/commands/add-feature.js +32 -0
  10. package/dist/commands/init.d.ts +7 -0
  11. package/dist/commands/init.js +42 -0
  12. package/dist/commands/list.d.ts +6 -0
  13. package/dist/commands/list.js +36 -0
  14. package/dist/core/framework-version.d.ts +8 -0
  15. package/dist/core/framework-version.js +40 -0
  16. package/dist/core/logger.d.ts +6 -0
  17. package/dist/core/logger.js +16 -0
  18. package/dist/core/project-config.d.ts +21 -0
  19. package/dist/core/project-config.js +17 -0
  20. package/dist/core/prompts.d.ts +5 -0
  21. package/dist/core/prompts.js +43 -0
  22. package/dist/core/template-utils.d.ts +1 -0
  23. package/dist/core/template-utils.js +42 -0
  24. package/dist/core/workspace.d.ts +10 -0
  25. package/dist/core/workspace.js +141 -0
  26. package/dist/index.d.ts +2 -0
  27. package/dist/index.js +2 -0
  28. package/dist/scaffold.d.ts +7 -0
  29. package/dist/scaffold.js +272 -0
  30. package/dist/usecases/add-api.usecase.d.ts +16 -0
  31. package/dist/usecases/add-api.usecase.js +87 -0
  32. package/dist/usecases/add-app.usecase.d.ts +16 -0
  33. package/dist/usecases/add-app.usecase.js +101 -0
  34. package/dist/usecases/add-feature.usecase.d.ts +15 -0
  35. package/dist/usecases/add-feature.usecase.js +566 -0
  36. package/dist/usecases/init-scaffold.usecase.d.ts +19 -0
  37. package/dist/usecases/init-scaffold.usecase.js +131 -0
  38. package/package.json +43 -0
  39. package/templates/api-base/app.config.ts +155 -0
  40. package/templates/api-base/package.json +55 -0
  41. package/templates/api-base/scripts/codegen.cjs +30 -0
  42. package/templates/api-base/scripts/codegen.ts +10 -0
  43. package/templates/api-base/src/controller/auth.controller.ts +160 -0
  44. package/templates/api-base/src/controller/menu.controller.ts +56 -0
  45. package/templates/api-base/src/controller/role.controller.ts +62 -0
  46. package/templates/api-base/src/controller/user.controller.ts +75 -0
  47. package/templates/api-base/src/dto/auth.dto.ts +31 -0
  48. package/templates/api-base/src/dto/menu.dto.ts +38 -0
  49. package/templates/api-base/src/dto/role.dto.ts +18 -0
  50. package/templates/api-base/src/dto/user.dto.ts +36 -0
  51. package/templates/api-base/src/entity/menu.entity.ts +35 -0
  52. package/templates/api-base/src/entity/role-menu.entity.ts +14 -0
  53. package/templates/api-base/src/entity/role.entity.ts +23 -0
  54. package/templates/api-base/src/entity/user-role.entity.ts +14 -0
  55. package/templates/api-base/src/entity/user.entity.ts +32 -0
  56. package/templates/api-base/src/mapper/menu.mapper.ts +7 -0
  57. package/templates/api-base/src/mapper/role-menu.mapper.ts +7 -0
  58. package/templates/api-base/src/mapper/role.mapper.ts +7 -0
  59. package/templates/api-base/src/mapper/user-role.mapper.ts +7 -0
  60. package/templates/api-base/src/mapper/user.mapper.ts +12 -0
  61. package/templates/api-base/src/scripts/init-db.ts +204 -0
  62. package/templates/api-base/src/server.ts +69 -0
  63. package/templates/api-base/src/service/auth.service.ts +144 -0
  64. package/templates/api-base/src/service/log.request.service.ts +72 -0
  65. package/templates/api-base/src/service/menu.service.ts +94 -0
  66. package/templates/api-base/src/service/role.service.ts +88 -0
  67. package/templates/api-base/src/service/user.service.ts +175 -0
  68. package/templates/api-base/src/utils/jwt.util.ts +39 -0
  69. package/templates/api-base/tsconfig.json +18 -0
  70. package/templates/feature-file/api/upload.controller.ts +97 -0
  71. package/templates/feature-log/api/docs/log-integration-guide.md +54 -0
  72. package/templates/feature-log/api/src/service/log.request.service.ts +112 -0
  73. package/templates/feature-log/api/src/service/log.service.ts +124 -0
  74. package/templates/feature-mq/api/src/controller/mq.controller.ts +35 -0
  75. package/templates/feature-mq/api/src/dto/mq.dto.ts +16 -0
  76. package/templates/feature-mq/api/src/service/mq.consumer.service.ts +26 -0
  77. package/templates/feature-redis/api/src/controller/cache.controller.ts +107 -0
  78. package/templates/feature-redis/api/src/dto/cache.dto.ts +24 -0
  79. package/templates/feature-redis/api/src/service/cache.service.ts +80 -0
  80. package/templates/scaffold-default/README.md +114 -0
  81. package/templates/scaffold-default/package.json +26 -0
  82. package/templates/scaffold-default/packages/admin/.env.dev +1 -0
  83. package/templates/scaffold-default/packages/admin/.env.prod +4 -0
  84. package/templates/scaffold-default/packages/admin/.env.stage +4 -0
  85. package/templates/scaffold-default/packages/admin/Dockerfile +37 -0
  86. package/templates/scaffold-default/packages/admin/README.MD +27 -0
  87. package/templates/scaffold-default/packages/admin/components.json +21 -0
  88. package/templates/scaffold-default/packages/admin/eslint.config.js +28 -0
  89. package/templates/scaffold-default/packages/admin/index.html +50 -0
  90. package/templates/scaffold-default/packages/admin/package.json +100 -0
  91. package/templates/scaffold-default/packages/admin/public/vite.svg +1 -0
  92. package/templates/scaffold-default/packages/admin/src/App.css +82 -0
  93. package/templates/scaffold-default/packages/admin/src/App.tsx +128 -0
  94. package/templates/scaffold-default/packages/admin/src/app.config.ts +3 -0
  95. package/templates/scaffold-default/packages/admin/src/components/admin-ui/data-table/data-table-pagination.tsx +148 -0
  96. package/templates/scaffold-default/packages/admin/src/components/admin-ui/data-table/data-table-sorter.tsx +50 -0
  97. package/templates/scaffold-default/packages/admin/src/components/admin-ui/data-table/index.tsx +266 -0
  98. package/templates/scaffold-default/packages/admin/src/components/admin-ui/editable-table.tsx +292 -0
  99. package/templates/scaffold-default/packages/admin/src/components/admin-ui/form/input-password.tsx +38 -0
  100. package/templates/scaffold-default/packages/admin/src/components/admin-ui/form/sign-in-form.tsx +118 -0
  101. package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/error-component.tsx +71 -0
  102. package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/header.tsx +162 -0
  103. package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/language-switcher.tsx +47 -0
  104. package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/layout.tsx +42 -0
  105. package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/loading-overlay.tsx +36 -0
  106. package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/shell-bar.tsx +232 -0
  107. package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/sidebar.tsx +193 -0
  108. package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/user-avatar.tsx +31 -0
  109. package/templates/scaffold-default/packages/admin/src/components/admin-ui/list-report.tsx +306 -0
  110. package/templates/scaffold-default/packages/admin/src/components/admin-ui/master-detail.tsx +382 -0
  111. package/templates/scaffold-default/packages/admin/src/components/admin-ui/notification/toaster.tsx +23 -0
  112. package/templates/scaffold-default/packages/admin/src/components/admin-ui/notification/undoable-notification.tsx +84 -0
  113. package/templates/scaffold-default/packages/admin/src/components/admin-ui/object-page.tsx +539 -0
  114. package/templates/scaffold-default/packages/admin/src/components/admin-ui/theme/theme-provider.tsx +160 -0
  115. package/templates/scaffold-default/packages/admin/src/components/admin-ui/theme/theme-select.tsx +129 -0
  116. package/templates/scaffold-default/packages/admin/src/components/admin-ui/theme/theme-toggle.tsx +90 -0
  117. package/templates/scaffold-default/packages/admin/src/components/ui/accordion.tsx +64 -0
  118. package/templates/scaffold-default/packages/admin/src/components/ui/alert-dialog.tsx +157 -0
  119. package/templates/scaffold-default/packages/admin/src/components/ui/alert.tsx +66 -0
  120. package/templates/scaffold-default/packages/admin/src/components/ui/aspect-ratio.tsx +9 -0
  121. package/templates/scaffold-default/packages/admin/src/components/ui/avatar.tsx +53 -0
  122. package/templates/scaffold-default/packages/admin/src/components/ui/badge.tsx +47 -0
  123. package/templates/scaffold-default/packages/admin/src/components/ui/breadcrumb.tsx +111 -0
  124. package/templates/scaffold-default/packages/admin/src/components/ui/button.tsx +59 -0
  125. package/templates/scaffold-default/packages/admin/src/components/ui/calendar.tsx +74 -0
  126. package/templates/scaffold-default/packages/admin/src/components/ui/card.tsx +92 -0
  127. package/templates/scaffold-default/packages/admin/src/components/ui/carousel.tsx +237 -0
  128. package/templates/scaffold-default/packages/admin/src/components/ui/chart.tsx +351 -0
  129. package/templates/scaffold-default/packages/admin/src/components/ui/checkbox.tsx +32 -0
  130. package/templates/scaffold-default/packages/admin/src/components/ui/collapsible.tsx +33 -0
  131. package/templates/scaffold-default/packages/admin/src/components/ui/command.tsx +182 -0
  132. package/templates/scaffold-default/packages/admin/src/components/ui/context-menu.tsx +252 -0
  133. package/templates/scaffold-default/packages/admin/src/components/ui/dialog.tsx +141 -0
  134. package/templates/scaffold-default/packages/admin/src/components/ui/drawer.tsx +130 -0
  135. package/templates/scaffold-default/packages/admin/src/components/ui/dropdown-menu.tsx +255 -0
  136. package/templates/scaffold-default/packages/admin/src/components/ui/form.tsx +166 -0
  137. package/templates/scaffold-default/packages/admin/src/components/ui/hover-card.tsx +42 -0
  138. package/templates/scaffold-default/packages/admin/src/components/ui/input-otp.tsx +77 -0
  139. package/templates/scaffold-default/packages/admin/src/components/ui/input.tsx +21 -0
  140. package/templates/scaffold-default/packages/admin/src/components/ui/label.tsx +22 -0
  141. package/templates/scaffold-default/packages/admin/src/components/ui/menubar.tsx +274 -0
  142. package/templates/scaffold-default/packages/admin/src/components/ui/navigation-menu.tsx +168 -0
  143. package/templates/scaffold-default/packages/admin/src/components/ui/pagination.tsx +127 -0
  144. package/templates/scaffold-default/packages/admin/src/components/ui/popover.tsx +48 -0
  145. package/templates/scaffold-default/packages/admin/src/components/ui/progress.tsx +29 -0
  146. package/templates/scaffold-default/packages/admin/src/components/ui/radio-group.tsx +45 -0
  147. package/templates/scaffold-default/packages/admin/src/components/ui/resizable.tsx +54 -0
  148. package/templates/scaffold-default/packages/admin/src/components/ui/scroll-area.tsx +58 -0
  149. package/templates/scaffold-default/packages/admin/src/components/ui/select.tsx +183 -0
  150. package/templates/scaffold-default/packages/admin/src/components/ui/separator.tsx +26 -0
  151. package/templates/scaffold-default/packages/admin/src/components/ui/sheet.tsx +139 -0
  152. package/templates/scaffold-default/packages/admin/src/components/ui/sidebar.tsx +740 -0
  153. package/templates/scaffold-default/packages/admin/src/components/ui/skeleton.tsx +13 -0
  154. package/templates/scaffold-default/packages/admin/src/components/ui/slider.tsx +63 -0
  155. package/templates/scaffold-default/packages/admin/src/components/ui/sonner.tsx +23 -0
  156. package/templates/scaffold-default/packages/admin/src/components/ui/switch.tsx +31 -0
  157. package/templates/scaffold-default/packages/admin/src/components/ui/table.tsx +114 -0
  158. package/templates/scaffold-default/packages/admin/src/components/ui/tabs.tsx +66 -0
  159. package/templates/scaffold-default/packages/admin/src/components/ui/textarea.tsx +18 -0
  160. package/templates/scaffold-default/packages/admin/src/components/ui/toggle-group.tsx +73 -0
  161. package/templates/scaffold-default/packages/admin/src/components/ui/toggle.tsx +45 -0
  162. package/templates/scaffold-default/packages/admin/src/components/ui/tooltip.tsx +59 -0
  163. package/templates/scaffold-default/packages/admin/src/hooks/use-mobile.ts +21 -0
  164. package/templates/scaffold-default/packages/admin/src/i18n.ts +20 -0
  165. package/templates/scaffold-default/packages/admin/src/index.tsx +19 -0
  166. package/templates/scaffold-default/packages/admin/src/layouts/menu-layout.tsx +211 -0
  167. package/templates/scaffold-default/packages/admin/src/layouts/tile-layout.tsx +355 -0
  168. package/templates/scaffold-default/packages/admin/src/lib/utils.ts +6 -0
  169. package/templates/scaffold-default/packages/admin/src/locales/en.json +68 -0
  170. package/templates/scaffold-default/packages/admin/src/locales/zh.json +68 -0
  171. package/templates/scaffold-default/packages/admin/src/pages/dashboard.tsx +12 -0
  172. package/templates/scaffold-default/packages/admin/src/pages/goods-receipt/CreatePage.tsx +302 -0
  173. package/templates/scaffold-default/packages/admin/src/pages/goods-receipt/EditPage.tsx +221 -0
  174. package/templates/scaffold-default/packages/admin/src/pages/goods-receipt/ListPage.tsx +283 -0
  175. package/templates/scaffold-default/packages/admin/src/pages/goods-receipt/ViewPage.tsx +280 -0
  176. package/templates/scaffold-default/packages/admin/src/pages/goods-receipt/index.ts +4 -0
  177. package/templates/scaffold-default/packages/admin/src/pages/home-page.tsx +244 -0
  178. package/templates/scaffold-default/packages/admin/src/pages/master-data/cost-centers/index.tsx +461 -0
  179. package/templates/scaffold-default/packages/admin/src/pages/master-data/currencies/index.tsx +255 -0
  180. package/templates/scaffold-default/packages/admin/src/pages/master-data/materials/ListPage.tsx +271 -0
  181. package/templates/scaffold-default/packages/admin/src/pages/master-data/materials/ViewPage.tsx +240 -0
  182. package/templates/scaffold-default/packages/admin/src/pages/master-data/materials/index.ts +2 -0
  183. package/templates/scaffold-default/packages/admin/src/pages/master-data/plants/ListPage.tsx +279 -0
  184. package/templates/scaffold-default/packages/admin/src/pages/master-data/plants/ViewPage.tsx +380 -0
  185. package/templates/scaffold-default/packages/admin/src/pages/master-data/plants/index.ts +2 -0
  186. package/templates/scaffold-default/packages/admin/src/pages/master-data/purchase-organizations/index.tsx +341 -0
  187. package/templates/scaffold-default/packages/admin/src/pages/master-data/units-of-measure/index.tsx +295 -0
  188. package/templates/scaffold-default/packages/admin/src/pages/master-data/vendors/ListPage.tsx +266 -0
  189. package/templates/scaffold-default/packages/admin/src/pages/master-data/vendors/ViewPage.tsx +274 -0
  190. package/templates/scaffold-default/packages/admin/src/pages/master-data/vendors/index.ts +2 -0
  191. package/templates/scaffold-default/packages/admin/src/pages/placeholder-page.tsx +13 -0
  192. package/templates/scaffold-default/packages/admin/src/pages/purchase-orders/ListPage.tsx +289 -0
  193. package/templates/scaffold-default/packages/admin/src/pages/purchase-orders/ViewPage.tsx +343 -0
  194. package/templates/scaffold-default/packages/admin/src/pages/purchase-orders/index.ts +2 -0
  195. package/templates/scaffold-default/packages/admin/src/pages/purchase-requisitions/CreatePage.tsx +398 -0
  196. package/templates/scaffold-default/packages/admin/src/pages/purchase-requisitions/EditPage.tsx +473 -0
  197. package/templates/scaffold-default/packages/admin/src/pages/purchase-requisitions/ListPage.tsx +307 -0
  198. package/templates/scaffold-default/packages/admin/src/pages/purchase-requisitions/ViewPage.tsx +304 -0
  199. package/templates/scaffold-default/packages/admin/src/pages/purchase-requisitions/constants.ts +51 -0
  200. package/templates/scaffold-default/packages/admin/src/pages/purchase-requisitions/index.ts +4 -0
  201. package/templates/scaffold-default/packages/admin/src/pages/reports/PurchaseOrderReport.tsx +312 -0
  202. package/templates/scaffold-default/packages/admin/src/pages/reports/PurchaseRequisitionReport.tsx +303 -0
  203. package/templates/scaffold-default/packages/admin/src/pages/reports/index.ts +2 -0
  204. package/templates/scaffold-default/packages/admin/src/pages/settings-page.tsx +335 -0
  205. package/templates/scaffold-default/packages/admin/src/providers/app-config.tsx +50 -0
  206. package/templates/scaffold-default/packages/admin/src/providers/auth-provider.ts +2 -0
  207. package/templates/scaffold-default/packages/admin/src/routes/auth.ts +9 -0
  208. package/templates/scaffold-default/packages/admin/src/routes/index.ts +85 -0
  209. package/templates/scaffold-default/packages/admin/src/routes/menu.ts +176 -0
  210. package/templates/scaffold-default/packages/admin/src/routes/modules/goods-receipt.ts +31 -0
  211. package/templates/scaffold-default/packages/admin/src/routes/modules/master-data.ts +41 -0
  212. package/templates/scaffold-default/packages/admin/src/routes/modules/purchase-orders.ts +27 -0
  213. package/templates/scaffold-default/packages/admin/src/routes/modules/purchase-requisitions.ts +39 -0
  214. package/templates/scaffold-default/packages/admin/src/routes/modules/reports.ts +33 -0
  215. package/templates/scaffold-default/packages/admin/src/routes/modules/settings.ts +19 -0
  216. package/templates/scaffold-default/packages/admin/src/routes/withSuspense.tsx +21 -0
  217. package/templates/scaffold-default/packages/admin/src/theme/amber.css +27 -0
  218. package/templates/scaffold-default/packages/admin/src/theme/blue.css +27 -0
  219. package/templates/scaffold-default/packages/admin/src/theme/default.css +75 -0
  220. package/templates/scaffold-default/packages/admin/src/theme/fiori.css +180 -0
  221. package/templates/scaffold-default/packages/admin/src/theme/green.css +27 -0
  222. package/templates/scaffold-default/packages/admin/src/theme/index.css +12 -0
  223. package/templates/scaffold-default/packages/admin/src/theme/rose.css +27 -0
  224. package/templates/scaffold-default/packages/admin/src/theme/violet.css +27 -0
  225. package/templates/scaffold-default/packages/admin/src/vite-env.d.ts +1 -0
  226. package/templates/scaffold-default/packages/admin/tsconfig.json +28 -0
  227. package/templates/scaffold-default/packages/admin/tsconfig.node.json +21 -0
  228. package/templates/scaffold-default/packages/admin/vite.config.ts +26 -0
  229. package/templates/scaffold-default/packages/api/.eslintrc.json +6 -0
  230. package/templates/scaffold-default/packages/api/.swcrc +17 -0
  231. package/templates/scaffold-default/packages/api/app.config.ts +163 -0
  232. package/templates/scaffold-default/packages/api/docs/api-document.md +497 -0
  233. package/templates/scaffold-default/packages/api/docs/final-completion-report.md +565 -0
  234. package/templates/scaffold-default/packages/api/docs/permission-integration-summary.md +432 -0
  235. package/templates/scaffold-default/packages/api/examples/security/README.md +664 -0
  236. package/templates/scaffold-default/packages/api/examples/security/complete/.env.example +26 -0
  237. package/templates/scaffold-default/packages/api/examples/security/complete/PROJECT_STRUCTURE.md +220 -0
  238. package/templates/scaffold-default/packages/api/examples/security/complete/README.md +847 -0
  239. package/templates/scaffold-default/packages/api/examples/security/complete/app.config.ts +69 -0
  240. package/templates/scaffold-default/packages/api/examples/security/complete/app.ts +63 -0
  241. package/templates/scaffold-default/packages/api/examples/security/complete/controller/auth.controller.ts +131 -0
  242. package/templates/scaffold-default/packages/api/examples/security/complete/controller/index.ts +4 -0
  243. package/templates/scaffold-default/packages/api/examples/security/complete/controller/permission.controller.ts +41 -0
  244. package/templates/scaffold-default/packages/api/examples/security/complete/controller/role.controller.ts +53 -0
  245. package/templates/scaffold-default/packages/api/examples/security/complete/controller/user.controller.ts +53 -0
  246. package/templates/scaffold-default/packages/api/examples/security/complete/dto/change-password.dto.ts +10 -0
  247. package/templates/scaffold-default/packages/api/examples/security/complete/dto/create-permission.dto.ts +14 -0
  248. package/templates/scaffold-default/packages/api/examples/security/complete/dto/create-role.dto.ts +11 -0
  249. package/templates/scaffold-default/packages/api/examples/security/complete/dto/create-user.dto.ts +15 -0
  250. package/templates/scaffold-default/packages/api/examples/security/complete/dto/index.ts +7 -0
  251. package/templates/scaffold-default/packages/api/examples/security/complete/dto/login.dto.ts +10 -0
  252. package/templates/scaffold-default/packages/api/examples/security/complete/dto/oauth-profile.dto.ts +7 -0
  253. package/templates/scaffold-default/packages/api/examples/security/complete/dto/register.dto.ts +17 -0
  254. package/templates/scaffold-default/packages/api/examples/security/complete/entity/index.ts +6 -0
  255. package/templates/scaffold-default/packages/api/examples/security/complete/entity/oauth-account.entity.ts +39 -0
  256. package/templates/scaffold-default/packages/api/examples/security/complete/entity/permission.entity.ts +31 -0
  257. package/templates/scaffold-default/packages/api/examples/security/complete/entity/role-permission.entity.ts +19 -0
  258. package/templates/scaffold-default/packages/api/examples/security/complete/entity/role.entity.ts +25 -0
  259. package/templates/scaffold-default/packages/api/examples/security/complete/entity/user-role.entity.ts +19 -0
  260. package/templates/scaffold-default/packages/api/examples/security/complete/entity/user.entity.ts +46 -0
  261. package/templates/scaffold-default/packages/api/examples/security/complete/init.sql +81 -0
  262. package/templates/scaffold-default/packages/api/examples/security/complete/middleware/auth.interceptor.ts +39 -0
  263. package/templates/scaffold-default/packages/api/examples/security/complete/middleware/index.ts +2 -0
  264. package/templates/scaffold-default/packages/api/examples/security/complete/middleware/permission.interceptor.ts +61 -0
  265. package/templates/scaffold-default/packages/api/examples/security/complete/package.json +54 -0
  266. package/templates/scaffold-default/packages/api/examples/security/complete/seed.sql +42 -0
  267. package/templates/scaffold-default/packages/api/examples/security/complete/service/auth.service.ts +41 -0
  268. package/templates/scaffold-default/packages/api/examples/security/complete/service/index.ts +5 -0
  269. package/templates/scaffold-default/packages/api/examples/security/complete/service/oauth.service.ts +82 -0
  270. package/templates/scaffold-default/packages/api/examples/security/complete/service/permission.service.ts +113 -0
  271. package/templates/scaffold-default/packages/api/examples/security/complete/service/role.service.ts +85 -0
  272. package/templates/scaffold-default/packages/api/examples/security/complete/service/user.service.ts +132 -0
  273. package/templates/scaffold-default/packages/api/examples/security/complete/tests/TEST_REPORT.md +318 -0
  274. package/templates/scaffold-default/packages/api/examples/security/complete/tests/generate-report.js +335 -0
  275. package/templates/scaffold-default/packages/api/examples/security/complete/tests/helpers/api-helpers.ts +116 -0
  276. package/templates/scaffold-default/packages/api/examples/security/complete/tests/helpers/index.ts +2 -0
  277. package/templates/scaffold-default/packages/api/examples/security/complete/tests/helpers/test-helpers.ts +129 -0
  278. package/templates/scaffold-default/packages/api/examples/security/complete/tests/integration/auth.api.test.ts +429 -0
  279. package/templates/scaffold-default/packages/api/examples/security/complete/tests/integration/role.api.test.ts +400 -0
  280. package/templates/scaffold-default/packages/api/examples/security/complete/tests/integration/user.api.test.ts +459 -0
  281. package/templates/scaffold-default/packages/api/examples/security/complete/tests/jest.config.js +40 -0
  282. package/templates/scaffold-default/packages/api/examples/security/complete/tests/run-all-tests.js +135 -0
  283. package/templates/scaffold-default/packages/api/examples/security/complete/tests/run-tests.js +109 -0
  284. package/templates/scaffold-default/packages/api/examples/security/complete/tests/setup.ts +19 -0
  285. package/templates/scaffold-default/packages/api/examples/security/complete/tests/unit/auth.service.test.ts +199 -0
  286. package/templates/scaffold-default/packages/api/examples/security/complete/tests/unit/permission.service.test.ts +377 -0
  287. package/templates/scaffold-default/packages/api/examples/security/complete/tests/unit/user.service.test.ts +288 -0
  288. package/templates/scaffold-default/packages/api/examples/security/complete/tsconfig.json +35 -0
  289. package/templates/scaffold-default/packages/api/examples/security/jwt/README.md +424 -0
  290. package/templates/scaffold-default/packages/api/examples/security/local/README.md +499 -0
  291. package/templates/scaffold-default/packages/api/examples/security/oauth2/README.md +637 -0
  292. package/templates/scaffold-default/packages/api/examples/security/permission/README.md +943 -0
  293. package/templates/scaffold-default/packages/api/examples/security/session/README.md +753 -0
  294. package/templates/scaffold-default/packages/api/package.json +63 -0
  295. package/templates/scaffold-default/packages/api/scripts/codegen.cjs +29 -0
  296. package/templates/scaffold-default/packages/api/scripts/codegen.ts +9 -0
  297. package/templates/scaffold-default/packages/api/src/config/security-auto-configuration.ts +75 -0
  298. package/templates/scaffold-default/packages/api/src/controller/auth.controller.ts +109 -0
  299. package/templates/scaffold-default/packages/api/src/controller/cache.controller.ts +106 -0
  300. package/templates/scaffold-default/packages/api/src/controller/menu.controller.ts +86 -0
  301. package/templates/scaffold-default/packages/api/src/controller/mq.controller.ts +35 -0
  302. package/templates/scaffold-default/packages/api/src/controller/role.controller.ts +100 -0
  303. package/templates/scaffold-default/packages/api/src/controller/upload.controller.ts +83 -0
  304. package/templates/scaffold-default/packages/api/src/controller/user.controller.ts +102 -0
  305. package/templates/scaffold-default/packages/api/src/dto/auth.dto.ts +30 -0
  306. package/templates/scaffold-default/packages/api/src/dto/cache.dto.ts +24 -0
  307. package/templates/scaffold-default/packages/api/src/dto/menu.dto.ts +37 -0
  308. package/templates/scaffold-default/packages/api/src/dto/mq.dto.ts +16 -0
  309. package/templates/scaffold-default/packages/api/src/dto/role.dto.ts +16 -0
  310. package/templates/scaffold-default/packages/api/src/dto/user.dto.ts +35 -0
  311. package/templates/scaffold-default/packages/api/src/entity/menu.entity.ts +34 -0
  312. package/templates/scaffold-default/packages/api/src/entity/role-menu.entity.ts +13 -0
  313. package/templates/scaffold-default/packages/api/src/entity/role.entity.ts +22 -0
  314. package/templates/scaffold-default/packages/api/src/entity/user-role.entity.ts +13 -0
  315. package/templates/scaffold-default/packages/api/src/entity/user.entity.ts +31 -0
  316. package/templates/scaffold-default/packages/api/src/mapper/menu.mapper.ts +6 -0
  317. package/templates/scaffold-default/packages/api/src/mapper/role-menu.mapper.ts +6 -0
  318. package/templates/scaffold-default/packages/api/src/mapper/role.mapper.ts +6 -0
  319. package/templates/scaffold-default/packages/api/src/mapper/user-role.mapper.ts +6 -0
  320. package/templates/scaffold-default/packages/api/src/mapper/user.mapper.ts +11 -0
  321. package/templates/scaffold-default/packages/api/src/scripts/assign-role.ts +41 -0
  322. package/templates/scaffold-default/packages/api/src/scripts/check-user-role.ts +28 -0
  323. package/templates/scaffold-default/packages/api/src/scripts/check-users.mjs +44 -0
  324. package/templates/scaffold-default/packages/api/src/scripts/demo-permissions.mjs +418 -0
  325. package/templates/scaffold-default/packages/api/src/scripts/init-db.ts +166 -0
  326. package/templates/scaffold-default/packages/api/src/scripts/reset-admin-password.mjs +70 -0
  327. package/templates/scaffold-default/packages/api/src/scripts/reset-password.ts +31 -0
  328. package/templates/scaffold-default/packages/api/src/scripts/simple-reset-admin.mjs +39 -0
  329. package/templates/scaffold-default/packages/api/src/scripts/test-db.ts +36 -0
  330. package/templates/scaffold-default/packages/api/src/scripts/test-di.ts +45 -0
  331. package/templates/scaffold-default/packages/api/src/scripts/test-permissions.mjs +551 -0
  332. package/templates/scaffold-default/packages/api/src/scripts/update-admin-password.mjs +56 -0
  333. package/templates/scaffold-default/packages/api/src/scripts/user-roles.ts +28 -0
  334. package/templates/scaffold-default/packages/api/src/server.ts +38 -0
  335. package/templates/scaffold-default/packages/api/src/service/auth.service.ts +165 -0
  336. package/templates/scaffold-default/packages/api/src/service/cache.service.ts +80 -0
  337. package/templates/scaffold-default/packages/api/src/service/log.request.service.ts +158 -0
  338. package/templates/scaffold-default/packages/api/src/service/log.service.ts +123 -0
  339. package/templates/scaffold-default/packages/api/src/service/menu.service.ts +94 -0
  340. package/templates/scaffold-default/packages/api/src/service/mq.consumer.service.ts +26 -0
  341. package/templates/scaffold-default/packages/api/src/service/role.service.ts +88 -0
  342. package/templates/scaffold-default/packages/api/src/service/user.service.ts +195 -0
  343. package/templates/scaffold-default/packages/api/src/types/sqljs.d.ts +18 -0
  344. package/templates/scaffold-default/packages/api/src/utils/auth.utils.js +0 -0
  345. package/templates/scaffold-default/packages/api/src/utils/jwt.util.ts +29 -0
  346. package/templates/scaffold-default/packages/api/tsconfig.json +17 -0
  347. package/templates/scaffold-default/packages/api/tsup.config.ts +14 -0
  348. package/templates/scaffold-default/packages/api/uploads/.gitkeep +0 -0
  349. package/templates/scaffold-default/packages/core/package.json +28 -0
  350. package/templates/scaffold-default/packages/core/src/auth/auth-client-middleware.ts +22 -0
  351. package/templates/scaffold-default/packages/core/src/auth/auth-constants.ts +6 -0
  352. package/templates/scaffold-default/packages/core/src/auth/auth-service.ts +65 -0
  353. package/templates/scaffold-default/packages/core/src/auth/backend-auth-provider.ts +149 -0
  354. package/templates/scaffold-default/packages/core/src/auth/default-auth-provider.ts +38 -0
  355. package/templates/scaffold-default/packages/core/src/auth/index.ts +12 -0
  356. package/templates/scaffold-default/packages/core/src/auth/types.ts +38 -0
  357. package/templates/scaffold-default/packages/core/src/authorization/authorization-client-middleware.ts +38 -0
  358. package/templates/scaffold-default/packages/core/src/authorization/authorization-config.ts +13 -0
  359. package/templates/scaffold-default/packages/core/src/authorization/authorization-provider.tsx +116 -0
  360. package/templates/scaffold-default/packages/core/src/authorization/default-authorization-provider.ts +26 -0
  361. package/templates/scaffold-default/packages/core/src/authorization/index.ts +15 -0
  362. package/templates/scaffold-default/packages/core/src/authorization/types.ts +42 -0
  363. package/templates/scaffold-default/packages/core/src/index.ts +3 -0
  364. package/templates/scaffold-default/packages/core/src/utils/promise-result-cache.ts +18 -0
  365. package/templates/scaffold-default/packages/core/tsconfig.json +19 -0
  366. package/templates/scaffold-default/packages/mobile/README.md +56 -0
  367. package/templates/scaffold-default/packages/mobile/index.html +13 -0
  368. package/templates/scaffold-default/packages/mobile/package.json +28 -0
  369. package/templates/scaffold-default/packages/mobile/postcss.config.mjs +7 -0
  370. package/templates/scaffold-default/packages/mobile/src/App.tsx +5 -0
  371. package/templates/scaffold-default/packages/mobile/src/app/globals.css +1 -0
  372. package/templates/scaffold-default/packages/mobile/src/components/LoginForm.tsx +83 -0
  373. package/templates/scaffold-default/packages/mobile/src/hooks/index.ts +5 -0
  374. package/templates/scaffold-default/packages/mobile/src/lib/utils.ts +7 -0
  375. package/templates/scaffold-default/packages/mobile/src/main.tsx +19 -0
  376. package/templates/scaffold-default/packages/mobile/src/pages/HomePage.tsx +41 -0
  377. package/templates/scaffold-default/packages/mobile/src/pages/LoginPage.tsx +24 -0
  378. package/templates/scaffold-default/packages/mobile/src/pages/index.ts +2 -0
  379. package/templates/scaffold-default/packages/mobile/src/routes/ProtectedRoute.tsx +35 -0
  380. package/templates/scaffold-default/packages/mobile/src/routes/index.tsx +24 -0
  381. package/templates/scaffold-default/packages/mobile/src/routes/routes.ts +11 -0
  382. package/templates/scaffold-default/packages/mobile/src/types/index.ts +5 -0
  383. package/templates/scaffold-default/packages/mobile/src/vite-env.d.ts +1 -0
  384. package/templates/scaffold-default/packages/mobile/tsconfig.json +23 -0
  385. package/templates/scaffold-default/packages/mobile/tsconfig.node.json +11 -0
  386. package/templates/scaffold-default/packages/mobile/vite.config.ts +20 -0
  387. package/templates/scaffold-default/pnpm-workspace.yaml +2 -0
  388. package/templates/scaffold-default/scripts/postinstall.cjs +42 -0
  389. package/templates/scaffold-default/scripts/rebuild-sqlite.cjs +23 -0
@@ -0,0 +1,149 @@
1
+ import type { AuthProviderConfig, AuthUser, LoginParams } from "./types"
2
+ import { AUTH_ACCESS_TOKEN_KEY } from "./auth-constants"
3
+
4
+ export type BackendAuthProviderOptions = {
5
+ /** 未授权时跳转的登录地址(通常是 "/login") */
6
+ loginUrl?: string
7
+ }
8
+
9
+ type ApiEnvelope<T> = { success: boolean; data?: T; error?: string }
10
+
11
+ async function readJson<T>(res: Response): Promise<T> {
12
+ return await res.json() as T
13
+ }
14
+
15
+ async function readTextSafe(res: Response): Promise<string> {
16
+ return await res.text().catch(() => "")
17
+ }
18
+
19
+ /**
20
+ * Parse backend response:
21
+ * - supports plain data (T)
22
+ * - supports envelope: { success, data, error }
23
+ */
24
+ function unwrapEnvelope<T>(payload: T | ApiEnvelope<T>): T {
25
+ if (payload && typeof payload === "object" && "success" in payload) {
26
+ const env = payload as ApiEnvelope<T>
27
+ if (!env.success) throw new Error(env.error || "Request failed")
28
+ return env.data as T
29
+ }
30
+ return payload as T
31
+ }
32
+
33
+ /** Map backend userInfo to core AuthUser. Handles missing/optional fields safely. */
34
+ function toAuthUser(info: {
35
+ id?: number | null
36
+ username?: string | null
37
+ realName?: string | null
38
+ email?: string | null
39
+ roles?: string[] | null
40
+ permissions?: string[] | null
41
+ }): AuthUser {
42
+ const account = info.username ?? ""
43
+ return {
44
+ ...(info.id != null && { id: String(info.id) }),
45
+ account,
46
+ ...(info.email != null && info.email !== "" && { email: info.email }),
47
+ ...(info.realName != null && { realName: info.realName }),
48
+ ...(info.roles != null && info.roles.length > 0 && { roles: info.roles }),
49
+ ...(info.permissions != null && info.permissions.length > 0 && { permissions: info.permissions }),
50
+ }
51
+ }
52
+
53
+ function getAuthErrorMessage(error: unknown, fallbackMessage: string): string {
54
+ if (error instanceof Error && error.message.trim() !== "") return error.message
55
+ if (typeof error === "string" && error.trim() !== "") return error
56
+ return fallbackMessage
57
+ }
58
+
59
+ function logAuthError(context: string, error: unknown): void {
60
+ // Centralized auth error logging for easier debugging.
61
+ console.error(`[Auth] ${context} error:`, error)
62
+ }
63
+
64
+ /**
65
+ * Backend auth provider for both admin & mobile.
66
+ * - login: calls backend /auth/login
67
+ * - getIdentity: calls backend /auth/current-user with stored access token
68
+ * - logout: clears token
69
+ * - onError: clears token on 401/403 and redirects to login
70
+ */
71
+ export function createBackendAuthProvider(
72
+ apiBaseUrl: string,
73
+ options: BackendAuthProviderOptions = {}
74
+ ): AuthProviderConfig {
75
+ const loginUrl = options.loginUrl ?? "/login"
76
+
77
+ return {
78
+ login: async (params: LoginParams) => {
79
+ try {
80
+ const res = await fetch(`${apiBaseUrl}/api/auth/login`, {
81
+ method: "POST",
82
+ headers: { "Content-Type": "application/json" },
83
+ body: JSON.stringify({
84
+ username: params.account,
85
+ password: params.password ?? "",
86
+ }),
87
+ })
88
+ if (!res.ok) {
89
+ const text = await readTextSafe(res)
90
+ throw new Error(text || `Login failed (${res.status})`)
91
+ }
92
+ const raw = await readJson<ApiEnvelope<{ accessToken?: string; refreshToken?: string; userInfo?: any }> | { accessToken?: string; refreshToken?: string; userInfo?: any }>(res)
93
+ const result = unwrapEnvelope(raw)
94
+ if (result?.accessToken) {
95
+ localStorage.setItem(AUTH_ACCESS_TOKEN_KEY, result.accessToken)
96
+ }
97
+ return {
98
+ success: true,
99
+ user: toAuthUser(result?.userInfo ?? {}),
100
+ redirectTo: "/",
101
+ }
102
+ } catch (err) {
103
+ logAuthError("login", err)
104
+ const message = getAuthErrorMessage(err, "Login failed")
105
+ return {
106
+ success: false,
107
+ error: { name: "Login Error", message },
108
+ }
109
+ }
110
+ },
111
+
112
+ logout: async () => {
113
+ localStorage.removeItem(AUTH_ACCESS_TOKEN_KEY)
114
+ return { success: true }
115
+ },
116
+
117
+ getIdentity: async (): Promise<AuthUser | null> => {
118
+ const token = localStorage.getItem(AUTH_ACCESS_TOKEN_KEY)
119
+ if (!token) return null
120
+ try {
121
+ const res = await fetch(`${apiBaseUrl}/api/auth/current`, {
122
+ method: "POST",
123
+ headers: { Authorization: `Bearer ${token}` },
124
+ })
125
+ if (!res.ok) {
126
+ const text = await readTextSafe(res)
127
+ throw new Error(text || `Get identity failed (${res.status})`)
128
+ }
129
+ const raw = await readJson<ApiEnvelope<any> | any>(res)
130
+ const userInfo = unwrapEnvelope(raw)
131
+ return toAuthUser(userInfo ?? {})
132
+ } catch (err) {
133
+ logAuthError("getIdentity", err)
134
+ localStorage.removeItem(AUTH_ACCESS_TOKEN_KEY)
135
+ return null
136
+ }
137
+ },
138
+
139
+ onError: async (error: Error & { statusCode?: number }) => {
140
+ logAuthError("onError", error)
141
+ const status = error.statusCode
142
+ if (status === 401 || status === 403) {
143
+ localStorage.removeItem(AUTH_ACCESS_TOKEN_KEY)
144
+ return { logout: true, redirectTo: loginUrl }
145
+ }
146
+ },
147
+ }
148
+ }
149
+
@@ -0,0 +1,38 @@
1
+ import { AuthProviderConfig, AuthUser } from "./types"
2
+
3
+ /** Demo/local provider only: stores serialized user blob. Backend providers use AUTH_ACCESS_TOKEN_KEY in auth-constants.ts. */
4
+ const AUTH_STORAGE_KEY = "_kdid"
5
+
6
+ const defaultAuthProvider: AuthProviderConfig = {
7
+ // 表单登录,根据实现情况调整
8
+ login: async ({ account }) => {
9
+ const user: AuthUser = {
10
+ account
11
+ }
12
+ try {
13
+ localStorage.setItem(AUTH_STORAGE_KEY, JSON.stringify(user))
14
+ return { success: true, user, redirectTo: "/" }
15
+ } catch {
16
+ return {
17
+ success: false,
18
+ error: { name: "Login Error", message: "Failed to save session" },
19
+ }
20
+ }
21
+ },
22
+ logout: async () => {
23
+ localStorage.removeItem(AUTH_STORAGE_KEY)
24
+ return { success: true }
25
+ },
26
+ // prod: 获取当前登录用户,换成接口
27
+ getIdentity: async () => {
28
+ const raw = localStorage.getItem(AUTH_STORAGE_KEY)
29
+ if (!raw) return null
30
+ try {
31
+ return JSON.parse(raw) as AuthUser
32
+ } catch {
33
+ return null
34
+ }
35
+ }
36
+ }
37
+
38
+ export default defaultAuthProvider
@@ -0,0 +1,12 @@
1
+ export { appAuth } from "./auth-service"
2
+ export { AUTH_ACCESS_TOKEN_KEY } from "./auth-constants"
3
+ export { default as defaultAuthProvider } from "./default-auth-provider"
4
+ export { createBackendAuthProvider } from "./backend-auth-provider"
5
+ export { createAuthClientMiddleware } from "./auth-client-middleware"
6
+ export type {
7
+ AuthUser,
8
+ LoginParams,
9
+ AuthProviderConfig,
10
+ AuthProviderResult,
11
+ AuthConfig
12
+ } from "./types"
@@ -0,0 +1,38 @@
1
+ import { ReactNode } from "react"
2
+
3
+ export type AuthUser = {
4
+ id?: string
5
+ /** 登录账号/用户名(替代原 name 字段) */
6
+ account: string
7
+ /** 可选:邮箱 */
8
+ email?: string
9
+ avatar?: string | ReactNode
10
+ /** 允许携带额外的用户数据(例如 roles、dept、tenant 等) */
11
+ [key: string]: unknown
12
+ }
13
+
14
+ export type LoginParams = {
15
+ account: string
16
+ password?: string,
17
+ [key: string]: unknown
18
+ }
19
+
20
+ export type AuthProviderResult = {
21
+ success: boolean
22
+ redirectTo?: string
23
+ user?: AuthUser
24
+ error?: { name: string; message: string }
25
+ }
26
+
27
+ export type AuthProviderConfig = {
28
+ login?: (params: LoginParams) => Promise<AuthProviderResult>
29
+ logout: () => Promise<AuthProviderResult>
30
+ getIdentity: () => Promise<AuthUser | null>
31
+ onError?: (
32
+ error: Error & { statusCode?: number }
33
+ ) => Promise<{ logout?: boolean; redirectTo?: string } | void>
34
+ }
35
+
36
+ export type AuthConfig = {
37
+ provider?: AuthProviderConfig
38
+ }
@@ -0,0 +1,38 @@
1
+ import { redirect } from "react-router"
2
+ import { authorizationConfig } from "./authorization-config"
3
+ import { NormalizedPermissions, PermissionSet } from "./types"
4
+
5
+ export function normalizePermissions(input: PermissionSet | null | undefined): NormalizedPermissions {
6
+ if (!input) return { set: new Set() }
7
+ if (Array.isArray(input)) {
8
+ // 忽略 "*",必须显式配置每个权限 key
9
+ const keys = input.filter((k) => k && k !== "*")
10
+ return { set: new Set(keys) }
11
+ }
12
+ const keys = Object.keys(input).filter((k) => k && k !== "*" && input[k] === true)
13
+ return { set: new Set(keys) }
14
+ }
15
+
16
+ export const createAuthorizationClientMiddleware = (key?: string) => {
17
+ return async function authorizationClientMiddleware(
18
+ _args: {
19
+ request: Request
20
+ context: unknown
21
+ },
22
+ next: () => Promise<unknown>
23
+ ): Promise<void> {
24
+ if (!authorizationConfig.useMiddleware || !authorizationConfig.provider) {
25
+ await next()
26
+ return
27
+ }
28
+ const { permissionPoints } = await authorizationConfig.provider.getPermissions()
29
+ const p = normalizePermissions(permissionPoints)
30
+ if (!key) {
31
+ key = location.pathname
32
+ }
33
+ if (!p.set.has(key)) {
34
+ throw redirect(authorizationConfig.fallbackUrl!)
35
+ }
36
+ await next()
37
+ }
38
+ }
@@ -0,0 +1,13 @@
1
+ import defaultAuthorizationProvider from "./default-authorization-provider"
2
+ import type { AuthorizationConfig } from "./types"
3
+
4
+ export const authorizationConfig: AuthorizationConfig = {
5
+ fallbackUrl: "/not-found",
6
+ useMiddleware: true,
7
+ provider: defaultAuthorizationProvider,
8
+ }
9
+
10
+ /** 初始化/覆盖 authorization 配置(与 auth 的 setAppAuthConfig 对齐) */
11
+ export const setAppAuthorizationConfig = (config: Partial<AuthorizationConfig>) => {
12
+ Object.assign(authorizationConfig, config)
13
+ }
@@ -0,0 +1,116 @@
1
+ "use client"
2
+
3
+ import {
4
+ createContext,
5
+ useCallback,
6
+ useContext,
7
+ useEffect,
8
+ useMemo,
9
+ useState,
10
+ type ReactNode,
11
+ } from "react"
12
+ import { authorizationConfig } from "./authorization-config"
13
+ import type { AuthorizationState, PermissionSet } from "./types"
14
+ import { normalizePermissions } from "./authorization-client-middleware"
15
+ import { appAuth } from "../auth"
16
+
17
+ const AuthorizationContext = createContext<{
18
+ state: AuthorizationState
19
+ } | null>(null)
20
+
21
+ export function AuthorizationProvider({
22
+ children,
23
+ }: {
24
+ children: ReactNode
25
+ }) {
26
+ const result = appAuth.check()
27
+ const isAuthenticated = result.isAuthenticated ?? false
28
+
29
+ const provider = authorizationConfig.provider!
30
+
31
+ const [data, setData] = useState<PermissionSet | null>(null)
32
+ const [isLoading, setIsLoading] = useState(false)
33
+
34
+ const load = useCallback(
35
+ async () => {
36
+ if (!isAuthenticated) {
37
+ setData(null)
38
+ setIsLoading(false)
39
+ return
40
+ }
41
+
42
+ setIsLoading(true)
43
+ try {
44
+ const { permissionPoints } = await provider.getPermissions()
45
+ setData(permissionPoints)
46
+ } catch {
47
+ setData(null)
48
+ } finally {
49
+ setIsLoading(false)
50
+ }
51
+ },
52
+ [isAuthenticated, provider]
53
+ )
54
+
55
+ // Login/logout/provider-change => refresh permissions
56
+ useEffect(() => {
57
+ if (!isAuthenticated) {
58
+ setData(null)
59
+ setIsLoading(false)
60
+ return
61
+ }
62
+ void load()
63
+ }, [isAuthenticated, provider, load])
64
+
65
+ const state: AuthorizationState = useMemo(
66
+ () => ({
67
+ permissions: normalizePermissions(data),
68
+ isLoading,
69
+ }),
70
+ [data, isLoading]
71
+ )
72
+
73
+ const value = useMemo(
74
+ () => ({
75
+ state,
76
+ }),
77
+ [state]
78
+ )
79
+
80
+ return (
81
+ <AuthorizationContext.Provider value={value}>
82
+ {isAuthenticated && state.isLoading ? (
83
+ <div className="flex min-h-screen items-center justify-center bg-background">
84
+ <span className="inline-flex h-6 w-6 animate-spin rounded-full border-2 border-muted border-t-primary" />
85
+ </div>
86
+ ) : (
87
+ children
88
+ )}
89
+ </AuthorizationContext.Provider>
90
+ )
91
+ }
92
+
93
+ export function useAuthorizationContext() {
94
+ const ctx = useContext(AuthorizationContext)
95
+ if (!ctx) throw new Error("useAuthorizationContext must be used within AuthorizationProvider")
96
+ return ctx
97
+ }
98
+
99
+ /** Single-key authz check (returns boolean). */
100
+ export function useAuthorization(key: string): boolean {
101
+ const { state } = useAuthorizationContext()
102
+ if (state.isLoading) return false
103
+ return state.permissions.set.has(key)
104
+ }
105
+
106
+ /** Bulk/imperative checker for loops and filters. */
107
+ export function useAuthorizationChecker() {
108
+ const { state } = useAuthorizationContext()
109
+ return useCallback(
110
+ (key: string) => {
111
+ if (state.isLoading) return false
112
+ return state.permissions.set.has(key)
113
+ },
114
+ [state.isLoading, state.permissions.set]
115
+ )
116
+ }
@@ -0,0 +1,26 @@
1
+ import { promiseResultCache } from "../utils/promise-result-cache"
2
+ import type {
3
+ AuthorizationProviderConfig,
4
+ } from "./types"
5
+
6
+ const PERMISSIONS_CACHE_KEY = "authorization/permissions"
7
+
8
+ /**
9
+ * Default authorization provider:
10
+ * - caches permissions in-memory (promiseCache)
11
+ * - replace getPermissions with real API call in production
12
+ */
13
+ const defaultAuthorizationProvider: AuthorizationProviderConfig = {
14
+ getPermissions: async () => {
15
+ return promiseResultCache(PERMISSIONS_CACHE_KEY, async () => {
16
+ // 返回菜单树、授权控制点列表
17
+ return {
18
+ permissionPoints: [],
19
+ menuTree: [],
20
+ }
21
+ })
22
+ }
23
+ }
24
+
25
+ export { PERMISSIONS_CACHE_KEY }
26
+ export default defaultAuthorizationProvider
@@ -0,0 +1,15 @@
1
+ export {
2
+ AuthorizationProvider,
3
+ useAuthorization,
4
+ useAuthorizationChecker,
5
+ useAuthorizationContext,
6
+ } from "./authorization-provider"
7
+
8
+ export { setAppAuthorizationConfig } from "./authorization-config"
9
+ export { createAuthorizationClientMiddleware } from "./authorization-client-middleware"
10
+ export type {
11
+ PermissionKey,
12
+ PermissionSet,
13
+ AuthorizationProviderConfig,
14
+ AuthorizationConfig,
15
+ } from "./types"
@@ -0,0 +1,42 @@
1
+ export type PermissionKey = string
2
+
3
+ export type PermissionSet = PermissionKey[] | Record<PermissionKey, boolean>
4
+
5
+ export type PermissionResult = {
6
+ permissionPoints: PermissionSet
7
+ menuTree: PermissionMenuItem[]
8
+ }
9
+
10
+ export type PermissionMenuItem = {
11
+ id: string
12
+ label: string
13
+ icon?: string,
14
+ path?: string
15
+ children?: PermissionMenuItem[]
16
+ }
17
+
18
+ export type AuthorizationProviderConfig = {
19
+ /** Fetch current user's permissions */
20
+ getPermissions: () => Promise<PermissionResult>
21
+ onError?: (
22
+ error: Error & { statusCode?: number }
23
+ ) => Promise<{ logout?: boolean; redirectTo?: string } | void>
24
+ }
25
+
26
+ export type AuthorizationConfig = {
27
+ /** 无权限时重定向地址(middleware 使用) */
28
+ fallbackUrl?: string
29
+ /** 是否启用授权 middleware */
30
+ useMiddleware?: boolean
31
+ provider?: AuthorizationProviderConfig
32
+ }
33
+
34
+
35
+ export type NormalizedPermissions = {
36
+ set: Set<string>
37
+ }
38
+
39
+ export type AuthorizationState = {
40
+ permissions: NormalizedPermissions
41
+ isLoading: boolean
42
+ }
@@ -0,0 +1,3 @@
1
+ export * from "./auth"
2
+ export * from "./authorization"
3
+ export * from './utils/promise-result-cache'
@@ -0,0 +1,18 @@
1
+ const cache = new Map<string, unknown>()
2
+
3
+ export async function promiseResultCache<T>(key: string, fn: () => Promise<T>): Promise<T> {
4
+ if (cache.has(key)) {
5
+ return cache.get(key) as T
6
+ }
7
+ const result = await fn()
8
+ cache.set(key, result)
9
+ return result
10
+ }
11
+
12
+ export function promiseResultCacheClear(key: string) {
13
+ cache.delete(key)
14
+ }
15
+
16
+ export function promiseResultCacheClearAll() {
17
+ cache.clear()
18
+ }
@@ -0,0 +1,19 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "ES2020",
4
+ "lib": ["DOM", "DOM.Iterable", "ESNext"],
5
+ "module": "ESNext",
6
+ "moduleResolution": "bundler",
7
+ "strict": true,
8
+ "jsx": "react-jsx",
9
+ "skipLibCheck": true,
10
+ "resolveJsonModule": true,
11
+ "noEmit": true,
12
+ "baseUrl": ".",
13
+ "paths": {
14
+ "@/*": ["./src/*"]
15
+ }
16
+ },
17
+ "include": ["src"],
18
+ "exclude": ["node_modules"]
19
+ }
@@ -0,0 +1,56 @@
1
+ # @scaffold/mobile
2
+
3
+ 移动端 H5 应用,Vite + React + 路由 + 鉴权。
4
+
5
+ ## 工程目录(最佳实践)
6
+
7
+ ```
8
+ src/
9
+ ├── app/ # 应用入口与全局样式
10
+ │ └── globals.css
11
+ ├── components/ # 可复用 UI 组件
12
+ │ └── LoginForm.tsx
13
+ ├── hooks/ # 自定义 Hooks
14
+ │ └── index.ts
15
+ ├── lib/ # 工具函数与通用逻辑
16
+ │ └── utils.ts
17
+ ├── pages/ # 页面级组件(按路由对应)
18
+ │ ├── index.ts
19
+ │ ├── LoginPage.tsx
20
+ │ └── HomePage.tsx
21
+ ├── routes/ # 路由配置与守卫
22
+ │ ├── index.tsx # 路由表与 Router
23
+ │ ├── routes.ts # 路径常量
24
+ │ └── ProtectedRoute.tsx
25
+ ├── types/ # 全局类型
26
+ │ └── index.ts
27
+ ├── App.tsx
28
+ ├── main.tsx
29
+ └── vite-env.d.ts
30
+ ```
31
+
32
+ ## 路由
33
+
34
+ | 路径 | 说明 | 鉴权 |
35
+ |----------|----------|--------|
36
+ | `/login` | 登录页 | 已登录则跳转首页 |
37
+ | `/` | 主页 | 需登录,未登录跳转登录 |
38
+
39
+ 登录成功后跳转到主页;访问未定义路径时重定向到 `/`。
40
+
41
+ ## 开发
42
+
43
+ ```bash
44
+ pnpm dev # 开发服务器 http://localhost:3002
45
+ pnpm build # 构建
46
+ pnpm preview # 预览构建结果
47
+ ```
48
+
49
+ ## 环境变量
50
+
51
+ - **VITE_API_URL**: 后端 API Base URL(可选)。不配置时默认使用 `http://localhost:3001`(对应 scaffold/api 默认端口)。
52
+
53
+ ## 依赖
54
+
55
+ - `@scaffold/core`:鉴权(与 admin 一致:appAuth + createBackendAuthProvider)
56
+ - `react-router-dom`:路由
@@ -0,0 +1,13 @@
1
+ <!DOCTYPE html>
2
+ <html lang="zh-CN">
3
+ <head>
4
+ <meta charset="UTF-8" />
5
+ <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
6
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
7
+ <title>AIKO-BOOT</title>
8
+ </head>
9
+ <body>
10
+ <div id="root"></div>
11
+ <script type="module" src="/src/main.tsx"></script>
12
+ </body>
13
+ </html>
@@ -0,0 +1,28 @@
1
+ {
2
+ "name": "@scaffold/mobile",
3
+ "version": "0.1.0",
4
+ "private": true,
5
+ "type": "module",
6
+ "scripts": {
7
+ "dev": "vite --port 3002",
8
+ "build": "tsc --noEmit && vite build",
9
+ "preview": "vite preview",
10
+ "lint": "eslint src"
11
+ },
12
+ "dependencies": {
13
+ "@scaffold/core": "workspace:*",
14
+ "react": "19.1.0",
15
+ "react-dom": "19.1.0",
16
+ "react-router-dom": "^7.6.0"
17
+ },
18
+ "devDependencies": {
19
+ "@tailwindcss/postcss": "^4.1.4",
20
+ "@types/node": "^20",
21
+ "@types/react": "^19.1.0",
22
+ "@types/react-dom": "^19.1.0",
23
+ "@vitejs/plugin-react": "^4.4.1",
24
+ "tailwindcss": "^4.1.4",
25
+ "typescript": "^5.8.3",
26
+ "vite": "^6.3.5"
27
+ }
28
+ }
@@ -0,0 +1,7 @@
1
+ const config = {
2
+ plugins: {
3
+ '@tailwindcss/postcss': {},
4
+ },
5
+ };
6
+
7
+ export default config;
@@ -0,0 +1,5 @@
1
+ import { AppRouter } from '@/routes';
2
+
3
+ export default function App() {
4
+ return <AppRouter />;
5
+ }
@@ -0,0 +1 @@
1
+ @import "tailwindcss";