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

package/docs/API.md

@@ -53,7 +53,6 @@
 - [inRange](API.md#inrange)
 - [isUrl](API.md#isurl)
 - [isUrlWithTemplateParameters](API.md#isurlwithtemplateparameters)
-- [oneOf](API.md#oneof)
 - [validator](API.md#validator)
 
 ### Date and Time Functions
@@ -142,6 +141,7 @@
 
 ### UI Functions
 
+- [isDesktop](API.md#isdesktop)
 - [setLeftNav](API.md#setleftnav)
 - [showModal](API.md#showmodal)
 - [showNotification](API.md#shownotification)
@@ -495,7 +495,7 @@ ___
 
 ### LayoutType
 
-Ƭ **LayoutType**: ``"tablet"`` \| ``"phone"`` \| ``"desktop"``
+Ƭ **LayoutType**: ``"phone"`` \| ``"tablet"`` \| ``"small-desktop"`` \| ``"large-desktop"``
 
 #### Defined in
 
@@ -515,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
 
@@ -535,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
@@ -550,7 +550,7 @@ ___
 
 ### fhirBaseUrl
 
-• **fhirBaseUrl**: ``"/ws/fhir2/R4"``
+• `Const` **fhirBaseUrl**: ``"/ws/fhir2/R4"``
 
 #### Defined in
 
@@ -560,7 +560,7 @@ ___
 
 ### getStartedVisit
 
-• **getStartedVisit**: `BehaviorSubject`<``null`` \| [`VisitItem`](interfaces/VisitItem.md)\>
+• `Const` **getStartedVisit**: `BehaviorSubject`<``null`` \| [`VisitItem`](interfaces/VisitItem.md)\>
 
 #### Defined in
 
@@ -570,7 +570,7 @@ ___
 
 ### sessionEndpoint
 
-• **sessionEndpoint**: ``"/ws/rest/v1/session"``
+• `Const` **sessionEndpoint**: ``"/ws/rest/v1/session"``
 
 #### Defined in
 
@@ -582,7 +582,7 @@ ___
 
 ### validators
 
-• **validators**: `Object`
+• `Const` **validators**: `Object`
 
 #### Type declaration
 
@@ -591,11 +591,10 @@ ___
 | `inRange` | (`min`: `number`, `max`: `number`) => [`Validator`](API.md#validator) |
 | `isUrl` | [`Validator`](API.md#validator) |
 | `isUrlWithTemplateParameters` | (`allowedTemplateParameters`: `string`[]) => [`Validator`](API.md#validator) |
-| `oneOf` | (`allowedValues`: `any`[]) => [`Validator`](API.md#validator) |
 
 #### Defined in
 
-[packages/framework/esm-config/src/validators/validators.ts:69](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validators.ts#L69)
+[packages/framework/esm-config/src/validators/validators.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validators.ts#L58)
 
 ___
 
@@ -603,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
 
@@ -623,7 +622,7 @@ ___
 
 ### offlineUuidPrefix
 
-• **offlineUuidPrefix**: ``"OFFLINE+"``
+• `Const` **offlineUuidPrefix**: ``"OFFLINE+"``
 
 #### Defined in
 
@@ -633,7 +632,7 @@ ___
 
 ### omrsOfflineCachingStrategyHttpHeaderName
 
-• **omrsOfflineCachingStrategyHttpHeaderName**: ``"x-omrs-offline-caching-strategy"``
+• `Const` **omrsOfflineCachingStrategyHttpHeaderName**: ``"x-omrs-offline-caching-strategy"``
 
 #### Defined in
 
@@ -643,7 +642,7 @@ ___
 
 ### omrsOfflineResponseBodyHttpHeaderName
 
-• **omrsOfflineResponseBodyHttpHeaderName**: ``"x-omrs-offline-response-body"``
+• `Const` **omrsOfflineResponseBodyHttpHeaderName**: ``"x-omrs-offline-response-body"``
 
 #### Defined in
 
@@ -653,7 +652,7 @@ ___
 
 ### omrsOfflineResponseStatusHttpHeaderName
 
-• **omrsOfflineResponseStatusHttpHeaderName**: ``"x-omrs-offline-response-status"``
+• `Const` **omrsOfflineResponseStatusHttpHeaderName**: ``"x-omrs-offline-response-status"``
 
 #### Defined in
 
@@ -665,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.
@@ -683,7 +682,7 @@ ___
 
 ### ExtensionSlot
 
-• **ExtensionSlot**: `React.FC`<[`ExtensionSlotProps`](API.md#extensionslotprops)\>
+• `Const` **ExtensionSlot**: `React.FC`<[`ExtensionSlotProps`](API.md#extensionslotprops)\>
 
 #### Defined in
 
@@ -693,7 +692,7 @@ ___
 
 ### backendDependencies
 
-• **backendDependencies**: `Object`
+• `Const` **backendDependencies**: `Object`
 
 #### Type declaration
 
@@ -712,7 +711,7 @@ ___
 
 ### LeftNavMenu
 
-• **LeftNavMenu**: `ForwardRefExoticComponent`<`SideNavProps` & `RefAttributes`<`HTMLElement`\>\>
+• `Const` **LeftNavMenu**: `ForwardRefExoticComponent`<`Pick`<`SideNavProps`, `string` \| `number` \| `symbol`\> & `RefAttributes`<`HTMLElement`\>\>
 
 #### Defined in
 
@@ -1599,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
 
@@ -1622,7 +1621,7 @@ ___
 
 ### isUrl
 
-▸ `Const` **isUrl**(`value`): `string` \| `void`
+▸ **isUrl**(`value`): `string` \| `void`
 
 Verifies that a string contains only the default URL template parameters.
 
@@ -1646,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`.
@@ -1669,63 +1668,24 @@ parameters, plus any specified in `allowedTemplateParameters`.
 
 ___
 
-### oneOf
-
-▸ `Const` **oneOf**(`allowedValues`): [`Validator`](API.md#validator)
-
-Verifies that the value is one of the allowed options.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `allowedValues` | `any`[] | The list of allowable values |
-
-#### Returns
-
-[`Validator`](API.md#validator)
-
-#### Defined in
-
-[packages/framework/esm-config/src/validators/validators.ts:62](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validators.ts#L62)
-
-___
-
 ### validator
 
 ▸ **validator**(`validationFunction`, `message`): [`Validator`](API.md#validator)
 
-Constructs a custom validator.
-
-### Example
-
-```typescript
-{
-  foo: {
-    _default: 0,
-    _validators: [
-      validator(val => val >= 0, "Must not be negative.")
-    ]
-  }
-}
-```
-
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `validationFunction` | [`ValidatorFunction`](API.md#validatorfunction) | Takes the configured value as input. Returns true    if it is valid, false otherwise. |
-| `message` | `string` \| (`value`: `any`) => `string` | A string message that explains why the value is invalid. Can    also be a function that takes the value as input and returns a string. |
+| Name | Type |
+| :------ | :------ |
+| `validationFunction` | [`ValidatorFunction`](API.md#validatorfunction) |
+| `message` | `string` |
 
 #### Returns
 
 [`Validator`](API.md#validator)
 
-A validator ready for use in a config schema
-
 #### Defined in
 
-[packages/framework/esm-config/src/validators/validator.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validator.ts#L25)
+[packages/framework/esm-config/src/validators/validator.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/validators/validator.ts#L4)
 
 ___
 
@@ -2255,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
@@ -2401,7 +2361,7 @@ ___
 
 ### useExtensionStore
 
-▸ `Const` **useExtensionStore**(): `T`
+▸ **useExtensionStore**(): `T`
 
 #### Returns
 
@@ -2411,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
 
@@ -2427,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
 
@@ -2449,7 +2409,7 @@ ___
 
 ### getAsyncExtensionLifecycle
 
-▸ `Const` **getAsyncExtensionLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`ReactAppOrParcel`<`any`\>\>
+▸ **getAsyncExtensionLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`ReactAppOrParcel`<`any`\>\>
 
 **`deprecated`** Use getAsyncLifecycle instead.
 
@@ -3455,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`
@@ -3525,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)
 
 ___
 
@@ -3547,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)
 
 ___
 
@@ -3653,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/mock.tsx

@@ -10,11 +10,7 @@ export {
   formatTime,
   age,
 } from "@openmrs/esm-utils";
-export {
-  interpolateString,
-  interpolateUrl,
-  validators,
-} from "@openmrs/esm-config";
+export { interpolateString, interpolateUrl } from "@openmrs/esm-config";
 
 window.i18next = { ...window.i18next, language: "en" };
 
@@ -153,6 +149,13 @@ export enum Type {
   UUID = "UUID",
 }
 
+export const validators = {
+  isBoolean: jest.fn(),
+  isString: jest.fn(),
+  isUuid: jest.fn(),
+  isObject: jest.fn(),
+};
+
 let configSchema = {};
 function getDefaults(schema) {
   let tmp = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "3.3.2-pre.33",
+  "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.33",
-    "@openmrs/esm-breadcrumbs": "^3.3.2-pre.33",
-    "@openmrs/esm-config": "^3.3.2-pre.33",
-    "@openmrs/esm-error-handling": "^3.3.2-pre.33",
-    "@openmrs/esm-extensions": "^3.3.2-pre.33",
-    "@openmrs/esm-globals": "^3.3.2-pre.33",
-    "@openmrs/esm-offline": "^3.3.2-pre.33",
-    "@openmrs/esm-react-utils": "^3.3.2-pre.33",
-    "@openmrs/esm-state": "^3.3.2-pre.33",
-    "@openmrs/esm-styleguide": "^3.3.2-pre.33",
-    "@openmrs/esm-utils": "^3.3.2-pre.33",
+    "@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": "f198f5768f43f7a24b7d0ab2124d3ea4b5faac90"
+  "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 () => {