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

package/docs/functions/useAbortController.md

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/docs/functions/useFhirInfinite.md

@@ -0,0 +1,46 @@
+[O3 Framework](../API.md) / useFhirInfinite
+
+# Function: useFhirInfinite()
+
+> **useFhirInfinite**\<`T`\>(`url`, `options`): `UseServerInfiniteReturnObject`\<`T`, `Bundle`\>
+
+Defined in: [packages/framework/esm-react-utils/src/useFhirInfinite.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useFhirInfinite.ts#L24)
+
+Fhir REST endpoints that return a list of objects, are server-side paginated.
+The server limits the max number of results being returned, and multiple requests are needed to get the full data set
+if its size exceeds this limit.
+
+This function is the FHIR counterpart of `useOpenmrsInfinite`.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `ResourceBase`
+
+## Parameters
+
+### url
+
+The URL of the paginated rest endpoint.
+           Similar to useSWRInfinite, this param can be null to disable fetching.
+
+`string` | `URL`
+
+### options
+
+[`UseServerInfiniteOptions`](../interfaces/UseServerInfiniteOptions.md)\<`Bundle`\> = `{}`
+
+The options object
+
+## Returns
+
+`UseServerInfiniteReturnObject`\<`T`, `Bundle`\>
+
+a UseServerInfiniteReturnObject object
+
+## See
+
+ - `useFhirPagination`
+ - `useFhirFetchAll`
+ - `useOpenmrsInfinite`

package/docs/functions/useFhirPagination.md

@@ -0,0 +1,129 @@
+[O3 Framework](../API.md) / useFhirPagination
+
+# Function: useFhirPagination()
+
+> **useFhirPagination**\<`T`\>(`url`, `pageSize`, `options`): `object`
+
+Defined in: [packages/framework/esm-react-utils/src/useFhirPagination.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useFhirPagination.ts#L27)
+
+Fhir REST endpoints that return a list of objects, are server-side paginated.
+The server limits the max number of results being returned, and multiple requests are needed to get the full data set
+if its size exceeds this limit.
+
+This function is the FHIR counterpart of `useOpenmrsPagination`.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `ResourceBase`
+
+## Parameters
+
+### url
+
+The URL of the paginated rest endpoint.
+           which will be overridden and manipulated by the `goTo*` callbacks
+
+`string` | `URL`
+
+### pageSize
+
+`number`
+
+The number of results to return per page / fetch.
+
+### options
+
+[`UseServerPaginationOptions`](../interfaces/UseServerPaginationOptions.md)\<`Bundle`\> = `{}`
+
+The options object
+
+## Returns
+
+### currentPage
+
+> **currentPage**: `number`
+
+### currentPageSize
+
+> **currentPageSize**: `MutableRefObject`\<`number`\>
+
+### data
+
+> **data**: `undefined` \| `T`[]
+
+### error
+
+> **error**: `any`
+
+The error object thrown by the fetcher function.
+
+### goTo()
+
+> **goTo**: (`page`) => `void`
+
+#### Parameters
+
+##### page
+
+`number`
+
+#### Returns
+
+`void`
+
+### goToNext()
+
+> **goToNext**: () => `void`
+
+#### Returns
+
+`void`
+
+### goToPrevious()
+
+> **goToPrevious**: () => `void`
+
+#### Returns
+
+`void`
+
+### isLoading
+
+> **isLoading**: `boolean`
+
+### isValidating
+
+> **isValidating**: `boolean`
+
+### mutate
+
+> **mutate**: `KeyedMutator`\<`FetchResponse`\<`Bundle`\>\>
+
+### paginated
+
+> **paginated**: `boolean`
+
+### showNextButton
+
+> **showNextButton**: `boolean`
+
+### showPreviousButton
+
+> **showPreviousButton**: `boolean`
+
+### totalCount
+
+> **totalCount**: `number` = `totalCount.current`
+
+### totalPages
+
+> **totalPages**: `number`
+
+## See
+
+`useOpenmrsPagination
+@see `useFhirInfinite`
+@see `useFhirFetchAll`
+@see `usePagination` for pagination of client-side data`