@openmrs/esm-framework 3.2.1-pre.924 → 3.2.1-pre.944

package/docs/API.md

@@ -67,6 +67,7 @@
 - [NavigationContext](interfaces/NavigationContext.md)
 - [NetworkRequestFailedEvent](interfaces/NetworkRequestFailedEvent.md)
 - [NewVisitPayload](interfaces/NewVisitPayload.md)
+- [OfflineModeResult](interfaces/OfflineModeResult.md)
 - [OfflinePatientArgs](interfaces/OfflinePatientArgs.md)
 - [OfflinePatientDataSyncHandler](interfaces/OfflinePatientDataSyncHandler.md)
 - [OfflinePatientDataSyncState](interfaces/OfflinePatientDataSyncState.md)
@@ -120,6 +121,7 @@
 - [LoggedInUserData](API.md#loggedinuserdata)
 - [MaybeAsync](API.md#maybeasync)
 - [NavigationContextType](API.md#navigationcontexttype)
+- [OfflineMode](API.md#offlinemode)
 - [OmrsOfflineCachingStrategy](API.md#omrsofflinecachingstrategy)
 - [OmrsOfflineHttpHeaderNames](API.md#omrsofflinehttpheadernames)
 - [OmrsOfflineHttpHeaders](API.md#omrsofflinehttpheaders)
@@ -187,8 +189,11 @@
 
 ### Other Functions
 
+- [activateOfflineCapability](API.md#activateofflinecapability)
 - [age](API.md#age)
 - [attach](API.md#attach)
+- [beginEditSynchronizationItem](API.md#begineditsynchronizationitem)
+- [canBeginEditSynchronizationItemsOfType](API.md#canbegineditsynchronizationitemsoftype)
 - [checkStatus](API.md#checkstatus)
 - [checkStatusFor](API.md#checkstatusfor)
 - [createErrorHandler](API.md#createerrorhandler)
@@ -213,6 +218,7 @@
 - [getAsyncLifecycle](API.md#getasynclifecycle)
 - [getConfig](API.md#getconfig)
 - [getConfigStore](API.md#getconfigstore)
+- [getCurrentOfflineMode](API.md#getcurrentofflinemode)
 - [getCustomProps](API.md#getcustomprops)
 - [getExtensionConfigStore](API.md#getextensionconfigstore)
 - [getExtensionNameFromId](API.md#getextensionnamefromid)
@@ -229,6 +235,7 @@
 - [getOmrsServiceWorker](API.md#getomrsserviceworker)
 - [getSessionLocation](API.md#getsessionlocation)
 - [getSyncLifecycle](API.md#getsynclifecycle)
+- [getSynchronizationItem](API.md#getsynchronizationitem)
 - [getSynchronizationItems](API.md#getsynchronizationitems)
 - [getSynchronizationItemsFor](API.md#getsynchronizationitemsfor)
 - [getUpdatedExtensionSlotInfo](API.md#getupdatedextensionslotinfo)
@@ -267,6 +274,7 @@
 - [retry](API.md#retry)
 - [runSynchronization](API.md#runsynchronization)
 - [saveVisit](API.md#savevisit)
+- [setCurrentOfflineMode](API.md#setcurrentofflinemode)
 - [setSessionLocation](API.md#setsessionlocation)
 - [setupOfflineSync](API.md#setupofflinesync)
 - [setupPaths](API.md#setuppaths)
@@ -490,6 +498,16 @@ ___
 
 ___
 
+### OfflineMode
+
+Ƭ **OfflineMode**: ``"on"`` \| ``"off"`` \| ``"unavailable"``
+
+#### Defined in
+
+[packages/framework/esm-offline/src/mode.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L36)
+
+___
+
 ### OmrsOfflineCachingStrategy
 
 Ƭ **OmrsOfflineCachingStrategy**: ``"network-only-or-cache-only"`` \| ``"network-first"``
@@ -560,6 +578,11 @@ ___
 
 ▸ (`item`, `options`): `Promise`<`any`\>
 
+A function which, when invoked, performs the actual client-server synchronization of the given
+`item` (which is the actual data to be synchronized).
+The function receives additional `options` which provide additional data that can be used
+for synchronizing.
+
 ##### Parameters
 
 | Name | Type |
@@ -573,7 +596,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L28)
+[packages/framework/esm-offline/src/sync.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L45)
 
 ___
 
@@ -1364,6 +1387,20 @@ ___
 
 ## Other Functions
 
+### activateOfflineCapability
+
+▸ **activateOfflineCapability**(): `Promise`<`void`\>
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[packages/framework/esm-offline/src/mode.ts:65](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L65)
+
+___
+
 ### age
 
 ▸ **age**(`dateString`): `string`
@@ -1409,6 +1446,52 @@ ___
 
 ___
 
+### beginEditSynchronizationItem
+
+▸ **beginEditSynchronizationItem**(`id`): `Promise`<`void`\>
+
+Triggers an edit flow for the given synchronization item.
+If this is not possible, throws an error.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `number` | The ID of the synchronization item to be edited. |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[packages/framework/esm-offline/src/sync.ts:354](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L354)
+
+___
+
+### canBeginEditSynchronizationItemsOfType
+
+▸ **canBeginEditSynchronizationItemsOfType**(`type`): `boolean`
+
+Returns whether editing synchronization items of the given type is supported by the currently
+registered synchronization handlers.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `type` | `string` | The identifying type of the synchronization item which should be edited. |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/framework/esm-offline/src/sync.ts:344](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L344)
+
+___
+
 ### checkStatus
 
 ▸ **checkStatus**(`online?`, `offline?`): `boolean`
@@ -1614,11 +1697,13 @@ ___
 
 ▸ **deleteSynchronizationItem**(`id`): `Promise`<`void`\>
 
+Deletes a queued up sync item with the given ID.
+
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `id` | `number` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `number` | The ID of the synchronization item to be deleted. |
 
 #### Returns
 
@@ -1626,7 +1711,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:251](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L251)
+[packages/framework/esm-offline/src/sync.ts:374](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L374)
 
 ___
 
@@ -2011,6 +2096,20 @@ ___
 
 ___
 
+### getCurrentOfflineMode
+
+▸ **getCurrentOfflineMode**(): [`OfflineModeResult`](interfaces/OfflineModeResult.md)
+
+#### Returns
+
+[`OfflineModeResult`](interfaces/OfflineModeResult.md)
+
+#### Defined in
+
+[packages/framework/esm-offline/src/mode.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L47)
+
+___
+
 ### getCustomProps
 
 ▸ **getCustomProps**(`online`, `offline`): `object`
@@ -2266,7 +2365,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L80)
+[packages/framework/esm-offline/src/sync.ts:133](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L133)
 
 ___
 
@@ -2339,10 +2438,40 @@ ___
 
 ___
 
+### getSynchronizationItem
+
+▸ **getSynchronizationItem**<`T`\>(`id`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\> \| `undefined`\>
+
+Returns a queued sync item with the given ID or `undefined` if no such item exists.
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | `any` |
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `id` | `number` | The ID of the requested sync item. |
+
+#### Returns
+
+`Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\> \| `undefined`\>
+
+#### Defined in
+
+[packages/framework/esm-offline/src/sync.ts:333](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L333)
+
+___
+
 ### getSynchronizationItems
 
 ▸ **getSynchronizationItems**<`T`\>(`type`): `Promise`<`T`[]\>
 
+Returns all currently queued up sync items of the currently signed in user.
+
 #### Type parameters
 
 | Name |
@@ -2351,9 +2480,9 @@ ___
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `type` | `string` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `type` | `string` | The identifying type of the synchronization items to be returned. |
 
 #### Returns
 
@@ -2361,7 +2490,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:246](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L246)
+[packages/framework/esm-offline/src/sync.ts:324](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L324)
 
 ___
 
@@ -2369,6 +2498,8 @@ ___
 
 ▸ **getSynchronizationItemsFor**<`T`\>(`userId`, `type`): `Promise`<`T`[]\>
 
+Returns all currently queued up sync items of a given user.
+
 #### Type parameters
 
 | Name |
@@ -2377,10 +2508,10 @@ ___
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `userId` | `string` |
-| `type` | `string` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `userId` | `string` | The ID of the user whose synchronization items should be returned. |
+| `type` | `string` | The identifying type of the synchronization items to be returned.. |
 
 #### Returns
 
@@ -2388,7 +2519,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:232](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L232)
+[packages/framework/esm-offline/src/sync.ts:306](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L306)
 
 ___
 
@@ -2855,6 +2986,8 @@ ___
 
 ▸ **queueSynchronizationItem**<`T`\>(`type`, `content`, `descriptor?`): `Promise`<`number`\>
 
+Enqueues a new item in the sync queue and associates the item with the currently signed in user.
+
 #### Type parameters
 
 | Name |
@@ -2863,11 +2996,11 @@ ___
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `type` | `string` |
-| `content` | `T` |
-| `descriptor?` | [`QueueItemDescriptor`](interfaces/QueueItemDescriptor.md) |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `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
 
@@ -2875,7 +3008,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:223](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L223)
+[packages/framework/esm-offline/src/sync.ts:292](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L292)
 
 ___
 
@@ -2883,6 +3016,8 @@ ___
 
 ▸ **queueSynchronizationItemFor**<`T`\>(`userId`, `type`, `content`, `descriptor?`): `Promise`<`number`\>
 
+Enqueues a new item in the sync queue for a specific user.
+
 #### Type parameters
 
 | Name |
@@ -2891,12 +3026,12 @@ ___
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `userId` | `string` |
-| `type` | `string` |
-| `content` | `T` |
-| `descriptor?` | [`QueueItemDescriptor`](interfaces/QueueItemDescriptor.md) |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `userId` | `string` | The user with whom the sync item should be associated with. |
+| `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
 
@@ -2904,7 +3039,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:195](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L195)
+[packages/framework/esm-offline/src/sync.ts:258](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L258)
 
 ___
 
@@ -3185,13 +3320,15 @@ ___
 
 ▸ **runSynchronization**(): `Promise`<`void`\>
 
+Runs a full synchronization of **all** queued synchronization items.
+
 #### Returns
 
 `Promise`<`void`\>
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:84](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L84)
+[packages/framework/esm-offline/src/sync.ts:140](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L140)
 
 ___
 
@@ -3216,6 +3353,26 @@ ___
 
 ___
 
+### setCurrentOfflineMode
+
+▸ **setCurrentOfflineMode**(`mode`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `mode` | [`OfflineMode`](API.md#offlinemode) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-offline/src/mode.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L55)
+
+___
+
 ### setSessionLocation
 
 ▸ **setSessionLocation**(`locationUuid`, `abortController`): `Promise`<`any`\>
@@ -3239,7 +3396,9 @@ ___
 
 ### setupOfflineSync
 
-▸ **setupOfflineSync**<`T`\>(`type`, `dependsOn`, `process`): `void`
+▸ **setupOfflineSync**<`T`\>(`type`, `dependsOn`, `process`, `options?`): `void`
+
+Registers a new synchronization handler which is able to synchronize data of a specific type.
 
 #### Type parameters
 
@@ -3249,11 +3408,12 @@ ___
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `type` | `string` |
-| `dependsOn` | `string`[] |
-| `process` | [`ProcessSyncItem`](API.md#processsyncitem)<`T`\> |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `type` | `string` | The identifying type of the synchronization items which can be handled by this handler. |
+| `dependsOn` | `string`[] | An array of other sync item types which must be synchronized before this handler   can synchronize its own data. Items of these types are effectively dependencies of the data   synchronized by this handler. |
+| `process` | [`ProcessSyncItem`](API.md#processsyncitem)<`T`\> | A function which, when invoked, performs the actual client-server synchronization of the given   `item` (which is the actual data to be synchronized). |
+| `options` | `SetupOfflineSyncOptions`<`T`\> | Additional options which can optionally be provided when setting up a synchronization callback   for a specific synchronization item type. |
 
 #### Returns
 
@@ -3261,7 +3421,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:263](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L263)
+[packages/framework/esm-offline/src/sync.ts:389](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L389)
 
 ___
 

package/docs/interfaces/FHIRResource.md

@@ -18,10 +18,10 @@
 
 | Name | Type |
 | :------ | :------ |
-| `code` | `Object` |
+| `code` | { `coding`: [`FHIRCode`](FHIRCode.md)[]  } |
 | `code.coding` | [`FHIRCode`](FHIRCode.md)[] |
 | `effectiveDateTime` | `Date` |
-| `encounter` | `Object` |
+| `encounter` | { `reference`: `string` ; `type`: `string`  } |
 | `encounter.reference` | `string` |
 | `encounter.type` | `string` |
 | `id` | `string` |
@@ -29,16 +29,16 @@
 | `referenceRange` | `any` |
 | `resourceType` | `string` |
 | `status` | `string` |
-| `subject` | `Object` |
+| `subject` | { `display`: `string` ; `identifier`: { `id`: `string` ; `system`: `string` ; `use`: `string` ; `value`: `string`  } ; `reference`: `string` ; `type`: `string`  } |
 | `subject.display` | `string` |
-| `subject.identifier` | `Object` |
+| `subject.identifier` | { `id`: `string` ; `system`: `string` ; `use`: `string` ; `value`: `string`  } |
 | `subject.identifier.id` | `string` |
 | `subject.identifier.system` | `string` |
 | `subject.identifier.use` | `string` |
 | `subject.identifier.value` | `string` |
 | `subject.reference` | `string` |
 | `subject.type` | `string` |
-| `valueQuantity` | `Object` |
+| `valueQuantity` | { `value`: `number`  } |
 | `valueQuantity.value` | `number` |
 
 #### Defined in

package/docs/interfaces/OfflineModeResult.md

@@ -0,0 +1,41 @@
+[@openmrs/esm-framework](../API.md) / OfflineModeResult
+
+# Interface: OfflineModeResult
+
+## Table of contents
+
+### Properties
+
+- [active](OfflineModeResult.md#active)
+- [current](OfflineModeResult.md#current)
+- [notAvailable](OfflineModeResult.md#notavailable)
+
+## Properties
+
+### active
+
+• **active**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-offline/src/mode.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L41)
+
+___
+
+### current
+
+• **current**: [`OfflineMode`](../API.md#offlinemode)
+
+#### Defined in
+
+[packages/framework/esm-offline/src/mode.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L39)
+
+___
+
+### notAvailable
+
+• **notAvailable**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-offline/src/mode.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/mode.ts#L40)

package/docs/interfaces/OfflineSynchronizationStore.md

@@ -2,6 +2,9 @@
 
 # Interface: OfflineSynchronizationStore
 
+Represents the data inside the global offline synchronization store.
+Provides information about a currently ongoing synchronization.
+
 ## Table of contents
 
 ### Properties
@@ -24,4 +27,4 @@
 
 #### 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)
+[packages/framework/esm-offline/src/sync.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L93)

package/docs/interfaces/QueueItemDescriptor.md

@@ -2,6 +2,11 @@
 
 # Interface: QueueItemDescriptor
 
+Contains information about the sync item which has been provided externally by the caller
+who added the item to the queue.
+This information is all optional, but, when provided while enqueuing the item, can be used in other
+locations to better represent the sync item, e.g. in the UI.
+
 ## Table of contents
 
 ### Properties
@@ -19,7 +24,7 @@
 
 #### 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)
+[packages/framework/esm-offline/src/sync.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L31)
 
 ___
 
@@ -29,7 +34,7 @@ ___
 
 #### 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)
+[packages/framework/esm-offline/src/sync.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L36)
 
 ___
 
@@ -39,7 +44,7 @@ ___
 
 #### 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)
+[packages/framework/esm-offline/src/sync.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L30)
 
 ___
 
@@ -49,4 +54,4 @@ ___
 
 #### 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)
+[packages/framework/esm-offline/src/sync.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L35)

package/docs/interfaces/SyncItem.md

@@ -1,6 +1,16 @@
 [@openmrs/esm-framework](../API.md) / SyncItem
 
-# Interface: SyncItem
+# Interface: SyncItem<T\>
+
+Defines an item queued up in the offline synchronization queue.
+A `SyncItem` contains both meta information about the item in the sync queue, as well as the
+actual data to be synchronized (i.e. the item's `content`).
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | `any` |
 
 ## Table of contents
 
@@ -18,11 +28,11 @@
 
 ### content
 
-• **content**: `any`
+• **content**: `T`
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L9)
+[packages/framework/esm-offline/src/sync.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L14)
 
 ___
 
@@ -32,7 +42,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L10)
+[packages/framework/esm-offline/src/sync.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L15)
 
 ___
 
@@ -42,7 +52,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L11)
+[packages/framework/esm-offline/src/sync.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L16)
 
 ___
 
@@ -52,7 +62,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L6)
+[packages/framework/esm-offline/src/sync.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L11)
 
 ___
 
@@ -69,7 +79,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L12)
+[packages/framework/esm-offline/src/sync.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L17)
 
 ___
 
@@ -79,7 +89,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L8)
+[packages/framework/esm-offline/src/sync.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L13)
 
 ___
 
@@ -89,4 +99,4 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L7)
+[packages/framework/esm-offline/src/sync.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L12)