@zenweb/schedule 1.0.0 → 2.3.0

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { SetupFunction } from '@zenweb/core';
+import { ScheduleOption } from './types';
+export * from './types';
+export declare function setup(option?: ScheduleOption): SetupFunction;

package/dist/index.js

@@ -0,0 +1,39 @@
+"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 });
+exports.setup = void 0;
+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(d, { cwd: d, absolute: true })) {
+                    require(m);
+                    count++;
+                }
+                setup.debug('load: %s %o files', d, count);
+            }
+        }
+    };
+}
+exports.setup = 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,SAAgB,KAAK,CAAC,MAAuB;IAC3C,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,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE;oBAC3D,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,sBAmBC"}

package/dist/register.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="koa__router" />
+import '@zenweb/router';
+import schedule = require('node-schedule');
+import { Core } from '@zenweb/core';
+import { RequestCallback, ScheduleOption } from './types';
+import { Router } from '@zenweb/router';
+export declare class ScheduleRegister {
+    option: ScheduleOption;
+    router: Router;
+    callback: RequestCallback;
+    private _index;
+    constructor(core: Core, option?: ScheduleOption);
+    job(...args: any[]): schedule.Job;
+}

package/dist/register.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScheduleRegister = void 0;
+require("@zenweb/router");
+const schedule = require("node-schedule");
+const http_1 = require("http");
+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(...args) {
+        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 = 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 schedule.scheduleJob(name, 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,0CAA2C;AAC3C,+BAAuD;AAMvD,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,CAAC,GAAG,IAAW;QAChB,IAAI,IAAI,GAAG,EAAE,CAAC;QACd,IAAI,IAAI,CAAC;QAET,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE;YAC/B,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACf,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACf,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACtB;aAAM;YACL,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACf,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SACtB;QAED,QAAQ;QACR,MAAM,IAAI,GAAG,oBAAoB,IAAI,CAAC,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC;QACzD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;QAE3C,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,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC;CACF;AA3DD,4CA2DC"}

package/dist/types.d.ts

@@ -0,0 +1,8 @@
+/// <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 {
+    paths?: 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,10 +1,11 @@
 {
   "name": "@zenweb/schedule",
-  "version": "1.0.0",
+  "version": "2.3.0",
   "description": "Zenweb Schedule module",
-  "main": "index.js",
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "prepublishOnly": "rm -fr dist && tsc"
   },
   "author": {
     "name": "YeFei",
@@ -28,13 +29,13 @@
     "url": "https://github.com/yefei/zenweb-schedule/issues"
   },
   "devDependencies": {
-    "eslint": "^7.16.0",
-    "koa": "^2.13.1",
-    "zenweb": "^1.5.1"
+    "@types/node-schedule": "^1.3.2",
+    "@zenweb/core": "^2.3.2",
+    "@zenweb/router": "^2.3.0",
+    "zenweb": "^2.3.1"
   },
   "dependencies": {
-    "@feiye/discover": "^1.0.0",
-    "debug": "^4.3.1",
-    "node-schedule": "^2.0.0"
+    "node-schedule": "^2.0.0",
+    "globby": "11.0.4"
   }
 }

package/src/index.ts

@@ -0,0 +1,27 @@
+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);
+      }
+    }
+  }
+}

package/{lib/register.js → src/register.ts}

@@ -1,36 +1,37 @@
-'use strict';
-
-const schedule = require('node-schedule');
-const { ServerResponse } = require('http');
+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';
 
 /**
  * 安全检查，防止外部调用
- * @param {import('koa').Context} ctx
- * @param {import('koa').Middleware} next
  */
-function safeCheck(ctx, next) {
+function safeCheck(ctx: Context, next: Next) {
   if (!ctx.req.socket.remoteAddress || !ctx.req.socket.remoteAddress.endsWith(SAFE_IP)) {
     ctx.throw(403);
   }
   return next();
 }
 
-class ScheduleRegister {
-  /**
-   * @param {import('@zenweb/core').Core} core
-   * @param {object} [options]
-   * @param {(req, res, callback: (req, res) => void) => void} [options.jobCallback] 自定义任务调用
-   */
-  constructor(core, options) {
-    this.options = options || {};
+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) {
+  job(...args: any[]) {
     let name = '';
     let rule;
 
@@ -48,11 +49,8 @@ class ScheduleRegister {
     this.router.post(path, safeCheck, ...args);
 
     // 注册到 scheduleJob
-    const jobArgs = [];
-    if (name) jobArgs.push(name);
-    jobArgs.push(rule);
-    jobArgs.push(() => {
-      const request = {
+    const callback = () => {
+      const request: IncomingMessage = Object.assign({
         headers: {
           host: '127.0.0.1',
         },
@@ -69,18 +67,14 @@ class ScheduleRegister {
           remoteAddress: SAFE_IP,
           remotePort: 7001,
         },
-      };
+      });
       const response = new ServerResponse(request);
-      if (this.options.jobCallback) {
-        this.options.jobCallback(request, response, this.callback);
+      if (this.option.jobCallback) {
+        this.option.jobCallback(request, response, this.callback);
       } else {
         this.callback(request, response);
       }
-    });
-    return schedule.scheduleJob(...jobArgs);
+    };
+    return schedule.scheduleJob(name, rule, callback);
   }
 }
-
-module.exports = {
-  ScheduleRegister,
-};

package/src/types.ts

@@ -0,0 +1,9 @@
+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

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

package/.eslintrc

@@ -1,14 +0,0 @@
-{
-  "extends": "eslint:recommended",
-  "env": {
-    "node": true,
-    "es6": true
-  },
-  "parserOptions": {
-    "ecmaVersion": 8
-  },
-  "rules": {
-    "no-unused-vars": ["warn", { "vars": "local", "args": "none" }],
-    "semi": "warn"
-  }
-}

package/index.js

@@ -1,29 +0,0 @@
-'use strict';
-
-const path = require('path');
-const { discover } = require('@feiye/discover');
-const debug = require('./lib/debug');
-const { ScheduleRegister } = require('./lib/register');
-
-/**
- * @param {import('@zenweb/core').Core} core 
- * @param {*} [options]
- */
-function setup(core, options) {
-  options = Object.assign({
-    paths: [path.join(process.cwd(), 'app', 'schedule')],
-  }, options);
-  debug('options: %o', options);
-  const register = new ScheduleRegister(core, options);
-  Object.defineProperty(core, 'schedule', { value: register });
-  if (options.paths && options.paths.length) {
-    options.paths.forEach(path => {
-      const count = discover(path);
-      debug('load: %s %o files', path, count);
-    });
-  }
-}
-
-module.exports = {
-  setup,
-};

package/lib/debug.js

@@ -1,3 +0,0 @@
-'use strict';
-
-module.exports = require('debug')('zenweb:schedule');