@openmrs/esm-framework 3.4.1-pre.132 → 3.4.1-pre.133

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 (10) hide show
  1. package/.turbo/turbo-build.log +8 -8
  2. package/dist/openmrs-esm-framework.js +1 -1
  3. package/dist/openmrs-esm-framework.js.map +1 -1
  4. package/docs/API.md +22 -11
  5. package/docs/classes/OpenmrsFetchError.md +4 -4
  6. package/docs/interfaces/FHIRRequestObj.md +5 -3
  7. package/docs/interfaces/FHIRRequestOptions.md +43 -0
  8. package/docs/interfaces/FetchResponseJson.md +7 -0
  9. package/docs/interfaces/UserHasAccessProps.md +11 -0
  10. package/package.json +13 -13
package/docs/API.md CHANGED
@@ -545,7 +545,7 @@ ___
545
545
 
546
546
  #### Defined in
547
547
 
548
- [packages/framework/esm-react-utils/src/UserHasAccess.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L9)
548
+ [packages/framework/esm-react-utils/src/UserHasAccess.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L10)
549
549
 
550
550
  ___
551
551
 
@@ -561,16 +561,27 @@ ___
561
561
 
562
562
  ### fhir
563
563
 
564
- • **fhir**: `FhirClient`
564
+ • **fhir**: `Object`
565
565
 
566
- The `fhir` object is [an instance of fhir.js](https://github.com/FHIR/fhir.js)
566
+ The `fhir` object is replicates the API from [fhir.js](https://github.com/FHIR/fhir.js)
567
567
  that can be used to call FHIR-compliant OpenMRS APIs. See
568
568
  [the docs for fhir.js](https://github.com/FHIR/fhir.js) for more info
569
569
  and example usage.
570
570
 
571
+ This object should be considered deprecated and may be removed from a future version
572
+ of the framework.
573
+
574
+ **`deprecated`**
575
+
576
+ #### Type declaration
577
+
578
+ | Name | Type |
579
+ | :------ | :------ |
580
+ | `read` | <T\>(`options`: [`FHIRRequestOptions`](interfaces/FHIRRequestOptions.md)) => `Promise`<{ `config`: [`FHIRRequestObj`](interfaces/FHIRRequestObj.md) ; `data`: `T` ; `headers`: `Headers` ; `status`: `number` }\> |
581
+
571
582
  #### Defined in
572
583
 
573
- [packages/framework/esm-api/src/fhir.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L42)
584
+ [packages/framework/esm-api/src/fhir.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L45)
574
585
 
575
586
  ___
576
587
 
@@ -600,7 +611,7 @@ ___
600
611
 
601
612
  #### Defined in
602
613
 
603
- [packages/framework/esm-api/src/openmrs-fetch.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L12)
614
+ [packages/framework/esm-api/src/openmrs-fetch.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L7)
604
615
 
605
616
  ___
606
617
 
@@ -752,18 +763,18 @@ ___
752
763
 
753
764
  ### fetchCurrentPatient
754
765
 
755
- ▸ **fetchCurrentPatient**(`patientUuid`, `contentOverrides?`): `Promise`<{ `data`: `Patient` }\> \| `Promise`<``null``\>
766
+ ▸ **fetchCurrentPatient**(`patientUuid`, `contentOverrides?`): `Promise`<{ `config`: [`FHIRRequestObj`](interfaces/FHIRRequestObj.md) ; `data`: `Patient` ; `headers`: `Headers` ; `status`: `number` }\> \| `Promise`<``null``\>
756
767
 
757
768
  #### Parameters
758
769
 
759
770
  | Name | Type |
760
771
  | :------ | :------ |
761
772
  | `patientUuid` | [`PatientUuid`](API.md#patientuuid) |
762
- | `contentOverrides?` | `Partial`<{ `headers?`: [`FetchHeaders`](interfaces/FetchHeaders.md) ; `id?`: `string` ; `patient?`: `string` ; `type`: `ResourceName` }\> |
773
+ | `contentOverrides?` | `Partial`<[`FHIRRequestOptions`](interfaces/FHIRRequestOptions.md)\> |
763
774
 
764
775
  #### Returns
765
776
 
766
- `Promise`<{ `data`: `Patient` }\> \| `Promise`<``null``\>
777
+ `Promise`<{ `config`: [`FHIRRequestObj`](interfaces/FHIRRequestObj.md) ; `data`: `Patient` ; `headers`: `Headers` ; `status`: `number` }\> \| `Promise`<``null``\>
767
778
 
768
779
  #### Defined in
769
780
 
@@ -967,7 +978,7 @@ makeUrl('/foo/bar');
967
978
 
968
979
  #### Defined in
969
980
 
970
- [packages/framework/esm-api/src/openmrs-fetch.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L24)
981
+ [packages/framework/esm-api/src/openmrs-fetch.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L19)
971
982
 
972
983
  ___
973
984
 
@@ -1034,7 +1045,7 @@ free up memory and network resources and to prevent race conditions.
1034
1045
 
1035
1046
  #### Defined in
1036
1047
 
1037
- [packages/framework/esm-api/src/openmrs-fetch.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L77)
1048
+ [packages/framework/esm-api/src/openmrs-fetch.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L72)
1038
1049
 
1039
1050
  ___
1040
1051
 
@@ -1085,7 +1096,7 @@ To cancel the network request, simply call `subscription.unsubscribe();`
1085
1096
 
1086
1097
  #### Defined in
1087
1098
 
1088
- [packages/framework/esm-api/src/openmrs-fetch.ts:248](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L248)
1099
+ [packages/framework/esm-api/src/openmrs-fetch.ts:243](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L243)
1089
1100
 
1090
1101
  ___
1091
1102
 
package/docs/classes/OpenmrsFetchError.md CHANGED
@@ -53,7 +53,7 @@ Error.constructor
53
53
 
54
54
  #### Defined in
55
55
 
56
- [packages/framework/esm-api/src/openmrs-fetch.ts:286](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L286)
56
+ [packages/framework/esm-api/src/openmrs-fetch.ts:281](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L281)
57
57
 
58
58
  ## API Properties
59
59
 
@@ -63,17 +63,17 @@ Error.constructor
63
63
 
64
64
  #### Defined in
65
65
 
66
- [packages/framework/esm-api/src/openmrs-fetch.ts:299](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L299)
66
+ [packages/framework/esm-api/src/openmrs-fetch.ts:294](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L294)
67
67
 
68
68
  ___
69
69
 
70
70
  ### responseBody
71
71
 
72
- • **responseBody**: ``null`` \| `string` \| `FetchResponseJson`
72
+ • **responseBody**: ``null`` \| `string` \| [`FetchResponseJson`](../interfaces/FetchResponseJson.md)
73
73
 
74
74
  #### Defined in
75
75
 
76
- [packages/framework/esm-api/src/openmrs-fetch.ts:300](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L300)
76
+ [packages/framework/esm-api/src/openmrs-fetch.ts:295](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L295)
77
77
 
78
78
  ___
79
79
 
package/docs/interfaces/FHIRRequestObj.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  # Interface: FHIRRequestObj
4
4
 
5
+ **`deprecated`**
6
+
5
7
  ## Table of contents
6
8
 
7
9
  ### API Properties
@@ -18,7 +20,7 @@
18
20
 
19
21
  #### Defined in
20
22
 
21
- [packages/framework/esm-api/src/fhir.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L50)
23
+ [packages/framework/esm-api/src/fhir.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L73)
22
24
 
23
25
  ___
24
26
 
@@ -28,7 +30,7 @@ ___
28
30
 
29
31
  #### Defined in
30
32
 
31
- [packages/framework/esm-api/src/fhir.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L49)
33
+ [packages/framework/esm-api/src/fhir.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L72)
32
34
 
33
35
  ___
34
36
 
@@ -38,4 +40,4 @@ ___
38
40
 
39
41
  #### Defined in
40
42
 
41
- [packages/framework/esm-api/src/fhir.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L48)
43
+ [packages/framework/esm-api/src/fhir.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L71)
package/docs/interfaces/FHIRRequestOptions.md ADDED
@@ -0,0 +1,43 @@
1
+ [@openmrs/esm-framework](../API.md) / FHIRRequestOptions
2
+
3
+ # Interface: FHIRRequestOptions
4
+
5
+ **`deprecated`**
6
+
7
+ ## Table of contents
8
+
9
+ ### API Properties
10
+
11
+ - [headers](FHIRRequestOptions.md#headers)
12
+ - [patient](FHIRRequestOptions.md#patient)
13
+ - [type](FHIRRequestOptions.md#type)
14
+
15
+ ## API Properties
16
+
17
+ ### headers
18
+
19
+ • `Optional` **headers**: [`FetchHeaders`](FetchHeaders.md)
20
+
21
+ #### Defined in
22
+
23
+ [packages/framework/esm-api/src/fhir.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L66)
24
+
25
+ ___
26
+
27
+ ### patient
28
+
29
+ • **patient**: `string`
30
+
31
+ #### Defined in
32
+
33
+ [packages/framework/esm-api/src/fhir.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L65)
34
+
35
+ ___
36
+
37
+ ### type
38
+
39
+ • **type**: `ResourceName`
40
+
41
+ #### Defined in
42
+
43
+ [packages/framework/esm-api/src/fhir.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L64)
package/docs/interfaces/FetchResponseJson.md ADDED
@@ -0,0 +1,7 @@
1
+ [@openmrs/esm-framework](../API.md) / FetchResponseJson
2
+
3
+ # Interface: FetchResponseJson
4
+
5
+ ## Indexable
6
+
7
+ ▪ [key: `string`]: `any`
package/docs/interfaces/UserHasAccessProps.md CHANGED
@@ -6,10 +6,21 @@
6
6
 
7
7
  ### API Properties
8
8
 
9
+ - [fallback](UserHasAccessProps.md#fallback)
9
10
  - [privilege](UserHasAccessProps.md#privilege)
10
11
 
11
12
  ## API Properties
12
13
 
14
+ ### fallback
15
+
16
+ • `Optional` **fallback**: `ReactNode`
17
+
18
+ #### Defined in
19
+
20
+ [packages/framework/esm-react-utils/src/UserHasAccess.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L7)
21
+
22
+ ___
23
+
13
24
  ### privilege
14
25
 
15
26
  • **privilege**: `string`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openmrs/esm-framework",
3
- "version": "3.4.1-pre.132",
3
+ "version": "3.4.1-pre.133",
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.4.1-pre.132",
39
- "@openmrs/esm-breadcrumbs": "^3.4.1-pre.132",
40
- "@openmrs/esm-config": "^3.4.1-pre.132",
41
- "@openmrs/esm-error-handling": "^3.4.1-pre.132",
42
- "@openmrs/esm-extensions": "^3.4.1-pre.132",
43
- "@openmrs/esm-globals": "^3.4.1-pre.132",
44
- "@openmrs/esm-offline": "^3.4.1-pre.132",
45
- "@openmrs/esm-react-utils": "^3.4.1-pre.132",
46
- "@openmrs/esm-state": "^3.4.1-pre.132",
47
- "@openmrs/esm-styleguide": "^3.4.1-pre.132",
48
- "@openmrs/esm-utils": "^3.4.1-pre.132",
38
+ "@openmrs/esm-api": "^3.4.1-pre.133",
39
+ "@openmrs/esm-breadcrumbs": "^3.4.1-pre.133",
40
+ "@openmrs/esm-config": "^3.4.1-pre.133",
41
+ "@openmrs/esm-error-handling": "^3.4.1-pre.133",
42
+ "@openmrs/esm-extensions": "^3.4.1-pre.133",
43
+ "@openmrs/esm-globals": "^3.4.1-pre.133",
44
+ "@openmrs/esm-offline": "^3.4.1-pre.133",
45
+ "@openmrs/esm-react-utils": "^3.4.1-pre.133",
46
+ "@openmrs/esm-state": "^3.4.1-pre.133",
47
+ "@openmrs/esm-styleguide": "^3.4.1-pre.133",
48
+ "@openmrs/esm-utils": "^3.4.1-pre.133",
49
49
  "dayjs": "^1.10.7"
50
50
  },
51
- "gitHead": "492efb72dd8ae4c73ec188a4d14f5d8dd6c35e49"
51
+ "gitHead": "a39d44591042d755a1b8164bef7b2b49a05890ff"
52
52
  }