@medplum/fhir-router 2.1.10 → 2.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/cjs/index.cjs.map +1 -1
  2. package/dist/esm/index.mjs.map +1 -1
  3. package/dist/types.d.ts +23 -23
  4. package/package.json +31 -31
  5. package/tsdoc.json +4 -0
package/dist/types.d.ts CHANGED
@@ -11,7 +11,7 @@ export declare abstract class BaseRepository {
11
11
  * Searches for FHIR resources.
12
12
  *
13
13
  * See: https://www.hl7.org/fhir/http.html#search
14
- * @param searchRequest The FHIR search request.
14
+ * @param searchRequest - The FHIR search request.
15
15
  * @returns The search results.
16
16
  */
17
17
  abstract search<T extends Resource>(searchRequest: SearchRequest<T>): Promise<Bundle<T>>;
@@ -23,7 +23,7 @@ export declare abstract class BaseRepository {
23
23
  * The return value is the resource, if available; otherwise, undefined.
24
24
  *
25
25
  * See FHIR search for full details: https://www.hl7.org/fhir/search.html
26
- * @param searchRequest The FHIR search request.
26
+ * @param searchRequest - The FHIR search request.
27
27
  * @returns Promise to the first search result or undefined.
28
28
  */
29
29
  searchOne<T extends Resource>(searchRequest: SearchRequest<T>): Promise<T | undefined>;
@@ -35,13 +35,13 @@ export declare abstract class BaseRepository {
35
35
  * The return value is an array of resources.
36
36
  *
37
37
  * See FHIR search for full details: https://www.hl7.org/fhir/search.html
38
- * @param searchRequest The FHIR search request.
38
+ * @param searchRequest - The FHIR search request.
39
39
  * @returns Promise to the array of search results.
40
40
  */
41
41
  searchResources<T extends Resource>(searchRequest: SearchRequest<T>): Promise<T[]>;
42
42
  }
43
43
 
44
- declare interface FhirOptions {
44
+ export declare interface FhirOptions {
45
45
  introspectionEnabled?: boolean;
46
46
  }
47
47
 
@@ -58,7 +58,7 @@ export declare interface FhirRepository {
58
58
  * Creates a FHIR resource.
59
59
  *
60
60
  * See: https://www.hl7.org/fhir/http.html#create
61
- * @param resource The FHIR resource to create.
61
+ * @param resource - The FHIR resource to create.
62
62
  * @returns The created resource.
63
63
  */
64
64
  createResource<T extends Resource>(resource: T): Promise<T>;
@@ -66,8 +66,8 @@ export declare interface FhirRepository {
66
66
  * Reads a FHIR resource by ID.
67
67
  *
68
68
  * See: https://www.hl7.org/fhir/http.html#read
69
- * @param resourceType The FHIR resource type.
70
- * @param id The FHIR resource ID.
69
+ * @param resourceType - The FHIR resource type.
70
+ * @param id - The FHIR resource ID.
71
71
  * @returns The FHIR resource.
72
72
  */
73
73
  readResource<T extends Resource>(resourceType: string, id: string): Promise<T>;
@@ -75,7 +75,7 @@ export declare interface FhirRepository {
75
75
  * Reads a FHIR resource by reference.
76
76
  *
77
77
  * See: https://www.hl7.org/fhir/http.html#read
78
- * @param reference The FHIR reference.
78
+ * @param reference - The FHIR reference.
79
79
  * @returns The FHIR resource.
80
80
  */
81
81
  readReference<T extends Resource>(reference: Reference<T>): Promise<T>;
@@ -83,7 +83,7 @@ export declare interface FhirRepository {
83
83
  * Reads a collection of FHIR resources by reference.
84
84
  *
85
85
  * See: https://www.hl7.org/fhir/http.html#read
86
- * @param references The FHIR references.
86
+ * @param references - The FHIR references.
87
87
  * @returns The FHIR resources.
88
88
  */
89
89
  readReferences(references: readonly Reference[]): Promise<(Resource | Error)[]>;
@@ -93,8 +93,8 @@ export declare interface FhirRepository {
93
93
  * Results are sorted with oldest versions last
94
94
  *
95
95
  * See: https://www.hl7.org/fhir/http.html#history
96
- * @param resourceType The FHIR resource type.
97
- * @param id The FHIR resource ID.
96
+ * @param resourceType - The FHIR resource type.
97
+ * @param id - The FHIR resource ID.
98
98
  * @returns Operation outcome and a history bundle.
99
99
  */
100
100
  readHistory<T extends Resource>(resourceType: string, id: string): Promise<Bundle<T>>;
@@ -102,16 +102,16 @@ export declare interface FhirRepository {
102
102
  * Reads a FHIR resource version.
103
103
  *
104
104
  * See: https://www.hl7.org/fhir/http.html#vread
105
- * @param resourceType The FHIR resource type.
106
- * @param id The FHIR resource ID.
107
- * @param vid The FHIR resource version ID.
105
+ * @param resourceType - The FHIR resource type.
106
+ * @param id - The FHIR resource ID.
107
+ * @param vid - The FHIR resource version ID.
108
108
  */
109
109
  readVersion<T extends Resource>(resourceType: string, id: string, vid: string): Promise<T>;
110
110
  /**
111
111
  * Updates a FHIR resource.
112
112
  *
113
113
  * See: https://www.hl7.org/fhir/http.html#update
114
- * @param resource The FHIR resource to update.
114
+ * @param resource - The FHIR resource to update.
115
115
  * @returns The updated resource.
116
116
  */
117
117
  updateResource<T extends Resource>(resource: T): Promise<T>;
@@ -119,17 +119,17 @@ export declare interface FhirRepository {
119
119
  * Deletes a FHIR resource.
120
120
  *
121
121
  * See: https://www.hl7.org/fhir/http.html#delete
122
- * @param resourceType The FHIR resource type.
123
- * @param id The FHIR resource ID.
122
+ * @param resourceType - The FHIR resource type.
123
+ * @param id - The FHIR resource ID.
124
124
  */
125
125
  deleteResource(resourceType: string, id: string): Promise<void>;
126
126
  /**
127
127
  * Patches a FHIR resource.
128
128
  *
129
129
  * See: https://www.hl7.org/fhir/http.html#patch
130
- * @param resourceType The FHIR resource type.
131
- * @param id The FHIR resource ID.
132
- * @param patch The JSONPatch operations.
130
+ * @param resourceType - The FHIR resource type.
131
+ * @param id - The FHIR resource ID.
132
+ * @param patch - The JSONPatch operations.
133
133
  * @returns The patched resource.
134
134
  */
135
135
  patchResource(resourceType: string, id: string, patch: Operation[]): Promise<Resource>;
@@ -137,7 +137,7 @@ export declare interface FhirRepository {
137
137
  * Searches for FHIR resources.
138
138
  *
139
139
  * See: https://www.hl7.org/fhir/http.html#search
140
- * @param searchRequest The FHIR search request.
140
+ * @param searchRequest - The FHIR search request.
141
141
  * @returns The search results.
142
142
  */
143
143
  search<T extends Resource>(searchRequest: SearchRequest<T>): Promise<Bundle<T>>;
@@ -149,7 +149,7 @@ export declare interface FhirRepository {
149
149
  * The return value is the resource, if available; otherwise, undefined.
150
150
  *
151
151
  * See FHIR search for full details: https://www.hl7.org/fhir/search.html
152
- * @param searchRequest The FHIR search request.
152
+ * @param searchRequest - The FHIR search request.
153
153
  * @returns Promise to the first search result or undefined.
154
154
  */
155
155
  searchOne<T extends Resource>(searchRequest: SearchRequest<T>): Promise<T | undefined>;
@@ -161,7 +161,7 @@ export declare interface FhirRepository {
161
161
  * The return value is an array of resources.
162
162
  *
163
163
  * See FHIR search for full details: https://www.hl7.org/fhir/search.html
164
- * @param searchRequest The FHIR search request.
164
+ * @param searchRequest - The FHIR search request.
165
165
  * @returns Promise to the array of search results.
166
166
  */
167
167
  searchResources<T extends Resource>(searchRequest: SearchRequest<T>): Promise<T[]>;
package/package.json CHANGED
@@ -1,21 +1,42 @@
1
1
  {
2
2
  "name": "@medplum/fhir-router",
3
- "version": "2.1.10",
3
+ "version": "2.1.11",
4
4
  "description": "Medplum FHIR Router",
5
- "author": "Medplum <hello@medplum.com>",
6
- "license": "Apache-2.0",
5
+ "keywords": [
6
+ "medplum",
7
+ "fhir",
8
+ "healthcare",
9
+ "interoperability",
10
+ "json",
11
+ "serialization",
12
+ "hl7",
13
+ "standards",
14
+ "clinical",
15
+ "dstu2",
16
+ "stu3",
17
+ "r4",
18
+ "normative"
19
+ ],
7
20
  "homepage": "https://www.medplum.com/",
8
21
  "repository": {
9
22
  "type": "git",
10
- "url": "https://github.com/medplum/medplum.git",
23
+ "url": "git+https://github.com/medplum/medplum.git",
11
24
  "directory": "packages/fhir-router"
12
25
  },
13
- "engines": {
14
- "node": ">=18.0.0"
26
+ "license": "Apache-2.0",
27
+ "author": "Medplum <hello@medplum.com>",
28
+ "sideEffects": false,
29
+ "exports": {
30
+ "types": "./dist/types.d.ts",
31
+ "require": "./dist/cjs/index.cjs",
32
+ "import": "./dist/esm/index.mjs"
15
33
  },
34
+ "main": "dist/cjs/index.cjs",
35
+ "module": "dist/esm/index.mjs",
36
+ "types": "dist/types.d.ts",
16
37
  "scripts": {
17
- "clean": "rimraf dist",
18
38
  "build": "npm run clean && tsc --project tsconfig.build.json && node esbuild.mjs && api-extractor run --local",
39
+ "clean": "rimraf dist",
19
40
  "test": "jest"
20
41
  },
21
42
  "dependencies": {
@@ -26,28 +47,7 @@
26
47
  "graphql": "16.8.1",
27
48
  "rfc6902": "5.0.1"
28
49
  },
29
- "main": "dist/cjs/index.cjs",
30
- "module": "dist/esm/index.mjs",
31
- "types": "dist/types.d.ts",
32
- "exports": {
33
- "types": "./dist/types.d.ts",
34
- "require": "./dist/cjs/index.cjs",
35
- "import": "./dist/esm/index.mjs"
36
- },
37
- "sideEffects": false,
38
- "keywords": [
39
- "medplum",
40
- "fhir",
41
- "healthcare",
42
- "interoperability",
43
- "json",
44
- "serialization",
45
- "hl7",
46
- "standards",
47
- "clinical",
48
- "dstu2",
49
- "stu3",
50
- "r4",
51
- "normative"
52
- ]
50
+ "engines": {
51
+ "node": ">=18.0.0"
52
+ }
53
53
  }
package/tsdoc.json ADDED
@@ -0,0 +1,4 @@
1
+ {
2
+ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
3
+ "extends": ["../../tsdoc.json"]
4
+ }