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

fix(export): render docx screenshots through the annotation pipeline

Luis Ortiz4ba4e9bfd75f
diff --git a/src/core/export/__tests__/docx-export.test.ts b/src/core/export/__tests__/docx-export.test.ts
index cd42be5..170c900 100644
--- a/src/core/export/__tests__/docx-export.test.ts
+++ b/src/core/export/__tests__/docx-export.test.ts
@@ -1,9 +1,13 @@
// @vitest-environment jsdom
import { strFromU8, unzipSync } from 'fflate';
-import { describe, expect, it } from 'vitest';
+import { describe, expect, it, vi } from 'vitest';
import { exportGuideAsDOCX, fitDocxImageSize } from '@/core/export/docx-export';
import type { Guide, Screenshot, Step } from '@/core/guides/types';
+const rendered = vi.hoisted(() => vi.fn(async () => new Blob(['rendered'], { type: 'image/png' })));
+
+vi.mock('@/core/screenshot/render', () => ({ renderScreenshot: rendered }));
+
function makeGuide(overrides: Partial<Guide> = {}): Guide {
return {
id: 'guide-1',
@@ -97,6 +101,46 @@ describe('exportGuideAsDOCX', () => {
expect(Object.keys(files).some((name) => name.startsWith('word/media/'))).toBe(false);
});
+
+ it('embeds the rendered screenshot so annotations and redactions are applied', async () => {
+ rendered.mockClear();
+ const step = makeStep();
+ const screenshot = makeScreenshot(step.id, 'raw-pixels');
+ screenshot.edits = {
+ annotations: [{ id: 'r1', type: 'redact', x: 0, y: 0, w: 10, h: 10, style: 'solid' }],
+ };
+
+ const blob = await exportGuideAsDOCX(makeGuide(), [step], new Map([[step.id, screenshot]]));
+ const files = await unzipDocx(blob);
+ const media = Object.keys(files).filter((name) => name.startsWith('word/media/') && files[name].length > 0);
+
+ expect(rendered).toHaveBeenCalledWith(screenshot, expect.objectContaining({ format: 'image/png' }));
+ expect(media).toHaveLength(1);
+ expect(strFromU8(files[media[0]])).toBe('rendered');
+ });
+
+ it('sizes the image from the cropped viewport, not the original bitmap', async () => {
+ const step = makeStep();
+ const screenshot = makeScreenshot(step.id);
+ screenshot.edits = { viewport: { x: 0, y: 0, width: 400, height: 100 } };
+
+ const xml = await readDocumentXml(await exportGuideAsDOCX(makeGuide(), [step], new Map([[step.id, screenshot]])));
+
+ const extent = xml.match(/<wp:extent cx="(\d+)" cy="(\d+)"/);
+ expect(extent).not.toBeNull();
+ expect(Number(extent?.[1]) / Number(extent?.[2])).toBeCloseTo(4, 1);
+ });
+
+ it('embeds screenshots whose stored mime type is not natively supported by docx', async () => {
+ const step = makeStep();
+ const screenshot = makeScreenshot(step.id);
+ screenshot.mimeType = 'image/webp';
+
+ const blob = await exportGuideAsDOCX(makeGuide(), [step], new Map([[step.id, screenshot]]));
+ const files = await unzipDocx(blob);
+
+ expect(Object.keys(files).some((name) => name.startsWith('word/media/'))).toBe(true);
+ });
});
describe('fitDocxImageSize', () => {
diff --git a/src/core/export/docx-export.ts b/src/core/export/docx-export.ts
index 5a5daef..65a3944 100644
--- a/src/core/export/docx-export.ts
+++ b/src/core/export/docx-export.ts
@@ -25,10 +25,10 @@ import { type ExportOptions, IMAGE_SCALE_FACTORS, loadExportOptions } from '@/co
import { blobToArrayBuffer, extractDomain, formatDate } from '@/core/export/utils';
import { actionSteps, calloutAccent, isBlock, stepNumbers, tint } from '@/core/guides/blocks';
import type { Guide, Screenshot, Step } from '@/core/guides/types';
+import { resolveViewport } from '@/core/screenshot/geometry';
+import { renderScreenshot } from '@/core/screenshot/render';
import { logger } from '@/lib/logger';
-type SupportedDocxImageType = 'bmp' | 'gif' | 'jpg' | 'png';
-
const DOCX_MAX_IMAGE_WIDTH = 520;
const DOCX_MAX_IMAGE_HEIGHT = 640; // px @ 96dpi, fits one page after margins
const DOCX_STEP_INDENT = 900;
@@ -219,47 +219,24 @@ function buildCover(guide: Guide, steps: Step[], domain: string | null, brand: B
return [head, rule, meta];
}
-function getDocxImageType(mimeType: string): SupportedDocxImageType | null {
- switch (mimeType) {
- case 'image/png':
- return 'png';
- case 'image/jpeg':
- case 'image/jpg':
- return 'jpg';
- case 'image/gif':
- return 'gif';
- case 'image/bmp':
- return 'bmp';
- default:
- return null;
- }
-}
-
async function buildImageParagraph(
screenshot: Screenshot,
stepIndex: number,
scale: number,
): Promise<Paragraph | null> {
- const imageType = getDocxImageType(screenshot.mimeType);
- if (!imageType) {
- logger.warn('DOCX: unsupported screenshot mime type', screenshot.mimeType, 'for step', stepIndex);
- return null;
- }
-
try {
- const arrayBuffer = await blobToArrayBuffer(screenshot.blob);
- const fitted = fitDocxImageSize(screenshot.width, screenshot.height, DOCX_STEP_INDENT / 2);
+ const arrayBuffer = await blobToArrayBuffer(await renderScreenshot(screenshot, { format: 'image/png' }));
+ const viewport = resolveViewport(screenshot);
+ const fitted = fitDocxImageSize(viewport.width, viewport.height, DOCX_STEP_INDENT / 2);
const width = Math.max(1, Math.round(fitted.width * scale));
const height = Math.max(1, Math.round(fitted.height * scale));
return new Paragraph({
alignment: AlignmentType.LEFT,
- children: [
- new ImageRun({ type: imageType, data: new Uint8Array(arrayBuffer), transformation: { width, height } }),
- ],
+ children: [new ImageRun({ type: 'png', data: new Uint8Array(arrayBuffer), transformation: { width, height } })],
});
} catch (err) {
- logger.warn('DOCX: failed to load screenshot for step', stepIndex, err);
+ logger.warn('DOCX: failed to render screenshot for step', stepIndex, err);
return null;
}
}