@openmrs/esm-config 10.0.1-pre.5364 → 10.0.1-pre.5373

package/.turbo/turbo-build.log

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

package/dist/module-config/module-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"module-config.d.ts","sourceRoot":"","sources":["../../src/module-config/module-config.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAuB,MAAM,UAAU,CAAC;AAySxF;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,QAS1E;AAED;;;;;;;;;GASG;AACH,wBAAgB,8BAA8B,CAAC,UAAU,EAAE,MAAM,QAKhE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,QAKpD;AAED;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAAC,SAAS,EAAE,MAAM,QAK7D;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,2BAA2B,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,QAetF;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,SAAa,QAK9D;AAiCD;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAMjF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAoBxD;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,UAKvG;AAomBD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,QAUjD;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,SAUhC"}
+{"version":3,"file":"module-config.d.ts","sourceRoot":"","sources":["../../src/module-config/module-config.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAuB,MAAM,UAAU,CAAC;AA+SxF;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,QAS1E;AAED;;;;;;;;;GASG;AACH,wBAAgB,8BAA8B,CAAC,UAAU,EAAE,MAAM,QAKhE;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,QAKpD;AAED;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAAC,SAAS,EAAE,MAAM,QAK7D;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,2BAA2B,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,QAetF;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,SAAa,QAK9D;AAiCD;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAMjF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,EACjB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAoBxD;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,UAKvG;AA6nBD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,QAUjD;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,SAUhC"}

package/dist/module-config/module-config.js

@@ -7,12 +7,13 @@ import { configExtensionStore, configInternalStore, getConfigStore, getExtension
  * Deep merge two objects, with right-side values taking precedence.
  * Arrays are replaced entirely (not merged by index), matching the
  * behavior of ramda's mergeDeepRight.
- */ function mergeDeepReplace(left, right) {
-    return mergeWith({}, left, right, (_objValue, srcValue)=>{
-        if (Array.isArray(srcValue)) {
-            return srcValue;
-        }
-    });
+ */ function replaceArrays(_objValue, srcValue) {
+    if (Array.isArray(srcValue)) {
+        return srcValue;
+    }
+}
+function mergeDeepReplace(left, right) {
+    return mergeWith({}, left, right, replaceArrays);
 }
 /**
  * Store setup
@@ -43,8 +44,9 @@ const configSubscriptions = [];
     const tempConfigState = temporaryConfigStore.getState();
     const extensionState = configExtensionStore.getState();
     computeModuleConfig(configState, tempConfigState);
-    computeExtensionSlotConfigs(configState, tempConfigState);
-    computeExtensionConfigs(configState, extensionState, tempConfigState);
+    const slotConfigs = getExtensionSlotConfigs(configState, tempConfigState);
+    computeExtensionSlotConfigs(slotConfigs);
+    computeExtensionConfigs(configState, extensionState, tempConfigState, slotConfigs);
     // Last, because a failure here must not skip the outputs above. Only kept current while the
     // implementer tools are watching it; otherwise derived on read.
     invalidateImplementerToolsConfig();
@@ -108,8 +110,7 @@ function computeModuleConfig(state, tempState) {
         }
     }
 }
-function computeExtensionSlotConfigs(state, tempState) {
-    const slotConfigs = getExtensionSlotConfigs(state, tempState);
+function computeExtensionSlotConfigs(slotConfigs) {
     const slotStore = getExtensionSlotsConfigStore();
     const oldSlots = slotStore.getState().slots;
     const slots = {};
@@ -148,7 +149,7 @@ function computeImplementerToolsConfig(state, tempConfigState) {
         implementerToolsConfigStore.setState(newState);
     }
 }
-function computeExtensionConfigs(configState, extensionState, tempConfigState) {
+function computeExtensionConfigs(configState, extensionState, tempConfigState, slotConfigs) {
     const extensionsConfigStore = getExtensionsConfigStore();
     const oldConfigs = extensionsConfigStore.getState().configs;
     const configs = {};
@@ -157,7 +158,7 @@ function computeExtensionConfigs(configState, extensionState, tempConfigState) {
     // We assume that the module schema has already been defined, since the extension
     // it contains is mounted.
     for (let extension of extensionState.mountedExtensions){
-        const config = computeExtensionConfig(extension.slotModuleName, extension.extensionModuleName, extension.slotName, extension.extensionId, configState, tempConfigState);
+        const config = computeExtensionConfig(extension.slotModuleName, extension.extensionModuleName, extension.slotName, extension.extensionId, configState, tempConfigState, slotConfigs[extension.slotName]);
         const previous = oldConfigs[extension.slotName]?.[extension.extensionId];
         // Entries keep their identity when the configuration behind them hasn't changed, so that
         // mounting one extension doesn't hand every other mounted extension a new config object.
@@ -410,7 +411,8 @@ const extensionConfigCache = new Map();
  * @param extensionModuleName The name of the module which defines the extension (and therefore the config schema)
  * @param slotName The name of the extension slot where the extension is mounted
  * @param extensionId The ID of the extension in its slot
- */ function computeExtensionConfig(slotModuleName, extensionModuleName, slotName, extensionId, configState, tempConfigState) {
+ * @param slotConfig The slot's configuration, gathered from every module that configures it
+ */ function computeExtensionConfig(slotModuleName, extensionModuleName, slotName, extensionId, configState, tempConfigState, slotConfig) {
     const extensionName = getExtensionNameFromId(extensionId);
     const extensionConfigSchema = configState.schemas[extensionName];
     // JSON string of these elements should be unique-per-extension
@@ -426,11 +428,13 @@ const extensionConfigCache = new Map();
     }
     const nameOfSchemaSource = extensionConfigSchema ? extensionName : extensionModuleName;
     const providedConfigs = getProvidedConfigs(configState, tempConfigState);
+    const sharedOverride = slotConfig?.configure?.[extensionId] ?? {};
     const slotModuleConfig = mergeConfigsFor(slotModuleName, providedConfigs);
     const configOverride = slotModuleConfig?.extensionSlots?.[slotName]?.configure?.[extensionId] ?? {};
     const extensionConfig = mergeConfigsFor(nameOfSchemaSource, providedConfigs);
     const combinedConfig = mergeConfigs([
         extensionConfig,
+        sharedOverride,
         configOverride
     ]);
     const schema = extensionConfigSchema ?? configState.schemas[extensionModuleName];
@@ -558,13 +562,26 @@ function getExtensionSlotConfigs(configState, tempConfigState) {
         return obj;
     }, {});
     validateAllExtensionSlotConfigs(slotConfigPerModule);
-    const slotConfigs = Object.keys(slotConfigPerModule).reduce((obj, key)=>{
-        obj = {
-            ...obj,
-            ...slotConfigPerModule[key]
-        };
-        return obj;
-    }, {});
+    const slotConfigs = {};
+    const configureBlocks = {};
+    for (const configBySlotName of Object.values(slotConfigPerModule)){
+        for (const [slotName, config] of Object.entries(configBySlotName)){
+            slotConfigs[slotName] = config;
+            if (config.configure) {
+                var _configureBlocks, _slotName;
+                ((_configureBlocks = configureBlocks)[_slotName = slotName] ?? (_configureBlocks[_slotName] = [])).push(config.configure);
+            }
+        }
+    }
+    for (const [slotName, blocks] of Object.entries(configureBlocks)){
+        const configure = blocks.length === 1 ? blocks[0] : mergeConfigs(blocks);
+        if (slotConfigs[slotName].configure !== configure) {
+            slotConfigs[slotName] = {
+                ...slotConfigs[slotName],
+                configure
+            };
+        }
+    }
     return slotConfigs;
 }
 function validateAllExtensionSlotConfigs(slotConfigPerModule) {
@@ -687,8 +704,10 @@ function mergeConfigsFor(moduleName, allConfigs) {
     const allConfigsForModule = allConfigs.map(({ [moduleName]: c })=>c).filter((c)=>!!c);
     return mergeConfigs(allConfigsForModule);
 }
-function mergeConfigs(configs) {
-    return configs.reduce((acc, config)=>mergeDeepReplace(acc, config), {});
+/**
+ * Merges a whole list at once, accumulating into one destination.
+ */ function mergeConfigs(configs) {
+    return configs.reduce((acc, config)=>mergeWith(acc, config, replaceArrays), {});
 }
 /**
  * Recursively check the provided config tree to make sure that all

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-config",
-  "version": "10.0.1-pre.5364",
+  "version": "10.0.1-pre.5373",
   "license": "MPL-2.0",
   "description": "A configuration library for the OpenMRS Single-Spa framework.",
   "type": "module",
@@ -57,15 +57,15 @@
     "lodash-es": "^4.17.21"
   },
   "peerDependencies": {
-    "@openmrs/esm-globals": "^10.0.1-pre.5364",
-    "@openmrs/esm-state": "^10.0.1-pre.5364",
-    "@openmrs/esm-utils": "^10.0.1-pre.5364",
+    "@openmrs/esm-globals": "^10.0.1-pre.5373",
+    "@openmrs/esm-state": "^10.0.1-pre.5373",
+    "@openmrs/esm-utils": "^10.0.1-pre.5373",
     "single-spa": "6.x"
   },
   "devDependencies": {
-    "@openmrs/esm-globals": "10.0.1-pre.5364",
-    "@openmrs/esm-state": "10.0.1-pre.5364",
-    "@openmrs/esm-utils": "10.0.1-pre.5364",
+    "@openmrs/esm-globals": "10.0.1-pre.5373",
+    "@openmrs/esm-state": "10.0.1-pre.5373",
+    "@openmrs/esm-utils": "10.0.1-pre.5373",
     "@swc/cli": "0.8.1",
     "@swc/core": "1.15.21",
     "@types/lodash-es": "^4.17.12",

package/src/module-config/module-config.test.ts

@@ -1341,6 +1341,99 @@ describe('extension config', () => {
     expect(console.error).not.toHaveBeenCalled();
   });
 
+  // The module that renders an extension owns the slot it opens, which need not be the module an
+  // implementer configures that slot from.
+  it("uses the 'configure' config written by a module other than the one owning the slot", () => {
+    updateConfigExtensionStore('fooExt#id6');
+    const configureConfig = {
+      'ext-mod': { bar: 'qux' },
+      'other-mod': {
+        extensionSlots: {
+          barSlot: {
+            configure: { 'fooExt#id6': { baz: 'quiz' } },
+          },
+        },
+      },
+    };
+    Config.provide(configureConfig);
+    const result = getExtensionConfig('barSlot', 'fooExt#id6').getState().config;
+    expect(result).toStrictEqual({
+      bar: 'qux',
+      baz: 'quiz',
+      'Display conditions': { expression: undefined, privileges: [] },
+      'Translation overrides': {},
+    });
+    expect(console.error).not.toHaveBeenCalled();
+  });
+
+  it("prefers the slot-owning module's 'configure' config to another module's", () => {
+    updateConfigExtensionStore('fooExt#id7');
+    const configureConfig = {
+      'slot-mod': {
+        extensionSlots: {
+          barSlot: {
+            configure: { 'fooExt#id7': { baz: 'from-owner' } },
+          },
+        },
+      },
+      'other-mod': {
+        extensionSlots: {
+          barSlot: {
+            configure: { 'fooExt#id7': { bar: 'from-other', baz: 'from-other' } },
+          },
+        },
+      },
+    };
+    Config.provide(configureConfig);
+    const result = getExtensionConfig('barSlot', 'fooExt#id7').getState().config;
+    expect(result).toStrictEqual({
+      bar: 'from-other',
+      baz: 'from-owner',
+      'Display conditions': { expression: undefined, privileges: [] },
+      'Translation overrides': {},
+    });
+    expect(console.error).not.toHaveBeenCalled();
+  });
+
+  it("gathers 'configure' from every module but leaves 'add' to the last one to declare the slot", () => {
+    updateConfigExtensionStore('fooExt#id8');
+    Config.provide({
+      'first-mod': {
+        extensionSlots: {
+          barSlot: { add: ['fooExt#unwanted'], configure: { 'fooExt#id8': { bar: 'from-first' } } },
+        },
+      },
+      'last-mod': {
+        extensionSlots: {
+          barSlot: { add: ['fooExt#id8'], configure: { 'fooExt#id8': { baz: 'from-last' } } },
+        },
+      },
+    });
+
+    // Composing `add` across modules would resurrect entries another module had removed, so the
+    // last module to name the slot still supplies it whole.
+    expect(getExtensionSlotsConfigStore().getState().slots['barSlot'].config.add).toStrictEqual(['fooExt#id8']);
+    expect(getExtensionConfig('barSlot', 'fooExt#id8').getState().config).toStrictEqual({
+      bar: 'from-first',
+      baz: 'from-last',
+      'Display conditions': { expression: undefined, privileges: [] },
+      'Translation overrides': {},
+    });
+  });
+
+  it('releases a cross-module configure when the temporary config that set it is cleared', () => {
+    updateConfigExtensionStore('fooExt#id9');
+    temporaryConfigStore.setState({
+      config: { 'other-mod': { extensionSlots: { barSlot: { configure: { 'fooExt#id9': { baz: 'temporary' } } } } } },
+    });
+    expect(getExtensionConfig('barSlot', 'fooExt#id9').getState().config.baz).toBe('temporary');
+
+    // The derived slot config is not part of the extension config cache key, so a released override
+    // is only picked up because that cache also keys on the temporary config it was derived from.
+    temporaryConfigStore.setState({ config: {} });
+    expect(getExtensionConfig('barSlot', 'fooExt#id9').getState().config.baz).toBe('bazzy');
+  });
+
   it('validates the extension configure config, with module config schema', () => {
     updateConfigExtensionStore('fooExt#id1');
     const badConfig = {

package/src/module-config/module-config.ts

@@ -32,12 +32,14 @@ import { type TemporaryConfigStore } from '..';
  * Arrays are replaced entirely (not merged by index), matching the
  * behavior of ramda's mergeDeepRight.
  */
+function replaceArrays(_objValue: unknown, srcValue: unknown) {
+  if (Array.isArray(srcValue)) {
+    return srcValue;
+  }
+}
+
 function mergeDeepReplace<T extends object>(left: T, right: Partial<T>): T {
-  return mergeWith({}, left, right, (_objValue: unknown, srcValue: unknown) => {
-    if (Array.isArray(srcValue)) {
-      return srcValue;
-    }
-  }) as T;
+  return mergeWith({}, left, right, replaceArrays) as T;
 }
 
 /**
@@ -73,8 +75,11 @@ function recomputeAllConfigs() {
   const extensionState = configExtensionStore.getState();
 
   computeModuleConfig(configState, tempConfigState);
-  computeExtensionSlotConfigs(configState, tempConfigState);
-  computeExtensionConfigs(configState, extensionState, tempConfigState);
+
+  const slotConfigs = getExtensionSlotConfigs(configState, tempConfigState);
+  computeExtensionSlotConfigs(slotConfigs);
+  computeExtensionConfigs(configState, extensionState, tempConfigState, slotConfigs);
+
   // Last, because a failure here must not skip the outputs above. Only kept current while the
   // implementer tools are watching it; otherwise derived on read.
   invalidateImplementerToolsConfig();
@@ -185,8 +190,7 @@ function computeModuleConfig(state: ConfigInternalStore, tempState: TemporaryCon
   }
 }
 
-function computeExtensionSlotConfigs(state: ConfigInternalStore, tempState: TemporaryConfigStore) {
-  const slotConfigs = getExtensionSlotConfigs(state, tempState);
+function computeExtensionSlotConfigs(slotConfigs: Record<string, ExtensionSlotConfig>) {
   const slotStore = getExtensionSlotsConfigStore();
   const oldSlots = slotStore.getState().slots;
   const slots: ExtensionSlotsConfigStore['slots'] = {};
@@ -228,6 +232,7 @@ function computeExtensionConfigs(
   configState: ConfigInternalStore,
   extensionState: ConfigExtensionStore,
   tempConfigState: TemporaryConfigStore,
+  slotConfigs: Record<string, ExtensionSlotConfig>,
 ) {
   const extensionsConfigStore = getExtensionsConfigStore();
   const oldConfigs = extensionsConfigStore.getState().configs;
@@ -245,6 +250,7 @@ function computeExtensionConfigs(
       extension.extensionId,
       configState,
       tempConfigState,
+      slotConfigs[extension.slotName],
     );
 
     const previous = oldConfigs[extension.slotName]?.[extension.extensionId];
@@ -555,6 +561,7 @@ const extensionConfigCache = new Map<string, ExtensionConfigCacheEntry>();
  * @param extensionModuleName The name of the module which defines the extension (and therefore the config schema)
  * @param slotName The name of the extension slot where the extension is mounted
  * @param extensionId The ID of the extension in its slot
+ * @param slotConfig The slot's configuration, gathered from every module that configures it
  */
 function computeExtensionConfig(
   slotModuleName: string,
@@ -563,6 +570,7 @@ function computeExtensionConfig(
   extensionId: string,
   configState: ConfigInternalStore,
   tempConfigState: TemporaryConfigStore,
+  slotConfig: ExtensionSlotConfig | undefined,
 ) {
   const extensionName = getExtensionNameFromId(extensionId);
   const extensionConfigSchema = configState.schemas[extensionName];
@@ -582,10 +590,11 @@ function computeExtensionConfig(
 
   const nameOfSchemaSource = extensionConfigSchema ? extensionName : extensionModuleName;
   const providedConfigs = getProvidedConfigs(configState, tempConfigState);
+  const sharedOverride = slotConfig?.configure?.[extensionId] ?? {};
   const slotModuleConfig = mergeConfigsFor(slotModuleName, providedConfigs);
   const configOverride = slotModuleConfig?.extensionSlots?.[slotName]?.configure?.[extensionId] ?? {};
   const extensionConfig = mergeConfigsFor(nameOfSchemaSource, providedConfigs);
-  const combinedConfig = mergeConfigs([extensionConfig, configOverride]);
+  const combinedConfig = mergeConfigs([extensionConfig, sharedOverride, configOverride]);
   const schema = extensionConfigSchema ?? configState.schemas[extensionModuleName];
   validateStructure(schema, combinedConfig, nameOfSchemaSource);
   const config = setDefaults(schema, combinedConfig);
@@ -739,11 +748,30 @@ function getExtensionSlotConfigs(
     },
     {},
   );
+
   validateAllExtensionSlotConfigs(slotConfigPerModule);
-  const slotConfigs = Object.keys(slotConfigPerModule).reduce((obj, key) => {
-    obj = { ...obj, ...slotConfigPerModule[key] };
-    return obj;
-  }, {});
+
+  const slotConfigs: Record<string, ExtensionSlotConfig> = {};
+  const configureBlocks: Record<string, Array<NonNullable<ExtensionSlotConfig['configure']>>> = {};
+
+  for (const configBySlotName of Object.values(slotConfigPerModule)) {
+    for (const [slotName, config] of Object.entries(configBySlotName)) {
+      slotConfigs[slotName] = config;
+
+      if (config.configure) {
+        (configureBlocks[slotName] ??= []).push(config.configure);
+      }
+    }
+  }
+
+  for (const [slotName, blocks] of Object.entries(configureBlocks)) {
+    const configure = blocks.length === 1 ? blocks[0] : (mergeConfigs(blocks) as ExtensionSlotConfig['configure']);
+
+    if (slotConfigs[slotName].configure !== configure) {
+      slotConfigs[slotName] = { ...slotConfigs[slotName], configure };
+    }
+  }
+
   return slotConfigs;
 }
 
@@ -901,8 +929,11 @@ function mergeConfigsFor(moduleName: string, allConfigs: Array<Config>): ConfigO
   return mergeConfigs(allConfigsForModule);
 }
 
+/**
+ * Merges a whole list at once, accumulating into one destination.
+ */
 function mergeConfigs(configs: Array<Config>) {
-  return configs.reduce<Config>((acc, config) => mergeDeepReplace(acc, config), {});
+  return configs.reduce<Config>((acc, config) => mergeWith(acc, config, replaceArrays), {});
 }
 
 /**