init:完成ts和js双版本

Author: pedro

.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = false
+insert_final_newline = false

.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+dist

.eslintrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  "extends": "standard",
+  "rules": {
+    "semi": ["warn", "always"],
+    "quotes": ["warn", "double"],
+    "eol-last": 0
+  }
+};

.gitignore

@@ -0,0 +1,16 @@
+logs/
+npm-debug.log
+yarn-error.log
+node_modules/
+package-lock.json
+yarn.lock
+coverage/
+.idea/
+run/
+suspect/
+.DS_Store
+*.sw*
+*.un~
+.vscode/
+dist
+learn

README.md

@@ -0,0 +1,44 @@
+# lin-cms-koa
+
+> 以 koa 实现的 lin-cms 后台部分，支持 javasript 和 typescript 双语言版本
+
+## 提示
+
+**lin-cms-koa 目前仅作为个人项目进行开发，强烈不建议用于实际项目**
+
+lin-cms 的[前端仓库](https://github.com/TaleLin/lin-cms-vue)
+
+## 开始
+
+**以 typescript 的方式运行**
+
+```bash
+npm run start:dev
+```
+
+**将 typescript 编译成 javascript 的方式运行**
+
+```bash
+npm run tsc:prod && npm run start:prod
+```
+
+**通过 javascript 的方式直接运行**
+
+```bash
+node js/app/starter.js
+```
+
+## TODO LIST
+
+- [x] 全局异常处理
+- [x] 参数检验
+- [x] 多级路由，路由分层，路由前缀
+- [x] JWT 支持
+- [x] json 数据返回扩展
+- [x] 日志记录中间件
+- [x] ORM(typeorm)框架集成
+- [x] 配置文件驱动
+- [x] 业务
+- [x] 插件(推送)
+- [x] 将数据库操作抽象成 dto 层
+- [ ] 细节优化

jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node"
+};

js/app/api/cms/admin.js

@@ -0,0 +1,265 @@
+"use strict";
+
+const {
+  Redprint,
+  paginate,
+  routeMetaInfo,
+  adminRequired,
+  Success,
+  ParametersException,
+  NotFound,
+  Failed
+} = require("lin-cms-test");
+
+const {
+  has,
+  set,
+  get,
+  toSafeInteger,
+  isInteger
+} = require("lodash");
+const {
+  ResetPasswordForm,
+  UpdateUserInfoForm,
+  NewGroupForm,
+  UpdateGroupForm,
+  DispatchAuthForm,
+  DispatchAuthsForm,
+  RemoveAuthsForm
+} = require("../../validators/forms");
+const {
+  AdminDao
+} = require("../../dao/cms/admin");
+const {
+  getSafeParamId
+} = require("../../libs/util");
+
+const admin = new Redprint({
+  prefix: "/admin"
+});
+
+exports.admin = admin;
+const adminDao = new AdminDao();
+
+admin.redGet("getAuthority", "/authority", {
+  auth: "查询所有可分配的权限",
+  module: "管理员",
+  mount: false
+}, adminRequired, ctx => {
+  const res = {};
+  routeMetaInfo.forEach((v, k) => {
+    const au = v["auth"];
+    if (!has(res, `${v["module"]}.${au}`)) {
+      set(res, `${v["module"]}.${au}`, [k]);
+    } else {
+      res[v["module"]][au].push(k);
+    }
+  });
+  ctx.json(res);
+});
+
+admin.redGet("getAdminUsers", "/users", {
+  auth: "查询所有用户",
+  module: "管理员",
+  mount: false
+}, adminRequired, async (ctx) => {
+  const groupId = get(ctx.request.query, "group_id");
+  const {
+    start,
+    count
+  } = paginate(ctx);
+  const {
+    users,
+    total
+  } = await adminDao.getUsers(ctx, groupId, start, count);
+  ctx.json({
+    collection: users,
+    // 超级管理员不算入总数
+    total_nums: total
+  });
+});
+
+admin.redPut("changeUserPassword", "/password/:id", {
+  auth: "修改用户密码",
+  module: "管理员",
+  mount: false
+}, adminRequired, async (ctx) => {
+  const form = new ResetPasswordForm(ctx).validate();
+  const id = toSafeInteger(get(ctx.params, "id"));
+  if (!isInteger(id)) {
+    throw new ParametersException({
+      msg: "路由参数错误"
+    });
+  }
+  await adminDao.changeUserPassword(ctx, form, id);
+  ctx.json(new Success({
+    msg: "密码修改成功"
+  }));
+});
+
+admin.redDelete("deleteUser", "/:id", {
+  auth: "删除用户",
+  module: "管理员",
+  mount: false
+}, adminRequired, async (ctx) => {
+  const id = toSafeInteger(get(ctx.params, "id"));
+  if (!isInteger(id)) {
+    throw new ParametersException({
+      msg: "路由参数错误"
+    });
+  }
+  await adminDao.deleteUser(ctx, id);
+  ctx.json(new Success({
+    msg: "操作成功"
+  }));
+});
+
+admin.redPut("updateUser", "/:id", {
+  auth: "管理员更新用户信息",
+  module: "管理员",
+  mount: false
+}, adminRequired, async (ctx) => {
+  const form = new UpdateUserInfoForm(ctx).validate();
+  const id = toSafeInteger(get(ctx.params, "id"));
+  if (!isInteger(id)) {
+    throw new ParametersException({
+      msg: "路由参数错误"
+    });
+  }
+  await adminDao.updateUserInfo(ctx, form, id);
+  ctx.json(new Success({
+    msg: "操作成功"
+  }));
+});
+
+admin.redGet("getAdminGroups", "/groups", {
+  auth: "查询所有权限组及其权限",
+  module: "管理员",
+  mount: false
+}, adminRequired, async (ctx) => {
+  const {
+    start,
+    count
+  } = paginate(ctx);
+  const {
+    groups,
+    total
+  } = await adminDao.getGroups(ctx, start, count);
+  if (total < 1) {
+    throw new NotFound({
+      msg: "未找到任何权限组"
+    });
+  }
+  ctx.json({
+    collection: groups,
+    total_nums: total
+  });
+});
+
+admin.redGet("getAllGroup", "/group/all", {
+  auth: "查询所有权限组",
+  module: "管理员",
+  mount: false
+}, adminRequired, async (ctx) => {
+  const groups = await ctx.manager.groupModel.find();
+  if (!groups || groups.length < 1) {
+    throw new NotFound({
+      msg: "未找到任何权限组"
+    });
+  }
+  ctx.json(groups);
+});
+
+admin.redGet("getGroup", "/group/:id", {
+  auth: "查询一个权限组及其权限",
+  module: "管理员",
+  mount: false
+}, adminRequired, async (ctx) => {
+  const id = toSafeInteger(get(ctx.params, "id"));
+  if (!isInteger(id)) {
+    throw new ParametersException({
+      msg: "路由参数错误"
+    });
+  }
+  const group = await adminDao.getGroup(ctx, id);
+  ctx.json(group);
+});
+
+admin.redPost("createGroup", "/group", {
+  auth: "新建权限组",
+  module: "管理员",
+  mount: false
+}, adminRequired, async (ctx) => {
+  const form = new NewGroupForm(ctx).validate();
+  const ok = await adminDao.createGroup(ctx, form);
+  if (ok) {
+    ctx.json(new Failed({
+      msg: "新建分组失败"
+    }));
+  } else {
+    ctx.json(new Success({
+      msg: "新建分组成功"
+    }));
+  }
+});
+
+admin.redPut("updateGroup", "/group/:id", {
+  auth: "更新一个权限组",
+  module: "管理员",
+  mount: false
+}, adminRequired, async (ctx) => {
+  const id = getSafeParamId(ctx);
+  const form = new UpdateGroupForm(ctx).validate();
+  await adminDao.updateGroup(ctx, form, id);
+  ctx.json(new Success({
+    msg: "更新分组成功"
+  }));
+});
+
+admin.redDelete("deleteGroup", "/group/:id", {
+  auth: "删除一个权限组",
+  module: "管理员",
+  mount: false
+}, adminRequired, async (ctx) => {
+  const id = getSafeParamId(ctx);
+  await adminDao.deleteGroup(ctx, id);
+  ctx.json(new Success({
+    msg: "删除分组成功"
+  }));
+});
+
+admin.redPost("dispatchAuth", "/dispatch", {
+  auth: "分配单个权限",
+  module: "管理员",
+  mount: false
+}, adminRequired, async (ctx) => {
+  const form = new DispatchAuthForm(ctx).validate();
+  await adminDao.dispatchAuth(ctx, form);
+  ctx.json(new Success({
+    msg: "添加权限成功"
+  }));
+});
+
+admin.redPost("dispatchAuths", "/dispatch/patch", {
+  auth: "分配多个权限",
+  module: "管理员",
+  mount: false
+}, adminRequired, async (ctx) => {
+  const form = new DispatchAuthsForm(ctx).validate();
+  await adminDao.dispatchAuths(ctx, form);
+  ctx.json(new Success({
+    msg: "添加权限成功"
+  }));
+});
+
+admin.redPost("removeAuths", "/remove", {
+  auth: "删除多个权限",
+  module: "管理员",
+  mount: false
+}, adminRequired, async (ctx) => {
+  const form = new RemoveAuthsForm(ctx).validate();
+  await adminDao.removeAuths(ctx, form);
+  ctx.json(new Success({
+    msg: "删除权限成功"
+  }));
+});

js/app/api/cms/index.js

@@ -0,0 +1,28 @@
+"use strict";
+
+const {
+  user
+} = require("./user");
+const {
+  test
+} = require("./test");
+const {
+  log
+} = require("./log");
+const {
+  admin
+} = require("./admin");
+const {
+  Redprint
+} = require("lin-cms-test");
+
+const cms = new Redprint({
+  prefix: "/cms"
+});
+
+exports.cms = cms;
+
+cms.use(user.routes()).use(user.allowedMethods());
+cms.use(test.routes()).use(test.allowedMethods());
+cms.use(log.routes()).use(log.allowedMethods());
+cms.use(admin.routes()).use(admin.allowedMethods());