@openmrs/esm-framework 3.1.10-pre.92 → 3.1.11-pre.597

package/docs/interfaces/RetryOptions.md

@@ -0,0 +1,83 @@
+[@openmrs/esm-framework](../API.md) / RetryOptions
+
+# Interface: RetryOptions
+
+Options for configuring the behavior of the [retry](../API.md#retry) function.
+
+## Table of contents
+
+### Methods
+
+- [getDelay](RetryOptions.md#getdelay)
+- [onError](RetryOptions.md#onerror)
+- [shouldRetry](RetryOptions.md#shouldretry)
+
+## Methods
+
+### getDelay
+
+▸ `Optional` **getDelay**(`attempt`): `number`
+
+Calculates the next delay (in milliseconds) before a retry attempt.
+Returning a value for the inital attempt (`0`) delays the initial function invocation.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[packages/framework/esm-utils/src/retry.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L16)
+
+___
+
+### onError
+
+▸ `Optional` **onError**(`e`, `attempt`): `void`
+
+Called when invoking the function resulted in an error.
+Allows running side-effects on errors, e.g. logging.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `e` | `any` | The error thrown by the function. |
+| `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-utils/src/retry.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L23)
+
+___
+
+### shouldRetry
+
+▸ `Optional` **shouldRetry**(`attempt`): `any`
+
+Determines whether the retry function should retry executing the function after it failed
+with an error on the current attempt.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+[packages/framework/esm-utils/src/retry.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L10)

package/docs/interfaces/Role.md

@@ -0,0 +1,41 @@
+[@openmrs/esm-framework](../API.md) / Role
+
+# Interface: Role
+
+## Table of contents
+
+### Properties
+
+- [display](Role.md#display)
+- [links](Role.md#links)
+- [uuid](Role.md#uuid)
+
+## Properties
+
+### display
+
+• **display**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L55)
+
+___
+
+### links
+
+• **links**: `any`[]
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L56)
+
+___
+
+### uuid
+
+• **uuid**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L54)

package/docs/interfaces/SessionLocation.md

@@ -0,0 +1,41 @@
+[@openmrs/esm-framework](../API.md) / SessionLocation
+
+# Interface: SessionLocation
+
+## Table of contents
+
+### Properties
+
+- [display](SessionLocation.md#display)
+- [links](SessionLocation.md#links)
+- [uuid](SessionLocation.md#uuid)
+
+## Properties
+
+### display
+
+• **display**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L37)
+
+___
+
+### links
+
+• **links**: `any`[]
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L38)
+
+___
+
+### uuid
+
+• **uuid**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L36)

package/docs/interfaces/SessionUser.md

@@ -0,0 +1,92 @@
+[@openmrs/esm-framework](../API.md) / SessionUser
+
+# Interface: SessionUser
+
+## Table of contents
+
+### Properties
+
+- [allowedLocales](SessionUser.md#allowedlocales)
+- [authenticated](SessionUser.md#authenticated)
+- [currentProvider](SessionUser.md#currentprovider)
+- [locale](SessionUser.md#locale)
+- [sessionId](SessionUser.md#sessionid)
+- [sessionLocation](SessionUser.md#sessionlocation)
+- [user](SessionUser.md#user)
+
+## Properties
+
+### allowedLocales
+
+• **allowedLocales**: `string`[]
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L8)
+
+___
+
+### authenticated
+
+• **authenticated**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L9)
+
+___
+
+### currentProvider
+
+• **currentProvider**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `identifier` | `string` |
+| `uuid` | `string` |
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L13)
+
+___
+
+### locale
+
+• **locale**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L10)
+
+___
+
+### sessionId
+
+• **sessionId**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L11)
+
+___
+
+### sessionLocation
+
+• **sessionLocation**: `any`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L14)
+
+___
+
+### user
+
+• **user**: [`User`](User.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L12)

package/docs/interfaces/ShowNotificationEvent.md

@@ -0,0 +1,63 @@
+[@openmrs/esm-framework](../API.md) / ShowNotificationEvent
+
+# Interface: ShowNotificationEvent
+
+## Table of contents
+
+### Properties
+
+- [action](ShowNotificationEvent.md#action)
+- [description](ShowNotificationEvent.md#description)
+- [kind](ShowNotificationEvent.md#kind)
+- [millis](ShowNotificationEvent.md#millis)
+- [title](ShowNotificationEvent.md#title)
+
+## Properties
+
+### action
+
+• `Optional` **action**: `any`
+
+#### Defined in
+
+[packages/framework/esm-globals/src/events.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L61)
+
+___
+
+### description
+
+• **description**: `any`
+
+#### Defined in
+
+[packages/framework/esm-globals/src/events.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L52)
+
+___
+
+### kind
+
+• `Optional` **kind**: ``"error"`` \| ``"info"`` \| ``"info-square"`` \| ``"success"`` \| ``"warning"`` \| ``"warning-alt"``
+
+#### Defined in
+
+[packages/framework/esm-globals/src/events.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L53)
+
+___
+
+### millis
+
+• `Optional` **millis**: `number`
+
+#### Defined in
+
+[packages/framework/esm-globals/src/events.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L62)
+
+___
+
+### title
+
+• `Optional` **title**: `string`
+
+#### Defined in
+
+[packages/framework/esm-globals/src/events.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L60)

package/docs/interfaces/ShowToastEvent.md

@@ -0,0 +1,52 @@
+[@openmrs/esm-framework](../API.md) / ShowToastEvent
+
+# Interface: ShowToastEvent
+
+## Table of contents
+
+### Properties
+
+- [description](ShowToastEvent.md#description)
+- [kind](ShowToastEvent.md#kind)
+- [millis](ShowToastEvent.md#millis)
+- [title](ShowToastEvent.md#title)
+
+## Properties
+
+### description
+
+• **description**: `any`
+
+#### Defined in
+
+[packages/framework/esm-globals/src/events.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L66)
+
+___
+
+### kind
+
+• `Optional` **kind**: ``"error"`` \| ``"info"`` \| ``"info-square"`` \| ``"success"`` \| ``"warning"`` \| ``"warning-alt"``
+
+#### Defined in
+
+[packages/framework/esm-globals/src/events.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L67)
+
+___
+
+### millis
+
+• `Optional` **millis**: `number`
+
+#### Defined in
+
+[packages/framework/esm-globals/src/events.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L75)
+
+___
+
+### title
+
+• `Optional` **title**: `string`
+
+#### Defined in
+
+[packages/framework/esm-globals/src/events.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/events.ts#L74)

package/docs/interfaces/SpaConfig.md

@@ -0,0 +1,77 @@
+[@openmrs/esm-framework](../API.md) / SpaConfig
+
+# Interface: SpaConfig
+
+## Table of contents
+
+### Properties
+
+- [apiUrl](SpaConfig.md#apiurl)
+- [configUrls](SpaConfig.md#configurls)
+- [env](SpaConfig.md#env)
+- [offline](SpaConfig.md#offline)
+- [spaPath](SpaConfig.md#spapath)
+
+## Properties
+
+### apiUrl
+
+• **apiUrl**: `string`
+
+The base path or URL for the OpenMRS API / endpoints.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L57)
+
+___
+
+### configUrls
+
+• `Optional` **configUrls**: `string`[]
+
+URLs of configurations to load in the system.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L70)
+
+___
+
+### env
+
+• `Optional` **env**: [`SpaEnvironment`](../API.md#spaenvironment)
+
+The environment to use.
+
+**`default`** production
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L66)
+
+___
+
+### offline
+
+• `Optional` **offline**: `boolean`
+
+Defines if offline should be supported by installing a service worker.
+
+**`default`** true
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L75)
+
+___
+
+### spaPath
+
+• **spaPath**: `string`
+
+The base path for the SPA root path.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L61)

package/docs/interfaces/SyncItem.md

@@ -0,0 +1,92 @@
+[@openmrs/esm-framework](../API.md) / SyncItem
+
+# Interface: SyncItem
+
+## Table of contents
+
+### Properties
+
+- [content](SyncItem.md#content)
+- [createdOn](SyncItem.md#createdon)
+- [descriptor](SyncItem.md#descriptor)
+- [id](SyncItem.md#id)
+- [lastError](SyncItem.md#lasterror)
+- [type](SyncItem.md#type)
+- [userId](SyncItem.md#userid)
+
+## Properties
+
+### content
+
+• **content**: `any`
+
+#### 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)
+
+___
+
+### createdOn
+
+• **createdOn**: `Date`
+
+#### 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)
+
+___
+
+### descriptor
+
+• **descriptor**: [`QueueItemDescriptor`](QueueItemDescriptor.md)
+
+#### 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)
+
+___
+
+### id
+
+• `Optional` **id**: `number`
+
+#### 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)
+
+___
+
+### lastError
+
+• `Optional` **lastError**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `message?` | `string` |
+| `name?` | `string` |
+
+#### 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)
+
+___
+
+### type
+
+• **type**: `string`
+
+#### 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)
+
+___
+
+### userId
+
+• **userId**: `string`
+
+#### 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)

package/docs/interfaces/SyncProcessOptions.md

@@ -0,0 +1,69 @@
+[@openmrs/esm-framework](../API.md) / SyncProcessOptions
+
+# Interface: SyncProcessOptions<T\>
+
+## Type parameters
+
+| Name |
+| :------ |
+| `T` |
+
+## Table of contents
+
+### Properties
+
+- [abort](SyncProcessOptions.md#abort)
+- [dependencies](SyncProcessOptions.md#dependencies)
+- [index](SyncProcessOptions.md#index)
+- [items](SyncProcessOptions.md#items)
+- [userId](SyncProcessOptions.md#userid)
+
+## Properties
+
+### abort
+
+• **abort**: `AbortController`
+
+#### Defined in
+
+[packages/framework/esm-offline/src/sync.ts:256](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L256)
+
+___
+
+### dependencies
+
+• **dependencies**: `any`[]
+
+#### Defined in
+
+[packages/framework/esm-offline/src/sync.ts:260](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L260)
+
+___
+
+### index
+
+• **index**: `number`
+
+#### Defined in
+
+[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)
+
+___
+
+### items
+
+• **items**: `T`[]
+
+#### Defined in
+
+[packages/framework/esm-offline/src/sync.ts:259](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L259)
+
+___
+
+### userId
+
+• **userId**: `string`
+
+#### Defined in
+
+[packages/framework/esm-offline/src/sync.ts:257](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L257)

package/docs/interfaces/UnauthenticatedUser.md

@@ -0,0 +1,52 @@
+[@openmrs/esm-framework](../API.md) / UnauthenticatedUser
+
+# Interface: UnauthenticatedUser
+
+## Table of contents
+
+### Properties
+
+- [authenticated](UnauthenticatedUser.md#authenticated)
+- [sessionId](UnauthenticatedUser.md#sessionid)
+- [sessionLocation](UnauthenticatedUser.md#sessionlocation)
+- [user](UnauthenticatedUser.md#user)
+
+## Properties
+
+### authenticated
+
+• **authenticated**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L30)
+
+___
+
+### sessionId
+
+• **sessionId**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L29)
+
+___
+
+### sessionLocation
+
+• `Optional` **sessionLocation**: [`SessionLocation`](SessionLocation.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L32)
+
+___
+
+### user
+
+• `Optional` **user**: [`LoggedInUser`](LoggedInUser.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/user-resource.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L31)