create-dp-koa 1.1.1 → 1.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-dp-koa",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "Scaffold a DP-Koa framework project from the official template",
   "type": "module",
   "bin": {

package/template/scripts/sync-template.mjs

@@ -28,6 +28,21 @@ const EXCLUDED_SEGMENTS = new Set([
 /** 仓库根下整目录排除 */
 const EXCLUDED_TOP_LEVEL = new Set(['packages']);
 
+/**
+ * 不同步到模板的相对路径前缀（相对仓库根）
+ * 目标：让脚手架模板不再携带框架实现快照（framework/libs 等），改为依赖 npm 包。
+ */
+const EXCLUDED_RELATIVE_PREFIXES = [
+  'src/framework/',
+  'src/libs/',
+  'src/annotations/',
+  'src/middlewares/',
+  'src/examples/',
+  'src/repository/',
+  'src/migrations/',
+  'src/service/',
+];
+
 // template 内部“必须保留”的文件（防止后续 sync-template 直接覆盖回旧实现）
 // 相对路径以 DEST 为基准。
 const PRESERVE_RELATIVE_PATHS = [
@@ -38,11 +53,17 @@ const PRESERVE_RELATIVE_PATHS = [
   'src/controllers/demo/AnnotationDemoController.ts',
   'src/controllers/example/ExampleController.ts',
   'src/controllers/example/EnterpriseExampleController.ts',
+  'src/plugins/weboffice/http/routes.ts',
+  'src/plugins/registry.ts',
 ];
 
 function shouldCopySource(absSrc, baseRoot) {
   const rel = relative(baseRoot, absSrc);
   if (!rel || rel === '.') return true;
+  const normalized = rel.replace(/\\/g, '/');
+  for (const prefix of EXCLUDED_RELATIVE_PREFIXES) {
+    if (normalized === prefix.slice(0, -1) || normalized.startsWith(prefix)) return false;
+  }
   const parts = rel.split(/[/\\]/);
   for (const p of parts) {
     if (EXCLUDED_SEGMENTS.has(p)) return false;

package/template/src/app.ts

@@ -1,4 +1,3 @@
-import { DataSourceOptions } from "typeorm";
 import {
   bootstrap,
   setAfterBootstrap,
@@ -30,7 +29,7 @@ import {
   registerPluginRoutes,
   runAfterBootstrapHooks,
   runBeforeBootstrapHooks,
-} from "@src/framework/plugins/registry";
+} from "@src/plugins/registry";
 import Koa from "koa";
 import path from "path";
 

package/template/src/{framework/plugins → plugins}/registry.ts

@@ -1,7 +1,7 @@
 import type Koa from "koa";
 import type Router from "koa-router";
-import type { PluginDescriptor } from "@src/framework/plugins/types";
-import { logger } from "@src/framework/utils/logger";
+import type { PluginDescriptor } from "dp-koa-framework-core";
+import { logger } from "dp-koa-framework-core";
 
 // 示例插件（可按需添加/移除）
 import { plugin as webofficePlugin } from "@src/plugins/weboffice";

package/template/src/plugins/weboffice/http/routes.ts

@@ -3,7 +3,7 @@ import { Provider } from "dp-ioc2";
 import { WebofficeCallbackService } from "../services/webofficeCallback.service";
 import { parseWebOfficeContext } from "../core/context";
 import { OK, WebOfficeError, ErrInvalidArguments } from "../core/errors";
-import { logger } from "@src/framework/utils/logger";
+import { logger } from "dp-koa-framework-core";
 import path from "path";
 import fs from "fs";
 
@@ -33,7 +33,7 @@ function registerUnderPrefix(router: Router, basePath: string): void {
   router.post(`${base}/files`, async (ctx) => {
     try {
       const woCtx = parseWebOfficeContext(ctx);
-      const body = (ctx.request.body as any) || {};
+      const body = ((ctx.request as any).body as any) || {};
       const name = body.name || "未命名文档";
       const projectId = body.project_id != null ? Number(body.project_id) : undefined;
       const data = await service.createDocument(woCtx, name, projectId);

package/template/src/plugins/weboffice/index.ts

@@ -1,14 +1,14 @@
 import type Router from "koa-router";
 import type Koa from "koa";
-import type { PluginDescriptor } from "@src/framework/plugins/types";
+import type { PluginDescriptor } from "dp-koa-framework-core";
 import { registerWebOfficeRoutes } from "./http/routes";
 import { WebofficeFileEntity, WebofficeFileVersionEntity } from "./entities";
-import { logger } from "@src/framework/utils/logger";
+import { logger } from "dp-koa-framework-core";
 
 export const plugin: PluginDescriptor = {
   id: "weboffice",
   displayName: "WPS WebOffice 示例插件",
-  enabled: (env) => env.WEBOFFICE_ENABLED !== "0",
+  enabled: (env: NodeJS.ProcessEnv) => env.WEBOFFICE_ENABLED !== "0",
 
   onBeforeBootstrap(_app: Koa) {
     logger.info('Plugin "weboffice" before bootstrap');

package/template/src/plugins/weboffice/services/webofficeCallback.service.ts

@@ -1,5 +1,5 @@
 import { Injectable } from "dp-ioc2";
-import { BaseService } from "@src/service/base.service";
+import { BaseService, logger } from "dp-koa-framework-core";
 import { WebofficeFileEntity } from "../entities/webofficeFile.entity";
 import { WebofficeFileVersionEntity } from "../entities/webofficeFileVersion.entity";
 import {
@@ -18,8 +18,7 @@ import {
   ErrInternalError,
 } from "../core/errors";
 import { normalizeWpsUserId } from "../core/utils";
-import { getFilePublicUrl, isCosConfigured, uploadToCos, webofficeCosKey } from "@src/libs/cos";
-import { logger } from "@src/framework/utils/logger";
+import { getFilePublicUrl, isCosConfigured, uploadToCos, webofficeCosKey } from "dp-koa-framework-libs";
 import fs from "fs";
 import { v4 as uuidv4 } from "uuid";
 
@@ -229,7 +228,7 @@ export class WebofficeCallbackService extends BaseService {
       skip: offset,
       take: limit,
     });
-    return versions.map((v) => this.toGetFileReply(pair.file, v));
+    return versions.map((v: WebofficeFileVersionEntity) => this.toGetFileReply(pair.file, v));
   }
 
   async getFileVersion(

package/template/src/utils/testDataInitializer.ts

@@ -1,4 +1,4 @@
-import { logger } from "@src/framework/utils/logger";
+import { logger } from "dp-koa-framework-core";
 
 /**
  * 测试数据初始化工具

package/template/tsconfig.json

@@ -15,6 +15,12 @@
       "@src/*": [
         "./src/*"
       ],
+      "dp-koa-framework-core": [
+        "../../dp-koa-framework-core/dist/index.d.ts"
+      ],
+      "dp-koa-framework-libs": [
+        "../../dp-koa-framework-libs/dist/index.d.ts"
+      ]
     },
     "strictPropertyInitialization": false
   },

package/template/src/annotations/decorators/ConfigManagement.ts

@@ -1,9 +0,0 @@
-/**
- * 企业级配置管理装饰器
- */
-import { createAnnotationDecorator } from '@src/framework/decorator/processor/AnnotationDecorators';
-import { ConfigManagementConfig } from '@src/annotations/processors/ConfigManagementProcessor';
-
-export function ConfigManagement(config?: ConfigManagementConfig) {
-    return createAnnotationDecorator('ConfigManagement')(config);
-}

package/template/src/annotations/decorators/DistributedTracing.ts

@@ -1,9 +0,0 @@
-/**
- * 企业级分布式追踪装饰器
- */
-import { createAnnotationDecorator } from '@src/framework/decorator/processor/AnnotationDecorators';
-import { TracingConfig } from '@src/annotations/processors/DistributedTracingProcessor';
-
-export function DistributedTracing(config?: TracingConfig) {
-    return createAnnotationDecorator('DistributedTracing')(config);
-}

package/template/src/annotations/decorators/EnterprisePerformance.ts

@@ -1,9 +0,0 @@
-/**
- * 企业级性能监控装饰器
- */
-import { createAnnotationDecorator } from '@src/framework/decorator/processor/AnnotationDecorators';
-import { PerformanceConfig } from '@src/annotations/processors/EnterprisePerformanceProcessor';
-
-export function EnterprisePerformance(config?: PerformanceConfig) {
-    return createAnnotationDecorator('EnterprisePerformance')(config);
-}

package/template/src/annotations/decorators/PerformanceMonitor.ts

@@ -1,32 +0,0 @@
-import { createAnnotationDecorator } from '@src/framework/decorator/processor/AnnotationDecorators';
-
-/**
- * 性能监控注解配置接口
- */
-export interface PerformanceMonitorConfig {
-    /** 最大执行时间（毫秒） */
-    maxExecutionTime?: number;
-    /** 最大内存使用变化（MB） */
-    maxMemoryUsage?: number;
-    /** 是否启用详细日志 */
-    verbose?: boolean;
-}
-
-/**
- * 性能监控注解
- * 用于监控方法执行性能，包括执行时间和内存使用
- * 
- * @example
- * ```typescript
- * @PerformanceMonitor()
- * async getData() {
- *     return { data: 'example' };
- * }
- * 
- * @PerformanceMonitor({ maxExecutionTime: 1000, maxMemoryUsage: 10 })
- * async heavyOperation() {
- *     // 执行耗时操作
- * }
- * ```
- */
-export const PerformanceMonitor = createAnnotationDecorator('PerformanceMonitor');

package/template/src/annotations/decorators/SecurityAudit.ts

@@ -1,9 +0,0 @@
-/**
- * 企业级安全审计装饰器
- */
-import { createAnnotationDecorator } from '@src/framework/decorator/processor/AnnotationDecorators';
-import { SecurityAuditConfig } from '@src/annotations/processors/SecurityAuditProcessor';
-
-export function SecurityAudit(config?: SecurityAuditConfig) {
-    return createAnnotationDecorator('SecurityAudit')(config);
-}

package/template/src/annotations/index.ts

@@ -1,50 +0,0 @@
-/**
- * 企业级业务层注解导出文件
- * 统一导出所有自定义注解处理器和装饰器
- */
-
-// 导出基础注解处理器
-export { PerformanceMonitorProcessor } from './processors/PerformanceMonitorProcessor';
-
-// 导出企业级注解处理器
-export { EnterprisePerformanceProcessor } from './processors/EnterprisePerformanceProcessor';
-export { SecurityAuditProcessor } from './processors/SecurityAuditProcessor';
-export { DistributedTracingProcessor } from './processors/DistributedTracingProcessor';
-export { ConfigManagementProcessor } from './processors/ConfigManagementProcessor';
-
-// 导出基础注解装饰器
-export { PerformanceMonitor, type PerformanceMonitorConfig } from './decorators/PerformanceMonitor';
-
-// 导出企业级注解装饰器
-export { EnterprisePerformance } from './decorators/EnterprisePerformance';
-export { SecurityAudit } from './decorators/SecurityAudit';
-export { DistributedTracing } from './decorators/DistributedTracing';
-export { ConfigManagement } from './decorators/ConfigManagement';
-
-// 导出类型定义
-export type { PerformanceConfig } from './processors/EnterprisePerformanceProcessor';
-export type { SecurityAuditConfig } from './processors/SecurityAuditProcessor';
-export type { TracingConfig } from './processors/DistributedTracingProcessor';
-export type { ConfigManagementConfig } from './processors/ConfigManagementProcessor';
-
-/**
- * 获取所有业务层注解处理器
- * 用于在注解系统初始化时注册
- */
-export function getBusinessAnnotationProcessors() {
-    const { 
-        PerformanceMonitorProcessor,
-        EnterprisePerformanceProcessor,
-        SecurityAuditProcessor,
-        DistributedTracingProcessor,
-        ConfigManagementProcessor
-    } = require('@src/annotations/processors');
-    
-    return [
-        new PerformanceMonitorProcessor(),
-        new EnterprisePerformanceProcessor(),
-        new SecurityAuditProcessor(),
-        new DistributedTracingProcessor(),
-        new ConfigManagementProcessor()
-    ];
-}

package/template/src/annotations/processors/ConfigManagementProcessor.ts

@@ -1,369 +0,0 @@
-/**
- * 企业级配置管理注解处理器
- * 提供动态配置、环境变量管理和配置验证
- */
-
-import { Context } from 'koa';
-import { AnnotationProcessor } from '@src/framework/decorator/processor/AnnotationProcessor';
-import { logger } from '@src/framework/utils/logger';
-import { getRuntimeEnvironmentLabel } from '@src/framework/utils/function';
-
-export interface ConfigManagementConfig {
-    configKey?: string;
-    defaultValue?: any;
-    required?: boolean;
-    validationRules?: ValidationRule[];
-    refreshInterval?: number;
-    environment?: 'development' | 'staging' | 'production';
-    fallbackConfig?: Record<string, any>;
-}
-
-export interface ValidationRule {
-    type: 'string' | 'number' | 'boolean' | 'array' | 'object' | 'email' | 'url';
-    min?: number;
-    max?: number;
-    pattern?: RegExp;
-    custom?: (value: any) => boolean;
-    message?: string;
-}
-
-export interface ConfigValue {
-    key: string;
-    value: any;
-    source: 'environment' | 'database' | 'file' | 'default';
-    lastUpdated: Date;
-    environment: string;
-    validated: boolean;
-}
-
-export class ConfigManagementProcessor implements AnnotationProcessor {
-    readonly name = 'ConfigManagement';
-    readonly priority = 4;
-
-    private configCache: Map<string, ConfigValue> = new Map();
-    private validationRules: Map<string, ValidationRule[]> = new Map();
-    private refreshTimers: Map<string, NodeJS.Timeout> = new Map();
-    private configRefreshInterval: NodeJS.Timeout | null = null; // 存储定时器引用
-
-    constructor() {
-        this.loadEnvironmentConfigs();
-        this.startConfigRefresh();
-    }
-
-    async process(
-        ctx: Context,
-        controller: any,
-        methodName: string,
-        annotationData: ConfigManagementConfig,
-        callParams: any[]
-    ): Promise<boolean> {
-        const config = annotationData || {};
-        
-        if (!config.configKey) return true;
-
-        try {
-            // 获取配置值
-            const configValue = await this.getConfigValue(config.configKey, config);
-            
-            // 验证配置
-            if (config.validationRules) {
-                const isValid = this.validateConfig(config.configKey, configValue.value, config.validationRules);
-                if (!isValid) {
-                    logger.error(`[${this.name}] 配置验证失败: ${config.configKey}`);
-                    ctx.status = 500;
-                    ctx.body = { error: 'Configuration validation failed' };
-                    return false;
-                }
-            }
-
-            // 将配置注入到上下文
-            ctx.state.config = ctx.state.config || {};
-            ctx.state.config[config.configKey] = configValue.value;
-
-            logger.debug(`[${this.name}] 配置加载成功: ${config.configKey}`, {
-                value: this.sanitizeValue(configValue.value),
-                source: configValue.source
-            });
-
-        } catch (error) {
-            logger.error(`[${this.name}] 配置加载失败: ${config.configKey}`, error as Error);
-            
-            if (config.required) {
-                ctx.status = 500;
-                ctx.body = { error: 'Required configuration missing' };
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-    private async getConfigValue(key: string, config: ConfigManagementConfig): Promise<ConfigValue> {
-        // 检查缓存
-        const cached = this.configCache.get(key);
-        if (cached && this.isCacheValid(cached)) {
-            return cached;
-        }
-
-        let value: any;
-        let source: ConfigValue['source'] = 'default';
-
-        // 1. 尝试从环境变量获取
-        const envValue = process.env[key.toUpperCase()];
-        if (envValue !== undefined) {
-            value = this.parseValue(envValue);
-            source = 'environment';
-        }
-        // 2. 尝试从数据库获取
-        else if (await this.hasDatabaseConfig(key)) {
-            value = await this.getDatabaseConfig(key);
-            source = 'database';
-        }
-        // 3. 尝试从配置文件获取
-        else if (await this.hasFileConfig(key)) {
-            value = await this.getFileConfig(key);
-            source = 'file';
-        }
-        // 4. 使用默认值
-        else {
-            value = config.defaultValue;
-            source = 'default';
-        }
-
-        const configValue: ConfigValue = {
-            key,
-            value,
-            source,
-            lastUpdated: new Date(),
-            environment: config.environment || getRuntimeEnvironmentLabel(),
-            validated: false
-        };
-
-        // 缓存配置
-        this.configCache.set(key, configValue);
-
-        return configValue;
-    }
-
-    private parseValue(value: string): any {
-        // 尝试解析 JSON
-        try {
-            return JSON.parse(value);
-        } catch {
-            // 尝试解析布尔值
-            if (value.toLowerCase() === 'true') return true;
-            if (value.toLowerCase() === 'false') return false;
-            
-            // 尝试解析数字
-            const num = Number(value);
-            if (!isNaN(num)) return num;
-            
-            // 返回字符串
-            return value;
-        }
-    }
-
-    private validateConfig(key: string, value: any, rules: ValidationRule[]): boolean {
-        for (const rule of rules) {
-            if (!this.validateRule(value, rule)) {
-                logger.warn(`[${this.name}] 配置验证失败: ${key}`, {
-                    value: this.sanitizeValue(value),
-                    rule: rule.type,
-                    message: rule.message
-                });
-                return false;
-            }
-        }
-        return true;
-    }
-
-    private validateRule(value: any, rule: ValidationRule): boolean {
-        switch (rule.type) {
-            case 'string':
-                if (typeof value !== 'string') return false;
-                if (rule.min && value.length < rule.min) return false;
-                if (rule.max && value.length > rule.max) return false;
-                if (rule.pattern && !rule.pattern.test(value)) return false;
-                break;
-
-            case 'number':
-                if (typeof value !== 'number') return false;
-                if (rule.min && value < rule.min) return false;
-                if (rule.max && value > rule.max) return false;
-                break;
-
-            case 'boolean':
-                if (typeof value !== 'boolean') return false;
-                break;
-
-            case 'array':
-                if (!Array.isArray(value)) return false;
-                if (rule.min && value.length < rule.min) return false;
-                if (rule.max && value.length > rule.max) return false;
-                break;
-
-            case 'object':
-                if (typeof value !== 'object' || value === null) return false;
-                break;
-
-            case 'email':
-                if (typeof value !== 'string' || !/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(value)) return false;
-                break;
-
-            case 'url':
-                if (typeof value !== 'string' || !/^https?:\/\/.+/.test(value)) return false;
-                break;
-        }
-
-        // 自定义验证
-        if (rule.custom && !rule.custom(value)) return false;
-
-        return true;
-    }
-
-    private async hasDatabaseConfig(key: string): Promise<boolean> {
-        // 这里应该实现数据库配置检查
-        return false;
-    }
-
-    private async getDatabaseConfig(key: string): Promise<any> {
-        // 这里应该实现数据库配置获取
-        return null;
-    }
-
-    private async hasFileConfig(key: string): Promise<boolean> {
-        // 这里应该实现文件配置检查
-        return false;
-    }
-
-    private async getFileConfig(key: string): Promise<any> {
-        // 这里应该实现文件配置获取
-        return null;
-    }
-
-    private isCacheValid(configValue: ConfigValue): boolean {
-        const maxAge = 5 * 60 * 1000; // 5分钟
-        return Date.now() - configValue.lastUpdated.getTime() < maxAge;
-    }
-
-    private sanitizeValue(value: any): any {
-        if (typeof value === 'string' && value.length > 100) {
-            return value.substring(0, 100) + '...';
-        }
-        return value;
-    }
-
-    private loadEnvironmentConfigs(): void {
-        // 加载环境变量配置
-        Object.keys(process.env).forEach(key => {
-            if (key.startsWith('CONFIG_')) {
-                const configKey = key.substring(7).toLowerCase();
-                const value = this.parseValue(process.env[key]!);
-                
-                this.configCache.set(configKey, {
-                    key: configKey,
-                    value,
-                    source: 'environment',
-                    lastUpdated: new Date(),
-                    environment: getRuntimeEnvironmentLabel(),
-                    validated: false
-                });
-            }
-        });
-    }
-
-    private startConfigRefresh(): void {
-        // 如果已有定时器，先清除
-        if (this.configRefreshInterval) {
-            clearInterval(this.configRefreshInterval);
-        }
-        
-        // 定期刷新配置
-        this.configRefreshInterval = setInterval(() => {
-            this.refreshConfigs();
-        }, 60000); // 每分钟刷新一次
-    }
-
-    /**
-     * 停止配置刷新定时器
-     * 防止内存泄露
-     */
-    stopConfigRefresh(): void {
-        if (this.configRefreshInterval) {
-            clearInterval(this.configRefreshInterval);
-            this.configRefreshInterval = null;
-            logger.info(`[${this.name}] 配置刷新定时器已停止`);
-        }
-    }
-
-    /**
-     * 清理所有定时器
-     */
-    cleanup(): void {
-        // 清理主刷新定时器
-        this.stopConfigRefresh();
-        
-        // 清理所有独立的刷新定时器
-        this.refreshTimers.forEach((timer) => {
-            clearInterval(timer);
-        });
-        this.refreshTimers.clear();
-        
-        // 清理缓存
-        this.configCache.clear();
-        this.validationRules.clear();
-        
-        logger.info(`[${this.name}] 所有资源已清理`);
-    }
-
-    private async refreshConfigs(): Promise<void> {
-        const keys = Array.from(this.configCache.keys());
-        
-        for (const key of keys) {
-            try {
-                const cached = this.configCache.get(key)!;
-                if (cached.source === 'environment') {
-                    // 环境变量配置不需要刷新
-                    continue;
-                }
-
-                // 重新加载配置
-                const newValue = await this.getConfigValue(key, {});
-                if (JSON.stringify(newValue.value) !== JSON.stringify(cached.value)) {
-                    logger.info(`[${this.name}] 配置已更新: ${key}`);
-                }
-            } catch (error) {
-                logger.error(`[${this.name}] 配置刷新失败: ${key}`, error as Error);
-            }
-        }
-    }
-
-    /**
-     * 获取所有配置
-     */
-    getAllConfigs(): ConfigValue[] {
-        return Array.from(this.configCache.values());
-    }
-
-    /**
-     * 获取指定配置
-     */
-    getConfig(key: string): ConfigValue | undefined {
-        return this.configCache.get(key);
-    }
-
-    /**
-     * 设置配置验证规则
-     */
-    setValidationRules(key: string, rules: ValidationRule[]): void {
-        this.validationRules.set(key, rules);
-    }
-
-    /**
-     * 清理配置缓存
-     */
-    clearCache(): void {
-        this.configCache.clear();
-        logger.info(`[${this.name}] 配置缓存已清理`);
-    }
-}