@authowl/react 0.18.10 → 0.19.1

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { AuthConfig, Locale, AuthOwlClient, PublicConfig, ConsentStatus, OrganizationDetails, OrganizationMembership, HasParams, AuthUser, AuthClientError, SessionState, Organization, AuthOwlErrorCode } from '@authowl/core';
+import { AuthConfig, Locale, AuthOwlClient, PublicConfig, ConsentStatus, OrganizationInvitationDetails, OrganizationDetails, OrganizationMembership, HasParams, AuthUser, AuthClientError, SessionState, Organization, AuthOwlErrorCode } from '@authowl/core';
 export { AuthOwlError, AuthPasskey, ConsentStatus, HasParams, InvalidKeyError, Organization, OrganizationDetails, OrganizationInvitation, OrganizationMember, OrganizationMemberWithUser, OrganizationMembership, OrganizationRoleSummary, OrganizationTeam, OrganizationUserInvitation, PublicConfig, RateLimitedError, createMembershipHas, membershipHas, membershipHasPermission, membershipHasTeam } from '@authowl/core';
 
 type Appearance = {
@@ -26,9 +26,19 @@ type AuthOwlProviderProps = AuthConfig & {
      * project's default from public-config ('en' until the config loads).
      */
     locale?: Locale | 'auto';
+    /**
+     * Render the organization-invitation prompt when this browser arrives from an
+     * invitation link. Default true, because the link is otherwise inert: the
+     * emailed URL lands on the operator's own page and nothing else redeems it.
+     *
+     * Pass false for a headless app - it never imports our stylesheet, so the
+     * modal would render unstyled - and drive `useOrganizationInvitation()`
+     * instead.
+     */
+    invitationPrompt?: boolean;
     children: React.ReactNode;
 };
-declare function AuthOwlProvider({ publishableKey, apiUrl, fetch, appearance, locale: localeProp, children, }: AuthOwlProviderProps): React.JSX.Element;
+declare function AuthOwlProvider({ publishableKey, apiUrl, fetch, appearance, locale: localeProp, invitationPrompt, children, }: AuthOwlProviderProps): React.JSX.Element;
 declare function useAuthOwlContext(): Ctx;
 
 /** The active component locale (resolved by <AuthOwlProvider>). */
@@ -149,6 +159,30 @@ type UseOrganizationResult = {
  * the active org when one is set. Advisory, like the rest of the client surface.
  */
 declare function useOrganization(): UseOrganizationResult;
+type InvitationPromptStatus = 'idle' | 'loading' | 'ready' | 'joining' | 'wrong_account' | 'verify_email' | 'gone' | 'error';
+type UseOrganizationInvitationResult = {
+    /** The stashed invitation once it has been read back, else null. */
+    invitation: OrganizationInvitationDetails | null;
+    status: InvitationPromptStatus;
+    /** Redeem it. Resolves true when the membership was written. */
+    accept: () => Promise<boolean>;
+    /** Forget it locally. Never rejects it server-side - that is a terminal state. */
+    dismiss: () => void;
+};
+/**
+ * The organization invitation this browser arrived carrying, if any.
+ *
+ * The emailed link lands on the operator's page with `?authowl_invitation=<id>`
+ * and the only route that can redeem it needs a session, which the invitee
+ * usually does not have yet. `AuthOwlProvider` captures the id into storage on
+ * mount so it survives the sign-up's own redirects; this hook reads it back once
+ * a session exists and drives the redemption.
+ *
+ * The details come from `getInvitation`, which is recipient-only - so the
+ * organization's name is available to the person invited and to nobody else,
+ * and no pre-authentication call can leak it.
+ */
+declare function useOrganizationInvitation(): UseOrganizationInvitationResult;
 type UseSignInResult = {
     /** Email + password sign-in. */
     signIn: AuthOwlClient['signIn']['email'];
@@ -788,6 +822,25 @@ type OrganizationSwitcherProps = {
 };
 declare function OrganizationSwitcher({ showPersonalWorkspace, onOrganizationChange }?: OrganizationSwitcherProps): React.JSX.Element | null;
 
+/**
+ * The one screen that turns an emailed organization invitation into a
+ * membership.
+ *
+ * It is CONFIRMED rather than automatic, and the reason is not taste: accepting
+ * can fail for reasons the user has to see and can act on - the organization is
+ * at its member cap, the role no longer fits the claim budget, the invitation
+ * expired, the session belongs to a different address. An automatic redeem has
+ * nowhere to render any of that, which would recreate the very defect this fixes
+ * (a flow that reports success and produces no membership) one layer up.
+ *
+ * `AuthOwlProvider` renders this, so an operator who mounts our components
+ * anywhere gets a working invitation flow without adding a route. Headless
+ * consumers pass `invitationPrompt={false}` and drive
+ * {@link useOrganizationInvitation} themselves - they never import our
+ * stylesheet, so the default modal would render unstyled for them.
+ */
+declare function InvitationPrompt(): React.JSX.Element | null;
+
 type OrganizationListProps = {
     onOrganizationChange?: (organization: Organization | null) => void;
 };
@@ -847,4 +900,4 @@ 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, 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 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, useLocale, useMFA, useOrganization, usePasskeys, usePasswordReset, usePublicConfig, useSession, useSignIn, useSignOut, useSignUp, useUser, useWaitlist };
+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, useLocale, useMFA, useOrganization, useOrganizationInvitation, usePasskeys, usePasswordReset, 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, OrganizationDetails, OrganizationMembership, HasParams, AuthUser, AuthClientError, SessionState, Organization, AuthOwlErrorCode } from '@authowl/core';
+import { AuthConfig, Locale, AuthOwlClient, PublicConfig, ConsentStatus, OrganizationInvitationDetails, OrganizationDetails, OrganizationMembership, HasParams, AuthUser, AuthClientError, SessionState, Organization, AuthOwlErrorCode } from '@authowl/core';
 export { AuthOwlError, AuthPasskey, ConsentStatus, HasParams, InvalidKeyError, Organization, OrganizationDetails, OrganizationInvitation, OrganizationMember, OrganizationMemberWithUser, OrganizationMembership, OrganizationRoleSummary, OrganizationTeam, OrganizationUserInvitation, PublicConfig, RateLimitedError, createMembershipHas, membershipHas, membershipHasPermission, membershipHasTeam } from '@authowl/core';
 
 type Appearance = {
@@ -26,9 +26,19 @@ type AuthOwlProviderProps = AuthConfig & {
      * project's default from public-config ('en' until the config loads).
      */
     locale?: Locale | 'auto';
+    /**
+     * Render the organization-invitation prompt when this browser arrives from an
+     * invitation link. Default true, because the link is otherwise inert: the
+     * emailed URL lands on the operator's own page and nothing else redeems it.
+     *
+     * Pass false for a headless app - it never imports our stylesheet, so the
+     * modal would render unstyled - and drive `useOrganizationInvitation()`
+     * instead.
+     */
+    invitationPrompt?: boolean;
     children: React.ReactNode;
 };
-declare function AuthOwlProvider({ publishableKey, apiUrl, fetch, appearance, locale: localeProp, children, }: AuthOwlProviderProps): React.JSX.Element;
+declare function AuthOwlProvider({ publishableKey, apiUrl, fetch, appearance, locale: localeProp, invitationPrompt, children, }: AuthOwlProviderProps): React.JSX.Element;
 declare function useAuthOwlContext(): Ctx;
 
 /** The active component locale (resolved by <AuthOwlProvider>). */
@@ -149,6 +159,30 @@ type UseOrganizationResult = {
  * the active org when one is set. Advisory, like the rest of the client surface.
  */
 declare function useOrganization(): UseOrganizationResult;
+type InvitationPromptStatus = 'idle' | 'loading' | 'ready' | 'joining' | 'wrong_account' | 'verify_email' | 'gone' | 'error';
+type UseOrganizationInvitationResult = {
+    /** The stashed invitation once it has been read back, else null. */
+    invitation: OrganizationInvitationDetails | null;
+    status: InvitationPromptStatus;
+    /** Redeem it. Resolves true when the membership was written. */
+    accept: () => Promise<boolean>;
+    /** Forget it locally. Never rejects it server-side - that is a terminal state. */
+    dismiss: () => void;
+};
+/**
+ * The organization invitation this browser arrived carrying, if any.
+ *
+ * The emailed link lands on the operator's page with `?authowl_invitation=<id>`
+ * and the only route that can redeem it needs a session, which the invitee
+ * usually does not have yet. `AuthOwlProvider` captures the id into storage on
+ * mount so it survives the sign-up's own redirects; this hook reads it back once
+ * a session exists and drives the redemption.
+ *
+ * The details come from `getInvitation`, which is recipient-only - so the
+ * organization's name is available to the person invited and to nobody else,
+ * and no pre-authentication call can leak it.
+ */
+declare function useOrganizationInvitation(): UseOrganizationInvitationResult;
 type UseSignInResult = {
     /** Email + password sign-in. */
     signIn: AuthOwlClient['signIn']['email'];
@@ -788,6 +822,25 @@ type OrganizationSwitcherProps = {
 };
 declare function OrganizationSwitcher({ showPersonalWorkspace, onOrganizationChange }?: OrganizationSwitcherProps): React.JSX.Element | null;
 
+/**
+ * The one screen that turns an emailed organization invitation into a
+ * membership.
+ *
+ * It is CONFIRMED rather than automatic, and the reason is not taste: accepting
+ * can fail for reasons the user has to see and can act on - the organization is
+ * at its member cap, the role no longer fits the claim budget, the invitation
+ * expired, the session belongs to a different address. An automatic redeem has
+ * nowhere to render any of that, which would recreate the very defect this fixes
+ * (a flow that reports success and produces no membership) one layer up.
+ *
+ * `AuthOwlProvider` renders this, so an operator who mounts our components
+ * anywhere gets a working invitation flow without adding a route. Headless
+ * consumers pass `invitationPrompt={false}` and drive
+ * {@link useOrganizationInvitation} themselves - they never import our
+ * stylesheet, so the default modal would render unstyled for them.
+ */
+declare function InvitationPrompt(): React.JSX.Element | null;
+
 type OrganizationListProps = {
     onOrganizationChange?: (organization: Organization | null) => void;
 };
@@ -847,4 +900,4 @@ 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, 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 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, useLocale, useMFA, useOrganization, usePasskeys, usePasswordReset, usePublicConfig, useSession, useSignIn, useSignOut, useSignUp, useUser, useWaitlist };
+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, useLocale, useMFA, useOrganization, useOrganizationInvitation, usePasskeys, usePasswordReset, usePublicConfig, useSession, useSignIn, useSignOut, useSignUp, useUser, useWaitlist };