@authowl/react 0.22.0 → 0.24.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { AuthConfig, Locale, AuthOwlClient, PublicConfig, ConsentStatus, OrganizationInvitationDetails, OrganizationDetails, OrganizationMembership, HasParams, AuthUser, AuthClientError, InvitationRecipientHint, SessionState, Organization, AuthOwlErrorCode } from '@authowl/core';
+import { AuthConfig, Locale, AuthOwlClient, PublicConfig, ConsentStatus, OrganizationInvitationDetails, OrganizationDetails, OrganizationMembership, HasParams, AuthUser, AuthClientError, InvitationRecipientHint, SessionState, Organization, AuthOwlErrorCode, LastUsedSignInMethod } from '@authowl/core';
 export { AuthOwlError, AuthPasskey, ConsentStatus, HasParams, InvalidKeyError, Organization, OrganizationDetails, OrganizationInvitation, OrganizationMember, OrganizationMemberWithUser, OrganizationMembership, OrganizationRoleSummary, OrganizationTeam, OrganizationTeamMember, OrganizationUserInvitation, PublicConfig, RateLimitedError, createMembershipHas, membershipHas, membershipHasPermission, membershipHasTeam } from '@authowl/core';
 
 type Appearance = {
@@ -78,6 +78,9 @@ declare function useAuthClient(): AuthOwlClient;
 type UseAccountResult = AuthOwlClient['account'];
 /** Signed-in account profile, credential, session, provider, and deletion actions. */
 declare function useAccount(): UseAccountResult;
+type UsePrivacyResult = AuthOwlClient['privacy'];
+/** Signed-in privacy preferences and data-subject-rights actions. */
+declare function usePrivacy(): UsePrivacyResult;
 type UsePublicConfigResult = {
     config: PublicConfig | null;
     isLoading: boolean;
@@ -814,7 +817,7 @@ declare function SignOutButton({ children, redirectTo, onSignedOut, className }:
 
 declare function UserButton(): React.JSX.Element | null;
 
-declare const USER_PROFILE_SECTIONS: readonly ["profile", "email", "password", "social", "sessions", "passkeys", "mfa", "recovery", "danger"];
+declare const USER_PROFILE_SECTIONS: readonly ["profile", "email", "password", "social", "sessions", "passkeys", "mfa", "recovery", "privacy", "danger"];
 type UserProfileSection = (typeof USER_PROFILE_SECTIONS)[number];
 
 type UserProfileSharedProps = {
@@ -840,11 +843,24 @@ type UserProfileProps = UserProfileSharedProps & ({
 });
 declare function UserProfile(props?: UserProfileProps): React.JSX.Element;
 
+type PrivacyCenterProps = {
+    /** Optional class name on the privacy-center section. */
+    className?: string;
+};
+/**
+ * Managed consent and data-rights UI.
+ *
+ * The full center loads on demand because it is normally opened from account
+ * settings, keeping it out of an application's initial authentication bundle.
+ */
+declare function PrivacyCenter(props?: PrivacyCenterProps): React.JSX.Element;
+
 type OrganizationSwitcherProps = {
     showPersonalWorkspace?: boolean;
     onOrganizationChange?: (organization: Organization | null) => void;
 };
-declare function OrganizationSwitcher({ showPersonalWorkspace, onOrganizationChange }?: OrganizationSwitcherProps): React.JSX.Element | null;
+/** Organization workspace switcher, loaded when the host renders it. */
+declare function OrganizationSwitcher(props?: OrganizationSwitcherProps): React.JSX.Element;
 
 /**
  * The one screen that turns an emailed organization invitation into a
@@ -868,7 +884,8 @@ declare function InvitationPrompt(): React.JSX.Element | null;
 type OrganizationListProps = {
     onOrganizationChange?: (organization: Organization | null) => void;
 };
-declare function OrganizationList({ onOrganizationChange }?: OrganizationListProps): React.JSX.Element | null;
+/** Organization directory and invitation management, loaded on demand. */
+declare function OrganizationList(props?: OrganizationListProps): React.JSX.Element;
 
 type CreateOrganizationProps = {
     onCreated?: (organization: Organization) => void;
@@ -886,7 +903,11 @@ type OrganizationProfileProps = {
     onDeleted?: (organization: OrganizationDetails) => void;
     onLeft?: (organization: OrganizationDetails) => void;
 };
-declare function OrganizationProfile({ organizationId, defaultSection, onDeleted, onLeft }?: OrganizationProfileProps): React.JSX.Element | null;
+/**
+ * Managed organization settings, loaded when the host renders this optional
+ * administration surface.
+ */
+declare function OrganizationProfile(props?: OrganizationProfileProps): React.JSX.Element;
 
 type GoogleOneTapRuntimeErrorCode = 'script_load_failed' | 'api_unavailable' | 'configuration_conflict' | 'duplicate_instance' | 'prompt_failed';
 
@@ -901,7 +922,7 @@ type GoogleOneTapError = {
 type GoogleOneTapProps = {
     /** Disable prompting without unmounting the component. */
     disabled?: boolean;
-    /** Bind Google's ID token to this browser attempt. Generate a fresh random value server-side. */
+    /** Ask Google to include this nonce and verify the returned token carries the same value. */
     nonce?: string;
     /** Let eligible returning Google users sign in automatically. Defaults to false. */
     autoSelect?: boolean;
@@ -924,4 +945,24 @@ type GoogleOneTapProps = {
 /** Invisible, server-configured Google One Tap conversion helper. */
 declare function GoogleOneTap({ disabled, nonce, autoSelect, cancelOnTapOutside, context, itpSupport, loginHint, hostedDomain, stateCookieDomain, scriptNonce, onSignedIn, onSkipped, onDismissed, onError, }: GoogleOneTapProps): null;
 
-export { type Appearance, AuthLoaded, type AuthLoadedProps, AuthLoading, type AuthLoadingProps, AuthOwlBadge, type AuthOwlBadgeProps, AuthOwlBranding, type AuthOwlBrandingProps, AuthOwlProvider, type AuthOwlProviderProps, type AutofillHost, BackupCodesManager, type BackupCodesManagerProps, Bidi, type ConfigState, ConsentDocLinks, type ConsentDocLinksProps, ConsentGate, type ConsentGateProps, CreateOrganization, type CreateOrganizationProps, DEFAULT_BRAND_COLOR, EmailOtpForm, type EmailOtpFormProps, ForgotPassword, type ForgotPasswordProps, GoogleOneTap, type GoogleOneTapDismissReason, type GoogleOneTapError, type GoogleOneTapErrorCode, type GoogleOneTapProps, type GoogleOneTapSkipReason, InvitationPrompt, type InvitationPromptStatus, KNOWN_METHODS, type KnownMethod, MFAChallenge, type MFAChallengeProps, MFAEnrollment, type MFAEnrollmentProps, MFARequiredGate, type MFARequiredGateProps, MagicLinkForm, type MagicLinkFormProps, OrganizationList, type OrganizationListProps, OrganizationProfile, type OrganizationProfileProps, type OrganizationProfileSection, OrganizationSwitcher, type OrganizationSwitcherProps, PasskeyButton, type PasskeyButtonProps, PasskeyManager, type PasskeyManagerProps, PhoneOTP, type PhoneOTPProps, Protect, type ProtectProps, ResetPassword, type ResetPasswordProps, SignIn, type SignInPlan, type SignInProps, SignOutButton, type SignOutButtonProps, SignUp, type SignUpProps, SignedIn, type SignedInProps, SignedOut, type SignedOutProps, SocialButtons, type SocialButtonsProps, Spinner, type UseAccountResult, type UseAuthResult, type UseConsentResult, type UseEmailVerificationResult, type UseMFAResult, type UseOrganizationInvitationResult, type UseOrganizationResult, type UsePasskeysResult, type UsePasswordResetResult, type UsePublicConfigResult, type UseSignInResult, type UseSignOutResult, type UseSignUpResult, type UseUserResult, type UseWaitlistResult, UserButton, UserProfile, type UserProfileProps, type UserProfileSection, VerificationPending, type VerificationPendingProps, VerifyEmail, type VerifyEmailProps, Waitlist, type WaitlistProps, emailAutocomplete, resolveSignInMethods, useAccount, useAuth, useAuthClient, useAuthOwlContext, useConsent, useEmailVerification, useInvitationRecipientHint, useLocale, useMFA, useOrganization, useOrganizationInvitation, usePasskeys, usePasswordReset, usePublicConfig, useSession, useSignIn, useSignOut, useSignUp, useUser, useWaitlist };
+/**
+ * Which sign-in method last worked in this browser, for this project.
+ *
+ * Two kinds of method need different treatment, and conflating them is the bug
+ * this shape exists to avoid:
+ *
+ *   completes in page   password, email-OTP verification, passkey - observable
+ *                       success, so it is recorded when it happens.
+ *
+ *   leaves the page     social, SSO, magic link - the page that would observe
+ *                       success is one the browser navigates away from. The
+ *                       attempt is PARKED and promoted only when a session
+ *                       actually appears, so bouncing off a consent screen does
+ *                       not teach the form that the provider worked.
+ *
+ * Everything is per project and per browser, and never keyed by an identifier -
+ * see the core module for why that line matters.
+ */
+declare function useLastUsedSignInMethod(): LastUsedSignInMethod | null;
+
+export { type Appearance, AuthLoaded, type AuthLoadedProps, AuthLoading, type AuthLoadingProps, AuthOwlBadge, type AuthOwlBadgeProps, AuthOwlBranding, type AuthOwlBrandingProps, AuthOwlProvider, type AuthOwlProviderProps, type AutofillHost, BackupCodesManager, type BackupCodesManagerProps, Bidi, type ConfigState, ConsentDocLinks, type ConsentDocLinksProps, ConsentGate, type ConsentGateProps, CreateOrganization, type CreateOrganizationProps, DEFAULT_BRAND_COLOR, EmailOtpForm, type EmailOtpFormProps, ForgotPassword, type ForgotPasswordProps, GoogleOneTap, type GoogleOneTapDismissReason, type GoogleOneTapError, type GoogleOneTapErrorCode, type GoogleOneTapProps, type GoogleOneTapSkipReason, InvitationPrompt, type InvitationPromptStatus, KNOWN_METHODS, type KnownMethod, MFAChallenge, type MFAChallengeProps, MFAEnrollment, type MFAEnrollmentProps, MFARequiredGate, type MFARequiredGateProps, MagicLinkForm, type MagicLinkFormProps, OrganizationList, type OrganizationListProps, OrganizationProfile, type OrganizationProfileProps, type OrganizationProfileSection, OrganizationSwitcher, type OrganizationSwitcherProps, PasskeyButton, type PasskeyButtonProps, PasskeyManager, type PasskeyManagerProps, PhoneOTP, type PhoneOTPProps, PrivacyCenter, type PrivacyCenterProps, Protect, type ProtectProps, ResetPassword, type ResetPasswordProps, SignIn, type SignInPlan, type SignInProps, SignOutButton, type SignOutButtonProps, SignUp, type SignUpProps, SignedIn, type SignedInProps, SignedOut, type SignedOutProps, SocialButtons, type SocialButtonsProps, Spinner, type UseAccountResult, type UseAuthResult, type UseConsentResult, type UseEmailVerificationResult, type UseMFAResult, type UseOrganizationInvitationResult, type UseOrganizationResult, type UsePasskeysResult, type UsePasswordResetResult, type UsePrivacyResult, type UsePublicConfigResult, type UseSignInResult, type UseSignOutResult, type UseSignUpResult, type UseUserResult, type UseWaitlistResult, UserButton, UserProfile, type UserProfileProps, type UserProfileSection, VerificationPending, type VerificationPendingProps, VerifyEmail, type VerifyEmailProps, Waitlist, type WaitlistProps, emailAutocomplete, resolveSignInMethods, useAccount, useAuth, useAuthClient, useAuthOwlContext, useConsent, useEmailVerification, useInvitationRecipientHint, useLastUsedSignInMethod, useLocale, useMFA, useOrganization, useOrganizationInvitation, usePasskeys, usePasswordReset, usePrivacy, usePublicConfig, useSession, useSignIn, useSignOut, useSignUp, useUser, useWaitlist };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { AuthConfig, Locale, AuthOwlClient, PublicConfig, ConsentStatus, OrganizationInvitationDetails, OrganizationDetails, OrganizationMembership, HasParams, AuthUser, AuthClientError, InvitationRecipientHint, SessionState, Organization, AuthOwlErrorCode } from '@authowl/core';
+import { AuthConfig, Locale, AuthOwlClient, PublicConfig, ConsentStatus, OrganizationInvitationDetails, OrganizationDetails, OrganizationMembership, HasParams, AuthUser, AuthClientError, InvitationRecipientHint, SessionState, Organization, AuthOwlErrorCode, LastUsedSignInMethod } from '@authowl/core';
 export { AuthOwlError, AuthPasskey, ConsentStatus, HasParams, InvalidKeyError, Organization, OrganizationDetails, OrganizationInvitation, OrganizationMember, OrganizationMemberWithUser, OrganizationMembership, OrganizationRoleSummary, OrganizationTeam, OrganizationTeamMember, OrganizationUserInvitation, PublicConfig, RateLimitedError, createMembershipHas, membershipHas, membershipHasPermission, membershipHasTeam } from '@authowl/core';
 
 type Appearance = {
@@ -78,6 +78,9 @@ declare function useAuthClient(): AuthOwlClient;
 type UseAccountResult = AuthOwlClient['account'];
 /** Signed-in account profile, credential, session, provider, and deletion actions. */
 declare function useAccount(): UseAccountResult;
+type UsePrivacyResult = AuthOwlClient['privacy'];
+/** Signed-in privacy preferences and data-subject-rights actions. */
+declare function usePrivacy(): UsePrivacyResult;
 type UsePublicConfigResult = {
     config: PublicConfig | null;
     isLoading: boolean;
@@ -814,7 +817,7 @@ declare function SignOutButton({ children, redirectTo, onSignedOut, className }:
 
 declare function UserButton(): React.JSX.Element | null;
 
-declare const USER_PROFILE_SECTIONS: readonly ["profile", "email", "password", "social", "sessions", "passkeys", "mfa", "recovery", "danger"];
+declare const USER_PROFILE_SECTIONS: readonly ["profile", "email", "password", "social", "sessions", "passkeys", "mfa", "recovery", "privacy", "danger"];
 type UserProfileSection = (typeof USER_PROFILE_SECTIONS)[number];
 
 type UserProfileSharedProps = {
@@ -840,11 +843,24 @@ type UserProfileProps = UserProfileSharedProps & ({
 });
 declare function UserProfile(props?: UserProfileProps): React.JSX.Element;
 
+type PrivacyCenterProps = {
+    /** Optional class name on the privacy-center section. */
+    className?: string;
+};
+/**
+ * Managed consent and data-rights UI.
+ *
+ * The full center loads on demand because it is normally opened from account
+ * settings, keeping it out of an application's initial authentication bundle.
+ */
+declare function PrivacyCenter(props?: PrivacyCenterProps): React.JSX.Element;
+
 type OrganizationSwitcherProps = {
     showPersonalWorkspace?: boolean;
     onOrganizationChange?: (organization: Organization | null) => void;
 };
-declare function OrganizationSwitcher({ showPersonalWorkspace, onOrganizationChange }?: OrganizationSwitcherProps): React.JSX.Element | null;
+/** Organization workspace switcher, loaded when the host renders it. */
+declare function OrganizationSwitcher(props?: OrganizationSwitcherProps): React.JSX.Element;
 
 /**
  * The one screen that turns an emailed organization invitation into a
@@ -868,7 +884,8 @@ declare function InvitationPrompt(): React.JSX.Element | null;
 type OrganizationListProps = {
     onOrganizationChange?: (organization: Organization | null) => void;
 };
-declare function OrganizationList({ onOrganizationChange }?: OrganizationListProps): React.JSX.Element | null;
+/** Organization directory and invitation management, loaded on demand. */
+declare function OrganizationList(props?: OrganizationListProps): React.JSX.Element;
 
 type CreateOrganizationProps = {
     onCreated?: (organization: Organization) => void;
@@ -886,7 +903,11 @@ type OrganizationProfileProps = {
     onDeleted?: (organization: OrganizationDetails) => void;
     onLeft?: (organization: OrganizationDetails) => void;
 };
-declare function OrganizationProfile({ organizationId, defaultSection, onDeleted, onLeft }?: OrganizationProfileProps): React.JSX.Element | null;
+/**
+ * Managed organization settings, loaded when the host renders this optional
+ * administration surface.
+ */
+declare function OrganizationProfile(props?: OrganizationProfileProps): React.JSX.Element;
 
 type GoogleOneTapRuntimeErrorCode = 'script_load_failed' | 'api_unavailable' | 'configuration_conflict' | 'duplicate_instance' | 'prompt_failed';
 
@@ -901,7 +922,7 @@ type GoogleOneTapError = {
 type GoogleOneTapProps = {
     /** Disable prompting without unmounting the component. */
     disabled?: boolean;
-    /** Bind Google's ID token to this browser attempt. Generate a fresh random value server-side. */
+    /** Ask Google to include this nonce and verify the returned token carries the same value. */
     nonce?: string;
     /** Let eligible returning Google users sign in automatically. Defaults to false. */
     autoSelect?: boolean;
@@ -924,4 +945,24 @@ type GoogleOneTapProps = {
 /** Invisible, server-configured Google One Tap conversion helper. */
 declare function GoogleOneTap({ disabled, nonce, autoSelect, cancelOnTapOutside, context, itpSupport, loginHint, hostedDomain, stateCookieDomain, scriptNonce, onSignedIn, onSkipped, onDismissed, onError, }: GoogleOneTapProps): null;
 
-export { type Appearance, AuthLoaded, type AuthLoadedProps, AuthLoading, type AuthLoadingProps, AuthOwlBadge, type AuthOwlBadgeProps, AuthOwlBranding, type AuthOwlBrandingProps, AuthOwlProvider, type AuthOwlProviderProps, type AutofillHost, BackupCodesManager, type BackupCodesManagerProps, Bidi, type ConfigState, ConsentDocLinks, type ConsentDocLinksProps, ConsentGate, type ConsentGateProps, CreateOrganization, type CreateOrganizationProps, DEFAULT_BRAND_COLOR, EmailOtpForm, type EmailOtpFormProps, ForgotPassword, type ForgotPasswordProps, GoogleOneTap, type GoogleOneTapDismissReason, type GoogleOneTapError, type GoogleOneTapErrorCode, type GoogleOneTapProps, type GoogleOneTapSkipReason, InvitationPrompt, type InvitationPromptStatus, KNOWN_METHODS, type KnownMethod, MFAChallenge, type MFAChallengeProps, MFAEnrollment, type MFAEnrollmentProps, MFARequiredGate, type MFARequiredGateProps, MagicLinkForm, type MagicLinkFormProps, OrganizationList, type OrganizationListProps, OrganizationProfile, type OrganizationProfileProps, type OrganizationProfileSection, OrganizationSwitcher, type OrganizationSwitcherProps, PasskeyButton, type PasskeyButtonProps, PasskeyManager, type PasskeyManagerProps, PhoneOTP, type PhoneOTPProps, Protect, type ProtectProps, ResetPassword, type ResetPasswordProps, SignIn, type SignInPlan, type SignInProps, SignOutButton, type SignOutButtonProps, SignUp, type SignUpProps, SignedIn, type SignedInProps, SignedOut, type SignedOutProps, SocialButtons, type SocialButtonsProps, Spinner, type UseAccountResult, type UseAuthResult, type UseConsentResult, type UseEmailVerificationResult, type UseMFAResult, type UseOrganizationInvitationResult, type UseOrganizationResult, type UsePasskeysResult, type UsePasswordResetResult, type UsePublicConfigResult, type UseSignInResult, type UseSignOutResult, type UseSignUpResult, type UseUserResult, type UseWaitlistResult, UserButton, UserProfile, type UserProfileProps, type UserProfileSection, VerificationPending, type VerificationPendingProps, VerifyEmail, type VerifyEmailProps, Waitlist, type WaitlistProps, emailAutocomplete, resolveSignInMethods, useAccount, useAuth, useAuthClient, useAuthOwlContext, useConsent, useEmailVerification, useInvitationRecipientHint, useLocale, useMFA, useOrganization, useOrganizationInvitation, usePasskeys, usePasswordReset, usePublicConfig, useSession, useSignIn, useSignOut, useSignUp, useUser, useWaitlist };
+/**
+ * Which sign-in method last worked in this browser, for this project.
+ *
+ * Two kinds of method need different treatment, and conflating them is the bug
+ * this shape exists to avoid:
+ *
+ *   completes in page   password, email-OTP verification, passkey - observable
+ *                       success, so it is recorded when it happens.
+ *
+ *   leaves the page     social, SSO, magic link - the page that would observe
+ *                       success is one the browser navigates away from. The
+ *                       attempt is PARKED and promoted only when a session
+ *                       actually appears, so bouncing off a consent screen does
+ *                       not teach the form that the provider worked.
+ *
+ * Everything is per project and per browser, and never keyed by an identifier -
+ * see the core module for why that line matters.
+ */
+declare function useLastUsedSignInMethod(): LastUsedSignInMethod | null;
+
+export { type Appearance, AuthLoaded, type AuthLoadedProps, AuthLoading, type AuthLoadingProps, AuthOwlBadge, type AuthOwlBadgeProps, AuthOwlBranding, type AuthOwlBrandingProps, AuthOwlProvider, type AuthOwlProviderProps, type AutofillHost, BackupCodesManager, type BackupCodesManagerProps, Bidi, type ConfigState, ConsentDocLinks, type ConsentDocLinksProps, ConsentGate, type ConsentGateProps, CreateOrganization, type CreateOrganizationProps, DEFAULT_BRAND_COLOR, EmailOtpForm, type EmailOtpFormProps, ForgotPassword, type ForgotPasswordProps, GoogleOneTap, type GoogleOneTapDismissReason, type GoogleOneTapError, type GoogleOneTapErrorCode, type GoogleOneTapProps, type GoogleOneTapSkipReason, InvitationPrompt, type InvitationPromptStatus, KNOWN_METHODS, type KnownMethod, MFAChallenge, type MFAChallengeProps, MFAEnrollment, type MFAEnrollmentProps, MFARequiredGate, type MFARequiredGateProps, MagicLinkForm, type MagicLinkFormProps, OrganizationList, type OrganizationListProps, OrganizationProfile, type OrganizationProfileProps, type OrganizationProfileSection, OrganizationSwitcher, type OrganizationSwitcherProps, PasskeyButton, type PasskeyButtonProps, PasskeyManager, type PasskeyManagerProps, PhoneOTP, type PhoneOTPProps, PrivacyCenter, type PrivacyCenterProps, Protect, type ProtectProps, ResetPassword, type ResetPasswordProps, SignIn, type SignInPlan, type SignInProps, SignOutButton, type SignOutButtonProps, SignUp, type SignUpProps, SignedIn, type SignedInProps, SignedOut, type SignedOutProps, SocialButtons, type SocialButtonsProps, Spinner, type UseAccountResult, type UseAuthResult, type UseConsentResult, type UseEmailVerificationResult, type UseMFAResult, type UseOrganizationInvitationResult, type UseOrganizationResult, type UsePasskeysResult, type UsePasswordResetResult, type UsePrivacyResult, type UsePublicConfigResult, type UseSignInResult, type UseSignOutResult, type UseSignUpResult, type UseUserResult, type UseWaitlistResult, UserButton, UserProfile, type UserProfileProps, type UserProfileSection, VerificationPending, type VerificationPendingProps, VerifyEmail, type VerifyEmailProps, Waitlist, type WaitlistProps, emailAutocomplete, resolveSignInMethods, useAccount, useAuth, useAuthClient, useAuthOwlContext, useConsent, useEmailVerification, useInvitationRecipientHint, useLastUsedSignInMethod, useLocale, useMFA, useOrganization, useOrganizationInvitation, usePasskeys, usePasswordReset, usePrivacy, usePublicConfig, useSession, useSignIn, useSignOut, useSignUp, useUser, useWaitlist };