@clerk/react 6.15.0-snapshot.v20260828154440 → 6.15.0

package/dist/experimental/mosaic.d.cts

@@ -1,239 +0,0 @@
-import { OrganizationResource, UserResource } from "@clerk/shared/types";
-import { ReactElement, ReactNode } from "react";
-
-//#region ../ui/dist-mosaic/index.d.ts
-//#region src/mosaic/user-button/user-button.types.d.ts
-/**
- * Which switchers the surface carries. `combined` is both; `organization` is an organization
- * switcher with no account rows; `user` is an account switcher that never shows an organization,
- * even when one is active.
- */
-type UserButtonMode = 'combined' | 'organization' | 'user';
-/**
- * Which of the two switchers a `combined` surface leads with: the one named in the trigger and
- * headed in the popup. Both are still listed either way. The single-purpose modes have only one
- * thing to lead with, so they ignore it.
- */
-type UserButtonModePriority = 'organization' | 'user';
-/** Which switchers the surface carries, and which one it leads with. */
-interface UserButtonModeProps {
-  /**
-   * Which switchers the popup carries: both, organizations alone, or accounts alone.
-   *
-   * @default 'combined'
-   */
-  mode?: UserButtonMode;
-  /**
-   * Which switcher a `combined` surface leads with in the trigger and the popup's header. The other
-   * one is still listed. Ignored by the single-purpose modes, which have only one thing to lead with.
-   *
-   * @default 'organization'
-   */
-  modePriority?: UserButtonModePriority;
-}
-/**
- * A built-in action the foot of the popup lists as a row of its own, named by the id `menuItemOrder`
- * knows it by. The surface's other actions live in its header or behind a `⋯`, where there is no
- * list for an order to run in.
- *
- * `switchAccount` and `addAccount` share a slot: the foot carries the flyout of signed-in accounts
- * where there is more than one, and the row it would have opened onto where there is not. Name both
- * to place that slot whichever way it resolves.
- */
-type UserButtonMenuItemId = 'switchAccount' | 'addAccount' | 'signOutAll';
-interface UserButtonMenuItemBase {
-  /** Identifies the row, for ordering. */
-  id: string;
-  /** Names the row. */
-  label: string;
-  icon?: ReactNode;
-}
-/** An action of your own at the foot of the popup. */
-interface UserButtonMenuAction extends UserButtonMenuItemBase {
-  onClick: () => void;
-  href?: never;
-}
-/** A row at the foot of the popup that leaves for somewhere else. */
-interface UserButtonMenuLink extends UserButtonMenuItemBase {
-  /** Where the row goes. */
-  href: string;
-  onClick?: never;
-}
-type UserButtonMenuItem = UserButtonMenuAction | UserButtonMenuLink;
-/** The app's own actions at the foot of the popup, and the order the foot's rows run in. */
-interface UserButtonMenuProps {
-  /** Actions and links of your own, added to the foot of the popup ahead of Clerk's own rows. */
-  customMenuItems?: UserButtonMenuItem[];
-  /**
-   * The order the foot's rows run in, by id: a built-in row's id, or a custom item's `id`. Anything
-   * left out follows the rows named here. An id the surface does not carry as a row is ignored,
-   * since which rows the foot has depends on its mode.
-   */
-  menuItemOrder?: (UserButtonMenuItemId | (string & {}))[];
-} //#endregion
-//#region src/mosaic/user-button/user-button.model.d.ts
-type AfterSelectUrl<T> = ((entity: T) => string) | string;
-/** A URL is the whole opt-in to navigation, and `modal` forbids one, so the pair cannot contradict itself. */
-type UserProfileMode = {
-  userProfileUrl: string;
-  userProfileMode?: 'navigation';
-} | {
-  userProfileUrl?: never;
-  userProfileMode?: 'modal';
-};
-type OrganizationProfileMode = {
-  organizationProfileUrl: string;
-  organizationProfileMode?: 'navigation';
-} | {
-  organizationProfileUrl?: never;
-  organizationProfileMode?: 'modal';
-};
-type CreateOrganizationMode = {
-  createOrganizationUrl: string;
-  createOrganizationMode?: 'navigation';
-} | {
-  createOrganizationUrl?: never;
-  createOrganizationMode?: 'modal';
-};
-type UserButtonModelOptions = UserProfileMode & OrganizationProfileMode & CreateOrganizationMode & {
-  afterSelectOrganizationUrl?: AfterSelectUrl<OrganizationResource>; /** Where selecting the personal workspace lands. Resolved against the user, not an organization. */
-  afterSelectPersonalUrl?: AfterSelectUrl<UserResource>; /** Where switching account lands. The instance URL is used when this is omitted. */
-  afterSwitchSessionUrl?: string;
-  /**
-   * Leaves the personal workspace out. An instance that forces organization selection withholds it
-   * either way, so this cannot opt back in.
-   */
-  hidePersonal?: boolean;
-}; //#endregion
-//#region src/mosaic/user-button/user-button.pages.d.ts
-/** A page the UserProfile brings itself, named by the id its navigation knows it as. */
-type UserProfilePageId = 'account' | 'security' | 'billing' | 'apiKeys';
-/** A page of your own inside the profile, reached from its navigation. */
-interface CustomProfilePage {
-  /** Names the page in the profile's navigation. */
-  label: string;
-  /** Where the page lives, relative to the profile root. Absolute URLs are rejected. */
-  path: string;
-  href?: never;
-  icon?: ReactNode;
-  /** Rendered as the page itself. */
-  content: ReactNode;
-}
-/** A row in the profile's navigation that leaves for somewhere else. */
-interface CustomProfileLink {
-  /** Names the row in the profile's navigation. */
-  label: string;
-  /** Identifies the row, for ordering. */
-  path: string;
-  /** Where the row goes. */
-  href: string;
-  icon?: ReactNode;
-  content?: never;
-}
-type CustomProfileItem = CustomProfilePage | CustomProfileLink; //#endregion
-//#region src/mosaic/user-button/user-button.view.d.ts
-interface UserButtonTriggerProps {
-  /**
-   * Names the active workspace beside its avatar — the organization wherever one heads the
-   * trigger, no selection when personal is hidden and none is active, the account otherwise.
-   * Turn it off for the avatar alone.
-   *
-   * @default true
-   */
-  renderTriggerLabel?: boolean;
-  /**
-   * Carries the active organization's plan beside its name. Part of the label, so it needs
-   * `renderTriggerLabel`: a plan badge with nothing to qualify says nothing.
-   *
-   * @default true
-   */
-  renderTriggerBadge?: boolean;
-} //#endregion
-//#region src/mosaic/user-button/user-button.d.ts
-/** Configures the UserProfile this button opens. */
-interface UserButtonUserProfileProps {
-  /** Pages and links of your own, added to the profile's navigation. */
-  customPages?: CustomProfileItem[];
-  /**
-   * The order the profile's navigation runs in, by id: a built-in page's id, or a custom entry's
-   * `path`. Anything left out follows the pages named here. The first page is the one the profile
-   * opens on, so it cannot be a link.
-   */
-  pageOrder?: (UserProfilePageId | (string & {}))[];
-}
-/** Everything `<UserButton />` takes: profile routing, trigger content, the app's own menu rows, and the profile it opens. */
-type UserButtonProps = UserButtonModelOptions & UserButtonTriggerProps & UserButtonMenuProps & UserButtonModeProps & {
-  userProfileProps?: UserButtonUserProfileProps;
-  /**
-   * Fallback while loading.
-   *
-   * Note that the UserButton renders nothing when the user is signed out, so using this on
-   * pages that are reachable while both signed-out and signed-in can result in Fallback->Nothing.
-   */
-  fallback?: ReactNode;
-};
-/**
- * The signed-in user's avatar, and the menu behind it: switch organization, switch or add an account,
- * open the profile, and sign out. It reads the active session and organization from Clerk, so it takes
- * no data. It renders `fallback` until Clerk answers, and nothing at all when nobody is signed in.
- *
- * Each action is a request: the row you click spins, the others stand down, and the menu stays open on
- * the result. Only an action that navigates closes it.
- *
- * @example
- * ```tsx
- * import { UserButton } from '@clerk/nextjs/experimental/mosaic';
- *
- * <UserButton />
- * ```
- *
- * @example
- * `mode` narrows the menu to one switcher, and `modePriority` picks which one a combined menu leads
- * with — in its header, and in the trigger beside the avatar. The other one is still listed.
- * ```tsx
- * <UserButton mode='organization' />
- * <UserButton mode='user' />
- * <UserButton modePriority='user' />
- * ```
- *
- * @example
- * Passing a URL routes to a page of your own instead of opening Clerk's modal; that is the whole
- * opt-in. `afterSelectOrganizationUrl` is where switching organization lands, and takes a `:param`
- * template, a plain path, or a function. `afterSwitchSessionUrl` is where switching account lands.
- * ```tsx
- * <UserButton
- *   userProfileUrl='/account'
- *   organizationProfileUrl='/settings/organization'
- *   afterSelectOrganizationUrl='/orgs/:slug'
- *   afterSwitchSessionUrl='/dashboard'
- * />
- * ```
- *
- * @example
- * `fallback` holds the space while Clerk is still answering. Size it to the trigger to keep the row
- * it sits in from moving. Nothing stands in once the answer is that nobody is signed in.
- * ```tsx
- * <UserButton fallback={<AvatarSkeleton />} />
- * ```
- *
- * @example
- * `customPages` adds your own pages to the profile this button opens; `customMenuItems` adds your
- * own rows to the foot of the menu, each one either an `onClick` action or an `href` link.
- * ```tsx
- * <UserButton
- *   userProfileProps={{
- *     customPages: [{ path: 'usage', label: 'Usage', icon: <ChartIcon />, content: <UsagePage /> }],
- *     pageOrder: ['account', 'usage', 'security'],
- *   }}
- *   customMenuItems={[
- *     { id: 'docs', label: 'Documentation', icon: <BookIcon />, href: 'https://example.com/docs' },
- *     { id: 'support', label: 'Contact support', icon: <ChatIcon />, onClick: () => openSupportChat() },
- *   ]}
- *   menuItemOrder={['docs', 'support', 'addAccount', 'signOutAll']}
- * />
- * ```
- */
-declare function UserButton(props?: UserButtonProps): ReactElement | null; //#endregion
-//#endregion
-export { UserButton, type UserButtonProps };
-//# sourceMappingURL=mosaic.d.cts.map

package/dist/experimental/mosaic.d.mts

@@ -1,239 +0,0 @@
-import { ReactElement, ReactNode } from "react";
-import { OrganizationResource, UserResource } from "@clerk/shared/types";
-
-//#region ../ui/dist-mosaic/index.d.ts
-//#region src/mosaic/user-button/user-button.types.d.ts
-/**
- * Which switchers the surface carries. `combined` is both; `organization` is an organization
- * switcher with no account rows; `user` is an account switcher that never shows an organization,
- * even when one is active.
- */
-type UserButtonMode = 'combined' | 'organization' | 'user';
-/**
- * Which of the two switchers a `combined` surface leads with: the one named in the trigger and
- * headed in the popup. Both are still listed either way. The single-purpose modes have only one
- * thing to lead with, so they ignore it.
- */
-type UserButtonModePriority = 'organization' | 'user';
-/** Which switchers the surface carries, and which one it leads with. */
-interface UserButtonModeProps {
-  /**
-   * Which switchers the popup carries: both, organizations alone, or accounts alone.
-   *
-   * @default 'combined'
-   */
-  mode?: UserButtonMode;
-  /**
-   * Which switcher a `combined` surface leads with in the trigger and the popup's header. The other
-   * one is still listed. Ignored by the single-purpose modes, which have only one thing to lead with.
-   *
-   * @default 'organization'
-   */
-  modePriority?: UserButtonModePriority;
-}
-/**
- * A built-in action the foot of the popup lists as a row of its own, named by the id `menuItemOrder`
- * knows it by. The surface's other actions live in its header or behind a `⋯`, where there is no
- * list for an order to run in.
- *
- * `switchAccount` and `addAccount` share a slot: the foot carries the flyout of signed-in accounts
- * where there is more than one, and the row it would have opened onto where there is not. Name both
- * to place that slot whichever way it resolves.
- */
-type UserButtonMenuItemId = 'switchAccount' | 'addAccount' | 'signOutAll';
-interface UserButtonMenuItemBase {
-  /** Identifies the row, for ordering. */
-  id: string;
-  /** Names the row. */
-  label: string;
-  icon?: ReactNode;
-}
-/** An action of your own at the foot of the popup. */
-interface UserButtonMenuAction extends UserButtonMenuItemBase {
-  onClick: () => void;
-  href?: never;
-}
-/** A row at the foot of the popup that leaves for somewhere else. */
-interface UserButtonMenuLink extends UserButtonMenuItemBase {
-  /** Where the row goes. */
-  href: string;
-  onClick?: never;
-}
-type UserButtonMenuItem = UserButtonMenuAction | UserButtonMenuLink;
-/** The app's own actions at the foot of the popup, and the order the foot's rows run in. */
-interface UserButtonMenuProps {
-  /** Actions and links of your own, added to the foot of the popup ahead of Clerk's own rows. */
-  customMenuItems?: UserButtonMenuItem[];
-  /**
-   * The order the foot's rows run in, by id: a built-in row's id, or a custom item's `id`. Anything
-   * left out follows the rows named here. An id the surface does not carry as a row is ignored,
-   * since which rows the foot has depends on its mode.
-   */
-  menuItemOrder?: (UserButtonMenuItemId | (string & {}))[];
-} //#endregion
-//#region src/mosaic/user-button/user-button.model.d.ts
-type AfterSelectUrl<T> = ((entity: T) => string) | string;
-/** A URL is the whole opt-in to navigation, and `modal` forbids one, so the pair cannot contradict itself. */
-type UserProfileMode = {
-  userProfileUrl: string;
-  userProfileMode?: 'navigation';
-} | {
-  userProfileUrl?: never;
-  userProfileMode?: 'modal';
-};
-type OrganizationProfileMode = {
-  organizationProfileUrl: string;
-  organizationProfileMode?: 'navigation';
-} | {
-  organizationProfileUrl?: never;
-  organizationProfileMode?: 'modal';
-};
-type CreateOrganizationMode = {
-  createOrganizationUrl: string;
-  createOrganizationMode?: 'navigation';
-} | {
-  createOrganizationUrl?: never;
-  createOrganizationMode?: 'modal';
-};
-type UserButtonModelOptions = UserProfileMode & OrganizationProfileMode & CreateOrganizationMode & {
-  afterSelectOrganizationUrl?: AfterSelectUrl<OrganizationResource>; /** Where selecting the personal workspace lands. Resolved against the user, not an organization. */
-  afterSelectPersonalUrl?: AfterSelectUrl<UserResource>; /** Where switching account lands. The instance URL is used when this is omitted. */
-  afterSwitchSessionUrl?: string;
-  /**
-   * Leaves the personal workspace out. An instance that forces organization selection withholds it
-   * either way, so this cannot opt back in.
-   */
-  hidePersonal?: boolean;
-}; //#endregion
-//#region src/mosaic/user-button/user-button.pages.d.ts
-/** A page the UserProfile brings itself, named by the id its navigation knows it as. */
-type UserProfilePageId = 'account' | 'security' | 'billing' | 'apiKeys';
-/** A page of your own inside the profile, reached from its navigation. */
-interface CustomProfilePage {
-  /** Names the page in the profile's navigation. */
-  label: string;
-  /** Where the page lives, relative to the profile root. Absolute URLs are rejected. */
-  path: string;
-  href?: never;
-  icon?: ReactNode;
-  /** Rendered as the page itself. */
-  content: ReactNode;
-}
-/** A row in the profile's navigation that leaves for somewhere else. */
-interface CustomProfileLink {
-  /** Names the row in the profile's navigation. */
-  label: string;
-  /** Identifies the row, for ordering. */
-  path: string;
-  /** Where the row goes. */
-  href: string;
-  icon?: ReactNode;
-  content?: never;
-}
-type CustomProfileItem = CustomProfilePage | CustomProfileLink; //#endregion
-//#region src/mosaic/user-button/user-button.view.d.ts
-interface UserButtonTriggerProps {
-  /**
-   * Names the active workspace beside its avatar — the organization wherever one heads the
-   * trigger, no selection when personal is hidden and none is active, the account otherwise.
-   * Turn it off for the avatar alone.
-   *
-   * @default true
-   */
-  renderTriggerLabel?: boolean;
-  /**
-   * Carries the active organization's plan beside its name. Part of the label, so it needs
-   * `renderTriggerLabel`: a plan badge with nothing to qualify says nothing.
-   *
-   * @default true
-   */
-  renderTriggerBadge?: boolean;
-} //#endregion
-//#region src/mosaic/user-button/user-button.d.ts
-/** Configures the UserProfile this button opens. */
-interface UserButtonUserProfileProps {
-  /** Pages and links of your own, added to the profile's navigation. */
-  customPages?: CustomProfileItem[];
-  /**
-   * The order the profile's navigation runs in, by id: a built-in page's id, or a custom entry's
-   * `path`. Anything left out follows the pages named here. The first page is the one the profile
-   * opens on, so it cannot be a link.
-   */
-  pageOrder?: (UserProfilePageId | (string & {}))[];
-}
-/** Everything `<UserButton />` takes: profile routing, trigger content, the app's own menu rows, and the profile it opens. */
-type UserButtonProps = UserButtonModelOptions & UserButtonTriggerProps & UserButtonMenuProps & UserButtonModeProps & {
-  userProfileProps?: UserButtonUserProfileProps;
-  /**
-   * Fallback while loading.
-   *
-   * Note that the UserButton renders nothing when the user is signed out, so using this on
-   * pages that are reachable while both signed-out and signed-in can result in Fallback->Nothing.
-   */
-  fallback?: ReactNode;
-};
-/**
- * The signed-in user's avatar, and the menu behind it: switch organization, switch or add an account,
- * open the profile, and sign out. It reads the active session and organization from Clerk, so it takes
- * no data. It renders `fallback` until Clerk answers, and nothing at all when nobody is signed in.
- *
- * Each action is a request: the row you click spins, the others stand down, and the menu stays open on
- * the result. Only an action that navigates closes it.
- *
- * @example
- * ```tsx
- * import { UserButton } from '@clerk/nextjs/experimental/mosaic';
- *
- * <UserButton />
- * ```
- *
- * @example
- * `mode` narrows the menu to one switcher, and `modePriority` picks which one a combined menu leads
- * with — in its header, and in the trigger beside the avatar. The other one is still listed.
- * ```tsx
- * <UserButton mode='organization' />
- * <UserButton mode='user' />
- * <UserButton modePriority='user' />
- * ```
- *
- * @example
- * Passing a URL routes to a page of your own instead of opening Clerk's modal; that is the whole
- * opt-in. `afterSelectOrganizationUrl` is where switching organization lands, and takes a `:param`
- * template, a plain path, or a function. `afterSwitchSessionUrl` is where switching account lands.
- * ```tsx
- * <UserButton
- *   userProfileUrl='/account'
- *   organizationProfileUrl='/settings/organization'
- *   afterSelectOrganizationUrl='/orgs/:slug'
- *   afterSwitchSessionUrl='/dashboard'
- * />
- * ```
- *
- * @example
- * `fallback` holds the space while Clerk is still answering. Size it to the trigger to keep the row
- * it sits in from moving. Nothing stands in once the answer is that nobody is signed in.
- * ```tsx
- * <UserButton fallback={<AvatarSkeleton />} />
- * ```
- *
- * @example
- * `customPages` adds your own pages to the profile this button opens; `customMenuItems` adds your
- * own rows to the foot of the menu, each one either an `onClick` action or an `href` link.
- * ```tsx
- * <UserButton
- *   userProfileProps={{
- *     customPages: [{ path: 'usage', label: 'Usage', icon: <ChartIcon />, content: <UsagePage /> }],
- *     pageOrder: ['account', 'usage', 'security'],
- *   }}
- *   customMenuItems={[
- *     { id: 'docs', label: 'Documentation', icon: <BookIcon />, href: 'https://example.com/docs' },
- *     { id: 'support', label: 'Contact support', icon: <ChatIcon />, onClick: () => openSupportChat() },
- *   ]}
- *   menuItemOrder={['docs', 'support', 'addAccount', 'signOutAll']}
- * />
- * ```
- */
-declare function UserButton(props?: UserButtonProps): ReactElement | null; //#endregion
-//#endregion
-export { UserButton, type UserButtonProps };
-//# sourceMappingURL=mosaic.d.mts.map