@bull-board/nestjs 5.19.2 → 5.20.1

package/README.md

@@ -68,7 +68,7 @@ To register a new queue, you need to register `BullBoardModule.forFeature` in th
 ```typescript
 import { Module } from '@nestjs/common';
 import { BullBoardModule } from "@bull-board/nestjs";
-import { BullMQAdapter } from "@bull-board/api/bullMQadapter";
+import { BullMQAdapter } from "@bull-board/api/bullMQAdapter";
 import { BullModule } from "@nestjs/bullmq";
 
 @Module({

package/dist/bull-board.module.d.ts

@@ -1,6 +1,7 @@
 import { DynamicModule } from "@nestjs/common";
-import { BullBoardModuleOptions, BullBoardQueueOptions } from "./bull-board.types";
+import { BullBoardModuleAsyncOptions, BullBoardModuleOptions, BullBoardQueueOptions } from "./bull-board.types";
 export declare class BullBoardModule {
     static forFeature(...queues: BullBoardQueueOptions[]): DynamicModule;
     static forRoot(options: BullBoardModuleOptions): DynamicModule;
+    static forRootAsync(options: BullBoardModuleAsyncOptions): DynamicModule;
 }

package/dist/bull-board.module.js

@@ -31,6 +31,13 @@ let BullBoardModule = BullBoardModule_1 = class BullBoardModule {
             exports: [bull_board_root_module_1.BullBoardRootModule],
         };
     }
+    static forRootAsync(options) {
+        return {
+            module: BullBoardModule_1,
+            imports: [bull_board_root_module_1.BullBoardRootModule.forRootAsync(options)],
+            exports: [bull_board_root_module_1.BullBoardRootModule]
+        };
+    }
 };
 exports.BullBoardModule = BullBoardModule;
 exports.BullBoardModule = BullBoardModule = BullBoardModule_1 = __decorate([

package/dist/bull-board.root-module.d.ts

@@ -1,5 +1,5 @@
 import { DynamicModule, MiddlewareConsumer, NestModule } from "@nestjs/common";
-import { BullBoardModuleOptions, BullBoardServerAdapter } from "./bull-board.types";
+import { BullBoardModuleAsyncOptions, BullBoardModuleOptions, BullBoardServerAdapter } from "./bull-board.types";
 import { ApplicationConfig, HttpAdapterHost } from "@nestjs/core";
 export declare class BullBoardRootModule implements NestModule {
     private readonly adapterHost;
@@ -9,4 +9,5 @@ export declare class BullBoardRootModule implements NestModule {
     constructor(adapterHost: HttpAdapterHost, applicationConfig: ApplicationConfig, adapter: BullBoardServerAdapter, options: BullBoardModuleOptions);
     configure(consumer: MiddlewareConsumer): any;
     static forRoot(options: BullBoardModuleOptions): DynamicModule;
+    static forRootAsync(options: BullBoardModuleAsyncOptions): DynamicModule;
 }

package/dist/bull-board.root-module.js

@@ -80,6 +80,42 @@ let BullBoardRootModule = BullBoardRootModule_1 = class BullBoardRootModule {
             ],
         };
     }
+    static forRootAsync(options) {
+        const bullBoardProvider = {
+            provide: bull_board_constants_1.BULL_BOARD_INSTANCE,
+            useFactory: (options, adapter) => (0, api_1.createBullBoard)({
+                queues: [],
+                serverAdapter: adapter,
+                options: options.boardOptions,
+            }),
+            inject: [bull_board_constants_1.BULL_BOARD_OPTIONS, bull_board_constants_1.BULL_BOARD_ADAPTER]
+        };
+        const serverAdapterProvider = {
+            provide: bull_board_constants_1.BULL_BOARD_ADAPTER,
+            useFactory: (options) => new options.adapter(),
+            inject: [bull_board_constants_1.BULL_BOARD_OPTIONS]
+        };
+        const optionsProvider = {
+            provide: bull_board_constants_1.BULL_BOARD_OPTIONS,
+            useFactory: options.useFactory,
+            inject: options.inject
+        };
+        return {
+            module: BullBoardRootModule_1,
+            global: true,
+            imports: options.imports,
+            providers: [
+                serverAdapterProvider,
+                optionsProvider,
+                bullBoardProvider
+            ],
+            exports: [
+                serverAdapterProvider,
+                bullBoardProvider,
+                optionsProvider
+            ],
+        };
+    }
 };
 exports.BullBoardRootModule = BullBoardRootModule;
 exports.BullBoardRootModule = BullBoardRootModule = BullBoardRootModule_1 = __decorate([

package/dist/bull-board.types.d.ts

@@ -1,6 +1,7 @@
 import { createBullBoard } from "@bull-board/api";
 import { BoardOptions, IServerAdapter, QueueAdapterOptions } from "@bull-board/api/dist/typings/app";
 import { BaseAdapter } from "@bull-board/api/dist/src/queueAdapters/base";
+import { InjectionToken, ModuleMetadata, OptionalFactoryDependency } from "@nestjs/common";
 export type BullBoardInstance = ReturnType<typeof createBullBoard>;
 export type BullBoardModuleOptions = {
     route: string;
@@ -10,6 +11,11 @@ export type BullBoardModuleOptions = {
     boardOptions?: BoardOptions;
     middleware?: any;
 };
+export type BullBoardModuleAsyncOptions = {
+    useFactory: (...args: any[]) => BullBoardModuleOptions | Promise<BullBoardModuleOptions>;
+    imports?: ModuleMetadata['imports'];
+    inject?: Array<InjectionToken | OptionalFactoryDependency>;
+};
 export type BullBoardQueueOptions = {
     name: string;
     adapter: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bull-board/nestjs",
-  "version": "5.19.2",
+  "version": "5.20.1",
   "description": "A NestJS module for Bull-Board dashboard.",
   "keywords": [
     "bull",
@@ -19,9 +19,9 @@
     "clean": "rm -rf dist"
   },
   "devDependencies": {
-    "@bull-board/api": "^5.19.2",
-    "@bull-board/express": "^5.19.2",
-    "@bull-board/fastify": "^5.19.2",
+    "@bull-board/api": "^5.20.1",
+    "@bull-board/express": "^5.20.1",
+    "@bull-board/fastify": "^5.20.1",
     "@nestjs/bullmq": "^10.0.0",
     "@nestjs/common": "^10.0.1",
     "@nestjs/core": "^10.0.1",
@@ -36,8 +36,8 @@
     "@nestjs/bull-shared": "^10.0.0"
   },
   "peerDependencies": {
-    "@bull-board/api": "^5.19.2",
-    "@bull-board/express": "^5.19.2",
+    "@bull-board/api": "^5.20.1",
+    "@bull-board/express": "^5.20.1",
     "@nestjs/common": "^9.0.0 || ^10.0.0",
     "@nestjs/core": "^9.0.0 || ^10.0.0",
     "reflect-metadata": "^0.1.13 || ^0.2.0",

package/src/bull-board.module.ts

@@ -2,7 +2,7 @@ import { DynamicModule, Module} from "@nestjs/common";
 import { BullBoardFeatureModule } from "./bull-board.feature-module";
 import { BullBoardRootModule } from "./bull-board.root-module";
 import { BULL_BOARD_QUEUES } from "./bull-board.constants";
-import { BullBoardModuleOptions, BullBoardQueueOptions } from "./bull-board.types";
+import { BullBoardModuleAsyncOptions, BullBoardModuleOptions, BullBoardQueueOptions } from "./bull-board.types";
 
 @Module({})
 export class BullBoardModule {
@@ -26,4 +26,12 @@ export class BullBoardModule {
       exports: [ BullBoardRootModule ],
     };
   }
+
+  static forRootAsync(options: BullBoardModuleAsyncOptions): DynamicModule {
+    return {
+      module: BullBoardModule,
+      imports: [ BullBoardRootModule.forRootAsync(options) ],
+      exports: [ BullBoardRootModule ]
+    }
+  }
 }

package/src/bull-board.root-module.ts

@@ -1,7 +1,7 @@
 import { DynamicModule, Inject, MiddlewareConsumer, Module, NestModule, Provider } from "@nestjs/common";
 import { createBullBoard } from "@bull-board/api";
 import { BULL_BOARD_ADAPTER, BULL_BOARD_INSTANCE, BULL_BOARD_OPTIONS } from "./bull-board.constants";
-import { BullBoardModuleOptions, BullBoardServerAdapter } from "./bull-board.types";
+import { BullBoardModuleAsyncOptions, BullBoardModuleOptions, BullBoardServerAdapter } from "./bull-board.types";
 import { ApplicationConfig, HttpAdapterHost } from "@nestjs/core";
 import { isExpressAdapter, isFastifyAdapter } from "./bull-board.util";
 
@@ -79,4 +79,44 @@ export class BullBoardRootModule implements NestModule {
       ],
     };
   }
+
+  static forRootAsync(options: BullBoardModuleAsyncOptions): DynamicModule {
+    const bullBoardProvider: Provider = {
+      provide: BULL_BOARD_INSTANCE,
+      useFactory: (options: BullBoardModuleOptions, adapter: BullBoardServerAdapter) => createBullBoard({
+        queues: [],
+        serverAdapter: adapter,
+        options: options.boardOptions,
+      }),
+      inject: [BULL_BOARD_OPTIONS, BULL_BOARD_ADAPTER]
+    };
+
+    const serverAdapterProvider: Provider = {
+      provide: BULL_BOARD_ADAPTER,
+      useFactory: (options: BullBoardModuleOptions) => new options.adapter(),
+      inject: [BULL_BOARD_OPTIONS]
+    };
+
+    const optionsProvider: Provider = {
+      provide: BULL_BOARD_OPTIONS,
+      useFactory: options.useFactory,
+      inject: options.inject
+    }
+
+    return {
+      module: BullBoardRootModule,
+      global: true,
+      imports: options.imports,
+      providers: [
+        serverAdapterProvider,
+        optionsProvider,
+        bullBoardProvider
+      ],
+      exports: [
+        serverAdapterProvider,
+        bullBoardProvider,
+        optionsProvider
+      ],
+    };
+  }
 }

package/src/bull-board.types.ts

@@ -1,6 +1,7 @@
 import { createBullBoard } from "@bull-board/api";
 import { BoardOptions, IServerAdapter, QueueAdapterOptions } from "@bull-board/api/dist/typings/app";
 import { BaseAdapter } from "@bull-board/api/dist/src/queueAdapters/base";
+import { InjectionToken, ModuleMetadata, OptionalFactoryDependency } from "@nestjs/common";
 
 export type BullBoardInstance = ReturnType<typeof createBullBoard>;
 
@@ -11,6 +12,12 @@ export type BullBoardModuleOptions = {
   middleware?: any
 }
 
+export type BullBoardModuleAsyncOptions = {
+  useFactory: (...args: any[]) => BullBoardModuleOptions| Promise<BullBoardModuleOptions>;
+  imports?: ModuleMetadata['imports'];
+  inject?: Array<InjectionToken | OptionalFactoryDependency>;
+}
+
 export type BullBoardQueueOptions = {
   name: string;
   adapter: { new(queue: any, options?: Partial<QueueAdapterOptions>): BaseAdapter },