@openmrs/esm-framework 3.2.0 → 3.2.1-pre.1010

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "3.2.0",
+  "version": "3.2.1-pre.1010",
   "license": "MPL-2.0",
   "browser": "dist/openmrs-esm-framework.js",
   "main": "src/index.ts",
@@ -35,18 +35,18 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "^3.2.0",
-    "@openmrs/esm-breadcrumbs": "^3.2.0",
-    "@openmrs/esm-config": "^3.2.0",
-    "@openmrs/esm-error-handling": "^3.2.0",
-    "@openmrs/esm-extensions": "^3.2.0",
-    "@openmrs/esm-globals": "^3.2.0",
-    "@openmrs/esm-offline": "^3.2.0",
-    "@openmrs/esm-react-utils": "^3.2.0",
-    "@openmrs/esm-state": "^3.2.0",
-    "@openmrs/esm-styleguide": "^3.2.0",
-    "@openmrs/esm-utils": "^3.2.0",
+    "@openmrs/esm-api": "^3.2.1-pre.1010",
+    "@openmrs/esm-breadcrumbs": "^3.2.1-pre.1010",
+    "@openmrs/esm-config": "^3.2.1-pre.1010",
+    "@openmrs/esm-error-handling": "^3.2.1-pre.1010",
+    "@openmrs/esm-extensions": "^3.2.1-pre.1010",
+    "@openmrs/esm-globals": "^3.2.1-pre.1010",
+    "@openmrs/esm-offline": "^3.2.1-pre.1010",
+    "@openmrs/esm-react-utils": "^3.2.1-pre.1010",
+    "@openmrs/esm-state": "^3.2.1-pre.1010",
+    "@openmrs/esm-styleguide": "^3.2.1-pre.1010",
+    "@openmrs/esm-utils": "^3.2.1-pre.1010",
     "dayjs": "^1.10.7"
   },
-  "gitHead": "9c4a04089e29ff99321d6fef72294f402deb0f7b"
+  "gitHead": "2d2457c75087b97cd8959d6a4dc854e3f6b8f6f5"
 }

package/src/integration-tests/extension-config.test.tsx

@@ -2,12 +2,9 @@ import React from "react";
 import {
   attach,
   registerExtension,
-  registerExtensionSlot,
-  updateExtensionStore,
-  ExtensionStore,
+  updateInternalExtensionStore,
 } from "../../../esm-extensions";
 import {
-  Extension,
   ExtensionSlot,
   getSyncLifecycle,
   openmrsComponentDecorator,
@@ -18,7 +15,7 @@ import { render, screen, waitFor } from "@testing-library/react";
 
 describe("Interaction between configuration and extension systems", () => {
   beforeEach(() => {
-    updateExtensionStore(() => ({ slots: {}, extensions: {} }));
+    updateInternalExtensionStore(() => ({ slots: {}, extensions: {} }));
   });
 
   test("Config should add, order, and remove extensions within slots", async () => {
@@ -26,7 +23,6 @@ describe("Interaction between configuration and extension systems", () => {
     registerSimpleExtension("Wilma", "esm-flintstone");
     registerSimpleExtension("Barney", "esm-rubble");
     registerSimpleExtension("Betty", "esm-rubble");
-    registerExtensionSlot("esm-flintstone", "A slot");
     attach("A slot", "Fred");
     attach("A slot", "Wilma");
     defineConfigSchema("esm-flintstone", {});
@@ -58,8 +54,6 @@ describe("Interaction between configuration and extension systems", () => {
 
   test("Extensions should recieve config from module and from 'configure' key", async () => {
     registerSimpleExtension("Wilma", "esm-flintstone", true);
-    registerExtensionSlot("esm-flintstone", "Flintstone slot");
-    registerExtensionSlot("esm-flintstone", "Future slot");
     defineConfigSchema("esm-flintstone", {
       town: { _type: Type.String, _default: "Bedrock" },
     });
@@ -105,7 +99,6 @@ describe("Interaction between configuration and extension systems", () => {
 
   test("Should be possible to attach the same extension twice with different configurations", async () => {
     registerSimpleExtension("pet", "esm-characters", true);
-    registerExtensionSlot("esm-flintstone", "Flintstone slot");
     defineConfigSchema("esm-characters", {
       name: { _type: Type.String, _default: "(no-name)" },
     });
@@ -161,7 +154,8 @@ function registerSimpleExtension(
       </div>
     );
   };
-  registerExtension(name, {
+  registerExtension({
+    name,
     moduleName,
     load: getSyncLifecycle(
       takesConfig ? ConfigurableComponent : SimpleComponent,

package/docs/interfaces/ConfigStore.md

@@ -1,34 +0,0 @@
-[@openmrs/esm-framework](../API.md) / ConfigStore
-
-# Interface: ConfigStore
-
-Output configs
-
-Each module has its own stores for its config and its extension slots' configs.
-
-## Table of contents
-
-### Properties
-
-- [config](ConfigStore.md#config)
-- [loaded](ConfigStore.md#loaded)
-
-## Properties
-
-### config
-
-• **config**: ``null`` \| [`ConfigObject`](ConfigObject.md)
-
-#### Defined in
-
-[packages/framework/esm-config/src/module-config/state.ts:125](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L125)
-
-___
-
-### loaded
-
-• **loaded**: `boolean`
-
-#### Defined in
-
-[packages/framework/esm-config/src/module-config/state.ts:126](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L126)

package/docs/interfaces/ExtensionDetails.md

@@ -1,81 +0,0 @@
-[@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:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L56)
-
-___
-
-### moduleName
-
-• **moduleName**: `string`
-
-#### 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)
-
-___
-
-### offline
-
-• `Optional` **offline**: `boolean` \| `object`
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/extensions.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L58)
-
-___
-
-### online
-
-• `Optional` **online**: `boolean` \| `object`
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/extensions.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L57)
-
-___
-
-### order
-
-• `Optional` **order**: `number`
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/extensions.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L59)
-
-## Methods
-
-### load
-
-▸ **load**(): `Promise`<`any`\>
-
-#### Returns
-
-`Promise`<`any`\>
-
-#### 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)

package/docs/interfaces/ExtensionSlotConfigsStore.md

@@ -1,32 +0,0 @@
-[@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:146](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L146)
-
-___
-
-### loaded
-
-• **loaded**: `boolean`
-
-#### Defined in
-
-[packages/framework/esm-config/src/module-config/state.ts:147](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L147)

package/docs/interfaces/ExtensionSlotInstance.md

@@ -1,51 +0,0 @@
-[@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:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L47)
-
-___
-
-### idOrder
-
-• **idOrder**: `string`[]
-
-A set allowing explicit ordering of the `assignedIds`.
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L57)
-
-___
-
-### 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:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L53)

package/docs/interfaces/ImplementerToolsConfigStore.md

@@ -1,19 +0,0 @@
-[@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:179](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L179)

package/docs/interfaces/WorkspaceItem.md

@@ -1,74 +0,0 @@
-[@openmrs/esm-framework](../API.md) / WorkspaceItem
-
-# Interface: WorkspaceItem
-
-## Table of contents
-
-### Properties
-
-- [component](WorkspaceItem.md#component)
-- [componentClosed](WorkspaceItem.md#componentclosed)
-- [inProgress](WorkspaceItem.md#inprogress)
-- [name](WorkspaceItem.md#name)
-- [props](WorkspaceItem.md#props)
-- [validations](WorkspaceItem.md#validations)
-
-## Properties
-
-### component
-
-• **component**: `any`
-
-#### Defined in
-
-[packages/framework/esm-api/src/workspace/workspace.resource.tsx:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L24)
-
-___
-
-### componentClosed
-
-• `Optional` **componentClosed**: `Function`
-
-#### Defined in
-
-[packages/framework/esm-api/src/workspace/workspace.resource.tsx:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L29)
-
-___
-
-### inProgress
-
-• **inProgress**: `boolean`
-
-#### Defined in
-
-[packages/framework/esm-api/src/workspace/workspace.resource.tsx:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L28)
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Defined in
-
-[packages/framework/esm-api/src/workspace/workspace.resource.tsx:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L25)
-
-___
-
-### props
-
-• **props**: `any`
-
-#### Defined in
-
-[packages/framework/esm-api/src/workspace/workspace.resource.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L26)
-
-___
-
-### validations
-
-• `Optional` **validations**: `Function`
-
-#### Defined in
-
-[packages/framework/esm-api/src/workspace/workspace.resource.tsx:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L27)