babelfhir-ts 1.4.1 → 1.4.2

package/out/src/generator/emitters/client/clientGenerator.js

@@ -5,6 +5,7 @@ import { logger } from "../../../logger.js";
 import { generateSmartAuth, generateSmartClient } from './smartAuthGenerator.js';
 import { generateReadme, installBaseClientTypes } from './clientReadmeGenerator.js';
 import { versionSlug } from '../../fhir/versionContext.js';
+import { buildSearchParamInterfaces, getSearchParamsTypeName } from './searchParamHelpers.js';
 const log = logger.withTag('client');
 /**
  * Generate FHIR client code for all resource types
@@ -26,14 +27,14 @@ export function generateClient(options) {
         fs.mkdirSync(clientDir, { recursive: true });
     }
     // Generate each file
-    generateTypes(clientDir, resourceTypes);
-    generateResourceReader(clientDir, resourceTypes);
+    generateTypes(clientDir, resourceTypes, options.searchParams);
+    generateResourceReader(clientDir, resourceTypes, options.searchParams);
     generateResourceWriter(clientDir, resourceTypes);
     generateBundleParser(clientDir, resourceTypes);
-    generateFhirClient(clientDir, resourceTypes);
+    generateFhirClient(clientDir, resourceTypes, options.searchParams);
     generateSmartAuth(clientDir);
     generateSmartClient(clientDir, resourceTypes);
-    generateIndex(clientDir, resourceTypes);
+    generateIndex(clientDir, resourceTypes, options.searchParams);
     generateReadme(clientDir);
     // Install base client type declarations so tsc can resolve @babelfhir-ts/client-<version>
     installBaseClientTypes(options.outputDir);
@@ -42,10 +43,12 @@ export function generateClient(options) {
 /**
  * Generate types.ts
  */
-function generateTypes(clientDir, resourceTypes) {
+function generateTypes(clientDir, resourceTypes, searchParams) {
     const unionType = resourceTypes
         .map((rt, idx) => `  ${idx === 0 ? "" : "| "}GeneratedTypes.${rt.profileName}`)
         .join("\n");
+    // Generate per-base-resource-type search param interfaces
+    const searchParamInterfaces = buildSearchParamInterfaces(resourceTypes, searchParams);
     const content = `import type * as GeneratedTypes from "../index.js";
 
 /**
@@ -54,9 +57,34 @@ function generateTypes(clientDir, resourceTypes) {
 export type WithId<T> = { id: string } & T;
 
 /**
- * Search parameters for FHIR resources
+ * Search parameter value type — all values are serialized to query strings.
  */
-export type SearchParams = Record<string, boolean | number | string | string[] | undefined>;
+export type SearchParamValue = boolean | number | string | string[] | undefined;
+
+/**
+ * Search parameters for FHIR resources (generic untyped version).
+ */
+export type SearchParams = Record<string, SearchParamValue>;
+
+/**
+ * Common search parameters supported by all FHIR resources.
+ * Includes an index signature to allow search parameter modifiers (e.g. name:exact).
+ */
+export interface CommonSearchParams {
+  _id?: SearchParamValue;
+  _lastUpdated?: SearchParamValue;
+  _tag?: SearchParamValue;
+  _profile?: SearchParamValue;
+  _security?: SearchParamValue;
+  _count?: SearchParamValue;
+  _sort?: SearchParamValue;
+  _include?: SearchParamValue;
+  _revinclude?: SearchParamValue;
+  _summary?: SearchParamValue;
+  _elements?: SearchParamValue;
+  _total?: SearchParamValue;
+  [key: string]: SearchParamValue;
+}
 
 /**
  * Bundle of FHIR resources
@@ -80,24 +108,34 @@ export interface Bundle<T> {
  */
 export type FhirResource =
 ${unionType};
-`;
+
+${searchParamInterfaces}`;
     fs.writeFileSync(path.join(clientDir, "types.ts"), content);
 }
 /**
  * Generate resource-reader.ts
  */
-function generateResourceReader(clientDir, resourceTypes) {
+function generateResourceReader(clientDir, resourceTypes, searchParams) {
+    // Build reader type aliases with typed search params
     const readerTypes = resourceTypes
-        .map((rt) => `export type ${rt.profileName}Reader = FhirResourceSearcher<GeneratedTypes.${rt.profileName}>;`)
+        .map((rt) => {
+        const spType = getSearchParamsTypeName(rt.baseResourceType, searchParams);
+        return `export type ${rt.profileName}Reader = FhirResourceSearcher<GeneratedTypes.${rt.profileName}, ${spType}>;`;
+    })
         .join("\n");
+    // Collect unique SearchParams type imports from types.ts
+    const spTypeImports = new Set(['SearchParams']);
+    for (const rt of resourceTypes) {
+        spTypeImports.add(getSearchParamsTypeName(rt.baseResourceType, searchParams));
+    }
     const content = `import type * as GeneratedTypes from "../index.js";
 
-import type { Bundle, SearchParams, WithId } from "./types.js";
+import type { Bundle, ${[...spTypeImports].sort().join(', ')}, WithId } from "./types.js";
 
 /**
  * Generic FHIR resource searcher/reader
  */
-export interface FhirResourceSearcher<T> {
+export interface FhirResourceSearcher<T, S extends SearchParams = SearchParams> {
   readonly baseUrl: string;
   readonly resourceType: string;
 
@@ -109,17 +147,17 @@ export interface FhirResourceSearcher<T> {
   /**
    * Search for resources
    */
-  search(params?: SearchParams): Promise<Bundle<WithId<T>>>;
+  search(params?: S): Promise<Bundle<WithId<T>>>;
 
   /**
    * Search and return first result or undefined
    */
-  searchOne(params?: SearchParams): Promise<undefined | WithId<T>>;
+  searchOne(params?: S): Promise<undefined | WithId<T>>;
 
   /**
    * Search and return all results (handles pagination)
    */
-  searchAll(params?: SearchParams): Promise<WithId<T>[]>;
+  searchAll(params?: S): Promise<WithId<T>[]>;
 }
 
 /**
@@ -135,7 +173,7 @@ export type FetchFn = typeof globalThis.fetch;
 /**
  * Implementation of FHIR resource reader
  */
-export class FhirResourceReader<T> implements FhirResourceSearcher<T> {
+export class FhirResourceReader<T, S extends SearchParams = SearchParams> implements FhirResourceSearcher<T, S> {
   private readonly fetchFn: FetchFn;
 
   constructor(
@@ -163,7 +201,7 @@ export class FhirResourceReader<T> implements FhirResourceSearcher<T> {
     return (await response.json()) as WithId<T>;
   }
 
-  async search(params?: SearchParams): Promise<Bundle<WithId<T>>> {
+  async search(params?: S): Promise<Bundle<WithId<T>>> {
     const url = new URL(\`\${this.baseUrl}/\${this.resourceType}\`);
 
     if (params) {
@@ -195,12 +233,12 @@ export class FhirResourceReader<T> implements FhirResourceSearcher<T> {
     return (await response.json()) as Bundle<WithId<T>>;
   }
 
-  async searchOne(params?: SearchParams): Promise<undefined | WithId<T>> {
-    const bundle = await this.search({ ...params, _count: 1 });
+  async searchOne(params?: S): Promise<undefined | WithId<T>> {
+    const bundle = await this.search({ ...params, _count: 1 } as S & { _count: number });
     return bundle.entry?.[0]?.resource;
   }
 
-  async searchAll(params?: SearchParams): Promise<WithId<T>[]> {
+  async searchAll(params?: S): Promise<WithId<T>[]> {
     const results: WithId<T>[] = [];
     let bundle = await this.search(params);
 
@@ -364,6 +402,7 @@ export class FhirResourceWriterImpl<T> implements FhirResourceWriter<T> {
  * Generate bundle-parser.ts
  */
 function generateBundleParser(clientDir, resourceTypes) {
+    const clientPkg = `@babelfhir-ts/client-${versionSlug()}`;
     // Group profiles by base resource type
     const resourceTypeGroups = new Map();
     for (const rt of resourceTypes) {
@@ -382,6 +421,7 @@ function generateBundleParser(clientDir, resourceTypes) {
     })
         .join("\n");
     const content = `import type * as GeneratedTypes from "../index.js";
+import { BundleParser as BaseBundleParser } from "${clientPkg}";
 import type { Bundle, FhirResource } from "./types.js";
 
 /**
@@ -515,6 +555,15 @@ ${parseByTypeCases}
   getBundleType(): 'collection' | 'searchset' | 'transaction-response' | 'transaction' | undefined {
     return this.bundle.type;
   }
+
+  /**
+   * Resolve a FHIR reference within this Bundle.
+   * Supports "ResourceType/id" relative references and full-URL references
+   * matched against entry.fullUrl.
+   */
+  resolveReference<T extends FhirResource>(ref: { reference?: string } | undefined): T | undefined {
+    return BaseBundleParser.resolveReference(ref, this.bundle as any) as T | undefined;
+  }
 }
 
 /**
@@ -529,12 +578,20 @@ export function parseBundle(bundle: Bundle<FhirResource>): BundleParser {
 /**
  * Generate fhir-client.ts
  */
-function generateFhirClient(clientDir, resourceTypes) {
+function generateFhirClient(clientDir, resourceTypes, searchParams) {
+    // Collect search param type imports
+    const spTypeImports = new Set();
+    for (const rt of resourceTypes) {
+        const spType = getSearchParamsTypeName(rt.baseResourceType, searchParams);
+        if (spType !== 'SearchParams')
+            spTypeImports.add(spType);
+    }
     const readerMethods = resourceTypes
         .map((rt) => {
         const methodName = rt.profileName.charAt(0).toLowerCase() + rt.profileName.slice(1);
+        const spType = getSearchParamsTypeName(rt.baseResourceType, searchParams);
         return `  ${methodName}() {
-    return this.forType<GeneratedTypes.${rt.profileName}>("${rt.baseResourceType}");
+    return this.forType<GeneratedTypes.${rt.profileName}, ${spType}>("${rt.baseResourceType}");
   }`;
     })
         .join("\n\n");
@@ -548,13 +605,17 @@ function generateFhirClient(clientDir, resourceTypes) {
         .join("\n\n");
     const slug = versionSlug();
     const clientPkg = `@babelfhir-ts/client-${slug}`;
+    const spImportLine = spTypeImports.size > 0
+        ? `\nimport type { ${[...spTypeImports].sort().join(', ')} } from "./types.js";\n`
+        : '';
     const content = `import {
   FhirReadClient as BaseFhirReadClient,
   FhirWriteClient as BaseFhirWriteClient,
   type FetchFn,
+  type SearchParams,
 } from "${clientPkg}";
 import type * as GeneratedTypes from "../index.js";
-
+${spImportLine}
 /**
  * Profile-specific FHIR Read Client.
  * Extends the base ${slug.toUpperCase()} read client with typed profile accessors.
@@ -622,13 +683,25 @@ export class FhirClient {
 /**
  * Generate index.ts barrel export
  */
-function generateIndex(clientDir, resourceTypes) {
+function generateIndex(clientDir, resourceTypes, searchParams) {
     const readerTypes = resourceTypes
         .map((rt) => `  ${rt.profileName}Reader,`)
         .join("\n");
     const writerTypes = resourceTypes
         .map((rt) => `  ${rt.profileName}Writer,`)
         .join("\n");
+    // Collect per-resource SearchParams type exports
+    const spTypeExports = new Set();
+    if (searchParams && searchParams.size > 0) {
+        for (const rt of resourceTypes) {
+            const spType = getSearchParamsTypeName(rt.baseResourceType, searchParams);
+            if (spType !== 'SearchParams')
+                spTypeExports.add(spType);
+        }
+    }
+    const spExportLine = spTypeExports.size > 0
+        ? `export type { CommonSearchParams, SearchParamValue, ${[...spTypeExports].sort().join(', ')} } from "./types.js";\n`
+        : '';
     const content = `export { FhirClient, FhirReadClient, FhirWriteClient } from "./fhir-client.js";
 export { FhirResourceReader } from "./resource-reader.js";
 export type { FetchFn } from "./resource-reader.js";
@@ -644,7 +717,7 @@ ${writerTypes}
 export { BundleParser, parseBundle } from "./bundle-parser.js";
 export type { BundleEntry } from "./bundle-parser.js";
 export type { Bundle, FhirResource, SearchParams, WithId } from "./types.js";
-export { SmartAuth, discoverEndpoints } from "./smart-auth.js";
+${spExportLine}export { SmartAuth, discoverEndpoints } from "./smart-auth.js";
 export type { SmartConfig, SmartToken, SmartConfiguration, LaunchMode } from "./smart-auth.js";
 export { SmartFhirClient } from "./smart-client.js";
 `;

package/out/src/generator/emitters/client/clientReadmeGenerator.js

@@ -226,14 +226,14 @@ export interface Bundle<T = ${fhirNs}.Resource> {
   entry?: { resource?: T; fullUrl?: string; search?: { mode?: string; score?: number }; request?: { method: string; url: string }; response?: { status: string } }[];
 }
 
-export declare class FhirResourceReader<T extends ${fhirNs}.Resource> {
+export declare class FhirResourceReader<T extends ${fhirNs}.Resource, S extends SearchParams = SearchParams> {
   readonly baseUrl: string;
   readonly resourceType: string;
   constructor(baseUrl: string, resourceType: string, fetchFn?: FetchFn);
   read(id: string): Promise<WithId<T>>;
-  search(params?: SearchParams): Promise<Bundle<WithId<T>>>;
-  searchOne(params?: SearchParams): Promise<WithId<T> | undefined>;
-  searchAll(params?: SearchParams): Promise<WithId<T>[]>;
+  search(params?: S): Promise<Bundle<WithId<T>>>;
+  searchOne(params?: S): Promise<WithId<T> | undefined>;
+  searchAll(params?: S): Promise<WithId<T>[]>;
 }
 
 export declare class FhirResourceWriter<T extends ${fhirNs}.Resource> {
@@ -248,7 +248,7 @@ export declare class FhirResourceWriter<T extends ${fhirNs}.Resource> {
 
 export declare class FhirReadClient {
   constructor(baseUrl: string, fetchFn?: FetchFn);
-  protected forType<T extends ${fhirNs}.Resource>(resourceType: string): FhirResourceReader<T>;
+  protected forType<T extends ${fhirNs}.Resource, S extends SearchParams = SearchParams>(resourceType: string): FhirResourceReader<T, S>;
 }
 
 export declare class FhirWriteClient {
@@ -262,6 +262,13 @@ export declare class FhirClient {
   read(): FhirReadClient;
   write(): FhirWriteClient;
 }
+
+export declare class BundleParser {
+  static getResourcesByType<T extends ${fhirNs}.Resource>(bundle: Bundle<${fhirNs}.Resource>, resourceType: string): WithId<T>[];
+  static getFirstResourceByType<T extends ${fhirNs}.Resource>(bundle: Bundle<${fhirNs}.Resource>, resourceType: string): WithId<T> | undefined;
+  static getAllResources(bundle: Bundle<${fhirNs}.Resource>): ${fhirNs}.Resource[];
+  static resolveReference<T extends ${fhirNs}.Resource>(ref: { reference?: string } | undefined, bundle: Bundle<${fhirNs}.Resource>): T | undefined;
+}
 `;
     fs.writeFileSync(path.join(pkgDir, "index.d.ts"), dts);
 }

package/out/src/generator/emitters/client/searchParamHelpers.js

@@ -0,0 +1,37 @@
+/**
+ * Build per-base-resource-type SearchParams interface declarations for generated types.ts.
+ */
+export function buildSearchParamInterfaces(resourceTypes, searchParams) {
+    if (!searchParams || searchParams.size === 0)
+        return '';
+    const baseTypes = [...new Set(resourceTypes.map(rt => rt.baseResourceType))];
+    const blocks = [];
+    for (const baseType of baseTypes) {
+        const params = searchParams.get(baseType);
+        if (!params?.length)
+            continue;
+        // Sort params alphabetically and deduplicate
+        const sorted = [...params].sort((a, b) => a.code.localeCompare(b.code));
+        const fields = sorted
+            .map(p => `  "${p.code}"?: SearchParamValue;`)
+            .join("\n");
+        blocks.push(`/**
+ * Typed search parameters for ${baseType} resources.
+ * Generated from SearchParameter definitions in the base FHIR spec and IG.
+ */
+export interface ${baseType}SearchParams extends CommonSearchParams {
+${fields}
+}`);
+    }
+    return blocks.join("\n\n") + "\n";
+}
+/**
+ * Get the SearchParams interface name for a given base resource type,
+ * or fall back to SearchParams if none is generated.
+ */
+export function getSearchParamsTypeName(baseResourceType, searchParams) {
+    if (searchParams?.has(baseResourceType) && searchParams.get(baseResourceType).length > 0) {
+        return `${baseResourceType}SearchParams`;
+    }
+    return 'SearchParams';
+}

package/out/src/generator/emitters/interface/interfaceFieldProcessor.js

@@ -535,6 +535,10 @@ export function processFields(ctx, fields, parentInterfaceName, parentFieldType,
             const sanitizedBaseResource = baseResource ? sanitizeIdentifier(baseResource) : undefined;
             const isBaseAbstract = sanitizedBaseResource === 'Base';
             const extendsClause = (sanitizedBaseResource && !isBaseAbstract && !isPrimitiveType(sanitizedBaseResource)) ? ` extends ${sanitizedBaseResource}` : '';
+            // Add resourceType literal for discriminated union support (only for actual FHIR resources, not data types)
+            if (ctx.resourceType && rules().isCoreResource(ctx.resourceType) && !deduped.some(l => /^resourceType[?:]/.test(l))) {
+                deduped.unshift(`resourceType: '${ctx.resourceType}';`);
+            }
             debug('emit root interface', parentInterfaceName, 'extends', sanitizedBaseResource, 'fields', deduped.length);
             interfaces.push(`export interface ${parentInterfaceName}${extendsClause} {\n${deduped.map(l => `    ${l}`).join('\n')}\n}`);
         }

package/out/src/generator/index.js

@@ -1,7 +1,7 @@
 import path from 'path';
 import fs from 'fs';
 import { fileURLToPath } from 'url';
-import { extractPackage, readStructureDefinitionsFromDir, readStructureDefinitionsFromDependencies, createPackageFromDir, readValueSetCodesWithDependencies, readValueSetsFromDir, detectFhirVersion, ensureDependenciesDownloaded } from './parser/packageParser.js';
+import { extractPackage, readStructureDefinitionsFromDir, readStructureDefinitionsFromDependencies, createPackageFromDir, readValueSetCodesWithDependencies, readValueSetsFromDir, detectFhirVersion, ensureDependenciesDownloaded, readSearchParametersFromDir } from './parser/packageParser.js';
 import { fetchStructureDefinitions, fetchStructureDefinition, registerLocalStructureDefinitions, clearLocalStructureDefinitions, collectValueSetBindingUrls } from './parser/sdParser.js';
 import { ensureDirectoryExists, downloadFile } from './core/utils.js';
 import { getFhirPackagesCacheDir } from './core/cacheConfig.js';
@@ -9,6 +9,8 @@ import { processStructureDefinition, resetFetchFailureTracking, getFetchFailureC
 import { logger } from '../logger.js';
 import { initVersionContext, ctx, versionSlug } from './fhir/versionContext.js';
 import { DEFAULT_FHIR_VERSION } from './fhir/types.js';
+import { FHIR_VERSIONS } from './fhir/versionRegistry.js';
+import { ensureCorePackage } from './fhir/corePackageResolver.js';
 import { spawn } from 'child_process';
 import { buildProfileRegistries, expandValueSetsWithTx, emitValueSetFiles, cleanupStaleValueSetDir, initGenerationContext, enrichValueSetsFromCodeMap, collectReferencedDependencyProfiles, } from './generationHelpers.js';
 /** Resolve the babelfhir-ts CLI version from its own package.json (used to stamp generated packages). */
@@ -41,6 +43,44 @@ function buildFhirChildTypeMapFromJson() {
     return result;
 }
 export { resetFetchFailureTracking, getFetchFailureCount, getFetchFailureWarning };
+/**
+ * Load search parameters from the FHIR core package and the IG's extracted root.
+ * Merges both sets, with IG params taking precedence for deduplication by code.
+ */
+async function loadSearchParameters(extractedRoot) {
+    const slug = versionSlug();
+    const coreSpec = FHIR_VERSIONS[slug]?.corePackage;
+    const merged = new Map();
+    // Load base FHIR search params from the core package
+    if (coreSpec) {
+        try {
+            const coreDir = await ensureCorePackage(coreSpec);
+            const coreParams = readSearchParametersFromDir(coreDir);
+            for (const [baseType, params] of coreParams) {
+                merged.set(baseType, [...params]);
+            }
+            log.debug(`Loaded ${coreParams.size} base resource type search param groups from core package`);
+        }
+        catch (err) {
+            log.warn(`Could not load core search parameters: ${err.message}`);
+        }
+    }
+    // Load IG-specific search params (may override or extend base)
+    const igParams = readSearchParametersFromDir(extractedRoot);
+    for (const [baseType, params] of igParams) {
+        const existing = merged.get(baseType) || [];
+        for (const p of params) {
+            if (!existing.some(e => e.code === p.code)) {
+                existing.push(p);
+            }
+        }
+        merged.set(baseType, existing);
+    }
+    if (igParams.size > 0) {
+        log.debug(`Loaded ${igParams.size} IG-specific search param groups`);
+    }
+    return merged;
+}
 /**
  * Copy the fhir-<version>.d.ts ambient module declaration into the output directory.
  * This is required so generated code can import from 'fhir/r4' (or r4b) even when
@@ -461,9 +501,12 @@ export async function generateIntoPackage(packageArchivePath, outArchivePath, fl
         // Generate FHIR client (unless --no-client flag)
         if (!flags?.noClient) {
             logger.log('Generating FHIR client...');
+            // Load search parameters from base FHIR spec + IG for typed search param generation
+            const searchParams = await loadSearchParameters(extractedRoot);
             const { generateClient } = await import('./emitters/client/clientGenerator.js');
             generateClient({
-                outputDir
+                outputDir,
+                searchParams,
             });
             logger.log('FHIR client generated');
         }
@@ -694,8 +737,9 @@ export async function generateIntoPackageDirect(packageArchivePath, flags) {
     await generateIndexFile(outputDir);
     if (!flags?.noClient) {
         logger.log('Generating FHIR client...');
+        const searchParams = await loadSearchParameters(extractedRoot);
         const { generateClient } = await import('./emitters/client/clientGenerator.js');
-        generateClient({ outputDir });
+        generateClient({ outputDir, searchParams });
         logger.log('FHIR client generated');
     }
     // Generate DICOMweb helpers (--dicomweb flag)
@@ -893,9 +937,11 @@ export async function generateForDirectory(inputDir, outputDir, flags) {
     // Generate FHIR client (unless --no-client flag)
     if (!flags?.noClient) {
         logger.log('Generating FHIR client...');
+        const searchParams = await loadSearchParameters(inputDir);
         const { generateClient } = await import('./emitters/client/clientGenerator.js');
         generateClient({
-            outputDir
+            outputDir,
+            searchParams,
         });
         logger.log('FHIR client generated');
     }

package/out/src/generator/parser/packageParser.js

@@ -806,3 +806,39 @@ export function readValueSetsFromDir(extractedRoot) {
     }
     return map;
 }
+/**
+ * Read all SearchParameter resources from a package directory.
+ * Returns a map of base resource type → array of search parameter definitions.
+ */
+export function readSearchParametersFromDir(extractedRoot) {
+    const jsonFiles = findJsonFilesByPrefix(extractedRoot, 'SearchParameter-');
+    const map = new Map();
+    for (const file of jsonFiles) {
+        try {
+            const content = JSON.parse(fs.readFileSync(file, 'utf-8'));
+            if (content.resourceType !== 'SearchParameter')
+                continue;
+            if (!content.code || !content.type || !content.base?.length)
+                continue;
+            if (content.status === 'retired')
+                continue;
+            const param = {
+                code: content.code,
+                type: content.type,
+                base: content.base,
+            };
+            for (const baseType of param.base) {
+                const existing = map.get(baseType) || [];
+                // Avoid duplicates by code
+                if (!existing.some(p => p.code === param.code)) {
+                    existing.push(param);
+                    map.set(baseType, existing);
+                }
+            }
+        }
+        catch (err) {
+            log.debug(`Skipping invalid JSON while reading SearchParameters ${file}: ${err.message}`);
+        }
+    }
+    return map;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "babelfhir-ts",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "BabelFHIR-TS: generate TypeScript interfaces, validators, and helper classes from FHIR R4/R4B/R5 StructureDefinitions (profiles) directly inside package archives.",
   "type": "module",
   "main": "out/src/main.js",