zenweb 1.21.0 → 2.0.0

package/README.md

@@ -3,15 +3,29 @@ Modular lightweight web framework based on Koa
 
 ## Quick start
 
+package.json
+```json
+{
+  "name": "app",
+  "type": "module",
+  "private": true,
+  "exports": "app/**",
+  "scripts": {
+    "dev": "cross-env DEBUG=* NODE_ENV=development nodemon app",
+    "start": "node app"
+  }
+}
+```
+
 ```bash
-$ npm i zenweb
+$ npm i zenweb cross-env nodemon
 ```
 
 app/index.js
 ```js
-'use strict';
+import { create } from 'zenweb';
 
-const app = module.exports = require('zenweb').create({
+const app = create({
   // add optional module
   // $ npm i @zenweb/sentry @zenweb/cors @zenweb/validation
   sentry: { dsn: 'xxxxx' },
@@ -24,16 +38,14 @@ app.start();
 
 app/controller/hello.js
 ```js
-'use strict';
-
-const app = require('..');
-const router = app.router;
+import { Router } from 'zenweb';
+export const router = Router();
 
-app.router.get('/', ctx => {
+router.get('/', ctx => {
   ctx.success('Hello');
 });
 
-app.router.get('/hello', ctx => {
+router.get('/hello', ctx => {
   ctx.success({
     say1: ctx.service.helloService.say(),
     say2: ctx.service.helloService.say(),
@@ -41,7 +53,7 @@ app.router.get('/hello', ctx => {
   });
 });
 
-app.router.get('/error', ctx => {
+router.get('/error', ctx => {
   ctx.fail('error info');
   console.log('Will not output');
 });
@@ -49,11 +61,9 @@ app.router.get('/error', ctx => {
 
 app/service/hello_service.js
 ```js
-'use strict';
-
-const { Service } = require('zenweb');
+import { Service } from 'zenweb';
 
-class HelloService extends Service {
+export default class HelloService extends Service {
   constructor(ctx) {
     super(ctx);
     this.i = 0;
@@ -64,49 +74,10 @@ class HelloService extends Service {
     return `Hello: ${this.ctx.path}, ${this.i}`;
   }
 }
-
-module.exports = HelloService;
 ```
 
 ```bash
-$ DEBUG=* node app
+$ npm run dev
 boot time: 2 ms
 server on: 7001
 ```
-
-## doc
-
-### ctx.helper
-#### query(), body(), params()
-```js
-ctx.body = ctx.helper.query('kw', {
-  count: 'int',
-  is: 'bool',
-  list:'int[]',
-  trim:'trim',
-  trimList:'trim[]',
-});
-```
-```bash
-curl --location --request GET '127.0.0.1:7001/typecast?kw=%20111%20&count=222&is=y&list=1,2,3&trim=%20%20aaaa%20&trimList=asd,sdd,%20%20ddd%20,d,,1'
-```
-```json
-{
-  "kw": " 111 ",
-  "count": 222,
-  "is": true,
-  "list": [
-    1,
-    2,
-    3
-  ],
-  "trim": "aaaa",
-  "trimList": [
-    "asd",
-    "sdd",
-    "ddd",
-    "d",
-    "1"
-  ]
-}
-```

package/index.d.ts

@@ -2,9 +2,6 @@ import '@zenweb/log';
 import '@zenweb/router';
 import '@zenweb/helper';
 import '@zenweb/service';
-export { Core } from '@zenweb/core';
-export { ApiFail, ApiFailDetail } from '@zenweb/api';
-export { Service } from '@zenweb/service';
 import { CoreOptions } from '@zenweb/core';
 import { ServiceOptions } from '@zenweb/service';
 import { ApiOptions } from '@zenweb/api';
@@ -20,6 +17,9 @@ import { ViewOptions } from '@zenweb/view';
 import { ScheduleOptions } from '@zenweb/schedule';
 import { MessageCodeOption } from '@zenweb/messagecode';
 import { FormOption } from '@zenweb/form';
+export { Router } from '@zenweb/router';
+export { ApiFail } from '@zenweb/api';
+export { Service } from '@zenweb/service';
 
 interface CreateOptions {
   core?: CoreOptions;

package/index.js

@@ -1,8 +1,7 @@
-'use strict';
-
-const { Core } = require('@zenweb/core');
-const { ApiFail } = require('@zenweb/api');
-const { Service } = require('@zenweb/service');
+import { Core } from '@zenweb/core';
+export { Router } from '@zenweb/router';
+export { ApiFail } from '@zenweb/api';
+export { Service } from '@zenweb/service';
 
 // 可选模块
 const OPTIONAL_MODULES = {
@@ -20,7 +19,7 @@ const OPTIONAL_MODULES = {
  * @param {object} [options] 配置项
  * @returns {Core}
  */
-function create(options) {
+export function create(options) {
   options = options || {};
   const core = new Core(options.core);
   core.setup('@zenweb/meta');
@@ -43,10 +42,3 @@ function create(options) {
   }
   return core;
 }
-
-module.exports = {
-  Core,
-  ApiFail,
-  Service,
-  create,
-};

package/package.json

@@ -1,10 +1,19 @@
 {
   "name": "zenweb",
-  "version": "1.21.0",
+  "version": "2.0.0",
   "description": "Modular lightweight web framework based on Koa",
-  "main": "index.js",
+  "type": "module",
+  "exports": "./index.js",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "typings": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "dev": "cd example && cross-env DEBUG=* NODE_ENV=development node app"
   },
   "author": {
     "name": "YeFei",
@@ -25,7 +34,7 @@
   "bugs": {
     "url": "https://github.com/yefei/zenweb/issues"
   },
-  "devDependencies": {
+  "optionalDependencies": {
     "@zenweb/cors": "^1.1.0",
     "@zenweb/form": "^1.6.1",
     "@zenweb/metric": "^1.3.2",
@@ -39,12 +48,15 @@
   "dependencies": {
     "@zenweb/api": "^1.2.0",
     "@zenweb/body": "^1.1.0",
-    "@zenweb/core": "^1.2.3",
+    "@zenweb/core": "^2.0.1",
     "@zenweb/helper": "^1.2.0",
-    "@zenweb/log": "^1.6.0",
+    "@zenweb/log": "^2.0.1",
     "@zenweb/messagecode": "^1.0.1",
-    "@zenweb/meta": "^1.0.1",
-    "@zenweb/router": "^1.1.2",
-    "@zenweb/service": "^1.3.0"
+    "@zenweb/meta": "^2.0.0",
+    "@zenweb/router": "^2.0.1",
+    "@zenweb/service": "^2.0.0"
+  },
+  "devDependencies": {
+    "cross-env": "^7.0.3"
   }
 }

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/example/app/controller/index.js

@@ -1,87 +0,0 @@
-'use strict';
-
-const app = require('../../app');
-const router = app.router;
-
-router.get('/', ctx => {
-  ctx.body = {
-    hello: 'world',
-    time: Date.now(),
-  };
-});
-
-router.get('/name/:name', ctx => {
-  ctx.body = {
-    name: ctx.params.name,
-  };
-});
-
-router.get('/error', ctx => {
-  // 错误输出终止执行
-  ctx.fail('error demo');
-  console.log('后续代码不会执行');
-});
-
-router.get('/success', ctx => {
-  // 使用 success 统一包装返回格式
-  ctx.success('ok');
-});
-
-router.get('/log', ctx => {
-  app.log.info('App log');
-  ctx.log.info('Context log');
-  ctx.body = 'hello';
-});
-
-router.get('/service', ctx => {
-  console.log( 'helloService' in ctx.service ); // 可以用 in 判断 service 是否已注册
-  const helloService = ctx.service.helloService; // 获取时会被初始化
-  const helloService2 = ctx.service.helloService; // 再次获取使用之前已经初始化的
-  const { helloService: s3 } = ctx.service; // 可以用解构
-  ctx.body = {
-    1: helloService.say(),
-    2: helloService2.say(),
-    3: s3.say(),
-  };
-});
-
-function sleep(ms) {
-  return new Promise((res) => {
-    setTimeout(res, ms);
-  });
-}
-
-router.get('/x-process-time', async ctx => {
-  await sleep(1000);
-  ctx.body = 'ok';
-});
-
-
-router.get('/typecast', ctx => {
-  ctx.body = ctx.helper.query('kw', {
-    count: 'int',
-    is: 'bool',
-    list:'int[]',
-    trim:'trim',
-    trimList:'trim[]',
-  });
-});
-
-router.post('/typecast', ctx => {
-  ctx.body = ctx.helper.body('kw', {
-    count: 'int',
-    is: 'bool',
-    list:'int[]',
-    trim:'trim',
-    trimList:'trim[]',
-  });
-});
-
-router.post('/post', ctx => {
-  ctx.body = ctx.request.body;
-});
-
-router.post('/file', ctx => {
-  console.log('file:', ctx.request.files);
-  ctx.body = ctx.request.body;
-});

package/example/app/service/hello_service.js

@@ -1,17 +0,0 @@
-'use strict';
-
-const { Service } = require('../../..');
-
-class HelloService extends Service {
-  constructor(ctx) {
-    super(ctx);
-    this.i = 0;
-  }
-
-  say() {
-    this.i++;
-    return `Hello: ${this.ctx.path}, ${this.i}`;
-  }
-}
-
-module.exports = HelloService;

package/example/app.js

@@ -1,19 +0,0 @@
-'use strict';
-
-process.env.NODE_ENV = 'development';
-process.env.DEBUG = '*';
-
-const app = module.exports = require('..').create({
-  body: {
-    multipart: true,
-  },
-  api: {
-    failCode: 500,
-    failStatus: 200,
-    success(data) {
-      return { path: this.path, code: 200, data };
-    },
-  }
-});
-
-app.start();