@openmrs/esm-framework 3.1.10-pre.92 → 3.1.11-pre.597

package/docs/interfaces/LegacyAppExtensionDefinition.md

@@ -0,0 +1,170 @@
+[@openmrs/esm-framework](../API.md) / LegacyAppExtensionDefinition
+
+# Interface: LegacyAppExtensionDefinition
+
+## Hierarchy
+
+- [`ExtensionComponentDefinition`](ExtensionComponentDefinition.md)
+
+  ↳ **`LegacyAppExtensionDefinition`**
+
+## Table of contents
+
+### Properties
+
+- [appName](LegacyAppExtensionDefinition.md#appname)
+- [meta](LegacyAppExtensionDefinition.md#meta)
+- [name](LegacyAppExtensionDefinition.md#name)
+- [offline](LegacyAppExtensionDefinition.md#offline)
+- [online](LegacyAppExtensionDefinition.md#online)
+- [order](LegacyAppExtensionDefinition.md#order)
+- [privilege](LegacyAppExtensionDefinition.md#privilege)
+- [resources](LegacyAppExtensionDefinition.md#resources)
+
+### Methods
+
+- [load](LegacyAppExtensionDefinition.md#load)
+
+## Properties
+
+### appName
+
+• **appName**: `string`
+
+The module/app that defines the component
+
+#### Inherited from
+
+[ExtensionComponentDefinition](ExtensionComponentDefinition.md).[appName](ExtensionComponentDefinition.md#appname)
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L86)
+
+___
+
+### meta
+
+• `Optional` **meta**: `Record`<`string`, `any`\>
+
+The meta data used for reflection by other components.
+
+#### Inherited from
+
+[ExtensionComponentDefinition](ExtensionComponentDefinition.md).[meta](ExtensionComponentDefinition.md#meta)
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:113](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L113)
+
+___
+
+### name
+
+• **name**: `string`
+
+The ID of the extension to register.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:141](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L141)
+
+___
+
+### offline
+
+• `Optional` **offline**: `boolean` \| `object`
+
+Defines the offline support / properties of the component.
+
+#### Inherited from
+
+[ExtensionComponentDefinition](ExtensionComponentDefinition.md).[offline](ExtensionComponentDefinition.md#offline)
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:98](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L98)
+
+___
+
+### online
+
+• `Optional` **online**: `boolean` \| `object`
+
+Defines the online support / properties of the component.
+
+#### Inherited from
+
+[ExtensionComponentDefinition](ExtensionComponentDefinition.md).[online](ExtensionComponentDefinition.md#online)
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:94](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L94)
+
+___
+
+### order
+
+• `Optional` **order**: `number`
+
+Specifies a preferred order number, if any.
+
+#### Inherited from
+
+[ExtensionComponentDefinition](ExtensionComponentDefinition.md).[order](ExtensionComponentDefinition.md#order)
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:117](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L117)
+
+___
+
+### privilege
+
+• `Optional` **privilege**: `string`
+
+Defines the access privilege required for this component, if any.
+
+#### Inherited from
+
+[ExtensionComponentDefinition](ExtensionComponentDefinition.md).[privilege](ExtensionComponentDefinition.md#privilege)
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:102](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L102)
+
+___
+
+### resources
+
+• `Optional` **resources**: `Record`<`string`, [`ResourceLoader`](ResourceLoader.md)<`any`\>\>
+
+Defines resources that are loaded when the component should mount.
+
+#### Inherited from
+
+[ExtensionComponentDefinition](ExtensionComponentDefinition.md).[resources](ExtensionComponentDefinition.md#resources)
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:106](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L106)
+
+## Methods
+
+### load
+
+▸ **load**(): `Promise`<`any`\>
+
+Defines a function to use for actually loading the component's lifecycle.
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Inherited from
+
+[ExtensionComponentDefinition](ExtensionComponentDefinition.md).[load](ExtensionComponentDefinition.md#load)
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L90)

package/docs/interfaces/Lifecycle.md

@@ -0,0 +1,68 @@
+[@openmrs/esm-framework](../API.md) / Lifecycle
+
+# Interface: Lifecycle
+
+## Table of contents
+
+### Methods
+
+- [bootstrap](Lifecycle.md#bootstrap)
+- [mount](Lifecycle.md#mount)
+- [unmount](Lifecycle.md#unmount)
+- [update](Lifecycle.md#update)
+
+## Methods
+
+### bootstrap
+
+▸ **bootstrap**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/render.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L8)
+
+___
+
+### mount
+
+▸ **mount**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/render.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L9)
+
+___
+
+### unmount
+
+▸ **unmount**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/render.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L10)
+
+___
+
+### update
+
+▸ `Optional` **update**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/render.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L11)

package/docs/interfaces/Location.md

@@ -0,0 +1,41 @@
+[@openmrs/esm-framework](../API.md) / Location
+
+# Interface: Location
+
+## Table of contents
+
+### Properties
+
+- [display](Location.md#display)
+- [name](Location.md#name)
+- [uuid](Location.md#uuid)
+
+## Properties
+
+### display
+
+• `Optional` **display**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L29)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L30)
+
+___
+
+### uuid
+
+• **uuid**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L28)

package/docs/interfaces/LoggedInUser.md

@@ -0,0 +1,133 @@
+[@openmrs/esm-framework](../API.md) / LoggedInUser
+
+# Interface: LoggedInUser
+
+## Indexable
+
+▪ [anythingElse: `string`]: `any`
+
+## Table of contents
+
+### Properties
+
+- [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)
+
+## Properties
+
+### allowedLocales
+
+• **allowedLocales**: `string`[]
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L24)
+
+___
+
+### display
+
+• **display**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L15)
+
+___
+
+### locale
+
+• **locale**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L23)
+
+___
+
+### person
+
+• **person**: [`Person`](Person.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L19)
+
+___
+
+### privileges
+
+• **privileges**: [`Privilege`](Privilege.md)[]
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L20)
+
+___
+
+### retired
+
+• **retired**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L22)
+
+___
+
+### roles
+
+• **roles**: [`Role`](Role.md)[]
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L21)
+
+___
+
+### systemId
+
+• **systemId**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L17)
+
+___
+
+### userProperties
+
+• **userProperties**: `any`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L18)
+
+___
+
+### username
+
+• **username**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L16)
+
+___
+
+### uuid
+
+• **uuid**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L14)

package/docs/interfaces/LoggedInUserFetchResponse.md

@@ -0,0 +1,281 @@
+[@openmrs/esm-framework](../API.md) / LoggedInUserFetchResponse
+
+# Interface: LoggedInUserFetchResponse
+
+## Hierarchy
+
+- [`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)
+
+### 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)
+
+## Properties
+
+### body
+
+• `Readonly` **body**: ``null`` \| `ReadableStream`<`Uint8Array`\>
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[body](FetchResponse.md#body)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2444
+
+___
+
+### bodyUsed
+
+• `Readonly` **bodyUsed**: `boolean`
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[bodyUsed](FetchResponse.md#bodyused)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2445
+
+___
+
+### data
+
+• **data**: [`LoggedInUserData`](../API.md#loggedinuserdata)
+
+#### Overrides
+
+[FetchResponse](FetchResponse.md).[data](FetchResponse.md#data)
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/fetch.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/fetch.ts#L12)
+
+___
+
+### headers
+
+• `Readonly` **headers**: `Headers`
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[headers](FetchResponse.md#headers)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12143
+
+___
+
+### ok
+
+• `Readonly` **ok**: `boolean`
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[ok](FetchResponse.md#ok)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12144
+
+___
+
+### redirected
+
+• `Readonly` **redirected**: `boolean`
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[redirected](FetchResponse.md#redirected)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12145
+
+___
+
+### status
+
+• `Readonly` **status**: `number`
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[status](FetchResponse.md#status)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12146
+
+___
+
+### statusText
+
+• `Readonly` **statusText**: `string`
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[statusText](FetchResponse.md#statustext)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12147
+
+___
+
+### type
+
+• `Readonly` **type**: `ResponseType`
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[type](FetchResponse.md#type)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12148
+
+___
+
+### url
+
+• `Readonly` **url**: `string`
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[url](FetchResponse.md#url)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12149
+
+## Methods
+
+### arrayBuffer
+
+▸ **arrayBuffer**(): `Promise`<`ArrayBuffer`\>
+
+#### Returns
+
+`Promise`<`ArrayBuffer`\>
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[arrayBuffer](FetchResponse.md#arraybuffer)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2446
+
+___
+
+### blob
+
+▸ **blob**(): `Promise`<`Blob`\>
+
+#### Returns
+
+`Promise`<`Blob`\>
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[blob](FetchResponse.md#blob)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2447
+
+___
+
+### clone
+
+▸ **clone**(): `Response`
+
+#### Returns
+
+`Response`
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[clone](FetchResponse.md#clone)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12150
+
+___
+
+### formData
+
+▸ **formData**(): `Promise`<`FormData`\>
+
+#### Returns
+
+`Promise`<`FormData`\>
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[formData](FetchResponse.md#formdata)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2448
+
+___
+
+### json
+
+▸ **json**(): `Promise`<`any`\>
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[json](FetchResponse.md#json)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2449
+
+___
+
+### text
+
+▸ **text**(): `Promise`<`string`\>
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Inherited from
+
+[FetchResponse](FetchResponse.md).[text](FetchResponse.md#text)
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2450