@zenweb/schedule 2.3.2 → 2.3.6

package/README.md

@@ -1,20 +1,25 @@
-# ZenWeb Schedule module
-
-[ZenWeb](https://www.npmjs.com/package/zenweb)
-
-## Quick start
-```
-$ npm i @zenweb/schedule
-```
-
-app/index.js
-```js
-app.setup('@zenweb/schedule');
-```
-
-app/schedule/echo.js
-```js
-app.schedule.job('*/1 * * * * *', ctx => {
-  console.log('task echo');
-});
-```
+# ZenWeb Schedule module
+
+[ZenWeb](https://www.npmjs.com/package/zenweb)
+
+## Quick start
+```
+$ npm i @zenweb/schedule
+```
+
+app/index.js
+```js
+app.setup('@zenweb/schedule');
+```
+
+app/schedule/echo.js
+```js
+app.schedule.job('*/1 * * * * *', ctx => {
+  console.log('task echo');
+});
+```
+
+## Develop
+```
+$ yarn global add rimraf typescript
+```

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { SetupFunction } from '@zenweb/core';
+import { ScheduleRegister } from './register';
+import { ScheduleOption } from './types';
+export * from './types';
+export default function setup(option?: ScheduleOption): SetupFunction;
+declare module '@zenweb/core' {
+    interface Core {
+        schedule: ScheduleRegister;
+    }
+}

package/dist/index.js

@@ -0,0 +1,38 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const globby = require("globby");
+const path = require("path");
+const register_1 = require("./register");
+__exportStar(require("./types"), exports);
+function setup(option) {
+    return async function schedule(setup) {
+        option = Object.assign({
+            paths: [path.join(process.cwd(), 'app', 'schedule')],
+        }, option);
+        setup.debug('option: %o', option);
+        const register = new register_1.ScheduleRegister(setup.core, option);
+        setup.defineCoreProperty('schedule', { value: register });
+        if (option.paths && option.paths.length) {
+            for (const d of option.paths) {
+                let count = 0;
+                for (const m of await globby(option.patterns || '**/*.{ts,js}', { cwd: d, absolute: true })) {
+                    require(m);
+                    count++;
+                }
+                setup.debug('load: %s %o files', d, count);
+            }
+        }
+    };
+}
+exports.default = setup;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iCAAiC;AAEjC,6BAA8B;AAC9B,yCAA8C;AAE9C,0CAAwB;AAExB,SAAwB,KAAK,CAAC,MAAuB;IACnD,OAAO,KAAK,UAAU,QAAQ,CAAC,KAAK;QAClC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;YACrB,KAAK,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;SACrD,EAAE,MAAM,CAAC,CAAC;QACX,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAClC,MAAM,QAAQ,GAAG,IAAI,2BAAgB,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1D,KAAK,CAAC,kBAAkB,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC1D,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE;YACvC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK,EAAE;gBAC5B,IAAI,KAAK,GAAG,CAAC,CAAC;gBACd,KAAK,MAAM,CAAC,IAAI,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,IAAI,cAAc,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE;oBAC3F,OAAO,CAAC,CAAC,CAAC,CAAC;oBACX,KAAK,EAAE,CAAC;iBACT;gBACD,KAAK,CAAC,KAAK,CAAC,mBAAmB,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;aAC5C;SACF;IACH,CAAC,CAAA;AACH,CAAC;AAnBD,wBAmBC"}

package/dist/register.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="koa__router" />
+import '@zenweb/router';
+import { Middleware } from 'koa';
+import { Core } from '@zenweb/core';
+import { RequestCallback, ScheduleOption } from './types';
+import { Router } from '@zenweb/router';
+import { RecurrenceRule, RecurrenceSpecDateRange, RecurrenceSpecObjLit } from 'node-schedule';
+export declare class ScheduleRegister {
+    option: ScheduleOption;
+    router: Router;
+    callback: RequestCallback;
+    private _index;
+    constructor(core: Core, option?: ScheduleOption);
+    job(rule: RecurrenceRule | RecurrenceSpecDateRange | RecurrenceSpecObjLit | Date | string | number, ...middleware: Middleware[]): import("node-schedule").Job;
+}

package/dist/register.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScheduleRegister = void 0;
+require("@zenweb/router");
+const http_1 = require("http");
+const node_schedule_1 = require("node-schedule");
+const SAFE_IP = '127.0.0.1';
+/**
+ * 安全检查，防止外部调用
+ */
+function safeCheck(ctx, next) {
+    if (!ctx.req.socket.remoteAddress || !ctx.req.socket.remoteAddress.endsWith(SAFE_IP)) {
+        ctx.throw(403);
+    }
+    return next();
+}
+class ScheduleRegister {
+    constructor(core, option) {
+        this.option = option || {};
+        this.router = core.router;
+        this.callback = core.koa.callback();
+        this._index = 0;
+    }
+    job(rule, ...middleware) {
+        // 注册到路由
+        const path = `/___schedule/job/${this._index++}`;
+        this.router.post(path, safeCheck, ...middleware);
+        // 注册到 scheduleJob
+        const callback = () => {
+            const request = Object.assign({
+                headers: {
+                    host: '127.0.0.1',
+                },
+                query: {},
+                querystring: '',
+                host: '127.0.0.1',
+                hostname: '127.0.0.1',
+                protocol: 'http',
+                secure: 'false',
+                method: 'POST',
+                url: path,
+                path: path,
+                socket: {
+                    remoteAddress: SAFE_IP,
+                    remotePort: 7001,
+                },
+            });
+            const response = new http_1.ServerResponse(request);
+            if (this.option.jobCallback) {
+                this.option.jobCallback(request, response, this.callback);
+            }
+            else {
+                this.callback(request, response);
+            }
+        };
+        return (0, node_schedule_1.scheduleJob)(rule, callback);
+    }
+}
+exports.ScheduleRegister = ScheduleRegister;
+//# sourceMappingURL=register.js.map

package/dist/register.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"register.js","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":";;;AAAA,0BAAwB;AACxB,+BAAuD;AAKvD,iDAA2G;AAE3G,MAAM,OAAO,GAAG,WAAW,CAAC;AAE5B;;GAEG;AACH,SAAS,SAAS,CAAC,GAAY,EAAE,IAAU;IACzC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QACpF,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;KAChB;IACD,OAAO,IAAI,EAAE,CAAC;AAChB,CAAC;AAED,MAAa,gBAAgB;IAM3B,YAAY,IAAU,EAAE,MAAuB;QAC7C,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QACpC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IAClB,CAAC;IAED,GAAG,CACD,IAA8F,EAC9F,GAAG,UAAwB;QAE3B,QAAQ;QACR,MAAM,IAAI,GAAG,oBAAoB,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QACjD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,UAAU,CAAC,CAAC;QAEjD,kBAAkB;QAClB,MAAM,QAAQ,GAAG,GAAG,EAAE;YACpB,MAAM,OAAO,GAAoB,MAAM,CAAC,MAAM,CAAC;gBAC7C,OAAO,EAAE;oBACP,IAAI,EAAE,WAAW;iBAClB;gBACD,KAAK,EAAE,EAAE;gBACT,WAAW,EAAE,EAAE;gBACf,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE,WAAW;gBACrB,QAAQ,EAAE,MAAM;gBAChB,MAAM,EAAE,OAAO;gBACf,MAAM,EAAE,MAAM;gBACd,GAAG,EAAE,IAAI;gBACT,IAAI,EAAE,IAAI;gBACV,MAAM,EAAE;oBACN,aAAa,EAAE,OAAO;oBACtB,UAAU,EAAE,IAAI;iBACjB;aACF,CAAC,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,qBAAc,CAAC,OAAO,CAAC,CAAC;YAC7C,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;gBAC3B,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;aAC3D;iBAAM;gBACL,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;aAClC;QACH,CAAC,CAAC;QACF,OAAO,IAAA,2BAAW,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC;CACF;AAlDD,4CAkDC"}

package/dist/types.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="node" />
+import { ServerResponse, IncomingMessage } from 'http';
+export declare type RequestCallback = (request: IncomingMessage, response: ServerResponse) => void;
+export declare type JobCallback = (request: IncomingMessage, response: ServerResponse, callback: RequestCallback) => void;
+export interface ScheduleOption {
+    /**
+     * 加载 schedule 文件目录，默认: ./app/schedule
+     */
+    paths?: string[];
+    /**
+     * 文件匹配规则，默认: ** /*.{ts,js}
+     */
+    patterns?: string;
+    jobCallback?: JobCallback;
+}

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,41 +1,44 @@
-{
-  "name": "@zenweb/schedule",
-  "version": "2.3.2",
-  "description": "Zenweb Schedule module",
-  "exports": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "scripts": {
-    "prepublishOnly": "rm -fr dist && tsc"
-  },
-  "author": {
-    "name": "YeFei",
-    "email": "316606233@qq.com"
-  },
-  "keywords": [
-    "web",
-    "app",
-    "http",
-    "framework",
-    "schedule",
-    "cron",
-    "koa"
-  ],
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/yefei/zenweb-schedule.git"
-  },
-  "bugs": {
-    "url": "https://github.com/yefei/zenweb-schedule/issues"
-  },
-  "devDependencies": {
-    "@zenweb/core": "^2.3.2",
-    "@zenweb/router": "^2.3.0",
-    "zenweb": "^2.3.1"
-  },
-  "dependencies": {
-    "@types/node-schedule": "^1.3.2",
-    "globby": "11.0.4",
-    "node-schedule": "^2.0.0"
-  }
-}
+{
+  "name": "@zenweb/schedule",
+  "version": "2.3.6",
+  "description": "Zenweb Schedule module",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepublishOnly": "rimraf dist && tsc"
+  },
+  "author": {
+    "name": "YeFei",
+    "email": "316606233@qq.com"
+  },
+  "keywords": [
+    "web",
+    "app",
+    "http",
+    "framework",
+    "schedule",
+    "cron",
+    "koa"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yefei/zenweb-schedule.git"
+  },
+  "bugs": {
+    "url": "https://github.com/yefei/zenweb-schedule/issues"
+  },
+  "devDependencies": {
+    "@zenweb/core": "^2.3.2",
+    "@zenweb/router": "^2.3.0",
+    "zenweb": "^2.3.1"
+  },
+  "dependencies": {
+    "@types/node-schedule": "^1.3.2",
+    "globby": "11.0.4",
+    "node-schedule": "^2.0.0"
+  }
+}

package/example/app/schedule/echo.js

@@ -1,8 +0,0 @@
-'use strict';
-
-const app = require('../../app');
-
-app.schedule.job('*/1 * * * * *', ctx => {
-  console.log('task echo');
-  ctx.body = 'ok';
-});

package/example/app.js

@@ -1,11 +0,0 @@
-'use strict';
-
-process.env.DEBUG = '*';
-
-const app = module.exports = require('zenweb').create();
-app.setup(require('..').setup, {
-  jobCallback(request, response, callback) {
-    callback(request, response);
-  }
-});
-app.start();

package/src/index.ts

@@ -1,33 +0,0 @@
-import * as globby from 'globby';
-import { SetupFunction } from '@zenweb/core';
-import path = require('path');
-import { ScheduleRegister } from './register';
-import { ScheduleOption } from './types';
-export * from './types';
-
-export function setup(option?: ScheduleOption): SetupFunction {
-  return async function schedule(setup) {
-    option = Object.assign({
-      paths: [path.join(process.cwd(), 'app', 'schedule')],
-    }, option);
-    setup.debug('option: %o', option);
-    const register = new ScheduleRegister(setup.core, option);
-    setup.defineCoreProperty('schedule', { value: register });
-    if (option.paths && option.paths.length) {
-      for (const d of option.paths) {
-        let count = 0;
-        for (const m of await globby(d, { cwd: d, absolute: true })) {
-          require(m);
-          count++;
-        }
-        setup.debug('load: %s %o files', d, count);
-      }
-    }
-  }
-}
-
-declare module '@zenweb/core' {
-  interface Core {
-    schedule: ScheduleRegister;
-  }
-}

package/src/register.ts

@@ -1,80 +0,0 @@
-import '@zenweb/router';
-import schedule = require('node-schedule');
-import { ServerResponse, IncomingMessage } from 'http';
-import { Context, Next } from 'koa';
-import { Core } from '@zenweb/core';
-import { RequestCallback, ScheduleOption } from './types';
-import { Router } from '@zenweb/router';
-
-const SAFE_IP = '127.0.0.1';
-
-/**
- * 安全检查，防止外部调用
- */
-function safeCheck(ctx: Context, next: Next) {
-  if (!ctx.req.socket.remoteAddress || !ctx.req.socket.remoteAddress.endsWith(SAFE_IP)) {
-    ctx.throw(403);
-  }
-  return next();
-}
-
-export class ScheduleRegister {
-  option: ScheduleOption;
-  router: Router;
-  callback: RequestCallback;
-  private _index: number;
-
-  constructor(core: Core, option?: ScheduleOption) {
-    this.option = option || {};
-    this.router = core.router;
-    this.callback = core.koa.callback();
-    this._index = 0;
-  }
-
-  job(...args: any[]) {
-    let name = '';
-    let rule;
-
-    if (typeof args[1] === 'string') {
-      name = args[0];
-      rule = args[1];
-      args = args.slice(2);
-    } else {
-      rule = args[0];
-      args = args.slice(1);
-    }
-
-    // 注册到路由
-    const path = `/___schedule/job/${this._index++}/${name}`;
-    this.router.post(path, safeCheck, ...args);
-
-    // 注册到 scheduleJob
-    const callback = () => {
-      const request: IncomingMessage = Object.assign({
-        headers: {
-          host: '127.0.0.1',
-        },
-        query: {},
-        querystring: '',
-        host: '127.0.0.1',
-        hostname: '127.0.0.1',
-        protocol: 'http',
-        secure: 'false',
-        method: 'POST',
-        url: path,
-        path: path,
-        socket: {
-          remoteAddress: SAFE_IP,
-          remotePort: 7001,
-        },
-      });
-      const response = new ServerResponse(request);
-      if (this.option.jobCallback) {
-        this.option.jobCallback(request, response, this.callback);
-      } else {
-        this.callback(request, response);
-      }
-    };
-    return schedule.scheduleJob(name, rule, callback);
-  }
-}

package/src/types.ts

@@ -1,9 +0,0 @@
-import { ServerResponse, IncomingMessage } from 'http';
-
-export type RequestCallback = (request: IncomingMessage, response: ServerResponse) => void;
-export type JobCallback = (request: IncomingMessage, response: ServerResponse, callback: RequestCallback) => void;
-
-export interface ScheduleOption {
-  paths?: string[];
-  jobCallback?: JobCallback;
-}

package/tsconfig.json

@@ -1,21 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2019",
-    "lib": [
-      "ES2019"
-    ],
-    "module": "commonjs",
-    "noImplicitAny": true,
-    "preserveConstEnums": true,
-    "sourceMap": true,
-    "declaration": true,
-    "outDir": "./dist"
-  },
-  "exclude": [
-    "node_modules",
-    "**/*.spec.ts"
-  ],
-  "include": [
-    "src/**/*"
-  ]
-}