fastify-hl7 3.2.0 → 4.0.0

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

@@ -1,99 +0,0 @@
-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
-     * @since 1.0.0
-     */
-    closeAll(): Promise<boolean>;
-    /**
-     * Build a 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
-     * @since 2.1.0
-     * @param date
-     * @param length Options are 8, 12, or 14 (default)
-     */
-    buildDate(date: Date, length?: string): string;
-    /**
-     * Build a 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.
-     * @since 1.0.0
-     * @param props
-     */
-    buildMessage(props?: ClientBuilderMessageOptions): Message;
-    /**
-     *
-     * @param name
-     * @param props
-     */
-    createClient(name: string, props: ClientOptions): Client;
-    /**
-     * Create an HL7 Outbound Connection
-     * @remarks Connect to an HL7 Server/Broker
-     * @since 1.0.0
-     * @param name The name stored within created client connections.
-     * @param props
-     * @param handler
-     */
-    createConnection(name: string, props: ClientListenerOptions, handler: OutboundHandler): Connection;
-    /**
-     * Get Client by the name
-     * @since 1.0.0
-     * @param name
-     */
-    getClientByName(name: string): Client | undefined;
-    /**
-     * Get Connection by Port
-     * @since 1.0.0
-     * @param port
-     */
-    getClientConnectionByPort(port: string): Connection | undefined;
-    /**
-     * Process a HL7
-     * @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.
-     * @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
-     * @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/esm/class/hL7Client.js

@@ -1,201 +0,0 @@
-import Client, { Batch, FileBatch, Connection, isBatch, Message, createHL7Date, } from "node-hl7-client";
-import { errors } from "../errors.js";
-export class HL7Client {
-    constructor() {
-        this._clientConnections = [];
-    }
-    /**
-     * Close All Connections for this Client
-     * @since 1.0.0
-     */
-    async closeAll() {
-        this._clientConnections.forEach((outbound) => {
-            outbound.ports.map(async (port) => {
-                await port.connection.close();
-            });
-        });
-        return true;
-    }
-    /**
-     * Build a HL7 Batch
-     * @remarks Create a properly formatted HL7 Batch.
-     * @since 1.0.0
-     * @param props
-     */
-    buildBatch(props) {
-        if (typeof props !== "undefined" && typeof props.text !== "undefined") {
-            throw new errors.FASTIFY_HL7_ERR_USAGE("Use processMessage method. This is for building.");
-        }
-        return new Batch({ ...props });
-    }
-    /**
-     * Build Date
-     * @remarks Build a date string based off HL7 Standards
-     * @since 2.1.0
-     * @param date
-     * @param length Options are 8, 12, or 14 (default)
-     */
-    buildDate(date, length) {
-        return createHL7Date(date, length);
-    }
-    /**
-     * Build a HL7 File Batch
-     * @remarks Create a properly formatted HL7 File Batch.
-     * @since 1.0.0
-     * @param props
-     */
-    buildFileBatch(props) {
-        if (typeof props !== "undefined" &&
-            (typeof props.fullFilePath !== "undefined" ||
-                typeof props.fileBuffer !== "undefined")) {
-            throw new errors.FASTIFY_HL7_ERR_USAGE("Use readFile or readFileBuffer method. This is for building.");
-        }
-        return new FileBatch({ ...props });
-    }
-    /**
-     * Build a HL7 Message
-     * @remarks Create a properly formatted HL7 message.
-     * @since 1.0.0
-     * @param props
-     */
-    buildMessage(props) {
-        if (typeof props !== "undefined" && typeof props.text !== "undefined") {
-            throw new errors.FASTIFY_HL7_ERR_USAGE("Use processMessage method. This is for building.");
-        }
-        return new Message({ ...props });
-    }
-    /**
-     *
-     * @param name
-     * @param props
-     */
-    createClient(name, props) {
-        const nameFormat = /[ `!@#$%^&*()+\-=\[\]{};':"\\|,.<>\/?~]/; //eslint-disable-line
-        if (nameFormat.test(name)) {
-            throw new errors.FASTIFY_HL7_ERR_USAGE("name must not contain certain characters: `!@#$%^&*()+\\-=\\[\\]{};':\"\\\\|,.<>\\/?~.");
-        }
-        // make sure that this does not exist already...
-        this._clientConnections.forEach((connections) => {
-            if (connections.name === name) {
-                throw new errors.FASTIFY_HL7_ERR_USAGE("name must be unique.");
-            }
-            // nto in the Client class yet
-            // if (client.getHost() === props.host) {
-            //   throw new errors.FASTIFY_HL7_ERR_USAGE(`host is already a pointer. Name is: ${connections.name}`)
-            // }
-        });
-        // new client
-        const client = new Client(props);
-        // add it to the collection
-        this._clientConnections.push({
-            name,
-            client,
-            ports: [],
-        });
-        return client;
-    }
-    /**
-     * Create an HL7 Outbound Connection
-     * @remarks Connect to an HL7 Server/Broker
-     * @since 1.0.0
-     * @param name The name stored within created client connections.
-     * @param props
-     * @param 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: `!@#$%^&*()+\\-=\\[\\]{};':\"\\\\|,.<>\\/?~.");
-        }
-        const getConnection = this._clientConnections.find((client) => client.name === name);
-        if (typeof getConnection !== "undefined") {
-            // make sure port is not used all ready
-            getConnection.ports.forEach((outbound) => {
-                if (outbound.port === props.port.toString()) {
-                    throw new errors.FASTIFY_HL7_ERR_USAGE(`port ${props.port} is already used with this client. Choose a new outgoing port.`);
-                }
-            });
-            // create outbound port to the server in getConnection.client
-            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.
-            return outbound;
-        }
-        throw new errors.FASTIFY_HL7_ERR_USAGE("No valid client. Improper setup of a outbound connection.");
-    }
-    /**
-     * Get Client by the name
-     * @since 1.0.0
-     * @param name
-     */
-    getClientByName(name) {
-        const connection = this._clientConnections.find((connection) => connection.name === name);
-        if (typeof connection !== "undefined") {
-            return connection.client;
-        }
-        return undefined;
-    }
-    /**
-     * Get Connection by Port
-     * @since 1.0.0
-     * @param port
-     */
-    getClientConnectionByPort(port) {
-        let connection;
-        this._clientConnections.forEach((outbound) => {
-            outbound.ports.forEach((aPort) => {
-                if (aPort.port === port) {
-                    connection = aPort.connection;
-                }
-            });
-        });
-        return connection;
-    }
-    /**
-     * Process a HL7
-     * @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) {
-        if (isBatch(text)) {
-            return new Batch({ text });
-        }
-        else {
-            return new Message({ text });
-        }
-    }
-    /**
-     * Read File
-     * @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) {
-        return new FileBatch({ fullFilePath });
-    }
-    /**
-     * Read a File Buffer
-     * @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) {
-        return new FileBatch({ fileBuffer });
-    }
-}

package/lib/esm/class/hL7Server.js

@@ -1,77 +0,0 @@
-import { EventEmitter } from "node:events";
-import { Inbound, } from "node-hl7-server";
-import { errors } from "../errors.js";
-export class HL7Server extends EventEmitter {
-    constructor(server) {
-        super();
-        this._server = server;
-        this._serverInboundConnections = [];
-    }
-    /**
-     * Close Inbound connection.
-     * @since 1.0.0
-     * @param port
-     */
-    async close(port) {
-        const inbound = this._serverInboundConnections.find((server) => server.port === port);
-        if (typeof inbound !== "undefined") {
-            return await inbound.server.close(); // close the server for all inbound connections
-        }
-        throw new errors.FASTIFY_HL7_ERR_USAGE(`No inbound server listening on port: ${port}`);
-    }
-    /**
-     * Close all Inbound connections.
-     * @since 1.0.0
-     */
-    async closeAll() {
-        this._serverInboundConnections.map(async (inbound) => {
-            await inbound.server.close();
-        });
-        return true;
-    }
-    /**
-     * Create Inbound connection.
-     * @since 1.0.0
-     * @param name
-     * @param props
-     * @param handler
-     */
-    createInbound(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: `!@#$%^&*()+\\-=\\[\\]{};':\"\\\\|,.<>\\/?~.");
-        }
-        const inbound = new Inbound(this._server, props, handler);
-        this._serverInboundConnections.push({
-            name,
-            port: props.port.toString(),
-            server: inbound,
-        });
-        this.emit("inbound", props.port.toString());
-        return inbound;
-    }
-    /**
-     * Get Server Inbound Connection by Name
-     * @since 1.0.0
-     * @param name
-     */
-    getServerByName(name) {
-        const inbound = this._serverInboundConnections.find((inbound) => inbound.name === name);
-        if (typeof inbound !== "undefined") {
-            return inbound.server;
-        }
-        return undefined;
-    }
-    /**
-     * Get Server Inbound Connection by Port
-     * @since 1.0.0
-     * @param port
-     */
-    getServerByPort(port) {
-        const inbound = this._serverInboundConnections.find((inbound) => inbound.port === port);
-        if (typeof inbound !== "undefined") {
-            return inbound.server;
-        }
-        return undefined;
-    }
-}

package/lib/esm/decorate.js

@@ -1 +0,0 @@
-export {};

package/lib/esm/errors.js

@@ -1,7 +0,0 @@
-import createError from "@fastify/error";
-export const errors = {
-    /** Error if there is an setup error of the plugin itself. */
-    FASTIFY_HL7_ERR_SETUP_ERRORS: createError("FASTIFY_HL7_ERR_SETUP_ERRORS", "Setup error: %s"),
-    /** If an invalid usage error was done, this error would pop up. */
-    FASTIFY_HL7_ERR_USAGE: createError("FASTIFY_HL7_ERR_USAGE", "Usage error: %s"),
-};

package/lib/esm/index.d.ts

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

@@ -1,125 +0,0 @@
-import fp from "fastify-plugin";
-import Server from "node-hl7-server";
-import { HL7Server } from "./class/hL7Server.js";
-import { HL7Client } from "./class/hL7Client.js";
-import { errors } from "./errors.js";
-import { validateOpts } from "./validation.js";
-export * from "./types.js";
-/**
- * @since 1.0.0
- * @param fastify
- * @param _opts
- * @param connection
- */
-const decorateFastifyInstance = (fastify, _opts, connection) => {
-    if (typeof fastify.hl7 !== "undefined") {
-        throw new errors.FASTIFY_HL7_ERR_SETUP_ERRORS("Already registered.");
-    }
-    if (typeof fastify.hl7 === "undefined") {
-        fastify.log.trace("[fastify-hl7] Decorate Fastify");
-        fastify.decorate("hl7", connection);
-    }
-};
-const fastifyHL7 = fp(async (fastify, opts) => {
-    const generatedOpts = await validateOpts(opts);
-    opts = { ...opts, ...generatedOpts };
-    // Create server.
-    // 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 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
-    let server;
-    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") {
-                await server.closeAll();
-            }
-        });
-    }
-    // Client Functions
-    const client = new HL7Client();
-    // run these before fastify closes
-    fastify.addHook("preClose", async () => {
-        if (typeof client !== "undefined") {
-            await client.closeAll();
-        }
-    });
-    decorateFastifyInstance(fastify, opts, {
-        _serverInstance: serverInstance,
-        buildBatch: function (props) {
-            return client.buildBatch(props);
-        },
-        buildDate: function (date, length) {
-            return client.buildDate(date, length);
-        },
-        buildFileBatch: function (props) {
-            return client.buildFileBatch(props);
-        },
-        buildMessage: function (props) {
-            return client.buildMessage(props);
-        },
-        closeServer: async function (port) {
-            if (typeof server !== "undefined") {
-                return await server.close(port);
-            }
-            throw new errors.FASTIFY_HL7_ERR_USAGE("server was not started. re-register plugin with enableServer set to true.");
-        },
-        closeServerAll: async () => {
-            if (typeof server !== "undefined") {
-                return await server.closeAll();
-            }
-            throw new errors.FASTIFY_HL7_ERR_USAGE("server was not started. re-register plugin with enableServer set to true.");
-        },
-        createClient: function (name, props) {
-            return client.createClient(name, props);
-        },
-        createInbound: function (name, props, handler) {
-            if (typeof server !== "undefined") {
-                return server.createInbound(name, props, handler);
-            }
-            throw new errors.FASTIFY_HL7_ERR_USAGE("server was not started. re-register plugin with enableServer set to true.");
-        },
-        createConnection: function (name, props, handler) {
-            return client.createConnection(name, props, handler);
-        },
-        getClientByName: function (name) {
-            return client.getClientByName(name);
-        },
-        getClientConnectionByPort: function (port) {
-            return client.getClientConnectionByPort(port);
-        },
-        getServerByName: function (name) {
-            if (typeof server !== "undefined") {
-                return server.getServerByName(name);
-            }
-            throw new errors.FASTIFY_HL7_ERR_USAGE("server was not started. re-register plugin with enableServer set to true.");
-        },
-        getServerByPort: function (port) {
-            if (typeof server !== "undefined") {
-                return server.getServerByPort(port);
-            }
-            throw new errors.FASTIFY_HL7_ERR_USAGE("server was not started. re-register plugin with enableServer set to true.");
-        },
-        processHL7: function (text) {
-            return client.processHL7(text);
-        },
-        readFile: function (fullFilePath) {
-            return client.readFile(fullFilePath);
-        },
-        readFileBuffer: function (fileBuffer) {
-            return client.readFileBuffer(fileBuffer);
-        },
-    });
-});
-export default fastifyHL7;

package/lib/esm/package.json

@@ -1,3 +0,0 @@
-{
-    "type": "module"
-}

package/lib/esm/types.js

@@ -1 +0,0 @@
-export {};

package/lib/esm/validation.d.ts

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

package/lib/esm/validation.js

@@ -1,11 +0,0 @@
-/**
- * @since 1.0.0
- * @param opts
- */
-export const validateOpts = async (opts) => {
-    // Mandatory, Defaulted
-    if (typeof opts.enableServer === "undefined") {
-        opts.enableServer = true;
-    }
-    return opts;
-};

package/lib/types/api.d.ts

@@ -1,7 +0,0 @@
-import { HL7 } from "fastify";
-import fastifyHL7 from ".";
-import { AServers, FastifyHL7Options } from "./decorate.js";
-import { HL7Client } from "./class/hL7Client.js";
-import { HL7Server } from "./class/hL7Server.js";
-export default fastifyHL7;
-export { fastifyHL7, HL7, FastifyHL7Options, HL7Client, HL7Server, AServers };

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

@@ -1,38 +0,0 @@
-import { EventEmitter } from "node:events";
-import Server, { Inbound, InboundHandler, ListenerOptions } from "node-hl7-server";
-export declare class HL7Server extends EventEmitter {
-    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): Inbound;
-    /**
-     * Get Server Inbound Connection by Name
-     * @since 1.0.0
-     * @param name
-     */
-    getServerByName(name: string): Inbound | undefined;
-    /**
-     * Get Server Inbound Connection by Port
-     * @since 1.0.0
-     * @param port
-     */
-    getServerByPort(port: string): Inbound | undefined;
-}

package/lib/types/decorate.d.ts

@@ -1,38 +0,0 @@
-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/types/errors.d.ts

@@ -1,10 +0,0 @@
-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?]>;
-};