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

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @backstage/plugin-signals-react
 
+## 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/core-plugin-api@1.9.0-next.1
+  - @backstage/types@1.1.1
+
+## 0.0.1-next.2
+
+### Patch Changes
+
+- 447d210: Fix disconnect loop on server start
+- Updated dependencies
+  - @backstage/core-plugin-api@1.9.0-next.1
+  - @backstage/types@1.1.1
+
 ## 0.0.1-next.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -4,15 +4,18 @@ import { JsonObject } from '@backstage/types';
 /** @public */
 declare const signalApiRef: _backstage_core_plugin_api.ApiRef<SignalApi>;
 /** @public */
-type SignalApi = {
-    subscribe(channel: string, onMessage: (message: JsonObject) => void): {
-        unsubscribe: () => void;
-    };
-};
+interface SignalSubscriber {
+    unsubscribe(): void;
+}
+/** @public */
+interface SignalApi {
+    subscribe<TMessage extends JsonObject = JsonObject>(channel: string, onMessage: (message: TMessage) => void): SignalSubscriber;
+}
 
 /** @public */
-declare const useSignal: (channel: string) => {
-    lastSignal: JsonObject | null;
+declare const useSignal: <TMessage extends JsonObject = JsonObject>(channel: string) => {
+    lastSignal: TMessage | null;
+    isSignalsAvailable: boolean;
 };
 
-export { SignalApi, signalApiRef, useSignal };
+export { SignalApi, SignalSubscriber, signalApiRef, useSignal };

package/dist/index.esm.js

@@ -1,5 +1,5 @@
 import { createApiRef, useApiHolder } from '@backstage/core-plugin-api';
-import { useState, useEffect } from 'react';
+import { useState, useEffect, useMemo } from 'react';
 
 const signalApiRef = createApiRef({
   id: "plugin.signal.service"
@@ -12,9 +12,12 @@ const useSignal = (channel) => {
   useEffect(() => {
     let unsub = null;
     if (signals) {
-      const { unsubscribe } = signals.subscribe(channel, (msg) => {
-        setLastSignal(msg);
-      });
+      const { unsubscribe } = signals.subscribe(
+        channel,
+        (msg) => {
+          setLastSignal(msg);
+        }
+      );
       unsub = unsubscribe;
     }
     return () => {
@@ -23,7 +26,8 @@ const useSignal = (channel) => {
       }
     };
   }, [signals, channel]);
-  return { lastSignal };
+  const isSignalsAvailable = useMemo(() => !signals, [signals]);
+  return { lastSignal, isSignalsAvailable };
 };
 
 export { signalApiRef, useSignal };

package/dist/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":["../src/api/SignalApi.ts","../src/hooks/useSignal.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 { createApiRef } from '@backstage/core-plugin-api';\nimport { JsonObject } from '@backstage/types';\n\n/** @public */\nexport const signalApiRef = createApiRef<SignalApi>({\n  id: 'plugin.signal.service',\n});\n\n/** @public */\nexport type SignalApi = {\n  subscribe(\n    channel: string,\n    onMessage: (message: JsonObject) => void,\n  ): { unsubscribe: () => void };\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 { signalApiRef } from '../api';\nimport { useApiHolder } from '@backstage/core-plugin-api';\nimport { JsonObject } from '@backstage/types';\nimport { useEffect, useState } from 'react';\n\n/** @public */\nexport const useSignal = (channel: string) => {\n  const apiHolder = useApiHolder();\n  // Use apiHolder instead useApi in case signalApi is not available in the\n  // backstage instance this is used\n  const signals = apiHolder.get(signalApiRef);\n  const [lastSignal, setLastSignal] = useState<JsonObject | null>(null);\n  useEffect(() => {\n    let unsub: null | (() => void) = null;\n    if (signals) {\n      const { unsubscribe } = signals.subscribe(channel, (msg: JsonObject) => {\n        setLastSignal(msg);\n      });\n      unsub = unsubscribe;\n    }\n    return () => {\n      if (signals && unsub) {\n        unsub();\n      }\n    };\n  }, [signals, channel]);\n\n  return { lastSignal };\n};\n"],"names":[],"mappings":";;;AAmBO,MAAM,eAAe,YAAwB,CAAA;AAAA,EAClD,EAAI,EAAA,uBAAA;AACN,CAAC;;ACAY,MAAA,SAAA,GAAY,CAAC,OAAoB,KAAA;AAC5C,EAAA,MAAM,YAAY,YAAa,EAAA,CAAA;AAG/B,EAAM,MAAA,OAAA,GAAU,SAAU,CAAA,GAAA,CAAI,YAAY,CAAA,CAAA;AAC1C,EAAA,MAAM,CAAC,UAAA,EAAY,aAAa,CAAA,GAAI,SAA4B,IAAI,CAAA,CAAA;AACpE,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,KAA6B,GAAA,IAAA,CAAA;AACjC,IAAA,IAAI,OAAS,EAAA;AACX,MAAA,MAAM,EAAE,WAAY,EAAA,GAAI,QAAQ,SAAU,CAAA,OAAA,EAAS,CAAC,GAAoB,KAAA;AACtE,QAAA,aAAA,CAAc,GAAG,CAAA,CAAA;AAAA,OAClB,CAAA,CAAA;AACD,MAAQ,KAAA,GAAA,WAAA,CAAA;AAAA,KACV;AACA,IAAA,OAAO,MAAM;AACX,MAAA,IAAI,WAAW,KAAO,EAAA;AACpB,QAAM,KAAA,EAAA,CAAA;AAAA,OACR;AAAA,KACF,CAAA;AAAA,GACC,EAAA,CAAC,OAAS,EAAA,OAAO,CAAC,CAAA,CAAA;AAErB,EAAA,OAAO,EAAE,UAAW,EAAA,CAAA;AACtB;;;;"}
+{"version":3,"file":"index.esm.js","sources":["../src/api/SignalApi.ts","../src/hooks/useSignal.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 { createApiRef } from '@backstage/core-plugin-api';\nimport { JsonObject } from '@backstage/types';\n\n/** @public */\nexport const signalApiRef = createApiRef<SignalApi>({\n  id: 'plugin.signal.service',\n});\n\n/** @public */\nexport interface SignalSubscriber {\n  unsubscribe(): void;\n}\n\n/** @public */\nexport interface SignalApi {\n  subscribe<TMessage extends JsonObject = JsonObject>(\n    channel: string,\n    onMessage: (message: TMessage) => void,\n  ): SignalSubscriber;\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 { signalApiRef } from '../api';\nimport { useApiHolder } from '@backstage/core-plugin-api';\nimport { JsonObject } from '@backstage/types';\nimport { useEffect, useMemo, useState } from 'react';\n\n/** @public */\nexport const useSignal = <TMessage extends JsonObject = JsonObject>(\n  channel: string,\n): { lastSignal: TMessage | null; isSignalsAvailable: boolean } => {\n  const apiHolder = useApiHolder();\n  // Use apiHolder instead useApi in case signalApi is not available in the\n  // backstage instance this is used\n  const signals = apiHolder.get(signalApiRef);\n  const [lastSignal, setLastSignal] = useState<TMessage | null>(null);\n  useEffect(() => {\n    let unsub: null | (() => void) = null;\n    if (signals) {\n      const { unsubscribe } = signals.subscribe<TMessage>(\n        channel,\n        (msg: TMessage) => {\n          setLastSignal(msg);\n        },\n      );\n      unsub = unsubscribe;\n    }\n    return () => {\n      if (signals && unsub) {\n        unsub();\n      }\n    };\n  }, [signals, channel]);\n\n  // Can be used to fallback (for example to long polling) if signals are not available in the system\n  const isSignalsAvailable = useMemo(() => !signals, [signals]);\n\n  return { lastSignal, isSignalsAvailable };\n};\n"],"names":[],"mappings":";;;AAmBO,MAAM,eAAe,YAAwB,CAAA;AAAA,EAClD,EAAI,EAAA,uBAAA;AACN,CAAC;;ACAY,MAAA,SAAA,GAAY,CACvB,OACiE,KAAA;AACjE,EAAA,MAAM,YAAY,YAAa,EAAA,CAAA;AAG/B,EAAM,MAAA,OAAA,GAAU,SAAU,CAAA,GAAA,CAAI,YAAY,CAAA,CAAA;AAC1C,EAAA,MAAM,CAAC,UAAA,EAAY,aAAa,CAAA,GAAI,SAA0B,IAAI,CAAA,CAAA;AAClE,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,KAA6B,GAAA,IAAA,CAAA;AACjC,IAAA,IAAI,OAAS,EAAA;AACX,MAAM,MAAA,EAAE,WAAY,EAAA,GAAI,OAAQ,CAAA,SAAA;AAAA,QAC9B,OAAA;AAAA,QACA,CAAC,GAAkB,KAAA;AACjB,UAAA,aAAA,CAAc,GAAG,CAAA,CAAA;AAAA,SACnB;AAAA,OACF,CAAA;AACA,MAAQ,KAAA,GAAA,WAAA,CAAA;AAAA,KACV;AACA,IAAA,OAAO,MAAM;AACX,MAAA,IAAI,WAAW,KAAO,EAAA;AACpB,QAAM,KAAA,EAAA,CAAA;AAAA,OACR;AAAA,KACF,CAAA;AAAA,GACC,EAAA,CAAC,OAAS,EAAA,OAAO,CAAC,CAAA,CAAA;AAGrB,EAAA,MAAM,qBAAqB,OAAQ,CAAA,MAAM,CAAC,OAAS,EAAA,CAAC,OAAO,CAAC,CAAA,CAAA;AAE5D,EAAO,OAAA,EAAE,YAAY,kBAAmB,EAAA,CAAA;AAC1C;;;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-signals-react",
   "description": "Web library for the signals plugin",
-  "version": "0.0.1-next.1",
+  "version": "0.0.1-next.3",
   "main": "dist/index.esm.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -10,6 +10,11 @@
     "main": "dist/index.esm.js",
     "types": "dist/index.d.ts"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/signals-react"
+  },
   "backstage": {
     "role": "web-library"
   },
@@ -24,7 +29,7 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/core-plugin-api": "^1.8.3-next.0",
+    "@backstage/core-plugin-api": "^1.9.0-next.1",
     "@backstage/types": "^1.1.1",
     "@material-ui/core": "^4.12.4"
   },
@@ -32,8 +37,8 @@
     "react": "^16.13.1 || ^17.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.25.2-next.1",
-    "@backstage/test-utils": "^1.5.0-next.1",
+    "@backstage/cli": "^0.25.2-next.3",
+    "@backstage/test-utils": "^1.5.0-next.3",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^14.0.0"
   },