fastify-hl7 1.2.0 → 2.0.0

package/README.md

@@ -69,7 +69,7 @@ Within your code now you can use the fastify context and access the ```hl7``` de
 and create an outbound connection.
 
 ```ts
-const client = fastify.hl7.createOutbound(
+const client = fastify.hl7.createConnection(
   'ob_adt',
   {port: 3001},
   async (res) => {
@@ -101,9 +101,7 @@ If this is not set, enableServer will be set to ```true```. You need to set this
 ### ```serverOptions```
 
 Set this using the options from the [node-hl7-serer](https://github.com/Bugs5382/node-hl7-server/blob/main/README.md) library ServerOptions values to override server creation.
-This could be enabling IPv4 or IPv6 and other server options including TLS. SInce you can not set this after run time, it has to be set during registration.
-
-
+This could be enabling IPv4 or IPv6 and other server options including TLS. Since you cannot set this after run time, it has to be set during registration.
 
 ### External Libraries
 

package/lib/cjs/class/hL7Client.js

@@ -175,7 +175,7 @@ var HL7Client = /** @class */ (function () {
      * @param props
      * @param handler
      */
-    HL7Client.prototype.createOutbound = function (name, props, handler) {
+    HL7Client.prototype.createConnection = function (name, props, handler) {
         var nameFormat = /[ `!@#$%^&*()+\-=\[\]{};':"\\|,.<>\/?~]/; //eslint-disable-line
         if (nameFormat.test(name)) {
             throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('name must not contain certain characters: `!@#$%^&*()+\\-=\\[\\]{};\':"\\\\|,.<>\\/?~.');
@@ -189,7 +189,7 @@ var HL7Client = /** @class */ (function () {
                 }
             });
             // create outbound port to the server in getConnection.client
-            var outbound = new node_hl7_client_1.HL7Outbound(getConnection.client, props, handler);
+            var outbound = new node_hl7_client_1.Connection(getConnection.client, props, handler);
             // add it to the array of known ports. need to know this, so we can get it later if needed.
             getConnection.ports.push({ port: props.port.toString(), connection: outbound });
             // return it right away. the user might do something with it.

package/lib/cjs/class/hL7Server.js

@@ -98,7 +98,7 @@ var HL7Server = /** @class */ (function () {
         if (nameFormat.test(name)) {
             throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('name must not contain certain characters: `!@#$%^&*()+\\-=\\[\\]{};\':"\\\\|,.<>\\/?~.');
         }
-        var inbound = new node_hl7_server_1.HL7Inbound(this._server, props, handler);
+        var inbound = new node_hl7_server_1.Inbound(this._server, props, handler);
         this._serverInboundConnections.push({
             name: name,
             port: props.port.toString(),

package/lib/cjs/index.js

@@ -172,8 +172,8 @@ var fastifyHL7 = (0, fastify_plugin_1.default)(function (fastify, opts) { return
                         }
                         throw new errors_js_1.errors.FASTIFY_HL7_ERR_USAGE('server was not started. re-register plugin with enableServer set to true.');
                     },
-                    createOutbound: function (name, props, handler) {
-                        return client.createOutbound(name, props, handler);
+                    createConnection: function (name, props, handler) {
+                        return client.createConnection(name, props, handler);
                     },
                     getClientByName: function (name) {
                         return client.getClientByName(name);

package/lib/esm/class/hL7Client.js

@@ -1,4 +1,4 @@
-import Client, { Batch, FileBatch, HL7Outbound, isBatch, Message } from 'node-hl7-client';
+import Client, { Batch, FileBatch, Connection, isBatch, Message } from 'node-hl7-client';
 import { errors } from '../errors.js';
 export class HL7Client {
     /** @internal */
@@ -92,7 +92,7 @@ export class HL7Client {
      * @param props
      * @param handler
      */
-    createOutbound(name, props, handler) {
+    createConnection(name, props, handler) {
         const nameFormat = /[ `!@#$%^&*()+\-=\[\]{};':"\\|,.<>\/?~]/; //eslint-disable-line
         if (nameFormat.test(name)) {
             throw new errors.FASTIFY_HL7_ERR_USAGE('name must not contain certain characters: `!@#$%^&*()+\\-=\\[\\]{};\':"\\\\|,.<>\\/?~.');
@@ -106,7 +106,7 @@ export class HL7Client {
                 }
             });
             // create outbound port to the server in getConnection.client
-            const outbound = new HL7Outbound(getConnection.client, props, handler);
+            const outbound = new Connection(getConnection.client, props, handler);
             // add it to the array of known ports. need to know this, so we can get it later if needed.
             getConnection.ports.push({ port: props.port.toString(), connection: outbound });
             // return it right away. the user might do something with it.

package/lib/esm/class/hL7Server.js

@@ -1,4 +1,4 @@
-import { HL7Inbound } from 'node-hl7-server';
+import { Inbound } from 'node-hl7-server';
 import { errors } from '../errors.js';
 export class HL7Server {
     _server;
@@ -41,7 +41,7 @@ export class HL7Server {
         if (nameFormat.test(name)) {
             throw new errors.FASTIFY_HL7_ERR_USAGE('name must not contain certain characters: `!@#$%^&*()+\\-=\\[\\]{};\':"\\\\|,.<>\\/?~.');
         }
-        const inbound = new HL7Inbound(this._server, props, handler);
+        const inbound = new Inbound(this._server, props, handler);
         this._serverInboundConnections.push({
             name,
             port: props.port.toString(),

package/lib/esm/index.js

@@ -82,8 +82,8 @@ 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.');
         },
-        createOutbound: function (name, props, handler) {
-            return client.createOutbound(name, props, handler);
+        createConnection: function (name, props, handler) {
+            return client.createConnection(name, props, handler);
         },
         getClientByName: function (name) {
             return client.getClientByName(name);

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

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import Client, { Batch, ClientBuilderFileOptions, ClientBuilderMessageOptions, ClientBuilderOptions, ClientListenerOptions, ClientOptions, FileBatch, HL7Outbound, Message, OutboundHandler } from 'node-hl7-client';
+import Client, { Batch, ClientBuilderFileOptions, ClientBuilderMessageOptions, ClientBuilderOptions, ClientListenerOptions, ClientOptions, FileBatch, Connection, Message, OutboundHandler } from 'node-hl7-client';
 export declare class HL7Client {
     constructor();
     /**
@@ -42,7 +42,7 @@ export declare class HL7Client {
      * @param props
      * @param handler
      */
-    createOutbound(name: string, props: ClientListenerOptions, handler: OutboundHandler): HL7Outbound;
+    createConnection(name: string, props: ClientListenerOptions, handler: OutboundHandler): Connection;
     /**
      * Get Client by the name
      * @since 1.0.0
@@ -54,7 +54,7 @@ export declare class HL7Client {
      * @since 1.0.0
      * @param port
      */
-    getClientConnectionByPort(port: string): HL7Outbound | undefined;
+    getClientConnectionByPort(port: string): Connection | 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

@@ -1,4 +1,4 @@
-import Server, { HL7Inbound, InboundHandler, ListenerOptions } from 'node-hl7-server';
+import Server, { Inbound, InboundHandler, ListenerOptions } from 'node-hl7-server';
 export declare class HL7Server {
     private readonly _server;
     private readonly _serverInboundConnections;
@@ -21,17 +21,17 @@ export declare class HL7Server {
      * @param props
      * @param handler
      */
-    createInbound(name: string, props: ListenerOptions, handler: InboundHandler): HL7Inbound;
+    createInbound(name: string, props: ListenerOptions, handler: InboundHandler): Inbound;
     /**
      * Get Server Inbound Connection by Name
      * @since 1.0.0
      * @param name
      */
-    getServerByName(name: string): HL7Inbound | undefined;
+    getServerByName(name: string): Inbound | undefined;
     /**
      * Get Server Inbound Connection by Port
      * @since 1.0.0
      * @param port
      */
-    getServerByPort(port: string): HL7Inbound | undefined;
+    getServerByPort(port: string): Inbound | undefined;
 }

package/lib/types/decorate.d.ts

@@ -1,5 +1,5 @@
-import Client, { HL7Outbound } from 'node-hl7-client';
-import { HL7Inbound, ServerOptions } from 'node-hl7-server';
+import Client, { Connection } from 'node-hl7-client';
+import { Inbound, ServerOptions } from 'node-hl7-server';
 /**
  * @since 1.0.0
  */
@@ -17,7 +17,7 @@ export interface FastifyHL7Options {
  */
 interface AClientPorts {
     port: string;
-    connection: HL7Outbound;
+    connection: Connection;
 }
 /**
  * @since 1.0.0
@@ -33,6 +33,6 @@ export interface AClients {
 export interface AServers {
     name: string;
     port: string;
-    server: HL7Inbound;
+    server: Inbound;
 }
 export {};

package/lib/types/types.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
-import Server, { HL7Inbound, InboundHandler, ListenerOptions } from 'node-hl7-server';
-import Client, { Batch, ClientBuilderFileOptions, ClientBuilderMessageOptions, ClientBuilderOptions, ClientListenerOptions, ClientOptions, FileBatch, HL7Outbound, Message, OutboundHandler } from 'node-hl7-client';
+import Server, { Inbound, InboundHandler, ListenerOptions } from 'node-hl7-server';
+import Client, { Batch, ClientBuilderFileOptions, ClientBuilderMessageOptions, ClientBuilderOptions, ClientListenerOptions, ClientOptions, Connection, FileBatch, Message, OutboundHandler } from 'node-hl7-client';
 declare module 'fastify' {
     interface HL7 {
         /** Server Instance
@@ -27,23 +27,23 @@ declare module 'fastify' {
         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;
+        createInbound: (name: string, props: ListenerOptions, handler: InboundHandler) => Inbound;
         /** 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;
+        createConnection: (name: string, props: ClientListenerOptions, handler: OutboundHandler) => Connection;
         /** 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;
+        getClientConnectionByPort: (port: string) => Connection | undefined;
         /** Get Server (Inbound) connection by port.
          * @since 1.0.0 */
-        getServerByPort: (port: string) => HL7Inbound | undefined;
+        getServerByPort: (port: string) => Inbound | undefined;
         /** Get Server (Inbound) connection by name.
          * @since 1.0.0 */
-        getServerByName: (name: string) => HL7Inbound | undefined;
+        getServerByName: (name: string) => Inbound | undefined;
         /** Process an HL7 string.
          * @since 1.0.0  */
         processHL7: (text: string) => Message | Batch;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify-hl7",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "description": "A Fastify HL7 Plugin Developed in Pure TypeScript.",
   "module": "./lib/esm/index.js",
   "main": "./lib/cjs/index.js",
@@ -17,10 +17,10 @@
     "lib/"
   ],
   "engines": {
-    "node": "^18 || ^20"
+    "node": ">=20.0.0"
   },
   "scripts": {
-    "clean": "rm -rf lib coverage",
+    "clean": "rm -rf lib coverage docs",
     "build": "tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json && tsc -p tsconfig.types.json && ./bin/build-types.sh",
     "build:watch": "tsc -p tsconfig.esm.json -w",
     "npmPkgJsonLint": "npmPkgJsonLint .",
@@ -28,17 +28,16 @@
     "lint:fix": "npmPkgJsonLint . && ts-standard --fix | snazzy",
     "pack": "npm pack",
     "prepublishOnly": "npm run clean && npm run build && npm run pack",
-    "test": "jest",
-    "test:open": "jest --detectOpenHandles",
-    "test:ci": "jest --ci",
-    "test:coverage": "jest --coverage",
-    "test:coverage:watch": "jest --coverage --watch",
+    "test": "vitest run",
+    "test:verbose": "vitest run --reporter verbose",
+    "test:watch": "vitest watch",
+    "test:coverage": "vitest --coverage",
     "typedoc": "typedoc",
     "typedoc:watch": "typedoc -watch",
     "semantic-release": "semantic-release",
     "semantic-release:dry-run": "semantic-release --dry-run",
-    "update": "npx npm-check-updates -u && npm run update:post-update",
-    "update:post-update": "npm install && npm run test:ci"
+    "update": "npx npm-check-updates -u --enginesNode && npm run update:post-update",
+    "update:post-update": "npm install && npm run test"
   },
   "repository": {
     "type": "git",
@@ -60,37 +59,39 @@
   "dependencies": {
     "@fastify/error": "^3.4.1",
     "fastify-plugin": "^4.5.1",
-    "node-hl7-client": "^1.1.2",
-    "node-hl7-server": "^1.2.3"
+    "node-hl7-client": "^2.0.0",
+    "node-hl7-server": "^2.0.0"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^11.1.0",
     "@semantic-release/git": "^10.0.1",
     "@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.8",
+    "@the-rabbit-hole/semantic-release-config": "^1.5.0",
+    "@types/node": "^20.11.16",
     "@types/randomstring": "^1.1.11",
     "@types/tcp-port-used": "^1.0.4",
-    "@typescript-eslint/parser": "^6.18.1",
+    "@typescript-eslint/parser": "^6.20.0",
+    "@vitest/coverage-v8": "^1.2.2",
+    "@vitest/ui": "^1.2.2",
     "clean-publish": "^4.2.0",
-    "fastify": "^4.25.2",
-    "jest": "^29.7.0",
-    "jest-ts-webcompat-resolver": "^1.0.0",
-    "npm-check-updates": "^16.14.12",
+    "fastify": "^4.26.0",
+    "npm-check-updates": "^16.14.14",
     "npm-package-json-lint": "^7.1.0",
     "portfinder": "^1.0.32",
     "pre-commit": "^1.2.2",
     "semantic-release": "^22.0.12",
     "snazzy": "^9.0.0",
     "tcp-port-used": "^1.0.2",
-    "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",
     "ts-standard": "^12.0.2",
-    "tsd": "^0.30.3",
+    "tsd": "^0.30.4",
     "typedoc": "^0.25.7",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "vitest": "^1.2.2"
   },
-  "pre-commit": []
+  "precommit": [
+    "lint:fix",
+    "build"
+  ]
 }