@saishnarvekar/plugin-elastic-devtool-backend 0.1.0

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2026 Saish Narvekar
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,81 @@
+developing the plugin backend itself.
+
+# Elastic Dev Tool Plugin for Backstage (Backend)
+
+![Backstage Logo](https://backstage.io/img/logo.svg)
+
+> [!TIP]
+> Backend API for Elasticsearch management and query in Backstage.
+
+---
+
+## Overview
+
+`@saishnarvekar/plugin-elastic-devtool-backend` provides the backend API and service layer for the Elastic Dev Tool plugin, enabling secure, robust Elasticsearch operations from your Backstage instance.
+
+---
+
+## Features
+
+- REST API for Elasticsearch query and index management
+- Secure proxy to your Elasticsearch cluster
+- Cluster health and stats endpoints
+- Built with Backstage backend best practices
+
+---
+
+## Installation
+
+Add the backend plugin to your Backstage backend:
+
+```bash
+yarn --cwd packages/backend add @saishnarvekar/plugin-elastic-devtool-backend
+```
+
+---
+
+## Usage
+
+Register the plugin in your backend (e.g. in `packages/backend/src/index.ts`):
+
+```ts
+import { elasticDevToolPlugin } from '@saishnarvekar/plugin-elastic-devtool-backend';
+
+const backend = createBackend();
+// ...existing code...
+backend.add(elasticDevToolPlugin());
+```
+
+Configure your Elasticsearch connection in `app-config.yaml`:
+
+```yaml
+elastic:
+	baseUrl: 'http://localhost:9200'
+	username: 'elastic'  # optional
+	password: 'password' # optional
+```
+
+---
+
+## Development
+
+To run the backend plugin in isolation for development:
+
+```bash
+yarn start
+```
+
+This will launch a local backend server for rapid development and testing.
+
+---
+
+## Resources
+
+- [Backstage Backend Plugins](https://backstage.io/docs/backend-system/)
+- [Elasticsearch Node.js Client](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/)
+- [Backstage Plugin Authoring](https://backstage.io/docs/plugins/)
+
+---
+
+> [!IMPORTANT]
+> Use together with [`@saishnarvekar/plugin-elastic-devtool`](../elastic-devtool/) for a complete frontend + backend solution.

package/dist/index.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var plugin = require('./plugin.cjs.js');
+
+
+
+exports.default = plugin.elasticDevtoolPlugin;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+/**
+ * elasticDevtoolPlugin backend plugin
+ *
+ * @public
+ */
+declare const elasticDevtoolPlugin: _backstage_backend_plugin_api.BackendFeature;
+
+export { elasticDevtoolPlugin as default };

package/dist/plugin.cjs.js

@@ -0,0 +1,28 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var router = require('./router.cjs.js');
+
+const elasticDevtoolPlugin = backendPluginApi.createBackendPlugin({
+  pluginId: "elastic-devtool",
+  register(env) {
+    env.registerInit({
+      deps: {
+        httpRouter: backendPluginApi.coreServices.httpRouter,
+        config: backendPluginApi.coreServices.rootConfig
+      },
+      async init({ httpRouter, config }) {
+        httpRouter.use(
+          await router.createRouter({ config })
+        );
+        httpRouter.addAuthPolicy({
+          path: "/health",
+          allow: "unauthenticated"
+        });
+      }
+    });
+  }
+});
+
+exports.elasticDevtoolPlugin = elasticDevtoolPlugin;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["import {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './router';\n\n/**\n * elasticDevtoolPlugin backend plugin\n *\n * @public\n */\nexport const elasticDevtoolPlugin = createBackendPlugin({\n  pluginId: 'elastic-devtool',\n  register(env) {\n    env.registerInit({\n      deps: {\n        httpRouter: coreServices.httpRouter,\n        config: coreServices.rootConfig,\n      },\n      async init({ httpRouter, config }) {\n        httpRouter.use(\n          await createRouter({ config }),\n        );\n        httpRouter.addAuthPolicy({\n          path: '/health',\n          allow: 'unauthenticated',\n        });\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","coreServices","createRouter"],"mappings":";;;;;AAWO,MAAM,uBAAuBA,oCAAA,CAAoB;AAAA,EACtD,QAAA,EAAU,iBAAA;AAAA,EACV,SAAS,GAAA,EAAK;AACZ,IAAA,GAAA,CAAI,YAAA,CAAa;AAAA,MACf,IAAA,EAAM;AAAA,QACJ,YAAYC,6BAAA,CAAa,UAAA;AAAA,QACzB,QAAQA,6BAAA,CAAa;AAAA,OACvB;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,UAAA,EAAY,QAAO,EAAG;AACjC,QAAA,UAAA,CAAW,GAAA;AAAA,UACT,MAAMC,mBAAA,CAAa,EAAE,MAAA,EAAQ;AAAA,SAC/B;AACA,QAAA,UAAA,CAAW,aAAA,CAAc;AAAA,UACvB,IAAA,EAAM,SAAA;AAAA,UACN,KAAA,EAAO;AAAA,SACR,CAAA;AAAA,MACH;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;"}

package/dist/router.cjs.js

@@ -0,0 +1,55 @@
+'use strict';
+
+var express = require('express');
+var Router = require('express-promise-router');
+var elasticsearch = require('@elastic/elasticsearch');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var express__default = /*#__PURE__*/_interopDefaultCompat(express);
+var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
+
+async function createRouter(options) {
+  const router = Router__default.default();
+  router.use(express__default.default.json());
+  const esNode = options.config.getString("elastic-devtool.elasticsearch.node");
+  const esUsername = options.config.getString("elastic-devtool.elasticsearch.username");
+  const esPassword = options.config.getString("elastic-devtool.elasticsearch.password");
+  const esClient = new elasticsearch.Client({
+    node: esNode,
+    auth: {
+      username: esUsername,
+      password: esPassword
+    },
+    tls: {
+      rejectUnauthorized: false
+    }
+  });
+  router.get("/health", async (_, res) => {
+    res.json({ status: "ok" });
+  });
+  router.get("/indices", async (_, res) => {
+    try {
+      const result = await esClient.cat.indices({ format: "json" });
+      const names = result.map((r) => r.index);
+      res.json(names);
+    } catch (error) {
+      res.status(500).json({ error: String(error) });
+    }
+  });
+  router.post("/search", async (req, res) => {
+    const body = req.body;
+    console.info("Received ES query", { body });
+    try {
+      const result = await esClient.search(body);
+      res.json(result);
+    } catch (error) {
+      console.error("ES query failed", { error });
+      res.status(500).json({ error: String(error) });
+    }
+  });
+  return router;
+}
+
+exports.createRouter = createRouter;
+//# sourceMappingURL=router.cjs.js.map

package/dist/router.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.cjs.js","sources":["../src/router.ts"],"sourcesContent":["import express from 'express';\nimport Router from 'express-promise-router';\nimport { Client } from '@elastic/elasticsearch';\n\nexport async function createRouter(options: {config: any}): Promise<express.Router> {\n  const router = Router();\n  router.use(express.json());\n\n  const esNode = options.config.getString(\"elastic-devtool.elasticsearch.node\");\n  const esUsername = options.config.getString(\"elastic-devtool.elasticsearch.username\");\n  const esPassword = options.config.getString(\"elastic-devtool.elasticsearch.password\");\n  \n  const esClient = new Client({\n    node: esNode,\n    auth: {\n      username: esUsername,\n      password: esPassword,\n    },\n    tls: {\n      rejectUnauthorized: false,\n    },\n  });\n\n  router.get('/health', async (_, res) => {\n    res.json({ status: 'ok' });\n  });\n\n  router.get('/indices', async (_, res) => {\n    try {\n      const result = await esClient.cat.indices({ format: 'json' });\n      const names = result.map(r => r.index);\n      res.json(names);\n    } catch (error) {\n      res.status(500).json({ error: String(error) });\n    }\n  });\n\n  router.post('/search', async (req, res) => {\n    const body = req.body;\n    console.info('Received ES query', { body });\n    try {\n      const result = await esClient.search(body);\n      res.json(result);\n    } catch (error) {\n      console.error('ES query failed', { error });\n      res.status(500).json({ error: String(error) });\n    }\n  });\n  return router;\n}\n"],"names":["Router","express","Client"],"mappings":";;;;;;;;;;;AAIA,eAAsB,aAAa,OAAA,EAAiD;AAClF,EAAA,MAAM,SAASA,uBAAA,EAAO;AACtB,EAAA,MAAA,CAAO,GAAA,CAAIC,wBAAA,CAAQ,IAAA,EAAM,CAAA;AAEzB,EAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,MAAA,CAAO,SAAA,CAAU,oCAAoC,CAAA;AAC5E,EAAA,MAAM,UAAA,GAAa,OAAA,CAAQ,MAAA,CAAO,SAAA,CAAU,wCAAwC,CAAA;AACpF,EAAA,MAAM,UAAA,GAAa,OAAA,CAAQ,MAAA,CAAO,SAAA,CAAU,wCAAwC,CAAA;AAEpF,EAAA,MAAM,QAAA,GAAW,IAAIC,oBAAA,CAAO;AAAA,IAC1B,IAAA,EAAM,MAAA;AAAA,IACN,IAAA,EAAM;AAAA,MACJ,QAAA,EAAU,UAAA;AAAA,MACV,QAAA,EAAU;AAAA,KACZ;AAAA,IACA,GAAA,EAAK;AAAA,MACH,kBAAA,EAAoB;AAAA;AACtB,GACD,CAAA;AAED,EAAA,MAAA,CAAO,GAAA,CAAI,SAAA,EAAW,OAAO,CAAA,EAAG,GAAA,KAAQ;AACtC,IAAA,GAAA,CAAI,IAAA,CAAK,EAAE,MAAA,EAAQ,IAAA,EAAM,CAAA;AAAA,EAC3B,CAAC,CAAA;AAED,EAAA,MAAA,CAAO,GAAA,CAAI,UAAA,EAAY,OAAO,CAAA,EAAG,GAAA,KAAQ;AACvC,IAAA,IAAI;AACF,MAAA,MAAM,MAAA,GAAS,MAAM,QAAA,CAAS,GAAA,CAAI,QAAQ,EAAE,MAAA,EAAQ,QAAQ,CAAA;AAC5D,MAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,GAAA,CAAI,CAAA,CAAA,KAAK,EAAE,KAAK,CAAA;AACrC,MAAA,GAAA,CAAI,KAAK,KAAK,CAAA;AAAA,IAChB,SAAS,KAAA,EAAO;AACd,MAAA,GAAA,CAAI,MAAA,CAAO,GAAG,CAAA,CAAE,IAAA,CAAK,EAAE,KAAA,EAAO,MAAA,CAAO,KAAK,CAAA,EAAG,CAAA;AAAA,IAC/C;AAAA,EACF,CAAC,CAAA;AAED,EAAA,MAAA,CAAO,IAAA,CAAK,SAAA,EAAW,OAAO,GAAA,EAAK,GAAA,KAAQ;AACzC,IAAA,MAAM,OAAO,GAAA,CAAI,IAAA;AACjB,IAAA,OAAA,CAAQ,IAAA,CAAK,mBAAA,EAAqB,EAAE,IAAA,EAAM,CAAA;AAC1C,IAAA,IAAI;AACF,MAAA,MAAM,MAAA,GAAS,MAAM,QAAA,CAAS,MAAA,CAAO,IAAI,CAAA;AACzC,MAAA,GAAA,CAAI,KAAK,MAAM,CAAA;AAAA,IACjB,SAAS,KAAA,EAAO;AACd,MAAA,OAAA,CAAQ,KAAA,CAAM,iBAAA,EAAmB,EAAE,KAAA,EAAO,CAAA;AAC1C,MAAA,GAAA,CAAI,MAAA,CAAO,GAAG,CAAA,CAAE,IAAA,CAAK,EAAE,KAAA,EAAO,MAAA,CAAO,KAAK,CAAA,EAAG,CAAA;AAAA,IAC/C;AAAA,EACF,CAAC,CAAA;AACD,EAAA,OAAO,MAAA;AACT;;;;"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@saishnarvekar/plugin-elastic-devtool-backend",
+  "version": "0.1.0",
+  "license": "Apache-2.0",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "backend-plugin",
+    "pluginId": "elastic-devtool",
+    "pluginPackages": [
+      "@saishnarvekar/plugin-elastic-devtool",
+      "@saishnarvekar/plugin-elastic-devtool-backend"
+    ],
+    "features": {
+      ".": "@backstage/BackendFeature"
+    }
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/backend-defaults": "^0.13.0",
+    "@backstage/backend-plugin-api": "^1.4.4",
+    "@backstage/catalog-client": "^1.12.0",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/plugin-catalog-node": "^1.19.1",
+    "@backstage/types": "^1.2.2",
+    "@elastic/elasticsearch": "^9.2.0",
+    "express": "^4.17.1",
+    "express-promise-router": "^4.1.0",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^1.9.1",
+    "@backstage/cli": "^0.34.4",
+    "@types/express": "^4.17.6",
+    "@types/supertest": "^2.0.12",
+    "supertest": "^6.2.4"
+  },
+  "files": [
+    "dist"
+  ],
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
+  }
+}