@openmrs/esm-api 10.0.1-pre.5607 → 10.0.1-pre.5616

package/.turbo/turbo-build.log

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

package/dist/current-user.d.ts

@@ -7,6 +7,8 @@ export type LoadedSessionStore = {
 export type UnloadedSessionStore = {
     loaded: false;
     session: null;
+    /** Set when fetching the session failed before any session had loaded. */
+    error?: Error;
 };
 /** @internal */
 export declare const sessionStore: import("zustand").StoreApi<SessionStore>;
@@ -15,7 +17,8 @@ export declare const sessionStore: import("zustand").StoreApi<SessionStore>;
  * current user's session. If the session hasn't been loaded, was loaded more than
  * a minute ago, or is in the middle of being refetched, the Promise waits for the
  * fetch in question rather than resolving with data that may be out of date. The
- * session it resolves with is therefore never more than a minute old.
+ * session it resolves with is therefore never more than a minute old, unless that fetch fails,
+ * in which case it resolves with the last session that loaded.
  *
  * The function accepts an optional `opts` object with an `includeAuthStatus` boolean
  * property that defaults to `true`. When `true`, the entire {@link Session} object
@@ -94,7 +97,12 @@ export declare function setUserLanguage(data: Session): void;
  * the user. All subscribers to the session store will be notified of the
  * new user once the new version of the user object is downloaded.
  *
- * @returns A Promise resolving to the updated session store state.
+ * If the server rejects the request as unauthenticated (401 or 403), the store records a
+ * logged-out session. If the request fails for any other reason, a session that has already
+ * loaded is kept; otherwise the store records the error.
+ *
+ * @returns A Promise resolving to the updated session store state. It rejects with the
+ *   store state if the request fails for a reason other than authentication.
  *
  * @example
  * ```js
@@ -189,7 +197,25 @@ export declare function getSessionLocation(): Promise<SessionLocation | undefine
  * await setSessionLocation('location-uuid-here', abortController);
  * ```
  */
-export declare function setSessionLocation(locationUuid: string, abortController: AbortController): Promise<any>;
+export declare function setSessionLocation(locationUuid: string, abortController?: AbortController): Promise<any>;
+/**
+ * Sets the locale for the current session only, leaving the user's default locale unchanged.
+ * Use {@link setUserProperties} with a `defaultLocale` property to change the default instead.
+ *
+ * @param locale The locale in Java's `Locale#toString()` form, e.g. `en_GB`.
+ * @param abortController Optional AbortController to allow cancellation of the request.
+ * @returns A Promise that resolves with the updated SessionStore after refetching the current user.
+ *   It rejects with an {@link OpenmrsFetchError} if the server does not accept the locale.
+ *
+ * @example
+ * ```ts
+ * import { setSessionLocale } from '@openmrs/esm-api';
+ * await setSessionLocale('fr');
+ * ```
+ *
+ * @internal
+ */
+export declare function setSessionLocale(locale: string, abortController?: AbortController): Promise<SessionStore>;
 /**
  * Updates the user properties for a specific user. User properties are key-value
  * pairs that store user-specific settings and preferences. After updating the
@@ -216,4 +242,40 @@ export declare function setSessionLocation(locationUuid: string, abortController
 export declare function setUserProperties(userUuid: string, userProperties: {
     [x: string]: string;
 }, abortController?: AbortController): Promise<SessionStore>;
+/**
+ * Submits a TOTP code to complete a two-factor login challenge. When the code is accepted, the
+ * session store is refreshed with the now-authenticated session.
+ *
+ * @param code The code from the user's authenticator app.
+ * @param rememberDevice Whether the server should skip the challenge on this device in future.
+ * @returns A Promise resolving to the session. Its `authenticated` property is `false` if the
+ *   code was not accepted. It rejects with an {@link OpenmrsFetchError} if the server rejects the
+ *   request, in which case `responseBody` may explain why.
+ *
+ * @example
+ * ```ts
+ * import { verifyTotpCode } from '@openmrs/esm-api';
+ * const session = await verifyTotpCode('123456', true);
+ * ```
+ *
+ * @internal
+ */
+export declare function verifyTotpCode(code: string, rememberDevice?: boolean): Promise<Session>;
+/**
+ * Ends the current session on the server and records a logged-out session in the session store.
+ * A server that has already ended the session (401 or 403) counts as a successful logout.
+ *
+ * Other data cached for the logged-in user, such as SWR caches, is the caller's to clear.
+ *
+ * @returns A Promise that resolves once the session store holds a logged-out session.
+ *
+ * @example
+ * ```ts
+ * import { logout } from '@openmrs/esm-api';
+ * await logout();
+ * ```
+ *
+ * @internal
+ */
+export declare function logout(): Promise<void>;
 //# sourceMappingURL=current-user.d.ts.map

package/dist/current-user.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"current-user.d.ts","sourceRoot":"","sources":["../src/current-user.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAiB,MAAM,SAAS,CAAC;AAEtG,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;AAErE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,KAAK,CAAC;IACd,OAAO,EAAE,IAAI,CAAC;CACf,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,YAAY,0CAGvB,CAAC;AAoCH;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,iBAAS,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;AAC5C;;;;;GAKG;AACH,iBAAS,cAAc,CAAC,IAAI,EAAE;IAAE,iBAAiB,EAAE,IAAI,CAAA;CAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAC7E;;;;;GAKG;AACH,iBAAS,cAAc,CAAC,IAAI,EAAE;IAAE,iBAAiB,EAAE,KAAK,CAAA;CAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAmBnF,OAAO,EAAE,cAAc,EAAE,CAAC;AAE1B;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,eAAe,6CAG9B;AAiBD;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,OAAO,QAc5C;AAwBD;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,yBAwBtE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,SAK/B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,aAAa,CAC3B,iBAAiB,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,EACzC,IAAI,EAAE;IAAE,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;CAAE,WAa3D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,0BAmB9B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,kBAAkB,IAAI,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC,CAG/E;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,CAW7G;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,iBAAiB,CACrC,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE;IACd,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACrB,EACD,eAAe,CAAC,EAAE,eAAe,GAChC,OAAO,CAAC,YAAY,CAAC,CAcvB"}
+{"version":3,"file":"current-user.d.ts","sourceRoot":"","sources":["../src/current-user.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAiB,MAAM,SAAS,CAAC;AAEtG,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;AAErE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,KAAK,CAAC;IACd,OAAO,EAAE,IAAI,CAAC;IACd,0EAA0E;IAC1E,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,YAAY,0CAGvB,CAAC;AAoCH;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,iBAAS,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;AAC5C;;;;;GAKG;AACH,iBAAS,cAAc,CAAC,IAAI,EAAE;IAAE,iBAAiB,EAAE,IAAI,CAAA;CAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAC7E;;;;;GAKG;AACH,iBAAS,cAAc,CAAC,IAAI,EAAE;IAAE,iBAAiB,EAAE,KAAK,CAAA;CAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAyBnF,OAAO,EAAE,cAAc,EAAE,CAAC;AAE1B;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,eAAe,6CAG9B;AAiBD;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,OAAO,QAc5C;AAwBD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,yBAyBtE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,SAQ/B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,aAAa,CAC3B,iBAAiB,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,EACzC,IAAI,EAAE;IAAE,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;CAAE,WAa3D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,0BAmB9B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,kBAAkB,IAAI,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC,CAG/E;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,kBAAkB,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC,CAY9G;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,CAW/G;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,iBAAiB,CACrC,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE;IACd,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACrB,EACD,eAAe,CAAC,EAAE,eAAe,GAChC,OAAO,CAAC,YAAY,CAAC,CAcvB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,cAAc,UAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,CAiB3F;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAY5C"}

package/dist/current-user.js

@@ -1,7 +1,7 @@
 /** @module @category API */ import { reportError } from "@openmrs/esm-error-handling";
 import { createGlobalStore } from "@openmrs/esm-state";
 import { isUndefined } from "lodash-es";
-import { openmrsFetch, restBaseUrl, sessionEndpoint } from "./openmrs-fetch.js";
+import { OpenmrsFetchError, openmrsFetch, restBaseUrl, sessionEndpoint } from "./openmrs-fetch.js";
 /** @internal */ export const sessionStore = createGlobalStore('session', {
     loaded: false,
     session: null
@@ -36,16 +36,22 @@ let inFlightRefresh = null;
 function getCurrentUser(opts) {
     const includeAuthStatus = opts?.includeAuthStatus ?? true;
     const select = (session)=>includeAuthStatus ? session : session.user;
-    if (!refreshSessionIfStale()) {
+    const refresh = refreshSessionIfStale();
+    if (!refresh) {
         return Promise.resolve(select(sessionStore.getState().session));
     }
     return new Promise((resolve)=>{
-        const unsubscribe = sessionStore.subscribe((state)=>{
+        const resolveIfLoaded = ()=>{
+            const state = sessionStore.getState();
             if (state.loaded) {
                 unsubscribe();
                 resolve(select(state.session));
             }
-        });
+        };
+        const unsubscribe = sessionStore.subscribe(resolveIfLoaded);
+        // A failed refresh keeps an already-loaded session without updating the store, so the
+        // subscription alone would never fire.
+        refresh.then(resolveIfLoaded, resolveIfLoaded);
     });
 }
 export { getCurrentUser };
@@ -128,7 +134,12 @@ function isSuperUser(user) {
  * the user. All subscribers to the session store will be notified of the
  * new user once the new version of the user object is downloaded.
  *
- * @returns A Promise resolving to the updated session store state.
+ * If the server rejects the request as unauthenticated (401 or 403), the store records a
+ * logged-out session. If the request fails for any other reason, a session that has already
+ * loaded is kept; otherwise the store records the error.
+ *
+ * @returns A Promise resolving to the updated session store state. It rejects with the
+ *   store state if the request fails for a reason other than authentication.
  *
  * @example
  * ```js
@@ -142,7 +153,8 @@ function isSuperUser(user) {
         headers['Authorization'] = `Basic ${window.btoa(`${username}:${password}`)}`;
     }
     const refresh = handleSessionResponse(openmrsFetch(sessionEndpoint, {
-        headers
+        headers,
+        rejectAuthFailure: true
     }));
     // Publish the request so that readers can wait on it instead of reading the session it is about to
     // replace. Each call still issues its own request; this only tracks the most recent one.
@@ -173,7 +185,7 @@ function isSuperUser(user) {
             authenticated: false,
             sessionId: ''
         }
-    });
+    }, true);
 }
 /**
  * Checks whether the given user has access based on the required privilege(s).
@@ -281,9 +293,39 @@ function isSuperUser(user) {
         headers: {
             'Content-Type': 'application/json'
         },
-        signal: abortController.signal
+        rejectAuthFailure: true,
+        signal: abortController?.signal
     }));
 }
+/**
+ * Sets the locale for the current session only, leaving the user's default locale unchanged.
+ * Use {@link setUserProperties} with a `defaultLocale` property to change the default instead.
+ *
+ * @param locale The locale in Java's `Locale#toString()` form, e.g. `en_GB`.
+ * @param abortController Optional AbortController to allow cancellation of the request.
+ * @returns A Promise that resolves with the updated SessionStore after refetching the current user.
+ *   It rejects with an {@link OpenmrsFetchError} if the server does not accept the locale.
+ *
+ * @example
+ * ```ts
+ * import { setSessionLocale } from '@openmrs/esm-api';
+ * await setSessionLocale('fr');
+ * ```
+ *
+ * @internal
+ */ export async function setSessionLocale(locale, abortController) {
+    await openmrsFetch(sessionEndpoint, {
+        method: 'POST',
+        body: {
+            locale
+        },
+        headers: {
+            'Content-Type': 'application/json'
+        },
+        signal: abortController?.signal
+    });
+    return refetchCurrentUser();
+}
 /**
  * Updates the user properties for a specific user. User properties are key-value
  * pairs that store user-specific settings and preferences. After updating the
@@ -322,33 +364,114 @@ function isSuperUser(user) {
     });
     return refetchCurrentUser();
 }
+/**
+ * Submits a TOTP code to complete a two-factor login challenge. When the code is accepted, the
+ * session store is refreshed with the now-authenticated session.
+ *
+ * @param code The code from the user's authenticator app.
+ * @param rememberDevice Whether the server should skip the challenge on this device in future.
+ * @returns A Promise resolving to the session. Its `authenticated` property is `false` if the
+ *   code was not accepted. It rejects with an {@link OpenmrsFetchError} if the server rejects the
+ *   request, in which case `responseBody` may explain why.
+ *
+ * @example
+ * ```ts
+ * import { verifyTotpCode } from '@openmrs/esm-api';
+ * const session = await verifyTotpCode('123456', true);
+ * ```
+ *
+ * @internal
+ */ export async function verifyTotpCode(code, rememberDevice = false) {
+    const response = await openmrsFetch(rememberDevice ? `${sessionEndpoint}?rememberMe=true` : sessionEndpoint, {
+        headers: {
+            'X-Totp-Code': code
+        }
+    });
+    if (response.data?.authenticated) {
+        // `refetchCurrentUser` only resolves once the store holds a session.
+        const store = await refetchCurrentUser();
+        return store.session;
+    }
+    return response.data;
+}
+/**
+ * Ends the current session on the server and records a logged-out session in the session store.
+ * A server that has already ended the session (401 or 403) counts as a successful logout.
+ *
+ * Other data cached for the logged-in user, such as SWR caches, is the caller's to clear.
+ *
+ * @returns A Promise that resolves once the session store holds a logged-out session.
+ *
+ * @example
+ * ```ts
+ * import { logout } from '@openmrs/esm-api';
+ * await logout();
+ * ```
+ *
+ * @internal
+ */ export async function logout() {
+    try {
+        await openmrsFetch(sessionEndpoint, {
+            method: 'DELETE',
+            rejectAuthFailure: true
+        });
+    } catch (err) {
+        if (!isAuthFailure(err)) {
+            throw err;
+        }
+    }
+    clearCurrentUser();
+    // The session just cleared is already correct, so a failed refresh loses nothing.
+    await refetchCurrentUser().catch(()=>{});
+}
 function handleSessionResponse(result) {
     return new Promise((resolve, reject)=>{
         result.then((res)=>{
-            let nextState;
             if (typeof res?.data === 'object') {
-                nextState = {
+                const nextState = {
                     loaded: true,
                     session: res.data
                 };
-                sessionStore.setState(nextState);
+                sessionStore.setState(nextState, true);
                 resolve(nextState);
             } else {
-                nextState = {
-                    loaded: false,
-                    session: null
-                };
-                sessionStore.setState(nextState);
-                reject(nextState);
+                reject(recordSessionFailure(Error('The session endpoint did not respond with a session')));
             }
         }).catch((err)=>{
+            // An auth failure is the session endpoint's answer for "not logged in", not a failed lookup.
+            if (isAuthFailure(err)) {
+                if (isUnauthenticatedSession(err.responseBody)) {
+                    sessionStore.setState({
+                        loaded: true,
+                        session: err.responseBody
+                    }, true);
+                } else {
+                    clearCurrentUser();
+                }
+                resolve(sessionStore.getState());
+                return;
+            }
             reportError(`Failed to fetch new session information: ${err}`);
-            const nextState = {
-                loaded: false,
-                session: null
-            };
-            sessionStore.setState(nextState);
-            reject(nextState);
+            reject(recordSessionFailure(err));
         });
     });
 }
+function isAuthFailure(err) {
+    return err instanceof OpenmrsFetchError && (err.response.status === 401 || err.response.status === 403);
+}
+function isUnauthenticatedSession(body) {
+    return typeof body === 'object' && body !== null && body.authenticated === false;
+}
+/**
+ * A session that has already loaded is kept when a later fetch fails, since it is still the best answer
+ * available. With nothing to fall back on, the error is recorded so the app shell can show an error page.
+ */ function recordSessionFailure(err) {
+    if (!sessionStore.getState().loaded) {
+        sessionStore.setState({
+            loaded: false,
+            session: null,
+            error: err instanceof Error ? err : Error(String(err))
+        }, true);
+    }
+    return sessionStore.getState();
+}

package/dist/openmrs-fetch.d.ts

@@ -78,6 +78,11 @@ export declare class OpenmrsFetchError extends Error implements FetchError {
 export interface FetchConfig extends Omit<RequestInit, 'body' | 'headers'> {
     headers?: FetchHeaders;
     body?: FetchBody | string;
+    /**
+     * When `true`, a response that triggers the auth-failure redirect still navigates, but the
+     * returned promise rejects with an `OpenmrsFetchError` instead of staying pending.
+     */
+    rejectAuthFailure?: boolean;
 }
 type ResponseBody = string | FetchResponseJson;
 export interface FetchHeaders {

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

@@ -1 +1 @@
-{"version":3,"file":"openmrs-fetch.d.ts","sourceRoot":"","sources":["../src/openmrs-fetch.ts"],"names":[],"mappings":"AAIA,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,CAkM1G;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":"AAIA,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,CAqL1G;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;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;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

@@ -104,26 +104,26 @@ import { defaultRedirectAuthFailureUrl } from "./config-schema.js";
     if (!fetchInit.headers) {
         fetchInit.headers = {};
     }
-    /* Automatically stringify javascript objects being sent in the
-   * request body.
-   */ if (isPlainObject(fetchInit.body)) {
+    // Automatically stringify javascript objects being sent in the
+    // request body.
+    if (isPlainObject(fetchInit.body)) {
         fetchInit.body = JSON.stringify(fetchInit.body);
     }
-    /* Add a request header to tell the server to respond with json,
-   * since frontend code almost always wants json and the OpenMRS
-   * server won't give you json unless you explicitly ask for it.
-   * If a different Accept header is preferred, pass it into the fetchInit.
-   * If no Accept header is desired, pass it in explicitly as null.
-   */ if (typeof fetchInit.headers.Accept === 'undefined') {
+    // Add a request header to tell the server to respond with json,
+    // since frontend code almost always wants json and the OpenMRS
+    // server won't give you json unless you explicitly ask for it.
+    // If a different Accept header is preferred, pass it into the fetchInit.
+    // If no Accept header is desired, pass it in explicitly as null.
+    if (typeof fetchInit.headers.Accept === 'undefined') {
         fetchInit.headers.Accept = 'application/json';
     }
     if (fetchInit.headers.Accept === null) {
         delete fetchInit.headers.Accept;
     }
-    /* This tells the OpenMRS REST API not to return a WWW-Authenticate
-   * header. Returning that header is useful when using the API, but
-   * not from a UI.
-   */ let isRestRequest = false;
+    // This tells the OpenMRS REST API not to return a WWW-Authenticate
+    // header. Returning that header is useful when using the API, but
+    // not from a UI.
+    let isRestRequest = false;
     try {
         const requestUrl = new URL(url, window.location.href);
         const restUrl = new URL(makeUrl(restBaseUrl), window.location.href);
@@ -158,22 +158,20 @@ import { defaultRedirectAuthFailureUrl } from "./config-schema.js";
             url = urlUrl.toString();
         }
     }
-    /* We capture the stacktrace before making the request, so that if an error occurs we can
-   * log a full stacktrace that includes the code that made the request and handled the response
-   * Otherwise, we could run into situations where the stacktrace doesn't even show which code
-   * called @openmrs/api.
-   */ const requestStacktrace = Error();
+    // We capture the stacktrace before making the request, so that if an error occurs we can
+    // log a full stacktrace that includes the code that made the request and handled the response
+    // Otherwise, we could run into situations where the stacktrace doesn't even show which code
+    // called @openmrs/api.
+    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) {
-            /*
-       * 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');
+            // 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({
@@ -181,10 +179,10 @@ import { defaultRedirectAuthFailureUrl } from "./config-schema.js";
                 });
             }
             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.
-         */ response.data = null;
+                // 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.
+                response.data = null;
                 return response;
             } else {
                 // HTTP 200s - The request succeeded
@@ -200,13 +198,12 @@ import { defaultRedirectAuthFailureUrl } from "./config-schema.js";
                 });
             }
         } else {
-            /* HTTP response status is not in 200s. Usually this will mean
-       * either HTTP 400s (bad request from browser) or HTTP 500s (server error)
-       * Our goal is to come up with best possible stacktrace and error message
-       * to help developers understand the problem and debug
-       */ /*
-       * Redirect to given url when redirect on auth failure is enabled
-       */ if (url === makeUrl(sessionEndpoint) && response.status === 403 || redirectAuthFailure.enabled && redirectAuthFailure.errors.includes(response.status)) {
+            // HTTP response status is not in 200s. Usually this will mean
+            // either HTTP 400s (bad request from browser) or HTTP 500s (server error)
+            // Our goal is to come up with best possible stacktrace and error message
+            // to help developers understand the problem and debug
+            // Redirect to given url when redirect on auth failure is enabled
+            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.
@@ -215,28 +212,27 @@ import { defaultRedirectAuthFailureUrl } from "./config-schema.js";
                 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
-         * want it to remain in pending status while the navigation occurs.
-         */ return redirectAuthFailure.resolvePromise ? Promise.resolve() : new Promise(()=>{});
-            } else {
-                // Attempt to download a response body, if it has one
-                return response.clone().text().then((responseText)=>{
-                    let responseBody = responseText;
-                    try {
-                        responseBody = JSON.parse(responseText);
-                    } catch (err) {
-                    // Server didn't respond with json, so just go with the response text string
-                    }
-                    /* Make the fetch promise go into "rejected" status, with the best
-               * possible stacktrace and error message.
-               */ throw new OpenmrsFetchError(url, response, responseBody, requestStacktrace);
-                }, (err)=>{
-                    /* We weren't able to download a response body for this error.
-               * Time to just give the best possible stacktrace and error message.
-               */ throw new OpenmrsFetchError(url, response, null, requestStacktrace);
-                });
+                const rejectAuthFailures = fetchInit.rejectAuthFailure === true;
+                if (!rejectAuthFailures) {
+                    return redirectAuthFailure.resolvePromise ? Promise.resolve() : new Promise(()=>{});
+                }
             }
+            // Attempt to download a response body, if it has one
+            return response.clone().text().then((responseText)=>{
+                let responseBody = responseText;
+                try {
+                    responseBody = JSON.parse(responseText);
+                } catch (err) {
+                // Server didn't respond with json, so just go with the response text string
+                }
+                // Make the fetch promise go into "rejected" status, with the best
+                // possible stacktrace and error message.
+                throw new OpenmrsFetchError(url, response, responseBody, requestStacktrace);
+            }, ()=>{
+                // We weren't able to download a response body for this error.
+                // Time to just give the best possible stacktrace and error message.
+                throw new OpenmrsFetchError(url, response, null, requestStacktrace);
+            });
         }
     });
 }

package/dist/public.d.ts

@@ -1,6 +1,6 @@
 export { clearCurrentUser, getCurrentUser, getLoggedInUser, getSessionStore, getSessionLocation, refetchCurrentUser, setSessionLocation, setUserLanguage, setUserProperties, userHasAccess, type LoadedSessionStore, type SessionStore, type UnloadedSessionStore, } from './current-user';
 export * from './environment';
 export * from './types';
-export * from './openmrs-fetch';
+export { fhirBaseUrl, makeUrl, openmrsFetch, OpenmrsFetchError, restBaseUrl, sessionEndpoint, type FetchConfig, type FetchError, type FetchHeaders, type FetchResponseJson, } from './openmrs-fetch';
 export * from './openmrs-backend-dependencies';
 //# sourceMappingURL=public.d.ts.map

package/dist/public.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../src/public.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,oBAAoB,GAC1B,MAAM,gBAAgB,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,gCAAgC,CAAC"}
+{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../src/public.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,oBAAoB,GAC1B,MAAM,gBAAgB,CAAC;AACxB,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,OAAO,EACL,WAAW,EACX,OAAO,EACP,YAAY,EACZ,iBAAiB,EACjB,WAAW,EACX,eAAe,EACf,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,iBAAiB,GACvB,MAAM,iBAAiB,CAAC;AACzB,cAAc,gCAAgC,CAAC"}

package/dist/public.js

@@ -1,5 +1,5 @@
 export { clearCurrentUser, getCurrentUser, getLoggedInUser, getSessionStore, getSessionLocation, refetchCurrentUser, setSessionLocation, setUserLanguage, setUserProperties, userHasAccess } from "./current-user.js";
 export * from "./environment.js";
 export * from "./types/index.js";
-export * from "./openmrs-fetch.js";
+export { fhirBaseUrl, makeUrl, openmrsFetch, OpenmrsFetchError, restBaseUrl, sessionEndpoint } from "./openmrs-fetch.js";
 export * from "./openmrs-backend-dependencies.js";

package/mock-jest.ts

@@ -17,5 +17,8 @@ export const clearCurrentUser = jest.fn();
 export const refetchCurrentUser = jest.fn();
 export const setUserLanguage = jest.fn();
 export const setUserProperties = jest.fn();
+export const setSessionLocale = jest.fn(() => Promise.resolve());
+export const verifyTotpCode = jest.fn();
+export const logout = jest.fn(() => Promise.resolve());
 export const userHasAccess = jest.fn();
 export { OpenmrsFetchError } from './src/openmrs-fetch';

package/mock.ts

@@ -18,5 +18,8 @@ export const clearCurrentUser = vi.fn();
 export const refetchCurrentUser = vi.fn();
 export const setUserLanguage = vi.fn();
 export const setUserProperties = vi.fn();
+export const setSessionLocale = vi.fn(() => Promise.resolve());
+export const verifyTotpCode = vi.fn();
+export const logout = vi.fn(() => Promise.resolve());
 export const userHasAccess = vi.fn();
 export { OpenmrsFetchError } from './src/openmrs-fetch';

package/package.json

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