@openmrs/esm-api 6.3.1-pre.3204 → 6.3.1-pre.3211

package/.turbo/turbo-build.log

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

package/dist/config-schema.d.ts

@@ -0,0 +1,12 @@
+import { type ConfigSchema } from '@openmrs/esm-config';
+export declare const defaultRedirectAuthFailureUrl = "${openmrsSpaBase}/login";
+export declare const configSchema: ConfigSchema;
+export interface EsmApiConfigObject {
+    redirectAuthFailure: {
+        enabled: boolean;
+        url: string;
+        errors: number[];
+        resolvePromise: boolean;
+    };
+    followRedirects: boolean;
+}

package/dist/config-schema.js

@@ -0,0 +1,42 @@
+import { Type, validators } from "@openmrs/esm-config";
+export const defaultRedirectAuthFailureUrl = '${openmrsSpaBase}/login';
+export const configSchema = {
+    redirectAuthFailure: {
+        enabled: {
+            _type: Type.Boolean,
+            _default: true,
+            _description: 'Whether to redirect logged-out users to `redirectAuthFailure.url`'
+        },
+        url: {
+            _type: Type.String,
+            _default: defaultRedirectAuthFailureUrl,
+            _validators: [
+                validators.isUrl
+            ],
+            _description: 'The url to which users will be redirected when they are logged out. If set to blank, the `location` header from the response will be used.'
+        },
+        errors: {
+            _type: Type.Array,
+            _default: [
+                401
+            ],
+            _elements: {
+                _type: Type.Number,
+                _validators: [
+                    validators.inRange(100, 600)
+                ]
+            },
+            _description: 'The HTTP error codes for which users will be redirected'
+        },
+        resolvePromise: {
+            _type: Type.Boolean,
+            _default: false,
+            _description: "Changes how requests that fail authentication are handled. Try messing with this if redirects to the login page aren't working correctly."
+        }
+    },
+    followRedirects: {
+        _type: Type.Boolean,
+        _default: true,
+        _description: 'Whether openmrsFetch should support redirects returned from the backend'
+    }
+};

package/dist/openmrs-fetch.js

@@ -15,6 +15,7 @@ import { Observable } from "rxjs";
 import { isPlainObject } from "lodash-es";
 import { getConfig } from "@openmrs/esm-config";
 import { clearHistory, navigate } from "@openmrs/esm-navigation";
+import { defaultRedirectAuthFailureUrl } from "./config-schema.js";
 export const restBaseUrl = '/ws/rest/v1';
 export const fhirBaseUrl = '/ws/fhir2/R4';
 export const sessionEndpoint = `${restBaseUrl}/session`;
@@ -136,9 +137,9 @@ export const sessionEndpoint = `${restBaseUrl}/session`;
    */ const requestStacktrace = Error();
     return window.fetch(url, fetchInit).then(async (r)=>{
         const response = r;
+        const { redirectAuthFailure, followRedirects } = await getConfig('@openmrs/esm-api');
         if (response.ok) {
             if (response.status === 204) {
-                const { followRedirects } = await getConfig('@openmrs/esm-api');
                 if (followRedirects && response.headers.has('location')) {
                     const location = response.headers.get('location');
                     if (location) {
@@ -172,11 +173,14 @@ export const sessionEndpoint = `${restBaseUrl}/session`;
        * to help developers understand the problem and debug
        */ /*
        * Redirect to given url when redirect on auth failure is enabled
-       */ const { redirectAuthFailure } = await getConfig('@openmrs/esm-api');
-            if (url === makeUrl(sessionEndpoint) && response.status === 403 || redirectAuthFailure.enabled && redirectAuthFailure.errors.includes(response.status)) {
+       */ if (url === makeUrl(sessionEndpoint) && response.status === 403 || redirectAuthFailure.enabled && redirectAuthFailure.errors.includes(response.status)) {
                 clearHistory();
+                // by default, redirect to the url specified in the config.
+                // If blank, use the location header from the response.
+                // If that is also blank, use the default redirect url.
+                const location = redirectAuthFailure.url || response.headers.get('location') || defaultRedirectAuthFailureUrl;
                 navigate({
-                    to: redirectAuthFailure.url
+                    to: location
                 });
                 /* We sometimes don't really want this promise to resolve since there's no response data,
          * nor do we want it to reject because that would trigger error handling. We instead

package/dist/setup.js

@@ -1,46 +1,9 @@
-import { defineConfigSchema, Type, validators } from "@openmrs/esm-config";
+import { defineConfigSchema } from "@openmrs/esm-config";
 import { refetchCurrentUser } from "./current-user.js";
+import { configSchema } from "./config-schema.js";
 /**
  * @internal
  */ export function setupApiModule() {
-    defineConfigSchema('@openmrs/esm-api', {
-        redirectAuthFailure: {
-            enabled: {
-                _type: Type.Boolean,
-                _default: true,
-                _description: 'Whether to redirect logged-out users to `redirectAuthFailure.url`'
-            },
-            url: {
-                _type: Type.String,
-                _default: '${openmrsSpaBase}/login',
-                _validators: [
-                    validators.isUrl
-                ]
-            },
-            errors: {
-                _type: Type.Array,
-                _default: [
-                    401
-                ],
-                _elements: {
-                    _type: Type.Number,
-                    _validators: [
-                        validators.inRange(100, 600)
-                    ]
-                },
-                _description: 'The HTTP error codes for which users will be redirected'
-            },
-            resolvePromise: {
-                _type: Type.Boolean,
-                _default: false,
-                _description: "Changes how requests that fail authentication are handled. Try messing with this if redirects to the login page aren't working correctly."
-            }
-        },
-        followRedirects: {
-            _type: Type.Boolean,
-            _default: true,
-            _description: 'Whether openmrsFetch should support redirects returned from the backend'
-        }
-    });
+    defineConfigSchema('@openmrs/esm-api', configSchema);
     refetchCurrentUser();
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-api",
-  "version": "6.3.1-pre.3204",
+  "version": "6.3.1-pre.3211",
   "license": "MPL-2.0",
   "description": "The javascript module for interacting with the OpenMRS API",
   "type": "module",
@@ -61,10 +61,10 @@
     "@openmrs/esm-navigation": "6.x"
   },
   "devDependencies": {
-    "@openmrs/esm-config": "6.3.1-pre.3204",
-    "@openmrs/esm-error-handling": "6.3.1-pre.3204",
-    "@openmrs/esm-globals": "6.3.1-pre.3204",
-    "@openmrs/esm-navigation": "6.3.1-pre.3204",
+    "@openmrs/esm-config": "6.3.1-pre.3211",
+    "@openmrs/esm-error-handling": "6.3.1-pre.3211",
+    "@openmrs/esm-globals": "6.3.1-pre.3211",
+    "@openmrs/esm-navigation": "6.3.1-pre.3211",
     "@swc/cli": "^0.7.7",
     "@swc/core": "^1.11.29",
     "concurrently": "^9.1.2",

package/src/config-schema.ts

@@ -0,0 +1,50 @@
+import { type ConfigSchema, Type, validators } from '@openmrs/esm-config';
+
+export const defaultRedirectAuthFailureUrl = '${openmrsSpaBase}/login';
+
+export const configSchema: ConfigSchema = {
+  redirectAuthFailure: {
+    enabled: {
+      _type: Type.Boolean,
+      _default: true,
+      _description: 'Whether to redirect logged-out users to `redirectAuthFailure.url`',
+    },
+    url: {
+      _type: Type.String,
+      _default: defaultRedirectAuthFailureUrl,
+      _validators: [validators.isUrl],
+      _description:
+        'The url to which users will be redirected when they are logged out. If set to blank, the `location` header from the response will be used.',
+    },
+    errors: {
+      _type: Type.Array,
+      _default: [401],
+      _elements: {
+        _type: Type.Number,
+        _validators: [validators.inRange(100, 600)],
+      },
+      _description: 'The HTTP error codes for which users will be redirected',
+    },
+    resolvePromise: {
+      _type: Type.Boolean,
+      _default: false,
+      _description:
+        "Changes how requests that fail authentication are handled. Try messing with this if redirects to the login page aren't working correctly.",
+    },
+  },
+  followRedirects: {
+    _type: Type.Boolean,
+    _default: true,
+    _description: 'Whether openmrsFetch should support redirects returned from the backend',
+  },
+};
+
+export interface EsmApiConfigObject {
+  redirectAuthFailure: {
+    enabled: boolean;
+    url: string;
+    errors: number[];
+    resolvePromise: boolean;
+  };
+  followRedirects: boolean;
+}

package/src/openmrs-fetch.ts

@@ -4,6 +4,7 @@ import { isPlainObject } from 'lodash-es';
 import { getConfig } from '@openmrs/esm-config';
 import { clearHistory, navigate } from '@openmrs/esm-navigation';
 import type { FetchResponse } from './types';
+import { defaultRedirectAuthFailureUrl, type EsmApiConfigObject } from './config-schema';
 
 export const restBaseUrl = '/ws/rest/v1';
 export const fhirBaseUrl = '/ws/fhir2/R4';
@@ -148,9 +149,9 @@ 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) {
-        const { followRedirects } = await getConfig('@openmrs/esm-api');
         if (followRedirects && response.headers.has('location')) {
           const location = response.headers.get('location');
           if (location) {
@@ -190,14 +191,16 @@ export function openmrsFetch<T = any>(path: string, fetchInit: FetchConfig = {})
       /*
        * Redirect to given url when redirect on auth failure is enabled
        */
-      const { redirectAuthFailure } = await getConfig('@openmrs/esm-api');
-
       if (
         (url === makeUrl(sessionEndpoint) && response.status === 403) ||
         (redirectAuthFailure.enabled && redirectAuthFailure.errors.includes(response.status))
       ) {
         clearHistory();
-        navigate({ to: redirectAuthFailure.url });
+        // by default, redirect to the url specified in the config.
+        // If blank, use the location header from the response.
+        // If that is also blank, use the default redirect url.
+        const location = redirectAuthFailure.url || response.headers.get('location') || defaultRedirectAuthFailureUrl;
+        navigate({ to: location });
 
         /* We sometimes don't really want this promise to resolve since there's no response data,
          * nor do we want it to reject because that would trigger error handling. We instead

package/src/setup.ts

@@ -1,44 +1,12 @@
-import { defineConfigSchema, Type, validators } from '@openmrs/esm-config';
+import { defineConfigSchema } from '@openmrs/esm-config';
 import { refetchCurrentUser } from './current-user';
+import { configSchema } from './config-schema';
 
 /**
  * @internal
  */
 export function setupApiModule() {
-  defineConfigSchema('@openmrs/esm-api', {
-    redirectAuthFailure: {
-      enabled: {
-        _type: Type.Boolean,
-        _default: true,
-        _description: 'Whether to redirect logged-out users to `redirectAuthFailure.url`',
-      },
-      url: {
-        _type: Type.String,
-        _default: '${openmrsSpaBase}/login',
-        _validators: [validators.isUrl],
-      },
-      errors: {
-        _type: Type.Array,
-        _default: [401],
-        _elements: {
-          _type: Type.Number,
-          _validators: [validators.inRange(100, 600)],
-        },
-        _description: 'The HTTP error codes for which users will be redirected',
-      },
-      resolvePromise: {
-        _type: Type.Boolean,
-        _default: false,
-        _description:
-          "Changes how requests that fail authentication are handled. Try messing with this if redirects to the login page aren't working correctly.",
-      },
-    },
-    followRedirects: {
-      _type: Type.Boolean,
-      _default: true,
-      _description: 'Whether openmrsFetch should support redirects returned from the backend',
-    },
-  });
+  defineConfigSchema('@openmrs/esm-api', configSchema);
 
   refetchCurrentUser();
 }