@openmrs/esm-extensions 8.0.1-pre.3439 → 8.0.1-pre.3457

package/.turbo/turbo-build.log

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

package/dist/extensions.d.ts

@@ -1,5 +1,5 @@
 /** @module @category Extension */
-import { type AssignedExtension, type ExtensionRegistration, type ExtensionInternalStore } from './store';
+import { type AssignedExtension, type ExtensionInternalStore, type ExtensionRegistration, type ExtensionSlotCustomState } from './store';
 /**
  * Given an extension ID, which is a string uniquely identifying
  * an instance of an extension within an extension slot, this
@@ -63,9 +63,18 @@ export declare function getAssignedExtensions(slotName: string): Array<AssignedE
  *
  * @param moduleName The name of the module that contains the extension slot
  * @param slotName The extension slot name that is actually used
+ * @param state Optional custom state for the slot, which will be stored in the extension store.
  * @internal
  */
-export declare const registerExtensionSlot: (moduleName: string, slotName: string) => void;
+export declare const registerExtensionSlot: (moduleName: string, slotName: string, state?: ExtensionSlotCustomState) => void;
+/**
+ * Used by extension slots to update the copy of the state for the extension slot
+ *
+ * @param slotName The name of the slot with state to update
+ * @param state A copy of the new state
+ * @param partial Whether this should be applied as a partial
+ */
+export declare function updateExtensionSlotState(slotName: string, state: ExtensionSlotCustomState, partial?: boolean): void;
 /**
  * @internal
  * Just for testing.

package/dist/extensions.js

@@ -6,14 +6,14 @@
  * - assigned (computed from attached and configured)
  * - connected (computed from assigned using connectivity and online / offline)
  */ import { sessionStore, userHasAccess } from "@openmrs/esm-api";
-import { getExtensionConfigFromStore, getExtensionsConfigStore, getExtensionSlotConfig, getExtensionConfigFromExtensionSlotStore, getExtensionSlotConfigFromStore, getExtensionSlotsConfigStore } from "@openmrs/esm-config";
+import { getExtensionConfigFromExtensionSlotStore, getExtensionConfigFromStore, getExtensionSlotConfig, getExtensionSlotConfigFromStore, getExtensionSlotsConfigStore, getExtensionsConfigStore } from "@openmrs/esm-config";
 import { evaluateAsBoolean } from "@openmrs/esm-expression-evaluator";
 import { featureFlagsStore } from "@openmrs/esm-feature-flags";
 import { subscribeConnectivityChanged } from "@openmrs/esm-globals";
 import { isOnline as isOnlineFn } from "@openmrs/esm-utils";
 import { isEqual, merge } from "lodash-es";
 import { checkStatusFor } from "./helpers.js";
-import { getExtensionStore, getExtensionInternalStore, updateInternalExtensionStore } from "./store.js";
+import { getExtensionInternalStore, getExtensionStore, updateInternalExtensionStore } from "./store.js";
 const extensionInternalStore = getExtensionInternalStore();
 const extensionStore = getExtensionStore();
 const slotsConfigStore = getExtensionSlotsConfigStore();
@@ -57,12 +57,13 @@ function updateOutputStoreToCurrent() {
 }
 updateOutputStoreToCurrent();
 subscribeConnectivityChanged(updateOutputStoreToCurrent);
-function createNewExtensionSlotInfo(slotName, moduleName) {
+function createNewExtensionSlotInfo(slotName, moduleName, state) {
     return {
         moduleName,
         name: slotName,
         attachedIds: [],
-        config: null
+        config: null,
+        state
     };
 }
 /**
@@ -220,6 +221,14 @@ function getAssignedExtensionsFromSlotData(slotName, internalState, config, exte
     const attachedIds = internalState.slots[slotName].attachedIds;
     const assignedIds = calculateAssignedIds(config, attachedIds);
     const extensions = [];
+    // Create context once for all extensions in this slot
+    const slotState = internalState.slots[slotName]?.state;
+    const expressionContext = slotState && typeof slotState === 'object' ? {
+        session,
+        ...slotState
+    } : {
+        session
+    };
     for (let id of assignedIds){
         const { config: rawExtensionConfig } = getExtensionConfigFromStore(extensionConfigStoreState, slotName, id);
         const rawExtensionSlotExtensionConfig = getExtensionConfigFromExtensionSlotStore(config, slotName, id);
@@ -237,16 +246,14 @@ function getAssignedExtensionsFromSlotData(slotName, internalState, config, exte
                     continue;
                 }
             }
-            const displayConditionExpression = extensionConfig?.['Display conditions']?.expression ?? null;
-            if (displayConditionExpression !== null) {
+            const displayConditionExpression = extensionConfig?.['Display conditions']?.expression || extension.displayExpression;
+            if (displayConditionExpression !== undefined && typeof displayConditionExpression === 'string' && displayConditionExpression.trim().length > 0) {
                 try {
-                    if (!evaluateAsBoolean(displayConditionExpression, {
-                        session
-                    })) {
+                    if (!evaluateAsBoolean(displayConditionExpression, expressionContext)) {
                         continue;
                     }
                 } catch (e) {
-                    console.error(`Error while evaluating expression ${displayConditionExpression}`, e);
+                    console.error(`Error while evaluating expression '${displayConditionExpression}' for extension ${name} in slot ${slotName}`, e);
                     continue;
                 }
             }
@@ -310,38 +317,63 @@ function calculateAssignedIds(config, attachedIds) {
  *
  * @param moduleName The name of the module that contains the extension slot
  * @param slotName The extension slot name that is actually used
+ * @param state Optional custom state for the slot, which will be stored in the extension store.
  * @internal
- */ export const registerExtensionSlot = (moduleName, slotName)=>extensionInternalStore.setState((state)=>{
-        const existingModuleName = state.slots[slotName]?.moduleName;
+ */ export const registerExtensionSlot = (moduleName, slotName, state)=>extensionInternalStore.setState((currentState)=>{
+        const existingModuleName = currentState.slots[slotName]?.moduleName;
         if (existingModuleName && existingModuleName != moduleName) {
             console.warn(`An extension slot with the name '${slotName}' already exists. Refusing to register the same slot name twice (in "registerExtensionSlot"). The existing one is from module ${existingModuleName}.`);
-            return state;
+            return currentState;
         }
         if (existingModuleName && existingModuleName == moduleName) {
             // Re-rendering an existing slot
-            return state;
+            return currentState;
         }
-        if (state.slots[slotName]) {
+        if (currentState.slots[slotName]) {
             return {
-                ...state,
+                ...currentState,
                 slots: {
-                    ...state.slots,
+                    ...currentState.slots,
                     [slotName]: {
-                        ...state.slots[slotName],
-                        moduleName
+                        ...currentState.slots[slotName],
+                        moduleName,
+                        state
                     }
                 }
             };
         }
-        const slot = createNewExtensionSlotInfo(slotName, moduleName);
+        const slot = createNewExtensionSlotInfo(slotName, moduleName, state);
         return {
-            ...state,
+            ...currentState,
             slots: {
-                ...state.slots,
-                [slotName]: slot
+                ...currentState.slots,
+                [slotName]: {
+                    ...slot
+                }
             }
         };
     });
+/**
+ * Used by extension slots to update the copy of the state for the extension slot
+ *
+ * @param slotName The name of the slot with state to update
+ * @param state A copy of the new state
+ * @param partial Whether this should be applied as a partial
+ */ export function updateExtensionSlotState(slotName, state, partial = false) {
+    extensionInternalStore.setState((currentState)=>{
+        const newState = partial ? merge(currentState.slots[slotName].state, state) : state;
+        return {
+            ...currentState,
+            slots: {
+                ...currentState.slots,
+                [slotName]: {
+                    ...currentState.slots[slotName],
+                    state: newState
+                }
+            }
+        };
+    });
+}
 /**
  * @internal
  * Just for testing.

package/dist/left-nav.d.ts

@@ -1,10 +1,12 @@
 import { type ComponentConfig } from './types';
+import { type ExtensionSlotState } from './store';
 type LeftNavMode = 'normal' | 'collapsed' | 'hidden';
 export interface LeftNavStore {
     slotName: string | null;
     basePath: string;
     mode: LeftNavMode;
     componentContext?: ComponentConfig;
+    state?: ExtensionSlotState;
 }
 /** @internal */
 export declare const leftNavStore: import("zustand").StoreApi<LeftNavStore>;
@@ -18,13 +20,14 @@ export interface SetLeftNavParams {
      */
     mode?: LeftNavMode;
     componentContext?: ComponentConfig;
+    state?: ExtensionSlotState;
 }
 /**
  * Sets the current left nav context. Must be paired with {@link unsetLeftNav}.
  *
  * @deprecated Please use {@link useLeftNav} instead. This function will be made internal in a future release.
  */
-export declare function setLeftNav({ name, basePath, mode, componentContext }: SetLeftNavParams): void;
+export declare function setLeftNav({ name, basePath, mode, componentContext, state }: SetLeftNavParams): void;
 /**
  * Unsets the left nav context if the current context is for the supplied name.
  *

package/dist/left-nav.js

@@ -8,12 +8,13 @@ import { createGlobalStore } from "@openmrs/esm-state";
  * Sets the current left nav context. Must be paired with {@link unsetLeftNav}.
  *
  * @deprecated Please use {@link useLeftNav} instead. This function will be made internal in a future release.
- */ export function setLeftNav({ name, basePath, mode, componentContext }) {
+ */ export function setLeftNav({ name, basePath, mode, componentContext, state }) {
     leftNavStore.setState({
         slotName: name,
         basePath,
         mode: mode ?? 'normal',
-        componentContext
+        componentContext,
+        state
     });
 }
 /**

package/dist/store.d.ts

@@ -13,6 +13,7 @@ export interface ExtensionRegistration {
     readonly offline?: boolean;
     readonly privileges?: string | Array<string>;
     readonly featureFlag?: string;
+    readonly displayExpression?: string;
 }
 export interface ExtensionInfo extends ExtensionRegistration {
     /**
@@ -31,6 +32,7 @@ export interface ExtensionInternalStore {
     /** Extensions indexed by name */
     extensions: Record<string, ExtensionInfo>;
 }
+export type ExtensionSlotCustomState = Record<string | symbol | number, unknown> | undefined | null;
 export interface ExtensionSlotInfo {
     /**
      * The module in which the extension slot exists. Undefined if the slot
@@ -48,6 +50,7 @@ export interface ExtensionSlotInfo {
     attachedIds: Array<string>;
     /** The configuration provided for this slot. `null` if not yet loaded. */
     config: Omit<ExtensionSlotConfig, 'configuration'> | null;
+    state?: ExtensionSlotCustomState;
 }
 export interface ExtensionStore {
     slots: Record<string, ExtensionSlotState>;
@@ -55,6 +58,7 @@ export interface ExtensionStore {
 export interface ExtensionSlotState {
     moduleName?: string;
     assignedExtensions: Array<AssignedExtension>;
+    state?: ExtensionSlotCustomState;
 }
 export interface AssignedExtension {
     readonly id: string;

package/dist/store.js

@@ -15,6 +15,7 @@ const extensionInternalStore = createGlobalStore('extensionsInternal', {
         extensions: {}
     });
 /** @internal */ export function updateInternalExtensionStore(updater) {
+    // This is a function that updates the internal extension store.
     const state = extensionInternalStore.getState();
     const newState = updater(state);
     if (newState !== state) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-extensions",
-  "version": "8.0.1-pre.3439",
+  "version": "8.0.1-pre.3457",
   "license": "MPL-2.0",
   "description": "Coordinates extensions and extension points in the OpenMRS Frontend",
   "type": "module",
@@ -64,12 +64,12 @@
     "single-spa": "6.x"
   },
   "devDependencies": {
-    "@openmrs/esm-api": "8.0.1-pre.3439",
-    "@openmrs/esm-config": "8.0.1-pre.3439",
-    "@openmrs/esm-expression-evaluator": "8.0.1-pre.3439",
-    "@openmrs/esm-feature-flags": "8.0.1-pre.3439",
-    "@openmrs/esm-state": "8.0.1-pre.3439",
-    "@openmrs/esm-utils": "8.0.1-pre.3439",
+    "@openmrs/esm-api": "8.0.1-pre.3457",
+    "@openmrs/esm-config": "8.0.1-pre.3457",
+    "@openmrs/esm-expression-evaluator": "8.0.1-pre.3457",
+    "@openmrs/esm-feature-flags": "8.0.1-pre.3457",
+    "@openmrs/esm-state": "8.0.1-pre.3457",
+    "@openmrs/esm-utils": "8.0.1-pre.3457",
     "@swc/cli": "^0.7.7",
     "@swc/core": "^1.11.29",
     "concurrently": "^9.1.2",

package/src/extensions.ts

@@ -10,15 +10,15 @@
 
 import { type Session, type SessionStore, sessionStore, userHasAccess } from '@openmrs/esm-api';
 import {
-  type ExtensionsConfigStore,
   type ExtensionSlotConfig,
   type ExtensionSlotsConfigStore,
+  type ExtensionsConfigStore,
+  getExtensionConfigFromExtensionSlotStore,
   getExtensionConfigFromStore,
-  getExtensionsConfigStore,
   getExtensionSlotConfig,
-  getExtensionConfigFromExtensionSlotStore,
   getExtensionSlotConfigFromStore,
   getExtensionSlotsConfigStore,
+  getExtensionsConfigStore,
 } from '@openmrs/esm-config';
 import { evaluateAsBoolean } from '@openmrs/esm-expression-evaluator';
 import { type FeatureFlagsStore, featureFlagsStore } from '@openmrs/esm-feature-flags';
@@ -28,12 +28,13 @@ import { isEqual, merge } from 'lodash-es';
 import { checkStatusFor } from './helpers';
 import {
   type AssignedExtension,
+  type ExtensionInternalStore,
   type ExtensionRegistration,
+  type ExtensionSlotCustomState,
   type ExtensionSlotInfo,
-  type ExtensionInternalStore,
   type ExtensionSlotState,
-  getExtensionStore,
   getExtensionInternalStore,
+  getExtensionStore,
   updateInternalExtensionStore,
 } from './store';
 
@@ -139,12 +140,17 @@ function updateOutputStoreToCurrent() {
 updateOutputStoreToCurrent();
 subscribeConnectivityChanged(updateOutputStoreToCurrent);
 
-function createNewExtensionSlotInfo(slotName: string, moduleName?: string): ExtensionSlotInfo {
+function createNewExtensionSlotInfo(
+  slotName: string,
+  moduleName?: string,
+  state?: ExtensionSlotCustomState,
+): ExtensionSlotInfo {
   return {
     moduleName,
     name: slotName,
     attachedIds: [],
     config: null,
+    state,
   };
 }
 
@@ -333,6 +339,10 @@ function getAssignedExtensionsFromSlotData(
   const assignedIds = calculateAssignedIds(config, attachedIds);
   const extensions: Array<AssignedExtension> = [];
 
+  // Create context once for all extensions in this slot
+  const slotState = internalState.slots[slotName]?.state;
+  const expressionContext = slotState && typeof slotState === 'object' ? { session, ...slotState } : { session };
+
   for (let id of assignedIds) {
     const { config: rawExtensionConfig } = getExtensionConfigFromStore(extensionConfigStoreState, slotName, id);
     const rawExtensionSlotExtensionConfig = getExtensionConfigFromExtensionSlotStore(config, slotName, id);
@@ -357,15 +367,23 @@ function getAssignedExtensionsFromSlotData(
         }
       }
 
-      const displayConditionExpression = extensionConfig?.['Display conditions']?.expression ?? null;
-      if (displayConditionExpression !== null) {
+      const displayConditionExpression =
+        extensionConfig?.['Display conditions']?.expression || extension.displayExpression;
+
+      if (
+        displayConditionExpression !== undefined &&
+        typeof displayConditionExpression === 'string' &&
+        displayConditionExpression.trim().length > 0
+      ) {
         try {
-          if (!evaluateAsBoolean(displayConditionExpression, { session })) {
+          if (!evaluateAsBoolean(displayConditionExpression, expressionContext)) {
             continue;
           }
         } catch (e) {
-          console.error(`Error while evaluating expression ${displayConditionExpression}`, e);
-          // if the expression has an error, we do not display the extension
+          console.error(
+            `Error while evaluating expression '${displayConditionExpression}' for extension ${name} in slot ${slotName}`,
+            e,
+          );
           continue;
         }
       }
@@ -449,43 +467,77 @@ function calculateAssignedIds(config: ExtensionSlotConfig, attachedIds: Array<st
  *
  * @param moduleName The name of the module that contains the extension slot
  * @param slotName The extension slot name that is actually used
+ * @param state Optional custom state for the slot, which will be stored in the extension store.
  * @internal
  */
-export const registerExtensionSlot: (moduleName: string, slotName: string) => void = (moduleName, slotName) =>
-  extensionInternalStore.setState((state) => {
-    const existingModuleName = state.slots[slotName]?.moduleName;
+export const registerExtensionSlot: (moduleName: string, slotName: string, state?: ExtensionSlotCustomState) => void = (
+  moduleName,
+  slotName,
+  state,
+) =>
+  extensionInternalStore.setState((currentState) => {
+    const existingModuleName = currentState.slots[slotName]?.moduleName;
     if (existingModuleName && existingModuleName != moduleName) {
       console.warn(
         `An extension slot with the name '${slotName}' already exists. Refusing to register the same slot name twice (in "registerExtensionSlot"). The existing one is from module ${existingModuleName}.`,
       );
-      return state;
+      return currentState;
     }
+
     if (existingModuleName && existingModuleName == moduleName) {
       // Re-rendering an existing slot
-      return state;
+      return currentState;
     }
-    if (state.slots[slotName]) {
+
+    if (currentState.slots[slotName]) {
       return {
-        ...state,
+        ...currentState,
         slots: {
-          ...state.slots,
+          ...currentState.slots,
           [slotName]: {
-            ...state.slots[slotName],
+            ...currentState.slots[slotName],
             moduleName,
+            state,
           },
         },
       };
     }
-    const slot = createNewExtensionSlotInfo(slotName, moduleName);
+
+    const slot = createNewExtensionSlotInfo(slotName, moduleName, state);
     return {
-      ...state,
+      ...currentState,
       slots: {
-        ...state.slots,
-        [slotName]: slot,
+        ...currentState.slots,
+        [slotName]: {
+          ...slot,
+        },
       },
     };
   });
 
+/**
+ * Used by extension slots to update the copy of the state for the extension slot
+ *
+ * @param slotName The name of the slot with state to update
+ * @param state A copy of the new state
+ * @param partial Whether this should be applied as a partial
+ */
+export function updateExtensionSlotState(slotName: string, state: ExtensionSlotCustomState, partial: boolean = false) {
+  extensionInternalStore.setState((currentState) => {
+    const newState = partial ? merge(currentState.slots[slotName].state, state) : state;
+    return {
+      ...currentState,
+      slots: {
+        ...currentState.slots,
+        [slotName]: {
+          ...currentState.slots[slotName],
+          state: newState,
+        },
+      },
+    };
+  });
+}
+
 /**
  * @internal
  * Just for testing.

package/src/left-nav.ts

@@ -1,6 +1,7 @@
 import type {} from '@openmrs/esm-globals';
 import { createGlobalStore } from '@openmrs/esm-state';
 import { type ComponentConfig } from './types';
+import { type ExtensionSlotState } from './store';
 
 type LeftNavMode = 'normal' | 'collapsed' | 'hidden';
 export interface LeftNavStore {
@@ -8,6 +9,7 @@ export interface LeftNavStore {
   basePath: string;
   mode: LeftNavMode;
   componentContext?: ComponentConfig;
+  state?: ExtensionSlotState;
 }
 
 /** @internal */
@@ -27,6 +29,7 @@ export interface SetLeftNavParams {
    */
   mode?: LeftNavMode;
   componentContext?: ComponentConfig;
+  state?: ExtensionSlotState;
 }
 
 /**
@@ -34,8 +37,8 @@ export interface SetLeftNavParams {
  *
  * @deprecated Please use {@link useLeftNav} instead. This function will be made internal in a future release.
  */
-export function setLeftNav({ name, basePath, mode, componentContext }: SetLeftNavParams) {
-  leftNavStore.setState({ slotName: name, basePath, mode: mode ?? 'normal', componentContext });
+export function setLeftNav({ name, basePath, mode, componentContext, state }: SetLeftNavParams) {
+  leftNavStore.setState({ slotName: name, basePath, mode: mode ?? 'normal', componentContext, state });
 }
 
 /**

package/src/store.ts

@@ -19,6 +19,7 @@ export interface ExtensionRegistration {
   readonly offline?: boolean;
   readonly privileges?: string | Array<string>;
   readonly featureFlag?: string;
+  readonly displayExpression?: string;
 }
 
 export interface ExtensionInfo extends ExtensionRegistration {
@@ -41,6 +42,8 @@ export interface ExtensionInternalStore {
   extensions: Record<string, ExtensionInfo>;
 }
 
+export type ExtensionSlotCustomState = Record<string | symbol | number, unknown> | undefined | null;
+
 export interface ExtensionSlotInfo {
   /**
    * The module in which the extension slot exists. Undefined if the slot
@@ -58,6 +61,7 @@ export interface ExtensionSlotInfo {
   attachedIds: Array<string>;
   /** The configuration provided for this slot. `null` if not yet loaded. */
   config: Omit<ExtensionSlotConfig, 'configuration'> | null;
+  state?: ExtensionSlotCustomState;
 }
 
 export interface ExtensionStore {
@@ -67,6 +71,7 @@ export interface ExtensionStore {
 export interface ExtensionSlotState {
   moduleName?: string;
   assignedExtensions: Array<AssignedExtension>;
+  state?: ExtensionSlotCustomState;
 }
 
 export interface AssignedExtension {
@@ -110,6 +115,7 @@ export const getExtensionInternalStore = () =>
 
 /** @internal */
 export function updateInternalExtensionStore(updater: (state: ExtensionInternalStore) => ExtensionInternalStore) {
+  // This is a function that updates the internal extension store.
   const state = extensionInternalStore.getState();
   const newState = updater(state);