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

package/docs/classes/OpenmrsFetchError.md

@@ -1,211 +1,186 @@
-[@openmrs/esm-framework](../API.md) / OpenmrsFetchError
+[O3 Framework](../API.md) / OpenmrsFetchError
 
 # Class: OpenmrsFetchError
 
-## Hierarchy
+Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:301](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/openmrs-fetch.ts#L301)
 
-- `Error`
+## Extends
 
-  ↳ **`OpenmrsFetchError`**
+- `Error`
 
 ## Implements
 
 - [`FetchError`](../interfaces/FetchError.md)
 
-## Table of contents
-
-### API Constructors
+## Constructors
 
-- [constructor](OpenmrsFetchError.md#constructor)
+### Constructor
 
-### API Properties
+> **new OpenmrsFetchError**(`url`, `response`, `responseBody`, `requestStacktrace`): `OpenmrsFetchError`
 
-- [response](OpenmrsFetchError.md#response)
-- [responseBody](OpenmrsFetchError.md#responsebody)
+Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:302](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/openmrs-fetch.ts#L302)
 
-### Other Properties
-
-- [cause](OpenmrsFetchError.md#cause)
-- [message](OpenmrsFetchError.md#message)
-- [name](OpenmrsFetchError.md#name)
-- [stack](OpenmrsFetchError.md#stack)
-- [prepareStackTrace](OpenmrsFetchError.md#preparestacktrace)
-- [stackTraceLimit](OpenmrsFetchError.md#stacktracelimit)
-
-### Methods
+#### Parameters
 
-- [captureStackTrace](OpenmrsFetchError.md#capturestacktrace)
+##### url
 
-## API Constructors
+`string`
 
-### constructor
+##### response
 
-• **new OpenmrsFetchError**(`url`, `response`, `responseBody`, `requestStacktrace`)
+`Response`
 
-#### Parameters
+##### responseBody
 
-| Name | Type |
-| :------ | :------ |
-| `url` | `string` |
-| `response` | `Response` |
-| `responseBody` | ``null`` \| `ResponseBody` |
-| `requestStacktrace` | `Error` |
+`null` | `ResponseBody`
 
-#### Overrides
+##### requestStacktrace
 
-Error.constructor
+`Error`
 
-#### Defined in
+#### Returns
 
-[packages/framework/esm-api/src/openmrs-fetch.ts:302](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L302)
+`OpenmrsFetchError`
 
-## API Properties
+#### Overrides
 
-### response
+`Error.constructor`
 
-• **response**: `Response`
+## Properties
 
-#### Implementation of
+### cause?
 
-[FetchError](../interfaces/FetchError.md).[response](../interfaces/FetchError.md#response)
+> `optional` **cause**: `unknown`
 
-#### Defined in
+Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26
 
-[packages/framework/esm-api/src/openmrs-fetch.ts:310](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L310)
+#### Inherited from
 
-___
+`Error.cause`
 
-### responseBody
+***
 
-• **responseBody**: ``null`` \| `string` \| [`FetchResponseJson`](../interfaces/FetchResponseJson.md)
+### message
 
-#### Implementation of
+> **message**: `string`
 
-[FetchError](../interfaces/FetchError.md).[responseBody](../interfaces/FetchError.md#responsebody)
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077
 
-#### Defined in
+#### Inherited from
 
-[packages/framework/esm-api/src/openmrs-fetch.ts:311](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L311)
+`Error.message`
 
-___
+***
 
-## Other Properties
+### name
 
-### cause
+> **name**: `string`
 
-• `Optional` **cause**: `unknown`
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
 
 #### Inherited from
 
-Error.cause
+`Error.name`
 
-#### Defined in
+***
 
-node_modules/typescript/lib/lib.es2022.error.d.ts:26
+### prepareStackTrace()?
 
-___
+> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
 
-### message
-
-• **message**: `string`
+Defined in: node\_modules/@types/node/globals.d.ts:11
 
-#### Inherited from
+Optional override for formatting stack traces
 
-Error.message
+#### Parameters
 
-#### Defined in
+##### err
 
-node_modules/typescript/lib/lib.es5.d.ts:1054
+`Error`
 
-___
+##### stackTraces
 
-### name
+`CallSite`[]
 
-• **name**: `string`
-
-#### Inherited from
+#### Returns
 
-Error.name
+`any`
 
-#### Defined in
+#### See
 
-node_modules/typescript/lib/lib.es5.d.ts:1053
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
-___
+#### Inherited from
 
-### stack
+`Error.prepareStackTrace`
 
-• `Optional` **stack**: `string`
+***
 
-#### Inherited from
+### response
 
-Error.stack
+> **response**: `Response`
 
-#### Defined in
+Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:310](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/openmrs-fetch.ts#L310)
 
-node_modules/typescript/lib/lib.es5.d.ts:1055
+#### Implementation of
 
-___
+[`FetchError`](../interfaces/FetchError.md).[`response`](../interfaces/FetchError.md#response)
 
-### prepareStackTrace
+***
 
-▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+### responseBody
 
-#### Type declaration
+> **responseBody**: `null` \| `string` \| [`FetchResponseJson`](../interfaces/FetchResponseJson.md)
 
-▸ (`err`, `stackTraces`): `any`
+Defined in: [packages/framework/esm-api/src/openmrs-fetch.ts:311](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-api/src/openmrs-fetch.ts#L311)
 
-Optional override for formatting stack traces
+#### Implementation of
 
-**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+[`FetchError`](../interfaces/FetchError.md).[`responseBody`](../interfaces/FetchError.md#responsebody)
 
-##### Parameters
+***
 
-| Name | Type |
-| :------ | :------ |
-| `err` | `Error` |
-| `stackTraces` | `CallSite`[] |
+### stack?
 
-##### Returns
+> `optional` **stack**: `string`
 
-`any`
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
 
 #### Inherited from
 
-Error.prepareStackTrace
+`Error.stack`
 
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:11
-
-___
+***
 
 ### stackTraceLimit
 
-▪ `Static` **stackTraceLimit**: `number`
-
-#### Inherited from
+> `static` **stackTraceLimit**: `number`
 
-Error.stackTraceLimit
+Defined in: node\_modules/@types/node/globals.d.ts:13
 
-#### Defined in
+#### Inherited from
 
-node_modules/@types/node/globals.d.ts:13
+`Error.stackTraceLimit`
 
 ## Methods
 
-### captureStackTrace
+### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
 
-▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+Defined in: node\_modules/@types/node/globals.d.ts:4
 
 Create .stack property on a target object
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `targetObject` | `object` |
-| `constructorOpt?` | `Function` |
+##### targetObject
+
+`object`
+
+##### constructorOpt?
+
+`Function`
 
 #### Returns
 
@@ -213,8 +188,4 @@ Create .stack property on a target object
 
 #### Inherited from
 
-Error.captureStackTrace
-
-#### Defined in
-
-node_modules/@types/node/globals.d.ts:4
+`Error.captureStackTrace`

package/docs/enumerations/Type.md

@@ -0,0 +1,77 @@
+[O3 Framework](../API.md) / Type
+
+# Enumeration: Type
+
+Defined in: [packages/framework/esm-config/src/types.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L1)
+
+## Enumeration Members
+
+### Array
+
+> **Array**: `"Array"`
+
+Defined in: [packages/framework/esm-config/src/types.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L2)
+
+***
+
+### Boolean
+
+> **Boolean**: `"Boolean"`
+
+Defined in: [packages/framework/esm-config/src/types.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L3)
+
+***
+
+### ConceptUuid
+
+> **ConceptUuid**: `"ConceptUuid"`
+
+Defined in: [packages/framework/esm-config/src/types.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L4)
+
+***
+
+### Number
+
+> **Number**: `"Number"`
+
+Defined in: [packages/framework/esm-config/src/types.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L5)
+
+***
+
+### Object
+
+> **Object**: `"Object"`
+
+Defined in: [packages/framework/esm-config/src/types.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L6)
+
+***
+
+### PatientIdentifierTypeUuid
+
+> **PatientIdentifierTypeUuid**: `"PatientIdentifierTypeUuid"`
+
+Defined in: [packages/framework/esm-config/src/types.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L10)
+
+***
+
+### PersonAttributeTypeUuid
+
+> **PersonAttributeTypeUuid**: `"PersonAttributeTypeUuid"`
+
+Defined in: [packages/framework/esm-config/src/types.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L9)
+
+***
+
+### String
+
+> **String**: `"String"`
+
+Defined in: [packages/framework/esm-config/src/types.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L7)
+
+***
+
+### UUID
+
+> **UUID**: `"UUID"`
+
+Defined in: [packages/framework/esm-config/src/types.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-config/src/types.ts#L8)

package/docs/enumerations/VisitMode.md

@@ -0,0 +1,29 @@
+[O3 Framework](../API.md) / VisitMode
+
+# Enumeration: VisitMode
+
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/visit-utils.ts#L14)
+
+## Enumeration Members
+
+### EDITVISIT
+
+> **EDITVISIT**: `"editVisit"`
+
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/visit-utils.ts#L16)
+
+***
+
+### LOADING
+
+> **LOADING**: `"loadingVisit"`
+
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/visit-utils.ts#L17)
+
+***
+
+### NEWVISIT
+
+> **NEWVISIT**: `"startVisit"`
+
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/visit-utils.ts#L15)

package/docs/enumerations/VisitStatus.md

@@ -0,0 +1,21 @@
+[O3 Framework](../API.md) / VisitStatus
+
+# Enumeration: VisitStatus
+
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/visit-utils.ts#L20)
+
+## Enumeration Members
+
+### NOTSTARTED
+
+> **NOTSTARTED**: `"notStarted"`
+
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/visit-utils.ts#L21)
+
+***
+
+### ONGOING
+
+> **ONGOING**: `"ongoing"`
+
+Defined in: [packages/framework/esm-emr-api/src/visit-utils.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-emr-api/src/visit-utils.ts#L22)

package/docs/functions/ConfigurableLink.md

@@ -0,0 +1,19 @@
+[O3 Framework](../API.md) / ConfigurableLink
+
+# Function: ConfigurableLink()
+
+> **ConfigurableLink**(`__namedParameters`): `Element`
+
+Defined in: [packages/framework/esm-react-utils/src/ConfigurableLink.tsx:49](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L49)
+
+A React link component which calls [[navigate]] when clicked
+
+## Parameters
+
+### \_\_namedParameters
+
+`PropsWithChildren`\<[`ConfigurableLinkProps`](../interfaces/ConfigurableLinkProps.md)\>
+
+## Returns
+
+`Element`

package/docs/functions/CustomOverflowMenu.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / CustomOverflowMenu
+
+# Function: CustomOverflowMenu()
+
+> **CustomOverflowMenu**(`__namedParameters`): `Element`
+
+Defined in: [packages/framework/esm-styleguide/src/custom-overflow-menu/custom-overflow-menu.component.tsx:12](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/custom-overflow-menu/custom-overflow-menu.component.tsx#L12)
+
+## Parameters
+
+### \_\_namedParameters
+
+`CustomOverflowMenuProps`
+
+## Returns
+
+`Element`

package/docs/functions/DashboardExtension.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / DashboardExtension
+
+# Function: DashboardExtension()
+
+> **DashboardExtension**(`__namedParameters`): `Element`
+
+Defined in: [packages/framework/esm-styleguide/src/dashboard-extension/index.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/dashboard-extension/index.tsx#L16)
+
+## Parameters
+
+### \_\_namedParameters
+
+[`DashboardExtensionProps`](../interfaces/DashboardExtensionProps.md)
+
+## Returns
+
+`Element`

package/docs/functions/ExtensionSlot.md

@@ -0,0 +1,46 @@
+[O3 Framework](../API.md) / ExtensionSlot
+
+# Function: ExtensionSlot()
+
+> **ExtensionSlot**(`__namedParameters`): `Element`
+
+Defined in: [packages/framework/esm-react-utils/src/ExtensionSlot.tsx:71](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L71)
+
+An [extension slot](https://o3-docs.openmrs.org/docs/extension-system).
+A place with a name. Extensions that get connected to that name
+will be rendered into this.
+
+## Parameters
+
+### \_\_namedParameters
+
+[`ExtensionSlotProps`](../interfaces/ExtensionSlotProps.md)
+
+## Returns
+
+`Element`
+
+## Examples
+
+Passing a react node as children
+
+```tsx
+<ExtensionSlot name="Foo">
+  <div style={{ width: 10rem }}>
+    <Extension />
+  </div>
+</ExtensionSlot>
+```
+
+Passing a function as children
+
+```tsx
+<ExtensionSlot name="Bar">
+  {(extension) => (
+    <h1>{extension.name}</h1>
+    <div style={{ color: extension.meta.color }}>
+      <Extension />
+    </div>
+  )}
+</ExtensionSlot>
+```

package/docs/functions/OpenmrsAppContext.md

@@ -0,0 +1,36 @@
+[O3 Framework](../API.md) / OpenmrsAppContext
+
+# Function: OpenmrsAppContext()
+
+> **OpenmrsAppContext**\<`T`\>(`__namedParameters`): `null`
+
+Defined in: [packages/framework/esm-react-utils/src/OpenmrsContext.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-react-utils/src/OpenmrsContext.ts#L24)
+
+OpenmrsAppContext is a simple React component meant to function similarly to React's Context,
+but built on top of the OpenmrsAppContext.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+## Parameters
+
+### \_\_namedParameters
+
+[`OpenmrsAppContextProps`](../interfaces/OpenmrsAppContextProps.md)\<`T`\>
+
+## Returns
+
+`null`
+
+## Example
+
+```ts
+   <OpenmrsAppContext namespace="something" value={{ key: "1234" }} />
+```
+
+**Notes on usage:** Unlike a proper React context where the value is limited to the subtree under the
+context component, the `OpenmrsAppContext` is inherently global in scope. That means that _all applications_
+will see the values that you set for the namespace if they load the value of the namespace.

package/docs/functions/PatientBannerActionsMenu.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / PatientBannerActionsMenu
+
+# Function: PatientBannerActionsMenu()
+
+> **PatientBannerActionsMenu**(`__namedParameters`): `Element`
+
+Defined in: [packages/framework/esm-styleguide/src/patient-banner/actions-menu/patient-banner-actions-menu.component.tsx:20](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/patient-banner/actions-menu/patient-banner-actions-menu.component.tsx#L20)
+
+## Parameters
+
+### \_\_namedParameters
+
+[`PatientBannerActionsMenuProps`](../interfaces/PatientBannerActionsMenuProps.md)
+
+## Returns
+
+`Element`

package/docs/functions/PatientBannerContactDetails.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / PatientBannerContactDetails
+
+# Function: PatientBannerContactDetails()
+
+> **PatientBannerContactDetails**(`__namedParameters`): `Element`
+
+Defined in: [packages/framework/esm-styleguide/src/patient-banner/contact-details/patient-banner-contact-details.component.tsx:183](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/patient-banner/contact-details/patient-banner-contact-details.component.tsx#L183)
+
+## Parameters
+
+### \_\_namedParameters
+
+`ContactDetailsProps`
+
+## Returns
+
+`Element`

package/docs/functions/PatientBannerPatientIdentifiers.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / PatientBannerPatientIdentifiers
+
+# Function: PatientBannerPatientIdentifiers()
+
+> **PatientBannerPatientIdentifiers**(`__namedParameters`): `Element`
+
+Defined in: [packages/framework/esm-styleguide/src/patient-banner/patient-info/patient-banner-patient-identifiers.component.tsx:39](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/patient-banner/patient-info/patient-banner-patient-identifiers.component.tsx#L39)
+
+## Parameters
+
+### \_\_namedParameters
+
+`PatientBannerPatientIdentifiersProps`
+
+## Returns
+
+`Element`

package/docs/functions/PatientBannerPatientInfo.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / PatientBannerPatientInfo
+
+# Function: PatientBannerPatientInfo()
+
+> **PatientBannerPatientInfo**(`__namedParameters`): `Element`
+
+Defined in: [packages/framework/esm-styleguide/src/patient-banner/patient-info/patient-banner-patient-info.component.tsx:61](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/patient-banner/patient-info/patient-banner-patient-info.component.tsx#L61)
+
+## Parameters
+
+### \_\_namedParameters
+
+`PatientBannerPatientInfoProps`
+
+## Returns
+
+`Element`

package/docs/functions/PatientBannerToggleContactDetailsButton.md

@@ -0,0 +1,17 @@
+[O3 Framework](../API.md) / PatientBannerToggleContactDetailsButton
+
+# Function: PatientBannerToggleContactDetailsButton()
+
+> **PatientBannerToggleContactDetailsButton**(`__namedParameters`): `Element`
+
+Defined in: [packages/framework/esm-styleguide/src/patient-banner/contact-details/patient-banner-toggle-contact-details-button.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/patient-banner/contact-details/patient-banner-toggle-contact-details-button.component.tsx#L16)
+
+## Parameters
+
+### \_\_namedParameters
+
+[`PatientBannerToggleContactDetailsButtonProps`](../interfaces/PatientBannerToggleContactDetailsButtonProps.md)
+
+## Returns
+
+`Element`