@medplum/core 1.0.6 → 2.0.1

package/dist/cjs/client.d.ts

@@ -71,6 +71,14 @@ export interface MedplumClientOptions {
      * See: https://developer.mozilla.org/en-US/docs/Web/API/Request/cache
      */
     cacheTime?: number;
+    /**
+     * The length of time in milliseconds to delay requests for auto batching.
+     *
+     * Auto batching attempts to group multiple requests together into a single batch request.
+     *
+     * Default value is 0, which disables auto batching.
+     */
+    autoBatchTime?: number;
     /**
      * Fetch implementation.
      *
@@ -146,6 +154,7 @@ export interface BaseLoginRequest {
     readonly codeChallengeMethod?: string;
     readonly googleClientId?: string;
     readonly launch?: string;
+    readonly redirectUri?: string;
 }
 export interface EmailPasswordLoginRequest extends BaseLoginRequest {
     readonly email: string;
@@ -338,6 +347,12 @@ export declare class MedplumClient extends EventTarget {
      * @category Authentication
      */
     clear(): void;
+    /**
+     * Clears the active login from local storage.
+     * Does not clear all local storage (such as other logins).
+     * @category Authentication
+     */
+    clearActiveLogin(): void;
     /**
      * Invalidates any cached values or cached requests for the given URL.
      * @category Caching
@@ -467,10 +482,15 @@ export declare class MedplumClient extends EventTarget {
      * @returns Promise to the authentication response.
      */
     startGoogleLogin(loginRequest: GoogleLoginRequest): Promise<LoginAuthenticationResponse>;
-    getCodeChallenge(loginRequest: BaseLoginRequest): {
-        codeChallenge?: string;
-        codeChallengeMethod?: string;
-    };
+    /**
+     * Returns the PKCE code challenge and method.
+     * If the login request already includes a code challenge, it is returned.
+     * Otherwise, a new PKCE code challenge is generated.
+     * @category Authentication
+     * @param loginRequest The original login request.
+     * @returns The PKCE code challenge and method.
+     */
+    ensureCodeChallenge<T extends BaseLoginRequest>(loginRequest: T): Promise<T>;
     /**
      * Signs out locally.
      * Does not invalidate tokens with the server.
@@ -482,14 +502,23 @@ export declare class MedplumClient extends EventTarget {
      * Returns true if the user is signed in.
      * This may result in navigating away to the sign in page.
      * @category Authentication
+     * @param loginParams Optional login parameters.
      */
-    signInWithRedirect(): Promise<ProfileResource | void>;
+    signInWithRedirect(loginParams?: Partial<BaseLoginRequest>): Promise<ProfileResource | void>;
     /**
      * Tries to sign out the user.
      * See: https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html
      * @category Authentication
      */
     signOutWithRedirect(): void;
+    /**
+     * Initiates sign in with an external identity provider.
+     * @param authorizeUrl The external authorization URL.
+     * @param clientId The external client ID.
+     * @param redirectUri The external identity provider redirect URI.
+     * @param baseLogin The Medplum login request.
+     */
+    signInWithExternalAuth(authorizeUrl: string, clientId: string, redirectUri: string, baseLogin: BaseLoginRequest): Promise<void>;
     /**
      * Builds a FHIR URL from a collection of URL path components.
      * For example, `buildUrl('/Patient', '123')` returns `fhir/R4/Patient/123`.
@@ -1154,7 +1183,10 @@ export declare class MedplumClient extends EventTarget {
      * Starts a new PKCE flow.
      * These PKCE values are stateful, and must survive redirects and page refreshes.
      */
-    startPkce(): Promise<void>;
+    startPkce(): Promise<{
+        codeChallengeMethod: string;
+        codeChallenge: string;
+    }>;
     /**
      * Processes an OAuth authorization code.
      * See: https://openid.net/specs/openid-connect-core-1_0.html#TokenRequest