@kne/fastify-message 1.0.2 → 1.0.4

package/index.js

@@ -13,7 +13,15 @@ module.exports = fp(async function (fastify, options) {
         }
         return fastify.account.models.user;
       },
-      senders: {}
+      senders: {},
+      getAuthenticate: (type) => {
+        switch (type) {
+          case 'record':
+          case 'template':
+          default:
+            return [];
+        }
+      }
     },
     options
   );
@@ -29,7 +37,8 @@ module.exports = fp(async function (fastify, options) {
           getUserModel: options.getUserModel
         })
       ],
-      ['services', path.resolve(__dirname, './libs/services')]
+      ['services', path.resolve(__dirname, './libs/services')],
+      ['controllers', path.resolve(__dirname, './libs/controllers')]
     ]
   });
 

package/libs/controllers/main.js

@@ -1,24 +1,148 @@
 const fp = require('fastify-plugin');
 
 module.exports = fp(async (fastify, options) => {
-  const { services } = fastify.project;
+  const { services } = fastify[options.name];
+
+  // 查看发送记录列表
+  fastify.get(
+    `${options.prefix}/records`,
+    {
+      onRequest: options.getAuthenticate('record'),
+      schema: {
+        description: '获取消息发送记录列表',
+        summary: '查看发送记录',
+        querystring: {
+          type: 'object',
+          properties: {
+            currentPage: { type: 'integer', default: 1, description: '页码' },
+            perPage: { type: 'integer', default: 20, description: '每页数量' },
+            'filter[type]': { type: 'integer', description: '发送类型: 0=邮件, 1=短信' },
+            'filter[code]': { type: 'string', description: '模板编码' },
+            'filter[name]': { type: 'string', description: '发送对象（邮箱/手机号）' }
+          }
+        },
+        response: {
+          200: {
+            type: 'object',
+            properties: {
+              totalCount: { type: 'integer', description: '总数量' },
+              currentPage: { type: 'integer', description: '当前页码' },
+              perPage: { type: 'integer', description: '每页数量' },
+              pageData: {
+                type: 'array',
+                items: {
+                  type: 'object',
+                  properties: {
+                    id: { type: 'string', description: '记录ID' },
+                    name: { type: 'string', description: '发送对象' },
+                    type: { type: 'integer', description: '发送类型' },
+                    code: { type: 'string', description: '模板编码' },
+                    props: { type: 'object', description: '模板变量' },
+                    content: { type: 'object', description: '消息内容' },
+                    templateId: { type: 'string', description: '模板ID' },
+                    createdAt: { type: 'string', description: '创建时间' }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    async request => {
+      const { currentPage = 1, perPage = 20 } = request.query;
+      const { 'filter[type]': type, 'filter[code]': code, 'filter[name]': name } = request.query;
+      
+      const filter = {};
+      if (type !== undefined) filter.type = type;
+      if (code) filter.code = code;
+      if (name) filter.name = name;
+      
+      return await services.record.list({ filter, perPage, currentPage });
+    }
+  );
+
+  // 查看单条发送记录
+  fastify.get(
+    `${options.prefix}/records/:id`,
+    {
+      onRequest: options.getAuthenticate('record'),
+      schema: {
+        description: '获取单条消息发送记录详情',
+        summary: '查看发送记录详情',
+        params: {
+          type: 'object',
+          properties: {
+            id: { type: 'string', description: '记录ID' }
+          },
+          required: ['id']
+        },
+        response: {
+          200: {
+            type: 'object',
+            properties: {
+              id: { type: 'string', description: '记录ID' },
+              name: { type: 'string', description: '发送对象' },
+              type: { type: 'integer', description: '发送类型' },
+              code: { type: 'string', description: '模板编码' },
+              props: { type: 'object', description: '模板变量' },
+              content: { type: 'object', description: '消息内容' },
+              templateId: { type: 'string', description: '模板ID' },
+              createdAt: { type: 'string', description: '创建时间' }
+            }
+          }
+        }
+      }
+    },
+    async request => {
+      const { id } = request.params;
+      try {
+        return await services.record.detail({ id });
+      } catch (error) {
+        throw fastify.httpErrors.notFound(error.message);
+      }
+    }
+  );
+
+  // 查看消息模版列表
   fastify.get(
-    `${options.prefix}/welcome`,
+    `${options.prefix}/templates`,
     {
-      onRequest: [],
+      onRequest: options.getAuthenticate('template'),
       schema: {
-        description: '接口说明',
-        summary: '接口主题',
-        query: {},
+        description: '获取消息模版列表',
+        summary: '查看消息模版',
+        querystring: {
+          type: 'object',
+          properties: {
+            currentPage: { type: 'integer', default: 1, description: '页码' },
+            perPage: { type: 'integer', default: 20, description: '每页数量' },
+            'filter[type]': { type: 'integer', description: '模版类型: 0=邮件, 1=短信' },
+            'filter[code]': { type: 'string', description: '模版编码' },
+            'filter[level]': { type: 'integer', description: '模版级别: 0=系统, 1=业务' },
+            'filter[status]': { type: 'integer', description: '状态: 0=启用, 1=禁用' }
+          }
+        },
         response: {
           200: {
-            description: '返回值说明',
-            content: {
-              'application/json': {
-                schema: {
+            type: 'object',
+            properties: {
+              totalCount: { type: 'integer', description: '总数量' },
+              currentPage: { type: 'integer', description: '当前页码' },
+              perPage: { type: 'integer', description: '每页数量' },
+              pageData: {
+                type: 'array',
+                items: {
                   type: 'object',
                   properties: {
-                    message: { type: 'string', description: '信息' }
+                    id: { type: 'string', description: '模版ID' },
+                    name: { type: 'string', description: '模版名称' },
+                    code: { type: 'string', description: '模版编码' },
+                    type: { type: 'integer', description: '模版类型' },
+                    level: { type: 'integer', description: '模版级别' },
+                    status: { type: 'integer', description: '状态' },
+                    content: { type: 'string', description: '模版内容' },
+                    createdAt: { type: 'string', description: '创建时间' }
                   }
                 }
               }
@@ -28,7 +152,58 @@ module.exports = fp(async (fastify, options) => {
       }
     },
     async request => {
-      return { message: 'welcome' };
+      const { currentPage = 1, perPage = 20 } = request.query;
+      const { 'filter[type]': type, 'filter[code]': code, 'filter[level]': level, 'filter[status]': status } = request.query;
+      
+      const filter = {};
+      if (type !== undefined) filter.type = type;
+      if (code) filter.code = code;
+      if (level !== undefined) filter.level = level;
+      if (status !== undefined) filter.status = status;
+      
+      return await services.template.list({ filter, perPage, currentPage });
+    }
+  );
+
+  // 查看单个消息模版
+  fastify.get(
+    `${options.prefix}/templates/:id`,
+    {
+      onRequest: options.getAuthenticate('template'),
+      schema: {
+        description: '获取单个消息模版详情',
+        summary: '查看消息模版详情',
+        params: {
+          type: 'object',
+          properties: {
+            id: { type: 'string', description: '模版ID' }
+          },
+          required: ['id']
+        },
+        response: {
+          200: {
+            type: 'object',
+            properties: {
+              id: { type: 'string', description: '模版ID' },
+              name: { type: 'string', description: '模版名称' },
+              code: { type: 'string', description: '模版编码' },
+              type: { type: 'integer', description: '模版类型' },
+              level: { type: 'integer', description: '模版级别' },
+              status: { type: 'integer', description: '状态' },
+              content: { type: 'string', description: '模版内容' },
+              createdAt: { type: 'string', description: '创建时间' }
+            }
+          }
+        }
+      }
+    },
+    async request => {
+      const { id } = request.params;
+      try {
+        return await services.template.detail({ id });
+      } catch (error) {
+        throw fastify.httpErrors.notFound(error.message);
+      }
     }
   );
 });

package/libs/services/main.js

@@ -8,14 +8,9 @@ const { convert } = require('html-to-text');
 const pify = require('pify');
 
 module.exports = fp(async (fastify, options) => {
-  const emailConfig = Object.assign(
-    {},
-    {
-      port: 465,
-      secure: true
-    },
-    options.emailConfig
-  );
+  const emailConfig = Object.assign({}, {
+    port: 465, secure: true
+  }, options.emailConfig);
   const isTest = options.isTest;
   const { models, services } = fastify[options.name];
   const includeTemplate = async dir => {
@@ -30,14 +25,10 @@ module.exports = fp(async (fastify, options) => {
       const content = await fs.readFile(filePath, 'utf8');
       const filename = file.replace(path.extname(file), '');
       const tempArray = filename.split('_');
-      const code = tempArray[0],
-        type = tempArray[1] || 0,
-        name = tempArray[2] || code;
+      const code = tempArray[0], type = tempArray[1] || 0, name = tempArray[2] || code;
       const codeTemplate = await models.template.findOne({
         where: {
-          code,
-          type,
-          level: 0
+          code, type, level: 0
         }
       });
 
@@ -49,11 +40,7 @@ module.exports = fp(async (fastify, options) => {
         continue;
       }
       await models.template.create({
-        code,
-        type,
-        name,
-        content,
-        level: 0
+        code, type, name, content, level: 0
       });
       console.log(`create template: ${code}`);
     }
@@ -76,9 +63,7 @@ module.exports = fp(async (fastify, options) => {
   const messageTemplate = async ({ code, type = 0, level = 0, props }) => {
     const codeTemplate = await models.template.findOne({
       where: {
-        code,
-        type,
-        level
+        code, type, level
       }
     });
     if (!codeTemplate) {
@@ -88,11 +73,7 @@ module.exports = fp(async (fastify, options) => {
     const content = parseTemplate(template(codeTemplate.content)(props).split(/<!--(\s*)-->/g));
 
     return {
-      content,
-      props,
-      code,
-      type,
-      templateId: codeTemplate.id
+      content, props, code, type, templateId: codeTemplate.id
     };
   };
 
@@ -100,22 +81,8 @@ module.exports = fp(async (fastify, options) => {
     targetOptions = Object.assign({}, targetOptions);
     const { content, templateId } = await messageTemplate({ code, type, level, props });
     const sendOptions = await (async () => {
+      const currentSender = options.senders?.[type];
       if (type === 0) {
-        const currentClient = merge(
-          {},
-          {
-            host: emailConfig.host,
-            port: emailConfig.port,
-            secure: emailConfig.secure,
-            auth: {
-              user: emailConfig.user,
-              pass: emailConfig.pass
-            }
-          },
-          client
-        );
-        const smtp = nodemailer.createTransport(currentClient);
-
         const mailOptions = {
           ...targetOptions,
           from: `"${targetOptions.title || emailConfig.user}" <${emailConfig.user}>`,
@@ -127,11 +94,20 @@ module.exports = fp(async (fastify, options) => {
         };
 
         if (!isTest) {
-          await pify(smtp.sendMail.bind(smtp))(mailOptions);
+          if (typeof currentSender === 'function') {
+            await currentSender(mailOptions);
+          } else {
+            const currentClient = merge({}, {
+              host: emailConfig.host, port: emailConfig.port, secure: emailConfig.secure, auth: {
+                user: emailConfig.user, pass: emailConfig.pass
+              }
+            }, client);
+            const smtp = nodemailer.createTransport(currentClient);
+            await pify(smtp.sendMail.bind(smtp))(mailOptions);
+          }
         }
         return mailOptions;
       }
-      const currentSender = options.senders?.[type];
       if (typeof currentSender === 'function') {
         const { content, templateId } = await messageTemplate({ code, type, level, props });
         if (!isTest) {
@@ -145,9 +121,60 @@ module.exports = fp(async (fastify, options) => {
   };
 
   Object.assign(fastify[options.name].services, {
-    includeTemplate,
-    messageTemplate,
-    parseTemplate,
-    sendMessage
+    includeTemplate, messageTemplate, parseTemplate, sendMessage,
+    
+    // 发送记录相关服务
+    record: {
+      list: async ({ filter = {}, perPage = 20, currentPage = 1 }) => {
+        const { count, rows } = await models.record.findAndCountAll({
+          where: filter,
+          limit: perPage,
+          offset: (currentPage - 1) * perPage,
+          order: [['createdAt', 'DESC']]
+        });
+        
+        return {
+          pageData: rows,
+          totalCount: count,
+          perPage,
+          currentPage
+        };
+      },
+      
+      detail: async ({ id }) => {
+        const record = await models.record.findByPk(id);
+        if (!record) {
+          throw new Error('记录不存在');
+        }
+        return record;
+      }
+    },
+    
+    // 消息模版相关服务
+    template: {
+      list: async ({ filter = {}, perPage = 20, currentPage = 1 }) => {
+        const { count, rows } = await models.template.findAndCountAll({
+          where: filter,
+          limit: perPage,
+          offset: (currentPage - 1) * perPage,
+          order: [['createdAt', 'DESC']]
+        });
+        
+        return {
+          pageData: rows,
+          totalCount: count,
+          perPage,
+          currentPage
+        };
+      },
+      
+      detail: async ({ id }) => {
+        const template = await models.template.findByPk(id);
+        if (!template) {
+          throw new Error('模版不存在');
+        }
+        return template;
+      }
+    }
   });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kne/fastify-message",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "管理消息发送，支持sms消息，email消息等.",
   "main": "index.js",
   "scripts": {
@@ -10,7 +10,9 @@
     "build:md": "npx @kne/md-doc",
     "start:md": "npx @kne/md-doc --watch",
     "prettier": "prettier --config .prettierrc --write '{libs/**/*,index}.{js,jsx,ts,tsx,json,css,scss}'",
-    "lint-staged": "npx lint-staged"
+    "lint-staged": "npx lint-staged",
+    "test": "mocha --exit test/**/*.test.js",
+    "test:coverage": "nyc --reporter=html --reporter=text mocha test/**/*.test.js --timeout 10000"
   },
   "lint-staged": {
     "**/*.md": [
@@ -43,12 +45,17 @@
   },
   "devDependencies": {
     "@fastify/env": "^4.4.0",
+    "@fastify/sensible": "^6.0.4",
     "@kne/fastify-sequelize": "^2.0.1",
+    "chai": "^6.2.2",
     "fastify": "^5.3.2",
     "fastify-plugin": "^5.0.1",
     "husky": "^9.0.11",
+    "mocha": "^11.7.5",
     "nodemon": "^3.1.3",
-    "prettier": "^3.2.5"
+    "nyc": "^17.1.0",
+    "prettier": "^3.2.5",
+    "sqlite3": "^6.0.1"
   },
   "dependencies": {
     "fs-extra": "^11.3.0",