@openmrs/esm-routes 7.0.1-pre.3258 → 7.0.1-pre.3273

package/.turbo/turbo-build.log

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

package/dist/loaders/components.d.ts

@@ -1,4 +1,4 @@
-import { type FeatureFlagDefinition, type ExtensionDefinition, type ModalDefinition, type WorkspaceDefinition, type WorkspaceGroupDefinition } from '@openmrs/esm-globals';
+import { type FeatureFlagDefinition, type ExtensionDefinition, type ModalDefinition, type WorkspaceDefinition, type WorkspaceGroupDefinition, type WorkspaceGroupDefinition2, type WorkspaceDefinition2, type WorkspaceWindowDefinition2 } from '@openmrs/esm-globals';
 /**
  * This function registers an extension definition with the framework and will
  * attach the extension to any configured slots.
@@ -28,6 +28,9 @@ export declare function tryRegisterWorkspace(appName: string, workspace: Workspa
  * @param workspace An object that describes the workspace, derived from `routes.json`
  */
 export declare function tryRegisterWorkspaceGroup(appName: string, workspaceGroup: WorkspaceGroupDefinition): void;
+export declare function tryRegisterWorkspaceGroups2(appName: string, workspaceGroupDefs: Array<WorkspaceGroupDefinition2>): void;
+export declare function tryRegisterWorkspace2(appName: string, workspaceDefs: Array<WorkspaceDefinition2>): void;
+export declare function tryRegisterWorkspaceWindows2(appName: string, workspaceWindowDefs: Array<WorkspaceWindowDefinition2>): void;
 /**
  * This function registers a feature flag definition with the framework.
  *

package/dist/loaders/components.js

@@ -1,4 +1,4 @@
-import { attach, registerExtension, registerModal, registerWorkspace, registerWorkspaceGroup } from "@openmrs/esm-extensions";
+import { attach, registerExtension, registerModal, registerWorkspace, registerWorkspaceGroup, registerWorkspaceGroups2, registerWorkspaces2, registerWorkspaceWindows2 } from "@openmrs/esm-extensions";
 import { registerFeatureFlag } from "@openmrs/esm-feature-flags";
 import { loadLifeCycles } from "./load-lifecycles.js";
 /**
@@ -128,6 +128,15 @@ To fix this, ensure that you define the "name" field inside the workspace defini
         members: workspaceGroup.members ?? []
     });
 }
+export function tryRegisterWorkspaceGroups2(appName, workspaceGroupDefs) {
+    registerWorkspaceGroups2(workspaceGroupDefs);
+}
+export function tryRegisterWorkspace2(appName, workspaceDefs) {
+    registerWorkspaces2(appName, workspaceDefs);
+}
+export function tryRegisterWorkspaceWindows2(appName, workspaceWindowDefs) {
+    registerWorkspaceWindows2(appName, workspaceWindowDefs);
+}
 /**
  * This function registers a feature flag definition with the framework.
  *

package/dist/loaders/pages.d.ts

@@ -11,10 +11,7 @@ import { type OpenmrsAppRoutes } from '@openmrs/esm-globals';
 export declare function registerApp(appName: string, routes: OpenmrsAppRoutes): void;
 /**
  * This is called by the app shell once all route entries have been processed.
- * This actually registers the pages with the application. This function is
- * necessary to ensure that pages are rendered in the DOM according to their
- * order definition, especially because certain pages _must_ be first in the DOM.
- *
- * Each page is rendered into a div with an appropriate name.
+ * This registers the pages with the application, and creates the root div
+ * for each page in the DOM element specified by the page's containerDomId.
  */
 export declare function finishRegisteringAllApps(): void;

package/dist/loaders/pages.js

@@ -2,7 +2,7 @@ import { pathToActiveWhen, registerApplication } from "single-spa";
 import { registerModuleWithConfigSystem } from "@openmrs/esm-config";
 import { getFeatureFlag } from "@openmrs/esm-feature-flags";
 import { routeRegex } from "./helpers.js";
-import { tryRegisterExtension, tryRegisterFeatureFlag, tryRegisterModal, tryRegisterWorkspace, tryRegisterWorkspaceGroup } from "./components.js";
+import { tryRegisterExtension, tryRegisterFeatureFlag, tryRegisterModal, tryRegisterWorkspace, tryRegisterWorkspace2, tryRegisterWorkspaceGroup, tryRegisterWorkspaceGroups2, tryRegisterWorkspaceWindows2 } from "./components.js";
 import { loadLifeCycles } from "./load-lifecycles.js";
 // this is the global holder of all pages registered in the app
 const pages = [];
@@ -73,11 +73,13 @@ const pages = [];
         const availableWorkspaces = routes.workspaces ?? [];
         const availableWorkspaceGroups = routes.workspaceGroups ?? [];
         const availableFeatureFlags = routes.featureFlags ?? [];
+        const availableWorkspaceGroups2 = routes.workspaceGroups2 ?? [];
+        const availableWorkspaceWindows2 = routes.workspaceWindows2 ?? [];
+        const availableWorkspaces2 = routes.workspaces2 ?? [];
         routes.pages?.forEach((p)=>{
             if (p && typeof p === 'object' && Object.hasOwn(p, 'component') && (Object.hasOwn(p, 'route') || Object.hasOwn(p, 'routeRegex') || Object.hasOwn(p, 'routes'))) {
                 pages.push({
                     ...p,
-                    order: p.order ?? Number.MAX_SAFE_INTEGER,
                     appName
                 });
             } else {
@@ -112,6 +114,9 @@ const pages = [];
                 console.warn(`A workspace group for ${appName} could not be registered as it does not appear to have the required properties`, workspaceGroup);
             }
         });
+        tryRegisterWorkspaceGroups2(appName, availableWorkspaceGroups2);
+        tryRegisterWorkspaceWindows2(appName, availableWorkspaceWindows2);
+        tryRegisterWorkspace2(appName, availableWorkspaces2);
         availableFeatureFlags.forEach((featureFlag)=>{
             if (featureFlag && typeof featureFlag === 'object' && Object.hasOwn(featureFlag, 'flagName')) {
                 tryRegisterFeatureFlag(appName, featureFlag);
@@ -123,22 +128,18 @@ const pages = [];
 }
 /**
  * This is called by the app shell once all route entries have been processed.
- * This actually registers the pages with the application. This function is
- * necessary to ensure that pages are rendered in the DOM according to their
- * order definition, especially because certain pages _must_ be first in the DOM.
- *
- * Each page is rendered into a div with an appropriate name.
+ * This registers the pages with the application, and creates the root div
+ * for each page in the DOM element specified by the page's containerDomId.
  */ export function finishRegisteringAllApps() {
     pages.sort((a, b)=>{
-        let sort = a.order - b.order;
-        if (sort != 0) {
-            return sort;
-        }
         return a.appName.localeCompare(b.appName, 'en');
     });
-    // Create a div for each page. This ensures their DOM order.
+    // Create a div for each page, unless the DOM already contains the div with
+    // the expected id for the page to be mounted on. See:
+    // https://single-spa.js.org/docs/configuration/#two-registered-applications-simultaneously
+    // The div is put inside the DOM element specified by the page's containerDomId.
     // If we don't do this, Single-SPA 5 will create the DOM element only once
-    // the page becomes active, which makes it impossible to guarantee order.
+    // the page becomes active, at the end of <body>.
     let appIndices = new Map();
     for (let page of pages){
         if (!appIndices.has(page.appName)) {
@@ -148,9 +149,16 @@ const pages = [];
         }
         const index = appIndices.get(page.appName);
         const name = `${page.appName}-page-${index}`;
-        const div = document.createElement('div');
-        div.id = `single-spa-application:${name}`;
-        document.body.appendChild(div);
+        const containerDomId = page.containerDomId ?? 'omrs-apps-container';
+        const containerDiv = document.getElementById(containerDomId);
+        const appDomRootId = `single-spa-application:${name}`;
+        if (containerDiv) {
+            const div = document.createElement('div');
+            div.id = appDomRootId;
+            containerDiv?.appendChild(div);
+        } else {
+            throw new Error(`${page.appName} ${page.component} cannot be mounted to "${containerDomId}"; DOM element does not exist.`);
+        }
         tryRegisterPage(name, page);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-routes",
-  "version": "7.0.1-pre.3258",
+  "version": "7.0.1-pre.3273",
   "license": "MPL-2.0",
   "description": "Utilities for working with the routes registry",
   "type": "module",
@@ -54,12 +54,12 @@
     "single-spa": "6.x"
   },
   "devDependencies": {
-    "@openmrs/esm-config": "7.0.1-pre.3258",
-    "@openmrs/esm-dynamic-loading": "7.0.1-pre.3258",
-    "@openmrs/esm-extensions": "7.0.1-pre.3258",
-    "@openmrs/esm-feature-flags": "7.0.1-pre.3258",
-    "@openmrs/esm-globals": "7.0.1-pre.3258",
-    "@openmrs/esm-utils": "7.0.1-pre.3258",
+    "@openmrs/esm-config": "7.0.1-pre.3273",
+    "@openmrs/esm-dynamic-loading": "7.0.1-pre.3273",
+    "@openmrs/esm-extensions": "7.0.1-pre.3273",
+    "@openmrs/esm-feature-flags": "7.0.1-pre.3273",
+    "@openmrs/esm-globals": "7.0.1-pre.3273",
+    "@openmrs/esm-utils": "7.0.1-pre.3273",
     "@swc/cli": "^0.7.7",
     "@swc/core": "^1.11.29",
     "concurrently": "^9.1.2",

package/src/loaders/components.ts

@@ -4,6 +4,9 @@ import {
   registerModal,
   registerWorkspace,
   registerWorkspaceGroup,
+  registerWorkspaceGroups2,
+  registerWorkspaces2,
+  registerWorkspaceWindows2,
 } from '@openmrs/esm-extensions';
 import {
   type FeatureFlagDefinition,
@@ -11,6 +14,9 @@ import {
   type ModalDefinition,
   type WorkspaceDefinition,
   type WorkspaceGroupDefinition,
+  type WorkspaceGroupDefinition2,
+  type WorkspaceDefinition2,
+  type WorkspaceWindowDefinition2,
 } from '@openmrs/esm-globals';
 import { registerFeatureFlag } from '@openmrs/esm-feature-flags';
 import { loadLifeCycles } from './load-lifecycles';
@@ -183,6 +189,18 @@ To fix this, ensure that you define the "name" field inside the workspace defini
   });
 }
 
+export function tryRegisterWorkspaceGroups2(appName: string, workspaceGroupDefs: Array<WorkspaceGroupDefinition2>) {
+  registerWorkspaceGroups2(workspaceGroupDefs);
+}
+
+export function tryRegisterWorkspace2(appName: string, workspaceDefs: Array<WorkspaceDefinition2>) {
+  registerWorkspaces2(appName, workspaceDefs);
+}
+
+export function tryRegisterWorkspaceWindows2(appName: string, workspaceWindowDefs: Array<WorkspaceWindowDefinition2>) {
+  registerWorkspaceWindows2(appName, workspaceWindowDefs);
+}
+
 /**
  * This function registers a feature flag definition with the framework.
  *

package/src/loaders/pages.ts

@@ -17,7 +17,10 @@ import {
   tryRegisterFeatureFlag,
   tryRegisterModal,
   tryRegisterWorkspace,
+  tryRegisterWorkspace2,
   tryRegisterWorkspaceGroup,
+  tryRegisterWorkspaceGroups2,
+  tryRegisterWorkspaceWindows2,
 } from './components';
 import { loadLifeCycles } from './load-lifecycles';
 
@@ -102,6 +105,9 @@ export function registerApp(appName: string, routes: OpenmrsAppRoutes) {
     const availableWorkspaces: Array<WorkspaceDefinition> = routes.workspaces ?? [];
     const availableWorkspaceGroups: Array<WorkspaceGroupDefinition> = routes.workspaceGroups ?? [];
     const availableFeatureFlags: Array<FeatureFlagDefinition> = routes.featureFlags ?? [];
+    const availableWorkspaceGroups2 = routes.workspaceGroups2 ?? [];
+    const availableWorkspaceWindows2 = routes.workspaceWindows2 ?? [];
+    const availableWorkspaces2 = routes.workspaces2 ?? [];
 
     routes.pages?.forEach((p) => {
       if (
@@ -112,7 +118,6 @@ export function registerApp(appName: string, routes: OpenmrsAppRoutes) {
       ) {
         pages.push({
           ...p,
-          order: p.order ?? Number.MAX_SAFE_INTEGER,
           appName,
         });
       } else {
@@ -171,6 +176,9 @@ export function registerApp(appName: string, routes: OpenmrsAppRoutes) {
         );
       }
     });
+    tryRegisterWorkspaceGroups2(appName, availableWorkspaceGroups2);
+    tryRegisterWorkspaceWindows2(appName, availableWorkspaceWindows2);
+    tryRegisterWorkspace2(appName, availableWorkspaces2);
 
     availableFeatureFlags.forEach((featureFlag) => {
       if (featureFlag && typeof featureFlag === 'object' && Object.hasOwn(featureFlag, 'flagName')) {
@@ -187,24 +195,20 @@ export function registerApp(appName: string, routes: OpenmrsAppRoutes) {
 
 /**
  * This is called by the app shell once all route entries have been processed.
- * This actually registers the pages with the application. This function is
- * necessary to ensure that pages are rendered in the DOM according to their
- * order definition, especially because certain pages _must_ be first in the DOM.
- *
- * Each page is rendered into a div with an appropriate name.
+ * This registers the pages with the application, and creates the root div
+ * for each page in the DOM element specified by the page's containerDomId.
  */
 export function finishRegisteringAllApps() {
   pages.sort((a, b) => {
-    let sort = a.order - b.order;
-    if (sort != 0) {
-      return sort;
-    }
     return a.appName.localeCompare(b.appName, 'en');
   });
 
-  // Create a div for each page. This ensures their DOM order.
+  // Create a div for each page, unless the DOM already contains the div with
+  // the expected id for the page to be mounted on. See:
+  // https://single-spa.js.org/docs/configuration/#two-registered-applications-simultaneously
+  // The div is put inside the DOM element specified by the page's containerDomId.
   // If we don't do this, Single-SPA 5 will create the DOM element only once
-  // the page becomes active, which makes it impossible to guarantee order.
+  // the page becomes active, at the end of <body>.
   let appIndices = new Map();
   for (let page of pages) {
     if (!appIndices.has(page.appName)) {
@@ -215,9 +219,19 @@ export function finishRegisteringAllApps() {
     const index = appIndices.get(page.appName);
 
     const name = `${page.appName}-page-${index}`;
-    const div = document.createElement('div');
-    div.id = `single-spa-application:${name}`;
-    document.body.appendChild(div);
+    const containerDomId = page.containerDomId ?? 'omrs-apps-container';
+    const containerDiv = document.getElementById(containerDomId);
+    const appDomRootId = `single-spa-application:${name}`;
+
+    if (containerDiv) {
+      const div = document.createElement('div');
+      div.id = appDomRootId;
+      containerDiv?.appendChild(div);
+    } else {
+      throw new Error(
+        `${page.appName} ${page.component} cannot be mounted to "${containerDomId}"; DOM element does not exist.`,
+      );
+    }
     tryRegisterPage(name, page);
   }
 }