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

package/docs/functions/formatDatetime.md

@@ -1,29 +0,0 @@
-[O3 Framework](../API.md) / formatDatetime
-
-# Function: formatDatetime()
-
-> **formatDatetime**(`date`, `options?`): `string`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:139
-
-Formats the input into a string showing the date and time, according
-to the current locale. The `mode` parameter is as described for
-`formatDate`.
-
-This is created by concatenating the results of `formatDate`
-and `formatTime` with a comma and space. This agrees with the
-output of `Date.prototype.toLocaleString` for *most* locales.
-
-## Parameters
-
-### date
-
-`Date`
-
-### options?
-
-`Partial`\<`Omit`\<[`FormatDateOptions`](../type-aliases/FormatDateOptions.md), `"time"`\>\>
-
-## Returns
-
-`string`

package/docs/functions/formatPartialDate.md

@@ -1,39 +0,0 @@
-[O3 Framework](../API.md) / formatPartialDate
-
-# Function: formatPartialDate()
-
-> **formatPartialDate**(`dateString`, `options?`): `null` \| `string`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:104
-
-Formats the string representing a date, including partial representations of dates, according to the current
-locale and the given options.
-
-Default options:
- - mode: "standard",
- - time: "for today",
- - day: true,
- - month: true,
- - year: true
- - noToday: false
-
-If the date is today then "Today" is produced (in the locale language).
-This behavior can be disabled with `noToday: true`.
-
-When time is included, it is appended with a comma and a space. This
-agrees with the output of `Date.prototype.toLocaleString` for *most*
-locales.
-
-## Parameters
-
-### dateString
-
-`string`
-
-### options?
-
-`Partial`\<[`FormatDateOptions`](../type-aliases/FormatDateOptions.md)\>
-
-## Returns
-
-`null` \| `string`

package/docs/functions/formatPatientName.md

@@ -1,23 +0,0 @@
-[O3 Framework](../API.md) / formatPatientName
-
-# Function: formatPatientName()
-
-> **formatPatientName**(`name`): `string`
-
-Defined in: packages/framework/esm-utils/dist/patient-helpers.d.ts:20
-
-Get a formatted display string for an FHIR name.
-
-## Parameters
-
-### name
-
-The name to be formatted.
-
-`undefined` | `HumanName`
-
-## Returns
-
-`string`
-
-The formatted display name or an empty string if name is undefined.

package/docs/functions/formatTime.md

@@ -1,20 +0,0 @@
-[O3 Framework](../API.md) / formatTime
-
-# Function: formatTime()
-
-> **formatTime**(`date`): `string`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:129
-
-Formats the input as a time, according to the current locale.
-12-hour or 24-hour clock depends on locale.
-
-## Parameters
-
-### date
-
-`Date`
-
-## Returns
-
-`string`

package/docs/functions/formattedName.md

@@ -1,21 +0,0 @@
-[O3 Framework](../API.md) / formattedName
-
-# Function: ~~formattedName()~~
-
-> **formattedName**(`name`): `string`
-
-Defined in: packages/framework/esm-utils/dist/patient-helpers.d.ts:22
-
-## Parameters
-
-### name
-
-`undefined` | `HumanName`
-
-## Returns
-
-`string`
-
-## Deprecated
-
-Use `formatPatientName`

package/docs/functions/generateOfflineUuid.md

@@ -1,13 +0,0 @@
-[O3 Framework](../API.md) / generateOfflineUuid
-
-# Function: generateOfflineUuid()
-
-> **generateOfflineUuid**(): `string`
-
-Defined in: [packages/framework/esm-offline/src/uuid-support.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/uuid-support.ts#L7)
-
-Generates a UUID-like string which is used for uniquely identifying objects while offline.
-
-## Returns
-
-`string`

package/docs/functions/getAssignedExtensions.md

@@ -1,23 +0,0 @@
-[O3 Framework](../API.md) / getAssignedExtensions
-
-# Function: getAssignedExtensions()
-
-> **getAssignedExtensions**(`slotName`): [`AssignedExtension`](../interfaces/AssignedExtension.md)[]
-
-Defined in: [packages/framework/esm-extensions/src/extensions.ts:399](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-extensions/src/extensions.ts#L399)
-
-Gets the list of extensions assigned to a given slot
-
-## Parameters
-
-### slotName
-
-`string`
-
-The slot to load the assigned extensions for
-
-## Returns
-
-[`AssignedExtension`](../interfaces/AssignedExtension.md)[]
-
-An array of extensions assigned to the named slot

package/docs/functions/getAsyncLifecycle.md

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

package/docs/functions/getAttachmentByUuid.md

@@ -1,21 +0,0 @@
-[O3 Framework](../API.md) / getAttachmentByUuid
-
-# Function: getAttachmentByUuid()
-
-> **getAttachmentByUuid**(`attachmentUuid`, `abortController`): `Promise`\<`FetchResponse`\<`any`\>\>
-
-Defined in: [packages/framework/esm-emr-api/src/attachments.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/attachments.ts#L7)
-
-## Parameters
-
-### attachmentUuid
-
-`string`
-
-### abortController
-
-`AbortController`
-
-## Returns
-
-`Promise`\<`FetchResponse`\<`any`\>\>

package/docs/functions/getAttachments.md

@@ -1,25 +0,0 @@
-[O3 Framework](../API.md) / getAttachments
-
-# Function: getAttachments()
-
-> **getAttachments**(`patientUuid`, `includeEncounterless`, `abortController`): `Promise`\<`FetchResponse`\<`any`\>\>
-
-Defined in: [packages/framework/esm-emr-api/src/attachments.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/attachments.ts#L13)
-
-## Parameters
-
-### patientUuid
-
-`string`
-
-### includeEncounterless
-
-`boolean`
-
-### abortController
-
-`AbortController`
-
-## Returns
-
-`Promise`\<`FetchResponse`\<`any`\>\>

package/docs/functions/getBreadcrumbs.md

@@ -1,11 +0,0 @@
-[O3 Framework](../API.md) / getBreadcrumbs
-
-# Function: getBreadcrumbs()
-
-> **getBreadcrumbs**(): [`BreadcrumbRegistration`](../interfaces/BreadcrumbRegistration.md)[]
-
-Defined in: [packages/framework/esm-navigation/src/breadcrumbs/db.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-navigation/src/breadcrumbs/db.ts#L32)
-
-## Returns
-
-[`BreadcrumbRegistration`](../interfaces/BreadcrumbRegistration.md)[]

package/docs/functions/getBreadcrumbsFor.md

@@ -1,17 +0,0 @@
-[O3 Framework](../API.md) / getBreadcrumbsFor
-
-# Function: getBreadcrumbsFor()
-
-> **getBreadcrumbsFor**(`path`): [`BreadcrumbRegistration`](../interfaces/BreadcrumbRegistration.md)[]
-
-Defined in: [packages/framework/esm-navigation/src/breadcrumbs/filter.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-navigation/src/breadcrumbs/filter.ts#L54)
-
-## Parameters
-
-### path
-
-`string`
-
-## Returns
-
-[`BreadcrumbRegistration`](../interfaces/BreadcrumbRegistration.md)[]

package/docs/functions/getConfig.md

@@ -1,31 +0,0 @@
-[O3 Framework](../API.md) / getConfig
-
-# Function: getConfig()
-
-> **getConfig**\<`T`\>(`moduleName`): `Promise`\<`T`\>
-
-Defined in: [packages/framework/esm-config/src/module-config/module-config.ts:277](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/module-config/module-config.ts#L277)
-
-A promise-based way to access the config as soon as it is fully loaded.
-If it is already loaded, resolves the config in its present state.
-
-This is a useful function if you need to get the config in the course
-of the execution of a function.
-
-## Type Parameters
-
-### T
-
-`T` = `Record`\<`string`, `any`\>
-
-## Parameters
-
-### moduleName
-
-`string`
-
-The name of the module for which to look up the config
-
-## Returns
-
-`Promise`\<`T`\>

package/docs/functions/getContext.md

@@ -1,29 +0,0 @@
-[O3 Framework](../API.md) / getContext
-
-# Function: getContext()
-
-> **getContext**\<`T`\>(`namespace`): `null` \| `Readonly`\<`T`\>
-
-Defined in: [packages/framework/esm-context/src/context.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-context/src/context.ts#L60)
-
-Returns an _immutable_ version of the state of the namespace as it is currently
-
-## Type Parameters
-
-### T
-
-`T` *extends* `object` = \{ \}
-
-The type of the value stored in the namespace
-
-## Parameters
-
-### namespace
-
-`string`
-
-The namespace to load properties from
-
-## Returns
-
-`null` \| `Readonly`\<`T`\>

package/docs/functions/getCoreTranslation.md

@@ -1,35 +0,0 @@
-[O3 Framework](../API.md) / getCoreTranslation
-
-# Function: getCoreTranslation()
-
-> **getCoreTranslation**(`key`, `defaultText?`, `options?`): `string`
-
-Defined in: [packages/framework/esm-translations/src/index.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-translations/src/index.ts#L66)
-
-Use this function to obtain a translation from the core translations. This is a way to avoid having
-to define common translations in your app, and to ensure that translations are consistent across
-different apps. This function is also used to obtain translations in the framework and app shell.
-
-The complete set of core translations is available on the `CoreTranslationKey` type. Providing an
-invalid key to this function will result in a type error.
-
-## Parameters
-
-### key
-
-`"error"` | `"delete"` | `"actions"` | `"address"` | `"age"` | `"cancel"` | `"change"` | `"Clinic"` | `"close"` | `"confirm"` | `"contactAdministratorIfIssuePersists"` | `"contactDetails"` | `"edit"` | `"errorCopy"` | `"female"` | `"loading"` | `"male"` | `"other"` | `"patientIdentifierSticker"` | `"patientLists"` | `"print"` | `"printError"` | `"printErrorExplainer"` | `"printIdentifierSticker"` | `"printing"` | `"relationships"` | `"resetOverrides"` | `"save"` | `"scriptLoadingFailed"` | `"scriptLoadingError"` | `"seeMoreLists"` | `"sex"` | `"showLess"` | `"showMore"` | `"toggleDevTools"` | `"unknown"` | `"closeAllOpenedWorkspaces"` | `"closingAllWorkspacesPromptBody"` | `"closingAllWorkspacesPromptTitle"` | `"discard"` | `"hide"` | `"maximize"` | `"minimize"` | `"openAnyway"` | `"unsavedChangesInOpenedWorkspace"` | `"unsavedChangesInWorkspace"` | `"unsavedChangesTitleText"` | `"workspaceHeader"` | `"address1"` | `"address2"` | `"address3"` | `"address4"` | `"address5"` | `"address6"` | `"city"` | `"cityVillage"` | `"country"` | `"countyDistrict"` | `"district"` | `"postalCode"` | `"state"` | `"stateProvince"`
-
-### defaultText?
-
-`string`
-
-### options?
-
-`Omit`\<`TOptions`, `"ns"` \| `"defaultValue"`\>
-
-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`

package/docs/functions/getCurrentOfflineMode.md

@@ -1,11 +0,0 @@
-[O3 Framework](../API.md) / getCurrentOfflineMode
-
-# Function: getCurrentOfflineMode()
-
-> **getCurrentOfflineMode**(): [`OfflineModeResult`](../interfaces/OfflineModeResult.md)
-
-Defined in: [packages/framework/esm-offline/src/mode.ts:45](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/mode.ts#L45)
-
-## Returns
-
-[`OfflineModeResult`](../interfaces/OfflineModeResult.md)

package/docs/functions/getCurrentUser.md

@@ -1,154 +0,0 @@
-[O3 Framework](../API.md) / getCurrentUser
-
-# Function: getCurrentUser()
-
-## Call Signature
-
-> **getCurrentUser**(): `Observable`\<[`Session`](../interfaces/Session.md)\>
-
-Defined in: [packages/framework/esm-api/src/current-user.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/current-user.ts#L66)
-
-The getCurrentUser function returns an observable that produces
-**zero or more values, over time**. It will produce zero values
-by default if the user is not logged in. And it will provide a
-first value when the logged in user is fetched from the server.
-Subsequent values will be produced whenever the user object is
-updated.
-
-### Returns
-
-`Observable`\<[`Session`](../interfaces/Session.md)\>
-
-An Observable that produces zero or more values (as
-  described above). The values produced will be a user object (if
-  `includeAuthStatus` is set to `false`) or an object with a session
-  and authenticated property (if `includeAuthStatus` is set to `true`).
-
-#### Example
-
-```js
-import { getCurrentUser } from '@openmrs/esm-api'
-const subscription = getCurrentUser().subscribe(
-  user => console.log(user)
-)
-subscription.unsubscribe()
-getCurrentUser({includeAuthStatus: true}).subscribe(
-  data => console.log(data.authenticated)
-)
-```
-
-#### Be sure to unsubscribe when your component unmounts
-
-Otherwise your code will continue getting updates to the user object
-even after the UI component is gone from the screen. This is a memory
-leak and source of bugs.
-
-## Call Signature
-
-> **getCurrentUser**(`opts`): `Observable`\<[`Session`](../interfaces/Session.md)\>
-
-Defined in: [packages/framework/esm-api/src/current-user.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/current-user.ts#L67)
-
-The getCurrentUser function returns an observable that produces
-**zero or more values, over time**. It will produce zero values
-by default if the user is not logged in. And it will provide a
-first value when the logged in user is fetched from the server.
-Subsequent values will be produced whenever the user object is
-updated.
-
-### Parameters
-
-#### opts
-
-An object with `includeAuthStatus` boolean
-  property that defaults to `false`. When `includeAuthStatus` is set
-  to `true`, the entire response object from the API will be provided.
-  When `includeAuthStatus` is set to `false`, only the `user` property
-  of the response object will be provided.
-
-##### includeAuthStatus
-
-`true`
-
-### Returns
-
-`Observable`\<[`Session`](../interfaces/Session.md)\>
-
-An Observable that produces zero or more values (as
-  described above). The values produced will be a user object (if
-  `includeAuthStatus` is set to `false`) or an object with a session
-  and authenticated property (if `includeAuthStatus` is set to `true`).
-
-#### Example
-
-```js
-import { getCurrentUser } from '@openmrs/esm-api'
-const subscription = getCurrentUser().subscribe(
-  user => console.log(user)
-)
-subscription.unsubscribe()
-getCurrentUser({includeAuthStatus: true}).subscribe(
-  data => console.log(data.authenticated)
-)
-```
-
-#### Be sure to unsubscribe when your component unmounts
-
-Otherwise your code will continue getting updates to the user object
-even after the UI component is gone from the screen. This is a memory
-leak and source of bugs.
-
-## Call Signature
-
-> **getCurrentUser**(`opts`): `Observable`\<[`LoggedInUser`](../interfaces/LoggedInUser.md)\>
-
-Defined in: [packages/framework/esm-api/src/current-user.ts:68](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/current-user.ts#L68)
-
-The getCurrentUser function returns an observable that produces
-**zero or more values, over time**. It will produce zero values
-by default if the user is not logged in. And it will provide a
-first value when the logged in user is fetched from the server.
-Subsequent values will be produced whenever the user object is
-updated.
-
-### Parameters
-
-#### opts
-
-An object with `includeAuthStatus` boolean
-  property that defaults to `false`. When `includeAuthStatus` is set
-  to `true`, the entire response object from the API will be provided.
-  When `includeAuthStatus` is set to `false`, only the `user` property
-  of the response object will be provided.
-
-##### includeAuthStatus
-
-`false`
-
-### Returns
-
-`Observable`\<[`LoggedInUser`](../interfaces/LoggedInUser.md)\>
-
-An Observable that produces zero or more values (as
-  described above). The values produced will be a user object (if
-  `includeAuthStatus` is set to `false`) or an object with a session
-  and authenticated property (if `includeAuthStatus` is set to `true`).
-
-#### Example
-
-```js
-import { getCurrentUser } from '@openmrs/esm-api'
-const subscription = getCurrentUser().subscribe(
-  user => console.log(user)
-)
-subscription.unsubscribe()
-getCurrentUser({includeAuthStatus: true}).subscribe(
-  data => console.log(data.authenticated)
-)
-```
-
-#### Be sure to unsubscribe when your component unmounts
-
-Otherwise your code will continue getting updates to the user object
-even after the UI component is gone from the screen. This is a memory
-leak and source of bugs.

package/docs/functions/getDefaultCalendar.md

@@ -1,21 +0,0 @@
-[O3 Framework](../API.md) / getDefaultCalendar
-
-# Function: getDefaultCalendar()
-
-> **getDefaultCalendar**(`locale`): `undefined` \| `CalendarIdentifier`
-
-Defined in: packages/framework/esm-utils/dist/dates/date-util.d.ts:48
-
-Retrieves the default calendar for the specified locale if any.
-
-## Parameters
-
-### locale
-
-the locale to look-up
-
-`undefined` | `string` | `Locale`
-
-## Returns
-
-`undefined` \| `CalendarIdentifier`

package/docs/functions/getDefaultsFromConfigSchema.md

@@ -1,32 +0,0 @@
-[O3 Framework](../API.md) / getDefaultsFromConfigSchema
-
-# Function: getDefaultsFromConfigSchema()
-
-> **getDefaultsFromConfigSchema**\<`T`\>(`schema`): `T`
-
-Defined in: packages/framework/esm-utils/dist/test-helpers.d.ts:12
-
-Given a config schema, this returns an object like is returned by `useConfig`
-with all default values.
-
-This should be used in tests and not in production code.
-
-If all you need is the default values in your tests, these are returned by
-default from the `useConfig`/`getConfig` mock. This function is useful if you
-need to override some of the default values.
-
-## Type Parameters
-
-### T
-
-`T` = `Record`\<`string`, `any`\>
-
-## Parameters
-
-### schema
-
-`Record`\<`string` \| `number` \| `symbol`, `unknown`\>
-
-## Returns
-
-`T`

package/docs/functions/getDynamicOfflineDataEntries.md

@@ -1,28 +0,0 @@
-[O3 Framework](../API.md) / getDynamicOfflineDataEntries
-
-# Function: getDynamicOfflineDataEntries()
-
-> **getDynamicOfflineDataEntries**\<`T`\>(`type?`): `Promise`\<`T`[]\>
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:128](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/dynamic-offline-data.ts#L128)
-
-Returns all [DynamicOfflineData](../interfaces/DynamicOfflineData.md) entries which registered for the currently logged in user.
-Optionally returns only entries of a given type.
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`DynamicOfflineData`](../interfaces/DynamicOfflineData.md)
-
-## Parameters
-
-### type?
-
-`string`
-
-The type of the entries to be returned. If `undefined`, returns all types.
-
-## Returns
-
-`Promise`\<`T`[]\>

package/docs/functions/getDynamicOfflineDataEntriesFor.md

@@ -1,34 +0,0 @@
-[O3 Framework](../API.md) / getDynamicOfflineDataEntriesFor
-
-# Function: getDynamicOfflineDataEntriesFor()
-
-> **getDynamicOfflineDataEntriesFor**\<`T`\>(`userId`, `type?`): `Promise`\<`T`[]\>
-
-Defined in: [packages/framework/esm-offline/src/dynamic-offline-data.ts:139](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-offline/src/dynamic-offline-data.ts#L139)
-
-Returns all [DynamicOfflineData](../interfaces/DynamicOfflineData.md) entries which registered for the given user.
-Optionally returns only entries of a given type.
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`DynamicOfflineData`](../interfaces/DynamicOfflineData.md)
-
-## Parameters
-
-### userId
-
-`string`
-
-The ID of the user whose entries are to be retrieved.
-
-### type?
-
-`string`
-
-The type of the entries to be returned. If `undefined`, returns all types.
-
-## Returns
-
-`Promise`\<`T`[]\>