@streamoid/settings 0.8.0 → 0.9.0

package/dist/index.d.ts

@@ -44,6 +44,9 @@ type SettingsTab = "profile"
  | "workspaceMembers"
 /** Account › My workspaces — the memberships and switch/create list. */
  | "workspaceList"
+/** Organization › My organizations — every org the viewer belongs to:
+ *  open one, manage the ones they admin, create another. */
+ | "organizationList"
 /** Organization › People. */
  | "organization"
 /** Organization › Workspaces. */
@@ -207,6 +210,11 @@ interface SettingsWorkspaceAdapter {
     create: (input: {
         name: string;
         imageFile?: File | null;
+        /** The organization to create it in (the viewer must be its admin). */
+        organizationId?: string;
+        /** "shared": org members can join it from the workspace picker;
+         *  "private": invite-only. */
+        orgVisibility?: "private" | "shared";
         imageUrl?: string | null;
     }) => Promise<{
         id: string;
@@ -300,10 +308,36 @@ interface SettingsOrganizationListItem {
     name: string;
     imageUrl?: string;
     role?: SettingsOrganizationRole;
+    /** The organization the viewer is in right now. */
+    isCurrent?: boolean;
+    /** Its email domain; absent for an organization with none. */
+    domain?: string | null;
+    type?: SettingsOrganizationType;
+}
+/** "shared": offered to new users from the company domain at signup.
+ *  "private": invite-only. */
+type SettingsOrganizationType = "shared" | "private";
+/** Whether the viewer may create an organization, and on which domains
+ *  (GET /organization/create-options). */
+interface SettingsOrganizationCreateOptions {
+    canCreate: boolean;
+    /** The Streamoid team: any domain. */
+    anyDomain: boolean;
+    /** The viewer's company; null for a public email address, whose
+     *  organizations have no domain. */
+    rootDomain: string | null;
+    /** Prefill for the domain field. */
+    defaultDomain: string | null;
 }
 interface SettingsOrganizationCurrent {
     id: string;
     name?: string;
+    /** Absent on organizations created before types existed: treat as shared. */
+    type?: SettingsOrganizationType;
+    /** The company the organization belongs to ("abfrl.com" for an org on
+     *  ownd.abfrl.com). Members from the same company join as members; anyone
+     *  else is a guest. Absent for organizations with no domain. */
+    rootDomain?: string | null;
     imageUrl?: string;
     role?: SettingsOrganizationRole | string;
     /**
@@ -416,18 +450,32 @@ interface SettingsOrganizationAdapter {
     managementUrl?: string;
     current: SettingsOrganizationCurrent | null;
     list: () => Promise<SettingsOrganizationListItem[]>;
-    /** @deprecated Organizations are created at sign-in from the email domain,
-     *  or from the company name given in onboarding. Never called. */
+    /** Optional: create an organization (POST /organization). The caller
+     *  becomes its admin, and it comes with a default shared workspace. The
+     *  backend decides which domains the caller may use. */
     create?: (input: {
         name: string;
         imageFile?: File | null;
+        /** Defaults to the caller's own email domain. */
+        domain?: string;
+        type?: SettingsOrganizationType;
     }) => Promise<{
         id: string;
     } | void>;
+    /** Optional: who sees "Create organization" in Organization settings —
+     *  company admins, public email users and the Streamoid team. Without it, or
+     *  without `create`, the button never shows. */
+    getCreateOptions?: () => Promise<SettingsOrganizationCreateOptions>;
     update: (id: string, patch: {
         name?: string;
         imageFile?: File | null;
         imageUrl?: string | null;
+        /** Shared orgs are offered to new users from the company at signup;
+         *  private ones are invite-only. Any org admin may change it. */
+        type?: SettingsOrganizationType;
+        /** Only an admin whose own email is on the org's company may change it,
+         *  and only to a domain of the same company. */
+        domain?: string;
     }) => Promise<void>;
     switch: (id: string) => Promise<void>;
     delete: (id: string) => Promise<void>;
@@ -460,7 +508,8 @@ interface SettingsOrganizationAdapter {
     }) => Promise<void>;
     updateMemberRole: (input: {
         userId: string;
-        role: "admin" | "member";
+        /** Any direction, guest included. */
+        role: "admin" | "member" | "guest";
         /** @deprecated Organization invites no longer exist. */
         inviteAccess?: boolean;
     }) => Promise<void>;
@@ -876,7 +925,11 @@ interface SettingsApiAdapter {
         invitationId?: string;
     }) => Promise<void>;
     resendInvite: (invitationId: string) => Promise<void>;
-    /** CXO-only: promote one or more members to admin in a single call. */
+    /**
+     * @deprecated No longer called: `updateMemberRole` makes a member an admin by
+     * itself, and promoting first made that request fail. Kept so existing
+     * adapters still type-check.
+     */
     promoteAsAdmin?: (userIds: string[]) => Promise<void>;
     /** CXO-only: fetch granular per-user details (services, scopes, etc.). */
     getUserDetail?: (userId: string) => Promise<WorkspaceMember | null>;
@@ -1199,7 +1252,9 @@ interface WorkspaceModalProps {
     mode: "create" | "update";
     workspace?: WorkspaceData | null;
     onClose: () => void;
-    onCreate?: (name: string, imageFile: File | null) => void | boolean | Promise<void | boolean>;
+    onCreate?: (name: string, imageFile: File | null, details?: {
+        orgVisibility: "private" | "shared";
+    }) => void | boolean | Promise<void | boolean>;
     onUpdate?: (name: string, imageFile: File | null, imageRemoved: boolean) => void | boolean | Promise<void | boolean>;
     onLeave?: () => void | boolean | Promise<void | boolean>;
     onDelete?: () => void | boolean | Promise<void | boolean>;
@@ -1241,10 +1296,31 @@ declare function BillingContent({ embedded, showPlans: showPlansProp, onShowPlan
     onShowPerUserLimitsChange?: (open: boolean) => void;
 }): react__default.JSX.Element;
 
-declare function TeamsContent({ embedded, onInviteOpen, onInviteOpenChange, workspaceName, workspaceImageUrl, organizationName, hiddenApps, }?: {
+/**
+ * The one `updateMemberRole` request that saving a member sends, or `null`
+ * when there is nothing to save.
+ *
+ * `change-user-role` makes a member an admin by itself (role, flags, and
+ * dropping their app and store grants), so nothing is sent before it. Calling
+ * `promoteAsAdmin` first made the user admin and then had this request refused
+ * with 403 "Already present as admin.".
+ *
+ * An admin kept as admin has no other field to change (the modal hides the
+ * permissions for an admin), so that save sends nothing.
+ */
+declare function memberRoleUpdate(current: {
+    userId: string;
+    role: UserPermissions["role"];
+}, permissions: UserPermissions, services: ServiceItem[]): ({
+    userId: string;
+} & MemberPermissionsPayload) | null;
+declare function TeamsContent({ embedded, onInviteOpen, onInviteOpenChange, onCanInviteChange, workspaceName, workspaceImageUrl, organizationName, hiddenApps, }?: {
     embedded?: boolean;
     onInviteOpen?: boolean;
     onInviteOpenChange?: (open: boolean) => void;
+    /** Told whether the viewer may invite here, so a host-drawn Invite button
+     *  can follow the same rule as this screen's own. */
+    onCanInviteChange?: (canInvite: boolean) => void;
     /**
      * The workspace these members belong to. Supplied by the settings shell so
      * the page can name its own subject — without it this screen was a list of
@@ -1451,17 +1527,37 @@ interface OrganizationData {
     isCurrent: boolean;
     imageUrl?: string;
     imageName?: string;
+    /** "shared": offered to new users from the company at signup;
+     *  "private": invite-only. */
+    type?: "shared" | "private";
+    /** The organization's email domain; null when it has none. */
+    domain?: string | null;
+}
+/** Type and domain, passed to onCreate / onUpdate after the name and image. */
+interface OrganizationDetails {
+    type?: "shared" | "private";
+    /** Only set when it was changed (update) or filled in (create). */
+    domain?: string;
 }
 interface OrganizationModalProps {
     open: boolean;
     mode: "create" | "update";
     organization?: OrganizationData | null;
+    /** Create mode: whether the new organization can have a domain at all
+     *  (false for a public email user's org). Defaults to true. */
+    allowDomain?: boolean;
+    /** Create mode: the domain field's prefill. */
+    defaultDomain?: string | null;
+    /** Update mode: trust `organization.role` for the delete button instead of
+     *  asking `getHighestRole`, which answers for the *current* organization —
+     *  wrong when managing another one from My organizations. */
+    trustRole?: boolean;
     onClose: () => void;
-    onCreate?: (name: string, imageFile: File | null) => void | boolean | Promise<void | boolean>;
-    onUpdate?: (name: string, imageFile: File | null, imageRemoved: boolean) => void | boolean | Promise<void | boolean>;
+    onCreate?: (name: string, imageFile: File | null, details: OrganizationDetails) => void | boolean | Promise<void | boolean>;
+    onUpdate?: (name: string, imageFile: File | null, imageRemoved: boolean, details: OrganizationDetails) => void | boolean | Promise<void | boolean>;
     onDelete?: () => void | boolean | Promise<void | boolean>;
 }
-declare function OrganizationModal({ open, mode, organization, onClose, onCreate, onUpdate, onDelete, }: OrganizationModalProps): react.JSX.Element | null;
+declare function OrganizationModal({ open, mode, organization, allowDomain, defaultDomain, trustRole, onClose, onCreate, onUpdate, onDelete, }: OrganizationModalProps): react.JSX.Element | null;
 
 interface WorkspacePickerItem {
     _id: string;
@@ -1470,41 +1566,87 @@ interface WorkspacePickerItem {
     /** Who created it, shown under the name. */
     ownerName?: string;
 }
+/** One organization's section of a multi-organization picker. */
+interface WorkspacePickerGroup {
+    organizationId: string;
+    organizationName: string;
+    imageUrl?: string;
+    workspaces: WorkspacePickerItem[];
+    /** The viewer may create workspaces in it (an org admin). */
+    canCreate?: boolean;
+}
 interface WorkspacePickerProps {
     organizationName?: string;
-    workspaces: WorkspacePickerItem[];
+    workspaces?: WorkspacePickerItem[];
+    /** Several organizations at once, one collapsible section each. Takes the
+     *  place of `organizationName` / `workspaces`. */
+    groups?: WorkspacePickerGroup[];
     /** 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>;
+    /** Create a workspace (the user becomes its admin), shared (org members
+     *  can join it) or private (invite-only), in `organizationId` when the
+     *  picker lists groups. Throw to keep it open.
+     *  Omit it for anyone who may not create workspaces in the organization
+     *  (only org admins may); the picker then offers joining only. */
+    onCreate?: (name: string, visibility: "private" | "shared", organizationId?: string) => Promise<void>;
+}
+declare function WorkspacePicker({ organizationName, workspaces, groups, loading, onJoin, onCreate, }: WorkspacePickerProps): react.JSX.Element;
+
+interface OrganizationPickerItem {
+    _id: string;
+    name: string;
+    domain?: string;
+    imageUrl?: string;
 }
-declare function WorkspacePicker({ organizationName, workspaces, loading, onJoin, onCreate, }: WorkspacePickerProps): react.JSX.Element;
+type OrganizationPickerType = "shared" | "private";
+interface OrganizationPickerProps {
+    /** The company's shared organizations, exact-domain ones first. */
+    organizations: OrganizationPickerItem[];
+    /** The user's company ("abfrl.com"); absent for a public email domain. */
+    companyDomain?: string | null;
+    /** Signed in with a public email address (gmail.com and the like). */
+    publicDomain?: boolean;
+    /** Prefill for the new organization's name. */
+    suggestedName?: string;
+    loading?: boolean;
+    /** Join the ticked organizations as a member. Throw to keep the picker open. */
+    onJoin: (organizationIds: string[]) => Promise<void>;
+    /** Create an organization (the user becomes its admin). Throw to keep it open. */
+    onCreate: (input: {
+        name: string;
+        type: OrganizationPickerType;
+    }) => Promise<void>;
+}
+declare function OrganizationPicker({ organizations, companyDomain, publicDomain, suggestedName, loading, onJoin, onCreate, }: OrganizationPickerProps): react.JSX.Element;
 
+type OrganizationMemberRole = "admin" | "member" | "guest";
 interface OrganizationMemberModalProps {
     open: boolean;
     /** 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";
+    initialRole?: OrganizationMemberRole;
     /**
-     * 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, and a guest can't be made either.
+     * The target's email is not on the organization's company domain. Making
+     * them an org admin then asks for confirmation first.
      */
+    outsideDomain?: boolean;
+    /** The organization's company domain, named in that confirmation. */
+    organizationDomain?: string | null;
+    /** Show the target's role read-only and disable Save, leaving Remove as the
+     *  only action. */
     lockRole?: boolean;
     /** Label for the read-only role shown when `lockRole` is set. */
     lockedRoleLabel?: string;
     canRemove?: boolean;
     onClose: () => void;
     onUpdate?: (input: {
-        role: "admin" | "member";
+        role: OrganizationMemberRole;
     }) => void;
     onRemove?: () => void;
 }
-declare function OrganizationMemberModal({ open, userEmail, initialRole, lockRole, lockedRoleLabel, canRemove, onClose, onUpdate, onRemove, }: OrganizationMemberModalProps): react.JSX.Element | null;
+declare function OrganizationMemberModal({ open, userEmail, initialRole, outsideDomain, organizationDomain, lockRole, lockedRoleLabel, canRemove, onClose, onUpdate, onRemove, }: OrganizationMemberModalProps): react.JSX.Element | null;
 
 interface ConfirmLeaveModalProps {
     open: boolean;
@@ -1541,8 +1683,8 @@ interface StoreOption {
 }
 /**
  * Standing in the workspace's parent organization, as distinct from `role`,
- * which is the role inside the workspace itself. A colleague can hold either
- * workspace role; a guest can only ever be a workspace member.
+ * which is the role inside the workspace itself. Either can hold either
+ * workspace role.
  */
 type OrganizationStanding = "colleague" | "guest";
 interface InviteUpdateModalProps {
@@ -1610,15 +1752,20 @@ interface InviteUpdateModalProps {
     /** 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.
+     * @deprecated No longer read. A guest may be invited as a workspace admin,
+     * so the organization's domain no longer locks Admin off.
      */
     organizationDomain?: string | null;
+    /**
+     * Invite mode: whether the inviter may invite an admin. Only workspace
+     * admins (org admins included) can; a member with invite access invites
+     * members only. Defaults to true.
+     */
+    allowAdminRole?: boolean;
     /** 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, organizationDomain, 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: _organizationDomain, allowAdminRole, onInvite, }: InviteUpdateModalProps): react.JSX.Element | null;
 
 interface ExportDateModalProps {
     title: string;
@@ -1757,4 +1904,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 ConnectedApp, ConnectedAppsContent, type CreatedToken, type CreditCycleUnit, type CreditLimitValidation, type CustomCreditInfo, type CustomCreditResponse, DEFAULT_PERMISSIONS, DEFAULT_USER_LANGUAGE, ExportDateModal, InviteUpdateModal, type InvoicePdfResponse, type MemberCreditLimit, MemberCreditLimitModal, type MemberCreditLimitRow, type MemberCreditLimitSource, type MemberCreditLimitsResponse, MemberListFrame, type MemberListFrameProps, type MemberListTab, MemberListToolbar, type MemberListToolbarProps, type MemberPermissionsPayload, OrganizationContent, type OrganizationData, OrganizationIntegrationsContent, type OrganizationInvite, type OrganizationJoinRequest, type OrganizationJoinableWorkspace, type OrganizationMember, OrganizationMemberModal, type OrganizationMemberModalProps, OrganizationModal, type OrganizationView, type OrganizationWorkspaceItem, PerUserLimitsView, 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 SettingsIntegrationsAdapter, 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, type WorkspaceListOrganization, WorkspaceListTab, type WorkspaceMember, WorkspaceModal, type WorkspaceOrganization, type WorkspaceOrganizationRequest, WorkspacePicker, type WorkspacePickerItem, type WorkspacePickerProps, WorkspaceTab, type WorkspaceUsageResponse, belowUsageReason, cleanCreditLimitInput, countLabel, creditCycleUnit, describeDefaultLimit, describeMemberLimit, formatCreditLimit, formatCredits, groupWorkspaceList, isLimitBelowUsage, joinMembersWithLimits, lastUsedLabel, limitBelowUsageUsed, limitSourceLabel, loadWorkspaceOrganization, minimumCreditLimit, resolveSettingsTabFromPath, roundCredits, useSettingsAdapters, useWorkspaceOrganization, userLanguageLabel, validateCreditLimitInput, validateDefaultCreditLimitInput };
+export { APP_KEYS, type ApiToken, type AppKey, type AvailableCreditsResponse, BillingContent, type BillingEventPayload, type BillingProduct, type BillingSubscription, BuyCreditsModal, type BuyCreditsPayload, type BuyCreditsResponse, ConfirmDeleteModal, ConfirmLeaveModal, type ConnectedApp, ConnectedAppsContent, type CreatedToken, type CreditCycleUnit, type CreditLimitValidation, type CustomCreditInfo, type CustomCreditResponse, DEFAULT_PERMISSIONS, DEFAULT_USER_LANGUAGE, ExportDateModal, InviteUpdateModal, type InvoicePdfResponse, type MemberCreditLimit, MemberCreditLimitModal, type MemberCreditLimitRow, type MemberCreditLimitSource, type MemberCreditLimitsResponse, MemberListFrame, type MemberListFrameProps, type MemberListTab, MemberListToolbar, type MemberListToolbarProps, type MemberPermissionsPayload, OrganizationContent, type OrganizationData, type OrganizationDetails, OrganizationIntegrationsContent, type OrganizationInvite, type OrganizationJoinRequest, type OrganizationJoinableWorkspace, type OrganizationMember, OrganizationMemberModal, type OrganizationMemberModalProps, type OrganizationMemberRole, OrganizationModal, OrganizationPicker, type OrganizationPickerItem, type OrganizationPickerProps, type OrganizationPickerType, type OrganizationView, type OrganizationWorkspaceItem, PerUserLimitsView, 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 SettingsIntegrationsAdapter, type SettingsNavigationAdapter, type SettingsOrganizationAdapter, type SettingsOrganizationCreateOptions, type SettingsOrganizationCurrent, type SettingsOrganizationListItem, type SettingsOrganizationType, 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, type WorkspaceListOrganization, WorkspaceListTab, type WorkspaceMember, WorkspaceModal, type WorkspaceOrganization, type WorkspaceOrganizationRequest, WorkspacePicker, type WorkspacePickerGroup, type WorkspacePickerItem, type WorkspacePickerProps, WorkspaceTab, type WorkspaceUsageResponse, belowUsageReason, cleanCreditLimitInput, countLabel, creditCycleUnit, describeDefaultLimit, describeMemberLimit, formatCreditLimit, formatCredits, groupWorkspaceList, isLimitBelowUsage, joinMembersWithLimits, lastUsedLabel, limitBelowUsageUsed, limitSourceLabel, loadWorkspaceOrganization, memberRoleUpdate, minimumCreditLimit, resolveSettingsTabFromPath, roundCredits, useSettingsAdapters, useWorkspaceOrganization, userLanguageLabel, validateCreditLimitInput, validateDefaultCreditLimitInput };