@rethinkhealth/hl7v2-ast 0.1.0

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/index.d.ts

@@ -0,0 +1,57 @@
+import type { Node, Position } from 'unist';
+
+/**
+ * HL7v2 Node specification following the Unist spec
+ *
+ * @see https://github.com/syntax-tree/unist#node
+ */
+export interface HL7v2Node extends Node {
+  /**
+   * The type of the node.
+   */
+  type:
+    | 'message'
+    | 'segment'
+    | 'header'
+    | 'field'
+    | 'component'
+    | 'subcomponent';
+
+  /**
+   * The name of the node (e.g. "PID", "MSH", "EVN", etc.)
+   */
+  name?: string;
+
+  /**
+   * The index of the node in the parent.
+   *
+   * This is valuable in HL7v2 where fields and components' order is
+   * relevant.
+   */
+  index?: number;
+
+  /**
+   * The value of the node. This is the raw value of the node.
+   *
+   * TODO: We might consider removing this property and use the children
+   * property instead.
+   */
+  value?: string;
+
+  /**
+   * The delimiter of the node.
+   */
+  delimiter?: string;
+
+  /**
+   * The children of the node.
+   */
+  children?: HL7v2Node[];
+
+  /**
+   * The position of the node in the source text.
+   *
+   * This is used for round-tripping the AST back to the original text.
+   */
+  position?: Position;
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@rethinkhealth/hl7v2-ast",
+  "description": "HL7v2 is a specification for representing HL7v2 messages as an abstract syntax tree. It implements the unist spec.",
+  "version": "0.1.0",
+  "license": "MIT",
+  "author": {
+    "name": "Melek Somai",
+    "email": "melek@rethinkhealth.io"
+  },
+  "type": "module",
+  "files": [
+    "index.d.ts"
+  ],
+  "dependencies": {
+    "@types/unist": "3.0.3"
+  },
+  "devDependencies": {
+    "@types/node": "22.15.31",
+    "typescript": "^5.8.3",
+    "@rethinkhealth/tsconfig": "0.0.0"
+  },
+  "repository": "rethinkhealth/hl7v2.git",
+  "homepage": "https://www.rethinkhealth.io/hl7v2/docs",
+  "keywords": [
+    "bin",
+    "cli",
+    "hl7v2",
+    "hl7v2ast",
+    "unified"
+  ],
+  "packageManager": "pnpm@10.12.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "check-types": "tsc --noEmit"
+  }
+}