@better-auth-ui/core 1.6.8 → 1.6.10

package/dist/plugins/multi-session/multi-session-query-keys.d.ts

@@ -0,0 +1,6 @@
+/** Query key factory for multi-session queries, scoped per user. */
+export declare const multiSessionQueryKeys: {
+    readonly all: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "multiSession"];
+    readonly lists: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "multiSession", "list"];
+    readonly list: <TQuery = undefined>(userId: string | undefined, query?: TQuery) => readonly ["auth", "user", string | undefined, "multiSession", "list", NonNullable<TQuery> | null];
+};

package/dist/plugins/organization/organization-localization.d.ts

@@ -0,0 +1,115 @@
+export declare const organizationLocalization: {
+    /** @remarks `"Accept"` */
+    accept: string;
+    /** @remarks `"Accepted"` */
+    accepted: string;
+    /** @remarks `"Actions"` */
+    actions: string;
+    /** @remarks `"Admin"` */
+    admin: string;
+    /** @remarks `"All"` */
+    all: string;
+    /** @remarks `"Canceled"` */
+    canceled: string;
+    /** @remarks `"Cancel invitation"` */
+    cancelInvitation: string;
+    /** @remarks `"Change logo"` */
+    changeLogo: string;
+    /** @remarks `"Change role"` */
+    changeMemberRole: string;
+    /** @remarks `"Clear"` */
+    clear: string;
+    /** @remarks `"Create organization"` */
+    createOrganization: string;
+    /** @remarks `"Delete logo"` */
+    deleteLogo: string;
+    /** @remarks `"Delete organization"` */
+    deleteOrganization: string;
+    /** @remarks `"Permanently delete this organization and all of its data. All members will lose access and this cannot be undone."` */
+    deleteOrganizationDescription: string;
+    /** @remarks `"Invitations"` */
+    invitations: string;
+    /** @remarks `"Invited at"` */
+    invitedAt: string;
+    /** @remarks `"Invite member"` */
+    inviteMember: string;
+    /** @remarks `"Member invited successfully"` */
+    inviteMemberSuccess: string;
+    /** @remarks `"We'll email them a link to join this organization. Choose the role they'll have once they accept."` */
+    inviteMemberDescription: string;
+    /** @remarks `"You left the organization"` */
+    leftOrganization: string;
+    /** @remarks `"Leave organization"` */
+    leaveOrganization: string;
+    /** @remarks `"Leave this organization and lose access to its data and resources. You'll need a new invitation to rejoin."` */
+    leaveOrganizationDescription: string;
+    /** @remarks `"Logo"` */
+    logo: string;
+    /** @remarks `"Logo updated successfully"` */
+    logoChangedSuccess: string;
+    /** @remarks `"Logo removed successfully"` */
+    logoDeletedSuccess: string;
+    /** @remarks `"Manage"` */
+    manage: string;
+    /** @remarks `"Member"` */
+    member: string;
+    /** @remarks `"Member removed"` */
+    memberRemoved: string;
+    /** @remarks `"Member role updated"` */
+    memberRoleUpdated: string;
+    /** @remarks `"Members"` */
+    members: string;
+    /** @remarks `"People"` */
+    people: string;
+    /** @remarks `"Name"` */
+    name: string;
+    /** @remarks `"Enter the organization name"` */
+    namePlaceholder: string;
+    /** @remarks `"No invitations"` */
+    noInvitations: string;
+    /** @remarks `"No organizations"` */
+    noOrganizations: string;
+    /** @remarks `"Organization"` */
+    organization: string;
+    /** @remarks `"Organization deleted"` */
+    organizationDeleted: string;
+    /** @remarks `"Invite a teammate to collaborate in this organization."` */
+    organizationInvitationsEmptyDescription: string;
+    /** @remarks `"Organizations"` */
+    organizations: string;
+    /** @remarks `"Create an organization to collaborate with others and manage shared access."` */
+    organizationsDescription: string;
+    /** @remarks `"Organization profile"` */
+    organizationProfile: string;
+    /** @remarks `"Organization updated successfully"` */
+    organizationUpdatedSuccess: string;
+    /** @remarks `"Owner"` */
+    owner: string;
+    /** @remarks `"Pending"` */
+    pending: string;
+    /** @remarks `"Personal account"` */
+    personalAccount: string;
+    /** @remarks `"Rejected"` */
+    rejected: string;
+    /** @remarks `"Reject invitation"` */
+    rejectInvitation: string;
+    /** @remarks `"Remove member"` */
+    removeMember: string;
+    /** @remarks `"Are you sure you want to remove this member from the organization? They will lose access immediately."` */
+    removeMemberWarning: string;
+    /** @remarks `"Role"` */
+    role: string;
+    /** @remarks `"Search..."` */
+    search: string;
+    /** @remarks `"Slug"` */
+    slug: string;
+    /** @remarks `"organization-slug"` */
+    slugPlaceholder: string;
+    /** @remarks `"Status"` */
+    status: string;
+    /** @remarks `"Upload logo"` */
+    uploadLogo: string;
+    /** @remarks `"Invitations to join an organization will show up here."` */
+    userInvitationsEmptyDescription: string;
+};
+export type OrganizationLocalization = typeof organizationLocalization;

package/dist/plugins/organization/organization-mutation-keys.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Hierarchical mutation key factory for organization-related mutations.
+ *
+ * Mutation keys are mostly used for `useIsMutating` and global
+ * `MutationCache` observers (e.g. toast handling), so the keys are static
+ * tuples rather than parameterised factories. Each grouping exposes an
+ * `all` prefix so consumers can match a whole feature at once:
+ *
+ * ```ts
+ * useIsMutating({ mutationKey: organizationMutationKeys.all })
+ * ```
+ */
+export declare const organizationMutationKeys: {
+    /** Root key for every organization mutation. */
+    readonly all: readonly ["auth", "organization"];
+    /** Key for `organization.create`. */
+    readonly create: readonly ["auth", "organization", "create"];
+    /** Key for `organization.delete`. */
+    readonly delete: readonly ["auth", "organization", "delete"];
+    /** Key for `organization.update`. */
+    readonly update: readonly ["auth", "organization", "update"];
+    /** Key for `organization.setActive`. */
+    readonly setActive: readonly ["auth", "organization", "setActive"];
+    /** Key for `organization.inviteMember`. */
+    readonly inviteMember: readonly ["auth", "organization", "inviteMember"];
+    /** Key for `organization.removeMember`. */
+    readonly removeMember: readonly ["auth", "organization", "removeMember"];
+    /** Key for `organization.leave`. */
+    readonly leave: readonly ["auth", "organization", "leave"];
+    /** Key for `organization.updateMemberRole`. */
+    readonly updateMemberRole: readonly ["auth", "organization", "updateMemberRole"];
+    /** Key for `organization.acceptInvitation`. */
+    readonly acceptInvitation: readonly ["auth", "organization", "acceptInvitation"];
+    /** Key for `organization.cancelInvitation`. */
+    readonly cancelInvitation: readonly ["auth", "organization", "cancelInvitation"];
+    /** Key for `organization.rejectInvitation` (invitee declines). */
+    readonly rejectInvitation: readonly ["auth", "organization", "rejectInvitation"];
+    /** Key for `organization.checkSlug`. */
+    readonly checkSlug: readonly ["auth", "organization", "checkSlug"];
+};

package/dist/plugins/organization/organization-plugin.d.ts

@@ -0,0 +1,152 @@
+import { AvatarConfig } from '../../config/avatar-config';
+import { OrganizationLocalization } from './organization-localization';
+import { OrganizationViewPaths } from './organization-view-paths';
+declare module "../../lib/view-paths" {
+    /** Widens `SettingsViewPaths` by adding the `"organizations"` path when this plugin is imported. */
+    interface SettingsViewPaths {
+        /** @default "organizations" */
+        organizations?: string;
+    }
+}
+declare module "../../lib/auth-plugin" {
+    interface AuthPluginViewPaths {
+        organization?: Partial<OrganizationViewPaths>;
+    }
+}
+export type OrganizationPluginOptions = {
+    /**
+     * Whether to call `organization.checkSlug` when entering an organization slug.
+     * @default true
+     */
+    checkSlug?: boolean;
+    /**
+     * Override the plugin's default localization strings.
+     * @remarks `OrganizationLocalization`
+     */
+    localization?: Partial<OrganizationLocalization>;
+    /**
+     * Override URL segments contributed by this plugin.
+     *
+     * - `settings.organizations` — segment for the organizations settings view (default `"organizations"`).
+     * - `organization.settings` — segment for the `/organization/...` profile and danger zone tab (default `"settings"`).
+     * - `organization.people` — segment for the `/organization/...` members and invitations tab (default `"people"`).
+     */
+    viewPaths?: {
+        settings?: {
+            /** @default "organizations" */
+            organizations?: string;
+        };
+        organization?: Partial<OrganizationViewPaths>;
+    };
+    /**
+     * Organization logo upload, optimization, and deletion configuration.
+     * Same shape as {@link AvatarConfig} used for user avatars (`AuthConfig.avatar`).
+     * @remarks `AvatarConfig`
+     * @default { enabled: true, resize: resizeAvatar, size: 256, extension: "png" }
+     */
+    logo?: Partial<AvatarConfig>;
+    /**
+     * Map of role keys to display labels. When omitted, defaults to localized
+     * labels for `owner`, `admin`, and `member` (from `localization.owner`
+     * etc.) plus {@link OrganizationPluginOptions.additionalRoles}. When set,
+     * replaces that default map entirely; use {@link OrganizationPluginOptions.additionalRoles}
+     * to add more labels on top. Looked up at render time via `roles?.[role]`.
+     * @remarks `Record<string, string>`
+     */
+    roles?: Record<string, string>;
+    /**
+     * Extra role labels merged after the effective role map (either
+     * {@link OrganizationPluginOptions.roles} when provided, or the localized
+     * defaults). Use this for custom server roles without redefining built-in
+     * labels.
+     * @remarks `Record<string, string>`
+     */
+    additionalRoles?: Record<string, string>;
+    slug?: string | null;
+};
+export declare const organizationPlugin: ((options?: OrganizationPluginOptions | undefined) => {
+    slug: string | null | undefined;
+    checkSlug: boolean;
+    localization: {
+        accept: string;
+        accepted: string;
+        actions: string;
+        admin: string;
+        all: string;
+        canceled: string;
+        cancelInvitation: string;
+        changeLogo: string;
+        changeMemberRole: string;
+        clear: string;
+        createOrganization: string;
+        deleteLogo: string;
+        deleteOrganization: string;
+        deleteOrganizationDescription: string;
+        invitations: string;
+        invitedAt: string;
+        inviteMember: string;
+        inviteMemberSuccess: string;
+        inviteMemberDescription: string;
+        leftOrganization: string;
+        leaveOrganization: string;
+        leaveOrganizationDescription: string;
+        logo: string;
+        logoChangedSuccess: string;
+        logoDeletedSuccess: string;
+        manage: string;
+        member: string;
+        memberRemoved: string;
+        memberRoleUpdated: string;
+        members: string;
+        people: string;
+        name: string;
+        namePlaceholder: string;
+        noInvitations: string;
+        noOrganizations: string;
+        organization: string;
+        organizationDeleted: string;
+        organizationInvitationsEmptyDescription: string;
+        organizations: string;
+        organizationsDescription: string;
+        organizationProfile: string;
+        organizationUpdatedSuccess: string;
+        owner: string;
+        pending: string;
+        personalAccount: string;
+        rejected: string;
+        rejectInvitation: string;
+        removeMember: string;
+        removeMemberWarning: string;
+        role: string;
+        search: string;
+        slug: string;
+        slugPlaceholder: string;
+        status: string;
+        uploadLogo: string;
+        userInvitationsEmptyDescription: string;
+    };
+    logo: {
+        delete?: (url: string) => Promise<void>;
+        enabled: boolean;
+        extension: "png" | "jpg" | "webp" | "inherit";
+        resize: (file: File, size?: number, extension?: "png" | "jpg" | "webp" | "inherit") => Promise<File>;
+        size: number;
+        upload?: (file: File) => Promise<string>;
+    };
+    roles: {
+        [x: string]: string;
+    };
+    viewPaths: {
+        settings: {
+            organizations: string;
+        };
+        organization: {
+            settings: string;
+            people: string;
+        };
+    };
+} & {
+    id: "organization";
+}) & {
+    id: "organization";
+};

package/dist/plugins/organization/organization-query-keys.d.ts

@@ -0,0 +1,40 @@
+/** Query key factory for organization queries, scoped per user. */
+export declare const organizationQueryKeys: {
+    readonly all: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "organization"];
+    readonly lists: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "organization", "list"];
+    readonly list: <TQuery = undefined>(userId: string | undefined, query?: TQuery) => readonly ["auth", "user", string | undefined, "organization", "list", NonNullable<TQuery> | null];
+    readonly fullDetails: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "organization", "fullDetails"];
+    readonly fullDetail: <TQuery = undefined>(userId: string | undefined, query?: TQuery) => readonly ["auth", "user", string | undefined, "organization", "fullDetails", NonNullable<TQuery> | null];
+    /**
+     * Prefix for every active-organization cache entry (used for invalidation
+     * across slug-partitioned variants).
+     */
+    readonly activeOrganizations: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "organization", "active"];
+    /**
+     * Cache entry for the currently active organization. Holds a {@link
+     * ListOrganization}-shaped value — distinct from `fullDetail`, which
+     * carries members and invitations — so `setActive`'s optimistic update
+     * (which can only produce a list-shaped org) doesn't corrupt the full
+     * cache.
+     */
+    readonly activeOrganization: <TQuery = undefined>(userId: string | undefined, query?: TQuery) => readonly ["auth", "user", string | undefined, "organization", "active", NonNullable<TQuery> | null];
+    readonly members: {
+        readonly all: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "organization", "members"];
+        readonly lists: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "organization", "members", "list"];
+        readonly list: <TQuery = undefined>(userId: string | undefined, query?: TQuery) => readonly ["auth", "user", string | undefined, "organization", "members", "list", NonNullable<TQuery> | null];
+    };
+    readonly invitations: {
+        readonly all: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "organization", "invitations"];
+        readonly lists: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "organization", "invitations", "list"];
+        readonly list: <TQuery = undefined>(userId: string | undefined, query?: TQuery) => readonly ["auth", "user", string | undefined, "organization", "invitations", "list", NonNullable<TQuery> | null];
+    };
+    readonly userInvitations: {
+        readonly all: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "organization", "userInvitations"];
+        readonly lists: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "organization", "userInvitations", "list"];
+        readonly list: <TQuery = undefined>(userId: string | undefined, query?: TQuery) => readonly ["auth", "user", string | undefined, "organization", "userInvitations", "list", NonNullable<TQuery> | null];
+    };
+    readonly permissions: {
+        readonly all: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "organization", "permissions"];
+        readonly has: <TQuery = undefined>(userId: string | undefined, query?: TQuery) => readonly ["auth", "user", string | undefined, "organization", "permissions", "has", NonNullable<TQuery> | null];
+    };
+};

package/dist/plugins/organization/organization-view-paths.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Path segments under `/organization/...` contributed by `organizationPlugin`.
+ *
+ * Read at runtime via `useAuthPlugin(organizationPlugin).viewPaths.organization`.
+ */
+export interface OrganizationViewPaths {
+    /**
+     * Path segment for organization profile and danger zone
+     * @default "settings"
+     */
+    settings: string;
+    /**
+     * Path segment for members and invitations
+     * @default "people"
+     */
+    people: string;
+}
+/** Valid organization management tab / route key. */
+export type OrganizationView = keyof OrganizationViewPaths;

package/dist/plugins/passkey/passkey-plugin.d.ts

@@ -6,7 +6,7 @@ export type PasskeyPluginOptions = {
      */
     localization?: Partial<PasskeyLocalization>;
 };
-export declare const passkeyPlugin: ((options?: PasskeyPluginOptions | undefined) => Omit<{
+export declare const passkeyPlugin: ((options?: PasskeyPluginOptions | undefined) => {
     localization: {
         passkey: string;
         addPasskey: string;
@@ -18,7 +18,7 @@ export declare const passkeyPlugin: ((options?: PasskeyPluginOptions | undefined
         noPasskeys: string;
         name: string;
     };
-}, "id"> & {
+} & {
     id: "passkey";
 }) & {
     id: "passkey";

package/dist/plugins/passkey/passkey-query-keys.d.ts

@@ -0,0 +1,6 @@
+/** Query key factory for passkey queries, scoped per user. */
+export declare const passkeyQueryKeys: {
+    readonly all: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "passkey"];
+    readonly lists: (userId: string | undefined) => readonly ["auth", "user", string | undefined, "passkey", "list"];
+    readonly list: <TQuery = undefined>(userId: string | undefined, query?: TQuery) => readonly ["auth", "user", string | undefined, "passkey", "list", NonNullable<TQuery> | null];
+};

package/dist/plugins/theme/theme-plugin.d.ts

@@ -19,7 +19,7 @@ export type ThemePluginOptions = {
      */
     themes?: string[];
 };
-export declare const themePlugin: ((options: ThemePluginOptions) => Omit<{
+export declare const themePlugin: ((options: ThemePluginOptions) => {
     localization: {
         appearance: string;
         theme: string;
@@ -30,7 +30,7 @@ export declare const themePlugin: ((options: ThemePluginOptions) => Omit<{
     theme: string;
     setTheme: (theme: string) => void;
     themes: string[];
-}, "id"> & {
+} & {
     id: "theme";
 }) & {
     id: "theme";

package/dist/plugins/username/username-mutation-keys.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Mutation keys contributed by the username plugin.
+ *
+ * `signIn` is kept under the shared `["auth", "signIn", ...]` namespace so
+ * consumers can match the whole sign-in surface with
+ * `useIsMutating({ mutationKey: ["auth", "signIn"] })`.
+ */
+export declare const usernameMutationKeys: {
+    /** Key for `signIn.username`. */
+    readonly signIn: readonly ["auth", "signIn", "username"];
+    /**
+     * Key for `isUsernameAvailable`. This is technically a read, but it's
+     * exposed via better-auth's mutation surface and lives under the mutation
+     * factories for parity with other username flows.
+     */
+    readonly isUsernameAvailable: readonly ["auth", "isUsernameAvailable"];
+};

package/dist/plugins/username/username-plugin.d.ts

@@ -24,7 +24,7 @@ export type UsernamePluginOptions = {
      */
     localization?: Partial<UsernameLocalization>;
 };
-export declare const usernamePlugin: ((options?: UsernamePluginOptions | undefined) => Omit<{
+export declare const usernamePlugin: ((options?: UsernamePluginOptions | undefined) => {
     minUsernameLength: number;
     maxUsernameLength: number;
     localization: {
@@ -43,7 +43,7 @@ export declare const usernamePlugin: ((options?: UsernamePluginOptions | undefin
         placeholder: string;
         inputType: "input";
         signUp: "above";
-        required: boolean;
+        required: true;
     } | {
         name: string;
         type: "string";
@@ -61,7 +61,7 @@ export declare const usernamePlugin: ((options?: UsernamePluginOptions | undefin
      * Whether to check username availability on sign-up and user profile.
      */
     isUsernameAvailable?: boolean;
-}, "id"> & {
+} & {
     id: "username";
 }) & {
     id: "username";

package/dist/plugins.d.ts

@@ -0,0 +1,28 @@
+export * from './plugins/api-key/api-key-localization';
+export * from './plugins/api-key/api-key-mutation-keys';
+export * from './plugins/api-key/api-key-plugin';
+export * from './plugins/api-key/api-key-query-keys';
+export * from './plugins/delete-user/delete-user-localization';
+export * from './plugins/delete-user/delete-user-mutation-keys';
+export * from './plugins/delete-user/delete-user-plugin';
+export * from './plugins/magic-link/magic-link-localization';
+export * from './plugins/magic-link/magic-link-mutation-keys';
+export * from './plugins/magic-link/magic-link-plugin';
+export * from './plugins/multi-session/multi-session-localization';
+export * from './plugins/multi-session/multi-session-mutation-keys';
+export * from './plugins/multi-session/multi-session-plugin';
+export * from './plugins/multi-session/multi-session-query-keys';
+export * from './plugins/organization/organization-localization';
+export * from './plugins/organization/organization-mutation-keys';
+export * from './plugins/organization/organization-plugin';
+export * from './plugins/organization/organization-query-keys';
+export * from './plugins/organization/organization-view-paths';
+export * from './plugins/passkey/passkey-localization';
+export * from './plugins/passkey/passkey-mutation-keys';
+export * from './plugins/passkey/passkey-plugin';
+export * from './plugins/passkey/passkey-query-keys';
+export * from './plugins/theme/theme-localization';
+export * from './plugins/theme/theme-plugin';
+export * from './plugins/username/username-localization';
+export * from './plugins/username/username-mutation-keys';
+export * from './plugins/username/username-plugin';