@jayfong/x-server 1.31.1 → 1.32.0

package/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.32.0](https://github.com/jfWorks/x-server/compare/v1.31.3...v1.32.0) (2022-05-31)
+
+
+### Features
+
+* add DingtalkService ([3cbe91c](https://github.com/jfWorks/x-server/commit/3cbe91cd82c6cfc5fa4c5bcf2d8c7eb93711ef7c))
+
+### [1.31.3](https://github.com/jfWorks/x-server/compare/v1.31.2...v1.31.3) (2022-05-30)
+
+
+### Bug Fixes
+
+* defineCron ([5d72533](https://github.com/jfWorks/x-server/commit/5d72533c039645833391ce31f0403c96b2c5ef77))
+
+### [1.31.2](https://github.com/jfWorks/x-server/compare/v1.31.1...v1.31.2) (2022-05-30)
+
 ### [1.31.1](https://github.com/jfWorks/x-server/compare/v1.31.0...v1.31.1) (2022-05-30)
 
 ## [1.31.0](https://github.com/jfWorks/x-server/compare/v1.30.2...v1.31.0) (2022-05-30)

package/lib/_cjs/core/define_cron.js

@@ -8,7 +8,8 @@ var _cron = require("cron");
 function defineCron(options) {
   return new _cron.CronJob({
     cronTime: options.expression,
-    runOnInit: true,
+    runOnInit: options.runOnInit,
+    start: true,
     onTick: options.handle
   });
 }

package/lib/_cjs/index.js

@@ -170,6 +170,14 @@ Object.keys(_captcha).forEach(function (key) {
   exports[key] = _captcha[key];
 });
 
+var _dingtalk = require("./services/dingtalk");
+
+Object.keys(_dingtalk).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _dingtalk[key]) return;
+  exports[key] = _dingtalk[key];
+});
+
 var _dispose = require("./services/dispose");
 
 Object.keys(_dispose).forEach(function (key) {

package/lib/_cjs/services/dingtalk.js

@@ -0,0 +1,65 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+
+exports.__esModule = true;
+exports.DingtalkService = void 0;
+
+var _crypto = _interopRequireDefault(require("crypto"));
+
+var _got = _interopRequireDefault(require("got"));
+
+class DingtalkService {
+  constructor(options) {
+    this.options = options;
+    this.serviceName = 'dingtalk';
+  }
+
+  async send(options) {
+    const timestamp = Date.now();
+
+    const sign = _crypto.default.createHmac('sha256', this.options.secret).update(`${timestamp}\n${this.options.secret}`).digest('base64');
+
+    const data = {
+      msgtype: 'markdown',
+      markdown: {
+        title: options.title,
+        text: options.content
+      },
+      at: {
+        atMobiles: Array.isArray(options.at) ? options.at : [],
+        isAtAll: options.at === 'all'
+      }
+    };
+
+    if (!data.at.isAtAll && data.at.atMobiles.length) {
+      const atMobiles = data.at.atMobiles.filter(mobile => !data.markdown.text.includes(`@${mobile}`));
+
+      if (atMobiles.length) {
+        const atMobilesText = atMobiles.map(mobile => `@${mobile}`).join(' ');
+        data.markdown.text += `<!-- ${atMobilesText} -->`;
+      }
+    }
+
+    const {
+      body
+    } = await _got.default.post('https://oapi.dingtalk.com/robot/send', {
+      responseType: 'json',
+      searchParams: {
+        access_token: this.options.accessToken,
+        timestamp: timestamp,
+        sign: sign
+      },
+      json: data
+    });
+
+    if (body.errcode !== 0) {
+      throw new Error(body.errmsg);
+    }
+
+    return body;
+  }
+
+}
+
+exports.DingtalkService = DingtalkService;

package/lib/core/define_cron.js

@@ -2,7 +2,8 @@ import { CronJob } from 'cron';
 export function defineCron(options) {
   return new CronJob({
     cronTime: options.expression,
-    runOnInit: true,
+    runOnInit: options.runOnInit,
+    start: true,
     onTick: options.handle
   });
 }

package/lib/core/types.d.ts

@@ -139,12 +139,6 @@ export declare namespace XTask {
          * 任务名称
          */
         name: string;
-        /**
-         * 是否作为定时任务
-         *
-         * @see https://crontab.guru/
-         */
-        cron?: string;
         /**
          * 处理器
          */
@@ -162,6 +156,10 @@ export declare namespace XCron {
          * @see https://crontab.cronhub.io/
          */
         expression: string;
+        /**
+         * 是否初始化后执行一次
+         */
+        runOnInit?: boolean;
         /**
          * 处理器
          */

package/lib/index.d.ts

@@ -19,6 +19,7 @@ export * from './plugins/xml_parser';
 export * from './services/base';
 export * from './services/cache';
 export * from './services/captcha';
+export * from './services/dingtalk';
 export * from './services/dispose';
 export * from './services/jwt';
 export * from './services/mail';

package/lib/index.js

@@ -20,6 +20,7 @@ export * from "./plugins/xml_parser";
 export * from "./services/base";
 export * from "./services/cache";
 export * from "./services/captcha";
+export * from "./services/dingtalk";
 export * from "./services/dispose";
 export * from "./services/jwt";
 export * from "./services/mail";

package/lib/services/dingtalk.d.ts

@@ -0,0 +1,39 @@
+import { BaseService } from './base';
+export interface DingtalkServiceOptions {
+    /**
+     * 访问口令。
+     */
+    accessToken: string;
+    /**
+     * 访问密钥。
+     */
+    secret: string;
+}
+export interface DingtalkServiceSendOptions {
+    /**
+     * 通知标题。
+     */
+    title: string;
+    /**
+     * 通知内容，Markdown 格式。
+     */
+    content: string;
+    /**
+     * 要提醒的人员，设为 `all` 表示 @ 所有人，设为手机号数组只 @ 指定人。
+     */
+    at?: 'all' | string[];
+}
+export declare class DingtalkService implements BaseService {
+    private options;
+    serviceName: string;
+    constructor(options: DingtalkServiceOptions);
+    send(options: DingtalkServiceSendOptions): Promise<{
+        errcode: number;
+        errmsg: string;
+    }>;
+}
+declare module '../x' {
+    interface X {
+        dingtalk: DingtalkService;
+    }
+}

package/lib/services/dingtalk.js

@@ -0,0 +1,52 @@
+import crypto from 'crypto';
+import got from 'got';
+export class DingtalkService {
+  constructor(options) {
+    this.options = options;
+    this.serviceName = 'dingtalk';
+  }
+
+  async send(options) {
+    const timestamp = Date.now();
+    const sign = crypto.createHmac('sha256', this.options.secret).update(`${timestamp}\n${this.options.secret}`).digest('base64');
+    const data = {
+      msgtype: 'markdown',
+      markdown: {
+        title: options.title,
+        text: options.content
+      },
+      at: {
+        atMobiles: Array.isArray(options.at) ? options.at : [],
+        isAtAll: options.at === 'all'
+      }
+    };
+
+    if (!data.at.isAtAll && data.at.atMobiles.length) {
+      const atMobiles = data.at.atMobiles.filter(mobile => !data.markdown.text.includes(`@${mobile}`));
+
+      if (atMobiles.length) {
+        const atMobilesText = atMobiles.map(mobile => `@${mobile}`).join(' ');
+        data.markdown.text += `<!-- ${atMobilesText} -->`;
+      }
+    }
+
+    const {
+      body
+    } = await got.post('https://oapi.dingtalk.com/robot/send', {
+      responseType: 'json',
+      searchParams: {
+        access_token: this.options.accessToken,
+        timestamp: timestamp,
+        sign: sign
+      },
+      json: data
+    });
+
+    if (body.errcode !== 0) {
+      throw new Error(body.errmsg);
+    }
+
+    return body;
+  }
+
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jayfong/x-server",
-  "version": "1.31.1",
+  "version": "1.32.0",
   "license": "ISC",
   "sideEffects": false,
   "main": "lib/_cjs/index.js",