@avtechno/sfr 2.0.9 → 2.1.0

package/dist/index.mjs

@@ -22,6 +22,8 @@ async function write_service_discovery(cfg, documents) {
     //Setup files in case they do not exist.
     //Setup output folder
     await fs.mkdir(path.join(cwd, cfg.out), { recursive: true });
+    // Write combined OpenAPI index file containing all protocols
+    await write_combined_openapi_index(cfg, documents);
     // Loop over each protocol
     for (let [protocol, documentation] of Object.entries(documents)) {
         //Strictly await for setup to create dirs for each protocol.
@@ -51,6 +53,28 @@ async function write_service_discovery(cfg, documents) {
         }
     }
 }
+// Writes a combined openapi.yml index file containing all generated documentation
+async function write_combined_openapi_index(cfg, documents) {
+    const combined = {
+        openapi: "3.1.0",
+        info: {},
+        paths: {}
+    };
+    for (const [protocol, documentation] of Object.entries(documents)) {
+        switch (protocol) {
+            case "REST":
+                {
+                    const rest_doc = documentation;
+                    // Merge REST OpenAPI info and paths into combined doc
+                    combined.info = rest_doc.info;
+                    combined.paths = rest_doc.paths;
+                }
+                break;
+        }
+    }
+    // Write the combined index file
+    await fs.writeFile(path.join(cwd, cfg.out, "openapi.yml"), yaml.dump(combined, { lineWidth: -1, indent: 2, noRefs: true }), { flag: "w+" });
+}
 //Tasked with recursively creating directories and spec files.
 async function write_to_file(cfg, dir, data) {
     //Path is a slash(/) delimited string, with the end delimiter indicating the filename to be used.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avtechno/sfr",
-  "version": "2.0.9",
+  "version": "2.1.0",
   "description": "An opinionated way of writing services using ExpressJS.",
   "type": "module",
   "files": [

package/src/index.mts

@@ -31,6 +31,9 @@ async function write_service_discovery(cfg: ParserCFG, documents: ServiceDocumen
   //Setup output folder
   await fs.mkdir(path.join(cwd, cfg.out), { recursive: true });
 
+  // Write combined OpenAPI index file containing all protocols
+  await write_combined_openapi_index(cfg, documents);
+
   // Loop over each protocol
   for (let [protocol, documentation] of Object.entries(documents)) {
     //Strictly await for setup to create dirs for each protocol.
@@ -60,6 +63,33 @@ async function write_service_discovery(cfg: ParserCFG, documents: ServiceDocumen
   }
 }
 
+// Writes a combined openapi.yml index file containing all generated documentation
+async function write_combined_openapi_index(cfg: ParserCFG, documents: ServiceDocuments) {
+  const combined: any = {
+    openapi: "3.1.0",
+    info: {},
+    paths: {}
+  };
+
+  for (const [protocol, documentation] of Object.entries(documents)) {
+    switch (protocol) {
+      case "REST": {
+        const rest_doc = documentation as OAPI_Document;
+        // Merge REST OpenAPI info and paths into combined doc
+        combined.info = rest_doc.info;
+        combined.paths = rest_doc.paths;
+      } break;
+    }
+  }
+
+  // Write the combined index file
+  await fs.writeFile(
+    path.join(cwd, cfg.out, "openapi.yml"),
+    yaml.dump(combined, { lineWidth: -1, indent: 2, noRefs: true }),
+    { flag: "w+" }
+  );
+}
+
 //Tasked with recursively creating directories and spec files.
 async function write_to_file(cfg: ParserCFG, dir: string, data: object) {
   //Path is a slash(/) delimited string, with the end delimiter indicating the filename to be used.