@openmrs/esm-framework 3.2.1-pre.986 → 3.3.1-pre.1177

package/mock.tsx

@@ -8,6 +8,7 @@ export {
   formatDate,
   formatDatetime,
   formatTime,
+  age,
 } from "@openmrs/esm-utils";
 export { interpolateString, interpolateUrl } from "@openmrs/esm-config";
 
@@ -176,6 +177,10 @@ export function defineConfigSchema(moduleName, schema) {
   configSchema = schema;
 }
 
+export function defineExtensionConfigSchema(extensionName, schema) {
+  configSchema = schema;
+}
+
 export const navigate = jest.fn();
 
 export const ConfigurableLink = jest
@@ -199,7 +204,9 @@ export const detachAll = jest.fn();
 
 export const switchTo = jest.fn();
 
-export const ExtensionSlot = ({ children }) => <>{children}</>;
+export const ExtensionSlot = jest
+  .fn()
+  .mockImplementation(({ children }) => <>{children}</>);
 
 export const Extension = jest.fn().mockImplementation((props: any) => <slot />);
 
@@ -229,7 +236,7 @@ export const usePatient = jest.fn(() => ({
   error: null,
 }));
 
-export const useSessionUser = jest.fn(() => null);
+export const useSession = jest.fn(() => null);
 
 export const useLayoutType = jest.fn(() => "desktop");
 
@@ -239,6 +246,8 @@ export const useExtensionSlot = jest.fn(() => ({
   extensionIdsToRender: [],
 }));
 
+export const useExtensionSlotMeta = jest.fn(() => ({}));
+
 export const UserHasAccess = jest.fn().mockImplementation((props: any) => {
   return props.children;
 });
@@ -254,7 +263,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 };
 };
@@ -265,9 +284,21 @@ export const usePagination = jest.fn().mockImplementation(() => ({
   results: [],
 }));
 
+export const useVisit = jest.fn().mockReturnValue({
+  error: null,
+  mutate: jest.fn(),
+  isValidating: true,
+  currentVisit: null,
+});
+
 export const useVisitTypes = jest.fn(() => []);
 
 /* esm-styleguide */
 
 export const showNotification = jest.fn();
 export const showToast = jest.fn();
+export const showModal = jest.fn();
+
+export const LeftNavMenu = jest.fn();
+export const setLeftNav = jest.fn();
+export const unsetLeftNav = jest.fn();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "3.2.1-pre.986",
+  "version": "3.3.1-pre.1177",
   "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.986",
-    "@openmrs/esm-breadcrumbs": "^3.2.1-pre.986",
-    "@openmrs/esm-config": "^3.2.1-pre.986",
-    "@openmrs/esm-error-handling": "^3.2.1-pre.986",
-    "@openmrs/esm-extensions": "^3.2.1-pre.986",
-    "@openmrs/esm-globals": "^3.2.1-pre.986",
-    "@openmrs/esm-offline": "^3.2.1-pre.986",
-    "@openmrs/esm-react-utils": "^3.2.1-pre.986",
-    "@openmrs/esm-state": "^3.2.1-pre.986",
-    "@openmrs/esm-styleguide": "^3.2.1-pre.986",
-    "@openmrs/esm-utils": "^3.2.1-pre.986",
+    "@openmrs/esm-api": "^3.3.1-pre.1177",
+    "@openmrs/esm-breadcrumbs": "^3.3.1-pre.1177",
+    "@openmrs/esm-config": "^3.3.1-pre.1177",
+    "@openmrs/esm-error-handling": "^3.3.1-pre.1177",
+    "@openmrs/esm-extensions": "^3.3.1-pre.1177",
+    "@openmrs/esm-globals": "^3.3.1-pre.1177",
+    "@openmrs/esm-offline": "^3.3.1-pre.1177",
+    "@openmrs/esm-react-utils": "^3.3.1-pre.1177",
+    "@openmrs/esm-state": "^3.3.1-pre.1177",
+    "@openmrs/esm-styleguide": "^3.3.1-pre.1177",
+    "@openmrs/esm-utils": "^3.3.1-pre.1177",
     "dayjs": "^1.10.7"
   },
-  "gitHead": "970eb8ac9493a64af6d84c3f8a9620f96f01a1a3"
+  "gitHead": "d3541372844e7f46f8c1887ae4df492a1894aa87"
 }

package/src/index.ts

@@ -1,11 +1,11 @@
-export * from "@openmrs/esm-api";
+export * from "@openmrs/esm-api/src/public";
 export * from "@openmrs/esm-breadcrumbs";
-export * from "@openmrs/esm-config";
+export * from "@openmrs/esm-config/src/public";
 export * from "@openmrs/esm-error-handling";
-export * from "@openmrs/esm-extensions";
-export * from "@openmrs/esm-globals";
-export * from "@openmrs/esm-react-utils";
-export * from "@openmrs/esm-state";
-export * from "@openmrs/esm-styleguide";
+export * from "@openmrs/esm-extensions/src/public";
+export * from "@openmrs/esm-globals/src/public";
+export * from "@openmrs/esm-offline/src/public";
+export * from "@openmrs/esm-react-utils/src/public";
+export * from "@openmrs/esm-state/src/public";
+export * from "@openmrs/esm-styleguide/src/public";
 export * from "@openmrs/esm-utils";
-export * from "@openmrs/esm-offline";

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

@@ -3,18 +3,32 @@ import {
   attach,
   registerExtension,
   updateInternalExtensionStore,
+  getExtensionInternalStore,
+  getExtensionStore,
 } from "../../../esm-extensions";
 import {
   ExtensionSlot,
   getSyncLifecycle,
   openmrsComponentDecorator,
   useConfig,
+  useExtensionStore,
 } 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: {} }));
   });
 
@@ -28,7 +42,7 @@ describe("Interaction between configuration and extension systems", () => {
     defineConfigSchema("esm-flintstone", {});
     provide({
       "esm-flintstone": {
-        extensions: {
+        extensionSlots: {
           "A slot": {
             add: ["Barney", "Betty"],
             order: ["Betty", "Wilma"],
@@ -53,19 +67,19 @@ describe("Interaction between configuration and extension systems", () => {
   });
 
   test("Extensions should recieve config from module and from 'configure' key", async () => {
-    registerSimpleExtension("Wilma", "esm-flintstone", true);
+    registerSimpleExtension("Pebbles", "esm-flintstone", true);
     defineConfigSchema("esm-flintstone", {
       town: { _type: Type.String, _default: "Bedrock" },
     });
-    attach("Flintstone slot", "Wilma");
-    attach("Future slot", "Wilma");
+    attach("Flintstone slot", "Pebbles");
+    attach("Future slot", "Pebbles");
     provide({
       "esm-flintstone": {
         town: "Springfield",
-        extensions: {
+        extensionSlots: {
           "Future slot": {
             configure: {
-              Wilma: {
+              Pebbles: {
                 town: "New New York",
               },
             },
@@ -90,11 +104,11 @@ describe("Interaction between configuration and extension systems", () => {
       </>
     ));
     render(<App />);
-    await screen.findAllByText(/.*Wilma.*/);
-    const flintstoneWilma = screen.getByTestId("flintstone-slot");
-    expect(flintstoneWilma).toHaveTextContent(/Wilma:.*Springfield/);
-    const futureWilma = screen.getByTestId("future-slot");
-    expect(futureWilma).toHaveTextContent(/Wilma:.*New New York/);
+    await screen.findAllByText(/.*Pebbles.*/);
+    const flintstonePebbles = screen.getByTestId("flintstone-slot");
+    expect(flintstonePebbles).toHaveTextContent(/Pebbles:.*Springfield/);
+    const futurePebbles = screen.getByTestId("future-slot");
+    expect(futurePebbles).toHaveTextContent(/Pebbles:.*New New York/);
   });
 
   test("Should be possible to attach the same extension twice with different configurations", async () => {
@@ -106,7 +120,7 @@ describe("Interaction between configuration and extension systems", () => {
     attach("Flintstone slot", "pet#BabyPuss");
     provide({
       "esm-flintstone": {
-        extensions: {
+        extensionSlots: {
           "Flintstone slot": {
             configure: {
               "pet#Dino": {
@@ -138,6 +152,107 @@ 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/);
+  });
+
+  test("Extension config should be available in extension store", async () => {
+    registerSimpleExtension("Bamm-Bamm", "esm-flintstone", false);
+    attach("A slot", "Bamm-Bamm");
+    defineConfigSchema("esm-flintstone", { clothes: { _default: "leopard" } });
+    function RootComponent() {
+      const store = useExtensionStore();
+      return (
+        <div>
+          <ExtensionSlot data-testid="slot" extensionSlotName="A slot" />
+          {store.slots["A slot"].assignedExtensions.map((e) => (
+            <div key={e.name}>{JSON.stringify(e.config)}</div>
+          ))}
+        </div>
+      );
+    }
+    const App = openmrsComponentDecorator({
+      moduleName: "esm-flintstone",
+      featureName: "The Flintstones",
+      disableTranslations: true,
+    })(RootComponent);
+    render(<App />);
+    await waitFor(() => expect(screen.getByTestId(/slot/)).toBeInTheDocument());
+    expect(screen.getByText(/clothes/)).toHaveTextContent(/leopard/);
+    act(() => {
+      temporaryConfigStore.setState({
+        config: {
+          "esm-flintstone": {
+            extensionSlots: {
+              "A slot": {
+                configure: {
+                  "Bamm-Bamm": { clothes: "tiger" },
+                },
+              },
+            },
+          },
+        },
+      });
+    });
+    expect(screen.getByText(/clothes/)).toHaveTextContent(/tiger/);
+  });
 });
 
 function registerSimpleExtension(

package/src/internal.ts

@@ -0,0 +1,11 @@
+export * from "@openmrs/esm-api";
+export * from "@openmrs/esm-breadcrumbs";
+export * from "@openmrs/esm-config";
+export * from "@openmrs/esm-error-handling";
+export * from "@openmrs/esm-extensions";
+export * from "@openmrs/esm-globals";
+export * from "@openmrs/esm-offline";
+export * from "@openmrs/esm-react-utils";
+export * from "@openmrs/esm-state";
+export * from "@openmrs/esm-styleguide";
+export * from "@openmrs/esm-utils";

package/webpack.config.js

@@ -17,12 +17,20 @@ module.exports = (env) => ({
       {
         test: /\.m?(js|ts|tsx)$/,
         exclude: /(node_modules|bower_components)/,
-        use: "babel-loader",
+        use: "swc-loader",
+      },
+      {
+        test: /\.s?css$/,
+        use: [
+          { loader: require.resolve("style-loader") },
+          { loader: require.resolve("css-loader") },
+          { loader: require.resolve("sass-loader") },
+        ],
       },
     ],
   },
   resolve: {
-    extensions: [".ts", ".js", ".tsx", ".jsx"],
+    extensions: [".ts", ".js", ".tsx", ".jsx", ".scss"],
   },
   plugins: [
     new SystemJSPublicPathWebpackPlugin(),

package/babel.config.js

@@ -1,7 +0,0 @@
-module.exports = {
-  presets: [
-    "@babel/preset-env",
-    "@babel/preset-typescript",
-    "@babel/preset-react",
-  ],
-};

package/docs/interfaces/ComponentConfig.md

@@ -1,30 +0,0 @@
-[@openmrs/esm-framework](../API.md) / ComponentConfig
-
-# Interface: ComponentConfig
-
-## Table of contents
-
-### Properties
-
-- [extension](ComponentConfig.md#extension)
-- [moduleName](ComponentConfig.md#modulename)
-
-## Properties
-
-### extension
-
-• `Optional` **extension**: [`ExtensionData`](ExtensionData.md)
-
-#### Defined in
-
-[packages/framework/esm-react-utils/src/ComponentContext.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L11)
-
-___
-
-### moduleName
-
-• **moduleName**: `string`
-
-#### Defined in
-
-[packages/framework/esm-react-utils/src/ComponentContext.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/ComponentContext.ts#L10)

package/docs/interfaces/ComponentDecoratorOptions.md

@@ -1,52 +0,0 @@
-[@openmrs/esm-framework](../API.md) / ComponentDecoratorOptions
-
-# Interface: ComponentDecoratorOptions
-
-## Table of contents
-
-### Properties
-
-- [disableTranslations](ComponentDecoratorOptions.md#disabletranslations)
-- [featureName](ComponentDecoratorOptions.md#featurename)
-- [moduleName](ComponentDecoratorOptions.md#modulename)
-- [strictMode](ComponentDecoratorOptions.md#strictmode)
-
-## Properties
-
-### disableTranslations
-
-• `Optional` **disableTranslations**: `boolean`
-
-#### Defined in
-
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L57)
-
-___
-
-### featureName
-
-• **featureName**: `string`
-
-#### Defined in
-
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L56)
-
-___
-
-### moduleName
-
-• **moduleName**: `string`
-
-#### Defined in
-
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L55)
-
-___
-
-### strictMode
-
-• `Optional` **strictMode**: `boolean`
-
-#### Defined in
-
-[packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/openmrsComponentDecorator.tsx#L58)

package/docs/interfaces/ExtensionInfo.md

@@ -1,140 +0,0 @@
-[@openmrs/esm-framework](../API.md) / ExtensionInfo
-
-# Interface: ExtensionInfo
-
-## Hierarchy
-
-- [`ExtensionRegistration`](ExtensionRegistration.md)
-
-  ↳ **`ExtensionInfo`**
-
-## Table of contents
-
-### Properties
-
-- [instances](ExtensionInfo.md#instances)
-- [meta](ExtensionInfo.md#meta)
-- [moduleName](ExtensionInfo.md#modulename)
-- [name](ExtensionInfo.md#name)
-- [offline](ExtensionInfo.md#offline)
-- [online](ExtensionInfo.md#online)
-- [order](ExtensionInfo.md#order)
-
-### Methods
-
-- [load](ExtensionInfo.md#load)
-
-## Properties
-
-### instances
-
-• **instances**: `Record`<`string`, `Record`<`string`, [`ExtensionInstance`](ExtensionInstance.md)\>\>
-
-The instances where the extension has been rendered using `renderExtension`,
-indexed by slotModuleName and slotName.
-
-#### Defined in
-
-[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)
-
-___
-
-### meta
-
-• **meta**: [`ExtensionMeta`](ExtensionMeta.md)
-
-#### Inherited from
-
-[ExtensionRegistration](ExtensionRegistration.md).[meta](ExtensionRegistration.md#meta)
-
-#### 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)
-
-___
-
-### moduleName
-
-• **moduleName**: `string`
-
-#### Inherited from
-
-[ExtensionRegistration](ExtensionRegistration.md).[moduleName](ExtensionRegistration.md#modulename)
-
-#### 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)
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Inherited from
-
-[ExtensionRegistration](ExtensionRegistration.md).[name](ExtensionRegistration.md#name)
-
-#### 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)
-
-___
-
-### offline
-
-• `Optional` **offline**: `boolean` \| `object`
-
-#### Inherited from
-
-[ExtensionRegistration](ExtensionRegistration.md).[offline](ExtensionRegistration.md#offline)
-
-#### Defined in
-
-[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)
-
-___
-
-### online
-
-• `Optional` **online**: `boolean` \| `object`
-
-#### Inherited from
-
-[ExtensionRegistration](ExtensionRegistration.md).[online](ExtensionRegistration.md#online)
-
-#### 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)
-
-___
-
-### order
-
-• `Optional` **order**: `number`
-
-#### Inherited from
-
-[ExtensionRegistration](ExtensionRegistration.md).[order](ExtensionRegistration.md#order)
-
-#### 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)
-
-## 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:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L15)

package/docs/interfaces/ExtensionInstance.md

@@ -1,19 +0,0 @@
-[@openmrs/esm-framework](../API.md) / ExtensionInstance
-
-# Interface: ExtensionInstance
-
-## Table of contents
-
-### Properties
-
-- [id](ExtensionInstance.md#id)
-
-## Properties
-
-### id
-
-• **id**: `string`
-
-#### Defined in
-
-[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

@@ -1,34 +0,0 @@
-[@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)