@orangecheck/auth-client 2.33.0 → 2.33.2

package/README.md

@@ -1,6 +1,6 @@
 # `@orangecheck/auth-client`
 
-> **Full reference:** [docs.ochk.io/sdk/auth-client](https://docs.ochk.io/sdk/auth-client) — auto-generated from the TypeScript source on every release.
+> **Full reference:** [ochk.io/docs/sdk/auth-client](https://ochk.io/docs/sdk/auth-client) — auto-generated from the TypeScript source on every release.
 > Hand-written prose below is the high-level overview; the docs site is the source of truth for every export, type, and signature.
 
 
@@ -16,8 +16,8 @@ Pairs with [`@orangecheck/auth-core`](../auth-core) on the server side.
 > OrangeCheck *be* your sign-in. If you already run your own login
 > (Google, Auth0, Clerk, NextAuth, …) and just want to add a `did:oc`
 > to your users, you don't need this package — see
-> [OrangeCheck Connect](https://docs.ochk.io/connect). Both pathways are
-> compared at [docs.ochk.io/integration](https://docs.ochk.io/integration).
+> [OrangeCheck Connect](https://ochk.io/docs/connect). Both pathways are
+> compared at [ochk.io/docs/integration](https://ochk.io/docs/integration).
 
 ## Install
 

package/dist/index.d.mts

@@ -190,6 +190,13 @@ declare function fetchOcBond(opts?: {
 }): Promise<OcBondView | null>;
 declare function OcBond({ authOrigin, onChange, className, }: OcBondProps): React.ReactElement;
 
+declare const FRAGMENT_TTL_MS: number;
+declare function stripFragment(target: string): string;
+declare function withoutFragment(target: string): string;
+declare function returnToHere(): string;
+declare function keepFragmentOnReturnLinks(): () => void;
+declare function restoreReturnFragment(): boolean;
+
 declare const TAB_SESSION_HEADER = "x-oc-tab-session";
 declare const TAB_SESSION_STORAGE_KEY = "oc_tab_session";
 declare const TAB_ACCOUNT_HINT_KEY = "oc-as";
@@ -293,4 +300,4 @@ declare function isSudoAccountMismatch(body: {
     reason?: string;
 } | null | undefined): boolean;
 
-export { DEFAULT_CONFIG, DISPLAY_IDENTITY_KINDS, type DisplayIdentity, type DisplayIdentityKind, type OcAccount, OcAccountChip, type OcAccountChipProps, OcAccountPill, type OcAccountPillProps, type OcAccountSummary, OcAddressInput, type OcAddressInputProps, type OcAuthConfig, OcBond, type OcBondProps, type OcBondView, OcLinkedIdentities, type OcLinkedIdentitiesProps, type OcLinkedIdentity, OcSessionProvider, type OcSessionState, type OcSessionStatus, OcSignIn, OcSignInButton, type OcSignInButtonProps, type OcSignInProps, type OcSignOutScope, type OcTabSession, type RedirectToSudoArgs, SUDO_ACCOUNT_MISMATCH_MESSAGE, TAB_ACCOUNT_HINT_KEY, TAB_ADOPT_HASH, TAB_SESSION_HEADER, TAB_SESSION_STORAGE_KEY, 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, bondFloorsText, buildAddAccountUrl, buildSignInUrl, clearTabSession, consumeTabAccountHint, consumeTabAdoptMarker, familyReturnTarget, fetchOcBond, fetchOcLinkedIdentities, handleSudoRequired, installTabFetchInterceptor, installTabLinkDecorator, isSudoAccountMismatch, readTabSession, redirectToSudo, safeReturnTo, tabSessionHeader, useOcAddressSuggestion, useOcSession, useOptionalOcSession, useStepUpAuth, useWebAuthnList, useWebAuthnRegister, writeTabSession };
+export { DEFAULT_CONFIG, DISPLAY_IDENTITY_KINDS, type DisplayIdentity, type DisplayIdentityKind, FRAGMENT_TTL_MS, type OcAccount, OcAccountChip, type OcAccountChipProps, OcAccountPill, type OcAccountPillProps, type OcAccountSummary, OcAddressInput, type OcAddressInputProps, type OcAuthConfig, OcBond, type OcBondProps, type OcBondView, OcLinkedIdentities, type OcLinkedIdentitiesProps, type OcLinkedIdentity, OcSessionProvider, type OcSessionState, type OcSessionStatus, OcSignIn, OcSignInButton, type OcSignInButtonProps, type OcSignInProps, type OcSignOutScope, type OcTabSession, type RedirectToSudoArgs, SUDO_ACCOUNT_MISMATCH_MESSAGE, TAB_ACCOUNT_HINT_KEY, TAB_ADOPT_HASH, TAB_SESSION_HEADER, TAB_SESSION_STORAGE_KEY, 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, bondFloorsText, buildAddAccountUrl, buildSignInUrl, clearTabSession, consumeTabAccountHint, consumeTabAdoptMarker, familyReturnTarget, fetchOcBond, fetchOcLinkedIdentities, handleSudoRequired, installTabFetchInterceptor, installTabLinkDecorator, isSudoAccountMismatch, keepFragmentOnReturnLinks, readTabSession, redirectToSudo, restoreReturnFragment, returnToHere, safeReturnTo, stripFragment, tabSessionHeader, useOcAddressSuggestion, useOcSession, useOptionalOcSession, useStepUpAuth, useWebAuthnList, useWebAuthnRegister, withoutFragment, writeTabSession };

package/dist/index.d.ts

@@ -190,6 +190,13 @@ declare function fetchOcBond(opts?: {
 }): Promise<OcBondView | null>;
 declare function OcBond({ authOrigin, onChange, className, }: OcBondProps): React.ReactElement;
 
+declare const FRAGMENT_TTL_MS: number;
+declare function stripFragment(target: string): string;
+declare function withoutFragment(target: string): string;
+declare function returnToHere(): string;
+declare function keepFragmentOnReturnLinks(): () => void;
+declare function restoreReturnFragment(): boolean;
+
 declare const TAB_SESSION_HEADER = "x-oc-tab-session";
 declare const TAB_SESSION_STORAGE_KEY = "oc_tab_session";
 declare const TAB_ACCOUNT_HINT_KEY = "oc-as";
@@ -293,4 +300,4 @@ declare function isSudoAccountMismatch(body: {
     reason?: string;
 } | null | undefined): boolean;
 
-export { DEFAULT_CONFIG, DISPLAY_IDENTITY_KINDS, type DisplayIdentity, type DisplayIdentityKind, type OcAccount, OcAccountChip, type OcAccountChipProps, OcAccountPill, type OcAccountPillProps, type OcAccountSummary, OcAddressInput, type OcAddressInputProps, type OcAuthConfig, OcBond, type OcBondProps, type OcBondView, OcLinkedIdentities, type OcLinkedIdentitiesProps, type OcLinkedIdentity, OcSessionProvider, type OcSessionState, type OcSessionStatus, OcSignIn, OcSignInButton, type OcSignInButtonProps, type OcSignInProps, type OcSignOutScope, type OcTabSession, type RedirectToSudoArgs, SUDO_ACCOUNT_MISMATCH_MESSAGE, TAB_ACCOUNT_HINT_KEY, TAB_ADOPT_HASH, TAB_SESSION_HEADER, TAB_SESSION_STORAGE_KEY, 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, bondFloorsText, buildAddAccountUrl, buildSignInUrl, clearTabSession, consumeTabAccountHint, consumeTabAdoptMarker, familyReturnTarget, fetchOcBond, fetchOcLinkedIdentities, handleSudoRequired, installTabFetchInterceptor, installTabLinkDecorator, isSudoAccountMismatch, readTabSession, redirectToSudo, safeReturnTo, tabSessionHeader, useOcAddressSuggestion, useOcSession, useOptionalOcSession, useStepUpAuth, useWebAuthnList, useWebAuthnRegister, writeTabSession };
+export { DEFAULT_CONFIG, DISPLAY_IDENTITY_KINDS, type DisplayIdentity, type DisplayIdentityKind, FRAGMENT_TTL_MS, type OcAccount, OcAccountChip, type OcAccountChipProps, OcAccountPill, type OcAccountPillProps, type OcAccountSummary, OcAddressInput, type OcAddressInputProps, type OcAuthConfig, OcBond, type OcBondProps, type OcBondView, OcLinkedIdentities, type OcLinkedIdentitiesProps, type OcLinkedIdentity, OcSessionProvider, type OcSessionState, type OcSessionStatus, OcSignIn, OcSignInButton, type OcSignInButtonProps, type OcSignInProps, type OcSignOutScope, type OcTabSession, type RedirectToSudoArgs, SUDO_ACCOUNT_MISMATCH_MESSAGE, TAB_ACCOUNT_HINT_KEY, TAB_ADOPT_HASH, TAB_SESSION_HEADER, TAB_SESSION_STORAGE_KEY, 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, bondFloorsText, buildAddAccountUrl, buildSignInUrl, clearTabSession, consumeTabAccountHint, consumeTabAdoptMarker, familyReturnTarget, fetchOcBond, fetchOcLinkedIdentities, handleSudoRequired, installTabFetchInterceptor, installTabLinkDecorator, isSudoAccountMismatch, keepFragmentOnReturnLinks, readTabSession, redirectToSudo, restoreReturnFragment, returnToHere, safeReturnTo, stripFragment, tabSessionHeader, useOcAddressSuggestion, useOcSession, useOptionalOcSession, useStepUpAuth, useWebAuthnList, useWebAuthnRegister, withoutFragment, writeTabSession };

package/dist/index.js

@@ -26,6 +26,90 @@ var React4__namespace = /*#__PURE__*/_interopNamespace(React4);
 
 // src/provider.tsx
 
+// src/return-to.ts
+var PREFIX = "oc:return-fragment:";
+var FRAGMENT_TTL_MS = 15 * 60 * 1e3;
+function store() {
+  try {
+    return window.sessionStorage;
+  } catch {
+    return null;
+  }
+}
+function stripFragment(target) {
+  const cut = target.indexOf("#");
+  return cut < 0 ? target : target.slice(0, cut);
+}
+function keep(pathAndQuery, hash) {
+  if (hash.length < 2) return;
+  try {
+    store()?.setItem(PREFIX + pathAndQuery, JSON.stringify({ hash, at: Date.now() }));
+  } catch {
+  }
+}
+function withoutFragment(target) {
+  if (typeof window !== "undefined" && target.includes("#")) {
+    try {
+      const u = new URL(target, window.location.href);
+      if (u.origin === window.location.origin) keep(u.pathname + u.search, u.hash);
+    } catch {
+    }
+  }
+  return stripFragment(target);
+}
+function returnToHere() {
+  if (typeof window === "undefined") return "/";
+  const { pathname, search, hash } = window.location;
+  return withoutFragment(pathname + search + hash);
+}
+function keepFragmentOnReturnLinks() {
+  if (typeof document === "undefined") return () => {
+  };
+  const onClick = (e) => {
+    const { pathname, search, hash, href } = window.location;
+    if (hash.length < 2 || e.defaultPrevented) return;
+    const link = e.target?.closest?.("a[href]");
+    if (!link) return;
+    try {
+      const to = new URL(link.getAttribute("href") ?? "", href);
+      const back = to.searchParams.get("return_to");
+      if (!back) return;
+      const here = new URL(back, href);
+      if (here.origin === window.location.origin && here.pathname === pathname && here.search === search) {
+        keep(pathname + search, hash);
+      }
+    } catch {
+    }
+  };
+  document.addEventListener("click", onClick, true);
+  return () => document.removeEventListener("click", onClick, true);
+}
+function restoreReturnFragment() {
+  if (typeof window === "undefined") return false;
+  const s = store();
+  if (!s) return false;
+  const { pathname, search, hash } = window.location;
+  const key = PREFIX + pathname + search;
+  let raw;
+  try {
+    raw = s.getItem(key);
+    if (raw === null) return false;
+    s.removeItem(key);
+  } catch {
+    return false;
+  }
+  if (hash) return false;
+  try {
+    const kept = JSON.parse(raw);
+    if (typeof kept.hash !== "string" || !kept.hash.startsWith("#")) return false;
+    if (typeof kept.at !== "number" || Date.now() - kept.at > FRAGMENT_TTL_MS) return false;
+    window.history.replaceState(window.history.state, "", pathname + search + kept.hash);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
 // src/types.ts
 var DISPLAY_IDENTITY_KINDS = ["did", "btc", "email", "nostr"];
 var DEFAULT_CONFIG = {
@@ -42,7 +126,7 @@ function buildSignInUrl(cfg, returnTo) {
   const base = `${cfg.authOrigin}${cfg.signInPath}`;
   if (!returnTo) return base;
   const u = new URL(base);
-  u.searchParams.set("return_to", returnTo);
+  u.searchParams.set("return_to", stripFragment(returnTo));
   return u.toString();
 }
 function buildAddAccountUrl(cfg, returnTo) {
@@ -281,6 +365,13 @@ function OcSessionProvider({
   defaultReturnTo
 }) {
   const cfg = React4__namespace.useMemo(() => resolveConfig(config), [config]);
+  React4__namespace.useState(() => {
+    if (typeof window !== "undefined") {
+      consumeTabAdoptMarker();
+      restoreReturnFragment();
+    }
+    return null;
+  });
   const [account, setAccount] = React4__namespace.useState(null);
   const [roster, setRoster] = React4__namespace.useState([]);
   const [status, setStatus] = React4__namespace.useState("loading");
@@ -375,6 +466,7 @@ function OcSessionProvider({
       cancelled = true;
     };
   }, [refresh, cfg.authOrigin, cfg.multiAccount]);
+  React4__namespace.useEffect(() => keepFragmentOnReturnLinks(), []);
   React4__namespace.useEffect(
     () => cfg.multiAccount ? installTabFetchInterceptor(cfg.authOrigin) : void 0,
     [cfg.authOrigin, cfg.multiAccount]
@@ -871,6 +963,10 @@ function OcAccountPill({
     }
   );
 }
+function accountAddress(account) {
+  if (account?.primaryBtc) return account.primaryBtc;
+  return account?.displayIdentity?.kind === "btc" ? account.displayIdentity.value : null;
+}
 function useOcAddressSuggestion(options) {
   const {
     value,
@@ -880,7 +976,7 @@ function useOcAddressSuggestion(options) {
     suggestionClassName
   } = options;
   const { status, account } = useOcSession();
-  const sessionAddress = status === "authenticated" ? account?.primaryBtc ?? null : null;
+  const sessionAddress = status === "authenticated" ? accountAddress(account) : null;
   const [open, setOpen] = React4__namespace.useState(false);
   const [highlighted, setHighlighted] = React4__namespace.useState(false);
   const blurTimer = React4__namespace.useRef(null);
@@ -1012,7 +1108,7 @@ var OcAddressInput = React4__namespace.forwardRef(
     ...rest
   }, forwardedRef) {
     const { status, account } = useOcSession();
-    const sessionAddress = status === "authenticated" ? account?.primaryBtc ?? null : null;
+    const sessionAddress = status === "authenticated" ? accountAddress(account) : null;
     const [open, setOpen] = React4__namespace.useState(false);
     const [highlighted, setHighlighted] = React4__namespace.useState(false);
     const innerRef = React4__namespace.useRef(null);
@@ -1171,7 +1267,7 @@ function redirectToSudo(args = {}) {
   }
   const cfg = resolveConfig(args.config);
   const url = new URL("/sudo", cfg.authOrigin);
-  const returnTo = args.returnTo ?? window.location.href;
+  const returnTo = withoutFragment(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());
@@ -2535,7 +2631,9 @@ function ProviderSignIn({
   }, [authOrigin, credentials, hidden]);
   if (hidden) return null;
   if (providers !== null && providers.length === 0) return null;
-  const providerReturnTo = returnTo.startsWith("/") ? origin ? `${origin}${returnTo}` : returnTo : returnTo;
+  const providerReturnTo = stripFragment(
+    returnTo.startsWith("/") ? origin ? `${origin}${returnTo}` : returnTo : returnTo
+  );
   const line = { flex: 1, height: 1, background: "var(--border, #27272a)" };
   const BLOCK_GAP = 16;
   const BUTTON_GAP = 8;
@@ -3902,6 +4000,7 @@ function useStepUpAuth(opts) {
 
 exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
 exports.DISPLAY_IDENTITY_KINDS = DISPLAY_IDENTITY_KINDS;
+exports.FRAGMENT_TTL_MS = FRAGMENT_TTL_MS;
 exports.OcAccountChip = OcAccountChip;
 exports.OcAccountPill = OcAccountPill;
 exports.OcAddressInput = OcAddressInput;
@@ -3928,9 +4027,13 @@ exports.handleSudoRequired = handleSudoRequired;
 exports.installTabFetchInterceptor = installTabFetchInterceptor;
 exports.installTabLinkDecorator = installTabLinkDecorator;
 exports.isSudoAccountMismatch = isSudoAccountMismatch;
+exports.keepFragmentOnReturnLinks = keepFragmentOnReturnLinks;
 exports.readTabSession = readTabSession;
 exports.redirectToSudo = redirectToSudo;
+exports.restoreReturnFragment = restoreReturnFragment;
+exports.returnToHere = returnToHere;
 exports.safeReturnTo = safeReturnTo;
+exports.stripFragment = stripFragment;
 exports.tabSessionHeader = tabSessionHeader;
 exports.useOcAddressSuggestion = useOcAddressSuggestion;
 exports.useOcSession = useOcSession;
@@ -3938,6 +4041,7 @@ exports.useOptionalOcSession = useOptionalOcSession;
 exports.useStepUpAuth = useStepUpAuth;
 exports.useWebAuthnList = useWebAuthnList;
 exports.useWebAuthnRegister = useWebAuthnRegister;
+exports.withoutFragment = withoutFragment;
 exports.writeTabSession = writeTabSession;
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map