@glion/lint-profile-segment-order 0.22.0 → 0.23.0

package/README.md

@@ -168,6 +168,27 @@ Unexpected segment 'PID'. Expected: EVN, SFT
 
 The offending segment name and the segments valid at that position, sorted, are interpolated.
 
+### Invalid — segment after the end of the message
+
+`DSC` ends an `ORU_R01`, so no segment may follow it:
+
+```hl7
+MSH|^~\&|LAB|FAC|EMR|RFAC|20250601120000||ORU^R01^ORU_R01|MSG00001|P|2.5
+PID|1||PATID1234^^^HOSP^MR||DOE^JANE||19800101|F
+OBR|1|ORD1||CBC
+OBX|1|NM|WBC||5.0
+DSC|1
+PID|2||PATID5678^^^HOSP^MR||DOE^JOHN||19750101|M
+```
+
+Reported message:
+
+```
+Unexpected segment 'PID'
+```
+
+When no segment is valid at that position, the message lists none.
+
 ### Invalid — message ended prematurely
 
 All segments were consumed but the schema still requires more; an `ADT_A01` needs a `PV1`:

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAS,IAAI,EAAW,MAAM,YAAY,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAKnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,uEAAuE;AACvE,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,KAAK,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;;OAOG;IACH,UAAU,CAAC,EACP,WAAW,GACX,CAAC,CACC,OAAO,EAAE,mBAAmB,KACzB,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC,CAAC;IACrE;;;;;OAKG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAuDD,QAAA,MAAM,qBAAqB,+DAmD1B,CAAC;AAEF,eAAe,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAS,IAAI,EAAW,MAAM,YAAY,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAKnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,uEAAuE;AACvE,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,IAAI,CAAC;IACX,IAAI,EAAE,KAAK,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;;OAOG;IACH,UAAU,CAAC,EACP,WAAW,GACX,CAAC,CACC,OAAO,EAAE,mBAAmB,KACzB,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC,CAAC;IACrE;;;;;OAKG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAuDD,QAAA,MAAM,qBAAqB,+DAoD1B,CAAC;AAEF,eAAe,qBAAqB,CAAC"}

package/dist/index.js

@@ -71,7 +71,8 @@ const hl7v2LintSegmentOrder = lintRule({ origin: "hl7v2-lint:segment-order" }, a
 		case "matched": break;
 		case "mismatched": {
 			const { ancestors, node } = segments[result.index];
-			file.message(`Unexpected segment '${node.name}'. Expected: ${result.expected.join(", ")}`, {
+			const reason = result.expected.length > 0 ? `Unexpected segment '${node.name}'. Expected: ${result.expected.join(", ")}` : `Unexpected segment '${node.name}'`;
+			file.message(reason, {
 				ancestors,
 				place: node.position
 			});

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { Nodes, Root, Segment } from \"@glion/ast\";\nimport type { EventSchema } from \"@glion/profiles\";\nimport { profiles, runner } from \"@glion/profiles\";\nimport { value } from \"@glion/util-query\";\nimport { SKIP, visit } from \"@glion/util-visit\";\nimport { lintRule } from \"unified-lint-rule\";\nimport type { VFile } from \"vfile\";\n\n/** The message a `definition` function chooses an event schema for. */\nexport interface SegmentOrderContext {\n  tree: Root;\n  file: VFile;\n}\n\n/**\n * Options for the segment order lint rule.\n */\nexport interface SegmentOrderOptions {\n  /**\n   * The event schema to validate against, or a function that returns the\n   * one to use for a message. Default: the schema MSH-9 names.\n   *\n   * When the function returns `undefined`, the rule uses the schema MSH-9\n   * names. Return the same object for every message that uses a schema: a\n   * new object is compiled on its first run.\n   */\n  definition?:\n    | EventSchema\n    | ((\n        context: SegmentOrderContext\n      ) => EventSchema | undefined | Promise<EventSchema | undefined>);\n  /**\n   * Whether a Z-segment (a segment ID that starts with `Z`) that the event\n   * schema does not name fits at any position. HL7v2 allows local Z-segments\n   * in any message and segment group (v2.5.1 §2.11). When `false`, the rule\n   * reports such a segment as unexpected. Default: `true`.\n   */\n  allowZSegments?: boolean;\n}\n\n/**\n * Lint rule that validates HL7v2 segment order against event schema\n * profiles.\n *\n * Verifies each segment appears in the order the event schema defines.\n *\n * **Resolution**: If no `definition` is provided, the rule resolves the\n * schema from MSH-12 (version) and MSH-9.3 (event schema), or MSH-9.1\n * and MSH-9.2 when MSH-9.3 is empty. If the schema is unavailable, the rule\n * reports nothing.\n *\n * **Behavior**: Reports at most one order error per message: the first segment\n * the schema does not allow. A Z-segment the schema does not name is allowed\n * anywhere unless `allowZSegments` is `false`.\n *\n * @example\n *   ```typescript\n *   // With the schema MSH-9 names:\n *   unified().use(hl7v2LintSegmentOrder);\n *\n *   // With a schema of your own:\n *   unified().use(hl7v2LintSegmentOrder, {\n *     definition: {\n *       elements: [\n *         { name: \"MSH\", optional: false, repeating: false, type: \"segment\" },\n *         { name: \"PID\", optional: false, repeating: false, type: \"segment\" },\n *       ],\n *       id: \"ADT_SITE\",\n *     },\n *   });\n *\n *   // With a schema chosen per message, and the one MSH-9 names otherwise:\n *   unified().use(hl7v2LintSegmentOrder, {\n *     definition: ({ tree }) =>\n *       isSiteMessage(tree) ? SITE_STRUCTURE : undefined,\n *   });\n *   ```;\n */\n/**\n * The event schema MSH-12 and MSH-9 name: MSH-9.3, or MSH-9.1 and MSH-9.2,\n * which the events store resolves through the version's event map.\n */\nconst schemaOf = async (tree: Root): Promise<EventSchema | undefined> => {\n  const version = value(tree, \"MSH-12.1\")?.value;\n  if (!version) {\n    return;\n  }\n  const id =\n    value(tree, \"MSH-9.3\")?.value ||\n    `${value(tree, \"MSH-9.1\")?.value ?? \"\"}_${value(tree, \"MSH-9.2\")?.value ?? \"\"}`;\n  return await profiles.events.load(version, id);\n};\n\nconst hl7v2LintSegmentOrder = lintRule<Root, SegmentOrderOptions>(\n  {\n    origin: \"hl7v2-lint:segment-order\",\n  },\n  async (tree, file, options) => {\n    const definition = options?.definition;\n    const chosen =\n      typeof definition === \"function\"\n        ? await definition({ file, tree })\n        : definition;\n    const schema = chosen ?? (await schemaOf(tree));\n\n    if (!schema) {\n      return;\n    }\n\n    const segments: { node: Segment; ancestors: Nodes[] }[] = [];\n    visit(tree, \"segment\", (node, parents) => {\n      segments.push({ ancestors: [...parents, node], node });\n      return SKIP;\n    });\n\n    const result = runner(\n      schema,\n      segments.map(({ node }) => node.name),\n      { allowZSegments: options?.allowZSegments }\n    );\n\n    switch (result.type) {\n      case \"matched\": {\n        break;\n      }\n      case \"mismatched\": {\n        const { ancestors, node } = segments[\n          result.index\n        ] as (typeof segments)[number];\n        file.message(\n          `Unexpected segment '${node.name}'. Expected: ${result.expected.join(\", \")}`,\n          { ancestors, place: node.position }\n        );\n        break;\n      }\n      case \"incomplete\": {\n        file.message(\n          `Message ended prematurely. Expected: ${result.expected.join(\", \")}`,\n          { ancestors: [tree], place: tree.position }\n        );\n        break;\n      }\n    }\n  }\n);\n\nexport default hl7v2LintSegmentOrder;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkFA,MAAM,WAAW,OAAO,SAAiD;CACvE,MAAM,UAAU,MAAM,MAAM,WAAW,EAAE;AACzC,KAAI,CAAC,QACH;CAEF,MAAM,KACJ,MAAM,MAAM,UAAU,EAAE,SACxB,GAAG,MAAM,MAAM,UAAU,EAAE,SAAS,GAAG,GAAG,MAAM,MAAM,UAAU,EAAE,SAAS;AAC7E,QAAO,MAAM,SAAS,OAAO,KAAK,SAAS,GAAG;;AAGhD,MAAM,wBAAwB,SAC5B,EACE,QAAQ,4BACT,EACD,OAAO,MAAM,MAAM,YAAY;CAC7B,MAAM,aAAa,SAAS;CAK5B,MAAM,UAHJ,OAAO,eAAe,aAClB,MAAM,WAAW;EAAE;EAAM;EAAM,CAAC,GAChC,eACoB,MAAM,SAAS,KAAK;AAE9C,KAAI,CAAC,OACH;CAGF,MAAM,WAAoD,EAAE;AAC5D,OAAM,MAAM,YAAY,MAAM,YAAY;AACxC,WAAS,KAAK;GAAE,WAAW,CAAC,GAAG,SAAS,KAAK;GAAE;GAAM,CAAC;AACtD,SAAO;GACP;CAEF,MAAM,SAAS,OACb,QACA,SAAS,KAAK,EAAE,WAAW,KAAK,KAAK,EACrC,EAAE,gBAAgB,SAAS,gBAAgB,CAC5C;AAED,SAAQ,OAAO,MAAf;EACE,KAAK,UACH;EAEF,KAAK,cAAc;GACjB,MAAM,EAAE,WAAW,SAAS,SAC1B,OAAO;AAET,QAAK,QACH,uBAAuB,KAAK,KAAK,eAAe,OAAO,SAAS,KAAK,KAAK,IAC1E;IAAE;IAAW,OAAO,KAAK;IAAU,CACpC;AACD;;EAEF,KAAK;AACH,QAAK,QACH,wCAAwC,OAAO,SAAS,KAAK,KAAK,IAClE;IAAE,WAAW,CAAC,KAAK;IAAE,OAAO,KAAK;IAAU,CAC5C;AACD;;EAIP"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { Nodes, Root, Segment } from \"@glion/ast\";\nimport type { EventSchema } from \"@glion/profiles\";\nimport { profiles, runner } from \"@glion/profiles\";\nimport { value } from \"@glion/util-query\";\nimport { SKIP, visit } from \"@glion/util-visit\";\nimport { lintRule } from \"unified-lint-rule\";\nimport type { VFile } from \"vfile\";\n\n/** The message a `definition` function chooses an event schema for. */\nexport interface SegmentOrderContext {\n  tree: Root;\n  file: VFile;\n}\n\n/**\n * Options for the segment order lint rule.\n */\nexport interface SegmentOrderOptions {\n  /**\n   * The event schema to validate against, or a function that returns the\n   * one to use for a message. Default: the schema MSH-9 names.\n   *\n   * When the function returns `undefined`, the rule uses the schema MSH-9\n   * names. Return the same object for every message that uses a schema: a\n   * new object is compiled on its first run.\n   */\n  definition?:\n    | EventSchema\n    | ((\n        context: SegmentOrderContext\n      ) => EventSchema | undefined | Promise<EventSchema | undefined>);\n  /**\n   * Whether a Z-segment (a segment ID that starts with `Z`) that the event\n   * schema does not name fits at any position. HL7v2 allows local Z-segments\n   * in any message and segment group (v2.5.1 §2.11). When `false`, the rule\n   * reports such a segment as unexpected. Default: `true`.\n   */\n  allowZSegments?: boolean;\n}\n\n/**\n * Lint rule that validates HL7v2 segment order against event schema\n * profiles.\n *\n * Verifies each segment appears in the order the event schema defines.\n *\n * **Resolution**: If no `definition` is provided, the rule resolves the\n * schema from MSH-12 (version) and MSH-9.3 (event schema), or MSH-9.1\n * and MSH-9.2 when MSH-9.3 is empty. If the schema is unavailable, the rule\n * reports nothing.\n *\n * **Behavior**: Reports at most one order error per message: the first segment\n * the schema does not allow. A Z-segment the schema does not name is allowed\n * anywhere unless `allowZSegments` is `false`.\n *\n * @example\n *   ```typescript\n *   // With the schema MSH-9 names:\n *   unified().use(hl7v2LintSegmentOrder);\n *\n *   // With a schema of your own:\n *   unified().use(hl7v2LintSegmentOrder, {\n *     definition: {\n *       elements: [\n *         { name: \"MSH\", optional: false, repeating: false, type: \"segment\" },\n *         { name: \"PID\", optional: false, repeating: false, type: \"segment\" },\n *       ],\n *       id: \"ADT_SITE\",\n *     },\n *   });\n *\n *   // With a schema chosen per message, and the one MSH-9 names otherwise:\n *   unified().use(hl7v2LintSegmentOrder, {\n *     definition: ({ tree }) =>\n *       isSiteMessage(tree) ? SITE_STRUCTURE : undefined,\n *   });\n *   ```;\n */\n/**\n * The event schema MSH-12 and MSH-9 name: MSH-9.3, or MSH-9.1 and MSH-9.2,\n * which the events store resolves through the version's event map.\n */\nconst schemaOf = async (tree: Root): Promise<EventSchema | undefined> => {\n  const version = value(tree, \"MSH-12.1\")?.value;\n  if (!version) {\n    return;\n  }\n  const id =\n    value(tree, \"MSH-9.3\")?.value ||\n    `${value(tree, \"MSH-9.1\")?.value ?? \"\"}_${value(tree, \"MSH-9.2\")?.value ?? \"\"}`;\n  return await profiles.events.load(version, id);\n};\n\nconst hl7v2LintSegmentOrder = lintRule<Root, SegmentOrderOptions>(\n  {\n    origin: \"hl7v2-lint:segment-order\",\n  },\n  async (tree, file, options) => {\n    const definition = options?.definition;\n    const chosen =\n      typeof definition === \"function\"\n        ? await definition({ file, tree })\n        : definition;\n    const schema = chosen ?? (await schemaOf(tree));\n\n    if (!schema) {\n      return;\n    }\n\n    const segments: { node: Segment; ancestors: Nodes[] }[] = [];\n    visit(tree, \"segment\", (node, parents) => {\n      segments.push({ ancestors: [...parents, node], node });\n      return SKIP;\n    });\n\n    const result = runner(\n      schema,\n      segments.map(({ node }) => node.name),\n      { allowZSegments: options?.allowZSegments }\n    );\n\n    switch (result.type) {\n      case \"matched\": {\n        break;\n      }\n      case \"mismatched\": {\n        const { ancestors, node } = segments[\n          result.index\n        ] as (typeof segments)[number];\n        const reason =\n          result.expected.length > 0\n            ? `Unexpected segment '${node.name}'. Expected: ${result.expected.join(\", \")}`\n            : `Unexpected segment '${node.name}'`;\n        file.message(reason, { ancestors, place: node.position });\n        break;\n      }\n      case \"incomplete\": {\n        file.message(\n          `Message ended prematurely. Expected: ${result.expected.join(\", \")}`,\n          { ancestors: [tree], place: tree.position }\n        );\n        break;\n      }\n    }\n  }\n);\n\nexport default hl7v2LintSegmentOrder;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkFA,MAAM,WAAW,OAAO,SAAiD;CACvE,MAAM,UAAU,MAAM,MAAM,WAAW,EAAE;AACzC,KAAI,CAAC,QACH;CAEF,MAAM,KACJ,MAAM,MAAM,UAAU,EAAE,SACxB,GAAG,MAAM,MAAM,UAAU,EAAE,SAAS,GAAG,GAAG,MAAM,MAAM,UAAU,EAAE,SAAS;AAC7E,QAAO,MAAM,SAAS,OAAO,KAAK,SAAS,GAAG;;AAGhD,MAAM,wBAAwB,SAC5B,EACE,QAAQ,4BACT,EACD,OAAO,MAAM,MAAM,YAAY;CAC7B,MAAM,aAAa,SAAS;CAK5B,MAAM,UAHJ,OAAO,eAAe,aAClB,MAAM,WAAW;EAAE;EAAM;EAAM,CAAC,GAChC,eACoB,MAAM,SAAS,KAAK;AAE9C,KAAI,CAAC,OACH;CAGF,MAAM,WAAoD,EAAE;AAC5D,OAAM,MAAM,YAAY,MAAM,YAAY;AACxC,WAAS,KAAK;GAAE,WAAW,CAAC,GAAG,SAAS,KAAK;GAAE;GAAM,CAAC;AACtD,SAAO;GACP;CAEF,MAAM,SAAS,OACb,QACA,SAAS,KAAK,EAAE,WAAW,KAAK,KAAK,EACrC,EAAE,gBAAgB,SAAS,gBAAgB,CAC5C;AAED,SAAQ,OAAO,MAAf;EACE,KAAK,UACH;EAEF,KAAK,cAAc;GACjB,MAAM,EAAE,WAAW,SAAS,SAC1B,OAAO;GAET,MAAM,SACJ,OAAO,SAAS,SAAS,IACrB,uBAAuB,KAAK,KAAK,eAAe,OAAO,SAAS,KAAK,KAAK,KAC1E,uBAAuB,KAAK,KAAK;AACvC,QAAK,QAAQ,QAAQ;IAAE;IAAW,OAAO,KAAK;IAAU,CAAC;AACzD;;EAEF,KAAK;AACH,QAAK,QACH,wCAAwC,OAAO,SAAS,KAAK,KAAK,IAClE;IAAE,WAAW,CAAC,KAAK;IAAE,OAAO,KAAK;IAAU,CAC5C;AACD;;EAIP"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glion/lint-profile-segment-order",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "description": "Lints the segment order of an HL7v2 message against its message structure",
   "keywords": [
     "health",
@@ -35,10 +35,10 @@
   "dependencies": {
     "unified-lint-rule": "3.0.1",
     "vfile": "6.0.3",
-    "@glion/ast": "0.22.0",
-    "@glion/util-query": "0.22.0",
-    "@glion/profiles": "0.22.0",
-    "@glion/util-visit": "0.22.0"
+    "@glion/ast": "0.23.0",
+    "@glion/profiles": "0.23.0",
+    "@glion/util-query": "0.23.0",
+    "@glion/util-visit": "0.23.0"
   },
   "devDependencies": {
     "@types/node": "25.6.0",
@@ -48,9 +48,9 @@
     "typescript": "6.0.3",
     "unified": "^11.0.5",
     "vitest": "4.1.11",
-    "@glion/builder": "0.22.0",
+    "@glion/builder": "0.23.0",
     "@glion/check-readme": "0.18.0",
-    "@glion/parser": "0.22.0",
+    "@glion/parser": "0.23.0",
     "@glion/testing": "0.18.0",
     "@glion/tsconfig": "0.18.0"
   },