fastify-hl7 1.0.0-beta.1

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

@@ -0,0 +1,78 @@
+/// <reference types="node" />
+import { Batch, ClientBuilderFileOptions, ClientBuilderMessageOptions, ClientBuilderOptions, ClientListenerOptions, ClientOptions, FileBatch, HL7Outbound, Message, OutboundHandler } from 'node-hl7-client';
+export declare class HL7Client {
+    constructor();
+    /**
+     * Close All Connections for this Client
+     * @since 1.0.0
+     */
+    closeAll(): Promise<boolean>;
+    /**
+     * Build a HL7 Batch
+     * @description Create a properly formatted HL7 Batch.
+     * @since 1.0.0
+     * @param props
+     */
+    buildBatch(props?: ClientBuilderOptions): Batch;
+    /**
+     * Build a HL7 File Batch
+     * @description 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.
+     * @since 1.0.0
+     * @param props
+     */
+    buildMessage(props?: ClientBuilderMessageOptions): Message;
+    /**
+     *
+     * @param name
+     * @param props
+     */
+    createClient(name: string, props: ClientOptions): void;
+    /**
+     * Create an HL7 Outbound Connection
+     * @description Connect to an HL7 Server/Broker
+     * @since 1.0.0
+     * @param name The name stored within created client connections.
+     * @param props
+     * @param handler
+     */
+    createOutbound(name: string, props: ClientListenerOptions, handler: OutboundHandler): HL7Outbound;
+    /**
+     * Process a HL7
+     * @description 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.
+     * @since 1.0.0
+     * @param fullFilePath
+     * @returns FileBatch
+     * @example
+     *
+     * 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.
+     * @since 1.0.0
+     * @param fileBuffer
+     * @returns FileBatch
+     * @example
+     *
+     * const fileBuffer = fs.readFileSync(path.join('temp/', 'hl7.readTestBHS.20231208.hl7'))
+     * fastify.hl7.readFileBuffer(fileBuffer)
+     *
+     */
+    readFileBuffer(fileBuffer: Buffer): FileBatch;
+}

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

@@ -0,0 +1,25 @@
+import Server, { HL7Inbound, InboundHandler, ListenerOptions } from 'node-hl7-server';
+export declare class HL7Server {
+    private readonly _server;
+    private readonly _serverInboundConnections;
+    constructor(server: Server);
+    /**
+     * Close Inbound connection.
+     * @since 1.0.0
+     * @param port
+     */
+    close(port: string): Promise<boolean>;
+    /**
+     * Close all Inbound connections.
+     * @since 1.0.0
+     */
+    closeAll(): Promise<boolean>;
+    /**
+     * Create Inbound connection.
+     * @since 1.0.0
+     * @param name
+     * @param props
+     * @param handler
+     */
+    createInbound(name: string, props: ListenerOptions, handler: InboundHandler): HL7Inbound;
+}

package/lib/types/decorate.d.ts

@@ -0,0 +1,29 @@
+import Client, { HL7Outbound } from 'node-hl7-client';
+import { HL7Inbound, 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;
+}
+interface AClientPorts {
+    port: string;
+    connection: HL7Outbound;
+}
+export interface AClients {
+    name: string;
+    client: Client;
+    ports: AClientPorts[];
+}
+export interface AServers {
+    name: string;
+    port: string;
+    server: HL7Inbound;
+}
+export {};

package/lib/types/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/types/index.d.ts

@@ -0,0 +1,4 @@
+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;

package/lib/types/types.d.ts

@@ -0,0 +1,35 @@
+/// <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';
+declare module 'fastify' {
+    interface HL7 {
+        /** Server Instance **/
+        _serverInstance?: Server;
+        /** */
+        buildBatch: (props?: ClientBuilderOptions) => Batch;
+        /** */
+        buildFileBatch: (props?: ClientBuilderFileOptions) => FileBatch;
+        /** */
+        buildMessage: (props?: ClientBuilderMessageOptions) => Message;
+        /** */
+        closeServer: (port: string) => Promise<boolean>;
+        /** */
+        closeServerAll: () => Promise<boolean>;
+        /** Create Client */
+        createClient: (name: string, props: ClientOptions) => void;
+        /** */
+        createInbound: (name: string, props: ListenerOptions, handler: InboundHandler) => HL7Inbound;
+        /** Create Outgoing Client Port */
+        createOutbound: (name: string, props: ClientListenerOptions, handler: OutboundHandler) => HL7Outbound;
+        /** */
+        processHL7: (text: string) => Message | Batch;
+        /** */
+        readFile: (fullFilePath: string) => FileBatch;
+        /** */
+        readFileBuffer: (fileBuffer: Buffer) => FileBatch;
+    }
+    interface FastifyInstance {
+        /** Main Decorator for Fastify **/
+        hl7: HL7;
+    }
+}

package/lib/types/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/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "fastify-hl7",
+  "version": "1.0.0-beta.1",
+  "description": "A Fastify HL7 Plugin Developed in Pure TypeScript.",
+  "module": "./lib/esm/index.js",
+  "main": "./lib/cjs/index.js",
+  "types": "./lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js",
+      "default": "./lib/cjs/index.js"
+    }
+  },
+  "files": [
+    "lib/"
+  ],
+  "engines": {
+    "node": "^18 || ^20"
+  },
+  "scripts": {
+    "clean": "rm -rf lib coverage",
+    "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 .",
+    "lint": "npmPkgJsonLint . && ts-standard | snazzy",
+    "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",
+    "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"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Bugs5382/fastify-hl7.git"
+  },
+  "keywords": [
+    "node-hl7-client",
+    "node-hl7-server",
+    "hl7",
+    "fastify",
+    "fastify-plugin"
+  ],
+  "author": "Shane Froebel",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Bugs5382/fastify-hl7/issues"
+  },
+  "homepage": "https://github.com/Bugs5382/fastify-hl7#readme",
+  "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"
+  },
+  "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.5",
+    "@types/randomstring": "^1.1.11",
+    "@types/tcp-port-used": "^1.0.4",
+    "@typescript-eslint/parser": "^6.16.0",
+    "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",
+    "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.1",
+    "typedoc": "^0.25.4",
+    "typescript": "^5.3.3"
+  },
+  "pre-commit": []
+}