@backstage-community/plugin-vault 0.15.0 → 0.17.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage-community/plugin-vault
 
+## 0.17.0
+
+### Minor Changes
+
+- 7ad5206: Added support for multiple secrets paths
+
+## 0.16.0
+
+### Minor Changes
+
+- 84e3915: Backstage version bump to v1.47.2
+
 ## 0.15.0
 
 ### Minor Changes

package/README.md

@@ -44,6 +44,7 @@ To get started, first you need a running instance of Vault. You can follow [this
      token: <VAULT_TOKEN>
      secretEngine: 'customSecretEngine' # Optional. By default it uses 'secrets'. Can be overwritten by the annotation of the entity
      kvVersion: <kv-version> # Optional. The K/V version that your instance is using. The available options are '1' or '2'
+     secretSuffix: 'config' # Optional. Suffix to append to the secret path when creating new secrets (e.g., 'config')
    ```
 
 4. Get a `VAULT_TOKEN` with **LIST** permissions, as it's enough for the plugin. You can check [this tutorial](https://learn.hashicorp.com/tutorials/vault/tokens) for more info.
@@ -98,6 +99,20 @@ metadata:
     vault.io/secrets-engine: customSecretEngine # Optional. By default it uses the 'secretEngine' value from your app-config.
 ```
 
+### Multiple Secret Paths
+
+You can also specify multiple secret paths separated by commas. Each path will be displayed in the Vault table:
+
+```yaml
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  # ...
+  annotations:
+    vault.io/secrets-path: path/to/secrets,another/path,third/path
+    vault.io/secrets-engine: customSecretEngine # Optional. By default it uses the 'secretEngine' value from your app-config.
+```
+
 The path is relative to your secrets engine folder. So if you want to get the secrets for backstage and you have the following directory structure:
 
     .

package/dist/api.esm.js

@@ -37,11 +37,36 @@ class VaultClient {
     if (secretEngine) {
       query.engine = secretEngine;
     }
-    const result = await this.callApi(
-      `v1/secrets/${encodeURIComponent(secretPath)}`,
-      query
+    const result = await this.callApi(`v1/secrets/${encodeURIComponent(secretPath)}`, query);
+    return {
+      secrets: result.items,
+      vaultUrl: result.vaultUrl,
+      createUrl: result.createUrl
+    };
+  }
+  /**
+   * Returns the createUrl for a secret path using the dedicated backend route.
+   */
+  async getCreateUrl(secretPath, options) {
+    const query = {};
+    const { secretEngine } = options || {};
+    if (secretEngine) {
+      query.engine = secretEngine;
+    }
+    const apiUrl = `${await this.discoveryApi.getBaseUrl("vault")}`;
+    const response = await this.fetchApi.fetch(
+      `${apiUrl}/v1/secrets/${encodeURIComponent(
+        secretPath
+      )}/create-url?${new URLSearchParams(query).toString()}`,
+      {
+        headers: {
+          Accept: "application/json"
+        }
+      }
     );
-    return result.items;
+    if (!response.ok) return void 0;
+    const data = await response.json();
+    return data.createUrl;
   }
 }
 

package/dist/api.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.esm.js","sources":["../src/api.ts"],"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  DiscoveryApi,\n  createApiRef,\n  FetchApi,\n} from '@backstage/core-plugin-api';\nimport { NotFoundError, ResponseError } from '@backstage/errors';\n\n/**\n * @public\n */\nexport const vaultApiRef = createApiRef<VaultApi>({\n  id: 'plugin.vault.service',\n});\n\n/**\n * Object containing the secret name and some links.\n * @public\n */\nexport type VaultSecret = {\n  name: string;\n  path: string;\n  showUrl: string;\n  editUrl: string;\n};\n\n/**\n * Interface for the VaultApi.\n * @public\n */\nexport interface VaultApi {\n  /**\n   * Returns a list of secrets used to show in a table.\n   * @param secretPath - The path where the secrets are stored in Vault\n   * @param options - Additional options to be passed to the Vault API, allows to override vault default settings in app config file\n   */\n  listSecrets(\n    secretPath: string,\n    options?: {\n      secretEngine?: string;\n    },\n  ): Promise<VaultSecret[]>;\n}\n\n/**\n * Default implementation of the VaultApi.\n * @public\n */\nexport class VaultClient implements VaultApi {\n  private readonly discoveryApi: DiscoveryApi;\n  private readonly fetchApi: FetchApi;\n\n  constructor({\n    discoveryApi,\n    fetchApi,\n  }: {\n    discoveryApi: DiscoveryApi;\n    fetchApi: FetchApi;\n  }) {\n    this.discoveryApi = discoveryApi;\n    this.fetchApi = fetchApi;\n  }\n\n  private async callApi<T>(\n    path: string,\n    query: { [key in string]: any },\n  ): Promise<T> {\n    const apiUrl = `${await this.discoveryApi.getBaseUrl('vault')}`;\n    const response = await this.fetchApi.fetch(\n      `${apiUrl}/${path}?${new URLSearchParams(query).toString()}`,\n      {\n        headers: {\n          Accept: 'application/json',\n        },\n      },\n    );\n    if (response.ok) {\n      return (await response.json()) as T;\n    } else if (response.status === 404) {\n      throw new NotFoundError(`No secrets found in path '${path}'`);\n    }\n    throw await ResponseError.fromResponse(response);\n  }\n\n  async listSecrets(\n    secretPath: string,\n    options?: {\n      secretEngine?: string;\n    },\n  ): Promise<VaultSecret[]> {\n    const query: { [key in string]: any } = {};\n    const { secretEngine } = options || {};\n    if (secretEngine) {\n      query.engine = secretEngine;\n    }\n\n    const result = await this.callApi<{ items: VaultSecret[] }>(\n      `v1/secrets/${encodeURIComponent(secretPath)}`,\n      query,\n    );\n    return result.items;\n  }\n}\n"],"names":[],"mappings":";;;AAyBO,MAAM,cAAc,YAAuB,CAAA;AAAA,EAChD,EAAI,EAAA;AACN,CAAC;AAmCM,MAAM,WAAgC,CAAA;AAAA,EAC1B,YAAA;AAAA,EACA,QAAA;AAAA,EAEjB,WAAY,CAAA;AAAA,IACV,YAAA;AAAA,IACA;AAAA,GAIC,EAAA;AACD,IAAA,IAAA,CAAK,YAAe,GAAA,YAAA;AACpB,IAAA,IAAA,CAAK,QAAW,GAAA,QAAA;AAAA;AAClB,EAEA,MAAc,OACZ,CAAA,IAAA,EACA,KACY,EAAA;AACZ,IAAA,MAAM,SAAS,CAAG,EAAA,MAAM,KAAK,YAAa,CAAA,UAAA,CAAW,OAAO,CAAC,CAAA,CAAA;AAC7D,IAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,QAAS,CAAA,KAAA;AAAA,MACnC,CAAA,EAAG,MAAM,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,IAAI,eAAgB,CAAA,KAAK,CAAE,CAAA,QAAA,EAAU,CAAA,CAAA;AAAA,MAC1D;AAAA,QACE,OAAS,EAAA;AAAA,UACP,MAAQ,EAAA;AAAA;AACV;AACF,KACF;AACA,IAAA,IAAI,SAAS,EAAI,EAAA;AACf,MAAQ,OAAA,MAAM,SAAS,IAAK,EAAA;AAAA,KAC9B,MAAA,IAAW,QAAS,CAAA,MAAA,KAAW,GAAK,EAAA;AAClC,MAAA,MAAM,IAAI,aAAA,CAAc,CAA6B,0BAAA,EAAA,IAAI,CAAG,CAAA,CAAA,CAAA;AAAA;AAE9D,IAAM,MAAA,MAAM,aAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AACjD,EAEA,MAAM,WACJ,CAAA,UAAA,EACA,OAGwB,EAAA;AACxB,IAAA,MAAM,QAAkC,EAAC;AACzC,IAAA,MAAM,EAAE,YAAA,EAAiB,GAAA,OAAA,IAAW,EAAC;AACrC,IAAA,IAAI,YAAc,EAAA;AAChB,MAAA,KAAA,CAAM,MAAS,GAAA,YAAA;AAAA;AAGjB,IAAM,MAAA,MAAA,GAAS,MAAM,IAAK,CAAA,OAAA;AAAA,MACxB,CAAA,WAAA,EAAc,kBAAmB,CAAA,UAAU,CAAC,CAAA,CAAA;AAAA,MAC5C;AAAA,KACF;AACA,IAAA,OAAO,MAAO,CAAA,KAAA;AAAA;AAElB;;;;"}
+{"version":3,"file":"api.esm.js","sources":["../src/api.ts"],"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  DiscoveryApi,\n  createApiRef,\n  FetchApi,\n} from '@backstage/core-plugin-api';\nimport { NotFoundError, ResponseError } from '@backstage/errors';\n\n/**\n * @public\n */\nexport const vaultApiRef = createApiRef<VaultApi>({\n  id: 'plugin.vault.service',\n});\n\n/**\n * Object containing the secret name and some links.\n * @public\n */\nexport type VaultSecret = {\n  name: string;\n  path: string;\n  showUrl: string;\n  editUrl: string;\n};\n\n/**\n * Response from listSecrets API call\n * @public\n */\nexport type ListSecretsResponse = {\n  secrets: VaultSecret[];\n  vaultUrl?: string;\n  createUrl?: string;\n};\n\n/**\n * Interface for the VaultApi.\n * @public\n */\nexport interface VaultApi {\n  /**\n   * Returns a list of secrets used to show in a table along with vault URLs.\n   * @param secretPath - The path where the secrets are stored in Vault\n   * @param options - Additional options to be passed to the Vault API, allows to override vault default settings in app config file\n   */\n  listSecrets(\n    secretPath: string,\n    options?: {\n      secretEngine?: string;\n    },\n  ): Promise<ListSecretsResponse>;\n\n  getCreateUrl(\n    secretPath: string,\n    options?: {\n      secretEngine?: string;\n    },\n  ): Promise<string | undefined>;\n}\n\n/**\n * Default implementation of the VaultApi.\n * @public\n */\nexport class VaultClient implements VaultApi {\n  private readonly discoveryApi: DiscoveryApi;\n  private readonly fetchApi: FetchApi;\n\n  constructor({\n    discoveryApi,\n    fetchApi,\n  }: {\n    discoveryApi: DiscoveryApi;\n    fetchApi: FetchApi;\n  }) {\n    this.discoveryApi = discoveryApi;\n    this.fetchApi = fetchApi;\n  }\n\n  private async callApi<T>(\n    path: string,\n    query: { [key in string]: any },\n  ): Promise<T> {\n    const apiUrl = `${await this.discoveryApi.getBaseUrl('vault')}`;\n    const response = await this.fetchApi.fetch(\n      `${apiUrl}/${path}?${new URLSearchParams(query).toString()}`,\n      {\n        headers: {\n          Accept: 'application/json',\n        },\n      },\n    );\n    if (response.ok) {\n      return (await response.json()) as T;\n    } else if (response.status === 404) {\n      throw new NotFoundError(`No secrets found in path '${path}'`);\n    }\n    throw await ResponseError.fromResponse(response);\n  }\n\n  async listSecrets(\n    secretPath: string,\n    options?: {\n      secretEngine?: string;\n    },\n  ): Promise<ListSecretsResponse> {\n    const query: { [key in string]: any } = {};\n    const { secretEngine } = options || {};\n    if (secretEngine) {\n      query.engine = secretEngine;\n    }\n\n    const result = await this.callApi<{\n      items: VaultSecret[];\n      vaultUrl?: string;\n      createUrl?: string;\n    }>(`v1/secrets/${encodeURIComponent(secretPath)}`, query);\n    return {\n      secrets: result.items,\n      vaultUrl: result.vaultUrl,\n      createUrl: result.createUrl,\n    };\n  }\n\n  /**\n   * Returns the createUrl for a secret path using the dedicated backend route.\n   */\n  async getCreateUrl(\n    secretPath: string,\n    options?: { secretEngine?: string },\n  ): Promise<string | undefined> {\n    const query: { [key in string]: any } = {};\n    const { secretEngine } = options || {};\n    if (secretEngine) {\n      query.engine = secretEngine;\n    }\n    const apiUrl = `${await this.discoveryApi.getBaseUrl('vault')}`;\n    const response = await this.fetchApi.fetch(\n      `${apiUrl}/v1/secrets/${encodeURIComponent(\n        secretPath,\n      )}/create-url?${new URLSearchParams(query).toString()}`,\n      {\n        headers: {\n          Accept: 'application/json',\n        },\n      },\n    );\n    if (!response.ok) return undefined;\n    const data = await response.json();\n    return data.createUrl;\n  }\n}\n"],"names":[],"mappings":";;;AAyBO,MAAM,cAAc,YAAuB,CAAA;AAAA,EAChD,EAAI,EAAA;AACN,CAAC;AAoDM,MAAM,WAAgC,CAAA;AAAA,EAC1B,YAAA;AAAA,EACA,QAAA;AAAA,EAEjB,WAAY,CAAA;AAAA,IACV,YAAA;AAAA,IACA;AAAA,GAIC,EAAA;AACD,IAAA,IAAA,CAAK,YAAe,GAAA,YAAA;AACpB,IAAA,IAAA,CAAK,QAAW,GAAA,QAAA;AAAA;AAClB,EAEA,MAAc,OACZ,CAAA,IAAA,EACA,KACY,EAAA;AACZ,IAAA,MAAM,SAAS,CAAG,EAAA,MAAM,KAAK,YAAa,CAAA,UAAA,CAAW,OAAO,CAAC,CAAA,CAAA;AAC7D,IAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,QAAS,CAAA,KAAA;AAAA,MACnC,CAAA,EAAG,MAAM,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,IAAI,eAAgB,CAAA,KAAK,CAAE,CAAA,QAAA,EAAU,CAAA,CAAA;AAAA,MAC1D;AAAA,QACE,OAAS,EAAA;AAAA,UACP,MAAQ,EAAA;AAAA;AACV;AACF,KACF;AACA,IAAA,IAAI,SAAS,EAAI,EAAA;AACf,MAAQ,OAAA,MAAM,SAAS,IAAK,EAAA;AAAA,KAC9B,MAAA,IAAW,QAAS,CAAA,MAAA,KAAW,GAAK,EAAA;AAClC,MAAA,MAAM,IAAI,aAAA,CAAc,CAA6B,0BAAA,EAAA,IAAI,CAAG,CAAA,CAAA,CAAA;AAAA;AAE9D,IAAM,MAAA,MAAM,aAAc,CAAA,YAAA,CAAa,QAAQ,CAAA;AAAA;AACjD,EAEA,MAAM,WACJ,CAAA,UAAA,EACA,OAG8B,EAAA;AAC9B,IAAA,MAAM,QAAkC,EAAC;AACzC,IAAA,MAAM,EAAE,YAAA,EAAiB,GAAA,OAAA,IAAW,EAAC;AACrC,IAAA,IAAI,YAAc,EAAA;AAChB,MAAA,KAAA,CAAM,MAAS,GAAA,YAAA;AAAA;AAGjB,IAAM,MAAA,MAAA,GAAS,MAAM,IAAK,CAAA,OAAA,CAIvB,cAAc,kBAAmB,CAAA,UAAU,CAAC,CAAA,CAAA,EAAI,KAAK,CAAA;AACxD,IAAO,OAAA;AAAA,MACL,SAAS,MAAO,CAAA,KAAA;AAAA,MAChB,UAAU,MAAO,CAAA,QAAA;AAAA,MACjB,WAAW,MAAO,CAAA;AAAA,KACpB;AAAA;AACF;AAAA;AAAA;AAAA,EAKA,MAAM,YACJ,CAAA,UAAA,EACA,OAC6B,EAAA;AAC7B,IAAA,MAAM,QAAkC,EAAC;AACzC,IAAA,MAAM,EAAE,YAAA,EAAiB,GAAA,OAAA,IAAW,EAAC;AACrC,IAAA,IAAI,YAAc,EAAA;AAChB,MAAA,KAAA,CAAM,MAAS,GAAA,YAAA;AAAA;AAEjB,IAAA,MAAM,SAAS,CAAG,EAAA,MAAM,KAAK,YAAa,CAAA,UAAA,CAAW,OAAO,CAAC,CAAA,CAAA;AAC7D,IAAM,MAAA,QAAA,GAAW,MAAM,IAAA,CAAK,QAAS,CAAA,KAAA;AAAA,MACnC,CAAA,EAAG,MAAM,CAAe,YAAA,EAAA,kBAAA;AAAA,QACtB;AAAA,OACD,CAAe,YAAA,EAAA,IAAI,gBAAgB,KAAK,CAAA,CAAE,UAAU,CAAA,CAAA;AAAA,MACrD;AAAA,QACE,OAAS,EAAA;AAAA,UACP,MAAQ,EAAA;AAAA;AACV;AACF,KACF;AACA,IAAI,IAAA,CAAC,QAAS,CAAA,EAAA,EAAW,OAAA,KAAA,CAAA;AACzB,IAAM,MAAA,IAAA,GAAO,MAAM,QAAA,CAAS,IAAK,EAAA;AACjC,IAAA,OAAO,IAAK,CAAA,SAAA;AAAA;AAEhB;;;;"}

package/dist/components/EntityVaultTable/EntityVaultTable.esm.js

@@ -11,64 +11,98 @@ import { vaultApiRef } from '../../api.esm.js';
 import { VAULT_SECRET_PATH_ANNOTATION, VAULT_SECRET_ENGINE_ANNOTATION } from '../../constants.esm.js';
 
 const vaultSecretConfig = (entity) => {
-  const secretPath = entity.metadata.annotations?.[VAULT_SECRET_PATH_ANNOTATION];
+  const secretPathAnnotation = entity.metadata.annotations?.[VAULT_SECRET_PATH_ANNOTATION];
+  const secretPaths = secretPathAnnotation ? secretPathAnnotation.split(",").map((path) => path.trim()).filter(Boolean) : [];
   const secretEngine = entity.metadata.annotations?.[VAULT_SECRET_ENGINE_ANNOTATION];
-  return { secretPath, secretEngine };
+  return { secretPaths, secretEngine };
 };
 const EntityVaultTable = ({ entity }) => {
   const vaultApi = useApi(vaultApiRef);
-  const { secretPath, secretEngine } = vaultSecretConfig(entity);
-  if (!secretPath) {
+  const { secretPaths, secretEngine } = vaultSecretConfig(entity);
+  if (!secretPaths || secretPaths.length === 0) {
     throw Error(
       `The secret path is undefined. Please, define the annotation ${VAULT_SECRET_PATH_ANNOTATION}`
     );
   }
   const { value, loading, error } = useAsync(async () => {
-    return vaultApi.listSecrets(secretPath, { secretEngine });
+    const results = await Promise.all(
+      secretPaths.map(async (path) => {
+        const response = await vaultApi.listSecrets(path, { secretEngine }).catch(() => ({
+          secrets: []
+        }));
+        let createUrl = void 0;
+        if (response.secrets.length === 0) {
+          createUrl = await vaultApi.getCreateUrl?.(path, { secretEngine });
+        }
+        return {
+          path,
+          secrets: response.secrets,
+          createUrl
+        };
+      })
+    );
+    return results;
   }, []);
   const columns = [
+    { title: "Path", field: "path", width: "20%" },
     { title: "Secret", field: "secret", highlight: true },
-    { title: "View URL", field: "view", width: "10%" },
-    { title: "Edit URL", field: "edit", width: "10%" }
+    { title: "View", field: "view", width: "10%" },
+    { title: "Edit", field: "edit", width: "10%" }
   ];
-  const data = (value || []).map((secret) => {
-    const secretName = `${secret.path.replace(`${secretPath}/`, "")}/${secret.name}`;
-    return {
-      secret: secretName,
-      view: /* @__PURE__ */ jsx(
-        Link,
-        {
-          "aria-label": "View",
-          title: `View ${secretName}`,
-          to: secret.showUrl,
-          children: /* @__PURE__ */ jsx(Visibility, { style: { fontSize: 16 } })
-        }
-      ),
-      edit: /* @__PURE__ */ jsx(
-        Link,
-        {
-          "aria-label": "Edit",
-          title: `Edit ${secretName}`,
-          to: secret.editUrl,
-          children: /* @__PURE__ */ jsx(Edit, { style: { fontSize: 16 } })
-        }
-      )
-    };
+  const data = [];
+  (value || []).forEach(({ path, secrets, createUrl }) => {
+    if (secrets.length === 0) {
+      data.push({
+        path,
+        secret: /* @__PURE__ */ jsxs(Typography, { variant: "body2", color: "textSecondary", children: [
+          "No secrets, ",
+          /* @__PURE__ */ jsx(Link, { to: createUrl || "", children: "create one" })
+        ] }),
+        view: null,
+        edit: null
+      });
+    } else {
+      secrets.forEach((secret, index) => {
+        const secretName = `${secret.path.replace(`${path}/`, "")}/${secret.name}`;
+        data.push({
+          path: index === 0 ? path : "",
+          secret: secretName,
+          view: /* @__PURE__ */ jsx(
+            Link,
+            {
+              "aria-label": "View",
+              title: `View ${secretName}`,
+              to: secret.showUrl,
+              children: /* @__PURE__ */ jsx(Visibility, { style: { fontSize: 16 } })
+            }
+          ),
+          edit: /* @__PURE__ */ jsx(
+            Link,
+            {
+              "aria-label": "Edit",
+              title: `Edit ${secretName}`,
+              to: secret.editUrl,
+              children: /* @__PURE__ */ jsx(Edit, { style: { fontSize: 16 } })
+            }
+          )
+        });
+      });
+    }
   });
   if (error) {
     return /* @__PURE__ */ jsxs(Alert, { severity: "error", children: [
-      "Unexpected error while fetching secrets from path '",
-      secretPath,
-      "':",
-      " ",
+      "Unexpected error while fetching secrets from path(s) '",
+      secretPaths.join(", "),
+      "': ",
       error.message
     ] });
   }
+  const subtitle = secretPaths.length === 1 ? `Secrets for ${entity.metadata.name} in ${secretPaths[0]}` : `Secrets for ${entity.metadata.name} in ${secretPaths.length} paths`;
   return /* @__PURE__ */ jsx(
     Table,
     {
       title: "Vault",
-      subtitle: `Secrets for ${entity.metadata.name} in ${secretPath}`,
+      subtitle,
       columns,
       data,
       isLoading: loading,
@@ -81,8 +115,9 @@ const EntityVaultTable = ({ entity }) => {
       emptyContent: /* @__PURE__ */ jsx(Box, { style: { textAlign: "center", padding: "15px" }, children: /* @__PURE__ */ jsxs(Typography, { variant: "body1", children: [
         "No secrets found for ",
         entity.metadata.name,
-        " in ",
-        secretPath
+        " in",
+        " ",
+        secretPaths.join(", ")
       ] }) })
     }
   );

package/dist/components/EntityVaultTable/EntityVaultTable.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntityVaultTable.esm.js","sources":["../../../src/components/EntityVaultTable/EntityVaultTable.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 { Entity } from '@backstage/catalog-model';\nimport { Link, Table, TableColumn } from '@backstage/core-components';\nimport { useApi } from '@backstage/core-plugin-api';\nimport Box from '@material-ui/core/Box';\nimport Typography from '@material-ui/core/Typography';\nimport Edit from '@material-ui/icons/Edit';\nimport Visibility from '@material-ui/icons/Visibility';\nimport Alert from '@material-ui/lab/Alert';\nimport useAsync from 'react-use/esm/useAsync';\nimport { VaultSecret, vaultApiRef } from '../../api';\nimport {\n  VAULT_SECRET_ENGINE_ANNOTATION,\n  VAULT_SECRET_PATH_ANNOTATION,\n} from '../../constants';\n\nexport const vaultSecretConfig = (entity: Entity) => {\n  const secretPath =\n    entity.metadata.annotations?.[VAULT_SECRET_PATH_ANNOTATION];\n  const secretEngine =\n    entity.metadata.annotations?.[VAULT_SECRET_ENGINE_ANNOTATION];\n\n  return { secretPath, secretEngine };\n};\n\nexport const EntityVaultTable = ({ entity }: { entity: Entity }) => {\n  const vaultApi = useApi(vaultApiRef);\n  const { secretPath, secretEngine } = vaultSecretConfig(entity);\n  if (!secretPath) {\n    throw Error(\n      `The secret path is undefined. Please, define the annotation ${VAULT_SECRET_PATH_ANNOTATION}`,\n    );\n  }\n\n  const { value, loading, error } = useAsync(async (): Promise<\n    VaultSecret[]\n  > => {\n    return vaultApi.listSecrets(secretPath, { secretEngine });\n  }, []);\n\n  const columns: TableColumn[] = [\n    { title: 'Secret', field: 'secret', highlight: true },\n    { title: 'View URL', field: 'view', width: '10%' },\n    { title: 'Edit URL', field: 'edit', width: '10%' },\n  ];\n\n  const data = (value || []).map(secret => {\n    const secretName = `${secret.path.replace(`${secretPath}/`, '')}/${\n      secret.name\n    }`;\n\n    return {\n      secret: secretName,\n      view: (\n        <Link\n          aria-label=\"View\"\n          title={`View ${secretName}`}\n          to={secret.showUrl}\n        >\n          <Visibility style={{ fontSize: 16 }} />\n        </Link>\n      ),\n      edit: (\n        <Link\n          aria-label=\"Edit\"\n          title={`Edit ${secretName}`}\n          to={secret.editUrl}\n        >\n          <Edit style={{ fontSize: 16 }} />\n        </Link>\n      ),\n    };\n  });\n\n  if (error) {\n    return (\n      <Alert severity=\"error\">\n        Unexpected error while fetching secrets from path '{secretPath}':{' '}\n        {error.message}\n      </Alert>\n    );\n  }\n\n  return (\n    <Table\n      title=\"Vault\"\n      subtitle={`Secrets for ${entity.metadata.name} in ${secretPath}`}\n      columns={columns}\n      data={data}\n      isLoading={loading}\n      options={{\n        padding: 'dense',\n        pageSize: 10,\n        emptyRowsWhenPaging: false,\n        search: false,\n      }}\n      emptyContent={\n        <Box style={{ textAlign: 'center', padding: '15px' }}>\n          <Typography variant=\"body1\">\n            No secrets found for {entity.metadata.name} in {secretPath}\n          </Typography>\n        </Box>\n      }\n    />\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;AA8Ba,MAAA,iBAAA,GAAoB,CAAC,MAAmB,KAAA;AACnD,EAAA,MAAM,UACJ,GAAA,MAAA,CAAO,QAAS,CAAA,WAAA,GAAc,4BAA4B,CAAA;AAC5D,EAAA,MAAM,YACJ,GAAA,MAAA,CAAO,QAAS,CAAA,WAAA,GAAc,8BAA8B,CAAA;AAE9D,EAAO,OAAA,EAAE,YAAY,YAAa,EAAA;AACpC;AAEO,MAAM,gBAAmB,GAAA,CAAC,EAAE,MAAA,EAAiC,KAAA;AAClE,EAAM,MAAA,QAAA,GAAW,OAAO,WAAW,CAAA;AACnC,EAAA,MAAM,EAAE,UAAA,EAAY,YAAa,EAAA,GAAI,kBAAkB,MAAM,CAAA;AAC7D,EAAA,IAAI,CAAC,UAAY,EAAA;AACf,IAAM,MAAA,KAAA;AAAA,MACJ,+DAA+D,4BAA4B,CAAA;AAAA,KAC7F;AAAA;AAGF,EAAA,MAAM,EAAE,KAAO,EAAA,OAAA,EAAS,KAAM,EAAA,GAAI,SAAS,YAEtC;AACH,IAAA,OAAO,QAAS,CAAA,WAAA,CAAY,UAAY,EAAA,EAAE,cAAc,CAAA;AAAA,GAC1D,EAAG,EAAE,CAAA;AAEL,EAAA,MAAM,OAAyB,GAAA;AAAA,IAC7B,EAAE,KAAO,EAAA,QAAA,EAAU,KAAO,EAAA,QAAA,EAAU,WAAW,IAAK,EAAA;AAAA,IACpD,EAAE,KAAO,EAAA,UAAA,EAAY,KAAO,EAAA,MAAA,EAAQ,OAAO,KAAM,EAAA;AAAA,IACjD,EAAE,KAAO,EAAA,UAAA,EAAY,KAAO,EAAA,MAAA,EAAQ,OAAO,KAAM;AAAA,GACnD;AAEA,EAAA,MAAM,IAAQ,GAAA,CAAA,KAAA,IAAS,EAAC,EAAG,IAAI,CAAU,MAAA,KAAA;AACvC,IAAA,MAAM,UAAa,GAAA,CAAA,EAAG,MAAO,CAAA,IAAA,CAAK,OAAQ,CAAA,CAAA,EAAG,UAAU,CAAA,CAAA,CAAA,EAAK,EAAE,CAAC,CAC7D,CAAA,EAAA,MAAA,CAAO,IACT,CAAA,CAAA;AAEA,IAAO,OAAA;AAAA,MACL,MAAQ,EAAA,UAAA;AAAA,MACR,IACE,kBAAA,GAAA;AAAA,QAAC,IAAA;AAAA,QAAA;AAAA,UACC,YAAW,EAAA,MAAA;AAAA,UACX,KAAA,EAAO,QAAQ,UAAU,CAAA,CAAA;AAAA,UACzB,IAAI,MAAO,CAAA,OAAA;AAAA,UAEX,8BAAC,UAAW,EAAA,EAAA,KAAA,EAAO,EAAE,QAAA,EAAU,IAAM,EAAA;AAAA;AAAA,OACvC;AAAA,MAEF,IACE,kBAAA,GAAA;AAAA,QAAC,IAAA;AAAA,QAAA;AAAA,UACC,YAAW,EAAA,MAAA;AAAA,UACX,KAAA,EAAO,QAAQ,UAAU,CAAA,CAAA;AAAA,UACzB,IAAI,MAAO,CAAA,OAAA;AAAA,UAEX,8BAAC,IAAK,EAAA,EAAA,KAAA,EAAO,EAAE,QAAA,EAAU,IAAM,EAAA;AAAA;AAAA;AACjC,KAEJ;AAAA,GACD,CAAA;AAED,EAAA,IAAI,KAAO,EAAA;AACT,IACE,uBAAA,IAAA,CAAC,KAAM,EAAA,EAAA,QAAA,EAAS,OAAQ,EAAA,QAAA,EAAA;AAAA,MAAA,qDAAA;AAAA,MAC8B,UAAA;AAAA,MAAW,IAAA;AAAA,MAAG,GAAA;AAAA,MACjE,KAAM,CAAA;AAAA,KACT,EAAA,CAAA;AAAA;AAIJ,EACE,uBAAA,GAAA;AAAA,IAAC,KAAA;AAAA,IAAA;AAAA,MACC,KAAM,EAAA,OAAA;AAAA,MACN,UAAU,CAAe,YAAA,EAAA,MAAA,CAAO,QAAS,CAAA,IAAI,OAAO,UAAU,CAAA,CAAA;AAAA,MAC9D,OAAA;AAAA,MACA,IAAA;AAAA,MACA,SAAW,EAAA,OAAA;AAAA,MACX,OAAS,EAAA;AAAA,QACP,OAAS,EAAA,OAAA;AAAA,QACT,QAAU,EAAA,EAAA;AAAA,QACV,mBAAqB,EAAA,KAAA;AAAA,QACrB,MAAQ,EAAA;AAAA,OACV;AAAA,MACA,YACE,kBAAA,GAAA,CAAC,GAAI,EAAA,EAAA,KAAA,EAAO,EAAE,SAAA,EAAW,QAAU,EAAA,OAAA,EAAS,MAAO,EAAA,EACjD,QAAC,kBAAA,IAAA,CAAA,UAAA,EAAA,EAAW,SAAQ,OAAQ,EAAA,QAAA,EAAA;AAAA,QAAA,uBAAA;AAAA,QACJ,OAAO,QAAS,CAAA,IAAA;AAAA,QAAK,MAAA;AAAA,QAAK;AAAA,OAAA,EAClD,CACF,EAAA;AAAA;AAAA,GAEJ;AAEJ;;;;"}
+{"version":3,"file":"EntityVaultTable.esm.js","sources":["../../../src/components/EntityVaultTable/EntityVaultTable.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 { Entity } from '@backstage/catalog-model';\nimport { Link, Table, TableColumn } from '@backstage/core-components';\nimport { useApi } from '@backstage/core-plugin-api';\nimport Box from '@material-ui/core/Box';\nimport Typography from '@material-ui/core/Typography';\nimport Edit from '@material-ui/icons/Edit';\nimport Visibility from '@material-ui/icons/Visibility';\nimport Alert from '@material-ui/lab/Alert';\nimport useAsync from 'react-use/esm/useAsync';\nimport { VaultSecret, vaultApiRef } from '../../api';\nimport {\n  VAULT_SECRET_ENGINE_ANNOTATION,\n  VAULT_SECRET_PATH_ANNOTATION,\n} from '../../constants';\n\nexport const vaultSecretConfig = (entity: Entity) => {\n  const secretPathAnnotation =\n    entity.metadata.annotations?.[VAULT_SECRET_PATH_ANNOTATION];\n  const secretPaths = secretPathAnnotation\n    ? secretPathAnnotation\n        .split(',')\n        .map(path => path.trim())\n        .filter(Boolean)\n    : [];\n  const secretEngine =\n    entity.metadata.annotations?.[VAULT_SECRET_ENGINE_ANNOTATION];\n\n  return { secretPaths, secretEngine };\n};\n\nexport const EntityVaultTable = ({ entity }: { entity: Entity }) => {\n  const vaultApi = useApi(vaultApiRef);\n  const { secretPaths, secretEngine } = vaultSecretConfig(entity);\n  if (!secretPaths || secretPaths.length === 0) {\n    throw Error(\n      `The secret path is undefined. Please, define the annotation ${VAULT_SECRET_PATH_ANNOTATION}`,\n    );\n  }\n\n  const { value, loading, error } = useAsync(async (): Promise<\n    { path: string; secrets: VaultSecret[]; createUrl?: string }[]\n  > => {\n    const results = await Promise.all(\n      secretPaths.map(async path => {\n        const response = await vaultApi\n          .listSecrets(path, { secretEngine })\n          .catch(() => ({\n            secrets: [],\n          }));\n\n        let createUrl: string | undefined = undefined;\n        if (response.secrets.length === 0) {\n          createUrl = await vaultApi.getCreateUrl?.(path, { secretEngine });\n        }\n        return {\n          path,\n          secrets: response.secrets,\n          createUrl,\n        };\n      }),\n    );\n    return results;\n  }, []);\n\n  const columns: TableColumn[] = [\n    { title: 'Path', field: 'path', width: '20%' },\n    { title: 'Secret', field: 'secret', highlight: true },\n    { title: 'View', field: 'view', width: '10%' },\n    { title: 'Edit', field: 'edit', width: '10%' },\n  ];\n\n  const data: any[] = [];\n\n  (value || []).forEach(({ path, secrets, createUrl }) => {\n    if (secrets.length === 0) {\n      // No secrets in this path - show a link to create one\n      data.push({\n        path,\n        secret: (\n          <Typography variant=\"body2\" color=\"textSecondary\">\n            No secrets, <Link to={createUrl || ''}>create one</Link>\n          </Typography>\n        ),\n        view: null,\n        edit: null,\n      });\n    } else {\n      secrets.forEach((secret, index) => {\n        const secretName = `${secret.path.replace(`${path}/`, '')}/${\n          secret.name\n        }`;\n        data.push({\n          path: index === 0 ? path : '',\n          secret: secretName,\n          view: (\n            <Link\n              aria-label=\"View\"\n              title={`View ${secretName}`}\n              to={secret.showUrl}\n            >\n              <Visibility style={{ fontSize: 16 }} />\n            </Link>\n          ),\n          edit: (\n            <Link\n              aria-label=\"Edit\"\n              title={`Edit ${secretName}`}\n              to={secret.editUrl}\n            >\n              <Edit style={{ fontSize: 16 }} />\n            </Link>\n          ),\n        });\n      });\n    }\n  });\n\n  if (error) {\n    return (\n      <Alert severity=\"error\">\n        Unexpected error while fetching secrets from path(s) '\n        {secretPaths.join(', ')}': {error.message}\n      </Alert>\n    );\n  }\n\n  const subtitle =\n    secretPaths.length === 1\n      ? `Secrets for ${entity.metadata.name} in ${secretPaths[0]}`\n      : `Secrets for ${entity.metadata.name} in ${secretPaths.length} paths`;\n\n  return (\n    <Table\n      title=\"Vault\"\n      subtitle={subtitle}\n      columns={columns}\n      data={data}\n      isLoading={loading}\n      options={{\n        padding: 'dense',\n        pageSize: 10,\n        emptyRowsWhenPaging: false,\n        search: false,\n      }}\n      emptyContent={\n        <Box style={{ textAlign: 'center', padding: '15px' }}>\n          <Typography variant=\"body1\">\n            No secrets found for {entity.metadata.name} in{' '}\n            {secretPaths.join(', ')}\n          </Typography>\n        </Box>\n      }\n    />\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;AA8Ba,MAAA,iBAAA,GAAoB,CAAC,MAAmB,KAAA;AACnD,EAAA,MAAM,oBACJ,GAAA,MAAA,CAAO,QAAS,CAAA,WAAA,GAAc,4BAA4B,CAAA;AAC5D,EAAA,MAAM,WAAc,GAAA,oBAAA,GAChB,oBACG,CAAA,KAAA,CAAM,GAAG,CACT,CAAA,GAAA,CAAI,CAAQ,IAAA,KAAA,IAAA,CAAK,MAAM,CAAA,CACvB,MAAO,CAAA,OAAO,IACjB,EAAC;AACL,EAAA,MAAM,YACJ,GAAA,MAAA,CAAO,QAAS,CAAA,WAAA,GAAc,8BAA8B,CAAA;AAE9D,EAAO,OAAA,EAAE,aAAa,YAAa,EAAA;AACrC;AAEO,MAAM,gBAAmB,GAAA,CAAC,EAAE,MAAA,EAAiC,KAAA;AAClE,EAAM,MAAA,QAAA,GAAW,OAAO,WAAW,CAAA;AACnC,EAAA,MAAM,EAAE,WAAA,EAAa,YAAa,EAAA,GAAI,kBAAkB,MAAM,CAAA;AAC9D,EAAA,IAAI,CAAC,WAAA,IAAe,WAAY,CAAA,MAAA,KAAW,CAAG,EAAA;AAC5C,IAAM,MAAA,KAAA;AAAA,MACJ,+DAA+D,4BAA4B,CAAA;AAAA,KAC7F;AAAA;AAGF,EAAA,MAAM,EAAE,KAAO,EAAA,OAAA,EAAS,KAAM,EAAA,GAAI,SAAS,YAEtC;AACH,IAAM,MAAA,OAAA,GAAU,MAAM,OAAQ,CAAA,GAAA;AAAA,MAC5B,WAAA,CAAY,GAAI,CAAA,OAAM,IAAQ,KAAA;AAC5B,QAAM,MAAA,QAAA,GAAW,MAAM,QAAA,CACpB,WAAY,CAAA,IAAA,EAAM,EAAE,YAAa,EAAC,CAClC,CAAA,KAAA,CAAM,OAAO;AAAA,UACZ,SAAS;AAAC,SACV,CAAA,CAAA;AAEJ,QAAA,IAAI,SAAgC,GAAA,KAAA,CAAA;AACpC,QAAI,IAAA,QAAA,CAAS,OAAQ,CAAA,MAAA,KAAW,CAAG,EAAA;AACjC,UAAA,SAAA,GAAY,MAAM,QAAS,CAAA,YAAA,GAAe,IAAM,EAAA,EAAE,cAAc,CAAA;AAAA;AAElE,QAAO,OAAA;AAAA,UACL,IAAA;AAAA,UACA,SAAS,QAAS,CAAA,OAAA;AAAA,UAClB;AAAA,SACF;AAAA,OACD;AAAA,KACH;AACA,IAAO,OAAA,OAAA;AAAA,GACT,EAAG,EAAE,CAAA;AAEL,EAAA,MAAM,OAAyB,GAAA;AAAA,IAC7B,EAAE,KAAO,EAAA,MAAA,EAAQ,KAAO,EAAA,MAAA,EAAQ,OAAO,KAAM,EAAA;AAAA,IAC7C,EAAE,KAAO,EAAA,QAAA,EAAU,KAAO,EAAA,QAAA,EAAU,WAAW,IAAK,EAAA;AAAA,IACpD,EAAE,KAAO,EAAA,MAAA,EAAQ,KAAO,EAAA,MAAA,EAAQ,OAAO,KAAM,EAAA;AAAA,IAC7C,EAAE,KAAO,EAAA,MAAA,EAAQ,KAAO,EAAA,MAAA,EAAQ,OAAO,KAAM;AAAA,GAC/C;AAEA,EAAA,MAAM,OAAc,EAAC;AAErB,EAAC,CAAA,KAAA,IAAS,EAAI,EAAA,OAAA,CAAQ,CAAC,EAAE,IAAA,EAAM,OAAS,EAAA,SAAA,EAAgB,KAAA;AACtD,IAAI,IAAA,OAAA,CAAQ,WAAW,CAAG,EAAA;AAExB,MAAA,IAAA,CAAK,IAAK,CAAA;AAAA,QACR,IAAA;AAAA,QACA,wBACG,IAAA,CAAA,UAAA,EAAA,EAAW,OAAQ,EAAA,OAAA,EAAQ,OAAM,eAAgB,EAAA,QAAA,EAAA;AAAA,UAAA,cAAA;AAAA,0BACnC,GAAA,CAAA,IAAA,EAAA,EAAK,EAAI,EAAA,SAAA,IAAa,IAAI,QAAU,EAAA,YAAA,EAAA;AAAA,SACnD,EAAA,CAAA;AAAA,QAEF,IAAM,EAAA,IAAA;AAAA,QACN,IAAM,EAAA;AAAA,OACP,CAAA;AAAA,KACI,MAAA;AACL,MAAQ,OAAA,CAAA,OAAA,CAAQ,CAAC,MAAA,EAAQ,KAAU,KAAA;AACjC,QAAA,MAAM,UAAa,GAAA,CAAA,EAAG,MAAO,CAAA,IAAA,CAAK,OAAQ,CAAA,CAAA,EAAG,IAAI,CAAA,CAAA,CAAA,EAAK,EAAE,CAAC,CACvD,CAAA,EAAA,MAAA,CAAO,IACT,CAAA,CAAA;AACA,QAAA,IAAA,CAAK,IAAK,CAAA;AAAA,UACR,IAAA,EAAM,KAAU,KAAA,CAAA,GAAI,IAAO,GAAA,EAAA;AAAA,UAC3B,MAAQ,EAAA,UAAA;AAAA,UACR,IACE,kBAAA,GAAA;AAAA,YAAC,IAAA;AAAA,YAAA;AAAA,cACC,YAAW,EAAA,MAAA;AAAA,cACX,KAAA,EAAO,QAAQ,UAAU,CAAA,CAAA;AAAA,cACzB,IAAI,MAAO,CAAA,OAAA;AAAA,cAEX,8BAAC,UAAW,EAAA,EAAA,KAAA,EAAO,EAAE,QAAA,EAAU,IAAM,EAAA;AAAA;AAAA,WACvC;AAAA,UAEF,IACE,kBAAA,GAAA;AAAA,YAAC,IAAA;AAAA,YAAA;AAAA,cACC,YAAW,EAAA,MAAA;AAAA,cACX,KAAA,EAAO,QAAQ,UAAU,CAAA,CAAA;AAAA,cACzB,IAAI,MAAO,CAAA,OAAA;AAAA,cAEX,8BAAC,IAAK,EAAA,EAAA,KAAA,EAAO,EAAE,QAAA,EAAU,IAAM,EAAA;AAAA;AAAA;AACjC,SAEH,CAAA;AAAA,OACF,CAAA;AAAA;AACH,GACD,CAAA;AAED,EAAA,IAAI,KAAO,EAAA;AACT,IACE,uBAAA,IAAA,CAAC,KAAM,EAAA,EAAA,QAAA,EAAS,OAAQ,EAAA,QAAA,EAAA;AAAA,MAAA,wDAAA;AAAA,MAErB,WAAA,CAAY,KAAK,IAAI,CAAA;AAAA,MAAE,KAAA;AAAA,MAAI,KAAM,CAAA;AAAA,KACpC,EAAA,CAAA;AAAA;AAIJ,EAAA,MAAM,WACJ,WAAY,CAAA,MAAA,KAAW,IACnB,CAAe,YAAA,EAAA,MAAA,CAAO,SAAS,IAAI,CAAA,IAAA,EAAO,YAAY,CAAC,CAAC,KACxD,CAAe,YAAA,EAAA,MAAA,CAAO,SAAS,IAAI,CAAA,IAAA,EAAO,YAAY,MAAM,CAAA,MAAA,CAAA;AAElE,EACE,uBAAA,GAAA;AAAA,IAAC,KAAA;AAAA,IAAA;AAAA,MACC,KAAM,EAAA,OAAA;AAAA,MACN,QAAA;AAAA,MACA,OAAA;AAAA,MACA,IAAA;AAAA,MACA,SAAW,EAAA,OAAA;AAAA,MACX,OAAS,EAAA;AAAA,QACP,OAAS,EAAA,OAAA;AAAA,QACT,QAAU,EAAA,EAAA;AAAA,QACV,mBAAqB,EAAA,KAAA;AAAA,QACrB,MAAQ,EAAA;AAAA,OACV;AAAA,MACA,YACE,kBAAA,GAAA,CAAC,GAAI,EAAA,EAAA,KAAA,EAAO,EAAE,SAAA,EAAW,QAAU,EAAA,OAAA,EAAS,MAAO,EAAA,EACjD,QAAC,kBAAA,IAAA,CAAA,UAAA,EAAA,EAAW,SAAQ,OAAQ,EAAA,QAAA,EAAA;AAAA,QAAA,uBAAA;AAAA,QACJ,OAAO,QAAS,CAAA,IAAA;AAAA,QAAK,KAAA;AAAA,QAAI,GAAA;AAAA,QAC9C,WAAA,CAAY,KAAK,IAAI;AAAA,OAAA,EACxB,CACF,EAAA;AAAA;AAAA,GAEJ;AAEJ;;;;"}

package/dist/index.d.ts

@@ -41,19 +41,31 @@ type VaultSecret = {
     showUrl: string;
     editUrl: string;
 };
+/**
+ * Response from listSecrets API call
+ * @public
+ */
+type ListSecretsResponse = {
+    secrets: VaultSecret[];
+    vaultUrl?: string;
+    createUrl?: string;
+};
 /**
  * Interface for the VaultApi.
  * @public
  */
 interface VaultApi {
     /**
-     * Returns a list of secrets used to show in a table.
+     * Returns a list of secrets used to show in a table along with vault URLs.
      * @param secretPath - The path where the secrets are stored in Vault
      * @param options - Additional options to be passed to the Vault API, allows to override vault default settings in app config file
      */
     listSecrets(secretPath: string, options?: {
         secretEngine?: string;
-    }): Promise<VaultSecret[]>;
+    }): Promise<ListSecretsResponse>;
+    getCreateUrl(secretPath: string, options?: {
+        secretEngine?: string;
+    }): Promise<string | undefined>;
 }
 
-export { EntityVaultCard, VAULT_SECRET_PATH_ANNOTATION, type VaultApi, type VaultSecret, isVaultAvailable, vaultApiRef, vaultPlugin };
+export { EntityVaultCard, type ListSecretsResponse, VAULT_SECRET_PATH_ANNOTATION, type VaultApi, type VaultSecret, isVaultAvailable, vaultApiRef, vaultPlugin };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage-community/plugin-vault",
-  "version": "0.15.0",
+  "version": "0.17.0",
   "description": "A Backstage plugin that integrates towards Vault",
   "backstage": {
     "role": "frontend-plugin",
@@ -45,11 +45,11 @@
   },
   "dependencies": {
     "@backstage/catalog-model": "^1.7.6",
-    "@backstage/core-components": "^0.18.4",
-    "@backstage/core-plugin-api": "^1.12.1",
+    "@backstage/core-components": "^0.18.6",
+    "@backstage/core-plugin-api": "^1.12.2",
     "@backstage/errors": "^1.2.7",
-    "@backstage/frontend-plugin-api": "^0.13.2",
-    "@backstage/plugin-catalog-react": "^1.21.4",
+    "@backstage/frontend-plugin-api": "^0.13.4",
+    "@backstage/plugin-catalog-react": "^1.21.6",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
@@ -81,10 +81,10 @@
     }
   },
   "devDependencies": {
-    "@backstage/cli": "^0.35.1",
-    "@backstage/core-app-api": "^1.19.3",
-    "@backstage/dev-utils": "^1.1.18",
-    "@backstage/plugin-catalog": "^1.32.1",
+    "@backstage/cli": "^0.35.3",
+    "@backstage/core-app-api": "^1.19.4",
+    "@backstage/dev-utils": "^1.1.19",
+    "@backstage/plugin-catalog": "^1.32.2",
     "@backstage/test-utils": "^1.7.14",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",