forked from atomic-ehr/codegen
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathregister.ts
More file actions
398 lines (371 loc) · 16.4 KB
/
register.ts
File metadata and controls
398 lines (371 loc) · 16.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
import { CanonicalManager } from "@atomic-ehr/fhir-canonical-manager";
import * as fhirschema from "@atomic-ehr/fhirschema";
import {
type FHIRSchema,
type FHIRSchemaElement,
isStructureDefinition,
type StructureDefinition,
} from "@atomic-ehr/fhirschema";
import { type CodeSystem, isCodeSystem, isValueSet, type ValueSet } from "@root/fhir-types/hl7-fhir-r4-core";
import type { CodegenLogger } from "@root/utils/codegen-logger";
import type {
CanonicalUrl,
Name,
PackageMeta,
RichFHIRSchema,
RichStructureDefinition,
RichValueSet,
} from "@typeschema/types";
import { enrichFHIRSchema, enrichValueSet, packageMetaToFhir, packageMetaToNpm } from "@typeschema/types";
export type Register = {
testAppendFs(fs: FHIRSchema): void;
ensureSpecializationCanonicalUrl(name: string | Name | CanonicalUrl): CanonicalUrl;
resolveSd(pkg: PackageMeta, canonicalUrl: CanonicalUrl): StructureDefinition | undefined;
resolveFs(pkg: PackageMeta, canonicalUrl: CanonicalUrl): RichFHIRSchema | undefined;
resolveFsGenealogy(pkg: PackageMeta, canonicalUrl: CanonicalUrl): RichFHIRSchema[];
resolveFsSpecializations(pkg: PackageMeta, canonicalUrl: CanonicalUrl): RichFHIRSchema[];
allSd(): RichStructureDefinition[];
patchSd(fn: (pkg: PackageMeta, sd: StructureDefinition) => StructureDefinition): void;
/** Returns all FHIRSchemas from all packages in the resolver */
allFs(): RichFHIRSchema[];
/** Returns all ValueSets from all packages in the resolver */
allVs(): RichValueSet[];
resolveVs(_pkg: PackageMeta, canonicalUrl: CanonicalUrl): RichValueSet | undefined;
resolveAny(canonicalUrl: CanonicalUrl): any | undefined;
resolveElementSnapshot(fhirSchema: RichFHIRSchema, path: string[]): FHIRSchemaElement;
getAllElementKeys(elems: Record<string, FHIRSchemaElement>): string[];
resolver: PackageAwareResolver;
resolutionTree: () => ResolutionTree;
};
const readPackageDependencies = async (manager: ReturnType<typeof CanonicalManager>, packageMeta: PackageMeta) => {
const packageJSON = (await manager.packageJson(packageMeta.name)) as any;
if (!packageJSON) return [];
const dependencies = packageJSON.dependencies;
if (dependencies !== undefined) {
return Object.entries(dependencies).map(([name, version]): PackageMeta => {
return { name: name as string, version: version as string };
});
}
return [];
};
// FIXME: Tiding: PackageName, PkgId, PkgName
type PkgId = string;
type PkgName = string;
type FocusedResource = StructureDefinition | ValueSet | CodeSystem;
type CanonicalResolution<T> = {
deep: number;
pkg: PackageMeta;
pkgId: PkgId;
resource: T;
};
type PackageIndex = {
pkg: PackageMeta;
canonicalResolution: Record<CanonicalUrl, CanonicalResolution<FocusedResource>[]>;
fhirSchemas: Record<CanonicalUrl, RichFHIRSchema>;
valueSets: Record<CanonicalUrl, RichValueSet>;
};
type PackageAwareResolver = Record<PkgId, PackageIndex>;
export type ResolutionTree = Record<PkgName, Record<CanonicalUrl, { deep: number; pkg: PackageMeta }[]>>;
const mkEmptyPkgIndex = (pkg: PackageMeta): PackageIndex => {
return {
pkg,
canonicalResolution: {},
fhirSchemas: {},
valueSets: {},
};
};
const mkPackageAwareResolver = async (
manager: ReturnType<typeof CanonicalManager>,
pkg: PackageMeta,
deep: number,
acc: PackageAwareResolver,
logger?: CodegenLogger,
): Promise<PackageIndex> => {
const pkgId = packageMetaToFhir(pkg);
logger?.info(`${" ".repeat(deep * 2)}+ ${pkgId}`);
if (acc[pkgId]) return acc[pkgId];
const index = mkEmptyPkgIndex(pkg);
for (const resource of await manager.search({ package: pkg })) {
const rawUrl = resource.url;
if (!rawUrl) continue;
if (!(isStructureDefinition(resource) || isValueSet(resource) || isCodeSystem(resource))) continue;
const url = rawUrl as CanonicalUrl;
if (index.canonicalResolution[url]) logger?.dryWarn(`Duplicate canonical URL: ${url} at ${pkgId}.`);
index.canonicalResolution[url] = [{ deep, pkg: pkg, pkgId, resource: resource as FocusedResource }];
}
const deps = await readPackageDependencies(manager, pkg);
for (const depPkg of deps) {
const { canonicalResolution } = await mkPackageAwareResolver(manager, depPkg, deep + 1, acc, logger);
for (const [surl, resolutions] of Object.entries(canonicalResolution)) {
const url = surl as CanonicalUrl;
index.canonicalResolution[url] = [...(index.canonicalResolution[url] || []), ...resolutions];
}
}
for (const resolutionOptions of Object.values(index.canonicalResolution)) {
resolutionOptions.sort((a, b) => a.deep - b.deep);
}
acc[pkgId] = index;
return index;
};
const enrichResolver = (resolver: PackageAwareResolver, logger?: CodegenLogger) => {
for (const { pkg, canonicalResolution } of Object.values(resolver)) {
const pkgId = packageMetaToFhir(pkg);
if (!resolver[pkgId]) throw new Error(`Package ${pkgId} not found`);
let counter = 0;
logger?.info(`FHIR Schema conversion for '${packageMetaToFhir(pkg)}' begins...`);
for (const [_url, options] of Object.entries(canonicalResolution)) {
const resolition = options[0];
if (!resolition) throw new Error(`Resource not found`);
const resource = resolition.resource;
const resourcePkg = resolition.pkg;
if (isStructureDefinition(resource)) {
const fs = fhirschema.translate(resource as StructureDefinition) as FHIRSchema;
const rfs = enrichFHIRSchema(fs, resourcePkg);
counter++;
resolver[pkgId].fhirSchemas[rfs.url] = rfs;
}
if (isValueSet(resource)) {
const rvs = enrichValueSet(resource, resourcePkg);
resolver[pkgId].valueSets[rvs.url] = rvs;
}
}
logger?.info(`FHIR Schema conversion for '${packageMetaToFhir(pkg)}' completed: ${counter} successful`);
}
};
const packageAgnosticResolveCanonical = (
resolver: PackageAwareResolver,
url: CanonicalUrl,
_logger?: CodegenLogger,
) => {
const options = Object.values(resolver).flatMap((pkg) => pkg.canonicalResolution[url]);
if (!options) throw new Error(`No canonical resolution found for ${url} in any package`);
// if (options.length > 1)
// logger?.dry_warn(
// `Multiple canonical resolutions found for ${url} in: ${options
// .map((e) => {
// return `\n ${JSON.stringify({ ...e, resource: undefined, pkg: undefined })}`;
// })
// .join("")}`,
// );
return options[0]?.resource;
};
export type RegisterConfig = {
logger?: CodegenLogger;
focusedPackages?: PackageMeta[];
/** Custom FHIR package registry URL */
registry?: string;
};
export const registerFromManager = async (
manager: ReturnType<typeof CanonicalManager>,
{ logger, focusedPackages }: RegisterConfig,
): Promise<Register> => {
const packages = focusedPackages ?? (await manager.packages());
const resolver: PackageAwareResolver = {};
for (const pkg of packages) {
await mkPackageAwareResolver(manager, pkg, 0, resolver, logger);
}
enrichResolver(resolver);
const resolveFs = (pkg: PackageMeta, canonicalUrl: CanonicalUrl) => {
const pkgIndex = resolver[packageMetaToFhir(pkg)];
if (pkgIndex) {
// Use canonicalResolution which is sorted by depth (closest first)
const resolution = pkgIndex.canonicalResolution[canonicalUrl]?.[0];
if (resolution) {
return resolver[resolution.pkgId]?.fhirSchemas[canonicalUrl];
}
}
// Fallback for packages not in resolver: search by package name in fhirSchemas
for (const idx of Object.values(resolver)) {
const fs = idx.fhirSchemas[canonicalUrl];
if (fs && fs.package_meta.name === pkg.name) return fs;
}
// Last resort: return any match
for (const idx of Object.values(resolver)) {
const fs = idx.fhirSchemas[canonicalUrl];
if (fs) return fs;
}
return undefined;
};
const resolveVs = (pkg: PackageMeta, canonicalUrl: CanonicalUrl) => {
const pkgIndex = resolver[packageMetaToFhir(pkg)];
if (pkgIndex) {
// Use canonicalResolution which is sorted by depth (closest first)
const resolution = pkgIndex.canonicalResolution[canonicalUrl]?.[0];
if (resolution) {
return resolver[resolution.pkgId]?.valueSets[canonicalUrl];
}
}
// Fallback for packages not in resolver: search by package name in valueSets
for (const idx of Object.values(resolver)) {
const vs = idx.valueSets[canonicalUrl];
if (vs && vs.package_meta.name === pkg.name) return vs;
}
// Last resort: return any match
for (const idx of Object.values(resolver)) {
const vs = idx.valueSets[canonicalUrl];
if (vs) return vs;
}
return undefined;
};
const ensureSpecializationCanonicalUrl = (name: string | Name | CanonicalUrl): CanonicalUrl => {
// Strip version suffix from canonical URL (e.g., "Extension|4.0.1" -> "Extension")
if (name.includes("|")) name = name.split("|")[0] as CanonicalUrl;
if (name.match(/^[a-zA-Z0-9]+$/)) {
return `http://hl7.org/fhir/StructureDefinition/${name}` as CanonicalUrl;
}
return name as CanonicalUrl;
};
const resolveFsGenealogy = (pkg: PackageMeta, canonicalUrl: CanonicalUrl) => {
let fs = resolveFs(pkg, canonicalUrl);
if (fs === undefined) throw new Error(`Failed to resolve FHIR Schema: '${canonicalUrl}'`);
const genealogy = [fs];
while (fs?.base) {
const pkg = fs.package_meta;
const baseUrl = ensureSpecializationCanonicalUrl(fs.base);
fs = resolveFs(pkg, baseUrl);
if (fs === undefined)
throw new Error(
`Failed to resolve FHIR Schema base for '${canonicalUrl}'. Problem: '${baseUrl}' from '${packageMetaToFhir(pkg)}'`,
);
genealogy.push(fs);
}
return genealogy;
};
const resolveFsSpecializations = (pkg: PackageMeta, canonicalUrl: CanonicalUrl): RichFHIRSchema[] => {
return resolveFsGenealogy(pkg, canonicalUrl).filter((fs) => fs.derivation === "specialization");
};
const resolveElementSnapshot = (fhirSchema: RichFHIRSchema, path: string[]): FHIRSchemaElement => {
const geneology = resolveFsGenealogy(fhirSchema.package_meta, fhirSchema.url);
const elemGeneology = resolveFsElementGenealogy(geneology, path);
const elemSnapshot = fsElementSnapshot(elemGeneology);
return elemSnapshot;
};
const getAllElementKeys = (elems: Record<string, FHIRSchemaElement>): string[] => {
const keys: Set<string> = new Set();
for (const [key, elem] of Object.entries(elems)) {
keys.add(key);
for (const choiceKey of elem?.choices || []) {
if (!elems[choiceKey]) {
keys.add(choiceKey);
}
}
}
return Array.from(keys);
};
let cachedResolutionTree: ResolutionTree | undefined;
return {
testAppendFs(rfs: RichFHIRSchema) {
const pkgId = packageMetaToFhir(rfs.package_meta);
if (!resolver[pkgId]) resolver[pkgId] = mkEmptyPkgIndex(rfs.package_meta);
resolver[pkgId].fhirSchemas[rfs.url] = rfs;
cachedResolutionTree = undefined;
},
resolveFs,
resolveFsGenealogy: resolveFsGenealogy,
resolveFsSpecializations: resolveFsSpecializations,
ensureSpecializationCanonicalUrl,
resolveSd: (pkg: PackageMeta, canonicalUrl: CanonicalUrl) => {
const res = resolver[packageMetaToFhir(pkg)]?.canonicalResolution[canonicalUrl]?.[0]?.resource;
if (isStructureDefinition(res)) return res as StructureDefinition;
return undefined;
},
allSd: () =>
Object.values(resolver)
.flatMap((pkgIndex) =>
Object.values(pkgIndex.canonicalResolution).flatMap((resolutions) =>
resolutions.map((r) => {
const sd = r.resource as RichStructureDefinition;
if (!sd.package_name) {
return {
...sd,
package_name: pkgIndex.pkg.name,
package_version: pkgIndex.pkg.version,
};
}
return sd;
}),
),
)
.filter((r): r is RichStructureDefinition => isStructureDefinition(r))
.sort((sd1, sd2) => sd1.url.localeCompare(sd2.url)),
patchSd: (fn: (pkg: PackageMeta, sd: StructureDefinition) => StructureDefinition) => {
Object.values(resolver).flatMap((pkgIndex) =>
Object.values(pkgIndex.canonicalResolution).forEach((resolutions) => {
resolutions.forEach((e) => {
if (isStructureDefinition(e.resource)) {
const sd = e.resource as StructureDefinition;
const newSd = fn(pkgIndex.pkg, sd);
if (sd.url !== newSd.url)
throw new Error(`Patch update StructureDefinition URL: ${sd.url} !== ${newSd.url}`);
e.resource = newSd;
}
});
}),
);
enrichResolver(resolver);
cachedResolutionTree = undefined;
},
allFs: () => Object.values(resolver).flatMap((pkgIndex) => Object.values(pkgIndex.fhirSchemas)),
allVs: () => Object.values(resolver).flatMap((pkgIndex) => Object.values(pkgIndex.valueSets)),
resolveVs,
resolveAny: (canonicalUrl: CanonicalUrl) => packageAgnosticResolveCanonical(resolver, canonicalUrl, logger),
resolveElementSnapshot,
getAllElementKeys,
resolver,
resolutionTree: () => {
if (cachedResolutionTree) return cachedResolutionTree;
const res: ResolutionTree = {};
for (const [_pkgId, pkgIndex] of Object.entries(resolver)) {
const pkgName = pkgIndex.pkg.name;
res[pkgName] = {};
for (const [surl, resolutions] of Object.entries(pkgIndex.canonicalResolution)) {
const url = surl as CanonicalUrl;
res[pkgName][url] = [];
for (const resolution of resolutions) {
res[pkgName][url].push({ deep: resolution.deep, pkg: resolution.pkg });
}
}
}
cachedResolutionTree = res;
return res;
},
};
};
export const registerFromPackageMetas = async (
packageMetas: PackageMeta[],
conf: RegisterConfig,
): Promise<Register> => {
const packageNames = packageMetas.map(packageMetaToNpm);
conf?.logger?.step(`Loading FHIR packages: ${packageNames.join(", ")}`);
const manager = CanonicalManager({
packages: packageNames,
workingDir: "tmp/fhir",
registry: conf.registry || undefined,
});
await manager.init();
return await registerFromManager(manager, {
...conf,
focusedPackages: packageMetas,
});
};
export const resolveFsElementGenealogy = (genealogy: RichFHIRSchema[], path: string[]): FHIRSchemaElement[] => {
const [top, ...rest] = path;
if (top === undefined) return [];
return genealogy
.map((fs) => {
if (!fs.elements) return undefined;
let elem = fs.elements?.[top];
for (const k of rest) {
elem = elem?.elements?.[k];
}
return elem;
})
.filter((elem) => elem !== undefined);
};
export function fsElementSnapshot(genealogy: FHIRSchemaElement[]): FHIRSchemaElement {
const revGenealogy = genealogy.reverse();
const snapshot = Object.assign({}, ...revGenealogy);
// NOTE: to avoid regeneration nested types
snapshot.elements = undefined;
return snapshot;
}