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

package/docs/functions/useStore.md

@@ -0,0 +1,131 @@
+[O3 Framework](../API.md) / useStore
+
+# Function: useStore()
+
+## Call Signature
+
+> **useStore**\<`T`\>(`store`): `T`
+
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useStore.ts#L53)
+
+### Type Parameters
+
+#### T
+
+`T`
+
+### Parameters
+
+#### store
+
+`StoreApi`\<`T`\>
+
+### Returns
+
+`T`
+
+## Call Signature
+
+> **useStore**\<`T`, `U`\>(`store`, `select`): `U`
+
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useStore.ts#L54)
+
+### Type Parameters
+
+#### T
+
+`T`
+
+#### U
+
+`U`
+
+### Parameters
+
+#### store
+
+`StoreApi`\<`T`\>
+
+#### select
+
+(`state`) => `U`
+
+### Returns
+
+`U`
+
+## Call Signature
+
+> **useStore**\<`T`, `U`, `A`\>(`store`, `select`, `actions`): `T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>
+
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useStore.ts#L55)
+
+### Type Parameters
+
+#### T
+
+`T`
+
+#### U
+
+`U`
+
+#### A
+
+`A` *extends* [`Actions`](../type-aliases/Actions.md)\<`T`\>
+
+### Parameters
+
+#### store
+
+`StoreApi`\<`T`\>
+
+#### select
+
+`undefined`
+
+#### actions
+
+`A`
+
+### Returns
+
+`T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>
+
+## Call Signature
+
+> **useStore**\<`T`, `U`, `A`\>(`store`, `select`, `actions`): `U` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>
+
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useStore.ts#L60)
+
+### Type Parameters
+
+#### T
+
+`T`
+
+#### U
+
+`U`
+
+#### A
+
+`A` *extends* [`Actions`](../type-aliases/Actions.md)\<`T`\>
+
+### Parameters
+
+#### store
+
+`StoreApi`\<`T`\>
+
+#### select
+
+(`state`) => `U`
+
+#### actions
+
+`A`
+
+### Returns
+
+`U` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>

package/docs/functions/useStoreWithActions.md

@@ -0,0 +1,33 @@
+[O3 Framework](../API.md) / useStoreWithActions
+
+# Function: useStoreWithActions()
+
+> **useStoreWithActions**\<`T`, `A`\>(`store`, `actions`): `T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>
+
+Defined in: [packages/framework/esm-react-utils/src/useStore.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useStore.ts#L87)
+
+## Type Parameters
+
+### T
+
+`T`
+
+### A
+
+`A` *extends* [`Actions`](../type-aliases/Actions.md)\<`T`\>
+
+## Parameters
+
+### store
+
+`StoreApi`\<`T`\>
+
+A zustand store
+
+### actions
+
+`A`
+
+## Returns
+
+`T` & [`BoundActions`](../type-aliases/BoundActions.md)\<`T`, `A`\>

package/docs/functions/useVisit.md

@@ -0,0 +1,41 @@
+[O3 Framework](../API.md) / useVisit
+
+# Function: useVisit()
+
+> **useVisit**(`patientUuid`, `representation`): [`VisitReturnType`](../interfaces/VisitReturnType.md)
+
+Defined in: [packages/framework/esm-react-utils/src/useVisit.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useVisit.ts#L42)
+
+This React hook returns visit information if the patient UUID is not null. There are
+potentially two relevant visits at a time: "active" and "current".
+
+The active visit is the most recent visit without an end date. The presence of an active
+visit generally means that the patient is in the facility.
+
+The current visit is the active visit, unless a retrospective visit has been selected.
+If there is no active visit and no selected retrospective visit, then there is no
+current visit. If there is no active visit but there is a retrospective visit, then
+the retrospective visit is the current visit. `currentVisitIsRetrospective` tells you
+whether the current visit is a retrospective visit.
+
+The active visit and current visit require two separate API calls. `error` contains
+the error from either one, if there is an error. `isValidating` is true if either
+API call is in progress. `mutate` refreshes the data from both API calls.
+
+## Parameters
+
+### patientUuid
+
+`string`
+
+Unique patient identifier `string`
+
+### representation
+
+`string` = `defaultVisitCustomRepresentation`
+
+The custom representation of the visit
+
+## Returns
+
+[`VisitReturnType`](../interfaces/VisitReturnType.md)

package/docs/functions/useVisitContextStore.md

@@ -0,0 +1,23 @@
+[O3 Framework](../API.md) / useVisitContextStore
+
+# Function: useVisitContextStore()
+
+> **useVisitContextStore**(`mutateVisitCallback?`): `VisitStoreState` & `BindFunctionsIn`\<\{ `mutateVisit`: \{ \}; `setVisitContext`: \{ `manuallySetVisitUuid`: `null` \| `string`; `patientUuid`: `null` \| `string`; \}; \}\>
+
+Defined in: [packages/framework/esm-react-utils/src/useVisitContextStore.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/useVisitContextStore.ts#L28)
+
+A hook to return the visit context store and corresponding actions.
+
+## Parameters
+
+### mutateVisitCallback?
+
+() => `void`
+
+An optional mutate callback to register. If provided, the
+store action's `mutateVisit` function will invoke this callback (along with any other
+callbacks also registered into the store)
+
+## Returns
+
+`VisitStoreState` & `BindFunctionsIn`\<\{ `mutateVisit`: \{ \}; `setVisitContext`: \{ `manuallySetVisitUuid`: `null` \| `string`; `patientUuid`: `null` \| `string`; \}; \}\>

package/docs/functions/useVisitTypes.md

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

package/docs/functions/useWorkspaces.md

@@ -0,0 +1,11 @@
+[O3 Framework](../API.md) / useWorkspaces
+
+# Function: useWorkspaces()
+
+> **useWorkspaces**(): [`WorkspacesInfo`](../interfaces/WorkspacesInfo.md)
+
+Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:543](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L543)
+
+## Returns
+
+[`WorkspacesInfo`](../interfaces/WorkspacesInfo.md)

package/docs/functions/userHasAccess.md

@@ -0,0 +1,27 @@
+[O3 Framework](../API.md) / userHasAccess
+
+# Function: userHasAccess()
+
+> **userHasAccess**(`requiredPrivilege`, `user`): `boolean`
+
+Defined in: [packages/framework/esm-api/src/current-user.ts:184](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/current-user.ts#L184)
+
+## Parameters
+
+### requiredPrivilege
+
+`string` | `string`[]
+
+### user
+
+#### privileges
+
+[`Privilege`](../interfaces/Privilege.md)[]
+
+#### roles
+
+[`Role`](../interfaces/Role.md)[]
+
+## Returns
+
+`boolean`

package/docs/functions/validator.md

@@ -0,0 +1,44 @@
+[O3 Framework](../API.md) / validator
+
+# Function: validator()
+
+> **validator**(`validationFunction`, `message`): [`Validator`](../type-aliases/Validator.md)
+
+Defined in: [packages/framework/esm-config/src/validators/validator.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/validators/validator.ts#L25)
+
+Constructs a custom validator.
+
+### Example
+
+```typescript
+{
+  foo: {
+    _default: 0,
+    _validators: [
+      validator(val => val >= 0, "Must not be negative.")
+    ]
+  }
+}
+```
+
+## Parameters
+
+### validationFunction
+
+[`ValidatorFunction`](../type-aliases/ValidatorFunction.md)
+
+Takes the configured value as input. Returns true
+   if it is valid, false otherwise.
+
+### message
+
+A string message that explains why the value is invalid. Can
+   also be a function that takes the value as input and returns a string.
+
+`string` | (`value`) => `string`
+
+## Returns
+
+[`Validator`](../type-aliases/Validator.md)
+
+A validator ready for use in a config schema

package/docs/interfaces/ActionMenuButtonProps.md

@@ -1,91 +1,67 @@
-[@openmrs/esm-framework](../API.md) / ActionMenuButtonProps
+[O3 Framework](../API.md) / ActionMenuButtonProps
 
 # Interface: ActionMenuButtonProps
 
-## Table of contents
+Defined in: [packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:29](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L29)
 
-### Workspace Properties
+## Properties
 
-- [iconDescription](ActionMenuButtonProps.md#icondescription)
-- [label](ActionMenuButtonProps.md#label)
-- [tagContent](ActionMenuButtonProps.md#tagcontent)
-- [type](ActionMenuButtonProps.md#type)
+### getIcon()
 
-### Workspace Methods
+> **getIcon**: (`props`) => `Element`
 
-- [getIcon](ActionMenuButtonProps.md#geticon)
-- [handler](ActionMenuButtonProps.md#handler)
+Defined in: [packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:30](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L30)
 
-## Workspace Properties
-
-### iconDescription
-
-• **iconDescription**: `string`
-
-#### Defined in
-
-[packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L32)
-
-___
-
-### label
-
-• **label**: `string`
-
-#### Defined in
-
-[packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L31)
+#### Parameters
 
-___
+##### props
 
-### tagContent
+`object`
 
-• `Optional` **tagContent**: `ReactNode`
+#### Returns
 
-#### Defined in
+`Element`
 
-[packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L35)
+***
 
-___
+### handler()
 
-### type
+> **handler**: () => `void`
 
-• **type**: `string`
+Defined in: [packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:33](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L33)
 
-#### Defined in
+#### Returns
 
-[packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L34)
+`void`
 
-## Workspace Methods
+***
 
-### getIcon
+### iconDescription
 
-▸ **getIcon**(`props`): `Element`
+> **iconDescription**: `string`
 
-#### Parameters
+Defined in: [packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:32](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L32)
 
-| Name | Type |
-| :------ | :------ |
-| `props` | `object` |
+***
 
-#### Returns
+### label
 
-`Element`
+> **label**: `string`
 
-#### Defined in
+Defined in: [packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:31](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L31)
 
-[packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L30)
+***
 
-___
+### tagContent?
 
-### handler
+> `optional` **tagContent**: `ReactNode`
 
-▸ **handler**(): `void`
+Defined in: [packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:35](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L35)
 
-#### Returns
+***
 
-`void`
+### type
 
-#### Defined in
+> **type**: `string`
 
-[packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L33)
+Defined in: [packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx:34](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L34)

package/docs/interfaces/ActionableNotificationDescriptor.md

@@ -1,107 +1,77 @@
-[@openmrs/esm-framework](../API.md) / ActionableNotificationDescriptor
+[O3 Framework](../API.md) / ActionableNotificationDescriptor
 
 # Interface: ActionableNotificationDescriptor
 
-## Table of contents
+Defined in: [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L9)
 
-### UI Properties
-
-- [actionButtonLabel](ActionableNotificationDescriptor.md#actionbuttonlabel)
-- [critical](ActionableNotificationDescriptor.md#critical)
-- [kind](ActionableNotificationDescriptor.md#kind)
-- [progressActionLabel](ActionableNotificationDescriptor.md#progressactionlabel)
-- [subtitle](ActionableNotificationDescriptor.md#subtitle)
-- [title](ActionableNotificationDescriptor.md#title)
-
-### UI Methods
-
-- [onActionButtonClick](ActionableNotificationDescriptor.md#onactionbuttonclick)
-- [onClose](ActionableNotificationDescriptor.md#onclose)
-
-## UI Properties
+## Properties
 
 ### actionButtonLabel
 
-• **actionButtonLabel**: `string`
-
-#### Defined in
-
-[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L10)
-
-___
-
-### critical
-
-• `Optional` **critical**: `boolean`
-
-#### Defined in
-
-[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L16)
+> **actionButtonLabel**: `string`
 
-___
+Defined in: [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L10)
 
-### kind
+***
 
-• `Optional` **kind**: `string`
+### critical?
 
-#### Defined in
+> `optional` **critical**: `boolean`
 
-[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L15)
+Defined in: [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L16)
 
-___
+***
 
-### progressActionLabel
+### kind?
 
-• `Optional` **progressActionLabel**: `string`
+> `optional` **kind**: `string`
 
-#### Defined in
+Defined in: [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L15)
 
-[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L17)
+***
 
-___
+### onActionButtonClick()
 
-### subtitle
+> **onActionButtonClick**: () => `void`
 
-• **subtitle**: `string`
+Defined in: [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L11)
 
-#### Defined in
+#### Returns
 
-[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L13)
+`void`
 
-___
+***
 
-### title
+### onClose()?
 
-• `Optional` **title**: `string`
+> `optional` **onClose**: () => `void`
 
-#### Defined in
+Defined in: [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L12)
 
-[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L14)
+#### Returns
 
-## UI Methods
+`void`
 
-### onActionButtonClick
+***
 
-▸ **onActionButtonClick**(): `void`
+### progressActionLabel?
 
-#### Returns
+> `optional` **progressActionLabel**: `string`
 
-`void`
+Defined in: [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L17)
 
-#### Defined in
+***
 
-[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L11)
+### subtitle
 
-___
+> **subtitle**: `string`
 
-### onClose
+Defined in: [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L13)
 
-▸ `Optional` **onClose**(): `void`
+***
 
-#### Returns
-
-`void`
+### title?
 
-#### Defined in
+> `optional` **title**: `string`
 
-[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L12)
+Defined in: [packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L14)