String type for id (#6)

* fix(json-api-nestjs): fix name for type

* fix(json-api-nestjs): allow id as string

Closes #5

* docs(json-api-nestjs): change readme

* feat(json-api-nestjs): add import options

Co-authored-by: Alexander Kharkovey <[email protected]>

Author: klerick

.github/workflows/Release.yml

@@ -31,18 +31,18 @@ jobs:
       - name: Test
         run: |
           npx nx run-many --target=test --all --code-coverage --coverage --reporters=default --reporters=default --coverageReporters=cobertura,html,json
-          SUMMARY=$(node ./tools/utils/merge-codecoverage/index.js | grep "All files" | awk '{print $4}')
-          echo "COVERAGE=$(echo ${SUMMARY})" >> $GITHUB_ENV
-      - name: Cretae Badge
-        uses: schneegans/[email protected]
-        with:
-          auth: ${{ secrets.GIST_SECRET }}
-          gistID: ${{ secrets.GIST_ID }}
-          filename: coverage-json-api.json
-          label: Test Coverage
-          message: ${{ env.COVERAGE }}
-          color: green
-          namedLogo: jest
+#          SUMMARY=$(node ./tools/utils/merge-codecoverage/index.js | grep "All files" | awk '{print $4}')
+#          echo "COVERAGE=$(echo ${SUMMARY})" >> $GITHUB_ENV
+#      - name: Cretae Badge
+#        uses: schneegans/[email protected]
+#        with:
+#          auth: ${{ secrets.GIST_SECRET }}
+#          gistID: ${{ secrets.GIST_ID }}
+#          filename: coverage-json-api.json
+#          label: Test Coverage
+#          message: ${{ env.COVERAGE }}
+#          color: green
+#          namedLogo: jest
       - name: Deploy
         run: npx nx affected --target=deploy --base=$BEFORE_SHA
 

README.md

@@ -7,20 +7,17 @@
 </p>
 
 <p align="center">
-  Json API plugin for 
+  Json API plugins 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>
 
-## Description
-
-<p>
-This plugin works upon TypeOrm library, which is used as the main database abstraction layer tool. The module automatically generates an API according to JSON API specification from the database structure (TypeORM entities). It supports features such as requests validation based on database fields types, request filtering, endpoints extending, 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>
-
+- *[json-api-nestjs](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-api-nestjs)* - plugin for create CRUD overs JSON API
+- *json-api-nestjs-sdk* - tool for client, call api over *json-api-nestjs*(coming soon...)
+- *kson-api-nestjs-acl* - tool for acl over *json-api-nestjs*(coming soon...)
 ## Installation
 
 ```bash

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

@@ -0,0 +1,8 @@
+import { ParseUUIDPipe } from '@nestjs/common';
+import { BookList } from 'database';
+import { JsonApi } from 'json-api-nestjs';
+
+@JsonApi(BookList, {
+  pipeForId: ParseUUIDPipe,
+})
+export class ExtendBookListController {}

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

@@ -1,5 +1,5 @@
 import { Get, Param, Inject } from '@nestjs/common';
-
+import { HttpService } from '@nestjs/axios';
 import { Users } from 'database';
 import {
   JsonApi,
@@ -10,6 +10,7 @@ import {
   QueryParams,
 } from 'json-api-nestjs';
 import { ExampleService } from '../../service/example/example.service';
+import { map } from 'rxjs';
 
 @JsonApi(Users, {
   allowMethod: excludeMethod(['deleteRelationship']),
@@ -18,6 +19,7 @@ import { ExampleService } from '../../service/example/example.service';
 export class ExtendUserController extends JsonBaseController<Users> {
   @InjectService() public service: JsonApiService<Users>;
   @Inject(ExampleService) protected exampleService: ExampleService;
+  @Inject(HttpService) protected httpService: HttpService;
 
   public override getAll(query: QueryParams<Users>) {
     return this.service.getAll({ query });
@@ -27,4 +29,11 @@ export class ExtendUserController extends JsonBaseController<Users> {
   testOne(@Param('id') id: string): string {
     return this.exampleService.testMethode(id);
   }
+
+  @Get('test-http')
+  testHttp() {
+    return this.httpService
+      .get('http://localhost:3333/api/v1/book-list')
+      .pipe(map((r) => r.data));
+  }
 }

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

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

libs/database/src/lib/config.ts

@@ -1,11 +1,11 @@
 import { TypeOrmModuleOptions } from '@nestjs/typeorm';
 
 import { config as ormConfig } from './config-cli';
-import { Roles, Comments, Users, Addresses } from './entities';
+import { Roles, Comments, Users, Addresses, BookList } from './entities';
 
 export const config: TypeOrmModuleOptions = {
   ...ormConfig,
   ...{
-    entities: [Roles, Comments, Users, Addresses],
+    entities: [Roles, Comments, Users, Addresses, BookList],
   },
 };

libs/database/src/lib/entities/book-list.ts

@@ -0,0 +1,38 @@
+import {
+  Column,
+  Entity,
+  PrimaryGeneratedColumn,
+  UpdateDateColumn,
+} from 'typeorm';
+import { IsEmpty, IsNotEmpty } from 'class-validator';
+
+@Entity('book_list')
+export class BookList {
+  @PrimaryGeneratedColumn()
+  public id: string;
+
+  @IsNotEmpty()
+  @Column({
+    type: 'text',
+    nullable: false,
+  })
+  public text: string;
+
+  @IsEmpty()
+  @Column({
+    name: 'created_at',
+    type: 'timestamp',
+    nullable: true,
+    default: 'CURRENT_TIMESTAMP',
+  })
+  public createdAt: Date;
+
+  @IsEmpty()
+  @UpdateDateColumn({
+    name: 'updated_at',
+    type: 'timestamp',
+    nullable: true,
+    default: 'CURRENT_TIMESTAMP',
+  })
+  public updatedAt: Date;
+}

libs/database/src/lib/entities/index.ts

@@ -3,3 +3,4 @@ export * from './roles';
 export * from './users';
 export * from './comments';
 export * from './users-have-roles';
+export * from './book-list';

libs/database/src/lib/migrations/1665469071344-CreateBookTable.ts

@@ -0,0 +1,52 @@
+import {
+  MigrationInterface,
+  QueryRunner,
+  Table,
+  TableColumn,
+  TableForeignKey,
+} from 'typeorm';
+
+export class CreateCommentsTable1665469071344 implements MigrationInterface {
+  protected readonly tableName = 'book_list';
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+        CREATE EXTENSION IF NOT EXISTS "uuid-ossp"
+    `);
+    await queryRunner.createTable(
+      new Table({
+        name: this.tableName,
+        columns: [
+          new TableColumn({
+            name: 'id',
+            type: 'uuid',
+            isGenerated: true,
+            isPrimary: true,
+            unsigned: true,
+            generationStrategy: 'uuid',
+          }),
+          new TableColumn({
+            name: 'text',
+            type: 'text',
+            isNullable: false,
+          }),
+          new TableColumn({
+            name: 'created_at',
+            type: 'timestamp',
+            isNullable: true,
+            default: 'CURRENT_TIMESTAMP',
+          }),
+          new TableColumn({
+            name: 'updated_at',
+            type: 'timestamp',
+            isNullable: true,
+            default: 'CURRENT_TIMESTAMP',
+          }),
+        ],
+      })
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.dropTable(this.tableName);
+  }
+}

libs/json-api-nestjs/README.md

@@ -1,6 +1,7 @@
-****strong text****
 # json-api-nestjs
 
+This plugin works upon TypeOrm library, which is used as the main database abstraction layer tool. The module automatically generates an API according to JSON API specification from the database structure (TypeORM entities). It supports features such as requests validation based on database fields types, request filtering, endpoints extending, 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.
+
 ## Installation
 
 ```bash  
@@ -47,9 +48,11 @@ export interface ModuleOptions {
     controllers?: NestController[];  // List of controller, if you need extend default present
     connectionName?: string; // Type orm connection name: "default" is default name  
     providers?: NestProvider[]; // List of addition provider for useing in custom controller
+    imports?: NestImport[]; // List of addition module for useing in custom controller
     options?: {  
 	  requiredSelectField?: boolean; // Need list of select field in get endpoint, try is default
 	  debug?: boolean; // Debug info in result object
+    pipeForId?: Type<PipeTransform> // Nestjs pipe for validate id params, by default ParseIntPipe
 	};  
 }
 ```