@openmrs/esm-framework 3.4.1-pre.146 → 3.4.1-pre.149

package/docs/interfaces/PageDefinition.md

@@ -82,15 +82,16 @@ The order in which to load the page. This determines DOM order.
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:145](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L145)
+[packages/framework/esm-globals/src/types.ts:146](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L146)
 
 ___
 
 ### privilege
 
-• `Optional` **privilege**: `string`
+• `Optional` **privilege**: `string` \| `string`[]
 
-Defines the access privilege required for this component, if any.
+Defines the access privilege(s) required for this component, if any.
+If more than one privilege is provided, the user must have all specified permissions.
 
 #### Inherited from
 
@@ -98,7 +99,7 @@ Defines the access privilege required for this component, if any.
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:115](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L115)
+[packages/framework/esm-globals/src/types.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L116)
 
 ___
 
@@ -114,7 +115,7 @@ Defines resources that are loaded when the component should mount.
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:119](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L119)
+[packages/framework/esm-globals/src/types.ts:120](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L120)
 
 ___
 
@@ -126,7 +127,7 @@ The route of the page.
 
 #### Defined in
 
-[packages/framework/esm-globals/src/types.ts:141](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L141)
+[packages/framework/esm-globals/src/types.ts:142](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-globals/src/types.ts#L142)
 
 ## Methods
 

package/docs/interfaces/UserHasAccessProps.md

@@ -23,7 +23,7 @@ ___
 
 ### privilege
 
-• **privilege**: `string`
+• **privilege**: `string` \| `string`[]
 
 #### Defined in
 

package/mock.tsx

@@ -3,6 +3,7 @@ import type {} from "@openmrs/esm-globals";
 import createStore, { Store } from "unistore";
 import { never, of } from "rxjs";
 import { interpolateUrl } from "@openmrs/esm-config";
+import { SessionStore } from "@openmrs/esm-api";
 export {
   parseDate,
   formatDate,
@@ -51,7 +52,7 @@ export function getCurrentUser() {
   return of({ authenticated: false });
 }
 
-export const mockSessionStore = createGlobalStore("mock-session-store", {
+export const mockSessionStore = createGlobalStore<SessionStore>("mock-session-store", {
   loaded: false,
   session: null,
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "3.4.1-pre.146",
+  "version": "3.4.1-pre.149",
   "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.4.1-pre.146",
-    "@openmrs/esm-breadcrumbs": "^3.4.1-pre.146",
-    "@openmrs/esm-config": "^3.4.1-pre.146",
-    "@openmrs/esm-error-handling": "^3.4.1-pre.146",
-    "@openmrs/esm-extensions": "^3.4.1-pre.146",
-    "@openmrs/esm-globals": "^3.4.1-pre.146",
-    "@openmrs/esm-offline": "^3.4.1-pre.146",
-    "@openmrs/esm-react-utils": "^3.4.1-pre.146",
-    "@openmrs/esm-state": "^3.4.1-pre.146",
-    "@openmrs/esm-styleguide": "^3.4.1-pre.146",
-    "@openmrs/esm-utils": "^3.4.1-pre.146",
+    "@openmrs/esm-api": "^3.4.1-pre.149",
+    "@openmrs/esm-breadcrumbs": "^3.4.1-pre.149",
+    "@openmrs/esm-config": "^3.4.1-pre.149",
+    "@openmrs/esm-error-handling": "^3.4.1-pre.149",
+    "@openmrs/esm-extensions": "^3.4.1-pre.149",
+    "@openmrs/esm-globals": "^3.4.1-pre.149",
+    "@openmrs/esm-offline": "^3.4.1-pre.149",
+    "@openmrs/esm-react-utils": "^3.4.1-pre.149",
+    "@openmrs/esm-state": "^3.4.1-pre.149",
+    "@openmrs/esm-styleguide": "^3.4.1-pre.149",
+    "@openmrs/esm-utils": "^3.4.1-pre.149",
     "dayjs": "^1.10.7"
   },
-  "gitHead": "778740715dc4112e140f372d75da1b57523babc6"
+  "gitHead": "b6c06cecaa56b82534d0478fc565c6a4968991fd"
 }

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

@@ -3,8 +3,6 @@ import {
   attach,
   registerExtension,
   updateInternalExtensionStore,
-  getExtensionInternalStore,
-  getExtensionStore,
 } from "../../../esm-extensions";
 import {
   ExtensionSlot,
@@ -22,7 +20,17 @@ import {
   getExtensionSlotsConfigStore,
 } from "../../../esm-config/src";
 import { act, render, screen, waitFor } from "@testing-library/react";
-import { waitForElementToBeRemoved } from "@testing-library/dom";
+import { Person } from "@openmrs/esm-api";
+import { mockSessionStore } from "../../mock";
+
+jest.mock("@openmrs/esm-api", () => {
+  const original = jest.requireActual("@openmrs/esm-api");
+  return {
+    ...original,
+    getSessionStore: () => mockSessionStore,
+    refetchCurrentUser: jest.fn(),
+  };
+});
 
 describe("Interaction between configuration and extension systems", () => {
   beforeEach(() => {
@@ -244,12 +252,172 @@ describe("Interaction between configuration and extension systems", () => {
     });
     expect(screen.getByText(/clothes/)).toHaveTextContent(/tiger/);
   });
+
+  test("should not show extension when user lacks configured privilege", async () => {
+    mockSessionStore.setState({
+      loaded: true,
+      session: {
+        authenticated: true,
+        sessionId: "1",
+        user: {
+          uuid: "1",
+          display: "Non-Admin",
+          username: "nonadmin",
+          systemId: "nonadmin",
+          userProperties: {},
+          person: {} as Person,
+          privileges: [],
+          roles: [],
+          retired: false,
+          locale: "en",
+          allowedLocales: ["en"],
+        },
+      },
+    });
+
+    registerSimpleExtension("Schmoo", "esm-bedrock", true);
+    registerSimpleExtension("Wilma", "esm-flintstones", true);
+    attach("A slot", "Schmoo");
+    attach("A slot", "Wilma");
+    defineConfigSchema("esm-bedrock", {});
+    defineConfigSchema("esm-flintstones", {});
+    provide({
+      "esm-bedrock": {
+        "Display conditions": {
+          privileges: ["Yabadabadoo!"],
+        },
+      },
+    });
+    provide({
+      "esm-flintstones": {},
+    });
+
+    function RootComponent() {
+      return (
+        <div>
+          <ExtensionSlot data-testid="slot" extensionSlotName="A slot" />
+        </div>
+      );
+    }
+    const App = openmrsComponentDecorator({
+      moduleName: "esm-bedrock",
+      featureName: "Bedrock",
+      disableTranslations: true,
+    })(RootComponent);
+
+    render(<App />);
+    await waitFor(() => expect(screen.getByTestId(/slot/)).toBeInTheDocument());
+    expect(screen.getByText(/\bWilma\b/)).toBeVisible();
+    expect(screen.queryAllByText(/\bSchmoo\b/)).toHaveLength(0);
+  });
+
+  test("should show extension when user has configured privilege", async () => {
+    mockSessionStore.setState({
+      loaded: true,
+      session: {
+        authenticated: true,
+        sessionId: "1",
+        user: {
+          uuid: "1",
+          display: "Non-Admin",
+          username: "nonadmin",
+          systemId: "nonadmin",
+          userProperties: {},
+          person: {} as Person,
+          privileges: [{ uuid: "1", display: "Yabadabadoo!" }],
+          roles: [],
+          retired: false,
+          locale: "en",
+          allowedLocales: ["en"],
+        },
+      },
+    });
+
+    registerSimpleExtension("Schmoo", "esm-bedrock", true);
+    attach("A slot", "Schmoo");
+    defineConfigSchema("esm-bedrock", {});
+    provide({
+      "esm-bedrock": {
+        "Display conditions": {
+          privileges: ["Yabadabadoo!"],
+        },
+      },
+    });
+
+    function RootComponent() {
+      return (
+        <div>
+          <ExtensionSlot data-testid="slot" extensionSlotName="A slot" />
+        </div>
+      );
+    }
+    const App = openmrsComponentDecorator({
+      moduleName: "esm-bedrock",
+      featureName: "Bedrock",
+      disableTranslations: true,
+    })(RootComponent);
+
+    render(<App />);
+    await waitFor(() => expect(screen.getByTestId(/slot/)).toBeInTheDocument());
+    expect(screen.getByText(/\bSchmoo\b/)).toBeVisible();
+  });
+
+  test("should only show extensions users have default privilege for", async () => {
+    mockSessionStore.setState({
+      loaded: true,
+      session: {
+        authenticated: true,
+        sessionId: "1",
+        user: {
+          uuid: "1",
+          display: "Non-Admin",
+          username: "nonadmin",
+          systemId: "nonadmin",
+          userProperties: {},
+          person: {} as Person,
+          privileges: [{ uuid: "1", display: "YOWTCH!" }],
+          roles: [],
+          retired: false,
+          locale: "en",
+          allowedLocales: ["en"],
+        },
+      },
+    });
+
+    registerSimpleExtension("Schmoo", "esm-bedrock", true, "Yabadabadoo!");
+    registerSimpleExtension("Wilma", "esm-flintstones", true, "YOWTCH!");
+    attach("A slot", "Schmoo");
+    attach("A slot", "Wilma");
+    defineConfigSchema("esm-bedrock", {});
+    defineConfigSchema("esm-flintstones", {});
+    provide({ "esm-bedrock": {} });
+    provide({ "esm-flintstones": {} });
+
+    function RootComponent() {
+      return (
+        <div>
+          <ExtensionSlot data-testid="slot" extensionSlotName="A slot" />
+        </div>
+      );
+    }
+    const App = openmrsComponentDecorator({
+      moduleName: "esm-bedrock",
+      featureName: "Bedrock",
+      disableTranslations: true,
+    })(RootComponent);
+
+    render(<App />);
+    await waitFor(() => expect(screen.getByTestId(/slot/)).toBeInTheDocument());
+    expect(screen.getByText(/\bWilma\b/)).toBeVisible();
+    expect(screen.queryAllByText(/\bSchmoo\b/)).toHaveLength(0);
+  });
 });
 
 function registerSimpleExtension(
   name: string,
   moduleName: string,
-  takesConfig: boolean = false
+  takesConfig: boolean = false,
+  privileges?: string | string[]
 ) {
   const SimpleComponent = () => <div>{name}</div>;
   const ConfigurableComponent = () => {
@@ -272,5 +440,6 @@ function registerSimpleExtension(
       }
     ),
     meta: {},
+    privileges,
   });
 }