cauthy-auth 0.19.0 → 0.22.0

package/dist/next.d.mts

@@ -1,5 +1,5 @@
-import { C as Cauthy } from './cauthy-C29HCvag.mjs';
-import { S as Session } from './system-ZD_Wa8Bm.mjs';
+import { C as Cauthy } from './cauthy-XkIbG5gE.mjs';
+import { S as Session } from './system-BxMsSIu1.mjs';
 import 'jose';
 import './theme.mjs';
 

package/dist/next.d.ts

@@ -1,5 +1,5 @@
-import { C as Cauthy } from './cauthy-Bn3iv50y.js';
-import { S as Session } from './system-DhRr_WxR.js';
+import { C as Cauthy } from './cauthy-DGAy45G2.js';
+import { S as Session } from './system-DTIeDXDP.js';
 import 'jose';
 import './theme.js';
 

package/dist/react.d.mts

@@ -174,6 +174,8 @@ interface SessionUser {
     emailVerifyBy?: string;
     /** The language the person reads in ("es", "en-US"), when Cauthy knows it. */
     locale?: string;
+    /** A guest: a visitor's session before they sign up. No email; `account.upgrade` makes it an account, keeping `id`. */
+    isAnonymous?: boolean;
 }
 /** A value JSON can carry. What crosses from server to browser is typed as this, never `unknown`. */
 type JsonValue = string | number | boolean | null | JsonValue[] | {
@@ -265,6 +267,20 @@ interface AuthMethods {
      * forms show it themselves.
      */
     captchaSiteKey?: string;
+    /**
+     * Whether the workspace signs some people in through their company's SSO,
+     * found by their work address (`signIn.ssoDiscover`, `signIn.sso`).
+     */
+    sso: boolean;
+}
+/** A company's sign-in (an SSO connection of the workspace). */
+interface SSOConnection {
+    /** What `signIn.sso({ connection })` takes. */
+    id: string;
+    /** The company's name, for "Continue with …". */
+    name: string;
+    /** The address can sign in no other way: a password, link or provider answers `sso_required`. */
+    enforced: boolean;
 }
 /**
  * What holds a passkey, as its authenticator says: a security key (a YubiKey),
@@ -314,6 +330,82 @@ interface ConnectedAgent {
     connectedAt: string;
     lastUsedAt: string;
 }
+/** An organization the person belongs to, with what their role lets them do with its people. */
+interface OrganizationSeat {
+    id: string;
+    /** The client system it is of (`pondari`). */
+    system: string;
+    name: string;
+    kind: string;
+    /** The person's role in it. */
+    role: string;
+    /** Cauthy's member powers, from the system's catalog: cauthy:members read and manage. */
+    can: {
+        readMembers: boolean;
+        manageMembers: boolean;
+    };
+}
+/** A person of an organization, as a member who may see them reads it. */
+interface OrganizationPerson {
+    userId: string;
+    email: string;
+    name: string;
+    role: string;
+    /** The account's: `active`, `suspended`… A disabled member is still listed. */
+    status: string;
+    /** Invited and not yet accepted. */
+    invited: boolean;
+    /** Manages the organization's members. */
+    manager: boolean;
+    /** The signed-in person. */
+    you: boolean;
+    /** UTC, ISO 8601. */
+    since: string;
+}
+/** A role of the organization's system, as the catalog names it. */
+interface OrganizationRoleChoice {
+    role: string;
+    name: string;
+    description: string;
+    /** Holding it manages the organization's members. */
+    manager: boolean;
+}
+/**
+ * The signed-in person's organizations, and their people. Seeing them needs
+ * cauthy:members read in the person's role; changing them needs manage. Cauthy
+ * decides, with the person's own session: the application authorizes nothing.
+ */
+interface OrganizationsClient {
+    /** The organizations the person belongs to; one system's only with `system`. */
+    list(system?: string): Promise<OrganizationSeat[]>;
+    /** The people of one, or null when the person may not see them. */
+    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. */
+    add(organizationId: string, form: {
+        email: string;
+        role: string;
+        name?: string;
+        locale?: string;
+    }): Promise<AuthResult<'added', {
+        member: OrganizationPerson;
+    }>>;
+    setRole(organizationId: string, userId: string, role: string): Promise<AuthResult<'changed', {
+        userId: string;
+        role: string;
+    }>>;
+    /** Removes a member; the person themself may always leave. */
+    remove(organizationId: string, userId: string): Promise<AuthResult<'removed', {
+        userId: string;
+    }>>;
+    /** Sends a member's invitation again. */
+    inviteAgain(organizationId: string, userId: string, form?: {
+        locale?: string;
+    }): Promise<AuthResult<'sent', {
+        userId: string;
+    }>>;
+}
 interface AccountSession {
     /** "Mac · Chrome", or "" when the browser did not say. */
     device: string;
@@ -436,6 +528,26 @@ interface AccountClient {
     unlink(provider: string): Promise<AuthResult<'unlinked', {
         provider: string;
     }>>;
+    /**
+     * A guest becomes an account of their own with an address and a password —
+     * the same id, so what they did stays theirs. `email_taken`: the address has
+     * an account already; offer to sign in with it.
+     */
+    upgrade(form: {
+        email: string;
+        password: string;
+        name?: string;
+    }): Promise<AuthResult<'signed_in', {
+        session: PublicSession;
+    }>>;
+    /** Where a guest goes to become the account of a provider's address (Google…). */
+    upgradeUrl(provider: string, options?: {
+        returnTo?: string;
+    }): string;
+    /** Sends a guest to `upgradeUrl`; they come back signed in as the account. */
+    upgradeWith(provider: string, options?: {
+        returnTo?: string;
+    }): void;
     /** Where the account is signed in. */
     sessions(): Promise<AccountSession[]>;
     /** Signs the account out everywhere, here too. */
@@ -469,6 +581,17 @@ interface AccountClient {
 }
 interface AuthClient {
     signIn: {
+        /**
+         * A guest session, before the visitor signs up: the application keeps what
+         * they do under `session.user.id`, and `account.upgrade` (or
+         * `account.upgradeWith`) makes it their account, same id. Only where the
+         * workspace allows guests (`anonymous_disabled` otherwise).
+         */
+        anonymously(form?: {
+            captchaToken?: string;
+        }): Promise<AuthResult<'signed_in', {
+            session: PublicSession;
+        }>>;
         /** With address and password. `mfa_required`: ask for the code and call `signIn.mfa`. */
         email(form: {
             email: string;
@@ -577,6 +700,38 @@ interface AuthClient {
         social(provider: string, options?: {
             returnTo?: string;
         }): void;
+        /**
+         * Which company's sign-in a work address uses, if any (`found`), or
+         * `none`. It says so of the address's domain, never whether the address
+         * has an account.
+         */
+        ssoDiscover(form: {
+            email: string;
+        }): Promise<AuthResult<'found', {
+            connection: SSOConnection;
+        }> | AuthResult<'none'>>;
+        /**
+         * Sends the browser to the person's company (found by `email`, or named
+         * by `connection`); it comes back signed in, at `returnTo`. A sign-in the
+         * company refused comes back with `?auth_error=`. Any other way of
+         * signing in answers `sso_required` for an address its company holds to
+         * SSO: send it here then.
+         */
+        sso(target: {
+            email: string;
+        } | {
+            connection: string;
+        }, options?: {
+            returnTo?: string;
+        }): void;
+        /** Where `sso` sends the browser, for a plain link. */
+        ssoUrl(target: {
+            email: string;
+        } | {
+            connection: string;
+        }, options?: {
+            returnTo?: string;
+        }): string;
         /** Where `social` sends the browser, for a plain link. */
         socialUrl(provider: string, options?: {
             returnTo?: string;
@@ -612,6 +767,8 @@ interface AuthClient {
     signOut(): Promise<AuthResult<'signed_out'>>;
     /** The signed-in person's own account. */
     account: AccountClient;
+    /** The signed-in person's organizations, and their people. */
+    organizations: OrganizationsClient;
     /** Who is signed in, or null. */
     getSession(): Promise<PublicSession | null>;
     methods(): Promise<AuthMethods>;
@@ -723,6 +880,24 @@ interface AuthTexts {
     linkWith: string;
     unlink: string;
     linked: string;
+    ssoOnly: string;
+    members: string;
+    membersHidden: string;
+    organizationMissing: string;
+    memberYou: string;
+    memberInvited: string;
+    memberManager: string;
+    memberRole: string;
+    memberAdd: string;
+    memberAdded: string;
+    memberRemove: string;
+    memberRemoveConfirm: string;
+    memberLeave: string;
+    memberLeaveConfirm: string;
+    memberInviteAgain: string;
+    memberInvitationSent: string;
+    yes: string;
+    cancel: string;
     /** By error code; one missing shows what the server said. */
     errors: Record<string, string>;
 }
@@ -828,6 +1003,22 @@ 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;
+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 people of one of the signed-in person's organizations, administered
+ * from the application. What it offers follows the person's role in the
+ * system's catalog: cauthy:members read lists the people; manage adds them by
+ * address (one with no account is invited), changes their role, sends an
+ * invitation again and removes them. Anybody may leave. Cauthy checks each
+ * change with the person's own session; the application authorizes nothing.
+ * Like the other forms, it carries no styles.
+ */
+declare function OrganizationMembers(props: OrganizationMembersProps): react.JSX.Element;
 
 interface SessionContext {
     /** The signed-in person and their organizations, or null. */
@@ -872,4 +1063,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, type Passkey, type PasskeyKind, type PermissionOf, type Policy, type PublicSession, ResetPassword, type RoleOf, type SecondStep, type SessionContext, type SessionOrganization, type SessionUser, SignIn, SignUp, VerifyEmail, can, canAutofillPasskeys, canUsePasskeys, createAuthClient, definePolicy, useAuth, useSession };
+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 };

package/dist/react.d.ts

@@ -174,6 +174,8 @@ interface SessionUser {
     emailVerifyBy?: string;
     /** The language the person reads in ("es", "en-US"), when Cauthy knows it. */
     locale?: string;
+    /** A guest: a visitor's session before they sign up. No email; `account.upgrade` makes it an account, keeping `id`. */
+    isAnonymous?: boolean;
 }
 /** A value JSON can carry. What crosses from server to browser is typed as this, never `unknown`. */
 type JsonValue = string | number | boolean | null | JsonValue[] | {
@@ -265,6 +267,20 @@ interface AuthMethods {
      * forms show it themselves.
      */
     captchaSiteKey?: string;
+    /**
+     * Whether the workspace signs some people in through their company's SSO,
+     * found by their work address (`signIn.ssoDiscover`, `signIn.sso`).
+     */
+    sso: boolean;
+}
+/** A company's sign-in (an SSO connection of the workspace). */
+interface SSOConnection {
+    /** What `signIn.sso({ connection })` takes. */
+    id: string;
+    /** The company's name, for "Continue with …". */
+    name: string;
+    /** The address can sign in no other way: a password, link or provider answers `sso_required`. */
+    enforced: boolean;
 }
 /**
  * What holds a passkey, as its authenticator says: a security key (a YubiKey),
@@ -314,6 +330,82 @@ interface ConnectedAgent {
     connectedAt: string;
     lastUsedAt: string;
 }
+/** An organization the person belongs to, with what their role lets them do with its people. */
+interface OrganizationSeat {
+    id: string;
+    /** The client system it is of (`pondari`). */
+    system: string;
+    name: string;
+    kind: string;
+    /** The person's role in it. */
+    role: string;
+    /** Cauthy's member powers, from the system's catalog: cauthy:members read and manage. */
+    can: {
+        readMembers: boolean;
+        manageMembers: boolean;
+    };
+}
+/** A person of an organization, as a member who may see them reads it. */
+interface OrganizationPerson {
+    userId: string;
+    email: string;
+    name: string;
+    role: string;
+    /** The account's: `active`, `suspended`… A disabled member is still listed. */
+    status: string;
+    /** Invited and not yet accepted. */
+    invited: boolean;
+    /** Manages the organization's members. */
+    manager: boolean;
+    /** The signed-in person. */
+    you: boolean;
+    /** UTC, ISO 8601. */
+    since: string;
+}
+/** A role of the organization's system, as the catalog names it. */
+interface OrganizationRoleChoice {
+    role: string;
+    name: string;
+    description: string;
+    /** Holding it manages the organization's members. */
+    manager: boolean;
+}
+/**
+ * The signed-in person's organizations, and their people. Seeing them needs
+ * cauthy:members read in the person's role; changing them needs manage. Cauthy
+ * decides, with the person's own session: the application authorizes nothing.
+ */
+interface OrganizationsClient {
+    /** The organizations the person belongs to; one system's only with `system`. */
+    list(system?: string): Promise<OrganizationSeat[]>;
+    /** The people of one, or null when the person may not see them. */
+    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. */
+    add(organizationId: string, form: {
+        email: string;
+        role: string;
+        name?: string;
+        locale?: string;
+    }): Promise<AuthResult<'added', {
+        member: OrganizationPerson;
+    }>>;
+    setRole(organizationId: string, userId: string, role: string): Promise<AuthResult<'changed', {
+        userId: string;
+        role: string;
+    }>>;
+    /** Removes a member; the person themself may always leave. */
+    remove(organizationId: string, userId: string): Promise<AuthResult<'removed', {
+        userId: string;
+    }>>;
+    /** Sends a member's invitation again. */
+    inviteAgain(organizationId: string, userId: string, form?: {
+        locale?: string;
+    }): Promise<AuthResult<'sent', {
+        userId: string;
+    }>>;
+}
 interface AccountSession {
     /** "Mac · Chrome", or "" when the browser did not say. */
     device: string;
@@ -436,6 +528,26 @@ interface AccountClient {
     unlink(provider: string): Promise<AuthResult<'unlinked', {
         provider: string;
     }>>;
+    /**
+     * A guest becomes an account of their own with an address and a password —
+     * the same id, so what they did stays theirs. `email_taken`: the address has
+     * an account already; offer to sign in with it.
+     */
+    upgrade(form: {
+        email: string;
+        password: string;
+        name?: string;
+    }): Promise<AuthResult<'signed_in', {
+        session: PublicSession;
+    }>>;
+    /** Where a guest goes to become the account of a provider's address (Google…). */
+    upgradeUrl(provider: string, options?: {
+        returnTo?: string;
+    }): string;
+    /** Sends a guest to `upgradeUrl`; they come back signed in as the account. */
+    upgradeWith(provider: string, options?: {
+        returnTo?: string;
+    }): void;
     /** Where the account is signed in. */
     sessions(): Promise<AccountSession[]>;
     /** Signs the account out everywhere, here too. */
@@ -469,6 +581,17 @@ interface AccountClient {
 }
 interface AuthClient {
     signIn: {
+        /**
+         * A guest session, before the visitor signs up: the application keeps what
+         * they do under `session.user.id`, and `account.upgrade` (or
+         * `account.upgradeWith`) makes it their account, same id. Only where the
+         * workspace allows guests (`anonymous_disabled` otherwise).
+         */
+        anonymously(form?: {
+            captchaToken?: string;
+        }): Promise<AuthResult<'signed_in', {
+            session: PublicSession;
+        }>>;
         /** With address and password. `mfa_required`: ask for the code and call `signIn.mfa`. */
         email(form: {
             email: string;
@@ -577,6 +700,38 @@ interface AuthClient {
         social(provider: string, options?: {
             returnTo?: string;
         }): void;
+        /**
+         * Which company's sign-in a work address uses, if any (`found`), or
+         * `none`. It says so of the address's domain, never whether the address
+         * has an account.
+         */
+        ssoDiscover(form: {
+            email: string;
+        }): Promise<AuthResult<'found', {
+            connection: SSOConnection;
+        }> | AuthResult<'none'>>;
+        /**
+         * Sends the browser to the person's company (found by `email`, or named
+         * by `connection`); it comes back signed in, at `returnTo`. A sign-in the
+         * company refused comes back with `?auth_error=`. Any other way of
+         * signing in answers `sso_required` for an address its company holds to
+         * SSO: send it here then.
+         */
+        sso(target: {
+            email: string;
+        } | {
+            connection: string;
+        }, options?: {
+            returnTo?: string;
+        }): void;
+        /** Where `sso` sends the browser, for a plain link. */
+        ssoUrl(target: {
+            email: string;
+        } | {
+            connection: string;
+        }, options?: {
+            returnTo?: string;
+        }): string;
         /** Where `social` sends the browser, for a plain link. */
         socialUrl(provider: string, options?: {
             returnTo?: string;
@@ -612,6 +767,8 @@ interface AuthClient {
     signOut(): Promise<AuthResult<'signed_out'>>;
     /** The signed-in person's own account. */
     account: AccountClient;
+    /** The signed-in person's organizations, and their people. */
+    organizations: OrganizationsClient;
     /** Who is signed in, or null. */
     getSession(): Promise<PublicSession | null>;
     methods(): Promise<AuthMethods>;
@@ -723,6 +880,24 @@ interface AuthTexts {
     linkWith: string;
     unlink: string;
     linked: string;
+    ssoOnly: string;
+    members: string;
+    membersHidden: string;
+    organizationMissing: string;
+    memberYou: string;
+    memberInvited: string;
+    memberManager: string;
+    memberRole: string;
+    memberAdd: string;
+    memberAdded: string;
+    memberRemove: string;
+    memberRemoveConfirm: string;
+    memberLeave: string;
+    memberLeaveConfirm: string;
+    memberInviteAgain: string;
+    memberInvitationSent: string;
+    yes: string;
+    cancel: string;
     /** By error code; one missing shows what the server said. */
     errors: Record<string, string>;
 }
@@ -828,6 +1003,22 @@ 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;
+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 people of one of the signed-in person's organizations, administered
+ * from the application. What it offers follows the person's role in the
+ * system's catalog: cauthy:members read lists the people; manage adds them by
+ * address (one with no account is invited), changes their role, sends an
+ * invitation again and removes them. Anybody may leave. Cauthy checks each
+ * change with the person's own session; the application authorizes nothing.
+ * Like the other forms, it carries no styles.
+ */
+declare function OrganizationMembers(props: OrganizationMembersProps): react.JSX.Element;
 
 interface SessionContext {
     /** The signed-in person and their organizations, or null. */
@@ -872,4 +1063,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, type Passkey, type PasskeyKind, type PermissionOf, type Policy, type PublicSession, ResetPassword, type RoleOf, type SecondStep, type SessionContext, type SessionOrganization, type SessionUser, SignIn, SignUp, VerifyEmail, can, canAutofillPasskeys, canUsePasskeys, createAuthClient, definePolicy, useAuth, useSession };
+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 };