@orangecheck/auth-client 2.1.0 → 2.2.0

package/dist/index.d.mts

@@ -123,12 +123,19 @@ type WebAuthnListStatus = 'loading' | 'ready' | 'error';
 interface UseHostOptions {
     authOrigin?: string;
 }
+type WebAuthnRegisterResult = {
+    ok: true;
+    credential: WebAuthnCredentialPublic;
+} | {
+    ok: false;
+    reason: string;
+};
 interface UseWebAuthnRegisterReturn {
     status: WebAuthnRegisterStatus;
     error: Error | null;
     register: (args?: {
         label?: string;
-    }) => Promise<WebAuthnCredentialPublic | null>;
+    }) => Promise<WebAuthnRegisterResult>;
     reset: () => void;
 }
 declare function useWebAuthnRegister(opts?: UseHostOptions): UseWebAuthnRegisterReturn;
@@ -141,16 +148,33 @@ interface UseWebAuthnListReturn {
     remove: (id: string) => Promise<boolean>;
 }
 declare function useWebAuthnList(opts?: UseHostOptions): UseWebAuthnListReturn;
+type WebAuthnStepUpResult = {
+    ok: true;
+    step_up_at: number;
+} | {
+    ok: false;
+    reason: string;
+};
 interface UseStepUpAuthReturn {
     status: WebAuthnAssertionStatus;
     error: Error | null;
     stepUp: (args: {
         purpose: string;
-    }) => Promise<{
-        step_up_at: number;
-    } | null>;
+    }) => Promise<WebAuthnStepUpResult>;
     reset: () => void;
 }
 declare function useStepUpAuth(opts?: UseHostOptions): UseStepUpAuthReturn;
 
-export { DEFAULT_CONFIG, type OcAccount, OcAccountChip, type OcAccountChipProps, OcAccountPill, type OcAccountPillProps, OcAddressInput, type OcAddressInputProps, type OcAuthConfig, OcSessionProvider, type OcSessionState, type OcSessionStatus, OcSignIn, OcSignInButton, type OcSignInButtonProps, type OcSignInProps, type UseOcAddressSuggestionOptions, type UseOcAddressSuggestionReturn, type UseStepUpAuthReturn, type UseWebAuthnListReturn, type UseWebAuthnRegisterReturn, type WebAuthnAssertionStatus, type WebAuthnCredentialPublic, type WebAuthnListStatus, type WebAuthnRegisterStatus, buildSignInUrl, useOcAddressSuggestion, useOcSession, useOptionalOcSession, useStepUpAuth, useWebAuthnList, useWebAuthnRegister };
+interface RedirectToSudoArgs {
+    returnTo?: string;
+    purpose?: string;
+    config?: OcAuthConfig;
+}
+declare function redirectToSudo(args?: RedirectToSudoArgs): void;
+declare function handleSudoRequired(body: {
+    reason?: string;
+} | null | undefined, args?: Omit<RedirectToSudoArgs, 'returnTo'> & {
+    returnTo?: string;
+}): boolean;
+
+export { DEFAULT_CONFIG, type OcAccount, OcAccountChip, type OcAccountChipProps, OcAccountPill, type OcAccountPillProps, OcAddressInput, type OcAddressInputProps, type OcAuthConfig, OcSessionProvider, type OcSessionState, type OcSessionStatus, OcSignIn, OcSignInButton, type OcSignInButtonProps, type OcSignInProps, type RedirectToSudoArgs, type UseOcAddressSuggestionOptions, type UseOcAddressSuggestionReturn, type UseStepUpAuthReturn, type UseWebAuthnListReturn, type UseWebAuthnRegisterReturn, type WebAuthnAssertionStatus, type WebAuthnCredentialPublic, type WebAuthnListStatus, type WebAuthnRegisterResult, type WebAuthnRegisterStatus, type WebAuthnStepUpResult, buildSignInUrl, handleSudoRequired, redirectToSudo, useOcAddressSuggestion, useOcSession, useOptionalOcSession, useStepUpAuth, useWebAuthnList, useWebAuthnRegister };

package/dist/index.d.ts

@@ -123,12 +123,19 @@ type WebAuthnListStatus = 'loading' | 'ready' | 'error';
 interface UseHostOptions {
     authOrigin?: string;
 }
+type WebAuthnRegisterResult = {
+    ok: true;
+    credential: WebAuthnCredentialPublic;
+} | {
+    ok: false;
+    reason: string;
+};
 interface UseWebAuthnRegisterReturn {
     status: WebAuthnRegisterStatus;
     error: Error | null;
     register: (args?: {
         label?: string;
-    }) => Promise<WebAuthnCredentialPublic | null>;
+    }) => Promise<WebAuthnRegisterResult>;
     reset: () => void;
 }
 declare function useWebAuthnRegister(opts?: UseHostOptions): UseWebAuthnRegisterReturn;
@@ -141,16 +148,33 @@ interface UseWebAuthnListReturn {
     remove: (id: string) => Promise<boolean>;
 }
 declare function useWebAuthnList(opts?: UseHostOptions): UseWebAuthnListReturn;
+type WebAuthnStepUpResult = {
+    ok: true;
+    step_up_at: number;
+} | {
+    ok: false;
+    reason: string;
+};
 interface UseStepUpAuthReturn {
     status: WebAuthnAssertionStatus;
     error: Error | null;
     stepUp: (args: {
         purpose: string;
-    }) => Promise<{
-        step_up_at: number;
-    } | null>;
+    }) => Promise<WebAuthnStepUpResult>;
     reset: () => void;
 }
 declare function useStepUpAuth(opts?: UseHostOptions): UseStepUpAuthReturn;
 
-export { DEFAULT_CONFIG, type OcAccount, OcAccountChip, type OcAccountChipProps, OcAccountPill, type OcAccountPillProps, OcAddressInput, type OcAddressInputProps, type OcAuthConfig, OcSessionProvider, type OcSessionState, type OcSessionStatus, OcSignIn, OcSignInButton, type OcSignInButtonProps, type OcSignInProps, type UseOcAddressSuggestionOptions, type UseOcAddressSuggestionReturn, type UseStepUpAuthReturn, type UseWebAuthnListReturn, type UseWebAuthnRegisterReturn, type WebAuthnAssertionStatus, type WebAuthnCredentialPublic, type WebAuthnListStatus, type WebAuthnRegisterStatus, buildSignInUrl, useOcAddressSuggestion, useOcSession, useOptionalOcSession, useStepUpAuth, useWebAuthnList, useWebAuthnRegister };
+interface RedirectToSudoArgs {
+    returnTo?: string;
+    purpose?: string;
+    config?: OcAuthConfig;
+}
+declare function redirectToSudo(args?: RedirectToSudoArgs): void;
+declare function handleSudoRequired(body: {
+    reason?: string;
+} | null | undefined, args?: Omit<RedirectToSudoArgs, 'returnTo'> & {
+    returnTo?: string;
+}): boolean;
+
+export { DEFAULT_CONFIG, type OcAccount, OcAccountChip, type OcAccountChipProps, OcAccountPill, type OcAccountPillProps, OcAddressInput, type OcAddressInputProps, type OcAuthConfig, OcSessionProvider, type OcSessionState, type OcSessionStatus, OcSignIn, OcSignInButton, type OcSignInButtonProps, type OcSignInProps, type RedirectToSudoArgs, type UseOcAddressSuggestionOptions, type UseOcAddressSuggestionReturn, type UseStepUpAuthReturn, type UseWebAuthnListReturn, type UseWebAuthnRegisterReturn, type WebAuthnAssertionStatus, type WebAuthnCredentialPublic, type WebAuthnListStatus, type WebAuthnRegisterResult, type WebAuthnRegisterStatus, type WebAuthnStepUpResult, buildSignInUrl, handleSudoRequired, redirectToSudo, useOcAddressSuggestion, useOcSession, useOptionalOcSession, useStepUpAuth, useWebAuthnList, useWebAuthnRegister };

package/dist/index.js

@@ -1301,12 +1301,21 @@ function useWebAuthnRegister(opts) {
         });
         const optsBody = await optsRes.json();
         if (!optsRes.ok || !optsBody.ok || !optsBody.options || !optsBody.challenge_token) {
-          throw new Error(optsBody.reason ?? `options_failed_${optsRes.status}`);
+          const reason = optsBody.reason ?? `options_failed_${optsRes.status}`;
+          setError(new Error(reason));
+          setStatus("error");
+          return { ok: false, reason };
         }
         setStatus("authenticating");
-        const attestation = await browser.startRegistration({
-          optionsJSON: optsBody.options
-        });
+        let attestation;
+        try {
+          attestation = await browser.startRegistration({ optionsJSON: optsBody.options });
+        } catch (e) {
+          const reason = isAbortError(e) ? "cancelled" : e.message;
+          setError(new Error(reason));
+          setStatus("error");
+          return { ok: false, reason };
+        }
         setStatus("verifying");
         const verifyRes = await fetch(`${authOrigin}/api/auth/webauthn/register/verify`, {
           method: "POST",
@@ -1320,18 +1329,18 @@ function useWebAuthnRegister(opts) {
         });
         const verifyBody = await verifyRes.json();
         if (!verifyRes.ok || !verifyBody.ok || !verifyBody.credential) {
-          throw new Error(verifyBody.reason ?? `verify_failed_${verifyRes.status}`);
+          const reason = verifyBody.reason ?? `verify_failed_${verifyRes.status}`;
+          setError(new Error(reason));
+          setStatus("error");
+          return { ok: false, reason };
         }
         setStatus("success");
-        return verifyBody.credential;
+        return { ok: true, credential: verifyBody.credential };
       } catch (e) {
-        const err = e instanceof Error ? e : new Error(String(e));
-        setError(err);
+        const reason = e instanceof Error ? e.message : String(e);
+        setError(new Error(reason));
         setStatus("error");
-        if (isAbortError(err)) {
-          setError(new Error("cancelled"));
-        }
-        return null;
+        return { ok: false, reason };
       }
     },
     [authOrigin]
@@ -1443,12 +1452,21 @@ function useStepUpAuth(opts) {
         });
         const optsBody = await optsRes.json();
         if (!optsRes.ok || !optsBody.ok || !optsBody.options || !optsBody.challenge_token) {
-          throw new Error(optsBody.reason ?? `options_failed_${optsRes.status}`);
+          const reason = optsBody.reason ?? `options_failed_${optsRes.status}`;
+          setError(new Error(reason));
+          setStatus("error");
+          return { ok: false, reason };
         }
         setStatus("authenticating");
-        const assertion = await browser.startAuthentication({
-          optionsJSON: optsBody.options
-        });
+        let assertion;
+        try {
+          assertion = await browser.startAuthentication({ optionsJSON: optsBody.options });
+        } catch (e) {
+          const reason = isAbortError(e) ? "cancelled" : e.message;
+          setError(new Error(reason));
+          setStatus("error");
+          return { ok: false, reason };
+        }
         setStatus("verifying");
         const verifyRes = await fetch(
           `${authOrigin}/api/auth/webauthn/assertion/verify`,
@@ -1464,16 +1482,19 @@ function useStepUpAuth(opts) {
         );
         const verifyBody = await verifyRes.json();
         if (!verifyRes.ok || !verifyBody.ok || typeof verifyBody.step_up_at !== "number") {
-          throw new Error(verifyBody.reason ?? `verify_failed_${verifyRes.status}`);
+          const reason = verifyBody.reason ?? `verify_failed_${verifyRes.status}`;
+          setError(new Error(reason));
+          setStatus("error");
+          return { ok: false, reason };
         }
         await refresh();
         setStatus("success");
-        return { step_up_at: verifyBody.step_up_at };
+        return { ok: true, step_up_at: verifyBody.step_up_at };
       } catch (e) {
-        const err = isAbortError(e) ? new Error("cancelled") : e instanceof Error ? e : new Error(String(e));
-        setError(err);
+        const reason = e instanceof Error ? e.message : String(e);
+        setError(new Error(reason));
         setStatus("error");
-        return null;
+        return { ok: false, reason };
       }
     },
     [authOrigin, refresh]
@@ -1481,6 +1502,28 @@ function useStepUpAuth(opts) {
   return { status, error, stepUp, reset };
 }
 
+// src/sudo.tsx
+function redirectToSudo(args = {}) {
+  if (typeof window === "undefined") {
+    throw new Error(
+      "[@orangecheck/auth-client] redirectToSudo() requires a browser environment"
+    );
+  }
+  const cfg = resolveConfig(args.config);
+  const url = new URL("/sudo", cfg.authOrigin);
+  const returnTo = args.returnTo ?? window.location.href;
+  if (returnTo) url.searchParams.set("return_to", returnTo);
+  if (args.purpose) url.searchParams.set("purpose", args.purpose);
+  window.location.assign(url.toString());
+}
+function handleSudoRequired(body, args = {}) {
+  if (body && body.reason === "sudo_required") {
+    redirectToSudo(args);
+    return true;
+  }
+  return false;
+}
+
 exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
 exports.OcAccountChip = OcAccountChip;
 exports.OcAccountPill = OcAccountPill;
@@ -1489,6 +1532,8 @@ exports.OcSessionProvider = OcSessionProvider;
 exports.OcSignIn = OcSignIn;
 exports.OcSignInButton = OcSignInButton;
 exports.buildSignInUrl = buildSignInUrl;
+exports.handleSudoRequired = handleSudoRequired;
+exports.redirectToSudo = redirectToSudo;
 exports.useOcAddressSuggestion = useOcAddressSuggestion;
 exports.useOcSession = useOcSession;
 exports.useOptionalOcSession = useOptionalOcSession;