packaged @mvx/typeorm-adapter

This repo is for distribution on npm. The source for this module is in the main repo.

@mvx/typeorm-adapter is model parser for MVC frameworker. base on ioc @tsdi. help you develop your project easily.

Install

You can install this package either with npm

npm

1
2npm install @mvx/typeorm-adapter
3
4

Documentation

create application

1import { MvcApplication, DefaultMvcMiddlewares, MvcModule, MvcServer } from '@mvx/mvc';
2import { TypeOrmModule }  from '@mvx/typeorm-adapter';
3
4// 1. use MvcHostBuilder to boot application.
5MvcApplication.run();
6
7// 2. use bootstrap module to boot application
8
9@MvcModule({
10    // baseURL: __dirname,
11    imports: [
12        TypeOrmModule
13        //...  you service, or controller, some extends module.
14    ],
15    debug: true
16})
17class MvcApi {
18    constructor() {
19        console.log('boot application');
20    }
21}
22
23
24// 3. use MvcHostBuilder to boot application module.
25
26@MvcModule({
27    imports: [
28        TypeOrmModule
29        // ... /...  you service, or controller, some extends module.
30        // DebugLogAspect
31    ],
32    middlewares: DefaultMvcMiddlewares,
33    // bootstrap: MvcServer
34})
35class MvcApi {
36
37}
38
39MvcApplication.run(MvcApi);
40
41
42//4. use bootstrap module to boot application by main.
43@MvcModule({
44    imports: [
45        TypeOrmModule
46        // ...
47    ],
48    // bootstrap: MvcServer,
49    debug: true
50})
51class MvcApi {
52    constructor() {
53        console.log('boot application');
54    }
55
56    static main() {
57        console.log('run mvc api...');
58        MvcApplication.run(MvcApi);
59    }
60}
61
62

Define Controller

default setting load controllers in your project folder /controllers

• Each Controller action should return type ResultValue, also you can return base type or object, it deal with JsonResult.
• The action can be async or sync. Have provide FileResult, JsonResult, RedirectResult, ViewResult.
• Also, you can extend with BaseController, it has implements some mothod to create the ResultValue types.
• Model can auto create in action, it auto load value from request body.
• Restfull params or Query String params can auto set to Controller action(Controller method) via the name of param matched.
• Cors by @Cors decorator in class or method.

define as:

1import { Controller, Get, Post, IContext, ContextToken,  RequestMethod, Model, Field, Cors } from '@mvx/mvc';
2import { Inject } from '@tsdi/core';
3import { Mywork } from '../bi/Mywork';
4import { User } from '../models';
5
6@Cors
7@Controller('/users')
8export class UserController {
9
10    // @Inject(symbols.IContext)
11    // context: IContext;
12    constructor(private work: Mywork) {
13
14    }
15
16    @Get('')
17    index() {
18        console.log('home index invorked', this.work);
19        return this.work.workA();
20    }
21
22    // @Cors([RequestMethod.Post])
23    // also can define as below
24    // @Cors(['Post','Get'])
25    // @Cors('POST,GET')
26    @Post('/add')
27    async addUser(user: User, @Inject(ContextToken) ctx: IContext) {
28        console.log('user:', user);
29        console.log('request body', ctx.request.body);
30        return this.work.save(user);
31    }
32
33    @Get('/sub')
34    sub() {
35        return this.work.workB();
36    }
37
38    @Get('/:name')
39    getPerson(name: string) {
40        return this.work.find(name);
41    }
42
43    @Get('/find/:name')
44    query(name: string, @Inject(ContextToken) ctx) {
45        console.log(ctx);
46        return this.work.find(name);
47    }
48
49    @Get('/test/:id')
50    parmtest(id: number) {
51        if (id === 1) {
52            return this.work.workA();
53        } else if (id === 2) {
54            return this.work.workB();
55        } else {
56            return 'notFound';
57        }
58    }
59
60    @Post('/posttest/:id')
61    postTest(id: number) {
62        return {
63            id: id
64        }
65    }
66
67}
68
69
70@Controller('/')
71export class HomeController extends BaseController {
72
73    // @Inject(ContextToken)
74    // context: IContext;
75    constructor() {
76        super();
77    }
78
79    @Get('')
80    index(): ResultValue {
81        return this.view('index.html');
82    }
83
84    @Get('/index2')
85    home2(): ResultValue {
86        return this.view('index2.html');
87    }
88
89    @Post('/goto/:pageName')
90    gotoPage(pageName: string): ResultValue {
91        return this.redirect( '/' + pageName);
92    }
93}
94
95

Define AOP

Auto load Aspect service from folder /aop in your project.

see simple demo

1import { Aspect, Around, Joinpoint, Before } from '@tsdi/aop';
2
3@Aspect
4export class DebugLog {
5    @Around('execution(*Controller.*)')
6    log(joinPoint: Joinpoint) {
7        console.log('aspect append log, method name:', joinPoint.fullName, ' state:', joinPoint.state, ' Args:', joinPoint.args ,  ' returning:', joinPoint.returning, ' throwing:', joinPoint.throwing);
8    }
9
10    @Before(/Controller.\*$/)
11    Beforlog(joinPoint: Joinpoint) {
12        console.log('aspect Befor log:', joinPoint.fullName);
13    }
14}
15
16

Define Middlewares

default setting load middlewares in your project folder /middlewares

1import { Middleware, IMiddleware, Application, Configuration } from '@mvx/mvc';
2import { IContainer, Injectable } from '@tsdi/core';
3
4
5@Middleware('logger')
6export class Logger implements IMiddleware {
7
8    constructor() {
9
10    }
11
12    async execute (ctx, next) {
13        let start = Date.now();
14        await next();
15        const ms = Date.now() - start;
16        console.log(`mylog: ${ctx.method} ${ctx.url} - ${ms}ms`);
17        let end = new Date();
18    }
19
20}
21

changes

• 1.0.1

  1. add useServer to add Server Middleware features.

• 0.6.3

  1. update compile task, zip lib.
  2. update tsioc for fix bug when inherit class with classAnnations

• 0.5.5

  1. fix ConsoleLog error console.debug in nuix will not console.
  2. update components for route.

• v0.5.3

  1. fix bug in nuix linux load .d.ts file raise error, set default comfig load module with !./**/*.d.ts exclude.

• v0.5.1

  1. add Log aop aspect service. for Log easy. default user console to log, can config logLib,logConfig in your config.js to use third logger lib. eg. { logLib: 'log4js', logConfig:{...} }. has implements log4js adapter see code

  2. DebugAspect, config debug: true, in your config.js, will auto log debug info.

  3. AnnotationLogerAspect @annotation(Logger), logger some state via @Logger decorator config.

  4. add Annotation Auth aspect service AuthAspect to support yourself auth check easy. eg.

1@Aspect
2export class YourSecrityAspect {
3    // before AuthAspect.auth check some.
4    @Before('execution(AuthAspect.auth)', 'authAnnotation')
5    sessionCheck(authAnnotation: AuthorizationMetadata[], joinPoint: Joinpoint) {
6        //TODO： you check by authAnnotation
7    }
8}
9

• v0.4.1 fix assertUrlRegExp bug.
• v0.3.20 New Feature：
  1. Router and Cors middleware will check url is right route or not. add default route Url check in Configuartion. isRouteUrl method and routeUrlRegExp field.
• v0.3.19 New Feature: Fix bug, reset context middleware order to fix 500 error, when some time request.
• v0.3.18 New Feature:
  1. update tsioc to improvement method invoker.
  2. fix Model not register bug. get Model return empty object.
• v0.3.17 New Feature:
  1. add hostname for http or https to listen.
• v0.3.12 New Feature:
  1. es5 support. enable config https http server.
• v0.3.10 New Feature:
  1. Restfull params or Query String params can auto set to Controller action(Controller method) via the name of param matched.

Simples

see simples

License

MIT © Houjun