@rethinkhealth/hl7v2-lint-message-version 0.2.22

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,80 @@
+## @rethinkhealth/hl7v2-lint-message-version
+
+> Lint rule that checks an HL7v2 message version (MSH-12) satisfies a version expression.
+
+### Installation
+
+```bash
+pnpm add -D @rethinkhealth/hl7v2-lint-message-version
+```
+
+### Usage
+
+```typescript
+import { unified } from "unified";
+import { hl7v2Parser } from "@rethinkhealth/hl7v2-parser";
+import hl7v2LintMessageVersion from "@rethinkhealth/hl7v2-lint-message-version";
+
+const message = `MSH|^~\\&|SENDER|FAC|RCVR|FAC|20250101010101||ADT^A01^ADT_A01|MSG00001|P|2.5`;
+
+const processor = unified()
+  .use(hl7v2Parser)
+  // default expression is "<3.0.0 >=2.3"
+  .use(hl7v2LintMessageVersion, { expression: "<3.0.0 >=2.3" });
+
+await processor.process(message);
+```
+
+### Options
+
+- **expression**: string (optional)
+  - A semver-like range expression evaluated against `MSH-12`.
+  - Defaults to `"<3.0.0 >=2.3"`.
+
+Expressions are parsed and evaluated by `@rethinkhealth/hl7v2-util-semver`.
+
+### Examples
+
+- **✅ Valid within default range** (default `"<3.0.0 >=2.3"`)
+
+```
+MSH|^~\&|SENDER|FAC|RCVR|FAC|20250101010101||ADT^A01^ADT_A01|MSG00001|P|2.5
+```
+
+- **❌ Invalid: below minimum (2.3)**
+
+```
+MSH|^~\&|SENDER|FAC|RCVR|FAC|20250101010101||ADT^A01^ADT_A01|MSG00001|P|2.2
+```
+
+- **✅ Custom expression allowing 2.2**
+
+```typescript
+unified()
+  .use(hl7v2Parser)
+  .use(hl7v2LintMessageVersion, { expression: "<3.0.0 >=2.2" });
+```
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide][github-contributing] 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][github-code-of-conduct] 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][github-license] file for details.
+
+[github-code-of-conduct]: https://github.com/rethinkhealth/hl7v2/blob/main/CODE_OF_CONDUCT.md
+[github-license]: https://github.com/rethinkhealth/hl7v2/blob/main/LICENSE
+[github-contributing]: https://github.com/rethinkhealth/hl7v2/blob/main/CONTRIBUTING.md

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import type { Node } from "@rethinkhealth/hl7v2-ast";
+export type MessageVersionLintOptions = {
+    expression: string;
+};
+declare const hl7v2LintMessageVersion: import("unified-lint-rule").Plugin<Node, MessageVersionLintOptions>;
+export default hl7v2LintMessageVersion;
+//# 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,EAAQ,MAAM,0BAA0B,CAAC;AAK3D,MAAM,MAAM,yBAAyB,GAAG;IACtC,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAMF,QAAA,MAAM,uBAAuB,qEA6D5B,CAAC;AAEF,eAAe,uBAAuB,CAAC"}

package/dist/index.js

@@ -0,0 +1,66 @@
+// src/index.ts
+import { find, value } from "@rethinkhealth/hl7v2-util-query";
+import { parse, satisfies } from "@rethinkhealth/hl7v2-util-semver";
+import { lintRule } from "unified-lint-rule";
+var defaultOptions = {
+  expression: "<3.0.0 >=2.3"
+};
+var hl7v2LintMessageVersion = lintRule(
+  {
+    origin: "hl7v2-lint:message-version",
+    url: "https://github.com/rethinkhealth/hl7v2/tree/main/packages/hl7v2-lint-message-version#readme"
+  },
+  (tree, file, opts) => {
+    const options = { ...defaultOptions, ...opts };
+    if (tree.type !== "root") {
+      file.fail(
+        `The root node is expected to be a message. Received ${tree.type} instead.`,
+        {
+          ancestors: [tree],
+          place: tree.position
+        }
+      );
+      return;
+    }
+    const msh12 = find(tree, "MSH-12");
+    const place = msh12?.position ?? tree.position;
+    if (!msh12) {
+      file.fail("Message version (MSH.12) is not present.", {
+        ancestors: [tree],
+        place
+      });
+      return;
+    }
+    const versionStr = value(tree, "MSH-12");
+    if (!versionStr) {
+      file.fail(
+        "Unexpected value `undefined` for `MSH-12`, expected `string`",
+        {
+          ancestors: [tree, msh12],
+          place
+        }
+      );
+      return;
+    }
+    const version = parse(versionStr);
+    if (!version) {
+      file.fail("The message version is not valid.", {
+        ancestors: [tree, msh12],
+        place
+      });
+      return;
+    }
+    if (!satisfies(versionStr, options.expression)) {
+      file.fail("Message version is not supported.", {
+        ancestors: [tree, msh12],
+        place
+      });
+      return;
+    }
+  }
+);
+var index_default = hl7v2LintMessageVersion;
+export {
+  index_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, Root } from \"@rethinkhealth/hl7v2-ast\";\nimport { find, value } from \"@rethinkhealth/hl7v2-util-query\";\nimport { parse, satisfies } from \"@rethinkhealth/hl7v2-util-semver\";\nimport { lintRule } from \"unified-lint-rule\";\n\nexport type MessageVersionLintOptions = {\n  expression: string;\n};\n\nconst defaultOptions: Required<MessageVersionLintOptions> = {\n  expression: \"<3.0.0 >=2.3\",\n};\n\nconst hl7v2LintMessageVersion = lintRule<Node, MessageVersionLintOptions>(\n  {\n    origin: \"hl7v2-lint:message-version\",\n    url: \"https://github.com/rethinkhealth/hl7v2/tree/main/packages/hl7v2-lint-message-version#readme\",\n  },\n  (tree, file, opts) => {\n    const options = { ...defaultOptions, ...opts };\n\n    if (tree.type !== \"root\") {\n      file.fail(\n        `The root node is expected to be a message. Received ${tree.type} instead.`,\n        {\n          ancestors: [tree],\n          place: tree.position,\n        }\n      );\n      return;\n    }\n\n    const msh12 = find(tree as Root, \"MSH-12\");\n    const place = msh12?.position ?? tree.position;\n\n    if (!msh12) {\n      file.fail(\"Message version (MSH.12) is not present.\", {\n        ancestors: [tree],\n        place,\n      });\n      return;\n    }\n\n    const versionStr = value(tree as Root, \"MSH-12\");\n\n    if (!versionStr) {\n      file.fail(\n        \"Unexpected value `undefined` for `MSH-12`, expected `string`\",\n        {\n          ancestors: [tree, msh12],\n          place,\n        }\n      );\n      return;\n    }\n\n    const version = parse(versionStr);\n\n    if (!version) {\n      file.fail(\"The message version is not valid.\", {\n        ancestors: [tree, msh12],\n        place,\n      });\n      return;\n    }\n\n    if (!satisfies(versionStr, options.expression)) {\n      file.fail(\"Message version is not supported.\", {\n        ancestors: [tree, msh12],\n        place,\n      });\n      return;\n    }\n  }\n);\n\nexport default hl7v2LintMessageVersion;\n"],"mappings":";AACA,SAAS,MAAM,aAAa;AAC5B,SAAS,OAAO,iBAAiB;AACjC,SAAS,gBAAgB;AAMzB,IAAM,iBAAsD;AAAA,EAC1D,YAAY;AACd;AAEA,IAAM,0BAA0B;AAAA,EAC9B;AAAA,IACE,QAAQ;AAAA,IACR,KAAK;AAAA,EACP;AAAA,EACA,CAAC,MAAM,MAAM,SAAS;AACpB,UAAM,UAAU,EAAE,GAAG,gBAAgB,GAAG,KAAK;AAE7C,QAAI,KAAK,SAAS,QAAQ;AACxB,WAAK;AAAA,QACH,uDAAuD,KAAK,IAAI;AAAA,QAChE;AAAA,UACE,WAAW,CAAC,IAAI;AAAA,UAChB,OAAO,KAAK;AAAA,QACd;AAAA,MACF;AACA;AAAA,IACF;AAEA,UAAM,QAAQ,KAAK,MAAc,QAAQ;AACzC,UAAM,QAAQ,OAAO,YAAY,KAAK;AAEtC,QAAI,CAAC,OAAO;AACV,WAAK,KAAK,4CAA4C;AAAA,QACpD,WAAW,CAAC,IAAI;AAAA,QAChB;AAAA,MACF,CAAC;AACD;AAAA,IACF;AAEA,UAAM,aAAa,MAAM,MAAc,QAAQ;AAE/C,QAAI,CAAC,YAAY;AACf,WAAK;AAAA,QACH;AAAA,QACA;AAAA,UACE,WAAW,CAAC,MAAM,KAAK;AAAA,UACvB;AAAA,QACF;AAAA,MACF;AACA;AAAA,IACF;AAEA,UAAM,UAAU,MAAM,UAAU;AAEhC,QAAI,CAAC,SAAS;AACZ,WAAK,KAAK,qCAAqC;AAAA,QAC7C,WAAW,CAAC,MAAM,KAAK;AAAA,QACvB;AAAA,MACF,CAAC;AACD;AAAA,IACF;AAEA,QAAI,CAAC,UAAU,YAAY,QAAQ,UAAU,GAAG;AAC9C,WAAK,KAAK,qCAAqC;AAAA,QAC7C,WAAW,CAAC,MAAM,KAAK;AAAA,QACvB;AAAA,MACF,CAAC;AACD;AAAA,IACF;AAAA,EACF;AACF;AAEA,IAAO,gBAAQ;","names":[]}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@rethinkhealth/hl7v2-lint-message-version",
+  "description": "hl7v2-lint rule to warn when message version is not supported",
+  "version": "0.2.22",
+  "license": "MIT",
+  "author": {
+    "name": "Melek Somai",
+    "email": "melek@rethinkhealth.io"
+  },
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "dependencies": {
+    "unified-lint-rule": "3.0.1",
+    "@rethinkhealth/hl7v2-util-semver": "0.2.22",
+    "@rethinkhealth/hl7v2-util-query": "0.2.22"
+  },
+  "devDependencies": {
+    "@types/node": "24.8.1",
+    "@types/unist": "^3.0.3",
+    "@vitest/coverage-v8": "^3.2.4",
+    "tsup": "8.5.0",
+    "typescript": "^5.9.3",
+    "unified": "^11.0.5",
+    "vfile": "^6.0.3",
+    "vfile-reporter": "^8.1.1",
+    "vitest": "^3.2.4",
+    "@rethinkhealth/hl7v2-builder": "0.2.22",
+    "@rethinkhealth/hl7v2-ast": "0.2.22",
+    "@rethinkhealth/testing": "0.0.1",
+    "@rethinkhealth/tsconfig": "0.0.1"
+  },
+  "repository": "rethinkhealth/hl7v2.git",
+  "homepage": "https://www.rethinkhealth.io/hl7v2/docs",
+  "keywords": [
+    "definition",
+    "hl7",
+    "hl7v2",
+    "hl7v2-lint",
+    "hl7v2-lint-rule",
+    "lint",
+    "nodejs",
+    "rule",
+    "typescript",
+    "version"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup && tsc --emitDeclarationOnly",
+    "check-types": "tsc --noEmit",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest"
+  }
+}