@openmrs/esm-context 6.3.1-pre.3106 → 6.3.1-pre.3124

package/.turbo/turbo-build.log

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

package/dist/context.d.ts

@@ -14,18 +14,24 @@ export declare const contextStore: import("zustand/vanilla").StoreApi<OpenmrsApp
  * @param namespace the namespace to register
  * @param initialValue the initial value of the namespace
  */
-export declare function registerContext<T extends {} = {}>(namespace: string, initialValue?: T): void;
+export declare function registerContext<T extends Record<string | symbol | number, unknown> = Record<string | symbol | number, any>>(namespace: string, initialValue?: T): void;
 /**
  * Used by caller to unregister a namespace in the application context. Unregistering a namespace
  * will remove the namespace and all associated data.
  */
 export declare function unregisterContext(namespace: string): void;
-export declare function getContext<T extends {} = {}>(namespace: string): Readonly<T> | null;
+/**
+ * Returns an _immutable_ version of the state of the namespace as it is currently
+ *
+ * @typeParam T The type of the value stored in the namespace
+ * @param namespace The namespace to load properties from
+ */
+export declare function getContext<T extends Record<string | symbol | number, unknown> = Record<string | symbol | number, any>>(namespace: string): Readonly<T> | null;
 /**
  * Updates a namespace in the global context. If the namespace does not exist, it is registered.
  */
-export declare function updateContext<T extends {} = {}>(namespace: string, update: (state: T) => T): void;
-export type ContextCallback<T extends {} = {}> = (state: Readonly<T> | null | undefined) => void;
+export declare function updateContext<T extends Record<string | symbol | number, unknown> = Record<string | symbol | number, any>>(namespace: string, update: (state: T) => T): void;
+export type ContextCallback<T extends Record<string | symbol | number, unknown> = Record<string | symbol | number, any>> = (state: Readonly<T> | null | undefined) => void;
 /**
  * Subscribes to updates of a given namespace. Note that the returned object is immutable.
  *
@@ -33,5 +39,5 @@ export type ContextCallback<T extends {} = {}> = (state: Readonly<T> | null | un
  * @param callback a function invoked with the current context whenever
  * @returns A function to unsubscribe from the context
  */
-export declare function subscribeToContext<T extends {} = {}>(namespace: string, callback: ContextCallback<T>): () => void;
+export declare function subscribeToContext<T extends Record<string | symbol | number, unknown> = Record<string | symbol | number, any>>(namespace: string, callback: ContextCallback<T>): () => void;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-context",
-  "version": "6.3.1-pre.3106",
+  "version": "6.3.1-pre.3124",
   "license": "MPL-2.0",
   "description": "Utilities for managing the current execution context",
   "type": "module",
@@ -53,8 +53,8 @@
     "@openmrs/esm-state": "6.x"
   },
   "devDependencies": {
-    "@openmrs/esm-globals": "6.3.1-pre.3106",
-    "@openmrs/esm-state": "6.3.1-pre.3106",
+    "@openmrs/esm-globals": "6.3.1-pre.3124",
+    "@openmrs/esm-state": "6.3.1-pre.3124",
     "@swc/cli": "^0.7.7",
     "@swc/core": "^1.11.29",
     "concurrently": "^9.1.2",

package/src/context.ts

@@ -26,7 +26,9 @@ const nothing = Object();
  * @param namespace the namespace to register
  * @param initialValue the initial value of the namespace
  */
-export function registerContext<T extends {} = {}>(namespace: string, initialValue: T = nothing) {
+export function registerContext<
+  T extends Record<string | symbol | number, unknown> = Record<string | symbol | number, any>,
+>(namespace: string, initialValue: T = nothing) {
   contextStore.setState((state) => {
     if (namespace in state) {
       throw new Error(
@@ -51,7 +53,15 @@ export function unregisterContext(namespace: string) {
   });
 }
 
-export function getContext<T extends {} = {}>(namespace: string): Readonly<T> | null;
+/**
+ * Returns an _immutable_ version of the state of the namespace as it is currently
+ *
+ * @typeParam T The type of the value stored in the namespace
+ * @param namespace The namespace to load properties from
+ */
+export function getContext<T extends Record<string | symbol | number, unknown> = Record<string | symbol | number, any>>(
+  namespace: string,
+): Readonly<T> | null;
 /**
  * Returns an _immutable_ version of the state of the namespace as it is currently
  *
@@ -60,10 +70,10 @@ export function getContext<T extends {} = {}>(namespace: string): Readonly<T> |
  * @param namespace The namespace to load properties from
  * @param selector An optional function which extracts the relevant part of the state
  */
-export function getContext<T extends {} = {}, U extends {} = T>(
-  namespace: string,
-  selector: (state: Readonly<T>) => U = (state) => state as unknown as U,
-): Readonly<U> | null {
+export function getContext<
+  T extends Record<string | symbol | number, unknown> = Record<string | symbol | number, any>,
+  U extends Record<string | symbol | number, unknown> = T,
+>(namespace: string, selector: (state: Readonly<T>) => U = (state) => state as unknown as U): Readonly<U> | null {
   const state = contextStore.getState();
   if (namespace in state) {
     return Object.freeze(Object.assign({}, (selector ? selector(state[namespace] as T) : state[namespace]) as U));
@@ -75,7 +85,9 @@ export function getContext<T extends {} = {}, U extends {} = T>(
 /**
  * Updates a namespace in the global context. If the namespace does not exist, it is registered.
  */
-export function updateContext<T extends {} = {}>(namespace: string, update: (state: T) => T) {
+export function updateContext<
+  T extends Record<string | symbol | number, unknown> = Record<string | symbol | number, any>,
+>(namespace: string, update: (state: T) => T) {
   contextStore.setState((state) => {
     if (!(namespace in state)) {
       state[namespace] = {};
@@ -86,7 +98,9 @@ export function updateContext<T extends {} = {}>(namespace: string, update: (sta
   });
 }
 
-export type ContextCallback<T extends {} = {}> = (state: Readonly<T> | null | undefined) => void;
+export type ContextCallback<
+  T extends Record<string | symbol | number, unknown> = Record<string | symbol | number, any>,
+> = (state: Readonly<T> | null | undefined) => void;
 
 /**
  * Subscribes to updates of a given namespace. Note that the returned object is immutable.
@@ -95,7 +109,9 @@ export type ContextCallback<T extends {} = {}> = (state: Readonly<T> | null | un
  * @param callback a function invoked with the current context whenever
  * @returns A function to unsubscribe from the context
  */
-export function subscribeToContext<T extends {} = {}>(namespace: string, callback: ContextCallback<T>) {
+export function subscribeToContext<
+  T extends Record<string | symbol | number, unknown> = Record<string | symbol | number, any>,
+>(namespace: string, callback: ContextCallback<T>) {
   let previous = getContext<T>(namespace);
 
   // set initial value