@openmrs/esm-framework 8.0.1-pre.3603 → 8.0.1-pre.3612

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 (5) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/docs/functions/subscribeOpenmrsEvent.md +37 -0
  3. package/docs/interfaces/OpenmrsEventTypes.md +28 -0
  4. package/docs/type-aliases/OpenmrsEvent.md +9 -0
  5. package/package.json +20 -20
package/.turbo/turbo-build.log CHANGED
@@ -1,3 +1,3 @@
1
- [0] Rspack compiled successfully in 6.63 s
1
+ [0] Rspack compiled successfully in 6.78 s
2
2
  [0] rspack --mode=production exited with code 0
3
3
  [1] tsc --project tsconfig.build.json exited with code 0
package/docs/functions/subscribeOpenmrsEvent.md ADDED
@@ -0,0 +1,37 @@
1
+ [O3 Framework](../API.md) / subscribeOpenmrsEvent
2
+
3
+ # Function: subscribeOpenmrsEvent()
4
+
5
+ > **subscribeOpenmrsEvent**\<`T`\>(`event`, `handler`): () => `void`
6
+
7
+ Defined in: [packages/framework/esm-emr-api/src/events/index.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/events/index.ts#L24)
8
+
9
+ Subscribes to a custom OpenMRS event
10
+
11
+ ## Type Parameters
12
+
13
+ ### T
14
+
15
+ `T` *extends* keyof [`OpenmrsEventTypes`](../interfaces/OpenmrsEventTypes.md)
16
+
17
+ ## Parameters
18
+
19
+ ### event
20
+
21
+ `T`
22
+
23
+ The name of the event to listen to
24
+
25
+ ### handler
26
+
27
+ (`payload?`) => `boolean` \| `void`
28
+
29
+ The callback to be called when the event fires
30
+
31
+ ## Returns
32
+
33
+ > (): `void`
34
+
35
+ ### Returns
36
+
37
+ `void`
package/docs/interfaces/OpenmrsEventTypes.md ADDED
@@ -0,0 +1,28 @@
1
+ [O3 Framework](../API.md) / OpenmrsEventTypes
2
+
3
+ # Interface: OpenmrsEventTypes
4
+
5
+ Defined in: [packages/framework/esm-emr-api/src/events/types.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/events/types.ts#L32)
6
+
7
+ This is the set of events supported by the custom event system
8
+
9
+ ## Properties
10
+
11
+ ### before-page-changed
12
+
13
+ > **before-page-changed**: `PageChanged`
14
+
15
+ Defined in: [packages/framework/esm-emr-api/src/events/types.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/events/types.ts#L41)
16
+
17
+ The before-page-changed event is fired before the active page in the application changes
18
+
19
+ ***
20
+
21
+ ### started
22
+
23
+ > **started**: `never`
24
+
25
+ Defined in: [packages/framework/esm-emr-api/src/events/types.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/events/types.ts#L37)
26
+
27
+ The started event is fired once when the app started.
28
+ Listeners should use this as an opportunity to do any initialization required.
package/docs/type-aliases/OpenmrsEvent.md ADDED
@@ -0,0 +1,9 @@
1
+ [O3 Framework](../API.md) / OpenmrsEvent
2
+
3
+ # Type Alias: OpenmrsEvent
4
+
5
+ > **OpenmrsEvent** = keyof [`OpenmrsEventTypes`](../interfaces/OpenmrsEventTypes.md)
6
+
7
+ Defined in: [packages/framework/esm-emr-api/src/events/types.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/events/types.ts#L47)
8
+
9
+ This type is the union of all supported events
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "8.0.1-pre.3603",
3
+ "version": "8.0.1-pre.3612",
4
4
  "license": "MPL-2.0",
5
5
  "type": "module",
6
6
  "module": "dist/openmrs-esm-framework.js",
@@ -60,24 +60,24 @@
60
60
  "access": "public"
61
61
  },
62
62
  "dependencies": {
63
- "@openmrs/esm-api": "8.0.1-pre.3603",
64
- "@openmrs/esm-config": "8.0.1-pre.3603",
65
- "@openmrs/esm-context": "8.0.1-pre.3603",
66
- "@openmrs/esm-dynamic-loading": "8.0.1-pre.3603",
67
- "@openmrs/esm-emr-api": "8.0.1-pre.3603",
68
- "@openmrs/esm-error-handling": "8.0.1-pre.3603",
69
- "@openmrs/esm-expression-evaluator": "8.0.1-pre.3603",
70
- "@openmrs/esm-extensions": "8.0.1-pre.3603",
71
- "@openmrs/esm-feature-flags": "8.0.1-pre.3603",
72
- "@openmrs/esm-globals": "8.0.1-pre.3603",
73
- "@openmrs/esm-navigation": "8.0.1-pre.3603",
74
- "@openmrs/esm-offline": "8.0.1-pre.3603",
75
- "@openmrs/esm-react-utils": "8.0.1-pre.3603",
76
- "@openmrs/esm-routes": "8.0.1-pre.3603",
77
- "@openmrs/esm-state": "8.0.1-pre.3603",
78
- "@openmrs/esm-styleguide": "8.0.1-pre.3603",
79
- "@openmrs/esm-translations": "8.0.1-pre.3603",
80
- "@openmrs/esm-utils": "8.0.1-pre.3603"
63
+ "@openmrs/esm-api": "8.0.1-pre.3612",
64
+ "@openmrs/esm-config": "8.0.1-pre.3612",
65
+ "@openmrs/esm-context": "8.0.1-pre.3612",
66
+ "@openmrs/esm-dynamic-loading": "8.0.1-pre.3612",
67
+ "@openmrs/esm-emr-api": "8.0.1-pre.3612",
68
+ "@openmrs/esm-error-handling": "8.0.1-pre.3612",
69
+ "@openmrs/esm-expression-evaluator": "8.0.1-pre.3612",
70
+ "@openmrs/esm-extensions": "8.0.1-pre.3612",
71
+ "@openmrs/esm-feature-flags": "8.0.1-pre.3612",
72
+ "@openmrs/esm-globals": "8.0.1-pre.3612",
73
+ "@openmrs/esm-navigation": "8.0.1-pre.3612",
74
+ "@openmrs/esm-offline": "8.0.1-pre.3612",
75
+ "@openmrs/esm-react-utils": "8.0.1-pre.3612",
76
+ "@openmrs/esm-routes": "8.0.1-pre.3612",
77
+ "@openmrs/esm-state": "8.0.1-pre.3612",
78
+ "@openmrs/esm-styleguide": "8.0.1-pre.3612",
79
+ "@openmrs/esm-translations": "8.0.1-pre.3612",
80
+ "@openmrs/esm-utils": "8.0.1-pre.3612"
81
81
  },
82
82
  "peerDependencies": {
83
83
  "dayjs": "1.x",
@@ -90,7 +90,7 @@
90
90
  "swr": "2.x"
91
91
  },
92
92
  "devDependencies": {
93
- "@openmrs/typedoc-plugin-file-categories": "8.0.1-pre.3603",
93
+ "@openmrs/typedoc-plugin-file-categories": "8.0.1-pre.3612",
94
94
  "@rspack/cli": "^1.3.11",
95
95
  "@rspack/core": "^1.3.11",
96
96
  "@vitest/coverage-v8": "^4.0.7",