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

package/docs/functions/translateFrom.md

@@ -1,55 +0,0 @@
-[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

@@ -1,20 +0,0 @@
-[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

@@ -1,23 +0,0 @@
-[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

@@ -1,29 +0,0 @@
-[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

@@ -1,25 +0,0 @@
-[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)\>\>

package/docs/functions/useAbortController.md

@@ -1,32 +0,0 @@
-[O3 Framework](../API.md) / useAbortController
-
-# Function: useAbortController()
-
-> **useAbortController**(): `AbortController`
-
-Defined in: [packages/framework/esm-react-utils/src/useAbortController.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useAbortController.ts#L25)
-
-**`Beta`**
-
-This hook creates an AbortController that lasts either until the previous AbortController
-is aborted or until the component unmounts. This can be used to ensure that all fetch requests
-are cancelled when a component is unmounted.
-
-## Returns
-
-`AbortController`
-
-## Example
-
-```tsx
-import { useAbortController } from "@openmrs/esm-framework";
-
-function MyComponent() {
- const abortController = useAbortController();
- const { data } = useSWR(key, (key) => openmrsFetch(key, { signal: abortController.signal }));
-
- return (
-   // render something with data
- );
-}
-```

package/docs/functions/useAppContext.md

@@ -1,43 +0,0 @@
-[O3 Framework](../API.md) / useAppContext
-
-# Function: useAppContext()
-
-> **useAppContext**\<`T`\>(`namespace`): `undefined` \| `Readonly`\<`T`\>
-
-Defined in: [packages/framework/esm-react-utils/src/useAppContext.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useAppContext.ts#L26)
-
-This hook is used to access a namespace within the overall AppContext, so that a component can
-use any shared contextual values. A selector may be provided to further restrict the properties
-returned from the namespace.
-
-## 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
-
-`undefined` \| `Readonly`\<`T`\>
-
-## Examples
-
-```ts
-// load a full namespace
-const patientContext = useAppContext<PatientContext>('patient');
-```
-
-```ts
-// loads part of a namespace
-const patientName = useAppContext<PatientContext, string | undefined>('patient', (state) => state.display);
-```

package/docs/functions/useAssignedExtensionIds.md

@@ -1,26 +0,0 @@
-[O3 Framework](../API.md) / useAssignedExtensionIds
-
-# Function: ~~useAssignedExtensionIds()~~
-
-> **useAssignedExtensionIds**(`slotName`): `string`[]
-
-Defined in: [packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useAssignedExtensionIds.ts#L13)
-
-Gets the assigned extension ids for a given extension slot name.
-Does not consider if offline or online.
-
-## Parameters
-
-### slotName
-
-`string`
-
-The name of the slot to get the assigned IDs for.
-
-## Returns
-
-`string`[]
-
-## Deprecated
-
-Use `useAssignedExtensions`

package/docs/functions/useAssignedExtensions.md

@@ -1,21 +0,0 @@
-[O3 Framework](../API.md) / useAssignedExtensions
-
-# Function: useAssignedExtensions()
-
-> **useAssignedExtensions**(`slotName`): `AssignedExtension`[]
-
-Defined in: [packages/framework/esm-react-utils/src/useAssignedExtensions.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useAssignedExtensions.ts#L8)
-
-Gets the assigned extensions for a given extension slot name.
-
-## Parameters
-
-### slotName
-
-`string`
-
-The name of the slot to get the assigned extensions for.
-
-## Returns
-
-`AssignedExtension`[]

package/docs/functions/useAttachments.md

@@ -1,41 +0,0 @@
-[O3 Framework](../API.md) / useAttachments
-
-# Function: useAttachments()
-
-> **useAttachments**(`patientUuid`, `includeEncounterless`): `object`
-
-Defined in: [packages/framework/esm-react-utils/src/useAttachments.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useAttachments.ts#L7)
-
-## Parameters
-
-### patientUuid
-
-`string`
-
-### includeEncounterless
-
-`boolean`
-
-## Returns
-
-`object`
-
-### data
-
-> **data**: `AttachmentResponse`[]
-
-### error
-
-> **error**: `any`
-
-### isLoading
-
-> **isLoading**: `boolean`
-
-### isValidating
-
-> **isValidating**: `boolean`
-
-### mutate
-
-> **mutate**: `KeyedMutator`\<`FetchResponse`\<\{ `results`: `AttachmentResponse`[]; \}\>\>

package/docs/functions/useBodyScrollLock.md

@@ -1,17 +0,0 @@
-[O3 Framework](../API.md) / useBodyScrollLock
-
-# Function: useBodyScrollLock()
-
-> **useBodyScrollLock**(`active`): `void`
-
-Defined in: [packages/framework/esm-react-utils/src/useBodyScrollLock.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useBodyScrollLock.ts#L4)
-
-## Parameters
-
-### active
-
-`boolean`
-
-## Returns
-
-`void`

package/docs/functions/useConfig.md

@@ -1,27 +0,0 @@
-[O3 Framework](../API.md) / useConfig
-
-# Function: useConfig()
-
-> **useConfig**\<`T`\>(`options?`): `T`
-
-Defined in: [packages/framework/esm-react-utils/src/useConfig.ts:145](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useConfig.ts#L145)
-
-Use this React Hook to obtain your module's configuration.
-
-## Type Parameters
-
-### T
-
-`T` = `Record`\<`string`, `any`\>
-
-## Parameters
-
-### options?
-
-[`UseConfigOptions`](../interfaces/UseConfigOptions.md)
-
-Additional options that can be passed to useConfig()
-
-## Returns
-
-`T`

package/docs/functions/useConnectivity.md

@@ -1,11 +0,0 @@
-[O3 Framework](../API.md) / useConnectivity
-
-# Function: useConnectivity()
-
-> **useConnectivity**(): `boolean`
-
-Defined in: [packages/framework/esm-react-utils/src/useConnectivity.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useConnectivity.ts#L6)
-
-## Returns
-
-`boolean`

package/docs/functions/useDebounce.md

@@ -1,57 +0,0 @@
-[O3 Framework](../API.md) / useDebounce
-
-# Function: useDebounce()
-
-> **useDebounce**\<`T`\>(`value`, `delay`): `T`
-
-Defined in: [packages/framework/esm-react-utils/src/useDebounce.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useDebounce.ts#L32)
-
-This hook debounces a state variable. That state variable can then be used as the
-value of a controlled input, while the return value of this hook is used for making
-a request.
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### value
-
-`T`
-
-The value that will be used to set `debounceValue`
-
-### delay
-
-`number` = `300`
-
-The number of milliseconds to wait before updating `debounceValue`
-
-## Returns
-
-`T`
-
-The debounced value
-
-## Example
-
-```tsx
-import { useDebounce } from "@openmrs/esm-framework";
-
-function MyComponent() {
-  const [searchTerm, setSearchTerm] = useState('');
-  const debouncedSearchTerm = useDebounce(searchTerm);
-  const swrResult = useSWR(`/api/search?q=${debouncedSearchTerm}`)
-
- return (
-   <Search
-     labelText={t('search', 'Search')}
-     onChange={(e) => setSearchTerm(e.target.value)}
-     value={searchTerm}
-   />
- )
-}
-```

package/docs/functions/useDefineAppContext.md

@@ -1,70 +0,0 @@
-[O3 Framework](../API.md) / useDefineAppContext
-
-# Function: useDefineAppContext()
-
-> **useDefineAppContext**\<`T`\>(`namespace`, `value?`): (`update`) => `void`
-
-Defined in: [packages/framework/esm-react-utils/src/useDefineAppContext.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useDefineAppContext.ts#L37)
-
-This hook is used to register a namespace in the AppContext. The component that registers the
-namespace is responsible for updating the value associated with the namespace. The namespace
-will be automatically removed when the component using this hook is unmounted.
-
-## Type Parameters
-
-### T
-
-`T` *extends* `object`
-
-The type of the value of the namespace
-
-## Parameters
-
-### namespace
-
-`string`
-
-The name of the namespace in the application context. Note that the namespace
- must be unique among currently registered namespaces in the application context.
-
-### value?
-
-`T`
-
-The value to associate with this namespace. Updating the value property will update
-  the namespace value.
-
-## Returns
-
-A function which can be used to update the state associated with the namespace
-
-> (`update`): `void`
-
-### Parameters
-
-#### update
-
-(`state`) => `T`
-
-### Returns
-
-`void`
-
-## Examples
-
-```ts
-const { data: patient } = useSWR(`/ws/rest/v1/patient/${patientUuid}`, openmrsFetch);
-useDefineAppContext<PatientContext>('patient', patient ?? null);
-```
-
-```ts
-const { data: patient } = useSWR(`/ws/rest/v1/patient/${patientUuid}`, openmrsFetch);
-const updatePatient = useDefineAppContext<PatientContext>('patient', patient ?? null);
-updatePatient((patient) => {
- patient.name = 'Hector';
- return patient;
-})
-```
-
-Note that the AppContext does not allow the storing of undefined values in a namespace. Use `null`
-instead.

package/docs/functions/useEmrConfiguration.md

@@ -1,35 +0,0 @@
-[O3 Framework](../API.md) / useEmrConfiguration
-
-# Function: useEmrConfiguration()
-
-> **useEmrConfiguration**(): `object`
-
-Defined in: [packages/framework/esm-react-utils/src/useEmrConfiguration.ts:158](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useEmrConfiguration.ts#L158)
-
-React hook for fetching and managing OpenMRS EMR configuration
-
-## Returns
-
-`object`
-
-Object containing:
-  - emrConfiguration: EmrApiConfigurationResponse | undefined - The EMR configuration data
-  - isLoadingEmrConfiguration: boolean - Loading state indicator
-  - mutateEmrConfiguration: Function - SWR's mutate function for manual revalidation
-  - errorFetchingEmrConfiguration: Error | undefined - Error object if request fails
-
-### emrConfiguration
-
-> **emrConfiguration**: `undefined` \| [`EmrApiConfigurationResponse`](../interfaces/EmrApiConfigurationResponse.md) = `swrData.data.data`
-
-### errorFetchingEmrConfiguration
-
-> **errorFetchingEmrConfiguration**: `undefined` \| `Error` = `swrData.error`
-
-### isLoadingEmrConfiguration
-
-> **isLoadingEmrConfiguration**: `boolean` = `swrData.isLoading`
-
-### mutateEmrConfiguration
-
-> **mutateEmrConfiguration**: `KeyedMutator`\<`FetchResponse`\<[`EmrApiConfigurationResponse`](../interfaces/EmrApiConfigurationResponse.md)\>\> = `swrData.mutate`

package/docs/functions/useExtensionSlotMeta.md

@@ -1,25 +0,0 @@
-[O3 Framework](../API.md) / useExtensionSlotMeta
-
-# Function: useExtensionSlotMeta()
-
-> **useExtensionSlotMeta**\<`T`\>(`extensionSlotName`): `object`
-
-Defined in: [packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useExtensionSlotMeta.ts#L10)
-
-Extract meta data from all extension for a given extension slot.
-
-## Type Parameters
-
-### T
-
-`T` = `ExtensionMeta`
-
-## Parameters
-
-### extensionSlotName
-
-`string`
-
-## Returns
-
-`object`

package/docs/functions/useExtensionSlotStore.md

@@ -1,17 +0,0 @@
-[O3 Framework](../API.md) / useExtensionSlotStore
-
-# Function: useExtensionSlotStore()
-
-> **useExtensionSlotStore**(`slot`): `ExtensionSlotState`
-
-Defined in: [packages/framework/esm-react-utils/src/useExtensionSlotStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useExtensionSlotStore.ts#L5)
-
-## Parameters
-
-### slot
-
-`string`
-
-## Returns
-
-`ExtensionSlotState`

package/docs/functions/useFeatureFlag.md

@@ -1,30 +0,0 @@
-[O3 Framework](../API.md) / useFeatureFlag
-
-# Function: useFeatureFlag()
-
-> **useFeatureFlag**(`flagName`): `boolean`
-
-Defined in: [packages/framework/esm-react-utils/src/useFeatureFlag.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useFeatureFlag.ts#L18)
-
-Use this function to tell whether a feature flag is toggled on or off.
-
-Example:
-
-```tsx
-import { useFeatureFlag } from "@openmrs/esm-react-utils";
-
-export function MyComponent() {
- const isMyFeatureFlagOn = useFeatureFlag("my-feature-flag");
- return <>{isMyFeatureFlagOn && <ExperimentalFeature />}</>;
-}
-```
-
-## Parameters
-
-### flagName
-
-`string`
-
-## Returns
-
-`boolean`

package/docs/functions/useFhirFetchAll.md

@@ -1,44 +0,0 @@
-[O3 Framework](../API.md) / useFhirFetchAll
-
-# Function: useFhirFetchAll()
-
-> **useFhirFetchAll**\<`T`\>(`url`, `options`): `UseServerInfiniteReturnObject`\<`T`, `Bundle`\>
-
-Defined in: [packages/framework/esm-react-utils/src/useFhirFetchAll.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useFhirFetchAll.ts#L19)
-
-This hook handles fetching results from *all* pages of a paginated FHIR REST endpoint, making multiple requests
-as needed.
-This function is the FHIR counterpart of `useOpenmrsPagination`.
-
-## Type Parameters
-
-### T
-
-`T` *extends* `ResourceBase`
-
-## Parameters
-
-### url
-
-`any`
-
-The URL of the paginated rest endpoint.
-           Similar to useSWRInfinite, this param can be null to disable fetching.
-
-### options
-
-[`UseServerFetchAllOptions`](../interfaces/UseServerFetchAllOptions.md)\<`Bundle`\> = `{}`
-
-The options object
-
-## Returns
-
-`UseServerInfiniteReturnObject`\<`T`, `Bundle`\>
-
-a UseFhirInfiniteReturnObject object
-
-## See
-
- - `useFhirPagination`
- - `useFhirInfinite`
- - `useOpenmrsFetchAll``