npm - create-dp-koa - Versions diffs - 1.0.0 - Mend

create-dp-koa 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (235) hide show

package/README.md +50 -0
package/index.mjs +97 -0
package/package.json +33 -0
package/template/.env.development +9 -0
package/template/.env.production +12 -0
package/template/.github/workflows/ci-cd.yml +182 -0
package/template/.trae/documents/controller_development_plan.md +386 -0
package/template/.trae/skills/00-backend-core.skill.md +50 -0
package/template/.trae/skills/01-backend-skill-router.skill.md +55 -0
package/template/.trae/skills/10-backend-api.skill.md +54 -0
package/template/.trae/skills/11-backend-controller-recipes.skill.md +107 -0
package/template/.trae/skills/20-backend-repository.skill.md +25 -0
package/template/.trae/skills/21-backend-service.skill.md +135 -0
package/template/.trae/skills/25-backend-comments-and-doc.skill.md +97 -0
package/template/.trae/skills/30-backend-validation.skill.md +320 -0
package/template/.trae/skills/40-backend-error-logging.skill.md +21 -0
package/template/.trae/skills/50-backend-bootstrap-lifecycle.skill.md +90 -0
package/template/.trae/skills/60-backend-router-registration.skill.md +71 -0
package/template/.trae/skills/70-backend-middleware.skill.md +98 -0
package/template/.trae/skills/80-backend-utils-and-libs.skill.md +90 -0
package/template/.trae/skills/85-backend-plugins.rule.md +64 -0
package/template/.trae/skills/90-backend-testing.skill.md +29 -0
package/template/.trae/skills/README.md +49 -0
package/template/.vscode/launch.json +38 -0
package/template/.vscode/settings.json +1 -0
package/template/Dockerfile +36 -0
package/template/README.md +229 -0
package/template/docker-compose.yml +135 -0
package/template/docs/API_DOCUMENTATION.md +837 -0
package/template/docs/ARCHITECTURE_REFACTOR.md +109 -0
package/template/docs/CACHE_MIGRATION_GUIDE.md +142 -0
package/template/docs/DEPLOYMENT_GUIDE.md +1062 -0
package/template/docs/DEVELOPMENT_GUIDE.md +1097 -0
package/template/docs/DOCUMENTATION_CLEANUP_REPORT.md +166 -0
package/template/docs/DOCUMENTATION_COMPLETION_REPORT.md +223 -0
package/template/docs/DOCUMENTATION_INDEX.md +294 -0
package/template/docs/DOCUMENTATION_STRUCTURE.md +221 -0
package/template/docs/ENTERPRISE_ANNOTATION_SYSTEM_GUIDE.md +2069 -0
package/template/docs/ENTERPRISE_DATABASE_ARCHITECTURE.md +318 -0
package/template/docs/ENTERPRISE_DEPLOYMENT_GUIDE.md +547 -0
package/template/docs/ENTERPRISE_ERROR_HANDLING_GUIDE.md +357 -0
package/template/docs/ENTERPRISE_LOGGING_SYSTEM_GUIDE.md +494 -0
package/template/docs/ENVIRONMENT_CONFIG_EXAMPLE.md +69 -0
package/template/docs/FINAL_IMPLEMENTATION_SUMMARY.md +206 -0
package/template/docs/HEALTH_CHECK_ROUTE_FIX.md +134 -0
package/template/docs/IMPLEMENTATION_CHECKLIST.md +204 -0
package/template/docs/INSTALLATION_GUIDE.md +611 -0
package/template/docs/INTERCEPTOR_TESTING_REPORT.md +226 -0
package/template/docs/INTERCEPTOR_TESTING_SCRIPTS.md +143 -0
package/template/docs/LOGGING_OPTIMIZATION_GUIDE.md +126 -0
package/template/docs/MEMORY_DATABASE_GUIDE.md +212 -0
package/template/docs/NEW_ROUTER_INTEGRATION_GUIDE.md +345 -0
package/template/docs/NEW_ROUTER_INTEGRATION_SUMMARY.md +259 -0
package/template/docs/NEW_ROUTER_USAGE_GUIDE.md +364 -0
package/template/docs/QUICK_START.md +268 -0
package/template/docs/ROUTE_SLASH_COMPATIBILITY_FIX.md +191 -0
package/template/docs/SERVICE_INTERCEPTOR_GUIDE.md +243 -0
package/template/docs/SERVICE_LAYER_INDEX.md +205 -0
package/template/docs/SERVICE_PATTERN_GUIDE.md +270 -0
package/template/docs/SERVICE_RETURN_VALUE_SPECIFICATION.md +466 -0
package/template/docs/SWAGGER_DEBUG_MODE_GUIDE.md +80 -0
package/template/docs/SWAGGER_INTEGRATION_GUIDE.md +416 -0
package/template/docs/TRANSACTION_MANAGER_USAGE.md +360 -0
package/template/docs/TROUBLESHOOTING.md +869 -0
package/template/env.production.example +62 -0
package/template/jest.config.js +34 -0
package/template/package-lock.json +13240 -0
package/template/package.json +119 -0
package/template/patches/typeorm+0.3.25.patch +22 -0
package/template/scripts/sync-template.mjs +84 -0
package/template/scripts/test-annotation-system.sh +48 -0
package/template/scripts/test-core-functionality.sh +28 -0
package/template/src/annotations/decorators/ConfigManagement.ts +9 -0
package/template/src/annotations/decorators/DistributedTracing.ts +9 -0
package/template/src/annotations/decorators/EnterprisePerformance.ts +9 -0
package/template/src/annotations/decorators/PerformanceMonitor.ts +32 -0
package/template/src/annotations/decorators/SecurityAudit.ts +9 -0
package/template/src/annotations/index.ts +50 -0
package/template/src/annotations/processors/ConfigManagementProcessor.ts +369 -0
package/template/src/annotations/processors/DistributedTracingProcessor.ts +288 -0
package/template/src/annotations/processors/EnterprisePerformanceProcessor.ts +189 -0
package/template/src/annotations/processors/PerformanceMonitorProcessor.ts +101 -0
package/template/src/annotations/processors/SecurityAuditProcessor.ts +345 -0
package/template/src/annotations/processors/SwaggerProcessor.ts +612 -0
package/template/src/annotations/processors/index.ts +10 -0
package/template/src/app.ts +123 -0
package/template/src/controllers/base.controller.ts +41 -0
package/template/src/controllers/cacheManagement.controller.ts +131 -0
package/template/src/controllers/captcha.controller.ts +57 -0
package/template/src/controllers/demo/AnnotationDemoController.ts +118 -0
package/template/src/controllers/example/EnterpriseExampleController.ts +297 -0
package/template/src/controllers/example/ExampleController.ts +110 -0
package/template/src/controllers/example/NewAnnotationExampleController.ts +159 -0
package/template/src/controllers/example/SwaggerExampleController.ts +205 -0
package/template/src/controllers/example/TransactionExample.controller.ts +336 -0
package/template/src/controllers/health.controller.ts +235 -0
package/template/src/controllers/home/register.controller.ts +58 -0
package/template/src/controllers/home/ytGoods.controller.ts +92 -0
package/template/src/controllers/home/ytShop.controller.ts +135 -0
package/template/src/controllers/home/ytUser.controller.ts +89 -0
package/template/src/controllers/logManagement.controller.ts +396 -0
package/template/src/controllers/public/emailSend.controller.ts +65 -0
package/template/src/controllers/public/ytUserAuth.controller.ts +174 -0
package/template/src/controllers/testData.controller.ts +253 -0
package/template/src/dto/controller/example/NewAnnotationExampleController.dto.ts +73 -0
package/template/src/dto/controller/home/emailSend.controller.dto.ts +40 -0
package/template/src/dto/controller/home/register.controller.dto.ts +45 -0
package/template/src/dto/controller/home/ytGoods.controller.dto.ts +55 -0
package/template/src/dto/controller/home/ytShop.controller.dto.ts +69 -0
package/template/src/dto/controller/home/ytUser.controller.dto.ts +44 -0
package/template/src/dto/controller/public/ytUserAuth.controller.dto.ts +63 -0
package/template/src/dto/goods.dto.ts +212 -0
package/template/src/dto/service/ytService.dto.ts +13 -0
package/template/src/dto/user.dto.ts +177 -0
package/template/src/entity/base.entity.ts +13 -0
package/template/src/entity/columnTypes.ts +13 -0
package/template/src/entity/goodsImagesUnlockKey.entity.ts +33 -0
package/template/src/entity/goodsUnlocker.entity.ts +34 -0
package/template/src/entity/index.ts +15 -0
package/template/src/entity/shop.entity.ts +52 -0
package/template/src/entity/shopUser.entity.ts +41 -0
package/template/src/entity/ytGoods.entity.ts +94 -0
package/template/src/entity/ytUser.entity.ts +96 -0
package/template/src/examples/InterceptorExampleRunner.ts +284 -0
package/template/src/examples/ServiceInterceptorExample.ts +214 -0
package/template/src/examples/SwaggerProcessorExample.ts +169 -0
package/template/src/examples/TransactionManagerDemo.ts +377 -0
package/template/src/examples/cacheExamples.ts +155 -0
package/template/src/framework/decorator/controller.ts +311 -0
package/template/src/framework/decorator/processor/AnnotationDecorators.ts +100 -0
package/template/src/framework/decorator/processor/AnnotationProcessor.ts +156 -0
package/template/src/framework/decorator/processor/AnnotationProcessorConfig.ts +45 -0
package/template/src/framework/decorator/processor/AnnotationRegistry.ts +117 -0
package/template/src/framework/decorator/processor/AnnotationSystemInitializer.ts +95 -0
package/template/src/framework/decorator/processor/ProcessorManager.ts +76 -0
package/template/src/framework/decorator/processor/processors/CustomProcessors.ts +126 -0
package/template/src/framework/decorator/processor/processors/DefaultProcessors.ts +207 -0
package/template/src/framework/decorator/refactored/DecoratorFactory.ts +99 -0
package/template/src/framework/decorator/refactored/DecoratorMetadataManager.ts +125 -0
package/template/src/framework/decorator/refactored/DecoratorValidator.ts +128 -0
package/template/src/framework/decorator/refactored/TypeSafeDecorators.ts +139 -0
package/template/src/framework/decorator/refactored/index.ts +98 -0
package/template/src/framework/decorator/swagger.ts +150 -0
package/template/src/framework/interceptors/AdvancedServiceCallInterceptor.ts +375 -0
package/template/src/framework/interceptors/ServiceCallInterceptor.ts +348 -0
package/template/src/framework/interceptors/index.ts +19 -0
package/template/src/framework/plugins/registry.ts +63 -0
package/template/src/framework/plugins/types.ts +15 -0
package/template/src/framework/types/ServiceResult.ts +151 -0
package/template/src/framework/types/index.ts +16 -0
package/template/src/framework/utils/CacheManager.ts +430 -0
package/template/src/framework/utils/CacheService.ts +248 -0
package/template/src/framework/utils/DtoValidator.ts +164 -0
package/template/src/framework/utils/MigrationHelper.ts +179 -0
package/template/src/framework/utils/MigrationManager.ts +256 -0
package/template/src/framework/utils/NewRouter.ts +207 -0
package/template/src/framework/utils/TransactionManager.ts +172 -0
package/template/src/framework/utils/bootstrap.ts +445 -0
package/template/src/framework/utils/cache.ts +269 -0
package/template/src/framework/utils/databaseConfig.ts +148 -0
package/template/src/framework/utils/db.ts +39 -0
package/template/src/framework/utils/dbMonitor.ts +106 -0
package/template/src/framework/utils/dynamicSwagger.ts +410 -0
package/template/src/framework/utils/function.ts +61 -0
package/template/src/framework/utils/gracefulShutdown.ts +131 -0
package/template/src/framework/utils/logger.ts +388 -0
package/template/src/framework/utils/metrics.ts +182 -0
package/template/src/framework/utils/router.ts +417 -0
package/template/src/framework/utils/swagger.ts +184 -0
package/template/src/framework/utils/testDb.ts +19 -0
package/template/src/framework/utils/token.ts +23 -0
package/template/src/framework/utils/transform.ts +17 -0
package/template/src/libs/aokEmailSender.ts +42 -0
package/template/src/libs/captcha.ts +37 -0
package/template/src/libs/cos.ts +45 -0
package/template/src/libs/mCache.ts +7 -0
package/template/src/libs/serviceValidate.ts +3 -0
package/template/src/libs/tecentSms.ts +51 -0
package/template/src/middlewares/a.middleware.ts +6 -0
package/template/src/middlewares/error.middleware.ts +14 -0
package/template/src/middlewares/logging.middleware.ts +187 -0
package/template/src/middlewares/static.middleware.ts +79 -0
package/template/src/middlewares/swagger.middleware.ts +70 -0
package/template/src/middlewares/token.middleware.ts +32 -0
package/template/src/migrations/1700000000000-InitialDatabaseStructure.ts +172 -0
package/template/src/migrations/index.ts +6 -0
package/template/src/plugins/weboffice/core/context.ts +47 -0
package/template/src/plugins/weboffice/core/errors.ts +51 -0
package/template/src/plugins/weboffice/core/types.ts +63 -0
package/template/src/plugins/weboffice/core/utils.ts +7 -0
package/template/src/plugins/weboffice/entities/index.ts +3 -0
package/template/src/plugins/weboffice/entities/webofficeFile.entity.ts +28 -0
package/template/src/plugins/weboffice/entities/webofficeFileVersion.entity.ts +29 -0
package/template/src/plugins/weboffice/http/routes.ts +179 -0
package/template/src/plugins/weboffice/index.ts +23 -0
package/template/src/plugins/weboffice/services/webofficeCallback.service.ts +274 -0
package/template/src/repository/UserRepository.ts +122 -0
package/template/src/repository/base/BaseRepository.ts +124 -0
package/template/src/repository/interfaces/IBaseRepository.ts +67 -0
package/template/src/routers/index.ts +49 -0
package/template/src/service/base.service.ts +116 -0
package/template/src/service/paramValidateTest.service.ts +139 -0
package/template/src/service/ytGoods.service.ts +42 -0
package/template/src/service/ytShop.service.ts +90 -0
package/template/src/service/ytUser.service.ts +451 -0
package/template/src/test/swaggerParameterTest.ts +90 -0
package/template/src/utils/testDataInitializer.ts +296 -0
package/template/static/output.json +15203 -0
package/template/test/controllers/controllers.test.ts +173 -0
package/template/test/controllers/example/ExampleController.test.ts +222 -0
package/template/test/controllers/example/NewAnnotationExampleController.test.ts +200 -0
package/template/test/framework/TransactionManagerDemo.test.ts +363 -0
package/template/test/framework/annotation/AnnotationDecorators.test.ts +222 -0
package/template/test/framework/annotation/AnnotationExecutor.test.ts +246 -0
package/template/test/framework/annotation/AnnotationProcessor.test.ts +179 -0
package/template/test/framework/annotation/CustomProcessors.test.ts +313 -0
package/template/test/framework/annotation/DefaultProcessors.test.ts +371 -0
package/template/test/framework/annotation/NewRouter.test.ts +272 -0
package/template/test/framework/annotation/ProcessorManager.test.ts +248 -0
package/template/test/framework/annotation/setup.ts +26 -0
package/template/test/framework/cache.test.ts +101 -0
package/template/test/framework/databaseConfig.test.ts +142 -0
package/template/test/integration/integration.test.ts +153 -0
package/template/test/plugins/weboffice/http.routes.int.test.ts +61 -0
package/template/test/service/business.test.ts +87 -0
package/template/test/service/paramValidateTest.service.test.ts +184 -0
package/template/test/service/ytUser.service.test.ts +566 -0
package/template/test/setup.ts +20 -0
package/template/test/setupAfterEnv.ts +14 -0
package/template/test/utils/testHelpers.ts +220 -0
package/template/test_output.txt +0 -0
package/template/tsconfig.build.json +17 -0
package/template/tsconfig.json +31 -0
package/template/webpack.config.js +71 -0
package/template/yarn.lock +7354 -0

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

@@ -0,0 +1,79 @@
+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 ADDED Viewed

@@ -0,0 +1,70 @@
+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 ADDED Viewed

@@ -0,0 +1,32 @@
+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" };
+        }
+    };
+}

package/template/src/migrations/1700000000000-InitialDatabaseStructure.ts ADDED Viewed

@@ -0,0 +1,172 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+/**
+ * 初始数据库结构迁移
+ * 创建所有基础表结构
+ */
+export class InitialDatabaseStructure1700000000000 implements MigrationInterface {
+    name = 'InitialDatabaseStructure1700000000000';
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        // 创建用户表
+        await queryRunner.query(`
+            CREATE TABLE \`yt_user\` (
+                \`id\` int NOT NULL AUTO_INCREMENT,
+                \`nickName\` varchar(255) NOT NULL DEFAULT '',
+                \`telnumber\` varchar(255) NOT NULL DEFAULT '',
+                \`email\` varchar(255) NOT NULL DEFAULT '',
+                \`password\` varchar(255) NOT NULL DEFAULT '',
+                \`userType\` varchar(50) NOT NULL DEFAULT 'CUSTOMER',
+                \`gender\` int NOT NULL DEFAULT '0',
+                \`age\` int NOT NULL DEFAULT '0',
+                \`constellation\` varchar(255) NOT NULL DEFAULT '',
+                \`avatar\` varchar(255) NOT NULL DEFAULT '',
+                \`status\` varchar(50) NOT NULL DEFAULT 'normal',
+                \`updateDate\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6),
+                \`createDate\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),
+                PRIMARY KEY (\`id\`),
+                UNIQUE KEY \`IDX_yt_user_email\` (\`email\`),
+                UNIQUE KEY \`IDX_yt_user_telnumber\` (\`telnumber\`),
+                KEY \`IDX_yt_user_status\` (\`status\`),
+                KEY \`IDX_yt_user_userType\` (\`userType\`)
+            ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci
+        `);
+        // 创建店铺表
+        await queryRunner.query(`
+            CREATE TABLE \`shop\` (
+                \`id\` int NOT NULL AUTO_INCREMENT,
+                \`name\` varchar(255) NOT NULL DEFAULT '',
+                \`description\` varchar(255) NOT NULL DEFAULT '',
+                \`status\` varchar(50) NOT NULL DEFAULT 'NORMAL',
+                \`updateDate\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6),
+                \`createDate\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),
+                PRIMARY KEY (\`id\`),
+                KEY \`IDX_shop_status\` (\`status\`)
+            ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci
+        `);
+        // 创建店铺用户关联表
+        await queryRunner.query(`
+            CREATE TABLE \`shop_and_user\` (
+                \`id\` int NOT NULL AUTO_INCREMENT,
+                \`shopId\` int NOT NULL DEFAULT '0',
+                \`userId\` int NOT NULL DEFAULT '0',
+                \`updateDate\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6),
+                \`createDate\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),
+                PRIMARY KEY (\`id\`),
+                UNIQUE KEY \`IDX_shop_and_user_shopId\` (\`shopId\`),
+                UNIQUE KEY \`IDX_shop_and_user_userId\` (\`userId\`),
+                KEY \`IDX_shop_and_user_shopId_userId\` (\`shopId\`, \`userId\`)
+            ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci
+        `);
+        // 创建商品表
+        await queryRunner.query(`
+            CREATE TABLE \`yt_goods\` (
+                \`id\` int NOT NULL AUTO_INCREMENT,
+                \`name\` varchar(255) NOT NULL DEFAULT '',
+                \`shopId\` int NOT NULL DEFAULT '0',
+                \`albums\` text NOT NULL,
+                \`price\` decimal(10,2) NOT NULL DEFAULT '0.00',
+                \`tags\` text NOT NULL,
+                \`description\` varchar(255) NOT NULL DEFAULT '',
+                \`content\` text NOT NULL,
+                \`imagesContent\` text NOT NULL,
+                \`status\` varchar(50) NOT NULL DEFAULT 'NORMAL',
+                \`updateDate\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6),
+                \`createDate\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),
+                PRIMARY KEY (\`id\`),
+                KEY \`IDX_yt_goods_name\` (\`name\`),
+                KEY \`IDX_yt_goods_shopId\` (\`shopId\`),
+                KEY \`IDX_yt_goods_status\` (\`status\`)
+            ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci
+        `);
+        // 创建商品解锁记录表
+        await queryRunner.query(`
+            CREATE TABLE \`yt_goods_unlock\` (
+                \`id\` int NOT NULL AUTO_INCREMENT,
+                \`goodsId\` int NOT NULL DEFAULT '0',
+                \`ytUserId\` int NOT NULL DEFAULT '0',
+                \`updateDate\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6),
+                \`createDate\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),
+                PRIMARY KEY (\`id\`),
+                KEY \`IDX_yt_goods_unlock_goodsId\` (\`goodsId\`),
+                KEY \`IDX_yt_goods_unlock_ytUserId\` (\`ytUserId\`),
+                UNIQUE KEY \`IDX_yt_goods_unlock_goods_user\` (\`goodsId\`, \`ytUserId\`)
+            ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci
+        `);
+        // 创建商品图片解锁密钥表
+        await queryRunner.query(`
+            CREATE TABLE \`goods_images_unlock_key\` (
+                \`id\` int NOT NULL AUTO_INCREMENT,
+                \`key\` varchar(255) NOT NULL DEFAULT '',
+                \`goodsId\` int NOT NULL DEFAULT '0',
+                \`isUse\` tinyint(1) NOT NULL DEFAULT '0',
+                \`updateDate\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6),
+                \`createDate\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6),
+                PRIMARY KEY (\`id\`),
+                UNIQUE KEY \`IDX_goods_images_unlock_key_key\` (\`key\`),
+                KEY \`IDX_goods_images_unlock_key_goodsId\` (\`goodsId\`),
+                KEY \`IDX_goods_images_unlock_key_isUse\` (\`isUse\`)
+            ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci
+        `);
+        // 添加外键约束
+        await queryRunner.query(`
+            ALTER TABLE \`shop_and_user\`
+            ADD CONSTRAINT \`FK_shop_and_user_shopId\`
+            FOREIGN KEY (\`shopId\`) REFERENCES \`shop\`(\`id\`) ON DELETE CASCADE ON UPDATE CASCADE
+        `);
+        await queryRunner.query(`
+            ALTER TABLE \`shop_and_user\`
+            ADD CONSTRAINT \`FK_shop_and_user_userId\`
+            FOREIGN KEY (\`userId\`) REFERENCES \`yt_user\`(\`id\`) ON DELETE CASCADE ON UPDATE CASCADE
+        `);
+        await queryRunner.query(`
+            ALTER TABLE \`yt_goods\`
+            ADD CONSTRAINT \`FK_yt_goods_shopId\`
+            FOREIGN KEY (\`shopId\`) REFERENCES \`shop\`(\`id\`) ON DELETE CASCADE ON UPDATE CASCADE
+        `);
+        await queryRunner.query(`
+            ALTER TABLE \`yt_goods_unlock\`
+            ADD CONSTRAINT \`FK_yt_goods_unlock_goodsId\`
+            FOREIGN KEY (\`goodsId\`) REFERENCES \`yt_goods\`(\`id\`) ON DELETE CASCADE ON UPDATE CASCADE
+        `);
+        await queryRunner.query(`
+            ALTER TABLE \`yt_goods_unlock\`
+            ADD CONSTRAINT \`FK_yt_goods_unlock_ytUserId\`
+            FOREIGN KEY (\`ytUserId\`) REFERENCES \`yt_user\`(\`id\`) ON DELETE CASCADE ON UPDATE CASCADE
+        `);
+        await queryRunner.query(`
+            ALTER TABLE \`goods_images_unlock_key\`
+            ADD CONSTRAINT \`FK_goods_images_unlock_key_goodsId\`
+            FOREIGN KEY (\`goodsId\`) REFERENCES \`yt_goods\`(\`id\`) ON DELETE CASCADE ON UPDATE CASCADE
+        `);
+    }
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        // 删除外键约束
+        await queryRunner.query(`ALTER TABLE \`goods_images_unlock_key\` DROP FOREIGN KEY \`FK_goods_images_unlock_key_goodsId\``);
+        await queryRunner.query(`ALTER TABLE \`yt_goods_unlock\` DROP FOREIGN KEY \`FK_yt_goods_unlock_ytUserId\``);
+        await queryRunner.query(`ALTER TABLE \`yt_goods_unlock\` DROP FOREIGN KEY \`FK_yt_goods_unlock_goodsId\``);
+        await queryRunner.query(`ALTER TABLE \`yt_goods\` DROP FOREIGN KEY \`FK_yt_goods_shopId\``);
+        await queryRunner.query(`ALTER TABLE \`shop_and_user\` DROP FOREIGN KEY \`FK_shop_and_user_userId\``);
+        await queryRunner.query(`ALTER TABLE \`shop_and_user\` DROP FOREIGN KEY \`FK_shop_and_user_shopId\``);
+        // 删除表
+        await queryRunner.query(`DROP TABLE \`goods_images_unlock_key\``);
+        await queryRunner.query(`DROP TABLE \`yt_goods_unlock\``);
+        await queryRunner.query(`DROP TABLE \`yt_goods\``);
+        await queryRunner.query(`DROP TABLE \`shop_and_user\``);
+        await queryRunner.query(`DROP TABLE \`shop\``);
+        await queryRunner.query(`DROP TABLE \`yt_user\``);
+    }
+}

package/template/src/migrations/index.ts ADDED Viewed

@@ -0,0 +1,6 @@
+import { InitialDatabaseStructure1700000000000 } from "./1700000000000-InitialDatabaseStructure";
+/**
+ * 显式注册迁移类，避免仅靠文件路径扫描导致 webpack 单文件部署下无法发现迁移。
+ */
+export const APP_MIGRATIONS = [InitialDatabaseStructure1700000000000];

package/template/src/plugins/weboffice/core/context.ts ADDED Viewed

@@ -0,0 +1,47 @@
+import { WebOfficeContext } from "./types";
+const X_APP_ID = "x-app-id";
+const X_WEBOFFICE_TOKEN = "x-weboffice-token";
+const X_REQUEST_ID = "x-request-id";
+const X_USER_QUERY = "x-user-query";
+function parseQuery(header: string | undefined): Record<string, string | string[] | undefined> {
+  if (!header) return {};
+  try {
+    const params = new URLSearchParams(header);
+    const out: Record<string, string | string[] | undefined> = {};
+    params.forEach((value, key) => {
+      const existing = out[key];
+      if (existing === undefined) out[key] = value;
+      else if (Array.isArray(existing)) existing.push(value);
+      else out[key] = [existing, value];
+    });
+    return out;
+  } catch {
+    return {};
+  }
+}
+function getQueryToken(query: Record<string, string | string[] | undefined> | undefined): string {
+  if (!query?.token) return "";
+  const t = query.token;
+  return Array.isArray(t) ? (t[0] ?? "") : (t ?? "");
+}
+export function parseWebOfficeContext(ctx: {
+  request: {
+    headers: Record<string, string | string[] | undefined>;
+    query?: Record<string, string | string[] | undefined>;
+  };
+}): WebOfficeContext {
+  const headers = ctx.request.headers;
+  const headerToken = (headers[X_WEBOFFICE_TOKEN] as string) || "";
+  const token = headerToken || getQueryToken(ctx.request.query);
+  return {
+    appId: (headers[X_APP_ID] as string) || "",
+    token,
+    requestId: (headers[X_REQUEST_ID] as string) || "",
+    query: parseQuery(headers[X_USER_QUERY] as string),
+  };
+}

package/template/src/plugins/weboffice/core/errors.ts ADDED Viewed

@@ -0,0 +1,51 @@
+export const OK = 0;
+export const WebOfficeErrorCode = {
+  Unauthorized: 40002,
+  PermissionDenied: 40003,
+  FileNotExists: 40004,
+  InvalidArguments: 40005,
+  SpaceFull: 40006,
+  CustomMessage: 40007,
+  FileNameConflict: 40008,
+  FileVersionNotExists: 40009,
+  UserNotExists: 40010,
+  InternalError: 50001,
+} as const;
+export class WebOfficeError extends Error {
+  constructor(
+    public readonly code: number,
+    public readonly statusCode: number,
+    message: string
+  ) {
+    super(message);
+    this.name = "WebOfficeError";
+  }
+  withMessage(msg: string): WebOfficeError {
+    return new WebOfficeError(this.code, this.statusCode, msg);
+  }
+}
+export const ErrFileNotExists = new WebOfficeError(
+  WebOfficeErrorCode.FileNotExists,
+  403,
+  "file not exists"
+);
+export const ErrInvalidArguments = new WebOfficeError(
+  WebOfficeErrorCode.InvalidArguments,
+  403,
+  "invalid arguments"
+);
+export const ErrFileVersionNotExists = new WebOfficeError(
+  WebOfficeErrorCode.FileVersionNotExists,
+  403,
+  "file version not exists"
+);
+export const ErrInternalError = new WebOfficeError(
+  WebOfficeErrorCode.InternalError,
+  500,
+  "internal error"
+);

package/template/src/plugins/weboffice/core/types.ts ADDED Viewed

@@ -0,0 +1,63 @@
+export interface WebOfficeContext {
+  appId: string;
+  token: string;
+  requestId: string;
+  query: Record<string, string | string[] | undefined>;
+}
+export interface GetFileReply {
+  create_time: number;
+  creator_id: string;
+  id: string;
+  modifier_id: string;
+  modify_time: number;
+  name: string;
+  size: number;
+  version: number;
+}
+export interface GetFileDownloadReply {
+  url: string;
+  digest: string;
+  digest_type: string;
+  headers: Record<string, string>;
+}
+export interface GetFilePermissionReply {
+  comment: number;
+  copy: number;
+  download: number;
+  history: number;
+  print: number;
+  read: number;
+  rename: number;
+  saveas: number;
+  update: number;
+  user_id: string;
+}
+export interface WebOfficeUser {
+  id: string;
+  name: string;
+  avatar_url: string;
+  logined: boolean;
+}
+export interface GetWatermarkReply {
+  type: number;
+  value: string;
+  fill_style: string;
+  font: string;
+  rotate: number;
+  horizontal: number;
+  vertical: number;
+}
+export interface UpdateFile1PhaseArgs {
+  name: string;
+  size: number;
+  sha1: string;
+  isManual: boolean;
+  filePath: string;
+}

package/template/src/plugins/weboffice/core/utils.ts ADDED Viewed

@@ -0,0 +1,7 @@
+export function normalizeWpsUserId(value: string | null | undefined): string {
+  if (value == null || typeof value !== "string") return "system";
+  let s = value.replace(/[^a-zA-Z0-9_]/g, "_");
+  if (/^_/.test(s)) s = "u" + s;
+  return s || "system";
+}

package/template/src/plugins/weboffice/entities/index.ts ADDED Viewed

@@ -0,0 +1,3 @@
+export { WebofficeFileEntity } from "./webofficeFile.entity";
+export { WebofficeFileVersionEntity } from "./webofficeFileVersion.entity";

package/template/src/plugins/weboffice/entities/webofficeFile.entity.ts ADDED Viewed

@@ -0,0 +1,28 @@
+import { Column, Entity, OneToMany } from "typeorm";
+import { BaseEntity } from "@src/entity/base.entity";
+import { WebofficeFileVersionEntity } from "./webofficeFileVersion.entity";
+@Entity({ name: "weboffice_files" })
+export class WebofficeFileEntity extends BaseEntity {
+  @Column({ type: "varchar", length: 128, unique: true })
+  fileId: string;
+  @Column({ type: "varchar", length: 512 })
+  name: string;
+  @Column({ type: "varchar", length: 128, default: "" })
+  creatorId: string;
+  @Column({ type: "varchar", length: 128, default: "" })
+  modifierId: string;
+  @Column({ type: "int", default: 1 })
+  currentVersion: number;
+  @Column({ type: "int", nullable: true })
+  projectId: number | null;
+  @OneToMany(() => WebofficeFileVersionEntity, (v) => v.webofficeFile)
+  versions?: WebofficeFileVersionEntity[];
+}

package/template/src/plugins/weboffice/entities/webofficeFileVersion.entity.ts ADDED Viewed

@@ -0,0 +1,29 @@
+import { Column, Entity, ManyToOne, JoinColumn } from "typeorm";
+import { BaseEntity } from "@src/entity/base.entity";
+import { WebofficeFileEntity } from "./webofficeFile.entity";
+@Entity({ name: "weboffice_file_versions" })
+export class WebofficeFileVersionEntity extends BaseEntity {
+  @ManyToOne(() => WebofficeFileEntity, (f) => f.versions, { onDelete: "CASCADE" })
+  @JoinColumn({ name: "webofficeFileId" })
+  webofficeFile: WebofficeFileEntity;
+  @Column()
+  webofficeFileId: number;
+  @Column({ type: "int" })
+  version: number;
+  @Column({ type: "bigint", default: 0 })
+  size: number;
+  @Column({ type: "varchar", length: 64, default: "" })
+  digest: string;
+  @Column({ type: "varchar", length: 512 })
+  cosKey: string;
+  @Column({ type: "varchar", length: 128, default: "" })
+  creatorId: string;
+}