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

package/docs/classes/OpenmrsFetchError.md

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

package/docs/enums/Type.md

@@ -0,0 +1,107 @@
+[@openmrs/esm-framework](../API.md) / Type
+
+# Enumeration: Type
+
+## Table of contents
+
+### Enumeration Members
+
+- [Array](Type.md#array)
+- [Boolean](Type.md#boolean)
+- [ConceptUuid](Type.md#conceptuuid)
+- [Number](Type.md#number)
+- [Object](Type.md#object)
+- [PatientIdentifierTypeUuid](Type.md#patientidentifiertypeuuid)
+- [PersonAttributeTypeUuid](Type.md#personattributetypeuuid)
+- [String](Type.md#string)
+- [UUID](Type.md#uuid)
+
+## Enumeration Members
+
+### Array
+
+• **Array**
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L2)
+
+___
+
+### Boolean
+
+• **Boolean**
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L3)
+
+___
+
+### ConceptUuid
+
+• **ConceptUuid**
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L4)
+
+___
+
+### Number
+
+• **Number**
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L5)
+
+___
+
+### Object
+
+• **Object**
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L6)
+
+___
+
+### PatientIdentifierTypeUuid
+
+• **PatientIdentifierTypeUuid**
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L10)
+
+___
+
+### PersonAttributeTypeUuid
+
+• **PersonAttributeTypeUuid**
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L9)
+
+___
+
+### String
+
+• **String**
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L7)
+
+___
+
+### UUID
+
+• **UUID**
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L8)

package/docs/enums/VisitMode.md

@@ -0,0 +1,41 @@
+[@openmrs/esm-framework](../API.md) / VisitMode
+
+# Enumeration: VisitMode
+
+## Table of contents
+
+### API Enumeration Members
+
+- [EDITVISIT](VisitMode.md#editvisit)
+- [LOADING](VisitMode.md#loading)
+- [NEWVISIT](VisitMode.md#newvisit)
+
+## API Enumeration Members
+
+### EDITVISIT
+
+• **EDITVISIT**
+
+#### Defined in
+
+[packages/framework/esm-emr-api/src/visit-utils.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L16)
+
+___
+
+### LOADING
+
+• **LOADING**
+
+#### Defined in
+
+[packages/framework/esm-emr-api/src/visit-utils.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L17)
+
+___
+
+### NEWVISIT
+
+• **NEWVISIT**
+
+#### Defined in
+
+[packages/framework/esm-emr-api/src/visit-utils.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L15)

package/docs/enums/VisitStatus.md

@@ -0,0 +1,30 @@
+[@openmrs/esm-framework](../API.md) / VisitStatus
+
+# Enumeration: VisitStatus
+
+## Table of contents
+
+### API Enumeration Members
+
+- [NOTSTARTED](VisitStatus.md#notstarted)
+- [ONGOING](VisitStatus.md#ongoing)
+
+## API Enumeration Members
+
+### NOTSTARTED
+
+• **NOTSTARTED**
+
+#### Defined in
+
+[packages/framework/esm-emr-api/src/visit-utils.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L21)
+
+___
+
+### ONGOING
+
+• **ONGOING**
+
+#### Defined in
+
+[packages/framework/esm-emr-api/src/visit-utils.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L22)

package/docs/interfaces/ActionMenuButtonProps.md

@@ -1,67 +1,91 @@
-[O3 Framework](../API.md) / ActionMenuButtonProps
+[@openmrs/esm-framework](../API.md) / ActionMenuButtonProps
 
 # Interface: ActionMenuButtonProps
 
-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)
+## Table of contents
 
-## Properties
+### Workspace Properties
 
-### getIcon()
+- [iconDescription](ActionMenuButtonProps.md#icondescription)
+- [label](ActionMenuButtonProps.md#label)
+- [tagContent](ActionMenuButtonProps.md#tagcontent)
+- [type](ActionMenuButtonProps.md#type)
 
-> **getIcon**: (`props`) => `Element`
+### Workspace Methods
 
-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)
+- [getIcon](ActionMenuButtonProps.md#geticon)
+- [handler](ActionMenuButtonProps.md#handler)
 
-#### Parameters
+## Workspace Properties
 
-##### props
+### iconDescription
 
-`object`
+• **iconDescription**: `string`
 
-#### Returns
+#### Defined in
 
-`Element`
+[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)
 
-***
+___
 
-### handler()
+### label
 
-> **handler**: () => `void`
+• **label**: `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: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)
 
-`void`
+___
 
-***
+### tagContent
 
-### iconDescription
+• `Optional` **tagContent**: `ReactNode`
 
-> **iconDescription**: `string`
+#### Defined in
 
-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)
+[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)
 
-***
+___
 
-### label
+### type
 
-> **label**: `string`
+• **type**: `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/18d2874f03a33a6ab8295af0e87ac97fdd150718/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L31)
+#### 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/main/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L34)
 
-### tagContent?
+## Workspace Methods
 
-> `optional` **tagContent**: `ReactNode`
+### getIcon
 
-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)
+▸ **getIcon**(`props`): `Element`
 
-***
+#### Parameters
 
-### type
+| Name | Type |
+| :------ | :------ |
+| `props` | `object` |
+
+#### Returns
+
+`Element`
+
+#### 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/main/packages/framework/esm-styleguide/src/workspaces/action-menu-button/action-menu-button.component.tsx#L30)
+
+___
+
+### handler
+
+▸ **handler**(): `void`
+
+#### Returns
+
+`void`
 
-> **type**: `string`
+#### Defined in
 
-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)
+[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)