@openmrs/esm-framework 3.3.2-pre.9 → 4.0.0-pre.0

package/docs/API.md

@@ -141,6 +141,7 @@
 
 ### UI Functions
 
+- [isDesktop](API.md#isdesktop)
 - [setLeftNav](API.md#setleftnav)
 - [showModal](API.md#showmodal)
 - [showNotification](API.md#shownotification)
@@ -494,7 +495,7 @@ ___
 
 ### LayoutType
 
-Ƭ **LayoutType**: ``"tablet"`` \| ``"phone"`` \| ``"desktop"``
+Ƭ **LayoutType**: ``"phone"`` \| ``"tablet"`` \| ``"small-desktop"`` \| ``"large-desktop"``
 
 #### Defined in
 
@@ -514,17 +515,17 @@ ___
 
 ### UserHasAccess
 
-• **UserHasAccess**: `React.FC`<[`UserHasAccessProps`](interfaces/UserHasAccessProps.md)\>
+• `Const` **UserHasAccess**: `React.FC`<[`UserHasAccessProps`](interfaces/UserHasAccessProps.md)\>
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/UserHasAccess.tsx:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L9)
+[packages/framework/esm-react-utils/src/UserHasAccess.tsx:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L10)
 
 ___
 
 ### defaultVisitCustomRepresentation
 
-• **defaultVisitCustomRepresentation**: `string`
+• `Const` **defaultVisitCustomRepresentation**: `string`
 
 #### Defined in
 
@@ -534,7 +535,7 @@ ___
 
 ### fhir
 
-• **fhir**: `FhirClient`
+• `Const` **fhir**: `FhirClient`
 
 The `fhir` object is [an instance of fhir.js](https://github.com/FHIR/fhir.js)
 that can be used to call FHIR-compliant OpenMRS APIs. See
@@ -549,7 +550,7 @@ ___
 
 ### fhirBaseUrl
 
-• **fhirBaseUrl**: ``"/ws/fhir2/R4"``
+• `Const` **fhirBaseUrl**: ``"/ws/fhir2/R4"``
 
 #### Defined in
 
@@ -559,7 +560,7 @@ ___
 
 ### getStartedVisit
 
-• **getStartedVisit**: `BehaviorSubject`<``null`` \| [`VisitItem`](interfaces/VisitItem.md)\>
+• `Const` **getStartedVisit**: `BehaviorSubject`<``null`` \| [`VisitItem`](interfaces/VisitItem.md)\>
 
 #### Defined in
 
@@ -569,7 +570,7 @@ ___
 
 ### sessionEndpoint
 
-• **sessionEndpoint**: ``"/ws/rest/v1/session"``
+• `Const` **sessionEndpoint**: ``"/ws/rest/v1/session"``
 
 #### Defined in
 
@@ -581,7 +582,7 @@ ___
 
 ### validators
 
-• **validators**: `Object`
+• `Const` **validators**: `Object`
 
 #### Type declaration
 
@@ -601,7 +602,7 @@ ___
 
 ### ConfigurableLink
 
-• **ConfigurableLink**: `React.FC`<[`ConfigurableLinkProps`](interfaces/ConfigurableLinkProps.md)\>
+• `Const` **ConfigurableLink**: `React.FC`<[`ConfigurableLinkProps`](interfaces/ConfigurableLinkProps.md)\>
 
 A React link component which calls [navigate](API.md#navigate) when clicked
 
@@ -621,7 +622,7 @@ ___
 
 ### offlineUuidPrefix
 
-• **offlineUuidPrefix**: ``"OFFLINE+"``
+• `Const` **offlineUuidPrefix**: ``"OFFLINE+"``
 
 #### Defined in
 
@@ -631,7 +632,7 @@ ___
 
 ### omrsOfflineCachingStrategyHttpHeaderName
 
-• **omrsOfflineCachingStrategyHttpHeaderName**: ``"x-omrs-offline-caching-strategy"``
+• `Const` **omrsOfflineCachingStrategyHttpHeaderName**: ``"x-omrs-offline-caching-strategy"``
 
 #### Defined in
 
@@ -641,7 +642,7 @@ ___
 
 ### omrsOfflineResponseBodyHttpHeaderName
 
-• **omrsOfflineResponseBodyHttpHeaderName**: ``"x-omrs-offline-response-body"``
+• `Const` **omrsOfflineResponseBodyHttpHeaderName**: ``"x-omrs-offline-response-body"``
 
 #### Defined in
 
@@ -651,7 +652,7 @@ ___
 
 ### omrsOfflineResponseStatusHttpHeaderName
 
-• **omrsOfflineResponseStatusHttpHeaderName**: ``"x-omrs-offline-response-status"``
+• `Const` **omrsOfflineResponseStatusHttpHeaderName**: ``"x-omrs-offline-response-status"``
 
 #### Defined in
 
@@ -663,7 +664,7 @@ ___
 
 ### Extension
 
-• **Extension**: `React.FC`<[`ExtensionProps`](interfaces/ExtensionProps.md)\>
+• `Const` **Extension**: `React.FC`<[`ExtensionProps`](interfaces/ExtensionProps.md)\>
 
 Represents the position in the DOM where each extension within
 an extension slot is rendered.
@@ -681,7 +682,7 @@ ___
 
 ### ExtensionSlot
 
-• **ExtensionSlot**: `React.FC`<[`ExtensionSlotProps`](API.md#extensionslotprops)\>
+• `Const` **ExtensionSlot**: `React.FC`<[`ExtensionSlotProps`](API.md#extensionslotprops)\>
 
 #### Defined in
 
@@ -691,7 +692,7 @@ ___
 
 ### backendDependencies
 
-• **backendDependencies**: `Object`
+• `Const` **backendDependencies**: `Object`
 
 #### Type declaration
 
@@ -710,7 +711,7 @@ ___
 
 ### LeftNavMenu
 
-• **LeftNavMenu**: `ForwardRefExoticComponent`<`SideNavProps` & `RefAttributes`<`HTMLElement`\>\>
+• `Const` **LeftNavMenu**: `ForwardRefExoticComponent`<`Pick`<`SideNavProps`, `string` \| `number` \| `symbol`\> & `RefAttributes`<`HTMLElement`\>\>
 
 #### Defined in
 
@@ -1597,7 +1598,7 @@ ___
 
 ### inRange
 
-▸ `Const` **inRange**(`min`, `max`): [`Validator`](API.md#validator)
+▸ **inRange**(`min`, `max`): [`Validator`](API.md#validator)
 
 Verifies that the value is between the provided minimum and maximum
 
@@ -1620,7 +1621,7 @@ ___
 
 ### isUrl
 
-▸ `Const` **isUrl**(`value`): `string` \| `void`
+▸ **isUrl**(`value`): `string` \| `void`
 
 Verifies that a string contains only the default URL template parameters.
 
@@ -1644,7 +1645,7 @@ ___
 
 ### isUrlWithTemplateParameters
 
-▸ `Const` **isUrlWithTemplateParameters**(`allowedTemplateParameters`): [`Validator`](API.md#validator)
+▸ **isUrlWithTemplateParameters**(`allowedTemplateParameters`): [`Validator`](API.md#validator)
 
 Verifies that a string contains only the default URL template
 parameters, plus any specified in `allowedTemplateParameters`.
@@ -2214,7 +2215,7 @@ ___
 
 ### getExtensionStore
 
-▸ `Const` **getExtensionStore**(): `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
+▸ **getExtensionStore**(): `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
 
 This returns a [store](https://github.com/developit/unistore#store)
 that modules can use to get information about the state of the
@@ -2360,7 +2361,7 @@ ___
 
 ### useExtensionStore
 
-▸ `Const` **useExtensionStore**(): `T`
+▸ **useExtensionStore**(): `T`
 
 #### Returns
 
@@ -2370,7 +2371,7 @@ ___
 
 [packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L5)
 
-▸ `Const` **useExtensionStore**(`actions`): `T` & [`BoundActions`](API.md#boundactions)
+▸ **useExtensionStore**(`actions`): `T` & [`BoundActions`](API.md#boundactions)
 
 #### Parameters
 
@@ -2386,7 +2387,7 @@ ___
 
 [packages/framework/esm-react-utils/src/useExtensionStore.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useExtensionStore.ts#L5)
 
-▸ `Const` **useExtensionStore**(`actions?`): `T` & [`BoundActions`](API.md#boundactions)
+▸ **useExtensionStore**(`actions?`): `T` & [`BoundActions`](API.md#boundactions)
 
 #### Parameters
 
@@ -2408,7 +2409,7 @@ ___
 
 ### getAsyncExtensionLifecycle
 
-▸ `Const` **getAsyncExtensionLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`ReactAppOrParcel`<`any`\>\>
+▸ **getAsyncExtensionLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`ReactAppOrParcel`<`any`\>\>
 
 **`deprecated`** Use getAsyncLifecycle instead.
 
@@ -2728,7 +2729,7 @@ ___
 
 ### getFullSynchronizationItems
 
-▸ **getFullSynchronizationItems**<`T`\>(`type`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
+▸ **getFullSynchronizationItems**<`T`\>(`type?`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
 
 Returns all currently queued up sync items of the currently signed in user.
 
@@ -2742,7 +2743,7 @@ Returns all currently queued up sync items of the currently signed in user.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `type` | `string` | The identifying type of the synchronization items to be returned. |
+| `type?` | `string` | The identifying type of the synchronization items to be returned. |
 
 #### Returns
 
@@ -2750,13 +2751,13 @@ Returns all currently queued up sync items of the currently signed in user.
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:347](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L347)
+[packages/framework/esm-offline/src/sync.ts:345](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L345)
 
 ___
 
 ### getFullSynchronizationItemsFor
 
-▸ **getFullSynchronizationItemsFor**<`T`\>(`userId`, `type`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
+▸ **getFullSynchronizationItemsFor**<`T`\>(`userId`, `type?`): `Promise`<[`SyncItem`](interfaces/SyncItem.md)<`T`\>[]\>
 
 Returns all currently queued up sync items of a given user.
 
@@ -2771,7 +2772,7 @@ Returns all currently queued up sync items of a given user.
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `userId` | `string` | The ID of the user whose synchronization items should be returned. |
-| `type` | `string` | The identifying type of the synchronization items to be returned.. |
+| `type?` | `string` | The identifying type of the synchronization items to be returned.. |
 
 #### Returns
 
@@ -2779,7 +2780,7 @@ Returns all currently queued up sync items of a given user.
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:320](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L320)
+[packages/framework/esm-offline/src/sync.ts:321](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L321)
 
 ___
 
@@ -2821,13 +2822,13 @@ Returns a queued sync item with the given ID or `undefined` if no such item exis
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:356](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L356)
+[packages/framework/esm-offline/src/sync.ts:354](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L354)
 
 ___
 
 ### getSynchronizationItems
 
-▸ **getSynchronizationItems**<`T`\>(`type`): `Promise`<`T`[]\>
+▸ **getSynchronizationItems**<`T`\>(`type?`): `Promise`<`T`[]\>
 
 Returns the content of all currently queued up sync items of the currently signed in user.
 
@@ -2841,7 +2842,7 @@ Returns the content of all currently queued up sync items of the currently signe
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `type` | `string` | The identifying type of the synchronization items to be returned. |
+| `type?` | `string` | The identifying type of the synchronization items to be returned. |
 
 #### Returns
 
@@ -2849,7 +2850,7 @@ Returns the content of all currently queued up sync items of the currently signe
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:338](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L338)
+[packages/framework/esm-offline/src/sync.ts:336](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L336)
 
 ___
 
@@ -2939,7 +2940,7 @@ Enqueues a new item in the sync queue and associates the item with the currently
 
 #### Defined in
 
-[packages/framework/esm-offline/src/sync.ts:293](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L293)
+[packages/framework/esm-offline/src/sync.ts:294](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-offline/src/sync.ts#L294)
 
 ___
 
@@ -3414,6 +3415,26 @@ ___
 
 ## UI Functions
 
+### isDesktop
+
+▸ **isDesktop**(`layout`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `layout` | [`LayoutType`](API.md#layouttype) |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/useLayoutType.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useLayoutType.ts#L40)
+
+___
+
 ### setLeftNav
 
 ▸ **setLeftNav**(`__namedParameters`): `void`
@@ -3484,7 +3505,7 @@ Displays an inline notification in the UI.
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/notifications/index.tsx:41](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/notifications/index.tsx#L41)
+[packages/framework/esm-styleguide/src/notifications/index.tsx:40](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/notifications/index.tsx#L40)
 
 ___
 
@@ -3506,7 +3527,7 @@ Displays a toast notification in the UI.
 
 #### Defined in
 
-[packages/framework/esm-styleguide/src/toasts/index.tsx:35](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/index.tsx#L35)
+[packages/framework/esm-styleguide/src/toasts/index.tsx:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-styleguide/src/toasts/index.tsx#L36)
 
 ___
 
@@ -3612,7 +3633,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/useLayoutType.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useLayoutType.ts#L23)
+[packages/framework/esm-react-utils/src/useLayoutType.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/useLayoutType.ts#L26)
 
 ___
 

package/docs/interfaces/UserHasAccessProps.md

@@ -6,10 +6,21 @@
 
 ### API Properties
 
+- [children](UserHasAccessProps.md#children)
 - [privilege](UserHasAccessProps.md#privilege)
 
 ## API Properties
 
+### children
+
+• `Optional` **children**: `ReactNode`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/UserHasAccess.tsx:7](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L7)
+
+___
+
 ### privilege
 
 • **privilege**: `string`

package/jest.config.js

@@ -6,6 +6,11 @@ module.exports = {
     "\\.(s?css)$": "identity-obj-proxy",
     "\\.(svg)$": "<rootDir>/__mocks__/fileMock.js",
     "lodash-es/(.*)": "lodash/$1",
+    // See https://jestjs.io/docs/upgrading-to-jest28#packagejson-exports
+    // which links to https://github.com/microsoft/accessibility-insights-web/pull/5421#issuecomment-1109168149
+    "^dexie$": require.resolve("dexie"),
+    "^uuid$": require.resolve("uuid"),
   },
   setupFilesAfterEnv: ["<rootDir>/src/integration-tests/setup-tests.ts"],
+  testEnvironment: "jsdom",
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "3.3.2-pre.9",
+  "version": "4.0.0-pre.0",
   "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.3.2-pre.9",
-    "@openmrs/esm-breadcrumbs": "^3.3.2-pre.9",
-    "@openmrs/esm-config": "^3.3.2-pre.9",
-    "@openmrs/esm-error-handling": "^3.3.2-pre.9",
-    "@openmrs/esm-extensions": "^3.3.2-pre.9",
-    "@openmrs/esm-globals": "^3.3.2-pre.9",
-    "@openmrs/esm-offline": "^3.3.2-pre.9",
-    "@openmrs/esm-react-utils": "^3.3.2-pre.9",
-    "@openmrs/esm-state": "^3.3.2-pre.9",
-    "@openmrs/esm-styleguide": "^3.3.2-pre.9",
-    "@openmrs/esm-utils": "^3.3.2-pre.9",
+    "@openmrs/esm-api": "^4.0.0-pre.0",
+    "@openmrs/esm-breadcrumbs": "^4.0.0-pre.0",
+    "@openmrs/esm-config": "^4.0.0-pre.0",
+    "@openmrs/esm-error-handling": "^4.0.0-pre.0",
+    "@openmrs/esm-extensions": "^4.0.0-pre.0",
+    "@openmrs/esm-globals": "^4.0.0-pre.0",
+    "@openmrs/esm-offline": "^4.0.0-pre.0",
+    "@openmrs/esm-react-utils": "^4.0.0-pre.0",
+    "@openmrs/esm-state": "^4.0.0-pre.0",
+    "@openmrs/esm-styleguide": "^4.0.0-pre.0",
+    "@openmrs/esm-utils": "^4.0.0-pre.0",
     "dayjs": "^1.10.7"
   },
-  "gitHead": "cf39a8f13110271a58afce56819d93eb8b759dc5"
+  "gitHead": "254a7226212aac82df4434639b2584e24ac240e4"
 }

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,6 @@ import {
   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(() => {
@@ -210,7 +207,9 @@ describe("Interaction between configuration and extension systems", () => {
       });
     });
     expect(screen.queryByText("green")).not.toBeInTheDocument();
-    expect(screen.getByTestId("slot")).toHaveTextContent(/black/);
+    waitFor(() =>
+      expect(screen.getByTestId("slot")).toHaveTextContent(/black/)
+    );
   });
 
   test("Extension config should be available in extension store", async () => {