@rdyl/node-koa-controller 0.3.5 → 0.3.7

package/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 0.3.4 (2025-08-29)
+## 0.3.6 (2025-09-05)
 
 
 

package/dist/cache.js

@@ -75,8 +75,8 @@ var ASTCache = /** @class */ (function () {
                                 require(url);
                             }
                         }
-                        catch (_b) {
-                            console.warn("解析出现错误!");
+                        catch (err) {
+                            console.warn("解析出现错误!", err);
                         }
                         _a.label = 4;
                     case 4:

package/dist/docs/index.js

@@ -0,0 +1,63 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.api_docs_path = void 0;
+exports.getDocsHtml = getDocsHtml;
+var ejs_1 = __importDefault(require("ejs"));
+var path_1 = __importDefault(require("path"));
+var cache_1 = __importDefault(require("../cache"));
+var parse_1 = require("../docs/parse");
+exports.api_docs_path = "/api-docs.html";
+function getDocsHtml() {
+    return __awaiter(this, void 0, void 0, function () {
+        var treeData;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    treeData = (0, parse_1.parseASTRoutes)(cache_1.default.routes);
+                    return [4 /*yield*/, ejs_1.default.renderFile(path_1.default.resolve(__dirname, "../docs/template.ejs"), {
+                            treeData: treeData,
+                        })];
+                case 1: return [2 /*return*/, _a.sent()];
+            }
+        });
+    });
+}

package/dist/docs/parse.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseASTRoutes = parseASTRoutes;
+var utils_1 = require("../utils");
+function parseASTRoutes(routes) {
+    return routes.map(function (ele) {
+        return {
+            name: ele.prefix,
+            handlers: ele.handlers.map(function (item) {
+                var url = utils_1.Uri.join([ele.prefix, item.url]);
+                return {
+                    method: item.method,
+                    name: item.name,
+                    url: url,
+                    jsUrl: "`" + url.replace(new RegExp("{", "g"), "${") + "`",
+                    methodColor: "red",
+                };
+            }),
+        };
+    });
+}

package/dist/index.js

@@ -67,12 +67,16 @@ function useApiController(app, opts) {
             switch (_d.label) {
                 case 0:
                     root = opts.root, _a = opts.prefix, prefix = _a === void 0 ? "" : _a, _b = opts.port, port = _b === void 0 ? 8080 : _b, _c = opts.logs, logs = _c === void 0 ? true : _c, formidable = opts.formidable, useJwt = opts.useJwt;
+                    cache_1.default.logs = logs;
                     cache_1.default.prefix = prefix;
                     router = new koa_router_1.default();
+                    if (!root) return [3 /*break*/, 2];
                     rootDir = (0, path_1.resolve)(process.cwd(), root);
                     return [4 /*yield*/, cache_1.default.resolve(rootDir)];
                 case 1:
                     _d.sent();
+                    _d.label = 2;
+                case 2:
                     // 注册路由
                     cache_1.default.register(router, useJwt);
                     if (opts.static) {
@@ -85,7 +89,6 @@ function useApiController(app, opts) {
                         multipart: true,
                         formidable: formidable,
                     }));
-                    cache_1.default.logs = logs;
                     app.use(router.routes()).use(router.allowedMethods());
                     ip = (0, utils_1.getIPAdress)();
                     return [2 /*return*/, {

package/dist/utils.js

@@ -39,6 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Uri = void 0;
 exports.formatDateTime = formatDateTime;
 exports.getIPAdress = getIPAdress;
 exports.LogsHandler = LogsHandler;
@@ -47,6 +48,22 @@ var os_1 = __importDefault(require("os"));
 var path_1 = require("path");
 var boxen_1 = __importDefault(require("boxen"));
 var chalk_1 = __importDefault(require("chalk"));
+exports.Uri = {
+    join: function (paths) {
+        var url = "";
+        paths.forEach(function (path) {
+            if (path) {
+                if (path[0] === "/") {
+                    url += path;
+                }
+                else {
+                    url += "/".concat(path);
+                }
+            }
+        });
+        return url;
+    },
+};
 function formatDateTime(date, format) {
     if (date === void 0) { date = new Date(); }
     if (format === void 0) { format = "YYYY-MM-DD HH:mm:ss"; }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rdyl/node-koa-controller",
-  "version": "0.3.5",
+  "version": "0.3.7",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "types/index.d.ts",
@@ -25,6 +25,7 @@
     "boxen": "^8.0.1",
     "chalk": "^5.4.1",
     "crypto-js": "^4.2.0",
+    "ejs": "^3.1.10",
     "koa": "^2.15.3",
     "koa-body": "^6.0.1",
     "koa-router": "^13.0.1",
@@ -33,6 +34,7 @@
   "devDependencies": {
     "@commitlint/cli": "^19.6.1",
     "@commitlint/config-conventional": "^19.6.0",
+    "@types/ejs": "^3.1.5",
     "@types/node": "^22.9.0",
     "conventional-changelog-cli": "^5.0.0",
     "copyfiles": "^2.4.1",

package/types/docs/index.d.ts

@@ -0,0 +1,2 @@
+export declare const api_docs_path = "/api-docs.html";
+export declare function getDocsHtml(): Promise<string>;

package/types/docs/parse.d.ts

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

package/types/meta.d.ts

@@ -53,7 +53,7 @@ export interface ResData<T> {
 }
 export interface UseProps {
     port: number;
-    root: string;
+    root?: string;
     prefix?: string;
     static?: string;
     logs?: boolean;

package/types/utils.d.ts

@@ -1,4 +1,7 @@
 import { 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>;