nest-knexjs 0.0.4 → 0.0.8

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/dist/common/knex.decorators.d.ts

@@ -1,2 +1,3 @@
+import { KnexModuleOptions } from '../interfaces/knex-options.interface';
 export declare const InjectModel: (connection?: string) => (target: object, key: string | symbol, index?: number) => void;
-export declare const InjectConnection: (connection?: string) => (target: object, key: string | symbol, index?: number) => void;
+export declare const InjectConnection: (connection?: KnexModuleOptions | string) => ParameterDecorator;

package/dist/common/knex.decorators.js

@@ -4,7 +4,8 @@ exports.InjectConnection = exports.InjectModel = void 0;
 const common_1 = require("@nestjs/common");
 const knex_utils_1 = require("./knex.utils");
 const InjectModel = (connection) => {
-    return common_1.Inject(knex_utils_1.getConnectionToken(connection));
+    return (0, common_1.Inject)((0, knex_utils_1.getConnectionToken)(connection));
 };
 exports.InjectModel = InjectModel;
-exports.InjectConnection = exports.InjectModel;
+const InjectConnection = (connection) => (0, common_1.Inject)((0, knex_utils_1.getConnectionToken)(connection));
+exports.InjectConnection = InjectConnection;

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

@@ -1,13 +1,13 @@
-import { KnexModuleOptions } from "../interfaces";
-import { Observable } from "rxjs";
+import { KnexModuleOptions } from '../interfaces';
+import { Observable } from 'rxjs';
 /**
- * This function generates an injection token for an Repostiory
- * @param {Function} This parameter can either be a Repostiory
+ * This function generates an injection token for an Model
+ * @param {Function} This parameter can either be a Model
  * @param {string} [connection='default'] Connection name
  * @returns {string} The Entity injection token
  */
-export declare function getModelToken(entity: Function, connection?: KnexModuleOptions | string): string;
-export declare function getConnectionToken(connection?: KnexModuleOptions | string): string | Function;
+export declare function getModelToken(model: Function, connection?: KnexModuleOptions | string): string;
+export declare function getConnectionToken(connection?: KnexModuleOptions | any): 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

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateString = exports.getConnectionName = exports.handleRetry = exports.getConnectionPrefix = exports.getConnectionToken = exports.getModelToken = void 0;
-const knex_1 = require("knex");
 const knex_constants_1 = require("../knex.constants");
 const operators_1 = require("rxjs/operators");
 const uuid_1 = require("uuid");
@@ -9,27 +8,21 @@ const common_1 = require("@nestjs/common");
 const circular_dependency_exception_1 = require("../exceptions/circular-dependency.exception");
 const logger = new common_1.Logger('KnexModule');
 /**
- * This function generates an injection token for an Repostiory
- * @param {Function} This parameter can either be a Repostiory
+ * This function generates an injection token for an Model
+ * @param {Function} This parameter can either be a Model
  * @param {string} [connection='default'] Connection name
  * @returns {string} The Entity injection token
  */
-function getModelToken(entity, connection = knex_constants_1.DEFAULT_CONNECTION_NAME) {
-    if ((entity === null) || (entity === undefined)) {
+function getModelToken(model, connection = knex_constants_1.DEFAULT_CONNECTION_NAME) {
+    if (model === null || model === undefined) {
         throw new circular_dependency_exception_1.CircularDependencyException('@InjectModel()');
     }
     const connectionPrefix = getConnectionPrefix(connection);
-    return `${connectionPrefix}${entity.name}Repository`;
+    return `${connectionPrefix}${model.name}`;
 }
 exports.getModelToken = getModelToken;
 function getConnectionToken(connection = knex_constants_1.DEFAULT_CONNECTION_NAME) {
-    return knex_constants_1.DEFAULT_CONNECTION_NAME === connection
-        ? knex_1.knex
-        : 'string' === typeof connection
-            ? `${connection}Connection`
-            : knex_constants_1.DEFAULT_CONNECTION_NAME === connection.name || !connection.name
-                ? knex_1.knex
-                : `${connection.name}Connection`;
+    return `${connection.name || knex_constants_1.DEFAULT_CONNECTION_NAME}`;
 }
 exports.getConnectionToken = getConnectionToken;
 /**
@@ -52,19 +45,18 @@ function getConnectionPrefix(connection = knex_constants_1.DEFAULT_CONNECTION_NA
 }
 exports.getConnectionPrefix = getConnectionPrefix;
 function handleRetry(retryAttempts = 9, retryDelay = 3000) {
-    return (source) => source.pipe(operators_1.retryWhen(e => e.pipe(operators_1.scan((errorCount, error) => {
-        logger.error(`Unable to connect to the database. Retrying (${errorCount +
-            1})...`, error.stack);
+    return (source) => source.pipe((0, operators_1.retryWhen)((e) => e.pipe((0, operators_1.scan)((errorCount, error) => {
+        logger.error(`Unable to connect to the database. Retrying (${errorCount + 1})...`, error.stack);
         if (errorCount + 1 >= retryAttempts) {
             throw error;
         }
         return errorCount + 1;
-    }, 0), operators_1.delay(retryDelay))));
+    }, 0), (0, operators_1.delay)(retryDelay))));
 }
 exports.handleRetry = handleRetry;
 function getConnectionName(options) {
     return options && options.name ? options.name : knex_constants_1.DEFAULT_CONNECTION_NAME;
 }
 exports.getConnectionName = getConnectionName;
-const generateString = () => uuid_1.v4();
+const generateString = () => (0, uuid_1.v4)();
 exports.generateString = generateString;

package/dist/knex-core.module.d.ts

@@ -7,7 +7,7 @@ export declare class KnexCoreModule implements OnApplicationShutdown {
     constructor(options: KnexModuleOptions, moduleRef: ModuleRef);
     static forRoot(options: KnexModuleOptions, connection?: string): DynamicModule;
     static forRootAsync(options: KnexModuleAsyncOptions, connection: string): DynamicModule;
-    onApplicationShutdown(): Promise<void>;
+    onApplicationShutdown(): Promise<any>;
     static createAsyncProviders(options: KnexModuleAsyncOptions): Provider[];
     static createAsyncOptionsProvider(options: KnexModuleAsyncOptions): Provider;
     private static createConnectionFactory;

package/dist/knex-core.module.js

@@ -31,7 +31,7 @@ let KnexCoreModule = KnexCoreModule_1 = class KnexCoreModule {
             useValue: options,
         };
         const connectionProvider = {
-            provide: knex_utils_1.getConnectionToken(connection),
+            provide: (0, knex_utils_1.getConnectionToken)(connection),
             useFactory: async () => await this.createConnectionFactory(options),
         };
         return {
@@ -42,7 +42,7 @@ let KnexCoreModule = KnexCoreModule_1 = class KnexCoreModule {
     }
     static forRootAsync(options, connection) {
         const connectionProvider = {
-            provide: knex_utils_1.getConnectionToken(connection),
+            provide: (0, knex_utils_1.getConnectionToken)(connection),
             useFactory: async (options) => {
                 return await this.createConnectionFactory(options);
             },
@@ -56,7 +56,7 @@ let KnexCoreModule = KnexCoreModule_1 = class KnexCoreModule {
         };
     }
     async onApplicationShutdown() {
-        const connection = this.moduleRef.get(knex_utils_1.getConnectionToken(this.options));
+        const connection = this.moduleRef.get((0, knex_utils_1.getConnectionToken)(this.options));
         connection && (await connection.destroy());
     }
     static createAsyncProviders(options) {
@@ -93,17 +93,15 @@ let KnexCoreModule = KnexCoreModule_1 = class KnexCoreModule {
         };
     }
     static async createConnectionFactory(options) {
-        return await rxjs_1.defer(async () => {
-            return knex_1.knex(options.config);
-        })
-            .pipe(knex_utils_1.handleRetry(options.retryAttempts, options.retryDelay))
-            .toPromise();
+        return (0, rxjs_1.lastValueFrom)((0, rxjs_1.defer)(async () => {
+            return (0, knex_1.knex)(options.config);
+        }).pipe((0, knex_utils_1.handleRetry)(options.retryAttempts, options.retryDelay)));
     }
 };
 KnexCoreModule = KnexCoreModule_1 = __decorate([
-    common_1.Global(),
-    common_1.Module({}),
-    __param(0, common_1.Inject(knex_constants_1.KNEX_MODULE_OPTIONS)),
+    (0, common_1.Global)(),
+    (0, common_1.Module)({}),
+    __param(0, (0, common_1.Inject)(knex_constants_1.KNEX_MODULE_OPTIONS)),
     __metadata("design:paramtypes", [Object, core_1.ModuleRef])
 ], KnexCoreModule);
 exports.KnexCoreModule = KnexCoreModule;

package/dist/knex.module.js

@@ -25,6 +25,6 @@ let KnexModule = KnexModule_1 = class KnexModule {
     }
 };
 KnexModule = KnexModule_1 = __decorate([
-    common_1.Module({})
+    (0, common_1.Module)({})
 ], KnexModule);
 exports.KnexModule = KnexModule;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nest-knexjs",
-  "version": "0.0.4",
+  "version": "0.0.8",
   "description": "Knexjs module for Nest framework (node.js) 😻",
   "author": "Tony133",
   "license": "MIT",
@@ -18,41 +18,41 @@
     "release": "release-it"
   },
   "devDependencies": {
-    "@commitlint/cli": "12.1.4",
-    "@commitlint/config-angular": "12.1.4",
-    "@nestjs/common": "7.6.18",
-    "@nestjs/core": "7.6.18",
-    "@nestjs/platform-express": "7.6.18",
-    "@nestjs/testing": "7.6.18",
-    "@types/express": "4.17.12",
-    "@types/jest": "26.0.23",
-    "@types/node": "14.17.4",
+    "@commitlint/cli": "16.1.0",
+    "@commitlint/config-angular": "16.0.0",
+    "@nestjs/common": "8.2.6",
+    "@nestjs/core": "8.2.6",
+    "@nestjs/platform-express": "8.2.6",
+    "@nestjs/testing": "8.2.6",
+    "@types/express": "4.17.13",
+    "@types/node": "16.11.21",
+    "@types/jest": "27.4.0",
     "@types/supertest": "2.0.11",
-    "@typescript-eslint/eslint-plugin": "4.28.1",
-    "@typescript-eslint/parser": "4.28.1",
-    "eslint": "7.30.0",
+    "@typescript-eslint/eslint-plugin": "5.10.1",
+    "@typescript-eslint/parser": "5.10.1",
+    "eslint": "8.8.0",
     "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-import": "2.23.4",
-    "knex": "0.95.6",
+    "eslint-plugin-import": "2.25.4",
+    "knex": "1.0.1",
     "mysql": "2.18.1",
-    "husky": "7.0.0",
-    "jest": "27.0.6",
-    "prettier": "2.3.2",
+    "husky": "7.0.4",
+    "prettier": "2.5.1",
+    "jest": "27.4.7",
     "reflect-metadata": "0.1.13",
-    "release-it": "14.10.0",
-    "supertest": "6.1.3",
-    "rxjs": "7.1.0",
-    "ts-node": "10.0.0",
-    "ts-jest": "27.0.3",
-    "tsconfig-paths": "3.9.0",
-    "typescript": "4.3.5"
+    "release-it": "14.12.4",
+    "supertest": "6.2.2",
+    "ts-node": "10.4.0",
+    "rxjs": "7.5.2",
+    "ts-jest": "27.1.3",
+    "tsconfig-paths": "3.12.0",
+    "typescript": "4.5.5"
   },
   "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

@@ -5,7 +5,7 @@ import {
   NotFoundException,
 } from '@nestjs/common';
 import { Knex } from 'knex';
-import { InjectModel } from '../../../lib';
+import { InjectModel } from '../../../../lib';
 import { CreateUserDto } from './dto/create-user.dto';
 import { UpdateUserDto } from './dto/update-user.dto';
 
@@ -21,8 +21,8 @@ export class UsersService {
   async create(createUserDto: CreateUserDto) {
     try {
       const users = await this.knex.table('user').insert({
-        first_name: createUserDto.first_name,
-        last_name: createUserDto.last_name,
+        firstName: createUserDto.firstName,
+        lastName: createUserDto.lastName,
       });
 
       return { users };
@@ -33,7 +33,7 @@ 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').where('id', id);
     return { users };
@@ -42,8 +42,8 @@ export class UsersService {
   async update(id: number, updateUserDto: UpdateUserDto) {
     try {
       const users = await this.knex.table('user').where('id', id).update({
-        first_name: updateUserDto.first_name,
-        last_name: updateUserDto.last_name,
+        firstName: updateUserDto.firstName,
+        lastName: updateUserDto.lastName,
       });
 
       return { users };
@@ -54,7 +54,7 @@ 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').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',
         },
       ]);
     });