Skip to content

armgit / mimik

Public Imported from GitHub
0

🎬 A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots πŸ“–

refactor: share the narration notice and its status types between both surfaces

Luis Ortiz5ede54deea96
diff --git a/src/ui/fullview/__tests__/voice-notice.test.ts b/packages/core/src/capture/voice/__tests__/voice-notice.test.ts
similarity index 93%
rename from src/ui/fullview/__tests__/voice-notice.test.ts
rename to packages/core/src/capture/voice/__tests__/voice-notice.test.ts
index fd2dca7..aa4d3a0 100644
--- a/src/ui/fullview/__tests__/voice-notice.test.ts
+++ b/packages/core/src/capture/voice/__tests__/voice-notice.test.ts
@@ -1,14 +1,14 @@
import { readFileSync } from 'node:fs';
import { join } from 'node:path';
import { describe, expect, it } from 'vitest';
-import type { PanelVoiceUpdate, VoicePhase } from '@/lib/port/types';
-import { VOICE_CONFIRM_MS, voiceNotice } from '../lib/voice-notice';
-import { voiceSignature } from '../lib/voice-signature';
+import { VOICE_CONFIRM_MS, voiceNotice } from '../voice-notice';
+import { voiceSignature } from '../voice-signature';
+import type { VoicePhase, VoiceUpdate } from '../voice-update';
const LOCALES = ['en', 'es', 'fr', 'pt-BR', 'zh-CN'];
-function update(phase: VoicePhase, extra: Partial<PanelVoiceUpdate> = {}): PanelVoiceUpdate {
- return { type: 'VOICE_UPDATE', phase, ...extra };
+function update(phase: VoicePhase, extra: Partial<VoiceUpdate> = {}): VoiceUpdate {
+ return { phase, ...extra };
}
function localeKeys(locale: string): Set<string> {
diff --git a/src/ui/sidepanel/lib/narrated-key.ts b/packages/core/src/capture/voice/narrated-key.ts
similarity index 100%
rename from src/ui/sidepanel/lib/narrated-key.ts
rename to packages/core/src/capture/voice/narrated-key.ts
diff --git a/src/lib/voice/start-failure-reason.ts b/packages/core/src/capture/voice/start-failure-reason.ts
similarity index 87%
rename from src/lib/voice/start-failure-reason.ts
rename to packages/core/src/capture/voice/start-failure-reason.ts
index 39b68c9..3f951f0 100644
--- a/src/lib/voice/start-failure-reason.ts
+++ b/packages/core/src/capture/voice/start-failure-reason.ts
@@ -1,4 +1,4 @@
-import type { VoiceErrorReason } from './voice-message';
+import type { VoiceErrorReason } from './voice-update';
export function startFailureReason(error: unknown): VoiceErrorReason {
if (!(error instanceof Error)) return 'unknown';
diff --git a/src/ui/sidepanel/lib/voice-error-key.ts b/packages/core/src/capture/voice/voice-error-key.ts
similarity index 90%
rename from src/ui/sidepanel/lib/voice-error-key.ts
rename to packages/core/src/capture/voice/voice-error-key.ts
index 4384afa..7aa7345 100644
--- a/src/ui/sidepanel/lib/voice-error-key.ts
+++ b/packages/core/src/capture/voice/voice-error-key.ts
@@ -1,4 +1,4 @@
-import type { VoiceErrorReason } from '@/lib/voice/voice-message';
+import type { VoiceErrorReason } from './voice-update';
const VOICE_ERROR_KEYS: Record<VoiceErrorReason, string> = {
'permission-denied': 'voice.errorPermissionDenied',
diff --git a/src/ui/fullview/lib/voice-notice.ts b/packages/core/src/capture/voice/voice-notice.ts
similarity index 81%
rename from src/ui/fullview/lib/voice-notice.ts
rename to packages/core/src/capture/voice/voice-notice.ts
index ec4e787..7116707 100644
--- a/src/ui/fullview/lib/voice-notice.ts
+++ b/packages/core/src/capture/voice/voice-notice.ts
@@ -1,7 +1,7 @@
-import type { PanelVoiceUpdate } from '@/lib/port/types';
-import { narratedKey } from '@/ui/sidepanel/lib/narrated-key';
-import { voiceErrorKey } from '@/ui/sidepanel/lib/voice-error-key';
+import { narratedKey } from './narrated-key';
+import { voiceErrorKey } from './voice-error-key';
import { voiceSignature } from './voice-signature';
+import type { VoiceUpdate } from './voice-update';
export const VOICE_CONFIRM_MS = 7000;
@@ -17,7 +17,7 @@ export interface VoiceNotice {
autoDismissMs: number | null;
}
-export function voiceNotice(update: PanelVoiceUpdate, seenLive: boolean): VoiceNotice | null {
+export function voiceNotice(update: VoiceUpdate, seenLive: boolean): VoiceNotice | null {
const signature = voiceSignature(update);
if (update.phase === 'transcribing') {
diff --git a/packages/core/src/capture/voice/voice-signature.ts b/packages/core/src/capture/voice/voice-signature.ts
new file mode 100644
index 0000000..75f7e90
--- /dev/null
+++ b/packages/core/src/capture/voice/voice-signature.ts
@@ -0,0 +1,5 @@
+import type { VoiceUpdate } from './voice-update';
+
+export function voiceSignature(update: VoiceUpdate): string {
+ return `${update.phase}:${update.reason ?? ''}:${update.narrated ?? ''}`;
+}
diff --git a/packages/core/src/capture/voice/voice-update.ts b/packages/core/src/capture/voice/voice-update.ts
new file mode 100644
index 0000000..9619438
--- /dev/null
+++ b/packages/core/src/capture/voice/voice-update.ts
@@ -0,0 +1,19 @@
+export type VoicePhase = 'idle' | 'recording' | 'transcribing' | 'error';
+
+export type VoiceErrorReason =
+ | 'permission-denied'
+ | 'no-device'
+ | 'no-audio'
+ | 'not-recording'
+ | 'already-recording'
+ | 'missing-api-key'
+ | 'stream-ended'
+ | 'unsupported'
+ | 'unknown';
+
+export interface VoiceUpdate {
+ phase: VoicePhase;
+ reason?: VoiceErrorReason;
+ error?: string;
+ narrated?: number;
+}
diff --git a/packages/ui/src/index.ts b/packages/ui/src/index.ts
index 33a1bda..00ee41b 100644
--- a/packages/ui/src/index.ts
+++ b/packages/ui/src/index.ts
@@ -59,3 +59,4 @@ export { useFullview } from './stores/use-fullview';
export { MicrophoneAccessRow } from './voice/components/MicrophoneAccessRow';
export { MicrophonePicker } from './voice/components/MicrophonePicker';
export { NarrationSettings } from './voice/components/NarrationSettings';
+export { VoiceNotice } from './voice/components/VoiceNotice';
diff --git a/src/ui/fullview/components/VoiceNotice.tsx b/packages/ui/src/voice/components/VoiceNotice.tsx
similarity index 61%
rename from src/ui/fullview/components/VoiceNotice.tsx
rename to packages/ui/src/voice/components/VoiceNotice.tsx
index 09235eb..bafccf7 100644
--- a/src/ui/fullview/components/VoiceNotice.tsx
+++ b/packages/ui/src/voice/components/VoiceNotice.tsx
@@ -1,13 +1,9 @@
-import { Tooltip, TooltipContent, TooltipTrigger } from '@mimik/ui';
+import { voiceNotice } from '@mimik/core/capture/voice/voice-notice';
+import type { VoiceUpdate } from '@mimik/core/capture/voice/voice-update';
+import { i18n } from '@mimik/core/env';
import { Check, Loader2, TriangleAlert, X } from 'lucide-react';
import { useEffect, useState } from 'react';
-import { browser, i18n } from '#imports';
-import { getVoiceStatus } from '@/lib/offscreen/get-voice-status';
-import { observeVoiceFromBackground } from '@/lib/port/observe-voice-from-background';
-import type { PanelVoiceUpdate } from '@/lib/port/types';
-import { voiceNotice } from '../lib/voice-notice';
-
-const IDLE: PanelVoiceUpdate = { type: 'VOICE_UPDATE', phase: 'idle' };
+import { Tooltip, TooltipContent, TooltipTrigger } from '../../components/ui/tooltip';
const TONE_ICONS = {
progress: Loader2,
@@ -21,47 +17,14 @@ const TONE_CLASSES = {
failed: 'text-destructive',
};
-export function VoiceNotice() {
- const [update, setUpdate] = useState<PanelVoiceUpdate>(IDLE);
- const [seenLive, setSeenLive] = useState(false);
- const [dismissed, setDismissed] = useState<string | null>(null);
-
- useEffect(() => {
- let stop: (() => void) | null = null;
-
- const receive = (next: PanelVoiceUpdate) => {
- if (next.phase !== 'idle') setSeenLive(true);
- setUpdate(next);
- };
-
- const resync = () => {
- getVoiceStatus()
- .then((status) => {
- if (!status?.transcribing) return;
- setSeenLive(true);
- setUpdate({ type: 'VOICE_UPDATE', phase: 'transcribing' });
- })
- .catch(() => undefined);
- };
-
- const follow = () => {
- if (document.visibilityState === 'visible') {
- stop ??= observeVoiceFromBackground(receive, resync);
- return;
- }
- stop?.();
- stop = null;
- };
-
- follow();
- document.addEventListener('visibilitychange', follow);
-
- return () => {
- document.removeEventListener('visibilitychange', follow);
- stop?.();
- };
- }, []);
+interface VoiceNoticeProps {
+ update: VoiceUpdate;
+ seenLive: boolean;
+ onOpenSettings: () => void;
+}
+export function VoiceNotice({ update, seenLive, onOpenSettings }: VoiceNoticeProps) {
+ const [dismissed, setDismissed] = useState<string | null>(null);
const notice = voiceNotice(update, seenLive);
const signature = notice?.signature;
const autoDismissMs = notice?.autoDismissMs;
@@ -90,7 +53,8 @@ export function VoiceNotice() {
)}
{shown.showSettings && (
<button
- onClick={() => browser.runtime.openOptionsPage()}
+ type="button"
+ onClick={onOpenSettings}
className="mt-1.5 text-[11px] font-semibold text-accent hover:underline"
>
{i18n.t('voice.openSettings')}
@@ -101,6 +65,7 @@ export function VoiceNotice() {
<Tooltip>
<TooltipTrigger asChild>
<button
+ type="button"
onClick={() => setDismissed(shown.signature)}
className="shrink-0 p-0.5 rounded text-muted-foreground hover:text-foreground transition-colors"
>
diff --git a/src/entrypoints/background/voice.ts b/src/entrypoints/background/voice.ts
index 7852e64..5131843 100644
--- a/src/entrypoints/background/voice.ts
+++ b/src/entrypoints/background/voice.ts
@@ -4,6 +4,7 @@ import { hasVoiceApiKey, VOICE_KEY_SETTINGS } from '@/core/capture/voice/api-key
import { narrateRecording, type VoiceRecording } from '@/core/capture/voice/narrate-recording';
import { narrationUpdates } from '@/core/capture/voice/narration-updates';
import { readTranscriptionSettings } from '@/core/capture/voice/read-transcription-settings';
+import type { VoicePhase } from '@/core/capture/voice/voice-update';
import { applyNarrationToSteps, findExistingStepIds, getStepsForGuide, saveTranscript } from '@/core/guides/service';
import { localStorage } from '@/lib/browser-api/local-storage';
import { onMessage as onRuntimeMessage } from '@/lib/browser-api/on-message';
@@ -21,7 +22,7 @@ import { startVoiceCapture } from '@/lib/offscreen/start-voice-capture';
import { stopVoiceCapture } from '@/lib/offscreen/stop-voice-capture';
import { supportsVoice } from '@/lib/offscreen/supports-voice';
import { broadcastVoiceToPanel } from '@/lib/port/broadcast-voice-to-panel';
-import type { PanelVoiceUpdate, VoicePhase } from '@/lib/port/types';
+import type { PanelVoiceUpdate } from '@/lib/port/types';
import { handedOffPcm } from '@/lib/voice/handed-off-pcm';
import { isVoiceMessageFor } from '@/lib/voice/is-voice-message-for';
import { isVoiceStatus } from '@/lib/voice/is-voice-status';
diff --git a/src/lib/port/types.ts b/src/lib/port/types.ts
index 8594625..c49bed3 100644
--- a/src/lib/port/types.ts
+++ b/src/lib/port/types.ts
@@ -1,7 +1,7 @@
import type { browser } from '#imports';
import type { AiFailureReason } from '@/core/capture/ai/errors';
import type { CaptureStateValue, PauseReason } from '@/core/capture/machine';
-import type { VoiceErrorReason } from '@/lib/voice/voice-message';
+import type { VoiceUpdate } from '@/core/capture/voice/voice-update';
export interface PanelStateUpdate {
type: 'STATE_UPDATE';
@@ -11,14 +11,8 @@ export interface PanelStateUpdate {
pauseReason: PauseReason | null;
}
-export type VoicePhase = 'idle' | 'recording' | 'transcribing' | 'error';
-
-export interface PanelVoiceUpdate {
+export interface PanelVoiceUpdate extends VoiceUpdate {
type: 'VOICE_UPDATE';
- phase: VoicePhase;
- reason?: VoiceErrorReason;
- error?: string;
- narrated?: number;
}
export interface PanelAiUpdate {
diff --git a/src/lib/voice/create-voice-host.ts b/src/lib/voice/create-voice-host.ts
index dcd1209..b77b718 100644
--- a/src/lib/voice/create-voice-host.ts
+++ b/src/lib/voice/create-voice-host.ts
@@ -3,13 +3,13 @@ import { MicRecorder } from '@/core/capture/voice/mic-recorder';
import { EMPTY_NARRATION, narrateRecording, type VoiceRecording } from '@/core/capture/voice/narrate-recording';
import { partialRecording } from '@/core/capture/voice/partial-recording';
import type { TranscriptionSettings } from '@/core/capture/voice/read-transcription-settings';
+import { startFailureReason } from '@/core/capture/voice/start-failure-reason';
import type { NarrationResult } from '@/core/capture/voice/types';
import { usableRecording } from '@/core/capture/voice/usable-recording';
import { getExtensionURL } from '../browser-api/get-extension-url';
import { sendMessage } from '../browser-api/send-message';
import { describeError } from './describe-error';
import { permissionState } from './permission-state';
-import { startFailureReason } from './start-failure-reason';
import {
VOICE_BACKGROUND_TARGET,
VOICE_SIDEPANEL_TARGET,
diff --git a/src/lib/voice/voice-message.ts b/src/lib/voice/voice-message.ts
index 4e73fc0..8158a54 100644
--- a/src/lib/voice/voice-message.ts
+++ b/src/lib/voice/voice-message.ts
@@ -1,5 +1,6 @@
import type { VoiceProvider } from '@/core/capture/voice/transcribe';
import type { NarrationResult } from '@/core/capture/voice/types';
+import type { VoiceErrorReason } from '@/core/capture/voice/voice-update';
export const VOICE_OFFSCREEN_TARGET = 'mimik-offscreen';
export const VOICE_BACKGROUND_TARGET = 'mimik-background';
@@ -27,17 +28,6 @@ export const VoiceMessage = {
export type VoiceMessageType = (typeof VoiceMessage)[keyof typeof VoiceMessage];
-export type VoiceErrorReason =
- | 'permission-denied'
- | 'no-device'
- | 'no-audio'
- | 'not-recording'
- | 'already-recording'
- | 'missing-api-key'
- | 'stream-ended'
- | 'unsupported'
- | 'unknown';
-
export interface VoiceEnvelope {
type: VoiceMessageType;
target: VoiceTarget;
diff --git a/src/ui/fullview/App.tsx b/src/ui/fullview/App.tsx
index 3cf984a..b0a8f2c 100644
--- a/src/ui/fullview/App.tsx
+++ b/src/ui/fullview/App.tsx
@@ -2,7 +2,7 @@ import { AppFrame, GuideContent, LibraryContent, SearchModal, TooltipProvider, u
import { browser } from '#imports';
import { openSidebar } from '@/lib/browser-api/open-sidebar';
import { UpdateNotice } from '@/ui/shared/UpdateNotice';
-import { VoiceNotice } from './components/VoiceNotice';
+import { BackgroundVoiceNotice } from './components/BackgroundVoiceNotice';
export function FullViewApp() {
const route = useRoute();
@@ -36,7 +36,7 @@ export function FullViewApp() {
</main>
)}
- {import.meta.env.BROWSER !== 'firefox' && <VoiceNotice />}
+ {import.meta.env.BROWSER !== 'firefox' && <BackgroundVoiceNotice />}
</AppFrame>
</TooltipProvider>
);
diff --git a/src/ui/fullview/components/BackgroundVoiceNotice.tsx b/src/ui/fullview/components/BackgroundVoiceNotice.tsx
new file mode 100644
index 0000000..ba89057
--- /dev/null
+++ b/src/ui/fullview/components/BackgroundVoiceNotice.tsx
@@ -0,0 +1,8 @@
+import { VoiceNotice } from '@mimik/ui';
+import { browser } from '#imports';
+import { useBackgroundVoice } from '../hooks/use-background-voice';
+
+export function BackgroundVoiceNotice() {
+ const { update, seenLive } = useBackgroundVoice();
+ return <VoiceNotice update={update} seenLive={seenLive} onOpenSettings={() => browser.runtime.openOptionsPage()} />;
+}
diff --git a/src/ui/fullview/hooks/use-background-voice.ts b/src/ui/fullview/hooks/use-background-voice.ts
new file mode 100644
index 0000000..e40aa1f
--- /dev/null
+++ b/src/ui/fullview/hooks/use-background-voice.ts
@@ -0,0 +1,47 @@
+import type { VoiceUpdate } from '@mimik/core/capture/voice/voice-update';
+import { useEffect, useState } from 'react';
+import { getVoiceStatus } from '@/lib/offscreen/get-voice-status';
+import { observeVoiceFromBackground } from '@/lib/port/observe-voice-from-background';
+
+export function useBackgroundVoice(): { update: VoiceUpdate; seenLive: boolean } {
+ const [update, setUpdate] = useState<VoiceUpdate>({ phase: 'idle' });
+ const [seenLive, setSeenLive] = useState(false);
+
+ useEffect(() => {
+ let stop: (() => void) | null = null;
+
+ const receive = (next: VoiceUpdate) => {
+ if (next.phase !== 'idle') setSeenLive(true);
+ setUpdate(next);
+ };
+
+ const resync = () => {
+ getVoiceStatus()
+ .then((status) => {
+ if (!status?.transcribing) return;
+ setSeenLive(true);
+ setUpdate({ phase: 'transcribing' });
+ })
+ .catch(() => undefined);
+ };
+
+ const follow = () => {
+ if (document.visibilityState === 'visible') {
+ stop ??= observeVoiceFromBackground(receive, resync);
+ return;
+ }
+ stop?.();
+ stop = null;
+ };
+
+ follow();
+ document.addEventListener('visibilitychange', follow);
+
+ return () => {
+ document.removeEventListener('visibilitychange', follow);
+ stop?.();
+ };
+ }, []);
+
+ return { update, seenLive };
+}
diff --git a/src/ui/fullview/lib/voice-signature.ts b/src/ui/fullview/lib/voice-signature.ts
deleted file mode 100644
index 4d30bda..0000000
--- a/src/ui/fullview/lib/voice-signature.ts
+++ /dev/null
@@ -1,5 +0,0 @@
-import type { PanelVoiceUpdate } from '@/lib/port/types';
-
-export function voiceSignature(update: PanelVoiceUpdate): string {
- return `${update.phase}:${update.reason ?? ''}:${update.narrated ?? ''}`;
-}
diff --git a/src/ui/sidepanel/VoiceStatus.tsx b/src/ui/sidepanel/VoiceStatus.tsx
index 204bef5..91aad3a 100644
--- a/src/ui/sidepanel/VoiceStatus.tsx
+++ b/src/ui/sidepanel/VoiceStatus.tsx
@@ -1,7 +1,7 @@
import { TriangleAlert } from 'lucide-react';
import { i18n } from '#imports';
+import { voiceErrorKey } from '@/core/capture/voice/voice-error-key';
import type { PanelVoiceUpdate } from '@/lib/port/types';
-import { voiceErrorKey } from './lib/voice-error-key';
import { MicMeter } from './MicMeter';
interface VoiceStatusProps {
diff --git a/src/ui/sidepanel/VoiceToast.tsx b/src/ui/sidepanel/VoiceToast.tsx
index 81b1fce..35edd37 100644
--- a/src/ui/sidepanel/VoiceToast.tsx
+++ b/src/ui/sidepanel/VoiceToast.tsx
@@ -2,10 +2,10 @@ import { Tooltip, TooltipContent, TooltipTrigger } from '@mimik/ui';
import { Check, Loader2, TriangleAlert, X } from 'lucide-react';
import { useEffect, useState } from 'react';
import { i18n } from '#imports';
+import { narratedKey } from '@/core/capture/voice/narrated-key';
+import { voiceErrorKey } from '@/core/capture/voice/voice-error-key';
+import { voiceSignature } from '@/core/capture/voice/voice-signature';
import type { PanelVoiceUpdate } from '@/lib/port/types';
-import { voiceSignature } from '@/ui/fullview/lib/voice-signature';
-import { narratedKey } from './lib/narrated-key';
-import { voiceErrorKey } from './lib/voice-error-key';
const CONFIRM_MS = 7000;
diff --git a/src/ui/sidepanel/__tests__/voice-status.test.ts b/src/ui/sidepanel/__tests__/voice-status.test.ts
index 69523a6..f3eda62 100644
--- a/src/ui/sidepanel/__tests__/voice-status.test.ts
+++ b/src/ui/sidepanel/__tests__/voice-status.test.ts
@@ -1,12 +1,12 @@
import { readFileSync } from 'node:fs';
import { join } from 'node:path';
import { describe, expect, it } from 'vitest';
-import type { VoiceErrorReason } from '@/lib/voice/voice-message';
+import { narratedKey } from '@/core/capture/voice/narrated-key';
+import { voiceErrorKey } from '@/core/capture/voice/voice-error-key';
+import type { VoiceErrorReason } from '@/core/capture/voice/voice-update';
import { LEVEL_STALE_MS, MIC_ACTIVITIES, micActivity, SPEAKING_HOLD_MS } from '../lib/mic-activity';
import { micActivityKey } from '../lib/mic-activity-key';
import { MIC_BAR_MIN_SCALE, MIC_BARS, micBarScale } from '../lib/mic-bar-scale';
-import { narratedKey } from '../lib/narrated-key';
-import { voiceErrorKey } from '../lib/voice-error-key';
const LOCALES = ['en', 'es', 'fr', 'pt-BR', 'zh-CN'];