@replicated/portal-components 0.0.2 → 0.0.3

package/dist/actions/index.d.mts

@@ -4,6 +4,10 @@
  * specific actions, but it exports helpers so downstream portals can describe
  * their actions with consistent metadata.
  */
+/**
+ * Gets the base API origin from environment, with trailing slashes removed.
+ */
+declare const getApiOrigin: () => string;
 type PortalActionVisibility = "vendor" | "customer";
 interface PortalActionContext {
     vendorId: string;
@@ -19,13 +23,38 @@ interface PortalServerActionDefinition<Input, Output> {
     run: (input: Input, context?: PortalActionContext) => Promise<Output>;
 }
 declare const defineServerAction: <Input, Output>(definition: PortalServerActionDefinition<Input, Output>) => PortalServerActionDefinition<Input, Output>;
+interface CreateServiceAccountInput {
+    token: string;
+    name: string;
+}
+interface ServiceAccountData {
+    id: string;
+    customerId: string;
+    token: string;
+    accountName: string;
+    isRevoked: boolean;
+    createdAt: string;
+    emailAddress: string;
+}
+interface CreateServiceAccountResult {
+    service_account: ServiceAccountData;
+    token: string;
+}
+declare const createServiceAccount: PortalServerActionDefinition<CreateServiceAccountInput, CreateServiceAccountResult>;
 interface InitiateLoginInput {
     email: string;
 }
 interface InitiateLoginResult {
-    status: "ok";
+    status: "ok" | "saml_redirect";
     requestedAt: string;
     message: string;
+    /** If SAML redirect is required, this contains the info needed to redirect */
+    saml?: {
+        redirectRequired: true;
+        customerId: string;
+        email: string;
+        appSlug: string;
+    };
 }
 /**
  * Reference server action for initiating the passwordless login flow.
@@ -40,9 +69,543 @@ interface VerifyMagicLinkResult {
     raw: unknown;
 }
 interface VerifyMagicLinkError {
-    code: "invalid_code" | "unknown";
+    code: "invalid_code" | "expired" | "unknown";
     message: string;
+    isExpired?: boolean;
 }
 declare const verifyMagicLink: PortalServerActionDefinition<VerifyMagicLinkInput, VerifyMagicLinkResult>;
+interface CustomBrandingResponse {
+    brandingData: string;
+    documentation: unknown;
+}
+interface PortalLicenseField {
+    key: string;
+    label: string;
+    value: string | null;
+    isSecret?: boolean;
+}
+interface PortalLicenseDetails {
+    id?: string;
+    status?: string;
+    statusLabel?: string;
+    environment?: string;
+    expiresAt?: string | null;
+    releaseChannels?: string[];
+    installMethods?: string[];
+    installNotes?: string;
+    customerName?: string;
+    customerId?: string;
+    customerOrganization?: string;
+    fields: PortalLicenseField[];
+}
+interface ListSupportBundlesInput {
+    token: string;
+}
+interface SupportBundleInsight {
+    level: string;
+    primary: string;
+    key?: string;
+    detail?: string;
+}
+interface SupportBundleSummary {
+    id: string;
+    createdAt?: string;
+    status?: string;
+    size?: number;
+    instanceId?: string;
+    insights?: SupportBundleInsight[];
+    metadata?: Record<string, unknown>;
+}
+interface ListSupportBundlesResult {
+    bundles: SupportBundleSummary[];
+    totalCount: number;
+    raw: unknown;
+}
+interface DownloadSupportBundleInput {
+    token: string;
+    bundleId: string;
+}
+interface DownloadSupportBundleResult {
+    signedUrl: string;
+}
+interface DeleteSupportBundleInput {
+    token: string;
+    bundleId: string;
+}
+interface DeleteSupportBundleResult {
+    success: boolean;
+}
+interface UploadSupportBundleInput {
+    token: string;
+    appId: string;
+}
+interface UploadSupportBundleResult {
+    uploadUrl: string;
+    appId: string;
+}
+interface UploadSupportBundleCompleteInput {
+    token: string;
+    appId: string;
+    fileContent: ArrayBuffer;
+    contentLength: number;
+}
+interface UploadSupportBundleCompleteResult {
+    bundleId: string;
+    slug: string;
+}
+interface FetchLicenseDetailsInput {
+    token: string;
+}
+interface FetchLicenseDetailsResult {
+    license: PortalLicenseDetails;
+    raw: unknown;
+}
+interface FetchInstallOptionsInput {
+    token: string;
+}
+interface FetchInstallOptionsResult {
+    showLinux: boolean;
+    showHelm: boolean;
+}
+interface FetchLicenseSummaryInput {
+    token: string;
+}
+interface FetchLicenseSummaryResult {
+    type: string;
+    expiresAt: string | null;
+}
+interface FetchCustomersInput {
+    token: string;
+}
+interface Customer {
+    id: string;
+    name: string;
+    licenseId: string;
+    licenseType: string;
+    expiresAt: string;
+    isEnterprisePortalEnabled: boolean;
+}
+interface FetchCustomersResult {
+    customers: Customer[];
+}
+interface SwitchCustomerInput {
+    token: string;
+    customerId: string;
+}
+interface SwitchCustomerResult {
+    token: string;
+}
+interface ListReleasesInput {
+    token: string;
+}
+interface ListReleasesResult {
+    status: number;
+    body: string | null;
+}
+/**
+ * Fetches custom branding for the portal.
+ * This function is cached per-request to avoid duplicate API calls when called
+ * from multiple components (e.g., TopNav and page components).
+ */
+declare const fetchCustomBranding: () => Promise<CustomBrandingResponse>;
+declare const decodeJwtPayload: (token: string) => Record<string, unknown>;
+/**
+ * Extracts customer ID from JWT token. Throws if extraction fails.
+ */
+declare const getCustomerIdFromToken: (token: string) => string;
+declare const listSupportBundles: PortalServerActionDefinition<ListSupportBundlesInput, ListSupportBundlesResult>;
+declare const downloadSupportBundle: PortalServerActionDefinition<DownloadSupportBundleInput, DownloadSupportBundleResult>;
+declare const deleteSupportBundle: PortalServerActionDefinition<DeleteSupportBundleInput, DeleteSupportBundleResult>;
+declare const uploadSupportBundle: PortalServerActionDefinition<UploadSupportBundleCompleteInput, UploadSupportBundleCompleteResult>;
+/**
+ * Helper to get the upload endpoint URL for client-side uploads with progress tracking.
+ * Use this when you need progress indication - call this to get the URL, then upload directly from client.
+ */
+declare const getSupportBundleUploadUrl: (appId: string) => string;
+declare const listReleases: PortalServerActionDefinition<ListReleasesInput, ListReleasesResult>;
+declare const fetchLicenseDetails: PortalServerActionDefinition<FetchLicenseDetailsInput, FetchLicenseDetailsResult>;
+declare const fetchInstallOptions: PortalServerActionDefinition<FetchInstallOptionsInput, FetchInstallOptionsResult>;
+declare const fetchLicenseSummary: PortalServerActionDefinition<FetchLicenseSummaryInput, FetchLicenseSummaryResult>;
+declare const fetchCustomers: PortalServerActionDefinition<FetchCustomersInput, FetchCustomersResult>;
+declare const switchCustomer: PortalServerActionDefinition<SwitchCustomerInput, SwitchCustomerResult>;
+type SecurityInstallType = "linux" | "helm";
+interface SecurityScanSummary {
+    critical: Record<string, string>;
+    high: Record<string, string>;
+    medium: Record<string, string>;
+    low: Record<string, string>;
+}
+interface SecurityScanWrapper {
+    input: string;
+    digest?: string;
+    last_scanned_at?: string;
+    result: SecurityScanSummary;
+    not_found?: boolean;
+}
+interface SecurityReleaseImage {
+    image: string;
+    sha: string;
+    size: number;
+    platforms: {
+        os: string;
+        architecture: string;
+    }[];
+    security?: SecurityScanWrapper;
+}
+interface GetSecurityInfoInput {
+    token: string;
+    installType: SecurityInstallType;
+    channelSequence: number;
+    isAirgap?: boolean;
+}
+interface GetSecurityInfoResult {
+    images: SecurityReleaseImage[];
+}
+interface SecurityInfoDiff {
+    oldTags: string[];
+    newTags: string[];
+    oldVulns?: SecurityScanSummary;
+    newVulns?: SecurityScanSummary;
+    added?: SecurityScanSummary;
+    removed?: SecurityScanSummary;
+}
+interface GetSecurityInfoDiffInput {
+    token: string;
+    installType: SecurityInstallType;
+    fromChannelSequence: number;
+    toChannelSequence: number;
+    isAirgap?: boolean;
+}
+interface GetSecurityInfoDiffResult {
+    from_channel_sequence: number;
+    to_channel_sequence: number;
+    images: Record<string, SecurityInfoDiff>;
+}
+interface UnifiedSbom {
+    sbom: string;
+    sbom_source: string;
+}
+interface SpdxCreationInfo {
+    created: string;
+    creators: string[];
+}
+interface SpdxDocument {
+    SPDXID: string;
+    spdxVersion: string;
+    name: string;
+    creationInfo?: SpdxCreationInfo;
+    packages?: unknown[];
+    files?: unknown[];
+}
+interface GetSecurityInfoSBOMInput {
+    token: string;
+    installType: SecurityInstallType;
+    channelSequence: number;
+    isAirgap?: boolean;
+    unifiedSbom?: boolean;
+}
+interface GetSecurityInfoSBOMResult {
+    sboms: {
+        unified?: UnifiedSbom;
+    };
+}
+/**
+ * Fetches security scan (CVE) information for a specific release.
+ */
+declare const getSecurityInfo: PortalServerActionDefinition<GetSecurityInfoInput, GetSecurityInfoResult>;
+/**
+ * Fetches security diff between two releases (fixed/added CVEs).
+ */
+declare const getSecurityInfoDiff: PortalServerActionDefinition<GetSecurityInfoDiffInput, GetSecurityInfoDiffResult>;
+/**
+ * Fetches SBOM (Software Bill of Materials) for a specific release.
+ */
+declare const getSecurityInfoSBOM: PortalServerActionDefinition<GetSecurityInfoSBOMInput, GetSecurityInfoSBOMResult>;
+interface FetchTeamStatsInput {
+    token: string;
+}
+interface ServiceAccountSummary {
+    id: string;
+    accountName: string;
+    customerId: string;
+    isRevoked: boolean;
+    createdAt: string;
+}
+interface FetchTeamStatsResult {
+    userCount: number;
+    serviceAccountCount: number;
+}
+interface FetchDashboardInstancesInput {
+    token: string;
+}
+interface FetchDashboardInstancesResult {
+    onlineActiveCount: number;
+    airgapCount: number;
+    onlineUpdates: number;
+    airgapUpdates: number;
+}
+/**
+ * Fetches team statistics including user count and service account count.
+ * Used by the Team Settings dashboard card.
+ */
+declare const fetchTeamStats: PortalServerActionDefinition<FetchTeamStatsInput, FetchTeamStatsResult>;
+/**
+ * Fetches instance counts and available updates for the dashboard.
+ * Used by the Updates dashboard card.
+ */
+declare const fetchDashboardInstances: PortalServerActionDefinition<FetchDashboardInstancesInput, FetchDashboardInstancesResult>;
+interface FetchCurrentUserInput {
+    token: string;
+}
+interface UserProfile {
+    emailAddress: string;
+    firstName: string;
+    lastName: string;
+}
+interface FetchCurrentUserResult {
+    user: UserProfile;
+}
+interface UpdateUserInput {
+    token: string;
+    firstName?: string;
+    lastName?: string;
+}
+interface UpdateUserResult {
+    success: boolean;
+}
+interface NotificationSetting {
+    type: string;
+    enabled: boolean;
+}
+interface FetchNotificationsInput {
+    token: string;
+    customerId: string;
+}
+interface FetchNotificationsResult {
+    notifications: NotificationSetting[];
+}
+interface UpdateNotificationsInput {
+    token: string;
+    customerId: string;
+    notifications: NotificationSetting[];
+}
+interface UpdateNotificationsResult {
+    notifications: NotificationSetting[];
+}
+/**
+ * Fetches the current user's profile information.
+ */
+declare const fetchCurrentUser: PortalServerActionDefinition<FetchCurrentUserInput, FetchCurrentUserResult>;
+/**
+ * Updates the current user's profile information.
+ */
+declare const updateUser: PortalServerActionDefinition<UpdateUserInput, UpdateUserResult>;
+/**
+ * Fetches notification preferences for a specific customer/team.
+ */
+declare const fetchNotifications: PortalServerActionDefinition<FetchNotificationsInput, FetchNotificationsResult>;
+/**
+ * Updates notification preferences for a specific customer/team.
+ */
+declare const updateNotifications: PortalServerActionDefinition<UpdateNotificationsInput, UpdateNotificationsResult>;
+interface TeamUser {
+    id: string;
+    email: string;
+    name?: string;
+    createdAt?: string;
+}
+interface TeamUser {
+    emailAddress: string;
+    firstAccessedAt?: string;
+    lastAccessedAt?: string;
+    viewCount?: number;
+    pendingInvite?: boolean;
+}
+interface FetchTeamUsersInput {
+    token: string;
+    limit?: number;
+    offset?: number;
+}
+interface FetchTeamUsersResult {
+    users: TeamUser[];
+    total: number;
+}
+interface InviteUserInput {
+    token: string;
+    email: string;
+}
+interface InviteUserResult {
+    success: boolean;
+}
+interface DeleteUserInput {
+    token: string;
+    email: string;
+}
+interface DeleteUserResult {
+    success: boolean;
+}
+interface ServiceAccount {
+    id: string;
+    customerId: string;
+    accountName: string;
+    emailAddress?: string;
+    token: string;
+    isRevoked: boolean;
+    createdAt: string;
+    lastUsedAt?: string;
+    tokenRegeneratedAt?: string;
+}
+interface FetchServiceAccountsInput {
+    token: string;
+    limit?: number;
+    offset?: number;
+    includeRevoked?: boolean;
+}
+interface FetchServiceAccountsResult {
+    serviceAccounts: ServiceAccount[];
+    total: number;
+}
+interface RevokeServiceAccountInput {
+    token: string;
+    accountId: string;
+}
+interface RevokeServiceAccountResult {
+    success: boolean;
+}
+interface RotateServiceAccountTokenInput {
+    token: string;
+    accountId: string;
+}
+interface RotateServiceAccountTokenResult {
+    serviceAccount: ServiceAccount;
+    helmLoginCommand: string;
+    redeployHelm: string[];
+}
+interface Instance {
+    id: string;
+    serviceAccountId?: string;
+    versionLabel?: string;
+    channelId?: string;
+    channelSequence?: number;
+    lastCheckin?: string;
+    isAirgap?: boolean;
+    embeddedClusterVersion?: string;
+    tags?: Array<{
+        key: string;
+        value: string;
+    }>;
+}
+interface FetchInstancesInput {
+    token: string;
+}
+interface FetchInstancesResult {
+    instances: Instance[];
+}
+interface SAMLConfig {
+    samlAllowed: boolean;
+    samlEnabled: boolean;
+    entityId: string;
+    acsUrl: string;
+    hasIdpMetadata: boolean;
+    hasIdpCert: boolean;
+}
+interface FetchSamlConfigInput {
+    token: string;
+}
+interface FetchSamlConfigResult {
+    config: SAMLConfig;
+}
+interface UpdateSamlConfigInput {
+    token: string;
+    idpMetadataXml: string;
+    idpPublicCert: string;
+}
+interface UpdateSamlConfigResult {
+    success: boolean;
+}
+interface ToggleSamlEnabledInput {
+    token: string;
+    enabled: boolean;
+}
+interface ToggleSamlEnabledResult {
+    success: boolean;
+    samlEnabled: boolean;
+}
+interface DeprovisionSamlInput {
+    token: string;
+}
+interface DeprovisionSamlResult {
+    success: boolean;
+}
+/**
+ * Fetches the list of users for a team.
+ */
+declare const fetchTeamUsers: PortalServerActionDefinition<FetchTeamUsersInput, FetchTeamUsersResult>;
+/**
+ * Invites a user to the team.
+ */
+declare const inviteUser: PortalServerActionDefinition<InviteUserInput, InviteUserResult>;
+/**
+ * Removes a user from the team.
+ */
+declare const deleteUser: PortalServerActionDefinition<DeleteUserInput, DeleteUserResult>;
+/**
+ * Fetches the list of service accounts for a team.
+ */
+declare const fetchServiceAccounts: PortalServerActionDefinition<FetchServiceAccountsInput, FetchServiceAccountsResult>;
+/**
+ * Revokes a service account.
+ */
+declare const revokeServiceAccount: PortalServerActionDefinition<RevokeServiceAccountInput, RevokeServiceAccountResult>;
+/**
+ * Rotates a service account token.
+ */
+declare const rotateServiceAccountToken: PortalServerActionDefinition<RotateServiceAccountTokenInput, RotateServiceAccountTokenResult>;
+/**
+ * Fetches instances for the customer.
+ */
+declare const fetchInstances: PortalServerActionDefinition<FetchInstancesInput, FetchInstancesResult>;
+/**
+ * Fetches SAML configuration for the customer.
+ */
+declare const fetchSamlConfig: PortalServerActionDefinition<FetchSamlConfigInput, FetchSamlConfigResult>;
+/**
+ * Updates SAML configuration (uploads IdP metadata and certificate).
+ */
+declare const updateSamlConfig: PortalServerActionDefinition<UpdateSamlConfigInput, UpdateSamlConfigResult>;
+/**
+ * Toggles SAML authentication enabled/disabled.
+ */
+declare const toggleSamlEnabled: PortalServerActionDefinition<ToggleSamlEnabledInput, ToggleSamlEnabledResult>;
+/**
+ * Removes SAML configuration (deprovisions SAML).
+ */
+declare const deprovisionSaml: PortalServerActionDefinition<DeprovisionSamlInput, DeprovisionSamlResult>;
+interface AcceptInviteInput {
+    code: string;
+}
+interface AcceptInviteResult {
+    token: string;
+}
+interface AcceptInviteError {
+    code: "invalid_code" | "expired" | "unknown";
+    message: string;
+}
+/**
+ * Accepts a team invitation using the invite code from email.
+ * Returns a JWT token on success that can be used to establish a session.
+ */
+declare const acceptInvite: PortalServerActionDefinition<AcceptInviteInput, AcceptInviteResult>;
+interface RefreshInviteInput {
+    code: string;
+}
+interface RefreshInviteResult {
+    success: boolean;
+}
+/**
+ * Refreshes an expired invite by generating a new code and resending the email.
+ * The original code is used to identify the invite to refresh.
+ */
+declare const refreshInvite: PortalServerActionDefinition<RefreshInviteInput, RefreshInviteResult>;
 
-export { type InitiateLoginInput, type InitiateLoginResult, type PortalActionContext, type PortalActionVisibility, type PortalServerActionDefinition, type VerifyMagicLinkError, type VerifyMagicLinkInput, type VerifyMagicLinkResult, defineServerAction, initiateLogin, verifyMagicLink };
+export { type AcceptInviteError, type AcceptInviteInput, type AcceptInviteResult, type CreateServiceAccountInput, type CreateServiceAccountResult, type CustomBrandingResponse, type Customer, type DeleteSupportBundleInput, type DeleteSupportBundleResult, type DeleteUserInput, type DeleteUserResult, type DeprovisionSamlInput, type DeprovisionSamlResult, type DownloadSupportBundleInput, type DownloadSupportBundleResult, type FetchCurrentUserInput, type FetchCurrentUserResult, type FetchCustomersInput, type FetchCustomersResult, type FetchDashboardInstancesInput, type FetchDashboardInstancesResult, type FetchInstallOptionsInput, type FetchInstallOptionsResult, type FetchInstancesInput, type FetchInstancesResult, type FetchLicenseDetailsInput, type FetchLicenseDetailsResult, type FetchLicenseSummaryInput, type FetchLicenseSummaryResult, type FetchNotificationsInput, type FetchNotificationsResult, type FetchSamlConfigInput, type FetchSamlConfigResult, type FetchServiceAccountsInput, type FetchServiceAccountsResult, type FetchTeamStatsInput, type FetchTeamStatsResult, type FetchTeamUsersInput, type FetchTeamUsersResult, type GetSecurityInfoDiffInput, type GetSecurityInfoDiffResult, type GetSecurityInfoInput, type GetSecurityInfoResult, type GetSecurityInfoSBOMInput, type GetSecurityInfoSBOMResult, type InitiateLoginInput, type InitiateLoginResult, type Instance, type InviteUserInput, type InviteUserResult, type ListReleasesInput, type ListReleasesResult, type ListSupportBundlesInput, type ListSupportBundlesResult, type NotificationSetting, type PortalActionContext, type PortalActionVisibility, type PortalLicenseDetails, type PortalLicenseField, type PortalServerActionDefinition, type RefreshInviteInput, type RefreshInviteResult, type RevokeServiceAccountInput, type RevokeServiceAccountResult, type RotateServiceAccountTokenInput, type RotateServiceAccountTokenResult, type SAMLConfig, type SecurityInfoDiff, type SecurityInstallType, type SecurityReleaseImage, type SecurityScanSummary, type SecurityScanWrapper, type ServiceAccount, type ServiceAccountData, type ServiceAccountSummary, type SpdxCreationInfo, type SpdxDocument, type SupportBundleInsight, type SupportBundleSummary, type SwitchCustomerInput, type SwitchCustomerResult, type TeamUser, type ToggleSamlEnabledInput, type ToggleSamlEnabledResult, type UnifiedSbom, type UpdateNotificationsInput, type UpdateNotificationsResult, type UpdateSamlConfigInput, type UpdateSamlConfigResult, type UpdateUserInput, type UpdateUserResult, type UploadSupportBundleCompleteInput, type UploadSupportBundleCompleteResult, type UploadSupportBundleInput, type UploadSupportBundleResult, type UserProfile, type VerifyMagicLinkError, type VerifyMagicLinkInput, type VerifyMagicLinkResult, acceptInvite, createServiceAccount, decodeJwtPayload, defineServerAction, deleteSupportBundle, deleteUser, deprovisionSaml, downloadSupportBundle, fetchCurrentUser, fetchCustomBranding, fetchCustomers, fetchDashboardInstances, fetchInstallOptions, fetchInstances, fetchLicenseDetails, fetchLicenseSummary, fetchNotifications, fetchSamlConfig, fetchServiceAccounts, fetchTeamStats, fetchTeamUsers, getApiOrigin, getCustomerIdFromToken, getSecurityInfo, getSecurityInfoDiff, getSecurityInfoSBOM, getSupportBundleUploadUrl, initiateLogin, inviteUser, listReleases, listSupportBundles, refreshInvite, revokeServiceAccount, rotateServiceAccountToken, switchCustomer, toggleSamlEnabled, updateNotifications, updateSamlConfig, updateUser, uploadSupportBundle, verifyMagicLink };