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(core): move the microphone recorder and narration runner into core

Luis Ortizca7db93b9ff3
diff --git a/src/lib/voice/concat.ts b/packages/core/src/capture/voice/concat.ts
similarity index 100%
rename from src/lib/voice/concat.ts
rename to packages/core/src/capture/voice/concat.ts
diff --git a/src/lib/voice/mic-recorder.ts b/packages/core/src/capture/voice/mic-recorder.ts
similarity index 98%
rename from src/lib/voice/mic-recorder.ts
rename to packages/core/src/capture/voice/mic-recorder.ts
index cb013b8..227a299 100644
--- a/src/lib/voice/mic-recorder.ts
+++ b/packages/core/src/capture/voice/mic-recorder.ts
@@ -1,5 +1,5 @@
-import { SPEECH_RMS_THRESHOLD } from '@/core/capture/voice/energy-gate';
import { concat } from './concat';
+import { SPEECH_RMS_THRESHOLD } from './energy-gate';
import { openStream } from './open-stream';
export const TARGET_SAMPLE_RATE = 16000;
diff --git a/src/lib/voice/narrate-recording.ts b/packages/core/src/capture/voice/narrate-recording.ts
similarity index 71%
rename from src/lib/voice/narrate-recording.ts
rename to packages/core/src/capture/voice/narrate-recording.ts
index 978d8cd..8eeb8dc 100644
--- a/src/lib/voice/narrate-recording.ts
+++ b/packages/core/src/capture/voice/narrate-recording.ts
@@ -1,11 +1,11 @@
-import { logger } from '@mimik/core/logger';
-import { detectSpeechByEnergy } from '@/core/capture/voice/energy-gate';
-import { runNarrationPipeline } from '@/core/capture/voice/pipeline';
-import { buildStepWindows } from '@/core/capture/voice/step-windows';
-import { createTranscriber } from '@/core/capture/voice/transcribe';
-import type { NarrationResult } from '@/core/capture/voice/types';
+import { logger } from '@/core/logger';
+import { detectSpeechByEnergy } from './energy-gate';
+import { runNarrationPipeline } from './pipeline';
import type { TranscriptionSettings } from './read-transcription-settings';
-import type { VoiceStepMark } from './voice-message';
+import type { StepMark } from './step-windows';
+import { buildStepWindows } from './step-windows';
+import { createTranscriber } from './transcribe';
+import type { NarrationResult } from './types';
export interface VoiceRecording {
pcm: Int16Array;
@@ -30,7 +30,7 @@ export const EMPTY_NARRATION: NarrationResult = {
export async function narrateRecording(
recording: VoiceRecording,
- steps: VoiceStepMark[],
+ steps: StepMark[],
settings: TranscriptionSettings,
): Promise<NarrationResult> {
try {
diff --git a/src/lib/voice/open-stream.ts b/packages/core/src/capture/voice/open-stream.ts
similarity index 100%
rename from src/lib/voice/open-stream.ts
rename to packages/core/src/capture/voice/open-stream.ts
diff --git a/src/lib/voice/read-transcription-settings.ts b/packages/core/src/capture/voice/read-transcription-settings.ts
similarity index 71%
rename from src/lib/voice/read-transcription-settings.ts
rename to packages/core/src/capture/voice/read-transcription-settings.ts
index fdbb932..f8c20aa 100644
--- a/src/lib/voice/read-transcription-settings.ts
+++ b/packages/core/src/capture/voice/read-transcription-settings.ts
@@ -1,6 +1,6 @@
-import { resolveVoiceApiKey, VOICE_KEY_SETTINGS } from '@/core/capture/voice/api-key';
-import type { VoiceProvider } from '@/core/capture/voice/transcribe';
-import { localStorage } from '../browser-api/local-storage';
+import { localStorage } from '@/core/env';
+import { resolveVoiceApiKey, VOICE_KEY_SETTINGS } from './api-key';
+import type { VoiceProvider } from './transcribe';
export interface TranscriptionSettings {
provider: VoiceProvider;
diff --git a/packages/core/src/capture/voice/transcribe.ts b/packages/core/src/capture/voice/transcribe.ts
index 92640b2..f76e024 100644
--- a/packages/core/src/capture/voice/transcribe.ts
+++ b/packages/core/src/capture/voice/transcribe.ts
@@ -1,3 +1,4 @@
+import { coreFetch } from '@/core/env';
import type { TranscriptionResponse } from './types';
export type VoiceProvider = 'openai' | 'groq';
@@ -28,7 +29,7 @@ export function createTranscriber(config: TranscribeConfig): (wav: Blob) => Prom
form.append('temperature', '0');
if (config.language) form.append('language', config.language);
- const response = await fetch(url, {
+ const response = await coreFetch(url, {
method: 'POST',
headers: { Authorization: `Bearer ${config.apiKey}` },
body: form,
diff --git a/src/lib/voice/usable-recording.ts b/packages/core/src/capture/voice/usable-recording.ts
similarity index 100%
rename from src/lib/voice/usable-recording.ts
rename to packages/core/src/capture/voice/usable-recording.ts
diff --git a/src/entrypoints/background/__tests__/narration-settle.test.ts b/src/entrypoints/background/__tests__/narration-settle.test.ts
index cd98a05..4ce2eb8 100644
--- a/src/entrypoints/background/__tests__/narration-settle.test.ts
+++ b/src/entrypoints/background/__tests__/narration-settle.test.ts
@@ -37,10 +37,10 @@ vi.mock('@/lib/browser-api/on-message', () => ({ onMessage: vi.fn() }));
vi.mock('@/lib/port/broadcast-voice-to-panel', () => ({ broadcastVoiceToPanel: vi.fn() }));
-vi.mock('@/lib/voice/read-transcription-settings', () => ({
+vi.mock('@/core/capture/voice/read-transcription-settings', () => ({
readTranscriptionSettings: () => Promise.resolve({ provider: 'openai', apiKey: 'sk-test' }),
}));
-vi.mock('@/lib/voice/narrate-recording', () => ({ narrateRecording: vi.fn() }));
+vi.mock('@/core/capture/voice/narrate-recording', () => ({ narrateRecording: vi.fn() }));
const getStepsForGuide = vi.fn();
diff --git a/src/entrypoints/background/voice.ts b/src/entrypoints/background/voice.ts
index 2c4c0a4..b25858b 100644
--- a/src/entrypoints/background/voice.ts
+++ b/src/entrypoints/background/voice.ts
@@ -1,7 +1,9 @@
import { logger } from '@mimik/core/logger';
import { CaptureState } from '@/core/capture/machine';
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 { 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';
@@ -22,8 +24,6 @@ import type { PanelVoiceUpdate, VoicePhase } 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';
-import { narrateRecording, type VoiceRecording } from '@/lib/voice/narrate-recording';
-import { readTranscriptionSettings } from '@/lib/voice/read-transcription-settings';
import {
VOICE_BACKGROUND_TARGET,
type VoiceErrorEvent,
diff --git a/src/lib/voice/__tests__/voice-host-final.test.ts b/src/lib/voice/__tests__/voice-host-final.test.ts
index b318cd4..0179b1e 100644
--- a/src/lib/voice/__tests__/voice-host-final.test.ts
+++ b/src/lib/voice/__tests__/voice-host-final.test.ts
@@ -16,7 +16,7 @@ const recorderState = {
durationSeconds: 1,
};
-vi.mock('../mic-recorder', () => ({
+vi.mock('@/core/capture/voice/mic-recorder', () => ({
MicRecorder: class {
get recording() {
return recorderState.recording;
@@ -49,8 +49,8 @@ vi.mock('../mic-recorder', () => ({
},
}));
-vi.mock('../narrate-recording', async (importOriginal) => {
- const actual = await importOriginal<typeof import('../narrate-recording')>();
+vi.mock('@/core/capture/voice/narrate-recording', async (importOriginal) => {
+ const actual = await importOriginal<typeof import('@/core/capture/voice/narrate-recording')>();
return { ...actual, narrateRecording: (...args: unknown[]) => narrateRecording(...args) };
});
diff --git a/src/lib/voice/create-voice-host.ts b/src/lib/voice/create-voice-host.ts
index 1fb774c..dcd1209 100644
--- a/src/lib/voice/create-voice-host.ts
+++ b/src/lib/voice/create-voice-host.ts
@@ -1,15 +1,15 @@
import { logger } from '@mimik/core/logger';
+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 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 { MicRecorder } from './mic-recorder';
-import { EMPTY_NARRATION, narrateRecording, type VoiceRecording } from './narrate-recording';
import { permissionState } from './permission-state';
-import type { TranscriptionSettings } from './read-transcription-settings';
import { startFailureReason } from './start-failure-reason';
-import { usableRecording } from './usable-recording';
import {
VOICE_BACKGROUND_TARGET,
VOICE_SIDEPANEL_TARGET,