fix(json-api-nestjs): allow extends inner methode

Author: Alexander Kharkovey

README.md

@@ -1,105 +1,55 @@
+<p align='center'>
+  <a href="https://www.npmjs.com/package/json-api-nestjs" target="_blank"><img src="https://img.shields.io/npm/v/json-api-nestjs.svg" alt="NPM Version" /></a>
+  <a href="https://www.npmjs.com/package/json-api-nestjs" target="_blank"><img src="https://img.shields.io/npm/l/json-api-nestjs.svg" alt="Package License" /></a>
+  <a href="https://www.npmjs.com/package/json-api-nestjs" target="_blank"><img src="https://img.shields.io/npm/dm/json-api-nestjs.svg" alt="NPM Downloads" /></a>
+  <a href="http://commitizen.github.io/cz-cli/" target="_blank"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly" /></a>
+  <img src="https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/klerick/397d521f54660656f2fd6195ec482581/raw/coverage-json-api.json" alt="Coverage Badge" />
+</p>
 
+<p align="center">
+  Json API plugin for 
+  <a href="http://nestjs.com/" target="blank">NestJS</a>
+  framework 
+</p>
+<p>
+   Tools to implement JSON API, such as, end point, query params, body params, validation and transformation response.
+</p>
 
-# NestjsJsonApi
+## Description
 
-This project was generated using [Nx](https://nx.dev).
+<p>
+This is the plugin that works upon TypeOrm library as a main database abstraction layer tool. Module automaticly generates API according to JSON API specificaton from the database structure (TypeORM entities). It support such features as requests validation based on database fields types, request filtering, endpoints exdending, data relations control and much more. Our module significantly reduces the development time of REST services by removing the need to negotiate the mechanism of client-server interaction and implementing automatic API generation without the need to write any code.
+</p>
 
-<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="450"></p>
+## Installation
 
-🔎 **Smart, Fast and Extensible Build System**
+```bash
+$ npm install
+$ npm run typeorm:run
+$ npm run seed:run
+```
 
-## Quick Start & Documentation
+## Running the example app
 
-[Nx Documentation](https://nx.dev/getting-started/intro)
+```bash
+# build plugin
+$ npm run json-api-nestjs:build
 
-[Mental model is a good starting point for those who like to understand things theoretically first.](https://nx.dev/concepts/mental-model)
+# dev server
+$ npm run example:serve
 
-[Interactive Tutorial](https://nx.dev/getting-started/angular-tutorial)
+```
 
-## Adding capabilities to your workspace
+## Test
 
-Nx supports many plugins which add capabilities for developing different types of applications and different tools.
+```bash
+# unit tests
+$ nx test json-api-nestjs
 
-These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well.
+# test coverage
+$ nx test json-api-nestjs --coverage
+```
 
-Below are our core plugins:
+## License
 
-- [Angular](https://angular.io)
-  - `ng add @nrwl/angular`
-- [React](https://reactjs.org)
-  - `ng add @nrwl/react`
-- Web (no framework frontends)
-  - `ng add @nrwl/web`
-- [Nest](https://nestjs.com)
-  - `ng add @nrwl/nest`
-- [Express](https://expressjs.com)
-  - `ng add @nrwl/express`
-- [Node](https://nodejs.org)
-  - `ng add @nrwl/node`
-
-There are also many [community plugins](https://nx.dev/community) you could add.
-
-## Generate an application
-
-Run `ng g @nrwl/angular:app my-app` to generate an application.
-
-> You can use any of the plugins above to generate applications as well.
-
-When using Nx, you can create multiple applications and libraries in the same workspace.
-
-## Generate a library
-
-Run `ng g @nrwl/angular:lib my-lib` to generate a library.
-
-> You can also use any of the plugins above to generate libraries as well.
-
-Libraries are shareable across libraries and applications. They can be imported from `@nestjs-json-api/mylib`.
-
-## Development server
-
-Run `ng serve my-app` for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
-
-## Code scaffolding
-
-Run `ng g component my-component --project=my-app` to generate a new component.
-
-## Build
-
-Run `ng build my-app` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
-
-## Running unit tests
-
-Run `ng test my-app` to execute the unit tests via [Jest](https://jestjs.io).
-
-Run `nx affected:test` to execute the unit tests affected by a change.
-
-## Running end-to-end tests
-
-Run `ng e2e my-app` to execute the end-to-end tests via [Cypress](https://www.cypress.io).
-
-Run `nx affected:e2e` to execute the end-to-end tests affected by a change.
-
-## Understand your workspace
-
-Run `nx graph` to see a diagram of the dependencies of your projects.
-
-## Further help
-
-Visit the [Nx Documentation](https://nx.dev/angular) to learn more.
-
-
-
-
-
-
-## ☁ Nx Cloud
-
-### Distributed Computation Caching & Distributed Task Execution
-
-<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-cloud-card.png"></p>
-
-Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly.
-
-Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers.
-
-Visit [Nx Cloud](https://nx.app/) to learn more.
+The plugin is [MIT licensed](LICENSE).

apps/example/src/app/app.module.ts

@@ -1,4 +1,5 @@
 import { Module } from '@nestjs/common';
+import { LoggerModule } from 'nestjs-pino';
 
 import {DatabaseModule} from 'database';
 import {ResourcesModule} from './resources/resources.module';
@@ -7,7 +8,12 @@ import {ResourcesModule} from './resources/resources.module';
 @Module({
   imports: [
     DatabaseModule,
-    ResourcesModule
+    ResourcesModule,
+    LoggerModule.forRoot({
+      pinoHttp: {
+        level: 'debug'
+      }
+    })
   ],
   controllers: [],
   providers: [],

apps/example/src/app/resources/controllers/extend-user/extend-user.controller.ts

@@ -1,23 +1,25 @@
+import {Get, Param, Inject} from '@nestjs/common';
+
 import {Users} from 'database';
 import {JsonApi, excludeMethod, JsonBaseController, InjectService, JsonApiService, QueryParams} from 'json-api-nestjs';
-import {Get, Param} from '@nestjs/common';
+import {ExampleService} from '../../service/example/example.service';
 
 
 
 @JsonApi(Users, {
   allowMethod: excludeMethod(['deleteRelationship']),
   requiredSelectField: true
 })
-export class ExtendUserController extends JsonBaseController<Users>
-{
+export class ExtendUserController extends JsonBaseController<Users>{
   @InjectService() public service: JsonApiService<Users>;
+  @Inject(ExampleService) protected exampleService: ExampleService
 
   public override getAll(query: QueryParams<Users>){
     return this.service.getAll({query})
   }
 
   @Get(':id/example')
-  testOne(@Param('id') id) {
-    return id;
+  testOne(@Param('id') id: string): string {
+    return this.exampleService.testMethode(id);
   }
 }

apps/example/src/app/resources/resources.module.ts

@@ -3,19 +3,23 @@ import {JsonApiModule} from 'json-api-nestjs';
 import {Users, Addresses, Comments, Roles} from 'database';
 
 import {ExtendUserController} from './controllers/extend-user/extend-user.controller';
+import {ExampleService} from './service/example/example.service';
 
 @Module({
   imports: [
     JsonApiModule.forRoot({
       entities: [
         Users,
-        // Addresses,
-        // Comments,
-        // Roles
+        Addresses,
+        Comments,
+        Roles
       ],
       controllers: [
         ExtendUserController
       ],
+      providers: [
+        ExampleService
+      ],
       options: {
         debug: true,
         maxExecutionTime: 3000,

apps/example/src/app/resources/service/example/example.service.ts

@@ -0,0 +1,5 @@
+export class ExampleService{
+  testMethode(id: string): string {
+    return id;
+  }
+}

apps/example/src/main.ts

@@ -3,14 +3,19 @@
  * This is only a minimal backend to get started.
  */
 
-import {Logger, VersioningType} from '@nestjs/common';
-import { NestFactory } from '@nestjs/core';
-
-import { AppModule } from './app/app.module';
+import {VersioningType} from '@nestjs/common';
+import {NestFactory} from '@nestjs/core';
 import {DocumentBuilder, SwaggerModule} from '@nestjs/swagger';
+import {Logger} from 'nestjs-pino';
+
+import {AppModule} from './app/app.module';
+
 
 async function bootstrap() {
-  const app = await NestFactory.create(AppModule);
+  const app = await NestFactory.create(AppModule, {bufferLogs: true});
+  const ligerInst = app.get(Logger)
+  app.useLogger(ligerInst);
+  app.flushLogs();
   const globalPrefix = 'api';
   app.setGlobalPrefix(globalPrefix);
 
@@ -29,7 +34,7 @@ async function bootstrap() {
 
   const port = process.env.PORT || 3333;
   await app.listen(port);
-  Logger.log(
+  ligerInst.log(
     `🚀 Application is running on: http://localhost:${port}/${globalPrefix}`
   );
 }

libs/json-api-nestjs/src/index.ts

@@ -2,3 +2,4 @@ export * from './lib/json-api.module';
 export * from './lib/decorators';
 export { excludeMethod } from './lib/config/bindings'
 export * from './lib/types'
+export * from './lib/mixin/controller'