cauthy-auth 0.32.0 → 0.33.0

package/README.md

@@ -90,6 +90,7 @@ import { OrganizationMembers } from 'cauthy-auth/react'
   organizationId={org.id}
   roles={(role) => role !== 'billing'}             // the roles offered when adding or changing one
   hide={['archive', 'delete']}                    // never offered: 'archive', 'delete', 'rename', 'leave'
+  roleLabel={(c) => t(`roles.${c.role}`)}          // a role's name wherever one shows. Default: the catalog's
   onSaved={(e) => toast(e.kind)}                  // member.added, member.role_changed, member.removed, member.left,
 />                                                // member.invited_again, organization.renamed, .archived, .deleted
 
@@ -173,15 +174,25 @@ The ready-made forms wear the look set for your application in Cauthy's dashboar
 import 'cauthy-auth/styles.css'
 ```
 
-Or draw them with your own `components` and `classNames`, and pass `unstyled`. Every part the forms draw can be yours; a part not given is drawn as before. With every part given and `unstyled`, the forms add only structural wrappers (`div`, `form`, `section`, lists):
+Or draw them with your own `components` and `classNames`, and pass `unstyled`. Every part the forms draw can be yours; a part not given is drawn as before. With every part given and `unstyled`, the forms add no element of their own but lists:
 
 ```tsx
-<SignIn unstyled components={{ Button, Input, Checkbox, Select, Field, Text, Badge, Link, Divider, Alert, Confirm }} />
+<SignIn unstyled components={{ Form, Button, Input, Checkbox, Select, Field, Text, Badge, Link, Divider, Alert, Confirm }} />
 ```
 
+`Form` is every element the forms put around their parts: each form and each of its steps, and each part of `<Account />` and `<OrganizationMembers />`. Give it your design system's stack and the gaps between fields and buttons are yours, with no CSS on the page:
+
+```tsx
+const Form: AuthComponents['Form'] = ({ as, children, ...rest }) =>
+  as === 'form' ? <Stack as="form" gap={3} {...rest}>{children}</Stack> : <Stack gap={3} {...rest}>{children}</Stack>
+```
+
+`Button` is told what kind of button it is: `primary` sends the form; `secondary` is any other way (a provider, a passkey, a sign-in link, SSO, cancel, send again); `danger` removes, leaves, deletes, disconnects, signs out everywhere or turns the second step off. `loading` is true on the one button whose action is under way; every button is `disabled` meanwhile.
+
 | Part | Is given |
 | --- | --- |
-| `Button` | `type`, `disabled`, `className`, `onClick`, `children` |
+| `Form` | `as` (`form` or `div`), `onSubmit`, `noValidate`, `aria-busy`, `className`, `section`, `children`. Render a `<form>` for `as="form"`, for Enter to send it. `section` names each part of `<Account />` (`profile`, `passkeys`… as in `AccountSection`) and of `<OrganizationMembers />` (`members`, `add-member`, `organization`, `rename`), to draw each as a card |
+| `Button` | `type`, `variant` (`primary`, `secondary`, `danger`), `loading`, `disabled`, `className`, `onClick`, `children` |
 | `Input` | `id`, `name`, `type`, `value`, `autoComplete`, `required`, `className`, `aria-invalid`, `aria-describedby`, `onChange(e)` |
 | `Checkbox` | `id`, `name`, `checked`, `required`, `disabled`, `className`, `onChange(checked)`, `children` (its label) |
 | `Select` | `id`, `name`, `value`, `options: { value, label }[]`, `disabled`, `className`, `aria-label`, `onChange(value)` |
@@ -193,6 +204,14 @@ Or draw them with your own `components` and `classNames`, and pass `unstyled`. E
 | `Alert` | `tone` (`danger`, `info`, `success`), `children`. Announce it: `role="alert"` or `role="status"` |
 | `Confirm` | A function, `({ title, body, confirmLabel, cancelLabel, danger }) => Promise<boolean>`: your own dialog before removing a member, leaving, archiving or deleting. Without it, the question shows inline |
 
+A form checks every field before it sends anything: each one wrong shows its error at once, in the order they are drawn, and the first takes the focus. `<SignUp />` draws its fields once the workspace has said what it asks (a company's name, the legal boxes), so nothing moves as they come.
+
+What Cauthy mails from these forms (a sign-in link, a new password, a confirmation) goes in the page's language (`<html lang>`). Give `<CauthyProvider locale>` your application's own instead, or a function for a person who can change it:
+
+```tsx
+<CauthyProvider locale={() => i18n.language}>
+```
+
 `texts` changes any sentence. Its keys are stable: `email`, `password`, `name`, `code`, `signIn`, `signUp`, `continueWith`, `orWithEmail`, `forgotPassword`, `noAccount`, `createAccount`, `company`, `iAccept`, `and`, `termsOfService`, `privacyPolicy`, `haveAccount`, `sendLink`, `linkSent`, `codeHelp`, `codeHelpPhone`, `codeHelpEmail`, `sendEmailAgain`, `sendCodeSms`, `sendCodeWhatsapp`, `codeSent`, `pushSend`, `pushPick`, `pushWaiting`, `phone`, `phoneHelp`, `phoneOn`, `phoneOff`, `addPhone`, `removePhone`, `bySms`, `byWhatsapp`, `channel`, `verify`, `checkEmail`, `backToSignIn`, `emailMeALink`, `usePasskey`, `codeFromMail`, `signInLinkSent`, `newPassword`, `savePassword`, `passwordChanged`, `confirming`, `emailConfirmed`, `invitedTo`, `invitedToOrganization`, `invitedAs`, `choosePassword`, `acceptInvite`, `openingInvitation`, `invitationInvalid`, `profile`, `save`, `saved`, `currentPassword`, `changePassword`, `passwordChangedHere`, `secondStep`, `secondStepOn`, `secondStepOff`, `turnOn`, `turnOff`, `addToApp`, `openInApp`, `recoveryCodes`, `newRecoveryCodes`, `keepCodes`, `passkeys`, `managePasskeys`, `passkeysHelp`, `noPasskeys`, `passkeyName`, `addPasskey` (unused), `addPasskeyDevice`, `addSecurityKey`, `passkeyKinds`, `removePasskey`, `passkeyAdded`, `passkeyUnnamed`, `sessions`, `signOutEverywhere`, `agents`, `agentsHelp`, `disconnect`, `anAgent`, `unknownDevice`, `emailAddress`, `newEmail`, `changeEmail`, `emailSent`, `linkedAccounts`, `noLinkedAccounts`, `linkWith`, `unlink`, `linked`, `ssoOnly`, `members`, `membersHidden`, `organizationMissing`, `memberYou`, `memberInvited`, `memberManager`, `memberRole`, `memberAdd`, `memberAdded`, `memberRemove`, `memberRemoveConfirm`, `memberLeave`, `memberLeaveConfirm`, `memberInviteAgain`, `memberInvitationSent`, `organization`, `organizationRename`, `organizationRenamed`, `organizationArchive`, `organizationArchiveConfirm`, `organizationArchived`, `organizationDelete`, `organizationDeleteConfirm`, `organizationDeleted`, `yes`, `cancel`, `termsChanged`, `termsChangedHelp`, `acceptTerms`, and `errors` by error code. Built in: English and Spanish (`locale`). The dashboard can start the look from your stylesheet (shadcn/ui and Tailwind, Stackmyth, or variables of your own); `npx cauthy-auth theme --css src/app/globals.css` reads it the same way from a terminal.
 
 Connect your application to Cauthy in one step, from Cauthy's dashboard ("Connect a System") or from a terminal. In the application's folder, `init` reads its framework (Next.js, TanStack Start, React Router or Remix, SvelteKit, Vite + React, Express, Hono, Fastify), makes the client, writes every variable to its env file, `CAUTHY_SECRET` included, and lays down the route and a sign-in page, never over a file that is there:

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. */
@@ -1318,20 +1318,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 +1465,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 +1676,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 +1723,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 +1745,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. */
@@ -1318,20 +1318,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 +1465,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 +1676,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 +1723,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 +1745,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 };