@openmrs/esm-framework 3.1.15-pre.749 → 3.1.15-pre.757

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,51 @@ 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 getExtensionStore = () =>
+  getGlobalStore("extensions", { slots: {} });
+
+export const getExtensionInternalStore = () =>
+  getGlobalStore("extensions-internal", {
+    slots: {},
+    extensions: {},
+  });
+
+/* 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,56 +232,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>
-  ));
-
-let state = { slots: {}, extensions: {} };
-
-export const extensionStore = {
-  getState: () => state,
-  setState: (val) => {
-    state = { ...state, ...val };
-  },
-  subscribe: (updateFcn) => {
-    updateFcn(state);
-    return () => {};
-  },
-  unsubscribe: () => {},
-};
-
-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;
 });
@@ -228,31 +241,17 @@ export const createUseStore = (store: Store<any>) => (actions) => {
   return { ...state, ...actions };
 };
 
-export const useExtensionStore = (actions) => {
-  const state = extensionStore.getState();
-  return { ...state, ...actions };
-};
+export const useExtensionInternalStore = createUseStore(
+  getExtensionInternalStore()
+);
+
+export const useExtensionStore = createUseStore(getExtensionStore());
 
 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: () => {},
@@ -261,27 +260,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.749",
+  "version": "3.1.15-pre.757",
   "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.749",
-    "@openmrs/esm-breadcrumbs": "^3.1.15-pre.749",
-    "@openmrs/esm-config": "^3.1.15-pre.749",
-    "@openmrs/esm-error-handling": "^3.1.15-pre.749",
-    "@openmrs/esm-extensions": "^3.1.15-pre.749",
-    "@openmrs/esm-globals": "^3.1.15-pre.749",
-    "@openmrs/esm-offline": "^3.1.15-pre.749",
-    "@openmrs/esm-react-utils": "^3.1.15-pre.749",
-    "@openmrs/esm-state": "^3.1.15-pre.749",
-    "@openmrs/esm-styleguide": "^3.1.15-pre.749",
-    "@openmrs/esm-utils": "^3.1.15-pre.749",
+    "@openmrs/esm-api": "^3.1.15-pre.757",
+    "@openmrs/esm-breadcrumbs": "^3.1.15-pre.757",
+    "@openmrs/esm-config": "^3.1.15-pre.757",
+    "@openmrs/esm-error-handling": "^3.1.15-pre.757",
+    "@openmrs/esm-extensions": "^3.1.15-pre.757",
+    "@openmrs/esm-globals": "^3.1.15-pre.757",
+    "@openmrs/esm-offline": "^3.1.15-pre.757",
+    "@openmrs/esm-react-utils": "^3.1.15-pre.757",
+    "@openmrs/esm-state": "^3.1.15-pre.757",
+    "@openmrs/esm-styleguide": "^3.1.15-pre.757",
+    "@openmrs/esm-utils": "^3.1.15-pre.757",
     "dayjs": "^1.10.7"
   },
-  "gitHead": "110be85fd4162b3c89f51898a8f5913bec0b15ba"
+  "gitHead": "9b005ddcbb5f1f0412081c7c85b5afbe4477b17e"
 }

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

@@ -2,12 +2,9 @@ import React from "react";
 import {
   attach,
   registerExtension,
-  registerExtensionSlot,
-  updateExtensionStore,
-  ExtensionStore,
+  updateInternalExtensionStore,
 } from "../../../esm-extensions";
 import {
-  Extension,
   ExtensionSlot,
   getSyncLifecycle,
   openmrsComponentDecorator,
@@ -18,7 +15,7 @@ import { render, screen, waitFor } from "@testing-library/react";
 
 describe("Interaction between configuration and extension systems", () => {
   beforeEach(() => {
-    updateExtensionStore(() => ({ slots: {}, extensions: {} }));
+    updateInternalExtensionStore(() => ({ slots: {}, extensions: {} }));
   });
 
   test("Config should add, order, and remove extensions within slots", async () => {
@@ -26,7 +23,6 @@ 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", {});
@@ -58,8 +54,6 @@ 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" },
     });
@@ -105,7 +99,6 @@ 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)" },
     });
@@ -161,7 +154,8 @@ 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/ConfigStore.md

@@ -1,34 +0,0 @@
-[@openmrs/esm-framework](../API.md) / ConfigStore
-
-# Interface: ConfigStore
-
-Output configs
-
-Each module has its own stores for its config and its extension slots' configs.
-
-## Table of contents
-
-### Properties
-
-- [config](ConfigStore.md#config)
-- [loaded](ConfigStore.md#loaded)
-
-## Properties
-
-### config
-
-• **config**: ``null`` \| [`ConfigObject`](ConfigObject.md)
-
-#### Defined in
-
-[packages/framework/esm-config/src/module-config/state.ts:125](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L125)
-
-___
-
-### loaded
-
-• **loaded**: `boolean`
-
-#### Defined in
-
-[packages/framework/esm-config/src/module-config/state.ts:126](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L126)

package/docs/interfaces/ExtensionDetails.md

@@ -1,81 +0,0 @@
-[@openmrs/esm-framework](../API.md) / ExtensionDetails
-
-# Interface: ExtensionDetails
-
-## Table of contents
-
-### Properties
-
-- [meta](ExtensionDetails.md#meta)
-- [moduleName](ExtensionDetails.md#modulename)
-- [offline](ExtensionDetails.md#offline)
-- [online](ExtensionDetails.md#online)
-- [order](ExtensionDetails.md#order)
-
-### Methods
-
-- [load](ExtensionDetails.md#load)
-
-## Properties
-
-### meta
-
-• **meta**: `Record`<`string`, `any`\>
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/extensions.ts:56](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L56)
-
-___
-
-### moduleName
-
-• **moduleName**: `string`
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/extensions.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L54)
-
-___
-
-### offline
-
-• `Optional` **offline**: `boolean` \| `object`
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/extensions.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L58)
-
-___
-
-### online
-
-• `Optional` **online**: `boolean` \| `object`
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/extensions.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L57)
-
-___
-
-### order
-
-• `Optional` **order**: `number`
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/extensions.ts:59](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L59)
-
-## Methods
-
-### load
-
-▸ **load**(): `Promise`<`any`\>
-
-#### Returns
-
-`Promise`<`any`\>
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/extensions.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L55)

package/docs/interfaces/ExtensionSlotConfigsStore.md

@@ -1,32 +0,0 @@
-[@openmrs/esm-framework](../API.md) / ExtensionSlotConfigsStore
-
-# Interface: ExtensionSlotConfigsStore
-
-## Table of contents
-
-### Properties
-
-- [extensionSlotConfigs](ExtensionSlotConfigsStore.md#extensionslotconfigs)
-- [loaded](ExtensionSlotConfigsStore.md#loaded)
-
-## Properties
-
-### extensionSlotConfigs
-
-• **extensionSlotConfigs**: `Record`<`string`, [`ExtensionSlotConfigObject`](ExtensionSlotConfigObject.md)\>
-
-Configs for each extension slot in the module, indexed by slot name
-
-#### Defined in
-
-[packages/framework/esm-config/src/module-config/state.ts:146](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L146)
-
-___
-
-### loaded
-
-• **loaded**: `boolean`
-
-#### Defined in
-
-[packages/framework/esm-config/src/module-config/state.ts:147](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L147)

package/docs/interfaces/ExtensionSlotInstance.md

@@ -1,51 +0,0 @@
-[@openmrs/esm-framework](../API.md) / ExtensionSlotInstance
-
-# Interface: ExtensionSlotInstance
-
-## Table of contents
-
-### Properties
-
-- [addedIds](ExtensionSlotInstance.md#addedids)
-- [idOrder](ExtensionSlotInstance.md#idorder)
-- [removedIds](ExtensionSlotInstance.md#removedids)
-
-## Properties
-
-### addedIds
-
-• **addedIds**: `string`[]
-
-A set of additional extension IDs which have been added to to this slot despite not being
-explicitly `attach`ed to it.
-An example may be an extension which is added to the slot via the configuration.
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:47](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L47)
-
-___
-
-### idOrder
-
-• **idOrder**: `string`[]
-
-A set allowing explicit ordering of the `assignedIds`.
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L57)
-
-___
-
-### removedIds
-
-• **removedIds**: `string`[]
-
-A set of extension IDs which have been removed/hidden from this slot, even though they have
-previously been `attach`ed/added to it.
-An example may be an extension which is removed from the slot via the configuration.
-
-#### Defined in
-
-[packages/framework/esm-extensions/src/store.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L53)

package/docs/interfaces/ImplementerToolsConfigStore.md

@@ -1,19 +0,0 @@
-[@openmrs/esm-framework](../API.md) / ImplementerToolsConfigStore
-
-# Interface: ImplementerToolsConfigStore
-
-## Table of contents
-
-### Properties
-
-- [config](ImplementerToolsConfigStore.md#config)
-
-## Properties
-
-### config
-
-• **config**: [`Config`](Config.md)
-
-#### Defined in
-
-[packages/framework/esm-config/src/module-config/state.ts:179](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-config/src/module-config/state.ts#L179)