@openmrs/esm-api 10.0.1-pre.4892 → 10.0.1-pre.4915

package/.turbo/turbo-build.log

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

package/dist/openmrs-fetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"openmrs-fetch.d.ts","sourceRoot":"","sources":["../src/openmrs-fetch.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAIlC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAG7C,mEAAmE;AACnE,eAAO,MAAM,WAAW,gBAAgB,CAAC;AACzC,uEAAuE;AACvE,eAAO,MAAM,WAAW,iBAAiB,CAAC;AAC1C,sDAAsD;AACtD,eAAO,MAAM,eAAe,wBAA2B,CAAC;AAExD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,UASnC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,YAAY,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,GAAE,WAAgB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CA8J1G;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,GAAE,WAAgB,gCA8BjF;AAED,qBAAa,iBAAkB,SAAQ,KAAM,YAAW,UAAU;gBACpD,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,GAAG,IAAI,EAAE,iBAAiB,EAAE,KAAK;IAQxG,QAAQ,EAAE,QAAQ,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,iBAAiB,GAAG,IAAI,CAAC;CACjD;AAED,MAAM,WAAW,WAAY,SAAQ,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IACxE,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,IAAI,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;CAC3B;AAED,KAAK,YAAY,GAAG,MAAM,GAAG,iBAAiB,CAAC;AAE/C,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,UAAU,SAAS;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,QAAQ,CAAC;IACnB,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;CACnC"}
+{"version":3,"file":"openmrs-fetch.d.ts","sourceRoot":"","sources":["../src/openmrs-fetch.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAIlC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAG7C,mEAAmE;AACnE,eAAO,MAAM,WAAW,gBAAgB,CAAC;AACzC,uEAAuE;AACvE,eAAO,MAAM,WAAW,iBAAiB,CAAC;AAC1C,sDAAsD;AACtD,eAAO,MAAM,eAAe,wBAA2B,CAAC;AAExD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,UASnC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAgB,YAAY,CAAC,CAAC,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,GAAE,WAAgB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAuK1G;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,GAAE,WAAgB,gCA8BjF;AAED,qBAAa,iBAAkB,SAAQ,KAAM,YAAW,UAAU;gBACpD,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,GAAG,IAAI,EAAE,iBAAiB,EAAE,KAAK;IAQxG,QAAQ,EAAE,QAAQ,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,iBAAiB,GAAG,IAAI,CAAC;CACjD;AAED,MAAM,WAAW,WAAY,SAAQ,IAAI,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IACxE,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,IAAI,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;CAC3B;AAED,KAAK,YAAY,GAAG,MAAM,GAAG,iBAAiB,CAAC;AAE/C,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,UAAU,SAAS;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,QAAQ,CAAC;IACnB,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;CACnC"}

package/dist/openmrs-fetch.js

@@ -143,15 +143,20 @@ import { defaultRedirectAuthFailureUrl } from "./config-schema.js";
         const response = r;
         const { redirectAuthFailure, followRedirects } = await getConfig('@openmrs/esm-api');
         if (response.ok) {
+            /*
+       * Backend modules can trigger SPA redirects by returning a `Location` header.
+       * This is required because `fetch()` hides HTTP redirects from the application.
+       *
+       * - Session endpoint (2xx): Authentication challenge URLs (e.g. TOTP,2FA).
+       * - HTTP 204: Logout redirect URLs (e.g. Keycloak IdP logout). Refer: OA-41 #1231
+       */ const location = response.headers.get('location');
+            const shouldRedirect = followRedirects && location && (url === makeUrl(sessionEndpoint) || response.status === 204);
+            if (shouldRedirect) {
+                navigate({
+                    to: location
+                });
+            }
             if (response.status === 204) {
-                if (followRedirects && response.headers.has('location')) {
-                    const location = response.headers.get('location');
-                    if (location) {
-                        navigate({
-                            to: location
-                        });
-                    }
-                }
                 /* HTTP 204 - No Content
          * We should not try to download the empty response as json. Instead,
          * we return null since there is no response body.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-api",
-  "version": "10.0.1-pre.4892",
+  "version": "10.0.1-pre.4915",
   "license": "MPL-2.0",
   "description": "The javascript module for interacting with the OpenMRS API",
   "type": "module",
@@ -56,16 +56,16 @@
     "lodash-es": "^4.17.21"
   },
   "peerDependencies": {
-    "@openmrs/esm-config": "^10.0.1-pre.4892",
-    "@openmrs/esm-error-handling": "^10.0.1-pre.4892",
-    "@openmrs/esm-globals": "^10.0.1-pre.4892",
-    "@openmrs/esm-navigation": "^10.0.1-pre.4892"
+    "@openmrs/esm-config": "^10.0.1-pre.4915",
+    "@openmrs/esm-error-handling": "^10.0.1-pre.4915",
+    "@openmrs/esm-globals": "^10.0.1-pre.4915",
+    "@openmrs/esm-navigation": "^10.0.1-pre.4915"
   },
   "devDependencies": {
-    "@openmrs/esm-config": "10.0.1-pre.4892",
-    "@openmrs/esm-error-handling": "10.0.1-pre.4892",
-    "@openmrs/esm-globals": "10.0.1-pre.4892",
-    "@openmrs/esm-navigation": "10.0.1-pre.4892",
+    "@openmrs/esm-config": "10.0.1-pre.4915",
+    "@openmrs/esm-error-handling": "10.0.1-pre.4915",
+    "@openmrs/esm-globals": "10.0.1-pre.4915",
+    "@openmrs/esm-navigation": "10.0.1-pre.4915",
     "@swc/cli": "0.8.1",
     "@swc/core": "1.15.21",
     "@vitest/coverage-v8": "^4.1.2",

package/src/openmrs-fetch.test.ts

@@ -22,6 +22,7 @@ describe('openmrsFetch', () => {
           errors: [401],
           resolvePromise: false,
         },
+        followRedirects: true,
       }),
     );
     window.openmrsBase = '/openmrs';
@@ -131,6 +132,10 @@ describe('openmrsFetch', () => {
       Promise.resolve({
         ok: true,
         status: 200,
+        headers: {
+          has: () => false,
+          get: () => null,
+        },
         clone: () => ({
           text: () => Promise.resolve('{ "value": "hi" }'),
         }),
@@ -148,6 +153,10 @@ describe('openmrsFetch', () => {
       Promise.resolve({
         ok: true,
         status: 204,
+        headers: {
+          has: () => false,
+          get: () => null,
+        },
         json: () => Promise.reject(Error("No json for HTTP 204's!!")),
       }),
     );
@@ -241,6 +250,33 @@ describe('openmrsFetch', () => {
     });
   });
 
+  it('redirects to the Location header URL when session endpoint called and it contains a Location header', async () => {
+    // @ts-expect-error
+    window.fetch.mockReturnValue(
+      Promise.resolve({
+        ok: true,
+        status: 200,
+        statusText: 'OK',
+        headers: {
+          has: (name: string) => name.toLowerCase() === 'location',
+          get: (name: string) => (name.toLowerCase() === 'location' ? '/openmrs/spa/login' : null),
+        },
+        clone() {
+          return this;
+        },
+        text: () => Promise.resolve(''),
+      }),
+    );
+
+    const fetchPromise = openmrsFetch('/ws/rest/v1/session');
+
+    await new Promise((resolve) => setTimeout(resolve, 0));
+
+    expect(mockNavigate).toHaveBeenCalledWith({
+      to: '/openmrs/spa/login',
+    });
+  });
+
   it('redirects to the default login URL when a 401 response has no Location header (genuine auth failure)', async () => {
     mockGetConfig.mockResolvedValueOnce({
       redirectAuthFailure: {
@@ -312,6 +348,10 @@ describe('openmrsObservableFetch', () => {
       Promise.resolve({
         ok: true,
         status: 200,
+        headers: {
+          has: () => false,
+          get: () => null,
+        },
         clone: () => ({
           text: () => Promise.resolve('{"value": "hi"}'),
         }),

package/src/openmrs-fetch.ts

@@ -157,15 +157,24 @@ export function openmrsFetch<T = any>(path: string, fetchInit: FetchConfig = {})
   return window.fetch(url, fetchInit as RequestInit).then(async (r) => {
     const response = r as FetchResponse<T>;
     const { redirectAuthFailure, followRedirects } = await getConfig<EsmApiConfigObject>('@openmrs/esm-api');
+
     if (response.ok) {
-      if (response.status === 204) {
-        if (followRedirects && response.headers.has('location')) {
-          const location = response.headers.get('location');
-          if (location) {
-            navigate({ to: location });
-          }
-        }
+      /*
+       * Backend modules can trigger SPA redirects by returning a `Location` header.
+       * This is required because `fetch()` hides HTTP redirects from the application.
+       *
+       * - Session endpoint (2xx): Authentication challenge URLs (e.g. TOTP,2FA).
+       * - HTTP 204: Logout redirect URLs (e.g. Keycloak IdP logout). Refer: OA-41 #1231
+       */
+      const location = response.headers.get('location');
+      const shouldRedirect =
+        followRedirects && location && (url === makeUrl(sessionEndpoint) || response.status === 204);
 
+      if (shouldRedirect) {
+        navigate({ to: location });
+      }
+
+      if (response.status === 204) {
         /* HTTP 204 - No Content
          * We should not try to download the empty response as json. Instead,
          * we return null since there is no response body.