@backstage-community/plugin-vault 0.7.0 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage-community/plugin-vault
 
+## 0.9.0
+
+### Minor Changes
+
+- ada5266: Added support for the new frontend system
+
+## 0.8.0
+
+### Minor Changes
+
+- f1eec5a: Backstage version bump to v1.40.2
+
 ## 0.7.0
 
 ### Minor Changes

package/README.md

@@ -56,6 +56,34 @@ To get started, first you need a running instance of Vault. You can follow [this
      }
    ```
 
+### Use new frontend system
+
+1. Install the frontend plugin:
+
+   ```sh
+   yarn workspace app add @backstage-community/plugin-vault
+   ```
+
+2. Enable the plugin in your `packages/app(-next)/src/App.tsx`:
+
+   After all other imports:
+
+   ```tsx
+   import vaultPlugin from '@backstage-community/plugin-vault/alpha';
+   ```
+
+   ```tsx
+   export const app = createApp({
+     features: [
+       catalogPlugin,
+       catalogImportPlugin,
+       userSettingsPlugin,
+       vaultPlugin,
+       // ...
+     ],
+   });
+   ```
+
 ## Integration with the Catalog
 
 The plugin can be integrated into each Component in the catalog. To allow listing the available secrets a new annotation must be added to the `catalog-info.yaml`:

package/dist/alpha.d.ts

@@ -0,0 +1,33 @@
+import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
+import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
+
+/**
+ * An API to communicate with the Vault backend.
+ *
+ * @alpha
+ */
+declare const vaultApi: _backstage_frontend_plugin_api.ExtensionDefinition<{
+    kind: "api";
+    name: "vaultApi";
+    config: {};
+    configInput: {};
+    output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_core_plugin_api.AnyApiFactory, "core.api.factory", {}>;
+    inputs: {};
+    params: {
+        factory: _backstage_core_plugin_api.AnyApiFactory;
+    };
+}>;
+/**
+ * A catalog entity content (tab) that shows the Vault secrets.
+ *
+ * @alpha
+ */
+declare const vaultEntityContent: any;
+/**
+ * Backstage frontend plugin.
+ *
+ * @alpha
+ */
+declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{}, {}, {}>;
+
+export { _default as default, vaultApi, vaultEntityContent };

package/dist/alpha.esm.js

@@ -0,0 +1,38 @@
+import { jsx } from 'react/jsx-runtime';
+import { ApiBlueprint, createApiFactory, discoveryApiRef, fetchApiRef, createFrontendPlugin } from '@backstage/frontend-plugin-api';
+import { EntityContentBlueprint } from '@backstage/plugin-catalog-react/alpha';
+import { isVaultAvailable } from './conditions.esm.js';
+import { vaultApiRef, VaultClient } from './api.esm.js';
+
+const vaultApi = ApiBlueprint.make({
+  name: "vaultApi",
+  params: {
+    factory: createApiFactory({
+      api: vaultApiRef,
+      deps: { discoveryApi: discoveryApiRef, fetchApi: fetchApiRef },
+      factory: ({
+        discoveryApi,
+        fetchApi
+      }) => new VaultClient({
+        discoveryApi,
+        fetchApi
+      })
+    })
+  }
+});
+const vaultEntityContent = EntityContentBlueprint.make({
+  name: "vaultEntityContent",
+  params: {
+    defaultPath: "vault",
+    defaultTitle: "Vault",
+    filter: isVaultAvailable,
+    loader: () => import('./components/EntityVaultCard/index.esm.js').then((m) => /* @__PURE__ */ jsx(m.EntityVaultCard, {}))
+  }
+});
+var alpha = createFrontendPlugin({
+  id: "vault",
+  extensions: [vaultApi, vaultEntityContent]
+});
+
+export { alpha as default, vaultApi, vaultEntityContent };
+//# sourceMappingURL=alpha.esm.js.map

package/dist/alpha.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.tsx"],"sourcesContent":["/*\n * Copyright 2020 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  ApiBlueprint,\n  createApiFactory,\n  createFrontendPlugin,\n  discoveryApiRef,\n  fetchApiRef,\n} from '@backstage/frontend-plugin-api';\nimport { EntityContentBlueprint } from '@backstage/plugin-catalog-react/alpha';\nimport { DiscoveryApi, FetchApi } from '@backstage/core-plugin-api';\n\nimport { isVaultAvailable } from './conditions';\nimport { vaultApiRef, VaultClient } from './api';\n\n/**\n * An API to communicate with the Vault backend.\n *\n * @alpha\n */\nexport const vaultApi = ApiBlueprint.make({\n  name: 'vaultApi',\n  params: {\n    factory: createApiFactory({\n      api: vaultApiRef,\n      deps: { discoveryApi: discoveryApiRef, fetchApi: fetchApiRef },\n      factory: ({\n        discoveryApi,\n        fetchApi,\n      }: {\n        discoveryApi: DiscoveryApi;\n        fetchApi: FetchApi;\n      }) =>\n        new VaultClient({\n          discoveryApi,\n          fetchApi,\n        }),\n    }),\n  },\n});\n\n/**\n * A catalog entity content (tab) that shows the Vault secrets.\n *\n * @alpha\n */\nexport const vaultEntityContent: any = EntityContentBlueprint.make({\n  name: 'vaultEntityContent',\n  params: {\n    defaultPath: 'vault',\n    defaultTitle: 'Vault',\n    filter: isVaultAvailable,\n    loader: () =>\n      import('./components/EntityVaultCard').then(m => <m.EntityVaultCard />),\n  },\n});\n\n/**\n * Backstage frontend plugin.\n *\n * @alpha\n */\nexport default createFrontendPlugin({\n  id: 'vault',\n  extensions: [vaultApi, vaultEntityContent],\n});\n"],"names":[],"mappings":";;;;;;AAiCa,MAAA,QAAA,GAAW,aAAa,IAAK,CAAA;AAAA,EACxC,IAAM,EAAA,UAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,SAAS,gBAAiB,CAAA;AAAA,MACxB,GAAK,EAAA,WAAA;AAAA,MACL,IAAM,EAAA,EAAE,YAAc,EAAA,eAAA,EAAiB,UAAU,WAAY,EAAA;AAAA,MAC7D,SAAS,CAAC;AAAA,QACR,YAAA;AAAA,QACA;AAAA,OACF,KAIE,IAAI,WAAY,CAAA;AAAA,QACd,YAAA;AAAA,QACA;AAAA,OACD;AAAA,KACJ;AAAA;AAEL,CAAC;AAOY,MAAA,kBAAA,GAA0B,uBAAuB,IAAK,CAAA;AAAA,EACjE,IAAM,EAAA,oBAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,WAAa,EAAA,OAAA;AAAA,IACb,YAAc,EAAA,OAAA;AAAA,IACd,MAAQ,EAAA,gBAAA;AAAA,IACR,MAAA,EAAQ,MACN,OAAO,2CAA8B,CAAA,CAAE,IAAK,CAAA,CAAA,CAAA,qBAAM,GAAA,CAAA,CAAA,CAAE,eAAF,EAAA,EAAkB,CAAE;AAAA;AAE5E,CAAC;AAOD,YAAe,oBAAqB,CAAA;AAAA,EAClC,EAAI,EAAA,OAAA;AAAA,EACJ,UAAA,EAAY,CAAC,QAAA,EAAU,kBAAkB;AAC3C,CAAC,CAAA;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage-community/plugin-vault",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "A Backstage plugin that integrates towards Vault",
   "backstage": {
     "role": "frontend-plugin",
@@ -9,12 +9,13 @@
       "@backstage-community/plugin-vault",
       "@backstage-community/plugin-vault-backend",
       "@backstage-community/plugin-vault-node"
-    ]
+    ],
+    "features": {
+      "./alpha": "@backstage/FrontendPlugin"
+    }
   },
   "publishConfig": {
-    "access": "public",
-    "main": "dist/index.esm.js",
-    "types": "dist/index.d.ts"
+    "access": "public"
   },
   "keywords": [
     "backstage",
@@ -28,8 +29,8 @@
   },
   "license": "Apache-2.0",
   "sideEffects": false,
-  "main": "dist/index.esm.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
@@ -44,22 +45,47 @@
   },
   "dependencies": {
     "@backstage/catalog-model": "^1.7.4",
-    "@backstage/core-components": "^0.17.2",
-    "@backstage/core-plugin-api": "^1.10.7",
+    "@backstage/core-components": "^0.17.3",
+    "@backstage/core-plugin-api": "^1.10.8",
     "@backstage/errors": "^1.2.7",
-    "@backstage/plugin-catalog-react": "^1.18.0",
+    "@backstage/frontend-plugin-api": "^0.10.3",
+    "@backstage/plugin-catalog-react": "^1.19.0",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
     "@types/react": "^16.13.1 || ^17.0.0 || ^18.0.0",
     "react-use": "^17.2.4"
   },
+  "exports": {
+    ".": {
+      "import": "./dist/index.esm.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.esm.js"
+    },
+    "./alpha": {
+      "backstage": "@backstage/FrontendPlugin",
+      "import": "./dist/alpha.esm.js",
+      "types": "./dist/alpha.d.ts",
+      "default": "./dist/alpha.esm.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "alpha": [
+        "dist/alpha.d.ts"
+      ],
+      "package.json": [
+        "package.json"
+      ]
+    }
+  },
   "devDependencies": {
-    "@backstage/cli": "^0.32.1",
-    "@backstage/core-app-api": "^1.17.0",
-    "@backstage/dev-utils": "^1.1.10",
-    "@backstage/plugin-catalog": "^1.30.0",
-    "@backstage/test-utils": "^1.7.8",
+    "@backstage/cli": "^0.33.0",
+    "@backstage/core-app-api": "^1.17.1",
+    "@backstage/dev-utils": "^1.1.11",
+    "@backstage/plugin-catalog": "^1.31.0",
+    "@backstage/test-utils": "^1.7.9",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^15.0.0",
@@ -74,12 +100,5 @@
     "react-dom": "^16.13.1 || ^17.0.0 || ^18.0.0",
     "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
   },
-  "typesVersions": {
-    "*": {
-      "package.json": [
-        "package.json"
-      ]
-    }
-  },
   "module": "./dist/index.esm.js"
 }