@openmrs/esm-framework 3.2.1-pre.1090 → 3.2.1-pre.1101

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/ToastDescriptor.md ADDED
@@ -0,0 +1,69 @@
1
+ [@openmrs/esm-framework](../API.md) / ToastDescriptor
2
+
3
+ # Interface: ToastDescriptor
4
+
5
+ ## Hierarchy
6
+
7
+ - **`ToastDescriptor`**
8
+
9
+ ↳ [`ToastNotificationMeta`](ToastNotificationMeta.md)
10
+
11
+ ## Table of contents
12
+
13
+ ### UI Properties
14
+
15
+ - [critical](ToastDescriptor.md#critical)
16
+ - [description](ToastDescriptor.md#description)
17
+ - [kind](ToastDescriptor.md#kind)
18
+ - [millis](ToastDescriptor.md#millis)
19
+ - [title](ToastDescriptor.md#title)
20
+
21
+ ## UI Properties
22
+
23
+ ### critical
24
+
25
+ • `Optional` **critical**: `boolean`
26
+
27
+ #### Defined in
28
+
29
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L17)
30
+
31
+ ___
32
+
33
+ ### description
34
+
35
+ • **description**: `ReactNode`
36
+
37
+ #### Defined in
38
+
39
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L15)
40
+
41
+ ___
42
+
43
+ ### kind
44
+
45
+ • `Optional` **kind**: [`ToastType`](../API.md#toasttype)
46
+
47
+ #### Defined in
48
+
49
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L16)
50
+
51
+ ___
52
+
53
+ ### millis
54
+
55
+ • `Optional` **millis**: `number`
56
+
57
+ #### Defined in
58
+
59
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L19)
60
+
61
+ ___
62
+
63
+ ### title
64
+
65
+ • `Optional` **title**: `string`
66
+
67
+ #### Defined in
68
+
69
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L18)
package/docs/interfaces/ToastNotificationMeta.md ADDED
@@ -0,0 +1,100 @@
1
+ [@openmrs/esm-framework](../API.md) / ToastNotificationMeta
2
+
3
+ # Interface: ToastNotificationMeta
4
+
5
+ ## Hierarchy
6
+
7
+ - [`ToastDescriptor`](ToastDescriptor.md)
8
+
9
+ ↳ **`ToastNotificationMeta`**
10
+
11
+ ## Table of contents
12
+
13
+ ### UI Properties
14
+
15
+ - [critical](ToastNotificationMeta.md#critical)
16
+ - [description](ToastNotificationMeta.md#description)
17
+ - [id](ToastNotificationMeta.md#id)
18
+ - [kind](ToastNotificationMeta.md#kind)
19
+ - [millis](ToastNotificationMeta.md#millis)
20
+ - [title](ToastNotificationMeta.md#title)
21
+
22
+ ## UI Properties
23
+
24
+ ### critical
25
+
26
+ • `Optional` **critical**: `boolean`
27
+
28
+ #### Inherited from
29
+
30
+ [ToastDescriptor](ToastDescriptor.md).[critical](ToastDescriptor.md#critical)
31
+
32
+ #### Defined in
33
+
34
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L17)
35
+
36
+ ___
37
+
38
+ ### description
39
+
40
+ • **description**: `ReactNode`
41
+
42
+ #### Inherited from
43
+
44
+ [ToastDescriptor](ToastDescriptor.md).[description](ToastDescriptor.md#description)
45
+
46
+ #### Defined in
47
+
48
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L15)
49
+
50
+ ___
51
+
52
+ ### id
53
+
54
+ • **id**: `number`
55
+
56
+ #### Defined in
57
+
58
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L23)
59
+
60
+ ___
61
+
62
+ ### kind
63
+
64
+ • `Optional` **kind**: [`ToastType`](../API.md#toasttype)
65
+
66
+ #### Inherited from
67
+
68
+ [ToastDescriptor](ToastDescriptor.md).[kind](ToastDescriptor.md#kind)
69
+
70
+ #### Defined in
71
+
72
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L16)
73
+
74
+ ___
75
+
76
+ ### millis
77
+
78
+ • `Optional` **millis**: `number`
79
+
80
+ #### Inherited from
81
+
82
+ [ToastDescriptor](ToastDescriptor.md).[millis](ToastDescriptor.md#millis)
83
+
84
+ #### Defined in
85
+
86
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L19)
87
+
88
+ ___
89
+
90
+ ### title
91
+
92
+ • `Optional` **title**: `string`
93
+
94
+ #### Inherited from
95
+
96
+ [ToastDescriptor](ToastDescriptor.md).[title](ToastDescriptor.md#title)
97
+
98
+ #### Defined in
99
+
100
+ [packages/framework/esm-styleguide/src/toasts/toast.component.tsx:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/toast.component.tsx#L18)
package/docs/interfaces/UserHasAccessProps.md CHANGED
@@ -4,11 +4,11 @@
4
4
 
5
5
  ## Table of contents
6
6
 
7
- ### Properties
7
+ ### API Properties
8
8
 
9
9
  - [privilege](UserHasAccessProps.md#privilege)
10
10
 
11
- ## Properties
11
+ ## API Properties
12
12
 
13
13
  ### privilege
14
14
 
@@ -16,4 +16,4 @@
16
16
 
17
17
  #### Defined in
18
18
 
19
- [packages/framework/esm-react-utils/src/UserHasAccess.tsx:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L5)
19
+ [packages/framework/esm-react-utils/src/UserHasAccess.tsx:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L6)
package/docs/interfaces/VisitItem.md CHANGED
@@ -19,7 +19,7 @@
19
19
 
20
20
  #### Defined in
21
21
 
22
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:84](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L84)
22
+ [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L80)
23
23
 
24
24
  ___
25
25
 
@@ -29,7 +29,7 @@ ___
29
29
 
30
30
  #### Defined in
31
31
 
32
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L81)
32
+ [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L77)
33
33
 
34
34
  ___
35
35
 
@@ -39,7 +39,7 @@ ___
39
39
 
40
40
  #### Defined in
41
41
 
42
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L83)
42
+ [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L79)
43
43
 
44
44
  ___
45
45
 
@@ -49,4 +49,4 @@ ___
49
49
 
50
50
  #### Defined in
51
51
 
52
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:82](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L82)
52
+ [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:78](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L78)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "3.2.1-pre.1090",
3
+ "version": "3.2.1-pre.1101",
4
4
  "license": "MPL-2.0",
5
5
  "browser": "dist/openmrs-esm-framework.js",
6
6
  "main": "src/index.ts",
@@ -35,18 +35,18 @@
35
35
  "access": "public"
36
36
  },
37
37
  "dependencies": {
38
- "@openmrs/esm-api": "^3.2.1-pre.1090",
39
- "@openmrs/esm-breadcrumbs": "^3.2.1-pre.1090",
40
- "@openmrs/esm-config": "^3.2.1-pre.1090",
41
- "@openmrs/esm-error-handling": "^3.2.1-pre.1090",
42
- "@openmrs/esm-extensions": "^3.2.1-pre.1090",
43
- "@openmrs/esm-globals": "^3.2.1-pre.1090",
44
- "@openmrs/esm-offline": "^3.2.1-pre.1090",
45
- "@openmrs/esm-react-utils": "^3.2.1-pre.1090",
46
- "@openmrs/esm-state": "^3.2.1-pre.1090",
47
- "@openmrs/esm-styleguide": "^3.2.1-pre.1090",
48
- "@openmrs/esm-utils": "^3.2.1-pre.1090",
38
+ "@openmrs/esm-api": "^3.2.1-pre.1101",
39
+ "@openmrs/esm-breadcrumbs": "^3.2.1-pre.1101",
40
+ "@openmrs/esm-config": "^3.2.1-pre.1101",
41
+ "@openmrs/esm-error-handling": "^3.2.1-pre.1101",
42
+ "@openmrs/esm-extensions": "^3.2.1-pre.1101",
43
+ "@openmrs/esm-globals": "^3.2.1-pre.1101",
44
+ "@openmrs/esm-offline": "^3.2.1-pre.1101",
45
+ "@openmrs/esm-react-utils": "^3.2.1-pre.1101",
46
+ "@openmrs/esm-state": "^3.2.1-pre.1101",
47
+ "@openmrs/esm-styleguide": "^3.2.1-pre.1101",
48
+ "@openmrs/esm-utils": "^3.2.1-pre.1101",
49
49
  "dayjs": "^1.10.7"
50
50
  },
51
- "gitHead": "ab4a67b2e1ca6db69fd238faa23b75d6bbc71506"
51
+ "gitHead": "ef2763aec71da71656385003b2e92b16cbd0f51b"
52
52
  }
package/src/index.ts CHANGED
@@ -1,11 +1,11 @@
1
- export * from "@openmrs/esm-api";
1
+ export * from "@openmrs/esm-api/src/public";
2
2
  export * from "@openmrs/esm-breadcrumbs";
3
- export * from "@openmrs/esm-config";
3
+ export * from "@openmrs/esm-config/src/public";
4
4
  export * from "@openmrs/esm-error-handling";
5
- export * from "@openmrs/esm-extensions";
6
- export * from "@openmrs/esm-globals";
7
- export * from "@openmrs/esm-react-utils";
8
- export * from "@openmrs/esm-state";
9
- export * from "@openmrs/esm-styleguide";
5
+ export * from "@openmrs/esm-extensions/src/public";
6
+ export * from "@openmrs/esm-globals/src/public";
7
+ export * from "@openmrs/esm-offline/src/public";
8
+ export * from "@openmrs/esm-react-utils/src/public";
9
+ export * from "@openmrs/esm-state/src/public";
10
+ export * from "@openmrs/esm-styleguide/src/public";
10
11
  export * from "@openmrs/esm-utils";
11
- export * from "@openmrs/esm-offline";
package/src/internal.ts ADDED
@@ -0,0 +1,11 @@
1
+ export * from "@openmrs/esm-api";
2
+ export * from "@openmrs/esm-breadcrumbs";
3
+ export * from "@openmrs/esm-config";
4
+ export * from "@openmrs/esm-error-handling";
5
+ export * from "@openmrs/esm-extensions";
6
+ export * from "@openmrs/esm-globals";
7
+ export * from "@openmrs/esm-offline";
8
+ export * from "@openmrs/esm-react-utils";
9
+ export * from "@openmrs/esm-state";
10
+ export * from "@openmrs/esm-styleguide";
11
+ export * from "@openmrs/esm-utils";
package/docs/interfaces/ComponentConfig.md DELETED
@@ -1,30 +0,0 @@
1
- [@openmrs/esm-framework](../API.md) / ComponentConfig
2
-
3
- # Interface: ComponentConfig
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [extension](ComponentConfig.md#extension)
10
- - [moduleName](ComponentConfig.md#modulename)
11
-
12
- ## Properties
13
-
14
- ### extension
15
-
16
- • `Optional` **extension**: [`ExtensionData`](ExtensionData.md)
17
-
18
- #### Defined in
19
-
20
- [packages/framework/esm-react-utils/src/ComponentContext.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L11)
21
-
22
- ___
23
-
24
- ### moduleName
25
-
26
- • **moduleName**: `string`
27
-
28
- #### Defined in
29
-
30
- [packages/framework/esm-react-utils/src/ComponentContext.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L10)
package/docs/interfaces/ComponentDecoratorOptions.md DELETED
@@ -1,52 +0,0 @@
1
- [@openmrs/esm-framework](../API.md) / ComponentDecoratorOptions
2
-
3
- # Interface: ComponentDecoratorOptions
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [disableTranslations](ComponentDecoratorOptions.md#disabletranslations)
10
- - [featureName](ComponentDecoratorOptions.md#featurename)
11
- - [moduleName](ComponentDecoratorOptions.md#modulename)
12
- - [strictMode](ComponentDecoratorOptions.md#strictmode)
13
-
14
- ## Properties
15
-
16
- ### disableTranslations
17
-
18
- • `Optional` **disableTranslations**: `boolean`
19
-
20
- #### Defined in
21
-
22
- [packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L57)
23
-
24
- ___
25
-
26
- ### featureName
27
-
28
- • **featureName**: `string`
29
-
30
- #### Defined in
31
-
32
- [packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L56)
33
-
34
- ___
35
-
36
- ### moduleName
37
-
38
- • **moduleName**: `string`
39
-
40
- #### Defined in
41
-
42
- [packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L55)
43
-
44
- ___
45
-
46
- ### strictMode
47
-
48
- • `Optional` **strictMode**: `boolean`
49
-
50
- #### Defined in
51
-
52
- [packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L58)
package/docs/interfaces/ExtensionInfo.md DELETED
@@ -1,139 +0,0 @@
1
- [@openmrs/esm-framework](../API.md) / ExtensionInfo
2
-
3
- # Interface: ExtensionInfo
4
-
5
- ## Hierarchy
6
-
7
- - [`ExtensionRegistration`](ExtensionRegistration.md)
8
-
9
- ↳ **`ExtensionInfo`**
10
-
11
- ## Table of contents
12
-
13
- ### Properties
14
-
15
- - [instances](ExtensionInfo.md#instances)
16
- - [meta](ExtensionInfo.md#meta)
17
- - [moduleName](ExtensionInfo.md#modulename)
18
- - [name](ExtensionInfo.md#name)
19
- - [offline](ExtensionInfo.md#offline)
20
- - [online](ExtensionInfo.md#online)
21
- - [order](ExtensionInfo.md#order)
22
-
23
- ### Methods
24
-
25
- - [load](ExtensionInfo.md#load)
26
-
27
- ## Properties
28
-
29
- ### instances
30
-
31
- • **instances**: [`ExtensionInstance`](ExtensionInstance.md)[]
32
-
33
- The instances where the extension has been rendered using `renderExtension`.
34
-
35
- #### Defined in
36
-
37
- [packages/framework/esm-extensions/src/store.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L28)
38
-
39
- ___
40
-
41
- ### meta
42
-
43
- • **meta**: [`ExtensionMeta`](ExtensionMeta.md)
44
-
45
- #### Inherited from
46
-
47
- [ExtensionRegistration](ExtensionRegistration.md).[meta](ExtensionRegistration.md#meta)
48
-
49
- #### Defined in
50
-
51
- [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)
52
-
53
- ___
54
-
55
- ### moduleName
56
-
57
- • **moduleName**: `string`
58
-
59
- #### Inherited from
60
-
61
- [ExtensionRegistration](ExtensionRegistration.md).[moduleName](ExtensionRegistration.md#modulename)
62
-
63
- #### Defined in
64
-
65
- [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)
66
-
67
- ___
68
-
69
- ### name
70
-
71
- • **name**: `string`
72
-
73
- #### Inherited from
74
-
75
- [ExtensionRegistration](ExtensionRegistration.md).[name](ExtensionRegistration.md#name)
76
-
77
- #### Defined in
78
-
79
- [packages/framework/esm-extensions/src/store.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L15)
80
-
81
- ___
82
-
83
- ### offline
84
-
85
- • `Optional` **offline**: `boolean` \| `object`
86
-
87
- #### Inherited from
88
-
89
- [ExtensionRegistration](ExtensionRegistration.md).[offline](ExtensionRegistration.md#offline)
90
-
91
- #### Defined in
92
-
93
- [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)
94
-
95
- ___
96
-
97
- ### online
98
-
99
- • `Optional` **online**: `boolean` \| `object`
100
-
101
- #### Inherited from
102
-
103
- [ExtensionRegistration](ExtensionRegistration.md).[online](ExtensionRegistration.md#online)
104
-
105
- #### Defined in
106
-
107
- [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)
108
-
109
- ___
110
-
111
- ### order
112
-
113
- • `Optional` **order**: `number`
114
-
115
- #### Inherited from
116
-
117
- [ExtensionRegistration](ExtensionRegistration.md).[order](ExtensionRegistration.md#order)
118
-
119
- #### Defined in
120
-
121
- [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)
122
-
123
- ## Methods
124
-
125
- ### load
126
-
127
- ▸ **load**(): `Promise`<`any`\>
128
-
129
- #### Returns
130
-
131
- `Promise`<`any`\>
132
-
133
- #### Inherited from
134
-
135
- [ExtensionRegistration](ExtensionRegistration.md).[load](ExtensionRegistration.md#load)
136
-
137
- #### Defined in
138
-
139
- [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)
package/docs/interfaces/ExtensionInstance.md DELETED
@@ -1,41 +0,0 @@
1
- [@openmrs/esm-framework](../API.md) / ExtensionInstance
2
-
3
- # Interface: ExtensionInstance
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [id](ExtensionInstance.md#id)
10
- - [slotModuleName](ExtensionInstance.md#slotmodulename)
11
- - [slotName](ExtensionInstance.md#slotname)
12
-
13
- ## Properties
14
-
15
- ### id
16
-
17
- • **id**: `string`
18
-
19
- #### Defined in
20
-
21
- [packages/framework/esm-extensions/src/store.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L32)
22
-
23
- ___
24
-
25
- ### slotModuleName
26
-
27
- • **slotModuleName**: `string`
28
-
29
- #### Defined in
30
-
31
- [packages/framework/esm-extensions/src/store.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L34)
32
-
33
- ___
34
-
35
- ### slotName
36
-
37
- • **slotName**: `string`
38
-
39
- #### Defined in
40
-
41
- [packages/framework/esm-extensions/src/store.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L33)
package/docs/interfaces/ExtensionInternalStore.md DELETED
@@ -1,34 +0,0 @@
1
- [@openmrs/esm-framework](../API.md) / ExtensionInternalStore
2
-
3
- # Interface: ExtensionInternalStore
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [extensions](ExtensionInternalStore.md#extensions)
10
- - [slots](ExtensionInternalStore.md#slots)
11
-
12
- ## Properties
13
-
14
- ### extensions
15
-
16
- • **extensions**: `Record`<`string`, [`ExtensionInfo`](ExtensionInfo.md)\>
17
-
18
- Extensions indexed by name
19
-
20
- #### Defined in
21
-
22
- [packages/framework/esm-extensions/src/store.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L41)
23
-
24
- ___
25
-
26
- ### slots
27
-
28
- • **slots**: `Record`<`string`, [`ExtensionSlotInfo`](ExtensionSlotInfo.md)\>
29
-
30
- Slots indexed by name
31
-
32
- #### Defined in
33
-
34
- [packages/framework/esm-extensions/src/store.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L39)
package/docs/interfaces/ExtensionSlotInfo.md DELETED
@@ -1,64 +0,0 @@
1
- [@openmrs/esm-framework](../API.md) / ExtensionSlotInfo
2
-
3
- # Interface: ExtensionSlotInfo
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [attachedIds](ExtensionSlotInfo.md#attachedids)
10
- - [config](ExtensionSlotInfo.md#config)
11
- - [moduleName](ExtensionSlotInfo.md#modulename)
12
- - [name](ExtensionSlotInfo.md#name)
13
-
14
- ## Properties
15
-
16
- ### attachedIds
17
-
18
- • **attachedIds**: `string`[]
19
-
20
- The set of extension IDs which have been attached to this slot using `attach`.
21
- However, not all of these extension IDs should be rendered.
22
- `assignedIds` is the set defining those.
23
-
24
- #### Defined in
25
-
26
- [packages/framework/esm-extensions/src/store.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L58)
27
-
28
- ___
29
-
30
- ### config
31
-
32
- • **config**: ``null`` \| [`ExtensionSlotConfigObject`](ExtensionSlotConfigObject.md)
33
-
34
- The configuration provided for this slot. `null` if not yet loaded.
35
-
36
- #### Defined in
37
-
38
- [packages/framework/esm-extensions/src/store.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L60)
39
-
40
- ___
41
-
42
- ### moduleName
43
-
44
- • `Optional` **moduleName**: `string`
45
-
46
- The module in which the extension slot exists. Undefined if the slot
47
- hasn't been registered yet (but it has been attached or assigned to
48
- an extension.
49
-
50
- #### Defined in
51
-
52
- [packages/framework/esm-extensions/src/store.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L50)
53
-
54
- ___
55
-
56
- ### name
57
-
58
- • **name**: `string`
59
-
60
- The name under which the extension slot has been registered.
61
-
62
- #### Defined in
63
-
64
- [packages/framework/esm-extensions/src/store.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L52)