zenweb 2.3.1 → 2.4.0

package/README.md

@@ -1,112 +1,112 @@
-# ZenWeb
-基于 Koa 的模块化轻量级 Web 开发框架。
-本框架全部由 typescript 编写
-
-## 快速开始
-
-推荐使用 typescript 创建项目
-
-package.json
-```json
-{
-  "name": "app",
-  "private": true,
-  "main": "app/index.js",
-  "scripts": {
-    "dev": "cross-env DEBUG=* NODE_ENV=development nodemon app.ts",
-    "build": "tsc",
-    "start": "node app"
-  },
-  "nodemonConfig": {
-    "ignore": [
-      "**/typings/**"
-    ]
-  }
-}
-```
-
-```bash
-$ npm i zenweb
-$ npm i cross-env nodemon -D
-```
-
-app/index.ts
-```ts
-import { create } from 'zenweb';
-
-const app = create({
-  // add optional module
-  // $ npm i @zenweb/sentry @zenweb/cors @zenweb/validation
-  sentry: { dsn: 'xxxxx' },
-  cors: { origin: '*' },
-  validation: {},
-});
-
-app.start();
-```
-
-app/controller/hello.ts
-```ts
-import { Router } from 'zenweb';
-export const router = new Router();
-
-router.get('/', ctx => {
-  ctx.success('Hello');
-});
-
-router.get('/hello', ctx => {
-  ctx.success({
-    say1: ctx.service.helloService.say(),
-    say2: ctx.service.helloService.say(),
-    say3: ctx.service.helloService.say(),
-  });
-});
-
-router.get('/error', ctx => {
-  ctx.fail('error info');
-  console.log('Will not output');
-});
-```
-
-app/service/hello_service.ts
-```js
-import { Service } from 'zenweb';
-
-export default class HelloService extends Service {
-  i = 0;
-  say() {
-    this.i++;
-    return `Hello: ${this.ctx.path}, ${this.i}`;
-  }
-}
-```
-
-```bash
-$ npm run dev
-boot time: 2 ms
-server on: 7001
-```
-
-### 内置模块
-- [meta](https://www.npmjs.com/package/@zenweb/meta)
-- [log](https://www.npmjs.com/package/@zenweb/log)
-- [router](https://www.npmjs.com/package/@zenweb/router)
-- [messagecode](https://www.npmjs.com/package/@zenweb/messagecode)
-- [body](https://www.npmjs.com/package/@zenweb/body)
-- [service](https://www.npmjs.com/package/@zenweb/service)
-- [api](https://www.npmjs.com/package/@zenweb/api)
-- [helper](https://www.npmjs.com/package/@zenweb/helper)
-
-内置模块默认开启，可以通过设置配置项为 **false** 关闭
-
-
-### 可选模块
-- [cors](https://www.npmjs.com/package/@zenweb/cors)
-- [sentry](https://www.npmjs.com/package/@zenweb/sentry)
-- [metric](https://www.npmjs.com/package/@zenweb/metric)
-- [validation](https://www.npmjs.com/package/@zenweb/validation)
-- [mysql](https://www.npmjs.com/package/@zenweb/mysql)
-- [orm](https://www.npmjs.com/package/@zenweb/orm)
-- [view](https://www.npmjs.com/package/@zenweb/view)
-- [schedule](https://www.npmjs.com/package/@zenweb/schedule)
-- [form](https://www.npmjs.com/package/@zenweb/form)
+# ZenWeb
+基于 Koa 的模块化轻量级 Web 开发框架。
+本框架全部由 typescript 编写
+
+## 快速开始
+
+推荐使用 typescript 创建项目
+
+package.json
+```json
+{
+  "name": "app",
+  "private": true,
+  "main": "app/index.js",
+  "scripts": {
+    "dev": "cross-env DEBUG=* NODE_ENV=development nodemon app.ts",
+    "build": "tsc",
+    "start": "node app"
+  },
+  "nodemonConfig": {
+    "ignore": [
+      "**/typings/**"
+    ]
+  }
+}
+```
+
+```bash
+$ npm i zenweb
+$ npm i cross-env nodemon -D
+```
+
+app/index.ts
+```ts
+import { create } from 'zenweb';
+
+const app = create({
+  // add optional module
+  // $ npm i @zenweb/sentry @zenweb/cors @zenweb/validation
+  sentry: { dsn: 'xxxxx' },
+  cors: { origin: '*' },
+  validation: {},
+});
+
+app.start();
+```
+
+app/controller/hello.ts
+```ts
+import { Router } from 'zenweb';
+export const router = new Router();
+
+router.get('/', ctx => {
+  ctx.success('Hello');
+});
+
+router.get('/hello', ctx => {
+  ctx.success({
+    say1: ctx.service.helloService.say(),
+    say2: ctx.service.helloService.say(),
+    say3: ctx.service.helloService.say(),
+  });
+});
+
+router.get('/error', ctx => {
+  ctx.fail('error info');
+  console.log('Will not output');
+});
+```
+
+app/service/hello_service.ts
+```js
+import { Service } from 'zenweb';
+
+export default class HelloService extends Service {
+  i = 0;
+  say() {
+    this.i++;
+    return `Hello: ${this.ctx.path}, ${this.i}`;
+  }
+}
+```
+
+```bash
+$ npm run dev
+boot time: 2 ms
+server on: 7001
+```
+
+### 内置模块
+- [meta](https://www.npmjs.com/package/@zenweb/meta)
+- [log](https://www.npmjs.com/package/@zenweb/log)
+- [router](https://www.npmjs.com/package/@zenweb/router)
+- [messagecode](https://www.npmjs.com/package/@zenweb/messagecode)
+- [body](https://www.npmjs.com/package/@zenweb/body)
+- [service](https://www.npmjs.com/package/@zenweb/service)
+- [api](https://www.npmjs.com/package/@zenweb/api)
+- [helper](https://www.npmjs.com/package/@zenweb/helper)
+
+内置模块默认开启，可以通过设置配置项为 **false** 关闭
+
+
+### 可选模块
+- [cors](https://www.npmjs.com/package/@zenweb/cors)
+- [sentry](https://www.npmjs.com/package/@zenweb/sentry)
+- [metric](https://www.npmjs.com/package/@zenweb/metric)
+- [validation](https://www.npmjs.com/package/@zenweb/validation)
+- [mysql](https://www.npmjs.com/package/@zenweb/mysql)
+- [orm](https://www.npmjs.com/package/@zenweb/orm)
+- [view](https://www.npmjs.com/package/@zenweb/view)
+- [schedule](https://www.npmjs.com/package/@zenweb/schedule)
+- [form](https://www.npmjs.com/package/@zenweb/form)

package/dist/index.d.ts

@@ -1,10 +1,10 @@
-import { Core } from '@zenweb/core';
-import { CreateOptions } from './types';
-export { Router } from '@zenweb/router';
-export { ApiFail } from '@zenweb/api';
-export { Service } from '@zenweb/service';
-export * from './types';
-/**
- * @param options 模块配置项
- */
-export declare function create(options: CreateOptions): Core;
+import { Core } from '@zenweb/core';
+import { CreateOptions } from './types';
+export { Router } from '@zenweb/router';
+export { ApiFail } from '@zenweb/api';
+export { Service } from '@zenweb/service';
+export * from './types';
+/**
+ * @param options 模块配置项
+ */
+export declare function create(options: CreateOptions): Core;

package/dist/index.js

@@ -1,55 +1,55 @@
-"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.create = exports.Service = exports.ApiFail = exports.Router = void 0;
-const meta_1 = require("@zenweb/meta");
-const log_1 = require("@zenweb/log");
-const router_1 = require("@zenweb/router");
-const messagecode_1 = require("@zenweb/messagecode");
-const body_1 = require("@zenweb/body");
-const service_1 = require("@zenweb/service");
-const api_1 = require("@zenweb/api");
-const helper_1 = require("@zenweb/helper");
-const core_1 = require("@zenweb/core");
-var router_2 = require("@zenweb/router");
-Object.defineProperty(exports, "Router", { enumerable: true, get: function () { return router_2.Router; } });
-var api_2 = require("@zenweb/api");
-Object.defineProperty(exports, "ApiFail", { enumerable: true, get: function () { return api_2.ApiFail; } });
-var service_2 = require("@zenweb/service");
-Object.defineProperty(exports, "Service", { enumerable: true, get: function () { return service_2.Service; } });
-__exportStar(require("./types"), exports);
-/**
- * @param options 模块配置项
- */
-function create(options) {
-    options = options || {};
-    const core = new core_1.Core(options.core);
-    if (options.meta !== false)
-        core.setup((0, meta_1.default)(options.meta));
-    if (options.log !== false)
-        core.setup((0, log_1.default)(options.log));
-    if (options.router !== false)
-        core.setup((0, router_1.default)(options.router));
-    if (options.messagecode !== false)
-        core.setup((0, messagecode_1.default)(options.messagecode));
-    if (options.body !== false)
-        core.setup((0, body_1.default)(options.body));
-    if (options.service !== false)
-        core.setup((0, service_1.default)(options.service));
-    if (options.api !== false)
-        core.setup((0, api_1.default)(options.api));
-    if (options.helper !== false)
-        core.setup((0, helper_1.default)());
-    return core;
-}
-exports.create = create;
+"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.create = exports.Service = exports.ApiFail = exports.Router = void 0;
+const meta_1 = require("@zenweb/meta");
+const log_1 = require("@zenweb/log");
+const router_1 = require("@zenweb/router");
+const messagecode_1 = require("@zenweb/messagecode");
+const body_1 = require("@zenweb/body");
+const service_1 = require("@zenweb/service");
+const api_1 = require("@zenweb/api");
+const helper_1 = require("@zenweb/helper");
+const core_1 = require("@zenweb/core");
+var router_2 = require("@zenweb/router");
+Object.defineProperty(exports, "Router", { enumerable: true, get: function () { return router_2.Router; } });
+var api_2 = require("@zenweb/api");
+Object.defineProperty(exports, "ApiFail", { enumerable: true, get: function () { return api_2.ApiFail; } });
+var service_2 = require("@zenweb/service");
+Object.defineProperty(exports, "Service", { enumerable: true, get: function () { return service_2.Service; } });
+__exportStar(require("./types"), exports);
+/**
+ * @param options 模块配置项
+ */
+function create(options) {
+    options = options || {};
+    const core = new core_1.Core(options.core);
+    if (options.meta !== false)
+        core.setup((0, meta_1.default)(options.meta));
+    if (options.log !== false)
+        core.setup((0, log_1.default)(options.log));
+    if (options.router !== false)
+        core.setup((0, router_1.default)(options.router));
+    if (options.messagecode !== false)
+        core.setup((0, messagecode_1.default)(options.messagecode));
+    if (options.body !== false)
+        core.setup((0, body_1.default)(options.body));
+    if (options.service !== false)
+        core.setup((0, service_1.default)(options.service));
+    if (options.api !== false)
+        core.setup((0, api_1.default)(options.api));
+    if (options.helper !== false)
+        core.setup((0, helper_1.default)());
+    return core;
+}
+exports.create = create;
 //# sourceMappingURL=index.js.map

package/dist/types.d.ts

@@ -1,20 +1,20 @@
-import { CoreOption } from '@zenweb/core';
-import { MetaOption } from '@zenweb/meta';
-import { LogOption } from '@zenweb/log';
-import { RouterOption } from '@zenweb/router';
-import { MessageCodeOption } from '@zenweb/messagecode';
-import { BodyOption } from '@zenweb/body';
-import { ServiceOption } from '@zenweb/service';
-import { ApiOption } from '@zenweb/api';
-export interface CreateOptions {
-    [key: string]: any;
-    core?: CoreOption;
-    meta?: MetaOption | false;
-    log?: LogOption | false;
-    router?: RouterOption | false;
-    messagecode?: MessageCodeOption | false;
-    body?: BodyOption | false;
-    service?: ServiceOption | false;
-    api?: ApiOption | false;
-    helper?: boolean;
-}
+import { CoreOption } from '@zenweb/core';
+import { MetaOption } from '@zenweb/meta';
+import { LogOption } from '@zenweb/log';
+import { RouterOption } from '@zenweb/router';
+import { MessageCodeOption } from '@zenweb/messagecode';
+import { BodyOption } from '@zenweb/body';
+import { ServiceOption } from '@zenweb/service';
+import { ApiOption } from '@zenweb/api';
+export interface CreateOptions {
+    [key: string]: any;
+    core?: CoreOption;
+    meta?: MetaOption | false;
+    log?: LogOption | false;
+    router?: RouterOption | false;
+    messagecode?: MessageCodeOption | false;
+    body?: BodyOption | false;
+    service?: ServiceOption | false;
+    api?: ApiOption | false;
+    helper?: boolean;
+}

package/dist/types.js

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

package/package.json

@@ -1,47 +1,47 @@
-{
-  "name": "zenweb",
-  "version": "2.3.1",
-  "description": "Modular lightweight web framework based on Koa",
-  "main": "dist/index.js",
-  "typings": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "prepublishOnly": "tsc --build --clean && tsc",
-    "dev": "cd example && zenweb-service-types && cross-env DEBUG=* NODE_ENV=development ts-node app"
-  },
-  "author": {
-    "name": "YeFei",
-    "email": "316606233@qq.com"
-  },
-  "keywords": [
-    "web",
-    "app",
-    "http",
-    "framework",
-    "koa"
-  ],
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/yefei/zenweb.git"
-  },
-  "bugs": {
-    "url": "https://github.com/yefei/zenweb/issues"
-  },
-  "dependencies": {
-    "@zenweb/api": "^2.3.2",
-    "@zenweb/body": "^2.3.1",
-    "@zenweb/core": "^2.3.2",
-    "@zenweb/helper": "^2.3.0",
-    "@zenweb/log": "^2.3.0",
-    "@zenweb/messagecode": "^2.3.0",
-    "@zenweb/meta": "^2.3.0",
-    "@zenweb/router": "^2.3.0",
-    "@zenweb/service": "^2.3.5"
-  },
-  "devDependencies": {
-    "cross-env": "^7.0.3"
-  }
-}
+{
+  "name": "zenweb",
+  "version": "2.4.0",
+  "description": "Modular lightweight web framework based on Koa",
+  "main": "dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepublishOnly": "tsc --build --clean && tsc",
+    "dev": "cd example && zenweb-service-types && cross-env DEBUG=* NODE_ENV=development ts-node app"
+  },
+  "author": {
+    "name": "YeFei",
+    "email": "316606233@qq.com"
+  },
+  "keywords": [
+    "web",
+    "app",
+    "http",
+    "framework",
+    "koa"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yefei/zenweb.git"
+  },
+  "bugs": {
+    "url": "https://github.com/yefei/zenweb/issues"
+  },
+  "dependencies": {
+    "@zenweb/api": "^2.3.2",
+    "@zenweb/body": "^2.3.1",
+    "@zenweb/core": "^2.3.2",
+    "@zenweb/helper": "^2.3.0",
+    "@zenweb/log": "^2.3.0",
+    "@zenweb/messagecode": "^2.3.0",
+    "@zenweb/meta": "^2.3.0",
+    "@zenweb/router": "^2.3.0",
+    "@zenweb/service": "^2.4.2"
+  },
+  "devDependencies": {
+    "cross-env": "^7.0.3"
+  }
+}