fastify-hl7 2.1.0 → 3.0.0

package/lib/esm/decorate.d.ts

@@ -0,0 +1,38 @@
+import Client, { Connection } from 'node-hl7-client';
+import { Inbound, ServerOptions } from 'node-hl7-server';
+/**
+ * @since 1.0.0
+ */
+export interface FastifyHL7Options {
+    /** Enable Server Instance for Inbound
+     * @since 1.0.0
+     * @default true */
+    enableServer?: boolean;
+    /** Override Server Options
+     * @default From node-hl7-server */
+    serverOptions?: ServerOptions;
+}
+/**
+ * @since 1.0.0
+ */
+interface AClientPorts {
+    port: string;
+    connection: Connection;
+}
+/**
+ * @since 1.0.0
+ */
+export interface AClients {
+    name: string;
+    client: Client;
+    ports: AClientPorts[];
+}
+/**
+ * @since 1.0.0
+ */
+export interface AServers {
+    name: string;
+    port: string;
+    server: Inbound;
+}
+export {};

package/lib/esm/errors.d.ts

@@ -0,0 +1,10 @@
+export declare const errors: {
+    /** Error if there is an setup error of the plugin itself. */
+    FASTIFY_HL7_ERR_SETUP_ERRORS: import("@fastify/error").FastifyErrorConstructor<{
+        code: "FASTIFY_HL7_ERR_SETUP_ERRORS";
+    }, [any?, any?, any?]>;
+    /** If an invalid usage error was done, this error would pop up. */
+    FASTIFY_HL7_ERR_USAGE: import("@fastify/error").FastifyErrorConstructor<{
+        code: "FASTIFY_HL7_ERR_USAGE";
+    }, [any?, any?, any?]>;
+};

package/lib/esm/index.d.ts

@@ -0,0 +1,5 @@
+import { FastifyHL7Options } from './decorate.js';
+export * from './types.js';
+declare const fastifyHL7: import("fastify").FastifyPluginCallback<FastifyHL7Options, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault, import("fastify").FastifyBaseLogger>;
+export default fastifyHL7;
+export { FastifyHL7Options };

package/lib/esm/index.js

@@ -27,7 +27,7 @@ const fastifyHL7 = fp(async (fastify, opts) => {
     // Since there can only be one server per IP address
     // (i.e., the host this is running on.) There can only be more than one.
     // A server can host many HL7 Inbound connections via different ports, this is fine.
-    // Clients are different as a app could talk to different servers, on many ports.
+    // Clients are different as an app could talk to different servers, on many ports.
     // So we need to do something different.
     const serverInstance = (typeof opts.enableServer !== 'undefined' && opts.enableServer) ? new Server(opts.serverOptions) : undefined;
     // Server Functions

package/lib/esm/types.d.ts

@@ -0,0 +1,66 @@
+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
+         * @since 1.0.0 **/
+        _serverInstance?: Server;
+        /** Build HL7 Batch
+         * @since 1.0.0 */
+        buildBatch: (props?: ClientBuilderOptions) => Batch;
+        /** BBuild Date
+         * @since 2.1.0
+         */
+        buildDate: (date: Date, length?: string) => string;
+        /** 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
+         *@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.
+         * @since 1.0.0 */
+        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) => Connection | undefined;
+        /** Get Server (Inbound) connection by port.
+         * @since 1.0.0 */
+        getServerByPort: (port: string) => Inbound | undefined;
+        /** Get Server (Inbound) connection by name.
+         * @since 1.0.0 */
+        getServerByName: (name: string) => Inbound | 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
+         *@remarks hl7 is the decorator that everything hangs off.
+         * @since 1.0.0 **/
+        hl7: HL7;
+    }
+}

package/lib/esm/validation.d.ts

@@ -0,0 +1,6 @@
+import { FastifyHL7Options } from './decorate.js';
+/**
+ * @since 1.0.0
+ * @param opts
+ */
+export declare const validateOpts: (opts: FastifyHL7Options) => Promise<FastifyHL7Options>;

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

@@ -1,6 +1,7 @@
-/// <reference types="node" />
 import Client, { Batch, ClientBuilderFileOptions, ClientBuilderMessageOptions, ClientBuilderOptions, ClientListenerOptions, ClientOptions, FileBatch, Connection, Message, OutboundHandler } from 'node-hl7-client';
 export declare class HL7Client {
+    /** @internal */
+    private readonly _clientConnections;
     constructor();
     /**
      * Close All Connections for this Client
@@ -9,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)
@@ -24,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
      */
@@ -44,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
@@ -65,34 +66,34 @@ 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
      * @example
-     *
+     * ```ts
      * fastify.hl7.readFile( path.join('temp/', 'hl7.readTestBHS.20231208.hl7') )
-     *
+     * ```
      */
     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
      * @example
-     *
+     * ```ts
      * const fileBuffer = fs.readFileSync(path.join('temp/', 'hl7.readTestBHS.20231208.hl7'))
      * fastify.hl7.readFileBuffer(fileBuffer)
-     *
+     * ```
      */
     readFileBuffer(fileBuffer: Buffer): FileBatch;
 }

package/lib/types/types.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 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' {
@@ -26,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.
@@ -60,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.1.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,15 +17,15 @@
     "lib/"
   ],
   "engines": {
-    "node": ">=20.0.0"
+    "node": ">=20.15.0"
   },
   "scripts": {
     "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",
+    "build": "tsc -p src/tsconfig.esm.json && tsc -p src/tsconfig.cjs.json && tsc -p src/tsconfig.types.json && ./bin/build-types.sh",
+    "build:watch": "tsc -p src/tsconfig.esm.json -w",
     "npmPkgJsonLint": "npmPkgJsonLint .",
-    "lint": "npmPkgJsonLint . && ts-standard | snazzy",
-    "lint:fix": "npmPkgJsonLint . && ts-standard --fix | snazzy",
+    "lint": "npmPkgJsonLint . && ts-standard -p src/tsconfig.esm.json | snazzy",
+    "lint:fix": "npmPkgJsonLint . && ts-standard -p src/tsconfig.esm.json --fix | snazzy",
     "pack": "npm pack",
     "prepublishOnly": "npm run clean && npm run build && npm run pack",
     "test": "vitest run",
@@ -57,38 +57,38 @@
   },
   "homepage": "https://github.com/Bugs5382/fastify-hl7#readme",
   "dependencies": {
-    "@fastify/error": "^3.4.1",
-    "fastify-plugin": "^4.5.1",
-    "node-hl7-client": "^2.0.0",
-    "node-hl7-server": "^2.0.0"
+    "@fastify/error": "^4.0.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.11.19",
-    "@types/randomstring": "^1.1.11",
+    "@types/node": "^22.8.6",
+    "@types/randomstring": "^1.3.0",
     "@types/tcp-port-used": "^1.0.4",
-    "@typescript-eslint/parser": "^7.0.2",
-    "@vitest/coverage-v8": "^1.3.1",
-    "@vitest/ui": "^1.3.1",
-    "clean-publish": "^4.2.0",
-    "fastify": "^4.26.1",
-    "npm-check-updates": "^16.14.15",
-    "npm-package-json-lint": "^7.1.0",
+    "@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.30.5",
-    "typedoc": "^0.25.8",
-    "typescript": "^5.3.3",
-    "vitest": "^1.3.1"
+    "tsd": "^0.31.2",
+    "typedoc": "^0.26.10",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.4"
   },
   "precommit": [
     "lint:fix",