fastify-hl7 3.1.0 → 3.2.0

package/lib/cjs/class/hL7Client.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HL7Client = void 0;
 const node_hl7_client_1 = __importStar(require("node-hl7-client"));
@@ -44,7 +54,7 @@ class HL7Client {
     }
     /**
      * Build a HL7 Batch
-     *@remarks Create a properly formatted HL7 Batch.
+     * @remarks Create a properly formatted HL7 Batch.
      * @since 1.0.0
      * @param props
      */
@@ -56,7 +66,7 @@ class HL7Client {
     }
     /**
      * Build Date
-     *@remarks Build a date string based off HL7 Standards
+     * @remarks Build a date string based off HL7 Standards
      * @since 2.1.0
      * @param date
      * @param length Options are 8, 12, or 14 (default)
@@ -66,7 +76,7 @@ class HL7Client {
     }
     /**
      * Build a HL7 File Batch
-     *@remarks Create a properly formatted HL7 File Batch.
+     * @remarks Create a properly formatted HL7 File Batch.
      * @since 1.0.0
      * @param props
      */
@@ -80,7 +90,7 @@ class HL7Client {
     }
     /**
      * Build a HL7 Message
-     *@remarks Create a properly formatted HL7 message.
+     * @remarks Create a properly formatted HL7 message.
      * @since 1.0.0
      * @param props
      */
@@ -122,7 +132,7 @@ class HL7Client {
     }
     /**
      * Create an HL7 Outbound Connection
-     *@remarks Connect to an HL7 Server/Broker
+     * @remarks Connect to an HL7 Server/Broker
      * @since 1.0.0
      * @param name The name stored within created client connections.
      * @param props
@@ -183,7 +193,7 @@ class HL7Client {
     }
     /**
      * Process a HL7
-     *@remarks A HL7 message that could either be a Message (MSH) or Batch (BHS)
+     * @remarks A HL7 message that could either be a Message (MSH) or Batch (BHS)
      * @since 1.0.0
      * @param text Raw HL& String
      */
@@ -197,7 +207,7 @@ class HL7Client {
     }
     /**
      * Read File
-     *@remarks Pass the correct path of the file you want to read.
+     * @remarks Pass the correct path of the file you want to read.
      * @since 1.0.0
      * @param fullFilePath
      * @returns FileBatch
@@ -211,7 +221,7 @@ class HL7Client {
     }
     /**
      * Read a File Buffer
-     *@remarks Translate an already Buffered HL7 FHS segment to decode it.
+     * @remarks Translate an already Buffered HL7 FHS segment to decode it.
      * @since 1.0.0
      * @param fileBuffer
      * @returns FileBatch

package/lib/cjs/class/hL7Server.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HL7Server = void 0;
+const node_events_1 = require("node:events");
 const node_hl7_server_1 = require("node-hl7-server");
 const errors_js_1 = require("../errors.js");
-class HL7Server {
+class HL7Server extends node_events_1.EventEmitter {
     constructor(server) {
+        super();
         this._server = server;
         this._serverInboundConnections = [];
     }
@@ -48,6 +50,7 @@ class HL7Server {
             port: props.port.toString(),
             server: inbound,
         });
+        this.emit("inbound", props.port.toString());
         return inbound;
     }
     /**

package/lib/cjs/index.js

@@ -56,6 +56,9 @@ const fastifyHL7 = (0, fastify_plugin_1.default)(async (fastify, opts) => {
     if (typeof serverInstance !== "undefined") {
         // Server Functions
         server = new hL7Server_js_1.HL7Server(serverInstance);
+        server.on("inbound", (port) => {
+            fastify.log.info("HL7 Inbound Server Listening on Port %s", port);
+        });
         // before we close fastify, make sure all server instances are closed
         fastify.addHook("preClose", async () => {
             if (typeof server !== "undefined") {

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

@@ -10,14 +10,14 @@ export declare class HL7Client {
     closeAll(): Promise<boolean>;
     /**
      * Build a HL7 Batch
-     *@remarks Create a properly formatted HL7 Batch.
+     * @remarks Create a properly formatted HL7 Batch.
      * @since 1.0.0
      * @param props
      */
     buildBatch(props?: ClientBuilderOptions): Batch;
     /**
      * Build Date
-     *@remarks Build a date string based off HL7 Standards
+     * @remarks Build a date string based off HL7 Standards
      * @since 2.1.0
      * @param date
      * @param length Options are 8, 12, or 14 (default)
@@ -25,14 +25,14 @@ export declare class HL7Client {
     buildDate(date: Date, length?: string): string;
     /**
      * Build a HL7 File Batch
-     *@remarks Create a properly formatted HL7 File Batch.
+     * @remarks Create a properly formatted HL7 File Batch.
      * @since 1.0.0
      * @param props
      */
     buildFileBatch(props?: ClientBuilderFileOptions): FileBatch;
     /**
      * Build a HL7 Message
-     *@remarks Create a properly formatted HL7 message.
+     * @remarks Create a properly formatted HL7 message.
      * @since 1.0.0
      * @param props
      */
@@ -45,7 +45,7 @@ export declare class HL7Client {
     createClient(name: string, props: ClientOptions): Client;
     /**
      * Create an HL7 Outbound Connection
-     *@remarks Connect to an HL7 Server/Broker
+     * @remarks Connect to an HL7 Server/Broker
      * @since 1.0.0
      * @param name The name stored within created client connections.
      * @param props
@@ -66,14 +66,14 @@ export declare class HL7Client {
     getClientConnectionByPort(port: string): Connection | undefined;
     /**
      * Process a HL7
-     *@remarks A HL7 message that could either be a Message (MSH) or Batch (BHS)
+     * @remarks A HL7 message that could either be a Message (MSH) or Batch (BHS)
      * @since 1.0.0
      * @param text Raw HL& String
      */
     processHL7(text: string): Message | Batch;
     /**
      * Read File
-     *@remarks Pass the correct path of the file you want to read.
+     * @remarks Pass the correct path of the file you want to read.
      * @since 1.0.0
      * @param fullFilePath
      * @returns FileBatch
@@ -85,7 +85,7 @@ export declare class HL7Client {
     readFile(fullFilePath: string): FileBatch;
     /**
      * Read a File Buffer
-     *@remarks Translate an already Buffered HL7 FHS segment to decode it.
+     * @remarks Translate an already Buffered HL7 FHS segment to decode it.
      * @since 1.0.0
      * @param fileBuffer
      * @returns FileBatch

package/lib/esm/class/hL7Client.js

@@ -18,7 +18,7 @@ export class HL7Client {
     }
     /**
      * Build a HL7 Batch
-     *@remarks Create a properly formatted HL7 Batch.
+     * @remarks Create a properly formatted HL7 Batch.
      * @since 1.0.0
      * @param props
      */
@@ -30,7 +30,7 @@ export class HL7Client {
     }
     /**
      * Build Date
-     *@remarks Build a date string based off HL7 Standards
+     * @remarks Build a date string based off HL7 Standards
      * @since 2.1.0
      * @param date
      * @param length Options are 8, 12, or 14 (default)
@@ -40,7 +40,7 @@ export class HL7Client {
     }
     /**
      * Build a HL7 File Batch
-     *@remarks Create a properly formatted HL7 File Batch.
+     * @remarks Create a properly formatted HL7 File Batch.
      * @since 1.0.0
      * @param props
      */
@@ -54,7 +54,7 @@ export class HL7Client {
     }
     /**
      * Build a HL7 Message
-     *@remarks Create a properly formatted HL7 message.
+     * @remarks Create a properly formatted HL7 message.
      * @since 1.0.0
      * @param props
      */
@@ -96,7 +96,7 @@ export class HL7Client {
     }
     /**
      * Create an HL7 Outbound Connection
-     *@remarks Connect to an HL7 Server/Broker
+     * @remarks Connect to an HL7 Server/Broker
      * @since 1.0.0
      * @param name The name stored within created client connections.
      * @param props
@@ -157,7 +157,7 @@ export class HL7Client {
     }
     /**
      * Process a HL7
-     *@remarks A HL7 message that could either be a Message (MSH) or Batch (BHS)
+     * @remarks A HL7 message that could either be a Message (MSH) or Batch (BHS)
      * @since 1.0.0
      * @param text Raw HL& String
      */
@@ -171,7 +171,7 @@ export class HL7Client {
     }
     /**
      * Read File
-     *@remarks Pass the correct path of the file you want to read.
+     * @remarks Pass the correct path of the file you want to read.
      * @since 1.0.0
      * @param fullFilePath
      * @returns FileBatch
@@ -185,7 +185,7 @@ export class HL7Client {
     }
     /**
      * Read a File Buffer
-     *@remarks Translate an already Buffered HL7 FHS segment to decode it.
+     * @remarks Translate an already Buffered HL7 FHS segment to decode it.
      * @since 1.0.0
      * @param fileBuffer
      * @returns FileBatch

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

@@ -1,5 +1,6 @@
+import { EventEmitter } from "node:events";
 import Server, { Inbound, InboundHandler, ListenerOptions } from "node-hl7-server";
-export declare class HL7Server {
+export declare class HL7Server extends EventEmitter {
     private readonly _server;
     private readonly _serverInboundConnections;
     constructor(server: Server);

package/lib/esm/class/hL7Server.js

@@ -1,7 +1,9 @@
+import { EventEmitter } from "node:events";
 import { Inbound, } from "node-hl7-server";
 import { errors } from "../errors.js";
-export class HL7Server {
+export class HL7Server extends EventEmitter {
     constructor(server) {
+        super();
         this._server = server;
         this._serverInboundConnections = [];
     }
@@ -45,6 +47,7 @@ export class HL7Server {
             port: props.port.toString(),
             server: inbound,
         });
+        this.emit("inbound", props.port.toString());
         return inbound;
     }
     /**

package/lib/esm/index.js

@@ -37,6 +37,9 @@ const fastifyHL7 = fp(async (fastify, opts) => {
     if (typeof serverInstance !== "undefined") {
         // Server Functions
         server = new HL7Server(serverInstance);
+        server.on("inbound", (port) => {
+            fastify.log.info("HL7 Inbound Server Listening on Port %s", port);
+        });
         // before we close fastify, make sure all server instances are closed
         fastify.addHook("preClose", async () => {
             if (typeof server !== "undefined") {

package/lib/esm/types.d.ts

@@ -25,14 +25,14 @@ declare module "fastify" {
          * @since 1.0.0 */
         closeServerAll: () => Promise<boolean>;
         /** Create Client
-         *@remarks Connecting to a remote server/broker that accepts connections.
+         * @remarks 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) => Inbound;
         /** Create Outgoing Client Port
-         *@remarks This is on the established client that we are already a part off.
+         * @remarks This is on the established client that we are already a part off.
          * @since 1.0.0 */
         createConnection: (name: string, props: ClientListenerOptions, handler: OutboundHandler) => Connection;
         /** Get Client (Outbound) connection by name.
@@ -59,7 +59,7 @@ declare module "fastify" {
     }
     interface FastifyInstance {
         /** Main Decorator for Fastify
-         *@remarks hl7 is the decorator that everything hangs off.
+         * @remarks hl7 is the decorator that everything hangs off.
          * @since 1.0.0 **/
         hl7: HL7;
     }

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

@@ -10,14 +10,14 @@ export declare class HL7Client {
     closeAll(): Promise<boolean>;
     /**
      * Build a HL7 Batch
-     *@remarks Create a properly formatted HL7 Batch.
+     * @remarks Create a properly formatted HL7 Batch.
      * @since 1.0.0
      * @param props
      */
     buildBatch(props?: ClientBuilderOptions): Batch;
     /**
      * Build Date
-     *@remarks Build a date string based off HL7 Standards
+     * @remarks Build a date string based off HL7 Standards
      * @since 2.1.0
      * @param date
      * @param length Options are 8, 12, or 14 (default)
@@ -25,14 +25,14 @@ export declare class HL7Client {
     buildDate(date: Date, length?: string): string;
     /**
      * Build a HL7 File Batch
-     *@remarks Create a properly formatted HL7 File Batch.
+     * @remarks Create a properly formatted HL7 File Batch.
      * @since 1.0.0
      * @param props
      */
     buildFileBatch(props?: ClientBuilderFileOptions): FileBatch;
     /**
      * Build a HL7 Message
-     *@remarks Create a properly formatted HL7 message.
+     * @remarks Create a properly formatted HL7 message.
      * @since 1.0.0
      * @param props
      */
@@ -45,7 +45,7 @@ export declare class HL7Client {
     createClient(name: string, props: ClientOptions): Client;
     /**
      * Create an HL7 Outbound Connection
-     *@remarks Connect to an HL7 Server/Broker
+     * @remarks Connect to an HL7 Server/Broker
      * @since 1.0.0
      * @param name The name stored within created client connections.
      * @param props
@@ -66,14 +66,14 @@ export declare class HL7Client {
     getClientConnectionByPort(port: string): Connection | undefined;
     /**
      * Process a HL7
-     *@remarks A HL7 message that could either be a Message (MSH) or Batch (BHS)
+     * @remarks A HL7 message that could either be a Message (MSH) or Batch (BHS)
      * @since 1.0.0
      * @param text Raw HL& String
      */
     processHL7(text: string): Message | Batch;
     /**
      * Read File
-     *@remarks Pass the correct path of the file you want to read.
+     * @remarks Pass the correct path of the file you want to read.
      * @since 1.0.0
      * @param fullFilePath
      * @returns FileBatch
@@ -85,7 +85,7 @@ export declare class HL7Client {
     readFile(fullFilePath: string): FileBatch;
     /**
      * Read a File Buffer
-     *@remarks Translate an already Buffered HL7 FHS segment to decode it.
+     * @remarks Translate an already Buffered HL7 FHS segment to decode it.
      * @since 1.0.0
      * @param fileBuffer
      * @returns FileBatch

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

@@ -1,5 +1,6 @@
+import { EventEmitter } from "node:events";
 import Server, { Inbound, InboundHandler, ListenerOptions } from "node-hl7-server";
-export declare class HL7Server {
+export declare class HL7Server extends EventEmitter {
     private readonly _server;
     private readonly _serverInboundConnections;
     constructor(server: Server);

package/lib/types/types.d.ts

@@ -25,14 +25,14 @@ declare module "fastify" {
          * @since 1.0.0 */
         closeServerAll: () => Promise<boolean>;
         /** Create Client
-         *@remarks Connecting to a remote server/broker that accepts connections.
+         * @remarks 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) => Inbound;
         /** Create Outgoing Client Port
-         *@remarks This is on the established client that we are already a part off.
+         * @remarks This is on the established client that we are already a part off.
          * @since 1.0.0 */
         createConnection: (name: string, props: ClientListenerOptions, handler: OutboundHandler) => Connection;
         /** Get Client (Outbound) connection by name.
@@ -59,7 +59,7 @@ declare module "fastify" {
     }
     interface FastifyInstance {
         /** Main Decorator for Fastify
-         *@remarks hl7 is the decorator that everything hangs off.
+         * @remarks 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": "3.1.0",
+  "version": "3.2.0",
   "description": "A Fastify HL7 Plugin Developed in Pure TypeScript.",
   "module": "./lib/esm/index.js",
   "main": "./lib/cjs/index.js",
@@ -27,7 +27,7 @@
     "build:watch": "tsc -p src/tsconfig.esm.json -w",
     "build:watch:cjs": "tsc -p src/tsconfig.cjs.json -w",
     "npm:lint": "npmPkgJsonLint .",
-    "format": "prettier --write 'README.md' 'src/**/*.ts' '__tests__/**/*.ts'",
+    "format": "prettier --write 'README.md' 'src/**/*.ts' '__tests__/**/*.ts' '*.{mts,mjs}'",
     "lint": "npm run npm:lint && eslint | snazzy",
     "lint:fix": "npm run npm:lint && eslint --fix | snazzy",
     "pack": "npm pack",
@@ -65,15 +65,16 @@
     "node-hl7-server": "^3.1.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.15.0",
+    "@eslint/js": "^9.16.0",
+    "@shipgirl/typedoc-plugin-versions": "^0.2.8",
     "@types/eslint__js": "^8.42.3",
-    "@types/node": "^22.9.0",
+    "@types/node": "^22.10.1",
     "@types/tcp-port-used": "^1.0.4",
-    "@typescript-eslint/eslint-plugin": "^8.14.0",
-    "@typescript-eslint/parser": "^8.14.0",
-    "@vitest/coverage-v8": "^2.1.5",
-    "@vitest/ui": "^2.1.5",
-    "eslint": "^9.14.0",
+    "@typescript-eslint/eslint-plugin": "^8.17.0",
+    "@typescript-eslint/parser": "^8.17.0",
+    "@vitest/coverage-v8": "^2.1.8",
+    "@vitest/ui": "^2.1.8",
+    "eslint": "^9.16.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.2.1",
     "fastify": "^5.1.0",
@@ -85,12 +86,13 @@
     "tcp-port-used": "^1.0.2",
     "ts-node": "^10.9.2",
     "tsd": "^0.31.2",
-    "typedoc": "^0.26.11",
-    "typescript": "^5.6.3",
-    "typescript-eslint": "^8.14.0",
-    "vitest": "^2.1.5"
+    "typedoc": "^0.27.4",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.17.0",
+    "vitest": "^2.1.8"
   },
   "precommit": [
+    "format",
     "lint:fix",
     "build"
   ]