@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.
- package/README.md +187 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +30 -0
- package/dist/commands/add-api.d.ts +5 -0
- package/dist/commands/add-api.js +34 -0
- package/dist/commands/add-app.d.ts +5 -0
- package/dist/commands/add-app.js +34 -0
- package/dist/commands/add-feature.d.ts +5 -0
- package/dist/commands/add-feature.js +32 -0
- package/dist/commands/init.d.ts +7 -0
- package/dist/commands/init.js +42 -0
- package/dist/commands/list.d.ts +6 -0
- package/dist/commands/list.js +36 -0
- package/dist/core/framework-version.d.ts +8 -0
- package/dist/core/framework-version.js +40 -0
- package/dist/core/logger.d.ts +6 -0
- package/dist/core/logger.js +16 -0
- package/dist/core/project-config.d.ts +21 -0
- package/dist/core/project-config.js +17 -0
- package/dist/core/prompts.d.ts +5 -0
- package/dist/core/prompts.js +43 -0
- package/dist/core/template-utils.d.ts +1 -0
- package/dist/core/template-utils.js +42 -0
- package/dist/core/workspace.d.ts +10 -0
- package/dist/core/workspace.js +141 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2 -0
- package/dist/scaffold.d.ts +7 -0
- package/dist/scaffold.js +272 -0
- package/dist/usecases/add-api.usecase.d.ts +16 -0
- package/dist/usecases/add-api.usecase.js +87 -0
- package/dist/usecases/add-app.usecase.d.ts +16 -0
- package/dist/usecases/add-app.usecase.js +101 -0
- package/dist/usecases/add-feature.usecase.d.ts +15 -0
- package/dist/usecases/add-feature.usecase.js +566 -0
- package/dist/usecases/init-scaffold.usecase.d.ts +19 -0
- package/dist/usecases/init-scaffold.usecase.js +131 -0
- package/package.json +43 -0
- package/templates/api-base/app.config.ts +155 -0
- package/templates/api-base/package.json +55 -0
- package/templates/api-base/scripts/codegen.cjs +30 -0
- package/templates/api-base/scripts/codegen.ts +10 -0
- package/templates/api-base/src/controller/auth.controller.ts +160 -0
- package/templates/api-base/src/controller/menu.controller.ts +56 -0
- package/templates/api-base/src/controller/role.controller.ts +62 -0
- package/templates/api-base/src/controller/user.controller.ts +75 -0
- package/templates/api-base/src/dto/auth.dto.ts +31 -0
- package/templates/api-base/src/dto/menu.dto.ts +38 -0
- package/templates/api-base/src/dto/role.dto.ts +18 -0
- package/templates/api-base/src/dto/user.dto.ts +36 -0
- package/templates/api-base/src/entity/menu.entity.ts +35 -0
- package/templates/api-base/src/entity/role-menu.entity.ts +14 -0
- package/templates/api-base/src/entity/role.entity.ts +23 -0
- package/templates/api-base/src/entity/user-role.entity.ts +14 -0
- package/templates/api-base/src/entity/user.entity.ts +32 -0
- package/templates/api-base/src/mapper/menu.mapper.ts +7 -0
- package/templates/api-base/src/mapper/role-menu.mapper.ts +7 -0
- package/templates/api-base/src/mapper/role.mapper.ts +7 -0
- package/templates/api-base/src/mapper/user-role.mapper.ts +7 -0
- package/templates/api-base/src/mapper/user.mapper.ts +12 -0
- package/templates/api-base/src/scripts/init-db.ts +204 -0
- package/templates/api-base/src/server.ts +69 -0
- package/templates/api-base/src/service/auth.service.ts +144 -0
- package/templates/api-base/src/service/log.request.service.ts +72 -0
- package/templates/api-base/src/service/menu.service.ts +94 -0
- package/templates/api-base/src/service/role.service.ts +88 -0
- package/templates/api-base/src/service/user.service.ts +175 -0
- package/templates/api-base/src/utils/jwt.util.ts +39 -0
- package/templates/api-base/tsconfig.json +18 -0
- package/templates/feature-file/api/upload.controller.ts +97 -0
- package/templates/feature-log/api/docs/log-integration-guide.md +54 -0
- package/templates/feature-log/api/src/service/log.request.service.ts +112 -0
- package/templates/feature-log/api/src/service/log.service.ts +124 -0
- package/templates/feature-mq/api/src/controller/mq.controller.ts +35 -0
- package/templates/feature-mq/api/src/dto/mq.dto.ts +16 -0
- package/templates/feature-mq/api/src/service/mq.consumer.service.ts +26 -0
- package/templates/feature-redis/api/src/controller/cache.controller.ts +107 -0
- package/templates/feature-redis/api/src/dto/cache.dto.ts +24 -0
- package/templates/feature-redis/api/src/service/cache.service.ts +80 -0
- package/templates/scaffold-default/README.md +114 -0
- package/templates/scaffold-default/package.json +26 -0
- package/templates/scaffold-default/packages/admin/.env.dev +1 -0
- package/templates/scaffold-default/packages/admin/.env.prod +4 -0
- package/templates/scaffold-default/packages/admin/.env.stage +4 -0
- package/templates/scaffold-default/packages/admin/Dockerfile +37 -0
- package/templates/scaffold-default/packages/admin/README.MD +27 -0
- package/templates/scaffold-default/packages/admin/components.json +21 -0
- package/templates/scaffold-default/packages/admin/eslint.config.js +28 -0
- package/templates/scaffold-default/packages/admin/index.html +50 -0
- package/templates/scaffold-default/packages/admin/package.json +100 -0
- package/templates/scaffold-default/packages/admin/public/vite.svg +1 -0
- package/templates/scaffold-default/packages/admin/src/App.css +82 -0
- package/templates/scaffold-default/packages/admin/src/App.tsx +128 -0
- package/templates/scaffold-default/packages/admin/src/app.config.ts +3 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/data-table/data-table-pagination.tsx +148 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/data-table/data-table-sorter.tsx +50 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/data-table/index.tsx +266 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/editable-table.tsx +292 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/form/input-password.tsx +38 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/form/sign-in-form.tsx +118 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/error-component.tsx +71 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/header.tsx +162 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/language-switcher.tsx +47 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/layout.tsx +42 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/loading-overlay.tsx +36 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/shell-bar.tsx +232 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/sidebar.tsx +193 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/layout/user-avatar.tsx +31 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/list-report.tsx +306 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/master-detail.tsx +382 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/notification/toaster.tsx +23 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/notification/undoable-notification.tsx +84 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/object-page.tsx +539 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/theme/theme-provider.tsx +160 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/theme/theme-select.tsx +129 -0
- package/templates/scaffold-default/packages/admin/src/components/admin-ui/theme/theme-toggle.tsx +90 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/accordion.tsx +64 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/alert-dialog.tsx +157 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/alert.tsx +66 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/aspect-ratio.tsx +9 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/avatar.tsx +53 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/badge.tsx +47 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/breadcrumb.tsx +111 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/button.tsx +59 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/calendar.tsx +74 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/card.tsx +92 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/carousel.tsx +237 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/chart.tsx +351 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/checkbox.tsx +32 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/collapsible.tsx +33 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/command.tsx +182 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/context-menu.tsx +252 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/dialog.tsx +141 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/drawer.tsx +130 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/dropdown-menu.tsx +255 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/form.tsx +166 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/hover-card.tsx +42 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/input-otp.tsx +77 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/input.tsx +21 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/label.tsx +22 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/menubar.tsx +274 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/navigation-menu.tsx +168 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/pagination.tsx +127 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/popover.tsx +48 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/progress.tsx +29 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/radio-group.tsx +45 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/resizable.tsx +54 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/scroll-area.tsx +58 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/select.tsx +183 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/separator.tsx +26 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/sheet.tsx +139 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/sidebar.tsx +740 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/skeleton.tsx +13 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/slider.tsx +63 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/sonner.tsx +23 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/switch.tsx +31 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/table.tsx +114 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/tabs.tsx +66 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/textarea.tsx +18 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/toggle-group.tsx +73 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/toggle.tsx +45 -0
- package/templates/scaffold-default/packages/admin/src/components/ui/tooltip.tsx +59 -0
- package/templates/scaffold-default/packages/admin/src/hooks/use-mobile.ts +21 -0
- package/templates/scaffold-default/packages/admin/src/i18n.ts +20 -0
- package/templates/scaffold-default/packages/admin/src/index.tsx +19 -0
- package/templates/scaffold-default/packages/admin/src/layouts/menu-layout.tsx +211 -0
- package/templates/scaffold-default/packages/admin/src/layouts/tile-layout.tsx +355 -0
- package/templates/scaffold-default/packages/admin/src/lib/utils.ts +6 -0
- package/templates/scaffold-default/packages/admin/src/locales/en.json +68 -0
- package/templates/scaffold-default/packages/admin/src/locales/zh.json +68 -0
- package/templates/scaffold-default/packages/admin/src/pages/dashboard.tsx +12 -0
- package/templates/scaffold-default/packages/admin/src/pages/goods-receipt/CreatePage.tsx +302 -0
- package/templates/scaffold-default/packages/admin/src/pages/goods-receipt/EditPage.tsx +221 -0
- package/templates/scaffold-default/packages/admin/src/pages/goods-receipt/ListPage.tsx +283 -0
- package/templates/scaffold-default/packages/admin/src/pages/goods-receipt/ViewPage.tsx +280 -0
- package/templates/scaffold-default/packages/admin/src/pages/goods-receipt/index.ts +4 -0
- package/templates/scaffold-default/packages/admin/src/pages/home-page.tsx +244 -0
- package/templates/scaffold-default/packages/admin/src/pages/master-data/cost-centers/index.tsx +461 -0
- package/templates/scaffold-default/packages/admin/src/pages/master-data/currencies/index.tsx +255 -0
- package/templates/scaffold-default/packages/admin/src/pages/master-data/materials/ListPage.tsx +271 -0
- package/templates/scaffold-default/packages/admin/src/pages/master-data/materials/ViewPage.tsx +240 -0
- package/templates/scaffold-default/packages/admin/src/pages/master-data/materials/index.ts +2 -0
- package/templates/scaffold-default/packages/admin/src/pages/master-data/plants/ListPage.tsx +279 -0
- package/templates/scaffold-default/packages/admin/src/pages/master-data/plants/ViewPage.tsx +380 -0
- package/templates/scaffold-default/packages/admin/src/pages/master-data/plants/index.ts +2 -0
- package/templates/scaffold-default/packages/admin/src/pages/master-data/purchase-organizations/index.tsx +341 -0
- package/templates/scaffold-default/packages/admin/src/pages/master-data/units-of-measure/index.tsx +295 -0
- package/templates/scaffold-default/packages/admin/src/pages/master-data/vendors/ListPage.tsx +266 -0
- package/templates/scaffold-default/packages/admin/src/pages/master-data/vendors/ViewPage.tsx +274 -0
- package/templates/scaffold-default/packages/admin/src/pages/master-data/vendors/index.ts +2 -0
- package/templates/scaffold-default/packages/admin/src/pages/placeholder-page.tsx +13 -0
- package/templates/scaffold-default/packages/admin/src/pages/purchase-orders/ListPage.tsx +289 -0
- package/templates/scaffold-default/packages/admin/src/pages/purchase-orders/ViewPage.tsx +343 -0
- package/templates/scaffold-default/packages/admin/src/pages/purchase-orders/index.ts +2 -0
- package/templates/scaffold-default/packages/admin/src/pages/purchase-requisitions/CreatePage.tsx +398 -0
- package/templates/scaffold-default/packages/admin/src/pages/purchase-requisitions/EditPage.tsx +473 -0
- package/templates/scaffold-default/packages/admin/src/pages/purchase-requisitions/ListPage.tsx +307 -0
- package/templates/scaffold-default/packages/admin/src/pages/purchase-requisitions/ViewPage.tsx +304 -0
- package/templates/scaffold-default/packages/admin/src/pages/purchase-requisitions/constants.ts +51 -0
- package/templates/scaffold-default/packages/admin/src/pages/purchase-requisitions/index.ts +4 -0
- package/templates/scaffold-default/packages/admin/src/pages/reports/PurchaseOrderReport.tsx +312 -0
- package/templates/scaffold-default/packages/admin/src/pages/reports/PurchaseRequisitionReport.tsx +303 -0
- package/templates/scaffold-default/packages/admin/src/pages/reports/index.ts +2 -0
- package/templates/scaffold-default/packages/admin/src/pages/settings-page.tsx +335 -0
- package/templates/scaffold-default/packages/admin/src/providers/app-config.tsx +50 -0
- package/templates/scaffold-default/packages/admin/src/providers/auth-provider.ts +2 -0
- package/templates/scaffold-default/packages/admin/src/routes/auth.ts +9 -0
- package/templates/scaffold-default/packages/admin/src/routes/index.ts +85 -0
- package/templates/scaffold-default/packages/admin/src/routes/menu.ts +176 -0
- package/templates/scaffold-default/packages/admin/src/routes/modules/goods-receipt.ts +31 -0
- package/templates/scaffold-default/packages/admin/src/routes/modules/master-data.ts +41 -0
- package/templates/scaffold-default/packages/admin/src/routes/modules/purchase-orders.ts +27 -0
- package/templates/scaffold-default/packages/admin/src/routes/modules/purchase-requisitions.ts +39 -0
- package/templates/scaffold-default/packages/admin/src/routes/modules/reports.ts +33 -0
- package/templates/scaffold-default/packages/admin/src/routes/modules/settings.ts +19 -0
- package/templates/scaffold-default/packages/admin/src/routes/withSuspense.tsx +21 -0
- package/templates/scaffold-default/packages/admin/src/theme/amber.css +27 -0
- package/templates/scaffold-default/packages/admin/src/theme/blue.css +27 -0
- package/templates/scaffold-default/packages/admin/src/theme/default.css +75 -0
- package/templates/scaffold-default/packages/admin/src/theme/fiori.css +180 -0
- package/templates/scaffold-default/packages/admin/src/theme/green.css +27 -0
- package/templates/scaffold-default/packages/admin/src/theme/index.css +12 -0
- package/templates/scaffold-default/packages/admin/src/theme/rose.css +27 -0
- package/templates/scaffold-default/packages/admin/src/theme/violet.css +27 -0
- package/templates/scaffold-default/packages/admin/src/vite-env.d.ts +1 -0
- package/templates/scaffold-default/packages/admin/tsconfig.json +28 -0
- package/templates/scaffold-default/packages/admin/tsconfig.node.json +21 -0
- package/templates/scaffold-default/packages/admin/vite.config.ts +26 -0
- package/templates/scaffold-default/packages/api/.eslintrc.json +6 -0
- package/templates/scaffold-default/packages/api/.swcrc +17 -0
- package/templates/scaffold-default/packages/api/app.config.ts +163 -0
- package/templates/scaffold-default/packages/api/docs/api-document.md +497 -0
- package/templates/scaffold-default/packages/api/docs/final-completion-report.md +565 -0
- package/templates/scaffold-default/packages/api/docs/permission-integration-summary.md +432 -0
- package/templates/scaffold-default/packages/api/examples/security/README.md +664 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/.env.example +26 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/PROJECT_STRUCTURE.md +220 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/README.md +847 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/app.config.ts +69 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/app.ts +63 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/controller/auth.controller.ts +131 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/controller/index.ts +4 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/controller/permission.controller.ts +41 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/controller/role.controller.ts +53 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/controller/user.controller.ts +53 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/dto/change-password.dto.ts +10 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/dto/create-permission.dto.ts +14 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/dto/create-role.dto.ts +11 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/dto/create-user.dto.ts +15 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/dto/index.ts +7 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/dto/login.dto.ts +10 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/dto/oauth-profile.dto.ts +7 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/dto/register.dto.ts +17 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/entity/index.ts +6 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/entity/oauth-account.entity.ts +39 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/entity/permission.entity.ts +31 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/entity/role-permission.entity.ts +19 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/entity/role.entity.ts +25 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/entity/user-role.entity.ts +19 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/entity/user.entity.ts +46 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/init.sql +81 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/middleware/auth.interceptor.ts +39 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/middleware/index.ts +2 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/middleware/permission.interceptor.ts +61 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/package.json +54 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/seed.sql +42 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/service/auth.service.ts +41 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/service/index.ts +5 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/service/oauth.service.ts +82 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/service/permission.service.ts +113 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/service/role.service.ts +85 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/service/user.service.ts +132 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/TEST_REPORT.md +318 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/generate-report.js +335 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/helpers/api-helpers.ts +116 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/helpers/index.ts +2 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/helpers/test-helpers.ts +129 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/integration/auth.api.test.ts +429 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/integration/role.api.test.ts +400 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/integration/user.api.test.ts +459 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/jest.config.js +40 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/run-all-tests.js +135 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/run-tests.js +109 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/setup.ts +19 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/unit/auth.service.test.ts +199 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/unit/permission.service.test.ts +377 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tests/unit/user.service.test.ts +288 -0
- package/templates/scaffold-default/packages/api/examples/security/complete/tsconfig.json +35 -0
- package/templates/scaffold-default/packages/api/examples/security/jwt/README.md +424 -0
- package/templates/scaffold-default/packages/api/examples/security/local/README.md +499 -0
- package/templates/scaffold-default/packages/api/examples/security/oauth2/README.md +637 -0
- package/templates/scaffold-default/packages/api/examples/security/permission/README.md +943 -0
- package/templates/scaffold-default/packages/api/examples/security/session/README.md +753 -0
- package/templates/scaffold-default/packages/api/package.json +63 -0
- package/templates/scaffold-default/packages/api/scripts/codegen.cjs +29 -0
- package/templates/scaffold-default/packages/api/scripts/codegen.ts +9 -0
- package/templates/scaffold-default/packages/api/src/config/security-auto-configuration.ts +75 -0
- package/templates/scaffold-default/packages/api/src/controller/auth.controller.ts +109 -0
- package/templates/scaffold-default/packages/api/src/controller/cache.controller.ts +106 -0
- package/templates/scaffold-default/packages/api/src/controller/menu.controller.ts +86 -0
- package/templates/scaffold-default/packages/api/src/controller/mq.controller.ts +35 -0
- package/templates/scaffold-default/packages/api/src/controller/role.controller.ts +100 -0
- package/templates/scaffold-default/packages/api/src/controller/upload.controller.ts +83 -0
- package/templates/scaffold-default/packages/api/src/controller/user.controller.ts +102 -0
- package/templates/scaffold-default/packages/api/src/dto/auth.dto.ts +30 -0
- package/templates/scaffold-default/packages/api/src/dto/cache.dto.ts +24 -0
- package/templates/scaffold-default/packages/api/src/dto/menu.dto.ts +37 -0
- package/templates/scaffold-default/packages/api/src/dto/mq.dto.ts +16 -0
- package/templates/scaffold-default/packages/api/src/dto/role.dto.ts +16 -0
- package/templates/scaffold-default/packages/api/src/dto/user.dto.ts +35 -0
- package/templates/scaffold-default/packages/api/src/entity/menu.entity.ts +34 -0
- package/templates/scaffold-default/packages/api/src/entity/role-menu.entity.ts +13 -0
- package/templates/scaffold-default/packages/api/src/entity/role.entity.ts +22 -0
- package/templates/scaffold-default/packages/api/src/entity/user-role.entity.ts +13 -0
- package/templates/scaffold-default/packages/api/src/entity/user.entity.ts +31 -0
- package/templates/scaffold-default/packages/api/src/mapper/menu.mapper.ts +6 -0
- package/templates/scaffold-default/packages/api/src/mapper/role-menu.mapper.ts +6 -0
- package/templates/scaffold-default/packages/api/src/mapper/role.mapper.ts +6 -0
- package/templates/scaffold-default/packages/api/src/mapper/user-role.mapper.ts +6 -0
- package/templates/scaffold-default/packages/api/src/mapper/user.mapper.ts +11 -0
- package/templates/scaffold-default/packages/api/src/scripts/assign-role.ts +41 -0
- package/templates/scaffold-default/packages/api/src/scripts/check-user-role.ts +28 -0
- package/templates/scaffold-default/packages/api/src/scripts/check-users.mjs +44 -0
- package/templates/scaffold-default/packages/api/src/scripts/demo-permissions.mjs +418 -0
- package/templates/scaffold-default/packages/api/src/scripts/init-db.ts +166 -0
- package/templates/scaffold-default/packages/api/src/scripts/reset-admin-password.mjs +70 -0
- package/templates/scaffold-default/packages/api/src/scripts/reset-password.ts +31 -0
- package/templates/scaffold-default/packages/api/src/scripts/simple-reset-admin.mjs +39 -0
- package/templates/scaffold-default/packages/api/src/scripts/test-db.ts +36 -0
- package/templates/scaffold-default/packages/api/src/scripts/test-di.ts +45 -0
- package/templates/scaffold-default/packages/api/src/scripts/test-permissions.mjs +551 -0
- package/templates/scaffold-default/packages/api/src/scripts/update-admin-password.mjs +56 -0
- package/templates/scaffold-default/packages/api/src/scripts/user-roles.ts +28 -0
- package/templates/scaffold-default/packages/api/src/server.ts +38 -0
- package/templates/scaffold-default/packages/api/src/service/auth.service.ts +165 -0
- package/templates/scaffold-default/packages/api/src/service/cache.service.ts +80 -0
- package/templates/scaffold-default/packages/api/src/service/log.request.service.ts +158 -0
- package/templates/scaffold-default/packages/api/src/service/log.service.ts +123 -0
- package/templates/scaffold-default/packages/api/src/service/menu.service.ts +94 -0
- package/templates/scaffold-default/packages/api/src/service/mq.consumer.service.ts +26 -0
- package/templates/scaffold-default/packages/api/src/service/role.service.ts +88 -0
- package/templates/scaffold-default/packages/api/src/service/user.service.ts +195 -0
- package/templates/scaffold-default/packages/api/src/types/sqljs.d.ts +18 -0
- package/templates/scaffold-default/packages/api/src/utils/auth.utils.js +0 -0
- package/templates/scaffold-default/packages/api/src/utils/jwt.util.ts +29 -0
- package/templates/scaffold-default/packages/api/tsconfig.json +17 -0
- package/templates/scaffold-default/packages/api/tsup.config.ts +14 -0
- package/templates/scaffold-default/packages/api/uploads/.gitkeep +0 -0
- package/templates/scaffold-default/packages/core/package.json +28 -0
- package/templates/scaffold-default/packages/core/src/auth/auth-client-middleware.ts +22 -0
- package/templates/scaffold-default/packages/core/src/auth/auth-constants.ts +6 -0
- package/templates/scaffold-default/packages/core/src/auth/auth-service.ts +65 -0
- package/templates/scaffold-default/packages/core/src/auth/backend-auth-provider.ts +149 -0
- package/templates/scaffold-default/packages/core/src/auth/default-auth-provider.ts +38 -0
- package/templates/scaffold-default/packages/core/src/auth/index.ts +12 -0
- package/templates/scaffold-default/packages/core/src/auth/types.ts +38 -0
- package/templates/scaffold-default/packages/core/src/authorization/authorization-client-middleware.ts +38 -0
- package/templates/scaffold-default/packages/core/src/authorization/authorization-config.ts +13 -0
- package/templates/scaffold-default/packages/core/src/authorization/authorization-provider.tsx +116 -0
- package/templates/scaffold-default/packages/core/src/authorization/default-authorization-provider.ts +26 -0
- package/templates/scaffold-default/packages/core/src/authorization/index.ts +15 -0
- package/templates/scaffold-default/packages/core/src/authorization/types.ts +42 -0
- package/templates/scaffold-default/packages/core/src/index.ts +3 -0
- package/templates/scaffold-default/packages/core/src/utils/promise-result-cache.ts +18 -0
- package/templates/scaffold-default/packages/core/tsconfig.json +19 -0
- package/templates/scaffold-default/packages/mobile/README.md +56 -0
- package/templates/scaffold-default/packages/mobile/index.html +13 -0
- package/templates/scaffold-default/packages/mobile/package.json +28 -0
- package/templates/scaffold-default/packages/mobile/postcss.config.mjs +7 -0
- package/templates/scaffold-default/packages/mobile/src/App.tsx +5 -0
- package/templates/scaffold-default/packages/mobile/src/app/globals.css +1 -0
- package/templates/scaffold-default/packages/mobile/src/components/LoginForm.tsx +83 -0
- package/templates/scaffold-default/packages/mobile/src/hooks/index.ts +5 -0
- package/templates/scaffold-default/packages/mobile/src/lib/utils.ts +7 -0
- package/templates/scaffold-default/packages/mobile/src/main.tsx +19 -0
- package/templates/scaffold-default/packages/mobile/src/pages/HomePage.tsx +41 -0
- package/templates/scaffold-default/packages/mobile/src/pages/LoginPage.tsx +24 -0
- package/templates/scaffold-default/packages/mobile/src/pages/index.ts +2 -0
- package/templates/scaffold-default/packages/mobile/src/routes/ProtectedRoute.tsx +35 -0
- package/templates/scaffold-default/packages/mobile/src/routes/index.tsx +24 -0
- package/templates/scaffold-default/packages/mobile/src/routes/routes.ts +11 -0
- package/templates/scaffold-default/packages/mobile/src/types/index.ts +5 -0
- package/templates/scaffold-default/packages/mobile/src/vite-env.d.ts +1 -0
- package/templates/scaffold-default/packages/mobile/tsconfig.json +23 -0
- package/templates/scaffold-default/packages/mobile/tsconfig.node.json +11 -0
- package/templates/scaffold-default/packages/mobile/vite.config.ts +20 -0
- package/templates/scaffold-default/pnpm-workspace.yaml +2 -0
- package/templates/scaffold-default/scripts/postinstall.cjs +42 -0
- package/templates/scaffold-default/scripts/rebuild-sqlite.cjs +23 -0
|
@@ -0,0 +1,566 @@
|
|
|
1
|
+
import path from 'path';
|
|
2
|
+
import { fileURLToPath } from 'url';
|
|
3
|
+
import fs from 'fs-extra';
|
|
4
|
+
import { loadProjectConfig } from '../core/project-config.js';
|
|
5
|
+
import { syncRootPackageJson, withProjectConfig } from '../core/workspace.js';
|
|
6
|
+
// 在 ESM 环境中模拟 __dirname,兼容打包到 dist 后的运行时
|
|
7
|
+
const __filename = fileURLToPath(import.meta.url);
|
|
8
|
+
const __dirname = path.dirname(__filename);
|
|
9
|
+
export function createAddFeatureUseCase(deps) {
|
|
10
|
+
const { logger } = deps;
|
|
11
|
+
async function execute(input) {
|
|
12
|
+
const rootDir = input.rootDir ?? process.cwd();
|
|
13
|
+
const feature = input.feature;
|
|
14
|
+
if (input.dryRun) {
|
|
15
|
+
logger.info(`[dry-run] 将在 ${rootDir} 中为服务端 "${input.serviceName}" 增加特性:${feature}`);
|
|
16
|
+
return;
|
|
17
|
+
}
|
|
18
|
+
const config = await loadProjectConfig(rootDir);
|
|
19
|
+
if (!config) {
|
|
20
|
+
throw new Error('未找到 .aiko-boot.json,当前目录似乎不是脚手架根目录,请在 create 生成的根目录下执行。');
|
|
21
|
+
}
|
|
22
|
+
let apiDir;
|
|
23
|
+
const api = (config.apis ?? []).find((x) => x.name === input.serviceName);
|
|
24
|
+
if (api) {
|
|
25
|
+
// 从配置中读取路径
|
|
26
|
+
apiDir = path.join(rootDir, api.path);
|
|
27
|
+
}
|
|
28
|
+
else {
|
|
29
|
+
// 如果配置中没有,尝试从 packages/<serviceName> 推断
|
|
30
|
+
const candidateApiDir = path.join(rootDir, 'packages', input.serviceName);
|
|
31
|
+
if (await fs.pathExists(candidateApiDir)) {
|
|
32
|
+
logger.info(`未在 .aiko-boot.json 中找到 "${input.serviceName}" 配置,但检测到目录 ${candidateApiDir},将使用该目录。`);
|
|
33
|
+
apiDir = candidateApiDir;
|
|
34
|
+
}
|
|
35
|
+
else {
|
|
36
|
+
throw new Error(`未在 .aiko-boot.json 中找到名为 "${input.serviceName}" 的服务端配置,且未找到 packages/${input.serviceName} 目录。\n` +
|
|
37
|
+
`请先使用 "add-api ${input.serviceName}" 添加服务端,或手动在 .aiko-boot.json 中配置。`);
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
// 根据特性类型调用对应的处理函数
|
|
41
|
+
if (feature === 'file') {
|
|
42
|
+
await addFileFeatureToApi({
|
|
43
|
+
apiDir,
|
|
44
|
+
rootDir,
|
|
45
|
+
logger,
|
|
46
|
+
});
|
|
47
|
+
logger.info(`已为服务端 "${input.serviceName}" 启用 file 特性(本地存储 + 上传控制器)。`);
|
|
48
|
+
}
|
|
49
|
+
else if (feature === 'redis') {
|
|
50
|
+
await addRedisFeatureToApi({
|
|
51
|
+
apiDir,
|
|
52
|
+
rootDir,
|
|
53
|
+
logger,
|
|
54
|
+
});
|
|
55
|
+
logger.info(`已为服务端 "${input.serviceName}" 启用 redis 特性(缓存管理 + Redis 连接)。`);
|
|
56
|
+
}
|
|
57
|
+
else if (feature === 'mq') {
|
|
58
|
+
await addMqFeatureToApi({
|
|
59
|
+
apiDir,
|
|
60
|
+
rootDir,
|
|
61
|
+
logger,
|
|
62
|
+
});
|
|
63
|
+
logger.info(`已为服务端 "${input.serviceName}" 启用 mq 特性(消息队列 + 消费者服务)。`);
|
|
64
|
+
}
|
|
65
|
+
else if (feature === 'log') {
|
|
66
|
+
await addLogFeatureToApi({
|
|
67
|
+
apiDir,
|
|
68
|
+
rootDir,
|
|
69
|
+
logger,
|
|
70
|
+
});
|
|
71
|
+
logger.info(`已为服务端 "${input.serviceName}" 启用 log 特性(日志初始化 + HTTP 请求日志 + 错误日志)。`);
|
|
72
|
+
}
|
|
73
|
+
else {
|
|
74
|
+
logger.info(`TODO: 特性 "${feature}" 暂未实现,当前仅支持 feature=file(文件上传)、feature=redis(缓存管理)、feature=mq(消息队列)和 feature=log(日志)。`);
|
|
75
|
+
return;
|
|
76
|
+
}
|
|
77
|
+
// 更新 .aiko-boot.json 中的 features 数组
|
|
78
|
+
await withProjectConfig(rootDir, (cfg) => {
|
|
79
|
+
const apiConfig = cfg.apis?.find((x) => x.name === input.serviceName);
|
|
80
|
+
if (apiConfig) {
|
|
81
|
+
const features = apiConfig.features ?? [];
|
|
82
|
+
if (!features.includes(feature)) {
|
|
83
|
+
features.push(feature);
|
|
84
|
+
apiConfig.features = features;
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
});
|
|
88
|
+
// 特性添加完成后,同步根 package.json(保证 scripts 等信息最新)
|
|
89
|
+
await syncRootPackageJson(rootDir);
|
|
90
|
+
}
|
|
91
|
+
return { execute };
|
|
92
|
+
}
|
|
93
|
+
async function addFileFeatureToApi(ctx) {
|
|
94
|
+
const { apiDir, rootDir, logger } = ctx;
|
|
95
|
+
// 1) 更新 api package.json 依赖(storage starter + multer)
|
|
96
|
+
const pkgPath = path.join(apiDir, 'package.json');
|
|
97
|
+
if (!(await fs.pathExists(pkgPath))) {
|
|
98
|
+
throw new Error(`未找到 API package.json:${pkgPath}`);
|
|
99
|
+
}
|
|
100
|
+
const pkg = await fs.readJson(pkgPath);
|
|
101
|
+
pkg.dependencies = pkg.dependencies ?? {};
|
|
102
|
+
pkg.devDependencies = pkg.devDependencies ?? {};
|
|
103
|
+
if (!pkg.dependencies['@ai-partner-x/aiko-boot-starter-storage']) {
|
|
104
|
+
pkg.dependencies['@ai-partner-x/aiko-boot-starter-storage'] =
|
|
105
|
+
'workspace:*';
|
|
106
|
+
}
|
|
107
|
+
if (!pkg.dependencies.multer) {
|
|
108
|
+
pkg.dependencies.multer = '^1.4.5-lts.1';
|
|
109
|
+
}
|
|
110
|
+
if (!pkg.devDependencies['@types/multer']) {
|
|
111
|
+
pkg.devDependencies['@types/multer'] = '^1.4.12';
|
|
112
|
+
}
|
|
113
|
+
await fs.writeJson(pkgPath, pkg, { spaces: 2 });
|
|
114
|
+
logger.info('更新依赖:已写入 aiko-boot-starter-storage / multer / @types/multer。');
|
|
115
|
+
// 2) 更新 app.config.ts,增加 storage 配置(如果尚未存在)
|
|
116
|
+
const appConfigPath = path.join(apiDir, 'app.config.ts');
|
|
117
|
+
if (await fs.pathExists(appConfigPath)) {
|
|
118
|
+
let content = await fs.readFile(appConfigPath, 'utf-8');
|
|
119
|
+
if (!content.includes('storage:')) {
|
|
120
|
+
const marker = '} satisfies AppConfig;';
|
|
121
|
+
const storageBlock = ` storage: {
|
|
122
|
+
provider: 'local',
|
|
123
|
+
local: {
|
|
124
|
+
uploadDir: './uploads',
|
|
125
|
+
baseUrl: 'http://localhost:3001/api/uploads',
|
|
126
|
+
},
|
|
127
|
+
},
|
|
128
|
+
|
|
129
|
+
`;
|
|
130
|
+
if (!content.includes(marker)) {
|
|
131
|
+
throw new Error(`无法在 app.config.ts 中找到 "${marker}",请手动合并 storage 配置。`);
|
|
132
|
+
}
|
|
133
|
+
content = content.replace(marker, `${storageBlock}${marker}`);
|
|
134
|
+
await fs.writeFile(appConfigPath, content, 'utf-8');
|
|
135
|
+
logger.info('已在 app.config.ts 中注入 storage 配置。');
|
|
136
|
+
}
|
|
137
|
+
else {
|
|
138
|
+
logger.info('检测到 app.config.ts 已存在 storage 配置,跳过注入。');
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
else {
|
|
142
|
+
logger.warn?.('未找到 app.config.ts,跳过 storage 配置注入。');
|
|
143
|
+
}
|
|
144
|
+
// 3) 更新 server.ts,挂载 multer 中间件与静态文件服务
|
|
145
|
+
const serverPath = path.join(apiDir, 'src', 'server.ts');
|
|
146
|
+
if (await fs.pathExists(serverPath)) {
|
|
147
|
+
let serverCode = await fs.readFile(serverPath, 'utf-8');
|
|
148
|
+
if (!serverCode.includes('hasFileUpload')) {
|
|
149
|
+
// import { dirname } from 'path'; => import { dirname, join } from 'path';
|
|
150
|
+
serverCode = serverCode.replace("import { dirname } from 'path';", "import { dirname, join } from 'path';");
|
|
151
|
+
if (!serverCode.includes("from 'multer'")) {
|
|
152
|
+
serverCode = serverCode.replace("import express from 'express';", "import express from 'express';\nimport multer from 'multer';");
|
|
153
|
+
}
|
|
154
|
+
const loggerBlock = ` logger.info('Express middleware configured', {
|
|
155
|
+
hasRequestLogging: true,
|
|
156
|
+
});
|
|
157
|
+
`;
|
|
158
|
+
const replacementBlock = ` // 配置 multer 文件上传中间件
|
|
159
|
+
const upload = multer({ storage: multer.memoryStorage() });
|
|
160
|
+
expressApp.post('/api/upload', upload.single('file'));
|
|
161
|
+
expressApp.post('/api/upload/multiple', upload.array('files', 10));
|
|
162
|
+
|
|
163
|
+
// 配置静态文件服务(本地存储时访问上传的文件)
|
|
164
|
+
const uploadsDir = join(__dirname, '..', 'uploads');
|
|
165
|
+
expressApp.use('/api/uploads', express.static(uploadsDir));
|
|
166
|
+
|
|
167
|
+
logger.info('Express middleware configured', {
|
|
168
|
+
hasRequestLogging: true,
|
|
169
|
+
hasFileUpload: true,
|
|
170
|
+
hasStaticFiles: true,
|
|
171
|
+
});
|
|
172
|
+
`;
|
|
173
|
+
if (!serverCode.includes(loggerBlock)) {
|
|
174
|
+
throw new Error('无法在 server.ts 中找到 Express 中间件配置位置,请手动合并文件上传逻辑。');
|
|
175
|
+
}
|
|
176
|
+
serverCode = serverCode.replace(loggerBlock, replacementBlock);
|
|
177
|
+
await fs.writeFile(serverPath, serverCode, 'utf-8');
|
|
178
|
+
logger.info('已在 server.ts 中配置 multer 中间件和静态文件服务。');
|
|
179
|
+
}
|
|
180
|
+
else {
|
|
181
|
+
logger.info('检测到 server.ts 已包含文件上传相关配置,跳过修改。');
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
else {
|
|
185
|
+
logger.warn?.('未找到 src/server.ts,跳过服务端中间件配置。');
|
|
186
|
+
}
|
|
187
|
+
// 4) 复制上传控制器模板到 src/controller/upload.controller.ts
|
|
188
|
+
const controllerDir = path.join(apiDir, 'src', 'controller');
|
|
189
|
+
const uploadControllerPath = path.join(controllerDir, 'upload.controller.ts');
|
|
190
|
+
if (!(await fs.pathExists(uploadControllerPath))) {
|
|
191
|
+
const templateControllerPath = path.resolve(__dirname, '../../templates/feature-file/api/upload.controller.ts');
|
|
192
|
+
await fs.ensureDir(controllerDir);
|
|
193
|
+
await fs.copy(templateControllerPath, uploadControllerPath);
|
|
194
|
+
logger.info('已创建上传控制器 src/controller/upload.controller.ts。');
|
|
195
|
+
}
|
|
196
|
+
else {
|
|
197
|
+
logger.info('检测到上传控制器已存在,跳过创建。');
|
|
198
|
+
}
|
|
199
|
+
// 5) 创建 uploads 目录和 .gitkeep
|
|
200
|
+
const uploadsDir = path.join(apiDir, 'uploads');
|
|
201
|
+
await fs.ensureDir(uploadsDir);
|
|
202
|
+
await fs.writeFile(path.join(uploadsDir, '.gitkeep'), '', 'utf-8');
|
|
203
|
+
logger.info('已创建 uploads 目录及占位文件。');
|
|
204
|
+
// 6) 更新根 .gitignore,忽略上传文件但保留 .gitkeep
|
|
205
|
+
const gitignorePath = path.join(rootDir, '.gitignore');
|
|
206
|
+
let gitignore = (await fs.pathExists(gitignorePath))
|
|
207
|
+
? await fs.readFile(gitignorePath, 'utf-8')
|
|
208
|
+
: '';
|
|
209
|
+
const relativeUploadsPath = path
|
|
210
|
+
.relative(rootDir, uploadsDir)
|
|
211
|
+
.replace(/\\\\/g, '/')
|
|
212
|
+
.replace(/\\/g, '/');
|
|
213
|
+
const ignoreLine = `${relativeUploadsPath}/*`;
|
|
214
|
+
const keepLine = `!${relativeUploadsPath}/.gitkeep`;
|
|
215
|
+
if (!gitignore.includes(ignoreLine)) {
|
|
216
|
+
gitignore += `\n# Uploads (generated by aiko-boot)\n${ignoreLine}\n${keepLine}\n`;
|
|
217
|
+
await fs.writeFile(gitignorePath, gitignore.trimStart() + '\n', 'utf-8');
|
|
218
|
+
logger.info('已在根 .gitignore 中添加 uploads 忽略规则。');
|
|
219
|
+
}
|
|
220
|
+
else {
|
|
221
|
+
logger.info('根 .gitignore 中已存在 uploads 忽略规则,跳过修改。');
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
async function addRedisFeatureToApi(ctx) {
|
|
225
|
+
const { apiDir, rootDir: _rootDir, logger } = ctx;
|
|
226
|
+
// 1) 更新 api package.json 依赖(cache starter + ioredis)
|
|
227
|
+
const pkgPath = path.join(apiDir, 'package.json');
|
|
228
|
+
if (!(await fs.pathExists(pkgPath))) {
|
|
229
|
+
throw new Error(`未找到 API package.json:${pkgPath}`);
|
|
230
|
+
}
|
|
231
|
+
const pkg = await fs.readJson(pkgPath);
|
|
232
|
+
pkg.dependencies = pkg.dependencies ?? {};
|
|
233
|
+
pkg.devDependencies = pkg.devDependencies ?? {};
|
|
234
|
+
if (!pkg.dependencies['@ai-partner-x/aiko-boot-starter-cache']) {
|
|
235
|
+
pkg.dependencies['@ai-partner-x/aiko-boot-starter-cache'] = 'workspace:*';
|
|
236
|
+
}
|
|
237
|
+
if (!pkg.dependencies.ioredis) {
|
|
238
|
+
pkg.dependencies.ioredis = '^5.4.2';
|
|
239
|
+
}
|
|
240
|
+
await fs.writeJson(pkgPath, pkg, { spaces: 2 });
|
|
241
|
+
logger.info('更新依赖:已写入 aiko-boot-starter-cache / ioredis。');
|
|
242
|
+
// 2) 更新 app.config.ts,增加 cache 配置(如果尚未存在)
|
|
243
|
+
const appConfigPath = path.join(apiDir, 'app.config.ts');
|
|
244
|
+
if (await fs.pathExists(appConfigPath)) {
|
|
245
|
+
let content = await fs.readFile(appConfigPath, 'utf-8');
|
|
246
|
+
if (!content.includes('cache:')) {
|
|
247
|
+
const marker = '} satisfies AppConfig;';
|
|
248
|
+
const cacheBlock = ` // ========== Cache Configuration (cache.*) ==========
|
|
249
|
+
// Cache is disabled by default — no Redis connection is made until you opt in.
|
|
250
|
+
// To enable: set \`enabled: true\`, ensure Redis is running, then adjust host/port.
|
|
251
|
+
cache: {
|
|
252
|
+
enabled: false, // set to true to activate (requires Redis)
|
|
253
|
+
type: 'redis',
|
|
254
|
+
host: process.env.REDIS_HOST || '127.0.0.1',
|
|
255
|
+
port: Number(process.env.REDIS_PORT) || 6379,
|
|
256
|
+
},
|
|
257
|
+
`;
|
|
258
|
+
if (!content.includes(marker)) {
|
|
259
|
+
throw new Error(`无法在 app.config.ts 中找到 "${marker}",请手动合并 cache 配置。`);
|
|
260
|
+
}
|
|
261
|
+
content = content.replace(marker, `${cacheBlock}${marker}`);
|
|
262
|
+
await fs.writeFile(appConfigPath, content, 'utf-8');
|
|
263
|
+
logger.info('已在 app.config.ts 中注入 cache 配置。');
|
|
264
|
+
}
|
|
265
|
+
else {
|
|
266
|
+
logger.info('检测到 app.config.ts 已存在 cache 配置,跳过注入。');
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
else {
|
|
270
|
+
logger.warn?.('未找到 app.config.ts,跳过 cache 配置注入。');
|
|
271
|
+
}
|
|
272
|
+
// 3) 复制缓存相关文件模板
|
|
273
|
+
const templateBaseDir = path.resolve(__dirname, '../../templates/feature-redis/api');
|
|
274
|
+
// 复制 DTO
|
|
275
|
+
const dtoDir = path.join(apiDir, 'src', 'dto');
|
|
276
|
+
const cacheDtoPath = path.join(dtoDir, 'cache.dto.ts');
|
|
277
|
+
if (!(await fs.pathExists(cacheDtoPath))) {
|
|
278
|
+
const templateDtoPath = path.join(templateBaseDir, 'src', 'dto', 'cache.dto.ts');
|
|
279
|
+
await fs.ensureDir(dtoDir);
|
|
280
|
+
await fs.copy(templateDtoPath, cacheDtoPath);
|
|
281
|
+
logger.info('已创建缓存 DTO src/dto/cache.dto.ts。');
|
|
282
|
+
}
|
|
283
|
+
else {
|
|
284
|
+
logger.info('检测到缓存 DTO 已存在,跳过创建。');
|
|
285
|
+
}
|
|
286
|
+
// 复制 Service
|
|
287
|
+
const serviceDir = path.join(apiDir, 'src', 'service');
|
|
288
|
+
const cacheServicePath = path.join(serviceDir, 'cache.service.ts');
|
|
289
|
+
if (!(await fs.pathExists(cacheServicePath))) {
|
|
290
|
+
const templateServicePath = path.join(templateBaseDir, 'src', 'service', 'cache.service.ts');
|
|
291
|
+
await fs.ensureDir(serviceDir);
|
|
292
|
+
await fs.copy(templateServicePath, cacheServicePath);
|
|
293
|
+
logger.info('已创建缓存服务 src/service/cache.service.ts。');
|
|
294
|
+
}
|
|
295
|
+
else {
|
|
296
|
+
logger.info('检测到缓存服务已存在,跳过创建。');
|
|
297
|
+
}
|
|
298
|
+
// 复制 Controller
|
|
299
|
+
const controllerDir = path.join(apiDir, 'src', 'controller');
|
|
300
|
+
const cacheControllerPath = path.join(controllerDir, 'cache.controller.ts');
|
|
301
|
+
if (!(await fs.pathExists(cacheControllerPath))) {
|
|
302
|
+
const templateControllerPath = path.join(templateBaseDir, 'src', 'controller', 'cache.controller.ts');
|
|
303
|
+
await fs.ensureDir(controllerDir);
|
|
304
|
+
await fs.copy(templateControllerPath, cacheControllerPath);
|
|
305
|
+
logger.info('已创建缓存控制器 src/controller/cache.controller.ts。');
|
|
306
|
+
}
|
|
307
|
+
else {
|
|
308
|
+
logger.info('检测到缓存控制器已存在,跳过创建。');
|
|
309
|
+
}
|
|
310
|
+
}
|
|
311
|
+
async function addMqFeatureToApi(ctx) {
|
|
312
|
+
const { apiDir, rootDir: _rootDir, logger } = ctx;
|
|
313
|
+
// 1) 更新 api package.json 依赖(mq starter)
|
|
314
|
+
const pkgPath = path.join(apiDir, 'package.json');
|
|
315
|
+
if (!(await fs.pathExists(pkgPath))) {
|
|
316
|
+
throw new Error(`未找到 API package.json:${pkgPath}`);
|
|
317
|
+
}
|
|
318
|
+
const pkg = await fs.readJson(pkgPath);
|
|
319
|
+
pkg.dependencies = pkg.dependencies ?? {};
|
|
320
|
+
pkg.devDependencies = pkg.devDependencies ?? {};
|
|
321
|
+
if (!pkg.dependencies['@ai-partner-x/aiko-boot-starter-mq']) {
|
|
322
|
+
pkg.dependencies['@ai-partner-x/aiko-boot-starter-mq'] = 'workspace:*';
|
|
323
|
+
}
|
|
324
|
+
await fs.writeJson(pkgPath, pkg, { spaces: 2 });
|
|
325
|
+
logger.info('更新依赖:已写入 aiko-boot-starter-mq。');
|
|
326
|
+
// 2) 更新 app.config.ts,增加 mq 配置(如果尚未存在)
|
|
327
|
+
const appConfigPath = path.join(apiDir, 'app.config.ts');
|
|
328
|
+
if (await fs.pathExists(appConfigPath)) {
|
|
329
|
+
let content = await fs.readFile(appConfigPath, 'utf-8');
|
|
330
|
+
if (!content.includes('mq:')) {
|
|
331
|
+
const marker = '} satisfies AppConfig;';
|
|
332
|
+
const mqBlock = ` // ========== MQ Configuration (消息队列) ==========
|
|
333
|
+
// 使用内存适配器无需 RabbitMQ,设置 MQ_TYPE=memory 或使用下方配置
|
|
334
|
+
mq: {
|
|
335
|
+
enabled: true,
|
|
336
|
+
type: 'memory' as const,
|
|
337
|
+
},
|
|
338
|
+
`;
|
|
339
|
+
if (!content.includes(marker)) {
|
|
340
|
+
throw new Error(`无法在 app.config.ts 中找到 "${marker}",请手动合并 mq 配置。`);
|
|
341
|
+
}
|
|
342
|
+
content = content.replace(marker, `${mqBlock}${marker}`);
|
|
343
|
+
await fs.writeFile(appConfigPath, content, 'utf-8');
|
|
344
|
+
logger.info('已在 app.config.ts 中注入 mq 配置。');
|
|
345
|
+
}
|
|
346
|
+
else {
|
|
347
|
+
logger.info('检测到 app.config.ts 已存在 mq 配置,跳过注入。');
|
|
348
|
+
}
|
|
349
|
+
}
|
|
350
|
+
else {
|
|
351
|
+
logger.warn?.('未找到 app.config.ts,跳过 mq 配置注入。');
|
|
352
|
+
}
|
|
353
|
+
// 3) 复制 MQ 相关文件模板
|
|
354
|
+
const templateBaseDir = path.resolve(__dirname, '../../templates/feature-mq/api');
|
|
355
|
+
// 复制 DTO
|
|
356
|
+
const dtoDir = path.join(apiDir, 'src', 'dto');
|
|
357
|
+
const mqDtoPath = path.join(dtoDir, 'mq.dto.ts');
|
|
358
|
+
if (!(await fs.pathExists(mqDtoPath))) {
|
|
359
|
+
const templateDtoPath = path.join(templateBaseDir, 'src', 'dto', 'mq.dto.ts');
|
|
360
|
+
await fs.ensureDir(dtoDir);
|
|
361
|
+
await fs.copy(templateDtoPath, mqDtoPath);
|
|
362
|
+
logger.info('已创建 MQ DTO src/dto/mq.dto.ts。');
|
|
363
|
+
}
|
|
364
|
+
else {
|
|
365
|
+
logger.info('检测到 MQ DTO 已存在,跳过创建。');
|
|
366
|
+
}
|
|
367
|
+
// 复制 Service
|
|
368
|
+
const serviceDir = path.join(apiDir, 'src', 'service');
|
|
369
|
+
const mqConsumerServicePath = path.join(serviceDir, 'mq.consumer.service.ts');
|
|
370
|
+
if (!(await fs.pathExists(mqConsumerServicePath))) {
|
|
371
|
+
const templateServicePath = path.join(templateBaseDir, 'src', 'service', 'mq.consumer.service.ts');
|
|
372
|
+
await fs.ensureDir(serviceDir);
|
|
373
|
+
await fs.copy(templateServicePath, mqConsumerServicePath);
|
|
374
|
+
logger.info('已创建 MQ 消费者服务 src/service/mq.consumer.service.ts。');
|
|
375
|
+
}
|
|
376
|
+
else {
|
|
377
|
+
logger.info('检测到 MQ 消费者服务已存在,跳过创建。');
|
|
378
|
+
}
|
|
379
|
+
// 复制 Controller
|
|
380
|
+
const controllerDir = path.join(apiDir, 'src', 'controller');
|
|
381
|
+
const mqControllerPath = path.join(controllerDir, 'mq.controller.ts');
|
|
382
|
+
if (!(await fs.pathExists(mqControllerPath))) {
|
|
383
|
+
const templateControllerPath = path.join(templateBaseDir, 'src', 'controller', 'mq.controller.ts');
|
|
384
|
+
await fs.ensureDir(controllerDir);
|
|
385
|
+
await fs.copy(templateControllerPath, mqControllerPath);
|
|
386
|
+
logger.info('已创建 MQ 控制器 src/controller/mq.controller.ts。');
|
|
387
|
+
}
|
|
388
|
+
else {
|
|
389
|
+
logger.info('检测到 MQ 控制器已存在,跳过创建。');
|
|
390
|
+
}
|
|
391
|
+
}
|
|
392
|
+
async function addLogFeatureToApi(ctx) {
|
|
393
|
+
const { apiDir, logger } = ctx;
|
|
394
|
+
// 1) 更新 api package.json 依赖(log starter)
|
|
395
|
+
const pkgPath = path.join(apiDir, 'package.json');
|
|
396
|
+
if (!(await fs.pathExists(pkgPath))) {
|
|
397
|
+
throw new Error(`未找到 API package.json:${pkgPath}`);
|
|
398
|
+
}
|
|
399
|
+
const pkg = await fs.readJson(pkgPath);
|
|
400
|
+
pkg.dependencies = pkg.dependencies ?? {};
|
|
401
|
+
if (!pkg.dependencies['@ai-partner-x/aiko-boot-starter-log']) {
|
|
402
|
+
pkg.dependencies['@ai-partner-x/aiko-boot-starter-log'] = 'workspace:*';
|
|
403
|
+
}
|
|
404
|
+
await fs.writeJson(pkgPath, pkg, { spaces: 2 });
|
|
405
|
+
logger.info('更新依赖:已写入 aiko-boot-starter-log。');
|
|
406
|
+
// 2) 更新 app.config.ts,增加 logging 配置(如果尚未存在)
|
|
407
|
+
const appConfigPath = path.join(apiDir, 'app.config.ts');
|
|
408
|
+
if (await fs.pathExists(appConfigPath)) {
|
|
409
|
+
let content = await fs.readFile(appConfigPath, 'utf-8');
|
|
410
|
+
if (!content.includes('logging:')) {
|
|
411
|
+
const marker = '} satisfies AppConfig;';
|
|
412
|
+
const loggingBlock = createLoggingConfigBlock();
|
|
413
|
+
if (!content.includes(marker)) {
|
|
414
|
+
throw new Error(`无法在 app.config.ts 中找到 "${marker}",请手动合并 logging 配置。`);
|
|
415
|
+
}
|
|
416
|
+
content = content.replace(marker, `${loggingBlock}${marker}`);
|
|
417
|
+
await fs.writeFile(appConfigPath, content, 'utf-8');
|
|
418
|
+
logger.info('已在 app.config.ts 中注入 logging 配置。');
|
|
419
|
+
}
|
|
420
|
+
else {
|
|
421
|
+
logger.info('检测到 app.config.ts 已存在 logging 配置,跳过注入。');
|
|
422
|
+
}
|
|
423
|
+
}
|
|
424
|
+
else {
|
|
425
|
+
logger.warn?.('未找到 app.config.ts,跳过 logging 配置注入。');
|
|
426
|
+
}
|
|
427
|
+
// 3) 更新 server.ts,集成日志初始化、HTTP 请求日志中间件、全局错误日志处理
|
|
428
|
+
const serverPath = path.join(apiDir, 'src', 'server.ts');
|
|
429
|
+
if (await fs.pathExists(serverPath)) {
|
|
430
|
+
let serverCode = await fs.readFile(serverPath, 'utf-8');
|
|
431
|
+
let changed = false;
|
|
432
|
+
// a) 确保引入并调用 autoInit + getLogger
|
|
433
|
+
if (!serverCode.includes("from '@ai-partner-x/aiko-boot-starter-log'")) {
|
|
434
|
+
serverCode = serverCode.replace("import { createApp } from '@ai-partner-x/aiko-boot';", "import { createApp } from '@ai-partner-x/aiko-boot';\nimport { autoInit, getLogger } from '@ai-partner-x/aiko-boot-starter-log';");
|
|
435
|
+
changed = true;
|
|
436
|
+
}
|
|
437
|
+
if (!serverCode.includes('autoInit();')) {
|
|
438
|
+
// 在 import 后尽量靠前插入
|
|
439
|
+
serverCode = serverCode.replace("import { autoInit, getLogger } from '@ai-partner-x/aiko-boot-starter-log';", "import { autoInit, getLogger } from '@ai-partner-x/aiko-boot-starter-log';\n\nautoInit();");
|
|
440
|
+
changed = true;
|
|
441
|
+
}
|
|
442
|
+
if (!serverCode.includes("getLogger('server')")) {
|
|
443
|
+
// 在 autoInit 后创建 logger
|
|
444
|
+
serverCode = serverCode.replace('autoInit();', "autoInit();\nconst logger = getLogger('server');\n\nlogger.info('Starting API server...');");
|
|
445
|
+
changed = true;
|
|
446
|
+
}
|
|
447
|
+
// b) 引入 RequestLogService(本 feature 提供)
|
|
448
|
+
if (!serverCode.includes('RequestLogService')) {
|
|
449
|
+
serverCode = serverCode.replace("import express from 'express';", "import express from 'express';\nimport { RequestLogService } from './service/log.request.service';");
|
|
450
|
+
changed = true;
|
|
451
|
+
}
|
|
452
|
+
// c) 挂载请求日志中间件
|
|
453
|
+
const jsonLine = 'expressApp.use(express.json());';
|
|
454
|
+
if (serverCode.includes(jsonLine) && !serverCode.includes('RequestLogService.requestLogMiddleware')) {
|
|
455
|
+
serverCode = serverCode.replace(jsonLine, `${jsonLine}\n\n// HTTP request logging\nexpressApp.use(RequestLogService.requestLogMiddleware);`);
|
|
456
|
+
changed = true;
|
|
457
|
+
}
|
|
458
|
+
// d) 全局错误处理中间件(放在 listen 前)
|
|
459
|
+
if (!serverCode.includes('Global error handler')) {
|
|
460
|
+
const listenMarker = 'expressApp.listen(';
|
|
461
|
+
if (serverCode.includes(listenMarker)) {
|
|
462
|
+
serverCode = serverCode.replace(listenMarker, `// Global error handler\nexpressApp.use((err: unknown, req: any, res: any, next: any) => {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n void next;\n const error = err instanceof Error ? err : new Error(String(err));\n logger.error('Unhandled error', error, {\n method: req?.method,\n url: req?.url,\n path: req?.path,\n });\n if (!res.headersSent) {\n res.status(500).json({ message: 'Internal Server Error' });\n }\n});\n\n${listenMarker}`);
|
|
463
|
+
changed = true;
|
|
464
|
+
}
|
|
465
|
+
}
|
|
466
|
+
if (changed) {
|
|
467
|
+
await fs.writeFile(serverPath, serverCode, 'utf-8');
|
|
468
|
+
logger.info('已在 src/server.ts 中集成日志初始化、请求日志中间件与全局错误处理。');
|
|
469
|
+
}
|
|
470
|
+
else {
|
|
471
|
+
logger.info('检测到 src/server.ts 已包含日志相关配置,跳过修改。');
|
|
472
|
+
}
|
|
473
|
+
}
|
|
474
|
+
else {
|
|
475
|
+
logger.warn?.('未找到 src/server.ts,跳过服务端集成。');
|
|
476
|
+
}
|
|
477
|
+
// 4) 复制 log 相关文件模板(services + docs)
|
|
478
|
+
const templateBaseDir = path.resolve(__dirname, '../../templates/feature-log/api');
|
|
479
|
+
const serviceDir = path.join(apiDir, 'src', 'service');
|
|
480
|
+
await fs.ensureDir(serviceDir);
|
|
481
|
+
const logServicePath = path.join(serviceDir, 'log.service.ts');
|
|
482
|
+
if (!(await fs.pathExists(logServicePath))) {
|
|
483
|
+
await fs.copy(path.join(templateBaseDir, 'src', 'service', 'log.service.ts'), logServicePath);
|
|
484
|
+
logger.info('已创建日志服务 src/service/log.service.ts。');
|
|
485
|
+
}
|
|
486
|
+
else {
|
|
487
|
+
logger.info('检测到日志服务已存在,跳过创建。');
|
|
488
|
+
}
|
|
489
|
+
const requestLogServicePath = path.join(serviceDir, 'log.request.service.ts');
|
|
490
|
+
if (!(await fs.pathExists(requestLogServicePath))) {
|
|
491
|
+
await fs.copy(path.join(templateBaseDir, 'src', 'service', 'log.request.service.ts'), requestLogServicePath);
|
|
492
|
+
logger.info('已创建请求日志服务 src/service/log.request.service.ts。');
|
|
493
|
+
}
|
|
494
|
+
else {
|
|
495
|
+
logger.info('检测到请求日志服务已存在,跳过创建。');
|
|
496
|
+
}
|
|
497
|
+
const docsDir = path.join(apiDir, 'docs');
|
|
498
|
+
await fs.ensureDir(docsDir);
|
|
499
|
+
const docsPath = path.join(docsDir, 'log-integration-guide.md');
|
|
500
|
+
if (!(await fs.pathExists(docsPath))) {
|
|
501
|
+
await fs.copy(path.join(templateBaseDir, 'docs', 'log-integration-guide.md'), docsPath);
|
|
502
|
+
logger.info('已创建 docs/log-integration-guide.md。');
|
|
503
|
+
}
|
|
504
|
+
else {
|
|
505
|
+
logger.info('检测到 docs/log-integration-guide.md 已存在,跳过创建。');
|
|
506
|
+
}
|
|
507
|
+
}
|
|
508
|
+
function createLoggingConfigBlock() {
|
|
509
|
+
return ` logging: {
|
|
510
|
+
// 日志级别:error, warn, info, http, verbose, debug, silly
|
|
511
|
+
level: process.env.NODE_ENV === 'production' ? 'info' : 'debug',
|
|
512
|
+
|
|
513
|
+
// 输出格式:json, cli, pretty, simple
|
|
514
|
+
format: process.env.NODE_ENV === 'production' ? 'json' : 'cli',
|
|
515
|
+
|
|
516
|
+
// 是否启用颜色
|
|
517
|
+
colorize: process.env.NODE_ENV !== 'production',
|
|
518
|
+
|
|
519
|
+
// 是否显示时间戳
|
|
520
|
+
timestamp: true,
|
|
521
|
+
|
|
522
|
+
// 默认元数据
|
|
523
|
+
defaultMeta: {
|
|
524
|
+
service: 'scaffold-api',
|
|
525
|
+
version: '0.1.0',
|
|
526
|
+
env: process.env.NODE_ENV || 'development',
|
|
527
|
+
},
|
|
528
|
+
|
|
529
|
+
// 传输配置
|
|
530
|
+
transports: [
|
|
531
|
+
{
|
|
532
|
+
type: 'console',
|
|
533
|
+
enabled: true,
|
|
534
|
+
level: process.env.NODE_ENV === 'production' ? 'info' : 'debug',
|
|
535
|
+
format: process.env.NODE_ENV === 'production' ? 'json' : 'cli',
|
|
536
|
+
colorize: process.env.NODE_ENV !== 'production',
|
|
537
|
+
},
|
|
538
|
+
{
|
|
539
|
+
type: 'file',
|
|
540
|
+
enabled: true,
|
|
541
|
+
filename: './logs/log-{date}.log',
|
|
542
|
+
level: 'info',
|
|
543
|
+
maxSize: '10m',
|
|
544
|
+
maxFiles: 7,
|
|
545
|
+
format: 'json',
|
|
546
|
+
rotateByDate: true,
|
|
547
|
+
retentionDays: 30,
|
|
548
|
+
maxFileSize: 100,
|
|
549
|
+
},
|
|
550
|
+
{
|
|
551
|
+
type: 'file',
|
|
552
|
+
enabled: true,
|
|
553
|
+
filename: './logs/error-{date}.log',
|
|
554
|
+
level: 'error',
|
|
555
|
+
maxSize: '10m',
|
|
556
|
+
maxFiles: 30,
|
|
557
|
+
format: 'json',
|
|
558
|
+
rotateByDate: true,
|
|
559
|
+
retentionDays: 30,
|
|
560
|
+
maxFileSize: 100,
|
|
561
|
+
},
|
|
562
|
+
],
|
|
563
|
+
},
|
|
564
|
+
|
|
565
|
+
`;
|
|
566
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { Logger } from '../core/logger.js';
|
|
2
|
+
import type { Prompter } from '../core/prompts.js';
|
|
3
|
+
export type InitScaffoldInput = {
|
|
4
|
+
targetDir?: string;
|
|
5
|
+
name?: string;
|
|
6
|
+
empty: boolean;
|
|
7
|
+
withAdmin: boolean;
|
|
8
|
+
withMobile: boolean;
|
|
9
|
+
withApi: boolean;
|
|
10
|
+
templateDir?: string;
|
|
11
|
+
dryRun: boolean;
|
|
12
|
+
};
|
|
13
|
+
export type InitScaffoldDeps = {
|
|
14
|
+
logger: Logger;
|
|
15
|
+
prompter: Prompter;
|
|
16
|
+
};
|
|
17
|
+
export declare function createInitUseCase(deps: InitScaffoldDeps): {
|
|
18
|
+
execute: (input: InitScaffoldInput) => Promise<void>;
|
|
19
|
+
};
|