Skip to content

Voice-to-text dictation app with local (Nvidia Parakeet/Whisper) and cloud models (BYOK). Privacy-first and available cross-platform.

12.2 KB
Raw Blame
import { useState, type ReactNode } from "react";
import { ArrowLeft, CircleCheck, Laptop } from "../icons";
import { useTranslation } from "react-i18next";
import { Button } from "../ui/button";
// Imported (not referenced by path) so Vite fingerprints them and they resolve
// under the packaged app's file:// origin. Authored at 88px (2x the original
// 44px slot; the row has since tightened to a 40px slot), with their rounded
// corners baked in as transparency.
import microphoneIcon from "@/assets/onboarding-permission-microphone.webp";
import accessibilityIcon from "@/assets/onboarding-permission-accessibility.webp";
import systemAudioIcon from "@/assets/onboarding-permission-system-audio.webp";
import type { UsePermissionsReturn } from "../../hooks/usePermissions";
import type { SystemAudioAccessResult } from "../../types/electron";
import type { PermissionGuideId } from "../../types/permissionGuide";
import { canManageSystemAudioInApp } from "../../utils/systemAudioAccess";
import { getPlatform } from "../../utils/platform";
import { areRequiredPermissionsMet } from "../../utils/permissions";
import { needsLinuxPasteToolGuidance } from "../../utils/linuxPasteTools";
import MicPermissionWarning from "../ui/MicPermissionWarning";
import PasteToolsInfo from "../ui/PasteToolsInfo";
import { CompactOnboardingFrame } from "./OnboardingShell";

interface CompactPermissionsStepProps {
  guide?: {
    start: (permission: PermissionGuideId) => Promise<void>;
    ready: boolean;
    error: boolean;
  };
  permissions: UsePermissionsReturn;
  systemAudio: Pick<SystemAudioAccessResult, "granted" | "mode" | "supportsOnboardingGrant"> & {
    request: () => Promise<boolean>;
  };
  screenContext?: {
    enabled: boolean;
    granted: boolean;
    needsRelaunch: boolean;
    request: () => Promise<boolean>;
  };
  /** Omitted when there is no step to return to. */
  onBack?: () => void;
  onContinue: () => void;
}

interface PermissionRowProps {
  title: string;
  description: string;
  badge?: string;
  granted: boolean;
  busy: boolean;
  disabled?: boolean;
  iconSrc?: string;
  icon?: ReactNode;
  onRequest: () => Promise<void>;
}

function PermissionRow({
  title,
  description,
  badge,
  granted,
  busy,
  disabled = false,
  iconSrc,
  icon,
  onRequest,
}: PermissionRowProps) {
  const { t } = useTranslation();

  return (
    <div className="flex h-16 items-center gap-3">
      {/* Decorative: the adjacent title and description already name the
          permission, so announcing the icon too would just duplicate it. The
          icon stays put once granted — the button carries the state. */}
      {icon ?? (
        <img
          src={iconSrc}
          alt=""
          aria-hidden="true"
          width={40}
          height={40}
          decoding="async"
          draggable={false}
          className="size-10 shrink-0 select-none"
        />
      )}

      <div className="min-w-0 flex-1 text-start">
        <p className="text-sm font-medium leading-5 text-[var(--onboarding-text-primary)]">
          {title}
          {badge && (
            <span className="ms-1.5 inline-flex items-center rounded-full bg-[var(--onboarding-surface-tertiary)] px-2 py-0.5 align-middle text-[10px] font-normal leading-4 text-[var(--onboarding-text-secondary)]">
              {badge}
            </span>
          )}
        </p>
        <p className="mt-0.5 line-clamp-2 text-xs leading-4 text-[var(--onboarding-text-secondary)]">
          {description}
        </p>
      </div>

      <button
        type="button"
        disabled={busy || disabled || granted}
        onClick={() => void onRequest()}
        className={`onboarding-pressable inline-flex h-8 min-w-20 shrink-0 items-center justify-center gap-1 rounded-full px-2.5 text-xs font-normal focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-[color-mix(in_srgb,var(--onboarding-accent)_30%,transparent)] disabled:cursor-default ${
          granted
            ? // Granted rows are disabled, so the disabled: variants have to
              // restate the tint or it falls back to the neutral grey below.
              "bg-[color-mix(in_srgb,var(--onboarding-accent)_12%,transparent)] text-[var(--onboarding-accent)] disabled:bg-[color-mix(in_srgb,var(--onboarding-accent)_12%,transparent)] disabled:text-[var(--onboarding-accent)]"
            : "bg-[var(--onboarding-surface-tertiary)] text-[var(--onboarding-text-secondary)] hover:bg-[var(--onboarding-surface-tertiary-hover)] disabled:bg-[var(--onboarding-surface-tertiary)] disabled:text-[var(--onboarding-text-secondary)]"
        }`}
      >
        {granted && !busy && <CircleCheck className="size-3.5 shrink-0" aria-hidden="true" />}
        {busy
          ? t("common.loading")
          : granted
            ? t("onboarding.rehaul.permissions.enabled")
            : t("onboarding.rehaul.permissions.enable")}
      </button>
    </div>
  );
}

export default function CompactPermissionsStep({
  guide,
  permissions,
  systemAudio,
  screenContext,
  onBack,
  onContinue,
}: CompactPermissionsStepProps) {
  const { t } = useTranslation();
  const [busyPermission, setBusyPermission] = useState<PermissionGuideId | null>(null);
  const platform = getPlatform();
  const canRequestSystemAudio = canManageSystemAudioInApp(systemAudio);
  const requiredGranted = areRequiredPermissionsMet(permissions.micPermissionGranted);
  // Only macOS has grantable Accessibility (auto-paste) and System Audio
  // permissions. Windows auto-grants both (SendKeys needs nothing, WASAPI
  // loopback is permissionless) and Linux has no in-app grant for either, so
  // showing those rows there is either a no-op button or a dead disabled one.
  const showAccessibility = platform === "darwin";
  const showSystemAudio = platform === "darwin";
  // Screen Context: macOS grants via TCC, Windows is a permissionless opt-in;
  // Linux is hidden because Wayland capture is unsupported.
  const showScreenContext = platform === "darwin" || platform === "win32";
  const showLinuxPasteGuidance =
    platform === "linux" &&
    permissions.pasteToolsInfo !== null &&
    needsLinuxPasteToolGuidance(permissions.pasteToolsInfo);

  const request = async (id: PermissionGuideId, action: () => Promise<unknown>) => {
    setBusyPermission(id);
    try {
      if (guide?.ready && !guide.error) await guide.start(id);
      else await action();
    } finally {
      setBusyPermission(null);
    }
  };

  return (
    <CompactOnboardingFrame showLegalNotice={false}>
      <div className="onboarding-shell-scroll relative flex h-full flex-col overflow-y-auto px-5 pb-6 pt-45 text-center">
        {/* text-balance evens the two lines out ("Set up OpenWhispr" / "in 3
            minutes") instead of leaving one word stranded. Preferred over a
            hardcoded <br> because the break point stays correct in all 9
            locales, where the string length differs. */}
        <h1 className="onboarding-display-title mx-auto max-w-96 text-balance text-3xl!">
          {t("onboarding.rehaul.permissions.title")}
        </h1>

        <div className="mt-5 rounded-[1.35rem] bg-[var(--onboarding-surface-secondary)] px-3 py-1">
          <PermissionRow
            title={t("onboarding.permissions.microphoneTitle")}
            description={t("onboarding.rehaul.permissions.microphoneDescription")}
            granted={permissions.micPermissionGranted}
            busy={busyPermission === "microphone"}
            iconSrc={microphoneIcon}
            onRequest={() => request("microphone", permissions.requestMicPermission)}
          />
          {showAccessibility && (
            <>
              <div className="h-px bg-[var(--onboarding-surface-tertiary)]" />
              <PermissionRow
                title={t("onboarding.permissions.accessibilityTitle")}
                description={t("onboarding.rehaul.permissions.accessibilityDescription")}
                granted={permissions.accessibilityPermissionGranted}
                busy={busyPermission === "accessibility"}
                iconSrc={accessibilityIcon}
                onRequest={() =>
                  request("accessibility", permissions.requestAccessibilityPermission)
                }
              />
            </>
          )}
          {showSystemAudio && (
            <>
              <div className="h-px bg-[var(--onboarding-surface-tertiary)]" />
              <PermissionRow
                title={t("onboarding.rehaul.permissions.systemAudioTitle")}
                description={t("onboarding.rehaul.permissions.systemAudioDescription")}
                badge={t("onboarding.permissions.optional")}
                granted={systemAudio.granted}
                busy={busyPermission === "system-audio"}
                disabled={!canRequestSystemAudio}
                iconSrc={systemAudioIcon}
                onRequest={() => request("system-audio", systemAudio.request)}
              />
            </>
          )}
          {showScreenContext && screenContext && (
            <>
              <div className="h-px bg-[var(--onboarding-surface-tertiary)]" />
              <PermissionRow
                title={t("dictationAgent.screenContext.title")}
                description={t("onboarding.rehaul.permissions.screenContextDescription")}
                badge={t("onboarding.permissions.optional")}
                granted={screenContext.enabled && screenContext.granted}
                busy={busyPermission === "screen-context"}
                icon={
                  <span
                    aria-hidden="true"
                    className="flex size-10 shrink-0 items-center justify-center rounded-xl bg-[var(--onboarding-accent)] text-[var(--onboarding-accent-foreground)]"
                  >
                    <Laptop className="size-5" strokeWidth={2.2} />
                  </span>
                }
                onRequest={() => request("screen-context", screenContext.request)}
              />
            </>
          )}
        </div>

        {platform === "darwin" && screenContext?.enabled && screenContext.needsRelaunch && (
          <p className="mt-2 text-start text-xs leading-4 text-warning/80">
            {t("dictationAgent.screenContext.relaunchHint")}
          </p>
        )}

        {!permissions.micPermissionGranted && permissions.micPermissionError && (
          <div className="mt-3 text-start">
            <MicPermissionWarning
              error={permissions.micPermissionError}
              onOpenSoundSettings={() => void permissions.openSoundInputSettings()}
              onOpenPrivacySettings={() => void permissions.openMicPrivacySettings()}
            />
          </div>
        )}

        {showLinuxPasteGuidance && (
          <div className="mt-3 text-start">
            <PasteToolsInfo
              pasteToolsInfo={permissions.pasteToolsInfo}
              isChecking={permissions.isCheckingPasteTools}
              onCheck={() => void permissions.checkPasteToolsAvailability()}
            />
          </div>
        )}

        {/* Last child so mt-auto actually pins the actions to the bottom: any
            element after them rides along on that auto margin, which put the
            relaunch hint and the two warnings below the buttons — and, on Linux
            where the paste guidance is the point of the screen, out of view. */}
        <div className="mt-auto flex w-full shrink-0 items-center justify-between gap-3 pt-3">
          {onBack && (
            <button
              type="button"
              onClick={onBack}
              className="onboarding-pressable inline-flex h-10 flex-1 items-center justify-center gap-1.5 rounded-full border border-[var(--onboarding-control-border)] bg-[var(--onboarding-surface)] px-5 text-sm font-medium text-[var(--onboarding-text-primary)] transition-colors hover:bg-[var(--onboarding-surface-hover)] focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-[color-mix(in_srgb,var(--onboarding-accent)_30%,transparent)]"
            >
              <ArrowLeft className="size-4 rtl:rotate-180" aria-hidden="true" />
              {t("common.back")}
            </button>
          )}

          <Button
            type="button"
            onClick={onContinue}
            disabled={!requiredGranted}
            className="h-10 flex-1 px-5 text-sm"
          >
            {t("common.continue")}
          </Button>
        </div>
      </div>
    </CompactOnboardingFrame>
  );
}