@rethinkhealth/hl7v2-ast 0.4.2 → 0.5.0

package/README.md

@@ -14,8 +14,8 @@ The specification follows the [Unist](https://github.com/syntax-tree/unist) mode
 
 ### Where this specification fits
 
-* **hl7v2-ast** extends [unist](https://github.com/syntax-tree/unist) with HL7-specific node types.
-* Integrates with editor tooling, validators, and transformers.
+- **hl7v2-ast** extends [unist](https://github.com/syntax-tree/unist) with HL7-specific node types.
+- Integrates with editor tooling, validators, and transformers.
 
 ## Types
 
@@ -40,9 +40,9 @@ root
                 └── subcomponent (&)
 ```
 
-* Every **field** always contains one or more `field-repetition` nodes, even if there is no `~`.
-* Every **component** always contains one or more `subcomponent` nodes, even if there is no `&`.
-* Only `subcomponent` nodes carry `value`.
+- Every **field** always contains one or more `field-repetition` nodes, even if there is no `~`.
+- Every **component** always contains one or more `subcomponent` nodes, even if there is no `&`.
+- Only `subcomponent` nodes carry `value`.
 
 ## Nodes (abstract)
 
@@ -183,9 +183,9 @@ type HL7v2Content =
 
 The AST is designed for:
 
-* **Validation plugins** (segment rules, field presence)
-* **Annotation plugins** (map to FHIR, metadata)
-* **Transformers** (to JSON, FHIR, XML)
+- **Validation plugins** (segment rules, field presence)
+- **Annotation plugins** (map to FHIR, metadata)
+- **Transformers** (to JSON, FHIR, XML)
 
 ## Contributing
 
@@ -209,4 +209,4 @@ This program is licensed to you under the terms of the [MIT License](https://ope
 
 [github-code-of-conduct]: https://github.com/rethinkhealth/hl7v2/blob/main/CODE_OF_CONDUCT.md
 [github-license]: https://github.com/rethinkhealth/hl7v2/blob/main/LICENSE
-[github-contributing]: https://github.com/rethinkhealth/hl7v2/blob/main/CONTRIBUTING.md
+[github-contributing]: https://github.com/rethinkhealth/hl7v2/blob/main/CONTRIBUTING.md

package/index.d.ts

@@ -8,14 +8,14 @@ import type {
 /**
  * HL7v2 Delimiters type
  */
-export type Delimiters = {
+export interface Delimiters {
   field: string;
   component: string;
   subcomponent: string;
   repetition: string;
   escape: string;
   segment: string;
-};
+}
 
 // ## Abstract nodes
 
@@ -125,28 +125,16 @@ export type RootContent = RootContentMap[keyof RootContentMap];
  * > **Note**: {@link Root} does not need to be an entire document.
  * > it can also be a fragment.
  *
- * This interface can be augmented to register custom node types:
- *
- * ```ts
- * declare module 'mdast' {
- *   interface RootContentMap {
- *     // Allow using toml nodes defined by `remark-frontmatter`.
- *     toml: TOML;
- *   }
- * }
- * ```
- *
  * For a union of all {@link Root} children, see {@link RootContent}.
  */
-export type RootContentMap = {
-  segmentHeader: SegmentHeader;
+export interface RootContentMap {
   segment: Segment;
   group: Group;
   field: Field;
   fieldRepetition: FieldRepetition;
   component: Component;
   subcomponent: Subcomponent;
-};
+}
 
 // ## Concrete nodes
 
@@ -182,11 +170,13 @@ export interface Segment extends Parent {
    */
   type: "segment";
   /**
-   * Children of segment.
-   *
-   * `children[0]` is always a {@link SegmentHeader}.
+   * Name identifier for the segment (e.g., "MSH", "PID").
    */
-  children: [SegmentHeader, ...Field[]];
+  name: string;
+  /**
+   * Children of segment — only {@link Field} nodes.
+   */
+  children: Field[];
   /**
    * Data associated with the segment.
    */
@@ -198,20 +188,6 @@ export interface Segment extends Parent {
  */
 export interface SegmentData extends Data {}
 
-/**
- * HL7v2 segment header literal.
- *
- * This node always appears as the first child of a {@link Segment}. Consumers
- * should treat `segment.children[0]` as the canonical location of the
- * three-character HL7 identifier (for example, "MSH" or "PID").
- */
-export interface SegmentHeader extends Literal {
-  /**
-   * Node type of HL7v2 segment header.
-   */
-  type: "segment-header";
-}
-
 /**
  * HL7v2 group.
  *
@@ -230,11 +206,11 @@ export interface Group extends Parent {
    * Name identifier for the group (e.g., "ORDER", "OBSERVATION").
    * Used for querying specific groups in nested structures.
    */
-  name?: string | undefined;
+  name: string;
   /**
    * Children of group.
    */
-  children: Array<Segment | Group>;
+  children: (Segment | Group)[];
   /**
    * Data associated with the mdast block quote.
    */

package/package.json

@@ -1,20 +1,32 @@
 {
   "name": "@rethinkhealth/hl7v2-ast",
+  "version": "0.5.0",
   "description": "HL7v2 is a specification for representing HL7v2 messages as an abstract syntax tree. It implements the unist spec.",
-  "version": "0.4.2",
+  "keywords": [
+    "bin",
+    "cli",
+    "hl7v2",
+    "hl7v2ast",
+    "unified"
+  ],
+  "homepage": "https://www.rethinkhealth.io/hl7v2/docs",
   "license": "MIT",
   "author": {
     "name": "Melek Somai",
     "email": "melek@rethinkhealth.io"
   },
-  "type": "module",
+  "repository": "rethinkhealth/hl7v2.git",
   "files": [
     "index.d.ts"
   ],
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
   "devDependencies": {
     "@types/node": "24.10.1",
     "@types/unist": "^3.0.3",
-    "@vitest/coverage-v8": "4.0.14",
+    "@vitest/coverage-v8": "4.0.18",
     "tsup": "8.5.1",
     "typescript": "^5.9.3",
     "unified": "^11.0.5",
@@ -25,19 +37,7 @@
   "engines": {
     "node": ">=18"
   },
-  "repository": "rethinkhealth/hl7v2.git",
-  "homepage": "https://www.rethinkhealth.io/hl7v2/docs",
-  "keywords": [
-    "bin",
-    "cli",
-    "hl7v2",
-    "hl7v2ast",
-    "unified"
-  ],
   "packageManager": "pnpm@10.14.0",
-  "publishConfig": {
-    "access": "public"
-  },
   "scripts": {
     "check-types": "tsc ./index.d.ts --noEmit"
   }