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

package/docs/interfaces/DisplayConditionsConfigObject.md

@@ -1,45 +1,60 @@
-[O3 Framework](../API.md) / DisplayConditionsConfigObject
+[@openmrs/esm-framework](../API.md) / DisplayConditionsConfigObject
 
 # Interface: DisplayConditionsConfigObject
 
-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)
+## Table of contents
 
-## Properties
+### Properties
+
+- [expression](DisplayConditionsConfigObject.md#expression)
+- [offline](DisplayConditionsConfigObject.md#offline)
+- [online](DisplayConditionsConfigObject.md#online)
+- [privileges](DisplayConditionsConfigObject.md#privileges)
 
-### expression?
+## Properties
 
-> `optional` **expression**: `string`
+### expression
 
-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)
+• `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/main/packages/framework/esm-config/src/types.ts#L39)
 
-### offline?
+___
 
-> `optional` **offline**: `boolean`
+### offline
 
-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)
+• `Optional` **offline**: `boolean`
 
 Whether to display this extension when not connected to the server
 
-***
+#### Defined in
 
-### online?
+[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)
 
-> `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)
+### online
+
+• `Optional` **online**: `boolean`
 
 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?
+___
 
-> `optional` **privileges**: `string`[]
+### privileges
 
-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)
+• `Optional` **privileges**: `string`[]
 
 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,60 +1,78 @@
-[O3 Framework](../API.md) / DynamicOfflineData
+[@openmrs/esm-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/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/dynamic-offline-data.ts#L44)
-
 Represents the registration of a single dynamic offline data entry.
 
-## Properties
+## Table of contents
+
+### Offline Properties
 
-### id?
+- [id](DynamicOfflineData.md#id)
+- [identifier](DynamicOfflineData.md#identifier)
+- [syncState](DynamicOfflineData.md#syncstate)
+- [type](DynamicOfflineData.md#type)
+- [users](DynamicOfflineData.md#users)
 
-> `optional` **id**: `number`
+## Offline Properties
 
-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)
+### id
+
+• `Optional` **id**: `number`
 
 The internal ID of the data entry, as assigned by the IndexedDB where it is stored.
 
-***
+#### Defined in
 
-### identifier
+[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**: `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)
+### identifier
+
+• **identifier**: `string`
 
 The externally provided identifier of the data entry.
 This is typically the ID of the resource as assigned by a remote API.
 
-***
+#### Defined in
 
-### syncState?
+[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)
 
-> `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)
+### syncState
+
+• `Optional` **syncState**: [`DynamicOfflineDataSyncState`](DynamicOfflineDataSyncState.md)
 
 If this entry has already been synced, returns the result of that last sync attempt.
 Otherwise this is `undefined`.
 
-***
+#### Defined in
 
-### type
+[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**: `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)
+### type
+
+• **type**: `string`
 
 The underlying type used for categorizing the data entry.
 Examples could be `"patient"` or `"form"`.
 
-***
+#### Defined in
 
-### users
+[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**: `string`[]
+___
 
-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)
+### users
+
+• **users**: `string`[]
 
 The UUIDs of the users who need this data entry available offline.
+
+#### 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)

package/docs/interfaces/DynamicOfflineDataHandler.md

@@ -1,51 +1,66 @@
-[O3 Framework](../API.md) / DynamicOfflineDataHandler
+[@openmrs/esm-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/18d2874f03a33a6ab8295af0e87ac97fdd150718/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.
+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)
 
-## Properties
+### Methods
 
-### displayName?
+- [isSynced](DynamicOfflineDataHandler.md#issynced)
+- [sync](DynamicOfflineDataHandler.md#sync)
 
-> `optional` **displayName**: `string`
+## Offline Properties
 
-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)
+### displayName
+
+• `Optional` **displayName**: `string`
 
 A human-readable string representing the handler.
 If provided, the handler can be rendered in the UI using that string.
 
-***
+#### Defined in
 
-### id
+[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**: `string`
+___
 
-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)
+### id
+
+• **id**: `string`
 
 A string uniquely identifying the handler.
 
-***
+#### Defined in
 
-### type
+[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)
+
+___
 
-> **type**: `string`
+### type
 
-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)
+• **type**: `string`
 
 The type of offline data handled by this handler.
 See [DynamicOfflineData.type](DynamicOfflineData.md#type) for details.
 
-## Methods
+#### Defined in
 
-### isSynced()
+[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)
 
-> **isSynced**(`identifier`, `abortSignal?`): `Promise`\<`boolean`\>
+## Methods
 
-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)
+### isSynced
+
+▸ **isSynced**(`identifier`, `abortSignal?`): `Promise`<`boolean`\>
 
 Evaluates whether the given offline data is correctly synced at this point in time from the perspective
 of this single handler.
@@ -53,46 +68,38 @@ If `false`, the handler would have to (re-)sync the data in order for offline mo
 
 #### 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.
+| 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. |
 
 #### Returns
 
-`Promise`\<`boolean`\>
+`Promise`<`boolean`\>
 
-***
+#### Defined in
 
-### sync()
+[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**(`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)
+### sync
+
+▸ **sync**(`identifier`, `abortSignal?`): `Promise`<`void`\>
 
 Synchronizes the given offline data.
 
 #### Parameters
 
-##### identifier
-
-`string`
-
-The identifier of the offline data. See [DynamicOfflineData](DynamicOfflineData.md) for details.
+| 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. |
 
-##### abortSignal?
-
-`AbortSignal`
+#### Returns
 
-An `AbortSignal` which can be used to cancel the operation.
+`Promise`<`void`\>
 
-#### Returns
+#### Defined in
 
-`Promise`\<`void`\>
+[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)

package/docs/interfaces/DynamicOfflineDataSyncState.md

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