@openmrs/esm-framework 10.0.1-pre.5539 → 10.0.1-pre.5545

package/docs/functions/queueSynchronizationItem.md

@@ -1,39 +0,0 @@
-[O3 Framework](../API.md) / queueSynchronizationItem
-
-# Function: queueSynchronizationItem()
-
-> **queueSynchronizationItem**\<`T`\>(`type`, `content`, `descriptor?`): `Promise`\<`number`\>
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:261](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L261)
-
-Enqueues a new item in the sync queue and associates the item with the currently signed in user.
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### type
-
-`string`
-
-The identifying type of the synchronization item.
-
-### content
-
-`T`
-
-The actual data to be synchronized.
-
-### descriptor?
-
-[`QueueItemDescriptor`](../interfaces/QueueItemDescriptor.md)
-
-An optional descriptor providing additional metadata about the sync item.
-
-## Returns
-
-`Promise`\<`number`\>

package/docs/functions/registerOfflinePatientHandler.md

@@ -1,25 +0,0 @@
-[O3 Framework](../API.md) / registerOfflinePatientHandler
-
-# Function: ~~registerOfflinePatientHandler()~~
-
-> **registerOfflinePatientHandler**(`identifier`, `handler`): `void`
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L45)
-
-## Parameters
-
-### identifier
-
-`string`
-
-### handler
-
-[`OfflinePatientDataSyncHandler`](../interfaces/OfflinePatientDataSyncHandler.md)
-
-## Returns
-
-`void`
-
-## Deprecated
-
-Will be removed once all modules have been migrated to the new dynamic offline data API.

package/docs/functions/removeDynamicOfflineData.md

@@ -1,28 +0,0 @@
-[O3 Framework](../API.md) / removeDynamicOfflineData
-
-# Function: removeDynamicOfflineData()
-
-> **removeDynamicOfflineData**(`type`, `identifier`): `Promise`\<`void`\>
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:201](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L201)
-
-Declares that dynamic offline data of the given [type](#removedynamicofflinedata) with the given [identifier](#removedynamicofflinedata)
-no longer needs to be available offline for the currently logged in user.
-
-## Parameters
-
-### type
-
-`string`
-
-The type of the offline data. See [DynamicOfflineData](../interfaces/DynamicOfflineData.md) for details.
-
-### identifier
-
-`string`
-
-The identifier of the offline data. See [DynamicOfflineData](../interfaces/DynamicOfflineData.md) for details.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/functions/removeDynamicOfflineDataFor.md

@@ -1,34 +0,0 @@
-[O3 Framework](../API.md) / removeDynamicOfflineDataFor
-
-# Function: removeDynamicOfflineDataFor()
-
-> **removeDynamicOfflineDataFor**(`userId`, `type`, `identifier`): `Promise`\<`void`\>
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:213](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L213)
-
-Declares that dynamic offline data of the given [type](#removedynamicofflinedatafor) with the given [identifier](#removedynamicofflinedatafor)
-no longer needs to be available offline for the user with the given ID.
-
-## Parameters
-
-### userId
-
-`string`
-
-The ID of the user who doesn't require the specified offline data.
-
-### type
-
-`string`
-
-The type of the offline data. See [DynamicOfflineData](../interfaces/DynamicOfflineData.md) for details.
-
-### identifier
-
-`string`
-
-The identifier of the offline data. See [DynamicOfflineData](../interfaces/DynamicOfflineData.md) for details.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/functions/subscribeConnectivity.md

@@ -1,21 +0,0 @@
-[O3 Framework](../API.md) / subscribeConnectivity
-
-# Function: subscribeConnectivity()
-
-> **subscribeConnectivity**(`cb`): () => `void`
-
-Defined in: [packages/framework/esm-globals/src/events.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L24)
-
-## Parameters
-
-### cb
-
-(`ev`) => `void`
-
-## Returns
-
-> (): `void`
-
-### Returns
-
-`void`

package/docs/functions/subscribeConnectivityChanged.md

@@ -1,21 +0,0 @@
-[O3 Framework](../API.md) / subscribeConnectivityChanged
-
-# Function: subscribeConnectivityChanged()
-
-> **subscribeConnectivityChanged**(`cb`): () => `void`
-
-Defined in: [packages/framework/esm-globals/src/events.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L13)
-
-## Parameters
-
-### cb
-
-(`ev`) => `void`
-
-## Returns
-
-> (): `void`
-
-### Returns
-
-`void`

package/docs/functions/syncAllDynamicOfflineData.md

@@ -1,27 +0,0 @@
-[O3 Framework](../API.md) / syncAllDynamicOfflineData
-
-# Function: syncAllDynamicOfflineData()
-
-> **syncAllDynamicOfflineData**(`type`, `abortSignal?`): `Promise`\<`void`\>
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:241](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L241)
-
-Synchronizes all offline data entries of the given [type](#syncalldynamicofflinedata) for the currently logged in user.
-
-## Parameters
-
-### type
-
-`string`
-
-The type of the offline data. See [DynamicOfflineData](../interfaces/DynamicOfflineData.md) for details.
-
-### abortSignal?
-
-`AbortSignal`
-
-An `AbortSignal` which can be used to cancel the operation.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/functions/syncDynamicOfflineData.md

@@ -1,33 +0,0 @@
-[O3 Framework](../API.md) / syncDynamicOfflineData
-
-# Function: syncDynamicOfflineData()
-
-> **syncDynamicOfflineData**(`type`, `identifier`, `abortSignal?`): `Promise`\<`void`\>
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:254](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L254)
-
-Synchronizes a single offline data entry of the given [type](#syncdynamicofflinedata) for the currently logged in user.
-
-## Parameters
-
-### type
-
-`string`
-
-The type of the offline data. See [DynamicOfflineData](../interfaces/DynamicOfflineData.md) for details.
-
-### identifier
-
-`string`
-
-The identifier of the offline data. See [DynamicOfflineData](../interfaces/DynamicOfflineData.md) for details.
-
-### abortSignal?
-
-`AbortSignal`
-
-An `AbortSignal` which can be used to cancel the operation.
-
-## Returns
-
-`Promise`\<`void`\>

package/docs/functions/syncOfflinePatientData.md

@@ -1,21 +0,0 @@
-[O3 Framework](../API.md) / syncOfflinePatientData
-
-# Function: ~~syncOfflinePatientData()~~
-
-> **syncOfflinePatientData**(`patientUuid`): `Promise`\<`void`\>
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L62)
-
-## Parameters
-
-### patientUuid
-
-`string`
-
-## Returns
-
-`Promise`\<`void`\>
-
-## Deprecated
-
-Will be removed once all modules have been migrated to the new dynamic offline data API.

package/docs/interfaces/ClearDynamicRoutesMessage.md

@@ -1,21 +0,0 @@
-[O3 Framework](../API.md) / ClearDynamicRoutesMessage
-
-# Interface: ClearDynamicRoutesMessage
-
-Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L33)
-
-## Extends
-
-- [`OmrsServiceWorkerMessage`](OmrsServiceWorkerMessage.md)\<`"clearDynamicRoutes"`\>
-
-## Properties
-
-### type
-
-> **type**: `"clearDynamicRoutes"`
-
-Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
-
-#### Inherited from
-
-[`OmrsServiceWorkerMessage`](OmrsServiceWorkerMessage.md).[`type`](OmrsServiceWorkerMessage.md#type)

package/docs/interfaces/ConnectivityChangedEvent.md

@@ -1,13 +0,0 @@
-[O3 Framework](../API.md) / ConnectivityChangedEvent
-
-# Interface: ConnectivityChangedEvent
-
-Defined in: [packages/framework/esm-globals/src/events.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L1)
-
-## Properties
-
-### online
-
-> **online**: `boolean`
-
-Defined in: [packages/framework/esm-globals/src/events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L2)

package/docs/interfaces/DynamicOfflineData.md

@@ -1,60 +0,0 @@
-[O3 Framework](../API.md) / DynamicOfflineData
-
-# Interface: DynamicOfflineData
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:44](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L44)
-
-Represents the registration of a single dynamic offline data entry.
-
-## Properties
-
-### id?
-
-> `optional` **id**: `number`
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L48)
-
-The internal ID of the data entry, as assigned by the IndexedDB where it is stored.
-
-***
-
-### identifier
-
-> **identifier**: `string`
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L58)
-
-The externally provided identifier of the data entry.
-This is typically the ID of the resource as assigned by a remote API.
-
-***
-
-### syncState?
-
-> `optional` **syncState**: [`DynamicOfflineDataSyncState`](DynamicOfflineDataSyncState.md)
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L67)
-
-If this entry has already been synced, returns the result of that last sync attempt.
-Otherwise this is `undefined`.
-
-***
-
-### type
-
-> **type**: `string`
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L53)
-
-The underlying type used for categorizing the data entry.
-Examples could be `"patient"` or `"form"`.
-
-***
-
-### users
-
-> **users**: `string`[]
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L62)
-
-The UUIDs of the users who need this data entry available offline.

package/docs/interfaces/DynamicOfflineDataHandler.md

@@ -1,98 +0,0 @@
-[O3 Framework](../API.md) / DynamicOfflineDataHandler
-
-# Interface: DynamicOfflineDataHandler
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L10)
-
-A handler for synchronizing dynamically declared offline data.
-Can be setup using the [setupDynamicOfflineDataHandler](../functions/setupDynamicOfflineDataHandler.md) function.
-
-## Properties
-
-### displayName?
-
-> `optional` **displayName**: `string`
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L24)
-
-A human-readable string representing the handler.
-If provided, the handler can be rendered in the UI using that string.
-
-***
-
-### id
-
-> **id**: `string`
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L14)
-
-A string uniquely identifying the handler.
-
-***
-
-### type
-
-> **type**: `string`
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L19)
-
-The type of offline data handled by this handler.
-See [DynamicOfflineData.type](DynamicOfflineData.md#type) for details.
-
-## Methods
-
-### isSynced()
-
-> **isSynced**(`identifier`, `abortSignal?`): `Promise`\<`boolean`\>
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L32)
-
-Evaluates whether the given offline data is correctly synced at this point in time from the perspective
-of this single handler.
-If `false`, the handler would have to (re-)sync the data in order for offline mode to properly work.
-
-#### Parameters
-
-##### identifier
-
-`string`
-
-The identifier of the offline data. See [DynamicOfflineData](DynamicOfflineData.md) for details.
-
-##### abortSignal?
-
-`AbortSignal`
-
-An `AbortSignal` which can be used to cancel the operation.
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-***
-
-### sync()
-
-> **sync**(`identifier`, `abortSignal?`): `Promise`\<`void`\>
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L38)
-
-Synchronizes the given offline data.
-
-#### Parameters
-
-##### identifier
-
-`string`
-
-The identifier of the offline data. See [DynamicOfflineData](DynamicOfflineData.md) for details.
-
-##### abortSignal?
-
-`AbortSignal`
-
-An `AbortSignal` which can be used to cancel the operation.
-
-#### Returns
-
-`Promise`\<`void`\>

package/docs/interfaces/DynamicOfflineDataSyncState.md

@@ -1,65 +0,0 @@
-[O3 Framework](../API.md) / DynamicOfflineDataSyncState
-
-# Interface: DynamicOfflineDataSyncState
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L73)
-
-Represents the result of syncing a given [DynamicOfflineData](DynamicOfflineData.md) entry.
-
-## Properties
-
-### erroredHandlers
-
-> **erroredHandlers**: `string`[]
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L89)
-
-The IDs of the handlers which failed to synchronize their data.
-
-***
-
-### errors
-
-> **errors**: `object`[]
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L93)
-
-A collection of the errors caught while synchronizing, per handler.
-
-#### handlerId
-
-> **handlerId**: `string`
-
-#### message
-
-> **message**: `string`
-
-***
-
-### succeededHandlers
-
-> **succeededHandlers**: `string`[]
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:85](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L85)
-
-The IDs of the handlers which successfully synchronized their data.
-
-***
-
-### syncedBy
-
-> **syncedBy**: `string`
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L81)
-
-The ID of the user who has triggered the data synchronization.
-
-***
-
-### syncedOn
-
-> **syncedOn**: `Date`
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L77)
-
-The time when the entry has been synced the last time.

package/docs/interfaces/MessageServiceWorkerResult.md

@@ -1,35 +0,0 @@
-[O3 Framework](../API.md) / MessageServiceWorkerResult
-
-# Interface: MessageServiceWorkerResult\<T\>
-
-Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L46)
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Properties
-
-### error?
-
-> `optional` **error**: `string`
-
-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`
-
-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: [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)

package/docs/interfaces/OfflineModeResult.md

@@ -1,29 +0,0 @@
-[O3 Framework](../API.md) / OfflineModeResult
-
-# Interface: OfflineModeResult
-
-Defined in: [packages/framework/esm-offline/src/mode.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L36)
-
-## Properties
-
-### active
-
-> **active**: `boolean`
-
-Defined in: [packages/framework/esm-offline/src/mode.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L39)
-
-***
-
-### current
-
-> **current**: [`OfflineMode`](../type-aliases/OfflineMode.md)
-
-Defined in: [packages/framework/esm-offline/src/mode.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L37)
-
-***
-
-### notAvailable
-
-> **notAvailable**: `boolean`
-
-Defined in: [packages/framework/esm-offline/src/mode.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L38)

package/docs/interfaces/OfflinePatientArgs.md

@@ -1,25 +0,0 @@
-[O3 Framework](../API.md) / OfflinePatientArgs
-
-# Interface: ~~OfflinePatientArgs~~
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L28)
-
-## Deprecated
-
-Will be removed once all modules have been migrated to the new dynamic offline data API.
-
-## Properties
-
-### ~~patientUuid~~
-
-> **patientUuid**: `string`
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L29)
-
-***
-
-### ~~signal~~
-
-> **signal**: `AbortSignal`
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L30)

package/docs/interfaces/OfflinePatientDataSyncHandler.md

@@ -1,35 +0,0 @@
-[O3 Framework](../API.md) / OfflinePatientDataSyncHandler
-
-# Interface: ~~OfflinePatientDataSyncHandler~~
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L22)
-
-## Deprecated
-
-Will be removed once all modules have been migrated to the new dynamic offline data API.
-
-## Properties
-
-### ~~displayName~~
-
-> `readonly` **displayName**: `string`
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L23)
-
-## Methods
-
-### ~~onOfflinePatientAdded()~~
-
-> **onOfflinePatientAdded**(`args`): `Promise`\<`void`\>
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L24)
-
-#### Parameters
-
-##### args
-
-[`OfflinePatientArgs`](OfflinePatientArgs.md)
-
-#### Returns
-
-`Promise`\<`void`\>