npm - @oas-tools/oas-telemetry - Versions diffs - 0.6.2 → 0.7.0-alpha.0 - Mend

@oas-tools/oas-telemetry 0.6.2 → 0.7.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (131) hide show

package/README.md +442 -442
package/dist/{config.cjs → cjs/config.cjs} +6 -7
package/dist/{exporters → cjs/exporters}/InMemoryDBMetricsExporter.cjs +5 -40
package/dist/cjs/exporters/InMemoryDbExporter.cjs +87 -0
package/dist/cjs/exporters/InMemoryLogRecordExporter.cjs +110 -0
package/dist/{exporters → cjs/exporters}/consoleExporter.cjs +2 -7
package/dist/{exporters → cjs/exporters}/dynamicExporter.cjs +12 -19
package/dist/cjs/index.cjs +43 -0
package/dist/cjs/instrumentation/index.cjs +28 -0
package/dist/cjs/instrumentation/logs.cjs +46 -0
package/dist/cjs/instrumentation/metrics.cjs +27 -0
package/dist/cjs/instrumentation/traces.cjs +19 -0
package/dist/{openTelemetry.cjs → cjs/openTelemetry.cjs} +6 -8
package/dist/{systemMetrics.cjs → cjs/systemMetrics.cjs} +7 -7
package/dist/cjs/tlm-ai/agent.cjs +79 -0
package/dist/cjs/tlm-ai/aiController.cjs +69 -0
package/dist/cjs/tlm-ai/aiRoutes.cjs +13 -0
package/dist/cjs/tlm-ai/knownMicroservices.cjs +13 -0
package/dist/cjs/tlm-ai/tools.cjs +504 -0
package/dist/{routes/authRoutes.cjs → cjs/tlm-auth/authController.cjs} +21 -28
package/dist/{middleware → cjs/tlm-auth}/authMiddleware.cjs +1 -1
package/dist/cjs/tlm-auth/authRoutes.cjs +14 -0
package/dist/cjs/tlm-log/logController.cjs +55 -0
package/dist/cjs/tlm-log/logRoutes.cjs +13 -0
package/dist/{routes → cjs/tlm-metric}/metricsRoutes.cjs +1 -2
package/dist/{controllers → cjs/tlm-plugin}/pluginController.cjs +31 -41
package/dist/cjs/tlm-plugin/pluginRoutes.cjs +13 -0
package/dist/{controllers/telemetryController.cjs → cjs/tlm-trace/traceController.cjs} +8 -19
package/dist/cjs/tlm-trace/traceRoutes.cjs +17 -0
package/dist/cjs/tlm-ui/uiController.cjs +27 -0
package/dist/cjs/tlm-ui/uiRoutes.cjs +31 -0
package/dist/cjs/tlm-util/utilController.cjs +63 -0
package/dist/cjs/tlm-util/utilRoutes.cjs +12 -0
package/dist/cjs/tlmRoutes.cjs +79 -0
package/dist/cjs/types/index.cjs +8 -0
package/dist/cjs/utils/circular.cjs +90 -0
package/dist/cjs/utils/logger.cjs +28 -0
package/{src → dist/esm}/config.js +20 -23
package/{src → dist/esm}/exporters/InMemoryDBMetricsExporter.js +57 -111
package/dist/esm/exporters/InMemoryDbExporter.js +87 -0
package/dist/esm/exporters/InMemoryLogRecordExporter.js +95 -0
package/{src → dist/esm}/exporters/consoleExporter.js +38 -47
package/{src → dist/esm}/exporters/dynamicExporter.js +50 -62
package/dist/esm/index.js +39 -0
package/dist/esm/instrumentation/index.js +26 -0
package/dist/esm/instrumentation/logs.js +34 -0
package/dist/esm/instrumentation/metrics.js +18 -0
package/dist/esm/instrumentation/traces.js +12 -0
package/{src → dist/esm}/openTelemetry.js +50 -58
package/dist/esm/systemMetrics.js +82 -0
package/dist/esm/tlm-ai/agent.js +68 -0
package/dist/esm/tlm-ai/aiController.js +45 -0
package/dist/esm/tlm-ai/aiRoutes.js +7 -0
package/dist/esm/tlm-ai/knownMicroservices.js +5 -0
package/dist/esm/tlm-ai/tools.js +490 -0
package/dist/esm/tlm-auth/authController.js +41 -0
package/{src/middleware → dist/esm/tlm-auth}/authMiddleware.js +12 -14
package/dist/esm/tlm-auth/authRoutes.js +7 -0
package/dist/esm/tlm-log/logController.js +36 -0
package/dist/esm/tlm-log/logRoutes.js +7 -0
package/{src/controllers → dist/esm/tlm-metric}/metricsController.js +28 -30
package/{src/routes → dist/esm/tlm-metric}/metricsRoutes.js +8 -15
package/{src/controllers → dist/esm/tlm-plugin}/pluginController.js +103 -115
package/dist/esm/tlm-plugin/pluginRoutes.js +7 -0
package/dist/esm/tlm-trace/traceController.js +54 -0
package/dist/esm/tlm-trace/traceRoutes.js +11 -0
package/dist/esm/tlm-ui/uiController.js +20 -0
package/dist/esm/tlm-ui/uiRoutes.js +23 -0
package/dist/esm/tlm-util/utilController.js +57 -0
package/dist/esm/tlm-util/utilRoutes.js +6 -0
package/dist/esm/tlmRoutes.js +72 -0
package/dist/esm/types/index.js +4 -0
package/dist/esm/utils/circular.js +84 -0
package/dist/esm/utils/logger.js +19 -0
package/dist/types/config.d.ts +6 -0
package/dist/types/exporters/InMemoryDBMetricsExporter.d.ts +15 -0
package/dist/types/exporters/InMemoryDbExporter.d.ts +24 -0
package/dist/types/exporters/InMemoryLogRecordExporter.d.ts +27 -0
package/dist/types/exporters/consoleExporter.d.ts +13 -0
package/dist/types/exporters/dynamicExporter.d.ts +25 -0
package/dist/types/index.d.ts +8 -0
package/dist/types/instrumentation/index.d.ts +1 -0
package/dist/types/instrumentation/logs.d.ts +1 -0
package/dist/types/instrumentation/metrics.d.ts +1 -0
package/dist/types/instrumentation/traces.d.ts +1 -0
package/dist/types/openTelemetry.d.ts +1 -0
package/dist/types/systemMetrics.d.ts +26 -0
package/dist/types/tlm-ai/agent.d.ts +1 -0
package/dist/types/tlm-ai/aiController.d.ts +4 -0
package/dist/types/tlm-ai/aiRoutes.d.ts +2 -0
package/dist/types/tlm-ai/knownMicroservices.d.ts +6 -0
package/dist/types/tlm-ai/tools.d.ts +45 -0
package/dist/types/tlm-auth/authController.d.ts +4 -0
package/dist/types/tlm-auth/authMiddleware.d.ts +2 -0
package/dist/types/tlm-auth/authRoutes.d.ts +2 -0
package/dist/types/tlm-log/logController.d.ts +4 -0
package/dist/types/tlm-log/logRoutes.d.ts +2 -0
package/dist/types/tlm-metric/metricsController.d.ts +4 -0
package/dist/types/tlm-metric/metricsRoutes.d.ts +2 -0
package/dist/types/tlm-plugin/pluginController.d.ts +3 -0
package/dist/types/tlm-plugin/pluginRoutes.d.ts +2 -0
package/dist/types/tlm-trace/traceController.d.ts +7 -0
package/dist/types/tlm-trace/traceRoutes.d.ts +2 -0
package/dist/types/tlm-ui/uiController.d.ts +8 -0
package/dist/types/tlm-ui/uiRoutes.d.ts +2 -0
package/dist/types/tlm-util/utilController.d.ts +3 -0
package/dist/types/tlm-util/utilRoutes.d.ts +2 -0
package/dist/types/tlmRoutes.d.ts +2 -0
package/dist/types/types/index.d.ts +56 -0
package/dist/types/utils/circular.d.ts +31 -0
package/dist/types/utils/logger.d.ts +9 -0
package/dist/ui/assets/index-BNhZBPi2.css +1 -0
package/dist/ui/assets/index-DxGAMrAl.js +401 -0
package/dist/ui/index.html +14 -0
package/dist/ui/vite.svg +1 -0
package/package.json +80 -77
package/dist/controllers/uiController.cjs +0 -78
package/dist/exporters/InMemoryDbExporter.cjs +0 -178
package/dist/index.cjs +0 -110
package/dist/routes/telemetryRoutes.cjs +0 -31
package/dist/services/uiService.cjs +0 -1520
package/src/controllers/telemetryController.js +0 -69
package/src/controllers/uiController.js +0 -69
package/src/dev/ui/login.html +0 -32
package/src/exporters/InMemoryDbExporter.js +0 -181
package/src/index.js +0 -121
package/src/routes/authRoutes.js +0 -53
package/src/routes/telemetryRoutes.js +0 -38
package/src/services/uiService.js +0 -1520
package/src/systemMetrics.js +0 -102
/package/dist/{controllers → cjs/tlm-metric}/metricsController.cjs +0 -0

package/dist/ui/index.html ADDED Viewed

@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="./vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>OAS-Telemetry</title>
+    <script type="module" crossorigin src="./assets/index-DxGAMrAl.js"></script>
+    <link rel="stylesheet" crossorigin href="./assets/index-BNhZBPi2.css">
+  </head>
+  <body>
+    <div id="root"></div>
+  </body>
+</html>

package/dist/ui/vite.svg ADDED Viewed

@@ -0,0 +1 @@

+ <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>

package/package.json CHANGED Viewed

@@ -1,77 +1,80 @@
-{
-  "name": "@oas-tools/oas-telemetry",
-  "version": "0.6.2",
-  "description": "This package exports an Express middleware that traces requests and responses of an Express application using OpenTelemetry.",
-  "author": "Manuel Otero",
-  "contributors": [
-    "Alejandro Santisteban",
-    "Pablo Fernandez"
-  ],
-  "license": "Apache-2.0",
-  "type": "module",
-  "scripts": {
-    "devImportUi": "node dev/ui/importUiToHtml.js",
-    "devExportUi": "node dev/ui/exportHtmlToUi.js",
-    "build": "babel src -d dist --out-file-extension .cjs",
-    "devUi": "nodemon --watch dev/ui src --ext html --exec \"npm run devExportUi && npm run build && node test/functional/otTestServer.cjs\"",
-    "devUiEsm": "nodemon --watch dev/ui --ext html --exec \"npm run devExportUi && node test/functional/otTestServer.mjs\"",
-    "publish": "npm run build && npm publish",
-    "testPerformance": "npm i && cd test/performance/ && ./test.sh",
-    "pretest": "npm run build",
-    "test": "npm run testCJS && npm run testMJS",
-    "build:dockerTest": "npm run build && docker build -t oastlm-test-ks-api -f ./test/performance/ks-api/Dockerfile .",
-    "testCJS": "npm run preTestCJS && npm run launchTestCJS && npm run postTestCJS",
-    "preTestCJS": "node test/functional/otTestServer.cjs &",
-    "launchTestCJS": "npx -y wait-on http://localhost:3000/api/v1/pets && npm run sendRequests && sleep 4 && npm run checkRequestsLog",
-    "postTestCJS": "kill `ps -uax | grep \"node test/functional/otTestServer\" | grep -v \"grep\" | grep -v \"sh\" | awk '{print $2}'`",
-    "testMJS": "npm run preTestMJS && npm run launchTestMJS && npm run postTestMJS",
-    "preTestMJS": "node test/functional/otTestServer.mjs &",
-    "launchTestMJS": "npx -y wait-on http://localhost:3000/api/v1/pets && npm run sendRequests && sleep 4 && npm run checkRequestsLog",
-    "postTestMJS": "kill `ps -uax | grep \"node test/functional/otTestServer\" | grep -v \"grep\" | grep -v \"sh\" | awk '{print $2}'`",
-    "sendRequests": "npx -y newman run test/functional/request-collection.json -e test/functional/request-environment.json",
-    "checkRequestsLog": "npx -y newman run test/functional/request-collection-check.json -e test/functional/request-environment.json",
-    "launchKSApi": "npm run build; (cd test/performance/ks-api ; node indexTelemetry.js)",
-    "launchDevel": "export OTDEBUG=true && npm run launchKSApi"
-  },
-  "files": [
-    "dist",
-    "src"
-  ],
-  "main": "./dist/index.cjs",
-  "module": "./src/index.js",
-  "exports": {
-    "require": "./dist/index.cjs",
-    "import": "./src/index.js",
-    "default": "./src/index.js"
-  },
-  "dependencies": {
-    "@opentelemetry/host-metrics": "^0.35.5",
-    "@opentelemetry/instrumentation-http": "^0.51.0",
-    "@opentelemetry/resources": "^1.24.0",
-    "@opentelemetry/sdk-node": "^0.49.1",
-    "@seald-io/nedb": "^4.0.4",
-    "axios": "^1.6.8",
-    "cookie-parser": "^1.4.7",
-    "dynamic-installer": "^1.1.1",
-    "express": "^4.19.2",
-    "flatted": "^3.3.2",
-    "import-from-string": "^0.0.4",
-    "js-yaml": "^4.1.0",
-    "jsonwebtoken": "^9.0.2",
-    "readline": "^1.3.0",
-    "v8": "^0.1.0"
-  },
-  "devDependencies": {
-    "@babel/cli": "^7.24.1",
-    "@babel/core": "^7.24.4",
-    "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
-    "@babel/preset-env": "^7.24.4",
-    "@opentelemetry/api": "^1.8.0",
-    "@opentelemetry/auto-instrumentations-node": "^0.43.0",
-    "apipecker": "^1.3.1",
-    "babel-plugin-add-module-exports": "^1.0.4",
-    "babel-plugin-module-extension": "^0.1.3",
-    "nodemon": "^3.1.0"
-  }
-}
+{
+  "name": "@oas-tools/oas-telemetry",
+  "version": "0.7.0-alpha.0",
+  "description": "Automatically collects and stores telemetry data in memory using OpenTelemetry. Just import the Express middleware to access it through the built-in REST API or web UI—no extra setup required.",
+  "author": "Manuel Otero",
+  "contributors": [
+    "Alejandro Santisteban",
+    "Pablo Fernandez"
+  ],
+  "license": "Apache-2.0",
+  "type": "module",
+  "scripts": {
+    "dev": "tsx test/functional/otTestServer.ts",
+    "esm": "echo 'Remember to execute: \"npm run build\"' && node test/functional/otTestServer.mjs",
+    "cjs": "echo 'Remember to execute: \"npm run build\"' && node test/functional/otTestServer.cjs",
+    "build": "npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc -p tsconfig.json",
+    "build:cjs": "babel ./dist/esm -d ./dist/cjs --out-file-extension .cjs --config-file ./.babelrc",
+    "lint": "eslint --ext .ts . --fix"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/cjs/index.cjs",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.cjs",
+      "import": "./dist/esm/index.js"
+    }
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@opentelemetry/core": "^2.0.1",
+    "@opentelemetry/host-metrics": "^0.36.0",
+    "@opentelemetry/instrumentation": "^0.202.0",
+    "@opentelemetry/instrumentation-http": "^0.51.0",
+    "@opentelemetry/sdk-logs": "^0.202.0",
+    "@opentelemetry/sdk-metrics": "^2.0.1",
+    "@opentelemetry/sdk-trace-node": "^2.0.1",
+    "@opentelemetry/semantic-conventions": "^1.34.0",
+    "@seald-io/nedb": "^4.0.4",
+    "axios": "^1.10.0",
+    "cookie-parser": "^1.4.7",
+    "cors": "^2.8.5",
+    "dotenv": "^16.5.0",
+    "dynamic-installer": "^1.1.1",
+    "express": "^4.21.2",
+    "import-from-string": "^0.0.4",
+    "js-yaml": "^4.1.0",
+    "jsonwebtoken": "^9.0.2",
+    "minisearch": "^7.1.2",
+    "openai": "^5.6.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.24.1",
+    "@babel/core": "^7.24.4",
+    "@babel/plugin-transform-class-properties": "^7.27.1",
+    "@babel/plugin-transform-object-rest-spread": "^7.27.3",
+    "@babel/preset-env": "^7.24.4",
+    "@eslint/js": "^9.29.0",
+    "@opentelemetry/api": "^1.8.0",
+    "@types/cookie-parser": "^1.4.9",
+    "@types/cors": "^2.8.19",
+    "@types/express": "^5.0.3",
+    "@types/js-yaml": "^4.0.9",
+    "@types/jsonwebtoken": "^9.0.9",
+    "babel-plugin-add-module-exports": "^1.0.4",
+    "babel-plugin-module-extension": "^0.1.3",
+    "babel-plugin-transform-import-meta": "^2.3.3",
+    "eslint": "^9.29.0",
+    "eslint-plugin-import": "^2.32.0",
+    "tsx": "^4.20.1",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.34.1"
+  }
+}

package/dist/controllers/uiController.cjs DELETED Viewed

@@ -1,78 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.specLoader = exports.mainPage = exports.detailPage = exports.apiPage = void 0;
-var _config = require("../config.cjs");
-var _fs = require("fs");
-var _path = _interopRequireDefault(require("path"));
-var _jsYaml = _interopRequireDefault(require("js-yaml"));
-var _uiService = _interopRequireDefault(require("../services/uiService.cjs"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-const apiPage = (req, res) => {
-  const baseURL = _config.globalOasTlmConfig.baseURL;
-  let text = `
-    <h1>Telemetry API routes:</h1>
-    <ul>
-        <li><a href="${baseURL}/start">${baseURL}/start</a></li>
-        <li><a href="${baseURL}/stop">${baseURL}/stop</a></li>
-        <li><a href="${baseURL}/status">${baseURL}/status</a></li>
-        <li><a href="${baseURL}/reset">${baseURL}/reset</a></li>
-        <li><a href="${baseURL}/list">${baseURL}/list</a></li>
-        <li><a href="${baseURL}/heapStats">${baseURL}/heapStats</a></li>
-        <li>${baseURL}/find [POST]</li>
-    </ul>
-    `;
-  res.send(text);
-};
-exports.apiPage = apiPage;
-const mainPage = (req, res) => {
-  const baseURL = _config.globalOasTlmConfig.baseURL;
-  res.set('Content-Type', 'text/html');
-  res.send((0, _uiService.default)(baseURL).main);
-};
-exports.mainPage = mainPage;
-const detailPage = (req, res) => {
-  const baseURL = _config.globalOasTlmConfig.baseURL;
-  res.set('Content-Type', 'text/html');
-  res.send((0, _uiService.default)(baseURL).detail);
-};
-exports.detailPage = detailPage;
-const specLoader = (req, res) => {
-  if (_config.globalOasTlmConfig.specFileName) {
-    try {
-      const data = (0, _fs.readFileSync)(_config.globalOasTlmConfig.specFileName, {
-        encoding: 'utf8',
-        flag: 'r'
-      });
-      const extension = _path.default.extname(_config.globalOasTlmConfig.specFileName);
-      let json = data;
-      if (extension == _jsYaml.default) json = JSON.stringify(_jsYaml.default.SafeLoad(data), null, 2);
-      res.setHeader('Content-Type', 'application/json');
-      res.send(json);
-    } catch (e) {
-      console.error(`ERROR loading spec file ${_config.globalOasTlmConfig.specFileName}: ${e}`);
-    }
-  } else if (_config.globalOasTlmConfig.spec) {
-    let spec = false;
-    try {
-      spec = JSON.parse(_config.globalOasTlmConfig.spec);
-    } catch (ej) {
-      try {
-        spec = JSON.stringify(_jsYaml.default.load(_config.globalOasTlmConfig.spec), null, 2);
-      } catch (ey) {
-        console.error(`Error parsing spec: ${ej} - ${ey}`);
-      }
-    }
-    if (!spec) {
-      res.status(404);
-    } else {
-      res.setHeader('Content-Type', 'application/json');
-      res.send(spec);
-    }
-  } else {
-    res.status(404);
-  }
-};
-exports.specLoader = specLoader;

package/dist/exporters/InMemoryDbExporter.cjs DELETED Viewed

@@ -1,178 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.InMemoryExporter = void 0;
-var _core = require("@opentelemetry/core");
-var _nedb = _interopRequireDefault(require("@seald-io/nedb"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
-function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
-let dbglog = () => {};
-if (process.env.OTDEBUG == "true") dbglog = console.log;
-//import in memory database
-class InMemoryExporter {
-  constructor() {
-    // Overrided by dynamic exporter
-    _defineProperty(this, "plugins", []);
-    this._spans = new _nedb.default();
-    this._stopped = true;
-  }
-  export(readableSpans, resultCallback) {
-    try {
-      if (!this._stopped) {
-        // Prepare spans to be inserted into the in-memory database (remove circular references and convert to nested objects)
-        const cleanSpans = readableSpans.map(nestedSpan => removeCircularRefs(nestedSpan)) // to avoid JSON parsing error
-        .map(span => applyNesting(span)) // to avoid dot notation in keys (neDB does not support dot notation in keys)
-        .filter(span => !span.attributes?.http?.target?.includes("/telemetry")); // to avoid telemetry spans
-        // Insert spans into the in-memory database
-        this._spans.insert(cleanSpans, (err, newDoc) => {
-          // p = {name, plugin
-          this.plugins.forEach((pluginResource, i) => {
-            cleanSpans.forEach(t => {
-              dbglog(`Sending trace <${t._id}> to plugin (Plugin #${i}) <${pluginResource.name}>`);
-              dbglog(`Trace: \n<${JSON.stringify(t, null, 2)}`);
-              //TODO: This should be called newSpan instead of newTrace
-              pluginResource.plugin.newTrace(t);
-            });
-          });
-          if (err) {
-            console.error(err);
-            return;
-          }
-        });
-      }
-      setTimeout(() => resultCallback({
-        code: _core.ExportResultCode.SUCCESS
-      }), 0);
-    } catch (error) {
-      console.error('Error exporting spans\n' + error.message + '\n' + error.stack);
-      return resultCallback({
-        code: _core.ExportResultCode.FAILED,
-        error: new Error('Error exporting spans\n' + error.message + '\n' + error.stack)
-      });
-    }
-  }
-  start() {
-    this._stopped = false;
-  }
-  stop() {
-    this._stopped = true;
-  }
-  isRunning() {
-    return !this._stopped;
-  }
-  shutdown() {
-    this._stopped = true;
-    this._spans = new _nedb.default();
-    return this.forceFlush();
-  }
-  /**
-   * Exports any pending spans in the exporter
-   */
-  forceFlush() {
-    return Promise.resolve();
-  }
-  //err,docs
-  find(search, callback) {
-    this._spans.find(search, callback);
-  }
-  reset() {
-    this._spans = new _nedb.default();
-  }
-  getFinishedSpans() {
-    return this._spans.getAllData();
-  }
-}
-exports.InMemoryExporter = InMemoryExporter;
-function removeCircularRefs(obj) {
-  const seen = new WeakMap(); // Used to keep track of visited objects
-  // Replacer function to handle circular references
-  function replacer(key, value) {
-    if (key === "_spanProcessor") {
-      return "oas-telemetry skips this field to avoid circular reference";
-    }
-    // GENERIC CIRCULAR REFERENCE HANDLING
-    // if (typeof value === "object" && value !== null) {
-    //     // If the object has been visited before, return the name prefixed with "CIRCULAR+"
-    //     if (seen.has(value)) {
-    //         return `CIRCULAR${key}`;
-    //     }
-    //     seen.set(value, key); // Mark the object as visited with its name
-    // }
-    return value;
-  }
-  // Convert the object to a string and then parse it back
-  // This will trigger the replacer function to handle circular references
-  const jsonString = JSON.stringify(obj, replacer);
-  return JSON.parse(jsonString);
-}
-/**
- * Recursively converts dot-separated keys in an object to nested objects.
- *
- * @param {Object} obj - The object to process.
- * @returns {Object} - The object with all dot-separated keys converted to nested objects.
- * @example
- * // Input:
- * // {
- * //   "http.method": "GET",
- * //   "http.url": "http://example.com",
- * //   "nested.obj.key": "value"
- * // }
- * // Output:
- * // {
- * //   "http": {
- * //     "method": "GET",
- * //     "url": "http://example.com"
- * //   },
- * //   "nested": {
- * //     "obj": {
- * //       "key": "value"
- * //     }
- * //   }
- * // }
- */
-function convertToNestedObject(obj) {
-  const result = {};
-  for (const key in obj) {
-    const keys = key.split('.');
-    let temp = result;
-    for (let i = 0; i < keys.length; i++) {
-      const currentKey = keys[i];
-      if (i === keys.length - 1) {
-        // Last key, set the value
-        temp[currentKey] = obj[key];
-      } else {
-        // Intermediate key, ensure the object exists
-        if (!temp[currentKey]) {
-          temp[currentKey] = {};
-        }
-        temp = temp[currentKey];
-      }
-    }
-  }
-  return result;
-}
-/**
- * Applies nesting to all dot-separated keys within an object.
- *
- * @param {Object} obj - The object to apply nesting to.
- * @returns {Object} - The transformed object with nested structures.
- */
-function applyNesting(obj) {
-  // Recursively apply convertToNestedObject to each level of the object
-  for (const key in obj) {
-    if (typeof obj[key] === 'object' && obj[key] !== null) {
-      obj[key] = applyNesting(obj[key]);
-    }
-  }
-  return convertToNestedObject(obj);
-}

package/dist/index.cjs DELETED Viewed

@@ -1,110 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = oasTelemetry;
-require("./openTelemetry.cjs");
-var _config = require("./config.cjs");
-var _cookieParser = _interopRequireDefault(require("cookie-parser"));
-var _express = require("express");
-var _authMiddleware = require("./middleware/authMiddleware.cjs");
-var _authRoutes = _interopRequireDefault(require("./routes/authRoutes.cjs"));
-var _telemetryRoutes = require("./routes/telemetryRoutes.cjs");
-var _InMemoryDbExporter = require("./exporters/InMemoryDbExporter.cjs");
-var _metricsRoutes = _interopRequireDefault(require("./routes/metricsRoutes.cjs"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-let dbglog = () => {};
-if (process.env.OTDEBUG == "true") dbglog = console.log;
-/**
- * Returns the Oas Telemetry middleware. The parameters are the same as `globalOasTlmConfig`.
- * All parameters are optional. However, either `spec` or `specFileName` must be provided to enable endpoint filtering.
- *
- * @param {Object} OasTlmConfig Configuration object.
- * @param {string} [OasTlmConfig.baseURL="/telemetry"] The base URL for the telemetry routes.
- * @param {Object} [OasTlmConfig.spec] The OpenAPI spec object.
- * @param {string} [OasTlmConfig.specFileName] Alternative to `spec`: the path to the OpenAPI spec file.
- * @param {boolean} [OasTlmConfig.autoActivate=true] Whether to start telemetry automatically on load.
- * @param {boolean} [OasTlmConfig.authEnabled=true] Whether to enable authentication middleware.
- * @param {number} [OasTlmConfig.apiKeyMaxAge=1800000] The maximum age of the API key in milliseconds.
- * @param {string} [OasTlmConfig.defaultApiKey] The default API key to use.
- * @param {OasTlmExporter} [OasTlmConfig.exporter=InMemoryExporter] The exporter to use. Must implement the `OasTlmExporter` interface.
- * @returns {Router} The middleware router for Oas Telemetry.
- */
-function oasTelemetry(OasTlmConfig) {
-  const router = (0, _express.Router)();
-  if (process.env.OASTLM_MODULE_DISABLED === 'true') {
-    return router;
-  }
-  ;
-  if (OasTlmConfig) {
-    console.log("User provided config");
-    // Global = user-provided || default, for each key
-    for (const key in _config.globalOasTlmConfig) {
-      _config.globalOasTlmConfig[key] = OasTlmConfig[key] ?? _config.globalOasTlmConfig[key];
-    }
-  }
-  console.log("baseURL: ", _config.globalOasTlmConfig.baseURL);
-  _config.globalOasTlmConfig.dynamicExporter.changeExporter(_config.globalOasTlmConfig.exporter ?? new _InMemoryDbExporter.InMemoryExporter());
-  if (_config.globalOasTlmConfig.spec) dbglog(`Spec content provided`);else {
-    if (_config.globalOasTlmConfig.specFileName != "") dbglog(`Spec file used for telemetry: ${_config.globalOasTlmConfig.specFileName}`);else {
-      console.error("No spec available !");
-    }
-  }
-  let allAuthMiddlewares = getWrappedMiddlewares(() => _config.globalOasTlmConfig.authEnabled, [(0, _cookieParser.default)(), _authRoutes.default, _authMiddleware.authMiddleware]);
-  const baseURL = _config.globalOasTlmConfig.baseURL;
-  router.use((0, _express.json)());
-  router.use(baseURL, allAuthMiddlewares);
-  router.use(baseURL, _telemetryRoutes.telemetryRoutes);
-  router.use(baseURL + "/metrics", _metricsRoutes.default);
-  if (_config.globalOasTlmConfig.autoActivate) {
-    _config.globalOasTlmConfig.dynamicExporter.exporter?.start();
-  }
-  return router;
-}
-/**
- * @typedef OasTlmExporter
- * Represents an exporter that processes and manages telemetry data.
- * Any custom exporter must implement these methods.
- *
- * @method {void} start() Starts the exporter, allowing it to process data.
- * @method {void} stop() Stops the exporter and halts data processing.
- * @method {void} reset() Resets the internal state of the exporter (e.g., clears buffers or data stores).
- * @method {boolean} isRunning() Returns whether the exporter is actively processing data.
- * @method {Array} getFinishedSpans() Retrieves the collected spans from the exporter.
- * @method {any} export(ReadableSpan, SpanExporterResultCallback) Exports spans.
- * @method {Promise<void>} shutdown() Gracefully shuts down the exporter, flushing data if necessary.
- * @method {Promise<void>} forceFlush() Exports any pending data that has not yet been processed.
- * @property {Array} plugins An array of plugins that can be activated by the exporter.
- */
-/**
- * This function wraps the provided middleware functions with a condition callback.
- * If the condition callback returns true, the middleware/router will be executed.
- * If the condition callback returns false, the middleware/router will be skipped.
- *
- * @callback {function} conditionCallback A callback function that returns a boolean to determine if the middleware should be used.
- * @param {Array} middlewares An array of middleware or routers to be wrapped.
- * @returns {Array} An array of wrapped middleware functions.
- */
-function getWrappedMiddlewares(conditionCallback, middlewares) {
-  return middlewares.map(middleware => {
-    return function (req, res, next) {
-      if (conditionCallback()) {
-        if (typeof middleware === 'function') {
-          // look for handle property, if it exists, it's a router. If not call middleware
-          if (middleware.handle) {
-            middleware.handle(req, res, next);
-          } else {
-            middleware(req, res, next);
-          }
-        }
-      } else {
-        next();
-      }
-    };
-  });
-}
-module.exports = exports.default;

package/dist/routes/telemetryRoutes.cjs DELETED Viewed

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.telemetryRoutes = exports.default = void 0;
-var _express = require("express");
-var _uiController = require("../controllers/uiController.cjs");
-var _telemetryController = require("../controllers/telemetryController.cjs");
-var _pluginController = require("../controllers/pluginController.cjs");
-const telemetryRoutes = exports.telemetryRoutes = (0, _express.Router)();
-// Main Pages
-telemetryRoutes.get('/', _uiController.mainPage);
-telemetryRoutes.get('/detail/*', _uiController.detailPage);
-telemetryRoutes.get('/spec', _uiController.specLoader);
-telemetryRoutes.get('/api', _uiController.apiPage);
-// Telemetry Control
-telemetryRoutes.get('/start', _telemetryController.startTelemetry);
-telemetryRoutes.get('/stop', _telemetryController.stopTelemetry);
-telemetryRoutes.get('/status', _telemetryController.statusTelemetry);
-telemetryRoutes.get('/reset', _telemetryController.resetTelemetry);
-telemetryRoutes.get('/list', _telemetryController.listTelemetry);
-telemetryRoutes.post('/find', _telemetryController.findTelemetry);
-telemetryRoutes.get('/heapStats', _telemetryController.heapStats);
-// Plugins
-telemetryRoutes.get('/plugins', _pluginController.listPlugins);
-telemetryRoutes.post('/plugins', _pluginController.registerPlugin);
-var _default = exports.default = telemetryRoutes;