midway-fatcms 0.0.3 → 0.0.4

package/dist/middleware/permission.middleware.d.ts

@@ -1,88 +1,88 @@
-import { NextFunction, Context } from '@midwayjs/koa';
-import { Exceptions } from '../libs/crud-pro/exceptions';
-/**
- * 权限校验中间件
- *
- * 应用场景：
- * 1. 功能级权限控制：用户的增删改查操作需要对应的功能权限
- * 2. 数据安全保护：敏感数据的查看和修改需要特定权限
- * 3. 操作审计要求：关键业务操作（如财务、审批）必须有明确权限
- * 4. 多租户隔离：不同租户的用户只能访问授权的功能模块
- *
- * 使用示例：
- * ```typescript
- * @Post('/delete-order', { middleware: [checkPermission('order:delete')] }) // 单个权限
- * async deleteOrder(@Body() body: any) {
- *   // 业务逻辑：删除订单（需要order:delete权限）
- * }
- *
- * @Post('/export-financial-report', { middleware: [checkPermission(['report:export', 'finance:view'])] }) // 多个权限任一即可
- * async exportFinancialReport(@Body() body: any) {
- *   // 业务逻辑：导出财务报表（需要导出权限或财务查看权限）
- * }
- * ```
- *
- * @param codeList 权限码，支持字符串或数组，数组表示满足任一权限即可
- */
-declare function checkPermission(codeList: string | string[]): (ctx: Context, next: NextFunction) => Promise<{
-    success: boolean;
-    message: string;
-    code: Exceptions;
-}>;
-/**
- * 角色校验中间件
- *
- * 应用场景：
- * 1. 基于角色的访问控制（RBAC）：管理员、普通用户、访客等不同角色
- * 2. 组织架构权限：部门经理、财务主管等组织职位相关功能
- * 3. 业务流程控制：审批流程中的审批人、提交人等角色
- * 4. 粗粒度权限控制：比功能权限更高层级的角色级控制
- *
- * 使用示例：
- * ```typescript
- * @Post('/approve-order', { middleware: [checkRole('manager')] }) // 需要经理角色
- * async approveOrder(@Body() body: any) {
- *   // 业务逻辑：审批订单（仅经理可操作）
- * }
- *
- * @Get('/admin-dashboard', { middleware: [checkRole(['admin', 'super_admin'])] }) // 需要管理员或超级管理员角色
- * async getAdminDashboard() {
- *   // 业务逻辑：管理员仪表盘
- * }
- * ```
- *
- * @param codeList 角色码，支持字符串或数组，数组表示满足任一角色即可
- */
-declare function checkRole(codeList: string | string[]): (ctx: Context, next: NextFunction) => Promise<{
-    success: boolean;
-    message: string;
-    code: Exceptions;
-}>;
-/**
- * 登录校验中间件
- *
- * 应用场景：
- * 1. 需要用户身份的接口：个人中心、我的订单等用户相关功能
- * 2. 需要用户上下文的操作：创建内容时记录创建人、修改时记录修改人
- * 3. 个性化功能：基于用户偏好的推荐、用户配置等
- * 4. 通用登录保护：所有需要登录但不需要特定权限的接口
- *
- * 使用示例：
- * ```typescript
- * @Get('/my-profile', { middleware: [checkLogin()] }) // 查看个人信息
- * async getMyProfile() {
- *   // 业务逻辑：获取当前登录用户信息
- * }
- *
- * @Post('/create-post', { middleware: [checkLogin()] }) // 创建内容
- * async createPost(@Body() body: any) {
- *   // 业务逻辑：创建帖子（自动记录创建人）
- * }
- * ```
- */
-declare function checkLogin(): (ctx: Context, next: NextFunction) => Promise<{
-    success: boolean;
-    message: string;
-    code: Exceptions;
-}>;
-export { checkPermission, checkLogin, checkRole };
+import { NextFunction, Context } from '@midwayjs/koa';
+import { Exceptions } from '../libs/crud-pro/exceptions';
+/**
+ * 权限校验中间件
+ *
+ * 应用场景：
+ * 1. 功能级权限控制：用户的增删改查操作需要对应的功能权限
+ * 2. 数据安全保护：敏感数据的查看和修改需要特定权限
+ * 3. 操作审计要求：关键业务操作（如财务、审批）必须有明确权限
+ * 4. 多租户隔离：不同租户的用户只能访问授权的功能模块
+ *
+ * 使用示例：
+ * ```typescript
+ * @Post('/delete-order', { middleware: [checkPermission('order:delete')] }) // 单个权限
+ * async deleteOrder(@Body() body: any) {
+ *   // 业务逻辑：删除订单（需要order:delete权限）
+ * }
+ *
+ * @Post('/export-financial-report', { middleware: [checkPermission(['report:export', 'finance:view'])] }) // 多个权限任一即可
+ * async exportFinancialReport(@Body() body: any) {
+ *   // 业务逻辑：导出财务报表（需要导出权限或财务查看权限）
+ * }
+ * ```
+ *
+ * @param codeList 权限码，支持字符串或数组，数组表示满足任一权限即可
+ */
+declare function checkPermission(codeList: string | string[]): (ctx: Context, next: NextFunction) => Promise<{
+    success: boolean;
+    message: string;
+    code: Exceptions;
+}>;
+/**
+ * 角色校验中间件
+ *
+ * 应用场景：
+ * 1. 基于角色的访问控制（RBAC）：管理员、普通用户、访客等不同角色
+ * 2. 组织架构权限：部门经理、财务主管等组织职位相关功能
+ * 3. 业务流程控制：审批流程中的审批人、提交人等角色
+ * 4. 粗粒度权限控制：比功能权限更高层级的角色级控制
+ *
+ * 使用示例：
+ * ```typescript
+ * @Post('/approve-order', { middleware: [checkRole('manager')] }) // 需要经理角色
+ * async approveOrder(@Body() body: any) {
+ *   // 业务逻辑：审批订单（仅经理可操作）
+ * }
+ *
+ * @Get('/admin-dashboard', { middleware: [checkRole(['admin', 'super_admin'])] }) // 需要管理员或超级管理员角色
+ * async getAdminDashboard() {
+ *   // 业务逻辑：管理员仪表盘
+ * }
+ * ```
+ *
+ * @param codeList 角色码，支持字符串或数组，数组表示满足任一角色即可
+ */
+declare function checkRole(codeList: string | string[]): (ctx: Context, next: NextFunction) => Promise<{
+    success: boolean;
+    message: string;
+    code: Exceptions;
+}>;
+/**
+ * 登录校验中间件
+ *
+ * 应用场景：
+ * 1. 需要用户身份的接口：个人中心、我的订单等用户相关功能
+ * 2. 需要用户上下文的操作：创建内容时记录创建人、修改时记录修改人
+ * 3. 个性化功能：基于用户偏好的推荐、用户配置等
+ * 4. 通用登录保护：所有需要登录但不需要特定权限的接口
+ *
+ * 使用示例：
+ * ```typescript
+ * @Get('/my-profile', { middleware: [checkLogin()] }) // 查看个人信息
+ * async getMyProfile() {
+ *   // 业务逻辑：获取当前登录用户信息
+ * }
+ *
+ * @Post('/create-post', { middleware: [checkLogin()] }) // 创建内容
+ * async createPost(@Body() body: any) {
+ *   // 业务逻辑：创建帖子（自动记录创建人）
+ * }
+ * ```
+ */
+declare function checkLogin(): (ctx: Context, next: NextFunction) => Promise<{
+    success: boolean;
+    message: string;
+    code: Exceptions;
+}>;
+export { checkPermission, checkLogin, checkRole };

package/dist/middleware/permission.middleware.js

@@ -1,145 +1,145 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkRole = exports.checkLogin = exports.checkPermission = void 0;
-const exceptions_1 = require("../libs/crud-pro/exceptions");
-/**
- * 权限校验中间件
- *
- * 应用场景：
- * 1. 功能级权限控制：用户的增删改查操作需要对应的功能权限
- * 2. 数据安全保护：敏感数据的查看和修改需要特定权限
- * 3. 操作审计要求：关键业务操作（如财务、审批）必须有明确权限
- * 4. 多租户隔离：不同租户的用户只能访问授权的功能模块
- *
- * 使用示例：
- * ```typescript
- * @Post('/delete-order', { middleware: [checkPermission('order:delete')] }) // 单个权限
- * async deleteOrder(@Body() body: any) {
- *   // 业务逻辑：删除订单（需要order:delete权限）
- * }
- *
- * @Post('/export-financial-report', { middleware: [checkPermission(['report:export', 'finance:view'])] }) // 多个权限任一即可
- * async exportFinancialReport(@Body() body: any) {
- *   // 业务逻辑：导出财务报表（需要导出权限或财务查看权限）
- * }
- * ```
- *
- * @param codeList 权限码，支持字符串或数组，数组表示满足任一权限即可
- */
-function checkPermission(codeList) {
-    return async (ctx, next) => {
-        const userSession = ctx.userSession;
-        //  只有登录用户才会有功能点权限，所以必须登录
-        if (!userSession.isLogin()) {
-            return {
-                success: false,
-                message: '用户未登录, 请先登录',
-                code: exceptions_1.Exceptions.NOT_LOGIN,
-            };
-        }
-        // 查询当前用户是否有此功能点的权限
-        const hasPermission = userSession.hasAnyPermission(codeList);
-        if (!hasPermission) {
-            let message;
-            const loginName = userSession.getSessionInfo().loginName;
-            // 针对体验账号的特殊提示
-            if (loginName === 'devopsviewer') {
-                message = '开放体验账号不支持这些操作：新增、修改、删除、上传';
-            }
-            else {
-                message = '缺少权限: ' + JSON.stringify(codeList);
-            }
-            return {
-                success: false,
-                message: message,
-                code: exceptions_1.Exceptions.NO_AUTH,
-            };
-        }
-        await next();
-    };
-}
-exports.checkPermission = checkPermission;
-/**
- * 角色校验中间件
- *
- * 应用场景：
- * 1. 基于角色的访问控制（RBAC）：管理员、普通用户、访客等不同角色
- * 2. 组织架构权限：部门经理、财务主管等组织职位相关功能
- * 3. 业务流程控制：审批流程中的审批人、提交人等角色
- * 4. 粗粒度权限控制：比功能权限更高层级的角色级控制
- *
- * 使用示例：
- * ```typescript
- * @Post('/approve-order', { middleware: [checkRole('manager')] }) // 需要经理角色
- * async approveOrder(@Body() body: any) {
- *   // 业务逻辑：审批订单（仅经理可操作）
- * }
- *
- * @Get('/admin-dashboard', { middleware: [checkRole(['admin', 'super_admin'])] }) // 需要管理员或超级管理员角色
- * async getAdminDashboard() {
- *   // 业务逻辑：管理员仪表盘
- * }
- * ```
- *
- * @param codeList 角色码，支持字符串或数组，数组表示满足任一角色即可
- */
-function checkRole(codeList) {
-    return async (ctx, next) => {
-        const userSession = ctx.userSession;
-        //  只有登录用户才会有功能点权限，所以必须登录
-        if (!userSession.isLogin()) {
-            return {
-                success: false,
-                message: '用户未登录, 请先登录',
-                code: exceptions_1.Exceptions.NOT_LOGIN,
-            };
-        }
-        // 查询当前用户是否有此角色
-        const hasRole = userSession.hasAnyRole(codeList);
-        if (!hasRole) {
-            return {
-                success: false,
-                message: '缺少角色权限: ' + JSON.stringify(codeList),
-                code: exceptions_1.Exceptions.NO_AUTH,
-            };
-        }
-        await next();
-    };
-}
-exports.checkRole = checkRole;
-/**
- * 登录校验中间件
- *
- * 应用场景：
- * 1. 需要用户身份的接口：个人中心、我的订单等用户相关功能
- * 2. 需要用户上下文的操作：创建内容时记录创建人、修改时记录修改人
- * 3. 个性化功能：基于用户偏好的推荐、用户配置等
- * 4. 通用登录保护：所有需要登录但不需要特定权限的接口
- *
- * 使用示例：
- * ```typescript
- * @Get('/my-profile', { middleware: [checkLogin()] }) // 查看个人信息
- * async getMyProfile() {
- *   // 业务逻辑：获取当前登录用户信息
- * }
- *
- * @Post('/create-post', { middleware: [checkLogin()] }) // 创建内容
- * async createPost(@Body() body: any) {
- *   // 业务逻辑：创建帖子（自动记录创建人）
- * }
- * ```
- */
-function checkLogin() {
-    return async (ctx, next) => {
-        const userSession = ctx.userSession;
-        if (!userSession.isLogin()) {
-            return {
-                success: false,
-                message: '用户未登录, 请先登录',
-                code: exceptions_1.Exceptions.NOT_LOGIN,
-            };
-        }
-        await next();
-    };
-}
-exports.checkLogin = checkLogin;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkRole = exports.checkLogin = exports.checkPermission = void 0;
+const exceptions_1 = require("../libs/crud-pro/exceptions");
+/**
+ * 权限校验中间件
+ *
+ * 应用场景：
+ * 1. 功能级权限控制：用户的增删改查操作需要对应的功能权限
+ * 2. 数据安全保护：敏感数据的查看和修改需要特定权限
+ * 3. 操作审计要求：关键业务操作（如财务、审批）必须有明确权限
+ * 4. 多租户隔离：不同租户的用户只能访问授权的功能模块
+ *
+ * 使用示例：
+ * ```typescript
+ * @Post('/delete-order', { middleware: [checkPermission('order:delete')] }) // 单个权限
+ * async deleteOrder(@Body() body: any) {
+ *   // 业务逻辑：删除订单（需要order:delete权限）
+ * }
+ *
+ * @Post('/export-financial-report', { middleware: [checkPermission(['report:export', 'finance:view'])] }) // 多个权限任一即可
+ * async exportFinancialReport(@Body() body: any) {
+ *   // 业务逻辑：导出财务报表（需要导出权限或财务查看权限）
+ * }
+ * ```
+ *
+ * @param codeList 权限码，支持字符串或数组，数组表示满足任一权限即可
+ */
+function checkPermission(codeList) {
+    return async (ctx, next) => {
+        const userSession = ctx.userSession;
+        //  只有登录用户才会有功能点权限，所以必须登录
+        if (!userSession.isLogin()) {
+            return {
+                success: false,
+                message: '用户未登录, 请先登录',
+                code: exceptions_1.Exceptions.NOT_LOGIN,
+            };
+        }
+        // 查询当前用户是否有此功能点的权限
+        const hasPermission = userSession.hasAnyPermission(codeList);
+        if (!hasPermission) {
+            let message;
+            const loginName = userSession.getSessionInfo().loginName;
+            // 针对体验账号的特殊提示
+            if (loginName === 'devopsviewer') {
+                message = '开放体验账号不支持这些操作：新增、修改、删除、上传';
+            }
+            else {
+                message = '缺少权限: ' + JSON.stringify(codeList);
+            }
+            return {
+                success: false,
+                message: message,
+                code: exceptions_1.Exceptions.NO_AUTH,
+            };
+        }
+        await next();
+    };
+}
+exports.checkPermission = checkPermission;
+/**
+ * 角色校验中间件
+ *
+ * 应用场景：
+ * 1. 基于角色的访问控制（RBAC）：管理员、普通用户、访客等不同角色
+ * 2. 组织架构权限：部门经理、财务主管等组织职位相关功能
+ * 3. 业务流程控制：审批流程中的审批人、提交人等角色
+ * 4. 粗粒度权限控制：比功能权限更高层级的角色级控制
+ *
+ * 使用示例：
+ * ```typescript
+ * @Post('/approve-order', { middleware: [checkRole('manager')] }) // 需要经理角色
+ * async approveOrder(@Body() body: any) {
+ *   // 业务逻辑：审批订单（仅经理可操作）
+ * }
+ *
+ * @Get('/admin-dashboard', { middleware: [checkRole(['admin', 'super_admin'])] }) // 需要管理员或超级管理员角色
+ * async getAdminDashboard() {
+ *   // 业务逻辑：管理员仪表盘
+ * }
+ * ```
+ *
+ * @param codeList 角色码，支持字符串或数组，数组表示满足任一角色即可
+ */
+function checkRole(codeList) {
+    return async (ctx, next) => {
+        const userSession = ctx.userSession;
+        //  只有登录用户才会有功能点权限，所以必须登录
+        if (!userSession.isLogin()) {
+            return {
+                success: false,
+                message: '用户未登录, 请先登录',
+                code: exceptions_1.Exceptions.NOT_LOGIN,
+            };
+        }
+        // 查询当前用户是否有此角色
+        const hasRole = userSession.hasAnyRole(codeList);
+        if (!hasRole) {
+            return {
+                success: false,
+                message: '缺少角色权限: ' + JSON.stringify(codeList),
+                code: exceptions_1.Exceptions.NO_AUTH,
+            };
+        }
+        await next();
+    };
+}
+exports.checkRole = checkRole;
+/**
+ * 登录校验中间件
+ *
+ * 应用场景：
+ * 1. 需要用户身份的接口：个人中心、我的订单等用户相关功能
+ * 2. 需要用户上下文的操作：创建内容时记录创建人、修改时记录修改人
+ * 3. 个性化功能：基于用户偏好的推荐、用户配置等
+ * 4. 通用登录保护：所有需要登录但不需要特定权限的接口
+ *
+ * 使用示例：
+ * ```typescript
+ * @Get('/my-profile', { middleware: [checkLogin()] }) // 查看个人信息
+ * async getMyProfile() {
+ *   // 业务逻辑：获取当前登录用户信息
+ * }
+ *
+ * @Post('/create-post', { middleware: [checkLogin()] }) // 创建内容
+ * async createPost(@Body() body: any) {
+ *   // 业务逻辑：创建帖子（自动记录创建人）
+ * }
+ * ```
+ */
+function checkLogin() {
+    return async (ctx, next) => {
+        const userSession = ctx.userSession;
+        if (!userSession.isLogin()) {
+            return {
+                success: false,
+                message: '用户未登录, 请先登录',
+                code: exceptions_1.Exceptions.NOT_LOGIN,
+            };
+        }
+        await next();
+    };
+}
+exports.checkLogin = checkLogin;

package/dist/middleware/rediscache.middleware.d.ts

@@ -1,28 +1,28 @@
-import { NextFunction, Context } from '@midwayjs/koa';
-/**
- * Redis缓存中间件
- *
- * 应用场景：
- * 1. 高频查询接口：用户列表、商品详情等读多写少的接口
- * 2. 计算密集型接口：统计报表、数据聚合等耗时计算结果
- * 3. 外部API调用：第三方接口响应数据缓存，减少调用次数和费用
- * 4. 数据库压力缓解：热点数据缓存，降低数据库查询压力
- *
- * 使用示例：
- * ```typescript
- * @Get('/product-detail', { middleware: [redisCache(['query.productId'], 300)] }) // 商品详情缓存5分钟
- * async getProductDetail(@Query() query: any) {
- *   // 业务逻辑：查询商品详情
- * }
- *
- * @Post('/report', { middleware: [redisCache(['body.dateRange', 'body.type'], 1800)] }) // 报表数据缓存30分钟
- * async generateReport(@Body() body: any) {
- *   // 业务逻辑：生成统计报表
- * }
- * ```
- *
- * @param cacheKeyConfigList 缓存键配置，如 ['query.id', 'body.type']
- * @param cacheTimeSecond 缓存时长（秒），默认60秒，范围1-3600秒
- */
-declare function redisCache(cacheKeyConfigList: string[], cacheTimeSecond?: number): (ctx: Context, next: NextFunction) => Promise<any>;
-export { redisCache };
+import { NextFunction, Context } from '@midwayjs/koa';
+/**
+ * Redis缓存中间件
+ *
+ * 应用场景：
+ * 1. 高频查询接口：用户列表、商品详情等读多写少的接口
+ * 2. 计算密集型接口：统计报表、数据聚合等耗时计算结果
+ * 3. 外部API调用：第三方接口响应数据缓存，减少调用次数和费用
+ * 4. 数据库压力缓解：热点数据缓存，降低数据库查询压力
+ *
+ * 使用示例：
+ * ```typescript
+ * @Get('/product-detail', { middleware: [redisCache(['query.productId'], 300)] }) // 商品详情缓存5分钟
+ * async getProductDetail(@Query() query: any) {
+ *   // 业务逻辑：查询商品详情
+ * }
+ *
+ * @Post('/report', { middleware: [redisCache(['body.dateRange', 'body.type'], 1800)] }) // 报表数据缓存30分钟
+ * async generateReport(@Body() body: any) {
+ *   // 业务逻辑：生成统计报表
+ * }
+ * ```
+ *
+ * @param cacheKeyConfigList 缓存键配置，如 ['query.id', 'body.type']
+ * @param cacheTimeSecond 缓存时长（秒），默认60秒，范围1-3600秒
+ */
+declare function redisCache(cacheKeyConfigList: string[], cacheTimeSecond?: number): (ctx: Context, next: NextFunction) => Promise<any>;
+export { redisCache };