@orangecheck/auth-client 2.1.1 → 2.3.0

package/dist/index.d.mts

@@ -139,13 +139,26 @@ interface UseWebAuthnRegisterReturn {
     reset: () => void;
 }
 declare function useWebAuthnRegister(opts?: UseHostOptions): UseWebAuthnRegisterReturn;
+type WebAuthnRenameResult = {
+    ok: true;
+    credential: WebAuthnCredentialPublic;
+} | {
+    ok: false;
+    reason: string;
+};
+type WebAuthnRemoveResult = {
+    ok: true;
+} | {
+    ok: false;
+    reason: string;
+};
 interface UseWebAuthnListReturn {
     status: WebAuthnListStatus;
     credentials: WebAuthnCredentialPublic[];
     error: Error | null;
     refetch: () => Promise<void>;
-    rename: (id: string, label: string) => Promise<WebAuthnCredentialPublic | null>;
-    remove: (id: string) => Promise<boolean>;
+    rename: (id: string, label: string) => Promise<WebAuthnRenameResult>;
+    remove: (id: string) => Promise<WebAuthnRemoveResult>;
 }
 declare function useWebAuthnList(opts?: UseHostOptions): UseWebAuthnListReturn;
 type WebAuthnStepUpResult = {
@@ -165,4 +178,16 @@ interface UseStepUpAuthReturn {
 }
 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 WebAuthnRegisterResult, type WebAuthnRegisterStatus, type WebAuthnStepUpResult, 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 WebAuthnRemoveResult, type WebAuthnRenameResult, type WebAuthnStepUpResult, buildSignInUrl, handleSudoRequired, redirectToSudo, useOcAddressSuggestion, useOcSession, useOptionalOcSession, useStepUpAuth, useWebAuthnList, useWebAuthnRegister };

package/dist/index.d.ts

@@ -139,13 +139,26 @@ interface UseWebAuthnRegisterReturn {
     reset: () => void;
 }
 declare function useWebAuthnRegister(opts?: UseHostOptions): UseWebAuthnRegisterReturn;
+type WebAuthnRenameResult = {
+    ok: true;
+    credential: WebAuthnCredentialPublic;
+} | {
+    ok: false;
+    reason: string;
+};
+type WebAuthnRemoveResult = {
+    ok: true;
+} | {
+    ok: false;
+    reason: string;
+};
 interface UseWebAuthnListReturn {
     status: WebAuthnListStatus;
     credentials: WebAuthnCredentialPublic[];
     error: Error | null;
     refetch: () => Promise<void>;
-    rename: (id: string, label: string) => Promise<WebAuthnCredentialPublic | null>;
-    remove: (id: string) => Promise<boolean>;
+    rename: (id: string, label: string) => Promise<WebAuthnRenameResult>;
+    remove: (id: string) => Promise<WebAuthnRemoveResult>;
 }
 declare function useWebAuthnList(opts?: UseHostOptions): UseWebAuthnListReturn;
 type WebAuthnStepUpResult = {
@@ -165,4 +178,16 @@ interface UseStepUpAuthReturn {
 }
 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 WebAuthnRegisterResult, type WebAuthnRegisterStatus, type WebAuthnStepUpResult, 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 WebAuthnRemoveResult, type WebAuthnRenameResult, type WebAuthnStepUpResult, buildSignInUrl, handleSudoRequired, redirectToSudo, useOcAddressSuggestion, useOcSession, useOptionalOcSession, useStepUpAuth, useWebAuthnList, useWebAuthnRegister };

package/dist/index.js

@@ -1395,14 +1395,16 @@ function useWebAuthnList(opts) {
         });
         const j = await r.json();
         if (!j.ok || !j.credential) {
-          setError(new Error(j.reason ?? "rename_failed"));
-          return null;
+          const reason = j.reason ?? `rename_failed_${r.status}`;
+          setError(new Error(reason));
+          return { ok: false, reason };
         }
         await refetch();
-        return j.credential;
+        return { ok: true, credential: j.credential };
       } catch (e) {
-        setError(e instanceof Error ? e : new Error(String(e)));
-        return null;
+        const reason = e instanceof Error ? e.message : String(e);
+        setError(new Error(reason));
+        return { ok: false, reason };
       }
     },
     [authOrigin, refetch]
@@ -1416,14 +1418,16 @@ function useWebAuthnList(opts) {
         });
         const j = await r.json();
         if (!j.ok) {
-          setError(new Error(j.reason ?? "delete_failed"));
-          return false;
+          const reason = j.reason ?? `delete_failed_${r.status}`;
+          setError(new Error(reason));
+          return { ok: false, reason };
         }
         await refetch();
-        return true;
+        return { ok: true };
       } catch (e) {
-        setError(e instanceof Error ? e : new Error(String(e)));
-        return false;
+        const reason = e instanceof Error ? e.message : String(e);
+        setError(new Error(reason));
+        return { ok: false, reason };
       }
     },
     [authOrigin, refetch]
@@ -1502,6 +1506,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;
@@ -1510,6 +1536,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;