@avtechno/sfr 2.0.8 → 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/dist/sfr-pipeline.mjs

@@ -97,15 +97,15 @@ export class SFRPipeline {
             this.pattern_channels = Object.fromEntries(channels);
             SFRPipeline.injections.rest.handlers = {
                 ...SFRPipeline.injections.rest.handlers,
-                mq: this.pattern_channels
+                mq_patterns: this.pattern_channels,
             };
             SFRPipeline.injections.mq.handlers = {
                 ...SFRPipeline.injections.mq.handlers,
-                mq: this.pattern_channels
+                mq_patterns: this.pattern_channels,
             };
             SFRPipeline.injections.ws.handlers = {
                 ...SFRPipeline.injections.ws.handlers,
-                mq: this.pattern_channels
+                mq_patterns: this.pattern_channels,
             };
         }
         // Inject Socket.IO server into WS handlers

package/dist/templates.mjs

@@ -44,9 +44,9 @@ export function MQ(struct) {
     Object.entries(handlers).forEach(([pattern, handlermap]) => {
         Object.entries(handlermap).forEach(([k, v]) => {
             /* @ts-ignore */
-            const { mq } = (SFRPipeline.injections.mq.handlers || {});
+            const { mq_patterns } = (SFRPipeline.injections.mq.handlers || {});
             /* @ts-ignore */
-            handlers[pattern][k] = { ...v, fn: v.fn.bind({ ...controllers, mq: mq ? mq[pattern] : null, ...SFRPipeline.injections.mq.handlers }) };
+            handlers[pattern][k] = { ...v, fn: v.fn.bind({ ...controllers, mq: mq_patterns[pattern], ...SFRPipeline.injections.mq.handlers }) };
         });
     });
     /* @ts-ignore */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avtechno/sfr",
-  "version": "2.0.8",
+  "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.

package/src/sfr-pipeline.mts

@@ -117,17 +117,17 @@ export class SFRPipeline {
 
       SFRPipeline.injections.rest.handlers = {
         ...SFRPipeline.injections.rest.handlers,
-        mq: this.pattern_channels
+        mq_patterns: this.pattern_channels,
       }
       
       SFRPipeline.injections.mq.handlers = {
         ...SFRPipeline.injections.mq.handlers,
-        mq: this.pattern_channels
+        mq_patterns: this.pattern_channels,
       }
 
       SFRPipeline.injections.ws.handlers = {
         ...SFRPipeline.injections.ws.handlers,
-        mq: this.pattern_channels
+        mq_patterns: this.pattern_channels,
       }
     }
 

package/src/templates.mts

@@ -54,9 +54,9 @@ export function MQ<V, H>(struct : MQHandlerDescriptor<V, H>): H{
   Object.entries(handlers).forEach(([pattern, handlermap])=>{
     Object.entries(handlermap).forEach(([k, v])=> {
       /* @ts-ignore */
-      const {mq} = (SFRPipeline.injections.mq.handlers || {});
+      const {mq_patterns} = (SFRPipeline.injections.mq.handlers || {});
       /* @ts-ignore */
-      handlers[pattern][k] = {...v, fn : v.fn.bind({ ...controllers, mq : mq ? mq[pattern] : null, ...SFRPipeline.injections.mq.handlers})};
+      handlers[pattern][k] = {...v, fn : v.fn.bind({ ...controllers, mq : mq_patterns[pattern], ...SFRPipeline.injections.mq.handlers})};
     });
   });
   /* @ts-ignore */