Add registerAsync

CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.1.0-beta.1](https://github.com/ronati/narango/compare/v1.0.0...v1.1.0-beta.1) (2023-10-26)
+
+
+### Features
+
+* **module:** add registerAsync function to Narango module ([5bd1f51](https://github.com/ronati/narango/commit/5bd1f513034bfd6feee322ab73dd1bdc4ba35c3a))
+
 # 1.0.0 (2023-10-26)
 
 

README.md

@@ -72,6 +72,36 @@ For sake of simplicity the database credentials are passed directly to the regis
 
 ```
 
+### Async registration
+
+If you need to use providers to provide the options to Narango module, you can use `NarangoModule.registerAsync`:
+
+```ts
+import { Module } from "@nestjs/common";
+import { NarangoModule } from "@ronatilabs/narango";
+import { ConfigModule, ConfigService } from "@nestjs/config";
+
+@Module({
+  imports: [
+    ConfigModule.forRoot(),
+    NarangoModule.registerAsync({
+      useFactory: (config: ConfigService) => ({
+        database: {
+          url: config.get<string>("url"),
+          databaseName: config.get<string>("databaseName"),
+          auth: {
+            username: config.get<string>("username"),
+            password: config.get<string>("password"),
+          },
+        },
+      }),
+      inject: [ConfigService],
+    }),
+  ],
+})
+export class MyAppModule {}
+```
+
 ## Inject NarangoService
 
 Now you can access the `NarangoService` everywhere you need it in your application:
@@ -108,3 +138,7 @@ This project is setup with automatic semver versioning based on your commit sema
 3. Follow along the wizard to create your commit.
 4. Push your commit on the branch.
 5. Create your PR.
+
+## Notes for project's maintainers
+
+When you merge a PR from `beta` into `main` and it successfully published a new version on the `latest` channel, **don't forget to create a PR from `main` to `beta`**. **This is mandatory** for `semantic-release` to take it into account for next `beta` version.

lib/index.ts

@@ -1,3 +1,3 @@
-export * from "./narango.config";
+export { NarangoModuleOptions } from "./narango.module-definition";
 export * from "./narango.service";
 export * from "./narango.module";

lib/narango.module-definition.ts

@@ -0,0 +1,15 @@
+import type { Config as ArangoDBConfig } from "arangojs/connection";
+import { ConfigurableModuleBuilder } from "@nestjs/common";
+
+export interface NarangoModuleOptions {
+  global?: boolean;
+  database: ArangoDBConfig;
+}
+
+export const { ConfigurableModuleClass, MODULE_OPTIONS_TOKEN } =
+  new ConfigurableModuleBuilder<NarangoModuleOptions>()
+    .setExtras({ global: false }, (definition, extras) => ({
+      ...definition,
+      global: extras.global,
+    }))
+    .build();

lib/narango.module.ts

@@ -1,21 +1,10 @@
 import { Module } from "@nestjs/common";
-import type { DynamicModule } from "@nestjs/common";
 
 import { NarangoService } from "./narango.service";
-import { MODULE_OPTIONS } from "./narango.config";
-import type { NarangoModuleOptions } from "./narango.config";
+import { ConfigurableModuleClass } from "./narango.module-definition";
 
-@Module({})
-export class NarangoModule {
-  static register(options: NarangoModuleOptions): DynamicModule {
-    return {
-      module: NarangoModule,
-      global: options.global,
-      providers: [
-        { provide: MODULE_OPTIONS, useValue: options },
-        NarangoService,
-      ],
-      exports: [NarangoService],
-    };
-  }
-}
+@Module({
+  providers: [NarangoService],
+  exports: [NarangoService],
+})
+export class NarangoModule extends ConfigurableModuleClass {}

lib/narango.service.ts

@@ -2,14 +2,18 @@ import { Inject, Injectable } from "@nestjs/common";
 import type { OnApplicationShutdown } from "@nestjs/common";
 import { Database } from "arangojs";
 
-import { MODULE_OPTIONS } from "./narango.config";
-import type { NarangoModuleOptions } from "./narango.config";
+import {
+  MODULE_OPTIONS_TOKEN,
+  NarangoModuleOptions,
+} from "./narango.module-definition";
 
 @Injectable()
 export class NarangoService implements OnApplicationShutdown {
   public db: Database;
 
-  constructor(@Inject(MODULE_OPTIONS) private options: NarangoModuleOptions) {
+  constructor(
+    @Inject(MODULE_OPTIONS_TOKEN) private options: NarangoModuleOptions,
+  ) {
     this.db = new Database(options.database);
   }
 

lib/narango.spec.ts

@@ -4,7 +4,7 @@ import { Test } from "@nestjs/testing";
 
 import { NarangoModule } from "./narango.module";
 import { NarangoService } from "./narango.service";
-import { Injectable, Module } from "@nestjs/common";
+import { Global, Injectable, Module } from "@nestjs/common";
 
 const closeSpy = jest.fn();
 jest.mock("arangojs", () => ({
@@ -86,6 +86,42 @@ describe("Narango module", () => {
     expect(serviceFromRoot).toBeDefined();
     expect((serviceFromRoot.db as any).options).toEqual(options);
   });
+
+  it("can be registered async", async () => {
+    @Injectable()
+    class TestService {
+      public options = { url: "http://overridden.url" };
+      constructor() {}
+    }
+
+    @Global()
+    @Module({ providers: [TestService], exports: [TestService] })
+    class ChildModule {}
+
+    const rootModule = await Test.createTestingModule({
+      imports: [
+        ChildModule,
+        NarangoModule.registerAsync({
+          useFactory: (testService: TestService) => {
+            return {
+              database: {
+                ...options,
+                url: testService.options.url,
+              },
+            };
+          },
+          inject: [TestService],
+        }),
+      ],
+    }).compile();
+
+    const serviceFromRoot = rootModule.get<NarangoService>(NarangoService);
+    expect(serviceFromRoot).toBeDefined();
+    expect((serviceFromRoot.db as any).options).toEqual({
+      ...options,
+      url: "http://overridden.url",
+    });
+  });
 });
 
 /* eslint-enable @typescript-eslint/no-explicit-any */

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ronatilabs/narango",
-  "version": "1.0.0",
+  "version": "1.1.0-beta.1",
   "description": "A NestJS wrapper service for ArangoDB NodeJS driver",
   "exports": "./dist/index.js",
   "typings": "./dist/index.d.ts",