@glion/lint-profile-required-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,20 @@
+import type { Root } from "@glion/ast";
+/**
+ * Lint rule that validates required fields per HL7v2 profile.
+ *
+ * For each segment, checks that all fields marked `required: true`
+ * in the field definition are present and non-empty.
+ *
+ * Segments without a known profile (e.g., Z-segments) are silently skipped.
+ *
+ * Requires `@glion/annotate-profile-context` to run first
+ * so that `file.data.fields` is populated.
+ *
+ * @example
+ *   ```typescript
+ *   unified().use(hl7v2AnnotateProfileContext).use(hl7v2LintRequiredFields);
+ *   ```;
+ */
+declare const hl7v2LintRequiredFields: import("unified-lint-rule").Plugin<Root, unknown>;
+export default hl7v2LintRequiredFields;
+//# 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;AAKvC;;;;;;;;;;;;;;;GAeG;AACH,QAAA,MAAM,uBAAuB,mDA+B5B,CAAC;AAEF,eAAe,uBAAuB,CAAC"}

package/dist/index.js

@@ -0,0 +1,47 @@
+import { visit } from "@glion/util-visit";
+import { isEmptyNode } from "@glion/utils";
+import { lintRule } from "unified-lint-rule";
+//#region src/index.ts
+/**
+* Lint rule that validates required fields per HL7v2 profile.
+*
+* For each segment, checks that all fields marked `required: true`
+* in the field definition are present and non-empty.
+*
+* Segments without a known profile (e.g., Z-segments) are silently skipped.
+*
+* Requires `@glion/annotate-profile-context` to run first
+* so that `file.data.fields` is populated.
+*
+* @example
+*   ```typescript
+*   unified().use(hl7v2AnnotateProfileContext).use(hl7v2LintRequiredFields);
+*   ```;
+*/
+const hl7v2LintRequiredFields = lintRule({ origin: "hl7v2-lint:required-fields" }, (tree, file) => {
+	const ctx = file.data.profile;
+	if (!ctx) return;
+	visit(tree, "segment", (node, parents) => {
+		const fieldDef = ctx.fields.get(node.name);
+		if (!fieldDef) return;
+		for (const sequence of fieldDef.requiredSequences) {
+			const fieldNode = node.children[sequence - 1];
+			if (!fieldNode || isEmptyNode(fieldNode)) {
+				const profile = fieldDef.bySequence.get(sequence);
+				const name = profile?.name ? ` (${profile.name})` : "";
+				file.message(`Required field ${node.name}-${sequence}${name} is missing or empty`, {
+					ancestors: [
+						...parents,
+						node,
+						...fieldNode ? [fieldNode] : []
+					],
+					place: fieldNode?.position ?? node.position
+				});
+			}
+		}
+	});
+});
+//#endregion
+export { hl7v2LintRequiredFields 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 { visit } from \"@glion/util-visit\";\nimport { isEmptyNode } from \"@glion/utils\";\nimport { lintRule } from \"unified-lint-rule\";\n\n/**\n * Lint rule that validates required fields per HL7v2 profile.\n *\n * For each segment, checks that all fields marked `required: true`\n * in the field definition are present and non-empty.\n *\n * Segments without a known profile (e.g., Z-segments) are silently skipped.\n *\n * Requires `@glion/annotate-profile-context` to run first\n * so that `file.data.fields` is populated.\n *\n * @example\n *   ```typescript\n *   unified().use(hl7v2AnnotateProfileContext).use(hl7v2LintRequiredFields);\n *   ```;\n */\nconst hl7v2LintRequiredFields = lintRule<Root>(\n  { origin: \"hl7v2-lint:required-fields\" },\n  (tree, file) => {\n    const ctx = file.data.profile;\n    if (!ctx) {\n      return;\n    }\n\n    visit(tree, \"segment\", (node, parents) => {\n      const fieldDef = ctx.fields.get(node.name);\n      if (!fieldDef) {\n        return;\n      }\n\n      for (const sequence of fieldDef.requiredSequences) {\n        const fieldNode = node.children[sequence - 1];\n\n        if (!fieldNode || isEmptyNode(fieldNode)) {\n          const profile = fieldDef.bySequence.get(sequence);\n          const name = profile?.name ? ` (${profile.name})` : \"\";\n          file.message(\n            `Required field ${node.name}-${sequence}${name} is missing or empty`,\n            {\n              ancestors: [...parents, node, ...(fieldNode ? [fieldNode] : [])],\n              place: fieldNode?.position ?? node.position,\n            }\n          );\n        }\n      }\n    });\n  }\n);\n\nexport default hl7v2LintRequiredFields;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAuBA,MAAM,0BAA0B,SAC9B,EAAE,QAAQ,8BAA8B,GACvC,MAAM,SAAS;CACd,MAAM,MAAM,KAAK,KAAK;AACtB,KAAI,CAAC,IACH;AAGF,OAAM,MAAM,YAAY,MAAM,YAAY;EACxC,MAAM,WAAW,IAAI,OAAO,IAAI,KAAK,KAAK;AAC1C,MAAI,CAAC,SACH;AAGF,OAAK,MAAM,YAAY,SAAS,mBAAmB;GACjD,MAAM,YAAY,KAAK,SAAS,WAAW;AAE3C,OAAI,CAAC,aAAa,YAAY,UAAU,EAAE;IACxC,MAAM,UAAU,SAAS,WAAW,IAAI,SAAS;IACjD,MAAM,OAAO,SAAS,OAAO,KAAK,QAAQ,KAAK,KAAK;AACpD,SAAK,QACH,kBAAkB,KAAK,KAAK,GAAG,WAAW,KAAK,uBAC/C;KACE,WAAW;MAAC,GAAG;MAAS;MAAM,GAAI,YAAY,CAAC,UAAU,GAAG,EAAE;MAAE;KAChE,OAAO,WAAW,YAAY,KAAK;KACpC,CACF;;;GAGL;EAEL"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@glion/lint-profile-required-fields",
+  "version": "0.14.1",
+  "description": "Lint rule to validate required fields per HL7v2 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/utils": "0.14.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/testing": "0.0.2",
+    "@glion/annotate-profile-context": "0.14.1",
+    "@glion/tsconfig": "0.0.1",
+    "@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"
+  }
+}