@openmrs/esm-framework 3.2.1-pre.986 → 3.3.1-pre.1173

package/docs/interfaces/ExtensionSlotInfo.md

@@ -1,64 +0,0 @@
-[@openmrs/esm-framework](../API.md) / ExtensionSlotInfo
-
-# Interface: ExtensionSlotInfo
-
-## Table of contents
-
-### Properties
-
-- [attachedIds](ExtensionSlotInfo.md#attachedids)
-- [config](ExtensionSlotInfo.md#config)
-- [moduleName](ExtensionSlotInfo.md#modulename)
-- [name](ExtensionSlotInfo.md#name)
-
-## Properties
-
-### attachedIds
-
-• **attachedIds**: `string`[]
-
-The set of extension IDs which have been attached to this slot using `attach`.
-However, not all of these extension IDs should be rendered.
-`assignedIds` is the set defining those.
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L56)
-
-___
-
-### config
-
-• **config**: ``null`` \| [`ExtensionSlotConfigObject`](ExtensionSlotConfigObject.md)
-
-The configuration provided for this extension slot. `null` if not yet loaded.
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L58)
-
-___
-
-### moduleName
-
-• `Optional` **moduleName**: `string`
-
-The module in which the extension slot exists. Undefined if the slot
-hasn't been registered yet (but it has been attached or assigned to
-an extension.
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L48)
-
-___
-
-### name
-
-• **name**: `string`
-
-The name under which the extension slot has been registered.
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L50)

package/docs/interfaces/NavigationContext.md

@@ -1,50 +0,0 @@
-[@openmrs/esm-framework](../API.md) / NavigationContext
-
-# Interface: NavigationContext
-
-## Table of contents
-
-### Properties
-
-- [type](NavigationContext.md#type)
-
-### Methods
-
-- [handler](NavigationContext.md#handler)
-
-## Properties
-
-### type
-
-• **type**: [`NavigationContextType`](../API.md#navigationcontexttype)
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/contexts.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L6)
-
-## Methods
-
-### handler
-
-▸ **handler**<`T`\>(`link`, `state`): `boolean`
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | `any` |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `link` | `string` |
-| `state` | `T` |
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/contexts.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L7)

package/docs/interfaces/NetworkRequestFailedEvent.md

@@ -1,49 +0,0 @@
-[@openmrs/esm-framework](../API.md) / NetworkRequestFailedEvent
-
-# Interface: NetworkRequestFailedEvent
-
-## Hierarchy
-
-- [`OmrsServiceWorkerEvent`](OmrsServiceWorkerEvent.md)<``"networkRequestFailed"``\>
-
-  ↳ **`NetworkRequestFailedEvent`**
-
-## Table of contents
-
-### Properties
-
-- [request](NetworkRequestFailedEvent.md#request)
-- [type](NetworkRequestFailedEvent.md#type)
-
-## Properties
-
-### request
-
-• **request**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `body` | `string` |
-| `headers` | `Record`<`string`, `string`\> |
-| `method` | `string` |
-| `url` | `string` |
-
-#### Defined in
-
-[packages/framework/esm-offline/src/service-worker-events.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-events.ts#L7)
-
-___
-
-### type
-
-• **type**: ``"networkRequestFailed"``
-
-#### Inherited from
-
-[OmrsServiceWorkerEvent](OmrsServiceWorkerEvent.md).[type](OmrsServiceWorkerEvent.md#type)
-
-#### Defined in
-
-[packages/framework/esm-offline/src/service-worker-events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-events.ts#L2)

package/docs/interfaces/OfflineSynchronizationStore.md

@@ -1,30 +0,0 @@
-[@openmrs/esm-framework](../API.md) / OfflineSynchronizationStore
-
-# Interface: OfflineSynchronizationStore
-
-Represents the data inside the global offline synchronization store.
-Provides information about a currently ongoing synchronization.
-
-## Table of contents
-
-### Properties
-
-- [synchronization](OfflineSynchronizationStore.md#synchronization)
-
-## Properties
-
-### synchronization
-
-• `Optional` **synchronization**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `abortController` | `AbortController` |
-| `pendingCount` | `number` |
-| `totalCount` | `number` |
-
-#### Defined in
-
-[packages/framework/esm-offline/src/sync.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L93)

package/docs/interfaces/OmrsServiceWorkerEvent.md

@@ -1,31 +0,0 @@
-[@openmrs/esm-framework](../API.md) / OmrsServiceWorkerEvent
-
-# Interface: OmrsServiceWorkerEvent<TypeIdentifier\>
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TypeIdentifier` | extends `string` |
-
-## Hierarchy
-
-- **`OmrsServiceWorkerEvent`**
-
-  ↳ [`NetworkRequestFailedEvent`](NetworkRequestFailedEvent.md)
-
-## Table of contents
-
-### Properties
-
-- [type](OmrsServiceWorkerEvent.md#type)
-
-## Properties
-
-### type
-
-• **type**: `TypeIdentifier`
-
-#### Defined in
-
-[packages/framework/esm-offline/src/service-worker-events.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/service-worker-events.ts#L2)

package/docs/interfaces/OpenmrsReactComponentProps.md

@@ -1,19 +0,0 @@
-[@openmrs/esm-framework](../API.md) / OpenmrsReactComponentProps
-
-# Interface: OpenmrsReactComponentProps
-
-## Table of contents
-
-### Properties
-
-- [\_extensionContext](OpenmrsReactComponentProps.md#_extensioncontext)
-
-## Properties
-
-### \_extensionContext
-
-• `Optional` **\_extensionContext**: [`ExtensionData`](ExtensionData.md)
-
-#### Defined in
-
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:62](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L62)

package/docs/interfaces/OpenmrsReactComponentState.md

@@ -1,41 +0,0 @@
-[@openmrs/esm-framework](../API.md) / OpenmrsReactComponentState
-
-# Interface: OpenmrsReactComponentState
-
-## Table of contents
-
-### Properties
-
-- [caughtError](OpenmrsReactComponentState.md#caughterror)
-- [caughtErrorInfo](OpenmrsReactComponentState.md#caughterrorinfo)
-- [config](OpenmrsReactComponentState.md#config)
-
-## Properties
-
-### caughtError
-
-• **caughtError**: `any`
-
-#### Defined in
-
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:66](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L66)
-
-___
-
-### caughtErrorInfo
-
-• **caughtErrorInfo**: `any`
-
-#### Defined in
-
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:67](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L67)
-
-___
-
-### config
-
-• **config**: [`ComponentConfig`](ComponentConfig.md)
-
-#### Defined in
-
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:68](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L68)

package/docs/interfaces/SessionUser.md

@@ -1,92 +0,0 @@
-[@openmrs/esm-framework](../API.md) / SessionUser
-
-# Interface: SessionUser
-
-## Table of contents
-
-### Properties
-
-- [allowedLocales](SessionUser.md#allowedlocales)
-- [authenticated](SessionUser.md#authenticated)
-- [currentProvider](SessionUser.md#currentprovider)
-- [locale](SessionUser.md#locale)
-- [sessionId](SessionUser.md#sessionid)
-- [sessionLocation](SessionUser.md#sessionlocation)
-- [user](SessionUser.md#user)
-
-## Properties
-
-### allowedLocales
-
-• **allowedLocales**: `string`[]
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L8)
-
-___
-
-### authenticated
-
-• **authenticated**: `boolean`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L9)
-
-___
-
-### currentProvider
-
-• **currentProvider**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `identifier` | `string` |
-| `uuid` | `string` |
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L13)
-
-___
-
-### locale
-
-• **locale**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L10)
-
-___
-
-### sessionId
-
-• **sessionId**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L11)
-
-___
-
-### sessionLocation
-
-• **sessionLocation**: `any`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L14)
-
-___
-
-### user
-
-• **user**: [`User`](User.md)
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L12)

package/docs/interfaces/UnauthenticatedUser.md

@@ -1,52 +0,0 @@
-[@openmrs/esm-framework](../API.md) / UnauthenticatedUser
-
-# Interface: UnauthenticatedUser
-
-## Table of contents
-
-### Properties
-
-- [authenticated](UnauthenticatedUser.md#authenticated)
-- [sessionId](UnauthenticatedUser.md#sessionid)
-- [sessionLocation](UnauthenticatedUser.md#sessionlocation)
-- [user](UnauthenticatedUser.md#user)
-
-## Properties
-
-### authenticated
-
-• **authenticated**: `boolean`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L30)
-
-___
-
-### sessionId
-
-• **sessionId**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L29)
-
-___
-
-### sessionLocation
-
-• `Optional` **sessionLocation**: [`SessionLocation`](SessionLocation.md)
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L32)
-
-___
-
-### user
-
-• `Optional` **user**: [`LoggedInUser`](LoggedInUser.md)
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/user-resource.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/user-resource.ts#L31)

package/docs/interfaces/User.md

@@ -1,107 +0,0 @@
-[@openmrs/esm-framework](../API.md) / User
-
-# Interface: User
-
-## Table of contents
-
-### Properties
-
-- [display](User.md#display)
-- [link](User.md#link)
-- [person](User.md#person)
-- [priviliges](User.md#priviliges)
-- [resourceVersion](User.md#resourceversion)
-- [roles](User.md#roles)
-- [userProperties](User.md#userproperties)
-- [username](User.md#username)
-- [uuid](User.md#uuid)
-
-## Properties
-
-### display
-
-• **display**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L18)
-
-___
-
-### link
-
-• **link**: `string`[]
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L19)
-
-___
-
-### person
-
-• **person**: `any`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L20)
-
-___
-
-### priviliges
-
-• **priviliges**: `any`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L21)
-
-___
-
-### resourceVersion
-
-• **resourceVersion**: `any`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L22)
-
-___
-
-### roles
-
-• **roles**: `any`[]
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L23)
-
-___
-
-### userProperties
-
-• **userProperties**: `any`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L24)
-
-___
-
-### username
-
-• **username**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L25)
-
-___
-
-### uuid
-
-• **uuid**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L26)