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

package/docs/interfaces/LoggedInUser.md

@@ -1,133 +1,131 @@
-[@openmrs/esm-framework](../API.md) / LoggedInUser
+[O3 Framework](../API.md) / LoggedInUser
 
 # Interface: LoggedInUser
 
-## Indexable
-
-▪ [anythingElse: `string`]: `any`
+Defined in: [packages/framework/esm-api/src/types/user-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/user-resource.ts#L14)
 
-## Table of contents
-
-### Properties
+## Indexable
 
-- [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)
+\[`anythingElse`: `string`\]: `any`
 
 ## Properties
 
 ### allowedLocales
 
-• **allowedLocales**: `string`[]
+> **allowedLocales**: `string`[]
 
-#### Defined in
+Defined in: [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)
 
-[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)
-
-___
+***
 
 ### display
 
-• **display**: `string`
-
-#### Defined in
+> **display**: `string`
 
-[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)
+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)
 
-___
+***
 
 ### locale
 
-• **locale**: `string`
-
-#### Defined in
+> **locale**: `string`
 
-[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)
+Defined in: [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)
 
-___
+***
 
 ### person
 
-• **person**: [`Person`](Person.md)
+> **person**: [`Person`](Person.md)
 
-#### Defined in
+Defined in: [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)
 
-[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)
-
-___
+***
 
 ### privileges
 
-• **privileges**: [`Privilege`](Privilege.md)[]
-
-#### Defined in
+> **privileges**: [`Privilege`](Privilege.md)[]
 
-[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)
+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)
 
-___
+***
 
 ### retired
 
-• **retired**: `boolean`
-
-#### Defined in
+> **retired**: `boolean`
 
-[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)
+Defined in: [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)
 
-___
+***
 
 ### roles
 
-• **roles**: [`Role`](Role.md)[]
+> **roles**: [`Role`](Role.md)[]
 
-#### Defined in
+Defined in: [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)
 
-[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)
-
-___
+***
 
 ### systemId
 
-• **systemId**: `string`
+> **systemId**: `string`
+
+Defined in: [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)
 
-#### Defined in
+***
 
-[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)
+### username
 
-___
+> **username**: `string`
+
+Defined in: [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)
+
+***
 
 ### userProperties
 
-• **userProperties**: ``null`` \| { `[key: string]`: `string` \| `undefined`; `defaultLocation?`: `string` ; `patientsVisited?`: `string` ; `starredPatientLists?`: `string`  }
+> **userProperties**: `null` \| \{[`key`: `string`]: `undefined` \| `string`; `defaultLocation?`: `string`; `patientsVisited?`: `string`; `starredPatientLists?`: `string`; \}
 
-#### Defined in
+Defined in: [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)
 
-[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)
+#### Type declaration
 
-___
+`null`
 
-### username
+\{[`key`: `string`]: `undefined` \| `string`; `defaultLocation?`: `string`; `patientsVisited?`: `string`; `starredPatientLists?`: `string`; \}
 
-• **username**: `string`
+#### Index Signature
 
-#### Defined in
+\[`key`: `string`\]: `undefined` \| `string`
 
-[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)
+#### defaultLocation?
 
-___
+> `optional` **defaultLocation**: `string`
 
-### uuid
+The UUID of the location the user has set preference to use for next logins
+
+#### patientsVisited?
+
+> `optional` **patientsVisited**: `string`
 
-• **uuid**: `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(',')`
+
+#### starredPatientLists?
+
+> `optional` **starredPatientLists**: `string`
+
+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(',')`
+
+***
+
+### uuid
 
-#### Defined in
+> **uuid**: `string`
 
-[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)
+Defined in: [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,281 +1,273 @@
-[@openmrs/esm-framework](../API.md) / LoggedInUserFetchResponse
+[O3 Framework](../API.md) / LoggedInUserFetchResponse
 
 # Interface: LoggedInUserFetchResponse
 
-## Hierarchy
+Defined in: [packages/framework/esm-api/src/types/fetch.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/fetch.ts#L7)
 
-- [`FetchResponse`](FetchResponse.md)
-
-  ↳ **`LoggedInUserFetchResponse`**
-
-## Table of contents
-
-### Properties
-
-- [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)
+## Extends
 
-### Methods
-
-- [arrayBuffer](LoggedInUserFetchResponse.md#arraybuffer)
-- [blob](LoggedInUserFetchResponse.md#blob)
-- [clone](LoggedInUserFetchResponse.md#clone)
-- [formData](LoggedInUserFetchResponse.md#formdata)
-- [json](LoggedInUserFetchResponse.md#json)
-- [text](LoggedInUserFetchResponse.md#text)
+- [`FetchResponse`](FetchResponse.md)
 
 ## Properties
 
 ### body
 
-• `Readonly` **body**: ``null`` \| `ReadableStream`<`Uint8Array`\>
+> `readonly` **body**: `null` \| `ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
-#### Inherited from
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3534
 
-[FetchResponse](FetchResponse.md).[body](FetchResponse.md#body)
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body)
 
-#### Defined in
+#### Inherited from
 
-node_modules/typescript/lib/lib.dom.d.ts:2587
+[`FetchResponse`](FetchResponse.md).[`body`](FetchResponse.md#body)
 
-___
+***
 
 ### bodyUsed
 
-• `Readonly` **bodyUsed**: `boolean`
+> `readonly` **bodyUsed**: `boolean`
 
-#### Inherited from
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3536
 
-[FetchResponse](FetchResponse.md).[bodyUsed](FetchResponse.md#bodyused)
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed)
 
-#### Defined in
+#### Inherited from
 
-node_modules/typescript/lib/lib.dom.d.ts:2588
+[`FetchResponse`](FetchResponse.md).[`bodyUsed`](FetchResponse.md#bodyused)
 
-___
+***
 
 ### data
 
-• **data**: [`Session`](Session.md)
+> **data**: [`Session`](Session.md)
+
+Defined in: [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)
 
 #### Overrides
 
-[FetchResponse](FetchResponse.md).[data](FetchResponse.md#data)
+[`FetchResponse`](FetchResponse.md).[`data`](FetchResponse.md#data)
 
-#### Defined in
+***
 
-[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)
+### headers
 
-___
+> `readonly` **headers**: `Headers`
 
-### headers
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19881
 
-• `Readonly` **headers**: `Headers`
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/headers)
 
 #### Inherited from
 
-[FetchResponse](FetchResponse.md).[headers](FetchResponse.md#headers)
+[`FetchResponse`](FetchResponse.md).[`headers`](FetchResponse.md#headers)
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:11772
+### ok
 
-___
+> `readonly` **ok**: `boolean`
 
-### ok
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19883
 
-• `Readonly` **ok**: `boolean`
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/ok)
 
 #### Inherited from
 
-[FetchResponse](FetchResponse.md).[ok](FetchResponse.md#ok)
+[`FetchResponse`](FetchResponse.md).[`ok`](FetchResponse.md#ok)
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:11773
+### redirected
 
-___
+> `readonly` **redirected**: `boolean`
 
-### redirected
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19885
 
-• `Readonly` **redirected**: `boolean`
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/redirected)
 
 #### Inherited from
 
-[FetchResponse](FetchResponse.md).[redirected](FetchResponse.md#redirected)
+[`FetchResponse`](FetchResponse.md).[`redirected`](FetchResponse.md#redirected)
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:11774
+### status
 
-___
+> `readonly` **status**: `number`
 
-### status
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19887
 
-• `Readonly` **status**: `number`
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/status)
 
 #### Inherited from
 
-[FetchResponse](FetchResponse.md).[status](FetchResponse.md#status)
+[`FetchResponse`](FetchResponse.md).[`status`](FetchResponse.md#status)
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:11775
+### statusText
 
-___
+> `readonly` **statusText**: `string`
 
-### statusText
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19889
 
-• `Readonly` **statusText**: `string`
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/statusText)
 
 #### Inherited from
 
-[FetchResponse](FetchResponse.md).[statusText](FetchResponse.md#statustext)
+[`FetchResponse`](FetchResponse.md).[`statusText`](FetchResponse.md#statustext)
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:11776
+### type
 
-___
+> `readonly` **type**: `ResponseType`
 
-### type
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19891
 
-• `Readonly` **type**: `ResponseType`
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/type)
 
 #### Inherited from
 
-[FetchResponse](FetchResponse.md).[type](FetchResponse.md#type)
+[`FetchResponse`](FetchResponse.md).[`type`](FetchResponse.md#type)
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:11777
+### url
 
-___
+> `readonly` **url**: `string`
 
-### url
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19893
 
-• `Readonly` **url**: `string`
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/url)
 
 #### Inherited from
 
-[FetchResponse](FetchResponse.md).[url](FetchResponse.md#url)
+[`FetchResponse`](FetchResponse.md).[`url`](FetchResponse.md#url)
 
-#### Defined in
+## Methods
 
-node_modules/typescript/lib/lib.dom.d.ts:11778
+### arrayBuffer()
 
-## Methods
+> **arrayBuffer**(): `Promise`\<`ArrayBuffer`\>
 
-### arrayBuffer
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3538
 
-▸ **arrayBuffer**(): `Promise`<`ArrayBuffer`\>
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer)
 
 #### Returns
 
-`Promise`<`ArrayBuffer`\>
+`Promise`\<`ArrayBuffer`\>
 
 #### Inherited from
 
-[FetchResponse](FetchResponse.md).[arrayBuffer](FetchResponse.md#arraybuffer)
+[`FetchResponse`](FetchResponse.md).[`arrayBuffer`](FetchResponse.md#arraybuffer)
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:2589
+### blob()
 
-___
+> **blob**(): `Promise`\<`Blob`\>
 
-### blob
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3540
 
-▸ **blob**(): `Promise`<`Blob`\>
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob)
 
 #### Returns
 
-`Promise`<`Blob`\>
+`Promise`\<`Blob`\>
 
 #### Inherited from
 
-[FetchResponse](FetchResponse.md).[blob](FetchResponse.md#blob)
+[`FetchResponse`](FetchResponse.md).[`blob`](FetchResponse.md#blob)
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:2590
+### bytes()
 
-___
+> **bytes**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
-### clone
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3542
 
-▸ **clone**(): `Response`
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
 
 #### Returns
 
-`Response`
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
 #### Inherited from
 
-[FetchResponse](FetchResponse.md).[clone](FetchResponse.md#clone)
+[`FetchResponse`](FetchResponse.md).[`bytes`](FetchResponse.md#bytes)
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:11779
+### clone()
 
-___
+> **clone**(): `Response`
 
-### formData
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:19895
 
-▸ **formData**(): `Promise`<`FormData`\>
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response/clone)
 
 #### Returns
 
-`Promise`<`FormData`\>
+`Response`
 
 #### Inherited from
 
-[FetchResponse](FetchResponse.md).[formData](FetchResponse.md#formdata)
+[`FetchResponse`](FetchResponse.md).[`clone`](FetchResponse.md#clone)
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:2591
+### formData()
 
-___
+> **formData**(): `Promise`\<`FormData`\>
 
-### json
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3544
 
-▸ **json**(): `Promise`<`any`\>
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/formData)
 
 #### Returns
 
-`Promise`<`any`\>
+`Promise`\<`FormData`\>
 
 #### Inherited from
 
-[FetchResponse](FetchResponse.md).[json](FetchResponse.md#json)
+[`FetchResponse`](FetchResponse.md).[`formData`](FetchResponse.md#formdata)
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.dom.d.ts:2592
+### json()
 
-___
+> **json**(): `Promise`\<`any`\>
 
-### text
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3546
 
-▸ **text**(): `Promise`<`string`\>
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/json)
 
 #### Returns
 
-`Promise`<`string`\>
+`Promise`\<`any`\>
 
 #### Inherited from
 
-[FetchResponse](FetchResponse.md).[text](FetchResponse.md#text)
+[`FetchResponse`](FetchResponse.md).[`json`](FetchResponse.md#json)
 
-#### Defined in
+***
+
+### text()
+
+> **text**(): `Promise`\<`string`\>
+
+Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3548
+
+[MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/text)
+
+#### Returns
+
+`Promise`\<`string`\>
+
+#### Inherited from
 
-node_modules/typescript/lib/lib.dom.d.ts:2593
+[`FetchResponse`](FetchResponse.md).[`text`](FetchResponse.md#text)

package/docs/interfaces/MessageServiceWorkerResult.md

@@ -1,47 +1,35 @@
-[@openmrs/esm-framework](../API.md) / MessageServiceWorkerResult
+[O3 Framework](../API.md) / MessageServiceWorkerResult
 
-# Interface: MessageServiceWorkerResult<T\>
+# Interface: MessageServiceWorkerResult\<T\>
 
-## Type parameters
+Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L47)
 
-| Name |
-| :------ |
-| `T` |
+## Type Parameters
 
-## Table of contents
+### T
 
-### Offline Properties
+`T`
 
-- [error](MessageServiceWorkerResult.md#error)
-- [result](MessageServiceWorkerResult.md#result)
-- [success](MessageServiceWorkerResult.md#success)
+## Properties
 
-## Offline Properties
+### error?
 
-### error
+> `optional` **error**: `string`
 
-• `Optional` **error**: `string`
+Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L50)
 
-#### Defined in
+***
 
-[packages/framework/esm-offline/src/service-worker-messaging.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L49)
+### result?
 
-___
+> `optional` **result**: `T`
 
-### result
+Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L49)
 
-• `Optional` **result**: `T`
-
-#### Defined in
-
-[packages/framework/esm-offline/src/service-worker-messaging.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L48)
-
-___
+***
 
 ### success
 
-• **success**: `boolean`
-
-#### Defined in
+> **success**: `boolean`
 
-[packages/framework/esm-offline/src/service-worker-messaging.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L47)
+Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L48)