@openmrs/esm-framework 4.3.2-pre.680 → 4.4.0

package/docs/API.md

@@ -515,7 +515,7 @@ ___
 
 #### Index signature
 
-▪ [key: `string`]: `BoundAction`
+▪ [key: `string`]: (...`args`: `any`[]) => `void`
 
 #### Defined in
 
@@ -906,11 +906,11 @@ ___
 
 ### getSessionStore
 
-▸ **getSessionStore**(): `Store`<[`SessionStore`](API.md#sessionstore)\>
+▸ **getSessionStore**(): `StoreApi`<[`SessionStore`](API.md#sessionstore)\>
 
 #### Returns
 
-`Store`<[`SessionStore`](API.md#sessionstore)\>
+`StoreApi`<[`SessionStore`](API.md#sessionstore)\>
 
 #### Defined in
 
@@ -2256,19 +2256,18 @@ ___
 
 ### getExtensionStore
 
-▸ **getExtensionStore**(): `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
+▸ **getExtensionStore**(): `StoreApi`<[`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
-extension system.
+This returns a store that modules can use to get information about the
+state of the extension system.
 
 #### Returns
 
-`Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
+`StoreApi`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
 
 #### Defined in
 
-[packages/framework/esm-extensions/src/store.ts:130](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L130)
+[packages/framework/esm-extensions/src/store.ts:129](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/store.ts#L129)
 
 ___
 
@@ -2941,13 +2940,13 @@ ___
 
 ### getOfflinePatientDataStore
 
-▸ **getOfflinePatientDataStore**(): `Store`<[`OfflinePatientDataSyncStore`](interfaces/OfflinePatientDataSyncStore.md)\>
+▸ **getOfflinePatientDataStore**(): `StoreApi`<[`OfflinePatientDataSyncStore`](interfaces/OfflinePatientDataSyncStore.md)\>
 
 **`deprecated`** Will be removed once all modules have been migrated to the new dynamic offline data API.
 
 #### Returns
 
-`Store`<[`OfflinePatientDataSyncStore`](interfaces/OfflinePatientDataSyncStore.md)\>
+`StoreApi`<[`OfflinePatientDataSyncStore`](interfaces/OfflinePatientDataSyncStore.md)\>
 
 #### Defined in
 
@@ -3478,26 +3477,26 @@ ___
 
 ### createGlobalStore
 
-▸ **createGlobalStore**<`TState`\>(`name`, `initialState`): `Store`<`TState`\>
+▸ **createGlobalStore**<`T`\>(`name`, `initialState`): `StoreApi`<`T`\>
 
-Creates a Unistore [store](https://github.com/developit/unistore#store).
+Creates a Zustand store.
 
 #### Type parameters
 
 | Name |
 | :------ |
-| `TState` |
+| `T` |
 
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `name` | `string` | A name by which the store can be looked up later.    Must be unique across the entire application. |
-| `initialState` | `TState` | An object which will be the initial state of the store. |
+| `initialState` | `T` | An object which will be the initial state of the store. |
 
 #### Returns
 
-`Store`<`TState`\>
+`StoreApi`<`T`\>
 
 The newly created store.
 
@@ -3523,7 +3522,7 @@ Avoid this; generally prefer to have clients use `useStore(yourStore)`
 
 | Name | Type |
 | :------ | :------ |
-| `store` | `Store`<`T`\> |
+| `store` | `StoreApi`<`T`\> |
 
 #### Returns
 
@@ -3561,17 +3560,17 @@ Avoid this; generally prefer to have clients use `useStore(yourStore)`
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/createUseStore.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/createUseStore.ts#L23)
+[packages/framework/esm-react-utils/src/createUseStore.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/createUseStore.ts#L33)
 
 ___
 
 ### getAppState
 
-▸ **getAppState**(): `Store`<[`AppState`](interfaces/AppState.md)\>
+▸ **getAppState**(): `StoreApi`<[`AppState`](interfaces/AppState.md)\>
 
 #### Returns
 
-`Store`<[`AppState`](interfaces/AppState.md)\>
+`StoreApi`<[`AppState`](interfaces/AppState.md)\>
 
 The [store](https://github.com/developit/unistore#store) named `app`.
 
@@ -3583,27 +3582,27 @@ ___
 
 ### getGlobalStore
 
-▸ **getGlobalStore**<`TState`\>(`name`, `fallbackState?`): `Store`<`TState`\>
+▸ **getGlobalStore**<`T`\>(`name`, `fallbackState?`): `StoreApi`<`T`\>
 
-Returns the existing [store](https://github.com/developit/unistore#store) named `name`,
+Returns the existing store named `name`,
 or creates a new store named `name` if none exists.
 
 #### Type parameters
 
-| Name | Type |
-| :------ | :------ |
-| `TState` | `any` |
+| Name |
+| :------ |
+| `T` |
 
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `name` | `string` | The name of the store to look up. |
-| `fallbackState?` | `TState` | The initial value of the new store if no store named `name` exists. |
+| `fallbackState?` | `T` | The initial value of the new store if no store named `name` exists. |
 
 #### Returns
 
-`Store`<`TState`\>
+`StoreApi`<`T`\>
 
 The found or newly created store.
 
@@ -3615,7 +3614,7 @@ ___
 
 ### subscribeTo
 
-▸ **subscribeTo**<`T`, `U`\>(`store`, `select`, `handle`): `Unsubscribe`
+▸ **subscribeTo**<`T`, `U`\>(`store`, `select`, `handle`): () => `void`
 
 #### Type parameters
 
@@ -3628,13 +3627,19 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `store` | `Store`<`T`\> |
+| `store` | `StoreApi`<`T`\> |
 | `select` | (`state`: `T`) => `U` |
 | `handle` | (`subState`: `U`) => `void` |
 
 #### Returns
 
-`Unsubscribe`
+`fn`
+
+▸ (): `void`
+
+##### Returns
+
+`void`
 
 #### Defined in
 
@@ -3657,7 +3662,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `store` | `Store`<`T`\> |
+| `store` | `StoreApi`<`T`\> |
 
 #### Returns
 
@@ -3665,7 +3670,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/useStore.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L23)
+[packages/framework/esm-react-utils/src/useStore.ts:33](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L33)
 
 ▸ **useStore**<`T`, `U`\>(`store`, `select`): `U`
 
@@ -3680,7 +3685,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `store` | `Store`<`T`\> |
+| `store` | `StoreApi`<`T`\> |
 | `select` | (`state`: `T`) => `U` |
 
 #### Returns
@@ -3689,7 +3694,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/useStore.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L24)
+[packages/framework/esm-react-utils/src/useStore.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L34)
 
 ▸ **useStore**<`T`, `U`\>(`store`, `select`, `actions`): `T` & [`BoundActions`](API.md#boundactions)
 
@@ -3704,7 +3709,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `store` | `Store`<`T`\> |
+| `store` | `StoreApi`<`T`\> |
 | `select` | `undefined` |
 | `actions` | [`Actions`](API.md#actions) |
 
@@ -3714,7 +3719,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/useStore.ts:25](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L25)
+[packages/framework/esm-react-utils/src/useStore.ts:35](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L35)
 
 ▸ **useStore**<`T`, `U`\>(`store`, `select`, `actions`): `U` & [`BoundActions`](API.md#boundactions)
 
@@ -3729,7 +3734,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `store` | `Store`<`T`\> |
+| `store` | `StoreApi`<`T`\> |
 | `select` | (`state`: `T`) => `U` |
 | `actions` | [`Actions`](API.md#actions) |
 
@@ -3739,7 +3744,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/useStore.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L30)
+[packages/framework/esm-react-utils/src/useStore.ts:40](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L40)
 
 ___
 
@@ -3757,7 +3762,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `store` | `Store`<`T`\> |
+| `store` | `StoreApi`<`T`\> |
 | `actions` | [`Actions`](API.md#actions) |
 
 #### Returns
@@ -3766,7 +3771,7 @@ ___
 
 #### Defined in
 
-[packages/framework/esm-react-utils/src/useStore.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L52)
+[packages/framework/esm-react-utils/src/useStore.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useStore.ts#L61)
 
 ___
 

package/mock.tsx

@@ -1,6 +1,6 @@
 import React from "react";
 import type {} from "@openmrs/esm-globals";
-import createStore, { Store } from "unistore";
+import { createStore, StoreApi } from "zustand";
 import { never, of } from "rxjs";
 import { interpolateUrl } from "@openmrs/esm-config";
 import { SessionStore } from "@openmrs/esm-api";
@@ -73,18 +73,20 @@ export const fhirBaseUrl = "/ws/fhir2/R4";
 
 /* esm-state */
 interface StoreEntity {
-  value: Store<any>;
+  value: StoreApi<any>;
   active: boolean;
 }
 
-export type MockedStore<T> = Store<T> & { resetMock: () => void };
+export type MockedStore<T> = StoreApi<T> & {
+  resetMock: () => void;
+};
 
 export const mockStores = availableStores;
 
-export function createGlobalStore<TState>(
+export function createGlobalStore<T>(
   name: string,
-  initialState: TState
-): Store<TState> {
+  initialState: T
+): StoreApi<T> {
   const available = availableStores[name];
 
   if (available) {
@@ -99,7 +101,7 @@ export function createGlobalStore<TState>(
     available.active = true;
     return available.value;
   } else {
-    const store = createStore(initialState);
+    const store = createStore<T>()(() => initialState);
     initialStates[name] = initialState;
 
     availableStores[name] = {
@@ -111,14 +113,14 @@ export function createGlobalStore<TState>(
   }
 }
 
-export function getGlobalStore<TState = any>(
+export function getGlobalStore<T>(
   name: string,
-  fallbackState?: TState
-): Store<TState> {
+  fallbackState?: T
+): StoreApi<T> {
   const available = availableStores[name];
 
   if (!available) {
-    const store = createStore(fallbackState);
+    const store = createStore<T>()(() => fallbackState ?? ({} as unknown as T));
     initialStates[name] = fallbackState;
     availableStores[name] = {
       value: store,
@@ -130,13 +132,11 @@ export function getGlobalStore<TState = any>(
   return instrumentedStore(name, available.value);
 }
 
-function instrumentedStore<T>(name: string, store: Store<T>) {
+function instrumentedStore<T>(name: string, store: StoreApi<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>;
 }
@@ -261,20 +261,16 @@ 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 useExtensionInternalStore = createUseStore(
+export const useExtensionInternalStore = createGlobalStore(
+  "extensionInternal",
   getExtensionInternalStore()
 );
 
-export const useExtensionStore = createUseStore(getExtensionStore());
+export const useExtensionStore = getExtensionStore();
 
 const defaultSelect = (x) => x;
 export const useStore = (
-  store: Store<any>,
+  store: StoreApi<any>,
   select = defaultSelect,
   actions = {}
 ) => {
@@ -282,10 +278,12 @@ export const useStore = (
   return { ...state, ...actions };
 };
 
-export const useStoreWithActions = (store: Store<any>, actions) => {
-  const state = store.getState();
-  return { ...state, ...actions };
-};
+export function useStoreWithActions<T>(
+  store: StoreApi<T>,
+  actions: Function | { [key: string]: Function }
+): T & { [key: string]: (...args: any[]) => void } {
+  return useStore(store, defaultSelect, actions);
+}
 
 export const usePagination = jest.fn().mockImplementation(() => ({
   currentPage: 1,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "4.3.2-pre.680",
+  "version": "4.4.0",
   "license": "MPL-2.0",
   "browser": "dist/openmrs-esm-framework.js",
   "main": "src/index.ts",
@@ -35,17 +35,17 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "^4.3.2-pre.680",
-    "@openmrs/esm-breadcrumbs": "^4.3.2-pre.680",
-    "@openmrs/esm-config": "^4.3.2-pre.680",
-    "@openmrs/esm-error-handling": "^4.3.2-pre.680",
-    "@openmrs/esm-extensions": "^4.3.2-pre.680",
-    "@openmrs/esm-globals": "^4.3.2-pre.680",
-    "@openmrs/esm-offline": "^4.3.2-pre.680",
-    "@openmrs/esm-react-utils": "^4.3.2-pre.680",
-    "@openmrs/esm-state": "^4.3.2-pre.680",
-    "@openmrs/esm-styleguide": "^4.3.2-pre.680",
-    "@openmrs/esm-utils": "^4.3.2-pre.680",
+    "@openmrs/esm-api": "^4.4.0",
+    "@openmrs/esm-breadcrumbs": "^4.4.0",
+    "@openmrs/esm-config": "^4.4.0",
+    "@openmrs/esm-error-handling": "^4.4.0",
+    "@openmrs/esm-extensions": "^4.4.0",
+    "@openmrs/esm-globals": "^4.4.0",
+    "@openmrs/esm-offline": "^4.4.0",
+    "@openmrs/esm-react-utils": "^4.4.0",
+    "@openmrs/esm-state": "^4.4.0",
+    "@openmrs/esm-styleguide": "^4.4.0",
+    "@openmrs/esm-utils": "^4.4.0",
     "dayjs": "^1.10.7"
   },
   "devDependencies": {
@@ -53,5 +53,5 @@
     "jest-cli": "28.1.0",
     "jest-environment-jsdom": "28.1.0"
   },
-  "gitHead": "924a6261edaf89142bee78049ff388ef36b097ff"
+  "gitHead": "fdaefeded76bee4ec6503ca6590737e89ebe4b26"
 }