@openmrs/esm-framework 3.1.15-pre.752 → 3.1.15-pre.761

package/mock.tsx

@@ -2,8 +2,48 @@ import React from "react";
 import type {} from "@openmrs/esm-globals";
 import createStore, { Store } from "unistore";
 import { never, of } from "rxjs";
-import dayjs from "dayjs";
+export {
+  parseDate,
+  formatDate,
+  formatDatetime,
+  formatTime,
+} from "@openmrs/esm-utils";
 
+window.i18next = { ...window.i18next, language: "en" };
+
+/* esm-globals */
+
+export function setupPaths(config: any) {
+  window.openmrsBase = config.apiUrl;
+  window.spaBase = config.spaPath;
+  window.spaEnv = config.env || "production";
+  window.spaVersion = process.env.BUILD_VERSION;
+  window.getOpenmrsSpaBase = () => `${window.spaBase}/`;
+}
+
+/* esm-utils */
+export function isVersionSatisfied() {
+  return true;
+}
+
+/* esm-api */
+export const setSessionLocation = jest.fn(() => Promise.resolve());
+
+export const openmrsFetch = jest.fn(() => new Promise(() => {}));
+
+export const openmrsObservableFetch = jest.fn(() =>
+  of({ data: { entry: [] } })
+);
+
+export function getCurrentUser() {
+  return of({ authenticated: false });
+}
+
+export const newWorkspaceItem = jest.fn();
+
+export const fhirBaseUrl = "/ws/fhir2/R4";
+
+/* esm-state */
 interface StoreEntity {
   value: Store<any>;
   active: boolean;
@@ -15,12 +55,6 @@ const initialStates: Record<string, any> = {};
 
 const availableStores: Record<string, StoreEntity> = {};
 
-export function isVersionSatisfied() {
-  return true;
-}
-
-export const setSessionLocation = jest.fn(() => Promise.resolve());
-
 export const mockStores = availableStores;
 
 export function createGlobalStore<TState>(
@@ -83,6 +117,7 @@ function instrumentedStore<T>(name: string, store: Store<T>) {
   } as any as MockedStore<T>;
 }
 
+/* esm-config */
 export const configInternalStore = createGlobalStore("config-internal", {
   devDefaultsAreOn: false,
 });
@@ -139,23 +174,44 @@ export function defineConfigSchema(moduleName, schema) {
   configSchema = schema;
 }
 
+export const navigate = jest.fn();
+
+export const interpolateString = jest.fn();
+
+export const ConfigurableLink = jest
+  .fn()
+  .mockImplementation((config: { to: string; children: React.ReactNode }) => (
+    <a href={interpolateString(config.to)}>{config.children}</a>
+  ));
+
+/* esm-error-handling */
 export const createErrorHandler = () => jest.fn().mockReturnValue(never());
 
 export const reportError = jest.fn().mockImplementation((error) => {
   throw error;
 });
 
+/* esm-extensions */
+
+export const attach = jest.fn();
+export const detach = jest.fn();
+export const detachAll = jest.fn();
+
 export const switchTo = jest.fn();
 
-export const UserHasAccessReact = (props: any) => props.children;
+export const ExtensionSlot = ({ children }) => <>{children}</>;
 
-export const openmrsFetch = jest.fn(() => new Promise(() => {}));
+export const Extension = jest.fn().mockImplementation((props: any) => <slot />);
 
-export const openmrsObservableFetch = jest.fn(() =>
-  of({ data: { entry: [] } })
-);
+export const extensionStore = getGlobalStore("extensions", { slots: {} });
+
+/* esm-react-utils */
+
+export const ComponentContext = React.createContext(null);
 
-export const setIsUIEditorEnabled = (boolean): void => {};
+export const openmrsComponentDecorator = jest
+  .fn()
+  .mockImplementation(() => (component) => component);
 
 export const useCurrentPatient = jest.fn(() => [null, null, null, null]);
 
@@ -169,51 +225,6 @@ export const useExtensionSlot = jest.fn(() => ({
   extensionIdsToRender: [],
 }));
 
-export const useExtension = jest.fn(() => [React.createRef(), undefined]);
-
-export const getCurrentPatient = jest.fn(() =>
-  jest.fn().mockReturnValue(never())
-);
-
-export function getCurrentUser() {
-  return of({ authenticated: false });
-}
-
-export const navigate = jest.fn();
-
-export const interpolateString = jest.fn();
-
-export const getCurrentPatientUuid = jest.fn();
-
-export const newWorkspaceItem = jest.fn();
-
-export const fhirBaseUrl = "/ws/fhir2/R4";
-
-export const ExtensionSlot = ({ children }) => <>{children}</>;
-
-export const Extension = jest.fn().mockImplementation((props: any) => <slot />);
-
-export const ConfigurableLink = jest
-  .fn()
-  .mockImplementation((config: { to: string; children: React.ReactNode }) => (
-    <a href={interpolateString(config.to)}>{config.children}</a>
-  ));
-
-export const getExtensionStore = () =>
-  getGlobalStore("extensions", { slots: {} });
-
-export const getExtensionInternalStore = () =>
-  getGlobalStore("extensions-internal", {
-    slots: {},
-    extensions: {},
-  });
-
-export const ComponentContext = React.createContext(null);
-
-export const openmrsComponentDecorator = jest
-  .fn()
-  .mockImplementation(() => (component) => component);
-
 export const UserHasAccess = jest.fn().mockImplementation((props: any) => {
   return props.children;
 });
@@ -223,32 +234,16 @@ export const createUseStore = (store: Store<any>) => (actions) => {
   return { ...state, ...actions };
 };
 
-export const useExtensionInternalStore = createUseStore(
-  getExtensionInternalStore()
-);
-
-export const useExtensionStore = createUseStore(getExtensionStore());
+export const useExtensionStore = (actions) => {
+  const state = extensionStore.getState();
+  return { ...state, ...actions };
+};
 
 export const useStore = (store: Store<any>, actions) => {
   const state = store.getState();
   return { ...state, ...actions };
 };
 
-export const showNotification = jest.fn();
-export const showToast = jest.fn();
-
-export function setupPaths(config: any) {
-  window.openmrsBase = config.apiUrl;
-  window.spaBase = config.spaPath;
-  window.spaEnv = config.env || "production";
-  window.spaVersion = process.env.BUILD_VERSION;
-  window.getOpenmrsSpaBase = () => `${window.spaBase}/`;
-}
-
-export const attach = jest.fn();
-export const detach = jest.fn();
-export const detachAll = jest.fn();
-
 export const usePagination = jest.fn().mockImplementation(() => ({
   currentPage: 1,
   goTo: () => {},
@@ -257,27 +252,7 @@ export const usePagination = jest.fn().mockImplementation(() => ({
 
 export const useVisitTypes = jest.fn(() => []);
 
-export const formatDate = jest.fn((date: Date, mode) => {
-  if (!mode || mode == "standard") {
-    return dayjs(date).format("DD-MMM-YYYY");
-  }
-  if (mode == "wide") {
-    return dayjs(date).format("DD - MMM - YYYY");
-  }
-  if (mode == "no day") {
-    return dayjs(date).format("MMM YYYY");
-  }
-  if (mode == "no year") {
-    return dayjs(date).format("DD MMM");
-  }
-  console.warn("Unknown formatDate mode: ", mode);
-  return dayjs(date).format("DD-MMM-YYYY");
-});
-
-export const formatTime = jest.fn((date: Date) => {
-  return dayjs(date).format("HH:mm");
-});
+/* esm-styleguide */
 
-export const formatDatetime = jest.fn((date: Date, mode) => {
-  return formatDate(date, mode) + " " + formatTime(date);
-});
+export const showNotification = jest.fn();
+export const showToast = jest.fn();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "3.1.15-pre.752",
+  "version": "3.1.15-pre.761",
   "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.1.15-pre.752",
-    "@openmrs/esm-breadcrumbs": "^3.1.15-pre.752",
-    "@openmrs/esm-config": "^3.1.15-pre.752",
-    "@openmrs/esm-error-handling": "^3.1.15-pre.752",
-    "@openmrs/esm-extensions": "^3.1.15-pre.752",
-    "@openmrs/esm-globals": "^3.1.15-pre.752",
-    "@openmrs/esm-offline": "^3.1.15-pre.752",
-    "@openmrs/esm-react-utils": "^3.1.15-pre.752",
-    "@openmrs/esm-state": "^3.1.15-pre.752",
-    "@openmrs/esm-styleguide": "^3.1.15-pre.752",
-    "@openmrs/esm-utils": "^3.1.15-pre.752",
+    "@openmrs/esm-api": "^3.1.15-pre.761",
+    "@openmrs/esm-breadcrumbs": "^3.1.15-pre.761",
+    "@openmrs/esm-config": "^3.1.15-pre.761",
+    "@openmrs/esm-error-handling": "^3.1.15-pre.761",
+    "@openmrs/esm-extensions": "^3.1.15-pre.761",
+    "@openmrs/esm-globals": "^3.1.15-pre.761",
+    "@openmrs/esm-offline": "^3.1.15-pre.761",
+    "@openmrs/esm-react-utils": "^3.1.15-pre.761",
+    "@openmrs/esm-state": "^3.1.15-pre.761",
+    "@openmrs/esm-styleguide": "^3.1.15-pre.761",
+    "@openmrs/esm-utils": "^3.1.15-pre.761",
     "dayjs": "^1.10.7"
   },
-  "gitHead": "c0944ed45eaf5b0aa1c0f9f9da63da07a31edbf3"
+  "gitHead": "92dcde2d52edfb326b99f985cdec3700a0420add"
 }

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

@@ -2,9 +2,12 @@ import React from "react";
 import {
   attach,
   registerExtension,
-  updateInternalExtensionStore,
+  registerExtensionSlot,
+  updateExtensionStore,
+  ExtensionStore,
 } from "../../../esm-extensions";
 import {
+  Extension,
   ExtensionSlot,
   getSyncLifecycle,
   openmrsComponentDecorator,
@@ -15,7 +18,7 @@ import { render, screen, waitFor } from "@testing-library/react";
 
 describe("Interaction between configuration and extension systems", () => {
   beforeEach(() => {
-    updateInternalExtensionStore(() => ({ slots: {}, extensions: {} }));
+    updateExtensionStore(() => ({ slots: {}, extensions: {} }));
   });
 
   test("Config should add, order, and remove extensions within slots", async () => {
@@ -23,6 +26,7 @@ describe("Interaction between configuration and extension systems", () => {
     registerSimpleExtension("Wilma", "esm-flintstone");
     registerSimpleExtension("Barney", "esm-rubble");
     registerSimpleExtension("Betty", "esm-rubble");
+    registerExtensionSlot("esm-flintstone", "A slot");
     attach("A slot", "Fred");
     attach("A slot", "Wilma");
     defineConfigSchema("esm-flintstone", {});
@@ -54,6 +58,8 @@ describe("Interaction between configuration and extension systems", () => {
 
   test("Extensions should recieve config from module and from 'configure' key", async () => {
     registerSimpleExtension("Wilma", "esm-flintstone", true);
+    registerExtensionSlot("esm-flintstone", "Flintstone slot");
+    registerExtensionSlot("esm-flintstone", "Future slot");
     defineConfigSchema("esm-flintstone", {
       town: { _type: Type.String, _default: "Bedrock" },
     });
@@ -99,6 +105,7 @@ describe("Interaction between configuration and extension systems", () => {
 
   test("Should be possible to attach the same extension twice with different configurations", async () => {
     registerSimpleExtension("pet", "esm-characters", true);
+    registerExtensionSlot("esm-flintstone", "Flintstone slot");
     defineConfigSchema("esm-characters", {
       name: { _type: Type.String, _default: "(no-name)" },
     });
@@ -154,8 +161,7 @@ function registerSimpleExtension(
       </div>
     );
   };
-  registerExtension({
-    name,
+  registerExtension(name, {
     moduleName,
     load: getSyncLifecycle(
       takesConfig ? ConfigurableComponent : SimpleComponent,

package/src/mock-test.test.ts

@@ -0,0 +1,17 @@
+/**
+ * A test that validates that `@openmrs/esm-framework/mock` has
+ * the same API as `@openmrs/esm-framework`.
+ *
+ * Disabled because the mock is nowhere close to having the same
+ * API. You can change `xit` to `it` to run the test and see a
+ * comparison of the exports of the two modules.
+ */
+
+import * as real from "./index";
+import * as mock from "../mock";
+
+describe("@openmrs/esm-framework/mock", () => {
+  xit("should have the same exports as @openmrs/esm-framework", () => {
+    expect(new Set(Object.keys(real))).toEqual(new Set(Object.keys(mock)));
+  });
+});

package/docs/interfaces/AssignedExtension.md

@@ -1,63 +0,0 @@
-[@openmrs/esm-framework](../API.md) / AssignedExtension
-
-# Interface: AssignedExtension
-
-## Table of contents
-
-### Properties
-
-- [id](AssignedExtension.md#id)
-- [meta](AssignedExtension.md#meta)
-- [name](AssignedExtension.md#name)
-- [offline](AssignedExtension.md#offline)
-- [online](AssignedExtension.md#online)
-
-## Properties
-
-### id
-
-• **id**: `string`
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L71)
-
-___
-
-### meta
-
-• **meta**: [`ExtensionMeta`](ExtensionMeta.md)
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:73](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L73)
-
-___
-
-### name
-
-• **name**: `string`
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:72](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L72)
-
-___
-
-### offline
-
-• `Optional` **offline**: `boolean` \| `object`
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:75](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L75)
-
-___
-
-### online
-
-• `Optional` **online**: `boolean` \| `object`
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:74](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L74)

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)

package/docs/interfaces/ExtensionSlotState.md

@@ -1,30 +0,0 @@
-[@openmrs/esm-framework](../API.md) / ExtensionSlotState
-
-# Interface: ExtensionSlotState
-
-## Table of contents
-
-### Properties
-
-- [assignedExtensions](ExtensionSlotState.md#assignedextensions)
-- [moduleName](ExtensionSlotState.md#modulename)
-
-## Properties
-
-### assignedExtensions
-
-• **assignedExtensions**: [`AssignedExtension`](AssignedExtension.md)[]
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L67)
-
-___
-
-### moduleName
-
-• **moduleName**: `string`
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L66)