@midwayjs/bull-board 3.0.0

package/README.md

@@ -0,0 +1,9 @@
+# @midwayjs/bull-board
+
+this is a sub package for midway.
+
+Document: [https://midwayjs.org](https://midwayjs.org)
+
+## License
+
+[MIT]((http://github.com/midwayjs/midway/blob/master/LICENSE))

package/dist/configuration.d.ts

@@ -0,0 +1,12 @@
+import * as bull from '@midwayjs/bull';
+import { MidwayApplicationManager } from '@midwayjs/core';
+export declare class BullBoardConfiguration {
+    framework: bull.Framework;
+    applicationManager: MidwayApplicationManager;
+    bullBoardConfig: {
+        basePath?: string;
+        adapterOptions?: any;
+    };
+    onReady(): Promise<void>;
+}
+//# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -0,0 +1,78 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BullBoardConfiguration = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const bull = require("@midwayjs/bull");
+const core_1 = require("@midwayjs/core");
+const api_1 = require("@bull-board/api");
+const bullAdapter_1 = require("@bull-board/api/bullAdapter");
+const express_1 = require("@bull-board/express");
+const koa_1 = require("@bull-board/koa");
+let BullBoardConfiguration = class BullBoardConfiguration {
+    async onReady() {
+        const queueList = this.framework.getQueueList();
+        const wrapQueues = queueList.map(queue => new bullAdapter_1.BullAdapter(queue));
+        const basePath = this.bullBoardConfig.basePath;
+        const expressApp = this.applicationManager.getApplication('express');
+        if (expressApp) {
+            const serverAdapter = new express_1.ExpressAdapter();
+            (0, api_1.createBullBoard)({
+                queues: wrapQueues,
+                serverAdapter,
+            });
+            serverAdapter.setBasePath(basePath);
+            expressApp['originUse'](basePath, serverAdapter.getRouter());
+        }
+        const apps = this.applicationManager.getApplications(['egg', 'koa']);
+        for (const app of apps) {
+            const serverAdapter = new koa_1.KoaAdapter();
+            (0, api_1.createBullBoard)({
+                queues: wrapQueues,
+                serverAdapter,
+            });
+            serverAdapter.setBasePath(basePath);
+            await app.useMiddleware(serverAdapter.registerPlugin());
+        }
+    }
+};
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", bull.Framework)
+], BullBoardConfiguration.prototype, "framework", void 0);
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", core_1.MidwayApplicationManager)
+], BullBoardConfiguration.prototype, "applicationManager", void 0);
+__decorate([
+    (0, decorator_1.Config)('bullBoard'),
+    __metadata("design:type", Object)
+], BullBoardConfiguration.prototype, "bullBoardConfig", void 0);
+BullBoardConfiguration = __decorate([
+    (0, decorator_1.Configuration)({
+        namespace: 'bull-board',
+        imports: [bull],
+        importConfigs: [
+            {
+                default: {
+                    bullBoard: {
+                        basePath: 'ui',
+                        adapterOptions: {
+                            readOnlyMode: false,
+                        },
+                    },
+                },
+            },
+        ],
+    })
+], BullBoardConfiguration);
+exports.BullBoardConfiguration = BullBoardConfiguration;
+//# sourceMappingURL=configuration.js.map

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { BullBoardConfiguration as Configuration } from './configuration';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Configuration = void 0;
+var configuration_1 = require("./configuration");
+Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.BullBoardConfiguration; } });
+//# sourceMappingURL=index.js.map

package/index.d.ts

@@ -0,0 +1,12 @@
+import { QueueAdapterOptions } from '@bull-board/api/dist/typings/app';
+export * from './dist/index';
+
+declare module '@midwayjs/core/dist/interface' {
+  // eslint-disable-next-line
+  interface MidwayConfig {
+    bullBoard?: {
+      basePath?: string;
+      adapterOptions?: QueueAdapterOptions;
+    };
+  }
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@midwayjs/bull-board",
+  "version": "3.0.0",
+  "description": "midway component for bull",
+  "main": "dist/index.js",
+  "typings": "index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit"
+  },
+  "keywords": [
+    "midway",
+    "IoC",
+    "bull",
+    "bull-ui",
+    "plugin"
+  ],
+  "author": "",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "index.d.ts"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@midwayjs/core": "^3.4.13",
+    "@midwayjs/decorator": "^3.4.11",
+    "@midwayjs/mock": "^3.4.13"
+  },
+  "dependencies": {
+    "@bull-board/api": "4.3.1",
+    "@bull-board/express": "4.3.1",
+    "@bull-board/koa": "4.3.1",
+    "@midwayjs/bull": "^3.0.3"
+  },
+  "engines": {
+    "node": ">=12"
+  }
+}