create-koa-boot 1.0.0

package/templates/src/business/sysConfig/sysConfig.controller.ts

@@ -0,0 +1,87 @@
+import { Controller, Get, Post, Put, Delete, Route, Tags, Body, Path, SuccessResponse, Response } from 'tsoa';
+import { SysConfigService } from './sysConfig.service';
+import { SysConfig, CreateSysConfigDto, UpdateSysConfigDto } from './sysConfig.model';
+import { success, fail, ApiResponse, BizCode } from '../../common';
+
+@Route('base/configs')
+@Tags('基础数据 - 全局参数')
+export class SysConfigController extends Controller {
+  private configService = new SysConfigService();
+
+  /**
+   * 获取所有全局参数列表
+   */
+  @Get()
+  public async getAllConfigs(): Promise<ApiResponse<SysConfig[]>> {
+    const configs = await this.configService.getAllConfigs();
+    return success(configs);
+  }
+
+  /**
+   * 根据参数键获取参数
+   */
+  @Get('key/{configKey}')
+  public async getConfigByKey(@Path() configKey: string): Promise<ApiResponse<SysConfig | null>> {
+    const config = await this.configService.getConfigByKey(configKey);
+    if (!config) {
+      return fail('参数不存在', BizCode.NOT_FOUND, null);
+    }
+    return success(config);
+  }
+
+  /**
+   * 根据ID获取参数详情
+   */
+  @Get('{id}')
+  public async getConfigById(@Path() id: string): Promise<ApiResponse<SysConfig | null>> {
+    const config = await this.configService.getConfigById(id);
+    if (!config) {
+      return fail('参数不存在', BizCode.NOT_FOUND, null);
+    }
+    return success(config);
+  }
+
+  /**
+   * 创建全局参数
+   */
+  @Post()
+  @SuccessResponse(201, '创建成功')
+  public async createConfig(@Body() body: CreateSysConfigDto): Promise<ApiResponse<SysConfig | null>> {
+    const existing = await this.configService.getConfigByKey(body.configKey);
+    if (existing) {
+      return fail(`参数键 ${body.configKey} 已存在`, BizCode.FAIL, null);
+    }
+    const config = await this.configService.createConfig(body);
+    return success(config, '创建成功');
+  }
+
+  /**
+   * 更新全局参数（参数键不允许修改）
+   */
+  @Put('{id}')
+  public async updateConfig(
+    @Path() id: string,
+    @Body() body: UpdateSysConfigDto,
+  ): Promise<ApiResponse<SysConfig | null>> {
+    const existing = await this.configService.getConfigById(id);
+    if (!existing) {
+      return fail('参数不存在', BizCode.NOT_FOUND, null);
+    }
+    const config = await this.configService.updateConfig(id, body);
+    return success(config, '更新成功');
+  }
+
+  /**
+   * 删除全局参数
+   */
+  @Delete('{id}')
+  @Response(404, '参数不存在')
+  public async deleteConfig(@Path() id: string): Promise<ApiResponse<boolean>> {
+    const existing = await this.configService.getConfigById(id);
+    if (!existing) {
+      return fail('参数不存在', BizCode.NOT_FOUND, false);
+    }
+    await this.configService.deleteConfig(id);
+    return success(true, '删除成功');
+  }
+}

package/templates/src/business/sysConfig/sysConfig.model.ts

@@ -0,0 +1,44 @@
+import { IsString, IsNotEmpty, IsOptional, MaxLength } from 'class-validator';
+
+export class SysConfig {
+  @IsString()
+  id!: string;
+
+  @IsString()
+  configKey!: string;
+
+  @IsString()
+  configValue!: string;
+
+  description!: string | null;
+  createdAt!: Date;
+  updatedAt!: Date;
+}
+
+export class CreateSysConfigDto {
+  @IsString()
+  @IsNotEmpty({ message: '参数键不能为空' })
+  @MaxLength(100, { message: '参数键最多100个字符' })
+  configKey!: string;
+
+  @IsString()
+  @IsNotEmpty({ message: '参数值不能为空' })
+  configValue!: string;
+
+  @IsOptional()
+  @IsString()
+  @MaxLength(255, { message: '参数描述最多255个字符' })
+  description?: string;
+}
+
+export class UpdateSysConfigDto {
+  @IsOptional()
+  @IsString()
+  @IsNotEmpty({ message: '参数值不能为空' })
+  configValue?: string;
+
+  @IsOptional()
+  @IsString()
+  @MaxLength(255, { message: '参数描述最多255个字符' })
+  description?: string;
+}

package/templates/src/business/sysConfig/sysConfig.service.ts

@@ -0,0 +1,32 @@
+import 'reflect-metadata';
+import { Service } from 'typedi';
+import { prisma } from '../../config/database';
+import { CreateSysConfigDto, UpdateSysConfigDto, SysConfig } from './sysConfig.model';
+
+@Service()
+export class SysConfigService {
+  async getAllConfigs(): Promise<SysConfig[]> {
+    return prisma.sysConfig.findMany({ orderBy: { configKey: 'asc' } }) as unknown as SysConfig[];
+  }
+
+  async getConfigById(id: string): Promise<SysConfig | null> {
+    return prisma.sysConfig.findUnique({ where: { id } }) as unknown as SysConfig;
+  }
+
+  async getConfigByKey(configKey: string): Promise<SysConfig | null> {
+    return prisma.sysConfig.findUnique({ where: { configKey } }) as unknown as SysConfig;
+  }
+
+  async createConfig(dto: CreateSysConfigDto): Promise<SysConfig> {
+    return prisma.sysConfig.create({ data: dto as any }) as unknown as SysConfig;
+  }
+
+  async updateConfig(id: string, dto: UpdateSysConfigDto): Promise<SysConfig | null> {
+    return prisma.sysConfig.update({ where: { id }, data: dto as any }) as unknown as SysConfig;
+  }
+
+  async deleteConfig(id: string): Promise<boolean> {
+    const result = await prisma.sysConfig.delete({ where: { id } });
+    return !!result;
+  }
+}

package/templates/src/common/decorators.ts

@@ -0,0 +1 @@
+export * from 'koa-boot-runtime/common/decorators';

package/templates/src/common/index.ts

@@ -0,0 +1,8 @@
+// 桥接层：业务模块沿用 '../../common' 书写习惯。
+// 业务侧公共类型在 ./types 源码级声明（tsoa 硬约束，不解析 node_modules 类型）；
+// 其余运行时能力（paginateQuery/normalizeDto/系统枚举等）由框架提供。
+export * from './types';
+export { paginateQuery } from 'koa-boot-runtime/common';
+export type { PaginateOptions } from 'koa-boot-runtime/common';
+export { normalizeDto } from 'koa-boot-runtime/common';
+export * from 'koa-boot-runtime/common/enums';

package/templates/src/common/types.ts

@@ -0,0 +1,51 @@
+// ============ 业务侧公共类型声明 ============
+// 说明：tsoa 只能解析源码(.ts)中的类型声明，无法解析 node_modules 内 .d.ts 的类型。
+// 因此业务侧公共类型（响应包装、分页）在此源码级声明，结构与框架保持一致；
+// 运行时值（success/fail/pageSuccess/BizCode 等）仍由框架提供，见文件末尾 re-export。
+
+/** 统一 API 响应基础结构 */
+export interface ApiResponse<T = unknown> {
+  /** 业务状态码（200=成功，非200=失败） */
+  code: number;
+  /** 响应消息 */
+  message: string;
+  /** 响应数据 */
+  data: T;
+}
+
+/** 成功响应（泛型数据） */
+export type SuccessResponse<T> = ApiResponse<T> & { code: 200 };
+
+/** 失败响应 */
+export type FailResponse<T = null> = ApiResponse<T>;
+
+/** 分页查询参数 */
+export interface PaginationParams {
+  page: number;
+  pageSize: number;
+}
+
+/** 分页查询参数（可选，用于接收请求参数） */
+export interface OptionalPaginationParams {
+  page?: number;
+  pageSize?: number;
+}
+
+/** 分页元数据 */
+export interface PaginationMeta {
+  page: number;
+  pageSize: number;
+  total: number;
+  totalPages: number;
+  hasPrev: boolean;
+  hasNext: boolean;
+}
+
+/** 分页结果 */
+export interface PageResult<T> {
+  list: T[];
+  pagination: PaginationMeta;
+}
+
+// ============ 运行时值（由框架提供） ============
+export { BizCode, success, fail, pageSuccess } from 'koa-boot-runtime/common/types';

package/templates/src/config/database.ts

@@ -0,0 +1,4 @@
+// 桥接层：业务模块沿用 '../../config/database' 书写习惯
+// 与框架共享同一 PrismaClient 单例
+export { createPrismaClient, prisma } from 'koa-boot-runtime/config/database';
+export { default } from 'koa-boot-runtime/config/database';

package/templates/src/config/index.ts

@@ -0,0 +1,2 @@
+// 桥接层：业务模块沿用 '../../config' 书写习惯
+export { default } from 'koa-boot-runtime/config/index';

package/templates/src/index.ts

@@ -0,0 +1,40 @@
+import 'reflect-metadata';
+import app from './app';
+import config from './config';
+import { logger } from './utils/logger';
+import { connectRedis } from './utils/redisClient';
+import { printBanner } from './utils/banner';
+import { createPrismaClient, systemServices } from 'koa-boot-runtime';
+
+const PORT = Number(config.app.port || 3003);
+
+async function startServer() {
+  const prisma = createPrismaClient();
+  try {
+    await prisma.$connect();
+    logger.info('Database connection established successfully');
+
+    // Redis（可选依赖：连接失败不阻断启动，后续使用时会自动重连/降级）
+    connectRedis()
+      .then(() => logger.info('Redis connection established successfully'))
+      .catch((err) =>
+        logger.warn(
+          `Redis connection failed: ${err instanceof Error ? err.message : err}（请确认 Redis 服务已启动；系统仍可运行，缓存相关功能将降级）`,
+        ),
+      );
+
+    // 初始化 admin 账号（admin/admin123，仅首次）
+    const { UserService } = systemServices;
+    await new UserService().initAdminUser();
+
+    app.listen(PORT, () => {
+      printBanner(PORT);
+    });
+  } catch (error) {
+    logger.error('Failed to start server:', error);
+    await prisma.$disconnect();
+    process.exit(1);
+  }
+}
+
+startServer();

package/templates/src/utils/aiClient.ts

@@ -0,0 +1 @@
+export * from 'koa-boot-runtime/utils/aiClient';

package/templates/src/utils/banner.ts

@@ -0,0 +1 @@
+export * from 'koa-boot-runtime/utils/banner';

package/templates/src/utils/emailClient.ts

@@ -0,0 +1 @@
+export * from 'koa-boot-runtime/utils/emailClient';

package/templates/src/utils/logger.ts

@@ -0,0 +1 @@
+export * from 'koa-boot-runtime/utils/logger';

package/templates/src/utils/redisClient.ts

@@ -0,0 +1 @@
+export * from 'koa-boot-runtime/utils/redisClient';

package/templates/src/utils/smsClient.ts

@@ -0,0 +1 @@
+export * from 'koa-boot-runtime/utils/smsClient';

package/templates/src/utils/unipushClient.ts

@@ -0,0 +1 @@
+export * from 'koa-boot-runtime/utils/unipushClient';

package/templates/src/utils/wecom.ts

@@ -0,0 +1 @@
+export * from 'koa-boot-runtime/utils/wecom';

package/templates/tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true
+  },
+  "include": ["src/**/*.ts", "src/**/*.d.ts"]
+}

package/templates/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "lib": ["ES2022"],
+    "strict": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts", "src/**/*.d.ts"],
+  "exclude": ["node_modules", "dist"]
+}

package/templates/tsoa.json

@@ -0,0 +1,29 @@
+{
+  "entryFile": "./src/app.ts",
+  "controllerPathGlobs": [
+    "./src/business/**/*Controller.ts"
+  ],
+  "spec": {
+    "outputDirectory": "./src/build",
+    "specVersion": 3,
+    "basePath": "/api",
+    "securityDefinitions": {
+      "bearerAuth": {
+        "type": "http",
+        "scheme": "bearer",
+        "bearerFormat": "JWT"
+      }
+    }
+  },
+  "routes": {
+    "routesDir": "./src/build",
+    "middleware": "koa",
+    "basePath": "/api"
+  },
+  "compilerOptions": {
+    "baseUrl": "./src"
+  },
+  "ignore": [
+    "**/node_modules/**"
+  ]
+}