@backstage/plugin-signals 0.0.9 → 0.0.10-next.0

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @backstage/plugin-signals
 
+## 0.0.10-next.0
+
+### Patch Changes
+
+- 5add8e1: Added a `SignalsDisplay` extension to allows the signals plugin to be installed in an app as follows:
+
+  ```tsx
+  export default app.createRoot(
+    <>
+      <AlertDisplay transientTimeoutMs={2500} />
+      <OAuthRequestDialog />
+      <SignalsDisplay />
+      <AppRouter>
+        <VisitListener />
+        <Root>{routes}</Root>
+      </AppRouter>
+    </>,
+  );
+  ```
+
+  With this in place you can remove the explicit installation via the `plugins` option for `createApp`.
+
+- Updated dependencies
+  - @backstage/plugin-signals-react@0.0.5-next.0
+  - @backstage/core-components@0.14.10
+  - @backstage/core-plugin-api@1.9.3
+  - @backstage/theme@0.5.6
+  - @backstage/types@1.1.1
+
 ## 0.0.9
 
 ### Patch Changes

package/dist/index.d.ts

@@ -5,6 +5,8 @@ import { JsonObject } from '@backstage/types';
 
 /** @public */
 declare const signalsPlugin: _backstage_core_plugin_api.BackstagePlugin<{}, {}>;
+/** @public */
+declare const SignalsDisplay: () => null;
 
 /** @public */
 declare class SignalClient implements SignalApi {
@@ -32,4 +34,4 @@ declare class SignalClient implements SignalApi {
     private reconnect;
 }
 
-export { SignalClient, signalsPlugin };
+export { SignalClient, SignalsDisplay, signalsPlugin };

package/dist/index.esm.js

@@ -1,3 +1,3 @@
-export { signalsPlugin } from './plugin.esm.js';
+export { SignalsDisplay, signalsPlugin } from './plugin.esm.js';
 export { SignalClient } from './api/SignalClient.esm.js';
 //# sourceMappingURL=index.esm.js.map

package/dist/plugin.esm.js

@@ -1,4 +1,4 @@
-import { createPlugin, createApiFactory, identityApiRef, discoveryApiRef } from '@backstage/core-plugin-api';
+import { createPlugin, createApiFactory, identityApiRef, discoveryApiRef, createComponentExtension } from '@backstage/core-plugin-api';
 import { signalApiRef } from '@backstage/plugin-signals-react';
 import { SignalClient } from './api/SignalClient.esm.js';
 
@@ -20,6 +20,14 @@ const signalsPlugin = createPlugin({
     })
   ]
 });
+const SignalsDisplay = signalsPlugin.provide(
+  createComponentExtension({
+    component: {
+      // No-op for now, this is just a placeholder to avoid the need for an explicit plugin installation
+      sync: () => null
+    }
+  })
+);
 
-export { signalsPlugin };
+export { SignalsDisplay, signalsPlugin };
 //# sourceMappingURL=plugin.esm.js.map

package/dist/plugin.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.esm.js","sources":["../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 {\n  createApiFactory,\n  createPlugin,\n  discoveryApiRef,\n  identityApiRef,\n} from '@backstage/core-plugin-api';\nimport { signalApiRef } from '@backstage/plugin-signals-react';\nimport { SignalClient } from './api/SignalClient';\n\n/** @public */\nexport const signalsPlugin = createPlugin({\n  id: 'signals',\n  apis: [\n    createApiFactory({\n      api: signalApiRef,\n      deps: {\n        identity: identityApiRef,\n        discoveryApi: discoveryApiRef,\n      },\n      factory: ({ identity, discoveryApi }) => {\n        return SignalClient.create({\n          identity,\n          discoveryApi,\n        });\n      },\n    }),\n  ],\n});\n"],"names":[],"mappings":";;;;AAyBO,MAAM,gBAAgB,YAAa,CAAA;AAAA,EACxC,EAAI,EAAA,SAAA;AAAA,EACJ,IAAM,EAAA;AAAA,IACJ,gBAAiB,CAAA;AAAA,MACf,GAAK,EAAA,YAAA;AAAA,MACL,IAAM,EAAA;AAAA,QACJ,QAAU,EAAA,cAAA;AAAA,QACV,YAAc,EAAA,eAAA;AAAA,OAChB;AAAA,MACA,OAAS,EAAA,CAAC,EAAE,QAAA,EAAU,cAAmB,KAAA;AACvC,QAAA,OAAO,aAAa,MAAO,CAAA;AAAA,UACzB,QAAA;AAAA,UACA,YAAA;AAAA,SACD,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
+{"version":3,"file":"plugin.esm.js","sources":["../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 {\n  createApiFactory,\n  createComponentExtension,\n  createPlugin,\n  discoveryApiRef,\n  identityApiRef,\n} from '@backstage/core-plugin-api';\nimport { signalApiRef } from '@backstage/plugin-signals-react';\nimport { SignalClient } from './api/SignalClient';\n\n/** @public */\nexport const signalsPlugin = createPlugin({\n  id: 'signals',\n  apis: [\n    createApiFactory({\n      api: signalApiRef,\n      deps: {\n        identity: identityApiRef,\n        discoveryApi: discoveryApiRef,\n      },\n      factory: ({ identity, discoveryApi }) => {\n        return SignalClient.create({\n          identity,\n          discoveryApi,\n        });\n      },\n    }),\n  ],\n});\n\n/** @public */\nexport const SignalsDisplay = signalsPlugin.provide(\n  createComponentExtension({\n    component: {\n      // No-op for now, this is just a placeholder to avoid the need for an explicit plugin installation\n      sync: () => null,\n    },\n  }),\n);\n"],"names":[],"mappings":";;;;AA0BO,MAAM,gBAAgB,YAAa,CAAA;AAAA,EACxC,EAAI,EAAA,SAAA;AAAA,EACJ,IAAM,EAAA;AAAA,IACJ,gBAAiB,CAAA;AAAA,MACf,GAAK,EAAA,YAAA;AAAA,MACL,IAAM,EAAA;AAAA,QACJ,QAAU,EAAA,cAAA;AAAA,QACV,YAAc,EAAA,eAAA;AAAA,OAChB;AAAA,MACA,OAAS,EAAA,CAAC,EAAE,QAAA,EAAU,cAAmB,KAAA;AACvC,QAAA,OAAO,aAAa,MAAO,CAAA;AAAA,UACzB,QAAA;AAAA,UACA,YAAA;AAAA,SACD,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA;AAAA,GACH;AACF,CAAC,EAAA;AAGM,MAAM,iBAAiB,aAAc,CAAA,OAAA;AAAA,EAC1C,wBAAyB,CAAA;AAAA,IACvB,SAAW,EAAA;AAAA;AAAA,MAET,MAAM,MAAM,IAAA;AAAA,KACd;AAAA,GACD,CAAA;AACH;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-signals",
-  "version": "0.0.9",
+  "version": "0.0.10-next.0",
   "backstage": {
     "role": "frontend-plugin",
     "pluginId": "signals",
@@ -40,7 +40,7 @@
   "dependencies": {
     "@backstage/core-components": "^0.14.10",
     "@backstage/core-plugin-api": "^1.9.3",
-    "@backstage/plugin-signals-react": "^0.0.4",
+    "@backstage/plugin-signals-react": "^0.0.5-next.0",
     "@backstage/theme": "^0.5.6",
     "@backstage/types": "^1.1.1",
     "@material-ui/core": "^4.12.4",
@@ -50,10 +50,10 @@
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.27.0",
+    "@backstage/cli": "^0.27.1-next.0",
     "@backstage/core-app-api": "^1.14.2",
-    "@backstage/dev-utils": "^1.0.37",
-    "@backstage/test-utils": "^1.5.10",
+    "@backstage/dev-utils": "^1.0.38-next.0",
+    "@backstage/test-utils": "^1.6.0-next.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^15.0.0",
     "@testing-library/user-event": "^14.0.0",