@shun-js/recommend 0.3.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 qiaowenbin<uikoo9@qq.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,46 @@
+# @shun-js/recommend
+
+shun.js服务：推荐服务
+
+## 配置文件
+
+以`recommend.json`命名
+
+```json
+{
+  "port": 8004,
+  "db": {
+    "connectionLimit": 20,
+    "host": "127.0.0.1",
+    "port": 3306,
+    "database": "db_recommend",
+    "user": "root",
+    "password": "xx",
+    "timezone": "Asia/Shanghai",
+    "charset": "utf8mb4"
+  },
+  "feishu": {
+    "url": "http://127.0.0.1:8001/feishu/bot",
+    "feishuUrl": "https://open.feishu.cn/open-apis/bot/v2/hook/2cd0xx"
+  }
+}
+```
+
+## 启动
+
+```shell
+# 全局安装该服务
+npm i -g @shun-js/user
+
+# 安装shun-cli
+npm i -g @shun-js/shun-cli
+
+# 启动，在recommend.json所在目录下
+shunjs start @shun-js/recommend
+```
+
+## 请求
+
+```shell
+
+```

package/app.js

@@ -0,0 +1,31 @@
+// config
+const { parseServerConfig } = require('@shun-js/shun-config');
+
+// init
+(async () => {
+  // config
+  const config = await parseServerConfig(process.argv);
+  if (!config) {
+    console.log('read server config fail');
+    return;
+  }
+
+  // options
+  const options = {};
+
+  // options mysql
+  options.config = config;
+  options.mysql = require('qiao-mysql');
+
+  // options.redis
+  options.redis = require('qiao-redis');
+  options.redisOptions = config.redisOptions;
+
+  // options log
+  options.log = require('qiao-log');
+  options.logOptions = require('./server/log-options.js')();
+
+  // start
+  const app = await require('qiao-z')(options);
+  app.listen(config.port);
+})();

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@shun-js/recommend",
+  "version": "0.3.2",
+  "description": "recommend",
+  "keywords": [
+    "shun.js",
+    "recommend"
+  ],
+  "license": "MIT",
+  "author": "uikoo9 <uikoo9@qq.com>",
+  "homepage": "https://github.com/uikoo9/shun-js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/uikoo9/shun-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/uikoo9/shun-js/issues"
+  },
+  "files": [
+    "server",
+    "app.js"
+  ],
+  "dependencies": {
+    "@shun-js/shun-config": "^0.3.0",
+    "@shun-js/shun-service": "^0.3.1",
+    "qiao-log": "^5.1.9",
+    "qiao-mysql": "^5.1.9",
+    "qiao-z": "^5.7.7"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "gitHead": "a31fd2bf7127a36ce9d8759e28ba55fd750b26bd"
+}

package/server/controller/RecommendController.js

@@ -0,0 +1,22 @@
+// service
+const service = require('../service/RecommendService.js');
+
+/**
+ * recommend controller
+ */
+module.exports = (app) => {
+  // recommend add
+  app.post('/recommend/add', (req, res) => {
+    service.recommendAdd(req, res);
+  });
+
+  // recommend list
+  app.post('/recommend/list', (req, res) => {
+    service.recommendList(req, res);
+  });
+
+  // recommend change
+  app.post('/recommend/change', (req, res) => {
+    service.recommendChange(req, res);
+  });
+};

package/server/log-options.js

@@ -0,0 +1,30 @@
+/**
+ * log options
+ * @returns
+ */
+module.exports = () => {
+  // log options
+  const logLevel = 'debug';
+  const logPattern = 'yyyy-MM-dd-hh';
+  const logPath = require('path').resolve(__dirname, '../logs/qiao-z.log');
+
+  return {
+    appenders: {
+      stdout: {
+        type: 'stdout',
+      },
+      datefile: {
+        type: 'dateFile',
+        pattern: logPattern,
+        filename: logPath,
+        keepFileExt: true,
+      },
+    },
+    categories: {
+      default: {
+        level: logLevel,
+        appenders: ['stdout', 'datefile'],
+      },
+    },
+  };
+};

package/server/model/RecommendModel.js

@@ -0,0 +1,101 @@
+// mysql
+const sql = require('../sql/recommend-sql.json');
+
+/**
+ * addRecommend
+ * @param {*} req
+ * @param {*} res
+ */
+exports.addRecommend = async (req, res) => {
+  const methodName = 'addRecommend';
+
+  // const
+  const userId = req.body.userId;
+  const newUserId = req.body.newUserId;
+
+  // params
+  const params = [];
+  params.push(userId);
+  params.push(newUserId);
+
+  // add recommend
+  try {
+    await req.db.query(sql.addRecommend, params);
+
+    const msg = 'add success';
+    req.logger.info(methodName, msg);
+    res.jsonSuccess(msg);
+  } catch (error) {
+    const msg = 'add fail';
+    req.logger.error(methodName, msg, error.name, error.message);
+    res.jsonFail(msg);
+  }
+};
+
+/**
+ * listRecommend
+ * @param {*} req
+ * @param {*} res
+ * @param {*} userId
+ */
+exports.listRecommend = async (req, res, userId) => {
+  const methodName = 'listRecommend';
+
+  // list recommend
+  try {
+    return await req.db.query(sql.listRecommend, [userId]);
+  } catch (error) {
+    const msg = 'list fail';
+    req.logger.error(methodName, msg, error.name, error.message);
+    res.jsonFail(msg);
+  }
+};
+
+/**
+ * getRecommend
+ * @param {*} req
+ * @param {*} res
+ */
+exports.getRecommend = async (req, res) => {
+  const methodName = 'getRecommend';
+
+  // const
+  const userId = req.body.userId;
+  const newUserId = req.body.newUserId;
+
+  // params
+  const params = [];
+  params.push(userId);
+  params.push(newUserId);
+
+  // get recommend
+  try {
+    return await req.db.query(sql.getRecommend, params);
+  } catch (error) {
+    const msg = 'get fail';
+    req.logger.error(methodName, msg, error.name, error.message);
+    res.jsonFail(msg);
+  }
+};
+
+/**
+ * updateRecommend
+ * @param {*} req
+ * @param {*} res
+ */
+exports.updateRecommend = async (req, res, id) => {
+  const methodName = 'updateRecommend';
+
+  // get recommend
+  try {
+    await req.db.query(sql.updateRecommend, [id]);
+
+    const msg = 'update success';
+    req.logger.info(methodName, msg);
+    res.jsonSuccess(msg);
+  } catch (error) {
+    const msg = 'update fail';
+    req.logger.error(methodName, msg, error.name, error.message);
+    res.jsonFail(msg);
+  }
+};

package/server/service/RecommendService.js

@@ -0,0 +1,82 @@
+// util
+const { checkParams } = require('../util/check.js');
+const { feishuMsg } = require('../util/feishu.js');
+
+// model
+const { addRecommend, listRecommend, getRecommend, updateRecommend } = require('../model/RecommendModel.js');
+
+/**
+ * recommendAdd
+ * @param {*} req
+ * @param {*} res
+ */
+exports.recommendAdd = async (req, res) => {
+  // check params
+  const checkParamsRes = checkParams(req, res);
+  if (!checkParamsRes) return;
+
+  // add
+  await addRecommend(req, res);
+
+  // feishu
+  feishuMsg(`【提醒】用户-${req.body.userId}，推荐新用户-${req.body.newUserId}注册成功！`);
+};
+
+/**
+ * recommendList
+ * @param {*} req
+ * @param {*} res
+ * @returns
+ */
+exports.recommendList = async (req, res) => {
+  const methodName = 'recommendList';
+
+  // check
+  const userId = req.body.userId;
+  if (!userId) {
+    const msg = 'need userId';
+    req.logger.warn(methodName, msg, req.body);
+    res.jsonFail(msg);
+    return;
+  }
+
+  // list
+  const list = await listRecommend(req, res, userId);
+  if (!list) return;
+
+  // r
+  res.jsonSuccess('list success', list);
+};
+
+/**
+ * recommendChange
+ * @param {*} req
+ * @param {*} res
+ * @returns
+ */
+exports.recommendChange = async (req, res) => {
+  const methodName = 'recommendChange';
+
+  // check params
+  const checkParamsRes = checkParams(req, res);
+  if (!checkParamsRes) return;
+
+  // get
+  const recommends = await getRecommend(req, res);
+  if (!recommends) return;
+
+  // check recommends
+  if (recommends.length !== 1) {
+    const msg = '该记录已经兑换！';
+    req.logger.error(methodName, msg);
+    res.jsonFail(msg);
+    return;
+  }
+
+  // update
+  const recommend = recommends[0];
+  await updateRecommend(req, res, recommend.id);
+
+  // feishu
+  feishuMsg(`【提醒】用户-${recommend.recommend_user_id}-${recommend.recommend_newuser_id}兑换VIP会员成功！`);
+};

package/server/sql/recommend-sql.json

@@ -0,0 +1,6 @@
+{
+  "addRecommend": "insert into t_recommend values(null, ?,?,'0', now())",
+  "listRecommend": "select * from t_recommend where recommend_user_id=? order by id desc",
+  "getRecommend": "select * from t_recommend where recommend_user_id=? and recommend_newuser_id=? and recommend_exchange='0'",
+  "updateRecommend": "update t_recommend set recommend_exchange='1' where id=?"
+}

package/server/util/check.js

@@ -0,0 +1,29 @@
+/**
+ * checkParams
+ * @param {*} req
+ * @param {*} res
+ * @returns
+ */
+exports.checkParams = async (req, res) => {
+  const methodName = 'checkParams';
+
+  // const
+  const userId = req.body.userId;
+  const newUserId = req.body.newUserId;
+
+  // check
+  if (!userId) {
+    const msg = 'need userId';
+    req.logger.warn(methodName, msg, req.body);
+    res.jsonFail(msg);
+    return;
+  }
+  if (!newUserId) {
+    const msg = 'need newUserId';
+    req.logger.warn(methodName, msg, req.body);
+    res.jsonFail(msg);
+    return;
+  }
+
+  return true;
+};

package/server/util/feishu.js

@@ -0,0 +1,16 @@
+// services
+const { feishuBot } = require('@shun-js/shun-service');
+
+/**
+ * feishuMsg
+ * @param {*} msg
+ */
+exports.feishuMsg = (msg) => {
+  if (global.QZ_CONFIG.env !== 'production') return;
+
+  feishuBot({
+    url: global.QZ_CONFIG.feishu.url,
+    feishuUrl: global.QZ_CONFIG.feishu.feishuUrl,
+    feishuMsg: msg,
+  });
+};