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 πŸ“–

feat: Guide Me session manager and background message handlers

Luis Ortiz42ce0e709526
diff --git a/src/core/guideme/session.ts b/src/core/guideme/session.ts
new file mode 100644
index 0000000..97da6af
--- /dev/null
+++ b/src/core/guideme/session.ts
@@ -0,0 +1,48 @@
+import type { Step } from '@/core/guides/types';
+import { localStorage } from '@/lib/browser-api';
+
+export interface GuideMeSession {
+ guideId: string;
+ stepIndex: number;
+ totalSteps: number;
+ active: boolean;
+}
+
+const SESSION_KEY = 'guideMeSession';
+const STEP_KEY = 'guideMeStep';
+
+export async function startSession(guideId: string, totalSteps: number, firstStep: Step): Promise<void> {
+ const session: GuideMeSession = { guideId, stepIndex: 0, totalSteps, active: true };
+ await localStorage.set({ [SESSION_KEY]: session, [STEP_KEY]: firstStep });
+}
+
+export async function advanceSession(nextStep: Step, nextIndex: number): Promise<void> {
+ const data = await localStorage.get([SESSION_KEY]);
+ const session = data[SESSION_KEY] as GuideMeSession | undefined;
+ if (!session || !session.active) return;
+ await localStorage.set({
+ [SESSION_KEY]: { ...session, stepIndex: nextIndex },
+ [STEP_KEY]: nextStep,
+ });
+}
+
+export async function completeSession(): Promise<void> {
+ const data = await localStorage.get([SESSION_KEY]);
+ const session = data[SESSION_KEY] as GuideMeSession | undefined;
+ if (!session) return;
+ await localStorage.set({
+ [SESSION_KEY]: { ...session, active: false },
+ [STEP_KEY]: null,
+ });
+}
+
+export async function cancelSession(): Promise<void> {
+ await localStorage.set({ [SESSION_KEY]: null, [STEP_KEY]: null });
+}
+
+export async function getSession(): Promise<GuideMeSession | null> {
+ const data = await localStorage.get([SESSION_KEY]);
+ return (data[SESSION_KEY] as GuideMeSession) || null;
+}
+
+export { SESSION_KEY, STEP_KEY };
diff --git a/src/entrypoints/background/index.ts b/src/entrypoints/background/index.ts
index 0ee8108..46f0a36 100644
--- a/src/entrypoints/background/index.ts
+++ b/src/entrypoints/background/index.ts
@@ -1,7 +1,8 @@
import { defineBackground } from '#imports';
import { generateGuideTitle } from '@/core/capture/ai/title';
+import { advanceSession, cancelSession, completeSession, startSession } from '@/core/guideme/session';
import { createGuide, getStepsForGuide, saveRrwebChunk, updateGuideTitle } from '@/core/guides/service';
-import { getActiveTab, localStorage, setSidePanelBehavior } from '@/lib/browser-api';
+import { getActiveTab, localStorage, setSidePanelBehavior, updateTab } from '@/lib/browser-api';
import { logger } from '@/lib/logger';
import { onMessage } from '@/lib/messaging';
import { broadcastStateToPanel, setupPortListener } from '@/lib/port';
@@ -110,4 +111,70 @@ export default defineBackground(() => {
});
return { stored: true };
});
+
+ onMessage('startGuideMe', async ({ data }) => {
+ const steps = await getStepsForGuide(data.guideId);
+ if (steps.length === 0) return { started: false, error: 'No steps' };
+
+ const firstStep = steps[0];
+ if (!firstStep.elementMeta) return { started: false, error: 'Guide lacks element metadata' };
+
+ await startSession(data.guideId, steps.length, firstStep);
+
+ const activeTab = await getActiveTab();
+ if (activeTab?.id && firstStep.url) {
+ await updateTab(activeTab.id, { url: firstStep.url });
+ }
+
+ return { started: true };
+ });
+
+ onMessage('guideMeStepCompleted', async ({ data }) => {
+ const sessionData = await localStorage.get(['guideMeSession']);
+ const session = sessionData.guideMeSession as { guideId: string } | undefined;
+ if (!session) return { advanced: false };
+
+ const steps = await getStepsForGuide(session.guideId);
+ const nextIndex = data.stepIndex + 1;
+
+ if (nextIndex >= steps.length) {
+ await completeSession();
+ return { advanced: true, completed: true };
+ }
+
+ const nextStep = steps[nextIndex];
+ await advanceSession(nextStep, nextIndex);
+
+ const currentTab = await getActiveTab();
+ if (currentTab?.id && nextStep.url && nextStep.url !== currentTab.url) {
+ await updateTab(currentTab.id, { url: nextStep.url });
+ }
+
+ return { advanced: true };
+ });
+
+ onMessage('guideMeCancel', async () => {
+ await cancelSession();
+ return { cancelled: true };
+ });
+
+ onMessage('guideMePrev', async ({ data }) => {
+ if (data.stepIndex <= 0) return { moved: false };
+
+ const sessionData = await localStorage.get(['guideMeSession']);
+ const session = sessionData.guideMeSession as { guideId: string } | undefined;
+ if (!session) return { moved: false };
+
+ const steps = await getStepsForGuide(session.guideId);
+ const prevIndex = data.stepIndex - 1;
+ const prevStep = steps[prevIndex];
+ await advanceSession(prevStep, prevIndex);
+
+ const currentTab = await getActiveTab();
+ if (currentTab?.id && prevStep.url && prevStep.url !== currentTab.url) {
+ await updateTab(currentTab.id, { url: prevStep.url });
+ }
+
+ return { moved: true };
+ });
});
diff --git a/src/lib/messaging.ts b/src/lib/messaging.ts
index e5393d4..d3d641d 100644
--- a/src/lib/messaging.ts
+++ b/src/lib/messaging.ts
@@ -61,6 +61,36 @@ export interface RrwebChunkResponse {
stored: boolean;
}
+export interface StartGuideMeData {
+ guideId: string;
+}
+
+export interface StartGuideMeResponse {
+ started: boolean;
+ error?: string;
+}
+
+export interface GuideMeStepCompletedData {
+ stepIndex: number;
+}
+
+export interface GuideMeStepCompletedResponse {
+ advanced: boolean;
+ completed?: boolean;
+}
+
+export interface GuideMe_CancelResponse {
+ cancelled: boolean;
+}
+
+export interface GuideMe_PrevData {
+ stepIndex: number;
+}
+
+export interface GuideMe_PrevResponse {
+ moved: boolean;
+}
+
interface MimikProtocol {
getState(): GetStateResponse;
startRecording(data: StartRecordingData): StartRecordingResponse;
@@ -69,6 +99,10 @@ interface MimikProtocol {
updateInputStep(data: UpdateInputStepData): UpdateInputStepResponse;
finalizeInputStep(data: FinalizeInputStepData): FinalizeInputStepResponse;
rrwebChunk(data: RrwebChunkData): RrwebChunkResponse;
+ startGuideMe(data: StartGuideMeData): StartGuideMeResponse;
+ guideMeStepCompleted(data: GuideMeStepCompletedData): GuideMeStepCompletedResponse;
+ guideMeCancel(): GuideMe_CancelResponse;
+ guideMePrev(data: GuideMe_PrevData): GuideMe_PrevResponse;
}
export const { sendMessage, onMessage } = defineExtensionMessaging<MimikProtocol>();