fastify-hl7 1.0.0-beta.1 → 1.0.0-beta.3

package/lib/cjs/class/hL7Client.js

@@ -165,6 +165,7 @@ var HL7Client = /** @class */ (function () {
             client: client,
             ports: []
         });
+        return client;
     };
     /**
      * Create an HL7 Outbound Connection
@@ -196,6 +197,34 @@ var HL7Client = /** @class */ (function () {
         }
         throw new errors_1.errors.FASTIFY_HL7_ERR_USAGE('No valid client. Improper setup of a outbound connection.');
     };
+    /**
+     * Get Client by the name
+     * @since 1.0.0
+     * @param name
+     */
+    HL7Client.prototype.getClientByName = function (name) {
+        var connection = this._clientConnections.find(function (connection) { return connection.name === name; });
+        if (typeof connection !== 'undefined') {
+            return connection.client;
+        }
+        return undefined;
+    };
+    /**
+     * Get Connection by Port
+     * @since 1.0.0
+     * @param port
+     */
+    HL7Client.prototype.getClientConnectionByPort = function (port) {
+        var connection;
+        this._clientConnections.forEach(function (outbound) {
+            outbound.ports.forEach(function (aPort) {
+                if (aPort.port === port) {
+                    connection = aPort.connection;
+                }
+            });
+        });
+        return connection;
+    };
     /**
      * Process a HL7
      * @description A HL7 message that could either be a Message (MSH) or Batch (BHS)

package/lib/cjs/class/hL7Server.js

@@ -106,6 +106,30 @@ var HL7Server = /** @class */ (function () {
         });
         return inbound;
     };
+    /**
+     * Get Server Inbound Connection by Name
+     * @since 1.0.0
+     * @param name
+     */
+    HL7Server.prototype.getServerByName = function (name) {
+        var inbound = this._serverInboundConnections.find(function (inbound) { return inbound.name === name; });
+        if (typeof inbound !== 'undefined') {
+            return inbound.server;
+        }
+        return undefined;
+    };
+    /**
+     * Get Server Inbound Connection by Port
+     * @since 1.0.0
+     * @param port
+     */
+    HL7Server.prototype.getServerByPort = function (port) {
+        var inbound = this._serverInboundConnections.find(function (inbound) { return inbound.port === port; });
+        if (typeof inbound !== 'undefined') {
+            return inbound.server;
+        }
+        return undefined;
+    };
     return HL7Server;
 }());
 exports.HL7Server = HL7Server;

package/lib/cjs/index.js

@@ -164,7 +164,7 @@ var fastifyHL7 = (0, fastify_plugin_1.default)(function (fastify, opts) { return
                         });
                     }); },
                     createClient: function (name, props) {
-                        client.createClient(name, props);
+                        return client.createClient(name, props);
                     },
                     createInbound: function (name, props, handler) {
                         if (typeof server !== 'undefined') {
@@ -175,6 +175,24 @@ var fastifyHL7 = (0, fastify_plugin_1.default)(function (fastify, opts) { return
                     createOutbound: function (name, props, handler) {
                         return client.createOutbound(name, props, handler);
                     },
+                    getClientByName: function (name) {
+                        return client.getClientByName(name);
+                    },
+                    getClientConnectionByPort: function (port) {
+                        return client.getClientConnectionByPort(port);
+                    },
+                    getServerByName: function (name) {
+                        if (typeof server !== 'undefined') {
+                            return server.getServerByName(name);
+                        }
+                        throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('server was not started. re-register plugin with enableServer set to true.');
+                    },
+                    getServerByPort: function (port) {
+                        if (typeof server !== 'undefined') {
+                            return server.getServerByPort(port);
+                        }
+                        throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('server was not started. re-register plugin with enableServer set to true.');
+                    },
                     processHL7: function (text) {
                         return client.processHL7(text);
                     },

package/lib/esm/class/hL7Client.js

@@ -82,6 +82,7 @@ export class HL7Client {
             client,
             ports: []
         });
+        return client;
     }
     /**
      * Create an HL7 Outbound Connection
@@ -113,6 +114,34 @@ export class HL7Client {
         }
         throw new errors.FASTIFY_HL7_ERR_USAGE('No valid client. Improper setup of a outbound connection.');
     }
+    /**
+     * Get Client by the name
+     * @since 1.0.0
+     * @param name
+     */
+    getClientByName(name) {
+        const connection = this._clientConnections.find(connection => connection.name === name);
+        if (typeof connection !== 'undefined') {
+            return connection.client;
+        }
+        return undefined;
+    }
+    /**
+     * Get Connection by Port
+     * @since 1.0.0
+     * @param port
+     */
+    getClientConnectionByPort(port) {
+        let connection;
+        this._clientConnections.forEach(outbound => {
+            outbound.ports.forEach(aPort => {
+                if (aPort.port === port) {
+                    connection = aPort.connection;
+                }
+            });
+        });
+        return connection;
+    }
     /**
      * Process a HL7
      * @description A HL7 message that could either be a Message (MSH) or Batch (BHS)

package/lib/esm/class/hL7Server.js

@@ -49,4 +49,28 @@ export class HL7Server {
         });
         return inbound;
     }
+    /**
+     * Get Server Inbound Connection by Name
+     * @since 1.0.0
+     * @param name
+     */
+    getServerByName(name) {
+        const inbound = this._serverInboundConnections.find(inbound => inbound.name === name);
+        if (typeof inbound !== 'undefined') {
+            return inbound.server;
+        }
+        return undefined;
+    }
+    /**
+     * Get Server Inbound Connection by Port
+     * @since 1.0.0
+     * @param port
+     */
+    getServerByPort(port) {
+        const inbound = this._serverInboundConnections.find(inbound => inbound.port === port);
+        if (typeof inbound !== 'undefined') {
+            return inbound.server;
+        }
+        return undefined;
+    }
 }

package/lib/esm/index.js

@@ -74,7 +74,7 @@ const fastifyHL7 = fp(async (fastify, opts) => {
             throw new errors.FASTIFY_HL7_ERR_USAGE('server was not started. re-register plugin with enableServer set to true.');
         },
         createClient: function (name, props) {
-            client.createClient(name, props);
+            return client.createClient(name, props);
         },
         createInbound: function (name, props, handler) {
             if (typeof server !== 'undefined') {
@@ -85,6 +85,24 @@ const fastifyHL7 = fp(async (fastify, opts) => {
         createOutbound: function (name, props, handler) {
             return client.createOutbound(name, props, handler);
         },
+        getClientByName: function (name) {
+            return client.getClientByName(name);
+        },
+        getClientConnectionByPort: function (port) {
+            return client.getClientConnectionByPort(port);
+        },
+        getServerByName: function (name) {
+            if (typeof server !== 'undefined') {
+                return server.getServerByName(name);
+            }
+            throw new errors.FASTIFY_HL7_ERR_USAGE('server was not started. re-register plugin with enableServer set to true.');
+        },
+        getServerByPort: function (port) {
+            if (typeof server !== 'undefined') {
+                return server.getServerByPort(port);
+            }
+            throw new errors.FASTIFY_HL7_ERR_USAGE('server was not started. re-register plugin with enableServer set to true.');
+        },
         processHL7: function (text) {
             return client.processHL7(text);
         },

package/lib/types/class/hL7Client.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { Batch, ClientBuilderFileOptions, ClientBuilderMessageOptions, ClientBuilderOptions, ClientListenerOptions, ClientOptions, FileBatch, HL7Outbound, Message, OutboundHandler } from 'node-hl7-client';
+import Client, { Batch, ClientBuilderFileOptions, ClientBuilderMessageOptions, ClientBuilderOptions, ClientListenerOptions, ClientOptions, FileBatch, HL7Outbound, Message, OutboundHandler } from 'node-hl7-client';
 export declare class HL7Client {
     constructor();
     /**
@@ -33,7 +33,7 @@ export declare class HL7Client {
      * @param name
      * @param props
      */
-    createClient(name: string, props: ClientOptions): void;
+    createClient(name: string, props: ClientOptions): Client;
     /**
      * Create an HL7 Outbound Connection
      * @description Connect to an HL7 Server/Broker
@@ -43,6 +43,18 @@ export declare class HL7Client {
      * @param handler
      */
     createOutbound(name: string, props: ClientListenerOptions, handler: OutboundHandler): HL7Outbound;
+    /**
+     * Get Client by the name
+     * @since 1.0.0
+     * @param name
+     */
+    getClientByName(name: string): Client | undefined;
+    /**
+     * Get Connection by Port
+     * @since 1.0.0
+     * @param port
+     */
+    getClientConnectionByPort(port: string): HL7Outbound | undefined;
     /**
      * Process a HL7
      * @description A HL7 message that could either be a Message (MSH) or Batch (BHS)

package/lib/types/class/hL7Server.d.ts

@@ -22,4 +22,16 @@ export declare class HL7Server {
      * @param handler
      */
     createInbound(name: string, props: ListenerOptions, handler: InboundHandler): HL7Inbound;
+    /**
+     * Get Server Inbound Connection by Name
+     * @since 1.0.0
+     * @param name
+     */
+    getServerByName(name: string): HL7Inbound | undefined;
+    /**
+     * Get Server Inbound Connection by Port
+     * @since 1.0.0
+     * @param port
+     */
+    getServerByPort(port: string): HL7Inbound | undefined;
 }

package/lib/types/types.d.ts

@@ -1,35 +1,63 @@
 /// <reference types="node" />
 import Server, { HL7Inbound, InboundHandler, ListenerOptions } from 'node-hl7-server';
-import { Batch, ClientBuilderFileOptions, ClientBuilderMessageOptions, ClientBuilderOptions, ClientListenerOptions, ClientOptions, FileBatch, HL7Outbound, Message, OutboundHandler } from 'node-hl7-client';
+import Client, { Batch, ClientBuilderFileOptions, ClientBuilderMessageOptions, ClientBuilderOptions, ClientListenerOptions, ClientOptions, FileBatch, HL7Outbound, Message, OutboundHandler } from 'node-hl7-client';
 declare module 'fastify' {
     interface HL7 {
-        /** Server Instance **/
+        /** Server Instance
+         * @since 1.0.0 **/
         _serverInstance?: Server;
-        /** */
+        /** Build HL7 Batch
+         * @since 1.0.0 */
         buildBatch: (props?: ClientBuilderOptions) => Batch;
-        /** */
+        /** Build HL7 File Batch
+         * @since 1.0.0 */
         buildFileBatch: (props?: ClientBuilderFileOptions) => FileBatch;
-        /** */
+        /** Build HL7 Message
+         * @since 1.0.0 */
         buildMessage: (props?: ClientBuilderMessageOptions) => Message;
-        /** */
+        /** Close a incoming HL7 port.
+         * @since 1.0.0 */
         closeServer: (port: string) => Promise<boolean>;
-        /** */
+        /** Close all incoming HL7 ports.
+         * @since 1.0.0 */
         closeServerAll: () => Promise<boolean>;
-        /** Create Client */
-        createClient: (name: string, props: ClientOptions) => void;
-        /** */
+        /** Create Client
+         * @description Connecting to a remote server/broker that accepts connections.
+         * @since 1.0.0 */
+        createClient: (name: string, props: ClientOptions) => Client;
+        /** Create an incoming port connection on the server.
+         * @since 1.0.0 */
         createInbound: (name: string, props: ListenerOptions, handler: InboundHandler) => HL7Inbound;
-        /** Create Outgoing Client Port */
+        /** Create Outgoing Client Port
+         * @description This is on the established client that we are already a part off.
+         * @since 1.0.0 */
         createOutbound: (name: string, props: ClientListenerOptions, handler: OutboundHandler) => HL7Outbound;
-        /** */
+        /** Get Client (Outbound) connection by name.
+         * @since 1.0.0 */
+        getClientByName: (name: string) => Client | undefined;
+        /** Get Client Connection (Outbound) connection by port.
+         * @since 1.0.0 */
+        getClientConnectionByPort: (port: string) => HL7Outbound | undefined;
+        /** Get Server (Inbound) connection by port.
+         * @since 1.0.0 */
+        getServerByPort: (port: string) => HL7Inbound | undefined;
+        /** Get Server (Inbound) connection by name.
+         * @since 1.0.0 */
+        getServerByName: (name: string) => HL7Inbound | undefined;
+        /** Process an HL7 string.
+         * @since 1.0.0  */
         processHL7: (text: string) => Message | Batch;
-        /** */
+        /** Read a file from a path.
+         * @since 1.0.0 */
         readFile: (fullFilePath: string) => FileBatch;
-        /** */
+        /** Read a buffer that was a file batch.
+         * @since 1.0.0 */
         readFileBuffer: (fileBuffer: Buffer) => FileBatch;
     }
     interface FastifyInstance {
-        /** Main Decorator for Fastify **/
+        /** Main Decorator for Fastify
+         * @description hl7 is the decorator that everything hangs off.
+         * @since 1.0.0 **/
         hl7: HL7;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify-hl7",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "description": "A Fastify HL7 Plugin Developed in Pure TypeScript.",
   "module": "./lib/esm/index.js",
   "main": "./lib/cjs/index.js",
@@ -60,8 +60,8 @@
   "dependencies": {
     "@fastify/error": "^3.4.1",
     "fastify-plugin": "^4.5.1",
-    "node-hl7-client": "^1.1.0-beta.3",
-    "node-hl7-server": "^1.0.1-beta.3"
+    "node-hl7-client": "^1.1.2",
+    "node-hl7-server": "^1.2.1"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.3",
@@ -70,10 +70,10 @@
     "@semantic-release/release-notes-generator": "^12.1.0",
     "@the-rabbit-hole/semantic-release-config": "^1.4.0",
     "@types/jest": "^29.5.11",
-    "@types/node": "^20.10.5",
+    "@types/node": "^20.10.8",
     "@types/randomstring": "^1.1.11",
     "@types/tcp-port-used": "^1.0.4",
-    "@typescript-eslint/parser": "^6.16.0",
+    "@typescript-eslint/parser": "^6.18.1",
     "clean-publish": "^4.2.0",
     "fastify": "^4.25.2",
     "jest": "^29.7.0",
@@ -88,8 +88,8 @@
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",
     "ts-standard": "^12.0.2",
-    "tsd": "^0.30.1",
-    "typedoc": "^0.25.4",
+    "tsd": "^0.30.3",
+    "typedoc": "^0.25.7",
     "typescript": "^5.3.3"
   },
   "pre-commit": []