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

package/docs/interfaces/MessageServiceWorkerResult.md

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

package/docs/interfaces/ModernAppExtensionDefinition.md

@@ -0,0 +1,196 @@
+[@openmrs/esm-framework](../API.md) / ModernAppExtensionDefinition
+
+# Interface: ModernAppExtensionDefinition
+
+## Hierarchy
+
+- [`ExtensionComponentDefinition`](ExtensionComponentDefinition.md)
+
+  ↳ **`ModernAppExtensionDefinition`**
+
+## Table of contents
+
+### Properties
+
+- [appName](ModernAppExtensionDefinition.md#appname)
+- [id](ModernAppExtensionDefinition.md#id)
+- [meta](ModernAppExtensionDefinition.md#meta)
+- [offline](ModernAppExtensionDefinition.md#offline)
+- [online](ModernAppExtensionDefinition.md#online)
+- [order](ModernAppExtensionDefinition.md#order)
+- [privilege](ModernAppExtensionDefinition.md#privilege)
+- [resources](ModernAppExtensionDefinition.md#resources)
+- [slot](ModernAppExtensionDefinition.md#slot)
+- [slots](ModernAppExtensionDefinition.md#slots)
+
+### Methods
+
+- [load](ModernAppExtensionDefinition.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)
+
+___
+
+### id
+
+• **id**: `string`
+
+The ID of the extension to register.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:125](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L125)
+
+___
+
+### 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)
+
+___
+
+### 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)
+
+___
+
+### slot
+
+• `Optional` **slot**: `string`
+
+The slot of the extension to optionally attach to.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:129](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L129)
+
+___
+
+### slots
+
+• `Optional` **slots**: `string`[]
+
+The slots of the extension to optionally attach to.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:133](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L133)
+
+## 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/NavigateOptions.md

@@ -0,0 +1,19 @@
+[@openmrs/esm-framework](../API.md) / NavigateOptions
+
+# Interface: NavigateOptions
+
+## Table of contents
+
+### Properties
+
+- [to](NavigateOptions.md#to)
+
+## Properties
+
+### to
+
+• **to**: `string`
+
+#### Defined in
+
+[packages/framework/esm-config/src/navigation/navigate.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/navigation/navigate.ts#L10)

package/docs/interfaces/NavigationContext.md

@@ -0,0 +1,50 @@
+[@openmrs/esm-framework](../API.md) / NavigationContext
+
+# Interface: NavigationContext
+
+## Table of contents
+
+### Properties
+
+- [type](NavigationContext.md#type)
+
+### Methods
+
+- [handler](NavigationContext.md#handler)
+
+## Properties
+
+### type
+
+• **type**: [`NavigationContextType`](../API.md#navigationcontexttype)
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/contexts.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L6)
+
+## Methods
+
+### handler
+
+▸ **handler**<`T`\>(`link`, `state`): `boolean`
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | `any` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `link` | `string` |
+| `state` | `T` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/contexts.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L7)

package/docs/interfaces/NetworkRequestFailedEvent.md

@@ -0,0 +1,49 @@
+[@openmrs/esm-framework](../API.md) / NetworkRequestFailedEvent
+
+# Interface: NetworkRequestFailedEvent
+
+## Hierarchy
+
+- [`OmrsServiceWorkerEvent`](OmrsServiceWorkerEvent.md)<``"networkRequestFailed"``\>
+
+  ↳ **`NetworkRequestFailedEvent`**
+
+## Table of contents
+
+### Properties
+
+- [request](NetworkRequestFailedEvent.md#request)
+- [type](NetworkRequestFailedEvent.md#type)
+
+## Properties
+
+### request
+
+• **request**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `body` | `string` |
+| `headers` | `Record`<`string`, `string`\> |
+| `method` | `string` |
+| `url` | `string` |
+
+#### Defined in
+
+[packages/framework/esm-offline/src/service-worker-events.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-events.ts#L7)
+
+___
+
+### type
+
+• **type**: ``"networkRequestFailed"``
+
+#### Inherited from
+
+[OmrsServiceWorkerEvent](OmrsServiceWorkerEvent.md).[type](OmrsServiceWorkerEvent.md#type)
+
+#### 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/NewVisitPayload.md

@@ -0,0 +1,74 @@
+[@openmrs/esm-framework](../API.md) / NewVisitPayload
+
+# Interface: NewVisitPayload
+
+## Table of contents
+
+### Properties
+
+- [location](NewVisitPayload.md#location)
+- [patient](NewVisitPayload.md#patient)
+- [startDatetime](NewVisitPayload.md#startdatetime)
+- [stopDatetime](NewVisitPayload.md#stopdatetime)
+- [uuid](NewVisitPayload.md#uuid)
+- [visitType](NewVisitPayload.md#visittype)
+
+## Properties
+
+### location
+
+• **location**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L5)
+
+___
+
+### patient
+
+• `Optional` **patient**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L6)
+
+___
+
+### startDatetime
+
+• **startDatetime**: `Date`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L7)
+
+___
+
+### stopDatetime
+
+• `Optional` **stopDatetime**: `Date`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L9)
+
+___
+
+### uuid
+
+• `Optional` **uuid**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L4)
+
+___
+
+### visitType
+
+• **visitType**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L8)

package/docs/interfaces/OfflinePatientArgs.md

@@ -0,0 +1,34 @@
+[@openmrs/esm-framework](../API.md) / OfflinePatientArgs
+
+# Interface: OfflinePatientArgs
+
+## Table of contents
+
+### Properties
+
+- [patientUuid](OfflinePatientArgs.md#patientuuid)
+- [signal](OfflinePatientArgs.md#signal)
+
+## Properties
+
+### patientUuid
+
+• **patientUuid**: `string`
+
+The UUID of the patient that should be made available offline.
+
+#### Defined in
+
+[packages/framework/esm-offline/src/offline-patient-data.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L70)
+
+___
+
+### signal
+
+• **signal**: `AbortSignal`
+
+An {@link AbortSignal} which notifies about the cancellation of the operation.
+
+#### Defined in
+
+[packages/framework/esm-offline/src/offline-patient-data.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L74)

package/docs/interfaces/OfflinePatientDataSyncHandler.md

@@ -0,0 +1,52 @@
+[@openmrs/esm-framework](../API.md) / OfflinePatientDataSyncHandler
+
+# Interface: OfflinePatientDataSyncHandler
+
+## Table of contents
+
+### Properties
+
+- [displayName](OfflinePatientDataSyncHandler.md#displayname)
+
+### Methods
+
+- [onOfflinePatientAdded](OfflinePatientDataSyncHandler.md#onofflinepatientadded)
+
+## Properties
+
+### displayName
+
+• `Readonly` **displayName**: `string`
+
+A name of the handler registration which can be displayed to the user.
+This is ideally translated.
+
+#### Defined in
+
+[packages/framework/esm-offline/src/offline-patient-data.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L55)
+
+## Methods
+
+### onOfflinePatientAdded
+
+▸ **onOfflinePatientAdded**(`args`): `Promise`<`void`\>
+
+A function which is invoked when a patient is added to the app's offline patient cache.
+Signals to the handler that the patient's data must be made available offline.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `args` | [`OfflinePatientArgs`](OfflinePatientArgs.md) | Arguments which provide data about the patient to be made available offline. |
+
+#### Returns
+
+`Promise`<`void`\>
+
+A promise which should resolve if all data could be cached and reject when there was an issue
+  caching the data.
+
+#### Defined in
+
+[packages/framework/esm-offline/src/offline-patient-data.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L63)

package/docs/interfaces/OfflinePatientDataSyncState.md

@@ -0,0 +1,99 @@
+[@openmrs/esm-framework](../API.md) / OfflinePatientDataSyncState
+
+# Interface: OfflinePatientDataSyncState
+
+## Table of contents
+
+### Properties
+
+- [errors](OfflinePatientDataSyncState.md#errors)
+- [failedHandlers](OfflinePatientDataSyncState.md#failedhandlers)
+- [syncedHandlers](OfflinePatientDataSyncState.md#syncedhandlers)
+- [syncingHandlers](OfflinePatientDataSyncState.md#syncinghandlers)
+- [timestamp](OfflinePatientDataSyncState.md#timestamp)
+
+### Methods
+
+- [abort](OfflinePatientDataSyncState.md#abort)
+
+## Properties
+
+### errors
+
+• `Readonly` **errors**: `Record`<`string`, `string`\>
+
+A set of error messages associated with the identifers of the failed handlers.
+
+#### Defined in
+
+[packages/framework/esm-offline/src/offline-patient-data.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L41)
+
+___
+
+### failedHandlers
+
+• `Readonly` **failedHandlers**: `string`[]
+
+A list of the data sync handler registration identifiers which failed to synchronize the
+patient's data.
+
+#### Defined in
+
+[packages/framework/esm-offline/src/offline-patient-data.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L37)
+
+___
+
+### syncedHandlers
+
+• `Readonly` **syncedHandlers**: `string`[]
+
+A list of the data sync handler registration identifiers which successfully synchronized the
+patient's data.
+
+#### Defined in
+
+[packages/framework/esm-offline/src/offline-patient-data.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L32)
+
+___
+
+### syncingHandlers
+
+• `Readonly` **syncingHandlers**: `string`[]
+
+A list of the data sync handler registration identifiers which are still in the process
+of synchronizing the patient's data.
+
+#### Defined in
+
+[packages/framework/esm-offline/src/offline-patient-data.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L27)
+
+___
+
+### timestamp
+
+• `Readonly` **timestamp**: `Date`
+
+The time when this state snapshot was initially created.
+
+#### Defined in
+
+[packages/framework/esm-offline/src/offline-patient-data.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L22)
+
+## Methods
+
+### abort
+
+▸ **abort**(): `boolean`
+
+Aborts the process of downloading data.
+
+#### Returns
+
+`boolean`
+
+`true` if the cancellation could be triggered (that is, if there were any syncing handlers);
+  `false` if not.
+
+#### Defined in
+
+[packages/framework/esm-offline/src/offline-patient-data.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L47)

package/docs/interfaces/OfflinePatientDataSyncStore.md

@@ -0,0 +1,37 @@
+[@openmrs/esm-framework](../API.md) / OfflinePatientDataSyncStore
+
+# Interface: OfflinePatientDataSyncStore
+
+## Table of contents
+
+### Properties
+
+- [handlers](OfflinePatientDataSyncStore.md#handlers)
+- [offlinePatientDataSyncState](OfflinePatientDataSyncStore.md#offlinepatientdatasyncstate)
+
+## Properties
+
+### handlers
+
+• **handlers**: `Record`<`string`, [`OfflinePatientDataSyncHandler`](OfflinePatientDataSyncHandler.md)\>
+
+Holds the list of currently registered handlers which deal with patients that should be available offline.
+The key is a unique identifier which, once defined, should never change as it gives identity to
+the handler registration.
+
+#### Defined in
+
+[packages/framework/esm-offline/src/offline-patient-data.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L15)
+
+___
+
+### offlinePatientDataSyncState
+
+• **offlinePatientDataSyncState**: `Record`<`string`, [`OfflinePatientDataSyncState`](OfflinePatientDataSyncState.md)\>
+
+For each patient ID of the patients whose data is currently made available offline, provides
+the current data synchronizaton state.
+
+#### Defined in
+
+[packages/framework/esm-offline/src/offline-patient-data.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/offline-patient-data.ts#L9)

package/docs/interfaces/OfflineSynchronizationStore.md

@@ -0,0 +1,27 @@
+[@openmrs/esm-framework](../API.md) / OfflineSynchronizationStore
+
+# Interface: OfflineSynchronizationStore
+
+## Table of contents
+
+### Properties
+
+- [synchronization](OfflineSynchronizationStore.md#synchronization)
+
+## Properties
+
+### synchronization
+
+• `Optional` **synchronization**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `abortController` | `AbortController` |
+| `pendingCount` | `number` |
+| `totalCount` | `number` |
+
+#### Defined in
+
+[packages/framework/esm-offline/src/sync.ts:68](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L68)