Merge branch 'bugfix/LF-2769/typescript-update' into 'master'

Changed TypeScript definitions

See merge request lfor/fhirpath.js!16

CHANGELOG.md

@@ -3,6 +3,11 @@
 This log documents significant changes for each release.  This project follows
 [Semantic Versioning](http://semver.org/).
 
+## [3.13.3] - 2024-05-24
+### Changed
+- Added separate TypeScript type definition files for the main file and each
+  supported model.
+
 ## [3.13.2] - 2024-05-15
 ### Fixed
 - an issue with evaluating an expression for a resource passed through an

fhir-context/dstu2/index.d.ts

@@ -0,0 +1,8 @@
+import { Model } from "../../src/fhirpath";
+
+export const {
+    choiceTypePaths,
+    pathsDefinedElsewhere,
+    type2Parent,
+    path2Type
+}: Model;

fhir-context/r4/index.d.ts

@@ -0,0 +1,8 @@
+import { Model } from "../../src/fhirpath";
+
+export const {
+    choiceTypePaths,
+    pathsDefinedElsewhere,
+    type2Parent,
+    path2Type
+}: Model;

fhir-context/r5/index.d.ts

@@ -0,0 +1,8 @@
+import { Model } from "../../src/fhirpath";
+
+export const {
+    choiceTypePaths,
+    pathsDefinedElsewhere,
+    type2Parent,
+    path2Type
+}: Model;

fhir-context/stu3/index.d.ts

@@ -0,0 +1,8 @@
+import { Model } from "../../src/fhirpath";
+
+export const {
+    choiceTypePaths,
+    pathsDefinedElsewhere,
+    type2Parent,
+    path2Type
+}: Model;

package.json

@@ -1,8 +1,9 @@
 {
   "name": "fhirpath",
-  "version": "3.13.2",
+  "version": "3.13.3",
   "description": "A FHIRPath engine",
   "main": "src/fhirpath.js",
+  "types": "src/fhirpath.d.ts",
   "dependencies": {
     "@lhncbc/ucum-lhc": "^5.0.0",
     "antlr4": "~4.9.3",

src/fhirpath.d.ts

@@ -0,0 +1,64 @@
+export function compile(
+  path: string | Path,
+  model?: Model,
+  options?: {
+    resolveInternalTypes?: boolean
+    traceFn?: (value: any, label: string) => void,
+    userInvocationTable?: UserInvocationTable
+  }
+): Compile;
+
+export function evaluate(
+  fhirData: any,
+  path: string | Path,
+  context?: Context,
+  model?: Model,
+  options?: {
+    resolveInternalTypes?: boolean,
+    traceFn?: (value: any, label: string) => void
+    userInvocationTable?: UserInvocationTable
+  }
+): any[];
+
+export function resolveInternalTypes(value: any): any;
+
+export function types(value: any): string[];
+
+export function parse(expression: string): any;
+
+export const version :string;
+
+interface Path {
+  base: string;
+  expression: string;
+}
+
+interface Model {
+  choiceTypePaths: {
+    [path: string]: string[];
+  };
+  pathsDefinedElsewhere: {
+    [path: string]: string;
+  };
+  type2Parent: {
+    [path: string]: string;
+  };
+  path2Type: {
+    [path: string]: string;
+  };
+}
+
+type Compile = (resource: any, context?: Context) => any[];
+
+type Context = void | Record<string, any>;
+
+type UserInvocationTable = {
+  [name: string]: {
+    fn: Function,
+    arity: {
+      [numberOfParams: number]: Array<'Expr' | 'AnyAtRoot' | 'Identifier' | 'TypeSpecifier' | 'Any' | 'Integer' | 'Boolean' | 'Number' | 'String'>
+    },
+    nullable?: boolean,
+    internalStructures?: boolean
+  }
+};