@bull-board/nestjs 8.0.0 → 8.0.1

package/jest.config.js

@@ -0,0 +1,20 @@
+const { defaults: tsJest } = require('ts-jest/presets');
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  transform: {
+    ...tsJest.transform,
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        tsconfig: {
+          experimentalDecorators: true,
+          emitDecoratorMetadata: true,
+          esModuleInterop: true,
+        },
+      },
+    ],
+  },
+  testMatch: ['<rootDir>/tests/**/*.spec.ts'],
+  testTimeout: 30000,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bull-board/nestjs",
-  "version": "8.0.0",
+  "version": "8.0.1",
   "description": "A NestJS module for Bull-Board dashboard.",
   "keywords": [
     "bull",
@@ -24,25 +24,32 @@
   },
   "scripts": {
     "build": "yarn clean && tsc",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist",
+    "test": "jest"
   },
   "devDependencies": {
-    "@bull-board/api": "^8.0.0",
-    "@bull-board/express": "^8.0.0",
-    "@bull-board/fastify": "^8.0.0",
+    "@bull-board/api": "^8.0.1",
+    "@bull-board/express": "^8.0.1",
+    "@bull-board/fastify": "^8.0.1",
+    "@bull-board/test-utils": "workspace:*",
     "@nestjs/bull-shared": "^11.0.4",
     "@nestjs/bullmq": "^11.0.4",
     "@nestjs/common": "^11.1.24",
     "@nestjs/core": "^11.1.24",
+    "@nestjs/platform-express": "^11.0.0",
     "@types/node": "^22.19.20",
+    "@types/supertest": "^6.0.2",
     "bull": "^4.16.5",
     "bullmq": "^5.78.0",
+    "jest": "^30.0.0",
     "reflect-metadata": "^0.2.2",
     "rxjs": "^7.8.2",
+    "supertest": "^7.0.0",
+    "ts-jest": "^29.0.0",
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@bull-board/api": "^8.0.0",
+    "@bull-board/api": "^8.0.1",
     "@nestjs/bull-shared": "^10.0.0 || ^11.0.0",
     "@nestjs/common": "^9.0.0 || ^10.0.0 || ^11.0.0",
     "@nestjs/core": "^9.0.0 || ^10.0.0 || ^11.0.0",

package/tests/contract.spec.ts

@@ -0,0 +1,50 @@
+import 'reflect-metadata';
+import { ExpressAdapter as BullBoardExpressAdapter } from '@bull-board/express';
+import {
+  runServerAdapterContract,
+  uiFixtureBasePath,
+  NormalizedResponse,
+  ContractRequest,
+} from '@bull-board/test-utils';
+import { NestFactory } from '@nestjs/core';
+import { ExpressAdapter } from '@nestjs/platform-express';
+import { json } from 'express';
+import request from 'supertest';
+import { BullBoardModule } from '../src';
+import { BULL_BOARD_INSTANCE } from '../src/bull-board.constants';
+import type { BullBoardInstance } from '../src/bull-board.types';
+
+runServerAdapterContract('NestJS', async ({ basePath, queue }) => {
+  const nestExpressAdapter = new ExpressAdapter();
+
+  const route = basePath || '/';
+
+  const appModule = BullBoardModule.forRoot({
+    route,
+    adapter: BullBoardExpressAdapter,
+    boardOptions: { uiBasePath: uiFixtureBasePath },
+    middleware: json(),
+  });
+
+  const app = await NestFactory.create(appModule, nestExpressAdapter, { logger: false });
+  await app.init();
+
+  const board = app.get<BullBoardInstance>(BULL_BOARD_INSTANCE);
+  board.addQueue(queue.adapter);
+
+  const send = async (req: ContractRequest): Promise<NormalizedResponse> => {
+    const agent = request(app.getHttpServer());
+    const m = req.method.toLowerCase() as 'get' | 'post' | 'put' | 'delete';
+    let r = agent[m](req.path);
+    if (req.body !== undefined) r = r.send(req.body as object);
+    const res = await r;
+    return { status: res.status, headers: res.headers as any, text: res.text };
+  };
+
+  return {
+    request: send,
+    teardown: async () => {
+      await app.close();
+    },
+  };
+});