@rdyl/node-koa-controller 0.5.6 → 0.5.8

package/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 0.5.5 (2025-12-31)
+## 0.5.7 (2026-01-07)
 
 
 

package/dist/cache.js

@@ -107,9 +107,9 @@ var ASTCache = /** @class */ (function () {
         }); });
         var hasLogs = Boolean(ASTCache.logs);
         ASTCache.routes.forEach(function (route) {
-            var handlers = route.handlers, prefix = route.prefix, Instance = route.Instance;
+            var handlers = route.handlers, prefix = route.prefix, Instance = route.Instance, cAuth = route.auth;
             handlers.forEach(function (handler) {
-                var method = handler.method, url = handler.url, name = handler.name;
+                var method = handler.method, url = handler.url, name = handler.name, hAuth = handler.auth;
                 var path = (0, path_1.join)("/" + ASTCache.prefix, prefix, url);
                 var isPublic = route.isPublic || handler.isPublic;
                 if (isPublic) {
@@ -125,61 +125,68 @@ var ASTCache = /** @class */ (function () {
                         }
                     });
                 }); };
-                var execWithJwt = !!useJwt
-                    ? isPublic
-                        ? function (instance) { return __awaiter(_this, void 0, void 0, function () {
+                var enabledAuth = (0, utils_1.ParsedAuthControl)(hAuth, cAuth);
+                var execWithJwt = (function () {
+                    if (useJwt) {
+                        if (isPublic) {
+                            // 非权限控制接口
+                            return function (instance) { return __awaiter(_this, void 0, void 0, function () {
+                                var jwt;
+                                return __generator(this, function (_a) {
+                                    switch (_a.label) {
+                                        case 0: return [4 /*yield*/, useJwt(instance._ctx)];
+                                        case 1:
+                                            jwt = _a.sent();
+                                            if (jwt) {
+                                                instance.jwt = jwt;
+                                            }
+                                            return [4 /*yield*/, next(instance)];
+                                        case 2:
+                                            _a.sent();
+                                            return [2 /*return*/];
+                                    }
+                                });
+                            }); };
+                        }
+                        return function (instance) { return __awaiter(_this, void 0, void 0, function () {
                             var jwt;
                             return __generator(this, function (_a) {
                                 switch (_a.label) {
                                     case 0: return [4 /*yield*/, useJwt(instance._ctx)];
                                     case 1:
                                         jwt = _a.sent();
-                                        if (jwt) {
-                                            instance.jwt = jwt;
-                                        }
+                                        if (!jwt)
+                                            return [2 /*return*/, instance.status.unauthorized()];
+                                        if (!enabledAuth(jwt.permissions))
+                                            return [2 /*return*/, instance.status.inaccessible()];
+                                        instance.jwt = jwt;
                                         return [4 /*yield*/, next(instance)];
                                     case 2:
                                         _a.sent();
                                         return [2 /*return*/];
                                 }
                             });
-                        }); }
-                        : function (instance) { return __awaiter(_this, void 0, void 0, function () {
-                            var jwt;
+                        }); };
+                    }
+                    return next;
+                })();
+                var routerHandler = (function () {
+                    if (hasLogs) {
+                        return function (ctx) { return __awaiter(_this, void 0, void 0, function () {
+                            var instance;
                             return __generator(this, function (_a) {
                                 switch (_a.label) {
-                                    case 0: return [4 /*yield*/, useJwt(instance._ctx)];
+                                    case 0:
+                                        instance = new Instance(ctx);
+                                        return [4 /*yield*/, (0, utils_1.LogsHandler)(ctx, function () { return execWithJwt(instance); })];
                                     case 1:
-                                        jwt = _a.sent();
-                                        if (!jwt) {
-                                            return [2 /*return*/, instance.status.unauthorized()];
-                                        }
-                                        if (jwt) {
-                                            instance.jwt = jwt;
-                                        }
-                                        return [4 /*yield*/, next(instance)];
-                                    case 2:
                                         _a.sent();
                                         return [2 /*return*/];
                                 }
                             });
-                        }); }
-                    : next;
-                var finalHandler = hasLogs
-                    ? function (ctx) { return __awaiter(_this, void 0, void 0, function () {
-                        var instance;
-                        return __generator(this, function (_a) {
-                            switch (_a.label) {
-                                case 0:
-                                    instance = new Instance(ctx);
-                                    return [4 /*yield*/, (0, utils_1.LogsHandler)(ctx, function () { return execWithJwt(instance); })];
-                                case 1:
-                                    _a.sent();
-                                    return [2 /*return*/];
-                            }
-                        });
-                    }); }
-                    : function (ctx) { return __awaiter(_this, void 0, void 0, function () {
+                        }); };
+                    }
+                    return function (ctx) { return __awaiter(_this, void 0, void 0, function () {
                         var instance;
                         return __generator(this, function (_a) {
                             switch (_a.label) {
@@ -192,8 +199,9 @@ var ASTCache = /** @class */ (function () {
                             }
                         });
                     }); };
+                })();
                 // @ts-ignore
-                router[method.toLowerCase()](path, finalHandler);
+                router[method.toLowerCase()](path, routerHandler);
             });
         });
     };

package/dist/docs/parse.js

@@ -6,6 +6,7 @@ function parseASTRoutes(routes) {
     return routes.map(function (ele) {
         return {
             name: ele.prefix,
+            tag: ele.auth.isPublic ? "public" : "",
             handlers: ele.handlers.map(function (item) {
                 var url = utils_1.Uri.join([ele.prefix, item.url]);
                 return {
@@ -14,6 +15,7 @@ function parseASTRoutes(routes) {
                     url: url,
                     jsUrl: "`" + url.replace(new RegExp("{", "g"), "${") + "`",
                     methodColor: "red",
+                    tag: item.auth.isPublic ? "public" : "",
                 };
             }),
         };

package/dist/meta.js

@@ -41,6 +41,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Patch = exports.Put = exports.Delete = exports.Post = exports.Get = exports.BaseController = exports.HttpMethod = void 0;
 exports.Controller = Controller;
+exports.AuthControl = AuthControl;
 var cache_1 = __importDefault(require("./cache"));
 var HttpMethod;
 (function (HttpMethod) {
@@ -54,8 +55,9 @@ var BaseController = /** @class */ (function () {
     function BaseController(_ctx) {
         this._ctx = _ctx;
         this.jwt = {
-            token: "",
-            value: {},
+            token: '',
+            current: {},
+            permissions: [],
         };
     }
     Object.defineProperty(BaseController.prototype, "pathname", {
@@ -70,16 +72,6 @@ var BaseController = /** @class */ (function () {
             var values = this._ctx.query;
             return {
                 values: values,
-                getPaged: function (def) {
-                    if (def === void 0) { def = {}; }
-                    var p = Number(values.page);
-                    var s = Number(values.pageSize);
-                    var _a = def.page, dPage = _a === void 0 ? 1 : _a, _b = def.pageSize, dPageSize = _b === void 0 ? 20 : _b;
-                    return {
-                        page: isNaN(p) ? dPage : p,
-                        pageSize: isNaN(s) ? dPageSize : s,
-                    };
-                },
                 getNumber: function (k) {
                     var n = values[k];
                     if (!n)
@@ -93,7 +85,7 @@ var BaseController = /** @class */ (function () {
                     var b = values[k];
                     if (!b)
                         return null;
-                    if (b === "1" || b === "true" || b === "TRUE") {
+                    if (b === '1' || b === 'true' || b === 'TRUE') {
                         return true;
                     }
                     return false;
@@ -105,7 +97,28 @@ var BaseController = /** @class */ (function () {
     });
     Object.defineProperty(BaseController.prototype, "params", {
         get: function () {
-            return this._ctx.params || {};
+            var values = this._ctx.params || {};
+            return {
+                values: values,
+                getNumber: function (k) {
+                    var n = values[k];
+                    if (!n)
+                        return null;
+                    var value = Number(n);
+                    if (isNaN(value))
+                        return null;
+                    return value;
+                },
+                getBool: function (k) {
+                    var b = values[k];
+                    if (!b)
+                        return null;
+                    if (b === '1' || b === 'true' || b === 'TRUE') {
+                        return true;
+                    }
+                    return false;
+                },
+            };
         },
         enumerable: false,
         configurable: true
@@ -130,7 +143,7 @@ var BaseController = /** @class */ (function () {
         get: function () {
             var _this = this;
             var sendJson = function (body) {
-                _this._ctx.response.set("Content-Type", "application/json;charset=utf-8");
+                _this._ctx.response.set('Content-Type', 'application/json;charset=utf-8');
                 _this._ctx.status = body.code;
                 _this._ctx.body = body;
             };
@@ -138,39 +151,39 @@ var BaseController = /** @class */ (function () {
                 raw: function (body, headers) {
                     var _a;
                     if (headers === void 0) { headers = {}; }
-                    _this._ctx.response.set("Content-Type", (_a = headers["Content-Type"]) !== null && _a !== void 0 ? _a : "application/json;charset=utf-8");
+                    _this._ctx.response.set('Content-Type', (_a = headers['Content-Type']) !== null && _a !== void 0 ? _a : 'application/json;charset=utf-8');
                     _this._ctx.status = 200;
                     _this._ctx.body = body;
                 },
                 ok: function (data) {
-                    sendJson({ data: data, code: 200, msg: "ok" });
+                    sendJson({ data: data, code: 200, msg: 'ok' });
                 },
                 okCreated: function (data, msg) {
-                    if (msg === void 0) { msg = "ok created"; }
+                    if (msg === void 0) { msg = 'ok created'; }
                     sendJson({ code: 201, data: data, msg: msg });
                 },
                 okAccept: function (data, msg) {
-                    if (msg === void 0) { msg = "ok accept"; }
+                    if (msg === void 0) { msg = 'ok accept'; }
                     sendJson({ code: 203, data: data, msg: msg });
                 },
                 parameterError: function (msg) {
-                    if (msg === void 0) { msg = "Parameter Error"; }
+                    if (msg === void 0) { msg = 'Parameter Error'; }
                     sendJson({ msg: msg, code: 400 });
                 },
                 unauthorized: function (msg) {
-                    if (msg === void 0) { msg = "User Unauthorized"; }
+                    if (msg === void 0) { msg = 'User Unauthorized'; }
                     sendJson({ msg: msg, code: 401 });
                 },
                 inaccessible: function (msg) {
-                    if (msg === void 0) { msg = "User Inaccessible"; }
+                    if (msg === void 0) { msg = 'User Inaccessible'; }
                     sendJson({ msg: msg, code: 403 });
                 },
                 exception: function (msg) {
-                    if (msg === void 0) { msg = "Service Exception"; }
+                    if (msg === void 0) { msg = 'Service Exception'; }
                     sendJson({ msg: msg, code: 500 });
                 },
                 unavailable: function (msg) {
-                    if (msg === void 0) { msg = "Service Unavailable"; }
+                    if (msg === void 0) { msg = 'Service Unavailable'; }
                     sendJson({ msg: msg, code: 503 });
                 },
             };
@@ -182,14 +195,17 @@ var BaseController = /** @class */ (function () {
 }());
 exports.BaseController = BaseController;
 function MethodFactory(method) {
-    return function (url, isPublic) {
-        if (isPublic === void 0) { isPublic = false; }
+    return function (url) {
         return function (target, name) {
+            console.log('method', name);
             var item = {
                 url: url,
                 method: method,
                 name: name,
-                isPublic: isPublic,
+                isPublic: false,
+                auth: {
+                    isPublic: false,
+                },
             };
             if (target.routes) {
                 target.routes.push(item);
@@ -200,19 +216,47 @@ function MethodFactory(method) {
         };
     };
 }
-function Controller(prefix, isPublic) {
-    if (isPublic === void 0) { isPublic = false; }
+function Controller(prefix) {
     return function (target) {
         var _a;
         var route = {
             Instance: target,
             prefix: prefix,
             handlers: ((_a = target.prototype) === null || _a === void 0 ? void 0 : _a.routes) || [],
-            isPublic: isPublic,
+            isPublic: false,
+            auth: {
+                isPublic: false,
+            },
         };
         cache_1.default.routes.push(route);
     };
 }
+function AuthControl(name, mode) {
+    return function (target, method) {
+        if (method) {
+            target.routes.forEach(function (ele) {
+                if (ele.name === method) {
+                    ele.auth = {
+                        isPublic: name === null,
+                        name: name || [],
+                        mode: mode,
+                    };
+                }
+            });
+        }
+        else {
+            cache_1.default.routes.forEach(function (ele) {
+                if (ele.Instance === target) {
+                    ele.auth = {
+                        isPublic: name === null,
+                        name: name || [],
+                        mode: mode,
+                    };
+                }
+            });
+        }
+    };
+}
 exports.Get = MethodFactory(HttpMethod.GET);
 exports.Post = MethodFactory(HttpMethod.POST);
 exports.Delete = MethodFactory(HttpMethod.DELETE);

package/dist/utils.js

@@ -43,6 +43,7 @@ exports.Uri = void 0;
 exports.formatDateTime = formatDateTime;
 exports.getIPAdress = getIPAdress;
 exports.LogsHandler = LogsHandler;
+exports.ParsedAuthControl = ParsedAuthControl;
 var os_1 = __importDefault(require("os"));
 var chalk_1 = __importDefault(require("chalk"));
 exports.Uri = {
@@ -139,3 +140,55 @@ function LogsHandler(ctx, next) {
         });
     });
 }
+function ParsedAuthControl() {
+    var auths = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        auths[_i] = arguments[_i];
+    }
+    if (!auths.length)
+        return function (_perms) { return true; };
+    // 预处理规则（只执行一次）
+    var required = [];
+    var any = [];
+    for (var _a = 0, auths_1 = auths; _a < auths_1.length; _a++) {
+        var auth = auths_1[_a];
+        var _b = auth.mode, mode = _b === void 0 ? "AND" : _b, _c = auth.name, name_1 = _c === void 0 ? [] : _c, isPublic = auth.isPublic;
+        if (isPublic)
+            continue;
+        var keys = typeof name_1 === "string" ? [name_1] : name_1;
+        if (!keys.length)
+            continue;
+        if (mode === "OR") {
+            any.push(keys);
+        }
+        else {
+            required.push.apply(required, keys);
+        }
+    }
+    // 返回真正的校验函数（高频调用）
+    return function (perms) {
+        if (perms === void 0) { perms = []; }
+        var permSet = new Set(perms);
+        // AND：必须全部存在
+        for (var _i = 0, required_1 = required; _i < required_1.length; _i++) {
+            var key = required_1[_i];
+            if (!permSet.has(key))
+                return false;
+        }
+        // OR：每一组至少命中一个
+        for (var _a = 0, any_1 = any; _a < any_1.length; _a++) {
+            var group = any_1[_a];
+            var hit = false;
+            for (var _b = 0, group_1 = group; _b < group_1.length; _b++) {
+                var key = group_1[_b];
+                if (permSet.has(key)) {
+                    hit = true;
+                    break;
+                }
+            }
+            if (!hit)
+                return false;
+        }
+        return true;
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rdyl/node-koa-controller",
-  "version": "0.5.6",
+  "version": "0.5.8",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "types/index.d.ts",

package/types/docs/parse.d.ts

@@ -1,11 +1,13 @@
 import { ASTCacheRoute } from "../meta";
 export declare function parseASTRoutes(routes: ASTCacheRoute[]): {
     name: string;
+    tag: string;
     handlers: {
         method: string;
         name: string;
         url: string;
         jsUrl: string;
         methodColor: string;
+        tag: string;
     }[];
 }[];

package/types/meta.d.ts

@@ -1,5 +1,5 @@
-import { ParameterizedContext } from "koa";
-import { ExtendedFormidableOptions } from "koa-body";
+import { ParameterizedContext } from 'koa';
+import { ExtendedFormidableOptions } from 'koa-body';
 export type KoaCtx = ParameterizedContext<any, any, any>;
 export declare enum HttpMethod {
     GET = "GET",
@@ -15,17 +15,14 @@ export declare class BaseController {
     get pathname(): any;
     get query(): {
         values: any;
-        getPaged(def?: Partial<{
-            page: number;
-            pageSize: number;
-        }>): {
-            page: number;
-            pageSize: number;
-        };
         getNumber(k: string): number | null;
         getBool(k: string): boolean | null;
     };
-    get params(): any;
+    get params(): {
+        values: any;
+        getNumber(k: string): number | null;
+        getBool(k: string): boolean | null;
+    };
     get body(): any;
     files(): Promise<any>;
     get status(): {
@@ -40,12 +37,13 @@ export declare class BaseController {
         unavailable(msg?: string): void;
     };
 }
-export declare function Controller(prefix: string, isPublic?: boolean): (target: any) => void;
-export declare const Get: (url: string, isPublic?: boolean) => (target: any, name: string) => void;
-export declare const Post: (url: string, isPublic?: boolean) => (target: any, name: string) => void;
-export declare const Delete: (url: string, isPublic?: boolean) => (target: any, name: string) => void;
-export declare const Put: (url: string, isPublic?: boolean) => (target: any, name: string) => void;
-export declare const Patch: (url: string, isPublic?: boolean) => (target: any, name: string) => void;
+export declare function Controller(prefix: string): (target: any) => void;
+export declare function AuthControl(name: string | string[] | null, mode?: 'AND' | 'OR'): (target: any, method?: string) => void;
+export declare const Get: (url: string) => (target: any, name: string) => void;
+export declare const Post: (url: string) => (target: any, name: string) => void;
+export declare const Delete: (url: string) => (target: any, name: string) => void;
+export declare const Put: (url: string) => (target: any, name: string) => void;
+export declare const Patch: (url: string) => (target: any, name: string) => void;
 export interface ResData<T> {
     code: number;
     msg: string;
@@ -61,7 +59,7 @@ export interface UseProps {
     useJwt?: UseJwtHandler;
 }
 export interface SyncUseValue {
-    context: import("koa").DefaultContext;
+    context: import('koa').DefaultContext;
     port: number;
     prefix: string;
     whitelist: (string | RegExp)[];
@@ -72,18 +70,26 @@ export interface ASTCacheHandler {
     method: string;
     isPublic: boolean;
     name: string;
+    auth: AuthControlProps;
 }
 export interface ASTCacheRoute {
     Instance: any;
     isPublic: boolean;
     prefix: string;
     handlers: ASTCacheHandler[];
+    auth: AuthControlProps;
 }
 export type UseJwtRes = {
     token: string;
-    value: unknown;
+    current: unknown;
+    permissions?: string[];
 };
 export type HandlerStatusBody = {
-    "Content-Type"?: string;
+    'Content-Type'?: string;
 };
 export type UseJwtHandler = (_ctx: KoaCtx) => Promise<UseJwtRes | null>;
+export type AuthControlProps = {
+    isPublic: boolean;
+    mode?: 'AND' | 'OR';
+    name?: string | string[];
+};

package/types/utils.d.ts

@@ -1,7 +1,8 @@
-import { KoaCtx } from "./meta";
+import { AuthControlProps, KoaCtx } from "./meta";
 export declare const Uri: {
     join(paths: string[]): string;
 };
 export declare function formatDateTime(date?: Date, format?: string): string;
 export declare function getIPAdress(): string;
 export declare function LogsHandler(ctx: KoaCtx, next: () => Promise<any>): Promise<void>;
+export declare function ParsedAuthControl(...auths: AuthControlProps[]): (_perms?: string[]) => boolean;