cauthy-auth 0.30.0 → 0.32.0

package/dist/react.d.ts

@@ -403,11 +403,25 @@ type AuthResult<S extends string, More = unknown> = ({
 };
 /** What the screen may offer. */
 interface AuthMethods {
-    /** The providers the workspace signs people in with: `{ id: 'google', name: 'Google' }`. */
+    /**
+     * The providers the workspace signs people in with and has turned on:
+     * `{ id: 'google', name: 'Google', iconUrl: 'https://…/v1/social/icons/google.svg' }`.
+     * `iconUrl` is the provider's logo, served by Cauthy; absent from a Cauthy
+     * that does not serve logos.
+     */
     providers: {
         id: string;
         name: string;
+        iconUrl?: string;
     }[];
+    /**
+     * Whether the workspace signs people in with a password. False: the
+     * password field, "forgot your password" and a sign-up with a password are
+     * not offered, and Cauthy refuses them (`password_disabled`). True from a
+     * server that does not say. (`password` is something else: the policy a new
+     * password must meet.)
+     */
+    passwordSignIn: boolean;
     /** Whether people may create an account themselves. */
     signUp: boolean;
     /** Set when the application's system makes an organization per sign-up: the form asks the company's name. */
@@ -416,7 +430,7 @@ interface AuthMethods {
         required: boolean;
     };
     magicLink: boolean;
-    /** Whether to offer a passkey. */
+    /** Whether to offer a passkey. False when the workspace turned passkeys off. */
     passkey: boolean;
     /**
      * Whether the passkey is used on this page itself. False: `signIn.passkey`
@@ -468,6 +482,15 @@ interface AuthMethods {
      */
     password?: PasswordPolicy;
 }
+/** An invitation, as its page shows it before the person chooses a password. */
+interface Invitation {
+    /** The address invited: the account the person signs in as. */
+    email: string;
+    /** The workspace's name. */
+    workspace: string;
+    /** The organization the person was invited to, when there is one. */
+    organization?: string;
+}
 /** A legal document the person owes: not yet accepted in its current version. */
 interface PendingLegal {
     kind: string;
@@ -1059,7 +1082,25 @@ interface AuthClient {
         token: string;
         password: string;
     }): Promise<AuthResult<'changed'>>;
-    /** Confirms the address, with the token the mailed link opened the page with (`token`). */
+    /**
+     * Who an invitation is for and to what, with the token the mailed link
+     * opened the page with (`token`). Reading it does not spend it.
+     * `invalid_token`: unknown, spent or expired.
+     */
+    invitation(token: string): Promise<AuthResult<'ok', {
+        invitation: Invitation;
+    }>>;
+    /**
+     * Accepts an invitation with the password the person chose (the workspace's
+     * policy, as for a sign-up) and signs them in. `mfa_required`: the account
+     * owes a second step; ask for the code and call `signIn.mfa`, as after
+     * `signIn.email`. A password refused leaves the invitation good.
+     */
+    acceptInvitation(token: string, password: string): Promise<AuthResult<'signed_in', {
+        session: PublicSession;
+    }> | AuthResult<'mfa_required', {
+        method?: 'email';
+    }>>;
     /** Confirms the address a mailed link is for. The person is signed in from the link when their account asks no second step. */
     verifyEmail(form: {
         token: string;
@@ -1139,6 +1180,8 @@ interface AuthTexts {
     removePhone: string;
     bySms: string;
     byWhatsapp: string;
+    /** The label of the channel phone codes go by, where the application draws it as a select. */
+    channel: string;
     verify: string;
     checkEmail: string;
     backToSignIn: string;
@@ -1151,6 +1194,13 @@ interface AuthTexts {
     passwordChanged: string;
     confirming: string;
     emailConfirmed: string;
+    invitedTo: string;
+    invitedToOrganization: string;
+    invitedAs: string;
+    choosePassword: string;
+    acceptInvite: string;
+    openingInvitation: string;
+    invitationInvalid: string;
     profile: string;
     save: string;
     saved: string;
@@ -1223,10 +1273,13 @@ interface AuthTexts {
     organizationDeleted: string;
     yes: string;
     cancel: string;
+    termsChanged: string;
+    termsChangedHelp: string;
+    acceptTerms: string;
     /** By error code; one missing shows what the server said. */
     errors: Record<string, string>;
 }
-type Slot = 'form' | 'field' | 'label' | 'input' | 'button' | 'providerButton' | 'link' | 'error' | 'fieldError' | 'hint' | 'notice' | 'separator' | 'footer' | 'check' | 'account' | 'section' | 'heading' | 'secret' | 'codes' | 'sessions' | 'session';
+type Slot = 'form' | 'field' | 'label' | 'input' | 'button' | 'providerButton' | 'providerIcon' | 'link' | 'error' | 'fieldError' | 'hint' | 'notice' | 'separator' | 'footer' | 'check' | 'account' | 'section' | 'heading' | 'secret' | 'codes' | 'sessions' | 'session';
 interface AuthFormProps {
     /** The language of the built-in sentences. Default: `en`. */
     locale?: 'en' | 'es';
@@ -1265,34 +1318,138 @@ interface AuthFormProps {
      */
     workspaceLook?: boolean;
     /**
-     * The application's own button and input, to draw the form with. Each is
-     * given what a `<button>` or an `<input>` would be.
+     * The application's own parts, to draw the form with: its button, input,
+     * checkbox, select, field, text, badge, link, divider, alert and
+     * confirmation. A part not given is drawn as before; with every part given
+     * and `unstyled`, the form adds no element that carries a look of its own.
      */
-    components?: {
-        Button?: ComponentType<{
-            type: 'submit' | 'button';
-            disabled?: boolean;
-            className?: string;
-            onClick?: () => void;
-            children: ReactNode;
-        }>;
-        Input?: ComponentType<{
-            id: string;
-            name: string;
-            type: string;
+    components?: AuthComponents;
+}
+/** What the application's button is given: what a `<button>` would be. */
+interface AuthButtonProps {
+    type: 'submit' | 'button';
+    disabled?: boolean;
+    className?: string;
+    onClick?: () => void;
+    children: ReactNode;
+}
+/** What the application's input is given: what an `<input>` would be. */
+interface AuthInputProps {
+    id: string;
+    name: string;
+    type: string;
+    value: string;
+    autoComplete?: string;
+    required?: boolean;
+    className?: string;
+    'aria-invalid'?: boolean;
+    'aria-describedby'?: string;
+    onChange: (e: {
+        target: {
             value: string;
-            autoComplete?: string;
-            required?: boolean;
-            className?: string;
-            'aria-invalid'?: boolean;
-            'aria-describedby'?: string;
-            onChange: (e: {
-                target: {
-                    value: string;
-                };
-            }) => void;
-        }>;
-    };
+        };
+    }) => void;
+}
+/** A box to tick: the legal documents and each consent of a sign-up. `children` is its label. */
+interface AuthCheckboxProps {
+    id: string;
+    name: string;
+    checked: boolean;
+    required?: boolean;
+    disabled?: boolean;
+    className?: string;
+    onChange: (checked: boolean) => void;
+    children: ReactNode;
+}
+/** One choice of a few: a member's role, the channel of phone codes. Without a visible label it carries `aria-label`. */
+interface AuthSelectProps {
+    id: string;
+    name: string;
+    value: string;
+    options: {
+        value: string;
+        label: string;
+    }[];
+    disabled?: boolean;
+    className?: string;
+    'aria-label'?: string;
+    onChange: (value: string) => void;
+}
+/**
+ * A label, its control (`children`) and what is said under it. The control's
+ * `aria-describedby` names `${id}-hint` and `${id}-error`: give the help and
+ * the error those ids for a screen reader to read them with it.
+ */
+interface AuthFieldProps {
+    id: string;
+    label: ReactNode;
+    children: ReactNode;
+    /** Beside the label: "Forgot your password?". */
+    aside?: ReactNode;
+    /** What the field takes (a new password's rule). Not given while there is an error. */
+    help?: ReactNode;
+    error?: ReactNode;
+    required?: boolean;
+    className?: string;
+}
+/** A sentence of the form: help, a state, the footer (`size: 'sm'`), a section's heading (`as: 'h2'`). */
+interface AuthTextProps {
+    as?: 'p' | 'span' | 'h2';
+    tone?: 'muted' | 'danger' | 'success';
+    size?: 'sm' | 'md' | 'lg';
+    children: ReactNode;
+}
+/** A short mark beside a name: "you", "invited", a role, a passkey's kind. */
+interface AuthBadgeProps {
+    tone?: 'neutral' | 'success' | 'warning' | 'danger';
+    children: ReactNode;
+}
+/** A link: to another screen, or a legal document (`newTab`). */
+interface AuthLinkProps {
+    href?: string;
+    onClick?: () => void;
+    newTab?: boolean;
+    children: ReactNode;
+}
+/** The line between the providers and the address: "or with your email". */
+interface AuthDividerProps {
+    label?: ReactNode;
+}
+/**
+ * What went wrong (`danger`), what was done (`success`) or what to know
+ * (`info`). The built-in one is announced: `role="alert"` for danger,
+ * `role="status"` otherwise; the application's should be too.
+ */
+interface AuthAlertProps {
+    tone: 'danger' | 'info' | 'success';
+    children: ReactNode;
+}
+/** What a confirmation asks: removing a member, leaving, archiving or deleting the organization. */
+interface AuthConfirmOptions {
+    title: string;
+    body?: string;
+    confirmLabel: string;
+    cancelLabel: string;
+    danger?: boolean;
+}
+/** The parts a form may be drawn with. See `AuthFormProps.components`. */
+interface AuthComponents {
+    Button?: ComponentType<AuthButtonProps>;
+    Input?: ComponentType<AuthInputProps>;
+    Checkbox?: ComponentType<AuthCheckboxProps>;
+    Select?: ComponentType<AuthSelectProps>;
+    Field?: ComponentType<AuthFieldProps>;
+    Text?: ComponentType<AuthTextProps>;
+    Badge?: ComponentType<AuthBadgeProps>;
+    Link?: ComponentType<AuthLinkProps>;
+    Divider?: ComponentType<AuthDividerProps>;
+    Alert?: ComponentType<AuthAlertProps>;
+    /**
+     * Asks before something that cannot be undone, and answers whether to go
+     * on: the application's own dialog. Not given: the question shows inline,
+     * with a yes and a cancel button. Never the browser's own dialog.
+     */
+    Confirm?: (options: AuthConfirmOptions) => Promise<boolean>;
 }
 declare function SignIn(props: AuthFormProps): react.JSX.Element;
 interface GoogleOneTapProps {
@@ -1316,11 +1473,91 @@ declare function ForgotPassword(props: AuthFormProps): react.JSX.Element;
 declare function ResetPassword(props: AuthFormProps): react.JSX.Element;
 /** The page a "confirm your address" link opens: `pages.verifyEmail`. It confirms as it opens. */
 declare function VerifyEmail(props: AuthFormProps): react.JSX.Element;
+/**
+ * The page an invitation opens: `pages.acceptInvite`. It says who is invited
+ * to what, asks for a password under the workspace's policy, signs the person
+ * in (with the second step, when their account owes one) and goes on to
+ * `returnTo`. The invitation is good until it is accepted: reading it, or a
+ * password refused, does not spend it.
+ */
+/** What `<AcceptInvite />` tells the application once the invitation is accepted. */
+type AcceptInviteEvent = {
+    kind: 'invitation.accepted';
+    email: string;
+    organization?: string;
+};
+interface AcceptInviteProps extends AuthFormProps {
+    /** Called once the invitation is accepted, before the second step when the account owes one. */
+    onSaved?: (event: AcceptInviteEvent) => void;
+}
+declare function AcceptInvite(props: AcceptInviteProps): react.JSX.Element;
+interface PendingTermsProps extends Omit<AuthFormProps, 'links' | 'returnTo' | 'createAccounts'> {
+    /** Called once the person accepted. Nothing else happens: the application decides what follows. */
+    onSuccess?: () => void;
+}
+/**
+ * The legal documents the signed-in person still owes (a new version of the
+ * terms, say), linked, with the action that accepts them. It shows nothing
+ * while it reads them, when nothing is owed, and once they are accepted.
+ * Nothing stops the person meanwhile: the application decides what waits.
+ */
+declare function PendingTerms(props: PendingTermsProps): react.JSX.Element | null;
+/** The parts of `<Account />`, by name: what `sections` lists. */
+type AccountSection = 'profile' | 'email' | 'password' | 'linked' | 'secondStep' | 'phone' | 'passkeys' | 'agents' | 'sessions';
+/**
+ * What `<Account />` tells the application after each change it saved, for
+ * the application's own toast or its own data to follow.
+ */
+type AccountEvent = {
+    kind: 'profile.saved';
+    name: string;
+} | {
+    kind: 'email.change_requested';
+    email: string;
+} | {
+    kind: 'password.changed';
+} | {
+    kind: 'identity.linked';
+    provider: string;
+} | {
+    kind: 'identity.unlinked';
+    provider: string;
+} | {
+    kind: 'mfa.enabled';
+} | {
+    kind: 'mfa.disabled';
+} | {
+    kind: 'recovery_codes.regenerated';
+} | {
+    kind: 'phone.added';
+    channel: 'sms' | 'whatsapp';
+} | {
+    kind: 'phone.removed';
+} | {
+    kind: 'passkey.added';
+    id: string;
+} | {
+    kind: 'passkey.removed';
+    id: string;
+} | {
+    kind: 'agent.disconnected';
+    id: string;
+} | {
+    kind: 'sessions.ended';
+};
 interface AccountProps extends Omit<AuthFormProps, 'links' | 'returnTo' | 'onSuccess'> {
     /** Called after "sign out everywhere". Default: go to `/`. */
     onSignedOut?: () => void;
     /** The moment of a session, as the application writes dates. Default: the browser's own way, in the reader's time zone. */
     formatDate?: (iso: string) => string;
+    /**
+     * The parts shown, in this order. Default: all of them, as listed in
+     * `AccountSection`. A part with nothing to show (the password of an account
+     * without one, agents when none is connected) stays out either way.
+     */
+    sections?: AccountSection[];
+    /** Called after every change saved, with what changed. */
+    onSaved?: (event: AccountEvent) => void;
 }
 /**
  * The signed-in person's account, in the application: their name, their
@@ -1328,11 +1565,82 @@ interface AccountProps extends Omit<AuthFormProps, 'links' | 'returnTo' | 'onSuc
  * its own. Like the other forms, it carries no styles.
  */
 declare function Account(props: AccountProps): react.JSX.Element;
+/** What each part of the account screen takes, shown on its own: `<Account />`'s props but `sections`. */
+type AccountPartProps = Omit<AccountProps, 'sections'>;
+/** The person's name. */
+declare function AccountProfile(props: AccountPartProps): react.JSX.Element;
+/** Changing the address: a link goes to the new one. */
+declare function AccountEmail(props: AccountPartProps): react.JSX.Element;
+/** Changing the password, for an account that has one. */
+declare function AccountPassword(props: AccountPartProps): react.JSX.Element;
+/** The providers the account signs in with. */
+declare function AccountLinked(props: AccountPartProps): react.JSX.Element;
+/** The second step with an authenticator app, and the recovery codes. */
+declare function AccountSecondStep(props: AccountPartProps): react.JSX.Element;
+/** The phone codes go to, where the workspace sends them. */
+declare function AccountPhone(props: AccountPartProps): react.JSX.Element;
+/** The account's passkeys. */
+declare function AccountPasskeys(props: AccountPartProps): react.JSX.Element;
+/** The AI agents the person connected, when there is one. */
+declare function AccountAgents(props: AccountPartProps): react.JSX.Element;
+/** Where the person is signed in, and "sign out everywhere". */
+declare function AccountSessions(props: AccountPartProps): react.JSX.Element;
+/** An action `<OrganizationMembers hide={...} />` never offers. */
+type OrganizationMembersAction = 'archive' | 'delete' | 'rename' | 'leave';
+/**
+ * What `<OrganizationMembers />` tells the application after each change it
+ * saved, for the application's own toast or its own data to follow.
+ */
+type OrganizationMembersEvent = {
+    kind: 'member.added';
+    organizationId: string;
+    userId: string;
+    email: string;
+    role: string;
+} | {
+    kind: 'member.role_changed';
+    organizationId: string;
+    userId: string;
+    role: string;
+    previousRole: string;
+} | {
+    kind: 'member.removed';
+    organizationId: string;
+    userId: string;
+} | {
+    kind: 'member.left';
+    organizationId: string;
+    userId: string;
+} | {
+    kind: 'member.invited_again';
+    organizationId: string;
+    userId: string;
+} | {
+    kind: 'organization.renamed';
+    organizationId: string;
+    name: string;
+} | {
+    kind: 'organization.archived';
+    organizationId: string;
+} | {
+    kind: 'organization.deleted';
+    organizationId: string;
+};
 interface OrganizationMembersProps extends Omit<AuthFormProps, 'links' | 'returnTo' | 'onSuccess' | 'createAccounts'> {
     /** The organization, by the id Cauthy gave it. */
     organizationId: string;
     /** The moment of a membership, as the application writes dates. Default: the browser's own way. */
     formatDate?: (iso: string) => string;
+    /**
+     * The roles offered when adding a member or changing one's role: those for
+     * which it answers true. A member already holding another role keeps it,
+     * and it shows. Default: every role the person may give.
+     */
+    roles?: (role: string, choice: OrganizationRoleChoice) => boolean;
+    /** Actions never offered, whatever the person's role allows. */
+    hide?: OrganizationMembersAction[];
+    /** Called after every change saved, with what changed. */
+    onSaved?: (event: OrganizationMembersEvent) => void;
 }
 /**
  * The people of one of the signed-in person's organizations, administered
@@ -1390,4 +1698,4 @@ declare function useSession(): SessionContext;
  */
 declare function useAuth(): AuthClient & Pick<SessionContext, 'session' | 'status' | 'refresh'>;
 
-export { Account, type AccountClient, type Account$1 as AccountDetails, type AccountProps, type AccountSession, type AuthClient, type AuthError, type AuthFormProps, type AuthMethods, type AuthResult, type AuthTexts, CauthyProvider, type CauthyProviderProps, type ConnectedAgent, ForgotPassword, GoogleOneTap, type GoogleOneTapProps, type JsonValue, type LinkedIdentity, OrganizationMembers, type OrganizationMembersProps, type OrganizationPerson, type OrganizationRoleChoice, type OrganizationSeat, type OrganizationsClient, type Passkey, type PasskeyKind, type PermissionOf, type Policy, type PublicSession, ResetPassword, type RoleOf, type SSOConnection, type SecondStep, type SessionContext, type SessionOrganization, type SessionUser, SignIn, SignUp, VerifyEmail, can, canAutofillPasskeys, canUsePasskeys, createAuthClient, definePolicy, useAuth, useSession };
+export { AcceptInvite, type AcceptInviteEvent, type AcceptInviteProps, Account, AccountAgents, type AccountClient, type Account$1 as AccountDetails, AccountEmail, type AccountEvent, AccountLinked, type AccountPartProps, AccountPasskeys, AccountPassword, AccountPhone, AccountProfile, type AccountProps, AccountSecondStep, type AccountSection, type AccountSession, AccountSessions, type AuthAlertProps, type AuthBadgeProps, type AuthButtonProps, type AuthCheckboxProps, type AuthClient, type AuthComponents, type AuthConfirmOptions, type AuthDividerProps, type AuthError, type AuthFieldProps, type AuthFormProps, type AuthInputProps, type AuthLinkProps, type AuthMethods, type AuthResult, type AuthSelectProps, type AuthTextProps, type AuthTexts, CauthyProvider, type CauthyProviderProps, type ConnectedAgent, ForgotPassword, GoogleOneTap, type GoogleOneTapProps, type Invitation, type JsonValue, type LinkedIdentity, OrganizationMembers, type OrganizationMembersAction, type OrganizationMembersEvent, type OrganizationMembersProps, type OrganizationPerson, type OrganizationRoleChoice, type OrganizationSeat, type OrganizationsClient, type Passkey, type PasskeyKind, type PendingLegal, PendingTerms, type PendingTermsProps, type PermissionOf, type Policy, type PublicSession, ResetPassword, type RoleOf, type SSOConnection, type SecondStep, type SessionContext, type SessionOrganization, type SessionUser, SignIn, SignUp, VerifyEmail, can, canAutofillPasskeys, canUsePasskeys, createAuthClient, definePolicy, useAuth, useSession };