feat: minor code cleanups (#105)

.github/workflows/deploy-docs.yml

@@ -0,0 +1,28 @@
+name: Deploy Typedoc to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+      - name: Install dependencies
+        run: npm install
+      - name: Generate Typedoc documentation
+        run: npm run typedoc
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GH_TOKEN }}
+          publish_dir: ./docs
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'

README.md

@@ -56,7 +56,9 @@ They might be sans uppercase throughout the documentation, but they would have t
 
 ## Documentation
 
-It's way too extensive to include on this README alone. Please [read this](pages/index.md) to gain more information.
+It's way too extensive to include on this README alone.
+Please [read this](pages/index.md) to gain more information.
+GitHub pages now has mostly full listing of all methods, classes, etc., but only for the most recent release.
 
 ## Acknowledgements
 

package.json

@@ -91,7 +91,7 @@
     "ts-node": "^10.9.2",
     "ts-standard": "^12.0.2",
     "tsd": "^0.31.1",
-    "typedoc": "^0.26.0",
+    "typedoc": "^0.26.1",
     "typescript": "5.5.2",
     "vitest": "^1.6.0"
   },

src/client/client.ts

@@ -30,6 +30,9 @@ export class Client extends EventEmitter {
   }
 
   /**
+   * This creates a new client to a new server connection.
+   * This is the remote side in which we will connect.
+   * Then using the {@link createConnection} method, you establish a connection to the port.
    * @since 1.0.0
    * @param props
    * @example
@@ -71,11 +74,11 @@ export class Client extends EventEmitter {
   createConnection (props: ClientListenerOptions, cb: OutboundHandler): Connection {
     const outbound = new Connection(this, props, cb)
 
-    outbound.on('client.acknowledged', (total) => {
+    outbound.on('client.acknowledged', (total: number) => {
       this.stats._totalAck = this.stats._totalAck + total
     })
 
-    outbound.on('client.sent', (total) => {
+    outbound.on('client.sent', (total: number) => {
       this.stats._totalSent = this.stats._totalSent + total
     })
 
@@ -87,7 +90,7 @@ export class Client extends EventEmitter {
   }
 
   /**
-   * Get the host that we will  connect to.
+   * Get the host that we will connect to.
    * The port might be different from each different "connection"
    * @since 1.1.0
    */

src/client/connection.ts

@@ -14,7 +14,7 @@ import { Client } from './client.js'
 import { InboundResponse } from './module/inboundResponse.js'
 
 /* eslint-disable */
-export interface Connection extends EventEmitter {
+export interface IConnection extends EventEmitter {
   /** The connection has been closed manually. You have to start the connection again. */
   on(name: 'close', cb: () => void): this;
   /** The connection is made. */
@@ -37,7 +37,7 @@ export interface Connection extends EventEmitter {
 /** Connection Class
  * @description Create a connection customer that will listen to result send to the particular port.
  * @since 1.0.0 */
-export class Connection extends EventEmitter implements Connection {
+export class Connection extends EventEmitter implements IConnection {
   /** @internal */
   _handler: OutboundHandler
   /** @internal */

src/client/module/inboundResponse.ts

@@ -10,7 +10,8 @@ export class InboundResponse {
 
   /**
    * Process the Inbound Response from the Server
-   * @description This takes the string of the response from the server and makes it a message. A response from a broker SHOULD always be a
+   * @description This takes the string of the response from the server and makes it a message.
+   * A response from a broker SHOULD always be a properly formated Hl7 message, we hope.
    * @since 1.0.0
    * @param data
    */

src/index.ts

@@ -2,7 +2,7 @@ import { Client } from './client/client.js'
 import { Message } from './builder/message.js'
 import { Batch } from './builder/batch.js'
 import { FileBatch } from './builder/fileBatch.js'
-import { Connection } from './client/connection.js'
+import { Connection, IConnection } from './client/connection.js'
 import { Delimiters, ReadyState } from './utils/enum.js'
 import { OutboundHandler } from './utils/normalizedClient.js'
 import { InboundResponse } from './client/module/inboundResponse.js'
@@ -18,4 +18,4 @@ export type { ClientBuilderFileOptions, ClientBuilderMessageOptions, ClientBuild
 export type { HL7Error, HL7FatalError, HL7ParserError } from './utils/exception.js'
 
 export default Client
-export { Client, Connection, OutboundHandler, InboundResponse, FileBatch, Batch, Message, ReadyState, NodeBase, EmptyNode, Segment, Delimiters, HL7Node }
+export { Client, Connection, IConnection, OutboundHandler, InboundResponse, FileBatch, Batch, Message, ReadyState, NodeBase, EmptyNode, Segment, Delimiters, HL7Node }

src/utils/normalizedBuilder.ts

@@ -1,6 +1,6 @@
 import fs from 'fs'
 import { HL7_2_7 } from '../specification/2.7.js'
-import { MSH } from '../specification/specification'
+import { MSH } from '../specification/specification.js'
 import { HL7FatalError } from './exception.js'
 import { ParserPlan } from './parserPlan.js'
 import { isBatch } from './utils.js'

src/utils/utils.ts

@@ -163,7 +163,7 @@ export const validIPv6 = (ip: string): boolean => {
 }
 
 /**
- * Generate a random String
+ * Generate a random string
  * @since 1.0.0
  * @param length
  */

tsconfig.cjs.json

@@ -1,9 +1,9 @@
 {
-  "extends": "./tsconfig.build.json",
+  "extends": "./tsconfig.json",
   "compilerOptions": {
-    "declaration": false,
-    "sourceMap": false,
     "module": "commonjs",
-    "outDir": "./lib/cjs"
+    "outDir": "./lib/cjs",
+    "declaration": false,
+    "sourceMap": false
   }
 }

tsconfig.esm.json

@@ -1,13 +1,9 @@
 {
-  "extends": "./tsconfig.build.json",
+  "extends": "./tsconfig.json",
   "compilerOptions": {
-    "declaration": false,
-    "sourceMap": false,
-    "target": "ES2022",
-    "lib": [
-      "es2021"
-    ],
-    "module": "es6",
-    "outDir": "./lib/esm"
+    "module": "ESNext",
+    "outDir": "./lib/esm",
+    "declaration": true,
+    "sourceMap": true
   }
 }

tsconfig.json

@@ -1,23 +1,25 @@
 {
   "compilerOptions": {
-    "allowJs": false,
-    "stripInternal": true,
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020"],
+    "outDir": "./dist",
+    "rootDir": "./src",
     "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
     "noImplicitAny": true,
+    "noImplicitReturns": true,
     "noImplicitThis": true,
-    "alwaysStrict": true,
-    "forceConsistentCasingInFileNames": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
+    "resolveJsonModule": true,
+    "typeRoots": ["./node_modules/@types"],
     "moduleResolution": "node",
-    "strictNullChecks": true,
-    "typeRoots": [
-      "./node_modules/@types",
-      "./@types"
-    ],
-    "esModuleInterop": true
+    "sourceMap": true,
+    "declaration": true
   },
-  "compileOnSave": true
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules", "**/*.spec.ts"]
 }

typedoc.json

@@ -2,7 +2,7 @@
   "entryPoints": ["src/api.ts"],
   "excludeExternals": true,
   "excludeInternal": true,
-  "includeVersion": false,
+  "includeVersion": true,
   "githubPages": false,
   "out": "./docs",
   "name": "Node HL7 Client",