@backstage/plugin-signals-backend 0.0.0-nightly-20240118021622

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @backstage/plugin-signals-backend
+
+## 0.0.0-nightly-20240118021622
+
+### Patch Changes
+
+- 047bead: Add support to subscribe and publish messages through signals plugins
+- Updated dependencies
+  - @backstage/plugin-signals-node@0.0.0-nightly-20240118021622
+  - @backstage/backend-common@0.0.0-nightly-20240118021622
+  - @backstage/config@1.1.1
+  - @backstage/plugin-auth-node@0.0.0-nightly-20240118021622
+  - @backstage/backend-plugin-api@0.0.0-nightly-20240118021622
+  - @backstage/types@1.1.1
+  - @backstage/plugin-events-node@0.0.0-nightly-20240118021622

package/README.md

@@ -0,0 +1,45 @@
+# signals
+
+Welcome to the signals backend plugin!
+
+Signals plugin allows backend plugins to publish messages to frontend plugins.
+
+## Getting started
+
+First install the `@backstage/plugin-signals-node` plugin to get the `SignalService` set up.
+
+Next, add Signals router to your backend in `packages/backend/src/plugins/signals.ts`:
+
+```ts
+import { Router } from 'express';
+import { createRouter } from '@backstage/plugin-signals-backend';
+import { PluginEnvironment } from '../types';
+
+export default async function createPlugin(
+  env: PluginEnvironment,
+): Promise<Router> {
+  return await createRouter({
+    logger: env.logger,
+    eventBroker: env.eventBroker,
+    identity: env.identity,
+  });
+}
+```
+
+Now add the signals to `packages/backend/src/index.ts`:
+
+```ts
+// ...
+import signals from './plugins/signals';
+
+async function main() {
+  // ...
+  const signalsEnv = useHotMemoize(module, () => createEnv('signals'));
+
+  const apiRouter = Router();
+  // ...
+  apiRouter.use('/signals', await signals(signalsEnv));
+  apiRouter.use(notFoundHandler());
+  // ...
+}
+```

package/dist/index.cjs.js

@@ -0,0 +1,193 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendCommon = require('@backstage/backend-common');
+var express = require('express');
+var Router = require('express-promise-router');
+var ws = require('ws');
+var uuid = require('uuid');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
+var Router__default = /*#__PURE__*/_interopDefaultLegacy(Router);
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class SignalManager {
+  constructor(options) {
+    __publicField(this, "connections", /* @__PURE__ */ new Map());
+    __publicField(this, "eventBroker");
+    __publicField(this, "logger");
+    var _a;
+    ({ eventBroker: this.eventBroker, logger: this.logger } = options);
+    (_a = this.eventBroker) == null ? void 0 : _a.subscribe({
+      supportsEventTopics: () => ["signals"],
+      onEvent: (params) => this.onEventBrokerEvent(params)
+    });
+  }
+  static create(options) {
+    return new SignalManager(options);
+  }
+  addConnection(ws, identity) {
+    var _a, _b;
+    const id = uuid.v4();
+    const conn = {
+      id,
+      user: (_a = identity == null ? void 0 : identity.identity.userEntityRef) != null ? _a : "user:default/guest",
+      ws,
+      ownershipEntityRefs: (_b = identity == null ? void 0 : identity.identity.ownershipEntityRefs) != null ? _b : [],
+      subscriptions: /* @__PURE__ */ new Set()
+    };
+    this.connections.set(id, conn);
+    ws.on("error", (err) => {
+      this.logger.info(
+        `Error occurred with connection ${id}: ${err}, closing connection`
+      );
+      ws.close();
+      this.connections.delete(id);
+    });
+    ws.on("close", (code, reason) => {
+      this.logger.info(
+        `Connection ${id} closed with code ${code}, reason: ${reason}`
+      );
+      this.connections.delete(id);
+    });
+    ws.on("message", (data, isBinary) => {
+      this.logger.debug(`Received message from connection ${id}: ${data}`);
+      if (isBinary) {
+        return;
+      }
+      try {
+        const json = JSON.parse(data.toString());
+        this.handleMessage(conn, json);
+      } catch (err) {
+        this.logger.error(
+          `Invalid message received from connection ${id}: ${err}`
+        );
+      }
+    });
+  }
+  handleMessage(connection, message) {
+    if (message.action === "subscribe" && message.channel) {
+      this.logger.info(
+        `Connection ${connection.id} subscribed to ${message.channel}`
+      );
+      connection.subscriptions.add(message.channel);
+    } else if (message.action === "unsubscribe" && message.channel) {
+      this.logger.info(
+        `Connection ${connection.id} unsubscribed from ${message.channel}`
+      );
+      connection.subscriptions.delete(message.channel);
+    }
+  }
+  async onEventBrokerEvent(params) {
+    const { eventPayload } = params;
+    if (!eventPayload.channel || !eventPayload.message) {
+      return;
+    }
+    const { channel, recipients, message } = eventPayload;
+    const jsonMessage = JSON.stringify({ channel, message });
+    this.connections.forEach((conn) => {
+      if (!conn.subscriptions.has(channel)) {
+        return;
+      }
+      if (recipients !== null && !conn.ownershipEntityRefs.some(
+        (ref) => recipients.includes(ref)
+      )) {
+        return;
+      }
+      if (conn.ws.readyState !== ws.WebSocket.OPEN) {
+        return;
+      }
+      conn.ws.send(jsonMessage, (err) => {
+        if (err) {
+          this.logger.error(`Failed to send message to ${conn.id}: ${err}`);
+        }
+      });
+    });
+  }
+}
+
+async function createRouter(options) {
+  const { logger, identity } = options;
+  const manager = SignalManager.create(options);
+  let subscribedToUpgradeRequests = false;
+  const webSocketServer = new ws.WebSocketServer({
+    noServer: true,
+    clientTracking: false
+  });
+  const upgradeMiddleware = async (req, _, next) => {
+    var _a;
+    const server = (_a = req.socket) == null ? void 0 : _a.server;
+    if (subscribedToUpgradeRequests || !server || !req.headers || req.headers.upgrade === void 0 || req.headers.upgrade.toLowerCase() !== "websocket") {
+      next();
+      return;
+    }
+    subscribedToUpgradeRequests = true;
+    server.on("upgrade", async (request, socket, head) => {
+      if (request.url !== "/api/signals") {
+        return;
+      }
+      let userIdentity = void 0;
+      const token = req.headers["sec-websocket-protocol"];
+      if (token) {
+        userIdentity = await identity.getIdentity({
+          request: {
+            headers: { authorization: token }
+          }
+        });
+      }
+      webSocketServer.handleUpgrade(
+        request,
+        socket,
+        head,
+        (ws, __) => {
+          manager.addConnection(ws, userIdentity);
+        }
+      );
+    });
+  };
+  const router = Router__default["default"]();
+  router.use(express__default["default"].json());
+  router.use(upgradeMiddleware);
+  router.get("/health", (_, response) => {
+    logger.info("PONG!");
+    response.json({ status: "ok" });
+  });
+  router.use(backendCommon.errorHandler());
+  return router;
+}
+
+const signalsPlugin = backendPluginApi.createBackendPlugin({
+  pluginId: "signals",
+  register(env) {
+    env.registerInit({
+      deps: {
+        httpRouter: backendPluginApi.coreServices.httpRouter,
+        logger: backendPluginApi.coreServices.logger,
+        identity: backendPluginApi.coreServices.identity
+        // TODO: EventBroker. It is optional for now but it's actually required so waiting for the new backend system
+        //       for the events-backend for this to work.
+      },
+      async init({ httpRouter, logger, identity }) {
+        httpRouter.use(
+          await createRouter({
+            logger,
+            identity
+          })
+        );
+      }
+    });
+  }
+});
+
+exports.createRouter = createRouter;
+exports["default"] = signalsPlugin;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/service/SignalManager.ts","../src/service/router.ts","../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { EventBroker, EventParams } from '@backstage/plugin-events-node';\nimport { SignalPayload } from '@backstage/plugin-signals-node';\nimport { RawData, WebSocket } from 'ws';\nimport { v4 as uuid } from 'uuid';\nimport { JsonObject } from '@backstage/types';\nimport { BackstageIdentityResponse } from '@backstage/plugin-auth-node';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\n/**\n * @internal\n */\nexport type SignalConnection = {\n  id: string;\n  user: string;\n  ws: WebSocket;\n  ownershipEntityRefs: string[];\n  subscriptions: Set<string>;\n};\n\n/**\n * @internal\n */\nexport type SignalManagerOptions = {\n  // TODO: Remove optional when events-backend can offer this service\n  eventBroker?: EventBroker;\n  logger: LoggerService;\n};\n\n/** @internal */\nexport class SignalManager {\n  private connections: Map<string, SignalConnection> = new Map<\n    string,\n    SignalConnection\n  >();\n  private eventBroker?: EventBroker;\n  private logger: LoggerService;\n\n  static create(options: SignalManagerOptions) {\n    return new SignalManager(options);\n  }\n\n  private constructor(options: SignalManagerOptions) {\n    ({ eventBroker: this.eventBroker, logger: this.logger } = options);\n\n    this.eventBroker?.subscribe({\n      supportsEventTopics: () => ['signals'],\n      onEvent: (params: EventParams<SignalPayload>) =>\n        this.onEventBrokerEvent(params),\n    });\n  }\n\n  addConnection(ws: WebSocket, identity?: BackstageIdentityResponse) {\n    const id = uuid();\n\n    const conn = {\n      id,\n      user: identity?.identity.userEntityRef ?? 'user:default/guest',\n      ws,\n      ownershipEntityRefs: identity?.identity.ownershipEntityRefs ?? [],\n      subscriptions: new Set<string>(),\n    };\n\n    this.connections.set(id, conn);\n\n    ws.on('error', (err: Error) => {\n      this.logger.info(\n        `Error occurred with connection ${id}: ${err}, closing connection`,\n      );\n      ws.close();\n      this.connections.delete(id);\n    });\n\n    ws.on('close', (code: number, reason: Buffer) => {\n      this.logger.info(\n        `Connection ${id} closed with code ${code}, reason: ${reason}`,\n      );\n      this.connections.delete(id);\n    });\n\n    ws.on('message', (data: RawData, isBinary: boolean) => {\n      this.logger.debug(`Received message from connection ${id}: ${data}`);\n      if (isBinary) {\n        return;\n      }\n      try {\n        const json = JSON.parse(data.toString()) as JsonObject;\n        this.handleMessage(conn, json);\n      } catch (err: any) {\n        this.logger.error(\n          `Invalid message received from connection ${id}: ${err}`,\n        );\n      }\n    });\n  }\n\n  private handleMessage(connection: SignalConnection, message: JsonObject) {\n    if (message.action === 'subscribe' && message.channel) {\n      this.logger.info(\n        `Connection ${connection.id} subscribed to ${message.channel}`,\n      );\n      connection.subscriptions.add(message.channel as string);\n    } else if (message.action === 'unsubscribe' && message.channel) {\n      this.logger.info(\n        `Connection ${connection.id} unsubscribed from ${message.channel}`,\n      );\n      connection.subscriptions.delete(message.channel as string);\n    }\n  }\n\n  private async onEventBrokerEvent(\n    params: EventParams<SignalPayload>,\n  ): Promise<void> {\n    const { eventPayload } = params;\n    if (!eventPayload.channel || !eventPayload.message) {\n      return;\n    }\n\n    const { channel, recipients, message } = eventPayload;\n    const jsonMessage = JSON.stringify({ channel, message });\n\n    // Actual websocket message sending\n    this.connections.forEach(conn => {\n      if (!conn.subscriptions.has(channel)) {\n        return;\n      }\n      // Sending to all users can be done with null\n      if (\n        recipients !== null &&\n        !conn.ownershipEntityRefs.some((ref: string) =>\n          recipients.includes(ref),\n        )\n      ) {\n        return;\n      }\n\n      if (conn.ws.readyState !== WebSocket.OPEN) {\n        return;\n      }\n\n      conn.ws.send(jsonMessage, err => {\n        if (err) {\n          this.logger.error(`Failed to send message to ${conn.id}: ${err}`);\n        }\n      });\n    });\n  }\n}\n","/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { errorHandler } from '@backstage/backend-common';\nimport express, { NextFunction, Request, Response } from 'express';\nimport Router from 'express-promise-router';\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport * as https from 'https';\nimport http, { IncomingMessage } from 'http';\nimport { SignalManager } from './SignalManager';\nimport {\n  BackstageIdentityResponse,\n  IdentityApi,\n  IdentityApiGetIdentityRequest,\n} from '@backstage/plugin-auth-node';\nimport { EventBroker } from '@backstage/plugin-events-node';\nimport { WebSocket, WebSocketServer } from 'ws';\n\n/** @public */\nexport interface RouterOptions {\n  logger: LoggerService;\n  eventBroker?: EventBroker;\n  identity: IdentityApi;\n}\n\n/** @public */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  const { logger, identity } = options;\n  const manager = SignalManager.create(options);\n  let subscribedToUpgradeRequests = false;\n\n  const webSocketServer = new WebSocketServer({\n    noServer: true,\n    clientTracking: false,\n  });\n\n  const upgradeMiddleware = async (\n    req: Request,\n    _: Response,\n    next: NextFunction,\n  ) => {\n    const server: https.Server | http.Server = (req.socket as any)?.server;\n    if (\n      subscribedToUpgradeRequests ||\n      !server ||\n      !req.headers ||\n      req.headers.upgrade === undefined ||\n      req.headers.upgrade.toLowerCase() !== 'websocket'\n    ) {\n      next();\n      return;\n    }\n\n    subscribedToUpgradeRequests = true;\n    server.on('upgrade', async (request, socket, head) => {\n      // TODO: Find a way to make this more generic\n      if (request.url !== '/api/signals') {\n        return;\n      }\n\n      let userIdentity: BackstageIdentityResponse | undefined = undefined;\n\n      // Authentication token is passed in Sec-WebSocket-Protocol header as there\n      // is no other way to pass the token with plain websockets\n      const token = req.headers['sec-websocket-protocol'];\n      if (token) {\n        userIdentity = await identity.getIdentity({\n          request: {\n            headers: { authorization: token },\n          },\n        } as IdentityApiGetIdentityRequest);\n      }\n\n      webSocketServer.handleUpgrade(\n        request,\n        socket,\n        head,\n        (ws: WebSocket, __: IncomingMessage) => {\n          manager.addConnection(ws, userIdentity);\n        },\n      );\n    });\n  };\n\n  const router = Router();\n  router.use(express.json());\n  router.use(upgradeMiddleware);\n\n  router.get('/health', (_, response) => {\n    logger.info('PONG!');\n    response.json({ status: 'ok' });\n  });\n\n  router.use(errorHandler());\n  return router;\n}\n","/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\n\n/**\n * Signals backend plugin\n *\n * @public\n */\nexport const signalsPlugin = createBackendPlugin({\n  pluginId: 'signals',\n  register(env) {\n    env.registerInit({\n      deps: {\n        httpRouter: coreServices.httpRouter,\n        logger: coreServices.logger,\n        identity: coreServices.identity,\n        // TODO: EventBroker. It is optional for now but it's actually required so waiting for the new backend system\n        //       for the events-backend for this to work.\n      },\n      async init({ httpRouter, logger, identity }) {\n        httpRouter.use(\n          await createRouter({\n            logger,\n            identity,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["uuid","WebSocket","WebSocketServer","Router","express","errorHandler","createBackendPlugin","coreServices"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AA4CO,MAAM,aAAc,CAAA;AAAA,EAYjB,YAAY,OAA+B,EAAA;AAXnD,IAAQ,aAAA,CAAA,IAAA,EAAA,aAAA,sBAAiD,GAGvD,EAAA,CAAA,CAAA;AACF,IAAQ,aAAA,CAAA,IAAA,EAAA,aAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,QAAA,CAAA,CAAA;AAlDV,IAAA,IAAA,EAAA,CAAA;AAyDI,IAAA,CAAC,EAAE,WAAa,EAAA,IAAA,CAAK,aAAa,MAAQ,EAAA,IAAA,CAAK,QAAW,GAAA,OAAA,EAAA;AAE1D,IAAK,CAAA,EAAA,GAAA,IAAA,CAAA,WAAA,KAAL,mBAAkB,SAAU,CAAA;AAAA,MAC1B,mBAAA,EAAqB,MAAM,CAAC,SAAS,CAAA;AAAA,MACrC,OAAS,EAAA,CAAC,MACR,KAAA,IAAA,CAAK,mBAAmB,MAAM,CAAA;AAAA,KAClC,CAAA,CAAA;AAAA,GACF;AAAA,EAZA,OAAO,OAAO,OAA+B,EAAA;AAC3C,IAAO,OAAA,IAAI,cAAc,OAAO,CAAA,CAAA;AAAA,GAClC;AAAA,EAYA,aAAA,CAAc,IAAe,QAAsC,EAAA;AAlErE,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAmEI,IAAA,MAAM,KAAKA,OAAK,EAAA,CAAA;AAEhB,IAAA,MAAM,IAAO,GAAA;AAAA,MACX,EAAA;AAAA,MACA,IAAM,EAAA,CAAA,EAAA,GAAA,QAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,QAAA,CAAU,QAAS,CAAA,aAAA,KAAnB,IAAoC,GAAA,EAAA,GAAA,oBAAA;AAAA,MAC1C,EAAA;AAAA,MACA,mBAAqB,EAAA,CAAA,EAAA,GAAA,QAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,QAAA,CAAU,QAAS,CAAA,mBAAA,KAAnB,YAA0C,EAAC;AAAA,MAChE,aAAA,sBAAmB,GAAY,EAAA;AAAA,KACjC,CAAA;AAEA,IAAK,IAAA,CAAA,WAAA,CAAY,GAAI,CAAA,EAAA,EAAI,IAAI,CAAA,CAAA;AAE7B,IAAG,EAAA,CAAA,EAAA,CAAG,OAAS,EAAA,CAAC,GAAe,KAAA;AAC7B,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,QACV,CAAA,+BAAA,EAAkC,EAAE,CAAA,EAAA,EAAK,GAAG,CAAA,oBAAA,CAAA;AAAA,OAC9C,CAAA;AACA,MAAA,EAAA,CAAG,KAAM,EAAA,CAAA;AACT,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA,CAAA;AAAA,KAC3B,CAAA,CAAA;AAED,IAAA,EAAA,CAAG,EAAG,CAAA,OAAA,EAAS,CAAC,IAAA,EAAc,MAAmB,KAAA;AAC/C,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,QACV,CAAc,WAAA,EAAA,EAAE,CAAqB,kBAAA,EAAA,IAAI,aAAa,MAAM,CAAA,CAAA;AAAA,OAC9D,CAAA;AACA,MAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA,CAAA;AAAA,KAC3B,CAAA,CAAA;AAED,IAAA,EAAA,CAAG,EAAG,CAAA,SAAA,EAAW,CAAC,IAAA,EAAe,QAAsB,KAAA;AACrD,MAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,iCAAA,EAAoC,EAAE,CAAA,EAAA,EAAK,IAAI,CAAE,CAAA,CAAA,CAAA;AACnE,MAAA,IAAI,QAAU,EAAA;AACZ,QAAA,OAAA;AAAA,OACF;AACA,MAAI,IAAA;AACF,QAAA,MAAM,IAAO,GAAA,IAAA,CAAK,KAAM,CAAA,IAAA,CAAK,UAAU,CAAA,CAAA;AACvC,QAAK,IAAA,CAAA,aAAA,CAAc,MAAM,IAAI,CAAA,CAAA;AAAA,eACtB,GAAU,EAAA;AACjB,QAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,UACV,CAAA,yCAAA,EAA4C,EAAE,CAAA,EAAA,EAAK,GAAG,CAAA,CAAA;AAAA,SACxD,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,aAAA,CAAc,YAA8B,OAAqB,EAAA;AACvE,IAAA,IAAI,OAAQ,CAAA,MAAA,KAAW,WAAe,IAAA,OAAA,CAAQ,OAAS,EAAA;AACrD,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,QACV,CAAc,WAAA,EAAA,UAAA,CAAW,EAAE,CAAA,eAAA,EAAkB,QAAQ,OAAO,CAAA,CAAA;AAAA,OAC9D,CAAA;AACA,MAAW,UAAA,CAAA,aAAA,CAAc,GAAI,CAAA,OAAA,CAAQ,OAAiB,CAAA,CAAA;AAAA,KAC7C,MAAA,IAAA,OAAA,CAAQ,MAAW,KAAA,aAAA,IAAiB,QAAQ,OAAS,EAAA;AAC9D,MAAA,IAAA,CAAK,MAAO,CAAA,IAAA;AAAA,QACV,CAAc,WAAA,EAAA,UAAA,CAAW,EAAE,CAAA,mBAAA,EAAsB,QAAQ,OAAO,CAAA,CAAA;AAAA,OAClE,CAAA;AACA,MAAW,UAAA,CAAA,aAAA,CAAc,MAAO,CAAA,OAAA,CAAQ,OAAiB,CAAA,CAAA;AAAA,KAC3D;AAAA,GACF;AAAA,EAEA,MAAc,mBACZ,MACe,EAAA;AACf,IAAM,MAAA,EAAE,cAAiB,GAAA,MAAA,CAAA;AACzB,IAAA,IAAI,CAAC,YAAA,CAAa,OAAW,IAAA,CAAC,aAAa,OAAS,EAAA;AAClD,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,MAAM,EAAE,OAAA,EAAS,UAAY,EAAA,OAAA,EAAY,GAAA,YAAA,CAAA;AACzC,IAAA,MAAM,cAAc,IAAK,CAAA,SAAA,CAAU,EAAE,OAAA,EAAS,SAAS,CAAA,CAAA;AAGvD,IAAK,IAAA,CAAA,WAAA,CAAY,QAAQ,CAAQ,IAAA,KAAA;AAC/B,MAAA,IAAI,CAAC,IAAA,CAAK,aAAc,CAAA,GAAA,CAAI,OAAO,CAAG,EAAA;AACpC,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,IACE,UAAe,KAAA,IAAA,IACf,CAAC,IAAA,CAAK,mBAAoB,CAAA,IAAA;AAAA,QAAK,CAAC,GAAA,KAC9B,UAAW,CAAA,QAAA,CAAS,GAAG,CAAA;AAAA,OAEzB,EAAA;AACA,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,IAAI,IAAK,CAAA,EAAA,CAAG,UAAe,KAAAC,YAAA,CAAU,IAAM,EAAA;AACzC,QAAA,OAAA;AAAA,OACF;AAEA,MAAK,IAAA,CAAA,EAAA,CAAG,IAAK,CAAA,WAAA,EAAa,CAAO,GAAA,KAAA;AAC/B,QAAA,IAAI,GAAK,EAAA;AACP,UAAA,IAAA,CAAK,OAAO,KAAM,CAAA,CAAA,0BAAA,EAA6B,KAAK,EAAE,CAAA,EAAA,EAAK,GAAG,CAAE,CAAA,CAAA,CAAA;AAAA,SAClE;AAAA,OACD,CAAA,CAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACH;AACF;;AC3HA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAM,MAAA,EAAE,MAAQ,EAAA,QAAA,EAAa,GAAA,OAAA,CAAA;AAC7B,EAAM,MAAA,OAAA,GAAU,aAAc,CAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAC5C,EAAA,IAAI,2BAA8B,GAAA,KAAA,CAAA;AAElC,EAAM,MAAA,eAAA,GAAkB,IAAIC,kBAAgB,CAAA;AAAA,IAC1C,QAAU,EAAA,IAAA;AAAA,IACV,cAAgB,EAAA,KAAA;AAAA,GACjB,CAAA,CAAA;AAED,EAAA,MAAM,iBAAoB,GAAA,OACxB,GACA,EAAA,CAAA,EACA,IACG,KAAA;AAtDP,IAAA,IAAA,EAAA,CAAA;AAuDI,IAAM,MAAA,MAAA,GAAA,CAAsC,EAAI,GAAA,GAAA,CAAA,MAAA,KAAJ,IAAoB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,MAAA,CAAA;AAChE,IAAA,IACE,2BACA,IAAA,CAAC,MACD,IAAA,CAAC,IAAI,OACL,IAAA,GAAA,CAAI,OAAQ,CAAA,OAAA,KAAY,UACxB,GAAI,CAAA,OAAA,CAAQ,OAAQ,CAAA,WAAA,OAAkB,WACtC,EAAA;AACA,MAAK,IAAA,EAAA,CAAA;AACL,MAAA,OAAA;AAAA,KACF;AAEA,IAA8B,2BAAA,GAAA,IAAA,CAAA;AAC9B,IAAA,MAAA,CAAO,EAAG,CAAA,SAAA,EAAW,OAAO,OAAA,EAAS,QAAQ,IAAS,KAAA;AAEpD,MAAI,IAAA,OAAA,CAAQ,QAAQ,cAAgB,EAAA;AAClC,QAAA,OAAA;AAAA,OACF;AAEA,MAAA,IAAI,YAAsD,GAAA,KAAA,CAAA,CAAA;AAI1D,MAAM,MAAA,KAAA,GAAQ,GAAI,CAAA,OAAA,CAAQ,wBAAwB,CAAA,CAAA;AAClD,MAAA,IAAI,KAAO,EAAA;AACT,QAAe,YAAA,GAAA,MAAM,SAAS,WAAY,CAAA;AAAA,UACxC,OAAS,EAAA;AAAA,YACP,OAAA,EAAS,EAAE,aAAA,EAAe,KAAM,EAAA;AAAA,WAClC;AAAA,SACgC,CAAA,CAAA;AAAA,OACpC;AAEA,MAAgB,eAAA,CAAA,aAAA;AAAA,QACd,OAAA;AAAA,QACA,MAAA;AAAA,QACA,IAAA;AAAA,QACA,CAAC,IAAe,EAAwB,KAAA;AACtC,UAAQ,OAAA,CAAA,aAAA,CAAc,IAAI,YAAY,CAAA,CAAA;AAAA,SACxC;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH,CAAA;AAEA,EAAA,MAAM,SAASC,0BAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,2BAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AACzB,EAAA,MAAA,CAAO,IAAI,iBAAiB,CAAA,CAAA;AAE5B,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,CAAC,CAAA,EAAG,QAAa,KAAA;AACrC,IAAA,MAAA,CAAO,KAAK,OAAO,CAAA,CAAA;AACnB,IAAA,QAAA,CAAS,IAAK,CAAA,EAAE,MAAQ,EAAA,IAAA,EAAM,CAAA,CAAA;AAAA,GAC/B,CAAA,CAAA;AAED,EAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AACzB,EAAO,OAAA,MAAA,CAAA;AACT;;ACnFO,MAAM,gBAAgBC,oCAAoB,CAAA;AAAA,EAC/C,QAAU,EAAA,SAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,YAAYC,6BAAa,CAAA,UAAA;AAAA,QACzB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,UAAUA,6BAAa,CAAA,QAAA;AAAA;AAAA;AAAA,OAGzB;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,UAAY,EAAA,MAAA,EAAQ,UAAY,EAAA;AAC3C,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAM,YAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,QAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import express from 'express';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { LoggerService } from '@backstage/backend-plugin-api';
+import { IdentityApi } from '@backstage/plugin-auth-node';
+import { EventBroker } from '@backstage/plugin-events-node';
+
+/** @public */
+interface RouterOptions {
+    logger: LoggerService;
+    eventBroker?: EventBroker;
+    identity: IdentityApi;
+}
+/** @public */
+declare function createRouter(options: RouterOptions): Promise<express.Router>;
+
+/**
+ * Signals backend plugin
+ *
+ * @public
+ */
+declare const signalsPlugin: () => _backstage_backend_plugin_api.BackendFeature;
+
+export { RouterOptions, createRouter, signalsPlugin as default };

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@backstage/plugin-signals-backend",
+  "version": "0.0.0-nightly-20240118021622",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "backend-plugin"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.0.0-nightly-20240118021622",
+    "@backstage/backend-plugin-api": "^0.0.0-nightly-20240118021622",
+    "@backstage/config": "^1.1.1",
+    "@backstage/plugin-auth-node": "^0.0.0-nightly-20240118021622",
+    "@backstage/plugin-events-node": "^0.0.0-nightly-20240118021622",
+    "@backstage/plugin-signals-node": "^0.0.0-nightly-20240118021622",
+    "@backstage/types": "^1.1.1",
+    "@types/express": "*",
+    "express": "^4.17.1",
+    "express-promise-router": "^4.1.0",
+    "http-proxy-middleware": "^2.0.0",
+    "node-fetch": "^2.6.7",
+    "uuid": "^8.0.0",
+    "winston": "^3.2.1",
+    "ws": "^8.14.2",
+    "yn": "^4.0.0"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.0.0-nightly-20240118021622",
+    "@types/supertest": "^2.0.8",
+    "msw": "^1.0.0",
+    "supertest": "^6.2.4"
+  },
+  "files": [
+    "dist"
+  ]
+}