@openmrs/esm-framework 6.3.1-pre.3124 → 6.3.1-pre.3127

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 (16) hide show
  1. package/.turbo/turbo-build.log +1 -1
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/API.md +6 -35
  5. package/docs/functions/OpenmrsAppContext.md +2 -2
  6. package/docs/functions/getContext.md +2 -2
  7. package/docs/functions/registerContext.md +1 -1
  8. package/docs/functions/subscribeToContext.md +1 -1
  9. package/docs/functions/unregisterContext.md +1 -1
  10. package/docs/functions/updateContext.md +2 -2
  11. package/docs/functions/useAppContext.md +1 -1
  12. package/docs/functions/useDefineAppContext.md +1 -1
  13. package/docs/interfaces/OpenmrsAppContextProps.md +3 -3
  14. package/docs/type-aliases/ContextCallback.md +1 -1
  15. package/package.json +20 -20
  16. package/typedoc.json +1 -0
package/docs/API.md CHANGED
@@ -228,41 +228,12 @@
228
228
 
229
229
  ## Config
230
230
 
231
- ### ConfigStore
232
-
233
- Defined in: /Users/ibacher/Documents/openmrs/openmrs-esm-core/packages/framework/esm-config/src/module-config/state.ts:99
234
-
235
- **`Internal`**
236
-
237
- Output configs
238
-
239
- Each module has its own stores for its config and its extension slots' configs.
240
-
241
- #### config
242
-
243
- > **config**: `null` \| [`ConfigObject`](interfaces/ConfigObject.md)
244
-
245
- Defined in: /Users/ibacher/Documents/openmrs/openmrs-esm-core/packages/framework/esm-config/src/module-config/state.ts:100
246
-
247
- #### loaded
248
-
249
- > **loaded**: `boolean`
250
-
251
- Defined in: /Users/ibacher/Documents/openmrs/openmrs-esm-core/packages/framework/esm-config/src/module-config/state.ts:101
252
-
253
- #### translationOverridesLoaded
254
-
255
- > **translationOverridesLoaded**: `boolean`
256
-
257
- Defined in: /Users/ibacher/Documents/openmrs/openmrs-esm-core/packages/framework/esm-config/src/module-config/state.ts:102
258
-
259
- ***
260
-
261
- ### getConfigStore
262
-
263
- > **getConfigStore**:
264
-
265
- Defined in: /Users/ibacher/Documents/openmrs/openmrs-esm-core/packages/framework/esm-config/src/module-config/state.ts:114
231
+ - [useConfig](functions/useConfig.md)
232
+ - [UseConfigOptions](interfaces/UseConfigOptions.md)
233
+ - [defineConfigSchema](functions/defineConfigSchema.md)
234
+ - [defineExtensionConfigSchema](functions/defineExtensionConfigSchema.md)
235
+ - [provide](functions/provide.md)
236
+ - [getConfig](functions/getConfig.md)
266
237
 
267
238
  ## Feature Flags
268
239
 
package/docs/functions/OpenmrsAppContext.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **OpenmrsAppContext**\<`T`\>(`__namedParameters`): `null`
6
6
 
7
- Defined in: [packages/framework/esm-react-utils/src/OpenmrsContext.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/OpenmrsContext.ts#L26)
7
+ Defined in: [packages/framework/esm-react-utils/src/OpenmrsContext.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/OpenmrsContext.ts#L24)
8
8
 
9
9
  OpenmrsAppContext is a simple React component meant to function similarly to React's Context,
10
10
  but built on top of the OpenmrsAppContext.
@@ -13,7 +13,7 @@ but built on top of the OpenmrsAppContext.
13
13
 
14
14
  ### T
15
15
 
16
- `T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> = `Record`\<`string` \| `number` \| `symbol`, `any`\>
16
+ `T` *extends* `object` = `object`
17
17
 
18
18
  ## Parameters
19
19
 
package/docs/functions/getContext.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **getContext**\<`T`\>(`namespace`): `null` \| `Readonly`\<`T`\>
6
6
 
7
- Defined in: [packages/framework/esm-context/src/context.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-context/src/context.ts#L62)
7
+ Defined in: [packages/framework/esm-context/src/context.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-context/src/context.ts#L63)
8
8
 
9
9
  Returns an _immutable_ version of the state of the namespace as it is currently
10
10
 
@@ -12,7 +12,7 @@ Returns an _immutable_ version of the state of the namespace as it is currently
12
12
 
13
13
  ### T
14
14
 
15
- `T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> = `Record`\<`string` \| `number` \| `symbol`, `any`\>
15
+ `T` *extends* `object` = `object`
16
16
 
17
17
  The type of the value stored in the namespace
18
18
 
package/docs/functions/registerContext.md CHANGED
@@ -13,7 +13,7 @@ an already-registered namespace will display a warning and make no modifications
13
13
 
14
14
  ### T
15
15
 
16
- `T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> = `Record`\<`string` \| `number` \| `symbol`, `any`\>
16
+ `T` *extends* `object` = `object`
17
17
 
18
18
  ## Parameters
19
19
 
package/docs/functions/subscribeToContext.md CHANGED
@@ -12,7 +12,7 @@ Subscribes to updates of a given namespace. Note that the returned object is imm
12
12
 
13
13
  ### T
14
14
 
15
- `T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> = `Record`\<`string` \| `number` \| `symbol`, `any`\>
15
+ `T` *extends* `object` = `object`
16
16
 
17
17
  ## Parameters
18
18
 
package/docs/functions/unregisterContext.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **unregisterContext**(`namespace`): `void`
6
6
 
7
- Defined in: [packages/framework/esm-context/src/context.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-context/src/context.ts#L47)
7
+ Defined in: [packages/framework/esm-context/src/context.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-context/src/context.ts#L48)
8
8
 
9
9
  Used by caller to unregister a namespace in the application context. Unregistering a namespace
10
10
  will remove the namespace and all associated data.
package/docs/functions/updateContext.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  > **updateContext**\<`T`\>(`namespace`, `update`): `void`
6
6
 
7
- Defined in: [packages/framework/esm-context/src/context.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-context/src/context.ts#L88)
7
+ Defined in: [packages/framework/esm-context/src/context.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-context/src/context.ts#L87)
8
8
 
9
9
  Updates a namespace in the global context. If the namespace does not exist, it is registered.
10
10
 
@@ -12,7 +12,7 @@ Updates a namespace in the global context. If the namespace does not exist, it i
12
12
 
13
13
  ### T
14
14
 
15
- `T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> = `Record`\<`string` \| `number` \| `symbol`, `any`\>
15
+ `T` *extends* `object` = `object`
16
16
 
17
17
  ## Parameters
18
18
 
package/docs/functions/useAppContext.md CHANGED
@@ -14,7 +14,7 @@ returned from the namespace.
14
14
 
15
15
  ### T
16
16
 
17
- `T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> = `Record`\<`string` \| `number` \| `symbol`, `any`\>
17
+ `T` *extends* `object` = `object`
18
18
 
19
19
  The type of the value stored in the namespace
20
20
 
package/docs/functions/useDefineAppContext.md CHANGED
@@ -14,7 +14,7 @@ will be automatically removed when the component using this hook is unmounted.
14
14
 
15
15
  ### T
16
16
 
17
- `T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> = `Record`\<`string` \| `number` \| `symbol`, `any`\>
17
+ `T` *extends* `object` = `object`
18
18
 
19
19
  The type of the value of the namespace
20
20
 
package/docs/interfaces/OpenmrsAppContextProps.md CHANGED
@@ -8,7 +8,7 @@ Defined in: [packages/framework/esm-react-utils/src/OpenmrsContext.ts:4](https:/
8
8
 
9
9
  ### T
10
10
 
11
- `T` *extends* `Record`\<`string` \| `symbol` \| `number`, `unknown`\> = `Record`\<`string` \| `symbol` \| `number`, `any`\>
11
+ `T` *extends* `NonNullable`\<`object`\> = `NonNullable`\<`object`\>
12
12
 
13
13
  ## Properties
14
14
 
@@ -16,7 +16,7 @@ Defined in: [packages/framework/esm-react-utils/src/OpenmrsContext.ts:4](https:/
16
16
 
17
17
  > **namespace**: `string`
18
18
 
19
- Defined in: [packages/framework/esm-react-utils/src/OpenmrsContext.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/OpenmrsContext.ts#L8)
19
+ Defined in: [packages/framework/esm-react-utils/src/OpenmrsContext.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/OpenmrsContext.ts#L6)
20
20
 
21
21
  the namespace that this component defines
22
22
 
@@ -26,6 +26,6 @@ the namespace that this component defines
26
26
 
27
27
  > `optional` **value**: `T`
28
28
 
29
- Defined in: [packages/framework/esm-react-utils/src/OpenmrsContext.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/OpenmrsContext.ts#L10)
29
+ Defined in: [packages/framework/esm-react-utils/src/OpenmrsContext.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/OpenmrsContext.ts#L8)
30
30
 
31
31
  used to control the value associated with the namespace
package/docs/type-aliases/ContextCallback.md CHANGED
@@ -10,7 +10,7 @@ Defined in: [packages/framework/esm-context/src/context.ts:101](https://github.c
10
10
 
11
11
  ### T
12
12
 
13
- `T` *extends* `Record`\<`string` \| `symbol` \| `number`, `unknown`\> = `Record`\<`string` \| `symbol` \| `number`, `any`\>
13
+ `T` *extends* `NonNullable`\<`object`\> = `NonNullable`\<`object`\>
14
14
 
15
15
  ## Parameters
16
16
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "6.3.1-pre.3124",
3
+ "version": "6.3.1-pre.3127",
4
4
  "license": "MPL-2.0",
5
5
  "type": "module",
6
6
  "module": "dist/openmrs-esm-framework.js",
@@ -59,24 +59,24 @@
59
59
  "access": "public"
60
60
  },
61
61
  "dependencies": {
62
- "@openmrs/esm-api": "6.3.1-pre.3124",
63
- "@openmrs/esm-config": "6.3.1-pre.3124",
64
- "@openmrs/esm-context": "6.3.1-pre.3124",
65
- "@openmrs/esm-dynamic-loading": "6.3.1-pre.3124",
66
- "@openmrs/esm-emr-api": "6.3.1-pre.3124",
67
- "@openmrs/esm-error-handling": "6.3.1-pre.3124",
68
- "@openmrs/esm-expression-evaluator": "6.3.1-pre.3124",
69
- "@openmrs/esm-extensions": "6.3.1-pre.3124",
70
- "@openmrs/esm-feature-flags": "6.3.1-pre.3124",
71
- "@openmrs/esm-globals": "6.3.1-pre.3124",
72
- "@openmrs/esm-navigation": "6.3.1-pre.3124",
73
- "@openmrs/esm-offline": "6.3.1-pre.3124",
74
- "@openmrs/esm-react-utils": "6.3.1-pre.3124",
75
- "@openmrs/esm-routes": "6.3.1-pre.3124",
76
- "@openmrs/esm-state": "6.3.1-pre.3124",
77
- "@openmrs/esm-styleguide": "6.3.1-pre.3124",
78
- "@openmrs/esm-translations": "6.3.1-pre.3124",
79
- "@openmrs/esm-utils": "6.3.1-pre.3124"
62
+ "@openmrs/esm-api": "6.3.1-pre.3127",
63
+ "@openmrs/esm-config": "6.3.1-pre.3127",
64
+ "@openmrs/esm-context": "6.3.1-pre.3127",
65
+ "@openmrs/esm-dynamic-loading": "6.3.1-pre.3127",
66
+ "@openmrs/esm-emr-api": "6.3.1-pre.3127",
67
+ "@openmrs/esm-error-handling": "6.3.1-pre.3127",
68
+ "@openmrs/esm-expression-evaluator": "6.3.1-pre.3127",
69
+ "@openmrs/esm-extensions": "6.3.1-pre.3127",
70
+ "@openmrs/esm-feature-flags": "6.3.1-pre.3127",
71
+ "@openmrs/esm-globals": "6.3.1-pre.3127",
72
+ "@openmrs/esm-navigation": "6.3.1-pre.3127",
73
+ "@openmrs/esm-offline": "6.3.1-pre.3127",
74
+ "@openmrs/esm-react-utils": "6.3.1-pre.3127",
75
+ "@openmrs/esm-routes": "6.3.1-pre.3127",
76
+ "@openmrs/esm-state": "6.3.1-pre.3127",
77
+ "@openmrs/esm-styleguide": "6.3.1-pre.3127",
78
+ "@openmrs/esm-translations": "6.3.1-pre.3127",
79
+ "@openmrs/esm-utils": "6.3.1-pre.3127"
80
80
  },
81
81
  "peerDependencies": {
82
82
  "dayjs": "1.x",
@@ -98,7 +98,7 @@
98
98
  "sass-embedded": "^1.89.0",
99
99
  "svgo-loader": "^4.0.0",
100
100
  "typedoc": "^0.28.5",
101
- "typedoc-plugin-file-categories": "6.3.1-pre.3124",
101
+ "typedoc-plugin-file-categories": "6.3.1-pre.3127",
102
102
  "typedoc-plugin-markdown": "^4.6.3",
103
103
  "typedoc-plugin-no-inherit": "^1.6.1",
104
104
  "typescript": "^5.8.3",
package/typedoc.json CHANGED
@@ -13,6 +13,7 @@
13
13
  "typedoc-plugin-markdown",
14
14
  "typedoc-plugin-no-inherit"
15
15
  ],
16
+ "basePath": "../../../",
16
17
  "readme": "none",
17
18
  "excludeInternal": true,
18
19
  "entryFileName": "API.md",