@openmrs/esm-framework 3.2.1-pre.1020 → 3.2.1-pre.1030

package/docs/API.md

@@ -160,7 +160,7 @@
 - [usePatient](API.md#usepatient)
 - [useSessionUser](API.md#usesessionuser)
 - [useStore](API.md#usestore)
-- [useStoreState](API.md#usestorestate)
+- [useStoreWithActions](API.md#usestorewithactions)
 - [useVisit](API.md#usevisit)
 - [useVisitTypes](API.md#usevisittypes)
 - [validator](API.md#validator)
@@ -1801,7 +1801,7 @@ writing a module for a specific implementation.
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:126](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L126)
+[packages/framework/esm-extensions/src/extensions.ts:151](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L151)
 
 ___
 
@@ -1955,6 +1955,8 @@ ___
 
 ▸ **createUseStore**<`T`\>(`store`): () => `T`(`actions`: [`Actions`](API.md#actions)) => `T` & [`BoundActions`](API.md#boundactions)(`actions?`: [`Actions`](API.md#actions)) => `T` & [`BoundActions`](API.md#boundactions)
 
+Avoid this; generally prefer to have clients use `useStore(yourStore)`
+
 #### Type parameters
 
 | Name |
@@ -2003,7 +2005,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/createUseStore.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/createUseStore.ts#L21)
+[packages/framework/esm-react-utils/src/createUseStore.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/createUseStore.ts#L22)
 
 ___
 
@@ -2048,7 +2050,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-config/src/module-config/module-config.ts:170](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L170)
+[packages/framework/esm-config/src/module-config/module-config.ts:178](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L178)
 
 ___
 
@@ -2093,7 +2095,7 @@ Avoid using this. Extension attachments should be considered declarative.
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:157](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L157)
+[packages/framework/esm-extensions/src/extensions.ts:182](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L182)
 
 ___
 
@@ -2115,7 +2117,7 @@ Avoid using this. Extension attachments should be considered declarative.
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:181](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L181)
+[packages/framework/esm-extensions/src/extensions.ts:206](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L206)
 
 ___
 
@@ -2247,7 +2249,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:249](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L249)
+[packages/framework/esm-extensions/src/extensions.ts:297](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L297)
 
 ___
 
@@ -2345,7 +2347,7 @@ of the execution of a function.
 
 #### Defined in
 
-[packages/framework/esm-config/src/module-config/module-config.ts:198](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L198)
+[packages/framework/esm-config/src/module-config/module-config.ts:206](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L206)
 
 ___
 
@@ -2371,7 +2373,7 @@ A list of extensions that should be rendered
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:239](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L239)
+[packages/framework/esm-extensions/src/extensions.ts:264](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L264)
 
 ___
 
@@ -2438,7 +2440,7 @@ getExtensionNameFromId("baz")
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:70](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L70)
+[packages/framework/esm-extensions/src/extensions.ts:95](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L95)
 
 ___
 
@@ -2458,7 +2460,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:83](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L83)
+[packages/framework/esm-extensions/src/extensions.ts:108](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L108)
 
 ___
 
@@ -2479,7 +2481,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L75)
+[packages/framework/esm-extensions/src/extensions.ts:100](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L100)
 
 ___
 
@@ -2964,7 +2966,7 @@ Validate and interpolate defaults for `providedConfig` according to `schema`
 
 #### Defined in
 
-[packages/framework/esm-config/src/module-config/module-config.ts:220](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L220)
+[packages/framework/esm-config/src/module-config/module-config.ts:228](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L228)
 
 ___
 
@@ -2985,7 +2987,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-config/src/module-config/module-config.ts:178](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L178)
+[packages/framework/esm-config/src/module-config/module-config.ts:186](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/module-config.ts#L186)
 
 ___
 
@@ -4190,13 +4192,14 @@ ___
 
 ### useStore
 
-▸ **useStore**<`T`\>(`store`): `T`
+▸ **useStore**<`T`, `U`\>(`store`): `T`
 
 #### Type parameters
 
 | Name |
 | :------ |
 | `T` |
+| `U` |
 
 #### Parameters
 
@@ -4210,21 +4213,47 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/useStore.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStore.ts#L4)
+[packages/framework/esm-react-utils/src/useStore.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStore.ts#L22)
 
-▸ **useStore**<`T`\>(`store`, `actions`): `T` & [`BoundActions`](API.md#boundactions)
+▸ **useStore**<`T`, `U`\>(`store`, `select`): `U`
 
 #### Type parameters
 
 | Name |
 | :------ |
 | `T` |
+| `U` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `store` | `Store`<`T`\> |
+| `select` | (`state`: `T`) => `U` |
+
+#### Returns
+
+`U`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/useStore.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStore.ts#L23)
+
+▸ **useStore**<`T`, `U`\>(`store`, `select`, `actions`): `T` & [`BoundActions`](API.md#boundactions)
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+| `U` |
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `store` | `Store`<`T`\> |
+| `select` | `undefined` |
 | `actions` | [`Actions`](API.md#actions) |
 
 #### Returns
@@ -4233,35 +4262,59 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/useStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStore.ts#L5)
+[packages/framework/esm-react-utils/src/useStore.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStore.ts#L24)
+
+▸ **useStore**<`T`, `U`\>(`store`, `select`, `actions`): `U` & [`BoundActions`](API.md#boundactions)
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `T` |
+| `U` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `store` | `Store`<`T`\> |
+| `select` | (`state`: `T`) => `U` |
+| `actions` | [`Actions`](API.md#actions) |
+
+#### Returns
+
+`U` & [`BoundActions`](API.md#boundactions)
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/useStore.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStore.ts#L29)
 
 ___
 
-### useStoreState
+### useStoreWithActions
 
-▸ **useStoreState**<`T`, `U`\>(`store`, `select`): `U`
+▸ **useStoreWithActions**<`T`\>(`store`, `actions`): `T` & [`BoundActions`](API.md#boundactions)
 
 #### Type parameters
 
 | Name |
 | :------ |
 | `T` |
-| `U` |
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `store` | `Store`<`T`\> |
-| `select` | (`state`: `T`) => `U` |
+| `actions` | [`Actions`](API.md#actions) |
 
 #### Returns
 
-`U`
+`T` & [`BoundActions`](API.md#boundactions)
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/useStoreState.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStoreState.ts#L5)
+[packages/framework/esm-react-utils/src/useStore.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useStore.ts#L51)
 
 ___
 

package/docs/interfaces/ExtensionSlotState.md

@@ -23,7 +23,7 @@ ___
 
 ### moduleName
 
-• **moduleName**: `string`
+• `Optional` **moduleName**: `string`
 
 #### Defined in
 

package/mock.tsx

@@ -258,7 +258,17 @@ export const useExtensionInternalStore = createUseStore(
 
 export const useExtensionStore = createUseStore(getExtensionStore());
 
-export const useStore = (store: Store<any>, actions) => {
+const defaultSelect = (x) => x;
+export const useStore = (
+  store: Store<any>,
+  select = defaultSelect,
+  actions = {}
+) => {
+  const state = select(store.getState());
+  return { ...state, ...actions };
+};
+
+export const useStoreWithActions = (store: Store<any>, actions) => {
   const state = store.getState();
   return { ...state, ...actions };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "3.2.1-pre.1020",
+  "version": "3.2.1-pre.1030",
   "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.1-pre.1020",
-    "@openmrs/esm-breadcrumbs": "^3.2.1-pre.1020",
-    "@openmrs/esm-config": "^3.2.1-pre.1020",
-    "@openmrs/esm-error-handling": "^3.2.1-pre.1020",
-    "@openmrs/esm-extensions": "^3.2.1-pre.1020",
-    "@openmrs/esm-globals": "^3.2.1-pre.1020",
-    "@openmrs/esm-offline": "^3.2.1-pre.1020",
-    "@openmrs/esm-react-utils": "^3.2.1-pre.1020",
-    "@openmrs/esm-state": "^3.2.1-pre.1020",
-    "@openmrs/esm-styleguide": "^3.2.1-pre.1020",
-    "@openmrs/esm-utils": "^3.2.1-pre.1020",
+    "@openmrs/esm-api": "^3.2.1-pre.1030",
+    "@openmrs/esm-breadcrumbs": "^3.2.1-pre.1030",
+    "@openmrs/esm-config": "^3.2.1-pre.1030",
+    "@openmrs/esm-error-handling": "^3.2.1-pre.1030",
+    "@openmrs/esm-extensions": "^3.2.1-pre.1030",
+    "@openmrs/esm-globals": "^3.2.1-pre.1030",
+    "@openmrs/esm-offline": "^3.2.1-pre.1030",
+    "@openmrs/esm-react-utils": "^3.2.1-pre.1030",
+    "@openmrs/esm-state": "^3.2.1-pre.1030",
+    "@openmrs/esm-styleguide": "^3.2.1-pre.1030",
+    "@openmrs/esm-utils": "^3.2.1-pre.1030",
     "dayjs": "^1.10.7"
   },
-  "gitHead": "05aa900c651fe7d95b15fcdc746f7a850c60e5ac"
+  "gitHead": "6cbe35121b26c2fa29beca46bf9e4de9012dd0fb"
 }

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

@@ -3,6 +3,7 @@ import {
   attach,
   registerExtension,
   updateInternalExtensionStore,
+  getExtensionStore,
 } from "../../../esm-extensions";
 import {
   ExtensionSlot,
@@ -10,11 +11,22 @@ import {
   openmrsComponentDecorator,
   useConfig,
 } from "../../../esm-react-utils/src";
-import { defineConfigSchema, provide, Type } from "../../../esm-config/src";
-import { render, screen, waitFor } from "@testing-library/react";
+import {
+  defineConfigSchema,
+  provide,
+  Type,
+  temporaryConfigStore,
+  configInternalStore,
+  getExtensionSlotsConfigStore,
+} from "../../../esm-config/src";
+import { act, render, screen, waitFor } from "@testing-library/react";
+import { waitForElementToBeRemoved } from "@testing-library/dom";
 
 describe("Interaction between configuration and extension systems", () => {
   beforeEach(() => {
+    temporaryConfigStore.setState({ config: {} });
+    configInternalStore.setState({ providedConfigs: [], schemas: {} });
+    getExtensionSlotsConfigStore().setState({ slots: {} });
     updateInternalExtensionStore(() => ({ slots: {}, extensions: {} }));
   });
 
@@ -138,6 +150,66 @@ describe("Interaction between configuration and extension systems", () => {
     expect(slot.firstChild).toHaveTextContent(/Dino/);
     expect(slot.lastChild).toHaveTextContent(/Baby Puss/);
   });
+
+  test("Slot config should update with temporary config", async () => {
+    registerSimpleExtension("Pearl", "esm-slaghoople");
+    attach("A slot", "Pearl");
+    defineConfigSchema("esm-slaghoople", {});
+    const App = openmrsComponentDecorator({
+      moduleName: "esm-slaghoople",
+      featureName: "The Slaghooples",
+      disableTranslations: true,
+    })(() => <ExtensionSlot data-testid="slot" extensionSlotName="A slot" />);
+    render(<App />);
+    await waitFor(() => expect(screen.getByText("Pearl")).toBeInTheDocument());
+    act(() => {
+      temporaryConfigStore.setState({
+        config: {
+          "esm-slaghoople": {
+            extensionSlots: {
+              "A slot": {
+                remove: ["Pearl"],
+              },
+            },
+          },
+        },
+      });
+    });
+    expect(screen.queryByText("Pearl")).not.toBeInTheDocument();
+  });
+
+  test("Extension config should update with temporary config", async () => {
+    registerSimpleExtension("Mr. Slate", "esm-flintstone", true);
+    attach("A slot", "Mr. Slate");
+    defineConfigSchema("esm-flintstone", { tie: { _default: "green" } });
+    const App = openmrsComponentDecorator({
+      moduleName: "esm-quarry",
+      featureName: "The Flintstones",
+      disableTranslations: true,
+    })(() => <ExtensionSlot data-testid="slot" extensionSlotName="A slot" />);
+    render(<App />);
+    await waitFor(() =>
+      expect(screen.getByText(/Mr. Slate/)).toBeInTheDocument()
+    );
+    expect(screen.getByTestId("slot")).toHaveTextContent(/green/);
+    act(() => {
+      temporaryConfigStore.setState({
+        config: {
+          "esm-quarry": {
+            extensionSlots: {
+              "A slot": {
+                configure: {
+                  "Mr. Slate": { tie: "black" },
+                },
+              },
+            },
+          },
+        },
+      });
+    });
+    expect(screen.queryByText("green")).not.toBeInTheDocument();
+    expect(screen.getByTestId("slot")).toHaveTextContent(/black/);
+  });
 });
 
 function registerSimpleExtension(