@oas-tools/oas-telemetry 0.1.6 → 0.1.8

package/README.md

@@ -13,23 +13,15 @@ Overall, OAS Telemetry will serve as a valuable tool for developers looking to g
 
 
 ## Usage
-OAS Telemetry is compatible with both CommonJS and ECMAScript Modules (ESM)
-
 To use the middelware add this two lines in your index.js (ESM):
 ```js
-// this MUST be the first line in your file (before any imports)
-const oasTelemetry = require('oas-telemetry');
+import oasTelemetry from 'oas-telemetry';
+import {readFileSync} from 'fs';
 
-// ...Express app and other imports...
+app.use(oasTelemetry({
+    spec : readFileSync('./spec/oas.yaml',{ encoding: 'utf8', flag: 'r' })
+}))
 
-// Now you can use the oasTelemetry middleware, configured with the default options
-app.use(oasTelemetry())
-```
-
-ESM version:
-```js
-import oasTelemetry from 'oas-telemetry';
-app.use(oasTelemetry())
 ```
 
 ## Custom Configuration
@@ -38,61 +30,66 @@ You can also customize the telemetry configuration by passing options to the mid
 ```js
 const customTelemetryConfig = {
     exporter: myCustomExporter,
-    baseURL: '/custom-telemetry'
+    spec: /* OAS content in json or yaml */
 };
 
 app.use(oasTelemetry(customTelemetryConfig));
 ```
-## Some Telemetry Endpoints
+
+## Telemetry UI
+
+You can access the telemetry UI in the endpoint ``/telemetry``
+
+
+## API Telemetry Endpoints
 
 OAS Telemetry middleware adds the following endpoints to your Express application:
 
-- /telemetry: Landing page with links to available routes.
+
 - /telemetry/start: Start telemetry data collection.
 - /telemetry/stop: Stop telemetry data collection.
+- /telemetry/status: Get status of telemetry.
 - /telemetry/reset: Reset telemetry data.
 - /telemetry/list: List all telemetry data.
 - /telemetry/find (POST): Search telemetry data.
 - /telemetry/heapStats: Shows v8 heapStats.
 
-## CommonJs Example
-```js index.cjs
-// this MUST be the first line in your file (before any imports)
-const oasTelemetry = require('@oas-tools/oas-telemetry');
 
-const express = require('express');
-const app = express();
-const port = 3001;
-app.use(express.json());
-
-// Now you can use the oasTelemetry middleware, configured with the default options
-app.use(oasTelemetry())
-
-app.get('/', (req, res) => {
-    res.send('Hello World!');
-});
-
-app.listen(port, () => {
-    console.log(`Example app listening at http://localhost:${port}`);
-});
-```
-
-## ESM Example
+## Simple Example
 ```js index.mjs
-// simple express API in ES6 Syntax
 import oasTelemetry from '@oas-tools/oas-telemetry';
 import express from 'express';
+
 const app = express();
 const port = 3000;
+
+const spec = { "paths": {
+                    "/api/v1/pets": {
+                        "get": {
+                            "summary": "Get pets",
+                            "responses":{
+                                "200": {
+                                    "description": "Success"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+
+app.use(oasTelemetry({
+    spec : JSON.stringify(spec)
+}))
+
 app.use(express.json());
 
-app.use(oasTelemetry())
-app.get('/', (req, res) => {
-    res.send('Hello World!');
+app.get("/api/v1/pets", (req, res) => {
+    res.send([{ name: "rocky"},{ name: "pikachu"}]);
 });
 
 app.listen(port, () => {
     console.log(`Example app listening at http://localhost:${port}`);
+    console.log(`Telemetry portal available at http://localhost:${port}/telemetry`);
 });
 ```
 

package/dist/index.cjs

@@ -10,12 +10,10 @@ var _v = _interopRequireDefault(require("v8"));
 var _fs = require("fs");
 var _path = _interopRequireDefault(require("path"));
 var _jsYaml = _interopRequireDefault(require("js-yaml"));
-var _url = require("url");
+var _ui = _interopRequireDefault(require("./ui.cjs"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // telemetryMiddleware.js
 
-const _filename = (0, _url.fileURLToPath)(import.meta.url);
-const _dirname = _path.default.dirname(_filename);
 let telemetryStatus = {
   active: true
 };
@@ -36,9 +34,6 @@ function oasTelemetry(tlConfig) {
     }
   }
   const router = (0, _express.Router)();
-
-  //const baseURL = telemetryConfig.baseURL;
-
   router.get(baseURL, mainPage);
   router.get(baseURL + "/detail/*", detailPage);
   router.get(baseURL + "/spec", specLoader);
@@ -68,18 +63,10 @@ const apiPage = (req, res) => {
   res.send(text);
 };
 const mainPage = (req, res) => {
-  const data = (0, _fs.readFileSync)(_dirname + '/ui/main.html', {
-    encoding: 'utf8',
-    flag: 'r'
-  });
-  res.send(data);
+  res.send((0, _ui.default)().main);
 };
 const detailPage = (req, res) => {
-  const data = (0, _fs.readFileSync)(_dirname + '/ui/detail.html', {
-    encoding: 'utf8',
-    flag: 'r'
-  });
-  res.send(data);
+  res.send((0, _ui.default)().detail);
 };
 const specLoader = (req, res) => {
   if (telemetryConfig.specFileName) {
@@ -97,7 +84,7 @@ const specLoader = (req, res) => {
       console.log(`ERROR loading spec file ${telemetryConfig.specFileName}: ${e}`);
     }
   } else {
-    if (telemetryConfig.spec) {
+    if (typeof telemetryConfig.spec === 'string' || telemetryConfig.spec instanceof String) {
       let spec = false;
       try {
         spec = JSON.parse(telemetryConfig.spec);
@@ -114,6 +101,11 @@ const specLoader = (req, res) => {
         res.setHeader('Content-Type', 'application/json');
         res.send(spec);
       }
+    } else if (typeof telemetryConfig.spec === 'object') {
+      res.setHeader('Content-Type', 'application/json');
+      res.send(telemetryConfig.spec);
+    } else {
+      res.status(404);
     }
   }
 };