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

package/docs/interfaces/ExtensionSlotConfigObject.md

@@ -0,0 +1,41 @@
+[@openmrs/esm-framework](../API.md) / ExtensionSlotConfigObject
+
+# Interface: ExtensionSlotConfigObject
+
+## Table of contents
+
+### Properties
+
+- [add](ExtensionSlotConfigObject.md#add)
+- [order](ExtensionSlotConfigObject.md#order)
+- [remove](ExtensionSlotConfigObject.md#remove)
+
+## Properties
+
+### add
+
+• `Optional` **add**: `string`[]
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L50)
+
+___
+
+### order
+
+• `Optional` **order**: `string`[]
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L52)
+
+___
+
+### remove
+
+• `Optional` **remove**: `string`[]
+
+#### Defined in
+
+[packages/framework/esm-config/src/types.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L51)

package/docs/interfaces/ExtensionSlotConfigsStore.md

@@ -0,0 +1,32 @@
+[@openmrs/esm-framework](../API.md) / ExtensionSlotConfigsStore
+
+# Interface: ExtensionSlotConfigsStore
+
+## Table of contents
+
+### Properties
+
+- [extensionSlotConfigs](ExtensionSlotConfigsStore.md#extensionslotconfigs)
+- [loaded](ExtensionSlotConfigsStore.md#loaded)
+
+## Properties
+
+### extensionSlotConfigs
+
+• **extensionSlotConfigs**: `Record`<`string`, [`ExtensionSlotConfigObject`](ExtensionSlotConfigObject.md)\>
+
+Configs for each extension slot in the module, indexed by slot name
+
+#### Defined in
+
+[packages/framework/esm-config/src/module-config/state.ts:152](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L152)
+
+___
+
+### loaded
+
+• **loaded**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-config/src/module-config/state.ts:153](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L153)

package/docs/interfaces/ExtensionSlotConfigureValueObject.md

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

package/docs/interfaces/ExtensionSlotInfo.md

@@ -0,0 +1,50 @@
+[@openmrs/esm-framework](../API.md) / ExtensionSlotInfo
+
+# Interface: ExtensionSlotInfo
+
+## Table of contents
+
+### Properties
+
+- [attachedIds](ExtensionSlotInfo.md#attachedids)
+- [instances](ExtensionSlotInfo.md#instances)
+- [name](ExtensionSlotInfo.md#name)
+
+## Properties
+
+### attachedIds
+
+• **attachedIds**: `string`[]
+
+The set of extension IDs which have been attached to this slot.
+This is essentially a complete history of `attach` calls to this specific slot.
+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:74](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L74)
+
+___
+
+### instances
+
+• **instances**: `Record`<`string`, [`ExtensionSlotInstance`](ExtensionSlotInstance.md)\>
+
+The mapping of modules / extension slot instances where the extension slot has been used.
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L67)
+
+___
+
+### name
+
+• **name**: `string`
+
+The name under which the extension slot has been registered.
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:63](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L63)

package/docs/interfaces/ExtensionSlotInstance.md

@@ -0,0 +1,51 @@
+[@openmrs/esm-framework](../API.md) / ExtensionSlotInstance
+
+# Interface: ExtensionSlotInstance
+
+## Table of contents
+
+### Properties
+
+- [addedIds](ExtensionSlotInstance.md#addedids)
+- [idOrder](ExtensionSlotInstance.md#idorder)
+- [removedIds](ExtensionSlotInstance.md#removedids)
+
+## Properties
+
+### addedIds
+
+• **addedIds**: `string`[]
+
+A set of additional extension IDs which have been added to to this slot despite not being
+explicitly `attach`ed to it.
+An example may be an extension which is added to the slot via the configuration.
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:46](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L46)
+
+___
+
+### idOrder
+
+• **idOrder**: `string`[]
+
+A set allowing explicit ordering of the `assignedIds`.
+
+#### 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)
+
+___
+
+### removedIds
+
+• **removedIds**: `string`[]
+
+A set of extension IDs which have been removed/hidden from this slot, even though they have
+previously been `attach`ed/added to it.
+An example may be an extension which is removed from the slot via the configuration.
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L52)

package/docs/interfaces/ExtensionStore.md

@@ -0,0 +1,34 @@
+[@openmrs/esm-framework](../API.md) / ExtensionStore
+
+# Interface: ExtensionStore
+
+## Table of contents
+
+### Properties
+
+- [extensions](ExtensionStore.md#extensions)
+- [slots](ExtensionStore.md#slots)
+
+## Properties
+
+### extensions
+
+• **extensions**: `Record`<`string`, [`ExtensionInfo`](ExtensionInfo.md)\>
+
+Extensions indexed by name
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L37)
+
+___
+
+### slots
+
+• **slots**: `Record`<`string`, [`ExtensionSlotInfo`](ExtensionSlotInfo.md)\>
+
+Slots indexed by name
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L35)

package/docs/interfaces/FHIRCode.md

@@ -0,0 +1,30 @@
+[@openmrs/esm-framework](../API.md) / FHIRCode
+
+# Interface: FHIRCode
+
+## Table of contents
+
+### Properties
+
+- [code](FHIRCode.md#code)
+- [system](FHIRCode.md#system)
+
+## Properties
+
+### code
+
+• **code**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/fhir-resource.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/fhir-resource.ts#L27)
+
+___
+
+### system
+
+• **system**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/fhir-resource.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/fhir-resource.ts#L28)

package/docs/interfaces/FHIRRequestObj.md

@@ -0,0 +1,41 @@
+[@openmrs/esm-framework](../API.md) / FHIRRequestObj
+
+# Interface: FHIRRequestObj
+
+## Table of contents
+
+### Properties
+
+- [headers](FHIRRequestObj.md#headers)
+- [method](FHIRRequestObj.md#method)
+- [url](FHIRRequestObj.md#url)
+
+## Properties
+
+### headers
+
+• **headers**: [`FetchHeaders`](FetchHeaders.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/fhir.ts:49](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L49)
+
+___
+
+### method
+
+• **method**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/fhir.ts:48](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L48)
+
+___
+
+### url
+
+• **url**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/fhir.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/fhir.ts#L47)

package/docs/interfaces/FHIRResource.md

@@ -0,0 +1,46 @@
+[@openmrs/esm-framework](../API.md) / FHIRResource
+
+# Interface: FHIRResource
+
+## Table of contents
+
+### Properties
+
+- [resource](FHIRResource.md#resource)
+
+## Properties
+
+### resource
+
+• **resource**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `code` | `Object` |
+| `code.coding` | [`FHIRCode`](FHIRCode.md)[] |
+| `effectiveDateTime` | `Date` |
+| `encounter` | `Object` |
+| `encounter.reference` | `string` |
+| `encounter.type` | `string` |
+| `id` | `string` |
+| `issued` | `Date` |
+| `referenceRange` | `any` |
+| `resourceType` | `string` |
+| `status` | `string` |
+| `subject` | `Object` |
+| `subject.display` | `string` |
+| `subject.identifier` | `Object` |
+| `subject.identifier.id` | `string` |
+| `subject.identifier.system` | `string` |
+| `subject.identifier.use` | `string` |
+| `subject.identifier.value` | `string` |
+| `subject.reference` | `string` |
+| `subject.type` | `string` |
+| `valueQuantity` | `Object` |
+| `valueQuantity.value` | `number` |
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/fhir-resource.ts:2](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/fhir-resource.ts#L2)

package/docs/interfaces/FetchHeaders.md

@@ -0,0 +1,7 @@
+[@openmrs/esm-framework](../API.md) / FetchHeaders
+
+# Interface: FetchHeaders
+
+## Indexable
+
+▪ [key: `string`]: `string` \| ``null``

package/docs/interfaces/FetchResponse.md

@@ -0,0 +1,285 @@
+[@openmrs/esm-framework](../API.md) / FetchResponse
+
+# Interface: FetchResponse<T\>
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | `any` |
+
+## Hierarchy
+
+- `Response`
+
+  ↳ **`FetchResponse`**
+
+  ↳↳ [`LoggedInUserFetchResponse`](LoggedInUserFetchResponse.md)
+
+## Table of contents
+
+### Properties
+
+- [body](FetchResponse.md#body)
+- [bodyUsed](FetchResponse.md#bodyused)
+- [data](FetchResponse.md#data)
+- [headers](FetchResponse.md#headers)
+- [ok](FetchResponse.md#ok)
+- [redirected](FetchResponse.md#redirected)
+- [status](FetchResponse.md#status)
+- [statusText](FetchResponse.md#statustext)
+- [type](FetchResponse.md#type)
+- [url](FetchResponse.md#url)
+
+### Methods
+
+- [arrayBuffer](FetchResponse.md#arraybuffer)
+- [blob](FetchResponse.md#blob)
+- [clone](FetchResponse.md#clone)
+- [formData](FetchResponse.md#formdata)
+- [json](FetchResponse.md#json)
+- [text](FetchResponse.md#text)
+
+## Properties
+
+### body
+
+• `Readonly` **body**: ``null`` \| `ReadableStream`<`Uint8Array`\>
+
+#### Inherited from
+
+Response.body
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2444
+
+___
+
+### bodyUsed
+
+• `Readonly` **bodyUsed**: `boolean`
+
+#### Inherited from
+
+Response.bodyUsed
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2445
+
+___
+
+### data
+
+• **data**: `T`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/fetch.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/fetch.ts#L4)
+
+___
+
+### headers
+
+• `Readonly` **headers**: `Headers`
+
+#### Inherited from
+
+Response.headers
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12143
+
+___
+
+### ok
+
+• `Readonly` **ok**: `boolean`
+
+#### Inherited from
+
+Response.ok
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12144
+
+___
+
+### redirected
+
+• `Readonly` **redirected**: `boolean`
+
+#### Inherited from
+
+Response.redirected
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12145
+
+___
+
+### status
+
+• `Readonly` **status**: `number`
+
+#### Inherited from
+
+Response.status
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12146
+
+___
+
+### statusText
+
+• `Readonly` **statusText**: `string`
+
+#### Inherited from
+
+Response.statusText
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12147
+
+___
+
+### type
+
+• `Readonly` **type**: `ResponseType`
+
+#### Inherited from
+
+Response.type
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12148
+
+___
+
+### url
+
+• `Readonly` **url**: `string`
+
+#### Inherited from
+
+Response.url
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12149
+
+## Methods
+
+### arrayBuffer
+
+▸ **arrayBuffer**(): `Promise`<`ArrayBuffer`\>
+
+#### Returns
+
+`Promise`<`ArrayBuffer`\>
+
+#### Inherited from
+
+Response.arrayBuffer
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2446
+
+___
+
+### blob
+
+▸ **blob**(): `Promise`<`Blob`\>
+
+#### Returns
+
+`Promise`<`Blob`\>
+
+#### Inherited from
+
+Response.blob
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2447
+
+___
+
+### clone
+
+▸ **clone**(): `Response`
+
+#### Returns
+
+`Response`
+
+#### Inherited from
+
+Response.clone
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:12150
+
+___
+
+### formData
+
+▸ **formData**(): `Promise`<`FormData`\>
+
+#### Returns
+
+`Promise`<`FormData`\>
+
+#### Inherited from
+
+Response.formData
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2448
+
+___
+
+### json
+
+▸ **json**(): `Promise`<`any`\>
+
+#### Returns
+
+`Promise`<`any`\>
+
+#### Inherited from
+
+Response.json
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2449
+
+___
+
+### text
+
+▸ **text**(): `Promise`<`string`\>
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Inherited from
+
+Response.text
+
+#### Defined in
+
+node_modules/typescript/lib/lib.dom.d.ts:2450

package/docs/interfaces/ImplementerToolsConfigStore.md

@@ -0,0 +1,19 @@
+[@openmrs/esm-framework](../API.md) / ImplementerToolsConfigStore
+
+# Interface: ImplementerToolsConfigStore
+
+## Table of contents
+
+### Properties
+
+- [config](ImplementerToolsConfigStore.md#config)
+
+## Properties
+
+### config
+
+• **config**: [`Config`](Config.md)
+
+#### Defined in
+
+[packages/framework/esm-config/src/module-config/state.ts:185](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L185)

package/docs/interfaces/ImportMap.md

@@ -0,0 +1,19 @@
+[@openmrs/esm-framework](../API.md) / ImportMap
+
+# Interface: ImportMap
+
+## Table of contents
+
+### Properties
+
+- [imports](ImportMap.md#imports)
+
+## Properties
+
+### imports
+
+• **imports**: `Record`<`string`, `string`\>
+
+#### Defined in
+
+[packages/framework/esm-globals/src/types.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L50)