@openmrs/esm-framework 3.2.1-pre.967 → 3.2.1-pre.970

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
@@ -79,19 +79,17 @@
79
79
  - [dispatchPrecacheStaticDependencies](API.md#dispatchprecachestaticdependencies)
80
80
  - [generateOfflineUuid](API.md#generateofflineuuid)
81
81
  - [getAppState](API.md#getappstate)
82
- - [getAssignedIds](API.md#getassignedids)
82
+ - [getAssignedExtensions](API.md#getassignedextensions)
83
83
  - [getAsyncExtensionLifecycle](API.md#getasyncextensionlifecycle)
84
84
  - [getAsyncLifecycle](API.md#getasynclifecycle)
85
85
  - [getConfig](API.md#getconfig)
86
- - [getConfigStore](API.md#getconfigstore)
86
+ - [getConnectedExtensions](API.md#getconnectedextensions)
87
87
  - [getCurrentOfflineMode](API.md#getcurrentofflinemode)
88
88
  - [getCustomProps](API.md#getcustomprops)
89
- - [getExtensionConfigStore](API.md#getextensionconfigstore)
90
89
  - [getExtensionNameFromId](API.md#getextensionnamefromid)
91
90
  - [getExtensionRegistration](API.md#getextensionregistration)
92
91
  - [getExtensionRegistrationFrom](API.md#getextensionregistrationfrom)
93
- - [getExtensionSlotsConfigStore](API.md#getextensionslotsconfigstore)
94
- - [getExtensionSlotsForModule](API.md#getextensionslotsformodule)
92
+ - [getExtensionStore](API.md#getextensionstore)
95
93
  - [getGlobalStore](API.md#getglobalstore)
96
94
  - [getLifecycle](API.md#getlifecycle)
97
95
  - [getOfflinePatientDataStore](API.md#getofflinepatientdatastore)
@@ -101,7 +99,6 @@
101
99
  - [getSynchronizationItem](API.md#getsynchronizationitem)
102
100
  - [getSynchronizationItems](API.md#getsynchronizationitems)
103
101
  - [getSynchronizationItemsFor](API.md#getsynchronizationitemsfor)
104
- - [getUpdatedExtensionSlotInfo](API.md#getupdatedextensionslotinfo)
105
102
  - [handleApiError](API.md#handleapierror)
106
103
  - [inRange](API.md#inrange)
107
104
  - [integrateBreakpoints](API.md#integratebreakpoints)
@@ -117,8 +114,6 @@
117
114
  - [pushNavigationContext](API.md#pushnavigationcontext)
118
115
  - [queueSynchronizationItem](API.md#queuesynchronizationitem)
119
116
  - [queueSynchronizationItemFor](API.md#queuesynchronizationitemfor)
120
- - [registerExtension](API.md#registerextension)
121
- - [registerExtensionSlot](API.md#registerextensionslot)
122
117
  - [registerOfflinePatientHandler](API.md#registerofflinepatienthandler)
123
118
  - [registerOmrsServiceWorker](API.md#registeromrsserviceworker)
124
119
  - [renderExtension](API.md#renderextension)
@@ -146,19 +141,14 @@
146
141
  - [switchTo](API.md#switchto)
147
142
  - [syncOfflinePatientData](API.md#syncofflinepatientdata)
148
143
  - [translateFrom](API.md#translatefrom)
149
- - [unregisterExtensionSlot](API.md#unregisterextensionslot)
150
144
  - [update](API.md#update)
151
- - [updateExtensionStore](API.md#updateextensionstore)
152
145
  - [useAssignedExtensionIds](API.md#useassignedextensionids)
153
- - [useAttachedExtensionIds](API.md#useattachedextensionids)
146
+ - [useAssignedExtensions](API.md#useassignedextensions)
154
147
  - [useBodyScrollLock](API.md#usebodyscrolllock)
155
148
  - [useConfig](API.md#useconfig)
156
149
  - [useConnectedExtensions](API.md#useconnectedextensions)
157
150
  - [useConnectivity](API.md#useconnectivity)
158
151
  - [useCurrentPatient](API.md#usecurrentpatient)
159
- - [useExtension](API.md#useextension)
160
- - [useExtensionSlot](API.md#useextensionslot)
161
- - [useExtensionSlotConfig](API.md#useextensionslotconfig)
162
152
  - [useExtensionSlotMeta](API.md#useextensionslotmeta)
163
153
  - [useExtensionStore](API.md#useextensionstore)
164
154
  - [useForceUpdate](API.md#useforceupdate)
@@ -242,7 +232,7 @@ ___
242
232
 
243
233
  ### Actions
244
234
 
245
- Ƭ **Actions**: `Function` \| { [key: string]: `Function`; }
235
+ Ƭ **Actions**: `Function` \| { `[key: string]`: `Function`; }
246
236
 
247
237
  #### Defined in
248
238
 
@@ -270,7 +260,7 @@ ___
270
260
 
271
261
  #### Defined in
272
262
 
273
- [packages/framework/esm-config/src/types.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L30)
263
+ [packages/framework/esm-config/src/types.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L31)
274
264
 
275
265
  ___
276
266
 
@@ -324,22 +314,6 @@ ___
324
314
 
325
315
  ___
326
316
 
327
- ### MaybeAsync
328
-
329
- Ƭ **MaybeAsync**<`T`\>: `T` \| `Promise`<`T`\>
330
-
331
- #### Type parameters
332
-
333
- | Name |
334
- | :------ |
335
- | `T` |
336
-
337
- #### Defined in
338
-
339
- [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)
340
-
341
- ___
342
-
343
317
  ### NavigationContextType
344
318
 
345
319
  Ƭ **NavigationContextType**: ``"workspace"`` \| ``"dialog"`` \| ``"link"``
@@ -455,7 +429,7 @@ ___
455
429
 
456
430
  #### Defined in
457
431
 
458
- [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)
432
+ [packages/framework/esm-config/src/types.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L59)
459
433
 
460
434
  ___
461
435
 
@@ -499,7 +473,7 @@ ___
499
473
 
500
474
  #### Defined in
501
475
 
502
- [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)
476
+ [packages/framework/esm-config/src/types.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L66)
503
477
 
504
478
  ___
505
479
 
@@ -523,7 +497,7 @@ ___
523
497
 
524
498
  #### Defined in
525
499
 
526
- [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)
500
+ [packages/framework/esm-config/src/types.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L64)
527
501
 
528
502
  ## API Variables
529
503
 
@@ -620,7 +594,7 @@ and *must* only be used once within that `<ExtensionSlot>`.
620
594
 
621
595
  #### Defined in
622
596
 
623
- [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)
597
+ [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)
624
598
 
625
599
  ___
626
600
 
@@ -663,21 +637,13 @@ ___
663
637
 
664
638
  ### extensionStore
665
639
 
666
- • **extensionStore**: `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
667
-
668
- #### Defined in
640
+ • **extensionStore**: `Store`<[`ExtensionInternalStore`](interfaces/ExtensionInternalStore.md)\>
669
641
 
670
- [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)
671
-
672
- ___
673
-
674
- ### implementerToolsConfigStore
675
-
676
- • **implementerToolsConfigStore**: `Store`<[`ImplementerToolsConfigStore`](interfaces/ImplementerToolsConfigStore.md)\>
642
+ **`deprecated`** Use `getExtensionStore`. The structure of this store has also changed.
677
643
 
678
644
  #### Defined in
679
645
 
680
- [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)
646
+ [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)
681
647
 
682
648
  ___
683
649
 
@@ -721,16 +687,6 @@ ___
721
687
 
722
688
  ___
723
689
 
724
- ### temporaryConfigStore
725
-
726
- • **temporaryConfigStore**: `Store`<`TemporaryConfigStore`\>
727
-
728
- #### Defined in
729
-
730
- [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)
731
-
732
- ___
733
-
734
690
  ### validators
735
691
 
736
692
  • **validators**: `Object`
@@ -1807,14 +1763,27 @@ ___
1807
1763
 
1808
1764
  ### attach
1809
1765
 
1810
- ▸ **attach**(`extensionSlotName`, `extensionId`): `void`
1766
+ ▸ **attach**(`slotName`, `extensionId`): `void`
1767
+
1768
+ Attach an extension to an extension slot.
1769
+
1770
+ This will cause the extension to be rendered into the specified
1771
+ extension slot, unless it is removed by configuration. Using
1772
+ `attach` is an alternative to specifying the `slot` or `slots`
1773
+ in the extension declaration.
1774
+
1775
+ It is particularly useful when creating a slot into which
1776
+ you want to render an existing extension. This enables you
1777
+ to do so without modifying the extension's declaration, which
1778
+ may be impractical or inappropriate, for example if you are
1779
+ writing a module for a specific implementation.
1811
1780
 
1812
1781
  #### Parameters
1813
1782
 
1814
- | Name | Type |
1815
- | :------ | :------ |
1816
- | `extensionSlotName` | `string` |
1817
- | `extensionId` | `string` |
1783
+ | Name | Type | Description |
1784
+ | :------ | :------ | :------ |
1785
+ | `slotName` | `string` | a name uniquely identifying the slot |
1786
+ | `extensionId` | `string` | an extension name, with an optional #-suffix to distinguish it from other instances of the same extension attached to the same slot. |
1818
1787
 
1819
1788
  #### Returns
1820
1789
 
@@ -1822,7 +1791,7 @@ ___
1822
1791
 
1823
1792
  #### Defined in
1824
1793
 
1825
- [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)
1794
+ [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)
1826
1795
 
1827
1796
  ___
1828
1797
 
@@ -2069,7 +2038,7 @@ ___
2069
2038
 
2070
2039
  #### Defined in
2071
2040
 
2072
- [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)
2041
+ [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)
2073
2042
 
2074
2043
  ___
2075
2044
 
@@ -2099,6 +2068,8 @@ ___
2099
2068
 
2100
2069
  ▸ **detach**(`extensionSlotName`, `extensionId`): `void`
2101
2070
 
2071
+ Avoid using this. Extension attachments should be considered declarative.
2072
+
2102
2073
  #### Parameters
2103
2074
 
2104
2075
  | Name | Type |
@@ -2112,7 +2083,7 @@ ___
2112
2083
 
2113
2084
  #### Defined in
2114
2085
 
2115
- [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)
2086
+ [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)
2116
2087
 
2117
2088
  ___
2118
2089
 
@@ -2120,6 +2091,8 @@ ___
2120
2091
 
2121
2092
  ▸ **detachAll**(`extensionSlotName`): `void`
2122
2093
 
2094
+ Avoid using this. Extension attachments should be considered declarative.
2095
+
2123
2096
  #### Parameters
2124
2097
 
2125
2098
  | Name | Type |
@@ -2132,7 +2105,7 @@ ___
2132
2105
 
2133
2106
  #### Defined in
2134
2107
 
2135
- [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)
2108
+ [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)
2136
2109
 
2137
2110
  ___
2138
2111
 
@@ -2248,25 +2221,23 @@ The [store](https://github.com/developit/unistore#store) named `app`.
2248
2221
 
2249
2222
  ___
2250
2223
 
2251
- ### getAssignedIds
2224
+ ### getAssignedExtensions
2252
2225
 
2253
- ▸ **getAssignedIds**(`slotName`, `config`, `attachedIds`): `string`[]
2226
+ ▸ **getAssignedExtensions**(`slotName`): [`AssignedExtension`](interfaces/AssignedExtension.md)[]
2254
2227
 
2255
2228
  #### Parameters
2256
2229
 
2257
2230
  | Name | Type |
2258
2231
  | :------ | :------ |
2259
2232
  | `slotName` | `string` |
2260
- | `config` | [`ExtensionSlotConfigObject`](interfaces/ExtensionSlotConfigObject.md) |
2261
- | `attachedIds` | `string`[] |
2262
2233
 
2263
2234
  #### Returns
2264
2235
 
2265
- `string`[]
2236
+ [`AssignedExtension`](interfaces/AssignedExtension.md)[]
2266
2237
 
2267
2238
  #### Defined in
2268
2239
 
2269
- [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)
2240
+ [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)
2270
2241
 
2271
2242
  ___
2272
2243
 
@@ -2364,27 +2335,33 @@ of the execution of a function.
2364
2335
 
2365
2336
  #### Defined in
2366
2337
 
2367
- [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)
2338
+ [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)
2368
2339
 
2369
2340
  ___
2370
2341
 
2371
- ### getConfigStore
2342
+ ### getConnectedExtensions
2372
2343
 
2373
- ▸ **getConfigStore**(`moduleName`): `Store`<[`ConfigStore`](interfaces/ConfigStore.md)\>
2344
+ ▸ **getConnectedExtensions**(`assignedExtensions`, `online?`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
2345
+
2346
+ Filters a list of extensions according to whether they support the
2347
+ current connectivity status.
2374
2348
 
2375
2349
  #### Parameters
2376
2350
 
2377
- | Name | Type |
2378
- | :------ | :------ |
2379
- | `moduleName` | `string` |
2351
+ | Name | Type | Default value | Description |
2352
+ | :------ | :------ | :------ | :------ |
2353
+ | `assignedExtensions` | [`AssignedExtension`](interfaces/AssignedExtension.md)[] | `undefined` | The list of extensions to filter. |
2354
+ | `online` | ``null`` \| `boolean` | `null` | Whether the app is currently online. If `null`, uses `navigator.onLine`. |
2380
2355
 
2381
2356
  #### Returns
2382
2357
 
2383
- `Store`<[`ConfigStore`](interfaces/ConfigStore.md)\>
2358
+ [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
2359
+
2360
+ A list of extensions that should be rendered
2384
2361
 
2385
2362
  #### Defined in
2386
2363
 
2387
- [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)
2364
+ [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)
2388
2365
 
2389
2366
  ___
2390
2367
 
@@ -2423,32 +2400,22 @@ ___
2423
2400
 
2424
2401
  ___
2425
2402
 
2426
- ### getExtensionConfigStore
2427
-
2428
- ▸ **getExtensionConfigStore**(`extensionSlotModuleName`, `attachedExtensionSlotName`, `extensionId`): `Store`<[`ConfigStore`](interfaces/ConfigStore.md)\>
2429
-
2430
- #### Parameters
2431
-
2432
- | Name | Type |
2433
- | :------ | :------ |
2434
- | `extensionSlotModuleName` | `string` |
2435
- | `attachedExtensionSlotName` | `string` |
2436
- | `extensionId` | `string` |
2437
-
2438
- #### Returns
2439
-
2440
- `Store`<[`ConfigStore`](interfaces/ConfigStore.md)\>
2441
-
2442
- #### Defined in
2443
-
2444
- [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)
2445
-
2446
- ___
2447
-
2448
2403
  ### getExtensionNameFromId
2449
2404
 
2450
2405
  ▸ **getExtensionNameFromId**(`extensionId`): `string`
2451
2406
 
2407
+ Given an extension ID, which is a string uniquely identifying
2408
+ an instance of an extension within an extension slot, this
2409
+ returns the extension name.
2410
+
2411
+ **`example`**
2412
+ ```js
2413
+ getExtensionNameFromId("foo#bar")
2414
+ --> "foo"
2415
+ getExtensionNameFromId("baz")
2416
+ --> "baz"
2417
+ ```
2418
+
2452
2419
  #### Parameters
2453
2420
 
2454
2421
  | Name | Type |
@@ -2461,7 +2428,7 @@ ___
2461
2428
 
2462
2429
  #### Defined in
2463
2430
 
2464
- [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)
2431
+ [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)
2465
2432
 
2466
2433
  ___
2467
2434
 
@@ -2481,7 +2448,7 @@ ___
2481
2448
 
2482
2449
  #### Defined in
2483
2450
 
2484
- [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)
2451
+ [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)
2485
2452
 
2486
2453
  ___
2487
2454
 
@@ -2493,7 +2460,7 @@ ___
2493
2460
 
2494
2461
  | Name | Type |
2495
2462
  | :------ | :------ |
2496
- | `state` | [`ExtensionStore`](interfaces/ExtensionStore.md) |
2463
+ | `state` | [`ExtensionInternalStore`](interfaces/ExtensionInternalStore.md) |
2497
2464
  | `extensionId` | `string` |
2498
2465
 
2499
2466
  #### Returns
@@ -2502,47 +2469,25 @@ ___
2502
2469
 
2503
2470
  #### Defined in
2504
2471
 
2505
- [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)
2506
-
2507
- ___
2508
-
2509
- ### getExtensionSlotsConfigStore
2510
-
2511
- ▸ **getExtensionSlotsConfigStore**(`moduleName`): `Store`<[`ExtensionSlotConfigsStore`](interfaces/ExtensionSlotConfigsStore.md)\>
2512
-
2513
- #### Parameters
2514
-
2515
- | Name | Type |
2516
- | :------ | :------ |
2517
- | `moduleName` | `string` |
2518
-
2519
- #### Returns
2520
-
2521
- `Store`<[`ExtensionSlotConfigsStore`](interfaces/ExtensionSlotConfigsStore.md)\>
2522
-
2523
- #### Defined in
2524
-
2525
- [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)
2472
+ [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)
2526
2473
 
2527
2474
  ___
2528
2475
 
2529
- ### getExtensionSlotsForModule
2476
+ ### getExtensionStore
2530
2477
 
2531
- ▸ **getExtensionSlotsForModule**(`moduleName`): `string`[]
2478
+ `Const` **getExtensionStore**(): `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
2532
2479
 
2533
- #### Parameters
2534
-
2535
- | Name | Type |
2536
- | :------ | :------ |
2537
- | `moduleName` | `string` |
2480
+ This returns a [store](https://github.com/developit/unistore#store)
2481
+ that modules can use to get information about the state of the
2482
+ extension system.
2538
2483
 
2539
2484
  #### Returns
2540
2485
 
2541
- `string`[]
2486
+ `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
2542
2487
 
2543
2488
  #### Defined in
2544
2489
 
2545
- [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)
2490
+ [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)
2546
2491
 
2547
2492
  ___
2548
2493
 
@@ -2773,33 +2718,6 @@ Returns all currently queued up sync items of a given user.
2773
2718
 
2774
2719
  ___
2775
2720
 
2776
- ### getUpdatedExtensionSlotInfo
2777
-
2778
- ▸ **getUpdatedExtensionSlotInfo**(`slotName`, `moduleName`, `extensionSlot`): [`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md)
2779
-
2780
- Returns information describing all extensions which can be rendered into an extension slot with
2781
- the specified name.
2782
- The returned information describe the extension itself, as well as the extension slot name(s)
2783
- with which it has been attached.
2784
-
2785
- #### Parameters
2786
-
2787
- | Name | Type | Description |
2788
- | :------ | :------ | :------ |
2789
- | `slotName` | `string` | The extension slot name for which matching extension info should be returned. |
2790
- | `moduleName` | `string` | The module name. Used for applying extension-specific config values to the result. |
2791
- | `extensionSlot` | [`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md) | The extension slot information object. |
2792
-
2793
- #### Returns
2794
-
2795
- [`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md)
2796
-
2797
- #### Defined in
2798
-
2799
- [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)
2800
-
2801
- ___
2802
-
2803
2721
  ### handleApiError
2804
2722
 
2805
2723
  ▸ **handleApiError**(): (`incomingResponseErr`: `any`) => `void`
@@ -3036,7 +2954,7 @@ Validate and interpolate defaults for `providedConfig` according to `schema`
3036
2954
 
3037
2955
  #### Defined in
3038
2956
 
3039
- [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)
2957
+ [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)
3040
2958
 
3041
2959
  ___
3042
2960
 
@@ -3057,7 +2975,7 @@ ___
3057
2975
 
3058
2976
  #### Defined in
3059
2977
 
3060
- [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)
2978
+ [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)
3061
2979
 
3062
2980
  ___
3063
2981
 
@@ -3150,48 +3068,6 @@ Enqueues a new item in the sync queue for a specific user.
3150
3068
 
3151
3069
  ___
3152
3070
 
3153
- ### registerExtension
3154
-
3155
- ▸ `Const` **registerExtension**(`name`, `details`): `void`
3156
-
3157
- #### Parameters
3158
-
3159
- | Name | Type |
3160
- | :------ | :------ |
3161
- | `name` | `string` |
3162
- | `details` | [`ExtensionDetails`](interfaces/ExtensionDetails.md) |
3163
-
3164
- #### Returns
3165
-
3166
- `void`
3167
-
3168
- #### Defined in
3169
-
3170
- [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)
3171
-
3172
- ___
3173
-
3174
- ### registerExtensionSlot
3175
-
3176
- ▸ **registerExtensionSlot**(`moduleName`, `slotName`): `void`
3177
-
3178
- #### Parameters
3179
-
3180
- | Name | Type | Description |
3181
- | :------ | :------ | :------ |
3182
- | `moduleName` | `string` | The name of the module that contains the extension slot |
3183
- | `slotName` | `string` | The extension slot name that is actually used |
3184
-
3185
- #### Returns
3186
-
3187
- `void`
3188
-
3189
- #### Defined in
3190
-
3191
- [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)
3192
-
3193
- ___
3194
-
3195
3071
  ### registerOfflinePatientHandler
3196
3072
 
3197
3073
  ▸ **registerOfflinePatientHandler**(`identifier`, `handler`): `void`
@@ -3862,27 +3738,6 @@ ___
3862
3738
 
3863
3739
  ___
3864
3740
 
3865
- ### unregisterExtensionSlot
3866
-
3867
- ▸ **unregisterExtensionSlot**(`moduleName`, `slotName`): `void`
3868
-
3869
- #### Parameters
3870
-
3871
- | Name | Type |
3872
- | :------ | :------ |
3873
- | `moduleName` | `string` |
3874
- | `slotName` | `string` |
3875
-
3876
- #### Returns
3877
-
3878
- `void`
3879
-
3880
- #### Defined in
3881
-
3882
- [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)
3883
-
3884
- ___
3885
-
3886
3741
  ### update
3887
3742
 
3888
3743
  ▸ **update**<`T`\>(`obj`, `__namedParameters`, `value`): `T`
@@ -3911,38 +3766,20 @@ ___
3911
3766
 
3912
3767
  ___
3913
3768
 
3914
- ### updateExtensionStore
3915
-
3916
- ▸ **updateExtensionStore**(`updater`): `void`
3917
-
3918
- #### Parameters
3919
-
3920
- | Name | Type |
3921
- | :------ | :------ |
3922
- | `updater` | (`state`: [`ExtensionStore`](interfaces/ExtensionStore.md)) => [`MaybeAsync`](API.md#maybeasync)<[`ExtensionStore`](interfaces/ExtensionStore.md)\> |
3923
-
3924
- #### Returns
3925
-
3926
- `void`
3927
-
3928
- #### Defined in
3929
-
3930
- [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)
3931
-
3932
- ___
3933
-
3934
3769
  ### useAssignedExtensionIds
3935
3770
 
3936
- ▸ **useAssignedExtensionIds**(`extensionSlotName`): `string`[]
3771
+ ▸ **useAssignedExtensionIds**(`slotName`): `string`[]
3937
3772
 
3938
3773
  Gets the assigned extension ids for a given extension slot name.
3939
3774
  Does not consider if offline or online.
3940
3775
 
3776
+ **`deprecated`** Use `useAssignedExtensions`
3777
+
3941
3778
  #### Parameters
3942
3779
 
3943
3780
  | Name | Type | Description |
3944
3781
  | :------ | :------ | :------ |
3945
- | `extensionSlotName` | `string` | The name of the slot to get the assigned IDs for. |
3782
+ | `slotName` | `string` | The name of the slot to get the assigned IDs for. |
3946
3783
 
3947
3784
  #### Returns
3948
3785
 
@@ -3950,29 +3787,30 @@ Does not consider if offline or online.
3950
3787
 
3951
3788
  #### Defined in
3952
3789
 
3953
- [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)
3790
+ [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)
3954
3791
 
3955
3792
  ___
3956
3793
 
3957
- ### useAttachedExtensionIds
3794
+ ### useAssignedExtensions
3958
3795
 
3959
- ▸ **useAttachedExtensionIds**(`extensionSlotName`): `string`[]
3796
+ ▸ **useAssignedExtensions**(`slotName`): [`AssignedExtension`](interfaces/AssignedExtension.md)[]
3960
3797
 
3961
- Gets the assigned extension ids for the given slot.
3798
+ Gets the assigned extensions for a given extension slot name.
3799
+ Does not consider if offline or online.
3962
3800
 
3963
3801
  #### Parameters
3964
3802
 
3965
- | Name | Type |
3966
- | :------ | :------ |
3967
- | `extensionSlotName` | `string` |
3803
+ | Name | Type | Description |
3804
+ | :------ | :------ | :------ |
3805
+ | `slotName` | `string` | The name of the slot to get the assigned extensions for. |
3968
3806
 
3969
3807
  #### Returns
3970
3808
 
3971
- `string`[]
3809
+ [`AssignedExtension`](interfaces/AssignedExtension.md)[]
3972
3810
 
3973
3811
  #### Defined in
3974
3812
 
3975
- [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)
3813
+ [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)
3976
3814
 
3977
3815
  ___
3978
3816
 
@@ -4024,7 +3862,7 @@ ___
4024
3862
 
4025
3863
  ### useConnectedExtensions
4026
3864
 
4027
- ▸ **useConnectedExtensions**(`extensionSlotName`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
3865
+ ▸ **useConnectedExtensions**(`slotName`): [`ConnectedExtension`](interfaces/ConnectedExtension.md)[]
4028
3866
 
4029
3867
  Gets the assigned extension for a given extension slot name.
4030
3868
  Considers if offline or online.
@@ -4033,7 +3871,7 @@ Considers if offline or online.
4033
3871
 
4034
3872
  | Name | Type | Description |
4035
3873
  | :------ | :------ | :------ |
4036
- | `extensionSlotName` | `string` | The name of the slot to get the assigned extensions for. |
3874
+ | `slotName` | `string` | The name of the slot to get the assigned extensions for. |
4037
3875
 
4038
3876
  #### Returns
4039
3877
 
@@ -4041,7 +3879,7 @@ Considers if offline or online.
4041
3879
 
4042
3880
  #### Defined in
4043
3881
 
4044
- [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)
3882
+ [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)
4045
3883
 
4046
3884
  ___
4047
3885
 
@@ -4084,78 +3922,6 @@ all the information needed to render a loading state, error state, and normal/su
4084
3922
 
4085
3923
  ___
4086
3924
 
4087
- ### useExtension
4088
-
4089
- ▸ **useExtension**<`TRef`\>(`state?`): [`RefObject`<`TRef`\>, [`ExtensionData`](interfaces/ExtensionData.md) \| `undefined`]
4090
-
4091
- #### Type parameters
4092
-
4093
- | Name | Type |
4094
- | :------ | :------ |
4095
- | `TRef` | extends `HTMLElement` |
4096
-
4097
- #### Parameters
4098
-
4099
- | Name | Type |
4100
- | :------ | :------ |
4101
- | `state?` | `Record`<`string`, `any`\> |
4102
-
4103
- #### Returns
4104
-
4105
- [`RefObject`<`TRef`\>, [`ExtensionData`](interfaces/ExtensionData.md) \| `undefined`]
4106
-
4107
- #### Defined in
4108
-
4109
- [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)
4110
-
4111
- ___
4112
-
4113
- ### useExtensionSlot
4114
-
4115
- ▸ **useExtensionSlot**(`extensionSlotName`): `Object`
4116
-
4117
- #### Parameters
4118
-
4119
- | Name | Type |
4120
- | :------ | :------ |
4121
- | `extensionSlotName` | `string` |
4122
-
4123
- #### Returns
4124
-
4125
- `Object`
4126
-
4127
- | Name | Type |
4128
- | :------ | :------ |
4129
- | `extensionSlotModuleName` | `string` |
4130
- | `extensionSlotName` | `string` |
4131
- | `extensions` | [`ConnectedExtension`](interfaces/ConnectedExtension.md)[] |
4132
-
4133
- #### Defined in
4134
-
4135
- [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)
4136
-
4137
- ___
4138
-
4139
- ### useExtensionSlotConfig
4140
-
4141
- ▸ **useExtensionSlotConfig**(`extensionSlotName`): [`ExtensionSlotConfigObject`](interfaces/ExtensionSlotConfigObject.md)
4142
-
4143
- #### Parameters
4144
-
4145
- | Name | Type |
4146
- | :------ | :------ |
4147
- | `extensionSlotName` | `string` |
4148
-
4149
- #### Returns
4150
-
4151
- [`ExtensionSlotConfigObject`](interfaces/ExtensionSlotConfigObject.md)
4152
-
4153
- #### Defined in
4154
-
4155
- [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)
4156
-
4157
- ___
4158
-
4159
3925
  ### useExtensionSlotMeta
4160
3926
 
4161
3927
  ▸ **useExtensionSlotMeta**<`T`\>(`extensionSlotName`): `Object`
@@ -4188,16 +3954,22 @@ ___
4188
3954
 
4189
3955
  ▸ `Const` **useExtensionStore**(): `T`
4190
3956
 
3957
+ The implementation of this will soon undergo a breaking change.
3958
+ This will return an `ExtensionStore` rather than `ExtensionInternalStore`.
3959
+
4191
3960
  #### Returns
4192
3961
 
4193
3962
  `T`
4194
3963
 
4195
3964
  #### Defined in
4196
3965
 
4197
- [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)
3966
+ [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)
4198
3967
 
4199
3968
  ▸ `Const` **useExtensionStore**(`actions`): `T` & [`BoundActions`](API.md#boundactions)
4200
3969
 
3970
+ The implementation of this will soon undergo a breaking change.
3971
+ This will return an `ExtensionStore` rather than `ExtensionInternalStore`.
3972
+
4201
3973
  #### Parameters
4202
3974
 
4203
3975
  | Name | Type |
@@ -4210,10 +3982,13 @@ ___
4210
3982
 
4211
3983
  #### Defined in
4212
3984
 
4213
- [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)
3985
+ [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)
4214
3986
 
4215
3987
  ▸ `Const` **useExtensionStore**(`actions?`): `T` & [`BoundActions`](API.md#boundactions)
4216
3988
 
3989
+ The implementation of this will soon undergo a breaking change.
3990
+ This will return an `ExtensionStore` rather than `ExtensionInternalStore`.
3991
+
4217
3992
  #### Parameters
4218
3993
 
4219
3994
  | Name | Type |
@@ -4226,7 +4001,7 @@ ___
4226
4001
 
4227
4002
  #### Defined in
4228
4003
 
4229
- [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)
4004
+ [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)
4230
4005
 
4231
4006
  ___
4232
4007