create-dp-koa 1.1.1 → 1.1.3

package/template/src/libs/captcha.ts

@@ -1,37 +0,0 @@
-import svgCaptcha from 'svg-captcha';
-import jwt from 'jsonwebtoken';
-
-export class CaptchaGenerator {
-  private static readonly JWT_SECRET = process.env.CAPTCHA_JWT_SECRET || 'captcha_secret';
-  private static readonly JWT_EXPIRES_IN = '5m';
-
-  static generate() {
-    const captcha = svgCaptcha.create({
-      size: 4,
-      ignoreChars: '0o1i',
-      noise: 2,
-      color: true,
-      background: '#f0f0f0'
-    });
-
-    const token = jwt.sign(
-      { captcha: captcha.text.toLowerCase() },
-      this.JWT_SECRET,
-      { expiresIn: this.JWT_EXPIRES_IN }
-    );
-
-    return {
-      image: captcha.data,
-      token
-    };
-  }
-
-  static verify(token: string, input: string): boolean {
-    try {
-      const decoded = jwt.verify(token, this.JWT_SECRET) as { captcha: string };
-      return decoded.captcha === input?.toLowerCase();
-    } catch {
-      return false;
-    }
-  }
-}

package/template/src/libs/cos.ts

@@ -1,45 +0,0 @@
-import COS from "cos-nodejs-sdk-v5";
-import fs from "fs";
-
-const SECRET_ID = process.env.COS_SECRET_ID || "";
-const SECRET_KEY = process.env.COS_SECRET_KEY || "";
-const BUCKET = process.env.COS_BUCKET || "";
-const REGION = process.env.COS_REGION || "";
-const FILES_HOST =
-  process.env.WEBOFFICE_FILES_HOST || process.env.FILES_HOST || "";
-
-function getCosClient(): COS | null {
-  if (!SECRET_ID || !SECRET_KEY) return null;
-  return new COS({
-    SecretId: SECRET_ID,
-    SecretKey: SECRET_KEY,
-  });
-}
-
-export function isCosConfigured(): boolean {
-  return !!(SECRET_ID && SECRET_KEY && BUCKET && REGION);
-}
-
-export async function uploadToCos(localFilePath: string, key: string): Promise<void> {
-  const client = getCosClient();
-  if (!client) throw new Error("COS client not configured");
-  if (!BUCKET || !REGION) throw new Error("COS bucket/region not configured");
-  await client.putObject({
-    Bucket: BUCKET,
-    Region: REGION,
-    Key: key,
-    Body: fs.createReadStream(localFilePath),
-  });
-}
-
-export function getFilePublicUrl(key: string): string {
-  if (!FILES_HOST) return "";
-  const host = FILES_HOST.replace(/\/$/, "");
-  const k = key.replace(/^\//, "");
-  return `${host}/${k}`;
-}
-
-export function webofficeCosKey(fileId: string, version: number): string {
-  return `weboffice/files/${fileId}/v${version}`;
-}
-

package/template/src/libs/mCache.ts

@@ -1,7 +0,0 @@
-import { createCache, CacheType } from "@src/framework/utils/cache";
-
-// 使用统一的缓存管理创建用户缓存
-export const ytUserCache = createCache('yt-user', CacheType.USER, {
-    stdTTL: 600, // 10分钟过期
-    maxKeys: 500 // 用户缓存限制500个
-});

package/template/src/libs/serviceValidate.ts

@@ -1,3 +0,0 @@
-export const ServiceValidate = (params: any, instance: any, fn: Function, done: (err: any, param: any) => void) => {
-    console.log(params, instance, fn, done, "seravice拦截器");
-}   

package/template/src/libs/tecentSms.ts

@@ -1,51 +0,0 @@
-import * as tencentcloud from 'tencentcloud-sdk-nodejs';
-import { config } from 'dotenv';
-
-type SmsParams = {
-    PhoneNumberSet: string[];
-    TemplateId: string;
-    SignName: string;
-    TemplateParamSet?: string[];
-    SmsSdkAppId: string;
-};
-
-export class TencentSms {
-    private client: any;
-
-    constructor() {
-        config();
-        const SmsClient = tencentcloud.sms.v20210111.Client;
-
-        this.client = new SmsClient({
-            credential: {
-                secretId: process.env.TENCENT_SMS_SECRET_ID,
-                secretKey: process.env.TENCENT_SMS_SECRET_KEY,
-            },
-            region: process.env.TENCENT_SMS_REGION || 'ap-guangzhou',
-            profile: {
-                httpProfile: {
-                    endpoint: 'sms.tencentcloudapi.com',
-                },
-            },
-        });
-    }
-
-    async sendSms(params: SmsParams): Promise<any> {
-        try {
-            const request = {
-                PhoneNumberSet: params.PhoneNumberSet,
-                TemplateId: params.TemplateId,
-                SignName: params.SignName,
-                TemplateParamSet: params.TemplateParamSet || [],
-                SmsSdkAppId: params.SmsSdkAppId,
-            };
-
-            return await this.client.SendSms(request);
-        } catch (error) {
-            throw error;
-            //   throw new Error(`Failed to send SMS: ${error.message}`);
-        }
-    }
-}
-
-export const tencentSms = new TencentSms();

package/template/src/middlewares/a.middleware.ts

@@ -1,6 +0,0 @@
-export default function () {
-    return async (ctx: any, next: Function) => {
-        // console.log("a middleware ");
-        await next()
-    }
-}

package/template/src/middlewares/error.middleware.ts

@@ -1,14 +0,0 @@
-import { logger } from "@src/framework/utils/logger";
-
-export default function () {
-    return async (ctx: any, next: Function) => {
-        try {
-            await next();
-        } catch (err) {
-            const error = err as any;
-            ctx.status = 500;
-            logger.error((err as Error).message || 'Unknown error');
-            return ctx.body = error;
-        }
-    }
-}

package/template/src/middlewares/logging.middleware.ts

@@ -1,187 +0,0 @@
-import { Context, Next } from 'koa'
-import { logger, createRequestLogger } from '@src/framework/utils/logger'
-import { isDebug } from '@src/framework/utils/function'
-
-/**
- * 企业级日志中间件
- * 提供请求追踪、性能监控、安全审计等功能
- */
-export const loggingMiddleware = () => {
-  return async (ctx: Context, next: Next) => {
-    const startTime = Date.now()
-    const requestId = logger.generateRequestId()
-    
-    // 创建请求专用的日志器
-    const requestLogger = createRequestLogger(requestId)
-    
-    // 设置请求上下文
-    requestLogger.setRequestContext(
-      requestId,
-      ctx.state.user?.id,
-      ctx.session?.id
-    )
-
-    // 设置追踪上下文（如果存在）
-    const traceId = ctx.get('X-Trace-ID') || ctx.get('X-Request-ID')
-    if (traceId) {
-      requestLogger.setTraceContext(traceId, requestId)
-    }
-
-    // 记录请求开始 - 只在调试模式下记录详细信息
-    if (isDebug()) {
-      requestLogger.debug('Request started', {
-        method: ctx.method,
-        url: ctx.url,
-        userAgent: ctx.get('User-Agent'),
-        ip: ctx.ip,
-        headers: sanitizeHeaders(ctx.headers)
-      })
-    }
-
-    // 审计日志 - 请求访问（只在调试模式下输出到控制台）
-    if (isDebug()) {
-      requestLogger.audit('REQUEST_ACCESS', ctx.url, {
-        method: ctx.method,
-        ip: ctx.ip,
-        userAgent: ctx.get('User-Agent'),
-        userId: ctx.state.user?.id
-      })
-    }
-
-    // 将日志器添加到上下文
-    ctx.logger = requestLogger
-    ctx.requestId = requestId
-
-    try {
-      await next()
-      
-      const duration = Date.now() - startTime
-      
-      // 记录请求完成 - 只在调试模式或慢请求时记录
-      if (isDebug() || duration > 1000) {
-        requestLogger.info('Request completed', {
-          method: ctx.method,
-          url: ctx.url,
-          status: ctx.status,
-          duration: `${duration}ms`,
-          responseSize: ctx.response.length || 0
-        })
-      }
-
-      // 性能监控日志 - 只在调试模式下输出到控制台
-      if (isDebug()) {
-        requestLogger.performance('HTTP_REQUEST', duration, {
-          method: ctx.method,
-          url: ctx.url,
-          status: ctx.status,
-          responseSize: ctx.response.length || 0
-        })
-      }
-
-      // 安全审计 - 响应状态
-      if (ctx.status >= 400) {
-        requestLogger.security('HTTP_ERROR_RESPONSE', 
-          ctx.status >= 500 ? 'high' : 'medium', 
-          {
-            status: ctx.status,
-            method: ctx.method,
-            url: ctx.url,
-            userId: ctx.state.user?.id
-          }
-        )
-      }
-
-    } catch (error) {
-      const duration = Date.now() - startTime
-      
-      // 记录错误
-      requestLogger.error('Request failed', error as Error, {
-        method: ctx.method,
-        url: ctx.url,
-        duration: `${duration}ms`
-      })
-
-      // 安全审计 - 错误事件
-      requestLogger.security('REQUEST_ERROR', 'high', {
-        error: error instanceof Error ? error.message : 'Unknown error',
-        method: ctx.method,
-        url: ctx.url,
-        userId: ctx.state.user?.id
-      })
-
-      throw error
-    } finally {
-      // 清理上下文
-      requestLogger.clearContext()
-    }
-  }
-}
-
-/**
- * 脱敏请求头
- */
-function sanitizeHeaders(headers: any): any {
-  const sanitized = { ...headers }
-  const sensitiveHeaders = ['authorization', 'cookie', 'x-api-key', 'x-auth-token']
-  
-  sensitiveHeaders.forEach(header => {
-    if (sanitized[header]) {
-      sanitized[header] = '***REDACTED***'
-    }
-  })
-  
-  return sanitized
-}
-
-/**
- * 业务日志中间件
- * 用于记录业务操作
- */
-export const businessLoggingMiddleware = () => {
-  return async (ctx: Context, next: Next) => {
-    const originalBody = ctx.body
-    
-    await next()
-    
-    // 记录业务操作 - 注释掉，不在控制台输出
-    // 如果需要查看业务日志，请查看 logs/structured.log 文件
-    // if (ctx.logger && ctx.status < 400 && isDebug()) {
-    //   ctx.logger.business('API_CALL', {
-    //     method: ctx.method,
-    //     url: ctx.url,
-    //     status: ctx.status,
-    //     userId: ctx.state.user?.id,
-    //     timestamp: new Date().toISOString()
-    //   })
-    // }
-  }
-}
-
-/**
- * 数据库操作日志中间件
- */
-export const databaseLoggingMiddleware = () => {
-  return async (ctx: Context, next: Next) => {
-    const startTime = Date.now()
-    
-    await next()
-    
-    const duration = Date.now() - startTime
-    
-    if (ctx.logger && duration > 100) { // 只记录超过100ms的数据库操作
-      ctx.logger.performance('DATABASE_OPERATION', duration, {
-        method: ctx.method,
-        url: ctx.url,
-        userId: ctx.state.user?.id
-      })
-    }
-  }
-}
-
-// 扩展Context类型
-declare module 'koa' {
-  interface Context {
-    logger: any
-    requestId: string
-  }
-}

package/template/src/middlewares/static.middleware.ts

@@ -1,79 +0,0 @@
-import path from "path";
-import mount from "koa-mount";
-import serve from "koa-static";
-import { isDebug } from "@src/framework/utils/function";
-
-export interface StaticMiddlewareOptions {
-  /**
-   * URL 前缀，例如：/static
-   * - 不建议以 / 结尾
-   */
-  urlPrefix?: string;
-  /**
-   * 本地目录（相对项目根目录 process.cwd()），例如：assets / uploads
-   */
-  dir?: string;
-  /**
-   * 生产环境缓存秒数（Cache-Control max-age）
-   */
-  maxAgeSeconds?: number;
-  /**
-   * 访问前缀根路径时的默认文件，例如：index.html
-   * - false 表示不提供默认文件
-   */
-  index?: string | false;
-  /**
-   * 是否在 next() 之后再尝试提供静态文件（默认 false，优先静态）
-   */
-  defer?: boolean;
-  /**
-   * 是否允许访问隐藏文件（默认 false）
-   */
-  hidden?: boolean;
-}
-
-function normalizePrefix(prefix: string): string {
-  let p = prefix.trim();
-  if (!p.startsWith("/")) p = `/${p}`;
-  // 只保留末尾非根路径的前缀（避免 /static/ 和 /static 产生差异）
-  if (p.length > 1 && p.endsWith("/")) p = p.slice(0, -1);
-  return p;
-}
-
-/**
- * 静态文件映射中间件（基于 koa-static + koa-mount）
- * - 默认：/static -> ./static
- * - 支持环境变量覆盖：STATIC_URL_PREFIX、STATIC_DIR、STATIC_MAX_AGE_SECONDS、STATIC_INDEX
- */
-export default function staticMiddleware(options: StaticMiddlewareOptions = {}) {
-  const urlPrefix = normalizePrefix(
-    options.urlPrefix ?? process.env.STATIC_URL_PREFIX ?? "/static"
-  );
-  const dir = options.dir ?? process.env.STATIC_DIR ?? "static";
-  const root = path.resolve(process.cwd(), dir);
-  const index =
-    options.index ??
-    (typeof process.env.STATIC_INDEX === "string"
-      ? process.env.STATIC_INDEX
-      : false);
-
-  const maxAgeSeconds =
-    options.maxAgeSeconds ??
-    (process.env.STATIC_MAX_AGE_SECONDS
-      ? Number(process.env.STATIC_MAX_AGE_SECONDS)
-      : !isDebug()
-        ? 86400
-        : 0);
-
-  return mount(
-    urlPrefix,
-    serve(root, {
-      maxage: Math.max(0, maxAgeSeconds) * 1000,
-      index,
-      defer: options.defer ?? false,
-      hidden: options.hidden ?? false,
-    })
-  );
-}
-
-

package/template/src/middlewares/swagger.middleware.ts

@@ -1,70 +0,0 @@
-import { getSwaggerSpec } from '@src/framework/utils/swagger';
-import { logger } from '@src/framework/utils/logger';
-
-/**
- * Swagger UI中间件 - 简化版本
- */
-export function swaggerMiddleware() {
-  logger.info('Swagger UI已配置');
-  
-  return async (ctx: any, next: any) => {
-    if (ctx.path === '/swagger') {
-      ctx.set('Content-Type', 'text/html');
-      ctx.body = `
-        <!DOCTYPE html>
-        <html>
-        <head>
-          <title>DP Koa Framework API文档</title>
-          <link rel="stylesheet" type="text/css" href="https://unpkg.com/swagger-ui-dist@3.25.0/swagger-ui.css" />
-          <style>
-            .topbar { display: none !important; }
-            .swagger-ui .info { margin: 20px 0; }
-          </style>
-        </head>
-        <body>
-          <div id="swagger-ui"></div>
-          <script src="https://unpkg.com/swagger-ui-dist@3.25.0/swagger-ui-bundle.js"></script>
-          <script>
-            SwaggerUIBundle({
-              url: '/swagger.json',
-              dom_id: '#swagger-ui',
-              presets: [
-                SwaggerUIBundle.presets.apis,
-                SwaggerUIBundle.presets.standalone
-              ],
-              layout: "StandaloneLayout"
-            });
-          </script>
-        </body>
-        </html>
-      `;
-      return;
-    }
-    await next();
-  };
-}
-
-/**
- * Swagger JSON端点
- */
-export async function swaggerJson(ctx: any, next: any) {
-  if (ctx.path === '/swagger.json') {
-    try {
-      const swaggerSpec = getSwaggerSpec();
-      
-      // 动态从Controller中提取Swagger信息
-      // 这里可以集成现有的路由系统来生成完整的文档
-      
-      ctx.set('Content-Type', 'application/json');
-      ctx.body = swaggerSpec;
-    } catch (error) {
-      logger.error('生成Swagger文档失败:', error as Error);
-      ctx.status = 500;
-      ctx.body = { error: '无法生成Swagger文档' };
-    }
-    return;
-  }
-  
-  await next();
-}
-

package/template/src/middlewares/token.middleware.ts

@@ -1,32 +0,0 @@
-import * as jwt from "jsonwebtoken";
-import { Context } from "koa";
-import { getTokenFromHeader } from "@src/framework/utils/token";
-
-export default function tokenMiddleware() {
-    
-    return async (ctx: Context, next: Function) => {
-        // 1. 从请求头获取token
-        const token = getTokenFromHeader(ctx);
-        if (!token) {
-            ctx.status = 401;
-            ctx.body = { code: -1, message: "未提供认证token" };
-            return;
-        }
-
-        try {
-            // 2. 验证token
-            const decoded = jwt.verify(token, process.env.jwt_secret ?? "123456") as any;
-            
-            // 3. 将用户信息挂载到ctx.state
-            ctx.state.user = {
-                userId: decoded.userId,
-                type: decoded.type,
-            };
-            
-            await next();
-        } catch (err) {
-            ctx.status = 401;
-            ctx.body = { code: -1, message: "无效或过期的token" };
-        }
-    };
-}