heroshot 0.17.0 → 0.18.0

package/README.md

@@ -1,22 +1,22 @@
 <p align="center">
-  <a href="https://heroshot.sh">
+  <a href="https://heroshot.dev">
     <picture>
       <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/omachala/heroshot/refs/heads/main/docs/public/screenshots/hero-desktop-dark.png">
       <img src="https://raw.githubusercontent.com/omachala/heroshot/refs/heads/main/docs/public/screenshots/hero-desktop-light.png" alt="heroshot">
     </picture>
   </a>
 </p>
-<p align="center"><em>👆 This hero shot of <a href="https://heroshot.sh">heroshot.sh</a> is <a href="https://github.com/omachala/heroshot/blob/main/.github/workflows/update-screenshots.yml#L17">taken</a> by heroshot ⚡️</em></p>
+<p align="center"><em>👆 This hero shot of <a href="https://heroshot.dev">heroshot.dev</a> is <a href="https://github.com/omachala/heroshot/blob/main/.github/workflows/update-screenshots.yml#L17">taken</a> by heroshot ⚡️</em></p>
 
 <p align="center">
   <a href="https://www.npmjs.com/package/heroshot"><img src="https://img.shields.io/npm/dt/heroshot?style=for-the-badge" alt="npm downloads"></a>
   <a href="https://www.npmjs.com/package/heroshot"><img src="https://img.shields.io/npm/v/heroshot?style=for-the-badge&logo=npm" alt="npm version"></a>
   <a href="https://codecov.io/gh/omachala/heroshot"><img src="https://img.shields.io/codecov/c/github/omachala/heroshot?style=for-the-badge" alt="coverage"></a>
   <a href="https://sonarcloud.io/summary/new_code?id=omachala_heroshot"><img src="https://img.shields.io/sonar/quality_gate/omachala_heroshot?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge&logo=sonarcloud" alt="quality gate"></a>
-  <a href="https://heroshot.sh"><img src="https://img.shields.io/badge/docs-heroshot.sh-blue?style=for-the-badge" alt="docs"></a>
+  <a href="https://heroshot.dev"><img src="https://img.shields.io/badge/docs-heroshot.dev-blue?style=for-the-badge" alt="docs"></a>
 </p>
 
-<p align="center">Like Heroshot? Share your story — <a href="https://x.com/intent/tweet?url=https%3A%2F%2Fheroshot.sh">X/Twitter</a> · <a href="https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fheroshot.sh">LinkedIn</a> · <a href="https://www.reddit.com/submit?url=https%3A%2F%2Fheroshot.sh&title=Heroshot%20%E2%80%93%20Define%20screenshots%20once%2C%20update%20them%20forever">Reddit</a> ❤️</p>
+<p align="center">Like Heroshot? Share your story — <a href="https://x.com/intent/tweet?url=https%3A%2F%2Fheroshot.dev">X/Twitter</a> · <a href="https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fheroshot.dev">LinkedIn</a> · <a href="https://www.reddit.com/submit?url=https%3A%2F%2Fheroshot.dev&title=Heroshot%20%E2%80%93%20Define%20screenshots%20once%2C%20update%20them%20forever">Reddit</a> ❤️</p>
 
 Your app changes constantly. New features, design tweaks, bug fixes. Meanwhile, the screenshots in your README and docs quietly become lies.
 
@@ -36,7 +36,7 @@ First run opens a browser with a visual editor. Pick elements, adjust padding, s
 
 ## Use in Your Docs
 
-**VitePress** · [Full guide](https://heroshot.sh/docs/integrations/vitepress)
+**VitePress** · [Full guide](https://heroshot.dev/docs/integrations/vitepress)
 
 ```ts
 // .vitepress/config.ts
@@ -52,7 +52,7 @@ import { Heroshot } from 'heroshot/vue';
 <Heroshot name="dashboard" alt="Dashboard" />
 ```
 
-**Docusaurus** · [Full guide](https://heroshot.sh/docs/integrations/docusaurus)
+**Docusaurus** · [Full guide](https://heroshot.dev/docs/integrations/docusaurus)
 
 ```js
 // docusaurus.config.js
@@ -64,7 +64,7 @@ import { Heroshot } from 'heroshot/docusaurus';
 <Heroshot name="dashboard" alt="Dashboard" />;
 ```
 
-**MkDocs** · [Full guide](https://heroshot.sh/docs/integrations/mkdocs)
+**MkDocs** · [Full guide](https://heroshot.dev/docs/integrations/mkdocs)
 
 ```yaml
 # mkdocs.yml
@@ -100,13 +100,13 @@ One component/macro, all variants - light/dark mode switches automatically, resp
 
 ## Learn More
 
-|                     |                                                                       |
-| ------------------- | --------------------------------------------------------------------- |
-| **Documentation**   | [heroshot.sh](https://heroshot.sh)                                    |
-| **Getting Started** | [Quick start guide](https://heroshot.sh/docs/getting-started)         |
-| **Configuration**   | [Config options](https://heroshot.sh/docs/config)                     |
-| **CI/CD Setup**     | [Automated updates](https://heroshot.sh/docs/guide/automated-updates) |
-| **CLI Reference**   | [All commands & flags](https://heroshot.sh/docs/cli)                  |
+|                     |                                                                        |
+| ------------------- | ---------------------------------------------------------------------- |
+| **Documentation**   | [heroshot.dev](https://heroshot.dev)                                   |
+| **Getting Started** | [Quick start guide](https://heroshot.dev/docs/getting-started)         |
+| **Configuration**   | [Config options](https://heroshot.dev/docs/config)                     |
+| **CI/CD Setup**     | [Automated updates](https://heroshot.dev/docs/guide/automated-updates) |
+| **CLI Reference**   | [All commands & flags](https://heroshot.dev/docs/cli)                  |
 
 ## Support the Project
 

package/dist/cli/cli.js

@@ -1,11 +1,10 @@
 #!/usr/bin/env node
-import { C as intro, D as setVerbose, E as outro, O as spinner, S as error, T as note, _ as loadConfig, a as launchBrowser, c as generateSessionKey, d as loadSession, f as saveLocalKey, g as getConfigPath, h as ensureHeroshotDirectory, k as verbose, l as getSessionPath, m as sessionExists, n as snippetAction, o as DEFAULT_VIEWPORT, p as saveSession, r as sync, s as EDITOR_DIR, u as loadLocalKey, v as saveConfig, w as log, x as generateUid, y as VIEWPORT_PRESETS } from "../snippet-Cm6b-EdU.js";
+import { C as intro, D as setVerbose, E as outro, O as spinner, S as error, T as note, _ as loadConfig, a as launchBrowser, c as generateSessionKey, d as loadSession, f as saveLocalKey, g as getConfigPath, h as ensureHeroshotDirectory, k as verbose, l as getSessionPath, m as sessionExists, n as snippetAction, o as DEFAULT_VIEWPORT, p as saveSession, r as sync, s as EDITOR_DIR, u as loadLocalKey, v as saveConfig, w as log, x as generateUid, y as VIEWPORT_PRESETS } from "../snippet-ZcZmuryj.js";
 import { existsSync, readFileSync, rmSync } from "node:fs";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
 import { Command } from "commander";
 import { z } from "zod";
-
 //#region src/browser/configToScreenshotData.ts
 /**
 * Convert config screenshots to toolbar ScreenshotData format.
@@ -31,7 +30,6 @@ function configToScreenshotData(screenshots) {
 		...screenshot.borderRadius && { borderRadius: screenshot.borderRadius }
 	}));
 }
-
 //#endregion
 //#region src/browser/pageScripts.ts
 /**
@@ -64,7 +62,6 @@ function dispatchHighlightJob(options) {
 		screenshotId: options.screenshotId
 	} }));
 }
-
 //#endregion
 //#region src/browser/toConfigScreenshot.ts
 /**
@@ -95,7 +92,6 @@ function toConfigScreenshot(data) {
 		...data.borderRadius && { borderRadius: data.borderRadius }
 	};
 }
-
 //#endregion
 //#region src/browser/saveCurrentConfig.ts
 /**
@@ -123,7 +119,6 @@ function saveCurrentConfig(configPath, allScreenshots, browserSettings, hiddenEl
 	saveConfig(configPath, config);
 	verbose("Config saved");
 }
-
 //#endregion
 //#region src/browser/handleEvent.ts
 function createEventHandler(state, browser, context) {
@@ -209,7 +204,6 @@ function createEventHandler(state, browser, context) {
 		}
 	};
 }
-
 //#endregion
 //#region src/browser/schema.ts
 /**
@@ -301,7 +295,6 @@ const toolbarEventSchema = z.discriminatedUnion("type", [
 	z.object({ type: z.literal("job-complete") }),
 	z.object({ type: z.literal("done") })
 ]);
-
 //#endregion
 //#region src/browser/injectToolbar.ts
 /**
@@ -393,7 +386,6 @@ async function doInjectToolbar(page, options) {
       document.body.appendChild(script);
     })(${JSON.stringify(screenshots)}, ${JSON.stringify(settings)}, ${JSON.stringify(pendingJob)}, ${JSON.stringify(selectedId)}, ${JSON.stringify(sidebarExpanded)}, ${JSON.stringify(hiddenElements)}, ${JSON.stringify(scriptContent)})`);
 }
-
 //#endregion
 //#region src/browser/browser.ts
 async function setup(options = {}) {
@@ -478,7 +470,7 @@ async function setup(options = {}) {
 	context.on("page", initPage);
 	const page = context.pages()[0] ?? await context.newPage();
 	initPage(page);
-	await page.goto("https://heroshot.sh/welcome", { waitUntil: "domcontentloaded" });
+	await page.goto("https://heroshot.dev/welcome", { waitUntil: "domcontentloaded" });
 	try {
 		await injectToolbar(page, injectOptions());
 		verbose("Toolbar injected on welcome page");
@@ -491,7 +483,6 @@ async function setup(options = {}) {
 	if (isNewKey) note("To print your session key:\n  npx heroshot session-key\n\nFor CI, add HEROSHOT_SESSION_KEY as a repository secret.", "Session encrypted");
 	return { hasScreenshots: allScreenshots.length > 0 };
 }
-
 //#endregion
 //#region src/cli/generateScreenshotFilename.ts
 /**
@@ -511,7 +502,6 @@ function generateScreenshotFilename(url, selector) {
 		return "screenshot.png";
 	}
 }
-
 //#endregion
 //#region src/cli/buildScreenshotEntry.ts
 /**
@@ -539,7 +529,6 @@ function buildScreenshotEntry(url, options) {
 	else if (options?.desktop) screenshot.viewports = ["desktop"];
 	return screenshot;
 }
-
 //#endregion
 //#region src/cli/optionsParsers.ts
 /**
@@ -563,6 +552,20 @@ function getDeviceScaleFactor(options, existingConfig) {
 	return existingConfig?.browser?.deviceScaleFactor;
 }
 /**
+* Build browser settings for a oneshot capture from CLI options,
+* falling back to existing config defaults.
+*/
+function buildBrowserSettings(options, existingConfig) {
+	return {
+		viewport: getViewport(options, existingConfig),
+		colorScheme: getColorScheme(options, false),
+		deviceScaleFactor: getDeviceScaleFactor(options, existingConfig),
+		reducedMotion: options?.reducedMotion ? "reduce" : existingConfig?.browser?.reducedMotion,
+		userAgent: options?.userAgent ?? existingConfig?.browser?.userAgent,
+		ignoreHTTPSErrors: options?.ignoreHttpsErrors ?? existingConfig?.browser?.ignoreHTTPSErrors
+	};
+}
+/**
 * Get viewport from CLI options.
 * Checks preset flags (mobile/tablet/desktop), custom dimensions, then existing config.
 */
@@ -579,7 +582,6 @@ function getViewport(options, existingConfig) {
 	}
 	return existingConfig?.browser?.viewport;
 }
-
 //#endregion
 //#region src/cli/buildShotConfig.ts
 /**
@@ -591,17 +593,10 @@ function buildShotConfig(url, options, existingConfig) {
 		outputDirectory: ".",
 		outputFormat: options?.quality ? "jpeg" : existingConfig?.outputFormat ?? "png",
 		jpegQuality: options?.quality ?? existingConfig?.jpegQuality ?? 80,
-		browser: {
-			viewport: getViewport(options, existingConfig),
-			colorScheme: getColorScheme(options, false),
-			deviceScaleFactor: getDeviceScaleFactor(options, existingConfig),
-			reducedMotion: options?.reducedMotion ? "reduce" : existingConfig?.browser?.reducedMotion,
-			userAgent: options?.userAgent ?? existingConfig?.browser?.userAgent
-		},
+		browser: buildBrowserSettings(options, existingConfig),
 		screenshots: [screenshot]
 	};
 }
-
 //#endregion
 //#region src/cli/handlers.ts
 /**
@@ -725,7 +720,6 @@ function sessionKeyAction() {
 	error("No session key found. Run \"heroshot config\" first to generate one.");
 	return false;
 }
-
 //#endregion
 //#region src/cli/list.ts
 /**
@@ -763,7 +757,6 @@ function listAction(options, globalOptions) {
 	}
 	return true;
 }
-
 //#endregion
 //#region src/cli/cli.ts
 function getVersion() {
@@ -781,7 +774,7 @@ program.name("heroshot").description("Define your screenshots once, update them
 	setVerbose(program.opts().verbose ?? false);
 	intro(version);
 });
-program.command("oneshot [url]", { isDefault: true }).description("Capture URL directly, or sync all screenshots from config").option("--selector <selector...>", "CSS selector(s) to capture").option("-o, --output <file>", "Output filename").option("-p, --padding <pixels>", "Padding around element", Number.parseInt).option("-w, --width <pixels>", "Viewport width", Number.parseInt).option("--height <pixels>", "Viewport height", Number.parseInt).option("--mobile", "Use mobile viewport (430x932)").option("--tablet", "Use tablet viewport (768x1024)").option("--desktop", "Use desktop viewport (1280x800)").option("--dark", "Force dark color scheme").option("--light", "Force light color scheme").option("--scale <factor>", "Device scale factor (1, 2, 3)", Number.parseInt).option("--retina", "Use retina scale (2x)").option("-q, --quality <percent>", "JPEG quality (1-100), outputs JPEG", Number.parseInt).option("--viewport-only", "Capture only viewport (not full page)").option("--reduced-motion", "Emulate prefers-reduced-motion: reduce (disables animations)").option("--user-agent <string>", "Custom user agent string").option("--save", "Save screenshot definition to config").option("--clean", "Delete stale files in output directory").option("--workers <count>", "Number of parallel capture workers", Number.parseInt).option("--headed", "Run browser in headed mode (visible window) for debugging").action(async (url, options) => {
+program.command("oneshot [url]", { isDefault: true }).description("Capture URL directly, or sync all screenshots from config").option("--selector <selector...>", "CSS selector(s) to capture").option("-o, --output <file>", "Output filename").option("-p, --padding <pixels>", "Padding around element", Number.parseInt).option("-w, --width <pixels>", "Viewport width", Number.parseInt).option("--height <pixels>", "Viewport height", Number.parseInt).option("--mobile", "Use mobile viewport (430x932)").option("--tablet", "Use tablet viewport (768x1024)").option("--desktop", "Use desktop viewport (1280x800)").option("--dark", "Force dark color scheme").option("--light", "Force light color scheme").option("--scale <factor>", "Device scale factor (1, 2, 3)", Number.parseInt).option("--retina", "Use retina scale (2x)").option("-q, --quality <percent>", "JPEG quality (1-100), outputs JPEG", Number.parseInt).option("--viewport-only", "Capture only viewport (not full page)").option("--reduced-motion", "Emulate prefers-reduced-motion: reduce (disables animations)").option("--user-agent <string>", "Custom user agent string").option("--ignore-https-errors", "Ignore TLS certificate errors (self-signed certs, dev only)").option("--save", "Save screenshot definition to config").option("--clean", "Delete stale files in output directory").option("--workers <count>", "Number of parallel capture workers", Number.parseInt).option("--headed", "Run browser in headed mode (visible window) for debugging").action(async (url, options) => {
 	if (!await shotAction(url, options, program.opts())) process.exitCode = 1;
 });
 program.command("config").description("Open browser to add/edit screenshot definitions").option("--reset", "Clear existing session and start fresh").option("--only", "Only run config, skip sync afterwards").option("--light", "Force light mode (prefers-color-scheme: light)").option("--dark", "Force dark mode (prefers-color-scheme: dark)").action(async (options) => {
@@ -798,6 +791,5 @@ program.command("list").description("List all configured screenshots").option("-
 	if (!listAction(options, program.opts())) process.exitCode = 1;
 });
 program.parse();
-
 //#endregion
-export {  };
+export {};

package/dist/index.js

@@ -44,6 +44,5 @@ function configToManifest(config) {
 		screenshots
 	};
 }
-
 //#endregion
-export { configToManifest };
+export { configToManifest };