@glion/lint-profile-extra-fields 0.14.1

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/dist/index.d.ts

@@ -0,0 +1,15 @@
+import type { Root } from "@glion/ast";
+/**
+ * Lint rule that warns when a segment contains fields beyond the maximum
+ * sequence number defined in its profile.
+ *
+ * Segments without a known profile (e.g., Z-segments) are silently skipped.
+ *
+ * @example
+ *   ```typescript
+ *   unified().use(hl7v2LintExtraFields);
+ *   ```;
+ */
+declare const hl7v2LintExtraFields: import("unified-lint-rule").Plugin<Root, unknown>;
+export default hl7v2LintExtraFields;
+//# 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":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAIvC;;;;;;;;;;GAUG;AACH,QAAA,MAAM,oBAAoB,mDAoCzB,CAAC;AAaF,eAAe,oBAAoB,CAAC"}

package/dist/index.js

@@ -0,0 +1,46 @@
+import { SKIP, visit } from "@glion/util-visit";
+import { lintRule } from "unified-lint-rule";
+//#region src/index.ts
+/**
+* Lint rule that warns when a segment contains fields beyond the maximum
+* sequence number defined in its profile.
+*
+* Segments without a known profile (e.g., Z-segments) are silently skipped.
+*
+* @example
+*   ```typescript
+*   unified().use(hl7v2LintExtraFields);
+*   ```;
+*/
+const hl7v2LintExtraFields = lintRule({ origin: "hl7v2-lint:extra-fields" }, (tree, file) => {
+	const ctx = file.data.profile;
+	if (!ctx) return;
+	visit(tree, "segment", (segment, segmentAncestors) => {
+		const fieldDef = ctx.fields.get(segment.name);
+		if (!fieldDef) return SKIP;
+		const maxSequence = maxKey(fieldDef.bySequence);
+		if (maxSequence === 0) return SKIP;
+		visit(segment, "field", (fieldNode, _fieldAncestors, info) => {
+			if (info.sequence > maxSequence) file.message(`Field ${segment.name}-${info.sequence} is beyond the defined fields for ${segment.name} (max: ${maxSequence} in v${ctx.version})`, {
+				ancestors: [
+					...segmentAncestors,
+					segment,
+					fieldNode
+				],
+				place: fieldNode.position
+			});
+			return SKIP;
+		});
+		return SKIP;
+	});
+});
+/** Return the highest numeric key in a Map, or 0 if empty. */
+function maxKey(map) {
+	let max = 0;
+	for (const key of map.keys()) if (key > max) max = key;
+	return max;
+}
+//#endregion
+export { hl7v2LintExtraFields as default };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["// oxlint-disable-next-line no-unused-vars -- triggers VFile DataMap augmentation\nimport type { ProfileContext } from \"@glion/annotate-profile-context\";\nimport type { Root } from \"@glion/ast\";\nimport { SKIP, visit } from \"@glion/util-visit\";\nimport { lintRule } from \"unified-lint-rule\";\n\n/**\n * Lint rule that warns when a segment contains fields beyond the maximum\n * sequence number defined in its profile.\n *\n * Segments without a known profile (e.g., Z-segments) are silently skipped.\n *\n * @example\n *   ```typescript\n *   unified().use(hl7v2LintExtraFields);\n *   ```;\n */\nconst hl7v2LintExtraFields = lintRule<Root>(\n  { origin: \"hl7v2-lint:extra-fields\" },\n  (tree, file) => {\n    const ctx = file.data.profile;\n    if (!ctx) {\n      return;\n    }\n\n    visit(tree, \"segment\", (segment, segmentAncestors) => {\n      const fieldDef = ctx.fields.get(segment.name);\n      if (!fieldDef) {\n        return SKIP;\n      }\n\n      const maxSequence = maxKey(fieldDef.bySequence);\n      if (maxSequence === 0) {\n        return SKIP;\n      }\n\n      visit(segment, \"field\", (fieldNode, _fieldAncestors, info) => {\n        if (info.sequence > maxSequence) {\n          file.message(\n            `Field ${segment.name}-${info.sequence} is beyond the defined fields for ${segment.name} (max: ${maxSequence} in v${ctx.version})`,\n            {\n              ancestors: [...segmentAncestors, segment, fieldNode],\n              place: fieldNode.position,\n            }\n          );\n        }\n\n        return SKIP;\n      });\n\n      return SKIP;\n    });\n  }\n);\n\n/** Return the highest numeric key in a Map, or 0 if empty. */\nfunction maxKey(map: ReadonlyMap<number, unknown>): number {\n  let max = 0;\n  for (const key of map.keys()) {\n    if (key > max) {\n      max = key;\n    }\n  }\n  return max;\n}\n\nexport default hl7v2LintExtraFields;\n"],"mappings":";;;;;;;;;;;;;;AAiBA,MAAM,uBAAuB,SAC3B,EAAE,QAAQ,2BAA2B,GACpC,MAAM,SAAS;CACd,MAAM,MAAM,KAAK,KAAK;AACtB,KAAI,CAAC,IACH;AAGF,OAAM,MAAM,YAAY,SAAS,qBAAqB;EACpD,MAAM,WAAW,IAAI,OAAO,IAAI,QAAQ,KAAK;AAC7C,MAAI,CAAC,SACH,QAAO;EAGT,MAAM,cAAc,OAAO,SAAS,WAAW;AAC/C,MAAI,gBAAgB,EAClB,QAAO;AAGT,QAAM,SAAS,UAAU,WAAW,iBAAiB,SAAS;AAC5D,OAAI,KAAK,WAAW,YAClB,MAAK,QACH,SAAS,QAAQ,KAAK,GAAG,KAAK,SAAS,oCAAoC,QAAQ,KAAK,SAAS,YAAY,OAAO,IAAI,QAAQ,IAChI;IACE,WAAW;KAAC,GAAG;KAAkB;KAAS;KAAU;IACpD,OAAO,UAAU;IAClB,CACF;AAGH,UAAO;IACP;AAEF,SAAO;GACP;EAEL;;AAGD,SAAS,OAAO,KAA2C;CACzD,IAAI,MAAM;AACV,MAAK,MAAM,OAAO,IAAI,MAAM,CAC1B,KAAI,MAAM,IACR,OAAM;AAGV,QAAO"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@glion/lint-profile-extra-fields",
+  "version": "0.14.1",
+  "description": "Lint rule that warns when a segment contains fields beyond the maximum sequence defined in its profile",
+  "keywords": [
+    "health",
+    "healthcare",
+    "hl7",
+    "hl7v2",
+    "nodejs",
+    "typescript"
+  ],
+  "homepage": "https://glion.dev",
+  "license": "MIT",
+  "author": {
+    "name": "Melek Somai",
+    "email": "melek@rethinkhealth.io"
+  },
+  "repository": "rethinkhealth/glion.git",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "unified-lint-rule": "3.0.1",
+    "@glion/util-visit": "0.14.1",
+    "@glion/ast": "0.14.1"
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.0",
+    "@vitest/coverage-v8": "4.1.2",
+    "tsdown": "0.21.7",
+    "typescript": "^5.9.3",
+    "unified": "^11.0.5",
+    "vfile": "^6.0.3",
+    "vitest": "4.1.2",
+    "@glion/annotate-profile-context": "0.14.1",
+    "@glion/builder": "0.14.1",
+    "@glion/tsconfig": "0.0.1",
+    "@glion/testing": "0.0.2"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsdown && tsc --emitDeclarationOnly",
+    "check-types": "tsc --noEmit",
+    "bench": "vitest bench --run",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest"
+  }
+}