feat(crud-objection): update objection-crud related code to the lates…

…t upstream

integration/crud-objection/app.module.ts

@@ -3,13 +3,16 @@ import { CompaniesModule } from './companies/companies.module';
 import { ProjectsModule } from './projects/projects.module';
 import { UsersModule } from './users/users.module';
 import { DatabaseModule } from './database.module';
+import { APP_GUARD } from '@nestjs/core';
+import { AuthGuard } from './auth.guard';
 
 @Module({
-  imports: [
-    DatabaseModule,
-    CompaniesModule,
-    ProjectsModule,
-    UsersModule,
+  imports: [DatabaseModule, CompaniesModule, ProjectsModule, UsersModule],
+  providers: [
+    {
+      provide: APP_GUARD,
+      useClass: AuthGuard,
+    },
   ],
 })
 export class AppModule {}

integration/crud-objection/auth.guard.ts

@@ -0,0 +1,16 @@
+import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
+
+import { UsersService } from './users';
+import { USER_REQUEST_KEY } from './constants';
+
+@Injectable()
+export class AuthGuard implements CanActivate {
+  constructor(private usersService: UsersService) {}
+
+  async canActivate(ctx: ExecutionContext): Promise<boolean> {
+    const req = ctx.switchToHttp().getRequest();
+    req[USER_REQUEST_KEY] = await this.usersService.modelClass.query().findById(1);
+
+    return true;
+  }
+}

integration/crud-objection/base.model.ts

@@ -6,11 +6,11 @@ export class BaseModel extends Model {
   createdAt: Date;
   updatedAt: Date;
 
-  $beforeInsert() {
-    this.createdAt = new Date();
-  }
-
   $beforeUpdate() {
     this.updatedAt = new Date();
   }
+
+  $beforeInsert() {
+    this.createdAt = new Date();
+  }
 }

integration/crud-objection/companies/companies.controller.ts

@@ -1,22 +1,47 @@
 import { Controller } from '@nestjs/common';
-import { ApiUseTags } from '@nestjs/swagger';
+import { ApiTags } from '@nestjs/swagger';
 import { Crud } from '@nestjsx/crud';
 
 import { Company } from './company.model';
 import { CompaniesService } from './companies.service';
+import { serialize } from './responses';
 
 @Crud({
   model: {
     type: Company,
   },
+  serialize,
+  routes: {
+    deleteOneBase: {
+      returnDeleted: false,
+    },
+  },
   query: {
+    alwaysPaginate: false,
+    allow: ['name'],
     join: {
-      users: {},
-      projects: {},
+      users: {
+        alias: 'companyUsers',
+        exclude: ['email'],
+        eager: true,
+      },
+      'users.projects': {
+        eager: true,
+        alias: 'usersProjects',
+        allow: ['name'],
+      },
+      'users.projects.company': {
+        eager: true,
+        alias: 'usersProjectsCompany',
+      },
+      projects: {
+        eager: true,
+        select: false,
+      },
     },
   },
 })
-@ApiUseTags('companies')
+@ApiTags('companies')
 @Controller('companies')
 export class CompaniesController {
   constructor(public service: CompaniesService) {}

integration/crud-objection/companies/company.model.ts

@@ -43,16 +43,16 @@ export class Company extends BaseModel {
       modelClass: path.resolve(__dirname, '../users/user.model'),
       join: {
         from: 'companies.id',
-        to: 'users.companyId'
-      }
+        to: 'users.companyId',
+      },
     },
     projects: {
       relation: Model.HasManyRelation,
       modelClass: path.resolve(__dirname, '../projects/project.model'),
       join: {
         from: 'companies.id',
-        to: 'projects.companyId'
-      }
-    }
-  }
+        to: 'projects.companyId',
+      },
+    },
+  };
 }

integration/crud-objection/companies/requests/create-company.dto.ts

@@ -0,0 +1,19 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString, MaxLength } from 'class-validator';
+
+export class CreateCompanyDto {
+  @ApiProperty({ type: 'string' })
+  @IsString()
+  @MaxLength(100)
+  name: string;
+
+  @ApiProperty({ type: 'string' })
+  @IsString()
+  @MaxLength(100)
+  domain: string;
+
+  @ApiProperty({ type: 'string' })
+  @IsString()
+  @MaxLength(100)
+  description: string;
+}

integration/crud-objection/companies/requests/index.ts

@@ -0,0 +1,5 @@
+import { CreateCompanyDto } from './create-company.dto';
+
+export const dto = {
+  create: CreateCompanyDto,
+};

integration/crud-objection/companies/responses/get-company-response.dto.ts

@@ -0,0 +1,22 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Exclude } from 'class-transformer';
+
+export class GetCompanyResponseDto {
+  @ApiProperty({ type: 'number' })
+  id: string;
+
+  @ApiProperty({ type: 'string' })
+  name: string;
+
+  @ApiProperty({ type: 'string' })
+  domain: string;
+
+  @ApiProperty({ type: 'string' })
+  description: string;
+
+  @Exclude()
+  createdAt: any;
+
+  @Exclude()
+  updatedAt: any;
+}

integration/crud-objection/companies/responses/index.ts

@@ -0,0 +1,6 @@
+import { SerializeOptions } from '@nestjsx/crud';
+import { GetCompanyResponseDto } from './get-company-response.dto';
+
+export const serialize: SerializeOptions = {
+  get: GetCompanyResponseDto,
+};

integration/crud-objection/constants.ts

@@ -0,0 +1 @@
+export const USER_REQUEST_KEY = 'user';

integration/crud-objection/database.module.ts

@@ -2,18 +2,30 @@ import { Global, Module } from '@nestjs/common';
 import * as Knex from 'knex';
 import { knexSnakeCaseMappers, Model } from 'objection';
 import { UserProfile } from './users-profiles';
-import { Project } from './projects';
+import { Project, UserProject } from './projects';
 import { Company } from './companies';
 import { User } from './users';
 import { KNEX_CONNECTION } from './injection-tokens';
-import { UserProject } from './users-projects';
+import { Device } from './devices';
+import { License, UserLicense } from './users-licenses';
+import { Note } from './notes';
 
-const models = [User, Company, Project, UserProfile, UserProject];
+const models = [
+  User,
+  Company,
+  Project,
+  UserProfile,
+  UserProject,
+  Device,
+  License,
+  UserLicense,
+  Note,
+];
 
-const modelProviders = models.map(model => {
+const modelProviders = models.map((model) => {
   return {
     provide: model.name,
-    useValue: model
+    useValue: model,
   };
 });
 
@@ -26,18 +38,18 @@ const providers = [
         client: 'pg',
         connection: 'postgres://root:root@127.0.0.1:5455/nestjsx_crud_objection',
         debug: process.env.KNEX_DEBUG === 'true',
-        ...knexSnakeCaseMappers()
+        ...knexSnakeCaseMappers(),
       });
 
       Model.knex(knex);
       return knex;
-    }
-  }
+    },
+  },
 ];
 
 @Global()
 @Module({
   providers: [...providers],
-  exports: [...providers]
+  exports: [...providers],
 })
 export class DatabaseModule {}

integration/crud-objection/devices/device.model.ts

@@ -0,0 +1,18 @@
+import { IsOptional, IsString, IsUUID } from 'class-validator';
+import { Model } from 'objection';
+
+export class Device extends Model {
+  static readonly tableName = 'devices';
+
+  static get idColumn() {
+    return ['deviceKey'];
+  }
+
+  @IsOptional({ always: true })
+  @IsUUID('4', { always: true })
+  deviceKey: string;
+
+  @IsOptional({ always: true })
+  @IsString({ always: true })
+  description?: string;
+}

integration/crud-objection/devices/devices.controller.ts

@@ -0,0 +1,29 @@
+import { Controller } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
+import { Crud } from '@nestjsx/crud';
+
+import { DevicesService } from './devices.service';
+import { serialize } from './response';
+import { Device } from './device.model';
+
+@Crud({
+  model: { type: Device },
+  serialize,
+  params: {
+    deviceKey: {
+      field: 'deviceKey',
+      type: 'uuid',
+      primary: true,
+    },
+  },
+  routes: {
+    deleteOneBase: {
+      returnDeleted: true,
+    },
+  },
+})
+@ApiTags('devices')
+@Controller('/devices')
+export class DevicesController {
+  constructor(public service: DevicesService) {}
+}

integration/crud-objection/devices/devices.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+
+import { DevicesService } from './devices.service';
+import { DevicesController } from './devices.controller';
+
+@Module({
+  providers: [DevicesService],
+  exports: [DevicesService],
+  controllers: [DevicesController],
+})
+export class DevicesModule {}

integration/crud-objection/devices/devices.service.ts

@@ -0,0 +1,12 @@
+import { Inject, Injectable } from '@nestjs/common';
+
+import { Device } from './device.model';
+import { ObjectionCrudService } from '@nestjsx/crud-objection';
+import { ModelClass } from 'objection';
+
+@Injectable()
+export class DevicesService extends ObjectionCrudService<Device> {
+  constructor(@Inject('Device') modelClass: ModelClass<Device>) {
+    super(modelClass);
+  }
+}

integration/crud-objection/devices/index.ts

@@ -0,0 +1,2 @@
+export * from './device.model';
+export * from './devices.service';

integration/crud-objection/devices/response/delete-device-response.dto.ts

@@ -0,0 +1,10 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Exclude } from 'class-transformer';
+
+export class DeleteDeviceResponseDto {
+  @ApiProperty({ type: 'string' })
+  deviceKey: string;
+
+  @Exclude()
+  description?: string;
+}

integration/crud-objection/devices/response/index.ts

@@ -0,0 +1,6 @@
+import { SerializeOptions } from '@nestjsx/crud';
+import { DeleteDeviceResponseDto } from './delete-device-response.dto';
+
+export const serialize: SerializeOptions = {
+  delete: DeleteDeviceResponseDto,
+};

integration/crud-objection/knexfile.js

@@ -7,10 +7,12 @@ module.exports = {
   migrations: {
     directory: './migrations',
     stub: './migration.stub',
+    extension: 'ts',
   },
   seeds: {
     directory: './seeds',
-    stub: './seed.stub'
+    stub: './seed.stub',
+    extension: 'ts',
   },
-  ...knexSnakeCaseMappers()
+  ...knexSnakeCaseMappers(),
 };

integration/crud-objection/main.ts

@@ -1,9 +1,22 @@
 import { NestFactory } from '@nestjs/core';
 import { ValidationPipe } from '@nestjs/common';
-import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
+import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
+import { CrudConfigService } from '@nestjsx/crud';
+import { USER_REQUEST_KEY } from './constants';
 import { HttpExceptionFilter } from '../shared/https-exception.filter';
 import { AppModule } from './app.module';
 
+// Important: load config before (!!!) you import AppModule
+// https://github.com/nestjsx/crud/wiki/Controllers#global-options
+CrudConfigService.load({
+  auth: {
+    property: USER_REQUEST_KEY,
+  },
+  routes: {
+    // exclude: ['createManyBase'],
+  },
+});
+
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
 

integration/crud-objection/migrations/20190609144759_CreateUsers.ts

@@ -10,6 +10,8 @@ export async function up(knex: Knex) {
       .notNullable()
       .unique();
 
+    t.jsonb('name').nullable();
+
     t.boolean('is_active')
       .notNullable()
       .defaultTo(true);

integration/crud-objection/migrations/20190609144779_CreateUsersProjects.ts

@@ -18,6 +18,8 @@ export async function up(knex: Knex) {
       .inTable('projects')
       .onDelete('CASCADE');
 
+    t.text('review').nullable();
+
     t.unique(['user_id', 'project_id']);
 
     t.timestamps();