@openmrs/esm-styleguide 10.0.1-pre.5199 → 10.0.1-pre.5240

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-[0] Successfully compiled: 123 files, copied 167 files with swc (298.76ms)
+[0] Successfully compiled: 123 files, copied 167 files with swc (273.27ms)
 [0] swc --strip-leading-paths --copy-files src -d dist && svgo -rf dist --quiet exited with code 0
 [1] tsc --project tsconfig.build.json exited with code 0

package/dist/workspaces2/scope-utils.d.ts

@@ -1,7 +1,7 @@
 /**
  * Determines whether workspaces should close based on a scope pattern and URL change.
  *
- * @param scopePattern - A regex pattern defining the scope. May include capture groups.
+ * @param scopePattern - A regex pattern matched against the SPA-relative pathname. May include capture groups.
  * @param oldUrl - The URL being navigated away from.
  * @param newUrl - The URL being navigated to.
  * @returns `true` if the workspace should close, `false` if it should stay open.

package/dist/workspaces2/scope-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scope-utils.d.ts","sourceRoot":"","sources":["../../src/workspaces2/scope-utils.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CA0BpG"}
+{"version":3,"file":"scope-utils.d.ts","sourceRoot":"","sources":["../../src/workspaces2/scope-utils.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAqCpG"}

package/dist/workspaces2/scope-utils.js

@@ -1,17 +1,27 @@
 /**
  * Determines whether workspaces should close based on a scope pattern and URL change.
  *
- * @param scopePattern - A regex pattern defining the scope. May include capture groups.
+ * @param scopePattern - A regex pattern matched against the SPA-relative pathname. May include capture groups.
  * @param oldUrl - The URL being navigated away from.
  * @param newUrl - The URL being navigated to.
  * @returns `true` if the workspace should close, `false` if it should stay open.
  */ export function shouldCloseOnUrlChange(scopePattern, oldUrl, newUrl) {
     try {
-        const oldPathname = new URL(oldUrl, window.location.origin).pathname;
-        const newPathname = new URL(newUrl, window.location.origin).pathname;
         const regex = new RegExp(scopePattern);
-        const oldMatch = oldPathname.match(regex);
-        const newMatch = newPathname.match(regex);
+        const oldPathnames = getPathnames(oldUrl);
+        const newPathnames = getPathnames(newUrl);
+        if (oldPathnames.spaRelative === null || newPathnames.spaRelative === null) {
+            return true;
+        }
+        // scopePattern is defined against the SPA-relative pathname. Fall back to
+        // the full pathnames when the relative pathnames don't both match, so that
+        // patterns containing the SPA base path also work.
+        let oldMatch = regex.exec(oldPathnames.spaRelative);
+        let newMatch = regex.exec(newPathnames.spaRelative);
+        if (!oldMatch || !newMatch) {
+            oldMatch = regex.exec(oldPathnames.full);
+            newMatch = regex.exec(newPathnames.full);
+        }
         if (!oldMatch || !newMatch) {
             // One or both URLs don't match the pattern - close workspace
             return true;
@@ -28,3 +38,20 @@
         return true;
     }
 }
+function getPathnames(url) {
+    const full = new URL(url, window.location.origin).pathname;
+    const spaBasePathname = new URL(window.getOpenmrsSpaBase?.() ?? '/', window.location.origin).pathname;
+    const spaBase = spaBasePathname.endsWith('/') ? spaBasePathname.slice(0, -1) : spaBasePathname;
+    let spaRelative = null;
+    if (!spaBase) {
+        spaRelative = full;
+    } else if (spaBase === full) {
+        spaRelative = '/';
+    } else if (full.startsWith(`${spaBase}/`)) {
+        spaRelative = full.slice(spaBase.length);
+    }
+    return {
+        full,
+        spaRelative
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-styleguide",
-  "version": "10.0.1-pre.5199",
+  "version": "10.0.1-pre.5240",
   "license": "MPL-2.0",
   "description": "The styleguide for OpenMRS SPA",
   "module": "dist/internal.js",
@@ -77,18 +77,18 @@
     "react-aria-components": "^1.7.1"
   },
   "peerDependencies": {
-    "@openmrs/esm-api": "^10.0.1-pre.5199",
-    "@openmrs/esm-config": "^10.0.1-pre.5199",
-    "@openmrs/esm-emr-api": "^10.0.1-pre.5199",
-    "@openmrs/esm-error-handling": "^10.0.1-pre.5199",
-    "@openmrs/esm-extensions": "^10.0.1-pre.5199",
-    "@openmrs/esm-globals": "^10.0.1-pre.5199",
-    "@openmrs/esm-navigation": "^10.0.1-pre.5199",
-    "@openmrs/esm-react-utils": "^10.0.1-pre.5199",
-    "@openmrs/esm-routes": "^10.0.1-pre.5199",
-    "@openmrs/esm-state": "^10.0.1-pre.5199",
-    "@openmrs/esm-translations": "^10.0.1-pre.5199",
-    "@openmrs/esm-utils": "^10.0.1-pre.5199",
+    "@openmrs/esm-api": "^10.0.1-pre.5240",
+    "@openmrs/esm-config": "^10.0.1-pre.5240",
+    "@openmrs/esm-emr-api": "^10.0.1-pre.5240",
+    "@openmrs/esm-error-handling": "^10.0.1-pre.5240",
+    "@openmrs/esm-extensions": "^10.0.1-pre.5240",
+    "@openmrs/esm-globals": "^10.0.1-pre.5240",
+    "@openmrs/esm-navigation": "^10.0.1-pre.5240",
+    "@openmrs/esm-react-utils": "^10.0.1-pre.5240",
+    "@openmrs/esm-routes": "^10.0.1-pre.5240",
+    "@openmrs/esm-state": "^10.0.1-pre.5240",
+    "@openmrs/esm-translations": "^10.0.1-pre.5240",
+    "@openmrs/esm-utils": "^10.0.1-pre.5240",
     "dayjs": "1.x",
     "i18next": "25.x",
     "react": "18.x",
@@ -98,18 +98,18 @@
     "swr": "2.x"
   },
   "devDependencies": {
-    "@openmrs/esm-api": "10.0.1-pre.5199",
-    "@openmrs/esm-config": "10.0.1-pre.5199",
-    "@openmrs/esm-emr-api": "10.0.1-pre.5199",
-    "@openmrs/esm-error-handling": "10.0.1-pre.5199",
-    "@openmrs/esm-extensions": "10.0.1-pre.5199",
-    "@openmrs/esm-globals": "10.0.1-pre.5199",
-    "@openmrs/esm-navigation": "10.0.1-pre.5199",
-    "@openmrs/esm-react-utils": "10.0.1-pre.5199",
-    "@openmrs/esm-routes": "10.0.1-pre.5199",
-    "@openmrs/esm-state": "10.0.1-pre.5199",
-    "@openmrs/esm-translations": "10.0.1-pre.5199",
-    "@openmrs/esm-utils": "10.0.1-pre.5199",
+    "@openmrs/esm-api": "10.0.1-pre.5240",
+    "@openmrs/esm-config": "10.0.1-pre.5240",
+    "@openmrs/esm-emr-api": "10.0.1-pre.5240",
+    "@openmrs/esm-error-handling": "10.0.1-pre.5240",
+    "@openmrs/esm-extensions": "10.0.1-pre.5240",
+    "@openmrs/esm-globals": "10.0.1-pre.5240",
+    "@openmrs/esm-navigation": "10.0.1-pre.5240",
+    "@openmrs/esm-react-utils": "10.0.1-pre.5240",
+    "@openmrs/esm-routes": "10.0.1-pre.5240",
+    "@openmrs/esm-state": "10.0.1-pre.5240",
+    "@openmrs/esm-translations": "10.0.1-pre.5240",
+    "@openmrs/esm-utils": "10.0.1-pre.5240",
     "@swc/cli": "0.8.1",
     "@swc/core": "1.15.21",
     "@types/geopattern": "^1.2.9",

package/src/workspaces2/scope-utils.test.ts

@@ -127,6 +127,116 @@ describe('shouldCloseOnUrlChange', () => {
     ],
     ['closes: relative URLs leaving scope', '^/home/appointments', '/home/appointments', '/home/service-queues', true],
   ])('%s', (_desc, pattern, oldUrl, newUrl, expected) => {
-    expect(shouldCloseOnUrlChange(pattern, oldUrl, newUrl)).toBe(expected);
+    withSpaBase('/', () => {
+      expect(shouldCloseOnUrlChange(pattern, oldUrl, newUrl)).toBe(expected);
+    });
+  });
+
+  it.each([
+    [
+      'stays open: navigation from the exact SPA base remains in a root scope',
+      '^/',
+      'http://localhost/openmrs/spa',
+      'http://localhost/openmrs/spa/home',
+      false,
+    ],
+    [
+      'stays open: same patient under the configured SPA base',
+      '^/patient/([^/]+)/chart(?:/|$)',
+      'http://localhost/openmrs/spa/patient/abc-123/chart/vitals',
+      'http://localhost/openmrs/spa/patient/abc-123/chart/conditions',
+      false,
+    ],
+    [
+      'closes: different patient under the configured SPA base',
+      '^/patient/([^/]+)/chart(?:/|$)',
+      'http://localhost/openmrs/spa/patient/abc-123/chart/vitals',
+      'http://localhost/openmrs/spa/patient/def-456/chart/vitals',
+      true,
+    ],
+    [
+      'closes: route only shares the SPA base as a string prefix',
+      '^/patient/([^/]+)/chart(?:/|$)',
+      'http://localhost/openmrs/spa2/patient/abc-123/chart/vitals',
+      'http://localhost/openmrs/spa2/patient/abc-123/chart/conditions',
+      true,
+    ],
+    [
+      'closes: navigation leaves the configured SPA base',
+      '^/patient/([^/]+)/chart(?:/|$)',
+      'http://localhost/openmrs/spa/patient/abc-123/chart/vitals',
+      'http://localhost/patient/abc-123/chart/conditions',
+      true,
+    ],
+    [
+      'closes: route only shares the patient chart prefix',
+      '^/patient/([^/]+)/chart(?:/|$)',
+      'http://localhost/openmrs/spa/patient/abc-123/chart',
+      'http://localhost/openmrs/spa/patient/abc-123/chart-extra',
+      true,
+    ],
+    [
+      'stays open: legacy pattern includes the configured SPA base',
+      '^/openmrs/spa/patient/([^/]+)/chart(?:/|$)',
+      'http://localhost/openmrs/spa/patient/abc-123/chart/vitals',
+      'http://localhost/openmrs/spa/patient/abc-123/chart/conditions',
+      false,
+    ],
+    [
+      'stays open: legacy pattern matches both full pathnames when only one relative pathname matches',
+      '^/openmrs',
+      'http://localhost/openmrs/spa/home',
+      'http://localhost/openmrs/spa/openmrs-lab',
+      false,
+    ],
+    [
+      'closes: legacy pattern captures a different patient',
+      '^/openmrs/spa/patient/([^/]+)/chart(?:/|$)',
+      'http://localhost/openmrs/spa/patient/abc-123/chart/vitals',
+      'http://localhost/openmrs/spa/patient/def-456/chart/vitals',
+      true,
+    ],
+  ])('%s', (_desc, pattern, oldUrl, newUrl, expected) => {
+    withSpaBase('/openmrs/spa/', () => {
+      expect(shouldCloseOnUrlChange(pattern, oldUrl, newUrl)).toBe(expected);
+    });
+  });
+
+  it('matches against full pathnames when getOpenmrsSpaBase is not defined', () => {
+    const originalGetOpenmrsSpaBase = window.getOpenmrsSpaBase;
+    // @ts-expect-error simulating an environment without the app shell globals
+    delete window.getOpenmrsSpaBase;
+
+    try {
+      expect(shouldCloseOnUrlChange('^/home/appointments', '/home/appointments', '/home/appointments/details')).toBe(
+        false,
+      );
+      expect(shouldCloseOnUrlChange('^/home/appointments', '/home/appointments', '/home/service-queues')).toBe(true);
+    } finally {
+      window.getOpenmrsSpaBase = originalGetOpenmrsSpaBase;
+    }
+  });
+
+  it('matches against a custom SPA base', () => {
+    withSpaBase('/custom/spa/', () => {
+      expect(
+        shouldCloseOnUrlChange(
+          '^/patient/([^/]+)/chart(?:/|$)',
+          '/custom/spa/patient/abc-123/chart/vitals',
+          '/custom/spa/patient/abc-123/chart/conditions',
+        ),
+      ).toBe(false);
+    });
   });
 });
+
+function withSpaBase<T>(spaBase: string, callback: () => T): T {
+  const originalGetOpenmrsSpaBase = window.getOpenmrsSpaBase;
+  window.getOpenmrsSpaBase = () => spaBase;
+
+  try {
+    return callback();
+  } finally {
+    window.getOpenmrsSpaBase = originalGetOpenmrsSpaBase;
+  }
+}

package/src/workspaces2/scope-utils.ts

@@ -1,19 +1,30 @@
 /**
  * Determines whether workspaces should close based on a scope pattern and URL change.
  *
- * @param scopePattern - A regex pattern defining the scope. May include capture groups.
+ * @param scopePattern - A regex pattern matched against the SPA-relative pathname. May include capture groups.
  * @param oldUrl - The URL being navigated away from.
  * @param newUrl - The URL being navigated to.
  * @returns `true` if the workspace should close, `false` if it should stay open.
  */
 export function shouldCloseOnUrlChange(scopePattern: string, oldUrl: string, newUrl: string): boolean {
   try {
-    const oldPathname = new URL(oldUrl, window.location.origin).pathname;
-    const newPathname = new URL(newUrl, window.location.origin).pathname;
     const regex = new RegExp(scopePattern);
+    const oldPathnames = getPathnames(oldUrl);
+    const newPathnames = getPathnames(newUrl);
 
-    const oldMatch = oldPathname.match(regex);
-    const newMatch = newPathname.match(regex);
+    if (oldPathnames.spaRelative === null || newPathnames.spaRelative === null) {
+      return true;
+    }
+
+    // scopePattern is defined against the SPA-relative pathname. Fall back to
+    // the full pathnames when the relative pathnames don't both match, so that
+    // patterns containing the SPA base path also work.
+    let oldMatch = regex.exec(oldPathnames.spaRelative);
+    let newMatch = regex.exec(newPathnames.spaRelative);
+    if (!oldMatch || !newMatch) {
+      oldMatch = regex.exec(oldPathnames.full);
+      newMatch = regex.exec(newPathnames.full);
+    }
 
     if (!oldMatch || !newMatch) {
       // One or both URLs don't match the pattern - close workspace
@@ -33,3 +44,20 @@ export function shouldCloseOnUrlChange(scopePattern: string, oldUrl: string, new
     return true;
   }
 }
+
+function getPathnames(url: string) {
+  const full = new URL(url, window.location.origin).pathname;
+  const spaBasePathname = new URL(window.getOpenmrsSpaBase?.() ?? '/', window.location.origin).pathname;
+  const spaBase = spaBasePathname.endsWith('/') ? spaBasePathname.slice(0, -1) : spaBasePathname;
+  let spaRelative: string | null = null;
+
+  if (!spaBase) {
+    spaRelative = full;
+  } else if (spaBase === full) {
+    spaRelative = '/';
+  } else if (full.startsWith(`${spaBase}/`)) {
+    spaRelative = full.slice(spaBase.length);
+  }
+
+  return { full, spaRelative };
+}