babelfhir-ts 1.0.30 → 1.0.32

package/README.md

@@ -58,7 +58,7 @@ Download and process a package directly from a registry (defaults to `https://pa
 babelfhir-ts --package hl7.fhir.us.core@8.0.0
 ```
 
-Download, pocess and install a processed package into your current project:
+Download, process and install a processed package into your current project:
 
 ```bash
 babelfhir-ts install hl7.fhir.us.core@8.0.0
@@ -132,7 +132,7 @@ babelfhir-ts [options] [<input> [output]]
 
 - **Directory** – scan all `.tgz`, `.zip`, or `.json` files inside the folder
 - **Archive** – process a FHIR NPM package in `.tgz` or `.zip` format
-- **StructureDefinition JSON** – generate code for a single profile definitio
+- **StructureDefinition JSON** – generate code for a single profile definition
 
 ## Scripts for contributors
 
@@ -141,7 +141,7 @@ babelfhir-ts [options] [<input> [output]]
 | `npm run generate`           | Execute the CLI against the local `input/` folder and refresh `output/`. |
 | `npm run generate:check`     | End-to-end check: generate, type-check, and lint the emitted output.         |
 | `npm test`                   | Type-check and run all Vitest suites (coverage enabled).                     |
-| `npm run download-validator` | Fetch the official HL7 validation jar used for parity testing.               |
+| `npm test validatorParity`   | Run validator parity tests against Firely .NET SDK validator.                |
 
 ## Caching notes
 
@@ -165,12 +165,21 @@ BabelFHIR-TS is a code generation tool that parses FHIR StructureDefinitions and
 
 ### Validation Scope
 
-- **High-level checks only**: The generated `validate()` functions execute FHIRPath expressions from profile invariants but do **not** perform:
-  - Terminology expansion or ValueSet validation
-  - Reference resolution (checking that referenced resources exist)
-  - Full cardinality enforcement for complex slicing scenarios
-  - Server-side business logic or workflow rules
-- **Use the official validator**: For production conformance testing, use the [HL7 FHIR Validator](https://github.com/hapifhir/org.hl7.fhir.core) alongside BabelFHIR-TS.
+The generated `validate()` methods DO check:
+- **FHIRPath constraints** from StructureDefinition invariants
+- **Cardinality rules** (min/max occurrences)
+- **Required fields** from profiles
+- **Pattern constraints** (patternCodeableConcept, patternCoding)
+- **Slice validation** for common patterns (coding arrays, BackboneElement slices)
+- **Data type correctness** (string, number, boolean, etc.)
+
+The generated validators DO NOT check:
+- **Terminology validation** (ValueSet expansion, code system membership) - requires terminology server
+- **Reference resolution** (checking that referenced resources exist) - requires FHIR server
+- **Complex discriminator types** (type, profile, exists, position) - only pattern/value discriminators supported
+- **Cross-resource business rules** - application-specific logic
+
+For comprehensive conformance testing, use the official [HL7 FHIR Validator](https://confluence.hl7.org/display/FHIR/Using+the+FHIR+Validator) or [Firely .NET SDK](https://fire.ly/products/firely-net-sdk/).
 
 ### TypeScript Limitations
 
@@ -188,7 +197,7 @@ BabelFHIR-TS is a code generation tool that parses FHIR StructureDefinitions and
   
   Use `random()` for development, testing, and prototyping, but always validate production data on the FHIR server side.
 
-- **`validate()` parity**: The generated validation methods execute FHIRPath expressions and check constraints from StructureDefinitions, but are **only guaranteed to match** the Firely .NET SDK validator for scenarios covered by our test suite (see GitHub actions). Edge cases, complex slicing patterns, or profiles not in our test pipeline may produce different results. For production conformance testing, use the [HL7 FHIR Validator](https://github.com/hapifhir/org.hl7.fhir.core) or [Firely .NET SDK](https://fire.ly/products/firely-net-sdk/) as the source of truth.
+- **`validate()` parity**: The generated validation methods execute FHIRPath expressions and check constraints from StructureDefinitions, but are **only guaranteed to match** the Firely .NET SDK validator for scenarios covered by our test suite (see GitHub actions). Edge cases, complex slicing patterns, or profiles not in our test pipeline may produce different results. For production conformance testing, use the official [HL7 FHIR Validator](https://confluence.hl7.org/display/FHIR/Using+the+FHIR+Validator) or [Firely .NET SDK](https://fire.ly/products/firely-net-sdk/) as the source of truth.
 
 ### FHIR Version Support
 

package/out/generator/index.js

@@ -7,7 +7,6 @@ import { extractPackage, readStructureDefinitionsFromDir, createPackageFromDir,
 import { fetchStructureDefinitions, parseStructureDefinition, fetchStructureDefinition, registerLocalStructureDefinitions, buildFhirChildTypeMap } from './sdParser.js';
 import { writeInterfaceAndValidatorToFile, mergeFields, alignFields, ensureDirectoryExists, writeToFile, getBaseResource, downloadFile, sanitizeIdentifier, toPascalCase } from './utils.js';
 import { generateValidateProfileFunction } from './validatorGenerator.js';
-import { loadExamplesFromPackage, generateTestFile } from './testGenerator.js';
 import { generateValueSetTypeScript, generateValueSetRegistry } from './valueSetGenerator.js';
 import { generateRandomSupportContent } from './randomSupportGenerator.js';
 import { logger } from '../logger.js';
@@ -177,7 +176,7 @@ async function generateIndexFile(dir) {
 }
 // Reusable processor for a single StructureDefinition
 async function processStructureDefinition(sd, ctx) {
-    const { outputDir, fhirSourceHint, valueSetCodesMap, valueSets, examplesMap, existingStructureDefinitions, profileIdToName, profileUrlToName, flags, fhirChildTypeMap } = ctx;
+    const { outputDir, fhirSourceHint, valueSetCodesMap, valueSets, existingStructureDefinitions, profileIdToName, profileUrlToName, flags, fhirChildTypeMap } = ctx;
     const rawInterfaceName = sd.name || sd.id || 'UnnamedInterface';
     let interfaceName = toPascalCase(rawInterfaceName);
     // Check if the interface name conflicts with a FHIR base type
@@ -234,7 +233,7 @@ async function processStructureDefinition(sd, ctx) {
         if (externalSD) {
             try {
                 logger.log(`Processing external profile as StructureDefinition: ${normalizedTypeName}`);
-                const actualInterfaceName = await processStructureDefinition(externalSD, { outputDir, fhirSourceHint: profileInfo.profileUrl, valueSetCodesMap, valueSets, examplesMap, existingStructureDefinitions, profileIdToName, profileUrlToName, flags, fhirChildTypeMap });
+                const actualInterfaceName = await processStructureDefinition(externalSD, { outputDir, fhirSourceHint: profileInfo.profileUrl, valueSetCodesMap, valueSets, existingStructureDefinitions, profileIdToName, profileUrlToName, flags, fhirChildTypeMap });
                 // If the actual generated interface name differs from what we expected,
                 // add a mapping so other profiles can find it
                 if (actualInterfaceName !== normalizedTypeName) {
@@ -402,10 +401,6 @@ async function processStructureDefinition(sd, ctx) {
     // Only generate class files if --no-classes flag is not set
     if (!flags?.noClasses) {
         writeToFile(path.join(outputDir, `${interfaceName}Class.ts`), classContent);
-        if (examplesMap && examplesMap[interfaceName]) {
-            const { valid, invalid } = examplesMap[interfaceName];
-            generateTestFile(outputDir, interfaceName, valid, invalid);
-        }
     }
     console.log(`Generated artifacts for ${interfaceName}`);
     return interfaceName;
@@ -482,9 +477,8 @@ export async function generate(fhirSource, outputDir, flags) {
         }
     }
     logger.log(`Profile registries pre-populated: ${profileUrlToName.size} URLs, ${profileIdToName.size} IDs`);
-    const examples = loadExamplesFromPackage(fhirSource);
     for (const sd of structureDefinitions) {
-        await processStructureDefinition(sd, { outputDir, fhirSourceHint: fhirSource, valueSetCodesMap, valueSets, examplesMap: examples, existingStructureDefinitions, profileIdToName, profileUrlToName, flags, fhirChildTypeMap });
+        await processStructureDefinition(sd, { outputDir, fhirSourceHint: fhirSource, valueSetCodesMap, valueSets, existingStructureDefinitions, profileIdToName, profileUrlToName, flags, fhirChildTypeMap });
     }
 }
 /**
@@ -585,9 +579,8 @@ export async function generateIntoPackage(packageArchivePath, outArchivePath, fl
         logger.log(`Profile registries pre-populated: ${profileUrlToName.size} URLs, ${profileIdToName.size} IDs`);
         // Register all local StructureDefinitions for resolution before HTTP fetches
         registerLocalStructureDefinitions(structureDefinitions);
-        const examples = loadExamplesFromPackage(extractedRoot);
         for (const sd of structureDefinitions) {
-            await processStructureDefinition(sd, { outputDir, fhirSourceHint: '', valueSetCodesMap, valueSets, examplesMap: examples, existingStructureDefinitions, profileIdToName, profileUrlToName, flags });
+            await processStructureDefinition(sd, { outputDir, fhirSourceHint: '', valueSetCodesMap, valueSets, existingStructureDefinitions, profileIdToName, profileUrlToName, flags });
         }
         // Create package.json in generated folder
         const originalPackageJsonPath = path.join(extractedRoot, 'package', 'package.json');
@@ -637,6 +630,10 @@ export async function generateIntoPackage(packageArchivePath, outArchivePath, fl
         // Compile TypeScript to JavaScript
         logger.log('Compiling TypeScript to JavaScript...');
         await compileTypeScriptToJS(outputDir);
+        // Copy package.json to root of extractedRoot so it's at the tarball root
+        const rootPackageJsonPath = path.join(extractedRoot, 'package.json');
+        fs.copyFileSync(generatedPackageJsonPath, rootPackageJsonPath);
+        logger.log('Copied package.json to tarball root');
         const finalArchive = outArchivePath || deriveOutputArchiveName(packageArchivePath);
         await createPackageFromDir(extractedRoot, finalArchive);
         return finalArchive;

package/out/generator/validatorGenerator.js

@@ -674,10 +674,10 @@ export function generateValidateProfileFunction(interfaceName, fields // Array o
     // Only import fhirpath and run evaluation logic when there are constraints.
     if (!hasConstraints) {
         return `
-export async function validate${interfaceName}(resource: ${interfaceName}): Promise<{ errors: string[], warnings: string[] }> {\n  // Touch the parameter so eslint no-unused-vars doesn't flag it when there are no constraints.\n  void resource;\n  return { errors: [], warnings: [] };\n}`;
+export async function validate${interfaceName}(resource: ${interfaceName}): Promise<{ errors: string[]; warnings: string[] }> {\n  // Touch the parameter so eslint no-unused-vars doesn't flag it when there are no constraints.\n  void resource;\n  return { errors: [], warnings: [] };\n}`;
     }
-    const fhirpathImport = filteredConstraints.length > 0 ? 'import fhirpath from "fhirpath";\nimport fhirpath_r4_model from "fhirpath/fhir-context/r4";\n\n' : '';
-    return `${fhirpathImport}export async function validate${interfaceName}(resource: ${interfaceName}): Promise<{ errors: string[], warnings: string[] }> {
+    const fhirpathImport = filteredConstraints.length > 0 ? 'import fhirpath from "fhirpath";\nimport fhirpath_r4_model from "fhirpath/fhir-context/r4/index.js";\n\n' : '';
+    return `${fhirpathImport}export async function validate${interfaceName}(resource: ${interfaceName}): Promise<{ errors: string[]; warnings: string[] }> {
   const errors: string[] = [];
   const warnings: string[] = [];
   ${validationLogic}${patternValidations.join('')}${fixedValueValidations.join('')}${sliceValidations.join('')}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "babelfhir-ts",
-  "version": "1.0.30",
+  "version": "1.0.32",
   "description": "BabelFHIR-TS: generate TypeScript interfaces, validators, and helper classes from FHIR R4 StructureDefinitions (profiles) directly inside package archives.",
   "type": "module",
   "main": "out/main.js",
@@ -31,7 +31,6 @@
     "generate": "tsx src/main.ts",
     "generate:check": "npm run generate && npm run typecheck && npm run typecheck:output && npm run lint:output",
     "generate:fhir-module": "node scripts/generate-fhir-r4-module.js",
-    "download-validator": "tsx scripts/download-validator.ts",
     "prepublishOnly": "npm run build"
   },
   "keywords": [
@@ -50,12 +49,12 @@
   "license": "ISC",
   "repository": {
     "type": "git",
-    "url": "https://github.com/quotentiroler/BabelFHIR-ts.git"
+    "url": "https://github.com/quotentiroler/BabelFHIR-TS.git"
   },
   "bugs": {
-    "url": "https://github.com/quotentiroler/BabelFHIR-ts/issues"
+    "url": "https://github.com/quotentiroler/BabelFHIR-TS/issues"
   },
-  "homepage": "https://github.com/quotentiroler/BabelFHIR-ts#readme",
+  "homepage": "https://github.com/quotentiroler/BabelFHIR-TS#readme",
   "engines": {
     "node": ">=18.0.0",
     "npm": ">=9.0.0"

package/out/generator/testGenerator.js

@@ -1,71 +0,0 @@
-import path from "path";
-import fs from "fs";
-import { logger } from "../logger.js";
-export function loadExamplesFromPackage(packagePath) {
-    const examplesDir = path.join(packagePath, "examples");
-    const resourceMap = {};
-    if (!fs.existsSync(examplesDir)) {
-        console.warn(`No examples directory found in package: ${examplesDir}`);
-        return resourceMap;
-    }
-    const files = fs.readdirSync(examplesDir);
-    files.forEach((file) => {
-        const match = file.match(/^(Example|Invalid)(\w+)\.json$/);
-        if (match) {
-            const [, type, resourceName] = match;
-            if (!resourceMap[resourceName]) {
-                resourceMap[resourceName] = { valid: [], invalid: [] };
-            }
-            if (type === "Example") {
-                resourceMap[resourceName].valid.push(path.join(examplesDir, file));
-            }
-            else if (type === "Invalid") {
-                resourceMap[resourceName].invalid.push(path.join(examplesDir, file));
-            }
-        }
-    });
-    return resourceMap;
-}
-export function generateTestFile(outputDir, resourceName, validExamples, invalidExamples) {
-    const className = `${resourceName}Class`;
-    const testFileName = `${resourceName}.test.ts`;
-    const testFilePath = path.join(outputDir, testFileName);
-    const testContent = `
-import { describe, it, expect } from "vitest";
-import { ${className} } from "../../generated/${className}";
-import fs from "fs";
-import path from "path";
-
-function loadExample(filePath: string) {
-    const fileContent = fs.readFileSync(filePath, "utf-8");
-    return JSON.parse(fileContent);
-}
-
-describe("${className} Validation", () => {
-    ${validExamples
-        .map((examplePath) => `
-    it("should validate ${path.basename(examplePath)} without errors", async () => {
-        const resource = loadExample("${examplePath.replace(/\\/g, "/")}");
-        const instance = new ${className}(resource);
-        const errors = await instance.validate();
-        expect(errors.errors).toEqual([]);
-    });
-    `)
-        .join("\n")}
-
-    ${invalidExamples
-        .map((examplePath) => `
-    it("should validate ${path.basename(examplePath)} with errors", async () => {
-        const resource = loadExample("${examplePath.replace(/\\/g, "/")}");
-        const instance = new ${className}(resource);
-        const { errors } = await instance.validate();
-        expect(errors.length).toBeGreaterThan(0);
-    });
-    `)
-        .join("\n")}
-
-});
-`;
-    fs.writeFileSync(testFilePath, testContent);
-    logger.log(`Generated test file: ${testFilePath}`);
-}