@glion/lint-profile-field-max-length 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,22 @@
+import type { Root } from "@glion/ast";
+/**
+ * Lint rule that validates field value lengths against HL7v2 profile maxLength.
+ *
+ * For each field with a defined `maxLength` in the profile, checks that
+ * each repetition's content length does not exceed the limit.
+ *
+ * The length is measured using `getLength()` from `hl7v2-utils`, which
+ * recursively sums the string lengths of all subcomponent values.
+ * Delimiters are not included in the count.
+ *
+ * Fields without `maxLength` in the profile and empty fields are skipped.
+ * Segments without a known profile (e.g., Z-segments) are silently skipped.
+ *
+ * @example
+ *   ```typescript
+ *   unified().use(hl7v2LintFieldMaxLength);
+ *   ```;
+ */
+declare const hl7v2LintFieldMaxLength: import("unified-lint-rule").Plugin<Root, unknown>;
+export default hl7v2LintFieldMaxLength;
+//# 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;;;;;;;;;;;;;;;;;GAiBG;AACH,QAAA,MAAM,uBAAuB,mDAqD5B,CAAC;AAEF,eAAe,uBAAuB,CAAC"}

package/dist/index.js

@@ -0,0 +1,54 @@
+import { SKIP, visit } from "@glion/util-visit";
+import { getLength, isEmptyNode } from "@glion/utils";
+import { lintRule } from "unified-lint-rule";
+//#region src/index.ts
+/**
+* Lint rule that validates field value lengths against HL7v2 profile maxLength.
+*
+* For each field with a defined `maxLength` in the profile, checks that
+* each repetition's content length does not exceed the limit.
+*
+* The length is measured using `getLength()` from `hl7v2-utils`, which
+* recursively sums the string lengths of all subcomponent values.
+* Delimiters are not included in the count.
+*
+* Fields without `maxLength` in the profile and empty fields are skipped.
+* Segments without a known profile (e.g., Z-segments) are silently skipped.
+*
+* @example
+*   ```typescript
+*   unified().use(hl7v2LintFieldMaxLength);
+*   ```;
+*/
+const hl7v2LintFieldMaxLength = lintRule({ origin: "hl7v2-lint:field-max-length" }, (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;
+		visit(segment, "field", (fieldNode, _fieldAncestors, info) => {
+			if (isEmptyNode(fieldNode)) return SKIP;
+			const profile = fieldDef.bySequence.get(info.sequence);
+			if (!profile?.maxLength) return SKIP;
+			for (const repetition of fieldNode.children) {
+				const len = getLength(repetition);
+				if (len === 0) continue;
+				if (len > profile.maxLength) file.message(`Field ${segment.name}-${info.sequence} exceeds max length of ${profile.maxLength} (actual: ${len})`, {
+					ancestors: [
+						...segmentAncestors,
+						segment,
+						fieldNode,
+						repetition
+					],
+					place: repetition.position ?? fieldNode.position
+				});
+			}
+			return SKIP;
+		});
+		return SKIP;
+	});
+});
+//#endregion
+export { hl7v2LintFieldMaxLength 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 { getLength, isEmptyNode } from \"@glion/utils\";\nimport { lintRule } from \"unified-lint-rule\";\n\n/**\n * Lint rule that validates field value lengths against HL7v2 profile maxLength.\n *\n * For each field with a defined `maxLength` in the profile, checks that\n * each repetition's content length does not exceed the limit.\n *\n * The length is measured using `getLength()` from `hl7v2-utils`, which\n * recursively sums the string lengths of all subcomponent values.\n * Delimiters are not included in the count.\n *\n * Fields without `maxLength` in the profile and empty fields are skipped.\n * Segments without a known profile (e.g., Z-segments) are silently skipped.\n *\n * @example\n *   ```typescript\n *   unified().use(hl7v2LintFieldMaxLength);\n *   ```;\n */\nconst hl7v2LintFieldMaxLength = lintRule<Root>(\n  { origin: \"hl7v2-lint:field-max-length\" },\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      visit(segment, \"field\", (fieldNode, _fieldAncestors, info) => {\n        if (isEmptyNode(fieldNode)) {\n          return SKIP;\n        }\n\n        const profile = fieldDef.bySequence.get(info.sequence);\n\n        if (!profile?.maxLength) {\n          return SKIP;\n        }\n\n        for (const repetition of fieldNode.children) {\n          const len = getLength(repetition);\n          if (len === 0) {\n            continue;\n          }\n\n          if (len > profile.maxLength) {\n            file.message(\n              `Field ${segment.name}-${info.sequence} exceeds max length of ${profile.maxLength} (actual: ${len})`,\n              {\n                ancestors: [\n                  ...segmentAncestors,\n                  segment,\n                  fieldNode,\n                  repetition,\n                ],\n                place: repetition.position ?? fieldNode.position,\n              }\n            );\n          }\n        }\n\n        return SKIP;\n      });\n\n      return SKIP;\n    });\n  }\n);\n\nexport default hl7v2LintFieldMaxLength;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAyBA,MAAM,0BAA0B,SAC9B,EAAE,QAAQ,+BAA+B,GACxC,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;AAGT,QAAM,SAAS,UAAU,WAAW,iBAAiB,SAAS;AAC5D,OAAI,YAAY,UAAU,CACxB,QAAO;GAGT,MAAM,UAAU,SAAS,WAAW,IAAI,KAAK,SAAS;AAEtD,OAAI,CAAC,SAAS,UACZ,QAAO;AAGT,QAAK,MAAM,cAAc,UAAU,UAAU;IAC3C,MAAM,MAAM,UAAU,WAAW;AACjC,QAAI,QAAQ,EACV;AAGF,QAAI,MAAM,QAAQ,UAChB,MAAK,QACH,SAAS,QAAQ,KAAK,GAAG,KAAK,SAAS,yBAAyB,QAAQ,UAAU,YAAY,IAAI,IAClG;KACE,WAAW;MACT,GAAG;MACH;MACA;MACA;MACD;KACD,OAAO,WAAW,YAAY,UAAU;KACzC,CACF;;AAIL,UAAO;IACP;AAEF,SAAO;GACP;EAEL"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@glion/lint-profile-field-max-length",
+  "version": "0.14.1",
+  "description": "Lint rule to validate field value lengths against HL7v2 profile maxLength",
+  "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/util-visit": "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/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"
+  }
+}