@openmrs/esm-framework 3.1.10-pre.92 → 3.1.11-pre.597

package/docs/interfaces/User.md

@@ -0,0 +1,107 @@
+[@openmrs/esm-framework](../API.md) / User
+
+# Interface: User
+
+## Table of contents
+
+### Properties
+
+- [display](User.md#display)
+- [link](User.md#link)
+- [persion](User.md#persion)
+- [priviliges](User.md#priviliges)
+- [resourceVersion](User.md#resourceversion)
+- [roles](User.md#roles)
+- [userProperties](User.md#userproperties)
+- [username](User.md#username)
+- [uuid](User.md#uuid)
+
+## Properties
+
+### display
+
+• **display**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L18)
+
+___
+
+### link
+
+• **link**: `string`[]
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L19)
+
+___
+
+### persion
+
+• **persion**: `any`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L20)
+
+___
+
+### priviliges
+
+• **priviliges**: `any`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L21)
+
+___
+
+### resourceVersion
+
+• **resourceVersion**: `any`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L22)
+
+___
+
+### roles
+
+• **roles**: `any`[]
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L23)
+
+___
+
+### userProperties
+
+• **userProperties**: `any`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L24)
+
+___
+
+### username
+
+• **username**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L25)
+
+___
+
+### uuid
+
+• **uuid**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/openmrs-resource.ts:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/openmrs-resource.ts#L26)

package/docs/interfaces/UserHasAccessProps.md

@@ -0,0 +1,19 @@
+[@openmrs/esm-framework](../API.md) / UserHasAccessProps
+
+# Interface: UserHasAccessProps
+
+## Table of contents
+
+### Properties
+
+- [privilege](UserHasAccessProps.md#privilege)
+
+## Properties
+
+### privilege
+
+• **privilege**: `string`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/UserHasAccess.tsx:5](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-react-utils/src/UserHasAccess.tsx#L5)

package/docs/interfaces/Visit.md

@@ -0,0 +1,111 @@
+[@openmrs/esm-framework](../API.md) / Visit
+
+# Interface: Visit
+
+## Indexable
+
+▪ [anythingElse: `string`]: `any`
+
+## Table of contents
+
+### Properties
+
+- [attributes](Visit.md#attributes)
+- [display](Visit.md#display)
+- [encounters](Visit.md#encounters)
+- [location](Visit.md#location)
+- [patient](Visit.md#patient)
+- [startDatetime](Visit.md#startdatetime)
+- [stopDatetime](Visit.md#stopdatetime)
+- [uuid](Visit.md#uuid)
+- [visitType](Visit.md#visittype)
+
+## Properties
+
+### attributes
+
+• `Optional` **attributes**: [`OpenmrsResource`](OpenmrsResource.md)[]
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L23)
+
+___
+
+### display
+
+• `Optional` **display**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L16)
+
+___
+
+### encounters
+
+• **encounters**: [`OpenmrsResource`](OpenmrsResource.md)[]
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L17)
+
+___
+
+### location
+
+• `Optional` **location**: [`Location`](Location.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:20](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L20)
+
+___
+
+### patient
+
+• `Optional` **patient**: [`OpenmrsResource`](OpenmrsResource.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L18)
+
+___
+
+### startDatetime
+
+• **startDatetime**: `Date`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L21)
+
+___
+
+### stopDatetime
+
+• `Optional` **stopDatetime**: `Date`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L22)
+
+___
+
+### uuid
+
+• **uuid**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L15)
+
+___
+
+### visitType
+
+• **visitType**: [`VisitType`](VisitType.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L19)

package/docs/interfaces/VisitItem.md

@@ -0,0 +1,52 @@
+[@openmrs/esm-framework](../API.md) / VisitItem
+
+# Interface: VisitItem
+
+## Table of contents
+
+### Properties
+
+- [anythingElse](VisitItem.md#anythingelse)
+- [mode](VisitItem.md#mode)
+- [status](VisitItem.md#status)
+- [visitData](VisitItem.md#visitdata)
+
+## Properties
+
+### anythingElse
+
+• `Optional` **anythingElse**: `any`
+
+#### Defined in
+
+[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:90](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L90)
+
+___
+
+### mode
+
+• **mode**: [`VisitMode`](../enums/VisitMode.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:87](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L87)
+
+___
+
+### status
+
+• **status**: [`VisitStatus`](../enums/VisitStatus.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:89](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L89)
+
+___
+
+### visitData
+
+• `Optional` **visitData**: [`Visit`](Visit.md)
+
+#### Defined in
+
+[packages/framework/esm-api/src/shared-api-objects/visit-utils.ts:88](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/shared-api-objects/visit-utils.ts#L88)

package/docs/interfaces/VisitType.md

@@ -0,0 +1,41 @@
+[@openmrs/esm-framework](../API.md) / VisitType
+
+# Interface: VisitType
+
+## Table of contents
+
+### Properties
+
+- [display](VisitType.md#display)
+- [name](VisitType.md#name)
+- [uuid](VisitType.md#uuid)
+
+## Properties
+
+### display
+
+• **display**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L35)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:36](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L36)
+
+___
+
+### uuid
+
+• **uuid**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/types/visit-resource.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/types/visit-resource.ts#L34)

package/docs/interfaces/WorkspaceItem.md

@@ -0,0 +1,74 @@
+[@openmrs/esm-framework](../API.md) / WorkspaceItem
+
+# Interface: WorkspaceItem
+
+## Table of contents
+
+### Properties
+
+- [component](WorkspaceItem.md#component)
+- [componentClosed](WorkspaceItem.md#componentclosed)
+- [inProgress](WorkspaceItem.md#inprogress)
+- [name](WorkspaceItem.md#name)
+- [props](WorkspaceItem.md#props)
+- [validations](WorkspaceItem.md#validations)
+
+## Properties
+
+### component
+
+• **component**: `any`
+
+#### Defined in
+
+[packages/framework/esm-api/src/workspace/workspace.resource.tsx:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L24)
+
+___
+
+### componentClosed
+
+• `Optional` **componentClosed**: `Function`
+
+#### Defined in
+
+[packages/framework/esm-api/src/workspace/workspace.resource.tsx:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L29)
+
+___
+
+### inProgress
+
+• **inProgress**: `boolean`
+
+#### Defined in
+
+[packages/framework/esm-api/src/workspace/workspace.resource.tsx:28](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L28)
+
+___
+
+### name
+
+• **name**: `string`
+
+#### Defined in
+
+[packages/framework/esm-api/src/workspace/workspace.resource.tsx:25](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L25)
+
+___
+
+### props
+
+• **props**: `any`
+
+#### Defined in
+
+[packages/framework/esm-api/src/workspace/workspace.resource.tsx:26](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L26)
+
+___
+
+### validations
+
+• `Optional` **validations**: `Function`
+
+#### Defined in
+
+[packages/framework/esm-api/src/workspace/workspace.resource.tsx:27](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-api/src/workspace/workspace.resource.tsx#L27)

package/mock.tsx

@@ -0,0 +1,253 @@
+import React from "react";
+import type {} from "@openmrs/esm-globals";
+import createStore, { Store } from "unistore";
+import { never, of } from "rxjs";
+
+interface StoreEntity {
+  value: Store<any>;
+  active: boolean;
+}
+
+export type MockedStore<T> = Store<T> & { resetMock: () => void };
+
+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>(
+  name: string,
+  initialState: TState
+): Store<TState> {
+  const available = availableStores[name];
+
+  if (available) {
+    if (available.active) {
+      console.error(
+        "Cannot override an existing store. Make sure that stores are only created once."
+      );
+    } else {
+      available.value.setState(initialState, true);
+    }
+
+    available.active = true;
+    return available.value;
+  } else {
+    const store = createStore(initialState);
+    initialStates[name] = initialState;
+
+    availableStores[name] = {
+      value: store,
+      active: true,
+    };
+
+    return instrumentedStore(name, store);
+  }
+}
+
+export function getGlobalStore<TState = any>(
+  name: string,
+  fallbackState?: TState
+): Store<TState> {
+  const available = availableStores[name];
+
+  if (!available) {
+    const store = createStore(fallbackState);
+    initialStates[name] = fallbackState;
+    availableStores[name] = {
+      value: store,
+      active: false,
+    };
+    return instrumentedStore(name, store);
+  }
+
+  return instrumentedStore(name, available.value);
+}
+
+function instrumentedStore<T>(name: string, store: Store<T>) {
+  return {
+    action: jest.spyOn(store, "action"),
+    getState: jest.spyOn(store, "getState"),
+    setState: jest.spyOn(store, "setState"),
+    subscribe: jest.spyOn(store, "subscribe"),
+    unsubscribe: jest.spyOn(store, "unsubscribe"),
+    resetMock: () => store.setState(initialStates[name]),
+  } as any as MockedStore<T>;
+}
+
+export const configInternalStore = createGlobalStore("config-internal", {
+  devDefaultsAreOn: false,
+});
+
+export const implementerToolsConfigStore = createGlobalStore(
+  "implementer-tools-config",
+  {}
+);
+
+export const temporaryConfigStore = createGlobalStore("temporary-config", {});
+
+export enum Type {
+  Array = "Array",
+  Boolean = "Boolean",
+  ConceptUuid = "ConceptUuid",
+  Number = "Number",
+  Object = "Object",
+  String = "String",
+  UUID = "UUID",
+}
+
+export const validators = {
+  isBoolean: jest.fn(),
+  isString: jest.fn(),
+  isUuid: jest.fn(),
+  isObject: jest.fn(),
+};
+
+let configSchema = {};
+function getDefaults(schema) {
+  let tmp = {};
+  for (let k of Object.keys(schema)) {
+    if (schema[k].hasOwnProperty("_default")) {
+      tmp[k] = schema[k]._default;
+    } else if (k.startsWith("_")) {
+      continue;
+    } else if (isOrdinaryObject(schema[k])) {
+      tmp[k] = getDefaults(schema[k]);
+    } else {
+      tmp[k] = schema[k];
+    }
+  }
+  return tmp;
+}
+function isOrdinaryObject(x) {
+  return !!x && x.constructor === Object;
+}
+
+export const getConfig = jest.fn().mockReturnValue(getDefaults(configSchema));
+
+export const useConfig = jest.fn().mockReturnValue(getDefaults(configSchema));
+
+export function defineConfigSchema(moduleName, schema) {
+  configSchema = schema;
+}
+
+export const createErrorHandler = () => jest.fn().mockReturnValue(never());
+
+export const reportError = jest.fn().mockImplementation((error) => {
+  throw error;
+});
+
+export const switchTo = jest.fn();
+
+export const UserHasAccessReact = (props: any) => props.children;
+
+export const openmrsFetch = jest.fn(() => new Promise(() => {}));
+
+export const openmrsObservableFetch = jest.fn(() =>
+  of({ data: { entry: [] } })
+);
+
+export const setIsUIEditorEnabled = (boolean): void => {};
+
+export const useCurrentPatient = jest.fn(() => [null, null, null, null]);
+
+export const useSessionUser = jest.fn(() => null);
+
+export const useLayoutType = jest.fn(() => "desktop");
+
+export const useExtensionSlot = jest.fn(() => ({
+  extensionSlotModuleName: "",
+  attachedExtensionSlotName: "",
+  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;
+});
+
+export const createUseStore = (store: Store<any>) => (actions) => {
+  const state = store.getState();
+  return { ...state, ...actions };
+};
+
+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();