npm - @openmrs/esm-routes - Versions diffs - 7.0.1-pre.3258 → 7.0.1-pre.3259 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/.turbo/turbo-build.log CHANGED Viewed

@@ -1,3 +1,3 @@
-[0] Successfully compiled: 9 files with swc (159.68ms)
+[0] Successfully compiled: 9 files with swc (177.22ms)
 [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/pages.d.ts CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -77,7 +77,6 @@ const pages = [];
             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 {
@@ -123,22 +122,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 +143,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 CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-routes",
-  "version": "7.0.1-pre.3258",
+  "version": "7.0.1-pre.3259",
   "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.3259",
+    "@openmrs/esm-dynamic-loading": "7.0.1-pre.3259",
+    "@openmrs/esm-extensions": "7.0.1-pre.3259",
+    "@openmrs/esm-feature-flags": "7.0.1-pre.3259",
+    "@openmrs/esm-globals": "7.0.1-pre.3259",
+    "@openmrs/esm-utils": "7.0.1-pre.3259",
     "@swc/cli": "^0.7.7",
     "@swc/core": "^1.11.29",
     "concurrently": "^9.1.2",

package/src/loaders/pages.ts CHANGED Viewed

@@ -112,7 +112,6 @@ export function registerApp(appName: string, routes: OpenmrsAppRoutes) {
       ) {
         pages.push({
           ...p,
-          order: p.order ?? Number.MAX_SAFE_INTEGER,
           appName,
         });
       } else {
@@ -187,24 +186,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 +210,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);
   }
 }