nest-knexjs 0.0.3 → 0.0.7

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,31 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: javascript
+
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Tony133
+Copyright (c) 2021-2022 Tony133
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -51,6 +51,7 @@ or
 - [Usage](#usage)
   - [KnexModule](#knexmodule)
   - [ExampleOfUse](#example-of-use)
+  - [MultiConnectionsDatabae](#multi-connections-database)
   - [CreateMigrations](#create-migrations)
   - [RunMigrations](#run-migrations)
   - [CreateSeeds](#create-seeds) 
@@ -108,12 +109,12 @@ UsersService:
 
 ```typescript
 import { Injectable } from '@nestjs/common';
-import Knex from 'knex';
-import { InjectModel } from 'nest-knexjs';
+import { Knex } from 'knex';
+import { InjectConnection } from 'nest-knexjs';
 
 @Injectable()
 export class UsersService {
-  constructor(@InjectModel() private readonly knex: Knex) {}
+  constructor(@InjectConnection() private readonly knex: Knex) {}
 
   async findAll() {
     const users = await this.knex.table('users');
@@ -139,6 +140,175 @@ export class UsersController {
 }
 ```
 
+## Multi Connections Database
+
+```typescript
+@Module({
+  imports: [
+    KnexModule.forRootAsync(
+      {
+        useFactory: () => ({
+          config: {
+            client: 'mysql',
+            version: '5.7',
+            useNullAsDefault: true,
+            connection: {
+              host: '127.0.0.1',
+              user: 'root',
+              port: 3306,
+              password: 'root',
+              database: 'test1',
+            },
+            pool: {
+              min: 2,
+              max: 10,
+            },
+          },
+        }),
+      },
+      'db1Connection',
+    ),
+    KnexModule.forRootAsync(
+      {
+        useFactory: () => ({
+          config: {
+            client: 'mysql',
+            version: '5.7',
+            useNullAsDefault: true,
+            connection: {
+              host: '127.0.0.1',
+              user: 'root',
+              port: 3307,
+              password: 'root',
+              database: 'test2',
+            },
+            pool: {
+              min: 2,
+              max: 10,
+            },
+          },
+        }),
+      },
+      'db2Connection',
+    ),
+  ],
+  controllers: [],
+  providers: [],
+})
+export class AppModule {}
+```
+
+Usage example with Multi Connection
+
+PostService:
+
+```typescript
+@Injectable()
+export class PostService {
+  constructor(
+    @InjectConnection('db2Connection')
+    private knexConnection: Knex,
+  ) {}
+
+  async create(createPostDto: CreatePostDto) {
+    try {
+      const post = await this.knexConnection.table('posts').insert({
+        title: createPostDto.title,
+        description: createPostDto.description,
+      });
+
+      return post;
+    } catch (err) {
+      throw new HttpException(err, HttpStatus.BAD_REQUEST);
+    }
+  }
+
+  async findAll() {
+    console.log(this.knexConnection);
+    const posts = await this.knexConnection.table('posts');
+    return { posts };
+  }
+}
+```
+
+UsersService:
+
+```typescript
+@Injectable()
+export class UsersService {
+  constructor(
+    @InjectConnection('db1Connection')
+    private knexConnection: Knex,
+  ) {}
+
+  async findAll() {
+    const users = await this.knexConnection.table('users');
+    return { users };
+  }
+
+  async create(createUserDto: CreateUserDto) {
+    try {
+      const users = await this.knexConnection.table('users').insert({
+        firstName: createUserDto.firstName,
+        lastName: createUserDto.lastName,
+      });
+
+      return { users };
+    } catch (err) {
+      throw new HttpException(err, HttpStatus.BAD_REQUEST);
+    }
+  }
+}
+```
+
+
+In `knexfile.js` update with your database configuration settings:
+
+```javascript
+module.exports = {
+  development: {
+    client: 'mysql',
+    version: '5.7',
+    connection: {
+      name: 'db1Connection',
+      host: '127.0.0.1',
+      user: 'root',
+      port: 3306,
+      password: 'root',
+      database: 'test1',
+    },
+    migrations: {
+      directory: './migrations/users',
+      tableName: '[:name_file_migrations_users]',
+    },
+  },
+  developmentTwo: {
+    client: 'mysql',
+    version: '5.7',
+    connection: {
+      name: 'db2Connection',
+      host: '127.0.0.1',
+      user: 'root',
+      port: 3307,
+      password: 'root',
+      database: 'test2',
+    },
+    migrations: {
+      directory: './migrations/posts',
+      tableName: '[:name_file_migrations_posts]',
+    },
+  },
+};
+```
+
+Run Migrations:
+
+```bash
+$ npx knex migrate:latest --env development
+
+$ npx knex migrate:latest --env developmentTwo
+```
+
 ## Create Migrations
 
 ```bash
@@ -153,8 +323,8 @@ exports.up = function(knex) {
   return knex.schema
     .createTable('users', function(table) {
       table.increments('id');
-      table.string('first_name', 255).notNullable();
-      table.string('last_name', 255).notNullable();
+      table.string('firstName', 255).notNullable();
+      table.string('lastName', 255).notNullable();
     })
     .createTable('products', function(table) {
       table.increments('id');
@@ -206,9 +376,9 @@ exports.seed = function (knex) {
     .del()
     .then(function () {
       return knex('users').insert([
-        { id: 1, first_name: 'firstname1', last_name: 'lastname1' },
-        { id: 2, first_name: 'firstname2', last_name: 'lastname2' },
-        { id: 3, first_name: 'firstname3', last_name: 'lastname3' },
+        { id: 1, firstName: 'firstName#1', lastName: 'lastName#1' },
+        { id: 2, firstName: 'firstName#2', lastName: 'lastName#2' },
+        { id: 3, firstName: 'firstName#3', lastName: 'lastName#3' },
       ]);
     });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nest-knexjs",
-  "version": "0.0.3",
+  "version": "0.0.7",
   "description": "Knexjs module for Nest framework (node.js) 😻",
   "author": "Tony133",
   "license": "MIT",
@@ -18,41 +18,41 @@
     "release": "release-it"
   },
   "devDependencies": {
-    "@commitlint/cli": "12.1.1",
-    "@commitlint/config-angular": "12.1.1",
-    "@nestjs/common": "7.6.15",
-    "@nestjs/core": "7.6.15",
-    "@nestjs/platform-express": "7.6.15",
-    "@nestjs/testing": "7.6.15",
-    "@types/express": "4.17.8",
-    "@types/jest": "26.0.23",
-    "@types/node": "14.14.44",
+    "@commitlint/cli": "16.0.2",
+    "@commitlint/config-angular": "16.0.0",
+    "@nestjs/common": "8.2.5",
+    "@nestjs/core": "8.2.5",
+    "@nestjs/platform-express": "8.2.5",
+    "@nestjs/testing": "8.2.5",
+    "@types/express": "4.17.13",
+    "@types/node": "16.11.19",
+    "@types/jest": "27.4.0",
     "@types/supertest": "2.0.11",
-    "@typescript-eslint/eslint-plugin": "4.22.1",
-    "@typescript-eslint/parser": "4.22.1",
-    "eslint": "7.26.0",
+    "@typescript-eslint/eslint-plugin": "5.9.1",
+    "@typescript-eslint/parser": "5.9.1",
+    "eslint": "8.7.0",
     "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-import": "2.22.1",
-    "knex": "0.95.4",
+    "eslint-plugin-import": "2.25.4",
+    "knex": "1.0.1",
     "mysql": "2.18.1",
-    "husky": "6.0.0",
-    "jest": "26.6.3",
-    "prettier": "2.2.1",
+    "husky": "7.0.4",
+    "prettier": "2.5.1",
+    "jest": "27.4.7",
     "reflect-metadata": "0.1.13",
-    "release-it": "14.6.1",
-    "supertest": "6.1.3",
-    "rxjs": "7.0.0",
-    "ts-node": "9.1.1",
-    "ts-jest": "26.5.6",
-    "tsconfig-paths": "3.9.0",
-    "typescript": "4.2.4"
+    "release-it": "14.12.3",
+    "supertest": "6.2.1",
+    "ts-node": "10.4.0",
+    "rxjs": "7.5.2",
+    "ts-jest": "27.1.3",
+    "tsconfig-paths": "3.12.0",
+    "typescript": "4.5.4"
   },
   "peerDependencies": {
-    "@nestjs/common": "^7.0.0",
-    "@nestjs/core": "^7.0.0",
+    "@nestjs/common": "^7.0.0 || ^8.0.0",
+    "@nestjs/core": "^7.0.0 || ^8.0.0",
     "reflect-metadata": "^0.1.13",
-    "rxjs": "^6.6.3 || ^7.0.0",
-    "knex": "^0.21.17 || ^0.95.0"
+    "rxjs": "^6.6.3 || ^7.2.0",
+    "knex": "^0.21.17 || ^0.95.0 || ^1.0.0"
   },
   "lint-staged": {
     "*.ts": [

package/tests/app-knex/app/users/dto/create-user.dto.ts

@@ -0,0 +1,4 @@
+export class CreateUserDto {
+  firstName: string;
+  lastName: string;
+}

package/tests/app-knex/app/users/dto/update-user.dto.ts

@@ -0,0 +1,4 @@
+export class UpdateUserDto {
+    firstName: string;  
+    lastName: string;
+}

package/tests/app-knex/app/users/entities/user.entity.ts

@@ -0,0 +1,5 @@
+export class User {
+  id: number;
+  firstName: string;
+  lastName: string;
+}

package/tests/{app → app-knex/app}/users/users.service.ts

@@ -4,8 +4,8 @@ import {
   Injectable,
   NotFoundException,
 } from '@nestjs/common';
-import * as Knex from 'knex';
-import { InjectModel } from '../../../lib';
+import { Knex } from 'knex';
+import { InjectModel } from '../../../../lib';
 import { CreateUserDto } from './dto/create-user.dto';
 import { UpdateUserDto } from './dto/update-user.dto';
 
@@ -14,15 +14,15 @@ export class UsersService {
   constructor(@InjectModel() private readonly knex: Knex) {}
 
   async findAll() {
-    const users = await this.knex.table('user_test');
+    const users = await this.knex.table('user');
     return { users };
   }
 
   async create(createUserDto: CreateUserDto) {
     try {
-      const users = await this.knex.table('user_test').insert({
-        first_name: createUserDto.first_name,
-        last_name: createUserDto.last_name,
+      const users = await this.knex.table('user').insert({
+        firstName: createUserDto.firstName,
+        lastName: createUserDto.lastName,
       });
 
       return { users };
@@ -33,17 +33,17 @@ export class UsersService {
 
   async findOne(id: number) {
     if (!id) {
-      throw new NotFoundException('Customer ID does not exist');
+      throw new NotFoundException('User ID does not exist');
     }
-    const users = await this.knex.table('user_test').where('id', id);
+    const users = await this.knex.table('user').where('id', id);
     return { users };
   }
 
   async update(id: number, updateUserDto: UpdateUserDto) {
     try {
-      const users = await this.knex.table('user_test').where('id', id).update({
-        first_name: updateUserDto.first_name,
-        last_name: updateUserDto.last_name,
+      const users = await this.knex.table('user').where('id', id).update({
+        firstName: updateUserDto.firstName,
+        lastName: updateUserDto.lastName,
       });
 
       return { users };
@@ -54,9 +54,9 @@ export class UsersService {
 
   async remove(id: number) {
     if (!id) {
-      throw new NotFoundException('Customer ID does not exist');
+      throw new NotFoundException('User ID does not exist');
     }
-    const users = await this.knex.table('user_test').where('id', id).del();
+    const users = await this.knex.table('user').where('id', id).del();
     return { users };
   }
 }

package/tests/{docker-compose.yml → app-knex/docker-compose.yml}

@@ -9,4 +9,4 @@ services:
        MYSQL_ROOT_PASSWORD: root
        MYSQL_DATABASE: test
      ports:
-       - "3306:3306"
+       - "3308:3306"

package/tests/{migrations → app-knex/migrations}/20210223224919_api.js

@@ -1,8 +1,8 @@
 exports.up = function (knex) {
   return knex.schema.createTable('user', function (table) {
     table.increments('id');
-    table.string('first_name', 255).notNullable();
-    table.string('last_name', 255).notNullable();
+    table.string('firstName', 255).notNullable();
+    table.string('lastName', 255).notNullable();
   });
 };
 

package/tests/{seeds → app-knex/seeds}/users.js

@@ -5,18 +5,18 @@ exports.seed = function (knex) {
       return knex('user').insert([
         {
           id: 1,
-          first_name: 'firstName #1',
-          last_name: 'lastName #1',
+          firstName: 'firstName #1',
+          lastName: 'lastName #1',
         },
         {
           id: 2,
-          first_name: 'firstName #1',
-          last_name: 'lastName #1',
+          firstName: 'firstName #2',
+          lastName: 'lastName #2',
         },
         {
           id: 3,
-          first_name: 'firstName #1',
-          last_name: 'lastName #1',
+          firstName: 'firstName #3',
+          lastName: 'lastName #3',
         },
       ]);
     });

package/tests/app-multi-database/app/app.module.ts

@@ -0,0 +1,61 @@
+import { Module } from '@nestjs/common';
+import { KnexModule } from '../../lib';
+import { PostModule } from './post/post.module';
+import { UsersModule } from './users/users.module';
+
+@Module({
+  imports: [
+    KnexModule.forRootAsync(
+      {
+        useFactory: () => ({
+          config: {
+            client: 'mysql',
+            version: '5.7',
+            useNullAsDefault: true,
+            connection: {
+              host: '127.0.0.1',
+              user: 'root',
+              port: 3306,
+              password: 'root',
+              database: 'test1',
+            },
+            pool: {
+              min: 2,
+              max: 10,
+            },
+          },
+        }),
+      },
+      'db1Connection',
+    ),
+    KnexModule.forRootAsync(
+      {
+        useFactory: () => ({
+          config: {
+            client: 'mysql',
+            version: '5.7',
+            useNullAsDefault: true,
+            connection: {
+              host: '127.0.0.1',
+              user: 'root',
+              port: 3307,
+              password: 'root',
+              database: 'test2',
+            },
+            pool: {
+              min: 2,
+              max: 10,
+            },
+          },
+        }),
+      },
+      'db2Connection',
+    ),
+
+    UsersModule,
+    PostModule,
+  ],
+  controllers: [],
+  providers: [],
+})
+export class AppModule {}

package/tests/app-multi-database/app/main.ts

@@ -0,0 +1,9 @@
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+
+  await app.listen(3000);
+}
+bootstrap();

package/tests/app-multi-database/app/post/dto/create-post.dto.ts

@@ -0,0 +1,4 @@
+export class CreatePostDto {
+  readonly title: string;
+  readonly description: string;
+}

package/tests/app-multi-database/app/post/dto/update-post.dto.ts

@@ -0,0 +1,4 @@
+export class UpdatePostDto {
+  readonly title: string;
+  readonly description: string;
+}

package/tests/app-multi-database/app/post/entities/post.entity.ts

@@ -0,0 +1,5 @@
+export class Post {
+  id: number;
+  title: string;
+  description: string;
+}

package/tests/app-multi-database/app/post/post.controller.ts

@@ -0,0 +1,42 @@
+import {
+  Controller,
+  Get,
+  Post,
+  Body,
+  Patch,
+  Param,
+  Delete,
+} from '@nestjs/common';
+import { PostService } from './post.service';
+import { CreatePostDto } from './dto/create-post.dto';
+import { UpdatePostDto } from './dto/update-post.dto';
+
+@Controller('posts')
+export class PostController {
+  constructor(private readonly postService: PostService) {}
+
+  @Post()
+  create(@Body() createPostDto: CreatePostDto) {
+    return this.postService.create(createPostDto);
+  }
+
+  @Get()
+  findAll() {
+    return this.postService.findAll();
+  }
+
+  @Get(':id')
+  findOne(@Param('id') id: string) {
+    return this.postService.findOne(+id);
+  }
+
+  @Patch(':id')
+  update(@Param('id') id: string, @Body() updatePostDto: UpdatePostDto) {
+    return this.postService.update(+id, updatePostDto);
+  }
+
+  @Delete(':id')
+  remove(@Param('id') id: string) {
+    return this.postService.remove(+id);
+  }
+}

package/tests/app-multi-database/app/post/post.module.ts

@@ -0,0 +1,10 @@
+import { Module } from '@nestjs/common';
+import { PostService } from './post.service';
+import { PostController } from './post.controller';
+
+@Module({
+  imports: [],
+  controllers: [PostController],
+  providers: [PostService],
+})
+export class PostModule {}

package/tests/app-multi-database/app/post/post.service.spec.ts

@@ -0,0 +1,18 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { PostService } from './post.service';
+
+describe('PostService', () => {
+  let service: PostService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [PostService],
+    }).compile();
+
+    service = module.get<PostService>(PostService);
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+});