@openmrs/esm-framework 4.0.2 → 4.0.3-pre.350

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 (9) hide show
  1. package/.turbo/turbo-build.log +6 -6
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/API.md +9 -12
  5. package/docs/interfaces/ConfigObject.md +11 -0
  6. package/docs/interfaces/DisplayConditionsConfigObject.md +1 -1
  7. package/docs/interfaces/ExtensionSlotConfig.md +4 -4
  8. package/docs/interfaces/ExtensionSlotConfigObject.md +3 -3
  9. package/package.json +13 -13
package/docs/API.md CHANGED
@@ -387,7 +387,7 @@ ___
387
387
 
388
388
  #### Defined in
389
389
 
390
- [packages/framework/esm-config/src/types.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L37)
390
+ [packages/framework/esm-config/src/types.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L38)
391
391
 
392
392
  ___
393
393
 
@@ -424,7 +424,7 @@ ___
424
424
 
425
425
  #### Defined in
426
426
 
427
- [packages/framework/esm-config/src/types.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L65)
427
+ [packages/framework/esm-config/src/types.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L66)
428
428
 
429
429
  ___
430
430
 
@@ -468,7 +468,7 @@ ___
468
468
 
469
469
  #### Defined in
470
470
 
471
- [packages/framework/esm-config/src/types.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L72)
471
+ [packages/framework/esm-config/src/types.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L73)
472
472
 
473
473
  ___
474
474
 
@@ -492,7 +492,7 @@ ___
492
492
 
493
493
  #### Defined in
494
494
 
495
- [packages/framework/esm-config/src/types.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L70)
495
+ [packages/framework/esm-config/src/types.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L71)
496
496
 
497
497
  ___
498
498
 
@@ -890,7 +890,7 @@ ___
890
890
 
891
891
  #### Defined in
892
892
 
893
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:202](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L202)
893
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:206](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L206)
894
894
 
895
895
  ___
896
896
 
@@ -904,7 +904,7 @@ ___
904
904
 
905
905
  #### Defined in
906
906
 
907
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:220](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L220)
907
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:224](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L224)
908
908
 
909
909
  ___
910
910
 
@@ -1169,7 +1169,7 @@ ___
1169
1169
 
1170
1170
  #### Defined in
1171
1171
 
1172
- [packages/framework/esm-api/src/shared-api-objects/current-user.ts:229](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L229)
1172
+ [packages/framework/esm-api/src/shared-api-objects/current-user.ts:233](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/shared-api-objects/current-user.ts#L233)
1173
1173
 
1174
1174
  ___
1175
1175
 
@@ -1557,10 +1557,6 @@ ___
1557
1557
  A promise-based way to access the config as soon as it is fully loaded.
1558
1558
  If it is already loaded, resolves the config in its present state.
1559
1559
 
1560
- In general you should use the Unistore-based API provided by
1561
- `getConfigStore`, which allows creating a subscription so that you always
1562
- have the latest config. If using React, just use `useConfig`.
1563
-
1564
1560
  This is a useful function if you need to get the config in the course
1565
1561
  of the execution of a function.
1566
1562
 
@@ -1576,7 +1572,7 @@ of the execution of a function.
1576
1572
 
1577
1573
  #### Defined in
1578
1574
 
1579
- [packages/framework/esm-config/src/module-config/module-config.ts:264](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L264)
1575
+ [packages/framework/esm-config/src/module-config/module-config.ts:260](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/module-config/module-config.ts#L260)
1580
1576
 
1581
1577
  ___
1582
1578
 
@@ -1614,6 +1610,7 @@ Use this React Hook to obtain your module's configuration.
1614
1610
  | Name | Type | Description |
1615
1611
  | :------ | :------ | :------ |
1616
1612
  | `Display conditions?` | [`DisplayConditionsConfigObject`](interfaces/DisplayConditionsConfigObject.md) | - |
1613
+ | `Translation overrides?` | `Record`<`string`, `Record`<`string`, `string`\>\> | - |
1617
1614
  | `constructor` | `Function` | The initial value of Object.prototype.constructor is the standard built-in Object constructor. |
1618
1615
  | `hasOwnProperty` | (`v`: `PropertyKey`) => `boolean` | Determines whether an object has a property with the specified name. |
1619
1616
  | `isPrototypeOf` | (`v`: `Object`) => `boolean` | Determines whether an object exists in another object's prototype chain. |
package/docs/interfaces/ConfigObject.md CHANGED
@@ -17,6 +17,7 @@
17
17
  ### Properties
18
18
 
19
19
  - [Display conditions](ConfigObject.md#display conditions)
20
+ - [Translation overrides](ConfigObject.md#translation overrides)
20
21
  - [constructor](ConfigObject.md#constructor)
21
22
 
22
23
  ### Methods
@@ -40,6 +41,16 @@
40
41
 
41
42
  ___
42
43
 
44
+ ### Translation overrides
45
+
46
+ • `Optional` **Translation overrides**: `Record`<`string`, `Record`<`string`, `string`\>\>
47
+
48
+ #### Defined in
49
+
50
+ [packages/framework/esm-config/src/types.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L31)
51
+
52
+ ___
53
+
43
54
  ### constructor
44
55
 
45
56
  • **constructor**: `Function`
package/docs/interfaces/DisplayConditionsConfigObject.md CHANGED
@@ -16,4 +16,4 @@
16
16
 
17
17
  #### Defined in
18
18
 
19
- [packages/framework/esm-config/src/types.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L34)
19
+ [packages/framework/esm-config/src/types.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L35)
package/docs/interfaces/ExtensionSlotConfig.md CHANGED
@@ -19,7 +19,7 @@
19
19
 
20
20
  #### Defined in
21
21
 
22
- [packages/framework/esm-config/src/types.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L46)
22
+ [packages/framework/esm-config/src/types.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L47)
23
23
 
24
24
  ___
25
25
 
@@ -29,7 +29,7 @@ ___
29
29
 
30
30
  #### Defined in
31
31
 
32
- [packages/framework/esm-config/src/types.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L49)
32
+ [packages/framework/esm-config/src/types.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L50)
33
33
 
34
34
  ___
35
35
 
@@ -39,7 +39,7 @@ ___
39
39
 
40
40
  #### Defined in
41
41
 
42
- [packages/framework/esm-config/src/types.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L48)
42
+ [packages/framework/esm-config/src/types.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L49)
43
43
 
44
44
  ___
45
45
 
@@ -49,4 +49,4 @@ ___
49
49
 
50
50
  #### Defined in
51
51
 
52
- [packages/framework/esm-config/src/types.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L47)
52
+ [packages/framework/esm-config/src/types.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L48)
package/docs/interfaces/ExtensionSlotConfigObject.md CHANGED
@@ -20,7 +20,7 @@ Additional extension IDs to assign to this slot, in addition to those `attach`ed
20
20
 
21
21
  #### Defined in
22
22
 
23
- [packages/framework/esm-config/src/types.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L58)
23
+ [packages/framework/esm-config/src/types.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L59)
24
24
 
25
25
  ___
26
26
 
@@ -32,7 +32,7 @@ Overrides the default ordering of extensions.
32
32
 
33
33
  #### Defined in
34
34
 
35
- [packages/framework/esm-config/src/types.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L62)
35
+ [packages/framework/esm-config/src/types.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L63)
36
36
 
37
37
  ___
38
38
 
@@ -44,4 +44,4 @@ Extension IDs which were `attach`ed to the slot but which should not be assigned
44
44
 
45
45
  #### Defined in
46
46
 
47
- [packages/framework/esm-config/src/types.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L60)
47
+ [packages/framework/esm-config/src/types.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L61)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "4.0.2",
3
+ "version": "4.0.3-pre.350",
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": "^4.0.2",
39
- "@openmrs/esm-breadcrumbs": "^4.0.2",
40
- "@openmrs/esm-config": "^4.0.2",
41
- "@openmrs/esm-error-handling": "^4.0.2",
42
- "@openmrs/esm-extensions": "^4.0.2",
43
- "@openmrs/esm-globals": "^4.0.2",
44
- "@openmrs/esm-offline": "^4.0.2",
45
- "@openmrs/esm-react-utils": "^4.0.2",
46
- "@openmrs/esm-state": "^4.0.2",
47
- "@openmrs/esm-styleguide": "^4.0.2",
48
- "@openmrs/esm-utils": "^4.0.2",
38
+ "@openmrs/esm-api": "^4.0.3-pre.350",
39
+ "@openmrs/esm-breadcrumbs": "^4.0.3-pre.350",
40
+ "@openmrs/esm-config": "^4.0.3-pre.350",
41
+ "@openmrs/esm-error-handling": "^4.0.3-pre.350",
42
+ "@openmrs/esm-extensions": "^4.0.3-pre.350",
43
+ "@openmrs/esm-globals": "^4.0.3-pre.350",
44
+ "@openmrs/esm-offline": "^4.0.3-pre.350",
45
+ "@openmrs/esm-react-utils": "^4.0.3-pre.350",
46
+ "@openmrs/esm-state": "^4.0.3-pre.350",
47
+ "@openmrs/esm-styleguide": "^4.0.3-pre.350",
48
+ "@openmrs/esm-utils": "^4.0.3-pre.350",
49
49
  "dayjs": "^1.10.7"
50
50
  },
51
- "gitHead": "cfd4f3a1a3746bff9ef8bc369033b77a0587be5c"
51
+ "gitHead": "c81f432d4a410f6b166e88a13080346b546ca45b"
52
52
  }