typespeed 2.0.20 → 2.0.22

package/README.md

@@ -6,29 +6,34 @@
 [![downloads](https://badgen.net/npm/dt/typespeed?color=pink)](https://www.npmjs.com/package/typespeed)
 [![license](https://badgen.net/github/license/speedphp/typespeed)](https://github.com/SpeedPHP/typespeed/blob/main/LICENSE)
 
-## 特点
+### 特点
 
+- 遵循 MIT 许可的开源项目。
+- 提供 22 个 TypeScript 装饰器，这些装饰器构成了完整的 Web 框架功能，包括对象管理、Web 路由、数据库操作等。
+- 通过命令行脚手架，可以快速创建项目，零配置启动。
+- 基于依赖注入、AOP、中间件和启动扫描等编程理念开发实现。
+- 底层采用 ExpressJS 实现，提供稳定、快速的 Web 服务。
+- 框架提供了两种风格不同却各具优点的数据操作模式。
 
+### 安装
 
-## 快速开始
+TypeSpeed 环境要求 NodeJS 16+，TypeScript 运行时。
 
 ```sh
-nodemon
+npm install typespeed -g
 ```
+### 使用
 
-### 环境要求
+```sh
+typespeed new blog
 
-* node v16+
+cd ./blog
 
-* typescript
-  ```sh
-  npm install typescript@latest -g
-  ```
+npm install
 
-### 安装
-
-## 使用
+npm run test
+```
 
-## 开源协议
+### 开源协议
 
 [MIT](LICENSE) © speedphp

package/dist/core.decorator.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.schedule = exports.getComponent = exports.getBean = exports.autoware = exports.config = exports.error = exports.value = exports.after = exports.before = exports.app = exports.log = exports.resource = exports.bean = exports.component = void 0;
+exports.schedule = exports.getComponent = exports.getBean = exports.autoware = exports.config = exports.error = exports.value = exports.app = exports.log = exports.resource = exports.bean = exports.component = void 0;
 require("reflect-metadata");
 const fs = require("fs");
 const path = require("path");
@@ -147,35 +147,6 @@ function error(message, ...optionalParams) {
     }
 }
 exports.error = error;
-function before(constructorFunction, methodName) {
-    const targetBean = getComponent(constructorFunction);
-    return function (target, propertyKey) {
-        const currentMethod = targetBean[methodName];
-        Object.assign(targetBean, {
-            [methodName]: function (...args) {
-                target[propertyKey](...args);
-                log("========== before ==========");
-                return currentMethod.apply(targetBean, args);
-            }
-        });
-    };
-}
-exports.before = before;
-function after(constructorFunction, methodName) {
-    const targetBean = getComponent(constructorFunction);
-    return function (target, propertyKey) {
-        const currentMethod = targetBean[methodName];
-        Object.assign(targetBean, {
-            [methodName]: function (...args) {
-                const result = currentMethod.apply(targetBean, args);
-                const afterResult = target[propertyKey](result);
-                log("========== after ==========");
-                return afterResult !== null && afterResult !== void 0 ? afterResult : result;
-            }
-        });
-    };
-}
-exports.after = after;
 function schedule(cronTime) {
     return (target, propertyKey) => {
         new cron.CronJob(cronTime, target[propertyKey]).start();

package/dist/default/default-authentication.class.js

@@ -0,0 +1,25 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const authentication_factory_class_1 = require("../factory/authentication-factory.class");
+const core_decorator_1 = require("../core.decorator");
+class DefaultAuthentication extends authentication_factory_class_1.default {
+    getAuthentication() {
+        return new DefaultAuthentication();
+    }
+}
+__decorate([
+    core_decorator_1.bean,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", authentication_factory_class_1.default)
+], DefaultAuthentication.prototype, "getAuthentication", null);
+exports.default = DefaultAuthentication;

package/dist/default/express-server.class.js

@@ -21,6 +21,7 @@ const server_factory_class_1 = require("../factory/server-factory.class");
 const route_decorator_1 = require("../route.decorator");
 const core_decorator_1 = require("../core.decorator");
 const redis_class_1 = require("./redis.class");
+const authentication_factory_class_1 = require("../factory/authentication-factory.class");
 class ExpressServer extends server_factory_class_1.default {
     getSever() {
         const server = new ExpressServer();
@@ -31,6 +32,7 @@ class ExpressServer extends server_factory_class_1.default {
         this.middlewareList.push(middleware);
     }
     start(port) {
+        this.app.use(this.authentication.afterCompletion);
         this.middlewareList.forEach(middleware => {
             this.app.use(middleware);
         });
@@ -59,10 +61,6 @@ class ExpressServer extends server_factory_class_1.default {
             }
             this.app.use(expressSession(sessionConfig));
         }
-        if (this.static) {
-            const staticPath = process.cwd() + this.static;
-            this.app.use(express.static(staticPath));
-        }
         if (this.favicon) {
             const faviconPath = process.cwd() + this.favicon;
             this.app.use(serveFavicon(faviconPath));
@@ -73,6 +71,11 @@ class ExpressServer extends server_factory_class_1.default {
         if (this.cookieConfig) {
             this.app.use(cookieParser(this.cookieConfig["secret"] || undefined, this.cookieConfig["options"] || {}));
         }
+        this.app.use(this.authentication.preHandle);
+        if (this.static) {
+            const staticPath = process.cwd() + this.static;
+            this.app.use(express.static(staticPath));
+        }
         (0, route_decorator_1.setRouter)(this.app);
         const errorPageDir = __dirname + "/pages";
         this.app.use((req, res) => {
@@ -138,6 +141,10 @@ __decorate([
     core_decorator_1.autoware,
     __metadata("design:type", redis_class_1.default)
 ], ExpressServer.prototype, "redisClient", void 0);
+__decorate([
+    core_decorator_1.autoware,
+    __metadata("design:type", authentication_factory_class_1.default)
+], ExpressServer.prototype, "authentication", void 0);
 __decorate([
     core_decorator_1.bean,
     __metadata("design:type", Function),

package/dist/default/log-default.class.js

@@ -15,12 +15,6 @@ class LogDefault extends log_factory_class_1.default {
     createLog() {
         return new LogDefault();
     }
-    log(message, ...optionalParams) {
-        console.log(message, ...optionalParams);
-    }
-    error(message, ...optionalParams) {
-        console.error(message, ...optionalParams);
-    }
 }
 __decorate([
     core_decorator_1.bean,

package/dist/factory/authentication-factory.class.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class AuthenticationFactory {
+    preHandle(req, res, next) {
+        next();
+    }
+    afterCompletion(req, res, next) {
+        next();
+    }
+}
+exports.default = AuthenticationFactory;

package/dist/factory/log-factory.class.js

@@ -1,5 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 class LogFactory {
+    log(message, ...optionalParams) {
+        console.log(message, ...optionalParams);
+    }
+    error(message, ...optionalParams) {
+        console.error(message, ...optionalParams);
+    }
+    debug(message, ...optionalParams) {
+        console.debug(message, ...optionalParams);
+    }
 }
 exports.default = LogFactory;

package/dist/route.decorator.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.jwt = exports.upload = exports.setRouter = exports.requestMapping = exports.postMapping = exports.getMapping = void 0;
+exports.jwt = exports.upload = exports.setRouter = exports.requestMapping = exports.postMapping = exports.getMapping = exports.after = exports.before = exports.response = exports.res = exports.request = exports.req = exports.reqParam = exports.reqForm = exports.reqQuery = exports.reqBody = exports.next = void 0;
 const multiparty = require("multiparty");
 const express_jwt_1 = require("express-jwt");
 const core_decorator_1 = require("./core.decorator");
@@ -9,6 +9,8 @@ const routerMapper = {
     "post": {},
     "all": {}
 };
+const routerParams = {};
+const routerParamsTotal = {};
 const routerMiddleware = {};
 function setRouter(app) {
     ["get", "post", "all"].forEach(method => {
@@ -33,7 +35,19 @@ function mapperFunction(method, value) {
             "invoker": async (req, res, next) => {
                 const routerBean = (0, core_decorator_1.getComponent)(target.constructor);
                 try {
-                    const testResult = await routerBean[propertyKey](req, res);
+                    let paramTotal = routerBean[propertyKey].length;
+                    if (routerParamsTotal[[target.constructor.name, propertyKey].toString()]) {
+                        paramTotal = Math.max(paramTotal, routerParamsTotal[[target.constructor.name, propertyKey].toString()]);
+                    }
+                    let args = [req, res, next];
+                    if (paramTotal > 0) {
+                        for (let i = 0; i < paramTotal; i++) {
+                            if (routerParams[[target.constructor.name, propertyKey, i].toString()]) {
+                                args[i] = routerParams[[target.constructor.name, propertyKey, i].toString()](req, res, next);
+                            }
+                        }
+                    }
+                    const testResult = await routerBean[propertyKey].apply(routerBean, args);
                     if (typeof testResult === "object") {
                         res.json(testResult);
                     }
@@ -78,6 +92,82 @@ function jwt(jwtConfig) {
     };
 }
 exports.jwt = jwt;
+function before(constructorFunction, methodName) {
+    const targetBean = (0, core_decorator_1.getComponent)(constructorFunction);
+    return function (target, propertyKey) {
+        const currentMethod = targetBean[methodName];
+        if (currentMethod.length > 0) {
+            routerParamsTotal[[constructorFunction.name, methodName].toString()] = currentMethod.length;
+        }
+        Object.assign(targetBean, {
+            [methodName]: function (...args) {
+                target[propertyKey](...args);
+                return currentMethod.apply(targetBean, args);
+            }
+        });
+    };
+}
+exports.before = before;
+function after(constructorFunction, methodName) {
+    const targetBean = (0, core_decorator_1.getComponent)(constructorFunction);
+    return function (target, propertyKey) {
+        const currentMethod = targetBean[methodName];
+        if (currentMethod.length > 0) {
+            routerParamsTotal[[constructorFunction.name, methodName].toString()] = currentMethod.length;
+        }
+        Object.assign(targetBean, {
+            [methodName]: function (...args) {
+                const result = currentMethod.apply(targetBean, args);
+                const afterResult = target[propertyKey](result);
+                return afterResult !== null && afterResult !== void 0 ? afterResult : result;
+            }
+        });
+    };
+}
+exports.after = after;
+function req(target, propertyKey, parameterIndex) {
+    const key = [target.constructor.name, propertyKey, parameterIndex].toString();
+    routerParams[key] = (req, res, next) => req;
+}
+exports.req = req;
+exports.request = req;
+function res(target, propertyKey, parameterIndex) {
+    const key = [target.constructor.name, propertyKey, parameterIndex].toString();
+    routerParams[key] = (req, res, next) => res;
+}
+exports.res = res;
+exports.response = res;
+function next(target, propertyKey, parameterIndex) {
+    const key = [target.constructor.name, propertyKey, parameterIndex].toString();
+    routerParams[key] = (req, res, next) => next;
+}
+exports.next = next;
+function reqBody(target, propertyKey, parameterIndex) {
+    const key = [target.constructor.name, propertyKey, parameterIndex].toString();
+    routerParams[key] = (req, res, next) => req.body;
+}
+exports.reqBody = reqBody;
+function reqParam(paramName) {
+    return (target, propertyKey, parameterIndex) => {
+        const key = [target.constructor.name, propertyKey, parameterIndex].toString();
+        routerParams[key] = (req, res, next) => req.params[paramName];
+    };
+}
+exports.reqParam = reqParam;
+function reqQuery(paramName) {
+    return (target, propertyKey, parameterIndex) => {
+        const key = [target.constructor.name, propertyKey, parameterIndex].toString();
+        routerParams[key] = (req, res, next) => req.query[paramName];
+    };
+}
+exports.reqQuery = reqQuery;
+function reqForm(paramName) {
+    return (target, propertyKey, parameterIndex) => {
+        const key = [target.constructor.name, propertyKey, parameterIndex].toString();
+        routerParams[key] = (req, res, next) => req.body[paramName];
+    };
+}
+exports.reqForm = reqForm;
 const getMapping = (value) => mapperFunction("get", value);
 exports.getMapping = getMapping;
 const postMapping = (value) => mapperFunction("post", value);

package/dist/scaffold/command.js

@@ -25,7 +25,7 @@ program.on('--help', () => {
     console.log('');
     console.log('  Examples:');
     console.log('');
-    console.log('    $ speed new blog');
+    console.log('    $ typespeed new blog');
 });
 program.parse(process.argv);
 function mkFile(fileName, targetPath, appName) {

package/dist/typespeed.d.ts

@@ -192,12 +192,17 @@ declare abstract class LogFactory {
      * 日志打印方法
      * @param message 日志内容
      */
-    abstract log(message?: any, ...optionalParams: any[]): void;
+    log(message?: any, ...optionalParams: any[]): void;
     /**
      * 错误日志打印方法
      * @param message 日志内容
      */
-    abstract error(message?: any, ...optionalParams: any[]): void;
+    error(message?: any, ...optionalParams: any[]): void;
+    /**
+     * 调试日志打印方法
+     * @param message 日志内容
+     */
+    debug(message?: any, ...optionalParams: any[]): void;
 }
 /**数据源工厂类 */
 declare abstract class DataSourceFactory {
@@ -234,6 +239,23 @@ declare abstract class CacheFactory {
     /**清空缓存 */
     abstract flush(): void;
 }
+/**认证类 */
+declare abstract class AuthenticationFactory {
+    /**
+     * 路由页面执行前认证
+     * @param req 请求对象
+     * @param res 响应对象
+     * @param next 下一步函数
+     */
+    preHandle(req: express.Request, res: express.Response, next: express.NextFunction): void;
+    /**
+     * 开始执行中间件前认证
+     * @param req 请求对象
+     * @param res 响应对象
+     * @param next 下一步函数
+     */
+    afterCompletion(req: express.Request, res: express.Response, next: express.NextFunction): void;
+}
 /**Redis 操作类 */
 declare class Redis extends IoRedis {
     /**获取 Redis 实例 */
@@ -322,4 +344,4 @@ declare class ExpressServer extends ServerFactory {
     private setDefaultMiddleware;
 }
 
-export { ExpressServer, LogDefault, NodeCache, RabbitMQ, rabbitListener, ReadWriteDb, Redis, CacheFactory, DataSourceFactory, LogFactory, ServerFactory, component, bean, resource, log, app, before, after, value, error, config, autoware, getBean, getComponent, schedule, getMapping, postMapping, requestMapping, setRouter, upload, jwt, insert, update, remove, select, param, resultType, cache, Model };
+export { ExpressServer, LogDefault, NodeCache, RabbitMQ, rabbitListener, ReadWriteDb, Redis, CacheFactory, DataSourceFactory, LogFactory, ServerFactory, AuthenticationFactory, component, bean, resource, log, app, before, after, value, error, config, autoware, getBean, getComponent, schedule, getMapping, postMapping, requestMapping, setRouter, upload, jwt, insert, update, remove, select, param, resultType, cache, Model};

package/dist/typespeed.js

@@ -14,7 +14,7 @@ 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 });
-exports.ReadWriteDb = exports.Redis = exports.NodeCache = exports.LogDefault = exports.ExpressServer = exports.ServerFactory = exports.DataSourceFactory = exports.CacheFactory = exports.LogFactory = void 0;
+exports.ReadWriteDb = exports.Redis = exports.NodeCache = exports.LogDefault = exports.ExpressServer = exports.AuthenticationFactory = exports.ServerFactory = exports.DataSourceFactory = exports.CacheFactory = exports.LogFactory = void 0;
 __exportStar(require("./core.decorator"), exports);
 __exportStar(require("./route.decorator"), exports);
 __exportStar(require("./database.decorator"), exports);
@@ -26,6 +26,8 @@ var data_source_factory_class_1 = require("./factory/data-source-factory.class")
 Object.defineProperty(exports, "DataSourceFactory", { enumerable: true, get: function () { return data_source_factory_class_1.default; } });
 var server_factory_class_1 = require("./factory/server-factory.class");
 Object.defineProperty(exports, "ServerFactory", { enumerable: true, get: function () { return server_factory_class_1.default; } });
+var authentication_factory_class_1 = require("./factory/authentication-factory.class");
+Object.defineProperty(exports, "AuthenticationFactory", { enumerable: true, get: function () { return authentication_factory_class_1.default; } });
 var express_server_class_1 = require("./default/express-server.class");
 Object.defineProperty(exports, "ExpressServer", { enumerable: true, get: function () { return express_server_class_1.default; } });
 var log_default_class_1 = require("./default/log-default.class");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typespeed",
-  "version": "2.0.20",
+  "version": "2.0.22",
   "description": "A new Framework for TypeScript.",
   "author": "speedphp",
   "license": "MIT License",
@@ -20,6 +20,15 @@
     "type": "git",
     "url": "git+https://github.com/speedphp/typespeed.git"
   },
+  "keywords": [
+    "framework",
+    "express",
+    "web",
+    "app",
+    "api",
+    "model",
+    "middleware"
+  ],
   "dependencies": {
     "@types/node": "^18.0.6",
     "commander": "^9.4.0",

package/src/core.decorator.ts

@@ -145,34 +145,6 @@ function error(message?: any, ...optionalParams: any[]) {
     }
 }
 
-function before(constructorFunction, methodName: string) {
-    const targetBean = getComponent(constructorFunction);
-    return function (target, propertyKey: string) {
-        const currentMethod = targetBean[methodName];
-        Object.assign(targetBean, {
-            [methodName]: function (...args) {
-                target[propertyKey](...args);
-                log("========== before ==========");
-                return currentMethod.apply(targetBean, args);
-            }
-        })
-    };
-}
-
-function after(constructorFunction, methodName: string) {
-    const targetBean = getComponent(constructorFunction);
-    return function (target, propertyKey: string) {
-        const currentMethod = targetBean[methodName];
-        Object.assign(targetBean, {
-            [methodName]: function (...args) {
-                const result = currentMethod.apply(targetBean, args);
-                const afterResult = target[propertyKey](result);
-                log("========== after ==========");
-                return afterResult ?? result;
-            }
-        })
-    };
-}
 
 function schedule(cronTime: string | Date) {
     return (target: any, propertyKey: string) => {
@@ -180,4 +152,4 @@ function schedule(cronTime: string | Date) {
     }
 }
 
-export { component, bean, resource, log, app, before, after, value, error, config, autoware, getBean, getComponent, schedule };
+export { component, bean, resource, log, app, value, error, config, autoware, getBean, getComponent, schedule };

package/src/default/default-authentication.class.ts

@@ -0,0 +1,10 @@
+import AuthenticationFactory from "../factory/authentication-factory.class";
+import { bean } from "../core.decorator";
+
+export default class DefaultAuthentication extends AuthenticationFactory{
+    @bean
+    public getAuthentication(): AuthenticationFactory {
+        return new DefaultAuthentication();
+    }
+}
+

package/src/default/express-server.class.ts

@@ -10,6 +10,7 @@ import ServerFactory from "../factory/server-factory.class";
 import { setRouter } from "../route.decorator";
 import { bean, log, value, error, autoware } from "../core.decorator";
 import Redis from "./redis.class";
+import AuthenticationFactory from "../factory/authentication-factory.class";
 
 export default class ExpressServer extends ServerFactory {
 
@@ -37,6 +38,9 @@ export default class ExpressServer extends ServerFactory {
     @autoware
     private redisClient: Redis;
 
+    @autoware
+    public authentication: AuthenticationFactory;
+
     @bean
     public getSever(): ServerFactory {
         const server = new ExpressServer();
@@ -49,6 +53,8 @@ export default class ExpressServer extends ServerFactory {
     }
 
     public start(port: number) {
+        this.app.use(this.authentication.afterCompletion);
+        
         this.middlewareList.forEach(middleware => {
             this.app.use(middleware);
         });
@@ -82,11 +88,6 @@ export default class ExpressServer extends ServerFactory {
             this.app.use(expressSession(sessionConfig));
         }
 
-        if (this.static) {
-            const staticPath = process.cwd() + this.static;
-            this.app.use(express.static(staticPath))
-        }
-
         if (this.favicon) {
             const faviconPath = process.cwd() + this.favicon;
             this.app.use(serveFavicon(faviconPath));
@@ -100,6 +101,12 @@ export default class ExpressServer extends ServerFactory {
             this.app.use(cookieParser(this.cookieConfig["secret"] || undefined, this.cookieConfig["options"] || {}));
         }
 
+        this.app.use(this.authentication.preHandle);
+
+        if (this.static) {
+            const staticPath = process.cwd() + this.static;
+            this.app.use(express.static(staticPath))
+        }
         setRouter(this.app);
 
         const errorPageDir = __dirname + "/pages";

package/src/default/log-default.class.ts

@@ -2,18 +2,8 @@ import { bean } from "../core.decorator";
 import LogFactory from "../factory/log-factory.class";
 
 export default class LogDefault extends LogFactory {
-
     @bean
     createLog(): LogFactory {
         return new LogDefault();
     }
-
-    public log(message?: any, ...optionalParams: any[]): void {
-        console.log(message, ...optionalParams);
-    }
-
-    public error(message?: any, ...optionalParams: any[]) : void{
-        console.error(message, ...optionalParams);
-    }
-
 }

package/src/factory/authentication-factory.class.ts

@@ -0,0 +1,9 @@
+import * as express from 'express';
+export default abstract class AuthenticationFactory {
+    public preHandle(req: express.Request, res: express.Response, next: express.NextFunction): void{
+        next();
+    }
+    public afterCompletion(req: express.Request, res: express.Response, next: express.NextFunction): void{
+        next();
+    }
+}

package/src/factory/log-factory.class.ts

@@ -1,4 +1,11 @@
 export default abstract class LogFactory {
-    abstract log(message?: any, ...optionalParams: any[]) : void;
-    abstract error(message?: any, ...optionalParams: any[]) : void;
+    public log(message?: any, ...optionalParams: any[]) : void {
+        console.log(message, ...optionalParams);
+    }
+    public error(message?: any, ...optionalParams: any[]) : void {
+        console.error(message, ...optionalParams);
+    }
+    public debug(message?: any, ...optionalParams: any[]) : void {
+        console.debug(message, ...optionalParams);
+    }
 }