@streamoid/settings 0.6.6 → 0.7.1

package/dist/index.d.ts

@@ -48,7 +48,11 @@ type SettingsTab = "profile"
  | "organization"
 /** Organization › Workspaces. */
  | "organizationWorkspaces"
-/** Organization › Domains & join requests. */
+/**
+ * @deprecated The Domains tab is gone; join requests moved to Organization ›
+ * Workspaces. Kept so old links and host code still resolve — it renders
+ * the Workspaces view.
+ */
  | "organizationDomains" | "referral" | "billing" | "apikey";
 /** Which entity a tab acts on. Drives the nav grouping and the breadcrumb. */
 type SettingsScope = "account" | "workspace" | "organization" | "global";
@@ -155,10 +159,11 @@ interface SettingsWorkspaceCurrent {
      */
     organizationId?: string;
     /**
-     * "private" = only members of this workspace can see it; "shared" = every
-     * member of the parent org gets implicit view-only access. Toggled from
-     * the Workspace tab; org admins always have full implicit access
-     * regardless of this flag (host-side rule, not enforced by this package).
+     * "shared" = listed in the organization's workspace picker, so anyone in the
+     * organization can join it as a member; "private" = not listed, people get
+     * in by invite only. Visibility never grants access by itself. Org admins
+     * can open every workspace in their organization either way (host-side
+     * rule, not enforced by this package).
      */
     orgVisibility?: "private" | "shared";
 }
@@ -222,6 +227,16 @@ interface SettingsWorkspaceAdapter {
             role?: string;
         } | null;
     }>;
+    /**
+     * Optional: plan labels ("Free", "Pro", …) for the given workspaces, keyed by
+     * id. My workspaces lists workspaces a page at a time and asks only for the
+     * page on screen, so `list()` doesn't have to look up every workspace's plan
+     * before anything renders. Leave a workspace out of the result when its
+     * lookup failed; it is shown without a plan.
+     *
+     * When omitted, the plan on each `list()` item is used as before.
+     */
+    fetchPlans?: (workspaceIds: string[]) => Promise<Record<string, string>>;
     /**
      * Optional: host-controlled refresh after the package mutates workspace
      * state. If provided, the package will call this instead of (or in addition
@@ -242,10 +257,11 @@ interface SettingsWorkspaceAdapter {
 /**
  * An organization membership role.
  *
- * `guest` is an outsider who accepted an invite to a single workspace inside
- * the organization. They hold a membership row — so they show up in these
- * responses — but inherit nothing from the org: no implicit access to its
- * shared workspaces, and every org-level write is refused by the backend.
+ * `guest` is an outsider who accepted an invite to a workspace inside the
+ * organization. They hold a membership row — so they show up in these
+ * responses — but inherit nothing from the org: they can't join its shared
+ * workspaces from the picker, can only ever be a workspace member, and every
+ * org-level write is refused by the backend.
  *
  * Gate write affordances on `=== "admin"`, never on `!== "member"`: a role this
  * union does not yet name must read as least-privileged, not as an editor.
@@ -267,7 +283,15 @@ interface SettingsOrganizationCurrent {
     imageUrl?: string;
     role?: SettingsOrganizationRole | string;
     /**
-     * Whether the viewer may invite into this organization.
+     * The email domain this organization is tied to (e.g. "acme.com"), when it
+     * has one. Organizations created for a team on a free email provider have
+     * none. Lets the workspace invite modal tell, from the address alone, that
+     * an invitee will be a guest — and so can only be invited as a member.
+     */
+    domain?: string | null;
+    /**
+     * Whether the viewer may add people to this organization through a
+     * workspace invite ("Colleague").
      *
      * Orthogonal to `role`, not implied by it: a guest row can carry it too, so
      * gate on `role !== "guest" && (role === "admin" || inviteAccess)`. The
@@ -279,7 +303,9 @@ interface SettingsOrganizationCurrent {
 interface OrganizationMember {
     _id: string;
     role: SettingsOrganizationRole;
-    inviteAccess: boolean;
+    /** @deprecated Only meant anything for organization-level invites, which
+     *  no longer exist. */
+    inviteAccess?: boolean;
     /** Populated user. Rows whose user document was deleted come back from the
      *  API with a null `user` — OrganizationContent drops those on fetch, so
      *  every render site can treat this as present. */
@@ -295,7 +321,10 @@ interface OrganizationMember {
         name?: string;
     };
 }
-/** A single row in the combined Organization invites table. */
+/**
+ * @deprecated Organization-level invites no longer exist; the package never
+ * reads this. Kept so host adapters that still name it keep compiling.
+ */
 interface OrganizationInvite {
     _id: string;
     kind: "email" | "domain";
@@ -331,10 +360,8 @@ interface OrganizationJoinRequest {
     };
     createdAt?: string;
 }
-/** Result of checking whether the current user's email domain already has
- *  an org claiming it via a domain invite — drives the "an organization
- *  already exists for your company" prompt in the create-organization
- *  empty state, so people don't fragment a company across duplicate orgs. */
+/** @deprecated Joining by domain now happens at sign-in; the package never
+ *  reads this. */
 interface OrganizationDomainMatch {
     organizationId: string;
     organizationName: string;
@@ -350,7 +377,9 @@ interface SettingsOrganizationAdapter {
     managementUrl?: string;
     current: SettingsOrganizationCurrent | null;
     list: () => Promise<SettingsOrganizationListItem[]>;
-    create: (input: {
+    /** @deprecated Organizations are created at sign-in from the email domain,
+     *  or from the company name given in onboarding. Never called. */
+    create?: (input: {
         name: string;
         imageFile?: File | null;
     }) => Promise<{
@@ -364,59 +393,55 @@ interface SettingsOrganizationAdapter {
     switch: (id: string) => Promise<void>;
     delete: (id: string) => Promise<void>;
     fetchMembers: () => Promise<OrganizationMember[]>;
-    /** Merged email + domain invites, tagged by `kind`. Drives a single
-     *  combined pending-invites table (not two separate lists). */
-    fetchInvites: () => Promise<OrganizationInvite[]>;
-    inviteMemberByEmail: (input: {
+    /** @deprecated Never called. */
+    fetchInvites?: () => Promise<OrganizationInvite[]>;
+    /** @deprecated Never called. */
+    inviteMemberByEmail?: (input: {
         email: string;
         role: "admin" | "member";
         inviteAccess: boolean;
     }) => Promise<void>;
-    inviteDomain: (input: {
+    /** @deprecated Never called. */
+    inviteDomain?: (input: {
         domain: string;
         autoJoinRole: "admin" | "member";
     }) => Promise<void>;
-    /** Revoke a domain invite. Only stops *future* auto-joins — does not
-     *  remove members who already joined via that domain. */
-    revokeDomainInvite: (id: string) => Promise<void>;
-    cancelInvite: (token: string) => Promise<void>;
-    resendInvite: (invitationId: string) => Promise<void>;
+    /** @deprecated Never called. */
+    revokeDomainInvite?: (id: string) => Promise<void>;
+    /** @deprecated Never called. */
+    cancelInvite?: (token: string) => Promise<void>;
+    /** @deprecated Never called. */
+    resendInvite?: (invitationId: string) => Promise<void>;
+    /** Removes the users from the organization — and, on the backend, from
+     *  every workspace in it. */
     removeMember: (input: {
         userIds?: string[];
+        /** @deprecated Organization invites no longer exist. */
         invitationIds?: string[];
     }) => Promise<void>;
     updateMemberRole: (input: {
         userId: string;
         role: "admin" | "member";
+        /** @deprecated Organization invites no longer exist. */
         inviteAccess?: boolean;
     }) => Promise<void>;
     /** Optional: gates write affordances inside the Organization tab. Can report
      *  "guest", so callers must gate on `=== "admin"` rather than `!== "member"`. */
     getHighestRole?: () => Promise<{
         role: SettingsOrganizationRole;
-        /**
-         * The viewer's own email domain, and whether it can be claimed at all.
-         *
-         * A self-serve domain claim can only ever be the claimer's OWN domain —
-         * there is no DNS verification, so the backend refuses any other — which
-         * makes one boolean about one known domain the entire answer. Server
-         * computed on purpose: the disposable-domain lists it consults are
-         * provisioned at runtime, so no bundled list could agree with it.
-         */
+        /** @deprecated Domain claims no longer exist; never read. */
         emailDomain?: string | null;
+        /** @deprecated Domain claims no longer exist; never read. */
         canClaimEmailDomain?: boolean;
     }>;
     fetchWorkspaces: () => Promise<OrganizationWorkspaceItem[]>;
     fetchJoinRequests: () => Promise<OrganizationJoinRequest[]>;
     approveJoinRequest: (requestId: string) => Promise<void>;
     rejectJoinRequest: (requestId: string) => Promise<void>;
-    /** Checks whether the current user's email domain already has an org
-     *  claiming it. Called when `current` is null, before showing the
-     *  "create organization" empty state. */
-    checkDomainMatch: () => Promise<OrganizationDomainMatch | null>;
-    /** Self-service join for the domain-match prompt — domain invites are
-     *  auto-join by design, so this doesn't need admin approval. */
-    joinByDomain: () => Promise<void>;
+    /** @deprecated Joining by domain now happens at sign-in. Never called. */
+    checkDomainMatch?: () => Promise<OrganizationDomainMatch | null>;
+    /** @deprecated Joining by domain now happens at sign-in. Never called. */
+    joinByDomain?: () => Promise<void>;
 }
 type TokenExpiry = "30d" | "60d" | "90d" | "1y" | "never";
 interface ApiToken {
@@ -913,13 +938,18 @@ declare function ProfileTab(): react.JSX.Element;
  * workspace you are not currently inside — the current one has its own
  * General page.
  */
-declare function WorkspaceListTab({ workspaces, loading, onCreateClick: _onCreateClick, onEditClick, onSwitchClick, onLeaveClick, }: {
+/** Workspaces shown per page in My workspaces. */
+declare const WORKSPACE_LIST_PAGE_SIZE = 10;
+declare function WorkspaceListTab({ workspaces, loading, onCreateClick: _onCreateClick, onEditClick, onSwitchClick, onLeaveClick, fetchPlans, pageSize, }: {
     workspaces: WorkspaceInfo[];
     loading: boolean;
     onCreateClick: () => void;
     onEditClick: (ws: WorkspaceInfo) => void;
     onSwitchClick: (ws: WorkspaceInfo) => void;
     onLeaveClick: (ws: WorkspaceInfo) => void;
+    /** See SettingsWorkspaceAdapter.fetchPlans. */
+    fetchPlans?: (workspaceIds: string[]) => Promise<Record<string, string>>;
+    pageSize?: number;
 }): react.JSX.Element;
 /**
  * @deprecated Renamed to `WorkspaceListTab` in 0.4.0 — the tab is a workspace
@@ -1040,21 +1070,17 @@ declare function TeamsContent({ embedded, onInviteOpen, onInviteOpenChange, work
 }): react.JSX.Element;
 
 /**
- * Which slice of the organization to show. The tab used to stack all three on
- * one scrolling page, so the members table, the workspace list and the join
- * requests competed for the same screen and the sections below the table were
- * easy to miss entirely.
+ * Which slice of the organization to show: its people, or its workspaces
+ * together with the workspaces asking to join it.
  *
- * `people` and `domains` split invites by kind on purpose: an email invite is
- * a person you are expecting, a domain invite is a standing rule. They were
- * interleaved in one "Pending" list, where a row could be either.
+ * `domains` is kept as an alias of `workspaces` for hosts and links that still
+ * use it. The Domains tab it named is gone: an organization is tied to one
+ * email domain from the moment it is created, and nobody claims one by hand.
  */
 type OrganizationView = "people" | "workspaces" | "domains";
-declare function OrganizationContent({ embedded, view, onInviteOpen, onInviteOpenChange, }?: {
+declare function OrganizationContent({ embedded, view, }?: {
     embedded?: boolean;
     view?: OrganizationView;
-    onInviteOpen?: boolean;
-    onInviteOpenChange?: (open: boolean) => void;
 }): react.JSX.Element;
 
 declare function TokensContent({ embedded, showRevokedOverride, onShowRevokedChange: _onShowRevokedChange, createOpenOverride, onCreateOpenChange, }?: {
@@ -1141,7 +1167,9 @@ interface MemberListToolbarProps {
     activeLabel: string;
     /** Row counts, appended to each tab label. Pass `null` while still loading. */
     activeCount: number | null;
-    pendingCount: number | null;
+    /** Omit (or pass `undefined`) for a list with no pending invites — the
+     *  organization's — and the tab pair collapses to a single label. */
+    pendingCount?: number | null;
     searchQuery: string;
     onSearchChange: (value: string) => void;
     /** Optional trailing control, e.g. an Invite button on the page itself. */
@@ -1211,63 +1239,48 @@ interface OrganizationModalProps {
 }
 declare function OrganizationModal({ open, mode, organization, onClose, onCreate, onUpdate, onDelete, }: OrganizationModalProps): react.JSX.Element | null;
 
-type ModalMode$1 = "invite" | "update";
-interface OrganizationInviteModalProps {
+interface WorkspacePickerItem {
+    _id: string;
+    name: string;
+    imageUrl?: string;
+    /** Who created it, shown under the name. */
+    ownerName?: string;
+}
+interface WorkspacePickerProps {
+    organizationName?: string;
+    workspaces: WorkspacePickerItem[];
+    /** While the list is still loading. */
+    loading?: boolean;
+    /** Join the ticked workspaces as a member. Throw to keep the picker open. */
+    onJoin: (workspaceIds: string[]) => Promise<void>;
+    /** Create a workspace (the user becomes its admin). Throw to keep it open. */
+    onCreate: (name: string) => Promise<void>;
+}
+declare function WorkspacePicker({ organizationName, workspaces, loading, onJoin, onCreate, }: WorkspacePickerProps): react.JSX.Element;
+
+interface OrganizationMemberModalProps {
     open: boolean;
-    mode: ModalMode$1;
-    /** Update mode: the target member's email (read-only display). */
+    /** The target member's email (read-only display). */
     userEmail?: string;
     /** admin/member only — the toggle below cannot express any other role, so
      *  pass `lockRole` for a target whose role is outside that pair. */
     initialRole?: "admin" | "member";
     /**
      * Show the target's role read-only and disable Save, leaving Remove as the
-     * only action.
-     *
-     * For an organization guest: the toggle offers Admin and Member and nothing
-     * else, so opening it on a guest preselected "Member" and quietly promoted
-     * them the moment Save was pressed — even by an admin who came only to flip
-     * `inviteAccess`, which is itself the thing a guest must never hold. Removing
-     * a guest happens through this same modal, so refusing to open it was not an
-     * option.
+     * only action. For an organization guest: the toggle offers Admin and Member
+     * and nothing else, and a guest can't be made either.
      */
     lockRole?: boolean;
-    /**
-     * Whether the viewer's own email domain can be claimed at all. Defaults to
-     * true, preserving today's behaviour for any host that does not pass it.
-     *
-     * A domain claim can only ever be the claimer's OWN domain — there is no DNS
-     * verification, so the backend refuses any other — and a public provider
-     * like gmail.com can never be claimed by anybody. Offering the tab in that
-     * case advertises the one mechanism that would solve bulk onboarding and
-     * then fails after submit, which is worse than not offering it.
-     */
-    canClaimDomain?: boolean;
-    /** The viewer's own email domain: the only one they could ever claim. */
-    claimableDomain?: string | null;
     /** Label for the read-only role shown when `lockRole` is set. */
     lockedRoleLabel?: string;
-    initialInviteAccess?: boolean;
-    /** Lets a pending-invite row reopen this modal to resend without edits. */
-    allowSubmitWithoutChanges?: boolean;
     canRemove?: boolean;
     onClose: () => void;
-    onInviteEmail?: (input: {
-        email: string;
-        role: "admin" | "member";
-        inviteAccess: boolean;
-    }) => void;
-    onInviteDomain?: (input: {
-        domain: string;
-        autoJoinRole: "admin" | "member";
-    }) => void;
     onUpdate?: (input: {
         role: "admin" | "member";
-        inviteAccess: boolean;
     }) => void;
     onRemove?: () => void;
 }
-declare function OrganizationInviteModal({ open, mode, userEmail, initialRole, lockRole, canClaimDomain, claimableDomain, lockedRoleLabel, initialInviteAccess, allowSubmitWithoutChanges, canRemove, onClose, onInviteEmail, onInviteDomain, onUpdate, onRemove, }: OrganizationInviteModalProps): react.JSX.Element | null;
+declare function OrganizationMemberModal({ open, userEmail, initialRole, lockRole, lockedRoleLabel, canRemove, onClose, onUpdate, onRemove, }: OrganizationMemberModalProps): react.JSX.Element | null;
 
 interface ConfirmLeaveModalProps {
     open: boolean;
@@ -1304,8 +1317,8 @@ interface StoreOption {
 }
 /**
  * Standing in the workspace's parent organization, as distinct from `role`,
- * which is the role inside the workspace itself. The two are independent: an
- * external collaborator is routinely a workspace admin and an org guest.
+ * which is the role inside the workspace itself. A colleague can hold either
+ * workspace role; a guest can only ever be a workspace member.
  */
 type OrganizationStanding = "colleague" | "guest";
 interface InviteUpdateModalProps {
@@ -1372,10 +1385,16 @@ interface InviteUpdateModalProps {
     allowGuestStanding?: boolean;
     /** Defaults to "guest" — the least-privileged of the two. */
     initialOrganizationStanding?: OrganizationStanding;
+    /**
+     * The email domain of the workspace's organization, when it has one. An
+     * invitee outside it joins as a guest (unless invited as a Colleague), and
+     * a guest can only be a workspace member — so Admin is locked off for them.
+     */
+    organizationDomain?: string | null;
     /** Called only in invite mode; receives (permissions, email, standing) */
     onInvite?: (permissions: UserPermissions, email: string, organizationStanding?: OrganizationStanding) => void;
 }
-declare function InviteUpdateModal({ open, mode, userEmail, stores, hiddenApps, allowSubmitWithoutChanges, initialPermissions, onClose, onSave, onRemove, canRemove, showOrganizationStanding, organizationName, allowGuestStanding, initialOrganizationStanding, onInvite, }: InviteUpdateModalProps): react.JSX.Element | null;
+declare function InviteUpdateModal({ open, mode, userEmail, stores, hiddenApps, allowSubmitWithoutChanges, initialPermissions, onClose, onSave, onRemove, canRemove, showOrganizationStanding, organizationName, allowGuestStanding, initialOrganizationStanding, organizationDomain, onInvite, }: InviteUpdateModalProps): react.JSX.Element | null;
 
 interface ExportDateModalProps {
     title: string;
@@ -1395,4 +1414,4 @@ declare function SettingsAdaptersProvider({ adapters, children, }: {
  */
 declare function useSettingsAdapters(): SettingsAdapters;
 
-export { APP_KEYS, type ApiToken, type AppKey, type AvailableCreditsResponse, BillingContent, type BillingEventPayload, type BillingProduct, type BillingSubscription, BuyCreditsModal, type BuyCreditsPayload, type BuyCreditsResponse, ConfirmDeleteModal, ConfirmLeaveModal, type CreatedToken, type CustomCreditInfo, type CustomCreditResponse, DEFAULT_PERMISSIONS, DEFAULT_USER_LANGUAGE, ExportDateModal, InviteUpdateModal, type InvoicePdfResponse, MemberListFrame, type MemberListFrameProps, type MemberListTab, MemberListToolbar, type MemberListToolbarProps, type MemberPermissionsPayload, OrganizationContent, type OrganizationData, type OrganizationInvite, OrganizationInviteModal, type OrganizationInviteModalProps, type OrganizationJoinRequest, type OrganizationMember, OrganizationModal, type OrganizationView, type OrganizationWorkspaceItem, type Price, type PriceMetadata, type ProductsResponse, ProfileAvatar, ProfileTab, ReferralTab, SCOPE_LABELS, ScopeHeader, type ScopeHeaderProps, type ServiceItem, type SettingsAdapters, SettingsAdaptersProvider, type SettingsApiAdapter, type SettingsAuthAdapter, type SettingsAuthUser, SettingsContent, type SettingsContentProps, type SettingsImageUploadAdapter, type SettingsNavigationAdapter, type SettingsOrganizationAdapter, type SettingsOrganizationCurrent, type SettingsOrganizationListItem, type SettingsScope, type SettingsTab, type SettingsToastAdapter, SettingsTooltip, type SettingsTooltipPlacement, type SettingsTooltipProps, type SettingsWorkspaceAdapter, type SettingsWorkspaceCurrent, type SettingsWorkspaceListItem, SiconKey, type StoreItem, type SubscriptionPlan, type SubscriptionResponse, TAB_DESCRIPTIONS, TAB_LABELS, TAB_SCOPE, TAB_TO_URL, type TeamMember, TeamsContent, type TokenExpiry, TokensContent, URL_TO_TAB, USER_LANGUAGES, type UpdateSubscriptionPayload, type UpdateSubscriptionResponse, type UsageHistoryItem, type UsageHistoryResponse, type UserLanguage, type UserPermissions, type WorkspaceData, WorkspaceGeneralTab, type WorkspaceGeneralTabProps, type WorkspaceInvite, WorkspaceListTab, type WorkspaceMember, WorkspaceModal, type WorkspaceOrganization, type WorkspaceOrganizationRequest, WorkspaceTab, type WorkspaceUsageResponse, countLabel, loadWorkspaceOrganization, resolveSettingsTabFromPath, useSettingsAdapters, useWorkspaceOrganization, userLanguageLabel };
+export { APP_KEYS, type ApiToken, type AppKey, type AvailableCreditsResponse, BillingContent, type BillingEventPayload, type BillingProduct, type BillingSubscription, BuyCreditsModal, type BuyCreditsPayload, type BuyCreditsResponse, ConfirmDeleteModal, ConfirmLeaveModal, type CreatedToken, type CustomCreditInfo, type CustomCreditResponse, DEFAULT_PERMISSIONS, DEFAULT_USER_LANGUAGE, ExportDateModal, InviteUpdateModal, type InvoicePdfResponse, MemberListFrame, type MemberListFrameProps, type MemberListTab, MemberListToolbar, type MemberListToolbarProps, type MemberPermissionsPayload, OrganizationContent, type OrganizationData, type OrganizationInvite, type OrganizationJoinRequest, type OrganizationMember, OrganizationMemberModal, type OrganizationMemberModalProps, OrganizationModal, type OrganizationView, type OrganizationWorkspaceItem, type Price, type PriceMetadata, type ProductsResponse, ProfileAvatar, ProfileTab, ReferralTab, SCOPE_LABELS, ScopeHeader, type ScopeHeaderProps, type ServiceItem, type SettingsAdapters, SettingsAdaptersProvider, type SettingsApiAdapter, type SettingsAuthAdapter, type SettingsAuthUser, SettingsContent, type SettingsContentProps, type SettingsImageUploadAdapter, type SettingsNavigationAdapter, type SettingsOrganizationAdapter, type SettingsOrganizationCurrent, type SettingsOrganizationListItem, type SettingsScope, type SettingsTab, type SettingsToastAdapter, SettingsTooltip, type SettingsTooltipPlacement, type SettingsTooltipProps, type SettingsWorkspaceAdapter, type SettingsWorkspaceCurrent, type SettingsWorkspaceListItem, SiconKey, type StoreItem, type SubscriptionPlan, type SubscriptionResponse, TAB_DESCRIPTIONS, TAB_LABELS, TAB_SCOPE, TAB_TO_URL, type TeamMember, TeamsContent, type TokenExpiry, TokensContent, URL_TO_TAB, USER_LANGUAGES, type UpdateSubscriptionPayload, type UpdateSubscriptionResponse, type UsageHistoryItem, type UsageHistoryResponse, type UserLanguage, type UserPermissions, WORKSPACE_LIST_PAGE_SIZE, type WorkspaceData, WorkspaceGeneralTab, type WorkspaceGeneralTabProps, type WorkspaceInvite, WorkspaceListTab, type WorkspaceMember, WorkspaceModal, type WorkspaceOrganization, type WorkspaceOrganizationRequest, WorkspacePicker, type WorkspacePickerItem, type WorkspacePickerProps, WorkspaceTab, type WorkspaceUsageResponse, countLabel, loadWorkspaceOrganization, resolveSettingsTabFromPath, useSettingsAdapters, useWorkspaceOrganization, userLanguageLabel };