feat: support Objection v3

Closes #1182 BREAKING CHANGE: Knex and Objection both have breaking changes, so this will too. Signed-off-by: Will Soto <[email protected]>
willsoto · Sep 23, 2021 · eed1848 · eed1848
1 parent cb8421b
commit eed1848
Show file tree

Hide file tree

Showing 9 changed files with 182 additions and 3,020 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -111,12 +111,12 @@
     "eslint-config-prettier": "~8.3.0",
     "eslint-plugin-mocha": "~9.0.0",
     "husky": "~7.0.0",
-    "knex": "~0.21.5",
+    "knex": "~0.95.11",
     "lint-staged": "~11.1.0",
     "markdown-toc": "~1.2.0",
     "mocha": "~9.1.0",
     "nyc": "~15.1.0",
-    "objection": "~2.2.15",
+    "objection": "3.0.0-alpha.4",
     "prettier": "~2.4.0",
     "prettier-plugin-organize-imports": "~2.3.2",
     "prettier-plugin-packagejson": "~2.2.11",
@@ -134,12 +134,16 @@
   "peerDependencies": {
     "@nestjs/common": "^7.0.0 || ^8.0.0",
     "@nestjs/core": "^7.0.0 || ^8.0.0",
-    "knex": ">=0.16.0",
-    "objection": "^2.0.0"
+    "knex": "^0.95.0",
+    "objection": "^3.0.0"
   },
   "release": {
     "branches": [
-      "main"
+      "main",
+      {
+        "name": "next",
+        "prerelease": true
+      }
     ],
     "plugins": [
       "@semantic-release/commit-analyzer",

diff --git a/src/core.ts b/src/core.ts
@@ -9,7 +9,7 @@ import {
   ValueProvider,
 } from "@nestjs/common";
 import { ModuleRef } from "@nestjs/core";
-import * as Knex from "knex";
+import { knex, Knex } from "knex";
 import { Model } from "objection";
 import {
   KNEX_CONNECTION,
@@ -34,7 +34,7 @@ export class ObjectionCoreModule implements OnApplicationShutdown {
 
   public static register(options: ObjectionModuleOptions): DynamicModule {
     const BaseModel = options.Model || Model;
-    const connection = Knex(options.config);
+    const connection = knex(options.config);
 
     BaseModel.knex(connection);
 
@@ -73,7 +73,7 @@ export class ObjectionCoreModule implements OnApplicationShutdown {
       provide: connectionToken,
       inject: [OBJECTION_MODULE_OPTIONS],
       useFactory(objectionModuleOptions: ObjectionModuleOptions): Knex {
-        return Knex(objectionModuleOptions.config);
+        return knex(objectionModuleOptions.config);
       },
     };
 

diff --git a/src/interfaces.ts b/src/interfaces.ts
@@ -1,6 +1,6 @@
 import { Type } from "@nestjs/common";
 import { ModuleMetadata } from "@nestjs/common/interfaces";
-import * as Knex from "knex";
+import { Knex } from "knex";
 import { Model } from "objection";
 export interface ObjectionModuleOptions {
   /**

diff --git a/test/core.spec.ts b/test/core.spec.ts
@@ -1,7 +1,7 @@
 import { Injectable } from "@nestjs/common";
 import { Test, TestingModule } from "@nestjs/testing";
 import { expect } from "chai";
-import * as Knex from "knex";
+import { Knex } from "knex";
 import { Model } from "objection";
 import * as sinon from "sinon";
 import {

diff --git a/test/fixtures.ts b/test/fixtures.ts
@@ -1,7 +1,8 @@
 import { Inject, Injectable, Module } from "@nestjs/common";
-import * as Knex from "knex";
+import { Knex } from "knex";
 import { Model } from "objection";
 import { Connection, KNEX_CONNECTION, ObjectionModule } from "../src";
+
 @Injectable()
 export class ConnectionCheck {
   constructor(@Inject(KNEX_CONNECTION) public connection: Connection) {}

diff --git a/test/integration.spec.ts b/test/integration.spec.ts
@@ -1,7 +1,7 @@
 /* eslint-disable new-cap */
 import { Test, TestingModule } from "@nestjs/testing";
 import { expect } from "chai";
-import * as Knex from "knex";
+import { Knex } from "knex";
 import { KNEX_CONNECTION } from "../src";
 import { ConnectionCheck, ConnectionModule } from "./fixtures";
 describe("Integration", function () {

diff --git a/test/module.spec.ts b/test/module.spec.ts
@@ -1,6 +1,6 @@
 import { Test, TestingModule } from "@nestjs/testing";
 import { expect } from "chai";
-import * as Knex from "knex";
+import { Knex } from "knex";
 import { Model } from "objection";
 import { KNEX_CONNECTION } from "../src/constants";
 import { ObjectionModule } from "../src/module";

diff --git a/test/multiple-connections.spec.ts b/test/multiple-connections.spec.ts
@@ -1,8 +1,9 @@
 import { Test, TestingModule } from "@nestjs/testing";
 import { expect } from "chai";
-import * as Knex from "knex";
+import { Knex } from "knex";
 import { Model } from "objection";
 import { ObjectionCoreModule } from "../src/core";
+
 describe("when registering multiple connections", function () {
   let testingModule: TestingModule;
   let connection1: Knex;