@rdyl/node-koa-controller 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.0.1 (2025-01-21)
+
+
+

package/README.md

@@ -0,0 +1,20 @@
+## Installation
+
+```bash
+$ npm install @rdyl/react-router-connect
+# or
+$ yarn add @rdyl/react-router-connect
+```
+
+## Getting started
+
+1. 配置tsconfig.json
+```json
+{
+  "compilerOptions": {
+    "types": [
+      "@rdyl/react-router-connect/types/type.d.ts"
+    ],
+  },
+}
+```

package/dist/controller/index.js

@@ -0,0 +1,179 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+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.ASTCache = void 0;
+exports.useController = useController;
+var koa_router_1 = __importDefault(require("koa-router"));
+var fs_1 = __importDefault(require("fs"));
+var path_1 = require("path");
+exports.ASTCache = {
+    routes: [],
+    whitelist: [],
+};
+function RegisterASTCacheRoutes(router) {
+    exports.ASTCache.routes.forEach(function (route) {
+        var handlers = route.handlers, prefix = route.prefix, Instance = route.Instance;
+        handlers.forEach(function (handler) {
+            var method = handler.method, url = handler.url, name = handler.name;
+            var path = (0, path_1.join)('/' + prefix, url);
+            var isPublic = route.isPublic || route.isPublic;
+            if (isPublic) {
+                exports.ASTCache.whitelist.push(path);
+            }
+            // @ts-ignore
+            router[method.toLowerCase()](path, function (_ctx) {
+                try {
+                    var instance = new Instance(_ctx);
+                    instance[name]();
+                }
+                catch (_a) {
+                    console.log(path + ':配置错误!');
+                }
+            });
+        });
+    });
+}
+function useController(app_1, _a) {
+    return __awaiter(this, arguments, void 0, function (app, _b) {
+        var router, rootDir, initAST;
+        var _this = this;
+        var root = _b.root, _c = _b.prefix, prefix = _c === void 0 ? '' : _c;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
+                case 0:
+                    router = new koa_router_1.default({
+                        prefix: prefix,
+                    });
+                    rootDir = (0, path_1.resolve)(process.cwd(), root);
+                    initAST = function (dir) { return __awaiter(_this, void 0, void 0, function () {
+                        var list, _i, list_1, p, url, stat, isDir, sp, ext, _a;
+                        return __generator(this, function (_b) {
+                            switch (_b.label) {
+                                case 0:
+                                    list = fs_1.default.readdirSync(dir);
+                                    _i = 0, list_1 = list;
+                                    _b.label = 1;
+                                case 1:
+                                    if (!(_i < list_1.length)) return [3 /*break*/, 8];
+                                    p = list_1[_i];
+                                    url = (0, path_1.resolve)(dir, p);
+                                    stat = fs_1.default.statSync(url);
+                                    isDir = stat.isDirectory();
+                                    if (!isDir) return [3 /*break*/, 3];
+                                    // 文件架
+                                    return [4 /*yield*/, initAST(url)];
+                                case 2:
+                                    // 文件架
+                                    _b.sent();
+                                    return [3 /*break*/, 7];
+                                case 3:
+                                    _b.trys.push([3, 6, , 7]);
+                                    sp = p.split('.');
+                                    ext = sp[sp.length - 1];
+                                    if (!(ext === 'ts' || ext === 'js')) return [3 /*break*/, 5];
+                                    // ts | js 文件
+                                    return [4 /*yield*/, Promise.resolve("".concat(url)).then(function (s) { return __importStar(require(s)); })];
+                                case 4:
+                                    // ts | js 文件
+                                    _b.sent();
+                                    _b.label = 5;
+                                case 5: return [3 /*break*/, 7];
+                                case 6:
+                                    _a = _b.sent();
+                                    console.warn('解析出现错误!');
+                                    return [3 /*break*/, 7];
+                                case 7:
+                                    _i++;
+                                    return [3 /*break*/, 1];
+                                case 8: return [2 /*return*/];
+                            }
+                        });
+                    }); };
+                    return [4 /*yield*/, initAST(rootDir)];
+                case 1:
+                    _d.sent();
+                    // 注册路由
+                    RegisterASTCacheRoutes(router);
+                    app.use(router.routes()).use(router.allowedMethods());
+                    return [2 /*return*/, Promise.resolve({
+                            whitelist: exports.ASTCache.whitelist,
+                        })];
+            }
+        });
+    });
+}
+__exportStar(require("./meta"), exports);

package/dist/controller/meta.js

@@ -0,0 +1,172 @@
+"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 };
+    }
+};
+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;
+var index_1 = require("./index");
+var HttpMethod;
+(function (HttpMethod) {
+    HttpMethod["GET"] = "GET";
+    HttpMethod["POST"] = "POST";
+    HttpMethod["PATCH"] = "PATCH";
+    HttpMethod["PUT"] = "PUT";
+    HttpMethod["DELETE"] = "DELETE";
+})(HttpMethod || (exports.HttpMethod = HttpMethod = {}));
+var BaseController = /** @class */ (function () {
+    function BaseController(_ctx) {
+        this._ctx = _ctx;
+    }
+    Object.defineProperty(BaseController.prototype, "pathname", {
+        get: function () {
+            return this._ctx.request.path;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(BaseController.prototype, "query", {
+        get: function () {
+            return this._ctx.query;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(BaseController.prototype, "params", {
+        get: function () {
+            return this._ctx.params || {};
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(BaseController.prototype, "body", {
+        get: function () {
+            // @ts-ignore
+            return this._ctx.request.body;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    BaseController.prototype.files = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                // @ts-ignore
+                return [2 /*return*/, this._ctx.request.files];
+            });
+        });
+    };
+    Object.defineProperty(BaseController.prototype, "status", {
+        get: function () {
+            var _ctx = this._ctx;
+            var sendJson = function (body) {
+                _ctx.response.set("Content-Type", "application/json;charset=utf-8");
+                _ctx.body = body;
+            };
+            return {
+                ok: function (data) {
+                    sendJson({ data: data });
+                },
+                okCreated: function (data, msg) {
+                    sendJson({ code: 201, data: data, msg: msg });
+                },
+                okAccept: function (data, msg) {
+                    sendJson({ code: 203, data: data, msg: msg });
+                },
+                parameterError: function (msg) {
+                    if (msg === void 0) { msg = "Parameter Error"; }
+                    sendJson({ msg: msg, code: 400 });
+                },
+                unauthorized: function (msg) {
+                    if (msg === void 0) { msg = "User Unauthorized"; }
+                    sendJson({ msg: msg, code: 401 });
+                },
+                inaccessible: function (msg) {
+                    if (msg === void 0) { msg = "User Inaccessible"; }
+                    sendJson({ msg: msg, code: 403 });
+                },
+                exception: function (msg) {
+                    if (msg === void 0) { msg = "Service Exception"; }
+                    sendJson({ msg: msg, code: 500 });
+                },
+                unavailable: function (msg) {
+                    if (msg === void 0) { msg = "Service Unavailable"; }
+                    sendJson({ msg: msg, code: 503 });
+                },
+            };
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return BaseController;
+}());
+exports.BaseController = BaseController;
+function MethodFactory(method) {
+    return function (url, isPublic) {
+        if (isPublic === void 0) { isPublic = false; }
+        return function (target, name) {
+            var item = {
+                url: url,
+                method: method,
+                name: name,
+                isPublic: isPublic,
+            };
+            if (target.routes) {
+                target.routes.push(item);
+            }
+            else {
+                target.routes = [item];
+            }
+        };
+    };
+}
+function Controller(prefix, isPublic) {
+    if (isPublic === void 0) { isPublic = false; }
+    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,
+        };
+        index_1.ASTCache.routes.push(route);
+    };
+}
+exports.Get = MethodFactory(HttpMethod.GET);
+exports.Post = MethodFactory(HttpMethod.POST);
+exports.Delete = MethodFactory(HttpMethod.DELETE);
+exports.Put = MethodFactory(HttpMethod.PUT);
+exports.Patch = MethodFactory(HttpMethod.PATCH);

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./controller"), exports);

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@rdyl/node-koa-controller",
+  "version": "0.0.1",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "types",
+    "CHANGELOG.md",
+    "README.md"
+  ],
+  "scripts": {
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
+    "build": "tsc && copyfiles -u 1 src/**/*.d.ts src/*.d.ts types && npm run changelog && git add CHANGELOG.md"
+  },
+  "dependencies": {
+    "@types/koa": "^2.15.0",
+    "@types/koa-router": "^7.4.8",
+    "koa": "^2.15.3",
+    "koa-router": "^13.0.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.9.0",
+    "copyfiles": "^2.4.1",
+    "typescript": "^5.6.3",
+    "@commitlint/cli": "^19.6.1",
+    "@commitlint/config-conventional": "^19.6.0",
+    "conventional-changelog-cli": "^5.0.0"
+  }
+}

package/types/controller/index.d.ts

@@ -0,0 +1,7 @@
+import Koa from 'koa';
+import { ASTCacheProp, InitOpts } from './meta';
+export declare const ASTCache: ASTCacheProp;
+export declare function useController(app: Koa, { root, prefix }: InitOpts): Promise<{
+    whitelist: string[];
+}>;
+export * from './meta';

package/types/controller/meta.d.ts

@@ -0,0 +1,59 @@
+import { ParameterizedContext } from "koa";
+import { IRouterParamContext } from "koa-router";
+export declare enum HttpMethod {
+    GET = "GET",
+    POST = "POST",
+    PATCH = "PATCH",
+    PUT = "PUT",
+    DELETE = "DELETE"
+}
+export declare class BaseController {
+    _ctx: ParameterizedContext<any, IRouterParamContext<any, {}>, any>;
+    constructor(_ctx: ParameterizedContext<any, IRouterParamContext<any, {}>, any>);
+    get pathname(): string;
+    get query(): import("querystring").ParsedUrlQuery;
+    get params(): Record<string, string>;
+    get body(): any;
+    files(): Promise<any>;
+    get status(): {
+        ok(data?: unknown): void;
+        okCreated(data: unknown, msg?: string): void;
+        okAccept(data: unknown, msg?: string): void;
+        parameterError(msg?: string): void;
+        unauthorized(msg?: string): void;
+        inaccessible(msg?: string): void;
+        exception(msg?: string): void;
+        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 interface ResData<T> {
+    msg: string;
+    code: number;
+    data: T;
+}
+export interface InitOpts {
+    root: string;
+    prefix?: string;
+}
+export interface ASTCacheHandler {
+    url: string;
+    method: string;
+    isPublic: boolean;
+    name: string;
+}
+export interface ASTCacheRoute {
+    Instance: any;
+    isPublic: boolean;
+    prefix: string;
+    handlers: ASTCacheHandler[];
+}
+export interface ASTCacheProp {
+    routes: ASTCacheRoute[];
+    whitelist: string[];
+}

package/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./controller";