@openmrs/esm-api 3.1.15-pre.694 → 3.1.15-pre.712

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 (34) hide show
  1. package/README.md +0 -2
  2. package/package.json +5 -6
  3. package/docs/API.md +0 -724
  4. package/docs/classes/OpenmrsFetchError.md +0 -186
  5. package/docs/enums/VisitMode.md +0 -41
  6. package/docs/enums/VisitStatus.md +0 -30
  7. package/docs/interfaces/CurrentPatientOptions.md +0 -27
  8. package/docs/interfaces/CurrentUserOptions.md +0 -27
  9. package/docs/interfaces/CurrentUserWithResponseOption.md +0 -29
  10. package/docs/interfaces/CurrentUserWithoutResponseOption.md +0 -29
  11. package/docs/interfaces/FHIRCode.md +0 -30
  12. package/docs/interfaces/FHIRRequestObj.md +0 -41
  13. package/docs/interfaces/FHIRResource.md +0 -46
  14. package/docs/interfaces/FetchHeaders.md +0 -7
  15. package/docs/interfaces/FetchResponse.md +0 -285
  16. package/docs/interfaces/Location.md +0 -41
  17. package/docs/interfaces/LoggedInUser.md +0 -133
  18. package/docs/interfaces/LoggedInUserFetchResponse.md +0 -281
  19. package/docs/interfaces/NewVisitPayload.md +0 -74
  20. package/docs/interfaces/OnlyThePatient.md +0 -29
  21. package/docs/interfaces/OpenmrsResource.md +0 -34
  22. package/docs/interfaces/PatientWithFullResponse.md +0 -29
  23. package/docs/interfaces/Person.md +0 -41
  24. package/docs/interfaces/Privilege.md +0 -41
  25. package/docs/interfaces/Role.md +0 -41
  26. package/docs/interfaces/SessionLocation.md +0 -41
  27. package/docs/interfaces/SessionUser.md +0 -92
  28. package/docs/interfaces/UnauthenticatedUser.md +0 -52
  29. package/docs/interfaces/User.md +0 -107
  30. package/docs/interfaces/Visit.md +0 -111
  31. package/docs/interfaces/VisitItem.md +0 -52
  32. package/docs/interfaces/VisitType.md +0 -41
  33. package/docs/interfaces/WorkspaceItem.md +0 -74
  34. package/typedoc.json +0 -7
package/docs/interfaces/UnauthenticatedUser.md DELETED
@@ -1,52 +0,0 @@
1
- [@openmrs/esm-api](../API.md) / UnauthenticatedUser
2
-
3
- # Interface: UnauthenticatedUser
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [authenticated](UnauthenticatedUser.md#authenticated)
10
- - [sessionId](UnauthenticatedUser.md#sessionid)
11
- - [sessionLocation](UnauthenticatedUser.md#sessionlocation)
12
- - [user](UnauthenticatedUser.md#user)
13
-
14
- ## Properties
15
-
16
- ### authenticated
17
-
18
- • **authenticated**: `boolean`
19
-
20
- #### Defined in
21
-
22
- [packages/framework/esm-api/src/types/user-resource.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L30)
23
-
24
- ___
25
-
26
- ### sessionId
27
-
28
- • **sessionId**: `string`
29
-
30
- #### Defined in
31
-
32
- [packages/framework/esm-api/src/types/user-resource.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L29)
33
-
34
- ___
35
-
36
- ### sessionLocation
37
-
38
- • `Optional` **sessionLocation**: [`SessionLocation`](SessionLocation.md)
39
-
40
- #### Defined in
41
-
42
- [packages/framework/esm-api/src/types/user-resource.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L32)
43
-
44
- ___
45
-
46
- ### user
47
-
48
- • `Optional` **user**: [`LoggedInUser`](LoggedInUser.md)
49
-
50
- #### Defined in
51
-
52
- [packages/framework/esm-api/src/types/user-resource.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L31)
package/docs/interfaces/User.md DELETED
@@ -1,107 +0,0 @@
1
- [@openmrs/esm-api](../API.md) / User
2
-
3
- # Interface: User
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [display](User.md#display)
10
- - [link](User.md#link)
11
- - [persion](User.md#persion)
12
- - [priviliges](User.md#priviliges)
13
- - [resourceVersion](User.md#resourceversion)
14
- - [roles](User.md#roles)
15
- - [userProperties](User.md#userproperties)
16
- - [username](User.md#username)
17
- - [uuid](User.md#uuid)
18
-
19
- ## Properties
20
-
21
- ### display
22
-
23
- • **display**: `string`
24
-
25
- #### Defined in
26
-
27
- [packages/framework/esm-api/src/types/openmrs-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L18)
28
-
29
- ___
30
-
31
- ### link
32
-
33
- • **link**: `string`[]
34
-
35
- #### Defined in
36
-
37
- [packages/framework/esm-api/src/types/openmrs-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L19)
38
-
39
- ___
40
-
41
- ### persion
42
-
43
- • **persion**: `any`
44
-
45
- #### Defined in
46
-
47
- [packages/framework/esm-api/src/types/openmrs-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L20)
48
-
49
- ___
50
-
51
- ### priviliges
52
-
53
- • **priviliges**: `any`
54
-
55
- #### Defined in
56
-
57
- [packages/framework/esm-api/src/types/openmrs-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L21)
58
-
59
- ___
60
-
61
- ### resourceVersion
62
-
63
- • **resourceVersion**: `any`
64
-
65
- #### Defined in
66
-
67
- [packages/framework/esm-api/src/types/openmrs-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L22)
68
-
69
- ___
70
-
71
- ### roles
72
-
73
- • **roles**: `any`[]
74
-
75
- #### Defined in
76
-
77
- [packages/framework/esm-api/src/types/openmrs-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L23)
78
-
79
- ___
80
-
81
- ### userProperties
82
-
83
- • **userProperties**: `any`
84
-
85
- #### Defined in
86
-
87
- [packages/framework/esm-api/src/types/openmrs-resource.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L24)
88
-
89
- ___
90
-
91
- ### username
92
-
93
- • **username**: `string`
94
-
95
- #### Defined in
96
-
97
- [packages/framework/esm-api/src/types/openmrs-resource.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L25)
98
-
99
- ___
100
-
101
- ### uuid
102
-
103
- • **uuid**: `string`
104
-
105
- #### Defined in
106
-
107
- [packages/framework/esm-api/src/types/openmrs-resource.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L26)
package/docs/interfaces/Visit.md DELETED
@@ -1,111 +0,0 @@
1
- [@openmrs/esm-api](../API.md) / Visit
2
-
3
- # Interface: Visit
4
-
5
- ## Indexable
6
-
7
- ▪ [anythingElse: `string`]: `any`
8
-
9
- ## Table of contents
10
-
11
- ### Properties
12
-
13
- - [attributes](Visit.md#attributes)
14
- - [display](Visit.md#display)
15
- - [encounters](Visit.md#encounters)
16
- - [location](Visit.md#location)
17
- - [patient](Visit.md#patient)
18
- - [startDatetime](Visit.md#startdatetime)
19
- - [stopDatetime](Visit.md#stopdatetime)
20
- - [uuid](Visit.md#uuid)
21
- - [visitType](Visit.md#visittype)
22
-
23
- ## Properties
24
-
25
- ### attributes
26
-
27
- • `Optional` **attributes**: [`OpenmrsResource`](OpenmrsResource.md)[]
28
-
29
- #### Defined in
30
-
31
- [packages/framework/esm-api/src/types/visit-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L23)
32
-
33
- ___
34
-
35
- ### display
36
-
37
- • `Optional` **display**: `string`
38
-
39
- #### Defined in
40
-
41
- [packages/framework/esm-api/src/types/visit-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L16)
42
-
43
- ___
44
-
45
- ### encounters
46
-
47
- • **encounters**: [`OpenmrsResource`](OpenmrsResource.md)[]
48
-
49
- #### Defined in
50
-
51
- [packages/framework/esm-api/src/types/visit-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L17)
52
-
53
- ___
54
-
55
- ### location
56
-
57
- • `Optional` **location**: [`Location`](Location.md)
58
-
59
- #### Defined in
60
-
61
- [packages/framework/esm-api/src/types/visit-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L20)
62
-
63
- ___
64
-
65
- ### patient
66
-
67
- • `Optional` **patient**: [`OpenmrsResource`](OpenmrsResource.md)
68
-
69
- #### Defined in
70
-
71
- [packages/framework/esm-api/src/types/visit-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L18)
72
-
73
- ___
74
-
75
- ### startDatetime
76
-
77
- • **startDatetime**: `Date`
78
-
79
- #### Defined in
80
-
81
- [packages/framework/esm-api/src/types/visit-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L21)
82
-
83
- ___
84
-
85
- ### stopDatetime
86
-
87
- • `Optional` **stopDatetime**: `Date`
88
-
89
- #### Defined in
90
-
91
- [packages/framework/esm-api/src/types/visit-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L22)
92
-
93
- ___
94
-
95
- ### uuid
96
-
97
- • **uuid**: `string`
98
-
99
- #### Defined in
100
-
101
- [packages/framework/esm-api/src/types/visit-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L15)
102
-
103
- ___
104
-
105
- ### visitType
106
-
107
- • **visitType**: [`VisitType`](VisitType.md)
108
-
109
- #### Defined in
110
-
111
- [packages/framework/esm-api/src/types/visit-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L19)
package/docs/interfaces/VisitItem.md DELETED
@@ -1,52 +0,0 @@
1
- [@openmrs/esm-api](../API.md) / VisitItem
2
-
3
- # Interface: VisitItem
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [anythingElse](VisitItem.md#anythingelse)
10
- - [mode](VisitItem.md#mode)
11
- - [status](VisitItem.md#status)
12
- - [visitData](VisitItem.md#visitdata)
13
-
14
- ## Properties
15
-
16
- ### anythingElse
17
-
18
- • `Optional` **anythingElse**: `any`
19
-
20
- #### Defined in
21
-
22
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L90)
23
-
24
- ___
25
-
26
- ### mode
27
-
28
- • **mode**: [`VisitMode`](../enums/VisitMode.md)
29
-
30
- #### Defined in
31
-
32
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L87)
33
-
34
- ___
35
-
36
- ### status
37
-
38
- • **status**: [`VisitStatus`](../enums/VisitStatus.md)
39
-
40
- #### Defined in
41
-
42
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L89)
43
-
44
- ___
45
-
46
- ### visitData
47
-
48
- • `Optional` **visitData**: [`Visit`](Visit.md)
49
-
50
- #### Defined in
51
-
52
- [packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L88)
package/docs/interfaces/VisitType.md DELETED
@@ -1,41 +0,0 @@
1
- [@openmrs/esm-api](../API.md) / VisitType
2
-
3
- # Interface: VisitType
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [display](VisitType.md#display)
10
- - [name](VisitType.md#name)
11
- - [uuid](VisitType.md#uuid)
12
-
13
- ## Properties
14
-
15
- ### display
16
-
17
- • **display**: `string`
18
-
19
- #### Defined in
20
-
21
- [packages/framework/esm-api/src/types/visit-resource.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L35)
22
-
23
- ___
24
-
25
- ### name
26
-
27
- • `Optional` **name**: `string`
28
-
29
- #### Defined in
30
-
31
- [packages/framework/esm-api/src/types/visit-resource.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L36)
32
-
33
- ___
34
-
35
- ### uuid
36
-
37
- • **uuid**: `string`
38
-
39
- #### Defined in
40
-
41
- [packages/framework/esm-api/src/types/visit-resource.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L34)
package/docs/interfaces/WorkspaceItem.md DELETED
@@ -1,74 +0,0 @@
1
- [@openmrs/esm-api](../API.md) / WorkspaceItem
2
-
3
- # Interface: WorkspaceItem
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [component](WorkspaceItem.md#component)
10
- - [componentClosed](WorkspaceItem.md#componentclosed)
11
- - [inProgress](WorkspaceItem.md#inprogress)
12
- - [name](WorkspaceItem.md#name)
13
- - [props](WorkspaceItem.md#props)
14
- - [validations](WorkspaceItem.md#validations)
15
-
16
- ## Properties
17
-
18
- ### component
19
-
20
- • **component**: `any`
21
-
22
- #### Defined in
23
-
24
- [packages/framework/esm-api/src/workspace/workspace.resource.tsx:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L24)
25
-
26
- ___
27
-
28
- ### componentClosed
29
-
30
- • `Optional` **componentClosed**: `Function`
31
-
32
- #### Defined in
33
-
34
- [packages/framework/esm-api/src/workspace/workspace.resource.tsx:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L29)
35
-
36
- ___
37
-
38
- ### inProgress
39
-
40
- • **inProgress**: `boolean`
41
-
42
- #### Defined in
43
-
44
- [packages/framework/esm-api/src/workspace/workspace.resource.tsx:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L28)
45
-
46
- ___
47
-
48
- ### name
49
-
50
- • **name**: `string`
51
-
52
- #### Defined in
53
-
54
- [packages/framework/esm-api/src/workspace/workspace.resource.tsx:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L25)
55
-
56
- ___
57
-
58
- ### props
59
-
60
- • **props**: `any`
61
-
62
- #### Defined in
63
-
64
- [packages/framework/esm-api/src/workspace/workspace.resource.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L26)
65
-
66
- ___
67
-
68
- ### validations
69
-
70
- • `Optional` **validations**: `Function`
71
-
72
- #### Defined in
73
-
74
- [packages/framework/esm-api/src/workspace/workspace.resource.tsx:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L27)
package/typedoc.json DELETED
@@ -1,7 +0,0 @@
1
- {
2
- "out": "docs",
3
- "readme": "none",
4
- "excludeInternal": true,
5
- "gitRevision": "master",
6
- "entryDocument": "API.md"
7
- }