@jayfong/x-server 1.30.2 → 1.31.3

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 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.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)
+
+
+### Features
+
+* defineCron ([f9f362e](https://github.com/jfWorks/x-server/commit/f9f362ee0a9845f662af0b686781299390c5647d))
+
 ### [1.30.2](https://github.com/jfWorks/x-server/compare/v1.30.1...v1.30.2) (2022-05-26)
 
 

package/lib/_cjs/cli/templates/crons.ts

@@ -0,0 +1,2 @@
+// @index(['../../src/crons/**/*.ts', '!**/_*'], (f, _) => `import '${f.path}'`)
+// @endindex

package/lib/_cjs/core/define_cron.js

@@ -0,0 +1,15 @@
+"use strict";
+
+exports.__esModule = true;
+exports.defineCron = defineCron;
+
+var _cron = require("cron");
+
+function defineCron(options) {
+  return new _cron.CronJob({
+    cronTime: options.expression,
+    runOnInit: options.runOnInit,
+    start: true,
+    onTick: options.handle
+  });
+}

package/lib/_cjs/core/define_task.js

@@ -21,14 +21,5 @@ function defineTask(options) {
   queue.process(async job => {
     return options.handle(job.data);
   });
-
-  if (options.cron) {
-    queue.add({}, {
-      repeat: {
-        cron: options.cron
-      }
-    });
-  }
-
   return queue;
 }

package/lib/_cjs/core/server.js

@@ -31,7 +31,7 @@ class Server {
     await this.applyRoutes();
     await this.applyHooks();
     await this.startFastify();
-    await this.startTasks();
+    await this.startCrons();
     await this.applyAutoClose();
   }
 
@@ -145,9 +145,9 @@ class Server {
     }
   }
 
-  async startTasks() {
+  async startCrons() {
     // @ts-ignore
-    await Promise.resolve().then(() => (0, _interopRequireWildcard2.default)(require('.x/tasks')));
+    await Promise.resolve().then(() => (0, _interopRequireWildcard2.default)(require('.x/crons')));
   }
 
   async applyAutoClose() {

package/lib/_cjs/core/types.js

@@ -1,7 +1,7 @@
 "use strict";
 
 exports.__esModule = true;
-exports.XTask = exports.XServer = exports.XHandler = void 0;
+exports.XTask = exports.XServer = exports.XHandler = exports.XCron = void 0;
 let XServer;
 exports.XServer = XServer;
 
@@ -15,4 +15,9 @@ exports.XHandler = XHandler;
 let XTask;
 exports.XTask = XTask;
 
-(function (_XTask) {})(XTask || (exports.XTask = XTask = {}));
+(function (_XTask) {})(XTask || (exports.XTask = XTask = {}));
+
+let XCron;
+exports.XCron = XCron;
+
+(function (_XCron) {})(XCron || (exports.XCron = XCron = {}));

package/lib/_cjs/index.js

@@ -10,6 +10,14 @@ Object.keys(_define_bus).forEach(function (key) {
   exports[key] = _define_bus[key];
 });
 
+var _define_cron = require("./core/define_cron");
+
+Object.keys(_define_cron).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _define_cron[key]) return;
+  exports[key] = _define_cron[key];
+});
+
 var _define_handler = require("./core/define_handler");
 
 Object.keys(_define_handler).forEach(function (key) {

package/lib/cli/templates/crons.ts

@@ -0,0 +1,2 @@
+// @index(['../../src/crons/**/*.ts', '!**/_*'], (f, _) => `import '${f.path}'`)
+// @endindex

package/lib/core/define_cron.d.ts

@@ -0,0 +1,2 @@
+import { XCron } from './types';
+export declare function defineCron(options: XCron.Options): XCron.Cron;

package/lib/core/define_cron.js

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

package/lib/core/define_task.js

@@ -12,14 +12,5 @@ export function defineTask(options) {
   queue.process(async job => {
     return options.handle(job.data);
   });
-
-  if (options.cron) {
-    queue.add({}, {
-      repeat: {
-        cron: options.cron
-      }
-    });
-  }
-
   return queue;
 }

package/lib/core/server.d.ts

@@ -14,6 +14,6 @@ export declare class Server {
     private applyServices;
     private applyPlugins;
     private applyRoutes;
-    private startTasks;
+    private startCrons;
     private applyAutoClose;
 }

package/lib/core/server.js

@@ -18,7 +18,7 @@ export class Server {
     await this.applyRoutes();
     await this.applyHooks();
     await this.startFastify();
-    await this.startTasks();
+    await this.startCrons();
     await this.applyAutoClose();
   }
 
@@ -130,9 +130,9 @@ export class Server {
     }
   }
 
-  async startTasks() {
+  async startCrons() {
     // @ts-ignore
-    await import('.x/tasks');
+    await import('.x/crons');
   }
 
   async applyAutoClose() {

package/lib/core/types.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import { BasePlugin } from '../plugins/base';
 import { BaseService } from '../services/base';
+import { CronJob } from 'cron';
 import { FastifyReply, FastifyRequest, FastifyServerOptions } from 'fastify';
 import { yup } from 'vtils/validator';
 import type { AsyncOrSync, LiteralUnion, OneOrMore, RequiredDeep } from 'vtils/types';
@@ -139,17 +140,32 @@ export declare namespace XTask {
          */
         name: string;
         /**
-         * 是否作为定时任务
+         * 处理器
+         */
+        handle: (data: T) => any;
+    }
+    interface Task<T> extends Queue<T> {
+    }
+}
+export declare namespace XCron {
+    interface Options {
+        /**
+         * 定时语法
          *
          * @see https://crontab.guru/
+         * @see https://crontab.cronhub.io/
+         */
+        expression: string;
+        /**
+         * 是否初始化后执行一次
          */
-        cron?: string;
+        runOnInit?: boolean;
         /**
          * 处理器
          */
-        handle: (data: T) => any;
+        handle: () => any;
     }
-    interface Task<T> extends Queue<T> {
+    interface Cron extends CronJob {
     }
 }
 export declare type XFile = MultipartFile;

package/lib/core/types.js

@@ -8,4 +8,8 @@ export let XHandler;
 
 export let XTask;
 
-(function (_XTask) {})(XTask || (XTask = {}));
+(function (_XTask) {})(XTask || (XTask = {}));
+
+export let XCron;
+
+(function (_XCron) {})(XCron || (XCron = {}));

package/lib/index.d.ts

@@ -1,4 +1,5 @@
 export * from './core/define_bus';
+export * from './core/define_cron';
 export * from './core/define_handler';
 export * from './core/define_hook';
 export * from './core/define_server';

package/lib/index.js

@@ -1,5 +1,6 @@
-// @index(['./**/*.ts', '!**/*.test.ts', '!./cli/**'], f => `export * from '${f.path}'`)
+// @index(['./**/*.ts', '!**/*.test.ts', '!./cli/**', '!./client_helper.ts'], f => `export * from '${f.path}'`)
 export * from "./core/define_bus";
+export * from "./core/define_cron";
 export * from "./core/define_handler";
 export * from "./core/define_hook";
 export * from "./core/define_server";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jayfong/x-server",
-  "version": "1.30.2",
+  "version": "1.31.3",
   "license": "ISC",
   "sideEffects": false,
   "main": "lib/_cjs/index.js",
@@ -30,6 +30,7 @@
     "@prisma/client": "^3.12.0",
     "@types/bull": "^3.15.8",
     "@types/busboy": "^0.3.2",
+    "@types/cron": "^2.0.0",
     "@types/http-errors": "^1.8.2",
     "@types/jsonwebtoken": "^8.5.8",
     "@types/nodemailer": "^6.4.4",
@@ -40,6 +41,7 @@
     "chokidar": "^3.5.3",
     "comment-parser": "^1.3.1",
     "compressing": "^1.5.1",
+    "cron": "^2.0.0",
     "cuid": "^2.1.8",
     "debug": "^4.3.4",
     "esbuild": "^0.14.36",

package/lib/_cjs/cli/templates/tasks.ts

@@ -1 +0,0 @@
-import '../../src/tasks/index'

package/lib/cli/templates/tasks.ts

@@ -1 +0,0 @@
-import '../../src/tasks/index'