@openmrs/esm-framework 4.0.0-pre.1 → 4.0.1-pre.208

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 (91) hide show
  1. package/.turbo/turbo-build.log +23 -119
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.LICENSE.txt +0 -22
  4. package/dist/openmrs-esm-framework.js.map +1 -1
  5. package/docs/API.md +330 -774
  6. package/docs/classes/OpenmrsFetchError.md +4 -10
  7. package/docs/enums/Type.md +20 -20
  8. package/docs/enums/VisitMode.md +8 -8
  9. package/docs/enums/VisitStatus.md +6 -6
  10. package/docs/interfaces/AssignedExtension.md +7 -9
  11. package/docs/interfaces/BreadcrumbRegistration.md +2 -2
  12. package/docs/interfaces/BreadcrumbSettings.md +4 -22
  13. package/docs/interfaces/CancelLoading.md +1 -1
  14. package/docs/interfaces/ClearDynamicRoutesMessage.md +1 -1
  15. package/docs/interfaces/ComponentDefinition.md +7 -19
  16. package/docs/interfaces/Config.md +3 -17
  17. package/docs/interfaces/ConfigObject.md +14 -17
  18. package/docs/interfaces/ConfigSchema.md +3 -3
  19. package/docs/interfaces/ConfigurableLinkProps.md +2 -2
  20. package/docs/interfaces/ConnectedExtension.md +4 -6
  21. package/docs/interfaces/ConnectivityChangedEvent.md +1 -1
  22. package/docs/interfaces/CurrentPatientOptions.md +1 -1
  23. package/docs/interfaces/DisplayConditionsConfigObject.md +19 -0
  24. package/docs/interfaces/DynamicOfflineData.md +5 -20
  25. package/docs/interfaces/DynamicOfflineDataHandler.md +9 -26
  26. package/docs/interfaces/DynamicOfflineDataSyncState.md +5 -17
  27. package/docs/interfaces/ErrorStateProps.md +2 -2
  28. package/docs/interfaces/ExtensionData.md +3 -3
  29. package/docs/interfaces/ExtensionDefinition.md +13 -37
  30. package/docs/interfaces/ExtensionProps.md +2 -2
  31. package/docs/interfaces/ExtensionRegistration.md +18 -7
  32. package/docs/interfaces/ExtensionSlotBaseProps.md +15 -4
  33. package/docs/interfaces/ExtensionSlotConfig.md +4 -4
  34. package/docs/interfaces/ExtensionSlotConfigObject.md +3 -9
  35. package/docs/interfaces/ExtensionSlotState.md +2 -2
  36. package/docs/interfaces/ExtensionStore.md +1 -1
  37. package/docs/interfaces/FHIRCode.md +3 -3
  38. package/docs/interfaces/FHIRRequestObj.md +3 -3
  39. package/docs/interfaces/FHIRRequestOptions.md +41 -0
  40. package/docs/interfaces/FHIRResource.md +1 -1
  41. package/docs/interfaces/FetchResponse.md +1 -1
  42. package/docs/interfaces/FetchResponseJson.md +7 -0
  43. package/docs/interfaces/ImportMap.md +1 -1
  44. package/docs/interfaces/Lifecycle.md +4 -4
  45. package/docs/interfaces/Location.md +3 -3
  46. package/docs/interfaces/LoggedInUser.md +11 -11
  47. package/docs/interfaces/LoggedInUserFetchResponse.md +1 -1
  48. package/docs/interfaces/MessageServiceWorkerResult.md +3 -3
  49. package/docs/interfaces/NavigateOptions.md +2 -2
  50. package/docs/interfaces/NewVisitPayload.md +6 -6
  51. package/docs/interfaces/NotificationDescriptor.md +6 -6
  52. package/docs/interfaces/OfflineModeResult.md +3 -3
  53. package/docs/interfaces/OfflinePatientArgs.md +2 -4
  54. package/docs/interfaces/OfflinePatientDataSyncHandler.md +2 -4
  55. package/docs/interfaces/OfflinePatientDataSyncState.md +6 -8
  56. package/docs/interfaces/OfflinePatientDataSyncStore.md +2 -4
  57. package/docs/interfaces/OldExtensionSlotBaseProps.md +65 -0
  58. package/docs/interfaces/OmrsServiceWorkerMessage.md +1 -1
  59. package/docs/interfaces/OnImportMapChangedMessage.md +2 -2
  60. package/docs/interfaces/OnlyThePatient.md +1 -1
  61. package/docs/interfaces/OpenmrsResource.md +2 -2
  62. package/docs/interfaces/PageDefinition.md +9 -25
  63. package/docs/interfaces/PatientWithFullResponse.md +1 -1
  64. package/docs/interfaces/Person.md +3 -3
  65. package/docs/interfaces/Privilege.md +3 -3
  66. package/docs/interfaces/QueueItemDescriptor.md +4 -9
  67. package/docs/interfaces/RegisterDynamicRouteMessage.md +4 -4
  68. package/docs/interfaces/ResourceLoader.md +1 -1
  69. package/docs/interfaces/RetryOptions.md +7 -18
  70. package/docs/interfaces/Role.md +3 -3
  71. package/docs/interfaces/Session.md +7 -7
  72. package/docs/interfaces/SessionLocation.md +3 -3
  73. package/docs/interfaces/ShowNotificationEvent.md +5 -5
  74. package/docs/interfaces/ShowToastEvent.md +4 -4
  75. package/docs/interfaces/SpaConfig.md +5 -19
  76. package/docs/interfaces/SyncItem.md +7 -11
  77. package/docs/interfaces/SyncProcessOptions.md +5 -7
  78. package/docs/interfaces/ToastDescriptor.md +5 -5
  79. package/docs/interfaces/ToastNotificationMeta.md +6 -6
  80. package/docs/interfaces/UserHasAccessProps.md +4 -4
  81. package/docs/interfaces/Visit.md +9 -9
  82. package/docs/interfaces/VisitItem.md +4 -4
  83. package/docs/interfaces/VisitType.md +3 -3
  84. package/jest.config.js +3 -0
  85. package/mock.tsx +3 -7
  86. package/package.json +13 -13
  87. package/src/integration-tests/extension-config.test.tsx +215 -17
  88. package/typedoc.json +1 -1
  89. package/.turbo/turbo-lint.log +0 -2
  90. package/.turbo/turbo-test.log +0 -451
  91. package/.turbo/turbo-typescript.log +0 -2
package/docs/API.md CHANGED
@@ -30,7 +30,7 @@
30
30
  - [useSession](API.md#usesession)
31
31
  - [useVisit](API.md#usevisit)
32
32
  - [useVisitTypes](API.md#usevisittypes)
33
- - [userHasAccess](API.md#userhasaccess)
33
+ - [userHasAccess](API.md#userhasaccess-1)
34
34
 
35
35
  ### Breadcrumb Functions
36
36
 
@@ -54,7 +54,7 @@
54
54
  - [isUrl](API.md#isurl)
55
55
  - [isUrlWithTemplateParameters](API.md#isurlwithtemplateparameters)
56
56
  - [oneOf](API.md#oneof)
57
- - [validator](API.md#validator)
57
+ - [validator](API.md#validator-1)
58
58
 
59
59
  ### Date and Time Functions
60
60
 
@@ -140,6 +140,10 @@
140
140
  - [syncOfflinePatientData](API.md#syncofflinepatientdata)
141
141
  - [useConnectivity](API.md#useconnectivity)
142
142
 
143
+ ### Other Functions
144
+
145
+ - [ExtensionSlot](API.md#extensionslot)
146
+
143
147
  ### Store Functions
144
148
 
145
149
  - [createGlobalStore](API.md#createglobalstore)
@@ -174,7 +178,7 @@
174
178
  - [retry](API.md#retry)
175
179
  - [translateFrom](API.md#translatefrom)
176
180
 
177
- ## API Type aliases
181
+ ## API Type Aliases
178
182
 
179
183
  ### CurrentPatient
180
184
 
@@ -182,7 +186,7 @@
182
186
 
183
187
  #### Defined in
184
188
 
185
- [packages/framework/esm-api/src/shared-api-objects/current-patient.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L5)
189
+ [packages/framework/esm-api/src/shared-api-objects/current-patient.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L5)
186
190
 
187
191
  ___
188
192
 
@@ -199,7 +203,7 @@ ___
199
203
 
200
204
  #### Defined in
201
205
 
202
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L16)
206
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L17)
203
207
 
204
208
  ___
205
209
 
@@ -209,7 +213,7 @@ ___
209
213
 
210
214
  #### Defined in
211
215
 
212
- [packages/framework/esm-react-utils/src/usePatient.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/usePatient.ts#L5)
216
+ [packages/framework/esm-react-utils/src/usePatient.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/usePatient.ts#L5)
213
217
 
214
218
  ___
215
219
 
@@ -219,7 +223,7 @@ ___
219
223
 
220
224
  #### Defined in
221
225
 
222
- [packages/framework/esm-api/src/shared-api-objects/current-patient.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L19)
226
+ [packages/framework/esm-api/src/shared-api-objects/current-patient.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L19)
223
227
 
224
228
  ___
225
229
 
@@ -229,7 +233,7 @@ ___
229
233
 
230
234
  #### Defined in
231
235
 
232
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L14)
236
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L15)
233
237
 
234
238
  ___
235
239
 
@@ -246,11 +250,11 @@ ___
246
250
 
247
251
  #### Defined in
248
252
 
249
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L21)
253
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L22)
250
254
 
251
255
  ___
252
256
 
253
- ## Date and Time Type aliases
257
+ ## Date and Time Type Aliases
254
258
 
255
259
  ### DateInput
256
260
 
@@ -258,7 +262,7 @@ ___
258
262
 
259
263
  #### Defined in
260
264
 
261
- [packages/framework/esm-utils/src/omrs-dates.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L19)
265
+ [packages/framework/esm-utils/src/omrs-dates.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L19)
262
266
 
263
267
  ___
264
268
 
@@ -268,7 +272,7 @@ ___
268
272
 
269
273
  #### Defined in
270
274
 
271
- [packages/framework/esm-utils/src/omrs-dates.ts:140](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L140)
275
+ [packages/framework/esm-utils/src/omrs-dates.ts:140](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L140)
272
276
 
273
277
  ___
274
278
 
@@ -280,18 +284,18 @@ ___
280
284
 
281
285
  | Name | Type | Description |
282
286
  | :------ | :------ | :------ |
283
- | `day` | `boolean` | Whether to include the day number |
284
- | `mode` | [`FormatDateMode`](API.md#formatdatemode) | - `standard`: "03 Feb 2022" - `wide`: "03 — Feb — 2022" |
285
- | `time` | `boolean` \| ``"for today"`` | Whether the time should be included in the output always (`true`), never (`false`), or only when the input date is today (`for today`). |
286
- | `year` | `boolean` | Whether to include the year |
287
+ | `day` | `boolean` | |
288
+ | `mode` | [`FormatDateMode`](API.md#formatdatemode) | |
289
+ | `time` | `boolean` \| ``"for today"`` | |
290
+ | `year` | `boolean` | |
287
291
 
288
292
  #### Defined in
289
293
 
290
- [packages/framework/esm-utils/src/omrs-dates.ts:142](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L142)
294
+ [packages/framework/esm-utils/src/omrs-dates.ts:142](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L142)
291
295
 
292
296
  ___
293
297
 
294
- ## Navigation Type aliases
298
+ ## Navigation Type Aliases
295
299
 
296
300
  ### TemplateParams
297
301
 
@@ -303,11 +307,11 @@ ___
303
307
 
304
308
  #### Defined in
305
309
 
306
- [packages/framework/esm-config/src/navigation/navigate.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/navigation/navigate.ts#L10)
310
+ [packages/framework/esm-config/src/navigation/navigate.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/navigation/navigate.ts#L10)
307
311
 
308
312
  ___
309
313
 
310
- ## Offline Type aliases
314
+ ## Offline Type Aliases
311
315
 
312
316
  ### KnownOmrsServiceWorkerMessages
313
317
 
@@ -315,7 +319,7 @@ ___
315
319
 
316
320
  #### Defined in
317
321
 
318
- [packages/framework/esm-offline/src/service-worker-messaging.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L46)
322
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L46)
319
323
 
320
324
  ___
321
325
 
@@ -325,7 +329,7 @@ ___
325
329
 
326
330
  #### Defined in
327
331
 
328
- [packages/framework/esm-offline/src/mode.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L38)
332
+ [packages/framework/esm-offline/src/mode.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L38)
329
333
 
330
334
  ___
331
335
 
@@ -333,14 +337,9 @@ ___
333
337
 
334
338
  Ƭ **OmrsOfflineCachingStrategy**: ``"network-only-or-cache-only"`` \| ``"network-first"``
335
339
 
336
- * `cache-or-network`: The default strategy, equal to the absence of this header.
337
- The SW attempts to resolve the request via the network, but falls back to the cache if required.
338
- The service worker decides the strategy to be used.
339
- * `network-first`: See https://developers.google.com/web/tools/workbox/modules/workbox-strategies#network_first_network_falling_back_to_cache.
340
-
341
340
  #### Defined in
342
341
 
343
- [packages/framework/esm-offline/src/service-worker-http-headers.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-http-headers.ts#L18)
342
+ [packages/framework/esm-offline/src/service-worker-http-headers.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L18)
344
343
 
345
344
  ___
346
345
 
@@ -350,7 +349,7 @@ ___
350
349
 
351
350
  #### Defined in
352
351
 
353
- [packages/framework/esm-offline/src/service-worker-http-headers.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-http-headers.ts#L45)
352
+ [packages/framework/esm-offline/src/service-worker-http-headers.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L45)
354
353
 
355
354
  ___
356
355
 
@@ -358,24 +357,21 @@ ___
358
357
 
359
358
  Ƭ **OmrsOfflineHttpHeaders**: `Object`
360
359
 
361
- Defines the keys of the custom headers which can be appended to an HTTP request.
362
- HTTP requests with these headers are handled in a special way by the SPA's service worker.
363
-
364
360
  #### Type declaration
365
361
 
366
362
  | Name | Type | Description |
367
363
  | :------ | :------ | :------ |
368
- | `x-omrs-offline-caching-strategy?` | [`OmrsOfflineCachingStrategy`](API.md#omrsofflinecachingstrategy) | Instructs the service worker to use a specific caching strategy for this request. |
369
- | `x-omrs-offline-response-body?` | `string` | If the client is offline and the request cannot be read from the cache (i.e. if there is no way to receive any kind of data for this request), the service worker will return a response with the body in this header. |
370
- | `x-omrs-offline-response-status?` | \`${number}\` | If the client is offline and the request cannot be read from the cache (i.e. if there is no way to receive any kind of data for this request), the service worker will return a response with the status code defined in this header. |
364
+ | `x-omrs-offline-caching-strategy?` | [`OmrsOfflineCachingStrategy`](API.md#omrsofflinecachingstrategy) | |
365
+ | `x-omrs-offline-response-body?` | `string` | |
366
+ | `x-omrs-offline-response-status?` | \`${number}\` | |
371
367
 
372
368
  #### Defined in
373
369
 
374
- [packages/framework/esm-offline/src/service-worker-http-headers.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-http-headers.ts#L26)
370
+ [packages/framework/esm-offline/src/service-worker-http-headers.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L26)
375
371
 
376
372
  ___
377
373
 
378
- ## Other Type aliases
374
+ ## Other Type Aliases
379
375
 
380
376
  ### ConfigValue
381
377
 
@@ -383,17 +379,17 @@ ___
383
379
 
384
380
  #### Defined in
385
381
 
386
- [packages/framework/esm-config/src/types.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L32)
382
+ [packages/framework/esm-config/src/types.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L37)
387
383
 
388
384
  ___
389
385
 
390
386
  ### ExtensionSlotProps
391
387
 
392
- Ƭ **ExtensionSlotProps**: [`ExtensionSlotBaseProps`](interfaces/ExtensionSlotBaseProps.md) & `React.HTMLAttributes`<`HTMLDivElement`\>
388
+ Ƭ **ExtensionSlotProps**: [`OldExtensionSlotBaseProps`](interfaces/OldExtensionSlotBaseProps.md) \| [`ExtensionSlotBaseProps`](interfaces/ExtensionSlotBaseProps.md) & `Omit`<`React.HTMLAttributes`<`HTMLDivElement`\>, ``"children"``\> & { `children?`: `React.ReactNode` \| (`extension`: [`ConnectedExtension`](interfaces/ConnectedExtension.md)) => `React.ReactNode` }
393
389
 
394
390
  #### Defined in
395
391
 
396
- [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L48)
392
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L23)
397
393
 
398
394
  ___
399
395
 
@@ -410,7 +406,7 @@ ___
410
406
 
411
407
  #### Defined in
412
408
 
413
- [packages/framework/esm-config/src/types.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L60)
409
+ [packages/framework/esm-config/src/types.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L65)
414
410
 
415
411
  ___
416
412
 
@@ -420,7 +416,7 @@ ___
420
416
 
421
417
  #### Defined in
422
418
 
423
- [packages/framework/esm-globals/src/types.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L53)
419
+ [packages/framework/esm-globals/src/types.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L53)
424
420
 
425
421
  ___
426
422
 
@@ -430,7 +426,7 @@ ___
430
426
 
431
427
  #### Defined in
432
428
 
433
- [packages/framework/esm-api/src/types/visit-resource.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L12)
429
+ [packages/framework/esm-api/src/types/visit-resource.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/visit-resource.ts#L12)
434
430
 
435
431
  ___
436
432
 
@@ -454,7 +450,7 @@ ___
454
450
 
455
451
  #### Defined in
456
452
 
457
- [packages/framework/esm-config/src/types.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L67)
453
+ [packages/framework/esm-config/src/types.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L72)
458
454
 
459
455
  ___
460
456
 
@@ -478,11 +474,11 @@ ___
478
474
 
479
475
  #### Defined in
480
476
 
481
- [packages/framework/esm-config/src/types.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L65)
477
+ [packages/framework/esm-config/src/types.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L70)
482
478
 
483
479
  ___
484
480
 
485
- ## Store Type aliases
481
+ ## Store Type Aliases
486
482
 
487
483
  ### Actions
488
484
 
@@ -490,7 +486,7 @@ ___
490
486
 
491
487
  #### Defined in
492
488
 
493
- [packages/framework/esm-react-utils/src/createUseStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/createUseStore.ts#L5)
489
+ [packages/framework/esm-react-utils/src/createUseStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/createUseStore.ts#L5)
494
490
 
495
491
  ___
496
492
 
@@ -504,11 +500,11 @@ ___
504
500
 
505
501
  #### Defined in
506
502
 
507
- [packages/framework/esm-react-utils/src/createUseStore.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/createUseStore.ts#L6)
503
+ [packages/framework/esm-react-utils/src/createUseStore.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/createUseStore.ts#L6)
508
504
 
509
505
  ___
510
506
 
511
- ## UI Type aliases
507
+ ## UI Type Aliases
512
508
 
513
509
  ### InlineNotificationType
514
510
 
@@ -516,7 +512,7 @@ ___
516
512
 
517
513
  #### Defined in
518
514
 
519
- [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L22)
515
+ [packages/framework/esm-styleguide/src/notifications/notification.component.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L22)
520
516
 
521
517
  ___
522
518
 
@@ -526,7 +522,7 @@ ___
526
522
 
527
523
  #### Defined in
528
524
 
529
- [packages/framework/esm-react-utils/src/useLayoutType.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useLayoutType.ts#L4)
525
+ [packages/framework/esm-react-utils/src/useLayoutType.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLayoutType.ts#L4)
530
526
 
531
527
  ___
532
528
 
@@ -536,7 +532,7 @@ ___
536
532
 
537
533
  #### Defined in
538
534
 
539
- [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L26)
535
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L26)
540
536
 
541
537
  ## API Variables
542
538
 
@@ -546,7 +542,7 @@ ___
546
542
 
547
543
  #### Defined in
548
544
 
549
- [packages/framework/esm-react-utils/src/UserHasAccess.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L11)
545
+ [packages/framework/esm-react-utils/src/UserHasAccess.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L11)
550
546
 
551
547
  ___
552
548
 
@@ -556,22 +552,23 @@ ___
556
552
 
557
553
  #### Defined in
558
554
 
559
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L12)
555
+ [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L12)
560
556
 
561
557
  ___
562
558
 
563
559
  ### fhir
564
560
 
565
- • `Const` **fhir**: `FhirClient`
561
+ • `Const` **fhir**: `Object`
562
+
563
+ #### Type declaration
566
564
 
567
- The `fhir` object is [an instance of fhir.js](https://github.com/FHIR/fhir.js)
568
- that can be used to call FHIR-compliant OpenMRS APIs. See
569
- [the docs for fhir.js](https://github.com/FHIR/fhir.js) for more info
570
- and example usage.
565
+ | Name | Type |
566
+ | :------ | :------ |
567
+ | `read` | <T\>(`options`: [`FHIRRequestOptions`](interfaces/FHIRRequestOptions.md)) => `Promise`<{ `config`: [`FHIRRequestObj`](interfaces/FHIRRequestObj.md) ; `data`: `T` ; `headers`: `Headers` ; `status`: `number` }\> |
571
568
 
572
569
  #### Defined in
573
570
 
574
- [packages/framework/esm-api/src/fhir.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L42)
571
+ [packages/framework/esm-api/src/fhir.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/fhir.ts#L45)
575
572
 
576
573
  ___
577
574
 
@@ -581,7 +578,7 @@ ___
581
578
 
582
579
  #### Defined in
583
580
 
584
- [packages/framework/esm-api/src/fhir.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L5)
581
+ [packages/framework/esm-api/src/fhir.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/fhir.ts#L5)
585
582
 
586
583
  ___
587
584
 
@@ -591,7 +588,7 @@ ___
591
588
 
592
589
  #### Defined in
593
590
 
594
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L74)
591
+ [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L74)
595
592
 
596
593
  ___
597
594
 
@@ -601,7 +598,7 @@ ___
601
598
 
602
599
  #### Defined in
603
600
 
604
- [packages/framework/esm-api/src/openmrs-fetch.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L12)
601
+ [packages/framework/esm-api/src/openmrs-fetch.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L7)
605
602
 
606
603
  ___
607
604
 
@@ -622,7 +619,7 @@ ___
622
619
 
623
620
  #### Defined in
624
621
 
625
- [packages/framework/esm-config/src/validators/validators.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validators.ts#L69)
622
+ [packages/framework/esm-config/src/validators/validators.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L69)
626
623
 
627
624
  ___
628
625
 
@@ -634,7 +631,7 @@ ___
634
631
 
635
632
  #### Defined in
636
633
 
637
- [packages/framework/esm-offline/src/uuid.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/uuid.ts#L4)
634
+ [packages/framework/esm-offline/src/uuid.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid.ts#L4)
638
635
 
639
636
  ___
640
637
 
@@ -644,7 +641,7 @@ ___
644
641
 
645
642
  #### Defined in
646
643
 
647
- [packages/framework/esm-offline/src/service-worker-http-headers.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-http-headers.ts#L7)
644
+ [packages/framework/esm-offline/src/service-worker-http-headers.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L7)
648
645
 
649
646
  ___
650
647
 
@@ -654,7 +651,7 @@ ___
654
651
 
655
652
  #### Defined in
656
653
 
657
- [packages/framework/esm-offline/src/service-worker-http-headers.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-http-headers.ts#L3)
654
+ [packages/framework/esm-offline/src/service-worker-http-headers.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L3)
658
655
 
659
656
  ___
660
657
 
@@ -664,7 +661,7 @@ ___
664
661
 
665
662
  #### Defined in
666
663
 
667
- [packages/framework/esm-offline/src/service-worker-http-headers.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-http-headers.ts#L5)
664
+ [packages/framework/esm-offline/src/service-worker-http-headers.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L5)
668
665
 
669
666
  ___
670
667
 
@@ -676,7 +673,7 @@ ___
676
673
 
677
674
  #### Defined in
678
675
 
679
- [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L12)
676
+ [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L12)
680
677
 
681
678
  ___
682
679
 
@@ -684,27 +681,9 @@ ___
684
681
 
685
682
  • `Const` **Extension**: `React.FC`<[`ExtensionProps`](interfaces/ExtensionProps.md)\>
686
683
 
687
- Represents the position in the DOM where each extension within
688
- an extension slot is rendered.
689
-
690
- Renders once for each extension attached to that extension slot.
691
-
692
- Usage of this component *must* have an ancestor `<ExtensionSlot>`,
693
- and *must* only be used once within that `<ExtensionSlot>`.
694
-
695
- #### Defined in
696
-
697
- [packages/framework/esm-react-utils/src/Extension.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L23)
698
-
699
- ___
700
-
701
- ### ExtensionSlot
702
-
703
- • `Const` **ExtensionSlot**: `React.FC`<[`ExtensionSlotProps`](API.md#extensionslotprops)\>
704
-
705
684
  #### Defined in
706
685
 
707
- [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L55)
686
+ [packages/framework/esm-react-utils/src/Extension.tsx:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/Extension.tsx#L31)
708
687
 
709
688
  ___
710
689
 
@@ -721,7 +700,7 @@ ___
721
700
 
722
701
  #### Defined in
723
702
 
724
- [packages/framework/esm-api/src/openmrs-backend-dependencies.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-backend-dependencies.ts#L1)
703
+ [packages/framework/esm-api/src/openmrs-backend-dependencies.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-backend-dependencies.ts#L1)
725
704
 
726
705
  ___
727
706
 
@@ -733,7 +712,7 @@ ___
733
712
 
734
713
  #### Defined in
735
714
 
736
- [packages/framework/esm-styleguide/src/left-nav/index.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/left-nav/index.tsx#L32)
715
+ [packages/framework/esm-styleguide/src/left-nav/index.tsx:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L30)
737
716
 
738
717
  ## API Functions
739
718
 
@@ -747,28 +726,28 @@ ___
747
726
 
748
727
  #### Defined in
749
728
 
750
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:174](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L174)
729
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:188](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L188)
751
730
 
752
731
  ___
753
732
 
754
733
  ### fetchCurrentPatient
755
734
 
756
- ▸ **fetchCurrentPatient**(`patientUuid`, `contentOverrides?`): `Promise`<{ `data`: `Patient` }\> \| `Promise`<``null``\>
735
+ ▸ **fetchCurrentPatient**(`patientUuid`, `contentOverrides?`): `Promise`<{ `config`: [`FHIRRequestObj`](interfaces/FHIRRequestObj.md) ; `data`: `Patient` ; `headers`: `Headers` ; `status`: `number` }\> \| `Promise`<``null``\>
757
736
 
758
737
  #### Parameters
759
738
 
760
739
  | Name | Type |
761
740
  | :------ | :------ |
762
741
  | `patientUuid` | [`PatientUuid`](API.md#patientuuid) |
763
- | `contentOverrides?` | `Partial`<{ `headers?`: [`FetchHeaders`](interfaces/FetchHeaders.md) ; `id?`: `string` ; `patient?`: `string` ; `type`: `ResourceName` }\> |
742
+ | `contentOverrides?` | `Partial`<[`FHIRRequestOptions`](interfaces/FHIRRequestOptions.md)\> |
764
743
 
765
744
  #### Returns
766
745
 
767
- `Promise`<{ `data`: `Patient` }\> \| `Promise`<``null``\>
746
+ `Promise`<{ `config`: [`FHIRRequestObj`](interfaces/FHIRRequestObj.md) ; `data`: `Patient` ; `headers`: `Headers` ; `status`: `number` }\> \| `Promise`<``null``\>
768
747
 
769
748
  #### Defined in
770
749
 
771
- [packages/framework/esm-api/src/shared-api-objects/current-patient.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L21)
750
+ [packages/framework/esm-api/src/shared-api-objects/current-patient.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L21)
772
751
 
773
752
  ___
774
753
 
@@ -776,44 +755,13 @@ ___
776
755
 
777
756
  ▸ **getCurrentUser**(): `Observable`<[`Session`](interfaces/Session.md)\>
778
757
 
779
- The getCurrentUser function returns an observable that produces
780
- **zero or more values, over time**. It will produce zero values
781
- by default if the user is not logged in. And it will provide a
782
- first value when the logged in user is fetched from the server.
783
- Subsequent values will be produced whenever the user object is
784
- updated.
785
-
786
758
  #### Returns
787
759
 
788
760
  `Observable`<[`Session`](interfaces/Session.md)\>
789
761
 
790
- An Observable that produces zero or more values (as
791
- described above). The values produced will be a user object (if
792
- `includeAuthStatus` is set to `false`) or an object with a session
793
- and authenticated property (if `includeAuthStatus` is set to `true`).
794
-
795
- #### Example
796
-
797
- ```js
798
- import { getCurrentUser } from '@openmrs/esm-api'
799
- const subscription = getCurrentUser().subscribe(
800
- user => console.log(user)
801
- )
802
- subscription.unsubscribe()
803
- getCurrentUser({includeAuthStatus: true}).subscribe(
804
- data => console.log(data.authenticated)
805
- )
806
- ```
807
-
808
- #### Be sure to unsubscribe when your component unmounts
809
-
810
- Otherwise your code will continue getting updates to the user object
811
- even after the UI component is gone from the screen. This is a memory
812
- leak and source of bugs.
813
-
814
762
  #### Defined in
815
763
 
816
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L70)
764
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L71)
817
765
 
818
766
  ▸ **getCurrentUser**(`opts`): `Observable`<[`Session`](interfaces/Session.md)\>
819
767
 
@@ -830,7 +778,7 @@ leak and source of bugs.
830
778
 
831
779
  #### Defined in
832
780
 
833
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L71)
781
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L72)
834
782
 
835
783
  ▸ **getCurrentUser**(`opts`): `Observable`<[`LoggedInUser`](interfaces/LoggedInUser.md)\>
836
784
 
@@ -847,7 +795,7 @@ leak and source of bugs.
847
795
 
848
796
  #### Defined in
849
797
 
850
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L72)
798
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L73)
851
799
 
852
800
  ___
853
801
 
@@ -861,7 +809,7 @@ ___
861
809
 
862
810
  #### Defined in
863
811
 
864
- [packages/framework/esm-api/src/shared-api-objects/location.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/location.ts#L14)
812
+ [packages/framework/esm-api/src/shared-api-objects/location.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/location.ts#L14)
865
813
 
866
814
  ___
867
815
 
@@ -875,7 +823,7 @@ ___
875
823
 
876
824
  #### Defined in
877
825
 
878
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:188](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L188)
826
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:202](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L202)
879
827
 
880
828
  ___
881
829
 
@@ -889,7 +837,7 @@ ___
889
837
 
890
838
  #### Defined in
891
839
 
892
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:206](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L206)
840
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:220](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L220)
893
841
 
894
842
  ___
895
843
 
@@ -903,7 +851,7 @@ ___
903
851
 
904
852
  #### Defined in
905
853
 
906
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:104](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L104)
854
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:105](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L105)
907
855
 
908
856
  ___
909
857
 
@@ -917,7 +865,7 @@ ___
917
865
 
918
866
  #### Defined in
919
867
 
920
- [packages/framework/esm-api/src/shared-api-objects/visit-type.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-type.ts#L15)
868
+ [packages/framework/esm-api/src/shared-api-objects/visit-type.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-type.ts#L15)
921
869
 
922
870
  ___
923
871
 
@@ -939,7 +887,7 @@ ___
939
887
 
940
888
  #### Defined in
941
889
 
942
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L20)
890
+ [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L20)
943
891
 
944
892
  ___
945
893
 
@@ -947,15 +895,6 @@ ___
947
895
 
948
896
  ▸ **makeUrl**(`path`): `string`
949
897
 
950
- Append `path` to the OpenMRS SPA base.
951
-
952
- #### Example
953
-
954
- ```ts
955
- makeUrl('/foo/bar');
956
- // => '/openmrs/foo/bar'
957
- ```
958
-
959
898
  #### Parameters
960
899
 
961
900
  | Name | Type |
@@ -968,7 +907,7 @@ makeUrl('/foo/bar');
968
907
 
969
908
  #### Defined in
970
909
 
971
- [packages/framework/esm-api/src/openmrs-fetch.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L24)
910
+ [packages/framework/esm-api/src/openmrs-fetch.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L19)
972
911
 
973
912
  ___
974
913
 
@@ -976,11 +915,6 @@ ___
976
915
 
977
916
  ▸ **openmrsFetch**<`T`\>(`path`, `fetchInit?`): `Promise`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
978
917
 
979
- The openmrsFetch function is a wrapper around the
980
- [browser's built-in fetch function](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch),
981
- with extra handling for OpenMRS-specific API behaviors, such as
982
- request headers, authentication, authorization, and the API urls.
983
-
984
918
  #### Type parameters
985
919
 
986
920
  | Name | Type |
@@ -991,51 +925,16 @@ request headers, authentication, authorization, and the API urls.
991
925
 
992
926
  | Name | Type | Description |
993
927
  | :------ | :------ | :------ |
994
- | `path` | `string` | A string url to make the request to. Note that the openmrs base url (by default `/openmrs`) will be automatically prepended to the URL, so there is no need to include it. |
995
- | `fetchInit` | `FetchConfig` | A [fetch init object](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch#Syntax). Note that the `body` property does not need to be `JSON.stringify()`ed because openmrsFetch will do that for you. |
928
+ | `path` | `string` | |
929
+ | `fetchInit` | `FetchConfig` | |
996
930
 
997
931
  #### Returns
998
932
 
999
933
  `Promise`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
1000
934
 
1001
- A [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
1002
- that resolves with a [Response object](https://developer.mozilla.org/en-US/docs/Web/API/Response).
1003
- Note that the openmrs version of the Response object has already
1004
- downloaded the HTTP response body as json, and has an additional
1005
- `data` property with the HTTP response json as a javascript object.
1006
-
1007
- #### Example
1008
- ```js
1009
- import { openmrsFetch } from '@openmrs/esm-api'
1010
- const abortController = new AbortController();
1011
- openmrsFetch('/ws/rest/v1/session', {signal: abortController.signal})
1012
- .then(response => {
1013
- console.log(response.data.authenticated)
1014
- })
1015
- .catch(err => {
1016
- console.error(err.status);
1017
- })
1018
- abortController.abort();
1019
- openmrsFetch('/ws/rest/v1/session', {
1020
- method: 'POST',
1021
- body: {
1022
- username: 'hi',
1023
- password: 'there',
1024
- }
1025
- })
1026
- ```
1027
-
1028
- #### Cancellation
1029
-
1030
- To cancel a network request, use an
1031
- [AbortController](https://developer.mozilla.org/en-US/docs/Web/API/AbortController/abort).
1032
- It is best practice to cancel your network requests when the user
1033
- navigates away from a page while the request is pending request, to
1034
- free up memory and network resources and to prevent race conditions.
1035
-
1036
935
  #### Defined in
1037
936
 
1038
- [packages/framework/esm-api/src/openmrs-fetch.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L77)
937
+ [packages/framework/esm-api/src/openmrs-fetch.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L72)
1039
938
 
1040
939
  ___
1041
940
 
@@ -1043,11 +942,6 @@ ___
1043
942
 
1044
943
  ▸ **openmrsObservableFetch**<`T`\>(`url`, `fetchInit?`): `Observable`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
1045
944
 
1046
- The openmrsObservableFetch function is a wrapper around openmrsFetch
1047
- that returns an [Observable](https://rxjs-dev.firebaseapp.com/guide/observable)
1048
- instead of a promise. It exists in case using an Observable is
1049
- preferred or more convenient than a promise.
1050
-
1051
945
  #### Type parameters
1052
946
 
1053
947
  | Name |
@@ -1058,35 +952,16 @@ preferred or more convenient than a promise.
1058
952
 
1059
953
  | Name | Type | Description |
1060
954
  | :------ | :------ | :------ |
1061
- | `url` | `string` | See [openmrsFetch](API.md#openmrsfetch) |
1062
- | `fetchInit` | `FetchConfig` | See [openmrsFetch](API.md#openmrsfetch) |
955
+ | `url` | `string` | |
956
+ | `fetchInit` | `FetchConfig` | |
1063
957
 
1064
958
  #### Returns
1065
959
 
1066
960
  `Observable`<[`FetchResponse`](interfaces/FetchResponse.md)<`T`\>\>
1067
961
 
1068
- An Observable that produces exactly one Response object.
1069
- The response object is exactly the same as for [openmrsFetch](API.md#openmrsfetch).
1070
-
1071
- #### Example
1072
-
1073
- ```js
1074
- import { openmrsObservableFetch } from '@openmrs/esm-api'
1075
- const subscription = openmrsObservableFetch('/ws/rest/v1/session').subscribe(
1076
- response => console.log(response.data),
1077
- err => {throw err},
1078
- () => console.log('finished')
1079
- )
1080
- subscription.unsubscribe()
1081
- ```
1082
-
1083
- #### Cancellation
1084
-
1085
- To cancel the network request, simply call `subscription.unsubscribe();`
1086
-
1087
962
  #### Defined in
1088
963
 
1089
- [packages/framework/esm-api/src/openmrs-fetch.ts:248](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L248)
964
+ [packages/framework/esm-api/src/openmrs-fetch.ts:243](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L243)
1090
965
 
1091
966
  ___
1092
967
 
@@ -1094,25 +969,13 @@ ___
1094
969
 
1095
970
  ▸ **refetchCurrentUser**(): `Promise`<`unknown`\>
1096
971
 
1097
- The `refetchCurrentUser` function causes a network request to redownload
1098
- the user. All subscribers to the current user will be notified of the
1099
- new users once the new version of the user object is downloaded.
1100
-
1101
972
  #### Returns
1102
973
 
1103
974
  `Promise`<`unknown`\>
1104
975
 
1105
- The same observable as returned by [getCurrentUser](API.md#getcurrentuser).
1106
-
1107
- #### Example
1108
- ```js
1109
- import { refetchCurrentUser } from '@openmrs/esm-api'
1110
- refetchCurrentUser()
1111
- ```
1112
-
1113
976
  #### Defined in
1114
977
 
1115
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:149](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L149)
978
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L163)
1116
979
 
1117
980
  ___
1118
981
 
@@ -1133,7 +996,7 @@ ___
1133
996
 
1134
997
  #### Defined in
1135
998
 
1136
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L45)
999
+ [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L45)
1137
1000
 
1138
1001
  ___
1139
1002
 
@@ -1154,7 +1017,7 @@ ___
1154
1017
 
1155
1018
  #### Defined in
1156
1019
 
1157
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:215](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L215)
1020
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:229](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L229)
1158
1021
 
1159
1022
  ___
1160
1023
 
@@ -1174,7 +1037,7 @@ ___
1174
1037
 
1175
1038
  #### Defined in
1176
1039
 
1177
- [packages/framework/esm-api/src/shared-api-objects/location.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/location.ts#L7)
1040
+ [packages/framework/esm-api/src/shared-api-objects/location.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/location.ts#L7)
1178
1041
 
1179
1042
  ___
1180
1043
 
@@ -1194,7 +1057,7 @@ ___
1194
1057
 
1195
1058
  #### Defined in
1196
1059
 
1197
- [packages/framework/esm-api/src/shared-api-objects/visit-type.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-type.ts#L7)
1060
+ [packages/framework/esm-api/src/shared-api-objects/visit-type.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-type.ts#L7)
1198
1061
 
1199
1062
  ___
1200
1063
 
@@ -1216,7 +1079,7 @@ ___
1216
1079
 
1217
1080
  #### Defined in
1218
1081
 
1219
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L59)
1082
+ [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L59)
1220
1083
 
1221
1084
  ___
1222
1085
 
@@ -1224,11 +1087,6 @@ ___
1224
1087
 
1225
1088
  ▸ **useCurrentPatient**(`patientUuid?`): [`boolean`, `NullablePatient`, [`PatientUuid`](API.md#patientuuid), `Error` \| ``null``]
1226
1089
 
1227
- This React hook returns the current patient, as specified by the current route. It returns
1228
- all the information needed to render a loading state, error state, and normal/success state.
1229
-
1230
- **`deprecated`** Use [usePatient](API.md#usepatient) instead.
1231
-
1232
1090
  #### Parameters
1233
1091
 
1234
1092
  | Name | Type |
@@ -1241,7 +1099,7 @@ all the information needed to render a loading state, error state, and normal/su
1241
1099
 
1242
1100
  #### Defined in
1243
1101
 
1244
- [packages/framework/esm-react-utils/src/useCurrentPatient.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useCurrentPatient.ts#L83)
1102
+ [packages/framework/esm-react-utils/src/useCurrentPatient.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useCurrentPatient.ts#L83)
1245
1103
 
1246
1104
  ___
1247
1105
 
@@ -1255,7 +1113,7 @@ ___
1255
1113
 
1256
1114
  #### Defined in
1257
1115
 
1258
- [packages/framework/esm-react-utils/src/useLocations.tsx:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useLocations.tsx#L5)
1116
+ [packages/framework/esm-react-utils/src/useLocations.tsx:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLocations.tsx#L5)
1259
1117
 
1260
1118
  ___
1261
1119
 
@@ -1263,11 +1121,6 @@ ___
1263
1121
 
1264
1122
  ▸ **usePatient**(`patientUuid?`): `Object`
1265
1123
 
1266
- This React hook returns a patient object. If the `patientUuid` is provided
1267
- as a parameter, then the patient for that UUID is returned. If the parameter
1268
- is not provided, the patient UUID is obtained from the current route, and
1269
- a route listener is set up to update the patient whenever the route changes.
1270
-
1271
1124
  #### Parameters
1272
1125
 
1273
1126
  | Name | Type |
@@ -1287,7 +1140,7 @@ a route listener is set up to update the patient whenever the route changes.
1287
1140
 
1288
1141
  #### Defined in
1289
1142
 
1290
- [packages/framework/esm-react-utils/src/usePatient.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/usePatient.ts#L92)
1143
+ [packages/framework/esm-react-utils/src/usePatient.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/usePatient.ts#L92)
1291
1144
 
1292
1145
  ___
1293
1146
 
@@ -1295,21 +1148,13 @@ ___
1295
1148
 
1296
1149
  ▸ **useSession**(): [`Session`](interfaces/Session.md)
1297
1150
 
1298
- Gets the current user session information. Returns an object with
1299
- property `authenticated` == `false` if the user is not logged in.
1300
-
1301
- Uses Suspense. This hook will always either return a Session object
1302
- or throw for Suspense. It will never return `null`/`undefined`.
1303
-
1304
1151
  #### Returns
1305
1152
 
1306
1153
  [`Session`](interfaces/Session.md)
1307
1154
 
1308
- Current user session information
1309
-
1310
1155
  #### Defined in
1311
1156
 
1312
- [packages/framework/esm-react-utils/src/useSession.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useSession.tsx#L17)
1157
+ [packages/framework/esm-react-utils/src/useSession.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useSession.tsx#L17)
1313
1158
 
1314
1159
  ___
1315
1160
 
@@ -1317,25 +1162,19 @@ ___
1317
1162
 
1318
1163
  ▸ **useVisit**(`patientUuid`): `VisitReturnType`
1319
1164
 
1320
- This React hook returns a visit object. If the `patientUuid` is provided
1321
- as a parameter, then the currentVisit, error and mutate function
1322
- for that patient visit is returned.
1323
-
1324
1165
  #### Parameters
1325
1166
 
1326
1167
  | Name | Type | Description |
1327
1168
  | :------ | :------ | :------ |
1328
- | `patientUuid` | `string` | Unique patient identifier `string` |
1169
+ | `patientUuid` | `string` | |
1329
1170
 
1330
1171
  #### Returns
1331
1172
 
1332
1173
  `VisitReturnType`
1333
1174
 
1334
- Object {`error` `isValidating`, `currentVisit`, `mutate`}
1335
-
1336
1175
  #### Defined in
1337
1176
 
1338
- [packages/framework/esm-react-utils/src/useVisit.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useVisit.ts#L29)
1177
+ [packages/framework/esm-react-utils/src/useVisit.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisit.ts#L29)
1339
1178
 
1340
1179
  ___
1341
1180
 
@@ -1349,30 +1188,30 @@ ___
1349
1188
 
1350
1189
  #### Defined in
1351
1190
 
1352
- [packages/framework/esm-react-utils/src/useVisitTypes.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useVisitTypes.ts#L5)
1191
+ [packages/framework/esm-react-utils/src/useVisitTypes.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisitTypes.ts#L5)
1353
1192
 
1354
1193
  ___
1355
1194
 
1356
1195
  ### userHasAccess
1357
1196
 
1358
- ▸ **userHasAccess**(`requiredPrivilege`, `user`): `undefined` \| [`Privilege`](interfaces/Privilege.md)
1197
+ ▸ **userHasAccess**(`requiredPrivilege`, `user`): `boolean`
1359
1198
 
1360
1199
  #### Parameters
1361
1200
 
1362
1201
  | Name | Type |
1363
1202
  | :------ | :------ |
1364
- | `requiredPrivilege` | `string` |
1203
+ | `requiredPrivilege` | `string` \| `string`[] |
1365
1204
  | `user` | `Object` |
1366
1205
  | `user.privileges` | [`Privilege`](interfaces/Privilege.md)[] |
1367
1206
  | `user.roles` | [`Role`](interfaces/Role.md)[] |
1368
1207
 
1369
1208
  #### Returns
1370
1209
 
1371
- `undefined` \| [`Privilege`](interfaces/Privilege.md)
1210
+ `boolean`
1372
1211
 
1373
1212
  #### Defined in
1374
1213
 
1375
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:181](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L181)
1214
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:195](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L195)
1376
1215
 
1377
1216
  ___
1378
1217
 
@@ -1395,7 +1234,7 @@ ___
1395
1234
 
1396
1235
  #### Defined in
1397
1236
 
1398
- [packages/framework/esm-breadcrumbs/src/filter.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/filter.ts#L43)
1237
+ [packages/framework/esm-breadcrumbs/src/filter.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/filter.ts#L43)
1399
1238
 
1400
1239
  ___
1401
1240
 
@@ -1409,7 +1248,7 @@ ___
1409
1248
 
1410
1249
  #### Defined in
1411
1250
 
1412
- [packages/framework/esm-breadcrumbs/src/db.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/db.ts#L35)
1251
+ [packages/framework/esm-breadcrumbs/src/db.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/db.ts#L35)
1413
1252
 
1414
1253
  ___
1415
1254
 
@@ -1429,7 +1268,7 @@ ___
1429
1268
 
1430
1269
  #### Defined in
1431
1270
 
1432
- [packages/framework/esm-breadcrumbs/src/filter.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/filter.ts#L66)
1271
+ [packages/framework/esm-breadcrumbs/src/filter.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/filter.ts#L66)
1433
1272
 
1434
1273
  ___
1435
1274
 
@@ -1449,7 +1288,7 @@ ___
1449
1288
 
1450
1289
  #### Defined in
1451
1290
 
1452
- [packages/framework/esm-breadcrumbs/src/db.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/db.ts#L21)
1291
+ [packages/framework/esm-breadcrumbs/src/db.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/db.ts#L21)
1453
1292
 
1454
1293
  ___
1455
1294
 
@@ -1469,7 +1308,7 @@ ___
1469
1308
 
1470
1309
  #### Defined in
1471
1310
 
1472
- [packages/framework/esm-breadcrumbs/src/db.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/db.ts#L25)
1311
+ [packages/framework/esm-breadcrumbs/src/db.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-breadcrumbs/src/db.ts#L25)
1473
1312
 
1474
1313
  ___
1475
1314
 
@@ -1479,19 +1318,12 @@ ___
1479
1318
 
1480
1319
  ▸ **defineConfigSchema**(`moduleName`, `schema`): `void`
1481
1320
 
1482
- This defines a configuration schema for a module. The schema tells the
1483
- configuration system how the module can be configured. It specifies
1484
- what makes configuration valid or invalid.
1485
-
1486
- See [Configuration System](http://o3-dev.docs.openmrs.org/#/main/config)
1487
- for more information about defining a config schema.
1488
-
1489
1321
  #### Parameters
1490
1322
 
1491
1323
  | Name | Type | Description |
1492
1324
  | :------ | :------ | :------ |
1493
- | `moduleName` | `string` | Name of the module the schema is being defined for. Generally should be the one in which the `defineConfigSchema` call takes place. |
1494
- | `schema` | [`ConfigSchema`](interfaces/ConfigSchema.md) | The config schema for the module |
1325
+ | `moduleName` | `string` | |
1326
+ | `schema` | [`ConfigSchema`](interfaces/ConfigSchema.md) | |
1495
1327
 
1496
1328
  #### Returns
1497
1329
 
@@ -1499,7 +1331,7 @@ for more information about defining a config schema.
1499
1331
 
1500
1332
  #### Defined in
1501
1333
 
1502
- [packages/framework/esm-config/src/module-config/module-config.ts:193](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L193)
1334
+ [packages/framework/esm-config/src/module-config/module-config.ts:192](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L192)
1503
1335
 
1504
1336
  ___
1505
1337
 
@@ -1507,23 +1339,12 @@ ___
1507
1339
 
1508
1340
  ▸ **defineExtensionConfigSchema**(`extensionName`, `schema`): `void`
1509
1341
 
1510
- This defines a configuration schema for an extension. When a schema is defined
1511
- for an extension, that extension will receive the configuration corresponding
1512
- to that schema, rather than the configuration corresponding to the module
1513
- in which it is defined.
1514
-
1515
- The schema tells the configuration system how the module can be configured.
1516
- It specifies what makes configuration valid or invalid.
1517
-
1518
- See [Configuration System](http://o3-dev.docs.openmrs.org/#/main/config)
1519
- for more information about defining a config schema.
1520
-
1521
1342
  #### Parameters
1522
1343
 
1523
1344
  | Name | Type | Description |
1524
1345
  | :------ | :------ | :------ |
1525
- | `extensionName` | `string` | Name of the extension the schema is being defined for. Should match the `name` of one of the `extensions` entries being returned by `setupOpenMRS`. |
1526
- | `schema` | [`ConfigSchema`](interfaces/ConfigSchema.md) | The config schema for the extension |
1346
+ | `extensionName` | `string` | |
1347
+ | `schema` | [`ConfigSchema`](interfaces/ConfigSchema.md) | |
1527
1348
 
1528
1349
  #### Returns
1529
1350
 
@@ -1531,7 +1352,7 @@ for more information about defining a config schema.
1531
1352
 
1532
1353
  #### Defined in
1533
1354
 
1534
- [packages/framework/esm-config/src/module-config/module-config.ts:218](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L218)
1355
+ [packages/framework/esm-config/src/module-config/module-config.ts:222](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L222)
1535
1356
 
1536
1357
  ___
1537
1358
 
@@ -1539,21 +1360,11 @@ ___
1539
1360
 
1540
1361
  ▸ **getConfig**(`moduleName`): `Promise`<[`Config`](interfaces/Config.md)\>
1541
1362
 
1542
- A promise-based way to access the config as soon as it is fully loaded.
1543
- If it is already loaded, resolves the config in its present state.
1544
-
1545
- In general you should use the Unistore-based API provided by
1546
- `getConfigStore`, which allows creating a subscription so that you always
1547
- have the latest config. If using React, just use `useConfig`.
1548
-
1549
- This is a useful function if you need to get the config in the course
1550
- of the execution of a function.
1551
-
1552
1363
  #### Parameters
1553
1364
 
1554
1365
  | Name | Type | Description |
1555
1366
  | :------ | :------ | :------ |
1556
- | `moduleName` | `string` | The name of the module for which to look up the config |
1367
+ | `moduleName` | `string` | |
1557
1368
 
1558
1369
  #### Returns
1559
1370
 
@@ -1561,7 +1372,7 @@ of the execution of a function.
1561
1372
 
1562
1373
  #### Defined in
1563
1374
 
1564
- [packages/framework/esm-config/src/module-config/module-config.ts:254](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L254)
1375
+ [packages/framework/esm-config/src/module-config/module-config.ts:264](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L264)
1565
1376
 
1566
1377
  ___
1567
1378
 
@@ -1582,7 +1393,7 @@ ___
1582
1393
 
1583
1394
  #### Defined in
1584
1395
 
1585
- [packages/framework/esm-config/src/module-config/module-config.ts:234](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L234)
1396
+ [packages/framework/esm-config/src/module-config/module-config.ts:244](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L244)
1586
1397
 
1587
1398
  ___
1588
1399
 
@@ -1590,25 +1401,24 @@ ___
1590
1401
 
1591
1402
  ▸ **useConfig**(): `Object`
1592
1403
 
1593
- Use this React Hook to obtain your module's configuration.
1594
-
1595
1404
  #### Returns
1596
1405
 
1597
1406
  `Object`
1598
1407
 
1599
1408
  | Name | Type | Description |
1600
1409
  | :------ | :------ | :------ |
1601
- | `constructor` | `Function` | The initial value of Object.prototype.constructor is the standard built-in Object constructor. |
1602
- | `hasOwnProperty` | (`v`: `PropertyKey`) => `boolean` | Determines whether an object has a property with the specified name. |
1603
- | `isPrototypeOf` | (`v`: `Object`) => `boolean` | Determines whether an object exists in another object's prototype chain. |
1604
- | `propertyIsEnumerable` | (`v`: `PropertyKey`) => `boolean` | Determines whether a specified property is enumerable. |
1605
- | `toLocaleString` | () => `string` | Returns a date converted to a string using the current locale. |
1606
- | `toString` | () => `string` | Returns a string representation of an object. |
1607
- | `valueOf` | () => `Object` | Returns the primitive value of the specified object. |
1410
+ | `Display conditions?` | [`DisplayConditionsConfigObject`](interfaces/DisplayConditionsConfigObject.md) | - |
1411
+ | `constructor` | `Function` | |
1412
+ | `hasOwnProperty` | (`v`: `PropertyKey`) => `boolean` | |
1413
+ | `isPrototypeOf` | (`v`: `Object`) => `boolean` | |
1414
+ | `propertyIsEnumerable` | (`v`: `PropertyKey`) => `boolean` | |
1415
+ | `toLocaleString` | () => `string` | |
1416
+ | `toString` | () => `string` | |
1417
+ | `valueOf` | () => `Object` | |
1608
1418
 
1609
1419
  #### Defined in
1610
1420
 
1611
- [packages/framework/esm-react-utils/src/useConfig.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useConfig.ts#L163)
1421
+ [packages/framework/esm-react-utils/src/useConfig.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConfig.ts#L163)
1612
1422
 
1613
1423
  ___
1614
1424
 
@@ -1618,14 +1428,12 @@ ___
1618
1428
 
1619
1429
  ▸ **inRange**(`min`, `max`): [`Validator`](API.md#validator)
1620
1430
 
1621
- Verifies that the value is between the provided minimum and maximum
1622
-
1623
1431
  #### Parameters
1624
1432
 
1625
1433
  | Name | Type | Description |
1626
1434
  | :------ | :------ | :------ |
1627
- | `min` | `number` | Minimum acceptable value |
1628
- | `max` | `number` | Maximum acceptable value |
1435
+ | `min` | `number` | |
1436
+ | `max` | `number` | |
1629
1437
 
1630
1438
  #### Returns
1631
1439
 
@@ -1633,7 +1441,7 @@ Verifies that the value is between the provided minimum and maximum
1633
1441
 
1634
1442
  #### Defined in
1635
1443
 
1636
- [packages/framework/esm-config/src/validators/validators.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validators.ts#L10)
1444
+ [packages/framework/esm-config/src/validators/validators.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L10)
1637
1445
 
1638
1446
  ___
1639
1447
 
@@ -1641,10 +1449,6 @@ ___
1641
1449
 
1642
1450
  ▸ **isUrl**(`value`): `string` \| `void`
1643
1451
 
1644
- Verifies that a string contains only the default URL template parameters.
1645
-
1646
- **`category`** Navigation
1647
-
1648
1452
  #### Parameters
1649
1453
 
1650
1454
  | Name | Type |
@@ -1657,7 +1461,7 @@ Verifies that a string contains only the default URL template parameters.
1657
1461
 
1658
1462
  #### Defined in
1659
1463
 
1660
- [packages/framework/esm-config/src/validators/validators.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validators.ts#L56)
1464
+ [packages/framework/esm-config/src/validators/validators.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L56)
1661
1465
 
1662
1466
  ___
1663
1467
 
@@ -1665,16 +1469,11 @@ ___
1665
1469
 
1666
1470
  ▸ **isUrlWithTemplateParameters**(`allowedTemplateParameters`): [`Validator`](API.md#validator)
1667
1471
 
1668
- Verifies that a string contains only the default URL template
1669
- parameters, plus any specified in `allowedTemplateParameters`.
1670
-
1671
- **`category`** Navigation
1672
-
1673
1472
  #### Parameters
1674
1473
 
1675
1474
  | Name | Type | Description |
1676
1475
  | :------ | :------ | :------ |
1677
- | `allowedTemplateParameters` | `string`[] | To be added to `openmrsBase` and `openmrsSpaBase` |
1476
+ | `allowedTemplateParameters` | `string`[] | |
1678
1477
 
1679
1478
  #### Returns
1680
1479
 
@@ -1682,7 +1481,7 @@ parameters, plus any specified in `allowedTemplateParameters`.
1682
1481
 
1683
1482
  #### Defined in
1684
1483
 
1685
- [packages/framework/esm-config/src/validators/validators.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validators.ts#L24)
1484
+ [packages/framework/esm-config/src/validators/validators.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L24)
1686
1485
 
1687
1486
  ___
1688
1487
 
@@ -1690,13 +1489,11 @@ ___
1690
1489
 
1691
1490
  ▸ **oneOf**(`allowedValues`): [`Validator`](API.md#validator)
1692
1491
 
1693
- Verifies that the value is one of the allowed options.
1694
-
1695
1492
  #### Parameters
1696
1493
 
1697
1494
  | Name | Type | Description |
1698
1495
  | :------ | :------ | :------ |
1699
- | `allowedValues` | `any`[] | The list of allowable values |
1496
+ | `allowedValues` | `any`[] | |
1700
1497
 
1701
1498
  #### Returns
1702
1499
 
@@ -1704,7 +1501,7 @@ Verifies that the value is one of the allowed options.
1704
1501
 
1705
1502
  #### Defined in
1706
1503
 
1707
- [packages/framework/esm-config/src/validators/validators.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validators.ts#L62)
1504
+ [packages/framework/esm-config/src/validators/validators.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validators.ts#L62)
1708
1505
 
1709
1506
  ___
1710
1507
 
@@ -1712,37 +1509,20 @@ ___
1712
1509
 
1713
1510
  ▸ **validator**(`validationFunction`, `message`): [`Validator`](API.md#validator)
1714
1511
 
1715
- Constructs a custom validator.
1716
-
1717
- ### Example
1718
-
1719
- ```typescript
1720
- {
1721
- foo: {
1722
- _default: 0,
1723
- _validators: [
1724
- validator(val => val >= 0, "Must not be negative.")
1725
- ]
1726
- }
1727
- }
1728
- ```
1729
-
1730
1512
  #### Parameters
1731
1513
 
1732
1514
  | Name | Type | Description |
1733
1515
  | :------ | :------ | :------ |
1734
- | `validationFunction` | [`ValidatorFunction`](API.md#validatorfunction) | Takes the configured value as input. Returns true if it is valid, false otherwise. |
1735
- | `message` | `string` \| (`value`: `any`) => `string` | A string message that explains why the value is invalid. Can also be a function that takes the value as input and returns a string. |
1516
+ | `validationFunction` | [`ValidatorFunction`](API.md#validatorfunction) | |
1517
+ | `message` | `string` \| (`value`: `any`) => `string` | |
1736
1518
 
1737
1519
  #### Returns
1738
1520
 
1739
1521
  [`Validator`](API.md#validator)
1740
1522
 
1741
- A validator ready for use in a config schema
1742
-
1743
1523
  #### Defined in
1744
1524
 
1745
- [packages/framework/esm-config/src/validators/validator.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validator.ts#L25)
1525
+ [packages/framework/esm-config/src/validators/validator.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/validators/validator.ts#L25)
1746
1526
 
1747
1527
  ___
1748
1528
 
@@ -1752,23 +1532,6 @@ ___
1752
1532
 
1753
1533
  ▸ **formatDate**(`date`, `options?`): `string`
1754
1534
 
1755
- Formats the input date according to the current locale and the
1756
- given options.
1757
-
1758
- Default options:
1759
- - mode: "standard",
1760
- - time: "for today",
1761
- - day: true,
1762
- - year: true
1763
-
1764
- If the date is today then "Today" is produced (in the locale language).
1765
-
1766
- When time is included, it is appended with a comma and a space. This
1767
- agrees with the output of `Date.prototype.toLocaleString` for *most*
1768
- locales.
1769
-
1770
- TODO: Shouldn't throw on null input
1771
-
1772
1535
  #### Parameters
1773
1536
 
1774
1537
  | Name | Type |
@@ -1782,7 +1545,7 @@ TODO: Shouldn't throw on null input
1782
1545
 
1783
1546
  #### Defined in
1784
1547
 
1785
- [packages/framework/esm-utils/src/omrs-dates.ts:184](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L184)
1548
+ [packages/framework/esm-utils/src/omrs-dates.ts:184](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L184)
1786
1549
 
1787
1550
  ___
1788
1551
 
@@ -1790,14 +1553,6 @@ ___
1790
1553
 
1791
1554
  ▸ **formatDatetime**(`date`, `options?`): `string`
1792
1555
 
1793
- Formats the input into a string showing the date and time, according
1794
- to the current locale. The `mode` parameter is as described for
1795
- `formatDate`.
1796
-
1797
- This is created by concatenating the results of `formatDate`
1798
- and `formatTime` with a comma and space. This agrees with the
1799
- output of `Date.prototype.toLocaleString` for *most* locales.
1800
-
1801
1556
  #### Parameters
1802
1557
 
1803
1558
  | Name | Type |
@@ -1811,7 +1566,7 @@ output of `Date.prototype.toLocaleString` for *most* locales.
1811
1566
 
1812
1567
  #### Defined in
1813
1568
 
1814
- [packages/framework/esm-utils/src/omrs-dates.ts:251](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L251)
1569
+ [packages/framework/esm-utils/src/omrs-dates.ts:251](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L251)
1815
1570
 
1816
1571
  ___
1817
1572
 
@@ -1819,9 +1574,6 @@ ___
1819
1574
 
1820
1575
  ▸ **formatTime**(`date`): `string`
1821
1576
 
1822
- Formats the input as a time, according to the current locale.
1823
- 12-hour or 24-hour clock depends on locale.
1824
-
1825
1577
  #### Parameters
1826
1578
 
1827
1579
  | Name | Type |
@@ -1834,7 +1586,7 @@ Formats the input as a time, according to the current locale.
1834
1586
 
1835
1587
  #### Defined in
1836
1588
 
1837
- [packages/framework/esm-utils/src/omrs-dates.ts:235](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L235)
1589
+ [packages/framework/esm-utils/src/omrs-dates.ts:235](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L235)
1838
1590
 
1839
1591
  ___
1840
1592
 
@@ -1842,9 +1594,6 @@ ___
1842
1594
 
1843
1595
  ▸ **isOmrsDateStrict**(`omrsPayloadString`): `boolean`
1844
1596
 
1845
- This function is STRICT on checking whether a date string is the openmrs format.
1846
- The format should be YYYY-MM-DDTHH:mm:ss.SSSZZ
1847
-
1848
1597
  #### Parameters
1849
1598
 
1850
1599
  | Name | Type |
@@ -1857,7 +1606,7 @@ The format should be YYYY-MM-DDTHH:mm:ss.SSSZZ
1857
1606
 
1858
1607
  #### Defined in
1859
1608
 
1860
- [packages/framework/esm-utils/src/omrs-dates.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L27)
1609
+ [packages/framework/esm-utils/src/omrs-dates.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L27)
1861
1610
 
1862
1611
  ___
1863
1612
 
@@ -1869,7 +1618,7 @@ ___
1869
1618
 
1870
1619
  | Name | Type | Description |
1871
1620
  | :------ | :------ | :------ |
1872
- | `date` | [`DateInput`](API.md#dateinput) | Checks if the provided date is today. |
1621
+ | `date` | [`DateInput`](API.md#dateinput) | |
1873
1622
 
1874
1623
  #### Returns
1875
1624
 
@@ -1877,7 +1626,7 @@ ___
1877
1626
 
1878
1627
  #### Defined in
1879
1628
 
1880
- [packages/framework/esm-utils/src/omrs-dates.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L64)
1629
+ [packages/framework/esm-utils/src/omrs-dates.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L64)
1881
1630
 
1882
1631
  ___
1883
1632
 
@@ -1885,9 +1634,6 @@ ___
1885
1634
 
1886
1635
  ▸ **parseDate**(`dateString`): `Date`
1887
1636
 
1888
- Utility function to parse an arbitrary string into a date.
1889
- Uses `dayjs(dateString)`.
1890
-
1891
1637
  #### Parameters
1892
1638
 
1893
1639
  | Name | Type |
@@ -1900,7 +1646,7 @@ Uses `dayjs(dateString)`.
1900
1646
 
1901
1647
  #### Defined in
1902
1648
 
1903
- [packages/framework/esm-utils/src/omrs-dates.ts:136](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L136)
1649
+ [packages/framework/esm-utils/src/omrs-dates.ts:136](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L136)
1904
1650
 
1905
1651
  ___
1906
1652
 
@@ -1908,8 +1654,6 @@ ___
1908
1654
 
1909
1655
  ▸ **toDateObjectStrict**(`omrsDateString`): `Date` \| ``null``
1910
1656
 
1911
- Converts the object to a date object if it is a valid ISO date time string.
1912
-
1913
1657
  #### Parameters
1914
1658
 
1915
1659
  | Name | Type |
@@ -1922,7 +1666,7 @@ Converts the object to a date object if it is a valid ISO date time string.
1922
1666
 
1923
1667
  #### Defined in
1924
1668
 
1925
- [packages/framework/esm-utils/src/omrs-dates.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L71)
1669
+ [packages/framework/esm-utils/src/omrs-dates.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L71)
1926
1670
 
1927
1671
  ___
1928
1672
 
@@ -1930,9 +1674,6 @@ ___
1930
1674
 
1931
1675
  ▸ **toOmrsDateFormat**(`date`, `format?`): `string`
1932
1676
 
1933
- **`deprecated`** use `formatDate(date)`
1934
- Formats the input as a date string. By default the format "YYYY-MMM-DD" is used.
1935
-
1936
1677
  #### Parameters
1937
1678
 
1938
1679
  | Name | Type | Default value |
@@ -1946,7 +1687,7 @@ Formats the input as a date string. By default the format "YYYY-MMM-DD" is used.
1946
1687
 
1947
1688
  #### Defined in
1948
1689
 
1949
- [packages/framework/esm-utils/src/omrs-dates.ts:128](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L128)
1690
+ [packages/framework/esm-utils/src/omrs-dates.ts:128](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L128)
1950
1691
 
1951
1692
  ___
1952
1693
 
@@ -1954,9 +1695,6 @@ ___
1954
1695
 
1955
1696
  ▸ **toOmrsDayDateFormat**(`date`): `string`
1956
1697
 
1957
- **`deprecated`** use `formatDate(date, "wide")`
1958
- Formats the input as a date string using the format "DD - MMM - YYYY".
1959
-
1960
1698
  #### Parameters
1961
1699
 
1962
1700
  | Name | Type |
@@ -1969,7 +1707,7 @@ Formats the input as a date string using the format "DD - MMM - YYYY".
1969
1707
 
1970
1708
  #### Defined in
1971
1709
 
1972
- [packages/framework/esm-utils/src/omrs-dates.ts:112](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L112)
1710
+ [packages/framework/esm-utils/src/omrs-dates.ts:112](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L112)
1973
1711
 
1974
1712
  ___
1975
1713
 
@@ -1977,8 +1715,6 @@ ___
1977
1715
 
1978
1716
  ▸ **toOmrsIsoString**(`date`, `toUTC?`): `string`
1979
1717
 
1980
- Formats the input as a date time string using the format "YYYY-MM-DDTHH:mm:ss.SSSZZ".
1981
-
1982
1718
  #### Parameters
1983
1719
 
1984
1720
  | Name | Type | Default value |
@@ -1992,7 +1728,7 @@ Formats the input as a date time string using the format "YYYY-MM-DDTHH:mm:ss.SS
1992
1728
 
1993
1729
  #### Defined in
1994
1730
 
1995
- [packages/framework/esm-utils/src/omrs-dates.ts:82](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L82)
1731
+ [packages/framework/esm-utils/src/omrs-dates.ts:82](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L82)
1996
1732
 
1997
1733
  ___
1998
1734
 
@@ -2000,9 +1736,6 @@ ___
2000
1736
 
2001
1737
  ▸ **toOmrsTimeString**(`date`): `string`
2002
1738
 
2003
- **`deprecated`** use `formatTime`
2004
- Formats the input as a time string using the format "HH:mm A".
2005
-
2006
1739
  #### Parameters
2007
1740
 
2008
1741
  | Name | Type |
@@ -2015,7 +1748,7 @@ Formats the input as a time string using the format "HH:mm A".
2015
1748
 
2016
1749
  #### Defined in
2017
1750
 
2018
- [packages/framework/esm-utils/src/omrs-dates.ts:104](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L104)
1751
+ [packages/framework/esm-utils/src/omrs-dates.ts:104](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L104)
2019
1752
 
2020
1753
  ___
2021
1754
 
@@ -2023,9 +1756,6 @@ ___
2023
1756
 
2024
1757
  ▸ **toOmrsTimeString24**(`date`): `string`
2025
1758
 
2026
- **`deprecated`** use `formatTime`
2027
- Formats the input as a time string using the format "HH:mm".
2028
-
2029
1759
  #### Parameters
2030
1760
 
2031
1761
  | Name | Type |
@@ -2038,7 +1768,7 @@ Formats the input as a time string using the format "HH:mm".
2038
1768
 
2039
1769
  #### Defined in
2040
1770
 
2041
- [packages/framework/esm-utils/src/omrs-dates.ts:96](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L96)
1771
+ [packages/framework/esm-utils/src/omrs-dates.ts:96](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L96)
2042
1772
 
2043
1773
  ___
2044
1774
 
@@ -2046,9 +1776,6 @@ ___
2046
1776
 
2047
1777
  ▸ **toOmrsYearlessDateFormat**(`date`): `string`
2048
1778
 
2049
- **`deprecated`** use `formatDate(date, "no year")`
2050
- Formats the input as a date string using the format "DD-MMM".
2051
-
2052
1779
  #### Parameters
2053
1780
 
2054
1781
  | Name | Type |
@@ -2061,7 +1788,7 @@ Formats the input as a date string using the format "DD-MMM".
2061
1788
 
2062
1789
  #### Defined in
2063
1790
 
2064
- [packages/framework/esm-utils/src/omrs-dates.ts:120](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L120)
1791
+ [packages/framework/esm-utils/src/omrs-dates.ts:120](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/omrs-dates.ts#L120)
2065
1792
 
2066
1793
  ___
2067
1794
 
@@ -2089,7 +1816,7 @@ ___
2089
1816
 
2090
1817
  #### Defined in
2091
1818
 
2092
- [packages/framework/esm-error-handling/src/index.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-error-handling/src/index.ts#L24)
1819
+ [packages/framework/esm-error-handling/src/index.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-error-handling/src/index.ts#L24)
2093
1820
 
2094
1821
  ___
2095
1822
 
@@ -2109,7 +1836,7 @@ ___
2109
1836
 
2110
1837
  #### Defined in
2111
1838
 
2112
- [packages/framework/esm-error-handling/src/index.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-error-handling/src/index.ts#L17)
1839
+ [packages/framework/esm-error-handling/src/index.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-error-handling/src/index.ts#L17)
2113
1840
 
2114
1841
  ___
2115
1842
 
@@ -2119,25 +1846,12 @@ ___
2119
1846
 
2120
1847
  ▸ **attach**(`slotName`, `extensionId`): `void`
2121
1848
 
2122
- Attach an extension to an extension slot.
2123
-
2124
- This will cause the extension to be rendered into the specified
2125
- extension slot, unless it is removed by configuration. Using
2126
- `attach` is an alternative to specifying the `slot` or `slots`
2127
- in the extension declaration.
2128
-
2129
- It is particularly useful when creating a slot into which
2130
- you want to render an existing extension. This enables you
2131
- to do so without modifying the extension's declaration, which
2132
- may be impractical or inappropriate, for example if you are
2133
- writing a module for a specific implementation.
2134
-
2135
1849
  #### Parameters
2136
1850
 
2137
1851
  | Name | Type | Description |
2138
1852
  | :------ | :------ | :------ |
2139
- | `slotName` | `string` | a name uniquely identifying the slot |
2140
- | `extensionId` | `string` | an extension name, with an optional #-suffix to distinguish it from other instances of the same extension attached to the same slot. |
1853
+ | `slotName` | `string` | |
1854
+ | `extensionId` | `string` | |
2141
1855
 
2142
1856
  #### Returns
2143
1857
 
@@ -2145,7 +1859,7 @@ writing a module for a specific implementation.
2145
1859
 
2146
1860
  #### Defined in
2147
1861
 
2148
- [packages/framework/esm-extensions/src/extensions.ts:172](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L172)
1862
+ [packages/framework/esm-extensions/src/extensions.ts:174](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L174)
2149
1863
 
2150
1864
  ___
2151
1865
 
@@ -2153,8 +1867,6 @@ ___
2153
1867
 
2154
1868
  ▸ **detach**(`extensionSlotName`, `extensionId`): `void`
2155
1869
 
2156
- Avoid using this. Extension attachments should be considered declarative.
2157
-
2158
1870
  #### Parameters
2159
1871
 
2160
1872
  | Name | Type |
@@ -2168,7 +1880,7 @@ Avoid using this. Extension attachments should be considered declarative.
2168
1880
 
2169
1881
  #### Defined in
2170
1882
 
2171
- [packages/framework/esm-extensions/src/extensions.ts:203](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L203)
1883
+ [packages/framework/esm-extensions/src/extensions.ts:205](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L205)
2172
1884
 
2173
1885
  ___
2174
1886
 
@@ -2176,8 +1888,6 @@ ___
2176
1888
 
2177
1889
  ▸ **detachAll**(`extensionSlotName`): `void`
2178
1890
 
2179
- Avoid using this. Extension attachments should be considered declarative.
2180
-
2181
1891
  #### Parameters
2182
1892
 
2183
1893
  | Name | Type |
@@ -2190,7 +1900,7 @@ Avoid using this. Extension attachments should be considered declarative.
2190
1900
 
2191
1901
  #### Defined in
2192
1902
 
2193
- [packages/framework/esm-extensions/src/extensions.ts:227](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L227)
1903
+ [packages/framework/esm-extensions/src/extensions.ts:229](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L229)
2194
1904
 
2195
1905
  ___
2196
1906
 
@@ -2200,9 +1910,9 @@ ___
2200
1910
 
2201
1911
  #### Parameters
2202
1912
 
2203
- | Name | Type |
2204
- | :------ | :------ |
2205
- | `slotName` | `string` |
1913
+ | Name | Type | Description |
1914
+ | :------ | :------ | :------ |
1915
+ | `slotName` | `string` | |
2206
1916
 
2207
1917
  #### Returns
2208
1918
 
@@ -2210,7 +1920,7 @@ ___
2210
1920
 
2211
1921
  #### Defined in
2212
1922
 
2213
- [packages/framework/esm-extensions/src/extensions.ts:328](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L328)
1923
+ [packages/framework/esm-extensions/src/extensions.ts:359](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L359)
2214
1924
 
2215
1925
  ___
2216
1926
 
@@ -2218,25 +1928,20 @@ ___
2218
1928
 
2219
1929
  ▸ **getConnectedExtensions**(`assignedExtensions`, `online?`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
2220
1930
 
2221
- Filters a list of extensions according to whether they support the
2222
- current connectivity status.
2223
-
2224
1931
  #### Parameters
2225
1932
 
2226
1933
  | Name | Type | Default value | Description |
2227
1934
  | :------ | :------ | :------ | :------ |
2228
- | `assignedExtensions` | [`AssignedExtension`](interfaces/AssignedExtension.md)[] | `undefined` | The list of extensions to filter. |
2229
- | `online` | ``null`` \| `boolean` | `null` | Whether the app is currently online. If `null`, uses `navigator.onLine`. |
1935
+ | `assignedExtensions` | [`AssignedExtension`](interfaces/AssignedExtension.md)[] | `undefined` | |
1936
+ | `online` | ``null`` \| `boolean` | `null` | |
2230
1937
 
2231
1938
  #### Returns
2232
1939
 
2233
1940
  [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
2234
1941
 
2235
- A list of extensions that should be rendered
2236
-
2237
1942
  #### Defined in
2238
1943
 
2239
- [packages/framework/esm-extensions/src/extensions.ts:285](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L285)
1944
+ [packages/framework/esm-extensions/src/extensions.ts:287](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L287)
2240
1945
 
2241
1946
  ___
2242
1947
 
@@ -2244,18 +1949,6 @@ ___
2244
1949
 
2245
1950
  ▸ **getExtensionNameFromId**(`extensionId`): `string`
2246
1951
 
2247
- Given an extension ID, which is a string uniquely identifying
2248
- an instance of an extension within an extension slot, this
2249
- returns the extension name.
2250
-
2251
- **`example`**
2252
- ```js
2253
- getExtensionNameFromId("foo#bar")
2254
- --> "foo"
2255
- getExtensionNameFromId("baz")
2256
- --> "baz"
2257
- ```
2258
-
2259
1952
  #### Parameters
2260
1953
 
2261
1954
  | Name | Type |
@@ -2268,7 +1961,7 @@ getExtensionNameFromId("baz")
2268
1961
 
2269
1962
  #### Defined in
2270
1963
 
2271
- [packages/framework/esm-extensions/src/extensions.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L116)
1964
+ [packages/framework/esm-extensions/src/extensions.ts:118](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L118)
2272
1965
 
2273
1966
  ___
2274
1967
 
@@ -2276,27 +1969,19 @@ ___
2276
1969
 
2277
1970
  ▸ **getExtensionStore**(): `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
2278
1971
 
2279
- This returns a [store](https://github.com/developit/unistore#store)
2280
- that modules can use to get information about the state of the
2281
- extension system.
2282
-
2283
1972
  #### Returns
2284
1973
 
2285
1974
  `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
2286
1975
 
2287
1976
  #### Defined in
2288
1977
 
2289
- [packages/framework/esm-extensions/src/store.ts:129](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L129)
1978
+ [packages/framework/esm-extensions/src/store.ts:130](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L130)
2290
1979
 
2291
1980
  ___
2292
1981
 
2293
1982
  ### renderExtension
2294
1983
 
2295
- ▸ **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction?`, `additionalProps?`): [`CancelLoading`](interfaces/CancelLoading.md)
2296
-
2297
- Mounts into a DOM node (representing an extension slot)
2298
- a lazy-loaded component from *any* frontend module
2299
- that registered an extension component for this slot.
1984
+ ▸ **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction?`, `additionalProps?`): `Parcel` \| ``null``
2300
1985
 
2301
1986
  #### Parameters
2302
1987
 
@@ -2311,11 +1996,11 @@ that registered an extension component for this slot.
2311
1996
 
2312
1997
  #### Returns
2313
1998
 
2314
- [`CancelLoading`](interfaces/CancelLoading.md)
1999
+ `Parcel` \| ``null``
2315
2000
 
2316
2001
  #### Defined in
2317
2002
 
2318
- [packages/framework/esm-extensions/src/render.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L17)
2003
+ [packages/framework/esm-extensions/src/render.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L17)
2319
2004
 
2320
2005
  ___
2321
2006
 
@@ -2323,16 +2008,11 @@ ___
2323
2008
 
2324
2009
  ▸ **useAssignedExtensionIds**(`slotName`): `string`[]
2325
2010
 
2326
- Gets the assigned extension ids for a given extension slot name.
2327
- Does not consider if offline or online.
2328
-
2329
- **`deprecated`** Use `useAssignedExtensions`
2330
-
2331
2011
  #### Parameters
2332
2012
 
2333
2013
  | Name | Type | Description |
2334
2014
  | :------ | :------ | :------ |
2335
- | `slotName` | `string` | The name of the slot to get the assigned IDs for. |
2015
+ | `slotName` | `string` | |
2336
2016
 
2337
2017
  #### Returns
2338
2018
 
@@ -2340,7 +2020,7 @@ Does not consider if offline or online.
2340
2020
 
2341
2021
  #### Defined in
2342
2022
 
2343
- [packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts#L13)
2023
+ [packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts#L13)
2344
2024
 
2345
2025
  ___
2346
2026
 
@@ -2348,14 +2028,11 @@ ___
2348
2028
 
2349
2029
  ▸ **useAssignedExtensions**(`slotName`): [`AssignedExtension`](interfaces/AssignedExtension.md)[]
2350
2030
 
2351
- Gets the assigned extensions for a given extension slot name.
2352
- Does not consider if offline or online.
2353
-
2354
2031
  #### Parameters
2355
2032
 
2356
2033
  | Name | Type | Description |
2357
2034
  | :------ | :------ | :------ |
2358
- | `slotName` | `string` | The name of the slot to get the assigned extensions for. |
2035
+ | `slotName` | `string` | |
2359
2036
 
2360
2037
  #### Returns
2361
2038
 
@@ -2363,7 +2040,7 @@ Does not consider if offline or online.
2363
2040
 
2364
2041
  #### Defined in
2365
2042
 
2366
- [packages/framework/esm-react-utils/src/useAssignedExtensions.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useAssignedExtensions.ts#L15)
2043
+ [packages/framework/esm-react-utils/src/useAssignedExtensions.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAssignedExtensions.ts#L15)
2367
2044
 
2368
2045
  ___
2369
2046
 
@@ -2371,14 +2048,11 @@ ___
2371
2048
 
2372
2049
  ▸ **useConnectedExtensions**(`slotName`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
2373
2050
 
2374
- Gets the assigned extension for a given extension slot name.
2375
- Considers if offline or online.
2376
-
2377
2051
  #### Parameters
2378
2052
 
2379
2053
  | Name | Type | Description |
2380
2054
  | :------ | :------ | :------ |
2381
- | `slotName` | `string` | The name of the slot to get the assigned extensions for. |
2055
+ | `slotName` | `string` | |
2382
2056
 
2383
2057
  #### Returns
2384
2058
 
@@ -2386,7 +2060,7 @@ Considers if offline or online.
2386
2060
 
2387
2061
  #### Defined in
2388
2062
 
2389
- [packages/framework/esm-react-utils/src/useConnectedExtensions.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L15)
2063
+ [packages/framework/esm-react-utils/src/useConnectedExtensions.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L15)
2390
2064
 
2391
2065
  ___
2392
2066
 
@@ -2394,8 +2068,6 @@ ___
2394
2068
 
2395
2069
  ▸ **useExtensionSlotMeta**<`T`\>(`extensionSlotName`): `Object`
2396
2070
 
2397
- Extract meta data from all extension for a given extension slot.
2398
-
2399
2071
  #### Type parameters
2400
2072
 
2401
2073
  | Name | Type |
@@ -2404,9 +2076,9 @@ Extract meta data from all extension for a given extension slot.
2404
2076
 
2405
2077
  #### Parameters
2406
2078
 
2407
- | Name | Type |
2408
- | :------ | :------ |
2409
- | `extensionSlotName` | `string` |
2079
+ | Name | Type | Description |
2080
+ | :------ | :------ | :------ |
2081
+ | `extensionSlotName` | `string` | |
2410
2082
 
2411
2083
  #### Returns
2412
2084
 
@@ -2414,7 +2086,7 @@ Extract meta data from all extension for a given extension slot.
2414
2086
 
2415
2087
  #### Defined in
2416
2088
 
2417
- [packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts#L10)
2089
+ [packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts#L10)
2418
2090
 
2419
2091
  ___
2420
2092
 
@@ -2428,7 +2100,7 @@ ___
2428
2100
 
2429
2101
  #### Defined in
2430
2102
 
2431
- [packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L5)
2103
+ [packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionStore.ts#L5)
2432
2104
 
2433
2105
  ▸ **useExtensionStore**(`actions`): `T` & [`BoundActions`](API.md#boundactions)
2434
2106
 
@@ -2444,7 +2116,7 @@ ___
2444
2116
 
2445
2117
  #### Defined in
2446
2118
 
2447
- [packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L5)
2119
+ [packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionStore.ts#L5)
2448
2120
 
2449
2121
  ▸ **useExtensionStore**(`actions?`): `T` & [`BoundActions`](API.md#boundactions)
2450
2122
 
@@ -2460,7 +2132,7 @@ ___
2460
2132
 
2461
2133
  #### Defined in
2462
2134
 
2463
- [packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L5)
2135
+ [packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useExtensionStore.ts#L5)
2464
2136
 
2465
2137
  ___
2466
2138
 
@@ -2470,8 +2142,6 @@ ___
2470
2142
 
2471
2143
  ▸ **getAsyncExtensionLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`ReactAppOrParcel`<`any`\>\>
2472
2144
 
2473
- **`deprecated`** Use getAsyncLifecycle instead.
2474
-
2475
2145
  #### Type parameters
2476
2146
 
2477
2147
  | Name |
@@ -2497,7 +2167,7 @@ ___
2497
2167
 
2498
2168
  #### Defined in
2499
2169
 
2500
- [packages/framework/esm-react-utils/src/getLifecycle.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/getLifecycle.ts#L39)
2170
+ [packages/framework/esm-react-utils/src/getLifecycle.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L39)
2501
2171
 
2502
2172
  ___
2503
2173
 
@@ -2530,7 +2200,7 @@ ___
2530
2200
 
2531
2201
  #### Defined in
2532
2202
 
2533
- [packages/framework/esm-react-utils/src/getLifecycle.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/getLifecycle.ts#L21)
2203
+ [packages/framework/esm-react-utils/src/getLifecycle.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L21)
2534
2204
 
2535
2205
  ___
2536
2206
 
@@ -2557,7 +2227,7 @@ ___
2557
2227
 
2558
2228
  #### Defined in
2559
2229
 
2560
- [packages/framework/esm-react-utils/src/getLifecycle.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/getLifecycle.ts#L10)
2230
+ [packages/framework/esm-react-utils/src/getLifecycle.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L10)
2561
2231
 
2562
2232
  ___
2563
2233
 
@@ -2590,7 +2260,7 @@ ___
2590
2260
 
2591
2261
  #### Defined in
2592
2262
 
2593
- [packages/framework/esm-react-utils/src/getLifecycle.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/getLifecycle.ts#L29)
2263
+ [packages/framework/esm-react-utils/src/getLifecycle.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/getLifecycle.ts#L29)
2594
2264
 
2595
2265
  ___
2596
2266
 
@@ -2600,8 +2270,6 @@ ___
2600
2270
 
2601
2271
  ▸ **ConfigurableLink**(`__namedParameters`): `Element`
2602
2272
 
2603
- A React link component which calls [navigate](API.md#navigate) when clicked
2604
-
2605
2273
  #### Parameters
2606
2274
 
2607
2275
  | Name | Type |
@@ -2614,7 +2282,7 @@ A React link component which calls [navigate](API.md#navigate) when clicked
2614
2282
 
2615
2283
  #### Defined in
2616
2284
 
2617
- [packages/framework/esm-react-utils/src/ConfigurableLink.tsx:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L38)
2285
+ [packages/framework/esm-react-utils/src/ConfigurableLink.tsx:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L38)
2618
2286
 
2619
2287
  ___
2620
2288
 
@@ -2622,26 +2290,12 @@ ___
2622
2290
 
2623
2291
  ▸ **interpolateString**(`template`, `params`): `string`
2624
2292
 
2625
- Interpolates values of `params` into the `template` string.
2626
-
2627
- Useful for additional template parameters in URLs.
2628
-
2629
- Example usage:
2630
- ```js
2631
- navigate({
2632
- to: interpolateString(
2633
- config.links.patientChart,
2634
- { patientUuid: patient.uuid }
2635
- )
2636
- });
2637
- ```
2638
-
2639
2293
  #### Parameters
2640
2294
 
2641
2295
  | Name | Type | Description |
2642
2296
  | :------ | :------ | :------ |
2643
- | `template` | `string` | With optional params wrapped in `${ }` |
2644
- | `params` | `Object` | Values to interpolate into the string template |
2297
+ | `template` | `string` | |
2298
+ | `params` | `Object` | |
2645
2299
 
2646
2300
  #### Returns
2647
2301
 
@@ -2649,7 +2303,7 @@ navigate({
2649
2303
 
2650
2304
  #### Defined in
2651
2305
 
2652
- [packages/framework/esm-config/src/navigation/interpolate-string.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/navigation/interpolate-string.ts#L46)
2306
+ [packages/framework/esm-config/src/navigation/interpolate-string.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/navigation/interpolate-string.ts#L63)
2653
2307
 
2654
2308
  ___
2655
2309
 
@@ -2657,17 +2311,12 @@ ___
2657
2311
 
2658
2312
  ▸ **interpolateUrl**(`template`, `additionalParams?`): `string`
2659
2313
 
2660
- Interpolates a string with openmrsBase and openmrsSpaBase.
2661
-
2662
- Useful for accepting `${openmrsBase}` or `${openmrsSpaBase}` template
2663
- parameters in configurable URLs.
2664
-
2665
2314
  #### Parameters
2666
2315
 
2667
2316
  | Name | Type | Description |
2668
2317
  | :------ | :------ | :------ |
2669
- | `template` | `string` | A string to interpolate |
2670
- | `additionalParams?` | `Object` | Additional values to interpolate into the string template |
2318
+ | `template` | `string` | |
2319
+ | `additionalParams?` | `Object` | |
2671
2320
 
2672
2321
  #### Returns
2673
2322
 
@@ -2675,7 +2324,7 @@ parameters in configurable URLs.
2675
2324
 
2676
2325
  #### Defined in
2677
2326
 
2678
- [packages/framework/esm-config/src/navigation/interpolate-string.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/navigation/interpolate-string.ts#L16)
2327
+ [packages/framework/esm-config/src/navigation/interpolate-string.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/navigation/interpolate-string.ts#L36)
2679
2328
 
2680
2329
  ___
2681
2330
 
@@ -2683,21 +2332,11 @@ ___
2683
2332
 
2684
2333
  ▸ **navigate**(`to`): `void`
2685
2334
 
2686
- Calls `location.assign` for non-SPA paths and [navigateToUrl](https://single-spa.js.org/docs/api/#navigatetourl) for SPA paths
2687
-
2688
- Example usage:
2689
- ```js
2690
- const config = useConfig();
2691
- const submitHandler = () => {
2692
- navigate({ to: config.links.submitSuccess });
2693
- };
2694
- ```
2695
-
2696
2335
  #### Parameters
2697
2336
 
2698
2337
  | Name | Type | Description |
2699
2338
  | :------ | :------ | :------ |
2700
- | `to` | [`NavigateOptions`](interfaces/NavigateOptions.md) | The target path or URL. Supports templating with 'openmrsBase', 'openmrsSpaBase', and any additional template parameters defined in `templateParams`. For example, `${openmrsSpaBase}/home` will resolve to `/openmrs/spa/home` for implementations using the standard OpenMRS and SPA base paths. If `templateParams` contains `{ foo: "bar" }`, then the URL `${openmrsBase}/${foo}` will become `/openmrs/bar`. |
2339
+ | `to` | [`NavigateOptions`](interfaces/NavigateOptions.md) | |
2701
2340
 
2702
2341
  #### Returns
2703
2342
 
@@ -2705,7 +2344,7 @@ const submitHandler = () => {
2705
2344
 
2706
2345
  #### Defined in
2707
2346
 
2708
- [packages/framework/esm-config/src/navigation/navigate.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/navigation/navigate.ts#L35)
2347
+ [packages/framework/esm-config/src/navigation/navigate.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/navigation/navigate.ts#L42)
2709
2348
 
2710
2349
  ___
2711
2350
 
@@ -2715,14 +2354,11 @@ ___
2715
2354
 
2716
2355
  ▸ **beginEditSynchronizationItem**(`id`): `Promise`<`void`\>
2717
2356
 
2718
- Triggers an edit flow for the given synchronization item.
2719
- If this is not possible, throws an error.
2720
-
2721
2357
  #### Parameters
2722
2358
 
2723
2359
  | Name | Type | Description |
2724
2360
  | :------ | :------ | :------ |
2725
- | `id` | `number` | The ID of the synchronization item to be edited. |
2361
+ | `id` | `number` | |
2726
2362
 
2727
2363
  #### Returns
2728
2364
 
@@ -2730,7 +2366,7 @@ If this is not possible, throws an error.
2730
2366
 
2731
2367
  #### Defined in
2732
2368
 
2733
- [packages/framework/esm-offline/src/sync.ts:357](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L357)
2369
+ [packages/framework/esm-offline/src/sync.ts:357](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L357)
2734
2370
 
2735
2371
  ___
2736
2372
 
@@ -2738,14 +2374,11 @@ ___
2738
2374
 
2739
2375
  ▸ **canBeginEditSynchronizationItemsOfType**(`type`): `boolean`
2740
2376
 
2741
- Returns whether editing synchronization items of the given type is supported by the currently
2742
- registered synchronization handlers.
2743
-
2744
2377
  #### Parameters
2745
2378
 
2746
2379
  | Name | Type | Description |
2747
2380
  | :------ | :------ | :------ |
2748
- | `type` | `string` | The identifying type of the synchronization item which should be edited. |
2381
+ | `type` | `string` | |
2749
2382
 
2750
2383
  #### Returns
2751
2384
 
@@ -2753,7 +2386,7 @@ registered synchronization handlers.
2753
2386
 
2754
2387
  #### Defined in
2755
2388
 
2756
- [packages/framework/esm-offline/src/sync.ts:347](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L347)
2389
+ [packages/framework/esm-offline/src/sync.ts:347](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L347)
2757
2390
 
2758
2391
  ___
2759
2392
 
@@ -2761,13 +2394,11 @@ ___
2761
2394
 
2762
2395
  ▸ **deleteSynchronizationItem**(`id`): `Promise`<`void`\>
2763
2396
 
2764
- Deletes a queued up sync item with the given ID.
2765
-
2766
2397
  #### Parameters
2767
2398
 
2768
2399
  | Name | Type | Description |
2769
2400
  | :------ | :------ | :------ |
2770
- | `id` | `number` | The ID of the synchronization item to be deleted. |
2401
+ | `id` | `number` | |
2771
2402
 
2772
2403
  #### Returns
2773
2404
 
@@ -2775,7 +2406,7 @@ Deletes a queued up sync item with the given ID.
2775
2406
 
2776
2407
  #### Defined in
2777
2408
 
2778
- [packages/framework/esm-offline/src/sync.ts:377](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L377)
2409
+ [packages/framework/esm-offline/src/sync.ts:377](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L377)
2779
2410
 
2780
2411
  ___
2781
2412
 
@@ -2783,15 +2414,13 @@ ___
2783
2414
 
2784
2415
  ▸ **generateOfflineUuid**(): `string`
2785
2416
 
2786
- Generates a UUID-like string which is used for uniquely identifying objects while offline.
2787
-
2788
2417
  #### Returns
2789
2418
 
2790
2419
  `string`
2791
2420
 
2792
2421
  #### Defined in
2793
2422
 
2794
- [packages/framework/esm-offline/src/uuid.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/uuid.ts#L7)
2423
+ [packages/framework/esm-offline/src/uuid.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid.ts#L7)
2795
2424
 
2796
2425
  ___
2797
2426
 
@@ -2805,7 +2434,7 @@ ___
2805
2434
 
2806
2435
  #### Defined in
2807
2436
 
2808
- [packages/framework/esm-offline/src/mode.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L49)
2437
+ [packages/framework/esm-offline/src/mode.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L49)
2809
2438
 
2810
2439
  ___
2811
2440
 
@@ -2813,14 +2442,11 @@ ___
2813
2442
 
2814
2443
  ▸ **getDynamicOfflineDataEntries**(`type?`): `Promise`<[`DynamicOfflineData`](interfaces/DynamicOfflineData.md)[]\>
2815
2444
 
2816
- Returns all [DynamicOfflineData](interfaces/DynamicOfflineData.md) entries which registered for the currently logged in user.
2817
- Optionally returns only entries of a given type.
2818
-
2819
2445
  #### Parameters
2820
2446
 
2821
2447
  | Name | Type | Description |
2822
2448
  | :------ | :------ | :------ |
2823
- | `type?` | `string` | The type of the entries to be returned. If `undefined`, returns all types. |
2449
+ | `type?` | `string` | |
2824
2450
 
2825
2451
  #### Returns
2826
2452
 
@@ -2828,7 +2454,7 @@ Optionally returns only entries of a given type.
2828
2454
 
2829
2455
  #### Defined in
2830
2456
 
2831
- [packages/framework/esm-offline/src/dynamic-offline-data.ts:131](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L131)
2457
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:131](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L131)
2832
2458
 
2833
2459
  ___
2834
2460
 
@@ -2836,15 +2462,12 @@ ___
2836
2462
 
2837
2463
  ▸ **getDynamicOfflineDataEntriesFor**(`userId`, `type?`): `Promise`<[`DynamicOfflineData`](interfaces/DynamicOfflineData.md)[]\>
2838
2464
 
2839
- Returns all [DynamicOfflineData](interfaces/DynamicOfflineData.md) entries which registered for the given user.
2840
- Optionally returns only entries of a given type.
2841
-
2842
2465
  #### Parameters
2843
2466
 
2844
2467
  | Name | Type | Description |
2845
2468
  | :------ | :------ | :------ |
2846
- | `userId` | `string` | The ID of the user whose entries are to be retrieved. |
2847
- | `type?` | `string` | The type of the entries to be returned. If `undefined`, returns all types. |
2469
+ | `userId` | `string` | |
2470
+ | `type?` | `string` | |
2848
2471
 
2849
2472
  #### Returns
2850
2473
 
@@ -2852,7 +2475,7 @@ Optionally returns only entries of a given type.
2852
2475
 
2853
2476
  #### Defined in
2854
2477
 
2855
- [packages/framework/esm-offline/src/dynamic-offline-data.ts:144](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L144)
2478
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:144](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L144)
2856
2479
 
2857
2480
  ___
2858
2481
 
@@ -2860,15 +2483,13 @@ ___
2860
2483
 
2861
2484
  ▸ **getDynamicOfflineDataHandlers**(): [`DynamicOfflineDataHandler`](interfaces/DynamicOfflineDataHandler.md)[]
2862
2485
 
2863
- Returns all handlers which have been setup using the [setupDynamicOfflineDataHandler](API.md#setupdynamicofflinedatahandler) function.
2864
-
2865
2486
  #### Returns
2866
2487
 
2867
2488
  [`DynamicOfflineDataHandler`](interfaces/DynamicOfflineDataHandler.md)[]
2868
2489
 
2869
2490
  #### Defined in
2870
2491
 
2871
- [packages/framework/esm-offline/src/dynamic-offline-data.ts:105](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L105)
2492
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:105](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L105)
2872
2493
 
2873
2494
  ___
2874
2495
 
@@ -2876,8 +2497,6 @@ ___
2876
2497
 
2877
2498
  ▸ **getFullSynchronizationItems**<`T`\>(`type?`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
2878
2499
 
2879
- Returns all currently queued up sync items of the currently signed in user.
2880
-
2881
2500
  #### Type parameters
2882
2501
 
2883
2502
  | Name |
@@ -2888,7 +2507,7 @@ Returns all currently queued up sync items of the currently signed in user.
2888
2507
 
2889
2508
  | Name | Type | Description |
2890
2509
  | :------ | :------ | :------ |
2891
- | `type?` | `string` | The identifying type of the synchronization items to be returned. |
2510
+ | `type?` | `string` | |
2892
2511
 
2893
2512
  #### Returns
2894
2513
 
@@ -2896,7 +2515,7 @@ Returns all currently queued up sync items of the currently signed in user.
2896
2515
 
2897
2516
  #### Defined in
2898
2517
 
2899
- [packages/framework/esm-offline/src/sync.ts:325](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L325)
2518
+ [packages/framework/esm-offline/src/sync.ts:325](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L325)
2900
2519
 
2901
2520
  ___
2902
2521
 
@@ -2904,8 +2523,6 @@ ___
2904
2523
 
2905
2524
  ▸ **getFullSynchronizationItemsFor**<`T`\>(`userId`, `type?`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
2906
2525
 
2907
- Returns all currently queued up sync items of a given user.
2908
-
2909
2526
  #### Type parameters
2910
2527
 
2911
2528
  | Name |
@@ -2916,8 +2533,8 @@ Returns all currently queued up sync items of a given user.
2916
2533
 
2917
2534
  | Name | Type | Description |
2918
2535
  | :------ | :------ | :------ |
2919
- | `userId` | `string` | The ID of the user whose synchronization items should be returned. |
2920
- | `type?` | `string` | The identifying type of the synchronization items to be returned.. |
2536
+ | `userId` | `string` | |
2537
+ | `type?` | `string` | |
2921
2538
 
2922
2539
  #### Returns
2923
2540
 
@@ -2925,7 +2542,7 @@ Returns all currently queued up sync items of a given user.
2925
2542
 
2926
2543
  #### Defined in
2927
2544
 
2928
- [packages/framework/esm-offline/src/sync.ts:301](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L301)
2545
+ [packages/framework/esm-offline/src/sync.ts:301](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L301)
2929
2546
 
2930
2547
  ___
2931
2548
 
@@ -2933,15 +2550,13 @@ ___
2933
2550
 
2934
2551
  ▸ **getOfflinePatientDataStore**(): `Store`<[`OfflinePatientDataSyncStore`](interfaces/OfflinePatientDataSyncStore.md)\>
2935
2552
 
2936
- **`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
2937
-
2938
2553
  #### Returns
2939
2554
 
2940
2555
  `Store`<[`OfflinePatientDataSyncStore`](interfaces/OfflinePatientDataSyncStore.md)\>
2941
2556
 
2942
2557
  #### Defined in
2943
2558
 
2944
- [packages/framework/esm-offline/src/offline-patient-data.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L45)
2559
+ [packages/framework/esm-offline/src/offline-patient-data.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L45)
2945
2560
 
2946
2561
  ___
2947
2562
 
@@ -2949,8 +2564,6 @@ ___
2949
2564
 
2950
2565
  ▸ **getSynchronizationItem**<`T`\>(`id`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\> \| `undefined`\>
2951
2566
 
2952
- Returns a queued sync item with the given ID or `undefined` if no such item exists.
2953
-
2954
2567
  #### Type parameters
2955
2568
 
2956
2569
  | Name | Type |
@@ -2961,7 +2574,7 @@ Returns a queued sync item with the given ID or `undefined` if no such item exis
2961
2574
 
2962
2575
  | Name | Type | Description |
2963
2576
  | :------ | :------ | :------ |
2964
- | `id` | `number` | The ID of the requested sync item. |
2577
+ | `id` | `number` | |
2965
2578
 
2966
2579
  #### Returns
2967
2580
 
@@ -2969,7 +2582,7 @@ Returns a queued sync item with the given ID or `undefined` if no such item exis
2969
2582
 
2970
2583
  #### Defined in
2971
2584
 
2972
- [packages/framework/esm-offline/src/sync.ts:334](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L334)
2585
+ [packages/framework/esm-offline/src/sync.ts:334](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L334)
2973
2586
 
2974
2587
  ___
2975
2588
 
@@ -2977,8 +2590,6 @@ ___
2977
2590
 
2978
2591
  ▸ **getSynchronizationItems**<`T`\>(`type?`): `Promise`<`T`[]\>
2979
2592
 
2980
- Returns the content of all currently queued up sync items of the currently signed in user.
2981
-
2982
2593
  #### Type parameters
2983
2594
 
2984
2595
  | Name |
@@ -2989,7 +2600,7 @@ Returns the content of all currently queued up sync items of the currently signe
2989
2600
 
2990
2601
  | Name | Type | Description |
2991
2602
  | :------ | :------ | :------ |
2992
- | `type?` | `string` | The identifying type of the synchronization items to be returned. |
2603
+ | `type?` | `string` | |
2993
2604
 
2994
2605
  #### Returns
2995
2606
 
@@ -2997,7 +2608,7 @@ Returns the content of all currently queued up sync items of the currently signe
2997
2608
 
2998
2609
  #### Defined in
2999
2610
 
3000
- [packages/framework/esm-offline/src/sync.ts:316](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L316)
2611
+ [packages/framework/esm-offline/src/sync.ts:316](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L316)
3001
2612
 
3002
2613
  ___
3003
2614
 
@@ -3005,8 +2616,6 @@ ___
3005
2616
 
3006
2617
  ▸ **isOfflineUuid**(`uuid`): `boolean`
3007
2618
 
3008
- Checks whether the given string has the format of an offline UUID generated by [generateOfflineUuid](API.md#generateofflineuuid)
3009
-
3010
2619
  #### Parameters
3011
2620
 
3012
2621
  | Name | Type |
@@ -3019,7 +2628,7 @@ Checks whether the given string has the format of an offline UUID generated by [
3019
2628
 
3020
2629
  #### Defined in
3021
2630
 
3022
- [packages/framework/esm-offline/src/uuid.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/uuid.ts#L12)
2631
+ [packages/framework/esm-offline/src/uuid.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid.ts#L12)
3023
2632
 
3024
2633
  ___
3025
2634
 
@@ -3027,23 +2636,19 @@ ___
3027
2636
 
3028
2637
  ▸ **messageOmrsServiceWorker**(`message`): `Promise`<[`MessageServiceWorkerResult`](interfaces/MessageServiceWorkerResult.md)<`any`\>\>
3029
2638
 
3030
- Sends the specified message to the application's service worker.
3031
-
3032
2639
  #### Parameters
3033
2640
 
3034
2641
  | Name | Type | Description |
3035
2642
  | :------ | :------ | :------ |
3036
- | `message` | [`KnownOmrsServiceWorkerMessages`](API.md#knownomrsserviceworkermessages) | The message to be sent. |
2643
+ | `message` | [`KnownOmrsServiceWorkerMessages`](API.md#knownomrsserviceworkermessages) | |
3037
2644
 
3038
2645
  #### Returns
3039
2646
 
3040
2647
  `Promise`<[`MessageServiceWorkerResult`](interfaces/MessageServiceWorkerResult.md)<`any`\>\>
3041
2648
 
3042
- A promise which completes when the message has been successfully processed by the Service Worker.
3043
-
3044
2649
  #### Defined in
3045
2650
 
3046
- [packages/framework/esm-offline/src/service-worker-messaging.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L11)
2651
+ [packages/framework/esm-offline/src/service-worker-messaging.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L11)
3047
2652
 
3048
2653
  ___
3049
2654
 
@@ -3051,15 +2656,12 @@ ___
3051
2656
 
3052
2657
  ▸ **putDynamicOfflineData**(`type`, `identifier`): `Promise`<`void`\>
3053
2658
 
3054
- Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/FHIRResource.md#identifier)
3055
- should be made available offline for the currently logged in user.
3056
-
3057
2659
  #### Parameters
3058
2660
 
3059
2661
  | Name | Type | Description |
3060
2662
  | :------ | :------ | :------ |
3061
- | `type` | `string` | The type of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
3062
- | `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
2663
+ | `type` | `string` | |
2664
+ | `identifier` | `string` | |
3063
2665
 
3064
2666
  #### Returns
3065
2667
 
@@ -3067,7 +2669,7 @@ should be made available offline for the currently logged in user.
3067
2669
 
3068
2670
  #### Defined in
3069
2671
 
3070
- [packages/framework/esm-offline/src/dynamic-offline-data.ts:162](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L162)
2672
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:162](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L162)
3071
2673
 
3072
2674
  ___
3073
2675
 
@@ -3075,16 +2677,13 @@ ___
3075
2677
 
3076
2678
  ▸ **putDynamicOfflineDataFor**(`userId`, `type`, `identifier`): `Promise`<`void`\>
3077
2679
 
3078
- Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/FHIRResource.md#identifier)
3079
- should be made available offline for the user with the given ID.
3080
-
3081
2680
  #### Parameters
3082
2681
 
3083
2682
  | Name | Type | Description |
3084
2683
  | :------ | :------ | :------ |
3085
- | `userId` | `string` | The ID of the user for whom the dynamic offline data should be made available. |
3086
- | `type` | `string` | The type of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
3087
- | `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
2684
+ | `userId` | `string` | |
2685
+ | `type` | `string` | |
2686
+ | `identifier` | `string` | |
3088
2687
 
3089
2688
  #### Returns
3090
2689
 
@@ -3092,7 +2691,7 @@ should be made available offline for the user with the given ID.
3092
2691
 
3093
2692
  #### Defined in
3094
2693
 
3095
- [packages/framework/esm-offline/src/dynamic-offline-data.ts:177](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L177)
2694
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:177](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L177)
3096
2695
 
3097
2696
  ___
3098
2697
 
@@ -3100,8 +2699,6 @@ ___
3100
2699
 
3101
2700
  ▸ **queueSynchronizationItem**<`T`\>(`type`, `content`, `descriptor?`): `Promise`<`number`\>
3102
2701
 
3103
- Enqueues a new item in the sync queue and associates the item with the currently signed in user.
3104
-
3105
2702
  #### Type parameters
3106
2703
 
3107
2704
  | Name |
@@ -3112,9 +2709,9 @@ Enqueues a new item in the sync queue and associates the item with the currently
3112
2709
 
3113
2710
  | Name | Type | Description |
3114
2711
  | :------ | :------ | :------ |
3115
- | `type` | `string` | The identifying type of the synchronization item. |
3116
- | `content` | `T` | The actual data to be synchronized. |
3117
- | `descriptor?` | [`QueueItemDescriptor`](interfaces/QueueItemDescriptor.md) | An optional descriptor providing additional metadata about the sync item. |
2712
+ | `type` | `string` | |
2713
+ | `content` | `T` | |
2714
+ | `descriptor?` | [`QueueItemDescriptor`](interfaces/QueueItemDescriptor.md) | |
3118
2715
 
3119
2716
  #### Returns
3120
2717
 
@@ -3122,7 +2719,7 @@ Enqueues a new item in the sync queue and associates the item with the currently
3122
2719
 
3123
2720
  #### Defined in
3124
2721
 
3125
- [packages/framework/esm-offline/src/sync.ts:274](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L274)
2722
+ [packages/framework/esm-offline/src/sync.ts:274](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L274)
3126
2723
 
3127
2724
  ___
3128
2725
 
@@ -3130,8 +2727,6 @@ ___
3130
2727
 
3131
2728
  ▸ **registerOfflinePatientHandler**(`identifier`, `handler`): `void`
3132
2729
 
3133
- **`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
3134
-
3135
2730
  #### Parameters
3136
2731
 
3137
2732
  | Name | Type |
@@ -3145,7 +2740,7 @@ ___
3145
2740
 
3146
2741
  #### Defined in
3147
2742
 
3148
- [packages/framework/esm-offline/src/offline-patient-data.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L51)
2743
+ [packages/framework/esm-offline/src/offline-patient-data.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L51)
3149
2744
 
3150
2745
  ___
3151
2746
 
@@ -3153,15 +2748,12 @@ ___
3153
2748
 
3154
2749
  ▸ **removeDynamicOfflineData**(`type`, `identifier`): `Promise`<`void`\>
3155
2750
 
3156
- Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/FHIRResource.md#identifier)
3157
- no longer needs to be available offline for the currently logged in user.
3158
-
3159
2751
  #### Parameters
3160
2752
 
3161
2753
  | Name | Type | Description |
3162
2754
  | :------ | :------ | :------ |
3163
- | `type` | `string` | The type of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
3164
- | `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
2755
+ | `type` | `string` | |
2756
+ | `identifier` | `string` | |
3165
2757
 
3166
2758
  #### Returns
3167
2759
 
@@ -3169,7 +2761,7 @@ no longer needs to be available offline for the currently logged in user.
3169
2761
 
3170
2762
  #### Defined in
3171
2763
 
3172
- [packages/framework/esm-offline/src/dynamic-offline-data.ts:213](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L213)
2764
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:213](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L213)
3173
2765
 
3174
2766
  ___
3175
2767
 
@@ -3177,16 +2769,13 @@ ___
3177
2769
 
3178
2770
  ▸ **removeDynamicOfflineDataFor**(`userId`, `type`, `identifier`): `Promise`<`void`\>
3179
2771
 
3180
- Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/FHIRResource.md#identifier)
3181
- no longer needs to be available offline for the user with the given ID.
3182
-
3183
2772
  #### Parameters
3184
2773
 
3185
2774
  | Name | Type | Description |
3186
2775
  | :------ | :------ | :------ |
3187
- | `userId` | `string` | The ID of the user who doesn't require the specified offline data. |
3188
- | `type` | `string` | The type of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
3189
- | `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
2776
+ | `userId` | `string` | |
2777
+ | `type` | `string` | |
2778
+ | `identifier` | `string` | |
3190
2779
 
3191
2780
  #### Returns
3192
2781
 
@@ -3194,7 +2783,7 @@ no longer needs to be available offline for the user with the given ID.
3194
2783
 
3195
2784
  #### Defined in
3196
2785
 
3197
- [packages/framework/esm-offline/src/dynamic-offline-data.ts:228](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L228)
2786
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:228](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L228)
3198
2787
 
3199
2788
  ___
3200
2789
 
@@ -3202,14 +2791,11 @@ ___
3202
2791
 
3203
2792
  ▸ **setupDynamicOfflineDataHandler**(`handler`): `void`
3204
2793
 
3205
- Sets up a handler for synchronizing dynamic offline data.
3206
- See [DynamicOfflineDataHandler](interfaces/DynamicOfflineDataHandler.md) for details.
3207
-
3208
2794
  #### Parameters
3209
2795
 
3210
2796
  | Name | Type | Description |
3211
2797
  | :------ | :------ | :------ |
3212
- | `handler` | [`DynamicOfflineDataHandler`](interfaces/DynamicOfflineDataHandler.md) | The handler to be setup. |
2798
+ | `handler` | [`DynamicOfflineDataHandler`](interfaces/DynamicOfflineDataHandler.md) | |
3213
2799
 
3214
2800
  #### Returns
3215
2801
 
@@ -3217,7 +2803,7 @@ See [DynamicOfflineDataHandler](interfaces/DynamicOfflineDataHandler.md) for det
3217
2803
 
3218
2804
  #### Defined in
3219
2805
 
3220
- [packages/framework/esm-offline/src/dynamic-offline-data.ts:114](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L114)
2806
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:114](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L114)
3221
2807
 
3222
2808
  ___
3223
2809
 
@@ -3225,8 +2811,6 @@ ___
3225
2811
 
3226
2812
  ▸ **setupOfflineSync**<`T`\>(`type`, `dependsOn`, `process`, `options?`): `void`
3227
2813
 
3228
- Registers a new synchronization handler which is able to synchronize data of a specific type.
3229
-
3230
2814
  #### Type parameters
3231
2815
 
3232
2816
  | Name |
@@ -3237,10 +2821,10 @@ Registers a new synchronization handler which is able to synchronize data of a s
3237
2821
 
3238
2822
  | Name | Type | Description |
3239
2823
  | :------ | :------ | :------ |
3240
- | `type` | `string` | The identifying type of the synchronization items which can be handled by this handler. |
3241
- | `dependsOn` | `string`[] | An array of other sync item types which must be synchronized before this handler can synchronize its own data. Items of these types are effectively dependencies of the data synchronized by this handler. |
3242
- | `process` | `ProcessSyncItem`<`T`\> | A function which, when invoked, performs the actual client-server synchronization of the given `item` (which is the actual data to be synchronized). |
3243
- | `options` | `SetupOfflineSyncOptions`<`T`\> | Additional options which can optionally be provided when setting up a synchronization callback for a specific synchronization item type. |
2824
+ | `type` | `string` | |
2825
+ | `dependsOn` | `string`[] | |
2826
+ | `process` | `ProcessSyncItem`<`T`\> | |
2827
+ | `options` | `SetupOfflineSyncOptions`<`T`\> | |
3244
2828
 
3245
2829
  #### Returns
3246
2830
 
@@ -3248,7 +2832,7 @@ Registers a new synchronization handler which is able to synchronize data of a s
3248
2832
 
3249
2833
  #### Defined in
3250
2834
 
3251
- [packages/framework/esm-offline/src/sync.ts:392](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L392)
2835
+ [packages/framework/esm-offline/src/sync.ts:392](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L392)
3252
2836
 
3253
2837
  ___
3254
2838
 
@@ -3274,7 +2858,7 @@ ___
3274
2858
 
3275
2859
  #### Defined in
3276
2860
 
3277
- [packages/framework/esm-globals/src/events.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L24)
2861
+ [packages/framework/esm-globals/src/events.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L24)
3278
2862
 
3279
2863
  ___
3280
2864
 
@@ -3300,7 +2884,7 @@ ___
3300
2884
 
3301
2885
  #### Defined in
3302
2886
 
3303
- [packages/framework/esm-globals/src/events.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L14)
2887
+ [packages/framework/esm-globals/src/events.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L14)
3304
2888
 
3305
2889
  ___
3306
2890
 
@@ -3326,7 +2910,7 @@ ___
3326
2910
 
3327
2911
  #### Defined in
3328
2912
 
3329
- [packages/framework/esm-globals/src/events.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L45)
2913
+ [packages/framework/esm-globals/src/events.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L45)
3330
2914
 
3331
2915
  ___
3332
2916
 
@@ -3334,14 +2918,12 @@ ___
3334
2918
 
3335
2919
  ▸ **syncAllDynamicOfflineData**(`type`, `abortSignal?`): `Promise`<`void`\>
3336
2920
 
3337
- Synchronizes all offline data entries of the given [type](interfaces/FetchResponse.md#type) for the currently logged in user.
3338
-
3339
2921
  #### Parameters
3340
2922
 
3341
2923
  | Name | Type | Description |
3342
2924
  | :------ | :------ | :------ |
3343
- | `type` | `string` | The type of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
3344
- | `abortSignal?` | `AbortSignal` | An {@link AbortSignal} which can be used to cancel the operation. |
2925
+ | `type` | `string` | |
2926
+ | `abortSignal?` | `AbortSignal` | |
3345
2927
 
3346
2928
  #### Returns
3347
2929
 
@@ -3349,7 +2931,7 @@ Synchronizes all offline data entries of the given [type](interfaces/FetchRespon
3349
2931
 
3350
2932
  #### Defined in
3351
2933
 
3352
- [packages/framework/esm-offline/src/dynamic-offline-data.ts:262](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L262)
2934
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:262](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L262)
3353
2935
 
3354
2936
  ___
3355
2937
 
@@ -3357,15 +2939,13 @@ ___
3357
2939
 
3358
2940
  ▸ **syncDynamicOfflineData**(`type`, `identifier`, `abortSignal?`): `Promise`<`void`\>
3359
2941
 
3360
- Synchronizes a single offline data entry of the given [type](interfaces/FetchResponse.md#type) for the currently logged in user.
3361
-
3362
2942
  #### Parameters
3363
2943
 
3364
2944
  | Name | Type | Description |
3365
2945
  | :------ | :------ | :------ |
3366
- | `type` | `string` | The type of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
3367
- | `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](interfaces/DynamicOfflineData.md) for details. |
3368
- | `abortSignal?` | `AbortSignal` | An {@link AbortSignal} which can be used to cancel the operation. |
2946
+ | `type` | `string` | |
2947
+ | `identifier` | `string` | |
2948
+ | `abortSignal?` | `AbortSignal` | |
3369
2949
 
3370
2950
  #### Returns
3371
2951
 
@@ -3373,7 +2953,7 @@ Synchronizes a single offline data entry of the given [type](interfaces/FetchRes
3373
2953
 
3374
2954
  #### Defined in
3375
2955
 
3376
- [packages/framework/esm-offline/src/dynamic-offline-data.ts:280](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/dynamic-offline-data.ts#L280)
2956
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:280](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L280)
3377
2957
 
3378
2958
  ___
3379
2959
 
@@ -3381,8 +2961,6 @@ ___
3381
2961
 
3382
2962
  ▸ **syncOfflinePatientData**(`patientUuid`): `Promise`<`void`\>
3383
2963
 
3384
- **`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
3385
-
3386
2964
  #### Parameters
3387
2965
 
3388
2966
  | Name | Type |
@@ -3395,7 +2973,7 @@ ___
3395
2973
 
3396
2974
  #### Defined in
3397
2975
 
3398
- [packages/framework/esm-offline/src/offline-patient-data.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L71)
2976
+ [packages/framework/esm-offline/src/offline-patient-data.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L71)
3399
2977
 
3400
2978
  ___
3401
2979
 
@@ -3409,7 +2987,29 @@ ___
3409
2987
 
3410
2988
  #### Defined in
3411
2989
 
3412
- [packages/framework/esm-react-utils/src/useConnectivity.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useConnectivity.ts#L5)
2990
+ [packages/framework/esm-react-utils/src/useConnectivity.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useConnectivity.ts#L5)
2991
+
2992
+ ___
2993
+
2994
+ ## Other Functions
2995
+
2996
+ ### ExtensionSlot
2997
+
2998
+ ▸ **ExtensionSlot**(`__namedParameters`): `Element`
2999
+
3000
+ #### Parameters
3001
+
3002
+ | Name | Type |
3003
+ | :------ | :------ |
3004
+ | `__namedParameters` | [`ExtensionSlotProps`](API.md#extensionslotprops) |
3005
+
3006
+ #### Returns
3007
+
3008
+ `Element`
3009
+
3010
+ #### Defined in
3011
+
3012
+ [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:85](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L85)
3413
3013
 
3414
3014
  ___
3415
3015
 
@@ -3419,8 +3019,6 @@ ___
3419
3019
 
3420
3020
  ▸ **createGlobalStore**<`TState`\>(`name`, `initialState`): `Store`<`TState`\>
3421
3021
 
3422
- Creates a Unistore [store](https://github.com/developit/unistore#store).
3423
-
3424
3022
  #### Type parameters
3425
3023
 
3426
3024
  | Name |
@@ -3431,18 +3029,16 @@ Creates a Unistore [store](https://github.com/developit/unistore#store).
3431
3029
 
3432
3030
  | Name | Type | Description |
3433
3031
  | :------ | :------ | :------ |
3434
- | `name` | `string` | A name by which the store can be looked up later. Must be unique across the entire application. |
3435
- | `initialState` | `TState` | An object which will be the initial state of the store. |
3032
+ | `name` | `string` | |
3033
+ | `initialState` | `TState` | |
3436
3034
 
3437
3035
  #### Returns
3438
3036
 
3439
3037
  `Store`<`TState`\>
3440
3038
 
3441
- The newly created store.
3442
-
3443
3039
  #### Defined in
3444
3040
 
3445
- [packages/framework/esm-state/src/state.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-state/src/state.ts#L19)
3041
+ [packages/framework/esm-state/src/state.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L19)
3446
3042
 
3447
3043
  ___
3448
3044
 
@@ -3450,8 +3046,6 @@ ___
3450
3046
 
3451
3047
  ▸ **createUseStore**<`T`\>(`store`): () => `T`(`actions`: [`Actions`](API.md#actions)) => `T` & [`BoundActions`](API.md#boundactions)(`actions?`: [`Actions`](API.md#actions)) => `T` & [`BoundActions`](API.md#boundactions)
3452
3048
 
3453
- Avoid this; generally prefer to have clients use `useStore(yourStore)`
3454
-
3455
3049
  #### Type parameters
3456
3050
 
3457
3051
  | Name |
@@ -3500,7 +3094,7 @@ Avoid this; generally prefer to have clients use `useStore(yourStore)`
3500
3094
 
3501
3095
  #### Defined in
3502
3096
 
3503
- [packages/framework/esm-react-utils/src/createUseStore.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/createUseStore.ts#L23)
3097
+ [packages/framework/esm-react-utils/src/createUseStore.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/createUseStore.ts#L23)
3504
3098
 
3505
3099
  ___
3506
3100
 
@@ -3512,11 +3106,9 @@ ___
3512
3106
 
3513
3107
  `Store`<[`AppState`](interfaces/AppState.md)\>
3514
3108
 
3515
- The [store](https://github.com/developit/unistore#store) named `app`.
3516
-
3517
3109
  #### Defined in
3518
3110
 
3519
- [packages/framework/esm-state/src/state.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-state/src/state.ts#L86)
3111
+ [packages/framework/esm-state/src/state.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L86)
3520
3112
 
3521
3113
  ___
3522
3114
 
@@ -3524,9 +3116,6 @@ ___
3524
3116
 
3525
3117
  ▸ **getGlobalStore**<`TState`\>(`name`, `fallbackState?`): `Store`<`TState`\>
3526
3118
 
3527
- Returns the existing [store](https://github.com/developit/unistore#store) named `name`,
3528
- or creates a new store named `name` if none exists.
3529
-
3530
3119
  #### Type parameters
3531
3120
 
3532
3121
  | Name | Type |
@@ -3537,18 +3126,16 @@ or creates a new store named `name` if none exists.
3537
3126
 
3538
3127
  | Name | Type | Description |
3539
3128
  | :------ | :------ | :------ |
3540
- | `name` | `string` | The name of the store to look up. |
3541
- | `fallbackState?` | `TState` | The initial value of the new store if no store named `name` exists. |
3129
+ | `name` | `string` | |
3130
+ | `fallbackState?` | `TState` | |
3542
3131
 
3543
3132
  #### Returns
3544
3133
 
3545
3134
  `Store`<`TState`\>
3546
3135
 
3547
- The found or newly created store.
3548
-
3549
3136
  #### Defined in
3550
3137
 
3551
- [packages/framework/esm-state/src/state.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-state/src/state.ts#L56)
3138
+ [packages/framework/esm-state/src/state.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L56)
3552
3139
 
3553
3140
  ___
3554
3141
 
@@ -3577,7 +3164,7 @@ ___
3577
3164
 
3578
3165
  #### Defined in
3579
3166
 
3580
- [packages/framework/esm-state/src/state.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-state/src/state.ts#L90)
3167
+ [packages/framework/esm-state/src/state.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-state/src/state.ts#L90)
3581
3168
 
3582
3169
  ___
3583
3170
 
@@ -3604,7 +3191,7 @@ ___
3604
3191
 
3605
3192
  #### Defined in
3606
3193
 
3607
- [packages/framework/esm-react-utils/src/useStore.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStore.ts#L23)
3194
+ [packages/framework/esm-react-utils/src/useStore.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L23)
3608
3195
 
3609
3196
  ▸ **useStore**<`T`, `U`\>(`store`, `select`): `U`
3610
3197
 
@@ -3628,7 +3215,7 @@ ___
3628
3215
 
3629
3216
  #### Defined in
3630
3217
 
3631
- [packages/framework/esm-react-utils/src/useStore.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStore.ts#L24)
3218
+ [packages/framework/esm-react-utils/src/useStore.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L24)
3632
3219
 
3633
3220
  ▸ **useStore**<`T`, `U`\>(`store`, `select`, `actions`): `T` & [`BoundActions`](API.md#boundactions)
3634
3221
 
@@ -3653,7 +3240,7 @@ ___
3653
3240
 
3654
3241
  #### Defined in
3655
3242
 
3656
- [packages/framework/esm-react-utils/src/useStore.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStore.ts#L25)
3243
+ [packages/framework/esm-react-utils/src/useStore.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L25)
3657
3244
 
3658
3245
  ▸ **useStore**<`T`, `U`\>(`store`, `select`, `actions`): `U` & [`BoundActions`](API.md#boundactions)
3659
3246
 
@@ -3678,7 +3265,7 @@ ___
3678
3265
 
3679
3266
  #### Defined in
3680
3267
 
3681
- [packages/framework/esm-react-utils/src/useStore.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStore.ts#L30)
3268
+ [packages/framework/esm-react-utils/src/useStore.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L30)
3682
3269
 
3683
3270
  ___
3684
3271
 
@@ -3705,7 +3292,7 @@ ___
3705
3292
 
3706
3293
  #### Defined in
3707
3294
 
3708
- [packages/framework/esm-react-utils/src/useStore.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStore.ts#L52)
3295
+ [packages/framework/esm-react-utils/src/useStore.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L52)
3709
3296
 
3710
3297
  ___
3711
3298
 
@@ -3727,7 +3314,7 @@ ___
3727
3314
 
3728
3315
  #### Defined in
3729
3316
 
3730
- [packages/framework/esm-react-utils/src/useLayoutType.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useLayoutType.ts#L40)
3317
+ [packages/framework/esm-react-utils/src/useLayoutType.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLayoutType.ts#L40)
3731
3318
 
3732
3319
  ___
3733
3320
 
@@ -3747,7 +3334,7 @@ ___
3747
3334
 
3748
3335
  #### Defined in
3749
3336
 
3750
- [packages/framework/esm-styleguide/src/left-nav/index.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/left-nav/index.tsx#L20)
3337
+ [packages/framework/esm-styleguide/src/left-nav/index.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L18)
3751
3338
 
3752
3339
  ___
3753
3340
 
@@ -3755,22 +3342,18 @@ ___
3755
3342
 
3756
3343
  ▸ **showModal**(`extensionId`, `props?`, `onClose?`): () => `void`
3757
3344
 
3758
- Shows the provided extension component in a modal dialog.
3759
-
3760
3345
  #### Parameters
3761
3346
 
3762
3347
  | Name | Type | Description |
3763
3348
  | :------ | :------ | :------ |
3764
- | `extensionId` | `string` | The id of the extension to show. |
3765
- | `props` | `Record`<`string`, `any`\> | The optional props to provide to the extension. |
3766
- | `onClose` | () => `void` | The optional notification to receive when the modal is closed. |
3349
+ | `extensionId` | `string` | |
3350
+ | `props` | `Record`<`string`, `any`\> | |
3351
+ | `onClose` | () => `void` | |
3767
3352
 
3768
3353
  #### Returns
3769
3354
 
3770
3355
  `fn`
3771
3356
 
3772
- The dispose function to force closing the modal dialog.
3773
-
3774
3357
  ▸ (): `void`
3775
3358
 
3776
3359
  ##### Returns
@@ -3779,7 +3362,7 @@ The dispose function to force closing the modal dialog.
3779
3362
 
3780
3363
  #### Defined in
3781
3364
 
3782
- [packages/framework/esm-styleguide/src/modals/index.tsx:164](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/modals/index.tsx#L164)
3365
+ [packages/framework/esm-styleguide/src/modals/index.tsx:165](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/modals/index.tsx#L165)
3783
3366
 
3784
3367
  ___
3785
3368
 
@@ -3787,13 +3370,11 @@ ___
3787
3370
 
3788
3371
  ▸ **showNotification**(`notification`): `void`
3789
3372
 
3790
- Displays an inline notification in the UI.
3791
-
3792
3373
  #### Parameters
3793
3374
 
3794
3375
  | Name | Type | Description |
3795
3376
  | :------ | :------ | :------ |
3796
- | `notification` | [`NotificationDescriptor`](interfaces/NotificationDescriptor.md) | The description of the notification to display. |
3377
+ | `notification` | [`NotificationDescriptor`](interfaces/NotificationDescriptor.md) | |
3797
3378
 
3798
3379
  #### Returns
3799
3380
 
@@ -3801,7 +3382,7 @@ Displays an inline notification in the UI.
3801
3382
 
3802
3383
  #### Defined in
3803
3384
 
3804
- [packages/framework/esm-styleguide/src/notifications/index.tsx:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/notifications/index.tsx#L40)
3385
+ [packages/framework/esm-styleguide/src/notifications/index.tsx:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/index.tsx#L40)
3805
3386
 
3806
3387
  ___
3807
3388
 
@@ -3809,13 +3390,11 @@ ___
3809
3390
 
3810
3391
  ▸ **showToast**(`toast`): `void`
3811
3392
 
3812
- Displays a toast notification in the UI.
3813
-
3814
3393
  #### Parameters
3815
3394
 
3816
3395
  | Name | Type | Description |
3817
3396
  | :------ | :------ | :------ |
3818
- | `toast` | [`ToastDescriptor`](interfaces/ToastDescriptor.md) | The description of the toast to display. |
3397
+ | `toast` | [`ToastDescriptor`](interfaces/ToastDescriptor.md) | |
3819
3398
 
3820
3399
  #### Returns
3821
3400
 
@@ -3823,7 +3402,7 @@ Displays a toast notification in the UI.
3823
3402
 
3824
3403
  #### Defined in
3825
3404
 
3826
- [packages/framework/esm-styleguide/src/toasts/index.tsx:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/index.tsx#L36)
3405
+ [packages/framework/esm-styleguide/src/toasts/index.tsx:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/toasts/index.tsx#L36)
3827
3406
 
3828
3407
  ___
3829
3408
 
@@ -3849,7 +3428,7 @@ ___
3849
3428
 
3850
3429
  #### Defined in
3851
3430
 
3852
- [packages/framework/esm-globals/src/events.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L93)
3431
+ [packages/framework/esm-globals/src/events.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L93)
3853
3432
 
3854
3433
  ___
3855
3434
 
@@ -3875,7 +3454,7 @@ ___
3875
3454
 
3876
3455
  #### Defined in
3877
3456
 
3878
- [packages/framework/esm-globals/src/events.ts:102](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L102)
3457
+ [packages/framework/esm-globals/src/events.ts:102](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L102)
3879
3458
 
3880
3459
  ___
3881
3460
 
@@ -3895,7 +3474,7 @@ ___
3895
3474
 
3896
3475
  #### Defined in
3897
3476
 
3898
- [packages/framework/esm-styleguide/src/left-nav/index.tsx:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/left-nav/index.tsx#L24)
3477
+ [packages/framework/esm-styleguide/src/left-nav/index.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L22)
3899
3478
 
3900
3479
  ___
3901
3480
 
@@ -3915,7 +3494,7 @@ ___
3915
3494
 
3916
3495
  #### Defined in
3917
3496
 
3918
- [packages/framework/esm-react-utils/src/useBodyScrollLock.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useBodyScrollLock.ts#L4)
3497
+ [packages/framework/esm-react-utils/src/useBodyScrollLock.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useBodyScrollLock.ts#L4)
3919
3498
 
3920
3499
  ___
3921
3500
 
@@ -3929,7 +3508,7 @@ ___
3929
3508
 
3930
3509
  #### Defined in
3931
3510
 
3932
- [packages/framework/esm-react-utils/src/useLayoutType.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useLayoutType.ts#L26)
3511
+ [packages/framework/esm-react-utils/src/useLayoutType.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLayoutType.ts#L26)
3933
3512
 
3934
3513
  ___
3935
3514
 
@@ -3956,7 +3535,7 @@ ___
3956
3535
 
3957
3536
  #### Defined in
3958
3537
 
3959
- [packages/framework/esm-react-utils/src/useOnClickOutside.tsx:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useOnClickOutside.tsx#L4)
3538
+ [packages/framework/esm-react-utils/src/useOnClickOutside.tsx:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOnClickOutside.tsx#L4)
3960
3539
 
3961
3540
  ___
3962
3541
 
@@ -3995,7 +3574,7 @@ ___
3995
3574
 
3996
3575
  #### Defined in
3997
3576
 
3998
- [packages/framework/esm-react-utils/src/usePagination.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/usePagination.ts#L6)
3577
+ [packages/framework/esm-react-utils/src/usePagination.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/usePagination.ts#L6)
3999
3578
 
4000
3579
  ___
4001
3580
 
@@ -4005,23 +3584,19 @@ ___
4005
3584
 
4006
3585
  ▸ **age**(`dateString`): `string`
4007
3586
 
4008
- Gets a human readable age represention of the provided date string.
4009
-
4010
3587
  #### Parameters
4011
3588
 
4012
3589
  | Name | Type | Description |
4013
3590
  | :------ | :------ | :------ |
4014
- | `dateString` | `string` | The stringified date. |
3591
+ | `dateString` | `string` | |
4015
3592
 
4016
3593
  #### Returns
4017
3594
 
4018
3595
  `string`
4019
3596
 
4020
- A human-readable string version of the age.
4021
-
4022
3597
  #### Defined in
4023
3598
 
4024
- [packages/framework/esm-utils/src/age-helpers.tsx:39](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/age-helpers.tsx#L39)
3599
+ [packages/framework/esm-utils/src/age-helpers.tsx:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L39)
4025
3600
 
4026
3601
  ___
4027
3602
 
@@ -4029,23 +3604,19 @@ ___
4029
3604
 
4030
3605
  ▸ **daysIntoYear**(`date`): `number`
4031
3606
 
4032
- Gets the number of days in the year of the given date.
4033
-
4034
3607
  #### Parameters
4035
3608
 
4036
3609
  | Name | Type | Description |
4037
3610
  | :------ | :------ | :------ |
4038
- | `date` | `Date` | The date to compute the days within the year. |
3611
+ | `date` | `Date` | |
4039
3612
 
4040
3613
  #### Returns
4041
3614
 
4042
3615
  `number`
4043
3616
 
4044
- The number of days.
4045
-
4046
3617
  #### Defined in
4047
3618
 
4048
- [packages/framework/esm-utils/src/age-helpers.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/age-helpers.tsx#L8)
3619
+ [packages/framework/esm-utils/src/age-helpers.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L8)
4049
3620
 
4050
3621
  ___
4051
3622
 
@@ -4053,24 +3624,20 @@ ___
4053
3624
 
4054
3625
  ▸ **isSameDay**(`firstDate`, `secondDate`): `boolean`
4055
3626
 
4056
- Checks if two dates are representing the same day.
4057
-
4058
3627
  #### Parameters
4059
3628
 
4060
3629
  | Name | Type | Description |
4061
3630
  | :------ | :------ | :------ |
4062
- | `firstDate` | `Date` | The first date. |
4063
- | `secondDate` | `Date` | The second date. |
3631
+ | `firstDate` | `Date` | |
3632
+ | `secondDate` | `Date` | |
4064
3633
 
4065
3634
  #### Returns
4066
3635
 
4067
3636
  `boolean`
4068
3637
 
4069
- True if both are located on the same day.
4070
-
4071
3638
  #### Defined in
4072
3639
 
4073
- [packages/framework/esm-utils/src/age-helpers.tsx:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/age-helpers.tsx#L25)
3640
+ [packages/framework/esm-utils/src/age-helpers.tsx:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.tsx#L25)
4074
3641
 
4075
3642
  ___
4076
3643
 
@@ -4091,7 +3658,7 @@ ___
4091
3658
 
4092
3659
  #### Defined in
4093
3660
 
4094
- [packages/framework/esm-utils/src/version.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/version.ts#L22)
3661
+ [packages/framework/esm-utils/src/version.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/version.ts#L22)
4095
3662
 
4096
3663
  ___
4097
3664
 
@@ -4099,15 +3666,6 @@ ___
4099
3666
 
4100
3667
  ▸ **retry**<`T`\>(`fn`, `options?`): `Promise`<`T`\>
4101
3668
 
4102
- Executes the specified function and retries executing on failure with a custom backoff strategy
4103
- defined by the options.
4104
-
4105
- If not configured otherwise, this function uses the following default options:
4106
- * Retries 5 times beyond the initial attempt.
4107
- * Uses an exponential backoff starting with an initial delay of 1000ms.
4108
-
4109
- **`throws`** Rethrows the final error of running `fn` when the function stops retrying.
4110
-
4111
3669
  #### Type parameters
4112
3670
 
4113
3671
  | Name |
@@ -4118,18 +3676,16 @@ If not configured otherwise, this function uses the following default options:
4118
3676
 
4119
3677
  | Name | Type | Description |
4120
3678
  | :------ | :------ | :------ |
4121
- | `fn` | () => `Promise`<`T`\> | The function to be executed and retried on failure. |
4122
- | `options` | [`RetryOptions`](interfaces/RetryOptions.md) | Additional options which configure the retry behavior. |
3679
+ | `fn` | () => `Promise`<`T`\> | |
3680
+ | `options` | [`RetryOptions`](interfaces/RetryOptions.md) | |
4123
3681
 
4124
3682
  #### Returns
4125
3683
 
4126
3684
  `Promise`<`T`\>
4127
3685
 
4128
- The result of successfully executing `fn`.
4129
-
4130
3686
  #### Defined in
4131
3687
 
4132
- [packages/framework/esm-utils/src/retry.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L40)
3688
+ [packages/framework/esm-utils/src/retry.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/retry.ts#L40)
4133
3689
 
4134
3690
  ___
4135
3691
 
@@ -4152,4 +3708,4 @@ ___
4152
3708
 
4153
3709
  #### Defined in
4154
3710
 
4155
- [packages/framework/esm-utils/src/translate.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/translate.ts#L4)
3711
+ [packages/framework/esm-utils/src/translate.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/translate.ts#L4)