@zenweb/schedule 2.3.0 → 2.3.4

package/dist/index.d.ts

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

package/dist/index.js

@@ -10,7 +10,6 @@ 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");
@@ -35,5 +34,5 @@ function setup(option) {
         }
     };
 }
-exports.setup = setup;
+exports.default = setup;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +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"}
+{"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,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,wBAmBC"}

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@zenweb/schedule",
-  "version": "2.3.0",
+  "version": "2.3.4",
   "description": "Zenweb Schedule module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "prepublishOnly": "rm -fr dist && tsc"
   },
@@ -29,13 +32,13 @@
     "url": "https://github.com/yefei/zenweb-schedule/issues"
   },
   "devDependencies": {
-    "@types/node-schedule": "^1.3.2",
     "@zenweb/core": "^2.3.2",
     "@zenweb/router": "^2.3.0",
     "zenweb": "^2.3.1"
   },
   "dependencies": {
-    "node-schedule": "^2.0.0",
-    "globby": "11.0.4"
+    "@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/index.d.ts

@@ -1,30 +0,0 @@
-import { Middleware } from 'koa';
-import { Core } from '@zenweb/core';
-import { ServerResponse, IncomingMessage } from 'http';
-import { RecurrenceRule, RecurrenceSpecDateRange, RecurrenceSpecObjLit, Job } from 'node-schedule';
-
-declare class ScheduleRegister<StateT = any, CustomT = {}> {
-  job(
-    rule: RecurrenceRule | RecurrenceSpecDateRange | RecurrenceSpecObjLit | Date | string | number,
-    ...middleware: Middleware<StateT, CustomT>[]
-  ): Job;
-
-  job(
-    name: string,
-    rule: RecurrenceRule | RecurrenceSpecDateRange | RecurrenceSpecObjLit | Date | string | number,
-    ...middleware: Middleware<StateT, CustomT>[]
-  ): Job;
-}
-
-export interface ScheduleOptions {
-  paths?: string[];
-  jobCallback?: (request: IncomingMessage, response: ServerResponse, callback: (request: IncomingMessage, response: ServerResponse) => void) => void;
-}
-
-export declare function setup(core: Core, options?: ScheduleOptions): void;
-
-declare module '@zenweb/core' {
-  interface Core {
-    schedule: ScheduleRegister;
-  }
-}

package/src/index.ts

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

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/**/*"
-  ]
-}