cauthy-auth 0.32.0 → 0.34.0

package/dist/next.d.mts

@@ -1,5 +1,5 @@
-import { C as Cauthy } from './cauthy-2jtP2LVQ.mjs';
-import { S as Session } from './system-BrrJsrFW.mjs';
+import { C as Cauthy } from './cauthy-C-GoRXy9.mjs';
+import { S as Session } from './system-DUGV040y.mjs';
 import 'jose';
 import './theme.mjs';
 

package/dist/next.d.ts

@@ -1,5 +1,5 @@
-import { C as Cauthy } from './cauthy-CKfvvv_i.js';
-import { S as Session } from './system-BvvoNs2y.js';
+import { C as Cauthy } from './cauthy-BUozWD72.js';
+import { S as Session } from './system-Bz4haPrI.js';
 import 'jose';
 import './theme.js';
 

package/dist/react.d.mts

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import { ComponentType, ReactNode } from 'react';
+import { ComponentType, FormEvent, ReactNode } from 'react';
 
 /** How an application looks on Cauthy's hosted pages. Every value is optional. */
 /** One font file the application serves: a family in one weight (or a range) and one style. */
@@ -620,7 +620,11 @@ interface OrganizationsClient {
     members(organizationId: string): Promise<OrganizationPerson[] | null>;
     /** The roles a member may be given, or null when the person may not see them. */
     roles(organizationId: string): Promise<OrganizationRoleChoice[] | null>;
-    /** Adds a person by their address; an address with no account gets one and its invitation. */
+    /**
+     * Adds a person by their address; an address with no account gets one and
+     * its invitation. It only adds: a person who already belongs keeps their
+     * role and the result is the error `member_exists` (change it with `setRole`).
+     */
     add(organizationId: string, form: {
         email: string;
         role: string;
@@ -1318,20 +1322,51 @@ interface AuthFormProps {
      */
     workspaceLook?: boolean;
     /**
-     * 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
+     * The application's own parts, to draw the form with: its form layout,
+     * 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?: AuthComponents;
 }
-/** What the application's button is given: what a `<button>` would be. */
+/**
+ * What the application's button is given: what a `<button>` would be, and
+ * what kind of button it is. `primary` sends the form; `secondary` is any
+ * other action (a provider, a passkey, a sign-in link, cancel, send again);
+ * `danger` removes, leaves, deletes, disconnects or turns something off.
+ * `loading` is true on the one button whose action is under way; every
+ * button is `disabled` meanwhile, as before.
+ */
 interface AuthButtonProps {
     type: 'submit' | 'button';
     disabled?: boolean;
     className?: string;
     onClick?: () => void;
     children: ReactNode;
+    variant?: 'primary' | 'secondary' | 'danger';
+    loading?: boolean;
+}
+/**
+ * What the application's form layout is given: every element the forms put
+ * around their parts — a whole form, each step of it, each part of the
+ * account and members screens — so its own stack lays them out. `as` says
+ * which element it stands for: a `form` sends with `onSubmit` (render a
+ * `<form>` with it for Enter to submit), a `div` only groups.
+ */
+interface AuthFormLayoutProps {
+    as: 'form' | 'div';
+    onSubmit?: (e: FormEvent) => void;
+    noValidate?: boolean;
+    'aria-busy'?: boolean;
+    className?: string;
+    /**
+     * Which part of `<Account />` or `<OrganizationMembers />` this is, for an
+     * application that draws each as a card: an `AccountSection`
+     * (`profile`, `passkeys`…), or `members`, `add-member`, `organization`
+     * and `rename` (the form inside `organization`). Not set on a whole form.
+     */
+    section?: string;
+    children: ReactNode;
 }
 /** What the application's input is given: what an `<input>` would be. */
 interface AuthInputProps {
@@ -1434,6 +1469,12 @@ interface AuthConfirmOptions {
 }
 /** The parts a form may be drawn with. See `AuthFormProps.components`. */
 interface AuthComponents {
+    /**
+     * Every element around the form's parts: the form itself, each step, each
+     * part of the account and members screens. Not given: the `form`, `div` or
+     * `section` the forms have always drawn.
+     */
+    Form?: ComponentType<AuthFormLayoutProps>;
     Button?: ComponentType<AuthButtonProps>;
     Input?: ComponentType<AuthInputProps>;
     Checkbox?: ComponentType<AuthCheckboxProps>;
@@ -1639,6 +1680,8 @@ interface OrganizationMembersProps extends Omit<AuthFormProps, 'links' | 'return
     roles?: (role: string, choice: OrganizationRoleChoice) => boolean;
     /** Actions never offered, whatever the person's role allows. */
     hide?: OrganizationMembersAction[];
+    /** A role's name wherever one shows: a member's, the role choices, adding one. Default: the name the catalog gives it. */
+    roleLabel?: (choice: OrganizationRoleChoice) => string;
     /** Called after every change saved, with what changed. */
     onSaved?: (event: OrganizationMembersEvent) => void;
 }
@@ -1684,8 +1727,16 @@ interface CauthyProviderProps {
      * out when the server did not look.
      */
     initialSession?: PublicSession | null;
+    /**
+     * The language the person reads, for what Cauthy mails them from
+     * `useAuth()` and the ready-made forms (a sign-in link, a new password, a
+     * confirmation): a tag like `es` or `es-CO`, or a function that answers it
+     * when the person can change it. Default: the page's own (`<html lang>`),
+     * else the browser's.
+     */
+    locale?: string | (() => string | undefined);
 }
-declare function CauthyProvider({ children, basePath, initialSession }: CauthyProviderProps): react.JSX.Element;
+declare function CauthyProvider({ children, basePath, initialSession, locale }: CauthyProviderProps): react.JSX.Element;
 declare function useSession(): SessionContext;
 /**
  * The application's own sign-in screens: the functions a form calls.
@@ -1698,4 +1749,4 @@ declare function useSession(): SessionContext;
  */
 declare function useAuth(): AuthClient & Pick<SessionContext, 'session' | 'status' | 'refresh'>;
 
-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 };
+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 AuthFormLayoutProps, 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 };

package/dist/react.d.ts

@@ -1,5 +1,5 @@
 import * as react from 'react';
-import { ComponentType, ReactNode } from 'react';
+import { ComponentType, FormEvent, ReactNode } from 'react';
 
 /** How an application looks on Cauthy's hosted pages. Every value is optional. */
 /** One font file the application serves: a family in one weight (or a range) and one style. */
@@ -620,7 +620,11 @@ interface OrganizationsClient {
     members(organizationId: string): Promise<OrganizationPerson[] | null>;
     /** The roles a member may be given, or null when the person may not see them. */
     roles(organizationId: string): Promise<OrganizationRoleChoice[] | null>;
-    /** Adds a person by their address; an address with no account gets one and its invitation. */
+    /**
+     * Adds a person by their address; an address with no account gets one and
+     * its invitation. It only adds: a person who already belongs keeps their
+     * role and the result is the error `member_exists` (change it with `setRole`).
+     */
     add(organizationId: string, form: {
         email: string;
         role: string;
@@ -1318,20 +1322,51 @@ interface AuthFormProps {
      */
     workspaceLook?: boolean;
     /**
-     * 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
+     * The application's own parts, to draw the form with: its form layout,
+     * 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?: AuthComponents;
 }
-/** What the application's button is given: what a `<button>` would be. */
+/**
+ * What the application's button is given: what a `<button>` would be, and
+ * what kind of button it is. `primary` sends the form; `secondary` is any
+ * other action (a provider, a passkey, a sign-in link, cancel, send again);
+ * `danger` removes, leaves, deletes, disconnects or turns something off.
+ * `loading` is true on the one button whose action is under way; every
+ * button is `disabled` meanwhile, as before.
+ */
 interface AuthButtonProps {
     type: 'submit' | 'button';
     disabled?: boolean;
     className?: string;
     onClick?: () => void;
     children: ReactNode;
+    variant?: 'primary' | 'secondary' | 'danger';
+    loading?: boolean;
+}
+/**
+ * What the application's form layout is given: every element the forms put
+ * around their parts — a whole form, each step of it, each part of the
+ * account and members screens — so its own stack lays them out. `as` says
+ * which element it stands for: a `form` sends with `onSubmit` (render a
+ * `<form>` with it for Enter to submit), a `div` only groups.
+ */
+interface AuthFormLayoutProps {
+    as: 'form' | 'div';
+    onSubmit?: (e: FormEvent) => void;
+    noValidate?: boolean;
+    'aria-busy'?: boolean;
+    className?: string;
+    /**
+     * Which part of `<Account />` or `<OrganizationMembers />` this is, for an
+     * application that draws each as a card: an `AccountSection`
+     * (`profile`, `passkeys`…), or `members`, `add-member`, `organization`
+     * and `rename` (the form inside `organization`). Not set on a whole form.
+     */
+    section?: string;
+    children: ReactNode;
 }
 /** What the application's input is given: what an `<input>` would be. */
 interface AuthInputProps {
@@ -1434,6 +1469,12 @@ interface AuthConfirmOptions {
 }
 /** The parts a form may be drawn with. See `AuthFormProps.components`. */
 interface AuthComponents {
+    /**
+     * Every element around the form's parts: the form itself, each step, each
+     * part of the account and members screens. Not given: the `form`, `div` or
+     * `section` the forms have always drawn.
+     */
+    Form?: ComponentType<AuthFormLayoutProps>;
     Button?: ComponentType<AuthButtonProps>;
     Input?: ComponentType<AuthInputProps>;
     Checkbox?: ComponentType<AuthCheckboxProps>;
@@ -1639,6 +1680,8 @@ interface OrganizationMembersProps extends Omit<AuthFormProps, 'links' | 'return
     roles?: (role: string, choice: OrganizationRoleChoice) => boolean;
     /** Actions never offered, whatever the person's role allows. */
     hide?: OrganizationMembersAction[];
+    /** A role's name wherever one shows: a member's, the role choices, adding one. Default: the name the catalog gives it. */
+    roleLabel?: (choice: OrganizationRoleChoice) => string;
     /** Called after every change saved, with what changed. */
     onSaved?: (event: OrganizationMembersEvent) => void;
 }
@@ -1684,8 +1727,16 @@ interface CauthyProviderProps {
      * out when the server did not look.
      */
     initialSession?: PublicSession | null;
+    /**
+     * The language the person reads, for what Cauthy mails them from
+     * `useAuth()` and the ready-made forms (a sign-in link, a new password, a
+     * confirmation): a tag like `es` or `es-CO`, or a function that answers it
+     * when the person can change it. Default: the page's own (`<html lang>`),
+     * else the browser's.
+     */
+    locale?: string | (() => string | undefined);
 }
-declare function CauthyProvider({ children, basePath, initialSession }: CauthyProviderProps): react.JSX.Element;
+declare function CauthyProvider({ children, basePath, initialSession, locale }: CauthyProviderProps): react.JSX.Element;
 declare function useSession(): SessionContext;
 /**
  * The application's own sign-in screens: the functions a form calls.
@@ -1698,4 +1749,4 @@ declare function useSession(): SessionContext;
  */
 declare function useAuth(): AuthClient & Pick<SessionContext, 'session' | 'status' | 'refresh'>;
 
-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 };
+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 AuthFormLayoutProps, 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 };