@kne/fastify-message 1.0.0-alpha.0

package/README.md

@@ -0,0 +1,254 @@
+
+# fastify-message
+
+
+### 描述
+
+管理消息发送，支持sms消息，email消息等.
+
+
+### 安装
+
+```shell
+npm i --save @kne/fastify-message
+```
+
+
+### 概述
+
+### 项目概述
+
+fastify-message 是一个基于 Fastify 框架的消息管理插件，提供了模板管理和消息发送功能。目前支持邮件发送，并预留了短信发送的扩展接口。
+
+### 主要特性
+
+- 支持邮件模板管理
+- 支持模板变量替换
+- 支持 HTML 和纯文本邮件格式
+- 支持邮件发送记录追踪
+- 支持系统级和业务级模板分类
+- 支持模板状态管理（启用/禁用）
+
+### 安装
+
+```bash
+npm install fastify-message
+```
+
+### 基础配置
+
+```javascript
+const fastify = require('fastify')();
+
+fastify.register(require('fastify-message'), {
+  name: 'message', // 插件注册名称
+  emailConfig: {
+    host: 'smtp.example.com',
+    port: 465,
+    secure: true,
+    user: 'your-email@example.com',
+    pass: 'your-password',
+    defaultSubject: '系统通知' // 默认邮件主题
+  },
+  isTest: false // 测试模式下不会真实发送邮件
+});
+```
+
+### 模板格式
+
+模板文件使用 EJS 语法，支持以下特殊注释标记来区分不同部分：
+
+```html
+<!-- subject -->
+邮件主题
+
+<!-- html -->
+<h1>你好，<%= username %>！</h1>
+<div><%= content %></div>
+```
+
+### 模板命名规则
+
+模板文件命名格式：`code_type_name.ejs`
+
+- code: 模板编码
+- type: 模板类型（可选，默认为0）
+  - 0: 邮件
+  - 1: 短信
+- name: 模板名称（可选，默认使用code）
+
+示例：`welcome_0_欢迎邮件.ejs`
+
+### 使用示例
+
+```javascript
+// 发送邮件
+await fastify.message.services.sendMessage({
+  type: 0, // 0: 邮件
+  name: 'recipient@example.com', // 收件人
+  code: 'welcome', // 模板编码
+  props: { // 模板变量
+    username: 'John',
+    content: 'Welcome to our platform!'
+  },
+  options: {
+    title: '系统通知', // 发件人名称
+    attachments: [] // 附件列表
+  }
+});
+
+// 导入模板文件
+await fastify.message.services.includeTemplate('./templates');
+```
+
+
+### 示例
+
+#### 示例代码
+
+
+
+### API
+
+### 服务方法 (Services)
+
+#### includeTemplate
+
+从指定目录导入模板文件到数据库。
+
+| 参数  | 类型     | 必填 | 描述       |
+|-----|--------|----|----------|
+| dir | String | 是  | 模板文件目录路径 |
+
+| 返回值 | 类型            | 描述   |
+|-----|---------------|------|
+| -   | Promise<void> | 无返回值 |
+
+示例：
+
+```javascript
+await fastify.message.services.includeTemplate('./templates');
+```
+
+#### messageTemplate
+
+根据模板编码和参数生成消息内容。
+
+| 参数    | 类型     | 必填 | 默认值 | 描述         |
+|-------|--------|----|-----|------------|
+| code  | String | 是  | -   | 模板编码       |
+| type  | Number | 否  | 0   | 模板类型（0:邮件） |
+| level | Number | 否  | 0   | 模板级别       |
+| props | Object | 是  | -   | 模板变量       |
+
+| 返回值字段           | 类型     | 描述     |
+|-----------------|--------|--------|
+| content.subject | String | 邮件主题   |
+| content.html    | String | HTML内容 |
+| content.text    | String | 纯文本内容  |
+| props           | Object | 模板变量   |
+| code            | String | 模板编码   |
+| type            | Number | 模板类型   |
+| templateId      | Number | 模板ID   |
+
+示例：
+
+```javascript
+const message = await fastify.message.services.messageTemplate({
+  code: 'welcome',
+  props: {
+    username: 'John',
+    content: 'Welcome!'
+  }
+});
+```
+
+#### parseTemplate
+
+解析模板文本中的特殊注释标记。
+
+| 参数   | 类型     | 必填 | 描述     |
+|------|--------|----|--------|
+| text | String | 是  | 模板文本内容 |
+
+| 返回值字段   | 类型     | 描述                     |
+|---------|--------|------------------------|
+| subject | String | <!-- subject --> 标记内容  |
+| html    | String | <!-- html --> 标记内容     |
+| text    | String | <!-- text --> 标记内容（可选） |
+
+#### sendMessage
+
+发送消息（邮件/短信）。
+
+| 参数      | 类型     | 必填 | 默认值 | 描述            |
+|---------|--------|----|-----|---------------|
+| type    | Number | 否  | 0   | 消息类型（0:邮件）    |
+| name    | String | 是  | -   | 接收者（邮件地址/手机号） |
+| props   | Object | 是  | -   | 模板变量          |
+| code    | String | 是  | -   | 模板编码          |
+| level   | Number | 否  | 0   | 模板级别          |
+| client  | Object | 否  | -   | 客户端配置（覆盖默认配置） |
+| options | Object | 否  | -   | 发送选项          |
+
+options 参数详情：
+
+| 字段          | 类型     | 必填 | 描述    |
+|-------------|--------|----|-------|
+| title       | String | 否  | 发件人名称 |
+| subject     | String | 否  | 邮件主题  |
+| attachments | Array  | 否  | 附件列表  |
+
+示例：
+
+```javascript
+await fastify.message.services.sendMessage({
+  type: 0,
+  name: 'user@example.com',
+  code: 'welcome',
+  props: {
+    username: 'John',
+    content: 'Welcome!'
+  },
+  options: {
+    title: 'System',
+    attachments: [
+      {
+        filename: 'welcome.pdf',
+        path: './welcome.pdf'
+      }
+    ]
+  }
+});
+```
+
+### 数据模型 (Models)
+
+#### Template 模型
+
+| 字段        | 类型     | 默认值 | 描述         |
+|-----------|--------|-----|------------|
+| id        | Number | -   | 主键         |
+| code      | String | -   | 模板编码       |
+| type      | Number | 0   | 模板类型       |
+| name      | String | -   | 模板名称       |
+| content   | String | -   | 模板内容       |
+| level     | Number | 0   | 模板级别       |
+| status    | Number | 0   | 模板状态（0:启用） |
+| createdAt | Date   | -   | 创建时间       |
+| updatedAt | Date   | -   | 更新时间       |
+
+#### Record 模型
+
+| 字段         | 类型     | 默认值 | 描述   |
+|------------|--------|-----|------|
+| id         | Number | -   | 主键   |
+| type       | Number | -   | 消息类型 |
+| code       | String | -   | 模板编码 |
+| templateId | Number | -   | 模板ID |
+| props      | Object | -   | 模板变量 |
+| name       | String | -   | 接收者  |
+| content    | Object | -   | 发送内容 |
+| createdAt  | Date   | -   | 创建时间 |
+| updatedAt  | Date   | -   | 更新时间 |
+

package/index.js

@@ -0,0 +1,38 @@
+const fp = require('fastify-plugin');
+const path = require('node:path');
+
+module.exports = fp(async function (fastify, options) {
+  options = Object.assign(
+    {},
+    {
+      name: 'message',
+      dbTableNamePrefix: 't_message_',
+      getUserModel: () => {
+        if (!fastify.account) {
+          throw new Error('fastify-account plugin must be registered before fastify-trtc-conference,or set options.getUserModel');
+        }
+        return fastify.account.models.user;
+      }
+    },
+    options
+  );
+
+  fastify.register(require('@kne/fastify-namespace'), {
+    name: options.name,
+    options,
+    modules: [
+      [
+        'models',
+        await fastify.sequelize.addModels(path.resolve(__dirname, './libs/models'), {
+          prefix: options.dbTableNamePrefix,
+          getUserModel: options.getUserModel
+        })
+      ],
+      ['services', path.resolve(__dirname, './libs/services')]
+    ]
+  });
+
+  fastify.register(async (fastify, options) => {
+    await fastify[options.name].services.includeTemplate(options.templateDir);
+  }, options);
+});

package/libs/controllers/main.js

@@ -0,0 +1,34 @@
+const fp = require('fastify-plugin');
+
+module.exports = fp(async (fastify, options) => {
+  const { services } = fastify.project;
+  fastify.get(
+    `${options.prefix}/welcome`,
+    {
+      onRequest: [],
+      schema: {
+        description: '接口说明',
+        summary: '接口主题',
+        query: {},
+        response: {
+          200: {
+            description: '返回值说明',
+            content: {
+              'application/json': {
+                schema: {
+                  type: 'object',
+                  properties: {
+                    message: { type: 'string', description: '信息' }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    async request => {
+      return { message: 'welcome' };
+    }
+  );
+});

package/libs/models/example._js

@@ -0,0 +1,13 @@
+module.exports = ({DataTypes}) => {
+    return {
+        name: 'modelName',//此处定义modelName，默认根据文件名转驼峰命名，可以缺省
+        model: {
+            name: DataTypes.STRING
+        }, associate: ({/*这里可以获取models*/}, fastify) => {
+            //可以这样获取某个namespace的models fastify.account.models
+        }, options: {
+            indexed: []
+        }
+    };
+};
+

package/libs/models/record.js

@@ -0,0 +1,37 @@
+module.exports = ({ DataTypes, options }) => {
+  return {
+    model: {
+      name: {
+        type: DataTypes.STRING,
+        comment: '发送对象'
+      },
+      type: {
+        type: DataTypes.INTEGER,
+        defaultValue: 0,
+        comment: '发送类型: 0:邮件'
+      },
+      code: {
+        type: DataTypes.INTEGER,
+        comment: '消息类型: 1:账号验证码'
+      },
+      props: {
+        type: DataTypes.JSON,
+        comment: '消息模版变量'
+      },
+      content: {
+        type: DataTypes.JSONB,
+        comment: '消息内容'
+      }
+    },
+    associate: ({ record, template }) => {
+      record.belongsTo(options.getUserModel(), {
+        foreignKey: 'userId',
+        comment: '发送用户，为空时为系统发送'
+      });
+      record.belongsTo(template);
+    },
+    options: {
+      comment: '系统消息记录'
+    }
+  };
+};

package/libs/models/template.js

@@ -0,0 +1,43 @@
+module.exports = ({ DataTypes, options }) => {
+  return {
+    model: {
+      name: {
+        type: DataTypes.STRING,
+        comment: '模版名称'
+      },
+      code: {
+        type: DataTypes.STRING,
+        comment: '模版编码',
+        allowNull: false
+      },
+      type: {
+        type: DataTypes.INTEGER,
+        comment: '模版类型: 0:email,1:SMS',
+        allowNull: false
+      },
+      content: {
+        type: DataTypes.TEXT,
+        comment: '模版内容'
+      },
+      level: {
+        type: DataTypes.INTEGER,
+        comment: '模版级别: 0:系统,1:业务',
+        defaultValue: 1
+      },
+      status: {
+        type: DataTypes.INTEGER,
+        comment: '状态: 0:启用,1:禁用',
+        defaultValue: 0
+      }
+    },
+    associate: ({ template }) => {
+      template.belongsTo(options.getUserModel(), {
+        foreignKey: 'userId',
+        comment: '创建用户，为空时为系统初始化默认创建'
+      });
+    },
+    options: {
+      comment: '消息模版'
+    }
+  };
+};

package/libs/services/main.js

@@ -0,0 +1,137 @@
+const fp = require('fastify-plugin');
+const fs = require('fs-extra');
+const path = require('node:path');
+const template = require('lodash/template');
+const merge = require('lodash/merge');
+const nodemailer = require('nodemailer');
+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 isTest = options.isTest;
+  const { models, services } = fastify[options.name];
+  const includeTemplate = async dir => {
+    if (!(await fs.exists(dir))) {
+      return;
+    }
+    const list = await fs.readdir(dir);
+    for (const file of list) {
+      const filePath = path.join(dir, file);
+      const content = 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 codeTemplate = await models.template.findOne({
+        where: {
+          code,
+          type,
+          level: 0
+        }
+      });
+      if (codeTemplate) {
+        codeTemplate.content = content;
+        codeTemplate.name = name;
+        await codeTemplate.save();
+        continue;
+      }
+      await models.template.create({
+        code,
+        type,
+        name,
+        content,
+        level: 0
+      });
+    }
+  };
+
+  const parseTemplate = text => {
+    const regex = /<!--\s*([^\n]+?)\s*-->\s*([\s\S]*?)(?=\s*<!--|$)/g;
+    let match;
+    const result = {};
+
+    while ((match = regex.exec(text)) !== null) {
+      const fieldName = match[1].trim();
+      const fieldValue = match[2].trim();
+      result[fieldName] = fieldValue.replace(/\n/g, '\\n');
+    }
+
+    return result;
+  };
+
+  const messageTemplate = async ({ code, type = 0, level = 0, props }) => {
+    const codeTemplate = await models.template.findOne({
+      where: {
+        code,
+        type,
+        level
+      }
+    });
+    if (!codeTemplate) {
+      throw new Error('template not found');
+    }
+
+    const content = parseTemplate(template(codeTemplate.content)(props).split(/<!--(\s*)-->/g));
+
+    return {
+      content,
+      props,
+      code,
+      type,
+      templateId: codeTemplate.id
+    };
+  };
+
+  const sendMessage = async ({ type = 0, name, props, code, level = 0, client, options }) => {
+    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 { content, type, templateId } = await messageTemplate({ code, type, level, props });
+
+      const mailOptions = {
+        ...options,
+        from: `"${options.title || emailConfig.user}" <${emailConfig.user}>`,
+        to: name,
+        subject: content.subject || options.subject || emailConfig.defaultSubject || 'Message reminder',
+        html: content.html,
+        text: content.text || convert(content.html),
+        attachments: options.attachments || []
+      };
+
+      if (isTest) {
+        await pify(smtp.sendMail.bind(smtp))(mailOptions);
+      }
+
+      await models.record.create({ type, code, templateId, props, name, content: mailOptions });
+    }
+  };
+
+  Object.assign(fastify[options.name].services, {
+    includeTemplate,
+    messageTemplate,
+    parseTemplate,
+    sendMessage
+  });
+});

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@kne/fastify-message",
+  "version": "1.0.0-alpha.0",
+  "description": "管理消息发送，支持sms消息，email消息等.",
+  "main": "index.js",
+  "scripts": {
+    "init": "husky",
+    "dev": "nodemon ./index.js",
+    "start": "node ./index.js",
+    "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": {
+    "**/*.md": [
+      "git add"
+    ],
+    "{libs/**/*,index}.{js,jsx,ts,tsx,json,css,scss}": [
+      "prettier --config .prettierrc --write",
+      "git add"
+    ]
+  },
+  "files": [
+    "index.js",
+    "libs"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kne-union/fastify-message.git"
+  },
+  "keywords": [],
+  "author": "linzp",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/kne-union/fastify-message/issues"
+  },
+  "homepage": "https://github.com/kne-union/fastify-message#readme",
+  "peerDependencies": {
+    "@kne/fastify-namespace": "*",
+    "@kne/fastify-sequelize": "*",
+    "fastify-plugin": ">=5"
+  },
+  "devDependencies": {
+    "@fastify/env": "^4.4.0",
+    "@kne/fastify-sequelize": "^2.0.1",
+    "fastify": "^5.3.2",
+    "fastify-plugin": "^5.0.1",
+    "husky": "^9.0.11",
+    "nodemon": "^3.1.3",
+    "prettier": "^3.2.5"
+  },
+  "dependencies": {
+    "fs-extra": "^11.3.0",
+    "html-to-text": "^9.0.5",
+    "lodash": "^4.17.21",
+    "nodemailer": "^7.0.3",
+    "pify": "^6.1.0"
+  }
+}