@zenweb/schedule 3.6.1 → 4.0.0

package/README.md

@@ -2,10 +2,27 @@
 
 [ZenWeb](https://www.npmjs.com/package/zenweb)
 
-定时任务
+基于请求的定时任务，如同定时请求固定接口，可以使用中间件和请求上下文。
 
-```ts
-import { Context } from 'zenweb';
+## 依赖模块
+
+- @zenweb/inject
+- @zenweb/router
+
+## 快速使用
+
+```bash npm2yarn
+npm install @zenweb/schedule
+```
+
+```ts title="src/index.ts"
+import modSchedule from '@zenweb/schedule';
+// ...
+app.setup(modSchedule());
+// ...
+```
+
+```ts title="src/schedule/echo.ts"
 import { schedule } from '@zenweb/schedule';
 
 export class EchoScheduler {
@@ -14,15 +31,19 @@ export class EchoScheduler {
     console.log('task echo');
     return 'ok';
   }
-
-  @schedule({ rule: '*/4 * * * * *' })
-  err(ctx: Context) {
-    ctx.errrrr();
-  }
 }
 ```
 
-## Changelog
+## 配置项
+
+| 配置项 | 类型 | 默认值 | 功能 |
+| ----- | --- | ----- | ---- |
+| paths | `string[]` | `['./app/schedule']` | 定时任务控制器加载目录
+| patterns | `string` | **/*.{ts,js} | 定时任务控制器文件匹配规则
+| disabled | `boolean` | `false` | 是否禁用定时器，可以通过环境变量 ZENWEB_SCHEDULE_DISABLED=1 控制
+
+## Core 挂载项
 
-### 3.6.1
-- null 检查
+| 挂载项 | 类型 | 功能 |
+| ----- | --- | ---- |
+| scheduleRegister | ScheduleRegister | ScheduleRegister 实例

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { SetupFunction } from '@zenweb/core';
-import { schedule, ScheduleRegister } from './register';
-import { ScheduleOption } from './types';
+import { schedule, ScheduleRegister } from './register.js';
+import { ScheduleOption } from './types.js';
 export { ScheduleOption, schedule };
 export default function setup(opt?: ScheduleOption): SetupFunction;
 declare module '@zenweb/core' {

package/dist/index.js

@@ -1,25 +1,25 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.schedule = void 0;
-const globby = require("globby");
-const path = require("path");
-const register_1 = require("./register");
-Object.defineProperty(exports, "schedule", { enumerable: true, get: function () { return register_1.schedule; } });
-function setup(opt) {
+import path from 'node:path';
+import { globby } from 'globby';
+import { schedule, ScheduleRegister } from './register.js';
+export { schedule };
+export default function setup(opt) {
     const option = Object.assign({
-        paths: [path.join(process.cwd(), 'app', 'schedule')],
+        paths: ['./app/schedule'],
         disabled: process.env.ZENWEB_SCHEDULE_DISABLED === '1',
     }, opt);
     return async function schedule(setup) {
         setup.assertModuleExists('inject', '@zenweb/inject');
         setup.assertModuleExists('router', '@zenweb/router');
         setup.debug('option: %o', option);
-        const scheduleRegister = new register_1.ScheduleRegister(setup.core, option);
+        const scheduleRegister = new ScheduleRegister(setup.core, option);
         setup.defineCoreProperty('scheduleRegister', { value: scheduleRegister });
         if (option.paths && option.paths.length) {
-            for (const d of option.paths) {
+            for (let d of option.paths) {
+                if (d.startsWith('./')) {
+                    d = path.join(process.cwd(), d.slice(2));
+                }
                 for (const file of await globby(option.patterns || '**/*.{ts,js}', { cwd: d, absolute: true })) {
-                    const mod = require(file.slice(0, -3));
+                    const mod = await import(file);
                     for (const i of Object.values(mod)) {
                         if (typeof i === 'function') {
                             scheduleRegister.register(i);
@@ -36,4 +36,3 @@ function setup(opt) {
         });
     };
 }
-exports.default = setup;

package/dist/register.d.ts

@@ -1,6 +1,6 @@
 import { Core, Middleware } from '@zenweb/core';
 import { RecurrenceRule, RecurrenceSpecDateRange, RecurrenceSpecObjLit } from 'node-schedule';
-import { ScheduleOption } from './types';
+import { ScheduleOption } from './types.js';
 interface ScheduleMethodOption {
     rule: RecurrenceRule | RecurrenceSpecDateRange | RecurrenceSpecObjLit | Date | string | number;
     middleware?: Middleware | Middleware[];
@@ -8,7 +8,7 @@ interface ScheduleMethodOption {
 /**
  * 定时任务设定
  */
-export declare function schedule(opt: ScheduleMethodOption): (target: Object, propertyKey: string | symbol, descriptor_or_paramtypes?: any[] | PropertyDescriptor | undefined) => void;
+export declare function schedule(opt: ScheduleMethodOption): (target: Object, propertyKey: string | symbol, descriptor_or_paramtypes?: PropertyDescriptor | any[]) => void;
 export declare class ScheduleRegister {
     private core;
     private router;

package/dist/register.js

@@ -1,28 +1,27 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScheduleRegister = exports.schedule = void 0;
-const http_1 = require("http");
-const node_schedule_1 = require("node-schedule");
-const crypto_1 = require("crypto");
-const decorator_make_1 = require("decorator-make");
-const router_1 = require("@zenweb/router");
-const inject_1 = require("@zenweb/inject");
-const scheduleDecorator = (0, decorator_make_1.makeMethodDecorator)();
+/// <reference types="@zenweb/inject" />
+import { ServerResponse } from 'node:http';
+import { scheduleJob } from 'node-schedule';
+import { randomUUID } from 'node:crypto';
+import { makeMethodDecorator } from 'decorator-make';
+import { Router } from '@zenweb/router';
+const scheduleDecorator = makeMethodDecorator();
 /**
  * 定时任务设定
  */
-function schedule(opt) {
+export function schedule(opt) {
     return scheduleDecorator.wrap((descriptor, target) => {
-        const path = `${(0, crypto_1.randomUUID)()}/${target.constructor.name}.${descriptor.handle.name}`;
+        const path = `${randomUUID()}/${target.constructor.name}.${descriptor.handle.name}`;
         return Object.assign({ path }, descriptor, opt);
     });
 }
-exports.schedule = schedule;
-class ScheduleRegister {
+export class ScheduleRegister {
+    core;
+    router;
+    option;
+    jobs = [];
     constructor(core, option) {
-        this.jobs = [];
         this.core = core;
-        this.router = new router_1.Router({
+        this.router = new Router({
             prefix: '/__schedule/',
         });
         this.option = option;
@@ -33,7 +32,6 @@ class ScheduleRegister {
     register(target) {
         const methods = scheduleDecorator.getMethods(target.prototype);
         if (methods.length > 0) {
-            (0, inject_1.scope)('prototype', false)(target);
             for (const item of methods) {
                 // 添加到路由中
                 this.router.post(item.path, ...(item.middleware ?
@@ -45,7 +43,7 @@ class ScheduleRegister {
                     continue;
                 }
                 // 启用定时器
-                const job = (0, node_schedule_1.scheduleJob)(item.rule, () => {
+                const job = scheduleJob(item.rule, () => {
                     const path = '/__schedule/' + item.path;
                     const request = Object.assign({
                         headers: {
@@ -65,7 +63,7 @@ class ScheduleRegister {
                             remotePort: 7001,
                         },
                     });
-                    const response = new http_1.ServerResponse(request);
+                    const response = new ServerResponse(request);
                     this.core.app.callback()(request, response);
                 });
                 this.jobs.push(job);
@@ -81,4 +79,3 @@ class ScheduleRegister {
         }
     }
 }
-exports.ScheduleRegister = ScheduleRegister;

package/dist/types.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="node" />
-import { ServerResponse, IncomingMessage } from 'http';
+import { ServerResponse, IncomingMessage } from 'node:http';
 export type RequestCallback = (request: IncomingMessage, response: ServerResponse) => void;
 export type JobCallback = (request: IncomingMessage, response: ServerResponse, callback: RequestCallback) => void;
 export interface ScheduleOption {

package/dist/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@zenweb/schedule",
-  "version": "3.6.1",
+  "type": "module",
+  "version": "4.0.0",
   "description": "Zenweb Schedule module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -9,8 +10,8 @@
   ],
   "scripts": {
     "build": "rimraf dist && tsc",
-    "prepublishOnly": "npm run build",
-    "dev": "cd example && cross-env DEBUG=* ts-node app"
+    "prepack": "npm run build",
+    "dev": "cd example && node --env-file=.env --loader=ts-node/esm app.ts"
   },
   "author": {
     "name": "YeFei",
@@ -34,18 +35,18 @@
     "url": "https://github.com/yefei/zenweb-schedule/issues"
   },
   "devDependencies": {
-    "@zenweb/core": "^3.5.1",
-    "@zenweb/inject": "^3.18.0",
-    "@zenweb/router": "^3.3.0",
-    "cross-env": "^7.0.3",
+    "@types/node": "^22.7.5",
+    "@zenweb/core": "^5.1.0",
+    "@zenweb/inject": "^5.1.0",
+    "@zenweb/router": "^5.0.0",
     "rimraf": "^4.3.1",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5"
+    "typescript": "^5.6.3"
   },
   "dependencies": {
-    "@types/node-schedule": "^2.1.0",
-    "decorator-make": "^1.3.0",
-    "globby": "11.0.4",
+    "@types/node-schedule": "^2.1.7",
+    "decorator-make": "^1.5.0",
+    "globby": "^14.0.2",
     "node-schedule": "^2.1.1"
   }
 }