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

package/docs/interfaces/ExtensionComponentDefinition.md

@@ -0,0 +1,153 @@
+[@openmrs/esm-framework](../API.md) / ExtensionComponentDefinition
+
+# Interface: ExtensionComponentDefinition
+
+## Hierarchy
+
+- [`ComponentDefinition`](ComponentDefinition.md)
+
+  ↳ **`ExtensionComponentDefinition`**
+
+  ↳↳ [`ModernAppExtensionDefinition`](ModernAppExtensionDefinition.md)
+
+  ↳↳ [`LegacyAppExtensionDefinition`](LegacyAppExtensionDefinition.md)
+
+## Table of contents
+
+### Properties
+
+- [appName](ExtensionComponentDefinition.md#appname)
+- [meta](ExtensionComponentDefinition.md#meta)
+- [offline](ExtensionComponentDefinition.md#offline)
+- [online](ExtensionComponentDefinition.md#online)
+- [order](ExtensionComponentDefinition.md#order)
+- [privilege](ExtensionComponentDefinition.md#privilege)
+- [resources](ExtensionComponentDefinition.md#resources)
+
+### Methods
+
+- [load](ExtensionComponentDefinition.md#load)
+
+## Properties
+
+### appName
+
+• **appName**: `string`
+
+The module/app that defines the component
+
+#### Inherited from
+
+[ComponentDefinition](ComponentDefinition.md).[appName](ComponentDefinition.md#appname)
+
+#### 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)
+
+___
+
+### meta
+
+• `Optional` **meta**: `Record`<`string`, `any`\>
+
+The meta data used for reflection by other components.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:113](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L113)
+
+___
+
+### offline
+
+• `Optional` **offline**: `boolean` \| `object`
+
+Defines the offline support / properties of the component.
+
+#### Inherited from
+
+[ComponentDefinition](ComponentDefinition.md).[offline](ComponentDefinition.md#offline)
+
+#### 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.
+
+#### Inherited from
+
+[ComponentDefinition](ComponentDefinition.md).[online](ComponentDefinition.md#online)
+
+#### 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)
+
+___
+
+### order
+
+• `Optional` **order**: `number`
+
+Specifies a preferred order number, if any.
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:117](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L117)
+
+___
+
+### privilege
+
+• `Optional` **privilege**: `string`
+
+Defines the access privilege required for this component, if any.
+
+#### Inherited from
+
+[ComponentDefinition](ComponentDefinition.md).[privilege](ComponentDefinition.md#privilege)
+
+#### 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.
+
+#### Inherited from
+
+[ComponentDefinition](ComponentDefinition.md).[resources](ComponentDefinition.md#resources)
+
+#### 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`\>
+
+#### Inherited from
+
+[ComponentDefinition](ComponentDefinition.md).[load](ComponentDefinition.md#load)
+
+#### 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)

package/docs/interfaces/ExtensionData.md

@@ -0,0 +1,41 @@
+[@openmrs/esm-framework](../API.md) / ExtensionData
+
+# Interface: ExtensionData
+
+## Table of contents
+
+### Properties
+
+- [extensionId](ExtensionData.md#extensionid)
+- [extensionSlotModuleName](ExtensionData.md#extensionslotmodulename)
+- [extensionSlotName](ExtensionData.md#extensionslotname)
+
+## Properties
+
+### extensionId
+
+• **extensionId**: `string`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/ComponentContext.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L6)
+
+___
+
+### extensionSlotModuleName
+
+• **extensionSlotModuleName**: `string`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/ComponentContext.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L5)
+
+___
+
+### extensionSlotName
+
+• **extensionSlotName**: `string`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/ComponentContext.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L4)

package/docs/interfaces/ExtensionDetails.md

@@ -0,0 +1,81 @@
+[@openmrs/esm-framework](../API.md) / ExtensionDetails
+
+# Interface: ExtensionDetails
+
+## Table of contents
+
+### Properties
+
+- [meta](ExtensionDetails.md#meta)
+- [moduleName](ExtensionDetails.md#modulename)
+- [offline](ExtensionDetails.md#offline)
+- [online](ExtensionDetails.md#online)
+- [order](ExtensionDetails.md#order)
+
+### Methods
+
+- [load](ExtensionDetails.md#load)
+
+## Properties
+
+### meta
+
+• **meta**: `Record`<`string`, `any`\>
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/extensions.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L52)
+
+___
+
+### moduleName
+
+• **moduleName**: `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/extensions.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L50)
+
+___
+
+### offline
+
+• `Optional` **offline**: `boolean` \| `object`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/extensions.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L54)
+
+___
+
+### online
+
+• `Optional` **online**: `boolean` \| `object`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/extensions.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L53)
+
+___
+
+### order
+
+• `Optional` **order**: `number`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/extensions.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L55)
+
+## Methods
+
+### load
+
+▸ **load**(): `Promise`<`any`\>
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/extensions.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L51)

package/docs/interfaces/ExtensionInfo.md

@@ -0,0 +1,140 @@
+[@openmrs/esm-framework](../API.md) / ExtensionInfo
+
+# Interface: ExtensionInfo
+
+## Hierarchy
+
+- [`ExtensionRegistration`](ExtensionRegistration.md)
+
+  ↳ **`ExtensionInfo`**
+
+## Table of contents
+
+### Properties
+
+- [instances](ExtensionInfo.md#instances)
+- [meta](ExtensionInfo.md#meta)
+- [moduleName](ExtensionInfo.md#modulename)
+- [name](ExtensionInfo.md#name)
+- [offline](ExtensionInfo.md#offline)
+- [online](ExtensionInfo.md#online)
+- [order](ExtensionInfo.md#order)
+
+### Methods
+
+- [load](ExtensionInfo.md#load)
+
+## Properties
+
+### instances
+
+• **instances**: `Record`<`string`, `Record`<`string`, [`ExtensionInstance`](ExtensionInstance.md)\>\>
+
+The instances where the extension has been rendered using `renderExtension`,
+indexed by slotModuleName and slotName.
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L26)
+
+___
+
+### meta
+
+• **meta**: [`ExtensionMeta`](ExtensionMeta.md)
+
+#### Inherited from
+
+[ExtensionRegistration](ExtensionRegistration.md).[meta](ExtensionRegistration.md#meta)
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L15)
+
+___
+
+### moduleName
+
+• **moduleName**: `string`
+
+#### Inherited from
+
+[ExtensionRegistration](ExtensionRegistration.md).[moduleName](ExtensionRegistration.md#modulename)
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L14)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Inherited from
+
+[ExtensionRegistration](ExtensionRegistration.md).[name](ExtensionRegistration.md#name)
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L12)
+
+___
+
+### offline
+
+• `Optional` **offline**: `boolean` \| `object`
+
+#### Inherited from
+
+[ExtensionRegistration](ExtensionRegistration.md).[offline](ExtensionRegistration.md#offline)
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L18)
+
+___
+
+### online
+
+• `Optional` **online**: `boolean` \| `object`
+
+#### Inherited from
+
+[ExtensionRegistration](ExtensionRegistration.md).[online](ExtensionRegistration.md#online)
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L17)
+
+___
+
+### order
+
+• `Optional` **order**: `number`
+
+#### Inherited from
+
+[ExtensionRegistration](ExtensionRegistration.md).[order](ExtensionRegistration.md#order)
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L16)
+
+## Methods
+
+### load
+
+▸ **load**(): `Promise`<`any`\>
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Inherited from
+
+[ExtensionRegistration](ExtensionRegistration.md).[load](ExtensionRegistration.md#load)
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L13)

package/docs/interfaces/ExtensionInstance.md

@@ -0,0 +1,19 @@
+[@openmrs/esm-framework](../API.md) / ExtensionInstance
+
+# Interface: ExtensionInstance
+
+## Table of contents
+
+### Properties
+
+- [id](ExtensionInstance.md#id)
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L30)

package/docs/interfaces/ExtensionMeta.md

@@ -0,0 +1,7 @@
+[@openmrs/esm-framework](../API.md) / ExtensionMeta
+
+# Interface: ExtensionMeta
+
+## Indexable
+
+▪ [_: `string`]: `any`

package/docs/interfaces/ExtensionProps.md

@@ -0,0 +1,44 @@
+[@openmrs/esm-framework](../API.md) / ExtensionProps
+
+# Interface: ExtensionProps
+
+## Table of contents
+
+### Properties
+
+- [state](ExtensionProps.md#state)
+
+### Methods
+
+- [wrap](ExtensionProps.md#wrap)
+
+## Properties
+
+### state
+
+• `Optional` **state**: `Record`<`string`, `any`\>
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/Extension.tsx:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L6)
+
+## Methods
+
+### wrap
+
+▸ `Optional` **wrap**(`slot`, `extension`): ``null`` \| `ReactElement`<`any`, `any`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `slot` | `ReactNode` |
+| `extension` | [`ExtensionData`](ExtensionData.md) |
+
+#### Returns
+
+``null`` \| `ReactElement`<`any`, `any`\>
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/Extension.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L7)

package/docs/interfaces/ExtensionRegistration.md

@@ -0,0 +1,98 @@
+[@openmrs/esm-framework](../API.md) / ExtensionRegistration
+
+# Interface: ExtensionRegistration
+
+## Hierarchy
+
+- **`ExtensionRegistration`**
+
+  ↳ [`ExtensionInfo`](ExtensionInfo.md)
+
+## Table of contents
+
+### Properties
+
+- [meta](ExtensionRegistration.md#meta)
+- [moduleName](ExtensionRegistration.md#modulename)
+- [name](ExtensionRegistration.md#name)
+- [offline](ExtensionRegistration.md#offline)
+- [online](ExtensionRegistration.md#online)
+- [order](ExtensionRegistration.md#order)
+
+### Methods
+
+- [load](ExtensionRegistration.md#load)
+
+## Properties
+
+### meta
+
+• **meta**: [`ExtensionMeta`](ExtensionMeta.md)
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L15)
+
+___
+
+### moduleName
+
+• **moduleName**: `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L14)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L12)
+
+___
+
+### offline
+
+• `Optional` **offline**: `boolean` \| `object`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L18)
+
+___
+
+### online
+
+• `Optional` **online**: `boolean` \| `object`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L17)
+
+___
+
+### order
+
+• `Optional` **order**: `number`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L16)
+
+## Methods
+
+### load
+
+▸ **load**(): `Promise`<`any`\>
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L13)

package/docs/interfaces/ExtensionSlotBaseProps.md

@@ -0,0 +1,54 @@
+[@openmrs/esm-framework](../API.md) / ExtensionSlotBaseProps
+
+# Interface: ExtensionSlotBaseProps
+
+## Table of contents
+
+### Properties
+
+- [extensionSlotName](ExtensionSlotBaseProps.md#extensionslotname)
+- [state](ExtensionSlotBaseProps.md#state)
+
+### Methods
+
+- [select](ExtensionSlotBaseProps.md#select)
+
+## Properties
+
+### extensionSlotName
+
+• **extensionSlotName**: `string`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L47)
+
+___
+
+### state
+
+• `Optional` **state**: `Record`<`string`, `any`\>
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L51)
+
+## Methods
+
+### select
+
+▸ `Optional` **select**(`extensions`): [`ExtensionRegistration`](ExtensionRegistration.md)[]
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `extensions` | [`ExtensionRegistration`](ExtensionRegistration.md)[] |
+
+#### Returns
+
+[`ExtensionRegistration`](ExtensionRegistration.md)[]
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/ExtensionSlot.tsx:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ExtensionSlot.tsx#L48)

package/docs/interfaces/ExtensionSlotConfig.md

@@ -0,0 +1,52 @@
+[@openmrs/esm-framework](../API.md) / ExtensionSlotConfig
+
+# Interface: ExtensionSlotConfig
+
+## Table of contents
+
+### Properties
+
+- [add](ExtensionSlotConfig.md#add)
+- [configure](ExtensionSlotConfig.md#configure)
+- [order](ExtensionSlotConfig.md#order)
+- [remove](ExtensionSlotConfig.md#remove)
+
+## Properties
+
+### add
+
+• `Optional` **add**: `string`[]
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L39)
+
+___
+
+### configure
+
+• `Optional` **configure**: [`ExtensionSlotConfigureValueObject`](ExtensionSlotConfigureValueObject.md)
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L42)
+
+___
+
+### order
+
+• `Optional` **order**: `string`[]
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L41)
+
+___
+
+### remove
+
+• `Optional` **remove**: `string`[]
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L40)