@kne/fastify-account 2.0.1 → 2.0.3

package/README.md

@@ -1,18 +1,43 @@
 
-# fastify-user
+# fastify-account
 
 
 ### 描述
 
-用于用户注册登录认证
+用于用户注册登录认证.
 
 
 ### 安装
 
 ```shell
-npm i --save @kne/fastify-user
+npm i --save @kne/fastify-account
 ```
 
+
+### 概述
+
+#### 功能模块
+- **账号管理**：提供用户注册、登录、密码修改、忘记密码等功能。
+- **用户信息管理**：支持用户信息的获取和更新。
+- **验证码服务**：支持邮箱和短信验证码的发送与验证。
+
+#### 技术栈
+- **后端框架**：Fastify
+- **数据库**：Sequelize（支持多种数据库）
+- **认证**：JWT（JSON Web Token）
+- **密码加密**：bcryptjs
+- **工具库**：Lodash、Day.js
+
+#### 核心模块
+- **models**：定义数据模型（用户、账号、验证码等）。
+- **services**：业务逻辑层，处理核心功能。
+- **controllers**：API接口层，定义路由和请求处理。
+
+#### 项目特点
+- 模块化设计，易于扩展和维护。
+- 支持多租户功能。
+- 提供详细的错误处理和日志记录。
+
 ### 示例
 
 #### 示例代码
@@ -21,7 +46,24 @@ npm i --save @kne/fastify-user
 
 ### API
 
-| 属性名 | 说明 | 类型 | 默认值 |
-|-----|----|----|-----|
-|     |    |    |     |
+#### 账号管理
+
+| 路径 | 方法 | 描述 | 参数 |
+|------|------|------|------|
+| `/api/account/v1.0.0/account/sendEmailCode` | POST | 发送登录邮箱验证码 | `email` (string), `type` (number), `options` (object) |
+| `/api/account/v1.0.0/account/sendSMSCode` | POST | 发送登录短信验证码 | `phone` (string), `type` (number), `options` (object) |
+| `/api/account/v1.0.0/account/validateCode` | POST | 验证码验证 | `name` (string), `type` (number), `code` (string) |
+| `/api/account/v1.0.0/account/accountIsExists` | POST | 账号是否已存在 | `phone` (string) 或 `email` (string) |
+| `/api/account/v1.0.0/account/register` | POST | 注册账号 | `phone` (string) 或 `email` (string), `password` (string), `code` (string), 其他可选字段 |
+| `/api/account/v1.0.0/account/login` | POST | 登录 | `type` (string), `email` (string) 或 `phone` (string), `password` (string) |
+| `/api/account/v1.0.0/account/modifyPassword` | POST | 修改密码 | `email` (string) 或 `phone` (string), `newPwd` (string), `oldPwd` (string) |
+| `/api/account/v1.0.0/account/resetPassword` | POST | 重置密码 | `newPwd` (string), `token` (string) |
+| `/api/account/v1.0.0/account/forgetPwd` | POST | 忘记密码 | `email` (string) 或 `phone` (string) |
+| `/api/account/v1.0.0/account/parseResetToken` | POST | 通过token获取name | `token` (string) |
+
+#### 用户信息管理
 
+| 路径 | 方法 | 描述 | 参数 |
+|------|------|------|------|
+| `/api/account/v1.0.0/user/getUserInfo` | GET | 获取用户信息 | 无 |
+| `/api/account/v1.0.0/user/saveUserInfo` | POST | 更新用户信息 | `avatar` (string), `nickname` (string), `email` (string), `phone` (string), `gender` (string), `birthday` (string), `description` (string) |

package/libs/controllers/admin-user.js

@@ -1,110 +1,110 @@
 const fp = require('fastify-plugin');
 
 const adminUserController = fp(async (fastify, options) => {
-    const {services, authenticate} = fastify[options.name];
-    fastify.get(`${options.prefix}/admin/getUserList`, {
-        onRequest: [authenticate.user, authenticate.admin], schema: {
-            tags: ['管理后台'], summary: '获取用户列表', query: {
-                type: 'object', properties: {
-                    perPage: {type: 'number'}, currentPage: {type: 'number'}
-                }
-            }
+  const { services, authenticate } = fastify[options.name];
+  fastify.get(`${options.prefix}/admin/getUserList`, {
+    onRequest: [authenticate.user, authenticate.admin], schema: {
+      tags: ['管理后台'], summary: '获取用户列表', query: {
+        type: 'object', properties: {
+          perPage: { type: 'number' }, currentPage: { type: 'number' }
         }
-    }, async request => {
-        const {filter, perPage, currentPage} = Object.assign({
-            perPage: 20, currentPage: 1
-        }, request.query);
-        return await services.user.getUserList({
-            filter, perPage, currentPage
-        });
+      }
+    }
+  }, async request => {
+    const { filter, perPage, currentPage } = Object.assign({
+      perPage: 20, currentPage: 1
+    }, request.query);
+    return await services.user.getUserList({
+      filter, perPage, currentPage
     });
+  });
 
-    fastify.post(`${options.prefix}/admin/resetUserPassword`, {
-        onRequest: [authenticate.user, authenticate.admin], schema: {
-            tags: ['管理后台'], summary: '重置用户账号密码', body: {
-                type: 'object', required: ['userId', 'password'], properties: {
-                    password: {type: 'string'}, userId: {type: 'string'}
-                }
-            }
+  fastify.post(`${options.prefix}/admin/resetUserPassword`, {
+    onRequest: [authenticate.user, authenticate.admin], schema: {
+      tags: ['管理后台'], summary: '重置用户账号密码', body: {
+        type: 'object', required: ['userId', 'password'], properties: {
+          password: { type: 'string' }, userId: { type: 'string' }
         }
-    }, async request => {
-        await services.account.resetPassword(request.body);
-        return {};
-    });
+      }
+    }
+  }, async request => {
+    await services.account.resetPassword(request.body);
+    return {};
+  });
 
-    fastify.post(`${options.prefix}/admin/addUser`, {
-        onRequest: [authenticate.user, authenticate.admin], schema: {
-            tags: ['管理后台'], summary: '添加用户', body: {}
-        }
-    }, async request => {
-        const userInfo = request.body;
-        await services.user.addUser(Object.assign({}, userInfo, {
-            status: 10, password: services.account.md5(options.defaultPassword)
-        }));
-        return {};
-    });
+  fastify.post(`${options.prefix}/admin/addUser`, {
+    onRequest: [authenticate.user, authenticate.admin], schema: {
+      tags: ['管理后台'], summary: '添加用户', body: {}
+    }
+  }, async request => {
+    const userInfo = request.body;
+    await services.user.addUser(Object.assign({}, userInfo, {
+      status: 10, password: services.account.md5(options.defaultPassword)
+    }));
+    return {};
+  });
 
-    fastify.post(`${options.prefix}/admin/saveUser`, {
-        onRequest: [authenticate.user, authenticate.admin], schema: {
-            tags: ['管理后台'], summary: '修改用户信息', body: {
-                type: 'object', required: ['id'], properties: {
-                    id: {type: 'string'},
-                    avatar: {type: 'string'},
-                    nickname: {type: 'string'},
-                    phone: {type: 'string'},
-                    email: {type: 'string'},
-                    description: {type: 'string'}
-                }
-            }
+  fastify.post(`${options.prefix}/admin/saveUser`, {
+    onRequest: [authenticate.user, authenticate.admin], schema: {
+      tags: ['管理后台'], summary: '修改用户信息', body: {
+        type: 'object', required: ['id'], properties: {
+          id: { type: 'string' },
+          avatar: { type: 'string' },
+          nickname: { type: 'string' },
+          phone: { type: 'string', default: '' },
+          email: { type: 'string', default: '' },
+          description: { type: 'string', default: '' }
         }
-    }, async request => {
-        const user = request.body;
-        await services.user.saveUser(user);
-        return {};
-    });
+      }
+    }
+  }, async request => {
+    const user = request.body;
+    await services.user.saveUser(user);
+    return {};
+  });
 
-    fastify.post(`${options.prefix}/admin/setSuperAdmin`, {
-        onRequest: [authenticate.user, authenticate.admin], schema: {
-            tags: ['管理后台'], summary: '设置用户为超级管理员', body: {
-                type: 'object', required: ['status', 'userId'], properties: {
-                    status: {type: 'boolean', description: 'true:将用户设置为超级管理员,false:取消用户超级管理员'},
-                    userId: {type: 'string', description: '用户id'}
-                }
-            }
+  fastify.post(`${options.prefix}/admin/setSuperAdmin`, {
+    onRequest: [authenticate.user, authenticate.admin], schema: {
+      tags: ['管理后台'], summary: '设置用户为超级管理员', body: {
+        type: 'object', required: ['status', 'userId'], properties: {
+          status: { type: 'boolean', description: 'true:将用户设置为超级管理员,false:取消用户超级管理员' },
+          userId: { type: 'string', description: '用户id' }
         }
-    }, async request => {
-        const {status, userId} = request.body;
-        await services.user.setSuperAdmin({userId, status});
-        return {};
-    });
+      }
+    }
+  }, async request => {
+    const { status, userId } = request.body;
+    await services.user.setSuperAdmin({ userId, status });
+    return {};
+  });
 
-    fastify.post(`${options.prefix}/admin/setUserClose`, {
-        onRequest: [authenticate.user, authenticate.admin], schema: {
-            tags: ['管理后台'], summary: '关闭用户', body: {
-                type: 'object', required: ['id'], properties: {
-                    id: {type: 'string'}
-                }
-            }
+  fastify.post(`${options.prefix}/admin/setUserClose`, {
+    onRequest: [authenticate.user, authenticate.admin], schema: {
+      tags: ['管理后台'], summary: '关闭用户', body: {
+        type: 'object', required: ['id'], properties: {
+          id: { type: 'string' }
         }
-    }, async request => {
-        const {id} = request.body;
-        await services.user.setUserStatus({userId: id, status: 12});
-        return {};
-    });
+      }
+    }
+  }, async request => {
+    const { id } = request.body;
+    await services.user.setUserStatus({ userId: id, status: 12 });
+    return {};
+  });
 
-    fastify.post(`${options.prefix}/admin/setUserNormal`, {
-        onRequest: [authenticate.user, authenticate.admin], schema: {
-            tags: ['管理后台'], summary: '设置用户状态为正常', body: {
-                type: 'object', required: ['id'], properties: {
-                    id: {type: 'string'}
-                }
-            }
+  fastify.post(`${options.prefix}/admin/setUserNormal`, {
+    onRequest: [authenticate.user, authenticate.admin], schema: {
+      tags: ['管理后台'], summary: '设置用户状态为正常', body: {
+        type: 'object', required: ['id'], properties: {
+          id: { type: 'string' }
         }
-    }, async request => {
-        const {id} = request.body;
-        await services.user.setUserStatus({userId: id, status: 0});
-        return {};
-    });
+      }
+    }
+  }, async request => {
+    const { id } = request.body;
+    await services.user.setUserStatus({ userId: id, status: 0 });
+    return {};
+  });
 });
 
 module.exports = adminUserController;

package/libs/models/user.js

@@ -2,58 +2,34 @@ const user = ({ DataTypes, definePrimaryType }) => {
   return {
     model: {
       nickname: {
-        type: DataTypes.STRING,
-        comment: '用户昵称'
-      },
-      email: {
-        type: DataTypes.STRING,
-        comment: '用户邮箱'
-      },
-      phone: {
-        type: DataTypes.STRING,
-        comment: '用户手机号'
-      },
-      userAccountId: definePrimaryType('userAccountId', {
-        allowNull: false,
-        comment: '当前账号id'
-      }),
-      status: {
-        type: DataTypes.INTEGER,
-        defaultValue: 0,
-        comment: '0:正常,10:初始化未激活，需要用户设置密码后使用,11:已禁用,12:已关闭'
-      },
-      avatar: {
-        type: DataTypes.STRING,
-        comment: '头像fileId'
-      },
-      gender: {
-        type: DataTypes.STRING,
-        comment: 'F:女,M:男'
-      },
-      birthday: {
-        type: DataTypes.DATE,
-        comment: '出生日期'
-      },
-      description: {
-        type: DataTypes.TEXT,
-        comment: '个人描述'
-      },
-      isSuperAdmin: {
-        type: DataTypes.BOOLEAN,
-        comment: '是否是平台超级管理员'
-      }
-    },
-    options: {
-      indexes: [
-        {
-          unique: true,
-          fields: ['email', 'deleted_at']
-        },
-        {
-          unique: true,
-          fields: ['phone', 'deleted_at']
+        type: DataTypes.STRING, comment: '用户昵称'
+      }, email: {
+        type: DataTypes.STRING, comment: '用户邮箱', set(value) {
+          this.setDataValue('email', value ? value.toLowerCase() : value);
         }
-      ]
+      }, phone: {
+        type: DataTypes.STRING, comment: '用户手机号'
+      }, userAccountId: definePrimaryType('userAccountId', {
+        allowNull: false, comment: '当前账号id'
+      }), status: {
+        type: DataTypes.INTEGER, defaultValue: 0, comment: '0:正常,10:初始化未激活，需要用户设置密码后使用,11:已禁用,12:已关闭'
+      }, avatar: {
+        type: DataTypes.STRING, comment: '头像fileId'
+      }, gender: {
+        type: DataTypes.STRING, comment: 'F:女,M:男'
+      }, birthday: {
+        type: DataTypes.DATE, comment: '出生日期'
+      }, description: {
+        type: DataTypes.TEXT, comment: '个人描述'
+      }, isSuperAdmin: {
+        type: DataTypes.BOOLEAN, comment: '是否是平台超级管理员'
+      }
+    }, options: {
+      indexes: [{
+        unique: true, fields: ['email', 'deleted_at']
+      }, {
+        unique: true, fields: ['phone', 'deleted_at']
+      }]
     }
   };
 };

package/libs/services/account.js

@@ -122,7 +122,7 @@ const accountService = fp(async (fastify, options) => {
     };
     (() => {
       if (type === 'email') {
-        query.email = email;
+        query.email = email.toLowerCase();
         return;
       }
       if (type === 'phone') {

package/libs/services/user.js

@@ -36,19 +36,17 @@ const userService = fp(async (fastify, options) => {
   const accountIsExists = async ({ email, phone }, currentUser) => {
     const query = [];
     if (email && email !== get(currentUser, 'email')) {
-      query.push({ email });
+      query.push({ email: email.toLowerCase() });
     }
     if (phone && phone !== get(currentUser, 'phone')) {
       query.push({ phone });
     }
 
-    return (
-      (await models.user.count({
-        where: {
-          [Op.or]: query
-        }
-      })) > 0
-    );
+    return ((await models.user.count({
+      where: {
+        [Op.or]: query
+      }
+    })) > 0);
   };
 
   const addUser = async ({ avatar, nickname, gender, birthday, description, phone, email, password, status }) => {
@@ -60,15 +58,7 @@ const userService = fp(async (fastify, options) => {
     }
     const account = await models.userAccount.create(await services.account.passwordEncryption(password));
     const user = await models.user.create({
-      avatar,
-      nickname,
-      gender,
-      birthday,
-      description,
-      phone,
-      email,
-      status,
-      userAccountId: account.id
+      avatar, nickname, gender, birthday, description, phone, email, status, userAccountId: account.id
     });
     await account.update({ belongToUserId: user.id });
 
@@ -109,13 +99,12 @@ const userService = fp(async (fastify, options) => {
     return {
       pageData: rows.map(item => {
         return Object.assign({}, item.get({ pain: true }));
-      }),
-      totalCount: count
+      }), totalCount: count
     };
   };
 
   const saveUser = async ({ id, ...otherInfo }) => {
-    const user = await getUserInstance({id});
+    const user = await getUserInstance({ id });
 
     if ((await accountIsExists({ phone: otherInfo.phone, email: otherInfo.email }, user)) > 0) {
       throw new Error('手机号或者邮箱都不能重复');
@@ -143,14 +132,7 @@ const userService = fp(async (fastify, options) => {
   };
 
   services.user = {
-    getUserInstance,
-    getUser,
-    addUser,
-    saveUser,
-    accountIsExists,
-    getUserList,
-    setSuperAdmin,
-    setUserStatus
+    getUserInstance, getUser, addUser, saveUser, accountIsExists, getUserList, setSuperAdmin, setUserStatus
   };
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kne/fastify-account",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "用于用户注册登录认证.",
   "main": "index.js",
   "scripts": {