@openmrs/esm-framework 3.4.1-pre.98 → 4.0.1-pre.204

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 (88) hide show
  1. package/.turbo/turbo-build.log +16 -138
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.LICENSE.txt +9 -21
  4. package/dist/openmrs-esm-framework.js.map +1 -1
  5. package/docs/API.md +588 -756
  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 +12 -1
  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 +63 -0
  25. package/docs/interfaces/DynamicOfflineDataHandler.md +88 -0
  26. package/docs/interfaces/DynamicOfflineDataSyncState.md +63 -0
  27. package/docs/interfaces/ErrorStateProps.md +30 -0
  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 +13 -2
  38. package/docs/interfaces/FHIRRequestObj.md +3 -3
  39. package/docs/interfaces/FHIRRequestOptions.md +41 -0
  40. package/docs/interfaces/FHIRResource.md +4 -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 +12 -1
  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 -6
  54. package/docs/interfaces/OfflinePatientDataSyncHandler.md +5 -14
  55. package/docs/interfaces/OfflinePatientDataSyncState.md +6 -24
  56. package/docs/interfaces/OfflinePatientDataSyncStore.md +2 -9
  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 +24 -2
  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 +8 -0
  85. package/mock.tsx +4 -7
  86. package/package.json +13 -13
  87. package/src/integration-tests/extension-config.test.tsx +218 -21
  88. package/typedoc.json +1 -1
package/docs/interfaces/ConfigSchema.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  #### Defined in
24
24
 
25
- [packages/framework/esm-config/src/types.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L21)
25
+ [packages/framework/esm-config/src/types.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L21)
26
26
 
27
27
  ___
28
28
 
@@ -32,7 +32,7 @@ ___
32
32
 
33
33
  #### Defined in
34
34
 
35
- [packages/framework/esm-config/src/types.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L19)
35
+ [packages/framework/esm-config/src/types.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L19)
36
36
 
37
37
  ___
38
38
 
@@ -42,4 +42,4 @@ ___
42
42
 
43
43
  #### Defined in
44
44
 
45
- [packages/framework/esm-config/src/types.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L20)
45
+ [packages/framework/esm-config/src/types.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L20)
package/docs/interfaces/ConfigurableLinkProps.md CHANGED
@@ -12,14 +12,25 @@
12
12
 
13
13
  ### Navigation Properties
14
14
 
15
+ - [templateParams](ConfigurableLinkProps.md#templateparams)
15
16
  - [to](ConfigurableLinkProps.md#to)
16
17
 
17
18
  ## Navigation Properties
18
19
 
20
+ ### templateParams
21
+
22
+ • `Optional` **templateParams**: [`TemplateParams`](../API.md#templateparams)
23
+
24
+ #### Defined in
25
+
26
+ [packages/framework/esm-react-utils/src/ConfigurableLink.tsx:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L27)
27
+
28
+ ___
29
+
19
30
  ### to
20
31
 
21
32
  • **to**: `string`
22
33
 
23
34
  #### Defined in
24
35
 
25
- [packages/framework/esm-react-utils/src/ConfigurableLink.tsx:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L22)
36
+ [packages/framework/esm-react-utils/src/ConfigurableLink.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L26)
package/docs/interfaces/ConnectedExtension.md CHANGED
@@ -17,11 +17,9 @@
17
17
 
18
18
  • **config**: ``null`` \| [`ConfigObject`](ConfigObject.md)
19
19
 
20
- The extension's config. Note that this will be `null` until the slot is mounted.
21
-
22
20
  #### Defined in
23
21
 
24
- [packages/framework/esm-extensions/src/store.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L89)
22
+ [packages/framework/esm-extensions/src/store.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L90)
25
23
 
26
24
  ___
27
25
 
@@ -31,7 +29,7 @@ ___
31
29
 
32
30
  #### Defined in
33
31
 
34
- [packages/framework/esm-extensions/src/store.ts:85](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L85)
32
+ [packages/framework/esm-extensions/src/store.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L86)
35
33
 
36
34
  ___
37
35
 
@@ -41,7 +39,7 @@ ___
41
39
 
42
40
  #### Defined in
43
41
 
44
- [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)
42
+ [packages/framework/esm-extensions/src/store.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L88)
45
43
 
46
44
  ___
47
45
 
@@ -51,4 +49,4 @@ ___
51
49
 
52
50
  #### Defined in
53
51
 
54
- [packages/framework/esm-extensions/src/store.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L86)
52
+ [packages/framework/esm-extensions/src/store.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L87)
package/docs/interfaces/ConnectivityChangedEvent.md CHANGED
@@ -16,4 +16,4 @@
16
16
 
17
17
  #### Defined in
18
18
 
19
- [packages/framework/esm-globals/src/events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L2)
19
+ [packages/framework/esm-globals/src/events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L2)
package/docs/interfaces/CurrentPatientOptions.md CHANGED
@@ -24,4 +24,4 @@
24
24
 
25
25
  #### Defined in
26
26
 
27
- [packages/framework/esm-api/src/shared-api-objects/current-patient.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L8)
27
+ [packages/framework/esm-api/src/shared-api-objects/current-patient.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L8)
package/docs/interfaces/DisplayConditionsConfigObject.md ADDED
@@ -0,0 +1,19 @@
1
+ [@openmrs/esm-framework](../API.md) / DisplayConditionsConfigObject
2
+
3
+ # Interface: DisplayConditionsConfigObject
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [privileges](DisplayConditionsConfigObject.md#privileges)
10
+
11
+ ## Properties
12
+
13
+ ### privileges
14
+
15
+ • `Optional` **privileges**: `string`[]
16
+
17
+ #### Defined in
18
+
19
+ [packages/framework/esm-config/src/types.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L34)
package/docs/interfaces/DynamicOfflineData.md ADDED
@@ -0,0 +1,63 @@
1
+ [@openmrs/esm-framework](../API.md) / DynamicOfflineData
2
+
3
+ # Interface: DynamicOfflineData
4
+
5
+ ## Table of contents
6
+
7
+ ### Offline Properties
8
+
9
+ - [id](DynamicOfflineData.md#id)
10
+ - [identifier](DynamicOfflineData.md#identifier)
11
+ - [syncState](DynamicOfflineData.md#syncstate)
12
+ - [type](DynamicOfflineData.md#type)
13
+ - [users](DynamicOfflineData.md#users)
14
+
15
+ ## Offline Properties
16
+
17
+ ### id
18
+
19
+ • `Optional` **id**: `number`
20
+
21
+ #### Defined in
22
+
23
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L48)
24
+
25
+ ___
26
+
27
+ ### identifier
28
+
29
+ • **identifier**: `string`
30
+
31
+ #### Defined in
32
+
33
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L58)
34
+
35
+ ___
36
+
37
+ ### syncState
38
+
39
+ • `Optional` **syncState**: [`DynamicOfflineDataSyncState`](DynamicOfflineDataSyncState.md)
40
+
41
+ #### Defined in
42
+
43
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L67)
44
+
45
+ ___
46
+
47
+ ### type
48
+
49
+ • **type**: `string`
50
+
51
+ #### Defined in
52
+
53
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L53)
54
+
55
+ ___
56
+
57
+ ### users
58
+
59
+ • **users**: `string`[]
60
+
61
+ #### Defined in
62
+
63
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L62)
package/docs/interfaces/DynamicOfflineDataHandler.md ADDED
@@ -0,0 +1,88 @@
1
+ [@openmrs/esm-framework](../API.md) / DynamicOfflineDataHandler
2
+
3
+ # Interface: DynamicOfflineDataHandler
4
+
5
+ ## Table of contents
6
+
7
+ ### Offline Properties
8
+
9
+ - [displayName](DynamicOfflineDataHandler.md#displayname)
10
+ - [id](DynamicOfflineDataHandler.md#id)
11
+ - [type](DynamicOfflineDataHandler.md#type)
12
+
13
+ ### Methods
14
+
15
+ - [isSynced](DynamicOfflineDataHandler.md#issynced)
16
+ - [sync](DynamicOfflineDataHandler.md#sync)
17
+
18
+ ## Offline Properties
19
+
20
+ ### displayName
21
+
22
+ • `Optional` **displayName**: `string`
23
+
24
+ #### Defined in
25
+
26
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L24)
27
+
28
+ ___
29
+
30
+ ### id
31
+
32
+ • **id**: `string`
33
+
34
+ #### Defined in
35
+
36
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L14)
37
+
38
+ ___
39
+
40
+ ### type
41
+
42
+ • **type**: `string`
43
+
44
+ #### Defined in
45
+
46
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L19)
47
+
48
+ ## Methods
49
+
50
+ ### isSynced
51
+
52
+ ▸ **isSynced**(`identifier`, `abortSignal?`): `Promise`<`boolean`\>
53
+
54
+ #### Parameters
55
+
56
+ | Name | Type | Description |
57
+ | :------ | :------ | :------ |
58
+ | `identifier` | `string` | |
59
+ | `abortSignal?` | `AbortSignal` | |
60
+
61
+ #### Returns
62
+
63
+ `Promise`<`boolean`\>
64
+
65
+ #### Defined in
66
+
67
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L32)
68
+
69
+ ___
70
+
71
+ ### sync
72
+
73
+ ▸ **sync**(`identifier`, `abortSignal?`): `Promise`<`void`\>
74
+
75
+ #### Parameters
76
+
77
+ | Name | Type | Description |
78
+ | :------ | :------ | :------ |
79
+ | `identifier` | `string` | |
80
+ | `abortSignal?` | `AbortSignal` | |
81
+
82
+ #### Returns
83
+
84
+ `Promise`<`void`\>
85
+
86
+ #### Defined in
87
+
88
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L38)
package/docs/interfaces/DynamicOfflineDataSyncState.md ADDED
@@ -0,0 +1,63 @@
1
+ [@openmrs/esm-framework](../API.md) / DynamicOfflineDataSyncState
2
+
3
+ # Interface: DynamicOfflineDataSyncState
4
+
5
+ ## Table of contents
6
+
7
+ ### Offline Properties
8
+
9
+ - [erroredHandlers](DynamicOfflineDataSyncState.md#erroredhandlers)
10
+ - [errors](DynamicOfflineDataSyncState.md#errors)
11
+ - [succeededHandlers](DynamicOfflineDataSyncState.md#succeededhandlers)
12
+ - [syncedBy](DynamicOfflineDataSyncState.md#syncedby)
13
+ - [syncedOn](DynamicOfflineDataSyncState.md#syncedon)
14
+
15
+ ## Offline Properties
16
+
17
+ ### erroredHandlers
18
+
19
+ • **erroredHandlers**: `string`[]
20
+
21
+ #### Defined in
22
+
23
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L89)
24
+
25
+ ___
26
+
27
+ ### errors
28
+
29
+ • **errors**: { `handlerId`: `string` ; `message`: `string` }[]
30
+
31
+ #### Defined in
32
+
33
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L93)
34
+
35
+ ___
36
+
37
+ ### succeededHandlers
38
+
39
+ • **succeededHandlers**: `string`[]
40
+
41
+ #### Defined in
42
+
43
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:85](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L85)
44
+
45
+ ___
46
+
47
+ ### syncedBy
48
+
49
+ • **syncedBy**: `string`
50
+
51
+ #### Defined in
52
+
53
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L81)
54
+
55
+ ___
56
+
57
+ ### syncedOn
58
+
59
+ • **syncedOn**: `Date`
60
+
61
+ #### Defined in
62
+
63
+ [packages/framework/esm-offline/src/dynamic-offline-data.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L77)
package/docs/interfaces/ErrorStateProps.md ADDED
@@ -0,0 +1,30 @@
1
+ [@openmrs/esm-framework](../API.md) / ErrorStateProps
2
+
3
+ # Interface: ErrorStateProps
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [error](ErrorStateProps.md#error)
10
+ - [headerTitle](ErrorStateProps.md#headertitle)
11
+
12
+ ## Properties
13
+
14
+ ### error
15
+
16
+ • **error**: `any`
17
+
18
+ #### Defined in
19
+
20
+ [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L8)
21
+
22
+ ___
23
+
24
+ ### headerTitle
25
+
26
+ • **headerTitle**: `string`
27
+
28
+ #### Defined in
29
+
30
+ [packages/framework/esm-styleguide/src/error-state/error-state.component.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/error-state/error-state.component.tsx#L9)
package/docs/interfaces/ExtensionData.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- [packages/framework/esm-react-utils/src/ComponentContext.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L6)
21
+ [packages/framework/esm-react-utils/src/ComponentContext.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ComponentContext.ts#L6)
22
22
 
23
23
  ___
24
24
 
@@ -28,7 +28,7 @@ ___
28
28
 
29
29
  #### Defined in
30
30
 
31
- [packages/framework/esm-react-utils/src/ComponentContext.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L5)
31
+ [packages/framework/esm-react-utils/src/ComponentContext.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ComponentContext.ts#L5)
32
32
 
33
33
  ___
34
34
 
@@ -38,4 +38,4 @@ ___
38
38
 
39
39
  #### Defined in
40
40
 
41
- [packages/framework/esm-react-utils/src/ComponentContext.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L4)
41
+ [packages/framework/esm-react-utils/src/ComponentContext.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ComponentContext.ts#L4)
package/docs/interfaces/ExtensionDefinition.md CHANGED
@@ -34,15 +34,13 @@
34
34
 
35
35
  • **appName**: `string`
36
36
 
37
- The module/app that defines the component
38
-
39
37
  #### Inherited from
40
38
 
41
39
  [ComponentDefinition](ComponentDefinition.md).[appName](ComponentDefinition.md#appname)
42
40
 
43
41
  #### Defined in
44
42
 
45
- [packages/framework/esm-globals/src/types.ts:99](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L99)
43
+ [packages/framework/esm-globals/src/types.ts:99](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L99)
46
44
 
47
45
  ___
48
46
 
@@ -50,11 +48,9 @@ ___
50
48
 
51
49
  • `Optional` **id**: `string`
52
50
 
53
- **`deprecated`** A confusing way to specify the name of the extension
54
-
55
51
  #### Defined in
56
52
 
57
- [packages/framework/esm-globals/src/types.ts:134](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L134)
53
+ [packages/framework/esm-globals/src/types.ts:135](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L135)
58
54
 
59
55
  ___
60
56
 
@@ -62,11 +58,9 @@ ___
62
58
 
63
59
  • `Optional` **meta**: `Record`<`string`, `any`\>
64
60
 
65
- The meta data used for reflection by other components
66
-
67
61
  #### Defined in
68
62
 
69
- [packages/framework/esm-globals/src/types.ts:130](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L130)
63
+ [packages/framework/esm-globals/src/types.ts:131](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L131)
70
64
 
71
65
  ___
72
66
 
@@ -74,11 +68,9 @@ ___
74
68
 
75
69
  • **name**: `string`
76
70
 
77
- The name of the extension being registered
78
-
79
71
  #### Defined in
80
72
 
81
- [packages/framework/esm-globals/src/types.ts:124](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L124)
73
+ [packages/framework/esm-globals/src/types.ts:125](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L125)
82
74
 
83
75
  ___
84
76
 
@@ -86,15 +78,13 @@ ___
86
78
 
87
79
  • `Optional` **offline**: `boolean` \| `object`
88
80
 
89
- Defines the offline support / properties of the component.
90
-
91
81
  #### Inherited from
92
82
 
93
83
  [ComponentDefinition](ComponentDefinition.md).[offline](ComponentDefinition.md#offline)
94
84
 
95
85
  #### Defined in
96
86
 
97
- [packages/framework/esm-globals/src/types.ts:111](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L111)
87
+ [packages/framework/esm-globals/src/types.ts:111](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L111)
98
88
 
99
89
  ___
100
90
 
@@ -102,15 +92,13 @@ ___
102
92
 
103
93
  • `Optional` **online**: `boolean` \| `object`
104
94
 
105
- Defines the online support / properties of the component.
106
-
107
95
  #### Inherited from
108
96
 
109
97
  [ComponentDefinition](ComponentDefinition.md).[online](ComponentDefinition.md#online)
110
98
 
111
99
  #### Defined in
112
100
 
113
- [packages/framework/esm-globals/src/types.ts:107](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L107)
101
+ [packages/framework/esm-globals/src/types.ts:107](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L107)
114
102
 
115
103
  ___
116
104
 
@@ -118,19 +106,15 @@ ___
118
106
 
119
107
  • `Optional` **order**: `number`
120
108
 
121
- Specifies the relative order in which the extension renders in a slot
122
-
123
109
  #### Defined in
124
110
 
125
- [packages/framework/esm-globals/src/types.ts:132](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L132)
111
+ [packages/framework/esm-globals/src/types.ts:133](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L133)
126
112
 
127
113
  ___
128
114
 
129
115
  ### privilege
130
116
 
131
- • `Optional` **privilege**: `string`
132
-
133
- Defines the access privilege required for this component, if any.
117
+ • `Optional` **privilege**: `string` \| `string`[]
134
118
 
135
119
  #### Inherited from
136
120
 
@@ -138,7 +122,7 @@ Defines the access privilege required for this component, if any.
138
122
 
139
123
  #### Defined in
140
124
 
141
- [packages/framework/esm-globals/src/types.ts:115](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L115)
125
+ [packages/framework/esm-globals/src/types.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L116)
142
126
 
143
127
  ___
144
128
 
@@ -146,15 +130,13 @@ ___
146
130
 
147
131
  • `Optional` **resources**: `Record`<`string`, [`ResourceLoader`](ResourceLoader.md)<`any`\>\>
148
132
 
149
- Defines resources that are loaded when the component should mount.
150
-
151
133
  #### Inherited from
152
134
 
153
135
  [ComponentDefinition](ComponentDefinition.md).[resources](ComponentDefinition.md#resources)
154
136
 
155
137
  #### Defined in
156
138
 
157
- [packages/framework/esm-globals/src/types.ts:119](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L119)
139
+ [packages/framework/esm-globals/src/types.ts:120](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L120)
158
140
 
159
141
  ___
160
142
 
@@ -162,11 +144,9 @@ ___
162
144
 
163
145
  • `Optional` **slot**: `string`
164
146
 
165
- A slot to attach to
166
-
167
147
  #### Defined in
168
148
 
169
- [packages/framework/esm-globals/src/types.ts:126](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L126)
149
+ [packages/framework/esm-globals/src/types.ts:127](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L127)
170
150
 
171
151
  ___
172
152
 
@@ -174,11 +154,9 @@ ___
174
154
 
175
155
  • `Optional` **slots**: `string`[]
176
156
 
177
- Slots to attach to
178
-
179
157
  #### Defined in
180
158
 
181
- [packages/framework/esm-globals/src/types.ts:128](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L128)
159
+ [packages/framework/esm-globals/src/types.ts:129](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L129)
182
160
 
183
161
  ## Methods
184
162
 
@@ -186,8 +164,6 @@ Slots to attach to
186
164
 
187
165
  ▸ **load**(): `Promise`<`any`\>
188
166
 
189
- Defines a function to use for actually loading the component's lifecycle.
190
-
191
167
  #### Returns
192
168
 
193
169
  `Promise`<`any`\>
@@ -198,4 +174,4 @@ Defines a function to use for actually loading the component's lifecycle.
198
174
 
199
175
  #### Defined in
200
176
 
201
- [packages/framework/esm-globals/src/types.ts:103](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L103)
177
+ [packages/framework/esm-globals/src/types.ts:103](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/types.ts#L103)
package/docs/interfaces/ExtensionProps.md CHANGED
@@ -20,7 +20,7 @@
20
20
 
21
21
  #### Defined in
22
22
 
23
- [packages/framework/esm-react-utils/src/Extension.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L7)
23
+ [packages/framework/esm-react-utils/src/Extension.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/Extension.tsx#L14)
24
24
 
25
25
  ## Methods
26
26
 
@@ -41,4 +41,4 @@
41
41
 
42
42
  #### Defined in
43
43
 
44
- [packages/framework/esm-react-utils/src/Extension.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L8)
44
+ [packages/framework/esm-react-utils/src/Extension.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/Extension.tsx#L16)
package/docs/interfaces/ExtensionRegistration.md CHANGED
@@ -12,6 +12,7 @@
12
12
  - [offline](ExtensionRegistration.md#offline)
13
13
  - [online](ExtensionRegistration.md#online)
14
14
  - [order](ExtensionRegistration.md#order)
15
+ - [privileges](ExtensionRegistration.md#privileges)
15
16
 
16
17
  ### Methods
17
18
 
@@ -25,7 +26,7 @@
25
26
 
26
27
  #### Defined in
27
28
 
28
- [packages/framework/esm-extensions/src/store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L19)
29
+ [packages/framework/esm-extensions/src/store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L19)
29
30
 
30
31
  ___
31
32
 
@@ -35,7 +36,7 @@ ___
35
36
 
36
37
  #### Defined in
37
38
 
38
- [packages/framework/esm-extensions/src/store.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L18)
39
+ [packages/framework/esm-extensions/src/store.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L18)
39
40
 
40
41
  ___
41
42
 
@@ -45,7 +46,7 @@ ___
45
46
 
46
47
  #### Defined in
47
48
 
48
- [packages/framework/esm-extensions/src/store.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L16)
49
+ [packages/framework/esm-extensions/src/store.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L16)
49
50
 
50
51
  ___
51
52
 
@@ -55,7 +56,7 @@ ___
55
56
 
56
57
  #### Defined in
57
58
 
58
- [packages/framework/esm-extensions/src/store.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L22)
59
+ [packages/framework/esm-extensions/src/store.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L22)
59
60
 
60
61
  ___
61
62
 
@@ -65,7 +66,7 @@ ___
65
66
 
66
67
  #### Defined in
67
68
 
68
- [packages/framework/esm-extensions/src/store.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L21)
69
+ [packages/framework/esm-extensions/src/store.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L21)
69
70
 
70
71
  ___
71
72
 
@@ -75,7 +76,17 @@ ___
75
76
 
76
77
  #### Defined in
77
78
 
78
- [packages/framework/esm-extensions/src/store.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L20)
79
+ [packages/framework/esm-extensions/src/store.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L20)
80
+
81
+ ___
82
+
83
+ ### privileges
84
+
85
+ • `Optional` **privileges**: `string` \| `string`[]
86
+
87
+ #### Defined in
88
+
89
+ [packages/framework/esm-extensions/src/store.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L23)
79
90
 
80
91
  ## Methods
81
92
 
@@ -89,4 +100,4 @@ ___
89
100
 
90
101
  #### Defined in
91
102
 
92
- [packages/framework/esm-extensions/src/store.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L17)
103
+ [packages/framework/esm-extensions/src/store.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L17)