@glion/jsonify 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/README.md

@@ -0,0 +1,128 @@
+# @glion/jsonify
+
+**[unified](https://unifiedjs.com/)** plugin to transform HL7v2 message ASTs into a simplified JSON representation.
+
+## What is this?
+
+`@glion/jsonify` is a [unified](https://unifiedjs.com/) plugin that takes an HL7v2 syntax tree (produced by a parser such as [`@glion/ast`][https://github.com/rethinkhealth/glion/tree/main/packages/hl7v2-parser]) and compiles it to a clean, structured JSON format.
+
+It strips away [unist](https://github.com/syntax-tree/unist) metadata and preserves only meaningful HL7v2 properties such as segment type, field indexes, and values.
+
+## When should I use this?
+
+Use this plugin when you need:
+
+- A minimal JSON representation of HL7v2 messages for downstream processing.
+- To serialize HL7v2 ASTs into a format suitable for APIs or storage.
+
+If you need to parse raw HL7v2 messages first, use [`@glion/ast`](https://github.com/rethinkhealth/glion/tree/main/packages/hl7v2-parser) before applying this plugin.
+
+## Install
+
+This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
+
+In Node.js (version 16+), install with [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm):
+
+```sh
+npm install @glion/jsonify
+```
+
+## Use
+
+Say we have an HL7v2 message and want to convert it to JSON:
+
+```js
+import { unified } from "unified";
+import { hl7v2Parse } from "@glion/ast";
+import { hl7v2Jsonify } from "@glion/jsonify";
+
+const msg = `MSH|^~\\&|HIS|RIH|EKG|EKG|200202150930||ADT^A01|MSG00001|P|2.4\rPID|||555-44-4444||DOE^JOHN`;
+
+const file = await unified().use(hl7v2Parse).use(hl7v2Jsonify).process(msg);
+
+console.log(String(file));
+```
+
+Yields:
+
+```json
+{
+  "type": "Message",
+  "children": [
+    {
+      "type": "Segment",
+      "name": "MSH",
+      "children": [
+        { "type": "Field", "name": "MSH-1", "value": "|" },
+        { "type": "Field", "name": "MSH-2", "value": "^~\\&" },
+        ...
+      ]
+    },
+    {
+      "type": "Segment",
+      "name": "PID",
+      "children": [
+        { "type": "Field", "name": "PID-3", "value": "555-44-4444" },
+        { "type": "Field", "name": "PID-5", "value": "DOE^JOHN" }
+      ]
+    }
+  ]
+}
+```
+
+## API
+
+### `unified().use(hl7v2Jsonify)`
+
+Transform an HL7v2 AST into JSON.
+
+###### Parameters
+
+There are no options.
+
+###### Returns
+
+Nothing (`undefined`). The unified compiler returns a stringified JSON document.
+
+## JSON Schema
+
+The output JSON has the following shape:
+
+```ts
+interface HL7v2JsonNode {
+  type: string;
+  name?: string;
+  index?: number;
+  value?: string;
+  delimiter?: string;
+  children?: HL7v2JsonNode[];
+}
+```
+
+## Security
+
+This plugin only transforms AST nodes and does not execute code. Ensure you trust the source of HL7v2 messages before processing.
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide][github-contributing] for more details.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Code of Conduct
+
+To ensure a welcoming and positive environment, we have a [Code of Conduct][github-code-of-conduct] that all contributors and participants are expected to adhere to.
+
+## License
+
+Copyright 2025 Rethink Health, SUARL. All rights reserved.
+
+This program is licensed to you under the terms of the [MIT License](https://opensource.org/licenses/MIT). This program is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [LICENSE][github-license] file for details.
+
+[github-code-of-conduct]: https://github.com/rethinkhealth/glion/blob/main/CODE_OF_CONDUCT.md
+[github-license]: https://github.com/rethinkhealth/glion/blob/main/LICENSE
+[github-contributing]: https://github.com/rethinkhealth/glion/blob/main/CONTRIBUTING.md

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { hl7v2Jsonify } from "./processor";
+export { toJsonRuntime } from "./runtime";
+export type { FieldJson, GroupJson, Hl7v2JsonResult, SegmentJson, } from "./types";
+//# 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":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,YAAY,EACV,SAAS,EACT,SAAS,EACT,eAAe,EACf,WAAW,GACZ,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,62 @@
+//#region src/runtime.ts
+function toJsonRuntime(root) {
+	const r = root;
+	const out = [];
+	for (const child of r.children) if (child.type === "segment") out.push(processSegment(child));
+	else if (child.type === "group") out.push(processGroup(child));
+	return out;
+}
+function processSegment(segment) {
+	const fields = [];
+	for (const f of segment.children) fields.push(materializeField(f));
+	return {
+		fields,
+		segment: segment.name
+	};
+}
+function processGroup(group) {
+	const children = [];
+	for (const child of group.children) if (child.type === "segment") children.push(processSegment(child));
+	else if (child.type === "group") children.push(processGroup(child));
+	return {
+		children,
+		group: group.name ?? ""
+	};
+}
+function materializeField(field) {
+	const toComponent = (c) => {
+		if (c.children?.length === 0) return "";
+		if (c.children?.length === 1) return c.children[0].value;
+		return c.children ? c.children.map((sc) => sc.value) : [];
+	};
+	const toRepetitionArray = (r) => r.children.map((c) => toComponent(c));
+	const repetitions = field.children;
+	if (repetitions.length === 1) {
+		const rep = repetitions[0];
+		if (!rep) throw new Error("Expected a field repetition");
+		if (rep.children.length === 1) {
+			const comp = rep.children[0];
+			const compVal = toComponent(comp);
+			return Array.isArray(compVal) ? [compVal] : compVal;
+		}
+		return toRepetitionArray(rep);
+	}
+	return repetitions.map((r) => {
+		const rep = r;
+		if (rep.children.length === 1) return toComponent(rep.children[0]);
+		return toRepetitionArray(rep);
+	});
+}
+//#endregion
+//#region src/processor.ts
+function hl7v2Jsonify() {
+	const self = this;
+	function compiler(tree) {
+		return toJsonRuntime(tree);
+	}
+	self.compiler = compiler;
+}
+//#endregion
+export { hl7v2Jsonify, toJsonRuntime };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/runtime.ts","../src/processor.ts"],"sourcesContent":["import type {\n  Component,\n  Field,\n  FieldRepetition,\n  Group,\n  Nodes,\n  Root,\n  Segment,\n  Subcomponent,\n} from \"@glion/ast\";\n\nimport type {\n  FieldJson,\n  GroupJson,\n  Hl7v2JsonResult,\n  SegmentJson,\n} from \"./types\";\n\nexport function toJsonRuntime(root: Nodes): Hl7v2JsonResult {\n  const r = root as Root;\n  const out: Hl7v2JsonResult = [];\n\n  for (const child of r.children) {\n    if (child.type === \"segment\") {\n      out.push(processSegment(child as Segment));\n    } else if (child.type === \"group\") {\n      out.push(processGroup(child as Group));\n    }\n  }\n\n  return out;\n}\n\nfunction processSegment(segment: Segment): SegmentJson {\n  const fields: (FieldJson | FieldJson[])[] = [];\n\n  for (const f of segment.children) {\n    fields.push(materializeField(f));\n  }\n\n  return { fields, segment: segment.name };\n}\n\nfunction processGroup(group: Group): GroupJson {\n  const children: (SegmentJson | GroupJson)[] = [];\n\n  for (const child of group.children) {\n    if (child.type === \"segment\") {\n      children.push(processSegment(child as Segment));\n    } else if (child.type === \"group\") {\n      children.push(processGroup(child as Group));\n    }\n  }\n\n  return { children, group: group.name ?? \"\" };\n}\n\n// Convert a Field into JSON-friendly value: string or nested arrays representing reps/components/subcomponents\nfunction materializeField(field: Field): FieldJson | FieldJson[] {\n  const toComponent = (c: Component): FieldJson => {\n    if (c.children?.length === 0) {\n      return \"\";\n    }\n    if (c.children?.length === 1) {\n      return (c.children[0] as Subcomponent).value;\n    }\n    return c.children ? c.children.map((sc) => (sc as Subcomponent).value) : [];\n  };\n\n  const toRepetitionArray = (r: FieldRepetition): FieldJson[] =>\n    r.children.map((c) => toComponent(c as Component));\n\n  const repetitions = field.children as FieldRepetition[];\n\n  if (repetitions.length === 1) {\n    const rep = repetitions[0];\n\n    if (!rep) {\n      throw new Error(\"Expected a field repetition\");\n    }\n\n    if (rep.children.length === 1) {\n      const comp = rep.children[0] as Component;\n      const compVal = toComponent(comp);\n\n      return Array.isArray(compVal) ? [compVal] : compVal;\n    }\n    return toRepetitionArray(rep);\n  }\n\n  // Multiple repetitions: project each repetition to a value (string or array)\n  return repetitions.map((r) => {\n    const rep = r as FieldRepetition;\n    if (rep.children.length === 1) {\n      return toComponent(rep.children[0] as Component);\n    }\n    return toRepetitionArray(rep);\n  }) as string[];\n}\n","import type { Node, Nodes, Root } from \"@glion/ast\";\nimport type { Processor } from \"unified\";\n\nimport { toJsonRuntime } from \"./runtime\";\nimport type { Hl7v2JsonResult } from \"./types\";\n\nexport function hl7v2Jsonify(this: Processor) {\n  const self = this as unknown as Processor<\n    Node,\n    undefined,\n    undefined,\n    Root,\n    undefined\n  >;\n\n  function compiler(tree: Nodes): Hl7v2JsonResult {\n    return toJsonRuntime(tree);\n  }\n\n  self.compiler = compiler as unknown as typeof self.compiler;\n}\n"],"mappings":";AAkBA,SAAgB,cAAc,MAA8B;CAC1D,MAAM,IAAI;CACV,MAAM,MAAuB,EAAE;AAE/B,MAAK,MAAM,SAAS,EAAE,SACpB,KAAI,MAAM,SAAS,UACjB,KAAI,KAAK,eAAe,MAAiB,CAAC;UACjC,MAAM,SAAS,QACxB,KAAI,KAAK,aAAa,MAAe,CAAC;AAI1C,QAAO;;AAGT,SAAS,eAAe,SAA+B;CACrD,MAAM,SAAsC,EAAE;AAE9C,MAAK,MAAM,KAAK,QAAQ,SACtB,QAAO,KAAK,iBAAiB,EAAE,CAAC;AAGlC,QAAO;EAAE;EAAQ,SAAS,QAAQ;EAAM;;AAG1C,SAAS,aAAa,OAAyB;CAC7C,MAAM,WAAwC,EAAE;AAEhD,MAAK,MAAM,SAAS,MAAM,SACxB,KAAI,MAAM,SAAS,UACjB,UAAS,KAAK,eAAe,MAAiB,CAAC;UACtC,MAAM,SAAS,QACxB,UAAS,KAAK,aAAa,MAAe,CAAC;AAI/C,QAAO;EAAE;EAAU,OAAO,MAAM,QAAQ;EAAI;;AAI9C,SAAS,iBAAiB,OAAuC;CAC/D,MAAM,eAAe,MAA4B;AAC/C,MAAI,EAAE,UAAU,WAAW,EACzB,QAAO;AAET,MAAI,EAAE,UAAU,WAAW,EACzB,QAAQ,EAAE,SAAS,GAAoB;AAEzC,SAAO,EAAE,WAAW,EAAE,SAAS,KAAK,OAAQ,GAAoB,MAAM,GAAG,EAAE;;CAG7E,MAAM,qBAAqB,MACzB,EAAE,SAAS,KAAK,MAAM,YAAY,EAAe,CAAC;CAEpD,MAAM,cAAc,MAAM;AAE1B,KAAI,YAAY,WAAW,GAAG;EAC5B,MAAM,MAAM,YAAY;AAExB,MAAI,CAAC,IACH,OAAM,IAAI,MAAM,8BAA8B;AAGhD,MAAI,IAAI,SAAS,WAAW,GAAG;GAC7B,MAAM,OAAO,IAAI,SAAS;GAC1B,MAAM,UAAU,YAAY,KAAK;AAEjC,UAAO,MAAM,QAAQ,QAAQ,GAAG,CAAC,QAAQ,GAAG;;AAE9C,SAAO,kBAAkB,IAAI;;AAI/B,QAAO,YAAY,KAAK,MAAM;EAC5B,MAAM,MAAM;AACZ,MAAI,IAAI,SAAS,WAAW,EAC1B,QAAO,YAAY,IAAI,SAAS,GAAgB;AAElD,SAAO,kBAAkB,IAAI;GAC7B;;;;AC3FJ,SAAgB,eAA8B;CAC5C,MAAM,OAAO;CAQb,SAAS,SAAS,MAA8B;AAC9C,SAAO,cAAc,KAAK;;AAG5B,MAAK,WAAW"}

package/dist/processor.d.ts

@@ -0,0 +1,3 @@
+import type { Processor } from "unified";
+export declare function hl7v2Jsonify(this: Processor): void;
+//# sourceMappingURL=processor.d.ts.map

package/dist/processor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"processor.d.ts","sourceRoot":"","sources":["../src/processor.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAKzC,wBAAgB,YAAY,CAAC,IAAI,EAAE,SAAS,QAc3C"}

package/dist/runtime.d.ts

@@ -0,0 +1,4 @@
+import type { Nodes } from "@glion/ast";
+import type { Hl7v2JsonResult } from "./types";
+export declare function toJsonRuntime(root: Nodes): Hl7v2JsonResult;
+//# sourceMappingURL=runtime.d.ts.map

package/dist/runtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../src/runtime.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAKV,KAAK,EAIN,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EAGV,eAAe,EAEhB,MAAM,SAAS,CAAC;AAEjB,wBAAgB,aAAa,CAAC,IAAI,EAAE,KAAK,GAAG,eAAe,CAa1D"}

package/dist/types.d.ts

@@ -0,0 +1,11 @@
+export type FieldJson = string | string[];
+export interface SegmentJson {
+    segment: string;
+    fields: (FieldJson | FieldJson[])[];
+}
+export interface GroupJson {
+    group: string;
+    children: (SegmentJson | GroupJson)[];
+}
+export type Hl7v2JsonResult = (SegmentJson | GroupJson)[];
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAE1C,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,CAAC,SAAS,GAAG,SAAS,EAAE,CAAC,EAAE,CAAC;CACrC;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,CAAC,WAAW,GAAG,SAAS,CAAC,EAAE,CAAC;CACvC;AAED,MAAM,MAAM,eAAe,GAAG,CAAC,WAAW,GAAG,SAAS,CAAC,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@glion/jsonify",
+  "version": "0.14.1",
+  "description": "hl7v2 plugin to transform hl7v2 messages to a simplified JSON representation",
+  "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": "11.0.5",
+    "@glion/ast": "0.14.1"
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.0",
+    "@types/unist": "^3.0.3",
+    "@vitest/coverage-v8": "4.1.2",
+    "tsdown": "0.21.7",
+    "typescript": "^5.9.3",
+    "vitest": "4.1.2",
+    "@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",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "test:watch": "vitest"
+  }
+}