@openmrs/esm-api 3.1.15-pre.692 → 3.1.15-pre.707
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.
- package/README.md +0 -2
- package/package.json +6 -7
- package/docs/API.md +0 -724
- package/docs/classes/OpenmrsFetchError.md +0 -186
- package/docs/enums/VisitMode.md +0 -41
- package/docs/enums/VisitStatus.md +0 -30
- package/docs/interfaces/CurrentPatientOptions.md +0 -27
- package/docs/interfaces/CurrentUserOptions.md +0 -27
- package/docs/interfaces/CurrentUserWithResponseOption.md +0 -29
- package/docs/interfaces/CurrentUserWithoutResponseOption.md +0 -29
- package/docs/interfaces/FHIRCode.md +0 -30
- package/docs/interfaces/FHIRRequestObj.md +0 -41
- package/docs/interfaces/FHIRResource.md +0 -46
- package/docs/interfaces/FetchHeaders.md +0 -7
- package/docs/interfaces/FetchResponse.md +0 -285
- package/docs/interfaces/Location.md +0 -41
- package/docs/interfaces/LoggedInUser.md +0 -133
- package/docs/interfaces/LoggedInUserFetchResponse.md +0 -281
- package/docs/interfaces/NewVisitPayload.md +0 -74
- package/docs/interfaces/OnlyThePatient.md +0 -29
- package/docs/interfaces/OpenmrsResource.md +0 -34
- package/docs/interfaces/PatientWithFullResponse.md +0 -29
- package/docs/interfaces/Person.md +0 -41
- package/docs/interfaces/Privilege.md +0 -41
- package/docs/interfaces/Role.md +0 -41
- package/docs/interfaces/SessionLocation.md +0 -41
- package/docs/interfaces/SessionUser.md +0 -92
- package/docs/interfaces/UnauthenticatedUser.md +0 -52
- package/docs/interfaces/User.md +0 -107
- package/docs/interfaces/Visit.md +0 -111
- package/docs/interfaces/VisitItem.md +0 -52
- package/docs/interfaces/VisitType.md +0 -41
- package/docs/interfaces/WorkspaceItem.md +0 -74
- package/typedoc.json +0 -7
|
@@ -1,285 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-api](../API.md) / FetchResponse
|
|
2
|
-
|
|
3
|
-
# Interface: FetchResponse<T\>
|
|
4
|
-
|
|
5
|
-
## Type parameters
|
|
6
|
-
|
|
7
|
-
| Name | Type |
|
|
8
|
-
| :------ | :------ |
|
|
9
|
-
| `T` | `any` |
|
|
10
|
-
|
|
11
|
-
## Hierarchy
|
|
12
|
-
|
|
13
|
-
- `Response`
|
|
14
|
-
|
|
15
|
-
↳ **`FetchResponse`**
|
|
16
|
-
|
|
17
|
-
↳↳ [`LoggedInUserFetchResponse`](LoggedInUserFetchResponse.md)
|
|
18
|
-
|
|
19
|
-
## Table of contents
|
|
20
|
-
|
|
21
|
-
### Properties
|
|
22
|
-
|
|
23
|
-
- [body](FetchResponse.md#body)
|
|
24
|
-
- [bodyUsed](FetchResponse.md#bodyused)
|
|
25
|
-
- [data](FetchResponse.md#data)
|
|
26
|
-
- [headers](FetchResponse.md#headers)
|
|
27
|
-
- [ok](FetchResponse.md#ok)
|
|
28
|
-
- [redirected](FetchResponse.md#redirected)
|
|
29
|
-
- [status](FetchResponse.md#status)
|
|
30
|
-
- [statusText](FetchResponse.md#statustext)
|
|
31
|
-
- [type](FetchResponse.md#type)
|
|
32
|
-
- [url](FetchResponse.md#url)
|
|
33
|
-
|
|
34
|
-
### Methods
|
|
35
|
-
|
|
36
|
-
- [arrayBuffer](FetchResponse.md#arraybuffer)
|
|
37
|
-
- [blob](FetchResponse.md#blob)
|
|
38
|
-
- [clone](FetchResponse.md#clone)
|
|
39
|
-
- [formData](FetchResponse.md#formdata)
|
|
40
|
-
- [json](FetchResponse.md#json)
|
|
41
|
-
- [text](FetchResponse.md#text)
|
|
42
|
-
|
|
43
|
-
## Properties
|
|
44
|
-
|
|
45
|
-
### body
|
|
46
|
-
|
|
47
|
-
• `Readonly` **body**: ``null`` \| `ReadableStream`<`Uint8Array`\>
|
|
48
|
-
|
|
49
|
-
#### Inherited from
|
|
50
|
-
|
|
51
|
-
Response.body
|
|
52
|
-
|
|
53
|
-
#### Defined in
|
|
54
|
-
|
|
55
|
-
node_modules/typescript/lib/lib.dom.d.ts:2444
|
|
56
|
-
|
|
57
|
-
___
|
|
58
|
-
|
|
59
|
-
### bodyUsed
|
|
60
|
-
|
|
61
|
-
• `Readonly` **bodyUsed**: `boolean`
|
|
62
|
-
|
|
63
|
-
#### Inherited from
|
|
64
|
-
|
|
65
|
-
Response.bodyUsed
|
|
66
|
-
|
|
67
|
-
#### Defined in
|
|
68
|
-
|
|
69
|
-
node_modules/typescript/lib/lib.dom.d.ts:2445
|
|
70
|
-
|
|
71
|
-
___
|
|
72
|
-
|
|
73
|
-
### data
|
|
74
|
-
|
|
75
|
-
• **data**: `T`
|
|
76
|
-
|
|
77
|
-
#### Defined in
|
|
78
|
-
|
|
79
|
-
[packages/framework/esm-api/src/types/fetch.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/fetch.ts#L4)
|
|
80
|
-
|
|
81
|
-
___
|
|
82
|
-
|
|
83
|
-
### headers
|
|
84
|
-
|
|
85
|
-
• `Readonly` **headers**: `Headers`
|
|
86
|
-
|
|
87
|
-
#### Inherited from
|
|
88
|
-
|
|
89
|
-
Response.headers
|
|
90
|
-
|
|
91
|
-
#### Defined in
|
|
92
|
-
|
|
93
|
-
node_modules/typescript/lib/lib.dom.d.ts:12143
|
|
94
|
-
|
|
95
|
-
___
|
|
96
|
-
|
|
97
|
-
### ok
|
|
98
|
-
|
|
99
|
-
• `Readonly` **ok**: `boolean`
|
|
100
|
-
|
|
101
|
-
#### Inherited from
|
|
102
|
-
|
|
103
|
-
Response.ok
|
|
104
|
-
|
|
105
|
-
#### Defined in
|
|
106
|
-
|
|
107
|
-
node_modules/typescript/lib/lib.dom.d.ts:12144
|
|
108
|
-
|
|
109
|
-
___
|
|
110
|
-
|
|
111
|
-
### redirected
|
|
112
|
-
|
|
113
|
-
• `Readonly` **redirected**: `boolean`
|
|
114
|
-
|
|
115
|
-
#### Inherited from
|
|
116
|
-
|
|
117
|
-
Response.redirected
|
|
118
|
-
|
|
119
|
-
#### Defined in
|
|
120
|
-
|
|
121
|
-
node_modules/typescript/lib/lib.dom.d.ts:12145
|
|
122
|
-
|
|
123
|
-
___
|
|
124
|
-
|
|
125
|
-
### status
|
|
126
|
-
|
|
127
|
-
• `Readonly` **status**: `number`
|
|
128
|
-
|
|
129
|
-
#### Inherited from
|
|
130
|
-
|
|
131
|
-
Response.status
|
|
132
|
-
|
|
133
|
-
#### Defined in
|
|
134
|
-
|
|
135
|
-
node_modules/typescript/lib/lib.dom.d.ts:12146
|
|
136
|
-
|
|
137
|
-
___
|
|
138
|
-
|
|
139
|
-
### statusText
|
|
140
|
-
|
|
141
|
-
• `Readonly` **statusText**: `string`
|
|
142
|
-
|
|
143
|
-
#### Inherited from
|
|
144
|
-
|
|
145
|
-
Response.statusText
|
|
146
|
-
|
|
147
|
-
#### Defined in
|
|
148
|
-
|
|
149
|
-
node_modules/typescript/lib/lib.dom.d.ts:12147
|
|
150
|
-
|
|
151
|
-
___
|
|
152
|
-
|
|
153
|
-
### type
|
|
154
|
-
|
|
155
|
-
• `Readonly` **type**: `ResponseType`
|
|
156
|
-
|
|
157
|
-
#### Inherited from
|
|
158
|
-
|
|
159
|
-
Response.type
|
|
160
|
-
|
|
161
|
-
#### Defined in
|
|
162
|
-
|
|
163
|
-
node_modules/typescript/lib/lib.dom.d.ts:12148
|
|
164
|
-
|
|
165
|
-
___
|
|
166
|
-
|
|
167
|
-
### url
|
|
168
|
-
|
|
169
|
-
• `Readonly` **url**: `string`
|
|
170
|
-
|
|
171
|
-
#### Inherited from
|
|
172
|
-
|
|
173
|
-
Response.url
|
|
174
|
-
|
|
175
|
-
#### Defined in
|
|
176
|
-
|
|
177
|
-
node_modules/typescript/lib/lib.dom.d.ts:12149
|
|
178
|
-
|
|
179
|
-
## Methods
|
|
180
|
-
|
|
181
|
-
### arrayBuffer
|
|
182
|
-
|
|
183
|
-
▸ **arrayBuffer**(): `Promise`<`ArrayBuffer`\>
|
|
184
|
-
|
|
185
|
-
#### Returns
|
|
186
|
-
|
|
187
|
-
`Promise`<`ArrayBuffer`\>
|
|
188
|
-
|
|
189
|
-
#### Inherited from
|
|
190
|
-
|
|
191
|
-
Response.arrayBuffer
|
|
192
|
-
|
|
193
|
-
#### Defined in
|
|
194
|
-
|
|
195
|
-
node_modules/typescript/lib/lib.dom.d.ts:2446
|
|
196
|
-
|
|
197
|
-
___
|
|
198
|
-
|
|
199
|
-
### blob
|
|
200
|
-
|
|
201
|
-
▸ **blob**(): `Promise`<`Blob`\>
|
|
202
|
-
|
|
203
|
-
#### Returns
|
|
204
|
-
|
|
205
|
-
`Promise`<`Blob`\>
|
|
206
|
-
|
|
207
|
-
#### Inherited from
|
|
208
|
-
|
|
209
|
-
Response.blob
|
|
210
|
-
|
|
211
|
-
#### Defined in
|
|
212
|
-
|
|
213
|
-
node_modules/typescript/lib/lib.dom.d.ts:2447
|
|
214
|
-
|
|
215
|
-
___
|
|
216
|
-
|
|
217
|
-
### clone
|
|
218
|
-
|
|
219
|
-
▸ **clone**(): `Response`
|
|
220
|
-
|
|
221
|
-
#### Returns
|
|
222
|
-
|
|
223
|
-
`Response`
|
|
224
|
-
|
|
225
|
-
#### Inherited from
|
|
226
|
-
|
|
227
|
-
Response.clone
|
|
228
|
-
|
|
229
|
-
#### Defined in
|
|
230
|
-
|
|
231
|
-
node_modules/typescript/lib/lib.dom.d.ts:12150
|
|
232
|
-
|
|
233
|
-
___
|
|
234
|
-
|
|
235
|
-
### formData
|
|
236
|
-
|
|
237
|
-
▸ **formData**(): `Promise`<`FormData`\>
|
|
238
|
-
|
|
239
|
-
#### Returns
|
|
240
|
-
|
|
241
|
-
`Promise`<`FormData`\>
|
|
242
|
-
|
|
243
|
-
#### Inherited from
|
|
244
|
-
|
|
245
|
-
Response.formData
|
|
246
|
-
|
|
247
|
-
#### Defined in
|
|
248
|
-
|
|
249
|
-
node_modules/typescript/lib/lib.dom.d.ts:2448
|
|
250
|
-
|
|
251
|
-
___
|
|
252
|
-
|
|
253
|
-
### json
|
|
254
|
-
|
|
255
|
-
▸ **json**(): `Promise`<`any`\>
|
|
256
|
-
|
|
257
|
-
#### Returns
|
|
258
|
-
|
|
259
|
-
`Promise`<`any`\>
|
|
260
|
-
|
|
261
|
-
#### Inherited from
|
|
262
|
-
|
|
263
|
-
Response.json
|
|
264
|
-
|
|
265
|
-
#### Defined in
|
|
266
|
-
|
|
267
|
-
node_modules/typescript/lib/lib.dom.d.ts:2449
|
|
268
|
-
|
|
269
|
-
___
|
|
270
|
-
|
|
271
|
-
### text
|
|
272
|
-
|
|
273
|
-
▸ **text**(): `Promise`<`string`\>
|
|
274
|
-
|
|
275
|
-
#### Returns
|
|
276
|
-
|
|
277
|
-
`Promise`<`string`\>
|
|
278
|
-
|
|
279
|
-
#### Inherited from
|
|
280
|
-
|
|
281
|
-
Response.text
|
|
282
|
-
|
|
283
|
-
#### Defined in
|
|
284
|
-
|
|
285
|
-
node_modules/typescript/lib/lib.dom.d.ts:2450
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-api](../API.md) / Location
|
|
2
|
-
|
|
3
|
-
# Interface: Location
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [display](Location.md#display)
|
|
10
|
-
- [name](Location.md#name)
|
|
11
|
-
- [uuid](Location.md#uuid)
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### display
|
|
16
|
-
|
|
17
|
-
• `Optional` **display**: `string`
|
|
18
|
-
|
|
19
|
-
#### Defined in
|
|
20
|
-
|
|
21
|
-
[packages/framework/esm-api/src/types/visit-resource.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L29)
|
|
22
|
-
|
|
23
|
-
___
|
|
24
|
-
|
|
25
|
-
### name
|
|
26
|
-
|
|
27
|
-
• `Optional` **name**: `string`
|
|
28
|
-
|
|
29
|
-
#### Defined in
|
|
30
|
-
|
|
31
|
-
[packages/framework/esm-api/src/types/visit-resource.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L30)
|
|
32
|
-
|
|
33
|
-
___
|
|
34
|
-
|
|
35
|
-
### uuid
|
|
36
|
-
|
|
37
|
-
• **uuid**: `string`
|
|
38
|
-
|
|
39
|
-
#### Defined in
|
|
40
|
-
|
|
41
|
-
[packages/framework/esm-api/src/types/visit-resource.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L28)
|
|
@@ -1,133 +0,0 @@
|
|
|
1
|
-
[@openmrs/esm-api](../API.md) / LoggedInUser
|
|
2
|
-
|
|
3
|
-
# Interface: LoggedInUser
|
|
4
|
-
|
|
5
|
-
## Indexable
|
|
6
|
-
|
|
7
|
-
▪ [anythingElse: `string`]: `any`
|
|
8
|
-
|
|
9
|
-
## Table of contents
|
|
10
|
-
|
|
11
|
-
### Properties
|
|
12
|
-
|
|
13
|
-
- [allowedLocales](LoggedInUser.md#allowedlocales)
|
|
14
|
-
- [display](LoggedInUser.md#display)
|
|
15
|
-
- [locale](LoggedInUser.md#locale)
|
|
16
|
-
- [person](LoggedInUser.md#person)
|
|
17
|
-
- [privileges](LoggedInUser.md#privileges)
|
|
18
|
-
- [retired](LoggedInUser.md#retired)
|
|
19
|
-
- [roles](LoggedInUser.md#roles)
|
|
20
|
-
- [systemId](LoggedInUser.md#systemid)
|
|
21
|
-
- [userProperties](LoggedInUser.md#userproperties)
|
|
22
|
-
- [username](LoggedInUser.md#username)
|
|
23
|
-
- [uuid](LoggedInUser.md#uuid)
|
|
24
|
-
|
|
25
|
-
## Properties
|
|
26
|
-
|
|
27
|
-
### allowedLocales
|
|
28
|
-
|
|
29
|
-
• **allowedLocales**: `string`[]
|
|
30
|
-
|
|
31
|
-
#### Defined in
|
|
32
|
-
|
|
33
|
-
[packages/framework/esm-api/src/types/user-resource.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L24)
|
|
34
|
-
|
|
35
|
-
___
|
|
36
|
-
|
|
37
|
-
### display
|
|
38
|
-
|
|
39
|
-
• **display**: `string`
|
|
40
|
-
|
|
41
|
-
#### Defined in
|
|
42
|
-
|
|
43
|
-
[packages/framework/esm-api/src/types/user-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L15)
|
|
44
|
-
|
|
45
|
-
___
|
|
46
|
-
|
|
47
|
-
### locale
|
|
48
|
-
|
|
49
|
-
• **locale**: `string`
|
|
50
|
-
|
|
51
|
-
#### Defined in
|
|
52
|
-
|
|
53
|
-
[packages/framework/esm-api/src/types/user-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L23)
|
|
54
|
-
|
|
55
|
-
___
|
|
56
|
-
|
|
57
|
-
### person
|
|
58
|
-
|
|
59
|
-
• **person**: [`Person`](Person.md)
|
|
60
|
-
|
|
61
|
-
#### Defined in
|
|
62
|
-
|
|
63
|
-
[packages/framework/esm-api/src/types/user-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L19)
|
|
64
|
-
|
|
65
|
-
___
|
|
66
|
-
|
|
67
|
-
### privileges
|
|
68
|
-
|
|
69
|
-
• **privileges**: [`Privilege`](Privilege.md)[]
|
|
70
|
-
|
|
71
|
-
#### Defined in
|
|
72
|
-
|
|
73
|
-
[packages/framework/esm-api/src/types/user-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L20)
|
|
74
|
-
|
|
75
|
-
___
|
|
76
|
-
|
|
77
|
-
### retired
|
|
78
|
-
|
|
79
|
-
• **retired**: `boolean`
|
|
80
|
-
|
|
81
|
-
#### Defined in
|
|
82
|
-
|
|
83
|
-
[packages/framework/esm-api/src/types/user-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L22)
|
|
84
|
-
|
|
85
|
-
___
|
|
86
|
-
|
|
87
|
-
### roles
|
|
88
|
-
|
|
89
|
-
• **roles**: [`Role`](Role.md)[]
|
|
90
|
-
|
|
91
|
-
#### Defined in
|
|
92
|
-
|
|
93
|
-
[packages/framework/esm-api/src/types/user-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L21)
|
|
94
|
-
|
|
95
|
-
___
|
|
96
|
-
|
|
97
|
-
### systemId
|
|
98
|
-
|
|
99
|
-
• **systemId**: `string`
|
|
100
|
-
|
|
101
|
-
#### Defined in
|
|
102
|
-
|
|
103
|
-
[packages/framework/esm-api/src/types/user-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L17)
|
|
104
|
-
|
|
105
|
-
___
|
|
106
|
-
|
|
107
|
-
### userProperties
|
|
108
|
-
|
|
109
|
-
• **userProperties**: `any`
|
|
110
|
-
|
|
111
|
-
#### Defined in
|
|
112
|
-
|
|
113
|
-
[packages/framework/esm-api/src/types/user-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L18)
|
|
114
|
-
|
|
115
|
-
___
|
|
116
|
-
|
|
117
|
-
### username
|
|
118
|
-
|
|
119
|
-
• **username**: `string`
|
|
120
|
-
|
|
121
|
-
#### Defined in
|
|
122
|
-
|
|
123
|
-
[packages/framework/esm-api/src/types/user-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L16)
|
|
124
|
-
|
|
125
|
-
___
|
|
126
|
-
|
|
127
|
-
### uuid
|
|
128
|
-
|
|
129
|
-
• **uuid**: `string`
|
|
130
|
-
|
|
131
|
-
#### Defined in
|
|
132
|
-
|
|
133
|
-
[packages/framework/esm-api/src/types/user-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L14)
|