@openmrs/esm-framework 3.1.10-pre.92 → 3.1.11-pre.597

package/docs/classes/OpenmrsFetchError.md

@@ -0,0 +1,186 @@
+[@openmrs/esm-framework](../API.md) / OpenmrsFetchError
+
+# Class: OpenmrsFetchError
+
+## Hierarchy
+
+- `Error`
+
+  ↳ **`OpenmrsFetchError`**
+
+## Table of contents
+
+### Constructors
+
+- [constructor](OpenmrsFetchError.md#constructor)
+
+### Properties
+
+- [message](OpenmrsFetchError.md#message)
+- [name](OpenmrsFetchError.md#name)
+- [response](OpenmrsFetchError.md#response)
+- [responseBody](OpenmrsFetchError.md#responsebody)
+- [stack](OpenmrsFetchError.md#stack)
+- [prepareStackTrace](OpenmrsFetchError.md#preparestacktrace)
+- [stackTraceLimit](OpenmrsFetchError.md#stacktracelimit)
+
+### Methods
+
+- [captureStackTrace](OpenmrsFetchError.md#capturestacktrace)
+
+## Constructors
+
+### constructor
+
+• **new OpenmrsFetchError**(`url`, `response`, `responseBody`, `requestStacktrace`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `url` | `string` |
+| `response` | `Response` |
+| `responseBody` | ``null`` \| `ResponseBody` |
+| `requestStacktrace` | `Error` |
+
+#### Overrides
+
+Error.constructor
+
+#### Defined in
+
+[packages/framework/esm-api/src/openmrs-fetch.ts:270](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L270)
+
+## Properties
+
+### message
+
+• **message**: `string`
+
+#### Inherited from
+
+Error.message
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:974
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+Error.name
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:973
+
+___
+
+### response
+
+• **response**: `Response`
+
+#### Defined in
+
+[packages/framework/esm-api/src/openmrs-fetch.ts:283](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L283)
+
+___
+
+### responseBody
+
+• **responseBody**: ``null`` \| `string` \| `FetchResponseJson`
+
+#### Defined in
+
+[packages/framework/esm-api/src/openmrs-fetch.ts:284](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/openmrs-fetch.ts#L284)
+
+___
+
+### stack
+
+• `Optional` **stack**: `string`
+
+#### Inherited from
+
+Error.stack
+
+#### Defined in
+
+node_modules/typescript/lib/lib.es5.d.ts:975
+
+___
+
+### prepareStackTrace
+
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
+
+#### Type declaration
+
+▸ (`err`, `stackTraces`): `any`
+
+Optional override for formatting stack traces
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
+
+##### Returns
+
+`any`
+
+#### Inherited from
+
+Error.prepareStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:11
+
+___
+
+### stackTraceLimit
+
+▪ `Static` **stackTraceLimit**: `number`
+
+#### Inherited from
+
+Error.stackTraceLimit
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### captureStackTrace
+
+▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+Error.captureStackTrace
+
+#### Defined in
+
+node_modules/@types/node/globals.d.ts:4

package/docs/enums/Type.md

@@ -0,0 +1,85 @@
+[@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)
+- [String](Type.md#string)
+- [UUID](Type.md#uuid)
+
+## Enumeration members
+
+### Array
+
+• **Array** = `"Array"`
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/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/master/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/master/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/master/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/master/packages/framework/esm-config/src/types.ts#L6)
+
+___
+
+### String
+
+• **String** = `"String"`
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/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/master/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
+
+### Enumeration members
+
+- [EDITVISIT](VisitMode.md#editvisit)
+- [LOADING](VisitMode.md#loading)
+- [NEWVISIT](VisitMode.md#newvisit)
+
+## Enumeration members
+
+### EDITVISIT
+
+• **EDITVISIT** = `"editVisit"`
+
+#### Defined in
+
+[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:95](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L95)
+
+___
+
+### LOADING
+
+• **LOADING** = `"loadingVisit"`
+
+#### Defined in
+
+[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:96](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L96)
+
+___
+
+### NEWVISIT
+
+• **NEWVISIT** = `"startVisit"`
+
+#### Defined in
+
+[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:94](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L94)

package/docs/enums/VisitStatus.md

@@ -0,0 +1,30 @@
+[@openmrs/esm-framework](../API.md) / VisitStatus
+
+# Enumeration: VisitStatus
+
+## Table of contents
+
+### Enumeration members
+
+- [NOTSTARTED](VisitStatus.md#notstarted)
+- [ONGOING](VisitStatus.md#ongoing)
+
+## Enumeration members
+
+### NOTSTARTED
+
+• **NOTSTARTED** = `"notStarted"`
+
+#### Defined in
+
+[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:100](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L100)
+
+___
+
+### ONGOING
+
+• **ONGOING** = `"ongoing"`
+
+#### Defined in
+
+[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:101](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L101)

package/docs/interfaces/AppState.md

@@ -0,0 +1,3 @@
+[@openmrs/esm-framework](../API.md) / AppState
+
+# Interface: AppState

package/docs/interfaces/BreadcrumbRegistration.md

@@ -0,0 +1,30 @@
+[@openmrs/esm-framework](../API.md) / BreadcrumbRegistration
+
+# Interface: BreadcrumbRegistration
+
+## Table of contents
+
+### Properties
+
+- [matcher](BreadcrumbRegistration.md#matcher)
+- [settings](BreadcrumbRegistration.md#settings)
+
+## Properties
+
+### matcher
+
+• **matcher**: `RegExp`
+
+#### Defined in
+
+[packages/framework/esm-breadcrumbs/src/types.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/types.ts#L31)
+
+___
+
+### settings
+
+• **settings**: [`BreadcrumbSettings`](BreadcrumbSettings.md)
+
+#### Defined in
+
+[packages/framework/esm-breadcrumbs/src/types.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/types.ts#L32)

package/docs/interfaces/BreadcrumbSettings.md

@@ -0,0 +1,70 @@
+[@openmrs/esm-framework](../API.md) / BreadcrumbSettings
+
+# Interface: BreadcrumbSettings
+
+## Table of contents
+
+### Properties
+
+- [matcher](BreadcrumbSettings.md#matcher)
+- [parent](BreadcrumbSettings.md#parent)
+- [path](BreadcrumbSettings.md#path)
+- [title](BreadcrumbSettings.md#title)
+
+## Properties
+
+### matcher
+
+• `Optional` **matcher**: `string` \| `RegExp`
+
+A string or RegEx that determines whether the breadcrumb should be displayed.
+It is tested against the current location's path.
+
+If `matcher` is a string, it can contain route parameters. e.g. `/foo/:bar`.
+
+Can be omitted; the value of `path` is used as the default value.
+
+#### Defined in
+
+[packages/framework/esm-breadcrumbs/src/types.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/types.ts#L14)
+
+___
+
+### parent
+
+• `Optional` **parent**: `string`
+
+The breadcrumb's parent breadcrumb. Supply the path of the breadcrumb here, e.g.,
+if we are currently in "/foo/bar", you could provide "/foo" to get the breadcrumb
+associated with the path "/foo".
+
+If a path is missing for some reason, the closest matching one will be taken as
+parent.
+
+#### Defined in
+
+[packages/framework/esm-breadcrumbs/src/types.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/types.ts#L23)
+
+___
+
+### path
+
+• **path**: `string`
+
+Gets the path of breadcrumb for navigation purposes.
+
+#### Defined in
+
+[packages/framework/esm-breadcrumbs/src/types.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/types.ts#L5)
+
+___
+
+### title
+
+• **title**: `string` \| (`params`: `any`) => `string`
+
+The title of the breadcrumb.
+
+#### Defined in
+
+[packages/framework/esm-breadcrumbs/src/types.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-breadcrumbs/src/types.ts#L27)

package/docs/interfaces/CancelLoading.md

@@ -0,0 +1,17 @@
+[@openmrs/esm-framework](../API.md) / CancelLoading
+
+# Interface: CancelLoading
+
+## Callable
+
+### CancelLoading
+
+▸ **CancelLoading**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/render.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L15)

package/docs/interfaces/ClearDynamicRoutesMessage.md

@@ -0,0 +1,29 @@
+[@openmrs/esm-framework](../API.md) / ClearDynamicRoutesMessage
+
+# Interface: ClearDynamicRoutesMessage
+
+## Hierarchy
+
+- [`OmrsServiceWorkerMessage`](OmrsServiceWorkerMessage.md)<``"clearDynamicRoutes"``\>
+
+  ↳ **`ClearDynamicRoutesMessage`**
+
+## Table of contents
+
+### Properties
+
+- [type](ClearDynamicRoutesMessage.md#type)
+
+## Properties
+
+### type
+
+• **type**: ``"clearDynamicRoutes"``
+
+#### Inherited from
+
+[OmrsServiceWorkerMessage](OmrsServiceWorkerMessage.md).[type](OmrsServiceWorkerMessage.md#type)
+
+#### Defined in
+
+[packages/framework/esm-offline/src/service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)

package/docs/interfaces/ComponentConfig.md

@@ -0,0 +1,30 @@
+[@openmrs/esm-framework](../API.md) / ComponentConfig
+
+# Interface: ComponentConfig
+
+## Table of contents
+
+### Properties
+
+- [extension](ComponentConfig.md#extension)
+- [moduleName](ComponentConfig.md#modulename)
+
+## Properties
+
+### extension
+
+• `Optional` **extension**: [`ExtensionData`](ExtensionData.md)
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/ComponentContext.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L11)
+
+___
+
+### moduleName
+
+• **moduleName**: `string`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/ComponentContext.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L10)

package/docs/interfaces/ComponentDecoratorOptions.md

@@ -0,0 +1,52 @@
+[@openmrs/esm-framework](../API.md) / ComponentDecoratorOptions
+
+# Interface: ComponentDecoratorOptions
+
+## Table of contents
+
+### Properties
+
+- [disableTranslations](ComponentDecoratorOptions.md#disabletranslations)
+- [featureName](ComponentDecoratorOptions.md#featurename)
+- [moduleName](ComponentDecoratorOptions.md#modulename)
+- [strictMode](ComponentDecoratorOptions.md#strictmode)
+
+## Properties
+
+### disableTranslations
+
+• `Optional` **disableTranslations**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L57)
+
+___
+
+### featureName
+
+• **featureName**: `string`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L56)
+
+___
+
+### moduleName
+
+• **moduleName**: `string`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L55)
+
+___
+
+### strictMode
+
+• `Optional` **strictMode**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L58)

package/docs/interfaces/ComponentDefinition.md

@@ -0,0 +1,101 @@
+[@openmrs/esm-framework](../API.md) / ComponentDefinition
+
+# Interface: ComponentDefinition
+
+## Hierarchy
+
+- **`ComponentDefinition`**
+
+  ↳ [`ExtensionComponentDefinition`](ExtensionComponentDefinition.md)
+
+  ↳ [`PageDefinition`](PageDefinition.md)
+
+## Table of contents
+
+### Properties
+
+- [appName](ComponentDefinition.md#appname)
+- [offline](ComponentDefinition.md#offline)
+- [online](ComponentDefinition.md#online)
+- [privilege](ComponentDefinition.md#privilege)
+- [resources](ComponentDefinition.md#resources)
+
+### Methods
+
+- [load](ComponentDefinition.md#load)
+
+## Properties
+
+### appName
+
+• **appName**: `string`
+
+The module/app that defines the component
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L86)
+
+___
+
+### offline
+
+• `Optional` **offline**: `boolean` \| `object`
+
+Defines the offline support / properties of the component.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:98](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L98)
+
+___
+
+### online
+
+• `Optional` **online**: `boolean` \| `object`
+
+Defines the online support / properties of the component.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:94](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L94)
+
+___
+
+### privilege
+
+• `Optional` **privilege**: `string`
+
+Defines the access privilege required for this component, if any.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:102](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L102)
+
+___
+
+### resources
+
+• `Optional` **resources**: `Record`<`string`, [`ResourceLoader`](ResourceLoader.md)<`any`\>\>
+
+Defines resources that are loaded when the component should mount.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:106](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L106)
+
+## Methods
+
+### load
+
+▸ **load**(): `Promise`<`any`\>
+
+Defines a function to use for actually loading the component's lifecycle.
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L90)