@glion/lint-profile-required-components 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 components in composite datatype fields.
+ *
+ * For each field with a composite datatype, checks that all components
+ * marked `required: true` in the datatype definition are present and
+ * non-empty in every field repetition.
+ *
+ * Empty fields are skipped (the required-fields rule handles that).
+ * Simple (non-composite) datatypes are skipped.
+ * Segments without a known profile (e.g., Z-segments) are silently skipped.
+ *
+ * @example
+ *   ```typescript
+ *   unified().use(hl7v2LintRequiredComponents);
+ *   ```;
+ */
+declare const hl7v2LintRequiredComponents: import("unified-lint-rule").Plugin<Root, unknown>;
+export default hl7v2LintRequiredComponents;
+//# 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,EAAiC,IAAI,EAAW,MAAM,YAAY,CAAC;AAO/E;;;;;;;;;;;;;;;GAeG;AACH,QAAA,MAAM,2BAA2B,mDAsDhC,CAAC;AAsCF,eAAe,2BAA2B,CAAC"}

package/dist/index.js

@@ -0,0 +1,60 @@
+import { SKIP, 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 components in composite datatype fields.
+*
+* For each field with a composite datatype, checks that all components
+* marked `required: true` in the datatype definition are present and
+* non-empty in every field repetition.
+*
+* Empty fields are skipped (the required-fields rule handles that).
+* Simple (non-composite) datatypes are skipped.
+* Segments without a known profile (e.g., Z-segments) are silently skipped.
+*
+* @example
+*   ```typescript
+*   unified().use(hl7v2LintRequiredComponents);
+*   ```;
+*/
+const hl7v2LintRequiredComponents = lintRule({ origin: "hl7v2-lint:required-components" }, (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) return SKIP;
+		const dtDef = ctx.datatypes.get(fieldProfile.datatype);
+		if (!dtDef || dtDef.kind !== "composite" || dtDef.requiredSequences.size === 0) return SKIP;
+		for (const repetition of fieldNode.children) checkRepetition(file, dtDef, repetition, segment, info.sequence, ancestors, fieldNode);
+		return SKIP;
+	});
+});
+/** Check a single field repetition for missing required components. */
+function checkRepetition(file, dtDef, repetition, segment, sequence, ancestors, fieldNode) {
+	for (const compSeq of dtDef.requiredSequences) {
+		const component = repetition.children[compSeq - 1];
+		if (!(component?.children[0]?.value !== void 0 && component.children[0].value.length > 0)) {
+			const compProfile = dtDef.componentsBySequence.get(compSeq);
+			const compName = compProfile?.name ? ` (${compProfile.name})` : "";
+			file.message(`Required component ${segment.name}-${sequence}.${compSeq}${compName} is missing or empty`, {
+				ancestors: [
+					...ancestors,
+					fieldNode,
+					repetition,
+					...component ? [component] : []
+				],
+				place: component?.position ?? repetition.position ?? fieldNode.position
+			});
+		}
+	}
+}
+//#endregion
+export { hl7v2LintRequiredComponents 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 { Field, FieldRepetition, Nodes, Root, Segment } from \"@glion/ast\";\nimport type { DatatypeDefinition } from \"@glion/profiles\";\nimport { SKIP, visit } from \"@glion/util-visit\";\nimport { isEmptyNode } from \"@glion/utils\";\nimport { lintRule } from \"unified-lint-rule\";\nimport type { VFile } from \"vfile\";\n\n/**\n * Lint rule that validates required components in composite datatype fields.\n *\n * For each field with a composite datatype, checks that all components\n * marked `required: true` in the datatype definition are present and\n * non-empty in every field repetition.\n *\n * Empty fields are skipped (the required-fields rule handles that).\n * Simple (non-composite) datatypes are skipped.\n * Segments without a known profile (e.g., Z-segments) are silently skipped.\n *\n * @example\n *   ```typescript\n *   unified().use(hl7v2LintRequiredComponents);\n *   ```;\n */\nconst hl7v2LintRequiredComponents = lintRule<Root>(\n  { origin: \"hl7v2-lint:required-components\" },\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 — most fields in a message are empty,\n      // so this avoids segment/profile lookups for the majority of fields\n      if (isEmptyNode(fieldNode as Field)) {\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) {\n        return SKIP;\n      }\n\n      const dtDef = ctx.datatypes.get(fieldProfile.datatype);\n      if (\n        !dtDef ||\n        dtDef.kind !== \"composite\" ||\n        dtDef.requiredSequences.size === 0\n      ) {\n        return SKIP;\n      }\n\n      for (const repetition of (fieldNode as Field).children) {\n        checkRepetition(\n          file,\n          dtDef,\n          repetition,\n          segment,\n          info.sequence,\n          ancestors,\n          fieldNode as Field\n        );\n      }\n\n      return SKIP;\n    });\n  }\n);\n\n/** Check a single field repetition for missing required components. */\nfunction checkRepetition(\n  file: VFile,\n  dtDef: DatatypeDefinition,\n  repetition: FieldRepetition,\n  segment: Segment,\n  sequence: number,\n  ancestors: Nodes[],\n  fieldNode: Field\n): void {\n  for (const compSeq of dtDef.requiredSequences) {\n    const component = repetition.children[compSeq - 1];\n    const compHasValue =\n      component?.children[0]?.value !== undefined &&\n      component.children[0].value.length > 0;\n\n    if (!compHasValue) {\n      const compProfile = dtDef.componentsBySequence.get(compSeq);\n      const compName = compProfile?.name ? ` (${compProfile.name})` : \"\";\n      file.message(\n        `Required component ${segment.name}-${sequence}.${compSeq}${compName} is missing or empty`,\n        {\n          ancestors: [\n            ...ancestors,\n            fieldNode,\n            repetition,\n            ...(component ? [component] : []),\n          ],\n          place:\n            component?.position ?? repetition.position ?? fieldNode.position,\n        }\n      );\n    }\n  }\n}\n\nexport default hl7v2LintRequiredComponents;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAyBA,MAAM,8BAA8B,SAClC,EAAE,QAAQ,kCAAkC,GAC3C,MAAM,SAAS;CACd,MAAM,MAAM,KAAK,KAAK;AACtB,KAAI,CAAC,IACH;AAGF,OAAM,MAAM,UAAU,WAAW,WAAW,SAAS;AAGnD,MAAI,YAAY,UAAmB,CACjC,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,aACH,QAAO;EAGT,MAAM,QAAQ,IAAI,UAAU,IAAI,aAAa,SAAS;AACtD,MACE,CAAC,SACD,MAAM,SAAS,eACf,MAAM,kBAAkB,SAAS,EAEjC,QAAO;AAGT,OAAK,MAAM,cAAe,UAAoB,SAC5C,iBACE,MACA,OACA,YACA,SACA,KAAK,UACL,WACA,UACD;AAGH,SAAO;GACP;EAEL;;AAGD,SAAS,gBACP,MACA,OACA,YACA,SACA,UACA,WACA,WACM;AACN,MAAK,MAAM,WAAW,MAAM,mBAAmB;EAC7C,MAAM,YAAY,WAAW,SAAS,UAAU;AAKhD,MAAI,EAHF,WAAW,SAAS,IAAI,UAAU,KAAA,KAClC,UAAU,SAAS,GAAG,MAAM,SAAS,IAEpB;GACjB,MAAM,cAAc,MAAM,qBAAqB,IAAI,QAAQ;GAC3D,MAAM,WAAW,aAAa,OAAO,KAAK,YAAY,KAAK,KAAK;AAChE,QAAK,QACH,sBAAsB,QAAQ,KAAK,GAAG,SAAS,GAAG,UAAU,SAAS,uBACrE;IACE,WAAW;KACT,GAAG;KACH;KACA;KACA,GAAI,YAAY,CAAC,UAAU,GAAG,EAAE;KACjC;IACD,OACE,WAAW,YAAY,WAAW,YAAY,UAAU;IAC3D,CACF"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@glion/lint-profile-required-components",
+  "version": "0.14.1",
+  "description": "Lint rule to validate required components in composite datatype fields",
+  "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",
+    "@glion/utils": "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/profiles": "0.14.1",
+    "@glion/testing": "0.0.2",
+    "@glion/tsconfig": "0.0.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"
+  }
+}