@openmrs/esm-framework 6.3.1-pre.3092 → 6.3.1-pre.3104

package/docs/interfaces/DisplayConditionsConfigObject.md

@@ -1,60 +1,45 @@
-[@openmrs/esm-framework](../API.md) / DisplayConditionsConfigObject
+[O3 Framework](../API.md) / DisplayConditionsConfigObject
 
 # Interface: DisplayConditionsConfigObject
 
-## Table of contents
-
-### Properties
-
-- [expression](DisplayConditionsConfigObject.md#expression)
-- [offline](DisplayConditionsConfigObject.md#offline)
-- [online](DisplayConditionsConfigObject.md#online)
-- [privileges](DisplayConditionsConfigObject.md#privileges)
+Defined in: [packages/framework/esm-config/src/types.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L35)
 
 ## Properties
 
-### expression
+### expression?
 
-• `Optional` **expression**: `string`
+> `optional` **expression**: `string`
 
-An expression to evaluate whether or not the user should see this extension
+Defined in: [packages/framework/esm-config/src/types.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L39)
 
-#### Defined in
+An expression to evaluate whether or not the user should see this extension
 
-[packages/framework/esm-config/src/types.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L39)
+***
 
-___
+### offline?
 
-### offline
+> `optional` **offline**: `boolean`
 
-• `Optional` **offline**: `boolean`
+Defined in: [packages/framework/esm-config/src/types.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L43)
 
 Whether to display this extension when not connected to the server
 
-#### Defined in
+***
 
-[packages/framework/esm-config/src/types.ts:43](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L43)
+### online?
 
-___
+> `optional` **online**: `boolean`
 
-### online
-
-• `Optional` **online**: `boolean`
+Defined in: [packages/framework/esm-config/src/types.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L41)
 
 Whether to display this extension when connected to the server
 
-#### Defined in
-
-[packages/framework/esm-config/src/types.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L41)
+***
 
-___
+### privileges?
 
-### privileges
+> `optional` **privileges**: `string`[]
 
-• `Optional` **privileges**: `string`[]
+Defined in: [packages/framework/esm-config/src/types.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L37)
 
 The privileges a user should have to see this extension
-
-#### Defined in
-
-[packages/framework/esm-config/src/types.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L37)

package/docs/interfaces/DynamicOfflineData.md

@@ -1,78 +1,60 @@
-[@openmrs/esm-framework](../API.md) / DynamicOfflineData
+[O3 Framework](../API.md) / DynamicOfflineData
 
 # Interface: DynamicOfflineData
 
-Represents the registration of a single dynamic offline data entry.
-
-## Table of contents
+Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:44](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/dynamic-offline-data.ts#L44)
 
-### Offline Properties
+Represents the registration of a single dynamic offline data entry.
 
-- [id](DynamicOfflineData.md#id)
-- [identifier](DynamicOfflineData.md#identifier)
-- [syncState](DynamicOfflineData.md#syncstate)
-- [type](DynamicOfflineData.md#type)
-- [users](DynamicOfflineData.md#users)
+## Properties
 
-## Offline Properties
+### id?
 
-### id
+> `optional` **id**: `number`
 
-• `Optional` **id**: `number`
+Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/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.
 
-#### 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)
-
-___
+***
 
 ### identifier
 
-• **identifier**: `string`
+> **identifier**: `string`
+
+Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/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.
 
-#### 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)
+### syncState?
 
-___
+> `optional` **syncState**: [`DynamicOfflineDataSyncState`](DynamicOfflineDataSyncState.md)
 
-### 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/18d2874f03a33a6ab8295af0e87ac97fdd150718/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`.
 
-#### 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)
-
-___
+***
 
 ### type
 
-• **type**: `string`
+> **type**: `string`
+
+Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/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"`.
 
-#### 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)
-
-___
+***
 
 ### users
 
-• **users**: `string`[]
+> **users**: `string`[]
 
-The UUIDs of the users who need this data entry available offline.
-
-#### Defined in
+Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/dynamic-offline-data.ts#L62)
 
-[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,66 +1,51 @@
-[@openmrs/esm-framework](../API.md) / DynamicOfflineDataHandler
+[O3 Framework](../API.md) / DynamicOfflineDataHandler
 
 # Interface: DynamicOfflineDataHandler
 
-A handler for synchronizing dynamically declared offline data.
-Can be setup using the [setupDynamicOfflineDataHandler](../API.md#setupdynamicofflinedatahandler) function.
-
-## Table of contents
-
-### Offline Properties
-
-- [displayName](DynamicOfflineDataHandler.md#displayname)
-- [id](DynamicOfflineDataHandler.md#id)
-- [type](DynamicOfflineDataHandler.md#type)
+Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/dynamic-offline-data.ts#L10)
 
-### Methods
+A handler for synchronizing dynamically declared offline data.
+Can be setup using the [setupDynamicOfflineDataHandler](../functions/setupDynamicOfflineDataHandler.md) function.
 
-- [isSynced](DynamicOfflineDataHandler.md#issynced)
-- [sync](DynamicOfflineDataHandler.md#sync)
+## Properties
 
-## Offline Properties
+### displayName?
 
-### displayName
+> `optional` **displayName**: `string`
 
-• `Optional` **displayName**: `string`
+Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/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.
 
-#### 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)
-
-___
+***
 
 ### id
 
-• **id**: `string`
+> **id**: `string`
 
-A string uniquely identifying the handler.
-
-#### Defined in
+Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/dynamic-offline-data.ts#L14)
 
-[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`
+> **type**: `string`
+
+Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/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.
 
-#### 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)
-
 ## Methods
 
-### isSynced
+### isSynced()
 
-▸ **isSynced**(`identifier`, `abortSignal?`): `Promise`<`boolean`\>
+> **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/18d2874f03a33a6ab8295af0e87ac97fdd150718/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.
@@ -68,38 +53,46 @@ If `false`, the handler would have to (re-)sync the data in order for offline mo
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](DynamicOfflineData.md) for details. |
-| `abortSignal?` | `AbortSignal` | An {@link AbortSignal} which can be used to cancel the operation. |
+##### identifier
 
-#### Returns
+`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.
 
-`Promise`<`boolean`\>
+#### Returns
 
-#### Defined in
+`Promise`\<`boolean`\>
 
-[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)
+***
 
-___
+### sync()
 
-### sync
+> **sync**(`identifier`, `abortSignal?`): `Promise`\<`void`\>
 
-▸ **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/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/dynamic-offline-data.ts#L38)
 
 Synchronizes the given offline data.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `identifier` | `string` | The identifier of the offline data. See [DynamicOfflineData](DynamicOfflineData.md) for details. |
-| `abortSignal?` | `AbortSignal` | An {@link AbortSignal} which can be used to cancel the operation. |
+##### identifier
 
-#### Returns
+`string`
+
+The identifier of the offline data. See [DynamicOfflineData](DynamicOfflineData.md) for details.
 
-`Promise`<`void`\>
+##### abortSignal?
 
-#### Defined in
+`AbortSignal`
+
+An `AbortSignal` which can be used to cancel the operation.
+
+#### Returns
 
-[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)
+`Promise`\<`void`\>

package/docs/interfaces/DynamicOfflineDataSyncState.md

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