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

package/docs/interfaces/CancelLoading.md

@@ -1,17 +1,13 @@
-[@openmrs/esm-framework](../API.md) / CancelLoading
+[O3 Framework](../API.md) / CancelLoading
 
-# Interface: CancelLoading
+# Interface: CancelLoading()
 
-## Callable
+Defined in: [packages/framework/esm-extensions/src/render.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L7)
 
-### CancelLoading
+> **CancelLoading**(): `void`
 
-▸ **CancelLoading**(): `void`
+Defined in: [packages/framework/esm-extensions/src/render.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L8)
 
-#### Returns
+## Returns
 
 `void`
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/render.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/render.ts#L8)

package/docs/interfaces/ClearDynamicRoutesMessage.md

@@ -1,29 +1,21 @@
-[@openmrs/esm-framework](../API.md) / ClearDynamicRoutesMessage
+[O3 Framework](../API.md) / ClearDynamicRoutesMessage
 
 # Interface: ClearDynamicRoutesMessage
 
-## Hierarchy
+Defined in: [packages/framework/esm-offline/src/service-worker-messaging.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L34)
 
-- [`OmrsServiceWorkerMessage`](OmrsServiceWorkerMessage.md)<``"clearDynamicRoutes"``\>
+## Extends
 
-  ↳ **`ClearDynamicRoutesMessage`**
+- [`OmrsServiceWorkerMessage`](OmrsServiceWorkerMessage.md)\<`"clearDynamicRoutes"`\>
 
-## Table of contents
-
-### Offline Properties
-
-- [type](ClearDynamicRoutesMessage.md#type)
-
-## Offline Properties
+## Properties
 
 ### type
 
-• **type**: ``"clearDynamicRoutes"``
+> **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/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
 
-#### Defined in
+#### Inherited from
 
-[packages/framework/esm-offline/src/service-worker-messaging.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/service-worker-messaging.ts#L26)
+[`OmrsServiceWorkerMessage`](OmrsServiceWorkerMessage.md).[`type`](OmrsServiceWorkerMessage.md#type)

package/docs/interfaces/CloseWorkspaceOptions.md

@@ -1,54 +1,47 @@
-[@openmrs/esm-framework](../API.md) / CloseWorkspaceOptions
+[O3 Framework](../API.md) / CloseWorkspaceOptions
 
 # Interface: CloseWorkspaceOptions
 
-## Table of contents
+Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L15)
 
-### Workspace Properties
+## Properties
 
-- [closeWorkspaceGroup](CloseWorkspaceOptions.md#closeworkspacegroup)
-- [ignoreChanges](CloseWorkspaceOptions.md#ignorechanges)
+### closeWorkspaceGroup?
 
-### Workspace Methods
+> `optional` **closeWorkspaceGroup**: `boolean`
 
-- [onWorkspaceClose](CloseWorkspaceOptions.md#onworkspaceclose)
-
-## Workspace Properties
-
-### closeWorkspaceGroup
-
-• `Optional` **closeWorkspaceGroup**: `boolean`
+Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L37)
 
 Controls whether the workspace group should be closed and store to be
 cleared when this workspace is closed.
 Defaults to true except when opening a new workspace of the same group.
 
-**`default`** true
+#### Default
 
-#### Defined in
+```ts
+true
+```
 
-[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:37](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L37)
+***
 
-___
+### ignoreChanges?
 
-### ignoreChanges
+> `optional` **ignoreChanges**: `boolean`
 
-• `Optional` **ignoreChanges**: `boolean`
+Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L22)
 
 Whether to close the workspace ignoring all the changes present in the workspace.
 
 If ignoreChanges is true, the user will not be prompted to save changes before closing
 even if the `testFcn` passed to `promptBeforeClosing` returns `true`.
 
-#### Defined in
+***
 
-[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L22)
+### onWorkspaceClose()?
 
-## Workspace Methods
+> `optional` **onWorkspaceClose**: () => `void`
 
-### onWorkspaceClose
-
-▸ `Optional` **onWorkspaceClose**(): `void`
+Defined in: [packages/framework/esm-styleguide/src/workspaces/workspaces.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L29)
 
 If you want to take an action after the workspace is closed, you can pass your function as
 `onWorkspaceClose`. This function will be called only after the workspace is closed, given
@@ -59,7 +52,3 @@ that the user might be shown a prompt.
 `void`
 
 void
-
-#### Defined in
-
-[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L29)

package/docs/interfaces/ComponentConfig.md

@@ -1,41 +1,29 @@
-[@openmrs/esm-framework](../API.md) / ComponentConfig
+[O3 Framework](../API.md) / ComponentConfig
 
 # Interface: ComponentConfig
 
-## Table of contents
-
-### Properties
-
-- [extension](ComponentConfig.md#extension)
-- [featureName](ComponentConfig.md#featurename)
-- [moduleName](ComponentConfig.md#modulename)
+Defined in: [packages/framework/esm-extensions/src/types.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L7)
 
 ## Properties
 
-### extension
-
-• `Optional` **extension**: [`ExtensionData`](ExtensionData.md)
+### extension?
 
-#### Defined in
+> `optional` **extension**: [`ExtensionData`](ExtensionData.md)
 
-[packages/framework/esm-extensions/src/types.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L10)
+Defined in: [packages/framework/esm-extensions/src/types.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L10)
 
-___
+***
 
 ### featureName
 
-• **featureName**: `string`
+> **featureName**: `string`
 
-#### Defined in
+Defined in: [packages/framework/esm-extensions/src/types.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L9)
 
-[packages/framework/esm-extensions/src/types.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L9)
-
-___
+***
 
 ### moduleName
 
-• **moduleName**: `string`
-
-#### Defined in
+> **moduleName**: `string`
 
-[packages/framework/esm-extensions/src/types.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L8)
+Defined in: [packages/framework/esm-extensions/src/types.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/types.ts#L8)

package/docs/interfaces/Concept.md

@@ -1,221 +1,173 @@
-[@openmrs/esm-framework](../API.md) / Concept
+[O3 Framework](../API.md) / Concept
 
 # Interface: Concept
 
-## Hierarchy
+Defined in: [packages/framework/esm-api/src/types/concept-resource.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L4)
 
-- [`OpenmrsResource`](OpenmrsResource.md)
-
-  ↳ **`Concept`**
-
-## Table of contents
-
-### Properties
-
-- [answers](Concept.md#answers)
-- [attributes](Concept.md#attributes)
-- [auditInfo](Concept.md#auditinfo)
-- [conceptClass](Concept.md#conceptclass)
-- [datatype](Concept.md#datatype)
-- [descriptions](Concept.md#descriptions)
-- [display](Concept.md#display)
-- [links](Concept.md#links)
-- [mappings](Concept.md#mappings)
-- [name](Concept.md#name)
-- [names](Concept.md#names)
-- [resourceVersion](Concept.md#resourceversion)
-- [retired](Concept.md#retired)
-- [set](Concept.md#set)
-- [setMembers](Concept.md#setmembers)
-- [uuid](Concept.md#uuid)
-- [version](Concept.md#version)
+Superclass for all Openmrs Resources, with strict typings.
+If the subclass does not have all attributes (including optional ones)
+accounted for, use OpenmrsResource instead.
 
-## Properties
+## Extends
 
-### answers
+- [`OpenmrsResource`](OpenmrsResource.md)
 
-• `Optional` **answers**: `any`
+## Indexable
 
-#### Defined in
+\[`anythingElse`: `string`\]: `any`
 
-[packages/framework/esm-api/src/types/concept-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L15)
+## Properties
 
-___
+### answers?
 
-### attributes
+> `optional` **answers**: `any`
 
-• `Optional` **attributes**: `any`
+Defined in: [packages/framework/esm-api/src/types/concept-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L15)
 
-#### Defined in
+***
 
-[packages/framework/esm-api/src/types/concept-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L17)
+### attributes?
 
-___
+> `optional` **attributes**: `any`
 
-### auditInfo
+Defined in: [packages/framework/esm-api/src/types/concept-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L17)
 
-• `Optional` **auditInfo**: [`AuditInfo`](AuditInfo.md)
+***
 
-#### Inherited from
+### auditInfo?
 
-[OpenmrsResource](OpenmrsResource.md).[auditInfo](OpenmrsResource.md#auditinfo)
+> `optional` **auditInfo**: [`AuditInfo`](AuditInfo.md)
 
-#### Defined in
+Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L16)
 
-[packages/framework/esm-api/src/types/openmrs-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L16)
-
-___
+#### Inherited from
 
-### conceptClass
+[`OpenmrsResource`](OpenmrsResource.md).[`auditInfo`](OpenmrsResource.md#auditinfo)
 
-• `Optional` **conceptClass**: [`ConceptClass`](ConceptClass.md)
+***
 
-#### Defined in
+### conceptClass?
 
-[packages/framework/esm-api/src/types/concept-resource.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L7)
+> `optional` **conceptClass**: [`ConceptClass`](ConceptClass.md)
 
-___
+Defined in: [packages/framework/esm-api/src/types/concept-resource.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L7)
 
-### datatype
+***
 
-• `Optional` **datatype**: [`ConceptDatatype`](ConceptDatatype.md)
+### datatype?
 
-#### Defined in
+> `optional` **datatype**: [`ConceptDatatype`](ConceptDatatype.md)
 
-[packages/framework/esm-api/src/types/concept-resource.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L6)
+Defined in: [packages/framework/esm-api/src/types/concept-resource.ts:6](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L6)
 
-___
+***
 
-### descriptions
+### descriptions?
 
-• `Optional` **descriptions**: [`OpenmrsResource`](OpenmrsResource.md)[]
+> `optional` **descriptions**: [`OpenmrsResource`](OpenmrsResource.md)[]
 
-#### Defined in
+Defined in: [packages/framework/esm-api/src/types/concept-resource.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L12)
 
-[packages/framework/esm-api/src/types/concept-resource.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L12)
+***
 
-___
+### display?
 
-### display
+> `optional` **display**: `string`
 
-• `Optional` **display**: `string`
+Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L14)
 
 #### Inherited from
 
-[OpenmrsResource](OpenmrsResource.md).[display](OpenmrsResource.md#display)
-
-#### Defined in
+[`OpenmrsResource`](OpenmrsResource.md).[`display`](OpenmrsResource.md#display)
 
-[packages/framework/esm-api/src/types/openmrs-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L14)
+***
 
-___
+### links?
 
-### links
+> `optional` **links**: [`Link`](Link.md)[]
 
-• `Optional` **links**: [`Link`](Link.md)[]
+Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L15)
 
 #### Inherited from
 
-[OpenmrsResource](OpenmrsResource.md).[links](OpenmrsResource.md#links)
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L15)
+[`OpenmrsResource`](OpenmrsResource.md).[`links`](OpenmrsResource.md#links)
 
-___
+***
 
-### mappings
+### mappings?
 
-• `Optional` **mappings**: `any`
+> `optional` **mappings**: `any`
 
-#### Defined in
+Defined in: [packages/framework/esm-api/src/types/concept-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L14)
 
-[packages/framework/esm-api/src/types/concept-resource.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L14)
+***
 
-___
+### name?
 
-### name
+> `optional` **name**: [`ConceptName`](ConceptName.md)
 
-• `Optional` **name**: [`ConceptName`](ConceptName.md)
+Defined in: [packages/framework/esm-api/src/types/concept-resource.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L5)
 
-#### Defined in
+***
 
-[packages/framework/esm-api/src/types/concept-resource.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L5)
+### names?
 
-___
+> `optional` **names**: [`ConceptName`](ConceptName.md)[]
 
-### names
+Defined in: [packages/framework/esm-api/src/types/concept-resource.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L11)
 
-• `Optional` **names**: [`ConceptName`](ConceptName.md)[]
+***
 
-#### Defined in
+### resourceVersion?
 
-[packages/framework/esm-api/src/types/concept-resource.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L11)
+> `optional` **resourceVersion**: `string`
 
-___
-
-### resourceVersion
-
-• `Optional` **resourceVersion**: `string`
+Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L17)
 
 #### Inherited from
 
-[OpenmrsResource](OpenmrsResource.md).[resourceVersion](OpenmrsResource.md#resourceversion)
-
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L17)
-
-___
-
-### retired
+[`OpenmrsResource`](OpenmrsResource.md).[`resourceVersion`](OpenmrsResource.md#resourceversion)
 
-• `Optional` **retired**: `boolean`
+***
 
-#### Defined in
+### retired?
 
-[packages/framework/esm-api/src/types/concept-resource.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L10)
+> `optional` **retired**: `boolean`
 
-___
+Defined in: [packages/framework/esm-api/src/types/concept-resource.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L10)
 
-### set
+***
 
-• `Optional` **set**: `boolean`
+### set?
 
-#### Defined in
+> `optional` **set**: `boolean`
 
-[packages/framework/esm-api/src/types/concept-resource.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L8)
+Defined in: [packages/framework/esm-api/src/types/concept-resource.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L8)
 
-___
+***
 
-### setMembers
+### setMembers?
 
-• `Optional` **setMembers**: `any`
+> `optional` **setMembers**: `any`
 
-#### Defined in
+Defined in: [packages/framework/esm-api/src/types/concept-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L16)
 
-[packages/framework/esm-api/src/types/concept-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L16)
-
-___
+***
 
 ### uuid
 
-• **uuid**: `string`
-
-#### Inherited from
+> **uuid**: `string`
 
-[OpenmrsResource](OpenmrsResource.md).[uuid](OpenmrsResource.md#uuid)
+Defined in: [packages/framework/esm-api/src/types/openmrs-resource.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L13)
 
-#### Defined in
-
-[packages/framework/esm-api/src/types/openmrs-resource.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/openmrs-resource.ts#L13)
+#### Inherited from
 
-___
+[`OpenmrsResource`](OpenmrsResource.md).[`uuid`](OpenmrsResource.md#uuid)
 
-### version
+***
 
-• `Optional` **version**: `string`
+### version?
 
-#### Defined in
+> `optional` **version**: `string`
 
-[packages/framework/esm-api/src/types/concept-resource.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L9)
+Defined in: [packages/framework/esm-api/src/types/concept-resource.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/concept-resource.ts#L9)