@openmrs/esm-framework 3.1.15-pre.751 → 3.1.15-pre.752

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/API.md CHANGED
@@ -17,6 +17,7 @@
17
17
  ### Interfaces
18
18
 
19
19
  - [AppState](interfaces/AppState.md)
20
+ - [AssignedExtension](interfaces/AssignedExtension.md)
20
21
  - [BreadcrumbRegistration](interfaces/BreadcrumbRegistration.md)
21
22
  - [BreadcrumbSettings](interfaces/BreadcrumbSettings.md)
22
23
  - [CancelLoading](interfaces/CancelLoading.md)
@@ -27,7 +28,6 @@
27
28
  - [Config](interfaces/Config.md)
28
29
  - [ConfigObject](interfaces/ConfigObject.md)
29
30
  - [ConfigSchema](interfaces/ConfigSchema.md)
30
- - [ConfigStore](interfaces/ConfigStore.md)
31
31
  - [ConfigurableLinkProps](interfaces/ConfigurableLinkProps.md)
32
32
  - [ConnectedExtension](interfaces/ConnectedExtension.md)
33
33
  - [ConnectivityChangedEvent](interfaces/ConnectivityChangedEvent.md)
@@ -37,26 +37,24 @@
37
37
  - [CurrentUserWithoutResponseOption](interfaces/CurrentUserWithoutResponseOption.md)
38
38
  - [ExtensionData](interfaces/ExtensionData.md)
39
39
  - [ExtensionDefinition](interfaces/ExtensionDefinition.md)
40
- - [ExtensionDetails](interfaces/ExtensionDetails.md)
41
40
  - [ExtensionInfo](interfaces/ExtensionInfo.md)
42
41
  - [ExtensionInstance](interfaces/ExtensionInstance.md)
42
+ - [ExtensionInternalStore](interfaces/ExtensionInternalStore.md)
43
43
  - [ExtensionMeta](interfaces/ExtensionMeta.md)
44
44
  - [ExtensionProps](interfaces/ExtensionProps.md)
45
45
  - [ExtensionRegistration](interfaces/ExtensionRegistration.md)
46
46
  - [ExtensionSlotBaseProps](interfaces/ExtensionSlotBaseProps.md)
47
47
  - [ExtensionSlotConfig](interfaces/ExtensionSlotConfig.md)
48
48
  - [ExtensionSlotConfigObject](interfaces/ExtensionSlotConfigObject.md)
49
- - [ExtensionSlotConfigsStore](interfaces/ExtensionSlotConfigsStore.md)
50
49
  - [ExtensionSlotConfigureValueObject](interfaces/ExtensionSlotConfigureValueObject.md)
51
50
  - [ExtensionSlotInfo](interfaces/ExtensionSlotInfo.md)
52
- - [ExtensionSlotInstance](interfaces/ExtensionSlotInstance.md)
51
+ - [ExtensionSlotState](interfaces/ExtensionSlotState.md)
53
52
  - [ExtensionStore](interfaces/ExtensionStore.md)
54
53
  - [FHIRCode](interfaces/FHIRCode.md)
55
54
  - [FHIRRequestObj](interfaces/FHIRRequestObj.md)
56
55
  - [FHIRResource](interfaces/FHIRResource.md)
57
56
  - [FetchHeaders](interfaces/FetchHeaders.md)
58
57
  - [FetchResponse](interfaces/FetchResponse.md)
59
- - [ImplementerToolsConfigStore](interfaces/ImplementerToolsConfigStore.md)
60
58
  - [ImportMap](interfaces/ImportMap.md)
61
59
  - [Lifecycle](interfaces/Lifecycle.md)
62
60
  - [Location](interfaces/Location.md)
@@ -118,7 +116,6 @@
118
116
  - [KnownOmrsServiceWorkerMessages](API.md#knownomrsserviceworkermessages)
119
117
  - [LayoutType](API.md#layouttype)
120
118
  - [LoggedInUserData](API.md#loggedinuserdata)
121
- - [MaybeAsync](API.md#maybeasync)
122
119
  - [NavigationContextType](API.md#navigationcontexttype)
123
120
  - [OmrsOfflineCachingStrategy](API.md#omrsofflinecachingstrategy)
124
121
  - [OmrsOfflineHttpHeaderNames](API.md#omrsofflinehttpheadernames)
@@ -149,13 +146,11 @@
149
146
  - [extensionStore](API.md#extensionstore)
150
147
  - [fhirBaseUrl](API.md#fhirbaseurl)
151
148
  - [getStartedVisit](API.md#getstartedvisit)
152
- - [implementerToolsConfigStore](API.md#implementertoolsconfigstore)
153
149
  - [offlineUuidPrefix](API.md#offlineuuidprefix)
154
150
  - [omrsOfflineCachingStrategyHttpHeaderName](API.md#omrsofflinecachingstrategyhttpheadername)
155
151
  - [omrsOfflineResponseBodyHttpHeaderName](API.md#omrsofflineresponsebodyhttpheadername)
156
152
  - [omrsOfflineResponseStatusHttpHeaderName](API.md#omrsofflineresponsestatushttpheadername)
157
153
  - [sessionEndpoint](API.md#sessionendpoint)
158
- - [temporaryConfigStore](API.md#temporaryconfigstore)
159
154
  - [validators](API.md#validators)
160
155
 
161
156
  ### API Functions
@@ -207,18 +202,16 @@
207
202
  - [formatTime](API.md#formattime)
208
203
  - [generateOfflineUuid](API.md#generateofflineuuid)
209
204
  - [getAppState](API.md#getappstate)
210
- - [getAssignedIds](API.md#getassignedids)
205
+ - [getAssignedExtensions](API.md#getassignedextensions)
211
206
  - [getAsyncExtensionLifecycle](API.md#getasyncextensionlifecycle)
212
207
  - [getAsyncLifecycle](API.md#getasynclifecycle)
213
208
  - [getConfig](API.md#getconfig)
214
- - [getConfigStore](API.md#getconfigstore)
209
+ - [getConnectedExtensions](API.md#getconnectedextensions)
215
210
  - [getCustomProps](API.md#getcustomprops)
216
- - [getExtensionConfigStore](API.md#getextensionconfigstore)
217
211
  - [getExtensionNameFromId](API.md#getextensionnamefromid)
218
212
  - [getExtensionRegistration](API.md#getextensionregistration)
219
213
  - [getExtensionRegistrationFrom](API.md#getextensionregistrationfrom)
220
- - [getExtensionSlotsConfigStore](API.md#getextensionslotsconfigstore)
221
- - [getExtensionSlotsForModule](API.md#getextensionslotsformodule)
214
+ - [getExtensionStore](API.md#getextensionstore)
222
215
  - [getGlobalStore](API.md#getglobalstore)
223
216
  - [getLifecycle](API.md#getlifecycle)
224
217
  - [getLocations](API.md#getlocations)
@@ -230,7 +223,6 @@
230
223
  - [getSyncLifecycle](API.md#getsynclifecycle)
231
224
  - [getSynchronizationItems](API.md#getsynchronizationitems)
232
225
  - [getSynchronizationItemsFor](API.md#getsynchronizationitemsfor)
233
- - [getUpdatedExtensionSlotInfo](API.md#getupdatedextensionslotinfo)
234
226
  - [getVisitTypes](API.md#getvisittypes)
235
227
  - [getVisitsForPatient](API.md#getvisitsforpatient)
236
228
  - [handleApiError](API.md#handleapierror)
@@ -253,8 +245,6 @@
253
245
  - [pushNavigationContext](API.md#pushnavigationcontext)
254
246
  - [queueSynchronizationItem](API.md#queuesynchronizationitem)
255
247
  - [queueSynchronizationItemFor](API.md#queuesynchronizationitemfor)
256
- - [registerExtension](API.md#registerextension)
257
- - [registerExtensionSlot](API.md#registerextensionslot)
258
248
  - [registerOfflinePatientHandler](API.md#registerofflinepatienthandler)
259
249
  - [registerOmrsServiceWorker](API.md#registeromrsserviceworker)
260
250
  - [renderExtension](API.md#renderextension)
@@ -292,20 +282,15 @@
292
282
  - [toOmrsYearlessDateFormat](API.md#toomrsyearlessdateformat)
293
283
  - [toVisitTypeObject](API.md#tovisittypeobject)
294
284
  - [translateFrom](API.md#translatefrom)
295
- - [unregisterExtensionSlot](API.md#unregisterextensionslot)
296
285
  - [update](API.md#update)
297
- - [updateExtensionStore](API.md#updateextensionstore)
298
286
  - [updateVisit](API.md#updatevisit)
299
287
  - [useAssignedExtensionIds](API.md#useassignedextensionids)
300
- - [useAttachedExtensionIds](API.md#useattachedextensionids)
288
+ - [useAssignedExtensions](API.md#useassignedextensions)
301
289
  - [useBodyScrollLock](API.md#usebodyscrolllock)
302
290
  - [useConfig](API.md#useconfig)
303
291
  - [useConnectedExtensions](API.md#useconnectedextensions)
304
292
  - [useConnectivity](API.md#useconnectivity)
305
293
  - [useCurrentPatient](API.md#usecurrentpatient)
306
- - [useExtension](API.md#useextension)
307
- - [useExtensionSlot](API.md#useextensionslot)
308
- - [useExtensionSlotConfig](API.md#useextensionslotconfig)
309
294
  - [useExtensionSlotMeta](API.md#useextensionslotmeta)
310
295
  - [useExtensionStore](API.md#useextensionstore)
311
296
  - [useForceUpdate](API.md#useforceupdate)
@@ -459,22 +444,6 @@ ___
459
444
 
460
445
  ___
461
446
 
462
- ### MaybeAsync
463
-
464
- Ƭ **MaybeAsync**<`T`\>: `T` \| `Promise`<`T`\>
465
-
466
- #### Type parameters
467
-
468
- | Name |
469
- | :------ |
470
- | `T` |
471
-
472
- #### Defined in
473
-
474
- [packages/framework/esm-extensions/src/store.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L83)
475
-
476
- ___
477
-
478
447
  ### NavigationContextType
479
448
 
480
449
  Ƭ **NavigationContextType**: ``"workspace"`` \| ``"dialog"`` \| ``"link"``
@@ -585,7 +554,7 @@ ___
585
554
 
586
555
  #### Defined in
587
556
 
588
- [packages/framework/esm-config/src/types.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L55)
557
+ [packages/framework/esm-config/src/types.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L58)
589
558
 
590
559
  ___
591
560
 
@@ -629,7 +598,7 @@ ___
629
598
 
630
599
  #### Defined in
631
600
 
632
- [packages/framework/esm-config/src/types.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L62)
601
+ [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)
633
602
 
634
603
  ___
635
604
 
@@ -653,7 +622,7 @@ ___
653
622
 
654
623
  #### Defined in
655
624
 
656
- [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)
625
+ [packages/framework/esm-config/src/types.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L63)
657
626
 
658
627
  ## API Variables
659
628
 
@@ -720,7 +689,7 @@ and *must* only be used once within that `<ExtensionSlot>`.
720
689
 
721
690
  #### Defined in
722
691
 
723
- [packages/framework/esm-react-utils/src/Extension.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L22)
692
+ [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)
724
693
 
725
694
  ___
726
695
 
@@ -763,11 +732,13 @@ ___
763
732
 
764
733
  ### extensionStore
765
734
 
766
- • `Const` **extensionStore**: `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
735
+ • `Const` **extensionStore**: `Store`<[`ExtensionInternalStore`](interfaces/ExtensionInternalStore.md)\>
736
+
737
+ **`deprecated`** Use `getExtensionStore`. The structure of this store has also changed.
767
738
 
768
739
  #### Defined in
769
740
 
770
- [packages/framework/esm-extensions/src/store.ts:78](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L78)
741
+ [packages/framework/esm-extensions/src/index.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/index.ts#L12)
771
742
 
772
743
  ___
773
744
 
@@ -791,16 +762,6 @@ ___
791
762
 
792
763
  ___
793
764
 
794
- ### implementerToolsConfigStore
795
-
796
- • `Const` **implementerToolsConfigStore**: `Store`<[`ImplementerToolsConfigStore`](interfaces/ImplementerToolsConfigStore.md)\>
797
-
798
- #### Defined in
799
-
800
- [packages/framework/esm-config/src/module-config/state.ts:182](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L182)
801
-
802
- ___
803
-
804
765
  ### offlineUuidPrefix
805
766
 
806
767
  • `Const` **offlineUuidPrefix**: ``"OFFLINE+"``
@@ -851,16 +812,6 @@ ___
851
812
 
852
813
  ___
853
814
 
854
- ### temporaryConfigStore
855
-
856
- • `Const` **temporaryConfigStore**: `Store`<`TemporaryConfigStore`\>
857
-
858
- #### Defined in
859
-
860
- [packages/framework/esm-config/src/module-config/state.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L69)
861
-
862
- ___
863
-
864
815
  ### validators
865
816
 
866
817
  • `Const` **validators**: `Object`
@@ -1360,14 +1311,27 @@ ___
1360
1311
 
1361
1312
  ### attach
1362
1313
 
1363
- ▸ **attach**(`extensionSlotName`, `extensionId`): `void`
1314
+ ▸ **attach**(`slotName`, `extensionId`): `void`
1315
+
1316
+ Attach an extension to an extension slot.
1317
+
1318
+ This will cause the extension to be rendered into the specified
1319
+ extension slot, unless it is removed by configuration. Using
1320
+ `attach` is an alternative to specifying the `slot` or `slots`
1321
+ in the extension declaration.
1322
+
1323
+ It is particularly useful when creating a slot into which
1324
+ you want to render an existing extension. This enables you
1325
+ to do so without modifying the extension's declaration, which
1326
+ may be impractical or inappropriate, for example if you are
1327
+ writing a module for a specific implementation.
1364
1328
 
1365
1329
  #### Parameters
1366
1330
 
1367
- | Name | Type |
1368
- | :------ | :------ |
1369
- | `extensionSlotName` | `string` |
1370
- | `extensionId` | `string` |
1331
+ | Name | Type | Description |
1332
+ | :------ | :------ | :------ |
1333
+ | `slotName` | `string` | a name uniquely identifying the slot |
1334
+ | `extensionId` | `string` | an extension name, with an optional #-suffix to distinguish it from other instances of the same extension attached to the same slot. |
1371
1335
 
1372
1336
  #### Returns
1373
1337
 
@@ -1375,7 +1339,7 @@ ___
1375
1339
 
1376
1340
  #### Defined in
1377
1341
 
1378
- [packages/framework/esm-extensions/src/extensions.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L75)
1342
+ [packages/framework/esm-extensions/src/extensions.ts:126](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L126)
1379
1343
 
1380
1344
  ___
1381
1345
 
@@ -1576,7 +1540,7 @@ ___
1576
1540
 
1577
1541
  #### Defined in
1578
1542
 
1579
- [packages/framework/esm-config/src/module-config/module-config.ts:172](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L172)
1543
+ [packages/framework/esm-config/src/module-config/module-config.ts:170](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L170)
1580
1544
 
1581
1545
  ___
1582
1546
 
@@ -1604,6 +1568,8 @@ ___
1604
1568
 
1605
1569
  ▸ **detach**(`extensionSlotName`, `extensionId`): `void`
1606
1570
 
1571
+ Avoid using this. Extension attachments should be considered declarative.
1572
+
1607
1573
  #### Parameters
1608
1574
 
1609
1575
  | Name | Type |
@@ -1617,7 +1583,7 @@ ___
1617
1583
 
1618
1584
  #### Defined in
1619
1585
 
1620
- [packages/framework/esm-extensions/src/extensions.ts:105](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L105)
1586
+ [packages/framework/esm-extensions/src/extensions.ts:157](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L157)
1621
1587
 
1622
1588
  ___
1623
1589
 
@@ -1625,6 +1591,8 @@ ___
1625
1591
 
1626
1592
  ▸ **detachAll**(`extensionSlotName`): `void`
1627
1593
 
1594
+ Avoid using this. Extension attachments should be considered declarative.
1595
+
1628
1596
  #### Parameters
1629
1597
 
1630
1598
  | Name | Type |
@@ -1637,7 +1605,7 @@ ___
1637
1605
 
1638
1606
  #### Defined in
1639
1607
 
1640
- [packages/framework/esm-extensions/src/extensions.ts:128](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L128)
1608
+ [packages/framework/esm-extensions/src/extensions.ts:181](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L181)
1641
1609
 
1642
1610
  ___
1643
1611
 
@@ -1843,25 +1811,23 @@ The [store](https://github.com/developit/unistore#store) named `app`.
1843
1811
 
1844
1812
  ___
1845
1813
 
1846
- ### getAssignedIds
1814
+ ### getAssignedExtensions
1847
1815
 
1848
- ▸ **getAssignedIds**(`slotName`, `config`, `attachedIds`): `string`[]
1816
+ ▸ **getAssignedExtensions**(`slotName`): [`AssignedExtension`](interfaces/AssignedExtension.md)[]
1849
1817
 
1850
1818
  #### Parameters
1851
1819
 
1852
1820
  | Name | Type |
1853
1821
  | :------ | :------ |
1854
1822
  | `slotName` | `string` |
1855
- | `config` | [`ExtensionSlotConfigObject`](interfaces/ExtensionSlotConfigObject.md) |
1856
- | `attachedIds` | `string`[] |
1857
1823
 
1858
1824
  #### Returns
1859
1825
 
1860
- `string`[]
1826
+ [`AssignedExtension`](interfaces/AssignedExtension.md)[]
1861
1827
 
1862
1828
  #### Defined in
1863
1829
 
1864
- [packages/framework/esm-extensions/src/extensions.ts:178](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L178)
1830
+ [packages/framework/esm-extensions/src/extensions.ts:249](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L249)
1865
1831
 
1866
1832
  ___
1867
1833
 
@@ -1959,27 +1925,33 @@ of the execution of a function.
1959
1925
 
1960
1926
  #### Defined in
1961
1927
 
1962
- [packages/framework/esm-config/src/module-config/module-config.ts:200](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L200)
1928
+ [packages/framework/esm-config/src/module-config/module-config.ts:198](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L198)
1963
1929
 
1964
1930
  ___
1965
1931
 
1966
- ### getConfigStore
1932
+ ### getConnectedExtensions
1967
1933
 
1968
- ▸ **getConfigStore**(`moduleName`): `Store`<[`ConfigStore`](interfaces/ConfigStore.md)\>
1934
+ ▸ **getConnectedExtensions**(`assignedExtensions`, `online?`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
1935
+
1936
+ Filters a list of extensions according to whether they support the
1937
+ current connectivity status.
1969
1938
 
1970
1939
  #### Parameters
1971
1940
 
1972
- | Name | Type |
1973
- | :------ | :------ |
1974
- | `moduleName` | `string` |
1941
+ | Name | Type | Default value | Description |
1942
+ | :------ | :------ | :------ | :------ |
1943
+ | `assignedExtensions` | [`AssignedExtension`](interfaces/AssignedExtension.md)[] | `undefined` | The list of extensions to filter. |
1944
+ | `online` | `boolean` \| ``null`` | `null` | Whether the app is currently online. If `null`, uses `navigator.onLine`. |
1975
1945
 
1976
1946
  #### Returns
1977
1947
 
1978
- `Store`<[`ConfigStore`](interfaces/ConfigStore.md)\>
1948
+ [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
1949
+
1950
+ A list of extensions that should be rendered
1979
1951
 
1980
1952
  #### Defined in
1981
1953
 
1982
- [packages/framework/esm-config/src/module-config/state.ts:136](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L136)
1954
+ [packages/framework/esm-extensions/src/extensions.ts:239](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L239)
1983
1955
 
1984
1956
  ___
1985
1957
 
@@ -2004,32 +1976,22 @@ ___
2004
1976
 
2005
1977
  ___
2006
1978
 
2007
- ### getExtensionConfigStore
2008
-
2009
- ▸ **getExtensionConfigStore**(`extensionSlotModuleName`, `attachedExtensionSlotName`, `extensionId`): `Store`<[`ConfigStore`](interfaces/ConfigStore.md)\>
2010
-
2011
- #### Parameters
2012
-
2013
- | Name | Type |
2014
- | :------ | :------ |
2015
- | `extensionSlotModuleName` | `string` |
2016
- | `attachedExtensionSlotName` | `string` |
2017
- | `extensionId` | `string` |
2018
-
2019
- #### Returns
2020
-
2021
- `Store`<[`ConfigStore`](interfaces/ConfigStore.md)\>
2022
-
2023
- #### Defined in
2024
-
2025
- [packages/framework/esm-config/src/module-config/state.ts:166](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L166)
2026
-
2027
- ___
2028
-
2029
1979
  ### getExtensionNameFromId
2030
1980
 
2031
1981
  ▸ **getExtensionNameFromId**(`extensionId`): `string`
2032
1982
 
1983
+ Given an extension ID, which is a string uniquely identifying
1984
+ an instance of an extension within an extension slot, this
1985
+ returns the extension name.
1986
+
1987
+ **`example`**
1988
+ ```js
1989
+ getExtensionNameFromId("foo#bar")
1990
+ --> "foo"
1991
+ getExtensionNameFromId("baz")
1992
+ --> "baz"
1993
+ ```
1994
+
2033
1995
  #### Parameters
2034
1996
 
2035
1997
  | Name | Type |
@@ -2042,7 +2004,7 @@ ___
2042
2004
 
2043
2005
  #### Defined in
2044
2006
 
2045
- [packages/framework/esm-extensions/src/extensions.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L33)
2007
+ [packages/framework/esm-extensions/src/extensions.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L70)
2046
2008
 
2047
2009
  ___
2048
2010
 
@@ -2062,7 +2024,7 @@ ___
2062
2024
 
2063
2025
  #### Defined in
2064
2026
 
2065
- [packages/framework/esm-extensions/src/extensions.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L46)
2027
+ [packages/framework/esm-extensions/src/extensions.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L83)
2066
2028
 
2067
2029
  ___
2068
2030
 
@@ -2074,7 +2036,7 @@ ___
2074
2036
 
2075
2037
  | Name | Type |
2076
2038
  | :------ | :------ |
2077
- | `state` | [`ExtensionStore`](interfaces/ExtensionStore.md) |
2039
+ | `state` | [`ExtensionInternalStore`](interfaces/ExtensionInternalStore.md) |
2078
2040
  | `extensionId` | `string` |
2079
2041
 
2080
2042
  #### Returns
@@ -2083,47 +2045,25 @@ ___
2083
2045
 
2084
2046
  #### Defined in
2085
2047
 
2086
- [packages/framework/esm-extensions/src/extensions.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L38)
2048
+ [packages/framework/esm-extensions/src/extensions.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L75)
2087
2049
 
2088
2050
  ___
2089
2051
 
2090
- ### getExtensionSlotsConfigStore
2052
+ ### getExtensionStore
2091
2053
 
2092
- ▸ **getExtensionSlotsConfigStore**(`moduleName`): `Store`<[`ExtensionSlotConfigsStore`](interfaces/ExtensionSlotConfigsStore.md)\>
2093
-
2094
- #### Parameters
2054
+ `Const` **getExtensionStore**(): `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
2095
2055
 
2096
- | Name | Type |
2097
- | :------ | :------ |
2098
- | `moduleName` | `string` |
2056
+ This returns a [store](https://github.com/developit/unistore#store)
2057
+ that modules can use to get information about the state of the
2058
+ extension system.
2099
2059
 
2100
2060
  #### Returns
2101
2061
 
2102
- `Store`<[`ExtensionSlotConfigsStore`](interfaces/ExtensionSlotConfigsStore.md)\>
2062
+ `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
2103
2063
 
2104
2064
  #### Defined in
2105
2065
 
2106
- [packages/framework/esm-config/src/module-config/state.ts:157](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L157)
2107
-
2108
- ___
2109
-
2110
- ### getExtensionSlotsForModule
2111
-
2112
- ▸ **getExtensionSlotsForModule**(`moduleName`): `string`[]
2113
-
2114
- #### Parameters
2115
-
2116
- | Name | Type |
2117
- | :------ | :------ |
2118
- | `moduleName` | `string` |
2119
-
2120
- #### Returns
2121
-
2122
- `string`[]
2123
-
2124
- #### Defined in
2125
-
2126
- [packages/framework/esm-extensions/src/extensions.ts:303](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L303)
2066
+ [packages/framework/esm-extensions/src/store.ts:128](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L128)
2127
2067
 
2128
2068
  ___
2129
2069
 
@@ -2364,33 +2304,6 @@ ___
2364
2304
 
2365
2305
  ___
2366
2306
 
2367
- ### getUpdatedExtensionSlotInfo
2368
-
2369
- ▸ **getUpdatedExtensionSlotInfo**(`slotName`, `moduleName`, `extensionSlot`): [`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md)
2370
-
2371
- Returns information describing all extensions which can be rendered into an extension slot with
2372
- the specified name.
2373
- The returned information describe the extension itself, as well as the extension slot name(s)
2374
- with which it has been attached.
2375
-
2376
- #### Parameters
2377
-
2378
- | Name | Type | Description |
2379
- | :------ | :------ | :------ |
2380
- | `slotName` | `string` | The extension slot name for which matching extension info should be returned. |
2381
- | `moduleName` | `string` | The module name. Used for applying extension-specific config values to the result. |
2382
- | `extensionSlot` | [`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md) | The extension slot information object. |
2383
-
2384
- #### Returns
2385
-
2386
- [`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md)
2387
-
2388
- #### Defined in
2389
-
2390
- [packages/framework/esm-extensions/src/extensions.ts:330](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L330)
2391
-
2392
- ___
2393
-
2394
2307
  ### getVisitTypes
2395
2308
 
2396
2309
  ▸ **getVisitTypes**(): `Observable`<[`VisitType`](interfaces/VisitType.md)[]\>
@@ -2770,7 +2683,7 @@ Validate and interpolate defaults for `providedConfig` according to `schema`
2770
2683
 
2771
2684
  #### Defined in
2772
2685
 
2773
- [packages/framework/esm-config/src/module-config/module-config.ts:222](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L222)
2686
+ [packages/framework/esm-config/src/module-config/module-config.ts:220](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L220)
2774
2687
 
2775
2688
  ___
2776
2689
 
@@ -2791,7 +2704,7 @@ ___
2791
2704
 
2792
2705
  #### Defined in
2793
2706
 
2794
- [packages/framework/esm-config/src/module-config/module-config.ts:180](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L180)
2707
+ [packages/framework/esm-config/src/module-config/module-config.ts:178](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L178)
2795
2708
 
2796
2709
  ___
2797
2710
 
@@ -2880,48 +2793,6 @@ ___
2880
2793
 
2881
2794
  ___
2882
2795
 
2883
- ### registerExtension
2884
-
2885
- ▸ `Const` **registerExtension**(`name`, `details`): `void`
2886
-
2887
- #### Parameters
2888
-
2889
- | Name | Type |
2890
- | :------ | :------ |
2891
- | `name` | `string` |
2892
- | `details` | [`ExtensionDetails`](interfaces/ExtensionDetails.md) |
2893
-
2894
- #### Returns
2895
-
2896
- `void`
2897
-
2898
- #### Defined in
2899
-
2900
- [packages/framework/esm-extensions/src/extensions.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L62)
2901
-
2902
- ___
2903
-
2904
- ### registerExtensionSlot
2905
-
2906
- ▸ **registerExtensionSlot**(`moduleName`, `slotName`): `void`
2907
-
2908
- #### Parameters
2909
-
2910
- | Name | Type | Description |
2911
- | :------ | :------ | :------ |
2912
- | `moduleName` | `string` | The name of the module that contains the extension slot |
2913
- | `slotName` | `string` | The extension slot name that is actually used |
2914
-
2915
- #### Returns
2916
-
2917
- `void`
2918
-
2919
- #### Defined in
2920
-
2921
- [packages/framework/esm-extensions/src/extensions.ts:256](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L256)
2922
-
2923
- ___
2924
-
2925
2796
  ### registerOfflinePatientHandler
2926
2797
 
2927
2798
  ▸ **registerOfflinePatientHandler**(`identifier`, `handler`): `void`
@@ -3809,27 +3680,6 @@ ___
3809
3680
 
3810
3681
  ___
3811
3682
 
3812
- ### unregisterExtensionSlot
3813
-
3814
- ▸ **unregisterExtensionSlot**(`moduleName`, `slotName`): `void`
3815
-
3816
- #### Parameters
3817
-
3818
- | Name | Type |
3819
- | :------ | :------ |
3820
- | `moduleName` | `string` |
3821
- | `slotName` | `string` |
3822
-
3823
- #### Returns
3824
-
3825
- `void`
3826
-
3827
- #### Defined in
3828
-
3829
- [packages/framework/esm-extensions/src/extensions.ts:279](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L279)
3830
-
3831
- ___
3832
-
3833
3683
  ### update
3834
3684
 
3835
3685
  ▸ **update**<`T`\>(`obj`, `__namedParameters`, `value`): `T`
@@ -3858,26 +3708,6 @@ ___
3858
3708
 
3859
3709
  ___
3860
3710
 
3861
- ### updateExtensionStore
3862
-
3863
- ▸ **updateExtensionStore**(`updater`): `void`
3864
-
3865
- #### Parameters
3866
-
3867
- | Name | Type |
3868
- | :------ | :------ |
3869
- | `updater` | (`state`: [`ExtensionStore`](interfaces/ExtensionStore.md)) => [`MaybeAsync`](API.md#maybeasync)<[`ExtensionStore`](interfaces/ExtensionStore.md)\> |
3870
-
3871
- #### Returns
3872
-
3873
- `void`
3874
-
3875
- #### Defined in
3876
-
3877
- [packages/framework/esm-extensions/src/store.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L87)
3878
-
3879
- ___
3880
-
3881
3711
  ### updateVisit
3882
3712
 
3883
3713
  ▸ **updateVisit**(`uuid`, `payload`, `abortController`): `Observable`<`any`\>
@@ -3902,16 +3732,18 @@ ___
3902
3732
 
3903
3733
  ### useAssignedExtensionIds
3904
3734
 
3905
- ▸ **useAssignedExtensionIds**(`extensionSlotName`): `string`[]
3735
+ ▸ **useAssignedExtensionIds**(`slotName`): `string`[]
3906
3736
 
3907
3737
  Gets the assigned extension ids for a given extension slot name.
3908
3738
  Does not consider if offline or online.
3909
3739
 
3740
+ **`deprecated`** Use `useAssignedExtensions`
3741
+
3910
3742
  #### Parameters
3911
3743
 
3912
3744
  | Name | Type | Description |
3913
3745
  | :------ | :------ | :------ |
3914
- | `extensionSlotName` | `string` | The name of the slot to get the assigned IDs for. |
3746
+ | `slotName` | `string` | The name of the slot to get the assigned IDs for. |
3915
3747
 
3916
3748
  #### Returns
3917
3749
 
@@ -3919,29 +3751,30 @@ Does not consider if offline or online.
3919
3751
 
3920
3752
  #### Defined in
3921
3753
 
3922
- [packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts#L11)
3754
+ [packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts#L12)
3923
3755
 
3924
3756
  ___
3925
3757
 
3926
- ### useAttachedExtensionIds
3758
+ ### useAssignedExtensions
3927
3759
 
3928
- ▸ **useAttachedExtensionIds**(`extensionSlotName`): `string`[]
3760
+ ▸ **useAssignedExtensions**(`slotName`): [`AssignedExtension`](interfaces/AssignedExtension.md)[]
3929
3761
 
3930
- Gets the assigned extension ids for the given slot.
3762
+ Gets the assigned extensions for a given extension slot name.
3763
+ Does not consider if offline or online.
3931
3764
 
3932
3765
  #### Parameters
3933
3766
 
3934
- | Name | Type |
3935
- | :------ | :------ |
3936
- | `extensionSlotName` | `string` |
3767
+ | Name | Type | Description |
3768
+ | :------ | :------ | :------ |
3769
+ | `slotName` | `string` | The name of the slot to get the assigned extensions for. |
3937
3770
 
3938
3771
  #### Returns
3939
3772
 
3940
- `string`[]
3773
+ [`AssignedExtension`](interfaces/AssignedExtension.md)[]
3941
3774
 
3942
3775
  #### Defined in
3943
3776
 
3944
- [packages/framework/esm-react-utils/src/useAttachedExtensionIds.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useAttachedExtensionIds.ts#L11)
3777
+ [packages/framework/esm-react-utils/src/useAssignedExtensions.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useAssignedExtensions.ts#L10)
3945
3778
 
3946
3779
  ___
3947
3780
 
@@ -3993,7 +3826,7 @@ ___
3993
3826
 
3994
3827
  ### useConnectedExtensions
3995
3828
 
3996
- ▸ **useConnectedExtensions**(`extensionSlotName`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
3829
+ ▸ **useConnectedExtensions**(`slotName`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
3997
3830
 
3998
3831
  Gets the assigned extension for a given extension slot name.
3999
3832
  Considers if offline or online.
@@ -4002,7 +3835,7 @@ Considers if offline or online.
4002
3835
 
4003
3836
  | Name | Type | Description |
4004
3837
  | :------ | :------ | :------ |
4005
- | `extensionSlotName` | `string` | The name of the slot to get the assigned extensions for. |
3838
+ | `slotName` | `string` | The name of the slot to get the assigned extensions for. |
4006
3839
 
4007
3840
  #### Returns
4008
3841
 
@@ -4010,7 +3843,7 @@ Considers if offline or online.
4010
3843
 
4011
3844
  #### Defined in
4012
3845
 
4013
- [packages/framework/esm-react-utils/src/useConnectedExtensions.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L36)
3846
+ [packages/framework/esm-react-utils/src/useConnectedExtensions.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L14)
4014
3847
 
4015
3848
  ___
4016
3849
 
@@ -4048,78 +3881,6 @@ ___
4048
3881
 
4049
3882
  ___
4050
3883
 
4051
- ### useExtension
4052
-
4053
- ▸ **useExtension**<`TRef`\>(`state?`): [`RefObject`<`TRef`\>, [`ExtensionData`](interfaces/ExtensionData.md) \| `undefined`]
4054
-
4055
- #### Type parameters
4056
-
4057
- | Name | Type |
4058
- | :------ | :------ |
4059
- | `TRef` | extends `HTMLElement` |
4060
-
4061
- #### Parameters
4062
-
4063
- | Name | Type |
4064
- | :------ | :------ |
4065
- | `state?` | `Record`<`string`, `any`\> |
4066
-
4067
- #### Returns
4068
-
4069
- [`RefObject`<`TRef`\>, [`ExtensionData`](interfaces/ExtensionData.md) \| `undefined`]
4070
-
4071
- #### Defined in
4072
-
4073
- [packages/framework/esm-react-utils/src/useExtension.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtension.ts#L5)
4074
-
4075
- ___
4076
-
4077
- ### useExtensionSlot
4078
-
4079
- ▸ **useExtensionSlot**(`extensionSlotName`): `Object`
4080
-
4081
- #### Parameters
4082
-
4083
- | Name | Type |
4084
- | :------ | :------ |
4085
- | `extensionSlotName` | `string` |
4086
-
4087
- #### Returns
4088
-
4089
- `Object`
4090
-
4091
- | Name | Type |
4092
- | :------ | :------ |
4093
- | `extensionSlotModuleName` | `string` |
4094
- | `extensionSlotName` | `string` |
4095
- | `extensions` | [`ConnectedExtension`](interfaces/ConnectedExtension.md)[] |
4096
-
4097
- #### Defined in
4098
-
4099
- [packages/framework/esm-react-utils/src/useExtensionSlot.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionSlot.ts#L9)
4100
-
4101
- ___
4102
-
4103
- ### useExtensionSlotConfig
4104
-
4105
- ▸ **useExtensionSlotConfig**(`extensionSlotName`): [`ExtensionSlotConfigObject`](interfaces/ExtensionSlotConfigObject.md)
4106
-
4107
- #### Parameters
4108
-
4109
- | Name | Type |
4110
- | :------ | :------ |
4111
- | `extensionSlotName` | `string` |
4112
-
4113
- #### Returns
4114
-
4115
- [`ExtensionSlotConfigObject`](interfaces/ExtensionSlotConfigObject.md)
4116
-
4117
- #### Defined in
4118
-
4119
- [packages/framework/esm-react-utils/src/useExtensionSlotConfig.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionSlotConfig.ts#L16)
4120
-
4121
- ___
4122
-
4123
3884
  ### useExtensionSlotMeta
4124
3885
 
4125
3886
  ▸ **useExtensionSlotMeta**<`T`\>(`extensionSlotName`): `Object`
@@ -4152,16 +3913,22 @@ ___
4152
3913
 
4153
3914
  ▸ `Const` **useExtensionStore**(): `T`
4154
3915
 
3916
+ The implementation of this will soon undergo a breaking change.
3917
+ This will return an `ExtensionStore` rather than `ExtensionInternalStore`.
3918
+
4155
3919
  #### Returns
4156
3920
 
4157
3921
  `T`
4158
3922
 
4159
3923
  #### Defined in
4160
3924
 
4161
- [packages/framework/esm-react-utils/src/useExtensionStore.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L4)
3925
+ [packages/framework/esm-react-utils/src/useExtensionStore.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L11)
4162
3926
 
4163
3927
  ▸ `Const` **useExtensionStore**(`actions`): `T` & [`BoundActions`](API.md#boundactions)
4164
3928
 
3929
+ The implementation of this will soon undergo a breaking change.
3930
+ This will return an `ExtensionStore` rather than `ExtensionInternalStore`.
3931
+
4165
3932
  #### Parameters
4166
3933
 
4167
3934
  | Name | Type |
@@ -4174,10 +3941,13 @@ ___
4174
3941
 
4175
3942
  #### Defined in
4176
3943
 
4177
- [packages/framework/esm-react-utils/src/useExtensionStore.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L4)
3944
+ [packages/framework/esm-react-utils/src/useExtensionStore.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L11)
4178
3945
 
4179
3946
  ▸ `Const` **useExtensionStore**(`actions?`): `T` & [`BoundActions`](API.md#boundactions)
4180
3947
 
3948
+ The implementation of this will soon undergo a breaking change.
3949
+ This will return an `ExtensionStore` rather than `ExtensionInternalStore`.
3950
+
4181
3951
  #### Parameters
4182
3952
 
4183
3953
  | Name | Type |
@@ -4190,7 +3960,7 @@ ___
4190
3960
 
4191
3961
  #### Defined in
4192
3962
 
4193
- [packages/framework/esm-react-utils/src/useExtensionStore.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L4)
3963
+ [packages/framework/esm-react-utils/src/useExtensionStore.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L11)
4194
3964
 
4195
3965
  ___
4196
3966