@backstage/plugin-signals-node 0.0.1-next.1 → 0.0.1-next.3

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @backstage/plugin-signals-node
 
+## 0.0.1-next.3
+
+### Patch Changes
+
+- 8472188: Added or fixed the `repository` field in `package.json`.
+- 1ab22c4: Allow defining signal type to publish and receive
+- Updated dependencies
+  - @backstage/backend-common@0.21.0-next.3
+  - @backstage/plugin-auth-node@0.4.4-next.3
+  - @backstage/backend-plugin-api@0.6.10-next.3
+  - @backstage/config@1.1.1
+  - @backstage/types@1.1.1
+  - @backstage/plugin-events-node@0.2.19-next.3
+
+## 0.0.1-next.2
+
+### Patch Changes
+
+- 447d210: Fix disconnect loop on server start
+- Updated dependencies
+  - @backstage/backend-common@0.21.0-next.2
+  - @backstage/backend-plugin-api@0.6.10-next.2
+  - @backstage/plugin-auth-node@0.4.4-next.2
+  - @backstage/plugin-events-node@0.2.19-next.2
+  - @backstage/config@1.1.1
+  - @backstage/types@1.1.1
+
 ## 0.0.1-next.1
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -20,21 +20,14 @@ class DefaultSignalService {
     return new DefaultSignalService(options);
   }
   /**
-   * Publishes a message to user refs to specific topic
-   * @param recipients - string or array of user ref strings to publish message to
-   * @param topic - message topic
-   * @param message - message to publish
+   * Publishes a signal to user refs to specific topic
+   * @param signal - Signal to publish
    */
   async publish(signal) {
     var _a;
-    const { recipients, channel, message } = signal;
     await ((_a = this.eventBroker) == null ? void 0 : _a.publish({
       topic: "signals",
-      eventPayload: {
-        recipients,
-        message,
-        channel
-      }
+      eventPayload: signal
     }));
   }
 }

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/DefaultSignalService.ts","../src/lib.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 } from '@backstage/plugin-events-node';\nimport { SignalPayload, SignalServiceOptions } from './types';\nimport { SignalService } from './SignalService';\n\n/** @public */\nexport class DefaultSignalService implements SignalService {\n  // TODO: Remove this to be optional when events-backend has eventBroker as service\n  private eventBroker?: EventBroker;\n\n  static create(options: SignalServiceOptions) {\n    return new DefaultSignalService(options);\n  }\n\n  private constructor(options: SignalServiceOptions) {\n    ({ eventBroker: this.eventBroker } = options);\n  }\n\n  /**\n   * Publishes a message to user refs to specific topic\n   * @param recipients - string or array of user ref strings to publish message to\n   * @param topic - message topic\n   * @param message - message to publish\n   */\n  async publish(signal: SignalPayload) {\n    const { recipients, channel, message } = signal;\n    await this.eventBroker?.publish({\n      topic: 'signals',\n      eventPayload: {\n        recipients,\n        message,\n        channel,\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 {\n  createServiceFactory,\n  createServiceRef,\n} from '@backstage/backend-plugin-api';\nimport { DefaultSignalService } from './DefaultSignalService';\nimport { SignalService } from './SignalService';\n\n/** @public */\nexport const signalService = createServiceRef<SignalService>({\n  id: 'signals.service',\n  scope: 'plugin',\n  defaultFactory: async service =>\n    createServiceFactory({\n      service,\n      deps: {\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      factory({}) {\n        return DefaultSignalService.create({});\n      },\n    }),\n});\n"],"names":["createServiceRef","createServiceFactory"],"mappings":";;;;;;;;;;;;AAoBO,MAAM,oBAA8C,CAAA;AAAA,EAQjD,YAAY,OAA+B,EAAA;AANnD;AAAA,IAAQ,aAAA,CAAA,IAAA,EAAA,aAAA,CAAA,CAAA;AAON,IAAA,CAAC,EAAE,WAAA,EAAa,IAAK,CAAA,WAAA,EAAgB,GAAA,OAAA,EAAA;AAAA,GACvC;AAAA,EANA,OAAO,OAAO,OAA+B,EAAA;AAC3C,IAAO,OAAA,IAAI,qBAAqB,OAAO,CAAA,CAAA;AAAA,GACzC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAM,QAAQ,MAAuB,EAAA;AAtCvC,IAAA,IAAA,EAAA,CAAA;AAuCI,IAAA,MAAM,EAAE,UAAA,EAAY,OAAS,EAAA,OAAA,EAAY,GAAA,MAAA,CAAA;AACzC,IAAM,OAAA,CAAA,EAAA,GAAA,IAAA,CAAK,WAAL,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAkB,OAAQ,CAAA;AAAA,MAC9B,KAAO,EAAA,SAAA;AAAA,MACP,YAAc,EAAA;AAAA,QACZ,UAAA;AAAA,QACA,OAAA;AAAA,QACA,OAAA;AAAA,OACF;AAAA,KACF,CAAA,CAAA,CAAA;AAAA,GACF;AACF;;AC1BO,MAAM,gBAAgBA,iCAAgC,CAAA;AAAA,EAC3D,EAAI,EAAA,iBAAA;AAAA,EACJ,KAAO,EAAA,QAAA;AAAA,EACP,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAqB,CAAA;AAAA,IACnB,OAAA;AAAA,IACA,IAAM,EAAA;AAAA;AAAA;AAAA,KAGN;AAAA,IACA,OAAA,CAAQ,EAAI,EAAA;AACV,MAAO,OAAA,oBAAA,CAAqB,MAAO,CAAA,EAAE,CAAA,CAAA;AAAA,KACvC;AAAA,GACD,CAAA;AACL,CAAC;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/DefaultSignalService.ts","../src/lib.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 } from '@backstage/plugin-events-node';\nimport { SignalPayload, SignalServiceOptions } from './types';\nimport { SignalService } from './SignalService';\nimport { JsonObject } from '@backstage/types';\n\n/** @public */\nexport class DefaultSignalService implements SignalService {\n  // TODO: Remove this to be optional when events-backend has eventBroker as service\n  private eventBroker?: EventBroker;\n\n  static create(options: SignalServiceOptions) {\n    return new DefaultSignalService(options);\n  }\n\n  private constructor(options: SignalServiceOptions) {\n    ({ eventBroker: this.eventBroker } = options);\n  }\n\n  /**\n   * Publishes a signal to user refs to specific topic\n   * @param signal - Signal to publish\n   */\n  async publish<TMessage extends JsonObject = JsonObject>(\n    signal: SignalPayload<TMessage>,\n  ) {\n    await this.eventBroker?.publish({\n      topic: 'signals',\n      eventPayload: signal,\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 {\n  createServiceFactory,\n  createServiceRef,\n} from '@backstage/backend-plugin-api';\nimport { DefaultSignalService } from './DefaultSignalService';\nimport { SignalService } from './SignalService';\n\n/** @public */\nexport const signalService = createServiceRef<SignalService>({\n  id: 'signals.service',\n  scope: 'plugin',\n  defaultFactory: async service =>\n    createServiceFactory({\n      service,\n      deps: {\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      factory({}) {\n        return DefaultSignalService.create({});\n      },\n    }),\n});\n"],"names":["createServiceRef","createServiceFactory"],"mappings":";;;;;;;;;;;;AAqBO,MAAM,oBAA8C,CAAA;AAAA,EAQjD,YAAY,OAA+B,EAAA;AANnD;AAAA,IAAQ,aAAA,CAAA,IAAA,EAAA,aAAA,CAAA,CAAA;AAON,IAAA,CAAC,EAAE,WAAA,EAAa,IAAK,CAAA,WAAA,EAAgB,GAAA,OAAA,EAAA;AAAA,GACvC;AAAA,EANA,OAAO,OAAO,OAA+B,EAAA;AAC3C,IAAO,OAAA,IAAI,qBAAqB,OAAO,CAAA,CAAA;AAAA,GACzC;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,QACJ,MACA,EAAA;AAvCJ,IAAA,IAAA,EAAA,CAAA;AAwCI,IAAM,OAAA,CAAA,EAAA,GAAA,IAAA,CAAK,WAAL,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAkB,OAAQ,CAAA;AAAA,MAC9B,KAAO,EAAA,SAAA;AAAA,MACP,YAAc,EAAA,MAAA;AAAA,KAChB,CAAA,CAAA,CAAA;AAAA,GACF;AACF;;ACtBO,MAAM,gBAAgBA,iCAAgC,CAAA;AAAA,EAC3D,EAAI,EAAA,iBAAA;AAAA,EACJ,KAAO,EAAA,QAAA;AAAA,EACP,cAAA,EAAgB,OAAM,OAAA,KACpBC,qCAAqB,CAAA;AAAA,IACnB,OAAA;AAAA,IACA,IAAM,EAAA;AAAA;AAAA;AAAA,KAGN;AAAA,IACA,OAAA,CAAQ,EAAI,EAAA;AACV,MAAO,OAAA,oBAAA,CAAqB,MAAO,CAAA,EAAE,CAAA,CAAA;AAAA,KACvC;AAAA,GACD,CAAA;AACL,CAAC;;;;;"}

package/dist/index.d.ts

@@ -9,19 +9,20 @@ type SignalServiceOptions = {
     eventBroker?: EventBroker;
 };
 /** @public */
-type SignalPayload = {
-    recipients: string[] | null;
+type SignalPayload<TMessage extends JsonObject = JsonObject> = {
+    recipients: string[] | string | null;
     channel: string;
-    message: JsonObject;
+    message: TMessage;
 };
 
 /** @public */
-type SignalService = {
+interface SignalService {
     /**
-     * Publishes a message to user refs to specific topic
+     * Publishes a signal to user refs to specific topic
+     * @param signal - Signal to publish
      */
-    publish(signal: SignalPayload): Promise<void>;
-};
+    publish<TMessage extends JsonObject = JsonObject>(signal: SignalPayload<TMessage>): Promise<void>;
+}
 
 /** @public */
 declare const signalService: _backstage_backend_plugin_api.ServiceRef<SignalService, "plugin">;
@@ -32,12 +33,10 @@ declare class DefaultSignalService implements SignalService {
     static create(options: SignalServiceOptions): DefaultSignalService;
     private constructor();
     /**
-     * Publishes a message to user refs to specific topic
-     * @param recipients - string or array of user ref strings to publish message to
-     * @param topic - message topic
-     * @param message - message to publish
+     * Publishes a signal to user refs to specific topic
+     * @param signal - Signal to publish
      */
-    publish(signal: SignalPayload): Promise<void>;
+    publish<TMessage extends JsonObject = JsonObject>(signal: SignalPayload<TMessage>): Promise<void>;
 }
 
 export { DefaultSignalService, SignalPayload, SignalService, SignalServiceOptions, signalService };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-signals-node",
   "description": "Node.js library for the signals plugin",
-  "version": "0.0.1-next.1",
+  "version": "0.0.1-next.3",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -10,6 +10,11 @@
     "main": "dist/index.cjs.js",
     "types": "dist/index.d.ts"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/signals-node"
+  },
   "backstage": {
     "role": "node-library"
   },
@@ -22,18 +27,18 @@
     "postpack": "backstage-cli package postpack"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.25.2-next.1",
+    "@backstage/cli": "^0.25.2-next.3",
     "@types/express": "^4.17.21"
   },
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@backstage/backend-common": "^0.21.0-next.1",
-    "@backstage/backend-plugin-api": "^0.6.10-next.1",
+    "@backstage/backend-common": "^0.21.0-next.3",
+    "@backstage/backend-plugin-api": "^0.6.10-next.3",
     "@backstage/config": "^1.1.1",
-    "@backstage/plugin-auth-node": "^0.4.4-next.1",
-    "@backstage/plugin-events-node": "^0.2.19-next.1",
+    "@backstage/plugin-auth-node": "^0.4.4-next.3",
+    "@backstage/plugin-events-node": "^0.2.19-next.3",
     "@backstage/types": "^1.1.1",
     "express": "^4.17.1",
     "uuid": "^8.0.0",