@glion/jsonify 0.15.0 → 0.15.2

package/README.md

@@ -1,44 +1,27 @@
 # @glion/jsonify
 
-**[unified](https://unifiedjs.com/)** plugin to transform HL7v2 message ASTs into a simplified JSON representation.
+Serialize an HL7v2 AST into a compact, structured JSON document.
 
-## What is this?
+## What it does
 
-`@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.
+`@glion/jsonify` takes an HL7v2 AST — typically produced by `@glion/parser` — and emits a JSON representation that strips `unist` metadata (position, raw, type discriminators) and keeps only the meaningful HL7v2 shape: segment names, field indexes, values, and children. The result is a clean payload for downstream APIs, message queues, and analytics stores that want structured HL7v2 without the parser's internal tree representation.
 
 ## 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
+```bash
 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";
+```ts
+import { hl7v2Parser } from "@glion/parser";
 import { hl7v2Jsonify } from "@glion/jsonify";
+import { unified } from "unified";
 
 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);
+const file = await unified().use(hl7v2Parser).use(hl7v2Jsonify).process(msg);
 
 console.log(String(file));
 ```
@@ -54,8 +37,7 @@ Yields:
       "name": "MSH",
       "children": [
         { "type": "Field", "name": "MSH-1", "value": "|" },
-        { "type": "Field", "name": "MSH-2", "value": "^~\\&" },
-        ...
+        { "type": "Field", "name": "MSH-2", "value": "^~\\&" }
       ]
     },
     {
@@ -74,55 +56,28 @@ Yields:
 
 ### `unified().use(hl7v2Jsonify)`
 
-Transform an HL7v2 AST into JSON.
+Register the plugin as the compiler of a `unified` processor. The processor's `process()` call returns a file whose stringified contents is the JSON document. No options.
 
-###### Parameters
+## JSON shape
 
-There are no options.
-
-###### Returns
-
-Nothing (`undefined`). The unified compiler returns a stringified JSON document.
-
-## JSON Schema
-
-The output JSON has the following shape:
+Every node in the output has the following shape:
 
 ```ts
 interface HL7v2JsonNode {
-  type: string;
-  name?: string;
-  index?: number;
-  value?: string;
-  delimiter?: string;
-  children?: HL7v2JsonNode[];
+  type: string; // "Message", "Segment", "Field", "Component", ...
+  name?: string; // segment name (e.g. "MSH") or field id (e.g. "PID-3")
+  index?: number; // positional index where relevant
+  value?: string; // leaf value for Field / Component / Subcomponent
+  delimiter?: string; // delimiter character when it is meaningful to preserve
+  children?: HL7v2JsonNode[]; // recursive shape for composite nodes
 }
 ```
 
-## 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
+Only the fields relevant to a given node appear in the output — `Field` nodes carry `name` and `value`, composite nodes carry `name` and `children`, and so on.
 
-Copyright 2025 Rethink Health, SUARL. All rights reserved.
+## Part of Glion
 
-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.
+`@glion/jsonify` is part of **[Glion]**, the application framework for HL7v2. See the [Glion README] for the full package catalog and architecture.
 
-[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
+[Glion]: https://github.com/rethinkhealth/glion#readme
+[Glion README]: https://github.com/rethinkhealth/glion#readme

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glion/jsonify",
-  "version": "0.15.0",
+  "version": "0.15.2",
   "description": "hl7v2 plugin to transform hl7v2 messages to a simplified JSON representation",
   "keywords": [
     "health",
@@ -16,7 +16,11 @@
     "name": "Melek Somai",
     "email": "melek@rethinkhealth.io"
   },
-  "repository": "rethinkhealth/glion.git",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rethinkhealth/glion.git",
+    "directory": "packages/jsonify"
+  },
   "files": [
     "dist"
   ],
@@ -30,18 +34,20 @@
   },
   "dependencies": {
     "unified": "11.0.5",
-    "@glion/ast": "0.15.0"
+    "@glion/ast": "0.15.2"
   },
   "devDependencies": {
     "@types/node": "^25.5.0",
     "@types/unist": "^3.0.3",
     "@vitest/coverage-v8": "4.1.2",
+    "publint": "0.3.18",
     "tsdown": "0.21.7",
     "typescript": "^5.9.3",
     "vitest": "4.1.2",
-    "@glion/builder": "0.15.0",
-    "@glion/testing": "0.15.0",
-    "@glion/tsconfig": "0.15.0"
+    "@glion/check-readme": "0.15.2",
+    "@glion/tsconfig": "0.15.2",
+    "@glion/builder": "0.15.2",
+    "@glion/testing": "0.15.2"
   },
   "engines": {
     "node": ">=18"
@@ -50,8 +56,10 @@
   "scripts": {
     "build": "tsdown && tsc --emitDeclarationOnly",
     "check-types": "tsc --noEmit",
+    "check:readme": "glion-check-readme",
     "test": "vitest run",
     "test:coverage": "vitest run --coverage",
-    "test:watch": "vitest"
+    "test:watch": "vitest",
+    "publint": "publint --strict"
   }
 }