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

package/docs/functions/showNotification.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / showNotification
+
+# Function: showNotification()
+
+> **showNotification**(`notification`): `void`
+
+Defined in: [packages/framework/esm-styleguide/src/notifications/index.tsx:43](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/notifications/index.tsx#L43)
+
+Displays an inline notification in the UI.
+
+## Parameters
+
+### notification
+
+[`NotificationDescriptor`](../interfaces/NotificationDescriptor.md)
+
+The description of the notification to display.
+
+## Returns
+
+`void`

package/docs/functions/showSnackbar.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / showSnackbar
+
+# Function: showSnackbar()
+
+> **showSnackbar**(`snackbar`): `void`
+
+Defined in: [packages/framework/esm-styleguide/src/snackbars/index.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/snackbars/index.tsx#L32)
+
+Displays a snack bar notification in the UI.
+
+## Parameters
+
+### snackbar
+
+[`SnackbarDescriptor`](../interfaces/SnackbarDescriptor.md)
+
+The description of the snack bar to display.
+
+## Returns
+
+`void`

package/docs/functions/showToast.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / showToast
+
+# Function: showToast()
+
+> **showToast**(`toast`): `void`
+
+Defined in: [packages/framework/esm-styleguide/src/toasts/index.tsx:36](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/toasts/index.tsx#L36)
+
+Displays a toast notification in the UI.
+
+## Parameters
+
+### toast
+
+[`ToastDescriptor`](../interfaces/ToastDescriptor.md)
+
+The description of the toast to display.
+
+## Returns
+
+`void`

package/docs/functions/subscribeActionableNotificationShown.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / subscribeActionableNotificationShown
+
+# Function: subscribeActionableNotificationShown()
+
+> **subscribeActionableNotificationShown**(`cb`): () => `void`
+
+Defined in: packages/framework/esm-globals/dist/events.d.ts:60
+
+## Parameters
+
+### cb
+
+(`data`) => `void`
+
+## Returns
+
+> (): `void`
+
+### Returns
+
+`void`

package/docs/functions/subscribeConnectivity.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / subscribeConnectivity
+
+# Function: subscribeConnectivity()
+
+> **subscribeConnectivity**(`cb`): () => `void`
+
+Defined in: packages/framework/esm-globals/dist/events.d.ts:9
+
+## Parameters
+
+### cb
+
+(`ev`) => `void`
+
+## Returns
+
+> (): `void`
+
+### Returns
+
+`void`

package/docs/functions/subscribeConnectivityChanged.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / subscribeConnectivityChanged
+
+# Function: subscribeConnectivityChanged()
+
+> **subscribeConnectivityChanged**(`cb`): () => `void`
+
+Defined in: packages/framework/esm-globals/dist/events.d.ts:7
+
+## Parameters
+
+### cb
+
+(`ev`) => `void`
+
+## Returns
+
+> (): `void`
+
+### Returns
+
+`void`

package/docs/functions/subscribeNotificationShown.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / subscribeNotificationShown
+
+# Function: subscribeNotificationShown()
+
+> **subscribeNotificationShown**(`cb`): () => `void`
+
+Defined in: packages/framework/esm-globals/dist/events.d.ts:58
+
+## Parameters
+
+### cb
+
+(`data`) => `void`
+
+## Returns
+
+> (): `void`
+
+### Returns
+
+`void`

package/docs/functions/subscribePrecacheStaticDependencies.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / subscribePrecacheStaticDependencies
+
+# Function: subscribePrecacheStaticDependencies()
+
+> **subscribePrecacheStaticDependencies**(`cb`): () => `void`
+
+Defined in: packages/framework/esm-globals/dist/events.d.ts:14
+
+## Parameters
+
+### cb
+
+(`data`) => `void`
+
+## Returns
+
+> (): `void`
+
+### Returns
+
+`void`

package/docs/functions/subscribeSnackbarShown.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / subscribeSnackbarShown
+
+# Function: subscribeSnackbarShown()
+
+> **subscribeSnackbarShown**(`cb`): () => `void`
+
+Defined in: packages/framework/esm-globals/dist/events.d.ts:64
+
+## Parameters
+
+### cb
+
+(`data`) => `void`
+
+## Returns
+
+> (): `void`
+
+### Returns
+
+`void`

package/docs/functions/subscribeTo.md

@@ -0,0 +1,75 @@
+[O3 Framework](../API.md) / subscribeTo
+
+# Function: subscribeTo()
+
+## Call Signature
+
+> **subscribeTo**\<`T`, `U`\>(`store`, `handle`): () => `void`
+
+Defined in: [packages/framework/esm-state/src/state.ts:109](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-state/src/state.ts#L109)
+
+### Type Parameters
+
+#### T
+
+`T`
+
+#### U
+
+`U` = `T`
+
+### Parameters
+
+#### store
+
+`StoreApi`\<`T`\>
+
+#### handle
+
+(`state`) => `void`
+
+### Returns
+
+> (): `void`
+
+#### Returns
+
+`void`
+
+## Call Signature
+
+> **subscribeTo**\<`T`, `U`\>(`store`, `select`, `handle`): () => `void`
+
+Defined in: [packages/framework/esm-state/src/state.ts:110](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-state/src/state.ts#L110)
+
+### Type Parameters
+
+#### T
+
+`T`
+
+#### U
+
+`U`
+
+### Parameters
+
+#### store
+
+`StoreApi`\<`T`\>
+
+#### select
+
+(`state`) => `U`
+
+#### handle
+
+(`subState`) => `void`
+
+### Returns
+
+> (): `void`
+
+#### Returns
+
+`void`

package/docs/functions/subscribeToContext.md

@@ -0,0 +1,39 @@
+[O3 Framework](../API.md) / subscribeToContext
+
+# Function: subscribeToContext()
+
+> **subscribeToContext**\<`T`\>(`namespace`, `callback`): () => `void`
+
+Defined in: [packages/framework/esm-context/src/context.ts:104](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-context/src/context.ts#L104)
+
+Subscribes to updates of a given namespace. Note that the returned object is immutable.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object` = \{ \}
+
+## Parameters
+
+### namespace
+
+`string`
+
+the namespace to subscribe to
+
+### callback
+
+[`ContextCallback`](../type-aliases/ContextCallback.md)\<`T`\>
+
+a function invoked with the current context whenever
+
+## Returns
+
+A function to unsubscribe from the context
+
+> (): `void`
+
+### Returns
+
+`void`

package/docs/functions/subscribeToastShown.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / subscribeToastShown
+
+# Function: subscribeToastShown()
+
+> **subscribeToastShown**(`cb`): () => `void`
+
+Defined in: packages/framework/esm-globals/dist/events.d.ts:62
+
+## Parameters
+
+### cb
+
+(`data`) => `void`
+
+## Returns
+
+> (): `void`
+
+### Returns
+
+`void`

package/docs/functions/syncAllDynamicOfflineData.md

@@ -0,0 +1,27 @@
+[O3 Framework](../API.md) / syncAllDynamicOfflineData
+
+# Function: syncAllDynamicOfflineData()
+
+> **syncAllDynamicOfflineData**(`type`, `abortSignal?`): `Promise`\<`void`\>
+
+Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:241](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/dynamic-offline-data.ts#L241)
+
+Synchronizes all offline data entries of the given [type](#syncalldynamicofflinedata) for the currently logged in user.
+
+## Parameters
+
+### type
+
+`string`
+
+The type of the offline data. See [DynamicOfflineData](../interfaces/DynamicOfflineData.md) for details.
+
+### abortSignal?
+
+`AbortSignal`
+
+An `AbortSignal` which can be used to cancel the operation.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/functions/syncDynamicOfflineData.md

@@ -0,0 +1,33 @@
+[O3 Framework](../API.md) / syncDynamicOfflineData
+
+# Function: syncDynamicOfflineData()
+
+> **syncDynamicOfflineData**(`type`, `identifier`, `abortSignal?`): `Promise`\<`void`\>
+
+Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:254](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/dynamic-offline-data.ts#L254)
+
+Synchronizes a single offline data entry of the given [type](#syncdynamicofflinedata) for the currently logged in user.
+
+## Parameters
+
+### type
+
+`string`
+
+The type of the offline data. See [DynamicOfflineData](../interfaces/DynamicOfflineData.md) for details.
+
+### identifier
+
+`string`
+
+The identifier of the offline data. See [DynamicOfflineData](../interfaces/DynamicOfflineData.md) for details.
+
+### abortSignal?
+
+`AbortSignal`
+
+An `AbortSignal` which can be used to cancel the operation.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/functions/syncOfflinePatientData.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / syncOfflinePatientData
+
+# Function: ~~syncOfflinePatientData()~~
+
+> **syncOfflinePatientData**(`patientUuid`): `Promise`\<`void`\>
+
+Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/offline-patient-data.ts#L62)
+
+## Parameters
+
+### patientUuid
+
+`string`
+
+## Returns
+
+`Promise`\<`void`\>
+
+## Deprecated
+
+Will be removed once all modules have been migrated to the new dynamic offline data API.

package/docs/functions/toDateObjectStrict.md

@@ -0,0 +1,20 @@
+[O3 Framework](../API.md) / toDateObjectStrict
+
+# Function: toDateObjectStrict()
+
+> **toDateObjectStrict**(`omrsDateString`): `null` \| `Date`
+
+Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:21
+
+Converts the object to a date object if it is an OpenMRS ISO date time string.
+Otherwise returns null.
+
+## Parameters
+
+### omrsDateString
+
+`string`
+
+## Returns
+
+`null` \| `Date`

package/docs/functions/toLocationObject.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / toLocationObject
+
+# Function: toLocationObject()
+
+> **toLocationObject**(`openmrsRestForm`): [`Location`](../interfaces/Location.md)
+
+Defined in: [packages/framework/esm-emr-api/src/location.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/location.ts#L7)
+
+## Parameters
+
+### openmrsRestForm
+
+`any`
+
+## Returns
+
+[`Location`](../interfaces/Location.md)

package/docs/functions/toOmrsIsoString.md

@@ -0,0 +1,23 @@
+[O3 Framework](../API.md) / toOmrsIsoString
+
+# Function: toOmrsIsoString()
+
+> **toOmrsIsoString**(`date`, `toUTC?`): `string`
+
+Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:25
+
+Formats the input to OpenMRS ISO format: "YYYY-MM-DDTHH:mm:ss.SSSZZ".
+
+## Parameters
+
+### date
+
+[`DateInput`](../type-aliases/DateInput.md)
+
+### toUTC?
+
+`boolean`
+
+## Returns
+
+`string`

package/docs/functions/toVisitTypeObject.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / toVisitTypeObject
+
+# Function: toVisitTypeObject()
+
+> **toVisitTypeObject**(`openmrsRestForm`): [`VisitType`](../interfaces/VisitType.md)
+
+Defined in: [packages/framework/esm-emr-api/src/visit-type.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/visit-type.ts#L7)
+
+## Parameters
+
+### openmrsRestForm
+
+`any`
+
+## Returns
+
+[`VisitType`](../interfaces/VisitType.md)

package/docs/functions/translateFrom.md

@@ -0,0 +1,55 @@
+[O3 Framework](../API.md) / translateFrom
+
+# Function: translateFrom()
+
+> **translateFrom**(`moduleName`, `key`, `fallback?`, `options?`): `string`
+
+Defined in: [packages/framework/esm-translations/src/index.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-translations/src/index.ts#L40)
+
+This function is for getting a translation from a specific module. Use this only if the
+translation is neither in the app making the call, nor in the core translations.
+This function is useful, for example, in libraries that are used by multiple apps, since libraries can't
+define their own translations.
+
+Translations within the current app should be accessed with the i18next API, using
+`useTranslation` and `t` as usual. Core translations should be accessed with the
+[[getCoreTranslation]] function.
+
+IMPORTANT: This function creates a hidden dependency on the module. Worse yet, it creates
+a dependency specifically on that module's translation keys, which are often regarded as
+"implementation details" and therefore may be volatile. Also note that this function DOES NOT
+load the module's translations if they have not already been loaded via `useTranslation`.
+**This function should therefore be avoided when possible.**
+
+## Parameters
+
+### moduleName
+
+`string`
+
+The module to get the translation from, e.g. '@openmrs/esm-login-app'
+
+### key
+
+`string`
+
+The i18next translation key
+
+### fallback?
+
+`string`
+
+Fallback text for if the lookup fails
+
+### options?
+
+`Omit`\<`TOptions`, `"ns"` \| `"defaultValue"`\>
+
+Options object passed to the i18next `t` function. See https://www.i18next.com/translation-function/essentials#overview-options
+           for more information. `ns` and `defaultValue` are already set and may not be used.
+
+## Returns
+
+`string`
+
+The translated text as a string

package/docs/functions/unregisterContext.md

@@ -0,0 +1,20 @@
+[O3 Framework](../API.md) / unregisterContext
+
+# Function: unregisterContext()
+
+> **unregisterContext**(`namespace`): `void`
+
+Defined in: [packages/framework/esm-context/src/context.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-context/src/context.ts#L45)
+
+Used by caller to unregister a namespace in the application context. Unregistering a namespace
+will remove the namespace and all associated data.
+
+## Parameters
+
+### namespace
+
+`string`
+
+## Returns
+
+`void`

package/docs/functions/unsetLeftNav.md

@@ -0,0 +1,23 @@
+[O3 Framework](../API.md) / unsetLeftNav
+
+# Function: ~~unsetLeftNav()~~
+
+> **unsetLeftNav**(`name`): `void`
+
+Defined in: [packages/framework/esm-extensions/src/left-nav.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/left-nav.ts#L46)
+
+Unsets the left nav context if the current context is for the supplied name.
+
+## Parameters
+
+### name
+
+`string`
+
+## Returns
+
+`void`
+
+## Deprecated
+
+Please use [useLeftNav](useLeftNav.md) instead. This function will be made internal in a future release.

package/docs/functions/updateContext.md

@@ -0,0 +1,29 @@
+[O3 Framework](../API.md) / updateContext
+
+# Function: updateContext()
+
+> **updateContext**\<`T`\>(`namespace`, `update`): `void`
+
+Defined in: [packages/framework/esm-context/src/context.ts:84](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-context/src/context.ts#L84)
+
+Updates a namespace in the global context. If the namespace does not exist, it is registered.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object` = \{ \}
+
+## Parameters
+
+### namespace
+
+`string`
+
+### update
+
+(`state`) => `T`
+
+## Returns
+
+`void`

package/docs/functions/updateVisit.md

@@ -0,0 +1,25 @@
+[O3 Framework](../API.md) / updateVisit
+
+# Function: updateVisit()
+
+> **updateVisit**(`uuid`, `payload`, `abortController`): `Promise`\<`FetchResponse`\<[`Visit`](../interfaces/Visit.md)\>\>
+
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/visit-utils.ts#L92)
+
+## Parameters
+
+### uuid
+
+`string`
+
+### payload
+
+[`UpdateVisitPayload`](../type-aliases/UpdateVisitPayload.md)
+
+### abortController
+
+`AbortController`
+
+## Returns
+
+`Promise`\<`FetchResponse`\<[`Visit`](../interfaces/Visit.md)\>\>