@openmrs/esm-framework 6.3.1-pre.3105 → 6.3.1-pre.3106

package/docs/interfaces/LoggedInUser.md

@@ -1,131 +1,133 @@
-[O3 Framework](../API.md) / LoggedInUser
+[@openmrs/esm-framework](../API.md) / LoggedInUser
 
 # Interface: LoggedInUser
 
-Defined in: [packages/framework/esm-api/src/types/user-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/user-resource.ts#L14)
-
 ## Indexable
 
-\[`anythingElse`: `string`\]: `any`
+▪ [anythingElse: `string`]: `any`
 
-## Properties
+## Table of contents
 
-### allowedLocales
+### Properties
 
-> **allowedLocales**: `string`[]
+- [allowedLocales](LoggedInUser.md#allowedlocales)
+- [display](LoggedInUser.md#display)
+- [locale](LoggedInUser.md#locale)
+- [person](LoggedInUser.md#person)
+- [privileges](LoggedInUser.md#privileges)
+- [retired](LoggedInUser.md#retired)
+- [roles](LoggedInUser.md#roles)
+- [systemId](LoggedInUser.md#systemid)
+- [userProperties](LoggedInUser.md#userproperties)
+- [username](LoggedInUser.md#username)
+- [uuid](LoggedInUser.md#uuid)
 
-Defined in: [packages/framework/esm-api/src/types/user-resource.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/user-resource.ts#L45)
+## Properties
 
-***
+### allowedLocales
 
-### display
+• **allowedLocales**: `string`[]
 
-> **display**: `string`
+#### Defined in
 
-Defined in: [packages/framework/esm-api/src/types/user-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/user-resource.ts#L16)
+[packages/framework/esm-api/src/types/user-resource.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L45)
 
-***
+___
 
-### locale
+### display
 
-> **locale**: `string`
+• **display**: `string`
 
-Defined in: [packages/framework/esm-api/src/types/user-resource.ts:44](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/user-resource.ts#L44)
+#### Defined in
 
-***
+[packages/framework/esm-api/src/types/user-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L16)
 
-### person
+___
 
-> **person**: [`Person`](Person.md)
+### locale
 
-Defined in: [packages/framework/esm-api/src/types/user-resource.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/user-resource.ts#L40)
+• **locale**: `string`
 
-***
+#### Defined in
 
-### privileges
+[packages/framework/esm-api/src/types/user-resource.ts:44](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L44)
 
-> **privileges**: [`Privilege`](Privilege.md)[]
+___
 
-Defined in: [packages/framework/esm-api/src/types/user-resource.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/user-resource.ts#L41)
+### person
 
-***
+• **person**: [`Person`](Person.md)
 
-### retired
+#### Defined in
 
-> **retired**: `boolean`
+[packages/framework/esm-api/src/types/user-resource.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L40)
 
-Defined in: [packages/framework/esm-api/src/types/user-resource.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/user-resource.ts#L43)
+___
 
-***
-
-### roles
+### privileges
 
-> **roles**: [`Role`](Role.md)[]
+• **privileges**: [`Privilege`](Privilege.md)[]
 
-Defined in: [packages/framework/esm-api/src/types/user-resource.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/user-resource.ts#L42)
+#### Defined in
 
-***
+[packages/framework/esm-api/src/types/user-resource.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L41)
 
-### systemId
+___
 
-> **systemId**: `string`
+### retired
 
-Defined in: [packages/framework/esm-api/src/types/user-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/user-resource.ts#L18)
+• **retired**: `boolean`
 
-***
+#### Defined in
 
-### username
+[packages/framework/esm-api/src/types/user-resource.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L43)
 
-> **username**: `string`
+___
 
-Defined in: [packages/framework/esm-api/src/types/user-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/user-resource.ts#L17)
+### roles
 
-***
+• **roles**: [`Role`](Role.md)[]
 
-### userProperties
+#### Defined in
 
-> **userProperties**: `null` \| \{[`key`: `string`]: `undefined` \| `string`; `defaultLocation?`: `string`; `patientsVisited?`: `string`; `starredPatientLists?`: `string`; \}
+[packages/framework/esm-api/src/types/user-resource.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L42)
 
-Defined in: [packages/framework/esm-api/src/types/user-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/user-resource.ts#L19)
+___
 
-#### Type declaration
+### systemId
 
-`null`
+• **systemId**: `string`
 
-\{[`key`: `string`]: `undefined` \| `string`; `defaultLocation?`: `string`; `patientsVisited?`: `string`; `starredPatientLists?`: `string`; \}
+#### Defined in
 
-#### Index Signature
+[packages/framework/esm-api/src/types/user-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L18)
 
-\[`key`: `string`\]: `undefined` \| `string`
+___
 
-#### defaultLocation?
+### userProperties
 
-> `optional` **defaultLocation**: `string`
+• **userProperties**: ``null`` \| { `[key: string]`: `string` \| `undefined`; `defaultLocation?`: `string` ; `patientsVisited?`: `string` ; `starredPatientLists?`: `string`  }
 
-The UUID of the location the user has set preference to use for next logins
+#### Defined in
 
-#### patientsVisited?
+[packages/framework/esm-api/src/types/user-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L19)
 
-> `optional` **patientsVisited**: `string`
+___
 
-The UUIDs of patients the user has visited
-Separated by commas
-To get the array, do `user.userProperties.patientsVisited.split(',')`
-To store the array, do `patientsVisited: patientsVisited.join(',')`
+### username
 
-#### starredPatientLists?
+• **username**: `string`
 
-> `optional` **starredPatientLists**: `string`
+#### Defined in
 
-The UUIDs of patient lists the user has starred
-Separated by commas
-To get the array, do `user.userProperties.starredPatientLists.split(',')`
-To store the array, perform `starredPatientLists: starredPatientLists.join(',')`
+[packages/framework/esm-api/src/types/user-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L17)
 
-***
+___
 
 ### uuid
 
-> **uuid**: `string`
+• **uuid**: `string`
+
+#### Defined in
 
-Defined in: [packages/framework/esm-api/src/types/user-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/user-resource.ts#L15)
+[packages/framework/esm-api/src/types/user-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L15)

package/docs/interfaces/LoggedInUserFetchResponse.md

@@ -1,214 +1,218 @@
-[O3 Framework](../API.md) / LoggedInUserFetchResponse
+[@openmrs/esm-framework](../API.md) / LoggedInUserFetchResponse
 
 # Interface: LoggedInUserFetchResponse
 
-Defined in: [packages/framework/esm-api/src/types/fetch.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/fetch.ts#L7)
-
-## Extends
+## Hierarchy
 
 - [`FetchResponse`](FetchResponse.md)
 
-## Properties
-
-### body
-
-> `readonly` **body**: `null` \| `ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+  ↳ **`LoggedInUserFetchResponse`**
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3534
+## Table of contents
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body)
+### Properties
 
-#### Inherited from
-
-[`FetchResponse`](FetchResponse.md).[`body`](FetchResponse.md#body)
+- [body](LoggedInUserFetchResponse.md#body)
+- [bodyUsed](LoggedInUserFetchResponse.md#bodyused)
+- [data](LoggedInUserFetchResponse.md#data)
+- [headers](LoggedInUserFetchResponse.md#headers)
+- [ok](LoggedInUserFetchResponse.md#ok)
+- [redirected](LoggedInUserFetchResponse.md#redirected)
+- [status](LoggedInUserFetchResponse.md#status)
+- [statusText](LoggedInUserFetchResponse.md#statustext)
+- [type](LoggedInUserFetchResponse.md#type)
+- [url](LoggedInUserFetchResponse.md#url)
 
-***
+### Methods
 
-### bodyUsed
+- [arrayBuffer](LoggedInUserFetchResponse.md#arraybuffer)
+- [blob](LoggedInUserFetchResponse.md#blob)
+- [clone](LoggedInUserFetchResponse.md#clone)
+- [formData](LoggedInUserFetchResponse.md#formdata)
+- [json](LoggedInUserFetchResponse.md#json)
+- [text](LoggedInUserFetchResponse.md#text)
 
-> `readonly` **bodyUsed**: `boolean`
+## Properties
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3536
+### body
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed)
+• `Readonly` **body**: ``null`` \| `ReadableStream`<`Uint8Array`\>
 
 #### Inherited from
 
-[`FetchResponse`](FetchResponse.md).[`bodyUsed`](FetchResponse.md#bodyused)
+[FetchResponse](FetchResponse.md).[body](FetchResponse.md#body)
 
-***
+#### Defined in
 
-### data
+node_modules/typescript/lib/lib.dom.d.ts:2587
 
-> **data**: [`Session`](Session.md)
+___
 
-Defined in: [packages/framework/esm-api/src/types/fetch.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/types/fetch.ts#L8)
+### bodyUsed
 
-#### Overrides
+• `Readonly` **bodyUsed**: `boolean`
 
-[`FetchResponse`](FetchResponse.md).[`data`](FetchResponse.md#data)
+#### Inherited from
 
-***
+[FetchResponse](FetchResponse.md).[bodyUsed](FetchResponse.md#bodyused)
 
-### headers
+#### Defined in
 
-> `readonly` **headers**: `Headers`
+node_modules/typescript/lib/lib.dom.d.ts:2588
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19881
+___
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/headers)
+### data
 
-#### Inherited from
+• **data**: [`Session`](Session.md)
 
-[`FetchResponse`](FetchResponse.md).[`headers`](FetchResponse.md#headers)
+#### Overrides
 
-***
+[FetchResponse](FetchResponse.md).[data](FetchResponse.md#data)
 
-### ok
+#### Defined in
 
-> `readonly` **ok**: `boolean`
+[packages/framework/esm-api/src/types/fetch.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/fetch.ts#L8)
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19883
+___
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/ok)
+### headers
+
+• `Readonly` **headers**: `Headers`
 
 #### Inherited from
 
-[`FetchResponse`](FetchResponse.md).[`ok`](FetchResponse.md#ok)
+[FetchResponse](FetchResponse.md).[headers](FetchResponse.md#headers)
 
-***
+#### Defined in
 
-### redirected
+node_modules/typescript/lib/lib.dom.d.ts:11772
 
-> `readonly` **redirected**: `boolean`
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19885
+### ok
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/redirected)
+• `Readonly` **ok**: `boolean`
 
 #### Inherited from
 
-[`FetchResponse`](FetchResponse.md).[`redirected`](FetchResponse.md#redirected)
+[FetchResponse](FetchResponse.md).[ok](FetchResponse.md#ok)
 
-***
+#### Defined in
 
-### status
+node_modules/typescript/lib/lib.dom.d.ts:11773
 
-> `readonly` **status**: `number`
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19887
+### redirected
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/status)
+• `Readonly` **redirected**: `boolean`
 
 #### Inherited from
 
-[`FetchResponse`](FetchResponse.md).[`status`](FetchResponse.md#status)
+[FetchResponse](FetchResponse.md).[redirected](FetchResponse.md#redirected)
 
-***
+#### Defined in
 
-### statusText
+node_modules/typescript/lib/lib.dom.d.ts:11774
 
-> `readonly` **statusText**: `string`
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19889
+### status
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/statusText)
+• `Readonly` **status**: `number`
 
 #### Inherited from
 
-[`FetchResponse`](FetchResponse.md).[`statusText`](FetchResponse.md#statustext)
+[FetchResponse](FetchResponse.md).[status](FetchResponse.md#status)
 
-***
+#### Defined in
 
-### type
+node_modules/typescript/lib/lib.dom.d.ts:11775
 
-> `readonly` **type**: `ResponseType`
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19891
+### statusText
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/type)
+• `Readonly` **statusText**: `string`
 
 #### Inherited from
 
-[`FetchResponse`](FetchResponse.md).[`type`](FetchResponse.md#type)
+[FetchResponse](FetchResponse.md).[statusText](FetchResponse.md#statustext)
 
-***
+#### Defined in
 
-### url
+node_modules/typescript/lib/lib.dom.d.ts:11776
 
-> `readonly` **url**: `string`
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19893
+### type
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/url)
+• `Readonly` **type**: `ResponseType`
 
 #### Inherited from
 
-[`FetchResponse`](FetchResponse.md).[`url`](FetchResponse.md#url)
-
-## Methods
+[FetchResponse](FetchResponse.md).[type](FetchResponse.md#type)
 
-### arrayBuffer()
+#### Defined in
 
-> **arrayBuffer**(): `Promise`\<`ArrayBuffer`\>
+node_modules/typescript/lib/lib.dom.d.ts:11777
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3538
+___
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer)
-
-#### Returns
+### url
 
-`Promise`\<`ArrayBuffer`\>
+• `Readonly` **url**: `string`
 
 #### Inherited from
 
-[`FetchResponse`](FetchResponse.md).[`arrayBuffer`](FetchResponse.md#arraybuffer)
+[FetchResponse](FetchResponse.md).[url](FetchResponse.md#url)
 
-***
+#### Defined in
 
-### blob()
+node_modules/typescript/lib/lib.dom.d.ts:11778
 
-> **blob**(): `Promise`\<`Blob`\>
+## Methods
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3540
+### arrayBuffer
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob)
+▸ **arrayBuffer**(): `Promise`<`ArrayBuffer`\>
 
 #### Returns
 
-`Promise`\<`Blob`\>
+`Promise`<`ArrayBuffer`\>
 
 #### Inherited from
 
-[`FetchResponse`](FetchResponse.md).[`blob`](FetchResponse.md#blob)
+[FetchResponse](FetchResponse.md).[arrayBuffer](FetchResponse.md#arraybuffer)
 
-***
+#### Defined in
 
-### bytes()
+node_modules/typescript/lib/lib.dom.d.ts:2589
 
-> **bytes**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3542
+### blob
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
+▸ **blob**(): `Promise`<`Blob`\>
 
 #### Returns
 
-`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+`Promise`<`Blob`\>
 
 #### Inherited from
 
-[`FetchResponse`](FetchResponse.md).[`bytes`](FetchResponse.md#bytes)
+[FetchResponse](FetchResponse.md).[blob](FetchResponse.md#blob)
 
-***
+#### Defined in
 
-### clone()
+node_modules/typescript/lib/lib.dom.d.ts:2590
 
-> **clone**(): `Response`
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19895
+### clone
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/clone)
+▸ **clone**(): `Response`
 
 #### Returns
 
@@ -216,58 +220,62 @@ Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19895
 
 #### Inherited from
 
-[`FetchResponse`](FetchResponse.md).[`clone`](FetchResponse.md#clone)
+[FetchResponse](FetchResponse.md).[clone](FetchResponse.md#clone)
 
-***
+#### Defined in
 
-### formData()
+node_modules/typescript/lib/lib.dom.d.ts:11779
 
-> **formData**(): `Promise`\<`FormData`\>
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3544
+### formData
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/formData)
+▸ **formData**(): `Promise`<`FormData`\>
 
 #### Returns
 
-`Promise`\<`FormData`\>
+`Promise`<`FormData`\>
 
 #### Inherited from
 
-[`FetchResponse`](FetchResponse.md).[`formData`](FetchResponse.md#formdata)
+[FetchResponse](FetchResponse.md).[formData](FetchResponse.md#formdata)
 
-***
+#### Defined in
 
-### json()
+node_modules/typescript/lib/lib.dom.d.ts:2591
 
-> **json**(): `Promise`\<`any`\>
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3546
+### json
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/json)
+▸ **json**(): `Promise`<`any`\>
 
 #### Returns
 
-`Promise`\<`any`\>
+`Promise`<`any`\>
 
 #### Inherited from
 
-[`FetchResponse`](FetchResponse.md).[`json`](FetchResponse.md#json)
+[FetchResponse](FetchResponse.md).[json](FetchResponse.md#json)
 
-***
+#### Defined in
 
-### text()
+node_modules/typescript/lib/lib.dom.d.ts:2592
 
-> **text**(): `Promise`\<`string`\>
+___
 
-Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3548
+### text
 
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/text)
+▸ **text**(): `Promise`<`string`\>
 
 #### Returns
 
-`Promise`\<`string`\>
+`Promise`<`string`\>
 
 #### Inherited from
 
-[`FetchResponse`](FetchResponse.md).[`text`](FetchResponse.md#text)
+[FetchResponse](FetchResponse.md).[text](FetchResponse.md#text)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2593