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

package/docs/interfaces/OmrsServiceWorkerEvent.md

@@ -0,0 +1,31 @@
+[@openmrs/esm-framework](../API.md) / OmrsServiceWorkerEvent
+
+# Interface: OmrsServiceWorkerEvent<TypeIdentifier\>
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TypeIdentifier` | extends `string` |
+
+## Hierarchy
+
+- **`OmrsServiceWorkerEvent`**
+
+  ↳ [`NetworkRequestFailedEvent`](NetworkRequestFailedEvent.md)
+
+## Table of contents
+
+### Properties
+
+- [type](OmrsServiceWorkerEvent.md#type)
+
+## Properties
+
+### type
+
+• **type**: `TypeIdentifier`
+
+#### Defined in
+
+[packages/framework/esm-offline/src/service-worker-events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-events.ts#L2)

package/docs/interfaces/OmrsServiceWorkerMessage.md

@@ -0,0 +1,35 @@
+[@openmrs/esm-framework](../API.md) / OmrsServiceWorkerMessage
+
+# Interface: OmrsServiceWorkerMessage<MessageTypeTypeIdentifier\>
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `MessageTypeTypeIdentifier` | extends `string` |
+
+## Hierarchy
+
+- **`OmrsServiceWorkerMessage`**
+
+  ↳ [`OnImportMapChangedMessage`](OnImportMapChangedMessage.md)
+
+  ↳ [`ClearDynamicRoutesMessage`](ClearDynamicRoutesMessage.md)
+
+  ↳ [`RegisterDynamicRouteMessage`](RegisterDynamicRouteMessage.md)
+
+## Table of contents
+
+### Properties
+
+- [type](OmrsServiceWorkerMessage.md#type)
+
+## Properties
+
+### type
+
+• **type**: `MessageTypeTypeIdentifier`
+
+#### Defined in
+
+[packages/framework/esm-offline/src/service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)

package/docs/interfaces/OnImportMapChangedMessage.md

@@ -0,0 +1,40 @@
+[@openmrs/esm-framework](../API.md) / OnImportMapChangedMessage
+
+# Interface: OnImportMapChangedMessage
+
+## Hierarchy
+
+- [`OmrsServiceWorkerMessage`](OmrsServiceWorkerMessage.md)<``"onImportMapChanged"``\>
+
+  ↳ **`OnImportMapChangedMessage`**
+
+## Table of contents
+
+### Properties
+
+- [importMap](OnImportMapChangedMessage.md#importmap)
+- [type](OnImportMapChangedMessage.md#type)
+
+## Properties
+
+### importMap
+
+• **importMap**: [`ImportMap`](ImportMap.md)
+
+#### Defined in
+
+[packages/framework/esm-offline/src/service-worker-messaging.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L31)
+
+___
+
+### type
+
+• **type**: ``"onImportMapChanged"``
+
+#### Inherited from
+
+[OmrsServiceWorkerMessage](OmrsServiceWorkerMessage.md).[type](OmrsServiceWorkerMessage.md#type)
+
+#### Defined in
+
+[packages/framework/esm-offline/src/service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)

package/docs/interfaces/OnlyThePatient.md

@@ -0,0 +1,29 @@
+[@openmrs/esm-framework](../API.md) / OnlyThePatient
+
+# Interface: OnlyThePatient
+
+## Hierarchy
+
+- [`CurrentPatientOptions`](CurrentPatientOptions.md)
+
+  ↳ **`OnlyThePatient`**
+
+## Table of contents
+
+### Properties
+
+- [includeConfig](OnlyThePatient.md#includeconfig)
+
+## Properties
+
+### includeConfig
+
+• **includeConfig**: ``false``
+
+#### Overrides
+
+[CurrentPatientOptions](CurrentPatientOptions.md).[includeConfig](CurrentPatientOptions.md#includeconfig)
+
+#### Defined in
+
+[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L15)

package/docs/interfaces/OpenmrsReactComponentProps.md

@@ -0,0 +1,19 @@
+[@openmrs/esm-framework](../API.md) / OpenmrsReactComponentProps
+
+# Interface: OpenmrsReactComponentProps
+
+## Table of contents
+
+### Properties
+
+- [\_extensionContext](OpenmrsReactComponentProps.md#_extensioncontext)
+
+## Properties
+
+### \_extensionContext
+
+• `Optional` **\_extensionContext**: [`ExtensionData`](ExtensionData.md)
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:62](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L62)

package/docs/interfaces/OpenmrsReactComponentState.md

@@ -0,0 +1,41 @@
+[@openmrs/esm-framework](../API.md) / OpenmrsReactComponentState
+
+# Interface: OpenmrsReactComponentState
+
+## Table of contents
+
+### Properties
+
+- [caughtError](OpenmrsReactComponentState.md#caughterror)
+- [caughtErrorInfo](OpenmrsReactComponentState.md#caughterrorinfo)
+- [config](OpenmrsReactComponentState.md#config)
+
+## Properties
+
+### caughtError
+
+• **caughtError**: `any`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:66](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L66)
+
+___
+
+### caughtErrorInfo
+
+• **caughtErrorInfo**: `any`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:67](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L67)
+
+___
+
+### config
+
+• **config**: [`ComponentConfig`](ComponentConfig.md)
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:68](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L68)

package/docs/interfaces/OpenmrsResource.md

@@ -0,0 +1,34 @@
+[@openmrs/esm-framework](../API.md) / OpenmrsResource
+
+# Interface: OpenmrsResource
+
+## Indexable
+
+▪ [anythingElse: `string`]: `any`
+
+## Table of contents
+
+### Properties
+
+- [display](OpenmrsResource.md#display)
+- [uuid](OpenmrsResource.md#uuid)
+
+## Properties
+
+### display
+
+• `Optional` **display**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L3)
+
+___
+
+### uuid
+
+• **uuid**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L2)

package/docs/interfaces/PageDefinition.md

@@ -0,0 +1,149 @@
+[@openmrs/esm-framework](../API.md) / PageDefinition
+
+# Interface: PageDefinition
+
+## Hierarchy
+
+- [`ComponentDefinition`](ComponentDefinition.md)
+
+  ↳ **`PageDefinition`**
+
+## Table of contents
+
+### Properties
+
+- [appName](PageDefinition.md#appname)
+- [offline](PageDefinition.md#offline)
+- [online](PageDefinition.md#online)
+- [order](PageDefinition.md#order)
+- [privilege](PageDefinition.md#privilege)
+- [resources](PageDefinition.md#resources)
+- [route](PageDefinition.md#route)
+
+### Methods
+
+- [load](PageDefinition.md#load)
+
+## Properties
+
+### appName
+
+• **appName**: `string`
+
+The module/app that defines the component
+
+#### Inherited from
+
+[ComponentDefinition](ComponentDefinition.md).[appName](ComponentDefinition.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)
+
+___
+
+### offline
+
+• `Optional` **offline**: `boolean` \| `object`
+
+Defines the offline support / properties of the component.
+
+#### Inherited from
+
+[ComponentDefinition](ComponentDefinition.md).[offline](ComponentDefinition.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
+
+[ComponentDefinition](ComponentDefinition.md).[online](ComponentDefinition.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
+
+• **order**: `number`
+
+The order in which to load the page. This determines DOM order.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:155](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L155)
+
+___
+
+### privilege
+
+• `Optional` **privilege**: `string`
+
+Defines the access privilege required for this component, if any.
+
+#### Inherited from
+
+[ComponentDefinition](ComponentDefinition.md).[privilege](ComponentDefinition.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
+
+[ComponentDefinition](ComponentDefinition.md).[resources](ComponentDefinition.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)
+
+___
+
+### route
+
+• **route**: `string`
+
+The route of the page.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:151](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L151)
+
+## Methods
+
+### load
+
+▸ **load**(): `Promise`<`any`\>
+
+Defines a function to use for actually loading the component's lifecycle.
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Inherited from
+
+[ComponentDefinition](ComponentDefinition.md).[load](ComponentDefinition.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/PatientWithFullResponse.md

@@ -0,0 +1,29 @@
+[@openmrs/esm-framework](../API.md) / PatientWithFullResponse
+
+# Interface: PatientWithFullResponse
+
+## Hierarchy
+
+- [`CurrentPatientOptions`](CurrentPatientOptions.md)
+
+  ↳ **`PatientWithFullResponse`**
+
+## Table of contents
+
+### Properties
+
+- [includeConfig](PatientWithFullResponse.md#includeconfig)
+
+## Properties
+
+### includeConfig
+
+• **includeConfig**: ``true``
+
+#### Overrides
+
+[CurrentPatientOptions](CurrentPatientOptions.md).[includeConfig](CurrentPatientOptions.md#includeconfig)
+
+#### Defined in
+
+[packages/framework/esm-api/src/shared-api-objects/current-patient.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/current-patient.ts#L11)

package/docs/interfaces/Person.md

@@ -0,0 +1,41 @@
+[@openmrs/esm-framework](../API.md) / Person
+
+# Interface: Person
+
+## Table of contents
+
+### Properties
+
+- [display](Person.md#display)
+- [links](Person.md#links)
+- [uuid](Person.md#uuid)
+
+## Properties
+
+### display
+
+• **display**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L43)
+
+___
+
+### links
+
+• **links**: `any`[]
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:44](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L44)
+
+___
+
+### uuid
+
+• **uuid**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L42)

package/docs/interfaces/PrecacheStaticDependenciesEvent.md

@@ -0,0 +1,3 @@
+[@openmrs/esm-framework](../API.md) / PrecacheStaticDependenciesEvent
+
+# Interface: PrecacheStaticDependenciesEvent

package/docs/interfaces/Privilege.md

@@ -0,0 +1,41 @@
+[@openmrs/esm-framework](../API.md) / Privilege
+
+# Interface: Privilege
+
+## Table of contents
+
+### Properties
+
+- [display](Privilege.md#display)
+- [links](Privilege.md#links)
+- [uuid](Privilege.md#uuid)
+
+## Properties
+
+### display
+
+• **display**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L49)
+
+___
+
+### links
+
+• **links**: `any`[]
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L50)
+
+___
+
+### uuid
+
+• **uuid**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L48)

package/docs/interfaces/QueueItemDescriptor.md

@@ -0,0 +1,52 @@
+[@openmrs/esm-framework](../API.md) / QueueItemDescriptor
+
+# Interface: QueueItemDescriptor
+
+## Table of contents
+
+### Properties
+
+- [dependencies](QueueItemDescriptor.md#dependencies)
+- [displayName](QueueItemDescriptor.md#displayname)
+- [id](QueueItemDescriptor.md#id)
+- [patientUuid](QueueItemDescriptor.md#patientuuid)
+
+## Properties
+
+### dependencies
+
+• `Optional` **dependencies**: { `id`: `string` ; `type`: `string`  }[]
+
+#### Defined in
+
+[packages/framework/esm-offline/src/sync.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L20)
+
+___
+
+### displayName
+
+• `Optional` **displayName**: `string`
+
+#### Defined in
+
+[packages/framework/esm-offline/src/sync.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L25)
+
+___
+
+### id
+
+• `Optional` **id**: `string`
+
+#### Defined in
+
+[packages/framework/esm-offline/src/sync.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L19)
+
+___
+
+### patientUuid
+
+• `Optional` **patientUuid**: `string`
+
+#### Defined in
+
+[packages/framework/esm-offline/src/sync.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L24)

package/docs/interfaces/RegisterDynamicRouteMessage.md

@@ -0,0 +1,51 @@
+[@openmrs/esm-framework](../API.md) / RegisterDynamicRouteMessage
+
+# Interface: RegisterDynamicRouteMessage
+
+## Hierarchy
+
+- [`OmrsServiceWorkerMessage`](OmrsServiceWorkerMessage.md)<``"registerDynamicRoute"``\>
+
+  ↳ **`RegisterDynamicRouteMessage`**
+
+## Table of contents
+
+### Properties
+
+- [pattern](RegisterDynamicRouteMessage.md#pattern)
+- [type](RegisterDynamicRouteMessage.md#type)
+- [url](RegisterDynamicRouteMessage.md#url)
+
+## Properties
+
+### pattern
+
+• `Optional` **pattern**: `string`
+
+#### Defined in
+
+[packages/framework/esm-offline/src/service-worker-messaging.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L39)
+
+___
+
+### type
+
+• **type**: ``"registerDynamicRoute"``
+
+#### Inherited from
+
+[OmrsServiceWorkerMessage](OmrsServiceWorkerMessage.md).[type](OmrsServiceWorkerMessage.md#type)
+
+#### Defined in
+
+[packages/framework/esm-offline/src/service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
+
+___
+
+### url
+
+• `Optional` **url**: `string`
+
+#### Defined in
+
+[packages/framework/esm-offline/src/service-worker-messaging.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L40)

package/docs/interfaces/ResourceLoader.md

@@ -0,0 +1,23 @@
+[@openmrs/esm-framework](../API.md) / ResourceLoader
+
+# Interface: ResourceLoader<T\>
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | `any` |
+
+## Callable
+
+### ResourceLoader
+
+▸ **ResourceLoader**(): `Promise`<`T`\>
+
+#### Returns
+
+`Promise`<`T`\>
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L79)