dinegg 3.0.0 → 3.0.3

package/app/extend/context.d.ts

@@ -1,6 +1,6 @@
 declare const _default: {
     throw(msg: string, ...args: any[]): never;
     success(data: any, code?: number, msg?: string): never;
-    error(data: any, code?: number, msg?: string): never;
+    error(msg: string, code?: number, msgDetails?: string[]): never;
 };
 export default _default;

package/app/extend/context.js

@@ -17,13 +17,14 @@ exports.default = {
         };
         throw { sendData, isDineggBizSuccess: true };
     },
-    error(data, code, msg) {
+    error(msg, code, msgDetails) {
         const sendData = {
-            data,
+            data: null,
             code: code || 50000,
-            msg: msg || "error",
+            msg: msg,
+            details: msgDetails || []
         };
         throw { sendData, isDineggBizSuccess: true };
     },
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbImNvbnRleHQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLGlDQUFpQzs7QUFZakMsNkJBQTZCO0FBRTdCLGtCQUFlO0lBQ2QsS0FBSyxDQUFDLEdBQVcsRUFBRSxHQUFHLElBQVc7UUFDaEMsR0FBRyxHQUFHLElBQUksQ0FBQyxNQUFNLENBQUMsR0FBRyxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUM7UUFDaEMsTUFBTSxDQUFDLEdBQVEsSUFBSSxLQUFLLENBQUMsVUFBVSxHQUFHLEVBQUUsQ0FBQyxDQUFDO1FBQzFDLENBQUMsQ0FBQyxnQkFBZ0IsR0FBRyxJQUFJLENBQUM7UUFDMUIsTUFBTSxDQUFDLENBQUM7SUFDVCxDQUFDO0lBQ0QsT0FBTyxDQUFDLElBQVMsRUFBRSxJQUFhLEVBQUUsR0FBWTtRQUM3QyxNQUFNLFFBQVEsR0FBc0I7WUFDbkMsSUFBSTtZQUNKLElBQUksRUFBRSxJQUFJLElBQUksS0FBSztZQUNuQixHQUFHLEVBQUUsR0FBRyxJQUFJLFNBQVM7U0FDckIsQ0FBQztRQUNGLE1BQU0sRUFBRSxRQUFRLEVBQUUsa0JBQWtCLEVBQUUsSUFBSSxFQUFFLENBQUM7SUFDOUMsQ0FBQztJQUNELEtBQUssQ0FBQyxJQUFTLEVBQUUsSUFBYSxFQUFFLEdBQVk7UUFDM0MsTUFBTSxRQUFRLEdBQXNCO1lBQ25DLElBQUk7WUFDSixJQUFJLEVBQUUsSUFBSSxJQUFJLEtBQUs7WUFDbkIsR0FBRyxFQUFFLEdBQUcsSUFBSSxPQUFPO1NBQ25CLENBQUM7UUFDRixNQUFNLEVBQUUsUUFBUSxFQUFFLGtCQUFrQixFQUFFLElBQUksRUFBRSxDQUFDO0lBQzlDLENBQUM7Q0FDRCxDQUFDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbImNvbnRleHQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLGlDQUFpQzs7QUFZakMsNkJBQTZCO0FBRTdCLGtCQUFlO0lBQ2QsS0FBSyxDQUFDLEdBQVcsRUFBRSxHQUFHLElBQVc7UUFDaEMsR0FBRyxHQUFHLElBQUksQ0FBQyxNQUFNLENBQUMsR0FBRyxFQUFFLEdBQUcsSUFBSSxDQUFDLENBQUM7UUFDaEMsTUFBTSxDQUFDLEdBQVEsSUFBSSxLQUFLLENBQUMsVUFBVSxHQUFHLEVBQUUsQ0FBQyxDQUFDO1FBQzFDLENBQUMsQ0FBQyxnQkFBZ0IsR0FBRyxJQUFJLENBQUM7UUFDMUIsTUFBTSxDQUFDLENBQUM7SUFDVCxDQUFDO0lBQ0QsT0FBTyxDQUFDLElBQVMsRUFBRSxJQUFhLEVBQUUsR0FBWTtRQUM3QyxNQUFNLFFBQVEsR0FBc0I7WUFDbkMsSUFBSTtZQUNKLElBQUksRUFBRSxJQUFJLElBQUksS0FBSztZQUNuQixHQUFHLEVBQUUsR0FBRyxJQUFJLFNBQVM7U0FDckIsQ0FBQztRQUNGLE1BQU0sRUFBRSxRQUFRLEVBQUUsa0JBQWtCLEVBQUUsSUFBSSxFQUFFLENBQUM7SUFDOUMsQ0FBQztJQUNELEtBQUssQ0FBQyxHQUFVLEVBQUUsSUFBYSxFQUFFLFVBQXFCO1FBQ3JELE1BQU0sUUFBUSxHQUFzQjtZQUNuQyxJQUFJLEVBQUMsSUFBSTtZQUNULElBQUksRUFBRSxJQUFJLElBQUksS0FBSztZQUNuQixHQUFHLEVBQUUsR0FBRztZQUNSLE9BQU8sRUFBQyxVQUFVLElBQUksRUFBRTtTQUN4QixDQUFDO1FBQ0YsTUFBTSxFQUFFLFFBQVEsRUFBRSxrQkFBa0IsRUFBRSxJQUFJLEVBQUUsQ0FBQztJQUM5QyxDQUFDO0NBQ0QsQ0FBQyJ9

package/config/config.default.js

@@ -44,9 +44,13 @@ exports.default = () => {
         secret: "fhsldghwoeihgtiowehrlgsdhfsljl24234hldkfsdfhls",
     };
     config.jwtLogin = {
+        enable: true,
         expires: 2000,
         routeWhiteList: [],
     };
+    config.catchNoCatchError = {
+        enable: true
+    };
     // sequelize 插件的配置
     config.sequelize = {};
     // 自定义一个常量自动加载
@@ -64,4 +68,4 @@ exports.default = () => {
     };
     return config;
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJjb25maWcuZGVmYXVsdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7OztHQU9HO0FBQ0gsWUFBWSxDQUFDOztBQUdiLDZCQUE2QjtBQUU3QixrQkFBZSxHQUFHLEVBQUU7SUFDbkIsTUFBTSxNQUFNLEdBQUcsRUFBZ0MsQ0FBQztJQUNoRCw4QkFBOEI7SUFDOUIsNkJBQTZCO0lBRTdCLFdBQVc7SUFDWCxNQUFNLENBQUMsUUFBUSxHQUFHO1FBQ2pCLElBQUksRUFBRSxLQUFLO1FBQ1gsZUFBZSxFQUFFLENBQUMsR0FBRyxDQUFDO0tBQ3RCLENBQUM7SUFDRixrQkFBa0I7SUFDbEIsTUFBTSxDQUFDLElBQUksR0FBRztRQUNiLE1BQU0sRUFBRSxHQUFHO1FBQ1gsWUFBWSxFQUFFLHdDQUF3QztLQUN0RCxDQUFDO0lBRUYsNkJBQTZCO0lBQzdCLE1BQU0sQ0FBQyxVQUFVLEdBQUc7UUFDbkIsU0FBUyxFQUFFLE9BQU87UUFDbEIsU0FBUyxFQUFFLE9BQU87S0FDbEIsQ0FBQztJQUVGLFVBQVU7SUFDVixNQUFNLENBQUMsTUFBTSxHQUFHO1FBQ2YsR0FBRyxFQUFFLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFFLE1BQU0sQ0FBQztRQUNyQyxVQUFVLEVBQUUsS0FBSztRQUNqQixZQUFZLEVBQUUsTUFBTTtLQUNwQixDQUFDO0lBQ0YsTUFBTSxDQUFDLFlBQVksR0FBRztJQUNyQixtQkFBbUI7SUFDbkIseURBQXlEO0lBQ3pELElBQUk7S0FDSixDQUFDO0lBRUYscUJBQXFCO0lBQ3JCLE1BQU0sQ0FBQyxHQUFHLEdBQUc7UUFDWixNQUFNLEVBQUUsZ0RBQWdEO0tBQ3hELENBQUM7SUFFRixNQUFNLENBQUMsUUFBUSxHQUFHO1FBQ2pCLE9BQU8sRUFBRSxJQUFJO1FBQ2IsY0FBYyxFQUFFLEVBQUU7S0FDbEIsQ0FBQztJQUVGLGtCQUFrQjtJQUNsQixNQUFNLENBQUMsU0FBUyxHQUFHLEVBQUUsQ0FBQztJQUV0QixjQUFjO0lBQ2QsTUFBTSxDQUFDLFlBQVksR0FBRztRQUNyQixNQUFNLEVBQUU7WUFDUCxNQUFNLEVBQUUsS0FBSztZQUNiLFFBQVEsRUFBRSxJQUFJO1lBQ2QsUUFBUSxFQUFFLEtBQUs7WUFDZixTQUFTLEVBQUUsT0FBTztZQUNsQixTQUFTLEVBQUUsWUFBWTtTQUN2QjtLQUNELENBQUM7SUFFRixNQUFNLENBQUMsSUFBSSxHQUFHO0lBQ2Isd0JBQXdCO0tBQ3hCLENBQUM7SUFFRixPQUFPLE1BQU0sQ0FBQztBQUNmLENBQUMsQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJjb25maWcuZGVmYXVsdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7OztHQU9HO0FBQ0gsWUFBWSxDQUFDOztBQUdiLDZCQUE2QjtBQUU3QixrQkFBZSxHQUFHLEVBQUU7SUFDbkIsTUFBTSxNQUFNLEdBQUcsRUFBZ0MsQ0FBQztJQUNoRCw4QkFBOEI7SUFDOUIsNkJBQTZCO0lBRTdCLFdBQVc7SUFDWCxNQUFNLENBQUMsUUFBUSxHQUFHO1FBQ2pCLElBQUksRUFBRSxLQUFLO1FBQ1gsZUFBZSxFQUFFLENBQUMsR0FBRyxDQUFDO0tBQ3RCLENBQUM7SUFDRixrQkFBa0I7SUFDbEIsTUFBTSxDQUFDLElBQUksR0FBRztRQUNiLE1BQU0sRUFBRSxHQUFHO1FBQ1gsWUFBWSxFQUFFLHdDQUF3QztLQUN0RCxDQUFDO0lBRUYsNkJBQTZCO0lBQzdCLE1BQU0sQ0FBQyxVQUFVLEdBQUc7UUFDbkIsU0FBUyxFQUFFLE9BQU87UUFDbEIsU0FBUyxFQUFFLE9BQU87S0FDbEIsQ0FBQztJQUVGLFVBQVU7SUFDVixNQUFNLENBQUMsTUFBTSxHQUFHO1FBQ2YsR0FBRyxFQUFFLElBQUksQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFFLE1BQU0sQ0FBQztRQUNyQyxVQUFVLEVBQUUsS0FBSztRQUNqQixZQUFZLEVBQUUsTUFBTTtLQUNwQixDQUFDO0lBQ0YsTUFBTSxDQUFDLFlBQVksR0FBRztJQUNyQixtQkFBbUI7SUFDbkIseURBQXlEO0lBQ3pELElBQUk7S0FDSixDQUFDO0lBRUYscUJBQXFCO0lBQ3JCLE1BQU0sQ0FBQyxHQUFHLEdBQUc7UUFDWixNQUFNLEVBQUUsZ0RBQWdEO0tBQ3hELENBQUM7SUFFRixNQUFNLENBQUMsUUFBUSxHQUFHO1FBQ2pCLE1BQU0sRUFBQyxJQUFJO1FBQ1gsT0FBTyxFQUFFLElBQUk7UUFDYixjQUFjLEVBQUUsRUFBRTtLQUNsQixDQUFDO0lBRUYsTUFBTSxDQUFDLGlCQUFpQixHQUFHO1FBQzFCLE1BQU0sRUFBQyxJQUFJO0tBQ1gsQ0FBQTtJQUVELGtCQUFrQjtJQUNsQixNQUFNLENBQUMsU0FBUyxHQUFHLEVBQUUsQ0FBQztJQUV0QixjQUFjO0lBQ2QsTUFBTSxDQUFDLFlBQVksR0FBRztRQUNyQixNQUFNLEVBQUU7WUFDUCxNQUFNLEVBQUUsS0FBSztZQUNiLFFBQVEsRUFBRSxJQUFJO1lBQ2QsUUFBUSxFQUFFLEtBQUs7WUFDZixTQUFTLEVBQUUsT0FBTztZQUNsQixTQUFTLEVBQUUsWUFBWTtTQUN2QjtLQUNELENBQUM7SUFFRixNQUFNLENBQUMsSUFBSSxHQUFHO0lBQ2Isd0JBQXdCO0tBQ3hCLENBQUM7SUFFRixPQUFPLE1BQU0sQ0FBQztBQUNmLENBQUMsQ0FBQyJ9

package/index.d.ts

@@ -51,7 +51,7 @@ declare module "egg" {
 		 * 与success对应
 		 * 抛出业务上的错误响应，但是http响应200，与throw不同，throw响应是400
 		 */
-		error(data:any,code?:number,msg?:string):never;
+		error(msg:string,code?:number,msgDetails?:string[]):never;
 	}
 
 	interface EggAppConfig {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dinegg",
-  "version": "3.0.0",
+  "version": "3.0.3",
   "description": "egg framework dinegg.",
   "dependencies": {
     "@diyaner/egg-sequelize": "^6.0.0",
@@ -71,6 +71,7 @@
     "agent.d.ts",
     "index.js",
     "index.d.ts",
+    "tshelper.js",
     "lib/**/*.d.ts",
     "decorator/**/*.js",
     "decorator/**/*.d.ts"

package/tshelper.js

@@ -0,0 +1,143 @@
+/*
+ * @copyright: Huang Ding
+ * @Author: ding-cx
+ * @Date: 2021-08-16 08:50:33
+ * @LastEditors: ding-cx
+ * @LastEditTime: 2021-10-21 16:30:24
+ * @Description: file content
+ *
+ * 若要改module和egg原来的service进行对调。就是module使用service，egg另外取名。
+ * 则
+ * 需修改interface IService
+ * declareTo Context.service
+ *
+ * pattern 应该跟随config配置的modules.imports一起设置。才能实现功能和代码提示一致。实现只使用某些模块。
+ *
+ */
+'use strict';
+// const path = require('path');
+// 引用egg-ts-helper 内部的，相当于替换默认auto的generator
+// const classGen = require("egg-ts-helper/dist/generators/class").default
+
+// 不用自定义生成器了。使用distName
+// const genratorService = (config, baseConfig) => {
+//   console.info(config);
+//   console.info(config.fileList);
+//   // console.info(baseConfig);
+
+//   const dtsDir = path.join(config.dtsDir, 'service.d.ts');
+
+//   config.interfaceHandle = config.interfaceHandle || 'AutoInstanceType<typeof {{ 0 }}>';
+
+//   const result = classGen(config, baseConfig);
+//   console.log(result);
+//   // 替换掉默认的，自定义就是改这里而已。
+//   result.dist = dtsDir;
+
+//   /* istanbul ignore else */
+//   if (result.content) {
+//     result.content = [
+//       'type AnyClass = new (...args: any[]) => any;',
+//       'type AnyFunc<T = any> = (...args: any[]) => T;',
+//       'type CanExportFunc = AnyFunc<Promise<any>> | AnyFunc<IterableIterator<any>>;',
+//       'type AutoInstanceType<T, U = T extends CanExportFunc ? T : T extends AnyFunc ? ReturnType<T> : T> = U extends AnyClass ? InstanceType<U> : U;',
+//       result.content,
+//     ].join('\n');
+//   }
+
+//   return result;
+// };
+
+module.exports = (importsModules = []) => {
+  const servicePattern = importsModules.length > 0 ? importsModules.map(mod => mod + '/**/*.service.(ts|js)') : '**/*.service.(ts|js)';
+  const controllerPattern = importsModules.length > 0 ? importsModules.map(mod => mod + '/**/*.controller.(ts|js)') : '**/*.controller.(ts|js)';
+
+  return {
+    watchDirs: {
+      moduleService: {
+        directory: 'app/modules', // 监听目录
+        pattern: servicePattern, // 遍历的文件表达式，一般都不需要改这个
+        // ignore: '', // 指定忽略某些文件的表达式，默认为空
+        generator: 'auto', // 生成器名称，取值为 class、auto、function、object
+        // generator: genratorService, // 生成器名称，取值为 class、auto、function、object
+        interface: 'IService', // interface 名称，如果不填的话，将会随机生成个 interface
+        // declareTo: 'Context.service', // 指定定义到 egg 的某个类型下
+        distName: 'service.d.ts', // 读源码发现可以传入此参数实现自定义声明文件名称。解决了问题，无需自定义。
+        watch: true, // 是否需要监听文件改动
+        caseStyle(pathItem) {
+          // 此处逻辑必须跟自定义加载器中的caseStyle自定义方法相一致，否则生成的d.ts无法对应。
+          pathItem = pathItem.replace(/.service$/, '');
+          if (!/^[a-z][a-z0-9_-]*$/i.test(pathItem)) {
+            throw new Error(`${pathItem} is not match 'a-z0-9_-' in ${pathItem}`);
+          }
+          pathItem = pathItem.replace(/[_-][a-z]/gi, s => s.substring(1).toUpperCase());
+          const first = pathItem[0];
+          return first.toLowerCase() + pathItem.substring(1);
+        }, // 模块命名格式
+        // interfaceHandle: val => `ReturnType<typeof ${val}>`, // interface 预处理方法
+        // trigger: ['add', 'unlink'], // 当接收到这些文件更改事件的时候，会触发 d.ts 的重新生成, 所有事件: ['add', 'unlink', 'change']
+      },
+      oldService: {
+        directory: 'app/service', // 监听目录
+        // pattern: servicePattern, // 遍历的文件表达式，一般都不需要改这个
+        // ignore: '', // 指定忽略某些文件的表达式，默认为空
+        generator: 'auto', // 生成器名称，取值为 class、auto、function、object
+        // generator: genratorService, // 生成器名称，取值为 class、auto、function、object
+        interface: 'oIService', // interface 名称，如果不填的话，将会随机生成个 interface
+        declareTo: 'Context.svs', // 指定定义到 egg 的某个类型下
+        distName: 'svs.d.ts', // 读源码发现可以传入此参数实现自定义声明文件名称。解决了问题，无需自定义。
+        watch: true, // 是否需要监听文件改动
+        caseStyle(pathItem) {
+          // 此处逻辑必须跟自定义加载器中的caseStyle自定义方法相一致，否则生成的d.ts无法对应。
+          //   pathItem = pathItem.replace(/.service$/, "");
+          if (!/^[a-z][a-z0-9_-]*$/i.test(pathItem)) {
+            throw new Error(`${pathItem} is not match 'a-z0-9_-' in ${pathItem}`);
+          }
+          pathItem = pathItem.replace(/[_-][a-z]/gi, s => s.substring(1).toUpperCase());
+          const first = pathItem[0];
+          return first.toLowerCase() + pathItem.substring(1);
+        }, // 模块命名格式
+        // interfaceHandle: val => `ReturnType<typeof ${val}>`, // interface 预处理方法
+        // trigger: ['add', 'unlink'], // 当接收到这些文件更改事件的时候，会触发 d.ts 的重新生成, 所有事件: ['add', 'unlink', 'change']
+      },
+      moduleController: {
+        directory: 'app/modules', // 监听目录
+        pattern: controllerPattern, // 遍历的文件表达式，一般都不需要改这个
+        // ignore: '', // 指定忽略某些文件的表达式，默认为空
+        generator: 'class', // 生成器名称，取值为 class、auto、function、object
+        interface: 'IController', // interface 名称，如果不填的话，将会随机生成个 interface
+        // declareTo: 'Application.controller_module', // 指定定义到 egg 的某个类型下 挂在IController上不是自定义的接口，所以不用再挂app
+        distName: 'controller.d.ts',
+        watch: true,
+        caseStyle(pathItem) {
+          // 此处逻辑必须跟自定义加载器中的caseStyle自定义方法相一致，否则生成的d.ts无法对应。
+          pathItem = pathItem.replace(/.controller$/, '');
+          if (!/^[a-z][a-z0-9_-]*$/i.test(pathItem)) {
+            throw new Error(`${pathItem} is not match 'a-z0-9_-' in ${pathItem}`);
+          }
+          pathItem = pathItem.replace(/[_-][a-z]/gi, s => s.substring(1).toUpperCase());
+          const first = pathItem[0];
+          return first.toLowerCase() + pathItem.substring(1);
+        }, // 模块命名格式
+      },
+      // 常量自动挂载
+      consts: {
+        directory: 'app/consts', // 监听目录
+        generator: 'object', // 生成器名称，取值为 class、auto、function、object
+        interface: 'IEggAppConsts', // interface 名称，如果不填的话，将会随机生成个 interface
+        declareTo: 'Application.consts', // 指定定义到 egg 的某个类型下 挂在IController上不是自定义的接口，所以不用再挂app
+        distName: 'consts.d.ts',
+        watch: true,
+        caseStyle(pathItem) {
+          // 此处逻辑必须跟自定义加载器中的caseStyle自定义方法相一致，否则生成的d.ts无法对应。
+          if (!/^[a-z][a-z0-9_-]*$/i.test(pathItem)) {
+            throw new Error(`${pathItem} is not match 'a-z0-9_-' in ${pathItem}`);
+          }
+          pathItem = pathItem.replace(/[_-][a-z]/gi, s => s.substring(1).toUpperCase());
+          const first = pathItem[0];
+          return first.toLowerCase() + pathItem.substring(1);
+        }, // 模块命名格式
+      },
+    },
+  };
+};