@openmrs/esm-framework 3.1.15-pre.749 → 3.1.15-pre.757

package/docs/interfaces/AssignedExtension.md

@@ -0,0 +1,63 @@
+[@openmrs/esm-framework](../API.md) / AssignedExtension
+
+# Interface: AssignedExtension
+
+## Table of contents
+
+### Properties
+
+- [id](AssignedExtension.md#id)
+- [meta](AssignedExtension.md#meta)
+- [name](AssignedExtension.md#name)
+- [offline](AssignedExtension.md#offline)
+- [online](AssignedExtension.md#online)
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L71)
+
+___
+
+### meta
+
+• **meta**: [`ExtensionMeta`](ExtensionMeta.md)
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L73)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L72)
+
+___
+
+### offline
+
+• `Optional` **offline**: `boolean` \| `object`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L75)
+
+___
+
+### online
+
+• `Optional` **online**: `boolean` \| `object`
+
+#### 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)

package/docs/interfaces/ConnectedExtension.md

@@ -2,34 +2,13 @@
 
 # Interface: ConnectedExtension
 
-We have the following extension modes:
-
-- attached (set via code in form of: attach, detach, ...)
-- configured (set via configuration in form of: added, removed, ...)
-- assigned (computed from attached and configured)
-- connected (computed from assigned using connectivity and online / offline)
-
-## Hierarchy
-
-- [`ExtensionRegistration`](ExtensionRegistration.md)
-
-  ↳ **`ConnectedExtension`**
-
 ## Table of contents
 
 ### Properties
 
 - [id](ConnectedExtension.md#id)
 - [meta](ConnectedExtension.md#meta)
-- [moduleName](ConnectedExtension.md#modulename)
 - [name](ConnectedExtension.md#name)
-- [offline](ConnectedExtension.md#offline)
-- [online](ConnectedExtension.md#online)
-- [order](ConnectedExtension.md#order)
-
-### Methods
-
-- [load](ConnectedExtension.md#load)
 
 ## Properties
 
@@ -39,7 +18,7 @@ We have the following extension modes:
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/useConnectedExtensions.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useConnectedExtensions.ts#L28)
+[packages/framework/esm-extensions/src/store.ts:79](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L79)
 
 ___
 
@@ -47,27 +26,9 @@ ___
 
 • **meta**: [`ExtensionMeta`](ExtensionMeta.md)
 
-#### Inherited from
-
-[ExtensionRegistration](ExtensionRegistration.md).[meta](ExtensionRegistration.md#meta)
-
 #### 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)
-
-___
-
-### moduleName
-
-• **moduleName**: `string`
-
-#### Inherited from
-
-[ExtensionRegistration](ExtensionRegistration.md).[moduleName](ExtensionRegistration.md#modulename)
-
-#### 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)
+[packages/framework/esm-extensions/src/store.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L81)
 
 ___
 
@@ -75,70 +36,6 @@ ___
 
 • **name**: `string`
 
-#### Inherited from
-
-[ExtensionRegistration](ExtensionRegistration.md).[name](ExtensionRegistration.md#name)
-
-#### 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)
-
-___
-
-### offline
-
-• `Optional` **offline**: `boolean` \| `object`
-
-#### Inherited from
-
-[ExtensionRegistration](ExtensionRegistration.md).[offline](ExtensionRegistration.md#offline)
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L19)
-
-___
-
-### online
-
-• `Optional` **online**: `boolean` \| `object`
-
-#### Inherited from
-
-[ExtensionRegistration](ExtensionRegistration.md).[online](ExtensionRegistration.md#online)
-
-#### 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)
-
-___
-
-### order
-
-• `Optional` **order**: `number`
-
-#### Inherited from
-
-[ExtensionRegistration](ExtensionRegistration.md).[order](ExtensionRegistration.md#order)
-
-#### 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)
-
-## 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:14](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L14)
+[packages/framework/esm-extensions/src/store.ts:80](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L80)

package/docs/interfaces/ExtensionInfo.md

@@ -35,7 +35,7 @@ indexed by slotModuleName and slotName.
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L27)
+[packages/framework/esm-extensions/src/store.ts:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L28)
 
 ___
 
@@ -49,7 +49,7 @@ ___
 
 #### 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)
+[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)
 
 ___
 
@@ -63,7 +63,7 @@ ___
 
 #### 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)
+[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)
 
 ___
 
@@ -77,7 +77,7 @@ ___
 
 #### 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)
+[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)
 
 ___
 
@@ -91,7 +91,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L19)
+[packages/framework/esm-extensions/src/store.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L20)
 
 ___
 
@@ -105,7 +105,7 @@ ___
 
 #### 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)
+[packages/framework/esm-extensions/src/store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L19)
 
 ___
 
@@ -119,7 +119,7 @@ ___
 
 #### 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)
+[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)
 
 ## Methods
 
@@ -137,4 +137,4 @@ ___
 
 #### 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)
+[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)

package/docs/interfaces/ExtensionInstance.md

@@ -16,4 +16,4 @@
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L31)
+[packages/framework/esm-extensions/src/store.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L32)

package/docs/interfaces/ExtensionInternalStore.md

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

package/docs/interfaces/ExtensionProps.md

@@ -20,7 +20,7 @@
 
 #### 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)
+[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)
 
 ## Methods
 
@@ -41,4 +41,4 @@
 
 #### 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)
+[packages/framework/esm-react-utils/src/Extension.tsx:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/Extension.tsx#L8)

package/docs/interfaces/ExtensionRegistration.md

@@ -8,8 +8,6 @@
 
   ↳ [`ExtensionInfo`](ExtensionInfo.md)
 
-  ↳ [`ConnectedExtension`](ConnectedExtension.md)
-
 ## Table of contents
 
 ### Properties
@@ -33,7 +31,7 @@
 
 #### 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)
+[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)
 
 ___
 
@@ -43,7 +41,7 @@ ___
 
 #### 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)
+[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)
 
 ___
 
@@ -53,7 +51,7 @@ ___
 
 #### 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)
+[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)
 
 ___
 
@@ -63,7 +61,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L19)
+[packages/framework/esm-extensions/src/store.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L20)
 
 ___
 
@@ -73,7 +71,7 @@ ___
 
 #### 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)
+[packages/framework/esm-extensions/src/store.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L19)
 
 ___
 
@@ -83,7 +81,7 @@ ___
 
 #### 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)
+[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)
 
 ## Methods
 
@@ -97,4 +95,4 @@ ___
 
 #### 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)
+[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)

package/docs/interfaces/ExtensionSlotConfigObject.md

@@ -16,9 +16,11 @@
 
 • `Optional` **add**: `string`[]
 
+Additional extension IDs to assign to this slot, in addition to those `attach`ed in code.
+
 #### 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)
+[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)
 
 ___
 
@@ -26,9 +28,11 @@ ___
 
 • `Optional` **order**: `string`[]
 
+Overrides the default ordering of extensions.
+
 #### 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)
+[packages/framework/esm-config/src/types.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L55)
 
 ___
 
@@ -36,6 +40,8 @@ ___
 
 • `Optional` **remove**: `string`[]
 
+Extension IDs which were `attach`ed to the slot but which should not be assigned.
+
 #### 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)
+[packages/framework/esm-config/src/types.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/types.ts#L53)

package/docs/interfaces/ExtensionSlotInfo.md

@@ -7,7 +7,8 @@
 ### Properties
 
 - [attachedIds](ExtensionSlotInfo.md#attachedids)
-- [instances](ExtensionSlotInfo.md#instances)
+- [config](ExtensionSlotInfo.md#config)
+- [moduleName](ExtensionSlotInfo.md#modulename)
 - [name](ExtensionSlotInfo.md#name)
 
 ## Properties
@@ -16,26 +17,39 @@
 
 • **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.
+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:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L75)
+[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)
 
 ___
 
-### instances
+### config
 
-• **instances**: `Record`<`string`, [`ExtensionSlotInstance`](ExtensionSlotInstance.md)\>
+• **config**: ``null`` \| [`ExtensionSlotConfigObject`](ExtensionSlotConfigObject.md)
 
-The mapping of modules / extension slot instances where the extension slot has been used.
+The configuration provided for this extension slot. `null` if not yet loaded.
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:68](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L68)
+[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)
 
 ___
 
@@ -47,4 +61,4 @@ The name under which the extension slot has been registered.
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:64](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L64)
+[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/ExtensionSlotState.md

@@ -0,0 +1,30 @@
+[@openmrs/esm-framework](../API.md) / ExtensionSlotState
+
+# Interface: ExtensionSlotState
+
+## Table of contents
+
+### Properties
+
+- [assignedExtensions](ExtensionSlotState.md#assignedextensions)
+- [moduleName](ExtensionSlotState.md#modulename)
+
+## Properties
+
+### assignedExtensions
+
+• **assignedExtensions**: [`AssignedExtension`](AssignedExtension.md)[]
+
+#### 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)
+
+___
+
+### moduleName
+
+• **moduleName**: `string`
+
+#### Defined in
+
+[packages/framework/esm-extensions/src/store.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L66)

package/docs/interfaces/ExtensionStore.md

@@ -6,29 +6,14 @@
 
 ### 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:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L38)
-
-___
-
 ### slots
 
-• **slots**: `Record`<`string`, [`ExtensionSlotInfo`](ExtensionSlotInfo.md)\>
-
-Slots indexed by name
+• **slots**: `Record`<`string`, [`ExtensionSlotState`](ExtensionSlotState.md)\>
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L36)
+[packages/framework/esm-extensions/src/store.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L62)

package/jest.config.js

@@ -1,9 +1,10 @@
 module.exports = {
   transform: {
-    "^.+\\.tsx?$": "babel-jest",
+    "^.+\\.(j|t)sx?$": "babel-jest",
   },
   moduleNameMapper: {
     "\\.(s?css)$": "identity-obj-proxy",
+    "\\.(svg)$": "<rootDir>/__mocks__/fileMock.js",
     "lodash-es/(.*)": "lodash/$1",
   },
   setupFilesAfterEnv: ["<rootDir>/src/integration-tests/setup-tests.ts"],