@openmrs/esm-state 9.0.3-pre.4216 → 9.0.3-pre.4223

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-[0] Successfully compiled: 4 files with swc (119.62ms)
+[0] Successfully compiled: 4 files with swc (84.64ms)
 [0] swc --strip-leading-paths src -d dist exited with code 0
 [1] tsc --project tsconfig.build.json exited with code 0

package/dist/state.d.ts

@@ -1,13 +1,15 @@
 import type { StoreApi } from 'zustand/vanilla';
+type StorageType = 'none' | 'sessionStorage';
 /**
  * Creates a Zustand store.
  *
  * @param name A name by which the store can be looked up later.
  *    Must be unique across the entire application.
+ * @param storageType The type of storage to use for persisting the store's state. Defaults to 'none'.
  * @param initialState An object which will be the initial state of the store.
  * @returns The newly created store.
  */
-export declare function createGlobalStore<T>(name: string, initialState: T): StoreApi<T>;
+export declare function createGlobalStore<T>(name: string, initialState: T, storageType?: StorageType): StoreApi<T>;
 /**
  * Registers an existing Zustand store.
  *
@@ -23,9 +25,10 @@ export declare function registerGlobalStore<T>(name: string, store: StoreApi<T>)
  *
  * @param name The name of the store to look up.
  * @param fallbackState The initial value of the new store if no store named `name` exists.
+ * @param fallbackStorageType The type of storage to use for the new store if no store named `name` exists. Defaults to 'none'.
  * @returns The found or newly created store.
  */
-export declare function getGlobalStore<T>(name: string, fallbackState?: T): StoreApi<T>;
+export declare function getGlobalStore<T>(name: string, fallbackState?: T, fallbackStorageType?: StorageType): StoreApi<T>;
 /**
  * Subscribes to a store and invokes a callback when the state changes.
  * The callback is also immediately invoked with the current state upon subscription.
@@ -42,4 +45,5 @@ export declare function getGlobalStore<T>(name: string, fallbackState?: T): Stor
  */
 export declare function subscribeTo<T, U = T>(store: StoreApi<T>, handle: (state: T) => void): () => void;
 export declare function subscribeTo<T, U>(store: StoreApi<T>, select: (state: T) => U, handle: (subState: U) => void): () => void;
+export {};
 //# sourceMappingURL=state.d.ts.map

package/dist/state.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../src/state.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAmBhD;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAwB/E;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAsBpF;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAa9E;AAID;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;AAClG,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAC9B,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAClB,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,EACvB,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,IAAI,GAC5B,MAAM,IAAI,CAAC"}
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../src/state.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAmBhD,KAAK,WAAW,GAAG,MAAM,GAAG,gBAAgB,CAAC;AAE7C;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,EAAE,WAAW,GAAE,WAAoB,GAAG,QAAQ,CAAC,CAAC,CAAC,CAwBlH;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAsBpF;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC9B,IAAI,EAAE,MAAM,EACZ,aAAa,CAAC,EAAE,CAAC,EACjB,mBAAmB,GAAE,WAAoB,GACxC,QAAQ,CAAC,CAAC,CAAC,CAab;AAID;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;AAClG,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAC9B,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,EAClB,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,EACvB,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,IAAI,GAC5B,MAAM,IAAI,CAAC"}

package/dist/state.js

@@ -1,4 +1,5 @@
 /** @module @category Store */ import { shallowEqual } from "@openmrs/esm-utils";
+import { persist, createJSONStorage } from "zustand/middleware";
 import { createStore } from "zustand/vanilla";
 import { isTestEnvironment } from "./utils.js";
 const availableStores = {};
@@ -14,9 +15,10 @@ globalThis.setTimeout?.(()=>{
  *
  * @param name A name by which the store can be looked up later.
  *    Must be unique across the entire application.
+ * @param storageType The type of storage to use for persisting the store's state. Defaults to 'none'.
  * @param initialState An object which will be the initial state of the store.
  * @returns The newly created store.
- */ export function createGlobalStore(name, initialState) {
+ */ export function createGlobalStore(name, initialState, storageType = 'none') {
     const available = availableStores[name];
     if (available) {
         if (available.active) {
@@ -29,7 +31,7 @@ globalThis.setTimeout?.(()=>{
         available.active = true;
         return available.value;
     } else {
-        const store = createStore()(()=>initialState);
+        const store = createStoreHelper(name, initialState, storageType);
         availableStores[name] = {
             value: store,
             active: true
@@ -70,11 +72,12 @@ globalThis.setTimeout?.(()=>{
  *
  * @param name The name of the store to look up.
  * @param fallbackState The initial value of the new store if no store named `name` exists.
+ * @param fallbackStorageType The type of storage to use for the new store if no store named `name` exists. Defaults to 'none'.
  * @returns The found or newly created store.
- */ export function getGlobalStore(name, fallbackState) {
+ */ export function getGlobalStore(name, fallbackState, fallbackStorageType = 'none') {
     const available = availableStores[name];
     if (!available) {
-        const store = createStore()(()=>fallbackState ?? {});
+        const store = createStoreHelper(name, fallbackState ?? {}, fallbackStorageType);
         availableStores[name] = {
             value: store,
             active: false
@@ -97,3 +100,17 @@ export function subscribeTo(...args) {
         }
     });
 }
+/**
+ * @internal
+ */ function createStoreHelper(name, initialState, storageType) {
+    let store;
+    if (storageType === 'sessionStorage') {
+        store = createStore()(persist(()=>initialState, {
+            name,
+            storage: createJSONStorage(()=>sessionStorage)
+        }));
+    } else {
+        store = createStore()(()=>initialState);
+    }
+    return store;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-state",
-  "version": "9.0.3-pre.4216",
+  "version": "9.0.3-pre.4223",
   "license": "MPL-2.0",
   "description": "Frontend stores & state management for OpenMRS",
   "type": "module",
@@ -61,8 +61,8 @@
     "@openmrs/esm-utils": "9.x"
   },
   "devDependencies": {
-    "@openmrs/esm-globals": "9.0.3-pre.4216",
-    "@openmrs/esm-utils": "9.0.3-pre.4216",
+    "@openmrs/esm-globals": "9.0.3-pre.4223",
+    "@openmrs/esm-utils": "9.0.3-pre.4223",
     "@swc/cli": "0.8.0",
     "@swc/core": "1.15.18",
     "@vitest/coverage-v8": "^4.0.18",

package/src/state.ts

@@ -1,6 +1,7 @@
 /** @module @category Store */
 import type {} from '@openmrs/esm-globals';
 import { shallowEqual } from '@openmrs/esm-utils';
+import { persist, createJSONStorage } from 'zustand/middleware';
 import type { StoreApi } from 'zustand/vanilla';
 import { createStore } from 'zustand/vanilla';
 import { isTestEnvironment } from './utils';
@@ -20,15 +21,18 @@ globalThis.setTimeout?.(() => {
   }
 }, 1000);
 
+type StorageType = 'none' | 'sessionStorage';
+
 /**
  * Creates a Zustand store.
  *
  * @param name A name by which the store can be looked up later.
  *    Must be unique across the entire application.
+ * @param storageType The type of storage to use for persisting the store's state. Defaults to 'none'.
  * @param initialState An object which will be the initial state of the store.
  * @returns The newly created store.
  */
-export function createGlobalStore<T>(name: string, initialState: T): StoreApi<T> {
+export function createGlobalStore<T>(name: string, initialState: T, storageType: StorageType = 'none'): StoreApi<T> {
   const available = availableStores[name];
 
   if (available) {
@@ -43,7 +47,7 @@ export function createGlobalStore<T>(name: string, initialState: T): StoreApi<T>
     available.active = true;
     return available.value as StoreApi<T>;
   } else {
-    const store = createStore<T>()(() => initialState);
+    const store = createStoreHelper(name, initialState, storageType);
 
     availableStores[name] = {
       value: store,
@@ -92,13 +96,18 @@ export function registerGlobalStore<T>(name: string, store: StoreApi<T>): StoreA
  *
  * @param name The name of the store to look up.
  * @param fallbackState The initial value of the new store if no store named `name` exists.
+ * @param fallbackStorageType The type of storage to use for the new store if no store named `name` exists. Defaults to 'none'.
  * @returns The found or newly created store.
  */
-export function getGlobalStore<T>(name: string, fallbackState?: T): StoreApi<T> {
+export function getGlobalStore<T>(
+  name: string,
+  fallbackState?: T,
+  fallbackStorageType: StorageType = 'none',
+): StoreApi<T> {
   const available = availableStores[name];
 
   if (!available) {
-    const store = createStore<T>()(() => fallbackState ?? ({} as unknown as T));
+    const store = createStoreHelper(name, fallbackState ?? ({} as unknown as T), fallbackStorageType);
     availableStores[name] = {
       value: store,
       active: false,
@@ -147,3 +156,16 @@ export function subscribeTo<T, U>(...args: SubscribeToArgs<T, U>): () => void {
     }
   });
 }
+
+/**
+ * @internal
+ */
+function createStoreHelper<T>(name: string, initialState: T, storageType: StorageType) {
+  let store: StoreApi<T>;
+  if (storageType === 'sessionStorage') {
+    store = createStore<T>()(persist(() => initialState, { name, storage: createJSONStorage(() => sessionStorage) }));
+  } else {
+    store = createStore<T>()(() => initialState);
+  }
+  return store;
+}