Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

7.1 KB
Raw Blame
export type SSOProviderType = 'oidc' | 'saml';

export interface SSOProviderFeatureGateCopy {
  title: string;
  subtitle: string;
  body: string;
}

export interface SSOProviderSummaryLike {
  type: SSOProviderType;
  oidcIssuerUrl?: string;
  samlIdpEntityId?: string;
  samlMetadataUrl?: string;
}

export function getSSOProviderTypeLabel(type: SSOProviderType): string {
  return type === 'oidc' ? 'OIDC' : 'SAML';
}

export function getSSOProviderAddButtonLabel(type: SSOProviderType): string {
  return `Add ${getSSOProviderTypeLabel(type)}`;
}

export function getSSOSamlFeatureGateCopy(): SSOProviderFeatureGateCopy {
  return {
    title: 'Single Sign-On',
    subtitle: 'Single Sign-On',
    body: 'OIDC, SAML, and multi-provider SSO are included with Community and higher tiers.',
  };
}

export function getSSOProviderModalTitle(editing: boolean, type: SSOProviderType): string {
  return `${editing ? 'Edit' : 'Add'} ${getSSOProviderTypeLabel(type)} Provider`;
}

export function getSSOProviderEmptyStateDescription(): string {
  return 'Add an OIDC or SAML provider to get started.';
}

export function getSSOProviderEmptyStateTitle(): string {
  return 'No SSO providers configured';
}

export function getSSOProvidersLoadingState() {
  return {
    text: 'Loading SSO providers…',
  } as const;
}

export function getSSOProvidersLoadErrorMessage(): string {
  return 'Unable to load SSO providers.';
}

export function getSSOProviderDetailsLoadErrorMessage(): string {
  return 'Unable to load SSO provider details.';
}

export function getSSOProviderSaveSuccessMessage(isEdit: boolean): string {
  return isEdit ? 'SSO provider has been updated.' : 'SSO provider has been created.';
}

export function getSSOProviderSaveErrorMessage(error?: unknown): string {
  const message = (
    error instanceof Error ? error.message : typeof error === 'string' ? error : ''
  ).trim();
  // Only short human guidance belongs in the editor, never markup, malformed
  // envelopes, object coercions or an unbounded upstream response.
  if (
    !message ||
    message.length > 500 ||
    /^[{["]/.test(message) ||
    /[<>\u0000-\u001F\u007F]/.test(message) // eslint-disable-line no-control-regex -- intentional sanitization
  ) {
    return 'Unable to save the SSO provider. Check the connection and try saving again.';
  }
  return `Unable to save the SSO provider: ${message}`;
}

export function getSSOProviderDeleteSuccessMessage(): string {
  return 'SSO provider has been removed.';
}

export function getSSOProviderDeleteErrorMessage(): string {
  return 'Unable to remove the SSO provider.';
}

export function getSSOProviderToggleSuccessMessage(enabled: boolean): string {
  return enabled ? 'SSO provider has been enabled.' : 'SSO provider has been disabled.';
}

export function getSSOProviderToggleErrorMessage(): string {
  return 'Unable to update the SSO provider.';
}

export function getSSOCopySuccessMessage(label: string): string {
  return `${label} has been copied to the clipboard.`;
}

export function getSSOCopyErrorMessage(label: string): string {
  return `Unable to copy ${label.toLowerCase()}. Select and copy the URL manually.`;
}

export function getSSOConnectionTestSuccessMessage(): string {
  return 'Connection test completed successfully.';
}

export function getSSOConnectionTestFailureMessage(message: string): string {
  return `Connection test failed: ${message}`;
}

export function getSSOConnectionTestErrorMessage(): string {
  return 'Unable to run the connection test.';
}

export function getSSOMetadataUrlRequiredMessage(): string {
  return 'Enter an IdP metadata URL.';
}

export function getSSOMetadataFetchErrorMessage(error?: unknown): string {
  // Preview callbacks, proxies and network errors can contain private provider
  // data. Use recognised categories only, never their message or raw response.
  const failure =
    error && typeof error === 'object' ? (error as { code?: unknown; status?: unknown }) : {};
  if (failure.status === 403) {
    return 'Metadata preview was refused. Check your administrator session and permissions, then try again. Your draft has not been saved.';
  }
  if (failure.status === 429 || failure.code === 'rate_limited') {
    return 'Too many metadata previews. Wait a moment and try again. Your draft has not been saved.';
  }
  switch (failure.code) {
    case 'validation_error':
      return 'Unable to preview SAML metadata. Check the metadata URL and try again. Your draft has not been saved.';
    case 'fetch_error':
      return 'Unable to fetch SAML metadata. Check the URL, provider availability and TLS trust on the Pulse server, then try again. Your draft has not been saved.';
    case 'parse_error':
      return 'Unable to parse SAML metadata. Check that the URL returns a SAML metadata document. Your draft has not been saved.';
    default:
      return 'Unable to preview SAML metadata. Check the connection and metadata URL, then try again. Your draft has not been saved.';
  }
}

export function getSSOProviderSummary(provider: SSOProviderSummaryLike): string {
  if (provider.type === 'oidc') {
    return provider.oidcIssuerUrl || '';
  }

  return provider.samlIdpEntityId || provider.samlMetadataUrl || '';
}

export function getSSOProviderCardClass(enabled: boolean): string {
  return enabled
    ? 'p-4 rounded-md border bg-surface border-border'
    : 'p-4 rounded-md border bg-surface-alt border-border opacity-60';
}

export function getSSOProviderTypeBadgeClass(): string {
  return 'px-1.5 py-0.5 text-xs font-medium rounded-sm bg-surface-hover';
}

export function getSSOTestResultPresentation(success: boolean) {
  if (success) {
    return {
      panelClass:
        'p-4 rounded-md border bg-green-50 dark:bg-green-900/25 border-green-200 dark:border-green-800',
      iconClass: 'w-5 h-5 text-emerald-500 dark:text-emerald-400 shrink-0 mt-0.5',
      titleClass: 'text-sm font-medium text-green-800 dark:text-green-200',
      errorClass: 'text-xs text-red-600 dark:text-red-400 mt-1',
    };
  }

  return {
    panelClass:
      'p-4 rounded-md border bg-red-50 dark:bg-red-900/25 border-red-200 dark:border-red-800',
    iconClass: 'w-5 h-5 text-rose-500 dark:text-rose-400 shrink-0 mt-0.5',
    titleClass: 'text-sm font-medium text-red-800 dark:text-red-200',
    errorClass: 'text-xs text-red-600 dark:text-red-400 mt-1',
  };
}

// getSSOEndpointUnavailableHint explains why a server-generated SSO endpoint URL
// is missing. The backend derives these URLs from the configured public URL, or
// from the request when none is set, so an empty value means neither source
// resolved a host and the admin has to configure one explicitly.
export function getSSOEndpointUnavailableHint(endpointLabel: string): string {
  return `Set the public URL in Settings > System to generate the correct ${endpointLabel}.`;
}

export function getSSOCertificatePresentation(isExpired: boolean) {
  return {
    containerClass: isExpired
      ? 'text-xs px-2 py-1 rounded-sm bg-red-100 dark:bg-red-900/25 text-red-700 dark:text-red-300'
      : 'text-xs px-2 py-1 rounded-sm bg-surface-hover text-base-content',
    expiredLabelClass: 'ml-1 text-red-600 dark:text-red-400 font-medium',
    expiredLabel: '(Expired!)',
  };
}