@openmrs/esm-framework 4.0.3-pre.367 → 4.0.3-pre.379

package/docs/API.md

@@ -160,6 +160,7 @@
 - [setLeftNav](API.md#setleftnav)
 - [showModal](API.md#showmodal)
 - [showNotification](API.md#shownotification)
+- [showActionableNotification](API.md#showactionablenotification)
 - [showToast](API.md#showtoast)
 - [subscribeNotificationShown](API.md#subscribenotificationshown)
 - [subscribeToastShown](API.md#subscribetoastshown)
@@ -397,7 +398,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/Extension.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/Extension.tsx#L14)
+[packages/framework/esm-react-utils/src/Extension.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/Extension.tsx#L13)
 
 ___
 
@@ -534,6 +535,16 @@ ___
 
 ___
 
+### ActionableNotificationType
+
+Ƭ **ActionableNotificationType**: ``"error"`` \| ``"info"`` \| ``"info-square"`` \| ``"success"`` \| ``"warning"`` \| ``"warning-alt"``
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L25)
+
+___
+
 ### LayoutType
 
 Ƭ **LayoutType**: ``"phone"`` \| ``"tablet"`` \| ``"small-desktop"`` \| ``"large-desktop"``
@@ -719,7 +730,7 @@ and *must* only be used once within that `<ExtensionSlot>`.
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/Extension.tsx:36](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/Extension.tsx#L36)
+[packages/framework/esm-react-utils/src/Extension.tsx:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/Extension.tsx#L35)
 
 ___
 
@@ -2227,7 +2238,7 @@ An array of extensions assigned to the named slot
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/extensions.ts:359](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L359)
+[packages/framework/esm-extensions/src/extensions.ts:360](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/extensions.ts#L360)
 
 ___
 
@@ -2309,7 +2320,7 @@ ___
 
 ### renderExtension
 
-▸ **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction?`, `additionalProps?`): `Parcel` \| ``null``
+▸ **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction?`, `additionalProps?`): `Promise`<`Parcel` \| ``null``\>
 
 Mounts into a DOM node (representing an extension slot)
 a lazy-loaded component from *any* frontend module
@@ -2328,7 +2339,7 @@ that registered an extension component for this slot.
 
 #### Returns
 
-`Parcel` \| ``null``
+`Promise`<`Parcel` \| ``null``\>
 
 #### Defined in
 
@@ -3875,7 +3886,7 @@ The dispose function to force closing the modal dialog.
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/modals/index.tsx:165](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/modals/index.tsx#L165)
+[packages/framework/esm-styleguide/src/modals/index.tsx:167](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/modals/index.tsx#L167)
 
 ___
 
@@ -3897,10 +3908,31 @@ Displays an inline notification in the UI.
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/notifications/index.tsx:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/index.tsx#L40)
+[packages/framework/esm-styleguide/src/notifications/index.tsx:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/index.tsx#L48)
 
 ___
 
+### showActionableNotification
+
+▸ **showActionableNotification**(`notification`): `void`
+
+Displays an actionable notification in the UI which takes in an action.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `notification` | [`ActionableNotificationDescriptor`](interfaces/ActionableNotificationDescriptor.md) | The description of the actionable notification to display. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/notifications/index.tsx:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/index.tsx#L88)
+
+___
 ### showToast
 
 ▸ **showToast**(`toast`): `void`
@@ -3945,7 +3977,31 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-globals/src/events.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L93)
+[packages/framework/esm-globals/src/events.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L117)
+
+___
+
+▸ **subscribeActionableNotificationShown**(`cb`): () => `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `cb` | (`data`: [`ShowActionableNotificationEvent`](interfaces/ShowActionableNotificationEvent.md)) => `void` |
+
+#### Returns
+
+`fn`
+
+▸ (): `void`
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/framework/esm-globals/src/events.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L126)
 
 ___
 
@@ -3971,7 +4027,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-globals/src/events.ts:102](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L102)
+[packages/framework/esm-globals/src/events.ts:102](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-globals/src/events.ts#L136)
 
 ___
 

package/docs/classes/OpenmrsFetchError.md

@@ -25,12 +25,12 @@
 - [message](OpenmrsFetchError.md#message)
 - [name](OpenmrsFetchError.md#name)
 - [stack](OpenmrsFetchError.md#stack)
+- [prepareStackTrace](OpenmrsFetchError.md#preparestacktrace)
 - [stackTraceLimit](OpenmrsFetchError.md#stacktracelimit)
 
 ### Methods
 
 - [captureStackTrace](OpenmrsFetchError.md#capturestacktrace)
-- [prepareStackTrace](OpenmrsFetchError.md#preparestacktrace)
 
 ## API Constructors
 
@@ -135,70 +135,74 @@ node_modules/typescript/lib/lib.es5.d.ts:1024
 
 ___
 
-### stackTraceLimit
-
-▪ `Static` **stackTraceLimit**: `number`
-
-#### Inherited from
-
-Error.stackTraceLimit
+### prepareStackTrace
 
-#### Defined in
+▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
 
-node_modules/@types/node/globals.d.ts:142
+#### Type declaration
 
-## Methods
+▸ (`err`, `stackTraces`): `any`
 
-### captureStackTrace
-
-▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+Optional override for formatting stack traces
 
-Create .stack property on a target object
+**`see`** https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
-#### Parameters
+##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `targetObject` | `Object` |
-| `constructorOpt?` | `Function` |
+| `err` | `Error` |
+| `stackTraces` | `CallSite`[] |
 
-#### Returns
+##### Returns
 
-`void`
+`any`
 
 #### Inherited from
 
-Error.captureStackTrace
+Error.prepareStackTrace
 
 #### Defined in
 
-node_modules/@types/node/globals.d.ts:133
+packages/framework/esm-framework/node_modules/@types/node/globals.d.ts:11
 
 ___
 
-### prepareStackTrace
+### stackTraceLimit
 
-▸ `Static` `Optional` **prepareStackTrace**(`err`, `stackTraces`): `any`
+▪ `Static` **stackTraceLimit**: `number`
 
-Optional override for formatting stack traces
+#### Inherited from
 
-**`see`** https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces
+Error.stackTraceLimit
+
+#### Defined in
+
+packages/framework/esm-framework/node_modules/@types/node/globals.d.ts:13
+
+## Methods
+
+### captureStackTrace
+
+▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Create .stack property on a target object
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `err` | `Error` |
-| `stackTraces` | `CallSite`[] |
+| `targetObject` | `object` |
+| `constructorOpt?` | `Function` |
 
 #### Returns
 
-`any`
+`void`
 
 #### Inherited from
 
-Error.prepareStackTrace
+Error.captureStackTrace
 
 #### Defined in
 
-node_modules/@types/node/globals.d.ts:140
+packages/framework/esm-framework/node_modules/@types/node/globals.d.ts:4

package/docs/interfaces/ActionableNotificationDescriptor.md

@@ -0,0 +1,82 @@
+[@openmrs/esm-framework](../API.md) / ActionableNotificationDescriptor
+
+# Interface: ActionableNotificationDescriptor
+
+## Table of contents
+
+### UI Properties
+
+- [actionButtonLable](ActionableNotificationDescriptor.md#actionButtonLable)
+- [critical](ActionableNotificationDescriptor.md#critical)
+- [subtitle](ActionableNotificationDescriptor.md#subtitle)
+- [kind](ActionableNotificationDescriptor.md#kind)
+- [onActionButtonClick](ActionableNotificationDescriptor.md#onActionButtonClick)
+- [title](ActionableNotificationDescriptor.md#title)
+
+## UI Properties
+
+### actionButtonLabel
+
+• **actionButtonLabel**: `string`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L10)
+
+___
+
+• **onActionButtonClick**: `void`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L11)
+
+___
+
+### critical
+
+• `Optional` **critical**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/notifications/notification.component.tsx:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L16)
+
+___
+
+### subtitle
+
+• **subtitle**: `string`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/notifications/notification.component.tsx:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L13)
+
+___
+
+### kind
+
+• `Optional` **kind**: [`ActionableNotificationType`](../API.md#actionablenotificationtype)
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L15)
+
+___
+
+### progressActionLabel
+
+• `Optional` **progressActionLabel**: `string`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:17](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L17)
+
+___
+
+### title
+
+• `Optional` **title**: `string`
+
+#### Defined in
+
+[packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/actionable-notification.component.tsx#L14)

package/mock.tsx

@@ -303,6 +303,7 @@ export const useVisitTypes = jest.fn(() => []);
 /* esm-styleguide */
 
 export const showNotification = jest.fn();
+export const showActionableNotification = jest.fn();
 export const showToast = jest.fn();
 export const showModal = jest.fn();
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "4.0.3-pre.367",
+  "version": "4.0.3-pre.379",
   "license": "MPL-2.0",
   "browser": "dist/openmrs-esm-framework.js",
   "main": "src/index.ts",
@@ -35,18 +35,23 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "^4.0.3-pre.367",
-    "@openmrs/esm-breadcrumbs": "^4.0.3-pre.367",
-    "@openmrs/esm-config": "^4.0.3-pre.367",
-    "@openmrs/esm-error-handling": "^4.0.3-pre.367",
-    "@openmrs/esm-extensions": "^4.0.3-pre.367",
-    "@openmrs/esm-globals": "^4.0.3-pre.367",
-    "@openmrs/esm-offline": "^4.0.3-pre.367",
-    "@openmrs/esm-react-utils": "^4.0.3-pre.367",
-    "@openmrs/esm-state": "^4.0.3-pre.367",
-    "@openmrs/esm-styleguide": "^4.0.3-pre.367",
-    "@openmrs/esm-utils": "^4.0.3-pre.367",
+    "@openmrs/esm-api": "^4.0.3-pre.379",
+    "@openmrs/esm-breadcrumbs": "^4.0.3-pre.379",
+    "@openmrs/esm-config": "^4.0.3-pre.379",
+    "@openmrs/esm-error-handling": "^4.0.3-pre.379",
+    "@openmrs/esm-extensions": "^4.0.3-pre.379",
+    "@openmrs/esm-globals": "^4.0.3-pre.379",
+    "@openmrs/esm-offline": "^4.0.3-pre.379",
+    "@openmrs/esm-react-utils": "^4.0.3-pre.379",
+    "@openmrs/esm-state": "^4.0.3-pre.379",
+    "@openmrs/esm-styleguide": "^4.0.3-pre.379",
+    "@openmrs/esm-utils": "^4.0.3-pre.379",
     "dayjs": "^1.10.7"
   },
-  "gitHead": "221f83fbf13c71ba941d4db5526369ea5e1e10ad"
+  "devDependencies": {
+    "jest": "28.1.0",
+    "jest-cli": "28.1.0",
+    "jest-environment-jsdom": "28.1.0"
+  },
+  "gitHead": "1a240c7c9dbef90d166e1fe29390d48d3cc9b305"
 }

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

@@ -59,13 +59,16 @@ describe("Interaction between configuration and extension systems", () => {
         },
       },
     });
-    const App = openmrsComponentDecorator({
-      moduleName: "esm-flintstone",
-      featureName: "The Flintstones",
-      disableTranslations: true,
-    })(() => <ExtensionSlot data-testid="slot" name="A slot" />);
 
-    render(<App />);
+    act(() => {
+      const App = openmrsComponentDecorator({
+        moduleName: "esm-flintstone",
+        featureName: "The Flintstones",
+        disableTranslations: true,
+      })(() => <ExtensionSlot data-testid="slot" name="A slot" />);
+
+      render(<App />);
+    });
 
     await waitFor(() => expect(screen.getByText("Betty")).toBeInTheDocument());
 
@@ -101,18 +104,21 @@ describe("Interaction between configuration and extension systems", () => {
         },
       },
     });
-    const App = openmrsComponentDecorator({
-      moduleName: "esm-flintstone",
-      featureName: "The Flintstones",
-      disableTranslations: true,
-    })(() => (
-      <>
-        <ExtensionSlot data-testid="flintstone-slot" name="Flintstone slot" />
-        <ExtensionSlot data-testid="future-slot" name="Future slot" />
-      </>
-    ));
-
-    render(<App />);
+
+    act(() => {
+      const App = openmrsComponentDecorator({
+        moduleName: "esm-flintstone",
+        featureName: "The Flintstones",
+        disableTranslations: true,
+      })(() => (
+        <>
+          <ExtensionSlot data-testid="flintstone-slot" name="Flintstone slot" />
+          <ExtensionSlot data-testid="future-slot" name="Future slot" />
+        </>
+      ));
+
+      render(<App />);
+    });
 
     await screen.findAllByText(/.*Pebbles.*/);
 
@@ -148,17 +154,20 @@ describe("Interaction between configuration and extension systems", () => {
         },
       },
     });
-    const App = openmrsComponentDecorator({
-      moduleName: "esm-flintstone",
-      featureName: "The Flintstones",
-      disableTranslations: true,
-    })(() => (
-      <>
-        <ExtensionSlot data-testid="flintstone-slot" name="Flintstone slot" />
-      </>
-    ));
-
-    render(<App />);
+
+    act(() => {
+      const App = openmrsComponentDecorator({
+        moduleName: "esm-flintstone",
+        featureName: "The Flintstones",
+        disableTranslations: true,
+      })(() => (
+        <>
+          <ExtensionSlot data-testid="flintstone-slot" name="Flintstone slot" />
+        </>
+      ));
+
+      render(<App />);
+    });
 
     await screen.findAllByText(/.*Dino.*/);
 
@@ -174,13 +183,16 @@ describe("Interaction between configuration and extension systems", () => {
     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" name="A slot" />);
 
-    render(<App />);
+    act(() => {
+      const App = openmrsComponentDecorator({
+        moduleName: "esm-slaghoople",
+        featureName: "The Slaghooples",
+        disableTranslations: true,
+      })(() => <ExtensionSlot data-testid="slot" name="A slot" />);
+
+      render(<App />);
+    });
 
     await waitFor(() => expect(screen.getByText("Pearl")).toBeInTheDocument());
 
@@ -207,13 +219,16 @@ describe("Interaction between configuration and extension systems", () => {
     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" name="A slot" />);
 
-    render(<App />);
+    act(() => {
+      const App = openmrsComponentDecorator({
+        moduleName: "esm-quarry",
+        featureName: "The Flintstones",
+        disableTranslations: true,
+      })(() => <ExtensionSlot data-testid="slot" name="A slot" />);
+
+      render(<App />);
+    });
 
     await waitFor(() =>
       expect(screen.getByText(/Mr. Slate/)).toBeInTheDocument()
@@ -258,13 +273,16 @@ describe("Interaction between configuration and extension systems", () => {
         </div>
       );
     }
-    const App = openmrsComponentDecorator({
-      moduleName: "esm-flintstone",
-      featureName: "The Flintstones",
-      disableTranslations: true,
-    })(RootComponent);
 
-    render(<App />);
+    act(() => {
+      const App = openmrsComponentDecorator({
+        moduleName: "esm-flintstone",
+        featureName: "The Flintstones",
+        disableTranslations: true,
+      })(RootComponent);
+
+      render(<App />);
+    });
 
     await waitFor(() => expect(screen.getByTestId(/slot/)).toBeInTheDocument());
 
@@ -335,13 +353,16 @@ describe("Interaction between configuration and extension systems", () => {
         </div>
       );
     }
-    const App = openmrsComponentDecorator({
-      moduleName: "esm-bedrock",
-      featureName: "Bedrock",
-      disableTranslations: true,
-    })(RootComponent);
 
-    render(<App />);
+    act(() => {
+      const App = openmrsComponentDecorator({
+        moduleName: "esm-bedrock",
+        featureName: "Bedrock",
+        disableTranslations: true,
+      })(RootComponent);
+
+      render(<App />);
+    });
 
     await waitFor(() => expect(screen.getByTestId(/slot/)).toBeInTheDocument());
     expect(screen.getByTestId("slot").firstChild).toHaveAttribute(
@@ -391,13 +412,16 @@ describe("Interaction between configuration and extension systems", () => {
         </div>
       );
     }
-    const App = openmrsComponentDecorator({
-      moduleName: "esm-bedrock",
-      featureName: "Bedrock",
-      disableTranslations: true,
-    })(RootComponent);
 
-    render(<App />);
+    act(() => {
+      const App = openmrsComponentDecorator({
+        moduleName: "esm-bedrock",
+        featureName: "Bedrock",
+        disableTranslations: true,
+      })(RootComponent);
+
+      render(<App />);
+    });
 
     await waitFor(() => expect(screen.getByTestId(/slot/)).toBeInTheDocument());
     expect(screen.getByTestId("slot").firstChild).toHaveAttribute(
@@ -444,13 +468,16 @@ describe("Interaction between configuration and extension systems", () => {
         </div>
       );
     }
-    const App = openmrsComponentDecorator({
-      moduleName: "esm-bedrock",
-      featureName: "Bedrock",
-      disableTranslations: true,
-    })(RootComponent);
 
-    render(<App />);
+    act(() => {
+      const App = openmrsComponentDecorator({
+        moduleName: "esm-bedrock",
+        featureName: "Bedrock",
+        disableTranslations: true,
+      })(RootComponent);
+
+      render(<App />);
+    });
 
     await waitFor(() => {
       expect(screen.getByTestId(/slot/)).toBeInTheDocument();