@rethinkhealth/hl7v2-lint-segment-header-length 0.2.8

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Rethink Health
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,174 @@
+# @rethinkhealth/hl7v2-lint-segment-header-length
+
+A [`unified`][github-unified] lint rule for HL7v2 that warns when a segment **header** (segment ID) is not exactly three uppercase ASCII letters (e.g., `MSH`, `PID`, `OBX`).
+
+## What is this?
+
+This package validates the **segment header** in HL7v2 syntax trees produced by parsers like [`@rethinkhealth/hl7v2-parser`][github-hl7v2-parser].  
+
+It reports a message when the header before the first field delimiter is not a 3-letter uppercase code.
+
+## When should I use this?
+
+Use this rule to enforce canonical HL7v2 segment identifiers across messages, catch typos (e.g., `PID1`, `Obx`, `MS`), and improve downstream processing reliability.
+
+## Presets
+
+This plugin is included in the following presets:
+
+| Preset | Options |
+| - | - |
+| `@rethinkhealth/hl7v2-lint-recommended` | |
+
+## Install
+
+This package is **ESM only**. In Node.js (v16+), install with npm:
+
+```sh
+npm install @rethinkhealth/hl7v2-lint-segment-header-length
+````
+
+
+## Use
+
+On the API:
+
+```js
+import { unified } from 'unified'
+import { hl7v2Parse } from '@rethinkhealth/hl7v2-parser'
+import hl7v2LintSegmentHeaderLength from '@rethinkhealth/hl7v2-lint-segment-header-length'
+import { reporter } from 'vfile-reporter'
+
+const msg = `MSH|^~\\&|...`
+const file = await unified()
+  .use(hl7v2Parse)
+  .use(hl7v2LintSegmentHeaderLength)
+  .process(msg)
+
+console.error(reporter([file]))
+```
+
+
+## API
+
+### `unified().use(hl7v2LintSegmentHeaderLength[, options])`
+
+Warn when a segment header is not a three-letter uppercase code.
+
+###### Parameters
+
+* `options.allow` (optional, `string[]`) — an allowlist of additional 3-letter codes (e.g., private segments such as `ZAD`). Values must still be 3 uppercase letters.
+
+###### Returns
+
+A `unified` Transformer that adds messages to the file.
+
+## Recommendation
+
+HL7v2 segments are identified by **exactly three uppercase letters**. Deviations often indicate malformed input, private extensions used incorrectly, or typos that can break routing and transformations.
+
+It’s recommended to enable this rule in most pipelines.
+
+## Examples
+
+##### `ok.hl7`
+
+###### In
+
+```hl7
+MSH|^~\&|... 
+PID|1||12345^^^HOSP^MR||DOE^JANE||...
+OBX|1|TX|...
+```
+
+###### Out
+
+No messages.
+
+##### `not-ok-too-long.hl7`
+
+###### In
+
+```hl7
+PID1|1||12345||DOE^JANE||...
+```
+
+###### Out
+
+```text
+1:1-1:4: Invalid segment header `PID1`: expected exactly 3 uppercase letters (e.g., `PID`)
+```
+
+##### `not-ok-too-short.hl7`
+
+###### In
+
+```hl7
+MS|^~\&|...
+```
+
+###### Out
+
+```text
+1:1-1:3: Invalid segment header `MS`: expected 3 uppercase letters
+```
+
+##### `not-ok-lowercase.hl7`
+
+###### In
+
+```hl7
+obx|1|TX|...
+```
+
+###### Out
+
+```text
+1:1-1:4: Invalid segment header `obx`: expected uppercase `OBX`
+```
+
+##### `ok-with-allowlist.hl7`
+
+###### In
+
+```hl7
+ZAD|1|...
+```
+
+With:
+
+```js
+.unified().use(hl7v2LintSegmentHeaderLength, { allow: ['ZAD'] })
+```
+
+###### Out
+
+No messages.
+
+## Security
+
+This plugin only transforms AST nodes and does not execute code. Ensure you trust the source of HL7v2 messages before processing.
+
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](../../CONTRIBUTING.md) for more details.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Code of Conduct
+
+To ensure a welcoming and positive environment, we have a [Code of Conduct](../../CODE_OF_CONDUCT.md) that all contributors and participants are expected to adhere to.
+
+## License
+
+Copyright 2025 Rethink Health, SUARL. All rights reserved.
+
+This program is licensed to you under the terms of the [MIT License](https://opensource.org/licenses/MIT). This program is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [LICENSE](../../LICENSE) file for details.
+
+[github-unified]: https://github.com/unifiedjs/unified
+[github-hl7v2-parser]: https://github.com/rethinkhealth/hl7v2/tree/main/packages/hl7v2-parser

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import type { Node } from '@rethinkhealth/hl7v2-ast';
+/**
+ * hl7v2-lint rule to warn when segment header length is invalid.
+ *
+ *
+ */
+declare const hl7v2LintSegmentHeaderLength: import("unified-lint-rule").Plugin<Node, undefined>;
+export default hl7v2LintSegmentHeaderLength;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAW,MAAM,0BAA0B,CAAC;AAK9D;;;;GAIG;AACH,QAAA,MAAM,4BAA4B,qDAiCjC,CAAC;AAEF,eAAe,4BAA4B,CAAC"}

package/dist/index.js

@@ -0,0 +1,33 @@
+// src/index.ts
+import pluralize from "pluralize";
+import { lintRule } from "unified-lint-rule";
+import { CONTINUE, SKIP, visitParents } from "unist-util-visit-parents";
+var hl7v2LintSegmentHeaderLength = lintRule(
+  {
+    origin: "hl7v2-lint:segment-header-length",
+    url: "https://github.com/rethinkhealth/hl7v2/tree/main/packages/hl7v2-lint-segment-header-length#readme"
+  },
+  (tree, file) => {
+    visitParents(tree, (node, parents) => {
+      if (node.type === "root") {
+        return CONTINUE;
+      }
+      if (node.type !== "segment") {
+        return SKIP;
+      }
+      const size = node.children?.[0]?.children?.[0]?.children?.[0]?.children?.[0]?.value.length ?? 0;
+      if (size === 3) {
+        return SKIP;
+      }
+      file.message(
+        `Unexpected ${size} header length, expected 3 characters, ${size > 3 ? `remove ${size - 3} ${pluralize("character", size - 3)}` : `add ${3 - (size ?? 0)} ${pluralize("character", 3 - (size ?? 0))}`}`,
+        { ancestors: [...parents, node], place: node.position }
+      );
+    });
+  }
+);
+var src_default = hl7v2LintSegmentHeaderLength;
+export {
+  src_default as default
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import type { Node, Segment } from '@rethinkhealth/hl7v2-ast';\nimport pluralize from 'pluralize';\nimport { lintRule } from 'unified-lint-rule';\nimport { CONTINUE, SKIP, visitParents } from 'unist-util-visit-parents';\n\n/**\n * hl7v2-lint rule to warn when segment header length is invalid.\n *\n *\n */\nconst hl7v2LintSegmentHeaderLength = lintRule<Node, undefined>(\n  {\n    origin: 'hl7v2-lint:segment-header-length',\n    url: 'https://github.com/rethinkhealth/hl7v2/tree/main/packages/hl7v2-lint-segment-header-length#readme',\n  },\n  (tree, file) => {\n    visitParents(tree, (node, parents) => {\n      if (node.type === 'root') {\n        return CONTINUE;\n      }\n\n      if (node.type !== 'segment') {\n        return SKIP;\n      }\n\n      const size =\n        (node as Segment).children?.[0]?.children?.[0]?.children?.[0]\n          ?.children?.[0]?.value.length ?? 0;\n\n      if (size === 3) {\n        return SKIP;\n      }\n\n      file.message(\n        `Unexpected ${size} header length, expected 3 characters, ${\n          size > 3\n            ? `remove ${size - 3} ${pluralize('character', size - 3)}`\n            : `add ${3 - (size ?? 0)} ${pluralize('character', 3 - (size ?? 0))}`\n        }`,\n        { ancestors: [...parents, node], place: node.position }\n      );\n    });\n  }\n);\n\nexport default hl7v2LintSegmentHeaderLength;\n"],"mappings":";AACA,OAAO,eAAe;AACtB,SAAS,gBAAgB;AACzB,SAAS,UAAU,MAAM,oBAAoB;AAO7C,IAAM,+BAA+B;AAAA,EACnC;AAAA,IACE,QAAQ;AAAA,IACR,KAAK;AAAA,EACP;AAAA,EACA,CAAC,MAAM,SAAS;AACd,iBAAa,MAAM,CAAC,MAAM,YAAY;AACpC,UAAI,KAAK,SAAS,QAAQ;AACxB,eAAO;AAAA,MACT;AAEA,UAAI,KAAK,SAAS,WAAW;AAC3B,eAAO;AAAA,MACT;AAEA,YAAM,OACH,KAAiB,WAAW,CAAC,GAAG,WAAW,CAAC,GAAG,WAAW,CAAC,GACxD,WAAW,CAAC,GAAG,MAAM,UAAU;AAErC,UAAI,SAAS,GAAG;AACd,eAAO;AAAA,MACT;AAEA,WAAK;AAAA,QACH,cAAc,IAAI,0CAChB,OAAO,IACH,UAAU,OAAO,CAAC,IAAI,UAAU,aAAa,OAAO,CAAC,CAAC,KACtD,OAAO,KAAK,QAAQ,EAAE,IAAI,UAAU,aAAa,KAAK,QAAQ,EAAE,CAAC,EACvE;AAAA,QACA,EAAE,WAAW,CAAC,GAAG,SAAS,IAAI,GAAG,OAAO,KAAK,SAAS;AAAA,MACxD;AAAA,IACF,CAAC;AAAA,EACH;AACF;AAEA,IAAO,cAAQ;","names":[]}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@rethinkhealth/hl7v2-lint-segment-header-length",
+  "description": "hl7v2-lint rule to warn when segment header length is invalid",
+  "version": "0.2.8",
+  "license": "MIT",
+  "author": {
+    "name": "Melek Somai",
+    "email": "melek@rethinkhealth.io"
+  },
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "dependencies": {
+    "pluralize": "^8.0.0",
+    "unified": "11.0.1",
+    "unified-lint-rule": "^3.0.0",
+    "unist-util-visit-parents": "^6.0.1"
+  },
+  "devDependencies": {
+    "@types/node": "22.15.31",
+    "@types/pluralize": "^0.0.33",
+    "@types/unist": "^3.0.3",
+    "@vitest/coverage-c8": "^0.33.0",
+    "@vitest/coverage-v8": "^3.2.4",
+    "tsup": "8.5.0",
+    "typescript": "^5.8.3",
+    "vfile-reporter": "^8.1.1",
+    "vitest": "^3.2.4",
+    "@rethinkhealth/hl7v2-ast": "0.2.8",
+    "@rethinkhealth/tsconfig": "0.0.0",
+    "@rethinkhealth/testing": "0.0.0",
+    "@rethinkhealth/hl7v2": "0.2.8"
+  },
+  "repository": "rethinkhealth/hl7v2.git",
+  "homepage": "https://www.rethinkhealth.io/hl7v2/docs",
+  "keywords": [
+    "hl7",
+    "hl7v2",
+    "nodejs",
+    "typescript",
+    "definition",
+    "lint",
+    "hl7v2-lint",
+    "hl7v2-lint-rule",
+    "rule"
+  ],
+  "packageManager": "pnpm@10.12.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup && tsc --emitDeclarationOnly",
+    "check-types": "tsc --noEmit",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest"
+  }
+}