feat(json-api-nestjs-sdk): new version sdk

BREAKING CHANGE: change param for getOne method

Author: Alexander Kharkovey

README.md

@@ -16,8 +16,8 @@
 </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...)
+- *[json-api-nestjs-sdk](https://github.com/klerick/nestjs-json-api/tree/master/libs/json-api-nestjs-sdk)* - tool for client, call api over *json-api-nestjs*
+- *json-api-nestjs-acl* - tool for acl over *json-api-nestjs*(coming soon...)
 ## Installation
 
 ```bash

apps/example-angular-client/project.json

@@ -6,9 +6,15 @@
   "prefix": "nestjs-json-api",
   "targets": {
     "build": {
-      "executor": "@angular-devkit/build-angular:browser",
+      "executor": "@angular-builders/custom-webpack:browser",
       "outputs": ["{options.outputPath}"],
       "options": {
+        "customWebpackConfig": {
+          "path": "apps/example-angular-client/webpack.config.ts",
+          "mergeRules": {
+            "externals": "replace"
+          }
+        },
         "outputPath": "dist/apps/example-angular-client",
         "index": "apps/example-angular-client/src/index.html",
         "main": "apps/example-angular-client/src/main.ts",
@@ -55,7 +61,7 @@
       "defaultConfiguration": "production"
     },
     "serve": {
-      "executor": "@angular-devkit/build-angular:dev-server",
+      "executor": "@angular-builders/custom-webpack:dev-server",
       "configurations": {
         "production": {
           "browserTarget": "example-angular-client:build:production"

apps/example-angular-client/src/app/app.component.html

@@ -1 +1,6 @@
-<nestjs-json-api-nx-welcome></nestjs-json-api-nx-welcome>
+<div>
+  <pre>{{dataItem | async | json}}</pre>
+</div>
+<div>
+  <pre>{{dataList | async | json}}</pre>
+</div>

apps/example-angular-client/src/app/app.component.ts

@@ -1,10 +1,113 @@
-import { Component } from '@angular/core';
+import { ChangeDetectionStrategy, Component, OnInit } from '@angular/core';
+import { JsonApiSdkService, EmptyArrayRelation } from 'json-api-nestjs-sdk';
+import { Users, BookList, Addresses } from 'database/entity';
+import { map, switchMap } from 'rxjs';
+
+const user = new Users();
+user.id = 17;
 
 @Component({
   selector: 'nestjs-json-api-root',
   templateUrl: './app.component.html',
   styleUrls: ['./app.component.css'],
+  changeDetection: ChangeDetectionStrategy.OnPush,
 })
-export class AppComponent {
+export class AppComponent implements OnInit {
   title = 'example-angular-client';
+  dataList = this.jsonApiSdkService.getAll<Users>(
+    Users,
+    {
+      filter: {
+        target: {
+          isActive: {
+            eq: 'true',
+          },
+        },
+      },
+      include: ['comments', 'addresses'],
+      page: {
+        size: 5,
+        number: 1,
+      },
+    },
+    true
+  );
+  dataItem = this.jsonApiSdkService.getOne<Users>(
+    Users,
+    17,
+    {
+      fields: {
+        target: ['login'],
+        addresses: ['city', 'state'],
+        comments: ['text', 'kind'],
+      },
+      include: ['comments', 'addresses'],
+    },
+    true
+  );
+
+  constructor(private jsonApiSdkService: JsonApiSdkService) {}
+
+  ngOnInit(): void {
+    this.jsonApiSdkService
+      .getOne<Users>(
+        Users,
+        17,
+        {
+          fields: {
+            target: ['login'],
+            addresses: ['city', 'state'],
+            comments: ['text', 'kind'],
+          },
+          include: ['comments', 'addresses'],
+        },
+        true
+      )
+      .pipe(
+        switchMap(({ entity, meta }) => {
+          const bookList = new BookList();
+          bookList.users = [entity];
+          bookList.text = 'Book list';
+          return this.jsonApiSdkService.postOne<BookList>(bookList, true);
+        }),
+        switchMap(({ entity, meta }) => {
+          const bookList = new BookList();
+          bookList.id = entity.id;
+          bookList.users = new EmptyArrayRelation();
+          bookList.text = 'Change Text';
+          return this.jsonApiSdkService.patchOne(bookList, true);
+        }),
+        switchMap(({ entity, meta }) => {
+          return this.jsonApiSdkService.deleteOne(entity);
+        })
+      )
+      .subscribe((r) => console.log(r));
+
+    this.jsonApiSdkService
+      .getRelationships(user, 'addresses')
+      .subscribe((r) => console.log(r));
+    this.jsonApiSdkService
+      .getRelationships(user, 'comments')
+      .subscribe((r) => console.log(r));
+
+    this.jsonApiSdkService
+      .getAll<Addresses>(Addresses)
+      .pipe(
+        map((r) => r[0]),
+        switchMap((addresses) => {
+          return this.jsonApiSdkService
+            .getOne<Users>(Users, 18, { include: ['comments', 'addresses'] })
+            .pipe(
+              switchMap((user) => {
+                user.addresses = addresses;
+                return this.jsonApiSdkService.patchRelationships<Users>(
+                  user,
+                  'addresses'
+                );
+              })
+            );
+        })
+      )
+      .subscribe((r) => console.log(r));
+  }
 }

apps/example-angular-client/src/app/app.module.ts

@@ -1,12 +1,25 @@
 import { NgModule } from '@angular/core';
+import { CommonModule } from '@angular/common';
 import { BrowserModule } from '@angular/platform-browser';
+import { JsonApiNestjsSdkModule } from 'json-api-nestjs-sdk';
+import { BookList, Users, Roles, Comments, Addresses } from 'database/entity';
 
 import { AppComponent } from './app.component';
 import { NxWelcomeComponent } from './nx-welcome.component';
 
 @NgModule({
   declarations: [AppComponent, NxWelcomeComponent],
-  imports: [BrowserModule],
+  imports: [
+    CommonModule,
+    BrowserModule,
+    JsonApiNestjsSdkModule.forRoot(
+      {
+        apiPrefix: '/api/v1',
+        apiHost: window.location.origin,
+      },
+      { BookList, Users, Roles, Comments, Addresses }
+    ),
+  ],
   providers: [],
   bootstrap: [AppComponent],
 })

apps/example-angular-client/webpack.config.ts

@@ -0,0 +1,17 @@
+import { Configuration } from 'webpack';
+import { CustomWebpackBrowserSchema, TargetOptions } from '@angular-builders/custom-webpack';
+import {resolve} from 'path';
+
+export default function webPackConfig(
+  config: Configuration,
+  options: CustomWebpackBrowserSchema,
+  targetOptions: TargetOptions): Configuration {
+
+  (config.resolve || {}).alias = {
+    typeorm: resolve(__dirname, "../../node_modules/typeorm/typeorm-model-shim"),
+    validator: resolve(__dirname, "../../node_modules/validator/es")
+  }
+
+  return config;
+}
+

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

@@ -14,7 +14,7 @@ import { map } from 'rxjs';
 
 @JsonApi(Users, {
   allowMethod: excludeMethod(['deleteRelationship']),
-  requiredSelectField: true,
+  requiredSelectField: false,
 })
 export class ExtendUserController extends JsonBaseController<Users> {
   @InjectService() public service: JsonApiService<Users>;

libs/database/src/entity.ts

@@ -0,0 +1 @@
+export * from './lib/entities';

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

@@ -14,7 +14,7 @@ export type IAddresses = Addresses;
 @Entity('addresses')
 export class Addresses {
   @PrimaryGeneratedColumn()
-  public id: number;
+  public id!: number;
 
   @IsOptional()
   @Length(3, 70)
@@ -24,7 +24,7 @@ export class Addresses {
     nullable: true,
     default: 'NULL',
   })
-  public city: string;
+  public city!: string;
 
   @IsOptional()
   @Length(3, 70)
@@ -34,7 +34,7 @@ export class Addresses {
     nullable: true,
     default: 'NULL',
   })
-  public state: string;
+  public state!: string;
 
   @IsOptional()
   @Length(3, 68)
@@ -44,7 +44,7 @@ export class Addresses {
     nullable: true,
     default: 'NULL',
   })
-  public country: string;
+  public country!: string;
 
   @IsEmpty()
   @Column({
@@ -53,7 +53,7 @@ export class Addresses {
     nullable: true,
     default: 'CURRENT_TIMESTAMP',
   })
-  public createdAt: Date;
+  public createdAt!: Date;
 
   @IsEmpty()
   @UpdateDateColumn({
@@ -62,8 +62,8 @@ export class Addresses {
     nullable: true,
     default: 'CURRENT_TIMESTAMP',
   })
-  public updatedAt: Date;
+  public updatedAt!: Date;
 
   @OneToOne(() => Users, (item) => item.addresses)
-  public user: IUsers;
+  public user!: IUsers;
 }

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

@@ -1,22 +1,26 @@
 import {
   Column,
   Entity,
+  ManyToMany,
   PrimaryGeneratedColumn,
   UpdateDateColumn,
 } from 'typeorm';
 import { IsEmpty, IsNotEmpty } from 'class-validator';
+import { IUsers, Users } from './users';
+
+export type IBookList = BookList;
 
 @Entity('book_list')
 export class BookList {
   @PrimaryGeneratedColumn()
-  public id: string;
+  public id!: string;
 
   @IsNotEmpty()
   @Column({
     type: 'text',
     nullable: false,
   })
-  public text: string;
+  public text!: string;
 
   @IsEmpty()
   @Column({
@@ -25,7 +29,7 @@ export class BookList {
     nullable: true,
     default: 'CURRENT_TIMESTAMP',
   })
-  public createdAt: Date;
+  public createdAt!: Date;
 
   @IsEmpty()
   @UpdateDateColumn({
@@ -34,5 +38,8 @@ export class BookList {
     nullable: true,
     default: 'CURRENT_TIMESTAMP',
   })
-  public updatedAt: Date;
+  public updatedAt!: Date;
+
+  @ManyToMany(() => Users, (item) => item.books)
+  public users!: IUsers[];
 }