refactor: register web service method to accept socket io srv

Adds a second parameter after the epxress object. The second parameter
is a SocketIO server object which plugins will be able to use to
register their asynchronous/streaming endpoints which do not use
traditional REST nor necessarily HTTP as the transport (think websocket
or SocketIO)

Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>

packages/cactus-cmd-api-server/src/main/typescript/api-server.ts

@@ -495,7 +495,7 @@ export class ApiServer {
       .map(async (plugin: ICactusPlugin) => {
         const p = plugin as IPluginWebService;
         await p.getOrCreateWebServices();
-        const webSvcs = await p.registerWebServices(app);
+        const webSvcs = await p.registerWebServices(app, null as any);
         return webSvcs;
       });
 

packages/cactus-core-api/package.json

@@ -83,7 +83,8 @@
   },
   "homepage": "https://github.com/hyperledger/cactus#readme",
   "devDependencies": {
-    "@types/express": "4.17.8"
+    "@types/express": "4.17.8",
+    "socket.io": "4.0.1"
   },
   "dependencies": {
     "@hyperledger/cactus-common": "0.5.0",

packages/cactus-core-api/src/main/typescript/plugin/web-service/i-plugin-web-service.ts

@@ -4,10 +4,16 @@ import { Optional } from "typescript-optional";
 import { Application } from "express";
 import { IWebServiceEndpoint } from "./i-web-service-endpoint";
 import { ICactusPlugin } from "../i-cactus-plugin";
+import type { Server as SocketIoServer } from "socket.io";
 
 export interface IPluginWebService extends ICactusPlugin {
   getOrCreateWebServices(): Promise<IWebServiceEndpoint[]>;
-  registerWebServices(expressApp: Application): Promise<IWebServiceEndpoint[]>;
+
+  registerWebServices(
+    expressApp: Application,
+    wsApi: SocketIoServer,
+  ): Promise<IWebServiceEndpoint[]>;
+
   getHttpServer(): Optional<Server | SecureServer>;
   shutdown(): Promise<void>;
 }