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

package/docs/functions/getDynamicOfflineDataHandlers.md

@@ -1,13 +0,0 @@
-[O3 Framework](../API.md) / getDynamicOfflineDataHandlers
-
-# Function: getDynamicOfflineDataHandlers()
-
-> **getDynamicOfflineDataHandlers**(): [`DynamicOfflineDataHandler`](../interfaces/DynamicOfflineDataHandler.md)[]
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:104](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/dynamic-offline-data.ts#L104)
-
-Returns all handlers which have been setup using the [setupDynamicOfflineDataHandler](setupDynamicOfflineDataHandler.md) function.
-
-## Returns
-
-[`DynamicOfflineDataHandler`](../interfaces/DynamicOfflineDataHandler.md)[]

package/docs/functions/getExtensionNameFromId.md

@@ -1,30 +0,0 @@
-[O3 Framework](../API.md) / getExtensionNameFromId
-
-# Function: getExtensionNameFromId()
-
-> **getExtensionNameFromId**(`extensionId`): `string`
-
-Defined in: [packages/framework/esm-extensions/src/extensions.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/extensions.ts#L163)
-
-Given an extension ID, which is a string uniquely identifying
-an instance of an extension within an extension slot, this
-returns the extension name.
-
-## Parameters
-
-### extensionId
-
-`string`
-
-## Returns
-
-`string`
-
-## Example
-
-```js
-getExtensionNameFromId("foo#bar")
- --> "foo"
-getExtensionNameFromId("baz")
- --> "baz"
-```

package/docs/functions/getExtensionStore.md

@@ -1,14 +0,0 @@
-[O3 Framework](../API.md) / getExtensionStore
-
-# Function: getExtensionStore()
-
-> **getExtensionStore**(): `StoreApi`\<[`ExtensionStore`](../interfaces/ExtensionStore.md)\>
-
-Defined in: [packages/framework/esm-extensions/src/store.ts:125](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/store.ts#L125)
-
-This returns a store that modules can use to get information about the
-state of the extension system.
-
-## Returns
-
-`StoreApi`\<[`ExtensionStore`](../interfaces/ExtensionStore.md)\>

package/docs/functions/getFeatureFlag.md

@@ -1,21 +0,0 @@
-[O3 Framework](../API.md) / getFeatureFlag
-
-# Function: getFeatureFlag()
-
-> **getFeatureFlag**(`flagName`): `boolean`
-
-Defined in: [packages/framework/esm-feature-flags/src/feature-flags.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-feature-flags/src/feature-flags.ts#L87)
-
-Use this function to access the current value of the feature flag
-
-If you are using React, use `useFeatureFlag` instead.
-
-## Parameters
-
-### flagName
-
-`string`
-
-## Returns
-
-`boolean`

package/docs/functions/getFhirServerPaginationHandlers.md

@@ -1,17 +0,0 @@
-[O3 Framework](../API.md) / getFhirServerPaginationHandlers
-
-# Function: getFhirServerPaginationHandlers()
-
-> **getFhirServerPaginationHandlers**\<`T`\>(): `FhirServerPaginationHandlers`\<`T`\>
-
-Defined in: [packages/framework/esm-react-utils/src/useFhirPagination.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useFhirPagination.ts#L36)
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Returns
-
-`FhirServerPaginationHandlers`\<`T`\>

package/docs/functions/getFullSynchronizationItems.md

@@ -1,27 +0,0 @@
-[O3 Framework](../API.md) / getFullSynchronizationItems
-
-# Function: getFullSynchronizationItems()
-
-> **getFullSynchronizationItems**\<`T`\>(`type?`): `Promise`\<[`SyncItem`](../interfaces/SyncItem.md)\<`T`\>[]\>
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:302](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L302)
-
-Returns all currently queued up sync items of the currently signed in user.
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### type?
-
-`string`
-
-The identifying type of the synchronization items to be returned.
-
-## Returns
-
-`Promise`\<[`SyncItem`](../interfaces/SyncItem.md)\<`T`\>[]\>

package/docs/functions/getFullSynchronizationItemsFor.md

@@ -1,33 +0,0 @@
-[O3 Framework](../API.md) / getFullSynchronizationItemsFor
-
-# Function: getFullSynchronizationItemsFor()
-
-> **getFullSynchronizationItemsFor**\<`T`\>(`userId`, `type?`): `Promise`\<[`SyncItem`](../interfaces/SyncItem.md)\<`T`\>[]\>
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:281](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L281)
-
-Returns all currently queued up sync items of a given user.
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### 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
-
-`Promise`\<[`SyncItem`](../interfaces/SyncItem.md)\<`T`\>[]\>

package/docs/functions/getGlobalStore.md

@@ -1,36 +0,0 @@
-[O3 Framework](../API.md) / getGlobalStore
-
-# Function: getGlobalStore()
-
-> **getGlobalStore**\<`T`\>(`name`, `fallbackState?`): `StoreApi`\<`T`\>
-
-Defined in: [packages/framework/esm-state/src/state.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-state/src/state.ts#L92)
-
-Returns the existing store named `name`,
-or creates a new store named `name` if none exists.
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### name
-
-`string`
-
-The name of the store to look up.
-
-### fallbackState?
-
-`T`
-
-The initial value of the new store if no store named `name` exists.
-
-## Returns
-
-`StoreApi`\<`T`\>
-
-The found or newly created store.

package/docs/functions/getHistory.md

@@ -1,13 +0,0 @@
-[O3 Framework](../API.md) / getHistory
-
-# Function: getHistory()
-
-> **getHistory**(): `string`[]
-
-Defined in: [packages/framework/esm-navigation/src/history/history.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-navigation/src/history/history.ts#L47)
-
-Returns a list of URLs representing the history of the current window session.
-
-## Returns
-
-`string`[]

package/docs/functions/getLifecycle.md

@@ -1,27 +0,0 @@
-[O3 Framework](../API.md) / getLifecycle
-
-# Function: getLifecycle()
-
-> **getLifecycle**\<`T`\>(`Component`, `options`): `ReactAppOrParcel`\<`T`\>
-
-Defined in: [packages/framework/esm-react-utils/src/getLifecycle.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/getLifecycle.ts#L10)
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### Component
-
-`ComponentType`\<`T`\>
-
-### options
-
-`ComponentDecoratorOptions`
-
-## Returns
-
-`ReactAppOrParcel`\<`T`\>

package/docs/functions/getLocale.md

@@ -1,15 +0,0 @@
-[O3 Framework](../API.md) / getLocale
-
-# Function: getLocale()
-
-> **getLocale**(): `string`
-
-Defined in: packages/framework/esm-utils/dist/get-locale.d.ts:5
-
-Returns the current locale of the application.
-
-## Returns
-
-`string`
-
-string

package/docs/functions/getLocations.md

@@ -1,21 +0,0 @@
-[O3 Framework](../API.md) / getLocations
-
-# Function: getLocations()
-
-> **getLocations**(`tagUuidOrName`, `query`): `Observable`\<[`Location`](../interfaces/Location.md)[]\>
-
-Defined in: [packages/framework/esm-emr-api/src/location.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/location.ts#L14)
-
-## Parameters
-
-### tagUuidOrName
-
-`null` | `string`
-
-### query
-
-`null` | `string`
-
-## Returns
-
-`Observable`\<[`Location`](../interfaces/Location.md)[]\>

package/docs/functions/getLoggedInUser.md

@@ -1,11 +0,0 @@
-[O3 Framework](../API.md) / getLoggedInUser
-
-# Function: getLoggedInUser()
-
-> **getLoggedInUser**(): `Promise`\<[`LoggedInUser`](../interfaces/LoggedInUser.md)\>
-
-Defined in: [packages/framework/esm-api/src/current-user.ts:201](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/current-user.ts#L201)
-
-## Returns
-
-`Promise`\<[`LoggedInUser`](../interfaces/LoggedInUser.md)\>

package/docs/functions/getOfflinePatientDataStore.md

@@ -1,15 +0,0 @@
-[O3 Framework](../API.md) / getOfflinePatientDataStore
-
-# Function: ~~getOfflinePatientDataStore()~~
-
-> **getOfflinePatientDataStore**(): `StoreApi`\<[`OfflinePatientDataSyncStore`](../interfaces/OfflinePatientDataSyncStore.md)\>
-
-Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/offline-patient-data.ts#L39)
-
-## Returns
-
-`StoreApi`\<[`OfflinePatientDataSyncStore`](../interfaces/OfflinePatientDataSyncStore.md)\>
-
-## Deprecated
-
-Will be removed once all modules have been migrated to the new dynamic offline data API.

package/docs/functions/getPatientName.md

@@ -1,26 +0,0 @@
-[O3 Framework](../API.md) / getPatientName
-
-# Function: getPatientName()
-
-> **getPatientName**(`patient`): `string`
-
-Defined in: packages/framework/esm-utils/dist/patient-helpers.d.ts:12
-
-Gets the formatted display name for a patient.
-
-The display name will be taken from the patient's 'usual' name,
-or may fall back to the patient's 'official' name.
-
-## Parameters
-
-### patient
-
-`Patient`
-
-The patient details in FHIR format.
-
-## Returns
-
-`string`
-
-The patient's display name or an empty string if name is not present.

package/docs/functions/getSessionLocation.md

@@ -1,11 +0,0 @@
-[O3 Framework](../API.md) / getSessionLocation
-
-# Function: getSessionLocation()
-
-> **getSessionLocation**(): `Promise`\<`undefined` \| [`SessionLocation`](../interfaces/SessionLocation.md)\>
-
-Defined in: [packages/framework/esm-api/src/current-user.ts:219](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/current-user.ts#L219)
-
-## Returns
-
-`Promise`\<`undefined` \| [`SessionLocation`](../interfaces/SessionLocation.md)\>

package/docs/functions/getSessionStore.md

@@ -1,11 +0,0 @@
-[O3 Framework](../API.md) / getSessionStore
-
-# Function: getSessionStore()
-
-> **getSessionStore**(): `StoreApi`\<[`SessionStore`](../type-aliases/SessionStore.md)\>
-
-Defined in: [packages/framework/esm-api/src/current-user.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/current-user.ts#L93)
-
-## Returns
-
-`StoreApi`\<[`SessionStore`](../type-aliases/SessionStore.md)\>

package/docs/functions/getSyncLifecycle.md

@@ -1,31 +0,0 @@
-[O3 Framework](../API.md) / getSyncLifecycle
-
-# Function: getSyncLifecycle()
-
-> **getSyncLifecycle**\<`T`\>(`Component`, `options`): () => `Promise`\<`ReactAppOrParcel`\<`T`\>\>
-
-Defined in: [packages/framework/esm-react-utils/src/getLifecycle.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/getLifecycle.ts#L25)
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### Component
-
-`ComponentType`\<`T`\>
-
-### options
-
-`ComponentDecoratorOptions`
-
-## Returns
-
-> (): `Promise`\<`ReactAppOrParcel`\<`T`\>\>
-
-### Returns
-
-`Promise`\<`ReactAppOrParcel`\<`T`\>\>

package/docs/functions/getSynchronizationItem.md

@@ -1,27 +0,0 @@
-[O3 Framework](../API.md) / getSynchronizationItem
-
-# Function: getSynchronizationItem()
-
-> **getSynchronizationItem**\<`T`\>(`id`): `Promise`\<`undefined` \| [`SyncItem`](../interfaces/SyncItem.md)\<`T`\>\>
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:311](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L311)
-
-Returns a queued sync item with the given ID or `undefined` if no such item exists.
-
-## Type Parameters
-
-### T
-
-`T` = `any`
-
-## Parameters
-
-### id
-
-`number`
-
-The ID of the requested sync item.
-
-## Returns
-
-`Promise`\<`undefined` \| [`SyncItem`](../interfaces/SyncItem.md)\<`T`\>\>

package/docs/functions/getSynchronizationItems.md

@@ -1,27 +0,0 @@
-[O3 Framework](../API.md) / getSynchronizationItems
-
-# Function: getSynchronizationItems()
-
-> **getSynchronizationItems**\<`T`\>(`type?`): `Promise`\<`T`[]\>
-
-Defined in: [packages/framework/esm-offline/src/sync.ts:293](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/sync.ts#L293)
-
-Returns the content of all currently queued up sync items of the currently signed in user.
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### type?
-
-`string`
-
-The identifying type of the synchronization items to be returned.
-
-## Returns
-
-`Promise`\<`T`[]\>

package/docs/functions/getVisitStore.md

@@ -1,11 +0,0 @@
-[O3 Framework](../API.md) / getVisitStore
-
-# Function: getVisitStore()
-
-> **getVisitStore**(): `StoreApi`\<[`VisitStoreState`](../interfaces/VisitStoreState.md)\>
-
-Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/visit-utils.ts#L57)
-
-## Returns
-
-`StoreApi`\<[`VisitStoreState`](../interfaces/VisitStoreState.md)\>

package/docs/functions/getVisitTypes.md

@@ -1,11 +0,0 @@
-[O3 Framework](../API.md) / getVisitTypes
-
-# Function: getVisitTypes()
-
-> **getVisitTypes**(): `Observable`\<[`VisitType`](../interfaces/VisitType.md)[]\>
-
-Defined in: [packages/framework/esm-emr-api/src/visit-type.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/visit-type.ts#L15)
-
-## Returns
-
-`Observable`\<[`VisitType`](../interfaces/VisitType.md)[]\>

package/docs/functions/getVisitsForPatient.md

@@ -1,29 +0,0 @@
-[O3 Framework](../API.md) / getVisitsForPatient
-
-# Function: ~~getVisitsForPatient()~~
-
-> **getVisitsForPatient**(`patientUuid`, `abortController`, `v?`): `Promise`\<`FetchResponse`\<\{ `results`: [`Visit`](../interfaces/Visit.md)[]; \}\>\>
-
-Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:110](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/visit-utils.ts#L110)
-
-## Parameters
-
-### patientUuid
-
-`string`
-
-### abortController
-
-`AbortController`
-
-### v?
-
-`string`
-
-## Returns
-
-`Promise`\<`FetchResponse`\<\{ `results`: [`Visit`](../interfaces/Visit.md)[]; \}\>\>
-
-## Deprecated
-
-Use the `useVisit` hook instead.

package/docs/functions/goBackInHistory.md

@@ -1,25 +0,0 @@
-[O3 Framework](../API.md) / goBackInHistory
-
-# Function: goBackInHistory()
-
-> **goBackInHistory**(`toUrl:`): `void`
-
-Defined in: [packages/framework/esm-navigation/src/history/history.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-navigation/src/history/history.ts#L58)
-
-Rolls back the history to the specified point and navigates to that URL.
-
-## Parameters
-
-### toUrl:
-
-The URL in the history to navigate to. History after that index
-will be deleted. If the URL is not found in the history, an error will be
-thrown.
-
-#### toUrl
-
-`string`
-
-## Returns
-
-`void`

package/docs/functions/importDynamic.md

@@ -1,58 +0,0 @@
-[O3 Framework](../API.md) / importDynamic
-
-# Function: importDynamic()
-
-> **importDynamic**\<`T`\>(`jsPackage`, `share`, `options?`): `Promise`\<`T`\>
-
-Defined in: [packages/framework/esm-dynamic-loading/src/dynamic-loading.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-dynamic-loading/src/dynamic-loading.ts#L37)
-
-Loads the named export from a named package. This might be used like:
-
-```js
-const { someComponent } = importDynamic("@openmrs/esm-template-app")
-```
-
-## Type Parameters
-
-### T
-
-`T` = `any`
-
-## Parameters
-
-### jsPackage
-
-`string`
-
-The package to load the export from.
-
-### share
-
-`string` = `'./start'`
-
-Indicates the name of the shared module; this is an advanced feature if the package you are loading
-  doesn't use the default OpenMRS shared module name "./start".
-
-### options?
-
-Additional options to control loading this script.
-
-#### importMap?
-
-[`ImportMap`](../interfaces/ImportMap.md)
-
-The import map to use to load the script. This is useful for situations where you're
-  loading multiple scripts at a time, since it allows the calling code to supply an importMap, saving multiple
-  calls to `getCurrentImportMap()`.
-
-#### maxLoadingTime?
-
-`number`
-
-A positive integer representing the maximum number of milliseconds to wait for the
-  script to load before the promise returned from this function will be rejected. Defaults to 600,000 milliseconds,
-  i.e., 10 minutes.
-
-## Returns
-
-`Promise`\<`T`\>

package/docs/functions/inRange.md

@@ -1,27 +0,0 @@
-[O3 Framework](../API.md) / inRange
-
-# Function: inRange()
-
-> **inRange**(`min`, `max`): [`Validator`](../type-aliases/Validator.md)
-
-Defined in: [packages/framework/esm-config/src/validators/validators.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/validators/validators.ts#L10)
-
-Verifies that the value is between the provided minimum and maximum
-
-## Parameters
-
-### min
-
-`number`
-
-Minimum acceptable value
-
-### max
-
-`number`
-
-Maximum acceptable value
-
-## Returns
-
-[`Validator`](../type-aliases/Validator.md)

package/docs/functions/interpolateString.md

@@ -1,34 +0,0 @@
-[O3 Framework](../API.md) / interpolateString
-
-# Function: interpolateString()
-
-> **interpolateString**(`template`, `params`): `string`
-
-Defined in: [packages/framework/esm-navigation/src/navigation/interpolate-string.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-navigation/src/navigation/interpolate-string.ts#L60)
-
-Interpolates values of `params` into the `template` string.
-
-Example usage:
-```js
-interpolateString("test ${one} ${two} 3", {
-   one: "1",
-   two: "2",
-}); // will return "test 1 2 3"
-interpolateString("test ok", { one: "1", two: "2" }) // will return "test ok"
-```
-
-## Parameters
-
-### template
-
-`string`
-
-With optional params wrapped in `${ }`
-
-### params
-
-Values to interpolate into the string template
-
-## Returns
-
-`string`