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

package/docs/interfaces/OfflinePatientDataSyncState.md

@@ -1,61 +0,0 @@
-[O3 Framework](../API.md) / OfflinePatientDataSyncState
-
-# Interface: ~~OfflinePatientDataSyncState~~
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L12)
-
-## Deprecated
-
-Will be removed once all modules have been migrated to the new dynamic offline data API.
-
-## Properties
-
-### ~~errors~~
-
-> `readonly` **errors**: `Record`\<`string`, `string`\>
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L17)
-
-***
-
-### ~~failedHandlers~~
-
-> `readonly` **failedHandlers**: `string`[]
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L16)
-
-***
-
-### ~~syncedHandlers~~
-
-> `readonly` **syncedHandlers**: `string`[]
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L15)
-
-***
-
-### ~~syncingHandlers~~
-
-> `readonly` **syncingHandlers**: `string`[]
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L14)
-
-***
-
-### ~~timestamp~~
-
-> `readonly` **timestamp**: `Date`
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L13)
-
-## Methods
-
-### ~~abort()~~
-
-> **abort**(): `boolean`
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L18)
-
-#### Returns
-
-`boolean`

package/docs/interfaces/OfflinePatientDataSyncStore.md

@@ -1,25 +0,0 @@
-[O3 Framework](../API.md) / OfflinePatientDataSyncStore
-
-# Interface: ~~OfflinePatientDataSyncStore~~
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L6)
-
-## Deprecated
-
-Will be removed once all modules have been migrated to the new dynamic offline data API.
-
-## Properties
-
-### ~~handlers~~
-
-> **handlers**: `Record`\<`string`, [`OfflinePatientDataSyncHandler`](OfflinePatientDataSyncHandler.md)\>
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L8)
-
-***
-
-### ~~offlinePatientDataSyncState~~
-
-> **offlinePatientDataSyncState**: `Record`\<`string`, [`OfflinePatientDataSyncState`](OfflinePatientDataSyncState.md)\>
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L7)

package/docs/interfaces/OmrsServiceWorkerMessage.md

@@ -1,25 +0,0 @@
-[O3 Framework](../API.md) / OmrsServiceWorkerMessage
-
-# Interface: OmrsServiceWorkerMessage\<MessageTypeTypeIdentifier\>
-
-Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L25)
-
-## Extended by
-
-- [`OnImportMapChangedMessage`](OnImportMapChangedMessage.md)
-- [`ClearDynamicRoutesMessage`](ClearDynamicRoutesMessage.md)
-- [`RegisterDynamicRouteMessage`](RegisterDynamicRouteMessage.md)
-
-## Type Parameters
-
-### MessageTypeTypeIdentifier
-
-`MessageTypeTypeIdentifier` *extends* `string`
-
-## Properties
-
-### type
-
-> **type**: `MessageTypeTypeIdentifier`
-
-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)

package/docs/interfaces/OnImportMapChangedMessage.md

@@ -1,29 +0,0 @@
-[O3 Framework](../API.md) / OnImportMapChangedMessage
-
-# Interface: OnImportMapChangedMessage
-
-Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L29)
-
-## Extends
-
-- [`OmrsServiceWorkerMessage`](OmrsServiceWorkerMessage.md)\<`"onImportMapChanged"`\>
-
-## Properties
-
-### importMap
-
-> **importMap**: [`ImportMap`](ImportMap.md)
-
-Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L30)
-
-***
-
-### type
-
-> **type**: `"onImportMapChanged"`
-
-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/PrecacheStaticDependenciesEvent.md

@@ -1,5 +0,0 @@
-[O3 Framework](../API.md) / PrecacheStaticDependenciesEvent
-
-# Interface: PrecacheStaticDependenciesEvent
-
-Defined in: [packages/framework/esm-globals/src/events.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L29)

package/docs/interfaces/QueueItemDescriptor.md

@@ -1,50 +0,0 @@
-[O3 Framework](../API.md) / QueueItemDescriptor
-
-# Interface: QueueItemDescriptor
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L31)
-
-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.
-
-## Properties
-
-### dependencies?
-
-> `optional` **dependencies**: `object`[]
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L33)
-
-#### id
-
-> **id**: `string`
-
-#### type
-
-> **type**: `string`
-
-***
-
-### displayName?
-
-> `optional` **displayName**: `string`
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L38)
-
-***
-
-### id?
-
-> `optional` **id**: `string`
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L32)
-
-***
-
-### patientUuid?
-
-> `optional` **patientUuid**: `string`
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L37)

package/docs/interfaces/RegisterDynamicRouteMessage.md

@@ -1,45 +0,0 @@
-[O3 Framework](../API.md) / RegisterDynamicRouteMessage
-
-# Interface: RegisterDynamicRouteMessage
-
-Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L35)
-
-## Extends
-
-- [`OmrsServiceWorkerMessage`](OmrsServiceWorkerMessage.md)\<`"registerDynamicRoute"`\>
-
-## Properties
-
-### pattern?
-
-> `optional` **pattern**: `string`
-
-Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L36)
-
-***
-
-### strategy?
-
-> `optional` **strategy**: [`OmrsOfflineCachingStrategy`](../type-aliases/OmrsOfflineCachingStrategy.md)
-
-Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L38)
-
-***
-
-### type
-
-> **type**: `"registerDynamicRoute"`
-
-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)
-
-***
-
-### url?
-
-> `optional` **url**: `string`
-
-Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L37)

package/docs/interfaces/SyncItem.md

@@ -1,79 +0,0 @@
-[O3 Framework](../API.md) / SyncItem
-
-# Interface: SyncItem\<T\>
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L12)
-
-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
-
-### T
-
-`T` = `any`
-
-## Properties
-
-### content
-
-> **content**: `T`
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L16)
-
-***
-
-### createdOn
-
-> **createdOn**: `Date`
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L17)
-
-***
-
-### descriptor
-
-> **descriptor**: [`QueueItemDescriptor`](QueueItemDescriptor.md)
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L18)
-
-***
-
-### id?
-
-> `optional` **id**: `number`
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L13)
-
-***
-
-### lastError?
-
-> `optional` **lastError**: `object`
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L19)
-
-#### message?
-
-> `optional` **message**: `string`
-
-#### name?
-
-> `optional` **name**: `string`
-
-***
-
-### type
-
-> **type**: `string`
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L15)
-
-***
-
-### userId
-
-> **userId**: `string`
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L14)

package/docs/interfaces/SyncProcessOptions.md

@@ -1,53 +0,0 @@
-[O3 Framework](../API.md) / SyncProcessOptions
-
-# Interface: SyncProcessOptions\<T\>
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L52)
-
-Additional data which can be used for synchronizing data in a ProcessSyncItem function.
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Properties
-
-### abort
-
-> **abort**: `AbortController`
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L53)
-
-***
-
-### dependencies
-
-> **dependencies**: `any`[]
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L57)
-
-***
-
-### index
-
-> **index**: `number`
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L55)
-
-***
-
-### items
-
-> **items**: `T`[]
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L56)
-
-***
-
-### userId
-
-> **userId**: `string`
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L54)

package/docs/type-aliases/KnownOmrsServiceWorkerMessages.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / KnownOmrsServiceWorkerMessages
-
-# Type Alias: KnownOmrsServiceWorkerMessages
-
-> **KnownOmrsServiceWorkerMessages** = [`OnImportMapChangedMessage`](../interfaces/OnImportMapChangedMessage.md) \| [`ClearDynamicRoutesMessage`](../interfaces/ClearDynamicRoutesMessage.md) \| [`RegisterDynamicRouteMessage`](../interfaces/RegisterDynamicRouteMessage.md)
-
-Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L41)

package/docs/type-aliases/OfflineMode.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / OfflineMode
-
-# Type Alias: OfflineMode
-
-> **OfflineMode** = `"on"` \| `"off"` \| `"unavailable"`
-
-Defined in: [packages/framework/esm-offline/src/mode.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/mode.ts#L34)

package/docs/type-aliases/OmrsOfflineCachingStrategy.md

@@ -1,12 +0,0 @@
-[O3 Framework](../API.md) / OmrsOfflineCachingStrategy
-
-# Type Alias: OmrsOfflineCachingStrategy
-
-> **OmrsOfflineCachingStrategy** = `"network-only-or-cache-only"` \| `"network-first"`
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L15)
-
-* `cache-or-network`: The default strategy, equal to the absence of this header.
-  The SW attempts to resolve the request via the network, but falls back to the cache if required.
-  The service worker decides the strategy to be used.
-* `network-first`: See https://developers.google.com/web/tools/workbox/modules/workbox-strategies#network_first_network_falling_back_to_cache.

package/docs/type-aliases/OmrsOfflineHttpHeaderNames.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / OmrsOfflineHttpHeaderNames
-
-# Type Alias: OmrsOfflineHttpHeaderNames
-
-> **OmrsOfflineHttpHeaderNames** = keyof [`OmrsOfflineHttpHeaders`](OmrsOfflineHttpHeaders.md)
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L40)

package/docs/type-aliases/OmrsOfflineHttpHeaders.md

@@ -1,44 +0,0 @@
-[O3 Framework](../API.md) / OmrsOfflineHttpHeaders
-
-# Type Alias: OmrsOfflineHttpHeaders
-
-> **OmrsOfflineHttpHeaders** = `object`
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L21)
-
-Defines the keys of the custom headers which can be appended to an HTTP request.
-HTTP requests with these headers are handled in a special way by the SPA's service worker.
-
-## Properties
-
-### x-omrs-offline-caching-strategy?
-
-> `optional` **x-omrs-offline-caching-strategy**: [`OmrsOfflineCachingStrategy`](OmrsOfflineCachingStrategy.md)
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L37)
-
-Instructs the service worker to use a specific caching strategy for this request.
-
-***
-
-### x-omrs-offline-response-body?
-
-> `optional` **x-omrs-offline-response-body**: `string`
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L27)
-
-If the client is offline and the request cannot be read from the cache (i.e. if there is no way
-to receive any kind of data for this request), the service worker will return a response with
-the body in this header.
-
-***
-
-### x-omrs-offline-response-status?
-
-> `optional` **x-omrs-offline-response-status**: `` `${number}` ``
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L33)
-
-If the client is offline and the request cannot be read from the cache (i.e. if there is no way
-to receive any kind of data for this request), the service worker will return a response with
-the status code defined in this header.

package/docs/variables/getStartedVisit.md

@@ -1,9 +0,0 @@
-[O3 Framework](../API.md) / getStartedVisit
-
-# Variable: ~~getStartedVisit~~
-
-> `const` **getStartedVisit**: `BehaviorSubject`\<`null` \| [`VisitItem`](../interfaces/VisitItem.md)\>
-
-Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:190](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L190)
-
-## Deprecated

package/docs/variables/offlineUuidPrefix.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / offlineUuidPrefix
-
-# Variable: offlineUuidPrefix
-
-> `const` **offlineUuidPrefix**: `"OFFLINE+"` = `'OFFLINE+'`
-
-Defined in: [packages/framework/esm-offline/src/uuid-support.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid-support.ts#L4)

package/docs/variables/omrsOfflineCachingStrategyHttpHeaderName.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / omrsOfflineCachingStrategyHttpHeaderName
-
-# Variable: omrsOfflineCachingStrategyHttpHeaderName
-
-> `const` **omrsOfflineCachingStrategyHttpHeaderName**: `"x-omrs-offline-caching-strategy"` = `'x-omrs-offline-caching-strategy'`
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L5)

package/docs/variables/omrsOfflineResponseBodyHttpHeaderName.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / omrsOfflineResponseBodyHttpHeaderName
-
-# Variable: omrsOfflineResponseBodyHttpHeaderName
-
-> `const` **omrsOfflineResponseBodyHttpHeaderName**: `"x-omrs-offline-response-body"` = `'x-omrs-offline-response-body'`
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L3)

package/docs/variables/omrsOfflineResponseStatusHttpHeaderName.md

@@ -1,7 +0,0 @@
-[O3 Framework](../API.md) / omrsOfflineResponseStatusHttpHeaderName
-
-# Variable: omrsOfflineResponseStatusHttpHeaderName
-
-> `const` **omrsOfflineResponseStatusHttpHeaderName**: `"x-omrs-offline-response-status"` = `'x-omrs-offline-response-status'`
-
-Defined in: [packages/framework/esm-offline/src/service-worker-http-headers.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-http-headers.ts#L4)