feat(lib): register and inject objection models (#637)

README.md

@@ -39,6 +39,7 @@ import { Module } from "@nestjs/common";
 import knex from "knex";
 import { knexSnakeCaseMappers } from "objection";
 import { ConfigModule, ConfigService } from "../config";
+import { User } from "./user";
 import { BaseModel } from "./base";
 
 @Module({
@@ -56,6 +57,9 @@ import { BaseModel } from "./base";
         },
       },
     }),
+
+    //Register your objection models so it can be provided when needed.
+    ObjectionModule.forFeature([User]),
   ],
   exports: [ObjectionModule],
 })
@@ -70,6 +74,7 @@ import { Module } from "@nestjs/common";
 import knex from "knex";
 import { knexSnakeCaseMappers } from "objection";
 import { ConfigModule, ConfigService } from "../config";
+import { User } from "./user";
 import { BaseModel } from "./base";
 
 @Module({
@@ -90,6 +95,8 @@ import { BaseModel } from "./base";
         };
       },
     }),
+    //Register your objection models so it can be provided when needed.
+    ObjectionModule.forFeature([User]),
   ],
   exports: [ObjectionModule],
 })
@@ -128,3 +135,19 @@ export class PrimaryDatabaseHealthIndicator extends HealthIndicator {
   }
 }
 ```
+
+### Injecting an objection model
+
+```ts
+import { Injectable, Inject } from "@nestjs/common";
+import { User } from "./user";
+
+@Injectable()
+export class UserService {
+  constructor(@Inject(User) private readonly userModel: typeof User) {}
+
+  async getUsers(): Promise<User[]> {
+    return await this.userModel.query();
+  }
+}
+```

lib/module.ts

@@ -1,5 +1,6 @@
 /* eslint-disable new-cap */
-import { DynamicModule, Logger, Module } from "@nestjs/common";
+import { DynamicModule, Logger, Module, Provider } from "@nestjs/common";
+import { Model } from "objection";
 import { ObjectionCoreModule } from "./core";
 import {
   ObjectionModuleAsyncOptions,
@@ -42,4 +43,19 @@ export class ObjectionModule {
       exports: [ObjectionCoreModule],
     };
   }
+
+  public static forFeature(models: typeof Model[]): DynamicModule {
+    const modelProviders: Provider[] = models.map((model) => {
+      return {
+        useValue: model,
+        provide: model.name,
+      };
+    });
+
+    return {
+      module: ObjectionModule,
+      providers: modelProviders,
+      exports: modelProviders,
+    };
+  }
 }

tests/module.spec.ts

@@ -2,6 +2,7 @@ import { KNEX_CONNECTION, OBJECTION_BASE_MODEL } from "@/constants";
 import { ObjectionModule } from "@/module";
 import { Test, TestingModule } from "@nestjs/testing";
 import knex from "knex";
+import { Model } from "objection";
 
 describe("ObjectionModule", () => {
   let testingModule: TestingModule;
@@ -64,4 +65,22 @@ describe("ObjectionModule", () => {
       expect(model).toBeDefined();
     });
   });
+
+  describe("#forFeature", () => {
+    beforeEach(async () => {
+      testingModule = await Test.createTestingModule({
+        imports: [
+          ObjectionModule.register({
+            config,
+          }),
+          ObjectionModule.forFeature([Model]),
+        ],
+      }).compile();
+    });
+
+    test("provides a model", () => {
+      const model = testingModule.get(Model);
+      expect(model).toBeDefined();
+    });
+  });
 });