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(export): add step caption and video resolution options

Luis Ortiz118918daea79
diff --git a/src/core/export/__tests__/options.test.ts b/src/core/export/__tests__/options.test.ts
index 96e5f28..0ca6e18 100644
--- a/src/core/export/__tests__/options.test.ts
+++ b/src/core/export/__tests__/options.test.ts
@@ -27,9 +27,21 @@ describe('normaliseExportOptions', () => {
screenshots: DEFAULT_EXPORT_OPTIONS.screenshots,
stepUrls: DEFAULT_EXPORT_OPTIONS.stepUrls,
imageScale: 'small',
+ stepDescriptions: DEFAULT_EXPORT_OPTIONS.stepDescriptions,
+ resolution: DEFAULT_EXPORT_OPTIONS.resolution,
});
});
+ it('rejects an unknown resolution so the encoder never gets bogus dimensions', () => {
+ expect(normaliseExportOptions({ resolution: '4k' }).resolution).toBe(DEFAULT_EXPORT_OPTIONS.resolution);
+ expect(normaliseExportOptions({ resolution: '1080p' }).resolution).toBe('1080p');
+ });
+
+ it('keeps step captions on unless they are explicitly turned off', () => {
+ expect(normaliseExportOptions({ stepDescriptions: 'no' }).stepDescriptions).toBe(true);
+ expect(normaliseExportOptions({ stepDescriptions: false }).stepDescriptions).toBe(false);
+ });
+
it('rejects an unknown image scale so no exporter can derive a NaN width', () => {
const result = normaliseExportOptions({ imageScale: 'enormous' });
expect(result.imageScale).toBe(DEFAULT_EXPORT_OPTIONS.imageScale);
diff --git a/src/core/export/options.ts b/src/core/export/options.ts
index 6b4254e..d6b218c 100644
--- a/src/core/export/options.ts
+++ b/src/core/export/options.ts
@@ -8,11 +8,17 @@ export const IMAGE_SCALE_FACTORS: Record<ImageScale, number> = {
large: 1,
};
+export type VideoResolution = '720p' | '1080p';
+
+export const VIDEO_RESOLUTIONS: VideoResolution[] = ['720p', '1080p'];
+
export interface ExportOptions {
cover: boolean;
screenshots: boolean;
stepUrls: boolean;
imageScale: ImageScale;
+ stepDescriptions: boolean;
+ resolution: VideoResolution;
}
export const DEFAULT_EXPORT_OPTIONS: ExportOptions = {
@@ -20,6 +26,8 @@ export const DEFAULT_EXPORT_OPTIONS: ExportOptions = {
screenshots: true,
stepUrls: true,
imageScale: 'medium',
+ stepDescriptions: true,
+ resolution: '720p',
};
const bool = (value: unknown, fallback: boolean) => (typeof value === 'boolean' ? value : fallback);
@@ -33,6 +41,10 @@ export function normaliseExportOptions(value: unknown): ExportOptions {
stepUrls: bool(raw.stepUrls, DEFAULT_EXPORT_OPTIONS.stepUrls),
imageScale:
raw.imageScale && raw.imageScale in IMAGE_SCALE_FACTORS ? raw.imageScale : DEFAULT_EXPORT_OPTIONS.imageScale,
+ stepDescriptions: bool(raw.stepDescriptions, DEFAULT_EXPORT_OPTIONS.stepDescriptions),
+ resolution: VIDEO_RESOLUTIONS.includes(raw.resolution as VideoResolution)
+ ? (raw.resolution as VideoResolution)
+ : DEFAULT_EXPORT_OPTIONS.resolution,
};
}