@glion/lint-profile-table-values 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,21 @@
+import type { Root } from "@glion/ast";
+/**
+ * Lint rule that validates coded field values against HL7-type tables.
+ *
+ * For each field that references a table in its profile, loads the table
+ * definition and checks that the field's first component value is a valid
+ * code in that table.
+ *
+ * Only `hl7`-type tables are validated. `user`-type tables are skipped
+ * (they contain site-specific codes).
+ *
+ * Empty fields are skipped. Segments without a known profile are skipped.
+ *
+ * @example
+ *   ```typescript
+ *   unified().use(hl7v2LintTableValues);
+ *   ```;
+ */
+declare const hl7v2LintTableValues: import("unified-lint-rule").Plugin<Root, unknown>;
+export default hl7v2LintTableValues;
+//# 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,EAAW,MAAM,YAAY,CAAC;AAahD;;;;;;;;;;;;;;;;GAgBG;AACH,QAAA,MAAM,oBAAoB,mDA+DzB,CAAC;AAEF,eAAe,oBAAoB,CAAC"}

package/dist/index.js

@@ -0,0 +1,66 @@
+import { SKIP, visit } from "@glion/util-visit";
+import { isEmptyNode } from "@glion/utils";
+import { lintRule } from "unified-lint-rule";
+//#region src/index.ts
+/**
+* Strip the "HL7" prefix from table IDs in field profiles.
+* Field profiles reference tables as "HL70001"; the tables store uses "0001".
+*/
+function normalizeTableId(tableRef) {
+	return tableRef.replace(/^HL7/, "");
+}
+/**
+* Lint rule that validates coded field values against HL7-type tables.
+*
+* For each field that references a table in its profile, loads the table
+* definition and checks that the field's first component value is a valid
+* code in that table.
+*
+* Only `hl7`-type tables are validated. `user`-type tables are skipped
+* (they contain site-specific codes).
+*
+* Empty fields are skipped. Segments without a known profile are skipped.
+*
+* @example
+*   ```typescript
+*   unified().use(hl7v2LintTableValues);
+*   ```;
+*/
+const hl7v2LintTableValues = lintRule({ origin: "hl7v2-lint:table-values" }, (tree, file) => {
+	const ctx = file.data.profile;
+	if (!ctx) return;
+	visit(tree, "field", (fieldNode, ancestors, info) => {
+		if (isEmptyNode(fieldNode)) return SKIP;
+		const segment = ancestors.at(-1);
+		if (!segment || segment.type !== "segment") return SKIP;
+		const fieldDef = ctx.fields.get(segment.name);
+		if (!fieldDef) return SKIP;
+		const fieldProfile = fieldDef.bySequence.get(info.sequence);
+		if (!fieldProfile?.table) return SKIP;
+		const tableId = normalizeTableId(fieldProfile.table);
+		const tableDef = ctx.tables.get(tableId);
+		if (!tableDef) return SKIP;
+		if (tableDef.type !== "hl7") return SKIP;
+		for (const repetition of fieldNode.children) {
+			const sub = repetition?.children[0]?.children[0];
+			if (!sub?.value) continue;
+			const val = sub.value;
+			if (!tableDef.codes.has(val)) {
+				const name = fieldProfile.name ? ` (${fieldProfile.name})` : "";
+				file.message(`Field ${segment.name}-${info.sequence}${name} value '${val}' is not in table ${tableId} (${tableDef.description})`, {
+					ancestors: [
+						...ancestors,
+						fieldNode,
+						repetition
+					],
+					place: repetition.position ?? fieldNode.position
+				});
+			}
+		}
+		return SKIP;
+	});
+});
+//#endregion
+export { hl7v2LintTableValues 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, Segment } from \"@glion/ast\";\nimport { SKIP, visit } from \"@glion/util-visit\";\nimport { isEmptyNode } from \"@glion/utils\";\nimport { lintRule } from \"unified-lint-rule\";\n\n/**\n * Strip the \"HL7\" prefix from table IDs in field profiles.\n * Field profiles reference tables as \"HL70001\"; the tables store uses \"0001\".\n */\nfunction normalizeTableId(tableRef: string): string {\n  return tableRef.replace(/^HL7/, \"\");\n}\n\n/**\n * Lint rule that validates coded field values against HL7-type tables.\n *\n * For each field that references a table in its profile, loads the table\n * definition and checks that the field's first component value is a valid\n * code in that table.\n *\n * Only `hl7`-type tables are validated. `user`-type tables are skipped\n * (they contain site-specific codes).\n *\n * Empty fields are skipped. Segments without a known profile are skipped.\n *\n * @example\n *   ```typescript\n *   unified().use(hl7v2LintTableValues);\n *   ```;\n */\nconst hl7v2LintTableValues = lintRule<Root>(\n  { origin: \"hl7v2-lint:table-values\" },\n  (tree, file) => {\n    const ctx = file.data.profile;\n    if (!ctx) {\n      return;\n    }\n\n    visit(tree, \"field\", (fieldNode, ancestors, info) => {\n      // Check emptiness first — avoids lookups for the majority of fields\n      if (isEmptyNode(fieldNode)) {\n        return SKIP;\n      }\n\n      const segment = ancestors.at(-1) as Segment | undefined;\n      if (!segment || segment.type !== \"segment\") {\n        return SKIP;\n      }\n\n      const fieldDef = ctx.fields.get(segment.name);\n      if (!fieldDef) {\n        return SKIP;\n      }\n\n      const fieldProfile = fieldDef.bySequence.get(info.sequence);\n      if (!fieldProfile?.table) {\n        return SKIP;\n      }\n\n      const tableId = normalizeTableId(fieldProfile.table);\n      const tableDef = ctx.tables.get(tableId);\n      if (!tableDef) {\n        return SKIP;\n      }\n\n      // Only validate HL7-defined tables\n      if (tableDef.type !== \"hl7\") {\n        return SKIP;\n      }\n\n      // Check each repetition's coded value against the table\n      for (const repetition of fieldNode.children) {\n        const sub = repetition?.children[0]?.children[0];\n        if (!sub?.value) {\n          continue;\n        }\n        const val = sub.value;\n\n        if (!tableDef.codes.has(val)) {\n          const name = fieldProfile.name ? ` (${fieldProfile.name})` : \"\";\n          file.message(\n            `Field ${segment.name}-${info.sequence}${name} value '${val}' is not in table ${tableId} (${tableDef.description})`,\n            {\n              ancestors: [...ancestors, fieldNode, repetition],\n              place: repetition.position ?? fieldNode.position,\n            }\n          );\n        }\n      }\n\n      return SKIP;\n    });\n  }\n);\n\nexport default hl7v2LintTableValues;\n"],"mappings":";;;;;;;;AAWA,SAAS,iBAAiB,UAA0B;AAClD,QAAO,SAAS,QAAQ,QAAQ,GAAG;;;;;;;;;;;;;;;;;;;AAoBrC,MAAM,uBAAuB,SAC3B,EAAE,QAAQ,2BAA2B,GACpC,MAAM,SAAS;CACd,MAAM,MAAM,KAAK,KAAK;AACtB,KAAI,CAAC,IACH;AAGF,OAAM,MAAM,UAAU,WAAW,WAAW,SAAS;AAEnD,MAAI,YAAY,UAAU,CACxB,QAAO;EAGT,MAAM,UAAU,UAAU,GAAG,GAAG;AAChC,MAAI,CAAC,WAAW,QAAQ,SAAS,UAC/B,QAAO;EAGT,MAAM,WAAW,IAAI,OAAO,IAAI,QAAQ,KAAK;AAC7C,MAAI,CAAC,SACH,QAAO;EAGT,MAAM,eAAe,SAAS,WAAW,IAAI,KAAK,SAAS;AAC3D,MAAI,CAAC,cAAc,MACjB,QAAO;EAGT,MAAM,UAAU,iBAAiB,aAAa,MAAM;EACpD,MAAM,WAAW,IAAI,OAAO,IAAI,QAAQ;AACxC,MAAI,CAAC,SACH,QAAO;AAIT,MAAI,SAAS,SAAS,MACpB,QAAO;AAIT,OAAK,MAAM,cAAc,UAAU,UAAU;GAC3C,MAAM,MAAM,YAAY,SAAS,IAAI,SAAS;AAC9C,OAAI,CAAC,KAAK,MACR;GAEF,MAAM,MAAM,IAAI;AAEhB,OAAI,CAAC,SAAS,MAAM,IAAI,IAAI,EAAE;IAC5B,MAAM,OAAO,aAAa,OAAO,KAAK,aAAa,KAAK,KAAK;AAC7D,SAAK,QACH,SAAS,QAAQ,KAAK,GAAG,KAAK,WAAW,KAAK,UAAU,IAAI,oBAAoB,QAAQ,IAAI,SAAS,YAAY,IACjH;KACE,WAAW;MAAC,GAAG;MAAW;MAAW;MAAW;KAChD,OAAO,WAAW,YAAY,UAAU;KACzC,CACF;;;AAIL,SAAO;GACP;EAEL"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@glion/lint-profile-table-values",
+  "version": "0.14.1",
+  "description": "Lint rule to validate coded field values against HL7v2 tables",
+  "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/ast": "0.14.1",
+    "@glion/utils": "0.14.1",
+    "@glion/util-visit": "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/tsconfig": "0.0.1",
+    "@glion/testing": "0.0.2",
+    "@glion/builder": "0.14.1"
+  },
+  "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"
+  }
+}