nest-knexjs 0.0.6 → 0.0.9

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@v3
+      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

@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" /></a>
+  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
 </p>
 
 [circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
@@ -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) 
@@ -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

package/dist/common/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/common/knex.utils.d.ts

@@ -7,7 +7,7 @@ import { Observable } from 'rxjs';
  * @returns {string} The Entity injection token
  */
 export declare function getModelToken(model: Function, connection?: KnexModuleOptions | string): string;
-export declare function getConnectionToken(connection?: KnexModuleOptions | any): string | Function;
+export declare function getConnectionToken(connection?: KnexModuleOptions | string): string | Function;
 /**
  * This function returns a Connection prefix based on the connection name
  * @param {KnexModuleOptions | string} [connection='default'] This optional parameter is either

package/dist/common/knex.utils.js

@@ -22,6 +22,9 @@ function getModelToken(model, connection = knex_constants_1.DEFAULT_CONNECTION_N
 }
 exports.getModelToken = getModelToken;
 function getConnectionToken(connection = knex_constants_1.DEFAULT_CONNECTION_NAME) {
+    if (typeof connection === 'string') {
+        return connection;
+    }
     return `${connection.name || knex_constants_1.DEFAULT_CONNECTION_NAME}`;
 }
 exports.getConnectionToken = getConnectionToken;

package/dist/exceptions/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/interfaces/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nest-knexjs",
-  "version": "0.0.6",
+  "version": "0.0.9",
   "description": "Knexjs module for Nest framework (node.js) 😻",
   "author": "Tony133",
   "license": "MIT",
@@ -18,41 +18,41 @@
     "release": "release-it"
   },
   "devDependencies": {
-    "@commitlint/cli": "13.1.0",
-    "@commitlint/config-angular": "13.1.0",
-    "@nestjs/common": "8.0.6",
-    "@nestjs/core": "8.0.6",
-    "@nestjs/platform-express": "8.0.6",
-    "@nestjs/testing": "8.0.6",
+    "@commitlint/cli": "16.2.3",
+    "@commitlint/config-angular": "16.2.3",
+    "@nestjs/common": "8.4.4",
+    "@nestjs/core": "8.4.4",
+    "@nestjs/platform-express": "8.4.4",
+    "@nestjs/testing": "8.4.4",
     "@types/express": "4.17.13",
-    "@types/jest": "27.0.1",
-    "@types/node": "14.17.14",
-    "@types/supertest": "2.0.11",
-    "@typescript-eslint/eslint-plugin": "4.30.0",
-    "@typescript-eslint/parser": "4.30.0",
-    "eslint": "7.32.0",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-import": "2.24.2",
-    "knex": "0.95.10",
+    "@types/node": "16.11.27",
+    "@types/jest": "27.4.1",
+    "@types/supertest": "2.0.12",
+    "@typescript-eslint/eslint-plugin": "5.19.0",
+    "@typescript-eslint/parser": "5.19.0",
+    "eslint": "8.13.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-import": "2.26.0",
+    "knex": "1.0.7",
     "mysql": "2.18.1",
-    "husky": "7.0.2",
-    "jest": "27.1.0",
-    "prettier": "2.3.2",
+    "husky": "7.0.4",
+    "prettier": "2.6.2",
+    "jest": "27.5.1",
     "reflect-metadata": "0.1.13",
-    "release-it": "14.11.5",
-    "supertest": "6.1.6",
-    "rxjs": "7.3.0",
-    "ts-node": "10.2.1",
-    "ts-jest": "27.0.5",
-    "tsconfig-paths": "3.11.0",
-    "typescript": "4.4.2"
+    "release-it": "14.14.2",
+    "supertest": "6.2.2",
+    "ts-node": "10.7.0",
+    "rxjs": "7.5.5",
+    "ts-jest": "27.1.4",
+    "tsconfig-paths": "3.14.1",
+    "typescript": "4.6.3"
   },
   "peerDependencies": {
     "@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.2.0",
-    "knex": "^0.21.17 || ^0.95.0"
+    "knex": "^0.21.17 || ^0.95.0 || ^1.0.0"
   },
   "lint-staged": {
     "*.ts": [

package/tests/app-knex/app/app.module.ts

@@ -0,0 +1,25 @@
+import { Module } from '@nestjs/common';
+import { KnexModule } from '../../lib';
+import { UsersModule } from './users/users.module';
+
+@Module({
+  imports: [
+    KnexModule.forRoot({
+      config: {
+        client: 'mysql',
+        version: '5.7',
+        useNullAsDefault: true,
+        connection: {
+          host: '127.0.0.1',
+          user: 'root',
+          password: 'root',
+          database: 'test',
+        },
+      },
+    }),
+    UsersModule,
+  ],
+  controllers: [],
+  providers: [],
+})
+export class AppModule {}

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

@@ -5,25 +5,22 @@ import {
   NotFoundException,
 } from '@nestjs/common';
 import { Knex } from 'knex';
-import { InjectConnection, InjectModel } from '../../../lib';
+import { InjectModel } from '../../../../lib';
 import { CreateUserDto } from './dto/create-user.dto';
 import { UpdateUserDto } from './dto/update-user.dto';
 
 @Injectable()
 export class UsersService {
-  constructor(
-    @InjectConnection('db1Connection')
-    private knex: Knex, //= knex(knexConfig.developmentOne.connection),
-  ) {}
+  constructor(@InjectModel() private readonly knex: Knex) {}
 
   async findAll() {
-    const users = await this.knex.table('users');
+    const users = await this.knex.table('user');
     return { users };
   }
 
   async create(createUserDto: CreateUserDto) {
     try {
-      const users = await this.knex.table('users').insert({
+      const users = await this.knex.table('user').insert({
         firstName: createUserDto.firstName,
         lastName: createUserDto.lastName,
       });
@@ -38,13 +35,13 @@ export class UsersService {
     if (!id) {
       throw new NotFoundException('User ID does not exist');
     }
-    const users = await this.knex.table('users').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('users').where('id', id).update({
+      const users = await this.knex.table('user').where('id', id).update({
         firstName: updateUserDto.firstName,
         lastName: updateUserDto.lastName,
       });
@@ -59,7 +56,7 @@ export class UsersService {
     if (!id) {
       throw new NotFoundException('User ID does not exist');
     }
-    const users = await this.knex.table('users').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/app-knex/knexfile.js

@@ -0,0 +1,11 @@
+module.exports = {
+  development: {
+    client: 'mysql',
+    connection: {
+      host: '127.0.0.1',
+      user: 'root',
+      password: 'root',
+      database: 'test',
+    },
+  },
+};

package/tests/app-knex/migrations/20210223224919_api.js

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

package/tests/app-knex/seeds/users.js

@@ -0,0 +1,23 @@
+exports.seed = function (knex) {
+  return knex('user')
+    .del()
+    .then(function () {
+      return knex('user').insert([
+        {
+          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/tests/app-multi-database/{app.module.ts → app/app.module.ts}

@@ -23,7 +23,6 @@ import { UsersModule } from './users/users.module';
               min: 2,
               max: 10,
             },
-            searchPath: ['db1Connection'],
           },
         }),
       },
@@ -47,7 +46,6 @@ import { UsersModule } from './users/users.module';
               min: 2,
               max: 10,
             },
-            searchPath: ['db2Connection'],
           },
         }),
       },

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/{post → app/post}/post.module.ts

@@ -3,7 +3,8 @@ import { PostService } from './post.service';
 import { PostController } from './post.controller';
 
 @Module({
+  imports: [],
   controllers: [PostController],
-  providers: [PostService]
+  providers: [PostService],
 })
 export class PostModule {}

package/tests/app-multi-database/{post → app/post}/post.service.ts

@@ -2,17 +2,14 @@ import { HttpException, HttpStatus, Injectable } from '@nestjs/common';
 import { CreatePostDto } from './dto/create-post.dto';
 import { UpdatePostDto } from './dto/update-post.dto';
 import { NotFoundException } from '@nestjs/common';
-// import KnexConnection from '../knex';
-// import knex from 'knex';
-// import knexConfig from '../../knexfile';
 import { Knex } from 'knex';
-import { InjectConnection } from '../../../lib';
+import { InjectConnection } from '../../../../lib';
 
 @Injectable()
 export class PostService {
   constructor(
     @InjectConnection('db2Connection')
-    private knexConnection: Knex, //= knex(knexConfig.developmentOne.connection),
+    private knexConnection: Knex,
   ) {}
 
   async create(createPostDto: CreatePostDto) {
@@ -29,14 +26,13 @@ export class PostService {
   }
 
   async findAll() {
-    console.log(this.knexConnection);
     const posts = await this.knexConnection.table('posts');
     return { posts };
   }
 
   async findOne(id: number) {
     if (!id) {
-      throw new NotFoundException('Customer ID does not exist');
+      throw new NotFoundException('Post ID does not exist');
     }
     const posts = await this.knexConnection.table('posts').where('id', id);
     return { posts };
@@ -60,7 +56,7 @@ export class PostService {
 
   async remove(id: number) {
     if (!id) {
-      throw new NotFoundException('User ID does not exist');
+      throw new NotFoundException('Post ID does not exist');
     }
     const post = await this.knexConnection.table('posts').where('id', id).del();
     return { post };

package/tests/app-multi-database/app/users/dto/create-user.dto.ts

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

package/tests/app-multi-database/app/users/dto/update-user.dto.ts

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

package/tests/app-multi-database/app/users/entities/user.entity.ts

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