@openmrs/esm-framework 3.2.1-pre.1068 → 3.2.1-pre.1082

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 (57) hide show
  1. package/dist/openmrs-esm-framework.js +1 -1
  2. package/dist/openmrs-esm-framework.js.LICENSE.txt +41 -1
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/API.md +1374 -2091
  5. package/docs/classes/OpenmrsFetchError.md +3 -3
  6. package/docs/enums/VisitMode.md +3 -3
  7. package/docs/enums/VisitStatus.md +2 -2
  8. package/docs/interfaces/AssignedExtension.md +9 -9
  9. package/docs/interfaces/BreadcrumbRegistration.md +4 -4
  10. package/docs/interfaces/BreadcrumbSettings.md +6 -6
  11. package/docs/interfaces/CancelLoading.md +1 -1
  12. package/docs/interfaces/ClearDynamicRoutesMessage.md +3 -3
  13. package/docs/interfaces/ConfigurableLinkProps.md +3 -3
  14. package/docs/interfaces/ConnectedExtension.md +6 -6
  15. package/docs/interfaces/CurrentPatientOptions.md +1 -1
  16. package/docs/interfaces/ExtensionRegistration.md +9 -15
  17. package/docs/interfaces/ExtensionSlotState.md +4 -4
  18. package/docs/interfaces/ExtensionStore.md +3 -3
  19. package/docs/interfaces/FHIRRequestObj.md +3 -3
  20. package/docs/interfaces/MessageServiceWorkerResult.md +5 -5
  21. package/docs/interfaces/NavigateOptions.md +3 -3
  22. package/docs/interfaces/NotificationDescriptor.md +74 -0
  23. package/docs/interfaces/OfflineModeResult.md +5 -5
  24. package/docs/interfaces/OfflinePatientArgs.md +4 -4
  25. package/docs/interfaces/OfflinePatientDataSyncHandler.md +4 -4
  26. package/docs/interfaces/OfflinePatientDataSyncState.md +8 -8
  27. package/docs/interfaces/OfflinePatientDataSyncStore.md +4 -4
  28. package/docs/interfaces/OmrsServiceWorkerMessage.md +3 -3
  29. package/docs/interfaces/OnImportMapChangedMessage.md +4 -4
  30. package/docs/interfaces/OnlyThePatient.md +1 -1
  31. package/docs/interfaces/PatientWithFullResponse.md +1 -1
  32. package/docs/interfaces/QueueItemDescriptor.md +6 -6
  33. package/docs/interfaces/RegisterDynamicRouteMessage.md +6 -6
  34. package/docs/interfaces/RetryOptions.md +3 -3
  35. package/docs/interfaces/ShowNotificationEvent.md +5 -5
  36. package/docs/interfaces/ShowToastEvent.md +4 -4
  37. package/docs/interfaces/SyncItem.md +9 -9
  38. package/docs/interfaces/SyncProcessOptions.md +8 -8
  39. package/docs/interfaces/ToastDescriptor.md +69 -0
  40. package/docs/interfaces/ToastNotificationMeta.md +100 -0
  41. package/docs/interfaces/UserHasAccessProps.md +3 -3
  42. package/docs/interfaces/VisitItem.md +4 -4
  43. package/package.json +13 -13
  44. package/src/index.ts +8 -8
  45. package/src/internal.ts +11 -0
  46. package/docs/interfaces/ComponentConfig.md +0 -30
  47. package/docs/interfaces/ComponentDecoratorOptions.md +0 -52
  48. package/docs/interfaces/ExtensionInfo.md +0 -139
  49. package/docs/interfaces/ExtensionInstance.md +0 -41
  50. package/docs/interfaces/ExtensionInternalStore.md +0 -34
  51. package/docs/interfaces/ExtensionSlotInfo.md +0 -64
  52. package/docs/interfaces/NavigationContext.md +0 -50
  53. package/docs/interfaces/NetworkRequestFailedEvent.md +0 -49
  54. package/docs/interfaces/OfflineSynchronizationStore.md +0 -30
  55. package/docs/interfaces/OmrsServiceWorkerEvent.md +0 -31
  56. package/docs/interfaces/OpenmrsReactComponentProps.md +0 -19
  57. package/docs/interfaces/OpenmrsReactComponentState.md +0 -41
package/docs/interfaces/NavigationContext.md DELETED
@@ -1,50 +0,0 @@
1
- [@openmrs/esm-framework](../API.md) / NavigationContext
2
-
3
- # Interface: NavigationContext
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [type](NavigationContext.md#type)
10
-
11
- ### Methods
12
-
13
- - [handler](NavigationContext.md#handler)
14
-
15
- ## Properties
16
-
17
- ### type
18
-
19
- • **type**: [`NavigationContextType`](../API.md#navigationcontexttype)
20
-
21
- #### Defined in
22
-
23
- [packages/framework/esm-extensions/src/contexts.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L6)
24
-
25
- ## Methods
26
-
27
- ### handler
28
-
29
- ▸ **handler**<`T`\>(`link`, `state`): `boolean`
30
-
31
- #### Type parameters
32
-
33
- | Name | Type |
34
- | :------ | :------ |
35
- | `T` | `any` |
36
-
37
- #### Parameters
38
-
39
- | Name | Type |
40
- | :------ | :------ |
41
- | `link` | `string` |
42
- | `state` | `T` |
43
-
44
- #### Returns
45
-
46
- `boolean`
47
-
48
- #### Defined in
49
-
50
- [packages/framework/esm-extensions/src/contexts.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L7)
package/docs/interfaces/NetworkRequestFailedEvent.md DELETED
@@ -1,49 +0,0 @@
1
- [@openmrs/esm-framework](../API.md) / NetworkRequestFailedEvent
2
-
3
- # Interface: NetworkRequestFailedEvent
4
-
5
- ## Hierarchy
6
-
7
- - [`OmrsServiceWorkerEvent`](OmrsServiceWorkerEvent.md)<``"networkRequestFailed"``\>
8
-
9
- ↳ **`NetworkRequestFailedEvent`**
10
-
11
- ## Table of contents
12
-
13
- ### Properties
14
-
15
- - [request](NetworkRequestFailedEvent.md#request)
16
- - [type](NetworkRequestFailedEvent.md#type)
17
-
18
- ## Properties
19
-
20
- ### request
21
-
22
- • **request**: `Object`
23
-
24
- #### Type declaration
25
-
26
- | Name | Type |
27
- | :------ | :------ |
28
- | `body` | `string` |
29
- | `headers` | `Record`<`string`, `string`\> |
30
- | `method` | `string` |
31
- | `url` | `string` |
32
-
33
- #### Defined in
34
-
35
- [packages/framework/esm-offline/src/service-worker-events.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-events.ts#L7)
36
-
37
- ___
38
-
39
- ### type
40
-
41
- • **type**: ``"networkRequestFailed"``
42
-
43
- #### Inherited from
44
-
45
- [OmrsServiceWorkerEvent](OmrsServiceWorkerEvent.md).[type](OmrsServiceWorkerEvent.md#type)
46
-
47
- #### Defined in
48
-
49
- [packages/framework/esm-offline/src/service-worker-events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-events.ts#L2)
package/docs/interfaces/OfflineSynchronizationStore.md DELETED
@@ -1,30 +0,0 @@
1
- [@openmrs/esm-framework](../API.md) / OfflineSynchronizationStore
2
-
3
- # Interface: OfflineSynchronizationStore
4
-
5
- Represents the data inside the global offline synchronization store.
6
- Provides information about a currently ongoing synchronization.
7
-
8
- ## Table of contents
9
-
10
- ### Properties
11
-
12
- - [synchronization](OfflineSynchronizationStore.md#synchronization)
13
-
14
- ## Properties
15
-
16
- ### synchronization
17
-
18
- • `Optional` **synchronization**: `Object`
19
-
20
- #### Type declaration
21
-
22
- | Name | Type |
23
- | :------ | :------ |
24
- | `abortController` | `AbortController` |
25
- | `pendingCount` | `number` |
26
- | `totalCount` | `number` |
27
-
28
- #### Defined in
29
-
30
- [packages/framework/esm-offline/src/sync.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L93)
package/docs/interfaces/OmrsServiceWorkerEvent.md DELETED
@@ -1,31 +0,0 @@
1
- [@openmrs/esm-framework](../API.md) / OmrsServiceWorkerEvent
2
-
3
- # Interface: OmrsServiceWorkerEvent<TypeIdentifier\>
4
-
5
- ## Type parameters
6
-
7
- | Name | Type |
8
- | :------ | :------ |
9
- | `TypeIdentifier` | extends `string` |
10
-
11
- ## Hierarchy
12
-
13
- - **`OmrsServiceWorkerEvent`**
14
-
15
- ↳ [`NetworkRequestFailedEvent`](NetworkRequestFailedEvent.md)
16
-
17
- ## Table of contents
18
-
19
- ### Properties
20
-
21
- - [type](OmrsServiceWorkerEvent.md#type)
22
-
23
- ## Properties
24
-
25
- ### type
26
-
27
- • **type**: `TypeIdentifier`
28
-
29
- #### Defined in
30
-
31
- [packages/framework/esm-offline/src/service-worker-events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-events.ts#L2)
package/docs/interfaces/OpenmrsReactComponentProps.md DELETED
@@ -1,19 +0,0 @@
1
- [@openmrs/esm-framework](../API.md) / OpenmrsReactComponentProps
2
-
3
- # Interface: OpenmrsReactComponentProps
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [\_extensionContext](OpenmrsReactComponentProps.md#_extensioncontext)
10
-
11
- ## Properties
12
-
13
- ### \_extensionContext
14
-
15
- • `Optional` **\_extensionContext**: [`ExtensionData`](ExtensionData.md)
16
-
17
- #### Defined in
18
-
19
- [packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:62](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L62)
package/docs/interfaces/OpenmrsReactComponentState.md DELETED
@@ -1,41 +0,0 @@
1
- [@openmrs/esm-framework](../API.md) / OpenmrsReactComponentState
2
-
3
- # Interface: OpenmrsReactComponentState
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [caughtError](OpenmrsReactComponentState.md#caughterror)
10
- - [caughtErrorInfo](OpenmrsReactComponentState.md#caughterrorinfo)
11
- - [config](OpenmrsReactComponentState.md#config)
12
-
13
- ## Properties
14
-
15
- ### caughtError
16
-
17
- • **caughtError**: `any`
18
-
19
- #### Defined in
20
-
21
- [packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:66](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L66)
22
-
23
- ___
24
-
25
- ### caughtErrorInfo
26
-
27
- • **caughtErrorInfo**: `any`
28
-
29
- #### Defined in
30
-
31
- [packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:67](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L67)
32
-
33
- ___
34
-
35
- ### config
36
-
37
- • **config**: [`ComponentConfig`](ComponentConfig.md)
38
-
39
- #### Defined in
40
-
41
- [packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:68](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L68)