@oas-tools/oas-telemetry 0.7.0-alpha.2 → 0.7.0-alpha.4

package/dist/cjs/tlm-plugin/pluginService.cjs

@@ -0,0 +1,79 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.pluginService = void 0;
+var _logger = _interopRequireDefault(require("../utils/logger.cjs"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+class PluginService {
+  constructor() {
+    this.plugins = [];
+  }
+  getPlugins() {
+    return this.plugins;
+  }
+  pushPlugin(plugin) {
+    this.plugins.push(plugin);
+  }
+  activatePlugin(pluginId) {
+    const plugin = this.plugins.find(p => p.id === pluginId);
+    if (plugin) {
+      plugin.active = true;
+    }
+  }
+  deactivatePlugin(pluginId) {
+    const plugin = this.plugins.find(p => p.id === pluginId);
+    if (plugin) {
+      plugin.active = false;
+    }
+  }
+  deletePlugin(pluginId) {
+    const plugin = this.plugins.find(p => p.id === pluginId);
+    if (plugin?.process && !plugin.process.killed) {
+      plugin.process.kill(1);
+    }
+    this.plugins = this.plugins.filter(p => p.id !== pluginId);
+  }
+  broadcastToPlugins(type, payload) {
+    this.plugins.forEach((plugin, i) => {
+      if (!plugin.active) return;
+      if (plugin.process) {
+        if (plugin.process.connected) {
+          try {
+            plugin.process.send({
+              type,
+              payload
+            });
+            _logger.default.debug(`Sent ${type} to child-process plugin <${plugin.name}> (#${i})`);
+          } catch (err) {
+            _logger.default.error(`Failed to send ${type} to plugin <${plugin.name}> (#${i}):`, err);
+          }
+        } else {
+          _logger.default.warn(`Plugin <${plugin.name}> (#${i}) is not connected. Skipping ${type}.`);
+        }
+      } else {
+        _logger.default.debug(`Plugin <${plugin.name}> does not implement ${type}. Skipping.`);
+      }
+    });
+  }
+  /**
+   * Broadcast a new metric to all active plugins
+   */
+  broadcastMetric(metric) {
+    this.broadcastToPlugins("newMetric", metric);
+  }
+  /**
+   * Broadcast a new log to all active plugins
+   */
+  broadcastLog(log) {
+    this.broadcastToPlugins("newLog", log);
+  }
+  /**
+   * Broadcast a new trace to all active plugins
+   */
+  broadcastTrace(trace) {
+    this.broadcastToPlugins("newTrace", trace);
+  }
+}
+const pluginService = exports.pluginService = new PluginService();

package/dist/cjs/tlm-trace/traceController.cjs

@@ -3,36 +3,37 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.stopTelemetry = exports.statusTelemetry = exports.startTelemetry = exports.resetTelemetry = exports.listTelemetry = exports.insertTracesToDb = exports.findTelemetry = void 0;
-var _config = require("../config.cjs");
+exports.stopTraces = exports.statusTraces = exports.startTraces = exports.setRetentionTimeTraces = exports.resetTraces = exports.listTraces = exports.insertTracesToDb = exports.findTraces = void 0;
+var _telemetryRegistry = require("../telemetry/telemetryRegistry.cjs");
+var _regexUtils = require("../utils/regexUtils.cjs");
 const _excluded = ["_id"];
 function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
 function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
-const startTelemetry = (req, res) => {
-  _config.globalOasTlmConfig.dynamicSpanExporter.exporter.start();
-  res.send('Telemetry started');
+const startTraces = (req, res) => {
+  _telemetryRegistry.inMemoryDbSpanExporter.enable();
+  res.send('Traces started');
 };
-exports.startTelemetry = startTelemetry;
-const stopTelemetry = (req, res) => {
-  _config.globalOasTlmConfig.dynamicSpanExporter.exporter.stop();
-  res.send('Telemetry stopped');
+exports.startTraces = startTraces;
+const stopTraces = (req, res) => {
+  _telemetryRegistry.inMemoryDbSpanExporter.disable();
+  res.send('Traces stopped');
 };
-exports.stopTelemetry = stopTelemetry;
-const statusTelemetry = (req, res) => {
-  const isRunning = _config.globalOasTlmConfig.dynamicSpanExporter.exporter.isRunning() || false;
+exports.stopTraces = stopTraces;
+const statusTraces = (req, res) => {
+  const isRunning = _telemetryRegistry.inMemoryDbSpanExporter.isEnabled() || false;
   res.send({
     active: isRunning
   });
 };
-exports.statusTelemetry = statusTelemetry;
-const resetTelemetry = (req, res) => {
-  _config.globalOasTlmConfig.dynamicSpanExporter.exporter.reset();
-  res.send('Telemetry reset');
+exports.statusTraces = statusTraces;
+const resetTraces = (req, res) => {
+  _telemetryRegistry.inMemoryDbSpanExporter.reset();
+  res.send('Traces reset');
 };
-exports.resetTelemetry = resetTelemetry;
-const listTelemetry = async (req, res) => {
+exports.resetTraces = resetTraces;
+const listTraces = async (req, res) => {
   try {
-    const spans = await _config.globalOasTlmConfig.dynamicSpanExporter.exporter.getFinishedSpans();
+    const spans = _telemetryRegistry.inMemoryDbSpanExporter.getFinishedSpans();
     res.send({
       spansCount: spans.length,
       spans: spans
@@ -40,39 +41,33 @@ const listTelemetry = async (req, res) => {
   } catch (err) {
     console.error(err);
     res.status(500).send({
-      error: 'Failed to list telemetry data'
+      error: 'Failed to list traces data'
     });
   }
 };
-exports.listTelemetry = listTelemetry;
-const findTelemetry = (req, res) => {
+exports.listTraces = listTraces;
+const findTraces = (req, res) => {
   const body = req.body;
-  const search = body?.search ? body.search : {};
-  if (body?.flags?.containsRegex) {
-    try {
-      //@ts-expect-error yes
-      body.config?.regexIds?.forEach(regexId => {
-        if (search[regexId]) search[regexId] = new RegExp(search[regexId]);
-      });
-    } catch (e) {
-      console.error(e);
-      res.status(404).send({
-        spansCount: 0,
-        spans: [],
-        error: e
-      });
-      return;
-    }
+  const query = body?.query ? body.query : {};
+  let processedQuery;
+  try {
+    processedQuery = (0, _regexUtils.convertRegexRecursively)(query);
+  } catch (error) {
+    console.error(error.message);
+    res.status(400).send({
+      error: error.message
+    });
+    return; // Exit if invalid regex was encountered
   }
-  _config.globalOasTlmConfig.dynamicSpanExporter.exporter.find(search, (err, docs) => {
+  _telemetryRegistry.inMemoryDbSpanExporter.find(processedQuery, (err, docs) => {
     if (err) {
       console.error(err);
       res.status(404).send({
         spansCount: 0,
         spans: [],
-        error: err
+        error: err.message
       });
-      return;
+      return; // Exit the function to prevent further execution
     }
     const spans = docs;
     res.send({
@@ -81,7 +76,7 @@ const findTelemetry = (req, res) => {
     });
   });
 };
-exports.findTelemetry = findTelemetry;
+exports.findTraces = findTraces;
 const insertTracesToDb = async (req, res) => {
   const jsonContent = req.body.spans;
   const resetData = req.query.reset === 'true';
@@ -102,11 +97,11 @@ const insertTracesToDb = async (req, res) => {
   try {
     let message = '';
     if (resetData) {
-      _config.globalOasTlmConfig.dynamicSpanExporter.exporter.reset();
+      _telemetryRegistry.inMemoryDbSpanExporter.reset();
       message += 'Traces Database reset. ';
     }
     await new Promise((resolve, reject) => {
-      _config.globalOasTlmConfig.dynamicSpanExporter.exporter.insert(cleanedTraces, (err, newDocs) => {
+      _telemetryRegistry.inMemoryDbSpanExporter.insert(cleanedTraces, (err, newDocs) => {
         if (err) {
           console.error('Error inserting traces:', err);
           return reject(err);
@@ -127,4 +122,18 @@ const insertTracesToDb = async (req, res) => {
     });
   }
 };
-exports.insertTracesToDb = insertTracesToDb;
+exports.insertTracesToDb = insertTracesToDb;
+const setRetentionTimeTraces = (req, res) => {
+  const retentionTime = req.body.retentionTime;
+  if (typeof retentionTime !== 'number' || retentionTime <= 0) {
+    res.status(400).send({
+      error: 'Invalid retention time. Must be a positive number.'
+    });
+    return;
+  }
+  _telemetryRegistry.inMemoryDbSpanExporter.retentionTimeInSeconds = retentionTime;
+  res.send({
+    message: `Retention time set to ${retentionTime} seconds.`
+  });
+};
+exports.setRetentionTimeTraces = setRetentionTimeTraces;

package/dist/cjs/tlm-trace/traceRoutes.cjs

@@ -3,16 +3,21 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.traceRoutes = exports.default = void 0;
+exports.getTraceRoutes = exports.default = void 0;
 var _express = require("express");
 var _traceController = require("./traceController.cjs");
-const traceRoutes = exports.traceRoutes = (0, _express.Router)();
-traceRoutes.get('/', _traceController.listTelemetry);
-traceRoutes.post('/', _traceController.insertTracesToDb);
-traceRoutes.post('/find', _traceController.findTelemetry);
-// Telemetry Control
-traceRoutes.get('/start', _traceController.startTelemetry);
-traceRoutes.get('/stop', _traceController.stopTelemetry);
-traceRoutes.get('/status', _traceController.statusTelemetry);
-traceRoutes.get('/reset', _traceController.resetTelemetry);
-var _default = exports.default = traceRoutes;
+const getTraceRoutes = () => {
+  const router = (0, _express.Router)();
+  // Telemetry Control
+  router.post('/start', _traceController.startTraces);
+  router.post('/stop', _traceController.stopTraces);
+  router.get('/status', _traceController.statusTraces);
+  router.post('/reset', _traceController.resetTraces);
+  router.get('/', _traceController.listTraces);
+  router.post('/', _traceController.insertTracesToDb);
+  router.post('/find', _traceController.findTraces);
+  router.post('/retention-time', _traceController.setRetentionTimeTraces);
+  return router;
+};
+exports.getTraceRoutes = getTraceRoutes;
+var _default = exports.default = getTraceRoutes;

package/dist/cjs/tlm-ui/uiRoutes.cjs

@@ -3,29 +3,35 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.uiRoutes = exports.default = void 0;
+exports.getUIRoutes = void 0;
 var _express = _interopRequireWildcard(require("express"));
 var _path = _interopRequireDefault(require("path"));
 var _url = require("url");
 var _logger = _interopRequireDefault(require("../utils/logger.cjs"));
+var _bootConfig = require("../config/bootConfig.cjs");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
-let relativePath = '../../ui';
-if (process.env.OASTLM_ENV === 'development') {
-  relativePath = '../../dist/ui';
-  _logger.default.warn('🚧 This process is serving the OASTLM UI from the build directory, but you are in development mode. For live updates, run the React app separately and access it at http://localhost:5173/.');
-}
-const customFilename = (0, _url.fileURLToPath)(require('url').pathToFileURL(__filename).toString());
-const customDirname = _path.default.dirname(customFilename);
-const staticFilesPath = _path.default.join(customDirname, relativePath);
-const uiRoutes = exports.uiRoutes = (0, _express.Router)();
-// This only works once the app is built: src/ --> dist/esm/
-// This file: dist/esm/routes/
-// UI bundle: dist/ui/
-// For development, the UI is served separately.
-uiRoutes.use(_express.default.static(staticFilesPath));
-uiRoutes.get('*', (_req, res) => {
-  // Serve the index.html file for all routes
-  res.sendFile(_path.default.join(staticFilesPath, 'index.html'));
-});
-var _default = exports.default = uiRoutes;
+const getUIRoutes = () => {
+  // This is when this file is in /dist
+  let relativePath = '../../ui';
+  // This is when this file in in /src
+  if (_bootConfig.bootEnvVariables.OASTLM_BOOT_ENV === 'development') {
+    relativePath = '../../dist/ui';
+    _logger.default.warn('🚧 This process is serving the OASTLM UI from the build directory, but you are in development mode. For live updates, run the React app separately and access it at http://localhost:5173/.');
+  }
+  const customFilename = (0, _url.fileURLToPath)(require('url').pathToFileURL(__filename).toString());
+  const customDirname = _path.default.dirname(customFilename);
+  const staticFilesPath = _path.default.join(customDirname, relativePath);
+  const router = (0, _express.Router)();
+  // This only works once the app is built: src/ --> dist/esm/
+  // This file: dist/esm/routes/
+  // UI bundle: dist/ui/
+  // For development, the UI is served separately.
+  router.use(_express.default.static(staticFilesPath));
+  router.get('*', (_req, res) => {
+    // Serve the index.html file for all routes
+    res.sendFile(_path.default.join(staticFilesPath, 'index.html'));
+  });
+  return router;
+};
+exports.getUIRoutes = getUIRoutes;

package/dist/cjs/tlm-util/utilController.cjs

@@ -4,20 +4,19 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.specLoader = exports.heapStats = void 0;
-var _config = require("../config.cjs");
 var _fs = require("fs");
 var _path = _interopRequireDefault(require("path"));
 var _jsYaml = _interopRequireDefault(require("js-yaml"));
 var _nodeV = _interopRequireDefault(require("node:v8"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const specLoader = (_req, res) => {
-  if (_config.globalOasTlmConfig.specFileName) {
+const specLoader = (_req, res, oasTlmConfig) => {
+  if (oasTlmConfig.general.specFileName) {
     try {
-      const data = (0, _fs.readFileSync)(_config.globalOasTlmConfig.specFileName, {
+      const data = (0, _fs.readFileSync)(oasTlmConfig.general.specFileName, {
         encoding: 'utf8',
         flag: 'r'
       });
-      const extension = _path.default.extname(_config.globalOasTlmConfig.specFileName);
+      const extension = _path.default.extname(oasTlmConfig.general.specFileName);
       let json = data;
       if (extension == "yaml")
         //@ts-expect-error yes
@@ -25,15 +24,15 @@ const specLoader = (_req, res) => {
       res.setHeader('Content-Type', 'application/json');
       res.send(json);
     } catch (e) {
-      console.error(`ERROR loading spec file ${_config.globalOasTlmConfig.specFileName}: ${e}`);
+      console.error(`ERROR loading spec file ${oasTlmConfig.general.specFileName}: ${e}`);
     }
-  } else if (_config.globalOasTlmConfig.spec) {
+  } else if (oasTlmConfig.general.spec) {
     let spec = null;
     try {
-      spec = JSON.parse(_config.globalOasTlmConfig.spec);
+      spec = JSON.parse(oasTlmConfig.general.spec);
     } catch (ej) {
       try {
-        spec = JSON.stringify(_jsYaml.default.load(_config.globalOasTlmConfig.spec), null, 2);
+        spec = JSON.stringify(_jsYaml.default.load(oasTlmConfig.general.spec), null, 2);
       } catch (ey) {
         console.error(`Error parsing spec: ${ej} - ${ey}`);
       }

package/dist/cjs/tlm-util/utilRoutes.cjs

@@ -3,26 +3,29 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.utilsRoutes = exports.default = void 0;
+exports.getUtilsRoutes = void 0;
 var _express = require("express");
 var _utilController = require("./utilController.cjs");
-const utilsRoutes = exports.utilsRoutes = (0, _express.Router)();
-utilsRoutes.get('/spec', _utilController.specLoader);
-utilsRoutes.get('/heapStats', _utilController.heapStats);
-utilsRoutes.get('/generateLog', (req, res) => {
-  const log = req.query.log || 'Default log message';
-  console.log('Generated log:', log);
-  res.send({
-    message: 'Log generated',
-    log: log
+const getUtilsRoutes = oasTlmConfig => {
+  const router = (0, _express.Router)();
+  router.get('/spec', (req, res) => (0, _utilController.specLoader)(req, res, oasTlmConfig));
+  router.get('/heapStats', _utilController.heapStats);
+  router.get('/generateLog', (req, res) => {
+    const log = req.query.log || 'Default log message';
+    console.log(log);
+    res.send({
+      message: 'Log generated',
+      log: log
+    });
   });
-});
-utilsRoutes.get('/wait/:seconds?', async (req, res) => {
-  const seconds = parseInt(req.params.seconds ?? "1", 10);
-  const waitTime = isNaN(seconds) ? 1 : seconds;
-  await new Promise(resolve => setTimeout(resolve, waitTime * 1000));
-  res.send({
-    waited: waitTime
+  router.get('/wait/:seconds?', async (req, res) => {
+    const seconds = parseInt(req.params.seconds ?? "1", 10);
+    const waitTime = isNaN(seconds) ? 1 : seconds;
+    await new Promise(resolve => setTimeout(resolve, waitTime * 1000));
+    res.send({
+      waited: waitTime
+    });
   });
-});
-var _default = exports.default = utilsRoutes;
+  return router;
+};
+exports.getUtilsRoutes = getUtilsRoutes;

package/dist/cjs/types/index.cjs

@@ -4,5 +4,4 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 ;
-;
 ;

package/dist/cjs/utils/logger.cjs

@@ -4,12 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _dotenv = _interopRequireDefault(require("dotenv"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-_dotenv.default.config();
+var _bootConfig = require("../config/bootConfig.cjs");
 const LOG_LEVELS = ['DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE'];
-const currentLogLevel = (process.env.OASTLM_LOG_LEVEL || 'INFO').toUpperCase();
-const serviceName = process.env.OASTLM_SERVICE_NAME || 'OAS-TLM';
+const currentLogLevel = (_bootConfig.bootEnvVariables.OASTLM_BOOT_LOG_LEVEL || 'INFO').toUpperCase();
+const serviceName = 'OAS-Telemetry';
 function log(level, ...messages) {
   if (LOG_LEVELS.indexOf(level) >= LOG_LEVELS.indexOf(currentLogLevel)) {
     const timestamp = new Date().toISOString();

package/dist/cjs/utils/regexUtils.cjs

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.convertRegexRecursively = void 0;
+const convertRegexRecursively = obj => {
+  if (Array.isArray(obj)) {
+    return obj.map(convertRegexRecursively);
+  } else if (obj && typeof obj === 'object') {
+    const newObj = {};
+    for (const key of Object.keys(obj)) {
+      if (key === '$regex' && typeof obj[key] === 'string') {
+        try {
+          return new RegExp(obj[key]);
+        } catch {
+          throw new Error(`Invalid regex value "${obj[key]}"`);
+        }
+      } else {
+        newObj[key] = convertRegexRecursively(obj[key]);
+      }
+    }
+    return newObj;
+  }
+  return obj;
+};
+exports.convertRegexRecursively = convertRegexRecursively;

package/dist/esm/config/bootConfig.js

@@ -0,0 +1,11 @@
+import dotenv from 'dotenv';
+if (process.env.NODE_ENV !== 'test') {
+    dotenv.config();
+}
+// This variables can NOT be configured via oasTelemetry(config)
+// They are used at the import of the library
+export const bootEnvVariables = {
+    OASTLM_BOOT_ENV: process.env.OASTLM_BOOT_ENV || process.env.NODE_ENV || 'production',
+    OASTLM_BOOT_MODULE_DISABLED: process.env.OASTLM_BOOT_MODULE_DISABLED === 'true',
+    OASTLM_BOOT_LOG_LEVEL: process.env.OASTLM_BOOT_LOG_LEVEL || 'INFO',
+};

package/dist/esm/config/config.js

@@ -0,0 +1,126 @@
+import merge from 'lodash.merge';
+// Environment-level config (highest priority)
+// If NOT defined, it should return UNDEFINED so it dose not override the userConfig or defaultConfig.
+// Thats why we use getParsedEnvVar with no default value.
+const loadEnv = () => {
+    return {
+        general: {
+            baseUrl: getParsedEnvVar("OASTLM_CONFIG_GENERAL_BASE_URL"),
+            specFileName: getParsedEnvVar("OASTLM_CONFIG_GENERAL_SPEC_FILE_NAME"),
+            // spec Not settable via env
+        },
+        auth: {
+            enabled: getParsedEnvVar("OASTLM_CONFIG_AUTH_ENABLED", (v) => v === "true"),
+            apiKeyMaxAge: getParsedEnvVar("OASTLM_CONFIG_AUTH_API_KEY_MAX_AGE", (v) => parseInt(v, 10)),
+            password: getParsedEnvVar("OASTLM_CONFIG_AUTH_PASSWORD"),
+            jwtSecret: getParsedEnvVar("OASTLM_CONFIG_AUTH_JWT_SECRET"),
+        },
+        traces: {
+            memoryExporter: {
+                enabled: getParsedEnvVar("OASTLM_CONFIG_TRACES_MEMORY_EXPORTER_ENABLED", (v) => v === "true"),
+                retentionTimeSeconds: getParsedEnvVar("OASTLM_CONFIG_TRACES_MEMORY_EXPORTER_RETENTION_TIME_SECONDS", (v) => parseInt(v, 10)),
+                // filters NOT settable via env
+            }
+        },
+        metrics: {
+            mainMetricReaderOptions: {
+                exportIntervalMillis: getParsedEnvVar("OASTLM_CONFIG_METRICS_MAIN_READER_EXPORT_INTERVAL", (v) => parseInt(v, 10)),
+                // metricProducers NOT settable via env
+            },
+            memoryExporter: {
+                enabled: getParsedEnvVar("OASTLM_CONFIG_METRICS_MEMORY_EXPORTER_ENABLED", (v) => v === "true"),
+                retentionTimeSeconds: getParsedEnvVar("OASTLM_CONFIG_METRICS_MEMORY_EXPORTER_RETENTION_TIME_SECONDS", (v) => parseInt(v, 10)),
+                // filters NOT settable via env
+            }
+        },
+        logs: {
+            memoryExporter: {
+                enabled: getParsedEnvVar("OASTLM_CONFIG_LOGS_MEMORY_EXPORTER_ENABLED", (v) => v === "true"),
+                retentionTimeSeconds: getParsedEnvVar("OASTLM_CONFIG_LOGS_MEMORY_EXPORTER_RETENTION_TIME_SECONDS", (v) => parseInt(v, 10)),
+                // filters NOT settable via env
+            },
+        },
+        ai: {
+            openAIKey: getParsedEnvVar("OASTLM_CONFIG_AI_OPENAI_KEY"),
+            openAIModel: getParsedEnvVar("OASTLM_CONFIG_AI_OPENAI_MODEL", (v) => v || "gpt-3.5-turbo"),
+            extraContextPrompts: getParsedEnvVar("OASTLM_CONFIG_AI_EXTRA_CONTEXT_PROMPTS", (v) => v ? v.split(',') : []),
+        },
+    };
+};
+// This defines de OasTlmConfig type, which is used throughout the library.
+// Please ensure that all possible types are included here, not only the defaults.
+// e.g. .ai.openAIKey: null as string | null, default is null, but can be set to a string.
+// NOTE: Some BOOT environment variables (e.g., OASTLM_BOOT_MODULE_DISABLED) are accessed before this config is loaded.
+// This means certain settings may affect application startup behavior outside of this configuration system.
+export const defaultConfig = {
+    general: {
+        baseUrl: "/telemetry",
+        specFileName: null, // e.g. "oas.json" or null if not provided
+        spec: null, // e.g. JSON.stringify(oasSpec) or null if not provided,
+        uiPath: "/oas-telemetry-ui", // path to the UI, e.g. "/oas-telemetry-ui" WARN: This must match the UI package's App.tsx "oas-telemetry-ui" path
+    },
+    auth: {
+        enabled: false,
+        apiKeyMaxAge: 1000 * 60 * 60, // 1 hour
+        password: "oas-telemetry-password",
+        jwtSecret: "oas-telemetry-secret",
+    },
+    ai: {
+        openAIKey: null,
+        openAIModel: "gpt-3.5-turbo",
+        extraContextPrompts: [], // e.g. ["Provide detailed explanations", "Use simple language"]
+    },
+    traces: {
+        extraExporters: [], // e.g. [new ConsoleSpanExporter()]
+        extraProcessors: [], // e.g. [new SimpleSpanProcessor(new ConsoleSpanExporter())]
+        mainProcessorOptions: {
+            config: undefined
+        },
+        memoryExporter: {
+            enabled: true, // auto start exporting.
+            retentionTimeSeconds: 60 * 60, // 1 hour
+        },
+        filters: [], // future feature, currently not used
+    },
+    metrics: {
+        mainMetricReaderOptions: {
+            exportIntervalMillis: 1000 * 60, // 60 seconds
+            metricProducers: [], // experimental by OpenTelemetry, not used by OAS-TLM yet
+        },
+        extraReaders: [], // e.g. [new PrometheusExporter()]
+        extraViews: [], // e.g. [new MetricView({ name: 'my_metric', labels: ['env'] })]
+        memoryExporter: {
+            enabled: true,
+            retentionTimeSeconds: 60 * 60, // 1 hour
+        },
+        filters: [], // future feature, currently not used
+    },
+    logs: {
+        extraExporters: [], // e.g. [new ConsoleLogRecordExporter()]
+        extraProcessors: [], // e.g. [new SimpleLogRecordProcessor(new ConsoleLogRecordExporter())]
+        memoryExporter: {
+            enabled: true,
+            retentionTimeSeconds: 60 * 60, // 1 hour
+        },
+        filters: [], // future feature, currently not used
+    },
+    plugins: {
+        enabled: true, // future feature
+        extraPlugins: [], // future feature
+    },
+};
+// Helper to get an environment variable with optional transform
+const getParsedEnvVar = (envKey, transform) => {
+    const rawValue = process.env[envKey];
+    // Treat undefined and "" in env as undefined (skip)
+    if (rawValue === undefined || rawValue === "")
+        return undefined;
+    if (typeof transform === 'function') {
+        return transform(rawValue);
+    }
+    return rawValue;
+};
+export const getConfig = (userConfig, fallbackConfig = defaultConfig, envConfig = loadEnv()) => {
+    // environment variables OVERRIDE userConfig OVERRIDE fallbackConfig
+    return merge({}, fallbackConfig, userConfig, envConfig);
+};