fastify-hl7 2.2.0 → 3.0.0

package/README.md

@@ -9,7 +9,7 @@ If you are using this NPM package, please consider giving it a :star: star.
 This will increase its visibility and solicit more contribution from the outside.
 
 This documentation is how to use this plugin, not on how to use the libraries above.
-Head [here](#external-libraries) if you need help with those.
+Head [here](#external-libraries-options) if you need help with those.
 
 ## Table of Contents
 
@@ -19,7 +19,7 @@ Head [here](#external-libraries) if you need help with those.
    2. [Client Quick Start](#client-quick-start)
 3. [Full Documentation](#full-documentation)
    1. [This Library Options](#this-library-options)
-   2. [External Libraries](#external-libraries)
+   2. [External Libraries Options](#external-libraries-options)
 4. [Acknowledgements](#acknowledgements)
 5. [License](#license)
 
@@ -97,19 +97,17 @@ await client.sendMessage(message)
 
 If this is not set, enableServer will be set to ```true```. You need to set this to ```false``` will turn off the server capabilities.
 
-
 ### ```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 cannot set this after run time, it has to be set during registration.
 
-### External Libraries
+### External Libraries Options
 
 * [node-hl7-client](https://github.com/Bugs5382/node-hl7-client/blob/main/README.md) - For the Client, Parser, and Builder to review their options that can be passed as props.
 * [node-hl7-server](https://github.com/Bugs5382/node-hl7-server/blob/main/README.md) - For the Server to the options that can be passed as props.
 
-Please review the library for more complete documentation.
-A far as this plugin for Fastify, there are no options to pass.
+Please review the libraries for more complete documentation.
 
 ## Acknowledgements
 

package/lib/cjs/class/hL7Client.js

@@ -44,7 +44,7 @@ class HL7Client {
     }
     /**
      * Build a HL7 Batch
-     * @description Create a properly formatted HL7 Batch.
+     *@remarks Create a properly formatted HL7 Batch.
      * @since 1.0.0
      * @param props
      */
@@ -56,7 +56,7 @@ class HL7Client {
     }
     /**
      * Build Date
-     * @description 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 +66,7 @@ class HL7Client {
     }
     /**
      * Build a HL7 File Batch
-     * @description Create a properly formatted HL7 File Batch.
+     *@remarks Create a properly formatted HL7 File Batch.
      * @since 1.0.0
      * @param props
      */
@@ -78,7 +78,7 @@ class HL7Client {
     }
     /**
      * Build a HL7 Message
-     * @description Create a properly formatted HL7 message.
+     *@remarks Create a properly formatted HL7 message.
      * @since 1.0.0
      * @param props
      */
@@ -120,7 +120,7 @@ class HL7Client {
     }
     /**
      * Create an HL7 Outbound Connection
-     * @description 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
@@ -178,7 +178,7 @@ class HL7Client {
     }
     /**
      * Process a HL7
-     * @description 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
      */
@@ -192,7 +192,7 @@ class HL7Client {
     }
     /**
      * Read File
-     * @description 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
@@ -206,7 +206,7 @@ class HL7Client {
     }
     /**
      * Read a File Buffer
-     * @description 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.d.ts

@@ -10,14 +10,14 @@ export declare class HL7Client {
     closeAll(): Promise<boolean>;
     /**
      * Build a HL7 Batch
-     * @description 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
-     * @description 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
-     * @description 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
-     * @description 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
-     * @description 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
-     * @description 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
-     * @description 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
-     * @description 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
-     * @description 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
-     * @description 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
-     * @description Create a properly formatted HL7 File Batch.
+     *@remarks Create a properly formatted HL7 File Batch.
      * @since 1.0.0
      * @param props
      */
@@ -52,7 +52,7 @@ export class HL7Client {
     }
     /**
      * Build a HL7 Message
-     * @description Create a properly formatted HL7 message.
+     *@remarks Create a properly formatted HL7 message.
      * @since 1.0.0
      * @param props
      */
@@ -94,7 +94,7 @@ export class HL7Client {
     }
     /**
      * Create an HL7 Outbound Connection
-     * @description 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
@@ -152,7 +152,7 @@ export class HL7Client {
     }
     /**
      * Process a HL7
-     * @description 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
      */
@@ -166,7 +166,7 @@ export class HL7Client {
     }
     /**
      * Read File
-     * @description 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
@@ -180,7 +180,7 @@ export class HL7Client {
     }
     /**
      * Read a File Buffer
-     * @description 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/types.d.ts

@@ -25,14 +25,14 @@ declare module 'fastify' {
          * @since 1.0.0 */
         closeServerAll: () => Promise<boolean>;
         /** Create Client
-         * @description 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
-         * @description 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
-         * @description 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
-     * @description 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
-     * @description 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
-     * @description 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
-     * @description 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
-     * @description 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
-     * @description 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
-     * @description 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
-     * @description 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/types.d.ts

@@ -25,14 +25,14 @@ declare module 'fastify' {
          * @since 1.0.0 */
         closeServerAll: () => Promise<boolean>;
         /** Create Client
-         * @description 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
-         * @description 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
-         * @description 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": "2.2.0",
+  "version": "3.0.0",
   "description": "A Fastify HL7 Plugin Developed in Pure TypeScript.",
   "module": "./lib/esm/index.js",
   "main": "./lib/cjs/index.js",
@@ -17,7 +17,7 @@
     "lib/"
   ],
   "engines": {
-    "node": ">=20.0.0"
+    "node": ">=20.15.0"
   },
   "scripts": {
     "clean": "rm -rf lib coverage docs",
@@ -58,36 +58,37 @@
   "homepage": "https://github.com/Bugs5382/fastify-hl7#readme",
   "dependencies": {
     "@fastify/error": "^4.0.0",
-    "fastify-plugin": "^4.5.1",
-    "node-hl7-client": "^2.3.0",
-    "node-hl7-server": "^2.4.0"
+    "fastify-plugin": "^5.0.1",
+    "node-hl7-client": "^2.3.1",
+    "node-hl7-server": "^3.0.0"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/commit-analyzer": "^11.1.0",
+    "@semantic-release/commit-analyzer": "^13.0.0",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/release-notes-generator": "^12.1.0",
+    "@semantic-release/release-notes-generator": "^14.0.1",
+    "@shipgirl/typedoc-plugin-versions": "^0.2.7",
     "@the-rabbit-hole/semantic-release-config": "^1.5.0",
-    "@types/node": "^20.14.8",
+    "@types/node": "^22.8.6",
     "@types/randomstring": "^1.3.0",
     "@types/tcp-port-used": "^1.0.4",
-    "@typescript-eslint/parser": "^7.14.1",
-    "@vitest/coverage-v8": "^1.6.0",
-    "@vitest/ui": "^1.6.0",
-    "fastify": "^4.28.0",
-    "npm-check-updates": "^16.14.20",
+    "@typescript-eslint/parser": "^8.12.2",
+    "@vitest/coverage-v8": "^2.1.4",
+    "@vitest/ui": "^2.1.4",
+    "fastify": "^5.0.0",
+    "npm-check-updates": "^17.1.9",
     "npm-package-json-lint": "^8.0.0",
     "portfinder": "^1.0.32",
     "pre-commit": "^1.2.2",
-    "semantic-release": "^22.0.12",
+    "semantic-release": "^24.2.0",
     "snazzy": "^9.0.0",
     "tcp-port-used": "^1.0.2",
     "ts-node": "^10.9.2",
     "ts-standard": "^12.0.2",
-    "tsd": "^0.31.1",
-    "typedoc": "^0.26.2",
-    "typescript": "^5.5.2",
-    "vitest": "^1.6.0"
+    "tsd": "^0.31.2",
+    "typedoc": "^0.26.10",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.4"
   },
   "precommit": [
     "lint:fix",