@zoreal/oauth2-react 0.2.18 → 0.2.20

package/dist/index.d.cts

@@ -254,6 +254,13 @@ declare function ZorealBusyRing({ busy, radius, theme, block, className, style,
     children: ReactNode;
 }): react.JSX.Element;
 
+declare function ZorealMark({ size, brand, className, }: {
+    size?: number;
+    /** Paint the brand blue instead of inheriting currentColor. */
+    brand?: boolean;
+    className?: string;
+}): react.JSX.Element;
+
 /**
  * The pairing modal, rendered by the SDK rather than by every integrator.
  *
@@ -323,4 +330,4 @@ declare function hasGrantedAnyScopeZoreal(response: Pick<ZorealCodeResponse, 'sc
  */
 declare function resolveIntent(intent: LoginIntent | undefined, scope: string | undefined, acrValues: string | readonly string[] | undefined): LoginIntent;
 
-export { type AcrValue, type AuthCodeFlowOptions, type BrowserDirectFlowOptions, DEFAULT_PAIRING_TIMEOUT_MS, type ErrorCode, type LoginIntent, type NonOAuthError, PairingModal, type PairingModalProps, type PairingState, type PairingUI, type SelectBy, type UseZorealAutoLoginOptions, ZorealBusyRing, type ZorealButtonConfiguration, type ZorealCodeResponse, type ZorealCredentialResponse, ZorealLogin, type ZorealLoginProps, type ZorealLoginRequestOptions, type ZorealOAuthContextProps, ZorealOAuthProvider, type ZorealOAuthProviderProps, type ZorealTheme, hasGrantedAllScopesZoreal, hasGrantedAnyScopeZoreal, resolveIntent, useZorealAutoLogin, useZorealLogin, useZorealOAuth, zorealLogout };
+export { type AcrValue, type AuthCodeFlowOptions, type BrowserDirectFlowOptions, DEFAULT_PAIRING_TIMEOUT_MS, type ErrorCode, type LoginIntent, type NonOAuthError, PairingModal, type PairingModalProps, type PairingState, type PairingUI, type SelectBy, type UseZorealAutoLoginOptions, ZorealBusyRing, type ZorealButtonConfiguration, type ZorealCodeResponse, type ZorealCredentialResponse, ZorealLogin, type ZorealLoginProps, type ZorealLoginRequestOptions, ZorealMark, type ZorealOAuthContextProps, ZorealOAuthProvider, type ZorealOAuthProviderProps, type ZorealTheme, hasGrantedAllScopesZoreal, hasGrantedAnyScopeZoreal, resolveIntent, useZorealAutoLogin, useZorealLogin, useZorealOAuth, zorealLogout };

package/dist/index.d.ts

@@ -254,6 +254,13 @@ declare function ZorealBusyRing({ busy, radius, theme, block, className, style,
     children: ReactNode;
 }): react.JSX.Element;
 
+declare function ZorealMark({ size, brand, className, }: {
+    size?: number;
+    /** Paint the brand blue instead of inheriting currentColor. */
+    brand?: boolean;
+    className?: string;
+}): react.JSX.Element;
+
 /**
  * The pairing modal, rendered by the SDK rather than by every integrator.
  *
@@ -323,4 +330,4 @@ declare function hasGrantedAnyScopeZoreal(response: Pick<ZorealCodeResponse, 'sc
  */
 declare function resolveIntent(intent: LoginIntent | undefined, scope: string | undefined, acrValues: string | readonly string[] | undefined): LoginIntent;
 
-export { type AcrValue, type AuthCodeFlowOptions, type BrowserDirectFlowOptions, DEFAULT_PAIRING_TIMEOUT_MS, type ErrorCode, type LoginIntent, type NonOAuthError, PairingModal, type PairingModalProps, type PairingState, type PairingUI, type SelectBy, type UseZorealAutoLoginOptions, ZorealBusyRing, type ZorealButtonConfiguration, type ZorealCodeResponse, type ZorealCredentialResponse, ZorealLogin, type ZorealLoginProps, type ZorealLoginRequestOptions, type ZorealOAuthContextProps, ZorealOAuthProvider, type ZorealOAuthProviderProps, type ZorealTheme, hasGrantedAllScopesZoreal, hasGrantedAnyScopeZoreal, resolveIntent, useZorealAutoLogin, useZorealLogin, useZorealOAuth, zorealLogout };
+export { type AcrValue, type AuthCodeFlowOptions, type BrowserDirectFlowOptions, DEFAULT_PAIRING_TIMEOUT_MS, type ErrorCode, type LoginIntent, type NonOAuthError, PairingModal, type PairingModalProps, type PairingState, type PairingUI, type SelectBy, type UseZorealAutoLoginOptions, ZorealBusyRing, type ZorealButtonConfiguration, type ZorealCodeResponse, type ZorealCredentialResponse, ZorealLogin, type ZorealLoginProps, type ZorealLoginRequestOptions, ZorealMark, type ZorealOAuthContextProps, ZorealOAuthProvider, type ZorealOAuthProviderProps, type ZorealTheme, hasGrantedAllScopesZoreal, hasGrantedAnyScopeZoreal, resolveIntent, useZorealAutoLogin, useZorealLogin, useZorealOAuth, zorealLogout };

package/dist/index.js

@@ -5,7 +5,7 @@ import { createContext, useContext, useMemo, useState as useState2 } from "react
 
 // src/wire.ts
 var WIRE_VERSION = 1;
-var SDK_VERSION = "0.2.18";
+var SDK_VERSION = "0.2.20";
 var DEFAULT_ISSUER = "https://id.zoreal.com";
 var POLL_INTERVAL_MS = 2e3;
 var POLL_INTERVAL_ENROLLING_MS = 5e3;
@@ -1600,6 +1600,76 @@ import { useMemo as useMemo2, useState as useState4 } from "react";
 // src/useZorealLogin.ts
 import { useCallback, useEffect as useEffect2, useRef as useRef2, useState as useState3 } from "react";
 
+// src/return.ts
+var PREFIX2 = "zoreal:oauth2:return:";
+var DONE = "zoreal:oauth2:done:";
+var MAX_AGE_MS = 10 * 60 * 1e3;
+function storage() {
+  try {
+    return typeof localStorage === "undefined" ? null : localStorage;
+  } catch {
+    return null;
+  }
+}
+function saveReturnFlow(flow) {
+  try {
+    storage()?.setItem(PREFIX2 + flow.requestId, JSON.stringify(flow));
+  } catch {
+  }
+}
+function peekReturnFlow(requestId) {
+  const store = storage();
+  if (!store) return null;
+  const raw = store.getItem(PREFIX2 + requestId);
+  if (!raw) return null;
+  try {
+    const flow = JSON.parse(raw);
+    if (flow.v !== 1 || flow.requestId !== requestId) return null;
+    if (Date.now() - flow.createdAt > MAX_AGE_MS) return null;
+    return flow;
+  } catch {
+    return null;
+  }
+}
+function forgetReturnFlow(requestId) {
+  try {
+    storage()?.removeItem(PREFIX2 + requestId);
+  } catch {
+  }
+  if (pending === requestId) pending = null;
+}
+function markReturnDone(requestId) {
+  try {
+    const store = storage();
+    store?.setItem(DONE + requestId, String(Date.now()));
+    store?.removeItem(PREFIX2 + requestId);
+  } catch {
+  }
+}
+function isReturnDone(requestId) {
+  return storage()?.getItem(DONE + requestId) !== null && storage()?.getItem(DONE + requestId) !== void 0;
+}
+function returnToUrl() {
+  if (typeof window === "undefined") return void 0;
+  const { href } = window.location;
+  const hash = href.indexOf("#");
+  return hash === -1 ? href : href.slice(0, hash);
+}
+var RETURN_MARK = /(?:^|[#&])zoreal_return=([A-Za-z0-9]{32})(?:&|$)/;
+var pending = null;
+function pendingReturnId() {
+  if (pending) return pending;
+  if (typeof window === "undefined") return null;
+  const match = RETURN_MARK.exec(window.location.hash);
+  if (!match) return null;
+  pending = match[1];
+  try {
+    window.history.replaceState(window.history.state, "", returnToUrl());
+  } catch {
+  }
+  return pending;
+}
+
 // src/jwt.ts
 function unsafeClaims(idToken) {
   try {
@@ -1979,6 +2049,7 @@ function generateRequestId() {
 }
 
 // src/useZorealLogin.ts
+var resumedReturns = /* @__PURE__ */ new Set();
 function useZorealFlow(options) {
   const { clientId, issuer, locale } = useZorealOAuth();
   const [pairing, setPairing] = useState3(null);
@@ -1988,6 +2059,7 @@ function useZorealFlow(options) {
   const abortRef = useRef2(null);
   const optionsRef = useRef2(options);
   optionsRef.current = options;
+  const closedByPerson = useRef2(false);
   useEffect2(
     () => () => {
       abortRef.current?.abort();
@@ -1995,6 +2067,61 @@ function useZorealFlow(options) {
     },
     []
   );
+  useEffect2(() => {
+    const id = pendingReturnId();
+    if (!id || resumedReturns.has(id)) return;
+    const saved = peekReturnFlow(id);
+    if (!saved || saved.clientId !== clientId) return;
+    forgetReturnFlow(id);
+    resumedReturns.add(id);
+    const controller = new AbortController();
+    abortRef.current = controller;
+    void (async () => {
+      const opts = optionsRef.current;
+      try {
+        const code = await pollUntilApproved(issuer, id, void 0, controller.signal, {
+          tolerateUnknownUntil: Date.now() + 5e3
+        });
+        if (saved.flow === "auth-code") {
+          opts.onCode?.({
+            code,
+            scope: saved.scope,
+            app_state: saved.appState,
+            code_verifier: saved.verifier,
+            nonce: saved.nonce
+          });
+        } else {
+          const tokens = await exchangeCode(issuer, {
+            code,
+            code_verifier: saved.verifier,
+            client_id: clientId
+          });
+          const claims = unsafeClaims(tokens.id_token);
+          opts.onCredential?.({
+            credential: tokens.id_token,
+            clientId,
+            select_by: "app_link",
+            acr: claims.acr ?? "zoreal.device"
+          });
+        }
+        markReturnDone(id);
+      } catch (e) {
+        if (e instanceof DOMException && e.name === "AbortError") return;
+        if (e instanceof FlowAbandonedError) {
+          opts.onNonOAuthError?.(e.reason);
+          return;
+        }
+        if (e instanceof OAuthFlowError) {
+          opts.onError?.({ error: e.error, description: e.description });
+          return;
+        }
+        opts.onNonOAuthError?.({
+          type: "unknown",
+          description: e instanceof Error ? e.message : String(e)
+        });
+      }
+    })();
+  }, [clientId, issuer]);
   const login = useCallback(() => {
     const opts = optionsRef.current;
     const run = async () => {
@@ -2011,8 +2138,23 @@ function useZorealFlow(options) {
       try {
         let code;
         let selectBy = "device";
+        let returnId = null;
         if (useAppLink) {
           const requestId = generateRequestId();
+          saveReturnFlow({
+            v: 1,
+            issuer,
+            clientId,
+            flow,
+            verifier,
+            nonce,
+            state,
+            scope: opts.scope ?? "openid",
+            appState: opts.app_state,
+            requestId,
+            createdAt: Date.now()
+          });
+          returnId = requestId;
           const startUrl = sameDeviceStartUrl(issuer, {
             client_id: clientId,
             scope: opts.scope ?? "openid",
@@ -2025,10 +2167,12 @@ function useZorealFlow(options) {
             prompt: opts.prompt,
             locale,
             request_id: requestId,
-            origin: window.location.origin
+            origin: window.location.origin,
+            return_to: returnToUrl()
           });
           selectBy = "app_link";
           const cancel = () => {
+            closedByPerson.current = true;
             controller.abort();
             setPairing(null);
           };
@@ -2055,6 +2199,9 @@ function useZorealFlow(options) {
             controller.signal,
             { tolerateUnknownUntil: Date.now() + 15e3 }
           );
+          if (isReturnDone(requestId)) {
+            throw new DOMException("aborted", "AbortError");
+          }
         } else {
           const started = await startPairing(issuer, {
             client_id: clientId,
@@ -2076,6 +2223,7 @@ function useZorealFlow(options) {
             selectBy = "qr";
             const qrRefreshSeconds = qrRefreshSecondsOf(started);
             const cancel = () => {
+              closedByPerson.current = true;
               controller.abort();
               setPairing(null);
               publishRef.current?.(null);
@@ -2125,6 +2273,7 @@ function useZorealFlow(options) {
         }
         setPairing(null);
         publishRef.current?.(null);
+        if (returnId) markReturnDone(returnId);
         if (flow === "auth-code") {
           opts.onCode?.({
             code,
@@ -2151,7 +2300,16 @@ function useZorealFlow(options) {
       } catch (e) {
         setPairing(null);
         publishRef.current?.(null);
-        if (e instanceof DOMException && e.name === "AbortError") return;
+        if (e instanceof DOMException && e.name === "AbortError") {
+          if (closedByPerson.current) {
+            closedByPerson.current = false;
+            opts.onNonOAuthError?.({
+              type: "popup_closed",
+              description: "the sign-in dialog was closed before the holder approved"
+            });
+          }
+          return;
+        }
         if (e instanceof FlowAbandonedError) {
           opts.onNonOAuthError?.(e.reason);
           return;
@@ -2395,6 +2553,7 @@ export {
   PairingModal,
   ZorealBusyRing,
   ZorealLogin,
+  ZorealMark,
   ZorealOAuthProvider,
   hasGrantedAllScopesZoreal,
   hasGrantedAnyScopeZoreal,