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

package/docs/functions/registerBreadcrumbs.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / registerBreadcrumbs
+
+# Function: registerBreadcrumbs()
+
+> **registerBreadcrumbs**(`breadcrumbs`): `void`
+
+Defined in: [packages/framework/esm-navigation/src/breadcrumbs/db.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-navigation/src/breadcrumbs/db.ts#L22)
+
+## Parameters
+
+### breadcrumbs
+
+[`BreadcrumbSettings`](../interfaces/BreadcrumbSettings.md)[]
+
+## Returns
+
+`void`

package/docs/functions/registerContext.md

@@ -0,0 +1,34 @@
+[O3 Framework](../API.md) / registerContext
+
+# Function: registerContext()
+
+> **registerContext**\<`T`\>(`namespace`, `initialValue`): `void`
+
+Defined in: [packages/framework/esm-context/src/context.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-context/src/context.ts#L29)
+
+Used by callers to register a new namespace in the application context. Attempting to register
+an already-registered namespace will display a warning and make no modifications to the state.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\> = `Record`\<`string` \| `number` \| `symbol`, `any`\>
+
+## Parameters
+
+### namespace
+
+`string`
+
+the namespace to register
+
+### initialValue
+
+`T` = `nothing`
+
+the initial value of the namespace
+
+## Returns
+
+`void`

package/docs/functions/registerDefaultCalendar.md

@@ -0,0 +1,33 @@
+[O3 Framework](../API.md) / registerDefaultCalendar
+
+# Function: registerDefaultCalendar()
+
+> **registerDefaultCalendar**(`locale`, `calendar`): `void`
+
+Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:42
+
+Provides the name of the calendar to associate, as a default, with the given base locale.
+
+## Parameters
+
+### locale
+
+`string`
+
+the locale to register this calendar for
+
+### calendar
+
+`CalendarIdentifier`
+
+the calendar to use for this registration
+
+## Returns
+
+`void`
+
+## Example
+
+```
+registerDefaultCalendar('en', 'buddhist') // sets the default calendar for the 'en' locale to Buddhist.
+```

package/docs/functions/registerFeatureFlag.md

@@ -0,0 +1,36 @@
+[O3 Framework](../API.md) / registerFeatureFlag
+
+# Function: registerFeatureFlag()
+
+> **registerFeatureFlag**(`flagName`, `label`, `description`): `void`
+
+Defined in: [packages/framework/esm-feature-flags/src/feature-flags.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-feature-flags/src/feature-flags.ts#L54)
+
+This function creates a feature flag. Call it in top-level code anywhere. It will
+not reset whether the flag is enabled or not, so it's safe to call it multiple times.
+Once a feature flag is created, it will appear with a toggle in the Implementer Tools.
+It can then be used to turn on or off features in the code.
+
+## Parameters
+
+### flagName
+
+`string`
+
+A code-friendly name for the flag, which will be used to reference it in code
+
+### label
+
+`string`
+
+A human-friendly name which will be displayed in the Implementer Tools
+
+### description
+
+`string`
+
+An explanation of what the flag does, which will be displayed in the Implementer Tools
+
+## Returns
+
+`void`

package/docs/functions/registerOfflinePatientHandler.md

@@ -0,0 +1,25 @@
+[O3 Framework](../API.md) / registerOfflinePatientHandler
+
+# Function: ~~registerOfflinePatientHandler()~~
+
+> **registerOfflinePatientHandler**(`identifier`, `handler`): `void`
+
+Defined in: [packages/framework/esm-offline/src/offline-patient-data.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/offline-patient-data.ts#L45)
+
+## Parameters
+
+### identifier
+
+`string`
+
+### handler
+
+[`OfflinePatientDataSyncHandler`](../interfaces/OfflinePatientDataSyncHandler.md)
+
+## Returns
+
+`void`
+
+## Deprecated
+
+Will be removed once all modules have been migrated to the new dynamic offline data API.

package/docs/functions/removeDynamicOfflineData.md

@@ -0,0 +1,28 @@
+[O3 Framework](../API.md) / removeDynamicOfflineData
+
+# Function: removeDynamicOfflineData()
+
+> **removeDynamicOfflineData**(`type`, `identifier`): `Promise`\<`void`\>
+
+Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:201](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L201)
+
+Declares that dynamic offline data of the given [type](#removedynamicofflinedata) with the given [identifier](#removedynamicofflinedata)
+no longer needs to be available offline 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.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/functions/removeDynamicOfflineDataFor.md

@@ -0,0 +1,34 @@
+[O3 Framework](../API.md) / removeDynamicOfflineDataFor
+
+# Function: removeDynamicOfflineDataFor()
+
+> **removeDynamicOfflineDataFor**(`userId`, `type`, `identifier`): `Promise`\<`void`\>
+
+Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:213](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L213)
+
+Declares that dynamic offline data of the given [type](#removedynamicofflinedatafor) with the given [identifier](#removedynamicofflinedatafor)
+no longer needs to be available offline for the user with the given ID.
+
+## Parameters
+
+### userId
+
+`string`
+
+The ID of the user who doesn't require the specified offline data.
+
+### 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.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/functions/renderExtension.md

@@ -0,0 +1,41 @@
+[O3 Framework](../API.md) / renderExtension
+
+# Function: renderExtension()
+
+> **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction`, `additionalProps`): `Promise`\<`null` \| `Parcel`\>
+
+Defined in: [packages/framework/esm-extensions/src/render.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L18)
+
+Mounts into a DOM node (representing an extension slot)
+a lazy-loaded component from *any* frontend module
+that registered an extension component for this slot.
+
+## Parameters
+
+### domElement
+
+`HTMLElement`
+
+### extensionSlotName
+
+`string`
+
+### extensionSlotModuleName
+
+`string`
+
+### extensionId
+
+`string`
+
+### renderFunction
+
+(`application`) => `ParcelConfig`
+
+### additionalProps
+
+`Record`\<`string`, `any`\> = `{}`
+
+## Returns
+
+`Promise`\<`null` \| `Parcel`\>

package/docs/functions/reportError.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / reportError
+
+# Function: reportError()
+
+> **reportError**(`err`): `void`
+
+Defined in: packages/framework/esm-error-handling/dist/index.d.ts:1
+
+## Parameters
+
+### err
+
+`unknown`
+
+## Returns
+
+`void`

package/docs/functions/retry.md

@@ -0,0 +1,44 @@
+[O3 Framework](../API.md) / retry
+
+# Function: retry()
+
+> **retry**\<`T`\>(`fn`, `options?`): `Promise`\<`T`\>
+
+Defined in: packages/framework/esm-utils/dist/retry.d.ts:38
+
+Executes the specified function and retries executing on failure with a custom backoff strategy
+defined by the options.
+
+If not configured otherwise, this function uses the following default options:
+* Retries 5 times beyond the initial attempt.
+* Uses an exponential backoff starting with an initial delay of 1000ms.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### fn
+
+() => `Promise`\<`T`\>
+
+The function to be executed and retried on failure.
+
+### options?
+
+[`RetryOptions`](../interfaces/RetryOptions.md)
+
+Additional options which configure the retry behavior.
+
+## Returns
+
+`Promise`\<`T`\>
+
+The result of successfully executing `fn`.
+
+## Throws
+
+Rethrows the final error of running `fn` when the function stops retrying.

package/docs/functions/saveVisit.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / saveVisit
+
+# Function: saveVisit()
+
+> **saveVisit**(`payload`, `abortController`): `Promise`\<`FetchResponse`\<[`Visit`](../interfaces/Visit.md)\>\>
+
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L81)
+
+## Parameters
+
+### payload
+
+[`NewVisitPayload`](../interfaces/NewVisitPayload.md)
+
+### abortController
+
+`AbortController`
+
+## Returns
+
+`Promise`\<`FetchResponse`\<[`Visit`](../interfaces/Visit.md)\>\>

package/docs/functions/selectPreferredName.md

@@ -0,0 +1,46 @@
+[O3 Framework](../API.md) / selectPreferredName
+
+# Function: selectPreferredName()
+
+> **selectPreferredName**(`patient`, ...`preferredNames`): `undefined` \| `HumanName`
+
+Defined in: packages/framework/esm-utils/dist/patient-helpers.d.ts:41
+
+Select the preferred name from the collection of names associated with a patient.
+
+Names may be specified with a usage such as 'usual', 'official', 'nickname', 'maiden', etc.
+A name with no usage specified is treated as the 'usual' name.
+
+The chosen name will be selected according to the priority order of `preferredNames`,
+
+## Parameters
+
+### patient
+
+`Patient`
+
+The patient from whom a name will be selected.
+
+### preferredNames
+
+...[`NameUse`](../type-aliases/NameUse.md)[]
+
+Optional ordered sequence of preferred name usages; defaults to 'usual' if not specified.
+
+## Returns
+
+`undefined` \| `HumanName`
+
+the preferred name for the patient, or undefined if no acceptable name could be found.
+
+## Examples
+
+```ts
+// normal use case; prefer usual name, fallback to official name
+displayNameByUsage(patient, 'usual', 'official')
+```
+
+```ts
+// prefer usual name over nickname, fallback to official name
+displayNameByUsage(patient, 'usual', 'nickname', 'official')
+```

package/docs/functions/setCurrentVisit.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / setCurrentVisit
+
+# Function: setCurrentVisit()
+
+> **setCurrentVisit**(`patientUuid`, `visitUuid`): `void`
+
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L61)
+
+## Parameters
+
+### patientUuid
+
+`string`
+
+### visitUuid
+
+`string`
+
+## Returns
+
+`void`

package/docs/functions/setLeftNav.md

@@ -0,0 +1,23 @@
+[O3 Framework](../API.md) / setLeftNav
+
+# Function: ~~setLeftNav()~~
+
+> **setLeftNav**(`__namedParameters`): `void`
+
+Defined in: [packages/framework/esm-extensions/src/left-nav.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L37)
+
+Sets the current left nav context. Must be paired with [unsetLeftNav](unsetLeftNav.md).
+
+## Parameters
+
+### \_\_namedParameters
+
+[`SetLeftNavParams`](../interfaces/SetLeftNavParams.md)
+
+## Returns
+
+`void`
+
+## Deprecated
+
+Please use [useLeftNav](useLeftNav.md) instead. This function will be made internal in a future release.

package/docs/functions/setSessionLocation.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / setSessionLocation
+
+# Function: setSessionLocation()
+
+> **setSessionLocation**(`locationUuid`, `abortController`): `Promise`\<`any`\>
+
+Defined in: [packages/framework/esm-api/src/current-user.ts:231](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L231)
+
+## Parameters
+
+### locationUuid
+
+`string`
+
+### abortController
+
+`AbortController`
+
+## Returns
+
+`Promise`\<`any`\>

package/docs/functions/setUserLanguage.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / setUserLanguage
+
+# Function: setUserLanguage()
+
+> **setUserLanguage**(`data`): `void`
+
+Defined in: [packages/framework/esm-api/src/current-user.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L116)
+
+## Parameters
+
+### data
+
+[`Session`](../interfaces/Session.md)
+
+## Returns
+
+`void`

package/docs/functions/setUserProperties.md

@@ -0,0 +1,23 @@
+[O3 Framework](../API.md) / setUserProperties
+
+# Function: setUserProperties()
+
+> **setUserProperties**(`userUuid`, `userProperties`, `abortController?`): `Promise`\<[`SessionStore`](../type-aliases/SessionStore.md)\>
+
+Defined in: [packages/framework/esm-api/src/current-user.ts:244](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L244)
+
+## Parameters
+
+### userUuid
+
+`string`
+
+### userProperties
+
+### abortController?
+
+`AbortController`
+
+## Returns
+
+`Promise`\<[`SessionStore`](../type-aliases/SessionStore.md)\>

package/docs/functions/setupDynamicOfflineDataHandler.md

@@ -0,0 +1,22 @@
+[O3 Framework](../API.md) / setupDynamicOfflineDataHandler
+
+# Function: setupDynamicOfflineDataHandler()
+
+> **setupDynamicOfflineDataHandler**(`handler`): `void`
+
+Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:113](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/dynamic-offline-data.ts#L113)
+
+Sets up a handler for synchronizing dynamic offline data.
+See [DynamicOfflineDataHandler](../interfaces/DynamicOfflineDataHandler.md) for details.
+
+## Parameters
+
+### handler
+
+[`DynamicOfflineDataHandler`](../interfaces/DynamicOfflineDataHandler.md)
+
+The handler to be setup.
+
+## Returns
+
+`void`

package/docs/functions/setupOfflineSync.md

@@ -0,0 +1,49 @@
+[O3 Framework](../API.md) / setupOfflineSync
+
+# Function: setupOfflineSync()
+
+> **setupOfflineSync**\<`T`\>(`type`, `dependsOn`, `process`, `options`): `void`
+
+Defined in: [packages/framework/esm-offline/src/sync.ts:365](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/sync.ts#L365)
+
+Registers a new synchronization handler which is able to synchronize data of a specific type.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### type
+
+`string`
+
+The identifying type of the synchronization items which can be handled by this handler.
+
+### dependsOn
+
+`string`[]
+
+An array of other sync item types which must be synchronized before this handler
+  can synchronize its own data. Items of these types are effectively dependencies of the data
+  synchronized by this handler.
+
+### process
+
+`ProcessSyncItem`\<`T`\>
+
+A function which, when invoked, performs the actual client-server synchronization of the given
+  `item` (which is the actual data to be synchronized).
+
+### options
+
+`SetupOfflineSyncOptions`\<`T`\> = `{}`
+
+Additional options which can optionally be provided when setting up a synchronization callback
+  for a specific synchronization item type.
+
+## Returns
+
+`void`

package/docs/functions/shallowEqual.md

@@ -0,0 +1,32 @@
+[O3 Framework](../API.md) / shallowEqual
+
+# Function: shallowEqual()
+
+> **shallowEqual**(`a`, `b`): `boolean`
+
+Defined in: packages/framework/esm-utils/dist/shallowEqual.d.ts:12
+
+Checks whether two objects are equal, using a shallow comparison, similar to React.
+
+In essence, shallowEquals ensures two objects have the same own properties and that the values
+of these are equal (===) to each other.
+
+## Parameters
+
+### a
+
+`unknown`
+
+The first value to compare
+
+### b
+
+`unknown`
+
+The second value to compare
+
+## Returns
+
+`boolean`
+
+true if the objects are shallowly equal to each other

package/docs/functions/showActionableNotification.md

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

package/docs/functions/showModal.md

@@ -0,0 +1,44 @@
+[O3 Framework](../API.md) / showModal
+
+# Function: showModal()
+
+> **showModal**(`modalName`, `props`, `onClose`): () => `void`
+
+Defined in: [packages/framework/esm-styleguide/src/modals/index.tsx:200](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/modals/index.tsx#L200)
+
+Shows a modal dialog.
+
+The modal must have been registered by name. This should be done in the `routes.json` file of the
+app that defines the modal. Note that both the `<ModalHeader>` and `<ModalBody>` should be at the
+top level of the modal component (wrapped in a React.Fragment), or else the content of the modal
+body might not vertical-scroll properly.
+
+## Parameters
+
+### modalName
+
+`string`
+
+The name of the modal to show.
+
+### props
+
+`ModalProps` = `{}`
+
+The optional props to provide to the modal.
+
+### onClose
+
+() => `void`
+
+The optional callback to call when the modal is closed.
+
+## Returns
+
+The dispose function to force closing the modal dialog.
+
+> (): `void`
+
+### Returns
+
+`void`