@bull-board/nestjs 5.3.1

package/README.md

@@ -0,0 +1,118 @@
+# <img alt="@bull-board" src="https://raw.githubusercontent.com/felixmosh/bull-board/master/packages/ui/src/static/images/logo.svg" width="35px" /> @bull-board/nestjs
+
+[NestJS](https://nestjs.com/)  for `bull-board`.
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@bull-board/nestjs">
+    <img alt="npm version" src="https://img.shields.io/npm/v/@bull-board/nestjs">
+  </a>
+  <a href="https://www.npmjs.com/package/bull-board">
+    <img alt="npm downloads" src="https://img.shields.io/npm/dw/bull-board">
+  </a>
+  <a href="https://github.com/vcapretz/bull-board/blob/master/LICENSE">
+    <img alt="licence" src="https://img.shields.io/github/license/vcapretz/bull-board">
+  </a>
+<p>
+
+![UI](https://raw.githubusercontent.com/felixmosh/bull-board/master/screenshots/dashboard.png)
+
+## Installation
+
+Install both @bull-board/api and this module.
+```bash
+$ npm install --save @bull-board/nestjs @bull-board/api
+```
+
+Install the Express or Fastify adapter depending on what you use in NestJS (default is Express)
+```bash
+$ npm install --save @bull-board/express
+//or 
+$ npm install --save @bull-board/fastify
+```
+
+## Register the root module
+Once the installation is completed, we can import the `BullBoardModule` into your rootmodule e.g. `AppModule`.
+
+```typescript
+import { Module } from '@nestjs/common';
+import { BullBoardModule } from "@bull-board/nestjs";
+import { ExpressAdapter } from "@bull-board/express";
+
+@Module({
+  imports: [
+    BullModule.forRoot({
+      // your bull module config here.
+    }),
+
+    BullBoardModule.forRoot({
+      route: '/queues',
+      adapter: ExpressAdapter // Or FastifyAdapter from `@bull-board/fastify`
+    }),
+  ],
+})
+export class AppModule {
+}
+```
+
+The `forRoot()` method registers the bull-board instance and allows you to pass several options to both the instance and module.
+The following options are available.
+- `route` the base route for the bull-board instance adapter.
+- `adapter` The routing adapter to be used, either the Express Adapter or Fastify Adapter provided by bull-board.
+- `boardOptions` options as provided by the bull-board package, such as `uiBasePath` and `uiConfig`
+- `middleware` optional middleware for the express adapter (e.g. basic authentication)
+
+## Register your queues
+To register a new queue, you need to register `BullBoardModule.forFeature` in the same module as where your queues are registered.
+
+```typescript
+import { Module } from '@nestjs/common';
+import { BullBoardModule } from "@bull-board/nestjs";
+import { BullModule } from "@nestjs/bullmq";
+
+@Module({
+  imports: [
+    BullModule.registerQueue(
+      {
+        name: 'my_awesome_queue'
+      }
+    ),
+    
+    BullBoardModule.forFeature({
+      name: 'my_awesome_queue',
+      adapter: BullMQAdapter, //or use BullAdapter if you're using bull instead of bullMQ
+    }),
+  ],
+})
+export class FeatureModule {}
+```
+
+The `forFeature` method registers the given queues to the bull-board instance.
+The following options are available.
+- `name` the queue name to register
+- `adapter` either `BullAdapter` or `BullMQAdapter` depending on which package you use.
+- `options` queue adapter options as found in the bull-board package, such as `readOnlyMode`, `description` etc.
+
+##  Using the bull-board instance in your controllers and/or services.
+The created bull-board instance is available via the `@InjectBullBoard()` decorator.
+For example in a controller:
+
+```typescript
+import { Controller, Get } from "@nestjs/common";
+import { BullBoardInstance, InjectBullBoard } from "@bull-board/nestjs";
+
+@Controller('my-feature')
+export class FeatureController {
+
+  constructor(
+    @InjectBullBoard() private readonly boardInstance: BullBoardInstance
+  ) {
+  }
+  
+  //controller methods
+}
+```
+
+# Usage examples
+1. [Simple NestJS setup](https://github.com/felixmosh/bull-board/tree/master/examples/with-nestjs)
+
+For more info visit the main [README](https://github.com/felixmosh/bull-board#readme)

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

@@ -0,0 +1,4 @@
+export declare const BULL_BOARD_OPTIONS = "bull_board_options";
+export declare const BULL_BOARD_QUEUES = "bull_board_queues";
+export declare const BULL_BOARD_ADAPTER = "bull_board_adapter";
+export declare const BULL_BOARD_INSTANCE = "bull_board_instance";

package/dist/bull-board.constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BULL_BOARD_INSTANCE = exports.BULL_BOARD_ADAPTER = exports.BULL_BOARD_QUEUES = exports.BULL_BOARD_OPTIONS = void 0;
+exports.BULL_BOARD_OPTIONS = 'bull_board_options';
+exports.BULL_BOARD_QUEUES = 'bull_board_queues';
+exports.BULL_BOARD_ADAPTER = 'bull_board_adapter';
+exports.BULL_BOARD_INSTANCE = 'bull_board_instance';

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

@@ -0,0 +1 @@
+export declare const InjectBullBoard: () => ParameterDecorator;

package/dist/bull-board.decorator.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InjectBullBoard = void 0;
+const common_1 = require("@nestjs/common");
+const bull_board_constants_1 = require("./bull-board.constants");
+const InjectBullBoard = () => (0, common_1.Inject)(bull_board_constants_1.BULL_BOARD_INSTANCE);
+exports.InjectBullBoard = InjectBullBoard;

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

@@ -0,0 +1,10 @@
+import { OnModuleInit } from "@nestjs/common";
+import { ModuleRef } from "@nestjs/core";
+import { BullBoardInstance, BullBoardQueueOptions } from "./bull-board.types";
+export declare class BullBoardFeatureModule implements OnModuleInit {
+    private readonly moduleRef;
+    private readonly queues;
+    private readonly board;
+    constructor(moduleRef: ModuleRef, queues: BullBoardQueueOptions[], board: BullBoardInstance);
+    onModuleInit(): any;
+}

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

@@ -0,0 +1,39 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BullBoardFeatureModule = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const bull_shared_1 = require("@nestjs/bull-shared");
+const bull_board_constants_1 = require("./bull-board.constants");
+let BullBoardFeatureModule = exports.BullBoardFeatureModule = class BullBoardFeatureModule {
+    constructor(moduleRef, queues, board) {
+        this.moduleRef = moduleRef;
+        this.queues = queues;
+        this.board = board;
+    }
+    onModuleInit() {
+        for (const queueOption of this.queues) {
+            const queue = this.moduleRef.get((0, bull_shared_1.getQueueToken)(queueOption.name), { strict: false });
+            const queueAdapter = new queueOption.adapter(queue, queueOption.options);
+            this.board.addQueue(queueAdapter);
+        }
+    }
+};
+exports.BullBoardFeatureModule = BullBoardFeatureModule = __decorate([
+    (0, common_1.Module)({}),
+    __param(1, (0, common_1.Inject)(bull_board_constants_1.BULL_BOARD_QUEUES)),
+    __param(2, (0, common_1.Inject)(bull_board_constants_1.BULL_BOARD_INSTANCE)),
+    __metadata("design:paramtypes", [core_1.ModuleRef, Array, Object])
+], BullBoardFeatureModule);

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

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

package/dist/bull-board.module.js

@@ -0,0 +1,37 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var BullBoardModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BullBoardModule = void 0;
+const common_1 = require("@nestjs/common");
+const bull_board_feature_module_1 = require("./bull-board.feature-module");
+const bull_board_root_module_1 = require("./bull-board.root-module");
+const bull_board_constants_1 = require("./bull-board.constants");
+let BullBoardModule = exports.BullBoardModule = BullBoardModule_1 = class BullBoardModule {
+    static forFeature(...queues) {
+        return {
+            module: bull_board_feature_module_1.BullBoardFeatureModule,
+            providers: [
+                {
+                    provide: bull_board_constants_1.BULL_BOARD_QUEUES,
+                    useValue: queues
+                }
+            ]
+        };
+    }
+    static forRoot(options) {
+        return {
+            module: BullBoardModule_1,
+            imports: [bull_board_root_module_1.BullBoardRootModule.forRoot(options)],
+            exports: [bull_board_root_module_1.BullBoardRootModule],
+        };
+    }
+};
+exports.BullBoardModule = BullBoardModule = BullBoardModule_1 = __decorate([
+    (0, common_1.Module)({})
+], BullBoardModule);

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

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

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

@@ -0,0 +1,84 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var BullBoardRootModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BullBoardRootModule = void 0;
+const common_1 = require("@nestjs/common");
+const api_1 = require("@bull-board/api");
+const bull_board_constants_1 = require("./bull-board.constants");
+const core_1 = require("@nestjs/core");
+const bull_board_util_1 = require("./bull-board.util");
+let BullBoardRootModule = exports.BullBoardRootModule = BullBoardRootModule_1 = class BullBoardRootModule {
+    constructor(adapterHost, adapter, options) {
+        this.adapterHost = adapterHost;
+        this.adapter = adapter;
+        this.options = options;
+    }
+    configure(consumer) {
+        this.adapter.setBasePath(this.options.route);
+        if ((0, bull_board_util_1.isExpressAdapter)(this.adapter)) {
+            return consumer
+                .apply(this.options.middleware, this.adapter.getRouter())
+                .forRoutes(this.options.route);
+        }
+        if ((0, bull_board_util_1.isFastifyAdapter)(this.adapter)) {
+            this.adapterHost.httpAdapter
+                .getInstance()
+                .register(this.adapter.registerPlugin(), { prefix: this.options.route });
+            return consumer
+                .apply(this.options.middleware)
+                .forRoutes(this.options.route);
+        }
+    }
+    static forRoot(options) {
+        const serverAdapter = new options.adapter();
+        const bullBoardProvider = {
+            provide: bull_board_constants_1.BULL_BOARD_INSTANCE,
+            useFactory: () => (0, api_1.createBullBoard)({
+                queues: [],
+                serverAdapter: serverAdapter,
+                options: options.boardOptions,
+            })
+        };
+        const serverAdapterProvider = {
+            provide: bull_board_constants_1.BULL_BOARD_ADAPTER,
+            useFactory: () => serverAdapter
+        };
+        const optionsProvider = {
+            provide: bull_board_constants_1.BULL_BOARD_OPTIONS,
+            useValue: options
+        };
+        return {
+            module: BullBoardRootModule_1,
+            global: true,
+            imports: [],
+            providers: [
+                serverAdapterProvider,
+                optionsProvider,
+                bullBoardProvider
+            ],
+            exports: [
+                serverAdapterProvider,
+                bullBoardProvider,
+                optionsProvider
+            ],
+        };
+    }
+};
+exports.BullBoardRootModule = BullBoardRootModule = BullBoardRootModule_1 = __decorate([
+    (0, common_1.Module)({}),
+    __param(1, (0, common_1.Inject)(bull_board_constants_1.BULL_BOARD_ADAPTER)),
+    __param(2, (0, common_1.Inject)(bull_board_constants_1.BULL_BOARD_OPTIONS)),
+    __metadata("design:paramtypes", [core_1.HttpAdapterHost, Object, Object])
+], BullBoardRootModule);

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

@@ -0,0 +1,28 @@
+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";
+export type BullBoardInstance = ReturnType<typeof createBullBoard>;
+export type BullBoardModuleOptions = {
+    route: string;
+    adapter: {
+        new (): BullBoardServerAdapter;
+    };
+    boardOptions?: BoardOptions;
+    middleware?: any;
+};
+export type BullBoardQueueOptions = {
+    name: string;
+    adapter: {
+        new (queue: any, options?: QueueAdapterOptions): BaseAdapter;
+    };
+    options?: QueueAdapterOptions;
+};
+export type BullBoardServerAdapter = IServerAdapter & {
+    setBasePath(path: string): any;
+};
+export type BullBoardFastifyAdapter = BullBoardServerAdapter & {
+    registerPlugin(): any;
+};
+export type BullBoardExpressAdapter = BullBoardServerAdapter & {
+    getRouter(): any;
+};

package/dist/bull-board.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,3 @@
+import { BullBoardExpressAdapter, BullBoardFastifyAdapter, BullBoardServerAdapter } from "./bull-board.types";
+export declare const isFastifyAdapter: (adapter: BullBoardServerAdapter) => adapter is BullBoardFastifyAdapter;
+export declare const isExpressAdapter: (adapter: BullBoardServerAdapter) => adapter is BullBoardExpressAdapter;

package/dist/bull-board.util.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isExpressAdapter = exports.isFastifyAdapter = void 0;
+const isFastifyAdapter = (adapter) => {
+    return 'registerPlugin' in adapter;
+};
+exports.isFastifyAdapter = isFastifyAdapter;
+const isExpressAdapter = (adapter) => {
+    return 'getRouter' in adapter;
+};
+exports.isExpressAdapter = isExpressAdapter;

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './bull-board.module';
+export * from './bull-board.types';
+export * from './bull-board.constants';
+export * from './bull-board.decorator';

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./bull-board.module"), exports);
+__exportStar(require("./bull-board.types"), exports);
+__exportStar(require("./bull-board.constants"), exports);
+__exportStar(require("./bull-board.decorator"), exports);

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@bull-board/nestjs",
+  "version": "5.3.1",
+  "description": "A NestJS module for Bull-Board dashboard.",
+  "keywords": [
+    "bull",
+    "bullmq",
+    "redis",
+    "queue",
+    "monitoring",
+    "nestjs",
+    "nestjs-module"
+  ],
+  "main": "dist/index.js",
+  "author": "Dennis Snijder <dennis@snijder.io>",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist"
+  },
+  "devDependencies": {
+    "@bull-board/api": "^5.3.1",
+    "@bull-board/express": "^5.3.1",
+    "@bull-board/fastify": "^5.3.1",
+    "@nestjs/bullmq": "^1.1.0",
+    "@nestjs/common": "9.4.2",
+    "@nestjs/core": "9.4.2",
+    "@types/node": "18.16.16",
+    "bull": "^4.10.4",
+    "bullmq": "^3.15.2",
+    "reflect-metadata": "0.1.13",
+    "rxjs": "7.8.1",
+    "typescript": "^5.1.3"
+  },
+  "dependencies": {
+    "@nestjs/bull-shared": "^0.1.3"
+  },
+  "peerDependencies": {
+    "@bull-board/api": "^5.3.1",
+    "@bull-board/express": "^5.3.1",
+    "@nestjs/common": "^8.0.0 || ^9.0.0",
+    "@nestjs/core": "^8.0.0 || ^9.0.0",
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^7.2.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/felixmosh/bull-board.git",
+    "directory": "packages/nestjs"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/bull-board.constants.ts

@@ -0,0 +1,5 @@
+
+export const BULL_BOARD_OPTIONS = 'bull_board_options';
+export const BULL_BOARD_QUEUES = 'bull_board_queues';
+export const BULL_BOARD_ADAPTER = 'bull_board_adapter';
+export const BULL_BOARD_INSTANCE = 'bull_board_instance';

package/src/bull-board.decorator.ts

@@ -0,0 +1,4 @@
+import { Inject } from '@nestjs/common';
+import { BULL_BOARD_INSTANCE } from "./bull-board.constants";
+
+export const InjectBullBoard = (): ParameterDecorator => Inject(BULL_BOARD_INSTANCE);

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

@@ -0,0 +1,25 @@
+import { Inject, Module, OnModuleInit } from "@nestjs/common";
+import { ModuleRef } from "@nestjs/core";
+import { getQueueToken } from "@nestjs/bull-shared";
+import { BullBoardInstance, BullBoardQueueOptions } from "./bull-board.types";
+import { Queue } from "bullmq";
+import { BULL_BOARD_INSTANCE, BULL_BOARD_QUEUES } from "./bull-board.constants";
+
+@Module({})
+export class BullBoardFeatureModule implements OnModuleInit {
+
+  constructor(
+    private readonly moduleRef: ModuleRef,
+    @Inject(BULL_BOARD_QUEUES) private readonly queues: BullBoardQueueOptions[],
+    @Inject(BULL_BOARD_INSTANCE) private readonly board: BullBoardInstance
+  ) {
+  }
+
+  onModuleInit(): any {
+    for (const queueOption of this.queues) {
+      const queue = this.moduleRef.get<Queue>(getQueueToken(queueOption.name), {strict: false});
+      const queueAdapter = new queueOption.adapter(queue, queueOption.options);
+      this.board.addQueue(queueAdapter);
+    }
+  }
+}

package/src/bull-board.module.ts

@@ -0,0 +1,29 @@
+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";
+
+@Module({})
+export class BullBoardModule {
+
+  static forFeature(...queues: BullBoardQueueOptions[]): DynamicModule {
+    return {
+      module: BullBoardFeatureModule,
+      providers: [
+        {
+          provide: BULL_BOARD_QUEUES,
+          useValue: queues
+        }
+      ]
+    };
+  }
+
+  static forRoot(options: BullBoardModuleOptions): DynamicModule {
+    return {
+      module: BullBoardModule,
+      imports: [ BullBoardRootModule.forRoot(options) ],
+      exports: [ BullBoardRootModule ],
+    };
+  }
+}

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

@@ -0,0 +1,76 @@
+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 { HttpAdapterHost } from "@nestjs/core";
+import { isExpressAdapter, isFastifyAdapter } from "./bull-board.util";
+
+@Module({})
+export class BullBoardRootModule implements NestModule {
+
+  constructor(
+    private readonly adapterHost: HttpAdapterHost,
+    @Inject(BULL_BOARD_ADAPTER) private readonly adapter: BullBoardServerAdapter,
+    @Inject(BULL_BOARD_OPTIONS) private readonly options: BullBoardModuleOptions
+  ) {
+  }
+
+  configure(consumer: MiddlewareConsumer): any {
+    this.adapter.setBasePath(this.options.route);
+
+    if (isExpressAdapter(this.adapter)) {
+      return consumer
+        .apply(this.options.middleware, this.adapter.getRouter())
+        .forRoutes(this.options.route);
+    }
+
+    if (isFastifyAdapter(this.adapter)) {
+      this.adapterHost.httpAdapter
+        .getInstance()
+        .register(this.adapter.registerPlugin(), {prefix: this.options.route});
+
+      return consumer
+        .apply(this.options.middleware)
+        .forRoutes(this.options.route);
+    }
+  }
+
+  static forRoot(options: BullBoardModuleOptions): DynamicModule {
+    const serverAdapter = new options.adapter();
+
+    const bullBoardProvider: Provider = {
+      provide: BULL_BOARD_INSTANCE,
+      useFactory: () => createBullBoard({
+        queues: [],
+        serverAdapter: serverAdapter,
+        options: options.boardOptions,
+      })
+    };
+
+    const serverAdapterProvider: Provider = {
+      provide: BULL_BOARD_ADAPTER,
+      useFactory: () => serverAdapter
+    };
+
+    const optionsProvider: Provider = {
+      provide: BULL_BOARD_OPTIONS,
+      useValue: options
+    };
+
+    return {
+      module: BullBoardRootModule,
+      global: true,
+      imports: [],
+      providers: [
+        serverAdapterProvider,
+        optionsProvider,
+        bullBoardProvider
+      ],
+      exports: [
+        serverAdapterProvider,
+        bullBoardProvider,
+        optionsProvider
+      ],
+    };
+  }
+}

package/src/bull-board.types.ts

@@ -0,0 +1,23 @@
+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";
+
+export type BullBoardInstance = ReturnType<typeof createBullBoard>;
+
+export type BullBoardModuleOptions = {
+  route: string;
+  adapter: { new(): BullBoardServerAdapter };
+  boardOptions?: BoardOptions;
+  middleware?: any
+}
+
+export type BullBoardQueueOptions = {
+  name: string;
+  adapter: { new(queue: any, options?: QueueAdapterOptions): BaseAdapter },
+  options?: QueueAdapterOptions,
+};
+
+//create our own types with the needed functions, so we don't need to include express/fastify libraries here.
+export type BullBoardServerAdapter = IServerAdapter & { setBasePath(path: string): any };
+export type BullBoardFastifyAdapter = BullBoardServerAdapter & { registerPlugin(): any };
+export type BullBoardExpressAdapter = BullBoardServerAdapter & { getRouter(): any };

package/src/bull-board.util.ts

@@ -0,0 +1,12 @@
+import {
+  BullBoardExpressAdapter,
+  BullBoardFastifyAdapter, BullBoardServerAdapter,
+} from "./bull-board.types";
+
+export const isFastifyAdapter = (adapter: BullBoardServerAdapter): adapter is BullBoardFastifyAdapter => {
+  return 'registerPlugin' in adapter;
+}
+
+export const isExpressAdapter = (adapter: BullBoardServerAdapter): adapter is BullBoardExpressAdapter => {
+  return 'getRouter' in adapter;
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './bull-board.module';
+export * from './bull-board.types';
+export * from './bull-board.constants';
+export * from './bull-board.decorator';

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "strict": true,
+    "removeComments": false,
+    "noLib": false,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "target": "es6",
+    "sourceMap": false,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "skipLibCheck": true,
+    "useUnknownInCatchVariables": false
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "**/*.spec.ts",
+    "tests",
+  ]
+}