@openmrs/esm-framework 9.0.3-pre.4622 → 9.0.3-pre.4643

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 (3) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/docs/functions/useAppContext.md +12 -2
  3. package/package.json +20 -20
package/.turbo/turbo-build.log CHANGED
@@ -1,3 +1,3 @@
1
- [0] Successfully compiled: 3 files with swc (116.52ms)
1
+ [0] Successfully compiled: 3 files with swc (129.39ms)
2
2
  [0] swc --strip-leading-paths src -d dist exited with code 0
3
3
  [1] tsc --project tsconfig.build.json exited with code 0
package/docs/functions/useAppContext.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  > **useAppContext**\<`T`\>(`namespace`): `undefined` \| `Readonly`\<`T`\>
8
8
 
9
- Defined in: [packages/framework/esm-react-utils/src/useAppContext.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAppContext.ts#L26)
9
+ Defined in: [packages/framework/esm-react-utils/src/useAppContext.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAppContext.ts#L30)
10
10
 
11
11
  This hook is used to access a namespace within the overall AppContext, so that a component can
12
12
  use any shared contextual values. A selector may be provided to further restrict the properties
@@ -32,6 +32,11 @@ The namespace to load properties from
32
32
 
33
33
  `undefined` \| `Readonly`\<`T`\>
34
34
 
35
+ The current value registered under `namespace`, or `undefined` when the namespace has not
36
+ yet been registered, was unregistered (e.g. the owning component unmounted), or is a blank string.
37
+ Consumers should handle the `undefined` case explicitly rather than defaulting to `{}`, since an
38
+ empty-object default can mask a genuinely missing namespace and hide bugs.
39
+
35
40
  ### Examples
36
41
 
37
42
  ```ts
@@ -48,7 +53,7 @@ const patientName = useAppContext<PatientContext, string | undefined>('patient',
48
53
 
49
54
  > **useAppContext**\<`T`, `U`\>(`namespace`, `selector`): `undefined` \| `Readonly`\<`U`\>
50
55
 
51
- Defined in: [packages/framework/esm-react-utils/src/useAppContext.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAppContext.ts#L52)
56
+ Defined in: [packages/framework/esm-react-utils/src/useAppContext.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAppContext.ts#L60)
52
57
 
53
58
  This hook is used to access a namespace within the overall AppContext, so that a component can
54
59
  use any shared contextual values. A selector may be provided to further restrict the properties
@@ -86,6 +91,11 @@ An optional function which extracts the relevant part of the state
86
91
 
87
92
  `undefined` \| `Readonly`\<`U`\>
88
93
 
94
+ The selected value, or `undefined` when the namespace has not yet been registered, was
95
+ unregistered (e.g. the owning component unmounted), or is a blank string. Consumers should handle
96
+ the `undefined` case explicitly rather than defaulting to `{}`, since an empty-object default can
97
+ mask a genuinely missing namespace and hide bugs.
98
+
89
99
  ### Examples
90
100
 
91
101
  ```ts
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "9.0.3-pre.4622",
3
+ "version": "9.0.3-pre.4643",
4
4
  "license": "MPL-2.0",
5
5
  "type": "module",
6
6
  "module": "dist/index.js",
@@ -59,24 +59,24 @@
59
59
  "access": "public"
60
60
  },
61
61
  "dependencies": {
62
- "@openmrs/esm-api": "9.0.3-pre.4622",
63
- "@openmrs/esm-config": "9.0.3-pre.4622",
64
- "@openmrs/esm-context": "9.0.3-pre.4622",
65
- "@openmrs/esm-dynamic-loading": "9.0.3-pre.4622",
66
- "@openmrs/esm-emr-api": "9.0.3-pre.4622",
67
- "@openmrs/esm-error-handling": "9.0.3-pre.4622",
68
- "@openmrs/esm-expression-evaluator": "9.0.3-pre.4622",
69
- "@openmrs/esm-extensions": "9.0.3-pre.4622",
70
- "@openmrs/esm-feature-flags": "9.0.3-pre.4622",
71
- "@openmrs/esm-globals": "9.0.3-pre.4622",
72
- "@openmrs/esm-navigation": "9.0.3-pre.4622",
73
- "@openmrs/esm-offline": "9.0.3-pre.4622",
74
- "@openmrs/esm-react-utils": "9.0.3-pre.4622",
75
- "@openmrs/esm-routes": "9.0.3-pre.4622",
76
- "@openmrs/esm-state": "9.0.3-pre.4622",
77
- "@openmrs/esm-styleguide": "9.0.3-pre.4622",
78
- "@openmrs/esm-translations": "9.0.3-pre.4622",
79
- "@openmrs/esm-utils": "9.0.3-pre.4622"
62
+ "@openmrs/esm-api": "9.0.3-pre.4643",
63
+ "@openmrs/esm-config": "9.0.3-pre.4643",
64
+ "@openmrs/esm-context": "9.0.3-pre.4643",
65
+ "@openmrs/esm-dynamic-loading": "9.0.3-pre.4643",
66
+ "@openmrs/esm-emr-api": "9.0.3-pre.4643",
67
+ "@openmrs/esm-error-handling": "9.0.3-pre.4643",
68
+ "@openmrs/esm-expression-evaluator": "9.0.3-pre.4643",
69
+ "@openmrs/esm-extensions": "9.0.3-pre.4643",
70
+ "@openmrs/esm-feature-flags": "9.0.3-pre.4643",
71
+ "@openmrs/esm-globals": "9.0.3-pre.4643",
72
+ "@openmrs/esm-navigation": "9.0.3-pre.4643",
73
+ "@openmrs/esm-offline": "9.0.3-pre.4643",
74
+ "@openmrs/esm-react-utils": "9.0.3-pre.4643",
75
+ "@openmrs/esm-routes": "9.0.3-pre.4643",
76
+ "@openmrs/esm-state": "9.0.3-pre.4643",
77
+ "@openmrs/esm-styleguide": "9.0.3-pre.4643",
78
+ "@openmrs/esm-translations": "9.0.3-pre.4643",
79
+ "@openmrs/esm-utils": "9.0.3-pre.4643"
80
80
  },
81
81
  "peerDependencies": {
82
82
  "dayjs": "1.x",
@@ -89,7 +89,7 @@
89
89
  "swr": "2.x"
90
90
  },
91
91
  "devDependencies": {
92
- "@openmrs/typedoc-plugin-file-categories": "9.0.3-pre.4622",
92
+ "@openmrs/typedoc-plugin-file-categories": "9.0.3-pre.4643",
93
93
  "@swc/cli": "0.8.1",
94
94
  "@swc/core": "1.15.21",
95
95
  "@vitest/coverage-v8": "^4.1.2",